ThreadBenchSameThreadTest.java

/*
 * Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */
package org.openjdk.jmh.it.threads;

import org.junit.Assert;
import org.junit.Test;
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.Scope;
import org.openjdk.jmh.annotations.Setup;
import org.openjdk.jmh.annotations.State;
import org.openjdk.jmh.annotations.TearDown;
import org.openjdk.jmh.annotations.Threads;
import org.openjdk.jmh.annotations.Warmup;
import org.openjdk.jmh.it.Fixtures;
import org.openjdk.jmh.runner.Runner;
import org.openjdk.jmh.runner.RunnerException;
import org.openjdk.jmh.runner.options.Options;
import org.openjdk.jmh.runner.options.OptionsBuilder;

import java.util.Collections;
import java.util.HashSet;
import java.util.Set;
import java.util.concurrent.TimeUnit;

/**
 * Tests if harness executes setup, run, and tearDown in the same workers.
 */
@State(Scope.Thread)
public class ThreadBenchSameThreadTest {

    private final Set<Thread> setupRunThread = Collections.synchronizedSet(new HashSet<>());
    private final Set<Thread> setupIterationThread = Collections.synchronizedSet(new HashSet<>());
    private final Set<Thread> setupInvocationThread = Collections.synchronizedSet(new HashSet<>());
    private final Set<Thread> teardownRunThread = Collections.synchronizedSet(new HashSet<>());
    private final Set<Thread> teardownIterationThread = Collections.synchronizedSet(new HashSet<>());
    private final Set<Thread> teardownInvocationThread = Collections.synchronizedSet(new HashSet<>());
    private final Set<Thread> testInvocationThread = Collections.synchronizedSet(new HashSet<>());

    @Setup(Level.Trial)
    public void setupRun() {
        setupRunThread.add(Thread.currentThread());
    }

    @Setup(Level.Iteration)
    public void setupIteration() {
        setupIterationThread.add(Thread.currentThread());
    }

    @Setup(Level.Invocation)
    public void setupInvocation() {
        setupInvocationThread.add(Thread.currentThread());
    }

    @TearDown(Level.Trial)
    public void tearDownRun() {
        teardownRunThread.add(Thread.currentThread());

        // Threads can change iteration to iteration
        if (Fixtures.expectStableThreads()) {
            Assert.assertEquals("test == setupRun",      testInvocationThread, setupRunThread);
            Assert.assertEquals("test == teardownRun",   testInvocationThread, teardownRunThread);
        } else {
            Assert.assertTrue("test <: setupRun",           testInvocationThread.containsAll(setupRunThread));
            Assert.assertTrue("test <: teardownRunThread",  testInvocationThread.containsAll(teardownRunThread));
        }
    }

    @TearDown(Level.Iteration)
    public void tearDownIteration() {
        teardownIterationThread.add(Thread.currentThread());

        // Within iteration, expect the same thread
        Assert.assertEquals("test == setupIteration",     testInvocationThread, setupIterationThread);
        Assert.assertEquals("test == teardownIteration",  testInvocationThread, teardownIterationThread);
        Assert.assertEquals("test == setupInvocation",    testInvocationThread, setupInvocationThread);
        Assert.assertEquals("test == teardownInvocation", testInvocationThread, teardownInvocationThread);
    }

    @TearDown(Level.Invocation)
    public void tearDownInvocation() {
        teardownInvocationThread.add(Thread.currentThread());
    }

    @Benchmark
    @BenchmarkMode(Mode.All)
    @Warmup(iterations = 0)
    @Measurement(iterations = 5, time = 100, timeUnit = TimeUnit.MILLISECONDS)
    @Fork(1)
    @Threads(4)
    public void test() {
        testInvocationThread.add(Thread.currentThread());
        Fixtures.work();
    }

    @Test
    public void invokeAPI() throws RunnerException {
        for (int c = 0; c < Fixtures.repetitionCount(); c++) {
            Options opt = new OptionsBuilder()
                    .include(Fixtures.getTestMask(this.getClass()))
                    .shouldFailOnError(true)
                    .build();
            new Runner(opt).run();
        }
    }

}