xref: /openbmc/linux/fs/overlayfs/params.c (revision 26532aeb3cec005d85b99298430077cb44858490)
1 // SPDX-License-Identifier: GPL-2.0-only
2 
3 #include <linux/fs.h>
4 #include <linux/module.h>
5 #include <linux/namei.h>
6 #include <linux/fs_context.h>
7 #include <linux/fs_parser.h>
8 #include <linux/posix_acl_xattr.h>
9 #include <linux/seq_file.h>
10 #include <linux/xattr.h>
11 #include "overlayfs.h"
12 #include "params.h"
13 
14 static bool ovl_redirect_dir_def = IS_ENABLED(CONFIG_OVERLAY_FS_REDIRECT_DIR);
15 module_param_named(redirect_dir, ovl_redirect_dir_def, bool, 0644);
16 MODULE_PARM_DESC(redirect_dir,
17 		 "Default to on or off for the redirect_dir feature");
18 
19 static bool ovl_redirect_always_follow =
20 	IS_ENABLED(CONFIG_OVERLAY_FS_REDIRECT_ALWAYS_FOLLOW);
21 module_param_named(redirect_always_follow, ovl_redirect_always_follow,
22 		   bool, 0644);
23 MODULE_PARM_DESC(redirect_always_follow,
24 		 "Follow redirects even if redirect_dir feature is turned off");
25 
26 static bool ovl_xino_auto_def = IS_ENABLED(CONFIG_OVERLAY_FS_XINO_AUTO);
27 module_param_named(xino_auto, ovl_xino_auto_def, bool, 0644);
28 MODULE_PARM_DESC(xino_auto,
29 		 "Auto enable xino feature");
30 
31 static bool ovl_index_def = IS_ENABLED(CONFIG_OVERLAY_FS_INDEX);
32 module_param_named(index, ovl_index_def, bool, 0644);
33 MODULE_PARM_DESC(index,
34 		 "Default to on or off for the inodes index feature");
35 
36 static bool ovl_nfs_export_def = IS_ENABLED(CONFIG_OVERLAY_FS_NFS_EXPORT);
37 module_param_named(nfs_export, ovl_nfs_export_def, bool, 0644);
38 MODULE_PARM_DESC(nfs_export,
39 		 "Default to on or off for the NFS export feature");
40 
41 static bool ovl_metacopy_def = IS_ENABLED(CONFIG_OVERLAY_FS_METACOPY);
42 module_param_named(metacopy, ovl_metacopy_def, bool, 0644);
43 MODULE_PARM_DESC(metacopy,
44 		 "Default to on or off for the metadata only copy up feature");
45 
46 enum {
47 	Opt_lowerdir,
48 	Opt_upperdir,
49 	Opt_workdir,
50 	Opt_default_permissions,
51 	Opt_redirect_dir,
52 	Opt_index,
53 	Opt_uuid,
54 	Opt_nfs_export,
55 	Opt_userxattr,
56 	Opt_xino,
57 	Opt_metacopy,
58 	Opt_verity,
59 	Opt_volatile,
60 };
61 
62 static const struct constant_table ovl_parameter_bool[] = {
63 	{ "on",		true  },
64 	{ "off",	false },
65 	{}
66 };
67 
68 static const struct constant_table ovl_parameter_uuid[] = {
69 	{ "off",	OVL_UUID_OFF  },
70 	{ "null",	OVL_UUID_NULL },
71 	{ "auto",	OVL_UUID_AUTO },
72 	{ "on",		OVL_UUID_ON   },
73 	{}
74 };
75 
76 static const char *ovl_uuid_mode(struct ovl_config *config)
77 {
78 	return ovl_parameter_uuid[config->uuid].name;
79 }
80 
81 static int ovl_uuid_def(void)
82 {
83 	return OVL_UUID_AUTO;
84 }
85 
86 static const struct constant_table ovl_parameter_xino[] = {
87 	{ "off",	OVL_XINO_OFF  },
88 	{ "auto",	OVL_XINO_AUTO },
89 	{ "on",		OVL_XINO_ON   },
90 	{}
91 };
92 
93 const char *ovl_xino_mode(struct ovl_config *config)
94 {
95 	return ovl_parameter_xino[config->xino].name;
96 }
97 
98 static int ovl_xino_def(void)
99 {
100 	return ovl_xino_auto_def ? OVL_XINO_AUTO : OVL_XINO_OFF;
101 }
102 
103 const struct constant_table ovl_parameter_redirect_dir[] = {
104 	{ "off",	OVL_REDIRECT_OFF      },
105 	{ "follow",	OVL_REDIRECT_FOLLOW   },
106 	{ "nofollow",	OVL_REDIRECT_NOFOLLOW },
107 	{ "on",		OVL_REDIRECT_ON       },
108 	{}
109 };
110 
111 static const char *ovl_redirect_mode(struct ovl_config *config)
112 {
113 	return ovl_parameter_redirect_dir[config->redirect_mode].name;
114 }
115 
116 static int ovl_redirect_mode_def(void)
117 {
118 	return ovl_redirect_dir_def	  ? OVL_REDIRECT_ON :
119 	       ovl_redirect_always_follow ? OVL_REDIRECT_FOLLOW :
120 					    OVL_REDIRECT_NOFOLLOW;
121 }
122 
123 static const struct constant_table ovl_parameter_verity[] = {
124 	{ "off",	OVL_VERITY_OFF     },
125 	{ "on",		OVL_VERITY_ON      },
126 	{ "require",	OVL_VERITY_REQUIRE },
127 	{}
128 };
129 
130 static const char *ovl_verity_mode(struct ovl_config *config)
131 {
132 	return ovl_parameter_verity[config->verity_mode].name;
133 }
134 
135 static int ovl_verity_mode_def(void)
136 {
137 	return OVL_VERITY_OFF;
138 }
139 
140 #define fsparam_string_empty(NAME, OPT) \
141 	__fsparam(fs_param_is_string, NAME, OPT, fs_param_can_be_empty, NULL)
142 
143 const struct fs_parameter_spec ovl_parameter_spec[] = {
144 	fsparam_string_empty("lowerdir",    Opt_lowerdir),
145 	fsparam_string("upperdir",          Opt_upperdir),
146 	fsparam_string("workdir",           Opt_workdir),
147 	fsparam_flag("default_permissions", Opt_default_permissions),
148 	fsparam_enum("redirect_dir",        Opt_redirect_dir, ovl_parameter_redirect_dir),
149 	fsparam_enum("index",               Opt_index, ovl_parameter_bool),
150 	fsparam_enum("uuid",                Opt_uuid, ovl_parameter_uuid),
151 	fsparam_enum("nfs_export",          Opt_nfs_export, ovl_parameter_bool),
152 	fsparam_flag("userxattr",           Opt_userxattr),
153 	fsparam_enum("xino",                Opt_xino, ovl_parameter_xino),
154 	fsparam_enum("metacopy",            Opt_metacopy, ovl_parameter_bool),
155 	fsparam_enum("verity",              Opt_verity, ovl_parameter_verity),
156 	fsparam_flag("volatile",            Opt_volatile),
157 	{}
158 };
159 
160 static char *ovl_next_opt(char **s)
161 {
162 	char *sbegin = *s;
163 	char *p;
164 
165 	if (sbegin == NULL)
166 		return NULL;
167 
168 	for (p = sbegin; *p; p++) {
169 		if (*p == '\\') {
170 			p++;
171 			if (!*p)
172 				break;
173 		} else if (*p == ',') {
174 			*p = '\0';
175 			*s = p + 1;
176 			return sbegin;
177 		}
178 	}
179 	*s = NULL;
180 	return sbegin;
181 }
182 
183 static int ovl_parse_monolithic(struct fs_context *fc, void *data)
184 {
185 	return vfs_parse_monolithic_sep(fc, data, ovl_next_opt);
186 }
187 
188 static ssize_t ovl_parse_param_split_lowerdirs(char *str)
189 {
190 	ssize_t nr_layers = 1, nr_colons = 0;
191 	char *s, *d;
192 
193 	for (s = d = str;; s++, d++) {
194 		if (*s == '\\') {
195 			/* keep esc chars in split lowerdir */
196 			*d++ = *s++;
197 		} else if (*s == ':') {
198 			bool next_colon = (*(s + 1) == ':');
199 
200 			nr_colons++;
201 			if (nr_colons == 2 && next_colon) {
202 				pr_err("only single ':' or double '::' sequences of unescaped colons in lowerdir mount option allowed.\n");
203 				return -EINVAL;
204 			}
205 			/* count layers, not colons */
206 			if (!next_colon)
207 				nr_layers++;
208 
209 			*d = '\0';
210 			continue;
211 		}
212 
213 		*d = *s;
214 		if (!*s) {
215 			/* trailing colons */
216 			if (nr_colons) {
217 				pr_err("unescaped trailing colons in lowerdir mount option.\n");
218 				return -EINVAL;
219 			}
220 			break;
221 		}
222 		nr_colons = 0;
223 	}
224 
225 	return nr_layers;
226 }
227 
228 static int ovl_mount_dir_noesc(const char *name, struct path *path)
229 {
230 	int err = -EINVAL;
231 
232 	if (!*name) {
233 		pr_err("empty lowerdir\n");
234 		goto out;
235 	}
236 	err = kern_path(name, LOOKUP_FOLLOW, path);
237 	if (err) {
238 		pr_err("failed to resolve '%s': %i\n", name, err);
239 		goto out;
240 	}
241 	err = -EINVAL;
242 	if (ovl_dentry_weird(path->dentry)) {
243 		pr_err("filesystem on '%s' not supported\n", name);
244 		goto out_put;
245 	}
246 	if (!d_is_dir(path->dentry)) {
247 		pr_err("'%s' not a directory\n", name);
248 		goto out_put;
249 	}
250 	return 0;
251 
252 out_put:
253 	path_put_init(path);
254 out:
255 	return err;
256 }
257 
258 static void ovl_unescape(char *s)
259 {
260 	char *d = s;
261 
262 	for (;; s++, d++) {
263 		if (*s == '\\')
264 			s++;
265 		*d = *s;
266 		if (!*s)
267 			break;
268 	}
269 }
270 
271 static int ovl_mount_dir(const char *name, struct path *path, bool upper)
272 {
273 	int err = -ENOMEM;
274 	char *tmp = kstrdup(name, GFP_KERNEL);
275 
276 	if (tmp) {
277 		ovl_unescape(tmp);
278 		err = ovl_mount_dir_noesc(tmp, path);
279 
280 		if (!err && upper && path->dentry->d_flags & DCACHE_OP_REAL) {
281 			pr_err("filesystem on '%s' not supported as upperdir\n",
282 			       tmp);
283 			path_put_init(path);
284 			err = -EINVAL;
285 		}
286 		kfree(tmp);
287 	}
288 	return err;
289 }
290 
291 static int ovl_parse_param_upperdir(const char *name, struct fs_context *fc,
292 				    bool workdir)
293 {
294 	int err;
295 	struct ovl_fs *ofs = fc->s_fs_info;
296 	struct ovl_config *config = &ofs->config;
297 	struct ovl_fs_context *ctx = fc->fs_private;
298 	struct path path;
299 	char *dup;
300 
301 	err = ovl_mount_dir(name, &path, true);
302 	if (err)
303 		return err;
304 
305 	/*
306 	 * Check whether upper path is read-only here to report failures
307 	 * early. Don't forget to recheck when the superblock is created
308 	 * as the mount attributes could change.
309 	 */
310 	if (__mnt_is_readonly(path.mnt)) {
311 		path_put(&path);
312 		return -EINVAL;
313 	}
314 
315 	dup = kstrdup(name, GFP_KERNEL);
316 	if (!dup) {
317 		path_put(&path);
318 		return -ENOMEM;
319 	}
320 
321 	if (workdir) {
322 		kfree(config->workdir);
323 		config->workdir = dup;
324 		path_put(&ctx->work);
325 		ctx->work = path;
326 	} else {
327 		kfree(config->upperdir);
328 		config->upperdir = dup;
329 		path_put(&ctx->upper);
330 		ctx->upper = path;
331 	}
332 	return 0;
333 }
334 
335 static void ovl_reset_lowerdirs(struct ovl_fs_context *ctx)
336 {
337 	struct ovl_fs_context_layer *l = ctx->lower;
338 
339 	// Reset old user provided lowerdir string
340 	kfree(ctx->lowerdir_all);
341 	ctx->lowerdir_all = NULL;
342 
343 	for (size_t nr = 0; nr < ctx->nr; nr++, l++) {
344 		path_put(&l->path);
345 		kfree(l->name);
346 		l->name = NULL;
347 	}
348 	ctx->nr = 0;
349 	ctx->nr_data = 0;
350 }
351 
352 /*
353  * Parse lowerdir= mount option:
354  *
355  * e.g.: lowerdir=/lower1:/lower2:/lower3::/data1::/data2
356  *     Set "/lower1", "/lower2", and "/lower3" as lower layers and
357  *     "/data1" and "/data2" as data lower layers. Any existing lower
358  *     layers are replaced.
359  */
360 static int ovl_parse_param_lowerdir(const char *name, struct fs_context *fc)
361 {
362 	int err;
363 	struct ovl_fs_context *ctx = fc->fs_private;
364 	struct ovl_fs_context_layer *l;
365 	char *dup = NULL, *iter;
366 	ssize_t nr_lower = 0, nr = 0, nr_data = 0;
367 	bool data_layer = false;
368 
369 	/*
370 	 * Ensure we're backwards compatible with mount(2)
371 	 * by allowing relative paths.
372 	 */
373 
374 	/* drop all existing lower layers */
375 	ovl_reset_lowerdirs(ctx);
376 
377 	if (!*name)
378 		return 0;
379 
380 	if (*name == ':') {
381 		pr_err("cannot append lower layer");
382 		return -EINVAL;
383 	}
384 
385 	// Store user provided lowerdir string to show in mount options
386 	ctx->lowerdir_all = kstrdup(name, GFP_KERNEL);
387 	if (!ctx->lowerdir_all)
388 		return -ENOMEM;
389 
390 	dup = kstrdup(name, GFP_KERNEL);
391 	if (!dup)
392 		return -ENOMEM;
393 
394 	err = -EINVAL;
395 	nr_lower = ovl_parse_param_split_lowerdirs(dup);
396 	if (nr_lower < 0)
397 		goto out_err;
398 
399 	if (nr_lower > OVL_MAX_STACK) {
400 		pr_err("too many lower directories, limit is %d\n", OVL_MAX_STACK);
401 		goto out_err;
402 	}
403 
404 	if (nr_lower > ctx->capacity) {
405 		err = -ENOMEM;
406 		l = krealloc_array(ctx->lower, nr_lower, sizeof(*ctx->lower),
407 				   GFP_KERNEL_ACCOUNT);
408 		if (!l)
409 			goto out_err;
410 
411 		ctx->lower = l;
412 		ctx->capacity = nr_lower;
413 	}
414 
415 	iter = dup;
416 	l = ctx->lower;
417 	for (nr = 0; nr < nr_lower; nr++, l++) {
418 		memset(l, 0, sizeof(*l));
419 
420 		err = ovl_mount_dir(iter, &l->path, false);
421 		if (err)
422 			goto out_put;
423 
424 		err = -ENOMEM;
425 		l->name = kstrdup(iter, GFP_KERNEL_ACCOUNT);
426 		if (!l->name)
427 			goto out_put;
428 
429 		if (data_layer)
430 			nr_data++;
431 
432 		/* Calling strchr() again would overrun. */
433 		if ((nr + 1) == nr_lower)
434 			break;
435 
436 		err = -EINVAL;
437 		iter = strchr(iter, '\0') + 1;
438 		if (*iter) {
439 			/*
440 			 * This is a regular layer so we require that
441 			 * there are no data layers.
442 			 */
443 			if ((ctx->nr_data + nr_data) > 0) {
444 				pr_err("regular lower layers cannot follow data lower layers");
445 				goto out_put;
446 			}
447 
448 			data_layer = false;
449 			continue;
450 		}
451 
452 		/* This is a data lower layer. */
453 		data_layer = true;
454 		iter++;
455 	}
456 	ctx->nr = nr_lower;
457 	ctx->nr_data += nr_data;
458 	kfree(dup);
459 	return 0;
460 
461 out_put:
462 	ovl_reset_lowerdirs(ctx);
463 
464 out_err:
465 	kfree(dup);
466 
467 	/* Intentionally don't realloc to a smaller size. */
468 	return err;
469 }
470 
471 static int ovl_parse_param(struct fs_context *fc, struct fs_parameter *param)
472 {
473 	int err = 0;
474 	struct fs_parse_result result;
475 	struct ovl_fs *ofs = fc->s_fs_info;
476 	struct ovl_config *config = &ofs->config;
477 	struct ovl_fs_context *ctx = fc->fs_private;
478 	int opt;
479 
480 	if (fc->purpose == FS_CONTEXT_FOR_RECONFIGURE) {
481 		/*
482 		 * On remount overlayfs has always ignored all mount
483 		 * options no matter if malformed or not so for
484 		 * backwards compatibility we do the same here.
485 		 */
486 		if (fc->oldapi)
487 			return 0;
488 
489 		/*
490 		 * Give us the freedom to allow changing mount options
491 		 * with the new mount api in the future. So instead of
492 		 * silently ignoring everything we report a proper
493 		 * error. This is only visible for users of the new
494 		 * mount api.
495 		 */
496 		return invalfc(fc, "No changes allowed in reconfigure");
497 	}
498 
499 	opt = fs_parse(fc, ovl_parameter_spec, param, &result);
500 	if (opt < 0)
501 		return opt;
502 
503 	switch (opt) {
504 	case Opt_lowerdir:
505 		err = ovl_parse_param_lowerdir(param->string, fc);
506 		break;
507 	case Opt_upperdir:
508 		fallthrough;
509 	case Opt_workdir:
510 		err = ovl_parse_param_upperdir(param->string, fc,
511 					       (Opt_workdir == opt));
512 		break;
513 	case Opt_default_permissions:
514 		config->default_permissions = true;
515 		break;
516 	case Opt_redirect_dir:
517 		config->redirect_mode = result.uint_32;
518 		if (config->redirect_mode == OVL_REDIRECT_OFF) {
519 			config->redirect_mode = ovl_redirect_always_follow ?
520 						OVL_REDIRECT_FOLLOW :
521 						OVL_REDIRECT_NOFOLLOW;
522 		}
523 		ctx->set.redirect = true;
524 		break;
525 	case Opt_index:
526 		config->index = result.uint_32;
527 		ctx->set.index = true;
528 		break;
529 	case Opt_uuid:
530 		config->uuid = result.uint_32;
531 		break;
532 	case Opt_nfs_export:
533 		config->nfs_export = result.uint_32;
534 		ctx->set.nfs_export = true;
535 		break;
536 	case Opt_xino:
537 		config->xino = result.uint_32;
538 		break;
539 	case Opt_metacopy:
540 		config->metacopy = result.uint_32;
541 		ctx->set.metacopy = true;
542 		break;
543 	case Opt_verity:
544 		config->verity_mode = result.uint_32;
545 		break;
546 	case Opt_volatile:
547 		config->ovl_volatile = true;
548 		break;
549 	case Opt_userxattr:
550 		config->userxattr = true;
551 		break;
552 	default:
553 		pr_err("unrecognized mount option \"%s\" or missing value\n",
554 		       param->key);
555 		return -EINVAL;
556 	}
557 
558 	return err;
559 }
560 
561 static int ovl_get_tree(struct fs_context *fc)
562 {
563 	return get_tree_nodev(fc, ovl_fill_super);
564 }
565 
566 static inline void ovl_fs_context_free(struct ovl_fs_context *ctx)
567 {
568 	ovl_reset_lowerdirs(ctx);
569 	path_put(&ctx->upper);
570 	path_put(&ctx->work);
571 	kfree(ctx->lower);
572 	kfree(ctx);
573 }
574 
575 static void ovl_free(struct fs_context *fc)
576 {
577 	struct ovl_fs *ofs = fc->s_fs_info;
578 	struct ovl_fs_context *ctx = fc->fs_private;
579 
580 	/*
581 	 * ofs is stored in the fs_context when it is initialized.
582 	 * ofs is transferred to the superblock on a successful mount,
583 	 * but if an error occurs before the transfer we have to free
584 	 * it here.
585 	 */
586 	if (ofs)
587 		ovl_free_fs(ofs);
588 
589 	if (ctx)
590 		ovl_fs_context_free(ctx);
591 }
592 
593 static int ovl_reconfigure(struct fs_context *fc)
594 {
595 	struct super_block *sb = fc->root->d_sb;
596 	struct ovl_fs *ofs = OVL_FS(sb);
597 	struct super_block *upper_sb;
598 	int ret = 0;
599 
600 	if (!(fc->sb_flags & SB_RDONLY) && ovl_force_readonly(ofs))
601 		return -EROFS;
602 
603 	if (fc->sb_flags & SB_RDONLY && !sb_rdonly(sb)) {
604 		upper_sb = ovl_upper_mnt(ofs)->mnt_sb;
605 		if (ovl_should_sync(ofs)) {
606 			down_read(&upper_sb->s_umount);
607 			ret = sync_filesystem(upper_sb);
608 			up_read(&upper_sb->s_umount);
609 		}
610 	}
611 
612 	return ret;
613 }
614 
615 static const struct fs_context_operations ovl_context_ops = {
616 	.parse_monolithic = ovl_parse_monolithic,
617 	.parse_param = ovl_parse_param,
618 	.get_tree    = ovl_get_tree,
619 	.reconfigure = ovl_reconfigure,
620 	.free        = ovl_free,
621 };
622 
623 /*
624  * This is called during fsopen() and will record the user namespace of
625  * the caller in fc->user_ns since we've raised FS_USERNS_MOUNT. We'll
626  * need it when we actually create the superblock to verify that the
627  * process creating the superblock is in the same user namespace as
628  * process that called fsopen().
629  */
630 int ovl_init_fs_context(struct fs_context *fc)
631 {
632 	struct ovl_fs_context *ctx;
633 	struct ovl_fs *ofs;
634 
635 	ctx = kzalloc(sizeof(*ctx), GFP_KERNEL_ACCOUNT);
636 	if (!ctx)
637 		return -ENOMEM;
638 
639 	/*
640 	 * By default we allocate for three lower layers. It's likely
641 	 * that it'll cover most users.
642 	 */
643 	ctx->lower = kmalloc_array(3, sizeof(*ctx->lower), GFP_KERNEL_ACCOUNT);
644 	if (!ctx->lower)
645 		goto out_err;
646 	ctx->capacity = 3;
647 
648 	ofs = kzalloc(sizeof(struct ovl_fs), GFP_KERNEL);
649 	if (!ofs)
650 		goto out_err;
651 
652 	ofs->config.redirect_mode	= ovl_redirect_mode_def();
653 	ofs->config.index		= ovl_index_def;
654 	ofs->config.uuid		= ovl_uuid_def();
655 	ofs->config.nfs_export		= ovl_nfs_export_def;
656 	ofs->config.xino		= ovl_xino_def();
657 	ofs->config.metacopy		= ovl_metacopy_def;
658 
659 	fc->s_fs_info		= ofs;
660 	fc->fs_private		= ctx;
661 	fc->ops			= &ovl_context_ops;
662 	return 0;
663 
664 out_err:
665 	ovl_fs_context_free(ctx);
666 	return -ENOMEM;
667 
668 }
669 
670 void ovl_free_fs(struct ovl_fs *ofs)
671 {
672 	struct vfsmount **mounts;
673 	unsigned i;
674 
675 	iput(ofs->workbasedir_trap);
676 	iput(ofs->indexdir_trap);
677 	iput(ofs->workdir_trap);
678 	dput(ofs->whiteout);
679 	dput(ofs->indexdir);
680 	dput(ofs->workdir);
681 	if (ofs->workdir_locked)
682 		ovl_inuse_unlock(ofs->workbasedir);
683 	dput(ofs->workbasedir);
684 	if (ofs->upperdir_locked)
685 		ovl_inuse_unlock(ovl_upper_mnt(ofs)->mnt_root);
686 
687 	/* Reuse ofs->config.lowerdirs as a vfsmount array before freeing it */
688 	mounts = (struct vfsmount **) ofs->config.lowerdirs;
689 	for (i = 0; i < ofs->numlayer; i++) {
690 		iput(ofs->layers[i].trap);
691 		kfree(ofs->config.lowerdirs[i]);
692 		mounts[i] = ofs->layers[i].mnt;
693 	}
694 	kern_unmount_array(mounts, ofs->numlayer);
695 	kfree(ofs->layers);
696 	for (i = 0; i < ofs->numfs; i++)
697 		free_anon_bdev(ofs->fs[i].pseudo_dev);
698 	kfree(ofs->fs);
699 
700 	kfree(ofs->config.lowerdirs);
701 	kfree(ofs->config.upperdir);
702 	kfree(ofs->config.workdir);
703 	if (ofs->creator_cred)
704 		put_cred(ofs->creator_cred);
705 	kfree(ofs);
706 }
707 
708 int ovl_fs_params_verify(const struct ovl_fs_context *ctx,
709 			 struct ovl_config *config)
710 {
711 	struct ovl_opt_set set = ctx->set;
712 
713 	if (ctx->nr_data > 0 && !config->metacopy) {
714 		pr_err("lower data-only dirs require metacopy support.\n");
715 		return -EINVAL;
716 	}
717 
718 	/* Workdir/index are useless in non-upper mount */
719 	if (!config->upperdir) {
720 		if (config->workdir) {
721 			pr_info("option \"workdir=%s\" is useless in a non-upper mount, ignore\n",
722 				config->workdir);
723 			kfree(config->workdir);
724 			config->workdir = NULL;
725 		}
726 		if (config->index && set.index) {
727 			pr_info("option \"index=on\" is useless in a non-upper mount, ignore\n");
728 			set.index = false;
729 		}
730 		config->index = false;
731 	}
732 
733 	if (!config->upperdir && config->ovl_volatile) {
734 		pr_info("option \"volatile\" is meaningless in a non-upper mount, ignoring it.\n");
735 		config->ovl_volatile = false;
736 	}
737 
738 	if (!config->upperdir && config->uuid == OVL_UUID_ON) {
739 		pr_info("option \"uuid=on\" requires an upper fs, falling back to uuid=null.\n");
740 		config->uuid = OVL_UUID_NULL;
741 	}
742 
743 	/* Resolve verity -> metacopy dependency */
744 	if (config->verity_mode && !config->metacopy) {
745 		/* Don't allow explicit specified conflicting combinations */
746 		if (set.metacopy) {
747 			pr_err("conflicting options: metacopy=off,verity=%s\n",
748 			       ovl_verity_mode(config));
749 			return -EINVAL;
750 		}
751 		/* Otherwise automatically enable metacopy. */
752 		config->metacopy = true;
753 	}
754 
755 	/*
756 	 * This is to make the logic below simpler.  It doesn't make any other
757 	 * difference, since redirect_dir=on is only used for upper.
758 	 */
759 	if (!config->upperdir && config->redirect_mode == OVL_REDIRECT_FOLLOW)
760 		config->redirect_mode = OVL_REDIRECT_ON;
761 
762 	/* Resolve verity -> metacopy -> redirect_dir dependency */
763 	if (config->metacopy && config->redirect_mode != OVL_REDIRECT_ON) {
764 		if (set.metacopy && set.redirect) {
765 			pr_err("conflicting options: metacopy=on,redirect_dir=%s\n",
766 			       ovl_redirect_mode(config));
767 			return -EINVAL;
768 		}
769 		if (config->verity_mode && set.redirect) {
770 			pr_err("conflicting options: verity=%s,redirect_dir=%s\n",
771 			       ovl_verity_mode(config), ovl_redirect_mode(config));
772 			return -EINVAL;
773 		}
774 		if (set.redirect) {
775 			/*
776 			 * There was an explicit redirect_dir=... that resulted
777 			 * in this conflict.
778 			 */
779 			pr_info("disabling metacopy due to redirect_dir=%s\n",
780 				ovl_redirect_mode(config));
781 			config->metacopy = false;
782 		} else {
783 			/* Automatically enable redirect otherwise. */
784 			config->redirect_mode = OVL_REDIRECT_ON;
785 		}
786 	}
787 
788 	/* Resolve nfs_export -> index dependency */
789 	if (config->nfs_export && !config->index) {
790 		if (!config->upperdir &&
791 		    config->redirect_mode != OVL_REDIRECT_NOFOLLOW) {
792 			pr_info("NFS export requires \"redirect_dir=nofollow\" on non-upper mount, falling back to nfs_export=off.\n");
793 			config->nfs_export = false;
794 		} else if (set.nfs_export && set.index) {
795 			pr_err("conflicting options: nfs_export=on,index=off\n");
796 			return -EINVAL;
797 		} else if (set.index) {
798 			/*
799 			 * There was an explicit index=off that resulted
800 			 * in this conflict.
801 			 */
802 			pr_info("disabling nfs_export due to index=off\n");
803 			config->nfs_export = false;
804 		} else {
805 			/* Automatically enable index otherwise. */
806 			config->index = true;
807 		}
808 	}
809 
810 	/* Resolve nfs_export -> !metacopy && !verity dependency */
811 	if (config->nfs_export && config->metacopy) {
812 		if (set.nfs_export && set.metacopy) {
813 			pr_err("conflicting options: nfs_export=on,metacopy=on\n");
814 			return -EINVAL;
815 		}
816 		if (set.metacopy) {
817 			/*
818 			 * There was an explicit metacopy=on that resulted
819 			 * in this conflict.
820 			 */
821 			pr_info("disabling nfs_export due to metacopy=on\n");
822 			config->nfs_export = false;
823 		} else if (config->verity_mode) {
824 			/*
825 			 * There was an explicit verity=.. that resulted
826 			 * in this conflict.
827 			 */
828 			pr_info("disabling nfs_export due to verity=%s\n",
829 				ovl_verity_mode(config));
830 			config->nfs_export = false;
831 		} else {
832 			/*
833 			 * There was an explicit nfs_export=on that resulted
834 			 * in this conflict.
835 			 */
836 			pr_info("disabling metacopy due to nfs_export=on\n");
837 			config->metacopy = false;
838 		}
839 	}
840 
841 
842 	/* Resolve userxattr -> !redirect && !metacopy && !verity dependency */
843 	if (config->userxattr) {
844 		if (set.redirect &&
845 		    config->redirect_mode != OVL_REDIRECT_NOFOLLOW) {
846 			pr_err("conflicting options: userxattr,redirect_dir=%s\n",
847 			       ovl_redirect_mode(config));
848 			return -EINVAL;
849 		}
850 		if (config->metacopy && set.metacopy) {
851 			pr_err("conflicting options: userxattr,metacopy=on\n");
852 			return -EINVAL;
853 		}
854 		if (config->verity_mode) {
855 			pr_err("conflicting options: userxattr,verity=%s\n",
856 			       ovl_verity_mode(config));
857 			return -EINVAL;
858 		}
859 		/*
860 		 * Silently disable default setting of redirect and metacopy.
861 		 * This shall be the default in the future as well: these
862 		 * options must be explicitly enabled if used together with
863 		 * userxattr.
864 		 */
865 		config->redirect_mode = OVL_REDIRECT_NOFOLLOW;
866 		config->metacopy = false;
867 	}
868 
869 	return 0;
870 }
871 
872 /**
873  * ovl_show_options
874  * @m: the seq_file handle
875  * @dentry: The dentry to query
876  *
877  * Prints the mount options for a given superblock.
878  * Returns zero; does not fail.
879  */
880 int ovl_show_options(struct seq_file *m, struct dentry *dentry)
881 {
882 	struct super_block *sb = dentry->d_sb;
883 	struct ovl_fs *ofs = OVL_FS(sb);
884 	char **lowerdirs = ofs->config.lowerdirs;
885 
886 	/*
887 	 * lowerdirs[0] holds the colon separated list that user provided
888 	 * with lowerdir mount option.
889 	 */
890 	seq_show_option(m, "lowerdir", lowerdirs[0]);
891 	if (ofs->config.upperdir) {
892 		seq_show_option(m, "upperdir", ofs->config.upperdir);
893 		seq_show_option(m, "workdir", ofs->config.workdir);
894 	}
895 	if (ofs->config.default_permissions)
896 		seq_puts(m, ",default_permissions");
897 	if (ofs->config.redirect_mode != ovl_redirect_mode_def())
898 		seq_printf(m, ",redirect_dir=%s",
899 			   ovl_redirect_mode(&ofs->config));
900 	if (ofs->config.index != ovl_index_def)
901 		seq_printf(m, ",index=%s", ofs->config.index ? "on" : "off");
902 	if (ofs->config.uuid != ovl_uuid_def())
903 		seq_printf(m, ",uuid=%s", ovl_uuid_mode(&ofs->config));
904 	if (ofs->config.nfs_export != ovl_nfs_export_def)
905 		seq_printf(m, ",nfs_export=%s", ofs->config.nfs_export ?
906 						"on" : "off");
907 	if (ofs->config.xino != ovl_xino_def() && !ovl_same_fs(ofs))
908 		seq_printf(m, ",xino=%s", ovl_xino_mode(&ofs->config));
909 	if (ofs->config.metacopy != ovl_metacopy_def)
910 		seq_printf(m, ",metacopy=%s",
911 			   ofs->config.metacopy ? "on" : "off");
912 	if (ofs->config.ovl_volatile)
913 		seq_puts(m, ",volatile");
914 	if (ofs->config.userxattr)
915 		seq_puts(m, ",userxattr");
916 	if (ofs->config.verity_mode != ovl_verity_mode_def())
917 		seq_printf(m, ",verity=%s",
918 			   ovl_verity_mode(&ofs->config));
919 	return 0;
920 }
921