common/overlay

   1 #
   2 # overlayfs specific common functions.
   3 #
   4 . ./common/module
   5
   6 # Export overlayfs xattrs and constant value
   7 export OVL_XATTR_OPAQUE="trusted.overlay.opaque"
   8 export OVL_XATTR_REDIRECT="trusted.overlay.redirect"
   9 export OVL_XATTR_IMPURE="trusted.overlay.impure"
  10 export OVL_XATTR_ORIGIN="trusted.overlay.origin"
  11 export OVL_XATTR_NLINK="trusted.overlay.nlink"
  12 export OVL_XATTR_UPPER="trusted.overlay.upper"
  13 export OVL_XATTR_METACOPY="trusted.overlay.metacopy"
  14
  15 # helper function to do the actual overlayfs mount operation
  16 _overlay_mount_dirs()
  17 {
  18         local lowerdir=$1
  19         local upperdir=$2
  20         local workdir=$3
  21         shift 3
  22
  23         $MOUNT_PROG -t overlay -o lowerdir=$lowerdir -o upperdir=$upperdir \
  24                     -o workdir=$workdir `_common_dev_mount_options $*`
  25 }
  26
  27 # Mount with same options/mnt/dev of scratch mount, but optionally
  28 # with different lower/upper/work dirs
  29 _overlay_scratch_mount_dirs()
  30 {
  31         local lowerdir=$1
  32         local upperdir=$2
  33         local workdir=$3
  34         shift 3
  35
  36         _overlay_mount_dirs $lowerdir $upperdir $workdir \
  37                                 $* $OVL_BASE_SCRATCH_MNT $SCRATCH_MNT
  38 }
  39
  40 _overlay_mkdirs()
  41 {
  42         local dir=$1
  43
  44         mkdir -p $dir/$OVL_UPPER
  45         mkdir -p $dir/$OVL_LOWER
  46         mkdir -p $dir/$OVL_WORK
  47         mkdir -p $dir/$OVL_MNT
  48 }
  49
  50 # Given a base fs dir, set up overlay directories and mount on the given mnt.
  51 # The dir is used as the mount device so it can be seen from df or mount
  52 _overlay_mount()
  53 {
  54         local dir=$1
  55         local mnt=$2
  56         shift 2
  57
  58         _supports_filetype $dir || _notrun "upper fs needs to support d_type"
  59
  60         _overlay_mkdirs $dir
  61
  62         _overlay_mount_dirs $dir/$OVL_LOWER $dir/$OVL_UPPER $dir/$OVL_WORK \
  63                                 $* $dir $mnt
  64 }
  65
  66 _overlay_base_mount()
  67 {
  68         local devname=$1
  69         local mntname=$2
  70         local dev=$3
  71         local mnt=$4
  72         shift 4
  73
  74         if [ -z "$dev" -o -z "$mnt" ] || \
  75                 _check_mounted_on $devname $dev $mntname $mnt; then
  76                 # no base fs or already mounted
  77                 return 0
  78         elif [ $? -ne 1 ]; then
  79                 # base fs mounted but not on mount point
  80                 return 1
  81         fi
  82
  83         _mount $* $dev $mnt
  84 }
  85
  86 _overlay_base_test_mount()
  87 {
  88         _overlay_base_mount OVL_BASE_TEST_DEV OVL_BASE_TEST_DIR \
  89                         "$OVL_BASE_TEST_DEV" "$OVL_BASE_TEST_DIR" \
  90                         $TEST_FS_MOUNT_OPTS $SELINUX_MOUNT_OPTIONS
  91 }
  92
  93 _overlay_test_mount()
  94 {
  95         _overlay_base_test_mount && \
  96                 _overlay_mount $OVL_BASE_TEST_DIR $TEST_DIR $*
  97 }
  98
  99 _overlay_base_scratch_mount()
 100 {
 101         _overlay_base_mount OVL_BASE_SCRATCH_DEV OVL_BASE_SCRATCH_MNT \
 102                         "$OVL_BASE_SCRATCH_DEV" "$OVL_BASE_SCRATCH_MNT" \
 103                         $OVL_BASE_MOUNT_OPTIONS $SELINUX_MOUNT_OPTIONS
 104 }
 105
 106 _overlay_scratch_mount()
 107 {
 108         _overlay_base_scratch_mount && \
 109                 _overlay_mount $OVL_BASE_SCRATCH_MNT $SCRATCH_MNT $*
 110 }
 111
 112 _overlay_base_unmount()
 113 {
 114         local dev=$1
 115         local mnt=$2
 116
 117         [ -n "$dev" -a -n "$mnt" ] || return 0
 118
 119         $UMOUNT_PROG $mnt
 120 }
 121
 122 _overlay_test_unmount()
 123 {
 124         $UMOUNT_PROG $TEST_DIR
 125         _overlay_base_unmount "$OVL_BASE_TEST_DEV" "$OVL_BASE_TEST_DIR"
 126 }
 127
 128 _overlay_scratch_unmount()
 129 {
 130         $UMOUNT_PROG $SCRATCH_MNT
 131         _overlay_base_unmount "$OVL_BASE_SCRATCH_DEV" "$OVL_BASE_SCRATCH_MNT"
 132 }
 133
 134 # Check that a specific overlayfs feature is supported
 135 __check_scratch_overlay_feature()
 136 {
 137         local feature=$1
 138
 139         # overalyfs features (e.g. redirect_dir, index) are
 140         # configurable from Kconfig (the build default), by module
 141         # parameter (the system default) and per mount by mount
 142         # option ${feature}=[on|off].
 143         local default=`_get_fs_module_param ${feature}`
 144         [ "$default" = Y ] || [ "$default" = N ] || \
 145                 _notrun "feature '${feature}' not supported by ${FSTYP}"
 146
 147         # Check options to be sure. For example, Overlayfs will fallback to
 148         # index=off if underlying fs does not support file handles.
 149         # Overlayfs only displays mount option if it differs from the default.
 150         # Overlayfs may enable the feature, but fallback to read-only mount.
 151         ((( [ "$default" = N ] && _fs_options $SCRATCH_DEV | grep -q "${feature}=on" ) || \
 152           ( [ "$default" = Y ] && ! _fs_options $SCRATCH_DEV | grep -q "${feature}=off" )) && \
 153             touch $SCRATCH_MNT/foo 2>/dev/null ) || \
 154                 _notrun "${FSTYP} feature '${feature}' cannot be enabled on ${SCRATCH_DEV}"
 155 }
 156
 157 # Require a set of overlayfs features
 158 _require_scratch_overlay_features()
 159 {
 160         local features=( $* )
 161         local opts="rw"
 162
 163         for feature in ${features[*]}; do
 164                 # If the module parameter does not exist then there is no
 165                 # point in checking the mount option.
 166                 _get_fs_module_param ${feature} > /dev/null 2>&1 || \
 167                         _notrun "feature '${feature}' not supported by overlay"
 168                 opts+=",${feature}=on"
 169         done
 170
 171         _scratch_mkfs > /dev/null 2>&1
 172         _try_scratch_mount -o $opts || \
 173                 _notrun "overlay features '${features[*]}' cannot be enabled on ${SCRATCH_DEV}"
 174
 175         for feature in ${features[*]}; do
 176                 __check_scratch_overlay_feature ${feature}
 177         done
 178
 179         _scratch_unmount
 180 }
 181
 182 # Helper function to check underlying dirs of overlay filesystem
 183 _overlay_fsck_dirs()
 184 {
 185         local lowerdir=$1
 186         local upperdir=$2
 187         local workdir=$3
 188         shift 3
 189
 190         [[ ! -x "$FSCK_OVERLAY_PROG" ]] && return 0
 191
 192         $FSCK_OVERLAY_PROG -o lowerdir=$lowerdir -o upperdir=$upperdir \
 193                            -o workdir=$workdir $*
 194 }
 195
 196 _overlay_check_dirs()
 197 {
 198         local lowerdir=$1
 199         local upperdir=$2
 200         local workdir=$3
 201         shift 3
 202         local err=0
 203
 204         _overlay_fsck_dirs $lowerdir $upperdir $workdir \
 205                            $FSCK_OPTIONS $* >>$tmp.fsck 2>&1
 206         if [ $? -ne 0 ]; then
 207                 _log_err "_overlay_check_fs: overlayfs on $lowerdir,$upperdir,$workdir is inconsistent"
 208
 209                 echo "*** fsck.overlay output ***"      >>$seqres.full
 210                 cat $tmp.fsck                           >>$seqres.full
 211                 echo "*** end fsck.overlay output"      >>$seqres.full
 212
 213                 echo "*** mount output ***"             >>$seqres.full
 214                 _mount                                  >>$seqres.full
 215                 echo "*** end mount output"             >>$seqres.full
 216
 217                 err=1
 218         fi
 219         rm -f $tmp.fsck
 220
 221         return $err
 222 }
 223
 224 # Check the same mnt/dev of _check_overlay_scratch_fs but non-default
 225 # underlying scratch dirs of overlayfs, it needs lower/upper/work dirs
 226 # provided as arguments, and it's useful for non-default setups such
 227 # as multiple lower layers
 228 _overlay_check_scratch_dirs()
 229 {
 230         local lowerdir=$1
 231         local upperdir=$2
 232         local workdir=$3
 233         shift 3
 234
 235         # Need to umount overlay for scratch dir check
 236         local ovl_mounted=`_is_dir_mountpoint $SCRATCH_MNT`
 237         [ -z "$ovl_mounted" ] || $UMOUNT_PROG $SCRATCH_MNT
 238
 239         # Check dirs with extra overlay options
 240         _overlay_check_dirs $lowerdir $upperdir $workdir $*
 241         local ret=$?
 242
 243         if [ $ret -eq 0 -a -n "$ovl_mounted" ]; then
 244                 # overlay was mounted, remount with extra mount options
 245                 _overlay_scratch_mount_dirs $lowerdir $upperdir \
 246                                             $workdir $*
 247                 ret=$?
 248         fi
 249
 250         return $ret
 251 }
 252
 253 _overlay_check_fs()
 254 {
 255         # The first arguments is overlay mount point use for checking
 256         # overlay filesystem is mounted or not, the remaining arquments
 257         # use for mounting overlay base filesystem if it was not mounted.
 258         # We shift one to aligns arguments for _overlay_base_mount.
 259         local ovl_mnt=$1
 260         shift 1
 261
 262         local base_dev=$3
 263         local base_mnt=$4
 264
 265         [ "$FSTYP" = overlay ] || return 0
 266
 267         # Base fs needs to be mounted to check overlay dirs
 268         local base_fstype=""
 269         local ovl_mounted=""
 270
 271         [ -z "$base_dev" ] || \
 272                 base_fstype=`_fs_type $base_dev`
 273
 274         # If base_dev is set but base_fstype is empty, base fs is not
 275         # mounted, we need to mount base fs. Otherwise, we need to
 276         # check and umount overlayfs if it was mounted.
 277         if [ -n "$base_dev" -a -z "$base_fstype" ]; then
 278                 _overlay_base_mount $*
 279         else
 280                 # Check and umount overlay for dir check
 281                 ovl_mounted=`_is_dir_mountpoint $ovl_mnt`
 282                 [ -z "$ovl_mounted" ] || $UMOUNT_PROG $ovl_mnt
 283         fi
 284
 285         _overlay_check_dirs $base_mnt/$OVL_LOWER $base_mnt/$OVL_UPPER \
 286                             $base_mnt/$OVL_WORK
 287         local ret=$?
 288
 289         if [ -n "$base_dev" -a -z "$base_fstype" ]; then
 290                 _overlay_base_unmount "$base_dev" "$base_mnt"
 291         elif [ $ret -eq 0 -a -n "$ovl_mounted" ]; then
 292                 # overlay was mounted, remount besides extra mount options
 293                 _overlay_mount $base_mnt $ovl_mnt
 294                 ret=$?
 295         fi
 296
 297         if [ $ret != 0 ]; then
 298                 status=1
 299                 if [ "$iam" != "check" ]; then
 300                         exit 1
 301                 fi
 302                 return 1
 303         fi
 304
 305         return 0
 306 }
 307
 308 _check_overlay_test_fs()
 309 {
 310         _overlay_check_fs "$TEST_DIR" \
 311                 OVL_BASE_TEST_DEV OVL_BASE_TEST_DIR \
 312                 "$OVL_BASE_TEST_DEV" "$OVL_BASE_TEST_DIR" \
 313                 $TEST_FS_MOUNT_OPTS $SELINUX_MOUNT_OPTIONS
 314 }
 315
 316 _check_overlay_scratch_fs()
 317 {
 318         _overlay_check_fs "$SCRATCH_MNT" \
 319                 OVL_BASE_SCRATCH_DEV OVL_BASE_SCRATCH_MNT \
 320                 "$OVL_BASE_SCRATCH_DEV" "$OVL_BASE_SCRATCH_MNT" \
 321                 $OVL_BASE_MOUNT_OPTIONS $SELINUX_MOUNT_OPTIONS
 322 }
 323
 324 _repair_overlay_scratch_fs()
 325 {
 326         _overlay_fsck_dirs $OVL_BASE_SCRATCH_MNT/$OVL_LOWER \
 327                 $OVL_BASE_SCRATCH_MNT/$OVL_UPPER \
 328                 $OVL_BASE_SCRATCH_MNT/$OVL_WORK -y
 329         local res=$?
 330         case $res in
 331         $FSCK_OK|$FSCK_NONDESTRUCT)
 332                 res=0
 333                 ;;
 334         *)
 335                 _dump_err2 "fsck.overlay failed, err=$res"
 336                 ;;
 337         esac
 338         return $res
 339 }