Commit b532ab5f authored by Mark Rutland's avatar Mark Rutland Committed by Catalin Marinas
Browse files

arm64: stacktrace: rename unwind_next_common() -> unwind_next_frame_record() 



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: default avatarMark Rutland <mark.rutland@arm.com>
Reviewed-by: default avatarKalesh Singh <kaleshsingh@google.com>
Reviewed-by: default avatarMadhavan T. Venkataraman <madvenka@linux.microsoft.com>
Reviewed-by: default avatarMark Brown <broonie@kernel.org>
Cc: Fuad Tabba <tabba@google.com>
Cc: Marc Zyngier <maz@kernel.org>
Cc: Will Deacon <will@kernel.org>
Link: https://lore.kernel.org/r/20220901130646.1316937-4-mark.rutland@arm.com


Signed-off-by: default avatarCatalin Marinas <catalin.marinas@arm.com>
parent bc8d7521

arch/arm64/include/asm/stacktrace/common.h

+13 −10
Original line number Diff line number Diff line
@@ -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.
@@ -145,7 +138,17 @@ 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,

/**

 * unwind_next_frame_record() - Unwind to the next frame record.

 *

 * @state:        the current unwind state.

 * @accessible:   determines whether the frame record is accessible

 * @translate_fp: translates the fp prior to access (may be NULL)

 *

 * Return: 0 upon success, an error code otherwise.

 */

static inline int

unwind_next_frame_record(struct unwind_state *state,

			 on_accessible_stack_fn accessible,

			 stack_trace_translate_fp_fn translate_fp)

{

arch/arm64/kernel/stacktrace.c

+1 −1
Original line number Diff line number Diff line
@@ -109,7 +109,7 @@ static int notrace unwind_next(struct unwind_state *state) 
	if (fp == (unsigned long)task_pt_regs(tsk)->stackframe)

		return -ENOENT;



	err = unwind_next_common(state, on_accessible_stack, NULL);

	err = unwind_next_frame_record(state, on_accessible_stack, NULL);

	if (err)

		return err;

arch/arm64/kvm/hyp/nvhe/stacktrace.c

+1 −1
Original line number Diff line number Diff line
@@ -71,7 +71,7 @@ static bool on_accessible_stack(const struct task_struct *tsk, 


static int unwind_next(struct unwind_state *state)

{

	return unwind_next_common(state, on_accessible_stack, NULL);

	return unwind_next_frame_record(state, on_accessible_stack, NULL);

}



static void notrace unwind(struct unwind_state *state,

arch/arm64/kvm/stacktrace.c

+2 −2
Original line number Diff line number Diff line
@@ -97,7 +97,7 @@ static bool on_accessible_stack(const struct task_struct *tsk, 


static int unwind_next(struct unwind_state *state)

{

	return unwind_next_common(state, on_accessible_stack,

	return unwind_next_frame_record(state, on_accessible_stack,

					kvm_nvhe_stack_kern_va);

}