installerfw-sh-functions

   1 # Copyright 2013 Intel Corporation
   2 # Author: Artem Bityutskiy
   3 # License: GPLv2
   4
   5 # This file contains common functions for setup-ivi-* programs
   6
   7 # Own name
   8 __PROG="${PROG:-installerfw-sh-functions}"
   9
  10 # Installer framework variables are saved in this file
  11 __installerfw_file="/etc/installerfw-environment"
  12 # The OS release information file
  13 __osrelease_file="/etc/os-release"
  14 # EFI System Partition PARTUUID
  15 __esp_ptypeid="C12A7328-F81F-11D2-BA4B-00A0C93EC93B"
  16
  17 # Mount prefix is assumed to be "/" if it is not defined
  18 [ -n "${INSTALLERFW_MOUNT_PREFIX:-}" ] || export INSTALLERFW_MOUNT_PREFIX="/"
  19
  20 __fatal()
  21 {
  22         IFS= printf "%s\n" "$__PROG: error: $*" 1>&2
  23         exit 1
  24 }
  25
  26 __verbose()
  27 {
  28         if [ -n "$verbose" ]; then
  29                 IFS= printf "%s\n" "$__PROG (verbose): $*" >&2
  30         fi
  31 }
  32
  33 # Verify that an environment variable is defined
  34 __verify_defined()
  35 {
  36         local variable="$1"
  37
  38         printenv "$variable" > /dev/null ||
  39                 __fatal "cannot find required environment variable" \
  40                         "\"$variable\""
  41 }
  42
  43 # Add the INSTALLERFW_MOUNT_PREFIX prefix to a path. This does not really
  44 # require a separate function unless we want to be fancy and avoid double or
  45 # tripple "/" in the resulting path.
  46 installerfw_mnt_prefix()
  47 {
  48         __verify_defined "INSTALLERFW_MOUNT_PREFIX"
  49
  50         local path="$INSTALLERFW_MOUNT_PREFIX/$1"
  51
  52         printf "%s" "$path" | LC_ALL=C sed -e 's/\/\+/\//g'
  53 }
  54
  55 # Return full path to the file which contains the installer framework
  56 # environment variables.
  57 installerfw_get_env_file_name()
  58 {
  59         printf "%s" "$(installerfw_mnt_prefix "$__installerfw_file")"
  60 }
  61
  62 # Save installer framework environment variables. Note, all the variables can
  63 # be split on 2 classes - those which make sense only inside the particular
  64 # installer and those which make sense in the OS environment. We only save the
  65 # latter.
  66 installerfw_save_env()
  67 {
  68         local file="$(installerfw_get_env_file_name)"
  69         local opts="\
  70 -e '^INSTALLERFW_KERNEL_OPTS=' \
  71 -e '^INSTALLERFW_PART[[:digit:]]\+_ALIGN=' \
  72 -e '^INSTALLERFW_PART[[:digit:]]\+_BOOTFLAG=' \
  73 -e '^INSTALLERFW_PART[[:digit:]]\+_FSOPTS=' \
  74 -e '^INSTALLERFW_PART[[:digit:]]\+_FSTYPE=' \
  75 -e '^INSTALLERFW_PART[[:digit:]]\+_LABEL=' \
  76 -e '^INSTALLERFW_PART[[:digit:]]\+_MOUNTPOINT=' \
  77 -e '^INSTALLERFW_PART[[:digit:]]\+_PARTUUID=' \
  78 -e '^INSTALLERFW_PART[[:digit:]]\+_SIZE=' \
  79 -e '^INSTALLERFW_PART[[:digit:]]\+_TYPE_ID=' \
  80 -e '^INSTALLERFW_PART[[:digit:]]\+_UUID=' \
  81 -e '^INSTALLERFW_PART_COUNT=' \
  82 -e '^INSTALLERFW_PTABLE_FORMAT=' \
  83 "
  84
  85         local variables="$(printenv | eval "LC_ALL=C grep $opts")"
  86
  87         if [ "$(printf "%s" "$variables" | wc -l)" -eq "0" ]; then
  88                 __fatal "no installer framework environment variables" \
  89                         "found, nothing to save"
  90         fi
  91
  92         printf "%s" "$variables" | LC_ALL=C sed -n -e \
  93                 "s/\(^INSTALLERFW_[^=]\+\)=\(.*\)/\1=\"\2\"/p" > "$file"
  94         __verbose "installerfw_save_env(): saved installer framework" \
  95                   "environment in \"$file\""
  96 }
  97
  98 # Restore installer framework environment variables.
  99 installerfw_restore_env()
 100 {
 101         local file="$(installerfw_get_env_file_name)"
 102
 103         [ -f "$file" ] || \
 104                 __fatal "installerfw_restore_env(): can't restore the" \
 105                         "installer framework environment: can't find" \
 106                         "\"$file\""
 107
 108         while IFS= read -r line; do
 109                 eval "export $line"
 110         done < "$file"
 111
 112         __verbose "installerfw_restore_env(): restored installer" \
 113                   "framework environment from \"$file\""
 114 }
 115
 116 # Check if the system is an EFI boot system by checking whether the boot
 117 # partition is a FAT 32 partition with the magic EFI type GUID.
 118 installerfw_is_efi_boot_system()
 119 {
 120         installerfw_get_part_info "/boot" "TYPE_ID" "__ptypeid"
 121
 122         # Make sure the UUID uses capital letters
 123         __ptypeid="$(printf "%s" "$__ptypeid" | tr "[:lower:]" "[:upper:]")"
 124
 125         __verify_defined "INSTALLERFW_PTABLE_FORMAT"
 126
 127         if [ "${INSTALLERFW_PTABLE_FORMAT:-}" = "gpt" ] && \
 128            [ "$__ptypeid" = "$__esp_ptypeid" ]; then
 129                 __verbose "installerfw_is_efi_boot_system(): /boot is" \
 130                           "the EFI system partition (type is" "\"$__ptypeid\")"
 131                 return 0
 132         else
 133                 __verbose "installerfw_is_efi_boot_system(): no EFI" \
 134                           "system partition found (type is" "\"$__ptypeid\")"
 135                 return 1
 136         fi
 137 }
 138
 139 # Get a piece of installer framework data for a partition. At the moment the
 140 # partition is specified by it's mount point (in $1), but this can be extended
 141 # to also accept the partition number, if needed.
 142 #
 143 # The second parameter ($2) is the a partial installer framework variable name
 144 # which should be returned. For example, "PARTUUID" would correspond to
 145 # "INSTALLERFW_PARTx_PARTUUID", and so on.
 146 #
 147 # The third parameter ($3) is name of the variable to store the result at. If
 148 # the requested installer framework variable is undefined or null, the shell
 149 # variable with name stored in $3 will have null value upon exit.
 150 installerfw_get_part_info()
 151 {
 152         local __mntpoint="$1"; shift
 153         local __var="$1"; shift
 154         local __res_var="$1"; shift
 155         local __pnum="0"
 156
 157         __verify_defined "INSTALLERFW_PART_COUNT"
 158
 159         while [ "$__pnum" -lt "$INSTALLERFW_PART_COUNT" ]; do
 160                 local __mp="INSTALLERFW_PART${__pnum}_MOUNTPOINT"
 161                 __verify_defined "$__mp"
 162
 163                 __mp="$(eval printf "%s" "\"\$$__mp\"")"
 164
 165                 [ "$__mp" != "$__mntpoint" ] || break
 166
 167                 __pnum="$((__pnum+1))"
 168         done
 169
 170         local installerfw_var="INSTALLERFW_PART${__pnum}_${__var}"
 171
 172         local __value=
 173         if printenv "$installerfw_var" > /dev/null; then
 174                 __value="$(eval printf "%s" "\"\$$installerfw_var\"")"
 175         fi
 176
 177         __verbose "installerfw_get_part_info(): $__res_var=$__value"
 178         eval "$__res_var"="\"\$__value\""
 179 }