refactor: 21915 Introduce StateLifecycleManager

hedera-node/hedera-app/src/main/java/com/hedera/node/app/HederaVirtualMapState.java

@@ -70,20 +70,6 @@ protected HederaVirtualMapState copyingConstructor() {
         return new HederaVirtualMapState(this);
     }
 
-    /**
-     * Creates a new instance of {@link HederaVirtualMapState} with the specified {@link VirtualMap}.
-     *
-     * @param virtualMap the virtual map whose metrics must already be registered
-     * @param metrics    the platform metric instance to use when creating the new instance of state
-     * @param time       the time instance to use when creating the new instance of state
-     * @return a new instance of {@link HederaVirtualMapState}
-     */
-    @Override
-    protected HederaVirtualMapState newInstance(
-            @NonNull final VirtualMap virtualMap, @NonNull final Metrics metrics, @NonNull final Time time) {
-        return new HederaVirtualMapState(virtualMap, metrics, time);
-    }
-
     /**
      * {@inheritDoc}
      */

hedera-node/hedera-app/src/test/java/com/hedera/node/app/state/merkle/SerializationTest.java

@@ -11,18 +11,22 @@
 import com.hedera.node.app.spi.fixtures.TestSchema;
 import com.hedera.node.app.spi.migrate.StartupNetworks;
 import com.hedera.node.config.data.HederaConfig;
+import com.swirlds.base.test.fixtures.time.FakeTime;
 import com.swirlds.common.io.utility.LegacyTemporaryFileBuilder;
 import com.swirlds.common.merkle.utility.MerkleTreeSnapshotReader;
+import com.swirlds.common.metrics.noop.NoOpMetrics;
 import com.swirlds.config.api.Configuration;
 import com.swirlds.config.extensions.sources.SimpleConfigSource;
 import com.swirlds.config.extensions.test.fixtures.TestConfigBuilder;
 import com.swirlds.platform.state.signed.SignedState;
 import com.swirlds.platform.test.fixtures.state.RandomSignedStateGenerator;
 import com.swirlds.state.MerkleNodeState;
 import com.swirlds.state.State;
+import com.swirlds.state.StateLifecycleManager;
 import com.swirlds.state.lifecycle.MigrationContext;
 import com.swirlds.state.lifecycle.Schema;
 import com.swirlds.state.lifecycle.StateDefinition;
+import com.swirlds.state.merkle.StateLifecycleManagerImpl;
 import com.swirlds.state.merkle.disk.OnDiskReadableKVState;
 import com.swirlds.state.merkle.disk.OnDiskWritableKVState;
 import com.swirlds.state.spi.ReadableKVState;
@@ -157,11 +161,12 @@ private void forceFlush(ReadableKVState<?, ?> state) {
     @ParameterizedTest
     @ValueSource(booleans = {true, false})
     void simpleReadAndWrite(boolean forceFlush) throws IOException, ConstructableRegistryException {
-        final var schemaV1 = createV1Schema();
-        final var originalTree = createMerkleHederaState(schemaV1);
+        final Schema schemaV1 = createV1Schema();
+        final StateLifecycleManager stateLifecycleManager = createStateLifecycleManager(schemaV1);
+        final MerkleNodeState originalTree = stateLifecycleManager.getMutableState();
 
         // When we serialize it to bytes and deserialize it back into a tree
-        MerkleNodeState copy = originalTree.copy(); // make a copy to make VM flushable
+        MerkleNodeState copy = stateLifecycleManager.copyMutableState(); // make a copy to make VM flushable
         final byte[] serializedBytes;
         if (forceFlush) {
             // Force flush the VMs to disk to test serialization and deserialization
@@ -188,21 +193,23 @@ void simpleReadAndWrite(boolean forceFlush) throws IOException, ConstructableReg
 
     @Test
     void snapshot() throws IOException {
-        final var schemaV1 = createV1Schema();
-        final var originalTree = createMerkleHederaState(schemaV1);
-        final var tempDir = LegacyTemporaryFileBuilder.buildTemporaryDirectory(config);
+        final Schema<SemanticVersion> schemaV1 = createV1Schema();
+        final StateLifecycleManager stateLifecycleManager = createStateLifecycleManager(schemaV1);
+        final Path tempDir = LegacyTemporaryFileBuilder.buildTemporaryDirectory(config);
+        final MerkleNodeState originalTree = stateLifecycleManager.getLatestImmutableState();
 
         // prepare the tree and create a snapshot
-        originalTree.copy().release();
+        stateLifecycleManager.getMutableState().release();
         originalTree.computeHash();
-        originalTree.createSnapshot(tempDir);
+        stateLifecycleManager.setSnapshotSource(() -> originalTree);
+        stateLifecycleManager.createSnapshot(tempDir);
+        originalTree.release();
 
         final MerkleNodeState state =
-                originalTree.loadSnapshot(tempDir.resolve(MerkleTreeSnapshotReader.SIGNED_STATE_FILE_NAME));
+                stateLifecycleManager.loadSnapshot(tempDir.resolve(MerkleTreeSnapshotReader.SIGNED_STATE_FILE_NAME));
         initServices(schemaV1, state);
         assertTree(state);
 
-        originalTree.release();
         state.release();
     }
 
@@ -213,13 +220,16 @@ void snapshot() throws IOException {
      */
     @Test
     void dualReadAndWrite() throws IOException, ConstructableRegistryException {
-        final var schemaV1 = createV1Schema();
-        final var originalTree = createMerkleHederaState(schemaV1);
+        final Schema<SemanticVersion> schemaV1 = createV1Schema();
+        final StateLifecycleManager stateLifecycleManager = createStateLifecycleManager(schemaV1);
+        final MerkleNodeState originalTree = stateLifecycleManager.getMutableState();
 
-        MerkleNodeState copy = originalTree.copy(); // make a copy to make VM flushable
+        MerkleNodeState copy = stateLifecycleManager.copyMutableState(); // make a copy to make VM flushable
 
         forceFlush(originalTree.getReadableStates(FIRST_SERVICE).get(FRUIT_STATE_ID));
-        copy.copy().release(); // make a fast copy because we can only write to disk an immutable copy
+        stateLifecycleManager
+                .copyMutableState()
+                .release(); // make a fast copy because we can only write to disk an immutable copy
         copy.getRoot().getHash();
         final byte[] serializedBytes = writeTree(copy.getRoot(), dir);
 
@@ -275,7 +285,7 @@ private void initServices(Schema<SemanticVersion> schemaV1, MerkleNodeState load
         loadedTree.getRoot().migrate(MINIMUM_SUPPORTED_VERSION);
     }
 
-    private MerkleNodeState createMerkleHederaState(Schema schemaV1) {
+    private StateLifecycleManager createStateLifecycleManager(Schema schemaV1) {
         final SignedState randomState =
                 new RandomSignedStateGenerator().setRound(1).build();
 
@@ -295,7 +305,12 @@ private MerkleNodeState createMerkleHederaState(Schema schemaV1) {
                 migrationStateChanges,
                 startupNetworks,
                 TEST_PLATFORM_STATE_FACADE);
-        return originalTreeCopy;
+
+        final StateLifecycleManager<SignedState> stateLifecycleManager =
+                new StateLifecycleManagerImpl<>(new NoOpMetrics(), new FakeTime(), TestVirtualMapState::new);
+
+        stateLifecycleManager.initState(originalTreeCopy, true);
+        return stateLifecycleManager;
     }
 
     private static void populateVmCache(State loadedTree) {

hedera-node/hedera-app/src/testFixtures/java/com/hedera/node/app/fixtures/state/FakeState.java

@@ -33,7 +33,6 @@
 import com.swirlds.state.test.fixtures.MapWritableStates;
 import com.swirlds.state.test.fixtures.merkle.TestVirtualMapState;
 import edu.umd.cs.findbugs.annotations.NonNull;
-import java.nio.file.Path;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Map;
@@ -303,9 +302,4 @@ public long queueElementPath(final int stateId, @NonNull final Bytes expectedVal
     public void initializeState(@NonNull final StateMetadata<?, ?> md) {
         // do nothing
     }
-
-    @Override
-    public MerkleNodeState loadSnapshot(@NonNull final Path targetPath) {
-        throw new UnsupportedOperationException();
-    }
 }

hedera-state-validator/src/main/java/com/hedera/statevalidation/blockstream/BlockStreamRecoveryWorkflow.java

@@ -8,6 +8,7 @@
 import com.hedera.hapi.block.stream.Block;
 import com.hedera.hapi.block.stream.BlockItem;
 import com.hedera.hapi.block.stream.output.StateChanges;
+import com.hedera.node.app.HederaVirtualMapState;
 import com.hedera.node.app.hapi.utils.blocks.BlockStreamAccess;
 import com.hedera.node.app.hapi.utils.blocks.BlockStreamUtils;
 import com.hedera.statevalidation.util.PlatformContextHelper;
@@ -18,6 +19,8 @@
 import com.swirlds.platform.state.snapshot.DeserializedSignedState;
 import com.swirlds.platform.state.snapshot.SignedStateFileWriter;
 import com.swirlds.state.MerkleNodeState;
+import com.swirlds.state.StateLifecycleManager;
+import com.swirlds.state.merkle.StateLifecycleManagerImpl;
 import com.swirlds.state.spi.CommittableWritableStates;
 import edu.umd.cs.findbugs.annotations.NonNull;
 import java.io.IOException;
@@ -149,9 +152,14 @@ public void applyBlocks(
                 false,
                 DEFAULT_PLATFORM_STATE_FACADE);
 
+        final StateLifecycleManager<SignedState> stateLifecycleManager = new StateLifecycleManagerImpl<>(
+                platformContext.getMetrics(),
+                platformContext.getTime(),
+                vm -> new HederaVirtualMapState(vm, platformContext.getMetrics(), platformContext.getTime()));
+        stateLifecycleManager.setSnapshotSource(signedState);
         try {
             SignedStateFileWriter.writeSignedStateFilesToDirectory(
-                    platformContext, selfId, outputPath, signedState, DEFAULT_PLATFORM_STATE_FACADE);
+                    platformContext, selfId, outputPath, DEFAULT_PLATFORM_STATE_FACADE, stateLifecycleManager);
         } catch (IOException e) {
             throw new RuntimeException(e);
         }

platform-sdk/consensus-otter-tests/src/testFixtures/java/org/hiero/otter/fixtures/app/OtterAppState.java

@@ -82,12 +82,6 @@ protected OtterAppState copyingConstructor() {
         return new OtterAppState(this);
     }
 
-    @Override
-    protected OtterAppState newInstance(
-            @NonNull final VirtualMap virtualMap, @NonNull final Metrics metrics, @NonNull final Time time) {
-        return new OtterAppState(virtualMap, metrics, time);
-    }
-
     /**
      * {@inheritDoc}
      */

platform-sdk/platform-apps/tests/ConsistencyTestingTool/src/main/java/com/swirlds/demo/consistency/ConsistencyTestingToolState.java

@@ -119,12 +119,6 @@ protected ConsistencyTestingToolState copyingConstructor() {
         return new ConsistencyTestingToolState(this);
     }
 
-    @Override
-    protected ConsistencyTestingToolState newInstance(
-            @NonNull final VirtualMap virtualMap, @NonNull final Metrics metrics, @NonNull final Time time) {
-        return new ConsistencyTestingToolState(virtualMap, metrics, time);
-    }
-
     /**
      * Initialize the state
      */

platform-sdk/platform-apps/tests/ISSTestingTool/src/main/java/com/swirlds/demo/iss/ISSTestingToolState.java

@@ -98,12 +98,6 @@ protected ISSTestingToolState copyingConstructor() {
         return new ISSTestingToolState(this);
     }
 
-    @Override
-    protected ISSTestingToolState newInstance(
-            @NonNull final VirtualMap virtualMap, @NonNull final Metrics metrics, @NonNull final Time time) {
-        return new ISSTestingToolState(virtualMap, metrics, time);
-    }
-
     public void initState(InitTrigger trigger, Platform platform) {
         throwIfImmutable();
 

platform-sdk/platform-apps/tests/MigrationTestingTool/src/main/java/com/swirlds/demo/migration/MigrationTestingToolState.java

@@ -32,12 +32,6 @@ protected MigrationTestingToolState copyingConstructor() {
         return new MigrationTestingToolState(this);
     }
 
-    @Override
-    protected MigrationTestingToolState newInstance(
-            @NonNull final VirtualMap virtualMap, @NonNull final Metrics metrics, @NonNull final Time time) {
-        return new MigrationTestingToolState(virtualMap, metrics, time);
-    }
-
     /**
      * {@inheritDoc}
      */

platform-sdk/swirlds-platform-core/src/main/java/com/swirlds/platform/SwirldsPlatform.java

@@ -38,7 +38,6 @@
 import com.swirlds.platform.publisher.PlatformPublisher;
 import com.swirlds.platform.reconnect.DefaultSignedStateValidator;
 import com.swirlds.platform.reconnect.ReconnectController;
-import com.swirlds.platform.state.SwirldStateManager;
 import com.swirlds.platform.state.nexus.DefaultLatestCompleteStateNexus;
 import com.swirlds.platform.state.nexus.LatestCompleteStateNexus;
 import com.swirlds.platform.state.nexus.LockFreeStateNexus;
@@ -59,6 +58,7 @@
 import com.swirlds.platform.wiring.PlatformComponents;
 import com.swirlds.platform.wiring.PlatformCoordinator;
 import com.swirlds.state.State;
+import com.swirlds.state.StateLifecycleManager;
 import edu.umd.cs.findbugs.annotations.NonNull;
 import java.time.Duration;
 import java.util.List;
@@ -138,6 +138,11 @@
      */
     private final SavedStateController savedStateController;
 
+    /**
+     * Manages the lifecycle of the state.
+     */
+    private final StateLifecycleManager<SignedState> stateLifecycleManager;
+
     /**
      * Encapsulated wiring for the platform.
      */
@@ -185,7 +190,8 @@
 
         final LatestCompleteStateNexus latestCompleteStateNexus = new DefaultLatestCompleteStateNexus(platformContext);
 
-        savedStateController = new DefaultSavedStateController(platformContext);
+        savedStateController = new DefaultSavedStateController(platformContext, blocks.stateLifecycleManager());
+        stateLifecycleManager = blocks.stateLifecycleManager();
 
         final SignedStateMetrics signedStateMetrics = new SignedStateMetrics(platformContext.getMetrics());
         final StateSignatureCollector stateSignatureCollector =
@@ -211,15 +217,15 @@
         initializeState(this, platformContext, initialState, blocks.consensusStateEventHandler(), platformStateFacade);
 
         // This object makes a copy of the state. After this point, initialState becomes immutable.
-        final SwirldStateManager swirldStateManager = blocks.swirldStateManager();
-        swirldStateManager.setState(initialState.getState(), true);
-        platformStateFacade.setCreationSoftwareVersionTo(swirldStateManager.getConsensusState(), blocks.appVersion());
+        final StateLifecycleManager stateLifecycleManager = blocks.stateLifecycleManager();
+        stateLifecycleManager.initState(initialState.getState(), true);
+        platformStateFacade.setCreationSoftwareVersionTo(stateLifecycleManager.getMutableState(), blocks.appVersion());
 
         final EventWindowManager eventWindowManager = new DefaultEventWindowManager();
 
         blocks.freezeCheckHolder()
                 .setFreezeCheckRef(instant ->
-                        platformStateFacade.isInFreezePeriod(instant, swirldStateManager.getConsensusState()));
+                        platformStateFacade.isInFreezePeriod(instant, stateLifecycleManager.getMutableState()));
 
         final AppNotifier appNotifier = new DefaultAppNotifier(blocks.notificationEngine());
 
@@ -231,7 +237,7 @@
                 this,
                 platformContext,
                 platformCoordinator,
-                swirldStateManager,
+                stateLifecycleManager,
                 savedStateController,
                 blocks.consensusStateEventHandler(),
                 blocks.reservedSignedStateResultPromise(),
@@ -382,6 +388,7 @@
             } else {
                 final SignedState signedState = reservedState.get();
                 signedState.markAsStateToSave(StateToDiskReason.PCES_RECOVERY_COMPLETE);
+                stateLifecycleManager.setSnapshotSource(signedState);
 
                 final StateDumpRequest request =
                         StateDumpRequest.create(signedState.reserve("dumping PCES recovery state"));

platform-sdk/swirlds-platform-core/src/main/java/com/swirlds/platform/builder/PlatformBuilder.java

@@ -34,14 +34,15 @@
 import com.swirlds.platform.reconnect.FallenBehindMonitor;
 import com.swirlds.platform.scratchpad.Scratchpad;
 import com.swirlds.platform.state.ConsensusStateEventHandler;
-import com.swirlds.platform.state.SwirldStateManager;
 import com.swirlds.platform.state.iss.IssScratchpad;
 import com.swirlds.platform.state.service.PlatformStateFacade;
 import com.swirlds.platform.state.signed.ReservedSignedState;
 import com.swirlds.platform.system.Platform;
 import com.swirlds.platform.wiring.PlatformComponents;
 import com.swirlds.platform.wiring.PlatformWiring;
 import com.swirlds.state.MerkleNodeState;
+import com.swirlds.state.StateLifecycleManager;
+import com.swirlds.state.merkle.StateLifecycleManagerImpl;
 import com.swirlds.virtualmap.VirtualMap;
 import edu.umd.cs.findbugs.annotations.NonNull;
 import java.io.IOException;
@@ -433,7 +434,8 @@
         final ApplicationCallbacks callbacks =
                 new ApplicationCallbacks(preconsensusEventConsumer, snapshotOverrideConsumer, staleEventConsumer);
 
-        final SwirldStateManager swirldStateManager = new SwirldStateManager(platformContext, currentRoster);
+        final StateLifecycleManager stateLifecycleManager = new StateLifecycleManagerImpl(
+                platformContext.getMetrics(), platformContext.getTime(), createStateFromVirtualMap);
 
         if (model == null) {
             final WiringConfig wiringConfig = platformContext.getConfiguration().getConfigData(WiringConfig.class);
@@ -495,7 +497,7 @@
                 issScratchpad,
                 NotificationEngine.buildEngine(getStaticThreadManager()),
                 new AtomicReference<>(),
-                swirldStateManager,
+                stateLifecycleManager,
                 new AtomicReference<>(),
                 firstPlatform,
                 consensusStateEventHandler,

platform-sdk/swirlds-platform-core/src/main/java/com/swirlds/platform/builder/PlatformBuildingBlocks.java

@@ -15,13 +15,14 @@
 import com.swirlds.platform.reconnect.FallenBehindMonitor;
 import com.swirlds.platform.scratchpad.Scratchpad;
 import com.swirlds.platform.state.ConsensusStateEventHandler;
-import com.swirlds.platform.state.SwirldStateManager;
 import com.swirlds.platform.state.iss.IssScratchpad;
 import com.swirlds.platform.state.service.PlatformStateFacade;
 import com.swirlds.platform.state.signed.ReservedSignedState;
+import com.swirlds.platform.state.signed.SignedState;
 import com.swirlds.platform.system.status.StatusActionSubmitter;
 import com.swirlds.platform.wiring.PlatformComponents;
 import com.swirlds.state.MerkleNodeState;
+import com.swirlds.state.StateLifecycleManager;
 import com.swirlds.virtualmap.VirtualMap;
 import edu.umd.cs.findbugs.annotations.NonNull;
 import edu.umd.cs.findbugs.annotations.Nullable;
@@ -72,7 +73,7 @@
  * @param notificationEngine                     for sending notifications to the application (legacy pattern)
  * @param statusActionSubmitterReference         a reference to the status action submitter, this can be deleted once
  *                                               platform status management is handled by the wiring framework
- * @param swirldStateManager                     responsible for the mutable state, this is exposed here due to
+ * @param stateLifecycleManager                  responsible for the mutable state, this is exposed here due to
  *                                               reconnect
  * @param getLatestCompleteStateReference        a reference to a supplier that supplies the latest immutable state,
  *                                               this is exposed here due to reconnect, can be removed once reconnect is
@@ -110,7 +111,7 @@
         @NonNull Scratchpad<IssScratchpad> issScratchpad,
         @NonNull NotificationEngine notificationEngine,
         @NonNull AtomicReference<StatusActionSubmitter> statusActionSubmitterReference,
-        @NonNull SwirldStateManager swirldStateManager,
+        @NonNull StateLifecycleManager<SignedState> stateLifecycleManager,
         @NonNull AtomicReference<Supplier<ReservedSignedState>> getLatestCompleteStateReference,
         boolean firstPlatform,
         @NonNull ConsensusStateEventHandler consensusStateEventHandler,
@@ -140,7 +141,7 @@
         requireNonNull(issScratchpad);
         requireNonNull(notificationEngine);
         requireNonNull(statusActionSubmitterReference);
-        requireNonNull(swirldStateManager);
+        requireNonNull(stateLifecycleManager);
         requireNonNull(getLatestCompleteStateReference);
         requireNonNull(consensusStateEventHandler);
         requireNonNull(platformStateFacade);