1 //===-- llvm/Instrinsics.h - LLVM Intrinsic Function Handling ---*- 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 a set of enums which allow processing of intrinsic
11 // functions. Values of these enum types are returned by
12 // Function::getIntrinsicID.
14 //===----------------------------------------------------------------------===//
16 #ifndef LLVM_IR_INTRINSICS_H
17 #define LLVM_IR_INTRINSICS_H
19 #include "llvm/ADT/ArrayRef.h"
31 /// This namespace contains an enum with a value for every intrinsic/builtin
32 /// function known by LLVM. The enum values are returned by
33 /// Function::getIntrinsicID().
36 not_intrinsic = 0, // Must be zero
38 // Get the intrinsic enums generated from Intrinsics.td
39 #define GET_INTRINSIC_ENUM_VALUES
40 #include "llvm/IR/Intrinsics.gen"
41 #undef GET_INTRINSIC_ENUM_VALUES
45 /// Return the LLVM name for an intrinsic, such as "llvm.ppc.altivec.lvx".
46 std::string getName(ID id, ArrayRef<Type*> Tys = None);
48 /// Return the function type for an intrinsic.
49 FunctionType *getType(LLVMContext &Context, ID id,
50 ArrayRef<Type*> Tys = None);
52 /// Returns true if the intrinsic can be overloaded.
53 bool isOverloaded(ID id);
55 /// Returns true if the intrinsic is a leaf, i.e. it does not make any calls
56 /// itself. Most intrinsics are leafs, the exceptions being the patchpoint
57 /// and statepoint intrinsics. These call (or invoke) their "target" argument.
60 /// Return the attributes for an intrinsic.
61 AttributeSet getAttributes(LLVMContext &C, ID id);
63 /// Create or insert an LLVM Function declaration for an intrinsic, and return
66 /// The Tys parameter is for intrinsics with overloaded types (e.g., those
67 /// using iAny, fAny, vAny, or iPTRAny). For a declaration of an overloaded
68 /// intrinsic, Tys must provide exactly one type for each overloaded type in
70 Function *getDeclaration(Module *M, ID id, ArrayRef<Type*> Tys = None);
72 /// Map a GCC builtin name to an intrinsic ID.
73 ID getIntrinsicForGCCBuiltin(const char *Prefix, const char *BuiltinName);
75 /// Map a MS builtin name to an intrinsic ID.
76 ID getIntrinsicForMSBuiltin(const char *Prefix, const char *BuiltinName);
78 /// This is a type descriptor which explains the type requirements of an
79 /// intrinsic. This is returned by getIntrinsicInfoTableEntries.
80 struct IITDescriptor {
81 enum IITDescriptorKind {
82 Void, VarArg, MMX, Token, Metadata, Half, Float, Double,
83 Integer, Vector, Pointer, Struct,
84 Argument, ExtendArgument, TruncArgument, HalfVecArgument,
85 SameVecWidthArgument, PtrToArgument, VecOfPtrsToElt
89 unsigned Integer_Width;
91 unsigned Vector_Width;
92 unsigned Pointer_AddressSpace;
93 unsigned Struct_NumElements;
94 unsigned Argument_Info;
104 unsigned getArgumentNumber() const {
105 assert(Kind == Argument || Kind == ExtendArgument ||
106 Kind == TruncArgument || Kind == HalfVecArgument ||
107 Kind == SameVecWidthArgument || Kind == PtrToArgument ||
108 Kind == VecOfPtrsToElt);
109 return Argument_Info >> 3;
111 ArgKind getArgumentKind() const {
112 assert(Kind == Argument || Kind == ExtendArgument ||
113 Kind == TruncArgument || Kind == HalfVecArgument ||
114 Kind == SameVecWidthArgument || Kind == PtrToArgument ||
115 Kind == VecOfPtrsToElt);
116 return (ArgKind)(Argument_Info & 7);
119 static IITDescriptor get(IITDescriptorKind K, unsigned Field) {
120 IITDescriptor Result = { K, { Field } };
125 /// Return the IIT table descriptor for the specified intrinsic into an array
126 /// of IITDescriptors.
127 void getIntrinsicInfoTableEntries(ID id, SmallVectorImpl<IITDescriptor> &T);
129 } // End Intrinsic namespace
131 } // End llvm namespace