-//===-- llvm/ParameterAttributes.h - Container for Param Attrs --*- C++ -*-===//
+//===-- llvm/ParameterAttributes.h - Container for ParamAttrs ---*- C++ -*-===//
//
// The LLVM Compiler Infrastructure
//
/// treated by optimizations and code generation. This enumeration lists the
/// attributes that can be associated with parameters or function results.
/// @brief Function parameter attributes.
-enum ParameterAttributes {
- NoAttributeSet = 0, ///< No attributes have been set
- ZExtAttribute = 1 << 0, ///< zero extended before/after call
- SExtAttribute = 1 << 1, ///< sign extended before/after call
- NoReturnAttribute = 1 << 2, ///< mark the function as not returning
- InRegAttribute = 1 << 3, ///< force argument to be passed in register
- StructRetAttribute = 1 << 4, ///< hidden pointer to structure to return
- NoUnwindAttribute = 1 << 5 ///< Function doesn't unwind stack
+namespace ParamAttr {
+
+enum Attributes {
+ None = 0, ///< No attributes have been set
+ ZExt = 1 << 0, ///< zero extended before/after call
+ SExt = 1 << 1, ///< sign extended before/after call
+ NoReturn = 1 << 2, ///< mark the function as not returning
+ InReg = 1 << 3, ///< force argument to be passed in register
+ StructRet = 1 << 4, ///< hidden pointer to structure to return
+ NoUnwind = 1 << 5 ///< Function doesn't unwind stack
};
+}
+
+typedef ParamAttr::Attributes ParameterAttributes;
+
/// This class is used by Function and CallInst to represent the set of
/// parameter attributes used. It represents a list of pairs of uint16_t, one
/// for the parameter index, and one a set of ParameterAttributes bits.
/// are provided to obtain information about the attributes.
/// @brief A List of ParameterAttributes.
class ParamAttrsList {
- /// @name Accessors
+ //void operator=(const ParamAttrsList &); // Do not implement
+ //ParamAttrsList(const ParamAttrsList &); // Do not implement
+
+ /// @name Types
/// @{
public:
- /// Returns the parameter index of a particular parameter attribute in this
- /// list of attributes. Note that the attr_index is an index into this
- /// class's list of attributes, not the index of the parameter. The result
- /// is the index of the parameter.
- /// @brief Get a parameter index
- uint16_t getParamIndex(unsigned attr_index) const {
- return attrs[attr_index].index;
- }
+ /// This is an internal structure used to associate the ParameterAttributes
+ /// with a parameter index.
+ /// @brief ParameterAttributes with a parameter index.
+ struct ParamAttrsWithIndex {
+ uint16_t attrs; ///< The attributes that are set, |'d together
+ uint16_t index; ///< Index of the parameter for which the attributes apply
+ };
+
+ /// @brief A vector of attribute/index pairs.
+ typedef SmallVector<ParamAttrsWithIndex,4> ParamAttrsVector;
+
+ /// @}
+ /// @name Construction
+ /// @{
+ public:
+ /// @brief Construct an empty ParamAttrsList
+ ParamAttrsList() {}
+ /// This method ensures the uniqueness of ParamAttrsList instances. The
+ /// argument is a vector of attribute/index pairs as represented by the
+ /// ParamAttrsWithIndex structure. The vector is used in the construction of
+ /// the ParamAttrsList instance. If an instance with identical vector pairs
+ /// exists, it will be returned instead of creating a new instance.
+ /// @brief Get a ParamAttrsList instance.
+ ParamAttrsList *get(const ParamAttrsVector &attrVec);
+
+ /// @}
+ /// @name Accessors
+ /// @{
+ public:
/// The parameter attributes for the \p indexth parameter are returned.
/// The 0th parameter refers to the return type of the function. Note that
/// the \p param_index is an index into the function's parameters, not an
return getParamAttrs(i) & attr;
}
- /// Determines how many parameter attributes are set in this ParamAttrsList.
- /// This says nothing about how many parameters the function has. It also
- /// says nothing about the highest parameter index that has attributes.
- /// @returns the number of parameter attributes in this ParamAttrsList.
- /// @brief Return the number of parameter attributes this type has.
- unsigned size() const { return attrs.size(); }
-
- /// @returns true if this ParamAttrsList is empty.
- /// @brief Determine emptiness of ParamAttrsList.
- unsigned empty() const { return attrs.empty(); }
-
/// The set of ParameterAttributes set in Attributes is converted to a
/// string of equivalent mnemonics. This is, presumably, for writing out
/// the mnemonics for the assembly writer.
}
return false;
}
+
+ /// Returns the parameter index of a particular parameter attribute in this
+ /// list of attributes. Note that the attr_index is an index into this
+ /// class's list of attributes, not the index of a parameter. The result
+ /// is the index of the parameter. Clients generally should not use this
+ /// method. It is used internally by LLVM.
+ /// @brief Get a parameter index
+ uint16_t getParamIndex(unsigned attr_index) const {
+ return attrs[attr_index].index;
+ }
+
+ /// Determines how many parameter attributes are set in this ParamAttrsList.
+ /// This says nothing about how many parameters the function has. It also
+ /// says nothing about the highest parameter index that has attributes.
+ /// Clients generally should not use this method. It is used internally by
+ /// LLVM.
+ /// @returns the number of parameter attributes in this ParamAttrsList.
+ /// @brief Return the number of parameter attributes this type has.
+ unsigned size() const { return attrs.size(); }
+
+ /// Clients generally should not use this method. It is used internally by
+ /// LLVM.
+ /// @returns true if this ParamAttrsList is empty.
+ /// @brief Determine emptiness of ParamAttrsList.
+ unsigned empty() const { return attrs.empty(); }
+
/// @}
/// @name Mutators
/// @{
public:
- /// This adds a pair to the list of parameter index and attribute pairs
- /// represented by this class. If the parameter index already exists then
- /// its attributes are overwritten. Otherwise it is added to the list.
- /// @brief Insert ParameterAttributes for an index
- void setAttributes(uint16_t param_index, uint16_t attrs);
+ /// This method will add the \p attrs to the parameter with index
+ /// \p param_index. If the parameter index does not exist it will be created
+ /// and the \p attrs will be the only attributes set. Otherwise, any
+ /// existing attributes for the specified parameter remain set and the
+ /// attributes given by \p attrs are also set.
+ /// @brief Add ParameterAttributes.
+ void addAttributes(uint16_t param_index, uint16_t attrs);
+
+ /// This method will remove the \p attrs to the parameter with index
+ /// \p param_index. If the parameter index does not exist in the list,
+ /// an assertion will occur. If the specified attributes are the last
+ /// attributes set for the specified parameter index, the attributes for
+ /// that index are removed completely from the list (size is decremented).
+ /// Otherwise, the specified attributes are removed from the set of
+ /// attributes for the given index, retaining any others.
+ /// @brief Remove a single ParameterAttribute
+ void removeAttributes(uint16_t param_index, uint16_t attrs);
/// @}
/// @name Data
/// @{
private:
- /// This is an internal structure used to associate the ParameterAttributes
- /// with a parameter index.
- /// @brief ParameterAttributes with a parameter index.
- struct ParamAttrsWithIndex {
- uint16_t attrs; ///< The attributes that are set, |'d together
- uint16_t index; ///< Index of the parameter for which the attributes apply
- };
-
- SmallVector<ParamAttrsWithIndex,2> attrs; ///< The list of attributes
+ ParamAttrsVector attrs; ///< The list of attributes
/// @}
};
projects / oota-llvm.git / blobdiff