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

Add aliases to drmemtrace launching: "-t drmemtrace" and "-tool" #6660

Closed
derekbruening opened this issue Feb 16, 2024 · 1 comment · Fixed by #6811
Closed

Add aliases to drmemtrace launching: "-t drmemtrace" and "-tool" #6660

derekbruening opened this issue Feb 16, 2024 · 1 comment · Fixed by #6811

Comments

@derekbruening
Copy link
Contributor

Today all drmemtrace analysis tools are launched with a front-end named "drcachesim" and with a tool selector named "-simulator_type". Those names can be misleading. We should add aliases and update the docs so the invocation changes from:

bin64/drrun -t drcachesim -simulator_type reuse_distance ...

to:

bin64/drrun -t drmemtrace -tool reuse_distance ...
@derekbruening derekbruening self-assigned this Feb 16, 2024
derekbruening added a commit that referenced this issue May 3, 2024
Adds -tool as the preferred alias for the -simulator_type option for
the drmemtrace/drcachesim framework.  This is long overdue as many
analysis tools are not "simulators" and the original option was solely
to pick between cache and TLB simulators.

Updates all uses in tests and documentation.

Adds a release note.

Changes the preferred cache and TLB simulator tool names to have
_simulator suffixes.  Adds a "drcachesim" alias for the cache
simulator as well.

Manually tested the "cache" and "drcachesim" aliases.

Issue: #6660
derekbruening added a commit that referenced this issue May 6, 2024
Adds -tool as the preferred alias for the -simulator_type option for the
drmemtrace/drcachesim framework. This is long overdue as many analysis
tools are not "simulators" and the original option was solely to pick
between cache and TLB simulators.

Updates all uses in tests and documentation.

Adds a release note.

Changes the preferred cache and TLB simulator tool names to have
_simulator suffixes. Adds a "drcachesim" alias for the cache simulator
as well.

Manually tested the "cache" and "drcachesim" aliases.

Issue: #6660
derekbruening added a commit to DynamoRIO/drmemtrace_samples that referenced this issue May 6, 2024
Updates the sample command lines to use the new -tool parameter
instead of the old -simulator_type.

Issue: DynamoRIO/dynamorio#6660
derekbruening added a commit to DynamoRIO/drmemtrace_samples that referenced this issue May 6, 2024
Updates the sample command lines to use the new -tool parameter
instead of the old -simulator_type.

Issue: DynamoRIO/dynamorio#6660
derekbruening added a commit that referenced this issue May 14, 2024
Adds a tool file so "-t drmemtrace" can become the preferred way to
launch the drmemtrace tool framework, as "drcachesim" is just one tool
within the framework.

Updates the documentation and tests.

Renames the "drcachesim" executable to "drmemtrace_launcher".

Fixes #6660
derekbruening added a commit to DynamoRIO/drmemtrace_samples that referenced this issue May 15, 2024
Updates the sample command lines to use the new preferred "-t
drmemtrace" instead of the old "-t drcachesim".  Also updates the
up-front framework name referenced in the README files.

Issue: DynamoRIO/dynamorio#6660
derekbruening added a commit to DynamoRIO/drmemtrace_samples that referenced this issue May 15, 2024
Updates the sample command lines to use the new preferred "-t
drmemtrace" instead of the old "-t drcachesim".  Also updates the
up-front framework name referenced in the README files.

Issue: DynamoRIO/dynamorio#6660
derekbruening added a commit that referenced this issue May 15, 2024
Adds a tool file so "-t drmemtrace" can become the preferred way to
launch the drmemtrace tool framework, as "drcachesim" is just one tool
within the framework.

Updates the documentation and tests.

Renames the "drcachesim" executable to "drmemtrace_launcher".

Fixes #6660
@derekbruening
Copy link
Contributor Author

Note that we decided to not go as far as renaming directories or files.

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

Successfully merging a pull request may close this issue.

1 participant