include/llvm/Intrinsics.h

   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_INTRINSICS_H
  17 #define LLVM_INTRINSICS_H
  18
  19 #include <string>
  20
  21 namespace llvm {
  22
  23 class Type;
  24 class FunctionType;
  25 class Function;
  26 class Module;
  27 class AttrListPtr;
  28
  29 /// Intrinsic Namespace - This namespace contains an enum with a value for
  30 /// every intrinsic/builtin function known by LLVM.  These enum values are
  31 /// returned by Function::getIntrinsicID().
  32 ///
  33 namespace Intrinsic {
  34   enum ID {
  35     not_intrinsic = 0,   // Must be zero
  36
  37     // Get the intrinsic enums generated from Intrinsics.td
  38 #define GET_INTRINSIC_ENUM_VALUES
  39 #include "llvm/Intrinsics.gen"
  40 #undef GET_INTRINSIC_ENUM_VALUES
  41     , num_intrinsics
  42   };
  43
  44   /// Intrinsic::getName(ID) - Return the LLVM name for an intrinsic, such as
  45   /// "llvm.ppc.altivec.lvx".
  46   std::string getName(ID id, const Type **Tys = 0, unsigned numTys = 0);
  47
  48   /// Intrinsic::getType(ID) - Return the function type for an intrinsic.
  49   ///
  50   const FunctionType *getType(ID id, const Type **Tys = 0, unsigned numTys = 0);
  51
  52   /// Intrinsic::getAttributes(ID) - Return the attributes for an intrinsic.
  53   ///
  54   AttrListPtr getAttributes(ID id);
  55
  56   /// Intrinsic::getDeclaration(M, ID) - Create or insert an LLVM Function
  57   /// declaration for an intrinsic, and return it.
  58   ///
  59   /// The Tys and numTys parameters are for intrinsics with overloaded types
  60   /// (i.e., those using iAny or fAny). For a declaration for an overloaded
  61   /// intrinsic, Tys should point to an array of numTys pointers to Type,
  62   /// and must provide exactly one type for each overloaded type in the
  63   /// intrinsic.
  64   Function *getDeclaration(Module *M, ID id, const Type **Tys = 0,
  65                            unsigned numTys = 0);
  66
  67 } // End Intrinsic namespace
  68
  69 } // End llvm namespace
  70
  71 #endif