Commit b18adee4 authored by Mark Brown's avatar Mark Brown Committed by Borislav Petkov
Browse files

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.

Signed-off-by: default avatarMark Brown <broonie@kernel.org>
Signed-off-by: default avatarBorislav Petkov <bp@suse.de>
Reviewed-by: default avatarMiroslav Benes <mbenes@suse.cz>
Acked-by: default avatarVasily Gorbik <gor@linux.ibm.com>
Acked-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Link: https://lkml.kernel.org/r/20210309194125.652-1-broonie@kernel.org
parent 09141ec0

arch/s390/kernel/stacktrace.c

+0 −6
Original line number Diff line number Diff line
@@ -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
Original line number Diff line number Diff line
@@ -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
Original line number Diff line number Diff line
@@ -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);