2 # overlayfs specific common functions.
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"
15 # helper function to do the actual overlayfs mount operation
23 $MOUNT_PROG -t overlay -o lowerdir=$lowerdir -o upperdir=$upperdir \
24 -o workdir=$workdir `_common_dev_mount_options $*`
27 # Mount with same options/mnt/dev of scratch mount, but optionally
28 # with different lower/upper/work dirs
29 _overlay_scratch_mount_dirs()
36 _overlay_mount_dirs $lowerdir $upperdir $workdir \
37 $* $OVL_BASE_SCRATCH_MNT $SCRATCH_MNT
44 mkdir -p $dir/$OVL_UPPER
45 mkdir -p $dir/$OVL_LOWER
46 mkdir -p $dir/$OVL_WORK
47 mkdir -p $dir/$OVL_MNT
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
58 _supports_filetype $dir || _notrun "upper fs needs to support d_type"
62 _overlay_mount_dirs $dir/$OVL_LOWER $dir/$OVL_UPPER $dir/$OVL_WORK \
74 if [ -z "$dev" -o -z "$mnt" ] || \
75 _check_mounted_on $devname $dev $mntname $mnt; then
76 # no base fs or already mounted
78 elif [ $? -ne 1 ]; then
79 # base fs mounted but not on mount point
86 _overlay_base_test_mount()
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
95 _overlay_base_test_mount && \
96 _overlay_mount $OVL_BASE_TEST_DIR $TEST_DIR $*
99 _overlay_base_scratch_mount()
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
106 _overlay_scratch_mount()
108 _overlay_base_scratch_mount && \
109 _overlay_mount $OVL_BASE_SCRATCH_MNT $SCRATCH_MNT $*
112 _overlay_base_unmount()
117 [ -n "$dev" -a -n "$mnt" ] || return 0
122 _overlay_test_unmount()
124 $UMOUNT_PROG $TEST_DIR
125 _overlay_base_unmount "$OVL_BASE_TEST_DEV" "$OVL_BASE_TEST_DIR"
128 _overlay_scratch_unmount()
130 $UMOUNT_PROG $SCRATCH_MNT
131 _overlay_base_unmount "$OVL_BASE_SCRATCH_DEV" "$OVL_BASE_SCRATCH_MNT"
134 # Check that a specific overlayfs feature is supported
135 __check_scratch_overlay_feature()
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}"
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}"
157 # Require a set of overlayfs features
158 _require_scratch_overlay_features()
160 local features=( $* )
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"
171 _scratch_mkfs > /dev/null 2>&1
172 _try_scratch_mount -o $opts || \
173 _notrun "overlay features '${features[*]}' cannot be enabled on ${SCRATCH_DEV}"
175 for feature in ${features[*]}; do
176 __check_scratch_overlay_feature ${feature}
182 # Helper function to check underlying dirs of overlay filesystem
190 [[ ! -x "$FSCK_OVERLAY_PROG" ]] && return 0
192 $FSCK_OVERLAY_PROG -o lowerdir=$lowerdir -o upperdir=$upperdir \
193 -o workdir=$workdir $*
196 # Run fsck and check for expected return value
197 _overlay_fsck_expect()
199 # The first arguments is the expected fsck program exit code, the
200 # remaining arguments are the input parameters of the fsck program.
207 _overlay_fsck_dirs $lowerdir $upperdir $workdir $* >> \
211 [[ "$fsck_ret" == "$expect_ret" ]] || \
212 echo "expect fsck.overlay to return $expect_ret, but got $fsck_ret"
215 _overlay_check_dirs()
223 _overlay_fsck_dirs $lowerdir $upperdir $workdir \
224 $FSCK_OPTIONS $* >>$tmp.fsck 2>&1
225 if [ $? -ne 0 ]; then
226 _log_err "_overlay_check_fs: overlayfs on $lowerdir,$upperdir,$workdir is inconsistent"
228 echo "*** fsck.overlay output ***" >>$seqres.full
229 cat $tmp.fsck >>$seqres.full
230 echo "*** end fsck.overlay output" >>$seqres.full
232 echo "*** mount output ***" >>$seqres.full
233 _mount >>$seqres.full
234 echo "*** end mount output" >>$seqres.full
243 # Check the same mnt/dev of _check_overlay_scratch_fs but non-default
244 # underlying scratch dirs of overlayfs, it needs lower/upper/work dirs
245 # provided as arguments, and it's useful for non-default setups such
246 # as multiple lower layers
247 _overlay_check_scratch_dirs()
254 # Need to umount overlay for scratch dir check
255 local ovl_mounted=`_is_dir_mountpoint $SCRATCH_MNT`
256 [ -z "$ovl_mounted" ] || $UMOUNT_PROG $SCRATCH_MNT
258 # Check dirs with extra overlay options
259 _overlay_check_dirs $lowerdir $upperdir $workdir $*
262 if [ $ret -eq 0 -a -n "$ovl_mounted" ]; then
263 # overlay was mounted, remount with extra mount options
264 _overlay_scratch_mount_dirs $lowerdir $upperdir \
274 # The first arguments is overlay mount point use for checking
275 # overlay filesystem is mounted or not, the remaining arquments
276 # use for mounting overlay base filesystem if it was not mounted.
277 # We shift one to aligns arguments for _overlay_base_mount.
284 [ "$FSTYP" = overlay ] || return 0
286 # Base fs needs to be mounted to check overlay dirs
290 [ -z "$base_dev" ] || \
291 base_fstype=`_fs_type $base_dev`
293 # If base_dev is set but base_fstype is empty, base fs is not
294 # mounted, we need to mount base fs. Otherwise, we need to
295 # check and umount overlayfs if it was mounted.
296 if [ -n "$base_dev" -a -z "$base_fstype" ]; then
297 _overlay_base_mount $*
299 # Check and umount overlay for dir check
300 ovl_mounted=`_is_dir_mountpoint $ovl_mnt`
301 [ -z "$ovl_mounted" ] || $UMOUNT_PROG $ovl_mnt
304 _overlay_check_dirs $base_mnt/$OVL_LOWER $base_mnt/$OVL_UPPER \
308 if [ -n "$base_dev" -a -z "$base_fstype" ]; then
309 _overlay_base_unmount "$base_dev" "$base_mnt"
310 elif [ $ret -eq 0 -a -n "$ovl_mounted" ]; then
311 # overlay was mounted, remount besides extra mount options
312 _overlay_mount $base_mnt $ovl_mnt
316 if [ $ret != 0 ]; then
318 if [ "$iam" != "check" ]; then
327 _check_overlay_test_fs()
329 _overlay_check_fs "$TEST_DIR" \
330 OVL_BASE_TEST_DEV OVL_BASE_TEST_DIR \
331 "$OVL_BASE_TEST_DEV" "$OVL_BASE_TEST_DIR" \
332 $TEST_FS_MOUNT_OPTS $SELINUX_MOUNT_OPTIONS
335 _check_overlay_scratch_fs()
337 _overlay_check_fs "$SCRATCH_MNT" \
338 OVL_BASE_SCRATCH_DEV OVL_BASE_SCRATCH_MNT \
339 "$OVL_BASE_SCRATCH_DEV" "$OVL_BASE_SCRATCH_MNT" \
340 $OVL_BASE_MOUNT_OPTIONS $SELINUX_MOUNT_OPTIONS
343 _repair_overlay_scratch_fs()
345 _overlay_fsck_dirs $OVL_BASE_SCRATCH_MNT/$OVL_LOWER \
346 $OVL_BASE_SCRATCH_MNT/$OVL_UPPER \
347 $OVL_BASE_SCRATCH_MNT/$OVL_WORK -y
350 $FSCK_OK|$FSCK_NONDESTRUCT)
354 _dump_err2 "fsck.overlay failed, err=$res"