oneapi-src / oneapi-src/unified-memory-framework
Document thread-safety aspects of UMF API and performance implications
Nobody has claimed this yet.
- Dominant language
- C
- Stars
- 98
- Forks
- 48
- Avg merge
- 3d 20h
- Merged PRs (30d)
- 6
Description
Rationale
Most UMF APIs are thread-safe and designed for multi-threaded environments. Our documentation should explicitly state thread safety for each UMF API function where applicable. Also, we should describe the performance implications of calling an API concurrently from multiple threads.
Description
Most of our API is thread-safe (where applicable) the API description part of our documentation for each API function should explicitly state whether it is thread-safe or not.
Also for thread-safe function, we should describe the performance implications of calling the function concurrently.
Ideally, performance-critical functions that are supposed to be called on a critical path should not impose global locking/waiting.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by inventorying the UMF API function documentation and identifying which functions are thread-safe. Document the applicable thread-safety status and concurrency performance implications for each API entry, including whether critical-path calls introduce global locking or waiting.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- c
- Domain
- documentation, performance
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100