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