/*
 * Copyright (c) 2014, 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.
 *
 * 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.bench.java.lang.invoke;

import org.openjdk.jmh.annotations.Benchmark;
import org.openjdk.jmh.annotations.BenchmarkMode;
import org.openjdk.jmh.annotations.Fork;
import org.openjdk.jmh.annotations.Measurement;
import org.openjdk.jmh.annotations.Mode;
import org.openjdk.jmh.annotations.OutputTimeUnit;
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 java.lang.invoke.MethodHandle;
import java.lang.invoke.MethodHandles;
import java.lang.invoke.MethodType;
import java.util.concurrent.TimeUnit;

/**
 * Benchmark assesses currying with MethodHandle.bindTo() performance
 */
@BenchmarkMode(Mode.AverageTime)
@OutputTimeUnit(TimeUnit.NANOSECONDS)
@State(Scope.Thread)
@Warmup(iterations = 10, time = 1, timeUnit = TimeUnit.SECONDS)
@Measurement(iterations = 5, time = 2, timeUnit = TimeUnit.SECONDS)
@Fork(3)
public class MethodHandleBindToCurry {

    /*
       Implementation notes:
          - calls static method to avoid binding "this"
          - tests the performance of gradually curried methods, hoping for compiler to optimize
          - arguments are volatile, to break optimistic CSE happening before the actual call
          - using invokeExact and Integers to skip argument conversions
          - baseline includes calling the method directly, and this is known to be super-fast due to inlining
     */

    private MethodHandle mhOrig;
    private MethodHandle mhCurry1;
    private MethodHandle mhCurry2;
    private MethodHandle mhCurry3;

    private volatile Integer arg1 = 1;
    private volatile Integer arg2 = 2;
    private volatile Integer arg3 = 3;

    @Setup
    public void setup() throws Throwable {
        mhOrig = MethodHandles.lookup().findStatic(MethodHandleBindToCurry.class, "doWork",
                MethodType.methodType(int.class, Integer.class, Integer.class, Integer.class));
        mhCurry1 = mhOrig.bindTo(arg1);
        mhCurry2 = mhCurry1.bindTo(arg2);
        mhCurry3 = mhCurry2.bindTo(arg3);
    }

    @Benchmark
    public int baselineRaw() {
        return doWork(arg1, arg2, arg3);
    }

    @Benchmark
    public int testInvoke_C0() throws Throwable {
        return (int) mhOrig.invokeExact(arg1, arg2, arg3);
    }

    @Benchmark
    public int testInvoke_C1() throws Throwable {
        return (int) mhCurry1.invokeExact(arg2, arg3);
    }

    @Benchmark
    public int testInvoke_C2() throws Throwable {
        return (int) mhCurry2.invokeExact(arg3);
    }

    @Benchmark
    public int testInvoke_C3() throws Throwable {
        return (int) mhCurry3.invokeExact();
    }

    public static int doWork(Integer a, Integer b, Integer c) {
        return 31*(31*(31*a + b) + c);
    }

}