[hipFile] Implement batch API. by jordan-turbofish · Pull Request #10430 · ROCm/rocm-systems

jordan-turbofish · 2026-08-19T21:42:08Z

Motivation

This PR implements the batch API.

Technical Details

Add a state machine to for the state of each operation. Encodes valid transitions. Invalid transitions throw an error.
Moves creation of BatchOperations to the hipFile API layer so that batch code doesn't grab DriverState lock. Avoids possible deadlock issue with future cleanup code called from DriverState.
Submits run function to thread pool to execute batch operations. Uses the existing synchronous IO calls.
Adds IBatchOperation to allow mocking of batch operations
Implements the retrieval of batch operation statuses for operations that have completed
Implements cancelation of batch operations
Implements destruction of batch contexts
Fix nullptr issue in hipFileBatchIOGetStatus
Cleanup batch_map when the driver is closed
Adds system tests for batch

Issue Tracking

Part of:

JIRA ID: AIHIPFILE-65

Test Plan

Unit tests added for new functionality and system tests added for batch.

Test Result

Tests pass.

Submission Checklist

Look over the contributing guidelines at https://github.com/ROCm/rocm-systems/blob/develop/CONTRIBUTING.md.

therock-pr-bot · 2026-08-19T21:42:48Z

✅ All Policy Checks Passed

Check	Status	Details
📝 PR Description	✅ Pass	—
⛔ Forbidden Files	✅ Pass	—
🧪 Unit Test	⚠️ Warning	Error: Source/code files changed without an accompanying unit test. Expected: add at least one test file named like `test_<name>.py` / `test_<name>.cpp` (or `<name>_test.`). Current:* code file(s) changed: `projects/hipfile/include/hipfile.h`, `projects/hipfile/src/amd_detail/batch/batch.cpp`, `projects/hipfile/src/amd_detail/batch/batch.h`, `projects/hipfile/src/amd_detail/hipfile-private.h`, `projects/hipfile/src/amd_detail/hipfile.cpp` (+9 more); no test file found
🚫 Draft PR	🔜 To Be Enabled	—
🚩 Feature Flag	🔜 To Be Enabled	—
📊 Code Coverage	🔜 To Be Enabled	—

🎉 All policy checks passed!

📖 Need help? See the Policy FAQ for details on every check and how to fix failures.

🙋 Wish to Override Policy?

github-advanced-security

CodeQL found more than 20 potential problems in the proposed changes. Check the Files changed tab for more details.

Copilot

Copilot wasn't able to review this pull request because it exceeds the maximum number of lines (20,000). Try reducing the number of changed lines and requesting a review from Copilot again.

Copilot

Pull request overview

Copilot reviewed 15 out of 15 changed files in this pull request and generated 4 comments.

Copilot

Pull request overview

Copilot reviewed 15 out of 15 changed files in this pull request and generated no new comments.

… versions Batch operations acquire the IFile and IBuffer before performing the IO. The IFile / IBuffer version rethrows the HipRuntime error. We will convert it to a hipFileDriverError in batch, since HIP errors would overlap with POXIX errors.

Moves locking of DriverState out of the BatchContext, which could cause ordering issues when cleanup is done during a hipFileDriverClose.

Consts are removed from the IFile and IBuffer to match usage in hipFileIo.

Enables mocking of the batch operations held by the context.

The mutex is not used in a shared capacity.

systems-assistant · 2026-09-01T14:58:41Z

TheRock Submodule Bump Activity

Newest first

2026-09-01 — Included in TheRock via ROCm/TheRock#7793.

github-actions Bot added the project: hipfile label Aug 19, 2026

jordan-turbofish changed the title ~~[hipFile] Implement cancelation and destruction of batch operations.~~ [hipFile] Implement cancelation of batch operations and destruction of batch contexts. Aug 19, 2026

jordan-turbofish force-pushed the users/jpatters/hipfile-batch-rest branch from af3a75e to 6c01708 Compare August 19, 2026 21:57

systems-assistant Bot added the organization: ROCm label Aug 19, 2026

github-advanced-security Bot found potential problems Aug 19, 2026

View reviewed changes

gaoikawa requested a balanced review from Copilot August 19, 2026 22:21

Copilot started reviewing on behalf of gaoikawa August 19, 2026 22:22

View session

Copilot AI reviewed Aug 19, 2026

jordan-turbofish force-pushed the users/jpatters/hipfile-batch-rest branch 3 times, most recently from 67267d5 to 0d0de55 Compare August 24, 2026 16:09

github-advanced-security Bot found potential problems Aug 24, 2026

View reviewed changes

Comment thread projects/hipfile/src/amd_detail/batch/batch.cpp Fixed

gaoikawa requested a balanced review from Copilot August 25, 2026 17:14

Copilot started reviewing on behalf of gaoikawa August 25, 2026 17:14

View session

Copilot AI reviewed Aug 25, 2026

View reviewed changes

Comment thread projects/hipfile/src/amd_detail/batch/batch.cpp Resolved

Comment thread projects/hipfile/src/amd_detail/batch/batch.cpp Resolved

Comment thread projects/hipfile/src/amd_detail/batch/batch.cpp Resolved

Comment thread projects/hipfile/include/hipfile.h Resolved

jordan-turbofish force-pushed the users/jpatters/hipfile-batch-rest branch 4 times, most recently from e6478ed to 8f415ac Compare August 28, 2026 19:19

github-actions Bot added the github actions Pull requests that update GitHub Actions code label Aug 28, 2026

jordan-turbofish force-pushed the users/jpatters/hipfile-batch-rest branch 2 times, most recently from e6478ed to c89b5aa Compare August 31, 2026 16:05

jordan-turbofish marked this pull request as ready for review August 31, 2026 16:07

jordan-turbofish requested a review from a team as a code owner August 31, 2026 16:07

github-advanced-security Bot found potential problems Aug 31, 2026

View reviewed changes

Comment thread projects/hipfile/src/amd_detail/batch/batch.cpp Dismissed

gaoikawa requested a balanced review from Copilot August 31, 2026 16:38

Copilot started reviewing on behalf of gaoikawa August 31, 2026 16:39

View session

Copilot AI reviewed Aug 31, 2026

View reviewed changes

zbyrne reviewed Aug 31, 2026

View reviewed changes

Comment thread projects/hipfile/test/system/batch.cpp Resolved

jordan-turbofish added 23 commits August 31, 2026 16:14

Use camel case for BatchContext methods.

26452ef

Don't allow copying or moving Batch{Context,Operation}

42a9c8d

Add BatchOperation state machine.

20edf62

Clarify description of ret in hipFileIoEvents_t.

2525ed0

Remove batch test cleanup not needed for per-process testing.

475ef44

Use StrictMock for MBatchContext in existing batch API tests

31f410c

Move creation of BatchOperations into hipFileBatchIOSubmit.

c6de03a

Moves locking of DriverState out of the BatchContext, which could cause ordering issues when cleanup is done during a hipFileDriverClose.

Remove const from BatchOperation IFile and IBuffer members

5d791d1

Consts are removed from the IFile and IBuffer to match usage in hipFileIo.

Reject zero count submissions.

8fc554c

Throw BatchFull when a submission exceeds context capacity

bd3e843

Run submitted batch operations on the thread pool

7e2f871

Add IBatchOperation.

e562f98

Enables mocking of the batch operations held by the context.

Rename BatchContext::outstanding_ops to submitted_ops.

60401e6

Add hipFileBatchIOGetStatus.

9e94699

Add hipFileBatchIOCancel.

19c7753

Add hipFileBatchIODestroy.

6a23b5a

Fix nullptr dereferencing in NVIDIA hipFileBatchIOGetStatus

8e72e90

Clear batch_map when driver has no references.

7fa100d

Move HipFileDataOps to its own file.

555540c

Add system tests for batch.

bd3611b

Use a plain mutex for BatchContext.

dabaf5d

The mutex is not used in a shared capacity.

Cancel submitted operations if a thread pool submission fails.

a4e0595

jordan-turbofish force-pushed the users/jpatters/hipfile-batch-rest branch from 488afa7 to a4e0595 Compare August 31, 2026 22:15

jordan-turbofish changed the title ~~[hipFile] Implement cancelation of batch operations and destruction of batch contexts.~~ [hipFile] Implement batch API. Aug 31, 2026

jordan-turbofish merged commit e2430bd into develop Aug 31, 2026
107 of 110 checks passed

jordan-turbofish deleted the users/jpatters/hipfile-batch-rest branch August 31, 2026 23:04

This was referenced Aug 31, 2026

feat(hipFile): Implement status retrieval for completed batch operations. #10429

Closed

[hipFile] Implement execution of submitted batch operations. #9991

Closed

Navigation Menu

Repository navigation

[hipFile] Implement batch API. - #10430

[hipFile] Implement batch API.#10430
jordan-turbofish merged 23 commits into
developfrom
users/jpatters/hipfile-batch-rest

jordan-turbofish commented Aug 19, 2026 •

edited

Loading

Uh oh!

therock-pr-bot Bot commented Aug 19, 2026 •

edited

Loading

Uh oh!

github-advanced-security AI left a comment

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

systems-assistant Bot commented Sep 1, 2026

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

jordan-turbofish commented Aug 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Motivation

Technical Details

Issue Tracking

Test Plan

Test Result

Submission Checklist

Uh oh!

therock-pr-bot Bot commented Aug 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ All Policy Checks Passed

Uh oh!

github-advanced-security AI left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

systems-assistant Bot commented Sep 1, 2026

TheRock Submodule Bump Activity

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

jordan-turbofish commented Aug 19, 2026 •

edited

Loading

therock-pr-bot Bot commented Aug 19, 2026 •

edited

Loading