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.
11 #include <linux/namei.h>
12 #include <linux/xattr.h>
13 #include <linux/security.h>
14 #include <linux/cred.h>
15 #include "overlayfs.h"
17 void ovl_cleanup(struct inode
*wdir
, struct dentry
*wdentry
)
22 if (d_is_dir(wdentry
))
23 err
= ovl_do_rmdir(wdir
, wdentry
);
25 err
= ovl_do_unlink(wdir
, wdentry
);
29 pr_err("overlayfs: cleanup of '%pd2' failed (%i)\n",
34 struct dentry
*ovl_lookup_temp(struct dentry
*workdir
, struct dentry
*dentry
)
39 snprintf(name
, sizeof(name
), "#%lx", (unsigned long) dentry
);
41 temp
= lookup_one_len(name
, workdir
, strlen(name
));
42 if (!IS_ERR(temp
) && temp
->d_inode
) {
43 pr_err("overlayfs: workdir/%s already exists\n", name
);
51 /* caller holds i_mutex on workdir */
52 static struct dentry
*ovl_whiteout(struct dentry
*workdir
,
53 struct dentry
*dentry
)
56 struct dentry
*whiteout
;
57 struct inode
*wdir
= workdir
->d_inode
;
59 whiteout
= ovl_lookup_temp(workdir
, dentry
);
63 err
= ovl_do_whiteout(wdir
, whiteout
);
66 whiteout
= ERR_PTR(err
);
72 int ovl_create_real(struct inode
*dir
, struct dentry
*newdentry
,
73 struct kstat
*stat
, const char *link
,
74 struct dentry
*hardlink
, bool debug
)
78 if (newdentry
->d_inode
)
82 err
= ovl_do_link(hardlink
, dir
, newdentry
, debug
);
84 switch (stat
->mode
& S_IFMT
) {
86 err
= ovl_do_create(dir
, newdentry
, stat
->mode
, debug
);
90 err
= ovl_do_mkdir(dir
, newdentry
, stat
->mode
, debug
);
97 err
= ovl_do_mknod(dir
, newdentry
,
98 stat
->mode
, stat
->rdev
, debug
);
102 err
= ovl_do_symlink(dir
, newdentry
, link
, debug
);
109 if (!err
&& WARN_ON(!newdentry
->d_inode
)) {
111 * Not quite sure if non-instantiated dentry is legal or not.
112 * VFS doesn't seem to care so check and warn here.
119 static int ovl_set_opaque(struct dentry
*upperdentry
)
121 return ovl_do_setxattr(upperdentry
, OVL_XATTR_OPAQUE
, "y", 1, 0);
124 static void ovl_remove_opaque(struct dentry
*upperdentry
)
128 err
= ovl_do_removexattr(upperdentry
, OVL_XATTR_OPAQUE
);
130 pr_warn("overlayfs: failed to remove opaque from '%s' (%i)\n",
131 upperdentry
->d_name
.name
, err
);
135 static int ovl_dir_getattr(struct vfsmount
*mnt
, struct dentry
*dentry
,
139 enum ovl_path_type type
;
140 struct path realpath
;
141 const struct cred
*old_cred
;
143 type
= ovl_path_real(dentry
, &realpath
);
144 old_cred
= ovl_override_creds(dentry
->d_sb
);
145 err
= vfs_getattr(&realpath
, stat
);
146 revert_creds(old_cred
);
150 stat
->dev
= dentry
->d_sb
->s_dev
;
151 stat
->ino
= dentry
->d_inode
->i_ino
;
154 * It's probably not worth it to count subdirs to get the
155 * correct link count. nlink=1 seems to pacify 'find' and
158 if (OVL_TYPE_MERGE(type
))
164 /* Common operations required to be done after creation of file on upper */
165 static void ovl_instantiate(struct dentry
*dentry
, struct inode
*inode
,
166 struct dentry
*newdentry
)
168 ovl_dentry_version_inc(dentry
->d_parent
);
169 ovl_dentry_update(dentry
, newdentry
);
170 ovl_inode_update(inode
, d_inode(newdentry
));
171 ovl_copyattr(newdentry
->d_inode
, inode
);
172 d_instantiate(dentry
, inode
);
175 static int ovl_create_upper(struct dentry
*dentry
, struct inode
*inode
,
176 struct kstat
*stat
, const char *link
,
177 struct dentry
*hardlink
)
179 struct dentry
*upperdir
= ovl_dentry_upper(dentry
->d_parent
);
180 struct inode
*udir
= upperdir
->d_inode
;
181 struct dentry
*newdentry
;
184 inode_lock_nested(udir
, I_MUTEX_PARENT
);
185 newdentry
= lookup_one_len(dentry
->d_name
.name
, upperdir
,
187 err
= PTR_ERR(newdentry
);
188 if (IS_ERR(newdentry
))
190 err
= ovl_create_real(udir
, newdentry
, stat
, link
, hardlink
, false);
194 ovl_instantiate(dentry
, inode
, newdentry
);
203 static int ovl_lock_rename_workdir(struct dentry
*workdir
,
204 struct dentry
*upperdir
)
206 /* Workdir should not be the same as upperdir */
207 if (workdir
== upperdir
)
210 /* Workdir should not be subdir of upperdir and vice versa */
211 if (lock_rename(workdir
, upperdir
) != NULL
)
217 unlock_rename(workdir
, upperdir
);
219 pr_err("overlayfs: failed to lock workdir+upperdir\n");
223 static struct dentry
*ovl_clear_empty(struct dentry
*dentry
,
224 struct list_head
*list
)
226 struct dentry
*workdir
= ovl_workdir(dentry
);
227 struct inode
*wdir
= workdir
->d_inode
;
228 struct dentry
*upperdir
= ovl_dentry_upper(dentry
->d_parent
);
229 struct inode
*udir
= upperdir
->d_inode
;
230 struct path upperpath
;
231 struct dentry
*upper
;
232 struct dentry
*opaquedir
;
236 if (WARN_ON(!workdir
))
237 return ERR_PTR(-EROFS
);
239 err
= ovl_lock_rename_workdir(workdir
, upperdir
);
243 ovl_path_upper(dentry
, &upperpath
);
244 err
= vfs_getattr(&upperpath
, &stat
);
249 if (!S_ISDIR(stat
.mode
))
251 upper
= upperpath
.dentry
;
252 if (upper
->d_parent
->d_inode
!= udir
)
255 opaquedir
= ovl_lookup_temp(workdir
, dentry
);
256 err
= PTR_ERR(opaquedir
);
257 if (IS_ERR(opaquedir
))
260 err
= ovl_create_real(wdir
, opaquedir
, &stat
, NULL
, NULL
, true);
264 err
= ovl_copy_xattr(upper
, opaquedir
);
268 err
= ovl_set_opaque(opaquedir
);
272 inode_lock(opaquedir
->d_inode
);
273 err
= ovl_set_attr(opaquedir
, &stat
);
274 inode_unlock(opaquedir
->d_inode
);
278 err
= ovl_do_rename(wdir
, opaquedir
, udir
, upper
, RENAME_EXCHANGE
);
282 ovl_cleanup_whiteouts(upper
, list
);
283 ovl_cleanup(wdir
, upper
);
284 unlock_rename(workdir
, upperdir
);
286 /* dentry's upper doesn't match now, get rid of it */
292 ovl_cleanup(wdir
, opaquedir
);
296 unlock_rename(workdir
, upperdir
);
301 static struct dentry
*ovl_check_empty_and_clear(struct dentry
*dentry
)
304 struct dentry
*ret
= NULL
;
307 err
= ovl_check_empty_dir(dentry
, &list
);
312 * If no upperdentry then skip clearing whiteouts.
314 * Can race with copy-up, since we don't hold the upperdir
315 * mutex. Doesn't matter, since copy-up can't create a
316 * non-empty directory from an empty one.
318 if (ovl_dentry_upper(dentry
))
319 ret
= ovl_clear_empty(dentry
, &list
);
322 ovl_cache_free(&list
);
327 static int ovl_create_over_whiteout(struct dentry
*dentry
, struct inode
*inode
,
328 struct kstat
*stat
, const char *link
,
329 struct dentry
*hardlink
)
331 struct dentry
*workdir
= ovl_workdir(dentry
);
332 struct inode
*wdir
= workdir
->d_inode
;
333 struct dentry
*upperdir
= ovl_dentry_upper(dentry
->d_parent
);
334 struct inode
*udir
= upperdir
->d_inode
;
335 struct dentry
*upper
;
336 struct dentry
*newdentry
;
339 if (WARN_ON(!workdir
))
342 err
= ovl_lock_rename_workdir(workdir
, upperdir
);
346 newdentry
= ovl_lookup_temp(workdir
, dentry
);
347 err
= PTR_ERR(newdentry
);
348 if (IS_ERR(newdentry
))
351 upper
= lookup_one_len(dentry
->d_name
.name
, upperdir
,
353 err
= PTR_ERR(upper
);
357 err
= ovl_create_real(wdir
, newdentry
, stat
, link
, hardlink
, true);
362 * mode could have been mutilated due to umask (e.g. sgid directory)
364 if (!S_ISLNK(stat
->mode
) && newdentry
->d_inode
->i_mode
!= stat
->mode
) {
365 struct iattr attr
= {
366 .ia_valid
= ATTR_MODE
,
367 .ia_mode
= stat
->mode
,
369 inode_lock(newdentry
->d_inode
);
370 err
= notify_change(newdentry
, &attr
, NULL
);
371 inode_unlock(newdentry
->d_inode
);
376 if (S_ISDIR(stat
->mode
)) {
377 err
= ovl_set_opaque(newdentry
);
381 err
= ovl_do_rename(wdir
, newdentry
, udir
, upper
,
386 ovl_cleanup(wdir
, upper
);
388 err
= ovl_do_rename(wdir
, newdentry
, udir
, upper
, 0);
392 ovl_instantiate(dentry
, inode
, newdentry
);
399 unlock_rename(workdir
, upperdir
);
404 ovl_cleanup(wdir
, newdentry
);
408 static int ovl_create_or_link(struct dentry
*dentry
, int mode
, dev_t rdev
,
409 const char *link
, struct dentry
*hardlink
)
413 const struct cred
*old_cred
;
414 struct cred
*override_cred
;
415 struct kstat stat
= {
420 inode
= ovl_new_inode(dentry
->d_sb
, mode
);
424 err
= ovl_copy_up(dentry
->d_parent
);
428 inode_init_owner(inode
, dentry
->d_parent
->d_inode
, mode
);
429 stat
.mode
= inode
->i_mode
;
431 old_cred
= ovl_override_creds(dentry
->d_sb
);
433 override_cred
= prepare_creds();
435 override_cred
->fsuid
= inode
->i_uid
;
436 override_cred
->fsgid
= inode
->i_gid
;
437 put_cred(override_creds(override_cred
));
438 put_cred(override_cred
);
440 if (!ovl_dentry_is_opaque(dentry
))
441 err
= ovl_create_upper(dentry
, inode
, &stat
, link
,
444 err
= ovl_create_over_whiteout(dentry
, inode
, &stat
,
447 revert_creds(old_cred
);
449 struct inode
*realinode
= d_inode(ovl_dentry_upper(dentry
));
451 WARN_ON(inode
->i_mode
!= realinode
->i_mode
);
452 WARN_ON(!uid_eq(inode
->i_uid
, realinode
->i_uid
));
453 WARN_ON(!gid_eq(inode
->i_gid
, realinode
->i_gid
));
462 static int ovl_create_object(struct dentry
*dentry
, int mode
, dev_t rdev
,
467 err
= ovl_want_write(dentry
);
469 err
= ovl_create_or_link(dentry
, mode
, rdev
, link
, NULL
);
470 ovl_drop_write(dentry
);
476 static int ovl_create(struct inode
*dir
, struct dentry
*dentry
, umode_t mode
,
479 return ovl_create_object(dentry
, (mode
& 07777) | S_IFREG
, 0, NULL
);
482 static int ovl_mkdir(struct inode
*dir
, struct dentry
*dentry
, umode_t mode
)
484 return ovl_create_object(dentry
, (mode
& 07777) | S_IFDIR
, 0, NULL
);
487 static int ovl_mknod(struct inode
*dir
, struct dentry
*dentry
, umode_t mode
,
490 /* Don't allow creation of "whiteout" on overlay */
491 if (S_ISCHR(mode
) && rdev
== WHITEOUT_DEV
)
494 return ovl_create_object(dentry
, mode
, rdev
, NULL
);
497 static int ovl_symlink(struct inode
*dir
, struct dentry
*dentry
,
500 return ovl_create_object(dentry
, S_IFLNK
, 0, link
);
503 static int ovl_link(struct dentry
*old
, struct inode
*newdir
,
507 struct dentry
*upper
;
509 err
= ovl_want_write(old
);
513 err
= ovl_copy_up(old
);
517 upper
= ovl_dentry_upper(old
);
518 err
= ovl_create_or_link(new, upper
->d_inode
->i_mode
, 0, NULL
, upper
);
526 static int ovl_remove_and_whiteout(struct dentry
*dentry
, bool is_dir
)
528 struct dentry
*workdir
= ovl_workdir(dentry
);
529 struct inode
*wdir
= workdir
->d_inode
;
530 struct dentry
*upperdir
= ovl_dentry_upper(dentry
->d_parent
);
531 struct inode
*udir
= upperdir
->d_inode
;
532 struct dentry
*whiteout
;
533 struct dentry
*upper
;
534 struct dentry
*opaquedir
= NULL
;
538 if (WARN_ON(!workdir
))
542 if (OVL_TYPE_MERGE_OR_LOWER(ovl_path_type(dentry
))) {
543 opaquedir
= ovl_check_empty_and_clear(dentry
);
544 err
= PTR_ERR(opaquedir
);
545 if (IS_ERR(opaquedir
))
551 * When removing an empty opaque directory, then it
552 * makes no sense to replace it with an exact replica of
553 * itself. But emptiness still needs to be checked.
555 err
= ovl_check_empty_dir(dentry
, &list
);
556 ovl_cache_free(&list
);
562 err
= ovl_lock_rename_workdir(workdir
, upperdir
);
566 upper
= lookup_one_len(dentry
->d_name
.name
, upperdir
,
568 err
= PTR_ERR(upper
);
573 if ((opaquedir
&& upper
!= opaquedir
) ||
574 (!opaquedir
&& ovl_dentry_upper(dentry
) &&
575 upper
!= ovl_dentry_upper(dentry
))) {
579 whiteout
= ovl_whiteout(workdir
, dentry
);
580 err
= PTR_ERR(whiteout
);
581 if (IS_ERR(whiteout
))
585 flags
= RENAME_EXCHANGE
;
587 err
= ovl_do_rename(wdir
, whiteout
, udir
, upper
, flags
);
591 ovl_cleanup(wdir
, upper
);
593 ovl_dentry_version_inc(dentry
->d_parent
);
600 unlock_rename(workdir
, upperdir
);
607 ovl_cleanup(wdir
, whiteout
);
611 static int ovl_remove_upper(struct dentry
*dentry
, bool is_dir
)
613 struct dentry
*upperdir
= ovl_dentry_upper(dentry
->d_parent
);
614 struct inode
*dir
= upperdir
->d_inode
;
615 struct dentry
*upper
;
618 inode_lock_nested(dir
, I_MUTEX_PARENT
);
619 upper
= lookup_one_len(dentry
->d_name
.name
, upperdir
,
621 err
= PTR_ERR(upper
);
626 if (upper
== ovl_dentry_upper(dentry
)) {
628 err
= vfs_rmdir(dir
, upper
);
630 err
= vfs_unlink(dir
, upper
, NULL
);
631 ovl_dentry_version_inc(dentry
->d_parent
);
636 * Keeping this dentry hashed would mean having to release
637 * upperpath/lowerpath, which could only be done if we are the
638 * sole user of this dentry. Too tricky... Just unhash for
649 static inline int ovl_check_sticky(struct dentry
*dentry
)
651 struct inode
*dir
= ovl_dentry_real(dentry
->d_parent
)->d_inode
;
652 struct inode
*inode
= ovl_dentry_real(dentry
)->d_inode
;
654 if (check_sticky(dir
, inode
))
660 static int ovl_do_remove(struct dentry
*dentry
, bool is_dir
)
662 enum ovl_path_type type
;
664 const struct cred
*old_cred
;
667 err
= ovl_check_sticky(dentry
);
671 err
= ovl_want_write(dentry
);
675 err
= ovl_copy_up(dentry
->d_parent
);
679 type
= ovl_path_type(dentry
);
681 old_cred
= ovl_override_creds(dentry
->d_sb
);
682 if (OVL_TYPE_PURE_UPPER(type
))
683 err
= ovl_remove_upper(dentry
, is_dir
);
685 err
= ovl_remove_and_whiteout(dentry
, is_dir
);
686 revert_creds(old_cred
);
688 ovl_drop_write(dentry
);
693 static int ovl_unlink(struct inode
*dir
, struct dentry
*dentry
)
695 return ovl_do_remove(dentry
, false);
698 static int ovl_rmdir(struct inode
*dir
, struct dentry
*dentry
)
700 return ovl_do_remove(dentry
, true);
703 static int ovl_rename2(struct inode
*olddir
, struct dentry
*old
,
704 struct inode
*newdir
, struct dentry
*new,
708 enum ovl_path_type old_type
;
709 enum ovl_path_type new_type
;
710 struct dentry
*old_upperdir
;
711 struct dentry
*new_upperdir
;
712 struct dentry
*olddentry
;
713 struct dentry
*newdentry
;
717 bool cleanup_whiteout
= false;
718 bool overwrite
= !(flags
& RENAME_EXCHANGE
);
719 bool is_dir
= d_is_dir(old
);
720 bool new_is_dir
= false;
721 struct dentry
*opaquedir
= NULL
;
722 const struct cred
*old_cred
= NULL
;
725 if (flags
& ~(RENAME_EXCHANGE
| RENAME_NOREPLACE
))
728 flags
&= ~RENAME_NOREPLACE
;
730 err
= ovl_check_sticky(old
);
734 /* Don't copy up directory trees */
735 old_type
= ovl_path_type(old
);
737 if (OVL_TYPE_MERGE_OR_LOWER(old_type
) && is_dir
)
741 err
= ovl_check_sticky(new);
748 new_type
= ovl_path_type(new);
750 if (!overwrite
&& OVL_TYPE_MERGE_OR_LOWER(new_type
) && new_is_dir
)
754 if (!OVL_TYPE_UPPER(new_type
) && !OVL_TYPE_UPPER(old_type
)) {
755 if (ovl_dentry_lower(old
)->d_inode
==
756 ovl_dentry_lower(new)->d_inode
)
759 if (OVL_TYPE_UPPER(new_type
) && OVL_TYPE_UPPER(old_type
)) {
760 if (ovl_dentry_upper(old
)->d_inode
==
761 ovl_dentry_upper(new)->d_inode
)
765 if (ovl_dentry_is_opaque(new))
766 new_type
= __OVL_PATH_UPPER
;
768 new_type
= __OVL_PATH_UPPER
| __OVL_PATH_PURE
;
771 err
= ovl_want_write(old
);
775 err
= ovl_copy_up(old
);
779 err
= ovl_copy_up(new->d_parent
);
783 err
= ovl_copy_up(new);
788 old_opaque
= !OVL_TYPE_PURE_UPPER(old_type
);
789 new_opaque
= !OVL_TYPE_PURE_UPPER(new_type
);
791 old_cred
= ovl_override_creds(old
->d_sb
);
793 if (overwrite
&& OVL_TYPE_MERGE_OR_LOWER(new_type
) && new_is_dir
) {
794 opaquedir
= ovl_check_empty_and_clear(new);
795 err
= PTR_ERR(opaquedir
);
796 if (IS_ERR(opaquedir
)) {
798 goto out_revert_creds
;
804 if (new->d_inode
|| !new_opaque
) {
805 /* Whiteout source */
806 flags
|= RENAME_WHITEOUT
;
808 /* Switch whiteouts */
809 flags
|= RENAME_EXCHANGE
;
811 } else if (is_dir
&& !new->d_inode
&& new_opaque
) {
812 flags
|= RENAME_EXCHANGE
;
813 cleanup_whiteout
= true;
817 old_upperdir
= ovl_dentry_upper(old
->d_parent
);
818 new_upperdir
= ovl_dentry_upper(new->d_parent
);
820 trap
= lock_rename(new_upperdir
, old_upperdir
);
823 olddentry
= lookup_one_len(old
->d_name
.name
, old_upperdir
,
825 err
= PTR_ERR(olddentry
);
826 if (IS_ERR(olddentry
))
830 if (olddentry
!= ovl_dentry_upper(old
))
833 newdentry
= lookup_one_len(new->d_name
.name
, new_upperdir
,
835 err
= PTR_ERR(newdentry
);
836 if (IS_ERR(newdentry
))
840 if (ovl_dentry_upper(new)) {
842 if (newdentry
!= opaquedir
)
845 if (newdentry
!= ovl_dentry_upper(new))
849 if (!d_is_negative(newdentry
) &&
850 (!new_opaque
|| !ovl_is_whiteout(newdentry
)))
854 if (olddentry
== trap
)
856 if (newdentry
== trap
)
859 if (is_dir
&& !old_opaque
&& new_opaque
) {
860 err
= ovl_set_opaque(olddentry
);
864 if (!overwrite
&& new_is_dir
&& old_opaque
&& !new_opaque
) {
865 err
= ovl_set_opaque(newdentry
);
870 if (old_opaque
|| new_opaque
) {
871 err
= ovl_do_rename(old_upperdir
->d_inode
, olddentry
,
872 new_upperdir
->d_inode
, newdentry
,
875 /* No debug for the plain case */
876 BUG_ON(flags
& ~RENAME_EXCHANGE
);
877 err
= vfs_rename(old_upperdir
->d_inode
, olddentry
,
878 new_upperdir
->d_inode
, newdentry
,
883 if (is_dir
&& !old_opaque
&& new_opaque
)
884 ovl_remove_opaque(olddentry
);
885 if (!overwrite
&& new_is_dir
&& old_opaque
&& !new_opaque
)
886 ovl_remove_opaque(newdentry
);
890 if (is_dir
&& old_opaque
&& !new_opaque
)
891 ovl_remove_opaque(olddentry
);
892 if (!overwrite
&& new_is_dir
&& !old_opaque
&& new_opaque
)
893 ovl_remove_opaque(newdentry
);
896 * Old dentry now lives in different location. Dentries in
897 * lowerstack are stale. We cannot drop them here because
898 * access to them is lockless. This could be only pure upper
899 * or opaque directory - numlower is zero. Or upper non-dir
900 * entry - its pureness is tracked by flag opaque.
902 if (old_opaque
!= new_opaque
) {
903 ovl_dentry_set_opaque(old
, new_opaque
);
905 ovl_dentry_set_opaque(new, old_opaque
);
908 if (cleanup_whiteout
)
909 ovl_cleanup(old_upperdir
->d_inode
, newdentry
);
911 ovl_dentry_version_inc(old
->d_parent
);
912 ovl_dentry_version_inc(new->d_parent
);
919 unlock_rename(new_upperdir
, old_upperdir
);
921 revert_creds(old_cred
);
929 const struct inode_operations ovl_dir_inode_operations
= {
930 .lookup
= ovl_lookup
,
932 .symlink
= ovl_symlink
,
933 .unlink
= ovl_unlink
,
935 .rename2
= ovl_rename2
,
937 .setattr
= ovl_setattr
,
938 .create
= ovl_create
,
940 .permission
= ovl_permission
,
941 .getattr
= ovl_dir_getattr
,
942 .setxattr
= ovl_setxattr
,
943 .getxattr
= ovl_getxattr
,
944 .listxattr
= ovl_listxattr
,
945 .removexattr
= ovl_removexattr
,
946 .get_acl
= ovl_get_acl
,
947 .update_time
= ovl_update_time
,