rtos: fix uninitialised variable warning
[fw/openocd] / src / rtos / rtos.c
index 524e1dacac39c4d2809581a9e6fbd17eae68133d..cdd37608ed446156ca409fd61405b8427b170ab3 100644 (file)
@@ -15,7 +15,7 @@
  *   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.             *
+ *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.           *
  ***************************************************************************/
 
 #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;
 
 static struct rtos_type *rtos_types[] = {
        &ThreadX_rtos,
        &FreeRTOS_rtos,
        &eCos_rtos,
        &Linux_os,
+       &ChibiOS_rtos,
+       &embKernel_rtos,
        NULL
 };
 
@@ -52,78 +55,87 @@ int rtos_smp_init(struct target *target)
        return ERROR_TARGET_INIT_FAILED;
 }
 
+static int os_alloc(struct target *target, struct rtos_type *ostype)
+{
+       struct rtos *os = target->rtos = calloc(1, sizeof(struct rtos));
+
+       if (!os)
+               return JIM_ERR;
+
+       os->type = ostype;
+       os->current_threadid = -1;
+       os->current_thread = 0;
+       os->symbols = NULL;
+       os->target = target;
+
+       /* RTOS drivers can override the packet handler in _create(). */
+       os->gdb_thread_packet = rtos_thread_packet;
+
+       return JIM_OK;
+}
+
+static void os_free(struct target *target)
+{
+       if (!target->rtos)
+               return;
+
+       if (target->rtos->symbols)
+               free(target->rtos->symbols);
+
+       free(target->rtos);
+       target->rtos = NULL;
+}
+
+static int os_alloc_create(struct target *target, struct rtos_type *ostype)
+{
+       int ret = os_alloc(target, ostype);
+
+       if (JIM_OK == ret) {
+               ret = target->rtos->type->create(target);
+               if (ret != JIM_OK)
+                       os_free(target);
+       }
+
+       return ret;
+}
+
 int rtos_create(Jim_GetOptInfo *goi, struct target *target)
 {
        int x;
        char *cp;
-       if (!goi->isconfigure) {
-               if (goi->argc != 0) {
-                       if (goi->argc != 0) {
-                               Jim_WrongNumArgs(goi->interp,
-                                       goi->argc, goi->argv,
-                                       "NO PARAMS");
-                               return JIM_ERR;
-                       }
+       struct Jim_Obj *res;
 
-                       Jim_SetResultString(goi->interp,
-                               target_type_name(target), -1);
-               }
+       if (!goi->isconfigure && goi->argc != 0) {
+               Jim_WrongNumArgs(goi->interp, goi->argc, goi->argv, "NO PARAMS");
+               return JIM_ERR;
        }
 
-       if (target->rtos)
-               free((void *)(target->rtos));
-                                               /*                      e = Jim_GetOpt_String(goi,
-                                                * &cp, NULL); */
-/*                     target->rtos = strdup(cp); */
+       os_free(target);
 
        Jim_GetOpt_String(goi, &cp, NULL);
-       /* now does target type exist */
 
        if (0 == strcmp(cp, "auto")) {
-               /* auto detection of RTOS */
+               /* Auto detect tries to look up all symbols for each RTOS,
+                * and runs the RTOS driver's _detect() function when GDB
+                * finds all symbols for any RTOS. See rtos_qsymbol(). */
                target->rtos_auto_detect = true;
-               x = 0;
-       } else {
 
-               for (x = 0; rtos_types[x]; x++) {
-                       if (0 == strcmp(cp, rtos_types[x]->name)) {
-                               /* found */
-                               break;
-                       }
-               }
-               if (rtos_types[x] == NULL) {
-                       Jim_SetResultFormatted(goi->interp, "Unknown rtos type %s, try one of ",
-                               cp);
-                       for (x = 0; rtos_types[x]; x++) {
-                               if (rtos_types[x + 1]) {
-                                       Jim_AppendStrings(goi->interp,
-                                               Jim_GetResult(goi->interp),
-                                               rtos_types[x]->name,
-                                               ", ", NULL);
-                               } else {
-                                       Jim_AppendStrings(goi->interp,
-                                               Jim_GetResult(goi->interp),
-                                               " or ",
-                                               rtos_types[x]->name, NULL);
-                               }
-                       }
-                       return JIM_ERR;
-               }
+               /* rtos_qsymbol() will iterate over all RTOSes. Allocate
+                * target->rtos here, and set it to the first RTOS type. */
+               return os_alloc(target, rtos_types[0]);
        }
-       /* Create it */
-       target->rtos = calloc(1, sizeof(struct rtos));
-       target->rtos->type = rtos_types[x];
-       target->rtos->current_threadid = -1;
-       target->rtos->current_thread = 0;
-       target->rtos->symbols = NULL;
-       target->rtos->target = target;
-       /* put default thread handler in linux usecase it is overloaded*/
-       target->rtos->gdb_thread_packet = rtos_thread_packet;
-
-       if (0 != strcmp(cp, "auto"))
-               target->rtos->type->create(target);
 
-       return JIM_OK;
+       for (x = 0; rtos_types[x]; x++)
+               if (0 == strcmp(cp, rtos_types[x]->name))
+                       return os_alloc_create(target, rtos_types[x]);
+
+       Jim_SetResultFormatted(goi->interp, "Unknown RTOS type %s, try one of: ", cp);
+       res = Jim_GetResult(goi->interp);
+       for (x = 0; rtos_types[x]; x++)
+               Jim_AppendStrings(goi->interp, res, rtos_types[x]->name, ", ", NULL);
+       Jim_AppendStrings(goi->interp, res, " or auto", NULL);
+
+       return JIM_ERR;
 }
 
 int gdb_thread_packet(struct connection *connection, char *packet, int packet_size)
@@ -134,97 +146,119 @@ int gdb_thread_packet(struct connection *connection, char *packet, int packet_si
                                                                                 *found*/
        return target->rtos->gdb_thread_packet(connection, packet, packet_size);
 }
-/* return -1 if no rtos defined, 0 if rtos and symbol to be asked, 1 if all
- * symbol have been asked*/
+
+static char *next_symbol(struct rtos *os, char *cur_symbol, uint64_t cur_addr)
+{
+       symbol_table_elem_t *s;
+
+       if (!os->symbols)
+               os->type->get_symbol_list_to_lookup(&os->symbols);
+
+       if (!cur_symbol[0])
+               return os->symbols[0].symbol_name;
+
+       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 NULL;
+}
+
+/* rtos_qsymbol() processes and replies to all qSymbol packets from GDB.
+ *
+ * GDB sends a qSymbol:: packet (empty address, empty name) to notify
+ * that it can now answer qSymbol::hexcodedname queries, to look up symbols.
+ *
+ * If the qSymbol packet has no address that means GDB did not find the
+ * symbol, in which case auto-detect will move on to try the next RTOS.
+ *
+ * rtos_qsymbol() then calls the next_symbol() helper function, which
+ * iterates over symbol names for the current RTOS until it finds the
+ * symbol in the received GDB packet, and then returns the next entry
+ * in the list of symbols.
+ *
+ * If GDB replied about the last symbol for the RTOS and the RTOS was
+ * specified explicitly, then no further symbol lookup is done. When
+ * auto-detecting, the RTOS driver _detect() function must return success.
+ *
+ * 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_detected = 0;
+       uint64_t addr = 0;
+       size_t reply_len;
+       char reply[GDB_BUFFER_SIZE], cur_sym[GDB_BUFFER_SIZE / 2] = "", *next_sym;
        struct target *target = get_target_from_connection(connection);
-       if (target->rtos != NULL) {
-               int next_symbol_num = -1;
-               if (target->rtos->symbols == NULL)
-                       target->rtos->type->get_symbol_list_to_lookup(&target->rtos->symbols);
-               if (0 == strcmp("qSymbol::", packet))
-                       /* first query - */
-                       next_symbol_num = 0;
-               else {
-                       int64_t value = 0;
-                       char *hex_name_str = malloc(strlen(packet));
-                       char *name_str;
-                       int symbol_num;
-
-                       char *found = strstr(packet, "qSymbol::");
-                       if (0 == found)
-                               sscanf(packet, "qSymbol:%" SCNx64 ":%s", &value, hex_name_str);
-                       else
-                               /* No value returned by GDB - symbol was not found*/
-                               sscanf(packet, "qSymbol::%s", hex_name_str);
-                       name_str = (char *) malloc(1 + strlen(hex_name_str) / 2);
-
-                       hex_to_str(name_str, hex_name_str);
-                       symbol_num = 0;
-                       while ((target->rtos->symbols[symbol_num].symbol_name != NULL) &&
-                                       (0 != strcmp(target->rtos->symbols[symbol_num].symbol_name, name_str)))
-                               symbol_num++;
-
-                       if (target->rtos->symbols[symbol_num].symbol_name == NULL) {
-                               LOG_OUTPUT("ERROR: unknown symbol\r\n");
-                               gdb_put_packet(connection, "OK", 2);
-                               free(hex_name_str);
-                               free(name_str);
-                               return ERROR_OK;
-                       }
+       struct rtos *os = target->rtos;
 
-                       target->rtos->symbols[symbol_num].address = value;
+       reply_len = sprintf(reply, "OK");
 
-                       next_symbol_num = symbol_num+1;
-                       free(hex_name_str);
-                       free(name_str);
-               }
+       if (!os)
+               goto done;
 
-               int symbols_done = 0;
-               if (target->rtos->symbols[next_symbol_num].symbol_name == NULL) {
-                       if ((target->rtos_auto_detect == false) ||
-                                       (1 == target->rtos->type->detect_rtos(target))) {
-                               /* Found correct RTOS or not autodetecting */
-                               if (target->rtos_auto_detect == true)
-                                       LOG_OUTPUT("Auto-detected RTOS: %s\r\n",
-                                               target->rtos->type->name);
-                               symbols_done = 1;
-                       } else {
-                               /* Auto detecting RTOS and currently not found */
-                               if (1 != rtos_try_next(target))
-                                       /* No more RTOS's to try */
-                                       symbols_done = 1;
-                               else {
-                                       next_symbol_num = 0;
-                                       target->rtos->type->get_symbol_list_to_lookup(
-                                               &target->rtos->symbols);
-                               }
+       /* Decode any symbol name in the packet*/
+       int len = unhexify(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 found an address for a symbol */
+               /* GDB could not find an address for the previous symbol */
+               if (!target->rtos_auto_detect) {
+                       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';
                }
-               if (symbols_done == 1)
-                       return symbols_done;
-               else {
-                       char *symname = target->rtos->symbols[next_symbol_num].symbol_name;
-                       char qsymstr[] = "qSymbol:";
-                       char *opstring = (char *)malloc(sizeof(qsymstr)+strlen(symname)*2+1);
-                       char *posptr = opstring;
-                       posptr += sprintf(posptr, "%s", qsymstr);
-                       str_to_hex(posptr, symname);
-                       gdb_put_packet(connection, opstring, strlen(opstring));
-                       free(opstring);
-                       return symbols_done;
+       }
+       next_sym = next_symbol(os, cur_sym, addr);
+
+       if (!next_sym) {
+               /* No more symbols need looking up */
+
+               if (!target->rtos_auto_detect) {
+                       rtos_detected = 1;
+                       goto done;
                }
+
+               if (os->type->detect_rtos(target)) {
+                       LOG_INFO("Auto-detected RTOS: %s", os->type->name);
+                       rtos_detected = 1;
+                       goto done;
+               } else {
+                       LOG_WARNING("No RTOS could be auto-detected!");
+                       goto done;
+               }
+       }
+
+       if (8 + (strlen(next_sym) * 2) + 1 > sizeof(reply)) {
+               LOG_ERROR("ERROR: RTOS symbol '%s' name is too long for GDB!", next_sym);
+               goto done;
        }
-       gdb_put_packet(connection, "OK", 2);
-       return -1;
+
+       reply_len = snprintf(reply, sizeof(reply), "qSymbol:");
+       reply_len += hexify(reply + reply_len, next_sym, 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)
 {
        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;
@@ -275,10 +309,10 @@ int rtos_thread_packet(struct connection *connection, char *packet, int packet_s
                        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 = (char *) 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;
@@ -286,49 +320,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);
-                       /* No more symbols needed */
-                       gdb_put_packet(connection, "OK", 2);
                }
                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 = (char *) 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);
 
                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);
@@ -396,7 +433,7 @@ 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 */
@@ -407,7 +444,8 @@ int rtos_generic_stack_read(struct target *target,
                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;
        }
 #if 0
@@ -441,67 +479,32 @@ 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;
 }
 
 int rtos_try_next(struct target *target)
 {
-       int x;
+       struct rtos *os = target->rtos;
+       struct rtos_type **type = rtos_types;
 
-       if (target->rtos == NULL)
-               return -1;
-
-       for (x = 0; rtos_types[x]; x++) {
-               if (target->rtos->type == rtos_types[x]) {
-                       /* found */
-                       if (rtos_types[x+1] != NULL) {
-                               target->rtos->type = rtos_types[x+1];
-                               if (target->rtos->symbols != NULL)
-                                       free(target->rtos->symbols);
-                               return 1;
-                       } else {
-                               /* No more rtos types */
-                               return 0;
-                       }
+       if (!os)
+               return 0;
 
-               }
-       }
-       return 0;
+       while (*type && os->type != *type)
+               type++;
 
-}
+       if (!*type || !*(++type))
+               return 0;
 
-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++;
+       os->type = *type;
+       if (os->symbols) {
+               free(os->symbols);
+               os->symbols = NULL;
        }
 
-}
-
-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;
+       return 1;
 }
 
 int rtos_update_threads(struct target *target)