Skip to content

Apache Lucene open-source search software

Remove Accountable interface in KnnVectorsReader (#13255)

Pulkit Guptadf0384c34fde
diff --git a/lucene/CHANGES.txt b/lucene/CHANGES.txt
index f350aa9fa2d..6ca9eb274d4 100644
--- a/lucene/CHANGES.txt
+++ b/lucene/CHANGES.txt
@@ -96,6 +96,9 @@ API Changes
* GITHUB#13261: Convert `BooleanClause` class to record class. (Pulkit Gupta)
+* GITHUB#13241: Remove Accountable interface on KnnVectorsReader. (Pulkit Gupta)
+
+
New Features
---------------------
diff --git a/lucene/MIGRATE.md b/lucene/MIGRATE.md
index 38c14b8715f..c81a33e13f6 100644
--- a/lucene/MIGRATE.md
+++ b/lucene/MIGRATE.md
@@ -225,6 +225,12 @@ public class CustomCollectorManager implements CollectorManager<CustomCollector,
List<Object> results = searcher.search(query, new CustomCollectorManager());
```
+
+### Accountable interface removed from KnnVectorsReader (GITHUB#13255)
+
+`KnnVectorsReader` objects use small heap memory, so it's not worth maintaining heap usage for them hence removed
+`Accountable` interface from `KnnVectorsReader`.
+
## Migration from Lucene 9.0 to Lucene 9.1
### Test framework package migration and module (LUCENE-10301)
diff --git a/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene90/Lucene90HnswVectorsReader.java b/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene90/Lucene90HnswVectorsReader.java
index d48817f54bd..7fb6d88fb6f 100644
--- a/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene90/Lucene90HnswVectorsReader.java
+++ b/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene90/Lucene90HnswVectorsReader.java
@@ -40,7 +40,6 @@ import org.apache.lucene.store.DataInput;
import org.apache.lucene.store.IndexInput;
import org.apache.lucene.util.Bits;
import org.apache.lucene.util.IOUtils;
-import org.apache.lucene.util.RamUsageEstimator;
import org.apache.lucene.util.hnsw.HnswGraph;
import org.apache.lucene.util.hnsw.NeighborQueue;
import org.apache.lucene.util.hnsw.RandomAccessVectorValues;
@@ -214,18 +213,6 @@ public final class Lucene90HnswVectorsReader extends KnnVectorsReader {
return new FieldEntry(input, info.getVectorSimilarityFunction());
}
- @Override
- public long ramBytesUsed() {
- long totalBytes = RamUsageEstimator.shallowSizeOfInstance(Lucene90HnswVectorsReader.class);
- totalBytes +=
- RamUsageEstimator.sizeOfMap(
- fields, RamUsageEstimator.shallowSizeOfInstance(FieldEntry.class));
- for (FieldEntry entry : fields.values()) {
- totalBytes += RamUsageEstimator.sizeOf(entry.ordToDoc);
- }
- return totalBytes;
- }
-
@Override
public void checkIntegrity() throws IOException {
CodecUtil.checksumEntireFile(vectorData);
diff --git a/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene91/Lucene91HnswVectorsReader.java b/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene91/Lucene91HnswVectorsReader.java
index e0210c9b19a..ea4d7089251 100644
--- a/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene91/Lucene91HnswVectorsReader.java
+++ b/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene91/Lucene91HnswVectorsReader.java
@@ -40,7 +40,6 @@ import org.apache.lucene.store.DataInput;
import org.apache.lucene.store.IndexInput;
import org.apache.lucene.util.Bits;
import org.apache.lucene.util.IOUtils;
-import org.apache.lucene.util.RamUsageEstimator;
import org.apache.lucene.util.hnsw.HnswGraph;
import org.apache.lucene.util.hnsw.HnswGraphSearcher;
import org.apache.lucene.util.hnsw.OrdinalTranslatedKnnCollector;
@@ -206,18 +205,6 @@ public final class Lucene91HnswVectorsReader extends KnnVectorsReader {
return new FieldEntry(input, info.getVectorSimilarityFunction());
}
- @Override
- public long ramBytesUsed() {
- long totalBytes = RamUsageEstimator.shallowSizeOfInstance(Lucene91HnswVectorsFormat.class);
- totalBytes +=
- RamUsageEstimator.sizeOfMap(
- fields, RamUsageEstimator.shallowSizeOfInstance(FieldEntry.class));
- for (FieldEntry entry : fields.values()) {
- totalBytes += RamUsageEstimator.sizeOf(entry.ordToDoc);
- }
- return totalBytes;
- }
-
@Override
public void checkIntegrity() throws IOException {
CodecUtil.checksumEntireFile(vectorData);
diff --git a/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene92/Lucene92HnswVectorsReader.java b/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene92/Lucene92HnswVectorsReader.java
index a7aa241f42d..68dac0d4b52 100644
--- a/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene92/Lucene92HnswVectorsReader.java
+++ b/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene92/Lucene92HnswVectorsReader.java
@@ -39,7 +39,6 @@ import org.apache.lucene.store.DataInput;
import org.apache.lucene.store.IndexInput;
import org.apache.lucene.util.Bits;
import org.apache.lucene.util.IOUtils;
-import org.apache.lucene.util.RamUsageEstimator;
import org.apache.lucene.util.hnsw.HnswGraph;
import org.apache.lucene.util.hnsw.HnswGraphSearcher;
import org.apache.lucene.util.hnsw.OrdinalTranslatedKnnCollector;
@@ -205,15 +204,6 @@ public final class Lucene92HnswVectorsReader extends KnnVectorsReader {
return new FieldEntry(input, info.getVectorSimilarityFunction());
}
- @Override
- public long ramBytesUsed() {
- long totalBytes = RamUsageEstimator.shallowSizeOfInstance(Lucene92HnswVectorsFormat.class);
- totalBytes +=
- RamUsageEstimator.sizeOfMap(
- fields, RamUsageEstimator.shallowSizeOfInstance(FieldEntry.class));
- return totalBytes;
- }
-
@Override
public void checkIntegrity() throws IOException {
CodecUtil.checksumEntireFile(vectorData);
diff --git a/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene94/Lucene94HnswVectorsReader.java b/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene94/Lucene94HnswVectorsReader.java
index 5daec83629f..8a144e07524 100644
--- a/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene94/Lucene94HnswVectorsReader.java
+++ b/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene94/Lucene94HnswVectorsReader.java
@@ -40,7 +40,6 @@ import org.apache.lucene.store.DataInput;
import org.apache.lucene.store.IndexInput;
import org.apache.lucene.util.Bits;
import org.apache.lucene.util.IOUtils;
-import org.apache.lucene.util.RamUsageEstimator;
import org.apache.lucene.util.hnsw.HnswGraph;
import org.apache.lucene.util.hnsw.HnswGraphSearcher;
import org.apache.lucene.util.hnsw.OrdinalTranslatedKnnCollector;
@@ -223,15 +222,6 @@ public final class Lucene94HnswVectorsReader extends KnnVectorsReader {
return new FieldEntry(input, vectorEncoding, info.getVectorSimilarityFunction());
}
- @Override
- public long ramBytesUsed() {
- long totalBytes = RamUsageEstimator.shallowSizeOfInstance(Lucene94HnswVectorsFormat.class);
- totalBytes +=
- RamUsageEstimator.sizeOfMap(
- fields, RamUsageEstimator.shallowSizeOfInstance(FieldEntry.class));
- return totalBytes;
- }
-
@Override
public void checkIntegrity() throws IOException {
CodecUtil.checksumEntireFile(vectorData);
diff --git a/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene95/Lucene95HnswVectorsReader.java b/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene95/Lucene95HnswVectorsReader.java
index d0063f9da17..ccf0735f458 100644
--- a/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene95/Lucene95HnswVectorsReader.java
+++ b/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene95/Lucene95HnswVectorsReader.java
@@ -61,9 +61,6 @@ import org.apache.lucene.util.packed.DirectMonotonicReader;
*/
public final class Lucene95HnswVectorsReader extends KnnVectorsReader implements HnswGraphProvider {
- private static final long SHALLOW_SIZE =
- RamUsageEstimator.shallowSizeOfInstance(Lucene95HnswVectorsFormat.class);
-
private final FieldInfos fieldInfos;
private final Map<String, FieldEntry> fields = new HashMap<>();
private final IndexInput vectorData;
@@ -235,13 +232,6 @@ public final class Lucene95HnswVectorsReader extends KnnVectorsReader implements
return new FieldEntry(input, vectorEncoding, info.getVectorSimilarityFunction());
}
- @Override
- public long ramBytesUsed() {
- return Lucene95HnswVectorsReader.SHALLOW_SIZE
- + RamUsageEstimator.sizeOfMap(
- fields, RamUsageEstimator.shallowSizeOfInstance(FieldEntry.class));
- }
-
@Override
public void checkIntegrity() throws IOException {
CodecUtil.checksumEntireFile(vectorData);
diff --git a/lucene/codecs/src/java/org/apache/lucene/codecs/simpletext/SimpleTextKnnVectorsReader.java b/lucene/codecs/src/java/org/apache/lucene/codecs/simpletext/SimpleTextKnnVectorsReader.java
index e4e1e9308c9..43cf92cbb1c 100644
--- a/lucene/codecs/src/java/org/apache/lucene/codecs/simpletext/SimpleTextKnnVectorsReader.java
+++ b/lucene/codecs/src/java/org/apache/lucene/codecs/simpletext/SimpleTextKnnVectorsReader.java
@@ -46,7 +46,6 @@ import org.apache.lucene.util.Bits;
import org.apache.lucene.util.BytesRef;
import org.apache.lucene.util.BytesRefBuilder;
import org.apache.lucene.util.IOUtils;
-import org.apache.lucene.util.RamUsageEstimator;
import org.apache.lucene.util.StringHelper;
import org.apache.lucene.util.hnsw.RandomAccessVectorValues;
@@ -58,9 +57,6 @@ import org.apache.lucene.util.hnsw.RandomAccessVectorValues;
*/
public class SimpleTextKnnVectorsReader extends KnnVectorsReader {
// shallowSizeOfInstance for fieldEntries map is included in ramBytesUsed() calculation
- private static final long BASE_RAM_BYTES_USED =
- RamUsageEstimator.shallowSizeOfInstance(SimpleTextKnnVectorsReader.class)
- + RamUsageEstimator.shallowSizeOfInstance(BytesRef.class);
private static final BytesRef EMPTY = new BytesRef("");
@@ -274,20 +270,6 @@ public class SimpleTextKnnVectorsReader extends KnnVectorsReader {
}
}
- @Override
- public long ramBytesUsed() {
- // mirror implementation of Lucene90VectorReader#ramBytesUsed
- long totalBytes = BASE_RAM_BYTES_USED;
- totalBytes += RamUsageEstimator.sizeOf(scratch.bytes());
- totalBytes +=
- RamUsageEstimator.sizeOfMap(
- fieldEntries, RamUsageEstimator.shallowSizeOfInstance(FieldEntry.class));
- for (FieldEntry entry : fieldEntries.values()) {
- totalBytes += RamUsageEstimator.sizeOf(entry.ordToDoc);
- }
- return totalBytes;
- }
-
@Override
public void close() throws IOException {
dataIn.close();
diff --git a/lucene/core/src/java/org/apache/lucene/codecs/KnnVectorsFormat.java b/lucene/core/src/java/org/apache/lucene/codecs/KnnVectorsFormat.java
index cdb74341959..840d3242c03 100644
--- a/lucene/core/src/java/org/apache/lucene/codecs/KnnVectorsFormat.java
+++ b/lucene/core/src/java/org/apache/lucene/codecs/KnnVectorsFormat.java
@@ -131,11 +131,6 @@ public abstract class KnnVectorsFormat implements NamedSPILoader.NamedSPI {
@Override
public void close() {}
-
- @Override
- public long ramBytesUsed() {
- return 0;
- }
};
}
diff --git a/lucene/core/src/java/org/apache/lucene/codecs/KnnVectorsReader.java b/lucene/core/src/java/org/apache/lucene/codecs/KnnVectorsReader.java
index 96530395861..e054ebeb2bb 100644
--- a/lucene/core/src/java/org/apache/lucene/codecs/KnnVectorsReader.java
+++ b/lucene/core/src/java/org/apache/lucene/codecs/KnnVectorsReader.java
@@ -26,11 +26,10 @@ import org.apache.lucene.search.KnnCollector;
import org.apache.lucene.search.ScoreDoc;
import org.apache.lucene.search.TopDocs;
import org.apache.lucene.search.TotalHits;
-import org.apache.lucene.util.Accountable;
import org.apache.lucene.util.Bits;
/** Reads vectors from an index. */
-public abstract class KnnVectorsReader implements Closeable, Accountable {
+public abstract class KnnVectorsReader implements Closeable {
/** Sole constructor */
protected KnnVectorsReader() {}
diff --git a/lucene/core/src/java/org/apache/lucene/codecs/perfield/PerFieldKnnVectorsFormat.java b/lucene/core/src/java/org/apache/lucene/codecs/perfield/PerFieldKnnVectorsFormat.java
index d84e0f7b1c9..3c56413688d 100644
--- a/lucene/core/src/java/org/apache/lucene/codecs/perfield/PerFieldKnnVectorsFormat.java
+++ b/lucene/core/src/java/org/apache/lucene/codecs/perfield/PerFieldKnnVectorsFormat.java
@@ -286,15 +286,6 @@ public abstract class PerFieldKnnVectorsFormat extends KnnVectorsFormat {
public void close() throws IOException {
IOUtils.close(fields.values());
}
-
- @Override
- public long ramBytesUsed() {
- long total = 0;
- for (KnnVectorsReader reader : fields.values()) {
- total += reader.ramBytesUsed();
- }
- return total;
- }
}
static String getSuffix(String formatName, String suffix) {
diff --git a/lucene/core/src/java/org/apache/lucene/index/SlowCodecReaderWrapper.java b/lucene/core/src/java/org/apache/lucene/index/SlowCodecReaderWrapper.java
index 81a3dcd6908..138995a2352 100644
--- a/lucene/core/src/java/org/apache/lucene/index/SlowCodecReaderWrapper.java
+++ b/lucene/core/src/java/org/apache/lucene/index/SlowCodecReaderWrapper.java
@@ -191,11 +191,6 @@ public final class SlowCodecReaderWrapper {
@Override
public void close() {}
-
- @Override
- public long ramBytesUsed() {
- return 0L;
- }
};
}
diff --git a/lucene/core/src/java/org/apache/lucene/index/SlowCompositeCodecReaderWrapper.java b/lucene/core/src/java/org/apache/lucene/index/SlowCompositeCodecReaderWrapper.java
index 0376f1e6243..d67d7daa963 100644
--- a/lucene/core/src/java/org/apache/lucene/index/SlowCompositeCodecReaderWrapper.java
+++ b/lucene/core/src/java/org/apache/lucene/index/SlowCompositeCodecReaderWrapper.java
@@ -823,15 +823,6 @@ final class SlowCompositeCodecReaderWrapper extends CodecReader {
IOUtils.close(readers);
}
- @Override
- public long ramBytesUsed() {
- long ramBytesUsed = 0;
- for (KnnVectorsReader reader : readers) {
- ramBytesUsed += reader.ramBytesUsed();
- }
- return ramBytesUsed;
- }
-
@Override
public void checkIntegrity() throws IOException {
for (KnnVectorsReader reader : readers) {
diff --git a/lucene/core/src/java/org/apache/lucene/index/SortingCodecReader.java b/lucene/core/src/java/org/apache/lucene/index/SortingCodecReader.java
index 6a50b06d35a..b6bc6bd5234 100644
--- a/lucene/core/src/java/org/apache/lucene/index/SortingCodecReader.java
+++ b/lucene/core/src/java/org/apache/lucene/index/SortingCodecReader.java
@@ -520,11 +520,6 @@ public final class SortingCodecReader extends FilterCodecReader {
public void close() throws IOException {
delegate.close();
}
-
- @Override
- public long ramBytesUsed() {
- return delegate.ramBytesUsed();
- }
};
}
diff --git a/lucene/test-framework/src/java/org/apache/lucene/tests/codecs/asserting/AssertingKnnVectorsFormat.java b/lucene/test-framework/src/java/org/apache/lucene/tests/codecs/asserting/AssertingKnnVectorsFormat.java
index 62aca64b57e..73ec496b562 100644
--- a/lucene/test-framework/src/java/org/apache/lucene/tests/codecs/asserting/AssertingKnnVectorsFormat.java
+++ b/lucene/test-framework/src/java/org/apache/lucene/tests/codecs/asserting/AssertingKnnVectorsFormat.java
@@ -171,11 +171,6 @@ public class AssertingKnnVectorsFormat extends KnnVectorsFormat {
delegate.close();
}
- @Override
- public long ramBytesUsed() {
- return delegate.ramBytesUsed();
- }
-
@Override
public HnswGraph getGraph(String field) throws IOException {
return ((HnswGraphProvider) delegate).getGraph(field);