1 //===---- llvm/MDBuilder.h - Builder for LLVM metadata ----------*- C++ -*-===// 2 // 3 // The LLVM Compiler Infrastructure 4 // 5 // This file is distributed under the University of Illinois Open Source 6 // License. See LICENSE.TXT for details. 7 // 8 //===----------------------------------------------------------------------===// 9 // 10 // This file defines the MDBuilder class, which is used as a convenient way to 11 // create LLVM metadata with a consistent and simplified interface. 12 // 13 //===----------------------------------------------------------------------===// 14 15 #ifndef LLVM_IR_MDBUILDER_H 16 #define LLVM_IR_MDBUILDER_H 17 18 #include "llvm/ADT/StringRef.h" 19 #include "llvm/Support/DataTypes.h" 20 #include <utility> 21 22 namespace llvm { 23 24 class APInt; 25 template <typename T> class ArrayRef; 26 class LLVMContext; 27 class Constant; 28 class ConstantAsMetadata; 29 class MDNode; 30 class MDString; 31 32 class MDBuilder { 33 LLVMContext &Context; 34 35 public: MDBuilder(LLVMContext & context)36 MDBuilder(LLVMContext &context) : Context(context) {} 37 38 /// \brief Return the given string as metadata. 39 MDString *createString(StringRef Str); 40 41 /// \brief Return the given constant as metadata. 42 ConstantAsMetadata *createConstant(Constant *C); 43 44 //===------------------------------------------------------------------===// 45 // FPMath metadata. 46 //===------------------------------------------------------------------===// 47 48 /// \brief Return metadata with the given settings. The special value 0.0 49 /// for the Accuracy parameter indicates the default (maximal precision) 50 /// setting. 51 MDNode *createFPMath(float Accuracy); 52 53 //===------------------------------------------------------------------===// 54 // Prof metadata. 55 //===------------------------------------------------------------------===// 56 57 /// \brief Return metadata containing two branch weights. 58 MDNode *createBranchWeights(uint32_t TrueWeight, uint32_t FalseWeight); 59 60 /// \brief Return metadata containing a number of branch weights. 61 MDNode *createBranchWeights(ArrayRef<uint32_t> Weights); 62 63 //===------------------------------------------------------------------===// 64 // Range metadata. 65 //===------------------------------------------------------------------===// 66 67 /// \brief Return metadata describing the range [Lo, Hi). 68 MDNode *createRange(const APInt &Lo, const APInt &Hi); 69 70 //===------------------------------------------------------------------===// 71 // AA metadata. 72 //===------------------------------------------------------------------===// 73 74 protected: 75 /// \brief Return metadata appropriate for a AA root node (scope or TBAA). 76 /// Each returned node is distinct from all other metadata and will never 77 /// be identified (uniqued) with anything else. 78 MDNode *createAnonymousAARoot(StringRef Name = StringRef(), 79 MDNode *Extra = nullptr); 80 81 public: 82 /// \brief Return metadata appropriate for a TBAA root node. Each returned 83 /// node is distinct from all other metadata and will never be identified 84 /// (uniqued) with anything else. createAnonymousTBAARoot()85 MDNode *createAnonymousTBAARoot() { 86 return createAnonymousAARoot(); 87 } 88 89 /// \brief Return metadata appropriate for an alias scope domain node. 90 /// Each returned node is distinct from all other metadata and will never 91 /// be identified (uniqued) with anything else. 92 MDNode *createAnonymousAliasScopeDomain(StringRef Name = StringRef()) { 93 return createAnonymousAARoot(Name); 94 } 95 96 /// \brief Return metadata appropriate for an alias scope root node. 97 /// Each returned node is distinct from all other metadata and will never 98 /// be identified (uniqued) with anything else. 99 MDNode *createAnonymousAliasScope(MDNode *Domain, 100 StringRef Name = StringRef()) { 101 return createAnonymousAARoot(Name, Domain); 102 } 103 104 /// \brief Return metadata appropriate for a TBAA root node with the given 105 /// name. This may be identified (uniqued) with other roots with the same 106 /// name. 107 MDNode *createTBAARoot(StringRef Name); 108 109 /// \brief Return metadata appropriate for an alias scope domain node with 110 /// the given name. This may be identified (uniqued) with other roots with 111 /// the same name. 112 MDNode *createAliasScopeDomain(StringRef Name); 113 114 /// \brief Return metadata appropriate for an alias scope node with 115 /// the given name. This may be identified (uniqued) with other scopes with 116 /// the same name and domain. 117 MDNode *createAliasScope(StringRef Name, MDNode *Domain); 118 119 /// \brief Return metadata for a non-root TBAA node with the given name, 120 /// parent in the TBAA tree, and value for 'pointsToConstantMemory'. 121 MDNode *createTBAANode(StringRef Name, MDNode *Parent, 122 bool isConstant = false); 123 124 struct TBAAStructField { 125 uint64_t Offset; 126 uint64_t Size; 127 MDNode *TBAA; TBAAStructFieldTBAAStructField128 TBAAStructField(uint64_t Offset, uint64_t Size, MDNode *TBAA) : 129 Offset(Offset), Size(Size), TBAA(TBAA) {} 130 }; 131 132 /// \brief Return metadata for a tbaa.struct node with the given 133 /// struct field descriptions. 134 MDNode *createTBAAStructNode(ArrayRef<TBAAStructField> Fields); 135 136 /// \brief Return metadata for a TBAA struct node in the type DAG 137 /// with the given name, a list of pairs (offset, field type in the type DAG). 138 MDNode * 139 createTBAAStructTypeNode(StringRef Name, 140 ArrayRef<std::pair<MDNode *, uint64_t>> Fields); 141 142 /// \brief Return metadata for a TBAA scalar type node with the 143 /// given name, an offset and a parent in the TBAA type DAG. 144 MDNode *createTBAAScalarTypeNode(StringRef Name, MDNode *Parent, 145 uint64_t Offset = 0); 146 147 /// \brief Return metadata for a TBAA tag node with the given 148 /// base type, access type and offset relative to the base type. 149 MDNode *createTBAAStructTagNode(MDNode *BaseType, MDNode *AccessType, 150 uint64_t Offset); 151 }; 152 153 } // end namespace llvm 154 155 #endif 156