autofs_i.h 7.71 KB
Newer Older
Linus Torvalds's avatar
Linus Torvalds committed
1
2
3
4
5
/* -*- c -*- ------------------------------------------------------------- *
 *   
 * linux/fs/autofs/autofs_i.h
 *
 *   Copyright 1997-1998 Transmeta Corporation - All Rights Reserved
6
 *   Copyright 2005-2006 Ian Kent <raven@themaw.net>
Linus Torvalds's avatar
Linus Torvalds committed
7
8
9
10
11
12
13
14
15
16
 *
 * This file is part of the Linux kernel and is made available under
 * the terms of the GNU General Public License, version 2, or at your
 * option, any later version, incorporated herein by reference.
 *
 * ----------------------------------------------------------------------- */

/* Internal header file for autofs */

#include <linux/auto_fs4.h>
17
#include <linux/auto_dev-ioctl.h>
18
#include <linux/mutex.h>
Linus Torvalds's avatar
Linus Torvalds committed
19
20
21
22
23
24
#include <linux/list.h>

/* This is the range of ioctl() numbers we claim as ours */
#define AUTOFS_IOC_FIRST     AUTOFS_IOC_READY
#define AUTOFS_IOC_COUNT     32

25
26
27
#define AUTOFS_DEV_IOCTL_IOC_FIRST	(AUTOFS_DEV_IOCTL_VERSION)
#define AUTOFS_DEV_IOCTL_IOC_COUNT	(AUTOFS_IOC_COUNT - 11)

Linus Torvalds's avatar
Linus Torvalds committed
28
29
30
31
32
33
34
35
36
37
38
39
40
41
#include <linux/kernel.h>
#include <linux/slab.h>
#include <linux/time.h>
#include <linux/string.h>
#include <linux/wait.h>
#include <linux/sched.h>
#include <linux/mount.h>
#include <linux/namei.h>
#include <asm/current.h>
#include <asm/uaccess.h>

/* #define DEBUG */

#ifdef DEBUG
42
43
44
45
46
#define DPRINTK(fmt, args...)				\
do {							\
	printk(KERN_DEBUG "pid %d: %s: " fmt "\n",	\
		current->pid, __func__, ##args);	\
} while (0)
Linus Torvalds's avatar
Linus Torvalds committed
47
#else
48
#define DPRINTK(fmt, args...) do {} while (0)
Linus Torvalds's avatar
Linus Torvalds committed
49
50
#endif

51
52
53
54
55
56
57
58
59
60
61
62
#define AUTOFS_WARN(fmt, args...)			\
do {							\
	printk(KERN_WARNING "pid %d: %s: " fmt "\n",	\
		current->pid, __func__, ##args);	\
} while (0)

#define AUTOFS_ERROR(fmt, args...)			\
do {							\
	printk(KERN_ERR "pid %d: %s: " fmt "\n",	\
		current->pid, __func__, ##args);	\
} while (0)

Linus Torvalds's avatar
Linus Torvalds committed
63
64
65
66
67
68
69
70
71
72
73
74
/* Unified info structure.  This is pointed to by both the dentry and
   inode structures.  Each file in the filesystem has an instance of this
   structure.  It holds a reference to the dentry, so dentries are never
   flushed while the file exists.  All name lookups are dealt with at the
   dentry level, although the filesystem can interfere in the validation
   process.  Readdir is implemented by traversing the dentry lists. */
struct autofs_info {
	struct dentry	*dentry;
	struct inode	*inode;

	int		flags;

75
76
	struct completion expire_complete;

77
	struct list_head active;
78
79
	int active_count;

80
	struct list_head expiring;
81

Linus Torvalds's avatar
Linus Torvalds committed
82
83
	struct autofs_sb_info *sbi;
	unsigned long last_used;
84
	atomic_t count;
Linus Torvalds's avatar
Linus Torvalds committed
85

86
87
88
	uid_t uid;
	gid_t gid;

Linus Torvalds's avatar
Linus Torvalds committed
89
90
91
92
93
94
95
96
97
98
	mode_t	mode;
	size_t	size;

	void (*free)(struct autofs_info *);
	union {
		const char *symlink;
	} u;
};

#define AUTOFS_INF_EXPIRING	(1<<0) /* dentry is in the process of expiring */
99
#define AUTOFS_INF_MOUNTPOINT	(1<<1) /* mountpoint status for direct expire */
100
#define AUTOFS_INF_PENDING	(1<<2) /* dentry pending mount */
Linus Torvalds's avatar
Linus Torvalds committed
101
102
103
104
105
106

struct autofs_wait_queue {
	wait_queue_head_t queue;
	struct autofs_wait_queue *next;
	autofs_wqt_t wait_queue_token;
	/* We use the following to see what we are waiting for */
107
	struct qstr name;
108
109
110
111
112
113
	u32 dev;
	u64 ino;
	uid_t uid;
	gid_t gid;
	pid_t pid;
	pid_t tgid;
Linus Torvalds's avatar
Linus Torvalds committed
114
115
	/* This is for status reporting upon return */
	int status;
Ian Kent's avatar
Ian Kent committed
116
	unsigned int wait_ctr;
Linus Torvalds's avatar
Linus Torvalds committed
117
118
119
120
121
122
};

#define AUTOFS_SBI_MAGIC 0x6d4a556d

struct autofs_sb_info {
	u32 magic;
123
	int pipefd;
Linus Torvalds's avatar
Linus Torvalds committed
124
125
126
127
128
	struct file *pipe;
	pid_t oz_pgrp;
	int catatonic;
	int version;
	int sub_version;
129
130
	int min_proto;
	int max_proto;
Linus Torvalds's avatar
Linus Torvalds committed
131
	unsigned long exp_timeout;
132
	unsigned int type;
Linus Torvalds's avatar
Linus Torvalds committed
133
134
135
	int reghost_enabled;
	int needs_reghost;
	struct super_block *sb;
136
	struct mutex wq_mutex;
Ian Kent's avatar
Ian Kent committed
137
	spinlock_t fs_lock;
Linus Torvalds's avatar
Linus Torvalds committed
138
	struct autofs_wait_queue *queues; /* Wait queue pointer */
139
	spinlock_t lookup_lock;
140
	struct list_head active_list;
141
	struct list_head expiring_list;
Linus Torvalds's avatar
Linus Torvalds committed
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
};

static inline struct autofs_sb_info *autofs4_sbi(struct super_block *sb)
{
	return (struct autofs_sb_info *)(sb->s_fs_info);
}

static inline struct autofs_info *autofs4_dentry_ino(struct dentry *dentry)
{
	return (struct autofs_info *)(dentry->d_fsdata);
}

/* autofs4_oz_mode(): do we see the man behind the curtain?  (The
   processes which do manipulations for us in user space sees the raw
   filesystem without "magic".) */

static inline int autofs4_oz_mode(struct autofs_sb_info *sbi) {
159
	return sbi->catatonic || task_pgrp_nr(current) == sbi->oz_pgrp;
Linus Torvalds's avatar
Linus Torvalds committed
160
161
162
163
164
165
166
}

/* Does a dentry have some pending activity? */
static inline int autofs4_ispending(struct dentry *dentry)
{
	struct autofs_info *inf = autofs4_dentry_ino(dentry);

167
	if (inf->flags & AUTOFS_INF_PENDING)
Ian Kent's avatar
Ian Kent committed
168
169
		return 1;

170
171
	if (inf->flags & AUTOFS_INF_EXPIRING)
		return 1;
Ian Kent's avatar
Ian Kent committed
172

173
	return 0;
Linus Torvalds's avatar
Linus Torvalds committed
174
175
176
177
}

static inline void autofs4_copy_atime(struct file *src, struct file *dst)
{
178
179
	dst->f_path.dentry->d_inode->i_atime =
		src->f_path.dentry->d_inode->i_atime;
Linus Torvalds's avatar
Linus Torvalds committed
180
181
182
183
184
185
186
187
	return;
}

struct inode *autofs4_get_inode(struct super_block *, struct autofs_info *);
void autofs4_free_ino(struct autofs_info *);

/* Expiration */
int is_autofs4_dentry(struct dentry *);
188
int autofs4_expire_wait(struct dentry *dentry);
Linus Torvalds's avatar
Linus Torvalds committed
189
190
191
int autofs4_expire_run(struct super_block *, struct vfsmount *,
			struct autofs_sb_info *,
			struct autofs_packet_expire __user *);
192
193
int autofs4_do_expire_multi(struct super_block *sb, struct vfsmount *mnt,
			    struct autofs_sb_info *sbi, int when);
Linus Torvalds's avatar
Linus Torvalds committed
194
195
int autofs4_expire_multi(struct super_block *, struct vfsmount *,
			struct autofs_sb_info *, int __user *);
196
197
198
199
200
201
202
203
204
205
206
struct dentry *autofs4_expire_direct(struct super_block *sb,
				     struct vfsmount *mnt,
				     struct autofs_sb_info *sbi, int how);
struct dentry *autofs4_expire_indirect(struct super_block *sb,
				       struct vfsmount *mnt,
				       struct autofs_sb_info *sbi, int how);

/* Device node initialization */

int autofs_dev_ioctl_init(void);
void autofs_dev_ioctl_exit(void);
Linus Torvalds's avatar
Linus Torvalds committed
207
208
209

/* Operations structures */

210
211
212
213
214
extern const struct inode_operations autofs4_symlink_inode_operations;
extern const struct inode_operations autofs4_dir_inode_operations;
extern const struct inode_operations autofs4_root_inode_operations;
extern const struct inode_operations autofs4_indirect_root_inode_operations;
extern const struct inode_operations autofs4_direct_root_inode_operations;
215
216
extern const struct file_operations autofs4_dir_operations;
extern const struct file_operations autofs4_root_operations;
Linus Torvalds's avatar
Linus Torvalds committed
217
218
219
220
221
222
223
224
225
226
227
228

/* Initializing function */

int autofs4_fill_super(struct super_block *, void *, int);
struct autofs_info *autofs4_init_ino(struct autofs_info *, struct autofs_sb_info *sbi, mode_t mode);

/* Queue management functions */

int autofs4_wait(struct autofs_sb_info *,struct dentry *, enum autofs_notify);
int autofs4_wait_release(struct autofs_sb_info *,autofs_wqt_t,int);
void autofs4_catatonic_mode(struct autofs_sb_info *);

Al Viro's avatar
Al Viro committed
229
static inline int autofs4_follow_mount(struct path *path)
230
231
232
{
	int res = 0;

Al Viro's avatar
Al Viro committed
233
234
	while (d_mountpoint(path->dentry)) {
		int followed = follow_down(path);
235
236
237
238
239
240
241
		if (!followed)
			break;
		res = 1;
	}
	return res;
}

242
243
244
245
246
247
248
249
250
251
static inline u32 autofs4_get_dev(struct autofs_sb_info *sbi)
{
	return new_encode_dev(sbi->sb->s_dev);
}

static inline u64 autofs4_get_ino(struct autofs_sb_info *sbi)
{
	return sbi->sb->s_root->d_inode->i_ino;
}

Linus Torvalds's avatar
Linus Torvalds committed
252
253
254
255
256
static inline int simple_positive(struct dentry *dentry)
{
	return dentry->d_inode && !d_unhashed(dentry);
}

257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
static inline void autofs4_add_expiring(struct dentry *dentry)
{
	struct autofs_sb_info *sbi = autofs4_sbi(dentry->d_sb);
	struct autofs_info *ino = autofs4_dentry_ino(dentry);
	if (ino) {
		spin_lock(&sbi->lookup_lock);
		if (list_empty(&ino->expiring))
			list_add(&ino->expiring, &sbi->expiring_list);
		spin_unlock(&sbi->lookup_lock);
	}
	return;
}

static inline void autofs4_del_expiring(struct dentry *dentry)
{
	struct autofs_sb_info *sbi = autofs4_sbi(dentry->d_sb);
	struct autofs_info *ino = autofs4_dentry_ino(dentry);
	if (ino) {
		spin_lock(&sbi->lookup_lock);
		if (!list_empty(&ino->expiring))
			list_del_init(&ino->expiring);
		spin_unlock(&sbi->lookup_lock);
	}
	return;
}

283
void autofs4_dentry_release(struct dentry *);
284
extern void autofs4_kill_sb(struct super_block *);