You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by ch...@apache.org on 2025/05/02 07:40:50 UTC

(lucene) branch main updated: Remove RANDOM_PRELOAD read advice, which is not actually used (#14593)

This is an automated email from the ASF dual-hosted git repository.

chegar pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/lucene.git


The following commit(s) were added to refs/heads/main by this push:
     new 7cbe0facb3b Remove RANDOM_PRELOAD read advice, which is not actually used (#14593)
7cbe0facb3b is described below

commit 7cbe0facb3b0022c1060bd06bc7ef94d1fd663e2
Author: Simon Cooper <si...@elastic.co>
AuthorDate: Fri May 2 08:40:44 2025 +0100

    Remove RANDOM_PRELOAD read advice, which is not actually used (#14593)
    
    ReadAdvice.RANDOM_PRELOAD just maps to the same madvise as NORMAL - so remove it completely.
---
 lucene/MIGRATE.md                                         |  2 +-
 .../lucene90/blocktree/Lucene90BlockTreeTermsReader.java  |  3 +--
 .../org/apache/lucene/codecs/memory/FSTTermsReader.java   |  3 +--
 .../blocktree/Lucene103BlockTreeTermsReader.java          |  3 +--
 .../lucene/codecs/lucene90/Lucene90PointsReader.java      |  2 +-
 .../codecs/lucene90/compressing/FieldsIndexReader.java    |  2 +-
 .../java/org/apache/lucene/store/PosixNativeAccess.java   |  1 -
 .../core/src/java/org/apache/lucene/store/ReadAdvice.java |  9 +--------
 .../lucene/index/TestDefaultCodecParallelizesIO.java      | 15 ++++++++-------
 .../lucene/tests/store/SerialIOCountingDirectory.java     |  2 +-
 10 files changed, 16 insertions(+), 26 deletions(-)

diff --git a/lucene/MIGRATE.md b/lucene/MIGRATE.md
index 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.java
index 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.java
index 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.java
index 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.java
index 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.java
index 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.java
index 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.java
index 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.java
index 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.java
index 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 {
   @Override
   public 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 time
       counter.increment();
       return super.openInput(name, context);