gpumutex 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
gpumutex-0.1.0/LICENSE ADDED
@@ -0,0 +1,190 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the
44
+ purposes of this License, Derivative Works shall not include works
45
+ that remain separable from, or merely link (or bind by name) to the
46
+ interfaces of, the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including the
49
+ original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing
141
+ the origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ Copyright 2026 Aaron Pazdera
179
+
180
+ Licensed under the Apache License, Version 2.0 (the "License");
181
+ you may not use this file except in compliance with the License.
182
+ You may obtain a copy of the License at
183
+
184
+ http://www.apache.org/licenses/LICENSE-2.0
185
+
186
+ Unless required by applicable law or agreed to in writing, software
187
+ distributed under the License is distributed on an "AS IS" BASIS,
188
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
189
+ See the License for the specific language governing permissions and
190
+ limitations under the License.
@@ -0,0 +1,4 @@
1
+ include gpumutex/libgpumutex.c
2
+ include LICENSE
3
+ include README.md
4
+ exclude gpumutex/libgpumutex.so
@@ -0,0 +1,258 @@
1
+ Metadata-Version: 2.4
2
+ Name: gpumutex
3
+ Version: 0.1.0
4
+ Summary: Exclusive per-process-tree GPU claiming for CUDA workloads via LD_PRELOAD.
5
+ Author-email: Aaron Pazdera <aarpazdera@gmail.com>
6
+ License: Apache License
7
+ Version 2.0, January 2004
8
+ http://www.apache.org/licenses/
9
+
10
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
11
+
12
+ 1. Definitions.
13
+
14
+ "License" shall mean the terms and conditions for use, reproduction,
15
+ and distribution as defined by Sections 1 through 9 of this document.
16
+
17
+ "Licensor" shall mean the copyright owner or entity authorized by
18
+ the copyright owner that is granting the License.
19
+
20
+ "Legal Entity" shall mean the union of the acting entity and all
21
+ other entities that control, are controlled by, or are under common
22
+ control with that entity. For the purposes of this definition,
23
+ "control" means (i) the power, direct or indirect, to cause the
24
+ direction or management of such entity, whether by contract or
25
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
26
+ outstanding shares, or (iii) beneficial ownership of such entity.
27
+
28
+ "You" (or "Your") shall mean an individual or Legal Entity
29
+ exercising permissions granted by this License.
30
+
31
+ "Source" form shall mean the preferred form for making modifications,
32
+ including but not limited to software source code, documentation
33
+ source, and configuration files.
34
+
35
+ "Object" form shall mean any form resulting from mechanical
36
+ transformation or translation of a Source form, including but
37
+ not limited to compiled object code, generated documentation,
38
+ and conversions to other media types.
39
+
40
+ "Work" shall mean the work of authorship, whether in Source or
41
+ Object form, made available under the License, as indicated by a
42
+ copyright notice that is included in or attached to the work
43
+ (an example is provided in the Appendix below).
44
+
45
+ "Derivative Works" shall mean any work, whether in Source or Object
46
+ form, that is based on (or derived from) the Work and for which the
47
+ editorial revisions, annotations, elaborations, or other modifications
48
+ represent, as a whole, an original work of authorship. For the
49
+ purposes of this License, Derivative Works shall not include works
50
+ that remain separable from, or merely link (or bind by name) to the
51
+ interfaces of, the Work and Derivative Works thereof.
52
+
53
+ "Contribution" shall mean any work of authorship, including the
54
+ original version of the Work and any modifications or additions
55
+ to that Work or Derivative Works thereof, that is intentionally
56
+ submitted to Licensor for inclusion in the Work by the copyright owner
57
+ or by an individual or Legal Entity authorized to submit on behalf of
58
+ the copyright owner. For the purposes of this definition, "submitted"
59
+ means any form of electronic, verbal, or written communication sent
60
+ to the Licensor or its representatives, including but not limited to
61
+ communication on electronic mailing lists, source code control systems,
62
+ and issue tracking systems that are managed by, or on behalf of, the
63
+ Licensor for the purpose of discussing and improving the Work, but
64
+ excluding communication that is conspicuously marked or otherwise
65
+ designated in writing by the copyright owner as "Not a Contribution."
66
+
67
+ "Contributor" shall mean Licensor and any individual or Legal Entity
68
+ on behalf of whom a Contribution has been received by Licensor and
69
+ subsequently incorporated within the Work.
70
+
71
+ 2. Grant of Copyright License. Subject to the terms and conditions of
72
+ this License, each Contributor hereby grants to You a perpetual,
73
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
74
+ copyright license to reproduce, prepare Derivative Works of,
75
+ publicly display, publicly perform, sublicense, and distribute the
76
+ Work and such Derivative Works in Source or Object form.
77
+
78
+ 3. Grant of Patent License. Subject to the terms and conditions of
79
+ this License, each Contributor hereby grants to You a perpetual,
80
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
81
+ (except as stated in this section) patent license to make, have made,
82
+ use, offer to sell, sell, import, and otherwise transfer the Work,
83
+ where such license applies only to those patent claims licensable
84
+ by such Contributor that are necessarily infringed by their
85
+ Contribution(s) alone or by combination of their Contribution(s)
86
+ with the Work to which such Contribution(s) was submitted. If You
87
+ institute patent litigation against any entity (including a
88
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
89
+ or a Contribution incorporated within the Work constitutes direct
90
+ or contributory patent infringement, then any patent licenses
91
+ granted to You under this License for that Work shall terminate
92
+ as of the date such litigation is filed.
93
+
94
+ 4. Redistribution. You may reproduce and distribute copies of the
95
+ Work or Derivative Works thereof in any medium, with or without
96
+ modifications, and in Source or Object form, provided that You
97
+ meet the following conditions:
98
+
99
+ (a) You must give any other recipients of the Work or
100
+ Derivative Works a copy of this License; and
101
+
102
+ (b) You must cause any modified files to carry prominent notices
103
+ stating that You changed the files; and
104
+
105
+ (c) You must retain, in the Source form of any Derivative Works
106
+ that You distribute, all copyright, patent, trademark, and
107
+ attribution notices from the Source form of the Work,
108
+ excluding those notices that do not pertain to any part of
109
+ the Derivative Works; and
110
+
111
+ (d) If the Work includes a "NOTICE" text file as part of its
112
+ distribution, then any Derivative Works that You distribute must
113
+ include a readable copy of the attribution notices contained
114
+ within such NOTICE file, excluding those notices that do not
115
+ pertain to any part of the Derivative Works, in at least one
116
+ of the following places: within a NOTICE text file distributed
117
+ as part of the Derivative Works; within the Source form or
118
+ documentation, if provided along with the Derivative Works; or,
119
+ within a display generated by the Derivative Works, if and
120
+ wherever such third-party notices normally appear. The contents
121
+ of the NOTICE file are for informational purposes only and
122
+ do not modify the License. You may add Your own attribution
123
+ notices within Derivative Works that You distribute, alongside
124
+ or as an addendum to the NOTICE text from the Work, provided
125
+ that such additional attribution notices cannot be construed
126
+ as modifying the License.
127
+
128
+ You may add Your own copyright statement to Your modifications and
129
+ may provide additional or different license terms and conditions
130
+ for use, reproduction, or distribution of Your modifications, or
131
+ for any such Derivative Works as a whole, provided Your use,
132
+ reproduction, and distribution of the Work otherwise complies with
133
+ the conditions stated in this License.
134
+
135
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
136
+ any Contribution intentionally submitted for inclusion in the Work
137
+ by You to the Licensor shall be under the terms and conditions of
138
+ this License, without any additional terms or conditions.
139
+ Notwithstanding the above, nothing herein shall supersede or modify
140
+ the terms of any separate license agreement you may have executed
141
+ with Licensor regarding such Contributions.
142
+
143
+ 6. Trademarks. This License does not grant permission to use the trade
144
+ names, trademarks, service marks, or product names of the Licensor,
145
+ except as required for reasonable and customary use in describing
146
+ the origin of the Work and reproducing the content of the NOTICE file.
147
+
148
+ 7. Disclaimer of Warranty. Unless required by applicable law or
149
+ agreed to in writing, Licensor provides the Work (and each
150
+ Contributor provides its Contributions) on an "AS IS" BASIS,
151
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
152
+ implied, including, without limitation, any warranties or conditions
153
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
154
+ PARTICULAR PURPOSE. You are solely responsible for determining the
155
+ appropriateness of using or redistributing the Work and assume any
156
+ risks associated with Your exercise of permissions under this License.
157
+
158
+ 8. Limitation of Liability. In no event and under no legal theory,
159
+ whether in tort (including negligence), contract, or otherwise,
160
+ unless required by applicable law (such as deliberate and grossly
161
+ negligent acts) or agreed to in writing, shall any Contributor be
162
+ liable to You for damages, including any direct, indirect, special,
163
+ incidental, or consequential damages of any character arising as a
164
+ result of this License or out of the use or inability to use the
165
+ Work (including but not limited to damages for loss of goodwill,
166
+ work stoppage, computer failure or malfunction, or any and all
167
+ other commercial damages or losses), even if such Contributor
168
+ has been advised of the possibility of such damages.
169
+
170
+ 9. Accepting Warranty or Additional Liability. While redistributing
171
+ the Work or Derivative Works thereof, You may choose to offer,
172
+ and charge a fee for, acceptance of support, warranty, indemnity,
173
+ or other liability obligations and/or rights consistent with this
174
+ License. However, in accepting such obligations, You may act only
175
+ on Your own behalf and on Your sole responsibility, not on behalf
176
+ of any other Contributor, and only if You agree to indemnify,
177
+ defend, and hold each Contributor harmless for any liability
178
+ incurred by, or claims asserted against, such Contributor by reason
179
+ of your accepting any such warranty or additional liability.
180
+
181
+ END OF TERMS AND CONDITIONS
182
+
183
+ Copyright 2026 Aaron Pazdera
184
+
185
+ Licensed under the Apache License, Version 2.0 (the "License");
186
+ you may not use this file except in compliance with the License.
187
+ You may obtain a copy of the License at
188
+
189
+ http://www.apache.org/licenses/LICENSE-2.0
190
+
191
+ Unless required by applicable law or agreed to in writing, software
192
+ distributed under the License is distributed on an "AS IS" BASIS,
193
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
194
+ See the License for the specific language governing permissions and
195
+ limitations under the License.
196
+
197
+ Project-URL: Homepage, https://github.com/apaz-cli/libgpumutex
198
+ Project-URL: GitHub, https://github.com/apaz-cli/libgpumutex
199
+ Project-URL: Issues, https://github.com/apaz-cli/libgpumutex/issues
200
+ Project-URL: Design notes, https://apaz.dev/blog/LD_PRELOAD.html
201
+ Classifier: Operating System :: POSIX :: Linux
202
+ Classifier: Programming Language :: Python :: 3
203
+ Classifier: License :: OSI Approved :: Apache Software License
204
+ Classifier: Topic :: System :: Hardware
205
+ Requires-Python: >=3.8
206
+ Description-Content-Type: text/markdown
207
+ License-File: LICENSE
208
+ Dynamic: license-file
209
+
210
+ # gpumutex
211
+
212
+ This library can be injected into existing CUDA programs with GPUs, such that no process also run under libgpumutex can interfere with another.
213
+
214
+ This is accomplished through relatively interesting means. See the design writeup: https://apaz.dev/blog/LD_PRELOAD.html
215
+
216
+ Linux only (glibc; uses `dl_iterate_phdr`/ELF parsing internally).
217
+
218
+ ## Installing with pip
219
+ ```sh
220
+ pip install gpumutex
221
+ ```
222
+
223
+ ```sh
224
+ GPUMUTEX_VISIBLE_DEVICES=0,1,2,3 gpumutex-run -- python train.py
225
+ # or, equivalently:
226
+ gpumutex-run --visible-devices 0,1,2,3 -- python train.py
227
+ ```
228
+
229
+ ```python
230
+ import gpumutex
231
+
232
+ gpumutex.run(["python", "train.py"], visible_devices="0,1,2,3", check=True)
233
+ gpumutex.system("python train.py", visible_devices=[0, 1, 2, 3])
234
+ ```
235
+
236
+ ## Using Standalone
237
+ ```sh
238
+ # Compile
239
+ cc -shared -fPIC -fvisibility=hidden -o libgpumutex.so gpumutex/libgpumutex.c -ldl -lpthread
240
+ ```
241
+
242
+ Then to run a program under it:
243
+ ```sh
244
+ LD_PRELOAD=./libgpumutex.so GPUMUTEX_VISIBLE_DEVICES=... program program_args
245
+ ```
246
+
247
+ ## Configuration
248
+
249
+ Both usages below are configured the same way as the raw interposer, via
250
+ environment variables. `gpumutex-run` and `gpumutex.run()`/`gpumutex.system()`
251
+ also accept these directly as CLI flags / keyword arguments, which set the
252
+ variable in the child's environment only, without touching your own:
253
+
254
+ | Variable | CLI flag | Python kwarg | Description | Default |
255
+ |-----------------------------|-----------------------|---------------------|-------------------------------------------------------------------------------------------|---------------------|
256
+ | `GPUMUTEX_VISIBLE_DEVICES` | `--visible-devices` | `visible_devices` | Comma-separated device indices to manage (e.g. `"0,2,3"`), or an iterable of indices in Python. Required; without it, the preload is inert. | none (required) |
257
+ | `GPUMUTEX_NUM_DEVICES` | `--num-devices` | `num_devices` | How many of those devices one process tree needs at once. | `1` |
258
+ | `GPUMUTEX_LOCK_DIR` | `--lock-dir` | `lock_dir` | Where lockfiles and the wait queue live. | `/tmp/libgpumutex` |
@@ -0,0 +1,49 @@
1
+ # gpumutex
2
+
3
+ This library can be injected into existing CUDA programs with GPUs, such that no process also run under libgpumutex can interfere with another.
4
+
5
+ This is accomplished through relatively interesting means. See the design writeup: https://apaz.dev/blog/LD_PRELOAD.html
6
+
7
+ Linux only (glibc; uses `dl_iterate_phdr`/ELF parsing internally).
8
+
9
+ ## Installing with pip
10
+ ```sh
11
+ pip install gpumutex
12
+ ```
13
+
14
+ ```sh
15
+ GPUMUTEX_VISIBLE_DEVICES=0,1,2,3 gpumutex-run -- python train.py
16
+ # or, equivalently:
17
+ gpumutex-run --visible-devices 0,1,2,3 -- python train.py
18
+ ```
19
+
20
+ ```python
21
+ import gpumutex
22
+
23
+ gpumutex.run(["python", "train.py"], visible_devices="0,1,2,3", check=True)
24
+ gpumutex.system("python train.py", visible_devices=[0, 1, 2, 3])
25
+ ```
26
+
27
+ ## Using Standalone
28
+ ```sh
29
+ # Compile
30
+ cc -shared -fPIC -fvisibility=hidden -o libgpumutex.so gpumutex/libgpumutex.c -ldl -lpthread
31
+ ```
32
+
33
+ Then to run a program under it:
34
+ ```sh
35
+ LD_PRELOAD=./libgpumutex.so GPUMUTEX_VISIBLE_DEVICES=... program program_args
36
+ ```
37
+
38
+ ## Configuration
39
+
40
+ Both usages below are configured the same way as the raw interposer, via
41
+ environment variables. `gpumutex-run` and `gpumutex.run()`/`gpumutex.system()`
42
+ also accept these directly as CLI flags / keyword arguments, which set the
43
+ variable in the child's environment only, without touching your own:
44
+
45
+ | Variable | CLI flag | Python kwarg | Description | Default |
46
+ |-----------------------------|-----------------------|---------------------|-------------------------------------------------------------------------------------------|---------------------|
47
+ | `GPUMUTEX_VISIBLE_DEVICES` | `--visible-devices` | `visible_devices` | Comma-separated device indices to manage (e.g. `"0,2,3"`), or an iterable of indices in Python. Required; without it, the preload is inert. | none (required) |
48
+ | `GPUMUTEX_NUM_DEVICES` | `--num-devices` | `num_devices` | How many of those devices one process tree needs at once. | `1` |
49
+ | `GPUMUTEX_LOCK_DIR` | `--lock-dir` | `lock_dir` | Where lockfiles and the wait queue live. | `/tmp/libgpumutex` |
@@ -0,0 +1,63 @@
1
+ """Python wrappers around libgpumutex: run subprocesses with libgpumutex.so
2
+ preloaded, so they claim a GPU via the same LD_PRELOAD mechanism described in
3
+ https://apaz.dev/blog/LD_PRELOAD.html.
4
+ """
5
+
6
+ import os
7
+ import subprocess
8
+
9
+ __all__ = ["LIBRARY_PATH", "run", "system"]
10
+
11
+ LIBRARY_PATH = os.path.join(os.path.dirname(os.path.abspath(__file__)), "libgpumutex.so")
12
+
13
+
14
+ def preload_value(existing):
15
+ entries = existing.split()
16
+ if LIBRARY_PATH not in entries:
17
+ entries.append(LIBRARY_PATH)
18
+ return " ".join(entries)
19
+
20
+
21
+ def visible_devices_value(value):
22
+ if isinstance(value, str):
23
+ return value
24
+ return ",".join(str(v) for v in value)
25
+
26
+
27
+ def preload_env(env, *, visible_devices=None, num_devices=None, lock_dir=None):
28
+ env = dict(os.environ if env is None else env)
29
+ env["LD_PRELOAD"] = preload_value(env.get("LD_PRELOAD", ""))
30
+ if visible_devices is not None:
31
+ env["GPUMUTEX_VISIBLE_DEVICES"] = visible_devices_value(visible_devices)
32
+ if num_devices is not None:
33
+ env["GPUMUTEX_NUM_DEVICES"] = str(num_devices)
34
+ if lock_dir is not None:
35
+ env["GPUMUTEX_LOCK_DIR"] = str(lock_dir)
36
+ return env
37
+
38
+
39
+ def run(*args, env=None, visible_devices=None, num_devices=None, lock_dir=None, **kwargs):
40
+ """Like subprocess.run(), but with libgpumutex.so added to LD_PRELOAD.
41
+
42
+ visible_devices, num_devices, and lock_dir set the corresponding
43
+ GPUMUTEX_* environment variables (see README) in the child's
44
+ environment only. visible_devices may be a comma-separated string
45
+ (e.g. "0,2,3") or an iterable of device indices.
46
+ """
47
+ return subprocess.run(
48
+ *args,
49
+ env=preload_env(env, visible_devices=visible_devices, num_devices=num_devices, lock_dir=lock_dir),
50
+ **kwargs,
51
+ )
52
+
53
+
54
+ def system(command, *, visible_devices=None, num_devices=None, lock_dir=None):
55
+ """Runs `command` through the shell, like os.system(), but with
56
+ libgpumutex.so added to LD_PRELOAD in the child's environment.
57
+
58
+ visible_devices, num_devices, and lock_dir are the same as in run().
59
+ """
60
+ return run(
61
+ command, shell=True,
62
+ visible_devices=visible_devices, num_devices=num_devices, lock_dir=lock_dir,
63
+ ).returncode
@@ -0,0 +1,44 @@
1
+ """gpumutex-run: exec a command with libgpumutex.so preloaded.
2
+
3
+ Usage: gpumutex-run [--visible-devices DEVICES] [--num-devices N]
4
+ [--lock-dir DIR] -- <command> [args...]
5
+ """
6
+
7
+ import argparse
8
+ import os
9
+ import sys
10
+
11
+ from . import preload_env
12
+
13
+
14
+ def main(argv=None):
15
+ argv = sys.argv[1:] if argv is None else argv
16
+
17
+ parser = argparse.ArgumentParser(
18
+ prog="gpumutex-run",
19
+ usage="%(prog)s [--visible-devices DEVICES] [--num-devices N] [--lock-dir DIR] -- <command> [args...]",
20
+ )
21
+ parser.add_argument("--visible-devices", metavar="DEVICES", help="sets GPUMUTEX_VISIBLE_DEVICES, e.g. 0,2,3")
22
+ parser.add_argument("--num-devices", metavar="N", help="sets GPUMUTEX_NUM_DEVICES")
23
+ parser.add_argument("--lock-dir", metavar="DIR", help="sets GPUMUTEX_LOCK_DIR")
24
+ parser.add_argument("command", nargs=argparse.REMAINDER)
25
+
26
+ args = parser.parse_args(argv)
27
+ command = args.command
28
+ if command and command[0] == "--":
29
+ command = command[1:]
30
+ if not command:
31
+ parser.print_usage(sys.stderr)
32
+ return 2
33
+
34
+ env = preload_env(
35
+ None,
36
+ visible_devices=args.visible_devices,
37
+ num_devices=args.num_devices,
38
+ lock_dir=args.lock_dir,
39
+ )
40
+ os.execvpe(command[0], command, env)
41
+
42
+
43
+ if __name__ == "__main__":
44
+ sys.exit(main())