chore: replacing minGenNonAncient data flow with NonAncientEventWindow

platform-sdk/platform-apps/tests/ConsistencyTestingTool/src/test/java/com/swirlds/demo/consistency/ConsistencyTestingToolRoundTests.java

@@ -24,6 +24,7 @@
 
 import com.swirlds.platform.consensus.ConsensusSnapshot;
 import com.swirlds.platform.consensus.GraphGenerations;
+import com.swirlds.platform.consensus.NonAncientEventWindow;
 import com.swirlds.platform.event.GossipEvent;
 import com.swirlds.platform.internal.ConsensusRound;
 import com.swirlds.platform.internal.EventImpl;
@@ -82,7 +83,12 @@ private static Round buildMockRound(final List<List<Long>> eventContents, final
         Mockito.when(mockSnapshot.round()).thenReturn(roundReceived);
 
         return new ConsensusRound(
-                mock(AddressBook.class), mockEvents, mock(EventImpl.class), mock(GraphGenerations.class), mockSnapshot);
+                mock(AddressBook.class),
+                mockEvents,
+                mock(EventImpl.class),
+                mock(GraphGenerations.class),
+                mock(NonAncientEventWindow.class),
+                mockSnapshot);
     }
 
     @Test

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

@@ -32,6 +32,7 @@
 import com.swirlds.platform.consensus.ConsensusUtils;
 import com.swirlds.platform.consensus.CountingVote;
 import com.swirlds.platform.consensus.InitJudges;
+import com.swirlds.platform.consensus.NonAncientEventWindow;
 import com.swirlds.platform.consensus.RoundElections;
 import com.swirlds.platform.consensus.SequentialRingBuffer;
 import com.swirlds.platform.consensus.ThreadSafeConsensusInfo;
@@ -693,6 +694,8 @@
                 consensusEvents,
                 recentEvents.get(recentEvents.size() - 1),
                 new Generations(this),
+                NonAncientEventWindow.createUsingRoundsNonAncient(
+                        decidedRoundNumber, getMinGenerationNonAncient(), config.roundsNonAncient()),
                 new ConsensusSnapshot(
                         decidedRoundNumber,
                         ConsensusUtils.getHashes(judges),

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

@@ -74,6 +74,7 @@
 import com.swirlds.platform.components.transaction.system.PreconsensusSystemTransactionManager;
 import com.swirlds.platform.config.ThreadConfig;
 import com.swirlds.platform.consensus.ConsensusConfig;
+import com.swirlds.platform.consensus.NonAncientEventWindow;
 import com.swirlds.platform.crypto.CryptoStatic;
 import com.swirlds.platform.crypto.KeysAndCerts;
 import com.swirlds.platform.crypto.PlatformSigner;
@@ -908,7 +909,13 @@
             if (eventConfig.useLegacyIntake()) {
                 eventLinker.loadFromSignedState(initialState);
             } else {
-                platformWiring.updateMinimumGenerationNonAncient(initialMinimumGenerationNonAncient);
+                platformWiring.updateNonAncientEventWindow(NonAncientEventWindow.createUsingRoundsNonAncient(
+                        initialState.getRound(),
+                        initialMinimumGenerationNonAncient,
+                        platformContext
+                                .getConfiguration()
+                                .getConfigData(ConsensusConfig.class)
+                                .roundsNonAncient()));
             }
 
             // We don't want to invoke these callbacks until after we are starting up.
@@ -1059,8 +1066,13 @@
         }
 
         try {
-            eventCreator.setMinimumGenerationNonAncient(
-                    signedState.getState().getPlatformState().getPlatformData().getMinimumGenerationNonAncient());
+            eventCreator.setNonAncientEventWindow(NonAncientEventWindow.createUsingRoundsNonAncient(
+                    signedState.getRound(),
+                    signedState.getMinRoundGeneration(),
+                    platformContext
+                            .getConfiguration()
+                            .getConfigData(ConsensusConfig.class)
+                            .roundsNonAncient()));
 
             // newer states will not have events, so we need to check for null
             if (signedState.getState().getPlatformState().getPlatformData().getEvents() == null) {
@@ -1197,7 +1209,13 @@
                             .inject(new AddressBookUpdate(
                                     signedState.getState().getPlatformState().getPreviousAddressBook(),
                                     signedState.getState().getPlatformState().getAddressBook()));
-                    platformWiring.updateMinimumGenerationNonAncient(signedState.getMinRoundGeneration());
+                    platformWiring.updateNonAncientEventWindow(NonAncientEventWindow.createUsingRoundsNonAncient(
+                            signedState.getRound(),
+                            signedState.getMinRoundGeneration(),
+                            platformContext
+                                    .getConfiguration()
+                                    .getConfigData(ConsensusConfig.class)
+                                    .roundsNonAncient()));
                 }
             } finally {
                 intakeQueue.resume();

platform-sdk/swirlds-platform-core/src/main/java/com/swirlds/platform/components/EventIntake.java

@@ -25,6 +25,8 @@
 import com.swirlds.common.platform.NodeId;
 import com.swirlds.common.threading.manager.ThreadManager;
 import com.swirlds.platform.Consensus;
+import com.swirlds.platform.consensus.ConsensusConfig;
+import com.swirlds.platform.consensus.NonAncientEventWindow;
 import com.swirlds.platform.event.GossipEvent;
 import com.swirlds.platform.event.linking.EventLinker;
 import com.swirlds.platform.event.validation.StaticValidators;
@@ -79,6 +81,7 @@
 
     private final EventIntakeMetrics metrics;
     private final Time time;
+    private final Long roundsNonAncient;
 
     /**
      * Measures the time spent in each phase of event intake
@@ -137,6 +140,10 @@
         this.intakeEventCounter = Objects.requireNonNull(intakeEventCounter);
 
         final EventConfig eventConfig = platformContext.getConfiguration().getConfigData(EventConfig.class);
+        this.roundsNonAncient = (long) platformContext
+                .getConfiguration()
+                .getConfigData(ConsensusConfig.class)
+                .roundsNonAncient();
 
         final BlockingQueue<Runnable> prehandlePoolQueue = new LinkedBlockingQueue<>();
         prehandlePool = new ThreadPoolExecutor(
@@ -214,7 +221,10 @@
                 phaseTimer.activatePhase(EventIntakePhase.HANDLING_STALE_EVENTS);
                 handleStale(minGenNonAncientBeforeAdding);
                 if (latestEventTipsetTracker != null) {
-                    latestEventTipsetTracker.setMinimumGenerationNonAncient(minimumGenerationNonAncient);
+                    // FUTURE WORK: When this class is refactored, it should not be constructing the
+                    // NonAncientEventWindow, but receiving it through the PlatformWiring instead.
+                    latestEventTipsetTracker.setNonAncientEventWindow(NonAncientEventWindow.createUsingRoundsNonAncient(
+                            consensus().getLastRoundDecided(), minimumGenerationNonAncient, roundsNonAncient));
                 }
             }
         } finally {

platform-sdk/swirlds-platform-core/src/main/java/com/swirlds/platform/components/LinkedEventIntake.java

@@ -19,6 +19,8 @@
 import com.swirlds.base.time.Time;
 import com.swirlds.common.context.PlatformContext;
 import com.swirlds.platform.Consensus;
+import com.swirlds.platform.consensus.ConsensusConfig;
+import com.swirlds.platform.consensus.NonAncientEventWindow;
 import com.swirlds.platform.eventhandling.ConsensusRoundHandler;
 import com.swirlds.platform.gossip.IntakeEventCounter;
 import com.swirlds.platform.gossip.shadowgraph.LatestEventTipsetTracker;
@@ -61,6 +63,7 @@
 
     private final EventIntakeMetrics metrics;
     private final Time time;
+    private final Long roundsNonAncient;
 
     /**
      * Tracks the number of events from each peer have been received, but aren't yet through the intake pipeline
@@ -104,6 +107,10 @@
 
         this.paused = false;
         metrics = new EventIntakeMetrics(platformContext, () -> -1);
+        this.roundsNonAncient = (long) platformContext
+                .getConfiguration()
+                .getConfigData(ConsensusConfig.class)
+                .roundsNonAncient();
     }
 
     /**
@@ -150,7 +157,12 @@
                 // with no consensus events, so we check the diff in generations to look for stale events
                 handleStale(minimumGenerationNonAncientBeforeAdding);
                 if (latestEventTipsetTracker != null) {
-                    latestEventTipsetTracker.setMinimumGenerationNonAncient(minimumGenerationNonAncient);
+                    // FUTURE WORK: When this class is refactored, it should not be constructing the
+                    // NonAncientEventWindow, but receiving it through the PlatformWiring instead.
+                    latestEventTipsetTracker.setNonAncientEventWindow(NonAncientEventWindow.createUsingRoundsNonAncient(
+                            consensusSupplier.get().getLastRoundDecided(),
+                            minimumGenerationNonAncient,
+                            roundsNonAncient));
                 }
             }
 

platform-sdk/swirlds-platform-core/src/main/java/com/swirlds/platform/consensus/NonAncientEventWindow.java

@@ -0,0 +1,139 @@
+/*
+ * Copyright (C) 2023 Hedera Hashgraph, LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.swirlds.platform.consensus;
+
+import com.swirlds.base.utility.ToStringBuilder;
+import com.swirlds.platform.event.GossipEvent;
+import com.swirlds.platform.system.events.EventConstants;
+import com.swirlds.platform.system.events.EventDescriptor;
+import edu.umd.cs.findbugs.annotations.NonNull;
+
+/**
+ * Determines the non-ancient lower bound (inclusive) on events and communicates the window of rounds between the
+ * pendingConsensusRound and the minimumRoundNonAncient (inclusive).
+ */
+public class NonAncientEventWindow {
+
+    /**
+     * The initial NonAncientEventWindow. This constant is used to initialize NonAncientEventWindow variables before
+     * receiving an updated value.
+     */
+    public static NonAncientEventWindow INITIAL_EVENT_WINDOW = new NonAncientEventWindow(
+            ConsensusConstants.ROUND_FIRST, ConsensusConstants.ROUND_FIRST, EventConstants.FIRST_GENERATION);
+
+    private final long latestConsensusRound;
+    private final long minRoundNonAncient;
+    private final long minGenNonAncient;
+
+    /**
+     * Create a new NonAncientEventWindow with the given bounds. The latestConsensusRound must be greater than or equal
+     * to the first round of consensus.  If the minimum round non-ancient is set to a number lower than the first round
+     * of consensus, the first round of consensus is used instead.  The minGenNonAncient value must be greater than or
+     * equal to the first generation for events.
+     *
+     * @param latestConsensusRound the latest round that has come to consensus
+     * @param minRoundNonAncient   the minimum round that is non-ancient
+     * @param minGenNonAncient     the minimum generation that is non-ancient
+     * @throws IllegalArgumentException if the latestConsensusRound is less than the first round of consensus or if the
+     *                                  minGenNonAncient value is less than the first generation for events.
+     */
+    public NonAncientEventWindow(long latestConsensusRound, long minRoundNonAncient, long minGenNonAncient) {
+        if (latestConsensusRound < ConsensusConstants.ROUND_FIRST) {
+            throw new IllegalArgumentException(
+                    "The latest consensus round cannot be less than the first round of consensus.");
+        }
+        if (minGenNonAncient < EventConstants.FIRST_GENERATION) {
+            throw new IllegalArgumentException(
+                    "the minimum generation non-ancient cannot be lower than the first generation for events.");
+        }
+        this.latestConsensusRound = latestConsensusRound;
+        this.minRoundNonAncient = Math.max(minRoundNonAncient, ConsensusConstants.ROUND_FIRST);
+        this.minGenNonAncient = minGenNonAncient;
+    }
+
+    /**
+     * @return the pending round coming to consensus, i.e. 1  + the latestConsensusRound
+     */
+    public long pendingConsensusRound() {
+        return latestConsensusRound + 1;
+    }
+
+    /**
+     * @return the lower bound of the non-ancient event window
+     */
+    public long getLowerBound() {
+        // FUTURE WORK: return minRoundNonAncient once we switch from minGenNonAncient.
+        return minGenNonAncient;
+    }
+
+    /**
+     * Determines if the given event is ancient.
+     *
+     * @param event the event to check for being ancient.
+     * @return true if the event is ancient, false otherwise.
+     */
+    public boolean isAncient(@NonNull final GossipEvent event) {
+        // FUTURE WORK: use generation until we throw the switch to using round
+        return event.getGeneration() < minGenNonAncient;
+    }
+
+    /**
+     * Determines if the given event is ancient.
+     *
+     * @param event the event to check for being ancient.
+     * @return true if the event is ancient, false otherwise.
+     */
+    public boolean isAncient(EventDescriptor event) {
+        // FUTURE WORK: use generation until we throw the switch to using round
+        return event.getGeneration() < minGenNonAncient;
+    }
+
+    /**
+     * Determines if the given long value is ancient.
+     *
+     * @param testValue the value to check for being ancient.
+     * @return true if the value is ancient, false otherwise.
+     */
+    public boolean isAncient(long testValue) {
+        // FUTURE WORK: use generation until we throw the switch to using round
+        return testValue < minGenNonAncient;
+    }
+
+    /**
+     * Create a NonAncientEventWindow by calculating the minRoundNonAncient value from the latestConsensusRound and
+     * roundsNonAncient.
+     *
+     * @param latestConsensusRound the latest round that has come to consensus
+     * @param minGenNonAncient     the minimum generation that is non-ancient
+     * @param roundsNonAncient     the number of rounds that are non-ancient
+     * @return the new NonAncientEventWindow
+     */
+    public static NonAncientEventWindow createUsingRoundsNonAncient(
+            final long latestConsensusRound, final long minGenNonAncient, final long roundsNonAncient) {
+        return new NonAncientEventWindow(
+                latestConsensusRound, latestConsensusRound - roundsNonAncient + 1, minGenNonAncient);
+    }
+
+    @Override
+    public String toString() {
+        return new ToStringBuilder(this)
+                .append("latestConsensusRound", latestConsensusRound)
+                .append("minRoundNonAncient", minRoundNonAncient)
+                .append("minGenNonAncient", minGenNonAncient)
+                .toString();
+    }
+}

platform-sdk/swirlds-platform-core/src/main/java/com/swirlds/platform/event/creation/AsyncEventCreationManager.java

@@ -29,6 +29,7 @@
 import com.swirlds.common.threading.framework.config.QueueThreadMetricsConfiguration;
 import com.swirlds.common.threading.futures.StandardFuture;
 import com.swirlds.common.threading.manager.ThreadManager;
+import com.swirlds.platform.consensus.NonAncientEventWindow;
 import com.swirlds.platform.internal.EventImpl;
 import edu.umd.cs.findbugs.annotations.NonNull;
 import java.util.Objects;
@@ -60,9 +61,9 @@
     private final BlockingQueueInserter<EventImpl> eventInserter;
 
     /**
-     * The object used to enqueue updates to the minimum generation non-ancient onto the work queue.
+     * The object used to enqueue updates to the non-ancient event window onto the work queue.
      */
-    private final BlockingQueueInserter<Long> minimumGenerationNonAncientInserter;
+    private final BlockingQueueInserter<NonAncientEventWindow> nonAncientEventWindowInserter;
 
     /**
      * Used to signal a desired pause.
@@ -102,7 +103,7 @@
                 .setCapacity(eventCreationConfig.creationQueueSize())
                 .setMaxBufferSize(eventCreationConfig.creationQueueBufferSize())
                 .addHandler(EventImpl.class, this::handleEvent)
-                .addHandler(Long.class, this::handleMinimumGenerationNonAncient)
+                .addHandler(NonAncientEventWindow.class, this::handleNonAncientEventWindow)
                 .addHandler(PauseRequest.class, this::handlePauseStatusChange)
                 .setIdleCallback(eventCreator::maybeCreateEvent)
                 .setBatchHandledCallback(eventCreator::maybeCreateEvent)
@@ -113,7 +114,7 @@
                 .build();
 
         eventInserter = workQueue.getInserter(EventImpl.class);
-        minimumGenerationNonAncientInserter = workQueue.getInserter(Long.class);
+        nonAncientEventWindowInserter = workQueue.getInserter(NonAncientEventWindow.class);
         setPauseStatusInserter = workQueue.getInserter(PauseRequest.class);
     }
 
@@ -128,12 +129,13 @@
     }
 
     /**
-     * Update the minimum generation non-ancient
+     * Update the non-ancient event window
      *
-     * @param minimumGenerationNonAncient the new minimum generation non-ancient
+     * @param nonAncientEventWindow the new minimum generation non-ancient
      */
-    public void setMinimumGenerationNonAncient(final long minimumGenerationNonAncient) throws InterruptedException {
-        minimumGenerationNonAncientInserter.put(minimumGenerationNonAncient);
+    public void setNonAncientEventWindow(@NonNull final NonAncientEventWindow nonAncientEventWindow)
+            throws InterruptedException {
+        nonAncientEventWindowInserter.put(nonAncientEventWindow);
     }
 
     /**
@@ -146,12 +148,12 @@
     }
 
     /**
-     * Pass a new minimum generation non-ancient into the event creator.
+     * Pass a new non-ancient event window into the event creator.
      *
-     * @param minimumGenerationNonAncient the new minimum generation non-ancient
+     * @param nonAncientEventWindow the new non-ancient event window
      */
-    private void handleMinimumGenerationNonAncient(final long minimumGenerationNonAncient) {
-        eventCreator.setMinimumGenerationNonAncient(minimumGenerationNonAncient);
+    private void handleNonAncientEventWindow(@NonNull final NonAncientEventWindow nonAncientEventWindow) {
+        eventCreator.setNonAncientEventWindow(nonAncientEventWindow);
     }
 
     /**