[QoL][IR] Provide default constructor for NameSupply/GlobalVarSupply #17135
Conversation
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
Prior to this commit, a `tvm::NameSupply` needed to be constructed with an explicit `const String& prefix` argument. Omitting this argument would fall back to the default constructor provided by the `TVM_DEFINE_MUTABLE_OBJECT_REF_METHODS` macro, producing a `NameSupply` holding a nullptr. This then leads to a segfault when the null `NameSupply` is used. The vast majority of usages of `NameSupply::NameSupply` (29 out of 31) initialize it with an empty `prefix` string. The remaining two use cases initialize it with a non-empty `prefix` string. There are no cases in which a null `NameSupply` is initialized. This commit updates `NameSupply` to use the `TVM_DEFINE_MUTABLE_NOTNULLABLE_OBJECT_REF_METHODS` macro instead of `TVM_DEFINE_MUTABLE_OBJECT_REF_METHODS`. This allows the default constructor to provide the common usage of a `NameSupply` with an empty prefix, rather than the error-prone usage of a null `NameSupply` A similar change is also made for `GlobalVarSupply`, as the majority of its uses also default to an empty prefix (11 out of 13).
Contributor
Author
|
I've accidentally made this mistake too many times, and wanted to make it harder to hit this segfault. |
masahi
approved these changes
Jul 12, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Prior to this commit, a
tvm::NameSupplyneeded to be constructed with an explicitconst String& prefixargument. Omitting this argument would fall back to the default constructor provided by theTVM_DEFINE_MUTABLE_OBJECT_REF_METHODSmacro, producing aNameSupplyholding a nullptr. This then leads to a segfault when the nullNameSupplyis used.The vast majority of usages of
NameSupply::NameSupply(29 out of 31) initialize it with an emptyprefixstring. The remaining two use cases initialize it with a non-emptyprefixstring. There are no cases in which a nullNameSupplyis initialized.This commit updates
NameSupplyto use theTVM_DEFINE_MUTABLE_NOTNULLABLE_OBJECT_REF_METHODSmacro instead ofTVM_DEFINE_MUTABLE_OBJECT_REF_METHODS. This allows the default constructor to provide the common usage of aNameSupplywith an empty prefix, rather than the error-prone usage of a nullNameSupplyA similar change is also made for
GlobalVarSupply, as the majority of its uses also default to an empty prefix (11 out of 13).