io.netty.microbench.search.SearchBenchmark Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2020 The Netty Project
 *
 * The Netty Project 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:
 *
 *   https://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 io.netty.microbench.search;

import io.netty.buffer.ByteBuf;
import io.netty.buffer.ByteBufUtil;
import io.netty.buffer.Unpooled;
import io.netty.buffer.search.AbstractMultiSearchProcessorFactory;
import io.netty.buffer.search.AbstractSearchProcessorFactory;
import io.netty.buffer.search.SearchProcessorFactory;
import io.netty.microbench.util.AbstractMicrobenchmark;
import org.openjdk.jmh.annotations.Benchmark;
import org.openjdk.jmh.annotations.CompilerControl;
import org.openjdk.jmh.annotations.CompilerControl.Mode;
import org.openjdk.jmh.annotations.Fork;
import org.openjdk.jmh.annotations.Measurement;
import org.openjdk.jmh.annotations.OutputTimeUnit;
import org.openjdk.jmh.annotations.Param;
import org.openjdk.jmh.annotations.Setup;
import org.openjdk.jmh.annotations.TearDown;
import org.openjdk.jmh.annotations.Warmup;

import java.util.Arrays;
import java.util.Random;
import java.util.concurrent.TimeUnit;

@OutputTimeUnit(TimeUnit.MILLISECONDS)
@Warmup(iterations = 5)
@Measurement(iterations = 5)
@Fork(1)
public class SearchBenchmark extends AbstractMicrobenchmark {

    private static final long SEED = 123;

    public enum Input {
        RANDOM_256B {
            @Override
            byte[] getNeedle(Random rnd) {
                return new byte[] { 'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h' };
            }
            @Override
            byte[] getHaystack(Random rnd) {
                return randomBytes(rnd, 256, ' ', 127);
            }
        },
        RANDOM_2KB {
            @Override
            byte[] getNeedle(Random rnd) {
                return new byte[] { 'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h' };
            }
            @Override
            byte[] getHaystack(Random rnd) {
                return randomBytes(rnd, 2048, ' ', 127);
            }
        },
        PREDICTABLE {
            @Override
            byte[] getNeedle(Random rnd) {
                // all 0s
                return new byte[64];
            }
            @Override
            byte[] getHaystack(Random rnd) {
                // no 0s except in the very end
                byte[] bytes = randomBytes(rnd, 2048, 1, 255);
                Arrays.fill(bytes, bytes.length - 64, bytes.length, (byte) 0);
                return bytes;
            }
        },
        UNPREDICTABLE {
            @Override
            byte[] getNeedle(Random rnd) {
                return randomBytes(rnd, 64, 0, 1);
            }
            @Override
            byte[] getHaystack(Random rnd) {
                return randomBytes(rnd, 2048, 0, 1);
            }
        },
        WORST_CASE { // Bitap will fail on it because the needle is >64 bytes long
            @Override
            byte[] getNeedle(Random rnd) {
                // aa(...)aab
                byte[] needle = new byte[1024];
                Arrays.fill(needle, (byte) 'a');
                needle[needle.length - 1] = 'b';
                return needle;
            }
            @Override
            byte[] getHaystack(Random rnd) {
                // aa(...)aaa
                byte[] haystack = new byte[2048];
                Arrays.fill(haystack, (byte) 'a');
                return haystack;
            }
        };

        abstract byte[] getNeedle(Random rnd);
        abstract byte[] getHaystack(Random rnd);
    }

    @Param
    public Input input;

    @Param
    public ByteBufType bufferType;

    private Random rnd;
    private ByteBuf needle, haystack;
    private byte[] needleBytes, haystackBytes;
    private SearchProcessorFactory kmpFactory, bitapFactory, ahoCorasicFactory;

    @Setup
    public void setup() {
        rnd = new Random(SEED);

        needleBytes = input.getNeedle(rnd);
        haystackBytes = input.getHaystack(rnd);

        needle = Unpooled.wrappedBuffer(needleBytes);
        haystack = bufferType.newBuffer(haystackBytes);

        kmpFactory = AbstractSearchProcessorFactory.newKmpSearchProcessorFactory(needleBytes);
        ahoCorasicFactory = AbstractMultiSearchProcessorFactory.newAhoCorasicSearchProcessorFactory(needleBytes);

        if (needleBytes.length <= 64) {
            bitapFactory = AbstractSearchProcessorFactory.newBitapSearchProcessorFactory(needleBytes);
        }
    }

    @TearDown
    public void teardown() {
        needle.release();
        haystack.release();
    }

    @Benchmark
    @CompilerControl(Mode.DONT_INLINE)
    public int indexOf() {
        return ByteBufUtil.indexOf(needle, haystack);
    }

    @Benchmark
    @CompilerControl(Mode.DONT_INLINE)
    public int kmp() {
        return haystack.forEachByte(kmpFactory.newSearchProcessor());
    }

    @Benchmark
    @CompilerControl(Mode.DONT_INLINE)
    public int bitap() {
        return haystack.forEachByte(bitapFactory.newSearchProcessor());
    }

    @Benchmark
    @CompilerControl(Mode.DONT_INLINE)
    public int ahoCorasic() {
        return haystack.forEachByte(ahoCorasicFactory.newSearchProcessor());
    }

    private static byte[] randomBytes(Random rnd, int size, int from, int to) {
        byte[] bytes = new byte[size];
        for (int i = 0; i < size; i++) {
            bytes[i] = (byte) (from + rnd.nextInt(to - from + 1));
        }
        return bytes;
    }

}