setup-ivi-bootloader-conf

   1 #!/bin/sh -euf
   2
   3 # Copyright 2013-2014 Intel Corporation
   4 # Author: Artem Bityutskiy
   5 # License: GPLv2
   6
   7 PROG="setup-ivi-bootloader-conf"
   8 VER="1.0"
   9
  10 srcdir="$(readlink -ev -- ${0%/*})"
  11 PATH="/usr/share/setup-ivi:$srcdir:$PATH"
  12
  13 if [ -f "$srcdir/setup-ivi-sh-functions" ]; then
  14         . "$srcdir/setup-ivi-sh-functions"
  15         . "$srcdir/installerfw-sh-functions"
  16 else
  17         .  /usr/share/setup-ivi/setup-ivi-sh-functions
  18         .  /usr/share/setup-ivi/installerfw-sh-functions
  19 fi
  20
  21 # This is a small trick which I use to make sure my scripts are portable -
  22 # check if 'dash' is present, and if yes - use it.
  23 if can_switch_to_dash; then
  24         exec dash -euf -- "$srcdir/$PROG" "$@"
  25         exit $?
  26 fi
  27
  28 # Preparation stuff common for all subcommands
  29 prepare()
  30 {
  31         # Get the installer framework environment
  32         installerfw_restore_env
  33
  34         rootdir="$(installerfw_mnt_prefix "/")"
  35         bootdir="$(installerfw_mnt_prefix "/boot")"
  36
  37         if installerfw_is_efi_boot_system; then
  38                 boot="gummiboot"
  39         else
  40                 boot="extlinux"
  41         fi
  42 }
  43
  44 #
  45 # -----------------------------------------------------------------------------
  46 # The "add" subcommand
  47 # -----------------------------------------------------------------------------
  48 #
  49
  50 show_add_usage()
  51 {
  52         cat <<-EOF
  53 Usage: $PROG add [options] <kernel>
  54
  55 Add bootloader entries for kernel <kernel>.
  56
  57 Options:
  58   -f, --force  if bootloader entries for <kernel> already exist in bootloader's
  59                config file(s) - re-write them, if <kernel> does not exist - do
  60                not fail
  61   -h, --help   show this text and exit
  62 EOF
  63 }
  64
  65 show_add_usage_fail()
  66 {
  67         IFS= printf "%s\n\n" "$PROG: error: $*" >&2
  68         show_add_usage >&2
  69         exit 1
  70 }
  71
  72 add_subcommand()
  73 {
  74         if [ "$#" -eq 0  ]; then
  75                 show_add_usage
  76                 exit 0
  77         fi
  78
  79         local tmp
  80         tmp=`getopt -n $PROG -o f,h --long force,help -- "$@"` ||
  81                 show_add_usage_fail "cannot parse command-line options"
  82         eval set -- "$tmp"
  83
  84         local force=
  85         while true; do
  86                 case "$1" in
  87                 -f|--force)
  88                         force="-f"
  89                         ;;
  90                 -h|--help)
  91                         show_add_usage
  92                         exit 0
  93                         ;;
  94                 --) shift; break
  95                         ;;
  96                 *) show_add_usage_fail "unrecognized option \"$1\""
  97                         ;;
  98                 esac
  99                 shift
 100         done
 101
 102         if [ "$#" -lt 1 ]; then
 103                 show_add_usage_fail "please, specify the kernel"
 104         fi
 105         if [ "$#" -gt 1 ]; then
 106                 show_add_usage_fail "too many arguments: \"$1\""
 107         fi
 108
 109         prepare
 110
 111         local kernel="$1"
 112         local kernel_path="$bootdir/$kernel"
 113
 114         if ! [ -f "$kernel_path" ] && [ -z "$force" ]; then
 115                 fatal "cannot find kernel \"$kernel_path\"" \
 116                       "(use -f to ignore this error)"
 117         fi
 118
 119         # Get root partition PARTUUID
 120         installerfw_get_part_info "/" "PARTUUID" "root_partuuid"
 121         [ -n "$root_partuuid" ] || \
 122                 fatal "cannot find PARTUUID of the root partition"
 123
 124         # Get kernel options
 125         local options="${INSTALLERFW_KERNEL_OPTS:-} root=PARTUUID=$root_partuuid"
 126
 127         # Get OS name
 128         local os_name=
 129         get_os_name "os_name"
 130
 131         # Add the default bootloader entry
 132         setup-$boot-conf $verbose --bootdir "$bootdir" add $force \
 133                 "$kernel" "$os_name" "$kernel" "$options"
 134
 135         # Add the debug bootloader entry. If there is the "quiet" option,
 136         # create a non-quiet configuration.
 137         local verbose_opts="$(printf "%s" "$options" | LC_ALL=C \
 138                                 sed -e "s/[[:blank:]]\+quiet[[:blank:]]\+/ /
 139                                         s/^quiet[[:blank:]]\+//
 140                                         s/[[:blank:]]\+quiet$//
 141                                         s/^quiet$//")"
 142
 143         local debug_opts="$verbose_opts ignore_loglevel log_buf_len=2M"
 144         local debug_opts="$debug_opts initcall_debug"
 145
 146
 147         setup-$boot-conf $verbose --bootdir "$bootdir" add \
 148                 $force "$kernel-debug" "Debug $os_name" \
 149                 "$kernel" "$verbose_opts"
 150
 151         # Add the clone bootloader entry, but only if the cloning tool is
 152         # installed
 153         if [ -f "$rootdir/usr/sbin/setup-ivi-clone" ]; then
 154                 clone_opts="$options systemd.unit=ivi-clone.service"
 155                 clone_opts="$clone_opts ivi-clone-target=autodetect"
 156                 setup-$boot-conf $verbose --bootdir "$bootdir" add \
 157                         $force "$kernel-clone" "Clone $os_name" \
 158                         "$kernel" "$clone_opts"
 159         fi
 160 }
 161
 162 #
 163 # -----------------------------------------------------------------------------
 164 # The "remove" subcommand
 165 # -----------------------------------------------------------------------------
 166 #
 167
 168 show_remove_usage()
 169 {
 170         cat <<-EOF
 171 Usage: $PROG remove [options] <kernel>
 172
 173 Delete bootloader entries for kernel <kernel> (only those which were previously
 174 created with "$PROG add").
 175
 176 Options:
 177   -f, --force  do not fail if <kernel> does not have corresponding bootloader
 178                entries
 179   -h, --help   show this text and exit
 180 EOF
 181 }
 182
 183 show_remove_usage_fail()
 184 {
 185         IFS= printf "%s\n\n" "$PROG: error: $*" >&2
 186         show_remove_usage >&2
 187         exit 1
 188 }
 189
 190 remove_subcommand()
 191 {
 192         if [ "$#" -eq 0  ]; then
 193                 show_remove_usage
 194                 exit 0
 195         fi
 196
 197         local tmp
 198         tmp=`getopt -n $PROG -o f,h --long force,help -- "$@"` ||
 199                 show_remove_usage_fail "cannot parse command-line options"
 200         eval set -- "$tmp"
 201
 202         local force=
 203         while true; do
 204                 case "$1" in
 205                 -f|--force)
 206                         force="-f"
 207                         ;;
 208                 -h|--help)
 209                         show_remove_usage
 210                         exit 0
 211                         ;;
 212                 --) shift; break
 213                         ;;
 214                 *) show_remove_usage_fail "unrecognized option \"$1\""
 215                         ;;
 216                 esac
 217                 shift
 218         done
 219
 220         if [ "$#" -lt 1 ]; then
 221                 show_add_usage_fail "please, specify the kernel"
 222         fi
 223         if [ "$#" -gt 1 ]; then
 224                 show_remove_usage_fail "too many arguments: \"$1\""
 225         fi
 226
 227         local kernel="$1"
 228
 229         prepare
 230
 231         # Get the current default entry
 232         local default="$(setup-$boot-conf $verbose --bootdir "$bootdir" \
 233                                               default $force)"
 234         [ $? -eq 0 ] || \
 235                 fatal "cannot get the default kernel, setup-$boot-conf failed"
 236
 237         local default_kernel="$(printf "%s" "$default" | LC_ALL=C \
 238                          sed -n -e 's/^kernel: \(.\+\)$/\1/p')"
 239
 240         if [ -n "$default_kernel" ]; then
 241                 verbose "current default boot kernel is " \
 242                         "\"$default_kernel\""
 243         else
 244                 verbose "did not find the default kernel," \
 245                       "setup-$boot-conf returned: $default"
 246         fi
 247
 248         # Remove the kernel
 249         setup-$boot-conf $verbose --bootdir "$bootdir" \
 250                              remove $force "$kernel" || \
 251                 fatal "setup-$boot-conf failed to remove" \
 252                       "entry \"$kernel\""
 253         setup-$boot-conf $verbose --bootdir "$bootdir" \
 254                              remove $force "$kernel-debug" || \
 255                 fatal "setup-$boot-conf failed to remove" \
 256                       "entry \"$kernel-verbose\""
 257         # The "clone" entry does not necessary exist, so use --force
 258         setup-$boot-conf $verbose --bootdir "$bootdir" \
 259                              remove --force "$kernel-clone" || \
 260                 fatal "setup-$boot-conf failed to remove" \
 261                       "entry \"$kernel-clone\""
 262
 263         # If this is not the default kernel, we are done
 264         [ "$kernel" = "$default_kernel" ] || return 0
 265
 266         # We've just removed the default kernel, find the kernel with the
 267         # latest version and make it to be the default
 268
 269         verbose "removed the default kernel, find the newest available"
 270
 271         local newest_kernel="$(get_newest_kernel "$bootdir" "$kernel")"
 272
 273         if [ -z "$newest_kernel" ]; then
 274                 verbose "no more kernels, set the kernel to none"
 275                 setup-$boot-conf $verbose --bootdir "$bootdir" \
 276                                      default --force "<none>"
 277         else
 278                 verbose "new default kernel is \"$newest_kernel\""
 279                 setup-$boot-conf $verbose --bootdir "$bootdir" \
 280                                      default "$newest_kernel"
 281         fi
 282
 283         if [ "$?" -ne 0 ]; then
 284                 fatal "cannot set default kernel, \"setup-$boot-conf\" failed"
 285         fi
 286 }
 287
 288 #
 289 # -----------------------------------------------------------------------------
 290 # The "default" subcommand
 291 # -----------------------------------------------------------------------------
 292 #
 293
 294 show_default_usage()
 295 {
 296         cat <<-EOF
 297 Usage: $PROG default [options] <kernel>
 298
 299 Set the default boot kernel to <kernel>. If <kernel> is omited, print the
 300 current default boot kernel name.
 301
 302 Options:
 303   -f, --force  do not fail if <kernel> doesn't exist
 304   -h, --help   show this text and exit
 305 EOF
 306 }
 307
 308 show_default_usage_fail()
 309 {
 310         IFS= printf "%s\n\n" "$PROG: error: $*" >&2
 311         show_default_usage >&2
 312         exit 1
 313 }
 314
 315 default_subcommand()
 316 {
 317         local tmp
 318         tmp=`getopt -n $PROG -o f,h --long force,help -- "$@"` ||
 319                 show_default_usage_fail "cannot parse command-line options"
 320         eval set -- "$tmp"
 321
 322         local force=
 323         while true; do
 324                 case "$1" in
 325                 -f|--force)
 326                         force="-f"
 327                         ;;
 328                 -h|--help)
 329                         show_default_usage
 330                         exit 0
 331                         ;;
 332                 --) shift; break
 333                         ;;
 334                 *) show_default_usage_fail "unrecognized option \"$1\""
 335                         ;;
 336                 esac
 337                 shift
 338         done
 339
 340         if [ "$#" -gt 1 ]; then
 341                 show_default_usage_fail "too many arguments: \"$1\""
 342         fi
 343
 344         prepare
 345
 346         local kernel="${1:-}"
 347         local kernel_path="$bootdir/$kernel"
 348
 349         if [ -n "$kernel" ] && ! [ -f "$kernel_path" ] && [ -z "$force" ]; then
 350                 fatal "cannot find kernel \"$kernel_path\"" \
 351                       "(use -f to ignore this error)"
 352         fi
 353
 354         setup-$boot-conf $verbose --bootdir "$bootdir" default $force "$kernel"
 355 }
 356
 357 #
 358 # -----------------------------------------------------------------------------
 359 #
 360
 361 show_usage()
 362 {
 363         cat <<-EOF
 364 Usage: $PROG [options] <subcommand> [options] <arguments>
 365
 366 This program adds or removes a kernel to/from the bootloader configuration
 367 file(s). This is a Tizen IVI-specific program and it currently supports only 2
 368 bootloader types - extlinux and gummiboot. Each new kernel gets 2 boot menu
 369 entries - the default and verbose, and both of these are removed by the
 370 "remove" subcommand.
 371
 372 The supported subcommands are:
 373    add     - add bootloader entries for a kernel
 374    remove  - remove bootloader entries for a kernel
 375    default - get or set the default boot kernel
 376
 377 Run "$PROG <subcommand>" to see subcommand-specific help.
 378
 379 Options:
 380   --version      show the program version and exit
 381   -v, --verbose  be verbose
 382   -h, --help     show this text and exit
 383 EOF
 384 }
 385
 386 show_usage_fail()
 387 {
 388         IFS= printf "%s\n\n" "$PROG: error: $*" >&2
 389         show_usage >&2
 390         exit 1
 391 }
 392
 393 verbose=
 394 while [ -n "${1:-""}" ] && [ -z "${1##-*}" ]; do
 395         case "$1" in
 396         --version)
 397                 printf "%s\n" "$VER"
 398                 exit 0
 399                 ;;
 400         -v|--verbose)
 401                 verbose="-v"
 402                 ;;
 403         -h|--help)
 404                 show_usage
 405                 exit 0
 406                 ;;
 407         --) shift; break
 408                 ;;
 409         *) show_usage_fail "unrecognized option \"$1\""
 410                 ;;
 411         esac
 412         shift
 413 done
 414
 415 if [ "$#" -eq 0 ]; then
 416         show_usage
 417         exit 0
 418 fi
 419
 420 # Parse subcommands
 421
 422 subcommand="$1"; shift
 423
 424 case "$subcommand" in
 425 add)
 426         add_subcommand "$@"
 427         break
 428         ;;
 429 remove)
 430         remove_subcommand "$@"
 431         break
 432         ;;
 433 default)
 434         default_subcommand "$@"
 435         break
 436         ;;
 437 *) show_usage_fail "unrecognized subcommand \"$subcommand\""
 438         ;;
 439 esac