ovl: specify layers via file descriptors
Subsystems (3)
Christian Brauner
maintainercover ovl: specify layers via file descriptors
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 provided patches for this but we decided to keep this work separate. This is a revamp of the patchset as the use-case has become more urgent.
This introduces the new mount options:
lowerdir_fd+
datadir_fd+upperdir_fdworkdir_fd
which can be used as follows:
fsconfig(fd_overlay, FSCONFIG_SET_FD, "upperdir_fd+", NULL, fd_upper); fsconfig(fd_overlay, FSCONFIG_SET_FD, "workdir_fd+", NULL, fd_work); fsconfig(fd_overlay, FSCONFIG_SET_FD, "lowerdir_fd+", NULL, fd_lower1); fsconfig(fd_overlay, FSCONFIG_SET_FD, "lowerdir_fd+", NULL, fd_lower2);
The selftest contains an example for this.
The mount api doesn't allow overloading of mount option parameters (except for strings and flags). Making this work for arbitrary parameters would be quite ugly or file descriptors would have to be special cased. Neither is very appealing. I do prefer the *_fd mount options because they aren't ambiguous.
---
Christian Brauner (3):
ovl: specify layers via file descriptors
selftests: use shared header
selftests: add overlayfs fd mounting selftests
fs/overlayfs/params.c | 132 +++++++++++++++++---- .../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 | 122 +++++++++++++++++++ .../selftests/filesystems/overlayfs/wrappers.h | 47 ++++++++ 6 files changed, 281 insertions(+), 50 deletions(-)
---
base-commit: 8cf0b93919e13d1e8d4466eb4080a4c4d9d66d7b
change-id: 20241011-work-overlayfs-dbcfa9223e87
Christian Brauner
maintainerRFC PATCH 1/3 ovl: specify layers via file descriptors
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.
This introduces the new mount options:
lowerdir_fd+
datadir_fd+
upperdir_fd
workdir_fd
which can be used as follows:
fsconfig(fd_overlay, FSCONFIG_SET_FD, "upperdir_fd+", NULL, fd_upper);
fsconfig(fd_overlay, FSCONFIG_SET_FD, "workdir_fd+", NULL, fd_work);
fsconfig(fd_overlay, FSCONFIG_SET_FD, "lowerdir_fd+", NULL, fd_lower1);
fsconfig(fd_overlay, FSCONFIG_SET_FD, "lowerdir_fd+", NULL, fd_lower2);Since the mount api doesn't allow overloading of mount option parameters (except for strings and flags). Making this work for arbitrary parameters would be quite ugly or file descriptors would have to be special cased. Neither is very appealing. I do prefer the *_fd mount options because they aren't ambiguous.
--- fs/overlayfs/params.c | 132 +++++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 109 insertions(+), 23 deletions(-)
fs/overlayfs/params.c +109 -23
@@ -59,6 +59,10 @@ enum ovl_opt { Opt_metacopy, Opt_verity, Opt_volatile, + Opt_lowerdir_add_fd, + Opt_datadir_add_fd, + Opt_upperdir_fd, + Opt_workdir_fd, }; static const struct constant_table ovl_parameter_bool[] = {
@@ -155,6 +159,10 @@ const struct fs_parameter_spec ovl_parameter_spec[] = {fsparam_enum ("metacopy" , Opt_metacopy, ovl_parameter_bool),fsparam_enum ("verity" , Opt_verity, ovl_parameter_verity),fsparam_flag ("volatile" , Opt_volatile), +fsparam_fd ("lowerdir_fd+" , Opt_lowerdir_add_fd), +fsparam_fd ("datadir_fd+" , Opt_datadir_add_fd), +fsparam_fd ("upperdir_fd" , Opt_upperdir_fd), + fsparam_fd("workdir_fd", Opt_workdir_fd), {} };
@@ -343,19 +351,27 @@ static void ovl_add_layer(struct fs_context *fc, enum ovl_opt layer,switch (layer) {case Opt_workdir: + fallthrough; +case Opt_workdir_fd:swap (config->workdir, *pname);swap (ctx->work, *path);break ;case Opt_upperdir: + fallthrough; +case Opt_upperdir_fd:swap (config->upperdir, *pname);swap (ctx->upper, *path);break ;case Opt_datadir_add: + fallthrough; +case Opt_datadir_add_fd: ctx->nr_data++; fallthrough;case Opt_lowerdir: fallthrough;case Opt_lowerdir_add: + fallthrough; +case Opt_lowerdir_add_fd:WARN_ON (ctx->nr >= ctx->capacity); l = &ctx->lower[ctx->nr++];memset (l,0 ,sizeof (*l));
@@ -367,43 +383,96 @@ 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) { -char *name =kstrdup (layer_name,GFP_KERNEL ); -bool upper = (layer == Opt_upperdir || layer == Opt_workdir); -struct path path; -int err; +return layer == Opt_upperdir || layer == Opt_upperdir_fd || + layer == Opt_workdir || layer == Opt_workdir_fd; +} + +static inline bool is_layer_fd (enum ovl_opt layer) +{ +return layer == Opt_upperdir_fd || layer == Opt_workdir_fd || + layer == Opt_lowerdir_add_fd || layer == Opt_datadir_add_fd; +} + +/* 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) +{ +switch (layer) { +case Opt_upperdir: + fallthrough; +case Opt_workdir: + fallthrough; +case Opt_lowerdir: +return ovl_mount_dir (layer_name, layer_path); +case Opt_lowerdir_add: + fallthrough; +case Opt_datadir_add: +return ovl_mount_dir_noesc (layer_name, layer_path); +default : +WARN_ON_ONCE (true); +return -EINVAL ; + } + +return 0 ; +} + +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); -if (err) - goto out_free; - - err =ovl_mount_dir_check (fc, &path, layer, name, upper); + upper =is_upper_layer (layer); + err =ovl_mount_dir_check (fc, layer_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); - -out_put: -path_put (&path); -out_free: -kfree (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 path __free(path_put) = {}; + char *buf __free(kfree) = NULL; +char *layer_name; +int err =0 ; + +if (is_layer_fd (layer)) { + buf =kmalloc (PATH_MAX ,GFP_KERNEL_ACCOUNT ); +if (!buf) +return -ENOMEM ; + + path = param->file->f_path; +path_get (&path); + + layer_name =d_path (&path, buf,PATH_MAX ); +if (IS_ERR (layer_name)) +return PTR_ERR (layer_name); + }else { + layer_name = param->string; + err =ovl_kern_path (layer_name, &path, layer); + } +if (err) +return err; + +return ovl_do_parse_layer (fc, layer_name, &path, layer); +} +static void ovl_reset_lowerdirs (struct ovl_fs_context *ctx) {struct ovl_fs_context_layer *l = ctx->lower;
@@ -474,7 +543,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;
@@ -552,10 +627,21 @@ static int ovl_parse_param(struct fs_context *fc, struct fs_parameter *param) err =ovl_parse_param_lowerdir (param->string, fc);break ;case Opt_lowerdir_add: + fallthrough;case Opt_datadir_add: + fallthrough;case Opt_upperdir: + fallthrough;case Opt_workdir: - err =ovl_parse_layer (fc, param->string, opt); + fallthrough; +case Opt_lowerdir_add_fd: + fallthrough; +case Opt_datadir_add_fd: + fallthrough; +case Opt_upperdir_fd: + fallthrough; +case Opt_workdir_fd: + err =ovl_parse_layer (fc, param, opt);break ;case Opt_default_permissions: config->default_permissions = true;
Signature · 1 line
2.45.2
Christian Brauner
maintainerRFC PATCH 2/3 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
maintainerRFC PATCH 3/3 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 | 122 +++++++++++++++++++++ .../selftests/filesystems/overlayfs/wrappers.h | 4 + 4 files changed, 128 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 +122 -0
122 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
Miklos Szeredi
maintainerQuoted 5 lines · Christian Brauner
The mount api doesn't allow overloading of mount option parameters (except for strings and flags). Making this work for arbitrary parameters would be quite ugly or file descriptors would have to be special cased. Neither is very appealing. I do prefer the
*_fdmount options because they aren't ambiguous.
But the fd's just represent a path (they can be O_PATH, right?)
So upperdir and upperdir_fd are exactly the same options, no? Just the representation is different.
Am I missing something?
Thanks,
Miklos
Christian Brauner
maintainerQuoted 4 lines
But the fd's just represent a path (they can be
O_PATH, right?)So upperdir and
upperdir_fdare exactly the same options, no? Just the representation is different.
So I misread the code which lead me to believe that aliasing would be more involved but it really isn't. Just give me a minute to fix this.