LLVM 19.0.0git
CallingConv.h
Go to the documentation of this file.
1//===- llvm/CallingConv.h - LLVM Calling Conventions ------------*- C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8//
9// This file defines LLVM's set of calling conventions.
10//
11//===----------------------------------------------------------------------===//
12
13#ifndef LLVM_IR_CALLINGCONV_H
14#define LLVM_IR_CALLINGCONV_H
15
16namespace llvm {
17
18/// CallingConv Namespace - This namespace contains an enum with a value for
19/// the well-known calling conventions.
20///
21namespace CallingConv {
22
23 /// LLVM IR allows to use arbitrary numbers as calling convention identifiers.
24 using ID = unsigned;
25
26 /// A set of enums which specify the assigned numeric values for known llvm
27 /// calling conventions.
28 /// LLVM Calling Convention Representation
29 enum {
30 /// The default llvm calling convention, compatible with C. This convention
31 /// is the only one that supports varargs calls. As with typical C calling
32 /// conventions, the callee/caller have to tolerate certain amounts of
33 /// prototype mismatch.
34 C = 0,
35
36 // Generic LLVM calling conventions. None of these support varargs calls,
37 // and all assume that the caller and callee prototype exactly match.
38
39 /// Attempts to make calls as fast as possible (e.g. by passing things in
40 /// registers).
41 Fast = 8,
42
43 /// Attempts to make code in the caller as efficient as possible under the
44 /// assumption that the call is not commonly executed. As such, these calls
45 /// often preserve all registers so that the call does not break any live
46 /// ranges in the caller side.
47 Cold = 9,
48
49 /// Used by the Glasgow Haskell Compiler (GHC).
50 GHC = 10,
51
52 /// Used by the High-Performance Erlang Compiler (HiPE).
53 HiPE = 11,
54
55 /// OBSOLETED - Used for stack based JavaScript calls
56 // WebKit_JS = 12,
57
58 /// Used for dynamic register based calls (e.g. stackmap and patchpoint
59 /// intrinsics).
60 AnyReg = 13,
61
62 /// Used for runtime calls that preserves most registers.
64
65 /// Used for runtime calls that preserves (almost) all registers.
67
68 /// Calling convention for Swift.
69 Swift = 16,
70
71 /// Used for access functions.
73
74 /// Attemps to make calls as fast as possible while guaranteeing that tail
75 /// call optimization can always be performed.
76 Tail = 18,
77
78 /// Special calling convention on Windows for calling the Control Guard
79 /// Check ICall funtion. The function takes exactly one argument (address of
80 /// the target function) passed in the first argument register, and has no
81 /// return value. All register values are preserved.
83
84 /// This follows the Swift calling convention in how arguments are passed
85 /// but guarantees tail calls will be made by making the callee clean up
86 /// their stack.
88
89 /// Used for runtime calls that preserves none general registers.
91
92 /// This is the start of the target-specific calling conventions, e.g.
93 /// fastcall and thiscall on X86.
95
96 /// stdcall is mostly used by the Win32 API. It is basically the same as the
97 /// C convention with the difference in that the callee is responsible for
98 /// popping the arguments from the stack.
100
101 /// 'fast' analog of X86_StdCall. Passes first two arguments in ECX:EDX
102 /// registers, others - via stack. Callee is responsible for stack cleaning.
104
105 /// ARM Procedure Calling Standard (obsolete, but still used on some
106 /// targets).
108
109 /// ARM Architecture Procedure Calling Standard calling convention (aka
110 /// EABI). Soft float variant.
112
113 /// Same as ARM_AAPCS, but uses hard floating point ABI.
115
116 /// Used for MSP430 interrupt routines.
118
119 /// Similar to X86_StdCall. Passes first argument in ECX, others via stack.
120 /// Callee is responsible for stack cleaning. MSVC uses this by default for
121 /// methods in its ABI.
123
124 /// Call to a PTX kernel. Passes all arguments in parameter space.
126
127 /// Call to a PTX device function. Passes all arguments in register or
128 /// parameter space.
130
131 /// Used for SPIR non-kernel device functions. No lowering or expansion of
132 /// arguments. Structures are passed as a pointer to a struct with the
133 /// byval attribute. Functions can only call SPIR_FUNC and SPIR_KERNEL
134 /// functions. Functions can only have zero or one return values. Variable
135 /// arguments are not allowed, except for printf. How arguments/return
136 /// values are lowered are not specified. Functions are only visible to the
137 /// devices.
139
140 /// Used for SPIR kernel functions. Inherits the restrictions of SPIR_FUNC,
141 /// except it cannot have non-void return values, it cannot have variable
142 /// arguments, it can also be called by the host or it is externally
143 /// visible.
145
146 /// Used for Intel OpenCL built-ins.
148
149 /// The C convention as specified in the x86-64 supplement to the System V
150 /// ABI, used on most non-Windows systems.
152
153 /// The C convention as implemented on Windows/x86-64 and AArch64. It
154 /// differs from the more common \c X86_64_SysV convention in a number of
155 /// ways, most notably in that XMM registers used to pass arguments are
156 /// shadowed by GPRs, and vice versa. On AArch64, this is identical to the
157 /// normal C (AAPCS) calling convention for normal functions, but floats are
158 /// passed in integer registers to variadic functions.
159 Win64 = 79,
160
161 /// MSVC calling convention that passes vectors and vector aggregates in SSE
162 /// registers.
164
165 /// Placeholders for HHVM calling conventions (deprecated, removed).
168
169 /// x86 hardware interrupt context. Callee may take one or two parameters,
170 /// where the 1st represents a pointer to hardware context frame and the 2nd
171 /// represents hardware error code, the presence of the later depends on the
172 /// interrupt vector taken. Valid for both 32- and 64-bit subtargets.
174
175 /// Used for AVR interrupt routines.
177
178 /// Used for AVR signal routines.
180
181 /// Used for special AVR rtlib functions which have an "optimized"
182 /// convention to preserve registers.
184
185 /// Used for Mesa vertex shaders, or AMDPAL last shader stage before
186 /// rasterization (vertex shader if tessellation and geometry are not in
187 /// use, or otherwise copy shader if one is needed).
189
190 /// Used for Mesa/AMDPAL geometry shaders.
192
193 /// Used for Mesa/AMDPAL pixel shaders.
195
196 /// Used for Mesa/AMDPAL compute shaders.
198
199 /// Used for AMDGPU code object kernels.
201
202 /// Register calling convention used for parameters transfer optimization
204
205 /// Used for Mesa/AMDPAL hull shaders (= tessellation control shaders).
207
208 /// Used for special MSP430 rtlib functions which have an "optimized"
209 /// convention using additional registers.
211
212 /// Used for AMDPAL vertex shader if tessellation is in use.
214
215 /// Used for AMDPAL shader stage before geometry shader if geometry is in
216 /// use. So either the domain (= tessellation evaluation) shader if
217 /// tessellation is in use, or otherwise the vertex shader.
219
220 /// Used between AArch64 Advanced SIMD functions
222
223 /// Used between AArch64 SVE functions
225
226 /// For emscripten __invoke_* functions. The first argument is required to
227 /// be the function ptr being indirectly called. The remainder matches the
228 /// regular calling convention.
230
231 /// Used for AMD graphics targets.
233
234 /// Used for M68k interrupt routines.
236
237 /// Preserve X0-X13, X19-X29, SP, Z0-Z31, P0-P15.
239
240 /// Preserve X2-X15, X19-X29, SP, Z0-Z31, P0-P15.
242
243 /// Used on AMDGPUs to give the middle-end more control over argument
244 /// placement.
246
247 /// Used on AMDGPUs to give the middle-end more control over argument
248 /// placement. Preserves active lane values for input VGPRs.
250
251 /// Used for M68k rtd-based CC (similar to X86's stdcall).
252 M68k_RTD = 106,
253
254 /// Used by GraalVM. Two additional registers are reserved.
255 GRAAL = 107,
256
257 /// Calling convention used in the ARM64EC ABI to implement calls between
258 /// x64 code and thunks. This is basically the x64 calling convention using
259 /// ARM64 register names. The first parameter is mapped to x9.
261
262 /// Calling convention used in the ARM64EC ABI to implement calls between
263 /// ARM64 code and thunks. This is just the ARM64 calling convention,
264 /// except that the first parameter is mapped to x9.
266
267 /// The highest possible ID. Must be some 2^k - 1.
268 MaxID = 1023
269 };
270
271} // end namespace CallingConv
272
273} // end namespace llvm
274
275#endif // LLVM_IR_CALLINGCONV_H
@ ARM64EC_Thunk_Native
Calling convention used in the ARM64EC ABI to implement calls between ARM64 code and thunks.
Definition: CallingConv.h:265
@ AArch64_VectorCall
Used between AArch64 Advanced SIMD functions.
Definition: CallingConv.h:221
@ X86_64_SysV
The C convention as specified in the x86-64 supplement to the System V ABI, used on most non-Windows ...
Definition: CallingConv.h:151
@ AMDGPU_CS
Used for Mesa/AMDPAL compute shaders.
Definition: CallingConv.h:197
@ M68k_INTR
Used for M68k interrupt routines.
Definition: CallingConv.h:235
@ AMDGPU_VS
Used for Mesa vertex shaders, or AMDPAL last shader stage before rasterization (vertex shader if tess...
Definition: CallingConv.h:188
@ MSP430_BUILTIN
Used for special MSP430 rtlib functions which have an "optimized" convention using additional registe...
Definition: CallingConv.h:210
@ AVR_SIGNAL
Used for AVR signal routines.
Definition: CallingConv.h:179
@ HiPE
Used by the High-Performance Erlang Compiler (HiPE).
Definition: CallingConv.h:53
@ Swift
Calling convention for Swift.
Definition: CallingConv.h:69
@ AMDGPU_KERNEL
Used for AMDGPU code object kernels.
Definition: CallingConv.h:200
@ MaxID
The highest possible ID. Must be some 2^k - 1.
Definition: CallingConv.h:268
@ AArch64_SVE_VectorCall
Used between AArch64 SVE functions.
Definition: CallingConv.h:224
@ ARM_APCS
ARM Procedure Calling Standard (obsolete, but still used on some targets).
Definition: CallingConv.h:107
@ CFGuard_Check
Special calling convention on Windows for calling the Control Guard Check ICall funtion.
Definition: CallingConv.h:82
@ AVR_INTR
Used for AVR interrupt routines.
Definition: CallingConv.h:176
@ PreserveMost
Used for runtime calls that preserves most registers.
Definition: CallingConv.h:63
@ AnyReg
OBSOLETED - Used for stack based JavaScript calls.
Definition: CallingConv.h:60
@ AMDGPU_Gfx
Used for AMD graphics targets.
Definition: CallingConv.h:232
@ DUMMY_HHVM
Placeholders for HHVM calling conventions (deprecated, removed).
Definition: CallingConv.h:166
@ AMDGPU_CS_ChainPreserve
Used on AMDGPUs to give the middle-end more control over argument placement.
Definition: CallingConv.h:249
@ AMDGPU_HS
Used for Mesa/AMDPAL hull shaders (= tessellation control shaders).
Definition: CallingConv.h:206
@ ARM_AAPCS
ARM Architecture Procedure Calling Standard calling convention (aka EABI).
Definition: CallingConv.h:111
@ AMDGPU_GS
Used for Mesa/AMDPAL geometry shaders.
Definition: CallingConv.h:191
@ AArch64_SME_ABI_Support_Routines_PreserveMost_From_X2
Preserve X2-X15, X19-X29, SP, Z0-Z31, P0-P15.
Definition: CallingConv.h:241
@ CXX_FAST_TLS
Used for access functions.
Definition: CallingConv.h:72
@ X86_INTR
x86 hardware interrupt context.
Definition: CallingConv.h:173
@ AArch64_SME_ABI_Support_Routines_PreserveMost_From_X0
Preserve X0-X13, X19-X29, SP, Z0-Z31, P0-P15.
Definition: CallingConv.h:238
@ WASM_EmscriptenInvoke
For emscripten __invoke_* functions.
Definition: CallingConv.h:229
@ AMDGPU_CS_Chain
Used on AMDGPUs to give the middle-end more control over argument placement.
Definition: CallingConv.h:245
@ AVR_BUILTIN
Used for special AVR rtlib functions which have an "optimized" convention to preserve registers.
Definition: CallingConv.h:183
@ GHC
Used by the Glasgow Haskell Compiler (GHC).
Definition: CallingConv.h:50
@ AMDGPU_PS
Used for Mesa/AMDPAL pixel shaders.
Definition: CallingConv.h:194
@ Cold
Attempts to make code in the caller as efficient as possible under the assumption that the call is no...
Definition: CallingConv.h:47
@ X86_ThisCall
Similar to X86_StdCall.
Definition: CallingConv.h:122
@ PTX_Device
Call to a PTX device function.
Definition: CallingConv.h:129
@ SPIR_KERNEL
Used for SPIR kernel functions.
Definition: CallingConv.h:144
@ PreserveAll
Used for runtime calls that preserves (almost) all registers.
Definition: CallingConv.h:66
@ X86_StdCall
stdcall is mostly used by the Win32 API.
Definition: CallingConv.h:99
@ FirstTargetCC
This is the start of the target-specific calling conventions, e.g.
Definition: CallingConv.h:94
@ SPIR_FUNC
Used for SPIR non-kernel device functions.
Definition: CallingConv.h:138
@ Fast
Attempts to make calls as fast as possible (e.g.
Definition: CallingConv.h:41
@ MSP430_INTR
Used for MSP430 interrupt routines.
Definition: CallingConv.h:117
@ X86_VectorCall
MSVC calling convention that passes vectors and vector aggregates in SSE registers.
Definition: CallingConv.h:163
@ Intel_OCL_BI
Used for Intel OpenCL built-ins.
Definition: CallingConv.h:147
@ PreserveNone
Used for runtime calls that preserves none general registers.
Definition: CallingConv.h:90
@ AMDGPU_ES
Used for AMDPAL shader stage before geometry shader if geometry is in use.
Definition: CallingConv.h:218
@ Tail
Attemps to make calls as fast as possible while guaranteeing that tail call optimization can always b...
Definition: CallingConv.h:76
@ Win64
The C convention as implemented on Windows/x86-64 and AArch64.
Definition: CallingConv.h:159
@ PTX_Kernel
Call to a PTX kernel. Passes all arguments in parameter space.
Definition: CallingConv.h:125
@ SwiftTail
This follows the Swift calling convention in how arguments are passed but guarantees tail calls will ...
Definition: CallingConv.h:87
@ GRAAL
Used by GraalVM. Two additional registers are reserved.
Definition: CallingConv.h:255
@ AMDGPU_LS
Used for AMDPAL vertex shader if tessellation is in use.
Definition: CallingConv.h:213
@ ARM_AAPCS_VFP
Same as ARM_AAPCS, but uses hard floating point ABI.
Definition: CallingConv.h:114
@ ARM64EC_Thunk_X64
Calling convention used in the ARM64EC ABI to implement calls between x64 code and thunks.
Definition: CallingConv.h:260
@ X86_RegCall
Register calling convention used for parameters transfer optimization.
Definition: CallingConv.h:203
@ M68k_RTD
Used for M68k rtd-based CC (similar to X86's stdcall).
Definition: CallingConv.h:252
@ C
The default llvm calling convention, compatible with C.
Definition: CallingConv.h:34
@ X86_FastCall
'fast' analog of X86_StdCall.
Definition: CallingConv.h:103
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18