3 * Copyright (C) 2011 Novell Inc.
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 as published by
7 * the Free Software Foundation.
10 #include <uapi/linux/magic.h>
12 #include <linux/namei.h>
13 #include <linux/xattr.h>
14 #include <linux/mount.h>
15 #include <linux/parser.h>
16 #include <linux/module.h>
17 #include <linux/statfs.h>
18 #include <linux/seq_file.h>
19 #include <linux/posix_acl_xattr.h>
20 #include <linux/exportfs.h>
21 #include "overlayfs.h"
23 MODULE_AUTHOR("Miklos Szeredi <miklos@szeredi.hu>");
24 MODULE_DESCRIPTION("Overlay filesystem");
25 MODULE_LICENSE("GPL");
30 #define OVL_MAX_STACK 500
32 static bool ovl_redirect_dir_def
= IS_ENABLED(CONFIG_OVERLAY_FS_REDIRECT_DIR
);
33 module_param_named(redirect_dir
, ovl_redirect_dir_def
, bool, 0644);
34 MODULE_PARM_DESC(ovl_redirect_dir_def
,
35 "Default to on or off for the redirect_dir feature");
37 static bool ovl_redirect_always_follow
=
38 IS_ENABLED(CONFIG_OVERLAY_FS_REDIRECT_ALWAYS_FOLLOW
);
39 module_param_named(redirect_always_follow
, ovl_redirect_always_follow
,
41 MODULE_PARM_DESC(ovl_redirect_always_follow
,
42 "Follow redirects even if redirect_dir feature is turned off");
44 static bool ovl_index_def
= IS_ENABLED(CONFIG_OVERLAY_FS_INDEX
);
45 module_param_named(index
, ovl_index_def
, bool, 0644);
46 MODULE_PARM_DESC(ovl_index_def
,
47 "Default to on or off for the inodes index feature");
49 static bool ovl_nfs_export_def
= IS_ENABLED(CONFIG_OVERLAY_FS_NFS_EXPORT
);
50 module_param_named(nfs_export
, ovl_nfs_export_def
, bool, 0644);
51 MODULE_PARM_DESC(ovl_nfs_export_def
,
52 "Default to on or off for the NFS export feature");
54 static bool ovl_xino_auto_def
= IS_ENABLED(CONFIG_OVERLAY_FS_XINO_AUTO
);
55 module_param_named(xino_auto
, ovl_xino_auto_def
, bool, 0644);
56 MODULE_PARM_DESC(ovl_xino_auto_def
,
57 "Auto enable xino feature");
59 static void ovl_entry_stack_free(struct ovl_entry
*oe
)
63 for (i
= 0; i
< oe
->numlower
; i
++)
64 dput(oe
->lowerstack
[i
].dentry
);
67 static void ovl_dentry_release(struct dentry
*dentry
)
69 struct ovl_entry
*oe
= dentry
->d_fsdata
;
72 ovl_entry_stack_free(oe
);
77 static int ovl_check_append_only(struct inode
*inode
, int flag
)
80 * This test was moot in vfs may_open() because overlay inode does
81 * not have the S_APPEND flag, so re-check on real upper inode
83 if (IS_APPEND(inode
)) {
84 if ((flag
& O_ACCMODE
) != O_RDONLY
&& !(flag
& O_APPEND
))
93 static struct dentry
*ovl_d_real(struct dentry
*dentry
,
94 const struct inode
*inode
,
95 unsigned int open_flags
, unsigned int flags
)
100 /* It's an overlay file */
101 if (inode
&& d_inode(dentry
) == inode
)
104 if (!d_is_reg(dentry
)) {
105 if (!inode
|| inode
== d_inode(dentry
))
111 err
= ovl_open_maybe_copy_up(dentry
, open_flags
);
116 real
= ovl_dentry_upper(dentry
);
117 if (real
&& (!inode
|| inode
== d_inode(real
))) {
119 err
= ovl_check_append_only(d_inode(real
), open_flags
);
126 real
= ovl_dentry_lower(dentry
);
130 /* Handle recursion */
131 real
= d_real(real
, inode
, open_flags
, 0);
133 if (!inode
|| inode
== d_inode(real
))
136 WARN(1, "ovl_d_real(%pd4, %s:%lu): real dentry not found\n", dentry
,
137 inode
? inode
->i_sb
->s_id
: "NULL", inode
? inode
->i_ino
: 0);
141 static int ovl_dentry_revalidate(struct dentry
*dentry
, unsigned int flags
)
143 struct ovl_entry
*oe
= dentry
->d_fsdata
;
147 for (i
= 0; i
< oe
->numlower
; i
++) {
148 struct dentry
*d
= oe
->lowerstack
[i
].dentry
;
150 if (d
->d_flags
& DCACHE_OP_REVALIDATE
) {
151 ret
= d
->d_op
->d_revalidate(d
, flags
);
155 if (!(flags
& LOOKUP_RCU
))
164 static int ovl_dentry_weak_revalidate(struct dentry
*dentry
, unsigned int flags
)
166 struct ovl_entry
*oe
= dentry
->d_fsdata
;
170 for (i
= 0; i
< oe
->numlower
; i
++) {
171 struct dentry
*d
= oe
->lowerstack
[i
].dentry
;
173 if (d
->d_flags
& DCACHE_OP_WEAK_REVALIDATE
) {
174 ret
= d
->d_op
->d_weak_revalidate(d
, flags
);
182 static const struct dentry_operations ovl_dentry_operations
= {
183 .d_release
= ovl_dentry_release
,
184 .d_real
= ovl_d_real
,
187 static const struct dentry_operations ovl_reval_dentry_operations
= {
188 .d_release
= ovl_dentry_release
,
189 .d_real
= ovl_d_real
,
190 .d_revalidate
= ovl_dentry_revalidate
,
191 .d_weak_revalidate
= ovl_dentry_weak_revalidate
,
194 static struct kmem_cache
*ovl_inode_cachep
;
196 static struct inode
*ovl_alloc_inode(struct super_block
*sb
)
198 struct ovl_inode
*oi
= kmem_cache_alloc(ovl_inode_cachep
, GFP_KERNEL
);
207 oi
->__upperdentry
= NULL
;
209 mutex_init(&oi
->lock
);
211 return &oi
->vfs_inode
;
214 static void ovl_i_callback(struct rcu_head
*head
)
216 struct inode
*inode
= container_of(head
, struct inode
, i_rcu
);
218 kmem_cache_free(ovl_inode_cachep
, OVL_I(inode
));
221 static void ovl_destroy_inode(struct inode
*inode
)
223 struct ovl_inode
*oi
= OVL_I(inode
);
225 dput(oi
->__upperdentry
);
228 ovl_dir_cache_free(inode
);
229 mutex_destroy(&oi
->lock
);
231 call_rcu(&inode
->i_rcu
, ovl_i_callback
);
234 static void ovl_free_fs(struct ovl_fs
*ofs
)
240 if (ofs
->workdir_locked
)
241 ovl_inuse_unlock(ofs
->workbasedir
);
242 dput(ofs
->workbasedir
);
243 if (ofs
->upperdir_locked
)
244 ovl_inuse_unlock(ofs
->upper_mnt
->mnt_root
);
245 mntput(ofs
->upper_mnt
);
246 for (i
= 0; i
< ofs
->numlower
; i
++)
247 mntput(ofs
->lower_layers
[i
].mnt
);
248 for (i
= 0; i
< ofs
->numlowerfs
; i
++)
249 free_anon_bdev(ofs
->lower_fs
[i
].pseudo_dev
);
250 kfree(ofs
->lower_layers
);
251 kfree(ofs
->lower_fs
);
253 kfree(ofs
->config
.lowerdir
);
254 kfree(ofs
->config
.upperdir
);
255 kfree(ofs
->config
.workdir
);
256 kfree(ofs
->config
.redirect_mode
);
257 if (ofs
->creator_cred
)
258 put_cred(ofs
->creator_cred
);
262 static void ovl_put_super(struct super_block
*sb
)
264 struct ovl_fs
*ofs
= sb
->s_fs_info
;
269 /* Sync real dirty inodes in upper filesystem (if it exists) */
270 static int ovl_sync_fs(struct super_block
*sb
, int wait
)
272 struct ovl_fs
*ofs
= sb
->s_fs_info
;
273 struct super_block
*upper_sb
;
280 * If this is a sync(2) call or an emergency sync, all the super blocks
281 * will be iterated, including upper_sb, so no need to do anything.
283 * If this is a syncfs(2) call, then we do need to call
284 * sync_filesystem() on upper_sb, but enough if we do it when being
285 * called with wait == 1.
290 upper_sb
= ofs
->upper_mnt
->mnt_sb
;
292 down_read(&upper_sb
->s_umount
);
293 ret
= sync_filesystem(upper_sb
);
294 up_read(&upper_sb
->s_umount
);
301 * @sb: The overlayfs super block
302 * @buf: The struct kstatfs to fill in with stats
304 * Get the filesystem statistics. As writes always target the upper layer
305 * filesystem pass the statfs to the upper filesystem (if it exists)
307 static int ovl_statfs(struct dentry
*dentry
, struct kstatfs
*buf
)
309 struct ovl_fs
*ofs
= dentry
->d_sb
->s_fs_info
;
310 struct dentry
*root_dentry
= dentry
->d_sb
->s_root
;
314 ovl_path_real(root_dentry
, &path
);
316 err
= vfs_statfs(&path
, buf
);
318 buf
->f_namelen
= ofs
->namelen
;
319 buf
->f_type
= OVERLAYFS_SUPER_MAGIC
;
325 /* Will this overlay be forced to mount/remount ro? */
326 static bool ovl_force_readonly(struct ovl_fs
*ofs
)
328 return (!ofs
->upper_mnt
|| !ofs
->workdir
);
331 static const char *ovl_redirect_mode_def(void)
333 return ovl_redirect_dir_def
? "on" : "off";
342 static const char * const ovl_xino_str
[] = {
348 static inline int ovl_xino_def(void)
350 return ovl_xino_auto_def
? OVL_XINO_AUTO
: OVL_XINO_OFF
;
356 * Prints the mount options for a given superblock.
357 * Returns zero; does not fail.
359 static int ovl_show_options(struct seq_file
*m
, struct dentry
*dentry
)
361 struct super_block
*sb
= dentry
->d_sb
;
362 struct ovl_fs
*ofs
= sb
->s_fs_info
;
364 seq_show_option(m
, "lowerdir", ofs
->config
.lowerdir
);
365 if (ofs
->config
.upperdir
) {
366 seq_show_option(m
, "upperdir", ofs
->config
.upperdir
);
367 seq_show_option(m
, "workdir", ofs
->config
.workdir
);
369 if (ofs
->config
.default_permissions
)
370 seq_puts(m
, ",default_permissions");
371 if (strcmp(ofs
->config
.redirect_mode
, ovl_redirect_mode_def()) != 0)
372 seq_printf(m
, ",redirect_dir=%s", ofs
->config
.redirect_mode
);
373 if (ofs
->config
.index
!= ovl_index_def
)
374 seq_printf(m
, ",index=%s", ofs
->config
.index
? "on" : "off");
375 if (ofs
->config
.nfs_export
!= ovl_nfs_export_def
)
376 seq_printf(m
, ",nfs_export=%s", ofs
->config
.nfs_export
?
378 if (ofs
->config
.xino
!= ovl_xino_def())
379 seq_printf(m
, ",xino=%s", ovl_xino_str
[ofs
->config
.xino
]);
383 static int ovl_remount(struct super_block
*sb
, int *flags
, char *data
)
385 struct ovl_fs
*ofs
= sb
->s_fs_info
;
387 if (!(*flags
& SB_RDONLY
) && ovl_force_readonly(ofs
))
393 static const struct super_operations ovl_super_operations
= {
394 .alloc_inode
= ovl_alloc_inode
,
395 .destroy_inode
= ovl_destroy_inode
,
396 .drop_inode
= generic_delete_inode
,
397 .put_super
= ovl_put_super
,
398 .sync_fs
= ovl_sync_fs
,
399 .statfs
= ovl_statfs
,
400 .show_options
= ovl_show_options
,
401 .remount_fs
= ovl_remount
,
408 OPT_DEFAULT_PERMISSIONS
,
420 static const match_table_t ovl_tokens
= {
421 {OPT_LOWERDIR
, "lowerdir=%s"},
422 {OPT_UPPERDIR
, "upperdir=%s"},
423 {OPT_WORKDIR
, "workdir=%s"},
424 {OPT_DEFAULT_PERMISSIONS
, "default_permissions"},
425 {OPT_REDIRECT_DIR
, "redirect_dir=%s"},
426 {OPT_INDEX_ON
, "index=on"},
427 {OPT_INDEX_OFF
, "index=off"},
428 {OPT_NFS_EXPORT_ON
, "nfs_export=on"},
429 {OPT_NFS_EXPORT_OFF
, "nfs_export=off"},
430 {OPT_XINO_ON
, "xino=on"},
431 {OPT_XINO_OFF
, "xino=off"},
432 {OPT_XINO_AUTO
, "xino=auto"},
436 static char *ovl_next_opt(char **s
)
444 for (p
= sbegin
; *p
; p
++) {
449 } else if (*p
== ',') {
459 static int ovl_parse_redirect_mode(struct ovl_config
*config
, const char *mode
)
461 if (strcmp(mode
, "on") == 0) {
462 config
->redirect_dir
= true;
464 * Does not make sense to have redirect creation without
465 * redirect following.
467 config
->redirect_follow
= true;
468 } else if (strcmp(mode
, "follow") == 0) {
469 config
->redirect_follow
= true;
470 } else if (strcmp(mode
, "off") == 0) {
471 if (ovl_redirect_always_follow
)
472 config
->redirect_follow
= true;
473 } else if (strcmp(mode
, "nofollow") != 0) {
474 pr_err("overlayfs: bad mount option \"redirect_dir=%s\"\n",
482 static int ovl_parse_opt(char *opt
, struct ovl_config
*config
)
486 config
->redirect_mode
= kstrdup(ovl_redirect_mode_def(), GFP_KERNEL
);
487 if (!config
->redirect_mode
)
490 while ((p
= ovl_next_opt(&opt
)) != NULL
) {
492 substring_t args
[MAX_OPT_ARGS
];
497 token
= match_token(p
, ovl_tokens
, args
);
500 kfree(config
->upperdir
);
501 config
->upperdir
= match_strdup(&args
[0]);
502 if (!config
->upperdir
)
507 kfree(config
->lowerdir
);
508 config
->lowerdir
= match_strdup(&args
[0]);
509 if (!config
->lowerdir
)
514 kfree(config
->workdir
);
515 config
->workdir
= match_strdup(&args
[0]);
516 if (!config
->workdir
)
520 case OPT_DEFAULT_PERMISSIONS
:
521 config
->default_permissions
= true;
524 case OPT_REDIRECT_DIR
:
525 kfree(config
->redirect_mode
);
526 config
->redirect_mode
= match_strdup(&args
[0]);
527 if (!config
->redirect_mode
)
532 config
->index
= true;
536 config
->index
= false;
539 case OPT_NFS_EXPORT_ON
:
540 config
->nfs_export
= true;
543 case OPT_NFS_EXPORT_OFF
:
544 config
->nfs_export
= false;
548 config
->xino
= OVL_XINO_ON
;
552 config
->xino
= OVL_XINO_OFF
;
556 config
->xino
= OVL_XINO_AUTO
;
560 pr_err("overlayfs: unrecognized mount option \"%s\" or missing value\n", p
);
565 /* Workdir is useless in non-upper mount */
566 if (!config
->upperdir
&& config
->workdir
) {
567 pr_info("overlayfs: option \"workdir=%s\" is useless in a non-upper mount, ignore\n",
569 kfree(config
->workdir
);
570 config
->workdir
= NULL
;
573 return ovl_parse_redirect_mode(config
, config
->redirect_mode
);
576 #define OVL_WORKDIR_NAME "work"
577 #define OVL_INDEXDIR_NAME "index"
579 static struct dentry
*ovl_workdir_create(struct ovl_fs
*ofs
,
580 const char *name
, bool persist
)
582 struct inode
*dir
= ofs
->workbasedir
->d_inode
;
583 struct vfsmount
*mnt
= ofs
->upper_mnt
;
586 bool retried
= false;
589 inode_lock_nested(dir
, I_MUTEX_PARENT
);
593 work
= lookup_one_len(name
, ofs
->workbasedir
, strlen(name
));
596 struct iattr attr
= {
597 .ia_valid
= ATTR_MODE
,
598 .ia_mode
= S_IFDIR
| 0,
610 ovl_workdir_cleanup(dir
, mnt
, work
, 0);
615 work
= ovl_create_real(dir
, work
, OVL_CATTR(attr
.ia_mode
));
621 * Try to remove POSIX ACL xattrs from workdir. We are good if:
623 * a) success (there was a POSIX ACL xattr and was removed)
624 * b) -ENODATA (there was no POSIX ACL xattr)
625 * c) -EOPNOTSUPP (POSIX ACL xattrs are not supported)
627 * There are various other error values that could effectively
628 * mean that the xattr doesn't exist (e.g. -ERANGE is returned
629 * if the xattr name is too long), but the set of filesystems
630 * allowed as upper are limited to "normal" ones, where checking
631 * for the above two errors is sufficient.
633 err
= vfs_removexattr(work
, XATTR_NAME_POSIX_ACL_DEFAULT
);
634 if (err
&& err
!= -ENODATA
&& err
!= -EOPNOTSUPP
)
637 err
= vfs_removexattr(work
, XATTR_NAME_POSIX_ACL_ACCESS
);
638 if (err
&& err
!= -ENODATA
&& err
!= -EOPNOTSUPP
)
641 /* Clear any inherited mode bits */
642 inode_lock(work
->d_inode
);
643 err
= notify_change(work
, &attr
, NULL
);
644 inode_unlock(work
->d_inode
);
660 pr_warn("overlayfs: failed to create directory %s/%s (errno: %i); mounting read-only\n",
661 ofs
->config
.workdir
, name
, -err
);
666 static void ovl_unescape(char *s
)
679 static int ovl_mount_dir_noesc(const char *name
, struct path
*path
)
684 pr_err("overlayfs: empty lowerdir\n");
687 err
= kern_path(name
, LOOKUP_FOLLOW
, path
);
689 pr_err("overlayfs: failed to resolve '%s': %i\n", name
, err
);
693 if (ovl_dentry_weird(path
->dentry
)) {
694 pr_err("overlayfs: filesystem on '%s' not supported\n", name
);
697 if (!d_is_dir(path
->dentry
)) {
698 pr_err("overlayfs: '%s' not a directory\n", name
);
709 static int ovl_mount_dir(const char *name
, struct path
*path
)
712 char *tmp
= kstrdup(name
, GFP_KERNEL
);
716 err
= ovl_mount_dir_noesc(tmp
, path
);
719 if (ovl_dentry_remote(path
->dentry
)) {
720 pr_err("overlayfs: filesystem on '%s' not supported as upperdir\n",
730 static int ovl_check_namelen(struct path
*path
, struct ovl_fs
*ofs
,
733 struct kstatfs statfs
;
734 int err
= vfs_statfs(path
, &statfs
);
737 pr_err("overlayfs: statfs failed on '%s'\n", name
);
739 ofs
->namelen
= max(ofs
->namelen
, statfs
.f_namelen
);
744 static int ovl_lower_dir(const char *name
, struct path
*path
,
745 struct ovl_fs
*ofs
, int *stack_depth
, bool *remote
)
750 err
= ovl_mount_dir_noesc(name
, path
);
754 err
= ovl_check_namelen(path
, ofs
, name
);
758 *stack_depth
= max(*stack_depth
, path
->mnt
->mnt_sb
->s_stack_depth
);
760 if (ovl_dentry_remote(path
->dentry
))
764 * The inodes index feature and NFS export need to encode and decode
765 * file handles, so they require that all layers support them.
767 fh_type
= ovl_can_decode_fh(path
->dentry
->d_sb
);
768 if ((ofs
->config
.nfs_export
||
769 (ofs
->config
.index
&& ofs
->config
.upperdir
)) && !fh_type
) {
770 ofs
->config
.index
= false;
771 ofs
->config
.nfs_export
= false;
772 pr_warn("overlayfs: fs on '%s' does not support file handles, falling back to index=off,nfs_export=off.\n",
776 /* Check if lower fs has 32bit inode numbers */
777 if (fh_type
!= FILEID_INO32_GEN
)
788 /* Workdir should not be subdir of upperdir and vice versa */
789 static bool ovl_workdir_ok(struct dentry
*workdir
, struct dentry
*upperdir
)
793 if (workdir
!= upperdir
) {
794 ok
= (lock_rename(workdir
, upperdir
) == NULL
);
795 unlock_rename(workdir
, upperdir
);
800 static unsigned int ovl_split_lowerdirs(char *str
)
802 unsigned int ctr
= 1;
805 for (s
= d
= str
;; s
++, d
++) {
808 } else if (*s
== ':') {
820 static int __maybe_unused
821 ovl_posix_acl_xattr_get(const struct xattr_handler
*handler
,
822 struct dentry
*dentry
, struct inode
*inode
,
823 const char *name
, void *buffer
, size_t size
)
825 return ovl_xattr_get(dentry
, inode
, handler
->name
, buffer
, size
);
828 static int __maybe_unused
829 ovl_posix_acl_xattr_set(const struct xattr_handler
*handler
,
830 struct dentry
*dentry
, struct inode
*inode
,
831 const char *name
, const void *value
,
832 size_t size
, int flags
)
834 struct dentry
*workdir
= ovl_workdir(dentry
);
835 struct inode
*realinode
= ovl_inode_real(inode
);
836 struct posix_acl
*acl
= NULL
;
839 /* Check that everything is OK before copy-up */
841 acl
= posix_acl_from_xattr(&init_user_ns
, value
, size
);
846 if (!IS_POSIXACL(d_inode(workdir
)))
847 goto out_acl_release
;
848 if (!realinode
->i_op
->set_acl
)
849 goto out_acl_release
;
850 if (handler
->flags
== ACL_TYPE_DEFAULT
&& !S_ISDIR(inode
->i_mode
)) {
851 err
= acl
? -EACCES
: 0;
852 goto out_acl_release
;
855 if (!inode_owner_or_capable(inode
))
856 goto out_acl_release
;
858 posix_acl_release(acl
);
861 * Check if sgid bit needs to be cleared (actual setacl operation will
862 * be done with mounter's capabilities and so that won't do it for us).
864 if (unlikely(inode
->i_mode
& S_ISGID
) &&
865 handler
->flags
== ACL_TYPE_ACCESS
&&
866 !in_group_p(inode
->i_gid
) &&
867 !capable_wrt_inode_uidgid(inode
, CAP_FSETID
)) {
868 struct iattr iattr
= { .ia_valid
= ATTR_KILL_SGID
};
870 err
= ovl_setattr(dentry
, &iattr
);
875 err
= ovl_xattr_set(dentry
, inode
, handler
->name
, value
, size
, flags
);
877 ovl_copyattr(ovl_inode_real(inode
), inode
);
882 posix_acl_release(acl
);
886 static int ovl_own_xattr_get(const struct xattr_handler
*handler
,
887 struct dentry
*dentry
, struct inode
*inode
,
888 const char *name
, void *buffer
, size_t size
)
893 static int ovl_own_xattr_set(const struct xattr_handler
*handler
,
894 struct dentry
*dentry
, struct inode
*inode
,
895 const char *name
, const void *value
,
896 size_t size
, int flags
)
901 static int ovl_other_xattr_get(const struct xattr_handler
*handler
,
902 struct dentry
*dentry
, struct inode
*inode
,
903 const char *name
, void *buffer
, size_t size
)
905 return ovl_xattr_get(dentry
, inode
, name
, buffer
, size
);
908 static int ovl_other_xattr_set(const struct xattr_handler
*handler
,
909 struct dentry
*dentry
, struct inode
*inode
,
910 const char *name
, const void *value
,
911 size_t size
, int flags
)
913 return ovl_xattr_set(dentry
, inode
, name
, value
, size
, flags
);
916 static const struct xattr_handler __maybe_unused
917 ovl_posix_acl_access_xattr_handler
= {
918 .name
= XATTR_NAME_POSIX_ACL_ACCESS
,
919 .flags
= ACL_TYPE_ACCESS
,
920 .get
= ovl_posix_acl_xattr_get
,
921 .set
= ovl_posix_acl_xattr_set
,
924 static const struct xattr_handler __maybe_unused
925 ovl_posix_acl_default_xattr_handler
= {
926 .name
= XATTR_NAME_POSIX_ACL_DEFAULT
,
927 .flags
= ACL_TYPE_DEFAULT
,
928 .get
= ovl_posix_acl_xattr_get
,
929 .set
= ovl_posix_acl_xattr_set
,
932 static const struct xattr_handler ovl_own_xattr_handler
= {
933 .prefix
= OVL_XATTR_PREFIX
,
934 .get
= ovl_own_xattr_get
,
935 .set
= ovl_own_xattr_set
,
938 static const struct xattr_handler ovl_other_xattr_handler
= {
939 .prefix
= "", /* catch all */
940 .get
= ovl_other_xattr_get
,
941 .set
= ovl_other_xattr_set
,
944 static const struct xattr_handler
*ovl_xattr_handlers
[] = {
945 #ifdef CONFIG_FS_POSIX_ACL
946 &ovl_posix_acl_access_xattr_handler
,
947 &ovl_posix_acl_default_xattr_handler
,
949 &ovl_own_xattr_handler
,
950 &ovl_other_xattr_handler
,
954 static int ovl_get_upper(struct ovl_fs
*ofs
, struct path
*upperpath
)
956 struct vfsmount
*upper_mnt
;
959 err
= ovl_mount_dir(ofs
->config
.upperdir
, upperpath
);
963 /* Upper fs should not be r/o */
964 if (sb_rdonly(upperpath
->mnt
->mnt_sb
)) {
965 pr_err("overlayfs: upper fs is r/o, try multi-lower layers mount\n");
970 err
= ovl_check_namelen(upperpath
, ofs
, ofs
->config
.upperdir
);
975 if (ovl_inuse_trylock(upperpath
->dentry
)) {
976 ofs
->upperdir_locked
= true;
977 } else if (ofs
->config
.index
) {
978 pr_err("overlayfs: upperdir is in-use by another mount, mount with '-o index=off' to override exclusive upperdir protection.\n");
981 pr_warn("overlayfs: upperdir is in-use by another mount, accessing files from both mounts will result in undefined behavior.\n");
984 upper_mnt
= clone_private_mount(upperpath
);
985 err
= PTR_ERR(upper_mnt
);
986 if (IS_ERR(upper_mnt
)) {
987 pr_err("overlayfs: failed to clone upperpath\n");
991 /* Don't inherit atime flags */
992 upper_mnt
->mnt_flags
&= ~(MNT_NOATIME
| MNT_NODIRATIME
| MNT_RELATIME
);
993 ofs
->upper_mnt
= upper_mnt
;
999 static int ovl_make_workdir(struct ovl_fs
*ofs
, struct path
*workpath
)
1001 struct vfsmount
*mnt
= ofs
->upper_mnt
;
1002 struct dentry
*temp
;
1006 err
= mnt_want_write(mnt
);
1010 ofs
->workdir
= ovl_workdir_create(ofs
, OVL_WORKDIR_NAME
, false);
1015 * Upper should support d_type, else whiteouts are visible. Given
1016 * workdir and upper are on same fs, we can do iterate_dir() on
1017 * workdir. This check requires successful creation of workdir in
1020 err
= ovl_check_d_type_supported(workpath
);
1025 * We allowed this configuration and don't want to break users over
1026 * kernel upgrade. So warn instead of erroring out.
1029 pr_warn("overlayfs: upper fs needs to support d_type.\n");
1031 /* Check if upper/work fs supports O_TMPFILE */
1032 temp
= ovl_do_tmpfile(ofs
->workdir
, S_IFREG
| 0);
1033 ofs
->tmpfile
= !IS_ERR(temp
);
1037 pr_warn("overlayfs: upper fs does not support tmpfile.\n");
1040 * Check if upper/work fs supports trusted.overlay.* xattr
1042 err
= ovl_do_setxattr(ofs
->workdir
, OVL_XATTR_OPAQUE
, "0", 1, 0);
1044 ofs
->noxattr
= true;
1045 ofs
->config
.index
= false;
1046 pr_warn("overlayfs: upper fs does not support xattr, falling back to index=off.\n");
1049 vfs_removexattr(ofs
->workdir
, OVL_XATTR_OPAQUE
);
1052 /* Check if upper/work fs supports file handles */
1053 fh_type
= ovl_can_decode_fh(ofs
->workdir
->d_sb
);
1054 if (ofs
->config
.index
&& !fh_type
) {
1055 ofs
->config
.index
= false;
1056 pr_warn("overlayfs: upper fs does not support file handles, falling back to index=off.\n");
1059 /* Check if upper fs has 32bit inode numbers */
1060 if (fh_type
!= FILEID_INO32_GEN
)
1063 /* NFS export of r/w mount depends on index */
1064 if (ofs
->config
.nfs_export
&& !ofs
->config
.index
) {
1065 pr_warn("overlayfs: NFS export requires \"index=on\", falling back to nfs_export=off.\n");
1066 ofs
->config
.nfs_export
= false;
1070 mnt_drop_write(mnt
);
1074 static int ovl_get_workdir(struct ovl_fs
*ofs
, struct path
*upperpath
)
1077 struct path workpath
= { };
1079 err
= ovl_mount_dir(ofs
->config
.workdir
, &workpath
);
1084 if (upperpath
->mnt
!= workpath
.mnt
) {
1085 pr_err("overlayfs: workdir and upperdir must reside under the same mount\n");
1088 if (!ovl_workdir_ok(workpath
.dentry
, upperpath
->dentry
)) {
1089 pr_err("overlayfs: workdir and upperdir must be separate subtrees\n");
1094 if (ovl_inuse_trylock(workpath
.dentry
)) {
1095 ofs
->workdir_locked
= true;
1096 } else if (ofs
->config
.index
) {
1097 pr_err("overlayfs: workdir is in-use by another mount, mount with '-o index=off' to override exclusive workdir protection.\n");
1100 pr_warn("overlayfs: workdir is in-use by another mount, accessing files from both mounts will result in undefined behavior.\n");
1103 ofs
->workbasedir
= dget(workpath
.dentry
);
1104 err
= ovl_make_workdir(ofs
, &workpath
);
1110 path_put(&workpath
);
1115 static int ovl_get_indexdir(struct ovl_fs
*ofs
, struct ovl_entry
*oe
,
1116 struct path
*upperpath
)
1118 struct vfsmount
*mnt
= ofs
->upper_mnt
;
1121 err
= mnt_want_write(mnt
);
1125 /* Verify lower root is upper root origin */
1126 err
= ovl_verify_origin(upperpath
->dentry
, oe
->lowerstack
[0].dentry
,
1129 pr_err("overlayfs: failed to verify upper root origin\n");
1133 ofs
->indexdir
= ovl_workdir_create(ofs
, OVL_INDEXDIR_NAME
, true);
1134 if (ofs
->indexdir
) {
1136 * Verify upper root is exclusively associated with index dir.
1137 * Older kernels stored upper fh in "trusted.overlay.origin"
1138 * xattr. If that xattr exists, verify that it is a match to
1139 * upper dir file handle. In any case, verify or set xattr
1140 * "trusted.overlay.upper" to indicate that index may have
1141 * directory entries.
1143 if (ovl_check_origin_xattr(ofs
->indexdir
)) {
1144 err
= ovl_verify_set_fh(ofs
->indexdir
, OVL_XATTR_ORIGIN
,
1145 upperpath
->dentry
, true, false);
1147 pr_err("overlayfs: failed to verify index dir 'origin' xattr\n");
1149 err
= ovl_verify_upper(ofs
->indexdir
, upperpath
->dentry
, true);
1151 pr_err("overlayfs: failed to verify index dir 'upper' xattr\n");
1153 /* Cleanup bad/stale/orphan index entries */
1155 err
= ovl_indexdir_cleanup(ofs
);
1157 if (err
|| !ofs
->indexdir
)
1158 pr_warn("overlayfs: try deleting index dir or mounting with '-o index=off' to disable inodes index.\n");
1161 mnt_drop_write(mnt
);
1165 /* Get a unique fsid for the layer */
1166 static int ovl_get_fsid(struct ovl_fs
*ofs
, struct super_block
*sb
)
1172 /* fsid 0 is reserved for upper fs even with non upper overlay */
1173 if (ofs
->upper_mnt
&& ofs
->upper_mnt
->mnt_sb
== sb
)
1176 for (i
= 0; i
< ofs
->numlowerfs
; i
++) {
1177 if (ofs
->lower_fs
[i
].sb
== sb
)
1181 err
= get_anon_bdev(&dev
);
1183 pr_err("overlayfs: failed to get anonymous bdev for lowerpath\n");
1187 ofs
->lower_fs
[ofs
->numlowerfs
].sb
= sb
;
1188 ofs
->lower_fs
[ofs
->numlowerfs
].pseudo_dev
= dev
;
1191 return ofs
->numlowerfs
;
1194 static int ovl_get_lower_layers(struct ovl_fs
*ofs
, struct path
*stack
,
1195 unsigned int numlower
)
1201 ofs
->lower_layers
= kcalloc(numlower
, sizeof(struct ovl_layer
),
1203 if (ofs
->lower_layers
== NULL
)
1206 ofs
->lower_fs
= kcalloc(numlower
, sizeof(struct ovl_sb
),
1208 if (ofs
->lower_fs
== NULL
)
1211 for (i
= 0; i
< numlower
; i
++) {
1212 struct vfsmount
*mnt
;
1215 err
= fsid
= ovl_get_fsid(ofs
, stack
[i
].mnt
->mnt_sb
);
1219 mnt
= clone_private_mount(&stack
[i
]);
1222 pr_err("overlayfs: failed to clone lowerpath\n");
1227 * Make lower layers R/O. That way fchmod/fchown on lower file
1228 * will fail instead of modifying lower fs.
1230 mnt
->mnt_flags
|= MNT_READONLY
| MNT_NOATIME
;
1232 ofs
->lower_layers
[ofs
->numlower
].mnt
= mnt
;
1233 ofs
->lower_layers
[ofs
->numlower
].idx
= i
+ 1;
1234 ofs
->lower_layers
[ofs
->numlower
].fsid
= fsid
;
1236 ofs
->lower_layers
[ofs
->numlower
].fs
=
1237 &ofs
->lower_fs
[fsid
- 1];
1243 * When all layers on same fs, overlay can use real inode numbers.
1244 * With mount option "xino=on", mounter declares that there are enough
1245 * free high bits in underlying fs to hold the unique fsid.
1246 * If overlayfs does encounter underlying inodes using the high xino
1247 * bits reserved for fsid, it emits a warning and uses the original
1250 if (!ofs
->numlowerfs
|| (ofs
->numlowerfs
== 1 && !ofs
->upper_mnt
)) {
1252 ofs
->config
.xino
= OVL_XINO_OFF
;
1253 } else if (ofs
->config
.xino
== OVL_XINO_ON
&& !ofs
->xino_bits
) {
1255 * This is a roundup of number of bits needed for numlowerfs+1
1256 * (i.e. ilog2(numlowerfs+1 - 1) + 1). fsid 0 is reserved for
1257 * upper fs even with non upper overlay.
1259 BUILD_BUG_ON(ilog2(OVL_MAX_STACK
) > 31);
1260 ofs
->xino_bits
= ilog2(ofs
->numlowerfs
) + 1;
1263 if (ofs
->xino_bits
) {
1264 pr_info("overlayfs: \"xino\" feature enabled using %d upper inode bits.\n",
1273 static struct ovl_entry
*ovl_get_lowerstack(struct super_block
*sb
,
1277 char *lowertmp
, *lower
;
1278 struct path
*stack
= NULL
;
1279 unsigned int stacklen
, numlower
= 0, i
;
1280 bool remote
= false;
1281 struct ovl_entry
*oe
;
1284 lowertmp
= kstrdup(ofs
->config
.lowerdir
, GFP_KERNEL
);
1289 stacklen
= ovl_split_lowerdirs(lowertmp
);
1290 if (stacklen
> OVL_MAX_STACK
) {
1291 pr_err("overlayfs: too many lower directories, limit is %d\n",
1294 } else if (!ofs
->config
.upperdir
&& stacklen
== 1) {
1295 pr_err("overlayfs: at least 2 lowerdir are needed while upperdir nonexistent\n");
1297 } else if (!ofs
->config
.upperdir
&& ofs
->config
.nfs_export
&&
1298 ofs
->config
.redirect_follow
) {
1299 pr_warn("overlayfs: NFS export requires \"redirect_dir=nofollow\" on non-upper mount, falling back to nfs_export=off.\n");
1300 ofs
->config
.nfs_export
= false;
1304 stack
= kcalloc(stacklen
, sizeof(struct path
), GFP_KERNEL
);
1310 for (numlower
= 0; numlower
< stacklen
; numlower
++) {
1311 err
= ovl_lower_dir(lower
, &stack
[numlower
], ofs
,
1312 &sb
->s_stack_depth
, &remote
);
1316 lower
= strchr(lower
, '\0') + 1;
1320 sb
->s_stack_depth
++;
1321 if (sb
->s_stack_depth
> FILESYSTEM_MAX_STACK_DEPTH
) {
1322 pr_err("overlayfs: maximum fs stacking depth exceeded\n");
1326 err
= ovl_get_lower_layers(ofs
, stack
, numlower
);
1331 oe
= ovl_alloc_entry(numlower
);
1335 for (i
= 0; i
< numlower
; i
++) {
1336 oe
->lowerstack
[i
].dentry
= dget(stack
[i
].dentry
);
1337 oe
->lowerstack
[i
].layer
= &ofs
->lower_layers
[i
];
1341 sb
->s_d_op
= &ovl_reval_dentry_operations
;
1343 sb
->s_d_op
= &ovl_dentry_operations
;
1346 for (i
= 0; i
< numlower
; i
++)
1347 path_put(&stack
[i
]);
1358 static int ovl_fill_super(struct super_block
*sb
, void *data
, int silent
)
1360 struct path upperpath
= { };
1361 struct dentry
*root_dentry
;
1362 struct ovl_entry
*oe
;
1368 ofs
= kzalloc(sizeof(struct ovl_fs
), GFP_KERNEL
);
1372 ofs
->creator_cred
= cred
= prepare_creds();
1376 ofs
->config
.index
= ovl_index_def
;
1377 ofs
->config
.nfs_export
= ovl_nfs_export_def
;
1378 ofs
->config
.xino
= ovl_xino_def();
1379 err
= ovl_parse_opt((char *) data
, &ofs
->config
);
1384 if (!ofs
->config
.lowerdir
) {
1386 pr_err("overlayfs: missing 'lowerdir'\n");
1390 sb
->s_stack_depth
= 0;
1391 sb
->s_maxbytes
= MAX_LFS_FILESIZE
;
1392 /* Assume underlaying fs uses 32bit inodes unless proven otherwise */
1393 if (ofs
->config
.xino
!= OVL_XINO_OFF
)
1394 ofs
->xino_bits
= BITS_PER_LONG
- 32;
1396 if (ofs
->config
.upperdir
) {
1397 if (!ofs
->config
.workdir
) {
1398 pr_err("overlayfs: missing 'workdir'\n");
1402 err
= ovl_get_upper(ofs
, &upperpath
);
1406 err
= ovl_get_workdir(ofs
, &upperpath
);
1411 sb
->s_flags
|= SB_RDONLY
;
1413 sb
->s_stack_depth
= ofs
->upper_mnt
->mnt_sb
->s_stack_depth
;
1414 sb
->s_time_gran
= ofs
->upper_mnt
->mnt_sb
->s_time_gran
;
1417 oe
= ovl_get_lowerstack(sb
, ofs
);
1422 /* If the upper fs is nonexistent, we mark overlayfs r/o too */
1423 if (!ofs
->upper_mnt
)
1424 sb
->s_flags
|= SB_RDONLY
;
1426 if (!(ovl_force_readonly(ofs
)) && ofs
->config
.index
) {
1427 err
= ovl_get_indexdir(ofs
, oe
, &upperpath
);
1431 /* Force r/o mount with no index dir */
1432 if (!ofs
->indexdir
) {
1434 ofs
->workdir
= NULL
;
1435 sb
->s_flags
|= SB_RDONLY
;
1440 /* Show index=off in /proc/mounts for forced r/o mount */
1441 if (!ofs
->indexdir
) {
1442 ofs
->config
.index
= false;
1443 if (ofs
->upper_mnt
&& ofs
->config
.nfs_export
) {
1444 pr_warn("overlayfs: NFS export requires an index dir, falling back to nfs_export=off.\n");
1445 ofs
->config
.nfs_export
= false;
1449 if (ofs
->config
.nfs_export
)
1450 sb
->s_export_op
= &ovl_export_operations
;
1452 /* Never override disk quota limits or use reserved space */
1453 cap_lower(cred
->cap_effective
, CAP_SYS_RESOURCE
);
1455 sb
->s_magic
= OVERLAYFS_SUPER_MAGIC
;
1456 sb
->s_op
= &ovl_super_operations
;
1457 sb
->s_xattr
= ovl_xattr_handlers
;
1458 sb
->s_fs_info
= ofs
;
1459 sb
->s_flags
|= SB_POSIXACL
| SB_NOREMOTELOCK
;
1462 root_dentry
= d_make_root(ovl_new_inode(sb
, S_IFDIR
, 0));
1466 root_dentry
->d_fsdata
= oe
;
1468 mntput(upperpath
.mnt
);
1469 if (upperpath
.dentry
) {
1470 ovl_dentry_set_upper_alias(root_dentry
);
1471 if (ovl_is_impuredir(upperpath
.dentry
))
1472 ovl_set_flag(OVL_IMPURE
, d_inode(root_dentry
));
1475 /* Root is always merge -> can have whiteouts */
1476 ovl_set_flag(OVL_WHITEOUTS
, d_inode(root_dentry
));
1477 ovl_dentry_set_flag(OVL_E_CONNECTED
, root_dentry
);
1478 ovl_inode_init(d_inode(root_dentry
), upperpath
.dentry
,
1479 ovl_dentry_lower(root_dentry
));
1481 sb
->s_root
= root_dentry
;
1486 ovl_entry_stack_free(oe
);
1489 path_put(&upperpath
);
1495 static struct dentry
*ovl_mount(struct file_system_type
*fs_type
, int flags
,
1496 const char *dev_name
, void *raw_data
)
1498 return mount_nodev(fs_type
, flags
, raw_data
, ovl_fill_super
);
1501 static struct file_system_type ovl_fs_type
= {
1502 .owner
= THIS_MODULE
,
1505 .kill_sb
= kill_anon_super
,
1507 MODULE_ALIAS_FS("overlay");
1509 static void ovl_inode_init_once(void *foo
)
1511 struct ovl_inode
*oi
= foo
;
1513 inode_init_once(&oi
->vfs_inode
);
1516 static int __init
ovl_init(void)
1520 ovl_inode_cachep
= kmem_cache_create("ovl_inode",
1521 sizeof(struct ovl_inode
), 0,
1522 (SLAB_RECLAIM_ACCOUNT
|
1523 SLAB_MEM_SPREAD
|SLAB_ACCOUNT
),
1524 ovl_inode_init_once
);
1525 if (ovl_inode_cachep
== NULL
)
1528 err
= register_filesystem(&ovl_fs_type
);
1530 kmem_cache_destroy(ovl_inode_cachep
);
1535 static void __exit
ovl_exit(void)
1537 unregister_filesystem(&ovl_fs_type
);
1540 * Make sure all delayed rcu free inodes are flushed before we
1544 kmem_cache_destroy(ovl_inode_cachep
);
1548 module_init(ovl_init
);
1549 module_exit(ovl_exit
);