Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /* -*- c -*- ------------------------------------------------------------- * |
2 | * | |
3 | * linux/fs/autofs/autofs_i.h | |
4 | * | |
5 | * Copyright 1997-1998 Transmeta Corporation - All Rights Reserved | |
34ca959c | 6 | * Copyright 2005-2006 Ian Kent <raven@themaw.net> |
1da177e4 LT |
7 | * |
8 | * This file is part of the Linux kernel and is made available under | |
9 | * the terms of the GNU General Public License, version 2, or at your | |
10 | * option, any later version, incorporated herein by reference. | |
11 | * | |
12 | * ----------------------------------------------------------------------- */ | |
13 | ||
14 | /* Internal header file for autofs */ | |
15 | ||
16 | #include <linux/auto_fs4.h> | |
8d7b48e0 | 17 | #include <linux/auto_dev-ioctl.h> |
1d5599e3 | 18 | #include <linux/mutex.h> |
b5c84bf6 | 19 | #include <linux/spinlock.h> |
1da177e4 LT |
20 | #include <linux/list.h> |
21 | ||
22 | /* This is the range of ioctl() numbers we claim as ours */ | |
23 | #define AUTOFS_IOC_FIRST AUTOFS_IOC_READY | |
24 | #define AUTOFS_IOC_COUNT 32 | |
25 | ||
8d7b48e0 IK |
26 | #define AUTOFS_DEV_IOCTL_IOC_FIRST (AUTOFS_DEV_IOCTL_VERSION) |
27 | #define AUTOFS_DEV_IOCTL_IOC_COUNT (AUTOFS_IOC_COUNT - 11) | |
28 | ||
1da177e4 LT |
29 | #include <linux/kernel.h> |
30 | #include <linux/slab.h> | |
31 | #include <linux/time.h> | |
32 | #include <linux/string.h> | |
33 | #include <linux/wait.h> | |
34 | #include <linux/sched.h> | |
35 | #include <linux/mount.h> | |
36 | #include <linux/namei.h> | |
37 | #include <asm/current.h> | |
38 | #include <asm/uaccess.h> | |
39 | ||
40 | /* #define DEBUG */ | |
41 | ||
42 | #ifdef DEBUG | |
8d7b48e0 IK |
43 | #define DPRINTK(fmt, args...) \ |
44 | do { \ | |
45 | printk(KERN_DEBUG "pid %d: %s: " fmt "\n", \ | |
46 | current->pid, __func__, ##args); \ | |
47 | } while (0) | |
1da177e4 | 48 | #else |
8d7b48e0 | 49 | #define DPRINTK(fmt, args...) do {} while (0) |
1da177e4 LT |
50 | #endif |
51 | ||
8d7b48e0 IK |
52 | #define AUTOFS_WARN(fmt, args...) \ |
53 | do { \ | |
54 | printk(KERN_WARNING "pid %d: %s: " fmt "\n", \ | |
55 | current->pid, __func__, ##args); \ | |
56 | } while (0) | |
57 | ||
58 | #define AUTOFS_ERROR(fmt, args...) \ | |
59 | do { \ | |
60 | printk(KERN_ERR "pid %d: %s: " fmt "\n", \ | |
61 | current->pid, __func__, ##args); \ | |
62 | } while (0) | |
63 | ||
b5c84bf6 NP |
64 | extern spinlock_t autofs4_lock; |
65 | ||
1da177e4 LT |
66 | /* Unified info structure. This is pointed to by both the dentry and |
67 | inode structures. Each file in the filesystem has an instance of this | |
68 | structure. It holds a reference to the dentry, so dentries are never | |
69 | flushed while the file exists. All name lookups are dealt with at the | |
70 | dentry level, although the filesystem can interfere in the validation | |
71 | process. Readdir is implemented by traversing the dentry lists. */ | |
72 | struct autofs_info { | |
73 | struct dentry *dentry; | |
74 | struct inode *inode; | |
75 | ||
76 | int flags; | |
77 | ||
6e60a9ab IK |
78 | struct completion expire_complete; |
79 | ||
25767378 | 80 | struct list_head active; |
4f8427d1 IK |
81 | int active_count; |
82 | ||
5f6f4f28 | 83 | struct list_head expiring; |
f50b6f86 | 84 | |
1da177e4 LT |
85 | struct autofs_sb_info *sbi; |
86 | unsigned long last_used; | |
1aff3c8b | 87 | atomic_t count; |
1da177e4 | 88 | |
c0f54d3e IK |
89 | uid_t uid; |
90 | gid_t gid; | |
91 | ||
1da177e4 LT |
92 | mode_t mode; |
93 | size_t size; | |
94 | ||
95 | void (*free)(struct autofs_info *); | |
96 | union { | |
97 | const char *symlink; | |
98 | } u; | |
99 | }; | |
100 | ||
101 | #define AUTOFS_INF_EXPIRING (1<<0) /* dentry is in the process of expiring */ | |
aa952eb2 | 102 | #define AUTOFS_INF_PENDING (1<<2) /* dentry pending mount */ |
1da177e4 LT |
103 | |
104 | struct autofs_wait_queue { | |
105 | wait_queue_head_t queue; | |
106 | struct autofs_wait_queue *next; | |
107 | autofs_wqt_t wait_queue_token; | |
108 | /* We use the following to see what we are waiting for */ | |
70b52a0a | 109 | struct qstr name; |
5c0a32fc IK |
110 | u32 dev; |
111 | u64 ino; | |
112 | uid_t uid; | |
113 | gid_t gid; | |
114 | pid_t pid; | |
115 | pid_t tgid; | |
1da177e4 LT |
116 | /* This is for status reporting upon return */ |
117 | int status; | |
296f7bf7 | 118 | unsigned int wait_ctr; |
1da177e4 LT |
119 | }; |
120 | ||
121 | #define AUTOFS_SBI_MAGIC 0x6d4a556d | |
122 | ||
123 | struct autofs_sb_info { | |
124 | u32 magic; | |
d7c4a5f1 | 125 | int pipefd; |
1da177e4 LT |
126 | struct file *pipe; |
127 | pid_t oz_pgrp; | |
128 | int catatonic; | |
129 | int version; | |
130 | int sub_version; | |
d7c4a5f1 IK |
131 | int min_proto; |
132 | int max_proto; | |
1da177e4 | 133 | unsigned long exp_timeout; |
34ca959c | 134 | unsigned int type; |
1da177e4 LT |
135 | int reghost_enabled; |
136 | int needs_reghost; | |
137 | struct super_block *sb; | |
1d5599e3 | 138 | struct mutex wq_mutex; |
3a9720ce | 139 | spinlock_t fs_lock; |
1da177e4 | 140 | struct autofs_wait_queue *queues; /* Wait queue pointer */ |
5f6f4f28 | 141 | spinlock_t lookup_lock; |
25767378 | 142 | struct list_head active_list; |
5f6f4f28 | 143 | struct list_head expiring_list; |
1da177e4 LT |
144 | }; |
145 | ||
146 | static inline struct autofs_sb_info *autofs4_sbi(struct super_block *sb) | |
147 | { | |
148 | return (struct autofs_sb_info *)(sb->s_fs_info); | |
149 | } | |
150 | ||
151 | static inline struct autofs_info *autofs4_dentry_ino(struct dentry *dentry) | |
152 | { | |
153 | return (struct autofs_info *)(dentry->d_fsdata); | |
154 | } | |
155 | ||
156 | /* autofs4_oz_mode(): do we see the man behind the curtain? (The | |
157 | processes which do manipulations for us in user space sees the raw | |
158 | filesystem without "magic".) */ | |
159 | ||
160 | static inline int autofs4_oz_mode(struct autofs_sb_info *sbi) { | |
a47afb0f | 161 | return sbi->catatonic || task_pgrp_nr(current) == sbi->oz_pgrp; |
1da177e4 LT |
162 | } |
163 | ||
164 | /* Does a dentry have some pending activity? */ | |
165 | static inline int autofs4_ispending(struct dentry *dentry) | |
166 | { | |
167 | struct autofs_info *inf = autofs4_dentry_ino(dentry); | |
168 | ||
aa952eb2 | 169 | if (inf->flags & AUTOFS_INF_PENDING) |
3a9720ce IK |
170 | return 1; |
171 | ||
97e7449a IK |
172 | if (inf->flags & AUTOFS_INF_EXPIRING) |
173 | return 1; | |
3a9720ce | 174 | |
97e7449a | 175 | return 0; |
1da177e4 LT |
176 | } |
177 | ||
1da177e4 LT |
178 | struct inode *autofs4_get_inode(struct super_block *, struct autofs_info *); |
179 | void autofs4_free_ino(struct autofs_info *); | |
180 | ||
181 | /* Expiration */ | |
182 | int is_autofs4_dentry(struct dentry *); | |
06a35985 | 183 | int autofs4_expire_wait(struct dentry *dentry); |
1da177e4 LT |
184 | int autofs4_expire_run(struct super_block *, struct vfsmount *, |
185 | struct autofs_sb_info *, | |
186 | struct autofs_packet_expire __user *); | |
56fcef75 IK |
187 | int autofs4_do_expire_multi(struct super_block *sb, struct vfsmount *mnt, |
188 | struct autofs_sb_info *sbi, int when); | |
1da177e4 LT |
189 | int autofs4_expire_multi(struct super_block *, struct vfsmount *, |
190 | struct autofs_sb_info *, int __user *); | |
8d7b48e0 IK |
191 | struct dentry *autofs4_expire_direct(struct super_block *sb, |
192 | struct vfsmount *mnt, | |
193 | struct autofs_sb_info *sbi, int how); | |
194 | struct dentry *autofs4_expire_indirect(struct super_block *sb, | |
195 | struct vfsmount *mnt, | |
196 | struct autofs_sb_info *sbi, int how); | |
197 | ||
198 | /* Device node initialization */ | |
199 | ||
200 | int autofs_dev_ioctl_init(void); | |
201 | void autofs_dev_ioctl_exit(void); | |
1da177e4 LT |
202 | |
203 | /* Operations structures */ | |
204 | ||
754661f1 AV |
205 | extern const struct inode_operations autofs4_symlink_inode_operations; |
206 | extern const struct inode_operations autofs4_dir_inode_operations; | |
207 | extern const struct inode_operations autofs4_root_inode_operations; | |
208 | extern const struct inode_operations autofs4_indirect_root_inode_operations; | |
209 | extern const struct inode_operations autofs4_direct_root_inode_operations; | |
4b6f5d20 AV |
210 | extern const struct file_operations autofs4_dir_operations; |
211 | extern const struct file_operations autofs4_root_operations; | |
1da177e4 | 212 | |
10584211 IK |
213 | /* Operations methods */ |
214 | ||
215 | struct vfsmount *autofs4_d_automount(struct path *); | |
b5b80177 | 216 | int autofs4_d_manage(struct dentry *, bool); |
10584211 IK |
217 | |
218 | /* VFS automount flags management functions */ | |
219 | ||
220 | static inline void __managed_dentry_set_automount(struct dentry *dentry) | |
221 | { | |
222 | dentry->d_flags |= DCACHE_NEED_AUTOMOUNT; | |
223 | } | |
224 | ||
225 | static inline void managed_dentry_set_automount(struct dentry *dentry) | |
226 | { | |
227 | spin_lock(&dentry->d_lock); | |
228 | __managed_dentry_set_automount(dentry); | |
229 | spin_unlock(&dentry->d_lock); | |
230 | } | |
231 | ||
232 | static inline void __managed_dentry_clear_automount(struct dentry *dentry) | |
233 | { | |
234 | dentry->d_flags &= ~DCACHE_NEED_AUTOMOUNT; | |
235 | } | |
236 | ||
237 | static inline void managed_dentry_clear_automount(struct dentry *dentry) | |
238 | { | |
239 | spin_lock(&dentry->d_lock); | |
240 | __managed_dentry_clear_automount(dentry); | |
241 | spin_unlock(&dentry->d_lock); | |
242 | } | |
243 | ||
b5b80177 IK |
244 | static inline void __managed_dentry_set_transit(struct dentry *dentry) |
245 | { | |
246 | dentry->d_flags |= DCACHE_MANAGE_TRANSIT; | |
247 | } | |
248 | ||
249 | static inline void managed_dentry_set_transit(struct dentry *dentry) | |
250 | { | |
251 | spin_lock(&dentry->d_lock); | |
252 | __managed_dentry_set_transit(dentry); | |
253 | spin_unlock(&dentry->d_lock); | |
254 | } | |
255 | ||
256 | static inline void __managed_dentry_clear_transit(struct dentry *dentry) | |
257 | { | |
258 | dentry->d_flags &= ~DCACHE_MANAGE_TRANSIT; | |
259 | } | |
260 | ||
261 | static inline void managed_dentry_clear_transit(struct dentry *dentry) | |
262 | { | |
263 | spin_lock(&dentry->d_lock); | |
264 | __managed_dentry_clear_transit(dentry); | |
265 | spin_unlock(&dentry->d_lock); | |
266 | } | |
267 | ||
268 | static inline void __managed_dentry_set_managed(struct dentry *dentry) | |
269 | { | |
270 | dentry->d_flags |= (DCACHE_NEED_AUTOMOUNT|DCACHE_MANAGE_TRANSIT); | |
271 | } | |
272 | ||
273 | static inline void managed_dentry_set_managed(struct dentry *dentry) | |
274 | { | |
275 | spin_lock(&dentry->d_lock); | |
276 | __managed_dentry_set_managed(dentry); | |
277 | spin_unlock(&dentry->d_lock); | |
278 | } | |
279 | ||
280 | static inline void __managed_dentry_clear_managed(struct dentry *dentry) | |
281 | { | |
282 | dentry->d_flags &= ~(DCACHE_NEED_AUTOMOUNT|DCACHE_MANAGE_TRANSIT); | |
283 | } | |
284 | ||
285 | static inline void managed_dentry_clear_managed(struct dentry *dentry) | |
286 | { | |
287 | spin_lock(&dentry->d_lock); | |
288 | __managed_dentry_clear_managed(dentry); | |
289 | spin_unlock(&dentry->d_lock); | |
290 | } | |
291 | ||
1da177e4 LT |
292 | /* Initializing function */ |
293 | ||
294 | int autofs4_fill_super(struct super_block *, void *, int); | |
295 | struct autofs_info *autofs4_init_ino(struct autofs_info *, struct autofs_sb_info *sbi, mode_t mode); | |
296 | ||
297 | /* Queue management functions */ | |
298 | ||
1da177e4 LT |
299 | int autofs4_wait(struct autofs_sb_info *,struct dentry *, enum autofs_notify); |
300 | int autofs4_wait_release(struct autofs_sb_info *,autofs_wqt_t,int); | |
301 | void autofs4_catatonic_mode(struct autofs_sb_info *); | |
302 | ||
5c0a32fc IK |
303 | static inline u32 autofs4_get_dev(struct autofs_sb_info *sbi) |
304 | { | |
305 | return new_encode_dev(sbi->sb->s_dev); | |
306 | } | |
307 | ||
308 | static inline u64 autofs4_get_ino(struct autofs_sb_info *sbi) | |
309 | { | |
310 | return sbi->sb->s_root->d_inode->i_ino; | |
311 | } | |
312 | ||
1da177e4 LT |
313 | static inline int simple_positive(struct dentry *dentry) |
314 | { | |
315 | return dentry->d_inode && !d_unhashed(dentry); | |
316 | } | |
317 | ||
2fd6b7f5 NP |
318 | static inline void __autofs4_add_expiring(struct dentry *dentry) |
319 | { | |
320 | struct autofs_sb_info *sbi = autofs4_sbi(dentry->d_sb); | |
321 | struct autofs_info *ino = autofs4_dentry_ino(dentry); | |
322 | if (ino) { | |
323 | if (list_empty(&ino->expiring)) | |
324 | list_add(&ino->expiring, &sbi->expiring_list); | |
325 | } | |
326 | return; | |
327 | } | |
328 | ||
c4cd70b3 IK |
329 | static inline void autofs4_add_expiring(struct dentry *dentry) |
330 | { | |
331 | struct autofs_sb_info *sbi = autofs4_sbi(dentry->d_sb); | |
332 | struct autofs_info *ino = autofs4_dentry_ino(dentry); | |
333 | if (ino) { | |
334 | spin_lock(&sbi->lookup_lock); | |
335 | if (list_empty(&ino->expiring)) | |
336 | list_add(&ino->expiring, &sbi->expiring_list); | |
337 | spin_unlock(&sbi->lookup_lock); | |
338 | } | |
339 | return; | |
340 | } | |
341 | ||
342 | static inline void autofs4_del_expiring(struct dentry *dentry) | |
343 | { | |
344 | struct autofs_sb_info *sbi = autofs4_sbi(dentry->d_sb); | |
345 | struct autofs_info *ino = autofs4_dentry_ino(dentry); | |
346 | if (ino) { | |
347 | spin_lock(&sbi->lookup_lock); | |
348 | if (!list_empty(&ino->expiring)) | |
349 | list_del_init(&ino->expiring); | |
350 | spin_unlock(&sbi->lookup_lock); | |
351 | } | |
352 | return; | |
353 | } | |
354 | ||
f5b95ff0 | 355 | void autofs4_dentry_release(struct dentry *); |
6ce31523 | 356 | extern void autofs4_kill_sb(struct super_block *); |