blob: 414403b2ee367a5d31906be265742522e8a5a49d [file] [log] [blame]
J. Duke686d76f2007-12-01 00:00:00 +00001<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
J. Duke686d76f2007-12-01 00:00:00 +00002<html>
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -07003 <head>
4 <title>OpenJDK Build README</title>
5 </head>
6 <body style="background-color:lightcyan">
7 <!-- ====================================================== -->
Kelly O'Hair2928b812008-09-17 13:30:32 -07008 <table width="100%">
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -07009 <tr>
10 <td align="center">
Kelly O'Hair634c79b2008-07-09 15:42:00 -070011 <img alt="OpenJDK"
12 src="http://openjdk.java.net/images/openjdk.png"
13 width=256 />
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -070014 </td>
15 </tr>
16 <tr>
17 <td align=center>
18 <h1>OpenJDK Build README</h1>
19 </td>
20 </tr>
J. Duke686d76f2007-12-01 00:00:00 +000021 </table>
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -070022 <!-- ------------------------------------------------------ -->
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>
J. Duke686d76f2007-12-01 00:00:00 +000038 <ul>
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -070039 <li><a href="#introduction">Introduction</a></li>
40 <li><a href="#MBE">Minimum Build Environments</a></li>
Dalibor Topic73e9e342009-09-23 20:06:01 +020041 <li><a href="#SDBE">Specific Developer Build Environments</a>
Kelly O'Hair2928b812008-09-17 13:30:32 -070042 <ul>
43 <li><a href="#fedora">Fedora Linux</a> </li>
44 <li><a href="#centos">CentOS Linux</a> </li>
Dalibor Topic73e9e342009-09-23 20:06:01 +020045 <li><a href="#debian">Debian GNU/Linux</a></li>
46 <li><a href="#ubuntu">Ubuntu Linux</a> </li>
47 <li><a href="#opensuse">OpenSUSE</a></li>
48 <li><a href="#mandriva">Mandriva</a></li>
49 <li><a href="#opensolaris">OpenSolaris</a></li>
Kelly O'Hair2928b812008-09-17 13:30:32 -070050 </ul>
Dalibor Topic73e9e342009-09-23 20:06:01 +020051 </li>
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -070052 <li><a href="#directories">Source Directory Structure</a> </li>
53 <li><a href="#building">Build Information</a>
54 <ul>
55 <li><a href="#gmake">GNU Make (<tt><i>gmake</i></tt>)</a> </li>
56 <li><a href="#linux">Basic Linux System Setup</a> </li>
57 <li><a href="#solaris">Basic Solaris System Setup</a> </li>
58 <li><a href="#windows">Basic Windows System Setup</a> </li>
59 <li><a href="#dependencies">Build Dependencies</a> </li>
60 <ul>
61 <li><a href="#bootjdk">Bootstrap JDK</a> </li>
62 <li><a href="#binaryplugs">Binary Plugs</a> </li>
63 <li><a href="#importjdk">Optional Import JDK</a> </li>
Kelly O'Hair634c79b2008-07-09 15:42:00 -070064 <li><a href="#ant">Ant</a> </li>
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -070065 <li><a href="#cacerts">Certificate Authority File (cacert)</a> </li>
66 <li><a href="#compilers">Compilers</a>
67 <ul>
68 <li><a href="#msvc">Microsoft Visual Studio</a> </li>
69 <li><a href="#mssdk">Microsoft Platform SDK</a> </li>
70 <li><a href="#gcc">Linux gcc/binutils</a> </li>
71 <li><a href="#studio">Sun Studio</a> </li>
72 </ul>
73 </li>
74 <li><a href="#zip">Zip and Unzip</a> </li>
75 <li><a href="#freetype">FreeType2 Fonts</a> </li>
76 <li>Linux and Solaris:
77 <ul>
78 <li><a href="#cups">CUPS Include files</a> </li>
Andrew John Hughese4d60712009-06-17 20:53:01 +010079 <li><a href="#xrender">XRender Include files</a></li>
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -070080 </ul>
81 </li>
82 <li>Linux only:
83 <ul>
84 <li><a href="#alsa">ALSA files</a> </li>
85 </ul>
86 </li>
87 <li>Windows only:
88 <ul>
89 <li>Unix Command Tools (<a href="#cygwin">CYGWIN</a>)</li>
90 <li><a href="#dxsdk">DirectX 9.0 SDK</a> </li>
91 </ul>
92 </li>
93 </ul>
94 </ul>
95 </li>
96 <li><a href="#creating">Creating the Build</a> </li>
97 <li><a href="#testing">Testing the Build</a> </li>
98 <li><a href="#variables">Environment/Make Variables</a></li>
99 <li><a href="#troubleshooting">Troubleshooting</a></li>
J. Duke686d76f2007-12-01 00:00:00 +0000100 </ul>
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -0700101 </blockquote>
102 <!-- ------------------------------------------------------ -->
103 <hr>
104 <h2><a name="MBE">Minimum Build Environments</a></h2>
105 <blockquote>
106 This file often describes specific requirements for what we call the
Kelly O'Haird03960122008-12-01 15:28:36 -0800107 "minimum build environments" (MBE) for this
108 specific release of the JDK,
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -0700109 Building with the MBE will generate the most compatible
110 bits that install on, and run correctly on, the most variations
111 of the same base OS and hardware architecture.
112 These usually represent what is often called the
113 least common denominator platforms.
114 It is understood that most developers will NOT be using these
115 specific platforms, and in fact creating these specific platforms
116 may be difficult due to the age of some of this software.
117 <p>
118 The minimum OS and C/C++ compiler versions needed for building the
119 OpenJDK:
120 <p>
121 <table border="1">
122 <thead>
123 <tr>
124 <th>Base OS and Architecture</th>
125 <th>OS</th>
Kelly O'Haird03960122008-12-01 15:28:36 -0800126 <th>C/C++ Compiler</th>
Xiomara Jayasenababd1162009-06-22 10:13:20 -0700127 <th>BOOT JDK</th>
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -0700128 </tr>
129 </thead>
130 <tbody>
131 <tr>
Kelly O'Haird03960122008-12-01 15:28:36 -0800132 <td>Linux X86 (32-bit)</td>
133 <td>Fedora 9</td>
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -0700134 <td>gcc 4 </td>
Xiomara Jayasenababd1162009-06-22 10:13:20 -0700135 <td>JDK 6u14 FCS </td>
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -0700136 </tr>
137 <tr>
Kelly O'Haird03960122008-12-01 15:28:36 -0800138 <td>Linux X64 (64-bit)</td>
139 <td>Fedora 9</td>
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -0700140 <td>gcc 4 </td>
Xiomara Jayasenababd1162009-06-22 10:13:20 -0700141 <td>JDK 6u14 FCS </td>
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -0700142 </tr>
143 <tr>
Kelly O'Haird03960122008-12-01 15:28:36 -0800144 <td>Solaris SPARC (32-bit)</td>
Xiomara Jayasenababd1162009-06-22 10:13:20 -0700145 <td>Solaris 10u2 + patches
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -0700146 <br>
147 See <a href="http://sunsolve.sun.com/pub-cgi/show.pl?target=patches/JavaSE" target="_blank">
148 SunSolve</a> for patch downloads.
149 </td>
Kelly O'Hair9af3b7b2008-08-06 16:06:43 -0700150 <td>Sun Studio 12</td>
Xiomara Jayasenababd1162009-06-22 10:13:20 -0700151 <td>JDK 6u14 FCS </td>
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -0700152 </tr>
153 <tr>
Kelly O'Haird03960122008-12-01 15:28:36 -0800154 <td>Solaris SPARCV9 (64-bit)</td>
Xiomara Jayasenababd1162009-06-22 10:13:20 -0700155 <td>Solaris 10u2 + patches
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -0700156 <br>
157 See <a href="http://sunsolve.sun.com/pub-cgi/show.pl?target=patches/JavaSE" target="_blank">
158 SunSolve</a> for patch downloads.
159 </td>
Kelly O'Hair9af3b7b2008-08-06 16:06:43 -0700160 <td>Sun Studio 12</td>
Xiomara Jayasenababd1162009-06-22 10:13:20 -0700161 <td>JDK 6u14 FCS </td>
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -0700162 </tr>
163 <tr>
Kelly O'Haird03960122008-12-01 15:28:36 -0800164 <td>Solaris X86 (32-bit)</td>
Xiomara Jayasenababd1162009-06-22 10:13:20 -0700165 <td>Solaris 10u2 + patches
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -0700166 <br>
167 See <a href="http://sunsolve.sun.com/pub-cgi/show.pl?target=patches/JavaSE" target="_blank">
168 SunSolve</a> for patch downloads.
169 </td>
Kelly O'Hair9af3b7b2008-08-06 16:06:43 -0700170 <td>Sun Studio 12</td>
Xiomara Jayasenababd1162009-06-22 10:13:20 -0700171 <td>JDK 6u14 FCS </td>
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -0700172 </tr>
173 <tr>
Kelly O'Haird03960122008-12-01 15:28:36 -0800174 <td>Solaris X64 (64-bit)</td>
Xiomara Jayasenababd1162009-06-22 10:13:20 -0700175 <td>Solaris 10u2 + patches
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -0700176 <br>
177 See <a href="http://sunsolve.sun.com/pub-cgi/show.pl?target=patches/JavaSE" target="_blank">
178 SunSolve</a> for patch downloads.
179 </td>
Kelly O'Hair9af3b7b2008-08-06 16:06:43 -0700180 <td>Sun Studio 12</td>
Xiomara Jayasenababd1162009-06-22 10:13:20 -0700181 <td>JDK 6u14 FCS </td>
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -0700182 </tr>
183 <tr>
Kelly O'Haird03960122008-12-01 15:28:36 -0800184 <td>Windows X86 (32-bit)</td>
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -0700185 <td>Windows XP</td>
Kelly O'Haird03960122008-12-01 15:28:36 -0800186 <td>Microsoft Visual Studio C++ 2008 Standard Edition</td>
Xiomara Jayasenababd1162009-06-22 10:13:20 -0700187 <td>JDK 6u14 FCS </td>
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -0700188 </tr>
189 <tr>
Kelly O'Haird03960122008-12-01 15:28:36 -0800190 <td>Windows X64 (64-bit)</td>
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -0700191 <td>Windows Server 2003 - Enterprise x64 Edition</td>
192 <td>Microsoft Platform SDK - April 2005</td>
Xiomara Jayasenababd1162009-06-22 10:13:20 -0700193 <td>JDK 6u14 FCS </td>
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -0700194 </tr>
195 </tbody>
196 </table>
Kelly O'Haird03960122008-12-01 15:28:36 -0800197 <p>
198 These same sources do indeed build on many more systems than the
199 above older generation systems, again the above is just a minimum.
200 <p>
201 Compilation problems with newer or different C/C++ compilers is a
202 common problem.
203 Similarly, compilation problems related to changes to the
204 <tt>/usr/include</tt> or system header files is also a
205 common problem with newer or unreleased OS versions.
206 Please report these types of problems as bugs so that they
207 can be dealt with accordingly.
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -0700208 </blockquote>
209 <!-- ------------------------------------------------------ -->
210 <hr>
211 <h2><a name="SDBE">Specific Developer Build Environments</a></h2>
212 <blockquote>
213 We won't be listing all the possible environments, but
214 we will try to provide what information we have available to us.
215 </blockquote>
216 <!-- ------------------------------------------------------ -->
Dalibor Topic73e9e342009-09-23 20:06:01 +0200217 <h3><a name="fedora">Fedora</a></h3>
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -0700218 <blockquote>
Dalibor Topic73e9e342009-09-23 20:06:01 +0200219 <h4>Fedora 9</h4>
220 <p>
221 <blockquote>
222 After installing <a href="http://fedoraproject.org">Fedora</a> 9
223 you need to install several build dependencies. The simplest
224 way to do it is to execute the following commands as user
225 <tt>root</tt>:
226 <p/>
227 <code>yum-builddep java-openjdk</code>
228 <p/>
229 <code>yum install gcc gcc-c++</code>
230 <p/>
231 In addition, it's necessary to set a few environment variables for the build:
232
233 <p/>
234 <code>export LANG=C ALT_BOOTDIR=/usr/lib/jvm/java-openjdk</code>
Kelly O'Hair2928b812008-09-17 13:30:32 -0700235 </blockquote>
Dalibor Topic73e9e342009-09-23 20:06:01 +0200236 <h4>Fedora 10</h4>
237 <p>
238 <blockquote>
239 After installing <a href="http://fedoraproject.org">Fedora</a> 10
240 you need to install several build dependencies. The simplest
241 way to do it is to execute the following commands as user
242 <tt>root</tt>:
243 <p/>
244 <code>yum-builddep java-1.6.0-openjdk</code>
245 <p/>
246 <code>yum install gcc gcc-c++</code>
247 <p/>
248 In addition, it's necessary to set a few environment variables for the build:
249
250 <p/>
251 <code>export LANG=C ALT_BOOTDIR=/usr/lib/jvm/java-openjdk</code>
252 </blockquote>
253 <h4>Fedora 11</h4>
254 <p>
255 <blockquote>
256 After installing <a href="http://fedoraproject.org">Fedora</a> 11
257 you need to install several build dependencies. The simplest
258 way to do it is to execute the following commands as user
259 <tt>root</tt>:
260 <p/>
261 <code>yum-builddep java-1.6.0-openjdk</code>
262 <p/>
263 <code>yum install gcc gcc-c++</code>
264 <p/>
265 In addition, it's necessary to set a few environment variables for the build:
266
267 <p/>
268 <code>export LANG=C ALT_BOOTDIR=/usr/lib/jvm/java-openjdk</code>
269 </blockquote>
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -0700270 </blockquote>
271 <!-- ------------------------------------------------------ -->
Kelly O'Hair2928b812008-09-17 13:30:32 -0700272 <h3><a name="centos">CentOS 5.2</a></h3>
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -0700273 <blockquote>
Kelly O'Hair2928b812008-09-17 13:30:32 -0700274 After installing
275 <a href="http://www.centos.org/">CentOS 5.2</a>
276 you need to make sure you have
277 the following Development bundles installed:
278 <blockquote>
279 <ul>
280 <li>Development Libraries</li>
281 <li>Development Tools</li>
282 <li>Java Development</li>
283 <li>X Software Development</li>
284 </ul>
285 </blockquote>
286 <p>
287 Plus the following packages:
288 <blockquote>
289 <ul>
290 <li>cups devel: Cups Development Package</li>
291 <li>alsa devel: Alsa Development Package</li>
292 <li>ant: Ant Package</li>
293 <li>Xi devel: libXi.so Development Package</li>
294 </ul>
295 </blockquote>
296 <p>
297 The freetype 2.3 packages don't seem to be available,
298 but the freetype 2.3 sources can be downloaded, built,
299 and installed easily enough from
300 <a href="http://downloads.sourceforge.net/freetype">
301 the freetype site</a>.
302 Build and install with something like:
303 <blockquote>
304 <tt>./configure && make && sudo -u root make install</tt>
305 </blockquote>
306 <p>
307 Mercurial packages could not be found easily, but a Google
308 search should find ones, and they usually include Python if
309 it's needed.
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -0700310 </blockquote>
311 <!-- ------------------------------------------------------ -->
Dalibor Topic73e9e342009-09-23 20:06:01 +0200312 <h3><a name="debian">Debian</a></h3>
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -0700313 <blockquote>
Dalibor Topic73e9e342009-09-23 20:06:01 +0200314 <h4>Debian 5.0 (Lenny)</h4>
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -0700315 <p>
Dalibor Topic73e9e342009-09-23 20:06:01 +0200316 <blockquote>
317 After installing <a href="http://debian.org">Debian</a> 5
318 you need to install several build dependencies.
319 The simplest way to install the build dependencies is to
320 execute the following commands as user <tt>root</tt>:
321 <p/>
322 <code>aptitude build-dep openjdk-6</code>
323 <p/>
324 <code>aptitude install openjdk-6-jdk libmotif-dev</code>
325 <p/>
326 In addition, it's necessary to set a few environment variables for the build:
327 <p/>
328 <code>export LANG=C ALT_BOOTDIR=/usr/lib/jvm/java-6-openjdk</code>
329 </blockquote>
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -0700330 </blockquote>
Dalibor Topic73e9e342009-09-23 20:06:01 +0200331 <!-- ====================================================== -->
332 <h3><a name="ubuntu">Ubuntu</a></h3>
333 <blockquote>
334 <h4>Ubuntu 8.04</h4>
335 <p>
336 <blockquote>
337 After installing <a href="http://ubuntu.org">Ubuntu</a> 8.04
338 you need to install several build dependencies.
339 <p/>
340 First, you need to enable the universe repository in the
341 Software Sources application and reload the repository
342 information. The Software Sources application is available
343 under the System/Administration menu.
344 <p/>
345 The simplest way to install the build dependencies is to
346 execute the following commands:
347 <p/>
348 <code>sudo aptitude build-dep openjdk-6</code>
349 <p/>
350 <code>sudo aptitude install openjdk-6-jdk</code>
351 <p/>
352 In addition, it's necessary to set a few environment variables for the build:
353 <p/>
354 <code>export LANG=C ALT_BOOTDIR=/usr/lib/jvm/java-6-openjdk</code>
355 </blockquote>
356 <h4>Ubuntu 8.10</h4>
357 <p>
358 <blockquote>
359 After installing <a href="http://ubuntu.org">Ubuntu</a> 8.10
360 you need to install several build dependencies. The simplest
361 way to do it is to execute the following commands:
362 <p/>
363 <code>sudo aptitude build-dep openjdk-6</code>
364 <p/>
365 <code>sudo aptitude install openjdk-6-jdk</code>
366 <p/>
367 In addition, it's necessary to set a few environment variables for the build:
368 <p/>
369 <code>export LANG=C ALT_BOOTDIR=/usr/lib/jvm/java-6-openjdk</code>
370 </blockquote>
371 <h4>Ubuntu 9.04</h4>
372 <p>
373 <blockquote>
374 After installing <a href="http://ubuntu.org">Ubuntu</a> 9.04
375 you need to install several build dependencies. The simplest
376 way to do it is to execute the following commands:
377 <p/>
378 <code>sudo aptitude build-dep openjdk-6</code>
379 <p/>
380 <code>sudo aptitude install openjdk-6-jdk</code>
381 <p/>
382 In addition, it's necessary to set a few environment variables for the build:
383 <p/>
384 <code>export LANG=C ALT_BOOTDIR=/usr/lib/jvm/java-6-openjdk</code>
385 </blockquote>
386 </blockquote>
387 <!-- ====================================================== -->
388 <h3><a name="opensuse">OpenSUSE</a></h3>
389 <blockquote>
390 <h4>OpenSUSE 11.1</h4>
391 <p>
392 <blockquote>
393 After installing <a href="http://opensuse.org">OpenSUSE</a> 11.1
394 you need to install several build dependencies.
395 The simplest way to install the build dependencies is to
396 execute the following commands:
397 <p/>
398 <code>sudo zypper source-install -d java-1_6_0-openjdk</code>
399 <p/>
400 <code>sudo zypper install make</code>
401 <p/>
402 In addition, it is necessary to set a few environment variables for the build:
403 <p/>
404 <code>export LANG=C ALT_BOOTDIR=/usr/lib/jvm/java-1.6.0-openjdk</code>
405 <p/>
406 Finally, you need to unset the <code>JAVA_HOME</code> environment variable:
407 <p/>
408 <code>export -n JAVA_HOME</code>
409 </blockquote>
410 </blockquote>
411 <!-- ====================================================== -->
412 <h3><a name="mandriva">Mandriva</a></h3>
413 <blockquote>
414 <h4>Mandriva Linux One 2009 Spring</h4>
415 <p>
416 <blockquote>
417 After installing <a href="http://mandriva.org">Mandriva</a> Linux One 2009 Spring
418 you need to install several build dependencies.
419 The simplest way to install the build dependencies is to
420 execute the following commands as user <tt>root</tt>:
421 <p/>
422 <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>
423 <p/>
424 In addition, it is necessary to set a few environment variables for the build:
425 <p/>
426 <code>export LANG=C ALT_BOOTDIR=/usr/lib/jvm/java-1.6.0-openjdk</code>
427 </blockquote>
428 </blockquote>
429 <!-- ====================================================== -->
430 <h3><a name="opensolaris">OpenSolaris</a></h3>
431 <blockquote>
432 <h4>OpenSolaris 2009.06</h4>
433 <p>
434 <blockquote>
435 After installing <a href="http://opensolaris.org">OpenSolaris</a> 2009.06
436 you need to install several build dependencies.
437 The simplest way to install the build dependencies is to
438 execute the following commands:
439 <p/>
440 <code>pfexec pkg install SUNWgmake SUNWj6dev SUNWant sunstudioexpress SUNWcups SUNWzip SUNWunzip SUNWxwhl SUNWxorg-headers SUNWaudh SUNWfreetype2</code>
441 <p/>
442 In addition, it is necessary to set a few environment variables for the build:
443 <p/>
444 <code>export LANG=C ALT_COMPILER_PATH=/opt/SunStudioExpress/bin/ ALT_CUPS_HEADERS_PATH=/usr/include/</code>
445 <p/>
446 Finally, you need to make sure that the build process can find the Sun Studio compilers:
447 <p/>
448 <code>export PATH=$PATH:/opt/SunStudioExpress/bin/</code>
449 </blockquote>
450 </blockquote>
451 <!-- ------------------------------------------------------ -->
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -0700452 <hr>
453 <h2><a name="directories">Source Directory Structure</a></h2>
454 <blockquote>
455 <p>
456 The source code for the OpenJDK is delivered in a set of
457 directories:
458 <tt>hotspot</tt>,
459 <tt>langtools</tt>,
460 <tt>corba</tt>,
461 <tt>jaxws</tt>,
462 <tt>jaxp</tt>,
463 and
464 <tt>jdk</tt>.
465 The <tt>hotspot</tt> directory contains the source code and make
466 files for building the OpenJDK Hotspot Virtual Machine.
467 The <tt>langtools</tt> directory contains the source code and make
468 files for building the OpenJDK javac and language tools.
469 The <tt>corba</tt> directory contains the source code and make
470 files for building the OpenJDK Corba files.
471 The <tt>jaxws</tt> directory contains the source code and make
472 files for building the OpenJDK JAXWS files.
473 The <tt>jaxp</tt> directory contains the source code and make
474 files for building the OpenJDK JAXP files.
475 The <tt>jdk</tt> directory contains the source code and make files for
476 building the OpenJDK runtime libraries and misc files.
477 The top level <tt>Makefile</tt>
478 is used to build the entire OpenJDK.
479 </blockquote>
480 <!-- ------------------------------------------------------ -->
481 <hr>
482 <h2><a name="building">Build Information</a></h2>
483 <blockquote>
484 Building the OpenJDK
485 is done with a <tt><i>gmake</i></tt>
486 command line and various
487 environment or make variable settings that direct the make rules
488 to where various components have been installed.
489 Where possible the makefiles will attempt to located the various
490 components in the default locations or any component specific
491 variable settings.
492 When the normal defaults fail or components cannot be found,
493 the various
494 <tt>ALT_*</tt> variables (alternates)
495 can be used to help the makefiles locate components.
496 <p>
497 Refer to the bash/sh/ksh setup file
498 <tt>jdk/make/jdk_generic_profile.sh</tt>
499 if you need help in setting up your environment variables.
500 A build could be as simple as:
501 <blockquote>
502 <pre><tt>
J. Duke686d76f2007-12-01 00:00:00 +0000503 bash
504 . jdk/make/jdk_generic_profile.sh
505 <i>gmake</i> sanity &amp;&amp; <i>gmake</i>
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -0700506 </tt></pre>
J. Duke686d76f2007-12-01 00:00:00 +0000507 </blockquote>
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -0700508 <p>
509 Of course ksh or sh would work too.
510 But some customization will probably be necessary.
511 The <tt>sanity</tt> rule will make some basic checks on build
512 dependencies and generate appropriate warning messages
513 regarding missing, out of date, or newer than expected components
514 found on your system.
J. Duke686d76f2007-12-01 00:00:00 +0000515 </blockquote>
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -0700516 <!-- ------------------------------------------------------ -->
517 <hr>
518 <h3><a name="gmake">GNU make (<tt><i>gmake</i></tt>)</a></h3>
J. Duke686d76f2007-12-01 00:00:00 +0000519 <blockquote>
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -0700520 The Makefiles in the OpenJDK are only valid when used with the
521 GNU version of the utility command <tt>make</tt>
522 (<tt><i>gmake</i></tt>).
523 A few notes about using GNU make:
524 <ul>
525 <li>
526 In general, you need GNU make version 3.78.1 or newer.
527 </li>
528 <li>
529 Place the location of the GNU make binary in the <tt>PATH</tt>.
530 </li>
531 <li>
532 <strong>Linux:</strong>
533 The <tt>/usr/bin/make</tt> command should work fine for you.
534 </li>
535 <li>
536 <strong>Solaris:</strong>
537 Do NOT use <tt>/usr/bin/make</tt> on Solaris.
538 If your Solaris system has the software
539 from the Solaris Companion CD installed,
540 you should use <tt>gmake</tt>
541 which will be located in either the <tt>/opt/sfw/bin</tt> or
542 <tt>/usr/sfw/bin</tt> directory.
Kelly O'Hair634c79b2008-07-09 15:42:00 -0700543 In more recent versions of Solaris GNU make can be found
544 at <tt>/usr/bin/gmake</tt>.
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -0700545 </li>
546 <li>
547 <strong>Windows:</strong>
548 Make sure you start your build inside a bash/sh/ksh shell.
549 <br>
550 <b>WARNING:</b> Watch out for make version 3.81, it may
Kelly O'Hair634c79b2008-07-09 15:42:00 -0700551 not work due to a lack of support for MS-DOS drive letter paths
552 like <tt>C:/</tt> or <tt>C:\</tt>.
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -0700553 Use a 3.80 version, or find a newer
Kelly O'Haird03960122008-12-01 15:28:36 -0800554 version that has this problem fixed.
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -0700555 The older 3.80 version of make.exe can be downloaded with this
556 <a href="http://cygwin.paracoda.com/release/make/make-3.80-1.tar.bz2" target="_blank">
557 link</a>.
Kelly O'Hair634c79b2008-07-09 15:42:00 -0700558 Use of this older 3.80 make.exe may require that you install the
559 libintl2.dll library or libintl2 cygwin package which is
560 no longer installed by default by the cygwin installer.
561 <br>
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -0700562 Also see the
563 <a href="http://developer.mozilla.org/en/docs/Windows_build_prerequisites_using_cygwin#make" target="_blank">
564 mozilla developer center</a>
565 on this topic.
Kelly O'Hair634c79b2008-07-09 15:42:00 -0700566 <br>
567 It's hoped that when make 3.82 starts shipping in a future cygwin
568 release that this MS-DOS path issue will be fixed.
569 In addition to the above 3.80 make.exe you can download
570 this
571 <a href="http://www.cmake.org/files/cygwin/make.exe">
572 www.cmake.org make.exe</a> which will not have a libintl2.dll
573 dependency.
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -0700574 </li>
575 </ul>
J. Duke686d76f2007-12-01 00:00:00 +0000576 <p>
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -0700577 Information on GNU make, and access to ftp download sites, are
578 available on the
579 <a href="http://www.gnu.org/software/make/make.html" target="_blank">
580 GNU make web site
581 </a>.
582 The latest source to GNU make is available at
583 <a href="http://ftp.gnu.org/pub/gnu/make/" target="_blank">
584 ftp.gnu.org/pub/gnu/make/</a>.
J. Duke686d76f2007-12-01 00:00:00 +0000585 </blockquote>
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -0700586 <!-- ------------------------------------------------------ -->
587 <hr>
588 <h3><a name="linux">Basic Linux System Setup</a></h3>
589 <blockquote>
J. Duke686d76f2007-12-01 00:00:00 +0000590 <strong>i586 only:</strong>
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -0700591 The minimum recommended hardware for building the Linux version
592 is a Pentium class processor or better, at least 256 MB of RAM, and
593 approximately 1.5 GB of free disk space.
J. Duke686d76f2007-12-01 00:00:00 +0000594 <p>
595 <strong>X64 only:</strong>
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -0700596 The minimum recommended hardware for building the Linux
597 version is an AMD Opteron class processor, at least 512 MB of RAM, and
598 approximately 4 GB of free disk space.
599 <p>
600 The build will use the tools contained in
601 <tt>/bin</tt> and
602 <tt>/usr/bin</tt>
603 of a standard installation of the Linux operating environment.
604 You should ensure that these directories are in your
605 <tt>PATH</tt>.
J. Duke686d76f2007-12-01 00:00:00 +0000606 <p>
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -0700607 Note that some Linux systems have a habit of pre-populating
608 your environment variables for you, for example <tt>JAVA_HOME</tt>
609 might get pre-defined for you to refer to the JDK installed on
610 your Linux system.
611 You will need to unset <tt>JAVA_HOME</tt>.
612 It's a good idea to run <tt>env</tt> and verify the
613 environment variables you are getting from the default system
614 settings make sense for building the
615 OpenJDK.
J. Duke686d76f2007-12-01 00:00:00 +0000616 </blockquote>
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -0700617 <!-- ------------------------------------------------------ -->
618 <h4><a name="linux_checklist">Basic Linux Check List</a></h4>
619 <blockquote>
620 <ol>
621 <li>
622 Install the
623 <a href="#bootjdk">Bootstrap JDK</a>, set
624 <tt><a href="#ALT_BOOTDIR">ALT_BOOTDIR</a></tt>.
625 </li>
626 <li>
627 Install the
628 <a href="#binaryplugs">Binary Plugs</a>, set
629 <tt><a href="#ALT_BINARY_PLUGS_PATH">ALT_BINARY_PLUGS_PATH</a></tt>.
630 </li>
631 <li>
632 <a href="#importjdk">Optional Import JDK</a>, set
633 <tt><a href="#ALT_JDK_IMPORT_PATH">ALT_JDK_IMPORT_PATH</a></tt>.
634 </li>
635 <li>
636 Install or upgrade the <a href="#freetype">FreeType development
637 package</a>.
638 </li>
Kelly O'Hair634c79b2008-07-09 15:42:00 -0700639 <li>
640 Install
Kelly O'Haird03960122008-12-01 15:28:36 -0800641 <a href="#ant">Ant</a>,
642 make sure it is in your PATH.
Kelly O'Hair634c79b2008-07-09 15:42:00 -0700643 </li>
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -0700644 </ol>
645 </blockquote>
646 <!-- ------------------------------------------------------ -->
647 <hr>
648 <h3><a name="solaris">Basic Solaris System Setup</a></h3>
649 <blockquote>
650 The minimum recommended hardware for building the
651 Solaris SPARC version is an UltraSPARC with 512 MB of RAM.
652 For building
653 the Solaris x86 version, a Pentium class processor or better and at
654 least 512 MB of RAM are recommended.
655 Approximately 1.4 GB of free disk
656 space is needed for a 32-bit build.
657 <p>
Kelly O'Haird03960122008-12-01 15:28:36 -0800658 If you are building the 64-bit version, you should
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -0700659 run the command "isainfo -v" to verify that you have a
660 64-bit installation, it should say <tt>sparcv9</tt> or
661 <tt>amd64</tt>.
662 An additional 7 GB of free disk space is needed
663 for a 64-bit build.
664 <p>
665 The build uses the tools contained in <tt>/usr/ccs/bin</tt>
666 and <tt>/usr/bin</tt> of a standard developer or full installation of
667 the Solaris operating environment.
668 <p>
669 Solaris patches specific to the JDK can be downloaded from the
670 <a href="http://sunsolve.sun.com/show.do?target=patches/JavaSE" target="_blank">
671 SunSolve JDK Solaris patches download page</a>.
672 You should ensure that the latest patch cluster for
673 your version of the Solaris operating environment has also
674 been installed.
675 </blockquote>
676 <!-- ------------------------------------------------------ -->
677 <h4><a name="solaris_checklist">Basic Solaris Check List</a></h4>
678 <blockquote>
679 <ol>
680 <li>
681 Install the
682 <a href="#bootjdk">Bootstrap JDK</a>, set
683 <tt><a href="#ALT_BOOTDIR">ALT_BOOTDIR</a></tt>.
684 </li>
685 <li>
686 Install the
687 <a href="#binaryplugs">Binary Plugs</a>, set
688 <tt><a href="#ALT_BINARY_PLUGS_PATH">ALT_BINARY_PLUGS_PATH</a></tt>.
689 </li>
690 <li>
691 <a href="#importjdk">Optional Import JDK</a>, set
692 <tt><a href="#ALT_JDK_IMPORT_PATH">ALT_JDK_IMPORT_PATH</a></tt>.
693 </li>
694 <li>
695 Install the
696 <a href="#studio">Sun Studio Compilers</a>, set
J. Duke686d76f2007-12-01 00:00:00 +0000697 <a href="#ALT_COMPILER_PATH"><tt>ALT_COMPILER_PATH</tt></a>.
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -0700698 </li>
699 <li>
700 Install the
701 <a href="#cups">CUPS Include files</a>, set
702 <tt><a href="#ALT_CUPS_HEADERS_PATH">ALT_CUPS_HEADERS_PATH</a></tt>.
703 </li>
Kelly O'Hair634c79b2008-07-09 15:42:00 -0700704 <li>
Andrew John Hughese4d60712009-06-17 20:53:01 +0100705 Install the <a href="#xrender">XRender Include files</a>.
706 </li>
707 <li>
Kelly O'Hair634c79b2008-07-09 15:42:00 -0700708 Install
Kelly O'Haird03960122008-12-01 15:28:36 -0800709 <a href="#ant">Ant</a>,
710 make sure it is in your PATH.
Kelly O'Hair634c79b2008-07-09 15:42:00 -0700711 </li>
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -0700712 </ol>
713 </blockquote>
714 <!-- ------------------------------------------------------ -->
715 <hr>
716 <h3><a name="windows">Basic Windows System Setup</a></h3>
717 <blockquote>
718 <strong>i586 only:</strong>
Kelly O'Haird03960122008-12-01 15:28:36 -0800719 The minimum recommended hardware for building the 32-bit or X86
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -0700720 Windows version is an Pentium class processor or better, at least
721 512 MB of RAM, and approximately 600 MB of free disk space.
722 <strong>
Kelly O'Haird03960122008-12-01 15:28:36 -0800723 NOTE: The Windows build machines need to use the
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -0700724 file system NTFS.
725 Build machines formatted to FAT32 will not work
726 because FAT32 doesn't support case-sensitivity in file names.
727 </strong>
728 <p>
729 <strong>X64 only:</strong>
730 The minimum recommended hardware for building
731 the Windows X64 version is an AMD Opteron class processor, at least 1
732 GB of RAM, and approximately 10 GB of free disk space.
733 </blockquote>
734 <!-- ------------------------------------------------------ -->
735 <h4><a name="paths">Windows Paths</a></h4>
736 <blockquote>
737 <strong>Windows:</strong>
738 Note that GNU make is a historic utility and is based very
739 heavily on shell scripting, so it does not tolerate the Windows habit
740 of having spaces in pathnames or the use of the <tt>\</tt>characters in pathnames.
741 Luckily on most Windows systems, you can use <tt>/</tt>instead of \, and
742 there is always a 'short' pathname without spaces for any path that
743 contains spaces.
744 Unfortunately, this short pathname can be somewhat dynamic and the
745 formula is difficult to explain.
746 You can use <tt>cygpath</tt> utility to map pathnames with spaces
747 or the <tt>\</tt>character into the <tt>C:/</tt> style of pathname
748 (called 'mixed'), e.g.
749 <tt>cygpath -s -m "<i>path</i>"</tt>.
750 <p>
751 The makefiles will try to translate any pathnames supplied
752 to it into the <tt>C:/</tt> style automatically.
753 <p>
754 Note that use of CYGWIN creates a unique problem with regards to
755 setting <a href="#path"><tt>PATH</tt></a>. Normally on Windows
756 the <tt>PATH</tt> variable contains directories
757 separated with the ";" character (Solaris and Linux uses ":").
758 With CYGWIN, it uses ":", but that means that paths like "C:/path"
759 cannot be placed in the CYGWIN version of <tt>PATH</tt> and
760 instead CYGWIN uses something like <tt>/cygdrive/c/path</tt>
761 which CYGWIN understands, but only CYGWIN understands.
762 So be careful with paths on Windows.
763 </blockquote>
764 <!-- ------------------------------------------------------ -->
765 <h4><a name="windows_checklist">Basic Windows Check List</a></h4>
766 <blockquote>
767 <ol>
768 <li>
769 Install the
770 <a href="#cygwin">CYGWIN product</a>.
771 </li>
772 <li>
773 Install the
774 <a href="#bootjdk">Bootstrap JDK</a>, set
775 <tt><a href="#ALT_BOOTDIR">ALT_BOOTDIR</a></tt>.
776 </li>
777 <li>
778 Install the
779 <a href="#binaryplugs">Binary Plugs</a>, set
780 <tt><a href="#ALT_BINARY_PLUGS_PATH">ALT_BINARY_PLUGS_PATH</a></tt>..
781 </li>
782 <li>
783 <a href="#importjdk">Optional Import JDK</a>, set
784 <tt><a href="#ALT_JDK_IMPORT_PATH">ALT_JDK_IMPORT_PATH</a></tt>.
785 </li>
786 <li>
787 Install the
Kelly O'Haird03960122008-12-01 15:28:36 -0800788 <a href="#msvc">Microsoft Visual Studio Compilers</a> (32-bit).
789 </li>
790 <li>
791 Install the
792 <a href="#mssdk">Microsoft Platform SDK</a>.
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -0700793 </li>
794 <li>
795 Setup all environment variables for compilers
796 (see <a href="#msvc">compilers</a>).
797 </li>
798 <li>
799 Install
800 <a href="#dxsdk">Microsoft DirectX SDK</a>.
801 </li>
Kelly O'Hair634c79b2008-07-09 15:42:00 -0700802 <li>
803 Install
Kelly O'Haird03960122008-12-01 15:28:36 -0800804 <a href="#ant">Ant</a>,
805 make sure it is in your PATH and set
Kelly O'Hair634c79b2008-07-09 15:42:00 -0700806 <tt><a href="#ANT_HOME">ANT_HOME</a></tt>.
807 </li>
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -0700808 </ol>
809 </blockquote>
810 <!-- ------------------------------------------------------ -->
811 <hr>
812 <h3><a name="dependencies">Build Dependencies</a></h3>
813 <blockquote>
814 Depending on the platform, the OpenJDK build process has some basic
815 dependencies on components not part of the OpenJDK sources.
816 Some of these are specific to a platform, some even specific to
817 an architecture.
818 Each dependency will have a set of ALT variables that can be set
819 to tell the makefiles where to locate the component.
820 In most cases setting these ALT variables may not be necessary
821 and the makefiles will find defaults on the system in standard
822 install locations or through component specific variables.
823 <!-- ------------------------------------------------------ -->
824 <h4><a name="bootjdk">Bootstrap JDK</a></h4>
J. Duke686d76f2007-12-01 00:00:00 +0000825 <blockquote>
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -0700826 All OpenJDK builds require access to the previously released
827 JDK 6, this is often called a bootstrap JDK.
828 The JDK 6 binaries can be downloaded from Sun's
829 <a href="http://java.sun.com/javase/1.6.0/download.html" target="_blank">JDK 6 download site</a>.
830 For build performance reasons
831 is very important that this bootstrap JDK be made available on the
832 local disk of the machine doing the build.
833 You should always set
834 <tt><a href="#ALT_BOOTDIR">ALT_BOOTDIR</a></tt>
835 to point to the location of
836 the bootstrap JDK installation, this is the directory pathname
837 that contains a <tt>bin, lib, and include</tt>
838 It's also a good idea to also place its <tt>bin</tt> directory
839 in the <tt>PATH</tt> environment variable, although it's
840 not required.
J. Duke686d76f2007-12-01 00:00:00 +0000841 <p>
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -0700842 <strong>Solaris:</strong>
843 Some pre-installed JDK images may be available to you in the
844 directory <tt>/usr/jdk/instances</tt>.
845 If you don't set
846 <tt><a href="#ALT_BOOTDIR">ALT_BOOTDIR</a></tt>
847 the makefiles will look in that location for a JDK it can use.
J. Duke686d76f2007-12-01 00:00:00 +0000848 </blockquote>
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -0700849 <!-- ------------------------------------------------------ -->
850 <h4><a name="binaryplugs">Binary Plugs</a></h4>
J. Duke686d76f2007-12-01 00:00:00 +0000851 <blockquote>
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -0700852 Not all of the source code that makes up the JDK is available
853 under an open-source license.
854 This is a temporary situation and these binary plugs will be
855 replaced with fully open source replacements as soon as possible.
856 So currently, in order to build a complete OpenJDK image,
857 you must first download and install the appropriate
858 binary plug bundles for the OpenJDK, go to the
859 <a href="http://openjdk.java.net" target="_blank">OpenJDK</a> site and select
Kelly O'Haird03960122008-12-01 15:28:36 -0800860 the
861 "<b>Bundles(7)</b>"
862 link and download the binaryplugs for
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -0700863 your particular platform.
864 The file downloaded is a jar file that must be extracted by running
865 the jar file with:
J. Duke686d76f2007-12-01 00:00:00 +0000866 <blockquote>
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -0700867 <pre>
868 <tt><b>java -jar jdk-7-ea-plug-b<i>nn</i>-<i>os</i>-<i>arch</i>-<i>dd</i>_<i>month</i>_<i>year</i>.jar</b></tt>
869 </pre>
870 </blockquote>
871 A prompt will be issued for acceptance of these binary plug files.
872 During the OpenJDK build process these "binary plugs"
873 for the encumbered components will be copied into your
874 resulting OpenJDK binary build image.
875 These binary plug files are only for the purpose of
876 building an OpenJDK binary.
877 Make sure you set
878 <tt><a href="#ALT_BINARY_PLUGS_PATH">ALT_BINARY_PLUGS_PATH</a></tt>
879 to the root of this installation.
880 </blockquote>
881 <!-- ------------------------------------------------------ -->
882 <h4><a name="importjdk">Optional Import JDK</a></h4>
883 <blockquote>
884 The <tt><a href="#ALT_JDK_IMPORT_PATH">ALT_JDK_IMPORT_PATH</a></tt>
885 setting is only needed if you are not building the entire
886 JDK. For example, if you have built the entire JDK once, and
887 wanted to avoid repeatedly building the Hotspot VM, you could
888 set this to the location of the previous JDK install image
889 and the build will copy the needed files from this import area.
890 </blockquote>
891 <!-- ------------------------------------------------------ -->
Kelly O'Hair634c79b2008-07-09 15:42:00 -0700892 <h4><a name="ant">Ant</a></h4>
893 <blockquote>
894 All OpenJDK builds require access to least Ant 1.6.5.
895 The Ant tool is available from the
Kelly O'Haird90b02d2008-12-05 17:18:04 -0800896 <a href="http://ant.apache.org" target="_blank">
Kelly O'Hair634c79b2008-07-09 15:42:00 -0700897 Ant download site</a>.
Kelly O'Haird03960122008-12-01 15:28:36 -0800898 You should always make sure <tt>ant</tt> is in your PATH, and
899 on Windows you may also need to set
Kelly O'Hair634c79b2008-07-09 15:42:00 -0700900 <tt><a href="#ANT_HOME">ANT_HOME</a></tt>
901 to point to the location of
902 the Ant installation, this is the directory pathname
903 that contains a <tt>bin and lib</tt>.
Kelly O'Hair634c79b2008-07-09 15:42:00 -0700904 </blockquote>
905 <!-- ------------------------------------------------------ -->
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -0700906 <h4><a name="cacerts">Certificate Authority File (cacert)</a></h4>
907 <blockquote>
908 See <a href="http://en.wikipedia.org/wiki/Certificate_Authority" target="_blank">
909 http://en.wikipedia.org/wiki/Certificate_Authority</a>
910 for a better understanding of the Certificate Authority (CA).
911 A certificates file named "cacerts"
912 represents a system-wide keystore with CA certificates.
913 In JDK and JRE
914 binary bundles, the "cacerts" file contains root CA certificates from
915 several public CAs (e.g., VeriSign, Thawte, and Baltimore).
916 The source contain a cacerts file
917 without CA root certificates.
918 Formal JDK builders will need to secure
919 permission from each public CA and include the certificates into their
920 own custom cacerts file.
921 Failure to provide a populated cacerts file
922 will result in verification errors of a certificate chain during runtime.
923 The variable
924 <tt><a href="#ALT_CACERTS_FILE">ALT_CACERTS_FILE</a></tt>
925 can be used to override the default location of the
926 cacerts file that will get placed in your build.
927 By default an empty cacerts file is provided and that should be
928 fine for most JDK developers.
929 </blockquote>
930 <!-- ------------------------------------------------------ -->
931 <h4><a name="compilers">Compilers</a></h4>
932 <blockquote>
933 <strong><a name="gcc">Linux gcc/binutils</a></strong>
934 <blockquote>
Kelly O'Haird03960122008-12-01 15:28:36 -0800935 The GNU gcc compiler version should be 4 or newer.
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -0700936 The compiler used should be the default compiler installed
937 in <tt>/usr/bin</tt>.
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -0700938 </blockquote>
939 <strong><a name="studio">Solaris: Sun Studio</a></strong>
940 <blockquote>
941 At a minimum, the
942 <a href="http://developers.sun.com/sunstudio/index.jsp" target="_blank">
Kelly O'Hair9af3b7b2008-08-06 16:06:43 -0700943 Sun Studio 12 Compilers</a>
944 (containing version 5.9 of the C and C++ compilers) is required,
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -0700945 with patches from the
946 <a href="http://sunsolve.sun.com/pub-cgi/show.pl?target=patches/patch-access" target="_blank">
947 SunSolve web site</a>.
948 <p>
949 Set
950 <a href="#ALT_COMPILER_PATH"><tt>ALT_COMPILER_PATH</tt></a>
951 to point to the location of
952 the compiler binaries, and place this location in the <tt>PATH</tt>.
953 <p>
954 The Sun Studio Express compilers at:
955 <a href="http://developers.sun.com/sunstudio/downloads/express.jsp" target="_blank">
956 Sun Studio Express Download site</a>
957 are also an option, although these compilers have not
958 been extensively used yet.
959 </blockquote>
Kelly O'Haird03960122008-12-01 15:28:36 -0800960 <strong><a name="msvc">Windows i586: Microsoft Visual Studio Compilers</a></strong>
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -0700961 <blockquote>
962 The 32-bit OpenJDK Windows build
Kelly O'Haird03960122008-12-01 15:28:36 -0800963 requires
964 Microsoft Visual Studio C++ 2008 (VS2008) Standard
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -0700965 Edition compiler.
966 The compiler and other tools are expected to reside
Kelly O'Haird03960122008-12-01 15:28:36 -0800967 in the location defined by the variable
968 <tt>VS90COMNTOOLS</tt> which
969 is set by the Microsoft Visual Studio installer.
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -0700970 <p>
971 Once the compiler is installed,
972 it is recommended that you run <tt>VCVARS32.BAT</tt>
973 to set the compiler environment variables
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -0700974 <tt>INCLUDE</tt>,
975 <tt>LIB</tt>, and
976 <tt>PATH</tt>
977 prior to building the
978 OpenJDK.
979 The above environment variables <b>MUST</b> be set.
980 <p>
Kelly O'Hair2928b812008-09-17 13:30:32 -0700981 <b>WARNING:</b> Make sure you check out the
982 <a href="#cygwin">CYGWIN link.exe WARNING</a>.
983 The path <tt>/usr/bin</tt> must be after the path to the
984 Visual Studio product.
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -0700985 </blockquote>
Kelly O'Haird03960122008-12-01 15:28:36 -0800986 <strong><a name="mssdk">Windows: Microsoft Platform SDK</a></strong>
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -0700987 <blockquote>
988 On <b>X64</b>, the Microsoft Platform Software
989 Development Kit (SDK), April 2005 Edition compiler,
990 is required for building the OpenJDK
991 because it contains the C/C++ compiler.
992 You will need to minimally install the Core SDK and
993 the MDAC SDK features of this compiler.
994 <p>
995 Once the Platform SDK is installed,
996 it is recommended that you run <tt>SetEnv.Cmd /X64</tt>
997 to set the compiler environment variables
998 <tt>MSSDK</tt>,
999 <tt>MSTOOLS</tt>,
1000 <tt>INCLUDE</tt>,
1001 <tt>LIB</tt>, and
1002 <tt>PATH</tt>
1003 prior to building the
1004 OpenJDK.
1005 The above environment variables <b>MUST</b> be set.
1006 <p>
Kelly O'Haird03960122008-12-01 15:28:36 -08001007 This Platform SDK compiler is only used on X64 builds
1008 but other parts of the Platform SDK may be used
1009 for the X86 builds.
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -07001010 </blockquote>
1011 </blockquote>
1012 <!-- ------------------------------------------------------ -->
1013 <h4><a name="zip">Zip and Unzip</a></h4>
1014 <blockquote>
1015 Version 2.2 (November 3rd 1997) or newer of the zip utility
1016 and version 5.12 or newer of the unzip utility is needed
1017 to build the JDK.
1018 With Solaris, Linux, and Windows CYGWIN, the zip and unzip
1019 utilities installed on the system should be fine.
1020 Information and the source code for
1021 ZIP.EXE and UNZIP.EXE is available on the
1022 <a href="http://www.info-zip.org"
1023 target="_blank">info-zip web site</a>.
1024 </blockquote>
1025 <!-- ------------------------------------------------------ -->
1026 <h4><a name="cups">Common UNIX Printing System (CUPS) Headers (Solaris &amp; Linux)</a></h4>
1027 <blockquote>
1028 <strong>Solaris:</strong>
1029 CUPS header files are required for building the
1030 OpenJDK on Solaris.
1031 The Solaris header files can be obtained by installing
1032 the package <strong>SFWcups</strong> from the Solaris Software
1033 Companion CD/DVD, these often will be installed into
1034 <tt>/opt/sfw/cups</tt>.
1035 <p>
1036 <strong>Linux:</strong>
1037 CUPS header files are required for building the
1038 OpenJDK on Linux.
1039 The Linux header files are usually available from a "cups"
1040 development package, it's recommended that you try and use
1041 the package provided by the particular version of Linux that
1042 you are using.
1043 <p>
1044 The CUPS header files can always be downloaded from
1045 <a href="http://www.cups.org" target="_blank">www.cups.org</a>.
1046 The variable
1047 <tt><a href="#ALT_CUPS_HEADERS_PATH">ALT_CUPS_HEADERS_PATH</a></tt>
1048 can be used to override the default location of the
1049 CUPS Header files.
1050 </blockquote>
1051 <!-- ------------------------------------------------------ -->
Andrew John Hughese4d60712009-06-17 20:53:01 +01001052 <h4><a name="xrender">XRender Extension Headers (Solaris &amp; Linux)</a></h4>
1053 <blockquote>
1054 <p>
1055 <strong>Solaris:</strong>
1056 XRender header files are required for building the
1057 OpenJDK on Solaris.
1058 The XRender header file is included with the other X11 header files
1059 in the package <strong>SFWxwinc</strong> on new enough versions of
1060 Solaris and will be installed in
1061 <tt>/usr/X11/include/X11/extensions/Xrender.h</tt>
1062 </p><p>
1063 <strong>Linux:</strong>
1064 XRender header files are required for building the
1065 OpenJDK on Linux.
1066 The Linux header files are usually available from a "Xrender"
1067 development package, it's recommended that you try and use
1068 the package provided by the particular distribution of Linux that
1069 you are using.
1070 </p>
1071 </blockquote>
1072 <!-- ------------------------------------------------------ -->
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -07001073 <h4><a name="freetype">FreeType 2</a></h4>
1074 <blockquote>
1075 Version 2.3 or newer of FreeType is required for building the OpenJDK.
1076 On Unix systems required files can be available as part of your
1077 distribution (while you still may need to upgrade them).
1078 Note that you need development version of package that
1079 includes both FreeType library and header files.
1080 <p>
1081 You can always download latest FreeType version from the
1082 <a href="http://www.freetype.org" target="_blank">FreeType website</a>.
1083 <p>
1084 Makefiles will try to pick FreeType from /usr/lib and /usr/include.
1085 In case it is installed elsewhere you will need to set environment
1086 variables
1087 <tt><a href="#ALT_FREETYPE_LIB_PATH">ALT_FREETYPE_LIB_PATH</a></tt>
1088 and
1089 <tt><a href="#ALT_FREETYPE_HEADERS_PATH">ALT_FREETYPE_HEADERS_PATH</a></tt>
1090 to refer to place where library and header files are installed.
Kelly O'Hair634c79b2008-07-09 15:42:00 -07001091 <p>
1092 Building the freetype 2 libraries from scratch is also possible,
1093 however on Windows refer to the
1094 <a href="http://freetype.freedesktop.org/wiki/FreeType_DLL">
1095 Windows FreeType DLL build instructions</a>.
1096 <p>
1097 Note that by default FreeType is built with byte code hinting
1098 support disabled due to licensing restrictions.
1099 In this case, text appearance and metrics are expected to
1100 differ from Sun's official JDK build.
1101 See
1102 <a href="http://freetype.sourceforge.net/freetype2/index.html">
1103 the SourceForge FreeType2 Home Page
1104 </a>
1105 for more information.
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -07001106 </blockquote>
1107 <!-- ------------------------------------------------------ -->
1108 <h4><a name="alsa">Advanced Linux Sound Architecture (ALSA) (Linux only)</a></h4>
1109 <blockquote>
1110 <strong>Linux only:</strong>
1111 Version 0.9.1 or newer of the ALSA files are
1112 required for building the OpenJDK on Linux.
1113 These Linux files are usually available from an "alsa"
1114 of "libasound"
1115 development package, it's highly recommended that you try and use
1116 the package provided by the particular version of Linux that
1117 you are using.
1118 The makefiles will check this emit a sanity error if it is
1119 missing or the wrong version.
1120 <p>
1121 In particular, older Linux systems will likely not have the
1122 right version of ALSA installed, for example
1123 Redhat AS 2.1 U2 and SuSE 8.1 do not include a sufficiently
1124 recent ALSA distribution.
1125 On rpm-based systems, you can see if ALSA is installed by
1126 running this command:
1127 <pre>
1128 <tt>rpm -qa | grep alsa</tt>
1129 </pre>
1130 Both <tt>alsa</tt> and <tt>alsa-devel</tt> packages are needed.
1131 <p>
1132 If your distribution does not come with ALSA, and you can't
1133 find ALSA packages built for your particular system,
1134 you can try to install the pre-built ALSA rpm packages from
1135 <a href="http://www.freshrpms.net/" target="_blank">
1136 <tt>www.freshrpms.net</tt></a>.
1137 Note that installing a newer ALSA could
1138 break sound output if an older version of ALSA was previously
1139 installed on the system, but it will enable JDK compilation.
1140 <blockquote>
1141 Installation: execute as root<br>
1142 [i586]: <code>rpm -Uv --force alsa-lib-devel-0.9.1-rh61.i386.rpm</code><br>
1143 [x64]: <code>rpm -Uv --force alsa-lib-devel-0.9.8-amd64.x86_64.rpm</code><br>
1144 Uninstallation:<br>
1145 [i586]: <code>rpm -ev alsa-lib-devel-0.9.1-rh61</code><br>
1146 [x64]:<code>rpm -ev alsa-lib-devel-0.9.8-amd64</code><br>
1147 Make sure that you do not link to the static library
1148 (<tt>libasound.a</tt>),
1149 by verifying that the dynamic library (<tt>libasound.so</tt>) is
1150 correctly installed in <tt>/usr/lib</tt>.
1151 </blockquote>
1152 As a last resort you can go to the
1153 <a href="http://www.alsa-project.org" target="_blank">
1154 Advanced Linux Sound Architecture Site</a> and build it from
1155 source.
1156 <blockquote>
1157 Download driver and library
1158 source tarballs from
1159 <a href="http://www.alsa-project.org" target="_blank">ALSA's homepage</a>.
1160 As root, execute the following
1161 commands (you may need to adapt the version number):
1162 <pre>
1163 <tt>
1164 $ tar xjf alsa-driver-0.9.1.tar.bz2
1165 $ cd alsa-driver-0.9.1
1166 $ ./configure
1167 $ make install
1168 $ cd ..
1169 $ tar xjf alsa-lib-0.9.1.tar.bz2
1170 $ cd alsa-lib-0.9.1
1171 $ ./configure
1172 $ make install
1173 </tt>
1174 </pre>
1175 Should one of the above steps fail, refer to the documentation on
1176 ALSA's home page.
1177 </blockquote>
1178 Note that this is a minimum install that enables
1179 building the JDK platform. To actually use ALSA sound drivers, more
1180 steps are necessary as outlined in the documentation on ALSA's homepage.
1181 <p>
1182 ALSA can be uninstalled by executing <tt>make uninstall</tt> first in
1183 the <tt>alsa-lib-0.9.1</tt> directory and then in
1184 <tt>alsa-driver-0.9.1</tt>.
1185 </blockquote>
1186 There are no ALT* variables to change the assumed locations of ALSA,
1187 the makefiles will expect to find the ALSA include files and library at:
1188 <tt>/usr/include/alsa</tt> and <tt>/usr/lib/libasound.so</tt>.
1189 </blockquote>
1190 <!-- ------------------------------------------------------ -->
1191 <h4>Windows Specific Dependencies</h4>
1192 <blockquote>
1193 <strong>Unix Command Tools (<a name="cygwin">CYGWIN</a>)</strong>
1194 <blockquote>
1195 The OpenJDK requires access to a set of unix command tools
1196 on Windows which can be supplied by
1197 <a href="http://www.cygwin.com" target="_blank">CYGWIN</a>.
1198 <p>
1199 The OpenJDK build requires CYGWIN version 1.5.12 or newer.
1200 Information about CYGWIN can
1201 be obtained from the CYGWIN website at
1202 <a href="http://www.cygwin.com" target="_blank">www.cygwin.com</a>.
1203 <p>
1204 By default CYGWIN doesn't install all the tools required for building
1205 the OpenJDK.
1206 Along with the default installation, you need to install
1207 the following tools.
1208 <blockquote>
1209 <table border="1">
1210 <thead>
1211 <tr>
1212 <td>Binary Name</td>
Kelly O'Hair2928b812008-09-17 13:30:32 -07001213 <td>Category</td>
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -07001214 <td>Package</td>
1215 <td>Description</td>
1216 </tr>
1217 </thead>
1218 <tbody>
1219 <tr>
1220 <td>ar.exe</td>
1221 <td>Devel</td>
Kelly O'Hair2928b812008-09-17 13:30:32 -07001222 <td>binutils</td>
1223 <td>The GNU assembler, linker and binary
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -07001224 utilities</td>
1225 </tr>
1226 <tr>
1227 <td>make.exe</td>
1228 <td>Devel</td>
Kelly O'Hair2928b812008-09-17 13:30:32 -07001229 <td>make</td>
1230 <td>The GNU version of the 'make' utility built for CYGWIN.<br>
Kelly O'Hair634c79b2008-07-09 15:42:00 -07001231 <b>NOTE</b>: See <a href="#gmake">the GNU make section</a></td>
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -07001232 </tr>
1233 <tr>
1234 <td>m4.exe</td>
1235 <td>Interpreters</td>
Kelly O'Hair2928b812008-09-17 13:30:32 -07001236 <td>m4</td>
1237 <td>GNU implementation of the traditional Unix macro
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -07001238 processor</td>
1239 </tr>
1240 <tr>
1241 <td>cpio.exe</td>
1242 <td>Utils</td>
Kelly O'Hair2928b812008-09-17 13:30:32 -07001243 <td>cpio</td>
1244 <td>A program to manage archives of files</td>
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -07001245 </tr>
1246 <tr>
Kelly O'Hair634c79b2008-07-09 15:42:00 -07001247 <td>gawk.exe</td>
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -07001248 <td>Utils</td>
Kelly O'Hair2928b812008-09-17 13:30:32 -07001249 <td>awk</td>
1250 <td>Pattern-directed scanning and processing language</td>
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -07001251 </tr>
1252 <tr>
1253 <td>file.exe</td>
1254 <td>Utils</td>
Kelly O'Hair2928b812008-09-17 13:30:32 -07001255 <td>file</td>
1256 <td>Determines file type using 'magic' numbers</td>
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -07001257 </tr>
1258 <tr>
1259 <td>zip.exe</td>
Kelly O'Hair634c79b2008-07-09 15:42:00 -07001260 <td>Archive</td>
Kelly O'Hair2928b812008-09-17 13:30:32 -07001261 <td>zip</td>
1262 <td>Package and compress (archive) files</td>
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -07001263 </tr>
1264 <tr>
1265 <td>unzip.exe</td>
Kelly O'Hair634c79b2008-07-09 15:42:00 -07001266 <td>Archive</td>
Kelly O'Hair2928b812008-09-17 13:30:32 -07001267 <td>unzip</td>
1268 <td>Extract compressed files in a ZIP archive</td>
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -07001269 </tr>
1270 <tr>
1271 <td>free.exe</td>
Kelly O'Hair2928b812008-09-17 13:30:32 -07001272 <td>System</td>
1273 <td>procps</td>
1274 <td>Display amount of free and used memory in the system</td>
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -07001275 </tr>
1276 </tbody>
1277 </table>
J. Duke686d76f2007-12-01 00:00:00 +00001278 </blockquote>
1279 <p>
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -07001280 Note that the CYGWIN software can conflict with other non-CYGWIN
1281 software on your Windows system.
1282 CYGWIN provides a
1283 <a href="http://cygwin.com/faq/faq.using.html" target="_blank">FAQ</a> for
1284 known issues and problems, of particular interest is the
1285 section on
1286 <a href="http://cygwin.com/faq/faq.using.html#faq.using.bloda" target="_blank">
1287 BLODA (applications that interfere with CYGWIN)</a>.
Kelly O'Hair2928b812008-09-17 13:30:32 -07001288 <p>
1289 <b>WARNING:</b>
1290 Be very careful with <b><tt>link.exe</tt></b>, it will conflict
1291 with the Visual Studio version. You need the Visual Studio
1292 version of <tt>link.exe</tt>, not the CYGWIN one.
1293 So it's important that the Visual Studio paths in PATH preceed
1294 the CYGWIN path <tt>/usr/bin</tt>.
J. Duke686d76f2007-12-01 00:00:00 +00001295 </blockquote>
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -07001296 <strong><a name="dxsdk">Microsoft DirectX 9.0 SDK header files and libraries</a></strong>
J. Duke686d76f2007-12-01 00:00:00 +00001297 <blockquote>
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -07001298 Microsoft DirectX 9.0 SDK (Summer 2004)
1299 headers are required for building
1300 OpenJDK.
1301 This SDK can be downloaded from
1302 <a href="http://www.microsoft.com/downloads/details.aspx?FamilyId=FD044A42-9912-42A3-9A9E-D857199F888E&amp;displaylang=en" target="_blank">
1303 Microsoft DirectX 9.0 SDK (Summer 2004)</a>.
1304 If the link above becomes obsolete, the SDK can be found from
1305 <a href="http://download.microsoft.com" target="_blank">the Microsoft Download Site</a>
1306 (search with "DirectX 9.0 SDK Update Summer 2004").
1307 The location of this SDK can be set with
1308 <tt><a href="#ALT_DXSDK_PATH">ALT_DXSDK_PATH</a></tt>
1309 but it's normally found via the DirectX environment variable
1310 <tt>DXSDK_DIR</tt>.
J. Duke686d76f2007-12-01 00:00:00 +00001311 </blockquote>
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -07001312 <strong><a name="msvcrt"><tt>MSVCRT.DLL</tt></a></strong>
1313 <blockquote>
1314 <strong>i586 only:</strong>
Kelly O'Haird03960122008-12-01 15:28:36 -08001315 The OpenJDK 32-bit build requires access to a redistributable
1316 <tt>MSVCRT.DLL</tt>.
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -07001317 If the <tt>MSVCRT.DLL</tt> is not installed in
1318 the system32 directory set the
1319 <a href="#ALT_MSVCRT_DLL_PATH"><tt>ALT_MSVCRT_DLL_PATH</tt></a>
Kelly O'Haird03960122008-12-01 15:28:36 -08001320 variable to the location of this file.
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -07001321 <p>
1322 <strong>X64 only:</strong>
Kelly O'Haird03960122008-12-01 15:28:36 -08001323 The OpenJDK 64-bit build requires access to a redistributable
1324 <tt>MSVCRT.DLL</tt>, which is
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -07001325 usually supplied by the
1326 <a href="#mssdk">Platform SDK</a>.
1327 If it is not available from the Platform SDK,
1328 set the
1329 <a href="#ALT_MSVCRT_DLL_PATH"><tt>ALT_MSVCRT_DLL_PATH</tt></a>
Kelly O'Haird03960122008-12-01 15:28:36 -08001330 variable to the location of this file.
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -07001331 </blockquote>
Kelly O'Haird03960122008-12-01 15:28:36 -08001332 <strong><tt><a name="msvcr90">MSVCR90.DLL</a></tt></strong>
J. Duke686d76f2007-12-01 00:00:00 +00001333 <blockquote>
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -07001334 <strong>i586 only:</strong>
1335 The
1336 OpenJDK
Kelly O'Haird03960122008-12-01 15:28:36 -08001337 build requires access to a redistributable
1338 <tt>MSVCR90.DLL</tt> which should be
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -07001339 supplied by the
Kelly O'Haird03960122008-12-01 15:28:36 -08001340 <a href="#msvc">Visual Studio product</a>.
1341 If the <tt>MSVCR90.DLL</tt> is not available from the
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -07001342 Visual Studio product
1343 set the
Kelly O'Haird03960122008-12-01 15:28:36 -08001344 <a href="#ALT_MSVCR90_DLL_PATH"><tt>ALT_MSVCR90_DLL_PATH</tt></a>
1345 variable to the location of this file.
J. Duke686d76f2007-12-01 00:00:00 +00001346 </blockquote>
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -07001347 </blockquote>
1348 <!-- ------------------------------------------------------ -->
1349 <hr>
1350 <h2><a name="creating">Creating the Build</a></h2>
1351 <blockquote>
1352 Once a machine is setup to build the OpenJDK,
1353 the steps to create the build are fairly simple.
1354 The various ALT settings can either be made into variables
1355 or can be supplied on the
1356 <a href="#gmake"><tt><i>gmake</i></tt></a>
1357 command.
1358 <ol>
1359 <li>Use the sanity rule to double check all the ALT settings:
1360 <blockquote>
1361 <tt>
1362 <i>gmake</i>
1363 sanity
1364 [ARCH_DATA_MODEL=<i>32 or 64</i>]
1365 [other "ALT_" overrides]
1366 </tt>
1367 </blockquote>
1368 </li>
1369 <li>Start the build with the command:
1370 <blockquote>
1371 <tt>
1372 <i>gmake</i>
1373 [ARCH_DATA_MODEL=<i>32 or 64</i>]
1374 [ALT_OUTPUTDIR=<i>output_directory</i>]
1375 [other "ALT_" overrides]
1376 </tt>
1377 </blockquote>
1378 </li>
1379 </ol>
1380 <p>
1381 <strong>Solaris:</strong>
1382 Note that ARCH_DATA_MODEL is really only needed on Solaris to
1383 indicate you want to built the 64-bit version.
1384 And before the Solaris 64-bit binaries can be used, they
1385 must be merged with the binaries from a separate 32-bit build.
1386 The merged binaries may then be used in either 32-bit or 64-bit mode, with
1387 the selection occurring at runtime
1388 with the <tt>-d32</tt> or <tt>-d64</tt> options.
1389 </blockquote>
1390 <!-- ------------------------------------------------------ -->
1391 <hr>
1392 <h2><a name="testing">Testing the Build</a></h2>
1393 <blockquote>
1394 When the build is completed, you should see the generated
1395 binaries and associated files in the <tt>j2sdk-image</tt>
1396 directory in the output directory.
1397 The default output directory is
1398 <tt>build/<i>platform</i></tt>,
1399 where <tt><i>platform</i></tt> is one of
1400 <tt><ul>
1401 <li>solaris-sparc</li>
1402 <li>solaris-sparcv9</li>
1403 <li>solaris-i586</li>
1404 <li>solaris-amd64</li>
1405 <li>linux-i586</li>
1406 <li>linux-amd64</li>
1407 <li>windows-i586</li>
1408 <li>windows-amd64</li>
1409 </ul></tt>
1410 In particular, the
1411 <tt>build/<i>platform</i>/j2sdk-image/bin</tt>
1412 directory should contain executables for the
1413 OpenJDK tools and utilities.
1414 <p>
1415 You can test that the build completed properly by using the build
1416 to run the various demos that you will find in the
1417 <tt>build/<i>platform</i>/j2sdk-image/demo</tt>
1418 directory.
1419 <p>
1420 The provided regression tests can be run with the <tt>jtreg</tt>
1421 utility from
1422 <a href="http://openjdk.java.net/jtreg/" target="_blank">the jtreg site</a>.
1423 </blockquote>
1424 <!-- ------------------------------------------------------ -->
1425 <hr>
1426 <h2><a name="variables">Environment/Make Variables</a></h2>
1427 <p>
1428 Some of the
1429 environment or make variables (just called <b>variables</b> in this
1430 document) that can impact the build are:
1431 <blockquote>
1432 <dl>
Kelly O'Haird03960122008-12-01 15:28:36 -08001433 <dt><a name="path"><tt>PATH</tt></a> </dt>
1434 <dd>Typically you want to set the <tt>PATH</tt> to include:
1435 <ul>
1436 <li>The location of the GNU make binary</li>
1437 <li>The location of the Bootstrap JDK <tt>java</tt>
1438 (see <a href="#bootjdk">Bootstrap JDK</a>)</li>
1439 <li>The location of the C/C++ compilers
1440 (see <a href="#compilers"><tt>compilers</tt></a>)</li>
1441 <li>The location or locations for the Unix command utilities
1442 (e.g. <tt>/usr/bin</tt>)</li>
1443 </ul>
1444 </dd>
1445 <dt><tt>MILESTONE</tt> </dt>
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -07001446 <dd>
Kelly O'Haird03960122008-12-01 15:28:36 -08001447 The milestone name for the build (<i>e.g.</i>"beta").
1448 The default value is "internal".
1449 </dd>
1450 <dt><tt>BUILD_NUMBER</tt> </dt>
1451 <dd>
1452 The build number for the build (<i>e.g.</i> "b27").
1453 The default value is "b00".
1454 </dd>
1455 <dt><a name="arch_data_model"><tt>ARCH_DATA_MODEL</tt></a></dt>
1456 <dd>The <tt>ARCH_DATA_MODEL</tt> variable
1457 is used to specify whether the build is to generate 32-bit or 64-bit
1458 binaries.
1459 The Solaris build supports either 32-bit or 64-bit builds, but
1460 Windows and Linux will support only one, depending on the specific
1461 OS being used.
1462 Normally, setting this variable is only necessary on Solaris.
1463 Set <tt>ARCH_DATA_MODEL</tt> to <tt>32</tt> for generating 32-bit binaries,
1464 or to <tt>64</tt> for generating 64-bit binaries.
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -07001465 </dd>
Kelly O'Hair634c79b2008-07-09 15:42:00 -07001466 <dt><a name="ALT_BOOTDIR"><tt>ALT_BOOTDIR</tt></a></dt>
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -07001467 <dd>
Kelly O'Hair634c79b2008-07-09 15:42:00 -07001468 The location of the bootstrap JDK installation.
1469 See <a href="#bootjdk">Bootstrap JDK</a> for more information.
1470 You should always install your own local Bootstrap JDK and
1471 always set <tt>ALT_BOOTDIR</tt> explicitly.
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -07001472 </dd>
Kelly O'Haird03960122008-12-01 15:28:36 -08001473 <dt><a name="ALT_BINARY_PLUGS_PATH"><tt>ALT_BINARY_PLUGS_PATH</tt></a></dt>
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -07001474 <dd>
Kelly O'Haird03960122008-12-01 15:28:36 -08001475 The location of the binary plugs installation.
1476 See <a href="#binaryplugs">Binary Plugs</a> for more information.
1477 You should always have a local copy of a
1478 recent Binary Plugs install image
1479 and set this variable to that location.
1480 </dd>
1481 <dt><a name="ALT_JDK_IMPORT_PATH"><tt>ALT_JDK_IMPORT_PATH</tt></a></dt>
1482 <dd>
1483 The location of a previously built JDK installation.
1484 See <a href="#importjdk">Optional Import JDK</a> for more information.
1485 </dd>
1486 <dt><a name="ALT_OUTPUTDIR"><tt>ALT_OUTPUTDIR</tt></a> </dt>
1487 <dd>
1488 An override for specifying the (absolute) path of where the
1489 build output is to go.
1490 The default output directory will be build/<i>platform</i>.
1491 </dd>
1492 <dt><a name="ALT_COMPILER_PATH"><tt>ALT_COMPILER_PATH</tt></a> </dt>
1493 <dd>
1494 The location of the C/C++ compiler.
1495 The default varies depending on the platform.
1496 </dd>
1497 <dt><tt><a name="ALT_CACERTS_FILE">ALT_CACERTS_FILE</a></tt></dt>
1498 <dd>
1499 The location of the <a href="#cacerts">cacerts</a> file.
1500 The default will refer to
1501 <tt>jdk/src/share/lib/security/cacerts</tt>.
1502 </dd>
1503 <dt><a name="ALT_CUPS_HEADERS_PATH"><tt>ALT_CUPS_HEADERS_PATH</tt></a> </dt>
1504 <dd>
1505 The location of the CUPS header files.
1506 See <a href="#cups">CUPS information</a> for more information.
1507 If this path does not exist the fallback path is
1508 <tt>/usr/include</tt>.
1509 </dd>
1510 <dt><a name="ALT_FREETYPE_LIB_PATH"><tt>ALT_FREETYPE_LIB_PATH</tt></a></dt>
1511 <dd>
1512 The location of the FreeType shared library.
1513 See <a href="#freetype">FreeType information</a> for details.
1514 </dd>
1515 <dt><a name="ALT_FREETYPE_HEADERS_PATH"><tt>ALT_FREETYPE_HEADERS_PATH</tt></a></dt>
1516 <dd>
1517 The location of the FreeType header files.
1518 See <a href="#freetype">FreeType information</a> for details.
1519 </dd>
1520 <dt><a name="ALT_JDK_DEVTOOLS_PATH"><tt>ALT_JDK_DEVTOOLS_PATH</tt></a></dt>
1521 <dd>
1522 The default root location of the devtools.
1523 The default value is
1524 <tt>$(ALT_SLASH_JAVA)/devtools</tt>.
1525 </dd>
1526 <dt><tt><a name="ALT_DEVTOOLS_PATH">ALT_DEVTOOLS_PATH</a></tt> </dt>
1527 <dd>
1528 The location of tools like the
1529 <a href="#zip"><tt>zip</tt> and <tt>unzip</tt></a>
1530 binaries, but might also contain the GNU make utility
1531 (<tt><i>gmake</i></tt>).
1532 So this area is a bit of a grab bag, especially on Windows.
1533 The default value depends on the platform and
1534 Unix Commands being used.
1535 On Linux the default will be
1536 <tt>$(ALT_JDK_DEVTOOLS_PATH)/linux/bin</tt>,
1537 on Solaris
1538 <tt>$(ALT_JDK_DEVTOOLS_PATH)/<i>{sparc,i386}</i>/bin</tt>,
1539 and on Windows with CYGWIN
1540 <tt>/usr/bin</tt>.
1541 </dd>
1542 <dt><a name="ALT_UNIXCCS_PATH"><tt>ALT_UNIXCCS_PATH</tt></a></dt>
1543 <dd>
1544 <strong>Solaris only:</strong>
1545 An override for specifying where the Unix CCS
1546 command set are located.
1547 The default location is <tt>/usr/ccs/bin</tt>
1548 </dd>
1549 <dt><a name="ALT_SLASH_JAVA"><tt>ALT_SLASH_JAVA</tt></a></dt>
1550 <dd>
1551 The default root location for many of the ALT path locations
1552 of the following ALT variables.
1553 The default value is
1554 <tt>"/java"</tt> on Solaris and Linux,
1555 <tt>"J:"</tt> on Windows.
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -07001556 </dd>
Kelly O'Hair634c79b2008-07-09 15:42:00 -07001557 <dt><a name="ALT_BUILD_JDK_IMPORT_PATH"><tt>ALT_BUILD_JDK_IMPORT_PATH</tt></a></dt>
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -07001558 <dd>
Kelly O'Hair634c79b2008-07-09 15:42:00 -07001559 These are useful in managing builds on multiple platforms.
1560 The default network location for all of the import JDK images
1561 for all platforms.
1562 If <tt><a href="#ALT_JDK_IMPORT_PATH">ALT_JDK_IMPORT_PATH</a></tt>
1563 is not set, this directory will be used and should contain
1564 the following directories:
1565 <tt>solaris-sparc</tt>,
1566 <tt>solaris-i586</tt>,
1567 <tt>solaris-sparcv9</tt>,
1568 <tt>solaris-amd64</tt>,
1569 <tt>linux-i586</tt>,
1570 <tt>linux-amd64</tt>,
1571 <tt>windows-i586</tt>,
1572 and
1573 <tt>windows-amd64</tt>.
1574 Where each of these directories contain the import JDK image
1575 for that platform.
1576 </dd>
Kelly O'Haird03960122008-12-01 15:28:36 -08001577 <dt><a name="ALT_BUILD_BINARY_PLUGS_PATH"><tt>ALT_BUILD_BINARY_PLUGS_PATH</tt></a></dt>
Kelly O'Hair634c79b2008-07-09 15:42:00 -07001578 <dd>
Kelly O'Haird03960122008-12-01 15:28:36 -08001579 These are useful in managing builds on multiple platforms.
1580 The default network location for all of the binary plug images
1581 for all platforms.
1582 If <tt><a href="#ALT_BINARY_PLUGS_PATH">ALT_BINARY_PLUGS_PATH</a></tt>
1583 is not set, this directory will be used and should contain
1584 the following directories:
1585 <tt>solaris-sparc</tt>,
1586 <tt>solaris-i586</tt>,
1587 <tt>solaris-sparcv9</tt>,
1588 <tt>solaris-amd64</tt>,
1589 <tt>linux-i586</tt>,
1590 <tt>linux-amd64</tt>,
1591 <tt>windows-i586</tt>,
1592 and
1593 <tt>windows-amd64</tt>.
1594 Where each of these directories contain the binary plugs image
1595 for that platform.
Kelly O'Hair634c79b2008-07-09 15:42:00 -07001596 </dd>
Kelly O'Haird03960122008-12-01 15:28:36 -08001597 <dt><strong>Windows specific:</strong></dt>
Kelly O'Hair634c79b2008-07-09 15:42:00 -07001598 <dd>
Kelly O'Haird03960122008-12-01 15:28:36 -08001599 <dl>
1600 <dt><a name="ALT_MSDEVTOOLS_PATH"><tt>ALT_MSDEVTOOLS_PATH</tt></a> </dt>
1601 <dd>
1602 The location of the
1603 Microsoft Visual Studio
1604 tools 'bin' directory.
1605 The default is usually derived from
1606 <a href="#ALT_COMPILER_PATH"><tt>ALT_COMPILER_PATH</tt></a>.
1607 </dd>
1608 <dt><tt><a name="ALT_DXSDK_PATH">ALT_DXSDK_PATH</a></tt> </dt>
1609 <dd>
1610 The location of the
1611 <a href="#dxsdk">Microsoft DirectX 9 SDK</a>.
1612 The default will be to try and use the DirectX environment
1613 variable <tt>DXSDK_DIR</tt>,
1614 failing that, look in <tt>C:/DXSDK</tt>.
1615 </dd>
1616 <dt><tt><a name="ALT_MSVCRT_DLL_PATH">ALT_MSVCRT_DLL_PATH</a></tt> </dt>
1617 <dd>
1618 The location of the
1619 <a href="#msvcrt"><tt>MSVCRT.DLL</tt></a>.
1620 </dd>
1621 <dt><tt><a name="ALT_MSVCR90_DLL_PATH">ALT_MSVCR90_DLL_PATH</a></tt> </dt>
1622 <dd>
1623 <strong>i586 only:</strong>
1624 The location of the
1625 <a href="#msvcr90"><tt>MSVCR90.DLL</tt></a>.
1626 </dd>
1627 </dl>
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -07001628 </dd>
1629 </dl>
1630 </blockquote>
1631 <!-- ------------------------------------------------------ -->
1632 <hr>
1633 <h2><a name="troubleshooting">Troubleshooting</a></h2>
1634 <blockquote>
1635 A build can fail for any number of reasons.
1636 Most failures
1637 are a result of trying to build in an environment in which all the
1638 pre-build requirements have not been met.
1639 The first step in
1640 troubleshooting a build failure is to recheck that you have satisfied
1641 all the pre-build requirements for your platform.
1642 Look for the check list of the platform you are building on in the
1643 <a href="#contents">Table of Contents</a>.
1644 <p>
1645 You can validate your build environment by using the <tt>sanity</tt>
1646 target.
1647 Any errors listed
1648 will stop the build from starting, and any warnings may result in
1649 a flawed product build.
1650 We strongly encourage you to evaluate every
1651 sanity check warning and fix it if required, before you proceed
1652 further with your build.
1653 <p>
1654 Some of the more common problems with builds are briefly described
1655 below, with suggestions for remedies.
1656 <ul>
1657 <li>
1658 <b>Slow Builds:</b>
1659 <blockquote>
1660 If your build machine seems to be overloaded from too many
1661 simultaneous C++ compiles, try setting the <tt>HOTSPOT_BUILD_JOBS</tt>
1662 variable to <tt>1</tt> (if you're using a multiple CPU
1663 machine, setting it to more than the the number of CPUs is probably
1664 not a good idea).
1665 <p>
1666 Creating the javadocs can be very slow, if you are running
1667 javadoc, consider skipping that step.
1668 <p>
1669 Faster hardware and more RAM always helps too.
1670 The VM build tends to be CPU intensive (many C++ compiles),
1671 and the rest of the JDK will often be disk intensive.
1672 <p>
1673 Faster compiles are possible using a tool called
1674 <a href="http://ccache.samba.org/" target="_blank">ccache</a>.
1675 </blockquote>
1676 </li>
1677 <li>
1678 <b>File time issues:</b>
1679 <blockquote>
1680 If you see warnings that refer to file time stamps, e.g.
1681 <blockquote>
1682 <i>Warning message:</i><tt> File `xxx' has modification time in
1683 the future.</tt>
1684 <br>
1685 <i>Warning message:</i> <tt> Clock skew detected. Your build may
1686 be incomplete.</tt>
1687 </blockquote>
1688 These warnings can occur when the clock on the build machine is out of
1689 sync with the timestamps on the source files. Other errors, apparently
1690 unrelated but in fact caused by the clock skew, can occur along with
1691 the clock skew warnings. These secondary errors may tend to obscure the
1692 fact that the true root cause of the problem is an out-of-sync clock.
1693 For example, an out-of-sync clock has been known to cause an old
1694 version of javac to be used to compile some files, resulting in errors
1695 when the pre-1.4 compiler ran across the new <tt>assert</tt> keyword
1696 in the 1.4 source code.
1697 <p>
1698 If you see these warnings, reset the clock on the build
1699 machine, run "<tt><i>gmake</i> clobber</tt>" or delete the directory
1700 containing the build output, and restart the build from the beginning.
1701 </blockquote>
1702 </li>
1703 <li>
1704 <b>Error message: <tt>Trouble writing out table to disk</tt></b>
1705 <blockquote>
1706 Increase the amount of swap space on your build machine.
1707 </blockquote>
1708 </li>
1709 <li>
1710 <b>Error Message: <tt>libstdc++ not found:</tt></b>
1711 <blockquote>
1712 This is caused by a missing libstdc++.a library.
1713 This is installed as part of a specific package
1714 (e.g. libstdc++.so.devel.386).
Kelly O'Haird03960122008-12-01 15:28:36 -08001715 By default some 64-bit Linux versions (e.g. Fedora)
1716 only install the 64-bit version of the libstdc++ package.
Kelly O'Hairbf8a41a2008-04-30 19:35:26 -07001717 Various parts of the JDK build require a static
1718 link of the C++ runtime libraries to allow for maximum
1719 portability of the built images.
1720 </blockquote>
1721 </li>
1722 <li>
1723 <b>Error Message: <tt>cannot restore segment prot after reloc</tt></b>
1724 <blockquote>
1725 This is probably an issue with SELinux (See
1726 <a href="http://en.wikipedia.org/wiki/SELinux" target="_blank">
1727 http://en.wikipedia.org/wiki/SELinux</a>).
1728 Parts of the VM is built without the <tt>-fPIC</tt> for
1729 performance reasons.
1730 <p>
1731 To completely disable SELinux:
1732 <tt>
1733 <ol>
1734 <li>$ su root</li>
1735 <li># system-config-securitylevel</li>
1736 <li>In the window that appears, select the SELinux tab</li>
1737 <li>Disable SELinux</li>
1738 </ol>
1739 </tt>
1740 <p>
1741 Alternatively, instead of completely disabling it you could
1742 disable just this one check.
1743 <tt>
1744 <ol>
1745 <li>Select System->Administration->SELinux Management</li>
1746 <li>In the SELinux Management Tool which appears,
1747 select "Boolean" from the menu on the left</li>
1748 <li>Expand the "Memory Protection" group</li>
1749 <li>Check the first item, labeled
1750 "Allow all unconfined executables to use libraries requiring text relocation ..."</li>
1751 </ol>
1752 </tt>
1753 </blockquote>
1754 </li>
1755 <li>
1756 <b>Windows Error Message: <tt>*** fatal error - couldn't allocate heap, ... </tt></b>
1757 <blockquote>
1758 The CYGWIN software can conflict with other non-CYGWIN
1759 software. See the CYGWIN FAQ section on
1760 <a href="http://cygwin.com/faq/faq.using.html#faq.using.bloda" target="_blank">
1761 BLODA (applications that interfere with CYGWIN)</a>.
1762 </blockquote>
1763 </li>
1764 <li>
1765 <b>Windows Error Message: <tt>*** multiple target patterns. Stop.</tt></b>
1766 <blockquote>
1767 The CYGWIN make version 3.81 may not like the Windows <tt>C:/</tt>
1768 style paths, it may not like the ':' character in the path
1769 when used in a makefile target definition.
1770 See the <a href="#gmake"><tt><i>gmake</i></tt></a> section.
1771 </blockquote>
1772 </li>
1773 </ul>
1774 </blockquote>
1775 <hr>
1776 </body>
1777</html>