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     vastart,        // Used to implement the va_start macro in C
  31     vaend,          // Used to implement the va_end macro in C
  32     vacopy,         // Used to implement the va_copy macro in C
  33
  34     // Code generator intrinsics.
  35     returnaddress,  // Yields the return address of a dynamic call frame
  36     frameaddress,   // Yields the frame address of a dynamic call frame
  37
  38     // setjmp/longjmp intrinsics.
  39     setjmp,         // Used to represent a setjmp call in C
  40     longjmp,        // Used to represent a longjmp call in C
  41     sigsetjmp,      // Used to represent a sigsetjmp call in C
  42     siglongjmp,     // Used to represent a siglongjmp call in C
  43
  44     // Garbage Collection intrinsics.
  45     gcroot,         // Defines a new GC root on the stack
  46     gcread,         // Defines a read of a heap object  (for read barriers)
  47     gcwrite,        // Defines a write to a heap object (for write barriers)
  48
  49     // Debugging intrinsics.
  50     dbg_stoppoint,    // Represents source lines and breakpointable places
  51     dbg_region_start, // Start of a region
  52     dbg_region_end,   // End of a region
  53     dbg_func_start,   // Start of a function
  54     dbg_declare,      // Declare a local object
  55
  56
  57     // Standard libc functions.
  58     memcpy,         // Copy non-overlapping memory blocks
  59     memmove,        // Copy potentially overlapping memory blocks
  60     memset,         // Fill memory with a byte value
  61
  62     // libm related functions.
  63     isunordered,    // Return true if either argument is a NaN
  64
  65     // Input/Output intrinsics.
  66     readport,
  67     writeport,
  68     readio,
  69     writeio,
  70
  71     //===------------------------------------------------------------------===//
  72     // This section defines intrinsic functions used to represent Alpha
  73     // instructions.
  74     //
  75     alpha_ctlz,     // CTLZ (count leading zero): counts the number of leading
  76                     // zeros in the given ulong value
  77
  78     alpha_cttz,     // CTTZ (count trailing zero): counts the number of trailing
  79                     // zeros in the given ulong value
  80
  81     alpha_ctpop,    // CTPOP (count population): counts the number of ones in
  82                     // the given ulong value
  83
  84     alpha_umulh,    // UMULH (unsigned multiply quadword high): Takes two 64-bit
  85                     // (ulong) values, and returns the upper 64 bits of their
  86                     // 128 bit product as a ulong
  87
  88     alpha_vecop,    // A generic vector operation. This function is used to
  89                     // represent various Alpha vector/multimedia instructions.
  90                     // It takes 4 parameters:
  91                     //  - the first two are 2 ulong vectors
  92                     //  - the third (uint) is the size (in bytes) of each
  93                     //    vector element. Thus a value of 1 means that the two
  94                     //    input vectors consist of 8 bytes
  95                     //  - the fourth (uint) is the operation to be performed on
  96                     //    the vectors. Its possible values are defined in the
  97                     //    enumeration AlphaVecOps.
  98
  99     alpha_pup,      // A pack/unpack operation. This function is used to
 100                     // represent Alpha pack/unpack operations.
 101                     // It takes 3 parameters:
 102                     //  - the first is an ulong to pack/unpack
 103                     //  - the second (uint) is the size of each component
 104                     //    Valid values are 2 (word) or 4 (longword)
 105                     //  - the third (uint) is the operation to be performed.
 106                     //    Possible values defined in the enumeration
 107                     //    AlphaPupOps
 108
 109     alpha_bytezap,  // This intrinsic function takes two parameters: a ulong
 110                     // (64-bit) value and a ubyte value, and returns a ulong.
 111                     // Each bit in the ubyte corresponds to a byte in the
 112                     // ulong. If the bit is 0, the byte in the output equals
 113                     // the corresponding byte in the input, else the byte in
 114                     // the output is zero.
 115
 116     alpha_bytemanip,// This intrinsic function represents all Alpha byte
 117                     // manipulation instructions. It takes 3 parameters:
 118                     //  - The first two are ulong inputs to operate on
 119                     //  - The third (uint) is the operation to perform.
 120                     //    Possible values defined in the enumeration
 121                     //    AlphaByteManipOps
 122
 123     alpha_dfpbop,   // This intrinsic function represents Alpha instructions
 124                     // that operate on two doubles and return a double. The
 125                     // first two parameters are the two double values to
 126                     // operate on, and the third is a uint that specifies the
 127                     // operation to perform. Its possible values are defined in
 128                     // the enumeration AlphaFloatingBinaryOps
 129
 130     alpha_dfpuop,   // This intrinsic function represents operation on a single
 131                     // double precision floating point value. The first
 132                     // paramters is the value and the second is the operation.
 133                     // The possible values for the operations are defined in the
 134                     // enumeration AlphaFloatingUnaryOps
 135
 136     alpha_unordered,// This intrinsic function tests if two double precision
 137                     // floating point values are unordered. It has two
 138                     // parameters: the two values to be tested. It return a
 139                     // boolean true if the two are unordered, else false.
 140
 141     alpha_uqtodfp,  // A generic function that converts a ulong to a double.
 142                     // How the conversion is performed is specified by the
 143                     // second parameter, the possible values for which are
 144                     // defined in the AlphaUqToDfpOps enumeration
 145
 146     alpha_uqtosfp,  // A generic function that converts a ulong to a float.
 147                     // How the conversion is performed is specified by the
 148                     // second parameter, the possible values for which are
 149                     // defined in the AlphaUqToSfpOps enumeration
 150
 151     alpha_dfptosq,  // A generic function that converts double to a long.
 152                     // How the conversion is performed is specified by the
 153                     // second parameter, the possible values for which are
 154                     // defined in the AlphaDfpToSqOps enumeration
 155
 156     alpha_sfptosq,  // A generic function that converts a float to a long.
 157                     // How the conversion is performed is specified by the
 158                     // second parameter, the possible values for which are
 159                     // defined in the AlphaSfpToSq enumeration
 160   };
 161
 162 } // End Intrinsic namespace
 163
 164 } // End llvm namespace
 165
 166 #endif