LLVM  17.0.0git
Intrinsics.h
Go to the documentation of this file.
1 //===- Intrinsics.h - LLVM Intrinsic Function Handling ----------*- 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 a set of enums which allow processing of intrinsic
10 // functions. Values of these enum types are returned by
11 // Function::getIntrinsicID.
12 //
13 //===----------------------------------------------------------------------===//
14 
15 #ifndef LLVM_IR_INTRINSICS_H
16 #define LLVM_IR_INTRINSICS_H
17 
18 #include "llvm/ADT/ArrayRef.h"
19 #include "llvm/Support/TypeSize.h"
20 #include <optional>
21 #include <string>
22 
23 namespace llvm {
24 
25 class Type;
26 class FunctionType;
27 class Function;
28 class LLVMContext;
29 class Module;
30 class AttributeList;
31 
32 /// This namespace contains an enum with a value for every intrinsic/builtin
33 /// function known by LLVM. The enum values are returned by
34 /// Function::getIntrinsicID().
35 namespace Intrinsic {
36  // Abstraction for the arguments of the noalias intrinsics
37  static const int NoAliasScopeDeclScopeArg = 0;
38 
39  // Intrinsic ID type. This is an opaque typedef to facilitate splitting up
40  // the enum into target-specific enums.
41  typedef unsigned ID;
42 
43  enum IndependentIntrinsics : unsigned {
44  not_intrinsic = 0, // Must be zero
45 
46  // Get the intrinsic enums generated from Intrinsics.td
47 #define GET_INTRINSIC_ENUM_VALUES
48 #include "llvm/IR/IntrinsicEnums.inc"
49 #undef GET_INTRINSIC_ENUM_VALUES
50  };
51 
52  /// Return the LLVM name for an intrinsic, such as "llvm.ppc.altivec.lvx".
53  /// Note, this version is for intrinsics with no overloads. Use the other
54  /// version of getName if overloads are required.
55  StringRef getName(ID id);
56 
57  /// Return the LLVM name for an intrinsic, without encoded types for
58  /// overloading, such as "llvm.ssa.copy".
59  StringRef getBaseName(ID id);
60 
61  /// Return the LLVM name for an intrinsic, such as "llvm.ppc.altivec.lvx" or
62  /// "llvm.ssa.copy.p0s_s.1". Note, this version of getName supports overloads.
63  /// This is less efficient than the StringRef version of this function. If no
64  /// overloads are required, it is safe to use this version, but better to use
65  /// the StringRef version. If one of the types is based on an unnamed type, a
66  /// function type will be computed. Providing FT will avoid this computation.
67  std::string getName(ID Id, ArrayRef<Type *> Tys, Module *M,
68  FunctionType *FT = nullptr);
69 
70  /// Return the LLVM name for an intrinsic. This is a special version only to
71  /// be used by LLVMIntrinsicCopyOverloadedName. It only supports overloads
72  /// based on named types.
73  std::string getNameNoUnnamedTypes(ID Id, ArrayRef<Type *> Tys);
74 
75  /// Return the function type for an intrinsic.
76  FunctionType *getType(LLVMContext &Context, ID id,
77  ArrayRef<Type *> Tys = std::nullopt);
78 
79  /// Returns true if the intrinsic can be overloaded.
80  bool isOverloaded(ID id);
81 
82  /// Return the attributes for an intrinsic.
83  AttributeList getAttributes(LLVMContext &C, ID id);
84 
85  /// Create or insert an LLVM Function declaration for an intrinsic, and return
86  /// it.
87  ///
88  /// The Tys parameter is for intrinsics with overloaded types (e.g., those
89  /// using iAny, fAny, vAny, or iPTRAny). For a declaration of an overloaded
90  /// intrinsic, Tys must provide exactly one type for each overloaded type in
91  /// the intrinsic.
93  ArrayRef<Type *> Tys = std::nullopt);
94 
95  /// Looks up Name in NameTable via binary search. NameTable must be sorted
96  /// and all entries must start with "llvm.". If NameTable contains an exact
97  /// match for Name or a prefix of Name followed by a dot, its index in
98  /// NameTable is returned. Otherwise, -1 is returned.
99  int lookupLLVMIntrinsicByName(ArrayRef<const char *> NameTable,
100  StringRef Name);
101 
102  /// Map a Clang builtin name to an intrinsic ID.
103  ID getIntrinsicForClangBuiltin(const char *Prefix, StringRef BuiltinName);
104 
105  /// Map a MS builtin name to an intrinsic ID.
106  ID getIntrinsicForMSBuiltin(const char *Prefix, StringRef BuiltinName);
107 
108  /// This is a type descriptor which explains the type requirements of an
109  /// intrinsic. This is returned by getIntrinsicInfoTableEntries.
110  struct IITDescriptor {
141  } Kind;
142 
143  union {
144  unsigned Integer_Width;
145  unsigned Float_Width;
148  unsigned Argument_Info;
150  };
151 
152  enum ArgKind {
159  };
160 
161  unsigned getArgumentNumber() const {
168  return Argument_Info >> 3;
169  }
176  return (ArgKind)(Argument_Info & 7);
177  }
178 
179  // VecOfAnyPtrsToElt and AnyPtrToElt uses both an overloaded argument (for
180  // address space) and a reference argument (for matching vector width and
181  // element types)
182  unsigned getOverloadArgNumber() const {
184  return Argument_Info >> 16;
185  }
186  unsigned getRefArgNumber() const {
188  return Argument_Info & 0xFFFF;
189  }
190 
191  static IITDescriptor get(IITDescriptorKind K, unsigned Field) {
192  IITDescriptor Result = { K, { Field } };
193  return Result;
194  }
195 
196  static IITDescriptor get(IITDescriptorKind K, unsigned short Hi,
197  unsigned short Lo) {
198  unsigned Field = Hi << 16 | Lo;
199  IITDescriptor Result = {K, {Field}};
200  return Result;
201  }
202 
203  static IITDescriptor getVector(unsigned Width, bool IsScalable) {
204  IITDescriptor Result = {Vector, {0}};
205  Result.Vector_Width = ElementCount::get(Width, IsScalable);
206  return Result;
207  }
208  };
209 
210  /// Return the IIT table descriptor for the specified intrinsic into an array
211  /// of IITDescriptors.
213 
218  };
219 
220  /// Match the specified function type with the type constraints specified by
221  /// the .td file. If the given type is an overloaded type it is pushed to the
222  /// ArgTys vector.
223  ///
224  /// Returns false if the given type matches with the constraints, true
225  /// otherwise.
228  SmallVectorImpl<Type *> &ArgTys);
229 
230  /// Verify if the intrinsic has variable arguments. This method is intended to
231  /// be called after all the fixed arguments have been matched first.
232  ///
233  /// This method returns true on error.
234  bool matchIntrinsicVarArg(bool isVarArg, ArrayRef<IITDescriptor> &Infos);
235 
236  /// Gets the type arguments of an intrinsic call by matching type contraints
237  /// specified by the .td file. The overloaded types are pushed into the
238  /// AgTys vector.
239  ///
240  /// Returns false if the given function is not a valid intrinsic call.
242 
243  // Checks if the intrinsic name matches with its signature and if not
244  // returns the declaration with the same signature and remangled name.
245  // An existing GlobalValue with the wanted name but with a wrong prototype
246  // or of the wrong kind will be renamed by adding ".renamed" to the name.
247  std::optional<Function *> remangleIntrinsicFunction(Function *F);
248 
249 } // End Intrinsic namespace
250 
251 } // End llvm namespace
252 
253 #endif
llvm::Intrinsic::getBaseName
StringRef getBaseName(ID id)
Return the LLVM name for an intrinsic, without encoded types for overloading, such as "llvm....
Definition: Function.cpp:970
llvm::Intrinsic::IITDescriptor::AK_AnyVector
@ AK_AnyVector
Definition: Intrinsics.h:156
llvm::Intrinsic::IITDescriptor::Subdivide4Argument
@ Subdivide4Argument
Definition: Intrinsics.h:136
llvm::Argument
This class represents an incoming formal argument to a Function.
Definition: Argument.h:28
llvm::Intrinsic::isOverloaded
bool isOverloaded(ID id)
Returns true if the intrinsic can be overloaded.
Definition: Function.cpp:1491
llvm
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18
llvm::Intrinsic::IITDescriptor::get
static IITDescriptor get(IITDescriptorKind K, unsigned short Hi, unsigned short Lo)
Definition: Intrinsics.h:196
llvm::Intrinsic::MatchIntrinsicTypes_NoMatchArg
@ MatchIntrinsicTypes_NoMatchArg
Definition: Intrinsics.h:217
llvm::Intrinsic::IITDescriptor::VecOfBitcastsToInt
@ VecOfBitcastsToInt
Definition: Intrinsics.h:137
llvm::Intrinsic::IITDescriptor::Kind
enum llvm::Intrinsic::IITDescriptor::IITDescriptorKind Kind
FunctionType
Definition: ItaniumDemangle.h:775
llvm::ElementCount
Definition: TypeSize.h:279
llvm::Intrinsic::IITDescriptor::BFloat
@ BFloat
Definition: Intrinsics.h:118
llvm::cl::Prefix
@ Prefix
Definition: CommandLine.h:159
llvm::Function
Definition: Function.h:59
llvm::Intrinsic::IITDescriptor::VarArg
@ VarArg
Definition: Intrinsics.h:113
TypeSize.h
llvm::Intrinsic::IITDescriptor::Quad
@ Quad
Definition: Intrinsics.h:121
llvm::Intrinsic::getName
StringRef getName(ID id)
Return the LLVM name for an intrinsic, such as "llvm.ppc.altivec.lvx".
Definition: Function.cpp:975
llvm::Intrinsic::IITDescriptor::MMX
@ MMX
Definition: Intrinsics.h:114
llvm::Intrinsic::IITDescriptor::AnyPtrToElt
@ AnyPtrToElt
Definition: Intrinsics.h:140
llvm::Intrinsic::IITDescriptor::Argument_Info
unsigned Argument_Info
Definition: Intrinsics.h:148
llvm::Intrinsic::IITDescriptor::Metadata
@ Metadata
Definition: Intrinsics.h:116
llvm::Intrinsic::IITDescriptor::PtrToArgument
@ PtrToArgument
Definition: Intrinsics.h:131
llvm::Intrinsic::lookupLLVMIntrinsicByName
int lookupLLVMIntrinsicByName(ArrayRef< const char * > NameTable, StringRef Name)
Looks up Name in NameTable via binary search.
Definition: IntrinsicInst.cpp:231
llvm::Intrinsic::getAttributes
AttributeList getAttributes(LLVMContext &C, ID id)
Return the attributes for an intrinsic.
llvm::Intrinsic::IITDescriptor::ExtendArgument
@ ExtendArgument
Definition: Intrinsics.h:127
llvm::Intrinsic::remangleIntrinsicFunction
std::optional< Function * > remangleIntrinsicFunction(Function *F)
Definition: Function.cpp:1867
llvm::Intrinsic::not_intrinsic
@ not_intrinsic
Definition: Intrinsics.h:44
llvm::Intrinsic::IITDescriptor::Pointer
@ Pointer
Definition: Intrinsics.h:124
llvm::Intrinsic::IITDescriptor::AK_Any
@ AK_Any
Definition: Intrinsics.h:153
llvm::ElementCount::get
static constexpr ElementCount get(ScalarTy MinVal, bool Scalable)
Definition: TypeSize.h:297
llvm::Intrinsic::IITDescriptor::Void
@ Void
Definition: Intrinsics.h:112
llvm::Intrinsic::IITDescriptor::AK_MatchType
@ AK_MatchType
Definition: Intrinsics.h:158
llvm::Intrinsic::getIntrinsicSignature
bool getIntrinsicSignature(Function *F, SmallVectorImpl< Type * > &ArgTys)
Gets the type arguments of an intrinsic call by matching type contraints specified by the ....
Definition: Function.cpp:1846
F
#define F(x, y, z)
Definition: MD5.cpp:55
llvm::Intrinsic::IITDescriptor::Float
@ Float
Definition: Intrinsics.h:119
llvm::Intrinsic::MatchIntrinsicTypes_NoMatchRet
@ MatchIntrinsicTypes_NoMatchRet
Definition: Intrinsics.h:216
Context
LLVMContext & Context
Definition: NVVMIntrRange.cpp:66
llvm::Intrinsic::IITDescriptor::AK_AnyPointer
@ AK_AnyPointer
Definition: Intrinsics.h:157
llvm::Intrinsic::IITDescriptor::Struct_NumElements
unsigned Struct_NumElements
Definition: Intrinsics.h:147
llvm::Intrinsic::getIntrinsicForClangBuiltin
ID getIntrinsicForClangBuiltin(const char *Prefix, StringRef BuiltinName)
Map a Clang builtin name to an intrinsic ID.
llvm::Intrinsic::IITDescriptor::Double
@ Double
Definition: Intrinsics.h:120
llvm::Intrinsic::IITDescriptor::SameVecWidthArgument
@ SameVecWidthArgument
Definition: Intrinsics.h:130
C
(vector float) vec_cmpeq(*A, *B) C
Definition: README_ALTIVEC.txt:86
llvm::Intrinsic::IITDescriptor::HalfVecArgument
@ HalfVecArgument
Definition: Intrinsics.h:129
llvm::Intrinsic::IITDescriptor::getArgumentNumber
unsigned getArgumentNumber() const
Definition: Intrinsics.h:161
llvm::Intrinsic::getType
FunctionType * getType(LLVMContext &Context, ID id, ArrayRef< Type * > Tys=std::nullopt)
Return the function type for an intrinsic.
Definition: Function.cpp:1470
llvm::Intrinsic::IITDescriptor::Pointer_AddressSpace
unsigned Pointer_AddressSpace
Definition: Intrinsics.h:146
llvm::Intrinsic::IITDescriptor::PPCQuad
@ PPCQuad
Definition: Intrinsics.h:139
llvm::CallingConv::ID
unsigned ID
LLVM IR allows to use arbitrary numbers as calling convention identifiers.
Definition: CallingConv.h:24
llvm::codeview::ClassOptions::Intrinsic
@ Intrinsic
llvm::Intrinsic::IITDescriptor::TruncArgument
@ TruncArgument
Definition: Intrinsics.h:128
llvm::Intrinsic::MatchIntrinsicTypes_Match
@ MatchIntrinsicTypes_Match
Definition: Intrinsics.h:215
llvm::Intrinsic::IndependentIntrinsics
IndependentIntrinsics
Definition: Intrinsics.h:43
llvm::Intrinsic::IITDescriptor::get
static IITDescriptor get(IITDescriptorKind K, unsigned Field)
Definition: Intrinsics.h:191
llvm::Intrinsic::IITDescriptor::Integer_Width
unsigned Integer_Width
Definition: Intrinsics.h:144
llvm::Intrinsic::matchIntrinsicVarArg
bool matchIntrinsicVarArg(bool isVarArg, ArrayRef< IITDescriptor > &Infos)
Verify if the intrinsic has variable arguments.
Definition: Function.cpp:1827
llvm::Intrinsic::IITDescriptor::Half
@ Half
Definition: Intrinsics.h:117
llvm::Intrinsic::IITDescriptor::Float_Width
unsigned Float_Width
Definition: Intrinsics.h:145
llvm::Intrinsic::getIntrinsicInfoTableEntries
void getIntrinsicInfoTableEntries(ID id, SmallVectorImpl< IITDescriptor > &T)
Return the IIT table descriptor for the specified intrinsic into an array of IITDescriptors.
Definition: Function.cpp:1332
llvm::Intrinsic::getIntrinsicForMSBuiltin
ID getIntrinsicForMSBuiltin(const char *Prefix, StringRef BuiltinName)
Map a MS builtin name to an intrinsic ID.
llvm::Intrinsic::IITDescriptor::AK_AnyInteger
@ AK_AnyInteger
Definition: Intrinsics.h:154
llvm::Intrinsic::IITDescriptor::VecOfAnyPtrsToElt
@ VecOfAnyPtrsToElt
Definition: Intrinsics.h:133
ArrayRef.h
TemplateParamKind::Type
@ Type
assert
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
llvm::Intrinsic::IITDescriptor::getOverloadArgNumber
unsigned getOverloadArgNumber() const
Definition: Intrinsics.h:182
llvm::Intrinsic::IITDescriptor::AMX
@ AMX
Definition: Intrinsics.h:138
llvm::Intrinsic::IITDescriptor::Argument
@ Argument
Definition: Intrinsics.h:126
llvm::Intrinsic::IITDescriptor::Subdivide2Argument
@ Subdivide2Argument
Definition: Intrinsics.h:135
llvm::Intrinsic::IITDescriptor::ArgKind
ArgKind
Definition: Intrinsics.h:152
llvm::Intrinsic::NoAliasScopeDeclScopeArg
static const int NoAliasScopeDeclScopeArg
Definition: Intrinsics.h:37
llvm::ArrayRef
ArrayRef - Represent a constant reference to an array (0 or more elements consecutively in memory),...
Definition: APInt.h:33
Module
Machine Check Debug Module
Definition: MachineCheckDebugify.cpp:122
llvm::Intrinsic::IITDescriptor::PtrToElt
@ PtrToElt
Definition: Intrinsics.h:132
llvm::Intrinsic::IITDescriptor::VecElementArgument
@ VecElementArgument
Definition: Intrinsics.h:134
llvm::Intrinsic::getDeclaration
Function * getDeclaration(Module *M, ID id, ArrayRef< Type * > Tys=std::nullopt)
Create or insert an LLVM Function declaration for an intrinsic, and return it.
Definition: Function.cpp:1502
llvm::Intrinsic::IITDescriptor::AK_AnyFloat
@ AK_AnyFloat
Definition: Intrinsics.h:155
llvm::Intrinsic::IITDescriptor::IITDescriptorKind
IITDescriptorKind
Definition: Intrinsics.h:111
llvm::AMDGPU::Hwreg::Width
Width
Definition: SIDefines.h:439
llvm::Intrinsic::getNameNoUnnamedTypes
std::string getNameNoUnnamedTypes(ID Id, ArrayRef< Type * > Tys)
Return the LLVM name for an intrinsic.
Definition: Function.cpp:1015
llvm::Intrinsic::IITDescriptor::Struct
@ Struct
Definition: Intrinsics.h:125
llvm::Intrinsic::IITDescriptor::Token
@ Token
Definition: Intrinsics.h:115
llvm::Intrinsic::IITDescriptor::Vector_Width
ElementCount Vector_Width
Definition: Intrinsics.h:149
llvm::Intrinsic::IITDescriptor::Vector
@ Vector
Definition: Intrinsics.h:123
llvm::Intrinsic::IITDescriptor::getRefArgNumber
unsigned getRefArgNumber() const
Definition: Intrinsics.h:186
llvm::Intrinsic::matchIntrinsicSignature
MatchIntrinsicTypesResult matchIntrinsicSignature(FunctionType *FTy, ArrayRef< IITDescriptor > &Infos, SmallVectorImpl< Type * > &ArgTys)
Match the specified function type with the type constraints specified by the .td file.
Definition: Function.cpp:1801
llvm::Intrinsic::IITDescriptor::getVector
static IITDescriptor getVector(unsigned Width, bool IsScalable)
Definition: Intrinsics.h:203
llvm::SmallVectorImpl
This class consists of common code factored out of the SmallVector class to reduce code duplication b...
Definition: APFloat.h:42
llvm::Intrinsic::IITDescriptor::Integer
@ Integer
Definition: Intrinsics.h:122
llvm::OptimizedStructLayoutField
A field in a structure.
Definition: OptimizedStructLayout.h:45
llvm::Intrinsic::IITDescriptor
This is a type descriptor which explains the type requirements of an intrinsic.
Definition: Intrinsics.h:110
llvm::AMDGPU::VGPRIndexMode::Id
Id
Definition: SIDefines.h:247
llvm::Intrinsic::MatchIntrinsicTypesResult
MatchIntrinsicTypesResult
Definition: Intrinsics.h:214
llvm::Intrinsic::IITDescriptor::getArgumentKind
ArgKind getArgumentKind() const
Definition: Intrinsics.h:170
llvm::codeview::PublicSymFlags::Function
@ Function
llvm::FunctionType
Class to represent function types.
Definition: DerivedTypes.h:103
llvm::Intrinsic::ID
unsigned ID
Definition: TargetTransformInfo.h:39