Skip to content

[Sofa.Simulation.Core] MappingGraph: fix memory leak in from parent/child shared_ptr cycle #6259

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
fredroy wants to merge 1 commit into
base: master
Choose a base branch
from
+22 −11
Open

[Sofa.Simulation.Core] MappingGraph: fix memory leak in from parent/child shared_ptr cycle #6259

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 13 additions & 7 deletions Sofa/framework/Simulation/Core/src/sofa/simulation/MappingGraph.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,11 +91,14 @@ MappingGraph::MappingInputs MappingGraph::getTopMostMechanicalStates(
current->accept(visitor);
}

for (auto& parent : current->m_parents)
for (auto& weakParent : current->m_parents)
{
if (parent->m_pendingCount == 0)
if (const auto parent = weakParent.lock())
{
nodes.push(parent.get());
if (parent->m_pendingCount == 0)
{
nodes.push(parent.get());
}
}
}
}
Expand Down Expand Up @@ -230,11 +233,14 @@ sofa::type::vector<core::BaseMapping*> MappingGraph::getBottomUpMappingsFrom(

current->accept(visitor);

for (auto& parent : current->m_parents)
for (auto& weakParent : current->m_parents)
{
if (parent->m_pendingCount == 0)
if (const auto parent = weakParent.lock())
{
nodes.push(parent.get());
if (parent->m_pendingCount == 0)
{
nodes.push(parent.get());
}
}
}
}
Expand Down Expand Up @@ -402,7 +408,7 @@ BaseMappingGraphNode* MappingGraph::findStateNode(core::behavior::BaseMechanical
void MappingGraph::addEdge(BaseMappingGraphNode* from, BaseMappingGraphNode* to)
{
from->m_children.push_back(to->shared_from_this());
to->m_parents.push_back(from->shared_from_this());
to->m_parents.push_back(from->weak_from_this());
}

} // namespace sofa::simulation
5 changes: 3 additions & 2 deletions Sofa/framework/Simulation/Core/src/sofa/simulation/mappinggraph/BaseMappingGraphNode.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,10 @@ bool BaseMappingGraphNode::isMapped() const
return m_isMapped.value();
}

const auto isMapped = std::any_of(m_parents.begin(), m_parents.end(), [](const SPtr& node)
const auto isMapped = std::any_of(m_parents.begin(), m_parents.end(), [](const std::weak_ptr<BaseMappingGraphNode>& weakNode)
{
return node->getType() == NodeType::Mapping || node->isMapped();
const auto node = weakNode.lock();
return node && (node->getType() == NodeType::Mapping || node->isMapped());
});

m_isMapped = isMapped;
Expand Down
8 changes: 6 additions & 2 deletions Sofa/framework/Simulation/Core/src/sofa/simulation/mappinggraph/BaseMappingGraphNode.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,11 +70,15 @@ class SOFA_SIMULATION_CORE_API BaseMappingGraphNode : public std::enable_shared_
*/
bool isMapped() const;

const sofa::type::vector<SPtr>& getParents() const { return m_parents; }
const sofa::type::vector<std::weak_ptr<BaseMappingGraphNode>>& getParents() const { return m_parents; }
const sofa::type::vector<SPtr>& getChildren() const { return m_children; }

private:
sofa::type::vector<SPtr> m_parents; ///< prerequisite nodes (nodes pointing to this one)
/// Prerequisite nodes (nodes pointing to this one). Held as weak_ptr: ownership of every
/// node belongs to MappingGraph::m_allNodes and to the owning parent's m_children; a strong
/// back-reference here would form a parent<->child reference cycle that keeps the whole
/// graph alive forever across rebuilds (MappingGraph::clear() only releases m_allNodes).
sofa::type::vector<std::weak_ptr<BaseMappingGraphNode>> m_parents;
sofa::type::vector<SPtr> m_children; ///< dependent nodes (nodes pointed from this one)

// Mutable counter used during traversal (reset before each traversal).
Expand Down
Loading