Skip to content

SAI-5884: Unload unused Fields|DocValues Producers #38

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 12 commits into
base: fs/branch_9_11
Choose a base branch
from
Open

SAI-5884: Unload unused Fields|DocValues Producers #38

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
dd8542b
Allow unused FieldsProducers and DocValuesProducers to be unloaded
magibney Oct 10, 2025
e89c1a5
add test
magibney Oct 10, 2025
7420c74
fix tests -- mostly around Directory closing
magibney Oct 10, 2025
b6fabe6
allow backing val to be GC'd
magibney Oct 14, 2025
a1d1185
safer one-time set of external refqueue handling
magibney Oct 14, 2025
4e76298
reorder field assignments in Unloader ctor (NPE, etc.)
magibney Oct 15, 2025
826da66
Unloader ctor should hold a ref to prevent immediate collection
magibney Oct 15, 2025
4946d5c
also unload PointsReader
magibney Oct 16, 2025
e77fb9b
sysprop-configurable totally disable unloading
magibney Oct 17, 2025
dee742d
must incRef before derivative refs
magibney Oct 20, 2025
b14f3e1
use explicit method to prevent dead ref GC
magibney Oct 20, 2025
c236ad0
always track the _raw_ instance
magibney Oct 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/gradle-precommit.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ jobs:
uses: ./.github/actions/gradle-caches

- name: Run gradle check (without tests)
run: ./gradlew check -x test -Ptask.times=true --max-workers 2
run: ./gradlew check -x test -Ptask.times=true --max-workers 2 -x :lucene:analysis.tests:renderJavadoc -x :lucene:distribution.tests:renderJavadoc -x :lucene:analysis:morfologik.tests:renderJavadoc

# This runs all tests without any other validation checks.
tests:
Expand Down Expand Up @@ -74,7 +74,7 @@ jobs:
uses: ./.github/actions/gradle-caches

- name: Run gradle tests
run: ./gradlew test "-Ptask.times=true" --max-workers 2
run: ./gradlew test "-Ptask.times=true" -Plucene.unload.executorPerDirectory=true -Plucene.unload.ttl=1 -Plucene.unload.initial=0 --max-workers 2

- name: Echo settings
run: cat gradle.properties
3 changes: 3 additions & 0 deletions gradle/testing/defaults-tests.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,9 @@ allprojects {
// completes.
// [propName: 'tests.foo', value: "bar", description: "Sets foo in tests."],
testOptions = [
[propName: 'lucene.unload.executorPerDirectory', value: false, description: "Directory instances supply their own unloading executor"],
[propName: 'lucene.unload.ttl', value: '60m', description: "Time since last use at which a resource becomes eligible for unloading"],
[propName: 'lucene.unload.initial', value: '1m', description: "Extra time allotted for first resource use after load/reload"],
// asserts, debug output.
[propName: 'tests.verbose', value: false, description: "Enables verbose mode (emits full test outputs immediately)."],
[propName: 'tests.workDir',
Expand Down
9 changes: 7 additions & 2 deletions lucene/core/src/java/org/apache/lucene/index/SegmentCoreReaders.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
import org.apache.lucene.codecs.FieldsProducer;
import org.apache.lucene.codecs.KnnVectorsReader;
import org.apache.lucene.codecs.NormsProducer;
import org.apache.lucene.codecs.PointsFormat;
import org.apache.lucene.codecs.PointsReader;
import org.apache.lucene.codecs.PostingsFormat;
import org.apache.lucene.codecs.StoredFieldsReader;
Expand Down Expand Up @@ -116,7 +117,9 @@ protected TermVectorsReader initialValue() {
if (coreFieldInfos.hasPostings()) {
final PostingsFormat format = codec.postingsFormat();
// Ask codec for its Fields
fields = format.fieldsProducer(segmentReadState);
fields =
Unloader.fieldsProducer(
() -> format.fieldsProducer(segmentReadState), dir, segmentReadState);
assert fields != null;
} else {
fields = null;
Expand Down Expand Up @@ -149,7 +152,9 @@ protected TermVectorsReader initialValue() {
}

if (coreFieldInfos.hasPointValues()) {
pointsReader = codec.pointsFormat().fieldsReader(segmentReadState);
PointsFormat pf = codec.pointsFormat();
pointsReader =
Unloader.pointsReader(() -> pf.fieldsReader(segmentReadState), dir, segmentReadState);
} else {
pointsReader = null;
}
Expand Down
3 changes: 2 additions & 1 deletion lucene/core/src/java/org/apache/lucene/index/SegmentDocValues.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,8 @@ private RefCount<DocValuesProducer> newDocValuesProducer(
SegmentReadState srs =
new SegmentReadState(dvDir, si.info, infos, IOContext.READ, segmentSuffix);
DocValuesFormat dvFormat = si.info.getCodec().docValuesFormat();
return new RefCount<DocValuesProducer>(dvFormat.fieldsProducer(srs)) {
return new RefCount<DocValuesProducer>(
Unloader.docValuesProducer(() -> dvFormat.fieldsProducer(srs), si.info.dir, srs)) {
@SuppressWarnings("synthetic-access")
@Override
protected void release() throws IOException {
Expand Down
Loading