1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
/* automatically generated by rust-bindgen 0.72.1 */
pub type size_t = ::core::ffi::c_ulong;
/// NVVM API call result code.
#[repr(u32)]
#[derive(
Debug,
Copy,
Clone,
Hash,
PartialOrd,
Ord,
PartialEq,
Eq,
TryFromPrimitive,
IntoPrimitive,
)]
pub enum nvvmResult {
NVVM_SUCCESS = 0,
NVVM_ERROR_OUT_OF_MEMORY = 1,
NVVM_ERROR_PROGRAM_CREATION_FAILURE = 2,
NVVM_ERROR_IR_VERSION_MISMATCH = 3,
NVVM_ERROR_INVALID_INPUT = 4,
NVVM_ERROR_INVALID_PROGRAM = 5,
NVVM_ERROR_INVALID_IR = 6,
NVVM_ERROR_INVALID_OPTION = 7,
NVVM_ERROR_NO_MODULE_IN_PROGRAM = 8,
NVVM_ERROR_COMPILATION = 9,
NVVM_ERROR_CANCELLED = 10,
}
unsafe extern "C" {
/// Get the message string for the given [`nvvmResult`] code.
///
/// # Parameters
///
/// - `result`: NVVM API result code.
pub fn nvvmGetErrorString(result: nvvmResult) -> *const ::core::ffi::c_char;
}
unsafe extern "C" {
/// Get the NVVM version.
///
/// # Parameters
///
/// - `major`: NVVM major version number.
/// - `minor`: NVVM minor version number.
pub fn nvvmVersion(
major: *mut ::core::ffi::c_int,
minor: *mut ::core::ffi::c_int,
) -> nvvmResult;
}
unsafe extern "C" {
/// Get the NVVM IR version.
///
/// # Parameters
///
/// - `majorIR`: NVVM IR major version number.
/// - `minorIR`: NVVM IR minor version number.
/// - `majorDbg`: NVVM IR debug metadata major version number.
/// - `minorDbg`: NVVM IR debug metadata minor version number.
pub fn nvvmIRVersion(
majorIR: *mut ::core::ffi::c_int,
minorIR: *mut ::core::ffi::c_int,
majorDbg: *mut ::core::ffi::c_int,
minorDbg: *mut ::core::ffi::c_int,
) -> nvvmResult;
}
unsafe extern "C" {
/// Get the LLVM IR version guaranteed to be supported by NVVM.
///
/// The valid arch strings are the ones supported by [`nvvmCompileProgram`].
///
/// # Parameters
///
/// - `arch`: Architecture string.
/// - `major`: IR version number.
pub fn nvvmLLVMVersion(
arch: *const ::core::ffi::c_char,
major: *mut ::core::ffi::c_int,
) -> nvvmResult;
}
#[repr(C)]
#[derive(Debug, Copy, Clone)]
pub struct _nvvmProgram {
_unused: [u8; 0],
}
/// NVVM Program.
///
/// An opaque handle for a program.
pub type nvvmProgram = *mut _nvvmProgram;
unsafe extern "C" {
/// Create a program, and set the value of its handle to `*prog`.
///
/// # Parameters
///
/// - `prog`: NVVM program.
pub fn nvvmCreateProgram(prog: *mut nvvmProgram) -> nvvmResult;
}
unsafe extern "C" {
/// Destroy a program.
///
/// # Parameters
///
/// - `prog`: NVVM program.
pub fn nvvmDestroyProgram(prog: *mut nvvmProgram) -> nvvmResult;
}
unsafe extern "C" {
/// Add a module level NVVM IR to a program.
///
/// The `buffer` should contain an NVVM IR module. The module should have NVVM IR either in the LLVM 7.0.1 bitcode representation or in the LLVM 7.0.1 text representation. Support for reading the text representation of NVVM IR is deprecated and may be removed in a later version.
///
/// # Parameters
///
/// - `prog`: NVVM program.
/// - `buffer`: NVVM IR module in the bitcode or text representation.
/// - `size`: Size of the NVVM IR module.
/// - `name`: Name of the NVVM IR module. If NULL, “<unnamed>” is used as the name.
pub fn nvvmAddModuleToProgram(
prog: nvvmProgram,
buffer: *const ::core::ffi::c_char,
size: size_t,
name: *const ::core::ffi::c_char,
) -> nvvmResult;
}
unsafe extern "C" {
/// Add a module level NVVM IR to a program.
///
/// The `buffer` should contain an NVVM IR module. The module should have NVVM IR in the LLVM 7.0.1 bitcode representation.
///
/// A module added using this API is lazily loaded - the only symbols loaded are those that are required by module(s) loaded using nvvmAddModuleToProgram. It is an error for a program to have all modules loaded using this API. Compiler may also optimize entities in this module by making them internal to the linked NVVM IR module, making them eligible for other optimizations. Due to these optimizations, this API to load a module is more efficient and should be used where possible.
///
/// # Parameters
///
/// - `prog`: NVVM program.
/// - `buffer`: NVVM IR module in the bitcode representation.
/// - `size`: Size of the NVVM IR module.
/// - `name`: Name of the NVVM IR module. If NULL, “<unnamed>” is used as the name.
pub fn nvvmLazyAddModuleToProgram(
prog: nvvmProgram,
buffer: *const ::core::ffi::c_char,
size: size_t,
name: *const ::core::ffi::c_char,
) -> nvvmResult;
}
unsafe extern "C" {
/// Compile the NVVM program.
///
/// The NVVM IR modules in the program will be linked at the IR level. The linked IR program is compiled to PTX.
///
/// The target datalayout in the linked IR program is used to determine the address size (32bit vs 64bit).
///
/// The valid compiler options are:
///
/// * -g (enable generation of full debugging information). Full debug support is only valid with ‘-opt=0’. Debug support requires the input module to utilize NVVM IR Debug Metadata. Line number (line info) only generation is also enabled via NVVM IR Debug Metadata, there is no specific libNVVM API flag for that case.
/// * -opt=
///
/// + 0 (disable optimizations)
/// + 3 (default, enable optimizations)
/// * -arch=
///
/// + compute_75 (default)
/// + compute_80
/// + compute_87
/// + compute_89
/// + compute_90
/// + compute_90a
/// + compute_100
/// + compute_100a
/// + compute_100f
/// + compute_103
/// + compute_103a
/// + compute_103f
/// + compute_110
/// + compute_110a
/// + compute_110f
/// + compute_120
/// + compute_120a
/// + compute_120f
/// + compute_121
/// + compute_121a
/// + compute_121f
/// * -ftz=
///
/// + 0 (default, preserve denormal values, when performing single-precision floating-point operations)
/// + 1 (flush denormal values to zero, when performing single-precision floating-point operations)
/// * -prec-sqrt=
///
/// + 0 (use a faster approximation for single-precision floating-point square root)
/// + 1 (default, use IEEE round-to-nearest mode for single-precision floating-point square root)
/// * -prec-div=
///
/// + 0 (use a faster approximation for single-precision floating-point division and reciprocals)
/// + 1 (default, use IEEE round-to-nearest mode for single-precision floating-point division and reciprocals)
/// * -fma=
///
/// + 0 (disable FMA contraction)
/// + 1 (default, enable FMA contraction)
/// * -jump-table-density=\[0-101\] Specify the case density percentage in switch statements, and use it as a minimal threshold to determine whether jump table(brx.idx instruction) will be used to implement a switch statement. Default value is 101. The percentage ranges from 0 to 101 inclusively.
/// * -gen-lto (Generate LTO IR instead of PTX).
///
/// # Parameters
///
/// - `prog`: NVVM program.
/// - `numOptions`: Number of compiler options passed.
/// - `options`: Compiler options in the form of C string array.
pub fn nvvmCompileProgram(
prog: nvvmProgram,
numOptions: ::core::ffi::c_int,
options: *mut *const ::core::ffi::c_char,
) -> nvvmResult;
}
unsafe extern "C" {
/// Verify the NVVM program.
///
/// The valid compiler options are:
///
/// Same as for [`nvvmCompileProgram`].
///
/// # Parameters
///
/// - `prog`: NVVM program.
/// - `numOptions`: Number of compiler options passed.
/// - `options`: Compiler options in the form of C string array.
pub fn nvvmVerifyProgram(
prog: nvvmProgram,
numOptions: ::core::ffi::c_int,
options: *mut *const ::core::ffi::c_char,
) -> nvvmResult;
}
unsafe extern "C" {
/// Get the size of the compiled result.
///
/// # Parameters
///
/// - `prog`: NVVM program.
/// - `bufferSizeRet`: Size of the compiled result (including the trailing NULL).
pub fn nvvmGetCompiledResultSize(
prog: nvvmProgram,
bufferSizeRet: *mut size_t,
) -> nvvmResult;
}
unsafe extern "C" {
/// Get the compiled result.
///
/// The result is stored in the memory pointed to by `buffer`.
///
/// # Parameters
///
/// - `prog`: NVVM program.
/// - `buffer`: Compiled result.
pub fn nvvmGetCompiledResult(
prog: nvvmProgram,
buffer: *mut ::core::ffi::c_char,
) -> nvvmResult;
}
unsafe extern "C" {
/// Get the Size of Compiler/Verifier Message.
///
/// The size of the message string (including the trailing NULL) is stored into `bufferSizeRet` when the return value is [`nvvmResult::NVVM_SUCCESS`].
///
/// # Parameters
///
/// - `prog`: NVVM program.
/// - `bufferSizeRet`: Size of the compilation/verification log (including the trailing NULL).
pub fn nvvmGetProgramLogSize(
prog: nvvmProgram,
bufferSizeRet: *mut size_t,
) -> nvvmResult;
}
unsafe extern "C" {
/// Get the Compiler/Verifier Message.
///
/// The NULL terminated message string is stored in the memory pointed to by `buffer` when the return value is [`nvvmResult::NVVM_SUCCESS`].
///
/// # Parameters
///
/// - `prog`: NVVM program.
/// - `buffer`: Compilation/Verification log.
pub fn nvvmGetProgramLog(
prog: nvvmProgram,
buffer: *mut ::core::ffi::c_char,
) -> nvvmResult;
}