1 //===---- llvm/MDBuilder.cpp - Builder for LLVM metadata ------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
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.
13 //===----------------------------------------------------------------------===//
15 #include "llvm/IR/MDBuilder.h"
16 #include "llvm/IR/Constants.h"
17 #include "llvm/IR/Function.h"
18 #include "llvm/IR/Metadata.h"
21 MDString *MDBuilder::createString(StringRef Str) {
22 return MDString::get(Context, Str);
25 ConstantAsMetadata *MDBuilder::createConstant(Constant *C) {
26 return ConstantAsMetadata::get(C);
29 MDNode *MDBuilder::createFPMath(float Accuracy) {
32 assert(Accuracy > 0.0 && "Invalid fpmath accuracy!");
34 createConstant(ConstantFP::get(Type::getFloatTy(Context), Accuracy));
35 return MDNode::get(Context, Op);
38 MDNode *MDBuilder::createBranchWeights(uint32_t TrueWeight,
39 uint32_t FalseWeight) {
40 return createBranchWeights({TrueWeight, FalseWeight});
43 MDNode *MDBuilder::createBranchWeights(ArrayRef<uint32_t> Weights) {
44 assert(Weights.size() >= 1 && "Need at least one branch weights!");
46 SmallVector<Metadata *, 4> Vals(Weights.size() + 1);
47 Vals[0] = createString("branch_weights");
49 Type *Int32Ty = Type::getInt32Ty(Context);
50 for (unsigned i = 0, e = Weights.size(); i != e; ++i)
51 Vals[i + 1] = createConstant(ConstantInt::get(Int32Ty, Weights[i]));
53 return MDNode::get(Context, Vals);
56 MDNode *MDBuilder::createUnpredictable() {
57 return MDNode::get(Context, None);
60 MDNode *MDBuilder::createFunctionEntryCount(
61 uint64_t Count, const DenseSet<GlobalValue::GUID> *Imports) {
62 Type *Int64Ty = Type::getInt64Ty(Context);
63 SmallVector<Metadata *, 8> Ops;
64 Ops.push_back(createString("function_entry_count"));
65 Ops.push_back(createConstant(ConstantInt::get(Int64Ty, Count)));
67 SmallVector<GlobalValue::GUID, 2> OrderID(Imports->begin(), Imports->end());
68 std::stable_sort(OrderID.begin(), OrderID.end(),
69 [] (GlobalValue::GUID A, GlobalValue::GUID B) {
71 for (auto ID : OrderID)
72 Ops.push_back(createConstant(ConstantInt::get(Int64Ty, ID)));
74 return MDNode::get(Context, Ops);
77 MDNode *MDBuilder::createFunctionSectionPrefix(StringRef Prefix) {
78 return MDNode::get(Context,
79 {createString("function_section_prefix"),
80 createString(Prefix)});
83 MDNode *MDBuilder::createRange(const APInt &Lo, const APInt &Hi) {
84 assert(Lo.getBitWidth() == Hi.getBitWidth() && "Mismatched bitwidths!");
86 Type *Ty = IntegerType::get(Context, Lo.getBitWidth());
87 return createRange(ConstantInt::get(Ty, Lo), ConstantInt::get(Ty, Hi));
90 MDNode *MDBuilder::createRange(Constant *Lo, Constant *Hi) {
91 // If the range is everything then it is useless.
95 // Return the range [Lo, Hi).
96 return MDNode::get(Context, {createConstant(Lo), createConstant(Hi)});
99 MDNode *MDBuilder::createCallees(ArrayRef<Function *> Callees) {
100 SmallVector<Metadata *, 4> Ops;
101 for (Function *F : Callees)
102 Ops.push_back(createConstant(F));
103 return MDNode::get(Context, Ops);
106 MDNode *MDBuilder::createAnonymousAARoot(StringRef Name, MDNode *Extra) {
107 // To ensure uniqueness the root node is self-referential.
108 auto Dummy = MDNode::getTemporary(Context, None);
110 SmallVector<Metadata *, 3> Args(1, Dummy.get());
112 Args.push_back(Extra);
114 Args.push_back(createString(Name));
115 MDNode *Root = MDNode::get(Context, Args);
117 // At this point we have
118 // !0 = metadata !{} <- dummy
119 // !1 = metadata !{metadata !0} <- root
120 // Replace the dummy operand with the root node itself and delete the dummy.
121 Root->replaceOperandWith(0, Root);
124 // !1 = metadata !{metadata !1} <- self-referential root
128 MDNode *MDBuilder::createTBAARoot(StringRef Name) {
129 return MDNode::get(Context, createString(Name));
132 /// \brief Return metadata for a non-root TBAA node with the given name,
133 /// parent in the TBAA tree, and value for 'pointsToConstantMemory'.
134 MDNode *MDBuilder::createTBAANode(StringRef Name, MDNode *Parent,
137 Constant *Flags = ConstantInt::get(Type::getInt64Ty(Context), 1);
138 return MDNode::get(Context,
139 {createString(Name), Parent, createConstant(Flags)});
141 return MDNode::get(Context, {createString(Name), Parent});
144 MDNode *MDBuilder::createAliasScopeDomain(StringRef Name) {
145 return MDNode::get(Context, createString(Name));
148 MDNode *MDBuilder::createAliasScope(StringRef Name, MDNode *Domain) {
149 return MDNode::get(Context, {createString(Name), Domain});
152 /// \brief Return metadata for a tbaa.struct node with the given
153 /// struct field descriptions.
154 MDNode *MDBuilder::createTBAAStructNode(ArrayRef<TBAAStructField> Fields) {
155 SmallVector<Metadata *, 4> Vals(Fields.size() * 3);
156 Type *Int64 = Type::getInt64Ty(Context);
157 for (unsigned i = 0, e = Fields.size(); i != e; ++i) {
158 Vals[i * 3 + 0] = createConstant(ConstantInt::get(Int64, Fields[i].Offset));
159 Vals[i * 3 + 1] = createConstant(ConstantInt::get(Int64, Fields[i].Size));
160 Vals[i * 3 + 2] = Fields[i].Type;
162 return MDNode::get(Context, Vals);
165 /// \brief Return metadata for a TBAA struct node in the type DAG
166 /// with the given name, a list of pairs (offset, field type in the type DAG).
167 MDNode *MDBuilder::createTBAAStructTypeNode(
168 StringRef Name, ArrayRef<std::pair<MDNode *, uint64_t>> Fields) {
169 SmallVector<Metadata *, 4> Ops(Fields.size() * 2 + 1);
170 Type *Int64 = Type::getInt64Ty(Context);
171 Ops[0] = createString(Name);
172 for (unsigned i = 0, e = Fields.size(); i != e; ++i) {
173 Ops[i * 2 + 1] = Fields[i].first;
174 Ops[i * 2 + 2] = createConstant(ConstantInt::get(Int64, Fields[i].second));
176 return MDNode::get(Context, Ops);
179 /// \brief Return metadata for a TBAA scalar type node with the
180 /// given name, an offset and a parent in the TBAA type DAG.
181 MDNode *MDBuilder::createTBAAScalarTypeNode(StringRef Name, MDNode *Parent,
183 ConstantInt *Off = ConstantInt::get(Type::getInt64Ty(Context), Offset);
184 return MDNode::get(Context,
185 {createString(Name), Parent, createConstant(Off)});
188 /// \brief Return metadata for a TBAA tag node with the given
189 /// base type, access type and offset relative to the base type.
190 MDNode *MDBuilder::createTBAAStructTagNode(MDNode *BaseType, MDNode *AccessType,
191 uint64_t Offset, bool IsConstant) {
192 IntegerType *Int64 = Type::getInt64Ty(Context);
193 ConstantInt *Off = ConstantInt::get(Int64, Offset);
195 return MDNode::get(Context, {BaseType, AccessType, createConstant(Off),
196 createConstant(ConstantInt::get(Int64, 1))});
198 return MDNode::get(Context, {BaseType, AccessType, createConstant(Off)});
201 MDNode *MDBuilder::createTBAATypeNode(MDNode *Parent, uint64_t Size,
203 ArrayRef<TBAAStructField> Fields) {
204 SmallVector<Metadata *, 4> Ops(3 + Fields.size() * 3);
205 Type *Int64 = Type::getInt64Ty(Context);
207 Ops[1] = createConstant(ConstantInt::get(Int64, Size));
209 for (unsigned I = 0, E = Fields.size(); I != E; ++I) {
210 Ops[I * 3 + 3] = Fields[I].Type;
211 Ops[I * 3 + 4] = createConstant(ConstantInt::get(Int64, Fields[I].Offset));
212 Ops[I * 3 + 5] = createConstant(ConstantInt::get(Int64, Fields[I].Size));
214 return MDNode::get(Context, Ops);
217 MDNode *MDBuilder::createTBAAAccessTag(MDNode *BaseType, MDNode *AccessType,
218 uint64_t Offset, uint64_t Size,
220 IntegerType *Int64 = Type::getInt64Ty(Context);
221 auto *OffsetNode = createConstant(ConstantInt::get(Int64, Offset));
222 auto *SizeNode = createConstant(ConstantInt::get(Int64, Size));
224 auto *ImmutabilityFlagNode = createConstant(ConstantInt::get(Int64, 1));
225 return MDNode::get(Context, {BaseType, AccessType, OffsetNode, SizeNode,
226 ImmutabilityFlagNode});
228 return MDNode::get(Context, {BaseType, AccessType, OffsetNode, SizeNode});
231 MDNode *MDBuilder::createIrrLoopHeaderWeight(uint64_t Weight) {
232 SmallVector<Metadata *, 2> Vals(2);
233 Vals[0] = createString("loop_header_weight");
234 Vals[1] = createConstant(ConstantInt::get(Type::getInt64Ty(Context), Weight));
235 return MDNode::get(Context, Vals);