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