https://renaissance.dev/docs

1
2<!DOCTYPE html>
3<html>
4
5<head>
6  <meta charset=utf-8 />
7  <title>Documentation | Renaissance Suite</title>
8  <meta name="keywords" content="benchmarks, JVM, benchmarking suite, concurrency, parallelism, modern" />
9  <meta name="description" content="The next-generation benchmarking suite for the JVM." />
10  <link rel="apple-touch-icon" sizes="180x180" href="/apple-touch-icon.png">
11  <link rel="icon" type="image/png" sizes="32x32" href="/favicon-32x32.png">
12  <link rel="icon" type="image/png" sizes="16x16" href="/favicon-16x16.png">
13  <link rel="manifest" href="/site.webmanifest">
14  <link rel="mask-icon" href="/safari-pinned-tab.svg" color="#5bbad5">
15  <meta name="msapplication-TileColor" content="#da532c">
16  <meta name="theme-color" content="#ffffff">
17  <link rel="stylesheet" href="/resources/styles/proj.css"/>
18  <link rel="stylesheet" href="/resources/styles/960.css" />
19  <link rel="stylesheet" href="/resources/styles/font-awesome.min.css"/>
20  <link rel="stylesheet" href="/resources/styles/hint.min.css"/>
21  <link rel="stylesheet" href="/resources/js/prettify/prettify3.css"/>
22  <link rel="stylesheet" href="/resources/js/slick-1.6.0/slick/slick.css"/>
23  <link rel="stylesheet" href="/resources/js/slick-1.6.0/slick/slick-theme.css"/>
24  

24<script type='text/javascript' src="/resources/js/easeljs-0.7.1.min.js"></script>

24
25  

25<script type='text/javascript' src="/resources/js/tweenjs-0.5.1.min.js"></script>

25
26  

26<script type='text/javascript' src="/resources/js/marked.min.js"></script>

26
27  

27<script type='text/javascript' src="/resources/js/CSSPlugin.js"></script>

27
28  

28<script type='text/javascript' src="/resources/js/jquery-1.11.0.min.js"></script>

28
29  

29<script type='text/javascript'>
30  $(function() {
31    $("pre").addClass("prettyprint linenums");
32  });
33  $(function() {
34    $(".language-scala > pre").addClass("lang-scala");
35    $(".language-java > pre").addClass("lang-java");
36  });
37  </script>

37
38  

38<script src="/resources/js/prettify/prettify.js"></script>

38
39  

39<script src="/resources/js/prettify/lang-scala.js"></script>

39
40  

40<script type='text/javascript' src="/resources/js/slick-1.6.0/slick/slick.js"></script>

40
41  

41<script src="/resources/js/devquotes.js"></script>

41
42  

42<script src="/resources/js/utils.js"></script>

42
43  

43<script async defer src="https://buttons.github.io/buttons.js"></script>

43
44</head>
45
46<body onload="prettyPrint()">
47
48  <div id="wrap">
49
50    <div id="top">
51      <div class="container_12">
52        <div class="grid_12">
53          <ul class="horizmenu topmenu">
54            <li class="topelement logo">
55              <!-- <img height="38" src="/resources/images/mona-lisa-round.png"/> -->
56              <span class="logotext" style="">Renaissance Suite</span>
57            </li>
58          </ul>
59          <ul class="horizmenu topmenuright">
60            <li class="topdivider topelement"></li>
61            <li class="topelement topbutton">
62              <a href="/"><i class="fa fa-home icon"></i>Home</a>
63            </li>
64            <li class="topdivider topelement"></li>
65            <li class="topelement topbutton">
66              <a href="/download"><i class="fa fa-download icon"></i>Downloads</a>
67            </li>
68            <li class="topdivider topelement"></li>
69            <li class="topelement topbutton">
70              <a href="/docs#contribution-guide"><i class="fa fa-keyboard-o icon"></i>Contribute</a>
71            </li>
72            <li class="topdivider topelement"></li>
73            <li class="topelement topbutton">
74              <a href="https://github.com/renaissance-benchmarks/renaissance/issues"><i class="fa fa-comment icon"></i>Discuss</a>
75            </li>
76            <li class="topdivider topelement toprightmost"></li>
77            <!-- <li class="topelement topzero"><a></a></li> -->
78          </ul>
79
80          <!--
81          <form class="horizsearch" action="https://www.google.com/search" method="GET">
82            <input name="as_q" class="search-query" placeholder="Search" type="text">
83            <input name="as_sitesearch" value="storm-enroute.com" type="hidden">
84          </form>
85          -->
86        </div>
87      </div>
88    </div>
89
90    <!-- <div class="darkdivider"></div> -->
91    <!-- <div class="greydivider"></div> -->
92    <!-- <div class="topshadow"></div> -->
93
94    <br/>
95
96<div id="content">
97  <div id="main" class="container_16">
98
99    <div class="grid_16">
100
101      <h1 id="documentation-overview">Documentation Overview</h1>
102
103<p>Thank you for your interest in using the Renaissance Benchmark Suite!
104<br />
105On this page, we provide basic usage instructions, and other useful information.</p>
106
107<ul>
108  <li><a href="#getting-started">Getting Started with Renaissance</a></li>
109  <li><a href="#contribution-guide">Contributing to Renaissance</a></li>
110  <li><a href="#licensing">Licensing Information</a></li>
111</ul>
112
113<p>The motivation behind the Renaissance benchmark suite,
114as well as the detailed analysis of the individual benchmarks,
115are described in the following <a href="/resources/docs/renaissance-suite.pdf">PLDI’19 paper</a>.</p>
116
117<h1 id="-getting-started-with-renaissance"><a name="getting-started"></a> Getting Started with Renaissance</h1>
118
119<p>The Renaissance Benchmark Suite comes with an informative guide
120on how to run Renaissance benchmarks, how to add new benchmarks, run policies and plugins,
121and a technical overview of the internal design of the suite.</p>
122
123<div id="readme-holder">
124</div>

125<script>
126loadRemoteContent(
127  "readme-holder",
128  "https://api.github.com/repos/renaissance-benchmarks/renaissance/contents/README.md",
129  "mona-lisa-round.png",
130  "markdown"
131)
132</script>

132
133
134<p>The source file that explains how to use Renaissance can be found
135<a href="https://github.com/renaissance-benchmarks/renaissance/blob/master/README.md">here</a>.</p>
136
137<h1 id="-contributing-to-renaissance"><a name="contribution-guide"></a> Contributing to Renaissance</h1>
138
139<p>One of the aims of the Renaissance suite is to continually evolve,
140and maintain a collection of relevant and interesting benchmarks
141for VM, compiler and tool developers.
142Renaissance therefore relies on an open-source contribution process
143to derive the set of benchmarks that are useful when optimizing or analyzing the JVM behaviour.
144The contribution guide contains detailed information about this process.</p>
145
146<div id="contribution-holder">
147</div>

148<script>
149loadRemoteContent(
150  "contribution-holder",
151  "https://api.github.com/repos/renaissance-benchmarks/renaissance/contents/CONTRIBUTING.md",
152  "mona-lisa-round.png",
153  "markdown"
154)
155</script>

155
156
157<p>The source file that explains the contribution process for the Renaissance suite can be found
158<a href="https://github.com/renaissance-benchmarks/renaissance/blob/master/CONTRIBUTING.md">here</a>.</p>
159
160<h1 id="-licensing-information"><a name="licensing"></a> Licensing Information</h1>
161
162<p>The Renaissance Benchmark Suite comes in two distributions,
163and is available under two licenses: the MIT license, and the GPL3 license.
164Depending on your needs, you can choose either of these licenses.
165The set of benchmarks in the Renaissance distribution with the MIT license is a subset of the
166benchmarks in the GPL3 distribution.</p>
167
168<h2 id="mit-distribution">MIT Distribution</h2>
169
170<p>The MIT license file can be found
171<a href="https://github.com/renaissance-benchmarks/renaissance/blob/master/LICENSE.MIT">here</a>.</p>
172
173<div id="license-holder-mit">
174</div>

175<script>
176loadRemoteContent(
177  "license-holder-mit",
178  "https://api.github.com/repos/renaissance-benchmarks/renaissance/contents/LICENSE.MIT",
179  "mona-lisa-round.png",
180  "license"
181)
182</script>

182
183
184<h2 id="gpl3-distribution">GPL3 Distribution</h2>
185
186<p>The GPL3 license file can be found
187<a href="https://github.com/renaissance-benchmarks/renaissance/blob/master/LICENSE.GPL">here</a>.</p>
188
189<div id="license-holder-gpl">
190</div>

191<script>
192loadRemoteContent(
193  "license-holder-gpl",
194  "https://api.github.com/repos/renaissance-benchmarks/renaissance/contents/LICENSE.GPL",
195  "mona-lisa-round.png",
196  "license"
197)
198</script>

198
199
200
201
202    </div>
203
204  </div>
205</div>
206
207
208  </div>
209
210  <div id="footer">
211    <!-- <div class="darkdivider"></div> -->
212    <!-- <div class="lightdivider"></div> -->
213  
214    <div id="footercontent" class="container_16">
215      <div class="grid_16 footer">
216        <ul class="horizmenu footermenu">
217          <li class="footerdivider footerelement"></li>
218          <li class="hint--top footerelement" data-hint="" id="quotebox">
219            <a href="">
220              <i class ="fa fa-lightbulb-o icon"></i> Tip of the day
221            </a>
222          </li>
223          <li class="footerdivider footerelement"></li>
224        </ul>
225        

225<script>
226        var quotebox = document.getElementById("quotebox");
227        var quote = fetchQuote();
228        quotebox.setAttribute("data-hint", quote.text + " " + quote.author)
229        </script>

229
230
231        <div class="copyright footerelement">
232          <a href="/">&copy; 2019 Renaissance Suite</a>
233        </div>
234      </div>
235      <div class="grid_12 footer">
236      </div>
237    </div>
238  </div>
239
240</body>
241
242
243</html>