Thu, 04 Oct 2012 14:34:31 -0700
Added tag jdk8-b59 for changeset dae9821589cc
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:lightcyan">
7 <!-- ====================================================== -->
8 <table width="100%">
9 <tr>
10 <td align="center">
11 <img alt="OpenJDK"
12 src="http://openjdk.java.net/images/openjdk.png"
13 width=256 />
14 </td>
15 </tr>
16 <tr>
17 <td align=center>
18 <h1>OpenJDK Build README</h1>
19 </td>
20 </tr>
21 </table>
22 <!-- ------------------------------------------------------ -->
23 <hr>
24 <h2><a name="introduction">Introduction</a></h2>
25 <blockquote>
26 <p>
27 This README file contains build instructions for the
28 <a href="http://openjdk.java.net" target="_blank">OpenJDK</a>.
29 Building the source code for the
30 OpenJDK
31 requires
32 a certain degree of technical expertise.
33 </blockquote>
34 <!-- ------------------------------------------------------ -->
35 <hr>
36 <h2><a name="contents">Contents</a></h2>
37 <blockquote>
38 <ul>
39 <li><a href="#introduction">Introduction</a></li>
40 <li><a href="#hg">Use of Mercurial</a>
41 <ul>
42 <li><a href="#get_source">Getting the Source</a></li>
43 </ul>
44 </li>
45 <li><a href="#MBE">Minimum Build Environments</a></li>
46 <li><a href="#SDBE">Specific Developer Build Environments</a>
47 <ul>
48 <li><a href="#fedora">Fedora Linux</a> </li>
49 <li><a href="#centos">CentOS Linux</a> </li>
50 <li><a href="#debian">Debian GNU/Linux</a></li>
51 <li><a href="#ubuntu">Ubuntu Linux</a> </li>
52 <li><a href="#opensuse">OpenSUSE</a></li>
53 <li><a href="#mandriva">Mandriva</a></li>
54 <li><a href="#opensolaris">OpenSolaris</a></li>
55 </ul>
56 </li>
57 <li><a href="#directories">Source Directory Structure</a>
58 <ul>
59 <li><a href="#drops">Managing the Source Drops</a></li>
60 </ul>
61 </li>
62 <li><a href="#building">Build Information</a>
63 <ul>
64 <li><a href="#gmake">GNU Make (<tt><i>gmake</i></tt>)</a> </li>
65 <li><a href="#linux">Basic Linux System Setup</a> </li>
66 <li><a href="#solaris">Basic Solaris System Setup</a> </li>
67 <li><a href="#windows">Basic Windows System Setup</a> </li>
68 <li><a href="#macosx">Basic Mac OS X System Setup</a></li>
69 <li><a href="#dependencies">Build Dependencies</a>
70 <ul>
71 <li><a href="#bootjdk">Bootstrap JDK</a> </li>
72 <li><a href="#importjdk">Optional Import JDK</a> </li>
73 <li><a href="#ant">Ant 1.7.1</a> </li>
74 <li><a href="#cacerts">Certificate Authority File (cacert)</a> </li>
75 <li><a href="#compilers">Compilers</a>
76 <ul>
77 <li><a href="#msvc32">Microsoft Visual Studio Professional/Express for 32 bit</a> </li>
78 <li><a href="#msvc64">Microsoft Visual Studio Professional for 64 bit</a> </li>
79 <li><a href="#mssdk64">Microsoft Windows SDK for 64 bit</a> </li>
80 <li><a href="#gcc">Linux gcc/binutils</a> </li>
81 <li><a href="#studio">Sun Studio</a> </li>
82 </ul>
83 </li>
84 <li><a href="#zip">Zip and Unzip</a> </li>
85 <li><a href="#freetype">FreeType2 Fonts</a> </li>
86 <li>Linux and Solaris:
87 <ul>
88 <li><a href="#cups">CUPS Include files</a> </li>
89 <li><a href="#xrender">XRender Include files</a></li>
90 </ul>
91 </li>
92 <li>Linux only:
93 <ul>
94 <li><a href="#alsa">ALSA files</a> </li>
95 </ul>
96 </li>
97 <li>Windows only:
98 <ul>
99 <li>Unix Command Tools (<a href="#cygwin">CYGWIN</a>)</li>
100 <li><a href="#dxsdk">DirectX 9.0 SDK</a> </li>
101 </ul>
102 </li>
103 </ul>
104 </li>
105 </ul>
106 </li>
107 <li><a href="#creating">Creating the Build</a> </li>
108 <li><a href="#testing">Testing the Build</a> </li>
109 <li><a href="#variables">Environment/Make Variables</a></li>
110 <li><a href="#troubleshooting">Troubleshooting</a></li>
111 <li><a href="#newbuild">The New Build</a></li>
112 </ul>
113 </blockquote>
115 <!-- ------------------------------------------------------ -->
116 <hr>
117 <h2><a name="hg">Use of Mercurial</a></h2>
118 <blockquote>
119 The OpenJDK sources are maintained with the revision control system
120 <a href="http://mercurial.selenic.com/wiki/Mercurial">Mercurial</a>.
121 If you are new to Mercurial, please see the
122 <a href="http://mercurial.selenic.com/wiki/BeginnersGuides">Beginner Guides</a>
123 or refer to the <a href="http://hgbook.red-bean.com/">Mercurial Book</a>.
124 The first few chapters of the book provide an excellent overview of
125 Mercurial, what it is and how it works.
126 <br>
127 For using Mercurial with the OpenJDK refer to the
128 <a href="http://openjdk.java.net/guide/repositories.html#installConfig">
129 Developer Guide: Installing and Configuring Mercurial</a>
130 section for more information.
132 <!-- ------------------------------------------------------ -->
133 <h3><a name="get_source">Getting the Source</a></h3>
134 <blockquote>
135 To get the entire set of OpenJDK Mercurial repositories
136 use the script <code>get_source.sh</code> located in the root repository:
137 <blockquote>
138 <tt>
139 hg clone http://hg.openjdk.java.net/jdk8/jdk8 <i>YourOpenJDK</i>
140 <br>cd <i>YourOpenJDK</i>
141 <br>sh ./get_source.sh
142 </tt>
143 </blockquote>
144 Once you have all the repositories, the
145 script <tt>make/scripts/hgforest.sh</tt>
146 can be used to repeat the same <tt>hg</tt>
147 command on every repository in the forest, e.g.
148 <blockquote>
149 <tt>
150 cd <i>YourOpenJDK</i>
151 <br>sh ./make/scripts/hgforest.sh pull -u
152 </tt>
153 </blockquote>
154 </blockquote>
156 </blockquote>
158 <!-- ------------------------------------------------------ -->
159 <hr>
160 <h2><a name="MBE">Minimum Build Environments</a></h2>
161 <blockquote>
162 This file often describes specific requirements for what we call the
163 "minimum build environments" (MBE) for this
164 specific release of the JDK,
165 Building with the MBE will generate the most compatible
166 bits that install on, and run correctly on, the most variations
167 of the same base OS and hardware architecture.
168 These usually represent what is often called the
169 least common denominator platforms.
170 It is understood that most developers will NOT be using these
171 specific platforms, and in fact creating these specific platforms
172 may be difficult due to the age of some of this software.
173 <p>
174 The minimum OS and C/C++ compiler versions needed for building the
175 OpenJDK:
176 <p>
177 <table border="1">
178 <thead>
179 <tr>
180 <th>Base OS and Architecture</th>
181 <th>OS</th>
182 <th>C/C++ Compiler</th>
183 <th>BOOT JDK</th>
184 </tr>
185 </thead>
186 <tbody>
187 <tr>
188 <td>Linux X86 (32-bit)</td>
189 <td>Fedora 9</td>
190 <td>gcc 4.3 </td>
191 <td>JDK 6u18</td>
192 </tr>
193 <tr>
194 <td>Linux X64 (64-bit)</td>
195 <td>Fedora 9</td>
196 <td>gcc 4.3 </td>
197 <td>JDK 6u18</td>
198 </tr>
199 <tr>
200 <td>Solaris SPARC (32-bit)</td>
201 <td>Solaris 10 Update 6</td>
202 <td>Sun Studio 12 Update 1 + patches</td>
203 <td>JDK 6u18</td>
204 </tr>
205 <tr>
206 <td>Solaris SPARCV9 (64-bit)</td>
207 <td>Solaris 10 Update 6</td>
208 <td>Sun Studio 12 Update 1 + patches</td>
209 <td>JDK 6u18</td>
210 </tr>
211 <tr>
212 <td>Solaris X86 (32-bit)</td>
213 <td>Solaris 10 Update 6</td>
214 <td>Sun Studio 12 Update 1 + patches</td>
215 <td>JDK 6u18</td>
216 </tr>
217 <tr>
218 <td>Solaris X64 (64-bit)</td>
219 <td>Solaris 10 Update 6</td>
220 <td>Sun Studio 12 Update 1 + patches</td>
221 <td>JDK 6u18</td>
222 </tr>
223 <tr>
224 <td>Windows X86 (32-bit)</td>
225 <td>Windows XP</td>
226 <td>Microsoft Visual Studio C++ 2010 Professional Edition</td>
227 <td>JDK 6u18</td>
228 </tr>
229 <tr>
230 <td>Windows X64 (64-bit)</td>
231 <td>Windows Server 2003 - Enterprise x64 Edition</td>
232 <td>Microsoft Visual Studio C++ 2010 Professional Edition</td>
233 <td>JDK 6u18</td>
234 </tr>
235 <tr>
236 <td>Mac OS X X64 (64-bit)</td>
237 <td>Mac OS X 10.7.3 "Lion"</td>
238 <td>XCode 4.1 or later</td>
239 <td>Java for OS X Lion Update 1</td>
240 </tr>
241 </tbody>
242 </table>
243 <p>
244 These same sources do indeed build on many more systems than the
245 above older generation systems, again the above is just a minimum.
246 <p>
247 Compilation problems with newer or different C/C++ compilers is a
248 common problem.
249 Similarly, compilation problems related to changes to the
250 <tt>/usr/include</tt> or system header files is also a
251 common problem with newer or unreleased OS versions.
252 Please report these types of problems as bugs so that they
253 can be dealt with accordingly.
254 </blockquote>
255 <!-- ------------------------------------------------------ -->
256 <hr>
257 <h2><a name="SDBE">Specific Developer Build Environments</a></h2>
258 <blockquote>
259 We won't be listing all the possible environments, but
260 we will try to provide what information we have available to us.
261 </blockquote>
262 <!-- ------------------------------------------------------ -->
263 <h3><a name="fedora">Fedora</a></h3>
264 <blockquote>
265 <h4>Fedora 9</h4>
266 <p>
267 <blockquote>
268 After installing <a href="http://fedoraproject.org">Fedora</a> 9
269 you need to install several build dependencies. The simplest
270 way to do it is to execute the following commands as user
271 <tt>root</tt>:
272 <p/>
273 <code>yum-builddep java-1.6.0-openjdk</code>
274 <p/>
275 <code>yum install gcc gcc-c++</code>
276 <p/>
277 In addition, it's necessary to set a few environment variables for the build:
279 <p/>
280 <code>export LANG=C ALT_BOOTDIR=/usr/lib/jvm/java-openjdk</code>
281 </blockquote>
282 <h4>Fedora 10</h4>
283 <p>
284 <blockquote>
285 After installing <a href="http://fedoraproject.org">Fedora</a> 10
286 you need to install several build dependencies. The simplest
287 way to do it is to execute the following commands as user
288 <tt>root</tt>:
289 <p/>
290 <code>yum-builddep java-1.6.0-openjdk</code>
291 <p/>
292 <code>yum install gcc gcc-c++</code>
293 <p/>
294 In addition, it's necessary to set a few environment variables for the build:
296 <p/>
297 <code>export LANG=C ALT_BOOTDIR=/usr/lib/jvm/java-openjdk</code>
298 </blockquote>
299 <h4>Fedora 11</h4>
300 <p>
301 <blockquote>
302 After installing <a href="http://fedoraproject.org">Fedora</a> 11
303 you need to install several build dependencies. The simplest
304 way to do it is to execute the following commands as user
305 <tt>root</tt>:
306 <p/>
307 <code>yum-builddep java-1.6.0-openjdk</code>
308 <p/>
309 <code>yum install gcc gcc-c++</code>
310 <p/>
311 In addition, it's necessary to set a few environment variables for the build:
313 <p/>
314 <code>export LANG=C ALT_BOOTDIR=/usr/lib/jvm/java-openjdk</code>
315 </blockquote>
316 </blockquote>
317 <!-- ------------------------------------------------------ -->
318 <h3><a name="centos">CentOS 5.5</a></h3>
319 <blockquote>
320 After installing
321 <a href="http://www.centos.org/">CentOS 5.5</a>
322 you need to make sure you have
323 the following Development bundles installed:
324 <blockquote>
325 <ul>
326 <li>Development Libraries</li>
327 <li>Development Tools</li>
328 <li>Java Development</li>
329 <li>X Software Development (Including XFree86-devel)</li>
330 </ul>
331 </blockquote>
332 <p>
333 Plus the following packages:
334 <blockquote>
335 <ul>
336 <li>cups devel: Cups Development Package</li>
337 <li>alsa devel: Alsa Development Package</li>
338 <li>ant: Ant Package</li>
339 <li>Xi devel: libXi.so Development Package</li>
340 </ul>
341 </blockquote>
342 <p>
343 The freetype 2.3 packages don't seem to be available,
344 but the freetype 2.3 sources can be downloaded, built,
345 and installed easily enough from
346 <a href="http://downloads.sourceforge.net/freetype">
347 the freetype site</a>.
348 Build and install with something like:
349 <blockquote>
350 <tt>./configure && make && sudo -u root make install</tt>
351 </blockquote>
352 <p>
353 Mercurial packages could not be found easily, but a Google
354 search should find ones, and they usually include Python if
355 it's needed.
356 </blockquote>
357 <!-- ------------------------------------------------------ -->
358 <h3><a name="debian">Debian</a></h3>
359 <blockquote>
360 <h4>Debian 5.0 (Lenny)</h4>
361 <p>
362 <blockquote>
363 After installing <a href="http://debian.org">Debian</a> 5
364 you need to install several build dependencies.
365 The simplest way to install the build dependencies is to
366 execute the following commands as user <tt>root</tt>:
367 <p/>
368 <code>aptitude build-dep openjdk-6</code>
369 <p/>
370 <code>aptitude install openjdk-6-jdk libmotif-dev</code>
371 <p/>
372 In addition, it's necessary to set a few environment variables for the build:
373 <p/>
374 <code>export LANG=C ALT_BOOTDIR=/usr/lib/jvm/java-6-openjdk</code>
375 </blockquote>
376 </blockquote>
377 <!-- ====================================================== -->
378 <h3><a name="ubuntu">Ubuntu</a></h3>
379 <blockquote>
380 <h4>Ubuntu 8.04</h4>
381 <p>
382 <blockquote>
383 After installing <a href="http://ubuntu.org">Ubuntu</a> 8.04
384 you need to install several build dependencies.
385 <p/>
386 First, you need to enable the universe repository in the
387 Software Sources application and reload the repository
388 information. The Software Sources application is available
389 under the System/Administration menu.
390 <p/>
391 The simplest way to install the build dependencies is to
392 execute the following commands:
393 <p/>
394 <code>sudo aptitude build-dep openjdk-6</code>
395 <p/>
396 <code>sudo aptitude install openjdk-6-jdk</code>
397 <p/>
398 In addition, it's necessary to set a few environment variables for the build:
399 <p/>
400 <code>export LANG=C ALT_BOOTDIR=/usr/lib/jvm/java-6-openjdk</code>
401 </blockquote>
402 <h4>Ubuntu 8.10</h4>
403 <p>
404 <blockquote>
405 After installing <a href="http://ubuntu.org">Ubuntu</a> 8.10
406 you need to install several build dependencies. The simplest
407 way to do it is to execute the following commands:
408 <p/>
409 <code>sudo aptitude build-dep openjdk-6</code>
410 <p/>
411 <code>sudo aptitude install openjdk-6-jdk</code>
412 <p/>
413 In addition, it's necessary to set a few environment variables for the build:
414 <p/>
415 <code>export LANG=C ALT_BOOTDIR=/usr/lib/jvm/java-6-openjdk</code>
416 </blockquote>
417 <h4>Ubuntu 9.04</h4>
418 <p>
419 <blockquote>
420 After installing <a href="http://ubuntu.org">Ubuntu</a> 9.04
421 you need to install several build dependencies. The simplest
422 way to do it is to execute the following commands:
423 <p/>
424 <code>sudo aptitude build-dep openjdk-6</code>
425 <p/>
426 <code>sudo aptitude install openjdk-6-jdk</code>
427 <p/>
428 In addition, it's necessary to set a few environment variables for the build:
429 <p/>
430 <code>export LANG=C ALT_BOOTDIR=/usr/lib/jvm/java-6-openjdk</code>
431 </blockquote>
432 </blockquote>
433 <!-- ====================================================== -->
434 <h3><a name="opensuse">OpenSUSE</a></h3>
435 <blockquote>
436 <h4>OpenSUSE 11.1</h4>
437 <p>
438 <blockquote>
439 After installing <a href="http://opensuse.org">OpenSUSE</a> 11.1
440 you need to install several build dependencies.
441 The simplest way to install the build dependencies is to
442 execute the following commands:
443 <p/>
444 <code>sudo zypper source-install -d java-1_6_0-openjdk</code>
445 <p/>
446 <code>sudo zypper install make</code>
447 <p/>
448 In addition, it is necessary to set a few environment variables for the build:
449 <p/>
450 <code>export LANG=C ALT_BOOTDIR=/usr/lib/jvm/java-1.6.0-openjdk</code>
451 <p/>
452 Finally, you need to unset the <code>JAVA_HOME</code> environment variable:
453 <p/>
454 <code>export -n JAVA_HOME</code>
455 </blockquote>
456 </blockquote>
457 <!-- ====================================================== -->
458 <h3><a name="mandriva">Mandriva</a></h3>
459 <blockquote>
460 <h4>Mandriva Linux One 2009 Spring</h4>
461 <p>
462 <blockquote>
463 After installing <a href="http://mandriva.org">Mandriva</a> Linux One 2009 Spring
464 you need to install several build dependencies.
465 The simplest way to install the build dependencies is to
466 execute the following commands as user <tt>root</tt>:
467 <p/>
468 <code>urpmi java-1.6.0-openjdk-devel ant make gcc gcc-c++ freetype-devel zip unzip libcups2-devel libxrender1-devel libalsa2-devel libstc++-static-devel libxtst6-devel libxi-devel</code>
469 <p/>
470 In addition, it is necessary to set a few environment variables for the build:
471 <p/>
472 <code>export LANG=C ALT_BOOTDIR=/usr/lib/jvm/java-1.6.0-openjdk</code>
473 </blockquote>
474 </blockquote>
475 <!-- ====================================================== -->
476 <h3><a name="opensolaris">OpenSolaris</a></h3>
477 <blockquote>
478 <h4>OpenSolaris 2009.06</h4>
479 <p>
480 <blockquote>
481 After installing <a href="http://opensolaris.org">OpenSolaris</a> 2009.06
482 you need to install several build dependencies.
483 The simplest way to install the build dependencies is to
484 execute the following commands:
485 <p/>
486 <code>pfexec pkg install SUNWgmake SUNWj6dev SUNWant sunstudioexpress SUNWcups SUNWzip SUNWunzip SUNWxwhl SUNWxorg-headers SUNWaudh SUNWfreetype2</code>
487 <p/>
488 In addition, it is necessary to set a few environment variables for the build:
489 <p/>
490 <code>export LANG=C ALT_COMPILER_PATH=/opt/SunStudioExpress/bin/ ALT_CUPS_HEADERS_PATH=/usr/include/</code>
491 <p/>
492 Finally, you need to make sure that the build process can find the Sun Studio compilers:
493 <p/>
494 <code>export PATH=$PATH:/opt/SunStudioExpress/bin/</code>
495 </blockquote>
496 </blockquote>
497 <!-- ------------------------------------------------------ -->
498 <hr>
499 <h2><a name="directories">Source Directory Structure</a></h2>
500 <blockquote>
501 <p>
502 The source code for the OpenJDK is delivered in a set of
503 directories:
504 <tt>hotspot</tt>,
505 <tt>langtools</tt>,
506 <tt>corba</tt>,
507 <tt>jaxws</tt>,
508 <tt>jaxp</tt>,
509 and
510 <tt>jdk</tt>.
511 The <tt>hotspot</tt> directory contains the source code and make
512 files for building the OpenJDK Hotspot Virtual Machine.
513 The <tt>langtools</tt> directory contains the source code and make
514 files for building the OpenJDK javac and language tools.
515 The <tt>corba</tt> directory contains the source code and make
516 files for building the OpenJDK Corba files.
517 The <tt>jaxws</tt> directory contains the source code and make
518 files for building the OpenJDK JAXWS files.
519 The <tt>jaxp</tt> directory contains the source code and make
520 files for building the OpenJDK JAXP files.
521 The <tt>jdk</tt> directory contains the source code and make files for
522 building the OpenJDK runtime libraries and misc files.
523 The top level <tt>Makefile</tt>
524 is used to build the entire OpenJDK.
526 <h3><a name="drops">Managing the Source Drops</a></h3>
527 <blockquote>
528 <p>
529 The repositories <tt>jaxp</tt> and <tt>jaxws</tt> actually
530 do not contain the sources for JAXP or JAX-WS.
531 These products have their own open source procedures at their
532 <a href="http://jaxp.java.net/">JAXP</a> and
533 <a href="http://jax-ws.java.net/">JAX-WS</a> home pages.
534 The OpenJDK project does need access to these sources to build
535 a complete JDK image because JAXP and JAX-WS are part of the JDK.
536 The current process for delivery of the JAXP and JAX-WS sources
537 involves so called "source drop bundles" downloaded from a public
538 website.
539 There are many reasons for this current mechanism, and it is
540 understood that this is not ideal for the open source community.
541 It is possible this process could change in the future.
542 <br>
543 <b>NOTE:</b> The <a href="http://download.java.net/openjdk/jdk8/">
544 Complete OpenJDK Source Bundles</a> <u>will</u> contain the JAXP and
545 JAX-WS sources.
546 </p>
548 <h4><a name="dropcreation">Creation of New Source Drop Bundles</a></h4>
549 <blockquote>
550 <ol>
551 <li>
552 The JAXP or JAX-WS team prepares a new zip bundle,
553 places a copy in a public download area on java.net,
554 sends us a link and a list of CRs (Change Request Numbers).
555 The older download bundles should not be deleted.
556 It is the responsibility of the JAXP and JAX-WS team to
557 place the proper GPL legal notices on the sources
558 and do any filtering or java re-packaging for the
559 OpenJDK instances of these classes.
560 </li>
561 <li>
562 The OpenJDK team copies this new bundle into shared
563 area (e.g. <tt>/java/devtools/share/jdk8-drops</tt>).
564 Older bundles are never deleted so we retain the history.
565 </li>
566 <li>
567 The OpenJDK team edits the ant property file
568 <tt>jaxp/jaxp.properties</tt> or
569 <tt>jaxws/jaxws.properties</tt> to update the
570 base URL, the zip bundle name, and the MD5 checksum
571 of the zip bundle
572 (on Solaris: <tt>sum -c md5 <i>bundlename</i></tt>)
573 </li>
574 <li>
575 OpenJDK team reviews and commits those changes with the
576 given CRs.
577 </li>
578 </ol>
579 </blockquote>
581 <h4><a name="dropusage">Using Source Drop Bundles</a></h4>
582 <blockquote>
583 <p>
584 The ant scripts that build <tt>jaxp</tt> and <tt>jaxws</tt>
585 will attempt to locate these zip bundles from the directory
586 in the environment variable
587 <tt><a href="#ALT_DROPS_DIR">ALT_DROPS_DIR</a></tt>.
588 The checksums protect from getting the wrong, corrupted, or
589 improperly modified sources.
590 Once the sources are made available, the population will not
591 happen again unless a <tt>make clobber</tt> is requested
592 or the <tt>jaxp/drop/</tt> or <tt>jaxws/drop/</tt>
593 directory is explicitly deleted.
594 <br>
595 <b>NOTE:</b> The default Makefile and ant script behavior
596 is to NOT download these bundles from the public http site.
597 In general, doing downloads
598 during the build process is not advised, it creates too much
599 unpredictability in the build process.
600 However, you can use <tt>make ALLOW_DOWNLOADS=true</tt> to
601 tell the ant script that the download of the zip bundle is
602 acceptable.
603 </p>
604 <p>
605 The recommended procedure for keeping a cache of these
606 source bundles would be to download them once, place them
607 in a directory outside the repositories, and then set
608 <tt><a href="#ALT_DROPS_DIR">ALT_DROPS_DIR</a></tt> to refer
609 to that directory.
610 These drop bundles do change occasionally, so the newer
611 bundles may need to be added to this area from time to time.
612 </p>
613 </blockquote>
614 </blockquote>
615 </blockquote>
616 <!-- ------------------------------------------------------ -->
617 <hr>
618 <h2><a name="building">Build Information</a></h2>
619 <blockquote>
620 Building the OpenJDK
621 is done with a <a href="#gmake">GNU <tt>make</tt></a> command line
622 and various
623 environment or make variable settings that direct the makefile rules
624 to where various components have been installed.
625 Where possible the makefiles will attempt to located the various
626 components in the default locations or any component specific
627 variable settings.
628 When the normal defaults fail or components cannot be found,
629 the various
630 <tt>ALT_*</tt> variables (alternates)
631 can be used to help the makefiles locate components.
632 <p>
633 Refer to the bash/sh/ksh setup file
634 <tt>jdk/make/jdk_generic_profile.sh</tt>
635 if you need help in setting up your environment variables.
636 A build could be as simple as:
637 <blockquote>
638 <pre><tt>
639 bash
640 . jdk/make/jdk_generic_profile.sh
641 <a href="#gmake"><tt>make</tt></a> sanity && <a href="#gmake"><tt>make</tt></a>
642 </tt></pre>
643 </blockquote>
644 <p>
645 Of course ksh or sh would work too.
646 But some customization will probably be necessary.
647 The <tt>sanity</tt> rule will make some basic checks on build
648 dependencies and generate appropriate warning messages
649 regarding missing, out of date, or newer than expected components
650 found on your system.
651 </blockquote>
652 <!-- ------------------------------------------------------ -->
653 <hr>
654 <h3><a name="gmake">GNU make (<tt><i>gmake</i></tt>)</a></h3>
655 <blockquote>
656 The Makefiles in the OpenJDK are only valid when used with the
657 GNU version of the utility command <tt>make</tt>
658 (<tt><i>gmake</i></tt>).
659 A few notes about using GNU make:
660 <ul>
661 <li>
662 You need GNU make version 3.81 or newer.
663 </li>
664 <li>
665 Place the location of the GNU make binary in the <tt>PATH</tt>.
666 </li>
667 <li>
668 <strong>Linux:</strong>
669 The <tt>/usr/bin/make</tt> should be 3.81 or newer
670 and should work fine for you.
671 If this version is not 3.81 or newer,
672 see the <a href="#buildgmake">"Building GNU make"</a> section.
673 </li>
674 <li>
675 <strong>Solaris:</strong>
676 Do NOT use <tt>/usr/bin/make</tt> on Solaris.
677 If your Solaris system has the software
678 from the Solaris Companion CD installed,
679 you should try and use <tt>gmake</tt>
680 which will be located in either the <tt>/opt/sfw/bin</tt> or
681 <tt>/usr/sfw/bin</tt> directory.
682 In more recent versions of Solaris GNU make might be found
683 at <tt>/usr/bin/gmake</tt>.<br>
684 <b>NOTE:</b> It is very likely that this <tt>gmake</tt>
685 could be 3.80, you need 3.81, in which case,
686 see the <a href="#buildgmake">"Building GNU make"</a> section.
687 </li>
688 <li>
689 <strong>Windows:</strong>
690 Make sure you start your build inside a bash/sh/ksh shell
691 and are using a <tt>make.exe</tt> utility built for that
692 environment (a cygwin <tt>make.exe</tt> is not the same
693 as a <tt>make.exe</tt> built for something like
694 <a href="http://www.mkssoftware.com/">MKS</a>).
695 <br>
696 <b>WARNING:</b> Watch out on some make 3.81 versions, it may
697 not work due to a lack of support for MS-DOS drive letter paths
698 like <tt>C:/</tt> or <tt>C:\</tt>.
699 <br>
700 You may be able to use the information at the
701 <a href="http://developer.mozilla.org/en/docs/Windows_build_prerequisites_using_cygwin#make" target="_blank">
702 mozilla developer center</a>
703 on this topic.
704 <br>
705 It's hoped that when make 3.82 starts shipping in a future cygwin
706 release that this MS-DOS path issue will be fixed.
707 <br>
708 It may be possible to download the version at
709 <a href="http://www.cmake.org/files/cygwin/make.exe">
710 www.cmake.org make.exe</a>.
711 <br>
712 It might be necessary for you to build your own GNU make 3.81,
713 see the <a href="#buildgmake">"Building GNU make"</a> section
714 in that case.
715 </li>
716 </ul>
717 <p>
718 Information on GNU make, and access to ftp download sites, are
719 available on the
720 <a href="http://www.gnu.org/software/make/make.html" target="_blank">
721 GNU make web site
722 </a>.
723 The latest source to GNU make is available at
724 <a href="http://ftp.gnu.org/pub/gnu/make/" target="_blank">
725 ftp.gnu.org/pub/gnu/make/</a>.
726 </p>
727 <!-- ------------------------------------------------------ -->
728 <h4><a name="buildgmake">Building GNU make</a></h4>
729 <blockquote>
730 First step is to get the GNU make 3.81 source from
731 <a href="http://ftp.gnu.org/pub/gnu/make/" target="_blank">
732 ftp.gnu.org/pub/gnu/make/</a>.
733 Building is a little different depending on the OS and unix toolset
734 on Windows:
735 <ul>
736 <li>
737 <strong>Linux:</strong>
738 <tt>./configure && make</tt>
739 </li>
740 <li>
741 <strong>Solaris:</strong>
742 <tt>./configure && gmake CC=gcc</tt>
743 </li>
744 <li>
745 <strong>Windows for CYGWIN:</strong>
746 <tt>./configure && make</tt>
747 </li>
748 <li>
749 <strong>Windows for MKS: (CYGWIN is recommended)</strong>
750 <tt>./configure && make -f Makefile.win32</tt>
751 </li>
752 </ul>
753 </blockquote>
754 </blockquote>
755 <!-- ------------------------------------------------------ -->
756 <hr>
757 <h3><a name="linux">Basic Linux System Setup</a></h3>
758 <blockquote>
759 <strong>i586 only:</strong>
760 The minimum recommended hardware for building the Linux version
761 is a Pentium class processor or better, at least 256 MB of RAM, and
762 approximately 1.5 GB of free disk space.
763 <p>
764 <strong>X64 only:</strong>
765 The minimum recommended hardware for building the Linux
766 version is an AMD Opteron class processor, at least 512 MB of RAM, and
767 approximately 4 GB of free disk space.
768 <p>
769 The build will use the tools contained in
770 <tt>/bin</tt> and
771 <tt>/usr/bin</tt>
772 of a standard installation of the Linux operating environment.
773 You should ensure that these directories are in your
774 <tt>PATH</tt>.
775 <p>
776 Note that some Linux systems have a habit of pre-populating
777 your environment variables for you, for example <tt>JAVA_HOME</tt>
778 might get pre-defined for you to refer to the JDK installed on
779 your Linux system.
780 You will need to unset <tt>JAVA_HOME</tt>.
781 It's a good idea to run <tt>env</tt> and verify the
782 environment variables you are getting from the default system
783 settings make sense for building the
784 OpenJDK.
785 </blockquote>
786 <!-- ------------------------------------------------------ -->
787 <h4><a name="linux_checklist">Basic Linux Check List</a></h4>
788 <blockquote>
789 <ol>
790 <li>
791 Install the
792 <a href="#bootjdk">Bootstrap JDK</a>, set
793 <tt><a href="#ALT_BOOTDIR">ALT_BOOTDIR</a></tt>.
794 </li>
795 <li>
796 <a href="#importjdk">Optional Import JDK</a>, set
797 <tt><a href="#ALT_JDK_IMPORT_PATH">ALT_JDK_IMPORT_PATH</a></tt>.
798 </li>
799 <li>
800 Install or upgrade the <a href="#freetype">FreeType development
801 package</a>.
802 </li>
803 <li>
804 Install
805 <a href="#ant">Ant 1.7.1 or newer</a>,
806 make sure it is in your PATH.
807 </li>
808 </ol>
809 </blockquote>
810 <!-- ------------------------------------------------------ -->
811 <hr>
812 <h3><a name="solaris">Basic Solaris System Setup</a></h3>
813 <blockquote>
814 The minimum recommended hardware for building the
815 Solaris SPARC version is an UltraSPARC with 512 MB of RAM.
816 For building
817 the Solaris x86 version, a Pentium class processor or better and at
818 least 512 MB of RAM are recommended.
819 Approximately 1.4 GB of free disk
820 space is needed for a 32-bit build.
821 <p>
822 If you are building the 64-bit version, you should
823 run the command "isainfo -v" to verify that you have a
824 64-bit installation, it should say <tt>sparcv9</tt> or
825 <tt>amd64</tt>.
826 An additional 7 GB of free disk space is needed
827 for a 64-bit build.
828 <p>
829 The build uses the tools contained in <tt>/usr/ccs/bin</tt>
830 and <tt>/usr/bin</tt> of a standard developer or full installation of
831 the Solaris operating environment.
832 <p>
833 Solaris patches specific to the JDK can be downloaded from the
834 <a href="http://sunsolve.sun.com/show.do?target=patches/JavaSE" target="_blank">
835 SunSolve JDK Solaris patches download page</a>.
836 You should ensure that the latest patch cluster for
837 your version of the Solaris operating environment has also
838 been installed.
839 </blockquote>
840 <!-- ------------------------------------------------------ -->
841 <h4><a name="solaris_checklist">Basic Solaris Check List</a></h4>
842 <blockquote>
843 <ol>
844 <li>
845 Install the
846 <a href="#bootjdk">Bootstrap JDK</a>, set
847 <tt><a href="#ALT_BOOTDIR">ALT_BOOTDIR</a></tt>.
848 </li>
849 <li>
850 <a href="#importjdk">Optional Import JDK</a>, set
851 <tt><a href="#ALT_JDK_IMPORT_PATH">ALT_JDK_IMPORT_PATH</a></tt>.
852 </li>
853 <li>
854 Install the
855 <a href="#studio">Sun Studio Compilers</a>, set
856 <a href="#ALT_COMPILER_PATH"><tt>ALT_COMPILER_PATH</tt></a>.
857 </li>
858 <li>
859 Install the
860 <a href="#cups">CUPS Include files</a>, set
861 <tt><a href="#ALT_CUPS_HEADERS_PATH">ALT_CUPS_HEADERS_PATH</a></tt>.
862 </li>
863 <li>
864 Install the <a href="#xrender">XRender Include files</a>.
865 </li>
866 <li>
867 Install
868 <a href="#ant">Ant 1.7.1 or newer</a>,
869 make sure it is in your PATH.
870 </li>
871 </ol>
872 </blockquote>
873 <!-- ------------------------------------------------------ -->
874 <hr>
875 <h3><a name="windows">Basic Windows System Setup</a></h3>
876 <blockquote>
877 <strong>i586 only:</strong>
878 The minimum recommended hardware for building the 32-bit or X86
879 Windows version is an Pentium class processor or better, at least
880 512 MB of RAM, and approximately 600 MB of free disk space.
881 <strong>
882 NOTE: The Windows build machines need to use the
883 file system NTFS.
884 Build machines formatted to FAT32 will not work
885 because FAT32 doesn't support case-sensitivity in file names.
886 </strong>
887 <p>
888 <strong>X64 only:</strong>
889 The minimum recommended hardware for building
890 the Windows X64 version is an AMD Opteron class processor, at least 1
891 GB of RAM, and approximately 10 GB of free disk space.
892 </blockquote>
893 <!-- ------------------------------------------------------ -->
894 <h4><a name="paths">Windows Paths</a></h4>
895 <blockquote>
896 <strong>Windows:</strong>
897 Note that GNU make is a historic utility and is based very
898 heavily on shell scripting, so it does not tolerate the Windows habit
899 of having spaces in pathnames or the use of the <tt>\</tt>characters in pathnames.
900 Luckily on most Windows systems, you can use <tt>/</tt>instead of \, and
901 there is always a 'short' pathname without spaces for any path that
902 contains spaces.
903 Unfortunately, this short pathname can be somewhat dynamic and the
904 formula is difficult to explain.
905 You can use <tt>cygpath</tt> utility to map pathnames with spaces
906 or the <tt>\</tt>character into the <tt>C:/</tt> style of pathname
907 (called 'mixed'), e.g.
908 <tt>cygpath -s -m "<i>path</i>"</tt>.
909 <p>
910 The makefiles will try to translate any pathnames supplied
911 to it into the <tt>C:/</tt> style automatically.
912 <p>
913 Note that use of CYGWIN creates a unique problem with regards to
914 setting <a href="#path"><tt>PATH</tt></a>. Normally on Windows
915 the <tt>PATH</tt> variable contains directories
916 separated with the ";" character (Solaris and Linux uses ":").
917 With CYGWIN, it uses ":", but that means that paths like "C:/path"
918 cannot be placed in the CYGWIN version of <tt>PATH</tt> and
919 instead CYGWIN uses something like <tt>/cygdrive/c/path</tt>
920 which CYGWIN understands, but only CYGWIN understands.
921 So be careful with paths on Windows.
922 </blockquote>
923 <!-- ------------------------------------------------------ -->
924 <h4><a name="windows_checklist">Basic Windows Check List</a></h4>
925 <blockquote>
926 <ol>
927 <li>
928 Install the
929 <a href="#cygwin">CYGWIN product</a>.
930 </li>
931 <li>
932 Install the
933 <a href="#bootjdk">Bootstrap JDK</a>, set
934 <tt><a href="#ALT_BOOTDIR">ALT_BOOTDIR</a></tt>.
935 </li>
936 <li>
937 <a href="#importjdk">Optional Import JDK</a>, set
938 <tt><a href="#ALT_JDK_IMPORT_PATH">ALT_JDK_IMPORT_PATH</a></tt>.
939 </li>
940 <li>
941 Install the
942 <a href="#msvc32">Microsoft Visual Studio Compilers</a>).
943 </li>
944 <li>
945 Setup all environment variables for compilers
946 (see <a href="#msvc32">compilers</a>).
947 </li>
948 <li>
949 Install
950 <a href="#dxsdk">Microsoft DirectX SDK</a>.
951 </li>
952 <li>
953 Install
954 <a href="#ant">Ant 1.7.1 or newer</a>,
955 make sure it is in your PATH and set
956 <tt><a href="#ANT_HOME">ANT_HOME</a></tt>.
957 </li>
958 </ol>
959 </blockquote>
960 <!-- ------------------------------------------------------ -->
961 <hr>
962 <h3><a name="macosx">Basic Mac OS X System Setup</a></h3>
963 <blockquote>
964 <strong>X64 only:</strong>
965 The minimum recommended hardware for building
966 the Mac OS X version is any 64-bit capable Intel processor, at least 2
967 GB of RAM, and approximately 3 GB of free disk space. You should also
968 have OS X Lion 10.7.3 installed.
969 </blockquote>
970 <!-- ------------------------------------------------------ -->
972 <h4><a name="macosx_checklist">Basic Mac OS X Check List</a></h4>
973 <blockquote>
974 <ol>
975 <li>
976 Install <a href="https://developer.apple.com/xcode/">XCode 4.1</a> or newer.
977 If you install XCode 4.3 or newer, make sure you also install
978 "Command line tools" found under the preferences pane "Downloads".
979 </li>
980 <li>
981 Install <a href="http://support.apple.com/kb/dl1421" target="_blank">"Java for OS X Lion Update 1"</a>,
982 set <tt><a href="#ALT_BOOTDIR">ALT_BOOTDIR</a> to <code>`/usr/libexec/java_home -v 1.6`</code></tt>
983 </li>
984 <li>
985 <a href="#importjdk">Optional Import JDK</a>, set
986 <tt><a href="#ALT_JDK_IMPORT_PATH">ALT_JDK_IMPORT_PATH</a></tt>.
987 </li>
988 </ol>
989 </blockquote>
990 <!-- ------------------------------------------------------ -->
991 <hr>
992 <h3><a name="dependencies">Build Dependencies</a></h3>
993 <blockquote>
994 Depending on the platform, the OpenJDK build process has some basic
995 dependencies on components not part of the OpenJDK sources.
996 Some of these are specific to a platform, some even specific to
997 an architecture.
998 Each dependency will have a set of ALT variables that can be set
999 to tell the makefiles where to locate the component.
1000 In most cases setting these ALT variables may not be necessary
1001 and the makefiles will find defaults on the system in standard
1002 install locations or through component specific variables.
1003 <!-- ------------------------------------------------------ -->
1004 <h4><a name="bootjdk">Bootstrap JDK</a></h4>
1005 <blockquote>
1006 All OpenJDK builds require access to the previously released
1007 JDK 6, this is often called a bootstrap JDK.
1008 The JDK 6 binaries can be downloaded from Sun's
1009 <a href="http://java.sun.com/javase/downloads/index.jsp"
1010 target="_blank">JDK 6 download site</a>.
1011 For build performance reasons
1012 is very important that this bootstrap JDK be made available on the
1013 local disk of the machine doing the build.
1014 You should always set
1015 <tt><a href="#ALT_BOOTDIR">ALT_BOOTDIR</a></tt>
1016 to point to the location of
1017 the bootstrap JDK installation, this is the directory pathname
1018 that contains a <tt>bin, lib, and include</tt>
1019 It's also a good idea to also place its <tt>bin</tt> directory
1020 in the <tt>PATH</tt> environment variable, although it's
1021 not required.
1022 <p>
1023 <strong>Solaris:</strong>
1024 Some pre-installed JDK images may be available to you in the
1025 directory <tt>/usr/jdk/instances</tt>.
1026 If you don't set
1027 <tt><a href="#ALT_BOOTDIR">ALT_BOOTDIR</a></tt>
1028 the makefiles will look in that location for a JDK it can use.
1029 </blockquote>
1030 <!-- ------------------------------------------------------ -->
1031 <h4><a name="importjdk">Optional Import JDK</a></h4>
1032 <blockquote>
1033 The <tt><a href="#ALT_JDK_IMPORT_PATH">ALT_JDK_IMPORT_PATH</a></tt>
1034 setting is only needed if you are not building the entire
1035 JDK. For example, if you have built the entire JDK once, and
1036 wanted to avoid repeatedly building the Hotspot VM, you could
1037 set this to the location of the previous JDK install image
1038 and the build will copy the needed files from this import area.
1039 </blockquote>
1040 <!-- ------------------------------------------------------ -->
1041 <h4><a name="ant">Ant</a></h4>
1042 <blockquote>
1043 All OpenJDK builds require access to least Ant 1.7.1.
1044 The Ant tool is available from the
1045 <a href="http://archive.apache.org/dist/ant/binaries/apache-ant-1.7.1-bin.zip" target="_blank">
1046 Ant 1.7.1 archive download site</a>.
1047 You should always make sure <tt>ant</tt> is in your PATH, and
1048 on Windows you may also need to set
1049 <tt><a href="#ANT_HOME">ANT_HOME</a></tt>
1050 to point to the location of
1051 the Ant installation, this is the directory pathname
1052 that contains a <tt>bin and lib</tt>.
1053 <br>
1054 <b>WARNING:</b> Ant versions used from IDE tools like NetBeans
1055 or installed via system packages may not operate the same
1056 as the one obtained from the Ant download bundles.
1057 These system and IDE installers sometimes choose to change
1058 the ant installation enough to cause differences.
1059 </blockquote>
1060 <!-- ------------------------------------------------------ -->
1061 <h4><a name="cacerts">Certificate Authority File (cacert)</a></h4>
1062 <blockquote>
1063 See <a href="http://en.wikipedia.org/wiki/Certificate_Authority" target="_blank">
1064 http://en.wikipedia.org/wiki/Certificate_Authority</a>
1065 for a better understanding of the Certificate Authority (CA).
1066 A certificates file named "cacerts"
1067 represents a system-wide keystore with CA certificates.
1068 In JDK and JRE
1069 binary bundles, the "cacerts" file contains root CA certificates from
1070 several public CAs (e.g., VeriSign, Thawte, and Baltimore).
1071 The source contain a cacerts file
1072 without CA root certificates.
1073 Formal JDK builders will need to secure
1074 permission from each public CA and include the certificates into their
1075 own custom cacerts file.
1076 Failure to provide a populated cacerts file
1077 will result in verification errors of a certificate chain during runtime.
1078 The variable
1079 <tt><a href="#ALT_CACERTS_FILE">ALT_CACERTS_FILE</a></tt>
1080 can be used to override the default location of the
1081 cacerts file that will get placed in your build.
1082 By default an empty cacerts file is provided and that should be
1083 fine for most JDK developers.
1084 </blockquote>
1085 <!-- ------------------------------------------------------ -->
1086 <h4><a name="compilers">Compilers</a></h4>
1087 <blockquote>
1088 <strong><a name="gcc">Linux gcc/binutils</a></strong>
1089 <blockquote>
1090 The GNU gcc compiler version should be 4.3 or newer.
1091 The compiler used should be the default compiler installed
1092 in <tt>/usr/bin</tt>.
1093 </blockquote>
1094 <strong><a name="studio">Solaris: Sun Studio</a></strong>
1095 <blockquote>
1096 At a minimum, the
1097 <a href="http://www.oracle.com/technetwork/server-storage/solarisstudio/downloads/index.htm" target="_blank">
1098 Sun Studio 12 Update 1 Compilers</a>
1099 (containing version 5.10 of the C and C++ compilers) is required,
1100 including specific patches.
1101 <p>
1102 The Solaris SPARC patch list is:
1103 <ul>
1104 <li>
1105 118683-05: SunOS 5.10: Patch for profiling libraries and assembler
1106 </li>
1107 <li>
1108 119963-21: SunOS 5.10: Shared library patch for C++
1109 </li>
1110 <li>
1111 120753-08: SunOS 5.10: Microtasking libraries (libmtsk) patch
1112 </li>
1113 <li>
1114 128228-09: Sun Studio 12 Update 1: Patch for Sun C++ Compiler
1115 </li>
1116 <li>
1117 141860-03: Sun Studio 12 Update 1: Patch for Compiler Common patch for Sun C C++ F77 F95
1118 </li>
1119 <li>
1120 141861-05: Sun Studio 12 Update 1: Patch for Sun C Compiler
1121 </li>
1122 <li>
1123 142371-01: Sun Studio 12.1 Update 1: Patch for dbx
1124 </li>
1125 <li>
1126 143384-02: Sun Studio 12 Update 1: Patch for debuginfo handling
1127 </li>
1128 <li>
1129 143385-02: Sun Studio 12 Update 1: Patch for Compiler Common patch for Sun C C++ F77 F95
1130 </li>
1131 <li>
1132 142369-01: Sun Studio 12.1: Patch for Performance Analyzer Tools
1133 </li>
1134 </ul>
1135 <p>
1136 The Solaris X86 patch list is:
1137 <ul>
1138 <li>
1139 119961-07: SunOS 5.10_x86, x64, Patch for profiling libraries and assembler
1140 </li>
1141 <li>
1142 119964-21: SunOS 5.10_x86: Shared library patch for C++_x86
1143 </li>
1144 <li>
1145 120754-08: SunOS 5.10_x86: Microtasking libraries (libmtsk) patch
1146 </li>
1147 <li>
1148 141858-06: Sun Studio 12 Update 1_x86: Sun Compiler Common patch for x86 backend
1149 </li>
1150 <li>
1151 128229-09: Sun Studio 12 Update 1_x86: Patch for C++ Compiler
1152 </li>
1153 <li>
1154 142363-05: Sun Studio 12 Update 1_x86: Patch for C Compiler
1155 </li>
1156 <li>
1157 142368-01: Sun Studio 12.1_x86: Patch for Performance Analyzer Tools
1158 </li>
1159 </ul>
1160 <p>
1161 Set
1162 <a href="#ALT_COMPILER_PATH"><tt>ALT_COMPILER_PATH</tt></a>
1163 to point to the location of
1164 the compiler binaries, and place this location in the <tt>PATH</tt>.
1165 <p>
1166 The Oracle Solaris Studio Express compilers at:
1167 <a href="http://developers.sun.com/sunstudio/downloads/express.jsp" target="_blank">
1168 Oracle Solaris Studio Express Download site</a>
1169 are also an option, although these compilers have not
1170 been extensively used yet.
1171 </blockquote>
1172 <strong><a name="msvc32">Windows i586: Microsoft Visual Studio 2010 Compilers</a></strong>
1173 <blockquote>
1174 <p>
1175 <b>BEGIN WARNING</b>: JDK 7 has transitioned to
1176 use the newest VS2010 Microsoft compilers.
1177 No other compilers are known to build the entire JDK,
1178 including non-open portions.
1179 Visual Studio 2010 Express compilers are now able to build all the
1180 open source repositories, but this is 32 bit only. To build 64 bit
1181 Windows binaries use the the 7.1 Windows SDK.
1182 <b>END WARNING.</b>
1183 <p>
1184 The 32-bit OpenJDK Windows build requires
1185 Microsoft Visual Studio C++ 2010 (VS2010) Professional
1186 Edition or Express compiler.
1187 The compiler and other tools are expected to reside
1188 in the location defined by the variable
1189 <tt>VS100COMNTOOLS</tt> which
1190 is set by the Microsoft Visual Studio installer.
1191 <p>
1192 Once the compiler is installed,
1193 it is recommended that you run <tt>VCVARS32.BAT</tt>
1194 to set the compiler environment variables
1195 <tt>INCLUDE</tt>,
1196 <tt>LIB</tt>, and
1197 <tt>PATH</tt>
1198 prior to building the
1199 OpenJDK.
1200 The above environment variables <b>MUST</b> be set.
1201 This compiler also contains the Windows SDK v 7.0a,
1202 which is an update to the Windows 7 SDK.
1203 <p>
1204 <b>WARNING:</b> Make sure you check out the
1205 <a href="#cygwin">CYGWIN link.exe WARNING</a>.
1206 The path <tt>/usr/bin</tt> must be after the path to the
1207 Visual Studio product.
1208 </blockquote>
1209 <strong><a name="msvc64">Windows x64: Microsoft Visual Studio 2010 Professional Compiler</a></strong>
1210 <blockquote>
1211 For <b>X64</b>, the set up is much the same as 32 bit
1212 except that you run <tt>amd64\VCVARS64.BAT</tt>
1213 to set the compiler environment variables.
1214 Previously 64 bit builds had to use the 64 bit compiler in
1215 an unbundled Windows SDK but this is no longer necessary if
1216 you have VS2010 Professional.
1217 </blockquote>
1218 <strong><a name="mssdk64">Windows x64: Microsoft Windows 7.1 SDK 64 bit compilers.</a></strong>
1219 For a free alternative for 64 bit builds, use the 7.1 SDK.
1220 Microsoft say that to set up your paths for this run
1221 <pre>
1222 c:\Program Files\Microsoft SDKs\Windows\v7.1\bin\setenv.cmd /x64.
1223 </pre>
1224 What was tested is just directly setting up LIB, INCLUDE,
1225 PATH and based on the installation directories using the
1226 DOS short name appropriate for the system, (you will
1227 need to set them for yours, not just blindly copy this) eg :
1228 <pre>
1229 set VSINSTALLDIR=c:\PROGRA~2\MICROS~1.0
1230 set WindowsSdkDir=c:\PROGRA~1\MICROS~1\Windows\v7.1
1231 set PATH=%VSINSTALLDIR%\vc\bin\amd64;%VSINSTALLDIR%\Common7\IDE;%WindowsSdkDir%\bin;%PATH%
1232 set INCLUDE=%VSINSTALLDIR%\vc\include;%WindowsSdkDir%\include
1233 set LIB=%VSINSTALLDIR%\vc\lib\amd64;%WindowsSdkDir%\lib\x64
1234 </pre>
1235 <strong><a name="llvmgcc">OS X Lion 10.7.3: LLVM GCC</a></strong>
1236 <blockquote>
1237 LLVM GCC is bundled with XCode. The version should be at least 4.2.1.
1238 </blockquote>
1239 </blockquote>
1240 <!-- ------------------------------------------------------ -->
1241 <h4><a name="zip">Zip and Unzip</a></h4>
1242 <blockquote>
1243 Version 2.2 (November 3rd 1997) or newer of the zip utility
1244 and version 5.12 or newer of the unzip utility is needed
1245 to build the JDK.
1246 With Solaris, Linux, and Windows CYGWIN, the zip and unzip
1247 utilities installed on the system should be fine.
1248 Information and the source code for
1249 ZIP.EXE and UNZIP.EXE is available on the
1250 <a href="http://www.info-zip.org"
1251 target="_blank">info-zip web site</a>.
1252 </blockquote>
1253 <!-- ------------------------------------------------------ -->
1254 <h4><a name="cups">Common UNIX Printing System (CUPS) Headers (Solaris & Linux)</a></h4>
1255 <blockquote>
1256 <strong>Solaris:</strong>
1257 CUPS header files are required for building the
1258 OpenJDK on Solaris.
1259 The Solaris header files can be obtained by installing
1260 the package <strong>SFWcups</strong> from the Solaris Software
1261 Companion CD/DVD, these often will be installed into
1262 <tt>/opt/sfw/cups</tt>.
1263 <p>
1264 <strong>Linux:</strong>
1265 CUPS header files are required for building the
1266 OpenJDK on Linux.
1267 The Linux header files are usually available from a "cups"
1268 development package, it's recommended that you try and use
1269 the package provided by the particular version of Linux that
1270 you are using.
1271 <p>
1272 The CUPS header files can always be downloaded from
1273 <a href="http://www.cups.org" target="_blank">www.cups.org</a>.
1274 The variable
1275 <tt><a href="#ALT_CUPS_HEADERS_PATH">ALT_CUPS_HEADERS_PATH</a></tt>
1276 can be used to override the default location of the
1277 CUPS Header files.
1278 </blockquote>
1279 <!-- ------------------------------------------------------ -->
1280 <h4><a name="xrender">XRender Extension Headers (Solaris & Linux)</a></h4>
1281 <blockquote>
1282 <p>
1283 <strong>Solaris:</strong>
1284 XRender header files are required for building the
1285 OpenJDK on Solaris.
1286 The XRender header file is included with the other X11 header files
1287 in the package <strong>SFWxwinc</strong> on new enough versions of
1288 Solaris and will be installed in
1289 <tt>/usr/X11/include/X11/extensions/Xrender.h</tt>
1290 </p><p>
1291 <strong>Linux:</strong>
1292 XRender header files are required for building the
1293 OpenJDK on Linux.
1294 The Linux header files are usually available from a "Xrender"
1295 development package, it's recommended that you try and use
1296 the package provided by the particular distribution of Linux that
1297 you are using.
1298 </p>
1299 </blockquote>
1300 <!-- ------------------------------------------------------ -->
1301 <h4><a name="freetype">FreeType 2</a></h4>
1302 <blockquote>
1303 Version 2.3 or newer of FreeType is required for building the OpenJDK.
1304 On Unix systems required files can be available as part of your
1305 distribution (while you still may need to upgrade them).
1306 Note that you need development version of package that
1307 includes both FreeType library and header files.
1308 <p>
1309 You can always download latest FreeType version from the
1310 <a href="http://www.freetype.org" target="_blank">FreeType website</a>.
1311 <p>
1312 Makefiles will try to pick FreeType from /usr/lib and /usr/include.
1313 In case it is installed elsewhere you will need to set environment
1314 variables
1315 <tt><a href="#ALT_FREETYPE_LIB_PATH">ALT_FREETYPE_LIB_PATH</a></tt>
1316 and
1317 <tt><a href="#ALT_FREETYPE_HEADERS_PATH">ALT_FREETYPE_HEADERS_PATH</a></tt>
1318 to refer to place where library and header files are installed.
1319 <p>
1320 Building the freetype 2 libraries from scratch is also possible,
1321 however on Windows refer to the
1322 <a href="http://freetype.freedesktop.org/wiki/FreeType_DLL">
1323 Windows FreeType DLL build instructions</a>.
1324 <p>
1325 Note that by default FreeType is built with byte code hinting
1326 support disabled due to licensing restrictions.
1327 In this case, text appearance and metrics are expected to
1328 differ from Sun's official JDK build.
1329 See
1330 <a href="http://freetype.sourceforge.net/freetype2/index.html">
1331 the SourceForge FreeType2 Home Page
1332 </a>
1333 for more information.
1334 </blockquote>
1335 <!-- ------------------------------------------------------ -->
1336 <h4><a name="alsa">Advanced Linux Sound Architecture (ALSA) (Linux only)</a></h4>
1337 <blockquote>
1338 <strong>Linux only:</strong>
1339 Version 0.9.1 or newer of the ALSA files are
1340 required for building the OpenJDK on Linux.
1341 These Linux files are usually available from an "alsa"
1342 of "libasound"
1343 development package, it's highly recommended that you try and use
1344 the package provided by the particular version of Linux that
1345 you are using.
1346 The makefiles will check this emit a sanity error if it is
1347 missing or the wrong version.
1348 <p>
1349 In particular, older Linux systems will likely not have the
1350 right version of ALSA installed, for example
1351 Redhat AS 2.1 U2 and SuSE 8.1 do not include a sufficiently
1352 recent ALSA distribution.
1353 On rpm-based systems, you can see if ALSA is installed by
1354 running this command:
1355 <pre>
1356 <tt>rpm -qa | grep alsa</tt>
1357 </pre>
1358 Both <tt>alsa</tt> and <tt>alsa-devel</tt> packages are needed.
1359 <p>
1360 If your distribution does not come with ALSA, and you can't
1361 find ALSA packages built for your particular system,
1362 you can try to install the pre-built ALSA rpm packages from
1363 <a href="http://www.freshrpms.net/" target="_blank">
1364 <tt>www.freshrpms.net</tt></a>.
1365 Note that installing a newer ALSA could
1366 break sound output if an older version of ALSA was previously
1367 installed on the system, but it will enable JDK compilation.
1368 <blockquote>
1369 Installation: execute as root<br>
1370 [i586]: <code>rpm -Uv --force alsa-lib-devel-0.9.1-rh61.i386.rpm</code><br>
1371 [x64]: <code>rpm -Uv --force alsa-lib-devel-0.9.8-amd64.x86_64.rpm</code><br>
1372 Uninstallation:<br>
1373 [i586]: <code>rpm -ev alsa-lib-devel-0.9.1-rh61</code><br>
1374 [x64]:<code>rpm -ev alsa-lib-devel-0.9.8-amd64</code><br>
1375 Make sure that you do not link to the static library
1376 (<tt>libasound.a</tt>),
1377 by verifying that the dynamic library (<tt>libasound.so</tt>) is
1378 correctly installed in <tt>/usr/lib</tt>.
1379 </blockquote>
1380 As a last resort you can go to the
1381 <a href="http://www.alsa-project.org" target="_blank">
1382 Advanced Linux Sound Architecture Site</a> and build it from
1383 source.
1384 <blockquote>
1385 Download driver and library
1386 source tarballs from
1387 <a href="http://www.alsa-project.org" target="_blank">ALSA's homepage</a>.
1388 As root, execute the following
1389 commands (you may need to adapt the version number):
1390 <pre>
1391 <tt>
1392 $ tar xjf alsa-driver-0.9.1.tar.bz2
1393 $ cd alsa-driver-0.9.1
1394 $ ./configure
1395 $ make install
1396 $ cd ..
1397 $ tar xjf alsa-lib-0.9.1.tar.bz2
1398 $ cd alsa-lib-0.9.1
1399 $ ./configure
1400 $ make install
1401 </tt>
1402 </pre>
1403 Should one of the above steps fail, refer to the documentation on
1404 ALSA's home page.
1405 </blockquote>
1406 Note that this is a minimum install that enables
1407 building the JDK platform. To actually use ALSA sound drivers, more
1408 steps are necessary as outlined in the documentation on ALSA's homepage.
1409 <p>
1410 ALSA can be uninstalled by executing <tt>make uninstall</tt> first in
1411 the <tt>alsa-lib-0.9.1</tt> directory and then in
1412 <tt>alsa-driver-0.9.1</tt>.
1413 </blockquote>
1414 There are no ALT* variables to change the assumed locations of ALSA,
1415 the makefiles will expect to find the ALSA include files and library at:
1416 <tt>/usr/include/alsa</tt> and <tt>/usr/lib/libasound.so</tt>.
1417 </blockquote>
1418 <!-- ------------------------------------------------------ -->
1419 <h4>Windows Specific Dependencies</h4>
1420 <blockquote>
1421 <strong>Unix Command Tools (<a name="cygwin">CYGWIN</a>)</strong>
1422 <blockquote>
1423 The OpenJDK requires access to a set of unix command tools
1424 on Windows which can be supplied by
1425 <a href="http://www.cygwin.com" target="_blank">CYGWIN</a>.
1426 <p>
1427 The OpenJDK build requires CYGWIN version 1.5.12 or newer.
1428 Information about CYGWIN can
1429 be obtained from the CYGWIN website at
1430 <a href="http://www.cygwin.com" target="_blank">www.cygwin.com</a>.
1431 <p>
1432 By default CYGWIN doesn't install all the tools required for building
1433 the OpenJDK.
1434 Along with the default installation, you need to install
1435 the following tools.
1436 <blockquote>
1437 <table border="1">
1438 <thead>
1439 <tr>
1440 <td>Binary Name</td>
1441 <td>Category</td>
1442 <td>Package</td>
1443 <td>Description</td>
1444 </tr>
1445 </thead>
1446 <tbody>
1447 <tr>
1448 <td>ar.exe</td>
1449 <td>Devel</td>
1450 <td>binutils</td>
1451 <td>The GNU assembler, linker and binary
1452 utilities</td>
1453 </tr>
1454 <tr>
1455 <td>make.exe</td>
1456 <td>Devel</td>
1457 <td>make</td>
1458 <td>The GNU version of the 'make' utility built for CYGWIN.<br>
1459 <b>NOTE</b>: See <a href="#gmake">the GNU make section</a></td>
1460 </tr>
1461 <tr>
1462 <td>m4.exe</td>
1463 <td>Interpreters</td>
1464 <td>m4</td>
1465 <td>GNU implementation of the traditional Unix macro
1466 processor</td>
1467 </tr>
1468 <tr>
1469 <td>cpio.exe</td>
1470 <td>Utils</td>
1471 <td>cpio</td>
1472 <td>A program to manage archives of files</td>
1473 </tr>
1474 <tr>
1475 <td>gawk.exe</td>
1476 <td>Utils</td>
1477 <td>awk</td>
1478 <td>Pattern-directed scanning and processing language</td>
1479 </tr>
1480 <tr>
1481 <td>file.exe</td>
1482 <td>Utils</td>
1483 <td>file</td>
1484 <td>Determines file type using 'magic' numbers</td>
1485 </tr>
1486 <tr>
1487 <td>zip.exe</td>
1488 <td>Archive</td>
1489 <td>zip</td>
1490 <td>Package and compress (archive) files</td>
1491 </tr>
1492 <tr>
1493 <td>unzip.exe</td>
1494 <td>Archive</td>
1495 <td>unzip</td>
1496 <td>Extract compressed files in a ZIP archive</td>
1497 </tr>
1498 <tr>
1499 <td>free.exe</td>
1500 <td>System</td>
1501 <td>procps</td>
1502 <td>Display amount of free and used memory in the system</td>
1503 </tr>
1504 </tbody>
1505 </table>
1506 </blockquote>
1507 <p>
1508 Note that the CYGWIN software can conflict with other non-CYGWIN
1509 software on your Windows system.
1510 CYGWIN provides a
1511 <a href="http://cygwin.com/faq/faq.using.html" target="_blank">FAQ</a> for
1512 known issues and problems, of particular interest is the
1513 section on
1514 <a href="http://cygwin.com/faq/faq.using.html#faq.using.bloda" target="_blank">
1515 BLODA (applications that interfere with CYGWIN)</a>.
1516 <p>
1517 <b>WARNING:</b>
1518 Be very careful with <b><tt>link.exe</tt></b>, it will conflict
1519 with the Visual Studio version. You need the Visual Studio
1520 version of <tt>link.exe</tt>, not the CYGWIN one.
1521 So it's important that the Visual Studio paths in PATH preceed
1522 the CYGWIN path <tt>/usr/bin</tt>.
1523 </blockquote>
1524 <strong><a name="dxsdk">Microsoft DirectX 9.0 SDK header files and libraries</a></strong>
1525 <blockquote>
1526 Microsoft DirectX 9.0 SDK (Summer 2004)
1527 headers are required for building
1528 OpenJDK.
1529 This SDK can be downloaded from
1530 <a href="http://www.microsoft.com/downloads/details.aspx?FamilyId=FD044A42-9912-42A3-9A9E-D857199F888E&displaylang=en" target="_blank">
1531 Microsoft DirectX 9.0 SDK (Summer 2004)</a>.
1532 If the link above becomes obsolete, the SDK can be found from
1533 <a href="http://download.microsoft.com" target="_blank">the Microsoft Download Site</a>
1534 (search with "DirectX 9.0 SDK Update Summer 2004").
1535 The location of this SDK can be set with
1536 <tt><a href="#ALT_DXSDK_PATH">ALT_DXSDK_PATH</a></tt>
1537 but it's normally found via the DirectX environment variable
1538 <tt>DXSDK_DIR</tt>.
1539 </blockquote>
1540 <strong><a name="msvcrNN"><tt>MSVCR100.DLL</tt></a></strong>
1541 <blockquote>
1542 The OpenJDK build requires access to a redistributable
1543 <tt>MSVCR100.DLL</tt>.
1544 This is usually picked up automatically from the redist
1545 directories of Visual Studio 2010.
1546 If this cannot be found set the
1547 <a href="#ALT_MSVCRNN_DLL_PATH"><tt>ALT_MSVCRNN_DLL_PATH</tt></a>
1548 variable to the location of this file.
1549 <p>
1550 </blockquote>
1551 </blockquote>
1552 <!-- ------------------------------------------------------ -->
1553 <hr>
1554 <h2><a name="creating">Creating the Build</a></h2>
1555 <blockquote>
1556 Once a machine is setup to build the OpenJDK,
1557 the steps to create the build are fairly simple.
1558 The various ALT settings can either be made into variables
1559 or can be supplied on the
1560 <a href="#gmake"><tt><i>gmake</i></tt></a>
1561 command.
1562 <ol>
1563 <li>Use the sanity rule to double check all the ALT settings:
1564 <blockquote>
1565 <tt>
1566 <i>gmake</i>
1567 sanity
1568 [ARCH_DATA_MODEL=<i>32 or 64</i>]
1569 [other "ALT_" overrides]
1570 </tt>
1571 </blockquote>
1572 </li>
1573 <li>Start the build with the command:
1574 <blockquote>
1575 <tt>
1576 <i>gmake</i>
1577 [ARCH_DATA_MODEL=<i>32 or 64</i>]
1578 [ALT_OUTPUTDIR=<i>output_directory</i>]
1579 [other "ALT_" overrides]
1580 </tt>
1581 </blockquote>
1582 </li>
1583 </ol>
1584 <p>
1585 <strong>Solaris:</strong>
1586 Note that ARCH_DATA_MODEL is really only needed on Solaris to
1587 indicate you want to built the 64-bit version.
1588 And before the Solaris 64-bit binaries can be used, they
1589 must be merged with the binaries from a separate 32-bit build.
1590 The merged binaries may then be used in either 32-bit or 64-bit mode, with
1591 the selection occurring at runtime
1592 with the <tt>-d32</tt> or <tt>-d64</tt> options.
1593 </blockquote>
1594 <!-- ------------------------------------------------------ -->
1595 <hr>
1596 <h2><a name="testing">Testing the Build</a></h2>
1597 <blockquote>
1598 When the build is completed, you should see the generated
1599 binaries and associated files in the <tt>j2sdk-image</tt>
1600 directory in the output directory.
1601 The default output directory is
1602 <tt>build/<i>platform</i></tt>,
1603 where <tt><i>platform</i></tt> is one of
1604 <blockquote>
1605 <ul>
1606 <li><tt>solaris-sparc</tt></li>
1607 <li><tt>solaris-sparcv9</tt></li>
1608 <li><tt>solaris-i586</tt></li>
1609 <li><tt>solaris-amd64</tt></li>
1610 <li><tt>linux-i586</tt></li>
1611 <li><tt>linux-amd64</tt></li>
1612 <li><tt>windows-i586</tt></li>
1613 <li><tt>windows-amd64</tt></li>
1614 </ul>
1615 </blockquote>
1616 In particular, the
1617 <tt>build/<i>platform</i>/j2sdk-image/bin</tt>
1618 directory should contain executables for the
1619 OpenJDK tools and utilities.
1620 <p>
1621 You can test that the build completed properly by using the build
1622 to run the various demos that you will find in the
1623 <tt>build/<i>platform</i>/j2sdk-image/demo</tt>
1624 directory.
1625 <p>
1626 The provided regression tests can be run with the <tt>jtreg</tt>
1627 utility from
1628 <a href="http://openjdk.java.net/jtreg/" target="_blank">the jtreg site</a>.
1629 </blockquote>
1630 <!-- ------------------------------------------------------ -->
1631 <hr>
1632 <h2><a name="variables">Environment/Make Variables</a></h2>
1633 <p>
1634 Some of the
1635 environment or make variables (just called <b>variables</b> in this
1636 document) that can impact the build are:
1637 <blockquote>
1638 <dl>
1639 <dt><a name="path"><tt>PATH</tt></a> </dt>
1640 <dd>Typically you want to set the <tt>PATH</tt> to include:
1641 <ul>
1642 <li>The location of the GNU make binary</li>
1643 <li>The location of the Bootstrap JDK <tt>java</tt>
1644 (see <a href="#bootjdk">Bootstrap JDK</a>)</li>
1645 <li>The location of the C/C++ compilers
1646 (see <a href="#compilers"><tt>compilers</tt></a>)</li>
1647 <li>The location or locations for the Unix command utilities
1648 (e.g. <tt>/usr/bin</tt>)</li>
1649 </ul>
1650 </dd>
1651 <dt><tt>MILESTONE</tt> </dt>
1652 <dd>
1653 The milestone name for the build (<i>e.g.</i>"beta").
1654 The default value is "internal".
1655 </dd>
1656 <dt><tt>BUILD_NUMBER</tt> </dt>
1657 <dd>
1658 The build number for the build (<i>e.g.</i> "b27").
1659 The default value is "b00".
1660 </dd>
1661 <dt><a name="arch_data_model"><tt>ARCH_DATA_MODEL</tt></a></dt>
1662 <dd>The <tt>ARCH_DATA_MODEL</tt> variable
1663 is used to specify whether the build is to generate 32-bit or 64-bit
1664 binaries.
1665 The Solaris build supports either 32-bit or 64-bit builds, but
1666 Windows and Linux will support only one, depending on the specific
1667 OS being used.
1668 Normally, setting this variable is only necessary on Solaris.
1669 Set <tt>ARCH_DATA_MODEL</tt> to <tt>32</tt> for generating 32-bit binaries,
1670 or to <tt>64</tt> for generating 64-bit binaries.
1671 </dd>
1672 <dt><a name="ALT_BOOTDIR"><tt>ALT_BOOTDIR</tt></a></dt>
1673 <dd>
1674 The location of the bootstrap JDK installation.
1675 See <a href="#bootjdk">Bootstrap JDK</a> for more information.
1676 You should always install your own local Bootstrap JDK and
1677 always set <tt>ALT_BOOTDIR</tt> explicitly.
1678 </dd>
1679 <dt><a name="ALT_JDK_IMPORT_PATH"><tt>ALT_JDK_IMPORT_PATH</tt></a></dt>
1680 <dd>
1681 The location of a previously built JDK installation.
1682 See <a href="#importjdk">Optional Import JDK</a> for more information.
1683 </dd>
1684 <dt><a name="ALT_OUTPUTDIR"><tt>ALT_OUTPUTDIR</tt></a> </dt>
1685 <dd>
1686 An override for specifying the (absolute) path of where the
1687 build output is to go.
1688 The default output directory will be build/<i>platform</i>.
1689 </dd>
1690 <dt><a name="ALT_COMPILER_PATH"><tt>ALT_COMPILER_PATH</tt></a> </dt>
1691 <dd>
1692 The location of the C/C++ compiler.
1693 The default varies depending on the platform.
1694 </dd>
1695 <dt><tt><a name="ALT_CACERTS_FILE">ALT_CACERTS_FILE</a></tt></dt>
1696 <dd>
1697 The location of the <a href="#cacerts">cacerts</a> file.
1698 The default will refer to
1699 <tt>jdk/src/share/lib/security/cacerts</tt>.
1700 </dd>
1701 <dt><a name="ALT_CUPS_HEADERS_PATH"><tt>ALT_CUPS_HEADERS_PATH</tt></a> </dt>
1702 <dd>
1703 The location of the CUPS header files.
1704 See <a href="#cups">CUPS information</a> for more information.
1705 If this path does not exist the fallback path is
1706 <tt>/usr/include</tt>.
1707 </dd>
1708 <dt><a name="ALT_FREETYPE_LIB_PATH"><tt>ALT_FREETYPE_LIB_PATH</tt></a></dt>
1709 <dd>
1710 The location of the FreeType shared library.
1711 See <a href="#freetype">FreeType information</a> for details.
1712 </dd>
1713 <dt><a name="ALT_FREETYPE_HEADERS_PATH"><tt>ALT_FREETYPE_HEADERS_PATH</tt></a></dt>
1714 <dd>
1715 The location of the FreeType header files.
1716 See <a href="#freetype">FreeType information</a> for details.
1717 </dd>
1718 <dt><a name="ALT_JDK_DEVTOOLS_PATH"><tt>ALT_JDK_DEVTOOLS_PATH</tt></a></dt>
1719 <dd>
1720 The default root location of the devtools.
1721 The default value is
1722 <tt>$(ALT_SLASH_JAVA)/devtools</tt>.
1723 </dd>
1724 <dt><tt><a name="ALT_DEVTOOLS_PATH">ALT_DEVTOOLS_PATH</a></tt> </dt>
1725 <dd>
1726 The location of tools like the
1727 <a href="#zip"><tt>zip</tt> and <tt>unzip</tt></a>
1728 binaries, but might also contain the GNU make utility
1729 (<tt><i>gmake</i></tt>).
1730 So this area is a bit of a grab bag, especially on Windows.
1731 The default value depends on the platform and
1732 Unix Commands being used.
1733 On Linux the default will be
1734 <tt>$(ALT_JDK_DEVTOOLS_PATH)/linux/bin</tt>,
1735 on Solaris
1736 <tt>$(ALT_JDK_DEVTOOLS_PATH)/<i>{sparc,i386}</i>/bin</tt>,
1737 and on Windows with CYGWIN
1738 <tt>/usr/bin</tt>.
1739 </dd>
1740 <dt><tt><a name="ALT_DROPS_DIR">ALT_DROPS_DIR</a></tt> </dt>
1741 <dd>
1742 The location of any source drop bundles
1743 (see <a href="#drops">Managing the Source Drops</a>).
1744 The default will be
1745 <tt>$(ALT_JDK_DEVTOOLS_PATH)/share/jdk8-drops</tt>.
1746 </dd>
1747 <dt><a name="ALT_UNIXCCS_PATH"><tt>ALT_UNIXCCS_PATH</tt></a></dt>
1748 <dd>
1749 <strong>Solaris only:</strong>
1750 An override for specifying where the Unix CCS
1751 command set are located.
1752 The default location is <tt>/usr/ccs/bin</tt>
1753 </dd>
1754 <dt><a name="ALT_SLASH_JAVA"><tt>ALT_SLASH_JAVA</tt></a></dt>
1755 <dd>
1756 The default root location for many of the ALT path locations
1757 of the following ALT variables.
1758 The default value is
1759 <tt>"/java"</tt> on Solaris and Linux,
1760 <tt>"J:"</tt> on Windows.
1761 </dd>
1762 <dt><a name="ALT_BUILD_JDK_IMPORT_PATH"><tt>ALT_BUILD_JDK_IMPORT_PATH</tt></a></dt>
1763 <dd>
1764 These are useful in managing builds on multiple platforms.
1765 The default network location for all of the import JDK images
1766 for all platforms.
1767 If <tt><a href="#ALT_JDK_IMPORT_PATH">ALT_JDK_IMPORT_PATH</a></tt>
1768 is not set, this directory will be used and should contain
1769 the following directories:
1770 <tt>solaris-sparc</tt>,
1771 <tt>solaris-i586</tt>,
1772 <tt>solaris-sparcv9</tt>,
1773 <tt>solaris-amd64</tt>,
1774 <tt>linux-i586</tt>,
1775 <tt>linux-amd64</tt>,
1776 <tt>windows-i586</tt>,
1777 and
1778 <tt>windows-amd64</tt>.
1779 Where each of these directories contain the import JDK image
1780 for that platform.
1781 </dd>
1782 <dt><a name="ALT_OPENWIN_HOME"><tt>ALT_OPENWIN_HOME</tt></a></dt>
1783 <dd>
1784 The top-level directory of the libraries and include files for the platform's
1785 graphical programming environment. The default location is platform specific.
1786 For example, on Linux it defaults to <tt>/usr/X11R6/</tt>.
1787 </dd>
1788 <dt><strong>Windows specific:</strong></dt>
1789 <dd>
1790 <dl>
1791 <dt><a name="ALT_WINDOWSSDKDIR"><tt>ALT_WINDOWSSDKDIR</tt></a> </dt>
1792 <dd>
1793 The location of the
1794 Microsoft Windows SDK where some tools will be
1795 located.
1796 The default is whatever WINDOWSSDKDIR is set to
1797 (or WindowsSdkDir) or the path
1798 <br>
1799 <tt>c:\Program Files\Microsoft SDKs\Windows\v7.0a</tt>
1800 </dd>
1801 <dt><tt><a name="ALT_DXSDK_PATH">ALT_DXSDK_PATH</a></tt> </dt>
1802 <dd>
1803 The location of the
1804 <a href="#dxsdk">Microsoft DirectX 9 SDK</a>.
1805 The default will be to try and use the DirectX environment
1806 variable <tt>DXSDK_DIR</tt>,
1807 failing that, look in <tt>C:/DXSDK</tt>.
1808 </dd>
1809 <dt><tt><a name="ALT_MSVCRNN_DLL_PATH">ALT_MSVCRNN_DLL_PATH</a></tt> </dt>
1810 <dd>
1811 The location of the
1812 <a href="#msvcrNN"><tt>MSVCR100.DLL</tt></a>.
1813 </dd>
1814 </dl>
1815 </dd>
1816 <dt><strong>Cross-Compilation Support:</strong></dt>
1817 <dd>
1818 <dl>
1819 <dt><a name="CROSS_COMPILE_ARCH"><tt>CROSS_COMPILE_ARCH</tt></a> </dt>
1820 <dd>
1821 Set to the target architecture of a cross-compilation build. If set, this
1822 variable is used to signify that we are cross-compiling. The expectation
1823 is that <a href="#ALT_COMPILER_PATH"><tt>ALT_COMPILER_PATH</tt></a> is set
1824 to point to the cross-compiler and that any cross-compilation specific flags
1825 are passed using <a href="#EXTRA_CFLAGS"><tt>EXTRA_CFLAGS</tt></a>.
1826 The <a href="#ALT_OPENWIN_HOME"><tt>ALT_OPENWIN_HOME</tt></a> variable should
1827 also be set to point to the graphical header files (e.g. X11) provided with
1828 the cross-compiler.
1829 When cross-compiling we skip execution of any demos etc that may be built, and
1830 also skip binary-file verification.
1831 </dd>
1832 <dt><tt><a name="EXTRA_CFLAGS">EXTRA_CFLAGS</a></tt> </dt>
1833 <dd>
1834 Used to pass cross-compilation options to the cross-compiler.
1835 These are added to the <tt>CFLAGS</tt> and <tt>CXXFLAGS</tt> variables.
1836 </dd>
1837 <dt><tt><a name="USE_ONLY_BOOTDIR_TOOLS">USE_ONLY_BOOTDIR_TOOLS</a></tt> </dt>
1838 <dd>
1839 Used primarily for cross-compilation builds (and always set in that case)
1840 this variable indicates that tools from the boot JDK should be used during
1841 the build process, not the tools (<tt>javac</tt>, <tt>javah</tt>, <tt>jar</tt>)
1842 just built (which can't execute on the build host).
1843 </dd>
1844 <dt><tt><a name="HOST_CC">HOST_CC</a></tt> </dt>
1845 <dd>
1846 The location of the C compiler to generate programs to run on the build host.
1847 Some parts of the build generate programs that are then compiled and executed
1848 to produce other parts of the build. Normally the primary C compiler is used
1849 to do this, but when cross-compiling that would be the cross-compiler and the
1850 resulting program could not be executed.
1851 On Linux this defaults to <tt>/usr/bin/gcc</tt>; on other platforms it must be
1852 set explicitly.
1853 </dd>
1854 </dl>
1855 <dt><strong>Specialized Build Options:</strong></dt>
1856 <dd>
1857 Some build variables exist to support specialized build environments and/or specialized
1858 build products. Their use is only supported in those contexts:
1859 <dl>
1860 <dt><tt><a name="BUILD_CLIENT_ONLY">BUILD_CLIENT_ONLY</a></tt> </dt>
1861 <dd>
1862 Indicates this build will only contain the Hotspot client VM. In addition to
1863 controlling the Hotspot build target, it ensures that we don't try to copy
1864 any server VM files/directories, and defines a default <tt>jvm.cfg</tt> file
1865 suitable for a client-only environment. Using this in a 64-bit build will
1866 generate a sanity warning as 64-bit client builds are not directly supported.
1867 </dd>
1868 <dt><tt><a name="BUILD_HEADLESS_ONLY"></a>BUILD_HEADLESS_ONLY</tt> </dt>
1869 <dd>
1870 Used when the build environment has no graphical capabilities at all. This
1871 excludes building anything that requires graphical libraries to be available.
1872 </dd>
1873 <dt><tt><a name="JAVASE_EMBEDDED"></a>JAVASE_EMBEDDED</tt> </dt>
1874 <dd>
1875 Used to indicate this is a build of the Oracle Java SE Embedded product.
1876 This will enable the directives included in the SE-Embedded specific build
1877 files.
1878 </dd>
1879 <dt><tt><a name="LIBZIP_CAN_USE_MMAP">LIBZIP_CAN_USE_MMAP</a></tt> </dt>
1880 <dd>
1881 If set to false, disables the use of mmap by the zip utility. Otherwise,
1882 mmap will be used.
1883 </dd>
1884 <dt><tt><a name="COMPRESS_JARS"></a>COMPRESS_JARS</tt> </dt>
1885 <dd>
1886 If set to true, causes certain jar files that would otherwise be built without
1887 compression, to use compression.
1888 </dd>
1889 </dl>
1890 </dd>
1891 </dl>
1892 </blockquote>
1893 <!-- ------------------------------------------------------ -->
1894 <hr>
1895 <h2><a name="hints">Hints and Tips</a></h2>
1896 <blockquote>
1897 You don't have to use all these hints and tips, and in fact people do actually
1898 build with systems that contradict these, but they might prove to be
1899 helpful to some.
1900 <ul>
1901 <li>
1902 If <tt>make sanity</tt> does not work, find out why, fix that
1903 before going any further. Or at least understand what the
1904 complaints are from it.
1905 </li>
1906 <li>
1907 JDK: Keep in mind that you are building a JDK, but you need
1908 a JDK (BOOTDIR JDK) to build this JDK.
1909 </li>
1910 <li>
1911 Ant: The ant utility is a java application and besides having
1912 ant available to you, it's important that ant finds the right
1913 java to run with. Make sure you can type <tt>ant -version</tt>
1914 and get clean results with no error messages.
1915 </li>
1916 <li>
1917 Linux: Try and favor the system packages over building your own
1918 or getting packages from other areas.
1919 Most Linux builds should be possible with the system's
1920 available packages.
1921 </li>
1922 <li>
1923 Solaris: Typically you will need to get compilers on your systems
1924 and occasionally GNU make 3.81 if a gmake binary is not available.
1925 The gmake binary might not be 3.81, be careful.
1926 </li>
1927 <li>
1928 Windows VS2010:
1929 <ul>
1930 <li>
1931 Only the C++ part of VS2010 is needed.
1932 Try to let the installation go to the default install directory.
1933 Always reboot your system after installing VS2010.
1934 The system environment variable VS100COMNTOOLS should be
1935 set in your environment.
1936 </li>
1937 <li>
1938 Make sure that TMP and TEMP are also set in the environment
1939 and refer to Windows paths that exist, like <tt>C:\temp</tt>,
1940 not <tt>/tmp</tt>, not <tt>/cygdrive/c/temp</tt>, and not <tt>C:/temp</tt>.
1941 <tt>C:\temp</tt> is just an example, it is assumed that this area is
1942 private to the user, so by default after installs you should
1943 see a unique user path in these variables.
1944 </li>
1945 <li>
1946 You need to use vsvars32.bat or vsvars64.bat to get the
1947 PATH, INCLUDE, LIB, LIBPATH, and WINDOWSSDKDIR
1948 variables set in your shell environment.
1949 These bat files are not easy to use from a shell environment.
1950 However, there is a script placed in the root jdk8 repository called
1951 vsvars.sh that can help, it should only be done once in a shell
1952 that will be doing the build, e.g.<br>
1953 <tt>sh ./make/scripts/vsvars.sh -v10 > settings<br>
1954 eval `cat settings`</tt><br>
1955 Or just <tt>eval `sh ./make/scripts/vsvars.sh -v10`</tt>.
1956 </li>
1957 </ul>
1958 </li>
1959 <li>
1960 Windows: PATH order is critical, see the
1961 <a href="#paths">paths</a> section for more information.
1962 </li>
1963 <li>
1964 Windows 64bit builds: Use ARCH_DATA_MODEL=64.
1965 </li>
1966 </ul>
1967 </blockquote>
1968 <!-- ------------------------------------------------------ -->
1969 <hr>
1970 <h2><a name="troubleshooting">Troubleshooting</a></h2>
1971 <blockquote>
1972 A build can fail for any number of reasons.
1973 Most failures
1974 are a result of trying to build in an environment in which all the
1975 pre-build requirements have not been met.
1976 The first step in
1977 troubleshooting a build failure is to recheck that you have satisfied
1978 all the pre-build requirements for your platform.
1979 Look for the check list of the platform you are building on in the
1980 <a href="#contents">Table of Contents</a>.
1981 <p>
1982 You can validate your build environment by using the <tt>sanity</tt>
1983 target.
1984 Any errors listed
1985 will stop the build from starting, and any warnings may result in
1986 a flawed product build.
1987 We strongly encourage you to evaluate every
1988 sanity check warning and fix it if required, before you proceed
1989 further with your build.
1990 <p>
1991 Some of the more common problems with builds are briefly described
1992 below, with suggestions for remedies.
1993 <ul>
1994 <li>
1995 <b>Corrupted Bundles on Windows:</b>
1996 <blockquote>
1997 Some virus scanning software has been known to corrupt the
1998 downloading of zip bundles.
1999 It may be necessary to disable the 'on access' or 'real time'
2000 virus scanning features to prevent this corruption.
2001 This type of "real time" virus scanning can also slow down the
2002 build process significantly.
2003 Temporarily disabling the feature, or excluding the build
2004 output directory may be necessary to get correct and faster builds.
2005 </blockquote>
2006 </li>
2007 <li>
2008 <b>Slow Builds:</b>
2009 <blockquote>
2010 If your build machine seems to be overloaded from too many
2011 simultaneous C++ compiles, try setting the <tt>HOTSPOT_BUILD_JOBS</tt>
2012 variable to <tt>1</tt> (if you're using a multiple CPU
2013 machine, setting it to more than the the number of CPUs is probably
2014 not a good idea).
2015 <p>
2016 Creating the javadocs can be very slow, if you are running
2017 javadoc, consider skipping that step.
2018 <p>
2019 Faster hardware and more RAM always helps too.
2020 The VM build tends to be CPU intensive (many C++ compiles),
2021 and the rest of the JDK will often be disk intensive.
2022 <p>
2023 Faster compiles are possible using a tool called
2024 <a href="http://ccache.samba.org/" target="_blank">ccache</a>.
2025 </blockquote>
2026 </li>
2027 <li>
2028 <b>File time issues:</b>
2029 <blockquote>
2030 If you see warnings that refer to file time stamps, e.g.
2031 <blockquote>
2032 <i>Warning message:</i><tt> File `xxx' has modification time in
2033 the future.</tt>
2034 <br>
2035 <i>Warning message:</i> <tt> Clock skew detected. Your build may
2036 be incomplete.</tt>
2037 </blockquote>
2038 These warnings can occur when the clock on the build machine is out of
2039 sync with the timestamps on the source files. Other errors, apparently
2040 unrelated but in fact caused by the clock skew, can occur along with
2041 the clock skew warnings. These secondary errors may tend to obscure the
2042 fact that the true root cause of the problem is an out-of-sync clock.
2043 For example, an out-of-sync clock has been known to cause an old
2044 version of javac to be used to compile some files, resulting in errors
2045 when the pre-1.4 compiler ran across the new <tt>assert</tt> keyword
2046 in the 1.4 source code.
2047 <p>
2048 If you see these warnings, reset the clock on the build
2049 machine, run "<tt><i>gmake</i> clobber</tt>" or delete the directory
2050 containing the build output, and restart the build from the beginning.
2051 </blockquote>
2052 </li>
2053 <li>
2054 <b>Error message: <tt>Trouble writing out table to disk</tt></b>
2055 <blockquote>
2056 Increase the amount of swap space on your build machine.
2057 </blockquote>
2058 </li>
2059 <li>
2060 <b>Error Message: <tt>libstdc++ not found:</tt></b>
2061 <blockquote>
2062 This is caused by a missing libstdc++.a library.
2063 This is installed as part of a specific package
2064 (e.g. libstdc++.so.devel.386).
2065 By default some 64-bit Linux versions (e.g. Fedora)
2066 only install the 64-bit version of the libstdc++ package.
2067 Various parts of the JDK build require a static
2068 link of the C++ runtime libraries to allow for maximum
2069 portability of the built images.
2070 </blockquote>
2071 </li>
2072 <li>
2073 <b>Error Message: <tt>cannot restore segment prot after reloc</tt></b>
2074 <blockquote>
2075 This is probably an issue with SELinux (See
2076 <a href="http://en.wikipedia.org/wiki/SELinux" target="_blank">
2077 http://en.wikipedia.org/wiki/SELinux</a>).
2078 Parts of the VM is built without the <tt>-fPIC</tt> for
2079 performance reasons.
2080 <p>
2081 To completely disable SELinux:
2082 <ol>
2083 <li><tt>$ su root</tt></li>
2084 <li><tt># system-config-securitylevel</tt></li>
2085 <li><tt>In the window that appears, select the SELinux tab</tt></li>
2086 <li><tt>Disable SELinux</tt></li>
2087 </ol>
2088 <p>
2089 Alternatively, instead of completely disabling it you could
2090 disable just this one check.
2091 <ol>
2092 <li>Select System->Administration->SELinux Management</li>
2093 <li>In the SELinux Management Tool which appears,
2094 select "Boolean" from the menu on the left</li>
2095 <li>Expand the "Memory Protection" group</li>
2096 <li>Check the first item, labeled
2097 "Allow all unconfined executables to use libraries requiring text relocation ..."</li>
2098 </ol>
2099 </blockquote>
2100 </li>
2101 <li>
2102 <b>Windows Error Messages:</b><br>
2103 <tt>*** fatal error - couldn't allocate heap, ... </tt><br>
2104 <tt>rm fails with "Directory not empty"</tt><br>
2105 <tt>unzip fails with "cannot create ... Permission denied"</tt><br>
2106 <tt>unzip fails with "cannot create ... Error 50"</tt><br>
2107 <blockquote>
2108 The CYGWIN software can conflict with other non-CYGWIN
2109 software. See the CYGWIN FAQ section on
2110 <a href="http://cygwin.com/faq/faq.using.html#faq.using.bloda" target="_blank">
2111 BLODA (applications that interfere with CYGWIN)</a>.
2112 </blockquote>
2113 </li>
2114 <li>
2115 <b>Windows Error Message: <tt>spawn failed</tt></b>
2116 <blockquote>
2117 Try rebooting the system, or there could be some kind of
2118 issue with the disk or disk partition being used.
2119 Sometimes it comes with a "Permission Denied" message.
2120 </blockquote>
2121 </li>
2122 </ul>
2123 </blockquote>
2124 <!-- ------------------------------------------------------ -->
2125 <hr>
2126 <h2><a name="newbuild">The New Build</a></h2>
2127 <blockquote>
2128 The <a href="http://openjdk.java.net/projects/build-infra/">
2129 Build Infrastructure project</a> is working on a new
2130 build. For information on how to try it out, please see the
2131 <a href="http://openjdk.java.net/projects/build-infra/guide.html">
2132 Build Infra User Guide</a>
2133 </blockquote>
2134 <hr>
2135 </body>
2136 </html>