From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id 72A93C00140 for ; Mon, 8 Aug 2022 11:47:36 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=bombadil.20210309; h=Sender: Content-Transfer-Encoding:Content-Type:List-Subscribe:List-Help:List-Post: List-Archive:List-Unsubscribe:List-Id:In-Reply-To:MIME-Version:References: Message-ID:Subject:Cc:To:From:Date:Reply-To:Content-ID:Content-Description: Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID: List-Owner; bh=19BlX2/qNtdsmOcJRIxLvdy61xJ3NAFF/L1o0JehNQ0=; b=SaFCtoP6jl8shz chfs8mI+RURdBR6+lg6rdVdR25sPWWGs0+KKP/1rqpFSkulE3e9FBILiLmkLkr9ftyqfam2MjfMMC nKHp1Rw35+UI+E9dAyX7ncen+1deKCC1WiO3rleBrs8GL+EENLHsXW4zTSToyflhqRvU66KRWJ7m7 in4ra7NGAPnYbLKEuU3qQ+XhoQ70cAaK9Gal+jxJv9GwCc1DcC4nS9XoEbAB+1DGH8XrCgTWg9sBy fe/4T1E1t9W0Q3zHVUVNruooN2XW9/AS56QWa4E7L6BsQ2jbsHo+ww5DBbe928kZX5hN3OUto0p3T gO4zq0aBKQx5ne9S/MLg==; Received: from localhost ([::1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.94.2 #2 (Red Hat Linux)) id 1oL1DU-00DJnG-Bx; Mon, 08 Aug 2022 11:46:40 +0000 Received: from foss.arm.com ([217.140.110.172]) by bombadil.infradead.org with esmtp (Exim 4.94.2 #2 (Red Hat Linux)) id 1oL1DQ-00DJkB-6x for linux-arm-kernel@lists.infradead.org; Mon, 08 Aug 2022 11:46:38 +0000 Received: from usa-sjc-imap-foss1.foss.arm.com (unknown [10.121.207.14]) by usa-sjc-mx-foss1.foss.arm.com (Postfix) with ESMTP id 47A1FED1; Mon, 8 Aug 2022 04:46:33 -0700 (PDT) Received: from FVFF77S0Q05N (unknown [10.57.44.193]) by usa-sjc-imap-foss1.foss.arm.com (Postfix) with ESMTPSA id 0E3AD3F5A1; Mon, 8 Aug 2022 04:46:30 -0700 (PDT) Date: Mon, 8 Aug 2022 12:46:25 +0100 From: Mark Rutland To: Will Deacon Cc: linux-arm-kernel@lists.infradead.org, broonie@kernel.org, catalin.marinas@arm.com, james.morse@arm.com, kaleshsingh@google.com, madvenka@linux.microsoft.com, maz@kernel.org, tabba@google.com Subject: Re: [PATCH v2 2/8] arm64: stacktrace: rename unwind_next_common() -> unwind_next_frame_record() Message-ID: References: <20220805124522.706457-1-mark.rutland@arm.com> <20220805124522.706457-3-mark.rutland@arm.com> <20220808113810.GA32107@willie-the-truck> MIME-Version: 1.0 Content-Disposition: inline In-Reply-To: <20220808113810.GA32107@willie-the-truck> X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20220808_044636_370383_CF4053E5 X-CRM114-Status: GOOD ( 29.02 ) X-BeenThere: linux-arm-kernel@lists.infradead.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+linux-arm-kernel=archiver.kernel.org@lists.infradead.org On Mon, Aug 08, 2022 at 12:38:10PM +0100, Will Deacon wrote: > On Fri, Aug 05, 2022 at 01:45:16PM +0100, Mark Rutland wrote: > > The unwind_next_common() function unwinds a single frame record. There > > are other unwind steps (e.g. unwinding through trampolines) which are > > handled in the regular kernel unwinder, and in future there may be other > > common unwind helpers. > > > > Clarify the purpose of unwind_next_common() by renaming it to > > unwind_next_frame_record(). At the same time, add commentary, and delete > > the redundant comment at the top of asm/stacktrace/common.h. > > > > There should be no functional change as a result of this patch. > > > > Signed-off-by: Mark Rutland > > Reviewed-by: Kalesh Singh > > Reviewed-by: Mark Brown > > Cc: Fuad Tabba > > Cc: Kalesh Singh > > Cc: Madhavan T. Venkataraman > > Cc: Marc Zyngier > > --- > > arch/arm64/include/asm/stacktrace/common.h | 22 ++++++++++++---------- > > arch/arm64/kernel/stacktrace.c | 2 +- > > arch/arm64/kvm/hyp/nvhe/stacktrace.c | 2 +- > > arch/arm64/kvm/stacktrace.c | 4 ++-- > > 4 files changed, 16 insertions(+), 14 deletions(-) > > > > diff --git a/arch/arm64/include/asm/stacktrace/common.h b/arch/arm64/include/asm/stacktrace/common.h > > index 01dc9f44a24a7..676002d7d333c 100644 > > --- a/arch/arm64/include/asm/stacktrace/common.h > > +++ b/arch/arm64/include/asm/stacktrace/common.h > > @@ -2,13 +2,6 @@ > > /* > > * Common arm64 stack unwinder code. > > * > > - * To implement a new arm64 stack unwinder: > > - * 1) Include this header > > - * > > - * 2) Call into unwind_next_common() from your top level unwind > > - * function, passing it the validation and translation callbacks > > - * (though the later can be NULL if no translation is required). > > - * > > * See: arch/arm64/kernel/stacktrace.c for the reference implementation. > > * > > * Copyright (C) 2012 ARM Ltd. > > @@ -139,9 +132,18 @@ typedef bool (*on_accessible_stack_fn)(const struct task_struct *tsk, > > unsigned long sp, unsigned long size, > > struct stack_info *info); > > > > -static inline int unwind_next_common(struct unwind_state *state, > > - on_accessible_stack_fn accessible, > > - stack_trace_translate_fp_fn translate_fp) > > +/* > > + * unwind_next_frame_record() - Unwind to the next frame record indicated by > > + * @state->fp. > > + * > > + * @state: the current unwind state. > > + * @accessible: determines whether the frame record is accessible > > + * @translate_fp: translates the fp prior to access (may be NULL) > > + */ > > This looks like kerneldoc, so you I think you should make the opening "/*" a > "/**". I agree; that's also true for all the other comments in this file. Would you mind if I did that as a follow-up fixing all of them? Otherwise, I can spin a v3 with a preparatory patch for the existing instances. Thanks, Mark. _______________________________________________ linux-arm-kernel mailing list linux-arm-kernel@lists.infradead.org http://lists.infradead.org/mailman/listinfo/linux-arm-kernel