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