38ab5188124702759e9592075e8b2c117f67c857
[linux-2.6-microblaze.git] / fs / namei.c
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  *  linux/fs/namei.c
4  *
5  *  Copyright (C) 1991, 1992  Linus Torvalds
6  */
7
8 /*
9  * Some corrections by tytso.
10  */
11
12 /* [Feb 1997 T. Schoebel-Theuer] Complete rewrite of the pathname
13  * lookup logic.
14  */
15 /* [Feb-Apr 2000, AV] Rewrite to the new namespace architecture.
16  */
17
18 #include <linux/init.h>
19 #include <linux/export.h>
20 #include <linux/kernel.h>
21 #include <linux/slab.h>
22 #include <linux/fs.h>
23 #include <linux/namei.h>
24 #include <linux/pagemap.h>
25 #include <linux/fsnotify.h>
26 #include <linux/personality.h>
27 #include <linux/security.h>
28 #include <linux/ima.h>
29 #include <linux/syscalls.h>
30 #include <linux/mount.h>
31 #include <linux/audit.h>
32 #include <linux/capability.h>
33 #include <linux/file.h>
34 #include <linux/fcntl.h>
35 #include <linux/device_cgroup.h>
36 #include <linux/fs_struct.h>
37 #include <linux/posix_acl.h>
38 #include <linux/hash.h>
39 #include <linux/bitops.h>
40 #include <linux/init_task.h>
41 #include <linux/uaccess.h>
42
43 #include "internal.h"
44 #include "mount.h"
45
46 /* [Feb-1997 T. Schoebel-Theuer]
47  * Fundamental changes in the pathname lookup mechanisms (namei)
48  * were necessary because of omirr.  The reason is that omirr needs
49  * to know the _real_ pathname, not the user-supplied one, in case
50  * of symlinks (and also when transname replacements occur).
51  *
52  * The new code replaces the old recursive symlink resolution with
53  * an iterative one (in case of non-nested symlink chains).  It does
54  * this with calls to <fs>_follow_link().
55  * As a side effect, dir_namei(), _namei() and follow_link() are now 
56  * replaced with a single function lookup_dentry() that can handle all 
57  * the special cases of the former code.
58  *
59  * With the new dcache, the pathname is stored at each inode, at least as
60  * long as the refcount of the inode is positive.  As a side effect, the
61  * size of the dcache depends on the inode cache and thus is dynamic.
62  *
63  * [29-Apr-1998 C. Scott Ananian] Updated above description of symlink
64  * resolution to correspond with current state of the code.
65  *
66  * Note that the symlink resolution is not *completely* iterative.
67  * There is still a significant amount of tail- and mid- recursion in
68  * the algorithm.  Also, note that <fs>_readlink() is not used in
69  * lookup_dentry(): lookup_dentry() on the result of <fs>_readlink()
70  * may return different results than <fs>_follow_link().  Many virtual
71  * filesystems (including /proc) exhibit this behavior.
72  */
73
74 /* [24-Feb-97 T. Schoebel-Theuer] Side effects caused by new implementation:
75  * New symlink semantics: when open() is called with flags O_CREAT | O_EXCL
76  * and the name already exists in form of a symlink, try to create the new
77  * name indicated by the symlink. The old code always complained that the
78  * name already exists, due to not following the symlink even if its target
79  * is nonexistent.  The new semantics affects also mknod() and link() when
80  * the name is a symlink pointing to a non-existent name.
81  *
82  * I don't know which semantics is the right one, since I have no access
83  * to standards. But I found by trial that HP-UX 9.0 has the full "new"
84  * semantics implemented, while SunOS 4.1.1 and Solaris (SunOS 5.4) have the
85  * "old" one. Personally, I think the new semantics is much more logical.
86  * Note that "ln old new" where "new" is a symlink pointing to a non-existing
87  * file does succeed in both HP-UX and SunOs, but not in Solaris
88  * and in the old Linux semantics.
89  */
90
91 /* [16-Dec-97 Kevin Buhr] For security reasons, we change some symlink
92  * semantics.  See the comments in "open_namei" and "do_link" below.
93  *
94  * [10-Sep-98 Alan Modra] Another symlink change.
95  */
96
97 /* [Feb-Apr 2000 AV] Complete rewrite. Rules for symlinks:
98  *      inside the path - always follow.
99  *      in the last component in creation/removal/renaming - never follow.
100  *      if LOOKUP_FOLLOW passed - follow.
101  *      if the pathname has trailing slashes - follow.
102  *      otherwise - don't follow.
103  * (applied in that order).
104  *
105  * [Jun 2000 AV] Inconsistent behaviour of open() in case if flags==O_CREAT
106  * restored for 2.4. This is the last surviving part of old 4.2BSD bug.
107  * During the 2.4 we need to fix the userland stuff depending on it -
108  * hopefully we will be able to get rid of that wart in 2.5. So far only
109  * XEmacs seems to be relying on it...
110  */
111 /*
112  * [Sep 2001 AV] Single-semaphore locking scheme (kudos to David Holland)
113  * implemented.  Let's see if raised priority of ->s_vfs_rename_mutex gives
114  * any extra contention...
115  */
116
117 /* In order to reduce some races, while at the same time doing additional
118  * checking and hopefully speeding things up, we copy filenames to the
119  * kernel data space before using them..
120  *
121  * POSIX.1 2.4: an empty pathname is invalid (ENOENT).
122  * PATH_MAX includes the nul terminator --RR.
123  */
124
125 #define EMBEDDED_NAME_MAX       (PATH_MAX - offsetof(struct filename, iname))
126
127 struct filename *
128 getname_flags(const char __user *filename, int flags, int *empty)
129 {
130         struct filename *result;
131         char *kname;
132         int len;
133
134         result = audit_reusename(filename);
135         if (result)
136                 return result;
137
138         result = __getname();
139         if (unlikely(!result))
140                 return ERR_PTR(-ENOMEM);
141
142         /*
143          * First, try to embed the struct filename inside the names_cache
144          * allocation
145          */
146         kname = (char *)result->iname;
147         result->name = kname;
148
149         len = strncpy_from_user(kname, filename, EMBEDDED_NAME_MAX);
150         if (unlikely(len < 0)) {
151                 __putname(result);
152                 return ERR_PTR(len);
153         }
154
155         /*
156          * Uh-oh. We have a name that's approaching PATH_MAX. Allocate a
157          * separate struct filename so we can dedicate the entire
158          * names_cache allocation for the pathname, and re-do the copy from
159          * userland.
160          */
161         if (unlikely(len == EMBEDDED_NAME_MAX)) {
162                 const size_t size = offsetof(struct filename, iname[1]);
163                 kname = (char *)result;
164
165                 /*
166                  * size is chosen that way we to guarantee that
167                  * result->iname[0] is within the same object and that
168                  * kname can't be equal to result->iname, no matter what.
169                  */
170                 result = kzalloc(size, GFP_KERNEL);
171                 if (unlikely(!result)) {
172                         __putname(kname);
173                         return ERR_PTR(-ENOMEM);
174                 }
175                 result->name = kname;
176                 len = strncpy_from_user(kname, filename, PATH_MAX);
177                 if (unlikely(len < 0)) {
178                         __putname(kname);
179                         kfree(result);
180                         return ERR_PTR(len);
181                 }
182                 if (unlikely(len == PATH_MAX)) {
183                         __putname(kname);
184                         kfree(result);
185                         return ERR_PTR(-ENAMETOOLONG);
186                 }
187         }
188
189         result->refcnt = 1;
190         /* The empty path is special. */
191         if (unlikely(!len)) {
192                 if (empty)
193                         *empty = 1;
194                 if (!(flags & LOOKUP_EMPTY)) {
195                         putname(result);
196                         return ERR_PTR(-ENOENT);
197                 }
198         }
199
200         result->uptr = filename;
201         result->aname = NULL;
202         audit_getname(result);
203         return result;
204 }
205
206 struct filename *
207 getname(const char __user * filename)
208 {
209         return getname_flags(filename, 0, NULL);
210 }
211
212 struct filename *
213 getname_kernel(const char * filename)
214 {
215         struct filename *result;
216         int len = strlen(filename) + 1;
217
218         result = __getname();
219         if (unlikely(!result))
220                 return ERR_PTR(-ENOMEM);
221
222         if (len <= EMBEDDED_NAME_MAX) {
223                 result->name = (char *)result->iname;
224         } else if (len <= PATH_MAX) {
225                 const size_t size = offsetof(struct filename, iname[1]);
226                 struct filename *tmp;
227
228                 tmp = kmalloc(size, GFP_KERNEL);
229                 if (unlikely(!tmp)) {
230                         __putname(result);
231                         return ERR_PTR(-ENOMEM);
232                 }
233                 tmp->name = (char *)result;
234                 result = tmp;
235         } else {
236                 __putname(result);
237                 return ERR_PTR(-ENAMETOOLONG);
238         }
239         memcpy((char *)result->name, filename, len);
240         result->uptr = NULL;
241         result->aname = NULL;
242         result->refcnt = 1;
243         audit_getname(result);
244
245         return result;
246 }
247
248 void putname(struct filename *name)
249 {
250         BUG_ON(name->refcnt <= 0);
251
252         if (--name->refcnt > 0)
253                 return;
254
255         if (name->name != name->iname) {
256                 __putname(name->name);
257                 kfree(name);
258         } else
259                 __putname(name);
260 }
261
262 /**
263  * check_acl - perform ACL permission checking
264  * @mnt_userns: user namespace of the mount the inode was found from
265  * @inode:      inode to check permissions on
266  * @mask:       right to check for (%MAY_READ, %MAY_WRITE, %MAY_EXEC ...)
267  *
268  * This function performs the ACL permission checking. Since this function
269  * retrieve POSIX acls it needs to know whether it is called from a blocking or
270  * non-blocking context and thus cares about the MAY_NOT_BLOCK bit.
271  *
272  * If the inode has been found through an idmapped mount the user namespace of
273  * the vfsmount must be passed through @mnt_userns. This function will then take
274  * care to map the inode according to @mnt_userns before checking permissions.
275  * On non-idmapped mounts or if permission checking is to be performed on the
276  * raw inode simply passs init_user_ns.
277  */
278 static int check_acl(struct user_namespace *mnt_userns,
279                      struct inode *inode, int mask)
280 {
281 #ifdef CONFIG_FS_POSIX_ACL
282         struct posix_acl *acl;
283
284         if (mask & MAY_NOT_BLOCK) {
285                 acl = get_cached_acl_rcu(inode, ACL_TYPE_ACCESS);
286                 if (!acl)
287                         return -EAGAIN;
288                 /* no ->get_acl() calls in RCU mode... */
289                 if (is_uncached_acl(acl))
290                         return -ECHILD;
291                 return posix_acl_permission(mnt_userns, inode, acl, mask);
292         }
293
294         acl = get_acl(inode, ACL_TYPE_ACCESS);
295         if (IS_ERR(acl))
296                 return PTR_ERR(acl);
297         if (acl) {
298                 int error = posix_acl_permission(mnt_userns, inode, acl, mask);
299                 posix_acl_release(acl);
300                 return error;
301         }
302 #endif
303
304         return -EAGAIN;
305 }
306
307 /**
308  * acl_permission_check - perform basic UNIX permission checking
309  * @mnt_userns: user namespace of the mount the inode was found from
310  * @inode:      inode to check permissions on
311  * @mask:       right to check for (%MAY_READ, %MAY_WRITE, %MAY_EXEC ...)
312  *
313  * This function performs the basic UNIX permission checking. Since this
314  * function may retrieve POSIX acls it needs to know whether it is called from a
315  * blocking or non-blocking context and thus cares about the MAY_NOT_BLOCK bit.
316  *
317  * If the inode has been found through an idmapped mount the user namespace of
318  * the vfsmount must be passed through @mnt_userns. This function will then take
319  * care to map the inode according to @mnt_userns before checking permissions.
320  * On non-idmapped mounts or if permission checking is to be performed on the
321  * raw inode simply passs init_user_ns.
322  */
323 static int acl_permission_check(struct user_namespace *mnt_userns,
324                                 struct inode *inode, int mask)
325 {
326         unsigned int mode = inode->i_mode;
327         kuid_t i_uid;
328
329         /* Are we the owner? If so, ACL's don't matter */
330         i_uid = i_uid_into_mnt(mnt_userns, inode);
331         if (likely(uid_eq(current_fsuid(), i_uid))) {
332                 mask &= 7;
333                 mode >>= 6;
334                 return (mask & ~mode) ? -EACCES : 0;
335         }
336
337         /* Do we have ACL's? */
338         if (IS_POSIXACL(inode) && (mode & S_IRWXG)) {
339                 int error = check_acl(mnt_userns, inode, mask);
340                 if (error != -EAGAIN)
341                         return error;
342         }
343
344         /* Only RWX matters for group/other mode bits */
345         mask &= 7;
346
347         /*
348          * Are the group permissions different from
349          * the other permissions in the bits we care
350          * about? Need to check group ownership if so.
351          */
352         if (mask & (mode ^ (mode >> 3))) {
353                 kgid_t kgid = i_gid_into_mnt(mnt_userns, inode);
354                 if (in_group_p(kgid))
355                         mode >>= 3;
356         }
357
358         /* Bits in 'mode' clear that we require? */
359         return (mask & ~mode) ? -EACCES : 0;
360 }
361
362 /**
363  * generic_permission -  check for access rights on a Posix-like filesystem
364  * @mnt_userns: user namespace of the mount the inode was found from
365  * @inode:      inode to check access rights for
366  * @mask:       right to check for (%MAY_READ, %MAY_WRITE, %MAY_EXEC,
367  *              %MAY_NOT_BLOCK ...)
368  *
369  * Used to check for read/write/execute permissions on a file.
370  * We use "fsuid" for this, letting us set arbitrary permissions
371  * for filesystem access without changing the "normal" uids which
372  * are used for other things.
373  *
374  * generic_permission is rcu-walk aware. It returns -ECHILD in case an rcu-walk
375  * request cannot be satisfied (eg. requires blocking or too much complexity).
376  * It would then be called again in ref-walk mode.
377  *
378  * If the inode has been found through an idmapped mount the user namespace of
379  * the vfsmount must be passed through @mnt_userns. This function will then take
380  * care to map the inode according to @mnt_userns before checking permissions.
381  * On non-idmapped mounts or if permission checking is to be performed on the
382  * raw inode simply passs init_user_ns.
383  */
384 int generic_permission(struct user_namespace *mnt_userns, struct inode *inode,
385                        int mask)
386 {
387         int ret;
388
389         /*
390          * Do the basic permission checks.
391          */
392         ret = acl_permission_check(mnt_userns, inode, mask);
393         if (ret != -EACCES)
394                 return ret;
395
396         if (S_ISDIR(inode->i_mode)) {
397                 /* DACs are overridable for directories */
398                 if (!(mask & MAY_WRITE))
399                         if (capable_wrt_inode_uidgid(mnt_userns, inode,
400                                                      CAP_DAC_READ_SEARCH))
401                                 return 0;
402                 if (capable_wrt_inode_uidgid(mnt_userns, inode,
403                                              CAP_DAC_OVERRIDE))
404                         return 0;
405                 return -EACCES;
406         }
407
408         /*
409          * Searching includes executable on directories, else just read.
410          */
411         mask &= MAY_READ | MAY_WRITE | MAY_EXEC;
412         if (mask == MAY_READ)
413                 if (capable_wrt_inode_uidgid(mnt_userns, inode,
414                                              CAP_DAC_READ_SEARCH))
415                         return 0;
416         /*
417          * Read/write DACs are always overridable.
418          * Executable DACs are overridable when there is
419          * at least one exec bit set.
420          */
421         if (!(mask & MAY_EXEC) || (inode->i_mode & S_IXUGO))
422                 if (capable_wrt_inode_uidgid(mnt_userns, inode,
423                                              CAP_DAC_OVERRIDE))
424                         return 0;
425
426         return -EACCES;
427 }
428 EXPORT_SYMBOL(generic_permission);
429
430 /**
431  * do_inode_permission - UNIX permission checking
432  * @mnt_userns: user namespace of the mount the inode was found from
433  * @inode:      inode to check permissions on
434  * @mask:       right to check for (%MAY_READ, %MAY_WRITE, %MAY_EXEC ...)
435  *
436  * We _really_ want to just do "generic_permission()" without
437  * even looking at the inode->i_op values. So we keep a cache
438  * flag in inode->i_opflags, that says "this has not special
439  * permission function, use the fast case".
440  */
441 static inline int do_inode_permission(struct user_namespace *mnt_userns,
442                                       struct inode *inode, int mask)
443 {
444         if (unlikely(!(inode->i_opflags & IOP_FASTPERM))) {
445                 if (likely(inode->i_op->permission))
446                         return inode->i_op->permission(inode, mask);
447
448                 /* This gets set once for the inode lifetime */
449                 spin_lock(&inode->i_lock);
450                 inode->i_opflags |= IOP_FASTPERM;
451                 spin_unlock(&inode->i_lock);
452         }
453         return generic_permission(mnt_userns, inode, mask);
454 }
455
456 /**
457  * sb_permission - Check superblock-level permissions
458  * @sb: Superblock of inode to check permission on
459  * @inode: Inode to check permission on
460  * @mask: Right to check for (%MAY_READ, %MAY_WRITE, %MAY_EXEC)
461  *
462  * Separate out file-system wide checks from inode-specific permission checks.
463  */
464 static int sb_permission(struct super_block *sb, struct inode *inode, int mask)
465 {
466         if (unlikely(mask & MAY_WRITE)) {
467                 umode_t mode = inode->i_mode;
468
469                 /* Nobody gets write access to a read-only fs. */
470                 if (sb_rdonly(sb) && (S_ISREG(mode) || S_ISDIR(mode) || S_ISLNK(mode)))
471                         return -EROFS;
472         }
473         return 0;
474 }
475
476 /**
477  * inode_permission - Check for access rights to a given inode
478  * @mnt_userns: User namespace of the mount the inode was found from
479  * @inode:      Inode to check permission on
480  * @mask:       Right to check for (%MAY_READ, %MAY_WRITE, %MAY_EXEC)
481  *
482  * Check for read/write/execute permissions on an inode.  We use fs[ug]id for
483  * this, letting us set arbitrary permissions for filesystem access without
484  * changing the "normal" UIDs which are used for other things.
485  *
486  * When checking for MAY_APPEND, MAY_WRITE must also be set in @mask.
487  */
488 int inode_permission(struct user_namespace *mnt_userns,
489                      struct inode *inode, int mask)
490 {
491         int retval;
492
493         retval = sb_permission(inode->i_sb, inode, mask);
494         if (retval)
495                 return retval;
496
497         if (unlikely(mask & MAY_WRITE)) {
498                 /*
499                  * Nobody gets write access to an immutable file.
500                  */
501                 if (IS_IMMUTABLE(inode))
502                         return -EPERM;
503
504                 /*
505                  * Updating mtime will likely cause i_uid and i_gid to be
506                  * written back improperly if their true value is unknown
507                  * to the vfs.
508                  */
509                 if (HAS_UNMAPPED_ID(mnt_userns, inode))
510                         return -EACCES;
511         }
512
513         retval = do_inode_permission(mnt_userns, inode, mask);
514         if (retval)
515                 return retval;
516
517         retval = devcgroup_inode_permission(inode, mask);
518         if (retval)
519                 return retval;
520
521         return security_inode_permission(inode, mask);
522 }
523 EXPORT_SYMBOL(inode_permission);
524
525 /**
526  * path_get - get a reference to a path
527  * @path: path to get the reference to
528  *
529  * Given a path increment the reference count to the dentry and the vfsmount.
530  */
531 void path_get(const struct path *path)
532 {
533         mntget(path->mnt);
534         dget(path->dentry);
535 }
536 EXPORT_SYMBOL(path_get);
537
538 /**
539  * path_put - put a reference to a path
540  * @path: path to put the reference to
541  *
542  * Given a path decrement the reference count to the dentry and the vfsmount.
543  */
544 void path_put(const struct path *path)
545 {
546         dput(path->dentry);
547         mntput(path->mnt);
548 }
549 EXPORT_SYMBOL(path_put);
550
551 #define EMBEDDED_LEVELS 2
552 struct nameidata {
553         struct path     path;
554         struct qstr     last;
555         struct path     root;
556         struct inode    *inode; /* path.dentry.d_inode */
557         unsigned int    flags;
558         unsigned        seq, m_seq, r_seq;
559         int             last_type;
560         unsigned        depth;
561         int             total_link_count;
562         struct saved {
563                 struct path link;
564                 struct delayed_call done;
565                 const char *name;
566                 unsigned seq;
567         } *stack, internal[EMBEDDED_LEVELS];
568         struct filename *name;
569         struct nameidata *saved;
570         unsigned        root_seq;
571         int             dfd;
572         kuid_t          dir_uid;
573         umode_t         dir_mode;
574 } __randomize_layout;
575
576 static void set_nameidata(struct nameidata *p, int dfd, struct filename *name)
577 {
578         struct nameidata *old = current->nameidata;
579         p->stack = p->internal;
580         p->dfd = dfd;
581         p->name = name;
582         p->total_link_count = old ? old->total_link_count : 0;
583         p->saved = old;
584         current->nameidata = p;
585 }
586
587 static void restore_nameidata(void)
588 {
589         struct nameidata *now = current->nameidata, *old = now->saved;
590
591         current->nameidata = old;
592         if (old)
593                 old->total_link_count = now->total_link_count;
594         if (now->stack != now->internal)
595                 kfree(now->stack);
596 }
597
598 static bool nd_alloc_stack(struct nameidata *nd)
599 {
600         struct saved *p;
601
602         p= kmalloc_array(MAXSYMLINKS, sizeof(struct saved),
603                          nd->flags & LOOKUP_RCU ? GFP_ATOMIC : GFP_KERNEL);
604         if (unlikely(!p))
605                 return false;
606         memcpy(p, nd->internal, sizeof(nd->internal));
607         nd->stack = p;
608         return true;
609 }
610
611 /**
612  * path_connected - Verify that a dentry is below mnt.mnt_root
613  *
614  * Rename can sometimes move a file or directory outside of a bind
615  * mount, path_connected allows those cases to be detected.
616  */
617 static bool path_connected(struct vfsmount *mnt, struct dentry *dentry)
618 {
619         struct super_block *sb = mnt->mnt_sb;
620
621         /* Bind mounts can have disconnected paths */
622         if (mnt->mnt_root == sb->s_root)
623                 return true;
624
625         return is_subdir(dentry, mnt->mnt_root);
626 }
627
628 static void drop_links(struct nameidata *nd)
629 {
630         int i = nd->depth;
631         while (i--) {
632                 struct saved *last = nd->stack + i;
633                 do_delayed_call(&last->done);
634                 clear_delayed_call(&last->done);
635         }
636 }
637
638 static void terminate_walk(struct nameidata *nd)
639 {
640         drop_links(nd);
641         if (!(nd->flags & LOOKUP_RCU)) {
642                 int i;
643                 path_put(&nd->path);
644                 for (i = 0; i < nd->depth; i++)
645                         path_put(&nd->stack[i].link);
646                 if (nd->flags & LOOKUP_ROOT_GRABBED) {
647                         path_put(&nd->root);
648                         nd->flags &= ~LOOKUP_ROOT_GRABBED;
649                 }
650         } else {
651                 nd->flags &= ~LOOKUP_RCU;
652                 rcu_read_unlock();
653         }
654         nd->depth = 0;
655 }
656
657 /* path_put is needed afterwards regardless of success or failure */
658 static bool __legitimize_path(struct path *path, unsigned seq, unsigned mseq)
659 {
660         int res = __legitimize_mnt(path->mnt, mseq);
661         if (unlikely(res)) {
662                 if (res > 0)
663                         path->mnt = NULL;
664                 path->dentry = NULL;
665                 return false;
666         }
667         if (unlikely(!lockref_get_not_dead(&path->dentry->d_lockref))) {
668                 path->dentry = NULL;
669                 return false;
670         }
671         return !read_seqcount_retry(&path->dentry->d_seq, seq);
672 }
673
674 static inline bool legitimize_path(struct nameidata *nd,
675                             struct path *path, unsigned seq)
676 {
677         return __legitimize_path(path, seq, nd->m_seq);
678 }
679
680 static bool legitimize_links(struct nameidata *nd)
681 {
682         int i;
683         for (i = 0; i < nd->depth; i++) {
684                 struct saved *last = nd->stack + i;
685                 if (unlikely(!legitimize_path(nd, &last->link, last->seq))) {
686                         drop_links(nd);
687                         nd->depth = i + 1;
688                         return false;
689                 }
690         }
691         return true;
692 }
693
694 static bool legitimize_root(struct nameidata *nd)
695 {
696         /*
697          * For scoped-lookups (where nd->root has been zeroed), we need to
698          * restart the whole lookup from scratch -- because set_root() is wrong
699          * for these lookups (nd->dfd is the root, not the filesystem root).
700          */
701         if (!nd->root.mnt && (nd->flags & LOOKUP_IS_SCOPED))
702                 return false;
703         /* Nothing to do if nd->root is zero or is managed by the VFS user. */
704         if (!nd->root.mnt || (nd->flags & LOOKUP_ROOT))
705                 return true;
706         nd->flags |= LOOKUP_ROOT_GRABBED;
707         return legitimize_path(nd, &nd->root, nd->root_seq);
708 }
709
710 /*
711  * Path walking has 2 modes, rcu-walk and ref-walk (see
712  * Documentation/filesystems/path-lookup.txt).  In situations when we can't
713  * continue in RCU mode, we attempt to drop out of rcu-walk mode and grab
714  * normal reference counts on dentries and vfsmounts to transition to ref-walk
715  * mode.  Refcounts are grabbed at the last known good point before rcu-walk
716  * got stuck, so ref-walk may continue from there. If this is not successful
717  * (eg. a seqcount has changed), then failure is returned and it's up to caller
718  * to restart the path walk from the beginning in ref-walk mode.
719  */
720
721 /**
722  * unlazy_walk - try to switch to ref-walk mode.
723  * @nd: nameidata pathwalk data
724  * Returns: 0 on success, -ECHILD on failure
725  *
726  * unlazy_walk attempts to legitimize the current nd->path and nd->root
727  * for ref-walk mode.
728  * Must be called from rcu-walk context.
729  * Nothing should touch nameidata between unlazy_walk() failure and
730  * terminate_walk().
731  */
732 static int unlazy_walk(struct nameidata *nd)
733 {
734         struct dentry *parent = nd->path.dentry;
735
736         BUG_ON(!(nd->flags & LOOKUP_RCU));
737
738         nd->flags &= ~LOOKUP_RCU;
739         if (unlikely(!legitimize_links(nd)))
740                 goto out1;
741         if (unlikely(!legitimize_path(nd, &nd->path, nd->seq)))
742                 goto out;
743         if (unlikely(!legitimize_root(nd)))
744                 goto out;
745         rcu_read_unlock();
746         BUG_ON(nd->inode != parent->d_inode);
747         return 0;
748
749 out1:
750         nd->path.mnt = NULL;
751         nd->path.dentry = NULL;
752 out:
753         rcu_read_unlock();
754         return -ECHILD;
755 }
756
757 /**
758  * unlazy_child - try to switch to ref-walk mode.
759  * @nd: nameidata pathwalk data
760  * @dentry: child of nd->path.dentry
761  * @seq: seq number to check dentry against
762  * Returns: 0 on success, -ECHILD on failure
763  *
764  * unlazy_child attempts to legitimize the current nd->path, nd->root and dentry
765  * for ref-walk mode.  @dentry must be a path found by a do_lookup call on
766  * @nd.  Must be called from rcu-walk context.
767  * Nothing should touch nameidata between unlazy_child() failure and
768  * terminate_walk().
769  */
770 static int unlazy_child(struct nameidata *nd, struct dentry *dentry, unsigned seq)
771 {
772         BUG_ON(!(nd->flags & LOOKUP_RCU));
773
774         nd->flags &= ~LOOKUP_RCU;
775         if (unlikely(!legitimize_links(nd)))
776                 goto out2;
777         if (unlikely(!legitimize_mnt(nd->path.mnt, nd->m_seq)))
778                 goto out2;
779         if (unlikely(!lockref_get_not_dead(&nd->path.dentry->d_lockref)))
780                 goto out1;
781
782         /*
783          * We need to move both the parent and the dentry from the RCU domain
784          * to be properly refcounted. And the sequence number in the dentry
785          * validates *both* dentry counters, since we checked the sequence
786          * number of the parent after we got the child sequence number. So we
787          * know the parent must still be valid if the child sequence number is
788          */
789         if (unlikely(!lockref_get_not_dead(&dentry->d_lockref)))
790                 goto out;
791         if (unlikely(read_seqcount_retry(&dentry->d_seq, seq)))
792                 goto out_dput;
793         /*
794          * Sequence counts matched. Now make sure that the root is
795          * still valid and get it if required.
796          */
797         if (unlikely(!legitimize_root(nd)))
798                 goto out_dput;
799         rcu_read_unlock();
800         return 0;
801
802 out2:
803         nd->path.mnt = NULL;
804 out1:
805         nd->path.dentry = NULL;
806 out:
807         rcu_read_unlock();
808         return -ECHILD;
809 out_dput:
810         rcu_read_unlock();
811         dput(dentry);
812         return -ECHILD;
813 }
814
815 static inline int d_revalidate(struct dentry *dentry, unsigned int flags)
816 {
817         if (unlikely(dentry->d_flags & DCACHE_OP_REVALIDATE))
818                 return dentry->d_op->d_revalidate(dentry, flags);
819         else
820                 return 1;
821 }
822
823 /**
824  * complete_walk - successful completion of path walk
825  * @nd:  pointer nameidata
826  *
827  * If we had been in RCU mode, drop out of it and legitimize nd->path.
828  * Revalidate the final result, unless we'd already done that during
829  * the path walk or the filesystem doesn't ask for it.  Return 0 on
830  * success, -error on failure.  In case of failure caller does not
831  * need to drop nd->path.
832  */
833 static int complete_walk(struct nameidata *nd)
834 {
835         struct dentry *dentry = nd->path.dentry;
836         int status;
837
838         if (nd->flags & LOOKUP_RCU) {
839                 /*
840                  * We don't want to zero nd->root for scoped-lookups or
841                  * externally-managed nd->root.
842                  */
843                 if (!(nd->flags & (LOOKUP_ROOT | LOOKUP_IS_SCOPED)))
844                         nd->root.mnt = NULL;
845                 if (unlikely(unlazy_walk(nd)))
846                         return -ECHILD;
847         }
848
849         if (unlikely(nd->flags & LOOKUP_IS_SCOPED)) {
850                 /*
851                  * While the guarantee of LOOKUP_IS_SCOPED is (roughly) "don't
852                  * ever step outside the root during lookup" and should already
853                  * be guaranteed by the rest of namei, we want to avoid a namei
854                  * BUG resulting in userspace being given a path that was not
855                  * scoped within the root at some point during the lookup.
856                  *
857                  * So, do a final sanity-check to make sure that in the
858                  * worst-case scenario (a complete bypass of LOOKUP_IS_SCOPED)
859                  * we won't silently return an fd completely outside of the
860                  * requested root to userspace.
861                  *
862                  * Userspace could move the path outside the root after this
863                  * check, but as discussed elsewhere this is not a concern (the
864                  * resolved file was inside the root at some point).
865                  */
866                 if (!path_is_under(&nd->path, &nd->root))
867                         return -EXDEV;
868         }
869
870         if (likely(!(nd->flags & LOOKUP_JUMPED)))
871                 return 0;
872
873         if (likely(!(dentry->d_flags & DCACHE_OP_WEAK_REVALIDATE)))
874                 return 0;
875
876         status = dentry->d_op->d_weak_revalidate(dentry, nd->flags);
877         if (status > 0)
878                 return 0;
879
880         if (!status)
881                 status = -ESTALE;
882
883         return status;
884 }
885
886 static int set_root(struct nameidata *nd)
887 {
888         struct fs_struct *fs = current->fs;
889
890         /*
891          * Jumping to the real root in a scoped-lookup is a BUG in namei, but we
892          * still have to ensure it doesn't happen because it will cause a breakout
893          * from the dirfd.
894          */
895         if (WARN_ON(nd->flags & LOOKUP_IS_SCOPED))
896                 return -ENOTRECOVERABLE;
897
898         if (nd->flags & LOOKUP_RCU) {
899                 unsigned seq;
900
901                 do {
902                         seq = read_seqcount_begin(&fs->seq);
903                         nd->root = fs->root;
904                         nd->root_seq = __read_seqcount_begin(&nd->root.dentry->d_seq);
905                 } while (read_seqcount_retry(&fs->seq, seq));
906         } else {
907                 get_fs_root(fs, &nd->root);
908                 nd->flags |= LOOKUP_ROOT_GRABBED;
909         }
910         return 0;
911 }
912
913 static int nd_jump_root(struct nameidata *nd)
914 {
915         if (unlikely(nd->flags & LOOKUP_BENEATH))
916                 return -EXDEV;
917         if (unlikely(nd->flags & LOOKUP_NO_XDEV)) {
918                 /* Absolute path arguments to path_init() are allowed. */
919                 if (nd->path.mnt != NULL && nd->path.mnt != nd->root.mnt)
920                         return -EXDEV;
921         }
922         if (!nd->root.mnt) {
923                 int error = set_root(nd);
924                 if (error)
925                         return error;
926         }
927         if (nd->flags & LOOKUP_RCU) {
928                 struct dentry *d;
929                 nd->path = nd->root;
930                 d = nd->path.dentry;
931                 nd->inode = d->d_inode;
932                 nd->seq = nd->root_seq;
933                 if (unlikely(read_seqcount_retry(&d->d_seq, nd->seq)))
934                         return -ECHILD;
935         } else {
936                 path_put(&nd->path);
937                 nd->path = nd->root;
938                 path_get(&nd->path);
939                 nd->inode = nd->path.dentry->d_inode;
940         }
941         nd->flags |= LOOKUP_JUMPED;
942         return 0;
943 }
944
945 /*
946  * Helper to directly jump to a known parsed path from ->get_link,
947  * caller must have taken a reference to path beforehand.
948  */
949 int nd_jump_link(struct path *path)
950 {
951         int error = -ELOOP;
952         struct nameidata *nd = current->nameidata;
953
954         if (unlikely(nd->flags & LOOKUP_NO_MAGICLINKS))
955                 goto err;
956
957         error = -EXDEV;
958         if (unlikely(nd->flags & LOOKUP_NO_XDEV)) {
959                 if (nd->path.mnt != path->mnt)
960                         goto err;
961         }
962         /* Not currently safe for scoped-lookups. */
963         if (unlikely(nd->flags & LOOKUP_IS_SCOPED))
964                 goto err;
965
966         path_put(&nd->path);
967         nd->path = *path;
968         nd->inode = nd->path.dentry->d_inode;
969         nd->flags |= LOOKUP_JUMPED;
970         return 0;
971
972 err:
973         path_put(path);
974         return error;
975 }
976
977 static inline void put_link(struct nameidata *nd)
978 {
979         struct saved *last = nd->stack + --nd->depth;
980         do_delayed_call(&last->done);
981         if (!(nd->flags & LOOKUP_RCU))
982                 path_put(&last->link);
983 }
984
985 int sysctl_protected_symlinks __read_mostly = 0;
986 int sysctl_protected_hardlinks __read_mostly = 0;
987 int sysctl_protected_fifos __read_mostly;
988 int sysctl_protected_regular __read_mostly;
989
990 /**
991  * may_follow_link - Check symlink following for unsafe situations
992  * @nd: nameidata pathwalk data
993  *
994  * In the case of the sysctl_protected_symlinks sysctl being enabled,
995  * CAP_DAC_OVERRIDE needs to be specifically ignored if the symlink is
996  * in a sticky world-writable directory. This is to protect privileged
997  * processes from failing races against path names that may change out
998  * from under them by way of other users creating malicious symlinks.
999  * It will permit symlinks to be followed only when outside a sticky
1000  * world-writable directory, or when the uid of the symlink and follower
1001  * match, or when the directory owner matches the symlink's owner.
1002  *
1003  * Returns 0 if following the symlink is allowed, -ve on error.
1004  */
1005 static inline int may_follow_link(struct nameidata *nd, const struct inode *inode)
1006 {
1007         struct user_namespace *mnt_userns;
1008         kuid_t i_uid;
1009
1010         if (!sysctl_protected_symlinks)
1011                 return 0;
1012
1013         mnt_userns = mnt_user_ns(nd->path.mnt);
1014         i_uid = i_uid_into_mnt(mnt_userns, inode);
1015         /* Allowed if owner and follower match. */
1016         if (uid_eq(current_cred()->fsuid, i_uid))
1017                 return 0;
1018
1019         /* Allowed if parent directory not sticky and world-writable. */
1020         if ((nd->dir_mode & (S_ISVTX|S_IWOTH)) != (S_ISVTX|S_IWOTH))
1021                 return 0;
1022
1023         /* Allowed if parent directory and link owner match. */
1024         if (uid_valid(nd->dir_uid) && uid_eq(nd->dir_uid, i_uid))
1025                 return 0;
1026
1027         if (nd->flags & LOOKUP_RCU)
1028                 return -ECHILD;
1029
1030         audit_inode(nd->name, nd->stack[0].link.dentry, 0);
1031         audit_log_path_denied(AUDIT_ANOM_LINK, "follow_link");
1032         return -EACCES;
1033 }
1034
1035 /**
1036  * safe_hardlink_source - Check for safe hardlink conditions
1037  * @mnt_userns: user namespace of the mount the inode was found from
1038  * @inode: the source inode to hardlink from
1039  *
1040  * Return false if at least one of the following conditions:
1041  *    - inode is not a regular file
1042  *    - inode is setuid
1043  *    - inode is setgid and group-exec
1044  *    - access failure for read and write
1045  *
1046  * Otherwise returns true.
1047  */
1048 static bool safe_hardlink_source(struct user_namespace *mnt_userns,
1049                                  struct inode *inode)
1050 {
1051         umode_t mode = inode->i_mode;
1052
1053         /* Special files should not get pinned to the filesystem. */
1054         if (!S_ISREG(mode))
1055                 return false;
1056
1057         /* Setuid files should not get pinned to the filesystem. */
1058         if (mode & S_ISUID)
1059                 return false;
1060
1061         /* Executable setgid files should not get pinned to the filesystem. */
1062         if ((mode & (S_ISGID | S_IXGRP)) == (S_ISGID | S_IXGRP))
1063                 return false;
1064
1065         /* Hardlinking to unreadable or unwritable sources is dangerous. */
1066         if (inode_permission(mnt_userns, inode, MAY_READ | MAY_WRITE))
1067                 return false;
1068
1069         return true;
1070 }
1071
1072 /**
1073  * may_linkat - Check permissions for creating a hardlink
1074  * @mnt_userns: user namespace of the mount the inode was found from
1075  * @link: the source to hardlink from
1076  *
1077  * Block hardlink when all of:
1078  *  - sysctl_protected_hardlinks enabled
1079  *  - fsuid does not match inode
1080  *  - hardlink source is unsafe (see safe_hardlink_source() above)
1081  *  - not CAP_FOWNER in a namespace with the inode owner uid mapped
1082  *
1083  * If the inode has been found through an idmapped mount the user namespace of
1084  * the vfsmount must be passed through @mnt_userns. This function will then take
1085  * care to map the inode according to @mnt_userns before checking permissions.
1086  * On non-idmapped mounts or if permission checking is to be performed on the
1087  * raw inode simply passs init_user_ns.
1088  *
1089  * Returns 0 if successful, -ve on error.
1090  */
1091 int may_linkat(struct user_namespace *mnt_userns, struct path *link)
1092 {
1093         struct inode *inode = link->dentry->d_inode;
1094
1095         /* Inode writeback is not safe when the uid or gid are invalid. */
1096         if (!uid_valid(i_uid_into_mnt(mnt_userns, inode)) ||
1097             !gid_valid(i_gid_into_mnt(mnt_userns, inode)))
1098                 return -EOVERFLOW;
1099
1100         if (!sysctl_protected_hardlinks)
1101                 return 0;
1102
1103         /* Source inode owner (or CAP_FOWNER) can hardlink all they like,
1104          * otherwise, it must be a safe source.
1105          */
1106         if (safe_hardlink_source(mnt_userns, inode) ||
1107             inode_owner_or_capable(mnt_userns, inode))
1108                 return 0;
1109
1110         audit_log_path_denied(AUDIT_ANOM_LINK, "linkat");
1111         return -EPERM;
1112 }
1113
1114 /**
1115  * may_create_in_sticky - Check whether an O_CREAT open in a sticky directory
1116  *                        should be allowed, or not, on files that already
1117  *                        exist.
1118  * @mnt_userns: user namespace of the mount the inode was found from
1119  * @dir_mode: mode bits of directory
1120  * @dir_uid: owner of directory
1121  * @inode: the inode of the file to open
1122  *
1123  * Block an O_CREAT open of a FIFO (or a regular file) when:
1124  *   - sysctl_protected_fifos (or sysctl_protected_regular) is enabled
1125  *   - the file already exists
1126  *   - we are in a sticky directory
1127  *   - we don't own the file
1128  *   - the owner of the directory doesn't own the file
1129  *   - the directory is world writable
1130  * If the sysctl_protected_fifos (or sysctl_protected_regular) is set to 2
1131  * the directory doesn't have to be world writable: being group writable will
1132  * be enough.
1133  *
1134  * If the inode has been found through an idmapped mount the user namespace of
1135  * the vfsmount must be passed through @mnt_userns. This function will then take
1136  * care to map the inode according to @mnt_userns before checking permissions.
1137  * On non-idmapped mounts or if permission checking is to be performed on the
1138  * raw inode simply passs init_user_ns.
1139  *
1140  * Returns 0 if the open is allowed, -ve on error.
1141  */
1142 static int may_create_in_sticky(struct user_namespace *mnt_userns,
1143                                 struct nameidata *nd, struct inode *const inode)
1144 {
1145         umode_t dir_mode = nd->dir_mode;
1146         kuid_t dir_uid = nd->dir_uid;
1147
1148         if ((!sysctl_protected_fifos && S_ISFIFO(inode->i_mode)) ||
1149             (!sysctl_protected_regular && S_ISREG(inode->i_mode)) ||
1150             likely(!(dir_mode & S_ISVTX)) ||
1151             uid_eq(i_uid_into_mnt(mnt_userns, inode), dir_uid) ||
1152             uid_eq(current_fsuid(), i_uid_into_mnt(mnt_userns, inode)))
1153                 return 0;
1154
1155         if (likely(dir_mode & 0002) ||
1156             (dir_mode & 0020 &&
1157              ((sysctl_protected_fifos >= 2 && S_ISFIFO(inode->i_mode)) ||
1158               (sysctl_protected_regular >= 2 && S_ISREG(inode->i_mode))))) {
1159                 const char *operation = S_ISFIFO(inode->i_mode) ?
1160                                         "sticky_create_fifo" :
1161                                         "sticky_create_regular";
1162                 audit_log_path_denied(AUDIT_ANOM_CREAT, operation);
1163                 return -EACCES;
1164         }
1165         return 0;
1166 }
1167
1168 /*
1169  * follow_up - Find the mountpoint of path's vfsmount
1170  *
1171  * Given a path, find the mountpoint of its source file system.
1172  * Replace @path with the path of the mountpoint in the parent mount.
1173  * Up is towards /.
1174  *
1175  * Return 1 if we went up a level and 0 if we were already at the
1176  * root.
1177  */
1178 int follow_up(struct path *path)
1179 {
1180         struct mount *mnt = real_mount(path->mnt);
1181         struct mount *parent;
1182         struct dentry *mountpoint;
1183
1184         read_seqlock_excl(&mount_lock);
1185         parent = mnt->mnt_parent;
1186         if (parent == mnt) {
1187                 read_sequnlock_excl(&mount_lock);
1188                 return 0;
1189         }
1190         mntget(&parent->mnt);
1191         mountpoint = dget(mnt->mnt_mountpoint);
1192         read_sequnlock_excl(&mount_lock);
1193         dput(path->dentry);
1194         path->dentry = mountpoint;
1195         mntput(path->mnt);
1196         path->mnt = &parent->mnt;
1197         return 1;
1198 }
1199 EXPORT_SYMBOL(follow_up);
1200
1201 static bool choose_mountpoint_rcu(struct mount *m, const struct path *root,
1202                                   struct path *path, unsigned *seqp)
1203 {
1204         while (mnt_has_parent(m)) {
1205                 struct dentry *mountpoint = m->mnt_mountpoint;
1206
1207                 m = m->mnt_parent;
1208                 if (unlikely(root->dentry == mountpoint &&
1209                              root->mnt == &m->mnt))
1210                         break;
1211                 if (mountpoint != m->mnt.mnt_root) {
1212                         path->mnt = &m->mnt;
1213                         path->dentry = mountpoint;
1214                         *seqp = read_seqcount_begin(&mountpoint->d_seq);
1215                         return true;
1216                 }
1217         }
1218         return false;
1219 }
1220
1221 static bool choose_mountpoint(struct mount *m, const struct path *root,
1222                               struct path *path)
1223 {
1224         bool found;
1225
1226         rcu_read_lock();
1227         while (1) {
1228                 unsigned seq, mseq = read_seqbegin(&mount_lock);
1229
1230                 found = choose_mountpoint_rcu(m, root, path, &seq);
1231                 if (unlikely(!found)) {
1232                         if (!read_seqretry(&mount_lock, mseq))
1233                                 break;
1234                 } else {
1235                         if (likely(__legitimize_path(path, seq, mseq)))
1236                                 break;
1237                         rcu_read_unlock();
1238                         path_put(path);
1239                         rcu_read_lock();
1240                 }
1241         }
1242         rcu_read_unlock();
1243         return found;
1244 }
1245
1246 /*
1247  * Perform an automount
1248  * - return -EISDIR to tell follow_managed() to stop and return the path we
1249  *   were called with.
1250  */
1251 static int follow_automount(struct path *path, int *count, unsigned lookup_flags)
1252 {
1253         struct dentry *dentry = path->dentry;
1254
1255         /* We don't want to mount if someone's just doing a stat -
1256          * unless they're stat'ing a directory and appended a '/' to
1257          * the name.
1258          *
1259          * We do, however, want to mount if someone wants to open or
1260          * create a file of any type under the mountpoint, wants to
1261          * traverse through the mountpoint or wants to open the
1262          * mounted directory.  Also, autofs may mark negative dentries
1263          * as being automount points.  These will need the attentions
1264          * of the daemon to instantiate them before they can be used.
1265          */
1266         if (!(lookup_flags & (LOOKUP_PARENT | LOOKUP_DIRECTORY |
1267                            LOOKUP_OPEN | LOOKUP_CREATE | LOOKUP_AUTOMOUNT)) &&
1268             dentry->d_inode)
1269                 return -EISDIR;
1270
1271         if (count && (*count)++ >= MAXSYMLINKS)
1272                 return -ELOOP;
1273
1274         return finish_automount(dentry->d_op->d_automount(path), path);
1275 }
1276
1277 /*
1278  * mount traversal - out-of-line part.  One note on ->d_flags accesses -
1279  * dentries are pinned but not locked here, so negative dentry can go
1280  * positive right under us.  Use of smp_load_acquire() provides a barrier
1281  * sufficient for ->d_inode and ->d_flags consistency.
1282  */
1283 static int __traverse_mounts(struct path *path, unsigned flags, bool *jumped,
1284                              int *count, unsigned lookup_flags)
1285 {
1286         struct vfsmount *mnt = path->mnt;
1287         bool need_mntput = false;
1288         int ret = 0;
1289
1290         while (flags & DCACHE_MANAGED_DENTRY) {
1291                 /* Allow the filesystem to manage the transit without i_mutex
1292                  * being held. */
1293                 if (flags & DCACHE_MANAGE_TRANSIT) {
1294                         ret = path->dentry->d_op->d_manage(path, false);
1295                         flags = smp_load_acquire(&path->dentry->d_flags);
1296                         if (ret < 0)
1297                                 break;
1298                 }
1299
1300                 if (flags & DCACHE_MOUNTED) {   // something's mounted on it..
1301                         struct vfsmount *mounted = lookup_mnt(path);
1302                         if (mounted) {          // ... in our namespace
1303                                 dput(path->dentry);
1304                                 if (need_mntput)
1305                                         mntput(path->mnt);
1306                                 path->mnt = mounted;
1307                                 path->dentry = dget(mounted->mnt_root);
1308                                 // here we know it's positive
1309                                 flags = path->dentry->d_flags;
1310                                 need_mntput = true;
1311                                 continue;
1312                         }
1313                 }
1314
1315                 if (!(flags & DCACHE_NEED_AUTOMOUNT))
1316                         break;
1317
1318                 // uncovered automount point
1319                 ret = follow_automount(path, count, lookup_flags);
1320                 flags = smp_load_acquire(&path->dentry->d_flags);
1321                 if (ret < 0)
1322                         break;
1323         }
1324
1325         if (ret == -EISDIR)
1326                 ret = 0;
1327         // possible if you race with several mount --move
1328         if (need_mntput && path->mnt == mnt)
1329                 mntput(path->mnt);
1330         if (!ret && unlikely(d_flags_negative(flags)))
1331                 ret = -ENOENT;
1332         *jumped = need_mntput;
1333         return ret;
1334 }
1335
1336 static inline int traverse_mounts(struct path *path, bool *jumped,
1337                                   int *count, unsigned lookup_flags)
1338 {
1339         unsigned flags = smp_load_acquire(&path->dentry->d_flags);
1340
1341         /* fastpath */
1342         if (likely(!(flags & DCACHE_MANAGED_DENTRY))) {
1343                 *jumped = false;
1344                 if (unlikely(d_flags_negative(flags)))
1345                         return -ENOENT;
1346                 return 0;
1347         }
1348         return __traverse_mounts(path, flags, jumped, count, lookup_flags);
1349 }
1350
1351 int follow_down_one(struct path *path)
1352 {
1353         struct vfsmount *mounted;
1354
1355         mounted = lookup_mnt(path);
1356         if (mounted) {
1357                 dput(path->dentry);
1358                 mntput(path->mnt);
1359                 path->mnt = mounted;
1360                 path->dentry = dget(mounted->mnt_root);
1361                 return 1;
1362         }
1363         return 0;
1364 }
1365 EXPORT_SYMBOL(follow_down_one);
1366
1367 /*
1368  * Follow down to the covering mount currently visible to userspace.  At each
1369  * point, the filesystem owning that dentry may be queried as to whether the
1370  * caller is permitted to proceed or not.
1371  */
1372 int follow_down(struct path *path)
1373 {
1374         struct vfsmount *mnt = path->mnt;
1375         bool jumped;
1376         int ret = traverse_mounts(path, &jumped, NULL, 0);
1377
1378         if (path->mnt != mnt)
1379                 mntput(mnt);
1380         return ret;
1381 }
1382 EXPORT_SYMBOL(follow_down);
1383
1384 /*
1385  * Try to skip to top of mountpoint pile in rcuwalk mode.  Fail if
1386  * we meet a managed dentry that would need blocking.
1387  */
1388 static bool __follow_mount_rcu(struct nameidata *nd, struct path *path,
1389                                struct inode **inode, unsigned *seqp)
1390 {
1391         struct dentry *dentry = path->dentry;
1392         unsigned int flags = dentry->d_flags;
1393
1394         if (likely(!(flags & DCACHE_MANAGED_DENTRY)))
1395                 return true;
1396
1397         if (unlikely(nd->flags & LOOKUP_NO_XDEV))
1398                 return false;
1399
1400         for (;;) {
1401                 /*
1402                  * Don't forget we might have a non-mountpoint managed dentry
1403                  * that wants to block transit.
1404                  */
1405                 if (unlikely(flags & DCACHE_MANAGE_TRANSIT)) {
1406                         int res = dentry->d_op->d_manage(path, true);
1407                         if (res)
1408                                 return res == -EISDIR;
1409                         flags = dentry->d_flags;
1410                 }
1411
1412                 if (flags & DCACHE_MOUNTED) {
1413                         struct mount *mounted = __lookup_mnt(path->mnt, dentry);
1414                         if (mounted) {
1415                                 path->mnt = &mounted->mnt;
1416                                 dentry = path->dentry = mounted->mnt.mnt_root;
1417                                 nd->flags |= LOOKUP_JUMPED;
1418                                 *seqp = read_seqcount_begin(&dentry->d_seq);
1419                                 *inode = dentry->d_inode;
1420                                 /*
1421                                  * We don't need to re-check ->d_seq after this
1422                                  * ->d_inode read - there will be an RCU delay
1423                                  * between mount hash removal and ->mnt_root
1424                                  * becoming unpinned.
1425                                  */
1426                                 flags = dentry->d_flags;
1427                                 continue;
1428                         }
1429                         if (read_seqretry(&mount_lock, nd->m_seq))
1430                                 return false;
1431                 }
1432                 return !(flags & DCACHE_NEED_AUTOMOUNT);
1433         }
1434 }
1435
1436 static inline int handle_mounts(struct nameidata *nd, struct dentry *dentry,
1437                           struct path *path, struct inode **inode,
1438                           unsigned int *seqp)
1439 {
1440         bool jumped;
1441         int ret;
1442
1443         path->mnt = nd->path.mnt;
1444         path->dentry = dentry;
1445         if (nd->flags & LOOKUP_RCU) {
1446                 unsigned int seq = *seqp;
1447                 if (unlikely(!*inode))
1448                         return -ENOENT;
1449                 if (likely(__follow_mount_rcu(nd, path, inode, seqp)))
1450                         return 0;
1451                 if (unlazy_child(nd, dentry, seq))
1452                         return -ECHILD;
1453                 // *path might've been clobbered by __follow_mount_rcu()
1454                 path->mnt = nd->path.mnt;
1455                 path->dentry = dentry;
1456         }
1457         ret = traverse_mounts(path, &jumped, &nd->total_link_count, nd->flags);
1458         if (jumped) {
1459                 if (unlikely(nd->flags & LOOKUP_NO_XDEV))
1460                         ret = -EXDEV;
1461                 else
1462                         nd->flags |= LOOKUP_JUMPED;
1463         }
1464         if (unlikely(ret)) {
1465                 dput(path->dentry);
1466                 if (path->mnt != nd->path.mnt)
1467                         mntput(path->mnt);
1468         } else {
1469                 *inode = d_backing_inode(path->dentry);
1470                 *seqp = 0; /* out of RCU mode, so the value doesn't matter */
1471         }
1472         return ret;
1473 }
1474
1475 /*
1476  * This looks up the name in dcache and possibly revalidates the found dentry.
1477  * NULL is returned if the dentry does not exist in the cache.
1478  */
1479 static struct dentry *lookup_dcache(const struct qstr *name,
1480                                     struct dentry *dir,
1481                                     unsigned int flags)
1482 {
1483         struct dentry *dentry = d_lookup(dir, name);
1484         if (dentry) {
1485                 int error = d_revalidate(dentry, flags);
1486                 if (unlikely(error <= 0)) {
1487                         if (!error)
1488                                 d_invalidate(dentry);
1489                         dput(dentry);
1490                         return ERR_PTR(error);
1491                 }
1492         }
1493         return dentry;
1494 }
1495
1496 /*
1497  * Parent directory has inode locked exclusive.  This is one
1498  * and only case when ->lookup() gets called on non in-lookup
1499  * dentries - as the matter of fact, this only gets called
1500  * when directory is guaranteed to have no in-lookup children
1501  * at all.
1502  */
1503 static struct dentry *__lookup_hash(const struct qstr *name,
1504                 struct dentry *base, unsigned int flags)
1505 {
1506         struct dentry *dentry = lookup_dcache(name, base, flags);
1507         struct dentry *old;
1508         struct inode *dir = base->d_inode;
1509
1510         if (dentry)
1511                 return dentry;
1512
1513         /* Don't create child dentry for a dead directory. */
1514         if (unlikely(IS_DEADDIR(dir)))
1515                 return ERR_PTR(-ENOENT);
1516
1517         dentry = d_alloc(base, name);
1518         if (unlikely(!dentry))
1519                 return ERR_PTR(-ENOMEM);
1520
1521         old = dir->i_op->lookup(dir, dentry, flags);
1522         if (unlikely(old)) {
1523                 dput(dentry);
1524                 dentry = old;
1525         }
1526         return dentry;
1527 }
1528
1529 static struct dentry *lookup_fast(struct nameidata *nd,
1530                                   struct inode **inode,
1531                                   unsigned *seqp)
1532 {
1533         struct dentry *dentry, *parent = nd->path.dentry;
1534         int status = 1;
1535
1536         /*
1537          * Rename seqlock is not required here because in the off chance
1538          * of a false negative due to a concurrent rename, the caller is
1539          * going to fall back to non-racy lookup.
1540          */
1541         if (nd->flags & LOOKUP_RCU) {
1542                 unsigned seq;
1543                 dentry = __d_lookup_rcu(parent, &nd->last, &seq);
1544                 if (unlikely(!dentry)) {
1545                         if (unlazy_walk(nd))
1546                                 return ERR_PTR(-ECHILD);
1547                         return NULL;
1548                 }
1549
1550                 /*
1551                  * This sequence count validates that the inode matches
1552                  * the dentry name information from lookup.
1553                  */
1554                 *inode = d_backing_inode(dentry);
1555                 if (unlikely(read_seqcount_retry(&dentry->d_seq, seq)))
1556                         return ERR_PTR(-ECHILD);
1557
1558                 /*
1559                  * This sequence count validates that the parent had no
1560                  * changes while we did the lookup of the dentry above.
1561                  *
1562                  * The memory barrier in read_seqcount_begin of child is
1563                  *  enough, we can use __read_seqcount_retry here.
1564                  */
1565                 if (unlikely(__read_seqcount_retry(&parent->d_seq, nd->seq)))
1566                         return ERR_PTR(-ECHILD);
1567
1568                 *seqp = seq;
1569                 status = d_revalidate(dentry, nd->flags);
1570                 if (likely(status > 0))
1571                         return dentry;
1572                 if (unlazy_child(nd, dentry, seq))
1573                         return ERR_PTR(-ECHILD);
1574                 if (unlikely(status == -ECHILD))
1575                         /* we'd been told to redo it in non-rcu mode */
1576                         status = d_revalidate(dentry, nd->flags);
1577         } else {
1578                 dentry = __d_lookup(parent, &nd->last);
1579                 if (unlikely(!dentry))
1580                         return NULL;
1581                 status = d_revalidate(dentry, nd->flags);
1582         }
1583         if (unlikely(status <= 0)) {
1584                 if (!status)
1585                         d_invalidate(dentry);
1586                 dput(dentry);
1587                 return ERR_PTR(status);
1588         }
1589         return dentry;
1590 }
1591
1592 /* Fast lookup failed, do it the slow way */
1593 static struct dentry *__lookup_slow(const struct qstr *name,
1594                                     struct dentry *dir,
1595                                     unsigned int flags)
1596 {
1597         struct dentry *dentry, *old;
1598         struct inode *inode = dir->d_inode;
1599         DECLARE_WAIT_QUEUE_HEAD_ONSTACK(wq);
1600
1601         /* Don't go there if it's already dead */
1602         if (unlikely(IS_DEADDIR(inode)))
1603                 return ERR_PTR(-ENOENT);
1604 again:
1605         dentry = d_alloc_parallel(dir, name, &wq);
1606         if (IS_ERR(dentry))
1607                 return dentry;
1608         if (unlikely(!d_in_lookup(dentry))) {
1609                 int error = d_revalidate(dentry, flags);
1610                 if (unlikely(error <= 0)) {
1611                         if (!error) {
1612                                 d_invalidate(dentry);
1613                                 dput(dentry);
1614                                 goto again;
1615                         }
1616                         dput(dentry);
1617                         dentry = ERR_PTR(error);
1618                 }
1619         } else {
1620                 old = inode->i_op->lookup(inode, dentry, flags);
1621                 d_lookup_done(dentry);
1622                 if (unlikely(old)) {
1623                         dput(dentry);
1624                         dentry = old;
1625                 }
1626         }
1627         return dentry;
1628 }
1629
1630 static struct dentry *lookup_slow(const struct qstr *name,
1631                                   struct dentry *dir,
1632                                   unsigned int flags)
1633 {
1634         struct inode *inode = dir->d_inode;
1635         struct dentry *res;
1636         inode_lock_shared(inode);
1637         res = __lookup_slow(name, dir, flags);
1638         inode_unlock_shared(inode);
1639         return res;
1640 }
1641
1642 static inline int may_lookup(struct user_namespace *mnt_userns,
1643                              struct nameidata *nd)
1644 {
1645         if (nd->flags & LOOKUP_RCU) {
1646                 int err = inode_permission(mnt_userns, nd->inode,
1647                                            MAY_EXEC | MAY_NOT_BLOCK);
1648                 if (err != -ECHILD)
1649                         return err;
1650                 if (unlazy_walk(nd))
1651                         return -ECHILD;
1652         }
1653         return inode_permission(mnt_userns, nd->inode, MAY_EXEC);
1654 }
1655
1656 static int reserve_stack(struct nameidata *nd, struct path *link, unsigned seq)
1657 {
1658         if (unlikely(nd->total_link_count++ >= MAXSYMLINKS))
1659                 return -ELOOP;
1660
1661         if (likely(nd->depth != EMBEDDED_LEVELS))
1662                 return 0;
1663         if (likely(nd->stack != nd->internal))
1664                 return 0;
1665         if (likely(nd_alloc_stack(nd)))
1666                 return 0;
1667
1668         if (nd->flags & LOOKUP_RCU) {
1669                 // we need to grab link before we do unlazy.  And we can't skip
1670                 // unlazy even if we fail to grab the link - cleanup needs it
1671                 bool grabbed_link = legitimize_path(nd, link, seq);
1672
1673                 if (unlazy_walk(nd) != 0 || !grabbed_link)
1674                         return -ECHILD;
1675
1676                 if (nd_alloc_stack(nd))
1677                         return 0;
1678         }
1679         return -ENOMEM;
1680 }
1681
1682 enum {WALK_TRAILING = 1, WALK_MORE = 2, WALK_NOFOLLOW = 4};
1683
1684 static const char *pick_link(struct nameidata *nd, struct path *link,
1685                      struct inode *inode, unsigned seq, int flags)
1686 {
1687         struct saved *last;
1688         const char *res;
1689         int error = reserve_stack(nd, link, seq);
1690
1691         if (unlikely(error)) {
1692                 if (!(nd->flags & LOOKUP_RCU))
1693                         path_put(link);
1694                 return ERR_PTR(error);
1695         }
1696         last = nd->stack + nd->depth++;
1697         last->link = *link;
1698         clear_delayed_call(&last->done);
1699         last->seq = seq;
1700
1701         if (flags & WALK_TRAILING) {
1702                 error = may_follow_link(nd, inode);
1703                 if (unlikely(error))
1704                         return ERR_PTR(error);
1705         }
1706
1707         if (unlikely(nd->flags & LOOKUP_NO_SYMLINKS) ||
1708                         unlikely(link->mnt->mnt_flags & MNT_NOSYMFOLLOW))
1709                 return ERR_PTR(-ELOOP);
1710
1711         if (!(nd->flags & LOOKUP_RCU)) {
1712                 touch_atime(&last->link);
1713                 cond_resched();
1714         } else if (atime_needs_update(&last->link, inode)) {
1715                 if (unlikely(unlazy_walk(nd)))
1716                         return ERR_PTR(-ECHILD);
1717                 touch_atime(&last->link);
1718         }
1719
1720         error = security_inode_follow_link(link->dentry, inode,
1721                                            nd->flags & LOOKUP_RCU);
1722         if (unlikely(error))
1723                 return ERR_PTR(error);
1724
1725         res = READ_ONCE(inode->i_link);
1726         if (!res) {
1727                 const char * (*get)(struct dentry *, struct inode *,
1728                                 struct delayed_call *);
1729                 get = inode->i_op->get_link;
1730                 if (nd->flags & LOOKUP_RCU) {
1731                         res = get(NULL, inode, &last->done);
1732                         if (res == ERR_PTR(-ECHILD)) {
1733                                 if (unlikely(unlazy_walk(nd)))
1734                                         return ERR_PTR(-ECHILD);
1735                                 res = get(link->dentry, inode, &last->done);
1736                         }
1737                 } else {
1738                         res = get(link->dentry, inode, &last->done);
1739                 }
1740                 if (!res)
1741                         goto all_done;
1742                 if (IS_ERR(res))
1743                         return res;
1744         }
1745         if (*res == '/') {
1746                 error = nd_jump_root(nd);
1747                 if (unlikely(error))
1748                         return ERR_PTR(error);
1749                 while (unlikely(*++res == '/'))
1750                         ;
1751         }
1752         if (*res)
1753                 return res;
1754 all_done: // pure jump
1755         put_link(nd);
1756         return NULL;
1757 }
1758
1759 /*
1760  * Do we need to follow links? We _really_ want to be able
1761  * to do this check without having to look at inode->i_op,
1762  * so we keep a cache of "no, this doesn't need follow_link"
1763  * for the common case.
1764  */
1765 static const char *step_into(struct nameidata *nd, int flags,
1766                      struct dentry *dentry, struct inode *inode, unsigned seq)
1767 {
1768         struct path path;
1769         int err = handle_mounts(nd, dentry, &path, &inode, &seq);
1770
1771         if (err < 0)
1772                 return ERR_PTR(err);
1773         if (likely(!d_is_symlink(path.dentry)) ||
1774            ((flags & WALK_TRAILING) && !(nd->flags & LOOKUP_FOLLOW)) ||
1775            (flags & WALK_NOFOLLOW)) {
1776                 /* not a symlink or should not follow */
1777                 if (!(nd->flags & LOOKUP_RCU)) {
1778                         dput(nd->path.dentry);
1779                         if (nd->path.mnt != path.mnt)
1780                                 mntput(nd->path.mnt);
1781                 }
1782                 nd->path = path;
1783                 nd->inode = inode;
1784                 nd->seq = seq;
1785                 return NULL;
1786         }
1787         if (nd->flags & LOOKUP_RCU) {
1788                 /* make sure that d_is_symlink above matches inode */
1789                 if (read_seqcount_retry(&path.dentry->d_seq, seq))
1790                         return ERR_PTR(-ECHILD);
1791         } else {
1792                 if (path.mnt == nd->path.mnt)
1793                         mntget(path.mnt);
1794         }
1795         return pick_link(nd, &path, inode, seq, flags);
1796 }
1797
1798 static struct dentry *follow_dotdot_rcu(struct nameidata *nd,
1799                                         struct inode **inodep,
1800                                         unsigned *seqp)
1801 {
1802         struct dentry *parent, *old;
1803
1804         if (path_equal(&nd->path, &nd->root))
1805                 goto in_root;
1806         if (unlikely(nd->path.dentry == nd->path.mnt->mnt_root)) {
1807                 struct path path;
1808                 unsigned seq;
1809                 if (!choose_mountpoint_rcu(real_mount(nd->path.mnt),
1810                                            &nd->root, &path, &seq))
1811                         goto in_root;
1812                 if (unlikely(nd->flags & LOOKUP_NO_XDEV))
1813                         return ERR_PTR(-ECHILD);
1814                 nd->path = path;
1815                 nd->inode = path.dentry->d_inode;
1816                 nd->seq = seq;
1817                 if (unlikely(read_seqretry(&mount_lock, nd->m_seq)))
1818                         return ERR_PTR(-ECHILD);
1819                 /* we know that mountpoint was pinned */
1820         }
1821         old = nd->path.dentry;
1822         parent = old->d_parent;
1823         *inodep = parent->d_inode;
1824         *seqp = read_seqcount_begin(&parent->d_seq);
1825         if (unlikely(read_seqcount_retry(&old->d_seq, nd->seq)))
1826                 return ERR_PTR(-ECHILD);
1827         if (unlikely(!path_connected(nd->path.mnt, parent)))
1828                 return ERR_PTR(-ECHILD);
1829         return parent;
1830 in_root:
1831         if (unlikely(read_seqretry(&mount_lock, nd->m_seq)))
1832                 return ERR_PTR(-ECHILD);
1833         if (unlikely(nd->flags & LOOKUP_BENEATH))
1834                 return ERR_PTR(-ECHILD);
1835         return NULL;
1836 }
1837
1838 static struct dentry *follow_dotdot(struct nameidata *nd,
1839                                  struct inode **inodep,
1840                                  unsigned *seqp)
1841 {
1842         struct dentry *parent;
1843
1844         if (path_equal(&nd->path, &nd->root))
1845                 goto in_root;
1846         if (unlikely(nd->path.dentry == nd->path.mnt->mnt_root)) {
1847                 struct path path;
1848
1849                 if (!choose_mountpoint(real_mount(nd->path.mnt),
1850                                        &nd->root, &path))
1851                         goto in_root;
1852                 path_put(&nd->path);
1853                 nd->path = path;
1854                 nd->inode = path.dentry->d_inode;
1855                 if (unlikely(nd->flags & LOOKUP_NO_XDEV))
1856                         return ERR_PTR(-EXDEV);
1857         }
1858         /* rare case of legitimate dget_parent()... */
1859         parent = dget_parent(nd->path.dentry);
1860         if (unlikely(!path_connected(nd->path.mnt, parent))) {
1861                 dput(parent);
1862                 return ERR_PTR(-ENOENT);
1863         }
1864         *seqp = 0;
1865         *inodep = parent->d_inode;
1866         return parent;
1867
1868 in_root:
1869         if (unlikely(nd->flags & LOOKUP_BENEATH))
1870                 return ERR_PTR(-EXDEV);
1871         dget(nd->path.dentry);
1872         return NULL;
1873 }
1874
1875 static const char *handle_dots(struct nameidata *nd, int type)
1876 {
1877         if (type == LAST_DOTDOT) {
1878                 const char *error = NULL;
1879                 struct dentry *parent;
1880                 struct inode *inode;
1881                 unsigned seq;
1882
1883                 if (!nd->root.mnt) {
1884                         error = ERR_PTR(set_root(nd));
1885                         if (error)
1886                                 return error;
1887                 }
1888                 if (nd->flags & LOOKUP_RCU)
1889                         parent = follow_dotdot_rcu(nd, &inode, &seq);
1890                 else
1891                         parent = follow_dotdot(nd, &inode, &seq);
1892                 if (IS_ERR(parent))
1893                         return ERR_CAST(parent);
1894                 if (unlikely(!parent))
1895                         error = step_into(nd, WALK_NOFOLLOW,
1896                                          nd->path.dentry, nd->inode, nd->seq);
1897                 else
1898                         error = step_into(nd, WALK_NOFOLLOW,
1899                                          parent, inode, seq);
1900                 if (unlikely(error))
1901                         return error;
1902
1903                 if (unlikely(nd->flags & LOOKUP_IS_SCOPED)) {
1904                         /*
1905                          * If there was a racing rename or mount along our
1906                          * path, then we can't be sure that ".." hasn't jumped
1907                          * above nd->root (and so userspace should retry or use
1908                          * some fallback).
1909                          */
1910                         smp_rmb();
1911                         if (unlikely(__read_seqcount_retry(&mount_lock.seqcount, nd->m_seq)))
1912                                 return ERR_PTR(-EAGAIN);
1913                         if (unlikely(__read_seqcount_retry(&rename_lock.seqcount, nd->r_seq)))
1914                                 return ERR_PTR(-EAGAIN);
1915                 }
1916         }
1917         return NULL;
1918 }
1919
1920 static const char *walk_component(struct nameidata *nd, int flags)
1921 {
1922         struct dentry *dentry;
1923         struct inode *inode;
1924         unsigned seq;
1925         /*
1926          * "." and ".." are special - ".." especially so because it has
1927          * to be able to know about the current root directory and
1928          * parent relationships.
1929          */
1930         if (unlikely(nd->last_type != LAST_NORM)) {
1931                 if (!(flags & WALK_MORE) && nd->depth)
1932                         put_link(nd);
1933                 return handle_dots(nd, nd->last_type);
1934         }
1935         dentry = lookup_fast(nd, &inode, &seq);
1936         if (IS_ERR(dentry))
1937                 return ERR_CAST(dentry);
1938         if (unlikely(!dentry)) {
1939                 dentry = lookup_slow(&nd->last, nd->path.dentry, nd->flags);
1940                 if (IS_ERR(dentry))
1941                         return ERR_CAST(dentry);
1942         }
1943         if (!(flags & WALK_MORE) && nd->depth)
1944                 put_link(nd);
1945         return step_into(nd, flags, dentry, inode, seq);
1946 }
1947
1948 /*
1949  * We can do the critical dentry name comparison and hashing
1950  * operations one word at a time, but we are limited to:
1951  *
1952  * - Architectures with fast unaligned word accesses. We could
1953  *   do a "get_unaligned()" if this helps and is sufficiently
1954  *   fast.
1955  *
1956  * - non-CONFIG_DEBUG_PAGEALLOC configurations (so that we
1957  *   do not trap on the (extremely unlikely) case of a page
1958  *   crossing operation.
1959  *
1960  * - Furthermore, we need an efficient 64-bit compile for the
1961  *   64-bit case in order to generate the "number of bytes in
1962  *   the final mask". Again, that could be replaced with a
1963  *   efficient population count instruction or similar.
1964  */
1965 #ifdef CONFIG_DCACHE_WORD_ACCESS
1966
1967 #include <asm/word-at-a-time.h>
1968
1969 #ifdef HASH_MIX
1970
1971 /* Architecture provides HASH_MIX and fold_hash() in <asm/hash.h> */
1972
1973 #elif defined(CONFIG_64BIT)
1974 /*
1975  * Register pressure in the mixing function is an issue, particularly
1976  * on 32-bit x86, but almost any function requires one state value and
1977  * one temporary.  Instead, use a function designed for two state values
1978  * and no temporaries.
1979  *
1980  * This function cannot create a collision in only two iterations, so
1981  * we have two iterations to achieve avalanche.  In those two iterations,
1982  * we have six layers of mixing, which is enough to spread one bit's
1983  * influence out to 2^6 = 64 state bits.
1984  *
1985  * Rotate constants are scored by considering either 64 one-bit input
1986  * deltas or 64*63/2 = 2016 two-bit input deltas, and finding the
1987  * probability of that delta causing a change to each of the 128 output
1988  * bits, using a sample of random initial states.
1989  *
1990  * The Shannon entropy of the computed probabilities is then summed
1991  * to produce a score.  Ideally, any input change has a 50% chance of
1992  * toggling any given output bit.
1993  *
1994  * Mixing scores (in bits) for (12,45):
1995  * Input delta: 1-bit      2-bit
1996  * 1 round:     713.3    42542.6
1997  * 2 rounds:   2753.7   140389.8
1998  * 3 rounds:   5954.1   233458.2
1999  * 4 rounds:   7862.6   256672.2
2000  * Perfect:    8192     258048
2001  *            (64*128) (64*63/2 * 128)
2002  */
2003 #define HASH_MIX(x, y, a)       \
2004         (       x ^= (a),       \
2005         y ^= x, x = rol64(x,12),\
2006         x += y, y = rol64(y,45),\
2007         y *= 9                  )
2008
2009 /*
2010  * Fold two longs into one 32-bit hash value.  This must be fast, but
2011  * latency isn't quite as critical, as there is a fair bit of additional
2012  * work done before the hash value is used.
2013  */
2014 static inline unsigned int fold_hash(unsigned long x, unsigned long y)
2015 {
2016         y ^= x * GOLDEN_RATIO_64;
2017         y *= GOLDEN_RATIO_64;
2018         return y >> 32;
2019 }
2020
2021 #else   /* 32-bit case */
2022
2023 /*
2024  * Mixing scores (in bits) for (7,20):
2025  * Input delta: 1-bit      2-bit
2026  * 1 round:     330.3     9201.6
2027  * 2 rounds:   1246.4    25475.4
2028  * 3 rounds:   1907.1    31295.1
2029  * 4 rounds:   2042.3    31718.6
2030  * Perfect:    2048      31744
2031  *            (32*64)   (32*31/2 * 64)
2032  */
2033 #define HASH_MIX(x, y, a)       \
2034         (       x ^= (a),       \
2035         y ^= x, x = rol32(x, 7),\
2036         x += y, y = rol32(y,20),\
2037         y *= 9                  )
2038
2039 static inline unsigned int fold_hash(unsigned long x, unsigned long y)
2040 {
2041         /* Use arch-optimized multiply if one exists */
2042         return __hash_32(y ^ __hash_32(x));
2043 }
2044
2045 #endif
2046
2047 /*
2048  * Return the hash of a string of known length.  This is carfully
2049  * designed to match hash_name(), which is the more critical function.
2050  * In particular, we must end by hashing a final word containing 0..7
2051  * payload bytes, to match the way that hash_name() iterates until it
2052  * finds the delimiter after the name.
2053  */
2054 unsigned int full_name_hash(const void *salt, const char *name, unsigned int len)
2055 {
2056         unsigned long a, x = 0, y = (unsigned long)salt;
2057
2058         for (;;) {
2059                 if (!len)
2060                         goto done;
2061                 a = load_unaligned_zeropad(name);
2062                 if (len < sizeof(unsigned long))
2063                         break;
2064                 HASH_MIX(x, y, a);
2065                 name += sizeof(unsigned long);
2066                 len -= sizeof(unsigned long);
2067         }
2068         x ^= a & bytemask_from_count(len);
2069 done:
2070         return fold_hash(x, y);
2071 }
2072 EXPORT_SYMBOL(full_name_hash);
2073
2074 /* Return the "hash_len" (hash and length) of a null-terminated string */
2075 u64 hashlen_string(const void *salt, const char *name)
2076 {
2077         unsigned long a = 0, x = 0, y = (unsigned long)salt;
2078         unsigned long adata, mask, len;
2079         const struct word_at_a_time constants = WORD_AT_A_TIME_CONSTANTS;
2080
2081         len = 0;
2082         goto inside;
2083
2084         do {
2085                 HASH_MIX(x, y, a);
2086                 len += sizeof(unsigned long);
2087 inside:
2088                 a = load_unaligned_zeropad(name+len);
2089         } while (!has_zero(a, &adata, &constants));
2090
2091         adata = prep_zero_mask(a, adata, &constants);
2092         mask = create_zero_mask(adata);
2093         x ^= a & zero_bytemask(mask);
2094
2095         return hashlen_create(fold_hash(x, y), len + find_zero(mask));
2096 }
2097 EXPORT_SYMBOL(hashlen_string);
2098
2099 /*
2100  * Calculate the length and hash of the path component, and
2101  * return the "hash_len" as the result.
2102  */
2103 static inline u64 hash_name(const void *salt, const char *name)
2104 {
2105         unsigned long a = 0, b, x = 0, y = (unsigned long)salt;
2106         unsigned long adata, bdata, mask, len;
2107         const struct word_at_a_time constants = WORD_AT_A_TIME_CONSTANTS;
2108
2109         len = 0;
2110         goto inside;
2111
2112         do {
2113                 HASH_MIX(x, y, a);
2114                 len += sizeof(unsigned long);
2115 inside:
2116                 a = load_unaligned_zeropad(name+len);
2117                 b = a ^ REPEAT_BYTE('/');
2118         } while (!(has_zero(a, &adata, &constants) | has_zero(b, &bdata, &constants)));
2119
2120         adata = prep_zero_mask(a, adata, &constants);
2121         bdata = prep_zero_mask(b, bdata, &constants);
2122         mask = create_zero_mask(adata | bdata);
2123         x ^= a & zero_bytemask(mask);
2124
2125         return hashlen_create(fold_hash(x, y), len + find_zero(mask));
2126 }
2127
2128 #else   /* !CONFIG_DCACHE_WORD_ACCESS: Slow, byte-at-a-time version */
2129
2130 /* Return the hash of a string of known length */
2131 unsigned int full_name_hash(const void *salt, const char *name, unsigned int len)
2132 {
2133         unsigned long hash = init_name_hash(salt);
2134         while (len--)
2135                 hash = partial_name_hash((unsigned char)*name++, hash);
2136         return end_name_hash(hash);
2137 }
2138 EXPORT_SYMBOL(full_name_hash);
2139
2140 /* Return the "hash_len" (hash and length) of a null-terminated string */
2141 u64 hashlen_string(const void *salt, const char *name)
2142 {
2143         unsigned long hash = init_name_hash(salt);
2144         unsigned long len = 0, c;
2145
2146         c = (unsigned char)*name;
2147         while (c) {
2148                 len++;
2149                 hash = partial_name_hash(c, hash);
2150                 c = (unsigned char)name[len];
2151         }
2152         return hashlen_create(end_name_hash(hash), len);
2153 }
2154 EXPORT_SYMBOL(hashlen_string);
2155
2156 /*
2157  * We know there's a real path component here of at least
2158  * one character.
2159  */
2160 static inline u64 hash_name(const void *salt, const char *name)
2161 {
2162         unsigned long hash = init_name_hash(salt);
2163         unsigned long len = 0, c;
2164
2165         c = (unsigned char)*name;
2166         do {
2167                 len++;
2168                 hash = partial_name_hash(c, hash);
2169                 c = (unsigned char)name[len];
2170         } while (c && c != '/');
2171         return hashlen_create(end_name_hash(hash), len);
2172 }
2173
2174 #endif
2175
2176 /*
2177  * Name resolution.
2178  * This is the basic name resolution function, turning a pathname into
2179  * the final dentry. We expect 'base' to be positive and a directory.
2180  *
2181  * Returns 0 and nd will have valid dentry and mnt on success.
2182  * Returns error and drops reference to input namei data on failure.
2183  */
2184 static int link_path_walk(const char *name, struct nameidata *nd)
2185 {
2186         int depth = 0; // depth <= nd->depth
2187         int err;
2188
2189         nd->last_type = LAST_ROOT;
2190         nd->flags |= LOOKUP_PARENT;
2191         if (IS_ERR(name))
2192                 return PTR_ERR(name);
2193         while (*name=='/')
2194                 name++;
2195         if (!*name) {
2196                 nd->dir_mode = 0; // short-circuit the 'hardening' idiocy
2197                 return 0;
2198         }
2199
2200         /* At this point we know we have a real path component. */
2201         for(;;) {
2202                 const char *link;
2203                 u64 hash_len;
2204                 int type;
2205
2206                 err = may_lookup(&init_user_ns, nd);
2207                 if (err)
2208                         return err;
2209
2210                 hash_len = hash_name(nd->path.dentry, name);
2211
2212                 type = LAST_NORM;
2213                 if (name[0] == '.') switch (hashlen_len(hash_len)) {
2214                         case 2:
2215                                 if (name[1] == '.') {
2216                                         type = LAST_DOTDOT;
2217                                         nd->flags |= LOOKUP_JUMPED;
2218                                 }
2219                                 break;
2220                         case 1:
2221                                 type = LAST_DOT;
2222                 }
2223                 if (likely(type == LAST_NORM)) {
2224                         struct dentry *parent = nd->path.dentry;
2225                         nd->flags &= ~LOOKUP_JUMPED;
2226                         if (unlikely(parent->d_flags & DCACHE_OP_HASH)) {
2227                                 struct qstr this = { { .hash_len = hash_len }, .name = name };
2228                                 err = parent->d_op->d_hash(parent, &this);
2229                                 if (err < 0)
2230                                         return err;
2231                                 hash_len = this.hash_len;
2232                                 name = this.name;
2233                         }
2234                 }
2235
2236                 nd->last.hash_len = hash_len;
2237                 nd->last.name = name;
2238                 nd->last_type = type;
2239
2240                 name += hashlen_len(hash_len);
2241                 if (!*name)
2242                         goto OK;
2243                 /*
2244                  * If it wasn't NUL, we know it was '/'. Skip that
2245                  * slash, and continue until no more slashes.
2246                  */
2247                 do {
2248                         name++;
2249                 } while (unlikely(*name == '/'));
2250                 if (unlikely(!*name)) {
2251 OK:
2252                         /* pathname or trailing symlink, done */
2253                         if (!depth) {
2254                                 nd->dir_uid = i_uid_into_mnt(&init_user_ns, nd->inode);
2255                                 nd->dir_mode = nd->inode->i_mode;
2256                                 nd->flags &= ~LOOKUP_PARENT;
2257                                 return 0;
2258                         }
2259                         /* last component of nested symlink */
2260                         name = nd->stack[--depth].name;
2261                         link = walk_component(nd, 0);
2262                 } else {
2263                         /* not the last component */
2264                         link = walk_component(nd, WALK_MORE);
2265                 }
2266                 if (unlikely(link)) {
2267                         if (IS_ERR(link))
2268                                 return PTR_ERR(link);
2269                         /* a symlink to follow */
2270                         nd->stack[depth++].name = name;
2271                         name = link;
2272                         continue;
2273                 }
2274                 if (unlikely(!d_can_lookup(nd->path.dentry))) {
2275                         if (nd->flags & LOOKUP_RCU) {
2276                                 if (unlazy_walk(nd))
2277                                         return -ECHILD;
2278                         }
2279                         return -ENOTDIR;
2280                 }
2281         }
2282 }
2283
2284 /* must be paired with terminate_walk() */
2285 static const char *path_init(struct nameidata *nd, unsigned flags)
2286 {
2287         int error;
2288         const char *s = nd->name->name;
2289
2290         if (!*s)
2291                 flags &= ~LOOKUP_RCU;
2292         if (flags & LOOKUP_RCU)
2293                 rcu_read_lock();
2294
2295         nd->flags = flags | LOOKUP_JUMPED;
2296         nd->depth = 0;
2297
2298         nd->m_seq = __read_seqcount_begin(&mount_lock.seqcount);
2299         nd->r_seq = __read_seqcount_begin(&rename_lock.seqcount);
2300         smp_rmb();
2301
2302         if (flags & LOOKUP_ROOT) {
2303                 struct dentry *root = nd->root.dentry;
2304                 struct inode *inode = root->d_inode;
2305                 if (*s && unlikely(!d_can_lookup(root)))
2306                         return ERR_PTR(-ENOTDIR);
2307                 nd->path = nd->root;
2308                 nd->inode = inode;
2309                 if (flags & LOOKUP_RCU) {
2310                         nd->seq = read_seqcount_begin(&nd->path.dentry->d_seq);
2311                         nd->root_seq = nd->seq;
2312                 } else {
2313                         path_get(&nd->path);
2314                 }
2315                 return s;
2316         }
2317
2318         nd->root.mnt = NULL;
2319         nd->path.mnt = NULL;
2320         nd->path.dentry = NULL;
2321
2322         /* Absolute pathname -- fetch the root (LOOKUP_IN_ROOT uses nd->dfd). */
2323         if (*s == '/' && !(flags & LOOKUP_IN_ROOT)) {
2324                 error = nd_jump_root(nd);
2325                 if (unlikely(error))
2326                         return ERR_PTR(error);
2327                 return s;
2328         }
2329
2330         /* Relative pathname -- get the starting-point it is relative to. */
2331         if (nd->dfd == AT_FDCWD) {
2332                 if (flags & LOOKUP_RCU) {
2333                         struct fs_struct *fs = current->fs;
2334                         unsigned seq;
2335
2336                         do {
2337                                 seq = read_seqcount_begin(&fs->seq);
2338                                 nd->path = fs->pwd;
2339                                 nd->inode = nd->path.dentry->d_inode;
2340                                 nd->seq = __read_seqcount_begin(&nd->path.dentry->d_seq);
2341                         } while (read_seqcount_retry(&fs->seq, seq));
2342                 } else {
2343                         get_fs_pwd(current->fs, &nd->path);
2344                         nd->inode = nd->path.dentry->d_inode;
2345                 }
2346         } else {
2347                 /* Caller must check execute permissions on the starting path component */
2348                 struct fd f = fdget_raw(nd->dfd);
2349                 struct dentry *dentry;
2350
2351                 if (!f.file)
2352                         return ERR_PTR(-EBADF);
2353
2354                 dentry = f.file->f_path.dentry;
2355
2356                 if (*s && unlikely(!d_can_lookup(dentry))) {
2357                         fdput(f);
2358                         return ERR_PTR(-ENOTDIR);
2359                 }
2360
2361                 nd->path = f.file->f_path;
2362                 if (flags & LOOKUP_RCU) {
2363                         nd->inode = nd->path.dentry->d_inode;
2364                         nd->seq = read_seqcount_begin(&nd->path.dentry->d_seq);
2365                 } else {
2366                         path_get(&nd->path);
2367                         nd->inode = nd->path.dentry->d_inode;
2368                 }
2369                 fdput(f);
2370         }
2371
2372         /* For scoped-lookups we need to set the root to the dirfd as well. */
2373         if (flags & LOOKUP_IS_SCOPED) {
2374                 nd->root = nd->path;
2375                 if (flags & LOOKUP_RCU) {
2376                         nd->root_seq = nd->seq;
2377                 } else {
2378                         path_get(&nd->root);
2379                         nd->flags |= LOOKUP_ROOT_GRABBED;
2380                 }
2381         }
2382         return s;
2383 }
2384
2385 static inline const char *lookup_last(struct nameidata *nd)
2386 {
2387         if (nd->last_type == LAST_NORM && nd->last.name[nd->last.len])
2388                 nd->flags |= LOOKUP_FOLLOW | LOOKUP_DIRECTORY;
2389
2390         return walk_component(nd, WALK_TRAILING);
2391 }
2392
2393 static int handle_lookup_down(struct nameidata *nd)
2394 {
2395         if (!(nd->flags & LOOKUP_RCU))
2396                 dget(nd->path.dentry);
2397         return PTR_ERR(step_into(nd, WALK_NOFOLLOW,
2398                         nd->path.dentry, nd->inode, nd->seq));
2399 }
2400
2401 /* Returns 0 and nd will be valid on success; Retuns error, otherwise. */
2402 static int path_lookupat(struct nameidata *nd, unsigned flags, struct path *path)
2403 {
2404         const char *s = path_init(nd, flags);
2405         int err;
2406
2407         if (unlikely(flags & LOOKUP_DOWN) && !IS_ERR(s)) {
2408                 err = handle_lookup_down(nd);
2409                 if (unlikely(err < 0))
2410                         s = ERR_PTR(err);
2411         }
2412
2413         while (!(err = link_path_walk(s, nd)) &&
2414                (s = lookup_last(nd)) != NULL)
2415                 ;
2416         if (!err)
2417                 err = complete_walk(nd);
2418
2419         if (!err && nd->flags & LOOKUP_DIRECTORY)
2420                 if (!d_can_lookup(nd->path.dentry))
2421                         err = -ENOTDIR;
2422         if (!err && unlikely(nd->flags & LOOKUP_MOUNTPOINT)) {
2423                 err = handle_lookup_down(nd);
2424                 nd->flags &= ~LOOKUP_JUMPED; // no d_weak_revalidate(), please...
2425         }
2426         if (!err) {
2427                 *path = nd->path;
2428                 nd->path.mnt = NULL;
2429                 nd->path.dentry = NULL;
2430         }
2431         terminate_walk(nd);
2432         return err;
2433 }
2434
2435 int filename_lookup(int dfd, struct filename *name, unsigned flags,
2436                     struct path *path, struct path *root)
2437 {
2438         int retval;
2439         struct nameidata nd;
2440         if (IS_ERR(name))
2441                 return PTR_ERR(name);
2442         if (unlikely(root)) {
2443                 nd.root = *root;
2444                 flags |= LOOKUP_ROOT;
2445         }
2446         set_nameidata(&nd, dfd, name);
2447         retval = path_lookupat(&nd, flags | LOOKUP_RCU, path);
2448         if (unlikely(retval == -ECHILD))
2449                 retval = path_lookupat(&nd, flags, path);
2450         if (unlikely(retval == -ESTALE))
2451                 retval = path_lookupat(&nd, flags | LOOKUP_REVAL, path);
2452
2453         if (likely(!retval))
2454                 audit_inode(name, path->dentry,
2455                             flags & LOOKUP_MOUNTPOINT ? AUDIT_INODE_NOEVAL : 0);
2456         restore_nameidata();
2457         putname(name);
2458         return retval;
2459 }
2460
2461 /* Returns 0 and nd will be valid on success; Retuns error, otherwise. */
2462 static int path_parentat(struct nameidata *nd, unsigned flags,
2463                                 struct path *parent)
2464 {
2465         const char *s = path_init(nd, flags);
2466         int err = link_path_walk(s, nd);
2467         if (!err)
2468                 err = complete_walk(nd);
2469         if (!err) {
2470                 *parent = nd->path;
2471                 nd->path.mnt = NULL;
2472                 nd->path.dentry = NULL;
2473         }
2474         terminate_walk(nd);
2475         return err;
2476 }
2477
2478 static struct filename *filename_parentat(int dfd, struct filename *name,
2479                                 unsigned int flags, struct path *parent,
2480                                 struct qstr *last, int *type)
2481 {
2482         int retval;
2483         struct nameidata nd;
2484
2485         if (IS_ERR(name))
2486                 return name;
2487         set_nameidata(&nd, dfd, name);
2488         retval = path_parentat(&nd, flags | LOOKUP_RCU, parent);
2489         if (unlikely(retval == -ECHILD))
2490                 retval = path_parentat(&nd, flags, parent);
2491         if (unlikely(retval == -ESTALE))
2492                 retval = path_parentat(&nd, flags | LOOKUP_REVAL, parent);
2493         if (likely(!retval)) {
2494                 *last = nd.last;
2495                 *type = nd.last_type;
2496                 audit_inode(name, parent->dentry, AUDIT_INODE_PARENT);
2497         } else {
2498                 putname(name);
2499                 name = ERR_PTR(retval);
2500         }
2501         restore_nameidata();
2502         return name;
2503 }
2504
2505 /* does lookup, returns the object with parent locked */
2506 struct dentry *kern_path_locked(const char *name, struct path *path)
2507 {
2508         struct filename *filename;
2509         struct dentry *d;
2510         struct qstr last;
2511         int type;
2512
2513         filename = filename_parentat(AT_FDCWD, getname_kernel(name), 0, path,
2514                                     &last, &type);
2515         if (IS_ERR(filename))
2516                 return ERR_CAST(filename);
2517         if (unlikely(type != LAST_NORM)) {
2518                 path_put(path);
2519                 putname(filename);
2520                 return ERR_PTR(-EINVAL);
2521         }
2522         inode_lock_nested(path->dentry->d_inode, I_MUTEX_PARENT);
2523         d = __lookup_hash(&last, path->dentry, 0);
2524         if (IS_ERR(d)) {
2525                 inode_unlock(path->dentry->d_inode);
2526                 path_put(path);
2527         }
2528         putname(filename);
2529         return d;
2530 }
2531
2532 int kern_path(const char *name, unsigned int flags, struct path *path)
2533 {
2534         return filename_lookup(AT_FDCWD, getname_kernel(name),
2535                                flags, path, NULL);
2536 }
2537 EXPORT_SYMBOL(kern_path);
2538
2539 /**
2540  * vfs_path_lookup - lookup a file path relative to a dentry-vfsmount pair
2541  * @dentry:  pointer to dentry of the base directory
2542  * @mnt: pointer to vfs mount of the base directory
2543  * @name: pointer to file name
2544  * @flags: lookup flags
2545  * @path: pointer to struct path to fill
2546  */
2547 int vfs_path_lookup(struct dentry *dentry, struct vfsmount *mnt,
2548                     const char *name, unsigned int flags,
2549                     struct path *path)
2550 {
2551         struct path root = {.mnt = mnt, .dentry = dentry};
2552         /* the first argument of filename_lookup() is ignored with root */
2553         return filename_lookup(AT_FDCWD, getname_kernel(name),
2554                                flags , path, &root);
2555 }
2556 EXPORT_SYMBOL(vfs_path_lookup);
2557
2558 static int lookup_one_len_common(const char *name, struct dentry *base,
2559                                  int len, struct qstr *this)
2560 {
2561         this->name = name;
2562         this->len = len;
2563         this->hash = full_name_hash(base, name, len);
2564         if (!len)
2565                 return -EACCES;
2566
2567         if (unlikely(name[0] == '.')) {
2568                 if (len < 2 || (len == 2 && name[1] == '.'))
2569                         return -EACCES;
2570         }
2571
2572         while (len--) {
2573                 unsigned int c = *(const unsigned char *)name++;
2574                 if (c == '/' || c == '\0')
2575                         return -EACCES;
2576         }
2577         /*
2578          * See if the low-level filesystem might want
2579          * to use its own hash..
2580          */
2581         if (base->d_flags & DCACHE_OP_HASH) {
2582                 int err = base->d_op->d_hash(base, this);
2583                 if (err < 0)
2584                         return err;
2585         }
2586
2587         return inode_permission(&init_user_ns, base->d_inode, MAY_EXEC);
2588 }
2589
2590 /**
2591  * try_lookup_one_len - filesystem helper to lookup single pathname component
2592  * @name:       pathname component to lookup
2593  * @base:       base directory to lookup from
2594  * @len:        maximum length @len should be interpreted to
2595  *
2596  * Look up a dentry by name in the dcache, returning NULL if it does not
2597  * currently exist.  The function does not try to create a dentry.
2598  *
2599  * Note that this routine is purely a helper for filesystem usage and should
2600  * not be called by generic code.
2601  *
2602  * The caller must hold base->i_mutex.
2603  */
2604 struct dentry *try_lookup_one_len(const char *name, struct dentry *base, int len)
2605 {
2606         struct qstr this;
2607         int err;
2608
2609         WARN_ON_ONCE(!inode_is_locked(base->d_inode));
2610
2611         err = lookup_one_len_common(name, base, len, &this);
2612         if (err)
2613                 return ERR_PTR(err);
2614
2615         return lookup_dcache(&this, base, 0);
2616 }
2617 EXPORT_SYMBOL(try_lookup_one_len);
2618
2619 /**
2620  * lookup_one_len - filesystem helper to lookup single pathname component
2621  * @name:       pathname component to lookup
2622  * @base:       base directory to lookup from
2623  * @len:        maximum length @len should be interpreted to
2624  *
2625  * Note that this routine is purely a helper for filesystem usage and should
2626  * not be called by generic code.
2627  *
2628  * The caller must hold base->i_mutex.
2629  */
2630 struct dentry *lookup_one_len(const char *name, struct dentry *base, int len)
2631 {
2632         struct dentry *dentry;
2633         struct qstr this;
2634         int err;
2635
2636         WARN_ON_ONCE(!inode_is_locked(base->d_inode));
2637
2638         err = lookup_one_len_common(name, base, len, &this);
2639         if (err)
2640                 return ERR_PTR(err);
2641
2642         dentry = lookup_dcache(&this, base, 0);
2643         return dentry ? dentry : __lookup_slow(&this, base, 0);
2644 }
2645 EXPORT_SYMBOL(lookup_one_len);
2646
2647 /**
2648  * lookup_one_len_unlocked - filesystem helper to lookup single pathname component
2649  * @name:       pathname component to lookup
2650  * @base:       base directory to lookup from
2651  * @len:        maximum length @len should be interpreted to
2652  *
2653  * Note that this routine is purely a helper for filesystem usage and should
2654  * not be called by generic code.
2655  *
2656  * Unlike lookup_one_len, it should be called without the parent
2657  * i_mutex held, and will take the i_mutex itself if necessary.
2658  */
2659 struct dentry *lookup_one_len_unlocked(const char *name,
2660                                        struct dentry *base, int len)
2661 {
2662         struct qstr this;
2663         int err;
2664         struct dentry *ret;
2665
2666         err = lookup_one_len_common(name, base, len, &this);
2667         if (err)
2668                 return ERR_PTR(err);
2669
2670         ret = lookup_dcache(&this, base, 0);
2671         if (!ret)
2672                 ret = lookup_slow(&this, base, 0);
2673         return ret;
2674 }
2675 EXPORT_SYMBOL(lookup_one_len_unlocked);
2676
2677 /*
2678  * Like lookup_one_len_unlocked(), except that it yields ERR_PTR(-ENOENT)
2679  * on negatives.  Returns known positive or ERR_PTR(); that's what
2680  * most of the users want.  Note that pinned negative with unlocked parent
2681  * _can_ become positive at any time, so callers of lookup_one_len_unlocked()
2682  * need to be very careful; pinned positives have ->d_inode stable, so
2683  * this one avoids such problems.
2684  */
2685 struct dentry *lookup_positive_unlocked(const char *name,
2686                                        struct dentry *base, int len)
2687 {
2688         struct dentry *ret = lookup_one_len_unlocked(name, base, len);
2689         if (!IS_ERR(ret) && d_flags_negative(smp_load_acquire(&ret->d_flags))) {
2690                 dput(ret);
2691                 ret = ERR_PTR(-ENOENT);
2692         }
2693         return ret;
2694 }
2695 EXPORT_SYMBOL(lookup_positive_unlocked);
2696
2697 #ifdef CONFIG_UNIX98_PTYS
2698 int path_pts(struct path *path)
2699 {
2700         /* Find something mounted on "pts" in the same directory as
2701          * the input path.
2702          */
2703         struct dentry *parent = dget_parent(path->dentry);
2704         struct dentry *child;
2705         struct qstr this = QSTR_INIT("pts", 3);
2706
2707         if (unlikely(!path_connected(path->mnt, parent))) {
2708                 dput(parent);
2709                 return -ENOENT;
2710         }
2711         dput(path->dentry);
2712         path->dentry = parent;
2713         child = d_hash_and_lookup(parent, &this);
2714         if (!child)
2715                 return -ENOENT;
2716
2717         path->dentry = child;
2718         dput(parent);
2719         follow_down(path);
2720         return 0;
2721 }
2722 #endif
2723
2724 int user_path_at_empty(int dfd, const char __user *name, unsigned flags,
2725                  struct path *path, int *empty)
2726 {
2727         return filename_lookup(dfd, getname_flags(name, flags, empty),
2728                                flags, path, NULL);
2729 }
2730 EXPORT_SYMBOL(user_path_at_empty);
2731
2732 int __check_sticky(struct user_namespace *mnt_userns, struct inode *dir,
2733                    struct inode *inode)
2734 {
2735         kuid_t fsuid = current_fsuid();
2736
2737         if (uid_eq(i_uid_into_mnt(mnt_userns, inode), fsuid))
2738                 return 0;
2739         if (uid_eq(i_uid_into_mnt(mnt_userns, dir), fsuid))
2740                 return 0;
2741         return !capable_wrt_inode_uidgid(mnt_userns, inode, CAP_FOWNER);
2742 }
2743 EXPORT_SYMBOL(__check_sticky);
2744
2745 /*
2746  *      Check whether we can remove a link victim from directory dir, check
2747  *  whether the type of victim is right.
2748  *  1. We can't do it if dir is read-only (done in permission())
2749  *  2. We should have write and exec permissions on dir
2750  *  3. We can't remove anything from append-only dir
2751  *  4. We can't do anything with immutable dir (done in permission())
2752  *  5. If the sticky bit on dir is set we should either
2753  *      a. be owner of dir, or
2754  *      b. be owner of victim, or
2755  *      c. have CAP_FOWNER capability
2756  *  6. If the victim is append-only or immutable we can't do antyhing with
2757  *     links pointing to it.
2758  *  7. If the victim has an unknown uid or gid we can't change the inode.
2759  *  8. If we were asked to remove a directory and victim isn't one - ENOTDIR.
2760  *  9. If we were asked to remove a non-directory and victim isn't one - EISDIR.
2761  * 10. We can't remove a root or mountpoint.
2762  * 11. We don't allow removal of NFS sillyrenamed files; it's handled by
2763  *     nfs_async_unlink().
2764  */
2765 static int may_delete(struct user_namespace *mnt_userns, struct inode *dir,
2766                       struct dentry *victim, bool isdir)
2767 {
2768         struct inode *inode = d_backing_inode(victim);
2769         int error;
2770
2771         if (d_is_negative(victim))
2772                 return -ENOENT;
2773         BUG_ON(!inode);
2774
2775         BUG_ON(victim->d_parent->d_inode != dir);
2776
2777         /* Inode writeback is not safe when the uid or gid are invalid. */
2778         if (!uid_valid(i_uid_into_mnt(mnt_userns, inode)) ||
2779             !gid_valid(i_gid_into_mnt(mnt_userns, inode)))
2780                 return -EOVERFLOW;
2781
2782         audit_inode_child(dir, victim, AUDIT_TYPE_CHILD_DELETE);
2783
2784         error = inode_permission(mnt_userns, dir, MAY_WRITE | MAY_EXEC);
2785         if (error)
2786                 return error;
2787         if (IS_APPEND(dir))
2788                 return -EPERM;
2789
2790         if (check_sticky(mnt_userns, dir, inode) || IS_APPEND(inode) ||
2791             IS_IMMUTABLE(inode) || IS_SWAPFILE(inode) ||
2792             HAS_UNMAPPED_ID(mnt_userns, inode))
2793                 return -EPERM;
2794         if (isdir) {
2795                 if (!d_is_dir(victim))
2796                         return -ENOTDIR;
2797                 if (IS_ROOT(victim))
2798                         return -EBUSY;
2799         } else if (d_is_dir(victim))
2800                 return -EISDIR;
2801         if (IS_DEADDIR(dir))
2802                 return -ENOENT;
2803         if (victim->d_flags & DCACHE_NFSFS_RENAMED)
2804                 return -EBUSY;
2805         return 0;
2806 }
2807
2808 /*      Check whether we can create an object with dentry child in directory
2809  *  dir.
2810  *  1. We can't do it if child already exists (open has special treatment for
2811  *     this case, but since we are inlined it's OK)
2812  *  2. We can't do it if dir is read-only (done in permission())
2813  *  3. We can't do it if the fs can't represent the fsuid or fsgid.
2814  *  4. We should have write and exec permissions on dir
2815  *  5. We can't do it if dir is immutable (done in permission())
2816  */
2817 static inline int may_create(struct user_namespace *mnt_userns,
2818                              struct inode *dir, struct dentry *child)
2819 {
2820         struct user_namespace *s_user_ns;
2821         audit_inode_child(dir, child, AUDIT_TYPE_CHILD_CREATE);
2822         if (child->d_inode)
2823                 return -EEXIST;
2824         if (IS_DEADDIR(dir))
2825                 return -ENOENT;
2826         s_user_ns = dir->i_sb->s_user_ns;
2827         if (!kuid_has_mapping(s_user_ns, fsuid_into_mnt(mnt_userns)) ||
2828             !kgid_has_mapping(s_user_ns, fsgid_into_mnt(mnt_userns)))
2829                 return -EOVERFLOW;
2830         return inode_permission(mnt_userns, dir, MAY_WRITE | MAY_EXEC);
2831 }
2832
2833 /*
2834  * p1 and p2 should be directories on the same fs.
2835  */
2836 struct dentry *lock_rename(struct dentry *p1, struct dentry *p2)
2837 {
2838         struct dentry *p;
2839
2840         if (p1 == p2) {
2841                 inode_lock_nested(p1->d_inode, I_MUTEX_PARENT);
2842                 return NULL;
2843         }
2844
2845         mutex_lock(&p1->d_sb->s_vfs_rename_mutex);
2846
2847         p = d_ancestor(p2, p1);
2848         if (p) {
2849                 inode_lock_nested(p2->d_inode, I_MUTEX_PARENT);
2850                 inode_lock_nested(p1->d_inode, I_MUTEX_CHILD);
2851                 return p;
2852         }
2853
2854         p = d_ancestor(p1, p2);
2855         if (p) {
2856                 inode_lock_nested(p1->d_inode, I_MUTEX_PARENT);
2857                 inode_lock_nested(p2->d_inode, I_MUTEX_CHILD);
2858                 return p;
2859         }
2860
2861         inode_lock_nested(p1->d_inode, I_MUTEX_PARENT);
2862         inode_lock_nested(p2->d_inode, I_MUTEX_PARENT2);
2863         return NULL;
2864 }
2865 EXPORT_SYMBOL(lock_rename);
2866
2867 void unlock_rename(struct dentry *p1, struct dentry *p2)
2868 {
2869         inode_unlock(p1->d_inode);
2870         if (p1 != p2) {
2871                 inode_unlock(p2->d_inode);
2872                 mutex_unlock(&p1->d_sb->s_vfs_rename_mutex);
2873         }
2874 }
2875 EXPORT_SYMBOL(unlock_rename);
2876
2877 int vfs_create(struct inode *dir, struct dentry *dentry, umode_t mode,
2878                 bool want_excl)
2879 {
2880         int error = may_create(&init_user_ns, dir, dentry);
2881         if (error)
2882                 return error;
2883
2884         if (!dir->i_op->create)
2885                 return -EACCES; /* shouldn't it be ENOSYS? */
2886         mode &= S_IALLUGO;
2887         mode |= S_IFREG;
2888         error = security_inode_create(dir, dentry, mode);
2889         if (error)
2890                 return error;
2891         error = dir->i_op->create(dir, dentry, mode, want_excl);
2892         if (!error)
2893                 fsnotify_create(dir, dentry);
2894         return error;
2895 }
2896 EXPORT_SYMBOL(vfs_create);
2897
2898 int vfs_mkobj(struct dentry *dentry, umode_t mode,
2899                 int (*f)(struct dentry *, umode_t, void *),
2900                 void *arg)
2901 {
2902         struct inode *dir = dentry->d_parent->d_inode;
2903         int error = may_create(&init_user_ns, dir, dentry);
2904         if (error)
2905                 return error;
2906
2907         mode &= S_IALLUGO;
2908         mode |= S_IFREG;
2909         error = security_inode_create(dir, dentry, mode);
2910         if (error)
2911                 return error;
2912         error = f(dentry, mode, arg);
2913         if (!error)
2914                 fsnotify_create(dir, dentry);
2915         return error;
2916 }
2917 EXPORT_SYMBOL(vfs_mkobj);
2918
2919 bool may_open_dev(const struct path *path)
2920 {
2921         return !(path->mnt->mnt_flags & MNT_NODEV) &&
2922                 !(path->mnt->mnt_sb->s_iflags & SB_I_NODEV);
2923 }
2924
2925 static int may_open(struct user_namespace *mnt_userns, const struct path *path,
2926                     int acc_mode, int flag)
2927 {
2928         struct dentry *dentry = path->dentry;
2929         struct inode *inode = dentry->d_inode;
2930         int error;
2931
2932         if (!inode)
2933                 return -ENOENT;
2934
2935         switch (inode->i_mode & S_IFMT) {
2936         case S_IFLNK:
2937                 return -ELOOP;
2938         case S_IFDIR:
2939                 if (acc_mode & MAY_WRITE)
2940                         return -EISDIR;
2941                 if (acc_mode & MAY_EXEC)
2942                         return -EACCES;
2943                 break;
2944         case S_IFBLK:
2945         case S_IFCHR:
2946                 if (!may_open_dev(path))
2947                         return -EACCES;
2948                 fallthrough;
2949         case S_IFIFO:
2950         case S_IFSOCK:
2951                 if (acc_mode & MAY_EXEC)
2952                         return -EACCES;
2953                 flag &= ~O_TRUNC;
2954                 break;
2955         case S_IFREG:
2956                 if ((acc_mode & MAY_EXEC) && path_noexec(path))
2957                         return -EACCES;
2958                 break;
2959         }
2960
2961         error = inode_permission(mnt_userns, inode, MAY_OPEN | acc_mode);
2962         if (error)
2963                 return error;
2964
2965         /*
2966          * An append-only file must be opened in append mode for writing.
2967          */
2968         if (IS_APPEND(inode)) {
2969                 if  ((flag & O_ACCMODE) != O_RDONLY && !(flag & O_APPEND))
2970                         return -EPERM;
2971                 if (flag & O_TRUNC)
2972                         return -EPERM;
2973         }
2974
2975         /* O_NOATIME can only be set by the owner or superuser */
2976         if (flag & O_NOATIME && !inode_owner_or_capable(mnt_userns, inode))
2977                 return -EPERM;
2978
2979         return 0;
2980 }
2981
2982 static int handle_truncate(struct file *filp)
2983 {
2984         const struct path *path = &filp->f_path;
2985         struct inode *inode = path->dentry->d_inode;
2986         int error = get_write_access(inode);
2987         if (error)
2988                 return error;
2989         /*
2990          * Refuse to truncate files with mandatory locks held on them.
2991          */
2992         error = locks_verify_locked(filp);
2993         if (!error)
2994                 error = security_path_truncate(path);
2995         if (!error) {
2996                 error = do_truncate(path->dentry, 0,
2997                                     ATTR_MTIME|ATTR_CTIME|ATTR_OPEN,
2998                                     filp);
2999         }
3000         put_write_access(inode);
3001         return error;
3002 }
3003
3004 static inline int open_to_namei_flags(int flag)
3005 {
3006         if ((flag & O_ACCMODE) == 3)
3007                 flag--;
3008         return flag;
3009 }
3010
3011 static int may_o_create(struct user_namespace *mnt_userns,
3012                         const struct path *dir, struct dentry *dentry,
3013                         umode_t mode)
3014 {
3015         struct user_namespace *s_user_ns;
3016         int error = security_path_mknod(dir, dentry, mode, 0);
3017         if (error)
3018                 return error;
3019
3020         s_user_ns = dir->dentry->d_sb->s_user_ns;
3021         if (!kuid_has_mapping(s_user_ns, fsuid_into_mnt(mnt_userns)) ||
3022             !kgid_has_mapping(s_user_ns, fsgid_into_mnt(mnt_userns)))
3023                 return -EOVERFLOW;
3024
3025         error = inode_permission(mnt_userns, dir->dentry->d_inode,
3026                                  MAY_WRITE | MAY_EXEC);
3027         if (error)
3028                 return error;
3029
3030         return security_inode_create(dir->dentry->d_inode, dentry, mode);
3031 }
3032
3033 /*
3034  * Attempt to atomically look up, create and open a file from a negative
3035  * dentry.
3036  *
3037  * Returns 0 if successful.  The file will have been created and attached to
3038  * @file by the filesystem calling finish_open().
3039  *
3040  * If the file was looked up only or didn't need creating, FMODE_OPENED won't
3041  * be set.  The caller will need to perform the open themselves.  @path will
3042  * have been updated to point to the new dentry.  This may be negative.
3043  *
3044  * Returns an error code otherwise.
3045  */
3046 static struct dentry *atomic_open(struct nameidata *nd, struct dentry *dentry,
3047                                   struct file *file,
3048                                   int open_flag, umode_t mode)
3049 {
3050         struct dentry *const DENTRY_NOT_SET = (void *) -1UL;
3051         struct inode *dir =  nd->path.dentry->d_inode;
3052         int error;
3053
3054         if (nd->flags & LOOKUP_DIRECTORY)
3055                 open_flag |= O_DIRECTORY;
3056
3057         file->f_path.dentry = DENTRY_NOT_SET;
3058         file->f_path.mnt = nd->path.mnt;
3059         error = dir->i_op->atomic_open(dir, dentry, file,
3060                                        open_to_namei_flags(open_flag), mode);
3061         d_lookup_done(dentry);
3062         if (!error) {
3063                 if (file->f_mode & FMODE_OPENED) {
3064                         if (unlikely(dentry != file->f_path.dentry)) {
3065                                 dput(dentry);
3066                                 dentry = dget(file->f_path.dentry);
3067                         }
3068                 } else if (WARN_ON(file->f_path.dentry == DENTRY_NOT_SET)) {
3069                         error = -EIO;
3070                 } else {
3071                         if (file->f_path.dentry) {
3072                                 dput(dentry);
3073                                 dentry = file->f_path.dentry;
3074                         }
3075                         if (unlikely(d_is_negative(dentry)))
3076                                 error = -ENOENT;
3077                 }
3078         }
3079         if (error) {
3080                 dput(dentry);
3081                 dentry = ERR_PTR(error);
3082         }
3083         return dentry;
3084 }
3085
3086 /*
3087  * Look up and maybe create and open the last component.
3088  *
3089  * Must be called with parent locked (exclusive in O_CREAT case).
3090  *
3091  * Returns 0 on success, that is, if
3092  *  the file was successfully atomically created (if necessary) and opened, or
3093  *  the file was not completely opened at this time, though lookups and
3094  *  creations were performed.
3095  * These case are distinguished by presence of FMODE_OPENED on file->f_mode.
3096  * In the latter case dentry returned in @path might be negative if O_CREAT
3097  * hadn't been specified.
3098  *
3099  * An error code is returned on failure.
3100  */
3101 static struct dentry *lookup_open(struct nameidata *nd, struct file *file,
3102                                   const struct open_flags *op,
3103                                   bool got_write)
3104 {
3105         struct dentry *dir = nd->path.dentry;
3106         struct inode *dir_inode = dir->d_inode;
3107         int open_flag = op->open_flag;
3108         struct dentry *dentry;
3109         int error, create_error = 0;
3110         umode_t mode = op->mode;
3111         DECLARE_WAIT_QUEUE_HEAD_ONSTACK(wq);
3112
3113         if (unlikely(IS_DEADDIR(dir_inode)))
3114                 return ERR_PTR(-ENOENT);
3115
3116         file->f_mode &= ~FMODE_CREATED;
3117         dentry = d_lookup(dir, &nd->last);
3118         for (;;) {
3119                 if (!dentry) {
3120                         dentry = d_alloc_parallel(dir, &nd->last, &wq);
3121                         if (IS_ERR(dentry))
3122                                 return dentry;
3123                 }
3124                 if (d_in_lookup(dentry))
3125                         break;
3126
3127                 error = d_revalidate(dentry, nd->flags);
3128                 if (likely(error > 0))
3129                         break;
3130                 if (error)
3131                         goto out_dput;
3132                 d_invalidate(dentry);
3133                 dput(dentry);
3134                 dentry = NULL;
3135         }
3136         if (dentry->d_inode) {
3137                 /* Cached positive dentry: will open in f_op->open */
3138                 return dentry;
3139         }
3140
3141         /*
3142          * Checking write permission is tricky, bacuse we don't know if we are
3143          * going to actually need it: O_CREAT opens should work as long as the
3144          * file exists.  But checking existence breaks atomicity.  The trick is
3145          * to check access and if not granted clear O_CREAT from the flags.
3146          *
3147          * Another problem is returing the "right" error value (e.g. for an
3148          * O_EXCL open we want to return EEXIST not EROFS).
3149          */
3150         if (unlikely(!got_write))
3151                 open_flag &= ~O_TRUNC;
3152         if (open_flag & O_CREAT) {
3153                 if (open_flag & O_EXCL)
3154                         open_flag &= ~O_TRUNC;
3155                 if (!IS_POSIXACL(dir->d_inode))
3156                         mode &= ~current_umask();
3157                 if (likely(got_write))
3158                         create_error = may_o_create(&init_user_ns, &nd->path,
3159                                                     dentry, mode);
3160                 else
3161                         create_error = -EROFS;
3162         }
3163         if (create_error)
3164                 open_flag &= ~O_CREAT;
3165         if (dir_inode->i_op->atomic_open) {
3166                 dentry = atomic_open(nd, dentry, file, open_flag, mode);
3167                 if (unlikely(create_error) && dentry == ERR_PTR(-ENOENT))
3168                         dentry = ERR_PTR(create_error);
3169                 return dentry;
3170         }
3171
3172         if (d_in_lookup(dentry)) {
3173                 struct dentry *res = dir_inode->i_op->lookup(dir_inode, dentry,
3174                                                              nd->flags);
3175                 d_lookup_done(dentry);
3176                 if (unlikely(res)) {
3177                         if (IS_ERR(res)) {
3178                                 error = PTR_ERR(res);
3179                                 goto out_dput;
3180                         }
3181                         dput(dentry);
3182                         dentry = res;
3183                 }
3184         }
3185
3186         /* Negative dentry, just create the file */
3187         if (!dentry->d_inode && (open_flag & O_CREAT)) {
3188                 file->f_mode |= FMODE_CREATED;
3189                 audit_inode_child(dir_inode, dentry, AUDIT_TYPE_CHILD_CREATE);
3190                 if (!dir_inode->i_op->create) {
3191                         error = -EACCES;
3192                         goto out_dput;
3193                 }
3194                 error = dir_inode->i_op->create(dir_inode, dentry, mode,
3195                                                 open_flag & O_EXCL);
3196                 if (error)
3197                         goto out_dput;
3198         }
3199         if (unlikely(create_error) && !dentry->d_inode) {
3200                 error = create_error;
3201                 goto out_dput;
3202         }
3203         return dentry;
3204
3205 out_dput:
3206         dput(dentry);
3207         return ERR_PTR(error);
3208 }
3209
3210 static const char *open_last_lookups(struct nameidata *nd,
3211                    struct file *file, const struct open_flags *op)
3212 {
3213         struct dentry *dir = nd->path.dentry;
3214         int open_flag = op->open_flag;
3215         bool got_write = false;
3216         unsigned seq;
3217         struct inode *inode;
3218         struct dentry *dentry;
3219         const char *res;
3220         int error;
3221
3222         nd->flags |= op->intent;
3223
3224         if (nd->last_type != LAST_NORM) {
3225                 if (nd->depth)
3226                         put_link(nd);
3227                 return handle_dots(nd, nd->last_type);
3228         }
3229
3230         if (!(open_flag & O_CREAT)) {
3231                 if (nd->last.name[nd->last.len])
3232                         nd->flags |= LOOKUP_FOLLOW | LOOKUP_DIRECTORY;
3233                 /* we _can_ be in RCU mode here */
3234                 dentry = lookup_fast(nd, &inode, &seq);
3235                 if (IS_ERR(dentry))
3236                         return ERR_CAST(dentry);
3237                 if (likely(dentry))
3238                         goto finish_lookup;
3239
3240                 BUG_ON(nd->flags & LOOKUP_RCU);
3241         } else {
3242                 /* create side of things */
3243                 if (nd->flags & LOOKUP_RCU) {
3244                         error = unlazy_walk(nd);
3245                         if (unlikely(error))
3246                                 return ERR_PTR(error);
3247                 }
3248                 audit_inode(nd->name, dir, AUDIT_INODE_PARENT);
3249                 /* trailing slashes? */
3250                 if (unlikely(nd->last.name[nd->last.len]))
3251                         return ERR_PTR(-EISDIR);
3252         }
3253
3254         if (open_flag & (O_CREAT | O_TRUNC | O_WRONLY | O_RDWR)) {
3255                 error = mnt_want_write(nd->path.mnt);
3256                 if (!error)
3257                         got_write = true;
3258                 /*
3259                  * do _not_ fail yet - we might not need that or fail with
3260                  * a different error; let lookup_open() decide; we'll be
3261                  * dropping this one anyway.
3262                  */
3263         }
3264         if (open_flag & O_CREAT)
3265                 inode_lock(dir->d_inode);
3266         else
3267                 inode_lock_shared(dir->d_inode);
3268         dentry = lookup_open(nd, file, op, got_write);
3269         if (!IS_ERR(dentry) && (file->f_mode & FMODE_CREATED))
3270                 fsnotify_create(dir->d_inode, dentry);
3271         if (open_flag & O_CREAT)
3272                 inode_unlock(dir->d_inode);
3273         else
3274                 inode_unlock_shared(dir->d_inode);
3275
3276         if (got_write)
3277                 mnt_drop_write(nd->path.mnt);
3278
3279         if (IS_ERR(dentry))
3280                 return ERR_CAST(dentry);
3281
3282         if (file->f_mode & (FMODE_OPENED | FMODE_CREATED)) {
3283                 dput(nd->path.dentry);
3284                 nd->path.dentry = dentry;
3285                 return NULL;
3286         }
3287
3288 finish_lookup:
3289         if (nd->depth)
3290                 put_link(nd);
3291         res = step_into(nd, WALK_TRAILING, dentry, inode, seq);
3292         if (unlikely(res))
3293                 nd->flags &= ~(LOOKUP_OPEN|LOOKUP_CREATE|LOOKUP_EXCL);
3294         return res;
3295 }
3296
3297 /*
3298  * Handle the last step of open()
3299  */
3300 static int do_open(struct nameidata *nd,
3301                    struct file *file, const struct open_flags *op)
3302 {
3303         int open_flag = op->open_flag;
3304         bool do_truncate;
3305         int acc_mode;
3306         int error;
3307
3308         if (!(file->f_mode & (FMODE_OPENED | FMODE_CREATED))) {
3309                 error = complete_walk(nd);
3310                 if (error)
3311                         return error;
3312         }
3313         if (!(file->f_mode & FMODE_CREATED))
3314                 audit_inode(nd->name, nd->path.dentry, 0);
3315         if (open_flag & O_CREAT) {
3316                 if ((open_flag & O_EXCL) && !(file->f_mode & FMODE_CREATED))
3317                         return -EEXIST;
3318                 if (d_is_dir(nd->path.dentry))
3319                         return -EISDIR;
3320                 error = may_create_in_sticky(&init_user_ns, nd,
3321                                              d_backing_inode(nd->path.dentry));
3322                 if (unlikely(error))
3323                         return error;
3324         }
3325         if ((nd->flags & LOOKUP_DIRECTORY) && !d_can_lookup(nd->path.dentry))
3326                 return -ENOTDIR;
3327
3328         do_truncate = false;
3329         acc_mode = op->acc_mode;
3330         if (file->f_mode & FMODE_CREATED) {
3331                 /* Don't check for write permission, don't truncate */
3332                 open_flag &= ~O_TRUNC;
3333                 acc_mode = 0;
3334         } else if (d_is_reg(nd->path.dentry) && open_flag & O_TRUNC) {
3335                 error = mnt_want_write(nd->path.mnt);
3336                 if (error)
3337                         return error;
3338                 do_truncate = true;
3339         }
3340         error = may_open(&init_user_ns, &nd->path, acc_mode, open_flag);
3341         if (!error && !(file->f_mode & FMODE_OPENED))
3342                 error = vfs_open(&nd->path, file);
3343         if (!error)
3344                 error = ima_file_check(file, op->acc_mode);
3345         if (!error && do_truncate)
3346                 error = handle_truncate(file);
3347         if (unlikely(error > 0)) {
3348                 WARN_ON(1);
3349                 error = -EINVAL;
3350         }
3351         if (do_truncate)
3352                 mnt_drop_write(nd->path.mnt);
3353         return error;
3354 }
3355
3356 struct dentry *vfs_tmpfile(struct dentry *dentry, umode_t mode, int open_flag)
3357 {
3358         struct dentry *child = NULL;
3359         struct inode *dir = dentry->d_inode;
3360         struct inode *inode;
3361         int error;
3362
3363         /* we want directory to be writable */
3364         error = inode_permission(&init_user_ns, dir, MAY_WRITE | MAY_EXEC);
3365         if (error)
3366                 goto out_err;
3367         error = -EOPNOTSUPP;
3368         if (!dir->i_op->tmpfile)
3369                 goto out_err;
3370         error = -ENOMEM;
3371         child = d_alloc(dentry, &slash_name);
3372         if (unlikely(!child))
3373                 goto out_err;
3374         error = dir->i_op->tmpfile(dir, child, mode);
3375         if (error)
3376                 goto out_err;
3377         error = -ENOENT;
3378         inode = child->d_inode;
3379         if (unlikely(!inode))
3380                 goto out_err;
3381         if (!(open_flag & O_EXCL)) {
3382                 spin_lock(&inode->i_lock);
3383                 inode->i_state |= I_LINKABLE;
3384                 spin_unlock(&inode->i_lock);
3385         }
3386         ima_post_create_tmpfile(inode);
3387         return child;
3388
3389 out_err:
3390         dput(child);
3391         return ERR_PTR(error);
3392 }
3393 EXPORT_SYMBOL(vfs_tmpfile);
3394
3395 static int do_tmpfile(struct nameidata *nd, unsigned flags,
3396                 const struct open_flags *op,
3397                 struct file *file)
3398 {
3399         struct dentry *child;
3400         struct path path;
3401         int error = path_lookupat(nd, flags | LOOKUP_DIRECTORY, &path);
3402         if (unlikely(error))
3403                 return error;
3404         error = mnt_want_write(path.mnt);
3405         if (unlikely(error))
3406                 goto out;
3407         child = vfs_tmpfile(path.dentry, op->mode, op->open_flag);
3408         error = PTR_ERR(child);
3409         if (IS_ERR(child))
3410                 goto out2;
3411         dput(path.dentry);
3412         path.dentry = child;
3413         audit_inode(nd->name, child, 0);
3414         /* Don't check for other permissions, the inode was just created */
3415         error = may_open(&init_user_ns, &path, 0, op->open_flag);
3416         if (error)
3417                 goto out2;
3418         file->f_path.mnt = path.mnt;
3419         error = finish_open(file, child, NULL);
3420 out2:
3421         mnt_drop_write(path.mnt);
3422 out:
3423         path_put(&path);
3424         return error;
3425 }
3426
3427 static int do_o_path(struct nameidata *nd, unsigned flags, struct file *file)
3428 {
3429         struct path path;
3430         int error = path_lookupat(nd, flags, &path);
3431         if (!error) {
3432                 audit_inode(nd->name, path.dentry, 0);
3433                 error = vfs_open(&path, file);
3434                 path_put(&path);
3435         }
3436         return error;
3437 }
3438
3439 static struct file *path_openat(struct nameidata *nd,
3440                         const struct open_flags *op, unsigned flags)
3441 {
3442         struct file *file;
3443         int error;
3444
3445         file = alloc_empty_file(op->open_flag, current_cred());
3446         if (IS_ERR(file))
3447                 return file;
3448
3449         if (unlikely(file->f_flags & __O_TMPFILE)) {
3450                 error = do_tmpfile(nd, flags, op, file);
3451         } else if (unlikely(file->f_flags & O_PATH)) {
3452                 error = do_o_path(nd, flags, file);
3453         } else {
3454                 const char *s = path_init(nd, flags);
3455                 while (!(error = link_path_walk(s, nd)) &&
3456                        (s = open_last_lookups(nd, file, op)) != NULL)
3457                         ;
3458                 if (!error)
3459                         error = do_open(nd, file, op);
3460                 terminate_walk(nd);
3461         }
3462         if (likely(!error)) {
3463                 if (likely(file->f_mode & FMODE_OPENED))
3464                         return file;
3465                 WARN_ON(1);
3466                 error = -EINVAL;
3467         }
3468         fput(file);
3469         if (error == -EOPENSTALE) {
3470                 if (flags & LOOKUP_RCU)
3471                         error = -ECHILD;
3472                 else
3473                         error = -ESTALE;
3474         }
3475         return ERR_PTR(error);
3476 }
3477
3478 struct file *do_filp_open(int dfd, struct filename *pathname,
3479                 const struct open_flags *op)
3480 {
3481         struct nameidata nd;
3482         int flags = op->lookup_flags;
3483         struct file *filp;
3484
3485         set_nameidata(&nd, dfd, pathname);
3486         filp = path_openat(&nd, op, flags | LOOKUP_RCU);
3487         if (unlikely(filp == ERR_PTR(-ECHILD)))
3488                 filp = path_openat(&nd, op, flags);
3489         if (unlikely(filp == ERR_PTR(-ESTALE)))
3490                 filp = path_openat(&nd, op, flags | LOOKUP_REVAL);
3491         restore_nameidata();
3492         return filp;
3493 }
3494
3495 struct file *do_file_open_root(struct dentry *dentry, struct vfsmount *mnt,
3496                 const char *name, const struct open_flags *op)
3497 {
3498         struct nameidata nd;
3499         struct file *file;
3500         struct filename *filename;
3501         int flags = op->lookup_flags | LOOKUP_ROOT;
3502
3503         nd.root.mnt = mnt;
3504         nd.root.dentry = dentry;
3505
3506         if (d_is_symlink(dentry) && op->intent & LOOKUP_OPEN)
3507                 return ERR_PTR(-ELOOP);
3508
3509         filename = getname_kernel(name);
3510         if (IS_ERR(filename))
3511                 return ERR_CAST(filename);
3512
3513         set_nameidata(&nd, -1, filename);
3514         file = path_openat(&nd, op, flags | LOOKUP_RCU);
3515         if (unlikely(file == ERR_PTR(-ECHILD)))
3516                 file = path_openat(&nd, op, flags);
3517         if (unlikely(file == ERR_PTR(-ESTALE)))
3518                 file = path_openat(&nd, op, flags | LOOKUP_REVAL);
3519         restore_nameidata();
3520         putname(filename);
3521         return file;
3522 }
3523
3524 static struct dentry *filename_create(int dfd, struct filename *name,
3525                                 struct path *path, unsigned int lookup_flags)
3526 {
3527         struct dentry *dentry = ERR_PTR(-EEXIST);
3528         struct qstr last;
3529         int type;
3530         int err2;
3531         int error;
3532         bool is_dir = (lookup_flags & LOOKUP_DIRECTORY);
3533
3534         /*
3535          * Note that only LOOKUP_REVAL and LOOKUP_DIRECTORY matter here. Any
3536          * other flags passed in are ignored!
3537          */
3538         lookup_flags &= LOOKUP_REVAL;
3539
3540         name = filename_parentat(dfd, name, lookup_flags, path, &last, &type);
3541         if (IS_ERR(name))
3542                 return ERR_CAST(name);
3543
3544         /*
3545          * Yucky last component or no last component at all?
3546          * (foo/., foo/.., /////)
3547          */
3548         if (unlikely(type != LAST_NORM))
3549                 goto out;
3550
3551         /* don't fail immediately if it's r/o, at least try to report other errors */
3552         err2 = mnt_want_write(path->mnt);
3553         /*
3554          * Do the final lookup.
3555          */
3556         lookup_flags |= LOOKUP_CREATE | LOOKUP_EXCL;
3557         inode_lock_nested(path->dentry->d_inode, I_MUTEX_PARENT);
3558         dentry = __lookup_hash(&last, path->dentry, lookup_flags);
3559         if (IS_ERR(dentry))
3560                 goto unlock;
3561
3562         error = -EEXIST;
3563         if (d_is_positive(dentry))
3564                 goto fail;
3565
3566         /*
3567          * Special case - lookup gave negative, but... we had foo/bar/
3568          * From the vfs_mknod() POV we just have a negative dentry -
3569          * all is fine. Let's be bastards - you had / on the end, you've
3570          * been asking for (non-existent) directory. -ENOENT for you.
3571          */
3572         if (unlikely(!is_dir && last.name[last.len])) {
3573                 error = -ENOENT;
3574                 goto fail;
3575         }
3576         if (unlikely(err2)) {
3577                 error = err2;
3578                 goto fail;
3579         }
3580         putname(name);
3581         return dentry;
3582 fail:
3583         dput(dentry);
3584         dentry = ERR_PTR(error);
3585 unlock:
3586         inode_unlock(path->dentry->d_inode);
3587         if (!err2)
3588                 mnt_drop_write(path->mnt);
3589 out:
3590         path_put(path);
3591         putname(name);
3592         return dentry;
3593 }
3594
3595 struct dentry *kern_path_create(int dfd, const char *pathname,
3596                                 struct path *path, unsigned int lookup_flags)
3597 {
3598         return filename_create(dfd, getname_kernel(pathname),
3599                                 path, lookup_flags);
3600 }
3601 EXPORT_SYMBOL(kern_path_create);
3602
3603 void done_path_create(struct path *path, struct dentry *dentry)
3604 {
3605         dput(dentry);
3606         inode_unlock(path->dentry->d_inode);
3607         mnt_drop_write(path->mnt);
3608         path_put(path);
3609 }
3610 EXPORT_SYMBOL(done_path_create);
3611
3612 inline struct dentry *user_path_create(int dfd, const char __user *pathname,
3613                                 struct path *path, unsigned int lookup_flags)
3614 {
3615         return filename_create(dfd, getname(pathname), path, lookup_flags);
3616 }
3617 EXPORT_SYMBOL(user_path_create);
3618
3619 int vfs_mknod(struct inode *dir, struct dentry *dentry, umode_t mode, dev_t dev)
3620 {
3621         bool is_whiteout = S_ISCHR(mode) && dev == WHITEOUT_DEV;
3622         int error = may_create(&init_user_ns, dir, dentry);
3623
3624         if (error)
3625                 return error;
3626
3627         if ((S_ISCHR(mode) || S_ISBLK(mode)) && !is_whiteout &&
3628             !capable(CAP_MKNOD))
3629                 return -EPERM;
3630
3631         if (!dir->i_op->mknod)
3632                 return -EPERM;
3633
3634         error = devcgroup_inode_mknod(mode, dev);
3635         if (error)
3636                 return error;
3637
3638         error = security_inode_mknod(dir, dentry, mode, dev);
3639         if (error)
3640                 return error;
3641
3642         error = dir->i_op->mknod(dir, dentry, mode, dev);
3643         if (!error)
3644                 fsnotify_create(dir, dentry);
3645         return error;
3646 }
3647 EXPORT_SYMBOL(vfs_mknod);
3648
3649 static int may_mknod(umode_t mode)
3650 {
3651         switch (mode & S_IFMT) {
3652         case S_IFREG:
3653         case S_IFCHR:
3654         case S_IFBLK:
3655         case S_IFIFO:
3656         case S_IFSOCK:
3657         case 0: /* zero mode translates to S_IFREG */
3658                 return 0;
3659         case S_IFDIR:
3660                 return -EPERM;
3661         default:
3662                 return -EINVAL;
3663         }
3664 }
3665
3666 static long do_mknodat(int dfd, const char __user *filename, umode_t mode,
3667                 unsigned int dev)
3668 {
3669         struct dentry *dentry;
3670         struct path path;
3671         int error;
3672         unsigned int lookup_flags = 0;
3673
3674         error = may_mknod(mode);
3675         if (error)
3676                 return error;
3677 retry:
3678         dentry = user_path_create(dfd, filename, &path, lookup_flags);
3679         if (IS_ERR(dentry))
3680                 return PTR_ERR(dentry);
3681
3682         if (!IS_POSIXACL(path.dentry->d_inode))
3683                 mode &= ~current_umask();
3684         error = security_path_mknod(&path, dentry, mode, dev);
3685         if (error)
3686                 goto out;
3687         switch (mode & S_IFMT) {
3688                 case 0: case S_IFREG:
3689                         error = vfs_create(path.dentry->d_inode,dentry,mode,true);
3690                         if (!error)
3691                                 ima_post_path_mknod(dentry);
3692                         break;
3693                 case S_IFCHR: case S_IFBLK:
3694                         error = vfs_mknod(path.dentry->d_inode,dentry,mode,
3695                                         new_decode_dev(dev));
3696                         break;
3697                 case S_IFIFO: case S_IFSOCK:
3698                         error = vfs_mknod(path.dentry->d_inode,dentry,mode,0);
3699                         break;
3700         }
3701 out:
3702         done_path_create(&path, dentry);
3703         if (retry_estale(error, lookup_flags)) {
3704                 lookup_flags |= LOOKUP_REVAL;
3705                 goto retry;
3706         }
3707         return error;
3708 }
3709
3710 SYSCALL_DEFINE4(mknodat, int, dfd, const char __user *, filename, umode_t, mode,
3711                 unsigned int, dev)
3712 {
3713         return do_mknodat(dfd, filename, mode, dev);
3714 }
3715
3716 SYSCALL_DEFINE3(mknod, const char __user *, filename, umode_t, mode, unsigned, dev)
3717 {
3718         return do_mknodat(AT_FDCWD, filename, mode, dev);
3719 }
3720
3721 int vfs_mkdir(struct inode *dir, struct dentry *dentry, umode_t mode)
3722 {
3723         int error = may_create(&init_user_ns, dir, dentry);
3724         unsigned max_links = dir->i_sb->s_max_links;
3725
3726         if (error)
3727                 return error;
3728
3729         if (!dir->i_op->mkdir)
3730                 return -EPERM;
3731
3732         mode &= (S_IRWXUGO|S_ISVTX);
3733         error = security_inode_mkdir(dir, dentry, mode);
3734         if (error)
3735                 return error;
3736
3737         if (max_links && dir->i_nlink >= max_links)
3738                 return -EMLINK;
3739
3740         error = dir->i_op->mkdir(dir, dentry, mode);
3741         if (!error)
3742                 fsnotify_mkdir(dir, dentry);
3743         return error;
3744 }
3745 EXPORT_SYMBOL(vfs_mkdir);
3746
3747 static long do_mkdirat(int dfd, const char __user *pathname, umode_t mode)
3748 {
3749         struct dentry *dentry;
3750         struct path path;
3751         int error;
3752         unsigned int lookup_flags = LOOKUP_DIRECTORY;
3753
3754 retry:
3755         dentry = user_path_create(dfd, pathname, &path, lookup_flags);
3756         if (IS_ERR(dentry))
3757                 return PTR_ERR(dentry);
3758
3759         if (!IS_POSIXACL(path.dentry->d_inode))
3760                 mode &= ~current_umask();
3761         error = security_path_mkdir(&path, dentry, mode);
3762         if (!error)
3763                 error = vfs_mkdir(path.dentry->d_inode, dentry, mode);
3764         done_path_create(&path, dentry);
3765         if (retry_estale(error, lookup_flags)) {
3766                 lookup_flags |= LOOKUP_REVAL;
3767                 goto retry;
3768         }
3769         return error;
3770 }
3771
3772 SYSCALL_DEFINE3(mkdirat, int, dfd, const char __user *, pathname, umode_t, mode)
3773 {
3774         return do_mkdirat(dfd, pathname, mode);
3775 }
3776
3777 SYSCALL_DEFINE2(mkdir, const char __user *, pathname, umode_t, mode)
3778 {
3779         return do_mkdirat(AT_FDCWD, pathname, mode);
3780 }
3781
3782 int vfs_rmdir(struct inode *dir, struct dentry *dentry)
3783 {
3784         int error = may_delete(&init_user_ns, dir, dentry, 1);
3785
3786         if (error)
3787                 return error;
3788
3789         if (!dir->i_op->rmdir)
3790                 return -EPERM;
3791
3792         dget(dentry);
3793         inode_lock(dentry->d_inode);
3794
3795         error = -EBUSY;
3796         if (is_local_mountpoint(dentry))
3797                 goto out;
3798
3799         error = security_inode_rmdir(dir, dentry);
3800         if (error)
3801                 goto out;
3802
3803         error = dir->i_op->rmdir(dir, dentry);
3804         if (error)
3805                 goto out;
3806
3807         shrink_dcache_parent(dentry);
3808         dentry->d_inode->i_flags |= S_DEAD;
3809         dont_mount(dentry);
3810         detach_mounts(dentry);
3811         fsnotify_rmdir(dir, dentry);
3812
3813 out:
3814         inode_unlock(dentry->d_inode);
3815         dput(dentry);
3816         if (!error)
3817                 d_delete(dentry);
3818         return error;
3819 }
3820 EXPORT_SYMBOL(vfs_rmdir);
3821
3822 long do_rmdir(int dfd, struct filename *name)
3823 {
3824         int error = 0;
3825         struct dentry *dentry;
3826         struct path path;
3827         struct qstr last;
3828         int type;
3829         unsigned int lookup_flags = 0;
3830 retry:
3831         name = filename_parentat(dfd, name, lookup_flags,
3832                                 &path, &last, &type);
3833         if (IS_ERR(name))
3834                 return PTR_ERR(name);
3835
3836         switch (type) {
3837         case LAST_DOTDOT:
3838                 error = -ENOTEMPTY;
3839                 goto exit1;
3840         case LAST_DOT:
3841                 error = -EINVAL;
3842                 goto exit1;
3843         case LAST_ROOT:
3844                 error = -EBUSY;
3845                 goto exit1;
3846         }
3847
3848         error = mnt_want_write(path.mnt);
3849         if (error)
3850                 goto exit1;
3851
3852         inode_lock_nested(path.dentry->d_inode, I_MUTEX_PARENT);
3853         dentry = __lookup_hash(&last, path.dentry, lookup_flags);
3854         error = PTR_ERR(dentry);
3855         if (IS_ERR(dentry))
3856                 goto exit2;
3857         if (!dentry->d_inode) {
3858                 error = -ENOENT;
3859                 goto exit3;
3860         }
3861         error = security_path_rmdir(&path, dentry);
3862         if (error)
3863                 goto exit3;
3864         error = vfs_rmdir(path.dentry->d_inode, dentry);
3865 exit3:
3866         dput(dentry);
3867 exit2:
3868         inode_unlock(path.dentry->d_inode);
3869         mnt_drop_write(path.mnt);
3870 exit1:
3871         path_put(&path);
3872         if (retry_estale(error, lookup_flags)) {
3873                 lookup_flags |= LOOKUP_REVAL;
3874                 goto retry;
3875         }
3876         putname(name);
3877         return error;
3878 }
3879
3880 SYSCALL_DEFINE1(rmdir, const char __user *, pathname)
3881 {
3882         return do_rmdir(AT_FDCWD, getname(pathname));
3883 }
3884
3885 /**
3886  * vfs_unlink - unlink a filesystem object
3887  * @dir:        parent directory
3888  * @dentry:     victim
3889  * @delegated_inode: returns victim inode, if the inode is delegated.
3890  *
3891  * The caller must hold dir->i_mutex.
3892  *
3893  * If vfs_unlink discovers a delegation, it will return -EWOULDBLOCK and
3894  * return a reference to the inode in delegated_inode.  The caller
3895  * should then break the delegation on that inode and retry.  Because
3896  * breaking a delegation may take a long time, the caller should drop
3897  * dir->i_mutex before doing so.
3898  *
3899  * Alternatively, a caller may pass NULL for delegated_inode.  This may
3900  * be appropriate for callers that expect the underlying filesystem not
3901  * to be NFS exported.
3902  */
3903 int vfs_unlink(struct inode *dir, struct dentry *dentry, struct inode **delegated_inode)
3904 {
3905         struct inode *target = dentry->d_inode;
3906         int error = may_delete(&init_user_ns, dir, dentry, 0);
3907
3908         if (error)
3909                 return error;
3910
3911         if (!dir->i_op->unlink)
3912                 return -EPERM;
3913
3914         inode_lock(target);
3915         if (is_local_mountpoint(dentry))
3916                 error = -EBUSY;
3917         else {
3918                 error = security_inode_unlink(dir, dentry);
3919                 if (!error) {
3920                         error = try_break_deleg(target, delegated_inode);
3921                         if (error)
3922                                 goto out;
3923                         error = dir->i_op->unlink(dir, dentry);
3924                         if (!error) {
3925                                 dont_mount(dentry);
3926                                 detach_mounts(dentry);
3927                                 fsnotify_unlink(dir, dentry);
3928                         }
3929                 }
3930         }
3931 out:
3932         inode_unlock(target);
3933
3934         /* We don't d_delete() NFS sillyrenamed files--they still exist. */
3935         if (!error && !(dentry->d_flags & DCACHE_NFSFS_RENAMED)) {
3936                 fsnotify_link_count(target);
3937                 d_delete(dentry);
3938         }
3939
3940         return error;
3941 }
3942 EXPORT_SYMBOL(vfs_unlink);
3943
3944 /*
3945  * Make sure that the actual truncation of the file will occur outside its
3946  * directory's i_mutex.  Truncate can take a long time if there is a lot of
3947  * writeout happening, and we don't want to prevent access to the directory
3948  * while waiting on the I/O.
3949  */
3950 long do_unlinkat(int dfd, struct filename *name)
3951 {
3952         int error;
3953         struct dentry *dentry;
3954         struct path path;
3955         struct qstr last;
3956         int type;
3957         struct inode *inode = NULL;
3958         struct inode *delegated_inode = NULL;
3959         unsigned int lookup_flags = 0;
3960 retry:
3961         name = filename_parentat(dfd, name, lookup_flags, &path, &last, &type);
3962         if (IS_ERR(name))
3963                 return PTR_ERR(name);
3964
3965         error = -EISDIR;
3966         if (type != LAST_NORM)
3967                 goto exit1;
3968
3969         error = mnt_want_write(path.mnt);
3970         if (error)
3971                 goto exit1;
3972 retry_deleg:
3973         inode_lock_nested(path.dentry->d_inode, I_MUTEX_PARENT);
3974         dentry = __lookup_hash(&last, path.dentry, lookup_flags);
3975         error = PTR_ERR(dentry);
3976         if (!IS_ERR(dentry)) {
3977                 /* Why not before? Because we want correct error value */
3978                 if (last.name[last.len])
3979                         goto slashes;
3980                 inode = dentry->d_inode;
3981                 if (d_is_negative(dentry))
3982                         goto slashes;
3983                 ihold(inode);
3984                 error = security_path_unlink(&path, dentry);
3985                 if (error)
3986                         goto exit2;
3987                 error = vfs_unlink(path.dentry->d_inode, dentry, &delegated_inode);
3988 exit2:
3989                 dput(dentry);
3990         }
3991         inode_unlock(path.dentry->d_inode);
3992         if (inode)
3993                 iput(inode);    /* truncate the inode here */
3994         inode = NULL;
3995         if (delegated_inode) {
3996                 error = break_deleg_wait(&delegated_inode);
3997                 if (!error)
3998                         goto retry_deleg;
3999         }
4000         mnt_drop_write(path.mnt);
4001 exit1:
4002         path_put(&path);
4003         if (retry_estale(error, lookup_flags)) {
4004                 lookup_flags |= LOOKUP_REVAL;
4005                 inode = NULL;
4006                 goto retry;
4007         }
4008         putname(name);
4009         return error;
4010
4011 slashes:
4012         if (d_is_negative(dentry))
4013                 error = -ENOENT;
4014         else if (d_is_dir(dentry))
4015                 error = -EISDIR;
4016         else
4017                 error = -ENOTDIR;
4018         goto exit2;
4019 }
4020
4021 SYSCALL_DEFINE3(unlinkat, int, dfd, const char __user *, pathname, int, flag)
4022 {
4023         if ((flag & ~AT_REMOVEDIR) != 0)
4024                 return -EINVAL;
4025
4026         if (flag & AT_REMOVEDIR)
4027                 return do_rmdir(dfd, getname(pathname));
4028         return do_unlinkat(dfd, getname(pathname));
4029 }
4030
4031 SYSCALL_DEFINE1(unlink, const char __user *, pathname)
4032 {
4033         return do_unlinkat(AT_FDCWD, getname(pathname));
4034 }
4035
4036 int vfs_symlink(struct inode *dir, struct dentry *dentry, const char *oldname)
4037 {
4038         int error = may_create(&init_user_ns, dir, dentry);
4039
4040         if (error)
4041                 return error;
4042
4043         if (!dir->i_op->symlink)
4044                 return -EPERM;
4045
4046         error = security_inode_symlink(dir, dentry, oldname);
4047         if (error)
4048                 return error;
4049
4050         error = dir->i_op->symlink(dir, dentry, oldname);
4051         if (!error)
4052                 fsnotify_create(dir, dentry);
4053         return error;
4054 }
4055 EXPORT_SYMBOL(vfs_symlink);
4056
4057 static long do_symlinkat(const char __user *oldname, int newdfd,
4058                   const char __user *newname)
4059 {
4060         int error;
4061         struct filename *from;
4062         struct dentry *dentry;
4063         struct path path;
4064         unsigned int lookup_flags = 0;
4065
4066         from = getname(oldname);
4067         if (IS_ERR(from))
4068                 return PTR_ERR(from);
4069 retry:
4070         dentry = user_path_create(newdfd, newname, &path, lookup_flags);
4071         error = PTR_ERR(dentry);
4072         if (IS_ERR(dentry))
4073                 goto out_putname;
4074
4075         error = security_path_symlink(&path, dentry, from->name);
4076         if (!error)
4077                 error = vfs_symlink(path.dentry->d_inode, dentry, from->name);
4078         done_path_create(&path, dentry);
4079         if (retry_estale(error, lookup_flags)) {
4080                 lookup_flags |= LOOKUP_REVAL;
4081                 goto retry;
4082         }
4083 out_putname:
4084         putname(from);
4085         return error;
4086 }
4087
4088 SYSCALL_DEFINE3(symlinkat, const char __user *, oldname,
4089                 int, newdfd, const char __user *, newname)
4090 {
4091         return do_symlinkat(oldname, newdfd, newname);
4092 }
4093
4094 SYSCALL_DEFINE2(symlink, const char __user *, oldname, const char __user *, newname)
4095 {
4096         return do_symlinkat(oldname, AT_FDCWD, newname);
4097 }
4098
4099 /**
4100  * vfs_link - create a new link
4101  * @old_dentry: object to be linked
4102  * @dir:        new parent
4103  * @new_dentry: where to create the new link
4104  * @delegated_inode: returns inode needing a delegation break
4105  *
4106  * The caller must hold dir->i_mutex
4107  *
4108  * If vfs_link discovers a delegation on the to-be-linked file in need
4109  * of breaking, it will return -EWOULDBLOCK and return a reference to the
4110  * inode in delegated_inode.  The caller should then break the delegation
4111  * and retry.  Because breaking a delegation may take a long time, the
4112  * caller should drop the i_mutex before doing so.
4113  *
4114  * Alternatively, a caller may pass NULL for delegated_inode.  This may
4115  * be appropriate for callers that expect the underlying filesystem not
4116  * to be NFS exported.
4117  */
4118 int vfs_link(struct dentry *old_dentry, struct inode *dir, struct dentry *new_dentry, struct inode **delegated_inode)
4119 {
4120         struct inode *inode = old_dentry->d_inode;
4121         unsigned max_links = dir->i_sb->s_max_links;
4122         int error;
4123
4124         if (!inode)
4125                 return -ENOENT;
4126
4127         error = may_create(&init_user_ns, dir, new_dentry);
4128         if (error)
4129                 return error;
4130
4131         if (dir->i_sb != inode->i_sb)
4132                 return -EXDEV;
4133
4134         /*
4135          * A link to an append-only or immutable file cannot be created.
4136          */
4137         if (IS_APPEND(inode) || IS_IMMUTABLE(inode))
4138                 return -EPERM;
4139         /*
4140          * Updating the link count will likely cause i_uid and i_gid to
4141          * be writen back improperly if their true value is unknown to
4142          * the vfs.
4143          */
4144         if (HAS_UNMAPPED_ID(&init_user_ns, inode))
4145                 return -EPERM;
4146         if (!dir->i_op->link)
4147                 return -EPERM;
4148         if (S_ISDIR(inode->i_mode))
4149                 return -EPERM;
4150
4151         error = security_inode_link(old_dentry, dir, new_dentry);
4152         if (error)
4153                 return error;
4154
4155         inode_lock(inode);
4156         /* Make sure we don't allow creating hardlink to an unlinked file */
4157         if (inode->i_nlink == 0 && !(inode->i_state & I_LINKABLE))
4158                 error =  -ENOENT;
4159         else if (max_links && inode->i_nlink >= max_links)
4160                 error = -EMLINK;
4161         else {
4162                 error = try_break_deleg(inode, delegated_inode);
4163                 if (!error)
4164                         error = dir->i_op->link(old_dentry, dir, new_dentry);
4165         }
4166
4167         if (!error && (inode->i_state & I_LINKABLE)) {
4168                 spin_lock(&inode->i_lock);
4169                 inode->i_state &= ~I_LINKABLE;
4170                 spin_unlock(&inode->i_lock);
4171         }
4172         inode_unlock(inode);
4173         if (!error)
4174                 fsnotify_link(dir, inode, new_dentry);
4175         return error;
4176 }
4177 EXPORT_SYMBOL(vfs_link);
4178
4179 /*
4180  * Hardlinks are often used in delicate situations.  We avoid
4181  * security-related surprises by not following symlinks on the
4182  * newname.  --KAB
4183  *
4184  * We don't follow them on the oldname either to be compatible
4185  * with linux 2.0, and to avoid hard-linking to directories
4186  * and other special files.  --ADM
4187  */
4188 static int do_linkat(int olddfd, const char __user *oldname, int newdfd,
4189               const char __user *newname, int flags)
4190 {
4191         struct dentry *new_dentry;
4192         struct path old_path, new_path;
4193         struct inode *delegated_inode = NULL;
4194         int how = 0;
4195         int error;
4196
4197         if ((flags & ~(AT_SYMLINK_FOLLOW | AT_EMPTY_PATH)) != 0)
4198                 return -EINVAL;
4199         /*
4200          * To use null names we require CAP_DAC_READ_SEARCH
4201          * This ensures that not everyone will be able to create
4202          * handlink using the passed filedescriptor.
4203          */
4204         if (flags & AT_EMPTY_PATH) {
4205                 if (!capable(CAP_DAC_READ_SEARCH))
4206                         return -ENOENT;
4207                 how = LOOKUP_EMPTY;
4208         }
4209
4210         if (flags & AT_SYMLINK_FOLLOW)
4211                 how |= LOOKUP_FOLLOW;
4212 retry:
4213         error = user_path_at(olddfd, oldname, how, &old_path);
4214         if (error)
4215                 return error;
4216
4217         new_dentry = user_path_create(newdfd, newname, &new_path,
4218                                         (how & LOOKUP_REVAL));
4219         error = PTR_ERR(new_dentry);
4220         if (IS_ERR(new_dentry))
4221                 goto out;
4222
4223         error = -EXDEV;
4224         if (old_path.mnt != new_path.mnt)
4225                 goto out_dput;
4226         error = may_linkat(&init_user_ns, &old_path);
4227         if (unlikely(error))
4228                 goto out_dput;
4229         error = security_path_link(old_path.dentry, &new_path, new_dentry);
4230         if (error)
4231                 goto out_dput;
4232         error = vfs_link(old_path.dentry, new_path.dentry->d_inode, new_dentry, &delegated_inode);
4233 out_dput:
4234         done_path_create(&new_path, new_dentry);
4235         if (delegated_inode) {
4236                 error = break_deleg_wait(&delegated_inode);
4237                 if (!error) {
4238                         path_put(&old_path);
4239                         goto retry;
4240                 }
4241         }
4242         if (retry_estale(error, how)) {
4243                 path_put(&old_path);
4244                 how |= LOOKUP_REVAL;
4245                 goto retry;
4246         }
4247 out:
4248         path_put(&old_path);
4249
4250         return error;
4251 }
4252
4253 SYSCALL_DEFINE5(linkat, int, olddfd, const char __user *, oldname,
4254                 int, newdfd, const char __user *, newname, int, flags)
4255 {
4256         return do_linkat(olddfd, oldname, newdfd, newname, flags);
4257 }
4258
4259 SYSCALL_DEFINE2(link, const char __user *, oldname, const char __user *, newname)
4260 {
4261         return do_linkat(AT_FDCWD, oldname, AT_FDCWD, newname, 0);
4262 }
4263
4264 /**
4265  * vfs_rename - rename a filesystem object
4266  * @old_dir:    parent of source
4267  * @old_dentry: source
4268  * @new_dir:    parent of destination
4269  * @new_dentry: destination
4270  * @delegated_inode: returns an inode needing a delegation break
4271  * @flags:      rename flags
4272  *
4273  * The caller must hold multiple mutexes--see lock_rename()).
4274  *
4275  * If vfs_rename discovers a delegation in need of breaking at either
4276  * the source or destination, it will return -EWOULDBLOCK and return a
4277  * reference to the inode in delegated_inode.  The caller should then
4278  * break the delegation and retry.  Because breaking a delegation may
4279  * take a long time, the caller should drop all locks before doing
4280  * so.
4281  *
4282  * Alternatively, a caller may pass NULL for delegated_inode.  This may
4283  * be appropriate for callers that expect the underlying filesystem not
4284  * to be NFS exported.
4285  *
4286  * The worst of all namespace operations - renaming directory. "Perverted"
4287  * doesn't even start to describe it. Somebody in UCB had a heck of a trip...
4288  * Problems:
4289  *
4290  *      a) we can get into loop creation.
4291  *      b) race potential - two innocent renames can create a loop together.
4292  *         That's where 4.4 screws up. Current fix: serialization on
4293  *         sb->s_vfs_rename_mutex. We might be more accurate, but that's another
4294  *         story.
4295  *      c) we have to lock _four_ objects - parents and victim (if it exists),
4296  *         and source (if it is not a directory).
4297  *         And that - after we got ->i_mutex on parents (until then we don't know
4298  *         whether the target exists).  Solution: try to be smart with locking
4299  *         order for inodes.  We rely on the fact that tree topology may change
4300  *         only under ->s_vfs_rename_mutex _and_ that parent of the object we
4301  *         move will be locked.  Thus we can rank directories by the tree
4302  *         (ancestors first) and rank all non-directories after them.
4303  *         That works since everybody except rename does "lock parent, lookup,
4304  *         lock child" and rename is under ->s_vfs_rename_mutex.
4305  *         HOWEVER, it relies on the assumption that any object with ->lookup()
4306  *         has no more than 1 dentry.  If "hybrid" objects will ever appear,
4307  *         we'd better make sure that there's no link(2) for them.
4308  *      d) conversion from fhandle to dentry may come in the wrong moment - when
4309  *         we are removing the target. Solution: we will have to grab ->i_mutex
4310  *         in the fhandle_to_dentry code. [FIXME - current nfsfh.c relies on
4311  *         ->i_mutex on parents, which works but leads to some truly excessive
4312  *         locking].
4313  */
4314 int vfs_rename(struct renamedata *rd)
4315 {
4316         int error;
4317         struct user_namespace *mnt_userns = &init_user_ns;
4318         struct inode *old_dir = rd->old_dir, *new_dir = rd->new_dir;
4319         struct dentry *old_dentry = rd->old_dentry;
4320         struct dentry *new_dentry = rd->new_dentry;
4321         struct inode **delegated_inode = rd->delegated_inode;
4322         unsigned int flags = rd->flags;
4323         bool is_dir = d_is_dir(old_dentry);
4324         struct inode *source = old_dentry->d_inode;
4325         struct inode *target = new_dentry->d_inode;
4326         bool new_is_dir = false;
4327         unsigned max_links = new_dir->i_sb->s_max_links;
4328         struct name_snapshot old_name;
4329
4330         if (source == target)
4331                 return 0;
4332
4333         error = may_delete(mnt_userns, old_dir, old_dentry, is_dir);
4334         if (error)
4335                 return error;
4336
4337         if (!target) {
4338                 error = may_create(mnt_userns, new_dir, new_dentry);
4339         } else {
4340                 new_is_dir = d_is_dir(new_dentry);
4341
4342                 if (!(flags & RENAME_EXCHANGE))
4343                         error = may_delete(mnt_userns, new_dir, new_dentry, is_dir);
4344                 else
4345                         error = may_delete(mnt_userns, new_dir, new_dentry, new_is_dir);
4346         }
4347         if (error)
4348                 return error;
4349
4350         if (!old_dir->i_op->rename)
4351                 return -EPERM;
4352
4353         /*
4354          * If we are going to change the parent - check write permissions,
4355          * we'll need to flip '..'.
4356          */
4357         if (new_dir != old_dir) {
4358                 if (is_dir) {
4359                         error = inode_permission(&init_user_ns, source,
4360                                                  MAY_WRITE);
4361                         if (error)
4362                                 return error;
4363                 }
4364                 if ((flags & RENAME_EXCHANGE) && new_is_dir) {
4365                         error = inode_permission(&init_user_ns, target,
4366                                                  MAY_WRITE);
4367                         if (error)
4368                                 return error;
4369                 }
4370         }
4371
4372         error = security_inode_rename(old_dir, old_dentry, new_dir, new_dentry,
4373                                       flags);
4374         if (error)
4375                 return error;
4376
4377         take_dentry_name_snapshot(&old_name, old_dentry);
4378         dget(new_dentry);
4379         if (!is_dir || (flags & RENAME_EXCHANGE))
4380                 lock_two_nondirectories(source, target);
4381         else if (target)
4382                 inode_lock(target);
4383
4384         error = -EBUSY;
4385         if (is_local_mountpoint(old_dentry) || is_local_mountpoint(new_dentry))
4386                 goto out;
4387
4388         if (max_links && new_dir != old_dir) {
4389                 error = -EMLINK;
4390                 if (is_dir && !new_is_dir && new_dir->i_nlink >= max_links)
4391                         goto out;
4392                 if ((flags & RENAME_EXCHANGE) && !is_dir && new_is_dir &&
4393                     old_dir->i_nlink >= max_links)
4394                         goto out;
4395         }
4396         if (!is_dir) {
4397                 error = try_break_deleg(source, delegated_inode);
4398                 if (error)
4399                         goto out;
4400         }
4401         if (target && !new_is_dir) {
4402                 error = try_break_deleg(target, delegated_inode);
4403                 if (error)
4404                         goto out;
4405         }
4406         error = old_dir->i_op->rename(old_dir, old_dentry,
4407                                        new_dir, new_dentry, flags);
4408         if (error)
4409                 goto out;
4410
4411         if (!(flags & RENAME_EXCHANGE) && target) {
4412                 if (is_dir) {
4413                         shrink_dcache_parent(new_dentry);
4414                         target->i_flags |= S_DEAD;
4415                 }
4416                 dont_mount(new_dentry);
4417                 detach_mounts(new_dentry);
4418         }
4419         if (!(old_dir->i_sb->s_type->fs_flags & FS_RENAME_DOES_D_MOVE)) {
4420                 if (!(flags & RENAME_EXCHANGE))
4421                         d_move(old_dentry, new_dentry);
4422                 else
4423                         d_exchange(old_dentry, new_dentry);
4424         }
4425 out:
4426         if (!is_dir || (flags & RENAME_EXCHANGE))
4427                 unlock_two_nondirectories(source, target);
4428         else if (target)
4429                 inode_unlock(target);
4430         dput(new_dentry);
4431         if (!error) {
4432                 fsnotify_move(old_dir, new_dir, &old_name.name, is_dir,
4433                               !(flags & RENAME_EXCHANGE) ? target : NULL, old_dentry);
4434                 if (flags & RENAME_EXCHANGE) {
4435                         fsnotify_move(new_dir, old_dir, &old_dentry->d_name,
4436                                       new_is_dir, NULL, new_dentry);
4437                 }
4438         }
4439         release_dentry_name_snapshot(&old_name);
4440
4441         return error;
4442 }
4443 EXPORT_SYMBOL(vfs_rename);
4444
4445 int do_renameat2(int olddfd, struct filename *from, int newdfd,
4446                  struct filename *to, unsigned int flags)
4447 {
4448         struct renamedata rd;
4449         struct dentry *old_dentry, *new_dentry;
4450         struct dentry *trap;
4451         struct path old_path, new_path;
4452         struct qstr old_last, new_last;
4453         int old_type, new_type;
4454         struct inode *delegated_inode = NULL;
4455         unsigned int lookup_flags = 0, target_flags = LOOKUP_RENAME_TARGET;
4456         bool should_retry = false;
4457         int error = -EINVAL;
4458
4459         if (flags & ~(RENAME_NOREPLACE | RENAME_EXCHANGE | RENAME_WHITEOUT))
4460                 goto put_both;
4461
4462         if ((flags & (RENAME_NOREPLACE | RENAME_WHITEOUT)) &&
4463             (flags & RENAME_EXCHANGE))
4464                 goto put_both;
4465
4466         if (flags & RENAME_EXCHANGE)
4467                 target_flags = 0;
4468
4469 retry:
4470         from = filename_parentat(olddfd, from, lookup_flags, &old_path,
4471                                         &old_last, &old_type);
4472         if (IS_ERR(from)) {
4473                 error = PTR_ERR(from);
4474                 goto put_new;
4475         }
4476
4477         to = filename_parentat(newdfd, to, lookup_flags, &new_path, &new_last,
4478                                 &new_type);
4479         if (IS_ERR(to)) {
4480                 error = PTR_ERR(to);
4481                 goto exit1;
4482         }
4483
4484         error = -EXDEV;
4485         if (old_path.mnt != new_path.mnt)
4486                 goto exit2;
4487
4488         error = -EBUSY;
4489         if (old_type != LAST_NORM)
4490                 goto exit2;
4491
4492         if (flags & RENAME_NOREPLACE)
4493                 error = -EEXIST;
4494         if (new_type != LAST_NORM)
4495                 goto exit2;
4496
4497         error = mnt_want_write(old_path.mnt);
4498         if (error)
4499                 goto exit2;
4500
4501 retry_deleg:
4502         trap = lock_rename(new_path.dentry, old_path.dentry);
4503
4504         old_dentry = __lookup_hash(&old_last, old_path.dentry, lookup_flags);
4505         error = PTR_ERR(old_dentry);
4506         if (IS_ERR(old_dentry))
4507                 goto exit3;
4508         /* source must exist */
4509         error = -ENOENT;
4510         if (d_is_negative(old_dentry))
4511                 goto exit4;
4512         new_dentry = __lookup_hash(&new_last, new_path.dentry, lookup_flags | target_flags);
4513         error = PTR_ERR(new_dentry);
4514         if (IS_ERR(new_dentry))
4515                 goto exit4;
4516         error = -EEXIST;
4517         if ((flags & RENAME_NOREPLACE) && d_is_positive(new_dentry))
4518                 goto exit5;
4519         if (flags & RENAME_EXCHANGE) {
4520                 error = -ENOENT;
4521                 if (d_is_negative(new_dentry))
4522                         goto exit5;
4523
4524                 if (!d_is_dir(new_dentry)) {
4525                         error = -ENOTDIR;
4526                         if (new_last.name[new_last.len])
4527                                 goto exit5;
4528                 }
4529         }
4530         /* unless the source is a directory trailing slashes give -ENOTDIR */
4531         if (!d_is_dir(old_dentry)) {
4532                 error = -ENOTDIR;
4533                 if (old_last.name[old_last.len])
4534                         goto exit5;
4535                 if (!(flags & RENAME_EXCHANGE) && new_last.name[new_last.len])
4536                         goto exit5;
4537         }
4538         /* source should not be ancestor of target */
4539         error = -EINVAL;
4540         if (old_dentry == trap)
4541                 goto exit5;
4542         /* target should not be an ancestor of source */
4543         if (!(flags & RENAME_EXCHANGE))
4544                 error = -ENOTEMPTY;
4545         if (new_dentry == trap)
4546                 goto exit5;
4547
4548         error = security_path_rename(&old_path, old_dentry,
4549                                      &new_path, new_dentry, flags);
4550         if (error)
4551                 goto exit5;
4552
4553         rd.old_dir         = old_path.dentry->d_inode;
4554         rd.old_dentry      = old_dentry;
4555         rd.new_dir         = new_path.dentry->d_inode;
4556         rd.new_dentry      = new_dentry;
4557         rd.delegated_inode = &delegated_inode;
4558         rd.flags           = flags;
4559         error = vfs_rename(&rd);
4560 exit5:
4561         dput(new_dentry);
4562 exit4:
4563         dput(old_dentry);
4564 exit3:
4565         unlock_rename(new_path.dentry, old_path.dentry);
4566         if (delegated_inode) {
4567                 error = break_deleg_wait(&delegated_inode);
4568                 if (!error)
4569                         goto retry_deleg;
4570         }
4571         mnt_drop_write(old_path.mnt);
4572 exit2:
4573         if (retry_estale(error, lookup_flags))
4574                 should_retry = true;
4575         path_put(&new_path);
4576 exit1:
4577         path_put(&old_path);
4578         if (should_retry) {
4579                 should_retry = false;
4580                 lookup_flags |= LOOKUP_REVAL;
4581                 goto retry;
4582         }
4583 put_both:
4584         if (!IS_ERR(from))
4585                 putname(from);
4586 put_new:
4587         if (!IS_ERR(to))
4588                 putname(to);
4589         return error;
4590 }
4591
4592 SYSCALL_DEFINE5(renameat2, int, olddfd, const char __user *, oldname,
4593                 int, newdfd, const char __user *, newname, unsigned int, flags)
4594 {
4595         return do_renameat2(olddfd, getname(oldname), newdfd, getname(newname),
4596                                 flags);
4597 }
4598
4599 SYSCALL_DEFINE4(renameat, int, olddfd, const char __user *, oldname,
4600                 int, newdfd, const char __user *, newname)
4601 {
4602         return do_renameat2(olddfd, getname(oldname), newdfd, getname(newname),
4603                                 0);
4604 }
4605
4606 SYSCALL_DEFINE2(rename, const char __user *, oldname, const char __user *, newname)
4607 {
4608         return do_renameat2(AT_FDCWD, getname(oldname), AT_FDCWD,
4609                                 getname(newname), 0);
4610 }
4611
4612 int readlink_copy(char __user *buffer, int buflen, const char *link)
4613 {
4614         int len = PTR_ERR(link);
4615         if (IS_ERR(link))
4616                 goto out;
4617
4618         len = strlen(link);
4619         if (len > (unsigned) buflen)
4620                 len = buflen;
4621         if (copy_to_user(buffer, link, len))
4622                 len = -EFAULT;
4623 out:
4624         return len;
4625 }
4626
4627 /**
4628  * vfs_readlink - copy symlink body into userspace buffer
4629  * @dentry: dentry on which to get symbolic link
4630  * @buffer: user memory pointer
4631  * @buflen: size of buffer
4632  *
4633  * Does not touch atime.  That's up to the caller if necessary
4634  *
4635  * Does not call security hook.
4636  */
4637 int vfs_readlink(struct dentry *dentry, char __user *buffer, int buflen)
4638 {
4639         struct inode *inode = d_inode(dentry);
4640         DEFINE_DELAYED_CALL(done);
4641         const char *link;
4642         int res;
4643
4644         if (unlikely(!(inode->i_opflags & IOP_DEFAULT_READLINK))) {
4645                 if (unlikely(inode->i_op->readlink))
4646                         return inode->i_op->readlink(dentry, buffer, buflen);
4647
4648                 if (!d_is_symlink(dentry))
4649                         return -EINVAL;
4650
4651                 spin_lock(&inode->i_lock);
4652                 inode->i_opflags |= IOP_DEFAULT_READLINK;
4653                 spin_unlock(&inode->i_lock);
4654         }
4655
4656         link = READ_ONCE(inode->i_link);
4657         if (!link) {
4658                 link = inode->i_op->get_link(dentry, inode, &done);
4659                 if (IS_ERR(link))
4660                         return PTR_ERR(link);
4661         }
4662         res = readlink_copy(buffer, buflen, link);
4663         do_delayed_call(&done);
4664         return res;
4665 }
4666 EXPORT_SYMBOL(vfs_readlink);
4667
4668 /**
4669  * vfs_get_link - get symlink body
4670  * @dentry: dentry on which to get symbolic link
4671  * @done: caller needs to free returned data with this
4672  *
4673  * Calls security hook and i_op->get_link() on the supplied inode.
4674  *
4675  * It does not touch atime.  That's up to the caller if necessary.
4676  *
4677  * Does not work on "special" symlinks like /proc/$$/fd/N
4678  */
4679 const char *vfs_get_link(struct dentry *dentry, struct delayed_call *done)
4680 {
4681         const char *res = ERR_PTR(-EINVAL);
4682         struct inode *inode = d_inode(dentry);
4683
4684         if (d_is_symlink(dentry)) {
4685                 res = ERR_PTR(security_inode_readlink(dentry));
4686                 if (!res)
4687                         res = inode->i_op->get_link(dentry, inode, done);
4688         }
4689         return res;
4690 }
4691 EXPORT_SYMBOL(vfs_get_link);
4692
4693 /* get the link contents into pagecache */
4694 const char *page_get_link(struct dentry *dentry, struct inode *inode,
4695                           struct delayed_call *callback)
4696 {
4697         char *kaddr;
4698         struct page *page;
4699         struct address_space *mapping = inode->i_mapping;
4700
4701         if (!dentry) {
4702                 page = find_get_page(mapping, 0);
4703                 if (!page)
4704                         return ERR_PTR(-ECHILD);
4705                 if (!PageUptodate(page)) {
4706                         put_page(page);
4707                         return ERR_PTR(-ECHILD);
4708                 }
4709         } else {
4710                 page = read_mapping_page(mapping, 0, NULL);
4711                 if (IS_ERR(page))
4712                         return (char*)page;
4713         }
4714         set_delayed_call(callback, page_put_link, page);
4715         BUG_ON(mapping_gfp_mask(mapping) & __GFP_HIGHMEM);
4716         kaddr = page_address(page);
4717         nd_terminate_link(kaddr, inode->i_size, PAGE_SIZE - 1);
4718         return kaddr;
4719 }
4720
4721 EXPORT_SYMBOL(page_get_link);
4722
4723 void page_put_link(void *arg)
4724 {
4725         put_page(arg);
4726 }
4727 EXPORT_SYMBOL(page_put_link);
4728
4729 int page_readlink(struct dentry *dentry, char __user *buffer, int buflen)
4730 {
4731         DEFINE_DELAYED_CALL(done);
4732         int res = readlink_copy(buffer, buflen,
4733                                 page_get_link(dentry, d_inode(dentry),
4734                                               &done));
4735         do_delayed_call(&done);
4736         return res;
4737 }
4738 EXPORT_SYMBOL(page_readlink);
4739
4740 /*
4741  * The nofs argument instructs pagecache_write_begin to pass AOP_FLAG_NOFS
4742  */
4743 int __page_symlink(struct inode *inode, const char *symname, int len, int nofs)
4744 {
4745         struct address_space *mapping = inode->i_mapping;
4746         struct page *page;
4747         void *fsdata;
4748         int err;
4749         unsigned int flags = 0;
4750         if (nofs)
4751                 flags |= AOP_FLAG_NOFS;
4752
4753 retry:
4754         err = pagecache_write_begin(NULL, mapping, 0, len-1,
4755                                 flags, &page, &fsdata);
4756         if (err)
4757                 goto fail;
4758
4759         memcpy(page_address(page), symname, len-1);
4760
4761         err = pagecache_write_end(NULL, mapping, 0, len-1, len-1,
4762                                                         page, fsdata);
4763         if (err < 0)
4764                 goto fail;
4765         if (err < len-1)
4766                 goto retry;
4767
4768         mark_inode_dirty(inode);
4769         return 0;
4770 fail:
4771         return err;
4772 }
4773 EXPORT_SYMBOL(__page_symlink);
4774
4775 int page_symlink(struct inode *inode, const char *symname, int len)
4776 {
4777         return __page_symlink(inode, symname, len,
4778                         !mapping_gfp_constraint(inode->i_mapping, __GFP_FS));
4779 }
4780 EXPORT_SYMBOL(page_symlink);
4781
4782 const struct inode_operations page_symlink_inode_operations = {
4783         .get_link       = page_get_link,
4784 };
4785 EXPORT_SYMBOL(page_symlink_inode_operations);