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