Skip to contentSkip to conversation

arm64/signal: Document our convention for choosing magic numbers

PATCH Applied Mark Brown 2 participants 2 messages Oct 31, 2022 – Nov 14, 2022 arm64

lore
Share & tools
lore

Mark Brown

author
#0 lore raw

PATCH 1/1 arm64/signal: Document our convention for choosing magic numbers

Szabolcs Nagy has pointed out that most of our signal frame magic numbers are chosen to be meaningful ASCII when dumped to aid manual parsing. This seems sensible since it might help someone parsing things out, let's document it so people implementing new signal contexts are aware of it and are more likely to follow it.

---
 arch/arm64/include/uapi/asm/sigcontext.h | 5 +++++
 1 file changed, 5 insertions(+)
arch/arm64/include/uapi/asm/sigcontext.h +5 -0
index 4aaf31e3bf16..32db6c6adc94 100644
@@ -62,6 +62,11 @@ struct sigcontext {
  * context. Such structures must be placed after the rt_sigframe on the stack
  * and be 16-byte aligned. The last structure must be a dummy one with the
  * magic and size set to 0.
+ *
+ * Note that the values allocated for use as magic should be chosen to
+ * be meanigful in ASCII to aid manual parsing, ZA doesn't follow this
+ * convention due to oversight but it should be observed going
+ * forwards.
  */
 struct _aarch64_ctx {
 	__u32 magic;

base-commit: 30a0b95b1335e12efef89dd78518ed3e4a71a763

Signature · 7 lines
2.30.2


_______________________________________________
linux-arm-kernel mailing list
[email protected]
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
maintainer Applied
#1 lore raw
Quoted 8 lines · Mark Brown

Szabolcs Nagy has pointed out that most of our signal frame magic numbers are chosen to be meaningful ASCII when dumped to aid manual parsing. This seems sensible since it might help someone parsing things out, let's document it so people implementing new signal contexts are aware of it and are more likely to follow it.

[...]

Applied to arm64 (for-next/trivial), thanks!

[1/1] arm64/signal: Document our convention for choosing magic numbers

      https://git.kernel.org/arm64/c/9e75e74b07ab

Cheers,

Signature · 10 lines
Will

https://fixes.arm64.dev
https://next.arm64.dev
https://will.arm64.dev

_______________________________________________
linux-arm-kernel mailing list
[email protected]
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel