usbgen.sh

   1 #!/bin/sh
   2
   3 #
   4 # CDDL HEADER START
   5 #
   6 # The contents of this file are subject to the terms of the
   7 # Common Development and Distribution License (the "License").
   8 # You may not use this file except in compliance with the License.
   9 #
  10 # You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  11 # or http://www.opensolaris.org/os/licensing.
  12 # See the License for the specific language governing permissions
  13 # and limitations under the License.
  14 #
  15 # When distributing Covered Code, include this CDDL HEADER in each
  16 # file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  17 # If applicable, add the following below this CDDL HEADER, with the
  18 # fields enclosed by brackets "[]" replaced with your own identifying
  19 # information: Portions Copyright [yyyy] [name of copyright owner]
  20 #
  21 # CDDL HEADER END
  22 #
  23
  24 #
  25 # Copyright 2008 Sun Microsystems, Inc.  All rights reserved.
  26 # Use is subject to license terms.
  27 #
  28
  29 #
  30 # Generate USB image from iso
  31 # Originally from slim_install, modified by Toomas Soome.
  32 #
  33
  34 # Solaris needs /usr/xpg4/bin/ because the tools in /usr/bin are not
  35 # POSIX-conformant
  36 export PATH=/usr/xpg4/bin:/bin:/usr/bin:/usr/sbin
  37
  38 #######################################################################
  39 # usage
  40 #       Print the usage message.
  41 # Input: none
  42 # Returns: none
  43 #
  44 #######################################################################
  45 function usage
  46 {
  47         print -u2 "\nUsage: "
  48         print -u2 "${progname} iso_file usb_image tmpdir"
  49         print -u2 "iso_file  : The path to an existing iso file."
  50         print -u2 "usb_image : The path to usb image to be created."
  51         print -u2 "tmpdir    : Temporary directy used during usb image " \
  52             "creation.\n"
  53
  54         print -u2 "If tmpdir does not exist it will be created. If " \
  55             "it or subdirectories under tmpdir can not be created " \
  56             " an error is generated and this script exits."
  57
  58 }
  59
  60 #
  61 #
  62 #######################################################################
  63 # cleanup
  64 #       This function attempst to clean up any resources this script
  65 #       could generate. Depending on where in the script this function
  66 #       is involked some resouces may not be there to cleanup, but
  67 #       that will not adversely effect anything.
  68 #
  69 #       This function is not defined using the function keyword
  70 #       to avoid an exit loop.
  71 #
  72 # Input: none
  73 # Returns: none
  74 #
  75 #######################################################################
  76 cleanup ()
  77 {
  78
  79         {
  80                 trap "" ERR INT
  81                 set +o errexit
  82
  83                 # unmounting, and uninstalling the lofi'ed devices and
  84                 # cleanup temporary files.
  85                 IFS=''
  86
  87                 umount "${usb_path}" || true
  88                 umount "${iso_path}" || true
  89
  90                 lofiadm "${usb_file}" && \
  91                     lofiadm -d "${usb_file}"
  92
  93                 lofiadm "${iso_file}"  && \
  94                     lofiadm -d "${iso_file}"
  95
  96                 if [[ -d "${iso_path}" ]] ; then
  97                         rm -rf "${iso_path}"
  98                 fi
  99
 100                 if [[ -d "${usb_path}" ]] ; then
 101                         rm -rf "${usb_path}"
 102                 fi
 103
 104                 #
 105                 # If the tmpdir did not exist this script could
 106                 # have created it, so remove it here.
 107                 #
 108                 if ! ${tmpdir_existed} ; then
 109                         rm -rf "${tmpdir}"
 110                 fi
 111          } > /dev/null 2>&1
 112
 113 }
 114
 115 #######################################################################
 116 # error_handler
 117 #       The error_handler for this script. Will cleanup the usb image
 118 #       that could have been partially created. Then invoke cleanup
 119 #       to clean up any temporary resouces.
 120 #
 121 #       This function is not defined using the function keyword
 122 #       to avoid an exit loop.
 123 #
 124 # Input: none
 125 # Returns: none
 126 #
 127 #######################################################################
 128 error_handler ()
 129 {
 130         trap "" ERR INT
 131         set +o errexit
 132
 133         print -u2 "\nError:\n"
 134         print -u2 -r -- "${progname}: $*"
 135         cleanup
 136
 137         #
 138         # If an error was encountered while attempting to create
 139         # the new usb image file don't leave a possibley partially
 140         # constructed one around.
 141         #
 142         if [[ -f "${usb_file}" ]] ; then
 143                 rm -rf "${usb_file}" > /dev/null 2>&1
 144         fi
 145
 146         exit 1
 147 }
 148
 149 # main
 150 #######################################################################
 151 # main
 152 #
 153 # Input:
 154 #       iso_file  : The path to an existing iso file.
 155 #       usb_image : The path to usb image to be created.
 156 #       tmpdir    : Temporary directroy used during usb image creation.
 157 #
 158 #       If tmpdir does not exist it will be created. If it can not be
 159 #       created an error is generated and this script exits.
 160 #
 161 #       This script must be run as root"
 162 #
 163 # Logic Flow:
 164 #       Set up error handling.
 165 #       Confirm input arguments.
 166 #       Create temporary directories.
 167 #       Mount up the existing ISO image file.
 168 #       Compute the size for the new USB image.
 169 #       Create and mount an empty new USB image.
 170 #       Copy the contents of the ISO file to the new USB image.
 171 #       Remove GRUB entries from the USB image which apply only to ISO.
 172 #       Set the file protections for the new USB image.
 173 #
 174 # Returns:
 175 #       1 on failure
 176 #       0 on success
 177 #
 178 #######################################################################
 179 typeset -r progname="$0"
 180 typeset -r iso_file="$1"
 181 typeset -r tmpdir="$3"
 182 typeset    tmpdir_existed=true
 183 typeset -r iso_path="${tmpdir}/iso"
 184
 185 typeset -r usb_file="$2"
 186 typeset -r usb_path="${tmpdir}/usb"
 187
 188 typeset isodev
 189 typeset devs
 190 typeset rdevs
 191 typeset s0devs
 192 typeset rs0devs
 193 typeset rs2devs
 194
 195 #
 196 # Confirm input arguments.
 197 #
 198 if [ $(id -u) != 0 ]; then
 199         print -u2 "Error:\nYou must run this script as root"
 200         usage
 201         exit 1
 202 fi
 203
 204 if [ $# -ne 3 ] ; then
 205         print -u2 "Error:\nImproper arguments"
 206         usage
 207         exit 1
 208 fi
 209
 210 #
 211 # Set up error handling.
 212 # Use set -o errexit to trap errors. However, where possible,
 213 # explicitly check command return status for errors.
 214 #
 215 trap "error_handler Error or interrupt encountered. Exiting" ERR INT
 216 set -o errexit
 217
 218 #
 219 # Create temporary directories.
 220 #
 221 [[ ! -d $tmpdir ]] && tmpdir_existed=false
 222 mkdir -p "${iso_path}"
 223 if [[ ! -d "${iso_path}" ]] ; then
 224         error_handler "Unable to create or access tmpdir ${iso_path}"
 225 fi
 226
 227 mkdir -p "${usb_path}"
 228 if [[ ! -d "${usb_path}" ]] ; then
 229         error_handler "Unable to create or access tmpdir ${usb_path}"
 230 fi
 231
 232 #
 233 # Mount up the existing ISO image file.
 234 #
 235 isodev="$(lofiadm -a "${iso_file}")" || \
 236     error_handler "Failed to lofiadm ${iso_file}"
 237
 238 mount -F hsfs "${isodev}" "${iso_path}" || \
 239     error_handler "Failed to mount ${isodev} on ${iso_path}"
 240
 241
 242 #
 243 # Compute the size in MB for the new USB image.
 244 # Use ISO file size + 20% to account for smaller block size on UFS
 245 # and the log.
 246 #
 247 usb_size=$(stat -f '%z' "${iso_file}")
 248 usb_size=$((usb_size * 12/10 / (1024*1024)))
 249
 250 #
 251 # Create and mount an empty new USB image.
 252 #
 253 mkfile -n ${usb_size}M "${usb_file}" || \
 254     error_handler "Failed to create file ${usb_file}"
 255
 256 devs="$(lofiadm -la "${usb_file}")" || \
 257         error_handler "Failed to lofiadm file ${usb_file}"
 258
 259 #
 260 # Set rdevs by replacing dsk with rdsk in devs
 261 #
 262 rdevs=/dev/rdsk${devs#/dev/dsk}
 263 # for mount
 264 s0devs=${devs%p0}s0
 265 # for newfs and installboot
 266 rs0devs=${rdevs%p0}s0
 267 # for prtvtoc | fmthard
 268 rs2devs=${rdevs%p0}s2
 269
 270 #
 271 # create Solaris2 partition
 272 #
 273 fdisk -B "${rdevs}"
 274 prtvtoc "${rs2devs}" | nawk '
 275 /^[^\*]/ { r = $1; for(n = 1; n <= NF; n++) vtoc[r,n] = $n }
 276 END {
 277 vtoc[0,1] = 0;
 278 vtoc[0,2] = 2;
 279 vtoc[0,3] = 00;
 280 vtoc[0,4] = vtoc[8,6] + 1;
 281 vtoc[0,5] = vtoc[2,6] - vtoc[8,6];
 282 vtoc[0,6] = vtoc[2,6];
 283 printf("\t%d\t%d\t%02d\t%d\t%d\t%d\n",
 284         vtoc[0,1], vtoc[0,2], vtoc[0,3], vtoc[0,4], vtoc[0,5], vtoc[0,6]);
 285 printf("\t%d\t%d\t%02d\t%d\t%d\t%d\n",
 286         vtoc[2,1], vtoc[2,2], vtoc[2,3], vtoc[2,4], vtoc[2,5], vtoc[2,6]);
 287 printf("\t%d\t%d\t%02d\t%d\t%d\t%d\n",
 288         vtoc[8,1], vtoc[8,2], vtoc[8,3], vtoc[8,4], vtoc[8,5], vtoc[8,6]);
 289 }' | fmthard -s- "${rs2devs}"
 290
 291 # newfs doesn't ask questions if stdin isn't a tty.
 292 newfs "${rs0devs}" </dev/null || \
 293         error_handler "Failed to construct the UFS file system ${rs0devs}"
 294
 295 mount -o nologging "${s0devs}" "${usb_path}" || \
 296         error_handler "Failed to mount construct the UFS file system ${rs0devs}"
 297
 298 #
 299 # Copy the contents of the ISO file to the new USB image.
 300 #
 301 print "Copying ISO contents to USB image..."
 302 (cd "${iso_path}"; find . -print | cpio -pmudV "${usb_path}")
 303
 304 #
 305 # install bootblocks
 306 #
 307 installboot -mf "${usb_path}/boot/pmbr" "${usb_path}/boot/gptzfsboot" \
 308         "${rs0devs}"
 309
 310 #
 311 # Set the file protections for the new USB image.
 312 #
 313 chmod 644 "${usb_file}"
 314
 315 #
 316 # unmounting, and uninstalling the lofi'ed devices
 317 #
 318 cleanup
 319
 320 printf "=== %s completed at %s\n\n" "$0" "$(date)"
 321
 322 exit 0
 323