3 # Copyright (c) 2012 The Chromium Authors. All rights reserved.
4 # Use of this source code is governed by a BSD-style license that can be
5 # found in the LICENSE file.
7 # Script to install everything needed to build chromium (well, ideally, anyway)
8 # See http://code.google.com/p/chromium/wiki/LinuxBuildInstructions
9 # and http://code.google.com/p/chromium/wiki/LinuxBuild64Bit
12 echo "Usage: $0 [--options]"
14 echo "--[no-]syms: enable or disable installation of debugging symbols"
15 echo "--[no-]lib32: enable or disable installation of 32 bit libraries"
16 echo "--[no-]arm: enable or disable installation of arm cross toolchain"
17 echo "--[no-]chromeos-fonts: enable or disable installation of Chrome OS"\
19 echo "--[no-]nacl: enable or disable installation of prerequisites for"\
20 "building standalone NaCl and all its toolchains"
21 echo "--no-prompt: silently select standard options/defaults"
22 echo "--quick-check: quickly try to determine if dependencies are installed"
23 echo " (this avoids interactive prompts and sudo commands,"
24 echo " so might not be 100% accurate)"
25 echo "--unsupported: attempt installation even on unsupported systems"
26 echo "Script will prompt interactively if options not given."
30 # Checks whether a particular package is available in the repos.
31 # USAGE: $ package_exists <package name>
33 apt-cache pkgnames |
grep -x "$1" > /dev
/null
2>&1
36 # These default to on because (some) bots need them and it keeps things
37 # simple for the bot setup if all bots just run the script in its default
38 # mode. Developers who don't want stuff they don't need installed on their
39 # own workstations can pass --no-arm --no-nacl when running the script.
46 --syms) do_inst_syms
=1;;
47 --no-syms) do_inst_syms
=0;;
48 --lib32) do_inst_lib32
=1;;
49 --no-lib32) do_inst_lib32
=0;;
50 --arm) do_inst_arm
=1;;
51 --no-arm) do_inst_arm
=0;;
52 --chromeos-fonts) do_inst_chromeos_fonts
=1;;
53 --no-chromeos-fonts) do_inst_chromeos_fonts
=0;;
54 --nacl) do_inst_nacl
=1;;
55 --no-nacl) do_inst_nacl
=0;;
56 --no-prompt) do_default
=1
57 do_quietly
="-qq --assume-yes"
59 --quick-check) do_quick_check
=1;;
60 --unsupported) do_unsupported
=1;;
66 ubuntu_versions
="12\.04|12\.10|13\.04|13\.10"
67 ubuntu_codenames
="precise|quantal|raring|saucy"
68 ubuntu_issue
="Ubuntu ($ubuntu_versions|$ubuntu_codenames)"
69 # GCEL is an Ubuntu-derived VM image used on Google Compute Engine; /etc/issue
70 # doesn't contain a version number so just trust that the user knows what
74 if [ 0 -eq "${do_unsupported-0}" ] && [ 0 -eq "${do_quick_check-0}" ] ; then
75 if ! egrep -q "($ubuntu_issue|$gcel_issue)" /etc
/issue
; then
76 echo "ERROR: Only Ubuntu 12.04 (precise) through 13.10 (saucy) are"\
77 "currently supported" >&2
81 if ! uname
-m |
egrep -q "i686|x86_64"; then
82 echo "Only x86 architectures are currently supported" >&2
87 if [ "x$(id -u)" != x0
] && [ 0 -eq "${do_quick_check-0}" ]; then
88 echo "Running as non-root user."
89 echo "You might have to enter your password one or more times for 'sudo'."
93 # Packages needed for chromeos only
94 chromeos_dev_list
="libbluetooth-dev"
96 # Packages needed for development
97 dev_list
="apache2.2-bin bison curl dpkg-dev elfutils fakeroot flex g++ git-core
98 gperf language-pack-da language-pack-fr language-pack-he
99 language-pack-zh-hant libapache2-mod-php5 libasound2-dev libbrlapi-dev
100 libbz2-dev libcairo2-dev libcap-dev libcups2-dev libcurl4-gnutls-dev
101 libdrm-dev libelf-dev libgconf2-dev libgl1-mesa-dev libglib2.0-dev
102 libglu1-mesa-dev libgnome-keyring-dev libgtk2.0-dev libkrb5-dev
103 libnspr4-dev libnss3-dev libpam0g-dev libpci-dev libpulse-dev
104 libsctp-dev libspeechd-dev libsqlite3-dev libssl-dev libudev-dev
105 libwww-perl libxslt1-dev libxss-dev libxt-dev libxtst-dev
106 mesa-common-dev openbox patch perl php5-cgi pkg-config python
107 python-cherrypy3 python-dev python-psutil rpm ruby subversion
108 ttf-dejavu-core ttf-indic-fonts ttf-kochi-gothic ttf-kochi-mincho
109 wdiff xfonts-mathml $chromeos_dev_list"
111 # 64-bit systems need a minimum set of 32-bit compat packages for the pre-built
112 # NaCl binaries. These are always needed, regardless of whether or not we want
113 # the full 32-bit "cross-compile" support (--lib32).
114 if file /sbin
/init |
grep -q 'ELF 64-bit'; then
115 dev_list
="${dev_list} libc6-i386 lib32gcc1 lib32stdc++6"
118 # Run-time libraries required by chromeos only
119 chromeos_lib_list
="libpulse0 libbz2-1.0"
121 # Full list of required run-time libraries
122 lib_list
="libatk1.0-0 libc6 libasound2 libcairo2 libcap2 libcups2 libexpat1
123 libfontconfig1 libfreetype6 libglib2.0-0 libgnome-keyring0
124 libgtk2.0-0 libpam0g libpango1.0-0 libpci3 libpcre3 libpixman-1-0
125 libpng12-0 libspeechd2 libstdc++6 libsqlite3-0 libx11-6
126 libxau6 libxcb1 libxcomposite1 libxcursor1 libxdamage1 libxdmcp6
127 libxext6 libxfixes3 libxi6 libxinerama1 libxrandr2 libxrender1
128 libxtst6 zlib1g $chromeos_lib_list"
130 # Debugging symbols for all of the run-time libraries
131 dbg_list
="libatk1.0-dbg libc6-dbg libcairo2-dbg libfontconfig1-dbg
132 libglib2.0-0-dbg libgtk2.0-0-dbg libpango1.0-0-dbg libpcre3-dbg
133 libpixman-1-0-dbg libsqlite3-0-dbg libx11-6-dbg libxau6-dbg
134 libxcb1-dbg libxcomposite1-dbg libxcursor1-dbg libxdamage1-dbg
135 libxdmcp6-dbg libxext6-dbg libxfixes3-dbg libxi6-dbg libxinerama1-dbg
136 libxrandr2-dbg libxrender1-dbg libxtst6-dbg zlib1g-dbg
139 # arm cross toolchain packages needed to build chrome on armhf
140 arm_list
="libc6-armhf-cross libc6-dev-armhf-cross libgcc1-armhf-cross
141 libgomp1-armhf-cross linux-libc-dev-armhf-cross
142 libgcc1-dbg-armhf-cross libgomp1-dbg-armhf-cross
143 binutils-arm-linux-gnueabihf cpp-arm-linux-gnueabihf
144 gcc-arm-linux-gnueabihf g++-arm-linux-gnueabihf
145 libmudflap0-dbg-armhf-cross"
147 # Old armel cross toolchain packages
148 armel_list
="libc6-armel-cross libc6-dev-armel-cross libgcc1-armel-cross
149 libgomp1-armel-cross linux-libc-dev-armel-cross
150 libgcc1-dbg-armel-cross libgomp1-dbg-armel-cross
151 binutils-arm-linux-gnueabi cpp-arm-linux-gnueabi
152 gcc-arm-linux-gnueabi g++-arm-linux-gnueabi
153 libmudflap0-dbg-armel-cross"
155 # TODO(sbc): remove armel once the armhf transition is complete
156 arm_list
="$arm_list $armel_list"
158 # Packages to build standalone NaCl and all its toolchains.
159 nacl_list
="g++-mingw-w64-i686 libtinfo-dev:i386"
161 # Some package names have changed over time
162 if package_exists ttf-mscorefonts-installer
; then
163 dev_list
="${dev_list} ttf-mscorefonts-installer"
165 dev_list
="${dev_list} msttcorefonts"
167 if package_exists libnspr4-dbg
; then
168 dbg_list
="${dbg_list} libnspr4-dbg libnss3-dbg"
169 lib_list
="${lib_list} libnspr4 libnss3"
171 dbg_list
="${dbg_list} libnspr4-0d-dbg libnss3-1d-dbg"
172 lib_list
="${lib_list} libnspr4-0d libnss3-1d"
174 if package_exists libjpeg-dev
; then
175 dev_list
="${dev_list} libjpeg-dev"
177 dev_list
="${dev_list} libjpeg62-dev"
179 if package_exists libudev1
; then
180 dev_list
="${dev_list} libudev1"
182 dev_list
="${dev_list} libudev0"
184 if package_exists libbrlapi0.6
; then
185 dev_list
="${dev_list} libbrlapi0.6"
187 dev_list
="${dev_list} libbrlapi0.5"
191 # Some packages are only needed if the distribution actually supports
193 if package_exists appmenu-gtk
; then
194 lib_list
="$lib_list appmenu-gtk"
197 # Waits for the user to press 'Y' or 'N'. Either uppercase of lowercase is
198 # accepted. Returns 0 for 'Y' and 1 for 'N'. If an optional parameter has
199 # been provided to yes_no(), the function also accepts RETURN as a user input.
200 # The parameter specifies the exit code that should be returned in that case.
201 # The function will echo the user's selection followed by a newline character.
202 # Users can abort the function by pressing CTRL-C. This will call "exit 1".
204 if [ 0 -ne "${do_default-0}" ] ; then
205 [ $1 -eq 0 ] && echo "Y" ||
echo "N"
210 c
="$(trap 'stty echo -iuclc icanon 2>/dev/null' EXIT INT TERM QUIT
211 stty -echo iuclc -icanon 2>/dev/null
212 dd count=1 bs=1 2>/dev/null | od -An -tx1)"
214 " 0a") if [ -n "$1" ]; then
215 [ $1 -eq 0 ] && echo "Y" ||
echo "N"
225 "") echo "Aborted" >&2
228 *) # The user pressed an unrecognized key. As we are not echoing
229 # any incorrect user input, alert the user by ringing the bell.
230 (tput bel
) 2>/dev
/null
236 if test "$do_inst_syms" = "" && test 0 -eq ${do_quick_check-0}
238 echo "This script installs all tools and libraries needed to build Chromium."
240 echo "For most of the libraries, it can also install debugging symbols, which"
241 echo "will allow you to debug code in the system libraries. Most developers"
242 echo "won't need these symbols."
243 echo -n "Do you want me to install them for you (y/N) "
248 if test "$do_inst_syms" = "1"; then
249 echo "Including debugging symbols."
251 echo "Skipping debugging symbols."
255 # When cross building for arm on 64-bit systems the host binaries
256 # that are part of v8 need to be compiled with -m32 which means
257 # that basic multilib support is needed.
258 if file /sbin
/init |
grep -q 'ELF 64-bit'; then
259 arm_list
="$arm_list g++-multilib"
262 if test "$do_inst_arm" = "1" ; then
263 echo "Including ARM cross toolchain."
265 echo "Skipping ARM cross toolchain."
269 if test "$do_inst_nacl" = "1"; then
270 echo "Including standalone NaCl dependencies."
272 echo "Skipping standalone NaCl dependencies."
277 echo "${dev_list} ${lib_list} ${dbg_list} ${arm_list} ${nacl_list}" |
278 tr " " "\n" | sort -u | tr "\n" " "
281 if [ 1 -eq "${do_quick_check-0}" ] ; then
282 failed_check
="$(dpkg-query -W -f '${PackageSpec}:${Status}\n' \
283 ${packages} 2>&1 | grep -v "ok installed
" || :)"
284 if [ -n "${failed_check}" ]; then
286 nomatch
="$(echo "${failed_check}" | \
287 sed -e "s
/^No packages found matching \
(.
*\
).$
/\
1/;t
;d
")"
288 missing
="$(echo "${failed_check}" | \
289 sed -e "/^No packages found matching
/d
;s
/^\
(.
*\
):.
*$
/\
1/")"
290 if [ "$nomatch" ]; then
291 # Distinguish between packages that actually aren't available to the
292 # system (i.e. not in any repo) and packages that just aren't known to
293 # dpkg (i.e. managed by apt).
295 for p
in ${nomatch}; do
296 if apt-cache show
${p} > /dev
/null
2>&1; then
297 missing
="${p}\n${missing}"
299 unknown
="${p}\n${unknown}"
302 if [ -n "${unknown}" ]; then
303 echo "WARNING: The following packages are unknown to your system"
304 echo "(maybe missing a repo or need to 'sudo apt-get update'):"
305 echo -e "${unknown}" |
sed -e "s/^/ /"
308 if [ -n "${missing}" ]; then
309 echo "WARNING: The following packages are not installed:"
310 echo -e "${missing}" |
sed -e "s/^/ /"
319 # We initially run "apt-get" with the --reinstall option and parse its output.
320 # This way, we can find all the packages that need to be newly installed
321 # without accidentally promoting any packages from "auto" to "manual".
322 # We then re-run "apt-get" with just the list of missing packages.
323 echo "Finding missing packages..."
324 # Intentionally leaving $packages unquoted so it's more readable.
325 echo "Packages required: " $packages
327 new_list_cmd
="sudo apt-get install --reinstall $(echo $packages)"
328 if new_list
="$(yes n | LANGUAGE=en LANG=C $new_list_cmd)"; then
329 # We probably never hit this following line.
330 echo "No missing packages, and the packages are up-to-date."
331 elif [ $?
-eq 1 ]; then
332 # We expect apt-get to have exit status of 1.
333 # This indicates that we cancelled the install with "yes n|".
334 new_list
=$
(echo "$new_list" |
335 sed -e '1,/The following NEW packages will be installed:/d;s/^ //;t;d')
336 new_list
=$
(echo "$new_list" |
sed 's/ *$//')
337 if [ -z "$new_list" ] ; then
338 echo "No missing packages, and the packages are up-to-date."
340 echo "Installing missing packages: $new_list."
341 sudo apt-get
install ${do_quietly-} ${new_list}
345 # An apt-get exit status of 100 indicates that a real error has occurred.
347 # I am intentionally leaving out the '"'s around new_list_cmd,
348 # as this makes it easier to cut and paste the output
349 echo "The following command failed: " ${new_list_cmd}
351 echo "It produces the following output:"
352 yes n |
$new_list_cmd || true
354 echo "You will have to install the above packages yourself."
359 # Install the Chrome OS default fonts. This must go after running
360 # apt-get, since install-chromeos-fonts depends on curl.
361 if test "$do_inst_chromeos_fonts" != "0"; then
363 echo "Installing Chrome OS fonts."
364 dir
=`echo $0 | sed -r -e 's/\/[^/]+$//'`
365 if ! sudo
$dir/linux
/install-chromeos-fonts.py
; then
366 echo "ERROR: The installation of the Chrome OS default fonts failed."
367 if [ `stat -f -c %T $dir` == "nfs" ]; then
368 echo "The reason is that your repo is installed on a remote file system."
370 echo "This is expected if your repo is installed on a remote file system."
372 echo "It is recommended to install your repo on a local file system."
373 echo "You can skip the installation of the Chrome OS default founts with"
374 echo "the command line option: --no-chromeos-fonts."
378 echo "Skipping installation of Chrome OS fonts."
381 # Install 32bit backwards compatibility support for 64bit systems
382 if file /sbin
/init |
grep -q 'ELF 64-bit'; then
383 if test "$do_inst_lib32" != "1"
385 echo "NOTE: If you were expecting the option to install 32bit libs,"
386 echo "please run with the --lib32 flag."
388 echo "Installation complete."
391 # This conditional statement has been added to deprecate and eventually
392 # remove support for 32bit libraries on 64bit systems. But for the time
393 # being, we still have to support a few legacy systems (e.g. bots), where
394 # this feature is needed.
395 # We only even give the user the option to install these libraries, if
396 # they explicitly requested doing so by setting the --lib32 command line
398 # And even then, we interactively ask them one more time whether they are
400 # In order for that to work, we must reset the ${do_inst_lib32} variable.
401 # There are other ways to achieve the same goal. But resetting the
402 # variable is the best way to document the intended behavior -- and to
403 # allow us to gradually deprecate and then remove the obsolete code.
404 if test "${do_default-0}" -ne 1; then
411 echo "We no longer recommend that you use this script to install"
412 echo "32bit libraries on a 64bit system. Instead, consider using the"
413 echo "install-chroot.sh script to help you set up a 32bit environment"
414 echo "for building and testing 32bit versions of Chrome."
416 echo "The code for installing 32bit libraries on a 64bit system is"
417 echo "unmaintained and might not work with modern versions of Ubuntu"
419 if test "$do_inst_lib32" != "" ; then
421 echo -n "Are you sure you want to proceed (y/N) "
426 if test "$do_inst_lib32" != "1"
431 # Standard 32bit compatibility libraries
432 echo "First, installing the limited existing 32-bit support..."
433 cmp_list
="ia32-libs lib32asound2-dev lib32stdc++6 lib32z1
434 lib32z1-dev libc6-dev-i386 libc6-i386 g++-multilib"
435 if [ -n "`apt-cache search lib32readline-gplv2-dev 2>/dev/null`" ]; then
436 cmp_list
="${cmp_list} lib32readline-gplv2-dev"
438 cmp_list
="${cmp_list} lib32readline5-dev"
440 sudo apt-get
install ${do_quietly-} $cmp_list
442 tmp
=/tmp
/install-32bit.$$
443 trap 'rm -rf "${tmp}"' EXIT INT TERM QUIT
444 mkdir
-p "${tmp}/apt/lists/partial" "${tmp}/cache" "${tmp}/partial"
445 touch "${tmp}/status"
447 [ -r /etc
/apt
/apt.conf
] && cp /etc
/apt
/apt.conf
"${tmp}/apt/"
448 cat >>"${tmp}/apt/apt.conf" <<EOF
449 Apt::Architecture "i386";
450 Dir::Cache "${tmp}/cache";
451 Dir::Cache::Archives "${tmp}/";
452 Dir::State::Lists "${tmp}/apt/lists/";
453 Dir::State::status "${tmp}/status";
456 # Download 32bit packages
457 echo "Computing list of available 32bit packages..."
458 sudo apt-get
-c="${tmp}/apt/apt.conf" update
460 echo "Downloading available 32bit packages..."
461 sudo apt-get
-c="${tmp}/apt/apt.conf" \
462 --yes --download-only --force-yes --reinstall install \
463 ${lib_list} ${dbg_list}
465 # Open packages, remove everything that is not a library, move the
466 # library to a lib32 directory and package everything as a *.deb file.
467 echo "Repackaging and installing 32bit packages for use on 64bit systems..."
468 for i
in ${lib_list} ${dbg_list}; do
469 orig
="$(echo "${tmp}/${i}"_*_i386.deb)"
470 compat
="$(echo "${orig}" |
471 sed -e 's,\(_[^_/]*_\)i386\(.deb\),-ia32\1amd64\2,')"
472 rm -rf "${tmp}/staging"
473 msg
="$(fakeroot -u sh -exc '
474 # Unpack 32bit Debian archive
476 mkdir -p "'"${tmp}"'/staging
/dpkg
/DEBIAN
"
477 cd "'"${tmp}"'/staging
"
479 tar Cfx dpkg data.tar*
480 tar zCfx dpkg/DEBIAN control.tar.gz
482 # Create a posix extended regular expression fragment that will
483 # recognize the includes which have changed. Should be rare,
484 # will almost always be empty.
485 includes=`sed -n -e "s
/^
[0-9a-z]* //g
" \
486 -e "\
,usr
/include
/,p
" dpkg/DEBIAN/md5sums |
487 xargs -n 1 -I FILE /bin/sh -c \
488 "cmp -s dpkg
/FILE
/FILE ||
echo FILE
" |
492 # If empty, set it to not match anything.
493 test -z "$includes" && includes="^
//"
495 # Turn the conflicts into an extended RE for removal from the
497 conflicts=`sed -n -e "/Conflicts
/s
/Conflicts
: *//;T
;s
/, */|
/g
;p
" \
500 # Rename package, change architecture, remove conflicts and dependencies
502 -e "/Package
/s
/$
/-ia32/" \
503 -e "/Architecture
/s
/:.
*$
/: amd64
/" \
504 -e "/Depends
/s
/:.
*/: ia32-libs
/" \
505 -e "/Provides
/s
/($conflicts)(, *)?
//g
;T1
;s
/, *$
//;:1" \
510 # Only keep files that live in "lib
" directories or the includes
513 -e "/\
/lib64\
//d
" -e "/\
/.?bin\
//d
" \
514 -e "\
,$includes,s
,[ /]include
/,&32/,g
;s
,include
/32/,include32
/,g
" \
515 -e "s
, lib
/, lib32
/,g
" \
516 -e "s
,/lib
/,/lib32
/,g
" \
518 -e "\
,^
/usr
/lib32
/debug\
(.
*/lib32\
),s
,^
/usr
/lib32
/debug
,/usr
/lib
/debug
," \
521 # Re-run ldconfig after installation/removal
522 { echo "#!/bin/sh"; echo "[ \"x\$1\" = xconfigure ]&&ldconfig||:"; } \
523 >dpkg
/DEBIAN
/postinst
524 { echo "#!/bin/sh"; echo "[ \"x\$1\" = xremove ]&&ldconfig||:"; } \
526 chmod 755 dpkg
/DEBIAN
/postinst dpkg
/DEBIAN
/postrm
528 # Remove any other control files
529 find dpkg
/DEBIAN
-mindepth 1 "(" -name control
-o -name md5sums
-o \
530 -name postinst
-o -name postrm
")" -o -print |
533 # Remove any files/dirs that live outside of "lib" directories,
534 # or are not in our list of changed includes.
535 find dpkg
-mindepth 1 -regextype posix-extended \
536 "(" -name DEBIAN
-o -name lib
-o -regex "dpkg/($includes)" ")" \
537 -prune -o -print |
tac |
538 xargs -r -n 1 sh
-c "rm \$0 2>/dev/null || rmdir \$0 2>/dev/null || : "
539 find dpkg
-name lib64
-o -name bin
-o -name "?bin" |
540 tac |
xargs -r rm -rf
542 # Remove any symbolic links that were broken by the above steps.
543 find -L dpkg
-type l
-print |
tac |
xargs -r rm -rf
545 # Rename lib to lib32, but keep debug symbols in /usr/lib/debug/usr/lib32
546 # That is where gdb looks for them.
547 find dpkg
-type d
-o -path "*/lib/*" -print |
548 xargs -r -n 1 sh
-c "
549 i=\$(echo \"\${0}\" |
550 sed -e s,/lib/,/lib32/,g \
551 -e s,/usr/lib32/debug\\\\\(.*/lib32\\\\\),/usr/lib/debug\\\\1,);
552 mkdir -p \"\${i%/*}\";
553 mv \"\${0}\" \"\${i}\""
555 # Rename include to include32.
556 [ -d "dpkg/usr/include" ] && mv "dpkg/usr/include" "dpkg/usr/include32"
558 # Prune any empty directories
559 find dpkg
-type d |
tac |
xargs -r -n 1 rmdir 2>/dev
/null ||
:
561 # Create our own Debian package
563 dpkg
--build staging
/dpkg .
' 2>&1)"
564 compat="$(eval echo $(echo "${compat}" |
565 sed -e 's
,_
[^_
/]*_amd64.deb
,_
*_amd64.deb
,'))"
566 [ -r "${compat}" ] || {
568 echo "Failed to build new Debian archive!" >&2
572 msg="$(sudo dpkg -i "${compat}" 2>&1)" && {
573 echo "Installed ${compat##*/}"
576 echo "Skipped ${compat##*/}"
580 # Add symbolic links for developing 32bit code
581 echo "Adding missing symbolic links, enabling 32bit code development..."
582 for i in $(find /lib32 /usr/lib32 -maxdepth 1 -name \*.so.\* |
583 sed -e 's
/[.
]so
[.
][0-9].
*/.so
/' |
585 [ "x${i##*/}" = "xld-linux.so" ] && continue
586 [ -r "$i" ] && continue
587 j="$(ls "$i."* | sed -e 's
/.
*[.
]so
[.
]\
([^.
]*\
)$
/\
1/;t
;d
' |
588 sort -n | tail -n 1)"
589 [ -r "$i.$j" ] || continue
590 sudo ln -s "${i##*/}.$j" "$i"