helper: Make unhexify() robust on invalid data
[openocd.git] / src / rtos / rtos.c
index 9002f1a8cfe64960785063465453d90f4eb12630..448c49c060cc96f1690c09ce4cc5dbda03d9e28a 100644 (file)
@@ -13,9 +13,7 @@
  *   GNU General Public License for more details.                          *
  *                                                                         *
  *   You should have received a copy of the GNU General Public License     *
- *   along with this program; if not, write to the                         *
- *   Free Software Foundation, Inc.,                                       *
- *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ *   along with this program.  If not, see <http://www.gnu.org/licenses/>. *
  ***************************************************************************/
 
 #ifdef HAVE_CONFIG_H
 #include "rtos.h"
 #include "target/target.h"
 #include "helper/log.h"
+#include "helper/binarybuffer.h"
 #include "server/gdb_server.h"
 
-static void hex_to_str(char *dst, char *hex_src);
-
 /* RTOSs */
 extern struct rtos_type FreeRTOS_rtos;
 extern struct rtos_type ThreadX_rtos;
 extern struct rtos_type eCos_rtos;
 extern struct rtos_type Linux_os;
+extern struct rtos_type ChibiOS_rtos;
+extern struct rtos_type embKernel_rtos;
+extern struct rtos_type mqx_rtos;
 
 static struct rtos_type *rtos_types[] = {
        &ThreadX_rtos,
        &FreeRTOS_rtos,
        &eCos_rtos,
        &Linux_os,
+       &ChibiOS_rtos,
+       &embKernel_rtos,
+       &mqx_rtos,
        NULL
 };
 
-int rtos_thread_packet(struct connection *connection, char *packet, int packet_size);
+int rtos_thread_packet(struct connection *connection, const char *packet, int packet_size);
 
 int rtos_smp_init(struct target *target)
 {
@@ -99,7 +102,7 @@ static int os_alloc_create(struct target *target, struct rtos_type *ostype)
 int rtos_create(Jim_GetOptInfo *goi, struct target *target)
 {
        int x;
-       char *cp;
+       const char *cp;
        struct Jim_Obj *res;
 
        if (!goi->isconfigure && goi->argc != 0) {
@@ -135,7 +138,7 @@ int rtos_create(Jim_GetOptInfo *goi, struct target *target)
        return JIM_ERR;
 }
 
-int gdb_thread_packet(struct connection *connection, char *packet, int packet_size)
+int gdb_thread_packet(struct connection *connection, char const *packet, int packet_size)
 {
        struct target *target = get_target_from_connection(connection);
        if (target->rtos == NULL)
@@ -144,7 +147,7 @@ int gdb_thread_packet(struct connection *connection, char *packet, int packet_si
        return target->rtos->gdb_thread_packet(connection, packet, packet_size);
 }
 
-static char *next_symbol(struct rtos *os, char *cur_symbol, uint64_t cur_addr)
+static symbol_table_elem_t *next_symbol(struct rtos *os, char *cur_symbol, uint64_t cur_addr)
 {
        symbol_table_elem_t *s;
 
@@ -152,18 +155,29 @@ static char *next_symbol(struct rtos *os, char *cur_symbol, uint64_t cur_addr)
                os->type->get_symbol_list_to_lookup(&os->symbols);
 
        if (!cur_symbol[0])
-               return os->symbols[0].symbol_name;
+               return &os->symbols[0];
 
        for (s = os->symbols; s->symbol_name; s++)
                if (!strcmp(s->symbol_name, cur_symbol)) {
                        s->address = cur_addr;
                        s++;
-                       return s->symbol_name;
+                       return s;
                }
 
        return NULL;
 }
 
+/* searches for 'symbol' in the lookup table for 'os' and returns TRUE,
+ * if 'symbol' is not declared optional */
+static bool is_symbol_mandatory(const struct rtos *os, const char *symbol)
+{
+       for (symbol_table_elem_t *s = os->symbols; s->symbol_name; ++s) {
+               if (!strcmp(s->symbol_name, symbol))
+                       return !s->optional;
+       }
+       return false;
+}
+
 /* rtos_qsymbol() processes and replies to all qSymbol packets from GDB.
  *
  * GDB sends a qSymbol:: packet (empty address, empty name) to notify
@@ -183,63 +197,82 @@ static char *next_symbol(struct rtos *os, char *cur_symbol, uint64_t cur_addr)
  *
  * rtos_qsymbol() returns 1 if an RTOS has been detected, or 0 otherwise.
  */
-int rtos_qsymbol(struct connection *connection, char *packet, int packet_size)
+int rtos_qsymbol(struct connection *connection, char const *packet, int packet_size)
 {
        int rtos_detected = 0;
-       uint64_t addr;
+       uint64_t addr = 0;
        size_t reply_len;
-       char reply[GDB_BUFFER_SIZE], cur_sym[GDB_BUFFER_SIZE / 2] = "", *next_sym;
+       char reply[GDB_BUFFER_SIZE], cur_sym[GDB_BUFFER_SIZE / 2] = "";
+       symbol_table_elem_t *next_sym = NULL;
        struct target *target = get_target_from_connection(connection);
        struct rtos *os = target->rtos;
 
        reply_len = sprintf(reply, "OK");
 
-       if (sscanf(packet, "qSymbol:%" SCNx64 ":", &addr))
-               hex_to_str(cur_sym, strchr(packet + 8, ':') + 1);
-       else if (target->rtos_auto_detect && !rtos_try_next(target))
+       if (!os)
                goto done;
 
-       next_sym = next_symbol(os, cur_sym, addr);
-       if (!next_sym) {
+       /* Decode any symbol name in the packet*/
+       size_t len = unhexify((uint8_t *)cur_sym, strchr(packet + 8, ':') + 1, strlen(strchr(packet + 8, ':') + 1));
+       cur_sym[len] = 0;
+
+       if ((strcmp(packet, "qSymbol::") != 0) &&               /* GDB is not offering symbol lookup for the first time */
+           (!sscanf(packet, "qSymbol:%" SCNx64 ":", &addr)) && /* GDB did not find an address for a symbol */
+           is_symbol_mandatory(os, cur_sym)) {                                 /* the symbol is mandatory for this RTOS */
+
+               /* GDB could not find an address for the previous symbol */
                if (!target->rtos_auto_detect) {
-                       rtos_detected = 1;
+                       LOG_WARNING("RTOS %s not detected. (GDB could not find symbol \'%s\')", os->type->name, cur_sym);
                        goto done;
+               } else {
+                       /* Autodetecting RTOS - try next RTOS */
+                       if (!rtos_try_next(target)) {
+                               LOG_WARNING("No RTOS could be auto-detected!");
+                               goto done;
+                       }
+
+                       /* Next RTOS selected - invalidate current symbol */
+                       cur_sym[0] = '\x00';
                }
+       }
+       next_sym = next_symbol(os, cur_sym, addr);
 
-               if (os->type->detect_rtos(target)) {
-                       LOG_OUTPUT("Auto-detected RTOS: %s\r\n", os->type->name);
+       if (!next_sym->symbol_name) {
+               /* No more symbols need looking up */
+
+               if (!target->rtos_auto_detect) {
                        rtos_detected = 1;
                        goto done;
                }
 
-               if (!rtos_try_next(target))
+               if (os->type->detect_rtos(target)) {
+                       LOG_INFO("Auto-detected RTOS: %s", os->type->name);
+                       rtos_detected = 1;
                        goto done;
-
-               os->type->get_symbol_list_to_lookup(&os->symbols);
-
-               next_sym = os->symbols[0].symbol_name;
-               if (!next_sym)
+               } else {
+                       LOG_WARNING("No RTOS could be auto-detected!");
                        goto done;
+               }
        }
 
-       if (8 + (strlen(next_sym) * 2) + 1 > sizeof(reply)) {
-               LOG_OUTPUT("ERROR: RTOS symbol '%s' name is too long for GDB!", next_sym);
+       if (8 + (strlen(next_sym->symbol_name) * 2) + 1 > sizeof(reply)) {
+               LOG_ERROR("ERROR: RTOS symbol '%s' name is too long for GDB!", next_sym->symbol_name);
                goto done;
        }
 
-       reply_len = sprintf(reply, "qSymbol:");
-       reply_len += str_to_hex(reply + reply_len, next_sym);
+       reply_len = snprintf(reply, sizeof(reply), "qSymbol:");
+       reply_len += hexify(reply + reply_len, next_sym->symbol_name, 0, sizeof(reply) - reply_len);
 
 done:
        gdb_put_packet(connection, reply, reply_len);
        return rtos_detected;
 }
 
-int rtos_thread_packet(struct connection *connection, char *packet, int packet_size)
+int rtos_thread_packet(struct connection *connection, char const *packet, int packet_size)
 {
        struct target *target = get_target_from_connection(connection);
 
-       if (strstr(packet, "qThreadExtraInfo,")) {
+       if (strncmp(packet, "qThreadExtraInfo,", 17) == 0) {
                if ((target->rtos != NULL) && (target->rtos->thread_details != NULL) &&
                                (target->rtos->thread_count != 0)) {
                        threadid_t threadid = 0;
@@ -263,37 +296,29 @@ int rtos_thread_packet(struct connection *connection, char *packet, int packet_s
                        struct thread_detail *detail = &target->rtos->thread_details[found];
 
                        int str_size = 0;
-                       if (detail->display_str != NULL)
-                               str_size += strlen(detail->display_str);
                        if (detail->thread_name_str != NULL)
                                str_size += strlen(detail->thread_name_str);
                        if (detail->extra_info_str != NULL)
                                str_size += strlen(detail->extra_info_str);
 
-                       char *tmp_str = (char *) malloc(str_size + 7);
+                       char *tmp_str = calloc(str_size + 4, sizeof(char));
                        char *tmp_str_ptr = tmp_str;
 
-                       if (detail->display_str != NULL)
-                               tmp_str_ptr += sprintf(tmp_str_ptr, "%s", detail->display_str);
-                       if (detail->thread_name_str != NULL) {
-                               if (tmp_str_ptr != tmp_str)
-                                       tmp_str_ptr += sprintf(tmp_str_ptr, " : ");
+                       if (detail->thread_name_str != NULL)
                                tmp_str_ptr += sprintf(tmp_str_ptr, "%s", detail->thread_name_str);
-                       }
                        if (detail->extra_info_str != NULL) {
                                if (tmp_str_ptr != tmp_str)
                                        tmp_str_ptr += sprintf(tmp_str_ptr, " : ");
-                               tmp_str_ptr +=
-                                       sprintf(tmp_str_ptr, " : %s", detail->extra_info_str);
+                               tmp_str_ptr += sprintf(tmp_str_ptr, "%s", detail->extra_info_str);
                        }
 
                        assert(strlen(tmp_str) ==
                                (size_t) (tmp_str_ptr - tmp_str));
 
-                       char *hex_str = (char *) malloc(strlen(tmp_str)*2 + 1);
-                       str_to_hex(hex_str, tmp_str);
+                       char *hex_str = malloc(strlen(tmp_str) * 2 + 1);
+                       int pkt_len = hexify(hex_str, tmp_str, 0, strlen(tmp_str) * 2 + 1);
 
-                       gdb_put_packet(connection, hex_str, strlen(hex_str));
+                       gdb_put_packet(connection, hex_str, pkt_len);
                        free(hex_str);
                        free(tmp_str);
                        return ERROR_OK;
@@ -301,47 +326,52 @@ int rtos_thread_packet(struct connection *connection, char *packet, int packet_s
                }
                gdb_put_packet(connection, "", 0);
                return ERROR_OK;
-       } else if (strstr(packet, "qSymbol")) {
+       } else if (strncmp(packet, "qSymbol", 7) == 0) {
                if (rtos_qsymbol(connection, packet, packet_size) == 1) {
                        target->rtos_auto_detect = false;
                        target->rtos->type->create(target);
                        target->rtos->type->update_threads(target->rtos);
                }
                return ERROR_OK;
-       } else if (strstr(packet, "qfThreadInfo")) {
+       } else if (strncmp(packet, "qfThreadInfo", 12) == 0) {
                int i;
-               if ((target->rtos != NULL) && (target->rtos->thread_count != 0)) {
-
-                       char *out_str = (char *) malloc(17 * target->rtos->thread_count + 5);
-                       char *tmp_str = out_str;
-                       tmp_str += sprintf(tmp_str, "m");
-                       for (i = 0; i < target->rtos->thread_count; i++) {
-                               if (i != 0)
-                                       tmp_str += sprintf(tmp_str, ",");
-                               tmp_str += sprintf(tmp_str, "%016" PRIx64,
-                                               target->rtos->thread_details[i].threadid);
+               if (target->rtos != NULL) {
+                       if (target->rtos->thread_count == 0) {
+                               gdb_put_packet(connection, "l", 1);
+                       } else {
+                               /*thread id are 16 char +1 for ',' */
+                               char *out_str = malloc(17 * target->rtos->thread_count + 1);
+                               char *tmp_str = out_str;
+                               for (i = 0; i < target->rtos->thread_count; i++) {
+                                       tmp_str += sprintf(tmp_str, "%c%016" PRIx64, i == 0 ? 'm' : ',',
+                                                                               target->rtos->thread_details[i].threadid);
+                               }
+                               gdb_put_packet(connection, out_str, strlen(out_str));
+                               free(out_str);
                        }
-                       tmp_str[0] = 0;
-                       gdb_put_packet(connection, out_str, strlen(out_str));
                } else
-                       gdb_put_packet(connection, "", 0);
+                       gdb_put_packet(connection, "l", 1);
 
                return ERROR_OK;
-       } else if (strstr(packet, "qsThreadInfo")) {
+       } else if (strncmp(packet, "qsThreadInfo", 12) == 0) {
                gdb_put_packet(connection, "l", 1);
                return ERROR_OK;
-       } else if (strstr(packet, "qAttached")) {
+       } else if (strncmp(packet, "qAttached", 9) == 0) {
                gdb_put_packet(connection, "1", 1);
                return ERROR_OK;
-       } else if (strstr(packet, "qOffsets")) {
+       } else if (strncmp(packet, "qOffsets", 8) == 0) {
                char offsets[] = "Text=0;Data=0;Bss=0";
                gdb_put_packet(connection, offsets, sizeof(offsets)-1);
                return ERROR_OK;
-       } else if (strstr(packet, "qC")) {
+       } else if (strncmp(packet, "qCRC:", 5) == 0) {
+               /* make sure we check this before "qC" packet below
+                * otherwise it gets incorrectly handled */
+               return GDB_THREAD_PACKET_NOT_CONSUMED;
+       } else if (strncmp(packet, "qC", 2) == 0) {
                if (target->rtos != NULL) {
-                       char buffer[15];
+                       char buffer[19];
                        int size;
-                       size = snprintf(buffer, 15, "QC%08X", (int)target->rtos->current_thread);
+                       size = snprintf(buffer, 19, "QC%016" PRIx64, target->rtos->current_thread);
                        gdb_put_packet(connection, buffer, size);
                } else
                        gdb_put_packet(connection, "QC0", 3);
@@ -366,8 +396,11 @@ int rtos_thread_packet(struct connection *connection, char *packet, int packet_s
                return ERROR_OK;
        } else if (packet[0] == 'H') {  /* Set current thread ( 'c' for step and continue, 'g' for
                                         * all other operations ) */
-               if ((packet[1] == 'g') && (target->rtos != NULL))
+               if ((packet[1] == 'g') && (target->rtos != NULL)) {
                        sscanf(packet, "Hg%16" SCNx64, &target->rtos->current_threadid);
+                       LOG_DEBUG("RTOS: GDB requested to set current thread to 0x%" PRIx64 "\r\n",
+                                                                               target->rtos->current_threadid);
+               }
                gdb_put_packet(connection, "OK", 2);
                return ERROR_OK;
        }
@@ -384,6 +417,12 @@ int rtos_get_gdb_reg_list(struct connection *connection)
                        ((current_threadid != target->rtos->current_thread) ||
                        (target->smp))) {       /* in smp several current thread are possible */
                char *hex_reg_list;
+
+               LOG_DEBUG("RTOS: getting register list for thread 0x%" PRIx64
+                                 ", target->rtos->current_thread=0x%" PRIx64 "\r\n",
+                                                                               current_threadid,
+                                                                               target->rtos->current_thread);
+
                target->rtos->type->get_thread_reg_list(target->rtos,
                        current_threadid,
                        &hex_reg_list);
@@ -409,20 +448,23 @@ int rtos_generic_stack_read(struct target *target,
        int retval;
 
        if (stack_ptr == 0) {
-               LOG_OUTPUT("Error: null stack pointer in thread\r\n");
+               LOG_ERROR("Error: null stack pointer in thread");
                return -5;
        }
        /* Read the stack */
-       uint8_t *stack_data = (uint8_t *) malloc(stacking->stack_registers_size);
+       uint8_t *stack_data = malloc(stacking->stack_registers_size);
        uint32_t address = stack_ptr;
 
        if (stacking->stack_growth_direction == 1)
                address -= stacking->stack_registers_size;
        retval = target_read_buffer(target, address, stacking->stack_registers_size, stack_data);
        if (retval != ERROR_OK) {
-               LOG_OUTPUT("Error reading stack frame from FreeRTOS thread\r\n");
+               free(stack_data);
+               LOG_ERROR("Error reading stack frame from thread");
                return retval;
        }
+       LOG_DEBUG("RTOS: Read stack frame at 0x%" PRIx32, address);
+
 #if 0
                LOG_OUTPUT("Stack Data :");
                for (i = 0; i < stacking->stack_registers_size; i++)
@@ -431,15 +473,14 @@ int rtos_generic_stack_read(struct target *target,
 #endif
        for (i = 0; i < stacking->num_output_registers; i++)
                list_size += stacking->register_offsets[i].width_bits/8;
-       *hex_reg_list = (char *)malloc(list_size*2 + 1);
+       *hex_reg_list = malloc(list_size*2 + 1);
        tmp_str_ptr = *hex_reg_list;
-       new_stack_ptr = stack_ptr - stacking->stack_growth_direction *
-               stacking->stack_registers_size;
-       if (stacking->stack_alignment != 0) {
-               /* Align new stack pointer to x byte boundary */
-               new_stack_ptr =
-                       (new_stack_ptr & (~((int64_t) stacking->stack_alignment - 1))) +
-                       ((stacking->stack_growth_direction == -1) ? stacking->stack_alignment : 0);
+       if (stacking->calculate_process_stack != NULL) {
+               new_stack_ptr = stacking->calculate_process_stack(target,
+                               stack_data, stacking, stack_ptr);
+       } else {
+               new_stack_ptr = stack_ptr - stacking->stack_growth_direction *
+                       stacking->stack_registers_size;
        }
        for (i = 0; i < stacking->num_output_registers; i++) {
                int j;
@@ -454,6 +495,7 @@ int rtos_generic_stack_read(struct target *target,
                                                stack_data[stacking->register_offsets[i].offset + j]);
                }
        }
+       free(stack_data);
 /*     LOG_OUTPUT("Output register string: %s\r\n", *hex_reg_list); */
        return ERROR_OK;
 }
@@ -481,42 +523,25 @@ int rtos_try_next(struct target *target)
        return 1;
 }
 
-static void hex_to_str(char *dst, char *hex_src)
-{
-       int src_pos = 0;
-       int dst_pos = 0;
-
-       while (hex_src[src_pos] != '\x00') {
-               char hex_char = hex_src[src_pos];
-               char hex_digit_val =
-                       (hex_char >=
-                        'a') ? hex_char-'a'+
-                       10 : (hex_char >= 'A') ? hex_char-'A'+10 : hex_char-'0';
-               if (0 == (src_pos & 0x01)) {
-                       dst[dst_pos] = hex_digit_val;
-                       dst[dst_pos+1] = 0;
-               } else {
-                       ((unsigned char *)dst)[dst_pos] <<= 4;
-                       ((unsigned char *)dst)[dst_pos] += hex_digit_val;
-                       dst_pos++;
-               }
-               src_pos++;
-       }
-
-}
-
-int str_to_hex(char *hex_dst, char *src)
-{
-       char *posptr = hex_dst;
-       unsigned i;
-       for (i = 0; i < strlen(src); i++)
-               posptr += sprintf(posptr, "%02x", (unsigned char)src[i]);
-       return posptr - hex_dst;
-}
-
 int rtos_update_threads(struct target *target)
 {
        if ((target->rtos != NULL) && (target->rtos->type != NULL))
                target->rtos->type->update_threads(target->rtos);
        return ERROR_OK;
 }
+
+void rtos_free_threadlist(struct rtos *rtos)
+{
+       if (rtos->thread_details) {
+               int j;
+
+               for (j = 0; j < rtos->thread_count; j++) {
+                       struct thread_detail *current_thread = &rtos->thread_details[j];
+                       free(current_thread->thread_name_str);
+                       free(current_thread->extra_info_str);
+               }
+               free(rtos->thread_details);
+               rtos->thread_details = NULL;
+               rtos->thread_count = 0;
+       }
+}

Linking to existing account procedure

If you already have an account and want to add another login method you MUST first sign in with your existing account and then change URL to read https://review.openocd.org/login/?link to get to this page again but this time it'll work for linking. Thank you.

SSH host keys fingerprints

1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=..              |
|+o..   .         |
|*.o   . .        |
|+B . . .         |
|Bo. = o S        |
|Oo.+ + =         |
|oB=.* = . o      |
| =+=.+   + E     |
|. .=o   . o      |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)