mirror of
https://github.com/OPM/ResInsight.git
synced 2026-10-24 22:27:55 -05:00
Magne Sjaastad
8ac2255832
Closing all summary cases while a delta ensemble is present crashed with a use-after-free. RicCloseSummaryCaseFeature::deleteSummaryCases holds a case list across removeCases and deletes it afterwards, while removeCases made the delta ensemble rebuild and destroy derived cases that are themselves part of that list. The previous fix rewrote the caller list with the surviving cases, which stopped the crash but left the hazard in place for any other caller holding a case list across a removal. Add RimSummaryCaseUpdateBatch, a plain scope object that is ambient for the duration of its scope. Removal now only detaches, and hands the detached cases to the batch. The outermost scope flushes, regenerating the dirty delta ensembles in dependency order first so a chained delta ensemble sees the final state of its source, then destroying the orphans with caf::PdmObjectHandleTools::deleteObjects. A nested batch contributes to the outermost one and never flushes. Orphans are held as guarded pointers, so a case the caller destroyed itself is skipped instead of being destroyed twice. Both contribution points fall back to immediate execution when no batch is active, so call sites that do not open one keep behaving as before. Open a batch in RimSummaryCaseMainCollection::removeCases and in RicCloseSummaryCaseFeature::deleteSummaryCases, which is the outermost of the two and therefore keeps the detached cases alive across its own deleteObjects call. removeCases no longer rewrites the caller list, so it now takes it by const reference.
69 lines
2.9 KiB
C++
69 lines
2.9 KiB
C++
/////////////////////////////////////////////////////////////////////////////////
|
|
//
|
|
// Copyright (C) 2026- Equinor ASA
|
|
//
|
|
// ResInsight is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// ResInsight is distributed in the hope that it will be useful, but WITHOUT ANY
|
|
// WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
// FITNESS FOR A PARTICULAR PURPOSE.
|
|
//
|
|
// See the GNU General Public License at <http://www.gnu.org/licenses/gpl.html>
|
|
// for more details.
|
|
//
|
|
/////////////////////////////////////////////////////////////////////////////////
|
|
|
|
#pragma once
|
|
|
|
#include "cafPdmPointer.h"
|
|
|
|
#include <vector>
|
|
|
|
class RimDeltaSummaryCase;
|
|
class RimDeltaSummaryEnsemble;
|
|
|
|
//==================================================================================================
|
|
/// Collects the work that must happen once a set of summary case mutations has settled. Removing a
|
|
/// case only detaches it and hands it to the batch, destruction happens when the batch flushes.
|
|
///
|
|
/// This is a plain stack object, ambient for the duration of its scope. A nested batch contributes to
|
|
/// the outermost one, which is the only one that flushes. Open a batch wherever a case list is held
|
|
/// across a mutation, so no object in that list is freed while the list is still in use.
|
|
///
|
|
/// The contribution points fall back to immediate execution when no batch is active, so call sites
|
|
/// that do not open one keep behaving as before.
|
|
//==================================================================================================
|
|
class RimSummaryCaseUpdateBatch
|
|
{
|
|
public:
|
|
RimSummaryCaseUpdateBatch();
|
|
~RimSummaryCaseUpdateBatch();
|
|
|
|
RimSummaryCaseUpdateBatch( const RimSummaryCaseUpdateBatch& ) = delete;
|
|
RimSummaryCaseUpdateBatch& operator=( const RimSummaryCaseUpdateBatch& ) = delete;
|
|
|
|
// Hand over detached cases for destruction at the flush. Destroys them immediately if no batch is active.
|
|
static void orphan( const std::vector<RimDeltaSummaryCase*>& orphanedCases );
|
|
|
|
// Schedule a regeneration of the derived cases of a delta ensemble. Regenerates immediately if no batch is active.
|
|
static void markDeltaEnsembleDirty( RimDeltaSummaryEnsemble* deltaEnsemble );
|
|
|
|
static bool isActive();
|
|
|
|
private:
|
|
void flush();
|
|
|
|
// The dirty ensembles and everything depending on them, ordered so a delta ensemble is regenerated before the delta
|
|
// ensembles using it as a source
|
|
std::vector<RimDeltaSummaryEnsemble*> ensemblesToRegenerate() const;
|
|
|
|
private:
|
|
std::vector<caf::PdmPointer<RimDeltaSummaryCase>> m_orphanedCases;
|
|
std::vector<caf::PdmPointer<RimDeltaSummaryEnsemble>> m_dirtyEnsembles;
|
|
|
|
static RimSummaryCaseUpdateBatch* sm_current;
|
|
};
|