Skip to contentSkip to conversation

overlay: create helper _overlay_scratch_mount_opts()

PATCH In review Amir Goldstein 1 participant 2 messages Dec 6, 2023 – Dec 25, 2023

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 overlay: create helper _overlay_scratch_mount_opts()

The new overlayfs mount options lowerdir+,datadir+ don't fit well into any of the existing _overlay_scratch_mount* helpers. Add this new helper to reduce a common pattern of custom mount options.

---

Zorro,

Here is the cleanup patch that you suggested.

Note that tests overlay/083 and overlay/086 intentionally use $MOUNT_PROG directly because some of the tests cases use escaping character "\" and calling _overlay_mount_* helpers can loose the special chars escaping when bash is evaluating the arguments.

Maybe it is solvabale, but that would be very high on the list of things that I do not want to do.

Thanks,
Amir.

 common/overlay    | 8 +++++++-
 tests/overlay/011 | 2 +-
 tests/overlay/035 | 3 +--
 tests/overlay/052 | 4 ++--
 tests/overlay/053 | 4 ++--
 tests/overlay/062 | 2 +-
 tests/overlay/079 | 4 ++--
 tests/overlay/085 | 4 ++--
 8 files changed, 18 insertions(+), 13 deletions(-)
common/overlay +7 -1
index ea1eb7b1..faa9339a 100644
@@ -32,6 +32,12 @@ _overlay_mount_dirs()
 	$MOUNT_PROG -t overlay $diropts `_common_dev_mount_options $*`
 }
 
+# Mount with mnt/dev of scratch mount and custom mount options
+_overlay_scratch_mount_opts()
+{
+	$MOUNT_PROG -t overlay $OVL_BASE_SCRATCH_MNT $SCRATCH_MNT $*
+}
+
 # Mount with same options/mnt/dev of scratch mount, but optionally
 # with different lower/upper/work dirs
 _overlay_scratch_mount_dirs()
@@ -254,7 +260,7 @@ _require_scratch_overlay_lowerdir_add_layers()
 	local datadir="$OVL_BASE_SCRATCH_MNT/$OVL_LOWER"
 
 	_scratch_mkfs > /dev/null 2>&1
-	$MOUNT_PROG -t overlay $OVL_BASE_SCRATCH_MNT $SCRATCH_MNT \
+	_overlay_scratch_mount_opts \
 		-o"lowerdir+=$lowerdir,datadir+=$datadir" \
 		-o"redirect_dir=follow,metacopy=on" > /dev/null 2>&1 || \
 	        _notrun "overlay lowerdir+,datadir+ not supported on ${SCRATCH_DEV}"
tests/overlay/011 +1 -1
index 20812d88..09a950ba 100755
@@ -37,7 +37,7 @@ $SETFATTR_PROG -n "trusted.overlay.opaque" -v "y" $upperdir/testdir
 # $upperdir overlaid on top of $lowerdir, so that "trusted.overlay.opaque"
 # xattr should be honored and should not be listed
 # mount readonly, because there's no upper and workdir
-$MOUNT_PROG -t overlay -o ro -o lowerdir=$upperdir:$lowerdir $OVL_BASE_SCRATCH_MNT $SCRATCH_MNT
+_overlay_scratch_mount_opts -o ro -o lowerdir=$upperdir:$lowerdir
 
 # Dump trusted.overlay xattr, we should not see the "opaque" xattr
 _getfattr -d -m overlay $SCRATCH_MNT/testdir
tests/overlay/035 +1 -2
index 8cd76979..f4c981ad 100755
@@ -42,8 +42,7 @@ mkdir -p $lowerdir1 $lowerdir2 $upperdir $workdir
 
 # Mount overlay with lower layers only.
 # Verify that overlay is mounted read-only and that it cannot be remounted rw.
-$MOUNT_PROG -t overlay -o"lowerdir=$lowerdir2:$lowerdir1" \
-			$OVL_BASE_SCRATCH_MNT $SCRATCH_MNT
+_overlay_scratch_mount_opts -o"lowerdir=$lowerdir2:$lowerdir1"
 touch $SCRATCH_MNT/foo 2>&1 | _filter_scratch
 $MOUNT_PROG -o remount,rw $SCRATCH_MNT 2>&1 | _filter_ro_mount
 $UMOUNT_PROG $SCRATCH_MNT
tests/overlay/052 +2 -2
index da8c645b..6abe2e01 100755
@@ -133,7 +133,7 @@ unmount_dirs
 
 # Check encode/decode/read of lower file handles on lower layers only r/o overlay.
 # For non-upper overlay mount, nfs_export requires disabling redirect_dir.
-$MOUNT_PROG -t overlay $OVL_BASE_SCRATCH_MNT $SCRATCH_MNT \
+_overlay_scratch_mount_opts \
 			-o ro,redirect_dir=nofollow,nfs_export=on,lowerdir=$middle:$lower
 test_file_handles $SCRATCH_MNT/lowertestdir -rp
 test_file_handles $SCRATCH_MNT/lowertestdir/subdir -rp
@@ -144,7 +144,7 @@ unmount_dirs
 # Overlay lookup cannot follow the redirect from $upper/lowertestdir.new to
 # $lower/lowertestdir. Instead, we mount an overlay subtree rooted at these
 # directories.
-$MOUNT_PROG -t overlay $OVL_BASE_SCRATCH_MNT $SCRATCH_MNT \
+_overlay_scratch_mount_opts \
 		-o ro,redirect_dir=nofollow,nfs_export=on,lowerdir=$upper/lowertestdir.new:$lower/lowertestdir
 test_file_handles $SCRATCH_MNT -r
 test_file_handles $SCRATCH_MNT/subdir -rp
tests/overlay/053 +2 -2
index dfa29d01..cf94f930 100755
@@ -162,7 +162,7 @@ unmount_dirs
 
 # Check encode/decode/read of lower file handles on lower layers only r/o overlay.
 # For non-upper overlay mount, nfs_export requires disabling redirect_dir.
-$MOUNT_PROG -t overlay $OVL_BASE_SCRATCH_MNT $SCRATCH_MNT \
+_overlay_scratch_mount_opts \
 			-o ro,redirect_dir=nofollow,nfs_export=on,lowerdir=$middle:$lower
 test_file_handles $SCRATCH_MNT/lowertestdir -rp
 test_file_handles $SCRATCH_MNT/lowertestdir/subdir -rp
@@ -173,7 +173,7 @@ unmount_dirs
 # Overlay lookup cannot follow the redirect from $upper/lowertestdir.new to
 # $lower/lowertestdir. Instead, we mount an overlay subtree rooted at these
 # directories.
-$MOUNT_PROG -t overlay $OVL_BASE_SCRATCH_MNT $SCRATCH_MNT \
+_overlay_scratch_mount_opts \
 		-o ro,redirect_dir=nofollow,nfs_export=on,lowerdir=$upper/lowertestdir.new:$lower/lowertestdir
 test_file_handles $SCRATCH_MNT -r
 test_file_handles $SCRATCH_MNT/subdir -rp
tests/overlay/062 +1 -1
index 04e13e46..a4e9560a 100755
@@ -65,7 +65,7 @@ create_test_files $lowertestdir
 $MOUNT_PROG --bind $lowertestdir $lowertestdir
 
 # For non-upper overlay mount, nfs_export requires disabling redirect_dir.
-$MOUNT_PROG -t overlay $OVL_BASE_SCRATCH_MNT $SCRATCH_MNT \
+_overlay_scratch_mount_opts \
 	-o ro,redirect_dir=nofollow,nfs_export=on,lowerdir=$lower:$lower2
 
 # Decode an overlay directory file handle, whose underlying lower dir dentry
tests/overlay/079 +2 -2
index 078ee816..f28fc313 100755
@@ -141,7 +141,7 @@ mount_overlay()
 {
 	local _lowerdir=$1 _datadir2=$2 _datadir=$3
 
-	$MOUNT_PROG -t overlay $OVL_BASE_SCRATCH_MNT $SCRATCH_MNT \
+	_overlay_scratch_mount_opts \
 		-o"lowerdir=$_lowerdir::$_datadir2::$_datadir" \
 		-o"upperdir=$upperdir,workdir=$workdir" \
 		-o redirect_dir=on,metacopy=on
@@ -151,7 +151,7 @@ mount_ro_overlay()
 {
 	local _lowerdir=$1 _datadir2=$2 _datadir=$3
 
-	$MOUNT_PROG -t overlay $OVL_BASE_SCRATCH_MNT $SCRATCH_MNT \
+	_overlay_scratch_mount_opts \
 		-o"lowerdir=$_lowerdir::$_datadir2::$_datadir" \
 		-o redirect_dir=follow,metacopy=on
 }
tests/overlay/085 +2 -2
index 07a32c24..0f4e4b06 100755
@@ -142,7 +142,7 @@ mount_overlay()
 {
 	local _lowerdir=$1 _datadir2=$2 _datadir=$3
 
-	$MOUNT_PROG -t overlay $OVL_BASE_SCRATCH_MNT $SCRATCH_MNT \
+	_overlay_scratch_mount_opts \
 		-o"lowerdir+=$_lowerdir,datadir+=$_datadir2,datadir+=$_datadir" \
 		-o"upperdir=$upperdir,workdir=$workdir" \
 		-o redirect_dir=on,metacopy=on
@@ -152,7 +152,7 @@ mount_ro_overlay()
 {
 	local _lowerdir=$1 _datadir2=$2 _datadir=$3
 
-	$MOUNT_PROG -t overlay $OVL_BASE_SCRATCH_MNT $SCRATCH_MNT \
+	_overlay_scratch_mount_opts \
 		-o"lowerdir+=$_lowerdir,datadir+=$_datadir2,datadir+=$_datadir" \
 		-o redirect_dir=follow,metacopy=on
 }
Signature · 1 line
2.34.1
#1 lore raw
Quoted 13 lines · Amir Goldstein

The new overlayfs mount options lowerdir+,datadir+ don't fit well into any of the existing _overlay_scratch_mount* helpers. Add this new helper to reduce a common pattern of custom mount options.

---

Zorro,

Here is the cleanup patch that you suggested.

Quoted 8 lines

Note that tests overlay/083 and overlay/086 intentionally use $MOUNT_PROG directly because some of the tests cases use escaping character "\" and calling _overlay_mount_* helpers can loose the special chars escaping when bash is evaluating the arguments.

Maybe it is solvabale, but that would be very high on the list of things that I do not want to do.

Hi Zorro,

I guess you missed this cleanup patch for the Xmas release. Oh well, next time.

Merry Christmas and Happy New Year!

Thanks,
Amir.

Quoted 168 lines
 common/overlay    | 8 +++++++-
 tests/overlay/011 | 2 +-
 tests/overlay/035 | 3 +--
 tests/overlay/052 | 4 ++--
 tests/overlay/053 | 4 ++--
 tests/overlay/062 | 2 +-
 tests/overlay/079 | 4 ++--
 tests/overlay/085 | 4 ++--
 8 files changed, 18 insertions(+), 13 deletions(-)
common/overlay +7 -1
index ea1eb7b1..faa9339a 100644
@@ -32,6 +32,12 @@ _overlay_mount_dirs()
        $MOUNT_PROG -t overlay $diropts `_common_dev_mount_options $*`
 }
 
+# Mount with mnt/dev of scratch mount and custom mount options
+_overlay_scratch_mount_opts()
+{
+       $MOUNT_PROG -t overlay $OVL_BASE_SCRATCH_MNT $SCRATCH_MNT $*
+}
+
 # Mount with same options/mnt/dev of scratch mount, but optionally
 # with different lower/upper/work dirs
 _overlay_scratch_mount_dirs()
@@ -254,7 +260,7 @@ _require_scratch_overlay_lowerdir_add_layers()
        local datadir="$OVL_BASE_SCRATCH_MNT/$OVL_LOWER"
 
        _scratch_mkfs > /dev/null 2>&1
-       $MOUNT_PROG -t overlay $OVL_BASE_SCRATCH_MNT $SCRATCH_MNT \
+       _overlay_scratch_mount_opts \
                -o"lowerdir+=$lowerdir,datadir+=$datadir" \
                -o"redirect_dir=follow,metacopy=on" > /dev/null 2>&1 || \
                _notrun "overlay lowerdir+,datadir+ not supported on ${SCRATCH_DEV}"
tests/overlay/011 +1 -1
index 20812d88..09a950ba 100755
@@ -37,7 +37,7 @@ $SETFATTR_PROG -n "trusted.overlay.opaque" -v "y" $upperdir/testdir
 # $upperdir overlaid on top of $lowerdir, so that "trusted.overlay.opaque"
 # xattr should be honored and should not be listed
 # mount readonly, because there's no upper and workdir
-$MOUNT_PROG -t overlay -o ro -o lowerdir=$upperdir:$lowerdir $OVL_BASE_SCRATCH_MNT $SCRATCH_MNT
+_overlay_scratch_mount_opts -o ro -o lowerdir=$upperdir:$lowerdir
 
 # Dump trusted.overlay xattr, we should not see the "opaque" xattr
 _getfattr -d -m overlay $SCRATCH_MNT/testdir
tests/overlay/035 +1 -2
index 8cd76979..f4c981ad 100755
@@ -42,8 +42,7 @@ mkdir -p $lowerdir1 $lowerdir2 $upperdir $workdir
 
 # Mount overlay with lower layers only.
 # Verify that overlay is mounted read-only and that it cannot be remounted rw.
-$MOUNT_PROG -t overlay -o"lowerdir=$lowerdir2:$lowerdir1" \
-                       $OVL_BASE_SCRATCH_MNT $SCRATCH_MNT
+_overlay_scratch_mount_opts -o"lowerdir=$lowerdir2:$lowerdir1"
 touch $SCRATCH_MNT/foo 2>&1 | _filter_scratch
 $MOUNT_PROG -o remount,rw $SCRATCH_MNT 2>&1 | _filter_ro_mount
 $UMOUNT_PROG $SCRATCH_MNT
tests/overlay/052 +2 -2
index da8c645b..6abe2e01 100755
@@ -133,7 +133,7 @@ unmount_dirs
 
 # Check encode/decode/read of lower file handles on lower layers only r/o overlay.
 # For non-upper overlay mount, nfs_export requires disabling redirect_dir.
-$MOUNT_PROG -t overlay $OVL_BASE_SCRATCH_MNT $SCRATCH_MNT \
+_overlay_scratch_mount_opts \
                        -o ro,redirect_dir=nofollow,nfs_export=on,lowerdir=$middle:$lower
 test_file_handles $SCRATCH_MNT/lowertestdir -rp
 test_file_handles $SCRATCH_MNT/lowertestdir/subdir -rp
@@ -144,7 +144,7 @@ unmount_dirs
 # Overlay lookup cannot follow the redirect from $upper/lowertestdir.new to
 # $lower/lowertestdir. Instead, we mount an overlay subtree rooted at these
 # directories.
-$MOUNT_PROG -t overlay $OVL_BASE_SCRATCH_MNT $SCRATCH_MNT \
+_overlay_scratch_mount_opts \
                -o ro,redirect_dir=nofollow,nfs_export=on,lowerdir=$upper/lowertestdir.new:$lower/lowertestdir
 test_file_handles $SCRATCH_MNT -r
 test_file_handles $SCRATCH_MNT/subdir -rp
tests/overlay/053 +2 -2
index dfa29d01..cf94f930 100755
@@ -162,7 +162,7 @@ unmount_dirs
 
 # Check encode/decode/read of lower file handles on lower layers only r/o overlay.
 # For non-upper overlay mount, nfs_export requires disabling redirect_dir.
-$MOUNT_PROG -t overlay $OVL_BASE_SCRATCH_MNT $SCRATCH_MNT \
+_overlay_scratch_mount_opts \
                        -o ro,redirect_dir=nofollow,nfs_export=on,lowerdir=$middle:$lower
 test_file_handles $SCRATCH_MNT/lowertestdir -rp
 test_file_handles $SCRATCH_MNT/lowertestdir/subdir -rp
@@ -173,7 +173,7 @@ unmount_dirs
 # Overlay lookup cannot follow the redirect from $upper/lowertestdir.new to
 # $lower/lowertestdir. Instead, we mount an overlay subtree rooted at these
 # directories.
-$MOUNT_PROG -t overlay $OVL_BASE_SCRATCH_MNT $SCRATCH_MNT \
+_overlay_scratch_mount_opts \
                -o ro,redirect_dir=nofollow,nfs_export=on,lowerdir=$upper/lowertestdir.new:$lower/lowertestdir
 test_file_handles $SCRATCH_MNT -r
 test_file_handles $SCRATCH_MNT/subdir -rp
tests/overlay/062 +1 -1
index 04e13e46..a4e9560a 100755
@@ -65,7 +65,7 @@ create_test_files $lowertestdir
 $MOUNT_PROG --bind $lowertestdir $lowertestdir
 
 # For non-upper overlay mount, nfs_export requires disabling redirect_dir.
-$MOUNT_PROG -t overlay $OVL_BASE_SCRATCH_MNT $SCRATCH_MNT \
+_overlay_scratch_mount_opts \
        -o ro,redirect_dir=nofollow,nfs_export=on,lowerdir=$lower:$lower2
 
 # Decode an overlay directory file handle, whose underlying lower dir dentry
tests/overlay/079 +2 -2
index 078ee816..f28fc313 100755
@@ -141,7 +141,7 @@ mount_overlay()
 {
        local _lowerdir=$1 _datadir2=$2 _datadir=$3
 
-       $MOUNT_PROG -t overlay $OVL_BASE_SCRATCH_MNT $SCRATCH_MNT \
+       _overlay_scratch_mount_opts \
                -o"lowerdir=$_lowerdir::$_datadir2::$_datadir" \
                -o"upperdir=$upperdir,workdir=$workdir" \
                -o redirect_dir=on,metacopy=on
@@ -151,7 +151,7 @@ mount_ro_overlay()
 {
        local _lowerdir=$1 _datadir2=$2 _datadir=$3
 
-       $MOUNT_PROG -t overlay $OVL_BASE_SCRATCH_MNT $SCRATCH_MNT \
+       _overlay_scratch_mount_opts \
                -o"lowerdir=$_lowerdir::$_datadir2::$_datadir" \
                -o redirect_dir=follow,metacopy=on
 }
tests/overlay/085 +2 -3
index 07a32c24..0f4e4b06 100755
@@ -142,7 +142,7 @@ mount_overlay()
 {
        local _lowerdir=$1 _datadir2=$2 _datadir=$3
 
-       $MOUNT_PROG -t overlay $OVL_BASE_SCRATCH_MNT $SCRATCH_MNT \
+       _overlay_scratch_mount_opts \
                -o"lowerdir+=$_lowerdir,datadir+=$_datadir2,datadir+=$_datadir" \
                -o"upperdir=$upperdir,workdir=$workdir" \
                -o redirect_dir=on,metacopy=on
@@ -152,7 +152,7 @@ mount_ro_overlay()
 {
        local _lowerdir=$1 _datadir2=$2 _datadir=$3
 
-       $MOUNT_PROG -t overlay $OVL_BASE_SCRATCH_MNT $SCRATCH_MNT \
+       _overlay_scratch_mount_opts \
                -o"lowerdir+=$_lowerdir,datadir+=$_datadir2,datadir+=$_datadir" \
                -o redirect_dir=follow,metacopy=on
 }
--

2.34.1