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 /// 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().
37 not_intrinsic = 0, // Must be zero
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
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);
50 /// Intrinsic::getType(ID) - Return the function type for an intrinsic.
52 FunctionType *getType(LLVMContext &Context, ID id,
53 ArrayRef<Type*> Tys = None);
55 /// Intrinsic::isOverloaded(ID) - Returns true if the intrinsic can be
57 bool isOverloaded(ID id);
59 /// Intrinsic::getAttributes(ID) - Return the attributes for an intrinsic.
61 AttributeSet getAttributes(LLVMContext &C, ID id);
63 /// Intrinsic::getDeclaration(M, ID) - Create or insert an LLVM Function
64 /// declaration for an intrinsic, and return it.
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 /// IITDescriptor - This is a type descriptor which explains the type
76 /// requirements of an intrinsic. This is returned by
77 /// getIntrinsicInfoTableEntries.
78 struct IITDescriptor {
79 enum IITDescriptorKind {
80 Void, MMX, Metadata, Half, Float, Double,
81 Integer, Vector, Pointer, Struct,
82 Argument, ExtendVecArgument, TruncVecArgument
86 unsigned Integer_Width;
88 unsigned Vector_Width;
89 unsigned Pointer_AddressSpace;
90 unsigned Struct_NumElements;
91 unsigned Argument_Info;
100 unsigned getArgumentNumber() const {
101 assert(Kind == Argument || Kind == ExtendVecArgument ||
102 Kind == TruncVecArgument);
103 return Argument_Info >> 2;
105 ArgKind getArgumentKind() const {
106 assert(Kind == Argument || Kind == ExtendVecArgument ||
107 Kind == TruncVecArgument);
108 return (ArgKind)(Argument_Info&3);
111 static IITDescriptor get(IITDescriptorKind K, unsigned Field) {
112 IITDescriptor Result = { K, { Field } };
117 /// getIntrinsicInfoTableEntries - Return the IIT table descriptor for the
118 /// specified intrinsic into an array of IITDescriptors.
120 void getIntrinsicInfoTableEntries(ID id, SmallVectorImpl<IITDescriptor> &T);
122 } // End Intrinsic namespace
124 } // End llvm namespace