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         if echo "$*" | grep -q remount; then
 109                 $MOUNT_PROG $SCRATCH_MNT $*
 110                 return
 111         fi
 112
 113         _overlay_base_scratch_mount && \
 114                 _overlay_mount $OVL_BASE_SCRATCH_MNT $SCRATCH_MNT $*
 115 }
 116
 117 _overlay_base_unmount()
 118 {
 119         local dev=$1
 120         local mnt=$2
 121
 122         [ -n "$dev" -a -n "$mnt" ] || return 0
 123
 124         $UMOUNT_PROG $mnt
 125 }
 126
 127 _overlay_test_unmount()
 128 {
 129         $UMOUNT_PROG $TEST_DIR
 130         _overlay_base_unmount "$OVL_BASE_TEST_DEV" "$OVL_BASE_TEST_DIR"
 131 }
 132
 133 _overlay_scratch_unmount()
 134 {
 135         $UMOUNT_PROG $SCRATCH_MNT
 136         _overlay_base_unmount "$OVL_BASE_SCRATCH_DEV" "$OVL_BASE_SCRATCH_MNT"
 137 }
 138
 139 # Check that a specific overlayfs feature is supported
 140 __check_scratch_overlay_feature()
 141 {
 142         local feature=$1
 143
 144         # overalyfs features (e.g. redirect_dir, index) are
 145         # configurable from Kconfig (the build default), by module
 146         # parameter (the system default) and per mount by mount
 147         # option ${feature}=[on|off].
 148         local default=`_get_fs_module_param ${feature}`
 149         [ "$default" = Y ] || [ "$default" = N ] || \
 150                 _notrun "feature '${feature}' not supported by ${FSTYP}"
 151
 152         # Check options to be sure. For example, Overlayfs will fallback to
 153         # index=off if underlying fs does not support file handles.
 154         # Overlayfs only displays mount option if it differs from the default.
 155         # Overlayfs may enable the feature, but fallback to read-only mount.
 156         ((( [ "$default" = N ] && _fs_options $SCRATCH_DEV | grep -q "${feature}=on" ) || \
 157           ( [ "$default" = Y ] && ! _fs_options $SCRATCH_DEV | grep -q "${feature}=off" )) && \
 158             touch $SCRATCH_MNT/foo 2>/dev/null ) || \
 159                 _notrun "${FSTYP} feature '${feature}' cannot be enabled on ${SCRATCH_DEV}"
 160 }
 161
 162 # Require a set of overlayfs features
 163 _require_scratch_overlay_features()
 164 {
 165         local features=( $* )
 166         local opts="rw"
 167
 168         for feature in ${features[*]}; do
 169                 # If the module parameter does not exist then there is no
 170                 # point in checking the mount option.
 171                 _get_fs_module_param ${feature} > /dev/null 2>&1 || \
 172                         _notrun "feature '${feature}' not supported by overlay"
 173                 opts+=",${feature}=on"
 174         done
 175
 176         _scratch_mkfs > /dev/null 2>&1
 177         _try_scratch_mount -o $opts || \
 178                 _notrun "overlay features '${features[*]}' cannot be enabled on ${SCRATCH_DEV}"
 179
 180         for feature in ${features[*]}; do
 181                 __check_scratch_overlay_feature ${feature}
 182         done
 183
 184         _scratch_unmount
 185 }
 186
 187 # Helper function to check underlying dirs of overlay filesystem
 188 _overlay_fsck_dirs()
 189 {
 190         local lowerdir=$1
 191         local upperdir=$2
 192         local workdir=$3
 193         shift 3
 194
 195         [[ ! -x "$FSCK_OVERLAY_PROG" ]] && return 0
 196
 197         $FSCK_OVERLAY_PROG -o lowerdir=$lowerdir -o upperdir=$upperdir \
 198                            -o workdir=$workdir $*
 199 }
 200
 201 # Run fsck and check for expected return value
 202 _overlay_fsck_expect()
 203 {
 204         # The first arguments is the expected fsck program exit code, the
 205         # remaining arguments are the input parameters of the fsck program.
 206         local expect_ret=$1
 207         local lowerdir=$2
 208         local upperdir=$3
 209         local workdir=$4
 210         shift 4
 211
 212         _overlay_fsck_dirs $lowerdir $upperdir $workdir $* >> \
 213                         $seqres.full 2>&1
 214         fsck_ret=$?
 215
 216         [[ "$fsck_ret" == "$expect_ret" ]] || \
 217                 echo "expect fsck.overlay to return $expect_ret, but got $fsck_ret"
 218 }
 219
 220 _overlay_check_dirs()
 221 {
 222         local lowerdir=$1
 223         local upperdir=$2
 224         local workdir=$3
 225         shift 3
 226         local err=0
 227
 228         _overlay_fsck_dirs $lowerdir $upperdir $workdir \
 229                            $FSCK_OPTIONS $* >>$tmp.fsck 2>&1
 230         if [ $? -ne 0 ]; then
 231                 _log_err "_overlay_check_fs: overlayfs on $lowerdir,$upperdir,$workdir is inconsistent"
 232
 233                 echo "*** fsck.overlay output ***"      >>$seqres.full
 234                 cat $tmp.fsck                           >>$seqres.full
 235                 echo "*** end fsck.overlay output"      >>$seqres.full
 236
 237                 echo "*** mount output ***"             >>$seqres.full
 238                 _mount                                  >>$seqres.full
 239                 echo "*** end mount output"             >>$seqres.full
 240
 241                 err=1
 242         fi
 243         rm -f $tmp.fsck
 244
 245         return $err
 246 }
 247
 248 # Check the same mnt/dev of _check_overlay_scratch_fs but non-default
 249 # underlying scratch dirs of overlayfs, it needs lower/upper/work dirs
 250 # provided as arguments, and it's useful for non-default setups such
 251 # as multiple lower layers
 252 _overlay_check_scratch_dirs()
 253 {
 254         local lowerdir=$1
 255         local upperdir=$2
 256         local workdir=$3
 257         shift 3
 258
 259         # Need to umount overlay for scratch dir check
 260         local ovl_mounted=`_is_dir_mountpoint $SCRATCH_MNT`
 261         [ -z "$ovl_mounted" ] || $UMOUNT_PROG $SCRATCH_MNT
 262
 263         # Check dirs with extra overlay options
 264         _overlay_check_dirs $lowerdir $upperdir $workdir $*
 265         local ret=$?
 266
 267         if [ $ret -eq 0 -a -n "$ovl_mounted" ]; then
 268                 # overlay was mounted, remount with extra mount options
 269                 _overlay_scratch_mount_dirs $lowerdir $upperdir \
 270                                             $workdir $*
 271                 ret=$?
 272         fi
 273
 274         return $ret
 275 }
 276
 277 _overlay_check_fs()
 278 {
 279         # The first arguments is overlay mount point use for checking
 280         # overlay filesystem is mounted or not, the remaining arquments
 281         # use for mounting overlay base filesystem if it was not mounted.
 282         # We shift one to aligns arguments for _overlay_base_mount.
 283         local ovl_mnt=$1
 284         shift 1
 285
 286         local base_dev=$3
 287         local base_mnt=$4
 288
 289         [ "$FSTYP" = overlay ] || return 0
 290
 291         # Base fs needs to be mounted to check overlay dirs
 292         local base_fstype=""
 293         local ovl_mounted=""
 294
 295         [ -z "$base_dev" ] || \
 296                 base_fstype=`_fs_type $base_dev`
 297
 298         # If base_dev is set but base_fstype is empty, base fs is not
 299         # mounted, we need to mount base fs. Otherwise, we need to
 300         # check and umount overlayfs if it was mounted.
 301         if [ -n "$base_dev" -a -z "$base_fstype" ]; then
 302                 _overlay_base_mount $*
 303         else
 304                 # Check and umount overlay for dir check
 305                 ovl_mounted=`_is_dir_mountpoint $ovl_mnt`
 306                 [ -z "$ovl_mounted" ] || $UMOUNT_PROG $ovl_mnt
 307         fi
 308
 309         _overlay_check_dirs $base_mnt/$OVL_LOWER $base_mnt/$OVL_UPPER \
 310                             $base_mnt/$OVL_WORK
 311         local ret=$?
 312
 313         if [ -n "$base_dev" -a -z "$base_fstype" ]; then
 314                 _overlay_base_unmount "$base_dev" "$base_mnt"
 315         elif [ $ret -eq 0 -a -n "$ovl_mounted" ]; then
 316                 # overlay was mounted, remount besides extra mount options
 317                 _overlay_mount $base_mnt $ovl_mnt
 318                 ret=$?
 319         fi
 320
 321         if [ $ret != 0 ]; then
 322                 status=1
 323                 if [ "$iam" != "check" ]; then
 324                         exit 1
 325                 fi
 326                 return 1
 327         fi
 328
 329         return 0
 330 }
 331
 332 _check_overlay_test_fs()
 333 {
 334         _overlay_check_fs "$TEST_DIR" \
 335                 OVL_BASE_TEST_DEV OVL_BASE_TEST_DIR \
 336                 "$OVL_BASE_TEST_DEV" "$OVL_BASE_TEST_DIR" \
 337                 $TEST_FS_MOUNT_OPTS $SELINUX_MOUNT_OPTIONS
 338 }
 339
 340 _check_overlay_scratch_fs()
 341 {
 342         _overlay_check_fs "$SCRATCH_MNT" \
 343                 OVL_BASE_SCRATCH_DEV OVL_BASE_SCRATCH_MNT \
 344                 "$OVL_BASE_SCRATCH_DEV" "$OVL_BASE_SCRATCH_MNT" \
 345                 $OVL_BASE_MOUNT_OPTIONS $SELINUX_MOUNT_OPTIONS
 346 }
 347
 348 _repair_overlay_scratch_fs()
 349 {
 350         _overlay_fsck_dirs $OVL_BASE_SCRATCH_MNT/$OVL_LOWER \
 351                 $OVL_BASE_SCRATCH_MNT/$OVL_UPPER \
 352                 $OVL_BASE_SCRATCH_MNT/$OVL_WORK -y
 353         local res=$?
 354         case $res in
 355         $FSCK_OK|$FSCK_NONDESTRUCT)
 356                 res=0
 357                 ;;
 358         *)
 359                 _dump_err2 "fsck.overlay failed, err=$res"
 360                 ;;
 361         esac
 362         return $res
 363 }