Skip to content

Conversation

@meserve-amd
Copy link
Contributor

@meserve-amd meserve-amd commented Oct 10, 2025

Motivation

In anticipation of formalizing an API for custom tools to attach with, we will rename librocprofv3-attach.so to librocprofiler-sdk-rocattach.so. This name was chosen because the library is technically not part of rocprofv3. We also anticipate formalizing and publishing a public API with this library, which we are calling ROCAttach. This API will be used by custom tools who wish to create their own attachment scenarios, so they do not need to learn the inner workings of ptrace or the protocol used to communicate with rocprofiler-sdk in the running process.

Technical Details

This PR is staged over a documentation change that I expect to be merged first.

I've kept just the rename separate for easier review and gitfu. Another review and documentation step for this API is to follow.

Test Plan

Use existing CI

Test Result

First result - failed due to incorrect naming of .so file, fixed this
Second result - some existing failures, need to fix before validating this change is ok

Submission Checklist

@meserve-amd meserve-amd requested a review from jrmadsen October 10, 2025 21:36
@meserve-amd meserve-amd requested a review from a team as a code owner October 10, 2025 21:36
@github-actions github-actions bot added documentation Improvements or additions to documentation project: rocprofiler-sdk labels Oct 10, 2025
@meserve-amd meserve-amd force-pushed the users/meserve-amd/attach/rocattach-rename branch from 7059074 to f929080 Compare October 10, 2025 22:00
@github-actions github-actions bot added documentation Improvements or additions to documentation project: rocprofiler-sdk labels Oct 10, 2025
@bgopesh bgopesh force-pushed the users/meserve-amd/attach/doc_cleanup branch from 779a0ae to 1515bc5 Compare October 13, 2025 05:12
@meserve-amd meserve-amd force-pushed the users/meserve-amd/attach/rocattach-rename branch from f929080 to e01b466 Compare October 13, 2025 16:40
Copy link
Contributor

@itrowbri itrowbri left a comment

Choose a reason for hiding this comment

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

I'm not familiar with the component sections of the code, but the changes seem simple enough. Will we need to add some tests outside of the tests/rocprofv3 section if we formalize this change given that attachment won't be limited to rocprofv3 anymore?

@vedithal-amd
Copy link
Contributor

Please rename the library hardcoded in rocprofiler-compute at https://github.com/ROCm/rocm-systems/blob/develop/projects/rocprofiler-compute/src/rocprof_compute_profile/profiler_rocprofiler_sdk.py

@meserve-amd meserve-amd force-pushed the users/meserve-amd/attach/doc_cleanup branch from 0914631 to 89626a2 Compare October 21, 2025 16:04
@meserve-amd meserve-amd marked this pull request as draft October 21, 2025 16:33
@meserve-amd meserve-amd force-pushed the users/meserve-amd/attach/doc_cleanup branch from 89626a2 to 7ef5c91 Compare October 21, 2025 16:39
@meserve-amd meserve-amd force-pushed the users/meserve-amd/attach/rocattach-rename branch 2 times, most recently from 4b0ca98 to e55bc1a Compare October 21, 2025 18:26
@meserve-amd meserve-amd marked this pull request as ready for review October 21, 2025 18:27
@meserve-amd meserve-amd force-pushed the users/meserve-amd/attach/doc_cleanup branch from 7ef5c91 to fc03ac7 Compare October 21, 2025 19:31
@meserve-amd meserve-amd force-pushed the users/meserve-amd/attach/rocattach-rename branch from e55bc1a to cd1a7c7 Compare October 21, 2025 22:52
Base automatically changed from users/meserve-amd/attach/doc_cleanup to develop October 22, 2025 21:16
@meserve-amd meserve-amd force-pushed the users/meserve-amd/attach/rocattach-rename branch 2 times, most recently from 92434df to 2d55220 Compare October 29, 2025 00:25
Copy link
Contributor

@bwelton bwelton left a comment

Choose a reason for hiding this comment

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

Fix the typo, may fix the tests as well.

@meserve-amd meserve-amd force-pushed the users/meserve-amd/attach/rocattach-rename branch from 2d55220 to 87e4dd9 Compare October 30, 2025 19:17
@ammarwa ammarwa removed the request for review from a team October 30, 2025 21:59
@ammarwa ammarwa force-pushed the users/meserve-amd/attach/rocattach-rename branch from f6cd3a8 to 31de924 Compare October 31, 2025 20:58
@meserve-amd meserve-amd force-pushed the users/meserve-amd/attach/rocattach-rename branch 4 times, most recently from 1c24012 to 13a5cdb Compare November 11, 2025 17:02
@meserve-amd meserve-amd dismissed jrmadsen’s stale review November 17, 2025 20:38

Comments have either been addressed or moved to #1653

- Renames library to librocprofiler-sdk-rocattach
- ROCAttach library will be formalized and documented in future commit
- Rename rocprofv3-attach.py to rocprof-attach.py
- Use common filesystem.hpp in rocattach
@meserve-amd meserve-amd force-pushed the users/meserve-amd/attach/rocattach-rename branch from 13a5cdb to 3c31971 Compare November 17, 2025 20:50
@JeniferC99
Copy link
Collaborator

psdb passing rocprofiler test -- override

@JeniferC99 JeniferC99 merged commit 1271813 into develop Nov 18, 2025
27 of 45 checks passed
@JeniferC99 JeniferC99 deleted the users/meserve-amd/attach/rocattach-rename branch November 18, 2025 16:52
systems-assistant bot pushed a commit to ROCm/rocprofiler-compute that referenced this pull request Nov 18, 2025
* attach: rename librocprofv3-attach

- Renames library to librocprofiler-sdk-rocattach
- ROCAttach library will be formalized and documented in future commit

* Address review comments

- Rename rocprofv3-attach.py to rocprof-attach.py
- Use common filesystem.hpp in rocattach

* Fix component name typo

* Doc fixup
[rocm-systems] ROCm/rocm-systems#1342 (commit 1271813)
systems-assistant bot pushed a commit to ROCm/rocprofiler-sdk that referenced this pull request Nov 18, 2025
* attach: rename librocprofv3-attach

- Renames library to librocprofiler-sdk-rocattach
- ROCAttach library will be formalized and documented in future commit

* Address review comments

- Rename rocprofv3-attach.py to rocprof-attach.py
- Use common filesystem.hpp in rocattach

* Fix component name typo

* Doc fixup
[rocm-systems] ROCm/rocm-systems#1342 (commit 1271813)
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.

7 participants