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 # Check for lsb_release command in $PATH
67 if ! which lsb_release
> /dev
/null
; then
68 echo "ERROR: lsb_release not found in \$PATH" >&2
72 lsb_release
=$
(lsb_release
--codename --short)
73 ubuntu_codenames
="(precise|quantal|raring|saucy|trusty)"
74 if [ 0 -eq "${do_unsupported-0}" ] && [ 0 -eq "${do_quick_check-0}" ] ; then
75 if [[ ! $lsb_release =~
$ubuntu_codenames ]]; then
76 echo "ERROR: Only Ubuntu 12.04 (precise) through 14.04 (trusty) 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 devscripts fakeroot flex
98 fonts-thai-tlwg g++ git-core gperf language-pack-da language-pack-fr
99 language-pack-he language-pack-zh-hant libapache2-mod-php5
100 libasound2-dev libbrlapi-dev libbz2-dev libcairo2-dev libcap-dev
101 libcups2-dev libcurl4-gnutls-dev libdrm-dev libelf-dev libexif-dev
102 libgbm-dev libgconf2-dev libgl1-mesa-dev libglib2.0-dev
103 libglu1-mesa-dev libgnome-keyring-dev libgtk2.0-dev libkrb5-dev
104 libnspr4-dev libnss3-dev libpam0g-dev libpci-dev libpulse-dev
105 libsctp-dev libspeechd-dev libsqlite3-dev libssl-dev libudev-dev
106 libwww-perl libxslt1-dev libxss-dev libxt-dev libxtst-dev
107 mesa-common-dev openbox patch perl php5-cgi pkg-config python
108 python-cherrypy3 python-dev python-psutil rpm ruby subversion
109 ttf-dejavu-core ttf-indic-fonts ttf-kochi-gothic ttf-kochi-mincho
110 wdiff xfonts-mathml zip $chromeos_dev_list"
112 # 64-bit systems need a minimum set of 32-bit compat packages for the pre-built
113 # NaCl binaries. These are always needed, regardless of whether or not we want
114 # the full 32-bit "cross-compile" support (--lib32).
115 if file /sbin
/init |
grep -q 'ELF 64-bit'; then
116 dev_list
="${dev_list} libc6-i386 lib32gcc1 lib32stdc++6"
119 # Run-time libraries required by chromeos only
120 chromeos_lib_list
="libpulse0 libbz2-1.0"
122 # Full list of required run-time libraries
123 lib_list
="libatk1.0-0 libc6 libasound2 libcairo2 libcap2 libcups2 libexpat1
124 libexif12 libfontconfig1 libfreetype6 libglib2.0-0 libgnome-keyring0
125 libgtk2.0-0 libpam0g libpango1.0-0 libpci3 libpcre3 libpixman-1-0
126 libpng12-0 libspeechd2 libstdc++6 libsqlite3-0 libx11-6
127 libxau6 libxcb1 libxcomposite1 libxcursor1 libxdamage1 libxdmcp6
128 libxext6 libxfixes3 libxi6 libxinerama1 libxrandr2 libxrender1
129 libxtst6 zlib1g $chromeos_lib_list"
131 # Debugging symbols for all of the run-time libraries
132 dbg_list
="libatk1.0-dbg libc6-dbg libcairo2-dbg libfontconfig1-dbg
133 libglib2.0-0-dbg libgtk2.0-0-dbg libpango1.0-0-dbg libpcre3-dbg
134 libpixman-1-0-dbg libsqlite3-0-dbg libx11-6-dbg libxau6-dbg
135 libxcb1-dbg libxcomposite1-dbg libxcursor1-dbg libxdamage1-dbg
136 libxdmcp6-dbg libxext6-dbg libxfixes3-dbg libxi6-dbg libxinerama1-dbg
137 libxrandr2-dbg libxrender1-dbg libxtst6-dbg zlib1g-dbg
140 # arm cross toolchain packages needed to build chrome on armhf
141 arm_list
="libc6-dev-armhf-cross
142 linux-libc-dev-armhf-cross
143 g++-arm-linux-gnueabihf"
145 # Packages to build standalone NaCl and all its toolchains.
146 nacl_list
="g++-mingw-w64-i686 libtinfo-dev libtinfo-dev:i386"
148 # Some package names have changed over time
149 if package_exists ttf-mscorefonts-installer
; then
150 dev_list
="${dev_list} ttf-mscorefonts-installer"
152 dev_list
="${dev_list} msttcorefonts"
154 if package_exists libnspr4-dbg
; then
155 dbg_list
="${dbg_list} libnspr4-dbg libnss3-dbg"
156 lib_list
="${lib_list} libnspr4 libnss3"
158 dbg_list
="${dbg_list} libnspr4-0d-dbg libnss3-1d-dbg"
159 lib_list
="${lib_list} libnspr4-0d libnss3-1d"
161 if package_exists libjpeg-dev
; then
162 dev_list
="${dev_list} libjpeg-dev"
164 dev_list
="${dev_list} libjpeg62-dev"
166 if package_exists libudev1
; then
167 dev_list
="${dev_list} libudev1"
169 dev_list
="${dev_list} libudev0"
171 if package_exists libbrlapi0.6
; then
172 dev_list
="${dev_list} libbrlapi0.6"
174 dev_list
="${dev_list} libbrlapi0.5"
178 # Some packages are only needed if the distribution actually supports
180 if package_exists appmenu-gtk
; then
181 lib_list
="$lib_list appmenu-gtk"
184 # Waits for the user to press 'Y' or 'N'. Either uppercase of lowercase is
185 # accepted. Returns 0 for 'Y' and 1 for 'N'. If an optional parameter has
186 # been provided to yes_no(), the function also accepts RETURN as a user input.
187 # The parameter specifies the exit code that should be returned in that case.
188 # The function will echo the user's selection followed by a newline character.
189 # Users can abort the function by pressing CTRL-C. This will call "exit 1".
191 if [ 0 -ne "${do_default-0}" ] ; then
192 [ $1 -eq 0 ] && echo "Y" ||
echo "N"
197 c
="$(trap 'stty echo -iuclc icanon 2>/dev/null' EXIT INT TERM QUIT
198 stty -echo iuclc -icanon 2>/dev/null
199 dd count=1 bs=1 2>/dev/null | od -An -tx1)"
201 " 0a") if [ -n "$1" ]; then
202 [ $1 -eq 0 ] && echo "Y" ||
echo "N"
212 "") echo "Aborted" >&2
215 *) # The user pressed an unrecognized key. As we are not echoing
216 # any incorrect user input, alert the user by ringing the bell.
217 (tput bel
) 2>/dev
/null
223 if test "$do_inst_syms" = "" && test 0 -eq ${do_quick_check-0}
225 echo "This script installs all tools and libraries needed to build Chromium."
227 echo "For most of the libraries, it can also install debugging symbols, which"
228 echo "will allow you to debug code in the system libraries. Most developers"
229 echo "won't need these symbols."
230 echo -n "Do you want me to install them for you (y/N) "
235 if test "$do_inst_syms" = "1"; then
236 echo "Including debugging symbols."
238 echo "Skipping debugging symbols."
242 # When cross building for arm on 64-bit systems the host binaries
243 # that are part of v8 need to be compiled with -m32 which means
244 # that basic multilib support is needed.
245 if file /sbin
/init |
grep -q 'ELF 64-bit'; then
246 if [ "$lsb_release" = "trusty" ]; then
247 # gcc-multilib conflicts with the arm cross compiler in trusty but
248 # g++-4.8-multilib gives us the 32-bit support that we need.
249 arm_list
="$arm_list g++-4.8-multilib"
251 arm_list
="$arm_list g++-multilib"
255 if test "$do_inst_arm" = "1" ; then
256 echo "Including ARM cross toolchain."
258 echo "Skipping ARM cross toolchain."
262 if test "$do_inst_nacl" = "1"; then
263 echo "Including standalone NaCl dependencies."
265 echo "Skipping standalone NaCl dependencies."
270 echo "${dev_list} ${lib_list} ${dbg_list} ${arm_list} ${nacl_list}" |
271 tr " " "\n" | sort -u | tr "\n" " "
274 if [ 1 -eq "${do_quick_check-0}" ] ; then
275 failed_check
="$(dpkg-query -W -f '${PackageSpec}:${Status}\n' \
276 ${packages} 2>&1 | grep -v "ok installed
" || :)"
277 if [ -n "${failed_check}" ]; then
279 nomatch
="$(echo "${failed_check}" | \
280 sed -e "s
/^No packages found matching \
(.
*\
).$
/\
1/;t
;d
")"
281 missing
="$(echo "${failed_check}" | \
282 sed -e "/^No packages found matching
/d
;s
/^\
(.
*\
):.
*$
/\
1/")"
283 if [ "$nomatch" ]; then
284 # Distinguish between packages that actually aren't available to the
285 # system (i.e. not in any repo) and packages that just aren't known to
286 # dpkg (i.e. managed by apt).
288 for p
in ${nomatch}; do
289 if apt-cache show
${p} > /dev
/null
2>&1; then
290 missing
="${p}\n${missing}"
292 unknown
="${p}\n${unknown}"
295 if [ -n "${unknown}" ]; then
296 echo "WARNING: The following packages are unknown to your system"
297 echo "(maybe missing a repo or need to 'sudo apt-get update'):"
298 echo -e "${unknown}" |
sed -e "s/^/ /"
301 if [ -n "${missing}" ]; then
302 echo "WARNING: The following packages are not installed:"
303 echo -e "${missing}" |
sed -e "s/^/ /"
312 # We initially run "apt-get" with the --reinstall option and parse its output.
313 # This way, we can find all the packages that need to be newly installed
314 # without accidentally promoting any packages from "auto" to "manual".
315 # We then re-run "apt-get" with just the list of missing packages.
316 echo "Finding missing packages..."
317 # Intentionally leaving $packages unquoted so it's more readable.
318 echo "Packages required: " $packages
320 new_list_cmd
="sudo apt-get install --reinstall $(echo $packages)"
321 if new_list
="$(yes n | LANGUAGE=en LANG=C $new_list_cmd)"; then
322 # We probably never hit this following line.
323 echo "No missing packages, and the packages are up-to-date."
324 elif [ $?
-eq 1 ]; then
325 # We expect apt-get to have exit status of 1.
326 # This indicates that we cancelled the install with "yes n|".
327 new_list
=$
(echo "$new_list" |
328 sed -e '1,/The following NEW packages will be installed:/d;s/^ //;t;d')
329 new_list
=$
(echo "$new_list" |
sed 's/ *$//')
330 if [ -z "$new_list" ] ; then
331 echo "No missing packages, and the packages are up-to-date."
333 echo "Installing missing packages: $new_list."
334 sudo apt-get
install ${do_quietly-} ${new_list}
338 # An apt-get exit status of 100 indicates that a real error has occurred.
340 # I am intentionally leaving out the '"'s around new_list_cmd,
341 # as this makes it easier to cut and paste the output
342 echo "The following command failed: " ${new_list_cmd}
344 echo "It produces the following output:"
345 yes n |
$new_list_cmd || true
347 echo "You will have to install the above packages yourself."
352 # Install the Chrome OS default fonts. This must go after running
353 # apt-get, since install-chromeos-fonts depends on curl.
354 if test "$do_inst_chromeos_fonts" != "0"; then
356 echo "Installing Chrome OS fonts."
357 dir
=`echo $0 | sed -r -e 's/\/[^/]+$//'`
358 if ! sudo
$dir/linux
/install-chromeos-fonts.py
; then
359 echo "ERROR: The installation of the Chrome OS default fonts failed."
360 if [ `stat -f -c %T $dir` == "nfs" ]; then
361 echo "The reason is that your repo is installed on a remote file system."
363 echo "This is expected if your repo is installed on a remote file system."
365 echo "It is recommended to install your repo on a local file system."
366 echo "You can skip the installation of the Chrome OS default founts with"
367 echo "the command line option: --no-chromeos-fonts."
371 echo "Skipping installation of Chrome OS fonts."
374 # Install 32bit backwards compatibility support for 64bit systems
375 if file /sbin
/init |
grep -q 'ELF 64-bit'; then
376 if test "$do_inst_lib32" != "1"
378 echo "NOTE: If you were expecting the option to install 32bit libs,"
379 echo "please run with the --lib32 flag."
381 echo "Installation complete."
384 # This conditional statement has been added to deprecate and eventually
385 # remove support for 32bit libraries on 64bit systems. But for the time
386 # being, we still have to support a few legacy systems (e.g. bots), where
387 # this feature is needed.
388 # We only even give the user the option to install these libraries, if
389 # they explicitly requested doing so by setting the --lib32 command line
391 # And even then, we interactively ask them one more time whether they are
393 # In order for that to work, we must reset the ${do_inst_lib32} variable.
394 # There are other ways to achieve the same goal. But resetting the
395 # variable is the best way to document the intended behavior -- and to
396 # allow us to gradually deprecate and then remove the obsolete code.
397 if test "${do_default-0}" -ne 1; then
404 echo "We no longer recommend that you use this script to install"
405 echo "32bit libraries on a 64bit system. Instead, consider using the"
406 echo "install-chroot.sh script to help you set up a 32bit environment"
407 echo "for building and testing 32bit versions of Chrome."
409 echo "The code for installing 32bit libraries on a 64bit system is"
410 echo "unmaintained and might not work with modern versions of Ubuntu"
412 if test "$do_inst_lib32" != "" ; then
414 echo -n "Are you sure you want to proceed (y/N) "
419 if test "$do_inst_lib32" != "1"
424 # Standard 32bit compatibility libraries
425 echo "First, installing the limited existing 32-bit support..."
426 cmp_list
="ia32-libs lib32asound2-dev lib32stdc++6 lib32z1
427 lib32z1-dev libc6-dev-i386 libc6-i386 g++-multilib"
428 if [ -n "`apt-cache search lib32readline-gplv2-dev 2>/dev/null`" ]; then
429 cmp_list
="${cmp_list} lib32readline-gplv2-dev"
431 cmp_list
="${cmp_list} lib32readline5-dev"
433 sudo apt-get
install ${do_quietly-} $cmp_list
435 tmp
=/tmp
/install-32bit.$$
436 trap 'rm -rf "${tmp}"' EXIT INT TERM QUIT
437 mkdir
-p "${tmp}/apt/lists/partial" "${tmp}/cache" "${tmp}/partial"
438 touch "${tmp}/status"
440 [ -r /etc
/apt
/apt.conf
] && cp /etc
/apt
/apt.conf
"${tmp}/apt/"
441 cat >>"${tmp}/apt/apt.conf" <<EOF
442 Apt::Architecture "i386";
443 Dir::Cache "${tmp}/cache";
444 Dir::Cache::Archives "${tmp}/";
445 Dir::State::Lists "${tmp}/apt/lists/";
446 Dir::State::status "${tmp}/status";
449 # Download 32bit packages
450 echo "Computing list of available 32bit packages..."
451 sudo apt-get
-c="${tmp}/apt/apt.conf" update
453 echo "Downloading available 32bit packages..."
454 sudo apt-get
-c="${tmp}/apt/apt.conf" \
455 --yes --download-only --force-yes --reinstall install \
456 ${lib_list} ${dbg_list}
458 # Open packages, remove everything that is not a library, move the
459 # library to a lib32 directory and package everything as a *.deb file.
460 echo "Repackaging and installing 32bit packages for use on 64bit systems..."
461 for i
in ${lib_list} ${dbg_list}; do
462 orig
="$(echo "${tmp}/${i}"_*_i386.deb)"
463 compat
="$(echo "${orig}" |
464 sed -e 's,\(_[^_/]*_\)i386\(.deb\),-ia32\1amd64\2,')"
465 rm -rf "${tmp}/staging"
466 msg
="$(fakeroot -u sh -exc '
467 # Unpack 32bit Debian archive
469 mkdir -p "'"${tmp}"'/staging
/dpkg
/DEBIAN
"
470 cd "'"${tmp}"'/staging
"
472 tar Cfx dpkg data.tar*
473 tar zCfx dpkg/DEBIAN control.tar.gz
475 # Create a posix extended regular expression fragment that will
476 # recognize the includes which have changed. Should be rare,
477 # will almost always be empty.
478 includes=`sed -n -e "s
/^
[0-9a-z]* //g
" \
479 -e "\
,usr
/include
/,p
" dpkg/DEBIAN/md5sums |
480 xargs -n 1 -I FILE /bin/sh -c \
481 "cmp -s dpkg
/FILE
/FILE ||
echo FILE
" |
485 # If empty, set it to not match anything.
486 test -z "$includes" && includes="^
//"
488 # Turn the conflicts into an extended RE for removal from the
490 conflicts=`sed -n -e "/Conflicts
/s
/Conflicts
: *//;T
;s
/, */|
/g
;p
" \
493 # Rename package, change architecture, remove conflicts and dependencies
495 -e "/Package
/s
/$
/-ia32/" \
496 -e "/Architecture
/s
/:.
*$
/: amd64
/" \
497 -e "/Depends
/s
/:.
*/: ia32-libs
/" \
498 -e "/Provides
/s
/($conflicts)(, *)?
//g
;T1
;s
/, *$
//;:1" \
503 # Only keep files that live in "lib
" directories or the includes
506 -e "/\
/lib64\
//d
" -e "/\
/.?bin\
//d
" \
507 -e "\
,$includes,s
,[ /]include
/,&32/,g
;s
,include
/32/,include32
/,g
" \
508 -e "s
, lib
/, lib32
/,g
" \
509 -e "s
,/lib
/,/lib32
/,g
" \
511 -e "\
,^
/usr
/lib32
/debug\
(.
*/lib32\
),s
,^
/usr
/lib32
/debug
,/usr
/lib
/debug
," \
514 # Re-run ldconfig after installation/removal
515 { echo "#!/bin/sh"; echo "[ \"x\$1\" = xconfigure ]&&ldconfig||:"; } \
516 >dpkg
/DEBIAN
/postinst
517 { echo "#!/bin/sh"; echo "[ \"x\$1\" = xremove ]&&ldconfig||:"; } \
519 chmod 755 dpkg
/DEBIAN
/postinst dpkg
/DEBIAN
/postrm
521 # Remove any other control files
522 find dpkg
/DEBIAN
-mindepth 1 "(" -name control
-o -name md5sums
-o \
523 -name postinst
-o -name postrm
")" -o -print |
526 # Remove any files/dirs that live outside of "lib" directories,
527 # or are not in our list of changed includes.
528 find dpkg
-mindepth 1 -regextype posix-extended \
529 "(" -name DEBIAN
-o -name lib
-o -regex "dpkg/($includes)" ")" \
530 -prune -o -print |
tac |
531 xargs -r -n 1 sh
-c "rm \$0 2>/dev/null || rmdir \$0 2>/dev/null || : "
532 find dpkg
-name lib64
-o -name bin
-o -name "?bin" |
533 tac |
xargs -r rm -rf
535 # Remove any symbolic links that were broken by the above steps.
536 find -L dpkg
-type l
-print |
tac |
xargs -r rm -rf
538 # Rename lib to lib32, but keep debug symbols in /usr/lib/debug/usr/lib32
539 # That is where gdb looks for them.
540 find dpkg
-type d
-o -path "*/lib/*" -print |
541 xargs -r -n 1 sh
-c "
542 i=\$(echo \"\${0}\" |
543 sed -e s,/lib/,/lib32/,g \
544 -e s,/usr/lib32/debug\\\\\(.*/lib32\\\\\),/usr/lib/debug\\\\1,);
545 mkdir -p \"\${i%/*}\";
546 mv \"\${0}\" \"\${i}\""
548 # Rename include to include32.
549 [ -d "dpkg/usr/include" ] && mv "dpkg/usr/include" "dpkg/usr/include32"
551 # Prune any empty directories
552 find dpkg
-type d |
tac |
xargs -r -n 1 rmdir 2>/dev
/null ||
:
554 # Create our own Debian package
556 dpkg
--build staging
/dpkg .
' 2>&1)"
557 compat="$(eval echo $(echo "${compat}" |
558 sed -e 's
,_
[^_
/]*_amd64.deb
,_
*_amd64.deb
,'))"
559 [ -r "${compat}" ] || {
561 echo "Failed to build new Debian archive!" >&2
565 msg="$(sudo dpkg -i "${compat}" 2>&1)" && {
566 echo "Installed ${compat##*/}"
569 echo "Skipped ${compat##*/}"
573 # Add symbolic links for developing 32bit code
574 echo "Adding missing symbolic links, enabling 32bit code development..."
575 for i in $(find /lib32 /usr/lib32 -maxdepth 1 -name \*.so.\* |
576 sed -e 's
/[.
]so
[.
][0-9].
*/.so
/' |
578 [ "x${i##*/}" = "xld-linux.so" ] && continue
579 [ -r "$i" ] && continue
580 j="$(ls "$i."* | sed -e 's
/.
*[.
]so
[.
]\
([^.
]*\
)$
/\
1/;t
;d
' |
581 sort -n | tail -n 1)"
582 [ -r "$i.$j" ] || continue
583 sudo ln -s "${i##*/}.$j" "$i"