Coverage for cuda/bindings/nvjitlink.pyx: 97.74%

1# SPDX-FileCopyrightText: Copyright (c) 2024-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=73b6eb59cbe4fda520d37939d18d4625eb3818e37689796be45025a8aa877473 

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_resource_ptr, get_nested_resource_ptr, nested_resource, nullable_unique_ptr, 

19 get_buffer_pointer, get_resource_ptrs) 

20  

21from libcpp.vector cimport vector 

22  

23  

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

25# Enum 

26############################################################################### 

27  

28class Result(_cyb_FastEnum): (empty)

29 """ 

30 The enumerated type `nvJitLinkResult` defines API call result codes. 

31 nvJitLink APIs return `nvJitLinkResult` codes to indicate the result. 

32  

33 See `nvJitLinkResult`. 

34 """ 

35 SUCCESS = NVJITLINK_SUCCESS (empty)

36 ERROR_UNRECOGNIZED_OPTION = (NVJITLINK_ERROR_UNRECOGNIZED_OPTION, 'Unrecognized Option') (empty)

37 ERROR_MISSING_ARCH = (NVJITLINK_ERROR_MISSING_ARCH, 'Option `-arch=sm_NN` not specified') (empty)

38 ERROR_INVALID_INPUT = (NVJITLINK_ERROR_INVALID_INPUT, 'Invalid Input') (empty)

39 ERROR_PTX_COMPILE = (NVJITLINK_ERROR_PTX_COMPILE, 'Issue during PTX Compilation') (empty)

40 ERROR_NVVM_COMPILE = (NVJITLINK_ERROR_NVVM_COMPILE, 'Issue during NVVM Compilation') (empty)

41 ERROR_INTERNAL = (NVJITLINK_ERROR_INTERNAL, 'Internal Error') (empty)

42 ERROR_THREADPOOL = (NVJITLINK_ERROR_THREADPOOL, 'Issue with Thread Pool') (empty)

43 ERROR_UNRECOGNIZED_INPUT = (NVJITLINK_ERROR_UNRECOGNIZED_INPUT, 'Unrecognized Input') (empty)

44 ERROR_FINALIZE = (NVJITLINK_ERROR_FINALIZE, 'Finalizer Error') (empty)

45 ERROR_NULL_INPUT = (NVJITLINK_ERROR_NULL_INPUT, 'Null Input') (empty)

46 ERROR_INCOMPATIBLE_OPTIONS = (NVJITLINK_ERROR_INCOMPATIBLE_OPTIONS, 'Incompatible Options') (empty)

47 ERROR_INCORRECT_INPUT_TYPE = (NVJITLINK_ERROR_INCORRECT_INPUT_TYPE, 'Incorrect Input Type') (empty)

48 ERROR_ARCH_MISMATCH = (NVJITLINK_ERROR_ARCH_MISMATCH, 'Arch Mismatch') (empty)

49 ERROR_OUTDATED_LIBRARY = (NVJITLINK_ERROR_OUTDATED_LIBRARY, 'Outdated Library') (empty)

50 ERROR_MISSING_FATBIN = (NVJITLINK_ERROR_MISSING_FATBIN, 'Missing Fatbin') (empty)

51 ERROR_UNRECOGNIZED_ARCH = (NVJITLINK_ERROR_UNRECOGNIZED_ARCH, 'Unrecognized -arch value') (empty)

52 ERROR_UNSUPPORTED_ARCH = (NVJITLINK_ERROR_UNSUPPORTED_ARCH, 'Unsupported -arch value') (empty)

53 ERROR_LTO_NOT_ENABLED = (NVJITLINK_ERROR_LTO_NOT_ENABLED, 'Requires -lto') (empty)

54  

55class InputType(_cyb_FastEnum): (empty)

56 """ 

57 The enumerated type `nvJitLinkInputType` defines the kind of inputs 

58 that can be passed to nvJitLinkAdd* APIs. 

59  

60 See `nvJitLinkInputType`. 

61 """ 

62 NONE = (NVJITLINK_INPUT_NONE, 'Error Type') (empty)

63 CUBIN = (NVJITLINK_INPUT_CUBIN, 'For CUDA Binaries') (empty)

64 PTX = (NVJITLINK_INPUT_PTX, 'For PTX') (empty)

65 LTOIR = (NVJITLINK_INPUT_LTOIR, 'For LTO-IR') (empty)

66 FATBIN = (NVJITLINK_INPUT_FATBIN, 'For Fatbin') (empty)

67 OBJECT = (NVJITLINK_INPUT_OBJECT, 'For Host Object') (empty)

68 LIBRARY = (NVJITLINK_INPUT_LIBRARY, 'For Host Library') (empty)

69 INDEX = (NVJITLINK_INPUT_INDEX, 'For Index File') (empty)

70 ANY = (NVJITLINK_INPUT_ANY, 'Dynamically chooses from the valid types') (empty)

71  

72  

73############################################################################### 

74# Error handling 

75############################################################################### 

76  

77class nvJitLinkError(Exception): (empty)

78  

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

80 self.status = status 6 ctx2% ' qbrb( )

81 s = Result(status) 6 ctx2% ' qbrb( )

82 cdef str err = f"{s.name} ({s.value})" 6 ctx2% ' qbrb( )

83 super(nvJitLinkError, self).__init__(err) 6 ctx2% ' qbrb( )

84  

85 def __reduce__(self): (empty)

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

87  

88  

89@cython.profile(False) (empty)

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

91 if status != 0: 105 ctx2a P Q R S X Y Z 0 5 6 7 8 * + , - . H I J K b c d e f g h i j k l m n o p q % @ ' T U V W 1 2 3 4 9 ! # $ / : ; = ? L M N O r s t u v w x y z A B C D E F G ( [ ) ] ^ _ ` { | } ~ abbbcbdbebfbgbhbibjbkblbmbnbobpb

92 with gil: 4 ctx1%'()

93 raise nvJitLinkError(status) 4 ctx1%'()

94 return status 101 ctx2a P Q R S X Y Z 0 5 6 7 8 * + , - . H I J K b c d e f g h i j k l m n o p q @ T U V W 1 2 3 4 9 ! # $ / : ; = ? L M N O r s t u v w x y z A B C D E F G [ ] ^ _ ` { | } ~ abbbcbdbebfbgbhbibjbkblbmbnbobpb

95  

96  

97############################################################################### 

98# Wrapper functions 

99############################################################################### 

100  

101cpdef destroy(intptr_t handle): (empty)

102 """nvJitLinkDestroy frees the memory associated with the given handle. 

103  

104 Args: 

105 handle (intptr_t): nvJitLink handle. 

106  

107 .. seealso:: `nvJitLinkDestroy` 

108 """ 

109 cdef Handle h = <Handle>handle 74 ctx1PQRSXYZ05678*+,-.HIJKbcdefghijklmnopqTUVW12349!#$/:;=?LMNOrstuvwxyzABCDEFG

110 with nogil: 74 ctx1PQRSXYZ05678*+,-.HIJKbcdefghijklmnopqTUVW12349!#$/:;=?LMNOrstuvwxyzABCDEFG

111 status = nvJitLinkDestroy(&h) 74 ctx1PQRSXYZ05678*+,-.HIJKbcdefghijklmnopqTUVW12349!#$/:;=?LMNOrstuvwxyzABCDEFG

112 check_status(status) 74 ctx1PQRSXYZ05678*+,-.HIJKbcdefghijklmnopqTUVW12349!#$/:;=?LMNOrstuvwxyzABCDEFG

113  

114  

115cpdef intptr_t create(uint32_t num_options, options) except -1: (empty)

116 """nvJitLinkCreate creates an instance of ``nvJitLinkHandle`` with the given input options, and sets the output parameter ``handle``. 

117  

118 Args: 

119 num_options (uint32_t): Number of options passed. 

120 options (object): Array of size ``num_options`` of option 

121 strings. It can be: 

122  

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

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

125 to a valid sequence of 'char', or 

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

127  

128  

129 Returns: 

130 intptr_t: Address of nvJitLink handle. 

131  

132 .. seealso:: `nvJitLinkCreate` 

133 """ 

134 cdef nested_resource[ char ] _options_ 

135 get_nested_resource_ptr[char](_options_, options, <char*>NULL) 78 ctx1PQRSXYZ05678*+,-.HIJKbcdefghijklmnopq%'TUVW12349!#$/:;=?LMNOrstuvwxyzABCDEFG()

136 cdef Handle handle 

137 with nogil: 78 ctx1PQRSXYZ05678*+,-.HIJKbcdefghijklmnopq%'TUVW12349!#$/:;=?LMNOrstuvwxyzABCDEFG()

138 __status__ = nvJitLinkCreate(&handle, num_options, <const char**>(_options_.ptrs.data())) 78 ctx1PQRSXYZ05678*+,-.HIJKbcdefghijklmnopq%'TUVW12349!#$/:;=?LMNOrstuvwxyzABCDEFG()

139 check_status(__status__) 78 ctx1PQRSXYZ05678*+,-.HIJKbcdefghijklmnopq%'TUVW12349!#$/:;=?LMNOrstuvwxyzABCDEFG()

140 return <intptr_t>handle 74 ctx1PQRSXYZ05678*+,-.HIJKbcdefghijklmnopqTUVW12349!#$/:;=?LMNOrstuvwxyzABCDEFG

141  

142  

143cpdef add_data(intptr_t handle, int input_type, data, size_t size, name): (empty)

144 """nvJitLinkAddData adds data image to the link. 

145  

146 Args: 

147 handle (intptr_t): nvJitLink handle. 

148 input_type (InputType): kind of input. 

149 data (bytes): pointer to data image in memory. 

150 size (size_t): size of the data. 

151 name (str): name of input object. 

152  

153 .. seealso:: `nvJitLinkAddData` 

154 """ 

155 cdef void* _data_ = get_buffer_pointer(data, size, readonly=True) 40 ctx1PQRSbcdefghijklmnopqTUVWrstuvwxyzABCDEFG

156 if not isinstance(name, str): 40 ctx1PQRSbcdefghijklmnopqTUVWrstuvwxyzABCDEFG

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

158 cdef bytes _temp_name_ = (<str>name).encode() 40 ctx1PQRSbcdefghijklmnopqTUVWrstuvwxyzABCDEFG

159 cdef char* _name_ = _temp_name_ 40 ctx1PQRSbcdefghijklmnopqTUVWrstuvwxyzABCDEFG

160 with nogil: 40 ctx1PQRSbcdefghijklmnopqTUVWrstuvwxyzABCDEFG

161 __status__ = nvJitLinkAddData(<Handle>handle, <_InputType>input_type, <const void*>_data_, size, <const char*>_name_) 40 ctx1PQRSbcdefghijklmnopqTUVWrstuvwxyzABCDEFG

162 check_status(__status__) 40 ctx1PQRSbcdefghijklmnopqTUVWrstuvwxyzABCDEFG

163  

164  

165cpdef add_file(intptr_t handle, int input_type, file_name): (empty)

166 """nvJitLinkAddFile reads data from file and links it in. 

167  

168 Args: 

169 handle (intptr_t): nvJitLink handle. 

170 input_type (InputType): kind of input. 

171 file_name (str): name of file. 

172  

173 .. seealso:: `nvJitLinkAddFile` 

174 """ 

175 if not isinstance(file_name, str): 8 ctx1XYZ01234

176 raise TypeError("file_name must be a Python str") 

177 cdef bytes _temp_file_name_ = (<str>file_name).encode() 8 ctx1XYZ01234

178 cdef char* _file_name_ = _temp_file_name_ 8 ctx1XYZ01234

179 with nogil: 8 ctx1XYZ01234

180 __status__ = nvJitLinkAddFile(<Handle>handle, <_InputType>input_type, <const char*>_file_name_) 8 ctx1XYZ01234

181 check_status(__status__) 8 ctx1XYZ01234

182  

183  

184cpdef complete(intptr_t handle): (empty)

185 """nvJitLinkComplete does the actual link. 

186  

187 Args: 

188 handle (intptr_t): nvJitLink handle. 

189  

190 .. seealso:: `nvJitLinkComplete` 

191 """ 

192 with nogil: 64 ctx1PQRSXYZ05678HIJKbcdefghijklmnopqTUVW12349!#$LMNOrstuvwxyzABCDEFG

193 __status__ = nvJitLinkComplete(<Handle>handle) 64 ctx1PQRSXYZ05678HIJKbcdefghijklmnopqTUVW12349!#$LMNOrstuvwxyzABCDEFG

194 check_status(__status__) 64 ctx1PQRSXYZ05678HIJKbcdefghijklmnopqTUVW12349!#$LMNOrstuvwxyzABCDEFG

195  

196  

197cpdef size_t get_linked_cubin_size(intptr_t handle) except? 0: (empty)

198 """nvJitLinkGetLinkedCubinSize gets the size of the linked cubin. 

199  

200 Args: 

201 handle (intptr_t): nvJitLink handle. 

202  

203 Returns: 

204 size_t: Size of the linked cubin. 

205  

206 .. seealso:: `nvJitLinkGetLinkedCubinSize` 

207 """ 

208 cdef size_t size 

209 with nogil: 8 ctx1fghivwxy

210 __status__ = nvJitLinkGetLinkedCubinSize(<Handle>handle, &size) 8 ctx1fghivwxy

211 check_status(__status__) 8 ctx1fghivwxy

212 return size 8 ctx1fghivwxy

213  

214  

215cpdef get_linked_cubin(intptr_t handle, cubin): (empty)

216 """nvJitLinkGetLinkedCubin gets the linked cubin. 

217  

218 Args: 

219 handle (intptr_t): nvJitLink handle. 

220 cubin (bytes): The linked cubin. 

221  

222 .. seealso:: `nvJitLinkGetLinkedCubin` 

223 """ 

224 cdef void* _cubin_ = get_buffer_pointer(cubin, -1, readonly=False) 8 ctx1fghivwxy

225 with nogil: 8 ctx1fghivwxy

226 __status__ = nvJitLinkGetLinkedCubin(<Handle>handle, <void*>_cubin_) 8 ctx1fghivwxy

227 check_status(__status__) 8 ctx1fghivwxy

228  

229  

230cpdef size_t get_linked_ptx_size(intptr_t handle) except? 0: (empty)

231 """nvJitLinkGetLinkedPtxSize gets the size of the linked ptx. 

232  

233 Args: 

234 handle (intptr_t): nvJitLink handle. 

235  

236 Returns: 

237 size_t: Size of the linked PTX. 

238  

239 .. seealso:: `nvJitLinkGetLinkedPtxSize` 

240 """ 

241 cdef size_t size 

242 with nogil: 8 ctx1nopqDEFG

243 __status__ = nvJitLinkGetLinkedPtxSize(<Handle>handle, &size) 8 ctx1nopqDEFG

244 check_status(__status__) 8 ctx1nopqDEFG

245 return size 8 ctx1nopqDEFG

246  

247  

248cpdef get_linked_ptx(intptr_t handle, ptx): (empty)

249 """nvJitLinkGetLinkedPtx gets the linked ptx. 

250  

251 Args: 

252 handle (intptr_t): nvJitLink handle. 

253 ptx (bytes): The linked PTX. 

254  

255 .. seealso:: `nvJitLinkGetLinkedPtx` 

256 """ 

257 cdef void* _ptx_ = get_buffer_pointer(ptx, -1, readonly=False) 8 ctx1nopqDEFG

258 with nogil: 8 ctx1nopqDEFG

259 __status__ = nvJitLinkGetLinkedPtx(<Handle>handle, <char*>_ptx_) 8 ctx1nopqDEFG

260 check_status(__status__) 8 ctx1nopqDEFG

261  

262  

263cpdef size_t get_error_log_size(intptr_t handle) except? 0: (empty)

264 """nvJitLinkGetErrorLogSize gets the size of the error log. 

265  

266 Args: 

267 handle (intptr_t): nvJitLink handle. 

268  

269 Returns: 

270 size_t: Size of the error log. 

271  

272 .. seealso:: `nvJitLinkGetErrorLogSize` 

273 """ 

274 cdef size_t size 

275 with nogil: 8 ctx1HIJKLMNO

276 __status__ = nvJitLinkGetErrorLogSize(<Handle>handle, &size) 8 ctx1HIJKLMNO

277 check_status(__status__) 8 ctx1HIJKLMNO

278 return size 8 ctx1HIJKLMNO

279  

280  

281cpdef get_error_log(intptr_t handle, log): (empty)

282 """nvJitLinkGetErrorLog puts any error messages in the log. 

283  

284 Args: 

285 handle (intptr_t): nvJitLink handle. 

286 log (bytes): The error log. 

287  

288 .. seealso:: `nvJitLinkGetErrorLog` 

289 """ 

290 cdef void* _log_ = get_buffer_pointer(log, -1, readonly=False) 8 ctx1HIJKLMNO

291 with nogil: 8 ctx1HIJKLMNO

292 __status__ = nvJitLinkGetErrorLog(<Handle>handle, <char*>_log_) 8 ctx1HIJKLMNO

293 check_status(__status__) 8 ctx1HIJKLMNO

294  

295  

296cpdef size_t get_info_log_size(intptr_t handle) except? 0: (empty)

297 """nvJitLinkGetInfoLogSize gets the size of the info log. 

298  

299 Args: 

300 handle (intptr_t): nvJitLink handle. 

301  

302 Returns: 

303 size_t: Size of the info log. 

304  

305 .. seealso:: `nvJitLinkGetInfoLogSize` 

306 """ 

307 cdef size_t size 

308 with nogil: 8 ctx1bcderstu

309 __status__ = nvJitLinkGetInfoLogSize(<Handle>handle, &size) 8 ctx1bcderstu

310 check_status(__status__) 8 ctx1bcderstu

311 return size 8 ctx1bcderstu

312  

313  

314cpdef get_info_log(intptr_t handle, log): (empty)

315 """nvJitLinkGetInfoLog puts any info messages in the log. 

316  

317 Args: 

318 handle (intptr_t): nvJitLink handle. 

319 log (bytes): The info log. 

320  

321 .. seealso:: `nvJitLinkGetInfoLog` 

322 """ 

323 cdef void* _log_ = get_buffer_pointer(log, -1, readonly=False) 8 ctx1bcderstu

324 with nogil: 8 ctx1bcderstu

325 __status__ = nvJitLinkGetInfoLog(<Handle>handle, <char*>_log_) 8 ctx1bcderstu

326 check_status(__status__) 8 ctx1bcderstu

327  

328  

329cpdef tuple version(): (empty)

330 """nvJitLinkVersion returns the current version of nvJitLink. 

331  

332 Returns: 

333 A 2-tuple containing: 

334  

335 - unsigned int: The major version. 

336 - unsigned int: The minor version. 

337  

338 .. seealso:: `nvJitLinkVersion` 

339 """ 

340 cdef unsigned int major 

341 cdef unsigned int minor 

342 with nogil: 27 ctx2a @ [ ] ^ _ ` { | } ~ abbbcbdbebfbgbhbibjbkblbmbnbobpb

343 __status__ = nvJitLinkVersion(&major, &minor) 27 ctx2a @ [ ] ^ _ ` { | } ~ abbbcbdbebfbgbhbibjbkblbmbnbobpb

344 check_status(__status__) 27 ctx2a @ [ ] ^ _ ` { | } ~ abbbcbdbebfbgbhbibjbkblbmbnbobpb

345 return (major, minor) 27 ctx2a @ [ ] ^ _ ` { | } ~ abbbcbdbebfbgbhbibjbkblbmbnbobpb

346  

347  

348cpdef size_t get_linked_ltoir_size(intptr_t handle) except? 0: (empty)

349 """nvJitLinkGetLinkedLTOIRSize gets the size of the linked LTOIR. 

350  

351 Args: 

352 handle (intptr_t): nvJitLink handle. 

353  

354 Returns: 

355 size_t: Size of the linked LTOIR. 

356  

357 .. seealso:: `nvJitLinkGetLinkedLTOIRSize` 

358 """ 

359 cdef size_t size 

360 with nogil: 8 ctx1jklmzABC

361 __status__ = nvJitLinkGetLinkedLTOIRSize(<Handle>handle, &size) 8 ctx1jklmzABC

362 check_status(__status__) 8 ctx1jklmzABC

363 return size 8 ctx1jklmzABC

364  

365  

366cpdef get_linked_ltoir(intptr_t handle, ltoir): (empty)

367 """nvJitLinkGetLinkedLTOIR gets the linked LTOIR. 

368  

369 Args: 

370 handle (intptr_t): nvJitLink handle. 

371 ltoir (bytes): The linked LTOIR in Container format. 

372  

373 .. seealso:: `nvJitLinkGetLinkedLTOIR` 

374 """ 

375 cdef void* _ltoir_ = get_buffer_pointer(ltoir, -1, readonly=False) 8 ctx1jklmzABC

376 with nogil: 8 ctx1jklmzABC

377 __status__ = nvJitLinkGetLinkedLTOIR(<Handle>handle, <void*>_ltoir_) 8 ctx1jklmzABC

378 check_status(__status__) 8 ctx1jklmzABC

379del _cyb_FastEnum (empty)