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/module.h>
16 #include <linux/posix_acl.h>
17 #include <linux/posix_acl_xattr.h>
18 #include <linux/atomic.h>
19 #include <linux/ratelimit.h>
20 #include "overlayfs.h"
22 static unsigned short ovl_redirect_max = 256;
23 module_param_named(redirect_max, ovl_redirect_max, ushort, 0644);
24 MODULE_PARM_DESC(ovl_redirect_max,
25 "Maximum length of absolute redirect xattr value");
27 void ovl_cleanup(struct inode *wdir, struct dentry *wdentry)
32 if (d_is_dir(wdentry))
33 err = ovl_do_rmdir(wdir, wdentry);
35 err = ovl_do_unlink(wdir, wdentry);
39 pr_err("overlayfs: cleanup of '%pd2' failed (%i)\n",
44 struct dentry *ovl_lookup_temp(struct dentry *workdir, struct dentry *dentry)
48 static atomic_t temp_id = ATOMIC_INIT(0);
50 /* counter is allowed to wrap, since temp dentries are ephemeral */
51 snprintf(name, sizeof(name), "#%x", atomic_inc_return(&temp_id));
53 temp = lookup_one_len(name, workdir, strlen(name));
54 if (!IS_ERR(temp) && temp->d_inode) {
55 pr_err("overlayfs: workdir/%s already exists\n", name);
63 /* caller holds i_mutex on workdir */
64 static struct dentry *ovl_whiteout(struct dentry *workdir,
65 struct dentry *dentry)
68 struct dentry *whiteout;
69 struct inode *wdir = workdir->d_inode;
71 whiteout = ovl_lookup_temp(workdir, dentry);
75 err = ovl_do_whiteout(wdir, whiteout);
78 whiteout = ERR_PTR(err);
84 int ovl_create_real(struct inode *dir, struct dentry *newdentry,
85 struct cattr *attr, struct dentry *hardlink, bool debug)
89 if (newdentry->d_inode)
93 err = ovl_do_link(hardlink, dir, newdentry, debug);
95 switch (attr->mode & S_IFMT) {
97 err = ovl_do_create(dir, newdentry, attr->mode, debug);
101 err = ovl_do_mkdir(dir, newdentry, attr->mode, debug);
108 err = ovl_do_mknod(dir, newdentry,
109 attr->mode, attr->rdev, debug);
113 err = ovl_do_symlink(dir, newdentry, attr->link, debug);
120 if (!err && WARN_ON(!newdentry->d_inode)) {
122 * Not quite sure if non-instantiated dentry is legal or not.
123 * VFS doesn't seem to care so check and warn here.
130 static int ovl_set_opaque(struct dentry *dentry, struct dentry *upperdentry)
134 err = ovl_do_setxattr(upperdentry, OVL_XATTR_OPAQUE, "y", 1, 0);
136 ovl_dentry_set_opaque(dentry);
141 /* Common operations required to be done after creation of file on upper */
142 static void ovl_instantiate(struct dentry *dentry, struct inode *inode,
143 struct dentry *newdentry, bool hardlink)
145 ovl_dentry_version_inc(dentry->d_parent);
146 ovl_dentry_update(dentry, newdentry);
148 ovl_inode_update(inode, d_inode(newdentry));
149 ovl_copyattr(newdentry->d_inode, inode);
151 WARN_ON(ovl_inode_real(inode, NULL) != d_inode(newdentry));
154 d_instantiate(dentry, inode);
157 static bool ovl_type_merge(struct dentry *dentry)
159 return OVL_TYPE_MERGE(ovl_path_type(dentry));
162 static int ovl_create_upper(struct dentry *dentry, struct inode *inode,
163 struct cattr *attr, struct dentry *hardlink)
165 struct dentry *upperdir = ovl_dentry_upper(dentry->d_parent);
166 struct inode *udir = upperdir->d_inode;
167 struct dentry *newdentry;
170 if (!hardlink && !IS_POSIXACL(udir))
171 attr->mode &= ~current_umask();
173 inode_lock_nested(udir, I_MUTEX_PARENT);
174 newdentry = lookup_one_len(dentry->d_name.name, upperdir,
176 err = PTR_ERR(newdentry);
177 if (IS_ERR(newdentry))
179 err = ovl_create_real(udir, newdentry, attr, hardlink, false);
183 if (ovl_type_merge(dentry->d_parent) && d_is_dir(newdentry)) {
184 /* Setting opaque here is just an optimization, allow to fail */
185 ovl_set_opaque(dentry, newdentry);
188 ovl_instantiate(dentry, inode, newdentry, !!hardlink);
197 static int ovl_lock_rename_workdir(struct dentry *workdir,
198 struct dentry *upperdir)
200 /* Workdir should not be the same as upperdir */
201 if (workdir == upperdir)
204 /* Workdir should not be subdir of upperdir and vice versa */
205 if (lock_rename(workdir, upperdir) != NULL)
211 unlock_rename(workdir, upperdir);
213 pr_err("overlayfs: failed to lock workdir+upperdir\n");
217 static struct dentry *ovl_clear_empty(struct dentry *dentry,
218 struct list_head *list)
220 struct dentry *workdir = ovl_workdir(dentry);
221 struct inode *wdir = workdir->d_inode;
222 struct dentry *upperdir = ovl_dentry_upper(dentry->d_parent);
223 struct inode *udir = upperdir->d_inode;
224 struct path upperpath;
225 struct dentry *upper;
226 struct dentry *opaquedir;
230 if (WARN_ON(!workdir))
231 return ERR_PTR(-EROFS);
233 err = ovl_lock_rename_workdir(workdir, upperdir);
237 ovl_path_upper(dentry, &upperpath);
238 err = vfs_getattr(&upperpath, &stat,
239 STATX_BASIC_STATS, AT_STATX_SYNC_AS_STAT);
244 if (!S_ISDIR(stat.mode))
246 upper = upperpath.dentry;
247 if (upper->d_parent->d_inode != udir)
250 opaquedir = ovl_lookup_temp(workdir, dentry);
251 err = PTR_ERR(opaquedir);
252 if (IS_ERR(opaquedir))
255 err = ovl_create_real(wdir, opaquedir,
256 &(struct cattr){.mode = stat.mode}, NULL, true);
260 err = ovl_copy_xattr(upper, opaquedir);
264 err = ovl_set_opaque(dentry, opaquedir);
268 inode_lock(opaquedir->d_inode);
269 err = ovl_set_attr(opaquedir, &stat);
270 inode_unlock(opaquedir->d_inode);
274 err = ovl_do_rename(wdir, opaquedir, udir, upper, RENAME_EXCHANGE);
278 ovl_cleanup_whiteouts(upper, list);
279 ovl_cleanup(wdir, upper);
280 unlock_rename(workdir, upperdir);
282 /* dentry's upper doesn't match now, get rid of it */
288 ovl_cleanup(wdir, opaquedir);
292 unlock_rename(workdir, upperdir);
297 static struct dentry *ovl_check_empty_and_clear(struct dentry *dentry)
300 struct dentry *ret = NULL;
301 enum ovl_path_type type = ovl_path_type(dentry);
304 err = ovl_check_empty_dir(dentry, &list);
311 * When removing an empty opaque directory, then it makes no sense to
312 * replace it with an exact replica of itself.
314 * If no upperdentry then skip clearing whiteouts.
316 * Can race with copy-up, since we don't hold the upperdir mutex.
317 * Doesn't matter, since copy-up can't create a non-empty directory
320 if (OVL_TYPE_UPPER(type) && OVL_TYPE_MERGE(type))
321 ret = ovl_clear_empty(dentry, &list);
324 ovl_cache_free(&list);
329 static int ovl_set_upper_acl(struct dentry *upperdentry, const char *name,
330 const struct posix_acl *acl)
336 if (!IS_ENABLED(CONFIG_FS_POSIX_ACL) || !acl)
339 size = posix_acl_to_xattr(NULL, acl, NULL, 0);
340 buffer = kmalloc(size, GFP_KERNEL);
344 size = posix_acl_to_xattr(&init_user_ns, acl, buffer, size);
349 err = vfs_setxattr(upperdentry, name, buffer, size, XATTR_CREATE);
355 static int ovl_create_over_whiteout(struct dentry *dentry, struct inode *inode,
357 struct dentry *hardlink)
359 struct dentry *workdir = ovl_workdir(dentry);
360 struct inode *wdir = workdir->d_inode;
361 struct dentry *upperdir = ovl_dentry_upper(dentry->d_parent);
362 struct inode *udir = upperdir->d_inode;
363 struct dentry *upper;
364 struct dentry *newdentry;
366 struct posix_acl *acl, *default_acl;
368 if (WARN_ON(!workdir))
372 err = posix_acl_create(dentry->d_parent->d_inode,
373 &cattr->mode, &default_acl, &acl);
378 err = ovl_lock_rename_workdir(workdir, upperdir);
382 newdentry = ovl_lookup_temp(workdir, dentry);
383 err = PTR_ERR(newdentry);
384 if (IS_ERR(newdentry))
387 upper = lookup_one_len(dentry->d_name.name, upperdir,
389 err = PTR_ERR(upper);
393 err = ovl_create_real(wdir, newdentry, cattr, hardlink, true);
398 * mode could have been mutilated due to umask (e.g. sgid directory)
401 !S_ISLNK(cattr->mode) &&
402 newdentry->d_inode->i_mode != cattr->mode) {
403 struct iattr attr = {
404 .ia_valid = ATTR_MODE,
405 .ia_mode = cattr->mode,
407 inode_lock(newdentry->d_inode);
408 err = notify_change(newdentry, &attr, NULL);
409 inode_unlock(newdentry->d_inode);
414 err = ovl_set_upper_acl(newdentry, XATTR_NAME_POSIX_ACL_ACCESS,
419 err = ovl_set_upper_acl(newdentry, XATTR_NAME_POSIX_ACL_DEFAULT,
425 if (!hardlink && S_ISDIR(cattr->mode)) {
426 err = ovl_set_opaque(dentry, newdentry);
430 err = ovl_do_rename(wdir, newdentry, udir, upper,
435 ovl_cleanup(wdir, upper);
437 err = ovl_do_rename(wdir, newdentry, udir, upper, 0);
441 ovl_instantiate(dentry, inode, newdentry, !!hardlink);
448 unlock_rename(workdir, upperdir);
451 posix_acl_release(acl);
452 posix_acl_release(default_acl);
457 ovl_cleanup(wdir, newdentry);
461 static int ovl_create_or_link(struct dentry *dentry, struct inode *inode,
462 struct cattr *attr, struct dentry *hardlink)
465 const struct cred *old_cred;
466 struct cred *override_cred;
468 err = ovl_copy_up(dentry->d_parent);
472 old_cred = ovl_override_creds(dentry->d_sb);
474 override_cred = prepare_creds();
476 override_cred->fsuid = inode->i_uid;
477 override_cred->fsgid = inode->i_gid;
479 err = security_dentry_create_files_as(dentry,
480 attr->mode, &dentry->d_name, old_cred,
483 put_cred(override_cred);
484 goto out_revert_creds;
487 put_cred(override_creds(override_cred));
488 put_cred(override_cred);
490 if (!ovl_dentry_is_whiteout(dentry))
491 err = ovl_create_upper(dentry, inode, attr,
494 err = ovl_create_over_whiteout(dentry, inode, attr,
498 revert_creds(old_cred);
500 struct inode *realinode = d_inode(ovl_dentry_upper(dentry));
502 WARN_ON(inode->i_mode != realinode->i_mode);
503 WARN_ON(!uid_eq(inode->i_uid, realinode->i_uid));
504 WARN_ON(!gid_eq(inode->i_gid, realinode->i_gid));
509 static int ovl_create_object(struct dentry *dentry, int mode, dev_t rdev,
514 struct cattr attr = {
519 err = ovl_want_write(dentry);
524 inode = ovl_new_inode(dentry->d_sb, mode, rdev);
528 inode_init_owner(inode, dentry->d_parent->d_inode, mode);
529 attr.mode = inode->i_mode;
531 err = ovl_create_or_link(dentry, inode, &attr, NULL);
536 ovl_drop_write(dentry);
541 static int ovl_create(struct inode *dir, struct dentry *dentry, umode_t mode,
544 return ovl_create_object(dentry, (mode & 07777) | S_IFREG, 0, NULL);
547 static int ovl_mkdir(struct inode *dir, struct dentry *dentry, umode_t mode)
549 return ovl_create_object(dentry, (mode & 07777) | S_IFDIR, 0, NULL);
552 static int ovl_mknod(struct inode *dir, struct dentry *dentry, umode_t mode,
555 /* Don't allow creation of "whiteout" on overlay */
556 if (S_ISCHR(mode) && rdev == WHITEOUT_DEV)
559 return ovl_create_object(dentry, mode, rdev, NULL);
562 static int ovl_symlink(struct inode *dir, struct dentry *dentry,
565 return ovl_create_object(dentry, S_IFLNK, 0, link);
568 static int ovl_link(struct dentry *old, struct inode *newdir,
574 err = ovl_want_write(old);
578 err = ovl_copy_up(old);
582 inode = d_inode(old);
585 err = ovl_create_or_link(new, inode, NULL, ovl_dentry_upper(old));
595 static int ovl_remove_and_whiteout(struct dentry *dentry, bool is_dir)
597 struct dentry *workdir = ovl_workdir(dentry);
598 struct inode *wdir = workdir->d_inode;
599 struct dentry *upperdir = ovl_dentry_upper(dentry->d_parent);
600 struct inode *udir = upperdir->d_inode;
601 struct dentry *whiteout;
602 struct dentry *upper;
603 struct dentry *opaquedir = NULL;
607 if (WARN_ON(!workdir))
611 opaquedir = ovl_check_empty_and_clear(dentry);
612 err = PTR_ERR(opaquedir);
613 if (IS_ERR(opaquedir))
617 err = ovl_lock_rename_workdir(workdir, upperdir);
621 upper = lookup_one_len(dentry->d_name.name, upperdir,
623 err = PTR_ERR(upper);
628 if ((opaquedir && upper != opaquedir) ||
629 (!opaquedir && ovl_dentry_upper(dentry) &&
630 upper != ovl_dentry_upper(dentry))) {
634 whiteout = ovl_whiteout(workdir, dentry);
635 err = PTR_ERR(whiteout);
636 if (IS_ERR(whiteout))
640 flags = RENAME_EXCHANGE;
642 err = ovl_do_rename(wdir, whiteout, udir, upper, flags);
646 ovl_cleanup(wdir, upper);
648 ovl_dentry_version_inc(dentry->d_parent);
655 unlock_rename(workdir, upperdir);
662 ovl_cleanup(wdir, whiteout);
666 static int ovl_remove_upper(struct dentry *dentry, bool is_dir)
668 struct dentry *upperdir = ovl_dentry_upper(dentry->d_parent);
669 struct inode *dir = upperdir->d_inode;
670 struct dentry *upper;
671 struct dentry *opaquedir = NULL;
674 /* Redirect dir can be !ovl_lower_positive && OVL_TYPE_MERGE */
675 if (is_dir && ovl_dentry_get_redirect(dentry)) {
676 opaquedir = ovl_check_empty_and_clear(dentry);
677 err = PTR_ERR(opaquedir);
678 if (IS_ERR(opaquedir))
682 inode_lock_nested(dir, I_MUTEX_PARENT);
683 upper = lookup_one_len(dentry->d_name.name, upperdir,
685 err = PTR_ERR(upper);
690 if ((opaquedir && upper != opaquedir) ||
691 (!opaquedir && upper != ovl_dentry_upper(dentry)))
695 err = vfs_rmdir(dir, upper);
697 err = vfs_unlink(dir, upper, NULL);
698 ovl_dentry_version_inc(dentry->d_parent);
701 * Keeping this dentry hashed would mean having to release
702 * upperpath/lowerpath, which could only be done if we are the
703 * sole user of this dentry. Too tricky... Just unhash for
717 static int ovl_do_remove(struct dentry *dentry, bool is_dir)
719 enum ovl_path_type type;
721 const struct cred *old_cred;
723 err = ovl_want_write(dentry);
727 err = ovl_copy_up(dentry->d_parent);
731 type = ovl_path_type(dentry);
733 old_cred = ovl_override_creds(dentry->d_sb);
734 if (!ovl_lower_positive(dentry))
735 err = ovl_remove_upper(dentry, is_dir);
737 err = ovl_remove_and_whiteout(dentry, is_dir);
738 revert_creds(old_cred);
741 clear_nlink(dentry->d_inode);
743 drop_nlink(dentry->d_inode);
746 ovl_drop_write(dentry);
751 static int ovl_unlink(struct inode *dir, struct dentry *dentry)
753 return ovl_do_remove(dentry, false);
756 static int ovl_rmdir(struct inode *dir, struct dentry *dentry)
758 return ovl_do_remove(dentry, true);
761 static bool ovl_type_merge_or_lower(struct dentry *dentry)
763 enum ovl_path_type type = ovl_path_type(dentry);
765 return OVL_TYPE_MERGE(type) || !OVL_TYPE_UPPER(type);
768 static bool ovl_can_move(struct dentry *dentry)
770 return ovl_redirect_dir(dentry->d_sb) ||
771 !d_is_dir(dentry) || !ovl_type_merge_or_lower(dentry);
774 static char *ovl_get_redirect(struct dentry *dentry, bool samedir)
777 struct dentry *d, *tmp;
778 int buflen = ovl_redirect_max + 1;
781 ret = kstrndup(dentry->d_name.name, dentry->d_name.len,
786 buf = ret = kmalloc(buflen, GFP_TEMPORARY);
792 for (d = dget(dentry); !IS_ROOT(d);) {
796 spin_lock(&d->d_lock);
797 name = ovl_dentry_get_redirect(d);
799 thislen = strlen(name);
801 name = d->d_name.name;
802 thislen = d->d_name.len;
805 /* If path is too long, fall back to userspace move */
806 if (thislen + (name[0] != '/') > buflen) {
807 ret = ERR_PTR(-EXDEV);
808 spin_unlock(&d->d_lock);
813 memcpy(&buf[buflen], name, thislen);
814 tmp = dget_dlock(d->d_parent);
815 spin_unlock(&d->d_lock);
820 /* Absolute redirect: finished */
821 if (buf[buflen] == '/')
826 ret = kstrdup(&buf[buflen], GFP_KERNEL);
831 return ret ? ret : ERR_PTR(-ENOMEM);
834 static int ovl_set_redirect(struct dentry *dentry, bool samedir)
837 const char *redirect = ovl_dentry_get_redirect(dentry);
839 if (redirect && (samedir || redirect[0] == '/'))
842 redirect = ovl_get_redirect(dentry, samedir);
843 if (IS_ERR(redirect))
844 return PTR_ERR(redirect);
846 err = ovl_do_setxattr(ovl_dentry_upper(dentry), OVL_XATTR_REDIRECT,
847 redirect, strlen(redirect), 0);
849 spin_lock(&dentry->d_lock);
850 ovl_dentry_set_redirect(dentry, redirect);
851 spin_unlock(&dentry->d_lock);
854 if (err == -EOPNOTSUPP)
855 ovl_clear_redirect_dir(dentry->d_sb);
857 pr_warn_ratelimited("overlay: failed to set redirect (%i)\n", err);
858 /* Fall back to userspace copy-up */
864 static int ovl_rename(struct inode *olddir, struct dentry *old,
865 struct inode *newdir, struct dentry *new,
869 struct dentry *old_upperdir;
870 struct dentry *new_upperdir;
871 struct dentry *olddentry;
872 struct dentry *newdentry;
876 bool cleanup_whiteout = false;
877 bool overwrite = !(flags & RENAME_EXCHANGE);
878 bool is_dir = d_is_dir(old);
879 bool new_is_dir = d_is_dir(new);
880 bool samedir = olddir == newdir;
881 struct dentry *opaquedir = NULL;
882 const struct cred *old_cred = NULL;
885 if (flags & ~(RENAME_EXCHANGE | RENAME_NOREPLACE))
888 flags &= ~RENAME_NOREPLACE;
890 /* Don't copy up directory trees */
892 if (!ovl_can_move(old))
894 if (!overwrite && !ovl_can_move(new))
897 err = ovl_want_write(old);
901 err = ovl_copy_up(old);
905 err = ovl_copy_up(new->d_parent);
909 err = ovl_copy_up(new);
914 old_cred = ovl_override_creds(old->d_sb);
916 if (overwrite && new_is_dir && ovl_type_merge_or_lower(new)) {
917 opaquedir = ovl_check_empty_and_clear(new);
918 err = PTR_ERR(opaquedir);
919 if (IS_ERR(opaquedir)) {
921 goto out_revert_creds;
926 if (ovl_lower_positive(old)) {
927 if (!ovl_dentry_is_whiteout(new)) {
928 /* Whiteout source */
929 flags |= RENAME_WHITEOUT;
931 /* Switch whiteouts */
932 flags |= RENAME_EXCHANGE;
934 } else if (is_dir && ovl_dentry_is_whiteout(new)) {
935 flags |= RENAME_EXCHANGE;
936 cleanup_whiteout = true;
940 old_upperdir = ovl_dentry_upper(old->d_parent);
941 new_upperdir = ovl_dentry_upper(new->d_parent);
943 trap = lock_rename(new_upperdir, old_upperdir);
945 olddentry = lookup_one_len(old->d_name.name, old_upperdir,
947 err = PTR_ERR(olddentry);
948 if (IS_ERR(olddentry))
952 if (olddentry != ovl_dentry_upper(old))
955 newdentry = lookup_one_len(new->d_name.name, new_upperdir,
957 err = PTR_ERR(newdentry);
958 if (IS_ERR(newdentry))
961 old_opaque = ovl_dentry_is_opaque(old);
962 new_opaque = ovl_dentry_is_opaque(new);
965 if (ovl_dentry_upper(new)) {
967 if (newdentry != opaquedir)
970 if (newdentry != ovl_dentry_upper(new))
974 if (!d_is_negative(newdentry) &&
975 (!new_opaque || !ovl_is_whiteout(newdentry)))
979 if (olddentry == trap)
981 if (newdentry == trap)
984 if (WARN_ON(olddentry->d_inode == newdentry->d_inode))
989 if (ovl_type_merge_or_lower(old))
990 err = ovl_set_redirect(old, samedir);
991 else if (!old_opaque && ovl_type_merge(new->d_parent))
992 err = ovl_set_opaque(old, olddentry);
996 if (!overwrite && new_is_dir) {
997 if (ovl_type_merge_or_lower(new))
998 err = ovl_set_redirect(new, samedir);
999 else if (!new_opaque && ovl_type_merge(old->d_parent))
1000 err = ovl_set_opaque(new, newdentry);
1005 err = ovl_do_rename(old_upperdir->d_inode, olddentry,
1006 new_upperdir->d_inode, newdentry, flags);
1010 if (cleanup_whiteout)
1011 ovl_cleanup(old_upperdir->d_inode, newdentry);
1013 ovl_dentry_version_inc(old->d_parent);
1014 ovl_dentry_version_inc(new->d_parent);
1021 unlock_rename(new_upperdir, old_upperdir);
1023 revert_creds(old_cred);
1025 ovl_drop_write(old);
1031 const struct inode_operations ovl_dir_inode_operations = {
1032 .lookup = ovl_lookup,
1034 .symlink = ovl_symlink,
1035 .unlink = ovl_unlink,
1037 .rename = ovl_rename,
1039 .setattr = ovl_setattr,
1040 .create = ovl_create,
1042 .permission = ovl_permission,
1043 .getattr = ovl_getattr,
1044 .listxattr = ovl_listxattr,
1045 .get_acl = ovl_get_acl,
1046 .update_time = ovl_update_time,