openocd: fix SPDX tag format for files .c
[fw/openocd] / src / rtos / rtos.c
index 3c3896de307e06d44ba9b9f5a21ce9aa63f413f5..2e76b501ae26816e311d86bcc02f4f51152073f7 100644 (file)
@@ -1,4 +1,4 @@
-/* SPDX-License-Identifier: GPL-2.0-or-later */
+// SPDX-License-Identifier: GPL-2.0-or-later
 
 /***************************************************************************
  *   Copyright (C) 2011 by Broadcom Corporation                            *
@@ -198,14 +198,6 @@ static struct symbol_table_elem *next_symbol(struct rtos *os, char *cur_symbol,
        return s;
 }
 
-/* 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)
-{
-       struct symbol_table_elem *s = find_symbol(os, symbol);
-       return s && !s->optional;
-}
-
 /* rtos_qsymbol() processes and replies to all qSymbol packets from GDB.
  *
  * GDB sends a qSymbol:: packet (empty address, empty name) to notify
@@ -223,6 +215,12 @@ static bool is_symbol_mandatory(const struct rtos *os, const char *symbol)
  * specified explicitly, then no further symbol lookup is done. When
  * auto-detecting, the RTOS driver _detect() function must return success.
  *
+ * The symbol is tried twice to handle the -flto case with gcc.  The first
+ * attempt uses the symbol as-is, and the second attempt tries the symbol
+ * with ".lto_priv.0" appended to it.  We only consider the first static
+ * symbol here from the -flto case.  (Each subsequent static symbol with
+ * the same name is exported as .lto_priv.1, .lto_priv.2, etc.)
+ *
  * rtos_qsymbol() returns 1 if an RTOS has been detected, or 0 otherwise.
  */
 int rtos_qsymbol(struct connection *connection, char const *packet, int packet_size)
@@ -231,7 +229,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;
+       struct symbol_table_elem *next_sym = NULL;
        struct target *target = get_target_from_connection(connection);
        struct rtos *os = target->rtos;
 
@@ -244,33 +242,60 @@ int rtos_qsymbol(struct connection *connection, char const *packet, int packet_s
        size_t len = unhexify((uint8_t *)cur_sym, strchr(packet + 8, ':') + 1, strlen(strchr(packet + 8, ':') + 1));
        cur_sym[len] = 0;
 
+       const char no_suffix[] = "";
+       const char lto_suffix[] = ".lto_priv.0";
+       const size_t lto_suffix_len = strlen(lto_suffix);
+
+       const char *cur_suffix;
+       const char *next_suffix;
+
+       /* Detect what suffix was used during the previous symbol lookup attempt, and
+        * speculatively determine the next suffix (only used for the unknown address case) */
+       if (len > lto_suffix_len && !strcmp(cur_sym + len - lto_suffix_len, lto_suffix)) {
+               /* Trim the suffix from cur_sym for comparison purposes below */
+               cur_sym[len - lto_suffix_len] = '\0';
+               cur_suffix = lto_suffix;
+               next_suffix = NULL;
+       } else {
+               cur_suffix = no_suffix;
+               next_suffix = lto_suffix;
+       }
+
        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 (next_suffix) {
+                       next_sym = sym;
+               } else 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);
+       LOG_DEBUG("RTOS: Address of symbol '%s%s' is 0x%" PRIx64, cur_sym, cur_suffix, addr);
 
-       next_sym = next_symbol(os, cur_sym, addr);
+       if (!next_sym) {
+               next_sym = next_symbol(os, cur_sym, addr);
+               next_suffix = no_suffix;
+       }
 
        /* 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);
+               LOG_WARNING("RTOS: Debugger sent us qSymbol with '%s%s' that we did not ask for", cur_sym, cur_suffix);
                goto done;
        }
 
@@ -292,17 +317,26 @@ int rtos_qsymbol(struct connection *connection, char const *packet, int packet_s
                }
        }
 
-       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);
+       assert(next_suffix);
+
+       reply_len = 8;                                   /* snprintf(..., "qSymbol:") */
+       reply_len += 2 * strlen(next_sym->symbol_name);  /* hexify(..., next_sym->symbol_name, ...) */
+       reply_len += 2 * strlen(next_suffix);            /* hexify(..., next_suffix, ...) */
+       reply_len += 1;                                  /* Terminating NUL */
+       if (reply_len > sizeof(reply)) {
+               LOG_ERROR("ERROR: RTOS symbol '%s%s' name is too long for GDB!", next_sym->symbol_name, next_suffix);
                goto done;
        }
 
-       LOG_DEBUG("RTOS: Requesting symbol lookup of '%s' from the debugger", next_sym->symbol_name);
+       LOG_DEBUG("RTOS: Requesting symbol lookup of '%s%s' from the debugger", next_sym->symbol_name, next_suffix);
 
        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),
                sizeof(reply) - reply_len);
+       reply_len += hexify(reply + reply_len,
+               (const uint8_t *)next_suffix, strlen(next_suffix),
+               sizeof(reply) - reply_len);
 
 done:
        gdb_put_packet(connection, reply, reply_len);