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   /// A set of enums which specify the assigned numeric values for known llvm
  24   /// calling conventions.
  25   /// @brief LLVM Calling Convention Representation
  26   enum ID {
  27     /// C - The default llvm calling convention, compatible with C.  This
  28     /// convention is the only calling convention that supports varargs calls.
  29     /// As with typical C calling conventions, the callee/caller have to
  30     /// tolerate certain amounts of prototype mismatch.
  31     C = 0,
  32
  33     // Generic LLVM calling conventions.  None of these calling conventions
  34     // support varargs calls, and all assume that the caller and callee
  35     // prototype exactly match.
  36
  37     /// Fast - This calling convention attempts to make calls as fast as
  38     /// possible (e.g. by passing things in registers).
  39     Fast = 8,
  40
  41     // Cold - This calling convention attempts to make code in the caller as
  42     // efficient as possible under the assumption that the call is not commonly
  43     // executed.  As such, these calls often preserve all registers so that the
  44     // call does not break any live ranges in the caller side.
  45     Cold = 9,
  46
  47     // GHC - Calling convention used by the Glasgow Haskell Compiler (GHC).
  48     GHC = 10,
  49
  50     // HiPE - Calling convention used by the High-Performance Erlang Compiler
  51     // (HiPE).
  52     HiPE = 11,
  53
  54     // WebKit JS - Calling convention for stack based JavaScript calls
  55     WebKit_JS = 12,
  56
  57     // Target - This is the start of the target-specific calling conventions,
  58     // e.g. fastcall and thiscall on X86.
  59     FirstTargetCC = 64,
  60
  61     /// X86_StdCall - stdcall is the calling conventions mostly used by the
  62     /// Win32 API. It is basically the same as the C convention with the
  63     /// difference in that the callee is responsible for popping the arguments
  64     /// from the stack.
  65     X86_StdCall = 64,
  66
  67     /// X86_FastCall - 'fast' analog of X86_StdCall. Passes first two arguments
  68     /// in ECX:EDX registers, others - via stack. Callee is responsible for
  69     /// stack cleaning.
  70     X86_FastCall = 65,
  71
  72     /// ARM_APCS - ARM Procedure Calling Standard calling convention (obsolete,
  73     /// but still used on some targets).
  74     ARM_APCS = 66,
  75
  76     /// ARM_AAPCS - ARM Architecture Procedure Calling Standard calling
  77     /// convention (aka EABI). Soft float variant.
  78     ARM_AAPCS = 67,
  79
  80     /// ARM_AAPCS_VFP - Same as ARM_AAPCS, but uses hard floating point ABI.
  81     ARM_AAPCS_VFP = 68,
  82
  83     /// MSP430_INTR - Calling convention used for MSP430 interrupt routines.
  84     MSP430_INTR = 69,
  85
  86     /// X86_ThisCall - Similar to X86_StdCall. Passes first argument in ECX,
  87     /// others via stack. Callee is responsible for stack cleaning. MSVC uses
  88     /// this by default for methods in its ABI.
  89     X86_ThisCall = 70,
  90
  91     /// PTX_Kernel - Call to a PTX kernel.
  92     /// Passes all arguments in parameter space.
  93     PTX_Kernel = 71,
  94
  95     /// PTX_Device - Call to a PTX device function.
  96     /// Passes all arguments in register or parameter space.
  97     PTX_Device = 72,
  98
  99     /// SPIR_FUNC - Calling convention for SPIR non-kernel device functions.
 100     /// No lowering or expansion of arguments.
 101     /// Structures are passed as a pointer to a struct with the byval attribute.
 102     /// Functions can only call SPIR_FUNC and SPIR_KERNEL functions.
 103     /// Functions can only have zero or one return values.
 104     /// Variable arguments are not allowed, except for printf.
 105     /// How arguments/return values are lowered are not specified.
 106     /// Functions are only visible to the devices.
 107     SPIR_FUNC = 75,
 108
 109     /// SPIR_KERNEL - Calling convention for SPIR kernel functions.
 110     /// Inherits the restrictions of SPIR_FUNC, except
 111     /// Cannot have non-void return values.
 112     /// Cannot have variable arguments.
 113     /// Can also be called by the host.
 114     /// Is externally visible.
 115     SPIR_KERNEL = 76,
 116
 117     /// Intel_OCL_BI - Calling conventions for Intel OpenCL built-ins
 118     Intel_OCL_BI = 77,
 119
 120     /// \brief The C convention as specified in the x86-64 supplement to the
 121     /// System V ABI, used on most non-Windows systems.
 122     X86_64_SysV = 78,
 123
 124     /// \brief The C convention as implemented on Windows/x86-64. This
 125     /// convention differs from the more common \c X86_64_SysV convention
 126     /// in a number of ways, most notably in that XMM registers used to pass
 127     /// arguments are shadowed by GPRs, and vice versa.
 128     X86_64_Win64 = 79
 129   };
 130 } // End CallingConv namespace
 131
 132 } // End llvm namespace
 133
 134 #endif