stacktrace: Move documentation for arch_stack_walk_reliable() to header
Subsystems (4)
PATCH 1/1 stacktrace: Move documentation for arch_stack_walk_reliable() to header
Currently arch_stack_wallk_reliable() is documented with an identical comment in both x86 and S/390 implementations which is a bit redundant. Move this to the header and convert to kerneldoc while we're at it.
--- arch/s390/kernel/stacktrace.c | 6 ------ arch/x86/kernel/stacktrace.c | 6 ------ include/linux/stacktrace.h | 19 +++++++++++++++++++ 3 files changed, 19 insertions(+), 12 deletions(-)
arch/s390/kernel/stacktrace.c +0 -6
@@ -24,12 +24,6 @@ void arch_stack_walk(stack_trace_consume_fn consume_entry, void *cookie, } } -/* -* This function returns an error if it detects any unreliable features of the -* stack. Otherwise it guarantees that the stack trace is reliable. -* -* If the task is not 'current', the caller *must* ensure the task is inactive. -*/ int arch_stack_walk_reliable (stack_trace_consume_fn consume_entry,void *cookie,struct task_struct *task) {
arch/x86/kernel/stacktrace.c +0 -6
@@ -29,12 +29,6 @@ void arch_stack_walk(stack_trace_consume_fn consume_entry, void *cookie, } } -/* -* This function returns an error if it detects any unreliable features of the -* stack. Otherwise it guarantees that the stack trace is reliable. -* -* If the task is not 'current', the caller *must* ensure the task is inactive. -*/ int arch_stack_walk_reliable (stack_trace_consume_fn consume_entry,void *cookie,struct task_struct *task) {
include/linux/stacktrace.h +19 -0
@@ -52,8 +52,27 @@ typedef bool (*stack_trace_consume_fn)(void *cookie, unsigned long addr);*/ void arch_stack_walk (stack_trace_consume_fn consume_entry,void *cookie,struct task_struct *task,struct pt_regs *regs); + +/** +* arch_stack_walk_reliable - Architecture specific function to walk the +* stack reliably +* +* @consume_entry: Callback which is invoked by the architecture code for +* each entry. +* @cookie: Caller supplied pointer which is handed back to +* @consume_entry +* @task: Pointer to a task struct, can be NULL +* +* This function returns an error if it detects any unreliable +* features of the stack. Otherwise it guarantees that the stack +* trace is reliable. +* +* If the task is not 'current', the caller *must* ensure the task is +* inactive and its stack is pinned. +*/ int arch_stack_walk_reliable (stack_trace_consume_fn consume_entry,void *cookie,struct task_struct *task); +void arch_stack_walk_user (stack_trace_consume_fn consume_entry,void *cookie,const struct pt_regs *regs);
Signature · 1 line
2.20.1
Quoted 4 lines · Mark Brown
Currently
arch_stack_wallk_reliable()is documented with an identical comment in both x86 and S/390 implementations which is a bit redundant. Move this to the header and convert to kerneldoc while we're at it.
Quoted 16 lines
Cc Thomas Gleixner <[email protected]>Cc Ingo Molnar <[email protected]>Cc Borislav Petkov <[email protected]>Cc "H. Peter Anvin" <[email protected]>Cc Heiko Carstens <[email protected]>Cc Christian Borntraeger <[email protected]>Cc Josh Poimboeuf <[email protected]>Cc Jiri Kosina <[email protected]>Cc Petr Mladek <[email protected]>Cc Joe Lawrence <[email protected]>Signed-off-by Mark Brown <[email protected]>Acked-by Vasily Gorbik <[email protected]>Reviewed-by Miroslav Benes <[email protected]>
Looks good. Thanks.
Quoted 73 lines
--- arch/s390/kernel/stacktrace.c | 6 ------ arch/x86/kernel/stacktrace.c | 6 ------ include/linux/stacktrace.h | 19 +++++++++++++++++++ 3 files changed, 19 insertions(+), 12 deletions(-)arch/s390/kernel/stacktrace.c +0
-6@@ -24,12 +24,6 @@ void arch_stack_walk(stack_trace_consume_fn consume_entry, void *cookie, } } -/* -* This function returns an error if it detects any unreliable features of the -* stack. Otherwise it guarantees that the stack trace is reliable. -* -* If the task is not 'current', the caller *must* ensure the task is inactive. -*/ int arch_stack_walk_reliable (stack_trace_consume_fn consume_entry,void *cookie,struct task_struct *task) {arch/x86/kernel/stacktrace.c +0
-6@@ -29,12 +29,6 @@ void arch_stack_walk(stack_trace_consume_fn consume_entry, void *cookie, } } -/* -* This function returns an error if it detects any unreliable features of the -* stack. Otherwise it guarantees that the stack trace is reliable. -* -* If the task is not 'current', the caller *must* ensure the task is inactive. -*/ int arch_stack_walk_reliable (stack_trace_consume_fn consume_entry,void *cookie,struct task_struct *task) {include/linux/stacktrace.h +19
-0@@ -52,8 +52,27 @@ typedef bool (*stack_trace_consume_fn)(void *cookie, unsigned long addr);*/ void arch_stack_walk (stack_trace_consume_fn consume_entry,void *cookie,struct task_struct *task,struct pt_regs *regs); + +/** +* arch_stack_walk_reliable - Architecture specific function to walk the +* stack reliably +* +* @consume_entry: Callback which is invoked by the architecture code for +* each entry. +* @cookie: Caller supplied pointer which is handed back to +* @consume_entry +* @task: Pointer to a task struct, can be NULL +* +* This function returns an error if it detects any unreliable +* features of the stack. Otherwise it guarantees that the stack +* trace is reliable. +* +* If the task is not 'current', the caller *must* ensure the task is +* inactive and its stack is pinned. +*/ int arch_stack_walk_reliable (stack_trace_consume_fn consume_entry,void *cookie,struct task_struct *task); +void arch_stack_walk_user (stack_trace_consume_fn consume_entry,void *cookie,const struct pt_regs *regs);
Signature · 1 line
~Randy
Borislav Petkov
maintainerQuoted 20 lines · Mark Brown
Currently
arch_stack_wallk_reliable()is documented with an identical comment in both x86 and S/390 implementations which is a bit redundant. Move this to the header and convert to kerneldoc while we're at it.Cc Thomas Gleixner <[email protected]>Cc Ingo Molnar <[email protected]>Cc Borislav Petkov <[email protected]>Cc "H. Peter Anvin" <[email protected]>Cc Heiko Carstens <[email protected]>Cc Christian Borntraeger <[email protected]>Cc Josh Poimboeuf <[email protected]>Cc Jiri Kosina <[email protected]>Cc Petr Mladek <[email protected]>Cc Joe Lawrence <[email protected]>Signed-off-by Mark Brown <[email protected]>Acked-by Vasily Gorbik <[email protected]>Reviewed-by Miroslav Benes <[email protected]>
Quoted 5 lines
--- arch/s390/kernel/stacktrace.c | 6 ------ arch/x86/kernel/stacktrace.c | 6 ------ include/linux/stacktrace.h | 19 +++++++++++++++++++ 3 files changed, 19 insertions(+), 12 deletions(-)
LGTM.
Holler if I should take this through tip.
Thx.
Signature · 4 lines
Regards/Gruss,
Boris.
https://people.kernel.org/tglx/notes-about-netiquetteQuoted 6 lines · Borislav Petkov
Quoted 1 line · Mark Brown
Currently
arch_stack_wallk_reliable()is documented with an identicalLGTM.
Holler if I should take this through tip.
Yes please, though there's a typo Peter pointed out in the commit log above - should be walk not wallk. Let me know if you want me to resend for that.
The following commit has been merged into the x86/cleanups branch of tip:
The following commit has been merged into the x86/cleanups branch of tip:
Commit-ID: b18adee4ce4443399963826b5d28d9e63d40740c Gitweb: https://git.kernel.org/tip/b18adee4ce4443399963826b5d28d9e63d40740c Author: Mark Brown <[email protected]> AuthorDate: Tue, 09 Mar 2021 19:41:25 Committer: Borislav Petkov <[email protected]> CommitterDate: Wed, 10 Mar 2021 15:52:31 +01:00
stacktrace: Move documentation for arch_stack_walk_reliable() to header
Currently arch_stack_walk_reliable() is documented with an identical comment in both x86 and S/390 implementations which is a bit redundant. Move this to the header and convert to kerneldoc while we're at it.
--- arch/s390/kernel/stacktrace.c | 6 ------ arch/x86/kernel/stacktrace.c | 6 ------ include/linux/stacktrace.h | 19 +++++++++++++++++++ 3 files changed, 19 insertions(+), 12 deletions(-)
arch/s390/kernel/stacktrace.c +0 -6
@@ -24,12 +24,6 @@ void arch_stack_walk(stack_trace_consume_fn consume_entry, void *cookie, } } -/* -* This function returns an error if it detects any unreliable features of the -* stack. Otherwise it guarantees that the stack trace is reliable. -* -* If the task is not 'current', the caller *must* ensure the task is inactive. -*/ int arch_stack_walk_reliable (stack_trace_consume_fn consume_entry,void *cookie,struct task_struct *task) {
arch/x86/kernel/stacktrace.c +0 -6
@@ -29,12 +29,6 @@ void arch_stack_walk(stack_trace_consume_fn consume_entry, void *cookie, } } -/* -* This function returns an error if it detects any unreliable features of the -* stack. Otherwise it guarantees that the stack trace is reliable. -* -* If the task is not 'current', the caller *must* ensure the task is inactive. -*/ int arch_stack_walk_reliable (stack_trace_consume_fn consume_entry,void *cookie,struct task_struct *task) {
include/linux/stacktrace.h +19 -0
@@ -52,8 +52,27 @@ typedef bool (*stack_trace_consume_fn)(void *cookie, unsigned long addr);*/ void arch_stack_walk (stack_trace_consume_fn consume_entry,void *cookie,struct task_struct *task,struct pt_regs *regs); + +/** +* arch_stack_walk_reliable - Architecture specific function to walk the +* stack reliably +* +* @consume_entry: Callback which is invoked by the architecture code for +* each entry. +* @cookie: Caller supplied pointer which is handed back to +* @consume_entry +* @task: Pointer to a task struct, can be NULL +* +* This function returns an error if it detects any unreliable +* features of the stack. Otherwise it guarantees that the stack +* trace is reliable. +* +* If the task is not 'current', the caller *must* ensure the task is +* inactive and its stack is pinned. +*/ int arch_stack_walk_reliable (stack_trace_consume_fn consume_entry,void *cookie,struct task_struct *task); +void arch_stack_walk_user (stack_trace_consume_fn consume_entry,void *cookie,const struct pt_regs *regs);