4b40cbc71e9bc36b5ea4ff6442155d458a4a5cce
[linux-2.6.git] / fs / autofs4 / autofs_i.h
1 /* -*- c -*- ------------------------------------------------------------- *
2  *   
3  * linux/fs/autofs/autofs_i.h
4  *
5  *   Copyright 1997-1998 Transmeta Corporation - All Rights Reserved
6  *   Copyright 2005-2006 Ian Kent <raven@themaw.net>
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>
17 #include <linux/mutex.h>
18 #include <linux/list.h>
19
20 /* This is the range of ioctl() numbers we claim as ours */
21 #define AUTOFS_IOC_FIRST     AUTOFS_IOC_READY
22 #define AUTOFS_IOC_COUNT     32
23
24 #include <linux/kernel.h>
25 #include <linux/slab.h>
26 #include <linux/time.h>
27 #include <linux/string.h>
28 #include <linux/wait.h>
29 #include <linux/sched.h>
30 #include <linux/mount.h>
31 #include <linux/namei.h>
32 #include <asm/current.h>
33 #include <asm/uaccess.h>
34
35 /* #define DEBUG */
36
37 #ifdef DEBUG
38 #define DPRINTK(fmt,args...) do { printk(KERN_DEBUG "pid %d: %s: " fmt "\n" , current->pid , __func__ , ##args); } while(0)
39 #else
40 #define DPRINTK(fmt,args...) do {} while(0)
41 #endif
42
43 /* Unified info structure.  This is pointed to by both the dentry and
44    inode structures.  Each file in the filesystem has an instance of this
45    structure.  It holds a reference to the dentry, so dentries are never
46    flushed while the file exists.  All name lookups are dealt with at the
47    dentry level, although the filesystem can interfere in the validation
48    process.  Readdir is implemented by traversing the dentry lists. */
49 struct autofs_info {
50         struct dentry   *dentry;
51         struct inode    *inode;
52
53         int             flags;
54
55         struct completion expire_complete;
56
57         struct list_head active;
58         struct list_head expiring;
59
60         struct autofs_sb_info *sbi;
61         unsigned long last_used;
62         atomic_t count;
63
64         mode_t  mode;
65         size_t  size;
66
67         void (*free)(struct autofs_info *);
68         union {
69                 const char *symlink;
70         } u;
71 };
72
73 #define AUTOFS_INF_EXPIRING     (1<<0) /* dentry is in the process of expiring */
74 #define AUTOFS_INF_MOUNTPOINT   (1<<1) /* mountpoint status for direct expire */
75
76 struct autofs_wait_queue {
77         wait_queue_head_t queue;
78         struct autofs_wait_queue *next;
79         autofs_wqt_t wait_queue_token;
80         /* We use the following to see what we are waiting for */
81         struct qstr name;
82         u32 dev;
83         u64 ino;
84         uid_t uid;
85         gid_t gid;
86         pid_t pid;
87         pid_t tgid;
88         /* This is for status reporting upon return */
89         int status;
90         unsigned int wait_ctr;
91 };
92
93 #define AUTOFS_SBI_MAGIC 0x6d4a556d
94
95 #define AUTOFS_TYPE_INDIRECT     0x0001
96 #define AUTOFS_TYPE_DIRECT       0x0002
97 #define AUTOFS_TYPE_OFFSET       0x0004
98
99 struct autofs_sb_info {
100         u32 magic;
101         int pipefd;
102         struct file *pipe;
103         pid_t oz_pgrp;
104         int catatonic;
105         int version;
106         int sub_version;
107         int min_proto;
108         int max_proto;
109         unsigned long exp_timeout;
110         unsigned int type;
111         int reghost_enabled;
112         int needs_reghost;
113         struct super_block *sb;
114         struct mutex wq_mutex;
115         spinlock_t fs_lock;
116         struct autofs_wait_queue *queues; /* Wait queue pointer */
117         spinlock_t lookup_lock;
118         struct list_head active_list;
119         struct list_head expiring_list;
120 };
121
122 static inline struct autofs_sb_info *autofs4_sbi(struct super_block *sb)
123 {
124         return (struct autofs_sb_info *)(sb->s_fs_info);
125 }
126
127 static inline struct autofs_info *autofs4_dentry_ino(struct dentry *dentry)
128 {
129         return (struct autofs_info *)(dentry->d_fsdata);
130 }
131
132 /* autofs4_oz_mode(): do we see the man behind the curtain?  (The
133    processes which do manipulations for us in user space sees the raw
134    filesystem without "magic".) */
135
136 static inline int autofs4_oz_mode(struct autofs_sb_info *sbi) {
137         return sbi->catatonic || task_pgrp_nr(current) == sbi->oz_pgrp;
138 }
139
140 /* Does a dentry have some pending activity? */
141 static inline int autofs4_ispending(struct dentry *dentry)
142 {
143         struct autofs_info *inf = autofs4_dentry_ino(dentry);
144
145         if (dentry->d_flags & DCACHE_AUTOFS_PENDING)
146                 return 1;
147
148         if (inf->flags & AUTOFS_INF_EXPIRING)
149                 return 1;
150
151         return 0;
152 }
153
154 static inline void autofs4_copy_atime(struct file *src, struct file *dst)
155 {
156         dst->f_path.dentry->d_inode->i_atime =
157                 src->f_path.dentry->d_inode->i_atime;
158         return;
159 }
160
161 struct inode *autofs4_get_inode(struct super_block *, struct autofs_info *);
162 void autofs4_free_ino(struct autofs_info *);
163
164 /* Expiration */
165 int is_autofs4_dentry(struct dentry *);
166 int autofs4_expire_run(struct super_block *, struct vfsmount *,
167                         struct autofs_sb_info *,
168                         struct autofs_packet_expire __user *);
169 int autofs4_expire_multi(struct super_block *, struct vfsmount *,
170                         struct autofs_sb_info *, int __user *);
171
172 /* Operations structures */
173
174 extern const struct inode_operations autofs4_symlink_inode_operations;
175 extern const struct inode_operations autofs4_dir_inode_operations;
176 extern const struct inode_operations autofs4_root_inode_operations;
177 extern const struct inode_operations autofs4_indirect_root_inode_operations;
178 extern const struct inode_operations autofs4_direct_root_inode_operations;
179 extern const struct file_operations autofs4_dir_operations;
180 extern const struct file_operations autofs4_root_operations;
181
182 /* Initializing function */
183
184 int autofs4_fill_super(struct super_block *, void *, int);
185 struct autofs_info *autofs4_init_ino(struct autofs_info *, struct autofs_sb_info *sbi, mode_t mode);
186
187 /* Queue management functions */
188
189 int autofs4_wait(struct autofs_sb_info *,struct dentry *, enum autofs_notify);
190 int autofs4_wait_release(struct autofs_sb_info *,autofs_wqt_t,int);
191 void autofs4_catatonic_mode(struct autofs_sb_info *);
192
193 static inline int autofs4_follow_mount(struct vfsmount **mnt, struct dentry **dentry)
194 {
195         int res = 0;
196
197         while (d_mountpoint(*dentry)) {
198                 int followed = follow_down(mnt, dentry);
199                 if (!followed)
200                         break;
201                 res = 1;
202         }
203         return res;
204 }
205
206 static inline u32 autofs4_get_dev(struct autofs_sb_info *sbi)
207 {
208         return new_encode_dev(sbi->sb->s_dev);
209 }
210
211 static inline u64 autofs4_get_ino(struct autofs_sb_info *sbi)
212 {
213         return sbi->sb->s_root->d_inode->i_ino;
214 }
215
216 static inline int simple_positive(struct dentry *dentry)
217 {
218         return dentry->d_inode && !d_unhashed(dentry);
219 }
220
221 static inline int __simple_empty(struct dentry *dentry)
222 {
223         struct dentry *child;
224         int ret = 0;
225
226         list_for_each_entry(child, &dentry->d_subdirs, d_u.d_child)
227                 if (simple_positive(child))
228                         goto out;
229         ret = 1;
230 out:
231         return ret;
232 }
233
234 void autofs4_dentry_release(struct dentry *);
235 extern void autofs4_kill_sb(struct super_block *);