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