1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html>
3 <head>
4 <title>OpenJDK Build README</title>
5 </head>
6 <body style="background-color:aquamarine">
7
8 <!-- ====================================================== -->
9 <table width="100%">
10 <tr>
11 <td align="center">
12 <img alt="OpenJDK"
13 src="http://openjdk.java.net/images/openjdk.png"
14 width=256>
15 </td>
16 </tr>
17 <tr>
18 <td align=center>
19 <h1>OpenJDK Build README</h1>
20 </td>
21 </tr>
22 </table>
23
24 <!-- ====================================================== -->
25 <hr>
26 <h2><a name="introduction">Introduction</a></h2>
27 <blockquote>
28 This README file contains build instructions for the
29 <a href="http://openjdk.java.net" target="_blank">OpenJDK</a>.
30 Building the source code for the
31 OpenJDK
32 requires
33 a certain degree of technical expertise.
34
35 <!-- ====================================================== -->
36 <h3>!!!!!!!!!!!!!!! THIS IS A MAJOR RE-WRITE of this document. !!!!!!!!!!!!!</h3>
37 <blockquote>
38 Some Headlines:
39 <ul>
40 <li>
41 The build is now a "<code>configure && make</code>" style build
42 </li>
43 <li>
44 Any GNU make 3.81 or newer should work
45 </li>
46 <li>
47 The build should scale, i.e. more processors should
48 cause the build to be done in less wall-clock time
49 </li>
50 <li>
51 Nested or recursive make invocations have been significantly
52 reduced, as has the total fork/exec or spawning
53 of sub processes during the build
54 </li>
55 <li>
56 Windows MKS usage is no longer supported
57 </li>
58 <li>
59 Windows Visual Studio <code>vsvars*.bat</code> and
60 <code>vcvars*.bat</code> files are run automatically
61 </li>
62 <li>
63 Ant is no longer used when building the OpenJDK
64 </li>
65 <li>
66 Use of ALT_* environment variables for configuring the
67 build is no longer supported
68 </li>
69 </ul>
70 </blockquote>
71 </blockquote>
72
73 <!-- ====================================================== -->
74 <hr>
75 <h2><a name="contents">Contents</a></h2>
76 <blockquote>
77 <ul>
78 <li><a href="#introduction">Introduction</a></li>
79
80 <li><a href="#hg">Use of Mercurial</a>
81 <ul>
82 <li><a href="#get_source">Getting the Source</a></li>
83 <li><a href="#repositories">Repositories</a></li>
84 </ul>
85 </li>
86
87 <li><a href="#building">Building</a>
88 <ul>
89 <li><a href="#setup">System Setup</a>
90 <ul>
91 <li><a href="#linux">Linux</a></li>
92 <li><a href="#solaris">Solaris</a></li>
93 <li><a href="#macosx">Mac OS X</a></li>
94 <li><a href="#windows">Windows</a></li>
95 </ul>
96 </li>
97 <li><a href="#configure">Configure</a></li>
98 <li><a href="#make">Make</a></li>
99 </ul>
100 </li>
101 <li><a href="#testing">Testing</a></li>
102 </ul>
103 <hr>
104 <ul>
105 <li><a href="#hints">Appendix A: Hints and Tips</a>
106 <ul>
107 <li><a href="#faq">FAQ</a></li>
108 <li><a href="#performance">Build Performance Tips</a></li>
109 <li><a href="#troubleshooting">Troubleshooting</a></li>
110 </ul>
111 </li>
112 <li><a href="#gmake">Appendix B: GNU Make Information</a></li>
113 <li><a href="#buildenvironments">Appendix C: Build Environments</a></li>
114
115 <!-- Leave out
116 <li><a href="#mapping">Appendix D: Mapping Old Builds to the New Builds</a></li>
117 -->
118
119 </ul>
120 </blockquote>
121
122 <!-- ====================================================== -->
123 <hr>
124 <h2><a name="hg">Use of Mercurial</a></h2>
125 <blockquote>
126 The OpenJDK sources are maintained with the revision control system
127 <a href="http://mercurial.selenic.com/wiki/Mercurial">Mercurial</a>.
128 If you are new to Mercurial, please see the
129 <a href="http://mercurial.selenic.com/wiki/BeginnersGuides">
130 Beginner Guides</a>
131 or refer to the <a href="http://hgbook.red-bean.com/">
132 Mercurial Book</a>.
133 The first few chapters of the book provide an excellent overview of
134 Mercurial, what it is and how it works.
135 <br>
136 For using Mercurial with the OpenJDK refer to the
137 <a href="http://openjdk.java.net/guide/repositories.html#installConfig">
138 Developer Guide: Installing and Configuring Mercurial</a>
139 section for more information.
140
141 <h3><a name="get_source">Getting the Source</a></h3>
142 <blockquote>
143 To get the entire set of OpenJDK Mercurial repositories
144 use the script <code>get_source.sh</code> located in the
145 root repository:
146 <blockquote>
147 <code>
148 hg clone http://hg.openjdk.java.net/jdk8/jdk8
149 <i>YourOpenJDK</i>
150 <br>
151 cd <i>YourOpenJDK</i>
152 <br>
153 bash ./get_source.sh
154 </code>
155 </blockquote>
156 Once you have all the repositories, keep in mind that each
157 repository is it's own independent repository.
158 You can also re-run <code>./get_source.sh</code> anytime to
159 pull over all the latest changesets in all the repositories.
160 This set of nested repositories has been given the term
161 "forest" and there are various ways to apply the same
162 <code>hg</code> command to each of the repositories.
163 For example, the script <code>make/scripts/hgforest.sh</code>
164 can be used to repeat the same <code>hg</code>
165 command on every repository, e.g.
166 <blockquote>
167 <code>
168 cd <i>YourOpenJDK</i>
169 <br>
170 bash ./make/scripts/hgforest.sh status
171 </code>
172 </blockquote>
173 </blockquote>
174
175 <h3><a name="repositories">Repositories</a></h3>
176 <blockquote>
177 <p>The set of repositories and what they contain:</p>
178 <table border="1">
179 <thead>
180 <tr>
181 <th>Repository</th>
182 <th>Contains</th>
183 </tr>
184 </thead>
185 <tbody>
186 <tr>
187 <td>
188 . (root)
189 </td>
190 <td>
191 common configure and makefile logic
192 </td>
193 </tr>
194 <tr>
195 <td>
196 hotspot
197 </td>
198 <td>
199 source code and make files for building
200 the OpenJDK Hotspot Virtual Machine
201 </td>
202 </tr>
203 <tr>
204 <td>
205 langtools
206 </td>
207 <td>
208 source code for the OpenJDK javac and language tools
209 </td>
210 </tr>
211 <tr>
212 <td>
213 jdk
214 </td>
215 <td>
216 source code and make files for building
217 the OpenJDK runtime libraries and misc files
218 </td>
219 </tr>
220 <tr>
221 <td>
222 jaxp
223 </td>
224 <td>
225 source code for the OpenJDK JAXP functionality
226 </td>
227 </tr>
228 <tr>
229 <td>
230 jaxws
231 </td>
232 <td>
233 source code for the OpenJDK JAX-WS functionality
234 </td>
235 </tr>
236 <tr>
237 <td>
238 corba
239 </td>
240 <td>
241 source code for the OpenJDK Corba functionality
242 </td>
243 </tr>
244 </tbody>
245 </table>
246 </blockquote>
247
248 <h3><a name="guidelines">Repository Source Guidelines</a></h3>
249 <blockquote>
250 There are some very basic guidelines:
251 <ul>
252 <li>
253 Use of whitespace in source files
254 (.java, .c, .h, .cpp, and .hpp files)
255 is restricted.
256 No TABs, no trailing whitespace on lines, and files
257 should not terminate in more than one blank line.
258 </li>
259 <li>
260 Files with execute permissions should not be added
261 to the source repositories.
262 </li>
263 <li>
264 All generated files need to be kept isolated from
265 the files
266 maintained or managed by the source control system.
267 The standard area for generated files is the top level
268 <code>build/</code> directory.
269 </li>
270 <li>
271 The default build process should be to build the product
272 and nothing else, in one form, e.g. a product (optimized),
273 debug (non-optimized, -g plus assert logic), or
274 fastdebug (optimized, -g plus assert logic).
275 </li>
276 <li>
277 The <tt>.hgignore</tt> file in each repository
278 must exist and should
279 include <tt>^build/</tt>, <tt>^dist/</tt> and
280 optionally any
281 <tt>nbproject/private</tt> directories.
282 <strong>It should NEVER</strong> include
283 anything in the
284 <tt>src/</tt> or <tt>test/</tt>
285 or any managed directory area of a repository.
286 </li>
287 <li>
288 Directory names and file names should never contain
289 blanks or
290 non-printing characters.
291 </li>
292 <li>
293 Generated source or binary files should NEVER be added to
294 the repository (that includes <tt>javah</tt> output).
295 There are some exceptions to this rule, in particular
296 with some of the generated configure scripts.
297 </li>
298 <li>
299 Files not needed for typical building
300 or testing of the repository
301 should not be added to the repository.
302 </li>
303 </ul>
304 </blockquote>
305
306 </blockquote>
307
308 <!-- ====================================================== -->
309 <hr>
310 <h2><a name="building">Building</a></h2>
311 <blockquote>
312 The very first step in building the OpenJDK is making sure the
313 system itself has everything it needs to do OpenJDK builds.
314 Once a system is setup, it generally doesn't need to be done again.
315 <br>
316 Building the OpenJDK is now done with running a
317 <a href="#configure"><code>configure</code></a>
318 script which will try and find and verify you have everything
319 you need, followed by running
320 <a href="#gmake"><code>make</code></a>, e.g.
321 <blockquote>
322 <b>
323 <code>
324 bash ./configure<br>
325 make all
326 </code>
327 </b>
328 </blockquote>
329 Where possible the <code>configure</code> script will attempt to located the
330 various components in the default locations or via component
331 specific variable settings.
332 When the normal defaults fail or components cannot be found,
333 additional <code>configure</code> options may be necessary to help <code>configure</code>
334 find the necessary tools for the build, or you may need to
335 re-visit the setup of your system due to missing software
336 packages.
337 <br>
338 <strong>NOTE:</strong> The <code>configure</code> script
339 file does not have
340 execute permissions and will need to be explicitly run with
341 <code>bash</code>,
342 see the <a href="#guidelines">source guidelines</a>.
343
344 <!-- ====================================================== -->
345 <hr>
346 <h3><a name="setup">System Setup</a></h3>
347 <blockquote>
348 Before even attempting to use a system to build the OpenJDK
349 there are some very basic system setups needed.
350 For all systems:
351 <ul>
352 <li>
353 Be sure the GNU make utility is version 3.81 or newer,
354 e.g. run "<code>make -version</code>"
355 </li>
356 <li>
357 Install a
358 <a name="bootjdk">Bootstrap JDK</a>.
359 All OpenJDK builds require access to a previously released
360 JDK called the <i>bootstrap JDK</i> or <i>boot JDK.</i>
361 The general rule is that the bootstrap JDK
362 must be an instance of the previous major
363 release of the JDK. In addition, there may be
364 a requirement to use a release at or beyond a
365 particular update level.
366 <br> <br>
367
368 <b><i>Building JDK 8 requires use of a version
369 of JDK 7 that is at Update 7 or newer. JDK 8
370 developers should not use JDK 8 as the boot
371 JDK, to ensure that JDK 8 dependencies are
372 not introduced into the parts of the system
373 that are built with JDK 7.</i></b>
374
375 <br> <br>
376 The JDK 7 binaries can be downloaded from Oracle's
377 <a href="http://www.oracle.com/technetwork/java/javase/downloads/index.html"
378 target="_blank">JDK 7 download site</a>.
379 For build performance reasons
380 is very important that this bootstrap JDK be made available
381 on the local disk of the machine doing the build.
382 You should add its <code>bin</code> directory
383 to the <code>PATH</code> environment variable.
384 If <code>configure</code> has any issues finding this JDK, you may
385 need to use the <code>configure</code> option
386 <code>--with-boot-jdk</code>.
387 </li>
388 <li>
389 Insure that GNU make, the Bootstrap JDK,
390 and the compilers are all
391 in your PATH environment variable
392 </li>
393 </ul>
394 And for specific systems:
395 <table border="1">
396 <thead>
397 <tr>
398 <th>Linux</th>
399 <th>Solaris</th>
400 <th>Windows</th>
401 <th>Mac OS X</th>
402 </tr>
403 </thead>
404 <tbody>
405 <tr>
406 <td>
407 Install all the software development
408 packages needed including
409 <a href="#alsa">alsa</a>,
410 <a href="#freetype">freetype</a>,
411 <a href="#cups">cups</a>, and
412 <a href="#xrender">xrender</a>.
413 <br>
414 See
415 <a href="#SDBE">specific system packages</a>.
416 </td>
417 <td>
418 Install all the software development
419 packages needed including
420 <a href="#studio">Studio Compilers</a>,
421 <a href="#freetype">freetype</a>,
422 <a href="#cups">cups</a>, and
423 <a href="#xrender">xrender</a>.
424 <br>
425 See
426 <a href="#SDBE">specific system packages</a>.
427 </td>
428 <td>
429 <ul>
430 <li>
431 Install one of
432 <a href="#cygwin">CYGWIN</a> or
433 <a href="#msys">MinGW/MSYS</a>
434 </li>
435 <li>
436 Install
437 <a href="#vs2010">Visual Studio 2010</a>
438 </li>
439 <li>
440 Install the
441 <a href="#dxsdk">Microsoft DirectX SDK</a>
442 </li>
443 </ul>
444 </td>
445 <td>
446 Install
447 <a href="https://developer.apple.com/xcode/">XCode 4.5.2</a>
448 and also install the "Command line tools" found under the
449 preferences pane "Downloads"
450 </td>
451 </tr>
452 </tbody>
453 </table>
454
455 <h4><a name="linux">Linux</a></h4>
456 <blockquote>
457 With Linux, try and favor the system packages over
458 building your own
459 or getting packages from other areas.
460 Most Linux builds should be possible with the system's
461 available packages.
462 <br>
463 Note that some Linux systems have a habit of pre-populating
464 your environment variables for you, for example <code>JAVA_HOME</code>
465 might get pre-defined for you to refer to the JDK installed on
466 your Linux system.
467 You will need to unset <code>JAVA_HOME</code>.
468 It's a good idea to run <code>env</code> and verify the
469 environment variables you are getting from the default system
470 settings make sense for building the OpenJDK.
471
472 </blockquote>
473
474 <h4><a name="solaris">Solaris</a></h4>
475 <blockquote>
476 <h5><a name="studio">Studio Compilers</a></h5>
477 <blockquote>
478 At a minimum, the
479 <a href="http://www.oracle.com/technetwork/server-storage/solarisstudio/downloads/index.htm" target="_blank">
480 Studio 12 Update 1 Compilers</a>
481 (containing version 5.10 of the C and C++ compilers) is required,
482 including specific patches.
483 <p>
484 The Solaris SPARC patch list is:
485 <ul>
486 <li>
487 118683-05: SunOS 5.10: Patch for profiling libraries and assembler
488 </li>
489 <li>
490 119963-21: SunOS 5.10: Shared library patch for C++
491 </li>
492 <li>
493 120753-08: SunOS 5.10: Microtasking libraries (libmtsk) patch
494 </li>
495 <li>
496 128228-09: Sun Studio 12 Update 1: Patch for Sun C++ Compiler
497 </li>
498 <li>
499 141860-03: Sun Studio 12 Update 1: Patch for Compiler Common patch for Sun C C++ F77 F95
500 </li>
501 <li>
502 141861-05: Sun Studio 12 Update 1: Patch for Sun C Compiler
503 </li>
504 <li>
505 142371-01: Sun Studio 12.1 Update 1: Patch for dbx
506 </li>
507 <li>
508 143384-02: Sun Studio 12 Update 1: Patch for debuginfo handling
509 </li>
510 <li>
511 143385-02: Sun Studio 12 Update 1: Patch for Compiler Common patch for Sun C C++ F77 F95
512 </li>
513 <li>
514 142369-01: Sun Studio 12.1: Patch for Performance Analyzer Tools
515 </li>
516 </ul>
517 <p>
518 The Solaris X86 patch list is:
519 <ul>
520 <li>
521 119961-07: SunOS 5.10_x86, x64, Patch for profiling libraries and assembler
522 </li>
523 <li>
524 119964-21: SunOS 5.10_x86: Shared library patch for C++_x86
525 </li>
526 <li>
527 120754-08: SunOS 5.10_x86: Microtasking libraries (libmtsk) patch
528 </li>
529 <li>
530 141858-06: Sun Studio 12 Update 1_x86: Sun Compiler Common patch for x86 backend
531 </li>
532 <li>
533 128229-09: Sun Studio 12 Update 1_x86: Patch for C++ Compiler
534 </li>
535 <li>
536 142363-05: Sun Studio 12 Update 1_x86: Patch for C Compiler
537 </li>
538 <li>
539 142368-01: Sun Studio 12.1_x86: Patch for Performance Analyzer Tools
540 </li>
541 </ul>
542 <p>
543 Place the <code>bin</code> directory in <code>PATH</code>.
544 <p>
545 The Oracle Solaris Studio Express compilers at:
546 <a href="http://www.oracle.com/technetwork/server-storage/solarisstudio/downloads/index-jsp-142582.html" target="_blank">
547 Oracle Solaris Studio Express Download site</a>
548 are also an option, although these compilers have not
549 been extensively used yet.
550 </blockquote>
551
552 </blockquote> <!-- Solaris -->
553
554 <h4><a name="windows">Windows</a></h4>
555 <blockquote>
556
557 <h5><a name="toolkit">Windows Unix Toolkit</a></h5>
558 <blockquote>
559 Building on Windows requires a Unix-like environment, notably a
560 Unix-like shell.
561 There are several such environments available of which
562 <a href="http://www.cygwin.com/">Cygwin</a> and
563 <a href="http://www.mingw.org/wiki/MSYS">MinGW/MSYS</a> are
564 currently supported for
565 the OpenJDK build. One of the differences of these
566 systems from standard Windows tools is the way
567 they handle Windows path names, particularly path names which contain
568 spaces, backslashes as path separators and possibly drive letters.
569 Depending
570 on the use case and the specifics of each environment these path
571 problems can
572 be solved by a combination of quoting whole paths, translating
573 backslashes to
574 forward slashes, escaping backslashes with additional backslashes and
575 translating the path names to their
576 <a href="http://en.wikipedia.org/wiki/8.3_filename">
577 "8.3" version</a>.
578
579 <h6><a name="cygwin">CYGWIN</a></h6>
580 <blockquote>
581 CYGWIN is an open source, Linux-like environment which tries to emulate
582 a complete POSIX layer on Windows. It tries to be smart about path names
583 and can usually handle all kinds of paths if they are correctly quoted
584 or escaped although internally it maps drive letters <code><drive>:</code>
585 to a virtual directory <code>/cygdrive/<drive></code>.
586 <p>
587 You can always use the <code>cygpath</code> utility to map pathnames with spaces
588 or the backslash character into the <code>C:/</code> style of pathname
589 (called 'mixed'), e.g. <code>cygpath -s -m "<i>path</i>"</code>.
590 </p>
591 <p>
592 Note that the use of CYGWIN creates a unique problem with regards to
593 setting <a href="#path"><code>PATH</code></a>. Normally on Windows
594 the <code>PATH</code> variable contains directories
595 separated with the ";" character (Solaris and Linux use ":").
596 With CYGWIN, it uses ":", but that means that paths like "C:/path"
597 cannot be placed in the CYGWIN version of <code>PATH</code> and
598 instead CYGWIN uses something like <code>/cygdrive/c/path</code>
599 which CYGWIN understands, but only CYGWIN understands.
600 </p>
601 <p>
602 The OpenJDK build requires CYGWIN version 1.7.16 or newer.
603 Information about CYGWIN can
604 be obtained from the CYGWIN website at
605 <a href="http://www.cygwin.com" target="_blank">www.cygwin.com</a>.
606 </p>
607 <p>
608 By default CYGWIN doesn't install all the tools required for building
609 the OpenJDK.
610 Along with the default installation, you need to install
611 the following tools.
612 <blockquote>
613 <table border="1">
614 <thead>
615 <tr>
616 <td>Binary Name</td>
617 <td>Category</td>
618 <td>Package</td>
619 <td>Description</td>
620 </tr>
621 </thead>
622 <tbody>
623 <tr>
624 <td>ar.exe</td>
625 <td>Devel</td>
626 <td>binutils</td>
627 <td>
628 The GNU assembler, linker and binary utilities
629 </td>
630 </tr>
631 <tr>
632 <td>make.exe</td>
633 <td>Devel</td>
634 <td>make</td>
635 <td>
636 The GNU version of the 'make' utility built for CYGWIN
637 </td>
638 </tr>
639 <tr>
640 <td>m4.exe</td>
641 <td>Interpreters</td>
642 <td>m4</td>
643 <td>
644 GNU implementation of the traditional Unix macro
645 processor
646 </td>
647 </tr>
648 <tr>
649 <td>cpio.exe</td>
650 <td>Utils</td>
651 <td>cpio</td>
652 <td>
653 A program to manage archives of files
654 </td>
655 </tr>
656 <tr>
657 <td>gawk.exe</td>
658 <td>Utils</td>
659 <td>awk</td>
660 <td>
661 Pattern-directed scanning and processing language
662 </td>
663 </tr>
664 <tr>
665 <td>file.exe</td>
666 <td>Utils</td>
667 <td>file</td>
668 <td>
669 Determines file type using 'magic' numbers
670 </td>
671 </tr>
672 <tr>
673 <td>zip.exe</td>
674 <td>Archive</td>
675 <td>zip</td>
676 <td>
677 Package and compress (archive) files
678 </td>
679 </tr>
680 <tr>
681 <td>unzip.exe</td>
682 <td>Archive</td>
683 <td>unzip</td>
684 <td>
685 Extract compressed files in a ZIP archive
686 </td>
687 </tr>
688 <tr>
689 <td>free.exe</td>
690 <td>System</td>
691 <td>procps</td>
692 <td>
693 Display amount of free and used memory in the system
694 </td>
695 </tr>
696 </tbody>
697 </table>
698 </blockquote>
699 Note that the CYGWIN software can conflict with other non-CYGWIN
700 software on your Windows system.
701 CYGWIN provides a
702 <a href="http://cygwin.com/faq/faq.using.html" target="_blank">FAQ</a> for
703 known issues and problems, of particular interest is the
704 section on
705 <a href="http://cygwin.com/faq/faq.using.html#faq.using.bloda" target="_blank">
706 BLODA (applications that interfere with CYGWIN)</a>.
707 </blockquote>
708
709 <h6><a name="msys">MinGW/MSYS</a></h6>
710 <blockquote>
711 MinGW ("Minimalist GNU for Windows") is a collection of free Windows
712 specific header files and import libraries combined with GNU toolsets that
713 allow one to produce native Windows programs that do not rely on any
714 3rd-party C runtime DLLs. MSYS is a supplement to MinGW which allows building
715 applications and programs which rely on traditional UNIX tools to
716 be present. Among others this includes tools like <code>bash</code>
717 and <code>make</code>.
718 See <a href="http://www.mingw.org/wiki/MSYS" target="_blank">MinGW/MSYS</a>
719 for more information.
720 <p>
721 Like Cygwin, MinGW/MSYS can handle different types of path formats. They
722 are internally converted to paths with forward slashes and drive letters
723 <code><drive>:</code> replaced by a virtual
724 directory <code>/<drive></code>. Additionally, MSYS automatically
725 detects binaries compiled for the MSYS environment and feeds them with the
726 internal, Unix-style path names. If native Windows applications are called
727 from within MSYS programs their path arguments are automatically converted
728 back to Windows style path names with drive letters and backslashes as
729 path separators. This may cause problems for Windows applications which
730 use forward slashes as parameter separator (e.g. <code>cl /nologo /I</code>)
731 because MSYS may wrongly <a href="http://mingw.org/wiki/Posix_path_conversion">
732 replace such parameters by drive letters</a>.
733 </p>
734 <p>
735 In addition to the tools which will be installed
736 by default, you have
737 to manually install the
738 <code>msys-zip</code> and
739 <code>msys-unzip</code> packages.
740 This can be easily done with the MinGW command line installer:
741 <blockquote>
742 <code>mingw-get.exe install msys-zip</code>
743 <br>
744 <code>mingw-get.exe install msys-unzip</code>
745 </blockquote>
746 </blockquote>
747
748 </blockquote>
749
750 <h5><a name="vs2010">Visual Studio 2010 Compilers</a></h5>
751 <blockquote>
752 <p>
753 The 32-bit and 64-bit OpenJDK Windows build requires
754 Microsoft Visual Studio C++ 2010 (VS2010) Professional
755 Edition or Express compiler.
756 The compiler and other tools are expected to reside
757 in the location defined by the variable
758 <code>VS100COMNTOOLS</code> which
759 is set by the Microsoft Visual Studio installer.
760 </p>
761 <p>
762 Only the C++ part of VS2010 is needed.
763 Try to let the installation go to the default
764 install directory.
765 Always reboot your system after installing VS2010.
766 The system environment variable VS100COMNTOOLS
767 should be
768 set in your environment.
769 </p>
770 <p>
771 Make sure that TMP and TEMP are also set
772 in the environment
773 and refer to Windows paths that exist,
774 like <code>C:\temp</code>,
775 not <code>/tmp</code>, not <code>/cygdrive/c/temp</code>,
776 and not <code>C:/temp</code>.
777 <code>C:\temp</code> is just an example,
778 it is assumed that this area is
779 private to the user, so by default
780 after installs you should
781 see a unique user path in these variables.
782 </p>
783 </blockquote>
784
785
786 </blockquote> <!-- Windows -->
787
788 <h4><a name="macosx">Mac OS X</a></h4>
789 <blockquote>
790 Make sure you get the right XCode version.
791 </blockquote> <!-- Mac OS X -->
792
793 </blockquote>
794
795 <!-- ====================================================== -->
796 <hr>
797 <h3><a name="configure">Configure</a></h3>
798 <blockquote>
799 The basic invocation of the <code>configure</code> script
800 looks like:
801 <blockquote>
802 <b><code>bash ./configure [<i>options</i>]</code></b>
803 </blockquote>
804 This will create an output directory containing the
805 "configuration" and setup an area for the build result.
806 This directory typically looks like:
807 <blockquote>
808 <b><code>build/linux-x64-normal-server-release</code></b>
809 </blockquote>
810 <code>configure</code> will try to figure out what system you are running on
811 and where all necessary build components are.
812 If you have all prerequisites for building installed,
813 it should find everything.
814 If it fails to detect any component automatically,
815 it will exit and inform you about the problem.
816 When this happens, read more below in
817 <a href="#configureoptions">the <code>configure</code> options</a>.
818 <p>
819 Some examples:
820 </p>
821 <table border="1">
822 <thead>
823 <tr>
824 <th>Description</th>
825 <th>Configure Command Line</th>
826 </tr>
827 </thead>
828 <tbody>
829 <tr>
830 <td>Windows 32bit build with freetype specified</td>
831 <td>
832 <code>bash ./configure --with-freetype=/cygdrive/c/freetype-i586 --with-target-bits=32</code>
833 </td>
834 </tr>
835 <tr>
836 <td>Debug 64bit Build</td>
837 <td>
838 <code>bash ./configure --enable-debug --with-target-bits=64</code>
839 </td>
840 </tr>
841 </tbody>
842 </table>
843
844 <!-- ====================================================== -->
845 <h4><a name="configureoptions">Configure Options</a></h4>
846 <blockquote>
847 Complete details on all the OpenJDK <code>configure</code> options can
848 be seen with:
849 <blockquote>
850 <b><code>bash ./configure --help=short</code></b>
851 </blockquote>
852 Use <code>-help</code> to see all the <code>configure</code> options
853 available.
854
855 You can generate any number of different configurations,
856 e.g. debug, release, 32, 64, etc.
857
858 Some of the more commonly used <code>configure</code> options are:
859
860 <table border="1">
861 <thead>
862 <tr>
863 <th width="300">OpenJDK Configure Option</th>
864 <th>Description</th>
865 </tr>
866 </thead>
867 <tbody>
868 <tr>
869 <td><b><code>--enable-debug</code></b></td>
870 <td>
871 set the debug level to fastdebug (this is a shorthand for
872 <code>--with-debug-level=fastdebug</code>)
873 </td>
874 </tr>
875 <tr>
876 <td><b><code>--with-alsa=</code></b><i>path</i></td>
877 <td>
878 select the location of the
879 <a name="alsa">Advanced Linux Sound Architecture (ALSA)</a>
880 <br>
881 Version 0.9.1 or newer of the ALSA files are
882 required for building the OpenJDK on Linux.
883 These Linux files are usually available from an "alsa"
884 of "libasound"
885 development package,
886 and it's highly recommended that you try and use
887 the package provided by the particular version of Linux that
888 you are using.
889 </td>
890 </tr>
891 <tr>
892 <td><b><code>--with-boot-jdk=</code></b><i>path</i></td>
893 <td>
894 select the <a href="#bootjdk">Bootstrap JDK</a>
895 </td>
896 </tr>
897 <tr>
898 <td><b><code>--with-boot-jdk-jvmargs=</code></b>"<i>args</i>"</td>
899 <td>
900 provide the JVM options to be used to run the
901 <a href="#bootjdk">Bootstrap JDK</a>
902 </td>
903 </tr>
904 <tr>
905 <td><b><code>--with-cacerts=</code></b><i>path</i></td>
906 <td>
907 select the path to the cacerts file.
908 <br>
909 See <a href="http://en.wikipedia.org/wiki/Certificate_Authority" target="_blank">
910 http://en.wikipedia.org/wiki/Certificate_Authority</a>
911 for a better understanding of the Certificate Authority (CA).
912 A certificates file named "cacerts"
913 represents a system-wide keystore with CA certificates.
914 In JDK and JRE
915 binary bundles, the "cacerts" file contains root CA certificates from
916 several public CAs (e.g., VeriSign, Thawte, and Baltimore).
917 The source contain a cacerts file
918 without CA root certificates.
919 Formal JDK builders will need to secure
920 permission from each public CA and include the certificates into their
921 own custom cacerts file.
922 Failure to provide a populated cacerts file
923 will result in verification errors of a certificate chain during runtime.
924 By default an empty cacerts file is provided and that should be
925 fine for most JDK developers.
926 </td>
927 </tr>
928 <tr>
929 <td><b><code>--with-cups=</code></b><i>path</i></td>
930 <td>
931 select the CUPS install location
932 <br>
933 The
934 <a name="cups">Common UNIX Printing System (CUPS) Headers</a>
935 are required for building the
936 OpenJDK on Solaris and Linux.
937 The Solaris header files can be obtained by installing
938 the package <strong>SFWcups</strong> from the Solaris Software
939 Companion CD/DVD, these often will be installed into the
940 directory <code>/opt/sfw/cups</code>.
941 <br>
942 The CUPS header files can always be downloaded from
943 <a href="http://www.cups.org" target="_blank">www.cups.org</a>.
944 </td>
945 </tr>
946 <tr>
947 <td><b><code>--with-cups-include=</code></b><i>path</i></td>
948 <td>
949 select the CUPS include directory location
950 </td>
951 </tr>
952 <tr>
953 <td><b><code>--with-debug-level=</code></b><i>level</i></td>
954 <td>
955 select the debug information level of release,
956 fastdebug, or slowdebug
957 </td>
958 </tr>
959 <tr>
960 <td><b><code>--with-dev-kit=</code></b><i>path</i></td>
961 <td>
962 select location of the compiler install or
963 developer install location
964 </td>
965 </tr>
966 <tr>
967 <td><b><code>--with-dxsdk=</code></b><i>path</i></td>
968 <td>
969 select location of the Windows Direct X SDK install
970 <br>
971 The <a name="dxsdk">Microsoft DirectX 9.0 SDK</a>
972 header files and libraries
973 from the Summer 2004 edition
974 are required for building OpenJDK.
975 This SDK can be downloaded from
976 <a href="http://www.microsoft.com/downloads/details.aspx?FamilyId=FD044A42-9912-42A3-9A9E-D857199F888E&displaylang=en" target="_blank">
977 Microsoft DirectX 9.0 SDK (Summer 2004)</a>.
978 If the link above becomes obsolete, the SDK can be found from
979 <a href="http://download.microsoft.com" target="_blank">the Microsoft Download Site</a>
980 (search with "DirectX 9.0 SDK Update Summer 2004").
981 Installation usually will set the environment variable
982 <code>DXSDK_DIR</code> to it's install location.
983 </td>
984 </tr>
985 <tr>
986 <td><b><code>--with-freetype=</code></b><i>path</i></td>
987 <td>
988 select the freetype files to use.
989 <br>
990 Expecting the
991 <a name="freetype">freetype</a> libraries under
992 <code>lib/</code> and the
993 headers under <code>include/</code>.
994 <br>
995 Version 2.3 or newer of FreeType is required.
996 On Unix systems required files can be available as part of your
997 distribution (while you still may need to upgrade them).
998 Note that you need development version of package that
999 includes both the FreeType library and header files.
1000 <br>
1001 You can always download latest FreeType version from the
1002 <a href="http://www.freetype.org" target="_blank">FreeType website</a>.
1003 <br>
1004 Building the freetype 2 libraries from scratch is also possible,
1005 however on Windows refer to the
1006 <a href="http://freetype.freedesktop.org/wiki/FreeType_DLL">
1007 Windows FreeType DLL build instructions</a>.
1008 <br>
1009 Note that by default FreeType is built with byte code hinting
1010 support disabled due to licensing restrictions.
1011 In this case, text appearance and metrics are expected to
1012 differ from Sun's official JDK build.
1013 See
1014 <a href="http://freetype.sourceforge.net/freetype2/index.html">
1015 the SourceForge FreeType2 Home Page
1016 </a>
1017 for more information.
1018 </td>
1019 </tr>
1020 <tr>
1021 <td><b><code>--with-import-hotspot=</code></b><i>path</i></td>
1022 <td>
1023 select the location to find hotspot
1024 binaries from a previous build to avoid building
1025 hotspot
1026 </td>
1027 </tr>
1028 <tr>
1029 <td><b><code>--with-target-bits=</code></b><i>arg</i></td>
1030 <td>
1031 select 32 or 64 bit build
1032 </td>
1033 </tr>
1034 <tr>
1035 <td><b><code>--with-jvm-variants=</code></b><i>variants</i></td>
1036 <td>
1037 select the JVM variants to build from, comma
1038 separated list that can include:
1039 server, client, kernel, zero and zeroshark
1040 </td>
1041 </tr>
1042 <tr>
1043 <td><b><code>--with-memory-size=</code></b><i>size</i></td>
1044 <td>
1045 select the RAM size that GNU make will think
1046 this system has
1047 </td>
1048 </tr>
1049 <tr>
1050 <td><a name="msvcrNN"><b><code>--with-msvcr-dll=</code></b><i>path</i></a></td>
1051 <td>
1052 select the <code>msvcr100.dll</code>
1053 file to include in the
1054 Windows builds (C/C++ runtime library for
1055 Visual Studio).
1056 <br>
1057 This is usually picked up automatically
1058 from the redist
1059 directories of Visual Studio 2010.
1060 </td>
1061 </tr>
1062 <tr>
1063 <td><b><code>--with-num-cores=</code></b><i>cores</i></td>
1064 <td>
1065 select the number of cores to use (processor
1066 count or CPU count)
1067 </td>
1068 </tr>
1069 <tr>
1070 <td><b><code>--with-x=</code></b><i>path</i></td>
1071 <td>
1072 select the location of the X11 and xrender files.
1073 <br>
1074 The
1075 <a name="xrender">XRender Extension Headers</a>
1076 are required for building the
1077 OpenJDK on Solaris and Linux.
1078 <br>
1079 The Linux header files are usually available from a "Xrender"
1080 development package, it's recommended that you try and use
1081 the package provided by the particular distribution of Linux that
1082 you are using.
1083 <br>
1084 The Solaris XRender header files is
1085 included with the other X11 header files
1086 in the package <strong>SFWxwinc</strong>
1087 on new enough versions of
1088 Solaris and will be installed in
1089 <code>/usr/X11/include/X11/extensions/Xrender.h</code> or
1090 <code>/usr/openwin/share/include/X11/extensions/Xrender.h</code>
1091 </td>
1092 </tr>
1093 </tbody>
1094 </table>
1095 </blockquote>
1096
1097 </blockquote>
1098
1099 <!-- ====================================================== -->
1100 <hr>
1101 <h3><a name="make">Make</a></h3>
1102 <blockquote>
1103 The basic invocation of the <code>make</code> utility
1104 looks like:
1105 <blockquote>
1106 <b><code>make all</code></b>
1107 </blockquote>
1108 This will start the build to the output directory containing the
1109 "configuration" that was created by the <code>configure</code>
1110 script. Run <code>make help</code> for more information on
1111 the available targets.
1112 <br>
1113 There are some of the make targets that
1114 are of general interest:
1115 <table border="1">
1116 <thead>
1117 <tr>
1118 <th>Make Target</th>
1119 <th>Description</th>
1120 </tr>
1121 </thead>
1122 <tbody>
1123 <tr>
1124 <td><i>empty</i></td>
1125 <td>build everything but no images</td>
1126 </tr>
1127 <tr>
1128 <td><b><code>all</code></b></td>
1129 <td>build everything including images</td>
1130 </tr>
1131 <tr>
1132 <td><b><code>all-conf</code></b></td>
1133 <td>build all configurations</td>
1134 </tr>
1135 <tr>
1136 <td><b><code>images</code></b></td>
1137 <td>create complete j2sdk and j2re images</td>
1138 </tr>
1139 <tr>
1140 <td><b><code>install</code></b></td>
1141 <td>install the generated images locally,
1142 typically in <code>/usr/local</code></td>
1143 </tr>
1144 <tr>
1145 <td><b><code>clean</code></b></td>
1146 <td>remove all files generated by make,
1147 but not those generated by <code>configure</code></td>
1148 </tr>
1149 <tr>
1150 <td><b><code>dist-clean</code></b></td>
1151 <td>remove all files generated by both
1152 and <code>configure</code> (basically killing the configuration)</td>
1153 </tr>
1154 <tr>
1155 <td><b><code>help</code></b></td>
1156 <td>give some help on using <code>make</code>,
1157 including some interesting make targets</td>
1158 </tr>
1159 </tbody>
1160 </table>
1161 </blockquote>
1162 </blockquote>
1163
1164 <!-- ====================================================== -->
1165 <hr>
1166 <h2><a name="testing">Testing</a></h2>
1167 <blockquote>
1168 When the build is completed, you should see the generated
1169 binaries and associated files in the <code>j2sdk-image</code>
1170 directory in the output directory.
1171 In particular, the
1172 <code>build/<i>*</i>/images/j2sdk-image/bin</code>
1173 directory should contain executables for the
1174 OpenJDK tools and utilities for that configuration.
1175 The testing tool <code>jtreg</code> will be needed
1176 and can be found at:
1177 <a href="http://openjdk.java.net/jtreg/" target="_blank">
1178 the jtreg site</a>.
1179 The provided regression tests in the repositories
1180 can be run with the command:
1181 <blockquote>
1182 <code><b>cd test && make PRODUCT_HOME=`pwd`/../build/*/images/j2sdk-image all</b></code>
1183 </blockquote>
1184 </blockquote>
1185
1186 <!-- ====================================================== -->
1187 <!-- ====================================================== -->
1188 <!-- ====================================================== -->
1189 <!-- ====================================================== -->
1190 <!-- ====================================================== -->
1191 <!-- ====================================================== -->
1192 <!-- ====================================================== -->
1193 <!-- ====================================================== -->
1194 <!-- ====================================================== -->
1195
1196 <!-- ====================================================== -->
1197 <hr>
1198 <h2><a name="hints">Appendix A: Hints and Tips</a></h2>
1199 <blockquote>
1200
1201 <h3><a name="faq">FAQ</a></h3>
1202 <blockquote>
1203
1204 <p>
1205 <b>Q:</b> The <code>configure</code> file looks horrible!
1206 How are you going to edit it?
1207 <br>
1208 <b>A:</b> The <code>configure</code> file is generated (think
1209 "compiled") by the autoconf tools. The source code is
1210 in <code>configure.ac</code> various .m4 files in common/autoconf,
1211 which are
1212 much more readable.
1213 </p>
1214
1215 <p>
1216 <b>Q:</b>
1217 Why is the <code>configure</code> file checked in,
1218 if it is generated?
1219 <br>
1220 <b>A:</b>
1221 If it was not generated, every user would need to have the autoconf
1222 tools installed, and re-generate the <code>configure</code> file
1223 as the first step.
1224 Our goal is to minimize the work needed to be done by the user
1225 to start building OpenJDK, and to minimize
1226 the number of external dependencies required.
1227 </p>
1228
1229 <p>
1230 <b>Q:</b>
1231 Do you require a specific version of autoconf for regenerating
1232 <code>configure</code>?
1233 <br>
1234 <b>A:</b>
1235 Currently, no, but this will likely be the case when things have
1236 settled down a bit more. (The reason for this is to avoid
1237 large spurious changes in <code>configure</code>
1238 in commits that made small changes to <code>configure.ac</code>).
1239 </p>
1240
1241 <p>
1242 <b>Q:</b>
1243 What are the files in <code>common/makefiles/support/*</code> for?
1244 They look like gibberish.
1245 <br>
1246 <b>A:</b>
1247 They are a somewhat ugly hack to compensate for command line length
1248 limitations on certain platforms (Windows, Solaris).
1249 Due to a combination of limitations in make and the shell,
1250 command lines containing too many files will not work properly.
1251 These
1252 helper files are part of an elaborate hack that will compress the
1253 command line in the makefile and then uncompress it safely.
1254 We're
1255 not proud of it, but it does fix the problem.
1256 If you have any better suggestions, we're all ears! :-)
1257 </p>
1258
1259 <p>
1260 <b>Q:</b>
1261 I want to see the output of the commands that make runs,
1262 like in the old build. How do I do that?
1263 <br>
1264 <b>A:</b>
1265 You specify the <code>LOG</code> variable to make. There are
1266 several log levels:
1267 </p>
1268 <blockquote>
1269 <ul>
1270 <li>
1271 <b><code>warn</code></b> — Default and very quiet.
1272 </li>
1273 <li>
1274 <b><code>info</code></b> — Shows more progress information
1275 than warn.
1276 </li>
1277 <li>
1278 <b><code>debug</code></b> — Echos all command lines and
1279 prints all macro calls for compilation definitions.
1280 </li>
1281 <li>
1282 <b><code>trace</code></b> — Echos all $(shell) command
1283 lines as well.
1284 </li>
1285 </ul>
1286 </blockquote>
1287
1288 <p>
1289 <b>Q:</b>
1290 When do I have to re-run <code>configure</code>?
1291 <br>
1292 <b>A:</b>
1293 Normally you will run <code>configure</code> only once for creating a
1294 configuration.
1295 You need to re-run configuration only if you want to change any
1296 configuration options,
1297 or if you pull down changes to the <code>configure</code> script.
1298 </p>
1299
1300 <p>
1301 <b>Q:</b>
1302 I have added a new source file. Do I need to modify the makefiles?
1303 <br>
1304 <b>A:</b>
1305 Normally, no. If you want to create e.g. a new native
1306 library,
1307 you will need to modify the makefiles. But for normal file
1308 additions or removals, no changes are needed. There are certan
1309 exceptions for some native libraries where the source files are spread
1310 over many directories which also contain courses for other
1311 libraries. In these cases it was simply easier to create include lists
1312 rather thane excludes.
1313 </p>
1314
1315 <p>
1316 <b>Q:</b>
1317 When I run <code>configure --help</code>, I see many strange options,
1318 like <code>--dvidir</code>. What is this?
1319 <br>
1320 <b>A:</b>
1321 Configure provides a slew of options by default, to all projects
1322 that use autoconf. Most of them are not used in OpenJDK,
1323 so you can safely ignore them. To list only OpenJDK specific features,
1324 use <code>configure --help=short</code> instead.
1325 </p>
1326
1327 <p>
1328 <b>Q:</b>
1329 <code>configure</code> provides OpenJDK-specific features such as
1330 <code>--enable-jigsaw</code> or <code>--with-builddeps-server</code>
1331 that are not described in this document. What about those?
1332 <br>
1333 <b>A:</b>
1334 Try them out if you like! But be aware that most of these are
1335 experimental features.
1336 Many of them don't do anything at all at the moment; the option
1337 is just a placeholder. Other depends on
1338 pieces of code or infrastructure that is currently
1339 not ready for prime time.
1340 </p>
1341
1342 <p>
1343 <b>Q:</b>
1344 How will you make sure you don't break anything?
1345 <br>
1346 <b>A:</b>
1347 We have a script that compares the result of the new build system
1348 with the result of the old. For most part, we aim for (and achieve)
1349 byte-by-byte identical output. There are however technical issues
1350 with e.g. native binaries, which might differ in a byte-by-byte
1351 comparison, even
1352 when building twice with the old build system.
1353 For these, we compare relevant aspects
1354 (e.g. the symbol table and file size).
1355 Note that we still don't have 100%
1356 equivalence, but we're close.
1357 </p>
1358
1359 <p>
1360 <b>Q:</b>
1361 I noticed this thing X in the build that looks very broken by design.
1362 Why don't you fix it?
1363 <br>
1364 <b>A:</b>
1365 Our goal is to produce a build output that is as close as
1366 technically possible to the old build output.
1367 If things were weird in the old build,
1368 they will be weird in the new build.
1369 Often, things were weird before due to obscurity,
1370 but in the new build system the weird stuff comes up to the surface.
1371 The plan is to attack these things at a later stage,
1372 after the new build system is established.
1373 </p>
1374
1375 <p>
1376 <b>Q:</b>
1377 The code in the new build system is not that well-structured.
1378 Will you fix this?
1379 <br>
1380 <b>A:</b>
1381 Yes! The new build system has grown bit by bit as we converted
1382 the old system. When all of the old build system is converted,
1383 we can take a step back and clean up the structure of the new build
1384 system. Some of this we plan to do before replacing the old build
1385 system and some will need to wait until after.
1386 </p>
1387
1388 <p>
1389 <b>Q:</b> What is @GenerateNativeHeaders?
1390 <br>
1391 <b>A:</b>
1392 To speed up compilation, we added a flag to javac which makes it
1393 do the job of javah as well, as a by-product; that is, generating
1394 native .h header files. These files are only generated
1395 if a class contains native methods. However, sometimes
1396 a class contains no native method,
1397 but still contains constants that native code needs to use.
1398 The new GenerateNativeHeaders annotation tells javac to
1399 force generation of a
1400 header file in these cases. (We don't want to generate
1401 native headers for all classes that contains constants
1402 but no native methods, since
1403 that would slow down the compilation process needlessly.)
1404 </p>
1405
1406 <p>
1407 <b>Q:</b>
1408 Is anything able to use the results of the new build's default make target?
1409 <br>
1410 <b>A:</b>
1411 Yes, this is the minimal (or roughly minimal)
1412 set of compiled output needed for a developer to actually
1413 execute the newly built JDK. The idea is that in an incremental
1414 development fashion, when doing a normal make,
1415 you should only spend time recompiling what's changed
1416 (making it purely incremental) and only do the work that's
1417 needed to actually run and test your code.
1418 The packaging stuff that is part of the <code>images</code>
1419 target is not needed for a normal developer who wants to
1420 test his new code. Even if it's quite fast, it's still unnecessary.
1421 We're targeting sub-second incremental rebuilds! ;-)
1422 (Or, well, at least single-digit seconds...)
1423 </p>
1424
1425 <p>
1426 <b>Q:</b>
1427 I usually set a specific environment variable when building,
1428 but I can't find the equivalent in the new build.
1429 What should I do?
1430 <br>
1431 <b>A:</b>
1432 It might very well be that we have missed to add support for
1433 an option that was actually used from outside the build system.
1434 Email us and we will
1435 add support for it!
1436 </p>
1437
1438 </blockquote>
1439
1440 <h3><a name="performance">Build Performance Tips</a></h3>
1441 <blockquote>
1442
1443 <p>Building OpenJDK requires a lot of horsepower.
1444 Some of the build tools can be adjusted to utilize more or less
1445 of resources such as
1446 parallel threads and memory.
1447 The <code>configure</code> script analyzes your system and selects reasonable
1448 values for such options based on your hardware.
1449 If you encounter resource problems, such as out of memory conditions,
1450 you can modify the detected values with:</p>
1451
1452 <ul>
1453 <li>
1454 <b><code>--with-num-cores</code></b>
1455 —
1456 number of cores in the build system,
1457 e.g. <code>--with-num-cores=8</code>
1458 </li>
1459 <li>
1460 <b><code>--with-memory-size</code></b>
1461 — memory (in MB) available in the build system,
1462 e.g. <code>--with-memory-size=1024</code>
1463 </li>
1464 </ul>
1465
1466 <p>It might also be necessary to specify the JVM arguments passed
1467 to the Bootstrap JDK, using e.g.
1468 <code>--with-boot-jdk-jvmargs="-Xmx8G -enableassertions"</code>.
1469 Doing this will override the default JVM arguments
1470 passed to the Bootstrap JDK.</p>
1471
1472
1473 <p>One of the top goals of the new build system is to improve the
1474 build performance and decrease the time needed to build. This will
1475 soon also apply to the java compilation when the Smart Javac wrapper
1476 is making its way into jdk8. It can be tried in the build-infra
1477 repository already. You are likely to find that the new build system
1478 is faster than the old one even without this feature.</p>
1479
1480 <p>At the end of a successful execution of <code>configure</code>,
1481 you will get a performance summary,
1482 indicating how well the build will perform. Here you will
1483 also get performance hints.
1484 If you want to build fast, pay attention to those!</p>
1485
1486 <h4>Building with ccache</h4>
1487
1488 <p>A simple way to radically speed up compilation of native code
1489 (typically hotspot and native libraries in JDK) is to install
1490 ccache. This will cache and reuse prior compilation results, if the
1491 source code is unchanged. However, ccache versions prior to 3.1.4
1492 does not work correctly with the precompiled headers used in
1493 OpenJDK. So if your platform supports ccache at 3.1.4 or later, we
1494 highly recommend installing it. This is currently only supported on
1495 linux.</p>
1496
1497 <h4>Building on local disk</h4>
1498
1499 <p>If you are using network shares, e.g. via NFS, for your source code,
1500 make sure the build directory is situated on local disk.
1501 The performance
1502 penalty is extremely high for building on a network share,
1503 close to unusable.</p>
1504
1505 <h4>Building only one JVM</h4>
1506
1507 <p>The old build builds multiple JVMs on 32-bit systems (client and
1508 server; and on Windows kernel as well). In the new build we have
1509 changed this default to only build server when it's available. This
1510 improves build times for those not interested in multiple JVMs. To
1511 mimic the old behavior on platforms that support it,
1512 use <code>--with-jvm-variants=client,server</code>.</p>
1513
1514 <h4>Selecting the number of cores to build on</h4>
1515
1516 <p>By default, <code>configure</code> will analyze your machine and run the make
1517 process in parallel with as many threads as you have cores. This
1518 behavior can be overridden, either "permanently" (on a <code>configure</code>
1519 basis) using <code>--with-num-cores=N</code> or for a single build
1520 only (on a make basis), using <code>make JOBS=N</code>.</p>
1521
1522 <p>If you want to make a slower build just this time, to save some CPU
1523 power for other processes, you can run
1524 e.g. <code>make JOBS=2</code>. This will force the makefiles
1525 to only run 2 parallel processes, or even <code>make JOBS=1</code>
1526 which will disable parallelism.</p>
1527
1528 <p>If you want to have it the other way round, namely having slow
1529 builds default and override with fast if you're
1530 impatient, you should call <code>configure</code> with
1531 <code>--with-num-cores=2</code>, making 2 the default.
1532 If you want to run with more
1533 cores, run <code>make JOBS=8</code></p>
1534
1535 </blockquote>
1536
1537 <h3><a name="troubleshooting">Troubleshooting</a></h3>
1538 <blockquote>
1539
1540 <h4>Solving build problems</h4>
1541
1542 <blockquote>
1543 If the build fails (and it's not due to a compilation error in
1544 a source file you've changed), the first thing you should do
1545 is to re-run the build with more verbosity.
1546 Do this by adding <code>LOG=debug</code> to your make command line.
1547 <br>
1548 The build log (with both stdout and stderr intermingled,
1549 basically the same as you see on your console) can be found as
1550 <code>build.log</code> in your build directory.
1551 <br>
1552 You can ask for help on build problems with the new build system
1553 on either the
1554 <a href="http://mail.openjdk.java.net/mailman/listinfo/build-dev">
1555 build-dev</a>
1556 or the
1557 <a href="http://mail.openjdk.java.net/mailman/listinfo/build-infra-dev">
1558 build-infra-dev</a>
1559 mailing lists. Please include the relevant parts
1560 of the build log.
1561 <br>
1562 A build can fail for any number of reasons.
1563 Most failures
1564 are a result of trying to build in an environment in which all the
1565 pre-build requirements have not been met.
1566 The first step in
1567 troubleshooting a build failure is to recheck that you have satisfied
1568 all the pre-build requirements for your platform.
1569 Scanning the <code>configure</code> log is a good first step, making
1570 sure that what it found makes sense for your system.
1571 Look for strange error messages or any difficulties that
1572 <code>configure</code> had in finding things.
1573 <br>
1574 Some of the more common problems with builds are briefly
1575 described
1576 below, with suggestions for remedies.
1577 <ul>
1578 <li>
1579 <b>Corrupted Bundles on Windows:</b>
1580 <blockquote>
1581 Some virus scanning software has been known to
1582 corrupt the
1583 downloading of zip bundles.
1584 It may be necessary to disable the 'on access' or
1585 'real time'
1586 virus scanning features to prevent this corruption.
1587 This type of "real time" virus scanning can also
1588 slow down the
1589 build process significantly.
1590 Temporarily disabling the feature, or excluding the build
1591 output directory may be necessary to get correct and
1592 faster builds.
1593 </blockquote>
1594 </li>
1595 <li>
1596 <b>Slow Builds:</b>
1597 <blockquote>
1598 If your build machine seems to be overloaded from too many
1599 simultaneous C++ compiles, try setting the
1600 <code>JOBS=1</code> on the <code>make</code> command line.
1601 Then try increasing the count slowly to an acceptable
1602 level for your system. Also:
1603 <blockquote>
1604 Creating the javadocs can be very slow,
1605 if you are running
1606 javadoc, consider skipping that step.
1607 <br>
1608 Faster CPUs, more RAM, and a faster DISK usually helps.
1609 The VM build tends to be CPU intensive
1610 (many C++ compiles),
1611 and the rest of the JDK will often be disk intensive.
1612 <br>
1613 Faster compiles are possible using a tool called
1614 <a href="http://ccache.samba.org/" target="_blank">ccache</a>.
1615 </blockquote>
1616 </blockquote>
1617 </li>
1618 <li>
1619 <b>File time issues:</b>
1620 <blockquote>
1621 If you see warnings that refer to file time stamps, e.g.
1622 <blockquote>
1623 <i>Warning message:</i><code>
1624 File `xxx' has modification time in
1625 the future.</code>
1626 <br>
1627 <i>Warning message:</i> <code> Clock skew detected.
1628 Your build may
1629 be incomplete.</code>
1630 </blockquote>
1631 These warnings can occur when the clock on the build
1632 machine is out of
1633 sync with the timestamps on the source files.
1634 Other errors, apparently
1635 unrelated but in fact caused by the clock skew,
1636 can occur along with
1637 the clock skew warnings.
1638 These secondary errors may tend to obscure the
1639 fact that the true root cause of the problem
1640 is an out-of-sync clock.
1641 <p>
1642 If you see these warnings, reset the clock on the
1643 build
1644 machine, run "<code><i>gmake</i> clobber</code>"
1645 or delete the directory
1646 containing the build output, and restart the
1647 build from the beginning.
1648 </blockquote>
1649 </li>
1650 <li>
1651 <b>Error message:
1652 <code>Trouble writing out table to disk</code></b>
1653 <blockquote>
1654 Increase the amount of swap space on your build machine.
1655 This could be caused by overloading the system and
1656 it may be necessary to use:
1657 <blockquote>
1658 <code>make JOBS=1</code>
1659 </blockquote>
1660 to reduce the load on the system.
1661 </blockquote>
1662 </li>
1663 <li>
1664 <b>Error Message:
1665 <code>libstdc++ not found:</code></b>
1666 <blockquote>
1667 This is caused by a missing libstdc++.a library.
1668 This is installed as part of a specific package
1669 (e.g. libstdc++.so.devel.386).
1670 By default some 64-bit Linux versions (e.g. Fedora)
1671 only install the 64-bit version of the libstdc++ package.
1672 Various parts of the JDK build require a static
1673 link of the C++ runtime libraries to allow for maximum
1674 portability of the built images.
1675 </blockquote>
1676 </li>
1677 <li>
1678 <b>Linux Error Message:
1679 <code>cannot restore segment prot after reloc</code></b>
1680 <blockquote>
1681 This is probably an issue with SELinux (See
1682 <a href="http://en.wikipedia.org/wiki/SELinux" target="_blank">
1683 http://en.wikipedia.org/wiki/SELinux</a>).
1684 Parts of the VM is built without the <code>-fPIC</code> for
1685 performance reasons.
1686 <p>
1687 To completely disable SELinux:
1688 <ol>
1689 <li><code>$ su root</code></li>
1690 <li><code># system-config-securitylevel</code></li>
1691 <li><code>In the window that appears, select the SELinux tab</code></li>
1692 <li><code>Disable SELinux</code></li>
1693 </ol>
1694 <p>
1695 Alternatively, instead of completely disabling it you could
1696 disable just this one check.
1697 <ol>
1698 <li>Select System->Administration->SELinux Management</li>
1699 <li>In the SELinux Management Tool which appears,
1700 select "Boolean" from the menu on the left</li>
1701 <li>Expand the "Memory Protection" group</li>
1702 <li>Check the first item, labeled
1703 "Allow all unconfined executables to use
1704 libraries requiring text relocation ..."</li>
1705 </ol>
1706 </blockquote>
1707 </li>
1708 <li>
1709 <b>Windows Error Messages:</b>
1710 <br>
1711 <code>*** fatal error - couldn't allocate heap, ... </code>
1712 <br>
1713 <code>rm fails with "Directory not empty"</code>
1714 <br>
1715 <code>unzip fails with "cannot create ... Permission denied"</code>
1716 <br>
1717 <code>unzip fails with "cannot create ... Error 50"</code>
1718 <br>
1719 <blockquote>
1720 The CYGWIN software can conflict with other non-CYGWIN
1721 software. See the CYGWIN FAQ section on
1722 <a href="http://cygwin.com/faq/faq.using.html#faq.using.bloda" target="_blank">
1723 BLODA (applications that interfere with CYGWIN)</a>.
1724 </blockquote>
1725 </li>
1726 <li>
1727 <b>Windows Error Message: <code>spawn failed</code></b>
1728 <blockquote>
1729 Try rebooting the system, or there could be some kind of
1730 issue with the disk or disk partition being used.
1731 Sometimes it comes with a "Permission Denied" message.
1732 </blockquote>
1733 </li>
1734 </ul>
1735 </blockquote>
1736
1737 </blockquote> <!-- Troubleshooting -->
1738
1739 </blockquote> <!-- Appendix A -->
1740
1741 <!-- ====================================================== -->
1742 <hr>
1743 <h2><a name="gmake">Appendix B: GNU make</a></h2>
1744 <blockquote>
1745
1746 The Makefiles in the OpenJDK are only valid when used with the
1747 GNU version of the utility command <code>make</code>
1748 (usually called <code>gmake</code> on Solaris).
1749 A few notes about using GNU make:
1750 <ul>
1751 <li>
1752 You need GNU make version 3.81 or newer.
1753 If the GNU make utility on your systems is not
1754 3.81 or newer,
1755 see <a href="#buildgmake">"Building GNU make"</a>.
1756 </li>
1757 <li>
1758 Place the location of the GNU make binary in the
1759 <code>PATH</code>.
1760 </li>
1761 <li>
1762 <strong>Solaris:</strong>
1763 Do NOT use <code>/usr/bin/make</code> on Solaris.
1764 If your Solaris system has the software
1765 from the Solaris Developer Companion CD installed,
1766 you should try and use <code>gmake</code>
1767 which will be located in either the
1768 <code>/usr/bin</code>, <code>/opt/sfw/bin</code> or
1769 <code>/usr/sfw/bin</code> directory.
1770 </li>
1771 <li>
1772 <strong>Windows:</strong>
1773 Make sure you start your build inside a bash shell.
1774 </li>
1775 <li>
1776 <strong>Mac OS X:</strong>
1777 The XCode "command line tools" must be installed on your Mac.
1778 </li>
1779 </ul>
1780 <p>
1781 Information on GNU make, and access to ftp download sites, are
1782 available on the
1783 <a href="http://www.gnu.org/software/make/make.html" target="_blank">
1784 GNU make web site
1785 </a>.
1786 The latest source to GNU make is available at
1787 <a href="http://ftp.gnu.org/pub/gnu/make/" target="_blank">
1788 ftp.gnu.org/pub/gnu/make/</a>.
1789 </p>
1790
1791 <h3><a name="buildgmake">Building GNU make</a></h3>
1792 <blockquote>
1793 First step is to get the GNU make 3.81 or newer source from
1794 <a href="http://ftp.gnu.org/pub/gnu/make/" target="_blank">
1795 ftp.gnu.org/pub/gnu/make/</a>.
1796 Building is a little different depending on the OS but is
1797 basically done with:
1798 <blockquote>
1799 <code>bash ./configure</code>
1800 <br>
1801 <code>make</code>
1802 </blockquote>
1803 </blockquote>
1804
1805 </blockquote> <!-- Appendix B -->
1806
1807 <!-- ====================================================== -->
1808 <hr>
1809 <h2><a name="buildenvironments">Appendix C: Build Environments</a></h2>
1810 <blockquote>
1811
1812 <h3><a name="MBE">Minimum Build Environments</a></h3>
1813 <blockquote>
1814 This file often describes specific requirements for what we
1815 call the
1816 "minimum build environments" (MBE) for this
1817 specific release of the JDK.
1818 What is listed below is what the Oracle Release
1819 Engineering Team will use to build the Oracle JDK product.
1820 Building with the MBE will hopefully generate the most compatible
1821 bits that install on, and run correctly on, the most variations
1822 of the same base OS and hardware architecture.
1823 In some cases, these represent what is often called the
1824 least common denominator, but each Operating System has different
1825 aspects to it.
1826 <p>
1827 In all cases, the Bootstrap JDK version minimum is critical,
1828 we cannot guarantee builds will work with older Bootstrap JDK's.
1829 Also in all cases, more RAM and more processors is better,
1830 the minimums listed below are simply recommendations.
1831 <p>
1832 With Solaris and Mac OS X, the version listed below is the
1833 oldest release we can guarantee builds and works, and the
1834 specific version of the compilers used could be critical.
1835 <p>
1836 With Windows the critical aspect is the Visual Studio compiler
1837 used, which due to it's runtime, generally dictates what Windows
1838 systems can do the builds and where the resulting bits can
1839 be used.<br>
1840 <b>NOTE: We expect a change here off these older Windows OS releases
1841 and to a 'less older' one, probably Windows 2008R2 X64.</b>
1842 <p>
1843 With Linux, it was just a matter of picking a
1844 stable distribution that is a good representative for Linux
1845 in general.<br>
1846 <b>NOTE: We expect a change here from Fedora 9 to something else,
1847 but it has not been completely determined yet, possibly
1848 Ubuntu 12.04 X64, unbiased community feedback would be welcome on
1849 what a good choice would be here.</b>
1850 <p>
1851 It is understood that most developers will NOT be using these
1852 specific versions, and in fact creating these specific versions
1853 may be difficult due to the age of some of this software.
1854 It is expected that developers are more often using the more
1855 recent releases and distributions of these operating systems.
1856 <p>
1857 Compilation problems with newer or different C/C++ compilers is a
1858 common problem.
1859 Similarly, compilation problems related to changes to the
1860 <code>/usr/include</code> or system header files is also a
1861 common problem with older, newer, or unreleased OS versions.
1862 Please report these types of problems as bugs so that they
1863 can be dealt with accordingly.
1864 </p>
1865 <table border="1">
1866 <thead>
1867 <tr>
1868 <th>Base OS and Architecture</th>
1869 <th>OS</th>
1870 <th>C/C++ Compiler</th>
1871 <th>Bootstrap JDK</th>
1872 <th>Processors</th>
1873 <th>RAM Minimum</th>
1874 <th>DISK Needs</th>
1875 </tr>
1876 </thead>
1877 <tbody>
1878 <tr>
1879 <td>Linux X86 (32-bit) and X64 (64-bit)</td>
1880 <td>Fedora 9</td>
1881 <td>gcc 4.3 </td>
1882 <td>JDK 7u7</td>
1883 <td>2 or more</td>
1884 <td>1 GB</td>
1885 <td>6 GB</td>
1886 </tr>
1887 <tr>
1888 <td>Solaris SPARC (32-bit) and SPARCV9 (64-bit)</td>
1889 <td>Solaris 10 Update 6</td>
1890 <td>Studio 12 Update 1 + patches</td>
1891 <td>JDK 7u7</td>
1892 <td>4 or more</td>
1893 <td>4 GB</td>
1894 <td>8 GB</td>
1895 </tr>
1896 <tr>
1897 <td>Solaris X86 (32-bit) and X64 (64-bit)</td>
1898 <td>Solaris 10 Update 6</td>
1899 <td>Studio 12 Update 1 + patches</td>
1900 <td>JDK 7u7</td>
1901 <td>4 or more</td>
1902 <td>4 GB</td>
1903 <td>8 GB</td>
1904 </tr>
1905 <tr>
1906 <td>Windows X86 (32-bit)</td>
1907 <td>Windows XP</td>
1908 <td>Microsoft Visual Studio C++ 2010 Professional Edition</td>
1909 <td>JDK 7u7</td>
1910 <td>2 or more</td>
1911 <td>2 GB</td>
1912 <td>6 GB</td>
1913 </tr>
1914 <tr>
1915 <td>Windows X64 (64-bit)</td>
1916 <td>Windows Server 2003 - Enterprise x64 Edition</td>
1917 <td>Microsoft Visual Studio C++ 2010 Professional Edition</td>
1918 <td>JDK 7u7</td>
1919 <td>2 or more</td>
1920 <td>2 GB</td>
1921 <td>6 GB</td>
1922 </tr>
1923 <tr>
1924 <td>Mac OS X X64 (64-bit)</td>
1925 <td>Mac OS X 10.7 "Lion"</td>
1926 <td>XCode 4.5.2 or newer</td>
1927 <td>JDK 7u7</td>
1928 <td>2 or more</td>
1929 <td>4 GB</td>
1930 <td>6 GB</td>
1931 </tr>
1932 </tbody>
1933 </table>
1934 </blockquote>
1935
1936 <!-- ====================================================== -->
1937 <hr>
1938 <h3><a name="SDBE">Specific Developer Build Environments</a></h3>
1939 <blockquote>
1940 We won't be listing all the possible environments, but
1941 we will try to provide what information we have available to us.
1942 <p>
1943 <strong>NOTE: The community can help out by updating
1944 this part of the document.
1945 </strong>
1946
1947 <h4><a name="fedora">Fedora</a></h4>
1948 <blockquote>
1949 After installing the latest
1950 <a href="http://fedoraproject.org">Fedora</a>
1951 you need to install several build dependencies.
1952 The simplest way to do it is to execute the
1953 following commands as user <code>root</code>:
1954 <blockquote>
1955 <code>yum-builddep java-1.7.0-openjdk</code>
1956 <br>
1957 <code>yum install gcc gcc-c++</code>
1958 </blockquote>
1959 <p>
1960 In addition, it's necessary to set a few environment
1961 variables for the build:
1962 <blockquote>
1963 <code>export LANG=C</code>
1964 <br>
1965 <code>export PATH="/usr/lib/jvm/java-openjdk/bin:${PATH}"</code>
1966 </blockquote>
1967 </blockquote>
1968
1969
1970 <h4><a name="centos">CentOS 5.5</a></h4>
1971 <blockquote>
1972 After installing
1973 <a href="http://www.centos.org/">CentOS 5.5</a>
1974 you need to make sure you have
1975 the following Development bundles installed:
1976 <blockquote>
1977 <ul>
1978 <li>Development Libraries</li>
1979 <li>Development Tools</li>
1980 <li>Java Development</li>
1981 <li>X Software Development (Including XFree86-devel)</li>
1982 </ul>
1983 </blockquote>
1984 <p>
1985 Plus the following packages:
1986 <blockquote>
1987 <ul>
1988 <li>cups devel: Cups Development Package</li>
1989 <li>alsa devel: Alsa Development Package</li>
1990 <li>Xi devel: libXi.so Development Package</li>
1991 </ul>
1992 </blockquote>
1993 <p>
1994 The freetype 2.3 packages don't seem to be available,
1995 but the freetype 2.3 sources can be downloaded, built,
1996 and installed easily enough from
1997 <a href="http://downloads.sourceforge.net/freetype">
1998 the freetype site</a>.
1999 Build and install with something like:
2000 <blockquote>
2001 <code>bash ./configure</code>
2002 <br>
2003 <code>make</code>
2004 <br>
2005 <code>sudo -u root make install</code>
2006 </blockquote>
2007 <p>
2008 Mercurial packages could not be found easily, but a Google
2009 search should find ones, and they usually include Python if
2010 it's needed.
2011 </blockquote>
2012
2013 <h4><a name="debian">Debian 5.0 (Lenny)</a></h4>
2014 <blockquote>
2015 After installing <a href="http://debian.org">Debian</a> 5
2016 you need to install several build dependencies.
2017 The simplest way to install the build dependencies is to
2018 execute the following commands as user <code>root</code>:
2019 <blockquote>
2020 <code>aptitude build-dep openjdk-7</code>
2021 <br>
2022 <code>aptitude install openjdk-7-jdk libmotif-dev</code>
2023 </blockquote>
2024 <p>
2025 In addition, it's necessary to set a few environment
2026 variables for the build:
2027 <blockquote>
2028 <code>export LANG=C</code>
2029 <br>
2030 <code>export PATH="/usr/lib/jvm/java-7-openjdk/bin:${PATH}"</code>
2031 </blockquote>
2032 </blockquote>
2033
2034 <h4><a name="ubuntu">Ubuntu 12.04</a></h4>
2035 <blockquote>
2036 After installing <a href="http://ubuntu.org">Ubuntu</a> 12.04
2037 you need to install several build dependencies. The simplest
2038 way to do it is to execute the following commands:
2039 <blockquote>
2040 <code>sudo aptitude build-dep openjdk-7</code>
2041 <br>
2042 <code>sudo aptitude install openjdk-7-jdk</code>
2043 </blockquote>
2044 <p>
2045 In addition, it's necessary to set a few environment
2046 variables for the build:
2047 <blockquote>
2048 <code>export LANG=C</code>
2049 <br>
2050 <code>export PATH="/usr/lib/jvm/java-7-openjdk/bin:${PATH}"</code>
2051 </blockquote>
2052 </blockquote>
2053
2054 <h4><a name="opensuse">OpenSUSE 11.1</a></h4>
2055 <blockquote>
2056 After installing <a href="http://opensuse.org">OpenSUSE</a> 11.1
2057 you need to install several build dependencies.
2058 The simplest way to install the build dependencies is to
2059 execute the following commands:
2060 <blockquote>
2061 <code>sudo zypper source-install -d java-1_7_0-openjdk</code>
2062 <br>
2063 <code>sudo zypper install make</code>
2064 </blockquote>
2065 <p>
2066 In addition, it is necessary to set a few environment
2067 variables for the build:
2068 <blockquote>
2069 <code>export LANG=C</code>
2070 <br>
2071 <code>export PATH="/usr/lib/jvm/java-1.7.0-openjdk/bin:$[PATH}"</code>
2072 </blockquote>
2073 <p>
2074 Finally, you need to unset the <code>JAVA_HOME</code>
2075 environment variable:
2076 <blockquote>
2077 <code>export -n JAVA_HOME</code>
2078 </blockquote>
2079 </blockquote>
2080
2081 <h4><a name="mandriva">Mandriva Linux One 2009 Spring</a></h4>
2082 <blockquote>
2083 After installing <a href="http://mandriva.org">Mandriva</a>
2084 Linux One 2009 Spring
2085 you need to install several build dependencies.
2086 The simplest way to install the build dependencies is to
2087 execute the following commands as user <code>root</code>:
2088 <blockquote>
2089 <code>urpmi java-1.7.0-openjdk-devel make gcc gcc-c++
2090 freetype-devel zip unzip libcups2-devel libxrender1-devel
2091 libalsa2-devel libstc++-static-devel libxtst6-devel
2092 libxi-devel</code>
2093 </blockquote>
2094 <p>
2095 In addition, it is necessary to set a few environment
2096 variables for the build:
2097 <blockquote>
2098 <code>export LANG=C</code>
2099 <br>
2100 <code>export PATH="/usr/lib/jvm/java-1.7.0-openjdk/bin:${PATH}"</code>
2101 </blockquote>
2102 </blockquote>
2103
2104 <h4><a name="opensolaris">OpenSolaris 2009.06</a></h4>
2105 <blockquote>
2106 After installing <a href="http://opensolaris.org">OpenSolaris</a> 2009.06
2107 you need to install several build dependencies.
2108 The simplest way to install the build dependencies is to
2109 execute the following commands:
2110 <blockquote>
2111 <code>pfexec pkg install SUNWgmake SUNWj7dev
2112 sunstudioexpress SUNWcups SUNWzip SUNWunzip SUNWxwhl
2113 SUNWxorg-headers SUNWaudh SUNWfreetype2</code>
2114 </blockquote>
2115 <p>
2116 In addition, it is necessary to set a few environment
2117 variables for the build:
2118 <blockquote>
2119 <code>export LANG=C</code>
2120 <br>
2121 <code>export PATH="/opt/SunStudioExpress/bin:${PATH}"</code>
2122 </blockquote>
2123 </blockquote>
2124
2125 </blockquote>
2126
2127 </blockquote> <!-- Appendix C -->
2128
2129 <!-- ====================================================== -->
2130
2131 <!-- Leave out Appendix D --
2132
2133 <hr>
2134 <h2><a name="mapping">Appendix D: Mapping Old to New</a></h2>
2135 <blockquote>
2136 <p>This table will help you convert some idioms of the old build
2137 system to the new build system.</p>
2138 <table summary="Cheat sheet for converting from old to new build system">
2139 <tr valign="top">
2140 <th>In the old build system, you used to...</th>
2141 <th>In the new build system, you should ...</th>
2142 </tr>
2143 <tr valign="top">
2144 <td>run <code>make sanity</code></td>
2145 <td>run <code>bash ./configure</code></td>
2146 </tr>
2147 <tr valign="top">
2148 <td>set <code>ALT_OUTPUTDIR=build/my-special-output</code></td>
2149 <td>before building the first time:
2150 <br>
2151 <code>cd build/my-special-output</code>
2152 <br>
2153 <code>bash ../../configure</code>
2154 <br>
2155 to build:
2156 <br>
2157 <code>cd build/my-special-output</code>
2158 <br>
2159 <code>make</code>
2160 </td>
2161 </tr>
2162 <tr valign="top">
2163 <td>set <code>ALT_BOOTDIR=/opt/java/jdk7</code></td>
2164 <td>run <code>configure --with-boot-jdk=/opt/java/jdk7</code></td>
2165 </tr>
2166 <tr valign="top">
2167 <td>run <code>make ARCH_DATA_MODEL=32</code></td>
2168 <td>run <code>configure --with-target-bits=32</code></td>
2169 </tr>
2170 <tr valign="top">
2171 <td>set <code>BUILD_CLIENT_ONLY=true</code></td>
2172 <td>run <code>configure --with-jvm-variants=client</code></td>
2173 </tr>
2174 <tr valign="top">
2175 <td>set <code>ALT_FREETYPE_LIB_PATH=/opt/freetype/lib</code>
2176 and <code>ALT_FREETYPE_HEADERS_PATH=/opt/freetype/include</code></td>
2177 <td>run <code>configure --with-freetype=/opt/freetype</code></td>
2178 </tr>
2179 <tr valign="top">
2180 <td>set <code>ALT_CUPS_HEADERS_PATH=/opt/cups/include</code></td>
2181 <td>run <code>configure --with-cups=/opt/cups</code></td>
2182 </tr>
2183 <tr valign="top">
2184 <td>set <code>ALT_OPENWIN_HOME=/opt/X11R6</code></td>
2185 <td>run <code>configure --with-x=/opt/X11R6</code></td>
2186 </tr>
2187 <tr valign="top">
2188 <td>set <code>ALT_MSVCRNN_DLL_PATH=c:/vc_redist</code></td>
2189 <td>run <code>configure --with-msvcr100dll=/cygdrive/c/vc_redist</code></td>
2190 </tr>
2191 <tr valign="top">
2192 <td>set <code>ALT_COMPILER_PATH=/opt/my-gcc/bin/gcc</code></td>
2193 <td>run <code>CC=/opt/my-gcc/bin/gcc configure</code>
2194 or <code>CXX=/opt/my-gcc/bin/g++ configure</code>
2195 </td>
2196 </tr>
2197 <tr valign="top">
2198 <td>set <code>BUILD_HEADLESS_ONLY=true</code></td>
2199 <td>run <code>configure --disable-headful</code></td>
2200 </tr>
2201 <tr valign="top">
2202 <td>set <code>ALT_DEVTOOLS_PATH=/opt/mytools</code></td>
2203 <td>just run <code>configure</code>,
2204 your tools should be detected automatically.
2205 If you have an unusual configuration,
2206 add the tools directory to your <code>PATH</code>.
2207 </td>
2208 </tr>
2209 <tr valign="top">
2210 <td>set <code>ALT_DROPS_DIR=/home/user/dropdir</code></td>
2211 <td>source drops are not used anymore</td>
2212 </tr>
2213 <tr valign="top">
2214 <td>set <code>USE_ONLY_BOOTDIR_TOOLS=true</code></td>
2215 <td>not needed, <code>configure</code> should always do the Right Thing automatically</td>
2216 </tr>
2217 <tr valign="top">
2218 <td>set <code>ALT_JDK_IMPORT_PATH=/opt/java/import-jdk</code>
2219 or <code>ALT_BUILD_JDK_IMPORT_PATH=/opt/java/import-jdk</code>
2220 </td>
2221 <td>Importing JDKs is no longer possible,
2222 but hotspot can be imported using
2223 <code>--with-import-hotspot</code>.
2224 Documentation on how to achieve a
2225 similar solution will come soon!
2226 </td>
2227 </tr>
2228 <tr valign="top">
2229 <td>set <code>EXTRA_CFLAGS=-Xfoo</code></td>
2230 <td>run <code>CFLAGS=-Xfoo configure</code></td>
2231 </tr>
2232 <tr valign="top">
2233 <td>set <code>CROSS_COMPILE_ARCH=i586</code></td>
2234 <td>see <a href="#sec7.3"> section 7.3, Cross-compilation</a></td>
2235 </tr>
2236 <tr valign="top">
2237 <td>set <code>SKIP_BOOT_CYCLE=false</code></td>
2238 <td>Run <code>make bootcycle-images</code>.</td>
2239 </tr>
2240 </table>
2241
2242 <h3><a name="variables">Environment/Make Variables</a></h3>
2243 <p>
2244 Some of the
2245 environment or make variables (just called <b>variables</b> in this
2246 document) that can impact the build are:
2247 <blockquote>
2248 <dl>
2249 <dt><a name="path"><code>PATH</code></a> </dt>
2250 <dd>Typically you want to set the <code>PATH</code> to include:
2251 <ul>
2252 <li>The location of the GNU make binary</li>
2253 <li>The location of the Bootstrap JDK <code>java</code>
2254 (see <a href="#bootjdk">Bootstrap JDK</a>)</li>
2255 <li>The location of the C/C++ compilers
2256 (see <a href="#compilers"><code>compilers</code></a>)</li>
2257 <li>The location or locations for the Unix command utilities
2258 (e.g. <code>/usr/bin</code>)</li>
2259 </ul>
2260 </dd>
2261 <dt><code>MILESTONE</code> </dt>
2262 <dd>
2263 The milestone name for the build (<i>e.g.</i>"beta").
2264 The default value is "internal".
2265 </dd>
2266 <dt><code>BUILD_NUMBER</code> </dt>
2267 <dd>
2268 The build number for the build (<i>e.g.</i> "b27").
2269 The default value is "b00".
2270 </dd>
2271 <dt><a name="arch_data_model"><code>ARCH_DATA_MODEL</code></a></dt>
2272 <dd>The <code>ARCH_DATA_MODEL</code> variable
2273 is used to specify whether the build is to generate 32-bit or 64-bit
2274 binaries.
2275 The Solaris build supports either 32-bit or 64-bit builds, but
2276 Windows and Linux will support only one, depending on the specific
2277 OS being used.
2278 Normally, setting this variable is only necessary on Solaris.
2279 Set <code>ARCH_DATA_MODEL</code> to <code>32</code> for generating 32-bit binaries,
2280 or to <code>64</code> for generating 64-bit binaries.
2281 </dd>
2282 <dt><a name="ALT_BOOTDIR"><code>ALT_BOOTDIR</code></a></dt>
2283 <dd>
2284 The location of the bootstrap JDK installation.
2285 See <a href="#bootjdk">Bootstrap JDK</a> for more information.
2286 You should always install your own local Bootstrap JDK and
2287 always set <code>ALT_BOOTDIR</code> explicitly.
2288 </dd>
2289 <dt><a name="ALT_OUTPUTDIR"><code>ALT_OUTPUTDIR</code></a> </dt>
2290 <dd>
2291 An override for specifying the (absolute) path of where the
2292 build output is to go.
2293 The default output directory will be build/<i>platform</i>.
2294 </dd>
2295 <dt><a name="ALT_COMPILER_PATH"><code>ALT_COMPILER_PATH</code></a> </dt>
2296 <dd>
2297 The location of the C/C++ compiler.
2298 The default varies depending on the platform.
2299 </dd>
2300 <dt><code><a name="ALT_CACERTS_FILE">ALT_CACERTS_FILE</a></code></dt>
2301 <dd>
2302 The location of the <a href="#cacerts">cacerts</a> file.
2303 The default will refer to
2304 <code>jdk/src/share/lib/security/cacerts</code>.
2305 </dd>
2306 <dt><a name="ALT_CUPS_HEADERS_PATH"><code>ALT_CUPS_HEADERS_PATH</code></a> </dt>
2307 <dd>
2308 The location of the CUPS header files.
2309 See <a href="#cups">CUPS information</a> for more information.
2310 If this path does not exist the fallback path is
2311 <code>/usr/include</code>.
2312 </dd>
2313 <dt><a name="ALT_FREETYPE_LIB_PATH"><code>ALT_FREETYPE_LIB_PATH</code></a></dt>
2314 <dd>
2315 The location of the FreeType shared library.
2316 See <a href="#freetype">FreeType information</a> for details.
2317 </dd>
2318 <dt><a name="ALT_FREETYPE_HEADERS_PATH"><code>ALT_FREETYPE_HEADERS_PATH</code></a></dt>
2319 <dd>
2320 The location of the FreeType header files.
2321 See <a href="#freetype">FreeType information</a> for details.
2322 </dd>
2323 <dt><a name="ALT_JDK_DEVTOOLS_PATH"><code>ALT_JDK_DEVTOOLS_PATH</code></a></dt>
2324 <dd>
2325 The default root location of the devtools.
2326 The default value is
2327 <code>$(ALT_SLASH_JAVA)/devtools</code>.
2328 </dd>
2329 <dt><code><a name="ALT_DEVTOOLS_PATH">ALT_DEVTOOLS_PATH</a></code> </dt>
2330 <dd>
2331 The location of tools like the
2332 <a href="#zip"><code>zip</code> and <code>unzip</code></a>
2333 binaries, but might also contain the GNU make utility
2334 (<code><i>gmake</i></code>).
2335 So this area is a bit of a grab bag, especially on Windows.
2336 The default value depends on the platform and
2337 Unix Commands being used.
2338 On Linux the default will be
2339 <code>$(ALT_JDK_DEVTOOLS_PATH)/linux/bin</code>,
2340 on Solaris
2341 <code>$(ALT_JDK_DEVTOOLS_PATH)/<i>{sparc,i386}</i>/bin</code>,
2342 and on Windows with CYGWIN
2343 <code>/usr/bin</code>.
2344 </dd>
2345 <dt><a name="ALT_UNIXCCS_PATH"><code>ALT_UNIXCCS_PATH</code></a></dt>
2346 <dd>
2347 <strong>Solaris only:</strong>
2348 An override for specifying where the Unix CCS
2349 command set are located.
2350 The default location is <code>/usr/ccs/bin</code>
2351 </dd>
2352 <dt><a name="ALT_SLASH_JAVA"><code>ALT_SLASH_JAVA</code></a></dt>
2353 <dd>
2354 The default root location for many of the ALT path locations
2355 of the following ALT variables.
2356 The default value is
2357 <code>"/java"</code> on Solaris and Linux,
2358 <code>"J:"</code> on Windows.
2359 </dd>
2360
2361 <dt><a name="ALT_OPENWIN_HOME"><code>ALT_OPENWIN_HOME</code></a></dt>
2362 <dd>
2363 The top-level directory of the libraries and include files
2364 for the platform's
2365 graphical programming environment.
2366 The default location is platform specific.
2367 For example, on Linux it defaults to <code>/usr/X11R6/</code>.
2368 </dd>
2369 <dt><strong>Windows specific:</strong></dt>
2370 <dd>
2371 <dl>
2372 <dt><a name="ALT_WINDOWSSDKDIR"><code>ALT_WINDOWSSDKDIR</code></a> </dt>
2373 <dd>
2374 The location of the
2375 Microsoft Windows SDK where some tools will be
2376 located.
2377 The default is whatever WINDOWSSDKDIR is set to
2378 (or WindowsSdkDir) or the path
2379 <br>
2380 <code>c:\Program Files\Microsoft SDKs\Windows\v7.0a</code>
2381 </dd>
2382 <dt><code><a name="ALT_DXSDK_PATH">ALT_DXSDK_PATH</a></code> </dt>
2383 <dd>
2384 The location of the
2385 <a href="#dxsdk">Microsoft DirectX 9 SDK</a>.
2386 The default will be to try and use the DirectX environment
2387 variable <code>DXSDK_DIR</code>,
2388 failing that, look in <code>C:/DXSDK</code>.
2389 </dd>
2390 <dt><code><a name="ALT_MSVCRNN_DLL_PATH">ALT_MSVCRNN_DLL_PATH</a></code> </dt>
2391 <dd>
2392 The location of the
2393 <a href="#msvcrNN"><code>MSVCR100.DLL</code></a>.
2394 </dd>
2395 </dl>
2396 </dd>
2397 <dt><strong>Cross-Compilation Support:</strong></dt>
2398 <dd>
2399 <dl>
2400 <dt><a name="CROSS_COMPILE_ARCH"><code>CROSS_COMPILE_ARCH</code></a> </dt>
2401 <dd>
2402 Set to the target architecture of a
2403 cross-compilation build. If set, this
2404 variable is used to signify that we are
2405 cross-compiling. The expectation
2406 is that
2407 <a href="#ALT_COMPILER_PATH"><code>ALT_COMPILER_PATH</code></a>
2408 is set
2409 to point to the cross-compiler and that any
2410 cross-compilation specific flags
2411 are passed using
2412 <a href="#EXTRA_CFLAGS"><code>EXTRA_CFLAGS</code></a>.
2413 The <a href="#ALT_OPENWIN_HOME"><code>ALT_OPENWIN_HOME</code></a>
2414 variable should
2415 also be set to point to the graphical header files
2416 (e.g. X11) provided with
2417 the cross-compiler.
2418 When cross-compiling we skip execution of any demos
2419 etc that may be built, and
2420 also skip binary-file verification.
2421 </dd>
2422 <dt><code><a name="EXTRA_CFLAGS">EXTRA_CFLAGS</a></code> </dt>
2423 <dd>
2424 Used to pass cross-compilation options to the
2425 cross-compiler.
2426 These are added to the <code>CFLAGS</code>
2427 and <code>CXXFLAGS</code> variables.
2428 </dd>
2429 <dt><code><a name="USE_ONLY_BOOTDIR_TOOLS">USE_ONLY_BOOTDIR_TOOLS</a></code> </dt>
2430 <dd>
2431 Used primarily for cross-compilation builds
2432 (and always set in that case)
2433 this variable indicates that tools from the
2434 boot JDK should be used during
2435 the build process, not the tools
2436 (<code>javac</code>, <code>javah</code>, <code>jar</code>)
2437 just built (which can't execute on the build host).
2438 </dd>
2439 <dt><code><a name="HOST_CC">HOST_CC</a></code> </dt>
2440 <dd>
2441 The location of the C compiler to generate programs
2442 to run on the build host.
2443 Some parts of the build generate programs that are
2444 then compiled and executed
2445 to produce other parts of the build. Normally the
2446 primary C compiler is used
2447 to do this, but when cross-compiling that would be
2448 the cross-compiler and the
2449 resulting program could not be executed.
2450 On Linux this defaults to <code>/usr/bin/gcc</code>;
2451 on other platforms it must be
2452 set explicitly.
2453 </dd>
2454 </dl>
2455 <dt><strong>Specialized Build Options:</strong></dt>
2456 <dd>
2457 Some build variables exist to support specialized build
2458 environments and/or specialized
2459 build products. Their use is only supported in those contexts:
2460 <dl>
2461 <dt><code><a name="BUILD_CLIENT_ONLY">BUILD_CLIENT_ONLY</a></code> </dt>
2462 <dd>
2463 Indicates this build will only contain the
2464 Hotspot client VM. In addition to
2465 controlling the Hotspot build target,
2466 it ensures that we don't try to copy
2467 any server VM files/directories,
2468 and defines a default <code>jvm.cfg</code> file
2469 suitable for a client-only environment.
2470 Using this in a 64-bit build will
2471 generate a sanity warning as 64-bit client
2472 builds are not directly supported.
2473 </dd>
2474 <dt><code><a name="BUILD_HEADLESS_ONLY"></a>BUILD_HEADLESS_ONLY</code> </dt>
2475 <dd>
2476 Used when the build environment has no graphical
2477 capabilities at all. This
2478 excludes building anything that requires graphical
2479 libraries to be available.
2480 </dd>
2481 <dt><code><a name="JAVASE_EMBEDDED"></a>JAVASE_EMBEDDED</code> </dt>
2482 <dd>
2483 Used to indicate this is a build of the Oracle
2484 Java SE Embedded product.
2485 This will enable the directives included in the
2486 SE-Embedded specific build
2487 files.
2488 </dd>
2489 <dt><code><a name="LIBZIP_CAN_USE_MMAP">LIBZIP_CAN_USE_MMAP</a></code> </dt>
2490 <dd>
2491 If set to false, disables the use of mmap by the
2492 zip utility. Otherwise,
2493 mmap will be used.
2494 </dd>
2495 <dt><code><a name="COMPRESS_JARS"></a>COMPRESS_JARS</code> </dt>
2496 <dd>
2497 If set to true, causes certain jar files that
2498 would otherwise be built without
2499 compression, to use compression.
2500 </dd>
2501 </dl>
2502 </dd>
2503 </dl>
2504 </blockquote>
2505
2506 </blockquote> <!-- Appendix D -->
2507
2508 <!-- ====================================================== -->
2509 <hr>
2510 <p>End of OpenJDK README-builds.html document.<br>Please come again!
2511 <hr>
2512
2513 </body>
2514 </html>