building.md revision 2530:cda60babd152
1% OpenJDK Build README 2 3![OpenJDK](http://openjdk.java.net/images/openjdk.png) 4 5-------------------------------------------------------------------------------- 6 7## Introduction 8 9This README file contains build instructions for the 10[OpenJDK](http://openjdk.java.net). Building the source code for the OpenJDK 11requires a certain degree of technical expertise. 12 13### !!!!!!!!!!!!!!! THIS IS A MAJOR RE-WRITE of this document. !!!!!!!!!!!!! 14 15Some Headlines: 16 17 * The build is now a "`configure && make`" style build 18 * Any GNU make 3.81 or newer should work, except on Windows where 4.0 or newer 19 is recommended. 20 * The build should scale, i.e. more processors should cause the build to be 21 done in less wall-clock time 22 * Nested or recursive make invocations have been significantly reduced, as 23 has the total fork/exec or spawning of sub processes during the build 24 * Windows MKS usage is no longer supported 25 * Windows Visual Studio `vsvars*.bat` and `vcvars*.bat` files are run 26 automatically 27 * Ant is no longer used when building the OpenJDK 28 * Use of ALT\_\* environment variables for configuring the build is no longer 29 supported 30 31------------------------------------------------------------------------------- 32 33## Contents 34 35 * [Introduction](#introduction) 36 * [Use of Mercurial](#hg) 37 * [Getting the Source](#get_source) 38 * [Repositories](#repositories) 39 * [Building](#building) 40 * [System Setup](#setup) 41 * [Linux](#linux) 42 * [Solaris](#solaris) 43 * [Mac OS X](#macosx) 44 * [Windows](#windows) 45 * [Configure](#configure) 46 * [Make](#make) 47 * [Testing](#testing) 48 49------------------------------------------------------------------------------- 50 51 * [Appendix A: Hints and Tips](#hints) 52 * [FAQ](#faq) 53 * [Build Performance Tips](#performance) 54 * [Troubleshooting](#troubleshooting) 55 * [Appendix B: GNU Make Information](#gmake) 56 * [Appendix C: Build Environments](#buildenvironments) 57 58------------------------------------------------------------------------------- 59 60## Use of Mercurial 61 62The OpenJDK sources are maintained with the revision control system 63[Mercurial](http://mercurial.selenic.com/wiki/Mercurial). If you are new to 64Mercurial, please see the [Beginner 65Guides](http://mercurial.selenic.com/wiki/BeginnersGuides) or refer to the 66[Mercurial Book](http://hgbook.red-bean.com/). The first few chapters of the 67book provide an excellent overview of Mercurial, what it is and how it works. 68 69For using Mercurial with the OpenJDK refer to the [Developer Guide: Installing 70and Configuring 71Mercurial](http://openjdk.java.net/guide/repositories.html#installConfig) 72section for more information. 73 74### Getting the Source 75 76To get the entire set of OpenJDK Mercurial repositories use the script 77`get_source.sh` located in the root repository: 78 79 hg clone http://hg.openjdk.java.net/jdk9/jdk9 YourOpenJDK 80 cd YourOpenJDK 81 bash ./get_source.sh 82 83Once you have all the repositories, keep in mind that each repository is its 84own independent repository. You can also re-run `./get_source.sh` anytime to 85pull over all the latest changesets in all the repositories. This set of nested 86repositories has been given the term "forest" and there are various ways to 87apply the same `hg` command to each of the repositories. For example, the 88script `make/scripts/hgforest.sh` can be used to repeat the same `hg` command 89on every repository, e.g. 90 91 cd YourOpenJDK 92 bash ./make/scripts/hgforest.sh status 93 94### Repositories 95 96The set of repositories and what they contain: 97 98 * **. (root)** contains common configure and makefile logic 99 * **hotspot** contains source code and make files for building the OpenJDK 100 Hotspot Virtual Machine 101 * **langtools** contains source code for the OpenJDK javac and language tools 102 * **jdk** contains source code and make files for building the OpenJDK runtime 103 libraries and misc files 104 * **jaxp** contains source code for the OpenJDK JAXP functionality 105 * **jaxws** contains source code for the OpenJDK JAX-WS functionality 106 * **corba** contains source code for the OpenJDK Corba functionality 107 * **nashorn** contains source code for the OpenJDK JavaScript implementation 108 109### Repository Source Guidelines 110 111There are some very basic guidelines: 112 113 * Use of whitespace in source files (.java, .c, .h, .cpp, and .hpp files) is 114 restricted. No TABs, no trailing whitespace on lines, and files should not 115 terminate in more than one blank line. 116 * Files with execute permissions should not be added to the source 117 repositories. 118 * All generated files need to be kept isolated from the files maintained or 119 managed by the source control system. The standard area for generated files 120 is the top level `build/` directory. 121 * The default build process should be to build the product and nothing else, 122 in one form, e.g. a product (optimized), debug (non-optimized, -g plus 123 assert logic), or fastdebug (optimized, -g plus assert logic). 124 * The `.hgignore` file in each repository must exist and should include 125 `^build/`, `^dist/` and optionally any `nbproject/private` directories. **It 126 should NEVER** include anything in the `src/` or `test/` or any managed 127 directory area of a repository. 128 * Directory names and file names should never contain blanks or non-printing 129 characters. 130 * Generated source or binary files should NEVER be added to the repository 131 (that includes `javah` output). There are some exceptions to this rule, in 132 particular with some of the generated configure scripts. 133 * Files not needed for typical building or testing of the repository should 134 not be added to the repository. 135 136------------------------------------------------------------------------------- 137 138## Building 139 140The very first step in building the OpenJDK is making sure the system itself 141has everything it needs to do OpenJDK builds. Once a system is setup, it 142generally doesn't need to be done again. 143 144Building the OpenJDK is now done with running a `configure` script which will 145try and find and verify you have everything you need, followed by running 146`make`, e.g. 147 148> **`bash ./configure`** \ 149> **`make all`** 150 151Where possible the `configure` script will attempt to located the various 152components in the default locations or via component specific variable 153settings. When the normal defaults fail or components cannot be found, 154additional `configure` options may be necessary to help `configure` find the 155necessary tools for the build, or you may need to re-visit the setup of your 156system due to missing software packages. 157 158**NOTE:** The `configure` script file does not have execute permissions and 159will need to be explicitly run with `bash`, see the source guidelines. 160 161------------------------------------------------------------------------------- 162 163### System Setup 164 165Before even attempting to use a system to build the OpenJDK there are some very 166basic system setups needed. For all systems: 167 168 * Be sure the GNU make utility is version 3.81 (4.0 on windows) or newer, e.g. 169 run "`make -version`" 170 171 <a name="bootjdk"></a> 172 * Install a Bootstrap JDK. All OpenJDK builds require access to a previously 173 released JDK called the *bootstrap JDK* or *boot JDK.* The general rule is 174 that the bootstrap JDK must be an instance of the previous major release of 175 the JDK. In addition, there may be a requirement to use a release at or 176 beyond a particular update level. 177 178 ***Building JDK 9 requires JDK 8. JDK 9 developers should not use JDK 9 as 179 the boot JDK, to ensure that JDK 9 dependencies are not introduced into the 180 parts of the system that are built with JDK 8.*** 181 182 The JDK 8 binaries can be downloaded from Oracle's [JDK 8 download 183 site](http://www.oracle.com/technetwork/java/javase/downloads/index.html). 184 For build performance reasons it is very important that this bootstrap JDK 185 be made available on the local disk of the machine doing the build. You 186 should add its `bin` directory to the `PATH` environment variable. If 187 `configure` has any issues finding this JDK, you may need to use the 188 `configure` option `--with-boot-jdk`. 189 190 * Ensure that GNU make, the Bootstrap JDK, and the compilers are all in your 191 PATH environment variable. 192 193And for specific systems: 194 195 * **Linux** 196 197 Install all the software development packages needed including 198 [alsa](#alsa), [freetype](#freetype), [cups](#cups), and 199 [xrender](#xrender). See [specific system packages](#SDBE). 200 201 * **Solaris** 202 203 Install all the software development packages needed including [Studio 204 Compilers](#studio), [freetype](#freetype), [cups](#cups), and 205 [xrender](#xrender). See [specific system packages](#SDBE). 206 207 * **Windows** 208 209 * Install one of [CYGWIN](#cygwin) or [MinGW/MSYS](#msys) 210 * Install [Visual Studio 2013](#vs2013) 211 212 * **Mac OS X** 213 214 Install [XCode 6.3](https://developer.apple.com/xcode/) 215 216#### Linux 217 218With Linux, try and favor the system packages over building your own or getting 219packages from other areas. Most Linux builds should be possible with the 220system's available packages. 221 222Note that some Linux systems have a habit of pre-populating your environment 223variables for you, for example `JAVA_HOME` might get pre-defined for you to 224refer to the JDK installed on your Linux system. You will need to unset 225`JAVA_HOME`. It's a good idea to run `env` and verify the environment variables 226you are getting from the default system settings make sense for building the 227OpenJDK. 228 229#### Solaris 230 231##### Studio Compilers 232 233At a minimum, the [Studio 12 Update 4 234Compilers](http://www.oracle.com/technetwork/server-storage/solarisstudio/downloads/index.htm) 235(containing version 5.13 of the C and C++ compilers) is required, including 236specific patches. 237 238The Solaris Studio installation should contain at least these packages: 239 240 Package Version 241 -------------------------------------------------- --------------- 242 developer/solarisstudio-124/backend 12.4-1.0.6.0 243 developer/solarisstudio-124/c++ 12.4-1.0.10.0 244 developer/solarisstudio-124/cc 12.4-1.0.4.0 245 developer/solarisstudio-124/library/c++-libs 12.4-1.0.10.0 246 developer/solarisstudio-124/library/math-libs 12.4-1.0.0.1 247 developer/solarisstudio-124/library/studio-gccrt 12.4-1.0.0.1 248 developer/solarisstudio-124/studio-common 12.4-1.0.0.1 249 developer/solarisstudio-124/studio-ja 12.4-1.0.0.1 250 developer/solarisstudio-124/studio-legal 12.4-1.0.0.1 251 developer/solarisstudio-124/studio-zhCN 12.4-1.0.0.1 252 253In particular backend 12.4-1.0.6.0 contains a critical patch for the sparc 254version. 255 256Place the `bin` directory in `PATH`. 257 258The Oracle Solaris Studio Express compilers at: [Oracle Solaris Studio Express 259Download 260site](http://www.oracle.com/technetwork/server-storage/solarisstudio/downloads/index-jsp-142582.html) 261are also an option, although these compilers have not been extensively used 262yet. 263 264#### Windows 265 266##### Windows Unix Toolkit 267 268Building on Windows requires a Unix-like environment, notably a Unix-like 269shell. There are several such environments available of which 270[Cygwin](http://www.cygwin.com/) and 271[MinGW/MSYS](http://www.mingw.org/wiki/MSYS) are currently supported for the 272OpenJDK build. One of the differences of these systems from standard Windows 273tools is the way they handle Windows path names, particularly path names which 274contain spaces, backslashes as path separators and possibly drive letters. 275Depending on the use case and the specifics of each environment these path 276problems can be solved by a combination of quoting whole paths, translating 277backslashes to forward slashes, escaping backslashes with additional 278backslashes and translating the path names to their ["8.3" 279version](http://en.wikipedia.org/wiki/8.3_filename). 280 281###### CYGWIN 282 283CYGWIN is an open source, Linux-like environment which tries to emulate a 284complete POSIX layer on Windows. It tries to be smart about path names and can 285usually handle all kinds of paths if they are correctly quoted or escaped 286although internally it maps drive letters `<drive>:` to a virtual directory 287`/cygdrive/<drive>`. 288 289You can always use the `cygpath` utility to map pathnames with spaces or the 290backslash character into the `C:/` style of pathname (called 'mixed'), e.g. 291`cygpath -s -m "<path>"`. 292 293Note that the use of CYGWIN creates a unique problem with regards to setting 294[`PATH`](#path). Normally on Windows the `PATH` variable contains directories 295separated with the ";" character (Solaris and Linux use ":"). With CYGWIN, it 296uses ":", but that means that paths like "C:/path" cannot be placed in the 297CYGWIN version of `PATH` and instead CYGWIN uses something like 298`/cygdrive/c/path` which CYGWIN understands, but only CYGWIN understands. 299 300The OpenJDK build requires CYGWIN version 1.7.16 or newer. Information about 301CYGWIN can be obtained from the CYGWIN website at 302[www.cygwin.com](http://www.cygwin.com). 303 304By default CYGWIN doesn't install all the tools required for building the 305OpenJDK. Along with the default installation, you need to install the following 306tools. 307 308 Binary Name Category Package Description 309 ------------- -------------- ---------- ------------------------------------------------------------ 310 ar.exe Devel binutils The GNU assembler, linker and binary utilities 311 make.exe Devel make The GNU version of the 'make' utility built for CYGWIN 312 m4.exe Interpreters m4 GNU implementation of the traditional Unix macro processor 313 cpio.exe Utils cpio A program to manage archives of files 314 gawk.exe Utils awk Pattern-directed scanning and processing language 315 file.exe Utils file Determines file type using 'magic' numbers 316 zip.exe Archive zip Package and compress (archive) files 317 unzip.exe Archive unzip Extract compressed files in a ZIP archive 318 free.exe System procps Display amount of free and used memory in the system 319 320Note that the CYGWIN software can conflict with other non-CYGWIN software on 321your Windows system. CYGWIN provides a 322[FAQ](http://cygwin.com/faq/faq.using.html) for known issues and problems, 323of particular interest is the section on [BLODA (applications that interfere 324with CYGWIN)](http://cygwin.com/faq/faq.using.html#faq.using.bloda). 325 326###### MinGW/MSYS 327 328MinGW ("Minimalist GNU for Windows") is a collection of free Windows specific 329header files and import libraries combined with GNU toolsets that allow one to 330produce native Windows programs that do not rely on any 3rd-party C runtime 331DLLs. MSYS is a supplement to MinGW which allows building applications and 332programs which rely on traditional UNIX tools to be present. Among others this 333includes tools like `bash` and `make`. See 334[MinGW/MSYS](http://www.mingw.org/wiki/MSYS) for more information. 335 336Like Cygwin, MinGW/MSYS can handle different types of path formats. They are 337internally converted to paths with forward slashes and drive letters `<drive>:` 338replaced by a virtual directory `/<drive>`. Additionally, MSYS automatically 339detects binaries compiled for the MSYS environment and feeds them with the 340internal, Unix-style path names. If native Windows applications are called from 341within MSYS programs their path arguments are automatically converted back to 342Windows style path names with drive letters and backslashes as path separators. 343This may cause problems for Windows applications which use forward slashes as 344parameter separator (e.g. `cl /nologo /I`) because MSYS may wrongly [replace 345such parameters by drive 346letters](http://mingw.org/wiki/Posix_path_conversion). 347 348In addition to the tools which will be installed by default, you have to 349manually install the `msys-zip` and `msys-unzip` packages. This can be easily 350done with the MinGW command line installer: 351 352 mingw-get.exe install msys-zip 353 mingw-get.exe install msys-unzip 354 355##### Visual Studio 2013 Compilers 356 357The 32-bit and 64-bit OpenJDK Windows build requires Microsoft Visual Studio 358C++ 2013 (VS2013) Professional Edition or Express compiler. The compiler and 359other tools are expected to reside in the location defined by the variable 360`VS120COMNTOOLS` which is set by the Microsoft Visual Studio installer. 361 362Only the C++ part of VS2013 is needed. Try to let the installation go to the 363default install directory. Always reboot your system after installing VS2013. 364The system environment variable VS120COMNTOOLS should be set in your 365environment. 366 367Make sure that TMP and TEMP are also set in the environment and refer to 368Windows paths that exist, like `C:\temp`, not `/tmp`, not `/cygdrive/c/temp`, 369and not `C:/temp`. `C:\temp` is just an example, it is assumed that this area 370is private to the user, so by default after installs you should see a unique 371user path in these variables. 372 373#### Mac OS X 374 375Make sure you get the right XCode version. 376 377------------------------------------------------------------------------------- 378 379### Configure 380 381The basic invocation of the `configure` script looks like: 382 383> **`bash ./configure [options]`** 384 385This will create an output directory containing the "configuration" and setup 386an area for the build result. This directory typically looks like: 387 388> **`build/linux-x64-normal-server-release`** 389 390`configure` will try to figure out what system you are running on and where all 391necessary build components are. If you have all prerequisites for building 392installed, it should find everything. If it fails to detect any component 393automatically, it will exit and inform you about the problem. When this 394happens, read more below in [the `configure` options](#configureoptions). 395 396Some examples: 397 398> **Windows 32bit build with freetype specified:** \ 399> `bash ./configure --with-freetype=/cygdrive/c/freetype-i586 --with-target-bits=32` 400 401> **Debug 64bit Build:** \ 402> `bash ./configure --enable-debug --with-target-bits=64` 403 404#### Configure Options 405 406Complete details on all the OpenJDK `configure` options can be seen with: 407 408> **`bash ./configure --help=short`** 409 410Use `-help` to see all the `configure` options available. You can generate any 411number of different configurations, e.g. debug, release, 32, 64, etc. 412 413Some of the more commonly used `configure` options are: 414 415> **`--enable-debug`** \ 416> set the debug level to fastdebug (this is a shorthand for 417> `--with-debug-level=fastdebug`) 418 419<a name="alsa"></a> 420 421> **`--with-alsa=`**_path_ \ 422> select the location of the Advanced Linux Sound Architecture (ALSA) 423 424> Version 0.9.1 or newer of the ALSA files are required for building the 425 OpenJDK on Linux. These Linux files are usually available from an "alsa" of 426 "libasound" development package, and it's highly recommended that you try 427 and use the package provided by the particular version of Linux that you are 428 using. 429 430> **`--with-boot-jdk=`**_path_ \ 431> select the [Bootstrap JDK](#bootjdk) 432 433> **`--with-boot-jdk-jvmargs=`**"_args_" \ 434> provide the JVM options to be used to run the [Bootstrap JDK](#bootjdk) 435 436> **`--with-cacerts=`**_path_ \ 437> select the path to the cacerts file. 438 439> See [Certificate Authority on 440 Wikipedia](http://en.wikipedia.org/wiki/Certificate_Authority) for a 441 better understanding of the Certificate Authority (CA). A certificates file 442 named "cacerts" represents a system-wide keystore with CA certificates. In 443 JDK and JRE binary bundles, the "cacerts" file contains root CA certificates 444 from several public CAs (e.g., VeriSign, Thawte, and Baltimore). The source 445 contain a cacerts file without CA root certificates. Formal JDK builders will 446 need to secure permission from each public CA and include the certificates 447 into their own custom cacerts file. Failure to provide a populated cacerts 448 file will result in verification errors of a certificate chain during 449 runtime. By default an empty cacerts file is provided and that should be fine 450 for most JDK developers. 451 452<a name="cups"></a> 453 454> **`--with-cups=`**_path_ \ 455> select the CUPS install location 456 457> The Common UNIX Printing System (CUPS) Headers are required for building the 458 OpenJDK on Solaris and Linux. The Solaris header files can be obtained by 459 installing the package **print/cups**. 460 461> The CUPS header files can always be downloaded from 462 [www.cups.org](http://www.cups.org). 463 464> **`--with-cups-include=`**_path_ \ 465> select the CUPS include directory location 466 467> **`--with-debug-level=`**_level_ \ 468> select the debug information level of release, fastdebug, or slowdebug 469 470> **`--with-dev-kit=`**_path_ \ 471> select location of the compiler install or developer install location 472 473<a name="freetype"></a> 474 475> **`--with-freetype=`**_path_ \ 476> select the freetype files to use. 477 478> Expecting the freetype libraries under `lib/` and the headers under 479 `include/`. 480 481> Version 2.3 or newer of FreeType is required. On Unix systems required files 482 can be available as part of your distribution (while you still may need to 483 upgrade them). Note that you need development version of package that 484 includes both the FreeType library and header files. 485 486> You can always download latest FreeType version from the [FreeType 487 website](http://www.freetype.org). Building the freetype 2 libraries from 488 scratch is also possible, however on Windows refer to the [Windows FreeType 489 DLL build instructions](http://freetype.freedesktop.org/wiki/FreeType_DLL). 490 491> Note that by default FreeType is built with byte code hinting support 492 disabled due to licensing restrictions. In this case, text appearance and 493 metrics are expected to differ from Sun's official JDK build. See the 494 [SourceForge FreeType2 Home Page](http://freetype.sourceforge.net/freetype2) 495 for more information. 496 497> **`--with-import-hotspot=`**_path_ \ 498> select the location to find hotspot binaries from a previous build to avoid 499 building hotspot 500 501> **`--with-target-bits=`**_arg_ \ 502> select 32 or 64 bit build 503 504> **`--with-jvm-variants=`**_variants_ \ 505> select the JVM variants to build from, comma separated list that can 506 include: server, client, kernel, zero and zeroshark 507 508> **`--with-memory-size=`**_size_ \ 509> select the RAM size that GNU make will think this system has 510 511> **`--with-msvcr-dll=`**_path_ \ 512> select the `msvcr100.dll` file to include in the Windows builds (C/C++ 513 runtime library for Visual Studio). 514 515> This is usually picked up automatically from the redist directories of 516 Visual Studio 2013. 517 518> **`--with-num-cores=`**_cores_ \ 519> select the number of cores to use (processor count or CPU count) 520 521<a name="xrender"></a> 522 523> **`--with-x=`**_path_ \ 524> select the location of the X11 and xrender files. 525 526> The XRender Extension Headers are required for building the OpenJDK on 527 Solaris and Linux. The Linux header files are usually available from a 528 "Xrender" development package, it's recommended that you try and use the 529 package provided by the particular distribution of Linux that you are using. 530 The Solaris XRender header files is included with the other X11 header files 531 in the package **SFWxwinc** on new enough versions of Solaris and will be 532 installed in `/usr/X11/include/X11/extensions/Xrender.h` or 533 `/usr/openwin/share/include/X11/extensions/Xrender.h` 534 535------------------------------------------------------------------------------- 536 537### Make 538 539The basic invocation of the `make` utility looks like: 540 541> **`make all`** 542 543This will start the build to the output directory containing the 544"configuration" that was created by the `configure` script. Run `make help` for 545more information on the available targets. 546 547There are some of the make targets that are of general interest: 548 549> _empty_ \ 550> build everything but no images 551 552> **`all`** \ 553> build everything including images 554 555> **`all-conf`** \ 556> build all configurations 557 558> **`images`** \ 559> create complete j2sdk and j2re images 560 561> **`install`** \ 562> install the generated images locally, typically in `/usr/local` 563 564> **`clean`** \ 565> remove all files generated by make, but not those generated by `configure` 566 567> **`dist-clean`** \ 568> remove all files generated by both and `configure` (basically killing the 569 configuration) 570 571> **`help`** \ 572> give some help on using `make`, including some interesting make targets 573 574------------------------------------------------------------------------------- 575 576## Testing 577 578When the build is completed, you should see the generated binaries and 579associated files in the `j2sdk-image` directory in the output directory. In 580particular, the `build/*/images/j2sdk-image/bin` directory should contain 581executables for the OpenJDK tools and utilities for that configuration. The 582testing tool `jtreg` will be needed and can be found at: [the jtreg 583site](http://openjdk.java.net/jtreg/). The provided regression tests in the 584repositories can be run with the command: 585 586> **``cd test && make PRODUCT_HOME=`pwd`/../build/*/images/j2sdk-image all``** 587 588------------------------------------------------------------------------------- 589 590## Appendix A: Hints and Tips 591 592### FAQ 593 594**Q:** The `generated-configure.sh` file looks horrible! How are you going to 595edit it? \ 596**A:** The `generated-configure.sh` file is generated (think "compiled") by the 597autoconf tools. The source code is in `configure.ac` and various .m4 files in 598common/autoconf, which are much more readable. 599 600**Q:** Why is the `generated-configure.sh` file checked in, if it is 601generated? \ 602**A:** If it was not generated, every user would need to have the autoconf 603tools installed, and re-generate the `configure` file as the first step. Our 604goal is to minimize the work needed to be done by the user to start building 605OpenJDK, and to minimize the number of external dependencies required. 606 607**Q:** Do you require a specific version of autoconf for regenerating 608`generated-configure.sh`? \ 609**A:** Yes, version 2.69 is required and should be easy enough to aquire on all 610supported operating systems. The reason for this is to avoid large spurious 611changes in `generated-configure.sh`. 612 613**Q:** How do you regenerate `generated-configure.sh` after making changes to 614the input files? \ 615**A:** Regnerating `generated-configure.sh` should always be done using the 616script `common/autoconf/autogen.sh` to ensure that the correct files get 617updated. This script should also be run after mercurial tries to merge 618`generated-configure.sh` as a merge of the generated file is not guaranteed to 619be correct. 620 621**Q:** What are the files in `common/makefiles/support/*` for? They look like 622gibberish. \ 623**A:** They are a somewhat ugly hack to compensate for command line length 624limitations on certain platforms (Windows, Solaris). Due to a combination of 625limitations in make and the shell, command lines containing too many files will 626not work properly. These helper files are part of an elaborate hack that will 627compress the command line in the makefile and then uncompress it safely. We're 628not proud of it, but it does fix the problem. If you have any better 629suggestions, we're all ears! :-) 630 631**Q:** I want to see the output of the commands that make runs, like in the old 632build. How do I do that? \ 633**A:** You specify the `LOG` variable to make. There are several log levels: 634 635 * **`warn`** -- Default and very quiet. 636 * **`info`** -- Shows more progress information than warn. 637 * **`debug`** -- Echos all command lines and prints all macro calls for 638 compilation definitions. 639 * **`trace`** -- Echos all \$(shell) command lines as well. 640 641**Q:** When do I have to re-run `configure`? \ 642**A:** Normally you will run `configure` only once for creating a 643configuration. You need to re-run configuration only if you want to change any 644configuration options, or if you pull down changes to the `configure` script. 645 646**Q:** I have added a new source file. Do I need to modify the makefiles? \ 647**A:** Normally, no. If you want to create e.g. a new native library, you will 648need to modify the makefiles. But for normal file additions or removals, no 649changes are needed. There are certan exceptions for some native libraries where 650the source files are spread over many directories which also contain sources 651for other libraries. In these cases it was simply easier to create include 652lists rather than excludes. 653 654**Q:** When I run `configure --help`, I see many strange options, like 655`--dvidir`. What is this? \ 656**A:** Configure provides a slew of options by default, to all projects that 657use autoconf. Most of them are not used in OpenJDK, so you can safely ignore 658them. To list only OpenJDK specific features, use `configure --help=short` 659instead. 660 661**Q:** `configure` provides OpenJDK-specific features such as 662`--with-builddeps-server` that are not described in this document. What about 663those? \ 664**A:** Try them out if you like! But be aware that most of these are 665experimental features. Many of them don't do anything at all at the moment; the 666option is just a placeholder. Others depend on pieces of code or infrastructure 667that is currently not ready for prime time. 668 669**Q:** How will you make sure you don't break anything? \ 670**A:** We have a script that compares the result of the new build system with 671the result of the old. For most part, we aim for (and achieve) byte-by-byte 672identical output. There are however technical issues with e.g. native binaries, 673which might differ in a byte-by-byte comparison, even when building twice with 674the old build system. For these, we compare relevant aspects (e.g. the symbol 675table and file size). Note that we still don't have 100% equivalence, but we're 676close. 677 678**Q:** I noticed this thing X in the build that looks very broken by design. 679Why don't you fix it? \ 680**A:** Our goal is to produce a build output that is as close as technically 681possible to the old build output. If things were weird in the old build, they 682will be weird in the new build. Often, things were weird before due to 683obscurity, but in the new build system the weird stuff comes up to the surface. 684The plan is to attack these things at a later stage, after the new build system 685is established. 686 687**Q:** The code in the new build system is not that well-structured. Will you 688fix this? \ 689**A:** Yes! The new build system has grown bit by bit as we converted the old 690system. When all of the old build system is converted, we can take a step back 691and clean up the structure of the new build system. Some of this we plan to do 692before replacing the old build system and some will need to wait until after. 693 694**Q:** Is anything able to use the results of the new build's default make 695target? \ 696**A:** Yes, this is the minimal (or roughly minimal) set of compiled output 697needed for a developer to actually execute the newly built JDK. The idea is 698that in an incremental development fashion, when doing a normal make, you 699should only spend time recompiling what's changed (making it purely 700incremental) and only do the work that's needed to actually run and test your 701code. The packaging stuff that is part of the `images` target is not needed for 702a normal developer who wants to test his new code. Even if it's quite fast, 703it's still unnecessary. We're targeting sub-second incremental rebuilds! ;-) 704(Or, well, at least single-digit seconds...) 705 706**Q:** I usually set a specific environment variable when building, but I can't 707find the equivalent in the new build. What should I do? \ 708**A:** It might very well be that we have neglected to add support for an 709option that was actually used from outside the build system. Email us and we 710will add support for it! 711 712### Build Performance Tips 713 714Building OpenJDK requires a lot of horsepower. Some of the build tools can be 715adjusted to utilize more or less of resources such as parallel threads and 716memory. The `configure` script analyzes your system and selects reasonable 717values for such options based on your hardware. If you encounter resource 718problems, such as out of memory conditions, you can modify the detected values 719with: 720 721 * **`--with-num-cores`** -- number of cores in the build system, e.g. 722 `--with-num-cores=8` 723 * **`--with-memory-size`** -- memory (in MB) available in the build system, 724 e.g. `--with-memory-size=1024` 725 726It might also be necessary to specify the JVM arguments passed to the Bootstrap 727JDK, using e.g. `--with-boot-jdk-jvmargs="-Xmx8G -enableassertions"`. Doing 728this will override the default JVM arguments passed to the Bootstrap JDK. 729 730One of the top goals of the new build system is to improve the build 731performance and decrease the time needed to build. This will soon also apply to 732the java compilation when the Smart Javac wrapper is fully supported. 733 734At the end of a successful execution of `configure`, you will get a performance 735summary, indicating how well the build will perform. Here you will also get 736performance hints. If you want to build fast, pay attention to those! 737 738#### Building with ccache 739 740The OpenJDK build supports building with ccache when using gcc or clang. Using 741ccache can radically speed up compilation of native code if you often rebuild 742the same sources. Your milage may vary however so we recommend evaluating it 743for yourself. To enable it, make sure it's on the path and configure with 744`--enable-ccache`. 745 746#### Building on local disk 747 748If you are using network shares, e.g. via NFS, for your source code, make sure 749the build directory is situated on local disk. The performance penalty is 750extremely high for building on a network share, close to unusable. 751 752#### Building only one JVM 753 754The old build builds multiple JVMs on 32-bit systems (client and server; and on 755Windows kernel as well). In the new build we have changed this default to only 756build server when it's available. This improves build times for those not 757interested in multiple JVMs. To mimic the old behavior on platforms that 758support it, use `--with-jvm-variants=client,server`. 759 760#### Selecting the number of cores to build on 761 762By default, `configure` will analyze your machine and run the make process in 763parallel with as many threads as you have cores. This behavior can be 764overridden, either "permanently" (on a `configure` basis) using 765`--with-num-cores=N` or for a single build only (on a make basis), using 766`make JOBS=N`. 767 768If you want to make a slower build just this time, to save some CPU power for 769other processes, you can run e.g. `make JOBS=2`. This will force the makefiles 770to only run 2 parallel processes, or even `make JOBS=1` which will disable 771parallelism. 772 773If you want to have it the other way round, namely having slow builds default 774and override with fast if you're impatient, you should call `configure` with 775`--with-num-cores=2`, making 2 the default. If you want to run with more cores, 776run `make JOBS=8` 777 778### Troubleshooting 779 780#### Solving build problems 781 782If the build fails (and it's not due to a compilation error in a source file 783you've changed), the first thing you should do is to re-run the build with more 784verbosity. Do this by adding `LOG=debug` to your make command line. 785 786The build log (with both stdout and stderr intermingled, basically the same as 787you see on your console) can be found as `build.log` in your build directory. 788 789You can ask for help on build problems with the new build system on either the 790[build-dev](http://mail.openjdk.java.net/mailman/listinfo/build-dev) or the 791[build-infra-dev](http://mail.openjdk.java.net/mailman/listinfo/build-infra-dev) 792mailing lists. Please include the relevant parts of the build log. 793 794A build can fail for any number of reasons. Most failures are a result of 795trying to build in an environment in which all the pre-build requirements have 796not been met. The first step in troubleshooting a build failure is to recheck 797that you have satisfied all the pre-build requirements for your platform. 798Scanning the `configure` log is a good first step, making sure that what it 799found makes sense for your system. Look for strange error messages or any 800difficulties that `configure` had in finding things. 801 802Some of the more common problems with builds are briefly described below, with 803suggestions for remedies. 804 805 * **Corrupted Bundles on Windows:** \ 806 Some virus scanning software has been known to corrupt the downloading of 807 zip bundles. It may be necessary to disable the 'on access' or 'real time' 808 virus scanning features to prevent this corruption. This type of 'real time' 809 virus scanning can also slow down the build process significantly. 810 Temporarily disabling the feature, or excluding the build output directory 811 may be necessary to get correct and faster builds. 812 813 * **Slow Builds:** \ 814 If your build machine seems to be overloaded from too many simultaneous C++ 815 compiles, try setting the `JOBS=1` on the `make` command line. Then try 816 increasing the count slowly to an acceptable level for your system. Also: 817 818 Creating the javadocs can be very slow, if you are running javadoc, consider 819 skipping that step. 820 821 Faster CPUs, more RAM, and a faster DISK usually helps. The VM build tends 822 to be CPU intensive (many C++ compiles), and the rest of the JDK will often 823 be disk intensive. 824 825 Faster compiles are possible using a tool called 826 [ccache](http://ccache.samba.org/). 827 828 * **File time issues:** \ 829 If you see warnings that refer to file time stamps, e.g. 830 831 > _Warning message:_ ` File 'xxx' has modification time in the future.` \ 832 > _Warning message:_ ` Clock skew detected. Your build may be incomplete.` 833 834 These warnings can occur when the clock on the build machine is out of sync 835 with the timestamps on the source files. Other errors, apparently unrelated 836 but in fact caused by the clock skew, can occur along with the clock skew 837 warnings. These secondary errors may tend to obscure the fact that the true 838 root cause of the problem is an out-of-sync clock. 839 840 If you see these warnings, reset the clock on the build machine, run 841 "`gmake clobber`" or delete the directory containing the build output, and 842 restart the build from the beginning. 843 844 * **Error message: `Trouble writing out table to disk`** \ 845 Increase the amount of swap space on your build machine. This could be 846 caused by overloading the system and it may be necessary to use: 847 848 > `make JOBS=1` 849 850 to reduce the load on the system. 851 852 * **Error Message: `libstdc++ not found`:** \ 853 This is caused by a missing libstdc++.a library. This is installed as part 854 of a specific package (e.g. libstdc++.so.devel.386). By default some 64-bit 855 Linux versions (e.g. Fedora) only install the 64-bit version of the 856 libstdc++ package. Various parts of the JDK build require a static link of 857 the C++ runtime libraries to allow for maximum portability of the built 858 images. 859 860 * **Linux Error Message: `cannot restore segment prot after reloc`** \ 861 This is probably an issue with SELinux (See [SELinux on 862 Wikipedia](http://en.wikipedia.org/wiki/SELinux)). Parts of the VM is built 863 without the `-fPIC` for performance reasons. 864 865 To completely disable SELinux: 866 867 1. `$ su root` 868 2. `# system-config-securitylevel` 869 3. `In the window that appears, select the SELinux tab` 870 4. `Disable SELinux` 871 872 Alternatively, instead of completely disabling it you could disable just 873 this one check. 874 875 1. Select System->Administration->SELinux Management 876 2. In the SELinux Management Tool which appears, select "Boolean" from the 877 menu on the left 878 3. Expand the "Memory Protection" group 879 4. Check the first item, labeled "Allow all unconfined executables to use 880 libraries requiring text relocation ..." 881 882 * **Windows Error Messages:** \ 883 `*** fatal error - couldn't allocate heap, ... ` \ 884 `rm fails with "Directory not empty"` \ 885 `unzip fails with "cannot create ... Permission denied"` \ 886 `unzip fails with "cannot create ... Error 50"` 887 888 The CYGWIN software can conflict with other non-CYGWIN software. See the 889 CYGWIN FAQ section on [BLODA (applications that interfere with 890 CYGWIN)](http://cygwin.com/faq/faq.using.html#faq.using.bloda). 891 892 * **Windows Error Message: `spawn failed`** \ 893 Try rebooting the system, or there could be some kind of issue with the disk 894 or disk partition being used. Sometimes it comes with a "Permission Denied" 895 message. 896 897------------------------------------------------------------------------------- 898 899## Appendix B: GNU make 900 901The Makefiles in the OpenJDK are only valid when used with the GNU version of 902the utility command `make` (usually called `gmake` on Solaris). A few notes 903about using GNU make: 904 905 * You need GNU make version 3.81 or newer. On Windows 4.0 or newer is 906 recommended. If the GNU make utility on your systems is not of a suitable 907 version, see "[Building GNU make](#buildgmake)". 908 * Place the location of the GNU make binary in the `PATH`. 909 * **Solaris:** Do NOT use `/usr/bin/make` on Solaris. If your Solaris system 910 has the software from the Solaris Developer Companion CD installed, you 911 should try and use `/usr/bin/gmake` or `/usr/gnu/bin/make`. 912 * **Windows:** Make sure you start your build inside a bash shell. 913 * **Mac OS X:** The XCode "command line tools" must be installed on your Mac. 914 915Information on GNU make, and access to ftp download sites, are available on the 916[GNU make web site](http://www.gnu.org/software/make/make.html). The latest 917source to GNU make is available at 918[ftp.gnu.org/pub/gnu/make/](http://ftp.gnu.org/pub/gnu/make/). 919 920### Building GNU make 921 922First step is to get the GNU make 3.81 or newer source from 923[ftp.gnu.org/pub/gnu/make/](http://ftp.gnu.org/pub/gnu/make/). Building is a 924little different depending on the OS but is basically done with: 925 926 bash ./configure 927 make 928 929------------------------------------------------------------------------------- 930 931## Appendix C: Build Environments 932 933### Minimum Build Environments 934 935This file often describes specific requirements for what we call the "minimum 936build environments" (MBE) for this specific release of the JDK. What is listed 937below is what the Oracle Release Engineering Team will use to build the Oracle 938JDK product. Building with the MBE will hopefully generate the most compatible 939bits that install on, and run correctly on, the most variations of the same 940base OS and hardware architecture. In some cases, these represent what is often 941called the least common denominator, but each Operating System has different 942aspects to it. 943 944In all cases, the Bootstrap JDK version minimum is critical, we cannot 945guarantee builds will work with older Bootstrap JDK's. Also in all cases, more 946RAM and more processors is better, the minimums listed below are simply 947recommendations. 948 949With Solaris and Mac OS X, the version listed below is the oldest release we 950can guarantee builds and works, and the specific version of the compilers used 951could be critical. 952 953With Windows the critical aspect is the Visual Studio compiler used, which due 954to it's runtime, generally dictates what Windows systems can do the builds and 955where the resulting bits can be used. 956 957**NOTE: We expect a change here off these older Windows OS releases and to a 958'less older' one, probably Windows 2008R2 X64.** 959 960With Linux, it was just a matter of picking a stable distribution that is a 961good representative for Linux in general. 962 963It is understood that most developers will NOT be using these specific 964versions, and in fact creating these specific versions may be difficult due to 965the age of some of this software. It is expected that developers are more often 966using the more recent releases and distributions of these operating systems. 967 968Compilation problems with newer or different C/C++ compilers is a common 969problem. Similarly, compilation problems related to changes to the 970`/usr/include` or system header files is also a common problem with older, 971newer, or unreleased OS versions. Please report these types of problems as bugs 972so that they can be dealt with accordingly. 973 974Bootstrap JDK: JDK 8 975 976 Base OS and Architecture OS C/C++ Compiler Processors RAM Minimum DISK Needs 977 ------------------------------------- ----------------------------- ------------------------------------------------------- ------------ ------------- ------------ 978 Linux X86 (32-bit) and X64 (64-bit) Oracle Enterprise Linux 6.4 gcc 4.9.2 2 or more 1 GB 6 GB 979 Solaris SPARCV9 (64-bit) Solaris 11 Update 1 Studio 12 Update 4 + patches 4 or more 4 GB 8 GB 980 Solaris X64 (64-bit) Solaris 11 Update 1 Studio 12 Update 4 + patches 4 or more 4 GB 8 GB 981 Windows X86 (32-bit) Windows Server 2012 R2 x64 Microsoft Visual Studio C++ 2013 Professional Edition 2 or more 2 GB 6 GB 982 Windows X64 (64-bit) Windows Server 2012 R2 x64 Microsoft Visual Studio C++ 2013 Professional Edition 2 or more 2 GB 6 GB 983 Mac OS X X64 (64-bit) Mac OS X 10.9 "Mavericks" Xcode 6.3 or newer 2 or more 4 GB 6 GB 984 985------------------------------------------------------------------------------- 986 987### Specific Developer Build Environments 988 989We won't be listing all the possible environments, but we will try to provide 990what information we have available to us. 991 992**NOTE: The community can help out by updating this part of the document.** 993 994#### Fedora 995 996After installing the latest [Fedora](http://fedoraproject.org) you need to 997install several build dependencies. The simplest way to do it is to execute the 998following commands as user `root`: 999 1000 yum-builddep java-1.7.0-openjdk 1001 yum install gcc gcc-c++ 1002 1003In addition, it's necessary to set a few environment variables for the build: 1004 1005 export LANG=C 1006 export PATH="/usr/lib/jvm/java-openjdk/bin:${PATH}" 1007 1008#### CentOS 5.5 1009 1010After installing [CentOS 5.5](http://www.centos.org/) you need to make sure you 1011have the following Development bundles installed: 1012 1013 * Development Libraries 1014 * Development Tools 1015 * Java Development 1016 * X Software Development (Including XFree86-devel) 1017 1018Plus the following packages: 1019 1020 * cups devel: Cups Development Package 1021 * alsa devel: Alsa Development Package 1022 * Xi devel: libXi.so Development Package 1023 1024The freetype 2.3 packages don't seem to be available, but the freetype 2.3 1025sources can be downloaded, built, and installed easily enough from [the 1026freetype site](http://downloads.sourceforge.net/freetype). Build and install 1027with something like: 1028 1029 bash ./configure 1030 make 1031 sudo -u root make install 1032 1033Mercurial packages could not be found easily, but a Google search should find 1034ones, and they usually include Python if it's needed. 1035 1036#### Debian 5.0 (Lenny) 1037 1038After installing [Debian](http://debian.org) 5 you need to install several 1039build dependencies. The simplest way to install the build dependencies is to 1040execute the following commands as user `root`: 1041 1042 aptitude build-dep openjdk-7 1043 aptitude install openjdk-7-jdk libmotif-dev 1044 1045In addition, it's necessary to set a few environment variables for the build: 1046 1047 export LANG=C 1048 export PATH="/usr/lib/jvm/java-7-openjdk/bin:${PATH}" 1049 1050#### Ubuntu 12.04 1051 1052After installing [Ubuntu](http://ubuntu.org) 12.04 you need to install several 1053build dependencies. The simplest way to do it is to execute the following 1054commands: 1055 1056 sudo aptitude build-dep openjdk-7 1057 sudo aptitude install openjdk-7-jdk 1058 1059In addition, it's necessary to set a few environment variables for the build: 1060 1061 export LANG=C 1062 export PATH="/usr/lib/jvm/java-7-openjdk/bin:${PATH}" 1063 1064#### OpenSUSE 11.1 1065 1066After installing [OpenSUSE](http://opensuse.org) 11.1 you need to install 1067several build dependencies. The simplest way to install the build dependencies 1068is to execute the following commands: 1069 1070 sudo zypper source-install -d java-1_7_0-openjdk 1071 sudo zypper install make 1072 1073In addition, it is necessary to set a few environment variables for the build: 1074 1075 export LANG=C 1076 export PATH="/usr/lib/jvm/java-1.7.0-openjdk/bin:$[PATH}" 1077 1078Finally, you need to unset the `JAVA_HOME` environment variable: 1079 1080 export -n JAVA_HOME` 1081 1082#### Mandriva Linux One 2009 Spring 1083 1084After installing [Mandriva](http://mandriva.org) Linux One 2009 Spring you need 1085to install several build dependencies. The simplest way to install the build 1086dependencies is to execute the following commands as user `root`: 1087 1088 urpmi java-1.7.0-openjdk-devel make gcc gcc-c++ freetype-devel zip unzip 1089 libcups2-devel libxrender1-devel libalsa2-devel libstc++-static-devel 1090 libxtst6-devel libxi-devel 1091 1092In addition, it is necessary to set a few environment variables for the build: 1093 1094 export LANG=C 1095 export PATH="/usr/lib/jvm/java-1.7.0-openjdk/bin:${PATH}" 1096 1097#### OpenSolaris 2009.06 1098 1099After installing [OpenSolaris](http://opensolaris.org) 2009.06 you need to 1100install several build dependencies. The simplest way to install the build 1101dependencies is to execute the following commands: 1102 1103 pfexec pkg install SUNWgmake SUNWj7dev sunstudioexpress SUNWcups SUNWzip 1104 SUNWunzip SUNWxwhl SUNWxorg-headers SUNWaudh SUNWfreetype2 1105 1106In addition, it is necessary to set a few environment variables for the build: 1107 1108 export LANG=C 1109 export PATH="/opt/SunStudioExpress/bin:${PATH}" 1110 1111------------------------------------------------------------------------------- 1112 1113End of the OpenJDK build README document. 1114 1115Please come again! 1116