doc/building.html
author erikj
Wed, 06 Jun 2018 13:16:12 -0700
changeset 50490 cbae0e359538
parent 50267 1582de22e3a1
child 50586 4bba6dea2e73
permissions -rw-r--r--
8200132: Remove jre images and bundles Reviewed-by: alanb, ihse
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
45227
97be1bcd7b25 8180472: Pandoc should generate html5 from markdown
ihse
parents: 45103
diff changeset
     1
<!DOCTYPE html>
97be1bcd7b25 8180472: Pandoc should generate html5 from markdown
ihse
parents: 45103
diff changeset
     2
<html>
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
     3
<head>
45227
97be1bcd7b25 8180472: Pandoc should generate html5 from markdown
ihse
parents: 45103
diff changeset
     4
  <meta charset="utf-8">
97be1bcd7b25 8180472: Pandoc should generate html5 from markdown
ihse
parents: 45103
diff changeset
     5
  <meta name="generator" content="pandoc">
97be1bcd7b25 8180472: Pandoc should generate html5 from markdown
ihse
parents: 45103
diff changeset
     6
  <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
45763
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
     7
  <title>Building OpenJDK</title>
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
     8
  <style type="text/css">code{white-space: pre;}</style>
47217
72e3ae9a25eb 8187444: Forest Consolidation: Make build work
erikj
parents: 47216
diff changeset
     9
  <link rel="stylesheet" href="../make/data/docs-resources/resources/jdk-default.css">
45227
97be1bcd7b25 8180472: Pandoc should generate html5 from markdown
ihse
parents: 45103
diff changeset
    10
  <!--[if lt IE 9]>
97be1bcd7b25 8180472: Pandoc should generate html5 from markdown
ihse
parents: 45103
diff changeset
    11
    <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
97be1bcd7b25 8180472: Pandoc should generate html5 from markdown
ihse
parents: 45103
diff changeset
    12
  <![endif]-->
45763
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    13
  <style type="text/css">pre, code, tt { color: #1d6ae5; }</style>
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
    14
</head>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
    15
<body>
45227
97be1bcd7b25 8180472: Pandoc should generate html5 from markdown
ihse
parents: 45103
diff changeset
    16
<header>
45763
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    17
<h1 class="title">Building OpenJDK</h1>
45227
97be1bcd7b25 8180472: Pandoc should generate html5 from markdown
ihse
parents: 45103
diff changeset
    18
</header>
45763
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    19
<nav id="TOC">
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
    20
<ul>
45763
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    21
<li><a href="#tldr-instructions-for-the-impatient">TL;DR (Instructions for the Impatient)</a></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    22
<li><a href="#introduction">Introduction</a></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    23
<li><a href="#getting-the-source-code">Getting the Source Code</a><ul>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    24
<li><a href="#special-considerations">Special Considerations</a></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    25
</ul></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    26
<li><a href="#build-hardware-requirements">Build Hardware Requirements</a><ul>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    27
<li><a href="#building-on-x86">Building on x86</a></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    28
<li><a href="#building-on-sparc">Building on sparc</a></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    29
<li><a href="#building-on-armaarch64">Building on arm/aarch64</a></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    30
</ul></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    31
<li><a href="#operating-system-requirements">Operating System Requirements</a><ul>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    32
<li><a href="#windows">Windows</a></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    33
<li><a href="#solaris">Solaris</a></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    34
<li><a href="#macos">macOS</a></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    35
<li><a href="#linux">Linux</a></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    36
<li><a href="#aix">AIX</a></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    37
</ul></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    38
<li><a href="#native-compiler-toolchain-requirements">Native Compiler (Toolchain) Requirements</a><ul>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    39
<li><a href="#gcc">gcc</a></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    40
<li><a href="#clang">clang</a></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    41
<li><a href="#apple-xcode">Apple Xcode</a></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    42
<li><a href="#oracle-solaris-studio">Oracle Solaris Studio</a></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    43
<li><a href="#microsoft-visual-studio">Microsoft Visual Studio</a></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    44
<li><a href="#ibm-xl-cc">IBM XL C/C++</a></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    45
</ul></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    46
<li><a href="#boot-jdk-requirements">Boot JDK Requirements</a><ul>
49159
436f1e03fd04 8199266: Update boot and build jdk requirements in configure
erikj
parents: 48743
diff changeset
    47
<li><a href="#getting-jdk-binaries">Getting JDK binaries</a></li>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
    48
</ul></li>
45763
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    49
<li><a href="#external-library-requirements">External Library Requirements</a><ul>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    50
<li><a href="#freetype">FreeType</a></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    51
<li><a href="#cups">CUPS</a></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    52
<li><a href="#x11">X11</a></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    53
<li><a href="#alsa">ALSA</a></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    54
<li><a href="#libffi">libffi</a></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    55
</ul></li>
48743
ba52fa7bbf14 8195689: Remove generated-configure.sh and instead use autoconf
ihse
parents: 47928
diff changeset
    56
<li><a href="#build-tools-requirements">Build Tools Requirements</a><ul>
ba52fa7bbf14 8195689: Remove generated-configure.sh and instead use autoconf
ihse
parents: 47928
diff changeset
    57
<li><a href="#autoconf">Autoconf</a></li>
45763
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    58
<li><a href="#gnu-make">GNU Make</a></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    59
<li><a href="#gnu-bash">GNU Bash</a></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    60
</ul></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    61
<li><a href="#running-configure">Running Configure</a><ul>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    62
<li><a href="#common-configure-arguments">Common Configure Arguments</a></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    63
<li><a href="#configure-control-variables">Configure Control Variables</a></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    64
</ul></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    65
<li><a href="#running-make">Running Make</a><ul>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    66
<li><a href="#common-make-targets">Common Make Targets</a></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    67
<li><a href="#make-control-variables">Make Control Variables</a></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    68
</ul></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    69
<li><a href="#running-tests">Running Tests</a></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    70
<li><a href="#cross-compiling">Cross-compiling</a><ul>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    71
<li><a href="#boot-jdk-and-build-jdk">Boot JDK and Build JDK</a></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    72
<li><a href="#specifying-the-target-platform">Specifying the Target Platform</a></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    73
<li><a href="#toolchain-considerations">Toolchain Considerations</a></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    74
<li><a href="#native-libraries">Native Libraries</a></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    75
<li><a href="#building-for-armaarch64">Building for ARM/aarch64</a></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    76
<li><a href="#verifying-the-build">Verifying the Build</a></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    77
</ul></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    78
<li><a href="#build-performance">Build Performance</a><ul>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    79
<li><a href="#disk-speed">Disk Speed</a></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    80
<li><a href="#virus-checking">Virus Checking</a></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    81
<li><a href="#ccache">Ccache</a></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    82
<li><a href="#precompiled-headers">Precompiled Headers</a></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    83
<li><a href="#icecc-icecream">Icecc / icecream</a></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    84
<li><a href="#using-sjavac">Using sjavac</a></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    85
<li><a href="#building-the-right-target">Building the Right Target</a></li>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
    86
</ul></li>
45763
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    87
<li><a href="#troubleshooting">Troubleshooting</a><ul>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    88
<li><a href="#locating-the-source-of-the-error">Locating the Source of the Error</a></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    89
<li><a href="#fixing-unexpected-build-failures">Fixing Unexpected Build Failures</a></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    90
<li><a href="#specific-build-issues">Specific Build Issues</a></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    91
<li><a href="#getting-help">Getting Help</a></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    92
</ul></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    93
<li><a href="#hints-and-suggestions-for-advanced-users">Hints and Suggestions for Advanced Users</a><ul>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    94
<li><a href="#setting-up-a-forest-for-pushing-changes-defpath">Setting Up a Forest for Pushing Changes (defpath)</a></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    95
<li><a href="#bash-completion">Bash Completion</a></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    96
<li><a href="#using-multiple-configurations">Using Multiple Configurations</a></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    97
<li><a href="#handling-reconfigurations">Handling Reconfigurations</a></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    98
<li><a href="#using-fine-grained-make-targets">Using Fine-Grained Make Targets</a></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
    99
<li><a href="#learn-about-mercurial">Learn About Mercurial</a></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   100
</ul></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   101
<li><a href="#understanding-the-build-system">Understanding the Build System</a><ul>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   102
<li><a href="#configurations">Configurations</a></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   103
<li><a href="#build-output-structure">Build Output Structure</a></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   104
<li><a href="#fixpath">Fixpath</a></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   105
<li><a href="#native-debug-symbols">Native Debug Symbols</a></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   106
<li><a href="#autoconf-details">Autoconf Details</a></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   107
<li><a href="#developing-the-build-system-itself">Developing the Build System Itself</a></li>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   108
</ul></li>
45763
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   109
<li><a href="#contributing-to-openjdk">Contributing to OpenJDK</a></li>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   110
</ul>
45763
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   111
</nav>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   112
<h2 id="tldr-instructions-for-the-impatient">TL;DR (Instructions for the Impatient)</h2>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   113
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   114
<ol type="1">
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   115
<li><p><a href="#getting-the-source-code">Get the complete source code</a>:<br />
48743
ba52fa7bbf14 8195689: Remove generated-configure.sh and instead use autoconf
ihse
parents: 47928
diff changeset
   116
<code>hg clone http://hg.openjdk.java.net/jdk/jdk</code></p></li>
45763
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   117
<li><p><a href="#running-configure">Run configure</a>:<br />
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   118
<code>bash configure</code></p>
48743
ba52fa7bbf14 8195689: Remove generated-configure.sh and instead use autoconf
ihse
parents: 47928
diff changeset
   119
<p>If <code>configure</code> fails due to missing dependencies (to either the <a href="#native-compiler-toolchain-requirements">toolchain</a>, <a href="#build-tools-requirements">build tools</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>
45763
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   120
<li><p><a href="#running-make">Run make</a>:<br />
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   121
<code>make images</code></p></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   122
<li><p>Verify your newly built JDK:<br />
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   123
<code>./build/*/images/jdk/bin/java -version</code></p></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   124
<li><p><a href="##running-tests">Run basic tests</a>:<br />
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   125
<code>make run-test-tier1</code></p></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   126
</ol>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   127
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   128
<h2 id="introduction">Introduction</h2>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   129
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   130
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   131
<h2 id="getting-the-source-code">Getting the Source Code</h2>
47217
72e3ae9a25eb 8187444: Forest Consolidation: Make build work
erikj
parents: 47216
diff changeset
   132
<p>Make sure you are getting the correct version. As of JDK 10, the source is no longer split into separate repositories so you only need to clone one single repository. 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>
45763
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   133
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   134
<h3 id="special-considerations">Special Considerations</h3>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   135
<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>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   136
<ul>
45763
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   137
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   138
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   139
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   140
<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>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   141
<ul>
45763
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   142
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   143
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   144
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   145
</ul>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   146
<p>Failure to follow this procedure might result in hard-to-debug build problems.</p></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   147
</ul>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   148
<h2 id="build-hardware-requirements">Build Hardware Requirements</h2>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   149
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   150
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   151
<h3 id="building-on-x86">Building on x86</h3>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   152
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   153
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   154
<h3 id="building-on-sparc">Building on sparc</h3>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   155
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   156
<h3 id="building-on-armaarch64">Building on arm/aarch64</h3>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   157
<p>This is not recommended. Instead, see the section on <a href="#cross-compiling">Cross-compiling</a>.</p>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   158
<h2 id="operating-system-requirements">Operating System Requirements</h2>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   159
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   160
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   161
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   162
<table>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   163
<thead>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   164
<tr class="header">
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   165
<th style="text-align: left;">Operating system</th>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   166
<th style="text-align: left;">Vendor/version used</th>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   167
</tr>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   168
</thead>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   169
<tbody>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   170
<tr class="odd">
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   171
<td style="text-align: left;">Linux</td>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   172
<td style="text-align: left;">Oracle Enterprise Linux 6.4 / 7.1 (using kernel 3.8.13)</td>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   173
</tr>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   174
<tr class="even">
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   175
<td style="text-align: left;">Solaris</td>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   176
<td style="text-align: left;">Solaris 11.1 SRU 21.4.1 / 11.2 SRU 5.5</td>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   177
</tr>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   178
<tr class="odd">
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   179
<td style="text-align: left;">macOS</td>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   180
<td style="text-align: left;">Mac OS X 10.9 (Mavericks) / 10.10 (Yosemite)</td>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   181
</tr>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   182
<tr class="even">
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   183
<td style="text-align: left;">Windows</td>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   184
<td style="text-align: left;">Windows Server 2012 R2</td>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   185
</tr>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   186
</tbody>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   187
</table>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   188
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   189
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   190
<h3 id="windows">Windows</h3>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   191
<p>Windows XP is not a supported platform, but all newer Windows should be able to build OpenJDK.</p>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   192
<p>On Windows, it is important that you pay attention to the instructions in the <a href="#special-considerations">Special Considerations</a>.</p>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   193
<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>
49234
3375a8039fde 8193017: Import freetype sources into OpenJDK source tree
prr
parents: 49159
diff changeset
   194
<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-msvcr-dll=/cygdrive/c/msvcr100.dll</code> rather than <code>--with-msvcr-dll=c:\msvcr100.dll</code>. For details on this conversion, see the section on <a href="#fixpath">Fixpath</a>.</p>
45763
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   195
<h4 id="cygwin">Cygwin</h4>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   196
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   197
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   198
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   199
<p>Apart from the basic Cygwin installation, the following packages must also be installed:</p>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   200
<ul>
48743
ba52fa7bbf14 8195689: Remove generated-configure.sh and instead use autoconf
ihse
parents: 47928
diff changeset
   201
<li><code>autoconf</code></li>
45763
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   202
<li><code>make</code></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   203
<li><code>zip</code></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   204
<li><code>unzip</code></li>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   205
</ul>
45763
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   206
<p>Often, you can install these packages using the following command line:</p>
48743
ba52fa7bbf14 8195689: Remove generated-configure.sh and instead use autoconf
ihse
parents: 47928
diff changeset
   207
<pre><code>&lt;path to Cygwin setup&gt;/setup-x86_64 -q -P autoconf -P make -P unzip -P zip</code></pre>
45763
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   208
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   209
<h3 id="solaris">Solaris</h3>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   210
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   211
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   212
<h3 id="macos">macOS</h3>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   213
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   214
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   215
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   216
<h3 id="linux">Linux</h3>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   217
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   218
<p>The basic tooling is provided as part of the core operating system, but you will most likely need to install developer packages.</p>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   219
<p>For apt-based distributions (Debian, Ubuntu, etc), try this:</p>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   220
<pre><code>sudo apt-get install build-essential</code></pre>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   221
<p>For rpm-based distributions (Fedora, Red Hat, etc), try this:</p>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   222
<pre><code>sudo yum groupinstall &quot;Development Tools&quot;</code></pre>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   223
<h3 id="aix">AIX</h3>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   224
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   225
<h2 id="native-compiler-toolchain-requirements">Native Compiler (Toolchain) Requirements</h2>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   226
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   227
<table>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   228
<thead>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   229
<tr class="header">
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   230
<th style="text-align: left;">Operating system</th>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   231
<th style="text-align: left;">Supported toolchain</th>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   232
</tr>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   233
</thead>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   234
<tbody>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   235
<tr class="odd">
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   236
<td style="text-align: left;">Linux</td>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   237
<td style="text-align: left;">gcc, clang</td>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   238
</tr>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   239
<tr class="even">
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   240
<td style="text-align: left;">macOS</td>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   241
<td style="text-align: left;">Apple Xcode (using clang)</td>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   242
</tr>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   243
<tr class="odd">
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   244
<td style="text-align: left;">Solaris</td>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   245
<td style="text-align: left;">Oracle Solaris Studio</td>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   246
</tr>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   247
<tr class="even">
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   248
<td style="text-align: left;">AIX</td>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   249
<td style="text-align: left;">IBM XL C/C++</td>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   250
</tr>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   251
<tr class="odd">
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   252
<td style="text-align: left;">Windows</td>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   253
<td style="text-align: left;">Microsoft Visual Studio</td>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   254
</tr>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   255
</tbody>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   256
</table>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   257
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   258
<table>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   259
<thead>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   260
<tr class="header">
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   261
<th style="text-align: left;">Operating system</th>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   262
<th style="text-align: left;">Toolchain version</th>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   263
</tr>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   264
</thead>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   265
<tbody>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   266
<tr class="odd">
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   267
<td style="text-align: left;">Linux</td>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   268
<td style="text-align: left;">gcc 4.9.2</td>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   269
</tr>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   270
<tr class="even">
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   271
<td style="text-align: left;">macOS</td>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   272
<td style="text-align: left;">Apple Xcode 6.3 (using clang 6.1.0)</td>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   273
</tr>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   274
<tr class="odd">
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   275
<td style="text-align: left;">Solaris</td>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   276
<td style="text-align: left;">Oracle Solaris Studio 12.4 (with compiler version 5.13)</td>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   277
</tr>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   278
<tr class="even">
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   279
<td style="text-align: left;">Windows</td>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   280
<td style="text-align: left;">Microsoft Visual Studio 2013 update 4</td>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   281
</tr>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   282
</tbody>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   283
</table>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   284
<h3 id="gcc">gcc</h3>
47217
72e3ae9a25eb 8187444: Forest Consolidation: Make build work
erikj
parents: 47216
diff changeset
   285
<p>The minimum accepted version of gcc is 4.7. Older versions will generate a warning by <code>configure</code> and are unlikely to work.</p>
45763
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   286
<p>OpenJDK 9 includes patches that should allow gcc 6 to compile, but this should be considered experimental.</p>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   287
<p>In general, any version between these two should be usable.</p>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   288
<h3 id="clang">clang</h3>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   289
<p>The minimum accepted version of clang is 3.2. Older versions will not be accepted by <code>configure</code>.</p>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   290
<p>To use clang instead of gcc on Linux, use <code>--with-toolchain-type=clang</code>.</p>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   291
<h3 id="apple-xcode">Apple Xcode</h3>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   292
<p>The oldest supported version of Xcode is 5.</p>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   293
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   294
<pre><code>xcode-select --install</code></pre>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   295
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   296
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   297
<h3 id="oracle-solaris-studio">Oracle Solaris Studio</h3>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   298
<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>
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   299
<p>The Solaris Studio installation should contain at least these packages:</p>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   300
<table>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   301
<thead>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   302
<tr class="header">
45227
97be1bcd7b25 8180472: Pandoc should generate html5 from markdown
ihse
parents: 45103
diff changeset
   303
<th style="text-align: left;">Package</th>
97be1bcd7b25 8180472: Pandoc should generate html5 from markdown
ihse
parents: 45103
diff changeset
   304
<th style="text-align: left;">Version</th>
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   305
</tr>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   306
</thead>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   307
<tbody>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   308
<tr class="odd">
45227
97be1bcd7b25 8180472: Pandoc should generate html5 from markdown
ihse
parents: 45103
diff changeset
   309
<td style="text-align: left;">developer/solarisstudio-124/backend</td>
97be1bcd7b25 8180472: Pandoc should generate html5 from markdown
ihse
parents: 45103
diff changeset
   310
<td style="text-align: left;">12.4-1.0.6.0</td>
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   311
</tr>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   312
<tr class="even">
45227
97be1bcd7b25 8180472: Pandoc should generate html5 from markdown
ihse
parents: 45103
diff changeset
   313
<td style="text-align: left;">developer/solarisstudio-124/c++</td>
97be1bcd7b25 8180472: Pandoc should generate html5 from markdown
ihse
parents: 45103
diff changeset
   314
<td style="text-align: left;">12.4-1.0.10.0</td>
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   315
</tr>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   316
<tr class="odd">
45227
97be1bcd7b25 8180472: Pandoc should generate html5 from markdown
ihse
parents: 45103
diff changeset
   317
<td style="text-align: left;">developer/solarisstudio-124/cc</td>
97be1bcd7b25 8180472: Pandoc should generate html5 from markdown
ihse
parents: 45103
diff changeset
   318
<td style="text-align: left;">12.4-1.0.4.0</td>
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   319
</tr>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   320
<tr class="even">
45227
97be1bcd7b25 8180472: Pandoc should generate html5 from markdown
ihse
parents: 45103
diff changeset
   321
<td style="text-align: left;">developer/solarisstudio-124/library/c++-libs</td>
97be1bcd7b25 8180472: Pandoc should generate html5 from markdown
ihse
parents: 45103
diff changeset
   322
<td style="text-align: left;">12.4-1.0.10.0</td>
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   323
</tr>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   324
<tr class="odd">
45227
97be1bcd7b25 8180472: Pandoc should generate html5 from markdown
ihse
parents: 45103
diff changeset
   325
<td style="text-align: left;">developer/solarisstudio-124/library/math-libs</td>
97be1bcd7b25 8180472: Pandoc should generate html5 from markdown
ihse
parents: 45103
diff changeset
   326
<td style="text-align: left;">12.4-1.0.0.1</td>
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   327
</tr>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   328
<tr class="even">
45227
97be1bcd7b25 8180472: Pandoc should generate html5 from markdown
ihse
parents: 45103
diff changeset
   329
<td style="text-align: left;">developer/solarisstudio-124/library/studio-gccrt</td>
97be1bcd7b25 8180472: Pandoc should generate html5 from markdown
ihse
parents: 45103
diff changeset
   330
<td style="text-align: left;">12.4-1.0.0.1</td>
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   331
</tr>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   332
<tr class="odd">
45227
97be1bcd7b25 8180472: Pandoc should generate html5 from markdown
ihse
parents: 45103
diff changeset
   333
<td style="text-align: left;">developer/solarisstudio-124/studio-common</td>
97be1bcd7b25 8180472: Pandoc should generate html5 from markdown
ihse
parents: 45103
diff changeset
   334
<td style="text-align: left;">12.4-1.0.0.1</td>
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   335
</tr>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   336
<tr class="even">
45227
97be1bcd7b25 8180472: Pandoc should generate html5 from markdown
ihse
parents: 45103
diff changeset
   337
<td style="text-align: left;">developer/solarisstudio-124/studio-ja</td>
97be1bcd7b25 8180472: Pandoc should generate html5 from markdown
ihse
parents: 45103
diff changeset
   338
<td style="text-align: left;">12.4-1.0.0.1</td>
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   339
</tr>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   340
<tr class="odd">
45227
97be1bcd7b25 8180472: Pandoc should generate html5 from markdown
ihse
parents: 45103
diff changeset
   341
<td style="text-align: left;">developer/solarisstudio-124/studio-legal</td>
97be1bcd7b25 8180472: Pandoc should generate html5 from markdown
ihse
parents: 45103
diff changeset
   342
<td style="text-align: left;">12.4-1.0.0.1</td>
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   343
</tr>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   344
<tr class="even">
45227
97be1bcd7b25 8180472: Pandoc should generate html5 from markdown
ihse
parents: 45103
diff changeset
   345
<td style="text-align: left;">developer/solarisstudio-124/studio-zhCN</td>
97be1bcd7b25 8180472: Pandoc should generate html5 from markdown
ihse
parents: 45103
diff changeset
   346
<td style="text-align: left;">12.4-1.0.0.1</td>
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   347
</tr>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   348
</tbody>
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   349
</table>
45763
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   350
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   351
<pre><code>$ cc -V
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   352
cc: Sun C 5.13 SunOS_i386 2014/10/20
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   353
$ CC -V
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   354
CC: Sun C++ 5.13 SunOS_i386 151846-10 2015/10/30</code></pre>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   355
<h3 id="microsoft-visual-studio">Microsoft Visual Studio</h3>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   356
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   357
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   358
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   359
<h3 id="ibm-xl-cc">IBM XL C/C++</h3>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   360
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   361
<p>See the <a href="http://cr.openjdk.java.net/~simonis/ppc-aix-port">OpenJDK PowerPC Port Status Page</a> for details.</p>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   362
<h2 id="boot-jdk-requirements">Boot JDK Requirements</h2>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   363
<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>
49159
436f1e03fd04 8199266: Update boot and build jdk requirements in configure
erikj
parents: 48743
diff changeset
   364
<p>The rule of thumb is that the boot JDK for building JDK major version <em>N</em> should be a 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've got the latest update version, since JDK 8 GA might not be able to build JDK 9 on all platforms.</p>
436f1e03fd04 8199266: Update boot and build jdk requirements in configure
erikj
parents: 48743
diff changeset
   365
<p>Early in the release cycle, version <em>N-1</em> may not yet have been released. In that case, the preferred boot JDK will be version <em>N-2</em> until version <em>N-1</em> is available.</p>
45763
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   366
<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>
49159
436f1e03fd04 8199266: Update boot and build jdk requirements in configure
erikj
parents: 48743
diff changeset
   367
<h3 id="getting-jdk-binaries">Getting JDK binaries</h3>
436f1e03fd04 8199266: Update boot and build jdk requirements in configure
erikj
parents: 48743
diff changeset
   368
<p>OpenJDK binaries for Linux, Windows and macOS can be downloaded from <a href="http://jdk.java.net">jdk.java.net</a>. 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 various platforms.</p>
436f1e03fd04 8199266: Update boot and build jdk requirements in configure
erikj
parents: 48743
diff changeset
   369
<p>On Linux you can also get OpenJDK from the Linux distribution. On apt-based distros (like Debian and Ubuntu), <code>sudo apt-get install openjdk-&lt;VERSION&gt;-jdk</code> is typically enough to install OpenJDK &lt;VERSION&gt;. On rpm-based distros (like Fedora and Red Hat), try <code>sudo yum install java-&lt;VERSION&gt;-openjdk-devel</code>.</p>
45763
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   370
<h2 id="external-library-requirements">External Library Requirements</h2>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   371
<p>Different platforms require different external libraries. In general, libraries are not optional - that is, they are either required or not used.</p>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   372
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   373
<p>As a fallback, the second version allows you to point to the include directory and the lib directory separately.</p>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   374
<h3 id="freetype">FreeType</h3>
49234
3375a8039fde 8193017: Import freetype sources into OpenJDK source tree
prr
parents: 49159
diff changeset
   375
<p>FreeType2 from <a href="http://www.freetype.org/">The FreeType Project</a> is not required on any platform. The exception is on Unix-based platforms when configuring such that the build artifacts will reference a system installed library, rather than bundling OpenJDK's own copy.</p>
45763
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   376
<ul>
49234
3375a8039fde 8193017: Import freetype sources into OpenJDK source tree
prr
parents: 49159
diff changeset
   377
<li>To install on an apt-based Linux, try running <code>sudo apt-get install libfreetype6-dev</code>.</li>
3375a8039fde 8193017: Import freetype sources into OpenJDK source tree
prr
parents: 49159
diff changeset
   378
<li>To install on an rpm-based Linux, try running <code>sudo yum install freetype-devel</code>.</li>
45763
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   379
<li>To install on Solaris, try running <code>pkg install system/library/freetype-2</code>.</li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   380
</ul>
49234
3375a8039fde 8193017: Import freetype sources into OpenJDK source tree
prr
parents: 49159
diff changeset
   381
<p>Use <code>--with-freetype-include=&lt;path&gt;</code> and <code>--with-freetype-lib=&lt;path&gt;</code> if <code>configure</code> does not automatically locate the platform FreeType files.</p>
45763
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   382
<h3 id="cups">CUPS</h3>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   383
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   384
<ul>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   385
<li>To install on an apt-based Linux, try running <code>sudo apt-get install libcups2-dev</code>.</li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   386
<li>To install on an rpm-based Linux, try running <code>sudo yum install cups-devel</code>.</li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   387
<li>To install on Solaris, try running <code>pkg install print/cups</code>.</li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   388
</ul>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   389
<p>Use <code>--with-cups=&lt;path&gt;</code> if <code>configure</code> does not properly locate your CUPS files.</p>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   390
<h3 id="x11">X11</h3>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   391
<p>Certain <a href="http://www.x.org/">X11</a> libraries and include files are required on Linux and Solaris.</p>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   392
<ul>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   393
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   394
<li>To install on an rpm-based Linux, try running <code>sudo yum install libXtst-devel libXt-devel libXrender-devel libXi-devel</code>.</li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   395
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   396
</ul>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   397
<p>Use <code>--with-x=&lt;path&gt;</code> if <code>configure</code> does not properly locate your X11 files.</p>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   398
<h3 id="alsa">ALSA</h3>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   399
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   400
<ul>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   401
<li>To install on an apt-based Linux, try running <code>sudo apt-get install libasound2-dev</code>.</li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   402
<li>To install on an rpm-based Linux, try running <code>sudo yum install alsa-lib-devel</code>.</li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   403
</ul>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   404
<p>Use <code>--with-alsa=&lt;path&gt;</code> if <code>configure</code> does not properly locate your ALSA files.</p>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   405
<h3 id="libffi">libffi</h3>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   406
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   407
<ul>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   408
<li>To install on an apt-based Linux, try running <code>sudo apt-get install libffi-dev</code>.</li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   409
<li>To install on an rpm-based Linux, try running <code>sudo yum install libffi-devel</code>.</li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   410
</ul>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   411
<p>Use <code>--with-libffi=&lt;path&gt;</code> if <code>configure</code> does not properly locate your libffi files.</p>
48743
ba52fa7bbf14 8195689: Remove generated-configure.sh and instead use autoconf
ihse
parents: 47928
diff changeset
   412
<h2 id="build-tools-requirements">Build Tools Requirements</h2>
ba52fa7bbf14 8195689: Remove generated-configure.sh and instead use autoconf
ihse
parents: 47928
diff changeset
   413
<h3 id="autoconf">Autoconf</h3>
ba52fa7bbf14 8195689: Remove generated-configure.sh and instead use autoconf
ihse
parents: 47928
diff changeset
   414
<p>OpenJDK requires <a href="http://www.gnu.org/software/autoconf">Autoconf</a> on all platforms. At least version 2.69 is required.</p>
ba52fa7bbf14 8195689: Remove generated-configure.sh and instead use autoconf
ihse
parents: 47928
diff changeset
   415
<ul>
ba52fa7bbf14 8195689: Remove generated-configure.sh and instead use autoconf
ihse
parents: 47928
diff changeset
   416
<li>To install on an apt-based Linux, try running <code>sudo apt-get install autoconf</code>.</li>
ba52fa7bbf14 8195689: Remove generated-configure.sh and instead use autoconf
ihse
parents: 47928
diff changeset
   417
<li>To install on an rpm-based Linux, try running <code>sudo yum install autoconf</code>.</li>
ba52fa7bbf14 8195689: Remove generated-configure.sh and instead use autoconf
ihse
parents: 47928
diff changeset
   418
<li>To install on macOS, try running <code>brew install autoconf</code>.</li>
ba52fa7bbf14 8195689: Remove generated-configure.sh and instead use autoconf
ihse
parents: 47928
diff changeset
   419
<li>To install on Windows, try running <code>&lt;path to Cygwin setup&gt;/setup-x86_64 -q -P autoconf</code>.</li>
ba52fa7bbf14 8195689: Remove generated-configure.sh and instead use autoconf
ihse
parents: 47928
diff changeset
   420
</ul>
ba52fa7bbf14 8195689: Remove generated-configure.sh and instead use autoconf
ihse
parents: 47928
diff changeset
   421
<p>If <code>configure</code> has problems locating your installation of autoconf, you can specify it using the <code>AUTOCONF</code> environment variable, like this:</p>
ba52fa7bbf14 8195689: Remove generated-configure.sh and instead use autoconf
ihse
parents: 47928
diff changeset
   422
<pre><code>AUTOCONF=&lt;path to autoconf&gt; configure ...</code></pre>
45763
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   423
<h3 id="gnu-make">GNU Make</h3>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   424
<p>OpenJDK requires <a href="http://www.gnu.org/software/make">GNU Make</a>. No other flavors of make are supported.</p>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   425
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   426
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   427
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   428
<p>On Solaris, it is common to call the GNU version of make by using <code>gmake</code>.</p>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   429
<h3 id="gnu-bash">GNU Bash</h3>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   430
<p>OpenJDK requires <a href="http://www.gnu.org/software/bash">GNU Bash</a>. No other shells are supported.</p>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   431
<p>At least version 3.2 of GNU Bash must be used.</p>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   432
<h2 id="running-configure">Running Configure</h2>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   433
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   434
<p>The configuration is created by the <code>configure</code> script. The basic invocation of the <code>configure</code> script looks like this:</p>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   435
<pre><code>bash configure [options]</code></pre>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   436
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   437
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   438
<p>Some command line examples:</p>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   439
<ul>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   440
<li><p>Create a 32-bit build for Windows with FreeType2 in <code>C:\freetype-i586</code>:</p>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   441
<pre><code>bash configure --with-freetype=/cygdrive/c/freetype-i586 --with-target-bits=32</code></pre></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   442
<li><p>Create a debug build with the <code>server</code> JVM and DTrace enabled:</p>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   443
<pre><code>bash configure --enable-debug --with-jvm-variants=server --enable-dtrace</code></pre></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   444
</ul>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   445
<h3 id="common-configure-arguments">Common Configure Arguments</h3>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   446
<p>Here follows some of the most common and important <code>configure</code> argument.</p>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   447
<p>To get up-to-date information on <em>all</em> available <code>configure</code> argument, please run:</p>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   448
<pre><code>bash configure --help</code></pre>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   449
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   450
<h4 id="configure-arguments-for-tailoring-the-build">Configure Arguments for Tailoring the Build</h4>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   451
<ul>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   452
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   453
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   454
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   455
<li><code>--with-version-string=&lt;string&gt;</code> - Specify the version string this build will be identified with.</li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   456
<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>
47687
fb290fd1f9d4 8171853: Remove Shark compiler
rkennke
parents: 47219
diff changeset
   457
<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>custom</code>. Note that not all variants are possible to combine in a single build.</li>
45763
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   458
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   459
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   460
</ul>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   461
<h4 id="configure-arguments-for-native-compilation">Configure Arguments for Native Compilation</h4>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   462
<ul>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   463
<li><code>--with-devkit=&lt;path&gt;</code> - Use this devkit for compilers, tools and resources</li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   464
<li><code>--with-sysroot=&lt;path&gt;</code> - Use this directory as sysroot</li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   465
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   466
<li><code>--with-toolchain-path=&lt;path&gt;[;&lt;path&gt;]</code> - Prepend these directories when searching for toolchain binaries (compilers etc)</li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   467
<li><code>--with-extra-cflags=&lt;flags&gt;</code> - Append these flags when compiling JDK C files</li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   468
<li><code>--with-extra-cxxflags=&lt;flags&gt;</code> - Append these flags when compiling JDK C++ files</li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   469
<li><code>--with-extra-ldflags=&lt;flags&gt;</code> - Append these flags when linking JDK libraries</li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   470
</ul>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   471
<h4 id="configure-arguments-for-external-dependencies">Configure Arguments for External Dependencies</h4>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   472
<ul>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   473
<li><code>--with-boot-jdk=&lt;path&gt;</code> - Set the path to the <a href="#boot-jdk-requirements">Boot JDK</a></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   474
<li><code>--with-freetype=&lt;path&gt;</code> - Set the path to <a href="#freetype">FreeType</a></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   475
<li><code>--with-cups=&lt;path&gt;</code> - Set the path to <a href="#cups">CUPS</a></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   476
<li><code>--with-x=&lt;path&gt;</code> - Set the path to <a href="#x11">X11</a></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   477
<li><code>--with-alsa=&lt;path&gt;</code> - Set the path to <a href="#alsa">ALSA</a></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   478
<li><code>--with-libffi=&lt;path&gt;</code> - Set the path to <a href="#libffi">libffi</a></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   479
<li><code>--with-jtreg=&lt;path&gt;</code> - Set the path to JTReg. See <a href="#running-tests">Running Tests</a></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   480
</ul>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   481
<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>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   482
<ul>
45763
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   483
<li><code>--with-libjpeg=&lt;source&gt;</code> - Use the specified source for libjpeg</li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   484
<li><code>--with-giflib=&lt;source&gt;</code> - Use the specified source for giflib</li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   485
<li><code>--with-libpng=&lt;source&gt;</code> - Use the specified source for libpng</li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   486
<li><code>--with-lcms=&lt;source&gt;</code> - Use the specified source for lcms</li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   487
<li><code>--with-zlib=&lt;source&gt;</code> - Use the specified source for zlib</li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   488
</ul>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   489
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   490
<ul>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   491
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   492
</ul>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   493
<h3 id="configure-control-variables">Configure Control Variables</h3>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   494
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   495
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   496
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   497
<p>If a configure argument exists, use that instead, e.g. use <code>--with-jtreg</code> instead of setting <code>JTREGEXE</code>.</p>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   498
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   499
<h2 id="running-make">Running Make</h2>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   500
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   501
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   502
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   503
<h3 id="common-make-targets">Common Make Targets</h3>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   504
<p>Apart from the default target, here are some common make targets:</p>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   505
<ul>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   506
<li><code>hotspot</code> - Build all of hotspot (but only hotspot)</li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   507
<li><code>hotspot-&lt;variant&gt;</code> - Build just the specified jvm variant</li>
50490
cbae0e359538 8200132: Remove jre images and bundles
erikj
parents: 50267
diff changeset
   508
<li><code>images</code> or <code>product-images</code> - Build the JDK image</li>
45763
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   509
<li><code>docs</code> or <code>docs-image</code> - Build the documentation image</li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   510
<li><code>test-image</code> - Build the test image</li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   511
<li><code>all</code> or <code>all-images</code> - Build all images (product, docs and test)</li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   512
<li><code>bootcycle-images</code> - Build images twice, second time with newly built JDK (good for testing)</li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   513
<li><code>clean</code> - Remove all files generated by make, but not those generated by configure</li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   514
<li><code>dist-clean</code> - Remove all files, including configuration</li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   515
</ul>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   516
<p>Run <code>make help</code> to get an up-to-date list of important make targets and make control variables.</p>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   517
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   518
<ul>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   519
<li><code>&lt;phase&gt;</code> - Build the specified phase and everything it depends on</li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   520
<li><code>&lt;module&gt;</code> - Build the specified module and everything it depends on</li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   521
<li><code>&lt;module&gt;-&lt;phase&gt;</code> - Compile the specified phase for the specified module and everything it depends on</li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   522
</ul>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   523
<p>Similarly, it is possible to clean just a part of the build by creating make targets according to these patterns:</p>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   524
<ul>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   525
<li><code>clean-&lt;outputdir&gt;</code> - Remove the subdir in the output dir with the name</li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   526
<li><code>clean-&lt;phase&gt;</code> - Remove all build results related to a certain build phase</li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   527
<li><code>clean-&lt;module&gt;</code> - Remove all build results related to a certain module</li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   528
<li><code>clean-&lt;module&gt;-&lt;phase&gt;</code> - Remove all build results related to a certain module and phase</li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   529
</ul>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   530
<h3 id="make-control-variables">Make Control Variables</h3>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   531
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   532
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   533
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   534
<h4 id="general-make-control-variables">General Make Control Variables</h4>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   535
<ul>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   536
<li><code>JOBS</code> - Specify the number of jobs to build with. See <a href="#build-performance">Build Performance</a>.</li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   537
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   538
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   539
</ul>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   540
<h4 id="test-make-control-variables">Test Make Control Variables</h4>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   541
<p>These make control variables only make sense when running tests. Please see <a href="testing.html">Testing OpenJDK</a> for details.</p>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   542
<ul>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   543
<li><code>TEST</code></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   544
<li><code>TEST_JOBS</code></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   545
<li><code>JTREG</code></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   546
<li><code>GTEST</code></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   547
</ul>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   548
<h4 id="advanced-make-control-variables">Advanced Make Control Variables</h4>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   549
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   550
<ul>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   551
<li><code>SPEC</code></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   552
<li><code>CONF_CHECK</code></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   553
<li><code>COMPARE_BUILD</code></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   554
<li><code>JDK_FILTER</code></li>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   555
</ul>
45763
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   556
<h2 id="running-tests">Running Tests</h2>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   557
<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>
50267
1582de22e3a1 8198323: testing.md not updated for repository layout change
ihse
parents: 49234
diff changeset
   558
<p>The <a href="https://wiki.openjdk.java.net/display/Adoption">Adoption Group</a> provides recent builds of jtreg <a href="https://adopt-openjdk.ci.cloudbees.com/job/jtreg/lastSuccessfulBuild/artifact">here</a>. Download the latest <code>.tar.gz</code> file, unpack it, and point <code>--with-jtreg</code> to the <code>jtreg</code> directory that you just unpacked.</p>
45763
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   559
<p>To execute the most basic tests (tier 1), use:</p>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   560
<pre><code>make run-test-tier1</code></pre>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   561
<p>For more details on how to run tests, please see the <a href="testing.html">Testing OpenJDK</a> document.</p>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   562
<h2 id="cross-compiling">Cross-compiling</h2>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   563
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   564
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   565
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   566
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   567
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   568
<h3 id="boot-jdk-and-build-jdk">Boot JDK and Build JDK</h3>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   569
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   570
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   571
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   572
<h3 id="specifying-the-target-platform">Specifying the Target Platform</h3>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   573
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   574
<h3 id="toolchain-considerations">Toolchain Considerations</h3>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   575
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   576
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   577
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   578
<p>If you are unsure what toolchain and versions to use, these have been proved working at the time of writing:</p>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   579
<ul>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   580
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   581
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   582
</ul>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   583
<h3 id="native-libraries">Native Libraries</h3>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   584
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   585
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   586
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   587
<h4 id="alsa-1">ALSA</h4>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   588
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   589
<p>Note that alsa is needed even if you only want to build a headless JDK.</p>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   590
<ul>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   591
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   592
<li><p>Install the libraries into the cross-compilation toolchain. For instance:</p>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   593
<pre><code>cd /tools/gcc-linaro-arm-linux-gnueabihf-raspbian-2012.09-20120921_linux/arm-linux-gnueabihf/libc
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   594
dpkg-deb -x /tmp/libasound2_1.0.25-4_armhf.deb .
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   595
dpkg-deb -x /tmp/libasound2-dev_1.0.25-4_armhf.deb .</code></pre></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   596
<li><p>If alsa is not properly detected by <code>configure</code>, you can point it out by <code>--with-alsa</code>.</p></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   597
</ul>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   598
<h4 id="x11-1">X11</h4>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   599
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   600
<p>Note that X11 is needed even if you only want to build a headless JDK.</p>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   601
<ul>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   602
<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:
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   603
<ul>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   604
<li>libxi</li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   605
<li>libxi-dev</li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   606
<li>x11proto-core-dev</li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   607
<li>x11proto-input-dev</li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   608
<li>x11proto-kb-dev</li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   609
<li>x11proto-render-dev</li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   610
<li>x11proto-xext-dev</li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   611
<li>libice-dev</li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   612
<li>libxrender</li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   613
<li>libxrender-dev</li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   614
<li>libsm-dev</li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   615
<li>libxt-dev</li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   616
<li>libx11</li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   617
<li>libx11-dev</li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   618
<li>libxtst</li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   619
<li>libxtst-dev</li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   620
<li>libxext</li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   621
<li>libxext-dev</li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   622
</ul></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   623
<li><p>Install the libraries into the cross-compilation toolchain. For instance:</p>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   624
<pre><code>cd /tools/gcc-linaro-arm-linux-gnueabihf-raspbian-2012.09-20120921_linux/arm-linux-gnueabihf/libc/usr
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   625
mkdir X11R6
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   626
cd X11R6
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   627
for deb in /tmp/target-x11/*.deb ; do dpkg-deb -x $deb . ; done
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   628
mv usr/* .
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   629
cd lib
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   630
cp arm-linux-gnueabihf/* .</code></pre>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   631
<p>You can ignore the following messages. These libraries are not needed to successfully complete a full JDK build.</p>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   632
<pre><code>cp: cannot stat `arm-linux-gnueabihf/libICE.so&#39;: No such file or directory
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   633
cp: cannot stat `arm-linux-gnueabihf/libSM.so&#39;: No such file or directory
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   634
cp: cannot stat `arm-linux-gnueabihf/libXt.so&#39;: No such file or directory</code></pre></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   635
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   636
</ul>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   637
<h3 id="building-for-armaarch64">Building for ARM/aarch64</h3>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   638
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   639
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   640
<h3 id="verifying-the-build">Verifying the Build</h3>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   641
<p>The build will end up in a directory named like <code>build/linux-arm-normal-server-release</code>.</p>
50490
cbae0e359538 8200132: Remove jre images and bundles
erikj
parents: 50267
diff changeset
   642
<p>Inside this build output directory, the <code>images/jdk</code> will contain the newly built JDK, for your <em>target</em> system.</p>
45763
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   643
<p>Copy these folders to your <em>target</em> system. Then you can run e.g. <code>images/jdk/bin/java -version</code>.</p>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   644
<h2 id="build-performance">Build Performance</h2>
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   645
<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>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   646
<ul>
45763
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   647
<li><p><code>--with-num-cores</code> -- number of cores in the build system, e.g. <code>--with-num-cores=8</code>.</p></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   648
<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>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   649
</ul>
45763
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   650
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   651
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   652
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   653
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   654
<h3 id="disk-speed">Disk Speed</h3>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   655
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   656
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   657
<p>As has been stressed elsewhere, do use SSD for source code and build directory, as well as (if possible) the build tools.</p>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   658
<h3 id="virus-checking">Virus Checking</h3>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   659
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   660
<h3 id="ccache">Ccache</h3>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   661
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   662
<h3 id="precompiled-headers">Precompiled Headers</h3>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   663
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   664
<p>You can experiment by disabling precompiled headers using <code>--disable-precompiled-headers</code>.</p>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   665
<h3 id="icecc-icecream">Icecc / icecream</h3>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   666
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   667
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   668
<h3 id="using-sjavac">Using sjavac</h3>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   669
<p>To speed up Java compilation, especially incremental compilations, you can try the experimental sjavac compiler by using <code>--enable-sjavac</code>.</p>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   670
<h3 id="building-the-right-target">Building the Right Target</h3>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   671
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   672
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   673
<h2 id="troubleshooting">Troubleshooting</h2>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   674
<p>If your build fails, it can sometimes be difficult to pinpoint the problem or find a proper solution.</p>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   675
<h3 id="locating-the-source-of-the-error">Locating the Source of the Error</h3>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   676
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   677
<h4 id="build-failure-summary">Build Failure Summary</h4>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   678
<p>To help you, the build system will print a failure summary at the end. It looks like this:</p>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   679
<pre><code>ERROR: Build failed for target &#39;hotspot&#39; in configuration &#39;linux-x64&#39; (exit code 2)
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   680
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   681
=== Output from failing command(s) repeated here ===
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   682
* For target hotspot_variant-server_libjvm_objs_psMemoryPool.o:
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   683
/localhome/hg/jdk9-sandbox/hotspot/src/share/vm/services/psMemoryPool.cpp:1:1: error: &#39;failhere&#39; does not name a type
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   684
   ... (rest of output omitted)
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   685
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   686
* All command lines available in /localhome/hg/jdk9-sandbox/build/linux-x64/make-support/failure-logs.
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   687
=== End of repeated output ===
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   688
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   689
=== Make failed targets repeated here ===
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   690
lib/CompileJvm.gmk:207: recipe for target &#39;/localhome/hg/jdk9-sandbox/build/linux-x64/hotspot/variant-server/libjvm/objs/psMemoryPool.o&#39; failed
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   691
make/Main.gmk:263: recipe for target &#39;hotspot-server-libs&#39; failed
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   692
=== End of repeated output ===
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   693
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   694
Hint: Try searching the build log for the name of the first failed target.
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   695
Hint: If caused by a warning, try configure --disable-warnings-as-errors.</code></pre>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   696
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   697
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   698
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   699
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   700
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   701
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   702
<h4 id="checking-the-build-log-file">Checking the Build Log File</h4>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   703
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   704
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   705
<h3 id="fixing-unexpected-build-failures">Fixing Unexpected Build Failures</h3>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   706
<p>Most of the time, the build will fail due to incorrect changes in the source code.</p>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   707
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   708
<h4 id="problems-with-the-build-environment">Problems with the Build Environment</h4>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   709
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   710
<p>Verify that the summary at the end looks correct. Are you indeed using the Boot JDK and native toolchain that you expect?</p>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   711
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   712
<h4 id="problems-with-incremental-rebuilds">Problems with Incremental Rebuilds</h4>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   713
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   714
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   715
<ol type="1">
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   716
<li><p>Make sure your forest is up-to-date</p>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   717
<p>Run <code>bash get_source.sh</code> to make sure you have the latest version of all repositories.</p></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   718
<li><p>Clean build results</p>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   719
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   720
<li><p>Completely clean the build directory.</p>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   721
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   722
<pre><code>make print-configuration &gt; current-configuration
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   723
make dist-clean
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   724
bash configure $(cat current-configuration)
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   725
make</code></pre></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   726
<li><p>Re-clone the Mercurial forest</p>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   727
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   728
</ol>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   729
<h3 id="specific-build-issues">Specific Build Issues</h3>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   730
<h4 id="clock-skew">Clock Skew</h4>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   731
<p>If you get an error message like this:</p>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   732
<pre><code>File &#39;xxx&#39; has modification time in the future.
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   733
Clock skew detected. Your build may be incomplete.</code></pre>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   734
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   735
<p>If you see these warnings, reset the clock on the build machine, run <code>make clean</code> and restart the build.</p>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   736
<h4 id="out-of-memory-errors">Out of Memory Errors</h4>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   737
<p>On Solaris, you might get an error message like this:</p>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   738
<pre><code>Trouble writing out table to disk</code></pre>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   739
<p>To solve this, increase the amount of swap space on your build machine.</p>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   740
<p>On Windows, you might get error messages like this:</p>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   741
<pre><code>fatal error - couldn&#39;t allocate heap
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   742
cannot create ... Permission denied
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   743
spawn failed</code></pre>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   744
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   745
<h3 id="getting-help">Getting Help</h3>
49159
436f1e03fd04 8199266: Update boot and build jdk requirements in configure
erikj
parents: 48743
diff changeset
   746
<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>
45763
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   747
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   748
<h2 id="hints-and-suggestions-for-advanced-users">Hints and Suggestions for Advanced Users</h2>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   749
<h3 id="setting-up-a-forest-for-pushing-changes-defpath">Setting Up a Forest for Pushing Changes (defpath)</h3>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   750
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   751
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   752
<pre><code>cd ~
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   753
mkdir hg-ext
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   754
cd hg-ext
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   755
hg clone http://hg.openjdk.java.net/code-tools/defpath
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   756
cat &lt;&lt; EOT &gt;&gt; ~/.hgrc
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   757
[extensions]
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   758
defpath=~/hg-ext/defpath/defpath.py
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   759
EOT</code></pre>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   760
<p>You can now setup a proper push path using:</p>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   761
<pre><code>hg defpath -d -u &lt;your OpenJDK username&gt;</code></pre>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   762
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   763
<h3 id="bash-completion">Bash Completion</h3>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   764
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   765
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   766
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   767
<pre><code>cat &lt;&lt; EOT &gt; /tmp/configure
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   768
#!/bin/bash
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   769
if [ \$(pwd) = \$(cd \$(dirname \$0); pwd) ] ; then
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   770
  echo &gt;&amp;2 &quot;Abort: Trying to call configure helper recursively&quot;
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   771
  exit 1
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   772
fi
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   773
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   774
bash \$PWD/configure &quot;\$@&quot;
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   775
EOT
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   776
chmod +x /tmp/configure
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   777
sudo mv /tmp/configure /usr/local/bin</code></pre>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   778
<p>Now <code>configure --en&lt;tab&gt;-dt&lt;tab&gt;</code> will result in <code>configure --enable-dtrace</code>.</p>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   779
<h3 id="using-multiple-configurations">Using Multiple Configurations</h3>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   780
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   781
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   782
<h3 id="handling-reconfigurations">Handling Reconfigurations</h3>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   783
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   784
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   785
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   786
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   787
<h3 id="using-fine-grained-make-targets">Using Fine-Grained Make Targets</h3>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   788
<p>The default behavior for make is to create consistent and correct output, at the expense of build speed, if necessary.</p>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   789
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   790
<h4 id="building-individual-modules">Building Individual Modules</h4>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   791
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   792
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   793
<h4 id="building-individual-module-phases">Building Individual Module Phases</h4>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   794
<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>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   795
<ul>
45763
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   796
<li><code>gensrc</code> (Generate source code to compile)</li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   797
<li><code>gendata</code> (Generate non-source code artifacts)</li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   798
<li><code>copy</code> (Copy resource artifacts)</li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   799
<li><code>java</code> (Compile Java code)</li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   800
<li><code>launchers</code> (Compile native executables)</li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   801
<li><code>libs</code> (Compile native libraries)</li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   802
<li><code>rmic</code> (Run the <code>rmic</code> tool)</li>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   803
</ul>
45763
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   804
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   805
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   806
<h4 id="skipping-the-dependency-check">Skipping the Dependency Check</h4>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   807
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   808
<blockquote>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   809
<p><strong>Note that if used incorrectly, this can lead to a broken build!</strong></p>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   810
</blockquote>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   811
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   812
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   813
<h4 id="rebuilding-part-of-java.base-jdk_filter">Rebuilding Part of java.base (JDK_FILTER)</h4>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   814
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   815
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   816
<h3 id="learn-about-mercurial">Learn About Mercurial</h3>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   817
<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>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   818
<ul>
45763
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   819
<li><a href="http://www.mercurial-scm.org/wiki/GitConcepts">Mercurial for git users</a></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   820
<li><a href="http://www.mercurial-scm.org/wiki/Tutorial">The official Mercurial tutorial</a></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   821
<li><a href="http://hginit.com/">hg init</a></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   822
<li><a href="http://hgbook.red-bean.com/read/">Mercurial: The Definitive Guide</a></li>
33030
de12d9a875ed 8139668: Generate README-build.html from markdown
ihse
parents: 29865
diff changeset
   823
</ul>
45763
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   824
<h2 id="understanding-the-build-system">Understanding the Build System</h2>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   825
<p>This section will give you a more technical description on the details of the build system.</p>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   826
<h3 id="configurations">Configurations</h3>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   827
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   828
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   829
<h3 id="build-output-structure">Build Output Structure</h3>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   830
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   831
<pre><code>buildtools/
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   832
configure-support/
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   833
hotspot/
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   834
images/
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   835
jdk/
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   836
make-support/
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   837
support/
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   838
test-results/
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   839
test-support/</code></pre>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   840
<p>This is what they are used for:</p>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   841
<ul>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   842
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   843
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   844
<li><p><code>test-results</code>: This directory contains the results from running tests.</p></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   845
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   846
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   847
<li><p><code>hotspot</code>: This is an area for intermediate files needed when building hotspot.</p></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   848
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   849
</ul>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   850
<h3 id="fixpath">Fixpath</h3>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   851
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   852
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   853
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   854
<h3 id="native-debug-symbols">Native Debug Symbols</h3>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   855
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   856
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   857
<ul>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   858
<li><p><code>none</code> means that no debug symbols will be generated during the build.</p></li>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   859
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   860
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   861
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   862
</ul>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   863
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   864
<h3 id="autoconf-details">Autoconf Details</h3>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   865
<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>
48743
ba52fa7bbf14 8195689: Remove generated-configure.sh and instead use autoconf
ihse
parents: 47928
diff changeset
   866
<p>The <code>configure</code> script in the top level directory of OpenJDK is just a thin wrapper that calls <code>make/autoconf/configure</code>. This in turn will run <code>autoconf</code> to create the runnable (generated) configure script, as <code>.build/generated-configure.sh</code>. Apart from being responsible for the generation of the runnable script, the <code>configure</code> script also provides functionality that is not easily expressed in the normal Autoconf framework. As part of this functionality, the generated script is called.</p>
ba52fa7bbf14 8195689: Remove generated-configure.sh and instead use autoconf
ihse
parents: 47928
diff changeset
   867
<p>The build system will detect if the Autoconf source files have changed, and will trigger a regeneration of the generated script if needed. You can also manually request such an update by <code>bash configure autogen</code>.</p>
ba52fa7bbf14 8195689: Remove generated-configure.sh and instead use autoconf
ihse
parents: 47928
diff changeset
   868
<p>In previous versions of the OpenJDK, the generated script was checked in at <code>make/autoconf/generated-configure.sh</code>. This is no longer the case.</p>
45763
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   869
<h3 id="developing-the-build-system-itself">Developing the Build System Itself</h3>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   870
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   871
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   872
<pre><code>$(eval $(call SetupJavaCompilation, BUILD_FOO_CLASSES, \
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   873
    SETUP := GENERATE_OLDBYTECODE, \
47219
fd36993f7bf5 8187542: Remove superfluous *_TOPDIR variables
ihse
parents: 47217
diff changeset
   874
    SRC := $(TOPDIR)/src/jkd.foo/share/classes, \
45763
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   875
    INCLUDES := jdk/internal/foo, \
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   876
    BIN := $(SUPPORT_OUTPUTDIR)/foo_classes, \
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   877
))</code></pre>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   878
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   879
<p>Correct dependency tracking is paramount. Sloppy dependency tracking will lead to improper parallelization, or worse, race conditions.</p>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   880
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   881
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   882
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   883
<pre><code>make COMPARE_BUILD=CONF=--enable-new-hotspot-feature:MAKE=hotspot</code></pre>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   884
<p>See <code>make/InitSupport.gmk</code> for details on how to use <code>COMPARE_BUILD</code>.</p>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   885
<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>
48743
ba52fa7bbf14 8195689: Remove generated-configure.sh and instead use autoconf
ihse
parents: 47928
diff changeset
   886
<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.</p>
45763
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   887
<h2 id="contributing-to-openjdk">Contributing to OpenJDK</h2>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   888
<p>So, now you've build your OpenJDK, and made your first patch, and want to contribute it back to the OpenJDK community.</p>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   889
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   890
<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>
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 45227
diff changeset
   891
<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>
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents: 41040
diff changeset
   892
</body>
333
d4540117530e 6563616: Clarify instructions for unpacking openjdk binary "plug"
ohair
parents: 15
diff changeset
   893
</html>