3 # Common functions for build scripts used by various packages
4 # incorporated (e.g., build, bootcd, nodeimage, sliceimage)
6 # Marc E. Fiuczynski <mef@cs.princeton.edu>
7 # Copyright (C) 2007 The Trustees of Princeton University
8 # Thierry Parmentelat <thierry.parmentelat@inria.fr> INRIA
10 # supported distros f12 f14 f16 f18 f20
11 # and debians/ubuntus to a lesser extent
13 # for locating pkgs.py
16 # returns 'Fedora' or 'CentOS' for now
17 function pl_getDistro() {
18 if [ -f "/etc/redhat-release" ] ; then
19 distro=$(awk ' { print $1 } ' /etc/redhat-release)
20 case $distro in Scientific*) distro="SL" ; esac
21 elif [ -f /etc/lsb-release ] ; then
23 echo $DISTRIB_CODENAME
24 elif [ -f /etc/debian_version ] ; then
25 case $(cat /etc/debian_version) in
26 6.*) distro=squeeze ;;
29 *) distro=unknown.debian.in.build.common ;;
32 [ -z "$distro" ] && { echo "build.common.pl_getDistro-unknown"; exit 1; }
37 # returns something like 8, 10, or 5.3
38 function pl_getRelease() {
39 if [ -f "/etc/redhat-release" ] ; then
40 release=$(awk ' { if ($1=="Fedora" && $2=="Core") print $4 ; if (($1=="Fedora" && $2!="Core")||$1=="CentOS") print $3 ; if ($1=="Scientific") print $4 } ' /etc/redhat-release)
42 echo "build.common.pl_getRelease-unknown"
45 # keep only the major number
46 echo "$release" | cut -d. -f1
50 # returns distro shortname, something like 'f8' or 'centos5'
51 function pl_getReleaseName () {
66 releasename=sl$release
68 squeeze|wheezy|jessie|oneiric|precise|quantal|raring|saucy)
72 releasename="unknown-name-for-${pl_DISTRO}-please-edit-build.common"
73 echo 1>&2 "build.common: WARNING - releasename not set for distro=$distro"
81 # yum exclusions are now defined in yumexclude.pkgs
82 # so they can now depend both on the linux distro and the pl distro
83 function pl_yumexclude () {
88 # search for file "yumexclude.pkgs"
89 yumexclude_file=$(pl_locateDistroFile $builddir $pldistro "yumexclude.pkgs")
91 # check if pkgs.py is in PATH
92 type -p pkgs.py >& /dev/null || export PATH=$builddir:$PATH
95 pkgs.py -a $pl_DISTRO_ARCH -f $fcdistro -d $pldistro $keyword $yumexclude_file || \
96 { echo pl_yumexclude failed with fcdistro=$fcdistro and pldistro=$pldistro; return 1 ; }
99 # <> fcdistro pldistro builddir
100 # node side : use the 'nodeyumexclude' keywork in yumexclude.pkgs
101 function pl_nodeyumexclude () { pl_yumexclude 'nodeyumexclude' "$@" ; }
102 # server side : use the 'plcyumexclude' keywork in yumexclude.pkgs
103 function pl_plcyumexclude () { pl_yumexclude 'plcyumexclude' "$@" ; }
106 # figure out which redhat distro we are using (fedora, centos, redhat)
107 pl_DISTRO=$(pl_getDistro)
109 # select basearch of the host devel environment - protected for macos for local tests
110 # try arch for testing stuff on a mac
111 pl_DISTRO_ARCH=$(uname -i 2>/dev/null || arch 2> /dev/null || echo unknownarch)
113 # the release number (plain number)
114 pl_DISTRO_RELEASE=$(pl_getRelease)
116 # the release name - something like 'f8' or 'sl6'
117 pl_DISTRO_NAME=$(pl_getReleaseName $pl_DISTRO $pl_DISTRO_RELEASE)
119 # get path to appropriate yumgroups.xml file
120 # Thierry: quick & dirty improvement
121 # this file is updated by the toplevel build, from the .pkgs files
122 pl_DISTRO_YUMGROUPS="../../../RPMS/yumgroups.xml"
124 function pl_process_fedora_options () {
127 while getopts "l:r:a:h" opt ; do
130 pl_DISTRO_URL=$OPTARG
131 let shiftcount=$shiftcount+2
134 pl_DISTRO_RELEASE=$OPTARG
135 let shiftcount=$shiftcount+2
138 pl_DISTRO_ARCH=$OPTARG
139 let shiftcount=$shiftcount+2
142 echo "Usage: $0 [OPTION]..."
143 echo " -l url distro mirror location (default: $pl_DISTRO_URL)"
144 echo " -r release distro release number (default: $pl_DISTRO_RELEASE)"
145 echo " -a arch distro architecture (default: $pl_DISTRO_ARCH)"
146 echo "where distro can be either fedora, centos, or redhat"
147 echo " -h This message"
155 ######################################## handling a root image
156 function pl_root_rpm_macros () {
158 %_install_langs C:en_US:en
159 %_netsharedpath /proc:/dev/pts:/usr/share/info
161 %__file_context_path /dev/null
165 function pl_root_makedevs() {
167 # Clean ${vroot}/dev, but only when ${vroot}!=""
168 [ -n $vroot ] && rm -rf $vroot/dev
171 mknod -m 666 $vroot/dev/null c 1 3
172 mknod -m 666 $vroot/dev/zero c 1 5
173 mknod -m 666 $vroot/dev/full c 1 7
174 mknod -m 644 $vroot/dev/random c 1 8
175 mknod -m 644 $vroot/dev/urandom c 1 9
176 mknod -m 666 $vroot/dev/tty c 5 0
177 mknod -m 666 $vroot/dev/ptmx c 5 2
178 # For bash command substitution
179 ln -nsf ../proc/self/fd $vroot/dev/fd
181 # For df and linuxconf
182 touch $vroot/dev/hdv1
185 mkdir -p $vroot/dev/pts
188 mkdir -p $vroot/dev/shm
191 mkdir -p $vroot/dev/net
192 mknod -m 600 $vroot/dev/net/tun c 10 200
194 # For mkinitrd (in case a kernel is being installed)
195 # As well as for loop back mounting within a vm.
196 for i in $(seq 0 255) ; do
197 mknod -m 640 $vroot/dev/loop$i b 7 $i
201 function mkfedora_usage() {
202 echo "Usage: pl_root_mkfedora [OPTION]... basedir pldistro pkgsfile(s)"
203 echo " -l url Fedora mirror location."
204 echo " Defaults are searched in <pldistro>.mirrors"
205 echo " -v Be verbose"
206 echo " -h This message"
207 echo " target selection (defaults based on current build VM context)"
208 echo " -r release Fedora release number (default: $releasever)"
209 echo " -a arch Fedora architecture (default: $basearch)"
213 function pl_root_mkfedora () {
215 echo "* Entering pl_root_mkfedora" "$@"
217 if [ $UID -ne 0 ] ; then
218 echo "Error: You must run this script as root."
225 # Release and architecture to install : defaults to current vm settings or previously parsed fedora_options
226 releasever=$pl_DISTRO_RELEASE
227 basearch=$pl_DISTRO_ARCH
230 while getopts "vh" opt ; do
232 v) verbose=1; set -x ;;
233 h|*) mkfedora_usage ;;
237 shift $(($OPTIND - 1))
238 [[ "$#" -lt 3 ]] && mkfedora_usage
242 vroot=$(cd $vroot && pwd -P)
243 [ -d $vroot ] || mkfedora_usage
246 # parse pkgsfile and add to local vars
247 fcdistro=${pl_DISTRO_NAME}
248 pkgs_packages=$(pkgs.py -a $pl_DISTRO_ARCH -f $fcdistro -d $pldistro package $pkgsfile)
249 pkgs_groups=$(pkgs.py -a $pl_DISTRO_ARCH -f $fcdistro -d $pldistro group $pkgsfile)
250 # what can get trashed to save space
251 pkgs_junk=$(pkgs.py -a $pl_DISTRO_ARCH -f $fcdistro -d $pldistro junk $pkgsfile)
253 pkgs_precious=$(pkgs.py -a $pl_DISTRO_ARCH -f $fcdistro -d $pldistro precious $pkgsfile)
254 # formerly related to mkfedora -k : packages to take from our own build
255 # and thus need be excluded frem the stock repos
256 # locate builddir by looking for pkgs.py
257 builddir=$(dirname $(type -p pkgs.py))
258 SUBST_NODEYUMEXCLUDE=$(pl_nodeyumexclude $fcdistro $pldistro $builddir)
259 pkgs_yumexclude=$(pkgs.py -a $pl_DISTRO_ARCH -f $fcdistro -d $pldistro yumexclude $pkgsfile | sed -e s,@NODEYUMEXCLUDE@,"$SUBST_NODEYUMEXCLUDE",)
260 # get mirrors if not specified with -l
261 if [ -z "$mirrors" ] ; then
262 mirrorsfile=$(pl_locateDistroFile ../build/ $pldistro "$pldistro.mirrors")
263 # do not sort mirrors, keep order from input
264 mirrors=$(pkgs.py -u -a $pl_DISTRO_ARCH -f $fcdistro -d $pldistro mirror $mirrorsfile)
268 [ -n "$pkgs_yumexclude" ] && yumexclude_line="exclude=$pkgs_yumexclude"
270 echo "$0: candidate mirrors"
271 for mirror in $mirrors ; do
272 echo "* candidate mirror $mirror"
275 # the repo part of the final yum.conf
276 yum_conf_repos=$vroot/xxxmkfedora-repos.confxxx
277 if ! yumconf_mirrors $yum_conf_repos ../build/ $fcdistro "$yumexclude_line" $mirrors ; then
278 echo xxx -- error ; return 1
281 # Do not tolerate errors
284 public_gpg_key=$(yumconf_gpgkey $yum_conf_repos)
286 ## make rpms ignore installing stuff to special fs entries like /proc
287 # Because of https://bugzilla.redhat.com/bugzilla/show_bug.cgi?id=52725
288 # you have to use at least one language beside 'C'
289 # Prevent all locales from being installed in reference image
290 mkdir -p $vroot/etc/rpm
291 pl_root_rpm_macros > $vroot/etc/rpm/macros
293 # Trick rpm and yum, who read the real root /etc/rpm/macros file
294 # rather than the one installed in the reference image, despite what
295 # you might expect the --root and --installroot options to mean. Both
296 # programs always read $HOME/.rpmmacros.
297 export HOME=$vroot/tmp
299 pl_root_rpm_macros > $vroot/tmp/.rpmmacros
301 function mkfedora_cleanup () {
302 umount -l $vroot/proc
303 umount -l $vroot/dev/shm
304 umount -l $vroot/dev/pts
307 # Clean up before exiting if anything goes wrong
308 trap "mkfedora_cleanup" ERR INT
310 # Mount in reference image
311 mount -t devpts none $vroot/dev/pts
312 mount -t tmpfs none $vroot/dev/shm
314 mount -t proc none $vroot/proc
316 # Create a /var/lib dirs for yum & rpm
317 mkdir -p $vroot/var/lib/yum
318 mkdir -p $vroot/var/lib/rpm
319 mkdir -p $vroot/usr/share/info
321 # Create a dummy /etc/fstab in reference image
323 cat >$vroot/etc/fstab <<EOF
324 # This fake fstab exists only to please df and linuxconf.
325 /dev/hdv1 / ext2 defaults 1 1
327 cp $vroot/etc/fstab $vroot/etc/mtab
329 # Necessary for some scripts
330 mkdir -p $vroot/etc/sysconfig
331 echo "NETWORKING=yes" > $vroot/etc/sysconfig/network
333 # Initialize RPM database in reference image
334 mkdir -p $vroot/var/lib/rpm
335 rpm --root $vroot --initdb
336 rpm --root $vroot --import $public_gpg_key
338 # Initialize yum in reference image
339 mkdir -p $vroot/var/cache/yum $vroot/var/log
341 # yum.conf is for building only - store in different location than /etc/yum.conf
342 yum_conf=$vroot/etc/mkfedora-yum.conf
343 cat > $yum_conf <<EOF
345 cachedir=/var/cache/yum
347 logfile=/var/log/yum.log
350 distroverpkg=redhat-release
356 # Prevent yum-2.4 from loading additional repository definitions
357 # (e.g., from /etc/yum.repos.d/)
361 cat $yum_conf_repos >> $yum_conf
363 # If we are being built as part of an automated RPM build, solve the
364 # bootstrap problem by including any just built packages in the yum
365 # configuration. This cooperates with the PlanetLab build system.
366 if [ -n "$RPM_BUILD_DIR" ] ; then
367 RPM_RPMS_DIR=$(cd $(dirname $RPM_BUILD_DIR)/RPMS && pwd -P)
368 # If run under sudo, allow user to delete the headers/ and
369 # repodata/ directories.
370 if [ -n "$SUDO_USER" ] ; then
371 chown -R $SUDO_USER $RPM_RPMS_DIR
373 cat >> $yum_conf <<EOF
376 name=Building - $basearch - $RPM_RPMS_DIR/
377 baseurl=file://$RPM_RPMS_DIR/
381 echo "========== Dumping $yum_conf"
383 echo "========== EndDump $yum_conf"
386 # yum --help | grep verbose &> /dev/null && yum_options="$yum_options --verbose"
387 yum_options="$yum_options -y"
388 yum_options="$yum_options -c $yum_conf"
389 yum_options="$yum_options --installroot=$vroot"
391 # glibc must be specified explicitly for the correct arch to be
393 echo "* Installing glibc"
394 # ignore yum's return code that is basically undefined
395 yum $yum_options install glibc || :
398 if [ -n "$pkgs_packages" ] ; then
399 echo "* Installing optional packages" $pkgs_packages
400 # ignore yum's return code that is basically undefined
401 echo "* Install options" $vroot $yum_options
402 yum $yum_options install $pkgs_packages || :
403 if ! rpm --root $vroot -q $pkgs_packages >/dev/null ; then
404 echo "* Warning: Missing packages"
405 rpm --root $vroot -q $pkgs_packages | grep "not installed"
409 if [ -n "$pkgs_groups" ] ; then
410 ## call yum sequentially to get finer-grained info on dependencies
411 for group_plus in $pkgs_groups ; do
412 group=$(echo $group_plus | sed -e "s,+++, ,g")
413 echo "* Installing optional group $group"
414 # ignore yum's return code that is basically undefined
415 yum $yum_options groupinstall "$group" || :
419 # formerly in bootcd/prep.sh : to optimize footprint
420 if [ -n "$pkgs_junk" ] ; then
421 echo "* Removing unnecessary junk"
423 # Save precious files
424 [ -n "$pkgs_precious" ] && tar --ignore-failed-read -cpf precious.tar $pkgs_precious
425 # Remove unnecessary junk
426 [ -n "$pkgs_junk" ] && rm -rf $pkgs_junk
427 # Restore precious files
428 [ -n "$pkgs_precious" ] && tar -xpf precious.tar && rm -f precious.tar
435 # NOTE: this hack is for Fedora >= 12.
436 # if kernel-debug is installed, clean it up
437 # we link to our version of kernel/initrd and clean up
438 # kernel-debug manually
439 if rpm --root $vroot --quiet -q kernel-debug ; then
440 echo "* Cleaning up kernel-debug - (workaround for f12)"
442 rm -rf kernel-boot kernel-bootsmp initrd-boot initrd-bootsmp
443 ln -s vmlinuz-*${pldistro}* kernel-boot
444 ln -s vmlinuz-*${pldistro}* kernel-bootsmp
445 ln -s initrd-*${pldistro}* initrd-boot
446 ln -s initrd-*${pldistro}* initrd-bootsmp
447 rpm --root $vroot --nodeps -e kernel-debug || :
451 # ignore yum's return code that is basically undefined
452 yum $yum_options clean all || :
455 rm -f $vroot/var/lib/rpm/__db*
457 # Set time zone to UTC
458 if [ -f $vroot/usr/share/zoneinfo/UTC -a -f $vroot/etc/localtime ] ; then
459 rm -f $vroot/etc/localtime
460 ln -s /usr/share/zoneinfo/UTC $vroot/etc/localtime
463 echo "Dumping current list of rpms in /etc/mkfedora-rpms.txt"
464 chroot $vroot rpm -aq | sort > $vroot/etc/mkfedora-rpms.txt
466 # remove trap handler, as we are about to call it directly.
475 function pl_root_tune_image () {
478 # Disable all services in reference image
479 chroot $root sh -c "/sbin/chkconfig --list | awk '{ print \$1 }' | xargs -i /sbin/chkconfig {} off"
481 # FC2 minilogd starts up during shutdown and makes unmounting
482 # impossible. Just get rid of it.
483 rm -f $root/sbin/minilogd
484 ln -nsf /bin/true $root/sbin/minilogd
486 # This tells the Boot Manager that it is okay to update
487 # /etc/resolv.conf and /etc/hosts whenever the network configuration
488 # changes. Users are free to delete this file.
489 touch $root/etc/AUTO_UPDATE_NET_FILES
492 # Move specified directories out of a src tree into a dst tree, and
493 # then for each moved directory create a symlink in src to dst.
494 function pl_move_dirs() {
501 for datadir in "$@" ; do
502 mkdir -p ${data}${datadir}
503 if [ -d ${root}/${datadir} -a ! -h ${root}/${datadir} ] ; then
504 (cd ${root} && find ./${datadir} | cpio -p -d -u ../${data}/)
506 rm -rf ${root}/${datadir}
507 mkdir -p $(dirname ${root}/${datadir})
508 ln -nsf ${store}/${datadir} ${root}/${datadir}
512 # Construct an image file from given some directory
513 # XXX in the future maybe use livecdtools?
514 function pl_make_image() {
519 # Leave about 100 MB free space and allow for about 20% inode overhead
520 bytes=$((($(du -sb $root | cut -f1) + $extraspace) * 120 / 100))
522 blocks=$(($bytes / $bs))
523 dd bs=$bs count=$blocks if=/dev/zero of=$image
524 mkfs.ext3 -b $bs -j -F $image
526 # Temporarily mount it
527 tmp=$(mktemp -d tmp.XXXXXX)
528 mount -o loop $image $tmp
529 trap "umount $tmp; rmdir $tmp" ERR INT
532 (cd $root && tar cpf - .) | (cd $tmp && tar xpf -)
540 # Fix permissions on tmp directories
541 function pl_fixtmp_permissions() {
543 chmod 1777 $root/tmp $root/usr/tmp $root/var/tmp
546 function pl_fixdirs() {
549 for datadir in datadirs ; do
550 if [ -h ${root}/${datadir} ] ; then
551 rm -f ${root}/${datadir}
552 mkdir -p ${root}/${datadir}
557 ########## .pkgs format
558 # Usage: pl_parsePkgs keyword [-a arch] fcdistro pldistro pkgs-file[..s]
559 # pkgs.py should be found in PATH, like this file build.common
560 # only usage should be for pl_getPackages and pl_getGroups,
561 # which in turn are usednow be in {node,slice}image/build.sh
562 function pl_parsePkgs () {
563 target_arch=$pl_DISTRO_ARCH
565 [ "$1" == "-a" ] && { shift; target_arch="$1"; shift; }
569 echo 1>&2 "pl_parsePkgs: using -a $target_arch -f $fcdistro -d $pldistro $keyword $@"
570 pkgs.py -a $target_arch -f $fcdistro -d $pldistro $keyword "$@"
572 # usage: pl_getPackages [-a arch] fcdistro pldistro pkg-file[..s]
573 function pl_getPackages() { pl_parsePkgs package "$@" ; }
574 function pl_getGroups() { pl_parsePkgs group "$@" ; }
576 ##############################
578 # locates a pldistro-dependant file
579 # tries first in build/<pldistro>/, then in build/planetlab/
580 function pl_locateDistroFile () {
586 # if config dir is missing but a .svnpath or a .gitpath exists, use it to extract the config dir
587 configdir="$builddir/config.${pldistro}"
588 if [ ! -d $configdir ] ; then
589 if [ -f "${configdir}.svnpath" -o -f "${configdir}.gitpath" ] ; then
590 echo 1>&2 "Invoking make to extract remote config.${pldistro}"
591 # we set PLDISTROTAGS here to /dev/null because when dealing with remote distros
592 # at a very early stage (like searching for devel.pkgs even before the build VM is created)
593 # then make screams because it cannot find a mandatory include file
594 # OTOH this mechanism here is not intended to depend on tags specifically
595 make 1>&2 --no-print-directory -C $builddir stage1=true config.${pldistro} PLDISTROTAGS=/dev/null
599 paths="$builddir/config.$pldistro/$pkgsfile $builddir/config.planetlab/$pkgsfile"
600 for path in $paths; do
601 if [ -f $path ] ; then
606 if [ -z "$pkgspath" ] ; then
607 echo 1>&2 "pl_locateDistroFile - in $(pwd) : cannot locate $pkgsfile in $builddir"
608 echo 1>&2 "candidates were $paths"
609 echo "not-found-by-pl_locateDistroFile"
612 echo 1>&2 "pl_locateDistroFile: using $pkgspath"
618 function yumgroups_from_pkgs () {
624 sedargs="-e s,@FCDISTRO@,$fcdistro,g"
627 <?xml version="1.0"?>
628 <!DOCTYPE comps PUBLIC "-//Red Hat, Inc.//DTD Comps info//EN" "comps.dtd">
632 for pkgsname in $pkgsnames; do
633 pkgsfile=$(pl_locateDistroFile $builddir $pldistro $pkgsname)
634 packages=$(pl_getPackages $fcdistro $pldistro $pkgsfile)
636 groupname=$(pkgs.py groupname $pkgsfile | sed $sedargs)
637 groupdesc=$(pkgs.py groupdesc $pkgsfile | sed $sedargs)
639 if [ -z "$groupname" -o -z "$groupdesc" ] ; then
640 echo "Cannot find groupname: and groupdesc: in $pkgsfile -- skipped" 1>&2
644 cat << __group_header
646 <id>$(echo $groupname|tr A-Z a-z)</id>
647 <name>$groupname</name>
648 <description>$groupdesc</description>
649 <uservisible>true</uservisible>
652 for package in $packages; do
653 echo "<packagereq type=\"mandatory\">$package</packagereq>"
655 cat << __group_footer
666 function build_fetch () {
667 curl --fail --silent --max-time 60 --output /dev/null "$1"
670 # tries to compute a valid yum.conf for that pldistro from the template in mirroring/
671 # returns 0 and writes <dest_yumconf> on success
672 # returns 1 on failure, in which case <dest_yumconf> is deleted
673 function yumconf_mirrors () {
674 dest_yumconf=$1; shift
677 yumexclude_line="$1" ; shift
680 template=$builddir/mirroring/$fcdistro/yum.repos.d/building.repo.in
682 if [ ! -f $template ] ; then
683 echo "yumconf_mirrors: cannot locate template $template"
688 for mirror in $mirrors; do
689 if yumconf_mirror $dest_yumconf $template "$yumexclude_line" $mirror; then
693 echo 'yumconf_mirrors in build.common : ran out of mirrors -- BAILING OUT'
698 # computes a yum.conf from the template, and checks that all baseurl defined in there are valid repos
699 # returns 0 on success and 1 on failure
700 function yumconf_mirror () {
701 dest_yumconf=$1; shift
703 yumexclude_line="$1" ; shift
706 sed -e "s,@MIRRORURL@,$mirror,g" \
708 $yumexclude_line" $template > $dest_yumconf
710 # capture all lines defining baseurl
711 baseurl_defs=$(grep '^baseurl=' $dest_yumconf)
712 if [ -z "$baseurl_defs" ] ; then
716 for baseurl_def in $baseurl_defs; do
717 baseurl=$(echo $baseurl_def | sed \
719 -e 's,$basearch,'"$pl_DISTRO_ARCH",g)
720 repomd=$baseurl/repodata/repomd.xml
722 echo "* Trying to fetch $repomd"
723 if ! build_fetch $repomd ; then
724 echo "* Failed to fetch $repomd"
728 echo "* Selected mirror $mirror"
732 # from a yum.conf as generated above, computes the gpgkey urls
733 function yumconf_gpgkey () {
734 dest_yumconf=$1; shift
736 values=$(grep -h '^gpgkey=' $dest_yumconf | sed -e s,gpgkey=,, | sed -e 's,$basearch,'"$pl_DISTRO_ARCH",g | sed -e 's, ,\n,g' | sort | uniq | xargs)
737 [ -n "$values" ] || return 1
742 # patches a yum conf to insert an exclude line in each declared repo
743 function yumconf_exclude () {
745 yumexclude_line="$1" ; shift
747 sed -i -e "/#baseurl=.*$/i\\
748 $yumexclude_line" $repo