1dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines//===---- llvm/MDBuilder.cpp - Builder for LLVM metadata ------------------===// 2dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines// 3dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines// The LLVM Compiler Infrastructure 4dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines// 5dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines// This file is distributed under the University of Illinois Open Source 6dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines// License. See LICENSE.TXT for details. 7dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines// 8dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines//===----------------------------------------------------------------------===// 9dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines// 10dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines// This file defines the MDBuilder class, which is used as a convenient way to 11dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines// create LLVM metadata with a consistent and simplified interface. 12dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines// 13dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines//===----------------------------------------------------------------------===// 14dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines 15dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines#include "llvm/IR/MDBuilder.h" 16dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines#include "llvm/IR/Constants.h" 17dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines#include "llvm/IR/Metadata.h" 18dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hinesusing namespace llvm; 19dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines 20dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen HinesMDString *MDBuilder::createString(StringRef Str) { 21dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines return MDString::get(Context, Str); 22dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines} 23dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines 24ebe69fe11e48d322045d5949c83283927a0d790bStephen HinesConstantAsMetadata *MDBuilder::createConstant(Constant *C) { 25ebe69fe11e48d322045d5949c83283927a0d790bStephen Hines return ConstantAsMetadata::get(C); 26ebe69fe11e48d322045d5949c83283927a0d790bStephen Hines} 27ebe69fe11e48d322045d5949c83283927a0d790bStephen Hines 28dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen HinesMDNode *MDBuilder::createFPMath(float Accuracy) { 29dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines if (Accuracy == 0.0) 30dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines return nullptr; 31dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines assert(Accuracy > 0.0 && "Invalid fpmath accuracy!"); 32ebe69fe11e48d322045d5949c83283927a0d790bStephen Hines auto *Op = 33ebe69fe11e48d322045d5949c83283927a0d790bStephen Hines createConstant(ConstantFP::get(Type::getFloatTy(Context), Accuracy)); 34dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines return MDNode::get(Context, Op); 35dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines} 36dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines 37dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen HinesMDNode *MDBuilder::createBranchWeights(uint32_t TrueWeight, 38dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines uint32_t FalseWeight) { 39cddc3e03e4ec99c0268c03a126195173e519ed58Pirama Arumuga Nainar return createBranchWeights({TrueWeight, FalseWeight}); 40dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines} 41dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines 42dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen HinesMDNode *MDBuilder::createBranchWeights(ArrayRef<uint32_t> Weights) { 43dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines assert(Weights.size() >= 2 && "Need at least two branch weights!"); 44dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines 45ebe69fe11e48d322045d5949c83283927a0d790bStephen Hines SmallVector<Metadata *, 4> Vals(Weights.size() + 1); 46dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines Vals[0] = createString("branch_weights"); 47dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines 48dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines Type *Int32Ty = Type::getInt32Ty(Context); 49dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines for (unsigned i = 0, e = Weights.size(); i != e; ++i) 50ebe69fe11e48d322045d5949c83283927a0d790bStephen Hines Vals[i + 1] = createConstant(ConstantInt::get(Int32Ty, Weights[i])); 51dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines 52dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines return MDNode::get(Context, Vals); 53dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines} 54dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines 55cddc3e03e4ec99c0268c03a126195173e519ed58Pirama Arumuga NainarMDNode *MDBuilder::createUnpredictable() { 56cddc3e03e4ec99c0268c03a126195173e519ed58Pirama Arumuga Nainar return MDNode::get(Context, None); 57cddc3e03e4ec99c0268c03a126195173e519ed58Pirama Arumuga Nainar} 586948897e478cbd66626159776a8017b3c18579b9Pirama Arumuga Nainar 59cddc3e03e4ec99c0268c03a126195173e519ed58Pirama Arumuga NainarMDNode *MDBuilder::createFunctionEntryCount(uint64_t Count) { 606948897e478cbd66626159776a8017b3c18579b9Pirama Arumuga Nainar Type *Int64Ty = Type::getInt64Ty(Context); 61cddc3e03e4ec99c0268c03a126195173e519ed58Pirama Arumuga Nainar return MDNode::get(Context, 62cddc3e03e4ec99c0268c03a126195173e519ed58Pirama Arumuga Nainar {createString("function_entry_count"), 63cddc3e03e4ec99c0268c03a126195173e519ed58Pirama Arumuga Nainar createConstant(ConstantInt::get(Int64Ty, Count))}); 646948897e478cbd66626159776a8017b3c18579b9Pirama Arumuga Nainar} 656948897e478cbd66626159776a8017b3c18579b9Pirama Arumuga Nainar 66dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen HinesMDNode *MDBuilder::createRange(const APInt &Lo, const APInt &Hi) { 67dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines assert(Lo.getBitWidth() == Hi.getBitWidth() && "Mismatched bitwidths!"); 68ebe69fe11e48d322045d5949c83283927a0d790bStephen Hines 69ebe69fe11e48d322045d5949c83283927a0d790bStephen Hines Type *Ty = IntegerType::get(Context, Lo.getBitWidth()); 70ebe69fe11e48d322045d5949c83283927a0d790bStephen Hines return createRange(ConstantInt::get(Ty, Lo), ConstantInt::get(Ty, Hi)); 71ebe69fe11e48d322045d5949c83283927a0d790bStephen Hines} 72ebe69fe11e48d322045d5949c83283927a0d790bStephen Hines 73ebe69fe11e48d322045d5949c83283927a0d790bStephen HinesMDNode *MDBuilder::createRange(Constant *Lo, Constant *Hi) { 74dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines // If the range is everything then it is useless. 75dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines if (Hi == Lo) 76dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines return nullptr; 77dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines 78dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines // Return the range [Lo, Hi). 79cddc3e03e4ec99c0268c03a126195173e519ed58Pirama Arumuga Nainar return MDNode::get(Context, {createConstant(Lo), createConstant(Hi)}); 80dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines} 81dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines 8237ed9c199ca639565f6ce88105f9e39e898d82d0Stephen HinesMDNode *MDBuilder::createAnonymousAARoot(StringRef Name, MDNode *Extra) { 83dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines // To ensure uniqueness the root node is self-referential. 84ebe69fe11e48d322045d5949c83283927a0d790bStephen Hines auto Dummy = MDNode::getTemporary(Context, None); 8537ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines 86ebe69fe11e48d322045d5949c83283927a0d790bStephen Hines SmallVector<Metadata *, 3> Args(1, Dummy.get()); 8737ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines if (Extra) 8837ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines Args.push_back(Extra); 8937ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines if (!Name.empty()) 9037ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines Args.push_back(createString(Name)); 9137ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines MDNode *Root = MDNode::get(Context, Args); 9237ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines 93dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines // At this point we have 94dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines // !0 = metadata !{} <- dummy 95dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines // !1 = metadata !{metadata !0} <- root 96dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines // Replace the dummy operand with the root node itself and delete the dummy. 97dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines Root->replaceOperandWith(0, Root); 98ebe69fe11e48d322045d5949c83283927a0d790bStephen Hines 99dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines // We now have 100dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines // !1 = metadata !{metadata !1} <- self-referential root 101dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines return Root; 102dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines} 103dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines 104dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen HinesMDNode *MDBuilder::createTBAARoot(StringRef Name) { 105dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines return MDNode::get(Context, createString(Name)); 106dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines} 107dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines 108dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines/// \brief Return metadata for a non-root TBAA node with the given name, 109dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines/// parent in the TBAA tree, and value for 'pointsToConstantMemory'. 110dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen HinesMDNode *MDBuilder::createTBAANode(StringRef Name, MDNode *Parent, 111dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines bool isConstant) { 112dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines if (isConstant) { 113dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines Constant *Flags = ConstantInt::get(Type::getInt64Ty(Context), 1); 114cddc3e03e4ec99c0268c03a126195173e519ed58Pirama Arumuga Nainar return MDNode::get(Context, 115cddc3e03e4ec99c0268c03a126195173e519ed58Pirama Arumuga Nainar {createString(Name), Parent, createConstant(Flags)}); 116dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines } 117cddc3e03e4ec99c0268c03a126195173e519ed58Pirama Arumuga Nainar return MDNode::get(Context, {createString(Name), Parent}); 118dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines} 119dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines 12037ed9c199ca639565f6ce88105f9e39e898d82d0Stephen HinesMDNode *MDBuilder::createAliasScopeDomain(StringRef Name) { 12137ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines return MDNode::get(Context, createString(Name)); 12237ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines} 12337ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines 12437ed9c199ca639565f6ce88105f9e39e898d82d0Stephen HinesMDNode *MDBuilder::createAliasScope(StringRef Name, MDNode *Domain) { 125cddc3e03e4ec99c0268c03a126195173e519ed58Pirama Arumuga Nainar return MDNode::get(Context, {createString(Name), Domain}); 12637ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines} 12737ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines 128dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines/// \brief Return metadata for a tbaa.struct node with the given 129dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines/// struct field descriptions. 130dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen HinesMDNode *MDBuilder::createTBAAStructNode(ArrayRef<TBAAStructField> Fields) { 131ebe69fe11e48d322045d5949c83283927a0d790bStephen Hines SmallVector<Metadata *, 4> Vals(Fields.size() * 3); 132dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines Type *Int64 = Type::getInt64Ty(Context); 133dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines for (unsigned i = 0, e = Fields.size(); i != e; ++i) { 134ebe69fe11e48d322045d5949c83283927a0d790bStephen Hines Vals[i * 3 + 0] = createConstant(ConstantInt::get(Int64, Fields[i].Offset)); 135ebe69fe11e48d322045d5949c83283927a0d790bStephen Hines Vals[i * 3 + 1] = createConstant(ConstantInt::get(Int64, Fields[i].Size)); 136dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines Vals[i * 3 + 2] = Fields[i].TBAA; 137dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines } 138dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines return MDNode::get(Context, Vals); 139dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines} 140dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines 141dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines/// \brief Return metadata for a TBAA struct node in the type DAG 142dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines/// with the given name, a list of pairs (offset, field type in the type DAG). 143dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen HinesMDNode *MDBuilder::createTBAAStructTypeNode( 144dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines StringRef Name, ArrayRef<std::pair<MDNode *, uint64_t>> Fields) { 145ebe69fe11e48d322045d5949c83283927a0d790bStephen Hines SmallVector<Metadata *, 4> Ops(Fields.size() * 2 + 1); 146dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines Type *Int64 = Type::getInt64Ty(Context); 147dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines Ops[0] = createString(Name); 148dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines for (unsigned i = 0, e = Fields.size(); i != e; ++i) { 149dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines Ops[i * 2 + 1] = Fields[i].first; 150ebe69fe11e48d322045d5949c83283927a0d790bStephen Hines Ops[i * 2 + 2] = createConstant(ConstantInt::get(Int64, Fields[i].second)); 151dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines } 152dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines return MDNode::get(Context, Ops); 153dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines} 154dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines 155dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines/// \brief Return metadata for a TBAA scalar type node with the 156dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines/// given name, an offset and a parent in the TBAA type DAG. 157dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen HinesMDNode *MDBuilder::createTBAAScalarTypeNode(StringRef Name, MDNode *Parent, 158dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines uint64_t Offset) { 159dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines ConstantInt *Off = ConstantInt::get(Type::getInt64Ty(Context), Offset); 160cddc3e03e4ec99c0268c03a126195173e519ed58Pirama Arumuga Nainar return MDNode::get(Context, 161cddc3e03e4ec99c0268c03a126195173e519ed58Pirama Arumuga Nainar {createString(Name), Parent, createConstant(Off)}); 162dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines} 163dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines 164dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines/// \brief Return metadata for a TBAA tag node with the given 165dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines/// base type, access type and offset relative to the base type. 166dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen HinesMDNode *MDBuilder::createTBAAStructTagNode(MDNode *BaseType, MDNode *AccessType, 1676948897e478cbd66626159776a8017b3c18579b9Pirama Arumuga Nainar uint64_t Offset, bool IsConstant) { 168cddc3e03e4ec99c0268c03a126195173e519ed58Pirama Arumuga Nainar IntegerType *Int64 = Type::getInt64Ty(Context); 169cddc3e03e4ec99c0268c03a126195173e519ed58Pirama Arumuga Nainar ConstantInt *Off = ConstantInt::get(Int64, Offset); 1706948897e478cbd66626159776a8017b3c18579b9Pirama Arumuga Nainar if (IsConstant) { 171cddc3e03e4ec99c0268c03a126195173e519ed58Pirama Arumuga Nainar return MDNode::get(Context, {BaseType, AccessType, createConstant(Off), 172cddc3e03e4ec99c0268c03a126195173e519ed58Pirama Arumuga Nainar createConstant(ConstantInt::get(Int64, 1))}); 1736948897e478cbd66626159776a8017b3c18579b9Pirama Arumuga Nainar } 174cddc3e03e4ec99c0268c03a126195173e519ed58Pirama Arumuga Nainar return MDNode::get(Context, {BaseType, AccessType, createConstant(Off)}); 175dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines} 176