Skip to contentSkip to conversation

module: Ignore RISC-V mapping symbols too

PATCH Applied Palmer Dabbelt 4 participants 4 messages Jul 7, 2023 – Jul 21, 2023

Subsystems (4)
lore
Share & tools
lore
#0 lore raw

PATCH v2 1/1 module: Ignore RISC-V mapping symbols too

RISC-V has an extended form of mapping symbols that we use to encode the ISA when it changes in the middle of an ELF. This trips up modpost as a build failure, I haven't yet verified it yet but I believe the kallsyms difference should result in stacks looking sane again.

---
Changes since v1 <[email protected]/>:

* Drop the unnecessary IS_RISCV define and just inline it.

---
 include/linux/module_symbol.h | 12 +++++++++++-
 kernel/module/kallsyms.c      |  2 +-
 scripts/mod/modpost.c         |  2 +-
 3 files changed, 13 insertions(+), 3 deletions(-)
include/linux/module_symbol.h +11 -1
index 7ace7ba30203..5b799942b243 100644
@@ -3,12 +3,22 @@
 #define _LINUX_MODULE_SYMBOL_H
 
 /* This ignores the intensely annoying "mapping symbols" found in ELF files. */
-static inline int is_mapping_symbol(const char *str)
+static inline int is_mapping_symbol(const char *str, int is_riscv)
 {
 	if (str[0] == '.' && str[1] == 'L')
 		return true;
 	if (str[0] == 'L' && str[1] == '0')
 		return true;
+	/*
+	 * RISC-V defines various special symbols that start with "$".  The
+	 * mapping symbols, which exist to differentiate between incompatible
+	 * instruction encodings when disassembling, show up all over the place
+	 * and are generally not meant to be treated like other symbols.  So
+	 * just ignore any of the special symbols.
+	 */
+	if (is_riscv)
+		return str[0] == '$';
+
 	return str[0] == '$' &&
 	       (str[1] == 'a' || str[1] == 'd' || str[1] == 't' || str[1] == 'x')
 	       && (str[2] == '\0' || str[2] == '.');
kernel/module/kallsyms.c +1 -1
index ef73ae7c8909..78a1ffc399d9 100644
@@ -289,7 +289,7 @@ static const char *find_kallsyms_symbol(struct module *mod,
 		 * and inserted at a whim.
 		 */
 		if (*kallsyms_symbol_name(kallsyms, i) == '\0' ||
-		    is_mapping_symbol(kallsyms_symbol_name(kallsyms, i)))
+		    is_mapping_symbol(kallsyms_symbol_name(kallsyms, i), IS_ENABLED(CONFIG_RISCV)))
 			continue;
 
 		if (thisval <= addr && thisval > bestval) {
scripts/mod/modpost.c +1 -1
index b29b29707f10..7c71429d6502 100644
@@ -1052,7 +1052,7 @@ static inline int is_valid_name(struct elf_info *elf, Elf_Sym *sym)
 
 	if (!name || !strlen(name))
 		return 0;
-	return !is_mapping_symbol(name);
+	return !is_mapping_symbol(name, elf->hdr->e_machine == EM_RISCV);
 }
 
 /* Look up the nearest symbol based on the section and the address */
Signature · 1 line
2.41.0
Reviewed-by Tested-by on v2 1/1
#1 lore raw
Quoted 8 lines · Palmer Dabbelt

RISC-V has an extended form of mapping symbols that we use to encode the ISA when it changes in the middle of an ELF. This trips up modpost as a build failure, I haven't yet verified it yet but I believe the kallsyms difference should result in stacks looking sane again.

Thanks.

Quoted 64 lines

---
Changes since v1 <[email protected]/>:

* Drop the unnecessary IS_RISCV define and just inline it.

---
 include/linux/module_symbol.h | 12 +++++++++++-
 kernel/module/kallsyms.c      |  2 +-
 scripts/mod/modpost.c         |  2 +-
 3 files changed, 13 insertions(+), 3 deletions(-)
include/linux/module_symbol.h +11 -1
index 7ace7ba30203..5b799942b243 100644
@@ -3,12 +3,22 @@
 #define _LINUX_MODULE_SYMBOL_H
 
 /* This ignores the intensely annoying "mapping symbols" found in ELF files. */
-static inline int is_mapping_symbol(const char *str)
+static inline int is_mapping_symbol(const char *str, int is_riscv)
 {
 	if (str[0] == '.' && str[1] == 'L')
 		return true;
 	if (str[0] == 'L' && str[1] == '0')
 		return true;
+	/*
+	 * RISC-V defines various special symbols that start with "$".  The
+	 * mapping symbols, which exist to differentiate between incompatible
+	 * instruction encodings when disassembling, show up all over the place
+	 * and are generally not meant to be treated like other symbols.  So
+	 * just ignore any of the special symbols.
+	 */
+	if (is_riscv)
+		return str[0] == '$';
+
 	return str[0] == '$' &&
 	       (str[1] == 'a' || str[1] == 'd' || str[1] == 't' || str[1] == 'x')
 	       && (str[2] == '\0' || str[2] == '.');
kernel/module/kallsyms.c +1 -1
index ef73ae7c8909..78a1ffc399d9 100644
@@ -289,7 +289,7 @@ static const char *find_kallsyms_symbol(struct module *mod,
 		 * and inserted at a whim.
 		 */
 		if (*kallsyms_symbol_name(kallsyms, i) == '\0' ||
-		    is_mapping_symbol(kallsyms_symbol_name(kallsyms, i)))
+		    is_mapping_symbol(kallsyms_symbol_name(kallsyms, i), IS_ENABLED(CONFIG_RISCV)))
 			continue;
 
 		if (thisval <= addr && thisval > bestval) {
scripts/mod/modpost.c +1 -1
index b29b29707f10..7c71429d6502 100644
@@ -1052,7 +1052,7 @@ static inline int is_valid_name(struct elf_info *elf, Elf_Sym *sym)
 
 	if (!name || !strlen(name))
 		return 0;
-	return !is_mapping_symbol(name);
+	return !is_mapping_symbol(name, elf->hdr->e_machine == EM_RISCV);
 }
 
 /* Look up the nearest symbol based on the section and the address */
Signature · 1 line
~Randy
maintainer Applied
#2 lore raw
In reply to Palmer Dabbelt
Quoted 8 lines · Palmer Dabbelt

RISC-V has an extended form of mapping symbols that we use to encode the ISA when it changes in the middle of an ELF. This trips up modpost as a build failure, I haven't yet verified it yet but I believe the kallsyms difference should result in stacks looking sane again.

Thanks, applied and pushed!

Luis

maintainer
#3 lore raw
In reply to Palmer Dabbelt

Hello!

Quoted 64 lines · Palmer Dabbelt

RISC-V has an extended form of mapping symbols that we use to encode the ISA when it changes in the middle of an ELF. This trips up modpost as a build failure, I haven't yet verified it yet but I believe the kallsyms difference should result in stacks looking sane again.

---
Changes since v1 <[email protected]/>:

* Drop the unnecessary IS_RISCV define and just inline it.

---
  include/linux/module_symbol.h | 12 +++++++++++-
  kernel/module/kallsyms.c      |  2 +-
  scripts/mod/modpost.c         |  2 +-
  3 files changed, 13 insertions(+), 3 deletions(-)
include/linux/module_symbol.h +11 -1
index 7ace7ba30203..5b799942b243 100644
@@ -3,12 +3,22 @@
  #define _LINUX_MODULE_SYMBOL_H
 
  /* This ignores the intensely annoying "mapping symbols" found in ELF files. */
-static inline int is_mapping_symbol(const char *str)
+static inline int is_mapping_symbol(const char *str, int is_riscv)
  {
  	if (str[0] == '.' && str[1] == 'L')
  		return true;
  	if (str[0] == 'L' && str[1] == '0')
  		return true;
+	/*
+	 * RISC-V defines various special symbols that start with "$".  The
+	 * mapping symbols, which exist to differentiate between incompatible
+	 * instruction encodings when disassembling, show up all over the place
+	 * and are generally not meant to be treated like other symbols.  So
+	 * just ignore any of the special symbols.
+	 */
+	if (is_riscv)
+		return str[0] == '$';
+
  	return str[0] == '$' &&
  	       (str[1] == 'a' || str[1] == 'd' || str[1] == 't' || str[1] == 'x')
  	       && (str[2] == '\0' || str[2] == '.');
kernel/module/kallsyms.c +1 -1
index ef73ae7c8909..78a1ffc399d9 100644
@@ -289,7 +289,7 @@ static const char *find_kallsyms_symbol(struct module *mod,
  		 * and inserted at a whim.
  		 */
  		if (*kallsyms_symbol_name(kallsyms, i) == '\0' ||
-		    is_mapping_symbol(kallsyms_symbol_name(kallsyms, i)))
+		    is_mapping_symbol(kallsyms_symbol_name(kallsyms, i), IS_ENABLED(CONFIG_RISCV)))
  			continue;
 
  		if (thisval <= addr && thisval > bestval) {
scripts/mod/modpost.c +0 -0
index b29b29707f10..7c71429d6502 100644

scripts/mod/modpost.c static inline int is_valid_name(struct elf_info *elf, Elf_Sym *sym) · line 1058

Quoted 8 lines
scripts/mod/modpost.c +1 -1
@@ -1052,7 +1052,7 @@ static inline int is_valid_name(struct elf_info *elf, Elf_Sym *sym)
 
  	if (!name || !strlen(name))
  		return 0;
-	return !is_mapping_symbol(name);
+	return !is_mapping_symbol(name, elf->hdr->e_machine == EM_RISCV);
  }
 
  /* Look up the nearest symbol based on the section and the address */

Since this commit was added, our builders are failing with the following error ...

kernel/scripts/mod/modpost.c: In function ‘is_valid_name’:
kernel/scripts/mod/modpost.c:1055:57: error: ‘EM_RISCV’ undeclared (first use in this function)

  return !is_mapping_symbol(name, elf->hdr->e_machine == EM_RISCV);
                                                         ^

We have had some cases of this before [0] and was fixed by ensuring this is defined if it is not.

Thanks
Jon

[0] https://patchwork.kernel.org/project/linux-mm/patch/20210924224338.8vuOlQPWr%[email protected]/

Signature · 1 line
nvpublic