Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / libcore / 5e00da6b123ebc6c454eb07a3e6550b31696437a / . / README-builds.html
blob: 6d7d5b52461b4e9e890bd979d6ff6b26fa0dd6c2 [file] [log] [blame]
J. Duke686d76f2007-12-01 00:00:00 +0000[diff] [blame]1<html>
Magnus Ihse Bursie17c89682015-10-20 10:39:07 +0200[diff] [blame]2 <head>
3 <title>OpenJDK Build README</title>
4 </head>
5 <body>
6<p><img src="http://openjdk.java.net/images/openjdk.png" alt="OpenJDK" title="" /></p>
Kelly O'Hair2ff5bb12013-02-23 10:47:01 -0800[diff] [blame]7
Magnus Ihse Bursie17c89682015-10-20 10:39:07 +0200[diff] [blame]8<h1>OpenJDK Build README</h1>
Kelly O'Hair2ff5bb12013-02-23 10:47:01 -0800[diff] [blame]9
Magnus Ihse Bursie17c89682015-10-20 10:39:07 +0200[diff] [blame]10<hr />
Kelly O'Hair2ff5bb12013-02-23 10:47:01 -0800[diff] [blame]11
Magnus Ihse Bursie17c89682015-10-20 10:39:07 +0200[diff] [blame]12<p><a name="introduction"></a></p>
Kelly O'Hair2ff5bb12013-02-23 10:47:01 -0800[diff] [blame]13
Magnus Ihse Bursie17c89682015-10-20 10:39:07 +0200[diff] [blame]14<h2>Introduction</h2>
Kelly O'Hair2ff5bb12013-02-23 10:47:01 -0800[diff] [blame]15
Magnus Ihse Bursie17c89682015-10-20 10:39:07 +0200[diff] [blame]16<p>This README file contains build instructions for the
17<a href="http://openjdk.java.net">OpenJDK</a>. Building the source code for the OpenJDK
18requires a certain degree of technical expertise.</p>
Kelly O'Hair2ff5bb12013-02-23 10:47:01 -0800[diff] [blame]19
Magnus Ihse Bursie17c89682015-10-20 10:39:07 +0200[diff] [blame]20<h3>!!!!!!!!!!!!!!! THIS IS A MAJOR RE-WRITE of this document. !!!!!!!!!!!!!</h3>
Kelly O'Hair2ff5bb12013-02-23 10:47:01 -0800[diff] [blame]21
Magnus Ihse Bursie17c89682015-10-20 10:39:07 +0200[diff] [blame]22<p>Some Headlines:</p>
Kelly O'Hair2ff5bb12013-02-23 10:47:01 -0800[diff] [blame]23
Magnus Ihse Bursie17c89682015-10-20 10:39:07 +0200[diff] [blame]24<ul>
25<li>The build is now a "<code>configure &amp;&amp; make</code>" style build</li>
26<li>Any GNU make 3.81 or newer should work, except on Windows where 4.0 or newer
27is recommended.</li>
28<li>The build should scale, i.e. more processors should cause the build to be
29done in less wall-clock time</li>
30<li>Nested or recursive make invocations have been significantly reduced,
31as has the total fork/exec or spawning of sub processes during the build</li>
32<li>Windows MKS usage is no longer supported</li>
33<li>Windows Visual Studio <code>vsvars*.bat</code> and <code>vcvars*.bat</code> files are run
34automatically</li>
35<li>Ant is no longer used when building the OpenJDK</li>
36<li>Use of ALT_* environment variables for configuring the build is no longer
37supported</li>
38</ul>
Kelly O'Hair213481a2010-12-22 12:25:52 -0800[diff] [blame]39
Magnus Ihse Bursie17c89682015-10-20 10:39:07 +0200[diff] [blame]40<hr />
Kelly O'Hair213481a2010-12-22 12:25:52 -0800[diff] [blame]41
Magnus Ihse Bursie17c89682015-10-20 10:39:07 +0200[diff] [blame]42<h2>Contents</h2>
Kelly O'Hair213481a2010-12-22 12:25:52 -0800[diff] [blame]43
Magnus Ihse Bursie17c89682015-10-20 10:39:07 +0200[diff] [blame]44<ul>
45<li><a href="#introduction">Introduction</a></li>
46<li><a href="#hg">Use of Mercurial</a>
47<ul>
48<li><a href="#get_source">Getting the Source</a></li>
49<li><a href="#repositories">Repositories</a></li>
50</ul></li>
51<li><a href="#building">Building</a>
52<ul>
53<li><a href="#setup">System Setup</a>
54<ul>
55<li><a href="#linux">Linux</a></li>
56<li><a href="#solaris">Solaris</a></li>
57<li><a href="#macosx">Mac OS X</a></li>
58<li><a href="#windows">Windows</a></li>
59</ul></li>
60<li><a href="#configure">Configure</a></li>
61<li><a href="#make">Make</a></li>
62</ul></li>
63<li><a href="#testing">Testing</a></li>
64</ul>
Dalibor Topic73e9e342009-09-23 20:06:01 +0200[diff] [blame]65
Magnus Ihse Bursie17c89682015-10-20 10:39:07 +0200[diff] [blame]66<hr />
Kelly O'Hairf240c002011-03-22 08:15:39 -0700[diff] [blame]67
Magnus Ihse Bursie17c89682015-10-20 10:39:07 +0200[diff] [blame]68<ul>
69<li><a href="#hints">Appendix A: Hints and Tips</a>
70<ul>
71<li><a href="#faq">FAQ</a></li>
72<li><a href="#performance">Build Performance Tips</a></li>
73<li><a href="#troubleshooting">Troubleshooting</a></li>
74</ul></li>
75<li><a href="#gmake">Appendix B: GNU Make Information</a></li>
76<li><a href="#buildenvironments">Appendix C: Build Environments</a></li>
77</ul>
Kelly O'Hair2ff5bb12013-02-23 10:47:01 -0800[diff] [blame]78
Magnus Ihse Bursie17c89682015-10-20 10:39:07 +0200[diff] [blame]79<hr />
Kelly O'Hair2ff5bb12013-02-23 10:47:01 -0800[diff] [blame]80
Magnus Ihse Bursie17c89682015-10-20 10:39:07 +0200[diff] [blame]81<p><a name="hg"></a></p>
Stuart Markse1dd7522013-06-18 17:18:46 -0700[diff] [blame]82
Magnus Ihse Bursie17c89682015-10-20 10:39:07 +0200[diff] [blame]83<h2>Use of Mercurial</h2>
Stuart Markse1dd7522013-06-18 17:18:46 -0700[diff] [blame]84
Magnus Ihse Bursie17c89682015-10-20 10:39:07 +0200[diff] [blame]85<p>The OpenJDK sources are maintained with the revision control system
86<a href="http://mercurial.selenic.com/wiki/Mercurial">Mercurial</a>. If you are new to
87Mercurial, please see the <a href="http://mercurial.selenic.com/wiki/
88BeginnersGuides">Beginner Guides</a> or refer to the <a href="http://hgbook.red-bean.com/">Mercurial Book</a>.
89The first few chapters of the book provide an excellent overview of Mercurial,
90what it is and how it works.</p>
Kelly O'Hair2ff5bb12013-02-23 10:47:01 -0800[diff] [blame]91
Magnus Ihse Bursie17c89682015-10-20 10:39:07 +0200[diff] [blame]92<p>For using Mercurial with the OpenJDK refer to the <a href="http://openjdk.java.net/guide/
93repositories.html#installConfig">Developer Guide: Installing
94and Configuring Mercurial</a> section for more information.</p>
Kelly O'Hair2ff5bb12013-02-23 10:47:01 -0800[diff] [blame]95
Magnus Ihse Bursie17c89682015-10-20 10:39:07 +0200[diff] [blame]96<p><a name="get_source"></a></p>
Kelly O'Hair2ff5bb12013-02-23 10:47:01 -0800[diff] [blame]97
Magnus Ihse Bursie17c89682015-10-20 10:39:07 +0200[diff] [blame]98<h3>Getting the Source</h3>
Kelly O'Hair2ff5bb12013-02-23 10:47:01 -0800[diff] [blame]99
Magnus Ihse Bursie17c89682015-10-20 10:39:07 +0200[diff] [blame]100<p>To get the entire set of OpenJDK Mercurial repositories use the script
101<code>get_source.sh</code> located in the root repository:</p>
Kelly O'Hair2ff5bb12013-02-23 10:47:01 -0800[diff] [blame]102
Magnus Ihse Bursie17c89682015-10-20 10:39:07 +0200[diff] [blame]103<pre><code> hg clone http://hg.openjdk.java.net/jdk9/jdk9 YourOpenJDK
104 cd YourOpenJDK
105 bash ./get_source.sh
106</code></pre>
Kelly O'Hair2ff5bb12013-02-23 10:47:01 -0800[diff] [blame]107
Magnus Ihse Bursie17c89682015-10-20 10:39:07 +0200[diff] [blame]108<p>Once you have all the repositories, keep in mind that each repository is its
109own independent repository. You can also re-run <code>./get_source.sh</code> anytime to
110pull over all the latest changesets in all the repositories. This set of
111nested repositories has been given the term "forest" and there are various
112ways to apply the same <code>hg</code> command to each of the repositories. For
113example, the script <code>make/scripts/hgforest.sh</code> can be used to repeat the
114same <code>hg</code> command on every repository, e.g.</p>
Kelly O'Hair2ff5bb12013-02-23 10:47:01 -0800[diff] [blame]115
Magnus Ihse Bursie17c89682015-10-20 10:39:07 +0200[diff] [blame]116<pre><code> cd YourOpenJDK
117 bash ./make/scripts/hgforest.sh status
118</code></pre>
Kelly O'Hair2ff5bb12013-02-23 10:47:01 -0800[diff] [blame]119
Magnus Ihse Bursie17c89682015-10-20 10:39:07 +0200[diff] [blame]120<p><a name="repositories"></a></p>
Kelly O'Hair2ff5bb12013-02-23 10:47:01 -0800[diff] [blame]121
Magnus Ihse Bursie17c89682015-10-20 10:39:07 +0200[diff] [blame]122<h3>Repositories</h3>
Kelly O'Hair2ff5bb12013-02-23 10:47:01 -0800[diff] [blame]123
Magnus Ihse Bursie17c89682015-10-20 10:39:07 +0200[diff] [blame]124<p>The set of repositories and what they contain:</p>
Kelly O'Hair2ff5bb12013-02-23 10:47:01 -0800[diff] [blame]125
Magnus Ihse Bursie17c89682015-10-20 10:39:07 +0200[diff] [blame]126<ul>
127<li><strong>. (root)</strong> contains common configure and makefile logic</li>
128<li><strong>hotspot</strong> contains source code and make files for building the OpenJDK
129Hotspot Virtual Machine</li>
130<li><strong>langtools</strong> contains source code for the OpenJDK javac and language tools</li>
131<li><strong>jdk</strong> contains source code and make files for building the OpenJDK runtime
132libraries and misc files</li>
133<li><strong>jaxp</strong> contains source code for the OpenJDK JAXP functionality</li>
134<li><strong>jaxws</strong> contains source code for the OpenJDK JAX-WS functionality</li>
135<li><strong>corba</strong> contains source code for the OpenJDK Corba functionality</li>
136<li><strong>nashorn</strong> contains source code for the OpenJDK JavaScript implementation</li>
137</ul>
Kelly O'Hair2ff5bb12013-02-23 10:47:01 -0800[diff] [blame]138
Magnus Ihse Bursie17c89682015-10-20 10:39:07 +0200[diff] [blame]139<h3>Repository Source Guidelines</h3>
Kelly O'Hair2ff5bb12013-02-23 10:47:01 -0800[diff] [blame]140
Magnus Ihse Bursie17c89682015-10-20 10:39:07 +0200[diff] [blame]141<p>There are some very basic guidelines:</p>
Kelly O'Hair2ff5bb12013-02-23 10:47:01 -0800[diff] [blame]142
Magnus Ihse Bursie17c89682015-10-20 10:39:07 +0200[diff] [blame]143<ul>
144<li>Use of whitespace in source files (.java, .c, .h, .cpp, and .hpp files) is
145restricted. No TABs, no trailing whitespace on lines, and files should not
146terminate in more than one blank line.</li>
147<li>Files with execute permissions should not be added to the source
148repositories.</li>
149<li>All generated files need to be kept isolated from the files maintained or
150managed by the source control system. The standard area for generated files
151is the top level <code>build/</code> directory.</li>
152<li>The default build process should be to build the product and nothing else,
153in one form, e.g. a product (optimized), debug (non-optimized, -g plus
154assert logic), or fastdebug (optimized, -g plus assert logic).</li>
155<li>The <code>.hgignore</code> file in each repository must exist and should include
156<code>^build/</code>, <code>^dist/</code> and optionally any <code>nbproject/private</code> directories. <strong>It
157should NEVER</strong> include anything in the <code>src/</code> or <code>test/</code> or any managed
158directory area of a repository.</li>
159<li>Directory names and file names should never contain blanks or non-printing
160characters.</li>
161<li>Generated source or binary files should NEVER be added to the repository
162(that includes <code>javah</code> output). There are some exceptions to this rule, in
163particular with some of the generated configure scripts.</li>
164<li>Files not needed for typical building or testing of the repository should
165not be added to the repository.</li>
166</ul>
Kelly O'Hair2ff5bb12013-02-23 10:47:01 -0800[diff] [blame]167
Magnus Ihse Bursie17c89682015-10-20 10:39:07 +0200[diff] [blame]168<hr />
Kelly O'Hair2ff5bb12013-02-23 10:47:01 -0800[diff] [blame]169
Magnus Ihse Bursie17c89682015-10-20 10:39:07 +0200[diff] [blame]170<p><a name="building"></a></p>
Kelly O'Hair2ff5bb12013-02-23 10:47:01 -0800[diff] [blame]171
Magnus Ihse Bursie17c89682015-10-20 10:39:07 +0200[diff] [blame]172<h2>Building</h2>
Kelly O'Hair2ff5bb12013-02-23 10:47:01 -0800[diff] [blame]173
Magnus Ihse Bursie17c89682015-10-20 10:39:07 +0200[diff] [blame]174<p>The very first step in building the OpenJDK is making sure the system itself
175has everything it needs to do OpenJDK builds. Once a system is setup, it
176generally doesn't need to be done again.</p>
Kelly O'Hair2ff5bb12013-02-23 10:47:01 -0800[diff] [blame]177
Magnus Ihse Bursie17c89682015-10-20 10:39:07 +0200[diff] [blame]178<p>Building the OpenJDK is now done with running a <code>configure</code> script which will
179try and find and verify you have everything you need, followed by running
180<code>make</code>, e.g.</p>
Kelly O'Hair2ff5bb12013-02-23 10:47:01 -0800[diff] [blame]181
Kelly O'Hair2ff5bb12013-02-23 10:47:01 -0800[diff] [blame]182<blockquote>
Magnus Ihse Bursie17c89682015-10-20 10:39:07 +0200[diff] [blame]183 <p><strong><code>bash ./configure</code></strong> <br />
184 <strong><code>make all</code></strong></p>
185</blockquote>
Kelly O'Hair2ff5bb12013-02-23 10:47:01 -0800[diff] [blame]186
Magnus Ihse Bursie17c89682015-10-20 10:39:07 +0200[diff] [blame]187<p>Where possible the <code>configure</code> script will attempt to located the various
188components in the default locations or via component specific variable
189settings. When the normal defaults fail or components cannot be found,
190additional <code>configure</code> options may be necessary to help <code>configure</code> find the
191necessary tools for the build, or you may need to re-visit the setup of your
192system due to missing software packages.</p>
Kelly O'Hair2ff5bb12013-02-23 10:47:01 -0800[diff] [blame]193
Magnus Ihse Bursie17c89682015-10-20 10:39:07 +0200[diff] [blame]194<p><strong>NOTE:</strong> The <code>configure</code> script file does not have execute permissions and
195will need to be explicitly run with <code>bash</code>, see the source guidelines.</p>
Kelly O'Hair2ff5bb12013-02-23 10:47:01 -0800[diff] [blame]196
Magnus Ihse Bursie17c89682015-10-20 10:39:07 +0200[diff] [blame]197<hr />
Kelly O'Hair2ff5bb12013-02-23 10:47:01 -0800[diff] [blame]198
Magnus Ihse Bursie17c89682015-10-20 10:39:07 +0200[diff] [blame]199<p><a name="setup"></a></p>
Kelly O'Hair2ff5bb12013-02-23 10:47:01 -0800[diff] [blame]200
Magnus Ihse Bursie17c89682015-10-20 10:39:07 +0200[diff] [blame]201<h3>System Setup</h3>
202
203<p>Before even attempting to use a system to build the OpenJDK there are some very
204basic system setups needed. For all systems:</p>
205
206<ul>
207<li><p>Be sure the GNU make utility is version 3.81 (4.0 on windows) or newer, e.g.
208run "<code>make -version</code>"</p>
209
210<p><a name="bootjdk"></a></p></li>
211<li><p>Install a Bootstrap JDK. All OpenJDK builds require access to a previously
212released JDK called the <em>bootstrap JDK</em> or <em>boot JDK.</em> The general rule is
213that the bootstrap JDK must be an instance of the previous major release of
214the JDK. In addition, there may be a requirement to use a release at or
215beyond a particular update level.</p>
216
217<p><strong><em>Building JDK 9 requires JDK 8. JDK 9 developers should not use JDK 9 as
218the boot JDK, to ensure that JDK 9 dependencies are not introduced into the
219parts of the system that are built with JDK 8.</em></strong></p>
220
221<p>The JDK 8 binaries can be downloaded from Oracle's <a href="http://www.oracle.com/technetwork/java/javase/downloads/index.html">JDK 8 download
222site</a>.
223For build performance reasons it is very important that this bootstrap JDK
224be made available on the local disk of the machine doing the build. You
225should add its <code>bin</code> directory to the <code>PATH</code> environment variable. If
226<code>configure</code> has any issues finding this JDK, you may need to use the
227<code>configure</code> option <code>--with-boot-jdk</code>.</p></li>
228<li><p>Ensure that GNU make, the Bootstrap JDK, and the compilers are all in your
229PATH environment variable.</p></li>
230</ul>
231
232<p>And for specific systems:</p>
233
234<ul>
235<li><p><strong>Linux</strong></p>
236
237<p>Install all the software development packages needed including
238<a href="#alsa">alsa</a>, <a href="#freetype">freetype</a>, <a href="#cups">cups</a>, and
239<a href="#xrender">xrender</a>. See <a href="#SDBE">specific system packages</a>.</p></li>
240<li><p><strong>Solaris</strong></p>
241
242<p>Install all the software development packages needed including <a href="#studio">Studio
243Compilers</a>, <a href="#freetype">freetype</a>, <a href="#cups">cups</a>, and
244<a href="#xrender">xrender</a>. See <a href="#SDBE">specific system packages</a>.</p></li>
245<li><p><strong>Windows</strong></p>
246
247<ul>
248<li>Install one of <a href="#cygwin">CYGWIN</a> or <a href="#msys">MinGW/MSYS</a></li>
249<li>Install <a href="#vs2013">Visual Studio 2013</a></li>
250</ul></li>
251<li><p><strong>Mac OS X</strong></p>
252
Erik Joelssone35dab12015-12-15 15:45:53 +0100[diff] [blame]253<p>Install <a href="https://developer.apple.com/xcode/">XCode 6.3</a></p></li>
Magnus Ihse Bursie17c89682015-10-20 10:39:07 +0200[diff] [blame]254</ul>
255
256<p><a name="linux"></a></p>
257
258<h4>Linux</h4>
259
260<p>With Linux, try and favor the system packages over building your own or getting
261packages from other areas. Most Linux builds should be possible with the
262system's available packages.</p>
263
264<p>Note that some Linux systems have a habit of pre-populating your environment
265variables for you, for example <code>JAVA_HOME</code> might get pre-defined for you to
266refer to the JDK installed on your Linux system. You will need to unset
267<code>JAVA_HOME</code>. It's a good idea to run <code>env</code> and verify the environment variables
268you are getting from the default system settings make sense for building the
269OpenJDK.</p>
270
271<p><a name="solaris"></a></p>
272
273<h4>Solaris</h4>
274
275<p><a name="studio"></a></p>
276
277<h5>Studio Compilers</h5>
278
279<p>At a minimum, the <a href="http://www.oracle.com/
Erik Joelssone35dab12015-12-15 15:45:53 +0100[diff] [blame]280technetwork/server-storage/solarisstudio/downloads/index.htm">Studio 12 Update 4 Compilers</a> (containing
281version 5.13 of the C and C++ compilers) is required, including specific
Magnus Ihse Bursie17c89682015-10-20 10:39:07 +0200[diff] [blame]282patches.</p>
283
Erik Joelssone35dab12015-12-15 15:45:53 +0100[diff] [blame]284<p>The Solaris Studio installation should contain at least these packages:</p>
Magnus Ihse Bursie17c89682015-10-20 10:39:07 +0200[diff] [blame]285
Erik Joelssone35dab12015-12-15 15:45:53 +0100[diff] [blame]286<blockquote>
287 <p><table border="1">
288 <thead>
289 <tr>
290 <td><strong>Package</strong></td>
291 <td><strong>Version</strong></td>
292 </tr>
293 </thead>
294 <tbody>
295 <tr>
296 <td>developer/solarisstudio-124/backend</td>
297 <td>12.4-1.0.6.0</td>
298 </tr>
299 <tr>
300 <td>developer/solarisstudio-124/c++</td>
301 <td>12.4-1.0.10.0</td>
302 </tr>
303 <tr>
304 <td>developer/solarisstudio-124/cc</td>
305 <td>12.4-1.0.4.0</td>
306 </tr>
307 <tr>
308 <td>developer/solarisstudio-124/library/c++-libs</td>
309 <td>12.4-1.0.10.0</td>
310 </tr>
311 <tr>
312 <td>developer/solarisstudio-124/library/math-libs</td>
313 <td>12.4-1.0.0.1</td>
314 </tr>
315 <tr>
316 <td>developer/solarisstudio-124/library/studio-gccrt</td>
317 <td>12.4-1.0.0.1</td>
318 </tr>
319 <tr>
320 <td>developer/solarisstudio-124/studio-common</td>
321 <td>12.4-1.0.0.1</td>
322 </tr>
323 <tr>
324 <td>developer/solarisstudio-124/studio-ja</td>
325 <td>12.4-1.0.0.1</td>
326 </tr>
327 <tr>
328 <td>developer/solarisstudio-124/studio-legal</td>
329 <td>12.4-1.0.0.1</td>
330 </tr>
331 <tr>
332 <td>developer/solarisstudio-124/studio-zhCN</td>
333 <td>12.4-1.0.0.1</td>
334 </tr>
335 </tbody>
336 </table></p>
337</blockquote>
Magnus Ihse Bursie17c89682015-10-20 10:39:07 +0200[diff] [blame]338
Erik Joelssone35dab12015-12-15 15:45:53 +0100[diff] [blame]339<p>In particular backend 12.4-1.0.6.0 contains a critical patch for the sparc
340version.</p>
Magnus Ihse Bursie17c89682015-10-20 10:39:07 +0200[diff] [blame]341
342<p>Place the <code>bin</code> directory in <code>PATH</code>.</p>
343
344<p>The Oracle Solaris Studio Express compilers at: <a href="http://www.oracle.com/technetwork/server-storage/solarisstudio/
345downloads/index-jsp-142582.html">Oracle Solaris Studio Express
346Download site</a> are also an option, although these compilers
347have not been extensively used yet.</p>
348
349<p><a name="windows"></a></p>
350
351<h4>Windows</h4>
352
353<h5>Windows Unix Toolkit</h5>
354
355<p>Building on Windows requires a Unix-like environment, notably a Unix-like
356shell. There are several such environments available of which
357<a href="http://www.cygwin.com/">Cygwin</a> and
358<a href="http://www.mingw.org/wiki/MSYS">MinGW/MSYS</a> are currently supported for the
359OpenJDK build. One of the differences of these systems from standard Windows
360tools is the way they handle Windows path names, particularly path names which
361contain spaces, backslashes as path separators and possibly drive letters.
362Depending on the use case and the specifics of each environment these path
363problems can be solved by a combination of quoting whole paths, translating
364backslashes to forward slashes, escaping backslashes with additional
365backslashes and translating the path names to their <a href="http://en.wikipedia.org/wiki/8.3_filename">"8.3"
366version</a>.</p>
367
368<p><a name="cygwin"></a></p>
369
370<h6>CYGWIN</h6>
371
372<p>CYGWIN is an open source, Linux-like environment which tries to emulate a
373complete POSIX layer on Windows. It tries to be smart about path names and can
374usually handle all kinds of paths if they are correctly quoted or escaped
375although internally it maps drive letters <code>&lt;drive&gt;:</code> to a virtual directory
376<code>/cygdrive/&lt;drive&gt;</code>.</p>
377
378<p>You can always use the <code>cygpath</code> utility to map pathnames with spaces or the
379backslash character into the <code>C:/</code> style of pathname (called 'mixed'), e.g.
380<code>cygpath -s -m "&lt;path&gt;"</code>.</p>
381
382<p>Note that the use of CYGWIN creates a unique problem with regards to setting
383<a href="#path"><code>PATH</code></a>. Normally on Windows the <code>PATH</code> variable contains directories
384separated with the ";" character (Solaris and Linux use ":"). With CYGWIN, it
385uses ":", but that means that paths like "C:/path" cannot be placed in the
386CYGWIN version of <code>PATH</code> and instead CYGWIN uses something like
387<code>/cygdrive/c/path</code> which CYGWIN understands, but only CYGWIN understands.</p>
388
389<p>The OpenJDK build requires CYGWIN version 1.7.16 or newer. Information about
390CYGWIN can be obtained from the CYGWIN website at
391<a href="http://www.cygwin.com">www.cygwin.com</a>.</p>
392
393<p>By default CYGWIN doesn't install all the tools required for building the
394OpenJDK. Along with the default installation, you need to install the following
395tools.</p>
396
397<blockquote>
398 <p><table border="1">
399 <thead>
400 <tr>
401 <td>Binary Name</td>
402 <td>Category</td>
403 <td>Package</td>
404 <td>Description</td>
405 </tr>
406 </thead>
407 <tbody>
408 <tr>
409 <td>ar.exe</td>
410 <td>Devel</td>
411 <td>binutils</td>
412 <td>The GNU assembler, linker and binary utilities</td>
413 </tr>
414 <tr>
415 <td>make.exe</td>
416 <td>Devel</td>
417 <td>make</td>
418 <td>The GNU version of the 'make' utility built for CYGWIN</td>
419 </tr>
420 <tr>
421 <td>m4.exe</td>
422 <td>Interpreters</td>
423 <td>m4</td>
424 <td>GNU implementation of the traditional Unix macro processor</td>
425 </tr>
426 <tr>
427 <td>cpio.exe</td>
428 <td>Utils</td>
429 <td>cpio</td>
430 <td>A program to manage archives of files</td>
431 </tr>
432 <tr>
433 <td>gawk.exe</td>
434 <td>Utils</td>
435 <td>awk</td>
436 <td>Pattern-directed scanning and processing language</td>
437 </tr>
438 <tr>
439 <td>file.exe</td>
440 <td>Utils</td>
441 <td>file</td>
442 <td>Determines file type using 'magic' numbers</td>
443 </tr>
444 <tr>
445 <td>zip.exe</td>
446 <td>Archive</td>
447 <td>zip</td>
448 <td>Package and compress (archive) files</td>
449 </tr>
450 <tr>
451 <td>unzip.exe</td>
452 <td>Archive</td>
453 <td>unzip</td>
454 <td>Extract compressed files in a ZIP archive</td>
455 </tr>
456 <tr>
457 <td>free.exe</td>
458 <td>System</td>
459 <td>procps</td>
460 <td>Display amount of free and used memory in the system</td>
461 </tr>
462 </tbody>
463 </table></p>
464</blockquote>
465
466<p>Note that the CYGWIN software can conflict with other non-CYGWIN software on
467your Windows system. CYGWIN provides a <a href="http://cygwin.com/faq/
468faq.using.html">FAQ</a> for known issues and problems, of particular interest is the
469section on <a href="http://cygwin.com/faq/faq.using.html#faq.using.bloda">BLODA (applications that interfere with
470CYGWIN)</a>.</p>
471
472<p><a name="msys"></a></p>
473
474<h6>MinGW/MSYS</h6>
475
476<p>MinGW ("Minimalist GNU for Windows") is a collection of free Windows specific
477header files and import libraries combined with GNU toolsets that allow one to
478produce native Windows programs that do not rely on any 3rd-party C runtime
479DLLs. MSYS is a supplement to MinGW which allows building applications and
480programs which rely on traditional UNIX tools to be present. Among others this
481includes tools like <code>bash</code> and <code>make</code>. See <a href="http://www.mingw.org/
482wiki/MSYS">MinGW/MSYS</a> for more information.</p>
483
484<p>Like Cygwin, MinGW/MSYS can handle different types of path formats. They are
485internally converted to paths with forward slashes and drive letters
486<code>&lt;drive&gt;:</code> replaced by a virtual directory <code>/&lt;drive&gt;</code>. Additionally, MSYS
487automatically detects binaries compiled for the MSYS environment and feeds them
488with the internal, Unix-style path names. If native Windows applications are
489called from within MSYS programs their path arguments are automatically
490converted back to Windows style path names with drive letters and backslashes
491as path separators. This may cause problems for Windows applications which use
492forward slashes as parameter separator (e.g. <code>cl /nologo /I</code>) because MSYS may
493wrongly <a href="http://mingw.org/wiki/
494Posix_path_conversion">replace such parameters by drive letters</a>.</p>
495
496<p>In addition to the tools which will be installed by default, you have to
497manually install the <code>msys-zip</code> and <code>msys-unzip</code> packages. This can be easily
498done with the MinGW command line installer:</p>
499
500<pre><code> mingw-get.exe install msys-zip
501 mingw-get.exe install msys-unzip
502</code></pre>
503
504<p><a name="vs2013"></a></p>
505
506<h5>Visual Studio 2013 Compilers</h5>
507
508<p>The 32-bit and 64-bit OpenJDK Windows build requires Microsoft Visual Studio
509C++ 2013 (VS2013) Professional Edition or Express compiler. The compiler and
510other tools are expected to reside in the location defined by the variable
511<code>VS120COMNTOOLS</code> which is set by the Microsoft Visual Studio installer.</p>
512
513<p>Only the C++ part of VS2013 is needed. Try to let the installation go to the
514default install directory. Always reboot your system after installing VS2013.
515The system environment variable VS120COMNTOOLS should be set in your
516environment.</p>
517
518<p>Make sure that TMP and TEMP are also set in the environment and refer to
519Windows paths that exist, like <code>C:\temp</code>, not <code>/tmp</code>, not <code>/cygdrive/c/temp</code>,
520and not <code>C:/temp</code>. <code>C:\temp</code> is just an example, it is assumed that this area
521is private to the user, so by default after installs you should see a unique
522user path in these variables.</p>
523
524<p><a name="macosx"></a></p>
525
526<h4>Mac OS X</h4>
527
528<p>Make sure you get the right XCode version.</p>
529
530<hr />
531
532<p><a name="configure"></a></p>
533
534<h3>Configure</h3>
535
536<p>The basic invocation of the <code>configure</code> script looks like:</p>
537
538<blockquote>
539 <p><strong><code>bash ./configure [options]</code></strong></p>
540</blockquote>
541
542<p>This will create an output directory containing the "configuration" and setup
543an area for the build result. This directory typically looks like:</p>
544
545<blockquote>
546 <p><strong><code>build/linux-x64-normal-server-release</code></strong></p>
547</blockquote>
548
549<p><code>configure</code> will try to figure out what system you are running on and where all
550necessary build components are. If you have all prerequisites for building
551installed, it should find everything. If it fails to detect any component
552automatically, it will exit and inform you about the problem. When this
553happens, read more below in <a href="#configureoptions">the <code>configure</code> options</a>.</p>
554
555<p>Some examples:</p>
556
557<blockquote>
558 <p><strong>Windows 32bit build with freetype specified:</strong> <br />
559 <code>bash ./configure --with-freetype=/cygdrive/c/freetype-i586 --with-target-
560bits=32</code></p>
561
562<p><strong>Debug 64bit Build:</strong> <br />
563 <code>bash ./configure --enable-debug --with-target-bits=64</code></p>
564</blockquote>
565
566<p><a name="configureoptions"></a></p>
567
568<h4>Configure Options</h4>
569
570<p>Complete details on all the OpenJDK <code>configure</code> options can be seen with:</p>
571
572<blockquote>
573 <p><strong><code>bash ./configure --help=short</code></strong></p>
574</blockquote>
575
576<p>Use <code>-help</code> to see all the <code>configure</code> options available. You can generate any
577number of different configurations, e.g. debug, release, 32, 64, etc.</p>
578
579<p>Some of the more commonly used <code>configure</code> options are:</p>
580
581<blockquote>
582 <p><strong><code>--enable-debug</code></strong> <br />
583 set the debug level to fastdebug (this is a shorthand for <code>--with-debug-
584 level=fastdebug</code>)</p>
585</blockquote>
586
587<p><a name="alsa"></a></p>
588
589<blockquote>
590 <p><strong><code>--with-alsa=</code></strong><em>path</em> <br />
591 select the location of the Advanced Linux Sound Architecture (ALSA)</p>
592
593<p>Version 0.9.1 or newer of the ALSA files are required for building the
594 OpenJDK on Linux. These Linux files are usually available from an "alsa" of
595 "libasound" development package, and it's highly recommended that you try
596 and use the package provided by the particular version of Linux that you are
597 using.</p>
598
599<p><strong><code>--with-boot-jdk=</code></strong><em>path</em> <br />
600 select the <a href="#bootjdk">Bootstrap JDK</a></p>
601
602<p><strong><code>--with-boot-jdk-jvmargs=</code></strong>"<em>args</em>" <br />
603 provide the JVM options to be used to run the <a href="#bootjdk">Bootstrap JDK</a></p>
604
605<p><strong><code>--with-cacerts=</code></strong><em>path</em> <br />
606 select the path to the cacerts file.</p>
607
608<p>See <a href="http://en.wikipedia.org/wiki/
609 Certificate_Authority">Certificate Authority on Wikipedia</a> for a better understanding of the Certificate
610 Authority (CA). A certificates file named "cacerts" represents a system-wide
611 keystore with CA certificates. In JDK and JRE binary bundles, the "cacerts"
612 file contains root CA certificates from several public CAs (e.g., VeriSign,
613 Thawte, and Baltimore). The source contain a cacerts file without CA root
614 certificates. Formal JDK builders will need to secure permission from each
615 public CA and include the certificates into their own custom cacerts file.
616 Failure to provide a populated cacerts file will result in verification
617 errors of a certificate chain during runtime. By default an empty cacerts
618 file is provided and that should be fine for most JDK developers.</p>
619</blockquote>
620
621<p><a name="cups"></a></p>
622
623<blockquote>
624 <p><strong><code>--with-cups=</code></strong><em>path</em> <br />
625 select the CUPS install location</p>
626
627<p>The Common UNIX Printing System (CUPS) Headers are required for building the
628 OpenJDK on Solaris and Linux. The Solaris header files can be obtained by
Alan Burlison06d76af2016-09-21 14:16:05 +0200[diff] [blame]629 installing the package <strong>print/cups</strong>.</p>
Magnus Ihse Bursie17c89682015-10-20 10:39:07 +0200[diff] [blame]630
631<p>The CUPS header files can always be downloaded from
632 <a href="http://www.cups.org">www.cups.org</a>.</p>
633
634<p><strong><code>--with-cups-include=</code></strong><em>path</em> <br />
635 select the CUPS include directory location</p>
636
637<p><strong><code>--with-debug-level=</code></strong><em>level</em> <br />
638 select the debug information level of release, fastdebug, or slowdebug</p>
639
640<p><strong><code>--with-dev-kit=</code></strong><em>path</em> <br />
641 select location of the compiler install or developer install location</p>
642</blockquote>
643
644<p><a name="freetype"></a></p>
645
646<blockquote>
647 <p><strong><code>--with-freetype=</code></strong><em>path</em> <br />
648 select the freetype files to use.</p>
649
650<p>Expecting the freetype libraries under <code>lib/</code> and the headers under
651 <code>include/</code>.</p>
652
653<p>Version 2.3 or newer of FreeType is required. On Unix systems required files
654 can be available as part of your distribution (while you still may need to
655 upgrade them). Note that you need development version of package that
656 includes both the FreeType library and header files.</p>
657
658<p>You can always download latest FreeType version from the <a href="http://www.freetype.org">FreeType
659 website</a>. Building the freetype 2 libraries from
660 scratch is also possible, however on Windows refer to the <a href="http://freetype.freedesktop.org/wiki/FreeType_DLL">Windows FreeType
661 DLL build instructions</a>.</p>
662
663<p>Note that by default FreeType is built with byte code hinting support
664 disabled due to licensing restrictions. In this case, text appearance and
665 metrics are expected to differ from Sun's official JDK build. See the
666 <a href="http://freetype.sourceforge.net/freetype2">SourceForge FreeType2 Home Page</a>
667 for more information.</p>
668
669<p><strong><code>--with-import-hotspot=</code></strong><em>path</em> <br />
670 select the location to find hotspot binaries from a previous build to avoid
671 building hotspot</p>
672
673<p><strong><code>--with-target-bits=</code></strong><em>arg</em> <br />
674 select 32 or 64 bit build</p>
675
676<p><strong><code>--with-jvm-variants=</code></strong><em>variants</em> <br />
677 select the JVM variants to build from, comma separated list that can
678 include: server, client, kernel, zero and zeroshark</p>
679
680<p><strong><code>--with-memory-size=</code></strong><em>size</em> <br />
681 select the RAM size that GNU make will think this system has</p>
682
683<p><strong><code>--with-msvcr-dll=</code></strong><em>path</em> <br />
684 select the <code>msvcr100.dll</code> file to include in the Windows builds (C/C++
685 runtime library for Visual Studio).</p>
686
687<p>This is usually picked up automatically from the redist directories of
688 Visual Studio 2013.</p>
689
690<p><strong><code>--with-num-cores=</code></strong><em>cores</em> <br />
691 select the number of cores to use (processor count or CPU count)</p>
692</blockquote>
693
694<p><a name="xrender"></a></p>
695
696<blockquote>
697 <p><strong><code>--with-x=</code></strong><em>path</em> <br />
698 select the location of the X11 and xrender files.</p>
699
700<p>The XRender Extension Headers are required for building the OpenJDK on
701 Solaris and Linux. The Linux header files are usually available from a
702 "Xrender" development package, it's recommended that you try and use the
703 package provided by the particular distribution of Linux that you are using.
704 The Solaris XRender header files is included with the other X11 header files
705 in the package <strong>SFWxwinc</strong> on new enough versions of Solaris and will be
706 installed in <code>/usr/X11/include/X11/extensions/Xrender.h</code> or
707 <code>/usr/openwin/share/include/X11/extensions/Xrender.h</code></p>
708</blockquote>
709
710<hr />
711
712<p><a name="make"></a></p>
713
714<h3>Make</h3>
715
716<p>The basic invocation of the <code>make</code> utility looks like:</p>
717
718<blockquote>
719 <p><strong><code>make all</code></strong></p>
720</blockquote>
721
722<p>This will start the build to the output directory containing the
723"configuration" that was created by the <code>configure</code> script. Run <code>make help</code> for
724more information on the available targets.</p>
725
726<p>There are some of the make targets that are of general interest:</p>
727
728<blockquote>
729 <p><em>empty</em> <br />
730 build everything but no images</p>
731
732<p><strong><code>all</code></strong> <br />
733 build everything including images</p>
734
735<p><strong><code>all-conf</code></strong> <br />
736 build all configurations</p>
737
738<p><strong><code>images</code></strong> <br />
739 create complete j2sdk and j2re images</p>
740
741<p><strong><code>install</code></strong> <br />
742 install the generated images locally, typically in <code>/usr/local</code></p>
743
744<p><strong><code>clean</code></strong> <br />
745 remove all files generated by make, but not those generated by <code>configure</code></p>
746
747<p><strong><code>dist-clean</code></strong> <br />
748 remove all files generated by both and <code>configure</code> (basically killing the
749 configuration)</p>
750
751<p><strong><code>help</code></strong> <br />
752 give some help on using <code>make</code>, including some interesting make targets</p>
753</blockquote>
754
755<hr />
756
757<p><a name="testing"></a></p>
758
759<h2>Testing</h2>
760
761<p>When the build is completed, you should see the generated binaries and
762associated files in the <code>j2sdk-image</code> directory in the output directory. In
763particular, the <code>build/*/images/j2sdk-image/bin</code> directory should contain
764executables for the OpenJDK tools and utilities for that configuration. The
765testing tool <code>jtreg</code> will be needed and can be found at: <a href="http://openjdk.java.net/jtreg/">the jtreg
766site</a>. The provided regression tests in the
767repositories can be run with the command:</p>
768
769<blockquote>
770 <p><strong><code>cd test &amp;&amp; make PRODUCT_HOME=`pwd`/../build/*/images/j2sdk-image all</code></strong></p>
771</blockquote>
772
773<hr />
774
775<p><a name="hints"></a></p>
776
777<h2>Appendix A: Hints and Tips</h2>
778
779<p><a name="faq"></a></p>
780
781<h3>FAQ</h3>
782
783<p><strong>Q:</strong> The <code>generated-configure.sh</code> file looks horrible! How are you going to
784edit it? <br />
785<strong>A:</strong> The <code>generated-configure.sh</code> file is generated (think "compiled") by the
786autoconf tools. The source code is in <code>configure.ac</code> and various .m4 files in
787common/autoconf, which are much more readable.</p>
788
789<p><strong>Q:</strong> Why is the <code>generated-configure.sh</code> file checked in, if it is
790generated? <br />
791<strong>A:</strong> If it was not generated, every user would need to have the autoconf
792tools installed, and re-generate the <code>configure</code> file as the first step. Our
793goal is to minimize the work needed to be done by the user to start building
794OpenJDK, and to minimize the number of external dependencies required.</p>
795
796<p><strong>Q:</strong> Do you require a specific version of autoconf for regenerating
797<code>generated-configure.sh</code>? <br />
798<strong>A:</strong> Yes, version 2.69 is required and should be easy enough to aquire on all
799supported operating systems. The reason for this is to avoid large spurious
800changes in <code>generated-configure.sh</code>.</p>
801
802<p><strong>Q:</strong> How do you regenerate <code>generated-configure.sh</code> after making changes to
803the input files? <br />
804<strong>A:</strong> Regnerating <code>generated-configure.sh</code> should always be done using the
805script <code>common/autoconf/autogen.sh</code> to ensure that the correct files get
806updated. This script should also be run after mercurial tries to merge
807<code>generated-configure.sh</code> as a merge of the generated file is not guaranteed to
808be correct.</p>
809
810<p><strong>Q:</strong> What are the files in <code>common/makefiles/support/*</code> for? They look like
811gibberish. <br />
812<strong>A:</strong> They are a somewhat ugly hack to compensate for command line length
813limitations on certain platforms (Windows, Solaris). Due to a combination of
814limitations in make and the shell, command lines containing too many files will
815not work properly. These helper files are part of an elaborate hack that will
816compress the command line in the makefile and then uncompress it safely. We're
817not proud of it, but it does fix the problem. If you have any better
818suggestions, we're all ears! :-)</p>
819
820<p><strong>Q:</strong> I want to see the output of the commands that make runs, like in the old
821build. How do I do that? <br />
822<strong>A:</strong> You specify the <code>LOG</code> variable to make. There are several log levels:</p>
823
824<ul>
825<li><strong><code>warn</code></strong> -- Default and very quiet.</li>
826<li><strong><code>info</code></strong> -- Shows more progress information than warn.</li>
827<li><strong><code>debug</code></strong> -- Echos all command lines and prints all macro calls for
828compilation definitions.</li>
829<li><strong><code>trace</code></strong> -- Echos all $(shell) command lines as well.</li>
830</ul>
831
832<p><strong>Q:</strong> When do I have to re-run <code>configure</code>? <br />
833<strong>A:</strong> Normally you will run <code>configure</code> only once for creating a
834configuration. You need to re-run configuration only if you want to change any
835configuration options, or if you pull down changes to the <code>configure</code> script.</p>
836
837<p><strong>Q:</strong> I have added a new source file. Do I need to modify the makefiles? <br />
838<strong>A:</strong> Normally, no. If you want to create e.g. a new native library, you will
839need to modify the makefiles. But for normal file additions or removals, no
840changes are needed. There are certan exceptions for some native libraries where
841the source files are spread over many directories which also contain sources
842for other libraries. In these cases it was simply easier to create include
843lists rather than excludes.</p>
844
845<p><strong>Q:</strong> When I run <code>configure --help</code>, I see many strange options, like
846<code>--dvidir</code>. What is this? <br />
847<strong>A:</strong> Configure provides a slew of options by default, to all projects that
848use autoconf. Most of them are not used in OpenJDK, so you can safely ignore
849them. To list only OpenJDK specific features, use <code>configure --help=short</code>
850instead.</p>
851
852<p><strong>Q:</strong> <code>configure</code> provides OpenJDK-specific features such as <code>--with-
853builddeps-server</code> that are not described in this document. What about those? <br />
854<strong>A:</strong> Try them out if you like! But be aware that most of these are
855experimental features. Many of them don't do anything at all at the moment; the
856option is just a placeholder. Others depend on pieces of code or infrastructure
857that is currently not ready for prime time.</p>
858
859<p><strong>Q:</strong> How will you make sure you don't break anything? <br />
860<strong>A:</strong> We have a script that compares the result of the new build system with
861the result of the old. For most part, we aim for (and achieve) byte-by-byte
862identical output. There are however technical issues with e.g. native binaries,
863which might differ in a byte-by-byte comparison, even when building twice with
864the old build system. For these, we compare relevant aspects (e.g. the symbol
865table and file size). Note that we still don't have 100% equivalence, but we're
866close.</p>
867
868<p><strong>Q:</strong> I noticed this thing X in the build that looks very broken by design.
869Why don't you fix it? <br />
870<strong>A:</strong> Our goal is to produce a build output that is as close as technically
871possible to the old build output. If things were weird in the old build, they
872will be weird in the new build. Often, things were weird before due to
873obscurity, but in the new build system the weird stuff comes up to the surface.
874The plan is to attack these things at a later stage, after the new build system
875is established.</p>
876
877<p><strong>Q:</strong> The code in the new build system is not that well-structured. Will you
878fix this? <br />
879<strong>A:</strong> Yes! The new build system has grown bit by bit as we converted the old
880system. When all of the old build system is converted, we can take a step back
881and clean up the structure of the new build system. Some of this we plan to do
882before replacing the old build system and some will need to wait until after.</p>
883
884<p><strong>Q:</strong> Is anything able to use the results of the new build's default make
885target? <br />
886<strong>A:</strong> Yes, this is the minimal (or roughly minimal) set of compiled output
887needed for a developer to actually execute the newly built JDK. The idea is
888that in an incremental development fashion, when doing a normal make, you
889should only spend time recompiling what's changed (making it purely
890incremental) and only do the work that's needed to actually run and test your
891code. The packaging stuff that is part of the <code>images</code> target is not needed for
892a normal developer who wants to test his new code. Even if it's quite fast,
893it's still unnecessary. We're targeting sub-second incremental rebuilds! ;-)
894(Or, well, at least single-digit seconds...)</p>
895
896<p><strong>Q:</strong> I usually set a specific environment variable when building, but I can't
897find the equivalent in the new build. What should I do? <br />
898<strong>A:</strong> It might very well be that we have neglected to add support for an
899option that was actually used from outside the build system. Email us and we
900will add support for it!</p>
901
902<p><a name="performance"></a></p>
903
904<h3>Build Performance Tips</h3>
905
906<p>Building OpenJDK requires a lot of horsepower. Some of the build tools can be
907adjusted to utilize more or less of resources such as parallel threads and
908memory. The <code>configure</code> script analyzes your system and selects reasonable
909values for such options based on your hardware. If you encounter resource
910problems, such as out of memory conditions, you can modify the detected values
911with:</p>
912
913<ul>
914<li><strong><code>--with-num-cores</code></strong> -- number of cores in the build system, e.g.
915<code>--with-num-cores=8</code></li>
916<li><strong><code>--with-memory-size</code></strong> -- memory (in MB) available in the build system,
917e.g. <code>--with-memory-size=1024</code></li>
918</ul>
919
920<p>It might also be necessary to specify the JVM arguments passed to the Bootstrap
921JDK, using e.g. <code>--with-boot-jdk-jvmargs="-Xmx8G -enableassertions"</code>. Doing
922this will override the default JVM arguments passed to the Bootstrap JDK.</p>
923
924<p>One of the top goals of the new build system is to improve the build
925performance and decrease the time needed to build. This will soon also apply to
926the java compilation when the Smart Javac wrapper is fully supported.</p>
927
928<p>At the end of a successful execution of <code>configure</code>, you will get a performance
929summary, indicating how well the build will perform. Here you will also get
930performance hints. If you want to build fast, pay attention to those!</p>
931
932<h4>Building with ccache</h4>
933
934<p>The OpenJDK build supports building with ccache when using gcc or clang. Using
935ccache can radically speed up compilation of native code if you often rebuild
936the same sources. Your milage may vary however so we recommend evaluating it
937for yourself. To enable it, make sure it's on the path and configure with
938<code>--enable-ccache</code>.</p>
939
940<h4>Building on local disk</h4>
941
942<p>If you are using network shares, e.g. via NFS, for your source code, make sure
943the build directory is situated on local disk. The performance penalty is
944extremely high for building on a network share, close to unusable.</p>
945
946<h4>Building only one JVM</h4>
947
948<p>The old build builds multiple JVMs on 32-bit systems (client and server; and on
949Windows kernel as well). In the new build we have changed this default to only
950build server when it's available. This improves build times for those not
951interested in multiple JVMs. To mimic the old behavior on platforms that
952support it, use <code>--with-jvm-variants=client,server</code>.</p>
953
954<h4>Selecting the number of cores to build on</h4>
955
956<p>By default, <code>configure</code> will analyze your machine and run the make process in
957parallel with as many threads as you have cores. This behavior can be
958overridden, either "permanently" (on a <code>configure</code> basis) using
959<code>--with-num-cores=N</code> or for a single build only (on a make basis), using
960<code>make JOBS=N</code>.</p>
961
962<p>If you want to make a slower build just this time, to save some CPU power for
963other processes, you can run e.g. <code>make JOBS=2</code>. This will force the makefiles
964to only run 2 parallel processes, or even <code>make JOBS=1</code> which will disable
965parallelism.</p>
966
967<p>If you want to have it the other way round, namely having slow builds default
968and override with fast if you're impatient, you should call <code>configure</code> with
969<code>--with-num-cores=2</code>, making 2 the default. If you want to run with more cores,
970run <code>make JOBS=8</code></p>
971
972<p><a name="troubleshooting"></a></p>
973
974<h3>Troubleshooting</h3>
975
976<h4>Solving build problems</h4>
977
978<p>If the build fails (and it's not due to a compilation error in a source file
979you've changed), the first thing you should do is to re-run the build with more
980verbosity. Do this by adding <code>LOG=debug</code> to your make command line.</p>
981
982<p>The build log (with both stdout and stderr intermingled, basically the same as
983you see on your console) can be found as <code>build.log</code> in your build directory.</p>
984
985<p>You can ask for help on build problems with the new build system on either the
986<a href="http://mail.openjdk.java.net/mailman/listinfo/build-dev">build-dev</a> or the
987<a href="http://mail.openjdk.java.net/mailman/listinfo/build-infra-dev">build-infra-dev</a>
988mailing lists. Please include the relevant parts of the build log.</p>
989
990<p>A build can fail for any number of reasons. Most failures are a result of
991trying to build in an environment in which all the pre-build requirements have
992not been met. The first step in troubleshooting a build failure is to recheck
993that you have satisfied all the pre-build requirements for your platform.
994Scanning the <code>configure</code> log is a good first step, making sure that what it
995found makes sense for your system. Look for strange error messages or any
996difficulties that <code>configure</code> had in finding things.</p>
997
998<p>Some of the more common problems with builds are briefly described below, with
999suggestions for remedies.</p>
1000
1001<ul>
1002<li><p><strong>Corrupted Bundles on Windows:</strong> <br />
1003Some virus scanning software has been known to corrupt the downloading of
1004zip bundles. It may be necessary to disable the 'on access' or 'real time'
1005virus scanning features to prevent this corruption. This type of 'real time'
1006virus scanning can also slow down the build process significantly.
1007Temporarily disabling the feature, or excluding the build output directory
1008may be necessary to get correct and faster builds.</p></li>
1009<li><p><strong>Slow Builds:</strong> <br />
1010If your build machine seems to be overloaded from too many simultaneous C++
1011compiles, try setting the <code>JOBS=1</code> on the <code>make</code> command line. Then try
1012increasing the count slowly to an acceptable level for your system. Also:</p>
1013
1014<p>Creating the javadocs can be very slow, if you are running javadoc, consider
1015skipping that step.</p>
1016
1017<p>Faster CPUs, more RAM, and a faster DISK usually helps. The VM build tends
1018to be CPU intensive (many C++ compiles), and the rest of the JDK will often
1019be disk intensive.</p>
1020
1021<p>Faster compiles are possible using a tool called
1022<a href="http://ccache.samba.org/">ccache</a>.</p></li>
1023<li><p><strong>File time issues:</strong> <br />
1024If you see warnings that refer to file time stamps, e.g.</p>
1025
1026<blockquote>
1027 <p><em>Warning message:</em> <code>File 'xxx' has modification time in the future.</code> <br />
1028<em>Warning message:</em> <code>Clock skew detected. Your build may be incomplete.</code></p>
1029</blockquote>
1030
1031<p>These warnings can occur when the clock on the build machine is out of sync
1032with the timestamps on the source files. Other errors, apparently unrelated
1033but in fact caused by the clock skew, can occur along with the clock skew
1034warnings. These secondary errors may tend to obscure the fact that the true
1035root cause of the problem is an out-of-sync clock.</p>
1036
1037<p>If you see these warnings, reset the clock on the build machine, run
1038"<code>gmake clobber</code>" or delete the directory containing the build output, and
1039restart the build from the beginning.</p></li>
1040<li><p><strong>Error message: <code>Trouble writing out table to disk</code></strong> <br />
1041Increase the amount of swap space on your build machine. This could be
1042caused by overloading the system and it may be necessary to use:</p>
1043
1044<blockquote>
1045 <p><code>make JOBS=1</code></p>
1046</blockquote>
1047
1048<p>to reduce the load on the system.</p></li>
1049<li><p><strong>Error Message: <code>libstdc++ not found</code>:</strong> <br />
1050This is caused by a missing libstdc++.a library. This is installed as part
1051of a specific package (e.g. libstdc++.so.devel.386). By default some 64-bit
1052Linux versions (e.g. Fedora) only install the 64-bit version of the
1053libstdc++ package. Various parts of the JDK build require a static link of
1054the C++ runtime libraries to allow for maximum portability of the built
1055images.</p></li>
1056<li><p><strong>Linux Error Message: <code>cannot restore segment prot after reloc</code></strong> <br />
1057This is probably an issue with SELinux (See <a href="http://en.wikipedia.org/wiki/SELinux">SELinux on
1058Wikipedia</a>). Parts of the VM is built
1059without the <code>-fPIC</code> for performance reasons.</p>
1060
1061<p>To completely disable SELinux:</p>
1062
1063<ol>
1064<li><code>$ su root</code></li>
1065<li><code># system-config-securitylevel</code></li>
1066<li><code>In the window that appears, select the SELinux tab</code></li>
1067<li><code>Disable SELinux</code></li>
1068</ol>
1069
1070<p>Alternatively, instead of completely disabling it you could disable just
1071this one check.</p>
1072
1073<ol>
1074<li>Select System->Administration->SELinux Management</li>
1075<li>In the SELinux Management Tool which appears, select "Boolean" from the
1076menu on the left</li>
1077<li>Expand the "Memory Protection" group</li>
1078<li>Check the first item, labeled "Allow all unconfined executables to use
1079libraries requiring text relocation ..."</li>
1080</ol></li>
1081<li><p><strong>Windows Error Messages:</strong> <br />
1082<code>*** fatal error - couldn't allocate heap, ...</code> <br />
1083<code>rm fails with "Directory not empty"</code> <br />
1084<code>unzip fails with "cannot create ... Permission denied"</code> <br />
1085<code>unzip fails with "cannot create ... Error 50"</code></p>
1086
1087<p>The CYGWIN software can conflict with other non-CYGWIN software. See the
1088CYGWIN FAQ section on <a href="http://cygwin.com/faq/faq.using.html#faq.using.bloda">BLODA (applications that interfere with
1089CYGWIN)</a>.</p></li>
1090<li><p><strong>Windows Error Message: <code>spawn failed</code></strong> <br />
1091Try rebooting the system, or there could be some kind of issue with the disk
1092or disk partition being used. Sometimes it comes with a "Permission Denied"
1093message.</p></li>
1094</ul>
1095
1096<hr />
1097
1098<p><a name="gmake"></a></p>
1099
1100<h2>Appendix B: GNU make</h2>
1101
1102<p>The Makefiles in the OpenJDK are only valid when used with the GNU version of
1103the utility command <code>make</code> (usually called <code>gmake</code> on Solaris). A few notes
1104about using GNU make:</p>
1105
1106<ul>
1107<li>You need GNU make version 3.81 or newer. On Windows 4.0 or newer is
1108recommended. If the GNU make utility on your systems is not of a suitable
1109version, see "<a href="#buildgmake">Building GNU make</a>".</li>
1110<li>Place the location of the GNU make binary in the <code>PATH</code>.</li>
1111<li><strong>Solaris:</strong> Do NOT use <code>/usr/bin/make</code> on Solaris. If your Solaris system
1112has the software from the Solaris Developer Companion CD installed, you
Alan Burlison731eb072016-09-21 14:20:27 +0200[diff] [blame]1113should try and use <code>/usr/bin/gmake</code> or <code>/usr/gnu/bin/make</code>.</li>
Magnus Ihse Bursie17c89682015-10-20 10:39:07 +0200[diff] [blame]1114<li><strong>Windows:</strong> Make sure you start your build inside a bash shell.</li>
1115<li><strong>Mac OS X:</strong> The XCode "command line tools" must be installed on your Mac.</li>
1116</ul>
1117
1118<p>Information on GNU make, and access to ftp download sites, are available on the
1119<a href="http://www.gnu.org/software/make/make.html">GNU make web site </a>. The latest
1120source to GNU make is available at
1121<a href="http://ftp.gnu.org/pub/gnu/make/">ftp.gnu.org/pub/gnu/make/</a>.</p>
1122
1123<p><a name="buildgmake"></a></p>
1124
1125<h3>Building GNU make</h3>
1126
1127<p>First step is to get the GNU make 3.81 or newer source from
1128<a href="http://ftp.gnu.org/pub/gnu/make/">ftp.gnu.org/pub/gnu/make/</a>. Building is a
1129little different depending on the OS but is basically done with:</p>
1130
1131<pre><code> bash ./configure
1132 make
1133</code></pre>
1134
1135<hr />
1136
1137<p><a name="buildenvironments"></a></p>
1138
1139<h2>Appendix C: Build Environments</h2>
1140
1141<h3>Minimum Build Environments</h3>
1142
1143<p>This file often describes specific requirements for what we call the "minimum
1144build environments" (MBE) for this specific release of the JDK. What is listed
1145below is what the Oracle Release Engineering Team will use to build the Oracle
1146JDK product. Building with the MBE will hopefully generate the most compatible
1147bits that install on, and run correctly on, the most variations of the same
1148base OS and hardware architecture. In some cases, these represent what is often
1149called the least common denominator, but each Operating System has different
1150aspects to it.</p>
1151
1152<p>In all cases, the Bootstrap JDK version minimum is critical, we cannot
1153guarantee builds will work with older Bootstrap JDK's. Also in all cases, more
1154RAM and more processors is better, the minimums listed below are simply
1155recommendations.</p>
1156
1157<p>With Solaris and Mac OS X, the version listed below is the oldest release we
1158can guarantee builds and works, and the specific version of the compilers used
1159could be critical.</p>
1160
1161<p>With Windows the critical aspect is the Visual Studio compiler used, which due
1162to it's runtime, generally dictates what Windows systems can do the builds and
1163where the resulting bits can be used.</p>
1164
1165<p><strong>NOTE: We expect a change here off these older Windows OS releases and to a
1166'less older' one, probably Windows 2008R2 X64.</strong></p>
1167
1168<p>With Linux, it was just a matter of picking a stable distribution that is a
1169good representative for Linux in general.</p>
1170
Magnus Ihse Bursie17c89682015-10-20 10:39:07 +0200[diff] [blame]1171<p>It is understood that most developers will NOT be using these specific
1172versions, and in fact creating these specific versions may be difficult due to
1173the age of some of this software. It is expected that developers are more often
1174using the more recent releases and distributions of these operating systems.</p>
1175
1176<p>Compilation problems with newer or different C/C++ compilers is a common
1177problem. Similarly, compilation problems related to changes to the
1178<code>/usr/include</code> or system header files is also a common problem with older,
1179newer, or unreleased OS versions. Please report these types of problems as bugs
1180so that they can be dealt with accordingly.</p>
1181
1182<blockquote>
1183 <p><table border="1">
1184 <thead>
1185 <tr>
1186 <th>Base OS and Architecture</th>
1187 <th>OS</th>
1188 <th>C/C++ Compiler</th>
1189 <th>Bootstrap JDK</th>
1190 <th>Processors</th>
1191 <th>RAM Minimum</th>
1192 <th>DISK Needs</th>
1193 </tr>
1194 </thead>
1195 <tbody>
1196 <tr>
1197 <td>Linux X86 (32-bit) and X64 (64-bit)</td>
1198 <td>Oracle Enterprise Linux 6.4</td>
Erik Joelssone35dab12015-12-15 15:45:53 +0100[diff] [blame]1199 <td>gcc 4.9.2 </td>
Magnus Ihse Bursie17c89682015-10-20 10:39:07 +0200[diff] [blame]1200 <td>JDK 8</td>
1201 <td>2 or more</td>
1202 <td>1 GB</td>
1203 <td>6 GB</td>
1204 </tr>
1205 <tr>
1206 <td>Solaris SPARCV9 (64-bit)</td>
Erik Joelssone35dab12015-12-15 15:45:53 +0100[diff] [blame]1207 <td>Solaris 11 Update 1</td>
1208 <td>Studio 12 Update 4 + patches</td>
Magnus Ihse Bursie17c89682015-10-20 10:39:07 +0200[diff] [blame]1209 <td>JDK 8</td>
1210 <td>4 or more</td>
1211 <td>4 GB</td>
1212 <td>8 GB</td>
1213 </tr>
1214 <tr>
1215 <td>Solaris X64 (64-bit)</td>
Erik Joelssone35dab12015-12-15 15:45:53 +0100[diff] [blame]1216 <td>Solaris 11 Update 1</td>
1217 <td>Studio 12 Update 4 + patches</td>
Magnus Ihse Bursie17c89682015-10-20 10:39:07 +0200[diff] [blame]1218 <td>JDK 8</td>
1219 <td>4 or more</td>
1220 <td>4 GB</td>
1221 <td>8 GB</td>
1222 </tr>
1223 <tr>
1224 <td>Windows X86 (32-bit)</td>
1225 <td>Windows Server 2012 R2 x64</td>
1226 <td>Microsoft Visual Studio C++ 2013 Professional Edition</td>
1227 <td>JDK 8</td>
1228 <td>2 or more</td>
1229 <td>2 GB</td>
1230 <td>6 GB</td>
1231 </tr>
1232 <tr>
1233 <td>Windows X64 (64-bit)</td>
1234 <td>Windows Server 2012 R2 x64</td>
1235 <td>Microsoft Visual Studio C++ 2013 Professional Edition</td>
1236 <td>JDK 8</td>
1237 <td>2 or more</td>
1238 <td>2 GB</td>
1239 <td>6 GB</td>
1240 </tr>
1241 <tr>
1242 <td>Mac OS X X64 (64-bit)</td>
1243 <td>Mac OS X 10.9 "Mavericks"</td>
Erik Joelssone35dab12015-12-15 15:45:53 +0100[diff] [blame]1244 <td>Xcode 6.3 or newer</td>
Magnus Ihse Bursie17c89682015-10-20 10:39:07 +0200[diff] [blame]1245 <td>JDK 8</td>
1246 <td>2 or more</td>
1247 <td>4 GB</td>
1248 <td>6 GB</td>
1249 </tr>
1250 </tbody>
1251 </table></p>
1252</blockquote>
1253
1254<hr />
1255
1256<p><a name="SDBE"></a></p>
1257
1258<h3>Specific Developer Build Environments</h3>
1259
1260<p>We won't be listing all the possible environments, but we will try to provide
1261what information we have available to us.</p>
1262
1263<p><strong>NOTE: The community can help out by updating this part of the document.</strong></p>
1264
1265<h4>Fedora</h4>
1266
1267<p>After installing the latest <a href="http://fedoraproject.org">Fedora</a> you need to
1268install several build dependencies. The simplest way to do it is to execute the
1269following commands as user <code>root</code>:</p>
1270
1271<pre><code> yum-builddep java-1.7.0-openjdk
1272 yum install gcc gcc-c++
1273</code></pre>
1274
1275<p>In addition, it's necessary to set a few environment variables for the build:</p>
1276
1277<pre><code> export LANG=C
1278 export PATH="/usr/lib/jvm/java-openjdk/bin:${PATH}"
1279</code></pre>
1280
1281<h4>CentOS 5.5</h4>
1282
1283<p>After installing <a href="http://www.centos.org/">CentOS 5.5</a> you need to make sure you
1284have the following Development bundles installed:</p>
1285
1286<ul>
1287<li>Development Libraries</li>
1288<li>Development Tools</li>
1289<li>Java Development</li>
1290<li>X Software Development (Including XFree86-devel)</li>
1291</ul>
1292
1293<p>Plus the following packages:</p>
1294
1295<ul>
1296<li>cups devel: Cups Development Package</li>
1297<li>alsa devel: Alsa Development Package</li>
1298<li>Xi devel: libXi.so Development Package</li>
1299</ul>
1300
1301<p>The freetype 2.3 packages don't seem to be available, but the freetype 2.3
1302sources can be downloaded, built, and installed easily enough from <a href="http://downloads.sourceforge.net/freetype">the
1303freetype site</a>. Build and install
1304with something like:</p>
1305
1306<pre><code> bash ./configure
1307 make
1308 sudo -u root make install
1309</code></pre>
1310
1311<p>Mercurial packages could not be found easily, but a Google search should find
1312ones, and they usually include Python if it's needed.</p>
1313
1314<h4>Debian 5.0 (Lenny)</h4>
1315
1316<p>After installing <a href="http://debian.org">Debian</a> 5 you need to install several
1317build dependencies. The simplest way to install the build dependencies is to
1318execute the following commands as user <code>root</code>:</p>
1319
1320<pre><code> aptitude build-dep openjdk-7
1321 aptitude install openjdk-7-jdk libmotif-dev
1322</code></pre>
1323
1324<p>In addition, it's necessary to set a few environment variables for the build:</p>
1325
1326<pre><code> export LANG=C
1327 export PATH="/usr/lib/jvm/java-7-openjdk/bin:${PATH}"
1328</code></pre>
1329
1330<h4>Ubuntu 12.04</h4>
1331
1332<p>After installing <a href="http://ubuntu.org">Ubuntu</a> 12.04 you need to install several
1333build dependencies. The simplest way to do it is to execute the following
1334commands:</p>
1335
1336<pre><code> sudo aptitude build-dep openjdk-7
1337 sudo aptitude install openjdk-7-jdk
1338</code></pre>
1339
1340<p>In addition, it's necessary to set a few environment variables for the build:</p>
1341
1342<pre><code> export LANG=C
1343 export PATH="/usr/lib/jvm/java-7-openjdk/bin:${PATH}"
1344</code></pre>
1345
1346<h4>OpenSUSE 11.1</h4>
1347
1348<p>After installing <a href="http://opensuse.org">OpenSUSE</a> 11.1 you need to install
1349several build dependencies. The simplest way to install the build dependencies
1350is to execute the following commands:</p>
1351
1352<pre><code> sudo zypper source-install -d java-1_7_0-openjdk
1353 sudo zypper install make
1354</code></pre>
1355
1356<p>In addition, it is necessary to set a few environment variables for the build:</p>
1357
1358<pre><code> export LANG=C
1359 export PATH="/usr/lib/jvm/java-1.7.0-openjdk/bin:$[PATH}"
1360</code></pre>
1361
1362<p>Finally, you need to unset the <code>JAVA_HOME</code> environment variable:</p>
1363
1364<pre><code> export -n JAVA_HOME`
1365</code></pre>
1366
1367<h4>Mandriva Linux One 2009 Spring</h4>
1368
1369<p>After installing <a href="http://mandriva.org">Mandriva</a> Linux One 2009 Spring you need
1370to install several build dependencies. The simplest way to install the build
1371dependencies is to execute the following commands as user <code>root</code>:</p>
1372
1373<pre><code> urpmi java-1.7.0-openjdk-devel make gcc gcc-c++ freetype-devel zip unzip
1374 libcups2-devel libxrender1-devel libalsa2-devel libstc++-static-devel
1375 libxtst6-devel libxi-devel
1376</code></pre>
1377
1378<p>In addition, it is necessary to set a few environment variables for the build:</p>
1379
1380<pre><code> export LANG=C
1381 export PATH="/usr/lib/jvm/java-1.7.0-openjdk/bin:${PATH}"
1382</code></pre>
1383
1384<h4>OpenSolaris 2009.06</h4>
1385
1386<p>After installing <a href="http://opensolaris.org">OpenSolaris</a> 2009.06 you need to
1387install several build dependencies. The simplest way to install the build
1388dependencies is to execute the following commands:</p>
1389
1390<pre><code> pfexec pkg install SUNWgmake SUNWj7dev sunstudioexpress SUNWcups SUNWzip
1391 SUNWunzip SUNWxwhl SUNWxorg-headers SUNWaudh SUNWfreetype2
1392</code></pre>
1393
1394<p>In addition, it is necessary to set a few environment variables for the build:</p>
1395
1396<pre><code> export LANG=C
1397 export PATH="/opt/SunStudioExpress/bin:${PATH}"
1398</code></pre>
1399
1400<hr />
1401
1402<p>End of the OpenJDK build README document.</p>
1403
1404<p>Please come again!</p>
1405 </body>
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -0700[diff] [blame]1406</html>