Push primary term to replication tracker (#38044)

This commit pushes the primary term into the replication tracker. This
is a precursor to using the primary term to resolving ordering problems
for retention leases. Namely, it can be that out-of-order retention
lease sync requests arrive on a replica. To resolve this, we need a
tuple of (primary term, version). For this to be, the primary term needs
to be accessible in the replication tracker. As the primary term is part
of the replication group anyway, this change conceptually makes sense.

Author: jasontedor

server/src/main/java/org/elasticsearch/index/seqno/ReplicationTracker.java

@@ -33,6 +33,7 @@
 import org.elasticsearch.common.io.stream.Writeable;
 import org.elasticsearch.index.IndexSettings;
 import org.elasticsearch.index.shard.AbstractIndexShardComponent;
+import org.elasticsearch.index.shard.IndexShard;
 import org.elasticsearch.index.shard.ReplicationGroup;
 import org.elasticsearch.index.shard.ShardId;
 
@@ -92,6 +93,12 @@ public class ReplicationTracker extends AbstractIndexShardComponent implements L
      */
     volatile boolean primaryMode;
 
+    /**
+     * The current operation primary term. Management of this value is done through {@link IndexShard} and must only be done when safe. See
+     * {@link #setOperationPrimaryTerm(long)}.
+     */
+    private volatile long operationPrimaryTerm;
+
     /**
      * Boolean flag that indicates if a relocation handoff is in progress. A handoff is started by calling {@link #startRelocationHandoff}
      * and is finished by either calling {@link #completeRelocationHandoff} or {@link #abortRelocationHandoff}, depending on whether the
@@ -408,6 +415,25 @@ public boolean isPrimaryMode() {
         return primaryMode;
     }
 
+    /**
+     * Returns the current operation primary term.
+     *
+     * @return the primary term
+     */
+    public long getOperationPrimaryTerm() {
+        return operationPrimaryTerm;
+    }
+
+    /**
+     * Sets the current operation primary term. This method should be invoked only when no other operations are possible on the shard. That
+     * is, either from the constructor of {@link IndexShard} or while holding all permits on the {@link IndexShard} instance.
+     *
+     * @param operationPrimaryTerm the new operation primary term
+     */
+    public void setOperationPrimaryTerm(final long operationPrimaryTerm) {
+        this.operationPrimaryTerm = operationPrimaryTerm;
+    }
+
     /**
      * Returns whether the replication tracker has relocated away to another shard copy.
      */
@@ -527,13 +553,15 @@ private static long inSyncCheckpointStates(
      * @param shardId               the shard ID
      * @param allocationId          the allocation ID
      * @param indexSettings         the index settings
+     * @param operationPrimaryTerm  the current primary term
      * @param globalCheckpoint      the last known global checkpoint for this shard, or {@link SequenceNumbers#UNASSIGNED_SEQ_NO}
      * @param onSyncRetentionLeases a callback when a new retention lease is created or an existing retention lease expires
      */
     public ReplicationTracker(
             final ShardId shardId,
             final String allocationId,
             final IndexSettings indexSettings,
+            final long operationPrimaryTerm,
             final long globalCheckpoint,
             final LongConsumer onGlobalCheckpointUpdated,
             final LongSupplier currentTimeMillisSupplier,
@@ -542,6 +570,7 @@ public ReplicationTracker(
         assert globalCheckpoint >= SequenceNumbers.UNASSIGNED_SEQ_NO : "illegal initial global checkpoint: " + globalCheckpoint;
         this.shardAllocationId = allocationId;
         this.primaryMode = false;
+        this.operationPrimaryTerm = operationPrimaryTerm;
         this.handoffInProgress = false;
         this.appliedClusterStateVersion = -1L;
         this.checkpoints = new HashMap<>(1 + indexSettings.getNumberOfReplicas());

server/src/main/java/org/elasticsearch/index/shard/IndexShard.java

@@ -202,7 +202,6 @@ public class IndexShard extends AbstractIndexShardComponent implements IndicesCl
     protected volatile ShardRouting shardRouting;
     protected volatile IndexShardState state;
     private volatile long pendingPrimaryTerm; // see JavaDocs for getPendingPrimaryTerm
-    private volatile long operationPrimaryTerm;
     protected final AtomicReference<Engine> currentEngineReference = new AtomicReference<>();
     final EngineFactory engineFactory;
 
@@ -310,17 +309,21 @@ public IndexShard(
         }
         this.translogConfig = new TranslogConfig(shardId, shardPath().resolveTranslog(), indexSettings, bigArrays);
         final String aId = shardRouting.allocationId().getId();
+        final long primaryTerm = indexSettings.getIndexMetaData().primaryTerm(shardId.id());
+        this.pendingPrimaryTerm = primaryTerm;
         this.globalCheckpointListeners =
                 new GlobalCheckpointListeners(shardId, threadPool.executor(ThreadPool.Names.LISTENER), threadPool.scheduler(), logger);
-        this.replicationTracker =
+        final ReplicationTracker replicationTracker =
                 new ReplicationTracker(
                         shardId,
                         aId,
                         indexSettings,
+                        primaryTerm,
                         UNASSIGNED_SEQ_NO,
                         globalCheckpointListeners::globalCheckpointUpdated,
                         threadPool::absoluteTimeInMillis,
                         retentionLeaseSyncer);
+        this.replicationTracker = replicationTracker;
 
         // the query cache is a node-level thing, however we want the most popular filters
         // to be computed on a per-shard basis
@@ -340,8 +343,6 @@ public boolean shouldCache(Query query) {
         }
         indexShardOperationPermits = new IndexShardOperationPermits(shardId, logger, threadPool);
         searcherWrapper = indexSearcherWrapper;
-        pendingPrimaryTerm = indexSettings.getIndexMetaData().primaryTerm(shardId.id());
-        operationPrimaryTerm = pendingPrimaryTerm;
         refreshListeners = buildRefreshListeners();
         persistMetadata(path, indexSettings, shardRouting, null, logger);
     }
@@ -402,7 +403,7 @@ public long getPendingPrimaryTerm() {
 
     /** Returns the primary term that is currently being used to assign to operations */
     public long getOperationPrimaryTerm() {
-        return this.operationPrimaryTerm;
+        return replicationTracker.getOperationPrimaryTerm();
     }
 
     /**
@@ -529,7 +530,7 @@ public void updateShardState(final ShardRouting newRouting,
                             assert pendingPrimaryTerm == newPrimaryTerm :
                                 "shard term changed on primary. expected [" + newPrimaryTerm + "] but was [" + pendingPrimaryTerm + "]" +
                                 ", current routing: " + currentRouting + ", new routing: " + newRouting;
-                            assert operationPrimaryTerm == newPrimaryTerm;
+                            assert getOperationPrimaryTerm() == newPrimaryTerm;
                             try {
                                 replicationTracker.activatePrimaryMode(getLocalCheckpoint());
                                 /*
@@ -731,23 +732,23 @@ private IndexShardState changeState(IndexShardState newState, String reason) {
     public Engine.IndexResult applyIndexOperationOnPrimary(long version, VersionType versionType, SourceToParse sourceToParse,
                                                            long ifSeqNo, long ifPrimaryTerm, long autoGeneratedTimestamp,
                                                            boolean isRetry) throws IOException {
-        return applyIndexOperation(getEngine(), SequenceNumbers.UNASSIGNED_SEQ_NO, operationPrimaryTerm, version, versionType,
+        return applyIndexOperation(getEngine(), SequenceNumbers.UNASSIGNED_SEQ_NO, getOperationPrimaryTerm(), version, versionType,
             ifSeqNo, ifPrimaryTerm, autoGeneratedTimestamp, isRetry, Engine.Operation.Origin.PRIMARY, sourceToParse);
     }
 
     public Engine.IndexResult applyIndexOperationOnReplica(long seqNo, long version, VersionType versionType,
                                                            long autoGeneratedTimeStamp, boolean isRetry, SourceToParse sourceToParse)
         throws IOException {
-        return applyIndexOperation(getEngine(), seqNo, operationPrimaryTerm, version, versionType, UNASSIGNED_SEQ_NO, 0,
+        return applyIndexOperation(getEngine(), seqNo, getOperationPrimaryTerm(), version, versionType, UNASSIGNED_SEQ_NO, 0,
             autoGeneratedTimeStamp, isRetry, Engine.Operation.Origin.REPLICA, sourceToParse);
     }
 
     private Engine.IndexResult applyIndexOperation(Engine engine, long seqNo, long opPrimaryTerm, long version, VersionType versionType,
                                                    long ifSeqNo, long ifPrimaryTerm,
                                                    long autoGeneratedTimeStamp, boolean isRetry, Engine.Operation.Origin origin,
                                                    SourceToParse sourceToParse) throws IOException {
-        assert opPrimaryTerm <= this.operationPrimaryTerm : "op term [ " + opPrimaryTerm + " ] > shard term [" + this.operationPrimaryTerm
-            + "]";
+        assert opPrimaryTerm <= getOperationPrimaryTerm()
+                : "op term [ " + opPrimaryTerm + " ] > shard term [" + getOperationPrimaryTerm() + "]";
         assert versionType.validateVersionForWrites(version);
         ensureWriteAllowed(origin);
         Engine.Index operation;
@@ -811,13 +812,13 @@ private Engine.IndexResult index(Engine engine, Engine.Index index) throws IOExc
     }
 
     public Engine.NoOpResult markSeqNoAsNoop(long seqNo, String reason) throws IOException {
-        return markSeqNoAsNoop(getEngine(), seqNo, operationPrimaryTerm, reason, Engine.Operation.Origin.REPLICA);
+        return markSeqNoAsNoop(getEngine(), seqNo, getOperationPrimaryTerm(), reason, Engine.Operation.Origin.REPLICA);
     }
 
     private Engine.NoOpResult markSeqNoAsNoop(Engine engine, long seqNo, long opPrimaryTerm, String reason,
                                               Engine.Operation.Origin origin) throws IOException {
-        assert opPrimaryTerm <= this.operationPrimaryTerm : "op term [ " + opPrimaryTerm + " ] > shard term [" + this.operationPrimaryTerm
-            + "]";
+        assert opPrimaryTerm <= getOperationPrimaryTerm()
+                : "op term [ " + opPrimaryTerm + " ] > shard term [" + getOperationPrimaryTerm() + "]";
         long startTime = System.nanoTime();
         ensureWriteAllowed(origin);
         final Engine.NoOp noOp = new Engine.NoOp(seqNo, opPrimaryTerm, origin, startTime, reason);
@@ -833,31 +834,33 @@ private Engine.NoOpResult noOp(Engine engine, Engine.NoOp noOp) {
     }
 
     public Engine.IndexResult getFailedIndexResult(Exception e, long version) {
-        return new Engine.IndexResult(e, version, operationPrimaryTerm);
+        return new Engine.IndexResult(e, version, getOperationPrimaryTerm());
     }
 
     public Engine.DeleteResult getFailedDeleteResult(Exception e, long version) {
-        return new Engine.DeleteResult(e, version, operationPrimaryTerm);
+        return new Engine.DeleteResult(e, version, getOperationPrimaryTerm());
     }
 
     public Engine.DeleteResult applyDeleteOperationOnPrimary(long version, String type, String id, VersionType versionType,
                                                              long ifSeqNo, long ifPrimaryTerm)
         throws IOException {
-        return applyDeleteOperation(getEngine(), SequenceNumbers.UNASSIGNED_SEQ_NO, operationPrimaryTerm, version, type, id, versionType,
-            ifSeqNo, ifPrimaryTerm, Engine.Operation.Origin.PRIMARY);
+        return applyDeleteOperation(
+                getEngine(), SequenceNumbers.UNASSIGNED_SEQ_NO, getOperationPrimaryTerm(), version, type, id, versionType, ifSeqNo,
+                ifPrimaryTerm, Engine.Operation.Origin.PRIMARY);
     }
 
     public Engine.DeleteResult applyDeleteOperationOnReplica(long seqNo, long version, String type, String id,
                                                              VersionType versionType) throws IOException {
-        return applyDeleteOperation(getEngine(), seqNo, operationPrimaryTerm, version, type, id, versionType, UNASSIGNED_SEQ_NO, 0,
+        return applyDeleteOperation(getEngine(), seqNo, getOperationPrimaryTerm(), version, type, id, versionType, UNASSIGNED_SEQ_NO, 0,
             Engine.Operation.Origin.REPLICA);
+
     }
 
     private Engine.DeleteResult applyDeleteOperation(Engine engine, long seqNo, long opPrimaryTerm, long version, String type, String id,
                                                      VersionType versionType, long ifSeqNo, long ifPrimaryTerm,
                                                      Engine.Operation.Origin origin) throws IOException {
-        assert opPrimaryTerm <= this.operationPrimaryTerm : "op term [ " + opPrimaryTerm + " ] > shard term [" + this.operationPrimaryTerm
-            + "]";
+        assert opPrimaryTerm <= getOperationPrimaryTerm()
+                : "op term [ " + opPrimaryTerm + " ] > shard term [" + getOperationPrimaryTerm() + "]";
         assert versionType.validateVersionForWrites(version);
         ensureWriteAllowed(origin);
         if (indexSettings().isSingleType()) {
@@ -874,7 +877,7 @@ private Engine.DeleteResult applyDeleteOperation(Engine engine, long seqNo, long
                     return new Engine.DeleteResult(update);
                 }
             } catch (MapperParsingException | IllegalArgumentException | TypeMissingException e) {
-                return new Engine.DeleteResult(e, version, operationPrimaryTerm, seqNo, false);
+                return new Engine.DeleteResult(e, version, getOperationPrimaryTerm(), seqNo, false);
             }
         }
         final Term uid = extractUidForDelete(type, id);
@@ -1304,7 +1307,7 @@ public void prepareForIndexRecovery() {
     }
 
     public void trimOperationOfPreviousPrimaryTerms(long aboveSeqNo) {
-        getEngine().trimOperationsFromTranslog(operationPrimaryTerm, aboveSeqNo);
+        getEngine().trimOperationsFromTranslog(getOperationPrimaryTerm(), aboveSeqNo);
     }
 
     /**
@@ -2421,7 +2424,7 @@ private EngineConfig newEngineConfig() {
                 Collections.singletonList(refreshListeners),
                 Collections.singletonList(new RefreshMetricUpdater(refreshMetric)),
                 indexSort, circuitBreakerService, replicationTracker, replicationTracker::getRetentionLeases,
-                () -> operationPrimaryTerm, tombstoneDocSupplier());
+                () -> getOperationPrimaryTerm(), tombstoneDocSupplier());
     }
 
     /**
@@ -2501,7 +2504,7 @@ private <E extends Exception> void bumpPrimaryTerm(final long newPrimaryTerm,
                                                        @Nullable ActionListener<Releasable> combineWithAction) {
         assert Thread.holdsLock(mutex);
         assert newPrimaryTerm > pendingPrimaryTerm || (newPrimaryTerm >= pendingPrimaryTerm && combineWithAction != null);
-        assert operationPrimaryTerm <= pendingPrimaryTerm;
+        assert getOperationPrimaryTerm() <= pendingPrimaryTerm;
         final CountDownLatch termUpdated = new CountDownLatch(1);
         asyncBlockOperations(new ActionListener<Releasable>() {
             @Override
@@ -2527,12 +2530,12 @@ private void innerFail(final Exception e) {
             public void onResponse(final Releasable releasable) {
                 final RunOnce releaseOnce = new RunOnce(releasable::close);
                 try {
-                    assert operationPrimaryTerm <= pendingPrimaryTerm;
+                    assert getOperationPrimaryTerm() <= pendingPrimaryTerm;
                     termUpdated.await();
                     // indexShardOperationPermits doesn't guarantee that async submissions are executed
                     // in the order submitted. We need to guard against another term bump
-                    if (operationPrimaryTerm < newPrimaryTerm) {
-                        operationPrimaryTerm = newPrimaryTerm;
+                    if (getOperationPrimaryTerm() < newPrimaryTerm) {
+                        replicationTracker.setOperationPrimaryTerm(newPrimaryTerm);
                         onBlocked.run();
                     }
                 } catch (final Exception e) {
@@ -2618,14 +2621,14 @@ private void innerAcquireReplicaOperationPermit(final long opPrimaryTerm,
         final ActionListener<Releasable> operationListener = new ActionListener<Releasable>() {
             @Override
             public void onResponse(final Releasable releasable) {
-                if (opPrimaryTerm < operationPrimaryTerm) {
+                if (opPrimaryTerm < getOperationPrimaryTerm()) {
                     releasable.close();
                     final String message = String.format(
                         Locale.ROOT,
                         "%s operation primary term [%d] is too old (current [%d])",
                         shardId,
                         opPrimaryTerm,
-                        operationPrimaryTerm);
+                        getOperationPrimaryTerm());
                     onPermitAcquired.onFailure(new IllegalStateException(message));
                 } else {
                     assert assertReplicationTarget();
@@ -2686,7 +2689,7 @@ public void onFailure(final Exception e) {
     }
 
     private boolean requirePrimaryTermUpdate(final long opPrimaryTerm, final boolean allPermits) {
-        return (opPrimaryTerm > pendingPrimaryTerm) || (allPermits && opPrimaryTerm > operationPrimaryTerm);
+        return (opPrimaryTerm > pendingPrimaryTerm) || (allPermits && opPrimaryTerm > getOperationPrimaryTerm());
     }
 
     public int getActiveOperationsCount() {

server/src/test/java/org/elasticsearch/index/seqno/ReplicationTrackerRetentionLeaseTests.java

@@ -53,6 +53,7 @@ public void testAddOrRenewRetentionLease() {
                 new ShardId("test", "_na", 0),
                 allocationId.getId(),
                 IndexSettingsModule.newIndexSettings("test", Settings.EMPTY),
+                randomNonNegativeLong(),
                 UNASSIGNED_SEQ_NO,
                 value -> {},
                 () -> 0L,
@@ -88,6 +89,7 @@ public void testAddRetentionLeaseCausesRetentionLeaseSync() {
                 new ShardId("test", "_na", 0),
                 allocationId.getId(),
                 IndexSettingsModule.newIndexSettings("test", Settings.EMPTY),
+                randomNonNegativeLong(),
                 UNASSIGNED_SEQ_NO,
                 value -> {},
                 () -> 0L,
@@ -143,6 +145,7 @@ private void runExpirationTest(final boolean primaryMode) {
                 new ShardId("test", "_na", 0),
                 allocationId.getId(),
                 IndexSettingsModule.newIndexSettings("test", settings),
+                randomNonNegativeLong(),
                 UNASSIGNED_SEQ_NO,
                 value -> {},
                 currentTimeMillis::get,
@@ -215,6 +218,7 @@ public void testRetentionLeaseExpirationCausesRetentionLeaseSync() {
                 new ShardId("test", "_na", 0),
                 allocationId.getId(),
                 IndexSettingsModule.newIndexSettings("test", settings),
+                randomNonNegativeLong(),
                 UNASSIGNED_SEQ_NO,
                 value -> {},
                 currentTimeMillis::get,

server/src/test/java/org/elasticsearch/index/seqno/ReplicationTrackerTestCase.java

@@ -45,6 +45,7 @@ ReplicationTracker newTracker(
                 new ShardId("test", "_na_", 0),
                 allocationId.getId(),
                 IndexSettingsModule.newIndexSettings("test", Settings.EMPTY),
+                randomNonNegativeLong(),
                 UNASSIGNED_SEQ_NO,
                 updatedGlobalCheckpoint,
                 currentTimeMillisSupplier,