Skip to content

feat(rocKE): add rocKEclient skeleton#8923

Closed
BrianHarrisonAMD wants to merge 3 commits into
developfrom
aick-1470-rocke-client-skeleton
Closed

feat(rocKE): add rocKEclient skeleton#8923
BrianHarrisonAMD wants to merge 3 commits into
developfrom
aick-1470-rocke-client-skeleton

Conversation

@BrianHarrisonAMD

@BrianHarrisonAMD BrianHarrisonAMD commented Jun 29, 2026

Copy link
Copy Markdown
Contributor

Summary

Adds a skeleton rocKEclient project under dnn-providers/hip-kernel-provider/rocKE-client, gated by the rocKE provider flag from PR #8864. When enabled, the project builds and installs librocKEclient.so beside the existing hip-kernel-provider plugin so hipDNN can load it, while the skeleton reports no applicable engines yet. This is the start of the rocKE client library, and will be directly exposing the hipDNN provider API to start with. Later on rocKE client & rocKE provider will be split into two different projects.

JIRA ID : AICK-1470

Risk Assessment

Low risk. This adds opt-in provider build/install and plugin-loading infrastructure, plus a new engine ID, but it is gated off by default and the new plugin intentionally rejects all graphs so it does not change existing dispatch behavior unless explicitly enabled.

ASIC Coverage

ASIC-independent wiring only. The plugin currently performs no GPU execution, exposes no supported operation surface, and returns no applicable engines for every graph; passing standard PR CI plus the local opt-in build/load smoke tests is sufficient, with no dedicated multi-arch sweep required for this skeleton.

Testing Summary

  • Full opt-in provider configure/build/install validated that HIPKERNELPROVIDER_ENABLE_ROCKE=ON builds rocKE, rocKEclient, hipDNN, and hip-kernel-provider together.
  • Installed smoke tests validated the plugin metadata, engine ID query, non-applicability behavior, and hipDNN loading rocKEclient from the installed plugin directory.
  • Targeted unit coverage validates the registered ROCKE_ENGINE name/id mapping and default RocKEContext instantiation.
  • Commit hooks completed through git commit.

Testing Checklist

  • Commit hooks - git commit -m "feat(hipdnn): add rocKEclient provider plugin skeleton" && git commit -m "test(hipdnn): cover rocKEclient skeleton wiring" - Status: Passed
  • Full opt-in provider configure - cmake --preset hip-kernel-provider -B build-rocke-client-full-install -DHIPKERNELPROVIDER_ENABLE_ROCKE=ON -DHIPKERNELPROVIDER_ENABLE_TESTS=OFF -DROCKE_CLIENT_ENABLE_TESTS=ON -DENABLE_ASM_SDPA_ENGINE=OFF -DENABLE_HIP_MLOPS_ENGINE=ON -DENABLE_CLANG_TIDY=OFF -DENABLE_CLANG_FORMAT=OFF - Status: Passed
  • Full opt-in provider build/install - cmake --build build-rocke-client-full-install && cmake --install build-rocke-client-full-install --prefix build-rocke-client-full-install/install - Status: Passed
  • Installed rocKEclient smoke tests - ctest --test-dir build-rocke-client-full-install/install/bin/rocKEclient --output-on-failure - Status: Passed
  • Targeted EngineNames and rocKEclient tests - cmake --preset hip-kernel-provider -B build-rocke-client-test-expansion -DHIPKERNELPROVIDER_ENABLE_ROCKE=ON -DHIPKERNELPROVIDER_ENABLE_TESTS=OFF -DROCKE_CLIENT_ENABLE_TESTS=ON -DENABLE_ASM_SDPA_ENGINE=OFF -DENABLE_HIP_MLOPS_ENGINE=ON -DENABLE_CLANG_TIDY=OFF -DENABLE_CLANG_FORMAT=OFF && cmake --build build-rocke-client-test-expansion --target hipdnn_data_sdk_tests rocke_client_tests rocke_client_integration_tests && ./build-rocke-client-test-expansion/bin/hipdnn_data_sdk_tests --gtest_filter='TestEngineNames.*' && ./build-rocke-client-test-expansion/bin/rocke_client_tests --gtest_filter='TestRocKEContext.*:TestRocKEContainer.*:TestRocKEEngine.*:TestPluginPublic.*' && ./build-rocke-client-test-expansion/bin/rocke_client_integration_tests - Status: Passed
  • PR CI - GitHub PR checks - Status: Pending

Technical Changes

  • Adds the rocKE-client C++ project with version generation, plugin SDK wiring, rocKEclient shared-library target, and install rules for the hipDNN engine plugin directory.
  • Exposes the hipDNN engine plugin C API through hipdnn_plugin_sdk/EnginePluginImpl.inl using rocKEclient container, handle, context, settings, and skeleton engine types.
  • Registers a ROCKE_ENGINE ID and implements a skeleton engine that advertises the ID but returns no applicability and rejects workspace/context creation with HIPDNN_PLUGIN_STATUS_NOT_APPLICABLE.
  • Wires rocKE-client into the existing HIPKERNELPROVIDER_ENABLE_ROCKE block beside the merged rocKE project so both build as part of hip-kernel-provider only when the flag is enabled.
  • Adds unit and integration smoke tests, including explicit ROCKE_ENGINE registry coverage, default RocKEContext construction coverage, and an installed CTest entry that verifies hipDNN loads rocKEclient from the installed plugin path.

@therock-pr-bot

therock-pr-bot Bot commented Jun 29, 2026

Copy link
Copy Markdown

❌ PR Check — Action Required

Check Status Details
🌿 Branch Name ✅ Pass
📝 PR Title/Description ❌ Fail Error: Title does not follow Conventional Commits style.
Expected: start with a valid type (feat, fix, docs, …).
Desired format: type(optional-scope): short description
Forbidden Files ✅ Pass
🧪 Unit Test ❌ Fail 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: dnn-providers/hip-kernel-provider/rocKE-client/src/PluginDefines.hpp, dnn-providers/hip-kernel-provider/rocKE-client/src/PluginPublic.cpp, dnn-providers/hip-kernel-provider/rocKE-client/src/RocKEContainer.cpp, dnn-providers/hip-kernel-provider/rocKE-client/src/RocKEContainer.hpp, dnn-providers/hip-kernel-provider/rocKE-client/src/RocKEContext.hpp (+14 more); no test file found
🔎 pre-commit ✅ Pass
🚫 Draft PR 🔜 To Be Enabled
🚩 Feature Flag 🔜 To Be Enabled
📊 Code Coverage 🔜 To Be Enabled

⚠️ 2 policy check(s) failed. Please address the issues above before this PR can be Reviewed.

🚫 Please fix the failed policies

  • ❌ PR Title/Description
  • ❌ Unit Test

The Not ready to Review label was added to this PR. Once all policies pass, the label is removed automatically.

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

@therock-pr-bot

therock-pr-bot Bot commented Jun 29, 2026

Copy link
Copy Markdown

🚫 Please fix the failed policies before requesting reviews.

The following policy checks failed:

  • ❌ PR Title/Description
  • ❌ Unit Test

The Not ready to Review label has been added to this PR.
Once all policies pass, the label will be removed automatically.

@BrianHarrisonAMD BrianHarrisonAMD changed the title feat(hipdnn): add rocKEclient provider plugin skeleton feat(rocKE): add rocKEclient skeleton Jun 29, 2026
@BrianHarrisonAMD

Copy link
Copy Markdown
Contributor Author

❌ PR Check — Action Required

Check Status Details
🌿 Branch Name ✅ Pass —
📝 PR Title/Description ✅ Pass —
Forbidden Files ✅ Pass —
🧪 Unit Test ❌ Fail 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: dnn-providers/hip-kernel-provider/rocKE-client/src/PluginDefines.hpp, dnn-providers/hip-kernel-provider/rocKE-client/src/PluginPublic.cpp, dnn-providers/hip-kernel-provider/rocKE-client/src/RocKEContainer.cpp, dnn-providers/hip-kernel-provider/rocKE-client/src/RocKEContainer.hpp, dnn-providers/hip-kernel-provider/rocKE-client/src/RocKEContext.hpp (+12 more); no test file found
🔎 pre-commit ✅ Pass —
🚫 Draft PR 🔜 To Be Enabled —
🚩 Feature Flag 🔜 To Be Enabled —
📊 Code Coverage 🔜 To Be Enabled —

⚠️ 1 policy check(s) failed. Please address the issues above before this PR can be Reviewed.
🚫 Please fix the failed policies

  • ❌ Unit Test

The Not ready to Review label was added to this PR. Once all policies pass, the label is removed automatically.

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

Removing the bot's, "not ready" flag since tests are present on all changed files.

@BrianHarrisonAMD BrianHarrisonAMD marked this pull request as ready for review June 29, 2026 21:29
@BrianHarrisonAMD BrianHarrisonAMD requested review from a team as code owners June 29, 2026 21:29
add_executable(
rocke_client_integration_tests
main.cpp
TestRocKEclientLoad.cpp

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should the casing here be TestRocKEClientLoad?

@BrianHarrisonAMD

Copy link
Copy Markdown
Contributor Author

Closing in favor of #8928, which moves the same commits onto the conventional users/bharriso/rocke-client-skeleton branch. The branch here was scuffed; superseded by #8928.

@BrianHarrisonAMD BrianHarrisonAMD deleted the aick-1470-rocke-client-skeleton branch July 7, 2026 15:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants