1 //===-- llvm/Instrinsics.h - LLVM Intrinsic Function Handling ---*- C++ -*-===// 2 // 3 // The LLVM Compiler Infrastructure 4 // 5 // This file is distributed under the University of Illinois Open Source 6 // License. See LICENSE.TXT for details. 7 // 8 //===----------------------------------------------------------------------===// 9 // 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. 13 // 14 //===----------------------------------------------------------------------===// 15 16 #ifndef LLVM_IR_INTRINSICS_H 17 #define LLVM_IR_INTRINSICS_H 18 19 #include "llvm/ADT/ArrayRef.h" 20 #include <string> 21 22 namespace llvm { 23 24 class Type; 25 class FunctionType; 26 class Function; 27 class LLVMContext; 28 class Module; 29 class AttributeSet; 30 31 /// Intrinsic Namespace - This namespace contains an enum with a value for 32 /// every intrinsic/builtin function known by LLVM. These enum values are 33 /// returned by Function::getIntrinsicID(). 34 /// 35 namespace Intrinsic { 36 enum ID { 37 not_intrinsic = 0, // Must be zero 38 39 // Get the intrinsic enums generated from Intrinsics.td 40 #define GET_INTRINSIC_ENUM_VALUES 41 #include "llvm/IR/Intrinsics.gen" 42 #undef GET_INTRINSIC_ENUM_VALUES 43 , num_intrinsics 44 }; 45 46 /// Intrinsic::getName(ID) - Return the LLVM name for an intrinsic, such as 47 /// "llvm.ppc.altivec.lvx". 48 std::string getName(ID id, ArrayRef<Type*> Tys = None); 49 50 /// Intrinsic::getType(ID) - Return the function type for an intrinsic. 51 /// 52 FunctionType *getType(LLVMContext &Context, ID id, 53 ArrayRef<Type*> Tys = None); 54 55 /// Intrinsic::isOverloaded(ID) - Returns true if the intrinsic can be 56 /// overloaded. 57 bool isOverloaded(ID id); 58 59 /// Intrinsic::getAttributes(ID) - Return the attributes for an intrinsic. 60 /// 61 AttributeSet getAttributes(LLVMContext &C, ID id); 62 63 /// Intrinsic::getDeclaration(M, ID) - Create or insert an LLVM Function 64 /// declaration for an intrinsic, and return it. 65 /// 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 69 /// the intrinsic. 70 Function *getDeclaration(Module *M, ID id, ArrayRef<Type*> Tys = None); 71 72 /// Map a GCC builtin name to an intrinsic ID. 73 ID getIntrinsicForGCCBuiltin(const char *Prefix, const char *BuiltinName); 74 75 /// Map a MS builtin name to an intrinsic ID. 76 ID getIntrinsicForMSBuiltin(const char *Prefix, const char *BuiltinName); 77 78 /// IITDescriptor - This is a type descriptor which explains the type 79 /// requirements of an intrinsic. This is returned by 80 /// getIntrinsicInfoTableEntries. 81 struct IITDescriptor { 82 enum IITDescriptorKind { 83 Void, VarArg, MMX, Metadata, Half, Float, Double, 84 Integer, Vector, Pointer, Struct, 85 Argument, ExtendArgument, TruncArgument, HalfVecArgument 86 } Kind; 87 88 union { 89 unsigned Integer_Width; 90 unsigned Float_Width; 91 unsigned Vector_Width; 92 unsigned Pointer_AddressSpace; 93 unsigned Struct_NumElements; 94 unsigned Argument_Info; 95 }; 96 97 enum ArgKind { 98 AK_AnyInteger, 99 AK_AnyFloat, 100 AK_AnyVector, 101 AK_AnyPointer 102 }; getArgumentNumberIITDescriptor103 unsigned getArgumentNumber() const { 104 assert(Kind == Argument || Kind == ExtendArgument || 105 Kind == TruncArgument || Kind == HalfVecArgument); 106 return Argument_Info >> 2; 107 } getArgumentKindIITDescriptor108 ArgKind getArgumentKind() const { 109 assert(Kind == Argument || Kind == ExtendArgument || 110 Kind == TruncArgument || Kind == HalfVecArgument); 111 return (ArgKind)(Argument_Info&3); 112 } 113 getIITDescriptor114 static IITDescriptor get(IITDescriptorKind K, unsigned Field) { 115 IITDescriptor Result = { K, { Field } }; 116 return Result; 117 } 118 }; 119 120 /// getIntrinsicInfoTableEntries - Return the IIT table descriptor for the 121 /// specified intrinsic into an array of IITDescriptors. 122 /// 123 void getIntrinsicInfoTableEntries(ID id, SmallVectorImpl<IITDescriptor> &T); 124 125 } // End Intrinsic namespace 126 127 } // End llvm namespace 128 129 #endif 130