Add build ID to stacktraces
Subsystems (12)
v4 cover Add build ID to stacktraces
This series adds the kernel's build ID[1] to the stacktrace header printed in oops messages, warnings, etc. and the build ID for any module that appears in the stacktrace after the module name. The goal is to make the stacktrace more self-contained and descriptive by including the relevant build IDs in the kernel logs when something goes wrong. This can be used by post processing tools like script/decode_stacktrace.sh and kernel developers to easily locate the debug info associated with a kernel crash and line up what line and file things started falling apart at.
To show how this can be used I've included a patch to decode_stacktrace.sh that downloads the debuginfo from a debuginfod server.
This also includes some patches to make the buildid.c file use more const arguments and consolidate logic into buildid.c from kdump. These are left to the end as they were mostly cleanup patches. I don't know who exactly maintains this so I guess Andrew is the best option to merge all this code.
Here's an example lkdtm stacktrace on arm64.
WARNING: CPU: 4 PID: 3255 at drivers/misc/lkdtm/bugs.c:83 lkdtm_WARNING+0x28/0x30 [lkdtm] Modules linked in: lkdtm rfcomm algif_hash algif_skcipher af_alg xt_cgroup uinput xt_MASQUERADE CPU: 4 PID: 3255 Comm: bash Not tainted 5.11 #3 aa23f7a1231c229de205662d5a9e0d4c580f19a1 Hardware name: Google Lazor (rev3+) with KB Backlight (DT) pstate: 00400009 (nzcv daif +PAN -UAO -TCO BTYPE=--) pc : lkdtm_WARNING+0x28/0x30 [lkdtm] lr : lkdtm_do_action+0x24/0x40 [lkdtm] sp : ffffffc0134fbca0 x29: ffffffc0134fbca0 x28: ffffff92d53ba240 x27: 0000000000000000 x26: 0000000000000000 x25: 0000000000000000 x24: ffffffe3622352c0 x23: 0000000000000020 x22: ffffffe362233366 x21: ffffffe3622352e0 x20: ffffffc0134fbde0 x19: 0000000000000008 x18: 0000000000000000 x17: ffffff929b6536fc x16: 0000000000000000 x15: 0000000000000000 x14: 0000000000000012 x13: ffffffe380ed892c x12: ffffffe381d05068 x11: 0000000000000000 x10: 0000000000000000 x9 : 0000000000000001 x8 : ffffffe362237000 x7 : aaaaaaaaaaaaaaaa x6 : 0000000000000000 x5 : 0000000000000000 x4 : 0000000000000001 x3 : 0000000000000008 x2 : ffffff93fef25a70 x1 : ffffff93fef15788 x0 : ffffffe3622352e0 Call trace: lkdtm_WARNING+0x28/0x30 [lkdtm ed5019fdf5e53be37cb1ba7899292d7e143b259e] direct_entry+0x16c/0x1b4 [lkdtm ed5019fdf5e53be37cb1ba7899292d7e143b259e] full_proxy_write+0x74/0xa4 vfs_write+0xec/0x2e8 ksys_write+0x84/0xf0 __arm64_sys_write+0x24/0x30 el0_svc_common+0xf4/0x1c0 do_el0_svc_compat+0x28/0x3c el0_svc_compat+0x10/0x1c el0_sync_compat_handler+0xa8/0xcc el0_sync_compat+0x178/0x180 ---[ end trace 3d95032303e59e68 ]---
Changes from v3 (https://lore.kernel.org/r/[email protected]):
* Fixed compilation warnings due to config changes
* Fixed kernel-doc on init_vmlinx_build_id()
* Totally removed add_build_id_vmcoreinfo()
* Added another printk format %pBb to help x86 print backtraces
* Some BUILD_BUG_ON() checks to make sure the buildid doesn't get bigger or smaller
Changes from v2 (https://lore.kernel.org/r/[email protected]):
* Renamed symbol printing function to indicate build IDness
* Put build ID information behind Kconfig knob
* Build ID for vmlinux is calculated in early init instead of on demand
* printk format is %pS[R]b
Changes from v1 (https://lore.kernel.org/r/[email protected]):
* New printk format %pSb and %pSr
* Return binary format instead of hex format string from build ID APIs
* Some new patches to cleanup buildid/decode_stacktrace.sh
* A new patch to decode_stacktrace.sh to parse output
[1] https://fedoraproject.org/wiki/Releases/FeatureBuildId
Stephen Boyd (13):
buildid: Only consider GNU notes for build ID parsing
buildid: Add API to parse build ID out of buffer
buildid: Stash away kernels build ID on init
dump_stack: Add vmlinux build ID to stack traces
module: Add printk formats to add module build ID to stacktraces
arm64: stacktrace: Use %pSb for backtrace printing x86/dumpstack: Use %pSb/%pBb for backtrace printing scripts/decode_stacktrace.sh: Support debuginfod scripts/decode_stacktrace.sh: Silence stderr messages from
addr2line/nm
scripts/decode_stacktrace.sh: Indicate 'auto' can be used for base
path
buildid: Mark some arguments const
buildid: Fix kernel-doc notation
kdump: Use vmlinux_build_id to simplify
Documentation/core-api/printk-formats.rst | 11 +++ arch/arm64/kernel/stacktrace.c | 2 +- arch/x86/kernel/dumpstack.c | 6 +- include/linux/buildid.h | 4 + include/linux/crash_core.h | 7 +- include/linux/kallsyms.h | 20 ++++- include/linux/module.h | 6 +- init/main.c | 1 + kernel/crash_core.c | 50 +----------- kernel/kallsyms.c | 95 ++++++++++++++++++----- kernel/module.c | 24 +++++- lib/Kconfig.debug | 11 +++ lib/buildid.c | 72 +++++++++++++---- lib/dump_stack.c | 13 +++- lib/vsprintf.c | 8 +- scripts/decode_stacktrace.sh | 89 +++++++++++++++++---- 16 files changed, 304 insertions(+), 115 deletions(-)
base-commit: a38fd8748464831584a19438cbb3082b5a2dab15
Signature · 1 line
https://chromeos.dev
PATCH v4 1/13 buildid: Only consider GNU notes for build ID parsing
Some kernel elf files have various notes that also happen to have an elf note type of '3', which matches NT_GNU_BUILD_ID but the note name isn't "GNU". For example, this note trips up the existing logic:
Owner Data size Description Xen 0x00000008 Unknown note type: (0x00000003) description data: 00 00 00 ffffff80 ffffffff ffffffff ffffffff ffffffff
Let's make sure that it is a GNU note when parsing the build ID so that we can use this function to parse a vmlinux's build ID too.
--- lib/buildid.c | 1 + 1 file changed, 1 insertion(+)
lib/buildid.c +1 -0
@@ -31,6 +31,7 @@ static inline int parse_build_id(void *page_addr,if (nhdr->n_type ==BUILD_ID && nhdr->n_namesz ==sizeof ("GNU" ) && + !strcmp ((char *)(nhdr +1 ),"GNU" ) && nhdr->n_descsz >0 && nhdr->n_descsz <=BUILD_ID_SIZE_MAX ) { memcpy(build_id,
Signature · 1 line
https://chromeos.dev
Re: [PATCH v4 01/13] buildid: Only consider GNU notes for build ID parsing
Quoted 10 lines · Stephen Boyd
Some kernel elf files have various notes that also happen to have an elf note type of '3', which matches
NT_GNU_BUILD_IDbut the note name isn't "GNU". For example, this note trips up the existing logic:Owner Data size Description Xen 0x00000008 Unknown note type: (0x00000003) description data: 00 00 00 ffffff80 ffffffff ffffffff ffffffff ffffffffLet's make sure that it is a GNU note when parsing the build ID so that we can use this function to parse a vmlinux's build ID too.
Quoted 8 lines
Reported-by Petr Mladek <[email protected]>Cc Jiri Olsa <[email protected]>Cc Alexei Starovoitov <[email protected]>Cc Jessica Yu <[email protected]>Cc Evan Green <[email protected]>Cc Hsin-Yi Wang <[email protected]>Fixes bd7525dacd7e ("bpf: Move stack_map_get_build_id into lib")Signed-off-by Stephen Boyd <[email protected]>
Best Regards,
Petr
PATCH v4 2/13 buildid: Add API to parse build ID out of buffer
In reply to Stephen BoydAdd an API that can parse the build ID out of a buffer, instead of a vma, to support printing a kernel module's build ID for stack traces.
--- include/linux/buildid.h | 1 + lib/buildid.c | 50 ++++++++++++++++++++++++++++++----------- 2 files changed, 38 insertions(+), 13 deletions(-)
include/linux/buildid.h +1 -0
@@ -8,5 +8,6 @@int build_id_parse (struct vm_area_struct *vma,unsigned char *build_id,__u32 *size); +int build_id_parse_buf (const void *buf,unsigned char *build_id,u32 buf_size);#endif
lib/buildid.c +37 -13
79 lines not on this page · raw message
Signature · 1 line
https://chromeos.dev
PATCH v4 3/13 buildid: Stash away kernels build ID on init
In reply to Stephen BoydParse the kernel's build ID at initialization so that other code can print a hex format string representation of the running kernel's build ID. This will be used in the kdump and dump_stack code so that developers can easily locate the vmlinux debug symbols for a crash/stacktrace.
--- include/linux/buildid.h | 3 +++ init/main.c | 1 + lib/buildid.c | 15 +++++++++++++++ 3 files changed, 19 insertions(+)
include/linux/buildid.h +3 -0
@@ -10,4 +10,7 @@ int build_id_parse(struct vm_area_struct *vma, unsigned char *build_id, __u32 *size);int build_id_parse_buf (const void *buf,unsigned char *build_id,u32 buf_size); +extern unsigned char vmlinux_build_id[BUILD_ID_SIZE_MAX ]; +void init_vmlinux_build_id (void ); +#endif
init/main.c +1 -0
@@ -857,6 +857,7 @@ asmlinkage __visible void __init __no_sanitize_address start_kernel(void)set_task_stack_end_magic (&init_task);smp_setup_processor_id ();debug_objects_early_init (); +init_vmlinux_build_id ();cgroup_init_early ();
lib/buildid.c +15 -0
@@ -1,6 +1,7 @@// SPDX-License-Identifier: GPL-2.0 #include <linux/buildid.h> +#include <linux/cache.h> #include <linux/elf.h> #include <linux/kernel.h> #include <linux/pagemap.h>
@@ -172,3 +173,17 @@ int build_id_parse_buf(const void *buf, unsigned char *build_id, u32 buf_size) {return parse_build_id_buf (build_id,NULL , buf, buf_size); } + +unsigned char vmlinux_build_id[BUILD_ID_SIZE_MAX ]__ro_after_init ; + +/** +* init_vmlinux_build_id - Compute and stash the running kernel's build ID +*/ +void __init init_vmlinux_build_id (void ) +{ +extern const void __start_notes__weak ; +extern const void __stop_notes__weak ; +unsigned int size = &__stop_notes - &__start_notes; + +build_id_parse_buf (&__start_notes, vmlinux_build_id, size); +}
Signature · 7 lines
https://chromeos.dev _______________________________________________ kexec mailing list [email protected] http://lists.infradead.org/mailman/listinfo/kexec
PATCH v4 4/13 dump_stack: Add vmlinux build ID to stack traces
In reply to Stephen BoydAdd the running kernel's build ID[1] to the stacktrace information header. This makes it simpler for developers to locate the vmlinux with full debuginfo for a particular kernel stacktrace. Combined with scripts/decode_stracktrace.sh, a developer can download the correct vmlinux from a debuginfod[2] server and find the exact file and line number for the functions plus offsets in a stacktrace.
This is especially useful for pstore crash debugging where the kernel crashes are recorded in the pstore logs and the recovery kernel is different or the debuginfo doesn't exist on the device due to space concerns (the data can be large and a security concern). The stacktrace can be analyzed after the crash by using the build ID to find the matching vmlinux and understand where in the function something went wrong.
Example stacktrace from lkdtm:
WARNING: CPU: 4 PID: 3255 at drivers/misc/lkdtm/bugs.c:83 lkdtm_WARNING+0x28/0x30 [lkdtm] Modules linked in: lkdtm rfcomm algif_hash algif_skcipher af_alg xt_cgroup uinput xt_MASQUERADE CPU: 4 PID: 3255 Comm: bash Not tainted 5.11 #3 aa23f7a1231c229de205662d5a9e0d4c580f19a1 Hardware name: Google Lazor (rev3+) with KB Backlight (DT) pstate: 00400009 (nzcv daif +PAN -UAO -TCO BTYPE=--) pc : lkdtm_WARNING+0x28/0x30 [lkdtm]
The hex string aa23f7a1231c229de205662d5a9e0d4c580f19a1 is the build ID, following the kernel version number. Put it all behind a config option, STACKTRACE_BUILD_ID, so that kernel developers can remove this information if they decide it is too much.
--- lib/Kconfig.debug | 11 +++++++++++ lib/dump_stack.c | 13 +++++++++++-- 2 files changed, 22 insertions(+), 2 deletions(-)
lib/Kconfig.debug +11 -0
@@ -35,6 +35,17 @@ config PRINTK_CALLER no option to enable/disable at the kernel command line parameter or sysfs interface. +config STACKTRACE_BUILD_ID + bool "Show build ID information in stacktraces" + depends on PRINTK + help + Selecting this option adds build ID information for symbols in + stacktraces printed with the printk format '%p[SR]b'. + + This option is intended for distros where debuginfo is not easily + accessible but can be downloaded given the build ID of the vmlinux or + kernel module where the function is located. + config CONSOLE_LOGLEVEL_DEFAULT int "Default console loglevel (1-15)" range 1 15
lib/dump_stack.c +11 -2
@@ -5,6 +5,7 @@*/ #include <linux/kernel.h> +#include <linux/buildid.h> #include <linux/export.h> #include <linux/sched.h> #include <linux/sched/debug.h>
@@ -36,6 +37,14 @@ void __init dump_stack_set_arch_desc(const char *fmt, ...)va_end (args); } +#if IS_ENABLED (CONFIG_STACKTRACE_BUILD_ID ) +#define BUILD_ID_FMT " %20phN" +#define BUILD_ID_VAL vmlinux_build_id +#else +#define BUILD_ID_FMT "%s" +#define BUILD_ID_VAL "" +#endif +/** * dump_stack_print_info - print generic debug info for dump_stack() * @log_lvl: log level
@@ -45,13 +54,13 @@ void __init dump_stack_set_arch_desc(const char *fmt, ...)*/ void dump_stack_print_info (const char *log_lvl) { -printk ("%sCPU: %d PID: %d Comm: %.20s %s%s %s %.*s\n" , +printk ("%sCPU: %d PID: %d Comm: %.20s %s%s %s %.*s" BUILD_ID_FMT "\n" , log_lvl,raw_smp_processor_id (), current->pid, current->comm,kexec_crash_loaded () ?"Kdump: loaded " :"" ,print_tainted (),init_utsname ()->release, (int )strcspn (init_utsname ()->version," " ), -init_utsname ()->version); +init_utsname ()->version,BUILD_ID_VAL );if (dump_stack_arch_desc_str[0 ] !='\0' ) printk("%sHardware name: %s\n",
Signature · 1 line
https://chromeos.dev
Re: [PATCH v4 04/13] dump_stack: Add vmlinux build ID to stack traces
Quoted 29 lines · Stephen Boyd
Add the running kernel's build ID[1] to the stacktrace information header. This makes it simpler for developers to locate the vmlinux with full debuginfo for a particular kernel stacktrace. Combined with
scripts/decode_stracktrace.sh, a developer can download the correct vmlinux from a debuginfod[2] server and find the exact file and line number for the functions plus offsets in a stacktrace.This is especially useful for pstore crash debugging where the kernel crashes are recorded in the pstore logs and the recovery kernel is different or the debuginfo doesn't exist on the device due to space concerns (the data can be large and a security concern). The stacktrace can be analyzed after the crash by using the build ID to find the matching vmlinux and understand where in the function something went wrong.
Example stacktrace from lkdtm:
WARNING: CPU: 4 PID: 3255 at drivers/misc/lkdtm/bugs.c:83 lkdtm_WARNING+0x28/0x30 [lkdtm] Modules linked in: lkdtm rfcomm algif_hash algif_skcipher af_alg xt_cgroup uinput xt_MASQUERADE CPU: 4 PID: 3255 Comm: bash Not tainted 5.11 #3 aa23f7a1231c229de205662d5a9e0d4c580f19a1 Hardware name: Google Lazor (rev3+) with KB Backlight (DT) pstate: 00400009 (nzcv daif +PAN -UAO -TCO BTYPE=--) pc : lkdtm_WARNING+0x28/0x30 [lkdtm]The hex string
aa23f7a1231c229de205662d5a9e0d4c580f19a1is the build ID, following the kernel version number. Put it all behind a config option,STACKTRACE_BUILD_ID, so that kernel developers can remove this information if they decide it is too much.
Quoted 12 lines
Cc Jiri Olsa <[email protected]>Cc Alexei Starovoitov <[email protected]>Cc Jessica Yu <[email protected]>Cc Evan Green <[email protected]>Cc Hsin-Yi Wang <[email protected]>Cc Petr Mladek <[email protected]>Cc Steven Rostedt <[email protected]>Cc Andy Shevchenko <[email protected]>Cc Matthew Wilcox <[email protected]>Signed-off-by Stephen Boyd <[email protected]>
One comment below.
Quoted 40 lines
--- lib/Kconfig.debug | 11 +++++++++++ lib/dump_stack.c | 13 +++++++++++-- 2 files changed, 22 insertions(+), 2 deletions(-)lib/Kconfig.debug +11
-0@@ -35,6 +35,17 @@ config PRINTK_CALLER no option to enable/disable at the kernel command line parameter or sysfs interface. +config STACKTRACE_BUILD_ID + bool "Show build ID information in stacktraces" + depends on PRINTK + help + Selecting this option adds build ID information for symbols in + stacktraces printed with the printk format '%p[SR]b'. + + This option is intended for distros where debuginfo is not easily + accessible but can be downloaded given the build ID of the vmlinux or + kernel module where the function is located. + config CONSOLE_LOGLEVEL_DEFAULT int "Default console loglevel (1-15)" range 1 15lib/dump_stack.c +1
-0@@ -5,6 +5,7 @@*/ #include <linux/kernel.h> +#include <linux/buildid.h> #include <linux/export.h> #include <linux/sched.h> #include <linux/sched/debug.h>
lib/dump_stack.c void __init dump_stack_set_arch_desc(const char *fmt, ...) · line 46
Quoted 10 lines
lib/dump_stack.c +7
-0@@ -36,6 +37,14 @@ void __init dump_stack_set_arch_desc(const char *fmt, ...)va_end (args); } +#if IS_ENABLED (CONFIG_STACKTRACE_BUILD_ID ) +#define BUILD_ID_FMT " %20phN" +#define BUILD_ID_VAL vmlinux_build_id +#else +#define BUILD_ID_FMT "%s" +#define BUILD_ID_VAL "" +#endif
3rd patch always defines and initializes vmlinux_build_id. But it is used only when CONFIG_STACKTRACE_BUILD_ID is enabled.
Is it intentional, please?
It is not a big deal for vmlinux_build_id. But it is more questionable for the per-module id. I am going to open this question for 5th patch as well.
Best Regards,
Petr
Re: [PATCH v4 04/13] dump_stack: Add vmlinux build ID to stack traces
Quoting Petr Mladek (2021-04-13 07:41:11)
Quoted 16 lines
Quoted 16 lines
lib/dump_stack.c +1
-0@@ -5,6 +5,7 @@*/ #include <linux/kernel.h> +#include <linux/buildid.h> #include <linux/export.h> #include <linux/sched.h> #include <linux/sched/debug.h> @@ -36,6 +37,14 @@ void __init dump_stack_set_arch_desc(const char *fmt, ...)va_end (args); }
Quoted 10 lines
lib/dump_stack.c void __init dump_stack_set_arch_desc(const char *fmt, ...) · line 46
Quoted 7 lines
lib/dump_stack.c +7
-0+#if IS_ENABLED (CONFIG_STACKTRACE_BUILD_ID ) +#define BUILD_ID_FMT " %20phN" +#define BUILD_ID_VAL vmlinux_build_id +#else +#define BUILD_ID_FMT "%s" +#define BUILD_ID_VAL "" +#endif 3rd patch always defines and initializes
vmlinux_build_id. But it is used only whenCONFIG_STACKTRACE_BUILD_IDis enabled.
It is also used for crash code.
Quoted 1 line
Is it intentional, please?
Yes, mostly for simplicity with the other user.
Quoted 5 lines
It is not a big deal for
vmlinux_build_id. But it is more questionable for the per-module id. I am going to open this question for 5th patch as well.
Right, for the vmlinux_build_id symbol it is not exported, and the whole buildid.c file is part of lib-y, so if the symbol isn't used the linker should drop it during link phase. I can drop the early init call if the config is disabled and crash kernel code isn't enabled, and then rely on the linker to drop the vmlinux_build_id symbol. Let me see if that can work so that we don't have to parse it at boot if it is never used.
PATCH v4 5/13 module: Add printk formats to add module build ID to stacktraces
In reply to Stephen BoydLet's make kernel stacktraces easier to identify by including the build ID[1] of a module if the stacktrace is printing a symbol from a module. This makes it simpler for developers to locate a kernel module's full debuginfo for a particular stacktrace. Combined with scripts/decode_stracktrace.sh, a developer can download the matching debuginfo from a debuginfod[2] server and find the exact file and line number for the functions plus offsets in a stacktrace that match the module. This is especially useful for pstore crash debugging where the kernel crashes are recorded in something like console-ramoops and the recovery kernel/modules are different or the debuginfo doesn't exist on the device due to space concerns (the debuginfo can be too large for space limited devices).
Originally, I put this on the %pS format, but that was quickly rejected given that %pS is used in other places such as ftrace where build IDs aren't meaningful. There was some discussions on the list to put every module build ID into the "Modules linked in:" section of the stacktrace message but that quickly becomes very hard to read once you have more than three or four modules linked in. It also provides too much information when we don't expect each module to be traversed in a stacktrace. Having the build ID for modules that aren't important just makes things messy. Splitting it to multiple lines for each module quickly explodes the number of lines printed in an oops too, possibly wrapping the warning off the console. And finally, trying to stash away each module used in a callstack to provide the ID of each symbol printed is cumbersome and would require changes to each architecture to stash away modules and return their build IDs once unwinding has completed.
Instead, we opt for the simpler approach of introducing new printk formats '%pS[R]b' for "pointer symbolic backtrace with module build ID" and '%pBb' for "pointer backtrace with module build ID" and then updating the few places in the architecture layer where the stacktrace is printed to use this new format.
Example:
WARNING: CPU: 3 PID: 3373 at drivers/misc/lkdtm/bugs.c:83 lkdtm_WARNING+0x28/0x30 [lkdtm] Modules linked in: lkdtm rfcomm algif_hash algif_skcipher af_alg xt_cgroup uinput xt_MASQUERADE hci_uart <modules trimmed> CPU: 3 PID: 3373 Comm: bash Not tainted 5.11 #12 a8c0d47f7051f3e6670ceaea724af66a39c6cec8 Hardware name: Google Lazor (rev3+) with KB Backlight (DT) pstate: 00400009 (nzcv daif +PAN -UAO -TCO BTYPE=--) pc : lkdtm_WARNING+0x28/0x30 [lkdtm] lr : lkdtm_do_action+0x24/0x40 [lkdtm] sp : ffffffc013febca0 x29: ffffffc013febca0 x28: ffffff88d9438040 x27: 0000000000000000 x26: 0000000000000000 x25: 0000000000000000 x24: ffffffdd0e9772c0 x23: 0000000000000020 x22: ffffffdd0e975366 x21: ffffffdd0e9772e0 x20: ffffffc013febde0 x19: 0000000000000008 x18: 0000000000000000 x17: 0000000000000000 x16: 0000000000000037 x15: ffffffdd102ab174 x14: 0000000000000003 x13: 0000000000000004 x12: 0000000000000000 x11: 0000000000000000 x10: 0000000000000000 x9 : 0000000000000001 x8 : ffffffdd0e979000 x7 : 0000000000000000 x6 : ffffffdd10ff6b54 x5 : 0000000000000000 x4 : 0000000000000000 x3 : ffffffc013feb938 x2 : ffffff89fef05a70 x1 : ffffff89feef5788 x0 : ffffffdd0e9772e0 Call trace: lkdtm_WARNING+0x28/0x30 [lkdtm 6c2215028606bda50de823490723dc4bc5bf46f9] direct_entry+0x16c/0x1b4 [lkdtm 6c2215028606bda50de823490723dc4bc5bf46f9] full_proxy_write+0x74/0xa4 vfs_write+0xec/0x2e8 ksys_write+0x84/0xf0 __arm64_sys_write+0x24/0x30 el0_svc_common+0xf4/0x1c0 do_el0_svc_compat+0x28/0x3c el0_svc_compat+0x10/0x1c el0_sync_compat_handler+0xa8/0xcc el0_sync_compat+0x178/0x180 ---[ end trace f89bc7f5417cbcc6 ]---
--- Documentation/core-api/printk-formats.rst | 11 +++ include/linux/kallsyms.h | 20 ++++- include/linux/module.h | 6 +- kernel/kallsyms.c | 95 ++++++++++++++++++----- kernel/module.c | 24 +++++- lib/vsprintf.c | 8 +- 6 files changed, 139 insertions(+), 25 deletions(-)
Documentation/core-api/printk-formats.rst +11 -0
@@ -114,6 +114,17 @@ used when printing stack backtraces. The specifier takes into consideration the effect of compiler optimisations which may occur when tail-calls are used and marked with the noreturn GCC attribute. +If the pointer is within a module, the module name and optionally build ID is +printed after the symbol name with an extra ``b`` appended to the end of the +specifier. + +:: + %pS versatile_init+0x0/0x110 [module_name] + %pSb versatile_init+0x0/0x110 [module_name ed5019fdf5e53be37cb1ba7899292d7e143b259e] + %pSRb versatile_init+0x9/0x110 [module_name ed5019fdf5e53be37cb1ba7899292d7e143b259e] + (with __builtin_extract_return_addr() translation) + %pBb prev_fn_of_versatile_init+0x88/0x88 [module_name ed5019fdf5e53be37cb1ba7899292d7e143b259e] + Probed Pointers from BPF / tracing ----------------------------------
include/linux/kallsyms.h +18 -2
@@ -7,6 +7,7 @@#define _LINUX_KALLSYMS_H#include <linux/errno.h> +#include <linux/buildid.h> #include <linux/kernel.h> #include <linux/stddef.h> #include <linux/mm.h>
@@ -15,8 +16,9 @@#include <asm/sections.h> #define KSYM_NAME_LEN 128 -#define KSYM_SYMBOL_LEN (sizeof("%s+%#lx/%#lx [%s]") + (KSYM_NAME_LEN - 1) + \ - 2*(BITS_PER_LONG*3/10) + (MODULE_NAME_LEN - 1) + 1) +#define KSYM_SYMBOL_LEN (sizeof("%s+%#lx/%#lx [%s %s]") + (KSYM_NAME_LEN - 1) + \ + 2*(BITS_PER_LONG*3/10) + (MODULE_NAME_LEN - 1) + \ + (BUILD_ID_SIZE_MAX * 2) + 1)struct cred ;struct module ;
@@ -91,8 +93,10 @@ const char *kallsyms_lookup(unsigned long addr,/* Look up a kernel symbol and return it in a text buffer. */ extern int sprint_symbol (char *buffer,unsigned long address); +extern int sprint_symbol_build_id (char *buffer,unsigned long address);extern int sprint_symbol_no_offset (char *buffer,unsigned long address);extern int sprint_backtrace (char *buffer,unsigned long address); +extern int sprint_backtrace_build_id (char *buffer,unsigned long address);int lookup_symbol_name (unsigned long addr,char *symname);int lookup_symbol_attrs (unsigned long addr,unsigned long *size,unsigned long *offset,char *modname,char *name);
@@ -128,6 +132,12 @@ static inline int sprint_symbol(char *buffer, unsigned long addr)return 0 ; } +static inline int sprint_symbol_build_id (char *buffer,unsigned long address) +{ + *buffer ='\0' ; +return 0 ; +} +static inline int sprint_symbol_no_offset (char *buffer,unsigned long addr) { *buffer ='\0' ;
@@ -140,6 +150,12 @@ static inline int sprint_backtrace(char *buffer, unsigned long addr)return 0 ; } +static inline int sprint_backtrace_build_id (char *buffer,unsigned long addr) +{ + *buffer ='\0' ; +return 0 ; +} +static inline int lookup_symbol_name (unsigned long addr,char *symname) {return -ERANGE ;
include/linux/module.h +5 -1
@@ -11,6 +11,7 @@#include <linux/list.h> #include <linux/stat.h> +#include <linux/buildid.h> #include <linux/compiler.h> #include <linux/cache.h> #include <linux/kmod.h>
@@ -367,6 +368,9 @@ struct module {/* Unique handle for this module */ char name[MODULE_NAME_LEN ]; +/* Module build ID */ +unsigned char build_id[BUILD_ID_SIZE_MAX ]; +/* Sysfs stuff. */ struct module_kobject mkobj;struct module_attribute *modinfo_attrs;
@@ -630,7 +634,7 @@ void *dereference_module_function_descriptor(struct module *mod, void *ptr);const char *module_address_lookup (unsigned long addr,unsigned long *symbolsize,unsigned long *offset, -char **modname, +char **modname,const unsigned char **modbuildid,char *namebuf);int lookup_module_symbol_name (unsigned long addr,char *symname);int lookup_module_symbol_attrs (unsigned long addr,unsigned long *size,unsigned long *offset,char *modname,char *name);
kernel/kallsyms.c +75 -20
161 lines not on this page · raw message
kernel/module.c +23 -1
@@ -13,6 +13,7 @@#include <linux/trace_events.h> #include <linux/init.h> #include <linux/kallsyms.h> +#include <linux/buildid.h> #include <linux/file.h> #include <linux/fs.h> #include <linux/sysfs.h>
@@ -2770,6 +2771,20 @@ static void add_kallsyms(struct module *mod, const struct load_info *info) } mod->core_kallsyms.num_symtab = ndst; } + +static void init_build_id (struct module *mod,const struct load_info *info) +{ +const Elf_Shdr *sechdr; +unsigned int i; + +for (i =0 ; i < info->hdr->e_shnum; i++) { + sechdr = &info->sechdrs[i]; +if (!sect_empty (sechdr) && sechdr->sh_type ==SHT_NOTE && + !build_id_parse_buf ((void *)sechdr->sh_addr, mod->build_id, + sechdr->sh_size)) +break ; + } +}#else static inline void layout_symtab (struct module *mod,struct load_info *info) {
@@ -2778,6 +2793,10 @@ static inline void layout_symtab(struct module *mod, struct load_info *info)static void add_kallsyms (struct module *mod,const struct load_info *info) { } + +static void init_build_id (struct module *mod,const struct load_info *info) +{ +}#endif /* CONFIG_KALLSYMS */ static void dynamic_debug_setup (struct module *mod,struct _ddebug *debug,unsigned int num)
@@ -4004,6 +4023,7 @@ static int load_module(struct load_info *info, const char __user *uargs, goto free_arch_cleanup; } +init_build_id (mod, info);dynamic_debug_setup (mod, info->debug, info->num_debug);/* Ftrace init must be called in the MODULE_STATE_UNFORMED state */
@@ -4235,7 +4255,7 @@ void * __weak dereference_module_function_descriptor(struct module *mod,const char *module_address_lookup (unsigned long addr,unsigned long *size,unsigned long *offset, -char **modname, +char **modname,const unsigned char **modbuildid,char *namebuf) {const char *ret =NULL ;
@@ -4246,6 +4266,8 @@ const char *module_address_lookup(unsigned long addr,if (mod) {if (modname) *modname = mod->name; +if (modbuildid) + *modbuildid = mod->build_id; ret =find_kallsyms_symbol (mod, addr, size, offset); }
lib/vsprintf.c +7 -1
@@ -966,8 +966,12 @@ char *symbol_string(char *buf, char *end, void *ptr, value = (unsigned long )ptr;#ifdef CONFIG_KALLSYMS -if (*fmt =='B' ) +if (*fmt =='B' && fmt[1 ] =='b' ) +sprint_backtrace_build_id (sym, value); +else if (*fmt =='B' )sprint_backtrace (sym, value); +else if (*fmt =='S' && (fmt[1 ] =='b' || (fmt[1 ] =='R' && fmt[2 ] =='b' ))) +sprint_symbol_build_id (sym, value);else if (*fmt !='s' )sprint_symbol (sym, value);else
@@ -2129,9 +2133,11 @@ early_param("no_hash_pointers", no_hash_pointers_enable);* - 'S' For symbolic direct pointers (or function descriptors) with offset * - 's' For symbolic direct pointers (or function descriptors) without offset * - '[Ss]R' as above with __builtin_extract_return_addr() translation +* - 'S[R]b' as above with module build ID (for use in backtraces) * - '[Ff]' %pf and %pF were obsoleted and later removed in favor of * %ps and %pS. Be careful when re-using these specifiers. * - 'B' For backtraced symbolic direct pointers with offset +* - 'Bb' as above with module build ID (for use in backtraces) * - 'R' For decoded struct resource, e.g., [mem 0x0-0x1f 64bit pref] * - 'r' For raw struct resource, e.g., [mem 0x0-0x1f flags 0x201] * - 'b[l]' For a bitmap, the number of bits is determined by the field
Signature · 1 line
https://chromeos.dev
Andy Shevchenko
reviewerRe: [PATCH v4 05/13] module: Add printk formats to add module build ID to stacktraces
Quoted 28 lines · Stephen Boyd
Let's make kernel stacktraces easier to identify by including the build ID[1] of a module if the stacktrace is printing a symbol from a module. This makes it simpler for developers to locate a kernel module's full debuginfo for a particular stacktrace. Combined with
scripts/decode_stracktrace.sh, a developer can download the matching debuginfo from a debuginfod[2] server and find the exact file and line number for the functions plus offsets in a stacktrace that match the module. This is especially useful for pstore crash debugging where the kernel crashes are recorded in something like console-ramoops and the recovery kernel/modules are different or the debuginfo doesn't exist on the device due to space concerns (the debuginfo can be too large for space limited devices).Originally, I put this on the %pS format, but that was quickly rejected given that %pS is used in other places such as ftrace where build IDs aren't meaningful. There was some discussions on the list to put every module build ID into the "Modules linked in:" section of the stacktrace message but that quickly becomes very hard to read once you have more than three or four modules linked in. It also provides too much information when we don't expect each module to be traversed in a stacktrace. Having the build ID for modules that aren't important just makes things messy. Splitting it to multiple lines for each module quickly explodes the number of lines printed in an oops too, possibly wrapping the warning off the console. And finally, trying to stash away each module used in a callstack to provide the ID of each symbol printed is cumbersome and would require changes to each architecture to stash away modules and return their build IDs once unwinding has completed.
Quoted 7 lines
Instead, we opt for the simpler approach of introducing new printk formats '%pS[R]b' for "pointer symbolic backtrace with module build ID" and '%pBb' for "pointer backtrace with module build ID" and then updating the few places in the architecture layer where the stacktrace is printed to use this new format.
Example:
Can you trim a bit the example, so we will see only important lines. In such case you may provide "before" and "after" variants.
...
kernel/kallsyms.c static int __sprint_symbol(char *buffer, unsigned long address,
Quoted 7 lines
kernel/kallsyms.c +4
-2-if (modname) - len +=sprintf (buffer + len," [%s]" , modname); +if (modname) { + len +=sprintf (buffer + len," [%s" , modname); +/* build ID should match length of sprintf below */ +BUILD_BUG_ON (BUILD_ID_SIZE_MAX !=20 );
First of all, why not static_assert() defined near to the actual macro?
kernel/kallsyms.c static int __sprint_symbol(char *buffer, unsigned long address, · line 399
Quoted 2 lines
kernel/kallsyms.c +2
-0+if (IS_ENABLED (CONFIG_STACKTRACE_BUILD_ID ) && add_buildid && buildid) + len +=sprintf (buffer + len," %20phN" , buildid);
len += sprintf(buffer + len, " %*phN", BUILD_ID_SIZE_MAX, buildid);
?
Signature · 2 lines
With Best Regards, Andy Shevchenko
Re: [PATCH v4 05/13] module: Add printk formats to add module build ID to stacktraces
Quoting Andy Shevchenko (2021-04-12 04:58:02)
Quoted 47 lines · Stephen Boyd
Quoted 28 lines
Let's make kernel stacktraces easier to identify by including the build ID[1] of a module if the stacktrace is printing a symbol from a module. This makes it simpler for developers to locate a kernel module's full debuginfo for a particular stacktrace. Combined with
scripts/decode_stracktrace.sh, a developer can download the matching debuginfo from a debuginfod[2] server and find the exact file and line number for the functions plus offsets in a stacktrace that match the module. This is especially useful for pstore crash debugging where the kernel crashes are recorded in something like console-ramoops and the recovery kernel/modules are different or the debuginfo doesn't exist on the device due to space concerns (the debuginfo can be too large for space limited devices).Originally, I put this on the %pS format, but that was quickly rejected given that %pS is used in other places such as ftrace where build IDs aren't meaningful. There was some discussions on the list to put every module build ID into the "Modules linked in:" section of the stacktrace message but that quickly becomes very hard to read once you have more than three or four modules linked in. It also provides too much information when we don't expect each module to be traversed in a stacktrace. Having the build ID for modules that aren't important just makes things messy. Splitting it to multiple lines for each module quickly explodes the number of lines printed in an oops too, possibly wrapping the warning off the console. And finally, trying to stash away each module used in a callstack to provide the ID of each symbol printed is cumbersome and would require changes to each architecture to stash away modules and return their build IDs once unwinding has completed.
Quoted 7 lines
Instead, we opt for the simpler approach of introducing new printk formats '%pS[R]b' for "pointer symbolic backtrace with module build ID" and '%pBb' for "pointer backtrace with module build ID" and then updating the few places in the architecture layer where the stacktrace is printed to use this new format.
Example:
Can you trim a bit the example, so we will see only important lines. In such case you may provide "before" and "after" variants.
...
Quoted 4 lines
kernel/kallsyms.c +2
-2-if (modname) - len +=sprintf (buffer + len," [%s]" , modname); +if (modname) { + len +=sprintf (buffer + len," [%s" , modname);
Quoted 4 lines
kernel/kallsyms.c static int __sprint_symbol(char *buffer, unsigned long address, · line 397
Quoted 2 lines
kernel/kallsyms.c +2
-0+/* build ID should match length of sprintf below */ +BUILD_BUG_ON (BUILD_ID_SIZE_MAX !=20 );First of all, why not
static_assert()defined near to the actual macro?
Which macro? BUILD_ID_SIZE_MAX? I tried static_assert() and it didn't work for me but maybe I missed something. Why is static_assert() preferred?
Quoted 6 lines
kernel/kallsyms.c static int __sprint_symbol(char *buffer, unsigned long address, · line 399
Quoted 3 lines
kernel/kallsyms.c +2
-0+if (IS_ENABLED (CONFIG_STACKTRACE_BUILD_ID ) && add_buildid && buildid) + len +=sprintf (buffer + len," %20phN" , buildid);len += sprintf(buffer + len, " %*phN", BUILD_ID_SIZE_MAX, buildid);
Are you suggesting to use sprintf format here so that the size is part of the printf? Sounds good to me. Thanks.
Andy Shevchenko
reviewerRe: [PATCH v4 05/13] module: Add printk formats to add module build ID to stacktraces
Quoted 48 lines · Stephen Boyd
Quoting Andy Shevchenko (2021-04-12 04:58:02)
Quoted 47 lines · Stephen Boyd
Quoted 28 lines
Let's make kernel stacktraces easier to identify by including the build ID[1] of a module if the stacktrace is printing a symbol from a module. This makes it simpler for developers to locate a kernel module's full debuginfo for a particular stacktrace. Combined with
scripts/decode_stracktrace.sh, a developer can download the matching debuginfo from a debuginfod[2] server and find the exact file and line number for the functions plus offsets in a stacktrace that match the module. This is especially useful for pstore crash debugging where the kernel crashes are recorded in something like console-ramoops and the recovery kernel/modules are different or the debuginfo doesn't exist on the device due to space concerns (the debuginfo can be too large for space limited devices).Originally, I put this on the %pS format, but that was quickly rejected given that %pS is used in other places such as ftrace where build IDs aren't meaningful. There was some discussions on the list to put every module build ID into the "Modules linked in:" section of the stacktrace message but that quickly becomes very hard to read once you have more than three or four modules linked in. It also provides too much information when we don't expect each module to be traversed in a stacktrace. Having the build ID for modules that aren't important just makes things messy. Splitting it to multiple lines for each module quickly explodes the number of lines printed in an oops too, possibly wrapping the warning off the console. And finally, trying to stash away each module used in a callstack to provide the ID of each symbol printed is cumbersome and would require changes to each architecture to stash away modules and return their build IDs once unwinding has completed.
Quoted 7 lines
Instead, we opt for the simpler approach of introducing new printk formats '%pS[R]b' for "pointer symbolic backtrace with module build ID" and '%pBb' for "pointer backtrace with module build ID" and then updating the few places in the architecture layer where the stacktrace is printed to use this new format.
Example:
Can you trim a bit the example, so we will see only important lines. In such case you may provide "before" and "after" variants.
...
Quoted 4 lines
kernel/kallsyms.c +2
-2-if (modname) - len +=sprintf (buffer + len," [%s]" , modname); +if (modname) { + len +=sprintf (buffer + len," [%s" , modname);
Quoted 6 lines
Quoted 4 lines
kernel/kallsyms.c static int __sprint_symbol(char *buffer, unsigned long address, · line 397
Quoted 2 lines
kernel/kallsyms.c +2
-0+/* build ID should match length of sprintf below */ +BUILD_BUG_ON (BUILD_ID_SIZE_MAX !=20 );First of all, why not
static_assert()defined near to the actual macro?Which macro?
BUILD_ID_SIZE_MAX?
Yes.
Quoted 2 lines
I tried
static_assert()and it didn't
work for me but maybe I missed something.
Sounds weird. static_assert() is a good one. Check, for example, lib/vsprintf.c on how to use it.
Quoted 2 lines
Why is
static_assert()
preferred?
Because it's cleaner way to achieve it and as a bonus it can be put outside of the functions (be in the header or so).
Quoted 8 lines
Quoted 5 lines
kernel/kallsyms.c static int __sprint_symbol(char *buffer, unsigned long address, · line 399
Quoted 2 lines
kernel/kallsyms.c +2
-0+if (IS_ENABLED (CONFIG_STACKTRACE_BUILD_ID ) && add_buildid && buildid) + len +=sprintf (buffer + len," %20phN" , buildid);len += sprintf(buffer + len, " %*phN", BUILD_ID_SIZE_MAX, buildid);Are you suggesting to use sprintf format here so that the size is part of the printf? Sounds good to me. Thanks.
I prefer %20phN when the size is carved in stone (for example by specification), but if you are really expecting that it may be changed in the future, use variadic approach as I showed above.
Signature · 2 lines
With Best Regards, Andy Shevchenko
Petr Mladek
maintainerRe: [PATCH v4 05/13] module: Add printk formats to add module build ID to stacktraces
Quoted 49 lines · Andy Shevchenko
Quoted 48 lines · Stephen Boyd
Quoting Andy Shevchenko (2021-04-12 04:58:02)
Quoted 47 lines · Stephen Boyd
Quoted 28 lines
Let's make kernel stacktraces easier to identify by including the build ID[1] of a module if the stacktrace is printing a symbol from a module. This makes it simpler for developers to locate a kernel module's full debuginfo for a particular stacktrace. Combined with
scripts/decode_stracktrace.sh, a developer can download the matching debuginfo from a debuginfod[2] server and find the exact file and line number for the functions plus offsets in a stacktrace that match the module. This is especially useful for pstore crash debugging where the kernel crashes are recorded in something like console-ramoops and the recovery kernel/modules are different or the debuginfo doesn't exist on the device due to space concerns (the debuginfo can be too large for space limited devices).Originally, I put this on the %pS format, but that was quickly rejected given that %pS is used in other places such as ftrace where build IDs aren't meaningful. There was some discussions on the list to put every module build ID into the "Modules linked in:" section of the stacktrace message but that quickly becomes very hard to read once you have more than three or four modules linked in. It also provides too much information when we don't expect each module to be traversed in a stacktrace. Having the build ID for modules that aren't important just makes things messy. Splitting it to multiple lines for each module quickly explodes the number of lines printed in an oops too, possibly wrapping the warning off the console. And finally, trying to stash away each module used in a callstack to provide the ID of each symbol printed is cumbersome and would require changes to each architecture to stash away modules and return their build IDs once unwinding has completed.
Quoted 7 lines
Instead, we opt for the simpler approach of introducing new printk formats '%pS[R]b' for "pointer symbolic backtrace with module build ID" and '%pBb' for "pointer backtrace with module build ID" and then updating the few places in the architecture layer where the stacktrace is printed to use this new format.
Example:
Can you trim a bit the example, so we will see only important lines. In such case you may provide "before" and "after" variants.
...
Quoted 4 lines
kernel/kallsyms.c +2
-2-if (modname) - len +=sprintf (buffer + len," [%s]" , modname); +if (modname) { + len +=sprintf (buffer + len," [%s" , modname);
Quoted 11 lines
Quoted 6 lines
Quoted 4 lines
kernel/kallsyms.c static int __sprint_symbol(char *buffer, unsigned long address, · line 397
Quoted 2 lines
kernel/kallsyms.c +2
-0+/* build ID should match length of sprintf below */ +BUILD_BUG_ON (BUILD_ID_SIZE_MAX !=20 );First of all, why not
static_assert()defined near to the actual macro?Which macro?
BUILD_ID_SIZE_MAX?Yes.
Quoted 2 lines
I tried
static_assert()and it didn't
work for me but maybe I missed something.
I guess that you wanted to use it inside macro definition:
#define VMCOREINFO_BUILD_ID(value) \
static_assert(ARRAY_SIZE(value) == BUILD_ID_SIZE_MAX); \
vmcoreinfo_append_str("BUILD-ID=%20phN\n", value)Instead, you should do it outside the macro:
static_assert(ARRAY_SIZE(value) == BUILD_ID_SIZE_MAX);
#define VMCOREINFO_BUILD_ID(value) \
vmcoreinfo_append_str("BUILD-ID=%20phN\n", value)Quoted 5 lines
Sounds weird.
static_assert()is a good one. Check, for example,lib/vsprintf.con how to use it.Quoted 2 lines
Why is
static_assert()
preferred?
I guess that it is because it is enough and more efficient for checks of constant values (no computation of the value).
Quoted 9 lines
Because it's cleaner way to achieve it and as a bonus it can be put outside of the functions (be in the header or so).
Quoted 6 lines
Quoted 5 lines
kernel/kallsyms.c static int __sprint_symbol(char *buffer, unsigned long address, · line 399
Quoted 2 lines
kernel/kallsyms.c +2
-0+if (IS_ENABLED (CONFIG_STACKTRACE_BUILD_ID ) && add_buildid && buildid) + len +=sprintf (buffer + len," %20phN" , buildid);len += sprintf(buffer + len, " %*phN", BUILD_ID_SIZE_MAX, buildid);
Quoted 6 lines
Quoted 2 lines
Are you suggesting to use sprintf format here so that the size is part of the printf? Sounds good to me. Thanks.
I prefer %20phN when the size is carved in stone (for example by specification), but if you are really expecting that it may be changed in the future, use variadic approach as I showed above.
I would consider this written in stone (last famous words ;-) and use %20phN with the static_assert().
Best Regards,
Petr
Re: [PATCH v4 05/13] module: Add printk formats to add module build ID to stacktraces
Quoting Petr Mladek (2021-04-13 08:16:20)
Quoted 19 lines · Andy Shevchenko
Quoted 11 lines · Stephen Boyd
Quoted 5 lines
Quoting Andy Shevchenko (2021-04-12 04:58:02)
Quoted 2 lines
First of all, why not
static_assert()defined near to the actual macro?Which macro?
BUILD_ID_SIZE_MAX?Yes.
Quoted 2 lines
I tried
static_assert()and it didn't
work for me but maybe I missed something.I guess that you wanted to use it inside macro definition:
#define VMCOREINFO_BUILD_ID(value) \ static_assert(ARRAY_SIZE(value) == BUILD_ID_SIZE_MAX); \ vmcoreinfo_append_str("BUILD-ID=%20phN\n", value)
Quoted 5 lines
Instead, you should do it outside the macro:
static_assert(ARRAY_SIZE(value) == BUILD_ID_SIZE_MAX);#define VMCOREINFO_BUILD_ID(value) \ vmcoreinfo_append_str("BUILD-ID=%20phN\n", value)
In this example "value" is not defined because it's an argument to the macro. How can this work?
From what I can tell static_assert() is for the case that you want to assert something at the global scope level. BUILD_BUG_ON() can't be used at global scope. I see the usage is usually to assert struct members and alignment of those members. In turn, static_assert() can't be used at function level scope. Each has a use and in this case I want to assert at function level scope to be as close as possible to the place that would need to change.
Quoted 12 lines
Quoted 6 lines
Sounds weird.
static_assert()is a good one. Check, for example,lib/vsprintf.con how to use it.Quoted 2 lines
Why is
static_assert()
preferred?I guess that it is because it is enough and more efficient for checks of constant values (no computation of the value).
Quoted 2 lines
Because it's cleaner way to achieve it and as a bonus it can be put outside of the functions (be in the header or so).
Ok, but I'm still not sure what it would be enforcing. In this case we need to have it near the sprintf line so that we know to fix the 20 in there should it ever change to be larger. If it's defined next to the BUILD_ID_SIZE_MAX macro then it does practically nothing to help future developers know what to change.
Quoted 10 lines
Quoted 10 lines
Quoted 9 lines
Quoted 6 lines
Review
Quoted 3 lines
(quoted diff) +2
-0+ if (IS_ENABLED(CONFIG_STACKTRACE_BUILD_ID) && add_buildid && buildid) + len += sprintf(buffer + len, " %20phN", buildid);len += sprintf(buffer + len, " %*phN", BUILD_ID_SIZE_MAX, buildid);Are you suggesting to use sprintf format here so that the size is part of the printf? Sounds good to me. Thanks.
Quoted 7 lines
Quoted 3 lines
I prefer %20phN when the size is carved in stone (for example by specification), but if you are really expecting that it may be changed in the future, use variadic approach as I showed above.
I would consider this written in stone (last famous words ;-) and use %20phN with the
static_assert().
Yes it is pretty much written in stone. The build ID can be an md5sum instead of SHA1, and thus 16 bytes instead of 20 bytes for the 160-bit SHA1 form. This is rare, and the code in buildid.c is padding it out with zeroes in the case that the note is smaller than 20 bytes in length. Within the kernel we can always assume the buffer is BUILD_ID_SIZE_MAX. How about this patch?
----8<-----
include/linux/crash_core.h +1 -1
@@ -39,7 +39,7 @@ phys_addr_t paddr_vmcoreinfo_note(void);#define VMCOREINFO_OSRELEASE (value) \ vmcoreinfo_append_str("OSRELEASE=%s\n", value)#define VMCOREINFO_BUILD_ID (value) \ - BUILD_BUG_ON(ARRAY_SIZE(value) != BUILD_ID_SIZE_MAX); \ + BUILD_BUG_ON(ARRAY_SIZE(value) != 20); \ vmcoreinfo_append_str("BUILD-ID=%20phN\n", value)#define VMCOREINFO_PAGESIZE (value) \ vmcoreinfo_append_str("PAGESIZE=%ld\n", value)
kernel/kallsyms.c +4 -1
@@ -25,7 +25,10 @@#include <linux/filter.h> #include <linux/ftrace.h> #include <linux/kprobes.h> +#include <linux/build_bug.h> #include <linux/compiler.h> +#include <linux/module.h> +#include <linux/kernel.h> /* * These will be re-linked against their real values
@@ -394,7 +397,7 @@ static int __sprint_symbol(char *buffer, unsigned long address,if (modname) { len +=sprintf (buffer + len," [%s" , modname);/* build ID should match length of sprintf below */ -BUILD_BUG_ON (BUILD_ID_SIZE_MAX !=20 ); +BUILD_BUG_ON (sizeof (typeof_member (struct module ,build_id )) !=20 );if (IS_ENABLED (CONFIG_STACKTRACE_BUILD_ID ) && add_buildid && buildid) len +=sprintf (buffer + len," %20phN" , buildid); len +=sprintf (buffer + len,"]" );
Re: [PATCH v4 05/13] module: Add printk formats to add module build ID to stacktraces
Quoting Stephen Boyd (2021-04-13 13:10:05)
Quoted 29 lines
Quoting Petr Mladek (2021-04-13 08:16:20)
Quoted 19 lines · Andy Shevchenko
Quoted 11 lines · Stephen Boyd
Quoted 5 lines
Quoting Andy Shevchenko (2021-04-12 04:58:02)
Quoted 2 lines
First of all, why not
static_assert()defined near to the actual macro?Which macro?
BUILD_ID_SIZE_MAX?Yes.
Quoted 2 lines
I tried
static_assert()and it didn't
work for me but maybe I missed something.I guess that you wanted to use it inside macro definition:
#define VMCOREINFO_BUILD_ID(value) \ static_assert(ARRAY_SIZE(value) == BUILD_ID_SIZE_MAX); \ vmcoreinfo_append_str("BUILD-ID=%20phN\n", value)Quoted 5 lines
Instead, you should do it outside the macro:
static_assert(ARRAY_SIZE(value) == BUILD_ID_SIZE_MAX);#define VMCOREINFO_BUILD_ID(value) \ vmcoreinfo_append_str("BUILD-ID=%20phN\n", value)In this example "value" is not defined because it's an argument to the macro. How can this work?
Quoted 8 lines
From what I can tell
static_assert()is for the case that you want to assert something at the global scope level.BUILD_BUG_ON()can't be used at global scope. I see the usage is usually to assert struct members and alignment of those members. In turn,static_assert()can't be used at function level scope. Each has a use and in this case I want to assert at function level scope to be as close as possible to the place that would need to change.
Good news. I can do this to force a basic block and then GCC doesn't complain.
---8<---
include/linux/crash_core.h +6 -3
@@ -38,9 +38,12 @@ phys_addr_t paddr_vmcoreinfo_note(void);#define VMCOREINFO_OSRELEASE (value) \ vmcoreinfo_append_str("OSRELEASE=%s\n", value) -#define VMCOREINFO_BUILD_ID (value) \ - BUILD_BUG_ON(ARRAY_SIZE(value) != BUILD_ID_SIZE_MAX); \ - vmcoreinfo_append_str("BUILD-ID=%20phN\n", value) +#define VMCOREINFO_BUILD_ID () \ + ({ \ + static_assert(sizeof(vmlinux_build_id) == 20); \ + vmcoreinfo_append_str("BUILD-ID=%20phN\n", vmlinux_build_id); \ + }) +#define VMCOREINFO_PAGESIZE (value) \ vmcoreinfo_append_str("PAGESIZE=%ld\n", value)
Petr Mladek
maintainerRe: [PATCH v4 05/13] module: Add printk formats to add module build ID to stacktraces
In reply to Stephen BoydQuoted 26 lines · Stephen Boyd
Let's make kernel stacktraces easier to identify by including the build ID[1] of a module if the stacktrace is printing a symbol from a module. This makes it simpler for developers to locate a kernel module's full debuginfo for a particular stacktrace. Combined with
scripts/decode_stracktrace.sh, a developer can download the matching debuginfo from a debuginfod[2] server and find the exact file and line number for the functions plus offsets in a stacktrace that match the module. This is especially useful for pstore crash debugging where the kernel crashes are recorded in something like console-ramoops and the recovery kernel/modules are different or the debuginfo doesn't exist on the device due to space concerns (the debuginfo can be too large for space limited devices).include/linux/module.h +1
-0@@ -11,6 +11,7 @@#include <linux/list.h> #include <linux/stat.h> +#include <linux/buildid.h> #include <linux/compiler.h> #include <linux/cache.h> #include <linux/kmod.h>
include/linux/module.h struct module { · line 372
Quoted 5 lines
include/linux/module.h +2
-0@@ -367,6 +368,9 @@ struct module {/* Unique handle for this module */ char name[MODULE_NAME_LEN ]; +/* Module build ID */ +unsigned char build_id[BUILD_ID_SIZE_MAX ];
Do we want to initialize/store the ID even when CONFIG_STACKTRACE_BUILD_ID is disabled and nobody would use it?
Most struct module members are added only when the related feature is enabled.
I am not sure how it would complicate the code. It is possible that it is not worth it. Well, I could imagine that the API will always pass the buildid parameter and module_address_lookup() might do something like
#ifndef CONFIG_STACKTRACE_BUILD_ID
static char empty_build_id[BUILD_ID_SIZE_MAX];
#endif
if (modbuildid) {
if (IS_ENABLED(CONFIG_STACKTRACE_BUILD_ID))
*modbuildid = mod->build_id;
else
*modbuildid = empty_build_id;IMHO, this is primary a call for Jessica as the module code maintainer.
Otherwise, I am fine with this patch. And it works as expected.
Best Regards,
Petr
Re: [PATCH v4 05/13] module: Add printk formats to add module build ID to stacktraces
Quoting Petr Mladek (2021-04-13 08:01:14)
Quoted 55 lines · Stephen Boyd
Quoted 26 lines
Let's make kernel stacktraces easier to identify by including the build ID[1] of a module if the stacktrace is printing a symbol from a module. This makes it simpler for developers to locate a kernel module's full debuginfo for a particular stacktrace. Combined with
scripts/decode_stracktrace.sh, a developer can download the matching debuginfo from a debuginfod[2] server and find the exact file and line number for the functions plus offsets in a stacktrace that match the module. This is especially useful for pstore crash debugging where the kernel crashes are recorded in something like console-ramoops and the recovery kernel/modules are different or the debuginfo doesn't exist on the device due to space concerns (the debuginfo can be too large for space limited devices).include/linux/module.h +1
-0@@ -11,6 +11,7 @@#include <linux/list.h> #include <linux/stat.h> +#include <linux/buildid.h> #include <linux/compiler.h> #include <linux/cache.h> #include <linux/kmod.h> include/linux/module.h struct module { · line 372
Quoted 5 lines
include/linux/module.h +2
-0@@ -367,6 +368,9 @@ struct module {/* Unique handle for this module */ char name[MODULE_NAME_LEN ]; +/* Module build ID */ +unsigned char build_id[BUILD_ID_SIZE_MAX ];Do we want to initialize/store the ID even when
CONFIG_STACKTRACE_BUILD_IDis disabled and nobody would use it?Most struct module members are added only when the related feature is enabled.
I am not sure how it would complicate the code. It is possible that it is not worth it. Well, I could imagine that the API will always pass the buildid parameter and
module_address_lookup()might do something like#ifndef
CONFIG_STACKTRACE_BUILD_ID
static char empty_build_id[BUILD_ID_SIZE_MAX];
#endifif (modbuildid) { if (IS_ENABLED(CONFIG_STACKTRACE_BUILD_ID)) *modbuildid = mod->build_id; else *modbuildid = empty_build_id;
Quoted 4 lines
IMHO, this is primary a call for Jessica as the module code maintainer.
Otherwise, I am fine with this patch. And it works as expected.
Does declaring mod->build_id as zero length work well enough?
----8<----
include/linux/module.h +7 -1
@@ -359,6 +359,12 @@ struct klp_modinfo { };#endif +#if IS_ENABLED (CONFIG_STACKTRACE_BUILD_ID ) +#define MODULE_BUILD_ID_LEN BUILD_ID_SIZE_MAX +#else +#define MODULE_BUILD_ID_LEN 0 +#endif +struct module {enum module_state state;
@@ -369,7 +375,7 @@ struct module {char name[MODULE_NAME_LEN ];/* Module build ID */ -unsigned char build_id[BUILD_ID_SIZE_MAX ]; +unsigned char build_id[MODULE_BUILD_ID_LEN ];/* Sysfs stuff. */ struct module_kobject mkobj;
kernel/kallsyms.c +9 -3
@@ -25,7 +25,10 @@#include <linux/filter.h> #include <linux/ftrace.h> #include <linux/kprobes.h> +#include <linux/build_bug.h> #include <linux/compiler.h> +#include <linux/module.h> +#include <linux/kernel.h> /* * These will be re-linked against their real values
@@ -393,10 +396,13 @@ static int __sprint_symbol(char *buffer, unsigned long address,if (modname) { len +=sprintf (buffer + len," [%s" , modname); -/* build ID should match length of sprintf below */ -BUILD_BUG_ON (BUILD_ID_SIZE_MAX !=20 ); -if (IS_ENABLED (CONFIG_STACKTRACE_BUILD_ID ) && add_buildid && buildid) +#if IS_ENABLED (CONFIG_STACKTRACE_BUILD_ID ) +if (add_buildid && buildid) { +/* build ID should match length of sprintf */ +static_assert (MODULE_BUILD_ID_LEN ==20 ); len +=sprintf (buffer + len," %20phN" , buildid); + } +#endif len +=sprintf (buffer + len,"]" ); }
kernel/module.c +11 -9
@@ -2771,7 +2771,17 @@ static void add_kallsyms(struct module *mod, const struct load_info *info) } mod->core_kallsyms.num_symtab = ndst; } +#else +static inline void layout_symtab (struct module *mod,struct load_info *info) +{ +} + +static void add_kallsyms (struct module *mod,const struct load_info *info) +{ +} +#endif /* CONFIG_KALLSYMS */ +#if IS_ENABLED (CONFIG_KALLSYMS ) &&IS_ENABLED (CONFIG_STACKTRACE_BUILD_ID )static void init_build_id (struct module *mod,const struct load_info *info) {const Elf_Shdr *sechdr;
@@ -2786,18 +2796,10 @@ static void init_build_id(struct module *mod, const struct load_info *info) } }#else -static inline void layout_symtab (struct module *mod,struct load_info *info) -{ -} - -static void add_kallsyms (struct module *mod,const struct load_info *info) -{ -} -static void init_build_id (struct module *mod,const struct load_info *info) { } -#endif /* CONFIG_KALLSYMS */ +#endif static void dynamic_debug_setup (struct module *mod,struct _ddebug *debug,unsigned int num) {
Petr Mladek
maintainerRe: [PATCH v4 05/13] module: Add printk formats to add module build ID to stacktraces
Quoted 56 lines · Stephen Boyd
Quoting Petr Mladek (2021-04-13 08:01:14)
Quoted 55 lines · Stephen Boyd
Quoted 26 lines
Let's make kernel stacktraces easier to identify by including the build ID[1] of a module if the stacktrace is printing a symbol from a module. This makes it simpler for developers to locate a kernel module's full debuginfo for a particular stacktrace. Combined with
scripts/decode_stracktrace.sh, a developer can download the matching debuginfo from a debuginfod[2] server and find the exact file and line number for the functions plus offsets in a stacktrace that match the module. This is especially useful for pstore crash debugging where the kernel crashes are recorded in something like console-ramoops and the recovery kernel/modules are different or the debuginfo doesn't exist on the device due to space concerns (the debuginfo can be too large for space limited devices).include/linux/module.h +1
-0@@ -11,6 +11,7 @@#include <linux/list.h> #include <linux/stat.h> +#include <linux/buildid.h> #include <linux/compiler.h> #include <linux/cache.h> #include <linux/kmod.h> include/linux/module.h struct module { · line 372
Quoted 5 lines
include/linux/module.h +2
-0@@ -367,6 +368,9 @@ struct module {/* Unique handle for this module */ char name[MODULE_NAME_LEN ]; +/* Module build ID */ +unsigned char build_id[BUILD_ID_SIZE_MAX ];Do we want to initialize/store the ID even when
CONFIG_STACKTRACE_BUILD_IDis disabled and nobody would use it?Most struct module members are added only when the related feature is enabled.
I am not sure how it would complicate the code. It is possible that it is not worth it. Well, I could imagine that the API will always pass the buildid parameter and
module_address_lookup()might do something like#ifndef
CONFIG_STACKTRACE_BUILD_ID
static char empty_build_id[BUILD_ID_SIZE_MAX];
#endifif (modbuildid) { if (IS_ENABLED(CONFIG_STACKTRACE_BUILD_ID)) *modbuildid = mod->build_id; else *modbuildid = empty_build_id;
Quoted 6 lines
Quoted 4 lines
IMHO, this is primary a call for Jessica as the module code maintainer.
Otherwise, I am fine with this patch. And it works as expected.
Does declaring
mod->build_idas zero length work well enough?
It might be fine because it would actually never get displayed. But yeah, it is kind of hack. The idea was to avoid too many #ifdefs in the code.
I think that it is Jessica's call what she would prefer.
Best Regards,
Petr
Re: [PATCH v4 05/13] module: Add printk formats to add module build ID to stacktraces
In reply to Stephen Boyd+++ Stephen Boyd [09/04/21 18:52 -0700]:
Quoted 193 lines
Let's make kernel stacktraces easier to identify by including the build ID[1] of a module if the stacktrace is printing a symbol from a module. This makes it simpler for developers to locate a kernel module's full debuginfo for a particular stacktrace. Combined with
scripts/decode_stracktrace.sh, a developer can download the matching debuginfo from a debuginfod[2] server and find the exact file and line number for the functions plus offsets in a stacktrace that match the module. This is especially useful for pstore crash debugging where the kernel crashes are recorded in something like console-ramoops and the recovery kernel/modules are different or the debuginfo doesn't exist on the device due to space concerns (the debuginfo can be too large for space limited devices).Originally, I put this on the %pS format, but that was quickly rejected given that %pS is used in other places such as ftrace where build IDs aren't meaningful. There was some discussions on the list to put every module build ID into the "Modules linked in:" section of the stacktrace message but that quickly becomes very hard to read once you have more than three or four modules linked in. It also provides too much information when we don't expect each module to be traversed in a stacktrace. Having the build ID for modules that aren't important just makes things messy. Splitting it to multiple lines for each module quickly explodes the number of lines printed in an oops too, possibly wrapping the warning off the console. And finally, trying to stash away each module used in a callstack to provide the ID of each symbol printed is cumbersome and would require changes to each architecture to stash away modules and return their build IDs once unwinding has completed.
Instead, we opt for the simpler approach of introducing new printk formats '%pS[R]b' for "pointer symbolic backtrace with module build ID" and '%pBb' for "pointer backtrace with module build ID" and then updating the few places in the architecture layer where the stacktrace is printed to use this new format.
Example:
WARNING: CPU: 3 PID: 3373 at drivers/misc/lkdtm/bugs.c:83 lkdtm_WARNING+0x28/0x30 [lkdtm] Modules linked in: lkdtm rfcomm algif_hash algif_skcipher af_alg xt_cgroup uinput xt_MASQUERADE hci_uart <modules trimmed> CPU: 3 PID: 3373 Comm: bash Not tainted 5.11 #12 a8c0d47f7051f3e6670ceaea724af66a39c6cec8 Hardware name: Google Lazor (rev3+) with KB Backlight (DT) pstate: 00400009 (nzcv daif +PAN -UAO -TCO BTYPE=--) pc : lkdtm_WARNING+0x28/0x30 [lkdtm] lr : lkdtm_do_action+0x24/0x40 [lkdtm]sp :
ffffffc013febca0
x29:ffffffc013febca0x28:ffffff88d9438040
x27: 0000000000000000 x26: 0000000000000000
x25: 0000000000000000 x24:ffffffdd0e9772c0
x23: 0000000000000020 x22:ffffffdd0e975366
x21:ffffffdd0e9772e0x20:ffffffc013febde0
x19: 0000000000000008 x18: 0000000000000000
x17: 0000000000000000 x16: 0000000000000037
x15:ffffffdd102ab174x14: 0000000000000003
x13: 0000000000000004 x12: 0000000000000000
x11: 0000000000000000 x10: 0000000000000000
x9 : 0000000000000001 x8 :ffffffdd0e979000
x7 : 0000000000000000 x6 :ffffffdd10ff6b54
x5 : 0000000000000000 x4 : 0000000000000000
x3 :ffffffc013feb938x2 :ffffff89fef05a70
x1 :ffffff89feef5788x0 :ffffffdd0e9772e0Call trace: lkdtm_WARNING+0x28/0x30 [lkdtm 6c2215028606bda50de823490723dc4bc5bf46f9] direct_entry+0x16c/0x1b4 [lkdtm 6c2215028606bda50de823490723dc4bc5bf46f9] full_proxy_write+0x74/0xa4 vfs_write+0xec/0x2e8 ksys_write+0x84/0xf0 __arm64_sys_write+0x24/0x30 el0_svc_common+0xf4/0x1c0 do_el0_svc_compat+0x28/0x3c el0_svc_compat+0x10/0x1c el0_sync_compat_handler+0xa8/0xcc el0_sync_compat+0x178/0x180 ---[ end trace f89bc7f5417cbcc6 ]---Cc Jiri Olsa <[email protected]>Cc Alexei Starovoitov <[email protected]>Cc Jessica Yu <[email protected]>Cc Evan Green <[email protected]>Cc Hsin-Yi Wang <[email protected]>Cc Petr Mladek <[email protected]>Cc Steven Rostedt <[email protected]>Cc Sergey Senozhatsky <[email protected]>Cc Andy Shevchenko <[email protected]>Cc Rasmus Villemoes <[email protected]>Cc <[email protected]>Cc Matthew Wilcox <[email protected]>Signed-off-by Stephen Boyd <[email protected]>---
Documentation/core-api/printk-formats.rst | 11 +++ include/linux/kallsyms.h | 20 ++++- include/linux/module.h | 6 +- kernel/kallsyms.c | 95 ++++++++++++++++++----- kernel/module.c | 24 +++++- lib/vsprintf.c | 8 +- 6 files changed, 139 insertions(+), 25 deletions(-)Documentation/core-api/printk-formats.rst +0
-0@@ -114,6 +114,17 @@ used when printing stack backtraces. The specifier takes intoconsideration the effect of compiler optimisations which may occur when tail-calls are used and marked with the noreturn GCC attribute.
Documentation/core-api/printk-formats.rst +11
-0+If the pointer is within a module, the module name and optionally build ID is +printed after the symbol name with an extra ``b`` appended to the end of the +specifier. + +:: + %pS versatile_init+0x0/0x110 [module_name] + %pSb versatile_init+0x0/0x110 [module_name ed5019fdf5e53be37cb1ba7899292d7e143b259e] + %pSRb versatile_init+0x9/0x110 [module_name ed5019fdf5e53be37cb1ba7899292d7e143b259e] + (with __builtin_extract_return_addr() translation) + %pBb prev_fn_of_versatile_init+0x88/0x88 [module_name ed5019fdf5e53be37cb1ba7899292d7e143b259e] +Probed Pointers from BPF / tracing
----------------------------------include/linux/kallsyms.h +18
-2@@ -7,6 +7,7 @@#define _LINUX_KALLSYMS_H#include <linux/errno.h> +#include <linux/buildid.h> #include <linux/kernel.h> #include <linux/stddef.h> #include <linux/mm.h> @@ -15,8 +16,9 @@#include <asm/sections.h> #define KSYM_NAME_LEN 128 -#define KSYM_SYMBOL_LEN (sizeof("%s+%#lx/%#lx [%s]") + (KSYM_NAME_LEN - 1) + \ - 2*(BITS_PER_LONG*3/10) + (MODULE_NAME_LEN - 1) + 1) +#define KSYM_SYMBOL_LEN (sizeof("%s+%#lx/%#lx [%s %s]") + (KSYM_NAME_LEN - 1) + \ + 2*(BITS_PER_LONG*3/10) + (MODULE_NAME_LEN - 1) + \ + (BUILD_ID_SIZE_MAX * 2) + 1)struct cred ;struct module ;@@ -91,8 +93,10 @@ const char *kallsyms_lookup(unsigned long addr,/* Look up a kernel symbol and return it in a text buffer. */ extern int sprint_symbol (char *buffer,unsigned long address); +extern int sprint_symbol_build_id (char *buffer,unsigned long address);extern int sprint_symbol_no_offset (char *buffer,unsigned long address);extern int sprint_backtrace (char *buffer,unsigned long address); +extern int sprint_backtrace_build_id (char *buffer,unsigned long address);int lookup_symbol_name (unsigned long addr,char *symname);int lookup_symbol_attrs (unsigned long addr,unsigned long *size,unsigned long *offset,char *modname,char *name);@@ -128,6 +132,12 @@ static inline int sprint_symbol(char *buffer, unsigned long addr)return 0 ; } +static inline int sprint_symbol_build_id (char *buffer,unsigned long address) +{ + *buffer ='\0' ; +return 0 ; +} +static inline int sprint_symbol_no_offset (char *buffer,unsigned long addr) { *buffer ='\0' ;@@ -140,6 +150,12 @@ static inline int sprint_backtrace(char *buffer, unsigned long addr)return 0 ; } +static inline int sprint_backtrace_build_id (char *buffer,unsigned long addr) +{ + *buffer ='\0' ; +return 0 ; +} +static inline int lookup_symbol_name (unsigned long addr,char *symname) {return -ERANGE ;include/linux/module.h +1
-0@@ -11,6 +11,7 @@#include <linux/list.h> #include <linux/stat.h> +#include <linux/buildid.h> #include <linux/compiler.h> #include <linux/cache.h> #include <linux/kmod.h>
include/linux/module.h struct module { · line 372
Quoted 5 lines
include/linux/module.h +2
-0@@ -367,6 +368,9 @@ struct module {/* Unique handle for this module */ char name[MODULE_NAME_LEN ]; +/* Module build ID */ +unsigned char build_id[BUILD_ID_SIZE_MAX ];
Hi Stephen,
Since this field is not used when !CONFIG_STACKTRACE_BUILD_ID, I would prefer to wrap this in an ifdef, similar to the other CONFIG-dependent fields in struct module. This makes it explicit under what conditions (i.e. config) the field is meant to be used.
Quoted 205 lines
include/linux/module.h +2
-1+/* Sysfs stuff. */ struct module_kobject mkobj;struct module_attribute *modinfo_attrs;@@ -630,7 +634,7 @@ void *dereference_module_function_descriptor(struct module *mod, void *ptr);const char *module_address_lookup (unsigned long addr,unsigned long *symbolsize,unsigned long *offset, -char **modname, +char **modname,const unsigned char **modbuildid,char *namebuf);int lookup_module_symbol_name (unsigned long addr,char *symname);int lookup_module_symbol_attrs (unsigned long addr,unsigned long *size,unsigned long *offset,char *modname,char *name);kernel/kallsyms.c +75
-20@@ -273,21 +273,13 @@ int kallsyms_lookup_size_offset(unsigned long addr, unsigned long *symbolsize,get_symbol_pos (addr, symbolsize, offset);return 1 ; } -return !!module_address_lookup (addr, symbolsize, offset,NULL , namebuf) || +return !!module_address_lookup (addr, symbolsize, offset,NULL ,NULL , namebuf) || !!__bpf_address_lookup (addr, symbolsize, offset, namebuf); } -/* -* Lookup an address -* - modname is set to NULL if it's in the kernel. -* - We guarantee that the returned name is valid until we reschedule even if. -* It resides in a module. -* - We also guarantee that modname will be valid until rescheduled. -*/ -const char *kallsyms_lookup (unsigned long addr, -unsigned long *symbolsize, -unsigned long *offset, -char **modname,char *namebuf) +const char *kallsyms_lookup_buildid (unsigned long addr,unsigned long *symbolsize, +unsigned long *offset,char **modname, +const unsigned char **modbuildid,char *namebuf) {const char *ret;@@ -303,12 +295,14 @@ const char *kallsyms_lookup(unsigned long addr, namebuf, KSYM_NAME_LEN);if (modname) *modname =NULL ; +if (modbuildid) + *modbuildid =NULL ;return namebuf; }/* See if it's in a module or a BPF JITed image. */ ret =module_address_lookup (addr, symbolsize, offset, - modname, namebuf); + modname, modbuildid, namebuf);if (!ret) ret =bpf_address_lookup (addr, symbolsize, offset, modname, namebuf);@@ -319,6 +313,22 @@ const char *kallsyms_lookup(unsigned long addr,return ret; } +/* +* Lookup an address +* - modname is set to NULL if it's in the kernel. +* - We guarantee that the returned name is valid until we reschedule even if. +* It resides in a module. +* - We also guarantee that modname will be valid until rescheduled. +*/ +const char *kallsyms_lookup (unsigned long addr, +unsigned long *symbolsize, +unsigned long *offset, +char **modname,char *namebuf) +{ +return kallsyms_lookup_buildid (addr, symbolsize, offset, modname, +NULL , namebuf); +} +int lookup_symbol_name (unsigned long addr,char *symname) { symname[0 ] ='\0' ;@@ -359,15 +369,17 @@ int lookup_symbol_attrs(unsigned long addr, unsigned long *size,/* Look up a kernel symbol and return it in a text buffer. */ static int __sprint_symbol (char *buffer,unsigned long address, -int symbol_offset,int add_offset) +int symbol_offset,int add_offset,int add_buildid) {char *modname; +const unsigned char *buildid;const char *name;unsigned long offset, size;int len; address += symbol_offset; - name =kallsyms_lookup (address, &size, &offset, &modname, buffer); + name =kallsyms_lookup_buildid (address, &size, &offset, &modname, &buildid, + buffer);if (!name)return sprintf (buffer,"0x%lx" , address - symbol_offset);@@ -379,8 +391,14 @@ static int __sprint_symbol(char *buffer, unsigned long address,if (add_offset) len +=sprintf (buffer + len,"+%#lx/%#lx" , offset, size); -if (modname) - len +=sprintf (buffer + len," [%s]" , modname); +if (modname) { + len +=sprintf (buffer + len," [%s" , modname); +/* build ID should match length of sprintf below */ +BUILD_BUG_ON (BUILD_ID_SIZE_MAX !=20 ); +if (IS_ENABLED (CONFIG_STACKTRACE_BUILD_ID ) && add_buildid && buildid) + len +=sprintf (buffer + len," %20phN" , buildid); + len +=sprintf (buffer + len,"]" ); + }return len; }@@ -398,10 +416,27 @@ static int __sprint_symbol(char *buffer, unsigned long address,*/ int sprint_symbol (char *buffer,unsigned long address) { -return __sprint_symbol (buffer, address,0 ,1 ); +return __sprint_symbol (buffer, address,0 ,1 ,0 ); }EXPORT_SYMBOL_GPL (sprint_symbol); +/** +* sprint_symbol_build_id - Look up a kernel symbol and return it in a text buffer +* @buffer: buffer to be stored +* @address: address to lookup +* +* This function looks up a kernel symbol with @address and stores its name, +* offset, size, module name and module build ID to @buffer if possible. If no +* symbol was found, just saves its @address as is. +* +* This function returns the number of bytes stored in @buffer. +*/ +int sprint_symbol_build_id (char *buffer,unsigned long address) +{ +return __sprint_symbol (buffer, address,0 ,1 ,1 ); +} +EXPORT_SYMBOL_GPL (sprint_symbol_build_id); +/** * sprint_symbol_no_offset - Look up a kernel symbol and return it in a text buffer * @buffer: buffer to be stored @@ -415,7 +450,7 @@ EXPORT_SYMBOL_GPL(sprint_symbol);*/ int sprint_symbol_no_offset (char *buffer,unsigned long address) { -return __sprint_symbol (buffer, address,0 ,0 ); +return __sprint_symbol (buffer, address,0 ,0 ,0 ); }EXPORT_SYMBOL_GPL (sprint_symbol_no_offset);@@ -435,7 +470,27 @@ EXPORT_SYMBOL_GPL(sprint_symbol_no_offset);*/ int sprint_backtrace (char *buffer,unsigned long address) { -return __sprint_symbol (buffer, address,-1 ,1 ); +return __sprint_symbol (buffer, address,-1 ,1 ,0 ); +} + +/** +* sprint_backtrace_build_id - Look up a backtrace symbol and return it in a text buffer +* @buffer: buffer to be stored +* @address: address to lookup +* +* This function is for stack backtrace and does the same thing as +* sprint_symbol() but with modified/decreased @address. If there is a +* tail-call to the function marked "noreturn", gcc optimized out code after +* the call so that the stack-saved return address could point outside of the +* caller. This function ensures that kallsyms will find the original caller +* by decreasing @address. This function also appends the module build ID to +* the @buffer if @address is within a kernel module. +* +* This function returns the number of bytes stored in @buffer. +*/ +int sprint_backtrace_build_id (char *buffer,unsigned long address) +{ +return __sprint_symbol (buffer, address,-1 ,1 ,1 ); }/* To avoid using get_symbol_offset for every symbol, we carry prefix along. */ kernel/module.c +4
-0@@ -13,6 +13,7 @@#include <linux/trace_events.h> #include <linux/init.h> #include <linux/kallsyms.h> +#include <linux/buildid.h> #include <linux/file.h> #include <linux/fs.h> #include <linux/sysfs.h> @@ -2770,6 +2771,20 @@ static void add_kallsyms(struct module *mod, const struct load_info *info) } mod->core_kallsyms.num_symtab = ndst; } + +static void init_build_id (struct module *mod,const struct load_info *info) +{
kernel/module.c static void add_kallsyms(struct module *mod, const struct load_info *info) · line 2786
Quoted 10 lines
kernel/module.c +10
-0+const Elf_Shdr *sechdr; +unsigned int i; + +for (i =0 ; i < info->hdr->e_shnum; i++) { + sechdr = &info->sechdrs[i]; +if (!sect_empty (sechdr) && sechdr->sh_type ==SHT_NOTE && + !build_id_parse_buf ((void *)sechdr->sh_addr, mod->build_id, + sechdr->sh_size)) +break ; + }
If mod->build_id is not used when !CONFIG_STACKTRACE_BUILD_ID, then we don't need to look for it. I would be fine with wrapping the function body in an ifdef (similar to what we currently do in del_usage_links() and do_mod_ctors()).
Quoted 33 lines
kernel/module.c +7
-1+}#else static inline void layout_symtab (struct module *mod,struct load_info *info) {@@ -2778,6 +2793,10 @@ static inline void layout_symtab(struct module *mod, struct load_info *info)static void add_kallsyms (struct module *mod,const struct load_info *info) { } + +static void init_build_id (struct module *mod,const struct load_info *info) +{ +}#endif /* CONFIG_KALLSYMS */ static void dynamic_debug_setup (struct module *mod,struct _ddebug *debug,unsigned int num)@@ -4004,6 +4023,7 @@ static int load_module(struct load_info *info, const char __user *uargs, goto free_arch_cleanup; } +init_build_id (mod, info);dynamic_debug_setup (mod, info->debug, info->num_debug);/* Ftrace init must be called in the MODULE_STATE_UNFORMED state */ @@ -4235,7 +4255,7 @@ void * __weak dereference_module_function_descriptor(struct module *mod,const char *module_address_lookup (unsigned long addr,unsigned long *size,unsigned long *offset, -char **modname, +char **modname,const unsigned char **modbuildid,char *namebuf) {const char *ret =NULL ;
kernel/module.c const char *module_address_lookup(unsigned long addr, · line 4270
Quoted 5 lines
kernel/module.c +2
-0@@ -4246,6 +4266,8 @@ const char *module_address_lookup(unsigned long addr,if (mod) {if (modname) *modname = mod->name; +if (modbuildid) + *modbuildid = mod->build_id;
Then maybe we can set *modbuildid = NULL in the case of !CONFIG_STACKTRACE_BUILD_ID, similar to the kernel case in kallsyms_lookup_buildid().
Thanks!
Jessica
Re: [PATCH v4 05/13] module: Add printk formats to add module build ID to stacktraces
Quoting Jessica Yu (2021-04-15 06:04:35)
Quoted 22 lines
+++ Stephen Boyd [09/04/21 18:52 -0700]:
Quoted 13 lines
include/linux/module.h +1
-0@@ -11,6 +11,7 @@#include <linux/list.h> #include <linux/stat.h> +#include <linux/buildid.h> #include <linux/compiler.h> #include <linux/cache.h> #include <linux/kmod.h> include/linux/module.h struct module { · line 372
Quoted 5 lines
include/linux/module.h +2
-0@@ -367,6 +368,9 @@ struct module {/* Unique handle for this module */ char name[MODULE_NAME_LEN ]; +/* Module build ID */ +unsigned char build_id[BUILD_ID_SIZE_MAX ];Hi Stephen,
Quoted 4 lines
Since this field is not used when !CONFIG_STACKTRACE_BUILD_ID, I would prefer to wrap this in an ifdef, similar to the other CONFIG-dependent fields in struct module. This makes it explicit under what conditions (i.e. config) the field is meant to be used.
Ok will do.
Quoted 18 lines
Quoted 18 lines
kernel/module.c +10
-0@@ -2770,6 +2771,20 @@ static void add_kallsyms(struct module *mod, const struct load_info *info) } mod->core_kallsyms.num_symtab = ndst; } + +static void init_build_id(struct module *mod, const struct load_info *info) +{ + const Elf_Shdr *sechdr; + unsigned int i; + + for (i = 0; i < info->hdr->e_shnum; i++) { + sechdr = &info->sechdrs[i]; + if (!sect_empty(sechdr) && sechdr->sh_type == SHT_NOTE && + !build_id_parse_buf((void *)sechdr->sh_addr, mod->build_id,
Quoted 8 lines
kernel/module.c static void add_kallsyms(struct module *mod, const struct load_info *info) · line 2786
Quoted 3 lines
kernel/module.c +3
-0+ sechdr->sh_size)) +break ; + }If
mod->build_idis not used when !CONFIG_STACKTRACE_BUILD_ID, then we don't need to look for it. I would be fine with wrapping the function body in an ifdef (similar to what we currently do indel_usage_links()anddo_mod_ctors()).
Ok, done.
Quoted 35 lines
Quoted 35 lines
kernel/module.c +7
-1+}#else static inline void layout_symtab (struct module *mod,struct load_info *info) {@@ -2778,6 +2793,10 @@ static inline void layout_symtab(struct module *mod, struct load_info *info)static void add_kallsyms (struct module *mod,const struct load_info *info) { } + +static void init_build_id (struct module *mod,const struct load_info *info) +{ +}#endif /* CONFIG_KALLSYMS */ static void dynamic_debug_setup (struct module *mod,struct _ddebug *debug,unsigned int num)@@ -4004,6 +4023,7 @@ static int load_module(struct load_info *info, const char __user *uargs, goto free_arch_cleanup; } +init_build_id (mod, info);dynamic_debug_setup (mod, info->debug, info->num_debug);/* Ftrace init must be called in the MODULE_STATE_UNFORMED state */ @@ -4235,7 +4255,7 @@ void * __weak dereference_module_function_descriptor(struct module *mod,const char *module_address_lookup (unsigned long addr,unsigned long *size,unsigned long *offset, -char **modname, +char **modname,const unsigned char **modbuildid,char *namebuf) {const char *ret =NULL ;@@ -4246,6 +4266,8 @@ const char *module_address_lookup(unsigned long addr,if (mod) {
Quoted 9 lines
kernel/module.c const char *module_address_lookup(unsigned long addr, · line 4270
Quoted 4 lines
kernel/module.c +2
-0if (modname) *modname = mod->name; +if (modbuildid) + *modbuildid = mod->build_id;Then maybe we can set *modbuildid = NULL in the case of !CONFIG_STACKTRACE_BUILD_ID, similar to the kernel case in
kallsyms_lookup_buildid().
Sounds good. It means that some more ifdefs are probably required vs. making the array size be 0 when the config is disabled but that isn't a big problem for me. I'm reworking the code now and will test and then send v5 shortly. Thanks!
Re: [PATCH v4 05/13] module: Add printk formats to add module build ID to stacktraces
+++ Stephen Boyd [17/04/21 18:52 -0700]:
[snip]
Quoted 4 lines
Sounds good. It means that some more ifdefs are probably required vs. making the array size be 0 when the config is disabled but that isn't a big problem for me. I'm reworking the code now and will test and then send v5 shortly. Thanks!
Great, thanks a lot Stephen!
Jessica
PATCH v4 6/13 arm64: stacktrace: Use %pSb for backtrace printing
In reply to Stephen BoydLet's use the new printk format to print the stacktrace entry when printing a backtrace to the kernel logs. This will include any module's build ID[1] in it so that offline/crash debugging can easily locate the debuginfo for a module via something like debuginfod[2].
--- arch/arm64/kernel/stacktrace.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
arch/arm64/kernel/stacktrace.c +1 -1
@@ -129,7 +129,7 @@ NOKPROBE_SYMBOL(walk_stackframe);static void dump_backtrace_entry (unsigned long where,const char *loglvl) { -printk ("%s %pS\n" , loglvl, (void *)where); +printk ("%s %pSb\n" , loglvl, (void *)where); } void dump_backtrace(struct pt_regs *regs, struct task_struct *tsk,
Signature · 1 line
https://chromeos.dev
PATCH v4 7/13 x86/dumpstack: Use %pSb/%pBb for backtrace printing
In reply to Stephen BoydLet's use the new printk formats to print the stacktrace entries when printing a backtrace to the kernel logs. This will include any module's build ID[1] in it so that offline/crash debugging can easily locate the debuginfo for a module via something like debuginfod[2].
--- arch/x86/kernel/dumpstack.c | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-)
arch/x86/kernel/dumpstack.c +3 -3
@@ -69,7 +69,7 @@ static void printk_stack_address(unsigned long address, int reliable, const char *log_lvl) {touch_nmi_watchdog (); -printk ("%s %s%pB\n" , log_lvl, reliable ?"" :"? " , (void *)address); +printk ("%s %s%pBb\n" , log_lvl, reliable ?"" :"? " , (void *)address); } static int copy_code(struct pt_regs *regs, u8 *buf, unsigned long src,
@@ -143,9 +143,9 @@ void show_opcodes(struct pt_regs *regs, const char *loglvl)void show_ip (struct pt_regs *regs,const char *loglvl) {#ifdef CONFIG_X86_32 -printk ("%sEIP: %pS\n" , loglvl, (void *)regs->ip); +printk ("%sEIP: %pSb\n" , loglvl, (void *)regs->ip);#else -printk ("%sRIP: %04x:%pS\n" , loglvl, (int )regs->cs, (void *)regs->ip); +printk ("%sRIP: %04x:%pSb\n" , loglvl, (int )regs->cs, (void *)regs->ip);#endif show_opcodes (regs, loglvl); }
Signature · 1 line
https://chromeos.dev
PATCH v4 8/13 scripts/decode_stacktrace.sh: Support debuginfod
In reply to Stephen BoydNow that stacktraces contain the build ID information we can update this script to use debuginfod-find to locate the debuginfo for the vmlinux and modules automatically. This can replace the existing code that requires specifying a path to vmlinux or tries to find the vmlinux and modules automatically by using the release number. Work it into the script as a fallback option if the vmlinux isn't specified on the commandline.
--- scripts/decode_stacktrace.sh | 81 +++++++++++++++++++++++++++++++----- 1 file changed, 70 insertions(+), 11 deletions(-)
scripts/decode_stacktrace.sh +70 -11
@@ -3,11 +3,10 @@ # (c) 2014, Sasha Levin <[email protected]> #set -x -if [[ $# < 1 ]]; then +usage() { echo "Usage:" echo " $0 -r <release> | <vmlinux> [base path] [modules path]" - exit 1 -fi +} if [[ $1 == "-r" ]] ; then vmlinux=""
@@ -24,6 +23,7 @@ if [[ $1 == "-r" ]] ; then if [[ $vmlinux == "" ]] ; then echo "ERROR! vmlinux image for release $release is not found" >&2 + usage exit 2 fi else
@@ -31,12 +31,35 @@ else basepath=${2-auto} modpath=$3 release="" + debuginfod= + + # Can we use debuginfod-find? + if type debuginfod-find >/dev/null 2>&1 ; then + debuginfod=${1-only} + fi + + if [[ $vmlinux == "" && -z $debuginfod ]] ; then + echo "ERROR! vmlinux image must be specified" >&2 + usage + exit 1 + fi fi declare -A cache declare -A modcache find_module() { + if [[ -n $debuginfod ]] ; then + if [[ -n $modbuildid ]] ; then + debuginfod-find debuginfo $modbuildid && return + fi + + # Only using debuginfod so don't try to find vmlinux module path + if [[ $debuginfod == "only" ]] ; then + return + fi + fi + if [[ "$modpath" != "" ]] ; then for fn in $(find "$modpath" -name "${module//_/[-_]}.ko*") ; do if readelf -WS "$fn" | grep -qwF .debug_line ; then
@@ -150,6 +173,27 @@ parse_symbol() { symbol="$segment$name ($code)" } +debuginfod_get_vmlinux() { + local vmlinux_buildid=${1##* } + + if [[ $vmlinux != "" ]]; then + return + fi + + if [[ $vmlinux_buildid =~ ^[0-9a-f]+ ]]; then + vmlinux=$(debuginfod-find debuginfo $vmlinux_buildid) + if [[ $? -ne 0 ]] ; then + echo "ERROR! vmlinux image not found via debuginfod-find" >&2 + usage + exit 2 + fi + return + fi + echo "ERROR! Build ID for vmlinux not found. Try passing -r or specifying vmlinux" >&2 + usage + exit 2 +} + decode_code() { local scripts=`dirname "${BASH_SOURCE[0]}"`
@@ -157,6 +201,14 @@ decode_code() { } handle_line() { + if [[ $basepath == "auto" && $vmlinux != "" ]] ; then + module="" + symbol="kernel_init+0x0/0x0" + parse_symbol + basepath=${symbol#kernel_init (} + basepath=${basepath%/init/main.c:*)} + fi + local words # Tokenize
@@ -182,16 +234,28 @@ handle_line() { fi done + if [[ ${words[$last]} =~ ^[0-9a-f]+\] ]]; then + words[$last-1]="${words[$last-1]} ${words[$last]}" + unset words[$last] + last=$(( $last - 1 )) + fi + if [[ ${words[$last]} =~ \[([^]]+)\] ]]; then module=${words[$last]} module=${module#\[} module=${module%\]} + modbuildid=${module#* } + module=${module% *} + if [[ $modbuildid == $module ]]; then + modbuildid= + fi symbol=${words[$last-1]} unset words[$last-1] else # The symbol is the last element, process it symbol=${words[$last]} module= + modbuildid= fi unset words[$last]
@@ -201,14 +265,6 @@ handle_line() { echo "${words[@]}" "$symbol $module" } -if [[ $basepath == "auto" ]] ; then - module="" - symbol="kernel_init+0x0/0x0" - parse_symbol - basepath=${symbol#kernel_init (} - basepath=${basepath%/init/main.c:*)} -fi - while read line; do # Let's see if we have an address in the line if [[ $line =~ \[\<([^]]+)\>\] ]] ||
@@ -218,6 +274,9 @@ while read line; do # Is it a code line? elif [[ $line == *Code:* ]]; then decode_code "$line" + # Is it a version line? + elif [[ -n $debuginfod && $line =~ PID:\ [0-9]+\ Comm: ]]; then + debuginfod_get_vmlinux "$line" else # Nothing special in this line, show it as is echo "$line"
Signature · 1 line
https://chromeos.dev
PATCH v4 9/13 scripts/decode_stacktrace.sh: Silence stderr messages from addr2line/nm
In reply to Stephen BoydSometimes if you're using tools that have linked things improperly or have new features/sections that older tools don't expect you'll see warnings printed to stderr. We don't really care about these warnings, so let's just silence these messages to cleanup output of this script.
--- scripts/decode_stacktrace.sh | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-)
scripts/decode_stacktrace.sh +3 -3
@@ -74,7 +74,7 @@ find_module() { find_module && return if [[ $release == "" ]] ; then - release=$(gdb -ex 'print init_uts_ns.name.release' -ex 'quit' -quiet -batch "$vmlinux" | sed -n 's/\$1 = "\(.*\)".*/\1/p') + release=$(gdb -ex 'print init_uts_ns.name.release' -ex 'quit' -quiet -batch "$vmlinux" 2>/dev/null | sed -n 's/\$1 = "\(.*\)".*/\1/p') fi for dn in {/usr/lib/debug,}/lib/modules/$release ; do
@@ -128,7 +128,7 @@ parse_symbol() { if [[ "${cache[$module,$name]+isset}" == "isset" ]]; then local base_addr=${cache[$module,$name]} else - local base_addr=$(nm "$objfile" | awk '$3 == "'$name'" && ($2 == "t" || $2 == "T") {print $1; exit}') + local base_addr=$(nm "$objfile" 2>/dev/null | awk '$3 == "'$name'" && ($2 == "t" || $2 == "T") {print $1; exit}') if [[ $base_addr == "" ]] ; then # address not found return
@@ -152,7 +152,7 @@ parse_symbol() { if [[ "${cache[$module,$address]+isset}" == "isset" ]]; then local code=${cache[$module,$address]} else - local code=$(${CROSS_COMPILE}addr2line -i -e "$objfile" "$address") + local code=$(${CROSS_COMPILE}addr2line -i -e "$objfile" "$address" 2>/dev/null) cache[$module,$address]=$code fi
Signature · 1 line
https://chromeos.dev
PATCH v4 10/13 scripts/decode_stacktrace.sh: Indicate 'auto' can be used for base path
In reply to Stephen BoydAdd "auto" to the usage message so that it's a little clearer that you can pass "auto" as the second argument. When passing "auto" the script tries to find the base path automatically instead of requiring it be passed on the commandline. Also use [<variable>] to indicate the variable argument and that it is optional so that we can differentiate from the literal "auto" that should be passed.
--- scripts/decode_stacktrace.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
scripts/decode_stacktrace.sh +1 -1
@@ -5,7 +5,7 @@ usage() { echo "Usage:" - echo " $0 -r <release> | <vmlinux> [base path] [modules path]" + echo " $0 -r <release> | <vmlinux> [<base path>|auto] [<modules path>]" } if [[ $1 == "-r" ]] ; then
Signature · 1 line
https://chromeos.dev
PATCH v4 11/13 buildid: Mark some arguments const
In reply to Stephen BoydThese arguments are never modified so they can be marked const to indicate as such.
--- lib/buildid.c | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-)
lib/buildid.c +4 -4
@@ -48,10 +48,10 @@ static int parse_build_id_buf(unsigned char *build_id,return -EINVAL ; } -static inline int parse_build_id (void *page_addr, +static inline int parse_build_id (const void *page_addr,unsigned char *build_id,__u32 *size, -void *note_start, +const void *note_start,Elf32_Word note_size) {/* check for overflow */
@@ -66,7 +66,7 @@ static inline int parse_build_id(void *page_addr, }/* Parse build ID from 32-bit ELF */ -static int get_build_id_32 (void *page_addr,unsigned char *build_id, +static int get_build_id_32 (const void *page_addr,unsigned char *build_id,__u32 *size) {Elf32_Ehdr *ehdr = (Elf32_Ehdr *)page_addr;
@@ -91,7 +91,7 @@ static int get_build_id_32(void *page_addr, unsigned char *build_id, }/* Parse build ID from 64-bit ELF */ -static int get_build_id_64 (void *page_addr,unsigned char *build_id, +static int get_build_id_64 (const void *page_addr,unsigned char *build_id,__u32 *size) {Elf64_Ehdr *ehdr = (Elf64_Ehdr *)page_addr;
Signature · 1 line
https://chromeos.dev
PATCH v4 12/13 buildid: Fix kernel-doc notation
In reply to Stephen BoydKernel doc should use "Return:" instead of "Returns" to properly reflect the return values.
--- lib/buildid.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
lib/buildid.c +1 -1
@@ -121,7 +121,7 @@ static int get_build_id_64(const void *page_addr, unsigned char *build_id,* @build_id: buffer to store build id, at least BUILD_ID_SIZE long * @size: returns actual build id size in case of success * -* Returns 0 on success, otherwise error (< 0). +* Return: 0 on success, -EINVAL otherwise */ int build_id_parse (struct vm_area_struct *vma,unsigned char *build_id,__u32 *size)
Signature · 1 line
https://chromeos.dev
PATCH v4 13/13 kdump: Use vmlinux_build_id to simplify
In reply to Stephen BoydWe can use the vmlinux_build_id array here now instead of open coding it. This mostly consolidates code.
--- include/linux/crash_core.h | 7 ++---- kernel/crash_core.c | 50 ++------------------------------------ 2 files changed, 4 insertions(+), 53 deletions(-)
include/linux/crash_core.h +2 -5
@@ -39,7 +39,8 @@ phys_addr_t paddr_vmcoreinfo_note(void);#define VMCOREINFO_OSRELEASE (value) \ vmcoreinfo_append_str("OSRELEASE=%s\n", value)#define VMCOREINFO_BUILD_ID (value) \ - vmcoreinfo_append_str("BUILD-ID=%s\n", value) + BUILD_BUG_ON(ARRAY_SIZE(value) != BUILD_ID_SIZE_MAX); \ + vmcoreinfo_append_str("BUILD-ID=%20phN\n", value)#define VMCOREINFO_PAGESIZE (value) \ vmcoreinfo_append_str("PAGESIZE=%ld\n", value)#define VMCOREINFO_SYMBOL (name) \
@@ -69,10 +70,6 @@ extern unsigned char *vmcoreinfo_data;extern size_t vmcoreinfo_size;extern u32 *vmcoreinfo_note; -/* raw contents of kernel .notes section */ -extern const void __start_notes__weak ; -extern const void __stop_notes__weak ; -Elf_Word *append_elf_note (Elf_Word *buf,char *name,unsigned int type,void *data,size_t data_len);void final_note (Elf_Word *buf);
kernel/crash_core.c +2 -48
68 lines not on this page · raw message
Signature · 7 lines
https://chromeos.dev _______________________________________________ kexec mailing list [email protected] http://lists.infradead.org/mailman/listinfo/kexec