kill LOOKUP_NO_EVAL, don't bother including namei.h from audit.h
[linux-block.git] / include / linux / namei.h
CommitLineData
b2441318 1/* SPDX-License-Identifier: GPL-2.0 */
1da177e4
LT
2#ifndef _LINUX_NAMEI_H
3#define _LINUX_NAMEI_H
4
b853a161 5#include <linux/kernel.h>
c5e725f3 6#include <linux/path.h>
b853a161
AV
7#include <linux/fcntl.h>
8#include <linux/errno.h>
1da177e4 9
737bebd1 10enum { MAX_NESTED_LINKS = 8 };
1da177e4 11
894bc8c4
AV
12#define MAXSYMLINKS 40
13
1da177e4
LT
14/*
15 * Type of the last component on LOOKUP_PARENT
16 */
17enum {LAST_NORM, LAST_ROOT, LAST_DOT, LAST_DOTDOT, LAST_BIND};
18
19/*
20 * The bitmask for a lookup event:
21 * - follow links at the end
22 * - require a directory
23 * - ending slashes ok even for nonexistent files
47a0dfaa 24 * - internal "there are more path components" flag
1da177e4 25 * - dentry cache is untrusted; force a real lookup
6f45b656 26 * - suppress terminal automount
57d46577 27 * - skip revalidation
1da177e4 28 */
31e6b01f
NP
29#define LOOKUP_FOLLOW 0x0001
30#define LOOKUP_DIRECTORY 0x0002
d94c177b 31#define LOOKUP_AUTOMOUNT 0x0004
31e6b01f
NP
32
33#define LOOKUP_PARENT 0x0010
34#define LOOKUP_REVAL 0x0020
35#define LOOKUP_RCU 0x0040
949a852e 36#define LOOKUP_NO_REVAL 0x0080
b6c8069d 37
1da177e4
LT
38/*
39 * Intent data
40 */
3516586a
AV
41#define LOOKUP_OPEN 0x0100
42#define LOOKUP_CREATE 0x0200
43#define LOOKUP_EXCL 0x0400
4e9ed2f8 44#define LOOKUP_RENAME_TARGET 0x0800
1da177e4 45
16c2cd71 46#define LOOKUP_JUMPED 0x1000
5b6ca027 47#define LOOKUP_ROOT 0x2000
f52e0c11 48#define LOOKUP_EMPTY 0x4000
4f757f3c 49#define LOOKUP_DOWN 0x8000
16c2cd71 50
eedf265a
EB
51extern int path_pts(struct path *path);
52
1fa1e7f6 53extern int user_path_at_empty(int, const char __user *, unsigned, struct path *, int *empty);
2d8f3038 54
b853a161
AV
55static inline int user_path_at(int dfd, const char __user *name, unsigned flags,
56 struct path *path)
57{
58 return user_path_at_empty(dfd, name, flags, path, NULL);
59}
60
61static inline int user_path(const char __user *name, struct path *path)
62{
63 return user_path_at_empty(AT_FDCWD, name, LOOKUP_FOLLOW, path, NULL);
64}
65
66static inline int user_lpath(const char __user *name, struct path *path)
67{
68 return user_path_at_empty(AT_FDCWD, name, 0, path, NULL);
69}
70
71static inline int user_path_dir(const char __user *name, struct path *path)
72{
73 return user_path_at_empty(AT_FDCWD, name,
74 LOOKUP_FOLLOW | LOOKUP_DIRECTORY, path, NULL);
75}
2d8f3038 76
d1811465
AV
77extern int kern_path(const char *, unsigned, struct path *);
78
1ac12b4b
JL
79extern struct dentry *kern_path_create(int, const char *, struct path *, unsigned int);
80extern struct dentry *user_path_create(int, const char __user *, struct path *, unsigned int);
921a1650 81extern void done_path_create(struct path *, struct dentry *);
79714f72 82extern struct dentry *kern_path_locked(const char *, struct path *);
2d864651 83extern int kern_path_mountpoint(int, const char *, struct path *, unsigned int);
1da177e4 84
0da0b7fd 85extern struct dentry *try_lookup_one_len(const char *, struct dentry *, int);
eead1911 86extern struct dentry *lookup_one_len(const char *, struct dentry *, int);
bbddca8e 87extern struct dentry *lookup_one_len_unlocked(const char *, struct dentry *, int);
1da177e4 88
cc53ce53 89extern int follow_down_one(struct path *);
7cc90cc3 90extern int follow_down(struct path *);
bab77ebf 91extern int follow_up(struct path *);
1da177e4
LT
92
93extern struct dentry *lock_rename(struct dentry *, struct dentry *);
94extern void unlock_rename(struct dentry *, struct dentry *);
95
6e77137b 96extern void nd_jump_link(struct path *path);
1da177e4 97
03514685
DG
98static inline void nd_terminate_link(void *name, size_t len, size_t maxlen)
99{
100 ((char *) name)[min(len, maxlen)] = '\0';
101}
102
b9d6ba94
JL
103/**
104 * retry_estale - determine whether the caller should retry an operation
105 * @error: the error that would currently be returned
106 * @flags: flags being used for next lookup attempt
107 *
108 * Check to see if the error code was -ESTALE, and then determine whether
109 * to retry the call based on whether "flags" already has LOOKUP_REVAL set.
110 *
111 * Returns true if the caller should try the operation again.
112 */
113static inline bool
114retry_estale(const long error, const unsigned int flags)
115{
116 return error == -ESTALE && !(flags & LOOKUP_REVAL);
117}
118
1da177e4 119#endif /* _LINUX_NAMEI_H */