annotate common/doc/building.html @ 2689:1b1226687b89

Added tag jdk-9.0.4+12 for changeset 2e265b4b8622
author robm
date Wed, 14 Feb 2018 06:54:58 -0800
parents 9c70f25ca307
children
rev   line source
ihse@2591 1 <!DOCTYPE html>
ihse@2591 2 <html>
ihse@2520 3 <head>
ihse@2591 4 <meta charset="utf-8">
ihse@2591 5 <meta name="generator" content="pandoc">
ihse@2591 6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
ihse@2619 7 <title>Building OpenJDK</title>
ihse@2520 8 <style type="text/css">code{white-space: pre;}</style>
ihse@2619 9 <link rel="stylesheet" href="../../jdk/make/data/docs-resources/resources/jdk-default.css">
ihse@2591 10 <!--[if lt IE 9]>
ihse@2591 11 <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
ihse@2591 12 <![endif]-->
ihse@2619 13 <style type="text/css">pre, code, tt { color: #1d6ae5; }</style>
ihse@2520 14 </head>
ihse@2520 15 <body>
ihse@2591 16 <header>
ihse@2619 17 <h1 class="title">Building OpenJDK</h1>
ihse@2591 18 </header>
ihse@2619 19 <nav id="TOC">
ihse@2619 20 <ul>
ihse@2619 21 <li><a href="#tldr-instructions-for-the-impatient">TL;DR (Instructions for the Impatient)</a></li>
ihse@2619 22 <li><a href="#introduction">Introduction</a></li>
ihse@2619 23 <li><a href="#getting-the-source-code">Getting the Source Code</a><ul>
ihse@2619 24 <li><a href="#special-considerations">Special Considerations</a></li>
ihse@2619 25 <li><a href="#using-get_source.sh">Using get_source.sh</a></li>
ihse@2619 26 <li><a href="#using-hgforest.sh">Using hgforest.sh</a></li>
ihse@2619 27 <li><a href="#using-the-trees-extension">Using the Trees Extension</a></li>
ihse@2619 28 </ul></li>
ihse@2619 29 <li><a href="#build-hardware-requirements">Build Hardware Requirements</a><ul>
ihse@2619 30 <li><a href="#building-on-x86">Building on x86</a></li>
ihse@2619 31 <li><a href="#building-on-sparc">Building on sparc</a></li>
ihse@2619 32 <li><a href="#building-on-armaarch64">Building on arm/aarch64</a></li>
ihse@2619 33 </ul></li>
ihse@2619 34 <li><a href="#operating-system-requirements">Operating System Requirements</a><ul>
ihse@2619 35 <li><a href="#windows">Windows</a></li>
ihse@2619 36 <li><a href="#solaris">Solaris</a></li>
ihse@2619 37 <li><a href="#macos">macOS</a></li>
ihse@2619 38 <li><a href="#linux">Linux</a></li>
ihse@2619 39 <li><a href="#aix">AIX</a></li>
ihse@2619 40 </ul></li>
ihse@2619 41 <li><a href="#native-compiler-toolchain-requirements">Native Compiler (Toolchain) Requirements</a><ul>
ihse@2619 42 <li><a href="#gcc">gcc</a></li>
ihse@2619 43 <li><a href="#clang">clang</a></li>
ihse@2619 44 <li><a href="#apple-xcode">Apple Xcode</a></li>
ihse@2619 45 <li><a href="#oracle-solaris-studio">Oracle Solaris Studio</a></li>
ihse@2619 46 <li><a href="#microsoft-visual-studio">Microsoft Visual Studio</a></li>
ihse@2619 47 <li><a href="#ibm-xl-cc">IBM XL C/C++</a></li>
ihse@2619 48 </ul></li>
ihse@2619 49 <li><a href="#boot-jdk-requirements">Boot JDK Requirements</a><ul>
ihse@2619 50 <li><a href="#jdk-8-on-linux">JDK 8 on Linux</a></li>
ihse@2619 51 <li><a href="#jdk-8-on-windows">JDK 8 on Windows</a></li>
ihse@2619 52 <li><a href="#jdk-8-on-macos">JDK 8 on macOS</a></li>
ihse@2619 53 <li><a href="#jdk-8-on-aix">JDK 8 on AIX</a></li>
ihse@2619 54 </ul></li>
ihse@2619 55 <li><a href="#external-library-requirements">External Library Requirements</a><ul>
ihse@2619 56 <li><a href="#freetype">FreeType</a></li>
ihse@2619 57 <li><a href="#cups">CUPS</a></li>
ihse@2619 58 <li><a href="#x11">X11</a></li>
ihse@2619 59 <li><a href="#alsa">ALSA</a></li>
ihse@2619 60 <li><a href="#libffi">libffi</a></li>
ihse@2619 61 <li><a href="#libelf">libelf</a></li>
ihse@2619 62 </ul></li>
ihse@2619 63 <li><a href="#other-tooling-requirements">Other Tooling Requirements</a><ul>
ihse@2619 64 <li><a href="#gnu-make">GNU Make</a></li>
ihse@2619 65 <li><a href="#gnu-bash">GNU Bash</a></li>
ihse@2619 66 <li><a href="#autoconf">Autoconf</a></li>
ihse@2619 67 </ul></li>
ihse@2619 68 <li><a href="#running-configure">Running Configure</a><ul>
ihse@2619 69 <li><a href="#common-configure-arguments">Common Configure Arguments</a></li>
ihse@2619 70 <li><a href="#configure-control-variables">Configure Control Variables</a></li>
ihse@2619 71 </ul></li>
ihse@2619 72 <li><a href="#running-make">Running Make</a><ul>
ihse@2619 73 <li><a href="#common-make-targets">Common Make Targets</a></li>
ihse@2619 74 <li><a href="#make-control-variables">Make Control Variables</a></li>
ihse@2619 75 </ul></li>
ihse@2619 76 <li><a href="#running-tests">Running Tests</a></li>
ihse@2619 77 <li><a href="#cross-compiling">Cross-compiling</a><ul>
ihse@2619 78 <li><a href="#boot-jdk-and-build-jdk">Boot JDK and Build JDK</a></li>
ihse@2619 79 <li><a href="#specifying-the-target-platform">Specifying the Target Platform</a></li>
ihse@2619 80 <li><a href="#toolchain-considerations">Toolchain Considerations</a></li>
ihse@2619 81 <li><a href="#native-libraries">Native Libraries</a></li>
ihse@2619 82 <li><a href="#building-for-armaarch64">Building for ARM/aarch64</a></li>
ihse@2619 83 <li><a href="#verifying-the-build">Verifying the Build</a></li>
ihse@2619 84 </ul></li>
ihse@2619 85 <li><a href="#build-performance">Build Performance</a><ul>
ihse@2619 86 <li><a href="#disk-speed">Disk Speed</a></li>
ihse@2619 87 <li><a href="#virus-checking">Virus Checking</a></li>
ihse@2619 88 <li><a href="#ccache">Ccache</a></li>
ihse@2619 89 <li><a href="#precompiled-headers">Precompiled Headers</a></li>
ihse@2619 90 <li><a href="#icecc-icecream">Icecc / icecream</a></li>
ihse@2619 91 <li><a href="#using-sjavac">Using sjavac</a></li>
ihse@2619 92 <li><a href="#building-the-right-target">Building the Right Target</a></li>
ihse@2619 93 </ul></li>
ihse@2619 94 <li><a href="#troubleshooting">Troubleshooting</a><ul>
ihse@2619 95 <li><a href="#locating-the-source-of-the-error">Locating the Source of the Error</a></li>
ihse@2619 96 <li><a href="#fixing-unexpected-build-failures">Fixing Unexpected Build Failures</a></li>
ihse@2619 97 <li><a href="#specific-build-issues">Specific Build Issues</a></li>
ihse@2619 98 <li><a href="#getting-help">Getting Help</a></li>
ihse@2619 99 </ul></li>
ihse@2619 100 <li><a href="#hints-and-suggestions-for-advanced-users">Hints and Suggestions for Advanced Users</a><ul>
ihse@2619 101 <li><a href="#setting-up-a-forest-for-pushing-changes-defpath">Setting Up a Forest for Pushing Changes (defpath)</a></li>
ihse@2619 102 <li><a href="#bash-completion">Bash Completion</a></li>
ihse@2619 103 <li><a href="#using-multiple-configurations">Using Multiple Configurations</a></li>
ihse@2619 104 <li><a href="#handling-reconfigurations">Handling Reconfigurations</a></li>
ihse@2619 105 <li><a href="#using-fine-grained-make-targets">Using Fine-Grained Make Targets</a></li>
ihse@2619 106 <li><a href="#learn-about-mercurial">Learn About Mercurial</a></li>
ihse@2619 107 </ul></li>
ihse@2619 108 <li><a href="#understanding-the-build-system">Understanding the Build System</a><ul>
ihse@2619 109 <li><a href="#configurations">Configurations</a></li>
ihse@2619 110 <li><a href="#build-output-structure">Build Output Structure</a></li>
ihse@2619 111 <li><a href="#fixpath">Fixpath</a></li>
ihse@2619 112 <li><a href="#native-debug-symbols">Native Debug Symbols</a></li>
ihse@2619 113 <li><a href="#autoconf-details">Autoconf Details</a></li>
ihse@2619 114 <li><a href="#developing-the-build-system-itself">Developing the Build System Itself</a></li>
ihse@2619 115 </ul></li>
ihse@2619 116 <li><a href="#contributing-to-openjdk">Contributing to OpenJDK</a></li>
ihse@2619 117 </ul>
ihse@2619 118 </nav>
ihse@2619 119 <h2 id="tldr-instructions-for-the-impatient">TL;DR (Instructions for the Impatient)</h2>
ihse@2619 120 <p>If you are eager to try out building OpenJDK, these simple steps works most of the time. They assume that you have installed Mercurial (and Cygwin if running on Windows) and cloned the top-level OpenJDK repository that you want to build.</p>
ihse@2619 121 <ol type="1">
ihse@2619 122 <li><p><a href="#getting-the-source-code">Get the complete source code</a>:<br />
ihse@2619 123 <code>bash get_source.sh</code></p></li>
ihse@2619 124 <li><p><a href="#running-configure">Run configure</a>:<br />
ihse@2619 125 <code>bash configure</code></p>
ihse@2619 126 <p>If <code>configure</code> fails due to missing dependencies (to either the <a href="#native-compiler-toolchain-requirements">toolchain</a>, <a href="#external-library-requirements">external libraries</a> or the <a href="#boot-jdk-requirements">boot JDK</a>), most of the time it prints a suggestion on how to resolve the situation on your platform. Follow the instructions, and try running <code>bash configure</code> again.</p></li>
ihse@2619 127 <li><p><a href="#running-make">Run make</a>:<br />
ihse@2619 128 <code>make images</code></p></li>
ihse@2619 129 <li><p>Verify your newly built JDK:<br />
ihse@2619 130 <code>./build/*/images/jdk/bin/java -version</code></p></li>
ihse@2619 131 <li><p><a href="##running-tests">Run basic tests</a>:<br />
ihse@2619 132 <code>make run-test-tier1</code></p></li>
ihse@2619 133 </ol>
ihse@2619 134 <p>If any of these steps failed, or if you want to know more about build requirements or build functionality, please continue reading this document.</p>
ihse@2520 135 <h2 id="introduction">Introduction</h2>
ihse@2619 136 <p>OpenJDK is a complex software project. Building it requires a certain amount of technical expertise, a fair number of dependencies on external software, and reasonably powerful hardware.</p>
ihse@2619 137 <p>If you just want to use OpenJDK and not build it yourself, this document is not for you. See for instance <a href="http://openjdk.java.net/install">OpenJDK installation</a> for some methods of installing a prebuilt OpenJDK.</p>
ihse@2619 138 <h2 id="getting-the-source-code">Getting the Source Code</h2>
ihse@2619 139 <p>OpenJDK uses <a href="http://www.mercurial-scm.org">Mercurial</a> for source control. The source code is contained not in a single Mercurial repository, but in a tree (&quot;forest&quot;) of interrelated repositories. You will need to check out all of the repositories to be able to build OpenJDK. To assist you in dealing with this somewhat unusual arrangement, there are multiple tools available, which are explained below.</p>
ihse@2619 140 <p>In any case, make sure you are getting the correct version. At the <a href="http://hg.openjdk.java.net/">OpenJDK Mercurial server</a> you can see a list of all available forests. If you want to build an older version, e.g. JDK 8, it is recommended that you get the <code>jdk8u</code> forest, which contains incremental updates, instead of the <code>jdk8</code> forest, which was frozen at JDK 8 GA.</p>
ihse@2619 141 <p>If you are new to Mercurial, a good place to start is the <a href="http://www.mercurial-scm.org/guide">Mercurial Beginner's Guide</a>. The rest of this document assumes a working knowledge of Mercurial.</p>
ihse@2619 142 <h3 id="special-considerations">Special Considerations</h3>
ihse@2619 143 <p>For a smooth building experience, it is recommended that you follow these rules on where and how to check out the source code.</p>
ihse@1680 144 <ul>
ihse@2619 145 <li><p>Do not check out the source code in a path which contains spaces. Chances are the build will not work. This is most likely to be an issue on Windows systems.</p></li>
ihse@2619 146 <li><p>Do not check out the source code in a path which has a very long name or is nested many levels deep. Chances are you will hit an OS limitation during the build.</p></li>
ihse@2619 147 <li><p>Put the source code on a local disk, not a network share. If possible, use an SSD. The build process is very disk intensive, and having slow disk access will significantly increase build times. If you need to use a network share for the source code, see below for suggestions on how to keep the build artifacts on a local disk.</p></li>
ihse@2619 148 <li><p>On Windows, extra care must be taken to make sure the <a href="#cygwin">Cygwin</a> environment is consistent. It is recommended that you follow this procedure:</p>
ihse@2619 149 <ul>
ihse@2619 150 <li><p>Create the directory that is going to contain the top directory of the OpenJDK clone by using the <code>mkdir</code> command in the Cygwin bash shell. That is, do <em>not</em> create it using Windows Explorer. This will ensure that it will have proper Cygwin attributes, and that it's children will inherit those attributes.</p></li>
ihse@2619 151 <li><p>Do not put the OpenJDK clone in a path under your Cygwin home directory. This is especially important if your user name contains spaces and/or mixed upper and lower case letters.</p></li>
ihse@2619 152 <li><p>Clone the OpenJDK repository using the Cygwin command line <code>hg</code> client as instructed in this document. That is, do <em>not</em> use another Mercurial client such as TortoiseHg.</p></li>
ihse@1680 153 </ul>
ihse@2619 154 <p>Failure to follow this procedure might result in hard-to-debug build problems.</p></li>
ihse@2619 155 </ul>
ihse@2619 156 <h3 id="using-get_source.sh">Using get_source.sh</h3>
ihse@2619 157 <p>The simplest way to get the entire forest is probably to clone the top-level repository and then run the <code>get_source.sh</code> script, like this:</p>
ihse@2619 158 <pre><code>hg clone http://hg.openjdk.java.net/jdk9/jdk9
ihse@2619 159 cd jdk9
ihse@2619 160 bash get_source.sh</code></pre>
ihse@2619 161 <p>The first time this is run, it will clone all the sub-repositories. Any subsequent execution of the script will update all sub-repositories to the latest revision.</p>
ihse@2619 162 <h3 id="using-hgforest.sh">Using hgforest.sh</h3>
ihse@2619 163 <p>The <code>hgforest.sh</code> script is more expressive than <code>get_source.sh</code>. It takes any number of arguments, and runs <code>hg</code> with those arguments on each sub-repository in the forest. The <code>get_source.sh</code> script is basically a simple wrapper that runs either <code>hgforest.sh clone</code> or <code>hgforest.sh pull -u</code>.</p>
ihse@1680 164 <ul>
ihse@2619 165 <li><p>Cloning the forest:</p>
ihse@2619 166 <pre><code>hg clone http://hg.openjdk.java.net/jdk9/jdk9
ihse@2619 167 cd jdk9
ihse@2619 168 bash common/bin/hgforest.sh clone</code></pre></li>
ihse@2619 169 <li><p>Pulling and updating the forest:</p>
ihse@2619 170 <pre><code>bash common/bin/hgforest.sh pull -u</code></pre></li>
ihse@2619 171 <li><p>Merging over the entire forest:</p>
ihse@2619 172 <pre><code>bash common/bin/hgforest.sh merge</code></pre></li>
ihse@2619 173 </ul>
ihse@2619 174 <h3 id="using-the-trees-extension">Using the Trees Extension</h3>
ihse@2619 175 <p>The trees extension is a Mercurial add-on that helps you deal with the forest. More information is available on the <a href="http://openjdk.java.net/projects/code-tools/trees">Code Tools trees page</a>.</p>
ihse@2619 176 <h4 id="installing-the-extension">Installing the Extension</h4>
ihse@2619 177 <p>Install the extension by cloning <code>http://hg.openjdk.java.net/code-tools/trees</code> and updating your <code>.hgrc</code> file. Here's one way to do this:</p>
ihse@2619 178 <pre><code>cd ~
ihse@2619 179 mkdir hg-ext
ihse@2619 180 cd hg-ext
ihse@2619 181 hg clone http://hg.openjdk.java.net/code-tools/trees
ihse@2619 182 cat &lt;&lt; EOT &gt;&gt; ~/.hgrc
ihse@2619 183 [extensions]
ihse@2619 184 trees=~/hg-ext/trees/trees.py
ihse@2619 185 EOT</code></pre>
ihse@2619 186 <h4 id="initializing-the-tree">Initializing the Tree</h4>
ihse@2619 187 <p>The trees extension needs to know the structure of the forest. If you have already cloned the entire forest using another method, you can initialize the forest like this:</p>
ihse@2619 188 <pre><code>hg tconf --set --walk --depth</code></pre>
ihse@2619 189 <p>Or you can clone the entire forest at once, if you substitute <code>clone</code> with <code>tclone</code> when cloning the top-level repository, e.g. like this:</p>
ihse@2619 190 <pre><code>hg tclone http://hg.openjdk.java.net/jdk9/jdk9</code></pre>
ihse@2619 191 <p>In this case, the forest will be properly initialized from the start.</p>
ihse@2619 192 <h4 id="other-operations">Other Operations</h4>
ihse@2619 193 <p>The trees extensions supplement many common operations with a trees version by prefixing a <code>t</code> to the normal Mercurial command, e.g. <code>tcommit</code>, <code>tstatus</code> or <code>tmerge</code>. For instance, to update the entire forest:</p>
ihse@2619 194 <pre><code>hg tpull -u</code></pre>
ihse@2619 195 <h2 id="build-hardware-requirements">Build Hardware Requirements</h2>
ihse@2619 196 <p>OpenJDK is a massive project, and require machines ranging from decent to powerful to be able to build in a reasonable amount of time, or to be able to complete a build at all.</p>
ihse@2619 197 <p>We <em>strongly</em> recommend usage of an SSD disk for the build, since disk speed is one of the limiting factors for build performance.</p>
ihse@2619 198 <h3 id="building-on-x86">Building on x86</h3>
ihse@2619 199 <p>At a minimum, a machine with 2-4 cores is advisable, as well as 2-4 GB of RAM. (The more cores to use, the more memory you need.) At least 6 GB of free disk space is required (8 GB minimum for building on Solaris).</p>
ihse@2619 200 <p>Even for 32-bit builds, it is recommended to use a 64-bit build machine, and instead create a 32-bit target using <code>--with-target-bits=32</code>.</p>
ihse@2619 201 <h3 id="building-on-sparc">Building on sparc</h3>
ihse@2619 202 <p>At a minimum, a machine with 4 cores is advisable, as well as 4 GB of RAM. (The more cores to use, the more memory you need.) At least 8 GB of free disk space is required.</p>
ihse@2619 203 <h3 id="building-on-armaarch64">Building on arm/aarch64</h3>
ihse@2619 204 <p>This is not recommended. Instead, see the section on <a href="#cross-compiling">Cross-compiling</a>.</p>
ihse@2619 205 <h2 id="operating-system-requirements">Operating System Requirements</h2>
ihse@2619 206 <p>The mainline OpenJDK project supports Linux, Solaris, macOS, AIX and Windows. Support for other operating system, e.g. BSD, exists in separate &quot;port&quot; projects.</p>
ihse@2619 207 <p>In general, OpenJDK can be built on a wide range of versions of these operating systems, but the further you deviate from what is tested on a daily basis, the more likely you are to run into problems.</p>
ihse@2619 208 <p>This table lists the OS versions used by Oracle when building JDK 9. Such information is always subject to change, but this table is up to date at the time of writing.</p>
ihse@2619 209 <table>
ihse@2619 210 <thead>
ihse@2619 211 <tr class="header">
ihse@2619 212 <th style="text-align: left;">Operating system</th>
ihse@2619 213 <th style="text-align: left;">Vendor/version used</th>
ihse@2619 214 </tr>
ihse@2619 215 </thead>
ihse@2619 216 <tbody>
ihse@2619 217 <tr class="odd">
ihse@2619 218 <td style="text-align: left;">Linux</td>
ihse@2619 219 <td style="text-align: left;">Oracle Enterprise Linux 6.4 / 7.1 (using kernel 3.8.13)</td>
ihse@2619 220 </tr>
ihse@2619 221 <tr class="even">
ihse@2619 222 <td style="text-align: left;">Solaris</td>
ihse@2619 223 <td style="text-align: left;">Solaris 11.1 SRU 21.4.1 / 11.2 SRU 5.5</td>
ihse@2619 224 </tr>
ihse@2619 225 <tr class="odd">
ihse@2619 226 <td style="text-align: left;">macOS</td>
ihse@2619 227 <td style="text-align: left;">Mac OS X 10.9 (Mavericks) / 10.10 (Yosemite)</td>
ihse@2619 228 </tr>
ihse@2619 229 <tr class="even">
ihse@2619 230 <td style="text-align: left;">Windows</td>
ihse@2619 231 <td style="text-align: left;">Windows Server 2012 R2</td>
ihse@2619 232 </tr>
ihse@2619 233 </tbody>
ihse@2619 234 </table>
ihse@2619 235 <p>The double version numbers for Linux, Solaris and macOS is due to the hybrid model used at Oracle, where header files and external libraries from an older version is used when building on a more modern version of the OS.</p>
ihse@2619 236 <p>The Build Group has a wiki page with <a href="https://wiki.openjdk.java.net/display/Build/Supported+Build+Platforms">Supported Build Platforms</a>. From time to time, this is updated by the community to list successes or failures of building on different platforms.</p>
ihse@2619 237 <h3 id="windows">Windows</h3>
ihse@2619 238 <p>Windows XP is not a supported platform, but all newer Windows should be able to build OpenJDK.</p>
ihse@2619 239 <p>On Windows, it is important that you pay attention to the instructions in the <a href="#special-considerations">Special Considerations</a>.</p>
ihse@2619 240 <p>Windows is the only non-POSIX OS supported by OpenJDK, and as such, requires some extra care. A POSIX support layer is required to build on Windows. For OpenJDK 9, the only supported such layer is Cygwin. (Msys is no longer supported due to a too old bash; msys2 and the new Windows Subsystem for Linux (WSL) would likely be possible to support in a future version but that would require a community effort to implement.)</p>
ihse@2619 241 <p>Internally in the build system, all paths are represented as Unix-style paths, e.g. <code>/cygdrive/c/hg/jdk9/Makefile</code> rather than <code>C:\hg\jdk9\Makefile</code>. This rule also applies to input to the build system, e.g. in arguments to <code>configure</code>. So, use <code>--with-freetype=/cygdrive/c/freetype</code> rather than <code>--with-freetype=c:\freetype</code>. For details on this conversion, see the section on <a href="#fixpath">Fixpath</a>.</p>
ihse@2619 242 <h4 id="cygwin">Cygwin</h4>
ihse@2619 243 <p>A functioning <a href="http://www.cygwin.com/">Cygwin</a> environment is thus required for building OpenJDK on Windows. If you have a 64-bit OS, we strongly recommend using the 64-bit version of Cygwin.</p>
ihse@2619 244 <p><strong>Note:</strong> Cygwin has a model of continuously updating all packages without any easy way to install or revert to a specific version of a package. This means that whenever you add or update a package in Cygwin, you might (inadvertently) update tools that are used by the OpenJDK build process, and that can cause unexpected build problems.</p>
ihse@2619 245 <p>OpenJDK requires GNU Make 4.0 or greater on Windows. This is usually not a problem, since Cygwin currently only distributes GNU Make at a version above 4.0.</p>
ihse@2619 246 <p>Apart from the basic Cygwin installation, the following packages must also be installed:</p>
ihse@1680 247 <ul>
ihse@2619 248 <li><code>make</code></li>
ihse@2619 249 <li><code>zip</code></li>
ihse@2619 250 <li><code>unzip</code></li>
ihse@1680 251 </ul>
ihse@2619 252 <p>Often, you can install these packages using the following command line:</p>
ihse@2619 253 <pre><code>&lt;path to Cygwin setup&gt;/setup-x86_64 -q -P make -P unzip -P zip</code></pre>
ihse@2619 254 <p>Unfortunately, Cygwin can be unreliable in certain circumstances. If you experience build tool crashes or strange issues when building on Windows, please check the Cygwin FAQ on the <a href="https://cygwin.com/faq/faq.html#faq.using.bloda">&quot;BLODA&quot; list</a> and the section on <a href="https://cygwin.com/faq/faq.html#faq.using.fixing-fork-failures">fork() failures</a>.</p>
ihse@2619 255 <h3 id="solaris">Solaris</h3>
ihse@2619 256 <p>See <code>make/devkit/solaris11.1-package-list.txt</code> for a list of recommended packages to install when building on Solaris. The versions specified in this list is the versions used by the daily builds at Oracle, and is likely to work properly.</p>
ihse@2619 257 <p>Older versions of Solaris shipped a broken version of <code>objcopy</code>. At least version 2.21.1 is needed, which is provided by Solaris 11 Update 1. Objcopy is needed if you want to have external debug symbols. Please make sure you are using at least version 2.21.1 of objcopy, or that you disable external debug symbols.</p>
ihse@2619 258 <h3 id="macos">macOS</h3>
ihse@2619 259 <p>Apple is using a quite aggressive scheme of pushing OS updates, and coupling these updates with required updates of Xcode. Unfortunately, this makes it difficult for a project like OpenJDK to keep pace with a continuously updated machine running macOS. See the section on <a href="#apple-xcode">Apple Xcode</a> on some strategies to deal with this.</p>
ihse@2619 260 <p>It is recommended that you use at least Mac OS X 10.9 (Mavericks). At the time of writing, OpenJDK has been successfully compiled on macOS versions up to 10.12.5 (Sierra), using XCode 8.3.2 and <code>--disable-warnings-as-errors</code>.</p>
ihse@2619 261 <p>The standard macOS environment contains the basic tooling needed to build, but for external libraries a package manager is recommended. OpenJDK uses <a href="https://brew.sh/">homebrew</a> in the examples, but feel free to use whatever manager you want (or none).</p>
ihse@2619 262 <h3 id="linux">Linux</h3>
ihse@2619 263 <p>It is often not much problem to build OpenJDK on Linux. The only general advice is to try to use the compilers, external libraries and header files as provided by your distribution.</p>
ihse@2619 264 <p>The basic tooling is provided as part of the core operating system, but you will most likely need to install developer packages.</p>
ihse@2619 265 <p>For apt-based distributions (Debian, Ubuntu, etc), try this:</p>
ihse@2619 266 <pre><code>sudo apt-get install build-essential</code></pre>
ihse@2619 267 <p>For rpm-based distributions (Fedora, Red Hat, etc), try this:</p>
ihse@2619 268 <pre><code>sudo yum groupinstall &quot;Development Tools&quot;</code></pre>
ihse@2619 269 <h3 id="aix">AIX</h3>
ihse@2619 270 <p>The regular builds by SAP is using AIX version 7.1, but AIX 5.3 is also supported. See the <a href="http://cr.openjdk.java.net/~simonis/ppc-aix-port">OpenJDK PowerPC Port Status Page</a> for details.</p>
ihse@2619 271 <h2 id="native-compiler-toolchain-requirements">Native Compiler (Toolchain) Requirements</h2>
ihse@2619 272 <p>Large portions of OpenJDK consists of native code, that needs to be compiled to be able to run on the target platform. In theory, toolchain and operating system should be independent factors, but in practice there's more or less a one-to-one correlation between target operating system and toolchain.</p>
ihse@2619 273 <table>
ihse@2619 274 <thead>
ihse@2619 275 <tr class="header">
ihse@2619 276 <th style="text-align: left;">Operating system</th>
ihse@2619 277 <th style="text-align: left;">Supported toolchain</th>
ihse@2619 278 </tr>
ihse@2619 279 </thead>
ihse@2619 280 <tbody>
ihse@2619 281 <tr class="odd">
ihse@2619 282 <td style="text-align: left;">Linux</td>
ihse@2619 283 <td style="text-align: left;">gcc, clang</td>
ihse@2619 284 </tr>
ihse@2619 285 <tr class="even">
ihse@2619 286 <td style="text-align: left;">macOS</td>
ihse@2619 287 <td style="text-align: left;">Apple Xcode (using clang)</td>
ihse@2619 288 </tr>
ihse@2619 289 <tr class="odd">
ihse@2619 290 <td style="text-align: left;">Solaris</td>
ihse@2619 291 <td style="text-align: left;">Oracle Solaris Studio</td>
ihse@2619 292 </tr>
ihse@2619 293 <tr class="even">
ihse@2619 294 <td style="text-align: left;">AIX</td>
ihse@2619 295 <td style="text-align: left;">IBM XL C/C++</td>
ihse@2619 296 </tr>
ihse@2619 297 <tr class="odd">
ihse@2619 298 <td style="text-align: left;">Windows</td>
ihse@2619 299 <td style="text-align: left;">Microsoft Visual Studio</td>
ihse@2619 300 </tr>
ihse@2619 301 </tbody>
ihse@2619 302 </table>
ihse@2619 303 <p>Please see the individual sections on the toolchains for version recommendations. As a reference, these versions of the toolchains are used, at the time of writing, by Oracle for the daily builds of OpenJDK. It should be possible to compile OpenJDK with both older and newer versions, but the closer you stay to this list, the more likely you are to compile successfully without issues.</p>
ihse@2619 304 <table>
ihse@2619 305 <thead>
ihse@2619 306 <tr class="header">
ihse@2619 307 <th style="text-align: left;">Operating system</th>
ihse@2619 308 <th style="text-align: left;">Toolchain version</th>
ihse@2619 309 </tr>
ihse@2619 310 </thead>
ihse@2619 311 <tbody>
ihse@2619 312 <tr class="odd">
ihse@2619 313 <td style="text-align: left;">Linux</td>
ihse@2619 314 <td style="text-align: left;">gcc 4.9.2</td>
ihse@2619 315 </tr>
ihse@2619 316 <tr class="even">
ihse@2619 317 <td style="text-align: left;">macOS</td>
ihse@2619 318 <td style="text-align: left;">Apple Xcode 6.3 (using clang 6.1.0)</td>
ihse@2619 319 </tr>
ihse@2619 320 <tr class="odd">
ihse@2619 321 <td style="text-align: left;">Solaris</td>
ihse@2619 322 <td style="text-align: left;">Oracle Solaris Studio 12.4 (with compiler version 5.13)</td>
ihse@2619 323 </tr>
ihse@2619 324 <tr class="even">
ihse@2619 325 <td style="text-align: left;">Windows</td>
ihse@2619 326 <td style="text-align: left;">Microsoft Visual Studio 2013 update 4</td>
ihse@2619 327 </tr>
ihse@2619 328 </tbody>
ihse@2619 329 </table>
ihse@2619 330 <h3 id="gcc">gcc</h3>
ihse@2619 331 <p>The minimum accepted version of gcc is 4.3. Older versions will not be accepted by <code>configure</code>.</p>
ihse@2619 332 <p>However, gcc 4.3 is quite old and OpenJDK is not regularly tested on this version, so it is recommended to use a more modern gcc.</p>
ihse@2619 333 <p>OpenJDK 9 includes patches that should allow gcc 6 to compile, but this should be considered experimental.</p>
ihse@2619 334 <p>In general, any version between these two should be usable.</p>
ihse@2619 335 <h3 id="clang">clang</h3>
ihse@2619 336 <p>The minimum accepted version of clang is 3.2. Older versions will not be accepted by <code>configure</code>.</p>
ihse@2619 337 <p>To use clang instead of gcc on Linux, use <code>--with-toolchain-type=clang</code>.</p>
ihse@2619 338 <h3 id="apple-xcode">Apple Xcode</h3>
ihse@2619 339 <p>The oldest supported version of Xcode is 5.</p>
ihse@2619 340 <p>You will need the Xcode command lines developers tools to be able to build OpenJDK. (Actually, <em>only</em> the command lines tools are needed, not the IDE.) The simplest way to install these is to run:</p>
ihse@2619 341 <pre><code>xcode-select --install</code></pre>
ihse@2619 342 <p>It is advisable to keep an older version of Xcode for building OpenJDK when updating Xcode. This <a href="http://iosdevelopertips.com/xcode/install-multiple-versions-of-xcode.html">blog page</a> has good suggestions on managing multiple Xcode versions. To use a specific version of Xcode, use <code>xcode-select -s</code> before running <code>configure</code>, or use <code>--with-toolchain-path</code> to point to the version of Xcode to use, e.g. <code>configure --with-toolchain-path=/Applications/Xcode5.app/Contents/Developer/usr/bin</code></p>
ihse@2619 343 <p>If you have recently (inadvertently) updated your OS and/or Xcode version, and OpenJDK can no longer be built, please see the section on <a href="#problems-with-the-build-environment">Problems with the Build Environment</a>, and <a href="#getting-help">Getting Help</a> to find out if there are any recent, non-merged patches available for this update.</p>
ihse@2619 344 <h3 id="oracle-solaris-studio">Oracle Solaris Studio</h3>
ihse@2619 345 <p>The minimum accepted version of the Solaris Studio compilers is 5.13 (corresponding to Solaris Studio 12.4). Older versions will not be accepted by configure.</p>
erikj@1828 346 <p>The Solaris Studio installation should contain at least these packages:</p>
ihse@2520 347 <table>
ihse@2520 348 <thead>
ihse@2520 349 <tr class="header">
ihse@2591 350 <th style="text-align: left;">Package</th>
ihse@2591 351 <th style="text-align: left;">Version</th>
ihse@2520 352 </tr>
ihse@2520 353 </thead>
ihse@2520 354 <tbody>
ihse@2520 355 <tr class="odd">
ihse@2591 356 <td style="text-align: left;">developer/solarisstudio-124/backend</td>
ihse@2591 357 <td style="text-align: left;">12.4-1.0.6.0</td>
ihse@2520 358 </tr>
ihse@2520 359 <tr class="even">
ihse@2591 360 <td style="text-align: left;">developer/solarisstudio-124/c++</td>
ihse@2591 361 <td style="text-align: left;">12.4-1.0.10.0</td>
ihse@2520 362 </tr>
ihse@2520 363 <tr class="odd">
ihse@2591 364 <td style="text-align: left;">developer/solarisstudio-124/cc</td>
ihse@2591 365 <td style="text-align: left;">12.4-1.0.4.0</td>
ihse@2520 366 </tr>
ihse@2520 367 <tr class="even">
ihse@2591 368 <td style="text-align: left;">developer/solarisstudio-124/library/c++-libs</td>
ihse@2591 369 <td style="text-align: left;">12.4-1.0.10.0</td>
ihse@2520 370 </tr>
ihse@2520 371 <tr class="odd">
ihse@2591 372 <td style="text-align: left;">developer/solarisstudio-124/library/math-libs</td>
ihse@2591 373 <td style="text-align: left;">12.4-1.0.0.1</td>
ihse@2520 374 </tr>
ihse@2520 375 <tr class="even">
ihse@2591 376 <td style="text-align: left;">developer/solarisstudio-124/library/studio-gccrt</td>
ihse@2591 377 <td style="text-align: left;">12.4-1.0.0.1</td>
ihse@2520 378 </tr>
ihse@2520 379 <tr class="odd">
ihse@2591 380 <td style="text-align: left;">developer/solarisstudio-124/studio-common</td>
ihse@2591 381 <td style="text-align: left;">12.4-1.0.0.1</td>
ihse@2520 382 </tr>
ihse@2520 383 <tr class="even">
ihse@2591 384 <td style="text-align: left;">developer/solarisstudio-124/studio-ja</td>
ihse@2591 385 <td style="text-align: left;">12.4-1.0.0.1</td>
ihse@2520 386 </tr>
ihse@2520 387 <tr class="odd">
ihse@2591 388 <td style="text-align: left;">developer/solarisstudio-124/studio-legal</td>
ihse@2591 389 <td style="text-align: left;">12.4-1.0.0.1</td>
ihse@2520 390 </tr>
ihse@2520 391 <tr class="even">
ihse@2591 392 <td style="text-align: left;">developer/solarisstudio-124/studio-zhCN</td>
ihse@2591 393 <td style="text-align: left;">12.4-1.0.0.1</td>
ihse@2520 394 </tr>
ihse@2520 395 </tbody>
ihse@2520 396 </table>
ihse@2619 397 <p>Compiling with Solaris Studio can sometimes be finicky. This is the exact version used by Oracle, which worked correctly at the time of writing:</p>
ihse@2619 398 <pre><code>$ cc -V
ihse@2619 399 cc: Sun C 5.13 SunOS_i386 2014/10/20
ihse@2619 400 $ CC -V
ihse@2619 401 CC: Sun C++ 5.13 SunOS_i386 151846-10 2015/10/30</code></pre>
ihse@2619 402 <h3 id="microsoft-visual-studio">Microsoft Visual Studio</h3>
ihse@2619 403 <p>The minimum accepted version of Visual Studio is 2010. Older versions will not be accepted by <code>configure</code>. The maximum accepted version of Visual Studio is 2013.</p>
ihse@2619 404 <p>If you have multiple versions of Visual Studio installed, <code>configure</code> will by default pick the latest. You can request a specific version to be used by setting <code>--with-toolchain-version</code>, e.g. <code>--with-toolchain-version=2010</code>.</p>
ihse@2619 405 <p>If you get <code>LINK: fatal error LNK1123: failure during conversion to COFF: file invalid</code> when building using Visual Studio 2010, you have encountered <a href="http://support.microsoft.com/kb/2757355">KB2757355</a>, a bug triggered by a specific installation order. However, the solution suggested by the KB article does not always resolve the problem. See <a href="https://stackoverflow.com/questions/10888391">this stackoverflow discussion</a> for other suggestions.</p>
ihse@2619 406 <h3 id="ibm-xl-cc">IBM XL C/C++</h3>
ihse@2619 407 <p>The regular builds by SAP is using version 12.1, described as <code>IBM XL C/C++ for AIX, V12.1 (5765-J02, 5725-C72) Version: 12.01.0000.0017</code>.</p>
ihse@2619 408 <p>See the <a href="http://cr.openjdk.java.net/~simonis/ppc-aix-port">OpenJDK PowerPC Port Status Page</a> for details.</p>
ihse@2619 409 <h2 id="boot-jdk-requirements">Boot JDK Requirements</h2>
ihse@2619 410 <p>Paradoxically, building OpenJDK requires a pre-existing JDK. This is called the &quot;boot JDK&quot;. The boot JDK does not have to be OpenJDK, though. If you are porting OpenJDK to a new platform, chances are that there already exists another JDK for that platform that is usable as boot JDK.</p>
ihse@2619 411 <p>The rule of thumb is that the boot JDK for building JDK major version <em>N</em> should be an JDK of major version <em>N-1</em>, so for building JDK 9 a JDK 8 would be suitable as boot JDK. However, OpenJDK should be able to &quot;build itself&quot;, so an up-to-date build of the current OpenJDK source is an acceptable alternative. If you are following the <em>N-1</em> rule, make sure you got the latest update version, since JDK 8 GA might not be able to build JDK 9 on all platforms.</p>
ihse@2619 412 <p>If the Boot JDK is not automatically detected, or the wrong JDK is picked, use <code>--with-boot-jdk</code> to point to the JDK to use.</p>
ihse@2619 413 <h3 id="jdk-8-on-linux">JDK 8 on Linux</h3>
ihse@2619 414 <p>On apt-based distros (like Debian and Ubuntu), <code>sudo apt-get install openjdk-8-jdk</code> is typically enough to install OpenJDK 8. On rpm-based distros (like Fedora and Red Hat), try <code>sudo yum install java-1.8.0-openjdk-devel</code>.</p>
ihse@2619 415 <h3 id="jdk-8-on-windows">JDK 8 on Windows</h3>
ihse@2619 416 <p>No pre-compiled binaries of OpenJDK 8 are readily available for Windows at the time of writing. An alternative is to download the <a href="http://www.oracle.com/technetwork/java/javase/downloads">Oracle JDK</a>. Another is the <a href="https://adoptopenjdk.net/">Adopt OpenJDK Project</a>, which publishes experimental prebuilt binaries for Windows.</p>
ihse@2619 417 <h3 id="jdk-8-on-macos">JDK 8 on macOS</h3>
ihse@2619 418 <p>No pre-compiled binaries of OpenJDK 8 are readily available for macOS at the time of writing. An alternative is to download the <a href="http://www.oracle.com/technetwork/java/javase/downloads">Oracle JDK</a>, or to install it using <code>brew cask install java</code>. Another option is the <a href="https://adoptopenjdk.net/">Adopt OpenJDK Project</a>, which publishes experimental prebuilt binaries for macOS.</p>
ihse@2619 419 <h3 id="jdk-8-on-aix">JDK 8 on AIX</h3>
ihse@2619 420 <p>No pre-compiled binaries of OpenJDK 8 are readily available for AIX at the time of writing. A starting point for working with OpenJDK on AIX is the <a href="http://openjdk.java.net/projects/ppc-aix-port/">PowerPC/AIX Port Project</a>.</p>
ihse@2619 421 <h2 id="external-library-requirements">External Library Requirements</h2>
ihse@2619 422 <p>Different platforms require different external libraries. In general, libraries are not optional - that is, they are either required or not used.</p>
ihse@2619 423 <p>If a required library is not detected by <code>configure</code>, you need to provide the path to it. There are two forms of the <code>configure</code> arguments to point to an external library: <code>--with-&lt;LIB&gt;=&lt;path&gt;</code> or <code>--with-&lt;LIB&gt;-include=&lt;path to include&gt; --with-&lt;LIB&gt;-lib=&lt;path to lib&gt;</code>. The first variant is more concise, but require the include files an library files to reside in a default hierarchy under this directory. In most cases, it works fine.</p>
ihse@2619 424 <p>As a fallback, the second version allows you to point to the include directory and the lib directory separately.</p>
ihse@2619 425 <h3 id="freetype">FreeType</h3>
ihse@2619 426 <p>FreeType2 from <a href="http://www.freetype.org/">The FreeType Project</a> is required on all platforms. At least version 2.3 is required.</p>
ihse@1680 427 <ul>
ihse@2619 428 <li>To install on an apt-based Linux, try running <code>sudo apt-get install libcups2-dev</code>.</li>
ihse@2619 429 <li>To install on an rpm-based Linux, try running <code>sudo yum install cups-devel</code>.</li>
ihse@2619 430 <li>To install on Solaris, try running <code>pkg install system/library/freetype-2</code>.</li>
ihse@2619 431 <li>To install on macOS, try running <code>brew install freetype</code>.</li>
ihse@2619 432 <li>To install on Windows, see <a href="#building-freetype-on-windows">below</a>.</li>
ihse@1680 433 </ul>
ihse@2619 434 <p>Use <code>--with-freetype=&lt;path&gt;</code> if <code>configure</code> does not properly locate your FreeType files.</p>
ihse@2619 435 <h4 id="building-freetype-on-windows">Building FreeType on Windows</h4>
ihse@2619 436 <p>On Windows, there is no readily available compiled version of FreeType. OpenJDK can help you compile FreeType from source. Download the FreeType sources and unpack them into an arbitrary directory:</p>
ihse@2619 437 <pre><code>wget http://download.savannah.gnu.org/releases/freetype/freetype-2.5.3.tar.gz
ihse@2619 438 tar -xzf freetype-2.5.3.tar.gz</code></pre>
ihse@2619 439 <p>Then run <code>configure</code> with <code>--with-freetype-src=&lt;freetype_src&gt;</code>. This will automatically build the freetype library into <code>&lt;freetype_src&gt;/lib64</code> for 64-bit builds or into <code>&lt;freetype_src&gt;/lib32</code> for 32-bit builds. Afterwards you can always use <code>--with-freetype-include=&lt;freetype_src&gt;/include</code> and <code>--with-freetype-lib=&lt;freetype_src&gt;/lib[32|64]</code> for other builds.</p>
ihse@2619 440 <p>Alternatively you can unpack the sources like this to use the default directory:</p>
ihse@2619 441 <pre><code>tar --one-top-level=$HOME/freetype --strip-components=1 -xzf freetype-2.5.3.tar.gz</code></pre>
ihse@2619 442 <h3 id="cups">CUPS</h3>
ihse@2619 443 <p>CUPS, <a href="http://www.cups.org">Common UNIX Printing System</a> header files are required on all platforms, except Windows. Often these files are provided by your operating system.</p>
ihse@2619 444 <ul>
ihse@2619 445 <li>To install on an apt-based Linux, try running <code>sudo apt-get install libcups2-dev</code>.</li>
ihse@2619 446 <li>To install on an rpm-based Linux, try running <code>sudo yum install cups-devel</code>.</li>
ihse@2619 447 <li>To install on Solaris, try running <code>pkg install print/cups</code>.</li>
ihse@2619 448 </ul>
ihse@2619 449 <p>Use <code>--with-cups=&lt;path&gt;</code> if <code>configure</code> does not properly locate your CUPS files.</p>
ihse@2619 450 <h3 id="x11">X11</h3>
ihse@2619 451 <p>Certain <a href="http://www.x.org/">X11</a> libraries and include files are required on Linux and Solaris.</p>
ihse@2619 452 <ul>
ihse@2619 453 <li>To install on an apt-based Linux, try running <code>sudo apt-get install libx11-dev libxext-dev libxrender-dev libxtst-dev libxt-dev</code>.</li>
ihse@2619 454 <li>To install on an rpm-based Linux, try running <code>sudo yum install libXtst-devel libXt-devel libXrender-devel libXi-devel</code>.</li>
ihse@2619 455 <li>To install on Solaris, try running <code>pkg install x11/header/x11-protocols x11/library/libice x11/library/libpthread-stubs x11/library/libsm x11/library/libx11 x11/library/libxau x11/library/libxcb x11/library/libxdmcp x11/library/libxevie x11/library/libxext x11/library/libxrender x11/library/libxscrnsaver x11/library/libxtst x11/library/toolkit/libxt</code>.</li>
ihse@2619 456 </ul>
ihse@2619 457 <p>Use <code>--with-x=&lt;path&gt;</code> if <code>configure</code> does not properly locate your X11 files.</p>
ihse@2619 458 <h3 id="alsa">ALSA</h3>
ihse@2619 459 <p>ALSA, <a href="https://www.alsa-project.org/">Advanced Linux Sound Architecture</a> is required on Linux. At least version 0.9.1 of ALSA is required.</p>
ihse@2619 460 <ul>
ihse@2619 461 <li>To install on an apt-based Linux, try running <code>sudo apt-get install libasound2-dev</code>.</li>
ihse@2619 462 <li>To install on an rpm-based Linux, try running <code>sudo yum install alsa-lib-devel</code>.</li>
ihse@2619 463 </ul>
ihse@2619 464 <p>Use <code>--with-alsa=&lt;path&gt;</code> if <code>configure</code> does not properly locate your ALSA files.</p>
ihse@2619 465 <h3 id="libffi">libffi</h3>
ihse@2619 466 <p>libffi, the <a href="http://sourceware.org/libffi">Portable Foreign Function Interface Library</a> is required when building the Zero version of Hotspot.</p>
ihse@2619 467 <ul>
ihse@2619 468 <li>To install on an apt-based Linux, try running <code>sudo apt-get install libffi-dev</code>.</li>
ihse@2619 469 <li>To install on an rpm-based Linux, try running <code>sudo yum install libffi-devel</code>.</li>
ihse@2619 470 </ul>
ihse@2619 471 <p>Use <code>--with-libffi=&lt;path&gt;</code> if <code>configure</code> does not properly locate your libffi files.</p>
ihse@2619 472 <h3 id="libelf">libelf</h3>
ihse@2619 473 <p>libelf from the <a href="http://sourceware.org/elfutils">elfutils project</a> is required when building the AOT feature of Hotspot.</p>
ihse@2619 474 <ul>
ihse@2619 475 <li>To install on an apt-based Linux, try running <code>sudo apt-get install libelf-dev</code>.</li>
ihse@2619 476 <li>To install on an rpm-based Linux, try running <code>sudo yum install elfutils-libelf-devel</code>.</li>
ihse@2619 477 </ul>
ihse@2619 478 <p>Use <code>--with-libelf=&lt;path&gt;</code> if <code>configure</code> does not properly locate your libelf files.</p>
ihse@2619 479 <h2 id="other-tooling-requirements">Other Tooling Requirements</h2>
ihse@2619 480 <h3 id="gnu-make">GNU Make</h3>
ihse@2619 481 <p>OpenJDK requires <a href="http://www.gnu.org/software/make">GNU Make</a>. No other flavors of make are supported.</p>
ihse@2619 482 <p>At least version 3.81 of GNU Make must be used. For distributions supporting GNU Make 4.0 or above, we strongly recommend it. GNU Make 4.0 contains useful functionality to handle parallel building (supported by <code>--with-output-sync</code>) and speed and stability improvements.</p>
ihse@2619 483 <p>Note that <code>configure</code> locates and verifies a properly functioning version of <code>make</code> and stores the path to this <code>make</code> binary in the configuration. If you start a build using <code>make</code> on the command line, you will be using the version of make found first in your <code>PATH</code>, and not necessarily the one stored in the configuration. This initial make will be used as &quot;bootstrap make&quot;, and in a second stage, the make located by <code>configure</code> will be called. Normally, this will present no issues, but if you have a very old <code>make</code>, or a non-GNU Make <code>make</code> in your path, this might cause issues.</p>
ihse@2619 484 <p>If you want to override the default make found by <code>configure</code>, use the <code>MAKE</code> configure variable, e.g. <code>configure MAKE=/opt/gnu/make</code>.</p>
ihse@2619 485 <p>On Solaris, it is common to call the GNU version of make by using <code>gmake</code>.</p>
ihse@2619 486 <h3 id="gnu-bash">GNU Bash</h3>
ihse@2619 487 <p>OpenJDK requires <a href="http://www.gnu.org/software/bash">GNU Bash</a>. No other shells are supported.</p>
ihse@2619 488 <p>At least version 3.2 of GNU Bash must be used.</p>
ihse@2619 489 <h3 id="autoconf">Autoconf</h3>
ihse@2619 490 <p>If you want to modify the build system itself, you need to install <a href="http://www.gnu.org/software/autoconf">Autoconf</a>.</p>
ihse@2619 491 <p>However, if you only need to build OpenJDK or if you only edit the actual OpenJDK source files, there is no dependency on autoconf, since the source distribution includes a pre-generated <code>configure</code> shell script.</p>
ihse@2619 492 <p>See the section on <a href="#autoconf-details">Autoconf Details</a> for details on how OpenJDK uses autoconf. This is especially important if you plan to contribute changes to OpenJDK that modifies the build system.</p>
ihse@2619 493 <h2 id="running-configure">Running Configure</h2>
ihse@2619 494 <p>To build OpenJDK, you need a &quot;configuration&quot;, which consists of a directory where to store the build output, coupled with information about the platform, the specific build machine, and choices that affect how OpenJDK is built.</p>
ihse@2619 495 <p>The configuration is created by the <code>configure</code> script. The basic invocation of the <code>configure</code> script looks like this:</p>
ihse@2619 496 <pre><code>bash configure [options]</code></pre>
ihse@2619 497 <p>This will create an output directory containing the configuration and setup an area for the build result. This directory typically looks like <code>build/linux-x64-normal-server-release</code>, but the actual name depends on your specific configuration. (It can also be set directly, see <a href="#using-multiple-configurations">Using Multiple Configurations</a>). This directory is referred to as <code>$BUILD</code> in this documentation.</p>
ihse@2619 498 <p><code>configure</code> will try to figure out what system you are running on and where all necessary build components are. If you have all prerequisites for building installed, it should find everything. If it fails to detect any component automatically, it will exit and inform you about the problem.</p>
ihse@2619 499 <p>Some command line examples:</p>
ihse@2619 500 <ul>
ihse@2619 501 <li><p>Create a 32-bit build for Windows with FreeType2 in <code>C:\freetype-i586</code>:</p>
ihse@2619 502 <pre><code>bash configure --with-freetype=/cygdrive/c/freetype-i586 --with-target-bits=32</code></pre></li>
ihse@2619 503 <li><p>Create a debug build with the <code>server</code> JVM and DTrace enabled:</p>
ihse@2619 504 <pre><code>bash configure --enable-debug --with-jvm-variants=server --enable-dtrace</code></pre></li>
ihse@2619 505 </ul>
ihse@2619 506 <h3 id="common-configure-arguments">Common Configure Arguments</h3>
ihse@2619 507 <p>Here follows some of the most common and important <code>configure</code> argument.</p>
ihse@2619 508 <p>To get up-to-date information on <em>all</em> available <code>configure</code> argument, please run:</p>
ihse@2619 509 <pre><code>bash configure --help</code></pre>
ihse@2619 510 <p>(Note that this help text also include general autoconf options, like <code>--dvidir</code>, that is not relevant to OpenJDK. To list only OpenJDK specific features, use <code>bash configure --help=short</code> instead.)</p>
ihse@2619 511 <h4 id="configure-arguments-for-tailoring-the-build">Configure Arguments for Tailoring the Build</h4>
ihse@2619 512 <ul>
ihse@2619 513 <li><code>--enable-debug</code> - Set the debug level to <code>fastdebug</code> (this is a shorthand for <code>--with-debug-level=fastdebug</code>)</li>
ihse@2619 514 <li><code>--with-debug-level=&lt;level&gt;</code> - Set the debug level, which can be <code>release</code>, <code>fastdebug</code>, <code>slowdebug</code> or <code>optimized</code>. Default is <code>release</code>. <code>optimized</code> is variant of <code>release</code> with additional Hotspot debug code.</li>
ihse@2619 515 <li><code>--with-native-debug-symbols=&lt;method&gt;</code> - Specify if and how native debug symbols should be built. Available methods are <code>none</code>, <code>internal</code>, <code>external</code>, <code>zipped</code>. Default behavior depends on platform. See <a href="#native-debug-symbols">Native Debug Symbols</a> for more details.</li>
ihse@2619 516 <li><code>--with-version-string=&lt;string&gt;</code> - Specify the version string this build will be identified with.</li>
ihse@2619 517 <li><code>--with-version-&lt;part&gt;=&lt;value&gt;</code> - A group of options, where <code>&lt;part&gt;</code> can be any of <code>pre</code>, <code>opt</code>, <code>build</code>, <code>major</code>, <code>minor</code>, <code>security</code> or <code>patch</code>. Use these options to modify just the corresponding part of the version string from the default, or the value provided by <code>--with-version-string</code>.</li>
ihse@2619 518 <li><code>--with-jvm-variants=&lt;variant&gt;[,&lt;variant&gt;...]</code> - Build the specified variant (or variants) of Hotspot. Valid variants are: <code>server</code>, <code>client</code>, <code>minimal</code>, <code>core</code>, <code>zero</code>, <code>zeroshark</code>, <code>custom</code>. Note that not all variants are possible to combine in a single build.</li>
ihse@2619 519 <li><code>--with-jvm-features=&lt;feature&gt;[,&lt;feature&gt;...]</code> - Use the specified JVM features when building Hotspot. The list of features will be enabled on top of the default list. For the <code>custom</code> JVM variant, this default list is empty. A complete list of available JVM features can be found using <code>bash configure --help</code>.</li>
ihse@2619 520 <li><code>--with-target-bits=&lt;bits&gt;</code> - Create a target binary suitable for running on a <code>&lt;bits&gt;</code> platform. Use this to create 32-bit output on a 64-bit build platform, instead of doing a full cross-compile. (This is known as a <em>reduced</em> build.)</li>
ihse@2619 521 </ul>
ihse@2619 522 <h4 id="configure-arguments-for-native-compilation">Configure Arguments for Native Compilation</h4>
ihse@2619 523 <ul>
ihse@2619 524 <li><code>--with-devkit=&lt;path&gt;</code> - Use this devkit for compilers, tools and resources</li>
ihse@2619 525 <li><code>--with-sysroot=&lt;path&gt;</code> - Use this directory as sysroot</li>
ihse@2619 526 <li><code>--with-extra-path=&lt;path&gt;[;&lt;path&gt;]</code> - Prepend these directories to the default path when searching for all kinds of binaries</li>
ihse@2619 527 <li><code>--with-toolchain-path=&lt;path&gt;[;&lt;path&gt;]</code> - Prepend these directories when searching for toolchain binaries (compilers etc)</li>
ihse@2619 528 <li><code>--with-extra-cflags=&lt;flags&gt;</code> - Append these flags when compiling JDK C files</li>
ihse@2619 529 <li><code>--with-extra-cxxflags=&lt;flags&gt;</code> - Append these flags when compiling JDK C++ files</li>
ihse@2619 530 <li><code>--with-extra-ldflags=&lt;flags&gt;</code> - Append these flags when linking JDK libraries</li>
ihse@2619 531 </ul>
ihse@2619 532 <h4 id="configure-arguments-for-external-dependencies">Configure Arguments for External Dependencies</h4>
ihse@2619 533 <ul>
ihse@2619 534 <li><code>--with-boot-jdk=&lt;path&gt;</code> - Set the path to the <a href="#boot-jdk-requirements">Boot JDK</a></li>
ihse@2619 535 <li><code>--with-freetype=&lt;path&gt;</code> - Set the path to <a href="#freetype">FreeType</a></li>
ihse@2619 536 <li><code>--with-cups=&lt;path&gt;</code> - Set the path to <a href="#cups">CUPS</a></li>
ihse@2619 537 <li><code>--with-x=&lt;path&gt;</code> - Set the path to <a href="#x11">X11</a></li>
ihse@2619 538 <li><code>--with-alsa=&lt;path&gt;</code> - Set the path to <a href="#alsa">ALSA</a></li>
ihse@2619 539 <li><code>--with-libffi=&lt;path&gt;</code> - Set the path to <a href="#libffi">libffi</a></li>
ihse@2619 540 <li><code>--with-libelf=&lt;path&gt;</code> - Set the path to <a href="#libelf">libelf</a></li>
ihse@2619 541 <li><code>--with-jtreg=&lt;path&gt;</code> - Set the path to JTReg. See <a href="#running-tests">Running Tests</a></li>
ihse@2619 542 </ul>
ihse@2619 543 <p>Certain third-party libraries used by OpenJDK (libjpeg, giflib, libpng, lcms and zlib) are included in the OpenJDK repository. The default behavior of the OpenJDK build is to use this version of these libraries, but they might be replaced by an external version. To do so, specify <code>system</code> as the <code>&lt;source&gt;</code> option in these arguments. (The default is <code>bundled</code>).</p>
ihse@2619 544 <ul>
ihse@2619 545 <li><code>--with-libjpeg=&lt;source&gt;</code> - Use the specified source for libjpeg</li>
ihse@2619 546 <li><code>--with-giflib=&lt;source&gt;</code> - Use the specified source for giflib</li>
ihse@2619 547 <li><code>--with-libpng=&lt;source&gt;</code> - Use the specified source for libpng</li>
ihse@2619 548 <li><code>--with-lcms=&lt;source&gt;</code> - Use the specified source for lcms</li>
ihse@2619 549 <li><code>--with-zlib=&lt;source&gt;</code> - Use the specified source for zlib</li>
ihse@2619 550 </ul>
ihse@2619 551 <p>On Linux, it is possible to select either static or dynamic linking of the C++ runtime. The default is static linking, with dynamic linking as fallback if the static library is not found.</p>
ihse@2619 552 <ul>
ihse@2619 553 <li><code>--with-stdc++lib=&lt;method&gt;</code> - Use the specified method (<code>static</code>, <code>dynamic</code> or <code>default</code>) for linking the C++ runtime.</li>
ihse@2619 554 </ul>
ihse@2619 555 <h3 id="configure-control-variables">Configure Control Variables</h3>
ihse@2619 556 <p>It is possible to control certain aspects of <code>configure</code> by overriding the value of <code>configure</code> variables, either on the command line or in the environment.</p>
ihse@2619 557 <p>Normally, this is <strong>not recommended</strong>. If used improperly, it can lead to a broken configuration. Unless you're well versed in the build system, this is hard to use properly. Therefore, <code>configure</code> will print a warning if this is detected.</p>
ihse@2619 558 <p>However, there are a few <code>configure</code> variables, known as <em>control variables</em> that are supposed to be overriden on the command line. These are variables that describe the location of tools needed by the build, like <code>MAKE</code> or <code>GREP</code>. If any such variable is specified, <code>configure</code> will use that value instead of trying to autodetect the tool. For instance, <code>bash configure MAKE=/opt/gnumake4.0/bin/make</code>.</p>
ihse@2619 559 <p>If a configure argument exists, use that instead, e.g. use <code>--with-jtreg</code> instead of setting <code>JTREGEXE</code>.</p>
ihse@2619 560 <p>Also note that, despite what autoconf claims, setting <code>CFLAGS</code> will not accomplish anything. Instead use <code>--with-extra-cflags</code> (and similar for <code>cxxflags</code> and <code>ldflags</code>).</p>
ihse@2619 561 <h2 id="running-make">Running Make</h2>
ihse@2619 562 <p>When you have a proper configuration, all you need to do to build OpenJDK is to run <code>make</code>. (But see the warning at <a href="#gnu-make">GNU Make</a> about running the correct version of make.)</p>
ihse@2619 563 <p>When running <code>make</code> without any arguments, the default target is used, which is the same as running <code>make default</code> or <code>make jdk</code>. This will build a minimal (or roughly minimal) set of compiled output (known as an &quot;exploded image&quot;) needed for a developer to actually execute the newly built JDK. The idea is that in an incremental development fashion, when doing a normal make, you should only spend time recompiling what's changed (making it purely incremental) and only do the work that's needed to actually run and test your code.</p>
ihse@2619 564 <p>The output of the exploded image resides in <code>$BUILD/jdk</code>. You can test the newly built JDK like this: <code>$BUILD/jdk/bin/java -version</code>.</p>
ihse@2619 565 <h3 id="common-make-targets">Common Make Targets</h3>
ihse@2619 566 <p>Apart from the default target, here are some common make targets:</p>
ihse@2619 567 <ul>
ihse@2619 568 <li><code>hotspot</code> - Build all of hotspot (but only hotspot)</li>
ihse@2619 569 <li><code>hotspot-&lt;variant&gt;</code> - Build just the specified jvm variant</li>
ihse@2619 570 <li><code>images</code> or <code>product-images</code> - Build the JRE and JDK images</li>
ihse@2619 571 <li><code>docs</code> or <code>docs-image</code> - Build the documentation image</li>
ihse@2619 572 <li><code>test-image</code> - Build the test image</li>
ihse@2619 573 <li><code>all</code> or <code>all-images</code> - Build all images (product, docs and test)</li>
ihse@2619 574 <li><code>bootcycle-images</code> - Build images twice, second time with newly built JDK (good for testing)</li>
ihse@2619 575 <li><code>clean</code> - Remove all files generated by make, but not those generated by configure</li>
ihse@2619 576 <li><code>dist-clean</code> - Remove all files, including configuration</li>
ihse@2619 577 </ul>
ihse@2619 578 <p>Run <code>make help</code> to get an up-to-date list of important make targets and make control variables.</p>
ihse@2619 579 <p>It is possible to build just a single module, a single phase, or a single phase of a single module, by creating make targets according to these followin patterns. A phase can be either of <code>gensrc</code>, <code>gendata</code>, <code>copy</code>, <code>java</code>, <code>launchers</code>, <code>libs</code> or <code>rmic</code>. See <a href="#using-fine-grained-make-targets">Using Fine-Grained Make Targets</a> for more details about this functionality.</p>
ihse@2619 580 <ul>
ihse@2619 581 <li><code>&lt;phase&gt;</code> - Build the specified phase and everything it depends on</li>
ihse@2619 582 <li><code>&lt;module&gt;</code> - Build the specified module and everything it depends on</li>
ihse@2619 583 <li><code>&lt;module&gt;-&lt;phase&gt;</code> - Compile the specified phase for the specified module and everything it depends on</li>
ihse@2619 584 </ul>
ihse@2619 585 <p>Similarly, it is possible to clean just a part of the build by creating make targets according to these patterns:</p>
ihse@2619 586 <ul>
ihse@2619 587 <li><code>clean-&lt;outputdir&gt;</code> - Remove the subdir in the output dir with the name</li>
ihse@2619 588 <li><code>clean-&lt;phase&gt;</code> - Remove all build results related to a certain build phase</li>
ihse@2619 589 <li><code>clean-&lt;module&gt;</code> - Remove all build results related to a certain module</li>
ihse@2619 590 <li><code>clean-&lt;module&gt;-&lt;phase&gt;</code> - Remove all build results related to a certain module and phase</li>
ihse@2619 591 </ul>
ihse@2619 592 <h3 id="make-control-variables">Make Control Variables</h3>
ihse@2619 593 <p>It is possible to control <code>make</code> behavior by overriding the value of <code>make</code> variables, either on the command line or in the environment.</p>
ihse@2619 594 <p>Normally, this is <strong>not recommended</strong>. If used improperly, it can lead to a broken build. Unless you're well versed in the build system, this is hard to use properly. Therefore, <code>make</code> will print a warning if this is detected.</p>
ihse@2619 595 <p>However, there are a few <code>make</code> variables, known as <em>control variables</em> that are supposed to be overriden on the command line. These make up the &quot;make time&quot; configuration, as opposed to the &quot;configure time&quot; configuration.</p>
ihse@2619 596 <h4 id="general-make-control-variables">General Make Control Variables</h4>
ihse@2619 597 <ul>
ihse@2619 598 <li><code>JOBS</code> - Specify the number of jobs to build with. See <a href="#build-performance">Build Performance</a>.</li>
ihse@2619 599 <li><code>LOG</code> - Specify the logging level and functionality. See <a href="#checking-the-build-log-file">Checking the Build Log File</a></li>
ihse@2619 600 <li><code>CONF</code> and <code>CONF_NAME</code> - Selecting the configuration(s) to use. See <a href="#using-multiple-configurations">Using Multiple Configurations</a></li>
ihse@2619 601 </ul>
ihse@2619 602 <h4 id="test-make-control-variables">Test Make Control Variables</h4>
ihse@2619 603 <p>These make control variables only make sense when running tests. Please see <a href="testing.html">Testing OpenJDK</a> for details.</p>
ihse@2619 604 <ul>
ihse@2619 605 <li><code>TEST</code></li>
ihse@2619 606 <li><code>TEST_JOBS</code></li>
ihse@2619 607 <li><code>JTREG</code></li>
ihse@2619 608 <li><code>GTEST</code></li>
ihse@2619 609 </ul>
ihse@2619 610 <h4 id="advanced-make-control-variables">Advanced Make Control Variables</h4>
ihse@2619 611 <p>These advanced make control variables can be potentially unsafe. See <a href="#hints-and-suggestions-for-advanced-users">Hints and Suggestions for Advanced Users</a> and <a href="#understanding-the-build-system">Understanding the Build System</a> for details.</p>
ihse@2619 612 <ul>
ihse@2619 613 <li><code>SPEC</code></li>
ihse@2619 614 <li><code>CONF_CHECK</code></li>
ihse@2619 615 <li><code>COMPARE_BUILD</code></li>
ihse@2619 616 <li><code>JDK_FILTER</code></li>
ihse@2619 617 </ul>
ihse@2619 618 <h2 id="running-tests">Running Tests</h2>
ihse@2619 619 <p>Most of the OpenJDK tests are using the <a href="http://openjdk.java.net/jtreg">JTReg</a> test framework. Make sure that your configuration knows where to find your installation of JTReg. If this is not picked up automatically, use the <code>--with-jtreg=&lt;path to jtreg home&gt;</code> option to point to the JTReg framework. Note that this option should point to the JTReg home, i.e. the top directory, containing <code>lib/jtreg.jar</code> etc.</p>
ihse@2619 620 <p>To execute the most basic tests (tier 1), use:</p>
ihse@2619 621 <pre><code>make run-test-tier1</code></pre>
ihse@2619 622 <p>For more details on how to run tests, please see the <a href="testing.html">Testing OpenJDK</a> document.</p>
ihse@2619 623 <h2 id="cross-compiling">Cross-compiling</h2>
ihse@2619 624 <p>Cross-compiling means using one platform (the <em>build</em> platform) to generate output that can ran on another platform (the <em>target</em> platform).</p>
ihse@2619 625 <p>The typical reason for cross-compiling is that the build is performed on a more powerful desktop computer, but the resulting binaries will be able to run on a different, typically low-performing system. Most of the complications that arise when building for embedded is due to this separation of <em>build</em> and <em>target</em> systems.</p>
ihse@2619 626 <p>This requires a more complex setup and build procedure. This section assumes you are familiar with cross-compiling in general, and will only deal with the particularities of cross-compiling OpenJDK. If you are new to cross-compiling, please see the <a href="https://en.wikipedia.org/wiki/Cross_compiler#External_links">external links at Wikipedia</a> for a good start on reading materials.</p>
ihse@2619 627 <p>Cross-compiling OpenJDK requires you to be able to build both for the build platform and for the target platform. The reason for the former is that we need to build and execute tools during the build process, both native tools and Java tools.</p>
ihse@2619 628 <p>If all you want to do is to compile a 32-bit version, for the same OS, on a 64-bit machine, consider using <code>--with-target-bits=32</code> instead of doing a full-blown cross-compilation. (While this surely is possible, it's a lot more work and will take much longer to build.)</p>
ihse@2619 629 <h3 id="boot-jdk-and-build-jdk">Boot JDK and Build JDK</h3>
ihse@2619 630 <p>When cross-compiling, make sure you use a boot JDK that runs on the <em>build</em> system, and not on the <em>target</em> system.</p>
ihse@2619 631 <p>To be able to build, we need a &quot;Build JDK&quot;, which is a JDK built from the current sources (that is, the same as the end result of the entire build process), but able to run on the <em>build</em> system, and not the <em>target</em> system. (In contrast, the Boot JDK should be from an older release, e.g. JDK 8 when building JDK 9.)</p>
ihse@2619 632 <p>The build process will create a minimal Build JDK for you, as part of building. To speed up the build, you can use <code>--with-build-jdk</code> to <code>configure</code> to point to a pre-built Build JDK. Please note that the build result is unpredictable, and can possibly break in subtle ways, if the Build JDK does not <strong>exactly</strong> match the current sources.</p>
ihse@2619 633 <h3 id="specifying-the-target-platform">Specifying the Target Platform</h3>
ihse@2619 634 <p>You <em>must</em> specify the target platform when cross-compiling. Doing so will also automatically turn the build into a cross-compiling mode. The simplest way to do this is to use the <code>--openjdk-target</code> argument, e.g. <code>--openjdk-target=arm-linux-gnueabihf</code>. or <code>--openjdk-target=aarch64-oe-linux</code>. This will automatically set the <code>--build</code>, <code>--host</code> and <code>--target</code> options for autoconf, which can otherwise be confusing. (In autoconf terminology, the &quot;target&quot; is known as &quot;host&quot;, and &quot;target&quot; is used for building a Canadian cross-compiler.)</p>
ihse@2619 635 <h3 id="toolchain-considerations">Toolchain Considerations</h3>
ihse@2619 636 <p>You will need two copies of your toolchain, one which generates output that can run on the target system (the normal, or <em>target</em>, toolchain), and one that generates output that can run on the build system (the <em>build</em> toolchain). Note that cross-compiling is only supported for gcc at the time being. The gcc standard is to prefix cross-compiling toolchains with the target denominator. If you follow this standard, <code>configure</code> is likely to pick up the toolchain correctly.</p>
ihse@2619 637 <p>The <em>build</em> toolchain will be autodetected just the same way the normal <em>build</em>/<em>target</em> toolchain will be autodetected when not cross-compiling. If this is not what you want, or if the autodetection fails, you can specify a devkit containing the <em>build</em> toolchain using <code>--with-build-devkit</code> to <code>configure</code>, or by giving <code>BUILD_CC</code> and <code>BUILD_CXX</code> arguments.</p>
ihse@2619 638 <p>It is often helpful to locate the cross-compilation tools, headers and libraries in a separate directory, outside the normal path, and point out that directory to <code>configure</code>. Do this by setting the sysroot (<code>--with-sysroot</code>) and appending the directory when searching for cross-compilations tools (<code>--with-toolchain-path</code>). As a compact form, you can also use <code>--with-devkit</code> to point to a single directory, if it is correctly setup. (See <code>basics.m4</code> for details.)</p>
ihse@2619 639 <p>If you are unsure what toolchain and versions to use, these have been proved working at the time of writing:</p>
ihse@2619 640 <ul>
ihse@2619 641 <li><a href="https://releases.linaro.org/archive/13.11/components/toolchain/binaries/gcc-linaro-aarch64-linux-gnu-4.8-2013.11_linux.tar.xz">aarch64</a></li>
ihse@2619 642 <li><a href="https://launchpad.net/linaro-toolchain-unsupported/trunk/2012.09/+download/gcc-linaro-arm-linux-gnueabihf-raspbian-2012.09-20120921_linux.tar.bz2">arm 32-bit hardware floating point</a></li>
ihse@2619 643 </ul>
ihse@2619 644 <h3 id="native-libraries">Native Libraries</h3>
ihse@2619 645 <p>You will need copies of external native libraries for the <em>target</em> system, present on the <em>build</em> machine while building.</p>
ihse@2619 646 <p>Take care not to replace the <em>build</em> system's version of these libraries by mistake, since that can render the <em>build</em> machine unusable.</p>
ihse@2619 647 <p>Make sure that the libraries you point to (ALSA, X11, etc) are for the <em>target</em>, not the <em>build</em>, platform.</p>
ihse@2619 648 <h4 id="alsa-1">ALSA</h4>
ihse@2619 649 <p>You will need alsa libraries suitable for your <em>target</em> system. For most cases, using Debian's pre-built libraries work fine.</p>
ihse@2619 650 <p>Note that alsa is needed even if you only want to build a headless JDK.</p>
ihse@2619 651 <ul>
ihse@2619 652 <li><p>Go to <a href="https://www.debian.org/distrib/packages">Debian Package Search</a> and search for the <code>libasound2</code> and <code>libasound2-dev</code> packages for your <em>target</em> system. Download them to /tmp.</p></li>
ihse@2619 653 <li><p>Install the libraries into the cross-compilation toolchain. For instance:</p>
ihse@2619 654 <pre><code>cd /tools/gcc-linaro-arm-linux-gnueabihf-raspbian-2012.09-20120921_linux/arm-linux-gnueabihf/libc
ihse@2619 655 dpkg-deb -x /tmp/libasound2_1.0.25-4_armhf.deb .
ihse@2619 656 dpkg-deb -x /tmp/libasound2-dev_1.0.25-4_armhf.deb .</code></pre></li>
ihse@2619 657 <li><p>If alsa is not properly detected by <code>configure</code>, you can point it out by <code>--with-alsa</code>.</p></li>
ihse@2619 658 </ul>
ihse@2619 659 <h4 id="x11-1">X11</h4>
ihse@2619 660 <p>You will need X11 libraries suitable for your <em>target</em> system. For most cases, using Debian's pre-built libraries work fine.</p>
ihse@2619 661 <p>Note that X11 is needed even if you only want to build a headless JDK.</p>
ihse@2619 662 <ul>
ihse@2619 663 <li>Go to <a href="https://www.debian.org/distrib/packages">Debian Package Search</a>, search for the following packages for your <em>target</em> system, and download them to /tmp/target-x11:
ihse@2619 664 <ul>
ihse@2619 665 <li>libxi</li>
ihse@2619 666 <li>libxi-dev</li>
ihse@2619 667 <li>x11proto-core-dev</li>
ihse@2619 668 <li>x11proto-input-dev</li>
ihse@2619 669 <li>x11proto-kb-dev</li>
ihse@2619 670 <li>x11proto-render-dev</li>
ihse@2619 671 <li>x11proto-xext-dev</li>
ihse@2619 672 <li>libice-dev</li>
ihse@2619 673 <li>libxrender</li>
ihse@2619 674 <li>libxrender-dev</li>
ihse@2619 675 <li>libsm-dev</li>
ihse@2619 676 <li>libxt-dev</li>
ihse@2619 677 <li>libx11</li>
ihse@2619 678 <li>libx11-dev</li>
ihse@2619 679 <li>libxtst</li>
ihse@2619 680 <li>libxtst-dev</li>
ihse@2619 681 <li>libxext</li>
ihse@2619 682 <li>libxext-dev</li>
ihse@2619 683 </ul></li>
ihse@2619 684 <li><p>Install the libraries into the cross-compilation toolchain. For instance:</p>
ihse@2619 685 <pre><code>cd /tools/gcc-linaro-arm-linux-gnueabihf-raspbian-2012.09-20120921_linux/arm-linux-gnueabihf/libc/usr
ihse@2619 686 mkdir X11R6
ihse@2619 687 cd X11R6
ihse@2619 688 for deb in /tmp/target-x11/*.deb ; do dpkg-deb -x $deb . ; done
ihse@2619 689 mv usr/* .
ihse@2619 690 cd lib
ihse@2619 691 cp arm-linux-gnueabihf/* .</code></pre>
ihse@2619 692 <p>You can ignore the following messages. These libraries are not needed to successfully complete a full JDK build.</p>
ihse@2619 693 <pre><code>cp: cannot stat `arm-linux-gnueabihf/libICE.so&#39;: No such file or directory
ihse@2619 694 cp: cannot stat `arm-linux-gnueabihf/libSM.so&#39;: No such file or directory
ihse@2619 695 cp: cannot stat `arm-linux-gnueabihf/libXt.so&#39;: No such file or directory</code></pre></li>
ihse@2619 696 <li><p>If the X11 libraries are not properly detected by <code>configure</code>, you can point them out by <code>--with-x</code>.</p></li>
ihse@2619 697 </ul>
ihse@2619 698 <h3 id="building-for-armaarch64">Building for ARM/aarch64</h3>
ihse@2619 699 <p>A common cross-compilation target is the ARM CPU. When building for ARM, it is useful to set the ABI profile. A number of pre-defined ABI profiles are available using <code>--with-abi-profile</code>: arm-vfp-sflt, arm-vfp-hflt, arm-sflt, armv5-vfp-sflt, armv6-vfp-hflt. Note that soft-float ABIs are no longer properly supported on OpenJDK.</p>
ihse@2619 700 <p>OpenJDK contains two different ports for the aarch64 platform, one is the original aarch64 port from the <a href="http://openjdk.java.net/projects/aarch64-port">AArch64 Port Project</a> and one is a 64-bit version of the Oracle contributed ARM port. When targeting aarch64, by the default the original aarch64 port is used. To select the Oracle ARM 64 port, use <code>--with-cpu-port=arm64</code>. Also set the corresponding value (<code>aarch64</code> or <code>arm64</code>) to --with-abi-profile, to ensure a consistent build.</p>
ihse@2619 701 <h3 id="verifying-the-build">Verifying the Build</h3>
ihse@2619 702 <p>The build will end up in a directory named like <code>build/linux-arm-normal-server-release</code>.</p>
ihse@2619 703 <p>Inside this build output directory, the <code>images/jdk</code> and <code>images/jre</code> will contain the newly built JDK and JRE, respectively, for your <em>target</em> system.</p>
ihse@2619 704 <p>Copy these folders to your <em>target</em> system. Then you can run e.g. <code>images/jdk/bin/java -version</code>.</p>
ihse@2619 705 <h2 id="build-performance">Build Performance</h2>
ihse@2520 706 <p>Building OpenJDK requires a lot of horsepower. Some of the build tools can be adjusted to utilize more or less of resources such as parallel threads and memory. The <code>configure</code> script analyzes your system and selects reasonable values for such options based on your hardware. If you encounter resource problems, such as out of memory conditions, you can modify the detected values with:</p>
ihse@1680 707 <ul>
ihse@2619 708 <li><p><code>--with-num-cores</code> -- number of cores in the build system, e.g. <code>--with-num-cores=8</code>.</p></li>
ihse@2619 709 <li><p><code>--with-memory-size</code> -- memory (in MB) available in the build system, e.g. <code>--with-memory-size=1024</code></p></li>
ihse@1680 710 </ul>
ihse@2619 711 <p>You can also specify directly the number of build jobs to use with <code>--with-jobs=N</code> to <code>configure</code>, or <code>JOBS=N</code> to <code>make</code>. Do not use the <code>-j</code> flag to <code>make</code>. In most cases it will be ignored by the makefiles, but it can cause problems for some make targets.</p>
ihse@2619 712 <p>It might also be necessary to specify the JVM arguments passed to the Boot JDK, using e.g. <code>--with-boot-jdk-jvmargs=&quot;-Xmx8G&quot;</code>. Doing so will override the default JVM arguments passed to the Boot JDK.</p>
ihse@2520 713 <p>At the end of a successful execution of <code>configure</code>, you will get a performance summary, indicating how well the build will perform. Here you will also get performance hints. If you want to build fast, pay attention to those!</p>
ihse@2619 714 <p>If you want to tweak build performance, run with <code>make LOG=info</code> to get a build time summary at the end of the build process.</p>
ihse@2619 715 <h3 id="disk-speed">Disk Speed</h3>
ihse@2619 716 <p>If you are using network shares, e.g. via NFS, for your source code, make sure the build directory is situated on local disk (e.g. by <code>ln -s /localdisk/jdk-build $JDK-SHARE/build</code>). The performance penalty is extremely high for building on a network share; close to unusable.</p>
ihse@2619 717 <p>Also, make sure that your build tools (including Boot JDK and toolchain) is located on a local disk and not a network share.</p>
ihse@2619 718 <p>As has been stressed elsewhere, do use SSD for source code and build directory, as well as (if possible) the build tools.</p>
ihse@2619 719 <h3 id="virus-checking">Virus Checking</h3>
ihse@2619 720 <p>The use of virus checking software, especially on Windows, can <em>significantly</em> slow down building of OpenJDK. If possible, turn off such software, or exclude the directory containing the OpenJDK source code from on-the-fly checking.</p>
ihse@2619 721 <h3 id="ccache">Ccache</h3>
ihse@2619 722 <p>The OpenJDK build supports building with ccache when using gcc or clang. Using ccache can radically speed up compilation of native code if you often rebuild the same sources. Your milage may vary however, so we recommend evaluating it for yourself. To enable it, make sure it's on the path and configure with <code>--enable-ccache</code>.</p>
ihse@2619 723 <h3 id="precompiled-headers">Precompiled Headers</h3>
ihse@2619 724 <p>By default, the Hotspot build uses preccompiled headers (PCH) on the toolchains were it is properly supported (clang, gcc, and Visual Studio). Normally, this speeds up the build process, but in some circumstances, it can actually slow things down.</p>
ihse@2619 725 <p>You can experiment by disabling precompiled headers using <code>--disable-precompiled-headers</code>.</p>
ihse@2619 726 <h3 id="icecc-icecream">Icecc / icecream</h3>
ihse@2619 727 <p><a href="http://github.com/icecc/icecream">icecc/icecream</a> is a simple way to setup a distributed compiler network. If you have multiple machines available for building OpenJDK, you can drastically cut individual build times by utilizing it.</p>
ihse@2619 728 <p>To use, setup an icecc network, and install icecc on the build machine. Then run <code>configure</code> using <code>--enable-icecc</code>.</p>
ihse@2619 729 <h3 id="using-sjavac">Using sjavac</h3>
ihse@2619 730 <p>To speed up Java compilation, especially incremental compilations, you can try the experimental sjavac compiler by using <code>--enable-sjavac</code>.</p>
ihse@2619 731 <h3 id="building-the-right-target">Building the Right Target</h3>
ihse@2619 732 <p>Selecting the proper target to build can have dramatic impact on build time. For normal usage, <code>jdk</code> or the default target is just fine. You only need to build <code>images</code> for shipping, or if your tests require it.</p>
ihse@2619 733 <p>See also <a href="#using-fine-grained-make-targets">Using Fine-Grained Make Targets</a> on how to build an even smaller subset of the product.</p>
ihse@2619 734 <h2 id="troubleshooting">Troubleshooting</h2>
ihse@2619 735 <p>If your build fails, it can sometimes be difficult to pinpoint the problem or find a proper solution.</p>
ihse@2619 736 <h3 id="locating-the-source-of-the-error">Locating the Source of the Error</h3>
ihse@2619 737 <p>When a build fails, it can be hard to pinpoint the actual cause of the error. In a typical build process, different parts of the product build in parallel, with the output interlaced.</p>
ihse@2619 738 <h4 id="build-failure-summary">Build Failure Summary</h4>
ihse@2619 739 <p>To help you, the build system will print a failure summary at the end. It looks like this:</p>
ihse@2619 740 <pre><code>ERROR: Build failed for target &#39;hotspot&#39; in configuration &#39;linux-x64&#39; (exit code 2)
ihse@2619 741
ihse@2619 742 === Output from failing command(s) repeated here ===
ihse@2619 743 * For target hotspot_variant-server_libjvm_objs_psMemoryPool.o:
ihse@2619 744 /localhome/hg/jdk9-sandbox/hotspot/src/share/vm/services/psMemoryPool.cpp:1:1: error: &#39;failhere&#39; does not name a type
ihse@2619 745 ... (rest of output omitted)
ihse@2619 746
ihse@2619 747 * All command lines available in /localhome/hg/jdk9-sandbox/build/linux-x64/make-support/failure-logs.
ihse@2619 748 === End of repeated output ===
ihse@2619 749
ihse@2619 750 === Make failed targets repeated here ===
ihse@2619 751 lib/CompileJvm.gmk:207: recipe for target &#39;/localhome/hg/jdk9-sandbox/build/linux-x64/hotspot/variant-server/libjvm/objs/psMemoryPool.o&#39; failed
ihse@2619 752 make/Main.gmk:263: recipe for target &#39;hotspot-server-libs&#39; failed
ihse@2619 753 === End of repeated output ===
ihse@2619 754
ihse@2619 755 Hint: Try searching the build log for the name of the first failed target.
ihse@2619 756 Hint: If caused by a warning, try configure --disable-warnings-as-errors.</code></pre>
ihse@2619 757 <p>Let's break it down! First, the selected configuration, and the top-level target you entered on the command line that caused the failure is printed.</p>
ihse@2619 758 <p>Then, between the <code>Output from failing command(s) repeated here</code> and <code>End of repeated output</code> the first lines of output (stdout and stderr) from the actual failing command is repeated. In most cases, this is the error message that caused the build to fail. If multiple commands were failing (this can happen in a parallel build), output from all failed commands will be printed here.</p>
ihse@2619 759 <p>The path to the <code>failure-logs</code> directory is printed. In this file you will find a <code>&lt;target&gt;.log</code> file that contains the output from this command in its entirety, and also a <code>&lt;target&gt;.cmd</code>, which contain the complete command line used for running this command. You can re-run the failing command by executing <code>. &lt;path to failure-logs&gt;/&lt;target&gt;.cmd</code> in your shell.</p>
ihse@2619 760 <p>Another way to trace the failure is to follow the chain of make targets, from top-level targets to individual file targets. Between <code>Make failed targets repeated here</code> and <code>End of repeated output</code> the output from make showing this chain is repeated. The first failed recipe will typically contain the full path to the file in question that failed to compile. Following lines will show a trace of make targets why we ended up trying to compile that file.</p>
ihse@2619 761 <p>Finally, some hints are given on how to locate the error in the complete log. In this example, we would try searching the log file for &quot;<code>psMemoryPool.o</code>&quot;. Another way to quickly locate make errors in the log is to search for &quot;<code>] Error</code>&quot; or &quot;<code>***</code>&quot;.</p>
ihse@2619 762 <p>Note that the build failure summary will only help you if the issue was a compilation failure or similar. If the problem is more esoteric, or is due to errors in the build machinery, you will likely get empty output logs, and <code>No indication of failed target found</code> instead of the make target chain.</p>
ihse@2619 763 <h4 id="checking-the-build-log-file">Checking the Build Log File</h4>
ihse@2619 764 <p>The output (stdout and stderr) from the latest build is always stored in <code>$BUILD/build.log</code>. The previous build log is stored as <code>build.log.old</code>. This means that it is not necessary to redirect the build output yourself if you want to process it.</p>
ihse@2619 765 <p>You can increase the verbosity of the log file, by the <code>LOG</code> control variable to <code>make</code>. If you want to see the command lines used in compilations, use <code>LOG=cmdlines</code>. To increase the general verbosity, use <code>LOG=info</code>, <code>LOG=debug</code> or <code>LOG=trace</code>. Both of these can be combined with <code>cmdlines</code>, e.g. <code>LOG=info,cmdlines</code>. The <code>debug</code> log level will show most shell commands executed by make, and <code>trace</code> will show all. Beware that both these log levels will produce a massive build log!</p>
ihse@2619 766 <h3 id="fixing-unexpected-build-failures">Fixing Unexpected Build Failures</h3>
ihse@2619 767 <p>Most of the time, the build will fail due to incorrect changes in the source code.</p>
ihse@2619 768 <p>Sometimes the build can fail with no apparent changes that have caused the failure. If this is the first time you are building OpenJDK on this particular computer, and the build fails, the problem is likely with your build environment. But even if you have previously built OpenJDK with success, and it now fails, your build environment might have changed (perhaps due to OS upgrades or similar). But most likely, such failures are due to problems with the incremental rebuild.</p>
ihse@2619 769 <h4 id="problems-with-the-build-environment">Problems with the Build Environment</h4>
ihse@2619 770 <p>Make sure your configuration is correct. Re-run <code>configure</code>, and look for any warnings. Warnings that appear in the middle of the <code>configure</code> output is also repeated at the end, after the summary. The entire log is stored in <code>$BUILD/configure.log</code>.</p>
ihse@2619 771 <p>Verify that the summary at the end looks correct. Are you indeed using the Boot JDK and native toolchain that you expect?</p>
ihse@2619 772 <p>By default, OpenJDK has a strict approach where warnings from the compiler is considered errors which fail the build. For very new or very old compiler versions, this can trigger new classes of warnings, which thus fails the build. Run <code>configure</code> with <code>--disable-warnings-as-errors</code> to turn of this behavior. (The warnings will still show, but not make the build fail.)</p>
ihse@2619 773 <h4 id="problems-with-incremental-rebuilds">Problems with Incremental Rebuilds</h4>
ihse@2619 774 <p>Incremental rebuilds mean that when you modify part of the product, only the affected parts get rebuilt. While this works great in most cases, and significantly speed up the development process, from time to time complex interdependencies will result in an incorrect build result. This is the most common cause for unexpected build problems, together with inconsistencies between the different Mercurial repositories in the forest.</p>
ihse@2619 775 <p>Here are a suggested list of things to try if you are having unexpected build problems. Each step requires more time than the one before, so try them in order. Most issues will be solved at step 1 or 2.</p>
ihse@2619 776 <ol type="1">
ihse@2619 777 <li><p>Make sure your forest is up-to-date</p>
ihse@2619 778 <p>Run <code>bash get_source.sh</code> to make sure you have the latest version of all repositories.</p></li>
ihse@2619 779 <li><p>Clean build results</p>
ihse@2619 780 <p>The simplest way to fix incremental rebuild issues is to run <code>make clean</code>. This will remove all build results, but not the configuration or any build system support artifacts. In most cases, this will solve build errors resulting from incremental build mismatches.</p></li>
ihse@2619 781 <li><p>Completely clean the build directory.</p>
ihse@2619 782 <p>If this does not work, the next step is to run <code>make dist-clean</code>, or removing the build output directory (<code>$BUILD</code>). This will clean all generated output, including your configuration. You will need to re-run <code>configure</code> after this step. A good idea is to run <code>make print-configuration</code> before running <code>make dist-clean</code>, as this will print your current <code>configure</code> command line. Here's a way to do this:</p>
ihse@2619 783 <pre><code>make print-configuration &gt; current-configuration
ihse@2619 784 make dist-clean
ihse@2619 785 bash configure $(cat current-configuration)
ihse@2619 786 make</code></pre></li>
ihse@2619 787 <li><p>Re-clone the Mercurial forest</p>
ihse@2619 788 <p>Sometimes the Mercurial repositories themselves gets in a state that causes the product to be un-buildable. In such a case, the simplest solution is often the &quot;sledgehammer approach&quot;: delete the entire forest, and re-clone it. If you have local changes, save them first to a different location using <code>hg export</code>.</p></li>
ihse@2619 789 </ol>
ihse@2619 790 <h3 id="specific-build-issues">Specific Build Issues</h3>
ihse@2619 791 <h4 id="clock-skew">Clock Skew</h4>
ihse@2619 792 <p>If you get an error message like this:</p>
ihse@2619 793 <pre><code>File &#39;xxx&#39; has modification time in the future.
ihse@2619 794 Clock skew detected. Your build may be incomplete.</code></pre>
ihse@2619 795 <p>then the clock on your build machine is out of sync with the timestamps on the source files. Other errors, apparently unrelated but in fact caused by the clock skew, can occur along with the clock skew warnings. These secondary errors may tend to obscure the fact that the true root cause of the problem is an out-of-sync clock.</p>
ihse@2619 796 <p>If you see these warnings, reset the clock on the build machine, run <code>make clean</code> and restart the build.</p>
ihse@2619 797 <h4 id="out-of-memory-errors">Out of Memory Errors</h4>
ihse@2619 798 <p>On Solaris, you might get an error message like this:</p>
ihse@2619 799 <pre><code>Trouble writing out table to disk</code></pre>
ihse@2619 800 <p>To solve this, increase the amount of swap space on your build machine.</p>
ihse@2619 801 <p>On Windows, you might get error messages like this:</p>
ihse@2619 802 <pre><code>fatal error - couldn&#39;t allocate heap
ihse@2619 803 cannot create ... Permission denied
ihse@2619 804 spawn failed</code></pre>
ihse@2619 805 <p>This can be a sign of a Cygwin problem. See the information about solving problems in the <a href="#cygwin">Cygwin</a> section. Rebooting the computer might help temporarily.</p>
ihse@2619 806 <h3 id="getting-help">Getting Help</h3>
ihse@2619 807 <p>If none of the suggestions in this document helps you, or if you find what you believe is a bug in the build system, please contact the Build Group by sending a mail to <a href="mailto:build-dev@openjdk.java.net">build-dev@openjdk.java.net</a>. Please include the relevant parts of the configure and/or build log.</p>
ihse@2619 808 <p>If you need general help or advice about developing for OpenJDK, you can also contact the Adoption Group. See the section on <a href="#contributing-to-openjdk">Contributing to OpenJDK</a> for more information.</p>
ihse@2619 809 <h2 id="hints-and-suggestions-for-advanced-users">Hints and Suggestions for Advanced Users</h2>
ihse@2619 810 <h3 id="setting-up-a-forest-for-pushing-changes-defpath">Setting Up a Forest for Pushing Changes (defpath)</h3>
ihse@2619 811 <p>To help you prepare a proper push path for a Mercurial repository, there exists a useful tool known as <a href="http://openjdk.java.net/projects/code-tools/defpath">defpath</a>. It will help you setup a proper push path for pushing changes to OpenJDK.</p>
ihse@2619 812 <p>Install the extension by cloning <code>http://hg.openjdk.java.net/code-tools/defpath</code> and updating your <code>.hgrc</code> file. Here's one way to do this:</p>
ihse@2619 813 <pre><code>cd ~
ihse@2619 814 mkdir hg-ext
ihse@2619 815 cd hg-ext
ihse@2619 816 hg clone http://hg.openjdk.java.net/code-tools/defpath
ihse@2619 817 cat &lt;&lt; EOT &gt;&gt; ~/.hgrc
ihse@2619 818 [extensions]
ihse@2619 819 defpath=~/hg-ext/defpath/defpath.py
ihse@2619 820 EOT</code></pre>
ihse@2619 821 <p>You can now setup a proper push path using:</p>
ihse@2619 822 <pre><code>hg defpath -d -u &lt;your OpenJDK username&gt;</code></pre>
ihse@2619 823 <p>If you also have the <code>trees</code> extension installed in Mercurial, you will automatically get a <code>tdefpath</code> command, which is even more useful. By running <code>hg tdefpath -du &lt;username&gt;</code> in the top repository of your forest, all repos will get setup automatically. This is the recommended usage.</p>
ihse@2619 824 <h3 id="bash-completion">Bash Completion</h3>
ihse@2619 825 <p>The <code>configure</code> and <code>make</code> commands tries to play nice with bash command-line completion (using <code>&lt;tab&gt;</code> or <code>&lt;tab&gt;&lt;tab&gt;</code>). To use this functionality, make sure you enable completion in your <code>~/.bashrc</code> (see instructions for bash in your operating system).</p>
ihse@2619 826 <p>Make completion will work out of the box, and will complete valid make targets. For instance, typing <code>make jdk-i&lt;tab&gt;</code> will complete to <code>make jdk-image</code>.</p>
ihse@2619 827 <p>The <code>configure</code> script can get completion for options, but for this to work you need to help <code>bash</code> on the way. The standard way of running the script, <code>bash configure</code>, will not be understood by bash completion. You need <code>configure</code> to be the command to run. One way to achieve this is to add a simple helper script to your path:</p>
ihse@2619 828 <pre><code>cat &lt;&lt; EOT &gt; /tmp/configure
ihse@2619 829 #!/bin/bash
ihse@2619 830 if [ \$(pwd) = \$(cd \$(dirname \$0); pwd) ] ; then
ihse@2619 831 echo &gt;&amp;2 &quot;Abort: Trying to call configure helper recursively&quot;
ihse@2619 832 exit 1
ihse@2619 833 fi
ihse@2619 834
ihse@2619 835 bash \$PWD/configure &quot;\$@&quot;
ihse@2619 836 EOT
ihse@2619 837 chmod +x /tmp/configure
ihse@2619 838 sudo mv /tmp/configure /usr/local/bin</code></pre>
ihse@2619 839 <p>Now <code>configure --en&lt;tab&gt;-dt&lt;tab&gt;</code> will result in <code>configure --enable-dtrace</code>.</p>
ihse@2619 840 <h3 id="using-multiple-configurations">Using Multiple Configurations</h3>
ihse@2619 841 <p>You can have multiple configurations for a single source forest. When you create a new configuration, run <code>configure --with-conf-name=&lt;name&gt;</code> to create a configuration with the name <code>&lt;name&gt;</code>. Alternatively, you can create a directory under <code>build</code> and run <code>configure</code> from there, e.g. <code>mkdir build/&lt;name&gt; &amp;&amp; cd build/&lt;name&gt; &amp;&amp; bash ../../configure</code>.</p>
ihse@2619 842 <p>Then you can build that configuration using <code>make CONF_NAME=&lt;name&gt;</code> or <code>make CONF=&lt;pattern&gt;</code>, where <code>&lt;pattern&gt;</code> is a substring matching one or several configurations, e.g. <code>CONF=debug</code>. The special empty pattern (<code>CONF=</code>) will match <em>all</em> available configuration, so <code>make CONF= hotspot</code> will build the <code>hotspot</code> target for all configurations. Alternatively, you can execute <code>make</code> in the configuration directory, e.g. <code>cd build/&lt;name&gt; &amp;&amp; make</code>.</p>
ihse@2619 843 <h3 id="handling-reconfigurations">Handling Reconfigurations</h3>
ihse@2619 844 <p>If you update the forest and part of the configure script has changed, the build system will force you to re-run <code>configure</code>.</p>
ihse@2619 845 <p>Most of the time, you will be fine by running <code>configure</code> again with the same arguments as the last time, which can easily be performed by <code>make reconfigure</code>. To simplify this, you can use the <code>CONF_CHECK</code> make control variable, either as <code>make CONF_CHECK=auto</code>, or by setting an environment variable. For instance, if you add <code>export CONF_CHECK=auto</code> to your <code>.bashrc</code> file, <code>make</code> will always run <code>reconfigure</code> automatically whenever the configure script has changed.</p>
ihse@2619 846 <p>You can also use <code>CONF_CHECK=ignore</code> to skip the check for a needed configure update. This might speed up the build, but comes at the risk of an incorrect build result. This is only recommended if you know what you're doing.</p>
ihse@2619 847 <p>From time to time, you will also need to modify the command line to <code>configure</code> due to changes. Use <code>make print-configure</code> to show the command line used for your current configuration.</p>
ihse@2619 848 <h3 id="using-fine-grained-make-targets">Using Fine-Grained Make Targets</h3>
ihse@2619 849 <p>The default behavior for make is to create consistent and correct output, at the expense of build speed, if necessary.</p>
ihse@2619 850 <p>If you are prepared to take some risk of an incorrect build, and know enough of the system to understand how things build and interact, you can speed up the build process considerably by instructing make to only build a portion of the product.</p>
ihse@2619 851 <h4 id="building-individual-modules">Building Individual Modules</h4>
ihse@2619 852 <p>The safe way to use fine-grained make targets is to use the module specific make targets. All source code in JDK 9 is organized so it belongs to a module, e.g. <code>java.base</code> or <code>jdk.jdwp.agent</code>. You can build only a specific module, by giving it as make target: <code>make jdk.jdwp.agent</code>. If the specified module depends on other modules (e.g. <code>java.base</code>), those modules will be built first.</p>
ihse@2619 853 <p>You can also specify a set of modules, just as you can always specify a set of make targets: <code>make jdk.crypto.cryptoki jdk.crypto.ec jdk.crypto.mscapi jdk.crypto.ucrypto</code></p>
ihse@2619 854 <h4 id="building-individual-module-phases">Building Individual Module Phases</h4>
ihse@2619 855 <p>The build process for each module is divided into separate phases. Not all modules need all phases. Which are needed depends on what kind of source code and other artifact the module consists of. The phases are:</p>
ihse@1680 856 <ul>
ihse@2619 857 <li><code>gensrc</code> (Generate source code to compile)</li>
ihse@2619 858 <li><code>gendata</code> (Generate non-source code artifacts)</li>
ihse@2619 859 <li><code>copy</code> (Copy resource artifacts)</li>
ihse@2619 860 <li><code>java</code> (Compile Java code)</li>
ihse@2619 861 <li><code>launchers</code> (Compile native executables)</li>
ihse@2619 862 <li><code>libs</code> (Compile native libraries)</li>
ihse@2619 863 <li><code>rmic</code> (Run the <code>rmic</code> tool)</li>
ihse@2520 864 </ul>
ihse@2619 865 <p>You can build only a single phase for a module by using the notation <code>$MODULE-$PHASE</code>. For instance, to build the <code>gensrc</code> phase for <code>java.base</code>, use <code>make java.base-gensrc</code>.</p>
ihse@2619 866 <p>Note that some phases may depend on others, e.g. <code>java</code> depends on <code>gensrc</code> (if present). Make will build all needed prerequisites before building the requested phase.</p>
ihse@2619 867 <h4 id="skipping-the-dependency-check">Skipping the Dependency Check</h4>
ihse@2619 868 <p>When using an iterative development style with frequent quick rebuilds, the dependency check made by make can take up a significant portion of the time spent on the rebuild. In such cases, it can be useful to bypass the dependency check in make.</p>
ihse@2619 869 <blockquote>
ihse@2619 870 <p><strong>Note that if used incorrectly, this can lead to a broken build!</strong></p>
ihse@2619 871 </blockquote>
ihse@2619 872 <p>To achieve this, append <code>-only</code> to the build target. For instance, <code>make jdk.jdwp.agent-java-only</code> will <em>only</em> build the <code>java</code> phase of the <code>jdk.jdwp.agent</code> module. If the required dependencies are not present, the build can fail. On the other hand, the execution time measures in milliseconds.</p>
ihse@2619 873 <p>A useful pattern is to build the first time normally (e.g. <code>make jdk.jdwp.agent</code>) and then on subsequent builds, use the <code>-only</code> make target.</p>
ihse@2619 874 <h4 id="rebuilding-part-of-java.base-jdk_filter">Rebuilding Part of java.base (JDK_FILTER)</h4>
ihse@2619 875 <p>If you are modifying files in <code>java.base</code>, which is the by far largest module in OpenJDK, then you need to rebuild all those files whenever a single file has changed. (This inefficiency will hopefully be addressed in JDK 10.)</p>
ihse@2619 876 <p>As a hack, you can use the make control variable <code>JDK_FILTER</code> to specify a pattern that will be used to limit the set of files being recompiled. For instance, <code>make java.base JDK_FILTER=javax/crypto</code> (or, to combine methods, <code>make java.base-java-only JDK_FILTER=javax/crypto</code>) will limit the compilation to files in the <code>javax.crypto</code> package.</p>
ihse@2619 877 <h3 id="learn-about-mercurial">Learn About Mercurial</h3>
ihse@2619 878 <p>To become an efficient OpenJDK developer, it is recommended that you invest in learning Mercurial properly. Here are some links that can get you started:</p>
ihse@2520 879 <ul>
ihse@2619 880 <li><a href="http://www.mercurial-scm.org/wiki/GitConcepts">Mercurial for git users</a></li>
ihse@2619 881 <li><a href="http://www.mercurial-scm.org/wiki/Tutorial">The official Mercurial tutorial</a></li>
ihse@2619 882 <li><a href="http://hginit.com/">hg init</a></li>
ihse@2619 883 <li><a href="http://hgbook.red-bean.com/read/">Mercurial: The Definitive Guide</a></li>
ihse@2520 884 </ul>
ihse@2619 885 <h2 id="understanding-the-build-system">Understanding the Build System</h2>
ihse@2619 886 <p>This section will give you a more technical description on the details of the build system.</p>
ihse@2619 887 <h3 id="configurations">Configurations</h3>
ihse@2619 888 <p>The build system expects to find one or more configuration. These are technically defined by the <code>spec.gmk</code> in a subdirectory to the <code>build</code> subdirectory. The <code>spec.gmk</code> file is generated by <code>configure</code>, and contains in principle the configuration (directly or by files included by <code>spec.gmk</code>).</p>
ihse@2619 889 <p>You can, in fact, select a configuration to build by pointing to the <code>spec.gmk</code> file with the <code>SPEC</code> make control variable, e.g. <code>make SPEC=$BUILD/spec.gmk</code>. While this is not the recommended way to call <code>make</code> as a user, it is what is used under the hood by the build system.</p>
ihse@2619 890 <h3 id="build-output-structure">Build Output Structure</h3>
ihse@2619 891 <p>The build output for a configuration will end up in <code>build/&lt;configuration name&gt;</code>, which we refer to as <code>$BUILD</code> in this document. The <code>$BUILD</code> directory contains the following important directories:</p>
ihse@2619 892 <pre><code>buildtools/
ihse@2619 893 configure-support/
ihse@2619 894 hotspot/
ihse@2619 895 images/
ihse@2619 896 jdk/
ihse@2619 897 make-support/
ihse@2619 898 support/
ihse@2619 899 test-results/
ihse@2619 900 test-support/</code></pre>
ihse@2619 901 <p>This is what they are used for:</p>
ihse@2520 902 <ul>
ihse@2619 903 <li><p><code>images</code>: This is the directory were the output of the <code>*-image</code> make targets end up. For instance, <code>make jdk-image</code> ends up in <code>images/jdk</code>.</p></li>
ihse@2619 904 <li><p><code>jdk</code>: This is the &quot;exploded image&quot;. After <code>make jdk</code>, you will be able to launch the newly built JDK by running <code>$BUILD/jdk/bin/java</code>.</p></li>
ihse@2619 905 <li><p><code>test-results</code>: This directory contains the results from running tests.</p></li>
ihse@2619 906 <li><p><code>support</code>: This is an area for intermediate files needed during the build, e.g. generated source code, object files and class files. Some noteworthy directories in <code>support</code> is <code>gensrc</code>, which contains the generated source code, and the <code>modules_*</code> directories, which contains the files in a per-module hierarchy that will later be collapsed into the <code>jdk</code> directory of the exploded image.</p></li>
ihse@2619 907 <li><p><code>buildtools</code>: This is an area for tools compiled for the build platform that are used during the rest of the build.</p></li>
ihse@2619 908 <li><p><code>hotspot</code>: This is an area for intermediate files needed when building hotspot.</p></li>
ihse@2619 909 <li><p><code>configure-support</code>, <code>make-support</code> and <code>test-support</code>: These directories contain files that are needed by the build system for <code>configure</code>, <code>make</code> and for running tests.</p></li>
ihse@2520 910 </ul>
ihse@2619 911 <h3 id="fixpath">Fixpath</h3>
ihse@2619 912 <p>Windows path typically look like <code>C:\User\foo</code>, while Unix paths look like <code>/home/foo</code>. Tools with roots from Unix often experience issues related to this mismatch when running on Windows.</p>
ihse@2619 913 <p>In the OpenJDK build, we always use Unix paths internally, and only just before calling a tool that does not understand Unix paths do we convert them to Windows paths.</p>
ihse@2619 914 <p>This conversion is done by the <code>fixpath</code> tool, which is a small wrapper that modifies unix-style paths to Windows-style paths in command lines. Fixpath is compiled automatically by <code>configure</code>.</p>
ihse@2619 915 <h3 id="native-debug-symbols">Native Debug Symbols</h3>
ihse@2619 916 <p>Native libraries and executables can have debug symbol (and other debug information) associated with them. How this works is very much platform dependent, but a common problem is that debug symbol information takes a lot of disk space, but is rarely needed by the end user.</p>
ihse@2619 917 <p>The OpenJDK supports different methods on how to handle debug symbols. The method used is selected by <code>--with-native-debug-symbols</code>, and available methods are <code>none</code>, <code>internal</code>, <code>external</code>, <code>zipped</code>.</p>
ihse@2520 918 <ul>
ihse@2619 919 <li><p><code>none</code> means that no debug symbols will be generated during the build.</p></li>
ihse@2619 920 <li><p><code>internal</code> means that debug symbols will be generated during the build, and they will be stored in the generated binary.</p></li>
ihse@2619 921 <li><p><code>external</code> means that debug symbols will be generated during the build, and after the compilation, they will be moved into a separate <code>.debuginfo</code> file. (This was previously known as FDS, Full Debug Symbols).</p></li>
ihse@2619 922 <li><p><code>zipped</code> is like <code>external</code>, but the .debuginfo file will also be zipped into a <code>.diz</code> file.</p></li>
ihse@2520 923 </ul>
ihse@2619 924 <p>When building for distribution, <code>zipped</code> is a good solution. Binaries built with <code>internal</code> is suitable for use by developers, since they facilitate debugging, but should be stripped before distributed to end users.</p>
ihse@2619 925 <h3 id="autoconf-details">Autoconf Details</h3>
ihse@2619 926 <p>The <code>configure</code> script is based on the autoconf framework, but in some details deviate from a normal autoconf <code>configure</code> script.</p>
ihse@2619 927 <p>The <code>configure</code> script in the top level directory of OpenJDK is just a thin wrapper that calls <code>common/autoconf/configure</code>. This in turn provides functionality that is not easily expressed in the normal Autoconf framework, and then calls into the core of the <code>configure</code> script, which is the <code>common/autoconf/generated-configure.sh</code> file.</p>
ihse@2619 928 <p>As the name implies, this file is generated by Autoconf. It is checked in after regeneration, to alleviate the common user to have to install Autoconf.</p>
ihse@2619 929 <p>The build system will detect if the Autoconf source files have changed, and will trigger a regeneration of <code>common/autoconf/generated-configure.sh</code> if needed. You can also manually request such an update by <code>bash common/autoconf/autogen.sh</code>.</p>
ihse@2619 930 <p>If you make changes to the build system that requires a re-generation, note the following:</p>
ihse@2520 931 <ul>
ihse@2619 932 <li><p>You must use <em>exactly</em> version 2.69 of autoconf for your patch to be accepted. This is to avoid spurious changes in the generated file. Note that Ubuntu 16.04 ships a patched version of autoconf which claims to be 2.69, but is not.</p></li>
ihse@2619 933 <li><p>You do not need to include the generated file in reviews.</p></li>
ihse@2619 934 <li><p>If the generated file needs updating, the Oracle JDK closed counter-part will also need to be updated. It is very much appreciated if you ask for an Oracle engineer to sponsor your push so this can be made in tandem.</p></li>
ihse@1680 935 </ul>
ihse@2619 936 <h3 id="developing-the-build-system-itself">Developing the Build System Itself</h3>
ihse@2619 937 <p>This section contains a few remarks about how to develop for the build system itself. It is not relevant if you are only making changes in the product source code.</p>
ihse@2619 938 <p>While technically using <code>make</code>, the make source files of the OpenJDK does not resemble most other Makefiles. Instead of listing specific targets and actions (perhaps using patterns), the basic modus operandi is to call a high-level function (or properly, macro) from the API in <code>make/common</code>. For instance, to compile all classes in the <code>jdk.internal.foo</code> package in the <code>jdk.foo</code> module, a call like this would be made:</p>
ihse@2619 939 <pre><code>$(eval $(call SetupJavaCompilation, BUILD_FOO_CLASSES, \
ihse@2619 940 SETUP := GENERATE_OLDBYTECODE, \
ihse@2619 941 SRC := $(JDK_TOPDIR)/src/jkd.foo/share/classes, \
ihse@2619 942 INCLUDES := jdk/internal/foo, \
ihse@2619 943 BIN := $(SUPPORT_OUTPUTDIR)/foo_classes, \
ihse@2619 944 ))</code></pre>
ihse@2619 945 <p>By encapsulating and expressing the high-level knowledge of <em>what</em> should be done, rather than <em>how</em> it should be done (as is normal in Makefiles), we can build a much more powerful and flexible build system.</p>
ihse@2619 946 <p>Correct dependency tracking is paramount. Sloppy dependency tracking will lead to improper parallelization, or worse, race conditions.</p>
ihse@2619 947 <p>To test for/debug race conditions, try running <code>make JOBS=1</code> and <code>make JOBS=100</code> and see if it makes any difference. (It shouldn't).</p>
ihse@2619 948 <p>To compare the output of two different builds and see if, and how, they differ, run <code>$BUILD1/compare.sh -o $BUILD2</code>, where <code>$BUILD1</code> and <code>$BUILD2</code> are the two builds you want to compare.</p>
ihse@2619 949 <p>To automatically build two consecutive versions and compare them, use <code>COMPARE_BUILD</code>. The value of <code>COMPARE_BUILD</code> is a set of variable=value assignments, like this:</p>
ihse@2619 950 <pre><code>make COMPARE_BUILD=CONF=--enable-new-hotspot-feature:MAKE=hotspot</code></pre>
ihse@2619 951 <p>See <code>make/InitSupport.gmk</code> for details on how to use <code>COMPARE_BUILD</code>.</p>
ihse@2619 952 <p>To analyze build performance, run with <code>LOG=trace</code> and check <code>$BUILD/build-trace-time.log</code>. Use <code>JOBS=1</code> to avoid parallelism.</p>
ihse@2619 953 <p>Please check that you adhere to the <a href="http://openjdk.java.net/groups/build/doc/code-conventions.html">Code Conventions for the Build System</a> before submitting patches. Also see the section in <a href="#autoconf-details">Autoconf Details</a> about the generated configure script.</p>
ihse@2619 954 <h2 id="contributing-to-openjdk">Contributing to OpenJDK</h2>
ihse@2619 955 <p>So, now you've build your OpenJDK, and made your first patch, and want to contribute it back to the OpenJDK community.</p>
ihse@2619 956 <p>First of all: Thank you! We gladly welcome your contribution to the OpenJDK. However, please bear in mind that OpenJDK is a massive project, and we must ask you to follow our rules and guidelines to be able to accept your contribution.</p>
ihse@2619 957 <p>The official place to start is the <a href="http://openjdk.java.net/contribute/">'How to contribute' page</a>. There is also an official (but somewhat outdated and skimpy on details) <a href="http://openjdk.java.net/guide/">Developer's Guide</a>.</p>
ihse@2619 958 <p>If this seems overwhelming to you, the Adoption Group is there to help you! A good place to start is their <a href="https://wiki.openjdk.java.net/display/Adoption/New+Contributor">'New Contributor' page</a>, or start reading the comprehensive <a href="https://adoptopenjdk.gitbooks.io/adoptopenjdk-getting-started-kit/en/">Getting Started Kit</a>. The Adoption Group will also happily answer any questions you have about contributing. Contact them by <a href="http://mail.openjdk.java.net/mailman/listinfo/adoption-discuss">mail</a> or <a href="http://openjdk.java.net/irc/">IRC</a>.</p>
ihse@2520 959 </body>
ohair@11 960 </html>