-
Notifications
You must be signed in to change notification settings - Fork 306
[doc-only] docs: clarify cuda.core concurrency and thread-safety policy #2318
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
Open
Andy-Jost
wants to merge
1
commit into
NVIDIA:main
Choose a base branch
from
Andy-Jost:ajost/docs-concurrency-thread-safety
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+68
−1
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| .. SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved. | ||
| .. SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| .. currentmodule:: cuda.core | ||
|
|
||
| Concurrency and Thread Safety | ||
| ============================= | ||
|
|
||
| ``cuda.core`` allows concurrent reads of its objects from multiple host | ||
| threads, but concurrent *mutation* of the same object is **not supported** -- | ||
| for example, adding nodes to the same graph, or closing a resource while | ||
| another thread is using it. Whenever an object is shared across threads and at | ||
| least one of them may mutate it, the application is responsible for providing | ||
| external synchronization. | ||
|
|
||
| The library does protect the integrity of its own internal state (such as | ||
| cached attributes and reference counting), so that concurrent reads of the same | ||
| object, or any kind of concurrent use of *distinct* objects, cannot corrupt the | ||
| interpreter. This is an integrity guarantee only: the ordering and outcome of | ||
| concurrent operations on a shared object are otherwise undefined. | ||
|
|
||
| Additional limitations apply because ``cuda.core`` inherits the concurrency | ||
| constraints of the underlying CUDA driver. Distinct ``cuda.core`` objects can | ||
| share driver or context state, so operating on separate objects is not always | ||
| safe. For example, modifying peer device access from one thread while another | ||
| thread accesses device memory affected by that change is unsafe, even though the | ||
| two threads use different objects. The application is responsible for | ||
| synchronizing operations that concurrently read and modify shared driver state. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, I think there are a few objects where we want idempotency. But not everwhere (places that use
dict.setdefault()to ensure this).