include/llvm/ParameterAttributes.h

   1 //===-- llvm/ParameterAttributes.h - Container for ParamAttrs ---*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by Reid Spencer and is distributed under the
   6 // University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file contains the types necessary to represent the parameter attributes
  11 // associated with functions and their calls.
  12 //
  13 // The implementations of these classes live in lib/VMCore/Function.cpp.
  14 //
  15 //===----------------------------------------------------------------------===//
  16
  17 #ifndef LLVM_PARAMETER_ATTRIBUTES_H
  18 #define LLVM_PARAMETER_ATTRIBUTES_H
  19
  20 #include "llvm/ADT/SmallVector.h"
  21 #include "llvm/ADT/FoldingSet.h"
  22
  23 namespace llvm {
  24 namespace ParamAttr {
  25
  26 /// Function parameters and results can have attributes to indicate how they
  27 /// should be treated by optimizations and code generation. This enumeration
  28 /// lists the attributes that can be associated with parameters or function
  29 /// results.
  30 /// @brief Function parameter attributes.
  31 enum Attributes {
  32   None       = 0,      ///< No attributes have been set
  33   ZExt       = 1 << 0, ///< zero extended before/after call
  34   SExt       = 1 << 1, ///< sign extended before/after call
  35   NoReturn   = 1 << 2, ///< mark the function as not returning
  36   InReg      = 1 << 3, ///< force argument to be passed in register
  37   StructRet  = 1 << 4, ///< hidden pointer to structure to return
  38   NoUnwind   = 1 << 5  ///< Function doesn't unwind stack
  39 };
  40
  41 }
  42
  43 /// This is just a pair of values to associate a set of parameter attributes
  44 /// with a parameter index.
  45 /// @brief ParameterAttributes with a parameter index.
  46 struct ParamAttrsWithIndex {
  47   uint16_t attrs; ///< The attributes that are set, |'d together
  48   uint16_t index; ///< Index of the parameter for which the attributes apply
  49 };
  50
  51 /// @brief A vector of attribute/index pairs.
  52 typedef SmallVector<ParamAttrsWithIndex,4> ParamAttrsVector;
  53
  54 /// @brief A more friendly way to reference the attributes.
  55 typedef ParamAttr::Attributes ParameterAttributes;
  56
  57 /// This class represents a list of attribute/index pairs for parameter
  58 /// attributes. Each entry in the list contains the index of a function
  59 /// parameter and the associated ParameterAttributes. If a parameter's index is
  60 /// not present in the list, then no attributes are set for that parameter. The
  61 /// list may also be empty, but this does not occur in practice. An item in
  62 /// the list with an index of 0 refers to the function as a whole or its result.
  63 /// To construct a ParamAttrsList, you must first fill a ParamAttrsVector with
  64 /// the attribute/index pairs you wish to set.  The list of attributes can be
  65 /// turned into a string of mnemonics suitable for LLVM Assembly output.
  66 /// Various accessors are provided to obtain information about the attributes.
  67 /// Note that objects of this class are "uniqued". The \p get method can return
  68 /// the pointer of an existing and identical instance. Consequently, reference
  69 /// counting is necessary in order to determine when the last reference to a
  70 /// ParamAttrsList of a given shape is dropped. Users of this class should use
  71 /// the addRef and dropRef methods to add/drop references. When the reference
  72 /// count goes to zero, the ParamAttrsList object is deleted.
  73 /// This class is used by Function, CallInst and InvokeInst to represent their
  74 /// sets of parameter attributes.
  75 /// @brief A List of ParameterAttributes.
  76 class ParamAttrsList : public FoldingSetNode {
  77   /// @name Construction
  78   /// @{
  79   private:
  80     // ParamAttrsList is uniqued, these should not be publicly available
  81     void operator=(const ParamAttrsList &); // Do not implement
  82     ParamAttrsList(const ParamAttrsList &); // Do not implement
  83     ParamAttrsList();                       // Do not implement
  84     ~ParamAttrsList();                      // Private implementation
  85
  86     /// Only the \p get method can invoke this when it wants to create a
  87     /// new instance.
  88     /// @brief Construct an ParamAttrsList from a ParamAttrsVector
  89     explicit ParamAttrsList(const ParamAttrsVector &attrVec)
  90       : attrs(attrVec), refCount(0) {}
  91
  92   public:
  93     /// This method ensures the uniqueness of ParamAttrsList instances. The
  94     /// argument is a vector of attribute/index pairs as represented by the
  95     /// ParamAttrsWithIndex structure. The vector is used in the construction of
  96     /// the ParamAttrsList instance. If an instance with identical vector pairs
  97     /// exists, it will be returned instead of creating a new instance.
  98     /// @brief Get a ParamAttrsList instance.
  99     static ParamAttrsList *get(const ParamAttrsVector &attrVec);
 100
 101   /// @}
 102   /// @name Accessors
 103   /// @{
 104   public:
 105     /// The parameter attributes for the \p indexth parameter are returned.
 106     /// The 0th parameter refers to the return type of the function. Note that
 107     /// the \p param_index is an index into the function's parameters, not an
 108     /// index into this class's list of attributes. The result of getParamIndex
 109     /// is always suitable input to this function.
 110     /// @returns The all the ParameterAttributes for the \p indexth parameter
 111     /// as a uint16_t of enumeration values OR'd together.
 112     /// @brief Get the attributes for a parameter
 113     uint16_t getParamAttrs(uint16_t param_index) const;
 114
 115     /// This checks to see if the \p ith function parameter has the parameter
 116     /// attribute given by \p attr set.
 117     /// @returns true if the parameter attribute is set
 118     /// @brief Determine if a ParameterAttributes is set
 119     bool paramHasAttr(uint16_t i, ParameterAttributes attr) const {
 120       return getParamAttrs(i) & attr;
 121     }
 122
 123     /// The set of ParameterAttributes set in Attributes is converted to a
 124     /// string of equivalent mnemonics. This is, presumably, for writing out
 125     /// the mnemonics for the assembly writer.
 126     /// @brief Convert parameter attribute bits to text
 127     static std::string getParamAttrsText(uint16_t Attributes);
 128
 129     /// The \p Indexth parameter attribute is converted to string.
 130     /// @brief Get the text for the parmeter attributes for one parameter.
 131     std::string getParamAttrsTextByIndex(uint16_t Index) const {
 132       return getParamAttrsText(getParamAttrs(Index));
 133     }
 134
 135     /// @brief Comparison operator for ParamAttrsList
 136     bool operator < (const ParamAttrsList& that) const {
 137       if (this->attrs.size() < that.attrs.size())
 138         return true;
 139       if (this->attrs.size() > that.attrs.size())
 140         return false;
 141       for (unsigned i = 0; i < attrs.size(); ++i) {
 142         if (attrs[i].index < that.attrs[i].index)
 143           return true;
 144         if (attrs[i].index > that.attrs[i].index)
 145           return false;
 146         if (attrs[i].attrs < that.attrs[i].attrs)
 147           return true;
 148         if (attrs[i].attrs > that.attrs[i].attrs)
 149           return false;
 150       }
 151       return false;
 152     }
 153
 154     /// Returns the parameter index of a particular parameter attribute in this
 155     /// list of attributes. Note that the attr_index is an index into this
 156     /// class's list of attributes, not the index of a parameter. The result
 157     /// is the index of the parameter. Clients generally should not use this
 158     /// method. It is used internally by LLVM.
 159     /// @brief Get a parameter index
 160     uint16_t getParamIndex(unsigned attr_index) const {
 161       return attrs[attr_index].index;
 162     }
 163
 164     uint16_t getParamAttrsAtIndex(unsigned attr_index) const {
 165       return attrs[attr_index].attrs;
 166     }
 167
 168     /// Determines how many parameter attributes are set in this ParamAttrsList.
 169     /// This says nothing about how many parameters the function has. It also
 170     /// says nothing about the highest parameter index that has attributes.
 171     /// Clients generally should not use this method. It is used internally by
 172     /// LLVM.
 173     /// @returns the number of parameter attributes in this ParamAttrsList.
 174     /// @brief Return the number of parameter attributes this type has.
 175     unsigned size() const { return attrs.size(); }
 176
 177     /// Classes retaining references to ParamAttrsList objects should call this
 178     /// method to increment the reference count. This ensures that the
 179     /// ParamAttrsList object will not disappear until the class drops it.
 180     /// @brief Add a reference to this instance.
 181     void addRef() const { refCount++; }
 182
 183     /// Classes retaining references to ParamAttrsList objects should call this
 184     /// method to decrement the reference count and possibly delete the
 185     /// ParamAttrsList object. This ensures that ParamAttrsList objects are
 186     /// cleaned up only when the last reference to them is dropped.
 187     /// @brief Drop a reference to this instance.
 188     void dropRef() const {
 189       assert(refCount != 0 && "dropRef without addRef");
 190       if (--refCount == 0)
 191         delete this;
 192     }
 193
 194   /// @}
 195   /// @name Implementation Details
 196   /// @{
 197   public:
 198     void Profile(FoldingSetNodeID &ID) const;
 199     void dump() const;
 200
 201   /// @}
 202   /// @name Data
 203   /// @{
 204   private:
 205     ParamAttrsVector attrs;     ///< The list of attributes
 206     mutable unsigned refCount;  ///< The number of references to this object
 207   /// @}
 208 };
 209
 210 } // End llvm namespace
 211
 212 #endif