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, bool hardlink)
168 ovl_dentry_version_inc(dentry->d_parent);
169 ovl_dentry_update(dentry, newdentry);
171 ovl_inode_update(inode, d_inode(newdentry));
172 ovl_copyattr(newdentry->d_inode, inode);
174 WARN_ON(ovl_inode_real(inode, NULL) != d_inode(newdentry));
177 d_instantiate(dentry, inode);
180 static int ovl_create_upper(struct dentry *dentry, struct inode *inode,
181 struct kstat *stat, const char *link,
182 struct dentry *hardlink)
184 struct dentry *upperdir = ovl_dentry_upper(dentry->d_parent);
185 struct inode *udir = upperdir->d_inode;
186 struct dentry *newdentry;
189 inode_lock_nested(udir, I_MUTEX_PARENT);
190 newdentry = lookup_one_len(dentry->d_name.name, upperdir,
192 err = PTR_ERR(newdentry);
193 if (IS_ERR(newdentry))
195 err = ovl_create_real(udir, newdentry, stat, link, hardlink, false);
199 ovl_instantiate(dentry, inode, newdentry, !!hardlink);
208 static int ovl_lock_rename_workdir(struct dentry *workdir,
209 struct dentry *upperdir)
211 /* Workdir should not be the same as upperdir */
212 if (workdir == upperdir)
215 /* Workdir should not be subdir of upperdir and vice versa */
216 if (lock_rename(workdir, upperdir) != NULL)
222 unlock_rename(workdir, upperdir);
224 pr_err("overlayfs: failed to lock workdir+upperdir\n");
228 static struct dentry *ovl_clear_empty(struct dentry *dentry,
229 struct list_head *list)
231 struct dentry *workdir = ovl_workdir(dentry);
232 struct inode *wdir = workdir->d_inode;
233 struct dentry *upperdir = ovl_dentry_upper(dentry->d_parent);
234 struct inode *udir = upperdir->d_inode;
235 struct path upperpath;
236 struct dentry *upper;
237 struct dentry *opaquedir;
241 if (WARN_ON(!workdir))
242 return ERR_PTR(-EROFS);
244 err = ovl_lock_rename_workdir(workdir, upperdir);
248 ovl_path_upper(dentry, &upperpath);
249 err = vfs_getattr(&upperpath, &stat);
254 if (!S_ISDIR(stat.mode))
256 upper = upperpath.dentry;
257 if (upper->d_parent->d_inode != udir)
260 opaquedir = ovl_lookup_temp(workdir, dentry);
261 err = PTR_ERR(opaquedir);
262 if (IS_ERR(opaquedir))
265 err = ovl_create_real(wdir, opaquedir, &stat, NULL, NULL, true);
269 err = ovl_copy_xattr(upper, opaquedir);
273 err = ovl_set_opaque(opaquedir);
277 inode_lock(opaquedir->d_inode);
278 err = ovl_set_attr(opaquedir, &stat);
279 inode_unlock(opaquedir->d_inode);
283 err = ovl_do_rename(wdir, opaquedir, udir, upper, RENAME_EXCHANGE);
287 ovl_cleanup_whiteouts(upper, list);
288 ovl_cleanup(wdir, upper);
289 unlock_rename(workdir, upperdir);
291 /* dentry's upper doesn't match now, get rid of it */
297 ovl_cleanup(wdir, opaquedir);
301 unlock_rename(workdir, upperdir);
306 static struct dentry *ovl_check_empty_and_clear(struct dentry *dentry)
309 struct dentry *ret = NULL;
312 err = ovl_check_empty_dir(dentry, &list);
317 * If no upperdentry then skip clearing whiteouts.
319 * Can race with copy-up, since we don't hold the upperdir
320 * mutex. Doesn't matter, since copy-up can't create a
321 * non-empty directory from an empty one.
323 if (ovl_dentry_upper(dentry))
324 ret = ovl_clear_empty(dentry, &list);
327 ovl_cache_free(&list);
332 static int ovl_create_over_whiteout(struct dentry *dentry, struct inode *inode,
333 struct kstat *stat, const char *link,
334 struct dentry *hardlink)
336 struct dentry *workdir = ovl_workdir(dentry);
337 struct inode *wdir = workdir->d_inode;
338 struct dentry *upperdir = ovl_dentry_upper(dentry->d_parent);
339 struct inode *udir = upperdir->d_inode;
340 struct dentry *upper;
341 struct dentry *newdentry;
344 if (WARN_ON(!workdir))
347 err = ovl_lock_rename_workdir(workdir, upperdir);
351 newdentry = ovl_lookup_temp(workdir, dentry);
352 err = PTR_ERR(newdentry);
353 if (IS_ERR(newdentry))
356 upper = lookup_one_len(dentry->d_name.name, upperdir,
358 err = PTR_ERR(upper);
362 err = ovl_create_real(wdir, newdentry, stat, link, hardlink, true);
367 * mode could have been mutilated due to umask (e.g. sgid directory)
370 !S_ISLNK(stat->mode) && newdentry->d_inode->i_mode != stat->mode) {
371 struct iattr attr = {
372 .ia_valid = ATTR_MODE,
373 .ia_mode = stat->mode,
375 inode_lock(newdentry->d_inode);
376 err = notify_change(newdentry, &attr, NULL);
377 inode_unlock(newdentry->d_inode);
382 if (!hardlink && S_ISDIR(stat->mode)) {
383 err = ovl_set_opaque(newdentry);
387 err = ovl_do_rename(wdir, newdentry, udir, upper,
392 ovl_cleanup(wdir, upper);
394 err = ovl_do_rename(wdir, newdentry, udir, upper, 0);
398 ovl_instantiate(dentry, inode, newdentry, !!hardlink);
405 unlock_rename(workdir, upperdir);
410 ovl_cleanup(wdir, newdentry);
414 static int ovl_create_or_link(struct dentry *dentry, struct inode *inode,
415 struct kstat *stat, const char *link,
416 struct dentry *hardlink)
419 const struct cred *old_cred;
420 struct cred *override_cred;
422 err = ovl_copy_up(dentry->d_parent);
426 old_cred = ovl_override_creds(dentry->d_sb);
428 override_cred = prepare_creds();
430 override_cred->fsuid = inode->i_uid;
431 override_cred->fsgid = inode->i_gid;
432 put_cred(override_creds(override_cred));
433 put_cred(override_cred);
435 if (!ovl_dentry_is_opaque(dentry))
436 err = ovl_create_upper(dentry, inode, stat, link,
439 err = ovl_create_over_whiteout(dentry, inode, stat,
442 revert_creds(old_cred);
444 struct inode *realinode = d_inode(ovl_dentry_upper(dentry));
446 WARN_ON(inode->i_mode != realinode->i_mode);
447 WARN_ON(!uid_eq(inode->i_uid, realinode->i_uid));
448 WARN_ON(!gid_eq(inode->i_gid, realinode->i_gid));
453 static int ovl_create_object(struct dentry *dentry, int mode, dev_t rdev,
458 struct kstat stat = {
462 err = ovl_want_write(dentry);
467 inode = ovl_new_inode(dentry->d_sb, mode);
471 inode_init_owner(inode, dentry->d_parent->d_inode, mode);
472 stat.mode = inode->i_mode;
474 err = ovl_create_or_link(dentry, inode, &stat, link, NULL);
479 ovl_drop_write(dentry);
484 static int ovl_create(struct inode *dir, struct dentry *dentry, umode_t mode,
487 return ovl_create_object(dentry, (mode & 07777) | S_IFREG, 0, NULL);
490 static int ovl_mkdir(struct inode *dir, struct dentry *dentry, umode_t mode)
492 return ovl_create_object(dentry, (mode & 07777) | S_IFDIR, 0, NULL);
495 static int ovl_mknod(struct inode *dir, struct dentry *dentry, umode_t mode,
498 /* Don't allow creation of "whiteout" on overlay */
499 if (S_ISCHR(mode) && rdev == WHITEOUT_DEV)
502 return ovl_create_object(dentry, mode, rdev, NULL);
505 static int ovl_symlink(struct inode *dir, struct dentry *dentry,
508 return ovl_create_object(dentry, S_IFLNK, 0, link);
511 static int ovl_link(struct dentry *old, struct inode *newdir,
517 err = ovl_want_write(old);
521 err = ovl_copy_up(old);
525 inode = d_inode(old);
528 err = ovl_create_or_link(new, inode, NULL, NULL, ovl_dentry_upper(old));
538 static int ovl_remove_and_whiteout(struct dentry *dentry, bool is_dir)
540 struct dentry *workdir = ovl_workdir(dentry);
541 struct inode *wdir = workdir->d_inode;
542 struct dentry *upperdir = ovl_dentry_upper(dentry->d_parent);
543 struct inode *udir = upperdir->d_inode;
544 struct dentry *whiteout;
545 struct dentry *upper;
546 struct dentry *opaquedir = NULL;
550 if (WARN_ON(!workdir))
554 if (OVL_TYPE_MERGE_OR_LOWER(ovl_path_type(dentry))) {
555 opaquedir = ovl_check_empty_and_clear(dentry);
556 err = PTR_ERR(opaquedir);
557 if (IS_ERR(opaquedir))
563 * When removing an empty opaque directory, then it
564 * makes no sense to replace it with an exact replica of
565 * itself. But emptiness still needs to be checked.
567 err = ovl_check_empty_dir(dentry, &list);
568 ovl_cache_free(&list);
574 err = ovl_lock_rename_workdir(workdir, upperdir);
578 upper = lookup_one_len(dentry->d_name.name, upperdir,
580 err = PTR_ERR(upper);
585 if ((opaquedir && upper != opaquedir) ||
586 (!opaquedir && ovl_dentry_upper(dentry) &&
587 upper != ovl_dentry_upper(dentry))) {
591 whiteout = ovl_whiteout(workdir, dentry);
592 err = PTR_ERR(whiteout);
593 if (IS_ERR(whiteout))
597 flags = RENAME_EXCHANGE;
599 err = ovl_do_rename(wdir, whiteout, udir, upper, flags);
603 ovl_cleanup(wdir, upper);
605 ovl_dentry_version_inc(dentry->d_parent);
612 unlock_rename(workdir, upperdir);
619 ovl_cleanup(wdir, whiteout);
623 static int ovl_remove_upper(struct dentry *dentry, bool is_dir)
625 struct dentry *upperdir = ovl_dentry_upper(dentry->d_parent);
626 struct inode *dir = upperdir->d_inode;
627 struct dentry *upper;
630 inode_lock_nested(dir, I_MUTEX_PARENT);
631 upper = lookup_one_len(dentry->d_name.name, upperdir,
633 err = PTR_ERR(upper);
638 if (upper == ovl_dentry_upper(dentry)) {
640 err = vfs_rmdir(dir, upper);
642 err = vfs_unlink(dir, upper, NULL);
643 ovl_dentry_version_inc(dentry->d_parent);
648 * Keeping this dentry hashed would mean having to release
649 * upperpath/lowerpath, which could only be done if we are the
650 * sole user of this dentry. Too tricky... Just unhash for
661 static inline int ovl_check_sticky(struct dentry *dentry)
663 struct inode *dir = ovl_dentry_real(dentry->d_parent)->d_inode;
664 struct inode *inode = ovl_dentry_real(dentry)->d_inode;
666 if (check_sticky(dir, inode))
672 static int ovl_do_remove(struct dentry *dentry, bool is_dir)
674 enum ovl_path_type type;
676 const struct cred *old_cred;
679 err = ovl_check_sticky(dentry);
683 err = ovl_want_write(dentry);
687 err = ovl_copy_up(dentry->d_parent);
691 type = ovl_path_type(dentry);
693 old_cred = ovl_override_creds(dentry->d_sb);
694 if (OVL_TYPE_PURE_UPPER(type))
695 err = ovl_remove_upper(dentry, is_dir);
697 err = ovl_remove_and_whiteout(dentry, is_dir);
698 revert_creds(old_cred);
700 drop_nlink(dentry->d_inode);
702 ovl_drop_write(dentry);
707 static int ovl_unlink(struct inode *dir, struct dentry *dentry)
709 return ovl_do_remove(dentry, false);
712 static int ovl_rmdir(struct inode *dir, struct dentry *dentry)
714 return ovl_do_remove(dentry, true);
717 static int ovl_rename2(struct inode *olddir, struct dentry *old,
718 struct inode *newdir, struct dentry *new,
722 enum ovl_path_type old_type;
723 enum ovl_path_type new_type;
724 struct dentry *old_upperdir;
725 struct dentry *new_upperdir;
726 struct dentry *olddentry;
727 struct dentry *newdentry;
731 bool cleanup_whiteout = false;
732 bool overwrite = !(flags & RENAME_EXCHANGE);
733 bool is_dir = d_is_dir(old);
734 bool new_is_dir = false;
735 struct dentry *opaquedir = NULL;
736 const struct cred *old_cred = NULL;
739 if (flags & ~(RENAME_EXCHANGE | RENAME_NOREPLACE))
742 flags &= ~RENAME_NOREPLACE;
744 err = ovl_check_sticky(old);
748 /* Don't copy up directory trees */
749 old_type = ovl_path_type(old);
751 if (OVL_TYPE_MERGE_OR_LOWER(old_type) && is_dir)
755 err = ovl_check_sticky(new);
762 new_type = ovl_path_type(new);
764 if (!overwrite && OVL_TYPE_MERGE_OR_LOWER(new_type) && new_is_dir)
768 if (!OVL_TYPE_UPPER(new_type) && !OVL_TYPE_UPPER(old_type)) {
769 if (ovl_dentry_lower(old)->d_inode ==
770 ovl_dentry_lower(new)->d_inode)
773 if (OVL_TYPE_UPPER(new_type) && OVL_TYPE_UPPER(old_type)) {
774 if (ovl_dentry_upper(old)->d_inode ==
775 ovl_dentry_upper(new)->d_inode)
779 if (ovl_dentry_is_opaque(new))
780 new_type = __OVL_PATH_UPPER;
782 new_type = __OVL_PATH_UPPER | __OVL_PATH_PURE;
785 err = ovl_want_write(old);
789 err = ovl_copy_up(old);
793 err = ovl_copy_up(new->d_parent);
797 err = ovl_copy_up(new);
802 old_opaque = !OVL_TYPE_PURE_UPPER(old_type);
803 new_opaque = !OVL_TYPE_PURE_UPPER(new_type);
805 old_cred = ovl_override_creds(old->d_sb);
807 if (overwrite && OVL_TYPE_MERGE_OR_LOWER(new_type) && new_is_dir) {
808 opaquedir = ovl_check_empty_and_clear(new);
809 err = PTR_ERR(opaquedir);
810 if (IS_ERR(opaquedir)) {
812 goto out_revert_creds;
818 if (new->d_inode || !new_opaque) {
819 /* Whiteout source */
820 flags |= RENAME_WHITEOUT;
822 /* Switch whiteouts */
823 flags |= RENAME_EXCHANGE;
825 } else if (is_dir && !new->d_inode && new_opaque) {
826 flags |= RENAME_EXCHANGE;
827 cleanup_whiteout = true;
831 old_upperdir = ovl_dentry_upper(old->d_parent);
832 new_upperdir = ovl_dentry_upper(new->d_parent);
834 trap = lock_rename(new_upperdir, old_upperdir);
837 olddentry = lookup_one_len(old->d_name.name, old_upperdir,
839 err = PTR_ERR(olddentry);
840 if (IS_ERR(olddentry))
844 if (olddentry != ovl_dentry_upper(old))
847 newdentry = lookup_one_len(new->d_name.name, new_upperdir,
849 err = PTR_ERR(newdentry);
850 if (IS_ERR(newdentry))
854 if (ovl_dentry_upper(new)) {
856 if (newdentry != opaquedir)
859 if (newdentry != ovl_dentry_upper(new))
863 if (!d_is_negative(newdentry) &&
864 (!new_opaque || !ovl_is_whiteout(newdentry)))
868 if (olddentry == trap)
870 if (newdentry == trap)
873 if (is_dir && !old_opaque && new_opaque) {
874 err = ovl_set_opaque(olddentry);
878 if (!overwrite && new_is_dir && old_opaque && !new_opaque) {
879 err = ovl_set_opaque(newdentry);
884 if (old_opaque || new_opaque) {
885 err = ovl_do_rename(old_upperdir->d_inode, olddentry,
886 new_upperdir->d_inode, newdentry,
889 /* No debug for the plain case */
890 BUG_ON(flags & ~RENAME_EXCHANGE);
891 err = vfs_rename(old_upperdir->d_inode, olddentry,
892 new_upperdir->d_inode, newdentry,
897 if (is_dir && !old_opaque && new_opaque)
898 ovl_remove_opaque(olddentry);
899 if (!overwrite && new_is_dir && old_opaque && !new_opaque)
900 ovl_remove_opaque(newdentry);
904 if (is_dir && old_opaque && !new_opaque)
905 ovl_remove_opaque(olddentry);
906 if (!overwrite && new_is_dir && !old_opaque && new_opaque)
907 ovl_remove_opaque(newdentry);
910 * Old dentry now lives in different location. Dentries in
911 * lowerstack are stale. We cannot drop them here because
912 * access to them is lockless. This could be only pure upper
913 * or opaque directory - numlower is zero. Or upper non-dir
914 * entry - its pureness is tracked by flag opaque.
916 if (old_opaque != new_opaque) {
917 ovl_dentry_set_opaque(old, new_opaque);
919 ovl_dentry_set_opaque(new, old_opaque);
922 if (cleanup_whiteout)
923 ovl_cleanup(old_upperdir->d_inode, newdentry);
925 ovl_dentry_version_inc(old->d_parent);
926 ovl_dentry_version_inc(new->d_parent);
933 unlock_rename(new_upperdir, old_upperdir);
935 revert_creds(old_cred);
943 const struct inode_operations ovl_dir_inode_operations = {
944 .lookup = ovl_lookup,
946 .symlink = ovl_symlink,
947 .unlink = ovl_unlink,
949 .rename2 = ovl_rename2,
951 .setattr = ovl_setattr,
952 .create = ovl_create,
954 .permission = ovl_permission,
955 .getattr = ovl_dir_getattr,
956 .setxattr = ovl_setxattr,
957 .getxattr = ovl_getxattr,
958 .listxattr = ovl_listxattr,
959 .removexattr = ovl_removexattr,
960 .get_acl = ovl_get_acl,
961 .update_time = ovl_update_time,