Fixes bug with variable naming in a couple of macros #596
Conversation
This file contains 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
…due to lack of macro expansion
daboehme
reviewed
Sep 30, 2024
include/caliper/cali_macros.h
Outdated
| // These macros were obtained from: | ||
| // https://stackoverflow.com/a/71899854 | ||
| #define CONCAT_(prefix, suffix) perfix##suffix | ||
| #define CREATE_VAR_NAME(prefix, suffix) CONCAT_(prefix, suffix) |
There was a problem hiding this comment.
I'd prefix these with CALI_ just to be sure
There was a problem hiding this comment.
Sounds good. I'll do that. Also, I'll tweak the logic for checking the results of the unit tests. I didn't realize that my test change would mess with the result logic.
There was a problem hiding this comment.
d8055c6 resolves this and fixes unit tests.
ilumsden
force-pushed
the
macro_concat_fix
branch
from
ec0ab33 to
d8055c6
Compare
ilumsden
force-pushed
the
macro_concat_fix
branch
from
d8055c6 to
2c73a45
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR fixes a bug with two Caliper macros:
CALI_CXX_MARK_FUNCTIONCALI_CXX_MARK_SCOPEBoth of these macros creates variables using special macros (i.e.,
__func__and__LINE__) and token concatenation (i.e.,##). However, token concatenation prevents recursive evaluation of macros, which can cause compilation issues.As an example, consider the following code:
After pre-processing, the code would look like:
Since these two variables have the same name, this code will fail to compile.
This PR fixes this bug by making use of the macro logic from this StackOverlow post.