[hipFile] doc: High-level overview of the IO paths#4866
[hipFile] doc: High-level overview of the IO paths#4866systems-assistant[bot] wants to merge 2 commits into
Conversation
…evelop/ROCm_hipFile/pr-250
github-actions
Bot
added
the
documentation
jordan-turbofish
changed the title
There was a problem hiding this comment.
Pull request overview
Adds a high-level documentation page describing how hipFile chooses between its two I/O execution paths (direct GPU↔storage vs CPU bounce-buffer fallback).
Changes:
- Introduces a new
io_path.rstdocument explaining fastpath vs fallback path behavior. - Documents the criteria required for fastpath eligibility and describes the request flow at a high level.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| request, pins the GPU buffer, and then submits the IO request to the virtual | ||
| filesystem layer. | ||
|
|
||
| Fallback Path |
There was a problem hiding this comment.
Section titles are inconsistent: this page uses "Fastpath" (one word) but "Fallback Path" (two words). For readability and searchability, make the naming consistent across both headings (and ideally match the terminology used in the surrounding text).
| Fallback Path | |
| Fallback path |
| * the filesystem backing the file must support direct IO | ||
| * the memory type of the buffer must be ``hipMemoryTypeDevice`` |
There was a problem hiding this comment.
Bullet list capitalization is inconsistent (some items start with a lowercase letter). Please capitalize the start of each bullet (and keep the list items parallel) for consistent grammar.
| * the filesystem backing the file must support direct IO | |
| * the memory type of the buffer must be ``hipMemoryTypeDevice`` | |
| * The filesystem backing the file must support direct IO | |
| * The memory type of the buffer must be ``hipMemoryTypeDevice`` |
|
This pull request has been inactive for 25 days and will be marked as stale. If you would like to keep this PR open, please:
This PR will be automatically closed in 5 days if no further activity occurs. |
AIHIPFILE-27
🔁 Imported from ROCm/hipFile#250
🧑💻 Originally authored by @kurtmcmillan