1 /* -*- c -*- ------------------------------------------------------------- *
3 * linux/fs/autofs/autofs_i.h
5 * Copyright 1997-1998 Transmeta Corporation - All Rights Reserved
6 * Copyright 2005-2006 Ian Kent <raven@themaw.net>
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.
12 * ----------------------------------------------------------------------- */
14 /* Internal header file for autofs */
16 #include <linux/auto_fs4.h>
17 #include <linux/auto_dev-ioctl.h>
18 #include <linux/mutex.h>
19 #include <linux/spinlock.h>
20 #include <linux/list.h>
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
26 #define AUTOFS_DEV_IOCTL_IOC_FIRST (AUTOFS_DEV_IOCTL_VERSION)
27 #define AUTOFS_DEV_IOCTL_IOC_COUNT (AUTOFS_IOC_COUNT - 11)
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>
43 #define DPRINTK(fmt, args...) \
45 printk(KERN_DEBUG "pid %d: %s: " fmt "\n", \
46 current->pid, __func__, ##args); \
49 #define DPRINTK(fmt, args...) do {} while (0)
52 #define AUTOFS_WARN(fmt, args...) \
54 printk(KERN_WARNING "pid %d: %s: " fmt "\n", \
55 current->pid, __func__, ##args); \
58 #define AUTOFS_ERROR(fmt, args...) \
60 printk(KERN_ERR "pid %d: %s: " fmt "\n", \
61 current->pid, __func__, ##args); \
64 extern spinlock_t autofs4_lock;
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. */
73 struct dentry *dentry;
78 struct completion expire_complete;
80 struct list_head active;
83 struct list_head expiring;
85 struct autofs_sb_info *sbi;
86 unsigned long last_used;
95 void (*free)(struct autofs_info *);
101 #define AUTOFS_INF_EXPIRING (1<<0) /* dentry is in the process of expiring */
102 #define AUTOFS_INF_PENDING (1<<2) /* dentry pending mount */
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 */
116 /* This is for status reporting upon return */
118 unsigned int wait_ctr;
121 #define AUTOFS_SBI_MAGIC 0x6d4a556d
123 struct autofs_sb_info {
133 unsigned long exp_timeout;
137 struct super_block *sb;
138 struct mutex wq_mutex;
140 struct autofs_wait_queue *queues; /* Wait queue pointer */
141 spinlock_t lookup_lock;
142 struct list_head active_list;
143 struct list_head expiring_list;
146 static inline struct autofs_sb_info *autofs4_sbi(struct super_block *sb)
148 return (struct autofs_sb_info *)(sb->s_fs_info);
151 static inline struct autofs_info *autofs4_dentry_ino(struct dentry *dentry)
153 return (struct autofs_info *)(dentry->d_fsdata);
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".) */
160 static inline int autofs4_oz_mode(struct autofs_sb_info *sbi) {
161 return sbi->catatonic || task_pgrp_nr(current) == sbi->oz_pgrp;
164 /* Does a dentry have some pending activity? */
165 static inline int autofs4_ispending(struct dentry *dentry)
167 struct autofs_info *inf = autofs4_dentry_ino(dentry);
169 if (inf->flags & AUTOFS_INF_PENDING)
172 if (inf->flags & AUTOFS_INF_EXPIRING)
178 struct inode *autofs4_get_inode(struct super_block *, struct autofs_info *);
179 void autofs4_free_ino(struct autofs_info *);
182 int is_autofs4_dentry(struct dentry *);
183 int autofs4_expire_wait(struct dentry *dentry);
184 int autofs4_expire_run(struct super_block *, struct vfsmount *,
185 struct autofs_sb_info *,
186 struct autofs_packet_expire __user *);
187 int autofs4_do_expire_multi(struct super_block *sb, struct vfsmount *mnt,
188 struct autofs_sb_info *sbi, int when);
189 int autofs4_expire_multi(struct super_block *, struct vfsmount *,
190 struct autofs_sb_info *, int __user *);
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);
198 /* Device node initialization */
200 int autofs_dev_ioctl_init(void);
201 void autofs_dev_ioctl_exit(void);
203 /* Operations structures */
205 extern const struct inode_operations autofs4_symlink_inode_operations;
206 extern const struct inode_operations autofs4_dir_inode_operations;
207 extern const struct file_operations autofs4_dir_operations;
208 extern const struct file_operations autofs4_root_operations;
210 /* Operations methods */
212 struct vfsmount *autofs4_d_automount(struct path *);
213 int autofs4_d_manage(struct dentry *, bool);
215 /* VFS automount flags management functions */
217 static inline void __managed_dentry_set_automount(struct dentry *dentry)
219 dentry->d_flags |= DCACHE_NEED_AUTOMOUNT;
222 static inline void managed_dentry_set_automount(struct dentry *dentry)
224 spin_lock(&dentry->d_lock);
225 __managed_dentry_set_automount(dentry);
226 spin_unlock(&dentry->d_lock);
229 static inline void __managed_dentry_clear_automount(struct dentry *dentry)
231 dentry->d_flags &= ~DCACHE_NEED_AUTOMOUNT;
234 static inline void managed_dentry_clear_automount(struct dentry *dentry)
236 spin_lock(&dentry->d_lock);
237 __managed_dentry_clear_automount(dentry);
238 spin_unlock(&dentry->d_lock);
241 static inline void __managed_dentry_set_transit(struct dentry *dentry)
243 dentry->d_flags |= DCACHE_MANAGE_TRANSIT;
246 static inline void managed_dentry_set_transit(struct dentry *dentry)
248 spin_lock(&dentry->d_lock);
249 __managed_dentry_set_transit(dentry);
250 spin_unlock(&dentry->d_lock);
253 static inline void __managed_dentry_clear_transit(struct dentry *dentry)
255 dentry->d_flags &= ~DCACHE_MANAGE_TRANSIT;
258 static inline void managed_dentry_clear_transit(struct dentry *dentry)
260 spin_lock(&dentry->d_lock);
261 __managed_dentry_clear_transit(dentry);
262 spin_unlock(&dentry->d_lock);
265 static inline void __managed_dentry_set_managed(struct dentry *dentry)
267 dentry->d_flags |= (DCACHE_NEED_AUTOMOUNT|DCACHE_MANAGE_TRANSIT);
270 static inline void managed_dentry_set_managed(struct dentry *dentry)
272 spin_lock(&dentry->d_lock);
273 __managed_dentry_set_managed(dentry);
274 spin_unlock(&dentry->d_lock);
277 static inline void __managed_dentry_clear_managed(struct dentry *dentry)
279 dentry->d_flags &= ~(DCACHE_NEED_AUTOMOUNT|DCACHE_MANAGE_TRANSIT);
282 static inline void managed_dentry_clear_managed(struct dentry *dentry)
284 spin_lock(&dentry->d_lock);
285 __managed_dentry_clear_managed(dentry);
286 spin_unlock(&dentry->d_lock);
289 /* Initializing function */
291 int autofs4_fill_super(struct super_block *, void *, int);
292 struct autofs_info *autofs4_init_ino(struct autofs_info *, struct autofs_sb_info *sbi, mode_t mode);
294 /* Queue management functions */
296 int autofs4_wait(struct autofs_sb_info *,struct dentry *, enum autofs_notify);
297 int autofs4_wait_release(struct autofs_sb_info *,autofs_wqt_t,int);
298 void autofs4_catatonic_mode(struct autofs_sb_info *);
300 static inline u32 autofs4_get_dev(struct autofs_sb_info *sbi)
302 return new_encode_dev(sbi->sb->s_dev);
305 static inline u64 autofs4_get_ino(struct autofs_sb_info *sbi)
307 return sbi->sb->s_root->d_inode->i_ino;
310 static inline int simple_positive(struct dentry *dentry)
312 return dentry->d_inode && !d_unhashed(dentry);
315 static inline void __autofs4_add_expiring(struct dentry *dentry)
317 struct autofs_sb_info *sbi = autofs4_sbi(dentry->d_sb);
318 struct autofs_info *ino = autofs4_dentry_ino(dentry);
320 if (list_empty(&ino->expiring))
321 list_add(&ino->expiring, &sbi->expiring_list);
326 static inline void autofs4_add_expiring(struct dentry *dentry)
328 struct autofs_sb_info *sbi = autofs4_sbi(dentry->d_sb);
329 struct autofs_info *ino = autofs4_dentry_ino(dentry);
331 spin_lock(&sbi->lookup_lock);
332 if (list_empty(&ino->expiring))
333 list_add(&ino->expiring, &sbi->expiring_list);
334 spin_unlock(&sbi->lookup_lock);
339 static inline void autofs4_del_expiring(struct dentry *dentry)
341 struct autofs_sb_info *sbi = autofs4_sbi(dentry->d_sb);
342 struct autofs_info *ino = autofs4_dentry_ino(dentry);
344 spin_lock(&sbi->lookup_lock);
345 if (!list_empty(&ino->expiring))
346 list_del_init(&ino->expiring);
347 spin_unlock(&sbi->lookup_lock);
352 void autofs4_dentry_release(struct dentry *);
353 extern void autofs4_kill_sb(struct super_block *);