1 page.title=Establishing a Build Environment 2 @jd:body 3 4 <!-- 5 Copyright 2015 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>For an overview of the entire code-review and code-update process, see <a 31 href="life-of-a-patch.html">Life of a Patch</a>.</p> 32 <h2 id="choosing-a-branch">Choosing a Branch</h2> 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 <code>master</code>), 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 <h2 id="setting-up-a-linux-build-environment">Setting up a Linux build environment</h2> 42 <p>These instructions apply to all branches, including <code>master</code>.</p> 43 <p>The Android build is routinely tested in house on recent versions of 44 Ubuntu LTS (14.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 <code>master</code> 48 branch, a 64-bit environment is required. Older versions can be 49 compiled on 32-bit systems.</p> 50 <p class="note"><strong>Note:</strong> See the <a 51 href="requirements.html">Requirements</a> for the complete list of hardware and 52 software requirements. Then follow the detailed instructions for Ubuntu and Mac 53 OS below.</p> 54 55 <h3 id="installing-the-jdk">Installing the JDK</h3> 56 <p>The <code>master</code> branch of Android in the <a 57 href="https://android.googlesource.com/">Android Open Source Project (AOSP)</a> 58 requires Java 8. On Ubuntu, use <a href="http://openjdk.java.net/install/">OpenJDK</a>.</p> 59 <p>Java 8: For the latest version of Android</p> 60 61 <h4 id="for-ubuntu-15-04">For Ubuntu >= 15.04</h4> 62 <p>Run the following:</p> 63 <pre><code>$ sudo apt-get update 64 $ sudo apt-get install openjdk-8-jdk 65 </code></pre> 66 67 <h4 id="for-ubuntu-14-04">For Ubuntu LTS 14.04</h4> 68 <p>There are no available supported OpenJDK 8 packages for Ubuntu 14.04. The 69 <strong>Ubuntu 15.04 OpenJDK 8</strong> packages have been used successfully 70 with Ubuntu 14.04. <em>Newer package versions (e.g. those for 15.10, 16.04) were 71 found not to work on 14.04 using the instructions below.</em></p> 72 <ol> 73 <li> 74 <p>Download the <code>.deb</code> packages for your architecture from 75 <a 76 href="http://packages.ubuntu.com/vivid/openjdk-8-jdk">http://packages.ubuntu.com/vivid/openjdk-8-jdk</a>:</p> 77 <ul> 78 <li><a href="http://packages.ubuntu.com/vivid/openjdk-8-jre-headless">openjdk-8-jre-headless</a></li> 79 <li><a href="http://packages.ubuntu.com/vivid/openjdk-8-jre">openjdk-8-jre</a></li> 80 <li><a href="http://packages.ubuntu.com/vivid/openjdk-8-jdk">openjdk-8-jdk</a></li> 81 </ul> 82 <p>Remember, you may obtain the architecture for your machine with:</p> 83 <code>$ uname -m</code> 84 <p>With <code>x86_64</code> representing a 64-bit (amd64) Linux kernel architecture and 85 <code>i386/i486/i586/i686</code> representing a 32-bit (i386) system.</p> 86 </li> 87 <li> 88 <p>Optionally, confirm the checksums of the downloaded files using the information 89 found on <a href="http://packages.ubuntu.com/vivid/openjdk-8-jdk" 90 >http://packages.ubuntu.com/vivid/openjdk-8-jdk</a>.</p> 91 <p>For example with the sha256sum tool:</p> 92 <pre><code>$ sha256sum {package file}</code></pre> 93 </li> 94 <li> 95 <p>Install the packages:</p> 96 <pre><code>$ sudo apt-get update</pre></code> 97 <p>Run dpkg for each of the .deb files you downloaded. It may produce errors due to 98 missing dependencies:</p> 99 <pre><code>$ sudo dpkg -i {downloaded.deb file}</pre></code> 100 <p>To fix missing dependencies:</p> 101 <pre><code>$ sudo apt-get -f install</pre></code> 102 </li> 103 </ol> 104 105 <h4 id="default-java-version">Update the default Java version - optional</h4> 106 <p>Optionally, for the Ubuntu versions above update the default Java version by 107 running:</p> 108 <pre><code>$ sudo update-alternatives --config java 109 $ sudo update-alternatives --config javac 110 </code></pre> 111 112 <p>If, during a build, you encounter version errors for Java, set its 113 path as described in the <a href="building.html#wrong-java-version">Wrong 114 Java Version</a> section.</p> 115 116 <p>To develop older versions of Android, download and install the corresponding version of the <a 117 href="http://www.oracle.com/technetwork/java/javase/archive-139210.html">Java JDK</a>:<br/> 118 Java 7: for Lollipop through Marshmallow<br/> 119 Java 6: for Gingerbread through KitKat<br/> 120 Java 5: for Cupcake through Froyo</p> 121 122 <h3 id="installing-required-packages-ubuntu-1404">Installing required packages (Ubuntu 14.04)</h3> 123 <p>You will need a 64-bit version of Ubuntu. Ubuntu 14.04 is recommended.</p> 124 <pre><code>$ sudo apt-get install git-core gnupg flex bison gperf build-essential \ 125 zip curl zlib1g-dev gcc-multilib g++-multilib libc6-dev-i386 \ 126 lib32ncurses5-dev x11proto-core-dev libx11-dev lib32z-dev ccache \ 127 libgl1-mesa-dev libxml2-utils xsltproc unzip 128 </code></pre> 129 130 <p class="note"><strong>Note:</strong> To use SELinux tools for policy 131 analysis, also install the <code>python-networkx</code> package.</p> 132 133 <h3 id="installing-required-packages-ubuntu-1204">Installing required packages (Ubuntu 12.04)</h3> 134 <p>You may use Ubuntu 12.04 to build older versions of Android. Version 12.04 is not supported on master or recent releases.</p> 135 <pre><code>$ sudo apt-get install git gnupg flex bison gperf build-essential \ 136 zip curl libc6-dev libncurses5-dev:i386 x11proto-core-dev \ 137 libx11-dev:i386 libreadline6-dev:i386 libgl1-mesa-glx:i386 \ 138 libgl1-mesa-dev g++-multilib mingw32 tofrodos \ 139 python-markdown libxml2-utils xsltproc zlib1g-dev:i386 140 $ sudo ln -s /usr/lib/i386-linux-gnu/mesa/libGL.so.1 /usr/lib/i386-linux-gnu/libGL.so 141 </code></pre> 142 143 <h3 id="installing-required-packages-ubuntu-1004-1110">Installing required packages (Ubuntu 10.04 -- 11.10)</h3> 144 <p>Building on Ubuntu 10.04-11.10 is no longer supported, but may be useful for building older 145 releases of AOSP.</p> 146 <pre><code>$ sudo apt-get install git gnupg flex bison gperf build-essential \ 147 zip curl zlib1g-dev libc6-dev lib32ncurses5-dev ia32-libs \ 148 x11proto-core-dev libx11-dev lib32readline5-dev lib32z-dev \ 149 libgl1-mesa-dev g++-multilib mingw32 tofrodos python-markdown \ 150 libxml2-utils xsltproc 151 </code></pre> 152 <p>On Ubuntu 10.10:</p> 153 <pre><code>$ sudo ln -s /usr/lib32/mesa/libGL.so.1 /usr/lib32/mesa/libGL.so 154 </code></pre> 155 <p>On Ubuntu 11.10:</p> 156 <pre><code>$ sudo apt-get install libx11-dev:i386 157 </code></pre> 158 <h3 id="configuring-usb-access">Configuring USB Access</h3> 159 <p>Under GNU/Linux systems (and specifically under Ubuntu systems), 160 regular users can't directly access USB devices by default. The 161 system needs to be configured to allow such access.</p> 162 <p>The recommended approach is to create a file at 163 <code>/etc/udev/rules.d/51-android.rules</code> (as the root user).</p> 164 165 <p>To do this, run the following command to download the <a href="51-android.rules">51-android.rules</a> file attached to this site, modify it to include your username, and place it in the correct location:</p> 166 167 <pre> 168 <code>$ wget -S -O - http://source.android.com/source/51-android.rules | sed "s/<username>/$USER/" | sudo tee >/dev/null /etc/udev/rules.d/51-android.rules; sudo udevadm control --reload-rules</code> 169 </pre> 170 171 <p>Those new rules take effect the next time a device is plugged in. 172 It might therefore be necessary to unplug the device and plug it 173 back into the computer.</p> 174 <p>This is known to work on both Ubuntu Hardy Heron (8.04.x LTS) and 175 Lucid Lynx (10.04.x LTS). Other versions of Ubuntu or other 176 variants of GNU/Linux might require different configurations.</p> 177 <h3 id="using-a-separate-output-directory">Using a separate output directory</h3> 178 <p>By default, the output of each build is stored in the <code>out/</code> 179 subdirectory of the matching source tree.</p> 180 <p>On some machines with multiple storage devices, builds are 181 faster when storing the source files and the output on 182 separate volumes. For additional performance, the output 183 can be stored on a filesystem optimized for speed instead 184 of crash robustness, since all files can be re-generated 185 in case of filesystem corruption.</p> 186 <p>To set this up, export the <code>OUT_DIR_COMMON_BASE</code> variable 187 to point to the location where your output directories 188 will be stored.</p> 189 <pre><code>export OUT_DIR_COMMON_BASE=<path-to-your-out-directory> 190 </code></pre> 191 <p>The output directory for each separate source tree will be 192 named after the directory holding the source tree.</p> 193 <p>For instance, if you have source trees as <code>/source/master1</code> 194 and <code>/source/master2</code> and <code>OUT_DIR_COMMON_BASE</code> is set to 195 <code>/output</code>, the output directories will be <code>/output/master1</code> 196 and <code>/output/master2</code>.</p> 197 <p>It's important in that case to not have multiple source 198 trees stored in directories that have the same name, 199 as those would end up sharing an output directory, with 200 unpredictable results.</p> 201 <p>This is only supported on Jelly Bean (4.1) and newer, 202 including the <code>master</code> branch.</p> 203 <h2 id="setting-up-a-mac-os-x-build-environment">Setting up a Mac OS build environment</h2> 204 <p>In a default installation, Mac OS runs on a case-preserving but case-insensitive 205 filesystem. This type of filesystem is not supported by git and will cause some 206 git commands (such as <code>git status</code>) to behave abnormally. Because of this, we 207 recommend that you always work with the AOSP source files on a case-sensitive 208 filesystem. This can be done fairly easily using a disk image, discussed below.</p> 209 <p>Once the proper filesystem is available, building the <code>master</code> branch in a modern 210 Mac OS environment is very straightforward. Earlier branches, including ICS, 211 require some additional tools and SDKs.</p> 212 <h3 id="creating-a-case-sensitive-disk-image">Creating a case-sensitive disk image</h3> 213 <p>You can create a case-sensitive filesystem within your existing Mac OS environment 214 using a disk image. To create the image, launch Disk 215 Utility and select "New Image". A size of 25GB is the minimum to 216 complete the build; larger numbers are more future-proof. Using sparse images 217 saves space while allowing to grow later as the need arises. Be sure to select 218 "case sensitive, journaled" as the volume format.</p> 219 <p>You can also create it from a shell with the following command:</p> 220 <pre><code># hdiutil create -type SPARSE -fs 'Case-sensitive Journaled HFS+' -size 40g ~/android.dmg 221 </code></pre> 222 <p>This will create a <code>.dmg</code> (or possibly a <code>.dmg.sparseimage</code>) file which, once mounted, acts as a drive with the required formatting for Android development. 223 <p>If you need a larger volume later, you can also resize the sparse image with the following command:</p> 224 <pre><code># hdiutil resize -size <new-size-you-want>g ~/android.dmg.sparseimage 225 </code></pre> 226 For a disk image named <code>android.dmg</code> stored in your home directory, you can add helper functions to your <code>~/.bash_profile</code>: 227 <ul> 228 <li> 229 To mount the image when you execute <code>mountAndroid</code>:</p> 230 <pre><code># mount the android file image 231 function mountAndroid { hdiutil attach ~/android.dmg -mountpoint /Volumes/android; } 232 </code></pre> 233 <p class="note"><strong>Note:</strong> If your system created a <code>.dmg.sparseimage</code> file, replace <code>~/android.dmg</code> with <code>~/android.dmg.sparseimage</code>.</p> 234 </li> 235 <li> 236 <p>To unmount it when you execute <code>umountAndroid</code>:</p> 237 <pre><code># unmount the android file image 238 function umountAndroid() { hdiutil detach /Volumes/android; } 239 </code></pre> 240 </li> 241 </ul> 242 <p>Once you've mounted the <code>android</code> volume, you'll do all your work there. You can eject it (unmount it) just like you would with an external drive.</p> 243 244 <h3 id="installing-the-mac-jdk">Installing the JDK</h3> 245 <p>The <code>master</code> branch of Android in the <a 246 href="https://android.googlesource.com/">Android Open Source Project (AOSP)</a> 247 requires Java 8. On Mac OS, use <a 248 href="http://www.oracle.com/technetwork/java/javase/downloads/java-archive-javase8-2177648.html#jdk-8u45-oth-JPR">jdk 8u45 or newer</a>.</p> 249 250 <p>The <code>5.0.x</code> branches of Android in the <a 251 href="https://android.googlesource.com/">Android Open Source Project (AOSP)</a> 252 require Java 7. On Mac OS, use <a 253 href="https://www.oracle.com/technetwork/java/javase/downloads/java-archive-downloads-javase7-521261.html#jdk-7u71-oth-JPR">jdk-7u71-macosx-x64.dmg</a>.</p> 254 255 <p>To develop for versions of Android Gingerbread through KitKat, download and 256 install the Java 6 version of the <a 257 href="http://support.apple.com/kb/dl1572">Java JDK</a>.</p> 258 259 <h3 id="master-branch">Master branch</h3> 260 <p>To build the latest source in a Mac OS environment, you will need an Intel/x86 261 machine running Mac OS X v10.10 (Yosemite) or later, along with Xcode 262 4.5.2 or later including the Command Line Tools.</p> 263 264 <h3 id="branch-60x">Branch 6.0.x</h3> 265 <p>To build 6.0.x and earlier source in a Mac OS environment, you will need an Intel/x86 266 machine running Mac OS X v10.10 (Yosemite), along with Xcode 267 4.5.2 and Command Line Tools.</p> 268 269 <h3 id="branch-50x">Branch 5.0.x</h3> 270 <p>To build 5.0.x and earlier source in a Mac OS environment, you will need an Intel/x86 271 machine running Mac OS X v10.8 (Mountain Lion), along with Xcode 272 4.5.2 and Command Line Tools.</p> 273 274 <h3 id="branch-44x">Branch 4.4.x</h3> 275 <p>To build 4.2.x and earlier source in a Mac OS environment, you will need an Intel/x86 276 machine running Mac OS X v10.6 (Snow Leopard) or Mac OS X v10.7 (Lion), along with Xcode 277 4.2 (Apple's Developer Tools). Although Lion does not come with a JDK, it should 278 install automatically when you attempt to build the source.</p> 279 <p>The remaining sections for Mac OS apply only to those who wish to build 280 earlier branches.</p> 281 282 <h3 id="branch-40x">Branch 4.0.x and all earlier branches</h3> 283 <p>To build android-4.0.x and earlier branches in a Mac OS environment, you need an 284 Intel/x86 machine running Mac OS X v10.5 (Leopard) or Mac OS X v10.6 (Snow Leopard). You 285 will need the Mac OS X v10.5 SDK.</p> 286 <h4 id="installing-required-packages">Installing required packages</h4> 287 <ul> 288 <li> 289 <p>Install Xcode from <a href="http://developer.apple.com/">the Apple developer site</a>. 290 We recommend version 3.1.4 or newer (e.g., gcc 4.2). 291 Version 4.x could cause difficulties. 292 If you are not already registered as an Apple developer, you will have to 293 create an Apple ID in order to download.</p> 294 </li> 295 <li> 296 <p>Install MacPorts from <a href="http://www.macports.org/install.php">macports.org</a>.</p> 297 <p class="note"><strong>Note:</strong> Make sure that <code>/opt/local/bin</code> appears in your path <strong>before</strong> <code>/usr/bin</code>. If not, please add the following to your <code>~/.bash_profile</code> file:</p> 298 <pre> 299 <code>export PATH=/opt/local/bin:$PATH</code> 300 </pre> 301 <p class="note"><strong>Note:</strong> If you do not have a <code>.bash_profile</code> file in your home directory, create one.</p> 302 </li> 303 <li> 304 <p>Get make, git, and GPG packages from MacPorts: </p> 305 <pre><code>$ POSIXLY_CORRECT=1 sudo port install gmake libsdl git gnupg 306 </code></pre> 307 <p>If using Mac OS X v10.4, also install bison:</p> 308 <pre><code>$ POSIXLY_CORRECT=1 sudo port install bison 309 </code></pre> 310 </li> 311 </ul> 312 <h4 id="reverting-from-make-382">Reverting from make 3.82</h4> 313 <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> 314 <ul> 315 <li> 316 <p>Edit <code>/opt/local/etc/macports/sources.conf</code> and add a line that says</p> 317 <pre><code>file:///Users/Shared/dports 318 </code></pre> 319 <p>above the rsync line. Then create this directory: </p> 320 <pre><code>$ mkdir /Users/Shared/dports 321 </code></pre> 322 </li> 323 <li> 324 <p>In the new <code>dports</code> directory, run </p> 325 <pre><code>$ svn co --revision 50980 http://svn.macports.org/repository/macports/trunk/dports/devel/gmake/ devel/gmake/ 326 </code></pre> 327 </li> 328 <li> 329 <p>Create a port index for your new local repository: </p> 330 <pre><code>$ portindex /Users/Shared/dports 331 </code></pre> 332 </li> 333 <li> 334 <p>Finally, install the old version of gmake with </p> 335 <pre><code>$ sudo port install gmake @3.81 336 </code></pre> 337 </li> 338 </ul> 339 <h4 id="setting-a-file-descriptor-limit">Setting a file descriptor limit</h4> 340 <p>On Mac OS, 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 /> 341 </p> 342 <p>To increase the cap, add the following lines to your <code>~/.bash_profile</code>: </p> 343 <pre><code># set the number of open files to be 1024 344 ulimit -S -n 1024 345 </code></pre> 346 <h2 id="optimizing-a-build-environment">Optimizing a build environment (optional)</h2> 347 <p><a name="ccache"></a></p> 348 <h3 id="setting-up-ccache">Setting up ccache</h3> 349 <p>You can optionally tell the build to use the ccache compilation tool. 350 Ccache acts as a compiler cache that can be used to speed up rebuilds. 351 This works very well if you use <code>make clean</code> often, or if you frequently 352 switch between different build products.</p> 353 <p>Put the following in your <code>.bashrc</code> (or equivalent):</p> 354 <pre><code>export USE_CCACHE=1 355 </code></pre> 356 <p>By default the cache will be stored in <code>~/.ccache</code>. 357 If your home directory is on NFS or some other non-local filesystem, 358 you will want to specify the directory in your <code>.bashrc</code> file as well:</p> 359 <pre><code>export CCACHE_DIR=<path-to-your-cache-directory> 360 </code></pre> 361 <p>The suggested cache size is 50-100GB. 362 You will need to run the following command once you have downloaded 363 the source code:</p> 364 <pre><code>prebuilts/misc/linux-x86/ccache/ccache -M 50G 365 </code></pre> 366 <p>On Mac OS, you should replace <code>linux-x86</code> with <code>darwin-x86</code>:</p> 367 <pre><code>prebuilts/misc/darwin-x86/ccache/ccache -M 50G 368 </code></pre> 369 <p>When building Ice Cream Sandwich (4.0.x) or older, ccache is in 370 a different location:</p> 371 <pre><code>prebuilt/linux-x86/ccache/ccache -M 50G 372 </code></pre> 373 <p>This setting is stored in the CCACHE_DIR and is persistent.</p> 374 <h2 id="next-download-the-source">Next: Download the source</h2> 375 <p>Your build environment is good to go! Proceed to <a href="downloading.html">downloading the source</a>.</p> 376
