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