usr/gen_initramfs.sh

   1 #!/bin/sh
   2 # Copyright (C) Martin Schlemmer <azarah@nosferatu.za.org>
   3 # Copyright (C) 2006 Sam Ravnborg <sam@ravnborg.org>
   4 #
   5 # Released under the terms of the GNU GPL
   6 #
   7 # Generate a cpio packed initramfs. It uses gen_init_cpio to generate
   8 # the cpio archive, and then compresses it.
   9 # This script assumes that gen_init_cpio is located in usr/ directory
  10
  11 # error out on errors
  12 set -e
  13
  14 usage() {
  15 cat << EOF
  16 Usage:
  17 $0 [-o <file>] [-l <dep_list>] [-u <uid>] [-g <gid>] {-d | <cpio_source>} ...
  18         -o <file>      Create compressed initramfs file named <file> using
  19                        gen_init_cpio and compressor depending on the extension
  20         -l <dep_list>  Create dependency list named <dep_list>
  21         -u <uid>       User ID to map to user ID 0 (root).
  22                        <uid> is only meaningful if <cpio_source> is a
  23                        directory.  "squash" forces all files to uid 0.
  24         -g <gid>       Group ID to map to group ID 0 (root).
  25                        <gid> is only meaningful if <cpio_source> is a
  26                        directory.  "squash" forces all files to gid 0.
  27         <cpio_source>  File list or directory for cpio archive.
  28                        If <cpio_source> is a .cpio file it will be used
  29                        as direct input to initramfs.
  30
  31 All options except -o and -l may be repeated and are interpreted
  32 sequentially and immediately.  -u and -g states are preserved across
  33 <cpio_source> options so an explicit "-u 0 -g 0" is required
  34 to reset the root/group mapping.
  35 EOF
  36 }
  37
  38 # awk style field access
  39 # $1 - field number; rest is argument string
  40 field() {
  41         shift $1 ; echo $1
  42 }
  43
  44 filetype() {
  45         local argv1="$1"
  46
  47         # symlink test must come before file test
  48         if [ -L "${argv1}" ]; then
  49                 echo "slink"
  50         elif [ -f "${argv1}" ]; then
  51                 echo "file"
  52         elif [ -d "${argv1}" ]; then
  53                 echo "dir"
  54         elif [ -b "${argv1}" -o -c "${argv1}" ]; then
  55                 echo "nod"
  56         elif [ -p "${argv1}" ]; then
  57                 echo "pipe"
  58         elif [ -S "${argv1}" ]; then
  59                 echo "sock"
  60         else
  61                 echo "invalid"
  62         fi
  63         return 0
  64 }
  65
  66 print_mtime() {
  67         local my_mtime="0"
  68
  69         if [ -e "$1" ]; then
  70                 my_mtime=$(find "$1" -printf "%T@\n" | sort -r | head -n 1)
  71         fi
  72
  73         echo "# Last modified: ${my_mtime}" >> $cpio_list
  74         echo "" >> $cpio_list
  75 }
  76
  77 list_parse() {
  78         if [ -z "$dep_list" -o -L "$1" ]; then
  79                 return
  80         fi
  81         echo "$1" | sed 's/:/\\:/g; s/$/ \\/' >> $dep_list
  82 }
  83
  84 # for each file print a line in following format
  85 # <filetype> <name> <path to file> <octal mode> <uid> <gid>
  86 # for links, devices etc the format differs. See gen_init_cpio for details
  87 parse() {
  88         local location="$1"
  89         local name="/${location#${srcdir}}"
  90         # change '//' into '/'
  91         name=$(echo "$name" | sed -e 's://*:/:g')
  92         local mode="$2"
  93         local uid="$3"
  94         local gid="$4"
  95         local ftype=$(filetype "${location}")
  96         # remap uid/gid to 0 if necessary
  97         [ "$root_uid" = "squash" ] && uid=0 || [ "$uid" -eq "$root_uid" ] && uid=0
  98         [ "$root_gid" = "squash" ] && gid=0 || [ "$gid" -eq "$root_gid" ] && gid=0
  99         local str="${mode} ${uid} ${gid}"
 100
 101         [ "${ftype}" = "invalid" ] && return 0
 102         [ "${location}" = "${srcdir}" ] && return 0
 103
 104         case "${ftype}" in
 105                 "file")
 106                         str="${ftype} ${name} ${location} ${str}"
 107                         ;;
 108                 "nod")
 109                         local dev="`LC_ALL=C ls -l "${location}"`"
 110                         local maj=`field 5 ${dev}`
 111                         local min=`field 6 ${dev}`
 112                         maj=${maj%,}
 113
 114                         [ -b "${location}" ] && dev="b" || dev="c"
 115
 116                         str="${ftype} ${name} ${str} ${dev} ${maj} ${min}"
 117                         ;;
 118                 "slink")
 119                         local target=`readlink "${location}"`
 120                         str="${ftype} ${name} ${target} ${str}"
 121                         ;;
 122                 *)
 123                         str="${ftype} ${name} ${str}"
 124                         ;;
 125         esac
 126
 127         echo "${str}" >> $cpio_list
 128
 129         return 0
 130 }
 131
 132 unknown_option() {
 133         printf "ERROR: unknown option \"$arg\"\n" >&2
 134         printf "If the filename validly begins with '-', " >&2
 135         printf "then it must be prefixed\n" >&2
 136         printf "by './' so that it won't be interpreted as an option." >&2
 137         printf "\n" >&2
 138         usage >&2
 139         exit 1
 140 }
 141
 142 header() {
 143         printf "\n#####################\n# $1\n" >> $cpio_list
 144 }
 145
 146 # process one directory (incl sub-directories)
 147 dir_filelist() {
 148         header "$1"
 149
 150         srcdir=$(echo "$1" | sed -e 's://*:/:g')
 151         dirlist=$(find "${srcdir}" -printf "%p %m %U %G\n" | LANG=C sort)
 152
 153         # If $dirlist is only one line, then the directory is empty
 154         if [  "$(echo "${dirlist}" | wc -l)" -gt 1 ]; then
 155                 print_mtime "$1"
 156
 157                 echo "${dirlist}" | \
 158                 while read x; do
 159                         list_parse $x
 160                         parse $x
 161                 done
 162         fi
 163 }
 164
 165 # if only one file is specified and it is .cpio file then use it direct as fs
 166 # if a directory is specified then add all files in given direcotry to fs
 167 # if a regular file is specified assume it is in gen_init_cpio format
 168 input_file() {
 169         source="$1"
 170         if [ -f "$1" ]; then
 171                 header "$1"
 172                 is_cpio="$(echo "$1" | sed 's/^.*\.cpio\(\..*\)\{0,1\}/cpio/')"
 173                 if [ $2 -eq 0 -a ${is_cpio} = "cpio" ]; then
 174                         cpio_file=$1
 175                         echo "$1" | grep -q '^.*\.cpio\..*' && is_cpio_compressed="compressed"
 176                         [ -n "$dep_list" ] && echo "$1" >> $dep_list
 177                         return 0
 178                 fi
 179                 print_mtime "$1" >> $cpio_list
 180                 cat "$1"         >> $cpio_list
 181                 if [ -n "$dep_list" ]; then
 182                         echo "$1 \\"  >> $dep_list
 183                         cat "$1" | while read type dir file perm ; do
 184                                 if [ "$type" = "file" ]; then
 185                                         echo "$file \\" >> $dep_list
 186                                 fi
 187                         done
 188                 fi
 189         elif [ -d "$1" ]; then
 190                 dir_filelist "$1"
 191         else
 192                 echo "  ${prog}: Cannot open '$1'" >&2
 193                 exit 1
 194         fi
 195 }
 196
 197 prog=$0
 198 root_uid=0
 199 root_gid=0
 200 dep_list=
 201 cpio_file=
 202 cpio_list=$(mktemp ${TMPDIR:-/tmp}/cpiolist.XXXXXX)
 203 output="/dev/stdout"
 204 output_file="/dev/stdout"
 205 is_cpio_compressed=
 206 compr="gzip -n -9 -f"
 207
 208 while [ $# -gt 0 ]; do
 209         arg="$1"
 210         shift
 211         case "$arg" in
 212                 "-l")   # files included in initramfs - used by kbuild
 213                         dep_list="$1"
 214                         echo "deps_initramfs := \\" > $dep_list
 215                         shift
 216                         ;;
 217                 "-o")   # generate compressed cpio image named $1
 218                         output_file="$1"
 219                         output=$cpio_list
 220                         echo "$output_file" | grep -q "\.gz$" \
 221                         && [ -x "`which gzip 2> /dev/null`" ] \
 222                         && compr="gzip -n -9 -f"
 223                         echo "$output_file" | grep -q "\.bz2$" \
 224                         && [ -x "`which bzip2 2> /dev/null`" ] \
 225                         && compr="bzip2 -9 -f"
 226                         echo "$output_file" | grep -q "\.lzma$" \
 227                         && [ -x "`which lzma 2> /dev/null`" ] \
 228                         && compr="lzma -9 -f"
 229                         echo "$output_file" | grep -q "\.xz$" \
 230                         && [ -x "`which xz 2> /dev/null`" ] \
 231                         && compr="xz --check=crc32 --lzma2=dict=1MiB"
 232                         echo "$output_file" | grep -q "\.lzo$" \
 233                         && [ -x "`which lzop 2> /dev/null`" ] \
 234                         && compr="lzop -9 -f"
 235                         echo "$output_file" | grep -q "\.lz4$" \
 236                         && [ -x "`which lz4 2> /dev/null`" ] \
 237                         && compr="lz4 -l -9 -f"
 238                         echo "$output_file" | grep -q "\.cpio$" && compr="cat"
 239                         shift
 240                         ;;
 241                 "-u")   # map $1 to uid=0 (root)
 242                         root_uid="$1"
 243                         [ "$root_uid" = "-1" ] && root_uid=$(id -u || echo 0)
 244                         shift
 245                         ;;
 246                 "-g")   # map $1 to gid=0 (root)
 247                         root_gid="$1"
 248                         [ "$root_gid" = "-1" ] && root_gid=$(id -g || echo 0)
 249                         shift
 250                         ;;
 251                 "-h")
 252                         usage
 253                         exit 0
 254                         ;;
 255                 *)
 256                         case "$arg" in
 257                                 "-"*)
 258                                         unknown_option
 259                                         ;;
 260                                 *)      # input file/dir - process it
 261                                         input_file "$arg" "$#"
 262                                         ;;
 263                         esac
 264                         ;;
 265         esac
 266 done
 267
 268 # If output_file is set we will generate cpio archive and compress it
 269 # we are careful to delete tmp files
 270 if [ -z ${cpio_file} ]; then
 271         timestamp=
 272         if test -n "$KBUILD_BUILD_TIMESTAMP"; then
 273                 timestamp="$(date -d"$KBUILD_BUILD_TIMESTAMP" +%s || :)"
 274                 if test -n "$timestamp"; then
 275                         timestamp="-t $timestamp"
 276                 fi
 277         fi
 278         cpio_tfile="$(mktemp ${TMPDIR:-/tmp}/cpiofile.XXXXXX)"
 279         usr/gen_init_cpio $timestamp ${cpio_list} > ${cpio_tfile}
 280 else
 281         cpio_tfile=${cpio_file}
 282 fi
 283 rm ${cpio_list}
 284 if [ "${is_cpio_compressed}" = "compressed" ]; then
 285         cat ${cpio_tfile} > ${output_file}
 286 else
 287         (cat ${cpio_tfile} | ${compr}  - > ${output_file}) \
 288         || (rm -f ${output_file} ; false)
 289 fi
 290 [ -z ${cpio_file} ] && rm ${cpio_tfile}
 291 exit 0