xref: /JGit/tools/bzl/jmh.bzl (revision 7554bdfad5be0eff0b95dcfcec11a2cb19883b18)
1# Copyright (C) 2019, Matthias Sohn <matthias.sohn@sap.com>
2# and other copyright owners as documented in the project's IP log.
3#
4# This program and the accompanying materials are made available
5# under the terms of the Eclipse Distribution License v1.0 which
6# accompanies this distribution, is reproduced below, and is
7# available at http://www.eclipse.org/org/documents/edl-v10.php
8#
9# All rights reserved.
10#
11# Redistribution and use in source and binary forms, with or
12# without modification, are permitted provided that the following
13# conditions are met:
14#
15# - Redistributions of source code must retain the above copyright
16#   notice, this list of conditions and the following disclaimer.
17#
18# - Redistributions in binary form must reproduce the above
19#   copyright notice, this list of conditions and the following
20#   disclaimer in the documentation and/or other materials provided
21#   with the distribution.
22#
23# - Neither the name of the Eclipse Foundation, Inc. nor the
24#   names of its contributors may be used to endorse or promote
25#   products derived from this software without specific prior
26#   written permission.
27#
28# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
29# CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
30# INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
31# OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
32# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
33# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
34# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
35# NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
36# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
37# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
38# STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
39# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
40# ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
41
42# Definitions to run jmh microbenchmarks
43
44load("@rules_java//java:defs.bzl", "java_binary", "java_plugin")
45
46def jmh_java_benchmarks(name, srcs, deps = [], tags = [], plugins = [], **kwargs):
47    """Builds runnable JMH benchmarks.
48    This rule builds a runnable target for one or more JMH benchmarks
49    specified as srcs. It takes the same arguments as java_binary,
50    except for main_class.
51    """
52    plugin_name = "_{}_jmh_annotation_processor".format(name)
53    java_plugin(
54        name = plugin_name,
55        deps = ["//lib/jmh:jmh"],
56        processor_class = "org.openjdk.jmh.generators.BenchmarkProcessor",
57        visibility = ["//visibility:private"],
58        tags = tags,
59    )
60    java_binary(
61        name = name,
62        srcs = srcs,
63        main_class = "org.openjdk.jmh.Main",
64        deps = deps + ["//lib/jmh:jmh"],
65        plugins = plugins + [plugin_name],
66        tags = tags,
67        **kwargs
68    )
69