linux-kernel - Re: [PATCH] stacktrace: Move documentation for arch_stack_walk

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <55c3a5a6-6f14-52f3-61c4-f4d8c8c0b64c@infradead.org>
Date:   Tue, 9 Mar 2021 13:36:25 -0800
From:   Randy Dunlap <rdunlap@...radead.org>
To:     Mark Brown <broonie@...nel.org>, linux-kernel@...r.kernel.org
Cc:     Thomas Gleixner <tglx@...utronix.de>,
        Ingo Molnar <mingo@...hat.com>, Borislav Petkov <bp@...en8.de>,
        "H. Peter Anvin" <hpa@...or.com>,
        Heiko Carstens <hca@...ux.ibm.com>,
        Christian Borntraeger <borntraeger@...ibm.com>,
        Josh Poimboeuf <jpoimboe@...hat.com>,
        Jiri Kosina <jikos@...nel.org>, Petr Mladek <pmladek@...e.com>,
        Joe Lawrence <joe.lawrence@...hat.com>, x86@...nel.org,
        linux-s390@...r.kernel.org, live-patching@...r.kernel.org,
        Vasily Gorbik <gor@...ux.ibm.com>,
        Miroslav Benes <mbenes@...e.cz>
Subject: Re: [PATCH] stacktrace: Move documentation for
 arch_stack_walk_reliable() to header

On 3/9/21 11:41 AM, Mark Brown wrote:
> 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 <tglx@...utronix.de>
> Cc: Ingo Molnar <mingo@...hat.com>
> Cc: Borislav Petkov <bp@...en8.de>
> Cc: "H. Peter Anvin" <hpa@...or.com>
> Cc: Heiko Carstens <hca@...ux.ibm.com>
> Cc: Christian Borntraeger <borntraeger@...ibm.com>
> Cc: Josh Poimboeuf <jpoimboe@...hat.com>
> Cc: Jiri Kosina <jikos@...nel.org>
> Cc: Petr Mladek <pmladek@...e.com>
> Cc: Joe Lawrence <joe.lawrence@...hat.com>
> Cc: x86@...nel.org
> Cc: linux-s390@...r.kernel.org
> Cc: live-patching@...r.kernel.org
> Signed-off-by: Mark Brown <broonie@...nel.org>
> Acked-by: Vasily Gorbik <gor@...ux.ibm.com>
> Reviewed-by: Miroslav Benes <mbenes@...e.cz>

Acked-by: Randy Dunlap <rdunlap@...radead.org>

Looks good. Thanks.

> ---
>  arch/s390/kernel/stacktrace.c |  6 ------
>  arch/x86/kernel/stacktrace.c  |  6 ------
>  include/linux/stacktrace.h    | 19 +++++++++++++++++++
>  3 files changed, 19 insertions(+), 12 deletions(-)
> 
> diff --git a/arch/s390/kernel/stacktrace.c b/arch/s390/kernel/stacktrace.c
> index 7f1266c24f6b..101477b3e263 100644
> --- a/arch/s390/kernel/stacktrace.c
> +++ b/arch/s390/kernel/stacktrace.c
> @@ -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)
>  {
> diff --git a/arch/x86/kernel/stacktrace.c b/arch/x86/kernel/stacktrace.c
> index 8627fda8d993..15b058eefc4e 100644
> --- a/arch/x86/kernel/stacktrace.c
> +++ b/arch/x86/kernel/stacktrace.c
> @@ -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)
>  {
> diff --git a/include/linux/stacktrace.h b/include/linux/stacktrace.h
> index 50e2df30b0aa..9edecb494e9e 100644
> --- a/include/linux/stacktrace.h
> +++ b/include/linux/stacktrace.h
> @@ -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);
>  
> 


-- 
~Randy