ovl: file descriptors based layer setup
Subsystems (4)
Christian Brauner
maintainerv3 cover ovl: file descriptors based layer setup
Hey,
Currently overlayfs only allows specifying layers through path names. This is inconvenient for users such as systemd that want to assemble an overlayfs mount purely based on file descriptors.
When porting overlayfs to the new mount api I already mentioned this. This enables user to specify both:
fsconfig(fd_overlay, FSCONFIG_SET_FD, "upperdir+", NULL, fd_upper);
fsconfig(fd_overlay, FSCONFIG_SET_FD, "workdir+", NULL, fd_work);
fsconfig(fd_overlay, FSCONFIG_SET_FD, "lowerdir+", NULL, fd_lower1);
fsconfig(fd_overlay, FSCONFIG_SET_FD, "lowerdir+", NULL, fd_lower2);in addition to:
fsconfig(fd_overlay, FSCONFIG_SET_STRING, "upperdir+", "/upper", 0);
fsconfig(fd_overlay, FSCONFIG_SET_STRING, "workdir+", "/work", 0);
fsconfig(fd_overlay, FSCONFIG_SET_STRING, "lowerdir+", "/lower1", 0);
fsconfig(fd_overlay, FSCONFIG_SET_STRING, "lowerdir+", "/lower2", 0);The selftest contains an example for this.
---
Changes in v3:
- Add documentation into overlayfs.rst.
- Rename new mount api parsing helper.
- Change cleanup scope in helper.
- Link to v2: https://lore.kernel.org/r/[email protected]
Changes in v2:
- Alias fd and path based mount options.
- Link to v1: https://lore.kernel.org/r/[email protected]
---
Christian Brauner (5):
fs: add helper to use mount option as path or fd
ovl: specify layers via file descriptors Documentation,ovl: document new file descriptor based layers
selftests: use shared header
selftests: add overlayfs fd mounting selftests
Documentation/filesystems/overlayfs.rst | 17 +++ fs/fs_parser.c | 20 +++ fs/overlayfs/params.c | 116 ++++++++++++---- include/linux/fs_parser.h | 5 +- .../selftests/filesystems/overlayfs/.gitignore | 1 + .../selftests/filesystems/overlayfs/Makefile | 2 +- .../selftests/filesystems/overlayfs/dev_in_maps.c | 27 +--- .../filesystems/overlayfs/set_layers_via_fds.c | 152 +++++++++++++++++++++ .../selftests/filesystems/overlayfs/wrappers.h | 47 +++++++ 9 files changed, 334 insertions(+), 53 deletions(-)
---
base-commit: 8cf0b93919e13d1e8d4466eb4080a4c4d9d66d7b
change-id: 20241011-work-overlayfs-dbcfa9223e87
Christian Brauner
maintainerPATCH v3 1/5 fs: add helper to use mount option as path or fd
Allow filesystems to use a mount option either as a file or path.
--- fs/fs_parser.c | 20 ++++++++++++++++++++ include/linux/fs_parser.h | 5 ++++- 2 files changed, 24 insertions(+), 1 deletion(-)
fs/fs_parser.c +20 -0
@@ -308,6 +308,26 @@ int fs_param_is_fd(struct p_log *log, const struct fs_parameter_spec *p, }EXPORT_SYMBOL (fs_param_is_fd); +int fs_param_is_file_or_string (struct p_log *log, +const struct fs_parameter_spec *p, +struct fs_parameter *param, +struct fs_parse_result *result) +{ +switch (param->type) { +case fs_value_is_string: +return fs_param_is_string (log, p, param, result); +case fs_value_is_file: + result->uint_32 = param->dirfd; +if (result->uint_32 <=INT_MAX ) +return 0 ; +break ; +default : +break ; + } +return fs_param_bad_value (log, param); +} +EXPORT_SYMBOL (fs_param_is_file_or_string); +int fs_param_is_uid (struct p_log *log,const struct fs_parameter_spec *p,struct fs_parameter *param,struct fs_parse_result *result) {
include/linux/fs_parser.h +4 -1
@@ -28,7 +28,8 @@ typedef int fs_param_type(struct p_log *,*/ fs_param_type fs_param_is_bool, fs_param_is_u32, fs_param_is_s32, fs_param_is_u64, fs_param_is_enum, fs_param_is_string, fs_param_is_blob, fs_param_is_blockdev, - fs_param_is_path, fs_param_is_fd, fs_param_is_uid, fs_param_is_gid; + fs_param_is_path, fs_param_is_fd, fs_param_is_uid, fs_param_is_gid, + fs_param_is_file_or_string;/* * Specification of the type of value a parameter wants.
@@ -133,6 +134,8 @@ static inline bool fs_validate_description(const char *name,#define fsparam_bdev (NAME ,OPT ) __fsparam(fs_param_is_blockdev, NAME, OPT, 0, NULL)#define fsparam_path (NAME ,OPT ) __fsparam(fs_param_is_path, NAME, OPT, 0, NULL)#define fsparam_fd (NAME ,OPT ) __fsparam(fs_param_is_fd, NAME, OPT, 0, NULL) +#define fsparam_file_or_string (NAME ,OPT ) \ + __fsparam(fs_param_is_file_or_string, NAME, OPT, 0, NULL)#define fsparam_uid (NAME ,OPT ) __fsparam(fs_param_is_uid, NAME, OPT, 0, NULL)#define fsparam_gid (NAME ,OPT ) __fsparam(fs_param_is_gid, NAME, OPT, 0, NULL)
Signature · 1 line
2.45.2
Christian Brauner
maintainerPATCH v3 2/5 ovl: specify layers via file descriptors
In reply to Christian BraunerCurrently overlayfs only allows specifying layers through path names. This is inconvenient for users such as systemd that want to assemble an overlayfs mount purely based on file descriptors.
This enables user to specify both:
fsconfig(fd_overlay, FSCONFIG_SET_FD, "upperdir+", NULL, fd_upper);
fsconfig(fd_overlay, FSCONFIG_SET_FD, "workdir+", NULL, fd_work);
fsconfig(fd_overlay, FSCONFIG_SET_FD, "lowerdir+", NULL, fd_lower1);
fsconfig(fd_overlay, FSCONFIG_SET_FD, "lowerdir+", NULL, fd_lower2);in addition to:
fsconfig(fd_overlay, FSCONFIG_SET_STRING, "upperdir+", "/upper", 0);
fsconfig(fd_overlay, FSCONFIG_SET_STRING, "workdir+", "/work", 0);
fsconfig(fd_overlay, FSCONFIG_SET_STRING, "lowerdir+", "/lower1", 0);
fsconfig(fd_overlay, FSCONFIG_SET_STRING, "lowerdir+", "/lower2", 0);--- fs/overlayfs/params.c | 116 +++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 91 insertions(+), 25 deletions(-)
fs/overlayfs/params.c +91 -25
@@ -141,10 +141,10 @@ static int ovl_verity_mode_def(void)const struct fs_parameter_spec ovl_parameter_spec[] = {fsparam_string_empty ("lowerdir" , Opt_lowerdir), -fsparam_string ("lowerdir+" , Opt_lowerdir_add), -fsparam_string ("datadir+" , Opt_datadir_add), -fsparam_string ("upperdir" , Opt_upperdir), -fsparam_string ("workdir" , Opt_workdir), +fsparam_file_or_string ("lowerdir+" , Opt_lowerdir_add), +fsparam_file_or_string ("datadir+" , Opt_datadir_add), +fsparam_file_or_string ("upperdir" , Opt_upperdir), +fsparam_file_or_string ("workdir" , Opt_workdir),fsparam_flag ("default_permissions" , Opt_default_permissions),fsparam_enum ("redirect_dir" , Opt_redirect_dir, ovl_parameter_redirect_dir),fsparam_enum ("index" , Opt_index, ovl_parameter_bool),
@@ -367,40 +367,100 @@ static void ovl_add_layer(struct fs_context *fc, enum ovl_opt layer, } } -static int ovl_parse_layer (struct fs_context *fc,const char *layer_name,enum ovl_opt layer) +static inline bool is_upper_layer (enum ovl_opt layer) +{ +return layer == Opt_upperdir || layer == Opt_workdir; +} + +/* Handle non-file descriptor-based layer options that require path lookup. */ +static inline int ovl_kern_path (const char *layer_name,struct path *layer_path, +enum ovl_opt layer) { -char *name =kstrdup (layer_name,GFP_KERNEL ); -bool upper = (layer == Opt_upperdir || layer == Opt_workdir); -struct path path;int err; +switch (layer) { +case Opt_upperdir: + fallthrough; +case Opt_workdir: + fallthrough; +case Opt_lowerdir: + err =ovl_mount_dir (layer_name, layer_path); +break ; +case Opt_lowerdir_add: + fallthrough; +case Opt_datadir_add: + err =ovl_mount_dir_noesc (layer_name, layer_path); +break ; +default : +WARN_ON_ONCE (true); + err = -EINVAL ; + } + +return err; +} + +static int ovl_do_parse_layer (struct fs_context *fc,const char *layer_name, +struct path *layer_path,enum ovl_opt layer) +{ + char *name __free(kfree) = kstrdup(layer_name, GFP_KERNEL); +bool upper; +int err =0 ; +if (!name)return -ENOMEM ; -if (upper || layer == Opt_lowerdir) - err =ovl_mount_dir (name, &path); -else - err =ovl_mount_dir_noesc (name, &path); + upper =is_upper_layer (layer); + err =ovl_mount_dir_check (fc, layer_path, layer, name, upper);if (err) - goto out_free; - - err =ovl_mount_dir_check (fc, &path, layer, name, upper); -if (err) - goto out_put; +return err;if (!upper) { err =ovl_ctx_realloc_lower (fc);if (err) - goto out_put; +return err; }/* Store the user provided path string in ctx to show in mountinfo */ -ovl_add_layer (fc, layer, &path, &name); +ovl_add_layer (fc, layer, layer_path, &name); +return err; +} + +static int ovl_parse_layer (struct fs_context *fc,struct fs_parameter *param, +enum ovl_opt layer) +{ + struct path layer_path __free(path_put) = {}; +int err =0 ; + +switch (param->type) { +case fs_value_is_string: + err =ovl_kern_path (param->string, &layer_path, layer); +if (err) +return err; + err =ovl_do_parse_layer (fc, param->string, &layer_path, layer); +break ; +case fs_value_is_file: { + char *buf __free(kfree); +char *layer_name; + + buf =kmalloc (PATH_MAX ,GFP_KERNEL_ACCOUNT ); +if (!buf) +return -ENOMEM ; + + layer_path = param->file->f_path; +path_get (&layer_path); + + layer_name =d_path (&layer_path, buf,PATH_MAX ); +if (IS_ERR (layer_name)) +return PTR_ERR (layer_name); + + err =ovl_do_parse_layer (fc, layer_name, &layer_path, layer); +break ; + } +default : +WARN_ON_ONCE (true); + err = -EINVAL ; + } -out_put: -path_put (&path); -out_free: -kfree (name);return err; }
@@ -474,7 +534,13 @@ static int ovl_parse_param_lowerdir(const char *name, struct fs_context *fc) iter = dup;for (nr =0 ; nr < nr_lower; nr++) { - err =ovl_parse_layer (fc, iter, Opt_lowerdir); + struct path path __free(path_put) = {}; + + err =ovl_kern_path (iter, &path, Opt_lowerdir); +if (err) + goto out_err; + + err =ovl_do_parse_layer (fc, iter, &path, Opt_lowerdir);if (err) goto out_err;
@@ -555,7 +621,7 @@ static int ovl_parse_param(struct fs_context *fc, struct fs_parameter *param)case Opt_datadir_add:case Opt_upperdir:case Opt_workdir: - err =ovl_parse_layer (fc, param->string, opt); + err =ovl_parse_layer (fc, param, opt);break ;case Opt_default_permissions: config->default_permissions = true;
Signature · 1 line
2.45.2
Miklos Szeredi
maintainerRe: [PATCH v3 2/5] ovl: specify layers via file descriptors
fs/overlayfs/params.c static void ovl_add_layer(struct fs_context *fc, enum ovl_opt layer, · line 438
Quoted 11 lines · Christian Brauner
fs/overlayfs/params.c +11
-0+static int ovl_parse_layer (struct fs_context *fc,struct fs_parameter *param, +enum ovl_opt layer) +{ + struct path layer_path __free(path_put) = {}; +int err =0 ; + +switch (param->type) { +case fs_value_is_string: + err =ovl_kern_path (param->string, &layer_path, layer); +if (err) +return err;
What guarantees, that layer_path will not be stored to in the error case?
Common sense, yes. But I'm sure there are hundreds of cases where it's not the case, despite common sense.
Can static checkers deal with this?
Thanks,
Miklos
Christian Brauner
maintainerRe: [PATCH v3 2/5] ovl: specify layers via file descriptors
Quoted 1 line
Can static checkers deal with this?
I don't know.
Christian Brauner
maintainerPATCH v3 3/5 Documentation,ovl: document new file descriptor based layers
In reply to Christian BraunerAdd a minimal example how to specify layers via file descriptors.
--- Documentation/filesystems/overlayfs.rst | 17 +++++++++++++++++ 1 file changed, 17 insertions(+)
Documentation/filesystems/overlayfs.rst +17 -0
@@ -440,6 +440,23 @@ For example:: fsconfig(fs_fd, FSCONFIG_SET_STRING, "datadir+", "/do2", 0); +Specifying layers via file descriptors +-------------------------------------- + +Since kernel v6.13, overlayfs supports specifying layers via file descriptors in +addition to specifying them as paths. This feature is available for the +"datadir+", "lowerdir+", "upperdir", and "workdir+" mount options with the +fsconfig syscall from the new mount api:: + + fsconfig(fs_fd, FSCONFIG_SET_FD, "lowerdir+", NULL, fd_lower1); + fsconfig(fs_fd, FSCONFIG_SET_FD, "lowerdir+", NULL, fd_lower2); + fsconfig(fs_fd, FSCONFIG_SET_FD, "lowerdir+", NULL, fd_lower3); + fsconfig(fs_fd, FSCONFIG_SET_FD, "datadir+", NULL, fd_data1); + fsconfig(fs_fd, FSCONFIG_SET_FD, "datadir+", NULL, fd_data2); + fsconfig(fs_fd, FSCONFIG_SET_FD, "workdir", NULL, fd_work); + fsconfig(fs_fd, FSCONFIG_SET_FD, "upperdir", NULL, fd_upper); + + fs-verity support -----------------
Signature · 1 line
2.45.2
Christian Brauner
maintainerPATCH v3 4/5 selftests: use shared header
In reply to Christian BraunerSo that we don't have to redefine the same system calls over and over.
--- .../selftests/filesystems/overlayfs/dev_in_maps.c | 27 +------------- .../selftests/filesystems/overlayfs/wrappers.h | 43 ++++++++++++++++++++++ 2 files changed, 44 insertions(+), 26 deletions(-)
tools/testing/selftests/filesystems/overlayfs/dev_in_maps.c +1 -26
@@ -17,32 +17,7 @@#include "../../kselftest.h" #include "log.h" - -static int sys_fsopen (const char *fsname,unsigned int flags) -{ -return syscall (__NR_fsopen, fsname, flags); -} - -static int sys_fsconfig (int fd,unsigned int cmd,const char *key,const char *value,int aux) -{ -return syscall (__NR_fsconfig, fd, cmd, key, value, aux); -} - -static int sys_fsmount (int fd,unsigned int flags,unsigned int attr_flags) -{ -return syscall (__NR_fsmount, fd, flags, attr_flags); -} -static int sys_mount (const char *src,const char *tgt,const char *fst, -unsigned long flags,const void *data) -{ -return syscall (__NR_mount, src, tgt, fst, flags, data); -} -static int sys_move_mount (int from_dfd,const char *from_pathname, -int to_dfd,const char *to_pathname, -unsigned int flags) -{ -return syscall (__NR_move_mount, from_dfd, from_pathname, to_dfd, to_pathname, flags); -} +#include "wrappers.h" static long get_file_dev_and_inode (void *addr,struct statx *stx) {
tools/testing/selftests/filesystems/overlayfs/wrappers.h new file +43 -0
43 lines not on this page · raw message
Signature · 1 line
2.45.2
Christian Brauner
maintainerPATCH v3 5/5 selftests: add overlayfs fd mounting selftests
In reply to Christian Brauner--- .../selftests/filesystems/overlayfs/.gitignore | 1 + .../selftests/filesystems/overlayfs/Makefile | 2 +- .../filesystems/overlayfs/set_layers_via_fds.c | 152 +++++++++++++++++++++ .../selftests/filesystems/overlayfs/wrappers.h | 4 + 4 files changed, 158 insertions(+), 1 deletion(-)
tools/testing/selftests/filesystems/overlayfs/.gitignore +1 -0
@@ -1,2 +1,3 @@ # SPDX-License-Identifier: GPL-2.0-only dev_in_maps +set_layers_via_fds
tools/testing/selftests/filesystems/overlayfs/Makefile +1 -1
@@ -1,6 +1,6 @@ # SPDX-License-Identifier: GPL-2.0 -TEST_GEN_PROGS := dev_in_maps +TEST_GEN_PROGS := dev_in_maps set_layers_via_fds CFLAGS := -Wall -Werror
tools/testing/selftests/filesystems/overlayfs/set_layers_via_fds.c new file +152 -0
152 lines not on this page · raw message
tools/testing/selftests/filesystems/overlayfs/wrappers.h +4 -0
@@ -32,6 +32,10 @@ static inline int sys_mount(const char *src, const char *tgt, const char *fst,return syscall (__NR_mount, src, tgt, fst, flags, data); } +#ifndef MOVE_MOUNT_F_EMPTY_PATH +#define MOVE_MOUNT_F_EMPTY_PATH 0x00000004/* Empty from path permitted */ +#endif +static inline int sys_move_mount (int from_dfd,const char *from_pathname,int to_dfd,const char *to_pathname,unsigned int flags)
Signature · 1 line
2.45.2
Quoted 17 lines · Christian Brauner
Hey,
Currently overlayfs only allows specifying layers through path names. This is inconvenient for users such as systemd that want to assemble an overlayfs mount purely based on file descriptors.
When porting overlayfs to the new mount api I already mentioned this. This enables user to specify both:
fsconfig(fd_overlay, FSCONFIG_SET_FD, "upperdir+", NULL, fd_upper); fsconfig(fd_overlay, FSCONFIG_SET_FD, "workdir+", NULL, fd_work); fsconfig(fd_overlay, FSCONFIG_SET_FD, "lowerdir+", NULL, fd_lower1); fsconfig(fd_overlay, FSCONFIG_SET_FD, "lowerdir+", NULL, fd_lower2);in addition to:
Quoted 8 lines
fsconfig(fd_overlay, FSCONFIG_SET_STRING, "upperdir+", "/upper", 0); fsconfig(fd_overlay, FSCONFIG_SET_STRING, "workdir+", "/work", 0); fsconfig(fd_overlay, FSCONFIG_SET_STRING, "lowerdir+", "/lower1", 0); fsconfig(fd_overlay, FSCONFIG_SET_STRING, "lowerdir+", "/lower2", 0);The selftest contains an example for this.
Signed-off-by Christian Brauner <[email protected]>
For the series:
Let me know if you want me to pick those up through the ovl tree. I don't expect any merge conflicts with other pending ovl patches.
Thanks,
Amir.
Quoted 33 lines
---
Changes in v3:
- Add documentation intooverlayfs.rst.
- Rename new mount api parsing helper.
- Change cleanup scope in helper.
- Link to v2: https://lore.kernel.org/r/[email protected]Changes in v2:
- Alias fd and path based mount options.
- Link to v1: https://lore.kernel.org/r/[email protected]---
Christian Brauner (5):
fs: add helper to use mount option as path or fd
ovl: specify layers via file descriptors Documentation,ovl: document new file descriptor based layers
selftests: use shared header
selftests: add overlayfs fd mounting selftestsDocumentation/filesystems/overlayfs.rst | 17 +++ fs/fs_parser.c | 20 +++ fs/overlayfs/params.c | 116 ++++++++++++---- include/linux/fs_parser.h | 5 +- .../selftests/filesystems/overlayfs/.gitignore | 1 + .../selftests/filesystems/overlayfs/Makefile | 2 +- .../selftests/filesystems/overlayfs/dev_in_maps.c | 27 +--- .../filesystems/overlayfs/set_layers_via_fds.c | 152 +++++++++++++++++++++ .../selftests/filesystems/overlayfs/wrappers.h | 47 +++++++ 9 files changed, 334 insertions(+), 53 deletions(-)---
base-commit:8cf0b93919e13d1e8d4466eb4080a4c4d9d66d7b
change-id: 20241011-work-overlayfs-dbcfa9223e87