6 # Common functions for build scripts used by various packages
7 # incorporated (e.g., build, myplc, myplc-devel, vserver-reference)
9 # Marc E. Fiuczynski <mef@cs.princeton.edu>
10 # Copyright (C) 2007 The Trustees of Princeton University
12 # supported distros f8, f10, f12, centos5
14 # for locating pkgs.py
17 # returns 'Fedora' or 'CentOS' for now
18 function pl_getDistro() {
19 if [ -f "/etc/redhat-release" ] ; then
20 distro=$(awk ' { print $1 } ' /etc/redhat-release)
21 case $distro in Scientific*) distro="SL" ; esac
23 echo "build.common.pl_getDistro-unknown"
30 # returns something like 8, 10, or 5.3
31 function pl_getRelease() {
32 if [ -f "/etc/redhat-release" ] ; then
33 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)
35 echo "build.common.pl_getRelease-unknown"
38 # keep only the major number
39 echo "$release" | cut -d. -f1
43 # returns stuff for vserver, i.e. something like 'f8' or 'centos5'
44 function pl_getReleaseName () {
59 releasename=sl$release
62 releasename="unknown-name-for-${pl_DISTRO}-please-edit-build.common"
63 echo 1>&2 "build.common: WARNING - releasename not set for distro=$distro"
71 # on fedora 8 or above, we use libnl from the stock repos
72 # on centos5 we build it locally
73 function pl_getKexcludes () {
76 ### there is an ugly hack going on around here
77 # with f12, the dependencies somehow require kernel 2.6.29 but our own kernel is 2.6.27
78 # so the ugly workaround here is to let 'kernel-debug' get installed from the stock repos
79 # we then remove it manually after the image is done, look for kernel-debug below
80 # relyong on kernel-PAE for this trick won't work, as 64 bits distros don't have PAE of course
82 echo 'kernel kernel-PAE kernel-PAEdebug kernel-vserver kernel-devel kernel-headers kernel-debuginfo util-vserver* iptables iptables-ipv6 iproute drupal' ;;
84 echo 'kernel kernel-vserver kernel-devel kernel-headers kernel-debuginfo util-vserver* iptables iproute drupal inotify-tools* libnl' ;;
86 echo 'kernel kernel-debug kernel-debug-devel kernel-devel kernel-doc kernel-firmware kernel-headers iptables iproute' ;;
88 echo "pl_DISTRO_NAME=$pl_DISTRO_NAME not supported in getexcludes.sh" ; exit 1 ;;
92 # figure out which redhat distro we are using (fedora, centos, redhat)
93 pl_DISTRO=$(pl_getDistro)
95 # select basearch of the host devel environment - protected for macos for local tests
96 pl_DISTRO_ARCH=$(uname -i 2>/dev/null|| echo unknownarch)
98 # the release number (plain number)
99 pl_DISTRO_RELEASE=$(pl_getRelease)
101 # the release name - for vserver build ...
102 pl_DISTRO_NAME=$(pl_getReleaseName $pl_DISTRO $pl_DISTRO_RELEASE)
104 # the packages to exclude
105 pl_KEXCLUDES=$(pl_getKexcludes $pl_DISTRO_NAME)
107 # get path to appropriate yumgroups.xml file
108 # Thierry: quick & dirty improvement
109 # this file is updated by the toplevel build, from the .pkgs files
110 pl_DISTRO_YUMGROUPS="../../../RPMS/yumgroups.xml"
112 function pl_process_fedora_options () {
115 while getopts "l:r:a:h" opt ; do
118 pl_DISTRO_URL=$OPTARG
119 let shiftcount=$shiftcount+2
122 pl_DISTRO_RELEASE=$OPTARG
123 let shiftcount=$shiftcount+2
126 pl_DISTRO_ARCH=$OPTARG
127 let shiftcount=$shiftcount+2
130 echo "Usage: $0 [OPTION]..."
131 echo " -l url distro mirror location (default: $pl_DISTRO_URL)"
132 echo " -r release distro release number (default: $pl_DISTRO_RELEASE)"
133 echo " -a arch distro architecture (default: $pl_DISTRO_ARCH)"
134 echo "where distro can be either fedora, centos, or redhat"
135 echo " -h This message"
143 ######################################## handling a root image
144 function pl_root_rpm_macros () {
146 %_install_langs C:en_US:en
147 %_netsharedpath /proc:/dev/pts:/usr/share/info
149 %__file_context_path /dev/null
153 function pl_root_makedevs() {
155 # Clean ${vroot}/dev, but only when ${vroot}!=""
156 [ -n $vroot ] && rm -rf $vroot/dev
159 mknod -m 666 $vroot/dev/null c 1 3
160 mknod -m 666 $vroot/dev/zero c 1 5
161 mknod -m 666 $vroot/dev/full c 1 7
162 mknod -m 644 $vroot/dev/random c 1 8
163 mknod -m 644 $vroot/dev/urandom c 1 9
164 mknod -m 666 $vroot/dev/tty c 5 0
165 mknod -m 666 $vroot/dev/ptmx c 5 2
166 # For bash command substitution
167 ln -nsf ../proc/self/fd $vroot/dev/fd
169 # For df and linuxconf
170 touch $vroot/dev/hdv1
173 mkdir -p $vroot/dev/pts
175 # (Might have to remove the following for vserver-reference.)
178 mkdir -p $vroot/dev/shm
181 mkdir -p $vroot/dev/net
182 mknod -m 600 $vroot/dev/net/tun c 10 200
184 # For mkinitrd (in case a kernel is being installed)
185 # As well as for loop back mounting within a vserver.
186 for i in $(seq 0 255) ; do
187 mknod -m 640 $vroot/dev/loop$i b 7 $i
191 function mkfedora_usage() {
192 echo "Usage: pl_root_mkfedora [OPTION]... basedir pldistro pkgsfile(s)"
193 echo " -l url Fedora mirror location."
194 echo " Defaults are searched in <pldistro>.mirrors"
195 echo " -v Be verbose"
196 echo " -h This message"
197 echo " target selection (defaults based on current build vserver)"
198 echo " -r release Fedora release number (default: $releasever)"
199 echo " -a arch Fedora architecture (default: $basearch)"
203 function pl_root_mkfedora () {
205 echo "* Entering pl_root_mkfedora" "$@"
207 if [ $UID -ne 0 ] ; then
208 echo "Error: You must run this script as root."
215 # Release and architecture to install : defaults to current vserver's settings or previously parsed fedora_options
216 releasever=$pl_DISTRO_RELEASE
217 basearch=$pl_DISTRO_ARCH
220 while getopts "vh" opt ; do
222 v) verbose=1; set -x ;;
223 h|*) mkfedora_usage ;;
227 shift $(($OPTIND - 1))
228 [[ "$#" -lt 3 ]] && mkfedora_usage
232 vroot=$(cd $vroot && pwd -P)
233 [ -d $vroot ] || mkfedora_usage
236 # parse pkgsfile and add to local vars
237 fcdistro=${pl_DISTRO_NAME}
238 pkgs_packages=$(pl_parsePkgs package $fcdistro $pldistro $pkgsfile)
239 pkgs_groups=$(pl_parsePkgs group $fcdistro $pldistro $pkgsfile)
240 # what can get trashed to save space
241 pkgs_junk=$(pl_parsePkgs junk $fcdistro $pldistro $pkgsfile)
243 pkgs_precious=$(pl_parsePkgs precious $fcdistro $pldistro $pkgsfile)
244 # formerly related to mkfedora -k : packages to take from our own build
245 # and thus need be excluded frem the stock repos
246 pkgs_kexcludes=$(pl_parsePkgs kexclude $fcdistro $pldistro $pkgsfile | sed -e s,@KEXCLUDE@,"$pl_KEXCLUDES",)
247 # get mirrors if not specified with -l
248 if [ -z "$mirrors" ] ; then
249 mirrorsfile=$(pl_locateDistroFile ../build/ $pldistro "$pldistro.mirrors")
250 mirrors=$(pl_parsePkgs mirror $fcdistro $pldistro $mirrorsfile)
254 [ -n "$pkgs_kexcludes" ] && kexclude_line="exclude=$pkgs_kexcludes"
256 echo "$0: candidate mirrors"
257 for mirror in $mirrors ; do
258 echo "* candidate mirror $mirror"
261 # the repo part of the final yum.conf
262 yum_conf_repos=$vroot/xxxmkfedora-repos.confxxx
263 if ! yumconf_mirrors $yum_conf_repos ../build/ $fcdistro "$kexclude_line" $mirrors ; then
264 echo xxx -- error ; return 1
267 # Do not tolerate errors
270 public_gpg_key=$(yumconf_gpgkey $yum_conf_repos)
272 ## make rpms ignore installing stuff to special fs entries like /proc
273 # Because of https://bugzilla.redhat.com/bugzilla/show_bug.cgi?id=52725
274 # you have to use at least one language beside 'C'
275 # Prevent all locales from being installed in reference image
276 mkdir -p $vroot/etc/rpm
277 pl_root_rpm_macros > $vroot/etc/rpm/macros
279 # Trick rpm and yum, who read the real root /etc/rpm/macros file
280 # rather than the one installed in the reference image, despite what
281 # you might expect the --root and --installroot options to mean. Both
282 # programs always read $HOME/.rpmmacros.
283 export HOME=$vroot/tmp
285 pl_root_rpm_macros > $vroot/tmp/.rpmmacros
287 function mkfedora_cleanup () {
288 umount -l $vroot/proc
289 umount -l $vroot/dev/shm
290 umount -l $vroot/dev/pts
293 # Clean up before exiting if anything goes wrong
294 trap "mkfedora_cleanup" ERR INT
296 # Mount in reference image
297 mount -t devpts none $vroot/dev/pts
298 mount -t tmpfs none $vroot/dev/shm
300 mount -t proc none $vroot/proc
302 # Create a /var/lib dirs for yum & rpm
303 mkdir -p $vroot/var/lib/yum
304 mkdir -p $vroot/var/lib/rpm
305 mkdir -p $vroot/usr/share/info
307 # Create a dummy /etc/fstab in reference image
309 cat >$vroot/etc/fstab <<EOF
310 # This fake fstab exists only to please df and linuxconf.
311 /dev/hdv1 / ext2 defaults 1 1
313 cp $vroot/etc/fstab $vroot/etc/mtab
315 # Necessary for some scripts
316 mkdir -p $vroot/etc/sysconfig
317 echo "NETWORKING=yes" > $vroot/etc/sysconfig/network
319 # Initialize RPM database in reference image
320 mkdir -p $vroot/var/lib/rpm
321 rpm --root $vroot --initdb
322 rpm --root $vroot --import $public_gpg_key
324 echo "rpm --root $vroot --import $public_gpg_key"
326 # Initialize yum in reference image
327 mkdir -p $vroot/var/cache/yum $vroot/var/log
329 # yum.conf is for building only - store in different location than /etc/yum.conf
330 yum_conf=$vroot/etc/mkfedora-yum.conf
331 cat > $yum_conf <<EOF
333 cachedir=/var/cache/yum
335 logfile=/var/log/yum.log
338 distroverpkg=redhat-release
344 # Prevent yum-2.4 from loading additional repository definitions
345 # (e.g., from /etc/yum.repos.d/)
349 cat $yum_conf_repos >> $yum_conf
351 # If we are being built as part of an automated RPM build, solve the
352 # bootstrap problem by including any just built packages in the yum
353 # configuration. This cooperates with the PlanetLab build system.
354 if [ -n "$RPM_BUILD_DIR" ] ; then
355 RPM_RPMS_DIR=$(cd $(dirname $RPM_BUILD_DIR)/RPMS && pwd -P)
356 # If run under sudo, allow user to delete the headers/ and
357 # repodata/ directories.
358 if [ -n "$SUDO_USER" ] ; then
359 chown -R $SUDO_USER $RPM_RPMS_DIR
361 cat >> $yum_conf <<EOF
364 name=Building - $basearch - $RPM_RPMS_DIR/
365 baseurl=file://$RPM_RPMS_DIR/
369 echo "========== Dumping $yum_conf"
371 echo "========== EndDump $yum_conf"
374 # yum --help | grep verbose &> /dev/null && yum_options="$yum_options --verbose"
375 yum_options="$yum_options -y"
376 yum_options="$yum_options -c $yum_conf"
377 yum_options="$yum_options --installroot=$vroot"
379 # glibc must be specified explicitly for the correct arch to be
381 echo "* Installing glibc"
382 # ignore yum's return code that is basically undefined
383 yum $yum_options install glibc || :
386 if [ -n "$pkgs_packages" ] ; then
387 echo "* Installing optional packages" $pkgs_packages
388 # ignore yum's return code that is basically undefined
389 echo "* Install options" $vroot $yum_options
390 yum $yum_options install $pkgs_packages || :
391 if ! rpm --root $vroot -q $pkgs_packages >/dev/null ; then
392 echo "* Warning: Missing packages"
393 rpm --root $vroot -q $pkgs_packages | grep "not installed"
397 if [ -n "$pkgs_groups" ] ; then
398 ## call yum sequentially to get finer-grained info on dependencies
399 for group_plus in $pkgs_groups ; do
400 group=$(echo $group_plus | sed -e "s,+++, ,g")
401 echo "* Installing optional group $group"
402 # ignore yum's return code that is basically undefined
403 yum $yum_options groupinstall "$group" || :
407 # formerly in bootcd/prep.sh : to optimize footprint
408 if [ -n "$pkgs_junk" ] ; then
409 echo "* Removing unnecessary junk"
411 # Save precious files
412 [ -n "$pkgs_precious" ] && tar --ignore-failed-read -cpf precious.tar $pkgs_precious
413 # Remove unnecessary junk
414 [ -n "$pkgs_junk" ] && rm -rf $pkgs_junk
415 # Restore precious files
416 [ -n "$pkgs_precious" ] && tar -xpf precious.tar && rm -f precious.tar
423 # NOTE: this hack is for Fedora >= 12.
424 # if kernel-debug is installed, clean it up
425 # we link to our version of kernel/initrd and clean up
426 # kernel-debug manually
427 if rpm --root $vroot --quiet -q kernel-debug ; then
428 echo "* Cleaning up kernel-debug - (workaround for f12)"
430 rm -rf kernel-boot kernel-bootsmp initrd-boot initrd-bootsmp
431 ln -s vmlinuz-*${pldistro}* kernel-boot
432 ln -s vmlinuz-*${pldistro}* kernel-bootsmp
433 ln -s initrd-*${pldistro}* initrd-boot
434 ln -s initrd-*${pldistro}* initrd-bootsmp
435 rpm --root $vroot --nodeps -e kernel-debug || :
439 # ignore yum's return code that is basically undefined
440 yum $yum_options clean all || :
443 rm -f $vroot/var/lib/rpm/__db*
445 # Set time zone to UTC
446 if [ -f $vroot/usr/share/zoneinfo/UTC -a -f $vroot/etc/localtime ] ; then
447 rm -f $vroot/etc/localtime
448 ln -s /usr/share/zoneinfo/UTC $vroot/etc/localtime
451 echo "Dumping current list of rpms in /etc/mkfedora-rpms.txt"
452 chroot $vroot rpm -aq | sort > $vroot/etc/mkfedora-rpms.txt
454 # remove trap handler, as we are about to call it directly.
463 function pl_root_tune_image () {
466 # Disable all services in reference image
467 chroot $root sh -c "/sbin/chkconfig --list | awk '{ print \$1 }' | xargs -i /sbin/chkconfig {} off"
469 # FC2 minilogd starts up during shutdown and makes unmounting
470 # impossible. Just get rid of it.
471 rm -f $root/sbin/minilogd
472 ln -nsf /bin/true $root/sbin/minilogd
474 # This tells the Boot Manager that it is okay to update
475 # /etc/resolv.conf and /etc/hosts whenever the network configuration
476 # changes. Users are free to delete this file.
477 touch $root/etc/AUTO_UPDATE_NET_FILES
480 # Move specified directories out of a src tree into a dst tree, and
481 # then for each moved directory create a symlink in src to dst.
482 function pl_move_dirs() {
489 for datadir in "$@" ; do
490 mkdir -p ${data}${datadir}
491 if [ -d ${root}/${datadir} -a ! -h ${root}/${datadir} ] ; then
492 (cd ${root} && find ./${datadir} | cpio -p -d -u ../${data}/)
494 rm -rf ${root}/${datadir}
495 mkdir -p $(dirname ${root}/${datadir})
496 ln -nsf ${store}/${datadir} ${root}/${datadir}
500 # Construct an image file from given some directory
501 # XXX in the future maybe use livecdtools?
502 function pl_make_image() {
507 # Leave about 100 MB free space and allow for about 20% inode overhead
508 bytes=$((($(du -sb $root | cut -f1) + $extraspace) * 120 / 100))
510 blocks=$(($bytes / $bs))
511 dd bs=$bs count=$blocks if=/dev/zero of=$image
512 mkfs.ext3 -b $bs -j -F $image
514 # Temporarily mount it
515 tmp=$(mktemp -d tmp.XXXXXX)
516 mount -o loop $image $tmp
517 trap "umount $tmp; rmdir $tmp" ERR INT
520 (cd $root && tar cpf - .) | (cd $tmp && tar xpf -)
528 # Fix permissions on tmp directories
529 function pl_fixtmp_permissions() {
531 chmod 1777 $root/tmp $root/usr/tmp $root/var/tmp
534 function pl_fixdirs() {
537 for datadir in datadirs ; do
538 if [ -h ${root}/${datadir} ] ; then
539 rm -f ${root}/${datadir}
540 mkdir -p ${root}/${datadir}
545 ########## .pkgs format
546 # Usage: pl_parsePkgs keyword [-a arch] fcdistro pldistro pkgs-file[..s]
547 # pkgs.py should be found in PATH, like this file build.common
548 function pl_parsePkgs () {
549 target_arch=$pl_DISTRO_ARCH
551 [ "$1" == "-a" ] && { shift; target_arch="$1"; shift; }
555 pkgs.py -a $target_arch -f $fcdistro -d $pldistro $keyword "$@"
557 # usage: pl_getPackages [-a arch] fcdistro pldistro pkg-file[..s]
558 function pl_getPackages() { pl_parsePkgs package "$@" ; }
559 function pl_getGroups() { pl_parsePkgs group "$@" ; }
561 ##############################
562 ### temporary - only for checking the new python version
563 # for a given keyword like 'package' :
564 # we support fcdistro-dependant format, for tokens (pkgname) without whitespace
566 # package: pkg1 .. pkgn
567 # package+f8: pkg1 .. pkgn
568 # package-f8: pkg1 .. pkgn
570 # values can contain @arch@, @fcdistro@ or @pldistro@ that are replaced with the current values
572 # the reason for the -a option is for when we build the build vserver itself; in this case
573 # pl_DISTRO_ARCH is the one we obtain from the root context, and that's wrong
574 # specify -sa arch AFTER keyword, so as to keep pl_getPackages and pl_getGroups simple
576 function pl_parsePkgs_old () {
578 target_arch=$pl_DISTRO_ARCH
580 [ "$1" == "-a" ] && { shift; target_arch="$1"; shift; }
583 # remaining arguments are paths to the pkgs files
585 # grab regular descriptions
586 all=$(grep -v '^#' "$@" | grep --regexp="^${keyword}:" | sed -e "s,${keyword}:,,")
588 add=$(grep -v '^#' "$@" | grep --regexp="^${keyword}+${fcdistro}:" | sed -e "s,${keyword}+${fcdistro}:,,")
590 sub=$(grep -v '^#' "$@" | grep --regexp="^${keyword}-${fcdistro}:" | sed -e "s,${keyword}-${fcdistro}:,,")
592 for rpm in $all $add; do
593 for exclude in $sub; do
594 [ "$rpm" = "$exclude" ] && continue 2
596 echo "${rpm} " | sed -e "s,@arch@,${target_arch},g" -e "s,@fcdistro@,$fcdistro,g" -e "s,@pldistro@,$pldistro,g"
600 ##############################
602 # locates a pldistro-dependant file
603 # tries first in build/<pldistro>/, then in build/planetlab/
604 function pl_locateDistroFile () {
610 # if config dir is missing but a .svnpath or a .gitpath exists, use it to extract the config dir
611 configdir="$builddir/config.${pldistro}"
612 if [ ! -d $configdir ] ; then
613 if [ -f "${configdir}.svnpath" -o -f "${configdir}.gitpath" ] ; then
614 echo 1>&2 "Invoking make to extract remote config.${pldistro}"
615 make 1>&2 --silent --no-print-directory -C $builddir stage1=true config.${pldistro}
619 paths="$builddir/config.$pldistro/$pkgsfile $builddir/config.planetlab/$pkgsfile"
620 for path in $paths; do
621 if [ -f $path ] ; then
626 if [ -z "$pkgspath" ] ; then
627 echo 1>&2 "pl_locateDistroFile - in $(pwd) : cannot locate $pkgsfile in $builddir"
628 echo 1>&2 "candidates were $paths"
629 echo "not-found-by-pl_locateDistroFile"
632 echo 1>&2 "pl_locateDistroFile: using $pkgspath"
638 function yumgroups_from_pkgs () {
644 sedargs="-e s,@FCDISTRO@,$fcdistro,g"
647 <?xml version="1.0"?>
648 <!DOCTYPE comps PUBLIC "-//Red Hat, Inc.//DTD Comps info//EN" "comps.dtd">
652 for pkgsname in $pkgsnames; do
653 pkgsfile=$(pl_locateDistroFile $builddir $pldistro $pkgsname)
654 packages=$(pl_getPackages $fcdistro $pldistro $pkgsfile)
656 groupname=$(pkgs.py groupname $pkgsfile | sed $sedargs)
657 groupdesc=$(pkgs.py groupdesc $pkgsfile | sed $sedargs)
659 if [ -z "$groupname" -o -z "$groupdesc" ] ; then
660 echo "Cannot find groupname: and groupdesc: in $pkgsfile -- skipped" 1>&2
664 cat << __group_header
666 <id>$(echo $groupname|tr A-Z a-z)</id>
667 <name>$groupname</name>
668 <description>$groupdesc</description>
669 <uservisible>true</uservisible>
672 for package in $packages; do
673 echo "<packagereq type=\"mandatory\">$package</packagereq>"
675 cat << __group_footer
686 function build_fetch () {
687 curl --fail --silent --max-time 60 --output /dev/null "$1"
690 # tries to compute a valid yum.conf for that pldistro from the template in mirroring/
691 # returns 0 and writes <dest_yumconf> on success
692 # returns 1 on failure, in which case <dest_yumconf> is deleted
693 function yumconf_mirrors () {
694 dest_yumconf=$1; shift
697 kexclude_line="$1" ; shift
700 template=$builddir/mirroring/$fcdistro/yum.repos.d/building.repo.in
702 if [ ! -f $template ] ; then
703 echo "yumconf_mirrors: cannot locate template $template"
708 for mirror in $mirrors; do
709 if yumconf_mirror $dest_yumconf $template "$kexclude_line" $mirror; then
713 echo 'yumconf_mirrors in build.common : ran out of mirrors -- BAILING OUT'
718 # computes a yum.conf from the template, and checks that all baseurl defined in there are valid repos
719 # returns 0 on success and 1 on failure
720 function yumconf_mirror () {
721 dest_yumconf=$1; shift
723 kexclude_line="$1" ; shift
726 sed -e "s,@MIRRORURL@,$mirror,g" \
728 $kexclude_line" $template > $dest_yumconf
730 # capture all lines defining baseurl
731 baseurl_defs=$(grep '^baseurl=' $dest_yumconf)
732 if [ -z "$baseurl_defs" ] ; then
736 for baseurl_def in $baseurl_defs; do
737 baseurl=$(echo $baseurl_def | sed \
739 -e 's,$basearch,'"$pl_DISTRO_ARCH",g)
740 repomd=$baseurl/repodata/repomd.xml
742 echo "* Trying to fetch $repomd"
743 if ! build_fetch $repomd ; then
744 echo "* Failed to fetch $repomd"
748 echo "* Selected mirror $mirror"
752 # from a yum.conf as generated above, computes the (first) gpgkey url
753 function yumconf_gpgkey () {
754 dest_yumconf=$1; shift
756 first_line=$(grep '^gpgkey=' $dest_yumconf | head -1)
757 values=$(echo $first_line | sed -e s,gpgkey=,,)
758 value=$(echo $values | sed -e 's,$basearch,'"$pl_DISTRO_ARCH",g)
759 [ -n "$value" ] || return 1
764 # patches a yum conf to insert an exclude line in each declared repo
765 function yumconf_exclude () {
767 kexclude_line="$1" ; shift
769 sed -i -e "/#baseurl=.*$/i\\
770 $kexclude_line" $repo