Attributes.h revision ad19d9c4228718b0ac167d0dfa013d14c3c9f135
1710632d07b13609444626367bebd34c0af3acb6aMikhail Glushenkov//===-- llvm/Attributes.h - Container for Attributes ------------*- C++ -*-===// 26091ebd172a16a10f1ea66061a5fa7cbf5139e56Reid Spencer// 36091ebd172a16a10f1ea66061a5fa7cbf5139e56Reid Spencer// The LLVM Compiler Infrastructure 46091ebd172a16a10f1ea66061a5fa7cbf5139e56Reid Spencer// 57ed47a13356daed2a34cd2209a31f92552e3bdd8Chris Lattner// This file is distributed under the University of Illinois Open Source 67ed47a13356daed2a34cd2209a31f92552e3bdd8Chris Lattner// License. See LICENSE.TXT for details. 76091ebd172a16a10f1ea66061a5fa7cbf5139e56Reid Spencer// 86091ebd172a16a10f1ea66061a5fa7cbf5139e56Reid Spencer//===----------------------------------------------------------------------===// 927107f6ab4627fa38bcacad6757ed6d52910f880Bill Wendling/// 1027107f6ab4627fa38bcacad6757ed6d52910f880Bill Wendling/// \file 1127107f6ab4627fa38bcacad6757ed6d52910f880Bill Wendling/// \brief This file contains the simple types necessary to represent the 1227107f6ab4627fa38bcacad6757ed6d52910f880Bill Wendling/// attributes associated with functions and their calls. 1327107f6ab4627fa38bcacad6757ed6d52910f880Bill Wendling/// 146091ebd172a16a10f1ea66061a5fa7cbf5139e56Reid Spencer//===----------------------------------------------------------------------===// 156091ebd172a16a10f1ea66061a5fa7cbf5139e56Reid Spencer 16674be02d525d4e24bc6943ed9274958c580bcfbcJakub Staszak#ifndef LLVM_IR_ATTRIBUTES_H 17674be02d525d4e24bc6943ed9274958c580bcfbcJakub Staszak#define LLVM_IR_ATTRIBUTES_H 186091ebd172a16a10f1ea66061a5fa7cbf5139e56Reid Spencer 19d509d0b532ec2358b3f341d4a4cd1411cb8b5db2Chris Lattner#include "llvm/ADT/ArrayRef.h" 200319888773b36dd61d7d2283cb9a26cac1e5abe8Bill Wendling#include "llvm/ADT/DenseSet.h" 213467e30edf63b6d8a8d446186674ba9e4b7885a9Bill Wendling#include "llvm/ADT/FoldingSet.h" 2222bd64173981bf1251c4b3bfc684207340534ba3Bill Wendling#include <cassert> 23ea59f896a672c2e1ef9f02277bce60257aa60989Bill Wendling#include <map> 2458d74910c6b82e622ecbb57d6644d48fec5a5c0fChris Lattner#include <string> 256091ebd172a16a10f1ea66061a5fa7cbf5139e56Reid Spencer 266091ebd172a16a10f1ea66061a5fa7cbf5139e56Reid Spencernamespace llvm { 27d426a642a23a234547cbc7061f5bfec157673249Bill Wendling 28702cc91aa1bd41540e8674921ae7ac89a4ff061fBill Wendlingclass AttrBuilder; 29f6670729aabc1fab85238d2b306a1c1767a807bbBill Wendlingclass AttributeImpl; 30817abdd8b055059e5930a15704b9f52da4236456Bill Wendlingclass AttributeSetImpl; 31817abdd8b055059e5930a15704b9f52da4236456Bill Wendlingclass AttributeSetNode; 326dc3781d44e56f0addf28b06232a50f3f9e6b1afBill Wendlingclass Constant; 332c79ecbd704c656178ffa43d5a58ebe3ca188b40Bill Wendlingclass LLVMContext; 34ad9a9e15595bc9d5ba1ed752caf8572957f77a3dDuncan Sandsclass Type; 35ad9a9e15595bc9d5ba1ed752caf8572957f77a3dDuncan Sands 361d3dcfe4246b4d45fa78a8dfd0a11c7fff842c15Bill Wendling//===----------------------------------------------------------------------===// 3727107f6ab4627fa38bcacad6757ed6d52910f880Bill Wendling/// \class 3827107f6ab4627fa38bcacad6757ed6d52910f880Bill Wendling/// \brief Functions, function parameters, and return types can have attributes 391d3dcfe4246b4d45fa78a8dfd0a11c7fff842c15Bill Wendling/// to indicate how they should be treated by optimizations and code 401d3dcfe4246b4d45fa78a8dfd0a11c7fff842c15Bill Wendling/// generation. This class represents one of those attributes. It's light-weight 411d3dcfe4246b4d45fa78a8dfd0a11c7fff842c15Bill Wendling/// and should be passed around by-value. 42034b94b17006f51722886b0f2283fb6fb19aca1fBill Wendlingclass Attribute { 436765834754cbb3cb0f15b4b15e98c5e73fa50066Bill Wendlingpublic: 441d3dcfe4246b4d45fa78a8dfd0a11c7fff842c15Bill Wendling /// This enumeration lists the attributes that can be associated with 4573dee180c836270644dfa7d90f9c5ba877567999Bill Wendling /// parameters, function results, or the function itself. 46f3d1500ab2c7364d3d0fb73a7e1b8c6339ab48b1Bill Wendling /// 4773dee180c836270644dfa7d90f9c5ba877567999Bill Wendling /// Note: The `uwtable' attribute is about the ABI or the user mandating an 4873dee180c836270644dfa7d90f9c5ba877567999Bill Wendling /// entry in the unwind table. The `nounwind' attribute is about an exception 4973dee180c836270644dfa7d90f9c5ba877567999Bill Wendling /// passing by the function. 50f3d1500ab2c7364d3d0fb73a7e1b8c6339ab48b1Bill Wendling /// 5173dee180c836270644dfa7d90f9c5ba877567999Bill Wendling /// In a theoretical system that uses tables for profiling and SjLj for 5211d00420e42ba88c3b48cab997965a7be79315e2Bill Wendling /// exceptions, they would be fully independent. In a normal system that uses 5311d00420e42ba88c3b48cab997965a7be79315e2Bill Wendling /// tables for both, the semantics are: 54f3d1500ab2c7364d3d0fb73a7e1b8c6339ab48b1Bill Wendling /// 5511d00420e42ba88c3b48cab997965a7be79315e2Bill Wendling /// nil = Needs an entry because an exception might pass by. 5611d00420e42ba88c3b48cab997965a7be79315e2Bill Wendling /// nounwind = No need for an entry 5711d00420e42ba88c3b48cab997965a7be79315e2Bill Wendling /// uwtable = Needs an entry because the ABI says so and because 5811d00420e42ba88c3b48cab997965a7be79315e2Bill Wendling /// an exception might pass by. 5911d00420e42ba88c3b48cab997965a7be79315e2Bill Wendling /// uwtable + nounwind = Needs an entry because the ABI says so. 6011d00420e42ba88c3b48cab997965a7be79315e2Bill Wendling 61629fb82419d9bfff6ae475363bcce66192dfcc8eBill Wendling enum AttrKind { 625a0eeb5a9d727940b1dbe8dff6e9aa292ada0f6aBill Wendling // IR-Level Attributes 63480b1b28ea6fc1bb5c78d99472df624cfd3fce47Bill Wendling None, ///< No attributes have been set 64480b1b28ea6fc1bb5c78d99472df624cfd3fce47Bill Wendling AddressSafety, ///< Address safety checking is on. 65480b1b28ea6fc1bb5c78d99472df624cfd3fce47Bill Wendling Alignment, ///< Alignment of parameter (5 bits) 666765834754cbb3cb0f15b4b15e98c5e73fa50066Bill Wendling ///< stored as log2 of alignment with +1 bias 67f6670729aabc1fab85238d2b306a1c1767a807bbBill Wendling ///< 0 means unaligned (different from align(1)) 68480b1b28ea6fc1bb5c78d99472df624cfd3fce47Bill Wendling AlwaysInline, ///< inline=always 69480b1b28ea6fc1bb5c78d99472df624cfd3fce47Bill Wendling ByVal, ///< Pass structure by value 70480b1b28ea6fc1bb5c78d99472df624cfd3fce47Bill Wendling InlineHint, ///< Source said inlining was desirable 71480b1b28ea6fc1bb5c78d99472df624cfd3fce47Bill Wendling InReg, ///< Force argument to be passed in register 729a419f656e278b96e9dfe739cd63c7bff9a4e1fdQuentin Colombet MinSize, ///< Function must be optimized for size first 73480b1b28ea6fc1bb5c78d99472df624cfd3fce47Bill Wendling Naked, ///< Naked function 74480b1b28ea6fc1bb5c78d99472df624cfd3fce47Bill Wendling Nest, ///< Nested function static chain 75480b1b28ea6fc1bb5c78d99472df624cfd3fce47Bill Wendling NoAlias, ///< Considered to not alias after call 76480b1b28ea6fc1bb5c78d99472df624cfd3fce47Bill Wendling NoCapture, ///< Function creates no aliases of pointer 7767ae13575900e8efd056672987249fd0adbf5e73James Molloy NoDuplicate, ///< Call cannot be duplicated 78480b1b28ea6fc1bb5c78d99472df624cfd3fce47Bill Wendling NoImplicitFloat, ///< Disable implicit floating point insts 79480b1b28ea6fc1bb5c78d99472df624cfd3fce47Bill Wendling NoInline, ///< inline=never 80480b1b28ea6fc1bb5c78d99472df624cfd3fce47Bill Wendling NonLazyBind, ///< Function is called early and/or 813a106e60366a51b4594ec303ff8dbbc58913227fBill Wendling ///< often, so lazy binding isn't worthwhile 82480b1b28ea6fc1bb5c78d99472df624cfd3fce47Bill Wendling NoRedZone, ///< Disable redzone 83480b1b28ea6fc1bb5c78d99472df624cfd3fce47Bill Wendling NoReturn, ///< Mark the function as not returning 84480b1b28ea6fc1bb5c78d99472df624cfd3fce47Bill Wendling NoUnwind, ///< Function doesn't unwind stack 85480b1b28ea6fc1bb5c78d99472df624cfd3fce47Bill Wendling OptimizeForSize, ///< opt_size 86480b1b28ea6fc1bb5c78d99472df624cfd3fce47Bill Wendling ReadNone, ///< Function does not access memory 87480b1b28ea6fc1bb5c78d99472df624cfd3fce47Bill Wendling ReadOnly, ///< Function only reads from memory 88480b1b28ea6fc1bb5c78d99472df624cfd3fce47Bill Wendling ReturnsTwice, ///< Function can return twice 89480b1b28ea6fc1bb5c78d99472df624cfd3fce47Bill Wendling SExt, ///< Sign extended before/after call 90480b1b28ea6fc1bb5c78d99472df624cfd3fce47Bill Wendling StackAlignment, ///< Alignment of stack for function (3 bits) 916765834754cbb3cb0f15b4b15e98c5e73fa50066Bill Wendling ///< stored as log2 of alignment with +1 bias 0 926765834754cbb3cb0f15b4b15e98c5e73fa50066Bill Wendling ///< means unaligned (different from 93f6670729aabc1fab85238d2b306a1c1767a807bbBill Wendling ///< alignstack=(1)) 94480b1b28ea6fc1bb5c78d99472df624cfd3fce47Bill Wendling StackProtect, ///< Stack protection. 95480b1b28ea6fc1bb5c78d99472df624cfd3fce47Bill Wendling StackProtectReq, ///< Stack protection required. 96114baee1fa017daefad2339c77b45b9ca3d79a41Bill Wendling StackProtectStrong, ///< Strong Stack protection. 97480b1b28ea6fc1bb5c78d99472df624cfd3fce47Bill Wendling StructRet, ///< Hidden pointer to structure to return 98ab39afa9d9b99c61842c8e3d0eb706bd16efdcf3Kostya Serebryany ThreadSafety, ///< Thread safety checking is on. 99ab39afa9d9b99c61842c8e3d0eb706bd16efdcf3Kostya Serebryany UninitializedChecks, ///< Checking for uses of uninitialized memory is on. 100480b1b28ea6fc1bb5c78d99472df624cfd3fce47Bill Wendling UWTable, ///< Function must be in a unwind table 1010319888773b36dd61d7d2283cb9a26cac1e5abe8Bill Wendling ZExt, ///< Zero extended before/after call 1020319888773b36dd61d7d2283cb9a26cac1e5abe8Bill Wendling 1033a4779a9211281a1d0c27c97037342329035a185NAKAMURA Takumi EndAttrKinds, ///< Sentinal value useful for loops 1043a4779a9211281a1d0c27c97037342329035a185NAKAMURA Takumi 1056f78fbbc630d2b86fb752574f5ad74473f57dfb1Chandler Carruth AttrKindEmptyKey, ///< Empty key value for DenseMapInfo 1066f78fbbc630d2b86fb752574f5ad74473f57dfb1Chandler Carruth AttrKindTombstoneKey ///< Tombstone key value for DenseMapInfo 1076765834754cbb3cb0f15b4b15e98c5e73fa50066Bill Wendling }; 1086765834754cbb3cb0f15b4b15e98c5e73fa50066Bill Wendlingprivate: 10927107f6ab4627fa38bcacad6757ed6d52910f880Bill Wendling AttributeImpl *pImpl; 11027107f6ab4627fa38bcacad6757ed6d52910f880Bill Wendling Attribute(AttributeImpl *A) : pImpl(A) {} 111d426a642a23a234547cbc7061f5bfec157673249Bill Wendlingpublic: 11227107f6ab4627fa38bcacad6757ed6d52910f880Bill Wendling Attribute() : pImpl(0) {} 1132c79ecbd704c656178ffa43d5a58ebe3ca188b40Bill Wendling 114c22f4aa886443507f8406d30d118fdeeac6a8c6cBill Wendling //===--------------------------------------------------------------------===// 115c22f4aa886443507f8406d30d118fdeeac6a8c6cBill Wendling // Attribute Construction 116c22f4aa886443507f8406d30d118fdeeac6a8c6cBill Wendling //===--------------------------------------------------------------------===// 117c22f4aa886443507f8406d30d118fdeeac6a8c6cBill Wendling 118c08a5ef6581f2c7550e92d31f63cd65ec29c39e0Bill Wendling /// \brief Return a uniquified Attribute object. 1198c74ecfbddabe89e150abff4fdff0a27108874b9Bill Wendling static Attribute get(LLVMContext &Context, AttrKind Kind, uint64_t Val = 0); 1208c74ecfbddabe89e150abff4fdff0a27108874b9Bill Wendling static Attribute get(LLVMContext &Context, StringRef Kind, 1218c74ecfbddabe89e150abff4fdff0a27108874b9Bill Wendling StringRef Val = StringRef()); 1222c79ecbd704c656178ffa43d5a58ebe3ca188b40Bill Wendling 123c08a5ef6581f2c7550e92d31f63cd65ec29c39e0Bill Wendling /// \brief Return a uniquified Attribute object that has the specific 124c08a5ef6581f2c7550e92d31f63cd65ec29c39e0Bill Wendling /// alignment set. 125c08a5ef6581f2c7550e92d31f63cd65ec29c39e0Bill Wendling static Attribute getWithAlignment(LLVMContext &Context, uint64_t Align); 126c08a5ef6581f2c7550e92d31f63cd65ec29c39e0Bill Wendling static Attribute getWithStackAlignment(LLVMContext &Context, uint64_t Align); 127c08a5ef6581f2c7550e92d31f63cd65ec29c39e0Bill Wendling 128c22f4aa886443507f8406d30d118fdeeac6a8c6cBill Wendling //===--------------------------------------------------------------------===// 129c22f4aa886443507f8406d30d118fdeeac6a8c6cBill Wendling // Attribute Accessors 130c22f4aa886443507f8406d30d118fdeeac6a8c6cBill Wendling //===--------------------------------------------------------------------===// 131c22f4aa886443507f8406d30d118fdeeac6a8c6cBill Wendling 1328c74ecfbddabe89e150abff4fdff0a27108874b9Bill Wendling /// \brief Return true if the attribute is an Attribute::AttrKind type. 1338c74ecfbddabe89e150abff4fdff0a27108874b9Bill Wendling bool isEnumAttribute() const; 1348c74ecfbddabe89e150abff4fdff0a27108874b9Bill Wendling 1358c74ecfbddabe89e150abff4fdff0a27108874b9Bill Wendling /// \brief Return true if the attribute is an alignment attribute. 1368c74ecfbddabe89e150abff4fdff0a27108874b9Bill Wendling bool isAlignAttribute() const; 1378c74ecfbddabe89e150abff4fdff0a27108874b9Bill Wendling 1388c74ecfbddabe89e150abff4fdff0a27108874b9Bill Wendling /// \brief Return true if the attribute is a string (target-dependent) 1398c74ecfbddabe89e150abff4fdff0a27108874b9Bill Wendling /// attribute. 1408c74ecfbddabe89e150abff4fdff0a27108874b9Bill Wendling bool isStringAttribute() const; 1418c74ecfbddabe89e150abff4fdff0a27108874b9Bill Wendling 142eddab1550ee10cce3bb26a26e88529cb19451aa3NAKAMURA Takumi /// \brief Return true if the attribute is present. 143eddab1550ee10cce3bb26a26e88529cb19451aa3NAKAMURA Takumi bool hasAttribute(AttrKind Val) const; 144eddab1550ee10cce3bb26a26e88529cb19451aa3NAKAMURA Takumi 14564754f499058b5dc748ea6d06a084af0ed539ec4Bill Wendling /// \brief Return true if the target-dependent attribute is present. 14664754f499058b5dc748ea6d06a084af0ed539ec4Bill Wendling bool hasAttribute(StringRef Val) const; 14764754f499058b5dc748ea6d06a084af0ed539ec4Bill Wendling 1488c74ecfbddabe89e150abff4fdff0a27108874b9Bill Wendling /// \brief Return the attribute's kind as an enum (Attribute::AttrKind). This 1498c74ecfbddabe89e150abff4fdff0a27108874b9Bill Wendling /// requires the attribute to be an enum or alignment attribute. 1508c74ecfbddabe89e150abff4fdff0a27108874b9Bill Wendling Attribute::AttrKind getKindAsEnum() const; 1516dc3781d44e56f0addf28b06232a50f3f9e6b1afBill Wendling 1528c74ecfbddabe89e150abff4fdff0a27108874b9Bill Wendling /// \brief Return the attribute's value as an integer. This requires that the 1538c74ecfbddabe89e150abff4fdff0a27108874b9Bill Wendling /// attribute be an alignment attribute. 1548c74ecfbddabe89e150abff4fdff0a27108874b9Bill Wendling uint64_t getValueAsInt() const; 1558c74ecfbddabe89e150abff4fdff0a27108874b9Bill Wendling 1568c74ecfbddabe89e150abff4fdff0a27108874b9Bill Wendling /// \brief Return the attribute's kind as a string. This requires the 1578c74ecfbddabe89e150abff4fdff0a27108874b9Bill Wendling /// attribute to be a string attribute. 1588c74ecfbddabe89e150abff4fdff0a27108874b9Bill Wendling StringRef getKindAsString() const; 1598c74ecfbddabe89e150abff4fdff0a27108874b9Bill Wendling 1608c74ecfbddabe89e150abff4fdff0a27108874b9Bill Wendling /// \brief Return the attribute's value as a string. This requires the 1618c74ecfbddabe89e150abff4fdff0a27108874b9Bill Wendling /// attribute to be a string attribute. 1628c74ecfbddabe89e150abff4fdff0a27108874b9Bill Wendling StringRef getValueAsString() const; 1636dc3781d44e56f0addf28b06232a50f3f9e6b1afBill Wendling 1641d3dcfe4246b4d45fa78a8dfd0a11c7fff842c15Bill Wendling /// \brief Returns the alignment field of an attribute as a byte alignment 165ef99fe8efaa6cb74c66e570a6ef467debca92911Bill Wendling /// value. 166e66f3d3ba0ea9f82f65a29c47fc37e997cbf0aceBill Wendling unsigned getAlignment() const; 167ef99fe8efaa6cb74c66e570a6ef467debca92911Bill Wendling 1681d3dcfe4246b4d45fa78a8dfd0a11c7fff842c15Bill Wendling /// \brief Returns the stack alignment field of an attribute as a byte 169943c29135e03e55f9a5dab393786171a4a536482Bill Wendling /// alignment value. 170e66f3d3ba0ea9f82f65a29c47fc37e997cbf0aceBill Wendling unsigned getStackAlignment() const; 17130b483c94001927b3593ed200e823104bab51660Bill Wendling 172c22f4aa886443507f8406d30d118fdeeac6a8c6cBill Wendling /// \brief The Attribute is converted to a string of equivalent mnemonic. This 173c22f4aa886443507f8406d30d118fdeeac6a8c6cBill Wendling /// is, presumably, for writing out the mnemonics for the assembly writer. 174b29ce26ea60f7516c853318ffbfc107fde9ad897Bill Wendling std::string getAsString(bool InAttrGrp = false) const; 175c22f4aa886443507f8406d30d118fdeeac6a8c6cBill Wendling 1768c74ecfbddabe89e150abff4fdff0a27108874b9Bill Wendling /// \brief Equality and non-equality operators. 1772d5be6c313c0f9e23e56620fa8f8ae8d9b539bf0Bill Wendling bool operator==(Attribute A) const { return pImpl == A.pImpl; } 1782d5be6c313c0f9e23e56620fa8f8ae8d9b539bf0Bill Wendling bool operator!=(Attribute A) const { return pImpl != A.pImpl; } 1792d5be6c313c0f9e23e56620fa8f8ae8d9b539bf0Bill Wendling 180c08a5ef6581f2c7550e92d31f63cd65ec29c39e0Bill Wendling /// \brief Less-than operator. Useful for sorting the attributes list. 1813467e30edf63b6d8a8d446186674ba9e4b7885a9Bill Wendling bool operator<(Attribute A) const; 1823467e30edf63b6d8a8d446186674ba9e4b7885a9Bill Wendling 183bb08593980b16fbd9758da6ca4fa9c7964f2f926Bill Wendling void Profile(FoldingSetNodeID &ID) const { 184bb08593980b16fbd9758da6ca4fa9c7964f2f926Bill Wendling ID.AddPointer(pImpl); 185bb08593980b16fbd9758da6ca4fa9c7964f2f926Bill Wendling } 186827cde1c8319e51463007078a7ce3660ebc93036Duncan Sands}; 187827cde1c8319e51463007078a7ce3660ebc93036Duncan Sands 188e66f3d3ba0ea9f82f65a29c47fc37e997cbf0aceBill Wendling//===----------------------------------------------------------------------===// 18927107f6ab4627fa38bcacad6757ed6d52910f880Bill Wendling/// \class 19016274258d16342a2f91aaa3690b78ce74e4105f1Bill Wendling/// \brief Provide DenseMapInfo for Attribute::AttrKinds. This is used by 19116274258d16342a2f91aaa3690b78ce74e4105f1Bill Wendling/// AttrBuilder. 19216274258d16342a2f91aaa3690b78ce74e4105f1Bill Wendlingtemplate<> struct DenseMapInfo<Attribute::AttrKind> { 19316274258d16342a2f91aaa3690b78ce74e4105f1Bill Wendling static inline Attribute::AttrKind getEmptyKey() { 19416274258d16342a2f91aaa3690b78ce74e4105f1Bill Wendling return Attribute::AttrKindEmptyKey; 19516274258d16342a2f91aaa3690b78ce74e4105f1Bill Wendling } 19616274258d16342a2f91aaa3690b78ce74e4105f1Bill Wendling static inline Attribute::AttrKind getTombstoneKey() { 19716274258d16342a2f91aaa3690b78ce74e4105f1Bill Wendling return Attribute::AttrKindTombstoneKey; 19816274258d16342a2f91aaa3690b78ce74e4105f1Bill Wendling } 19916274258d16342a2f91aaa3690b78ce74e4105f1Bill Wendling static unsigned getHashValue(const Attribute::AttrKind &Val) { 20016274258d16342a2f91aaa3690b78ce74e4105f1Bill Wendling return Val * 37U; 20116274258d16342a2f91aaa3690b78ce74e4105f1Bill Wendling } 20216274258d16342a2f91aaa3690b78ce74e4105f1Bill Wendling static bool isEqual(const Attribute::AttrKind &LHS, 20316274258d16342a2f91aaa3690b78ce74e4105f1Bill Wendling const Attribute::AttrKind &RHS) { 20416274258d16342a2f91aaa3690b78ce74e4105f1Bill Wendling return LHS == RHS; 20516274258d16342a2f91aaa3690b78ce74e4105f1Bill Wendling } 20616274258d16342a2f91aaa3690b78ce74e4105f1Bill Wendling}; 20716274258d16342a2f91aaa3690b78ce74e4105f1Bill Wendling 20816274258d16342a2f91aaa3690b78ce74e4105f1Bill Wendling//===----------------------------------------------------------------------===// 20916274258d16342a2f91aaa3690b78ce74e4105f1Bill Wendling/// \class 210c3662eeaa4a1a4061fc6d5c81e3eed48c5d9da26Bill Wendling/// \brief This class holds the attributes for a function, its return value, and 211c3662eeaa4a1a4061fc6d5c81e3eed48c5d9da26Bill Wendling/// its parameters. You access the attributes for each of them via an index into 212c3662eeaa4a1a4061fc6d5c81e3eed48c5d9da26Bill Wendling/// the AttributeSet object. The function attributes are at index 213c3662eeaa4a1a4061fc6d5c81e3eed48c5d9da26Bill Wendling/// `AttributeSet::FunctionIndex', the return value is at index 214c3662eeaa4a1a4061fc6d5c81e3eed48c5d9da26Bill Wendling/// `AttributeSet::ReturnIndex', and the attributes for the parameters start at 215c3662eeaa4a1a4061fc6d5c81e3eed48c5d9da26Bill Wendling/// index `1'. 21699faa3b4ec6d03ac7808fe4ff3fbf3d04e375502Bill Wendlingclass AttributeSet { 21707aae2e7d58fe23e370e0cbb9e1a3def99434c36Bill Wendlingpublic: 21807aae2e7d58fe23e370e0cbb9e1a3def99434c36Bill Wendling enum AttrIndex { 21907aae2e7d58fe23e370e0cbb9e1a3def99434c36Bill Wendling ReturnIndex = 0U, 22007aae2e7d58fe23e370e0cbb9e1a3def99434c36Bill Wendling FunctionIndex = ~0U 22107aae2e7d58fe23e370e0cbb9e1a3def99434c36Bill Wendling }; 22207aae2e7d58fe23e370e0cbb9e1a3def99434c36Bill Wendlingprivate: 223a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling friend class AttrBuilder; 2247d38c109aab8654e63e9071c7d948661f6b58433Bill Wendling friend class AttributeSetImpl; 22516274258d16342a2f91aaa3690b78ce74e4105f1Bill Wendling template <typename Ty> friend struct DenseMapInfo; 226a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling 22773dee180c836270644dfa7d90f9c5ba877567999Bill Wendling /// \brief The attributes that we are managing. This can be null to represent 2280976e00fd1cbf4128daeb72efd8957d00383fda9Bill Wendling /// the empty attributes list. 229ec2589863b32da169240c4fa120ef1e3798615d4Bill Wendling AttributeSetImpl *pImpl; 2300976e00fd1cbf4128daeb72efd8957d00383fda9Bill Wendling 23173dee180c836270644dfa7d90f9c5ba877567999Bill Wendling /// \brief The attributes for the specified index are returned. 232606c8e36dfdd28fc589356addd3e2cbb89a32e4dBill Wendling AttributeSetNode *getAttributes(unsigned Idx) const; 2330976e00fd1cbf4128daeb72efd8957d00383fda9Bill Wendling 23487e10dfefa94f77937c37b0eb51095540d675cbcBill Wendling /// \brief Create an AttributeSet with the specified parameters in it. 23587e10dfefa94f77937c37b0eb51095540d675cbcBill Wendling static AttributeSet get(LLVMContext &C, 2366bdbf061c353295669b6bfc271b948158602d1bcBill Wendling ArrayRef<std::pair<unsigned, Attribute> > Attrs); 23787e10dfefa94f77937c37b0eb51095540d675cbcBill Wendling static AttributeSet get(LLVMContext &C, 2386bdbf061c353295669b6bfc271b948158602d1bcBill Wendling ArrayRef<std::pair<unsigned, 23987e10dfefa94f77937c37b0eb51095540d675cbcBill Wendling AttributeSetNode*> > Attrs); 24087e10dfefa94f77937c37b0eb51095540d675cbcBill Wendling 24187e10dfefa94f77937c37b0eb51095540d675cbcBill Wendling static AttributeSet getImpl(LLVMContext &C, 2426bdbf061c353295669b6bfc271b948158602d1bcBill Wendling ArrayRef<std::pair<unsigned, 24387e10dfefa94f77937c37b0eb51095540d675cbcBill Wendling AttributeSetNode*> > Attrs); 24487e10dfefa94f77937c37b0eb51095540d675cbcBill Wendling 2457d38c109aab8654e63e9071c7d948661f6b58433Bill Wendling 246ec2589863b32da169240c4fa120ef1e3798615d4Bill Wendling explicit AttributeSet(AttributeSetImpl *LI) : pImpl(LI) {} 24758d74910c6b82e622ecbb57d6644d48fec5a5c0fChris Lattnerpublic: 248ec2589863b32da169240c4fa120ef1e3798615d4Bill Wendling AttributeSet() : pImpl(0) {} 249ec2589863b32da169240c4fa120ef1e3798615d4Bill Wendling AttributeSet(const AttributeSet &P) : pImpl(P.pImpl) {} 250d05204aea4977eaec25e96bc7605a7bb9d806fc0Bill Wendling const AttributeSet &operator=(const AttributeSet &RHS) { 251d05204aea4977eaec25e96bc7605a7bb9d806fc0Bill Wendling pImpl = RHS.pImpl; 252d05204aea4977eaec25e96bc7605a7bb9d806fc0Bill Wendling return *this; 253d05204aea4977eaec25e96bc7605a7bb9d806fc0Bill Wendling } 254710632d07b13609444626367bebd34c0af3acb6aMikhail Glushenkov 25558d74910c6b82e622ecbb57d6644d48fec5a5c0fChris Lattner //===--------------------------------------------------------------------===// 256c22f4aa886443507f8406d30d118fdeeac6a8c6cBill Wendling // AttributeSet Construction and Mutation 25758d74910c6b82e622ecbb57d6644d48fec5a5c0fChris Lattner //===--------------------------------------------------------------------===// 258710632d07b13609444626367bebd34c0af3acb6aMikhail Glushenkov 25918e7211068c9d2c6204512f9c468ee179818a4b6Bill Wendling /// \brief Return an AttributeSet with the specified parameters in it. 2608e47daf2858e980210f3e1f007036b24da342c29Bill Wendling static AttributeSet get(LLVMContext &C, ArrayRef<AttributeSet> Attrs); 26128d65722d6f283b327b5815914382077fe9c0ab4Bill Wendling static AttributeSet get(LLVMContext &C, unsigned Idx, 26232a57958226e369f964a034da2ce7083a1a34297Bill Wendling ArrayRef<Attribute::AttrKind> Kind); 2631bbd644301ed4d8a7efd4ceb15f71c56fa914f28Bill Wendling static AttributeSet get(LLVMContext &C, unsigned Idx, AttrBuilder &B); 26458d74910c6b82e622ecbb57d6644d48fec5a5c0fChris Lattner 265defaca00b8087d452df2b783250a48a32658a910Bill Wendling /// \brief Add an attribute to the attribute set at the given index. Since 266defaca00b8087d452df2b783250a48a32658a910Bill Wendling /// attribute sets are immutable, this returns a new set. 267defaca00b8087d452df2b783250a48a32658a910Bill Wendling AttributeSet addAttribute(LLVMContext &C, unsigned Idx, 268defaca00b8087d452df2b783250a48a32658a910Bill Wendling Attribute::AttrKind Attr) const; 269710632d07b13609444626367bebd34c0af3acb6aMikhail Glushenkov 270e4e85f17564c28cd571dda30146c3f310521acf0Bill Wendling /// \brief Add attributes to the attribute set at the given index. Since 271e4e85f17564c28cd571dda30146c3f310521acf0Bill Wendling /// attribute sets are immutable, this returns a new set. 272e4e85f17564c28cd571dda30146c3f310521acf0Bill Wendling AttributeSet addAttributes(LLVMContext &C, unsigned Idx, 273e4e85f17564c28cd571dda30146c3f310521acf0Bill Wendling AttributeSet Attrs) const; 274e4e85f17564c28cd571dda30146c3f310521acf0Bill Wendling 27518e7211068c9d2c6204512f9c468ee179818a4b6Bill Wendling /// \brief Remove the specified attribute at the specified index from this 2768246df61f6de716acf1f8c64fac3c19970a2c174Bill Wendling /// attribute list. Since attribute lists are immutable, this returns the new 27718e7211068c9d2c6204512f9c468ee179818a4b6Bill Wendling /// list. 2788246df61f6de716acf1f8c64fac3c19970a2c174Bill Wendling AttributeSet removeAttribute(LLVMContext &C, unsigned Idx, 2798246df61f6de716acf1f8c64fac3c19970a2c174Bill Wendling Attribute::AttrKind Attr) const; 2808246df61f6de716acf1f8c64fac3c19970a2c174Bill Wendling 2818246df61f6de716acf1f8c64fac3c19970a2c174Bill Wendling /// \brief Remove the specified attributes at the specified index from this 2828246df61f6de716acf1f8c64fac3c19970a2c174Bill Wendling /// attribute list. Since attribute lists are immutable, this returns the new 2838246df61f6de716acf1f8c64fac3c19970a2c174Bill Wendling /// list. 2848246df61f6de716acf1f8c64fac3c19970a2c174Bill Wendling AttributeSet removeAttributes(LLVMContext &C, unsigned Idx, 2858246df61f6de716acf1f8c64fac3c19970a2c174Bill Wendling AttributeSet Attrs) const; 286710632d07b13609444626367bebd34c0af3acb6aMikhail Glushenkov 28758d74910c6b82e622ecbb57d6644d48fec5a5c0fChris Lattner //===--------------------------------------------------------------------===// 288c22f4aa886443507f8406d30d118fdeeac6a8c6cBill Wendling // AttributeSet Accessors 28958d74910c6b82e622ecbb57d6644d48fec5a5c0fChris Lattner //===--------------------------------------------------------------------===// 29018e7211068c9d2c6204512f9c468ee179818a4b6Bill Wendling 29185b3fbecdfe934ac7519a8831c4bd262cba99d12Bill Wendling /// \brief Retrieve the LLVM context. 29285b3fbecdfe934ac7519a8831c4bd262cba99d12Bill Wendling LLVMContext &getContext() const; 29385b3fbecdfe934ac7519a8831c4bd262cba99d12Bill Wendling 29418e7211068c9d2c6204512f9c468ee179818a4b6Bill Wendling /// \brief The attributes for the specified index are returned. 29528d65722d6f283b327b5815914382077fe9c0ab4Bill Wendling AttributeSet getParamAttributes(unsigned Idx) const; 29619c874638d9478a5d5028854817a5ee72293bb2bDevang Patel 29718e7211068c9d2c6204512f9c468ee179818a4b6Bill Wendling /// \brief The attributes for the ret value are returned. 2983fc4b96b503fa202411317684a2ba02e41e43072Bill Wendling AttributeSet getRetAttributes() const; 29919c874638d9478a5d5028854817a5ee72293bb2bDevang Patel 30018e7211068c9d2c6204512f9c468ee179818a4b6Bill Wendling /// \brief The function attributes are returned. 301c5f1bc88a2eb7ad9ff924ca90cf88494e5f947b9Bill Wendling AttributeSet getFnAttributes() const; 302710632d07b13609444626367bebd34c0af3acb6aMikhail Glushenkov 303831737d329a727f53a1fb0572f7b7a8127208881Bill Wendling /// \brief Return true if the attribute exists at the given index. 30419d815c04fde6b7b53c2b542813157edfa213842Bill Wendling bool hasAttribute(unsigned Index, Attribute::AttrKind Kind) const; 305831737d329a727f53a1fb0572f7b7a8127208881Bill Wendling 306831737d329a727f53a1fb0572f7b7a8127208881Bill Wendling /// \brief Return true if attribute exists at the given index. 30719d815c04fde6b7b53c2b542813157edfa213842Bill Wendling bool hasAttributes(unsigned Index) const; 308831737d329a727f53a1fb0572f7b7a8127208881Bill Wendling 309c22f4aa886443507f8406d30d118fdeeac6a8c6cBill Wendling /// \brief Return true if the specified attribute is set for at least one 310c22f4aa886443507f8406d30d118fdeeac6a8c6cBill Wendling /// parameter or for the return value. 311c22f4aa886443507f8406d30d118fdeeac6a8c6cBill Wendling bool hasAttrSomewhere(Attribute::AttrKind Attr) const; 312c22f4aa886443507f8406d30d118fdeeac6a8c6cBill Wendling 31349f6060f16aec4024d644a6ec4ddd3de9b3e8821Bill Wendling /// \brief Return the alignment for the specified function parameter. 31419d815c04fde6b7b53c2b542813157edfa213842Bill Wendling unsigned getParamAlignment(unsigned Idx) const; 3158e47daf2858e980210f3e1f007036b24da342c29Bill Wendling 316831737d329a727f53a1fb0572f7b7a8127208881Bill Wendling /// \brief Get the stack alignment. 31719d815c04fde6b7b53c2b542813157edfa213842Bill Wendling unsigned getStackAlignment(unsigned Index) const; 318831737d329a727f53a1fb0572f7b7a8127208881Bill Wendling 319831737d329a727f53a1fb0572f7b7a8127208881Bill Wendling /// \brief Return the attributes at the index as a string. 320b29ce26ea60f7516c853318ffbfc107fde9ad897Bill Wendling std::string getAsString(unsigned Index, bool InAttrGrp = false) const; 321831737d329a727f53a1fb0572f7b7a8127208881Bill Wendling 32216c4b3cf2943ae2327752cf3de39769d14cfceceBill Wendling typedef ArrayRef<Attribute>::iterator iterator; 32316c4b3cf2943ae2327752cf3de39769d14cfceceBill Wendling 324f715dbd263149efeb9c684dfdb0637cf84f94399Bill Wendling iterator begin(unsigned Idx) const; 325f715dbd263149efeb9c684dfdb0637cf84f94399Bill Wendling iterator end(unsigned Idx) const; 32616c4b3cf2943ae2327752cf3de39769d14cfceceBill Wendling 327041221c0972ff575b07f76808c504833d629ae1fChris Lattner /// operator==/!= - Provide equality predicates. 32818e7211068c9d2c6204512f9c468ee179818a4b6Bill Wendling bool operator==(const AttributeSet &RHS) const { 329ec2589863b32da169240c4fa120ef1e3798615d4Bill Wendling return pImpl == RHS.pImpl; 33018e7211068c9d2c6204512f9c468ee179818a4b6Bill Wendling } 33118e7211068c9d2c6204512f9c468ee179818a4b6Bill Wendling bool operator!=(const AttributeSet &RHS) const { 332ec2589863b32da169240c4fa120ef1e3798615d4Bill Wendling return pImpl != RHS.pImpl; 33318e7211068c9d2c6204512f9c468ee179818a4b6Bill Wendling } 334710632d07b13609444626367bebd34c0af3acb6aMikhail Glushenkov 33558d74910c6b82e622ecbb57d6644d48fec5a5c0fChris Lattner //===--------------------------------------------------------------------===// 336c22f4aa886443507f8406d30d118fdeeac6a8c6cBill Wendling // AttributeSet Introspection 33758d74910c6b82e622ecbb57d6644d48fec5a5c0fChris Lattner //===--------------------------------------------------------------------===// 338710632d07b13609444626367bebd34c0af3acb6aMikhail Glushenkov 339c22f4aa886443507f8406d30d118fdeeac6a8c6cBill Wendling // FIXME: Remove this. 340c22f4aa886443507f8406d30d118fdeeac6a8c6cBill Wendling uint64_t Raw(unsigned Index) const; 341c22f4aa886443507f8406d30d118fdeeac6a8c6cBill Wendling 34218e7211068c9d2c6204512f9c468ee179818a4b6Bill Wendling /// \brief Return a raw pointer that uniquely identifies this attribute list. 34358d74910c6b82e622ecbb57d6644d48fec5a5c0fChris Lattner void *getRawPointer() const { 344ec2589863b32da169240c4fa120ef1e3798615d4Bill Wendling return pImpl; 34558d74910c6b82e622ecbb57d6644d48fec5a5c0fChris Lattner } 346710632d07b13609444626367bebd34c0af3acb6aMikhail Glushenkov 34718e7211068c9d2c6204512f9c468ee179818a4b6Bill Wendling /// \brief Return true if there are no attributes. 34858d74910c6b82e622ecbb57d6644d48fec5a5c0fChris Lattner bool isEmpty() const { 349aa57893e84ba7a35948fcaa99812ba88e58f4797Bill Wendling return getNumSlots() == 0; 35058d74910c6b82e622ecbb57d6644d48fec5a5c0fChris Lattner } 351710632d07b13609444626367bebd34c0af3acb6aMikhail Glushenkov 35218e7211068c9d2c6204512f9c468ee179818a4b6Bill Wendling /// \brief Return the number of slots used in this attribute list. This is 35318e7211068c9d2c6204512f9c468ee179818a4b6Bill Wendling /// the number of arguments that have an attribute set on them (including the 35418e7211068c9d2c6204512f9c468ee179818a4b6Bill Wendling /// function itself). 35558d74910c6b82e622ecbb57d6644d48fec5a5c0fChris Lattner unsigned getNumSlots() const; 356710632d07b13609444626367bebd34c0af3acb6aMikhail Glushenkov 357e1f95db4803a48a30fc2a1d5868281a87a36fb85Bill Wendling /// \brief Return the index for the given slot. 3583e3e789aede6ec38d39c95d88ad4e8634d5a259bBill Wendling uint64_t getSlotIndex(unsigned Slot) const; 359e1f95db4803a48a30fc2a1d5868281a87a36fb85Bill Wendling 3608e47daf2858e980210f3e1f007036b24da342c29Bill Wendling /// \brief Return the attributes at the given slot. 3618e47daf2858e980210f3e1f007036b24da342c29Bill Wendling AttributeSet getSlotAttributes(unsigned Slot) const; 3628e47daf2858e980210f3e1f007036b24da342c29Bill Wendling 363f3d1500ab2c7364d3d0fb73a7e1b8c6339ab48b1Bill Wendling void dump() const; 36458d74910c6b82e622ecbb57d6644d48fec5a5c0fChris Lattner}; 3654f859aa532dbf061736f9c23e0d0882b5cdfe566Reid Spencer 366a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling//===----------------------------------------------------------------------===// 367a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling/// \class 36816274258d16342a2f91aaa3690b78ce74e4105f1Bill Wendling/// \brief Provide DenseMapInfo for AttributeSet. 36916274258d16342a2f91aaa3690b78ce74e4105f1Bill Wendlingtemplate<> struct DenseMapInfo<AttributeSet> { 37016274258d16342a2f91aaa3690b78ce74e4105f1Bill Wendling static inline AttributeSet getEmptyKey() { 37116274258d16342a2f91aaa3690b78ce74e4105f1Bill Wendling uintptr_t Val = static_cast<uintptr_t>(-1); 37216274258d16342a2f91aaa3690b78ce74e4105f1Bill Wendling Val <<= PointerLikeTypeTraits<void*>::NumLowBitsAvailable; 37316274258d16342a2f91aaa3690b78ce74e4105f1Bill Wendling return AttributeSet(reinterpret_cast<AttributeSetImpl*>(Val)); 374c22f4aa886443507f8406d30d118fdeeac6a8c6cBill Wendling } 37516274258d16342a2f91aaa3690b78ce74e4105f1Bill Wendling static inline AttributeSet getTombstoneKey() { 37616274258d16342a2f91aaa3690b78ce74e4105f1Bill Wendling uintptr_t Val = static_cast<uintptr_t>(-2); 37716274258d16342a2f91aaa3690b78ce74e4105f1Bill Wendling Val <<= PointerLikeTypeTraits<void*>::NumLowBitsAvailable; 37816274258d16342a2f91aaa3690b78ce74e4105f1Bill Wendling return AttributeSet(reinterpret_cast<AttributeSetImpl*>(Val)); 379c22f4aa886443507f8406d30d118fdeeac6a8c6cBill Wendling } 38016274258d16342a2f91aaa3690b78ce74e4105f1Bill Wendling static unsigned getHashValue(AttributeSet AS) { 38116274258d16342a2f91aaa3690b78ce74e4105f1Bill Wendling return (unsigned((uintptr_t)AS.pImpl) >> 4) ^ 38216274258d16342a2f91aaa3690b78ce74e4105f1Bill Wendling (unsigned((uintptr_t)AS.pImpl) >> 9); 383c22f4aa886443507f8406d30d118fdeeac6a8c6cBill Wendling } 38416274258d16342a2f91aaa3690b78ce74e4105f1Bill Wendling static bool isEqual(AttributeSet LHS, AttributeSet RHS) { return LHS == RHS; } 385c22f4aa886443507f8406d30d118fdeeac6a8c6cBill Wendling}; 386c22f4aa886443507f8406d30d118fdeeac6a8c6cBill Wendling 387c22f4aa886443507f8406d30d118fdeeac6a8c6cBill Wendling//===----------------------------------------------------------------------===// 388c22f4aa886443507f8406d30d118fdeeac6a8c6cBill Wendling/// \class 389a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling/// \brief This class is used in conjunction with the Attribute::get method to 390a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling/// create an Attribute object. The object itself is uniquified. The Builder's 391a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling/// value, however, is not. So this can be used as a quick way to test for 392a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling/// equality, presence of attributes, etc. 393a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendlingclass AttrBuilder { 394a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling DenseSet<Attribute::AttrKind> Attrs; 395ea59f896a672c2e1ef9f02277bce60257aa60989Bill Wendling std::map<std::string, std::string> TargetDepAttrs; 396a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling uint64_t Alignment; 397a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling uint64_t StackAlignment; 398a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendlingpublic: 399a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling AttrBuilder() : Alignment(0), StackAlignment(0) {} 400f9271ea159b97e2febedcf095c3c4122cb24d077Bill Wendling explicit AttrBuilder(uint64_t Val) : Alignment(0), StackAlignment(0) { 401f9271ea159b97e2febedcf095c3c4122cb24d077Bill Wendling addRawValue(Val); 402a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling } 403a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling AttrBuilder(const Attribute &A) : Alignment(0), StackAlignment(0) { 40439da078977ae98b6bf1c3c76a472ed24f5f2a2d2Bill Wendling addAttribute(A); 405a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling } 406a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling AttrBuilder(AttributeSet AS, unsigned Idx); 40785df6b43403d3ebf5d80023a85699c6fb254941aBill Wendling AttrBuilder(const AttrBuilder &B) 40885df6b43403d3ebf5d80023a85699c6fb254941aBill Wendling : Attrs(B.Attrs), 40985df6b43403d3ebf5d80023a85699c6fb254941aBill Wendling TargetDepAttrs(B.TargetDepAttrs.begin(), B.TargetDepAttrs.end()), 41085df6b43403d3ebf5d80023a85699c6fb254941aBill Wendling Alignment(B.Alignment), StackAlignment(B.StackAlignment) {} 411a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling 412a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling void clear(); 413a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling 414a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling /// \brief Add an attribute to the builder. 415a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling AttrBuilder &addAttribute(Attribute::AttrKind Val); 416a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling 41739da078977ae98b6bf1c3c76a472ed24f5f2a2d2Bill Wendling /// \brief Add the Attribute object to the builder. 41839da078977ae98b6bf1c3c76a472ed24f5f2a2d2Bill Wendling AttrBuilder &addAttribute(Attribute A); 41939da078977ae98b6bf1c3c76a472ed24f5f2a2d2Bill Wendling 420ea59f896a672c2e1ef9f02277bce60257aa60989Bill Wendling /// \brief Add the target-dependent attribute to the builder. 421ad19d9c4228718b0ac167d0dfa013d14c3c9f135Bill Wendling AttrBuilder &addAttribute(StringRef A, StringRef V = StringRef()); 422ea59f896a672c2e1ef9f02277bce60257aa60989Bill Wendling 423a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling /// \brief Remove an attribute from the builder. 424a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling AttrBuilder &removeAttribute(Attribute::AttrKind Val); 425a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling 42649f6060f16aec4024d644a6ec4ddd3de9b3e8821Bill Wendling /// \brief Remove the attributes from the builder. 427e74365462a39529ae48ef4d34ec76b4543b8ea29Bill Wendling AttrBuilder &removeAttributes(AttributeSet A, uint64_t Index); 428a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling 429ea59f896a672c2e1ef9f02277bce60257aa60989Bill Wendling /// \brief Remove the target-dependent attribute to the builder. 430ea59f896a672c2e1ef9f02277bce60257aa60989Bill Wendling AttrBuilder &removeAttribute(StringRef A); 431ea59f896a672c2e1ef9f02277bce60257aa60989Bill Wendling 43285df6b43403d3ebf5d80023a85699c6fb254941aBill Wendling /// \brief Add the attributes from the builder. 43385df6b43403d3ebf5d80023a85699c6fb254941aBill Wendling AttrBuilder &merge(const AttrBuilder &B); 43485df6b43403d3ebf5d80023a85699c6fb254941aBill Wendling 435a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling /// \brief Return true if the builder has the specified attribute. 436a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling bool contains(Attribute::AttrKind A) const; 437a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling 438c342d9d345acdbd95577c7c6e9ce7d3a1bdb57bfBill Wendling /// \brief Return true if the builder has the specified target-dependent 439c342d9d345acdbd95577c7c6e9ce7d3a1bdb57bfBill Wendling /// attribute. 440c342d9d345acdbd95577c7c6e9ce7d3a1bdb57bfBill Wendling bool contains(StringRef A) const; 441c342d9d345acdbd95577c7c6e9ce7d3a1bdb57bfBill Wendling 442a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling /// \brief Return true if the builder has IR-level attributes. 443a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling bool hasAttributes() const; 444a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling 445a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling /// \brief Return true if the builder has any attribute that's in the 446a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling /// specified attribute. 447e74365462a39529ae48ef4d34ec76b4543b8ea29Bill Wendling bool hasAttributes(AttributeSet A, uint64_t Index) const; 448a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling 449a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling /// \brief Return true if the builder has an alignment attribute. 450a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling bool hasAlignmentAttr() const; 451a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling 452a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling /// \brief Retrieve the alignment attribute, if it exists. 453a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling uint64_t getAlignment() const { return Alignment; } 454a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling 455a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling /// \brief Retrieve the stack alignment attribute, if it exists. 456a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling uint64_t getStackAlignment() const { return StackAlignment; } 457a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling 458a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling /// \brief This turns an int alignment (which must be a power of 2) into the 459a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling /// form used internally in Attribute. 460a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling AttrBuilder &addAlignmentAttr(unsigned Align); 461a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling 462a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling /// \brief This turns an int stack alignment (which must be a power of 2) into 463a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling /// the form used internally in Attribute. 464a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling AttrBuilder &addStackAlignmentAttr(unsigned Align); 465a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling 46664754f499058b5dc748ea6d06a084af0ed539ec4Bill Wendling // Iterators for target-independent attributes. 467a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling typedef DenseSet<Attribute::AttrKind>::iterator iterator; 468a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling typedef DenseSet<Attribute::AttrKind>::const_iterator const_iterator; 469a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling 470c22f4aa886443507f8406d30d118fdeeac6a8c6cBill Wendling iterator begin() { return Attrs.begin(); } 471c22f4aa886443507f8406d30d118fdeeac6a8c6cBill Wendling iterator end() { return Attrs.end(); } 472817abdd8b055059e5930a15704b9f52da4236456Bill Wendling 473a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling const_iterator begin() const { return Attrs.begin(); } 474a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling const_iterator end() const { return Attrs.end(); } 475a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling 47687de71cb9f12d874e88d4f314ab245985c1b36bcBill Wendling bool empty() const { return Attrs.empty(); } 47787de71cb9f12d874e88d4f314ab245985c1b36bcBill Wendling 47864754f499058b5dc748ea6d06a084af0ed539ec4Bill Wendling // Iterators for target-dependent attributes. 47964754f499058b5dc748ea6d06a084af0ed539ec4Bill Wendling typedef std::pair<std::string, std::string> td_type; 48064754f499058b5dc748ea6d06a084af0ed539ec4Bill Wendling typedef std::map<std::string, std::string>::iterator td_iterator; 48164754f499058b5dc748ea6d06a084af0ed539ec4Bill Wendling typedef std::map<std::string, std::string>::const_iterator td_const_iterator; 48264754f499058b5dc748ea6d06a084af0ed539ec4Bill Wendling 48364754f499058b5dc748ea6d06a084af0ed539ec4Bill Wendling td_iterator td_begin() { return TargetDepAttrs.begin(); } 48464754f499058b5dc748ea6d06a084af0ed539ec4Bill Wendling td_iterator td_end() { return TargetDepAttrs.end(); } 48564754f499058b5dc748ea6d06a084af0ed539ec4Bill Wendling 48664754f499058b5dc748ea6d06a084af0ed539ec4Bill Wendling td_const_iterator td_begin() const { return TargetDepAttrs.begin(); } 48764754f499058b5dc748ea6d06a084af0ed539ec4Bill Wendling td_const_iterator td_end() const { return TargetDepAttrs.end(); } 48864754f499058b5dc748ea6d06a084af0ed539ec4Bill Wendling 48987de71cb9f12d874e88d4f314ab245985c1b36bcBill Wendling bool td_empty() const { return TargetDepAttrs.empty(); } 49087de71cb9f12d874e88d4f314ab245985c1b36bcBill Wendling 491a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling /// \brief Remove attributes that are used on functions only. 492a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling void removeFunctionOnlyAttrs() { 493a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling removeAttribute(Attribute::NoReturn) 494a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling .removeAttribute(Attribute::NoUnwind) 495a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling .removeAttribute(Attribute::ReadNone) 496a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling .removeAttribute(Attribute::ReadOnly) 497a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling .removeAttribute(Attribute::NoInline) 498a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling .removeAttribute(Attribute::AlwaysInline) 499a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling .removeAttribute(Attribute::OptimizeForSize) 500a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling .removeAttribute(Attribute::StackProtect) 501a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling .removeAttribute(Attribute::StackProtectReq) 502114baee1fa017daefad2339c77b45b9ca3d79a41Bill Wendling .removeAttribute(Attribute::StackProtectStrong) 503a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling .removeAttribute(Attribute::NoRedZone) 504a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling .removeAttribute(Attribute::NoImplicitFloat) 505a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling .removeAttribute(Attribute::Naked) 506a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling .removeAttribute(Attribute::InlineHint) 507a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling .removeAttribute(Attribute::StackAlignment) 508a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling .removeAttribute(Attribute::UWTable) 509a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling .removeAttribute(Attribute::NonLazyBind) 510a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling .removeAttribute(Attribute::ReturnsTwice) 511a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling .removeAttribute(Attribute::AddressSafety) 512ab39afa9d9b99c61842c8e3d0eb706bd16efdcf3Kostya Serebryany .removeAttribute(Attribute::ThreadSafety) 513ab39afa9d9b99c61842c8e3d0eb706bd16efdcf3Kostya Serebryany .removeAttribute(Attribute::UninitializedChecks) 514a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling .removeAttribute(Attribute::MinSize) 515a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling .removeAttribute(Attribute::NoDuplicate); 516a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling } 517a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling 518a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling bool operator==(const AttrBuilder &B); 519a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling bool operator!=(const AttrBuilder &B) { 520a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling return !(*this == B); 521a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling } 522c22f4aa886443507f8406d30d118fdeeac6a8c6cBill Wendling 523f9271ea159b97e2febedcf095c3c4122cb24d077Bill Wendling // FIXME: Remove this in 4.0. 524c22f4aa886443507f8406d30d118fdeeac6a8c6cBill Wendling 525c22f4aa886443507f8406d30d118fdeeac6a8c6cBill Wendling /// \brief Add the raw value to the internal representation. 526c22f4aa886443507f8406d30d118fdeeac6a8c6cBill Wendling AttrBuilder &addRawValue(uint64_t Val); 527a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling}; 528a90a99a82b9c5c39fc6dbee9c266dcd7b107fe2fBill Wendling 5298e47daf2858e980210f3e1f007036b24da342c29Bill Wendlingnamespace AttributeFuncs { 5308e47daf2858e980210f3e1f007036b24da342c29Bill Wendling 5318e47daf2858e980210f3e1f007036b24da342c29Bill Wendling/// \brief Which attributes cannot be applied to a type. 532e74365462a39529ae48ef4d34ec76b4543b8ea29Bill WendlingAttributeSet typeIncompatible(Type *Ty, uint64_t Index); 5338e47daf2858e980210f3e1f007036b24da342c29Bill Wendling 5348e47daf2858e980210f3e1f007036b24da342c29Bill Wendling} // end AttributeFuncs namespace 5358e47daf2858e980210f3e1f007036b24da342c29Bill Wendling 53627107f6ab4627fa38bcacad6757ed6d52910f880Bill Wendling} // end llvm namespace 5376091ebd172a16a10f1ea66061a5fa7cbf5139e56Reid Spencer 5386091ebd172a16a10f1ea66061a5fa7cbf5139e56Reid Spencer#endif 539