3 # Common functions for build scripts used by various packages
4 # incorporated (e.g., build, myplc, myplc-devel, vserver-reference)
6 # Marc E. Fiuczynski <mef@cs.princeton.edu>
7 # Copyright (C) 2007 The Trustees of Princeton University
12 function pl_getDefaultDistro() {
13 # FC4 is currently the default release
18 function pl_getDefaultRelease() {
19 # FC4 is currently the default release
24 function pl_getDistro() {
25 defaultDistro=$(pl_getDefaultDistro)
26 if [ -f "/etc/redhat-release" ] ; then
27 distro=$(awk ' { print $1 } ' /etc/redhat-release)
35 function pl_getRelease() {
36 defaultRelease=$(pl_getDefaultRelease)
37 if [ -f "/etc/redhat-release" ] ; then
38 release=$(awk ' { if ($1=="Fedora" && $2=="Core") print $4 ; if (($1=="Fedora" && $2!="Core")||$1=="CentOS") print $3 } ' /etc/redhat-release)
39 [ $release -lt $defaultRelease ] && release=$defaultRelease
41 release=$defaultRelease
47 # vserver expects something like fc4 or f7
48 # for fedora and centos only for now
49 function pl_getReleaseName () {
54 if [ "$release" -le 6 ] ; then
55 releasename=fc$release
67 releasename="unknown-name-for-${pl_DISTRO}-please-edit-build.common"
68 echo 1>&2 "build.common: WARNING - releasename not set for distro=$distro"
76 # figure out which redhat distro we are using (fedora, centos, redhat)
77 pl_DISTRO=$(pl_getDistro)
79 # select basearch of the host devel environment - protected for macos for local tests
80 pl_DISTRO_ARCH=$(uname -i 2>/dev/null|| echo unknownarch)
82 # the release number (plain number)
83 pl_DISTRO_RELEASE=$(pl_getRelease)
85 # the release name - for vserver build - like fc4, f8 or centos4
86 pl_DISTRO_NAME=$(pl_getReleaseName $pl_DISTRO $pl_DISTRO_RELEASE)
88 # get path to appropriate yumgroups.xml file
89 # Thierry: quick & dirty improvement
90 # this file is updated by the toplevel build, from groups/<pldistro>.xml
91 pl_DISTRO_YUMGROUPS="../../../RPMS/yumgroups.xml"
93 function pl_process_fedora_options () {
96 while getopts "l:r:a:h" opt ; do
100 let shiftcount=$shiftcount+2
103 pl_DISTRO_RELEASE=$OPTARG
104 let shiftcount=$shiftcount+2
107 pl_DISTRO_ARCH=$OPTARG
108 let shiftcount=$shiftcount+2
111 echo "Usage: $0 [OPTION]..."
112 echo " -l url distro mirror location (default: $pl_DISTRO_URL)"
113 echo " -r release distro release number (default: $pl_DISTRO_RELEASE)"
114 echo " -a arch distro architecture (default: $pl_DISTRO_ARCH)"
115 echo "where distro can be either fedora, centos, or redhat"
116 echo " -h This message"
124 ######################################## handling a root image
125 function pl_root_rpm_macros () {
127 %_install_langs C:en_US:en
128 %_netsharedpath /proc:/dev/pts:/usr/share/info
130 %__file_context_path /dev/null
134 function pl_root_makedevs() {
136 # Clean ${vroot}/dev, but only when ${vroot}!=""
137 [ -n $vroot ] && rm -rf $vroot/dev
140 mknod -m 666 $vroot/dev/null c 1 3
141 mknod -m 666 $vroot/dev/zero c 1 5
142 mknod -m 666 $vroot/dev/full c 1 7
143 mknod -m 644 $vroot/dev/random c 1 8
144 mknod -m 644 $vroot/dev/urandom c 1 9
145 mknod -m 666 $vroot/dev/tty c 5 0
146 mknod -m 666 $vroot/dev/ptmx c 5 2
147 # For bash command substitution
148 ln -nsf ../proc/self/fd $vroot/dev/fd
150 # For df and linuxconf
151 touch $vroot/dev/hdv1
154 mkdir -p $vroot/dev/pts
156 # (Might have to remove the following for vserver-reference.)
159 mkdir -p $vroot/dev/shm
162 mkdir -p $vroot/dev/net
163 mknod -m 600 $vroot/dev/net/tun c 10 200
165 # For mkinitrd (in case a kernel is being installed)
166 # As well for loop back mounting within a vserver.
167 for i in $(seq 0 255) ; do
168 mknod -m 640 $vroot/dev/loop$i b 7 $i
172 function mkfedora_usage() {
173 echo "Usage: pl_root_mkfedora [OPTION]... basedir pldistro pkgsfile(s)"
174 echo " -l url Fedora mirror location."
175 echo " Defaults are searched in <pldistro>.mirrors"
176 echo " -v Be verbose"
177 echo " -h This message"
178 echo " target selection (defaults based on current build vserver)"
179 echo " -r release Fedora release number (default: $releasever)"
180 echo " -a arch Fedora architecture (default: $basearch)"
184 function pl_root_mkfedora () {
186 echo "* Entering pl_root_mkfedora" "$@"
188 if [ $UID -ne 0 ] ; then
189 echo "Error: You must run this script as root."
196 # Release and architecture to install : defaults to current vserver's settings or previously parsed fedora_options
197 releasever=$pl_DISTRO_RELEASE
198 basearch=$pl_DISTRO_ARCH
202 while getopts "l:r:a:vh" opt ; do
205 mirrors="$mirrors $OPTARG"
223 shift $(($OPTIND - 1))
224 [[ "$#" -lt 3 ]] && mkfedora_usage
228 vroot=$(cd $vroot && pwd -P)
229 [ -d $vroot ] || mkfedora_usage
232 # parse pkgsfile and add to local vars
233 fcdistro=${pl_DISTRO_NAME}
234 pkgs_packages=$(pl_parsePkgs package $fcdistro $pldistro $pkgsfile)
235 pkgs_groups=$(pl_parsePkgs group $fcdistro $pldistro $pkgsfile)
236 # packages to exclude - obsolete, was maybe useful when installing a group
237 pkgs_excludes=$(pl_parsePkgs exclude $fcdistro $pldistro $pkgsfile)
238 pkgs_junk=$(pl_parsePkgs junk $fcdistro $pldistro $pkgsfile)
239 pkgs_precious=$(pl_parsePkgs precious $fcdistro $pldistro $pkgsfile)
240 # formerly related to mkfedora -k
241 pkgs_kexcludes=$(pl_parsePkgs kexclude $fcdistro $pldistro $pkgsfile)
242 # get mirrors if not specified with -l
243 if [ -z "$mirrors" ] ; then
244 mirrorsfile=$(pl_locateDistroFile ../build/ $pldistro "$pldistro.mirrors")
245 mirrors=$(pl_parsePkgs mirror $fcdistro $pldistro $mirrorsfile)
249 # add them manually as the output of pl_parsePkgs is line-separated
250 if [ -n "$pkgs_kexcludes" ] ; then
251 exclude_kernel="exclude="
252 for kexclude in $pkgs_kexcludes ; do
253 exclude_kernel="$exclude_kernel $kexclude"
257 function mkfedora_fetch ()
259 curl --fail --silent --max-time 60 "$1"
262 # set list of attempted locations according to target distro
263 # xxx all this should go into mirroring/ somehow
266 if [ $releasever -ge 7 ] ; then
267 # Plain Fedora comes with a new layout
269 fedora/releases/$releasever/Everything/$basearch/os
270 linux/releases/$releasever/Everything/$basearch/os
271 $releasever/Everything/$basearch/os
272 core/$releasever/Everything/$basearch/os
273 linux/core/$releasever/$basearch/os
278 fedora/core/$releasever/$basearch/os
279 linux/core/$releasever/$basearch/os
280 core/$releasever/$basearch/os
281 $releasever/$basearch/os
284 public_gpg_key=RPM-GPG-KEY-fedora
288 # you can use vbuild-fedora-mirror with -f centos5.1
289 # which is hard-coded in mirroring/centos as well
290 # for now I do the mapping here, mmhh
294 *) actual=$releasever ;;
297 centos/$actual/os/$basearch
299 public_gpg_key=RPM-GPG-KEY-CentOS-$releasever
302 echo "distro $pl_DISTRO not supported in build.common / mkfedora" ; exit 1
305 echo "$0: candidate mirrors"
306 for mirror in $mirrors ; do
307 echo "* candidate mirror $mirror"
310 for mirror in $mirrors ; do
311 for attempt in $attempts; do
312 attempturl=$mirror/$attempt
313 if mkfedora_fetch $attempturl/repodata/repomd.xml >/dev/null ; then
320 if [ -z "$baseurl" ] ; then
321 echo "Error: $releasever/$basearch/os/repodata/repomd.xml"
322 echo " could not be found in any of the following locations:"
324 for mirror in $mirrors ; do
325 for attempt in $attempts ; do
326 echo $mirror/$attempt
332 echo "* selecting mirror with baseurl=$baseurl"
335 # Do not tolerate errors
338 ## make rpms ignore installing stuff to special fs entries like /proc
339 # Because of https://bugzilla.redhat.com/bugzilla/show_bug.cgi?id=52725
340 # you have to use at least one language beside 'C'
341 # Prevent all locales from being installed in reference image
342 mkdir -p $vroot/etc/rpm
343 pl_root_rpm_macros > $vroot/etc/rpm/macros
345 # Trick rpm and yum, who read the real root /etc/rpm/macros file
346 # rather than the one installed in the reference image, despite what
347 # you might expect the --root and --installroot options to mean. Both
348 # programs always read $HOME/.rpmmacros.
349 export HOME=$vroot/tmp
351 pl_root_rpm_macros > $vroot/tmp/.rpmmacros
353 function mkfedora_cleanup () {
354 umount -l $vroot/proc
355 umount -l $vroot/dev/shm
356 umount -l $vroot/dev/pts
359 # Clean up before exiting if anything goes wrong
360 trap "mkfedora_cleanup" ERR INT
362 # Mount in reference image
363 mount -t devpts none $vroot/dev/pts
364 mount -t tmpfs none $vroot/dev/shm
366 mount -t proc none $vroot/proc
368 # Create a /var/lib dirs for yum & rpm
369 mkdir -p $vroot/var/lib/yum
370 mkdir -p $vroot/var/lib/rpm
371 mkdir -p $vroot/usr/share/info
373 # Create a dummy /etc/fstab in reference image
375 cat >$vroot/etc/fstab <<EOF
376 # This fake fstab exists only to please df and linuxconf.
377 /dev/hdv1 / ext2 defaults 1 1
379 cp $vroot/etc/fstab $vroot/etc/mtab
381 # Necessary for some scripts
382 mkdir -p $vroot/etc/sysconfig
383 echo "NETWORKING=yes" > $vroot/etc/sysconfig/network
385 # Initialize RPM database in reference image
386 mkdir -p $vroot/var/lib/rpm
387 rpm --root $vroot --initdb
388 rpm --root $vroot --import $baseurl/$public_gpg_key
390 # Initialize yum in reference image
391 mkdir -p $vroot/var/cache/yum $vroot/var/log
392 if [ $releasever -lt 7 ] ; then
398 cat >$vroot/etc/yum.conf <<EOF
400 cachedir=/var/cache/yum
402 logfile=/var/log/yum.log
404 distroverpkg=redhat-release
410 # Prevent yum-2.4 from loading additional repository definitions
411 # (e.g., from /etc/yum.repos.d/)
415 name=Fedora ${corename}${releasever} - $basearch - base
420 for optional in updates extras ; do
422 $mirror/linux/core/$optional/$releasever/$basearch \
423 $mirror/core/$optional/$releasever/$basearch \
424 $mirror/linux/$optional/$releasever/$basearch \
425 $mirror/$optional/$releasever/$basearch ; do
426 if mkfedora_fetch $optionalurl/repodata/repomd.xml ; then
427 cat >>$vroot/etc/yum.conf <<EOF
429 [$(basename $optional)]
430 name=Fedora ${corename}${releasever} - $basearch - $(basename $optional)
431 baseurl=$optionalurl/
439 # If we are being built as part of an automated RPM build, solve the
440 # bootstrap problem by including any just built packages in the yum
441 # configuration. This cooperates with the PlanetLab build system.
442 if [ -n "$RPM_BUILD_DIR" ] ; then
443 RPM_RPMS_DIR=$(cd $(dirname $RPM_BUILD_DIR)/RPMS && pwd -P)
444 # If run under sudo, allow user to delete the headers/ and
445 # repodata/ directories.
446 if [ -n "$SUDO_USER" ] ; then
447 chown -R $SUDO_USER $RPM_RPMS_DIR
449 cat >>$vroot/etc/yum.conf <<EOF
452 name=Bootstrap - $basearch - $RPM_RPMS_DIR/
453 baseurl=file://$RPM_RPMS_DIR/
458 for exclude in $pkgs_excludes; do
459 exclude_arg="$exclude_arg --exclude $exclude"
462 # glibc must be specified explicitly for the correct arch to be
464 echo "* Installing glibc"
465 yum -c $vroot/etc/yum.conf --installroot=$vroot -y $exclude_arg install glibc
468 if [ -n "$pkgs_packages" ] ; then
469 echo "* Installing optional packages" $pkgs_packages
470 yum -c $vroot/etc/yum.conf --installroot=$vroot -y $exclude_arg \
471 install $pkgs_packages
472 if ! rpm --root $vroot -q $pkgs_packages >/dev/null ; then
473 echo "* Warning: Missing packages"
474 rpm --root $vroot -q $pkgs_packages | grep "not installed"
478 if [ -n "$pkgs_groups" ] ; then
479 ## call yum sequentially to get finer-grained info on dependencies
480 for grp in $pkgs_groups ; do
481 echo "* Installing optional group $grp"
482 yum -c $vroot/etc/yum.conf --installroot=$vroot -y $exclude_arg \
487 # formerly in bootcd/prep.sh : to optimize footprint
488 if [ -n "$pkgs_junk" ] ; then
489 echo "* Removing unnecessary junk"
491 # Save precious files
492 [ -n "$pkgs_precious" ] && tar --ignore-failed-read -cpf precious.tar $pkgs_precious
493 # Remove unnecessary junk
494 [ -n "$pkgs_junk" ] && rm -rf $pkgs_junk
495 # Restore precious files
496 [ -n "$pkgs_precious" ] && tar -xpf precious.tar && rm -f precious.tar
502 yum -c $vroot/etc/yum.conf --installroot=$vroot -y clean all
505 rm -f $vroot/var/lib/rpm/__db*
507 # Set time zone to UTC
508 if [ -f $vroot/usr/share/zoneinfo/UTC -a -f $vroot/etc/localtime ] ; then
509 rm -f $vroot/etc/localtime
510 ln -s /usr/share/zoneinfo/UTC $vroot/etc/localtime
513 # remove trap handler, as we are about to call it directly.
522 function pl_root_tune_image () {
525 # Disable all services in reference image
526 chroot $root sh -c "/sbin/chkconfig --list | awk '{ print \$1 }' | xargs -i /sbin/chkconfig {} off"
528 # FC2 minilogd starts up during shutdown and makes unmounting
529 # impossible. Just get rid of it.
530 rm -f $root/sbin/minilogd
531 ln -nsf /bin/true $root/sbin/minilogd
533 # This tells the Boot Manager that it is okay to update
534 # /etc/resolv.conf and /etc/hosts whenever the network configuration
535 # changes. Users are free to delete this file.
536 touch $root/etc/AUTO_UPDATE_NET_FILES
539 # Move specified directories out of a src tree into a dst tree, and
540 # then for each moved directory create a symlink in src to dst.
541 function pl_move_dirs() {
548 for datadir in "$@" ; do
549 mkdir -p ${data}${datadir}
550 if [ -d ${root}/${datadir} -a ! -h ${root}/${datadir} ] ; then
551 (cd ${root} && find ./${datadir} | cpio -p -d -u ../${data}/)
553 rm -rf ${root}/${datadir}
554 mkdir -p $(dirname ${root}/${datadir})
555 ln -nsf ${store}/${datadir} ${root}/${datadir}
559 # Construct an image file from given some directory
560 # XXX in the future maybe use livecdtools?
561 function pl_make_image() {
566 # Leave about 100 MB free space and allow for about 20% inode overhead
567 bytes=$((($(du -sb $root | cut -f1) + $extraspace) * 120 / 100))
569 blocks=$(($bytes / $bs))
570 dd bs=$bs count=$blocks if=/dev/zero of=$image
571 mkfs.ext3 -b $bs -j -F $image
573 # Temporarily mount it
574 tmp=$(mktemp -d tmp.XXXXXX)
575 mount -o loop $image $tmp
576 trap "umount $tmp; rmdir $tmp" ERR INT
579 (cd $root && tar cpf - .) | (cd $tmp && tar xpf -)
587 # Fix permissions on tmp directories
588 function pl_fixtmp_permissions() {
590 chmod 1777 $root/tmp $root/usr/tmp $root/var/tmp
593 function pl_fixdirs() {
596 for datadir in datadirs ; do
597 if [ -h ${root}/${datadir} ] ; then
598 rm -f ${root}/${datadir}
599 mkdir -p ${root}/${datadir}
604 ########## .pkgs format
605 # comments start with a # - this is needed only if you use a keyword in a comment
607 function pl_getPkgsAttribute () {
610 # remove any initial white spaces from the result
611 grep -v '^#' $file | grep --regexp="^${keyword}:" | sed -e "s,${keyword}:,," -e "s,^[[:space:]][[:space:]]*,,"
614 # for a given keyword like 'package' :
615 # we support fcdistro-dependant format, for tokens (pkgname) without whitespace
617 # package: pkg1 .. pkgn
618 # package+f8: pkg1 .. pkgn
619 # package-f8: pkg1 .. pkgn
621 # values can contain @arch@, @fcdistro@ or @pldistro@ that are replaced with the current values
623 function pl_parsePkgs () {
628 # remaining arguments are paths to the pkgs files
630 # grab regular descriptions
631 all=$(grep -v '^#' "$@" | grep --regexp="^${keyword}:" | sed -e "s,${keyword}:,,")
633 add=$(grep -v '^#' "$@" | grep --regexp="^${keyword}+${fcdistro}:" | sed -e "s,${keyword}+${fcdistro}:,,")
635 sub=$(grep -v '^#' "$@" | grep --regexp="^${keyword}-${fcdistro}:" | sed -e "s,${keyword}-${fcdistro}:,,")
637 for i in $all $add; do
638 for exclude in $sub; do
639 [ "$i" = "$exclude" ] && continue 2
641 echo "$i " | sed -e "s,@arch@,$pl_DISTRO_ARCH,g" -e "s,@fcdistro@,$fcdistro,g" -e "s,@pldistro@,$pldistro,g"
646 function pl_getPackages() { fcdistro=$1; shift ; pldistro=$1; shift ; pl_parsePkgs package $fcdistro $pldistro "$@" ; }
647 function pl_getGroups() { fcdistro=$1; shift ; pldistro=$1; shift ; pl_parsePkgs group $fcdistro $pldistro "$@" ; }
649 # locates a pldistro-dependant file
650 # tries first in build/<pldistro>/, then in build/planetlab/
651 function pl_locateDistroFile () {
658 paths="$builddir/config.$pldistro/$pkgsfile $builddir/config.planetlab/$pkgsfile"
659 for path in $paths; do
660 if [ -f $path ] ; then
665 if [ -z "$pkgspath" ] ; then
666 echo 1>&2 "pl_locateDistroFile - in $(pwd) : cannot locate $pkgsfile in $builddir"
667 echo 1>&2 "candidates were $paths"
668 echo "not-found-by-pl_locateDistroFile"
671 echo 1>&2 "pl_locateDistroFile: using $pkgspath"
677 function yumgroups_from_pkgs () {
683 sedargs="-e s,@FCDISTRO@,$fcdistro,g"
686 <?xml version="1.0"?>
687 <!DOCTYPE comps PUBLIC "-//Red Hat, Inc.//DTD Comps info//EN" "comps.dtd">
691 for pkgsname in $pkgsnames; do
692 pkgsfile=$(pl_locateDistroFile $builddir $pldistro $pkgsname)
693 packages=$(pl_getPackages $fcdistro $pldistro $pkgsfile)
695 groupname=$(pl_getPkgsAttribute groupname $pkgsfile | sed $sedargs)
696 groupdesc=$(pl_getPkgsAttribute groupdesc $pkgsfile | sed $sedargs)
698 if [ -z "$groupname" -o -z "$groupdesc" ] ; then
699 echo "Cannot find groupname: and groupdesc: in $pkgsfile -- skipped" 1>&2
703 cat << __group_header
705 <id>$(echo $groupname|tr A-Z a-z)</id>
706 <name>$groupname</name>
707 <description>$groupdesc</description>
708 <uservisible>true</uservisible>
711 for package in $packages; do
712 echo "<packagereq type=\"mandatory\">$package</packagereq>"
714 cat << __group_footer