4 * Copyright (C) 1991, 1992 Linus Torvalds
8 * Some corrections by tytso.
11 /* [Feb 1997 T. Schoebel-Theuer] Complete rewrite of the pathname
14 /* [Feb-Apr 2000, AV] Rewrite to the new namespace architecture.
17 #include <linux/init.h>
18 #include <linux/export.h>
19 #include <linux/kernel.h>
20 #include <linux/slab.h>
22 #include <linux/namei.h>
23 #include <linux/pagemap.h>
24 #include <linux/fsnotify.h>
25 #include <linux/personality.h>
26 #include <linux/security.h>
27 #include <linux/ima.h>
28 #include <linux/syscalls.h>
29 #include <linux/mount.h>
30 #include <linux/audit.h>
31 #include <linux/capability.h>
32 #include <linux/file.h>
33 #include <linux/fcntl.h>
34 #include <linux/device_cgroup.h>
35 #include <linux/fs_struct.h>
36 #include <linux/posix_acl.h>
37 #include <linux/hash.h>
38 #include <asm/uaccess.h>
43 /* [Feb-1997 T. Schoebel-Theuer]
44 * Fundamental changes in the pathname lookup mechanisms (namei)
45 * were necessary because of omirr. The reason is that omirr needs
46 * to know the _real_ pathname, not the user-supplied one, in case
47 * of symlinks (and also when transname replacements occur).
49 * The new code replaces the old recursive symlink resolution with
50 * an iterative one (in case of non-nested symlink chains). It does
51 * this with calls to <fs>_follow_link().
52 * As a side effect, dir_namei(), _namei() and follow_link() are now
53 * replaced with a single function lookup_dentry() that can handle all
54 * the special cases of the former code.
56 * With the new dcache, the pathname is stored at each inode, at least as
57 * long as the refcount of the inode is positive. As a side effect, the
58 * size of the dcache depends on the inode cache and thus is dynamic.
60 * [29-Apr-1998 C. Scott Ananian] Updated above description of symlink
61 * resolution to correspond with current state of the code.
63 * Note that the symlink resolution is not *completely* iterative.
64 * There is still a significant amount of tail- and mid- recursion in
65 * the algorithm. Also, note that <fs>_readlink() is not used in
66 * lookup_dentry(): lookup_dentry() on the result of <fs>_readlink()
67 * may return different results than <fs>_follow_link(). Many virtual
68 * filesystems (including /proc) exhibit this behavior.
71 /* [24-Feb-97 T. Schoebel-Theuer] Side effects caused by new implementation:
72 * New symlink semantics: when open() is called with flags O_CREAT | O_EXCL
73 * and the name already exists in form of a symlink, try to create the new
74 * name indicated by the symlink. The old code always complained that the
75 * name already exists, due to not following the symlink even if its target
76 * is nonexistent. The new semantics affects also mknod() and link() when
77 * the name is a symlink pointing to a non-existent name.
79 * I don't know which semantics is the right one, since I have no access
80 * to standards. But I found by trial that HP-UX 9.0 has the full "new"
81 * semantics implemented, while SunOS 4.1.1 and Solaris (SunOS 5.4) have the
82 * "old" one. Personally, I think the new semantics is much more logical.
83 * Note that "ln old new" where "new" is a symlink pointing to a non-existing
84 * file does succeed in both HP-UX and SunOs, but not in Solaris
85 * and in the old Linux semantics.
88 /* [16-Dec-97 Kevin Buhr] For security reasons, we change some symlink
89 * semantics. See the comments in "open_namei" and "do_link" below.
91 * [10-Sep-98 Alan Modra] Another symlink change.
94 /* [Feb-Apr 2000 AV] Complete rewrite. Rules for symlinks:
95 * inside the path - always follow.
96 * in the last component in creation/removal/renaming - never follow.
97 * if LOOKUP_FOLLOW passed - follow.
98 * if the pathname has trailing slashes - follow.
99 * otherwise - don't follow.
100 * (applied in that order).
102 * [Jun 2000 AV] Inconsistent behaviour of open() in case if flags==O_CREAT
103 * restored for 2.4. This is the last surviving part of old 4.2BSD bug.
104 * During the 2.4 we need to fix the userland stuff depending on it -
105 * hopefully we will be able to get rid of that wart in 2.5. So far only
106 * XEmacs seems to be relying on it...
109 * [Sep 2001 AV] Single-semaphore locking scheme (kudos to David Holland)
110 * implemented. Let's see if raised priority of ->s_vfs_rename_mutex gives
111 * any extra contention...
114 /* In order to reduce some races, while at the same time doing additional
115 * checking and hopefully speeding things up, we copy filenames to the
116 * kernel data space before using them..
118 * POSIX.1 2.4: an empty pathname is invalid (ENOENT).
119 * PATH_MAX includes the nul terminator --RR.
122 #define EMBEDDED_NAME_MAX (PATH_MAX - offsetof(struct filename, iname))
125 getname_flags(const char __user *filename, int flags, int *empty)
127 struct filename *result;
131 result = audit_reusename(filename);
135 result = __getname();
136 if (unlikely(!result))
137 return ERR_PTR(-ENOMEM);
140 * First, try to embed the struct filename inside the names_cache
143 kname = (char *)result->iname;
144 result->name = kname;
146 len = strncpy_from_user(kname, filename, EMBEDDED_NAME_MAX);
147 if (unlikely(len < 0)) {
153 * Uh-oh. We have a name that's approaching PATH_MAX. Allocate a
154 * separate struct filename so we can dedicate the entire
155 * names_cache allocation for the pathname, and re-do the copy from
158 if (unlikely(len == EMBEDDED_NAME_MAX)) {
159 const size_t size = offsetof(struct filename, iname[1]);
160 kname = (char *)result;
163 * size is chosen that way we to guarantee that
164 * result->iname[0] is within the same object and that
165 * kname can't be equal to result->iname, no matter what.
167 result = kzalloc(size, GFP_KERNEL);
168 if (unlikely(!result)) {
170 return ERR_PTR(-ENOMEM);
172 result->name = kname;
173 len = strncpy_from_user(kname, filename, PATH_MAX);
174 if (unlikely(len < 0)) {
179 if (unlikely(len == PATH_MAX)) {
182 return ERR_PTR(-ENAMETOOLONG);
187 /* The empty path is special. */
188 if (unlikely(!len)) {
191 if (!(flags & LOOKUP_EMPTY)) {
193 return ERR_PTR(-ENOENT);
197 result->uptr = filename;
198 result->aname = NULL;
199 audit_getname(result);
204 getname(const char __user * filename)
206 return getname_flags(filename, 0, NULL);
210 getname_kernel(const char * filename)
212 struct filename *result;
213 int len = strlen(filename) + 1;
215 result = __getname();
216 if (unlikely(!result))
217 return ERR_PTR(-ENOMEM);
219 if (len <= EMBEDDED_NAME_MAX) {
220 result->name = (char *)result->iname;
221 } else if (len <= PATH_MAX) {
222 struct filename *tmp;
224 tmp = kmalloc(sizeof(*tmp), GFP_KERNEL);
225 if (unlikely(!tmp)) {
227 return ERR_PTR(-ENOMEM);
229 tmp->name = (char *)result;
233 return ERR_PTR(-ENAMETOOLONG);
235 memcpy((char *)result->name, filename, len);
237 result->aname = NULL;
239 audit_getname(result);
244 void putname(struct filename *name)
246 BUG_ON(name->refcnt <= 0);
248 if (--name->refcnt > 0)
251 if (name->name != name->iname) {
252 __putname(name->name);
258 static int check_acl(struct inode *inode, int mask)
260 #ifdef CONFIG_FS_POSIX_ACL
261 struct posix_acl *acl;
263 if (mask & MAY_NOT_BLOCK) {
264 acl = get_cached_acl_rcu(inode, ACL_TYPE_ACCESS);
267 /* no ->get_acl() calls in RCU mode... */
268 if (acl == ACL_NOT_CACHED)
270 return posix_acl_permission(inode, acl, mask & ~MAY_NOT_BLOCK);
273 acl = get_acl(inode, ACL_TYPE_ACCESS);
277 int error = posix_acl_permission(inode, acl, mask);
278 posix_acl_release(acl);
287 * This does the basic permission checking
289 static int acl_permission_check(struct inode *inode, int mask)
291 unsigned int mode = inode->i_mode;
293 if (likely(uid_eq(current_fsuid(), inode->i_uid)))
296 if (IS_POSIXACL(inode) && (mode & S_IRWXG)) {
297 int error = check_acl(inode, mask);
298 if (error != -EAGAIN)
302 if (in_group_p(inode->i_gid))
307 * If the DACs are ok we don't need any capability check.
309 if ((mask & ~mode & (MAY_READ | MAY_WRITE | MAY_EXEC)) == 0)
315 * generic_permission - check for access rights on a Posix-like filesystem
316 * @inode: inode to check access rights for
317 * @mask: right to check for (%MAY_READ, %MAY_WRITE, %MAY_EXEC, ...)
319 * Used to check for read/write/execute permissions on a file.
320 * We use "fsuid" for this, letting us set arbitrary permissions
321 * for filesystem access without changing the "normal" uids which
322 * are used for other things.
324 * generic_permission is rcu-walk aware. It returns -ECHILD in case an rcu-walk
325 * request cannot be satisfied (eg. requires blocking or too much complexity).
326 * It would then be called again in ref-walk mode.
328 int generic_permission(struct inode *inode, int mask)
333 * Do the basic permission checks.
335 ret = acl_permission_check(inode, mask);
339 if (S_ISDIR(inode->i_mode)) {
340 /* DACs are overridable for directories */
341 if (capable_wrt_inode_uidgid(inode, CAP_DAC_OVERRIDE))
343 if (!(mask & MAY_WRITE))
344 if (capable_wrt_inode_uidgid(inode,
345 CAP_DAC_READ_SEARCH))
350 * Read/write DACs are always overridable.
351 * Executable DACs are overridable when there is
352 * at least one exec bit set.
354 if (!(mask & MAY_EXEC) || (inode->i_mode & S_IXUGO))
355 if (capable_wrt_inode_uidgid(inode, CAP_DAC_OVERRIDE))
359 * Searching includes executable on directories, else just read.
361 mask &= MAY_READ | MAY_WRITE | MAY_EXEC;
362 if (mask == MAY_READ)
363 if (capable_wrt_inode_uidgid(inode, CAP_DAC_READ_SEARCH))
368 EXPORT_SYMBOL(generic_permission);
371 * We _really_ want to just do "generic_permission()" without
372 * even looking at the inode->i_op values. So we keep a cache
373 * flag in inode->i_opflags, that says "this has not special
374 * permission function, use the fast case".
376 static inline int do_inode_permission(struct inode *inode, int mask)
378 if (unlikely(!(inode->i_opflags & IOP_FASTPERM))) {
379 if (likely(inode->i_op->permission))
380 return inode->i_op->permission(inode, mask);
382 /* This gets set once for the inode lifetime */
383 spin_lock(&inode->i_lock);
384 inode->i_opflags |= IOP_FASTPERM;
385 spin_unlock(&inode->i_lock);
387 return generic_permission(inode, mask);
391 * __inode_permission - Check for access rights to a given inode
392 * @inode: Inode to check permission on
393 * @mask: Right to check for (%MAY_READ, %MAY_WRITE, %MAY_EXEC)
395 * Check for read/write/execute permissions on an inode.
397 * When checking for MAY_APPEND, MAY_WRITE must also be set in @mask.
399 * This does not check for a read-only file system. You probably want
400 * inode_permission().
402 int __inode_permission(struct inode *inode, int mask)
406 if (unlikely(mask & MAY_WRITE)) {
408 * Nobody gets write access to an immutable file.
410 if (IS_IMMUTABLE(inode))
414 retval = do_inode_permission(inode, mask);
418 retval = devcgroup_inode_permission(inode, mask);
422 return security_inode_permission(inode, mask);
424 EXPORT_SYMBOL(__inode_permission);
427 * sb_permission - Check superblock-level permissions
428 * @sb: Superblock of inode to check permission on
429 * @inode: Inode to check permission on
430 * @mask: Right to check for (%MAY_READ, %MAY_WRITE, %MAY_EXEC)
432 * Separate out file-system wide checks from inode-specific permission checks.
434 static int sb_permission(struct super_block *sb, struct inode *inode, int mask)
436 if (unlikely(mask & MAY_WRITE)) {
437 umode_t mode = inode->i_mode;
439 /* Nobody gets write access to a read-only fs. */
440 if ((sb->s_flags & MS_RDONLY) &&
441 (S_ISREG(mode) || S_ISDIR(mode) || S_ISLNK(mode)))
448 * inode_permission - Check for access rights to a given inode
449 * @inode: Inode to check permission on
450 * @mask: Right to check for (%MAY_READ, %MAY_WRITE, %MAY_EXEC)
452 * Check for read/write/execute permissions on an inode. We use fs[ug]id for
453 * this, letting us set arbitrary permissions for filesystem access without
454 * changing the "normal" UIDs which are used for other things.
456 * When checking for MAY_APPEND, MAY_WRITE must also be set in @mask.
458 int inode_permission(struct inode *inode, int mask)
462 retval = sb_permission(inode->i_sb, inode, mask);
465 return __inode_permission(inode, mask);
467 EXPORT_SYMBOL(inode_permission);
470 * path_get - get a reference to a path
471 * @path: path to get the reference to
473 * Given a path increment the reference count to the dentry and the vfsmount.
475 void path_get(const struct path *path)
480 EXPORT_SYMBOL(path_get);
483 * path_put - put a reference to a path
484 * @path: path to put the reference to
486 * Given a path decrement the reference count to the dentry and the vfsmount.
488 void path_put(const struct path *path)
493 EXPORT_SYMBOL(path_put);
495 #define EMBEDDED_LEVELS 2
503 struct inode *inode; /* path.dentry.d_inode */
513 } *stack, internal[EMBEDDED_LEVELS];
516 static void set_nameidata(struct nameidata *nd)
518 nd->stack = nd->internal;
521 static void restore_nameidata(struct nameidata *nd)
523 if (nd->stack != nd->internal) {
525 nd->stack = nd->internal;
529 static int __nd_alloc_stack(struct nameidata *nd)
531 struct saved *p = kmalloc((MAXSYMLINKS + 1) * sizeof(struct saved),
535 memcpy(p, nd->internal, sizeof(nd->internal));
540 static inline int nd_alloc_stack(struct nameidata *nd)
542 if (likely(nd->depth != EMBEDDED_LEVELS - 1))
544 if (likely(nd->stack != nd->internal))
546 return __nd_alloc_stack(nd);
550 * Path walking has 2 modes, rcu-walk and ref-walk (see
551 * Documentation/filesystems/path-lookup.txt). In situations when we can't
552 * continue in RCU mode, we attempt to drop out of rcu-walk mode and grab
553 * normal reference counts on dentries and vfsmounts to transition to rcu-walk
554 * mode. Refcounts are grabbed at the last known good point before rcu-walk
555 * got stuck, so ref-walk may continue from there. If this is not successful
556 * (eg. a seqcount has changed), then failure is returned and it's up to caller
557 * to restart the path walk from the beginning in ref-walk mode.
561 * unlazy_walk - try to switch to ref-walk mode.
562 * @nd: nameidata pathwalk data
563 * @dentry: child of nd->path.dentry or NULL
564 * Returns: 0 on success, -ECHILD on failure
566 * unlazy_walk attempts to legitimize the current nd->path, nd->root and dentry
567 * for ref-walk mode. @dentry must be a path found by a do_lookup call on
568 * @nd or NULL. Must be called from rcu-walk context.
570 static int unlazy_walk(struct nameidata *nd, struct dentry *dentry)
572 struct fs_struct *fs = current->fs;
573 struct dentry *parent = nd->path.dentry;
575 BUG_ON(!(nd->flags & LOOKUP_RCU));
578 * After legitimizing the bastards, terminate_walk()
579 * will do the right thing for non-RCU mode, and all our
580 * subsequent exit cases should rcu_read_unlock()
581 * before returning. Do vfsmount first; if dentry
582 * can't be legitimized, just set nd->path.dentry to NULL
583 * and rely on dput(NULL) being a no-op.
585 if (!legitimize_mnt(nd->path.mnt, nd->m_seq))
587 nd->flags &= ~LOOKUP_RCU;
589 if (!lockref_get_not_dead(&parent->d_lockref)) {
590 nd->path.dentry = NULL;
595 * For a negative lookup, the lookup sequence point is the parents
596 * sequence point, and it only needs to revalidate the parent dentry.
598 * For a positive lookup, we need to move both the parent and the
599 * dentry from the RCU domain to be properly refcounted. And the
600 * sequence number in the dentry validates *both* dentry counters,
601 * since we checked the sequence number of the parent after we got
602 * the child sequence number. So we know the parent must still
603 * be valid if the child sequence number is still valid.
606 if (read_seqcount_retry(&parent->d_seq, nd->seq))
608 BUG_ON(nd->inode != parent->d_inode);
610 if (!lockref_get_not_dead(&dentry->d_lockref))
612 if (read_seqcount_retry(&dentry->d_seq, nd->seq))
617 * Sequence counts matched. Now make sure that the root is
618 * still valid and get it if required.
620 if (nd->root.mnt && !(nd->flags & LOOKUP_ROOT)) {
621 spin_lock(&fs->lock);
622 if (nd->root.mnt != fs->root.mnt || nd->root.dentry != fs->root.dentry)
623 goto unlock_and_drop_dentry;
625 spin_unlock(&fs->lock);
631 unlock_and_drop_dentry:
632 spin_unlock(&fs->lock);
640 if (!(nd->flags & LOOKUP_ROOT))
645 static inline int d_revalidate(struct dentry *dentry, unsigned int flags)
647 return dentry->d_op->d_revalidate(dentry, flags);
651 * complete_walk - successful completion of path walk
652 * @nd: pointer nameidata
654 * If we had been in RCU mode, drop out of it and legitimize nd->path.
655 * Revalidate the final result, unless we'd already done that during
656 * the path walk or the filesystem doesn't ask for it. Return 0 on
657 * success, -error on failure. In case of failure caller does not
658 * need to drop nd->path.
660 static int complete_walk(struct nameidata *nd)
662 struct dentry *dentry = nd->path.dentry;
665 if (nd->flags & LOOKUP_RCU) {
666 nd->flags &= ~LOOKUP_RCU;
667 if (!(nd->flags & LOOKUP_ROOT))
670 if (!legitimize_mnt(nd->path.mnt, nd->m_seq)) {
674 if (unlikely(!lockref_get_not_dead(&dentry->d_lockref))) {
676 mntput(nd->path.mnt);
679 if (read_seqcount_retry(&dentry->d_seq, nd->seq)) {
682 mntput(nd->path.mnt);
688 if (likely(!(nd->flags & LOOKUP_JUMPED)))
691 if (likely(!(dentry->d_flags & DCACHE_OP_WEAK_REVALIDATE)))
694 status = dentry->d_op->d_weak_revalidate(dentry, nd->flags);
705 static __always_inline void set_root(struct nameidata *nd)
707 get_fs_root(current->fs, &nd->root);
710 static __always_inline unsigned set_root_rcu(struct nameidata *nd)
712 struct fs_struct *fs = current->fs;
716 seq = read_seqcount_begin(&fs->seq);
718 res = __read_seqcount_begin(&nd->root.dentry->d_seq);
719 } while (read_seqcount_retry(&fs->seq, seq));
723 static void path_put_conditional(struct path *path, struct nameidata *nd)
726 if (path->mnt != nd->path.mnt)
730 static inline void path_to_nameidata(const struct path *path,
731 struct nameidata *nd)
733 if (!(nd->flags & LOOKUP_RCU)) {
734 dput(nd->path.dentry);
735 if (nd->path.mnt != path->mnt)
736 mntput(nd->path.mnt);
738 nd->path.mnt = path->mnt;
739 nd->path.dentry = path->dentry;
743 * Helper to directly jump to a known parsed path from ->follow_link,
744 * caller must have taken a reference to path beforehand.
746 void nd_jump_link(struct nameidata *nd, struct path *path)
751 nd->inode = nd->path.dentry->d_inode;
752 nd->flags |= LOOKUP_JUMPED;
755 static inline void put_link(struct nameidata *nd)
757 struct saved *last = nd->stack + nd->depth;
758 struct inode *inode = last->link.dentry->d_inode;
759 if (last->cookie && inode->i_op->put_link)
760 inode->i_op->put_link(last->link.dentry, last->cookie);
761 path_put(&last->link);
764 int sysctl_protected_symlinks __read_mostly = 0;
765 int sysctl_protected_hardlinks __read_mostly = 0;
768 * may_follow_link - Check symlink following for unsafe situations
769 * @link: The path of the symlink
770 * @nd: nameidata pathwalk data
772 * In the case of the sysctl_protected_symlinks sysctl being enabled,
773 * CAP_DAC_OVERRIDE needs to be specifically ignored if the symlink is
774 * in a sticky world-writable directory. This is to protect privileged
775 * processes from failing races against path names that may change out
776 * from under them by way of other users creating malicious symlinks.
777 * It will permit symlinks to be followed only when outside a sticky
778 * world-writable directory, or when the uid of the symlink and follower
779 * match, or when the directory owner matches the symlink's owner.
781 * Returns 0 if following the symlink is allowed, -ve on error.
783 static inline int may_follow_link(struct path *link, struct nameidata *nd)
785 const struct inode *inode;
786 const struct inode *parent;
788 if (!sysctl_protected_symlinks)
791 /* Allowed if owner and follower match. */
792 inode = link->dentry->d_inode;
793 if (uid_eq(current_cred()->fsuid, inode->i_uid))
796 /* Allowed if parent directory not sticky and world-writable. */
797 parent = nd->path.dentry->d_inode;
798 if ((parent->i_mode & (S_ISVTX|S_IWOTH)) != (S_ISVTX|S_IWOTH))
801 /* Allowed if parent directory and link owner match. */
802 if (uid_eq(parent->i_uid, inode->i_uid))
805 audit_log_link_denied("follow_link", link);
806 path_put_conditional(link, nd);
812 * safe_hardlink_source - Check for safe hardlink conditions
813 * @inode: the source inode to hardlink from
815 * Return false if at least one of the following conditions:
816 * - inode is not a regular file
818 * - inode is setgid and group-exec
819 * - access failure for read and write
821 * Otherwise returns true.
823 static bool safe_hardlink_source(struct inode *inode)
825 umode_t mode = inode->i_mode;
827 /* Special files should not get pinned to the filesystem. */
831 /* Setuid files should not get pinned to the filesystem. */
835 /* Executable setgid files should not get pinned to the filesystem. */
836 if ((mode & (S_ISGID | S_IXGRP)) == (S_ISGID | S_IXGRP))
839 /* Hardlinking to unreadable or unwritable sources is dangerous. */
840 if (inode_permission(inode, MAY_READ | MAY_WRITE))
847 * may_linkat - Check permissions for creating a hardlink
848 * @link: the source to hardlink from
850 * Block hardlink when all of:
851 * - sysctl_protected_hardlinks enabled
852 * - fsuid does not match inode
853 * - hardlink source is unsafe (see safe_hardlink_source() above)
856 * Returns 0 if successful, -ve on error.
858 static int may_linkat(struct path *link)
860 const struct cred *cred;
863 if (!sysctl_protected_hardlinks)
866 cred = current_cred();
867 inode = link->dentry->d_inode;
869 /* Source inode owner (or CAP_FOWNER) can hardlink all they like,
870 * otherwise, it must be a safe source.
872 if (uid_eq(cred->fsuid, inode->i_uid) || safe_hardlink_source(inode) ||
876 audit_log_link_denied("linkat", link);
880 static __always_inline
881 const char *get_link(struct nameidata *nd)
883 struct saved *last = nd->stack + nd->depth;
884 struct dentry *dentry = nd->link.dentry;
885 struct inode *inode = dentry->d_inode;
889 BUG_ON(nd->flags & LOOKUP_RCU);
891 if (nd->link.mnt == nd->path.mnt)
892 mntget(nd->link.mnt);
894 if (unlikely(current->total_link_count >= MAXSYMLINKS)) {
897 return ERR_PTR(-ELOOP);
900 last->link = nd->link;
904 current->total_link_count++;
906 touch_atime(&last->link);
908 error = security_inode_follow_link(dentry);
909 res = ERR_PTR(error);
913 nd->last_type = LAST_BIND;
916 res = inode->i_op->follow_link(dentry, &last->cookie, nd);
920 path_put(&last->link);
926 static int follow_up_rcu(struct path *path)
928 struct mount *mnt = real_mount(path->mnt);
929 struct mount *parent;
930 struct dentry *mountpoint;
932 parent = mnt->mnt_parent;
933 if (&parent->mnt == path->mnt)
935 mountpoint = mnt->mnt_mountpoint;
936 path->dentry = mountpoint;
937 path->mnt = &parent->mnt;
942 * follow_up - Find the mountpoint of path's vfsmount
944 * Given a path, find the mountpoint of its source file system.
945 * Replace @path with the path of the mountpoint in the parent mount.
948 * Return 1 if we went up a level and 0 if we were already at the
951 int follow_up(struct path *path)
953 struct mount *mnt = real_mount(path->mnt);
954 struct mount *parent;
955 struct dentry *mountpoint;
957 read_seqlock_excl(&mount_lock);
958 parent = mnt->mnt_parent;
960 read_sequnlock_excl(&mount_lock);
963 mntget(&parent->mnt);
964 mountpoint = dget(mnt->mnt_mountpoint);
965 read_sequnlock_excl(&mount_lock);
967 path->dentry = mountpoint;
969 path->mnt = &parent->mnt;
972 EXPORT_SYMBOL(follow_up);
975 * Perform an automount
976 * - return -EISDIR to tell follow_managed() to stop and return the path we
979 static int follow_automount(struct path *path, unsigned flags,
982 struct vfsmount *mnt;
985 if (!path->dentry->d_op || !path->dentry->d_op->d_automount)
988 /* We don't want to mount if someone's just doing a stat -
989 * unless they're stat'ing a directory and appended a '/' to
992 * We do, however, want to mount if someone wants to open or
993 * create a file of any type under the mountpoint, wants to
994 * traverse through the mountpoint or wants to open the
995 * mounted directory. Also, autofs may mark negative dentries
996 * as being automount points. These will need the attentions
997 * of the daemon to instantiate them before they can be used.
999 if (!(flags & (LOOKUP_PARENT | LOOKUP_DIRECTORY |
1000 LOOKUP_OPEN | LOOKUP_CREATE | LOOKUP_AUTOMOUNT)) &&
1001 path->dentry->d_inode)
1004 current->total_link_count++;
1005 if (current->total_link_count >= 40)
1008 mnt = path->dentry->d_op->d_automount(path);
1011 * The filesystem is allowed to return -EISDIR here to indicate
1012 * it doesn't want to automount. For instance, autofs would do
1013 * this so that its userspace daemon can mount on this dentry.
1015 * However, we can only permit this if it's a terminal point in
1016 * the path being looked up; if it wasn't then the remainder of
1017 * the path is inaccessible and we should say so.
1019 if (PTR_ERR(mnt) == -EISDIR && (flags & LOOKUP_PARENT))
1021 return PTR_ERR(mnt);
1024 if (!mnt) /* mount collision */
1027 if (!*need_mntput) {
1028 /* lock_mount() may release path->mnt on error */
1030 *need_mntput = true;
1032 err = finish_automount(mnt, path);
1036 /* Someone else made a mount here whilst we were busy */
1041 path->dentry = dget(mnt->mnt_root);
1050 * Handle a dentry that is managed in some way.
1051 * - Flagged for transit management (autofs)
1052 * - Flagged as mountpoint
1053 * - Flagged as automount point
1055 * This may only be called in refwalk mode.
1057 * Serialization is taken care of in namespace.c
1059 static int follow_managed(struct path *path, unsigned flags)
1061 struct vfsmount *mnt = path->mnt; /* held by caller, must be left alone */
1063 bool need_mntput = false;
1066 /* Given that we're not holding a lock here, we retain the value in a
1067 * local variable for each dentry as we look at it so that we don't see
1068 * the components of that value change under us */
1069 while (managed = ACCESS_ONCE(path->dentry->d_flags),
1070 managed &= DCACHE_MANAGED_DENTRY,
1071 unlikely(managed != 0)) {
1072 /* Allow the filesystem to manage the transit without i_mutex
1074 if (managed & DCACHE_MANAGE_TRANSIT) {
1075 BUG_ON(!path->dentry->d_op);
1076 BUG_ON(!path->dentry->d_op->d_manage);
1077 ret = path->dentry->d_op->d_manage(path->dentry, false);
1082 /* Transit to a mounted filesystem. */
1083 if (managed & DCACHE_MOUNTED) {
1084 struct vfsmount *mounted = lookup_mnt(path);
1089 path->mnt = mounted;
1090 path->dentry = dget(mounted->mnt_root);
1095 /* Something is mounted on this dentry in another
1096 * namespace and/or whatever was mounted there in this
1097 * namespace got unmounted before lookup_mnt() could
1101 /* Handle an automount point */
1102 if (managed & DCACHE_NEED_AUTOMOUNT) {
1103 ret = follow_automount(path, flags, &need_mntput);
1109 /* We didn't change the current path point */
1113 if (need_mntput && path->mnt == mnt)
1117 return ret < 0 ? ret : need_mntput;
1120 int follow_down_one(struct path *path)
1122 struct vfsmount *mounted;
1124 mounted = lookup_mnt(path);
1128 path->mnt = mounted;
1129 path->dentry = dget(mounted->mnt_root);
1134 EXPORT_SYMBOL(follow_down_one);
1136 static inline int managed_dentry_rcu(struct dentry *dentry)
1138 return (dentry->d_flags & DCACHE_MANAGE_TRANSIT) ?
1139 dentry->d_op->d_manage(dentry, true) : 0;
1143 * Try to skip to top of mountpoint pile in rcuwalk mode. Fail if
1144 * we meet a managed dentry that would need blocking.
1146 static bool __follow_mount_rcu(struct nameidata *nd, struct path *path,
1147 struct inode **inode)
1150 struct mount *mounted;
1152 * Don't forget we might have a non-mountpoint managed dentry
1153 * that wants to block transit.
1155 switch (managed_dentry_rcu(path->dentry)) {
1165 if (!d_mountpoint(path->dentry))
1166 return !(path->dentry->d_flags & DCACHE_NEED_AUTOMOUNT);
1168 mounted = __lookup_mnt(path->mnt, path->dentry);
1171 path->mnt = &mounted->mnt;
1172 path->dentry = mounted->mnt.mnt_root;
1173 nd->flags |= LOOKUP_JUMPED;
1174 nd->seq = read_seqcount_begin(&path->dentry->d_seq);
1176 * Update the inode too. We don't need to re-check the
1177 * dentry sequence number here after this d_inode read,
1178 * because a mount-point is always pinned.
1180 *inode = path->dentry->d_inode;
1182 return !read_seqretry(&mount_lock, nd->m_seq) &&
1183 !(path->dentry->d_flags & DCACHE_NEED_AUTOMOUNT);
1186 static int follow_dotdot_rcu(struct nameidata *nd)
1188 struct inode *inode = nd->inode;
1193 if (nd->path.dentry == nd->root.dentry &&
1194 nd->path.mnt == nd->root.mnt) {
1197 if (nd->path.dentry != nd->path.mnt->mnt_root) {
1198 struct dentry *old = nd->path.dentry;
1199 struct dentry *parent = old->d_parent;
1202 inode = parent->d_inode;
1203 seq = read_seqcount_begin(&parent->d_seq);
1204 if (read_seqcount_retry(&old->d_seq, nd->seq))
1206 nd->path.dentry = parent;
1210 if (!follow_up_rcu(&nd->path))
1212 inode = nd->path.dentry->d_inode;
1213 nd->seq = read_seqcount_begin(&nd->path.dentry->d_seq);
1215 while (d_mountpoint(nd->path.dentry)) {
1216 struct mount *mounted;
1217 mounted = __lookup_mnt(nd->path.mnt, nd->path.dentry);
1220 nd->path.mnt = &mounted->mnt;
1221 nd->path.dentry = mounted->mnt.mnt_root;
1222 inode = nd->path.dentry->d_inode;
1223 nd->seq = read_seqcount_begin(&nd->path.dentry->d_seq);
1224 if (read_seqretry(&mount_lock, nd->m_seq))
1231 nd->flags &= ~LOOKUP_RCU;
1232 if (!(nd->flags & LOOKUP_ROOT))
1233 nd->root.mnt = NULL;
1239 * Follow down to the covering mount currently visible to userspace. At each
1240 * point, the filesystem owning that dentry may be queried as to whether the
1241 * caller is permitted to proceed or not.
1243 int follow_down(struct path *path)
1248 while (managed = ACCESS_ONCE(path->dentry->d_flags),
1249 unlikely(managed & DCACHE_MANAGED_DENTRY)) {
1250 /* Allow the filesystem to manage the transit without i_mutex
1253 * We indicate to the filesystem if someone is trying to mount
1254 * something here. This gives autofs the chance to deny anyone
1255 * other than its daemon the right to mount on its
1258 * The filesystem may sleep at this point.
1260 if (managed & DCACHE_MANAGE_TRANSIT) {
1261 BUG_ON(!path->dentry->d_op);
1262 BUG_ON(!path->dentry->d_op->d_manage);
1263 ret = path->dentry->d_op->d_manage(
1264 path->dentry, false);
1266 return ret == -EISDIR ? 0 : ret;
1269 /* Transit to a mounted filesystem. */
1270 if (managed & DCACHE_MOUNTED) {
1271 struct vfsmount *mounted = lookup_mnt(path);
1276 path->mnt = mounted;
1277 path->dentry = dget(mounted->mnt_root);
1281 /* Don't handle automount points here */
1286 EXPORT_SYMBOL(follow_down);
1289 * Skip to top of mountpoint pile in refwalk mode for follow_dotdot()
1291 static void follow_mount(struct path *path)
1293 while (d_mountpoint(path->dentry)) {
1294 struct vfsmount *mounted = lookup_mnt(path);
1299 path->mnt = mounted;
1300 path->dentry = dget(mounted->mnt_root);
1304 static void follow_dotdot(struct nameidata *nd)
1310 struct dentry *old = nd->path.dentry;
1312 if (nd->path.dentry == nd->root.dentry &&
1313 nd->path.mnt == nd->root.mnt) {
1316 if (nd->path.dentry != nd->path.mnt->mnt_root) {
1317 /* rare case of legitimate dget_parent()... */
1318 nd->path.dentry = dget_parent(nd->path.dentry);
1322 if (!follow_up(&nd->path))
1325 follow_mount(&nd->path);
1326 nd->inode = nd->path.dentry->d_inode;
1330 * This looks up the name in dcache, possibly revalidates the old dentry and
1331 * allocates a new one if not found or not valid. In the need_lookup argument
1332 * returns whether i_op->lookup is necessary.
1334 * dir->d_inode->i_mutex must be held
1336 static struct dentry *lookup_dcache(struct qstr *name, struct dentry *dir,
1337 unsigned int flags, bool *need_lookup)
1339 struct dentry *dentry;
1342 *need_lookup = false;
1343 dentry = d_lookup(dir, name);
1345 if (dentry->d_flags & DCACHE_OP_REVALIDATE) {
1346 error = d_revalidate(dentry, flags);
1347 if (unlikely(error <= 0)) {
1350 return ERR_PTR(error);
1352 d_invalidate(dentry);
1361 dentry = d_alloc(dir, name);
1362 if (unlikely(!dentry))
1363 return ERR_PTR(-ENOMEM);
1365 *need_lookup = true;
1371 * Call i_op->lookup on the dentry. The dentry must be negative and
1374 * dir->d_inode->i_mutex must be held
1376 static struct dentry *lookup_real(struct inode *dir, struct dentry *dentry,
1381 /* Don't create child dentry for a dead directory. */
1382 if (unlikely(IS_DEADDIR(dir))) {
1384 return ERR_PTR(-ENOENT);
1387 old = dir->i_op->lookup(dir, dentry, flags);
1388 if (unlikely(old)) {
1395 static struct dentry *__lookup_hash(struct qstr *name,
1396 struct dentry *base, unsigned int flags)
1399 struct dentry *dentry;
1401 dentry = lookup_dcache(name, base, flags, &need_lookup);
1405 return lookup_real(base->d_inode, dentry, flags);
1409 * It's more convoluted than I'd like it to be, but... it's still fairly
1410 * small and for now I'd prefer to have fast path as straight as possible.
1411 * It _is_ time-critical.
1413 static int lookup_fast(struct nameidata *nd,
1414 struct path *path, struct inode **inode)
1416 struct vfsmount *mnt = nd->path.mnt;
1417 struct dentry *dentry, *parent = nd->path.dentry;
1423 * Rename seqlock is not required here because in the off chance
1424 * of a false negative due to a concurrent rename, we're going to
1425 * do the non-racy lookup, below.
1427 if (nd->flags & LOOKUP_RCU) {
1430 dentry = __d_lookup_rcu(parent, &nd->last, &seq);
1435 * This sequence count validates that the inode matches
1436 * the dentry name information from lookup.
1438 *inode = dentry->d_inode;
1439 negative = d_is_negative(dentry);
1440 if (read_seqcount_retry(&dentry->d_seq, seq))
1446 * This sequence count validates that the parent had no
1447 * changes while we did the lookup of the dentry above.
1449 * The memory barrier in read_seqcount_begin of child is
1450 * enough, we can use __read_seqcount_retry here.
1452 if (__read_seqcount_retry(&parent->d_seq, nd->seq))
1456 if (unlikely(dentry->d_flags & DCACHE_OP_REVALIDATE)) {
1457 status = d_revalidate(dentry, nd->flags);
1458 if (unlikely(status <= 0)) {
1459 if (status != -ECHILD)
1465 path->dentry = dentry;
1466 if (likely(__follow_mount_rcu(nd, path, inode)))
1469 if (unlazy_walk(nd, dentry))
1472 dentry = __d_lookup(parent, &nd->last);
1475 if (unlikely(!dentry))
1478 if (unlikely(dentry->d_flags & DCACHE_OP_REVALIDATE) && need_reval)
1479 status = d_revalidate(dentry, nd->flags);
1480 if (unlikely(status <= 0)) {
1485 d_invalidate(dentry);
1490 if (unlikely(d_is_negative(dentry))) {
1495 path->dentry = dentry;
1496 err = follow_managed(path, nd->flags);
1497 if (unlikely(err < 0)) {
1498 path_put_conditional(path, nd);
1502 nd->flags |= LOOKUP_JUMPED;
1503 *inode = path->dentry->d_inode;
1510 /* Fast lookup failed, do it the slow way */
1511 static int lookup_slow(struct nameidata *nd, struct path *path)
1513 struct dentry *dentry, *parent;
1516 parent = nd->path.dentry;
1517 BUG_ON(nd->inode != parent->d_inode);
1519 mutex_lock(&parent->d_inode->i_mutex);
1520 dentry = __lookup_hash(&nd->last, parent, nd->flags);
1521 mutex_unlock(&parent->d_inode->i_mutex);
1523 return PTR_ERR(dentry);
1524 path->mnt = nd->path.mnt;
1525 path->dentry = dentry;
1526 err = follow_managed(path, nd->flags);
1527 if (unlikely(err < 0)) {
1528 path_put_conditional(path, nd);
1532 nd->flags |= LOOKUP_JUMPED;
1536 static inline int may_lookup(struct nameidata *nd)
1538 if (nd->flags & LOOKUP_RCU) {
1539 int err = inode_permission(nd->inode, MAY_EXEC|MAY_NOT_BLOCK);
1542 if (unlazy_walk(nd, NULL))
1545 return inode_permission(nd->inode, MAY_EXEC);
1548 static inline int handle_dots(struct nameidata *nd, int type)
1550 if (type == LAST_DOTDOT) {
1551 if (nd->flags & LOOKUP_RCU) {
1552 if (follow_dotdot_rcu(nd))
1560 static void terminate_walk(struct nameidata *nd)
1562 if (!(nd->flags & LOOKUP_RCU)) {
1563 path_put(&nd->path);
1565 nd->flags &= ~LOOKUP_RCU;
1566 if (!(nd->flags & LOOKUP_ROOT))
1567 nd->root.mnt = NULL;
1573 * Do we need to follow links? We _really_ want to be able
1574 * to do this check without having to look at inode->i_op,
1575 * so we keep a cache of "no, this doesn't need follow_link"
1576 * for the common case.
1578 static inline int should_follow_link(struct dentry *dentry, int follow)
1580 return unlikely(d_is_symlink(dentry)) ? follow : 0;
1583 static int walk_component(struct nameidata *nd, int follow)
1586 struct inode *inode;
1589 * "." and ".." are special - ".." especially so because it has
1590 * to be able to know about the current root directory and
1591 * parent relationships.
1593 if (unlikely(nd->last_type != LAST_NORM))
1594 return handle_dots(nd, nd->last_type);
1595 err = lookup_fast(nd, &path, &inode);
1596 if (unlikely(err)) {
1600 err = lookup_slow(nd, &path);
1604 inode = path.dentry->d_inode;
1606 if (d_is_negative(path.dentry))
1610 if (should_follow_link(path.dentry, follow)) {
1611 if (nd->flags & LOOKUP_RCU) {
1612 if (unlikely(nd->path.mnt != path.mnt ||
1613 unlazy_walk(nd, path.dentry))) {
1618 BUG_ON(inode != path.dentry->d_inode);
1622 path_to_nameidata(&path, nd);
1627 path_to_nameidata(&path, nd);
1634 * We can do the critical dentry name comparison and hashing
1635 * operations one word at a time, but we are limited to:
1637 * - Architectures with fast unaligned word accesses. We could
1638 * do a "get_unaligned()" if this helps and is sufficiently
1641 * - non-CONFIG_DEBUG_PAGEALLOC configurations (so that we
1642 * do not trap on the (extremely unlikely) case of a page
1643 * crossing operation.
1645 * - Furthermore, we need an efficient 64-bit compile for the
1646 * 64-bit case in order to generate the "number of bytes in
1647 * the final mask". Again, that could be replaced with a
1648 * efficient population count instruction or similar.
1650 #ifdef CONFIG_DCACHE_WORD_ACCESS
1652 #include <asm/word-at-a-time.h>
1656 static inline unsigned int fold_hash(unsigned long hash)
1658 return hash_64(hash, 32);
1661 #else /* 32-bit case */
1663 #define fold_hash(x) (x)
1667 unsigned int full_name_hash(const unsigned char *name, unsigned int len)
1669 unsigned long a, mask;
1670 unsigned long hash = 0;
1673 a = load_unaligned_zeropad(name);
1674 if (len < sizeof(unsigned long))
1678 name += sizeof(unsigned long);
1679 len -= sizeof(unsigned long);
1683 mask = bytemask_from_count(len);
1686 return fold_hash(hash);
1688 EXPORT_SYMBOL(full_name_hash);
1691 * Calculate the length and hash of the path component, and
1692 * return the "hash_len" as the result.
1694 static inline u64 hash_name(const char *name)
1696 unsigned long a, b, adata, bdata, mask, hash, len;
1697 const struct word_at_a_time constants = WORD_AT_A_TIME_CONSTANTS;
1700 len = -sizeof(unsigned long);
1702 hash = (hash + a) * 9;
1703 len += sizeof(unsigned long);
1704 a = load_unaligned_zeropad(name+len);
1705 b = a ^ REPEAT_BYTE('/');
1706 } while (!(has_zero(a, &adata, &constants) | has_zero(b, &bdata, &constants)));
1708 adata = prep_zero_mask(a, adata, &constants);
1709 bdata = prep_zero_mask(b, bdata, &constants);
1711 mask = create_zero_mask(adata | bdata);
1713 hash += a & zero_bytemask(mask);
1714 len += find_zero(mask);
1715 return hashlen_create(fold_hash(hash), len);
1720 unsigned int full_name_hash(const unsigned char *name, unsigned int len)
1722 unsigned long hash = init_name_hash();
1724 hash = partial_name_hash(*name++, hash);
1725 return end_name_hash(hash);
1727 EXPORT_SYMBOL(full_name_hash);
1730 * We know there's a real path component here of at least
1733 static inline u64 hash_name(const char *name)
1735 unsigned long hash = init_name_hash();
1736 unsigned long len = 0, c;
1738 c = (unsigned char)*name;
1741 hash = partial_name_hash(c, hash);
1742 c = (unsigned char)name[len];
1743 } while (c && c != '/');
1744 return hashlen_create(end_name_hash(hash), len);
1751 * This is the basic name resolution function, turning a pathname into
1752 * the final dentry. We expect 'base' to be positive and a directory.
1754 * Returns 0 and nd will have valid dentry and mnt on success.
1755 * Returns error and drops reference to input namei data on failure.
1757 static int link_path_walk(const char *name, struct nameidata *nd)
1767 /* At this point we know we have a real path component. */
1772 err = may_lookup(nd);
1776 hash_len = hash_name(name);
1779 if (name[0] == '.') switch (hashlen_len(hash_len)) {
1781 if (name[1] == '.') {
1783 nd->flags |= LOOKUP_JUMPED;
1789 if (likely(type == LAST_NORM)) {
1790 struct dentry *parent = nd->path.dentry;
1791 nd->flags &= ~LOOKUP_JUMPED;
1792 if (unlikely(parent->d_flags & DCACHE_OP_HASH)) {
1793 struct qstr this = { { .hash_len = hash_len }, .name = name };
1794 err = parent->d_op->d_hash(parent, &this);
1797 hash_len = this.hash_len;
1802 nd->last.hash_len = hash_len;
1803 nd->last.name = name;
1804 nd->last_type = type;
1806 name += hashlen_len(hash_len);
1810 * If it wasn't NUL, we know it was '/'. Skip that
1811 * slash, and continue until no more slashes.
1815 } while (unlikely(*name == '/'));
1819 err = walk_component(nd, LOOKUP_FOLLOW);
1828 err = nd_alloc_stack(nd);
1830 if (unlikely(err)) {
1831 path_to_nameidata(&nd->link, nd);
1838 if (unlikely(IS_ERR(s))) {
1852 path_put(&nd->path);
1853 nd->path = nd->root;
1854 path_get(&nd->root);
1855 nd->flags |= LOOKUP_JUMPED;
1856 while (unlikely(*++s == '/'))
1859 nd->inode = nd->path.dentry->d_inode;
1860 nd->stack[nd->depth - 1].name = name;
1867 if (!d_can_lookup(nd->path.dentry)) {
1874 while (unlikely(nd->depth > 1)) {
1881 if (unlikely(nd->depth > 1)) {
1882 name = nd->stack[nd->depth - 1].name;
1883 err = walk_component(nd, LOOKUP_FOLLOW);
1892 static int path_init(int dfd, const struct filename *name, unsigned int flags,
1893 struct nameidata *nd)
1896 const char *s = name->name;
1898 nd->last_type = LAST_ROOT; /* if there are only slashes... */
1899 nd->flags = flags | LOOKUP_JUMPED | LOOKUP_PARENT;
1902 if (flags & LOOKUP_ROOT) {
1903 struct dentry *root = nd->root.dentry;
1904 struct inode *inode = root->d_inode;
1906 if (!d_can_lookup(root))
1908 retval = inode_permission(inode, MAY_EXEC);
1912 nd->path = nd->root;
1914 if (flags & LOOKUP_RCU) {
1916 nd->seq = __read_seqcount_begin(&nd->path.dentry->d_seq);
1917 nd->m_seq = read_seqbegin(&mount_lock);
1919 path_get(&nd->path);
1924 nd->root.mnt = NULL;
1926 nd->m_seq = read_seqbegin(&mount_lock);
1928 if (flags & LOOKUP_RCU) {
1930 nd->seq = set_root_rcu(nd);
1933 path_get(&nd->root);
1935 nd->path = nd->root;
1936 } else if (dfd == AT_FDCWD) {
1937 if (flags & LOOKUP_RCU) {
1938 struct fs_struct *fs = current->fs;
1944 seq = read_seqcount_begin(&fs->seq);
1946 nd->seq = __read_seqcount_begin(&nd->path.dentry->d_seq);
1947 } while (read_seqcount_retry(&fs->seq, seq));
1949 get_fs_pwd(current->fs, &nd->path);
1952 /* Caller must check execute permissions on the starting path component */
1953 struct fd f = fdget_raw(dfd);
1954 struct dentry *dentry;
1959 dentry = f.file->f_path.dentry;
1962 if (!d_can_lookup(dentry)) {
1968 nd->path = f.file->f_path;
1969 if (flags & LOOKUP_RCU) {
1970 if (f.flags & FDPUT_FPUT)
1972 nd->seq = __read_seqcount_begin(&nd->path.dentry->d_seq);
1975 path_get(&nd->path);
1980 nd->inode = nd->path.dentry->d_inode;
1981 if (!(flags & LOOKUP_RCU))
1983 if (likely(!read_seqcount_retry(&nd->path.dentry->d_seq, nd->seq)))
1985 if (!(nd->flags & LOOKUP_ROOT))
1986 nd->root.mnt = NULL;
1990 current->total_link_count = 0;
1991 return link_path_walk(s, nd);
1994 static void path_cleanup(struct nameidata *nd)
1996 if (nd->root.mnt && !(nd->flags & LOOKUP_ROOT)) {
1997 path_put(&nd->root);
1998 nd->root.mnt = NULL;
2000 if (unlikely(nd->base))
2004 static int trailing_symlink(struct nameidata *nd)
2007 int error = may_follow_link(&nd->link, nd);
2008 if (unlikely(error))
2010 nd->flags |= LOOKUP_PARENT;
2012 if (unlikely(IS_ERR(s)))
2019 path_put(&nd->path);
2020 nd->path = nd->root;
2021 path_get(&nd->root);
2022 nd->flags |= LOOKUP_JUMPED;
2024 nd->inode = nd->path.dentry->d_inode;
2025 error = link_path_walk(s, nd);
2026 if (unlikely(error))
2031 static inline int lookup_last(struct nameidata *nd)
2033 if (nd->last_type == LAST_NORM && nd->last.name[nd->last.len])
2034 nd->flags |= LOOKUP_FOLLOW | LOOKUP_DIRECTORY;
2036 nd->flags &= ~LOOKUP_PARENT;
2037 return walk_component(nd, nd->flags & LOOKUP_FOLLOW);
2040 /* Returns 0 and nd will be valid on success; Retuns error, otherwise. */
2041 static int path_lookupat(int dfd, const struct filename *name,
2042 unsigned int flags, struct nameidata *nd)
2047 * Path walking is largely split up into 2 different synchronisation
2048 * schemes, rcu-walk and ref-walk (explained in
2049 * Documentation/filesystems/path-lookup.txt). These share much of the
2050 * path walk code, but some things particularly setup, cleanup, and
2051 * following mounts are sufficiently divergent that functions are
2052 * duplicated. Typically there is a function foo(), and its RCU
2053 * analogue, foo_rcu().
2055 * -ECHILD is the error number of choice (just to avoid clashes) that
2056 * is returned if some aspect of an rcu-walk fails. Such an error must
2057 * be handled by restarting a traditional ref-walk (which will always
2058 * be able to complete).
2060 err = path_init(dfd, name, flags, nd);
2061 if (!err && !(flags & LOOKUP_PARENT)) {
2062 err = lookup_last(nd);
2064 err = trailing_symlink(nd);
2067 err = lookup_last(nd);
2073 err = complete_walk(nd);
2075 if (!err && nd->flags & LOOKUP_DIRECTORY) {
2076 if (!d_can_lookup(nd->path.dentry)) {
2077 path_put(&nd->path);
2086 static int filename_lookup(int dfd, struct filename *name,
2087 unsigned int flags, struct nameidata *nd)
2092 retval = path_lookupat(dfd, name, flags | LOOKUP_RCU, nd);
2094 if (unlikely(retval == -ECHILD))
2095 retval = path_lookupat(dfd, name, flags, nd);
2096 if (unlikely(retval == -ESTALE))
2097 retval = path_lookupat(dfd, name, flags | LOOKUP_REVAL, nd);
2099 if (likely(!retval))
2100 audit_inode(name, nd->path.dentry, flags & LOOKUP_PARENT);
2101 restore_nameidata(nd);
2105 /* does lookup, returns the object with parent locked */
2106 struct dentry *kern_path_locked(const char *name, struct path *path)
2108 struct filename *filename = getname_kernel(name);
2109 struct nameidata nd;
2113 if (IS_ERR(filename))
2114 return ERR_CAST(filename);
2116 err = filename_lookup(AT_FDCWD, filename, LOOKUP_PARENT, &nd);
2121 if (nd.last_type != LAST_NORM) {
2123 d = ERR_PTR(-EINVAL);
2126 mutex_lock_nested(&nd.path.dentry->d_inode->i_mutex, I_MUTEX_PARENT);
2127 d = __lookup_hash(&nd.last, nd.path.dentry, 0);
2129 mutex_unlock(&nd.path.dentry->d_inode->i_mutex);
2139 int kern_path(const char *name, unsigned int flags, struct path *path)
2141 struct nameidata nd;
2142 struct filename *filename = getname_kernel(name);
2143 int res = PTR_ERR(filename);
2145 if (!IS_ERR(filename)) {
2146 res = filename_lookup(AT_FDCWD, filename, flags, &nd);
2153 EXPORT_SYMBOL(kern_path);
2156 * vfs_path_lookup - lookup a file path relative to a dentry-vfsmount pair
2157 * @dentry: pointer to dentry of the base directory
2158 * @mnt: pointer to vfs mount of the base directory
2159 * @name: pointer to file name
2160 * @flags: lookup flags
2161 * @path: pointer to struct path to fill
2163 int vfs_path_lookup(struct dentry *dentry, struct vfsmount *mnt,
2164 const char *name, unsigned int flags,
2167 struct filename *filename = getname_kernel(name);
2168 int err = PTR_ERR(filename);
2170 BUG_ON(flags & LOOKUP_PARENT);
2172 /* the first argument of filename_lookup() is ignored with LOOKUP_ROOT */
2173 if (!IS_ERR(filename)) {
2174 struct nameidata nd;
2175 nd.root.dentry = dentry;
2177 err = filename_lookup(AT_FDCWD, filename,
2178 flags | LOOKUP_ROOT, &nd);
2185 EXPORT_SYMBOL(vfs_path_lookup);
2188 * lookup_one_len - filesystem helper to lookup single pathname component
2189 * @name: pathname component to lookup
2190 * @base: base directory to lookup from
2191 * @len: maximum length @len should be interpreted to
2193 * Note that this routine is purely a helper for filesystem usage and should
2194 * not be called by generic code.
2196 struct dentry *lookup_one_len(const char *name, struct dentry *base, int len)
2202 WARN_ON_ONCE(!mutex_is_locked(&base->d_inode->i_mutex));
2206 this.hash = full_name_hash(name, len);
2208 return ERR_PTR(-EACCES);
2210 if (unlikely(name[0] == '.')) {
2211 if (len < 2 || (len == 2 && name[1] == '.'))
2212 return ERR_PTR(-EACCES);
2216 c = *(const unsigned char *)name++;
2217 if (c == '/' || c == '\0')
2218 return ERR_PTR(-EACCES);
2221 * See if the low-level filesystem might want
2222 * to use its own hash..
2224 if (base->d_flags & DCACHE_OP_HASH) {
2225 int err = base->d_op->d_hash(base, &this);
2227 return ERR_PTR(err);
2230 err = inode_permission(base->d_inode, MAY_EXEC);
2232 return ERR_PTR(err);
2234 return __lookup_hash(&this, base, 0);
2236 EXPORT_SYMBOL(lookup_one_len);
2238 int user_path_at_empty(int dfd, const char __user *name, unsigned flags,
2239 struct path *path, int *empty)
2241 struct nameidata nd;
2242 struct filename *tmp = getname_flags(name, flags, empty);
2243 int err = PTR_ERR(tmp);
2246 BUG_ON(flags & LOOKUP_PARENT);
2248 err = filename_lookup(dfd, tmp, flags, &nd);
2256 int user_path_at(int dfd, const char __user *name, unsigned flags,
2259 return user_path_at_empty(dfd, name, flags, path, NULL);
2261 EXPORT_SYMBOL(user_path_at);
2264 * NB: most callers don't do anything directly with the reference to the
2265 * to struct filename, but the nd->last pointer points into the name string
2266 * allocated by getname. So we must hold the reference to it until all
2267 * path-walking is complete.
2269 static struct filename *
2270 user_path_parent(int dfd, const char __user *path,
2271 struct path *parent,
2276 struct nameidata nd;
2277 struct filename *s = getname(path);
2280 /* only LOOKUP_REVAL is allowed in extra flags */
2281 flags &= LOOKUP_REVAL;
2286 error = filename_lookup(dfd, s, flags | LOOKUP_PARENT, &nd);
2289 return ERR_PTR(error);
2293 *type = nd.last_type;
2299 * mountpoint_last - look up last component for umount
2300 * @nd: pathwalk nameidata - currently pointing at parent directory of "last"
2301 * @path: pointer to container for result
2303 * This is a special lookup_last function just for umount. In this case, we
2304 * need to resolve the path without doing any revalidation.
2306 * The nameidata should be the result of doing a LOOKUP_PARENT pathwalk. Since
2307 * mountpoints are always pinned in the dcache, their ancestors are too. Thus,
2308 * in almost all cases, this lookup will be served out of the dcache. The only
2309 * cases where it won't are if nd->last refers to a symlink or the path is
2310 * bogus and it doesn't exist.
2313 * -error: if there was an error during lookup. This includes -ENOENT if the
2314 * lookup found a negative dentry. The nd->path reference will also be
2317 * 0: if we successfully resolved nd->path and found it to not to be a
2318 * symlink that needs to be followed. "path" will also be populated.
2319 * The nd->path reference will also be put.
2321 * 1: if we successfully resolved nd->last and found it to be a symlink
2322 * that needs to be followed. "path" will be populated with the path
2323 * to the link, and nd->path will *not* be put.
2326 mountpoint_last(struct nameidata *nd, struct path *path)
2329 struct dentry *dentry;
2330 struct dentry *dir = nd->path.dentry;
2332 /* If we're in rcuwalk, drop out of it to handle last component */
2333 if (nd->flags & LOOKUP_RCU) {
2334 if (unlazy_walk(nd, NULL)) {
2340 nd->flags &= ~LOOKUP_PARENT;
2342 if (unlikely(nd->last_type != LAST_NORM)) {
2343 error = handle_dots(nd, nd->last_type);
2346 dentry = dget(nd->path.dentry);
2350 mutex_lock(&dir->d_inode->i_mutex);
2351 dentry = d_lookup(dir, &nd->last);
2354 * No cached dentry. Mounted dentries are pinned in the cache,
2355 * so that means that this dentry is probably a symlink or the
2356 * path doesn't actually point to a mounted dentry.
2358 dentry = d_alloc(dir, &nd->last);
2361 mutex_unlock(&dir->d_inode->i_mutex);
2364 dentry = lookup_real(dir->d_inode, dentry, nd->flags);
2365 error = PTR_ERR(dentry);
2366 if (IS_ERR(dentry)) {
2367 mutex_unlock(&dir->d_inode->i_mutex);
2371 mutex_unlock(&dir->d_inode->i_mutex);
2374 if (d_is_negative(dentry)) {
2379 path->dentry = dentry;
2380 path->mnt = nd->path.mnt;
2381 if (should_follow_link(dentry, nd->flags & LOOKUP_FOLLOW)) {
2394 * path_mountpoint - look up a path to be umounted
2395 * @dfd: directory file descriptor to start walk from
2396 * @name: full pathname to walk
2397 * @path: pointer to container for result
2398 * @flags: lookup flags
2400 * Look up the given name, but don't attempt to revalidate the last component.
2401 * Returns 0 and "path" will be valid on success; Returns error otherwise.
2404 path_mountpoint(int dfd, const struct filename *name, struct path *path,
2405 struct nameidata *nd, unsigned int flags)
2407 int err = path_init(dfd, name, flags, nd);
2411 err = mountpoint_last(nd, path);
2413 err = trailing_symlink(nd);
2416 err = mountpoint_last(nd, path);
2425 filename_mountpoint(int dfd, struct filename *name, struct path *path,
2428 struct nameidata nd;
2431 return PTR_ERR(name);
2433 error = path_mountpoint(dfd, name, path, &nd, flags | LOOKUP_RCU);
2434 if (unlikely(error == -ECHILD))
2435 error = path_mountpoint(dfd, name, path, &nd, flags);
2436 if (unlikely(error == -ESTALE))
2437 error = path_mountpoint(dfd, name, path, &nd, flags | LOOKUP_REVAL);
2439 audit_inode(name, path->dentry, 0);
2440 restore_nameidata(&nd);
2446 * user_path_mountpoint_at - lookup a path from userland in order to umount it
2447 * @dfd: directory file descriptor
2448 * @name: pathname from userland
2449 * @flags: lookup flags
2450 * @path: pointer to container to hold result
2452 * A umount is a special case for path walking. We're not actually interested
2453 * in the inode in this situation, and ESTALE errors can be a problem. We
2454 * simply want track down the dentry and vfsmount attached at the mountpoint
2455 * and avoid revalidating the last component.
2457 * Returns 0 and populates "path" on success.
2460 user_path_mountpoint_at(int dfd, const char __user *name, unsigned int flags,
2463 return filename_mountpoint(dfd, getname(name), path, flags);
2467 kern_path_mountpoint(int dfd, const char *name, struct path *path,
2470 return filename_mountpoint(dfd, getname_kernel(name), path, flags);
2472 EXPORT_SYMBOL(kern_path_mountpoint);
2474 int __check_sticky(struct inode *dir, struct inode *inode)
2476 kuid_t fsuid = current_fsuid();
2478 if (uid_eq(inode->i_uid, fsuid))
2480 if (uid_eq(dir->i_uid, fsuid))
2482 return !capable_wrt_inode_uidgid(inode, CAP_FOWNER);
2484 EXPORT_SYMBOL(__check_sticky);
2487 * Check whether we can remove a link victim from directory dir, check
2488 * whether the type of victim is right.
2489 * 1. We can't do it if dir is read-only (done in permission())
2490 * 2. We should have write and exec permissions on dir
2491 * 3. We can't remove anything from append-only dir
2492 * 4. We can't do anything with immutable dir (done in permission())
2493 * 5. If the sticky bit on dir is set we should either
2494 * a. be owner of dir, or
2495 * b. be owner of victim, or
2496 * c. have CAP_FOWNER capability
2497 * 6. If the victim is append-only or immutable we can't do antyhing with
2498 * links pointing to it.
2499 * 7. If we were asked to remove a directory and victim isn't one - ENOTDIR.
2500 * 8. If we were asked to remove a non-directory and victim isn't one - EISDIR.
2501 * 9. We can't remove a root or mountpoint.
2502 * 10. We don't allow removal of NFS sillyrenamed files; it's handled by
2503 * nfs_async_unlink().
2505 static int may_delete(struct inode *dir, struct dentry *victim, bool isdir)
2507 struct inode *inode = victim->d_inode;
2510 if (d_is_negative(victim))
2514 BUG_ON(victim->d_parent->d_inode != dir);
2515 audit_inode_child(dir, victim, AUDIT_TYPE_CHILD_DELETE);
2517 error = inode_permission(dir, MAY_WRITE | MAY_EXEC);
2523 if (check_sticky(dir, inode) || IS_APPEND(inode) ||
2524 IS_IMMUTABLE(inode) || IS_SWAPFILE(inode))
2527 if (!d_is_dir(victim))
2529 if (IS_ROOT(victim))
2531 } else if (d_is_dir(victim))
2533 if (IS_DEADDIR(dir))
2535 if (victim->d_flags & DCACHE_NFSFS_RENAMED)
2540 /* Check whether we can create an object with dentry child in directory
2542 * 1. We can't do it if child already exists (open has special treatment for
2543 * this case, but since we are inlined it's OK)
2544 * 2. We can't do it if dir is read-only (done in permission())
2545 * 3. We should have write and exec permissions on dir
2546 * 4. We can't do it if dir is immutable (done in permission())
2548 static inline int may_create(struct inode *dir, struct dentry *child)
2550 audit_inode_child(dir, child, AUDIT_TYPE_CHILD_CREATE);
2553 if (IS_DEADDIR(dir))
2555 return inode_permission(dir, MAY_WRITE | MAY_EXEC);
2559 * p1 and p2 should be directories on the same fs.
2561 struct dentry *lock_rename(struct dentry *p1, struct dentry *p2)
2566 mutex_lock_nested(&p1->d_inode->i_mutex, I_MUTEX_PARENT);
2570 mutex_lock(&p1->d_inode->i_sb->s_vfs_rename_mutex);
2572 p = d_ancestor(p2, p1);
2574 mutex_lock_nested(&p2->d_inode->i_mutex, I_MUTEX_PARENT);
2575 mutex_lock_nested(&p1->d_inode->i_mutex, I_MUTEX_CHILD);
2579 p = d_ancestor(p1, p2);
2581 mutex_lock_nested(&p1->d_inode->i_mutex, I_MUTEX_PARENT);
2582 mutex_lock_nested(&p2->d_inode->i_mutex, I_MUTEX_CHILD);
2586 mutex_lock_nested(&p1->d_inode->i_mutex, I_MUTEX_PARENT);
2587 mutex_lock_nested(&p2->d_inode->i_mutex, I_MUTEX_PARENT2);
2590 EXPORT_SYMBOL(lock_rename);
2592 void unlock_rename(struct dentry *p1, struct dentry *p2)
2594 mutex_unlock(&p1->d_inode->i_mutex);
2596 mutex_unlock(&p2->d_inode->i_mutex);
2597 mutex_unlock(&p1->d_inode->i_sb->s_vfs_rename_mutex);
2600 EXPORT_SYMBOL(unlock_rename);
2602 int vfs_create(struct inode *dir, struct dentry *dentry, umode_t mode,
2605 int error = may_create(dir, dentry);
2609 if (!dir->i_op->create)
2610 return -EACCES; /* shouldn't it be ENOSYS? */
2613 error = security_inode_create(dir, dentry, mode);
2616 error = dir->i_op->create(dir, dentry, mode, want_excl);
2618 fsnotify_create(dir, dentry);
2621 EXPORT_SYMBOL(vfs_create);
2623 static int may_open(struct path *path, int acc_mode, int flag)
2625 struct dentry *dentry = path->dentry;
2626 struct inode *inode = dentry->d_inode;
2636 switch (inode->i_mode & S_IFMT) {
2640 if (acc_mode & MAY_WRITE)
2645 if (path->mnt->mnt_flags & MNT_NODEV)
2654 error = inode_permission(inode, acc_mode);
2659 * An append-only file must be opened in append mode for writing.
2661 if (IS_APPEND(inode)) {
2662 if ((flag & O_ACCMODE) != O_RDONLY && !(flag & O_APPEND))
2668 /* O_NOATIME can only be set by the owner or superuser */
2669 if (flag & O_NOATIME && !inode_owner_or_capable(inode))
2675 static int handle_truncate(struct file *filp)
2677 struct path *path = &filp->f_path;
2678 struct inode *inode = path->dentry->d_inode;
2679 int error = get_write_access(inode);
2683 * Refuse to truncate files with mandatory locks held on them.
2685 error = locks_verify_locked(filp);
2687 error = security_path_truncate(path);
2689 error = do_truncate(path->dentry, 0,
2690 ATTR_MTIME|ATTR_CTIME|ATTR_OPEN,
2693 put_write_access(inode);
2697 static inline int open_to_namei_flags(int flag)
2699 if ((flag & O_ACCMODE) == 3)
2704 static int may_o_create(struct path *dir, struct dentry *dentry, umode_t mode)
2706 int error = security_path_mknod(dir, dentry, mode, 0);
2710 error = inode_permission(dir->dentry->d_inode, MAY_WRITE | MAY_EXEC);
2714 return security_inode_create(dir->dentry->d_inode, dentry, mode);
2718 * Attempt to atomically look up, create and open a file from a negative
2721 * Returns 0 if successful. The file will have been created and attached to
2722 * @file by the filesystem calling finish_open().
2724 * Returns 1 if the file was looked up only or didn't need creating. The
2725 * caller will need to perform the open themselves. @path will have been
2726 * updated to point to the new dentry. This may be negative.
2728 * Returns an error code otherwise.
2730 static int atomic_open(struct nameidata *nd, struct dentry *dentry,
2731 struct path *path, struct file *file,
2732 const struct open_flags *op,
2733 bool got_write, bool need_lookup,
2736 struct inode *dir = nd->path.dentry->d_inode;
2737 unsigned open_flag = open_to_namei_flags(op->open_flag);
2741 int create_error = 0;
2742 struct dentry *const DENTRY_NOT_SET = (void *) -1UL;
2745 BUG_ON(dentry->d_inode);
2747 /* Don't create child dentry for a dead directory. */
2748 if (unlikely(IS_DEADDIR(dir))) {
2754 if ((open_flag & O_CREAT) && !IS_POSIXACL(dir))
2755 mode &= ~current_umask();
2757 excl = (open_flag & (O_EXCL | O_CREAT)) == (O_EXCL | O_CREAT);
2759 open_flag &= ~O_TRUNC;
2762 * Checking write permission is tricky, bacuse we don't know if we are
2763 * going to actually need it: O_CREAT opens should work as long as the
2764 * file exists. But checking existence breaks atomicity. The trick is
2765 * to check access and if not granted clear O_CREAT from the flags.
2767 * Another problem is returing the "right" error value (e.g. for an
2768 * O_EXCL open we want to return EEXIST not EROFS).
2770 if (((open_flag & (O_CREAT | O_TRUNC)) ||
2771 (open_flag & O_ACCMODE) != O_RDONLY) && unlikely(!got_write)) {
2772 if (!(open_flag & O_CREAT)) {
2774 * No O_CREATE -> atomicity not a requirement -> fall
2775 * back to lookup + open
2778 } else if (open_flag & (O_EXCL | O_TRUNC)) {
2779 /* Fall back and fail with the right error */
2780 create_error = -EROFS;
2783 /* No side effects, safe to clear O_CREAT */
2784 create_error = -EROFS;
2785 open_flag &= ~O_CREAT;
2789 if (open_flag & O_CREAT) {
2790 error = may_o_create(&nd->path, dentry, mode);
2792 create_error = error;
2793 if (open_flag & O_EXCL)
2795 open_flag &= ~O_CREAT;
2799 if (nd->flags & LOOKUP_DIRECTORY)
2800 open_flag |= O_DIRECTORY;
2802 file->f_path.dentry = DENTRY_NOT_SET;
2803 file->f_path.mnt = nd->path.mnt;
2804 error = dir->i_op->atomic_open(dir, dentry, file, open_flag, mode,
2807 if (create_error && error == -ENOENT)
2808 error = create_error;
2812 if (error) { /* returned 1, that is */
2813 if (WARN_ON(file->f_path.dentry == DENTRY_NOT_SET)) {
2817 if (file->f_path.dentry) {
2819 dentry = file->f_path.dentry;
2821 if (*opened & FILE_CREATED)
2822 fsnotify_create(dir, dentry);
2823 if (!dentry->d_inode) {
2824 WARN_ON(*opened & FILE_CREATED);
2826 error = create_error;
2830 if (excl && !(*opened & FILE_CREATED)) {
2839 * We didn't have the inode before the open, so check open permission
2842 acc_mode = op->acc_mode;
2843 if (*opened & FILE_CREATED) {
2844 WARN_ON(!(open_flag & O_CREAT));
2845 fsnotify_create(dir, dentry);
2846 acc_mode = MAY_OPEN;
2848 error = may_open(&file->f_path, acc_mode, open_flag);
2858 dentry = lookup_real(dir, dentry, nd->flags);
2860 return PTR_ERR(dentry);
2863 int open_flag = op->open_flag;
2865 error = create_error;
2866 if ((open_flag & O_EXCL)) {
2867 if (!dentry->d_inode)
2869 } else if (!dentry->d_inode) {
2871 } else if ((open_flag & O_TRUNC) &&
2875 /* will fail later, go on to get the right error */
2879 path->dentry = dentry;
2880 path->mnt = nd->path.mnt;
2885 * Look up and maybe create and open the last component.
2887 * Must be called with i_mutex held on parent.
2889 * Returns 0 if the file was successfully atomically created (if necessary) and
2890 * opened. In this case the file will be returned attached to @file.
2892 * Returns 1 if the file was not completely opened at this time, though lookups
2893 * and creations will have been performed and the dentry returned in @path will
2894 * be positive upon return if O_CREAT was specified. If O_CREAT wasn't
2895 * specified then a negative dentry may be returned.
2897 * An error code is returned otherwise.
2899 * FILE_CREATE will be set in @*opened if the dentry was created and will be
2900 * cleared otherwise prior to returning.
2902 static int lookup_open(struct nameidata *nd, struct path *path,
2904 const struct open_flags *op,
2905 bool got_write, int *opened)
2907 struct dentry *dir = nd->path.dentry;
2908 struct inode *dir_inode = dir->d_inode;
2909 struct dentry *dentry;
2913 *opened &= ~FILE_CREATED;
2914 dentry = lookup_dcache(&nd->last, dir, nd->flags, &need_lookup);
2916 return PTR_ERR(dentry);
2918 /* Cached positive dentry: will open in f_op->open */
2919 if (!need_lookup && dentry->d_inode)
2922 if ((nd->flags & LOOKUP_OPEN) && dir_inode->i_op->atomic_open) {
2923 return atomic_open(nd, dentry, path, file, op, got_write,
2924 need_lookup, opened);
2928 BUG_ON(dentry->d_inode);
2930 dentry = lookup_real(dir_inode, dentry, nd->flags);
2932 return PTR_ERR(dentry);
2935 /* Negative dentry, just create the file */
2936 if (!dentry->d_inode && (op->open_flag & O_CREAT)) {
2937 umode_t mode = op->mode;
2938 if (!IS_POSIXACL(dir->d_inode))
2939 mode &= ~current_umask();
2941 * This write is needed to ensure that a
2942 * rw->ro transition does not occur between
2943 * the time when the file is created and when
2944 * a permanent write count is taken through
2945 * the 'struct file' in finish_open().
2951 *opened |= FILE_CREATED;
2952 error = security_path_mknod(&nd->path, dentry, mode, 0);
2955 error = vfs_create(dir->d_inode, dentry, mode,
2956 nd->flags & LOOKUP_EXCL);
2961 path->dentry = dentry;
2962 path->mnt = nd->path.mnt;
2971 * Handle the last step of open()
2973 static int do_last(struct nameidata *nd,
2974 struct file *file, const struct open_flags *op,
2975 int *opened, struct filename *name)
2977 struct dentry *dir = nd->path.dentry;
2978 int open_flag = op->open_flag;
2979 bool will_truncate = (open_flag & O_TRUNC) != 0;
2980 bool got_write = false;
2981 int acc_mode = op->acc_mode;
2982 struct inode *inode;
2983 struct path save_parent = { .dentry = NULL, .mnt = NULL };
2985 bool retried = false;
2988 nd->flags &= ~LOOKUP_PARENT;
2989 nd->flags |= op->intent;
2991 if (nd->last_type != LAST_NORM) {
2992 error = handle_dots(nd, nd->last_type);
2998 if (!(open_flag & O_CREAT)) {
2999 if (nd->last.name[nd->last.len])
3000 nd->flags |= LOOKUP_FOLLOW | LOOKUP_DIRECTORY;
3001 /* we _can_ be in RCU mode here */
3002 error = lookup_fast(nd, &path, &inode);
3009 BUG_ON(nd->inode != dir->d_inode);
3011 /* create side of things */
3013 * This will *only* deal with leaving RCU mode - LOOKUP_JUMPED
3014 * has been cleared when we got to the last component we are
3017 error = complete_walk(nd);
3021 audit_inode(name, dir, LOOKUP_PARENT);
3023 /* trailing slashes? */
3024 if (nd->last.name[nd->last.len])
3029 if (op->open_flag & (O_CREAT | O_TRUNC | O_WRONLY | O_RDWR)) {
3030 error = mnt_want_write(nd->path.mnt);
3034 * do _not_ fail yet - we might not need that or fail with
3035 * a different error; let lookup_open() decide; we'll be
3036 * dropping this one anyway.
3039 mutex_lock(&dir->d_inode->i_mutex);
3040 error = lookup_open(nd, &path, file, op, got_write, opened);
3041 mutex_unlock(&dir->d_inode->i_mutex);
3047 if ((*opened & FILE_CREATED) ||
3048 !S_ISREG(file_inode(file)->i_mode))
3049 will_truncate = false;
3051 audit_inode(name, file->f_path.dentry, 0);
3055 if (*opened & FILE_CREATED) {
3056 /* Don't check for write permission, don't truncate */
3057 open_flag &= ~O_TRUNC;
3058 will_truncate = false;
3059 acc_mode = MAY_OPEN;
3060 path_to_nameidata(&path, nd);
3061 goto finish_open_created;
3065 * create/update audit record if it already exists.
3067 if (d_is_positive(path.dentry))
3068 audit_inode(name, path.dentry, 0);
3071 * If atomic_open() acquired write access it is dropped now due to
3072 * possible mount and symlink following (this might be optimized away if
3076 mnt_drop_write(nd->path.mnt);
3081 if ((open_flag & (O_EXCL | O_CREAT)) == (O_EXCL | O_CREAT))
3084 error = follow_managed(&path, nd->flags);
3089 nd->flags |= LOOKUP_JUMPED;
3091 BUG_ON(nd->flags & LOOKUP_RCU);
3092 inode = path.dentry->d_inode;
3094 if (d_is_negative(path.dentry)) {
3095 path_to_nameidata(&path, nd);
3099 if (should_follow_link(path.dentry, nd->flags & LOOKUP_FOLLOW)) {
3100 if (nd->flags & LOOKUP_RCU) {
3101 if (unlikely(nd->path.mnt != path.mnt ||
3102 unlazy_walk(nd, path.dentry))) {
3107 BUG_ON(inode != path.dentry->d_inode);
3112 if (unlikely(d_is_symlink(path.dentry)) && !(open_flag & O_PATH)) {
3113 path_to_nameidata(&path, nd);
3118 if ((nd->flags & LOOKUP_RCU) || nd->path.mnt != path.mnt) {
3119 path_to_nameidata(&path, nd);
3121 save_parent.dentry = nd->path.dentry;
3122 save_parent.mnt = mntget(path.mnt);
3123 nd->path.dentry = path.dentry;
3127 /* Why this, you ask? _Now_ we might have grown LOOKUP_JUMPED... */
3129 error = complete_walk(nd);
3131 path_put(&save_parent);
3134 audit_inode(name, nd->path.dentry, 0);
3136 if ((open_flag & O_CREAT) && d_is_dir(nd->path.dentry))
3139 if ((nd->flags & LOOKUP_DIRECTORY) && !d_can_lookup(nd->path.dentry))
3141 if (!d_is_reg(nd->path.dentry))
3142 will_truncate = false;
3144 if (will_truncate) {
3145 error = mnt_want_write(nd->path.mnt);
3150 finish_open_created:
3151 error = may_open(&nd->path, acc_mode, open_flag);
3155 BUG_ON(*opened & FILE_OPENED); /* once it's opened, it's opened */
3156 error = vfs_open(&nd->path, file, current_cred());
3158 *opened |= FILE_OPENED;
3160 if (error == -EOPENSTALE)
3165 error = open_check_o_direct(file);
3168 error = ima_file_check(file, op->acc_mode, *opened);
3172 if (will_truncate) {
3173 error = handle_truncate(file);
3179 mnt_drop_write(nd->path.mnt);
3180 path_put(&save_parent);
3185 path_put_conditional(&path, nd);
3192 /* If no saved parent or already retried then can't retry */
3193 if (!save_parent.dentry || retried)
3196 BUG_ON(save_parent.dentry != dir);
3197 path_put(&nd->path);
3198 nd->path = save_parent;
3199 nd->inode = dir->d_inode;
3200 save_parent.mnt = NULL;
3201 save_parent.dentry = NULL;
3203 mnt_drop_write(nd->path.mnt);
3210 static int do_tmpfile(int dfd, struct filename *pathname,
3211 struct nameidata *nd, int flags,
3212 const struct open_flags *op,
3213 struct file *file, int *opened)
3215 static const struct qstr name = QSTR_INIT("/", 1);
3216 struct dentry *dentry, *child;
3218 int error = path_lookupat(dfd, pathname,
3219 flags | LOOKUP_DIRECTORY, nd);
3220 if (unlikely(error))
3222 error = mnt_want_write(nd->path.mnt);
3223 if (unlikely(error))
3225 /* we want directory to be writable */
3226 error = inode_permission(nd->inode, MAY_WRITE | MAY_EXEC);
3229 dentry = nd->path.dentry;
3230 dir = dentry->d_inode;
3231 if (!dir->i_op->tmpfile) {
3232 error = -EOPNOTSUPP;
3235 child = d_alloc(dentry, &name);
3236 if (unlikely(!child)) {
3240 nd->flags &= ~LOOKUP_DIRECTORY;
3241 nd->flags |= op->intent;
3242 dput(nd->path.dentry);
3243 nd->path.dentry = child;
3244 error = dir->i_op->tmpfile(dir, nd->path.dentry, op->mode);
3247 audit_inode(pathname, nd->path.dentry, 0);
3248 /* Don't check for other permissions, the inode was just created */
3249 error = may_open(&nd->path, MAY_OPEN, op->open_flag);
3252 file->f_path.mnt = nd->path.mnt;
3253 error = finish_open(file, nd->path.dentry, NULL, opened);
3256 error = open_check_o_direct(file);
3259 } else if (!(op->open_flag & O_EXCL)) {
3260 struct inode *inode = file_inode(file);
3261 spin_lock(&inode->i_lock);
3262 inode->i_state |= I_LINKABLE;
3263 spin_unlock(&inode->i_lock);
3266 mnt_drop_write(nd->path.mnt);
3268 path_put(&nd->path);
3272 static struct file *path_openat(int dfd, struct filename *pathname,
3273 struct nameidata *nd, const struct open_flags *op, int flags)
3279 file = get_empty_filp();
3283 file->f_flags = op->open_flag;
3285 if (unlikely(file->f_flags & __O_TMPFILE)) {
3286 error = do_tmpfile(dfd, pathname, nd, flags, op, file, &opened);
3290 error = path_init(dfd, pathname, flags, nd);
3291 if (unlikely(error))
3294 error = do_last(nd, file, op, &opened, pathname);
3295 while (unlikely(error > 0)) { /* trailing symlink */
3296 nd->flags &= ~(LOOKUP_OPEN|LOOKUP_CREATE|LOOKUP_EXCL);
3297 error = trailing_symlink(nd);
3298 if (unlikely(error))
3300 error = do_last(nd, file, op, &opened, pathname);
3306 if (!(opened & FILE_OPENED)) {
3310 if (unlikely(error)) {
3311 if (error == -EOPENSTALE) {
3312 if (flags & LOOKUP_RCU)
3317 file = ERR_PTR(error);
3322 struct file *do_filp_open(int dfd, struct filename *pathname,
3323 const struct open_flags *op)
3325 struct nameidata nd;
3326 int flags = op->lookup_flags;
3330 filp = path_openat(dfd, pathname, &nd, op, flags | LOOKUP_RCU);
3331 if (unlikely(filp == ERR_PTR(-ECHILD)))
3332 filp = path_openat(dfd, pathname, &nd, op, flags);
3333 if (unlikely(filp == ERR_PTR(-ESTALE)))
3334 filp = path_openat(dfd, pathname, &nd, op, flags | LOOKUP_REVAL);
3335 restore_nameidata(&nd);
3339 struct file *do_file_open_root(struct dentry *dentry, struct vfsmount *mnt,
3340 const char *name, const struct open_flags *op)
3342 struct nameidata nd;
3344 struct filename *filename;
3345 int flags = op->lookup_flags | LOOKUP_ROOT;
3348 nd.root.dentry = dentry;
3351 if (d_is_symlink(dentry) && op->intent & LOOKUP_OPEN)
3352 return ERR_PTR(-ELOOP);
3354 filename = getname_kernel(name);
3355 if (unlikely(IS_ERR(filename)))
3356 return ERR_CAST(filename);
3358 file = path_openat(-1, filename, &nd, op, flags | LOOKUP_RCU);
3359 if (unlikely(file == ERR_PTR(-ECHILD)))
3360 file = path_openat(-1, filename, &nd, op, flags);
3361 if (unlikely(file == ERR_PTR(-ESTALE)))
3362 file = path_openat(-1, filename, &nd, op, flags | LOOKUP_REVAL);
3363 restore_nameidata(&nd);
3368 static struct dentry *filename_create(int dfd, struct filename *name,
3369 struct path *path, unsigned int lookup_flags)
3371 struct dentry *dentry = ERR_PTR(-EEXIST);
3372 struct nameidata nd;
3375 bool is_dir = (lookup_flags & LOOKUP_DIRECTORY);
3378 * Note that only LOOKUP_REVAL and LOOKUP_DIRECTORY matter here. Any
3379 * other flags passed in are ignored!
3381 lookup_flags &= LOOKUP_REVAL;
3383 error = filename_lookup(dfd, name, LOOKUP_PARENT|lookup_flags, &nd);
3385 return ERR_PTR(error);
3388 * Yucky last component or no last component at all?
3389 * (foo/., foo/.., /////)
3391 if (nd.last_type != LAST_NORM)
3393 nd.flags &= ~LOOKUP_PARENT;
3394 nd.flags |= LOOKUP_CREATE | LOOKUP_EXCL;
3396 /* don't fail immediately if it's r/o, at least try to report other errors */
3397 err2 = mnt_want_write(nd.path.mnt);
3399 * Do the final lookup.
3401 mutex_lock_nested(&nd.path.dentry->d_inode->i_mutex, I_MUTEX_PARENT);
3402 dentry = __lookup_hash(&nd.last, nd.path.dentry, nd.flags);
3407 if (d_is_positive(dentry))
3411 * Special case - lookup gave negative, but... we had foo/bar/
3412 * From the vfs_mknod() POV we just have a negative dentry -
3413 * all is fine. Let's be bastards - you had / on the end, you've
3414 * been asking for (non-existent) directory. -ENOENT for you.
3416 if (unlikely(!is_dir && nd.last.name[nd.last.len])) {
3420 if (unlikely(err2)) {
3428 dentry = ERR_PTR(error);
3430 mutex_unlock(&nd.path.dentry->d_inode->i_mutex);
3432 mnt_drop_write(nd.path.mnt);
3438 struct dentry *kern_path_create(int dfd, const char *pathname,
3439 struct path *path, unsigned int lookup_flags)
3441 struct filename *filename = getname_kernel(pathname);
3444 if (IS_ERR(filename))
3445 return ERR_CAST(filename);
3446 res = filename_create(dfd, filename, path, lookup_flags);
3450 EXPORT_SYMBOL(kern_path_create);
3452 void done_path_create(struct path *path, struct dentry *dentry)
3455 mutex_unlock(&path->dentry->d_inode->i_mutex);
3456 mnt_drop_write(path->mnt);
3459 EXPORT_SYMBOL(done_path_create);
3461 struct dentry *user_path_create(int dfd, const char __user *pathname,
3462 struct path *path, unsigned int lookup_flags)
3464 struct filename *tmp = getname(pathname);
3467 return ERR_CAST(tmp);
3468 res = filename_create(dfd, tmp, path, lookup_flags);
3472 EXPORT_SYMBOL(user_path_create);
3474 int vfs_mknod(struct inode *dir, struct dentry *dentry, umode_t mode, dev_t dev)
3476 int error = may_create(dir, dentry);
3481 if ((S_ISCHR(mode) || S_ISBLK(mode)) && !capable(CAP_MKNOD))
3484 if (!dir->i_op->mknod)
3487 error = devcgroup_inode_mknod(mode, dev);
3491 error = security_inode_mknod(dir, dentry, mode, dev);
3495 error = dir->i_op->mknod(dir, dentry, mode, dev);
3497 fsnotify_create(dir, dentry);
3500 EXPORT_SYMBOL(vfs_mknod);
3502 static int may_mknod(umode_t mode)
3504 switch (mode & S_IFMT) {
3510 case 0: /* zero mode translates to S_IFREG */
3519 SYSCALL_DEFINE4(mknodat, int, dfd, const char __user *, filename, umode_t, mode,
3522 struct dentry *dentry;
3525 unsigned int lookup_flags = 0;
3527 error = may_mknod(mode);
3531 dentry = user_path_create(dfd, filename, &path, lookup_flags);
3533 return PTR_ERR(dentry);
3535 if (!IS_POSIXACL(path.dentry->d_inode))
3536 mode &= ~current_umask();
3537 error = security_path_mknod(&path, dentry, mode, dev);
3540 switch (mode & S_IFMT) {
3541 case 0: case S_IFREG:
3542 error = vfs_create(path.dentry->d_inode,dentry,mode,true);
3544 case S_IFCHR: case S_IFBLK:
3545 error = vfs_mknod(path.dentry->d_inode,dentry,mode,
3546 new_decode_dev(dev));
3548 case S_IFIFO: case S_IFSOCK:
3549 error = vfs_mknod(path.dentry->d_inode,dentry,mode,0);
3553 done_path_create(&path, dentry);
3554 if (retry_estale(error, lookup_flags)) {
3555 lookup_flags |= LOOKUP_REVAL;
3561 SYSCALL_DEFINE3(mknod, const char __user *, filename, umode_t, mode, unsigned, dev)
3563 return sys_mknodat(AT_FDCWD, filename, mode, dev);
3566 int vfs_mkdir(struct inode *dir, struct dentry *dentry, umode_t mode)
3568 int error = may_create(dir, dentry);
3569 unsigned max_links = dir->i_sb->s_max_links;
3574 if (!dir->i_op->mkdir)
3577 mode &= (S_IRWXUGO|S_ISVTX);
3578 error = security_inode_mkdir(dir, dentry, mode);
3582 if (max_links && dir->i_nlink >= max_links)
3585 error = dir->i_op->mkdir(dir, dentry, mode);
3587 fsnotify_mkdir(dir, dentry);
3590 EXPORT_SYMBOL(vfs_mkdir);
3592 SYSCALL_DEFINE3(mkdirat, int, dfd, const char __user *, pathname, umode_t, mode)
3594 struct dentry *dentry;
3597 unsigned int lookup_flags = LOOKUP_DIRECTORY;
3600 dentry = user_path_create(dfd, pathname, &path, lookup_flags);
3602 return PTR_ERR(dentry);
3604 if (!IS_POSIXACL(path.dentry->d_inode))
3605 mode &= ~current_umask();
3606 error = security_path_mkdir(&path, dentry, mode);
3608 error = vfs_mkdir(path.dentry->d_inode, dentry, mode);
3609 done_path_create(&path, dentry);
3610 if (retry_estale(error, lookup_flags)) {
3611 lookup_flags |= LOOKUP_REVAL;
3617 SYSCALL_DEFINE2(mkdir, const char __user *, pathname, umode_t, mode)
3619 return sys_mkdirat(AT_FDCWD, pathname, mode);
3623 * The dentry_unhash() helper will try to drop the dentry early: we
3624 * should have a usage count of 1 if we're the only user of this
3625 * dentry, and if that is true (possibly after pruning the dcache),
3626 * then we drop the dentry now.
3628 * A low-level filesystem can, if it choses, legally
3631 * if (!d_unhashed(dentry))
3634 * if it cannot handle the case of removing a directory
3635 * that is still in use by something else..
3637 void dentry_unhash(struct dentry *dentry)
3639 shrink_dcache_parent(dentry);
3640 spin_lock(&dentry->d_lock);
3641 if (dentry->d_lockref.count == 1)
3643 spin_unlock(&dentry->d_lock);
3645 EXPORT_SYMBOL(dentry_unhash);
3647 int vfs_rmdir(struct inode *dir, struct dentry *dentry)
3649 int error = may_delete(dir, dentry, 1);
3654 if (!dir->i_op->rmdir)
3658 mutex_lock(&dentry->d_inode->i_mutex);
3661 if (is_local_mountpoint(dentry))
3664 error = security_inode_rmdir(dir, dentry);
3668 shrink_dcache_parent(dentry);
3669 error = dir->i_op->rmdir(dir, dentry);
3673 dentry->d_inode->i_flags |= S_DEAD;
3675 detach_mounts(dentry);
3678 mutex_unlock(&dentry->d_inode->i_mutex);
3684 EXPORT_SYMBOL(vfs_rmdir);
3686 static long do_rmdir(int dfd, const char __user *pathname)
3689 struct filename *name;
3690 struct dentry *dentry;
3694 unsigned int lookup_flags = 0;
3696 name = user_path_parent(dfd, pathname,
3697 &path, &last, &type, lookup_flags);
3699 return PTR_ERR(name);
3713 error = mnt_want_write(path.mnt);
3717 mutex_lock_nested(&path.dentry->d_inode->i_mutex, I_MUTEX_PARENT);
3718 dentry = __lookup_hash(&last, path.dentry, lookup_flags);
3719 error = PTR_ERR(dentry);
3722 if (!dentry->d_inode) {
3726 error = security_path_rmdir(&path, dentry);
3729 error = vfs_rmdir(path.dentry->d_inode, dentry);
3733 mutex_unlock(&path.dentry->d_inode->i_mutex);
3734 mnt_drop_write(path.mnt);
3738 if (retry_estale(error, lookup_flags)) {
3739 lookup_flags |= LOOKUP_REVAL;
3745 SYSCALL_DEFINE1(rmdir, const char __user *, pathname)
3747 return do_rmdir(AT_FDCWD, pathname);
3751 * vfs_unlink - unlink a filesystem object
3752 * @dir: parent directory
3754 * @delegated_inode: returns victim inode, if the inode is delegated.
3756 * The caller must hold dir->i_mutex.
3758 * If vfs_unlink discovers a delegation, it will return -EWOULDBLOCK and
3759 * return a reference to the inode in delegated_inode. The caller
3760 * should then break the delegation on that inode and retry. Because
3761 * breaking a delegation may take a long time, the caller should drop
3762 * dir->i_mutex before doing so.
3764 * Alternatively, a caller may pass NULL for delegated_inode. This may
3765 * be appropriate for callers that expect the underlying filesystem not
3766 * to be NFS exported.
3768 int vfs_unlink(struct inode *dir, struct dentry *dentry, struct inode **delegated_inode)
3770 struct inode *target = dentry->d_inode;
3771 int error = may_delete(dir, dentry, 0);
3776 if (!dir->i_op->unlink)
3779 mutex_lock(&target->i_mutex);
3780 if (is_local_mountpoint(dentry))
3783 error = security_inode_unlink(dir, dentry);
3785 error = try_break_deleg(target, delegated_inode);
3788 error = dir->i_op->unlink(dir, dentry);
3791 detach_mounts(dentry);
3796 mutex_unlock(&target->i_mutex);
3798 /* We don't d_delete() NFS sillyrenamed files--they still exist. */
3799 if (!error && !(dentry->d_flags & DCACHE_NFSFS_RENAMED)) {
3800 fsnotify_link_count(target);
3806 EXPORT_SYMBOL(vfs_unlink);
3809 * Make sure that the actual truncation of the file will occur outside its
3810 * directory's i_mutex. Truncate can take a long time if there is a lot of
3811 * writeout happening, and we don't want to prevent access to the directory
3812 * while waiting on the I/O.
3814 static long do_unlinkat(int dfd, const char __user *pathname)
3817 struct filename *name;
3818 struct dentry *dentry;
3822 struct inode *inode = NULL;
3823 struct inode *delegated_inode = NULL;
3824 unsigned int lookup_flags = 0;
3826 name = user_path_parent(dfd, pathname,
3827 &path, &last, &type, lookup_flags);
3829 return PTR_ERR(name);
3832 if (type != LAST_NORM)
3835 error = mnt_want_write(path.mnt);
3839 mutex_lock_nested(&path.dentry->d_inode->i_mutex, I_MUTEX_PARENT);
3840 dentry = __lookup_hash(&last, path.dentry, lookup_flags);
3841 error = PTR_ERR(dentry);
3842 if (!IS_ERR(dentry)) {
3843 /* Why not before? Because we want correct error value */
3844 if (last.name[last.len])
3846 inode = dentry->d_inode;
3847 if (d_is_negative(dentry))
3850 error = security_path_unlink(&path, dentry);
3853 error = vfs_unlink(path.dentry->d_inode, dentry, &delegated_inode);
3857 mutex_unlock(&path.dentry->d_inode->i_mutex);
3859 iput(inode); /* truncate the inode here */
3861 if (delegated_inode) {
3862 error = break_deleg_wait(&delegated_inode);
3866 mnt_drop_write(path.mnt);
3870 if (retry_estale(error, lookup_flags)) {
3871 lookup_flags |= LOOKUP_REVAL;
3878 if (d_is_negative(dentry))
3880 else if (d_is_dir(dentry))
3887 SYSCALL_DEFINE3(unlinkat, int, dfd, const char __user *, pathname, int, flag)
3889 if ((flag & ~AT_REMOVEDIR) != 0)
3892 if (flag & AT_REMOVEDIR)
3893 return do_rmdir(dfd, pathname);
3895 return do_unlinkat(dfd, pathname);
3898 SYSCALL_DEFINE1(unlink, const char __user *, pathname)
3900 return do_unlinkat(AT_FDCWD, pathname);
3903 int vfs_symlink(struct inode *dir, struct dentry *dentry, const char *oldname)
3905 int error = may_create(dir, dentry);
3910 if (!dir->i_op->symlink)
3913 error = security_inode_symlink(dir, dentry, oldname);
3917 error = dir->i_op->symlink(dir, dentry, oldname);
3919 fsnotify_create(dir, dentry);
3922 EXPORT_SYMBOL(vfs_symlink);
3924 SYSCALL_DEFINE3(symlinkat, const char __user *, oldname,
3925 int, newdfd, const char __user *, newname)
3928 struct filename *from;
3929 struct dentry *dentry;
3931 unsigned int lookup_flags = 0;
3933 from = getname(oldname);
3935 return PTR_ERR(from);
3937 dentry = user_path_create(newdfd, newname, &path, lookup_flags);
3938 error = PTR_ERR(dentry);
3942 error = security_path_symlink(&path, dentry, from->name);
3944 error = vfs_symlink(path.dentry->d_inode, dentry, from->name);
3945 done_path_create(&path, dentry);
3946 if (retry_estale(error, lookup_flags)) {
3947 lookup_flags |= LOOKUP_REVAL;
3955 SYSCALL_DEFINE2(symlink, const char __user *, oldname, const char __user *, newname)
3957 return sys_symlinkat(oldname, AT_FDCWD, newname);
3961 * vfs_link - create a new link
3962 * @old_dentry: object to be linked
3964 * @new_dentry: where to create the new link
3965 * @delegated_inode: returns inode needing a delegation break
3967 * The caller must hold dir->i_mutex
3969 * If vfs_link discovers a delegation on the to-be-linked file in need
3970 * of breaking, it will return -EWOULDBLOCK and return a reference to the
3971 * inode in delegated_inode. The caller should then break the delegation
3972 * and retry. Because breaking a delegation may take a long time, the
3973 * caller should drop the i_mutex before doing so.
3975 * Alternatively, a caller may pass NULL for delegated_inode. This may
3976 * be appropriate for callers that expect the underlying filesystem not
3977 * to be NFS exported.
3979 int vfs_link(struct dentry *old_dentry, struct inode *dir, struct dentry *new_dentry, struct inode **delegated_inode)
3981 struct inode *inode = old_dentry->d_inode;
3982 unsigned max_links = dir->i_sb->s_max_links;
3988 error = may_create(dir, new_dentry);
3992 if (dir->i_sb != inode->i_sb)
3996 * A link to an append-only or immutable file cannot be created.
3998 if (IS_APPEND(inode) || IS_IMMUTABLE(inode))
4000 if (!dir->i_op->link)
4002 if (S_ISDIR(inode->i_mode))
4005 error = security_inode_link(old_dentry, dir, new_dentry);
4009 mutex_lock(&inode->i_mutex);
4010 /* Make sure we don't allow creating hardlink to an unlinked file */
4011 if (inode->i_nlink == 0 && !(inode->i_state & I_LINKABLE))
4013 else if (max_links && inode->i_nlink >= max_links)
4016 error = try_break_deleg(inode, delegated_inode);
4018 error = dir->i_op->link(old_dentry, dir, new_dentry);
4021 if (!error && (inode->i_state & I_LINKABLE)) {
4022 spin_lock(&inode->i_lock);
4023 inode->i_state &= ~I_LINKABLE;
4024 spin_unlock(&inode->i_lock);
4026 mutex_unlock(&inode->i_mutex);
4028 fsnotify_link(dir, inode, new_dentry);
4031 EXPORT_SYMBOL(vfs_link);
4034 * Hardlinks are often used in delicate situations. We avoid
4035 * security-related surprises by not following symlinks on the
4038 * We don't follow them on the oldname either to be compatible
4039 * with linux 2.0, and to avoid hard-linking to directories
4040 * and other special files. --ADM
4042 SYSCALL_DEFINE5(linkat, int, olddfd, const char __user *, oldname,
4043 int, newdfd, const char __user *, newname, int, flags)
4045 struct dentry *new_dentry;
4046 struct path old_path, new_path;
4047 struct inode *delegated_inode = NULL;
4051 if ((flags & ~(AT_SYMLINK_FOLLOW | AT_EMPTY_PATH)) != 0)
4054 * To use null names we require CAP_DAC_READ_SEARCH
4055 * This ensures that not everyone will be able to create
4056 * handlink using the passed filedescriptor.
4058 if (flags & AT_EMPTY_PATH) {
4059 if (!capable(CAP_DAC_READ_SEARCH))
4064 if (flags & AT_SYMLINK_FOLLOW)
4065 how |= LOOKUP_FOLLOW;
4067 error = user_path_at(olddfd, oldname, how, &old_path);
4071 new_dentry = user_path_create(newdfd, newname, &new_path,
4072 (how & LOOKUP_REVAL));
4073 error = PTR_ERR(new_dentry);
4074 if (IS_ERR(new_dentry))
4078 if (old_path.mnt != new_path.mnt)
4080 error = may_linkat(&old_path);
4081 if (unlikely(error))
4083 error = security_path_link(old_path.dentry, &new_path, new_dentry);
4086 error = vfs_link(old_path.dentry, new_path.dentry->d_inode, new_dentry, &delegated_inode);
4088 done_path_create(&new_path, new_dentry);
4089 if (delegated_inode) {
4090 error = break_deleg_wait(&delegated_inode);
4092 path_put(&old_path);
4096 if (retry_estale(error, how)) {
4097 path_put(&old_path);
4098 how |= LOOKUP_REVAL;
4102 path_put(&old_path);
4107 SYSCALL_DEFINE2(link, const char __user *, oldname, const char __user *, newname)
4109 return sys_linkat(AT_FDCWD, oldname, AT_FDCWD, newname, 0);
4113 * vfs_rename - rename a filesystem object
4114 * @old_dir: parent of source
4115 * @old_dentry: source
4116 * @new_dir: parent of destination
4117 * @new_dentry: destination
4118 * @delegated_inode: returns an inode needing a delegation break
4119 * @flags: rename flags
4121 * The caller must hold multiple mutexes--see lock_rename()).
4123 * If vfs_rename discovers a delegation in need of breaking at either
4124 * the source or destination, it will return -EWOULDBLOCK and return a
4125 * reference to the inode in delegated_inode. The caller should then
4126 * break the delegation and retry. Because breaking a delegation may
4127 * take a long time, the caller should drop all locks before doing
4130 * Alternatively, a caller may pass NULL for delegated_inode. This may
4131 * be appropriate for callers that expect the underlying filesystem not
4132 * to be NFS exported.
4134 * The worst of all namespace operations - renaming directory. "Perverted"
4135 * doesn't even start to describe it. Somebody in UCB had a heck of a trip...
4137 * a) we can get into loop creation.
4138 * b) race potential - two innocent renames can create a loop together.
4139 * That's where 4.4 screws up. Current fix: serialization on
4140 * sb->s_vfs_rename_mutex. We might be more accurate, but that's another
4142 * c) we have to lock _four_ objects - parents and victim (if it exists),
4143 * and source (if it is not a directory).
4144 * And that - after we got ->i_mutex on parents (until then we don't know
4145 * whether the target exists). Solution: try to be smart with locking
4146 * order for inodes. We rely on the fact that tree topology may change
4147 * only under ->s_vfs_rename_mutex _and_ that parent of the object we
4148 * move will be locked. Thus we can rank directories by the tree
4149 * (ancestors first) and rank all non-directories after them.
4150 * That works since everybody except rename does "lock parent, lookup,
4151 * lock child" and rename is under ->s_vfs_rename_mutex.
4152 * HOWEVER, it relies on the assumption that any object with ->lookup()
4153 * has no more than 1 dentry. If "hybrid" objects will ever appear,
4154 * we'd better make sure that there's no link(2) for them.
4155 * d) conversion from fhandle to dentry may come in the wrong moment - when
4156 * we are removing the target. Solution: we will have to grab ->i_mutex
4157 * in the fhandle_to_dentry code. [FIXME - current nfsfh.c relies on
4158 * ->i_mutex on parents, which works but leads to some truly excessive
4161 int vfs_rename(struct inode *old_dir, struct dentry *old_dentry,
4162 struct inode *new_dir, struct dentry *new_dentry,
4163 struct inode **delegated_inode, unsigned int flags)
4166 bool is_dir = d_is_dir(old_dentry);
4167 const unsigned char *old_name;
4168 struct inode *source = old_dentry->d_inode;
4169 struct inode *target = new_dentry->d_inode;
4170 bool new_is_dir = false;
4171 unsigned max_links = new_dir->i_sb->s_max_links;
4173 if (source == target)
4176 error = may_delete(old_dir, old_dentry, is_dir);
4181 error = may_create(new_dir, new_dentry);
4183 new_is_dir = d_is_dir(new_dentry);
4185 if (!(flags & RENAME_EXCHANGE))
4186 error = may_delete(new_dir, new_dentry, is_dir);
4188 error = may_delete(new_dir, new_dentry, new_is_dir);
4193 if (!old_dir->i_op->rename && !old_dir->i_op->rename2)
4196 if (flags && !old_dir->i_op->rename2)
4200 * If we are going to change the parent - check write permissions,
4201 * we'll need to flip '..'.
4203 if (new_dir != old_dir) {
4205 error = inode_permission(source, MAY_WRITE);
4209 if ((flags & RENAME_EXCHANGE) && new_is_dir) {
4210 error = inode_permission(target, MAY_WRITE);
4216 error = security_inode_rename(old_dir, old_dentry, new_dir, new_dentry,
4221 old_name = fsnotify_oldname_init(old_dentry->d_name.name);
4223 if (!is_dir || (flags & RENAME_EXCHANGE))
4224 lock_two_nondirectories(source, target);
4226 mutex_lock(&target->i_mutex);
4229 if (is_local_mountpoint(old_dentry) || is_local_mountpoint(new_dentry))
4232 if (max_links && new_dir != old_dir) {
4234 if (is_dir && !new_is_dir && new_dir->i_nlink >= max_links)
4236 if ((flags & RENAME_EXCHANGE) && !is_dir && new_is_dir &&
4237 old_dir->i_nlink >= max_links)
4240 if (is_dir && !(flags & RENAME_EXCHANGE) && target)
4241 shrink_dcache_parent(new_dentry);
4243 error = try_break_deleg(source, delegated_inode);
4247 if (target && !new_is_dir) {
4248 error = try_break_deleg(target, delegated_inode);
4252 if (!old_dir->i_op->rename2) {
4253 error = old_dir->i_op->rename(old_dir, old_dentry,
4254 new_dir, new_dentry);
4256 WARN_ON(old_dir->i_op->rename != NULL);
4257 error = old_dir->i_op->rename2(old_dir, old_dentry,
4258 new_dir, new_dentry, flags);
4263 if (!(flags & RENAME_EXCHANGE) && target) {
4265 target->i_flags |= S_DEAD;
4266 dont_mount(new_dentry);
4267 detach_mounts(new_dentry);
4269 if (!(old_dir->i_sb->s_type->fs_flags & FS_RENAME_DOES_D_MOVE)) {
4270 if (!(flags & RENAME_EXCHANGE))
4271 d_move(old_dentry, new_dentry);
4273 d_exchange(old_dentry, new_dentry);
4276 if (!is_dir || (flags & RENAME_EXCHANGE))
4277 unlock_two_nondirectories(source, target);
4279 mutex_unlock(&target->i_mutex);
4282 fsnotify_move(old_dir, new_dir, old_name, is_dir,
4283 !(flags & RENAME_EXCHANGE) ? target : NULL, old_dentry);
4284 if (flags & RENAME_EXCHANGE) {
4285 fsnotify_move(new_dir, old_dir, old_dentry->d_name.name,
4286 new_is_dir, NULL, new_dentry);
4289 fsnotify_oldname_free(old_name);
4293 EXPORT_SYMBOL(vfs_rename);
4295 SYSCALL_DEFINE5(renameat2, int, olddfd, const char __user *, oldname,
4296 int, newdfd, const char __user *, newname, unsigned int, flags)
4298 struct dentry *old_dentry, *new_dentry;
4299 struct dentry *trap;
4300 struct path old_path, new_path;
4301 struct qstr old_last, new_last;
4302 int old_type, new_type;
4303 struct inode *delegated_inode = NULL;
4304 struct filename *from;
4305 struct filename *to;
4306 unsigned int lookup_flags = 0, target_flags = LOOKUP_RENAME_TARGET;
4307 bool should_retry = false;
4310 if (flags & ~(RENAME_NOREPLACE | RENAME_EXCHANGE | RENAME_WHITEOUT))
4313 if ((flags & (RENAME_NOREPLACE | RENAME_WHITEOUT)) &&
4314 (flags & RENAME_EXCHANGE))
4317 if ((flags & RENAME_WHITEOUT) && !capable(CAP_MKNOD))
4320 if (flags & RENAME_EXCHANGE)
4324 from = user_path_parent(olddfd, oldname,
4325 &old_path, &old_last, &old_type, lookup_flags);
4327 error = PTR_ERR(from);
4331 to = user_path_parent(newdfd, newname,
4332 &new_path, &new_last, &new_type, lookup_flags);
4334 error = PTR_ERR(to);
4339 if (old_path.mnt != new_path.mnt)
4343 if (old_type != LAST_NORM)
4346 if (flags & RENAME_NOREPLACE)
4348 if (new_type != LAST_NORM)
4351 error = mnt_want_write(old_path.mnt);
4356 trap = lock_rename(new_path.dentry, old_path.dentry);
4358 old_dentry = __lookup_hash(&old_last, old_path.dentry, lookup_flags);
4359 error = PTR_ERR(old_dentry);
4360 if (IS_ERR(old_dentry))
4362 /* source must exist */
4364 if (d_is_negative(old_dentry))
4366 new_dentry = __lookup_hash(&new_last, new_path.dentry, lookup_flags | target_flags);
4367 error = PTR_ERR(new_dentry);
4368 if (IS_ERR(new_dentry))
4371 if ((flags & RENAME_NOREPLACE) && d_is_positive(new_dentry))
4373 if (flags & RENAME_EXCHANGE) {
4375 if (d_is_negative(new_dentry))
4378 if (!d_is_dir(new_dentry)) {
4380 if (new_last.name[new_last.len])
4384 /* unless the source is a directory trailing slashes give -ENOTDIR */
4385 if (!d_is_dir(old_dentry)) {
4387 if (old_last.name[old_last.len])
4389 if (!(flags & RENAME_EXCHANGE) && new_last.name[new_last.len])
4392 /* source should not be ancestor of target */
4394 if (old_dentry == trap)
4396 /* target should not be an ancestor of source */
4397 if (!(flags & RENAME_EXCHANGE))
4399 if (new_dentry == trap)
4402 error = security_path_rename(&old_path, old_dentry,
4403 &new_path, new_dentry, flags);
4406 error = vfs_rename(old_path.dentry->d_inode, old_dentry,
4407 new_path.dentry->d_inode, new_dentry,
4408 &delegated_inode, flags);
4414 unlock_rename(new_path.dentry, old_path.dentry);
4415 if (delegated_inode) {
4416 error = break_deleg_wait(&delegated_inode);
4420 mnt_drop_write(old_path.mnt);
4422 if (retry_estale(error, lookup_flags))
4423 should_retry = true;
4424 path_put(&new_path);
4427 path_put(&old_path);
4430 should_retry = false;
4431 lookup_flags |= LOOKUP_REVAL;
4438 SYSCALL_DEFINE4(renameat, int, olddfd, const char __user *, oldname,
4439 int, newdfd, const char __user *, newname)
4441 return sys_renameat2(olddfd, oldname, newdfd, newname, 0);
4444 SYSCALL_DEFINE2(rename, const char __user *, oldname, const char __user *, newname)
4446 return sys_renameat2(AT_FDCWD, oldname, AT_FDCWD, newname, 0);
4449 int vfs_whiteout(struct inode *dir, struct dentry *dentry)
4451 int error = may_create(dir, dentry);
4455 if (!dir->i_op->mknod)
4458 return dir->i_op->mknod(dir, dentry,
4459 S_IFCHR | WHITEOUT_MODE, WHITEOUT_DEV);
4461 EXPORT_SYMBOL(vfs_whiteout);
4463 int readlink_copy(char __user *buffer, int buflen, const char *link)
4465 int len = PTR_ERR(link);
4470 if (len > (unsigned) buflen)
4472 if (copy_to_user(buffer, link, len))
4477 EXPORT_SYMBOL(readlink_copy);
4480 * A helper for ->readlink(). This should be used *ONLY* for symlinks that
4481 * have ->follow_link() touching nd only in nd_set_link(). Using (or not
4482 * using) it for any given inode is up to filesystem.
4484 int generic_readlink(struct dentry *dentry, char __user *buffer, int buflen)
4487 const char *link = dentry->d_inode->i_link;
4491 link = dentry->d_inode->i_op->follow_link(dentry, &cookie, NULL);
4493 return PTR_ERR(link);
4495 res = readlink_copy(buffer, buflen, link);
4496 if (cookie && dentry->d_inode->i_op->put_link)
4497 dentry->d_inode->i_op->put_link(dentry, cookie);
4500 EXPORT_SYMBOL(generic_readlink);
4502 /* get the link contents into pagecache */
4503 static char *page_getlink(struct dentry * dentry, struct page **ppage)
4507 struct address_space *mapping = dentry->d_inode->i_mapping;
4508 page = read_mapping_page(mapping, 0, NULL);
4513 nd_terminate_link(kaddr, dentry->d_inode->i_size, PAGE_SIZE - 1);
4517 int page_readlink(struct dentry *dentry, char __user *buffer, int buflen)
4519 struct page *page = NULL;
4520 int res = readlink_copy(buffer, buflen, page_getlink(dentry, &page));
4523 page_cache_release(page);
4527 EXPORT_SYMBOL(page_readlink);
4529 const char *page_follow_link_light(struct dentry *dentry, void **cookie, struct nameidata *nd)
4531 struct page *page = NULL;
4532 char *res = page_getlink(dentry, &page);
4537 EXPORT_SYMBOL(page_follow_link_light);
4539 void page_put_link(struct dentry *dentry, void *cookie)
4541 struct page *page = cookie;
4543 page_cache_release(page);
4545 EXPORT_SYMBOL(page_put_link);
4548 * The nofs argument instructs pagecache_write_begin to pass AOP_FLAG_NOFS
4550 int __page_symlink(struct inode *inode, const char *symname, int len, int nofs)
4552 struct address_space *mapping = inode->i_mapping;
4557 unsigned int flags = AOP_FLAG_UNINTERRUPTIBLE;
4559 flags |= AOP_FLAG_NOFS;
4562 err = pagecache_write_begin(NULL, mapping, 0, len-1,
4563 flags, &page, &fsdata);
4567 kaddr = kmap_atomic(page);
4568 memcpy(kaddr, symname, len-1);
4569 kunmap_atomic(kaddr);
4571 err = pagecache_write_end(NULL, mapping, 0, len-1, len-1,
4578 mark_inode_dirty(inode);
4583 EXPORT_SYMBOL(__page_symlink);
4585 int page_symlink(struct inode *inode, const char *symname, int len)
4587 return __page_symlink(inode, symname, len,
4588 !(mapping_gfp_mask(inode->i_mapping) & __GFP_FS));
4590 EXPORT_SYMBOL(page_symlink);
4592 const struct inode_operations page_symlink_inode_operations = {
4593 .readlink = generic_readlink,
4594 .follow_link = page_follow_link_light,
4595 .put_link = page_put_link,
4597 EXPORT_SYMBOL(page_symlink_inode_operations);