namei.h 2.92 KB
Newer Older
Linus Torvalds's avatar
Linus Torvalds committed
1
2
3
#ifndef _LINUX_NAMEI_H
#define _LINUX_NAMEI_H

Alexey Dobriyan's avatar
Alexey Dobriyan committed
4
#include <linux/dcache.h>
Stephen Warren's avatar
Stephen Warren committed
5
#include <linux/errno.h>
Linus Torvalds's avatar
Linus Torvalds committed
6
#include <linux/linkage.h>
7
#include <linux/path.h>
Linus Torvalds's avatar
Linus Torvalds committed
8
9
10

struct vfsmount;

Al Viro's avatar
Al Viro committed
11
enum { MAX_NESTED_LINKS = 8 };
Linus Torvalds's avatar
Linus Torvalds committed
12

13
14
#define MAXSYMLINKS 40

Linus Torvalds's avatar
Linus Torvalds committed
15
16
17
18
19
20
21
22
23
24
/*
 * Type of the last component on LOOKUP_PARENT
 */
enum {LAST_NORM, LAST_ROOT, LAST_DOT, LAST_DOTDOT, LAST_BIND};

/*
 * The bitmask for a lookup event:
 *  - follow links at the end
 *  - require a directory
 *  - ending slashes ok even for nonexistent files
25
 *  - internal "there are more path components" flag
Linus Torvalds's avatar
Linus Torvalds committed
26
 *  - dentry cache is untrusted; force a real lookup
27
 *  - suppress terminal automount
Linus Torvalds's avatar
Linus Torvalds committed
28
 */
Nick Piggin's avatar
Nick Piggin committed
29
30
#define LOOKUP_FOLLOW		0x0001
#define LOOKUP_DIRECTORY	0x0002
31
#define LOOKUP_AUTOMOUNT	0x0004
Nick Piggin's avatar
Nick Piggin committed
32
33
34
35

#define LOOKUP_PARENT		0x0010
#define LOOKUP_REVAL		0x0020
#define LOOKUP_RCU		0x0040
36

Linus Torvalds's avatar
Linus Torvalds committed
37
38
39
/*
 * Intent data
 */
40
41
42
#define LOOKUP_OPEN		0x0100
#define LOOKUP_CREATE		0x0200
#define LOOKUP_EXCL		0x0400
43
#define LOOKUP_RENAME_TARGET	0x0800
Linus Torvalds's avatar
Linus Torvalds committed
44

Al Viro's avatar
Al Viro committed
45
#define LOOKUP_JUMPED		0x1000
46
#define LOOKUP_ROOT		0x2000
Al Viro's avatar
Al Viro committed
47
#define LOOKUP_EMPTY		0x4000
Al Viro's avatar
Al Viro committed
48

49
extern int user_path_at(int, const char __user *, unsigned, struct path *);
50
extern int user_path_at_empty(int, const char __user *, unsigned, struct path *, int *empty);
51
52
53
54
55
56

#define user_path(name, path) user_path_at(AT_FDCWD, name, LOOKUP_FOLLOW, path)
#define user_lpath(name, path) user_path_at(AT_FDCWD, name, 0, path)
#define user_path_dir(name, path) \
	user_path_at(AT_FDCWD, name, LOOKUP_FOLLOW | LOOKUP_DIRECTORY, path)

Al Viro's avatar
Al Viro committed
57
58
extern int kern_path(const char *, unsigned, struct path *);

59
60
extern struct dentry *kern_path_create(int, const char *, struct path *, unsigned int);
extern struct dentry *user_path_create(int, const char __user *, struct path *, unsigned int);
Al Viro's avatar
Al Viro committed
61
extern void done_path_create(struct path *, struct dentry *);
Al Viro's avatar
Al Viro committed
62
extern struct dentry *kern_path_locked(const char *, struct path *);
Al Viro's avatar
Al Viro committed
63
extern int kern_path_mountpoint(int, const char *, struct path *, unsigned int);
Linus Torvalds's avatar
Linus Torvalds committed
64

65
extern struct dentry *lookup_one_len(const char *, struct dentry *, int);
Linus Torvalds's avatar
Linus Torvalds committed
66

67
extern int follow_down_one(struct path *);
68
extern int follow_down(struct path *);
Al Viro's avatar
Al Viro committed
69
extern int follow_up(struct path *);
Linus Torvalds's avatar
Linus Torvalds committed
70
71
72
73

extern struct dentry *lock_rename(struct dentry *, struct dentry *);
extern void unlock_rename(struct dentry *, struct dentry *);

74
extern void nd_jump_link(struct path *path);
Linus Torvalds's avatar
Linus Torvalds committed
75

76
77
78
79
80
static inline void nd_terminate_link(void *name, size_t len, size_t maxlen)
{
	((char *) name)[min(len, maxlen)] = '\0';
}

81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
/**
 * retry_estale - determine whether the caller should retry an operation
 * @error: the error that would currently be returned
 * @flags: flags being used for next lookup attempt
 *
 * Check to see if the error code was -ESTALE, and then determine whether
 * to retry the call based on whether "flags" already has LOOKUP_REVAL set.
 *
 * Returns true if the caller should try the operation again.
 */
static inline bool
retry_estale(const long error, const unsigned int flags)
{
	return error == -ESTALE && !(flags & LOOKUP_REVAL);
}

Linus Torvalds's avatar
Linus Torvalds committed
97
#endif /* _LINUX_NAMEI_H */