Intrinsics.h revision 8c3a54998bcbdd10e1997519ba1c17b7f0850709 
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
22namespace llvm {
23
24class Type;
25class FunctionType;
26class Function;
27class LLVMContext;
28class Module;
29class 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///
35namespace 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 = ArrayRef<Type*>());
49
50  /// Intrinsic::getType(ID) - Return the function type for an intrinsic.
51  ///
52  FunctionType *getType(LLVMContext &Context, ID id,
53                        ArrayRef<Type*> Tys = ArrayRef<Type*>());
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,
71                           ArrayRef<Type*> Tys = ArrayRef<Type*>());
72
73  /// Map a GCC builtin name to an intrinsic ID.
74  ID getIntrinsicForGCCBuiltin(const char *Prefix, const char *BuiltinName);
75
76  /// IITDescriptor - This is a type descriptor which explains the type
77  /// requirements of an intrinsic.  This is returned by
78  /// getIntrinsicInfoTableEntries.
79  struct IITDescriptor {
80    enum IITDescriptorKind {
81      Void, MMX, Metadata, Half, Float, Double,
82      Integer, Vector, Pointer, Struct,
83      Argument, ExtendVecArgument, TruncVecArgument
84    } Kind;
85
86    union {
87      unsigned Integer_Width;
88      unsigned Float_Width;
89      unsigned Vector_Width;
90      unsigned Pointer_AddressSpace;
91      unsigned Struct_NumElements;
92      unsigned Argument_Info;
93    };
94
95    enum ArgKind {
96      AK_AnyInteger,
97      AK_AnyFloat,
98      AK_AnyVector,
99      AK_AnyPointer
100    };
101    unsigned getArgumentNumber() const {
102      assert(Kind == Argument || Kind == ExtendVecArgument ||
103             Kind == TruncVecArgument);
104      return Argument_Info >> 2;
105    }
106    ArgKind getArgumentKind() const {
107      assert(Kind == Argument || Kind == ExtendVecArgument ||
108             Kind == TruncVecArgument);
109      return (ArgKind)(Argument_Info&3);
110    }
111
112    static IITDescriptor get(IITDescriptorKind K, unsigned Field) {
113      IITDescriptor Result = { K, { Field } };
114      return Result;
115    }
116  };
117
118  /// getIntrinsicInfoTableEntries - Return the IIT table descriptor for the
119  /// specified intrinsic into an array of IITDescriptors.
120  ///
121  void getIntrinsicInfoTableEntries(ID id, SmallVectorImpl<IITDescriptor> &T);
122
123} // End Intrinsic namespace
124
125} // End llvm namespace
126
127#endif
128