style: packed structs (#202)

style: packed structs Explain that structs must be packed (not contain any implicit padding). Signed-off-by: Gerwin Klein <gerwin.klein@proofcraft.systems>
seL4 · Oct 18, 2023 · 7b0cc2c · 7b0cc2c
1 parent d4bd9b0
commit 7b0cc2c
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/processes/style-guide.md b/processes/style-guide.md
@@ -248,6 +248,10 @@ anything in the general guide.
 * Do not use `typedef` to create a type alias for an `enum`; always
   specify `enum` types as `word_t` (otherwise, the `enum` size is
   determined by the compiler).
+* All `struct` definitions must be packed, i.e. not contain any implicit padding
+  that is inserted by the compiler (otherwise memory content is
+  unspecified). Use explicit `padding` fields of the required type size to
+  remove implicit compiler padding.
 
 ## Further resources