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

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

2# 

3# SPDX-License-Identifier: LicenseRef-NVIDIA-SOFTWARE-LICENSE 

4# 

5# This code was automatically generated across versions from 12.0.1 to 13.1.1, generator version 0.3.1.dev1322+g646ce84ec. Do not modify it directly. 

6  

7cimport cython # NOQA 

8  

9from ._internal.utils cimport (get_resource_ptr, get_nested_resource_ptr, nested_resource, nullable_unique_ptr, 

10 get_buffer_pointer, get_resource_ptrs) 

11  

12from cuda.bindings._internal._fast_enum import FastEnum as _FastEnum (empty)

13from libcpp.vector cimport vector 

14  

15  

16############################################################################### 

17# Enum 

18############################################################################### 

19  

20class Result(_FastEnum): (empty)

21 """ 

22 The enumerated type nvJitLinkResult defines API call result codes. 

23 nvJitLink APIs return nvJitLinkResult codes to indicate the result. 

24  

25 See `nvJitLinkResult`. 

26 """ 

27 SUCCESS = NVJITLINK_SUCCESS (empty)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

46  

47class InputType(_FastEnum): (empty)

48 """ 

49 The enumerated type nvJitLinkInputType defines the kind of inputs that 

50 can be passed to nvJitLinkAdd* APIs. 

51  

52 See `nvJitLinkInputType`. 

53 """ 

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

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

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

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

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

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

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

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

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

63  

64  

65############################################################################### 

66# Error handling 

67############################################################################### 

68  

69class nvJitLinkError(Exception): (empty)

70  

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

72 self.status = status 4 ctx1KLDE

73 s = Result(status) 4 ctx1KLDE

74 cdef str err = f"{s.name} ({s.value})" 4 ctx1KLDE

75 super(nvJitLinkError, self).__init__(err) 4 ctx1KLDE

76  

77 def __reduce__(self): (empty)

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

79  

80  

81@cython.profile(False) (empty)

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

83 if status != 0: 36 ctx1arstuvwxyzABCFGHInopqbcdefghijklmDJE

84 with gil: 2 ctx1DE

85 raise nvJitLinkError(status) 2 ctx1DE

86 return status 34 ctx1arstuvwxyzABCFGHInopqbcdefghijklmJ

87  

88  

89############################################################################### 

90# Wrapper functions 

91############################################################################### 

92  

93cpdef destroy(intptr_t handle): (empty)

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

95  

96 Args: 

97 handle (intptr_t): nvJitLink handle. 

98  

99 .. seealso:: `nvJitLinkDestroy` 

100 """ 

101 cdef Handle h = <Handle>handle 32 ctx1rstuvwxyzABCFGHInopqbcdefghijklm

102 with nogil: 32 ctx1rstuvwxyzABCFGHInopqbcdefghijklm

103 status = nvJitLinkDestroy(&h) 32 ctx1rstuvwxyzABCFGHInopqbcdefghijklm

104 check_status(status) 32 ctx1rstuvwxyzABCFGHInopqbcdefghijklm

105  

106  

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

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

109  

110 Args: 

111 num_options (uint32_t): Number of options passed. 

112 options (object): Array of size ``num_options`` of option strings. It can be: 

113  

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

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

116 to a valid sequence of 'char', or 

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

118  

119  

120 Returns: 

121 intptr_t: Address of nvJitLink handle. 

122  

123 .. seealso:: `nvJitLinkCreate` 

124 """ 

125 cdef nested_resource[ char ] _options_ 

126 get_nested_resource_ptr[char](_options_, options, <char*>NULL) 34 ctx1rstuvwxyzABCFGHInopqbcdefghijklmDE

127 cdef Handle handle 

128 with nogil: 34 ctx1rstuvwxyzABCFGHInopqbcdefghijklmDE

129 __status__ = nvJitLinkCreate(&handle, num_options, <const char**>(_options_.ptrs.data())) 34 ctx1rstuvwxyzABCFGHInopqbcdefghijklmDE

130 check_status(__status__) 34 ctx1rstuvwxyzABCFGHInopqbcdefghijklmDE

131 return <intptr_t>handle 32 ctx1rstuvwxyzABCFGHInopqbcdefghijklm

132  

133  

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

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

136  

137 Args: 

138 handle (intptr_t): nvJitLink handle. 

139 input_type (InputType): kind of input. 

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

141 size (size_t): size of the data. 

142 name (str): name of input object. 

143  

144 .. seealso:: `nvJitLinkAddData` 

145 """ 

146 cdef void* _data_ = get_buffer_pointer(data, size, readonly=True) 16 ctx1rstubcdefghijklm

147 if not isinstance(name, str): 16 ctx1rstubcdefghijklm

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

149 cdef bytes _temp_name_ = (<str>name).encode() 16 ctx1rstubcdefghijklm

150 cdef char* _name_ = _temp_name_ 16 ctx1rstubcdefghijklm

151 with nogil: 16 ctx1rstubcdefghijklm

152 __status__ = nvJitLinkAddData(<Handle>handle, <_InputType>input_type, <const void*>_data_, size, <const char*>_name_) 16 ctx1rstubcdefghijklm

153 check_status(__status__) 16 ctx1rstubcdefghijklm

154  

155  

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

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

158  

159 Args: 

160 handle (intptr_t): nvJitLink handle. 

161 input_type (InputType): kind of input. 

162 file_name (str): name of file. 

163  

164 .. seealso:: `nvJitLinkAddFile` 

165 """ 

166 if not isinstance(file_name, str): 4 ctx1vwxy

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

168 cdef bytes _temp_file_name_ = (<str>file_name).encode() 4 ctx1vwxy

169 cdef char* _file_name_ = _temp_file_name_ 4 ctx1vwxy

170 with nogil: 4 ctx1vwxy

171 __status__ = nvJitLinkAddFile(<Handle>handle, <_InputType>input_type, <const char*>_file_name_) 4 ctx1vwxy

172 check_status(__status__) 4 ctx1vwxy

173  

174  

175cpdef complete(intptr_t handle): (empty)

176 """nvJitLinkComplete does the actual link. 

177  

178 Args: 

179 handle (intptr_t): nvJitLink handle. 

180  

181 .. seealso:: `nvJitLinkComplete` 

182 """ 

183 with nogil: 28 ctx1rstuvwxyzABCnopqbcdefghijklm

184 __status__ = nvJitLinkComplete(<Handle>handle) 28 ctx1rstuvwxyzABCnopqbcdefghijklm

185 check_status(__status__) 28 ctx1rstuvwxyzABCnopqbcdefghijklm

186  

187  

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

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

190  

191 Args: 

192 handle (intptr_t): nvJitLink handle. 

193  

194 Returns: 

195 size_t: Size of the linked cubin. 

196  

197 .. seealso:: `nvJitLinkGetLinkedCubinSize` 

198 """ 

199 cdef size_t size 

200 with nogil: 4 ctx1fghi

201 __status__ = nvJitLinkGetLinkedCubinSize(<Handle>handle, &size) 4 ctx1fghi

202 check_status(__status__) 4 ctx1fghi

203 return size 4 ctx1fghi

204  

205  

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

207 """nvJitLinkGetLinkedCubin gets the linked cubin. 

208  

209 Args: 

210 handle (intptr_t): nvJitLink handle. 

211 cubin (bytes): The linked cubin. 

212  

213 .. seealso:: `nvJitLinkGetLinkedCubin` 

214 """ 

215 cdef void* _cubin_ = get_buffer_pointer(cubin, -1, readonly=False) 4 ctx1fghi

216 with nogil: 4 ctx1fghi

217 __status__ = nvJitLinkGetLinkedCubin(<Handle>handle, <void*>_cubin_) 4 ctx1fghi

218 check_status(__status__) 4 ctx1fghi

219  

220  

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

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

223  

224 Args: 

225 handle (intptr_t): nvJitLink handle. 

226  

227 Returns: 

228 size_t: Size of the linked PTX. 

229  

230 .. seealso:: `nvJitLinkGetLinkedPtxSize` 

231 """ 

232 cdef size_t size 

233 with nogil: 4 ctx1jklm

234 __status__ = nvJitLinkGetLinkedPtxSize(<Handle>handle, &size) 4 ctx1jklm

235 check_status(__status__) 4 ctx1jklm

236 return size 4 ctx1jklm

237  

238  

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

240 """nvJitLinkGetLinkedPtx gets the linked ptx. 

241  

242 Args: 

243 handle (intptr_t): nvJitLink handle. 

244 ptx (bytes): The linked PTX. 

245  

246 .. seealso:: `nvJitLinkGetLinkedPtx` 

247 """ 

248 cdef void* _ptx_ = get_buffer_pointer(ptx, -1, readonly=False) 4 ctx1jklm

249 with nogil: 4 ctx1jklm

250 __status__ = nvJitLinkGetLinkedPtx(<Handle>handle, <char*>_ptx_) 4 ctx1jklm

251 check_status(__status__) 4 ctx1jklm

252  

253  

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

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

256  

257 Args: 

258 handle (intptr_t): nvJitLink handle. 

259  

260 Returns: 

261 size_t: Size of the error log. 

262  

263 .. seealso:: `nvJitLinkGetErrorLogSize` 

264 """ 

265 cdef size_t size 

266 with nogil: 4 ctx1nopq

267 __status__ = nvJitLinkGetErrorLogSize(<Handle>handle, &size) 4 ctx1nopq

268 check_status(__status__) 4 ctx1nopq

269 return size 4 ctx1nopq

270  

271  

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

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

274  

275 Args: 

276 handle (intptr_t): nvJitLink handle. 

277 log (bytes): The error log. 

278  

279 .. seealso:: `nvJitLinkGetErrorLog` 

280 """ 

281 cdef void* _log_ = get_buffer_pointer(log, -1, readonly=False) 4 ctx1nopq

282 with nogil: 4 ctx1nopq

283 __status__ = nvJitLinkGetErrorLog(<Handle>handle, <char*>_log_) 4 ctx1nopq

284 check_status(__status__) 4 ctx1nopq

285  

286  

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

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

289  

290 Args: 

291 handle (intptr_t): nvJitLink handle. 

292  

293 Returns: 

294 size_t: Size of the info log. 

295  

296 .. seealso:: `nvJitLinkGetInfoLogSize` 

297 """ 

298 cdef size_t size 

299 with nogil: 4 ctx1bcde

300 __status__ = nvJitLinkGetInfoLogSize(<Handle>handle, &size) 4 ctx1bcde

301 check_status(__status__) 4 ctx1bcde

302 return size 4 ctx1bcde

303  

304  

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

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

307  

308 Args: 

309 handle (intptr_t): nvJitLink handle. 

310 log (bytes): The info log. 

311  

312 .. seealso:: `nvJitLinkGetInfoLog` 

313 """ 

314 cdef void* _log_ = get_buffer_pointer(log, -1, readonly=False) 4 ctx1bcde

315 with nogil: 4 ctx1bcde

316 __status__ = nvJitLinkGetInfoLog(<Handle>handle, <char*>_log_) 4 ctx1bcde

317 check_status(__status__) 4 ctx1bcde

318  

319  

320cpdef tuple version(): (empty)

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

322  

323 Returns: 

324 A 2-tuple containing: 

325  

326 - unsigned int: The major version. 

327 - unsigned int: The minor version. 

328  

329 .. seealso:: `nvJitLinkVersion` 

330 """ 

331 cdef unsigned int major 

332 cdef unsigned int minor 

333 with nogil: 2 ctx1aJ

334 __status__ = nvJitLinkVersion(&major, &minor) 2 ctx1aJ

335 check_status(__status__) 2 ctx1aJ

336 return (major, minor) 2 ctx1aJ