include/llvm/Intrinsics.h

   1 //===-- llvm/Instrinsics.h - LLVM Intrinsic Function Handling ---*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source 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
  26 /// Intrinsic Namespace - This namespace contains an enum with a value for
  27 /// every intrinsic/builtin function known by LLVM.  These enum values are
  28 /// returned by Function::getIntrinsicID().
  29 ///
  30 namespace Intrinsic {
  31   enum ID {
  32     not_intrinsic = 0,   // Must be zero
  33
  34     // Get the intrinsic enums generated from Intrinsics.td
  35 #define GET_INTRINSIC_ENUM_VALUES
  36 #include "llvm/Intrinsics.gen"
  37 #undef GET_INTRINSIC_ENUM_VALUES
  38     , num_intrinsics
  39   };
  40
  41   /// Intrinsic::getName(ID) - Return the LLVM name for an intrinsic, such as
  42   /// "llvm.ppc.altivec.lvx".
  43   std::string getName(ID id, const Type **Tys = 0, unsigned numTys = 0);
  44
  45   /// Intrinsic::getType(ID) - Return the function type for an intrinsic.
  46   ///
  47   const FunctionType *getType(ID id, const Type **Tys = 0, unsigned numTys = 0);
  48
  49   /// Intrinsic::getDeclaration(M, ID) - Create or insert an LLVM Function
  50   /// declaration for an intrinsic, and return it.
  51   Function *getDeclaration(Module *M, ID id, const Type **Tys = 0,
  52                            unsigned numTys = 0);
  53
  54 } // End Intrinsic namespace
  55
  56 } // End llvm namespace
  57
  58 #endif