arch: rename struct _callee_saved to struct arch_csf

ycsin · ycsin · commit db4834d2ae7e · 2024-09-05T11:33:23.000+08:00
Rename every architecture's `struct _callee_saved` to
`struct arch_csf`.

Signed-off-by: Yong Cong Sin &lt;ycsin@meta.com&gt;
Signed-off-by: Yong Cong Sin &lt;yongcong.sin@gmail.com&gt;
diff --git a/arch/arm/core/fatal.c b/arch/arm/core/fatal.c
@@ -47,7 +47,7 @@ static void esf_dump(const struct arch_esf *esf)
 	LOG_ERR("fpscr:  0x%08x", esf->fpu.fpscr);
 #endif
 #if defined(CONFIG_EXTRA_EXCEPTION_INFO)
-	const struct _callee_saved *callee = esf->extra_info.callee;
+	const struct arch_csf *callee = esf->extra_info.callee;
 
 	if (callee != NULL) {
 		LOG_ERR("r4/v1:  0x%08x  r5/v2:  0x%08x  r6/v3:  0x%08x",
diff --git a/arch/arm/core/offsets/offsets_aarch32.c b/arch/arm/core/offsets/offsets_aarch32.c
@@ -68,7 +68,7 @@ GEN_ABSOLUTE_SYM(___esf_t_SIZEOF, sizeof(_esf_t));
 
 /* size of the entire preempt registers structure */
 
-GEN_ABSOLUTE_SYM(___callee_saved_t_SIZEOF, sizeof(struct _callee_saved));
+GEN_ABSOLUTE_SYM(___callee_saved_t_SIZEOF, sizeof(struct arch_csf));
 
 #if defined(CONFIG_EXTRA_EXCEPTION_INFO)
 GEN_ABSOLUTE_SYM(___extra_esf_info_t_SIZEOF, sizeof(struct __extra_esf_info));
diff --git a/arch/riscv/core/offsets/offsets.c b/arch/riscv/core/offsets/offsets.c
@@ -27,7 +27,7 @@
 
 #include <kernel_offsets.h>
 
-/* struct _callee_saved member offsets */
+/* struct arch_csf member offsets */
 GEN_OFFSET_SYM(_callee_saved_t, sp);
 GEN_OFFSET_SYM(_callee_saved_t, ra);
 GEN_OFFSET_SYM(_callee_saved_t, s0);
diff --git a/include/zephyr/arch/arc/thread.h b/include/zephyr/arch/arc/thread.h
@@ -11,7 +11,7 @@
  * This file contains definitions for
  *
  *  struct _thread_arch
- *  struct _callee_saved
+ *  struct arch_csf
  *
  * necessary to instantiate instances of struct k_thread.
  */
@@ -34,10 +34,10 @@
 extern "C" {
 #endif
 
-struct _callee_saved {
+struct arch_csf {
 	uintptr_t sp; /* r28 */
 };
-typedef struct _callee_saved _callee_saved_t;
+typedef struct arch_csf _callee_saved_t;
 
 struct _thread_arch {
 
diff --git a/include/zephyr/arch/arm/thread.h b/include/zephyr/arch/arm/thread.h
@@ -11,7 +11,7 @@
  * This file contains definitions for
  *
  *  struct _thread_arch
- *  struct _callee_saved
+ *  struct arch_csf
   *
  * necessary to instantiate instances of struct k_thread.
  */
@@ -22,7 +22,7 @@
 #ifndef _ASMLANGUAGE
 #include <zephyr/types.h>
 
-struct _callee_saved {
+struct arch_csf {
 	uint32_t v1;  /* r4 */
 	uint32_t v2;  /* r5 */
 	uint32_t v3;  /* r6 */
@@ -37,7 +37,7 @@ struct _callee_saved {
 #endif
 };
 
-typedef struct _callee_saved _callee_saved_t;
+typedef struct arch_csf _callee_saved_t;
 
 #if defined(CONFIG_FPU) && defined(CONFIG_FPU_SHARING)
 struct _preempt_float {
diff --git a/include/zephyr/arch/arm64/thread.h b/include/zephyr/arch/arm64/thread.h
@@ -11,7 +11,7 @@
  * This file contains definitions for
  *
  *  struct _thread_arch
- *  struct _callee_saved
+ *  struct arch_csf
  *
  * necessary to instantiate instances of struct k_thread.
  */
@@ -23,7 +23,7 @@
 #include <zephyr/types.h>
 #include <zephyr/arch/arm64/mm.h>
 
-struct _callee_saved {
+struct arch_csf {
 	uint64_t x19;
 	uint64_t x20;
 	uint64_t x21;
@@ -40,7 +40,7 @@ struct _callee_saved {
 	uint64_t lr;
 };
 
-typedef struct _callee_saved _callee_saved_t;
+typedef struct arch_csf _callee_saved_t;
 
 struct z_arm64_fp_context {
 	__int128 q0,  q1,  q2,  q3,  q4,  q5,  q6,  q7;
diff --git a/include/zephyr/arch/mips/thread.h b/include/zephyr/arch/mips/thread.h
@@ -13,7 +13,7 @@
  * This file contains definitions for
  *
  *  struct _thread_arch
- *  struct _callee_saved
+ *  struct arch_csf
  *
  * necessary to instantiate instances of struct k_thread.
  */
@@ -28,7 +28,7 @@
  * The following structure defines the list of registers that need to be
  * saved/restored when a cooperative context switch occurs.
  */
-struct _callee_saved {
+struct arch_csf {
 	unsigned long sp;	/* Stack pointer */
 
 	unsigned long s0;	/* saved register */
@@ -41,7 +41,7 @@ struct _callee_saved {
 	unsigned long s7;	/* saved register */
 	unsigned long s8;	/* saved register AKA fp */
 };
-typedef struct _callee_saved _callee_saved_t;
+typedef struct arch_csf _callee_saved_t;
 
 struct _thread_arch {
 	uint32_t swap_return_value; /* Return value of z_swap() */
diff --git a/include/zephyr/arch/nios2/thread.h b/include/zephyr/arch/nios2/thread.h
@@ -11,7 +11,7 @@
  * This file contains definitions for
  *
  *  struct _thread_arch
- *  struct _callee_saved
+ *  struct arch_csf
  *
  * necessary to instantiate instances of struct k_thread.
  */
@@ -22,7 +22,7 @@
 #ifndef _ASMLANGUAGE
 #include <zephyr/types.h>
 
-struct _callee_saved {
+struct arch_csf {
 	/* General purpose callee-saved registers */
 	uint32_t r16;
 	uint32_t r17;
@@ -51,7 +51,7 @@ struct _callee_saved {
 	uint32_t retval;
 };
 
-typedef struct _callee_saved _callee_saved_t;
+typedef struct arch_csf _callee_saved_t;
 
 struct _thread_arch {
 	/* nothing for now */
diff --git a/include/zephyr/arch/posix/thread.h b/include/zephyr/arch/posix/thread.h
@@ -12,7 +12,7 @@
  * This file contains definitions for
  *
  *  struct _thread_arch
- *  struct _callee_saved
+ *  struct arch_csf
  *
  * necessary to instantiate instances of struct k_thread.
  */
@@ -27,7 +27,7 @@
 extern "C" {
 #endif
 
-struct _callee_saved {
+struct arch_csf {
 	/* IRQ status before irq_lock() and call to z_swap() */
 	uint32_t key;
 
diff --git a/include/zephyr/arch/riscv/thread.h b/include/zephyr/arch/riscv/thread.h
@@ -11,7 +11,7 @@
  * This file contains definitions for
  *
  *  struct _thread_arch
- *  struct _callee_saved
+ *  struct arch_csf
  *
  * necessary to instantiate instances of struct k_thread.
  */
@@ -26,7 +26,7 @@
  * The following structure defines the list of registers that need to be
  * saved/restored when a context switch occurs.
  */
-struct _callee_saved {
+struct arch_csf {
 	unsigned long sp;	/* Stack pointer, (x2 register) */
 	unsigned long ra;	/* return address */
 
@@ -45,7 +45,7 @@ struct _callee_saved {
 	unsigned long s11;	/* saved register */
 #endif
 };
-typedef struct _callee_saved _callee_saved_t;
+typedef struct arch_csf _callee_saved_t;
 
 #if !defined(RV_FP_TYPE)
 #ifdef CONFIG_CPU_HAS_FPU_DOUBLE_PRECISION
diff --git a/include/zephyr/arch/sparc/thread.h b/include/zephyr/arch/sparc/thread.h
@@ -11,7 +11,7 @@
  * This file contains definitions for
  *
  *  struct _thread_arch
- *  struct _callee_saved
+ *  struct arch_csf
  *
  * necessary to instantiate instances of struct k_thread.
  */
@@ -26,7 +26,7 @@
  * The following structure defines the list of registers that need to be
  * saved/restored when a cooperative context switch occurs.
  */
-struct _callee_saved {
+struct arch_csf {
 	/* y register used by mul/div */
 	uint32_t y;
 
@@ -63,7 +63,7 @@ struct _callee_saved {
 	uint32_t o7;
 
 };
-typedef struct _callee_saved _callee_saved_t;
+typedef struct arch_csf _callee_saved_t;
 
 struct _thread_arch {
 	/* empty */
diff --git a/include/zephyr/arch/x86/ia32/thread.h b/include/zephyr/arch/x86/ia32/thread.h
@@ -11,7 +11,7 @@
  * This file contains definitions for
  *
  *  struct _thread_arch
- *  struct _callee_saved
+ *  struct arch_csf
  *
  * necessary to instantiate instances of struct k_thread.
  */
@@ -58,7 +58,7 @@
  * switch occurs.
  */
 
-struct _callee_saved {
+struct arch_csf {
 	unsigned long esp;
 
 	/*
@@ -76,7 +76,7 @@ struct _callee_saved {
 
 };
 
-typedef struct _callee_saved _callee_saved_t;
+typedef struct arch_csf _callee_saved_t;
 
 /*
  * The macros CONFIG_{LAZY|EAGER}_FPU_SHARING shall be set to indicate that the
diff --git a/include/zephyr/arch/x86/intel64/thread.h b/include/zephyr/arch/x86/intel64/thread.h
@@ -96,13 +96,13 @@ struct x86_tss64 {
 typedef struct x86_tss64 x86_tss64_t;
 
 /*
- * The _callee_saved registers are unconditionally saved/restored across
+ * The arch_csf registers are unconditionally saved/restored across
  * context switches; the _thread_arch registers are only preserved when
  * the thread is interrupted. _arch_thread.flags tells __resume when to
  * cheat and only restore the first set. For more details see locore.S.
  */
 
-struct _callee_saved {
+struct arch_csf {
 	uint64_t rsp;
 	uint64_t rbx;
 	uint64_t rbp;
@@ -114,7 +114,7 @@ struct _callee_saved {
 	uint64_t rflags;
 };
 
-typedef struct _callee_saved _callee_saved_t;
+typedef struct arch_csf _callee_saved_t;
 
 struct _thread_arch {
 	uint8_t flags;
diff --git a/include/zephyr/arch/xtensa/thread.h b/include/zephyr/arch/xtensa/thread.h
@@ -19,11 +19,11 @@
  * field exists for sizeof compatibility with C++.
  */
 
-struct _callee_saved {
+struct arch_csf {
 	char dummy;
 };
 
-typedef struct _callee_saved _callee_saved_t;
+typedef struct arch_csf _callee_saved_t;
 
 struct _thread_arch {
 	uint32_t last_cpu;
diff --git a/include/zephyr/kernel/thread.h b/include/zephyr/kernel/thread.h
@@ -261,7 +261,7 @@ struct k_thread {
 	struct _thread_base base;
 
 	/** defined by the architecture, but all archs need these */
-	struct _callee_saved callee_saved;
+	struct arch_csf callee_saved;
 
 	/** static thread init data */
 	void *init_data;
diff --git a/subsys/testsuite/ztest/unittest/include/zephyr/arch/cpu.h b/subsys/testsuite/ztest/unittest/include/zephyr/arch/cpu.h
@@ -13,14 +13,14 @@ extern "C" {
 #endif
 
 /* Architecture thread structure */
-struct _callee_saved {
+struct arch_csf {
 #ifdef CONFIG_CPP
 	/* C++ does not allow empty structs, add an extra 1 byte */
 	uint8_t c;
 #endif
 };
 
-typedef struct _callee_saved _callee_saved_t;
+typedef struct arch_csf _callee_saved_t;
 
 struct _thread_arch {
 #ifdef CONFIG_CPP
diff --git a/tests/arch/arm/arm_interrupt/src/arm_interrupt.c b/tests/arch/arm/arm_interrupt/src/arm_interrupt.c
@@ -40,7 +40,7 @@ static int check_esf_matches_expectations(const struct arch_esf *pEsf)
 	}
 
 #if defined(CONFIG_EXTRA_EXCEPTION_INFO)
-	const struct _callee_saved *callee_regs = pEsf->extra_info.callee;
+	const struct arch_csf *callee_regs = pEsf->extra_info.callee;
 	const bool callee_regs_match_expected =
 		(callee_regs->v1 /* r4 */ == 4) &&
 		(callee_regs->v2 /* r5 */ == 5) &&
