Some improvements to ES812PostingsReader

original-brownbear · original-brownbear · commit ec5b02e19182 · 2024-04-11T13:15:53.000+02:00
Removing some fields that need not exist from this class as well as
cleaning up two redundant conditions and adding missing `final`.
diff --git a/server/src/main/java/org/elasticsearch/index/codec/postings/ES812PostingsReader.java b/server/src/main/java/org/elasticsearch/index/codec/postings/ES812PostingsReader.java
@@ -265,9 +265,7 @@ public ImpactsEnum impacts(FieldInfo fieldInfo, BlockTermState state, int flags)
             return new BlockImpactsDocsEnum(fieldInfo, (IntBlockTermState) state);
         }
 
-        if (indexHasPositions
-            && PostingsEnum.featureRequested(flags, PostingsEnum.POSITIONS)
-            && (indexHasOffsets == false || PostingsEnum.featureRequested(flags, PostingsEnum.OFFSETS) == false)
+        if ((indexHasOffsets == false || PostingsEnum.featureRequested(flags, PostingsEnum.OFFSETS) == false)
             && (indexHasPayloads == false || PostingsEnum.featureRequested(flags, PostingsEnum.PAYLOADS) == false)) {
             return new BlockImpactsPostingsEnum(fieldInfo, (IntBlockTermState) state);
         }
@@ -287,8 +285,6 @@ final class BlockDocsEnum extends PostingsEnum {
         private ES812SkipReader skipper;
         private boolean skipped;
 
-        final IndexInput startDocIn;
-
         IndexInput docIn;
         final boolean indexHasFreq;
         final boolean indexHasPos;
@@ -320,8 +316,7 @@ final class BlockDocsEnum extends PostingsEnum {
         private boolean isFreqsRead;
         private int singletonDocID; // docid when there is a single pulsed posting, otherwise -1
 
-        BlockDocsEnum(FieldInfo fieldInfo) throws IOException {
-            this.startDocIn = ES812PostingsReader.this.docIn;
+        BlockDocsEnum(FieldInfo fieldInfo) {
             this.docIn = null;
             indexHasFreq = fieldInfo.getIndexOptions().compareTo(IndexOptions.DOCS_AND_FREQS) >= 0;
             indexHasPos = fieldInfo.getIndexOptions().compareTo(IndexOptions.DOCS_AND_FREQS_AND_POSITIONS) >= 0;
@@ -333,7 +328,7 @@ final class BlockDocsEnum extends PostingsEnum {
         }
 
         public boolean canReuse(IndexInput docIn, FieldInfo fieldInfo) {
-            return docIn == startDocIn
+            return docIn == ES812PostingsReader.this.docIn
                 && indexHasFreq == (fieldInfo.getIndexOptions().compareTo(IndexOptions.DOCS_AND_FREQS) >= 0)
                 && indexHasPos == (fieldInfo.getIndexOptions().compareTo(IndexOptions.DOCS_AND_FREQS_AND_POSITIONS) >= 0)
                 && indexHasPayloads == fieldInfo.hasPayloads();
@@ -348,7 +343,7 @@ public PostingsEnum reset(IntBlockTermState termState, int flags) throws IOExcep
             if (docFreq > 1) {
                 if (docIn == null) {
                     // lazy init
-                    docIn = startDocIn.clone();
+                    docIn = ES812PostingsReader.this.docIn.clone();
                 }
                 docIn.seek(docTermStartFP);
             }
@@ -379,22 +374,22 @@ public int freq() throws IOException {
         }
 
         @Override
-        public int nextPosition() throws IOException {
+        public int nextPosition() {
             return -1;
         }
 
         @Override
-        public int startOffset() throws IOException {
+        public int startOffset() {
             return -1;
         }
 
         @Override
-        public int endOffset() throws IOException {
+        public int endOffset() {
             return -1;
         }
 
         @Override
-        public BytesRef getPayload() throws IOException {
+        public BytesRef getPayload() {
             return null;
         }
 
@@ -604,7 +599,7 @@ final class EverythingEnum extends PostingsEnum {
         private boolean needsPayloads; // true if we actually need payloads
         private int singletonDocID; // docid when there is a single pulsed posting, otherwise -1
 
-        EverythingEnum(FieldInfo fieldInfo) throws IOException {
+        EverythingEnum(FieldInfo fieldInfo) {
             indexHasOffsets = fieldInfo.getIndexOptions().compareTo(IndexOptions.DOCS_AND_FREQS_AND_POSITIONS_AND_OFFSETS) >= 0;
             indexHasPayloads = fieldInfo.hasPayloads();
 
@@ -690,7 +685,7 @@ public EverythingEnum reset(IntBlockTermState termState, int flags) throws IOExc
         }
 
         @Override
-        public int freq() throws IOException {
+        public int freq() {
             return freq;
         }
 
@@ -851,16 +846,13 @@ public int advance(int target) throws IOException {
 
             // Now scan:
             long doc;
-            while (true) {
+            do {
                 doc = docBuffer[docBufferUpto];
                 freq = (int) freqBuffer[docBufferUpto];
                 posPendingCount += freq;
                 docBufferUpto++;
 
-                if (doc >= target) {
-                    break;
-                }
-            }
+            } while (doc < target);
 
             position = 0;
             lastStartOffset = 0;
@@ -1010,7 +1002,7 @@ final class BlockImpactsDocsEnum extends ImpactsEnum {
 
         final boolean indexHasFreqs;
 
-        private int docFreq; // number of docs in this posting list
+        private final int docFreq; // number of docs in this posting list
         private int blockUpto; // number of documents in or before the current block
         private int doc; // doc we last read
         private long accum; // accumulator for doc deltas
@@ -1167,7 +1159,7 @@ public int advance(int target) throws IOException {
         }
 
         @Override
-        public int nextPosition() throws IOException {
+        public int nextPosition() {
             return -1;
         }
 
@@ -1211,8 +1203,8 @@ final class BlockImpactsPostingsEnum extends ImpactsEnum {
         final boolean indexHasOffsets;
         final boolean indexHasPayloads;
 
-        private int docFreq; // number of docs in this posting list
-        private long totalTermFreq; // number of positions in this posting list
+        private final int docFreq; // number of docs in this posting list
+        private final long totalTermFreq; // number of positions in this posting list
         private int docUpto; // how many docs we've read
         private int doc; // doc we last read
         private long accum; // accumulator for doc deltas
@@ -1227,20 +1219,10 @@ final class BlockImpactsPostingsEnum extends ImpactsEnum {
         // before reading positions:
         private long posPendingFP;
 
-        // Where this term's postings start in the .doc file:
-        private long docTermStartFP;
-
-        // Where this term's postings start in the .pos file:
-        private long posTermStartFP;
-
-        // Where this term's payloads/offsets start in the .pay
-        // file:
-        private long payTermStartFP;
-
         // File pointer where the last (vInt encoded) pos delta
         // block is. We need this to know whether to bulk
         // decode vs vInt decode the block:
-        private long lastPosBlockFP;
+        private final long lastPosBlockFP;
 
         private int nextSkipDoc = -1;
 
@@ -1255,9 +1237,13 @@ final class BlockImpactsPostingsEnum extends ImpactsEnum {
             this.posIn = ES812PostingsReader.this.posIn.clone();
 
             docFreq = termState.docFreq;
-            docTermStartFP = termState.docStartFP;
-            posTermStartFP = termState.posStartFP;
-            payTermStartFP = termState.payStartFP;
+            // Where this term's postings start in the .doc file:
+            long docTermStartFP = termState.docStartFP;
+            // Where this term's postings start in the .pos file:
+            long posTermStartFP = termState.posStartFP;
+            // Where this term's payloads/offsets start in the .pay
+            // file:
+            long payTermStartFP = termState.payStartFP;
             totalTermFreq = termState.totalTermFreq;
             docIn.seek(docTermStartFP);
             posPendingFP = posTermStartFP;
@@ -1280,7 +1266,7 @@ final class BlockImpactsPostingsEnum extends ImpactsEnum {
         }
 
         @Override
-        public int freq() throws IOException {
+        public int freq() {
             return freq;
         }
 
@@ -1507,8 +1493,8 @@ final class BlockImpactsEverythingEnum extends ImpactsEnum {
         final boolean indexHasOffsets;
         final boolean indexHasPayloads;
 
-        private int docFreq; // number of docs in this posting list
-        private long totalTermFreq; // number of positions in this posting list
+        private final int docFreq; // number of docs in this posting list
+        private final long totalTermFreq; // number of positions in this posting list
         private int docUpto; // how many docs we've read
         private int posDocUpTo; // for how many docs we've read positions, offsets, and payloads
         private int doc; // doc we last read
@@ -1527,20 +1513,10 @@ final class BlockImpactsEverythingEnum extends ImpactsEnum {
         // before reading payloads/offsets:
         private long payPendingFP;
 
-        // Where this term's postings start in the .doc file:
-        private long docTermStartFP;
-
-        // Where this term's postings start in the .pos file:
-        private long posTermStartFP;
-
-        // Where this term's payloads/offsets start in the .pay
-        // file:
-        private long payTermStartFP;
-
         // File pointer where the last (vInt encoded) pos delta
         // block is. We need this to know whether to bulk
         // decode vs vInt decode the block:
-        private long lastPosBlockFP;
+        private final long lastPosBlockFP;
 
         private int nextSkipDoc = -1;
 
@@ -1597,20 +1573,17 @@ final class BlockImpactsEverythingEnum extends ImpactsEnum {
             }
 
             docFreq = termState.docFreq;
-            docTermStartFP = termState.docStartFP;
-            posTermStartFP = termState.posStartFP;
-            payTermStartFP = termState.payStartFP;
             totalTermFreq = termState.totalTermFreq;
-            docIn.seek(docTermStartFP);
-            posPendingFP = posTermStartFP;
-            payPendingFP = payTermStartFP;
+            docIn.seek(termState.docStartFP);
+            posPendingFP = termState.posStartFP;
+            payPendingFP = termState.payStartFP;
             posPendingCount = 0;
             if (termState.totalTermFreq < BLOCK_SIZE) {
-                lastPosBlockFP = posTermStartFP;
+                lastPosBlockFP = termState.posStartFP;
             } else if (termState.totalTermFreq == BLOCK_SIZE) {
                 lastPosBlockFP = -1;
             } else {
-                lastPosBlockFP = posTermStartFP + termState.lastPosBlockOffset;
+                lastPosBlockFP = termState.posStartFP + termState.lastPosBlockOffset;
             }
 
             doc = -1;
@@ -1621,7 +1594,13 @@ final class BlockImpactsEverythingEnum extends ImpactsEnum {
             docBufferUpto = BLOCK_SIZE;
 
             skipper = new ES812ScoreSkipReader(docIn.clone(), MAX_SKIP_LEVELS, indexHasPos, indexHasOffsets, indexHasPayloads);
-            skipper.init(docTermStartFP + termState.skipOffset, docTermStartFP, posTermStartFP, payTermStartFP, docFreq);
+            skipper.init(
+                termState.docStartFP + termState.skipOffset,
+                termState.docStartFP,
+                termState.posStartFP,
+                termState.payStartFP,
+                docFreq
+            );
 
             if (indexHasFreq == false) {
                 for (int i = 0; i < ForUtil.BLOCK_SIZE; ++i) {
