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 /// Intrinsic Namespace - This namespace contains an enum with a value for
  22 /// every intrinsic/builtin function known by LLVM.  These enum values are
  23 /// returned by Function::getIntrinsicID().
  24 ///
  25 namespace Intrinsic {
  26   enum ID {
  27     not_intrinsic = 0,   // Must be zero
  28
  29     // Varargs handling intrinsics...
  30     va_start,       // Used to implement the va_start macro in C
  31     va_end,         // Used to implement the va_end macro in C
  32     va_copy,        // Used to implement the va_copy macro in C
  33
  34     // Setjmp/Longjmp intrinsics...
  35     setjmp,         // Used to represent a setjmp call in C
  36     longjmp,        // Used to represent a longjmp call in C
  37     sigsetjmp,      // Used to represent a sigsetjmp call in C
  38     siglongjmp,     // Used to represent a siglongjmp call in C
  39
  40     // Debugging intrinsics...
  41     dbg_stoppoint,    // Represents source lines and breakpointable places
  42     dbg_region_start, // Start of a region
  43     dbg_region_end,   // End of a region
  44     dbg_func_start,   // Start of a function
  45     dbg_declare,      // Declare a local object
  46
  47     //===------------------------------------------------------------------===//
  48     // This section defines intrinsic functions used to represent Alpha
  49     // instructions...
  50     //
  51     alpha_ctlz,     // CTLZ (count leading zero): counts the number of leading
  52                     // zeros in the given ulong value
  53
  54     alpha_cttz,     // CTTZ (count trailing zero): counts the number of trailing
  55                     // zeros in the given ulong value
  56
  57     alpha_ctpop,    // CTPOP (count population): counts the number of ones in
  58                     // the given ulong value
  59
  60     alpha_umulh,    // UMULH (unsigned multiply quadword high): Takes two 64-bit
  61                     // (ulong) values, and returns the upper 64 bits of their
  62                     // 128 bit product as a ulong
  63
  64     alpha_vecop,    // A generic vector operation. This function is used to
  65                     // represent various Alpha vector/multimedia instructions.
  66                     // It takes 4 parameters:
  67                     //  - the first two are 2 ulong vectors
  68                     //  - the third (uint) is the size (in bytes) of each
  69                     //    vector element. Thus a value of 1 means that the two
  70                     //    input vectors consist of 8 bytes
  71                     //  - the fourth (uint) is the operation to be performed on
  72                     //    the vectors. Its possible values are defined in the
  73                     //    enumeration AlphaVecOps.
  74
  75     alpha_pup,      // A pack/unpack operation. This function is used to
  76                     // represent Alpha pack/unpack operations.
  77                     // It takes 3 parameters:
  78                     //  - the first is an ulong to pack/unpack
  79                     //  - the second (uint) is the size of each component
  80                     //    Valid values are 2 (word) or 4 (longword)
  81                     //  - the third (uint) is the operation to be performed.
  82                     //    Possible values defined in the enumeration
  83                     //    AlphaPupOps
  84
  85     alpha_bytezap,  // This intrinsic function takes two parameters: a ulong
  86                     // (64-bit) value and a ubyte value, and returns a ulong.
  87                     // Each bit in the ubyte corresponds to a byte in the
  88                     // ulong. If the bit is 0, the byte in the output equals
  89                     // the corresponding byte in the input, else the byte in
  90                     // the output is zero.
  91
  92     alpha_bytemanip,// This intrinsic function represents all Alpha byte
  93                     // manipulation instructions. It takes 3 parameters:
  94                     //  - The first two are ulong inputs to operate on
  95                     //  - The third (uint) is the operation to perform.
  96                     //    Possible values defined in the enumeration
  97                     //    AlphaByteManipOps
  98
  99     alpha_dfpbop,   // This intrinsic function represents Alpha instructions
 100                     // that operate on two doubles and return a double. The
 101                     // first two parameters are the two double values to
 102                     // operate on, and the third is a uint that specifies the
 103                     // operation to perform. Its possible values are defined in
 104                     // the enumeration AlphaFloatingBinaryOps
 105
 106     alpha_dfpuop,   // This intrinsic function represents operation on a single
 107                     // double precision floating point value. The first
 108                     // paramters is the value and the second is the operation.
 109                     // The possible values for the operations are defined in the
 110                     // enumeration AlphaFloatingUnaryOps
 111
 112     alpha_unordered,// This intrinsic function tests if two double precision
 113                     // floating point values are unordered. It has two
 114                     // parameters: the two values to be tested. It return a
 115                     // boolean true if the two are unordered, else false.
 116
 117     alpha_uqtodfp,  // A generic function that converts a ulong to a double.
 118                     // How the conversion is performed is specified by the
 119                     // second parameter, the possible values for which are
 120                     // defined in the AlphaUqToDfpOps enumeration
 121
 122     alpha_uqtosfp,  // A generic function that converts a ulong to a float.
 123                     // How the conversion is performed is specified by the
 124                     // second parameter, the possible values for which are
 125                     // defined in the AlphaUqToSfpOps enumeration
 126
 127     alpha_dfptosq,  // A generic function that converts double to a long.
 128                     // How the conversion is performed is specified by the
 129                     // second parameter, the possible values for which are
 130                     // defined in the AlphaDfpToSqOps enumeration
 131
 132     alpha_sfptosq,  // A generic function that converts a float to a long.
 133                     // How the conversion is performed is specified by the
 134                     // second parameter, the possible values for which are
 135                     // defined in the AlphaSfpToSq enumeration
 136   };
 137
 138 } // End Intrinsic namespace
 139
 140 } // End llvm namespace
 141
 142 #endif