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/list.h>
21 /* This is the range of ioctl() numbers we claim as ours */
22 #define AUTOFS_IOC_FIRST AUTOFS_IOC_READY
23 #define AUTOFS_IOC_COUNT 32
25 #define AUTOFS_DEV_IOCTL_IOC_FIRST (AUTOFS_DEV_IOCTL_VERSION)
26 #define AUTOFS_DEV_IOCTL_IOC_COUNT (AUTOFS_IOC_COUNT - 11)
28 #include <linux/kernel.h>
29 #include <linux/slab.h>
30 #include <linux/time.h>
31 #include <linux/string.h>
32 #include <linux/wait.h>
33 #include <linux/sched.h>
34 #include <linux/mount.h>
35 #include <linux/namei.h>
36 #include <asm/current.h>
37 #include <asm/uaccess.h>
42 #define DPRINTK(fmt, args...) \
44 printk(KERN_DEBUG "pid %d: %s: " fmt "\n", \
45 current->pid, __func__, ##args); \
48 #define DPRINTK(fmt, args...) do {} while (0)
51 #define AUTOFS_WARN(fmt, args...) \
53 printk(KERN_WARNING "pid %d: %s: " fmt "\n", \
54 current->pid, __func__, ##args); \
57 #define AUTOFS_ERROR(fmt, args...) \
59 printk(KERN_ERR "pid %d: %s: " fmt "\n", \
60 current->pid, __func__, ##args); \
63 /* Unified info structure. This is pointed to by both the dentry and
64 inode structures. Each file in the filesystem has an instance of this
65 structure. It holds a reference to the dentry, so dentries are never
66 flushed while the file exists. All name lookups are dealt with at the
67 dentry level, although the filesystem can interfere in the validation
68 process. Readdir is implemented by traversing the dentry lists. */
70 struct dentry *dentry;
75 struct completion expire_complete;
77 struct list_head active;
80 struct list_head expiring;
82 struct autofs_sb_info *sbi;
83 unsigned long last_used;
92 void (*free)(struct autofs_info *);
98 #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 */
101 struct autofs_wait_queue {
102 wait_queue_head_t queue;
103 struct autofs_wait_queue *next;
104 autofs_wqt_t wait_queue_token;
105 /* We use the following to see what we are waiting for */
113 /* This is for status reporting upon return */
115 unsigned int wait_ctr;
118 #define AUTOFS_SBI_MAGIC 0x6d4a556d
120 struct autofs_sb_info {
130 unsigned long exp_timeout;
134 struct super_block *sb;
135 struct mutex wq_mutex;
137 struct autofs_wait_queue *queues; /* Wait queue pointer */
138 spinlock_t lookup_lock;
139 struct list_head active_list;
140 struct list_head expiring_list;
143 static inline struct autofs_sb_info *autofs4_sbi(struct super_block *sb)
145 return (struct autofs_sb_info *)(sb->s_fs_info);
148 static inline struct autofs_info *autofs4_dentry_ino(struct dentry *dentry)
150 return (struct autofs_info *)(dentry->d_fsdata);
153 /* autofs4_oz_mode(): do we see the man behind the curtain? (The
154 processes which do manipulations for us in user space sees the raw
155 filesystem without "magic".) */
157 static inline int autofs4_oz_mode(struct autofs_sb_info *sbi) {
158 return sbi->catatonic || task_pgrp_nr(current) == sbi->oz_pgrp;
161 /* Does a dentry have some pending activity? */
162 static inline int autofs4_ispending(struct dentry *dentry)
164 struct autofs_info *inf = autofs4_dentry_ino(dentry);
166 if (dentry->d_flags & DCACHE_AUTOFS_PENDING)
169 if (inf->flags & AUTOFS_INF_EXPIRING)
175 static inline void autofs4_copy_atime(struct file *src, struct file *dst)
177 dst->f_path.dentry->d_inode->i_atime =
178 src->f_path.dentry->d_inode->i_atime;
182 struct inode *autofs4_get_inode(struct super_block *, struct autofs_info *);
183 void autofs4_free_ino(struct autofs_info *);
186 int is_autofs4_dentry(struct dentry *);
187 int autofs4_expire_wait(struct dentry *dentry);
188 int autofs4_expire_run(struct super_block *, struct vfsmount *,
189 struct autofs_sb_info *,
190 struct autofs_packet_expire __user *);
191 int autofs4_do_expire_multi(struct super_block *sb, struct vfsmount *mnt,
192 struct autofs_sb_info *sbi, int when);
193 int autofs4_expire_multi(struct super_block *, struct vfsmount *,
194 struct autofs_sb_info *, int __user *);
195 struct dentry *autofs4_expire_direct(struct super_block *sb,
196 struct vfsmount *mnt,
197 struct autofs_sb_info *sbi, int how);
198 struct dentry *autofs4_expire_indirect(struct super_block *sb,
199 struct vfsmount *mnt,
200 struct autofs_sb_info *sbi, int how);
202 /* Device node initialization */
204 int autofs_dev_ioctl_init(void);
205 void autofs_dev_ioctl_exit(void);
207 /* Operations structures */
209 extern const struct inode_operations autofs4_symlink_inode_operations;
210 extern const struct inode_operations autofs4_dir_inode_operations;
211 extern const struct inode_operations autofs4_root_inode_operations;
212 extern const struct inode_operations autofs4_indirect_root_inode_operations;
213 extern const struct inode_operations autofs4_direct_root_inode_operations;
214 extern const struct file_operations autofs4_dir_operations;
215 extern const struct file_operations autofs4_root_operations;
217 /* Initializing function */
219 int autofs4_fill_super(struct super_block *, void *, int);
220 struct autofs_info *autofs4_init_ino(struct autofs_info *, struct autofs_sb_info *sbi, mode_t mode);
222 /* Queue management functions */
224 int autofs4_wait(struct autofs_sb_info *,struct dentry *, enum autofs_notify);
225 int autofs4_wait_release(struct autofs_sb_info *,autofs_wqt_t,int);
226 void autofs4_catatonic_mode(struct autofs_sb_info *);
228 static inline int autofs4_follow_mount(struct path *path)
232 while (d_mountpoint(path->dentry)) {
233 int followed = follow_down(path);
241 static inline u32 autofs4_get_dev(struct autofs_sb_info *sbi)
243 return new_encode_dev(sbi->sb->s_dev);
246 static inline u64 autofs4_get_ino(struct autofs_sb_info *sbi)
248 return sbi->sb->s_root->d_inode->i_ino;
251 static inline int simple_positive(struct dentry *dentry)
253 return dentry->d_inode && !d_unhashed(dentry);
256 static inline int __simple_empty(struct dentry *dentry)
258 struct dentry *child;
261 list_for_each_entry(child, &dentry->d_subdirs, d_u.d_child)
262 if (simple_positive(child))
269 static inline void autofs4_add_expiring(struct dentry *dentry)
271 struct autofs_sb_info *sbi = autofs4_sbi(dentry->d_sb);
272 struct autofs_info *ino = autofs4_dentry_ino(dentry);
274 spin_lock(&sbi->lookup_lock);
275 if (list_empty(&ino->expiring))
276 list_add(&ino->expiring, &sbi->expiring_list);
277 spin_unlock(&sbi->lookup_lock);
282 static inline void autofs4_del_expiring(struct dentry *dentry)
284 struct autofs_sb_info *sbi = autofs4_sbi(dentry->d_sb);
285 struct autofs_info *ino = autofs4_dentry_ino(dentry);
287 spin_lock(&sbi->lookup_lock);
288 if (!list_empty(&ino->expiring))
289 list_del_init(&ino->expiring);
290 spin_unlock(&sbi->lookup_lock);
295 void autofs4_dentry_release(struct dentry *);
296 extern void autofs4_kill_sb(struct super_block *);