[Bugfix] Restrict CopyOnWrite to _type_final #17132
Merged
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
Prior to this commit, the `TVM_DEFINE_OBJECT_REF_COW_METHOD` could be used in any `ObjectRef` subclass to provide a `CopyOnWrite` method. However, the implementation of this method method was invalid if the object's `ContainerType` could itself be subclassed. In that case, using `obj.CopyOnWrite()` when the object contains a subclass, and when a copy is required, would silently convert `obj` to instead contain a base class. This commit adds a `static_assert`, to the `TVM_DEFINE_OBJECT_REF_COW_METHOD` macro, preventing the macro from being used in classes that would have incorrect usage. Compilation with this change found two classes, `relax::Var` and `relax::BindingBlock` that were susceptible to this error, and the macro has been removed from these classes. For backwards-compatibility, the `CopyOnWrite` function for these two classes is provided explicitly.
tqchen
approved these changes
Jul 2, 2024
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.
Prior to this commit, the
TVM_DEFINE_OBJECT_REF_COW_METHODcould be used in anyObjectRefsubclass to provide aCopyOnWritemethod. However, the implementation of this method method was invalid if the object'sContainerTypecould itself be subclassed. In that case, usingobj.CopyOnWrite()when the object contains a subclass, and when a copy is required, would silently convertobjto instead contain a base class.This commit adds a
static_assert, to theTVM_DEFINE_OBJECT_REF_COW_METHODmacro, preventing the macro from being used in classes that would have incorrect usage.Compilation with this change found two classes,
relax::Varandrelax::BindingBlock, that were susceptible to this error, and the macro has been removed from these classes. For backwards-compatibility, theCopyOnWritefunction for these two classes is provided explicitly.