LLVM  16.0.0git
MDBuilder.h
Go to the documentation of this file.
1 //===---- llvm/MDBuilder.h - Builder for LLVM metadata ----------*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This file defines the MDBuilder class, which is used as a convenient way to
10 // create LLVM metadata with a consistent and simplified interface.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #ifndef LLVM_IR_MDBUILDER_H
15 #define LLVM_IR_MDBUILDER_H
16 
17 #include "llvm/ADT/DenseSet.h"
18 #include "llvm/ADT/SmallVector.h"
19 #include "llvm/ADT/StringRef.h"
20 #include "llvm/IR/GlobalValue.h"
21 #include "llvm/Support/DataTypes.h"
22 #include <utility>
23 
24 namespace llvm {
25 
26 class APInt;
27 template <typename T> class ArrayRef;
28 class LLVMContext;
29 class Constant;
30 class ConstantAsMetadata;
31 class Function;
32 class MDNode;
33 class MDString;
34 class Metadata;
35 
36 class MDBuilder {
37  LLVMContext &Context;
38 
39 public:
40  MDBuilder(LLVMContext &context) : Context(context) {}
41 
42  /// Return the given string as metadata.
44 
45  /// Return the given constant as metadata.
47 
48  //===------------------------------------------------------------------===//
49  // FPMath metadata.
50  //===------------------------------------------------------------------===//
51 
52  /// Return metadata with the given settings. The special value 0.0
53  /// for the Accuracy parameter indicates the default (maximal precision)
54  /// setting.
55  MDNode *createFPMath(float Accuracy);
56 
57  //===------------------------------------------------------------------===//
58  // Prof metadata.
59  //===------------------------------------------------------------------===//
60 
61  /// Return metadata containing two branch weights.
62  MDNode *createBranchWeights(uint32_t TrueWeight, uint32_t FalseWeight);
63 
64  /// Return metadata containing a number of branch weights.
66 
67  /// Return metadata specifying that a branch or switch is unpredictable.
69 
70  /// Return metadata containing the entry \p Count for a function, a boolean
71  /// \Synthetic indicating whether the counts were synthetized, and the
72  /// GUIDs stored in \p Imports that need to be imported for sample PGO, to
73  /// enable the same inlines as the profiled optimized binary
74  MDNode *createFunctionEntryCount(uint64_t Count, bool Synthetic,
75  const DenseSet<GlobalValue::GUID> *Imports);
76 
77  /// Return metadata containing the section prefix for a function.
79 
80  /// Return metadata containing the pseudo probe descriptor for a function.
82 
83  /// Return metadata containing llvm statistics.
84  MDNode *
85  createLLVMStats(ArrayRef<std::pair<StringRef, uint64_t>> LLVMStatsVec);
86 
87  //===------------------------------------------------------------------===//
88  // Range metadata.
89  //===------------------------------------------------------------------===//
90 
91  /// Return metadata describing the range [Lo, Hi).
92  MDNode *createRange(const APInt &Lo, const APInt &Hi);
93 
94  /// Return metadata describing the range [Lo, Hi).
96 
97  //===------------------------------------------------------------------===//
98  // Callees metadata.
99  //===------------------------------------------------------------------===//
100 
101  /// Return metadata indicating the possible callees of indirect
102  /// calls.
104 
105  //===------------------------------------------------------------------===//
106  // Callback metadata.
107  //===------------------------------------------------------------------===//
108 
109  /// Return metadata describing a callback (see llvm::AbstractCallSite).
110  MDNode *createCallbackEncoding(unsigned CalleeArgNo, ArrayRef<int> Arguments,
111  bool VarArgsArePassed);
112 
113  /// Merge the new callback encoding \p NewCB into \p ExistingCallbacks.
114  MDNode *mergeCallbackEncodings(MDNode *ExistingCallbacks, MDNode *NewCB);
115 
116  /// Return metadata feeding to the CodeGen about how to generate a function
117  /// prologue for the "function" santizier.
118  MDNode *createRTTIPointerPrologue(Constant *PrologueSig, Constant *RTTI);
119 
120  //===------------------------------------------------------------------===//
121  // PC sections metadata.
122  //===------------------------------------------------------------------===//
123 
124  /// A pair of PC section name with auxilliary constant data.
125  using PCSection = std::pair<StringRef, SmallVector<Constant *>>;
126 
127  /// Return metadata for PC sections.
129 
130  //===------------------------------------------------------------------===//
131  // AA metadata.
132  //===------------------------------------------------------------------===//
133 
134 protected:
135  /// Return metadata appropriate for a AA root node (scope or TBAA).
136  /// Each returned node is distinct from all other metadata and will never
137  /// be identified (uniqued) with anything else.
139  MDNode *Extra = nullptr);
140 
141 public:
142  /// Return metadata appropriate for a TBAA root node. Each returned
143  /// node is distinct from all other metadata and will never be identified
144  /// (uniqued) with anything else.
146  return createAnonymousAARoot();
147  }
148 
149  /// Return metadata appropriate for an alias scope domain node.
150  /// Each returned node is distinct from all other metadata and will never
151  /// be identified (uniqued) with anything else.
153  return createAnonymousAARoot(Name);
154  }
155 
156  /// Return metadata appropriate for an alias scope root node.
157  /// Each returned node is distinct from all other metadata and will never
158  /// be identified (uniqued) with anything else.
160  StringRef Name = StringRef()) {
161  return createAnonymousAARoot(Name, Domain);
162  }
163 
164  /// Return metadata appropriate for a TBAA root node with the given
165  /// name. This may be identified (uniqued) with other roots with the same
166  /// name.
168 
169  /// Return metadata appropriate for an alias scope domain node with
170  /// the given name. This may be identified (uniqued) with other roots with
171  /// the same name.
173 
174  /// Return metadata appropriate for an alias scope node with
175  /// the given name. This may be identified (uniqued) with other scopes with
176  /// the same name and domain.
178 
179  /// Return metadata for a non-root TBAA node with the given name,
180  /// parent in the TBAA tree, and value for 'pointsToConstantMemory'.
181  MDNode *createTBAANode(StringRef Name, MDNode *Parent,
182  bool isConstant = false);
183 
189  Offset(Offset), Size(Size), Type(Type) {}
190  };
191 
192  /// Return metadata for a tbaa.struct node with the given
193  /// struct field descriptions.
195 
196  /// Return metadata for a TBAA struct node in the type DAG
197  /// with the given name, a list of pairs (offset, field type in the type DAG).
198  MDNode *
200  ArrayRef<std::pair<MDNode *, uint64_t>> Fields);
201 
202  /// Return metadata for a TBAA scalar type node with the
203  /// given name, an offset and a parent in the TBAA type DAG.
205  uint64_t Offset = 0);
206 
207  /// Return metadata for a TBAA tag node with the given
208  /// base type, access type and offset relative to the base type.
210  uint64_t Offset, bool IsConstant = false);
211 
212  /// Return metadata for a TBAA type node in the TBAA type DAG with the
213  /// given parent type, size in bytes, type identifier and a list of fields.
217 
218  /// Return metadata for a TBAA access tag with the given base type,
219  /// final access type, offset of the access relative to the base type, size of
220  /// the access and flag indicating whether the accessed object can be
221  /// considered immutable for the purposes of the TBAA analysis.
223  uint64_t Offset, uint64_t Size,
224  bool IsImmutable = false);
225 
226  /// Return mutable version of the given mutable or immutable TBAA
227  /// access tag.
229 
230  /// Return metadata containing an irreducible loop header weight.
232 };
233 
234 } // end namespace llvm
235 
236 #endif
llvm::MDBuilder::TBAAStructField::Offset
uint64_t Offset
Definition: MDBuilder.h:185
llvm
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18
llvm::MDBuilder::createConstant
ConstantAsMetadata * createConstant(Constant *C)
Return the given constant as metadata.
Definition: MDBuilder.cpp:24
llvm::MDBuilder::createMutableTBAAAccessTag
MDNode * createMutableTBAAAccessTag(MDNode *Tag)
Return mutable version of the given mutable or immutable TBAA access tag.
Definition: MDBuilder.cpp:303
llvm::MDBuilder::TBAAStructField::Size
uint64_t Size
Definition: MDBuilder.h:186
llvm::MDBuilder::createTBAAStructTypeNode
MDNode * createTBAAStructTypeNode(StringRef Name, ArrayRef< std::pair< MDNode *, uint64_t >> Fields)
Return metadata for a TBAA struct node in the type DAG with the given name, a list of pairs (offset,...
Definition: MDBuilder.cpp:239
llvm::MDBuilder::createFPMath
MDNode * createFPMath(float Accuracy)
Return metadata with the given settings.
Definition: MDBuilder.cpp:28
llvm::MDBuilder::createAliasScopeDomain
MDNode * createAliasScopeDomain(StringRef Name)
Return metadata appropriate for an alias scope domain node with the given name.
Definition: MDBuilder.cpp:216
llvm::cl::Prefix
@ Prefix
Definition: CommandLine.h:161
llvm::Function
Definition: Function.h:60
StringRef.h
llvm::MDBuilder::createPseudoProbeDesc
MDNode * createPseudoProbeDesc(uint64_t GUID, uint64_t Hash, Function *F)
Return metadata containing the pseudo probe descriptor for a function.
Definition: MDBuilder.cpp:338
llvm::MDBuilder::createAliasScope
MDNode * createAliasScope(StringRef Name, MDNode *Domain)
Return metadata appropriate for an alias scope node with the given name.
Definition: MDBuilder.cpp:220
llvm::MDBuilder::createUnpredictable
MDNode * createUnpredictable()
Return metadata specifying that a branch or switch is unpredictable.
Definition: MDBuilder.cpp:55
llvm::Type
The instances of the Type class are immutable: once they are created, they are never changed.
Definition: Type.h:45
llvm::dwarf::Tag
Tag
Definition: Dwarf.h:105
BaseType
llvm::MDBuilder::createAnonymousAliasScope
MDNode * createAnonymousAliasScope(MDNode *Domain, StringRef Name=StringRef())
Return metadata appropriate for an alias scope root node.
Definition: MDBuilder.h:159
llvm::MDBuilder::MDBuilder
MDBuilder(LLVMContext &context)
Definition: MDBuilder.h:40
F
#define F(x, y, z)
Definition: MD5.cpp:55
Context
LLVMContext & Context
Definition: NVVMIntrRange.cpp:66
llvm::MDBuilder::PCSection
std::pair< StringRef, SmallVector< Constant * > > PCSection
A pair of PC section name with auxilliary constant data.
Definition: MDBuilder.h:125
GlobalValue.h
llvm::ISD::Constant
@ Constant
Definition: ISDOpcodes.h:76
llvm::MDBuilder::TBAAStructField::Type
MDNode * Type
Definition: MDBuilder.h:187
llvm::MDBuilder::createAnonymousTBAARoot
MDNode * createAnonymousTBAARoot()
Return metadata appropriate for a TBAA root node.
Definition: MDBuilder.h:145
C
(vector float) vec_cmpeq(*A, *B) C
Definition: README_ALTIVEC.txt:86
llvm::MDBuilder::createBranchWeights
MDNode * createBranchWeights(uint32_t TrueWeight, uint32_t FalseWeight)
Return metadata containing two branch weights.
Definition: MDBuilder.cpp:37
llvm::MDBuilder::createTBAANode
MDNode * createTBAANode(StringRef Name, MDNode *Parent, bool isConstant=false)
Return metadata for a non-root TBAA node with the given name, parent in the TBAA tree,...
Definition: MDBuilder.cpp:206
Domain
Domain
Definition: CorrelatedValuePropagation.cpp:709
DenseSet.h
llvm::MDBuilder::TBAAStructField::TBAAStructField
TBAAStructField(uint64_t Offset, uint64_t Size, MDNode *Type)
Definition: MDBuilder.h:188
llvm::MDBuilder::createTBAAStructTagNode
MDNode * createTBAAStructTagNode(MDNode *BaseType, MDNode *AccessType, uint64_t Offset, bool IsConstant=false)
Return metadata for a TBAA tag node with the given base type, access type and offset relative to the ...
Definition: MDBuilder.cpp:262
llvm::Metadata
Root of the metadata hierarchy.
Definition: Metadata.h:62
llvm::MDBuilder::createAnonymousAliasScopeDomain
MDNode * createAnonymousAliasScopeDomain(StringRef Name=StringRef())
Return metadata appropriate for an alias scope domain node.
Definition: MDBuilder.h:152
llvm::MDBuilder::mergeCallbackEncodings
MDNode * mergeCallbackEncodings(MDNode *ExistingCallbacks, MDNode *NewCB)
Merge the new callback encoding NewCB into ExistingCallbacks.
Definition: MDBuilder.cpp:124
llvm::MDBuilder::createString
MDString * createString(StringRef Str)
Return the given string as metadata.
Definition: MDBuilder.cpp:20
llvm::DenseSet
Implements a dense probed hash-table based set.
Definition: DenseSet.h:268
llvm::MDBuilder::createPCSections
MDNode * createPCSections(ArrayRef< PCSection > Sections)
Return metadata for PC sections.
Definition: MDBuilder.cpp:161
llvm::Constant
This is an important base class in LLVM.
Definition: Constant.h:41
llvm::MDBuilder::createLLVMStats
MDNode * createLLVMStats(ArrayRef< std::pair< StringRef, uint64_t >> LLVMStatsVec)
Return metadata containing llvm statistics.
Definition: MDBuilder.cpp:349
uint64_t
llvm::LLVMContext
This is an important class for using LLVM in a threaded context.
Definition: LLVMContext.h:67
isConstant
static bool isConstant(const MachineInstr &MI)
Definition: AMDGPUInstructionSelector.cpp:2605
llvm::MDBuilder::createTBAAAccessTag
MDNode * createTBAAAccessTag(MDNode *BaseType, MDNode *AccessType, uint64_t Offset, uint64_t Size, bool IsImmutable=false)
Return metadata for a TBAA access tag with the given base type, final access type,...
Definition: MDBuilder.cpp:289
llvm::MDBuilder::createCallbackEncoding
MDNode * createCallbackEncoding(unsigned CalleeArgNo, ArrayRef< int > Arguments, bool VarArgsArePassed)
Return metadata describing a callback (see llvm::AbstractCallSite).
Definition: MDBuilder.cpp:107
llvm::MDNode
Metadata node.
Definition: Metadata.h:944
llvm::APInt
Class for arbitrary precision integers.
Definition: APInt.h:75
llvm::ArrayRef< uint32_t >
llvm::StringRef
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:50
uint32_t
llvm::MDBuilder::createFunctionSectionPrefix
MDNode * createFunctionSectionPrefix(StringRef Prefix)
Return metadata containing the section prefix for a function.
Definition: MDBuilder.cpp:78
llvm::MDBuilder::createAnonymousAARoot
MDNode * createAnonymousAARoot(StringRef Name=StringRef(), MDNode *Extra=nullptr)
Return metadata appropriate for a AA root node (scope or TBAA).
Definition: MDBuilder.cpp:182
llvm::ConstantAsMetadata
Definition: Metadata.h:413
llvm::MDBuilder::createTBAAStructNode
MDNode * createTBAAStructNode(ArrayRef< TBAAStructField > Fields)
Return metadata for a tbaa.struct node with the given struct field descriptions.
Definition: MDBuilder.cpp:226
llvm::MDBuilder::TBAAStructField
Definition: MDBuilder.h:184
Arguments
AMDGPU Lower Kernel Arguments
Definition: AMDGPULowerKernelArguments.cpp:242
llvm::MDBuilder::createTBAAScalarTypeNode
MDNode * createTBAAScalarTypeNode(StringRef Name, MDNode *Parent, uint64_t Offset=0)
Return metadata for a TBAA scalar type node with the given name, an offset and a parent in the TBAA t...
Definition: MDBuilder.cpp:253
llvm::MDBuilder
Definition: MDBuilder.h:36
SmallVector.h
llvm::MDBuilder::createTBAARoot
MDNode * createTBAARoot(StringRef Name)
Return metadata appropriate for a TBAA root node with the given name.
Definition: MDBuilder.cpp:200
llvm::MDBuilder::createCallees
MDNode * createCallees(ArrayRef< Function * > Callees)
Return metadata indicating the possible callees of indirect calls.
Definition: MDBuilder.cpp:100
llvm::MDBuilder::createRange
MDNode * createRange(const APInt &Lo, const APInt &Hi)
Return metadata describing the range [Lo, Hi).
Definition: MDBuilder.cpp:84
LineType::Metadata
@ Metadata
DataTypes.h
llvm::MDBuilder::createTBAATypeNode
MDNode * createTBAATypeNode(MDNode *Parent, uint64_t Size, Metadata *Id, ArrayRef< TBAAStructField > Fields=ArrayRef< TBAAStructField >())
Return metadata for a TBAA type node in the TBAA type DAG with the given parent type,...
Definition: MDBuilder.cpp:273
llvm::AMDGPU::VGPRIndexMode::Id
Id
Definition: SIDefines.h:241
llvm::MDBuilder::createRTTIPointerPrologue
MDNode * createRTTIPointerPrologue(Constant *PrologueSig, Constant *RTTI)
Return metadata feeding to the CodeGen about how to generate a function prologue for the "function" s...
Definition: MDBuilder.cpp:153
llvm::MDString
A single uniqued string.
Definition: Metadata.h:612
llvm::MDBuilder::createFunctionEntryCount
MDNode * createFunctionEntryCount(uint64_t Count, bool Synthetic, const DenseSet< GlobalValue::GUID > *Imports)
Return metadata containing the entry Count for a function, a boolean \Synthetic indicating whether th...
Definition: MDBuilder.cpp:59
llvm::codeview::PublicSymFlags::Function
@ Function
llvm::MDBuilder::createIrrLoopHeaderWeight
MDNode * createIrrLoopHeaderWeight(uint64_t Weight)
Return metadata containing an irreducible loop header weight.
Definition: MDBuilder.cpp:330