1 page.title=Initializing a Build Environment 2 @jd:body 3 4 <!-- 5 Copyright 2013 The Android Open Source Project 6 7 Licensed under the Apache License, Version 2.0 (the "License"); 8 you may not use this file except in compliance with the License. 9 You may obtain a copy of the License at 10 11 http://www.apache.org/licenses/LICENSE-2.0 12 13 Unless required by applicable law or agreed to in writing, software 14 distributed under the License is distributed on an "AS IS" BASIS, 15 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 16 See the License for the specific language governing permissions and 17 limitations under the License. 18 --> 19 <div id="qv-wrapper"> 20 <div id="qv"> 21 <h2>In this document</h2> 22 <ol id="auto-toc"> 23 </ol> 24 </div> 25 </div> 26 27 <p>This section describes how to set up your local work environment to build 28 the Android source files. You will need to use Linux or Mac OS. Building under 29 Windows is not currently supported.</p> 30 <p><strong>Note</strong>: The source download is approximately 8.5GB in size. 31 You will need over 30GB free to complete a single build, and 32 up to 100GB (or more) for a full set of builds.</em></p> 33 <p>For an overview of the entire code-review and code-update process, see <a 34 href="life-of-a-patch.html">Life of a Patch</a>.</p> 35 <h2 id="choosing-a-branch">Choosing a Branch</h2> 36 <p>Some of the requirements for your build environment are determined by which 37 version of the source code you plan to compile. See 38 <a href="build-numbers.html">Build Numbers</a> for a full listing of branches you may 39 choose from. You may also choose to download and build the latest source code 40 (called "master"), in which case you will simply omit the branch specification 41 when you initialize the repository.</p> 42 <p>Once you have selected a branch, follow the appropriate instructions below to 43 set up your build environment.</p> 44 <h2 id="setting-up-a-linux-build-environment">Setting up a Linux build environment</h2> 45 <p>These instructions apply to all branches, including master.</p> 46 <p>The Android build is routinely tested in house on recent versions of 47 Ubuntu LTS (12.04), but most distributions should have the required 48 build tools available. Reports of successes or failures on other 49 distributions are welcome.</p> 50 <p>For Gingerbread (2.3.x) and newer versions, including the master 51 branch, a 64-bit environment is required. Older versions can be 52 compiled on 32-bit systems.</p> 53 <p><strong>Note</strong>: It is also possible to build Android in a virtual machine. 54 If you are running Linux in a virtual machine, you will need at 55 least 16GB of RAM/swap and 30GB or more of disk space in order to 56 build the Android tree.</p> 57 <p>See the <a href="building.html">Downloading and Building</a> page for the 58 list of hardware and software requirements. Then follow the detailed 59 instructions for Ubuntu and MacOS below.</p> 60 61 <h3 id="installing-the-jdk">Installing the JDK</h3> 62 <p>The master branch of Android in the <a 63 href="https://android.googlesource.com/">Android Open Source Project (AOSP)</a> 64 requires Java 7. On Ubuntu, use <a href="http://openjdk.java.net/install/">OpenJDK</a>.</p> 65 <p>Java 7: For the latest version of Android</p> 66 <pre><code>$ sudo apt-get update 67 $ sudo apt-get install openjdk-7-jdk 68 </code></pre> 69 70 <p>Optionally, update the default Java version by running:</p> 71 <pre><code>$ sudo update-alternatives --config java 72 $ sudo update-alternatives --config javac 73 </code></pre> 74 75 <p>If you encounter version errors for Java, set its 76 path as described in the <a href="building-running.html#wrong-java-version">Wrong 77 Java Version</a> section.</p> 78 79 <p>To develop older versions of Android, download and install the corresponding version of the <a 80 href="http://www.oracle.com/technetwork/java/javase/archive-139210.html">Java JDK</a>:<br/> 81 Java 6: for Gingerbread through KitKat<br/> 82 Java 5: for Cupcake through Froyo</p> 83 84 <p><strong>Note</strong>: The <code>lunch</code> command in the build step will ensure that the Sun JDK is 85 used instead of any previously installed JDK.</p> 86 87 <h3 id="installing-required-packages-ubuntu-1204">Installing required packages (Ubuntu 12.04)</h3> 88 <p>You will need a 64-bit version of Ubuntu. Ubuntu 12.04 is recommended. 89 Building using an older version of Ubuntu is not supported on master or recent releases.</p> 90 <pre><code>$ sudo apt-get install git gnupg flex bison gperf build-essential \ 91 zip curl libc6-dev libncurses5-dev:i386 x11proto-core-dev \ 92 libx11-dev:i386 libreadline6-dev:i386 libgl1-mesa-glx:i386 \ 93 libgl1-mesa-dev g++-multilib mingw32 tofrodos \ 94 python-markdown libxml2-utils xsltproc zlib1g-dev:i386 95 $ sudo ln -s /usr/lib/i386-linux-gnu/mesa/libGL.so.1 /usr/lib/i386-linux-gnu/libGL.so 96 </code></pre> 97 98 <h3 id="installing-required-packages-ubuntu-1404">Installing required packages (Ubuntu 14.04)</h3> 99 <p>Building on Ubuntu 14.04 is experimental at the moment but will eventually become the recommended 100 environment.</p> 101 <pre><code>$ sudo apt-get install bison g++-multilib git gperf libxml2-utils</code></pre> 102 103 <h3 id="installing-required-packages-ubuntu-1004-1110">Installing required packages (Ubuntu 10.04 -- 11.10)</h3> 104 <p>Building on Ubuntu 10.04-11.10 is no longer supported, but may be useful for building older 105 releases of AOSP.</p> 106 <pre><code>$ sudo apt-get install git-core gnupg flex bison gperf build-essential \ 107 zip curl zlib1g-dev libc6-dev lib32ncurses5-dev ia32-libs \ 108 x11proto-core-dev libx11-dev lib32readline5-dev lib32z-dev \ 109 libgl1-mesa-dev g++-multilib mingw32 tofrodos python-markdown \ 110 libxml2-utils xsltproc 111 </code></pre> 112 <p>On Ubuntu 10.10:</p> 113 <pre><code>$ sudo ln -s /usr/lib32/mesa/libGL.so.1 /usr/lib32/mesa/libGL.so 114 </code></pre> 115 <p>On Ubuntu 11.10:</p> 116 <pre><code>$ sudo apt-get install libx11-dev:i386 117 </code></pre> 118 <h3 id="configuring-usb-access">Configuring USB Access</h3> 119 <p>Under GNU/linux systems (and specifically under Ubuntu systems), 120 regular users can't directly access USB devices by default. The 121 system needs to be configured to allow such access.</p> 122 <p>The recommended approach is to create a file 123 <code>/etc/udev/rules.d/51-android.rules</code> (as the root user) and to copy 124 the following lines in it. <code><username></code> must be replaced by the 125 actual username of the user who is authorized to access the phones 126 over USB.</p> 127 <pre><code># adb protocol on passion (Nexus One) 128 SUBSYSTEM=="usb", ATTR{idVendor}=="18d1", ATTR{idProduct}=="4e12", MODE="0600", OWNER="<username>" 129 # fastboot protocol on passion (Nexus One) 130 SUBSYSTEM=="usb", ATTR{idVendor}=="0bb4", ATTR{idProduct}=="0fff", MODE="0600", OWNER="<username>" 131 # adb protocol on crespo/crespo4g (Nexus S) 132 SUBSYSTEM=="usb", ATTR{idVendor}=="18d1", ATTR{idProduct}=="4e22", MODE="0600", OWNER="<username>" 133 # fastboot protocol on crespo/crespo4g (Nexus S) 134 SUBSYSTEM=="usb", ATTR{idVendor}=="18d1", ATTR{idProduct}=="4e20", MODE="0600", OWNER="<username>" 135 # adb protocol on stingray/wingray (Xoom) 136 SUBSYSTEM=="usb", ATTR{idVendor}=="22b8", ATTR{idProduct}=="70a9", MODE="0600", OWNER="<username>" 137 # fastboot protocol on stingray/wingray (Xoom) 138 SUBSYSTEM=="usb", ATTR{idVendor}=="18d1", ATTR{idProduct}=="708c", MODE="0600", OWNER="<username>" 139 # adb protocol on maguro/toro (Galaxy Nexus) 140 SUBSYSTEM=="usb", ATTR{idVendor}=="04e8", ATTR{idProduct}=="6860", MODE="0600", OWNER="<username>" 141 # fastboot protocol on maguro/toro (Galaxy Nexus) 142 SUBSYSTEM=="usb", ATTR{idVendor}=="18d1", ATTR{idProduct}=="4e30", MODE="0600", OWNER="<username>" 143 # adb protocol on panda (PandaBoard) 144 SUBSYSTEM=="usb", ATTR{idVendor}=="0451", ATTR{idProduct}=="d101", MODE="0600", OWNER="<username>" 145 # adb protocol on panda (PandaBoard ES) 146 SUBSYSTEM=="usb", ATTR{idVendor}=="18d1", ATTR{idProduct}=="d002", MODE="0600", OWNER="<username>" 147 # fastboot protocol on panda (PandaBoard) 148 SUBSYSTEM=="usb", ATTR{idVendor}=="0451", ATTR{idProduct}=="d022", MODE="0600", OWNER="<username>" 149 # usbboot protocol on panda (PandaBoard) 150 SUBSYSTEM=="usb", ATTR{idVendor}=="0451", ATTR{idProduct}=="d00f", MODE="0600", OWNER="<username>" 151 # usbboot protocol on panda (PandaBoard ES) 152 SUBSYSTEM=="usb", ATTR{idVendor}=="0451", ATTR{idProduct}=="d010", MODE="0600", OWNER="<username>" 153 # adb protocol on grouper/tilapia (Nexus 7) 154 SUBSYSTEM=="usb", ATTR{idVendor}=="18d1", ATTR{idProduct}=="4e42", MODE="0600", OWNER="<username>" 155 # fastboot protocol on grouper/tilapia (Nexus 7) 156 SUBSYSTEM=="usb", ATTR{idVendor}=="18d1", ATTR{idProduct}=="4e40", MODE="0600", OWNER="<username>" 157 # adb protocol on manta (Nexus 10) 158 SUBSYSTEM=="usb", ATTR{idVendor}=="18d1", ATTR{idProduct}=="4ee2", MODE="0600", OWNER="<username>" 159 # fastboot protocol on manta (Nexus 10) 160 SUBSYSTEM=="usb", ATTR{idVendor}=="18d1", ATTR{idProduct}=="4ee0", MODE="0600", OWNER="<username>" 161 </code></pre> 162 <p>Those new rules take effect the next time a device is plugged in. 163 It might therefore be necessary to unplug the device and plug it 164 back into the computer.</p> 165 <p>This is known to work on both Ubuntu Hardy Heron (8.04.x LTS) and 166 Lucid Lynx (10.04.x LTS). Other versions of Ubuntu or other 167 variants of GNU/linux might require different configurations.</p> 168 <p><a name="ccache"></a></p> 169 <h3 id="setting-up-ccache">Setting up ccache</h3> 170 <p>You can optionally tell the build to use the ccache compilation tool. 171 Ccache acts as a compiler cache that can be used to speed-up rebuilds. 172 This works very well if you do "make clean" often, or if you frequently 173 switch between different build products.</p> 174 <p>Put the following in your .bashrc or equivalent.</p> 175 <pre><code>export USE_CCACHE=1 176 </code></pre> 177 <p>By default the cache will be stored in ~/.ccache. 178 If your home directory is on NFS or some other non-local filesystem, 179 you will want to specify the directory in your .bashrc as well.</p> 180 <pre><code>export CCACHE_DIR=<path-to-your-cache-directory> 181 </code></pre> 182 <p>The suggested cache size is 50-100GB. 183 You will need to run the following command once you have downloaded 184 the source code:</p> 185 <pre><code>prebuilts/misc/linux-x86/ccache/ccache -M 50G 186 </code></pre> 187 <p>When building Ice Cream Sandwich (4.0.x) or older, ccache is in 188 a different location:</p> 189 <pre><code>prebuilt/linux-x86/ccache/ccache -M 50G 190 </code></pre> 191 <p>This setting is stored in the CCACHE_DIR and is persistent.</p> 192 <h3 id="using-a-separate-output-directory">Using a separate output directory</h3> 193 <p>By default, the output of each build is stored in the out/ 194 subdirectory of the matching source tree.</p> 195 <p>On some machines with multiple storage devices, builds are 196 faster when storing the source files and the output on 197 separate volumes. For additional performance, the output 198 can be stored on a filesystem optimized for speed instead 199 of crash robustness, since all files can be re-generated 200 in case of filesystem corruption.</p> 201 <p>To set this up, export the <code>OUT_DIR_COMMON_BASE</code> variable 202 to point to the location where your output directories 203 will be stored.</p> 204 <pre><code>export OUT_DIR_COMMON_BASE=<path-to-your-out-directory> 205 </code></pre> 206 <p>The output directory for each separate source tree will be 207 named after the directory holding the source tree.</p> 208 <p>For instance, if you have source trees as <code>/source/master1</code> 209 and <code>/source/master2</code> and <code>OUT_DIR_COMMON_BASE</code> is set to 210 <code>/output</code>, the output directories will be <code>/output/master1</code> 211 and <code>/output/master2</code>.</p> 212 <p>It's important in that case to not have multiple source 213 trees stored in directories that have the same name, 214 as those would end up sharing an output directory, with 215 unpredictable results.</p> 216 <p>This is only supported on Jelly Bean (4.1) and newer, 217 including the master branch.</p> 218 <h2 id="setting-up-a-mac-os-x-build-environment">Setting up a Mac OS X build environment</h2> 219 <p>In a default installation, OS X runs on a case-preserving but case-insensitive 220 filesystem. This type of filesystem is not supported by git and will cause some 221 git commands (such as "git status") to behave abnormally. Because of this, we 222 recommend that you always work with the AOSP source files on a case-sensitive 223 filesystem. This can be done fairly easily using a disk image, discussed below.</p> 224 <p>Once the proper filesystem is available, building the master branch in a modern 225 OS X environment is very straightforward. Earlier branches, including ICS, 226 require some additional tools and SDKs.</p> 227 <h3 id="creating-a-case-sensitive-disk-image">Creating a case-sensitive disk image</h3> 228 <p>You can create a case-sensitive filesystem within your existing OS X environment 229 using a disk image. To create the image, launch Disk 230 Utility and select "New Image". A size of 25GB is the minimum to 231 complete the build, larger numbers are more future-proof. Using sparse images 232 saves space while allowing to grow later as the need arises. Be sure to select 233 "case sensitive, journaled" as the volume format.</p> 234 <p>You can also create it from a shell with the following command:</p> 235 <pre><code># hdiutil create -type SPARSE -fs 'Case-sensitive Journaled HFS+' -size 40g ~/android.dmg 236 </code></pre> 237 <p>This will create a .dmg (or possibly a .dmg.sparsefile) file which, once mounted, acts as a drive with the required formatting for Android development. For a disk image named "android.dmg" stored in your home directory, you can add the following to your <code>~/.bash_profile</code> to mount the image when you execute "mountAndroid":</p> 238 <pre><code># mount the android file image 239 function mountAndroid { hdiutil attach ~/android.dmg -mountpoint /Volumes/android; } 240 </code></pre> 241 <p>Once mounted, you'll do all your work in the "android" volume. You can eject it (unmount it) just like you would with an external drive.</p> 242 <h3 id="master-branch">Master branch</h3> 243 <p>To build the latest source in a Mac OS environment, you will need an Intel/x86 244 machine running MacOS 10.8 (Mountain Lion), along with Xcode 245 4.5.2 and Command Line Tools.</p> 246 <p>You will also need the <a 247 href="http://www.oracle.com/technetwork/java/javase/downloads/jdk7-downloads-1880260.html">Java 7 JDK</a>. 248 Select the file: jdk-7u51-macosx-x64.dmg</p> 249 250 <p>To develop for versions of Android Gingerbread through KitKat, download and 251 install the Java 6 version of the <a 252 href="http://support.apple.com/kb/dl1572">Java JDK</a>.</p> 253 254 <h3 id="branch-40x-and-all-earlier-branches">Branch 4.2.x and earlier branches</h3> 255 <p>To build 4.2.x and earlier source in a Mac OS environment, you will need an Intel/x86 256 machine running MacOS 10.6 (Snow Leopard) or MacOS 10.7 (Lion), along with Xcode 257 4.2 (Apple's Developer Tools). Although Lion does not come with a JDK, it should 258 install automatically when you attempt to build the source.</p> 259 <p>The remaining sections for Mac OS X only apply to those who wish to build 260 earlier branches.</p> 261 <h3 id="branch-40x-and-all-earlier-branches">Branch 4.0.x and all earlier branches</h3> 262 <p>To build android-4.0.x and earlier branches in a Mac OS environment, you need an 263 Intel/x86 machine running MacOS 10.5 (Leopard) or MacOS 10.6 (Snow Leopard). You 264 will need the MacOS 10.5 SDK.</p> 265 <h4 id="installing-required-packages">Installing required packages</h4> 266 <ul> 267 <li> 268 <p>Install Xcode from <a href="http://developer.apple.com/">the Apple developer site</a>. 269 We recommend version 3.1.4 or newer, i.e. gcc 4.2. 270 Version 4.x could cause difficulties. 271 If you are not already registered as an Apple developer, you will have to 272 create an Apple ID in order to download.</p> 273 </li> 274 <li> 275 <p>Install MacPorts from <a href="http://www.macports.org/install.php">macports.org</a>.</p> 276 <p><em>Note: Make sure that <code>/opt/local/bin</code> appears in your path BEFORE <code>/usr/bin</code>. If not, add</em> </p> 277 <pre><code>export PATH=/opt/local/bin:$PATH 278 </code></pre> 279 <p><em>to your <code>~/.bash_profile</code>.</em></p> 280 </li> 281 <li> 282 <p>Get make, git, and GPG packages from MacPorts: </p> 283 <pre><code>$ POSIXLY_CORRECT=1 sudo port install gmake libsdl git-core gnupg 284 </code></pre> 285 <p>If using Mac OS 10.4, also install bison:</p> 286 <pre><code>$ POSIXLY_CORRECT=1 sudo port install bison 287 </code></pre> 288 </li> 289 </ul> 290 <h4 id="reverting-from-make-382">Reverting from make 3.82</h4> 291 <p>For versions of Android before ICS, there is a bug in gmake 3.82 that prevents android from building. You can install version 3.81 using MacPorts by taking the following steps:</p> 292 <ul> 293 <li> 294 <p>Edit <code>/opt/local/etc/macports/sources.conf</code> and add a line that says</p> 295 <pre><code>file:///Users/Shared/dports 296 </code></pre> 297 <p>above the rsync line. Then create this directory: </p> 298 <pre><code>$ mkdir /Users/Shared/dports 299 </code></pre> 300 </li> 301 <li> 302 <p>In the new <code>dports</code> directory, run </p> 303 <pre><code>$ svn co --revision 50980 http://svn.macports.org/repository/macports/trunk/dports/devel/gmake/ devel/gmake/ 304 </code></pre> 305 </li> 306 <li> 307 <p>Create a port index for your new local repository: </p> 308 <pre><code>$ portindex /Users/Shared/dports 309 </code></pre> 310 </li> 311 <li> 312 <p>Finally, install the old version of gmake with </p> 313 <pre><code>$ sudo port install gmake @3.81 314 </code></pre> 315 </li> 316 </ul> 317 <h4 id="setting-a-file-descriptor-limit">Setting a file descriptor limit</h4> 318 <p>On MacOS the default limit on the number of simultaneous file descriptors open is too low and a highly parallel build process may exceed this limit.<br /> 319 </p> 320 <p>To increase the cap, add the following lines to your <code>~/.bash_profile</code>: </p> 321 <pre><code># set the number of open files to be 1024 322 ulimit -S -n 1024 323 </code></pre> 324 <h2 id="next-download-the-source">Next: Download the source</h2> 325 <p>Your build environment is good to go! Proceed to <a href="downloading.html">downloading the source</a>.</p> 326
