Apache Lucene open-source search software
Remove RANDOM_PRELOAD read advice, which is not actually used (#14593)
Simon Cooper7cbe0facb3b0
diff --git a/lucene/MIGRATE.md b/lucene/MIGRATE.mdindex 385ed64ae4b..543f6c4958d 100644--- a/lucene/MIGRATE.md+++ b/lucene/MIGRATE.md@@ -236,7 +236,7 @@ enum.### IOContext.LOAD and IOContext.READ removed`IOContext#LOAD` has been removed, it should be replaced with-`ioContext.withReadAdvice(ReadAdvice.RANDOM_PRELOAD)`.+`ioContext.withReadAdvice(ReadAdvice.NORMAL)`.`IOContext.READ` has been removed, it should be replaced with `IOContext.DEFAULT`.diff --git a/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene90/blocktree/Lucene90BlockTreeTermsReader.java b/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene90/blocktree/Lucene90BlockTreeTermsReader.javaindex d12ffcd4eac..fc28374275f 100644--- a/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene90/blocktree/Lucene90BlockTreeTermsReader.java+++ b/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene90/blocktree/Lucene90BlockTreeTermsReader.java@@ -146,8 +146,7 @@ public final class Lucene90BlockTreeTermsReader extends FieldsProducer {String indexName =IndexFileNames.segmentFileName(segment, state.segmentSuffix, TERMS_INDEX_EXTENSION);indexIn =- state.directory.openInput(- indexName, state.context.withReadAdvice(ReadAdvice.RANDOM_PRELOAD));+ state.directory.openInput(indexName, state.context.withReadAdvice(ReadAdvice.NORMAL));CodecUtil.checkIndexHeader(indexIn,TERMS_INDEX_CODEC_NAME,diff --git a/lucene/codecs/src/java/org/apache/lucene/codecs/memory/FSTTermsReader.java b/lucene/codecs/src/java/org/apache/lucene/codecs/memory/FSTTermsReader.javaindex d500b75eaab..a24146dfc45 100644--- a/lucene/codecs/src/java/org/apache/lucene/codecs/memory/FSTTermsReader.java+++ b/lucene/codecs/src/java/org/apache/lucene/codecs/memory/FSTTermsReader.java@@ -75,8 +75,7 @@ public class FSTTermsReader extends FieldsProducer {this.postingsReader = postingsReader;this.fstTermsInput =- state.directory.openInput(- termsFileName, state.context.withReadAdvice(ReadAdvice.RANDOM_PRELOAD));+ state.directory.openInput(termsFileName, state.context.withReadAdvice(ReadAdvice.NORMAL));IndexInput in = this.fstTermsInput;diff --git a/lucene/core/src/java/org/apache/lucene/codecs/lucene103/blocktree/Lucene103BlockTreeTermsReader.java b/lucene/core/src/java/org/apache/lucene/codecs/lucene103/blocktree/Lucene103BlockTreeTermsReader.javaindex 1eea2b1b206..b4c5e298098 100644--- a/lucene/core/src/java/org/apache/lucene/codecs/lucene103/blocktree/Lucene103BlockTreeTermsReader.java+++ b/lucene/core/src/java/org/apache/lucene/codecs/lucene103/blocktree/Lucene103BlockTreeTermsReader.java@@ -127,8 +127,7 @@ public final class Lucene103BlockTreeTermsReader extends FieldsProducer {String indexName =IndexFileNames.segmentFileName(segment, state.segmentSuffix, TERMS_INDEX_EXTENSION);indexIn =- state.directory.openInput(- indexName, state.context.withReadAdvice(ReadAdvice.RANDOM_PRELOAD));+ state.directory.openInput(indexName, state.context.withReadAdvice(ReadAdvice.NORMAL));CodecUtil.checkIndexHeader(indexIn,TERMS_INDEX_CODEC_NAME,diff --git a/lucene/core/src/java/org/apache/lucene/codecs/lucene90/Lucene90PointsReader.java b/lucene/core/src/java/org/apache/lucene/codecs/lucene90/Lucene90PointsReader.javaindex 82910e23ab9..2f6fb86fda7 100644--- a/lucene/core/src/java/org/apache/lucene/codecs/lucene90/Lucene90PointsReader.java+++ b/lucene/core/src/java/org/apache/lucene/codecs/lucene90/Lucene90PointsReader.java@@ -61,7 +61,7 @@ public class Lucene90PointsReader extends PointsReader {try {indexIn =readState.directory.openInput(- indexFileName, readState.context.withReadAdvice(ReadAdvice.RANDOM_PRELOAD));+ indexFileName, readState.context.withReadAdvice(ReadAdvice.NORMAL));CodecUtil.checkIndexHeader(indexIn,Lucene90PointsFormat.INDEX_CODEC_NAME,diff --git a/lucene/core/src/java/org/apache/lucene/codecs/lucene90/compressing/FieldsIndexReader.java b/lucene/core/src/java/org/apache/lucene/codecs/lucene90/compressing/FieldsIndexReader.javaindex 91ac9010f4b..2fed57fbac7 100644--- a/lucene/core/src/java/org/apache/lucene/codecs/lucene90/compressing/FieldsIndexReader.java+++ b/lucene/core/src/java/org/apache/lucene/codecs/lucene90/compressing/FieldsIndexReader.java@@ -69,7 +69,7 @@ final class FieldsIndexReader extends FieldsIndex {indexInput =dir.openInput(IndexFileNames.segmentFileName(name, suffix, extension),- context.withReadAdvice(ReadAdvice.RANDOM_PRELOAD));+ context.withReadAdvice(ReadAdvice.NORMAL));boolean success = false;try {CodecUtil.checkIndexHeader(diff --git a/lucene/core/src/java/org/apache/lucene/store/PosixNativeAccess.java b/lucene/core/src/java/org/apache/lucene/store/PosixNativeAccess.javaindex 477383fda32..fea88e979e5 100644--- a/lucene/core/src/java/org/apache/lucene/store/PosixNativeAccess.java+++ b/lucene/core/src/java/org/apache/lucene/store/PosixNativeAccess.java@@ -157,7 +157,6 @@ final class PosixNativeAccess extends NativeAccess {case NORMAL -> POSIX_MADV_NORMAL;case RANDOM -> POSIX_MADV_RANDOM;case SEQUENTIAL -> POSIX_MADV_SEQUENTIAL;- case RANDOM_PRELOAD -> POSIX_MADV_NORMAL;};}diff --git a/lucene/core/src/java/org/apache/lucene/store/ReadAdvice.java b/lucene/core/src/java/org/apache/lucene/store/ReadAdvice.javaindex 5c706e2abf5..46dc41a5e49 100644--- a/lucene/core/src/java/org/apache/lucene/store/ReadAdvice.java+++ b/lucene/core/src/java/org/apache/lucene/store/ReadAdvice.java@@ -33,12 +33,5 @@ public enum ReadAdvice {* Data is expected to be read sequentially with very little seeking at most. The system may read* ahead aggressively and free pages soon after they are accessed.*/- SEQUENTIAL,- /**- * Data is treated as random-access memory in practice. {@link Directory} implementations may- * explicitly load the content of the file in memory, or provide hints to the system so that it- * loads the content of the file into the page cache at open time. This should only be used on- * very small files that can be expected to fit in RAM with very high confidence.- */- RANDOM_PRELOAD+ SEQUENTIAL}diff --git a/lucene/core/src/test/org/apache/lucene/index/TestDefaultCodecParallelizesIO.java b/lucene/core/src/test/org/apache/lucene/index/TestDefaultCodecParallelizesIO.javaindex 58579ab93a4..70788c1f64e 100644--- a/lucene/core/src/test/org/apache/lucene/index/TestDefaultCodecParallelizesIO.java+++ b/lucene/core/src/test/org/apache/lucene/index/TestDefaultCodecParallelizesIO.java@@ -16,6 +16,9 @@*/package org.apache.lucene.index;+import static org.hamcrest.Matchers.greaterThan;+import static org.hamcrest.Matchers.lessThan;+import java.io.IOException;import org.apache.lucene.document.Document;import org.apache.lucene.store.ByteBuffersDirectory;@@ -43,8 +46,6 @@ public class TestDefaultCodecParallelizesIO extends LuceneTestCase {new IndexWriter(bbDir,new IndexWriterConfig()- // Disable CFS, this test needs to know about files that are open with the- // RANDOM_PRELOAD advice, which CFS doesn't allow us to detect..setUseCompoundFile(false).setMergePolicy(newLogMergePolicy(false)).setCodec(TestUtil.getDefaultCodec()))) {@@ -83,10 +84,10 @@ public class TestDefaultCodecParallelizesIO extends LuceneTestCase {}}- assertTrue(nonNullIOSuppliers > 0);+ assertThat(nonNullIOSuppliers, greaterThan(0));long newCount = dir.count();- assertTrue(newCount - prevCount > 0);- assertTrue(newCount - prevCount < nonNullIOSuppliers);+ assertThat(newCount, greaterThan(prevCount));+ assertThat(newCount, lessThan(prevCount + nonNullIOSuppliers));}/** Simulate stored fields retrieval. */@@ -105,7 +106,7 @@ public class TestDefaultCodecParallelizesIO extends LuceneTestCase {}long newCount = dir.count();- assertTrue(newCount - prevCount > 0);- assertTrue(newCount - prevCount < docs.length);+ assertThat(newCount, greaterThan(prevCount));+ assertThat(newCount, lessThan(prevCount + docs.length));}}diff --git a/lucene/test-framework/src/java/org/apache/lucene/tests/store/SerialIOCountingDirectory.java b/lucene/test-framework/src/java/org/apache/lucene/tests/store/SerialIOCountingDirectory.javaindex 98793fc0f1e..0c83dea338a 100644--- a/lucene/test-framework/src/java/org/apache/lucene/tests/store/SerialIOCountingDirectory.java+++ b/lucene/test-framework/src/java/org/apache/lucene/tests/store/SerialIOCountingDirectory.java@@ -73,7 +73,7 @@ public class SerialIOCountingDirectory extends FilterDirectory {@Overridepublic IndexInput openInput(String name, IOContext context) throws IOException {ReadAdvice readAdvice = context.readAdvice().orElse(Constants.DEFAULT_READADVICE);- if (readAdvice == ReadAdvice.RANDOM_PRELOAD) {+ if (readAdvice == ReadAdvice.NORMAL) {// expected to be loaded in memory, only count 1 at open timecounter.increment();return super.openInput(name, context);