1 //===---- llvm/MDBuilder.h - Builder for LLVM metadata ----------*- C++ -*-===//
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 #ifndef LLVM_IR_MDBUILDER_H
16 #define LLVM_IR_MDBUILDER_H
18 #include "llvm/ADT/StringRef.h"
19 #include "llvm/Support/DataTypes.h"
25 template <typename T> class ArrayRef;
28 class ConstantAsMetadata;
36 MDBuilder(LLVMContext &context) : Context(context) {}
38 /// \brief Return the given string as metadata.
39 MDString *createString(StringRef Str);
41 /// \brief Return the given constant as metadata.
42 ConstantAsMetadata *createConstant(Constant *C);
44 //===------------------------------------------------------------------===//
46 //===------------------------------------------------------------------===//
48 /// \brief Return metadata with the given settings. The special value 0.0
49 /// for the Accuracy parameter indicates the default (maximal precision)
51 MDNode *createFPMath(float Accuracy);
53 //===------------------------------------------------------------------===//
55 //===------------------------------------------------------------------===//
57 /// \brief Return metadata containing two branch weights.
58 MDNode *createBranchWeights(uint32_t TrueWeight, uint32_t FalseWeight);
60 /// \brief Return metadata containing a number of branch weights.
61 MDNode *createBranchWeights(ArrayRef<uint32_t> Weights);
63 /// Return metadata specifying that a branch or switch is unpredictable.
64 MDNode *createUnpredictable();
66 /// Return metadata containing the entry count for a function.
67 MDNode *createFunctionEntryCount(uint64_t Count);
69 /// Return metadata containing the section prefix for a function.
70 MDNode *createFunctionSectionPrefix(StringRef Prefix);
72 //===------------------------------------------------------------------===//
74 //===------------------------------------------------------------------===//
76 /// \brief Return metadata describing the range [Lo, Hi).
77 MDNode *createRange(const APInt &Lo, const APInt &Hi);
79 /// \brief Return metadata describing the range [Lo, Hi).
80 MDNode *createRange(Constant *Lo, Constant *Hi);
82 //===------------------------------------------------------------------===//
84 //===------------------------------------------------------------------===//
87 /// \brief Return metadata appropriate for a AA root node (scope or TBAA).
88 /// Each returned node is distinct from all other metadata and will never
89 /// be identified (uniqued) with anything else.
90 MDNode *createAnonymousAARoot(StringRef Name = StringRef(),
91 MDNode *Extra = nullptr);
94 /// \brief Return metadata appropriate for a TBAA root node. Each returned
95 /// node is distinct from all other metadata and will never be identified
96 /// (uniqued) with anything else.
97 MDNode *createAnonymousTBAARoot() {
98 return createAnonymousAARoot();
101 /// \brief Return metadata appropriate for an alias scope domain node.
102 /// Each returned node is distinct from all other metadata and will never
103 /// be identified (uniqued) with anything else.
104 MDNode *createAnonymousAliasScopeDomain(StringRef Name = StringRef()) {
105 return createAnonymousAARoot(Name);
108 /// \brief Return metadata appropriate for an alias scope root node.
109 /// Each returned node is distinct from all other metadata and will never
110 /// be identified (uniqued) with anything else.
111 MDNode *createAnonymousAliasScope(MDNode *Domain,
112 StringRef Name = StringRef()) {
113 return createAnonymousAARoot(Name, Domain);
116 /// \brief Return metadata appropriate for a TBAA root node with the given
117 /// name. This may be identified (uniqued) with other roots with the same
119 MDNode *createTBAARoot(StringRef Name);
121 /// \brief Return metadata appropriate for an alias scope domain node with
122 /// the given name. This may be identified (uniqued) with other roots with
124 MDNode *createAliasScopeDomain(StringRef Name);
126 /// \brief Return metadata appropriate for an alias scope node with
127 /// the given name. This may be identified (uniqued) with other scopes with
128 /// the same name and domain.
129 MDNode *createAliasScope(StringRef Name, MDNode *Domain);
131 /// \brief Return metadata for a non-root TBAA node with the given name,
132 /// parent in the TBAA tree, and value for 'pointsToConstantMemory'.
133 MDNode *createTBAANode(StringRef Name, MDNode *Parent,
134 bool isConstant = false);
136 struct TBAAStructField {
140 TBAAStructField(uint64_t Offset, uint64_t Size, MDNode *TBAA) :
141 Offset(Offset), Size(Size), TBAA(TBAA) {}
144 /// \brief Return metadata for a tbaa.struct node with the given
145 /// struct field descriptions.
146 MDNode *createTBAAStructNode(ArrayRef<TBAAStructField> Fields);
148 /// \brief Return metadata for a TBAA struct node in the type DAG
149 /// with the given name, a list of pairs (offset, field type in the type DAG).
151 createTBAAStructTypeNode(StringRef Name,
152 ArrayRef<std::pair<MDNode *, uint64_t>> Fields);
154 /// \brief Return metadata for a TBAA scalar type node with the
155 /// given name, an offset and a parent in the TBAA type DAG.
156 MDNode *createTBAAScalarTypeNode(StringRef Name, MDNode *Parent,
157 uint64_t Offset = 0);
159 /// \brief Return metadata for a TBAA tag node with the given
160 /// base type, access type and offset relative to the base type.
161 MDNode *createTBAAStructTagNode(MDNode *BaseType, MDNode *AccessType,
162 uint64_t Offset, bool IsConstant = false);
165 } // end namespace llvm