costin commented on code in PR #16623: URL: https://github.com/apache/lucene/pull/16623#discussion_r4197778869
########## lucene/benchmark-jmh/src/java/org/apache/lucene/benchmark/jmh/SoftDeletesReaderBenchmark.java: ########## @@ -0,0 +1,131 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.lucene.benchmark.jmh; + +import java.io.IOException; +import java.nio.file.Path; +import java.util.concurrent.TimeUnit; +import org.apache.lucene.document.Document; +import org.apache.lucene.document.Field; +import org.apache.lucene.document.NumericDocValuesField; +import org.apache.lucene.document.StringField; +import org.apache.lucene.index.DirectoryReader; +import org.apache.lucene.index.IndexWriter; +import org.apache.lucene.index.IndexWriterConfig; +import org.apache.lucene.index.LeafReaderContext; +import org.apache.lucene.index.SoftDeletesDirectoryReaderWrapper; +import org.apache.lucene.index.Term; +import org.apache.lucene.store.Directory; +import org.apache.lucene.store.MMapDirectory; +import org.apache.lucene.util.Bits; +import org.apache.lucene.util.IOUtils; +import org.openjdk.jmh.annotations.Benchmark; +import org.openjdk.jmh.annotations.BenchmarkMode; +import org.openjdk.jmh.annotations.Fork; +import org.openjdk.jmh.annotations.Level; +import org.openjdk.jmh.annotations.Measurement; +import org.openjdk.jmh.annotations.Mode; +import org.openjdk.jmh.annotations.OutputTimeUnit; +import org.openjdk.jmh.annotations.Param; +import org.openjdk.jmh.annotations.Scope; +import org.openjdk.jmh.annotations.Setup; +import org.openjdk.jmh.annotations.State; +import org.openjdk.jmh.annotations.TearDown; +import org.openjdk.jmh.annotations.Warmup; + +/** + * Measures the cost of wrapping a reader with {@link SoftDeletesDirectoryReaderWrapper}, which + * calls {@link org.apache.lucene.util.FixedBitSet#copyOf(Bits)} on each leaf's live docs. Since + * #15413, live docs are {@link org.apache.lucene.util.DenseLiveDocs} or {@link + * org.apache.lucene.util.SparseLiveDocs} which fall through to the per-bit generic loop. + */ +@BenchmarkMode(Mode.AverageTime) +@OutputTimeUnit(TimeUnit.MICROSECONDS) +@State(Scope.Benchmark) +@Warmup(iterations = 3, time = 2, timeUnit = TimeUnit.SECONDS) +@Measurement(iterations = 5, time = 3, timeUnit = TimeUnit.SECONDS) +@Fork(value = 3, jvmArgsPrepend = "--add-modules=jdk.incubator.vector") +public class SoftDeletesReaderBenchmark { + + private static final String SOFT_DELETE_FIELD = "__soft_delete"; + + @Param({"200000", "1000000"}) + int numDocs; + + @Param({"0.01", "0.05"}) + double softDeleteRate; + + private Directory dir; + private DirectoryReader baseReader; + private Path tempDir; + + @Setup(Level.Trial) + public void setup() throws Exception { + tempDir = Path.of(System.getProperty("java.io.tmpdir"), "softdel-bench-" + System.nanoTime()); + dir = MMapDirectory.open(tempDir); + + IndexWriterConfig config = + new IndexWriterConfig().setSoftDeletesField(SOFT_DELETE_FIELD).setRAMBufferSizeMB(256); + try (IndexWriter w = new IndexWriter(dir, config)) { + for (int i = 0; i < numDocs; i++) { + Document doc = new Document(); + doc.add(new StringField("id", Integer.toString(i), Field.Store.NO)); + doc.add(new NumericDocValuesField("val", i)); + w.addDocument(doc); + } + w.flush(); + int softDeleted = (int) (numDocs * softDeleteRate); + for (int i = 0; i < softDeleted; i++) { + int docId = (int) (((long) i * 7919) % numDocs); + Document replacement = new Document(); + replacement.add(new StringField("id", Integer.toString(docId), Field.Store.NO)); + replacement.add(new NumericDocValuesField("val", -1)); + w.softUpdateDocument( + new Term("id", Integer.toString(docId)), + replacement, + new NumericDocValuesField(SOFT_DELETE_FIELD, 1)); + } + int hardDeleted = Math.max(1, (int) (numDocs * 0.01)); Review Comment: The hard delete rate is now a @Param (0.5% and 5%), so SoftDeletesReaderBenchmark covers both SparseLiveDocs and DenseLiveDocs. ########## lucene/core/src/test/org/apache/lucene/util/TestLiveDocsCopyOf.java: ########## @@ -0,0 +1,93 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.lucene.util; + +import org.apache.lucene.tests.util.LuceneTestCase; + +/** Tests for {@link LiveDocs#toFixedBitSet()} via {@link FixedBitSet#copyOf(Bits)}. */ +public class TestLiveDocsCopyOf extends LuceneTestCase { + + public void testDenseLiveDocsCopyOf() { + int maxDoc = 1000; + FixedBitSet liveBits = new FixedBitSet(maxDoc); + liveBits.set(0, maxDoc); + // Delete some known positions + liveBits.clear(0); + liveBits.clear(42); + liveBits.clear(999); + + DenseLiveDocs dense = DenseLiveDocs.builder(liveBits, maxDoc).build(); + FixedBitSet copy = FixedBitSet.copyOf(dense); Review Comment: Copies are now checked to be detached from the source, the randomized reference is built from the deleted ids rather than get(), iterations scale with atLeast, and a new testBoundarySizes pins 1/63/64/65/4095/4096/4097 with all-deleted and single-deleted cases. ########## lucene/benchmark-jmh/src/java/org/apache/lucene/benchmark/jmh/SoftDeletesReaderBenchmark.java: ########## @@ -0,0 +1,131 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.lucene.benchmark.jmh; + +import java.io.IOException; +import java.nio.file.Path; +import java.util.concurrent.TimeUnit; +import org.apache.lucene.document.Document; +import org.apache.lucene.document.Field; +import org.apache.lucene.document.NumericDocValuesField; +import org.apache.lucene.document.StringField; +import org.apache.lucene.index.DirectoryReader; +import org.apache.lucene.index.IndexWriter; +import org.apache.lucene.index.IndexWriterConfig; +import org.apache.lucene.index.LeafReaderContext; +import org.apache.lucene.index.SoftDeletesDirectoryReaderWrapper; +import org.apache.lucene.index.Term; +import org.apache.lucene.store.Directory; +import org.apache.lucene.store.MMapDirectory; +import org.apache.lucene.util.Bits; +import org.apache.lucene.util.IOUtils; +import org.openjdk.jmh.annotations.Benchmark; +import org.openjdk.jmh.annotations.BenchmarkMode; +import org.openjdk.jmh.annotations.Fork; +import org.openjdk.jmh.annotations.Level; +import org.openjdk.jmh.annotations.Measurement; +import org.openjdk.jmh.annotations.Mode; +import org.openjdk.jmh.annotations.OutputTimeUnit; +import org.openjdk.jmh.annotations.Param; +import org.openjdk.jmh.annotations.Scope; +import org.openjdk.jmh.annotations.Setup; +import org.openjdk.jmh.annotations.State; +import org.openjdk.jmh.annotations.TearDown; +import org.openjdk.jmh.annotations.Warmup; + +/** + * Measures the cost of wrapping a reader with {@link SoftDeletesDirectoryReaderWrapper}, which + * calls {@link org.apache.lucene.util.FixedBitSet#copyOf(Bits)} on each leaf's live docs. Since + * #15413, live docs are {@link org.apache.lucene.util.DenseLiveDocs} or {@link + * org.apache.lucene.util.SparseLiveDocs} which fall through to the per-bit generic loop. + */ +@BenchmarkMode(Mode.AverageTime) +@OutputTimeUnit(TimeUnit.MICROSECONDS) +@State(Scope.Benchmark) +@Warmup(iterations = 3, time = 2, timeUnit = TimeUnit.SECONDS) +@Measurement(iterations = 5, time = 3, timeUnit = TimeUnit.SECONDS) +@Fork(value = 3, jvmArgsPrepend = "--add-modules=jdk.incubator.vector") +public class SoftDeletesReaderBenchmark { + + private static final String SOFT_DELETE_FIELD = "__soft_delete"; + + @Param({"200000", "1000000"}) + int numDocs; + + @Param({"0.01", "0.05"}) + double softDeleteRate; + + private Directory dir; + private DirectoryReader baseReader; + private Path tempDir; + + @Setup(Level.Trial) + public void setup() throws Exception { + tempDir = Path.of(System.getProperty("java.io.tmpdir"), "softdel-bench-" + System.nanoTime()); + dir = MMapDirectory.open(tempDir); + + IndexWriterConfig config = + new IndexWriterConfig().setSoftDeletesField(SOFT_DELETE_FIELD).setRAMBufferSizeMB(256); + try (IndexWriter w = new IndexWriter(dir, config)) { + for (int i = 0; i < numDocs; i++) { + Document doc = new Document(); + doc.add(new StringField("id", Integer.toString(i), Field.Store.NO)); + doc.add(new NumericDocValuesField("val", i)); + w.addDocument(doc); + } + w.flush(); + int softDeleted = (int) (numDocs * softDeleteRate); + for (int i = 0; i < softDeleted; i++) { + int docId = (int) (((long) i * 7919) % numDocs); + Document replacement = new Document(); + replacement.add(new StringField("id", Integer.toString(docId), Field.Store.NO)); + replacement.add(new NumericDocValuesField("val", -1)); + w.softUpdateDocument( + new Term("id", Integer.toString(docId)), + replacement, + new NumericDocValuesField(SOFT_DELETE_FIELD, 1)); + } + int hardDeleted = Math.max(1, (int) (numDocs * 0.01)); Review Comment: The hard delete rate is now a Param (0.5% and 5%), so SoftDeletesReaderBenchmark covers both SparseLiveDocs and DenseLiveDocs. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
