Received: by 2002:a05:7412:6592:b0:d7:7d3a:4fe2 with SMTP id m18csp1091939rdg; Fri, 11 Aug 2023 09:24:45 -0700 (PDT) X-Google-Smtp-Source: AGHT+IECYEfCCpCdmrYGGJw/WrEnITG15EZ8S2oeGnexcuvJVx2hrLNjNJDZRKdlvHFD7WNZRzGe X-Received: by 2002:a05:6a00:1a50:b0:668:73f5:dce0 with SMTP id h16-20020a056a001a5000b0066873f5dce0mr2199138pfv.29.1691771085335; Fri, 11 Aug 2023 09:24:45 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1691771085; cv=none; d=google.com; s=arc-20160816; b=hRqxZ0eRBzQuh/PtT2LrO1liYbq/MmZm40q6Ezvq3yaerIWtPjGg8H1KEvsXWk2o75 /MfQX8ImyNFCJHU9AhtX4IpP1NjGOzWzFoVuxyhPNFPRm16dCJGLQcL/gWVsbDolUBwy kbVBiM1tfFbyyiYoNWJ2XD5JgNxAR3GeOS8UPjU1ZIAHMn2eenoBpE9Vy5SXEEqLQ4em qTVc3pxIOh/L2tu9w+0U5iivKMhg+rSzH4/L02E3TSLbZbApy5nqZxmTcco6YOvP9x2+ dSFP/LUvMWJVBRDyA8BUrqGnKlhal/ECa7OZURxIHyiZHR92ZoO25r3cb0BqObUe/d6w DZqw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:cc:to:from:subject:message-id:mime-version:date :dkim-signature; bh=1vaThr58cHhzt3vCJBdqBIs2Yl/3Z2jvMp4OgQvCHVc=; fh=xh/g7dNJbwYr9WVB3rCguj1R0VLL65UcAaOvl7LeWOQ=; b=sCw4yUFqfVEfNFOordbmzLKzcYZLwHAhll/YUxKNWTlXDNJtS5hOV8gi8KXS2uen/j 6teT5q5Un9aqCYUUQ/l/n+lkdKr8l3gGrOqyTsNCh3m4IS5PRGSjBFO5noX8fV559haX L4pPyVOK7GaglyH5lzdN0897NsHADLrzXlv19vqnDxKvVxdSJA8aE5JiGOlA+ro3hl7p OFsT64rk6g026WGn4qed1u6aU5D+3H1EQZgPqDOD/pjckcqygQoyan1tIypnMJzv/PC4 5+EnjzjwoKY9X96jbHSJmcRMTkIR/fl1HNDQeuS+hlzJ88nIRzA1dA79vMaobbfxnM8v 7e5w== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@google.com header.s=20221208 header.b=5xqJ+9vO; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=REJECT sp=REJECT dis=NONE) header.from=google.com Return-Path: Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id ea26-20020a056a004c1a00b006875d7c82d5si3579061pfb.188.2023.08.11.09.24.33; Fri, 11 Aug 2023 09:24:45 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; dkim=pass header.i=@google.com header.s=20221208 header.b=5xqJ+9vO; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=REJECT sp=REJECT dis=NONE) header.from=google.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S236579AbjHKPUp (ORCPT + 99 others); Fri, 11 Aug 2023 11:20:45 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:35896 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S236514AbjHKPUV (ORCPT ); Fri, 11 Aug 2023 11:20:21 -0400 Received: from mail-yw1-x1149.google.com (mail-yw1-x1149.google.com [IPv6:2607:f8b0:4864:20::1149]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 96FF830D0 for ; Fri, 11 Aug 2023 08:19:58 -0700 (PDT) Received: by mail-yw1-x1149.google.com with SMTP id 00721157ae682-589cd098d24so3055157b3.0 for ; Fri, 11 Aug 2023 08:19:58 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20221208; t=1691767198; x=1692371998; h=cc:to:from:subject:message-id:mime-version:date:from:to:cc:subject :date:message-id:reply-to; bh=1vaThr58cHhzt3vCJBdqBIs2Yl/3Z2jvMp4OgQvCHVc=; b=5xqJ+9vOp2nrO/mxnyBJ/b/1HWLsgBT1IHmI50RXMG+v00b5fp1vs2Rwd8BJ+9On+a Q4jl5SsKlofCJHbO3RpNFGWeldC2dgdOf7WiBs7B3msfJcvntjhupdIzPNHiuqPJVz+z R/HdlzmM4cQEmJpgDlmTthNmGG/KyvuF0gdplPRvM4udG74+d0udlvizD0YfOPv0Opv2 3tPbceoZMBOxCBuYZR9Iewa4BKkdIHfl4kSzyUUw34WMnBaidreMjrhu73PoE0V1Y3HY Lo9Pzzu3F/0G/X2jav91I9Oukq8tP4eQTMYHi0nGsMKpFT4HL5VWbyKeiy/SS6PBE/G+ bSHA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1691767198; x=1692371998; h=cc:to:from:subject:message-id:mime-version:date:x-gm-message-state :from:to:cc:subject:date:message-id:reply-to; bh=1vaThr58cHhzt3vCJBdqBIs2Yl/3Z2jvMp4OgQvCHVc=; b=VysIARep1U/R66pcKNpOEP+1QRb8dK412Uv6wrDEQOYmOCe5jkE26sP2Ba/TzseDrI YWKr69EV8KNkBW/BdSz6jJVmBVD9JaFJAOBfuKc/1rWsTZ56AV/P5dxZ9I+nQM7nSpeC WdnRvkXQBP40HdFyLpycLAOcqkbknhuVAepxwouxmWSvhGUkoko/yFrkGOrkbZXloa// eRTxJOVAOR/0TsBYYexOkHzQHbOAN/bjEjqFir7P6QsyDmHZ9psygwq7kS4oPjk3Uut4 tnYyETaKDCyZA20sCUmLTASMja9H27Kj/f2aUDUi8Zc49i6RNrzoiHbfCwiug9YcnOnK 9RYg== X-Gm-Message-State: AOJu0Yx8WWDuuHvX+0JFd0bm90Hsqv6Pcd4BYby+hrTX3mlKoCNIiG6b fipCebPym2HqfQN1ZqeViVKWT1HgPA== X-Received: from elver.muc.corp.google.com ([2a00:79e0:9c:201:8dc0:5176:6fda:46a0]) (user=elver job=sendgmr) by 2002:a81:451d:0:b0:589:9d51:c8c0 with SMTP id s29-20020a81451d000000b005899d51c8c0mr41482ywa.2.1691767197794; Fri, 11 Aug 2023 08:19:57 -0700 (PDT) Date: Fri, 11 Aug 2023 17:18:38 +0200 Mime-Version: 1.0 X-Mailer: git-send-email 2.41.0.694.ge786442a9b-goog Message-ID: <20230811151847.1594958-1-elver@google.com> Subject: [PATCH v4 1/4] compiler_types: Introduce the Clang __preserve_most function attribute From: Marco Elver To: elver@google.com, Andrew Morton , Kees Cook Cc: Guenter Roeck , Peter Zijlstra , Mark Rutland , Steven Rostedt , Marc Zyngier , Oliver Upton , James Morse , Suzuki K Poulose , Zenghui Yu , Catalin Marinas , Will Deacon , Arnd Bergmann , Greg Kroah-Hartman , Paul Moore , James Morris , "Serge E. Hallyn" , Nathan Chancellor , Nick Desaulniers , Tom Rix , Miguel Ojeda , Sami Tolvanen , linux-arm-kernel@lists.infradead.org, kvmarm@lists.linux.dev, linux-kernel@vger.kernel.org, linux-security-module@vger.kernel.org, llvm@lists.linux.dev, Dmitry Vyukov , Alexander Potapenko , kasan-dev@googlegroups.com, linux-toolchains@vger.kernel.org Content-Type: text/plain; charset="UTF-8" X-Spam-Status: No, score=-9.6 required=5.0 tests=BAYES_00,DKIMWL_WL_MED, DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF, RCVD_IN_DNSWL_BLOCKED,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED, USER_IN_DEF_DKIM_WL autolearn=unavailable autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org [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 https://github.com/ClangBuiltLinux/linux/issues/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 Reviewed-by: Miguel Ojeda Reviewed-by: Nick Desaulniers Acked-by: Steven Rostedt (Google) Acked-by: Mark Rutland --- v4: * Guard attribute based on known-supported architectures to avoid compiler warnings about the attribute being ignored. v3: * Quote more from LLVM documentation about which registers are callee/caller with preserve_most. * Code comment to restrict use where tracing is meant to be disabled. v2: * Imply notrace, to avoid any conflicts with tracing which is inserted on function entry. See added comments. --- include/linux/compiler_types.h | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/include/linux/compiler_types.h b/include/linux/compiler_types.h index 547ea1ff806e..c523c6683789 100644 --- a/include/linux/compiler_types.h +++ b/include/linux/compiler_types.h @@ -106,6 +106,34 @@ static inline void __chk_io_ptr(const volatile void __iomem *ptr) { } #define __cold #endif +/* + * On x86-64 and arm64 targets, __preserve_most changes the calling convention + * of a function 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 uses a different set of caller- and callee- + * saved registers. + * + * The purpose is to alleviates the burden of saving and recovering a large + * register set before and after the call in the caller. This is beneficial for + * rarely taken slow paths, such as error-reporting functions that may be called + * from hot paths. + * + * Note: This may conflict with instrumentation inserted on function entry which + * does not use __preserve_most or equivalent convention (if in assembly). Since + * function tracing assumes the normal C calling convention, where the attribute + * is supported, __preserve_most implies notrace. It is recommended to restrict + * use of the attribute to functions that should or already disable tracing. + * + * Optional: not supported by gcc. + * + * clang: https://clang.llvm.org/docs/AttributeReference.html#preserve-most + */ +#if __has_attribute(__preserve_most__) && (defined(CONFIG_X86_64) || defined(CONFIG_ARM64)) +# define __preserve_most notrace __attribute__((__preserve_most__)) +#else +# define __preserve_most +#endif + /* Builtins */ /* -- 2.41.0.694.ge786442a9b-goog