unified-memory-framework icon indicating copy to clipboard operation
unified-memory-framework copied to clipboard

Document thread-safety aspects of UMF API and performance implications

Open vinser52 opened this issue 1 year ago • 0 comments

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.

vinser52 avatar Apr 18 '24 14:04 vinser52