lib/IR/MDBuilder.cpp

   1 //===---- llvm/MDBuilder.cpp - Builder for LLVM metadata ------------------===//
   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 #include "llvm/IR/MDBuilder.h"
  16 #include "llvm/IR/Constants.h"
  17 #include "llvm/IR/Metadata.h"
  18 using namespace llvm;
  19
  20 MDString *MDBuilder::createString(StringRef Str) {
  21   return MDString::get(Context, Str);
  22 }
  23
  24 ConstantAsMetadata *MDBuilder::createConstant(Constant *C) {
  25   return ConstantAsMetadata::get(C);
  26 }
  27
  28 MDNode *MDBuilder::createFPMath(float Accuracy) {
  29   if (Accuracy == 0.0)
  30     return nullptr;
  31   assert(Accuracy > 0.0 && "Invalid fpmath accuracy!");
  32   auto *Op =
  33       createConstant(ConstantFP::get(Type::getFloatTy(Context), Accuracy));
  34   return MDNode::get(Context, Op);
  35 }
  36
  37 MDNode *MDBuilder::createBranchWeights(uint32_t TrueWeight,
  38                                        uint32_t FalseWeight) {
  39   uint32_t Weights[] = {TrueWeight, FalseWeight};
  40   return createBranchWeights(Weights);
  41 }
  42
  43 MDNode *MDBuilder::createBranchWeights(ArrayRef<uint32_t> Weights) {
  44   assert(Weights.size() >= 2 && "Need at least two branch weights!");
  45
  46   SmallVector<Metadata *, 4> Vals(Weights.size() + 1);
  47   Vals[0] = createString("branch_weights");
  48
  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]));
  52
  53   return MDNode::get(Context, Vals);
  54 }
  55
  56 MDNode *MDBuilder::createUnpredictable() {
  57   return MDNode::get(Context, None);
  58 }
  59
  60 MDNode *MDBuilder::createFunctionEntryCount(uint64_t Count) {
  61   SmallVector<Metadata *, 2> Vals(2);
  62   Vals[0] = createString("function_entry_count");
  63
  64   Type *Int64Ty = Type::getInt64Ty(Context);
  65   Vals[1] = createConstant(ConstantInt::get(Int64Ty, Count));
  66
  67   return MDNode::get(Context, Vals);
  68 }
  69
  70 MDNode *MDBuilder::createRange(const APInt &Lo, const APInt &Hi) {
  71   assert(Lo.getBitWidth() == Hi.getBitWidth() && "Mismatched bitwidths!");
  72
  73   Type *Ty = IntegerType::get(Context, Lo.getBitWidth());
  74   return createRange(ConstantInt::get(Ty, Lo), ConstantInt::get(Ty, Hi));
  75 }
  76
  77 MDNode *MDBuilder::createRange(Constant *Lo, Constant *Hi) {
  78   // If the range is everything then it is useless.
  79   if (Hi == Lo)
  80     return nullptr;
  81
  82   // Return the range [Lo, Hi).
  83   Metadata *Range[2] = {createConstant(Lo), createConstant(Hi)};
  84   return MDNode::get(Context, Range);
  85 }
  86
  87 MDNode *MDBuilder::createAnonymousAARoot(StringRef Name, MDNode *Extra) {
  88   // To ensure uniqueness the root node is self-referential.
  89   auto Dummy = MDNode::getTemporary(Context, None);
  90
  91   SmallVector<Metadata *, 3> Args(1, Dummy.get());
  92   if (Extra)
  93     Args.push_back(Extra);
  94   if (!Name.empty())
  95     Args.push_back(createString(Name));
  96   MDNode *Root = MDNode::get(Context, Args);
  97
  98   // At this point we have
  99   //   !0 = metadata !{}            <- dummy
 100   //   !1 = metadata !{metadata !0} <- root
 101   // Replace the dummy operand with the root node itself and delete the dummy.
 102   Root->replaceOperandWith(0, Root);
 103
 104   // We now have
 105   //   !1 = metadata !{metadata !1} <- self-referential root
 106   return Root;
 107 }
 108
 109 MDNode *MDBuilder::createTBAARoot(StringRef Name) {
 110   return MDNode::get(Context, createString(Name));
 111 }
 112
 113 /// \brief Return metadata for a non-root TBAA node with the given name,
 114 /// parent in the TBAA tree, and value for 'pointsToConstantMemory'.
 115 MDNode *MDBuilder::createTBAANode(StringRef Name, MDNode *Parent,
 116                                   bool isConstant) {
 117   if (isConstant) {
 118     Constant *Flags = ConstantInt::get(Type::getInt64Ty(Context), 1);
 119     Metadata *Ops[3] = {createString(Name), Parent, createConstant(Flags)};
 120     return MDNode::get(Context, Ops);
 121   } else {
 122     Metadata *Ops[2] = {createString(Name), Parent};
 123     return MDNode::get(Context, Ops);
 124   }
 125 }
 126
 127 MDNode *MDBuilder::createAliasScopeDomain(StringRef Name) {
 128   return MDNode::get(Context, createString(Name));
 129 }
 130
 131 MDNode *MDBuilder::createAliasScope(StringRef Name, MDNode *Domain) {
 132   Metadata *Ops[2] = {createString(Name), Domain};
 133   return MDNode::get(Context, Ops);
 134 }
 135
 136 /// \brief Return metadata for a tbaa.struct node with the given
 137 /// struct field descriptions.
 138 MDNode *MDBuilder::createTBAAStructNode(ArrayRef<TBAAStructField> Fields) {
 139   SmallVector<Metadata *, 4> Vals(Fields.size() * 3);
 140   Type *Int64 = Type::getInt64Ty(Context);
 141   for (unsigned i = 0, e = Fields.size(); i != e; ++i) {
 142     Vals[i * 3 + 0] = createConstant(ConstantInt::get(Int64, Fields[i].Offset));
 143     Vals[i * 3 + 1] = createConstant(ConstantInt::get(Int64, Fields[i].Size));
 144     Vals[i * 3 + 2] = Fields[i].TBAA;
 145   }
 146   return MDNode::get(Context, Vals);
 147 }
 148
 149 /// \brief Return metadata for a TBAA struct node in the type DAG
 150 /// with the given name, a list of pairs (offset, field type in the type DAG).
 151 MDNode *MDBuilder::createTBAAStructTypeNode(
 152     StringRef Name, ArrayRef<std::pair<MDNode *, uint64_t>> Fields) {
 153   SmallVector<Metadata *, 4> Ops(Fields.size() * 2 + 1);
 154   Type *Int64 = Type::getInt64Ty(Context);
 155   Ops[0] = createString(Name);
 156   for (unsigned i = 0, e = Fields.size(); i != e; ++i) {
 157     Ops[i * 2 + 1] = Fields[i].first;
 158     Ops[i * 2 + 2] = createConstant(ConstantInt::get(Int64, Fields[i].second));
 159   }
 160   return MDNode::get(Context, Ops);
 161 }
 162
 163 /// \brief Return metadata for a TBAA scalar type node with the
 164 /// given name, an offset and a parent in the TBAA type DAG.
 165 MDNode *MDBuilder::createTBAAScalarTypeNode(StringRef Name, MDNode *Parent,
 166                                             uint64_t Offset) {
 167   ConstantInt *Off = ConstantInt::get(Type::getInt64Ty(Context), Offset);
 168   Metadata *Ops[3] = {createString(Name), Parent, createConstant(Off)};
 169   return MDNode::get(Context, Ops);
 170 }
 171
 172 /// \brief Return metadata for a TBAA tag node with the given
 173 /// base type, access type and offset relative to the base type.
 174 MDNode *MDBuilder::createTBAAStructTagNode(MDNode *BaseType, MDNode *AccessType,
 175                                            uint64_t Offset, bool IsConstant) {
 176   Type *Int64 = Type::getInt64Ty(Context);
 177   if (IsConstant) {
 178     Metadata *Ops[4] = {BaseType, AccessType,
 179                         createConstant(ConstantInt::get(Int64, Offset)),
 180                         createConstant(ConstantInt::get(Int64, 1))};
 181     return MDNode::get(Context, Ops);
 182   } else {
 183     Metadata *Ops[3] = {BaseType, AccessType,
 184                         createConstant(ConstantInt::get(Int64, Offset))};
 185     return MDNode::get(Context, Ops);
 186   }
 187 }