Coverage for cuda/bindings/nvvm.pyx: 90.91%

1# SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved. (empty)

2# 

3# SPDX-License-Identifier: Apache-2.0 

4# 

5# This code was automatically generated across versions from 12.0.1 to 13.3.0. Do not modify it directly. 

6# CYTHON-BINDINGS-GENERATED-DO-NOT-MODIFY-THIS-FILE: format=1; content-sha256=82dc56ccc695031faa515d1971c9841131d5aadc60c6d6e6cc223580fc544d16 

7  

8  

9# <<<< PREAMBLE CONTENT >>>> 

10  

11from cuda.bindings._internal._fast_enum import FastEnum as _cyb_FastEnum (empty)

12  

13  

14# <<<< END OF PREAMBLE CONTENT >>>> 

15  

16cimport cython # NOQA 

17  

18from ._internal.utils cimport (get_buffer_pointer, get_nested_resource_ptr, 

19 nested_resource) 

20  

21  

22############################################################################### 

23# Enum 

24############################################################################### 

25  

26class Result(_cyb_FastEnum): (empty)

27 """ 

28 NVVM API call result code. 

29  

30 See `nvvmResult`. 

31 """ 

32 SUCCESS = NVVM_SUCCESS (empty)

33 ERROR_OUT_OF_MEMORY = NVVM_ERROR_OUT_OF_MEMORY (empty)

34 ERROR_PROGRAM_CREATION_FAILURE = NVVM_ERROR_PROGRAM_CREATION_FAILURE (empty)

35 ERROR_IR_VERSION_MISMATCH = NVVM_ERROR_IR_VERSION_MISMATCH (empty)

36 ERROR_INVALID_INPUT = NVVM_ERROR_INVALID_INPUT (empty)

37 ERROR_INVALID_PROGRAM = NVVM_ERROR_INVALID_PROGRAM (empty)

38 ERROR_INVALID_IR = NVVM_ERROR_INVALID_IR (empty)

39 ERROR_INVALID_OPTION = NVVM_ERROR_INVALID_OPTION (empty)

40 ERROR_NO_MODULE_IN_PROGRAM = NVVM_ERROR_NO_MODULE_IN_PROGRAM (empty)

41 ERROR_COMPILATION = NVVM_ERROR_COMPILATION (empty)

42 ERROR_CANCELLED = NVVM_ERROR_CANCELLED (empty)

43  

44  

45############################################################################### 

46# Error handling 

47############################################################################### 

48  

49class nvvmError(Exception): (empty)

50  

51 def __init__(self, status): (empty)

52 self.status = status 12 ctx1ajklmnoAB(pq

53 s = Result(status) 12 ctx1ajklmnoAB(pq

54 cdef str err = f"{s.name} ({s.value})" 12 ctx1ajklmnoAB(pq

55 super(nvvmError, self).__init__(err) 12 ctx1ajklmnoAB(pq

56  

57 def __reduce__(self): (empty)

58 return (type(self), (self.status,)) 

59  

60  

61@cython.profile(False) (empty)

62cdef int check_status(int status) except 1 nogil: 

63 if status != 0: 67 ctx1aEFjQkRlSmTnoABbUcVdWeXfYgZh0i1GCD2P3u4v5w6x7y8z9!#$%'HIJKLMNOprqst

64 with gil: 11 ctx1ajklmnoABpq

65 raise nvvmError(status) 11 ctx1ajklmnoABpq

66 return status 67 ctx1aEFjQkRlSmTnoABbUcVdWeXfYgZh0i1GCD2P3u4v5w6x7y8z9!#$%'HIJKLMNOprqst

67  

68  

69############################################################################### 

70# Wrapper functions 

71############################################################################### 

72  

73cpdef destroy_program(intptr_t prog): (empty)

74 """Destroy a program. 

75  

76 Args: 

77 prog (intptr_t): nvvm prog. 

78  

79 .. seealso:: `nvvmDestroyProgram` 

80 """ 

81 cdef Program p = <Program>prog 33 ctx1aEFjklmnoABbcdefghiGCDuvwxyzprqst

82 with nogil: 33 ctx1aEFjklmnoABbcdefghiGCDuvwxyzprqst

83 status = nvvmDestroyProgram(&p) 33 ctx1aEFjklmnoABbcdefghiGCDuvwxyzprqst

84 check_status(status) 33 ctx1aEFjklmnoABbcdefghiGCDuvwxyzprqst

85  

86  

87cpdef str get_error_string(int result): (empty)

88 """Get the message string for the given ``nvvmResult`` code. 

89  

90 Args: 

91 result (Result): NVVM API result code. 

92  

93 .. seealso:: `nvvmGetErrorString` 

94 """ 

95 cdef const char *_output_cstr_ 

96 cdef bytes _output_ 

97 with nogil: 1 ctx1)

98 _output_cstr_ = nvvmGetErrorString(<_Result>result) 1 ctx1)

99 _output_ = _output_cstr_ 1 ctx1)

100 return _output_.decode() 1 ctx1)

101  

102  

103cpdef tuple version(): (empty)

104 """Get the NVVM version. 

105  

106 Returns: 

107 A 2-tuple containing: 

108  

109 - int: NVVM major version number. 

110 - int: NVVM minor version number. 

111  

112 .. seealso:: `nvvmVersion` 

113 """ 

114 cdef int major 

115 cdef int minor 

116 with nogil: 10 ctx1a3HIJKLMNO

117 __status__ = nvvmVersion(&major, &minor) 10 ctx1a3HIJKLMNO

118 check_status(__status__) 10 ctx1a3HIJKLMNO

119 return (major, minor) 10 ctx1a3HIJKLMNO

120  

121  

122cpdef tuple ir_version(): (empty)

123 """Get the NVVM IR version. 

124  

125 Returns: 

126 A 4-tuple containing: 

127  

128 - int: NVVM IR major version number. 

129 - int: NVVM IR minor version number. 

130 - int: NVVM IR debug metadata major version number. 

131 - int: NVVM IR debug metadata minor version number. 

132  

133 .. seealso:: `nvvmIRVersion` 

134 """ 

135 cdef int major_ir 

136 cdef int minor_ir 

137 cdef int major_dbg 

138 cdef int minor_dbg 

139 with nogil: 38 ctx1aQRSTUVWXYZ012456789!#$%'HIJKLMNOprqst

140 __status__ = nvvmIRVersion(&major_ir, &minor_ir, &major_dbg, &minor_dbg) 38 ctx1aQRSTUVWXYZ012456789!#$%'HIJKLMNOprqst

141 check_status(__status__) 38 ctx1aQRSTUVWXYZ012456789!#$%'HIJKLMNOprqst

142 return (major_ir, minor_ir, major_dbg, minor_dbg) 38 ctx1aQRSTUVWXYZ012456789!#$%'HIJKLMNOprqst

143  

144  

145cpdef intptr_t create_program() except? 0: (empty)

146 """Create a program, and set the value of its handle to ``*prog``. 

147  

148 Returns: 

149 intptr_t: NVVM program. 

150  

151 .. seealso:: `nvvmCreateProgram` 

152 """ 

153 cdef Program prog 

154 with nogil: 33 ctx1aEFjklmnoABbcdefghiGCDuvwxyzprqst

155 __status__ = nvvmCreateProgram(&prog) 33 ctx1aEFjklmnoABbcdefghiGCDuvwxyzprqst

156 check_status(__status__) 33 ctx1aEFjklmnoABbcdefghiGCDuvwxyzprqst

157 return <intptr_t>prog 33 ctx1aEFjklmnoABbcdefghiGCDuvwxyzprqst

158  

159  

160cpdef add_module_to_program(intptr_t prog, buffer, size_t size, name): (empty)

161 """Add a module level NVVM IR to a program. 

162  

163 Args: 

164 prog (intptr_t): NVVM program. 

165 buffer (bytes): NVVM IR module in the bitcode or text representation. 

166 size (size_t): Size of the NVVM IR module. 

167 name (str): Name of the NVVM IR module. If NULL, "<unnamed>" is used as the name. 

168  

169 .. seealso:: `nvvmAddModuleToProgram` 

170 """ 

171 cdef void* _buffer_ = get_buffer_pointer(buffer, size, readonly=True) 27 ctx1aEjklmnobcdefghiuvwxyzprqst

172 if not isinstance(name, str): 26 ctx1ajklmnobcdefghiuvwxyzprqst

173 raise TypeError("name must be a Python str") 

174 cdef bytes _temp_name_ = (<str>name).encode() 26 ctx1ajklmnobcdefghiuvwxyzprqst

175 cdef char* _name_ = _temp_name_ 26 ctx1ajklmnobcdefghiuvwxyzprqst

176 with nogil: 26 ctx1ajklmnobcdefghiuvwxyzprqst

177 __status__ = nvvmAddModuleToProgram(<Program>prog, <const char*>_buffer_, size, <const char*>_name_) 26 ctx1ajklmnobcdefghiuvwxyzprqst

178 check_status(__status__) 26 ctx1ajklmnobcdefghiuvwxyzprqst

179  

180  

181cpdef lazy_add_module_to_program(intptr_t prog, buffer, size_t size, name): (empty)

182 """Add a module level NVVM IR to a program. 

183  

184 Args: 

185 prog (intptr_t): NVVM program. 

186 buffer (bytes): NVVM IR module in the bitcode representation. 

187 size (size_t): Size of the NVVM IR module. 

188 name (str): Name of the NVVM IR module. If NULL, "<unnamed>" is used as the name. 

189  

190 .. seealso:: `nvvmLazyAddModuleToProgram` 

191 """ 

192 cdef void* _buffer_ = get_buffer_pointer(buffer, size, readonly=True) 1 ctx1F

193 if not isinstance(name, str): 

194 raise TypeError("name must be a Python str") 

195 cdef bytes _temp_name_ = (<str>name).encode() 

196 cdef char* _name_ = _temp_name_ 

197 with nogil: 

198 __status__ = nvvmLazyAddModuleToProgram(<Program>prog, <const char*>_buffer_, size, <const char*>_name_) 

199 check_status(__status__) 

200  

201  

202cpdef compile_program(intptr_t prog, int num_options, options): (empty)

203 """Compile the NVVM program. 

204  

205 Args: 

206 prog (intptr_t): NVVM program. 

207 num_options (int): Number of compiler ``options`` passed. 

208 options (object): Compiler options in the form of C string array. It can be: 

209  

210 - an :class:`int` as the pointer address to the nested sequence, or 

211 - a Python sequence of :class:`int`\s, each of which is a pointer address 

212 to a valid sequence of 'char', or 

213 - a nested Python sequence of ``str``. 

214  

215  

216 .. seealso:: `nvvmCompileProgram` 

217 """ 

218 cdef nested_resource[ char ] _options_ 

219 get_nested_resource_ptr[char](_options_, options, <char*>NULL) 18 ctx1ajlnAbcdefghiprqst

220 with nogil: 18 ctx1ajlnAbcdefghiprqst

221 __status__ = nvvmCompileProgram(<Program>prog, num_options, <const char**>(_options_.ptrs.data())) 18 ctx1ajlnAbcdefghiprqst

222 check_status(__status__) 18 ctx1ajlnAbcdefghiprqst

223  

224  

225cpdef verify_program(intptr_t prog, int num_options, options): (empty)

226 """Verify the NVVM program. 

227  

228 Args: 

229 prog (intptr_t): NVVM program. 

230 num_options (int): Number of compiler ``options`` passed. 

231 options (object): Compiler options in the form of C string array. It can be: 

232  

233 - an :class:`int` as the pointer address to the nested sequence, or 

234 - a Python sequence of :class:`int`\s, each of which is a pointer address 

235 to a valid sequence of 'char', or 

236 - a nested Python sequence of ``str``. 

237  

238  

239 .. seealso:: `nvvmVerifyProgram` 

240 """ 

241 cdef nested_resource[ char ] _options_ 

242 get_nested_resource_ptr[char](_options_, options, <char*>NULL) 10 ctx1kmoBuvwxyz

243 with nogil: 10 ctx1kmoBuvwxyz

244 __status__ = nvvmVerifyProgram(<Program>prog, num_options, <const char**>(_options_.ptrs.data())) 10 ctx1kmoBuvwxyz

245 check_status(__status__) 10 ctx1kmoBuvwxyz

246  

247  

248cpdef size_t get_compiled_result_size(intptr_t prog) except? 0: (empty)

249 """Get the size of the compiled result. 

250  

251 Args: 

252 prog (intptr_t): NVVM program. 

253  

254 Returns: 

255 size_t: Size of the compiled result (including the trailing NULL). 

256  

257 .. seealso:: `nvvmGetCompiledResultSize` 

258 """ 

259 cdef size_t buffer_size_ret 

260 with nogil: 9 ctx1bcdefghiC

261 __status__ = nvvmGetCompiledResultSize(<Program>prog, &buffer_size_ret) 9 ctx1bcdefghiC

262 check_status(__status__) 9 ctx1bcdefghiC

263 return buffer_size_ret 9 ctx1bcdefghiC

264  

265  

266cpdef get_compiled_result(intptr_t prog, buffer): (empty)

267 """Get the compiled result. 

268  

269 Args: 

270 prog (intptr_t): NVVM program. 

271 buffer (bytes): Compiled result. 

272  

273 .. seealso:: `nvvmGetCompiledResult` 

274 """ 

275 cdef void* _buffer_ = get_buffer_pointer(buffer, -1, readonly=False) 9 ctx1bcdefghiC

276 with nogil: 9 ctx1bcdefghiC

277 __status__ = nvvmGetCompiledResult(<Program>prog, <char*>_buffer_) 9 ctx1bcdefghiC

278 check_status(__status__) 9 ctx1bcdefghiC

279  

280  

281cpdef size_t get_program_log_size(intptr_t prog) except? 0: (empty)

282 """Get the Size of Compiler/Verifier Message. 

283  

284 Args: 

285 prog (intptr_t): NVVM program. 

286  

287 Returns: 

288 size_t: Size of the compilation/verification log (including the trailing NULL). 

289  

290 .. seealso:: `nvvmGetProgramLogSize` 

291 """ 

292 cdef size_t buffer_size_ret 

293 with nogil: 15 ctx1jklmnobcdefghiD

294 __status__ = nvvmGetProgramLogSize(<Program>prog, &buffer_size_ret) 15 ctx1jklmnobcdefghiD

295 check_status(__status__) 15 ctx1jklmnobcdefghiD

296 return buffer_size_ret 15 ctx1jklmnobcdefghiD

297  

298  

299cpdef get_program_log(intptr_t prog, buffer): (empty)

300 """Get the Compiler/Verifier Message. 

301  

302 Args: 

303 prog (intptr_t): NVVM program. 

304 buffer (bytes): Compilation/Verification log. 

305  

306 .. seealso:: `nvvmGetProgramLog` 

307 """ 

308 cdef void* _buffer_ = get_buffer_pointer(buffer, -1, readonly=False) 15 ctx1jklmnobcdefghiD

309 with nogil: 15 ctx1jklmnobcdefghiD

310 __status__ = nvvmGetProgramLog(<Program>prog, <char*>_buffer_) 15 ctx1jklmnobcdefghiD

311 check_status(__status__) 15 ctx1jklmnobcdefghiD

312  

313  

314cpdef int llvm_version(arch) except? 0: (empty)

315 """Get the LLVM IR version guaranteed to be supported by NVVM. 

316  

317 Args: 

318 arch (str): Architecture string. 

319  

320 Returns: 

321 int: IR version number. 

322  

323 .. seealso:: `nvvmLLVMVersion` 

324 """ 

325 if not isinstance(arch, str): 1 ctx1P

326 raise TypeError("arch must be a Python str") 

327 cdef bytes _temp_arch_ = (<str>arch).encode() 1 ctx1P

328 cdef char* _arch_ = _temp_arch_ 1 ctx1P

329 cdef int major 

330 with nogil: 1 ctx1P

331 __status__ = nvvmLLVMVersion(<const char*>_arch_, &major) 1 ctx1P

332 check_status(__status__) 1 ctx1P

333 return major 1 ctx1P

334del _cyb_FastEnum (empty)