Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Documentation]: hipamd/src/hip_prof_gen.py no explanation of its use. #89

Open
AphidGit opened this issue Jul 13, 2024 · 1 comment
Open
Labels
documentation Improvements or additions to documentation

Comments

@AphidGit
Copy link

Description of errors

I can't find how this script is used. It assumes some ubuntu defaults which makes hip non-compile-able on other platforms.

In particular, the parameter "OPT_PROF_API" I'm having a hard time finding. Exactly what should its value be?
It's called effectively like so, I believe;

python $BASEDIR/09_hip/clr/hipamd/src/hip_prof_gen.py -v ${OPT_PROF_API} ${PROF_API_HDR} ${PROF_API_SRC} ${PROF_API_STR} >${PROF_API_LOG}

Then, I specified the following, intending to use rocprofiler as profile API;

OPT_PROF_API="/opt/rocm/include/rocprofiler/rocprofiler.h "
PROF_API_STR="$BASEDIR/09_hip/clr/hipamd/include/hip/amd_detail/hip_prof_str.h"
PROF_API_HDR="$BASEDIR/09_hip/hip/include/hip/hip_runtime_api.h"
PROF_API_SRC="$BASEDIR/09_hip/clr/hipamd/src" 
PROF_API_LOG="$BASEDIR/09_hip/build/hip_prof_gen_log.txt"

But this fails to do the right thing, producing a malformed header file as it spits out this warning message:

/home/aphid/src/rocm/09_hip/clr/hipamd/src/hip_prof_gen.py Warning: src directory /home/aphid/src/rocm/09_hip/hip/include/hip/hip_runtime_api.h' not found

Clearly, the order of arguments is wrong or the arguments are badly specified or badly named. Now, I can analyze the code and try to piece back together exactly what the parameters should be, but expecting everyone who compiles it to do that work is a bit much...

Could this script get a standard linux/unix -h function that explains its use, and, in particular, what each parameter is. Or a man page. Ideally, include an example, in particular the standard way it's used within the cmake of hip/clr.

Attach any links, screenshots, or additional evidence you think will be helpful.

No response

@AphidGit AphidGit changed the title [Documentation]: hipamd/src /hip_prof_gen.py no explanation of its use. [Documentation]: hipamd/src/hip_prof_gen.py no explanation of its use. Jul 13, 2024
@ppanchad-amd ppanchad-amd added the documentation Improvements or additions to documentation label Sep 20, 2024
@ppanchad-amd
Copy link

@AphidGit Internal ticket has been created to fix documentation. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants