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 ### xxx thierry : looks like we should bump this to fedora 8
13 ### however, rather than the actual default,
14 ### this looks more like the bottom of what we're able to build
15 ### so I leave it with fc4
16 function pl_getDefaultDistro() {
17 # FC4 is currently the default release
22 function pl_getDefaultRelease() {
23 # FC4 is currently the default release
28 function pl_getDistro() {
29 defaultDistro=$(pl_getDefaultDistro)
30 if [ -f "/etc/redhat-release" ] ; then
31 distro=$(awk ' { print $1 } ' /etc/redhat-release)
39 ### xxx thierry : when running in a centOS box, this issues a warning message
40 ### because 5.2 is not an integer and bash cannot compare that
41 ### seems harmless though
42 function pl_getRelease() {
43 defaultRelease=$(pl_getDefaultRelease)
44 if [ -f "/etc/redhat-release" ] ; then
45 release=$(awk ' { if ($1=="Fedora" && $2=="Core") print $4 ; if (($1=="Fedora" && $2!="Core")||$1=="CentOS") print $3 } ' /etc/redhat-release)
46 [ $release -lt $defaultRelease ] && release=$defaultRelease
48 release=$defaultRelease
54 # vserver expects something like fc4 or f7
55 # for fedora and centos only for now
56 function pl_getReleaseName () {
61 if [ "$release" -le 6 ] ; then
62 releasename=fc$release
74 releasename="unknown-name-for-${pl_DISTRO}-please-edit-build.common"
75 echo 1>&2 "build.common: WARNING - releasename not set for distro=$distro"
83 # figure out which redhat distro we are using (fedora, centos, redhat)
84 pl_DISTRO=$(pl_getDistro)
86 # select basearch of the host devel environment - protected for macos for local tests
87 pl_DISTRO_ARCH=$(uname -i 2>/dev/null|| echo unknownarch)
89 # the release number (plain number)
90 pl_DISTRO_RELEASE=$(pl_getRelease)
92 # the release name - for vserver build - like fc4, f8 or centos4
93 pl_DISTRO_NAME=$(pl_getReleaseName $pl_DISTRO $pl_DISTRO_RELEASE)
95 # get path to appropriate yumgroups.xml file
96 # Thierry: quick & dirty improvement
97 # this file is updated by the toplevel build, from groups/<pldistro>.xml
98 pl_DISTRO_YUMGROUPS="../../../RPMS/yumgroups.xml"
100 function pl_process_fedora_options () {
103 while getopts "l:r:a:h" opt ; do
106 pl_DISTRO_URL=$OPTARG
107 let shiftcount=$shiftcount+2
110 pl_DISTRO_RELEASE=$OPTARG
111 let shiftcount=$shiftcount+2
114 pl_DISTRO_ARCH=$OPTARG
115 let shiftcount=$shiftcount+2
118 echo "Usage: $0 [OPTION]..."
119 echo " -l url distro mirror location (default: $pl_DISTRO_URL)"
120 echo " -r release distro release number (default: $pl_DISTRO_RELEASE)"
121 echo " -a arch distro architecture (default: $pl_DISTRO_ARCH)"
122 echo "where distro can be either fedora, centos, or redhat"
123 echo " -h This message"
131 ######################################## handling a root image
132 function pl_root_rpm_macros () {
134 %_install_langs C:en_US:en
135 %_netsharedpath /proc:/dev/pts:/usr/share/info
137 %__file_context_path /dev/null
141 function pl_root_makedevs() {
143 # Clean ${vroot}/dev, but only when ${vroot}!=""
144 [ -n $vroot ] && rm -rf $vroot/dev
147 mknod -m 666 $vroot/dev/null c 1 3
148 mknod -m 666 $vroot/dev/zero c 1 5
149 mknod -m 666 $vroot/dev/full c 1 7
150 mknod -m 644 $vroot/dev/random c 1 8
151 mknod -m 644 $vroot/dev/urandom c 1 9
152 mknod -m 666 $vroot/dev/tty c 5 0
153 mknod -m 666 $vroot/dev/ptmx c 5 2
154 # For bash command substitution
155 ln -nsf ../proc/self/fd $vroot/dev/fd
157 # For df and linuxconf
158 touch $vroot/dev/hdv1
161 mkdir -p $vroot/dev/pts
163 # (Might have to remove the following for vserver-reference.)
166 mkdir -p $vroot/dev/shm
169 mkdir -p $vroot/dev/net
170 mknod -m 600 $vroot/dev/net/tun c 10 200
172 # For mkinitrd (in case a kernel is being installed)
173 # As well for loop back mounting within a vserver.
174 for i in $(seq 0 255) ; do
175 mknod -m 640 $vroot/dev/loop$i b 7 $i
179 function mkfedora_usage() {
180 echo "Usage: pl_root_mkfedora [OPTION]... basedir pldistro pkgsfile(s)"
181 echo " -l url Fedora mirror location."
182 echo " Defaults are searched in <pldistro>.mirrors"
183 echo " -v Be verbose"
184 echo " -h This message"
185 echo " target selection (defaults based on current build vserver)"
186 echo " -r release Fedora release number (default: $releasever)"
187 echo " -a arch Fedora architecture (default: $basearch)"
191 function pl_root_mkfedora () {
193 echo "* Entering pl_root_mkfedora" "$@"
195 if [ $UID -ne 0 ] ; then
196 echo "Error: You must run this script as root."
203 # Release and architecture to install : defaults to current vserver's settings or previously parsed fedora_options
204 releasever=$pl_DISTRO_RELEASE
205 basearch=$pl_DISTRO_ARCH
209 ### while getopts "l:r:a:vh" opt ; do
210 while getopts "vh" opt ; do
212 ### l) mirrors="$mirrors $OPTARG" ;;
213 ### r) releasever=$OPTARG ;;
214 ### a) basearch=$OPTARG ;;
215 v) verbose=1; set -x ;;
216 h|*) mkfedora_usage ;;
220 shift $(($OPTIND - 1))
221 [[ "$#" -lt 3 ]] && mkfedora_usage
225 vroot=$(cd $vroot && pwd -P)
226 [ -d $vroot ] || mkfedora_usage
229 # parse pkgsfile and add to local vars
230 fcdistro=${pl_DISTRO_NAME}
231 pkgs_packages=$(pl_parsePkgs package $fcdistro $pldistro $pkgsfile)
232 pkgs_groups=$(pl_parsePkgs group $fcdistro $pldistro $pkgsfile)
233 # packages to exclude - obsolete, was maybe useful when installing a group
234 pkgs_excludes=$(pl_parsePkgs exclude $fcdistro $pldistro $pkgsfile)
235 pkgs_junk=$(pl_parsePkgs junk $fcdistro $pldistro $pkgsfile)
236 pkgs_precious=$(pl_parsePkgs precious $fcdistro $pldistro $pkgsfile)
237 # formerly related to mkfedora -k
238 pkgs_kexcludes=$(pl_parsePkgs kexclude $fcdistro $pldistro $pkgsfile)
239 # get mirrors if not specified with -l
240 if [ -z "$mirrors" ] ; then
241 mirrorsfile=$(pl_locateDistroFile ../build/ $pldistro "$pldistro.mirrors")
242 mirrors=$(pl_parsePkgs mirror $fcdistro $pldistro $mirrorsfile)
246 # add them manually as the output of pl_parsePkgs is line-separated
247 if [ -n "$pkgs_kexcludes" ] ; then
248 exclude_line="exclude="
249 for kexclude in $pkgs_kexcludes ; do
250 exclude_line="$exclude_line $kexclude"
254 echo "$0: candidate mirrors"
255 for mirror in $mirrors ; do
256 echo "* candidate mirror $mirror"
259 # the repo part of the final yum.conf
260 yum_conf_repos=$vroot/xxxmkfedora-repos.confxxx
261 if ! yumconf_mirrors $yum_conf_repos ../build/ $fcdistro "$exclude_line" $mirrors ; then
262 echo xxx -- error ; return 1
265 public_gpg_key=$(yumconf_gpgkey $yum_conf_repos)
267 # Do not tolerate errors
270 ## make rpms ignore installing stuff to special fs entries like /proc
271 # Because of https://bugzilla.redhat.com/bugzilla/show_bug.cgi?id=52725
272 # you have to use at least one language beside 'C'
273 # Prevent all locales from being installed in reference image
274 mkdir -p $vroot/etc/rpm
275 pl_root_rpm_macros > $vroot/etc/rpm/macros
277 # Trick rpm and yum, who read the real root /etc/rpm/macros file
278 # rather than the one installed in the reference image, despite what
279 # you might expect the --root and --installroot options to mean. Both
280 # programs always read $HOME/.rpmmacros.
281 export HOME=$vroot/tmp
283 pl_root_rpm_macros > $vroot/tmp/.rpmmacros
285 function mkfedora_cleanup () {
286 umount -l $vroot/proc
287 umount -l $vroot/dev/shm
288 umount -l $vroot/dev/pts
291 # Clean up before exiting if anything goes wrong
292 trap "mkfedora_cleanup" ERR INT
294 # Mount in reference image
295 mount -t devpts none $vroot/dev/pts
296 mount -t tmpfs none $vroot/dev/shm
298 mount -t proc none $vroot/proc
300 # Create a /var/lib dirs for yum & rpm
301 mkdir -p $vroot/var/lib/yum
302 mkdir -p $vroot/var/lib/rpm
303 mkdir -p $vroot/usr/share/info
305 # Create a dummy /etc/fstab in reference image
307 cat >$vroot/etc/fstab <<EOF
308 # This fake fstab exists only to please df and linuxconf.
309 /dev/hdv1 / ext2 defaults 1 1
311 cp $vroot/etc/fstab $vroot/etc/mtab
313 # Necessary for some scripts
314 mkdir -p $vroot/etc/sysconfig
315 echo "NETWORKING=yes" > $vroot/etc/sysconfig/network
317 # Initialize RPM database in reference image
318 mkdir -p $vroot/var/lib/rpm
319 rpm --root $vroot --initdb
320 rpm --root $vroot --import $public_gpg_key
322 # Initialize yum in reference image
323 mkdir -p $vroot/var/cache/yum $vroot/var/log
325 # yum.conf is for building only - store in different location than /etc/yum.conf
326 yum_conf=$vroot/etc/mkfedora-yum.conf
327 cat > $yum_conf <<EOF
329 cachedir=/var/cache/yum
331 logfile=/var/log/yum.log
333 distroverpkg=redhat-release
339 # Prevent yum-2.4 from loading additional repository definitions
340 # (e.g., from /etc/yum.repos.d/)
344 cat $yum_conf_repos >> $yum_conf
346 # If we are being built as part of an automated RPM build, solve the
347 # bootstrap problem by including any just built packages in the yum
348 # configuration. This cooperates with the PlanetLab build system.
349 if [ -n "$RPM_BUILD_DIR" ] ; then
350 RPM_RPMS_DIR=$(cd $(dirname $RPM_BUILD_DIR)/RPMS && pwd -P)
351 # If run under sudo, allow user to delete the headers/ and
352 # repodata/ directories.
353 if [ -n "$SUDO_USER" ] ; then
354 chown -R $SUDO_USER $RPM_RPMS_DIR
356 cat >> $yum_conf <<EOF
359 name=Building - $basearch - $RPM_RPMS_DIR/
360 baseurl=file://$RPM_RPMS_DIR/
364 echo "========== Dumping $yum_conf"
366 echo "========== EndDump $yum_conf"
369 yum --help | grep verbose &> /dev/null && yum_options="$yum_options --verbose"
370 yum_options="$yum_options -y"
371 yum_options="$yum_options -c $yum_conf"
372 yum_options="$yum_options --installroot=$vroot"
375 for exclude in $pkgs_excludes; do
376 exclude_arg="$exclude_arg --exclude $exclude"
379 # glibc must be specified explicitly for the correct arch to be
381 echo "* Installing glibc"
382 yum $yum_options $exclude_arg install glibc
385 if [ -n "$pkgs_packages" ] ; then
386 echo "* Installing optional packages" $pkgs_packages
387 yum $yum_options $exclude_arg install $pkgs_packages
388 if ! rpm --root $vroot -q $pkgs_packages >/dev/null ; then
389 echo "* Warning: Missing packages"
390 rpm --root $vroot -q $pkgs_packages | grep "not installed"
394 if [ -n "$pkgs_groups" ] ; then
395 ## call yum sequentially to get finer-grained info on dependencies
396 for grp in $pkgs_groups ; do
397 echo "* Installing optional group $grp"
398 yum $yum_options $exclude_arg groupinstall "$grp"
402 # formerly in bootcd/prep.sh : to optimize footprint
403 if [ -n "$pkgs_junk" ] ; then
404 echo "* Removing unnecessary junk"
406 # Save precious files
407 [ -n "$pkgs_precious" ] && tar --ignore-failed-read -cpf precious.tar $pkgs_precious
408 # Remove unnecessary junk
409 [ -n "$pkgs_junk" ] && rm -rf $pkgs_junk
410 # Restore precious files
411 [ -n "$pkgs_precious" ] && tar -xpf precious.tar && rm -f precious.tar
417 yum $yum_options clean all
420 rm -f $vroot/var/lib/rpm/__db*
422 # Set time zone to UTC
423 if [ -f $vroot/usr/share/zoneinfo/UTC -a -f $vroot/etc/localtime ] ; then
424 rm -f $vroot/etc/localtime
425 ln -s /usr/share/zoneinfo/UTC $vroot/etc/localtime
428 echo "Dumping current list of rpms in /etc/mkfedora-rpms.txt"
429 chroot $vroot rpm -aq | sort > $vroot/etc/mkfedora-rpms.txt
431 # remove trap handler, as we are about to call it directly.
440 function pl_root_tune_image () {
443 # Disable all services in reference image
444 chroot $root sh -c "/sbin/chkconfig --list | awk '{ print \$1 }' | xargs -i /sbin/chkconfig {} off"
446 # FC2 minilogd starts up during shutdown and makes unmounting
447 # impossible. Just get rid of it.
448 rm -f $root/sbin/minilogd
449 ln -nsf /bin/true $root/sbin/minilogd
451 # This tells the Boot Manager that it is okay to update
452 # /etc/resolv.conf and /etc/hosts whenever the network configuration
453 # changes. Users are free to delete this file.
454 touch $root/etc/AUTO_UPDATE_NET_FILES
457 # Move specified directories out of a src tree into a dst tree, and
458 # then for each moved directory create a symlink in src to dst.
459 function pl_move_dirs() {
466 for datadir in "$@" ; do
467 mkdir -p ${data}${datadir}
468 if [ -d ${root}/${datadir} -a ! -h ${root}/${datadir} ] ; then
469 (cd ${root} && find ./${datadir} | cpio -p -d -u ../${data}/)
471 rm -rf ${root}/${datadir}
472 mkdir -p $(dirname ${root}/${datadir})
473 ln -nsf ${store}/${datadir} ${root}/${datadir}
477 # Construct an image file from given some directory
478 # XXX in the future maybe use livecdtools?
479 function pl_make_image() {
484 # Leave about 100 MB free space and allow for about 20% inode overhead
485 bytes=$((($(du -sb $root | cut -f1) + $extraspace) * 120 / 100))
487 blocks=$(($bytes / $bs))
488 dd bs=$bs count=$blocks if=/dev/zero of=$image
489 mkfs.ext3 -b $bs -j -F $image
491 # Temporarily mount it
492 tmp=$(mktemp -d tmp.XXXXXX)
493 mount -o loop $image $tmp
494 trap "umount $tmp; rmdir $tmp" ERR INT
497 (cd $root && tar cpf - .) | (cd $tmp && tar xpf -)
505 # Fix permissions on tmp directories
506 function pl_fixtmp_permissions() {
508 chmod 1777 $root/tmp $root/usr/tmp $root/var/tmp
511 function pl_fixdirs() {
514 for datadir in datadirs ; do
515 if [ -h ${root}/${datadir} ] ; then
516 rm -f ${root}/${datadir}
517 mkdir -p ${root}/${datadir}
522 ########## .pkgs format
523 # comments start with a # - this is needed only if you use a keyword in a comment
525 function pl_getPkgsAttribute () {
528 # remove any initial white spaces from the result
529 grep -v '^#' $file | grep --regexp="^${keyword}:" | sed -e "s,${keyword}:,," -e "s,^[[:space:]][[:space:]]*,,"
532 # for a given keyword like 'package' :
533 # we support fcdistro-dependant format, for tokens (pkgname) without whitespace
535 # package: pkg1 .. pkgn
536 # package+f8: pkg1 .. pkgn
537 # package-f8: pkg1 .. pkgn
539 # values can contain @arch@, @fcdistro@ or @pldistro@ that are replaced with the current values
541 function pl_parsePkgs () {
546 # remaining arguments are paths to the pkgs files
548 # grab regular descriptions
549 all=$(grep -v '^#' "$@" | grep --regexp="^${keyword}:" | sed -e "s,${keyword}:,,")
551 add=$(grep -v '^#' "$@" | grep --regexp="^${keyword}+${fcdistro}:" | sed -e "s,${keyword}+${fcdistro}:,,")
553 sub=$(grep -v '^#' "$@" | grep --regexp="^${keyword}-${fcdistro}:" | sed -e "s,${keyword}-${fcdistro}:,,")
555 for i in $all $add; do
556 for exclude in $sub; do
557 [ "$i" = "$exclude" ] && continue 2
559 echo "$i " | sed -e "s,@arch@,$pl_DISTRO_ARCH,g" -e "s,@fcdistro@,$fcdistro,g" -e "s,@pldistro@,$pldistro,g"
564 function pl_getPackages() { fcdistro=$1; shift ; pldistro=$1; shift ; pl_parsePkgs package $fcdistro $pldistro "$@" ; }
565 function pl_getGroups() { fcdistro=$1; shift ; pldistro=$1; shift ; pl_parsePkgs group $fcdistro $pldistro "$@" ; }
567 # locates a pldistro-dependant file
568 # tries first in build/<pldistro>/, then in build/planetlab/
569 function pl_locateDistroFile () {
576 paths="$builddir/config.$pldistro/$pkgsfile $builddir/config.planetlab/$pkgsfile"
577 for path in $paths; do
578 if [ -f $path ] ; then
583 if [ -z "$pkgspath" ] ; then
584 echo 1>&2 "pl_locateDistroFile - in $(pwd) : cannot locate $pkgsfile in $builddir"
585 echo 1>&2 "candidates were $paths"
586 echo "not-found-by-pl_locateDistroFile"
589 echo 1>&2 "pl_locateDistroFile: using $pkgspath"
595 function yumgroups_from_pkgs () {
601 sedargs="-e s,@FCDISTRO@,$fcdistro,g"
604 <?xml version="1.0"?>
605 <!DOCTYPE comps PUBLIC "-//Red Hat, Inc.//DTD Comps info//EN" "comps.dtd">
609 for pkgsname in $pkgsnames; do
610 pkgsfile=$(pl_locateDistroFile $builddir $pldistro $pkgsname)
611 packages=$(pl_getPackages $fcdistro $pldistro $pkgsfile)
613 groupname=$(pl_getPkgsAttribute groupname $pkgsfile | sed $sedargs)
614 groupdesc=$(pl_getPkgsAttribute groupdesc $pkgsfile | sed $sedargs)
616 if [ -z "$groupname" -o -z "$groupdesc" ] ; then
617 echo "Cannot find groupname: and groupdesc: in $pkgsfile -- skipped" 1>&2
621 cat << __group_header
623 <id>$(echo $groupname|tr A-Z a-z)</id>
624 <name>$groupname</name>
625 <description>$groupdesc</description>
626 <uservisible>true</uservisible>
629 for package in $packages; do
630 echo "<packagereq type=\"mandatory\">$package</packagereq>"
632 cat << __group_footer
643 function build_fetch () {
644 curl --fail --silent --max-time 60 --output /dev/null "$1"
647 # tries to compute a valid yum.conf for that pldistro from the template in mirroring/
648 # returns 0 and writes <dest_yumconf> on success
649 # returns 1 on failure, in which case <dest_yumconf> is deleted
650 function yumconf_mirrors () {
651 dest_yumconf=$1; shift
654 exclude_line="$1" ; shift
657 template=$builddir/mirroring/$fcdistro/yum.repos.d/building.repo.in
659 if [ ! -f $template ] ; then
660 echo "yumconf_mirrors: cannot locate template $template"
665 for mirror in $mirrors; do
666 if yumconf_mirror $dest_yumconf $template "$exclude_line" $mirror; then
674 # computes a yum.conf from the template, and checks that all baseurl defined in there are valid repos
675 # returns 0 on success and 1 on failure
676 function yumconf_mirror () {
677 dest_yumconf=$1; shift
679 exclude_line="$1" ; shift
682 sed -e "s,@MIRRORURL@,$mirror,g" \
684 $exclude_line" $template > $dest_yumconf
686 # capture all lines defining baseurl
687 baseurl_defs=$(grep '^baseurl=' $dest_yumconf)
688 if [ -z "$baseurl_defs" ] ; then
692 for baseurl_def in $baseurl_defs; do
693 baseurl=$(echo $baseurl_def | sed \
695 -e 's,$basearch,'"$pl_DISTRO_ARCH",g)
696 repomd=$baseurl/repodata/repomd.xml
698 echo "* Trying to fetch $repomd"
699 if ! build_fetch $repomd ; then
700 echo "* Failed to fetch $repomd"
704 echo "* Selected mirror $mirror"
708 # from a yum.conf as generated above, computes the (first) gpgkey url
709 function yumconf_gpgkey () {
710 dest_yumconf=$1; shift
712 first_line=$(grep '^gpgkey=' $dest_yumconf | head -1)
713 values=$(echo $first_line | sed -e s,gpgkey=,,)
714 value=$(echo $values | awk '{print $1;}' | sed -e 's,$basearch,'"$pl_DISTRO_ARCH",g)
715 [ -n "$value" ] || return 1