unwind_user: Enhance comments on get CFA, FP, and RA

Move the comment "Get the Canonical Frame Address (CFA)" to the top
of the sequence of statements that actually get the CFA.  Reword the
comment "Find the Return Address (RA)" to "Get ...", as the statements
actually get the RA.  Add a respective comment to the statements that
get the FP.  This will be useful once future commits extend the logic
to get the RA and FP.

While at it align the comment on the "stack going in wrong direction"
check to the following one on the "address is word aligned" check.

Signed-off-by: Jens Remus <jremus@linux.ibm.com>
Signed-off-by: Peter Zijlstra (Intel) <peterz@infradead.org>
Link: https://patch.msgid.link/20251208160352.1363040-2-jremus@linux.ibm.com

diff --git a/kernel/unwind/user.c b/kernel/unwind/user.c
index 39e2707894447b68d25baa6fc26e4db9492e3e3d..0ca434f86e730920f44651ca347502a0afecf53e 100644 (file)
--- a/kernel/unwind/user.c
+++ b/kernel/unwind/user.c
@@ -31,6 +31,7 @@ static int unwind_user_next_common(struct unwind_user_state *state,
 {
        unsigned long cfa, fp, ra;
 
+       /* Get the Canonical Frame Address (CFA) */
        if (frame->use_fp) {
                if (state->fp < state->sp)
                        return -EINVAL;
@@ -38,11 +39,9 @@ static int unwind_user_next_common(struct unwind_user_state *state,
        } else {
                cfa = state->sp;
        }
-
-       /* Get the Canonical Frame Address (CFA) */
        cfa += frame->cfa_off;
 
-       /* stack going in wrong direction? */
+       /* Make sure that stack is not going in wrong direction */
        if (cfa <= state->sp)
                return -EINVAL;
 
@@ -50,10 +49,11 @@ static int unwind_user_next_common(struct unwind_user_state *state,
        if (cfa & (state->ws - 1))
                return -EINVAL;
 
-       /* Find the Return Address (RA) */
+       /* Get the Return Address (RA) */
        if (get_user_word(&ra, cfa, frame->ra_off, state->ws))
                return -EINVAL;
 
+       /* Get the Frame Pointer (FP) */
        if (frame->fp_off && get_user_word(&fp, cfa, frame->fp_off, state->ws))
                return -EINVAL;