Rlog scoped ranges - #134
Merged
Merged
Conversation
rlog lives on its own orphan branch of ROCm/rocmProfileData and is consumed from there as a submodule; there is no 'main' branch. CI triggered on push/pull_request to [main], so it has never run: PRs against the rlog branch were silently green with no build and no ctest. Trigger on [rlog] instead, and say in CONTRIBUTING that the PR base must be changed from the repository default (master).
rlog::Range (header-only) and the Python range()/range_decorator() push on entry and pop on exit. Install Range.h. Document both in the READMEs and fix the Python quick-start example.
bench_range and python/bench_range.py measure rlog::Range and the Python helpers with expensive range arguments. Update the benchmark READMEs.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Purpose
Add utility functions for rlog clients. Scoped-markers and decorators.
What does this PR do?
Adds C++ scoped markers to maintain rlog range push/pops. 'Zero' overhead when logging is off. Leverages a lazy lambda.
Add a python context manager; not so free when logging is off. Best to use the simple guard pattern for short durations.
Add a python decorator; less overhead than the context manager. Reasonable to leave on in production.
How was it tested?
Created benchmark test to verify functionality and performance.
Heavily benchmarked to justify the suggested patterns are effective. Documented timings.