| //===-- AArch64SMEAttributes.h - Helper for interpreting SME attributes -*-===// | |
| // | |
| // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. | |
| // See https://llvm.org/LICENSE.txt for license information. | |
| // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception | |
| // | |
| //===----------------------------------------------------------------------===// | |
| #include "llvm/IR/Function.h" | |
| #ifndef LLVM_LIB_TARGET_AARCH64_UTILS_AARCH64SMEATTRIBUTES_H | |
| #define LLVM_LIB_TARGET_AARCH64_UTILS_AARCH64SMEATTRIBUTES_H | |
| namespace llvm { | |
| class Function; | |
| class CallBase; | |
| class AttributeList; | |
| /// SMEAttrs is a utility class to parse the SME ACLE attributes on functions. | |
| /// It helps determine a function's requirements for PSTATE.ZA and PSTATE.SM. It | |
| /// has interfaces to query whether a streaming mode change or lazy-save | |
| /// mechanism is required when going from one function to another (e.g. through | |
| /// a call). | |
| class SMEAttrs { | |
| unsigned Bitmask; | |
| public: | |
| // Enum with bitmasks for each individual SME feature. | |
| enum Mask { | |
| Normal = 0, | |
| SM_Enabled = 1 << 0, // aarch64_pstate_sm_enabled | |
| SM_Compatible = 1 << 1, // aarch64_pstate_sm_compatible | |
| SM_Body = 1 << 2, // aarch64_pstate_sm_locally | |
| ZA_Shared = 1 << 3, // aarch64_pstate_sm_shared | |
| ZA_New = 1 << 4, // aarch64_pstate_sm_new | |
| ZA_Preserved = 1 << 5, // aarch64_pstate_sm_preserved | |
| All = ZA_Preserved - 1 | |
| }; | |
| SMEAttrs(unsigned Mask = Normal) : Bitmask(0) { set(Mask); } | |
| SMEAttrs(const Function &F) : SMEAttrs(F.getAttributes()) {} | |
| SMEAttrs(const CallBase &CB); | |
| SMEAttrs(const AttributeList &L); | |
| void set(unsigned M, bool Enable = true); | |
| // Interfaces to query PSTATE.SM | |
| bool hasStreamingBody() const { return Bitmask & SM_Body; } | |
| bool hasStreamingInterface() const { return Bitmask & SM_Enabled; } | |
| bool hasStreamingInterfaceOrBody() const { | |
| return hasStreamingBody() || hasStreamingInterface(); | |
| } | |
| bool hasStreamingCompatibleInterface() const { | |
| return Bitmask & SM_Compatible; | |
| } | |
| bool hasNonStreamingInterface() const { | |
| return !hasStreamingInterface() && !hasStreamingCompatibleInterface(); | |
| } | |
| bool hasNonStreamingInterfaceAndBody() const { | |
| return hasNonStreamingInterface() && !hasStreamingBody(); | |
| } | |
| /// \return true if a call from Caller -> Callee requires a change in | |
| /// streaming mode. | |
| /// If \p BodyOverridesInterface is true and Callee has a streaming body, | |
| /// then requiresSMChange considers a call to Callee as having a Streaming | |
| /// interface. This can be useful when considering e.g. inlining, where we | |
| /// explicitly want the body to overrule the interface (because after inlining | |
| /// the interface is no longer relevant). | |
| std::optional<bool> | |
| requiresSMChange(const SMEAttrs &Callee, | |
| bool BodyOverridesInterface = false) const; | |
| // Interfaces to query PSTATE.ZA | |
| bool hasNewZAInterface() const { return Bitmask & ZA_New; } | |
| bool hasSharedZAInterface() const { return Bitmask & ZA_Shared; } | |
| bool hasPrivateZAInterface() const { return !hasSharedZAInterface(); } | |
| bool preservesZA() const { return Bitmask & ZA_Preserved; } | |
| bool hasZAState() const { | |
| return hasNewZAInterface() || hasSharedZAInterface(); | |
| } | |
| bool requiresLazySave(const SMEAttrs &Callee) const { | |
| return hasZAState() && Callee.hasPrivateZAInterface() && | |
| !Callee.preservesZA(); | |
| } | |
| }; | |
| } // namespace llvm | |
| #endif // LLVM_LIB_TARGET_AARCH64_UTILS_AARCH64SMEATTRIBUTES_H |