include/llvm/IR/CallingConv.h

   1 //===-- llvm/CallingConv.h - LLVM Calling Conventions -----------*- 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 LLVM's set of calling conventions.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef LLVM_IR_CALLINGCONV_H
  15 #define LLVM_IR_CALLINGCONV_H
  16
  17 namespace llvm {
  18
  19 /// CallingConv Namespace - This namespace contains an enum with a value for
  20 /// the well-known calling conventions.
  21 ///
  22 namespace CallingConv {
  23   /// LLVM IR allows to use arbitrary numbers as calling convention identifiers.
  24   typedef unsigned ID;
  25
  26   /// A set of enums which specify the assigned numeric values for known llvm
  27   /// calling conventions.
  28   /// @brief LLVM Calling Convention Representation
  29   enum {
  30     /// C - The default llvm calling convention, compatible with C.  This
  31     /// convention is the only calling convention that supports varargs calls.
  32     /// As with typical C calling conventions, the callee/caller have to
  33     /// tolerate certain amounts of prototype mismatch.
  34     C = 0,
  35
  36     // Generic LLVM calling conventions.  None of these calling conventions
  37     // support varargs calls, and all assume that the caller and callee
  38     // prototype exactly match.
  39
  40     /// Fast - This calling convention attempts to make calls as fast as
  41     /// possible (e.g. by passing things in registers).
  42     Fast = 8,
  43
  44     // Cold - This calling convention attempts to make code in the caller as
  45     // efficient as possible under the assumption that the call is not commonly
  46     // executed.  As such, these calls often preserve all registers so that the
  47     // call does not break any live ranges in the caller side.
  48     Cold = 9,
  49
  50     // GHC - Calling convention used by the Glasgow Haskell Compiler (GHC).
  51     GHC = 10,
  52
  53     // HiPE - Calling convention used by the High-Performance Erlang Compiler
  54     // (HiPE).
  55     HiPE = 11,
  56
  57     // WebKit JS - Calling convention for stack based JavaScript calls
  58     WebKit_JS = 12,
  59
  60     // AnyReg - Calling convention for dynamic register based calls (e.g.
  61     // stackmap and patchpoint intrinsics).
  62     AnyReg = 13,
  63
  64     // PreserveMost - Calling convention for runtime calls that preserves most
  65     // registers.
  66     PreserveMost = 14,
  67
  68     // PreserveAll - Calling convention for runtime calls that preserves
  69     // (almost) all registers.
  70     PreserveAll = 15,
  71
  72     // Swift - Calling convention for Swift.
  73     Swift = 16,
  74
  75     // CXX_FAST_TLS - Calling convention for access functions.
  76     CXX_FAST_TLS = 17,
  77
  78     // Target - This is the start of the target-specific calling conventions,
  79     // e.g. fastcall and thiscall on X86.
  80     FirstTargetCC = 64,
  81
  82     /// X86_StdCall - stdcall is the calling conventions mostly used by the
  83     /// Win32 API. It is basically the same as the C convention with the
  84     /// difference in that the callee is responsible for popping the arguments
  85     /// from the stack.
  86     X86_StdCall = 64,
  87
  88     /// X86_FastCall - 'fast' analog of X86_StdCall. Passes first two arguments
  89     /// in ECX:EDX registers, others - via stack. Callee is responsible for
  90     /// stack cleaning.
  91     X86_FastCall = 65,
  92
  93     /// ARM_APCS - ARM Procedure Calling Standard calling convention (obsolete,
  94     /// but still used on some targets).
  95     ARM_APCS = 66,
  96
  97     /// ARM_AAPCS - ARM Architecture Procedure Calling Standard calling
  98     /// convention (aka EABI). Soft float variant.
  99     ARM_AAPCS = 67,
 100
 101     /// ARM_AAPCS_VFP - Same as ARM_AAPCS, but uses hard floating point ABI.
 102     ARM_AAPCS_VFP = 68,
 103
 104     /// MSP430_INTR - Calling convention used for MSP430 interrupt routines.
 105     MSP430_INTR = 69,
 106
 107     /// X86_ThisCall - Similar to X86_StdCall. Passes first argument in ECX,
 108     /// others via stack. Callee is responsible for stack cleaning. MSVC uses
 109     /// this by default for methods in its ABI.
 110     X86_ThisCall = 70,
 111
 112     /// PTX_Kernel - Call to a PTX kernel.
 113     /// Passes all arguments in parameter space.
 114     PTX_Kernel = 71,
 115
 116     /// PTX_Device - Call to a PTX device function.
 117     /// Passes all arguments in register or parameter space.
 118     PTX_Device = 72,
 119
 120     /// SPIR_FUNC - Calling convention for SPIR non-kernel device functions.
 121     /// No lowering or expansion of arguments.
 122     /// Structures are passed as a pointer to a struct with the byval attribute.
 123     /// Functions can only call SPIR_FUNC and SPIR_KERNEL functions.
 124     /// Functions can only have zero or one return values.
 125     /// Variable arguments are not allowed, except for printf.
 126     /// How arguments/return values are lowered are not specified.
 127     /// Functions are only visible to the devices.
 128     SPIR_FUNC = 75,
 129
 130     /// SPIR_KERNEL - Calling convention for SPIR kernel functions.
 131     /// Inherits the restrictions of SPIR_FUNC, except
 132     /// Cannot have non-void return values.
 133     /// Cannot have variable arguments.
 134     /// Can also be called by the host.
 135     /// Is externally visible.
 136     SPIR_KERNEL = 76,
 137
 138     /// Intel_OCL_BI - Calling conventions for Intel OpenCL built-ins
 139     Intel_OCL_BI = 77,
 140
 141     /// \brief The C convention as specified in the x86-64 supplement to the
 142     /// System V ABI, used on most non-Windows systems.
 143     X86_64_SysV = 78,
 144
 145     /// \brief The C convention as implemented on Windows/x86-64. This
 146     /// convention differs from the more common \c X86_64_SysV convention
 147     /// in a number of ways, most notably in that XMM registers used to pass
 148     /// arguments are shadowed by GPRs, and vice versa.
 149     X86_64_Win64 = 79,
 150
 151     /// \brief MSVC calling convention that passes vectors and vector aggregates
 152     /// in SSE registers.
 153     X86_VectorCall = 80,
 154
 155     /// \brief Calling convention used by HipHop Virtual Machine (HHVM) to
 156     /// perform calls to and from translation cache, and for calling PHP
 157     /// functions.
 158     /// HHVM calling convention supports tail/sibling call elimination.
 159     HHVM = 81,
 160
 161     /// \brief HHVM calling convention for invoking C/C++ helpers.
 162     HHVM_C = 82,
 163
 164     /// The highest possible calling convention ID. Must be some 2^k - 1.
 165     MaxID = 1023
 166   };
 167 } // End CallingConv namespace
 168
 169 } // End llvm namespace
 170
 171 #endif