rtos: Fold is_symbol_mandatory into rtos_qsymbol(..)
[fw/openocd] / src / rtos / rtos.c
index 54e9926f1cc222f3da9e3da98cf278e8cd6fa63a..ccf15c7c783a094fdfc15df7cb5070cc79c7f2ca 100644 (file)
@@ -1,19 +1,8 @@
+/* SPDX-License-Identifier: GPL-2.0-or-later */
+
 /***************************************************************************
  *   Copyright (C) 2011 by Broadcom Corporation                            *
  *   Evan Hunter - ehunter@broadcom.com                                    *
- *                                                                         *
- *   This program is free software; you can redistribute it and/or modify  *
- *   it under the terms of the GNU General Public License as published by  *
- *   the Free Software Foundation; either version 2 of the License, or     *
- *   (at your option) any later version.                                   *
- *                                                                         *
- *   This program is distributed in the hope that it will be useful,       *
- *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
- *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
- *   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, see <http://www.gnu.org/licenses/>. *
  ***************************************************************************/
 
 #ifdef HAVE_CONFIG_H
@@ -140,6 +129,9 @@ int rtos_create(struct jim_getopt_info *goi, struct target *target)
        if (e != JIM_OK)
                return e;
 
+       if (strcmp(cp, "none") == 0)
+               return JIM_OK;
+
        if (strcmp(cp, "auto") == 0) {
                /* Auto detect tries to look up all symbols for each RTOS,
                 * and runs the RTOS driver's _detect() function when GDB
@@ -152,14 +144,14 @@ int rtos_create(struct jim_getopt_info *goi, struct target *target)
        }
 
        for (x = 0; rtos_types[x]; x++)
-               if (0 == strcmp(cp, rtos_types[x]->name))
+               if (strcmp(cp, rtos_types[x]->name) == 0)
                        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);
+       Jim_AppendStrings(goi->interp, res, ", auto or none", NULL);
 
        return JIM_ERR;
 }
@@ -178,35 +170,32 @@ int gdb_thread_packet(struct connection *connection, char const *packet, int pac
        return target->rtos->gdb_thread_packet(connection, packet, packet_size);
 }
 
-static struct symbol_table_elem *next_symbol(struct rtos *os, char *cur_symbol, uint64_t cur_addr)
+static struct symbol_table_elem *find_symbol(const struct rtos *os, const char *symbol)
 {
        struct symbol_table_elem *s;
 
-       if (!os->symbols)
-               os->type->get_symbol_list_to_lookup(&os->symbols);
-
-       if (!cur_symbol[0])
-               return &os->symbols[0];
-
        for (s = os->symbols; s->symbol_name; s++)
-               if (!strcmp(s->symbol_name, cur_symbol)) {
-                       s->address = cur_addr;
-                       s++;
+               if (!strcmp(s->symbol_name, symbol))
                        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)
+static struct symbol_table_elem *next_symbol(struct rtos *os, char *cur_symbol, uint64_t cur_addr)
 {
-       for (struct symbol_table_elem *s = os->symbols; s->symbol_name; ++s) {
-               if (!strcmp(s->symbol_name, symbol))
-                       return !s->optional;
-       }
-       return false;
+       if (!os->symbols)
+               os->type->get_symbol_list_to_lookup(&os->symbols);
+
+       if (!cur_symbol[0])
+               return &os->symbols[0];
+
+       struct symbol_table_elem *s = find_symbol(os, cur_symbol);
+       if (!s)
+               return NULL;
+
+       s->address = cur_addr;
+       s++;
+       return s;
 }
 
 /* rtos_qsymbol() processes and replies to all qSymbol packets from GDB.
@@ -234,7 +223,7 @@ int rtos_qsymbol(struct connection *connection, char const *packet, int packet_s
        uint64_t addr = 0;
        size_t reply_len;
        char reply[GDB_BUFFER_SIZE + 1], cur_sym[GDB_BUFFER_SIZE / 2 + 1] = ""; /* Extra byte for null-termination */
-       struct symbol_table_elem *next_sym = NULL;
+       struct symbol_table_elem *next_sym;
        struct target *target = get_target_from_connection(connection);
        struct rtos *os = target->rtos;
 
@@ -248,26 +237,38 @@ int rtos_qsymbol(struct connection *connection, char const *packet, int packet_s
        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 */
+           (!sscanf(packet, "qSymbol:%" SCNx64 ":", &addr))) { /* GDB did not find 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!");
+               struct symbol_table_elem *sym = find_symbol(os, cur_sym);
+
+               if (sym && !sym->optional) {    /* the symbol is mandatory for this RTOS */
+                       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';
+                               /* Next RTOS selected - invalidate current symbol */
+                               cur_sym[0] = '\x00';
+                       }
                }
        }
+
+       LOG_DEBUG("RTOS: Address of symbol '%s' is 0x%" PRIx64, cur_sym, addr);
+
        next_sym = next_symbol(os, cur_sym, addr);
 
+       /* Should never happen unless the debugger misbehaves */
+       if (!next_sym) {
+               LOG_WARNING("RTOS: Debugger sent us qSymbol with '%s' that we did not ask for", cur_sym);
+               goto done;
+       }
+
        if (!next_sym->symbol_name) {
                /* No more symbols need looking up */
 
@@ -291,6 +292,8 @@ int rtos_qsymbol(struct connection *connection, char const *packet, int packet_s
                goto done;
        }
 
+       LOG_DEBUG("RTOS: Requesting symbol lookup of '%s' from the debugger", next_sym->symbol_name);
+
        reply_len = snprintf(reply, sizeof(reply), "qSymbol:");
        reply_len += hexify(reply + reply_len,
                (const uint8_t *)next_sym->symbol_name, strlen(next_sym->symbol_name),
@@ -306,13 +309,13 @@ int rtos_thread_packet(struct connection *connection, char const *packet, int pa
        struct target *target = get_target_from_connection(connection);
 
        if (strncmp(packet, "qThreadExtraInfo,", 17) == 0) {
-               if ((target->rtos) && (target->rtos->thread_details != NULL) &&
+               if ((target->rtos) && (target->rtos->thread_details) &&
                                (target->rtos->thread_count != 0)) {
                        threadid_t threadid = 0;
                        int found = -1;
                        sscanf(packet, "qThreadExtraInfo,%" SCNx64, &threadid);
 
-                       if ((target->rtos) && (target->rtos->thread_details != NULL)) {
+                       if ((target->rtos) && (target->rtos->thread_details)) {
                                int thread_num;
                                for (thread_num = 0; thread_num < target->rtos->thread_count; thread_num++) {
                                        if (target->rtos->thread_details[thread_num].threadid == threadid) {
@@ -416,7 +419,7 @@ int rtos_thread_packet(struct connection *connection, char const *packet, int pa
                threadid_t threadid;
                int found = -1;
                sscanf(packet, "T%" SCNx64, &threadid);
-               if ((target->rtos) && (target->rtos->thread_details != NULL)) {
+               if ((target->rtos) && (target->rtos->thread_details)) {
                        int thread_num;
                        for (thread_num = 0; thread_num < target->rtos->thread_count; thread_num++) {
                                if (target->rtos->thread_details[thread_num].threadid == threadid) {
@@ -564,7 +567,7 @@ int rtos_set_reg(struct connection *connection, int reg_num,
        struct target *target = get_target_from_connection(connection);
        int64_t current_threadid = target->rtos->current_threadid;
        if ((target->rtos) &&
-                       (target->rtos->type->set_reg != NULL) &&
+                       (target->rtos->type->set_reg) &&
                        (current_threadid != -1) &&
                        (current_threadid != 0)) {
                return target->rtos->type->set_reg(target->rtos, reg_num, reg_value);
@@ -605,7 +608,7 @@ int rtos_generic_stack_read(struct target *target,
                LOG_OUTPUT("\r\n");
 #endif
 
-       int64_t new_stack_ptr;
+       target_addr_t new_stack_ptr;
        if (stacking->calculate_process_stack) {
                new_stack_ptr = stacking->calculate_process_stack(target,
                                stack_data, stacking, stack_ptr);
@@ -657,7 +660,7 @@ static int rtos_try_next(struct target *target)
 
 int rtos_update_threads(struct target *target)
 {
-       if ((target->rtos) && (target->rtos->type != NULL))
+       if ((target->rtos) && (target->rtos->type))
                target->rtos->type->update_threads(target->rtos);
        return ERROR_OK;
 }