Skip to content

Commit 7a0fd5e

Browse files
melverkees
authored andcommitted
compiler_types: Introduce the Clang __preserve_most function attribute
[1]: "On X86-64 and AArch64 targets, this attribute changes the calling convention of a function. The preserve_most calling convention attempts to make the code in the caller as unintrusive as possible. This convention behaves identically to the C calling convention on how arguments and return values are passed, but it uses a different set of caller/callee-saved registers. This alleviates the burden of saving and recovering a large register set before and after the call in the caller. If the arguments are passed in callee-saved registers, then they will be preserved by the callee across the call. This doesn't apply for values returned in callee-saved registers. * On X86-64 the callee preserves all general purpose registers, except for R11. R11 can be used as a scratch register. Floating-point registers (XMMs/YMMs) are not preserved and need to be saved by the caller. * On AArch64 the callee preserve all general purpose registers, except x0-X8 and X16-X18." [1] https://clang.llvm.org/docs/AttributeReference.html#preserve-most Introduce the attribute to compiler_types.h as __preserve_most. Use of this attribute results in better code generation for calls to very rarely called functions, such as error-reporting functions, or rarely executed slow paths. Beware that the attribute conflicts with instrumentation calls inserted on function entry which do not use __preserve_most themselves. Notably, function tracing which assumes the normal C calling convention for the given architecture. Where the attribute is supported, __preserve_most will imply notrace. It is recommended to restrict use of the attribute to functions that should or already disable tracing. Note: The additional preprocessor check against architecture should not be necessary if __has_attribute() only returns true where supported; also see ClangBuiltLinux#1908. But until __has_attribute() does the right thing, we also guard by known-supported architectures to avoid build warnings on other architectures. The attribute may be supported by a future GCC version (see https://gcc.gnu.org/bugzilla/show_bug.cgi?id=110899). Signed-off-by: Marco Elver <[email protected]> Reviewed-by: Miguel Ojeda <[email protected]> Reviewed-by: Nick Desaulniers <[email protected]> Acked-by: "Steven Rostedt (Google)" <[email protected]> Acked-by: Mark Rutland <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Kees Cook <[email protected]>
1 parent 2e3f65c commit 7a0fd5e

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

include/linux/compiler_types.h

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,34 @@ static inline void __chk_io_ptr(const volatile void __iomem *ptr) { }
106106
#define __cold
107107
#endif
108108

109+
/*
110+
* On x86-64 and arm64 targets, __preserve_most changes the calling convention
111+
* of a function to make the code in the caller as unintrusive as possible. This
112+
* convention behaves identically to the C calling convention on how arguments
113+
* and return values are passed, but uses a different set of caller- and callee-
114+
* saved registers.
115+
*
116+
* The purpose is to alleviates the burden of saving and recovering a large
117+
* register set before and after the call in the caller. This is beneficial for
118+
* rarely taken slow paths, such as error-reporting functions that may be called
119+
* from hot paths.
120+
*
121+
* Note: This may conflict with instrumentation inserted on function entry which
122+
* does not use __preserve_most or equivalent convention (if in assembly). Since
123+
* function tracing assumes the normal C calling convention, where the attribute
124+
* is supported, __preserve_most implies notrace. It is recommended to restrict
125+
* use of the attribute to functions that should or already disable tracing.
126+
*
127+
* Optional: not supported by gcc.
128+
*
129+
* clang: https://clang.llvm.org/docs/AttributeReference.html#preserve-most
130+
*/
131+
#if __has_attribute(__preserve_most__) && (defined(CONFIG_X86_64) || defined(CONFIG_ARM64))
132+
# define __preserve_most notrace __attribute__((__preserve_most__))
133+
#else
134+
# define __preserve_most
135+
#endif
136+
109137
/* Builtins */
110138

111139
/*

0 commit comments

Comments
 (0)