-
Notifications
You must be signed in to change notification settings - Fork 25k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Lazily load soft-deletes for searchable snapshot shards (#69203)
Opening a Lucene index that supports soft-deletes currently creates the liveDocs bitset eagerly. This requires scanning the doc values to materialize the liveDocs bitset from the soft-delete doc values. In order for searchable snapshot shards to be available for searches as quickly as possible (i.e. on recovery, or in case of FrozenEngine whenever a search comes in), they should read as little as possible from the Lucene files. This commit introduces a LazySoftDeletesDirectoryReaderWrapper, a variant of Lucene's SoftDeletesDirectoryReaderWrapper that loads the livedocs bitset lazily on first access. It is special-tailored to ReadOnlyEngine / FrozenEngine as it only operates on non-NRT readers.
- Loading branch information
Showing
18 changed files
with
569 additions
and
41 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
259 changes: 259 additions & 0 deletions
259
server/src/main/java/org/apache/lucene/index/LazySoftDeletesDirectoryReaderWrapper.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,259 @@ | ||
| /* | ||
| * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
| * or more contributor license agreements. Licensed under the Elastic License | ||
| * 2.0 and the Server Side Public License, v 1; you may not use this file except | ||
| * in compliance with, at your election, the Elastic License 2.0 or the Server | ||
| * Side Public License, v 1. | ||
| */ | ||
|
|
||
| package org.apache.lucene.index; | ||
|
|
||
| import org.apache.lucene.document.Field; | ||
| import org.apache.lucene.search.DocIdSetIterator; | ||
| import org.apache.lucene.search.DocValuesFieldExistsQuery; | ||
| import org.apache.lucene.util.Bits; | ||
| import org.apache.lucene.util.FixedBitSet; | ||
| import org.elasticsearch.common.lucene.Lucene; | ||
|
|
||
| import java.io.IOException; | ||
| import java.io.UncheckedIOException; | ||
| import java.util.ArrayList; | ||
| import java.util.List; | ||
| import java.util.Objects; | ||
|
|
||
| /** | ||
| * This is a modified version of {@link SoftDeletesDirectoryReaderWrapper} that materializes the liveDocs | ||
| * bitset lazily. In contrast to {@link SoftDeletesDirectoryReaderWrapper}, this wrapper can only be used | ||
| * for non-NRT readers. | ||
| * | ||
| * This reader filters out documents that have a doc values value in the given field and treat these | ||
| * documents as soft deleted. Hard deleted documents will also be filtered out in the live docs of this reader. | ||
| * @see IndexWriterConfig#setSoftDeletesField(String) | ||
| * @see IndexWriter#softUpdateDocument(Term, Iterable, Field...) | ||
| * @see SoftDeletesRetentionMergePolicy | ||
| */ | ||
| public final class LazySoftDeletesDirectoryReaderWrapper extends FilterDirectoryReader { | ||
| private final CacheHelper readerCacheHelper; | ||
| /** | ||
| * Creates a new soft deletes wrapper. | ||
| * @param in the incoming directory reader | ||
| * @param field the soft deletes field | ||
| */ | ||
| public LazySoftDeletesDirectoryReaderWrapper(DirectoryReader in, String field) throws IOException { | ||
| super(in, new LazySoftDeletesSubReaderWrapper(field)); | ||
| readerCacheHelper = in.getReaderCacheHelper() == null ? null : new DelegatingCacheHelper(in.getReaderCacheHelper()); | ||
| } | ||
|
|
||
| @Override | ||
| protected DirectoryReader doWrapDirectoryReader(DirectoryReader in) throws IOException { | ||
| throw new UnsupportedOperationException(); | ||
| } | ||
|
|
||
| @Override | ||
| public CacheHelper getReaderCacheHelper() { | ||
| return readerCacheHelper; | ||
| } | ||
|
|
||
| private static class LazySoftDeletesSubReaderWrapper extends SubReaderWrapper { | ||
| private final String field; | ||
|
|
||
| LazySoftDeletesSubReaderWrapper(String field) { | ||
| Objects.requireNonNull(field, "Field must not be null"); | ||
| this.field = field; | ||
| } | ||
|
|
||
| @Override | ||
| protected LeafReader[] wrap(List<? extends LeafReader> readers) { | ||
| List<LeafReader> wrapped = new ArrayList<>(readers.size()); | ||
| for (LeafReader reader : readers) { | ||
| LeafReader wrap = wrap(reader); | ||
| assert wrap != null; | ||
| if (wrap.numDocs() != 0) { | ||
| wrapped.add(wrap); | ||
| } | ||
| } | ||
| return wrapped.toArray(new LeafReader[0]); | ||
| } | ||
|
|
||
| @Override | ||
| public LeafReader wrap(LeafReader reader) { | ||
| return LazySoftDeletesDirectoryReaderWrapper.wrap(reader, field); | ||
| } | ||
| } | ||
|
|
||
| static LeafReader wrap(LeafReader reader, String field) { | ||
| final SegmentReader segmentReader = Lucene.segmentReader(reader); | ||
| assert segmentReader.isNRT == false : "expected non-NRT reader"; | ||
| final SegmentCommitInfo segmentInfo = segmentReader.getSegmentInfo(); | ||
| final int numSoftDeletes = segmentInfo.getSoftDelCount(); | ||
| if (numSoftDeletes == 0) { | ||
| return reader; | ||
| } | ||
| final int maxDoc = reader.maxDoc(); | ||
| final int numDocs = maxDoc - segmentInfo.getDelCount() - segmentInfo.getSoftDelCount(); | ||
| final LazyBits lazyBits = new LazyBits(maxDoc, field, reader, numSoftDeletes, numDocs); | ||
| return reader instanceof CodecReader ? new LazySoftDeletesFilterCodecReader((CodecReader) reader, lazyBits, numDocs) | ||
| : new LazySoftDeletesFilterLeafReader(reader, lazyBits, numDocs); | ||
| } | ||
|
|
||
| public static final class LazySoftDeletesFilterLeafReader extends FilterLeafReader { | ||
| private final LeafReader reader; | ||
| private final LazyBits bits; | ||
| private final int numDocs; | ||
| private final CacheHelper readerCacheHelper; | ||
|
|
||
| public LazySoftDeletesFilterLeafReader(LeafReader reader, LazyBits bits, int numDocs) { | ||
| super(reader); | ||
| this.reader = reader; | ||
| this.bits = bits; | ||
| this.numDocs = numDocs; | ||
| this.readerCacheHelper = reader.getReaderCacheHelper() == null ? null : | ||
| new DelegatingCacheHelper(reader.getReaderCacheHelper()); | ||
| } | ||
|
|
||
| @Override | ||
| public LazyBits getLiveDocs() { | ||
| return bits; | ||
| } | ||
|
|
||
| @Override | ||
| public int numDocs() { | ||
| return numDocs; | ||
| } | ||
|
|
||
| @Override | ||
| public CacheHelper getCoreCacheHelper() { | ||
| return reader.getCoreCacheHelper(); | ||
| } | ||
|
|
||
| @Override | ||
| public CacheHelper getReaderCacheHelper() { | ||
| return readerCacheHelper; | ||
| } | ||
| } | ||
|
|
||
| public static final class LazySoftDeletesFilterCodecReader extends FilterCodecReader { | ||
| private final LeafReader reader; | ||
| private final LazyBits bits; | ||
| private final int numDocs; | ||
| private final CacheHelper readerCacheHelper; | ||
|
|
||
| public LazySoftDeletesFilterCodecReader(CodecReader reader, LazyBits bits, int numDocs) { | ||
| super(reader); | ||
| this.reader = reader; | ||
| this.bits = bits; | ||
| this.numDocs = numDocs; | ||
| this.readerCacheHelper = reader.getReaderCacheHelper() == null ? null : | ||
| new DelegatingCacheHelper(reader.getReaderCacheHelper()); | ||
| } | ||
|
|
||
| @Override | ||
| public LazyBits getLiveDocs() { | ||
| return bits; | ||
| } | ||
|
|
||
| @Override | ||
| public int numDocs() { | ||
| return numDocs; | ||
| } | ||
|
|
||
| @Override | ||
| public CacheHelper getCoreCacheHelper() { | ||
| return reader.getCoreCacheHelper(); | ||
| } | ||
|
|
||
| @Override | ||
| public CacheHelper getReaderCacheHelper() { | ||
| return readerCacheHelper; | ||
| } | ||
| } | ||
|
|
||
| private static class DelegatingCacheHelper implements CacheHelper { | ||
| private final CacheHelper delegate; | ||
| private final CacheKey cacheKey = new CacheKey(); | ||
|
|
||
| DelegatingCacheHelper(CacheHelper delegate) { | ||
| this.delegate = delegate; | ||
| } | ||
|
|
||
| @Override | ||
| public CacheKey getKey() { | ||
| return cacheKey; | ||
| } | ||
|
|
||
| @Override | ||
| public void addClosedListener(ClosedListener listener) { | ||
| // here we wrap the listener and call it with our cache key | ||
| // this is important since this key will be used to cache the reader and otherwise we won't free caches etc. | ||
| delegate.addClosedListener(unused -> listener.onClose(cacheKey)); | ||
| } | ||
| } | ||
|
|
||
| public static class LazyBits implements Bits { | ||
|
|
||
| private final int maxDoc; | ||
| private final String field; | ||
| private final LeafReader reader; | ||
| private final int numSoftDeletes; | ||
| private final int numDocs; | ||
| volatile Bits materializedBits; | ||
|
|
||
| public LazyBits(int maxDoc, String field, LeafReader reader, int numSoftDeletes, int numDocs) { | ||
| this.maxDoc = maxDoc; | ||
| this.field = field; | ||
| this.reader = reader; | ||
| this.numSoftDeletes = numSoftDeletes; | ||
| this.numDocs = numDocs; | ||
| materializedBits = null; | ||
| assert numSoftDeletes > 0; | ||
| } | ||
|
|
||
| @Override | ||
| public boolean get(int index) { | ||
| if (materializedBits == null) { | ||
| synchronized (this) { | ||
| try { | ||
| if (materializedBits == null) { | ||
| materializedBits = init(); | ||
| } | ||
| } catch (IOException e) { | ||
| throw new UncheckedIOException(e); | ||
| } | ||
| } | ||
| } | ||
| return materializedBits.get(index); | ||
| } | ||
|
|
||
| @Override | ||
| public int length() { | ||
| return maxDoc; | ||
| } | ||
|
|
||
| private Bits init() throws IOException { | ||
| assert Thread.holdsLock(this); | ||
|
|
||
| DocIdSetIterator iterator = DocValuesFieldExistsQuery.getDocValuesDocIdSetIterator(field, reader); | ||
| assert iterator != null; | ||
| Bits liveDocs = reader.getLiveDocs(); | ||
| final FixedBitSet bits; | ||
| if (liveDocs != null) { | ||
| bits = FixedBitSet.copyOf(liveDocs); | ||
| } else { | ||
| bits = new FixedBitSet(maxDoc); | ||
| bits.set(0, maxDoc); | ||
| } | ||
| int numComputedSoftDeletes = PendingSoftDeletes.applySoftDeletes(iterator, bits); | ||
| assert numComputedSoftDeletes == numSoftDeletes : | ||
| "numComputedSoftDeletes: " + numComputedSoftDeletes + " expected: " + numSoftDeletes; | ||
|
|
||
| int numDeletes = reader.numDeletedDocs() + numComputedSoftDeletes; | ||
| int computedNumDocs = reader.maxDoc() - numDeletes; | ||
| assert computedNumDocs == numDocs : "computedNumDocs: " + computedNumDocs + " expected: " + numDocs; | ||
| return bits; | ||
| } | ||
|
|
||
| public boolean initialized() { | ||
| return materializedBits != null; | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.