-
Notifications
You must be signed in to change notification settings - Fork 223
Move pathfinder to cuda-python top level
#723
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 17 commits
fbdebfa
731256d
6e0ec6c
07e1385
68aa8d5
fafa998
4eff7d2
db0f540
9fea2e7
c494ef2
78b8c6d
5690d96
81b9bd9
b9be5cb
79a8019
975ba0b
3678fb4
c25184e
58b2513
050f857
1933869
50f4f8e
787236c
5b5078b
13e08ae
97f9dc8
e18cf05
b015bbe
36491c8
c6187db
346e8b9
9207966
3682f7d
7742c5c
92c8441
a5b7190
db0ea56
9a9f1d7
aac1cf7
989db08
222df6c
0b8af00
f902dc9
481f8de
fd18e1e
796bd46
06763af
b2135cf
bf48142
135a37d
48c6d63
7ab201a
9f3e9a4
00c8b6a
034286a
aaed5f2
9d8c70c
8440f90
98ae874
9686c2f
f3c0006
8f015d2
9f17cd1
db7933a
1b9a929
b69bf23
80ebbda
1c8d315
52e1369
70d1c14
342ca49
4e0033c
74ef126
5e85328
46fd972
428a2dc
4096885
5e6c7e5
d787a4c
60918d5
933a889
c0509be
eedf658
58ca181
b73f421
88c4ebc
ee19b0c
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,56 +1 @@ | ||
| # `cuda.bindings.path_finder` Module | ||
|
|
||
| ## Public API (Work in Progress) | ||
|
|
||
| Currently exposes two primary interfaces: | ||
|
|
||
| ``` | ||
| cuda.bindings.path_finder._SUPPORTED_LIBNAMES # ('nvJitLink', 'nvrtc', 'nvvm') | ||
| cuda.bindings.path_finder._load_nvidia_dynamic_library(libname: str) -> LoadedDL | ||
| ``` | ||
|
|
||
| **Note:** | ||
| These APIs are prefixed with an underscore because they are considered | ||
| experimental while undergoing active development, although already | ||
| reasonably well-tested through CI pipelines. | ||
|
|
||
| ## Library Loading Search Priority | ||
|
|
||
| The `load_nvidia_dynamic_library()` function implements a hierarchical search | ||
| strategy for locating NVIDIA shared libraries: | ||
|
|
||
| 0. **Check if a library was loaded into the process already by some other means.** | ||
| - If yes, there is no alternative to skipping the rest of the search logic. | ||
| The absolute path of the already loaded library will be returned, along | ||
| with the handle to the library. | ||
|
|
||
| 1. **NVIDIA Python wheels** | ||
| - Scans all site-packages to find libraries installed via NVIDIA Python wheels. | ||
|
|
||
| 2. **OS default mechanisms / Conda environments** | ||
| - Falls back to native loader: | ||
| - `dlopen()` on Linux | ||
| - `LoadLibraryW()` on Windows | ||
| - Conda installations are expected to be discovered: | ||
| - Linux: Via `$ORIGIN/../lib` on `RPATH` (of the `python` binary; | ||
| note that this preempts `LD_LIBRARY_PATH` and `/etc/ld.so.conf.d/`) | ||
| - Windows: Via `%CONDA_PREFIX%\Library\bin` on system `PATH` | ||
| - CTK installations with system config updates are expected to be discovered: | ||
| - Linux: Via `/etc/ld.so.conf.d/*cuda*.conf` | ||
| - Windows: Via `C:\Program Files\NVIDIA GPU Computing Toolkit\CUDA\vX.Y\bin` on system `PATH` | ||
|
|
||
| 3. **Environment variables** | ||
| - Relies on `CUDA_HOME` or `CUDA_PATH` environment variables if set | ||
| (in that order). | ||
|
|
||
| Note that the search is done on a per-library basis. There is no centralized | ||
| mechanism that ensures all libraries are found in the same way. | ||
|
|
||
| ## Maintenance Requirements | ||
|
|
||
| These key components must be updated for new CUDA Toolkit releases: | ||
|
|
||
| - `supported_libs.SUPPORTED_LIBNAMES` | ||
| - `supported_libs.SUPPORTED_WINDOWS_DLLS` | ||
| - `supported_libs.SUPPORTED_LINUX_SONAMES` | ||
| - `supported_libs.EXPECTED_LIB_SYMBOLS` | ||
| # The `cuda.bindings.path_finder` module was moved → `cuda.pathfinder` |
This file was deleted.
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,177 @@ | ||
|
|
||
| Apache License | ||
| Version 2.0, January 2004 | ||
| http://www.apache.org/licenses/ | ||
|
|
||
| TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION | ||
|
|
||
| 1. Definitions. | ||
|
|
||
| "License" shall mean the terms and conditions for use, reproduction, | ||
| and distribution as defined by Sections 1 through 9 of this document. | ||
|
|
||
| "Licensor" shall mean the copyright owner or entity authorized by | ||
| the copyright owner that is granting the License. | ||
|
|
||
| "Legal Entity" shall mean the union of the acting entity and all | ||
| other entities that control, are controlled by, or are under common | ||
| control with that entity. For the purposes of this definition, | ||
| "control" means (i) the power, direct or indirect, to cause the | ||
| direction or management of such entity, whether by contract or | ||
| otherwise, or (ii) ownership of fifty percent (50%) or more of the | ||
| outstanding shares, or (iii) beneficial ownership of such entity. | ||
|
|
||
| "You" (or "Your") shall mean an individual or Legal Entity | ||
| exercising permissions granted by this License. | ||
|
|
||
| "Source" form shall mean the preferred form for making modifications, | ||
| including but not limited to software source code, documentation | ||
| source, and configuration files. | ||
|
|
||
| "Object" form shall mean any form resulting from mechanical | ||
| transformation or translation of a Source form, including but | ||
| not limited to compiled object code, generated documentation, | ||
| and conversions to other media types. | ||
|
|
||
| "Work" shall mean the work of authorship, whether in Source or | ||
| Object form, made available under the License, as indicated by a | ||
| copyright notice that is included in or attached to the work | ||
| (an example is provided in the Appendix below). | ||
|
|
||
| "Derivative Works" shall mean any work, whether in Source or Object | ||
| form, that is based on (or derived from) the Work and for which the | ||
| editorial revisions, annotations, elaborations, or other modifications | ||
| represent, as a whole, an original work of authorship. For the purposes | ||
| of this License, Derivative Works shall not include works that remain | ||
| separable from, or merely link (or bind by name) to the interfaces of, | ||
| the Work and Derivative Works thereof. | ||
|
|
||
| "Contribution" shall mean any work of authorship, including | ||
| the original version of the Work and any modifications or additions | ||
| to that Work or Derivative Works thereof, that is intentionally | ||
| submitted to Licensor for inclusion in the Work by the copyright owner | ||
| or by an individual or Legal Entity authorized to submit on behalf of | ||
| the copyright owner. For the purposes of this definition, "submitted" | ||
| means any form of electronic, verbal, or written communication sent | ||
| to the Licensor or its representatives, including but not limited to | ||
| communication on electronic mailing lists, source code control systems, | ||
| and issue tracking systems that are managed by, or on behalf of, the | ||
| Licensor for the purpose of discussing and improving the Work, but | ||
| excluding communication that is conspicuously marked or otherwise | ||
| designated in writing by the copyright owner as "Not a Contribution." | ||
|
|
||
| "Contributor" shall mean Licensor and any individual or Legal Entity | ||
| on behalf of whom a Contribution has been received by Licensor and | ||
| subsequently incorporated within the Work. | ||
|
|
||
| 2. Grant of Copyright License. Subject to the terms and conditions of | ||
| this License, each Contributor hereby grants to You a perpetual, | ||
| worldwide, non-exclusive, no-charge, royalty-free, irrevocable | ||
| copyright license to reproduce, prepare Derivative Works of, | ||
| publicly display, publicly perform, sublicense, and distribute the | ||
| Work and such Derivative Works in Source or Object form. | ||
|
|
||
| 3. Grant of Patent License. Subject to the terms and conditions of | ||
| this License, each Contributor hereby grants to You a perpetual, | ||
| worldwide, non-exclusive, no-charge, royalty-free, irrevocable | ||
| (except as stated in this section) patent license to make, have made, | ||
| use, offer to sell, sell, import, and otherwise transfer the Work, | ||
| where such license applies only to those patent claims licensable | ||
| by such Contributor that are necessarily infringed by their | ||
| Contribution(s) alone or by combination of their Contribution(s) | ||
| with the Work to which such Contribution(s) was submitted. If You | ||
| institute patent litigation against any entity (including a | ||
| cross-claim or counterclaim in a lawsuit) alleging that the Work | ||
| or a Contribution incorporated within the Work constitutes direct | ||
| or contributory patent infringement, then any patent licenses | ||
| granted to You under this License for that Work shall terminate | ||
| as of the date such litigation is filed. | ||
|
|
||
| 4. Redistribution. You may reproduce and distribute copies of the | ||
| Work or Derivative Works thereof in any medium, with or without | ||
| modifications, and in Source or Object form, provided that You | ||
| meet the following conditions: | ||
|
|
||
| (a) You must give any other recipients of the Work or | ||
| Derivative Works a copy of this License; and | ||
|
|
||
| (b) You must cause any modified files to carry prominent notices | ||
| stating that You changed the files; and | ||
|
|
||
| (c) You must retain, in the Source form of any Derivative Works | ||
| that You distribute, all copyright, patent, trademark, and | ||
| attribution notices from the Source form of the Work, | ||
| excluding those notices that do not pertain to any part of | ||
| the Derivative Works; and | ||
|
|
||
| (d) If the Work includes a "NOTICE" text file as part of its | ||
| distribution, then any Derivative Works that You distribute must | ||
| include a readable copy of the attribution notices contained | ||
| within such NOTICE file, excluding those notices that do not | ||
| pertain to any part of the Derivative Works, in at least one | ||
| of the following places: within a NOTICE text file distributed | ||
| as part of the Derivative Works; within the Source form or | ||
| documentation, if provided along with the Derivative Works; or, | ||
| within a display generated by the Derivative Works, if and | ||
| wherever such third-party notices normally appear. The contents | ||
| of the NOTICE file are for informational purposes only and | ||
| do not modify the License. You may add Your own attribution | ||
| notices within Derivative Works that You distribute, alongside | ||
| or as an addendum to the NOTICE text from the Work, provided | ||
| that such additional attribution notices cannot be construed | ||
| as modifying the License. | ||
|
|
||
| You may add Your own copyright statement to Your modifications and | ||
| may provide additional or different license terms and conditions | ||
| for use, reproduction, or distribution of Your modifications, or | ||
| for any such Derivative Works as a whole, provided Your use, | ||
| reproduction, and distribution of the Work otherwise complies with | ||
| the conditions stated in this License. | ||
|
|
||
| 5. Submission of Contributions. Unless You explicitly state otherwise, | ||
| any Contribution intentionally submitted for inclusion in the Work | ||
| by You to the Licensor shall be under the terms and conditions of | ||
| this License, without any additional terms or conditions. | ||
| Notwithstanding the above, nothing herein shall supersede or modify | ||
| the terms of any separate license agreement you may have executed | ||
| with Licensor regarding such Contributions. | ||
|
|
||
| 6. Trademarks. This License does not grant permission to use the trade | ||
| names, trademarks, service marks, or product names of the Licensor, | ||
| except as required for reasonable and customary use in describing the | ||
| origin of the Work and reproducing the content of the NOTICE file. | ||
|
|
||
| 7. Disclaimer of Warranty. Unless required by applicable law or | ||
| agreed to in writing, Licensor provides the Work (and each | ||
| Contributor provides its Contributions) on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or | ||
| implied, including, without limitation, any warranties or conditions | ||
| of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A | ||
| PARTICULAR PURPOSE. You are solely responsible for determining the | ||
| appropriateness of using or redistributing the Work and assume any | ||
| risks associated with Your exercise of permissions under this License. | ||
|
|
||
| 8. Limitation of Liability. In no event and under no legal theory, | ||
| whether in tort (including negligence), contract, or otherwise, | ||
| unless required by applicable law (such as deliberate and grossly | ||
| negligent acts) or agreed to in writing, shall any Contributor be | ||
| liable to You for damages, including any direct, indirect, special, | ||
| incidental, or consequential damages of any character arising as a | ||
| result of this License or out of the use or inability to use the | ||
| Work (including but not limited to damages for loss of goodwill, | ||
| work stoppage, computer failure or malfunction, or any and all | ||
| other commercial damages or losses), even if such Contributor | ||
| has been advised of the possibility of such damages. | ||
|
|
||
| 9. Accepting Warranty or Additional Liability. While redistributing | ||
| the Work or Derivative Works thereof, You may choose to offer, | ||
| and charge a fee for, acceptance of support, warranty, indemnity, | ||
| or other liability obligations and/or rights consistent with this | ||
| License. However, in accepting such obligations, You may act only | ||
| on Your own behalf and on Your sole responsibility, not on behalf | ||
| of any other Contributor, and only if You agree to indemnify, | ||
| defend, and hold each Contributor harmless for any liability | ||
| incurred by, or claims asserted against, such Contributor by reason | ||
| of your accepting any such warranty or additional liability. | ||
|
|
||
| END OF TERMS AND CONDITIONS |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| # `cuda.pathfinder` Module | ||
|
|
||
| ## Public API (Work in Progress) | ||
|
|
||
| Currently exposes two primary interfaces: | ||
|
|
||
| ``` | ||
| cuda.pathfinder.SUPPORTED_LIBNAMES # ('nvJitLink', 'nvrtc', 'nvvm') | ||
| cuda.pathfinder.nvidia_dynamic_libs.load_lib(libname: str) -> LoadedDL | ||
| ``` | ||
|
|
||
| ## Dynamic Library Loading Search Priority | ||
|
|
||
| The `cuda.pathfinder.nvidia_dynamic_libs.load_lib` function implements a | ||
| hierarchical search strategy for locating NVIDIA shared libraries: | ||
|
|
||
| 0. **Check if a library was loaded into the process already by some other means.** | ||
| - If yes, there is no alternative to skipping the rest of the search logic. | ||
| The absolute path of the already loaded library will be returned, along | ||
| with the handle to the library. | ||
|
|
||
| 1. **NVIDIA Python wheels** | ||
| - Scans all site-packages to find libraries installed via NVIDIA Python wheels. | ||
|
|
||
| 2. **OS default mechanisms / Conda environments** | ||
| - Falls back to native loader: | ||
| - `dlopen()` on Linux | ||
| - `LoadLibraryW()` on Windows | ||
| - Conda installations are expected to be discovered: | ||
| - Linux: Via `$ORIGIN/../lib` on `RPATH` (of the `python` binary; | ||
| note that this preempts `LD_LIBRARY_PATH` and `/etc/ld.so.conf.d/`) | ||
| - Windows: Via `%CONDA_PREFIX%\Library\bin` on system `PATH` | ||
| - CTK installations with system config updates are expected to be discovered: | ||
| - Linux: Via `/etc/ld.so.conf.d/*cuda*.conf` | ||
| - Windows: Via `C:\Program Files\NVIDIA GPU Computing Toolkit\CUDA\vX.Y\bin` on system `PATH` | ||
|
|
||
| 3. **Environment variables** | ||
| - Relies on `CUDA_HOME` or `CUDA_PATH` environment variables if set | ||
| (in that order). | ||
|
|
||
| Note that the search is done on a per-library basis. Currently there is no | ||
| centralized mechanism that ensures all libraries are found in the same way. | ||
|
|
||
| ## Maintenance Requirements | ||
|
|
||
| These key components must be updated for new CUDA Toolkit releases: | ||
|
|
||
| - `supported_nvidia_libs.SUPPORTED_LIBNAMES` | ||
| - `supported_nvidia_libs.SUPPORTED_WINDOWS_DLLS` | ||
| - `supported_nvidia_libs.SUPPORTED_LINUX_SONAMES` | ||
| - `supported_nvidia_libs.EXPECTED_LIB_SYMBOLS` | ||
rwgk marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| # SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved. | ||
| # SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| from cuda.pathfinder._dynamic_libs import load_nvidia_dynamic_lib as _load_nvidia_dynamic_lib | ||
| from cuda.pathfinder._dynamic_libs.load_dl_common import LoadedDL | ||
| from cuda.pathfinder._dynamic_libs.supported_nvidia_libs import SUPPORTED_LIBNAMES as SUPPORTED_NVIDIA_LIBNAMES | ||
|
|
||
| __all__ = ["SUPPORTED_NVIDIA_LIBNAMES", "load_nvidia_dynamic_lib"] | ||
|
|
||
|
|
||
| def load_nvidia_dynamic_lib(libname: str) -> LoadedDL: | ||
| """Load a NVIDIA dynamic library by name. | ||
|
|
||
| Args: | ||
| libname: The name of the library to load (e.g. "cudart", "nvvm", etc.) | ||
|
|
||
| Returns: | ||
| A LoadedDL object containing the library handle and path | ||
|
|
||
| Raises: | ||
| RuntimeError: If the library cannot be found or loaded | ||
| """ | ||
| return _load_nvidia_dynamic_lib.load_lib(libname) | ||
|
||
Uh oh!
There was an error while loading. Please reload this page.