LLVM  9.0.0svn
IRBuilder.cpp
Go to the documentation of this file.
1 //===- IRBuilder.cpp - Builder for LLVM Instrs ----------------------------===//
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 implements the IRBuilder class, which is used as a convenient way
10 // to create LLVM instructions with a consistent and simplified interface.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #include "llvm/IR/IRBuilder.h"
15 #include "llvm/ADT/ArrayRef.h"
16 #include "llvm/ADT/None.h"
17 #include "llvm/IR/Constant.h"
18 #include "llvm/IR/Constants.h"
19 #include "llvm/IR/DerivedTypes.h"
20 #include "llvm/IR/Function.h"
21 #include "llvm/IR/GlobalValue.h"
22 #include "llvm/IR/GlobalVariable.h"
23 #include "llvm/IR/IntrinsicInst.h"
24 #include "llvm/IR/Intrinsics.h"
25 #include "llvm/IR/LLVMContext.h"
26 #include "llvm/IR/Operator.h"
27 #include "llvm/IR/Statepoint.h"
28 #include "llvm/IR/Type.h"
29 #include "llvm/IR/Value.h"
30 #include "llvm/Support/Casting.h"
32 #include <cassert>
33 #include <cstdint>
34 #include <vector>
35 
36 using namespace llvm;
37 
38 /// CreateGlobalString - Make a new global variable with an initializer that
39 /// has array of i8 type filled in with the nul terminated string value
40 /// specified. If Name is specified, it is the name of the global variable
41 /// created.
43  const Twine &Name,
44  unsigned AddressSpace) {
45  Constant *StrConstant = ConstantDataArray::getString(Context, Str);
46  Module &M = *BB->getParent()->getParent();
47  auto *GV = new GlobalVariable(M, StrConstant->getType(), true,
48  GlobalValue::PrivateLinkage, StrConstant, Name,
50  AddressSpace);
52  GV->setAlignment(1);
53  return GV;
54 }
55 
57  assert(BB && BB->getParent() && "No current function!");
58  return BB->getParent()->getReturnType();
59 }
60 
61 Value *IRBuilderBase::getCastedInt8PtrValue(Value *Ptr) {
62  auto *PT = cast<PointerType>(Ptr->getType());
63  if (PT->getElementType()->isIntegerTy(8))
64  return Ptr;
65 
66  // Otherwise, we need to insert a bitcast.
67  PT = getInt8PtrTy(PT->getAddressSpace());
68  BitCastInst *BCI = new BitCastInst(Ptr, PT, "");
69  BB->getInstList().insert(InsertPt, BCI);
71  return BCI;
72 }
73 
75  IRBuilderBase *Builder,
76  const Twine &Name = "",
77  Instruction *FMFSource = nullptr) {
78  CallInst *CI = CallInst::Create(Callee, Ops, Name);
79  if (FMFSource)
80  CI->copyFastMathFlags(FMFSource);
81  Builder->GetInsertBlock()->getInstList().insert(Builder->GetInsertPoint(),CI);
82  Builder->SetInstDebugLocation(CI);
83  return CI;
84 }
85 
86 static InvokeInst *createInvokeHelper(Function *Invokee, BasicBlock *NormalDest,
87  BasicBlock *UnwindDest,
89  IRBuilderBase *Builder,
90  const Twine &Name = "") {
91  InvokeInst *II =
92  InvokeInst::Create(Invokee, NormalDest, UnwindDest, Ops, Name);
93  Builder->GetInsertBlock()->getInstList().insert(Builder->GetInsertPoint(),
94  II);
95  Builder->SetInstDebugLocation(II);
96  return II;
97 }
98 
100 CreateMemSet(Value *Ptr, Value *Val, Value *Size, unsigned Align,
101  bool isVolatile, MDNode *TBAATag, MDNode *ScopeTag,
102  MDNode *NoAliasTag) {
103  Ptr = getCastedInt8PtrValue(Ptr);
104  Value *Ops[] = {Ptr, Val, Size, getInt1(isVolatile)};
105  Type *Tys[] = { Ptr->getType(), Size->getType() };
106  Module *M = BB->getParent()->getParent();
107  Function *TheFn = Intrinsic::getDeclaration(M, Intrinsic::memset, Tys);
108 
109  CallInst *CI = createCallHelper(TheFn, Ops, this);
110 
111  if (Align > 0)
112  cast<MemSetInst>(CI)->setDestAlignment(Align);
113 
114  // Set the TBAA info if present.
115  if (TBAATag)
116  CI->setMetadata(LLVMContext::MD_tbaa, TBAATag);
117 
118  if (ScopeTag)
120 
121  if (NoAliasTag)
122  CI->setMetadata(LLVMContext::MD_noalias, NoAliasTag);
123 
124  return CI;
125 }
126 
128  Value *Ptr, Value *Val, Value *Size, unsigned Align, uint32_t ElementSize,
129  MDNode *TBAATag, MDNode *ScopeTag, MDNode *NoAliasTag) {
130  assert(Align >= ElementSize &&
131  "Pointer alignment must be at least element size.");
132 
133  Ptr = getCastedInt8PtrValue(Ptr);
134  Value *Ops[] = {Ptr, Val, Size, getInt32(ElementSize)};
135  Type *Tys[] = {Ptr->getType(), Size->getType()};
136  Module *M = BB->getParent()->getParent();
138  M, Intrinsic::memset_element_unordered_atomic, Tys);
139 
140  CallInst *CI = createCallHelper(TheFn, Ops, this);
141 
142  cast<AtomicMemSetInst>(CI)->setDestAlignment(Align);
143 
144  // Set the TBAA info if present.
145  if (TBAATag)
146  CI->setMetadata(LLVMContext::MD_tbaa, TBAATag);
147 
148  if (ScopeTag)
150 
151  if (NoAliasTag)
152  CI->setMetadata(LLVMContext::MD_noalias, NoAliasTag);
153 
154  return CI;
155 }
156 
158 CreateMemCpy(Value *Dst, unsigned DstAlign, Value *Src, unsigned SrcAlign,
159  Value *Size, bool isVolatile, MDNode *TBAATag,
160  MDNode *TBAAStructTag, MDNode *ScopeTag, MDNode *NoAliasTag) {
161  assert((DstAlign == 0 || isPowerOf2_32(DstAlign)) && "Must be 0 or a power of 2");
162  assert((SrcAlign == 0 || isPowerOf2_32(SrcAlign)) && "Must be 0 or a power of 2");
163  Dst = getCastedInt8PtrValue(Dst);
164  Src = getCastedInt8PtrValue(Src);
165 
166  Value *Ops[] = {Dst, Src, Size, getInt1(isVolatile)};
167  Type *Tys[] = { Dst->getType(), Src->getType(), Size->getType() };
168  Module *M = BB->getParent()->getParent();
169  Function *TheFn = Intrinsic::getDeclaration(M, Intrinsic::memcpy, Tys);
170 
171  CallInst *CI = createCallHelper(TheFn, Ops, this);
172 
173  auto* MCI = cast<MemCpyInst>(CI);
174  if (DstAlign > 0)
175  MCI->setDestAlignment(DstAlign);
176  if (SrcAlign > 0)
177  MCI->setSourceAlignment(SrcAlign);
178 
179  // Set the TBAA info if present.
180  if (TBAATag)
181  CI->setMetadata(LLVMContext::MD_tbaa, TBAATag);
182 
183  // Set the TBAA Struct info if present.
184  if (TBAAStructTag)
185  CI->setMetadata(LLVMContext::MD_tbaa_struct, TBAAStructTag);
186 
187  if (ScopeTag)
189 
190  if (NoAliasTag)
191  CI->setMetadata(LLVMContext::MD_noalias, NoAliasTag);
192 
193  return CI;
194 }
195 
197  Value *Dst, unsigned DstAlign, Value *Src, unsigned SrcAlign, Value *Size,
198  uint32_t ElementSize, MDNode *TBAATag, MDNode *TBAAStructTag,
199  MDNode *ScopeTag, MDNode *NoAliasTag) {
200  assert(DstAlign >= ElementSize &&
201  "Pointer alignment must be at least element size");
202  assert(SrcAlign >= ElementSize &&
203  "Pointer alignment must be at least element size");
204  Dst = getCastedInt8PtrValue(Dst);
205  Src = getCastedInt8PtrValue(Src);
206 
207  Value *Ops[] = {Dst, Src, Size, getInt32(ElementSize)};
208  Type *Tys[] = {Dst->getType(), Src->getType(), Size->getType()};
209  Module *M = BB->getParent()->getParent();
211  M, Intrinsic::memcpy_element_unordered_atomic, Tys);
212 
213  CallInst *CI = createCallHelper(TheFn, Ops, this);
214 
215  // Set the alignment of the pointer args.
216  auto *AMCI = cast<AtomicMemCpyInst>(CI);
217  AMCI->setDestAlignment(DstAlign);
218  AMCI->setSourceAlignment(SrcAlign);
219 
220  // Set the TBAA info if present.
221  if (TBAATag)
222  CI->setMetadata(LLVMContext::MD_tbaa, TBAATag);
223 
224  // Set the TBAA Struct info if present.
225  if (TBAAStructTag)
226  CI->setMetadata(LLVMContext::MD_tbaa_struct, TBAAStructTag);
227 
228  if (ScopeTag)
230 
231  if (NoAliasTag)
232  CI->setMetadata(LLVMContext::MD_noalias, NoAliasTag);
233 
234  return CI;
235 }
236 
238 CreateMemMove(Value *Dst, unsigned DstAlign, Value *Src, unsigned SrcAlign,
239  Value *Size, bool isVolatile, MDNode *TBAATag, MDNode *ScopeTag,
240  MDNode *NoAliasTag) {
241  assert((DstAlign == 0 || isPowerOf2_32(DstAlign)) && "Must be 0 or a power of 2");
242  assert((SrcAlign == 0 || isPowerOf2_32(SrcAlign)) && "Must be 0 or a power of 2");
243  Dst = getCastedInt8PtrValue(Dst);
244  Src = getCastedInt8PtrValue(Src);
245 
246  Value *Ops[] = {Dst, Src, Size, getInt1(isVolatile)};
247  Type *Tys[] = { Dst->getType(), Src->getType(), Size->getType() };
248  Module *M = BB->getParent()->getParent();
249  Function *TheFn = Intrinsic::getDeclaration(M, Intrinsic::memmove, Tys);
250 
251  CallInst *CI = createCallHelper(TheFn, Ops, this);
252 
253  auto *MMI = cast<MemMoveInst>(CI);
254  if (DstAlign > 0)
255  MMI->setDestAlignment(DstAlign);
256  if (SrcAlign > 0)
257  MMI->setSourceAlignment(SrcAlign);
258 
259  // Set the TBAA info if present.
260  if (TBAATag)
261  CI->setMetadata(LLVMContext::MD_tbaa, TBAATag);
262 
263  if (ScopeTag)
265 
266  if (NoAliasTag)
267  CI->setMetadata(LLVMContext::MD_noalias, NoAliasTag);
268 
269  return CI;
270 }
271 
273  Value *Dst, unsigned DstAlign, Value *Src, unsigned SrcAlign, Value *Size,
274  uint32_t ElementSize, MDNode *TBAATag, MDNode *TBAAStructTag,
275  MDNode *ScopeTag, MDNode *NoAliasTag) {
276  assert(DstAlign >= ElementSize &&
277  "Pointer alignment must be at least element size");
278  assert(SrcAlign >= ElementSize &&
279  "Pointer alignment must be at least element size");
280  Dst = getCastedInt8PtrValue(Dst);
281  Src = getCastedInt8PtrValue(Src);
282 
283  Value *Ops[] = {Dst, Src, Size, getInt32(ElementSize)};
284  Type *Tys[] = {Dst->getType(), Src->getType(), Size->getType()};
285  Module *M = BB->getParent()->getParent();
287  M, Intrinsic::memmove_element_unordered_atomic, Tys);
288 
289  CallInst *CI = createCallHelper(TheFn, Ops, this);
290 
291  // Set the alignment of the pointer args.
292  CI->addParamAttr(0, Attribute::getWithAlignment(CI->getContext(), DstAlign));
293  CI->addParamAttr(1, Attribute::getWithAlignment(CI->getContext(), SrcAlign));
294 
295  // Set the TBAA info if present.
296  if (TBAATag)
297  CI->setMetadata(LLVMContext::MD_tbaa, TBAATag);
298 
299  // Set the TBAA Struct info if present.
300  if (TBAAStructTag)
301  CI->setMetadata(LLVMContext::MD_tbaa_struct, TBAAStructTag);
302 
303  if (ScopeTag)
305 
306  if (NoAliasTag)
307  CI->setMetadata(LLVMContext::MD_noalias, NoAliasTag);
308 
309  return CI;
310 }
311 
313  Value *Src) {
314  Module *M = Builder->GetInsertBlock()->getParent()->getParent();
315  Value *Ops[] = {Src};
316  Type *Tys[] = { Src->getType()->getVectorElementType(), Src->getType() };
317  auto Decl = Intrinsic::getDeclaration(M, ID, Tys);
318  return createCallHelper(Decl, Ops, Builder);
319 }
320 
323  Value *Ops[] = {Acc, Src};
324  Type *Tys[] = {Acc->getType(), Src->getType()};
325  auto Decl = Intrinsic::getDeclaration(
326  M, Intrinsic::experimental_vector_reduce_fadd, Tys);
327  return createCallHelper(Decl, Ops, this);
328 }
329 
332  Value *Ops[] = {Acc, Src};
333  Type *Tys[] = {Acc->getType(), Src->getType()};
334  auto Decl = Intrinsic::getDeclaration(
335  M, Intrinsic::experimental_vector_reduce_fmul, Tys);
336  return createCallHelper(Decl, Ops, this);
337 }
338 
340  return getReductionIntrinsic(this, Intrinsic::experimental_vector_reduce_add,
341  Src);
342 }
343 
345  return getReductionIntrinsic(this, Intrinsic::experimental_vector_reduce_mul,
346  Src);
347 }
348 
350  return getReductionIntrinsic(this, Intrinsic::experimental_vector_reduce_and,
351  Src);
352 }
353 
355  return getReductionIntrinsic(this, Intrinsic::experimental_vector_reduce_or,
356  Src);
357 }
358 
360  return getReductionIntrinsic(this, Intrinsic::experimental_vector_reduce_xor,
361  Src);
362 }
363 
365  auto ID = IsSigned ? Intrinsic::experimental_vector_reduce_smax
366  : Intrinsic::experimental_vector_reduce_umax;
367  return getReductionIntrinsic(this, ID, Src);
368 }
369 
371  auto ID = IsSigned ? Intrinsic::experimental_vector_reduce_smin
372  : Intrinsic::experimental_vector_reduce_umin;
373  return getReductionIntrinsic(this, ID, Src);
374 }
375 
377  auto Rdx = getReductionIntrinsic(
378  this, Intrinsic::experimental_vector_reduce_fmax, Src);
379  if (NoNaN) {
381  FMF.setNoNaNs();
382  Rdx->setFastMathFlags(FMF);
383  }
384  return Rdx;
385 }
386 
388  auto Rdx = getReductionIntrinsic(
389  this, Intrinsic::experimental_vector_reduce_fmin, Src);
390  if (NoNaN) {
392  FMF.setNoNaNs();
393  Rdx->setFastMathFlags(FMF);
394  }
395  return Rdx;
396 }
397 
399  assert(isa<PointerType>(Ptr->getType()) &&
400  "lifetime.start only applies to pointers.");
401  Ptr = getCastedInt8PtrValue(Ptr);
402  if (!Size)
403  Size = getInt64(-1);
404  else
405  assert(Size->getType() == getInt64Ty() &&
406  "lifetime.start requires the size to be an i64");
407  Value *Ops[] = { Size, Ptr };
408  Module *M = BB->getParent()->getParent();
409  Function *TheFn =
410  Intrinsic::getDeclaration(M, Intrinsic::lifetime_start, {Ptr->getType()});
411  return createCallHelper(TheFn, Ops, this);
412 }
413 
415  assert(isa<PointerType>(Ptr->getType()) &&
416  "lifetime.end only applies to pointers.");
417  Ptr = getCastedInt8PtrValue(Ptr);
418  if (!Size)
419  Size = getInt64(-1);
420  else
421  assert(Size->getType() == getInt64Ty() &&
422  "lifetime.end requires the size to be an i64");
423  Value *Ops[] = { Size, Ptr };
424  Module *M = BB->getParent()->getParent();
425  Function *TheFn =
426  Intrinsic::getDeclaration(M, Intrinsic::lifetime_end, {Ptr->getType()});
427  return createCallHelper(TheFn, Ops, this);
428 }
429 
431 
432  assert(isa<PointerType>(Ptr->getType()) &&
433  "invariant.start only applies to pointers.");
434  Ptr = getCastedInt8PtrValue(Ptr);
435  if (!Size)
436  Size = getInt64(-1);
437  else
438  assert(Size->getType() == getInt64Ty() &&
439  "invariant.start requires the size to be an i64");
440 
441  Value *Ops[] = {Size, Ptr};
442  // Fill in the single overloaded type: memory object type.
443  Type *ObjectPtr[1] = {Ptr->getType()};
444  Module *M = BB->getParent()->getParent();
445  Function *TheFn =
446  Intrinsic::getDeclaration(M, Intrinsic::invariant_start, ObjectPtr);
447  return createCallHelper(TheFn, Ops, this);
448 }
449 
451  assert(Cond->getType() == getInt1Ty() &&
452  "an assumption condition must be of type i1");
453 
454  Value *Ops[] = { Cond };
455  Module *M = BB->getParent()->getParent();
456  Function *FnAssume = Intrinsic::getDeclaration(M, Intrinsic::assume);
457  return createCallHelper(FnAssume, Ops, this);
458 }
459 
460 /// Create a call to a Masked Load intrinsic.
461 /// \p Ptr - base pointer for the load
462 /// \p Align - alignment of the source location
463 /// \p Mask - vector of booleans which indicates what vector lanes should
464 /// be accessed in memory
465 /// \p PassThru - pass-through value that is used to fill the masked-off lanes
466 /// of the result
467 /// \p Name - name of the result variable
469  Value *Mask, Value *PassThru,
470  const Twine &Name) {
471  auto *PtrTy = cast<PointerType>(Ptr->getType());
472  Type *DataTy = PtrTy->getElementType();
473  assert(DataTy->isVectorTy() && "Ptr should point to a vector");
474  assert(Mask && "Mask should not be all-ones (null)");
475  if (!PassThru)
476  PassThru = UndefValue::get(DataTy);
477  Type *OverloadedTypes[] = { DataTy, PtrTy };
478  Value *Ops[] = { Ptr, getInt32(Align), Mask, PassThru};
479  return CreateMaskedIntrinsic(Intrinsic::masked_load, Ops,
480  OverloadedTypes, Name);
481 }
482 
483 /// Create a call to a Masked Store intrinsic.
484 /// \p Val - data to be stored,
485 /// \p Ptr - base pointer for the store
486 /// \p Align - alignment of the destination location
487 /// \p Mask - vector of booleans which indicates what vector lanes should
488 /// be accessed in memory
490  unsigned Align, Value *Mask) {
491  auto *PtrTy = cast<PointerType>(Ptr->getType());
492  Type *DataTy = PtrTy->getElementType();
493  assert(DataTy->isVectorTy() && "Ptr should point to a vector");
494  assert(Mask && "Mask should not be all-ones (null)");
495  Type *OverloadedTypes[] = { DataTy, PtrTy };
496  Value *Ops[] = { Val, Ptr, getInt32(Align), Mask };
497  return CreateMaskedIntrinsic(Intrinsic::masked_store, Ops, OverloadedTypes);
498 }
499 
500 /// Create a call to a Masked intrinsic, with given intrinsic Id,
501 /// an array of operands - Ops, and an array of overloaded types -
502 /// OverloadedTypes.
503 CallInst *IRBuilderBase::CreateMaskedIntrinsic(Intrinsic::ID Id,
504  ArrayRef<Value *> Ops,
505  ArrayRef<Type *> OverloadedTypes,
506  const Twine &Name) {
507  Module *M = BB->getParent()->getParent();
508  Function *TheFn = Intrinsic::getDeclaration(M, Id, OverloadedTypes);
509  return createCallHelper(TheFn, Ops, this, Name);
510 }
511 
512 /// Create a call to a Masked Gather intrinsic.
513 /// \p Ptrs - vector of pointers for loading
514 /// \p Align - alignment for one element
515 /// \p Mask - vector of booleans which indicates what vector lanes should
516 /// be accessed in memory
517 /// \p PassThru - pass-through value that is used to fill the masked-off lanes
518 /// of the result
519 /// \p Name - name of the result variable
521  Value *Mask, Value *PassThru,
522  const Twine& Name) {
523  auto PtrsTy = cast<VectorType>(Ptrs->getType());
524  auto PtrTy = cast<PointerType>(PtrsTy->getElementType());
525  unsigned NumElts = PtrsTy->getVectorNumElements();
526  Type *DataTy = VectorType::get(PtrTy->getElementType(), NumElts);
527 
528  if (!Mask)
530  NumElts));
531 
532  if (!PassThru)
533  PassThru = UndefValue::get(DataTy);
534 
535  Type *OverloadedTypes[] = {DataTy, PtrsTy};
536  Value * Ops[] = {Ptrs, getInt32(Align), Mask, PassThru};
537 
538  // We specify only one type when we create this intrinsic. Types of other
539  // arguments are derived from this type.
540  return CreateMaskedIntrinsic(Intrinsic::masked_gather, Ops, OverloadedTypes,
541  Name);
542 }
543 
544 /// Create a call to a Masked Scatter intrinsic.
545 /// \p Data - data to be stored,
546 /// \p Ptrs - the vector of pointers, where the \p Data elements should be
547 /// stored
548 /// \p Align - alignment for one element
549 /// \p Mask - vector of booleans which indicates what vector lanes should
550 /// be accessed in memory
552  unsigned Align, Value *Mask) {
553  auto PtrsTy = cast<VectorType>(Ptrs->getType());
554  auto DataTy = cast<VectorType>(Data->getType());
555  unsigned NumElts = PtrsTy->getVectorNumElements();
556 
557 #ifndef NDEBUG
558  auto PtrTy = cast<PointerType>(PtrsTy->getElementType());
559  assert(NumElts == DataTy->getVectorNumElements() &&
560  PtrTy->getElementType() == DataTy->getElementType() &&
561  "Incompatible pointer and data types");
562 #endif
563 
564  if (!Mask)
566  NumElts));
567 
568  Type *OverloadedTypes[] = {DataTy, PtrsTy};
569  Value * Ops[] = {Data, Ptrs, getInt32(Align), Mask};
570 
571  // We specify only one type when we create this intrinsic. Types of other
572  // arguments are derived from this type.
573  return CreateMaskedIntrinsic(Intrinsic::masked_scatter, Ops, OverloadedTypes);
574 }
575 
576 template <typename T0, typename T1, typename T2, typename T3>
577 static std::vector<Value *>
578 getStatepointArgs(IRBuilderBase &B, uint64_t ID, uint32_t NumPatchBytes,
579  Value *ActualCallee, uint32_t Flags, ArrayRef<T0> CallArgs,
580  ArrayRef<T1> TransitionArgs, ArrayRef<T2> DeoptArgs,
581  ArrayRef<T3> GCArgs) {
582  std::vector<Value *> Args;
583  Args.push_back(B.getInt64(ID));
584  Args.push_back(B.getInt32(NumPatchBytes));
585  Args.push_back(ActualCallee);
586  Args.push_back(B.getInt32(CallArgs.size()));
587  Args.push_back(B.getInt32(Flags));
588  Args.insert(Args.end(), CallArgs.begin(), CallArgs.end());
589  Args.push_back(B.getInt32(TransitionArgs.size()));
590  Args.insert(Args.end(), TransitionArgs.begin(), TransitionArgs.end());
591  Args.push_back(B.getInt32(DeoptArgs.size()));
592  Args.insert(Args.end(), DeoptArgs.begin(), DeoptArgs.end());
593  Args.insert(Args.end(), GCArgs.begin(), GCArgs.end());
594 
595  return Args;
596 }
597 
598 template <typename T0, typename T1, typename T2, typename T3>
600  IRBuilderBase *Builder, uint64_t ID, uint32_t NumPatchBytes,
601  Value *ActualCallee, uint32_t Flags, ArrayRef<T0> CallArgs,
602  ArrayRef<T1> TransitionArgs, ArrayRef<T2> DeoptArgs, ArrayRef<T3> GCArgs,
603  const Twine &Name) {
604  // Extract out the type of the callee.
605  auto *FuncPtrType = cast<PointerType>(ActualCallee->getType());
606  assert(isa<FunctionType>(FuncPtrType->getElementType()) &&
607  "actual callee must be a callable value");
608 
609  Module *M = Builder->GetInsertBlock()->getParent()->getParent();
610  // Fill in the one generic type'd argument (the function is also vararg)
611  Type *ArgTypes[] = { FuncPtrType };
612  Function *FnStatepoint =
613  Intrinsic::getDeclaration(M, Intrinsic::experimental_gc_statepoint,
614  ArgTypes);
615 
616  std::vector<Value *> Args =
617  getStatepointArgs(*Builder, ID, NumPatchBytes, ActualCallee, Flags,
618  CallArgs, TransitionArgs, DeoptArgs, GCArgs);
619  return createCallHelper(FnStatepoint, Args, Builder, Name);
620 }
621 
623  uint64_t ID, uint32_t NumPatchBytes, Value *ActualCallee,
624  ArrayRef<Value *> CallArgs, ArrayRef<Value *> DeoptArgs,
625  ArrayRef<Value *> GCArgs, const Twine &Name) {
626  return CreateGCStatepointCallCommon<Value *, Value *, Value *, Value *>(
627  this, ID, NumPatchBytes, ActualCallee, uint32_t(StatepointFlags::None),
628  CallArgs, None /* No Transition Args */, DeoptArgs, GCArgs, Name);
629 }
630 
632  uint64_t ID, uint32_t NumPatchBytes, Value *ActualCallee, uint32_t Flags,
633  ArrayRef<Use> CallArgs, ArrayRef<Use> TransitionArgs,
634  ArrayRef<Use> DeoptArgs, ArrayRef<Value *> GCArgs, const Twine &Name) {
635  return CreateGCStatepointCallCommon<Use, Use, Use, Value *>(
636  this, ID, NumPatchBytes, ActualCallee, Flags, CallArgs, TransitionArgs,
637  DeoptArgs, GCArgs, Name);
638 }
639 
641  uint64_t ID, uint32_t NumPatchBytes, Value *ActualCallee,
642  ArrayRef<Use> CallArgs, ArrayRef<Value *> DeoptArgs,
643  ArrayRef<Value *> GCArgs, const Twine &Name) {
644  return CreateGCStatepointCallCommon<Use, Value *, Value *, Value *>(
645  this, ID, NumPatchBytes, ActualCallee, uint32_t(StatepointFlags::None),
646  CallArgs, None, DeoptArgs, GCArgs, Name);
647 }
648 
649 template <typename T0, typename T1, typename T2, typename T3>
651  IRBuilderBase *Builder, uint64_t ID, uint32_t NumPatchBytes,
652  Value *ActualInvokee, BasicBlock *NormalDest, BasicBlock *UnwindDest,
653  uint32_t Flags, ArrayRef<T0> InvokeArgs, ArrayRef<T1> TransitionArgs,
654  ArrayRef<T2> DeoptArgs, ArrayRef<T3> GCArgs, const Twine &Name) {
655  // Extract out the type of the callee.
656  auto *FuncPtrType = cast<PointerType>(ActualInvokee->getType());
657  assert(isa<FunctionType>(FuncPtrType->getElementType()) &&
658  "actual callee must be a callable value");
659 
660  Module *M = Builder->GetInsertBlock()->getParent()->getParent();
661  // Fill in the one generic type'd argument (the function is also vararg)
662  Function *FnStatepoint = Intrinsic::getDeclaration(
663  M, Intrinsic::experimental_gc_statepoint, {FuncPtrType});
664 
665  std::vector<Value *> Args =
666  getStatepointArgs(*Builder, ID, NumPatchBytes, ActualInvokee, Flags,
667  InvokeArgs, TransitionArgs, DeoptArgs, GCArgs);
668  return createInvokeHelper(FnStatepoint, NormalDest, UnwindDest, Args, Builder,
669  Name);
670 }
671 
673  uint64_t ID, uint32_t NumPatchBytes, Value *ActualInvokee,
674  BasicBlock *NormalDest, BasicBlock *UnwindDest,
675  ArrayRef<Value *> InvokeArgs, ArrayRef<Value *> DeoptArgs,
676  ArrayRef<Value *> GCArgs, const Twine &Name) {
677  return CreateGCStatepointInvokeCommon<Value *, Value *, Value *, Value *>(
678  this, ID, NumPatchBytes, ActualInvokee, NormalDest, UnwindDest,
679  uint32_t(StatepointFlags::None), InvokeArgs, None /* No Transition Args*/,
680  DeoptArgs, GCArgs, Name);
681 }
682 
684  uint64_t ID, uint32_t NumPatchBytes, Value *ActualInvokee,
685  BasicBlock *NormalDest, BasicBlock *UnwindDest, uint32_t Flags,
686  ArrayRef<Use> InvokeArgs, ArrayRef<Use> TransitionArgs,
687  ArrayRef<Use> DeoptArgs, ArrayRef<Value *> GCArgs, const Twine &Name) {
688  return CreateGCStatepointInvokeCommon<Use, Use, Use, Value *>(
689  this, ID, NumPatchBytes, ActualInvokee, NormalDest, UnwindDest, Flags,
690  InvokeArgs, TransitionArgs, DeoptArgs, GCArgs, Name);
691 }
692 
694  uint64_t ID, uint32_t NumPatchBytes, Value *ActualInvokee,
695  BasicBlock *NormalDest, BasicBlock *UnwindDest, ArrayRef<Use> InvokeArgs,
696  ArrayRef<Value *> DeoptArgs, ArrayRef<Value *> GCArgs, const Twine &Name) {
697  return CreateGCStatepointInvokeCommon<Use, Value *, Value *, Value *>(
698  this, ID, NumPatchBytes, ActualInvokee, NormalDest, UnwindDest,
699  uint32_t(StatepointFlags::None), InvokeArgs, None, DeoptArgs, GCArgs,
700  Name);
701 }
702 
704  Type *ResultType,
705  const Twine &Name) {
706  Intrinsic::ID ID = Intrinsic::experimental_gc_result;
707  Module *M = BB->getParent()->getParent();
708  Type *Types[] = {ResultType};
709  Function *FnGCResult = Intrinsic::getDeclaration(M, ID, Types);
710 
711  Value *Args[] = {Statepoint};
712  return createCallHelper(FnGCResult, Args, this, Name);
713 }
714 
716  int BaseOffset,
717  int DerivedOffset,
718  Type *ResultType,
719  const Twine &Name) {
720  Module *M = BB->getParent()->getParent();
721  Type *Types[] = {ResultType};
722  Function *FnGCRelocate =
723  Intrinsic::getDeclaration(M, Intrinsic::experimental_gc_relocate, Types);
724 
725  Value *Args[] = {Statepoint,
726  getInt32(BaseOffset),
727  getInt32(DerivedOffset)};
728  return createCallHelper(FnGCRelocate, Args, this, Name);
729 }
730 
732  Instruction *FMFSource,
733  const Twine &Name) {
734  Module *M = BB->getModule();
735  Function *Fn = Intrinsic::getDeclaration(M, ID, {V->getType()});
736  return createCallHelper(Fn, {V}, this, Name, FMFSource);
737 }
738 
740  Value *RHS,
741  Instruction *FMFSource,
742  const Twine &Name) {
743  Module *M = BB->getModule();
744  Function *Fn = Intrinsic::getDeclaration(M, ID, { LHS->getType() });
745  return createCallHelper(Fn, {LHS, RHS}, this, Name, FMFSource);
746 }
747 
749  ArrayRef<Type *> Types,
751  Instruction *FMFSource,
752  const Twine &Name) {
753  Module *M = BB->getModule();
754  Function *Fn = Intrinsic::getDeclaration(M, ID, Types);
755  return createCallHelper(Fn, Args, this, Name, FMFSource);
756 }
Type * getVectorElementType() const
Definition: Type.h:370
Common base class shared among various IRBuilders.
Definition: IRBuilder.h:88
IntegerType * getType() const
getType - Specialize the getType() method to always return an IntegerType, which reduces the amount o...
Definition: Constants.h:171
constexpr char Align[]
Key for Kernel::Arg::Metadata::mAlign.
void copyFastMathFlags(FastMathFlags FMF)
Convenience function for transferring all fast-math flag values to this instruction, which must be an operator which supports these flags.
static Constant * getString(LLVMContext &Context, StringRef Initializer, bool AddNull=true)
This method constructs a CDS and initializes it with a text string.
Definition: Constants.cpp:2557
static IntegerType * getInt1Ty(LLVMContext &C)
Definition: Type.cpp:172
CallInst * CreateInvariantStart(Value *Ptr, ConstantInt *Size=nullptr)
Create a call to invariant.start intrinsic.
Definition: IRBuilder.cpp:430
This class represents lattice values for constants.
Definition: AllocatorList.h:23
static Attribute getWithAlignment(LLVMContext &Context, uint64_t Align)
Return a uniquified Attribute object that has the specific alignment set.
Definition: Attributes.cpp:124
A Module instance is used to store all the information related to an LLVM module. ...
Definition: Module.h:65
iterator begin() const
Definition: ArrayRef.h:136
amdgpu Simplify well known AMD library false FunctionCallee Value const Twine & Name
CallInst * CreateElementUnorderedAtomicMemMove(Value *Dst, unsigned DstAlign, Value *Src, unsigned SrcAlign, uint64_t Size, uint32_t ElementSize, MDNode *TBAATag=nullptr, MDNode *TBAAStructTag=nullptr, MDNode *ScopeTag=nullptr, MDNode *NoAliasTag=nullptr)
Create and insert an element unordered-atomic memmove between the specified pointers.
Definition: IRBuilder.h:515
static CallInst * Create(FunctionType *Ty, Value *F, const Twine &NameStr="", Instruction *InsertBefore=nullptr)
FastMathFlags FMF
Definition: IRBuilder.h:97
CallInst * CreateGCRelocate(Instruction *Statepoint, int BaseOffset, int DerivedOffset, Type *ResultType, const Twine &Name="")
Create a call to the experimental.gc.relocate intrinsics to project the relocated value of one pointe...
Definition: IRBuilder.cpp:715
This class represents a function call, abstracting a target machine&#39;s calling convention.
Like Internal, but omit from symbol table.
Definition: GlobalValue.h:56
LLVMContext & getContext() const
All values hold a context through their type.
Definition: Value.cpp:709
Metadata node.
Definition: Metadata.h:863
CallInst * CreateMemSet(Value *Ptr, Value *Val, uint64_t Size, unsigned Align, bool isVolatile=false, MDNode *TBAATag=nullptr, MDNode *ScopeTag=nullptr, MDNode *NoAliasTag=nullptr)
Create and insert a memset to the specified pointer and the specified value.
Definition: IRBuilder.h:403
LLVMContext & Context
Definition: IRBuilder.h:94
const Module * getModule() const
Return the module owning the function this basic block belongs to, or nullptr if the function does no...
Definition: BasicBlock.cpp:133
static CallInst * CreateGCStatepointCallCommon(IRBuilderBase *Builder, uint64_t ID, uint32_t NumPatchBytes, Value *ActualCallee, uint32_t Flags, ArrayRef< T0 > CallArgs, ArrayRef< T1 > TransitionArgs, ArrayRef< T2 > DeoptArgs, ArrayRef< T3 > GCArgs, const Twine &Name)
Definition: IRBuilder.cpp:599
Twine - A lightweight data structure for efficiently representing the concatenation of temporary valu...
Definition: Twine.h:80
IntegerType * getInt64Ty()
Fetch the type representing a 64-bit integer.
Definition: IRBuilder.h:351
CallInst * CreateFAddReduce(Value *Acc, Value *Src)
Create a vector fadd reduction intrinsic of the source vector.
Definition: IRBuilder.cpp:321
CallInst * CreateMemMove(Value *Dst, unsigned DstAlign, Value *Src, unsigned SrcAlign, uint64_t Size, bool isVolatile=false, MDNode *TBAATag=nullptr, MDNode *ScopeTag=nullptr, MDNode *NoAliasTag=nullptr)
Create and insert a memmove between the specified pointers.
Definition: IRBuilder.h:493
CallInst * CreateMaskedGather(Value *Ptrs, unsigned Align, Value *Mask=nullptr, Value *PassThru=nullptr, const Twine &Name="")
Create a call to Masked Gather intrinsic.
Definition: IRBuilder.cpp:520
BasicBlock * BB
Definition: IRBuilder.h:92
CallInst * CreateFPMinReduce(Value *Src, bool NoNaN=false)
Create a vector float min reduction intrinsic of the source vector.
Definition: IRBuilder.cpp:387
Type * getType() const
All values are typed, get the type of this value.
Definition: Value.h:244
BasicBlock * GetInsertBlock() const
Definition: IRBuilder.h:120
void SetInstDebugLocation(Instruction *I) const
If this builder has a current debug location, set it on the specified instruction.
Definition: IRBuilder.h:157
This class represents a no-op cast from one type to another.
ArrayRef - Represent a constant reference to an array (0 or more elements consecutively in memory)...
Definition: APInt.h:32
CallInst * CreateUnaryIntrinsic(Intrinsic::ID ID, Value *V, Instruction *FMFSource=nullptr, const Twine &Name="")
Create a call to intrinsic ID with 1 operand which is mangled on its type.
Definition: IRBuilder.cpp:731
Function * getDeclaration(Module *M, ID id, ArrayRef< Type *> Tys=None)
Create or insert an LLVM Function declaration for an intrinsic, and return it.
Definition: Function.cpp:1022
static CallInst * createCallHelper(Function *Callee, ArrayRef< Value *> Ops, IRBuilderBase *Builder, const Twine &Name="", Instruction *FMFSource=nullptr)
Definition: IRBuilder.cpp:74
CallInst * CreateXorReduce(Value *Src)
Create a vector int XOR reduction intrinsic of the source vector.
Definition: IRBuilder.cpp:359
CallInst * CreateGCStatepointCall(uint64_t ID, uint32_t NumPatchBytes, Value *ActualCallee, ArrayRef< Value *> CallArgs, ArrayRef< Value *> DeoptArgs, ArrayRef< Value *> GCArgs, const Twine &Name="")
Create a call to the experimental.gc.statepoint intrinsic to start a new statepoint sequence...
Definition: IRBuilder.cpp:622
Type * getReturnType() const
Returns the type of the ret val.
Definition: Function.h:168
static GCRegistry::Add< OcamlGC > B("ocaml", "ocaml 3.10-compatible GC")
constexpr bool isPowerOf2_32(uint32_t Value)
Return true if the argument is a power of two > 0.
Definition: MathExtras.h:428
LLVM Basic Block Representation.
Definition: BasicBlock.h:57
The instances of the Type class are immutable: once they are created, they are never changed...
Definition: Type.h:45
size_t size() const
size - Get the array size.
Definition: ArrayRef.h:148
ConstantInt * getInt1(bool V)
Get a constant value representing either true or false.
Definition: IRBuilder.h:281
This is an important base class in LLVM.
Definition: Constant.h:41
This file contains the declarations for the subclasses of Constant, which represent the different fla...
static InvokeInst * CreateGCStatepointInvokeCommon(IRBuilderBase *Builder, uint64_t ID, uint32_t NumPatchBytes, Value *ActualInvokee, BasicBlock *NormalDest, BasicBlock *UnwindDest, uint32_t Flags, ArrayRef< T0 > InvokeArgs, ArrayRef< T1 > TransitionArgs, ArrayRef< T2 > DeoptArgs, ArrayRef< T3 > GCArgs, const Twine &Name)
Definition: IRBuilder.cpp:650
InvokeInst * CreateGCStatepointInvoke(uint64_t ID, uint32_t NumPatchBytes, Value *ActualInvokee, BasicBlock *NormalDest, BasicBlock *UnwindDest, ArrayRef< Value *> InvokeArgs, ArrayRef< Value *> DeoptArgs, ArrayRef< Value *> GCArgs, const Twine &Name="")
Create an invoke to the experimental.gc.statepoint intrinsic to start a new statepoint sequence...
Definition: IRBuilder.cpp:672
A specialization of it&#39;s base class for read-write access to a gc.statepoint.
Definition: Statepoint.h:305
ConstantInt * getInt64(uint64_t C)
Get a constant 64-bit value.
Definition: IRBuilder.h:311
static Constant * getAllOnesValue(Type *Ty)
Definition: Constants.cpp:328
Type * getCurrentFunctionReturnType() const
Get the return type of the current function that we&#39;re emitting into.
Definition: IRBuilder.cpp:56
static UndefValue * get(Type *T)
Static factory methods - Return an &#39;undef&#39; object of the specified type.
Definition: Constants.cpp:1424
PointerType * getInt8PtrTy(unsigned AddrSpace=0)
Fetch the type representing a pointer to an 8-bit integer value.
Definition: IRBuilder.h:384
void setMetadata(unsigned KindID, MDNode *Node)
Set the metadata of the specified kind to the specified node.
Definition: Metadata.cpp:1222
CallInst * CreateLifetimeEnd(Value *Ptr, ConstantInt *Size=nullptr)
Create a lifetime.end intrinsic.
Definition: IRBuilder.cpp:414
const InstListType & getInstList() const
Return the underlying instruction list container.
Definition: BasicBlock.h:333
void addParamAttr(unsigned ArgNo, Attribute::AttrKind Kind)
Adds the attribute to the indicated argument.
Definition: InstrTypes.h:1374
CallInst * CreateAddReduce(Value *Src)
Create a vector int add reduction intrinsic of the source vector.
Definition: IRBuilder.cpp:339
This is the shared class of boolean and integer constants.
Definition: Constants.h:83
CallInst * CreateIntMaxReduce(Value *Src, bool IsSigned=false)
Create a vector integer max reduction intrinsic of the source vector.
Definition: IRBuilder.cpp:364
GlobalVariable * CreateGlobalString(StringRef Str, const Twine &Name="", unsigned AddressSpace=0)
Make a new global variable with initializer type i8*.
Definition: IRBuilder.cpp:42
CallInst * CreateAssumption(Value *Cond)
Create an assume intrinsic call that allows the optimizer to assume that the provided condition will ...
Definition: IRBuilder.cpp:450
CallInst * CreateElementUnorderedAtomicMemSet(Value *Ptr, Value *Val, uint64_t Size, unsigned Align, uint32_t ElementSize, MDNode *TBAATag=nullptr, MDNode *ScopeTag=nullptr, MDNode *NoAliasTag=nullptr)
Create and insert an element unordered-atomic memset of the region of memory starting at the given po...
Definition: IRBuilder.h:422
CallInst * CreateIntrinsic(Intrinsic::ID ID, ArrayRef< Type *> Types, ArrayRef< Value *> Args, Instruction *FMFSource=nullptr, const Twine &Name="")
Create a call to intrinsic ID with args, mangled using Types.
Definition: IRBuilder.cpp:748
static CallInst * getReductionIntrinsic(IRBuilderBase *Builder, Intrinsic::ID ID, Value *Src)
Definition: IRBuilder.cpp:312
static InvokeInst * createInvokeHelper(Function *Invokee, BasicBlock *NormalDest, BasicBlock *UnwindDest, ArrayRef< Value *> Ops, IRBuilderBase *Builder, const Twine &Name="")
Definition: IRBuilder.cpp:86
AddressSpace
Definition: NVPTXBaseInfo.h:21
iterator end() const
Definition: ArrayRef.h:137
CallInst * CreateMaskedStore(Value *Val, Value *Ptr, unsigned Align, Value *Mask)
Create a call to Masked Store intrinsic.
Definition: IRBuilder.cpp:489
ConstantInt * getInt32(uint32_t C)
Get a constant 32-bit value.
Definition: IRBuilder.h:306
CallInst * CreateMemCpy(Value *Dst, unsigned DstAlign, Value *Src, unsigned SrcAlign, uint64_t Size, bool isVolatile=false, MDNode *TBAATag=nullptr, MDNode *TBAAStructTag=nullptr, MDNode *ScopeTag=nullptr, MDNode *NoAliasTag=nullptr)
Create and insert a memcpy between the specified pointers.
Definition: IRBuilder.h:445
static std::vector< Value * > getStatepointArgs(IRBuilderBase &B, uint64_t ID, uint32_t NumPatchBytes, Value *ActualCallee, uint32_t Flags, ArrayRef< T0 > CallArgs, ArrayRef< T1 > TransitionArgs, ArrayRef< T2 > DeoptArgs, ArrayRef< T3 > GCArgs)
Definition: IRBuilder.cpp:578
CallInst * CreateFMulReduce(Value *Acc, Value *Src)
Create a vector fmul reduction intrinsic of the source vector.
Definition: IRBuilder.cpp:330
CallInst * CreateMaskedLoad(Value *Ptr, unsigned Align, Value *Mask, Value *PassThru=nullptr, const Twine &Name="")
Create a call to Masked Load intrinsic.
Definition: IRBuilder.cpp:468
void setNoNaNs(bool B=true)
Definition: Operator.h:218
IntegerType * getInt1Ty()
Fetch the type representing a single bit.
Definition: IRBuilder.h:331
CallInst * CreateAndReduce(Value *Src)
Create a vector int AND reduction intrinsic of the source vector.
Definition: IRBuilder.cpp:349
CallInst * CreateOrReduce(Value *Src)
Create a vector int OR reduction intrinsic of the source vector.
Definition: IRBuilder.cpp:354
CallInst * CreateIntMinReduce(Value *Src, bool IsSigned=false)
Create a vector integer min reduction intrinsic of the source vector.
Definition: IRBuilder.cpp:370
iterator insert(iterator where, pointer New)
Definition: ilist.h:226
void setUnnamedAddr(UnnamedAddr Val)
Definition: GlobalValue.h:215
static InvokeInst * Create(FunctionType *Ty, Value *Func, BasicBlock *IfNormal, BasicBlock *IfException, ArrayRef< Value *> Args, const Twine &NameStr, Instruction *InsertBefore=nullptr)
const Function * getParent() const
Return the enclosing method, or null if none.
Definition: BasicBlock.h:106
CallInst * CreateGCResult(Instruction *Statepoint, Type *ResultType, const Twine &Name="")
Create a call to the experimental.gc.result intrinsic to extract the result from a call wrapped in a ...
Definition: IRBuilder.cpp:703
CallInst * CreateMulReduce(Value *Src)
Create a vector int mul reduction intrinsic of the source vector.
Definition: IRBuilder.cpp:344
uint32_t Size
Definition: Profile.cpp:46
CallInst * CreateBinaryIntrinsic(Intrinsic::ID ID, Value *LHS, Value *RHS, Instruction *FMFSource=nullptr, const Twine &Name="")
Create a call to intrinsic ID with 2 operands which is mangled on the first type. ...
Definition: IRBuilder.cpp:739
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
CallInst * CreateMaskedScatter(Value *Val, Value *Ptrs, unsigned Align, Value *Mask=nullptr)
Create a call to Masked Scatter intrinsic.
Definition: IRBuilder.cpp:551
Module * getParent()
Get the module that this global value is contained inside of...
Definition: GlobalValue.h:565
LLVM Value Representation.
Definition: Value.h:72
static VectorType * get(Type *ElementType, unsigned NumElements)
This static method is the primary way to construct an VectorType.
Definition: Type.cpp:605
std::underlying_type< E >::type Mask()
Get a bitmask with 1s in all places up to the high-order bit of E&#39;s largest value.
Definition: BitmaskEnum.h:80
BasicBlock::iterator GetInsertPoint() const
Definition: IRBuilder.h:121
Invoke instruction.
CallInst * CreateLifetimeStart(Value *Ptr, ConstantInt *Size=nullptr)
Create a lifetime.start intrinsic.
Definition: IRBuilder.cpp:398
Convenience struct for specifying and reasoning about fast-math flags.
Definition: Operator.h:159
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:48
static bool isVolatile(Instruction *Inst)
CallInst * CreateElementUnorderedAtomicMemCpy(Value *Dst, unsigned DstAlign, Value *Src, unsigned SrcAlign, uint64_t Size, uint32_t ElementSize, MDNode *TBAATag=nullptr, MDNode *TBAAStructTag=nullptr, MDNode *ScopeTag=nullptr, MDNode *NoAliasTag=nullptr)
Create and insert an element unordered-atomic memcpy between the specified pointers.
Definition: IRBuilder.h:471
CallInst * CreateFPMaxReduce(Value *Src, bool NoNaN=false)
Create a vector float max reduction intrinsic of the source vector.
Definition: IRBuilder.cpp:376
BasicBlock::iterator InsertPt
Definition: IRBuilder.h:93
constexpr char Args[]
Key for Kernel::Metadata::mArgs.