Apache Lucene open-source search software
Speed up vint/vlong decoding (#15065)
Trevor McCulloch955d183a8520
diff --git a/lucene/benchmark-jmh/src/java/org/apache/lucene/benchmark/jmh/VIntBenchmark.java b/lucene/benchmark-jmh/src/java/org/apache/lucene/benchmark/jmh/VIntBenchmark.javanew file mode 100644index 00000000000..686ebb26142--- /dev/null+++ b/lucene/benchmark-jmh/src/java/org/apache/lucene/benchmark/jmh/VIntBenchmark.java@@ -0,0 +1,171 @@+/*+ * 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.Files;+import java.util.Arrays;+import java.util.Random;+import java.util.concurrent.TimeUnit;+import org.apache.lucene.store.ByteArrayDataInput;+import org.apache.lucene.store.ByteArrayDataOutput;+import org.apache.lucene.store.Directory;+import org.apache.lucene.store.IOContext;+import org.apache.lucene.store.IndexInput;+import org.apache.lucene.store.IndexOutput;+import org.apache.lucene.store.MMapDirectory;+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.Warmup;+import org.openjdk.jmh.infra.Blackhole;++@BenchmarkMode(Mode.Throughput)+@OutputTimeUnit(TimeUnit.MICROSECONDS)+@State(Scope.Benchmark)+@Warmup(iterations = 3, time = 3)+@Measurement(iterations = 5, time = 5)+@Fork(+ value = 1,+ jvmArgsPrepend = {"--add-modules=jdk.unsupported"})+public class VIntBenchmark {++ // Cumulative frequency for each number of bits per value used by doc deltas of tail postings on+ // wikibigall.+ private static final float[] CUMULATIVE_FREQUENCY_BY_BITS_REQUIRED =+ new float[] {+ 0.0f,+ 0.01026574f,+ 0.021453038f,+ 0.03342156f,+ 0.046476692f,+ 0.060890317f,+ 0.07644147f,+ 0.093718216f,+ 0.11424741f,+ 0.13989712f,+ 0.17366524f,+ 0.22071244f,+ 0.2815692f,+ 0.3537585f,+ 0.43655503f,+ 0.52308f,+ 0.6104675f,+ 0.7047371f,+ 0.78155357f,+ 0.8671179f,+ 0.9740598f,+ 1.0f+ };++ final int maxSize = 256;+ final long[] values = new long[maxSize];++ IndexInput mmapVIntIn;+ IndexInput mmapVLongIn;+ ByteArrayDataInput byteArrayVIntIn;+ ByteArrayDataInput byteArrayVLongIn;++ @Param({"64"})+ public int size;++ ByteArrayDataInput initArrayInput(long[] docs) throws Exception {+ byte[] vIntBytes = new byte[Long.BYTES * maxSize * 2];+ ByteArrayDataOutput vIntOut = new ByteArrayDataOutput(vIntBytes);+ for (long v : docs) {+ vIntOut.writeVInt((int) v);+ }+ return new ByteArrayDataInput(vIntBytes);+ }++ IndexInput initMMapInput(long[] docs) throws Exception {+ Directory dir = new MMapDirectory(Files.createTempDirectory("groupvintdata"));+ IndexOutput vintOut = dir.createOutput("vint", IOContext.DEFAULT);+ for (long v : docs) {+ vintOut.writeVInt((int) v);+ }+ vintOut.close();+ return dir.openInput("vint", IOContext.DEFAULT);+ }++ @Setup(Level.Trial)+ public void init() throws Exception {+ Random r = new Random(0);+ long[] docs = new long[maxSize];+ long[] docsLong = new long[maxSize];+ for (int i = 0; i < maxSize; ++i) {+ float randomFloat = r.nextFloat();+ // Reproduce the distribution of the number of bits per values that we're observing for tail+ // postings on wikibigall.+ int numBits = 1 + Arrays.binarySearch(CUMULATIVE_FREQUENCY_BY_BITS_REQUIRED, randomFloat);+ if (numBits < 0) {+ numBits = -numBits;+ }+ docs[i] = r.nextInt(1 << (numBits - 1), 1 << numBits);+ numBits *= 2;+ docsLong[i] = r.nextLong(1L << (numBits - 1), 1L << numBits);+ }+ mmapVIntIn = initMMapInput(docs);+ mmapVLongIn = initMMapInput(docsLong);+ byteArrayVIntIn = initArrayInput(docs);+ byteArrayVLongIn = initArrayInput(docsLong);+ }++ @Benchmark+ public void benchMMapDirectoryInputs_readVInt(Blackhole bh) throws IOException {+ mmapVIntIn.seek(0);+ for (int i = 0; i < size; i++) {+ values[i] = mmapVIntIn.readVInt();+ }+ bh.consume(values);+ }++ @Benchmark+ public void benchByteArrayDataInput_readVInt(Blackhole bh) {+ byteArrayVIntIn.rewind();+ for (int i = 0; i < size; i++) {+ values[i] = byteArrayVIntIn.readVInt();+ }+ bh.consume(values);+ }++ @Benchmark+ public void benchMMapDirectoryInputs_readVLong(Blackhole bh) throws IOException {+ mmapVLongIn.seek(0);+ for (int i = 0; i < size; i++) {+ values[i] = mmapVLongIn.readVLong();+ }+ bh.consume(values);+ }++ @Benchmark+ public void benchByteArrayDataInput_readVLong(Blackhole bh) {+ byteArrayVLongIn.rewind();+ for (int i = 0; i < size; i++) {+ values[i] = byteArrayVLongIn.readVLong();+ }+ bh.consume(values);+ }+}diff --git a/lucene/core/src/java/org/apache/lucene/store/DataInput.java b/lucene/core/src/java/org/apache/lucene/store/DataInput.javaindex 369b631426b..e70ad295cfd 100644--- a/lucene/core/src/java/org/apache/lucene/store/DataInput.java+++ b/lucene/core/src/java/org/apache/lucene/store/DataInput.java@@ -118,11 +118,13 @@ public abstract class DataInput implements Cloneable {* @see DataOutput#writeVInt(int)*/public int readVInt() throws IOException {- byte b = readByte();- int i = b & 0x7F;- for (int shift = 7; (b & 0x80) != 0; shift += 7) {- b = readByte();+ int i = 0;+ for (int shift = 0; shift < 32; shift += 7) {+ byte b = readByte();i |= (b & 0x7F) << shift;+ if ((b & 0x80) == 0) {+ break;+ }}return i;}@@ -196,11 +198,14 @@ public abstract class DataInput implements Cloneable {* @see DataOutput#writeVLong(long)*/public long readVLong() throws IOException {- byte b = readByte();- long i = b & 0x7F;- for (int shift = 7; (b & 0x80) != 0; shift += 7) {- b = readByte();- i |= (b & 0x7FL) << shift;+ long i = 0;+ // NB: we may be called internally to decode negative (10 byte) values.+ for (int shift = 0; shift < 64; shift += 7) {+ byte b = readByte();+ i |= (long) (b & 0x7F) << shift;+ if ((b & 0x80) == 0) {+ break;+ }}return i;}