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 <linux/posix_acl.h>
16 #include <linux/posix_acl_xattr.h>
17 #include <linux/atomic.h>
18 #include <linux/ratelimit.h>
19 #include "overlayfs.h"
21 void ovl_cleanup(struct inode *wdir, struct dentry *wdentry)
26 if (d_is_dir(wdentry))
27 err = ovl_do_rmdir(wdir, wdentry);
29 err = ovl_do_unlink(wdir, wdentry);
33 pr_err("overlayfs: cleanup of '%pd2' failed (%i)\n",
38 struct dentry *ovl_lookup_temp(struct dentry *workdir, struct dentry *dentry)
42 static atomic_t temp_id = ATOMIC_INIT(0);
44 /* counter is allowed to wrap, since temp dentries are ephemeral */
45 snprintf(name, sizeof(name), "#%x", atomic_inc_return(&temp_id));
47 temp = lookup_one_len(name, workdir, strlen(name));
48 if (!IS_ERR(temp) && temp->d_inode) {
49 pr_err("overlayfs: workdir/%s already exists\n", name);
57 /* caller holds i_mutex on workdir */
58 static struct dentry *ovl_whiteout(struct dentry *workdir,
59 struct dentry *dentry)
62 struct dentry *whiteout;
63 struct inode *wdir = workdir->d_inode;
65 whiteout = ovl_lookup_temp(workdir, dentry);
69 err = ovl_do_whiteout(wdir, whiteout);
72 whiteout = ERR_PTR(err);
78 int ovl_create_real(struct inode *dir, struct dentry *newdentry,
79 struct kstat *stat, const char *link,
80 struct dentry *hardlink, bool debug)
84 if (newdentry->d_inode)
88 err = ovl_do_link(hardlink, dir, newdentry, debug);
90 switch (stat->mode & S_IFMT) {
92 err = ovl_do_create(dir, newdentry, stat->mode, debug);
96 err = ovl_do_mkdir(dir, newdentry, stat->mode, debug);
103 err = ovl_do_mknod(dir, newdentry,
104 stat->mode, stat->rdev, debug);
108 err = ovl_do_symlink(dir, newdentry, link, debug);
115 if (!err && WARN_ON(!newdentry->d_inode)) {
117 * Not quite sure if non-instantiated dentry is legal or not.
118 * VFS doesn't seem to care so check and warn here.
125 static int ovl_set_opaque(struct dentry *upperdentry)
127 return ovl_do_setxattr(upperdentry, OVL_XATTR_OPAQUE, "y", 1, 0);
130 static int ovl_dir_getattr(struct vfsmount *mnt, struct dentry *dentry,
134 enum ovl_path_type type;
135 struct path realpath;
136 const struct cred *old_cred;
138 type = ovl_path_real(dentry, &realpath);
139 old_cred = ovl_override_creds(dentry->d_sb);
140 err = vfs_getattr(&realpath, stat);
141 revert_creds(old_cred);
145 stat->dev = dentry->d_sb->s_dev;
146 stat->ino = dentry->d_inode->i_ino;
149 * It's probably not worth it to count subdirs to get the
150 * correct link count. nlink=1 seems to pacify 'find' and
153 if (OVL_TYPE_MERGE(type))
159 /* Common operations required to be done after creation of file on upper */
160 static void ovl_instantiate(struct dentry *dentry, struct inode *inode,
161 struct dentry *newdentry, bool hardlink)
163 ovl_dentry_version_inc(dentry->d_parent);
164 ovl_dentry_update(dentry, newdentry);
166 ovl_inode_update(inode, d_inode(newdentry));
167 ovl_copyattr(newdentry->d_inode, inode);
169 WARN_ON(ovl_inode_real(inode, NULL) != d_inode(newdentry));
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 if (!hardlink && !IS_POSIXACL(udir))
185 stat->mode &= ~current_umask();
187 inode_lock_nested(udir, I_MUTEX_PARENT);
188 newdentry = lookup_one_len(dentry->d_name.name, upperdir,
190 err = PTR_ERR(newdentry);
191 if (IS_ERR(newdentry))
193 err = ovl_create_real(udir, newdentry, stat, link, hardlink, false);
197 ovl_instantiate(dentry, inode, newdentry, !!hardlink);
206 static int ovl_lock_rename_workdir(struct dentry *workdir,
207 struct dentry *upperdir)
209 /* Workdir should not be the same as upperdir */
210 if (workdir == upperdir)
213 /* Workdir should not be subdir of upperdir and vice versa */
214 if (lock_rename(workdir, upperdir) != NULL)
220 unlock_rename(workdir, upperdir);
222 pr_err("overlayfs: failed to lock workdir+upperdir\n");
226 static struct dentry *ovl_clear_empty(struct dentry *dentry,
227 struct list_head *list)
229 struct dentry *workdir = ovl_workdir(dentry);
230 struct inode *wdir = workdir->d_inode;
231 struct dentry *upperdir = ovl_dentry_upper(dentry->d_parent);
232 struct inode *udir = upperdir->d_inode;
233 struct path upperpath;
234 struct dentry *upper;
235 struct dentry *opaquedir;
239 if (WARN_ON(!workdir))
240 return ERR_PTR(-EROFS);
242 err = ovl_lock_rename_workdir(workdir, upperdir);
246 ovl_path_upper(dentry, &upperpath);
247 err = vfs_getattr(&upperpath, &stat);
252 if (!S_ISDIR(stat.mode))
254 upper = upperpath.dentry;
255 if (upper->d_parent->d_inode != udir)
258 opaquedir = ovl_lookup_temp(workdir, dentry);
259 err = PTR_ERR(opaquedir);
260 if (IS_ERR(opaquedir))
263 err = ovl_create_real(wdir, opaquedir, &stat, NULL, NULL, true);
267 err = ovl_copy_xattr(upper, opaquedir);
271 err = ovl_set_opaque(opaquedir);
275 inode_lock(opaquedir->d_inode);
276 err = ovl_set_attr(opaquedir, &stat);
277 inode_unlock(opaquedir->d_inode);
281 err = ovl_do_rename(wdir, opaquedir, udir, upper, RENAME_EXCHANGE);
285 ovl_cleanup_whiteouts(upper, list);
286 ovl_cleanup(wdir, upper);
287 unlock_rename(workdir, upperdir);
289 /* dentry's upper doesn't match now, get rid of it */
295 ovl_cleanup(wdir, opaquedir);
299 unlock_rename(workdir, upperdir);
304 static struct dentry *ovl_check_empty_and_clear(struct dentry *dentry)
307 struct dentry *ret = NULL;
308 enum ovl_path_type type = ovl_path_type(dentry);
311 err = ovl_check_empty_dir(dentry, &list);
318 * When removing an empty opaque directory, then it makes no sense to
319 * replace it with an exact replica of itself.
321 * If no upperdentry then skip clearing whiteouts.
323 * Can race with copy-up, since we don't hold the upperdir mutex.
324 * Doesn't matter, since copy-up can't create a non-empty directory
327 if (OVL_TYPE_UPPER(type) && OVL_TYPE_MERGE(type))
328 ret = ovl_clear_empty(dentry, &list);
331 ovl_cache_free(&list);
336 static int ovl_set_upper_acl(struct dentry *upperdentry, const char *name,
337 const struct posix_acl *acl)
343 if (!IS_ENABLED(CONFIG_FS_POSIX_ACL) || !acl)
346 size = posix_acl_to_xattr(NULL, acl, NULL, 0);
347 buffer = kmalloc(size, GFP_KERNEL);
351 size = posix_acl_to_xattr(&init_user_ns, acl, buffer, size);
356 err = vfs_setxattr(upperdentry, name, buffer, size, XATTR_CREATE);
362 static int ovl_create_over_whiteout(struct dentry *dentry, struct inode *inode,
363 struct kstat *stat, const char *link,
364 struct dentry *hardlink)
366 struct dentry *workdir = ovl_workdir(dentry);
367 struct inode *wdir = workdir->d_inode;
368 struct dentry *upperdir = ovl_dentry_upper(dentry->d_parent);
369 struct inode *udir = upperdir->d_inode;
370 struct dentry *upper;
371 struct dentry *newdentry;
373 struct posix_acl *acl, *default_acl;
375 if (WARN_ON(!workdir))
379 err = posix_acl_create(dentry->d_parent->d_inode,
380 &stat->mode, &default_acl, &acl);
385 err = ovl_lock_rename_workdir(workdir, upperdir);
389 newdentry = ovl_lookup_temp(workdir, dentry);
390 err = PTR_ERR(newdentry);
391 if (IS_ERR(newdentry))
394 upper = lookup_one_len(dentry->d_name.name, upperdir,
396 err = PTR_ERR(upper);
400 err = ovl_create_real(wdir, newdentry, stat, link, hardlink, true);
405 * mode could have been mutilated due to umask (e.g. sgid directory)
408 !S_ISLNK(stat->mode) && newdentry->d_inode->i_mode != stat->mode) {
409 struct iattr attr = {
410 .ia_valid = ATTR_MODE,
411 .ia_mode = stat->mode,
413 inode_lock(newdentry->d_inode);
414 err = notify_change(newdentry, &attr, NULL);
415 inode_unlock(newdentry->d_inode);
420 err = ovl_set_upper_acl(newdentry, XATTR_NAME_POSIX_ACL_ACCESS,
425 err = ovl_set_upper_acl(newdentry, XATTR_NAME_POSIX_ACL_DEFAULT,
431 if (!hardlink && S_ISDIR(stat->mode)) {
432 err = ovl_set_opaque(newdentry);
436 err = ovl_do_rename(wdir, newdentry, udir, upper,
441 ovl_cleanup(wdir, upper);
443 err = ovl_do_rename(wdir, newdentry, udir, upper, 0);
447 ovl_instantiate(dentry, inode, newdentry, !!hardlink);
454 unlock_rename(workdir, upperdir);
457 posix_acl_release(acl);
458 posix_acl_release(default_acl);
463 ovl_cleanup(wdir, newdentry);
467 static int ovl_create_or_link(struct dentry *dentry, struct inode *inode,
468 struct kstat *stat, const char *link,
469 struct dentry *hardlink)
472 const struct cred *old_cred;
473 struct cred *override_cred;
475 err = ovl_copy_up(dentry->d_parent);
479 old_cred = ovl_override_creds(dentry->d_sb);
481 override_cred = prepare_creds();
483 override_cred->fsuid = inode->i_uid;
484 override_cred->fsgid = inode->i_gid;
486 err = security_dentry_create_files_as(dentry,
487 stat->mode, &dentry->d_name, old_cred,
490 put_cred(override_cred);
491 goto out_revert_creds;
494 put_cred(override_creds(override_cred));
495 put_cred(override_cred);
497 if (!ovl_dentry_is_whiteout(dentry))
498 err = ovl_create_upper(dentry, inode, stat, link,
501 err = ovl_create_over_whiteout(dentry, inode, stat,
505 revert_creds(old_cred);
507 struct inode *realinode = d_inode(ovl_dentry_upper(dentry));
509 WARN_ON(inode->i_mode != realinode->i_mode);
510 WARN_ON(!uid_eq(inode->i_uid, realinode->i_uid));
511 WARN_ON(!gid_eq(inode->i_gid, realinode->i_gid));
516 static int ovl_create_object(struct dentry *dentry, int mode, dev_t rdev,
521 struct kstat stat = {
525 err = ovl_want_write(dentry);
530 inode = ovl_new_inode(dentry->d_sb, mode, rdev);
534 inode_init_owner(inode, dentry->d_parent->d_inode, mode);
535 stat.mode = inode->i_mode;
537 err = ovl_create_or_link(dentry, inode, &stat, link, NULL);
542 ovl_drop_write(dentry);
547 static int ovl_create(struct inode *dir, struct dentry *dentry, umode_t mode,
550 return ovl_create_object(dentry, (mode & 07777) | S_IFREG, 0, NULL);
553 static int ovl_mkdir(struct inode *dir, struct dentry *dentry, umode_t mode)
555 return ovl_create_object(dentry, (mode & 07777) | S_IFDIR, 0, NULL);
558 static int ovl_mknod(struct inode *dir, struct dentry *dentry, umode_t mode,
561 /* Don't allow creation of "whiteout" on overlay */
562 if (S_ISCHR(mode) && rdev == WHITEOUT_DEV)
565 return ovl_create_object(dentry, mode, rdev, NULL);
568 static int ovl_symlink(struct inode *dir, struct dentry *dentry,
571 return ovl_create_object(dentry, S_IFLNK, 0, link);
574 static int ovl_link(struct dentry *old, struct inode *newdir,
580 err = ovl_want_write(old);
584 err = ovl_copy_up(old);
588 inode = d_inode(old);
591 err = ovl_create_or_link(new, inode, NULL, NULL, ovl_dentry_upper(old));
601 static int ovl_remove_and_whiteout(struct dentry *dentry, bool is_dir)
603 struct dentry *workdir = ovl_workdir(dentry);
604 struct inode *wdir = workdir->d_inode;
605 struct dentry *upperdir = ovl_dentry_upper(dentry->d_parent);
606 struct inode *udir = upperdir->d_inode;
607 struct dentry *whiteout;
608 struct dentry *upper;
609 struct dentry *opaquedir = NULL;
613 if (WARN_ON(!workdir))
617 opaquedir = ovl_check_empty_and_clear(dentry);
618 err = PTR_ERR(opaquedir);
619 if (IS_ERR(opaquedir))
623 err = ovl_lock_rename_workdir(workdir, upperdir);
627 upper = lookup_one_len(dentry->d_name.name, upperdir,
629 err = PTR_ERR(upper);
634 if ((opaquedir && upper != opaquedir) ||
635 (!opaquedir && ovl_dentry_upper(dentry) &&
636 upper != ovl_dentry_upper(dentry))) {
640 whiteout = ovl_whiteout(workdir, dentry);
641 err = PTR_ERR(whiteout);
642 if (IS_ERR(whiteout))
646 flags = RENAME_EXCHANGE;
648 err = ovl_do_rename(wdir, whiteout, udir, upper, flags);
652 ovl_cleanup(wdir, upper);
654 ovl_dentry_version_inc(dentry->d_parent);
661 unlock_rename(workdir, upperdir);
668 ovl_cleanup(wdir, whiteout);
672 static int ovl_remove_upper(struct dentry *dentry, bool is_dir)
674 struct dentry *upperdir = ovl_dentry_upper(dentry->d_parent);
675 struct inode *dir = upperdir->d_inode;
676 struct dentry *upper;
679 inode_lock_nested(dir, I_MUTEX_PARENT);
680 upper = lookup_one_len(dentry->d_name.name, upperdir,
682 err = PTR_ERR(upper);
687 if (upper == ovl_dentry_upper(dentry)) {
689 err = vfs_rmdir(dir, upper);
691 err = vfs_unlink(dir, upper, NULL);
692 ovl_dentry_version_inc(dentry->d_parent);
697 * Keeping this dentry hashed would mean having to release
698 * upperpath/lowerpath, which could only be done if we are the
699 * sole user of this dentry. Too tricky... Just unhash for
710 static int ovl_do_remove(struct dentry *dentry, bool is_dir)
712 enum ovl_path_type type;
714 const struct cred *old_cred;
716 err = ovl_want_write(dentry);
720 err = ovl_copy_up(dentry->d_parent);
724 type = ovl_path_type(dentry);
726 old_cred = ovl_override_creds(dentry->d_sb);
727 if (!ovl_lower_positive(dentry))
728 err = ovl_remove_upper(dentry, is_dir);
730 err = ovl_remove_and_whiteout(dentry, is_dir);
731 revert_creds(old_cred);
734 clear_nlink(dentry->d_inode);
736 drop_nlink(dentry->d_inode);
739 ovl_drop_write(dentry);
744 static int ovl_unlink(struct inode *dir, struct dentry *dentry)
746 return ovl_do_remove(dentry, false);
749 static int ovl_rmdir(struct inode *dir, struct dentry *dentry)
751 return ovl_do_remove(dentry, true);
754 static bool ovl_type_merge_or_lower(struct dentry *dentry)
756 enum ovl_path_type type = ovl_path_type(dentry);
758 return OVL_TYPE_MERGE(type) || !OVL_TYPE_UPPER(type);
761 static bool ovl_can_move(struct dentry *dentry)
763 return ovl_redirect_dir(dentry->d_sb) ||
764 !d_is_dir(dentry) || !ovl_type_merge_or_lower(dentry);
767 #define OVL_REDIRECT_MAX 256
769 static char *ovl_get_redirect(struct dentry *dentry, bool samedir)
772 struct dentry *d, *tmp;
773 int buflen = OVL_REDIRECT_MAX + 1;
776 ret = kstrndup(dentry->d_name.name, dentry->d_name.len,
781 buf = ret = kmalloc(buflen, GFP_TEMPORARY);
787 for (d = dget(dentry); !IS_ROOT(d);) {
791 spin_lock(&d->d_lock);
792 name = ovl_dentry_get_redirect(d);
794 thislen = strlen(name);
796 name = d->d_name.name;
797 thislen = d->d_name.len;
800 /* If path is too long, fall back to userspace move */
801 if (thislen + (name[0] != '/') > buflen) {
802 ret = ERR_PTR(-EXDEV);
803 spin_unlock(&d->d_lock);
808 memcpy(&buf[buflen], name, thislen);
809 tmp = dget_dlock(d->d_parent);
810 spin_unlock(&d->d_lock);
815 /* Absolute redirect: finished */
816 if (buf[buflen] == '/')
821 ret = kstrdup(&buf[buflen], GFP_KERNEL);
826 return ret ? ret : ERR_PTR(-ENOMEM);
829 static int ovl_set_redirect(struct dentry *dentry, bool samedir)
832 const char *redirect = ovl_dentry_get_redirect(dentry);
834 if (redirect && (samedir || redirect[0] == '/'))
837 redirect = ovl_get_redirect(dentry, samedir);
838 if (IS_ERR(redirect))
839 return PTR_ERR(redirect);
841 err = ovl_do_setxattr(ovl_dentry_upper(dentry), OVL_XATTR_REDIRECT,
842 redirect, strlen(redirect), 0);
844 spin_lock(&dentry->d_lock);
845 ovl_dentry_set_redirect(dentry, redirect);
846 spin_unlock(&dentry->d_lock);
849 if (err == -EOPNOTSUPP)
850 ovl_clear_redirect_dir(dentry->d_sb);
852 pr_warn_ratelimited("overlay: failed to set redirect (%i)\n", err);
853 /* Fall back to userspace copy-up */
859 static int ovl_rename(struct inode *olddir, struct dentry *old,
860 struct inode *newdir, struct dentry *new,
864 struct dentry *old_upperdir;
865 struct dentry *new_upperdir;
866 struct dentry *olddentry;
867 struct dentry *newdentry;
871 bool cleanup_whiteout = false;
872 bool overwrite = !(flags & RENAME_EXCHANGE);
873 bool is_dir = d_is_dir(old);
874 bool new_is_dir = d_is_dir(new);
875 bool samedir = olddir == newdir;
876 struct dentry *opaquedir = NULL;
877 const struct cred *old_cred = NULL;
880 if (flags & ~(RENAME_EXCHANGE | RENAME_NOREPLACE))
883 flags &= ~RENAME_NOREPLACE;
885 /* Don't copy up directory trees */
887 if (!ovl_can_move(old))
889 if (!overwrite && !ovl_can_move(new))
892 err = ovl_want_write(old);
896 err = ovl_copy_up(old);
900 err = ovl_copy_up(new->d_parent);
904 err = ovl_copy_up(new);
909 old_cred = ovl_override_creds(old->d_sb);
911 if (overwrite && new_is_dir && ovl_type_merge_or_lower(new)) {
912 opaquedir = ovl_check_empty_and_clear(new);
913 err = PTR_ERR(opaquedir);
914 if (IS_ERR(opaquedir)) {
916 goto out_revert_creds;
921 if (ovl_lower_positive(old)) {
922 if (!ovl_dentry_is_whiteout(new)) {
923 /* Whiteout source */
924 flags |= RENAME_WHITEOUT;
926 /* Switch whiteouts */
927 flags |= RENAME_EXCHANGE;
929 } else if (is_dir && ovl_dentry_is_whiteout(new)) {
930 flags |= RENAME_EXCHANGE;
931 cleanup_whiteout = true;
935 old_upperdir = ovl_dentry_upper(old->d_parent);
936 new_upperdir = ovl_dentry_upper(new->d_parent);
938 trap = lock_rename(new_upperdir, old_upperdir);
940 olddentry = lookup_one_len(old->d_name.name, old_upperdir,
942 err = PTR_ERR(olddentry);
943 if (IS_ERR(olddentry))
947 if (olddentry != ovl_dentry_upper(old))
950 newdentry = lookup_one_len(new->d_name.name, new_upperdir,
952 err = PTR_ERR(newdentry);
953 if (IS_ERR(newdentry))
956 old_opaque = ovl_dentry_is_opaque(old);
957 new_opaque = ovl_dentry_is_opaque(new);
960 if (ovl_dentry_upper(new)) {
962 if (newdentry != opaquedir)
965 if (newdentry != ovl_dentry_upper(new))
969 if (!d_is_negative(newdentry) &&
970 (!new_opaque || !ovl_is_whiteout(newdentry)))
974 if (olddentry == trap)
976 if (newdentry == trap)
979 if (WARN_ON(olddentry->d_inode == newdentry->d_inode))
983 if (ovl_type_merge_or_lower(old)) {
984 err = ovl_set_redirect(old, samedir);
987 } else if (!old_opaque && ovl_lower_positive(new)) {
988 err = ovl_set_opaque(olddentry);
991 ovl_dentry_set_opaque(old, true);
994 if (!overwrite && new_is_dir) {
995 if (ovl_type_merge_or_lower(new)) {
996 err = ovl_set_redirect(new, samedir);
999 } else if (!new_opaque && ovl_lower_positive(old)) {
1000 err = ovl_set_opaque(newdentry);
1003 ovl_dentry_set_opaque(new, true);
1007 err = ovl_do_rename(old_upperdir->d_inode, olddentry,
1008 new_upperdir->d_inode, newdentry, flags);
1012 if (cleanup_whiteout)
1013 ovl_cleanup(old_upperdir->d_inode, newdentry);
1015 ovl_dentry_version_inc(old->d_parent);
1016 ovl_dentry_version_inc(new->d_parent);
1023 unlock_rename(new_upperdir, old_upperdir);
1025 revert_creds(old_cred);
1027 ovl_drop_write(old);
1033 const struct inode_operations ovl_dir_inode_operations = {
1034 .lookup = ovl_lookup,
1036 .symlink = ovl_symlink,
1037 .unlink = ovl_unlink,
1039 .rename = ovl_rename,
1041 .setattr = ovl_setattr,
1042 .create = ovl_create,
1044 .permission = ovl_permission,
1045 .getattr = ovl_dir_getattr,
1046 .listxattr = ovl_listxattr,
1047 .get_acl = ovl_get_acl,
1048 .update_time = ovl_update_time,