cache: enforce cache groups

Set up build time warnings to safeguard against future header changes of
organized structs.

Warning includes:

1) whether all variables are still in the same cache group
2) whether all the cache groups have the sum of the members size (in the
   maximum condition, including all members defined in configs)

The __cache_group* variables are ignored in kernel-doc check in the
various header files they appear in to enforce the cache groups.

Suggested-by: Daniel Borkmann <daniel@iogearbox.net>
Acked-by: Daniel Borkmann <daniel@iogearbox.net>
Signed-off-by: Coco Li <lixiaoyan@google.com>
Reviewed-by: Eric Dumazet <edumazet@google.com>
Reviewed-by: Shakeel Butt <shakeelb@google.com>
Signed-off-by: David S. Miller <davem@davemloft.net>

diff --git a/include/linux/cache.h b/include/linux/cache.h
index 9900d20..0ecb17b 100644 (file)
--- a/include/linux/cache.h
+++ b/include/linux/cache.h
@@ -85,6 +85,31 @@
 #define cache_line_size()      L1_CACHE_BYTES
 #endif
 
+#ifndef __cacheline_group_begin
+#define __cacheline_group_begin(GROUP) \
+       __u8 __cacheline_group_begin__##GROUP[0]
+#endif
+
+#ifndef __cacheline_group_end
+#define __cacheline_group_end(GROUP) \
+       __u8 __cacheline_group_end__##GROUP[0]
+#endif
+
+#ifndef CACHELINE_ASSERT_GROUP_MEMBER
+#define CACHELINE_ASSERT_GROUP_MEMBER(TYPE, GROUP, MEMBER) \
+       BUILD_BUG_ON(!(offsetof(TYPE, MEMBER) >= \
+                      offsetofend(TYPE, __cacheline_group_begin__##GROUP) && \
+                      offsetofend(TYPE, MEMBER) <= \
+                      offsetof(TYPE, __cacheline_group_end__##GROUP)))
+#endif
+
+#ifndef CACHELINE_ASSERT_GROUP_SIZE
+#define CACHELINE_ASSERT_GROUP_SIZE(TYPE, GROUP, SIZE) \
+       BUILD_BUG_ON(offsetof(TYPE, __cacheline_group_end__##GROUP) - \
+                    offsetofend(TYPE, __cacheline_group_begin__##GROUP) > \
+                    SIZE)
+#endif
+
 /*
  * Helper to add padding within a struct to ensure data fall into separate
  * cachelines.

diff --git a/scripts/kernel-doc b/scripts/kernel-doc
index 08a3e60..0a890fe 100755 (executable)
--- a/scripts/kernel-doc
+++ b/scripts/kernel-doc
@@ -1592,6 +1592,11 @@ sub push_parameter($$$$$) {
                $parameterdescs{$param} = "anonymous\n";
                $anon_struct_union = 1;
        }
+       elsif ($param =~ "__cacheline_group" )
+       # handle cache group enforcing variables: they do not need be described in header files
+       {
+               return; # ignore __cacheline_group_begin and __cacheline_group_end
+       }
 
        # warn if parameter has no description
        # (but ignore ones starting with # as these are not parameters