1 /***************************************************************************
2 * Copyright (C) 2011 by Broadcom Corporation *
3 * Evan Hunter - ehunter@broadcom.com *
5 * This program is free software; you can redistribute it and/or modify *
6 * it under the terms of the GNU General Public License as published by *
7 * the Free Software Foundation; either version 2 of the License, or *
8 * (at your option) any later version. *
10 * This program is distributed in the hope that it will be useful, *
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
13 * GNU General Public License for more details. *
15 * You should have received a copy of the GNU General Public License *
16 * along with this program. If not, see <http://www.gnu.org/licenses/>. *
17 ***************************************************************************/
24 #include "target/target.h"
25 #include "helper/log.h"
26 #include "helper/binarybuffer.h"
27 #include "server/gdb_server.h"
30 extern struct rtos_type FreeRTOS_rtos;
31 extern struct rtos_type ThreadX_rtos;
32 extern struct rtos_type eCos_rtos;
33 extern struct rtos_type Linux_os;
34 extern struct rtos_type chibios_rtos;
35 extern struct rtos_type chromium_ec_rtos;
36 extern struct rtos_type embKernel_rtos;
37 extern struct rtos_type mqx_rtos;
38 extern struct rtos_type uCOS_III_rtos;
39 extern struct rtos_type nuttx_rtos;
40 extern struct rtos_type hwthread_rtos;
41 extern struct rtos_type riot_rtos;
42 extern struct rtos_type zephyr_rtos;
44 static struct rtos_type *rtos_types[] = {
57 /* keep this as last, as it always matches with rtos auto */
62 static int rtos_try_next(struct target *target);
64 int rtos_thread_packet(struct connection *connection, const char *packet, int packet_size);
66 int rtos_smp_init(struct target *target)
68 if (target->rtos->type->smp_init)
69 return target->rtos->type->smp_init(target);
70 return ERROR_TARGET_INIT_FAILED;
73 static int rtos_target_for_threadid(struct connection *connection, int64_t threadid, struct target **t)
75 struct target *curr = get_target_from_connection(connection);
82 static int os_alloc(struct target *target, struct rtos_type *ostype)
84 struct rtos *os = target->rtos = calloc(1, sizeof(struct rtos));
90 os->current_threadid = -1;
91 os->current_thread = 0;
95 /* RTOS drivers can override the packet handler in _create(). */
96 os->gdb_thread_packet = rtos_thread_packet;
97 os->gdb_target_for_threadid = rtos_target_for_threadid;
102 static void os_free(struct target *target)
107 free(target->rtos->symbols);
112 static int os_alloc_create(struct target *target, struct rtos_type *ostype)
114 int ret = os_alloc(target, ostype);
117 ret = target->rtos->type->create(target);
125 int rtos_create(Jim_GetOptInfo *goi, struct target *target)
132 if (!goi->isconfigure && goi->argc != 0) {
133 Jim_WrongNumArgs(goi->interp, goi->argc, goi->argv, "NO PARAMS");
139 e = Jim_GetOpt_String(goi, &cp, NULL);
143 if (0 == strcmp(cp, "auto")) {
144 /* Auto detect tries to look up all symbols for each RTOS,
145 * and runs the RTOS driver's _detect() function when GDB
146 * finds all symbols for any RTOS. See rtos_qsymbol(). */
147 target->rtos_auto_detect = true;
149 /* rtos_qsymbol() will iterate over all RTOSes. Allocate
150 * target->rtos here, and set it to the first RTOS type. */
151 return os_alloc(target, rtos_types[0]);
154 for (x = 0; rtos_types[x]; x++)
155 if (0 == strcmp(cp, rtos_types[x]->name))
156 return os_alloc_create(target, rtos_types[x]);
158 Jim_SetResultFormatted(goi->interp, "Unknown RTOS type %s, try one of: ", cp);
159 res = Jim_GetResult(goi->interp);
160 for (x = 0; rtos_types[x]; x++)
161 Jim_AppendStrings(goi->interp, res, rtos_types[x]->name, ", ", NULL);
162 Jim_AppendStrings(goi->interp, res, " or auto", NULL);
167 void rtos_destroy(struct target *target)
172 int gdb_thread_packet(struct connection *connection, char const *packet, int packet_size)
174 struct target *target = get_target_from_connection(connection);
175 if (target->rtos == NULL)
176 return rtos_thread_packet(connection, packet, packet_size); /* thread not
178 return target->rtos->gdb_thread_packet(connection, packet, packet_size);
181 static struct symbol_table_elem *next_symbol(struct rtos *os, char *cur_symbol, uint64_t cur_addr)
183 struct symbol_table_elem *s;
186 os->type->get_symbol_list_to_lookup(&os->symbols);
189 return &os->symbols[0];
191 for (s = os->symbols; s->symbol_name; s++)
192 if (!strcmp(s->symbol_name, cur_symbol)) {
193 s->address = cur_addr;
201 /* searches for 'symbol' in the lookup table for 'os' and returns TRUE,
202 * if 'symbol' is not declared optional */
203 static bool is_symbol_mandatory(const struct rtos *os, const char *symbol)
205 for (struct symbol_table_elem *s = os->symbols; s->symbol_name; ++s) {
206 if (!strcmp(s->symbol_name, symbol))
212 /* rtos_qsymbol() processes and replies to all qSymbol packets from GDB.
214 * GDB sends a qSymbol:: packet (empty address, empty name) to notify
215 * that it can now answer qSymbol::hexcodedname queries, to look up symbols.
217 * If the qSymbol packet has no address that means GDB did not find the
218 * symbol, in which case auto-detect will move on to try the next RTOS.
220 * rtos_qsymbol() then calls the next_symbol() helper function, which
221 * iterates over symbol names for the current RTOS until it finds the
222 * symbol in the received GDB packet, and then returns the next entry
223 * in the list of symbols.
225 * If GDB replied about the last symbol for the RTOS and the RTOS was
226 * specified explicitly, then no further symbol lookup is done. When
227 * auto-detecting, the RTOS driver _detect() function must return success.
229 * rtos_qsymbol() returns 1 if an RTOS has been detected, or 0 otherwise.
231 int rtos_qsymbol(struct connection *connection, char const *packet, int packet_size)
233 int rtos_detected = 0;
236 char reply[GDB_BUFFER_SIZE + 1], cur_sym[GDB_BUFFER_SIZE / 2 + 1] = ""; /* Extra byte for null-termination */
237 struct symbol_table_elem *next_sym = NULL;
238 struct target *target = get_target_from_connection(connection);
239 struct rtos *os = target->rtos;
241 reply_len = sprintf(reply, "OK");
246 /* Decode any symbol name in the packet*/
247 size_t len = unhexify((uint8_t *)cur_sym, strchr(packet + 8, ':') + 1, strlen(strchr(packet + 8, ':') + 1));
250 if ((strcmp(packet, "qSymbol::") != 0) && /* GDB is not offering symbol lookup for the first time */
251 (!sscanf(packet, "qSymbol:%" SCNx64 ":", &addr)) && /* GDB did not find an address for a symbol */
252 is_symbol_mandatory(os, cur_sym)) { /* the symbol is mandatory for this RTOS */
254 /* GDB could not find an address for the previous symbol */
255 if (!target->rtos_auto_detect) {
256 LOG_WARNING("RTOS %s not detected. (GDB could not find symbol \'%s\')", os->type->name, cur_sym);
259 /* Autodetecting RTOS - try next RTOS */
260 if (!rtos_try_next(target)) {
261 LOG_WARNING("No RTOS could be auto-detected!");
265 /* Next RTOS selected - invalidate current symbol */
269 next_sym = next_symbol(os, cur_sym, addr);
271 if (!next_sym->symbol_name) {
272 /* No more symbols need looking up */
274 if (!target->rtos_auto_detect) {
279 if (os->type->detect_rtos(target)) {
280 LOG_INFO("Auto-detected RTOS: %s", os->type->name);
284 LOG_WARNING("No RTOS could be auto-detected!");
289 if (8 + (strlen(next_sym->symbol_name) * 2) + 1 > sizeof(reply)) {
290 LOG_ERROR("ERROR: RTOS symbol '%s' name is too long for GDB!", next_sym->symbol_name);
294 reply_len = snprintf(reply, sizeof(reply), "qSymbol:");
295 reply_len += hexify(reply + reply_len,
296 (const uint8_t *)next_sym->symbol_name, strlen(next_sym->symbol_name),
297 sizeof(reply) - reply_len);
300 gdb_put_packet(connection, reply, reply_len);
301 return rtos_detected;
304 int rtos_thread_packet(struct connection *connection, char const *packet, int packet_size)
306 struct target *target = get_target_from_connection(connection);
308 if (strncmp(packet, "qThreadExtraInfo,", 17) == 0) {
309 if ((target->rtos != NULL) && (target->rtos->thread_details != NULL) &&
310 (target->rtos->thread_count != 0)) {
311 threadid_t threadid = 0;
313 sscanf(packet, "qThreadExtraInfo,%" SCNx64, &threadid);
315 if ((target->rtos != NULL) && (target->rtos->thread_details != NULL)) {
317 for (thread_num = 0; thread_num < target->rtos->thread_count; thread_num++) {
318 if (target->rtos->thread_details[thread_num].threadid == threadid) {
319 if (target->rtos->thread_details[thread_num].exists)
325 gdb_put_packet(connection, "E01", 3); /* thread not found */
329 struct thread_detail *detail = &target->rtos->thread_details[found];
332 if (detail->thread_name_str != NULL)
333 str_size += strlen(detail->thread_name_str);
334 if (detail->extra_info_str != NULL)
335 str_size += strlen(detail->extra_info_str);
337 char *tmp_str = calloc(str_size + 9, sizeof(char));
338 char *tmp_str_ptr = tmp_str;
340 if (detail->thread_name_str != NULL)
341 tmp_str_ptr += sprintf(tmp_str_ptr, "Name: %s", detail->thread_name_str);
342 if (detail->extra_info_str != NULL) {
343 if (tmp_str_ptr != tmp_str)
344 tmp_str_ptr += sprintf(tmp_str_ptr, ", ");
345 tmp_str_ptr += sprintf(tmp_str_ptr, "%s", detail->extra_info_str);
348 assert(strlen(tmp_str) ==
349 (size_t) (tmp_str_ptr - tmp_str));
351 char *hex_str = malloc(strlen(tmp_str) * 2 + 1);
352 size_t pkt_len = hexify(hex_str, (const uint8_t *)tmp_str,
353 strlen(tmp_str), strlen(tmp_str) * 2 + 1);
355 gdb_put_packet(connection, hex_str, pkt_len);
361 gdb_put_packet(connection, "", 0);
363 } else if (strncmp(packet, "qSymbol", 7) == 0) {
364 if (rtos_qsymbol(connection, packet, packet_size) == 1) {
365 if (target->rtos_auto_detect == true) {
366 target->rtos_auto_detect = false;
367 target->rtos->type->create(target);
369 target->rtos->type->update_threads(target->rtos);
372 } else if (strncmp(packet, "qfThreadInfo", 12) == 0) {
374 if (target->rtos != NULL) {
375 if (target->rtos->thread_count == 0) {
376 gdb_put_packet(connection, "l", 1);
378 /*thread id are 16 char +1 for ',' */
379 char *out_str = malloc(17 * target->rtos->thread_count + 1);
380 char *tmp_str = out_str;
381 for (i = 0; i < target->rtos->thread_count; i++) {
382 tmp_str += sprintf(tmp_str, "%c%016" PRIx64, i == 0 ? 'm' : ',',
383 target->rtos->thread_details[i].threadid);
385 gdb_put_packet(connection, out_str, strlen(out_str));
389 gdb_put_packet(connection, "l", 1);
392 } else if (strncmp(packet, "qsThreadInfo", 12) == 0) {
393 gdb_put_packet(connection, "l", 1);
395 } else if (strncmp(packet, "qAttached", 9) == 0) {
396 gdb_put_packet(connection, "1", 1);
398 } else if (strncmp(packet, "qOffsets", 8) == 0) {
399 char offsets[] = "Text=0;Data=0;Bss=0";
400 gdb_put_packet(connection, offsets, sizeof(offsets)-1);
402 } else if (strncmp(packet, "qCRC:", 5) == 0) {
403 /* make sure we check this before "qC" packet below
404 * otherwise it gets incorrectly handled */
405 return GDB_THREAD_PACKET_NOT_CONSUMED;
406 } else if (strncmp(packet, "qC", 2) == 0) {
407 if (target->rtos != NULL) {
410 size = snprintf(buffer, 19, "QC%016" PRIx64, target->rtos->current_thread);
411 gdb_put_packet(connection, buffer, size);
413 gdb_put_packet(connection, "QC0", 3);
415 } else if (packet[0] == 'T') { /* Is thread alive? */
418 sscanf(packet, "T%" SCNx64, &threadid);
419 if ((target->rtos != NULL) && (target->rtos->thread_details != NULL)) {
421 for (thread_num = 0; thread_num < target->rtos->thread_count; thread_num++) {
422 if (target->rtos->thread_details[thread_num].threadid == threadid) {
423 if (target->rtos->thread_details[thread_num].exists)
429 gdb_put_packet(connection, "OK", 2); /* thread alive */
431 gdb_put_packet(connection, "E01", 3); /* thread not found */
433 } else if (packet[0] == 'H') { /* Set current thread ( 'c' for step and continue, 'g' for
434 * all other operations ) */
435 if ((packet[1] == 'g') && (target->rtos != NULL)) {
437 sscanf(packet, "Hg%16" SCNx64, &threadid);
438 LOG_DEBUG("RTOS: GDB requested to set current thread to 0x%" PRIx64, threadid);
439 /* threadid of 0 indicates target should choose */
441 target->rtos->current_threadid = target->rtos->current_thread;
443 target->rtos->current_threadid = threadid;
445 gdb_put_packet(connection, "OK", 2);
449 return GDB_THREAD_PACKET_NOT_CONSUMED;
452 static int rtos_put_gdb_reg_list(struct connection *connection,
453 struct rtos_reg *reg_list, int num_regs)
455 size_t num_bytes = 1; /* NUL */
456 for (int i = 0; i < num_regs; ++i)
457 num_bytes += DIV_ROUND_UP(reg_list[i].size, 8) * 2;
459 char *hex = malloc(num_bytes);
462 for (int i = 0; i < num_regs; ++i) {
463 size_t count = DIV_ROUND_UP(reg_list[i].size, 8);
464 size_t n = hexify(hex_p, reg_list[i].value, count, num_bytes);
469 gdb_put_packet(connection, hex, strlen(hex));
475 /** Look through all registers to find this register. */
476 int rtos_get_gdb_reg(struct connection *connection, int reg_num)
478 struct target *target = get_target_from_connection(connection);
479 int64_t current_threadid = target->rtos->current_threadid;
480 if ((target->rtos != NULL) && (current_threadid != -1) &&
481 (current_threadid != 0) &&
482 ((current_threadid != target->rtos->current_thread) ||
483 (target->smp))) { /* in smp several current thread are possible */
484 struct rtos_reg *reg_list;
487 LOG_DEBUG("getting register %d for thread 0x%" PRIx64
488 ", target->rtos->current_thread=0x%" PRIx64,
491 target->rtos->current_thread);
494 if (target->rtos->type->get_thread_reg) {
495 reg_list = calloc(1, sizeof(*reg_list));
497 retval = target->rtos->type->get_thread_reg(target->rtos,
498 current_threadid, reg_num, ®_list[0]);
499 if (retval != ERROR_OK) {
500 LOG_ERROR("RTOS: failed to get register %d", reg_num);
504 retval = target->rtos->type->get_thread_reg_list(target->rtos,
508 if (retval != ERROR_OK) {
509 LOG_ERROR("RTOS: failed to get register list");
514 for (int i = 0; i < num_regs; ++i) {
515 if (reg_list[i].number == (uint32_t)reg_num) {
516 rtos_put_gdb_reg_list(connection, reg_list + i, 1);
527 /** Return a list of general registers. */
528 int rtos_get_gdb_reg_list(struct connection *connection)
530 struct target *target = get_target_from_connection(connection);
531 int64_t current_threadid = target->rtos->current_threadid;
532 if ((target->rtos != NULL) && (current_threadid != -1) &&
533 (current_threadid != 0) &&
534 ((current_threadid != target->rtos->current_thread) ||
535 (target->smp))) { /* in smp several current thread are possible */
536 struct rtos_reg *reg_list;
539 LOG_DEBUG("RTOS: getting register list for thread 0x%" PRIx64
540 ", target->rtos->current_thread=0x%" PRIx64 "\r\n",
542 target->rtos->current_thread);
544 int retval = target->rtos->type->get_thread_reg_list(target->rtos,
548 if (retval != ERROR_OK) {
549 LOG_ERROR("RTOS: failed to get register list");
553 rtos_put_gdb_reg_list(connection, reg_list, num_regs);
561 int rtos_set_reg(struct connection *connection, int reg_num,
564 struct target *target = get_target_from_connection(connection);
565 int64_t current_threadid = target->rtos->current_threadid;
566 if ((target->rtos != NULL) &&
567 (target->rtos->type->set_reg != NULL) &&
568 (current_threadid != -1) &&
569 (current_threadid != 0)) {
570 return target->rtos->type->set_reg(target->rtos, reg_num, reg_value);
575 int rtos_generic_stack_read(struct target *target,
576 const struct rtos_register_stacking *stacking,
578 struct rtos_reg **reg_list,
583 if (stack_ptr == 0) {
584 LOG_ERROR("Error: null stack pointer in thread");
588 uint8_t *stack_data = malloc(stacking->stack_registers_size);
589 uint32_t address = stack_ptr;
591 if (stacking->stack_growth_direction == 1)
592 address -= stacking->stack_registers_size;
593 retval = target_read_buffer(target, address, stacking->stack_registers_size, stack_data);
594 if (retval != ERROR_OK) {
596 LOG_ERROR("Error reading stack frame from thread");
599 LOG_DEBUG("RTOS: Read stack frame at 0x%" PRIx32, address);
602 LOG_OUTPUT("Stack Data :");
603 for (i = 0; i < stacking->stack_registers_size; i++)
604 LOG_OUTPUT("%02X", stack_data[i]);
608 int64_t new_stack_ptr;
609 if (stacking->calculate_process_stack != NULL) {
610 new_stack_ptr = stacking->calculate_process_stack(target,
611 stack_data, stacking, stack_ptr);
613 new_stack_ptr = stack_ptr - stacking->stack_growth_direction *
614 stacking->stack_registers_size;
617 *reg_list = calloc(stacking->num_output_registers, sizeof(struct rtos_reg));
618 *num_regs = stacking->num_output_registers;
620 for (int i = 0; i < stacking->num_output_registers; ++i) {
621 (*reg_list)[i].number = stacking->register_offsets[i].number;
622 (*reg_list)[i].size = stacking->register_offsets[i].width_bits;
624 int offset = stacking->register_offsets[i].offset;
626 buf_cpy(&new_stack_ptr, (*reg_list)[i].value, (*reg_list)[i].size);
627 else if (offset != -1)
628 buf_cpy(stack_data + offset, (*reg_list)[i].value, (*reg_list)[i].size);
632 /* LOG_OUTPUT("Output register string: %s\r\n", *hex_reg_list); */
636 static int rtos_try_next(struct target *target)
638 struct rtos *os = target->rtos;
639 struct rtos_type **type = rtos_types;
644 while (*type && os->type != *type)
647 if (!*type || !*(++type))
658 int rtos_update_threads(struct target *target)
660 if ((target->rtos != NULL) && (target->rtos->type != NULL))
661 target->rtos->type->update_threads(target->rtos);
665 void rtos_free_threadlist(struct rtos *rtos)
667 if (rtos->thread_details) {
670 for (j = 0; j < rtos->thread_count; j++) {
671 struct thread_detail *current_thread = &rtos->thread_details[j];
672 free(current_thread->thread_name_str);
673 free(current_thread->extra_info_str);
675 free(rtos->thread_details);
676 rtos->thread_details = NULL;
677 rtos->thread_count = 0;
678 rtos->current_threadid = -1;
679 rtos->current_thread = 0;