Fix memory leak of Coordinates in unit tests #2306
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
The Coordinates' metric elements can hold shared_ptrs that result in a cyclic dependency between the Fields and the Coordinates, with the result that some unit tests have memory leaks. One place the issue can arise is when multiplying fields by metric elements with `CHECK > 0`. Then, `ASSERT1_FIELDS_COMPATIBLE` checks that both fields share a `Coordinates` -- but this has the side effect of initialising the `shared_ptr` in the metric elements. This means that when the `Mesh` gets destroyed, the `coords_map` starts to destroy its contents, but because the `Coordinates` metric elements members have references to the `Coordinates`, the `Coordinates` in `coords_map` doesn't get destroyed. The end result is that the `Coordinates` gets leaked. The fix here is to use a `weak_ptr` in `Field`. This only gets a reference to the `Coordinates` when needed.
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| @@ -166,7 +166,7 @@ public: | |||
| } | |||
| protected: | |||
| Mesh* fieldmesh{nullptr}; | |||
| mutable std::shared_ptr<Coordinates> fieldCoordinates{nullptr}; | |||
| mutable std::weak_ptr<Coordinates> fieldCoordinates{}; | |||
There was a problem hiding this comment.
warning: member variable fieldCoordinates has protected visibility [cppcoreguidelines-non-private-member-variables-in-classes]
mutable std::weak_ptr<Coordinates> fieldCoordinates{};
^
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.
The Coordinates' metric elements can hold shared_ptrs that result in a
cyclic dependency between the Fields and the Coordinates, with the
result that some unit tests have memory leaks.
One place the issue can arise is when multiplying fields by metric
elements with
CHECK > 0. Then,ASSERT1_FIELDS_COMPATIBLEchecksthat both fields share a
Coordinates-- but this has the side effectof initialising the
shared_ptrin the metric elements.This means that when the
Meshgets destroyed, thecoords_mapstarts to destroy its contents, but because the
Coordinatesmetricelements members have references to the
Coordinates, theCoordinatesincoords_mapdoesn't get destroyed. The end result isthat the
Coordinatesgets leaked.The fix here is to use a
weak_ptrinField. This only gets areference to the
Coordinateswhen needed.