autofs_i.h 8.98 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>
Nick Piggin's avatar
Nick Piggin committed
19
#include <linux/spinlock.h>
Linus Torvalds's avatar
Linus Torvalds committed
20
21
22
23
24
25
#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

26
27
28
#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
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 */

42
43
44
#define DPRINTK(fmt, ...)				\
	pr_debug("pid %d: %s: " fmt "\n",		\
		current->pid, __func__, ##__VA_ARGS__)
Linus Torvalds's avatar
Linus Torvalds committed
45

46
#define AUTOFS_WARN(fmt, ...)				\
47
	printk(KERN_WARNING "pid %d: %s: " fmt "\n",	\
48
		current->pid, __func__, ##__VA_ARGS__)
49

50
#define AUTOFS_ERROR(fmt, ...)				\
51
	printk(KERN_ERR "pid %d: %s: " fmt "\n",	\
52
		current->pid, __func__, ##__VA_ARGS__)
53

Linus Torvalds's avatar
Linus Torvalds committed
54
55
56
57
58
59
60
61
62
63
64
65
/* 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;

66
67
	struct completion expire_complete;

68
	struct list_head active;
69
70
	int active_count;

71
	struct list_head expiring;
72

Linus Torvalds's avatar
Linus Torvalds committed
73
74
	struct autofs_sb_info *sbi;
	unsigned long last_used;
75
	atomic_t count;
Linus Torvalds's avatar
Linus Torvalds committed
76

77
78
	uid_t uid;
	gid_t gid;
Linus Torvalds's avatar
Linus Torvalds committed
79
80
81
};

#define AUTOFS_INF_EXPIRING	(1<<0) /* dentry is in the process of expiring */
82
#define AUTOFS_INF_PENDING	(1<<2) /* dentry pending mount */
Linus Torvalds's avatar
Linus Torvalds committed
83
84
85
86
87
88

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 */
89
	struct qstr name;
90
91
92
93
94
95
	u32 dev;
	u64 ino;
	uid_t uid;
	gid_t gid;
	pid_t pid;
	pid_t tgid;
Linus Torvalds's avatar
Linus Torvalds committed
96
97
	/* This is for status reporting upon return */
	int status;
Ian Kent's avatar
Ian Kent committed
98
	unsigned int wait_ctr;
Linus Torvalds's avatar
Linus Torvalds committed
99
100
101
102
103
104
};

#define AUTOFS_SBI_MAGIC 0x6d4a556d

struct autofs_sb_info {
	u32 magic;
105
	int pipefd;
Linus Torvalds's avatar
Linus Torvalds committed
106
107
108
109
110
	struct file *pipe;
	pid_t oz_pgrp;
	int catatonic;
	int version;
	int sub_version;
111
112
	int min_proto;
	int max_proto;
Linus Torvalds's avatar
Linus Torvalds committed
113
	unsigned long exp_timeout;
114
	unsigned int type;
Linus Torvalds's avatar
Linus Torvalds committed
115
116
117
	int reghost_enabled;
	int needs_reghost;
	struct super_block *sb;
118
	struct mutex wq_mutex;
119
	struct mutex pipe_mutex;
Ian Kent's avatar
Ian Kent committed
120
	spinlock_t fs_lock;
Linus Torvalds's avatar
Linus Torvalds committed
121
	struct autofs_wait_queue *queues; /* Wait queue pointer */
122
	spinlock_t lookup_lock;
123
	struct list_head active_list;
124
	struct list_head expiring_list;
Linus Torvalds's avatar
Linus Torvalds committed
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
};

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) {
142
	return sbi->catatonic || task_pgrp_nr(current) == sbi->oz_pgrp;
Linus Torvalds's avatar
Linus Torvalds committed
143
144
145
146
147
148
149
}

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

150
	if (inf->flags & AUTOFS_INF_PENDING)
Ian Kent's avatar
Ian Kent committed
151
152
		return 1;

153
154
	if (inf->flags & AUTOFS_INF_EXPIRING)
		return 1;
Ian Kent's avatar
Ian Kent committed
155

156
	return 0;
Linus Torvalds's avatar
Linus Torvalds committed
157
158
}

Al Viro's avatar
Al Viro committed
159
struct inode *autofs4_get_inode(struct super_block *, umode_t);
Linus Torvalds's avatar
Linus Torvalds committed
160
161
162
163
void autofs4_free_ino(struct autofs_info *);

/* Expiration */
int is_autofs4_dentry(struct dentry *);
164
int autofs4_expire_wait(struct dentry *dentry);
Linus Torvalds's avatar
Linus Torvalds committed
165
166
167
int autofs4_expire_run(struct super_block *, struct vfsmount *,
			struct autofs_sb_info *,
			struct autofs_packet_expire __user *);
168
169
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
170
171
int autofs4_expire_multi(struct super_block *, struct vfsmount *,
			struct autofs_sb_info *, int __user *);
172
173
174
175
176
177
178
179
180
181
182
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
183
184
185

/* Operations structures */

186
187
extern const struct inode_operations autofs4_symlink_inode_operations;
extern const struct inode_operations autofs4_dir_inode_operations;
188
189
extern const struct file_operations autofs4_dir_operations;
extern const struct file_operations autofs4_root_operations;
Ian Kent's avatar
Ian Kent committed
190
extern const struct dentry_operations autofs4_dentry_operations;
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217

/* VFS automount flags management functions */

static inline void __managed_dentry_set_automount(struct dentry *dentry)
{
	dentry->d_flags |= DCACHE_NEED_AUTOMOUNT;
}

static inline void managed_dentry_set_automount(struct dentry *dentry)
{
	spin_lock(&dentry->d_lock);
	__managed_dentry_set_automount(dentry);
	spin_unlock(&dentry->d_lock);
}

static inline void __managed_dentry_clear_automount(struct dentry *dentry)
{
	dentry->d_flags &= ~DCACHE_NEED_AUTOMOUNT;
}

static inline void managed_dentry_clear_automount(struct dentry *dentry)
{
	spin_lock(&dentry->d_lock);
	__managed_dentry_clear_automount(dentry);
	spin_unlock(&dentry->d_lock);
}

218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
static inline void __managed_dentry_set_transit(struct dentry *dentry)
{
	dentry->d_flags |= DCACHE_MANAGE_TRANSIT;
}

static inline void managed_dentry_set_transit(struct dentry *dentry)
{
	spin_lock(&dentry->d_lock);
	__managed_dentry_set_transit(dentry);
	spin_unlock(&dentry->d_lock);
}

static inline void __managed_dentry_clear_transit(struct dentry *dentry)
{
	dentry->d_flags &= ~DCACHE_MANAGE_TRANSIT;
}

static inline void managed_dentry_clear_transit(struct dentry *dentry)
{
	spin_lock(&dentry->d_lock);
	__managed_dentry_clear_transit(dentry);
	spin_unlock(&dentry->d_lock);
}

static inline void __managed_dentry_set_managed(struct dentry *dentry)
{
	dentry->d_flags |= (DCACHE_NEED_AUTOMOUNT|DCACHE_MANAGE_TRANSIT);
}

static inline void managed_dentry_set_managed(struct dentry *dentry)
{
	spin_lock(&dentry->d_lock);
	__managed_dentry_set_managed(dentry);
	spin_unlock(&dentry->d_lock);
}

static inline void __managed_dentry_clear_managed(struct dentry *dentry)
{
	dentry->d_flags &= ~(DCACHE_NEED_AUTOMOUNT|DCACHE_MANAGE_TRANSIT);
}

static inline void managed_dentry_clear_managed(struct dentry *dentry)
{
	spin_lock(&dentry->d_lock);
	__managed_dentry_clear_managed(dentry);
	spin_unlock(&dentry->d_lock);
}

Linus Torvalds's avatar
Linus Torvalds committed
266
267
268
/* Initializing function */

int autofs4_fill_super(struct super_block *, void *, int);
Al Viro's avatar
Al Viro committed
269
270
struct autofs_info *autofs4_new_ino(struct autofs_sb_info *);
void autofs4_clean_ino(struct autofs_info *);
Linus Torvalds's avatar
Linus Torvalds committed
271
272
273
274
275
276
277

/* 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 *);

278
279
280
281
282
283
284
285
286
287
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
288
289
290
291
292
static inline int simple_positive(struct dentry *dentry)
{
	return dentry->d_inode && !d_unhashed(dentry);
}

Nick Piggin's avatar
Nick Piggin committed
293
294
295
296
297
298
299
300
301
302
303
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) {
		if (list_empty(&ino->expiring))
			list_add(&ino->expiring, &sbi->expiring_list);
	}
	return;
}

304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
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;
}

330
extern void autofs4_kill_sb(struct super_block *);