Merge git://git.kernel.org/pub/scm/linux/kernel/git/davem/sparc
[linux-2.6-microblaze.git] / fs / autofs / autofs_i.h
1 /*
2  *  Copyright 1997-1998 Transmeta Corporation - All Rights Reserved
3  *  Copyright 2005-2006 Ian Kent <raven@themaw.net>
4  *
5  * This file is part of the Linux kernel and is made available under
6  * the terms of the GNU General Public License, version 2, or at your
7  * option, any later version, incorporated herein by reference.
8  */
9
10 /* Internal header file for autofs */
11
12 #include <linux/auto_fs.h>
13 #include <linux/auto_dev-ioctl.h>
14
15 #include <linux/kernel.h>
16 #include <linux/slab.h>
17 #include <linux/time.h>
18 #include <linux/string.h>
19 #include <linux/wait.h>
20 #include <linux/sched.h>
21 #include <linux/sched/signal.h>
22 #include <linux/mount.h>
23 #include <linux/namei.h>
24 #include <linux/uaccess.h>
25 #include <linux/mutex.h>
26 #include <linux/spinlock.h>
27 #include <linux/list.h>
28 #include <linux/completion.h>
29 #include <linux/file.h>
30
31 /* This is the range of ioctl() numbers we claim as ours */
32 #define AUTOFS_IOC_FIRST     AUTOFS_IOC_READY
33 #define AUTOFS_IOC_COUNT     32
34
35 #define AUTOFS_DEV_IOCTL_IOC_FIRST      (AUTOFS_DEV_IOCTL_VERSION)
36 #define AUTOFS_DEV_IOCTL_IOC_COUNT \
37         (AUTOFS_DEV_IOCTL_ISMOUNTPOINT_CMD - AUTOFS_DEV_IOCTL_VERSION_CMD)
38
39 #ifdef pr_fmt
40 #undef pr_fmt
41 #endif
42 #define pr_fmt(fmt) KBUILD_MODNAME ":pid:%d:%s: " fmt, current->pid, __func__
43
44 /*
45  * Unified info structure.  This is pointed to by both the dentry and
46  * inode structures.  Each file in the filesystem has an instance of this
47  * structure.  It holds a reference to the dentry, so dentries are never
48  * flushed while the file exists.  All name lookups are dealt with at the
49  * dentry level, although the filesystem can interfere in the validation
50  * process.  Readdir is implemented by traversing the dentry lists.
51  */
52 struct autofs_info {
53         struct dentry   *dentry;
54         struct inode    *inode;
55
56         int             flags;
57
58         struct completion expire_complete;
59
60         struct list_head active;
61         int active_count;
62
63         struct list_head expiring;
64
65         struct autofs_sb_info *sbi;
66         unsigned long last_used;
67         atomic_t count;
68
69         kuid_t uid;
70         kgid_t gid;
71 };
72
73 #define AUTOFS_INF_EXPIRING     (1<<0) /* dentry in the process of expiring */
74 #define AUTOFS_INF_WANT_EXPIRE  (1<<1) /* the dentry is being considered
75                                         * for expiry, so RCU_walk is
76                                         * not permitted.  If it progresses to
77                                         * actual expiry attempt, the flag is
78                                         * not cleared when EXPIRING is set -
79                                         * in that case it gets cleared only
80                                         * when it comes to clearing EXPIRING.
81                                         */
82 #define AUTOFS_INF_PENDING      (1<<2) /* dentry pending mount */
83
84 struct autofs_wait_queue {
85         wait_queue_head_t queue;
86         struct autofs_wait_queue *next;
87         autofs_wqt_t wait_queue_token;
88         /* We use the following to see what we are waiting for */
89         struct qstr name;
90         u32 dev;
91         u64 ino;
92         kuid_t uid;
93         kgid_t gid;
94         pid_t pid;
95         pid_t tgid;
96         /* This is for status reporting upon return */
97         int status;
98         unsigned int wait_ctr;
99 };
100
101 #define AUTOFS_SBI_MAGIC 0x6d4a556d
102
103 struct autofs_sb_info {
104         u32 magic;
105         int pipefd;
106         struct file *pipe;
107         struct pid *oz_pgrp;
108         int catatonic;
109         int version;
110         int sub_version;
111         int min_proto;
112         int max_proto;
113         unsigned long exp_timeout;
114         unsigned int type;
115         struct super_block *sb;
116         struct mutex wq_mutex;
117         struct mutex pipe_mutex;
118         spinlock_t fs_lock;
119         struct autofs_wait_queue *queues; /* Wait queue pointer */
120         spinlock_t lookup_lock;
121         struct list_head active_list;
122         struct list_head expiring_list;
123         struct rcu_head rcu;
124 };
125
126 static inline struct autofs_sb_info *autofs_sbi(struct super_block *sb)
127 {
128         return (struct autofs_sb_info *)(sb->s_fs_info);
129 }
130
131 static inline struct autofs_info *autofs_dentry_ino(struct dentry *dentry)
132 {
133         return (struct autofs_info *)(dentry->d_fsdata);
134 }
135
136 /* autofs_oz_mode(): do we see the man behind the curtain?  (The
137  * processes which do manipulations for us in user space sees the raw
138  * filesystem without "magic".)
139  */
140 static inline int autofs_oz_mode(struct autofs_sb_info *sbi)
141 {
142         return sbi->catatonic || task_pgrp(current) == sbi->oz_pgrp;
143 }
144
145 struct inode *autofs_get_inode(struct super_block *, umode_t);
146 void autofs_free_ino(struct autofs_info *);
147
148 /* Expiration */
149 int is_autofs_dentry(struct dentry *);
150 int autofs_expire_wait(const struct path *path, int rcu_walk);
151 int autofs_expire_run(struct super_block *, struct vfsmount *,
152                       struct autofs_sb_info *,
153                       struct autofs_packet_expire __user *);
154 int autofs_do_expire_multi(struct super_block *sb, struct vfsmount *mnt,
155                            struct autofs_sb_info *sbi, int when);
156 int autofs_expire_multi(struct super_block *, struct vfsmount *,
157                         struct autofs_sb_info *, int __user *);
158 struct dentry *autofs_expire_direct(struct super_block *sb,
159                                     struct vfsmount *mnt,
160                                     struct autofs_sb_info *sbi, int how);
161 struct dentry *autofs_expire_indirect(struct super_block *sb,
162                                       struct vfsmount *mnt,
163                                       struct autofs_sb_info *sbi, int how);
164
165 /* Device node initialization */
166
167 int autofs_dev_ioctl_init(void);
168 void autofs_dev_ioctl_exit(void);
169
170 /* Operations structures */
171
172 extern const struct inode_operations autofs_symlink_inode_operations;
173 extern const struct inode_operations autofs_dir_inode_operations;
174 extern const struct file_operations autofs_dir_operations;
175 extern const struct file_operations autofs_root_operations;
176 extern const struct dentry_operations autofs_dentry_operations;
177
178 /* VFS automount flags management functions */
179 static inline void __managed_dentry_set_managed(struct dentry *dentry)
180 {
181         dentry->d_flags |= (DCACHE_NEED_AUTOMOUNT|DCACHE_MANAGE_TRANSIT);
182 }
183
184 static inline void managed_dentry_set_managed(struct dentry *dentry)
185 {
186         spin_lock(&dentry->d_lock);
187         __managed_dentry_set_managed(dentry);
188         spin_unlock(&dentry->d_lock);
189 }
190
191 static inline void __managed_dentry_clear_managed(struct dentry *dentry)
192 {
193         dentry->d_flags &= ~(DCACHE_NEED_AUTOMOUNT|DCACHE_MANAGE_TRANSIT);
194 }
195
196 static inline void managed_dentry_clear_managed(struct dentry *dentry)
197 {
198         spin_lock(&dentry->d_lock);
199         __managed_dentry_clear_managed(dentry);
200         spin_unlock(&dentry->d_lock);
201 }
202
203 /* Initializing function */
204
205 int autofs_fill_super(struct super_block *, void *, int);
206 struct autofs_info *autofs_new_ino(struct autofs_sb_info *);
207 void autofs_clean_ino(struct autofs_info *);
208
209 static inline int autofs_prepare_pipe(struct file *pipe)
210 {
211         if (!(pipe->f_mode & FMODE_CAN_WRITE))
212                 return -EINVAL;
213         if (!S_ISFIFO(file_inode(pipe)->i_mode))
214                 return -EINVAL;
215         /* We want a packet pipe */
216         pipe->f_flags |= O_DIRECT;
217         return 0;
218 }
219
220 /* Queue management functions */
221
222 int autofs_wait(struct autofs_sb_info *,
223                  const struct path *, enum autofs_notify);
224 int autofs_wait_release(struct autofs_sb_info *, autofs_wqt_t, int);
225 void autofs_catatonic_mode(struct autofs_sb_info *);
226
227 static inline u32 autofs_get_dev(struct autofs_sb_info *sbi)
228 {
229         return new_encode_dev(sbi->sb->s_dev);
230 }
231
232 static inline u64 autofs_get_ino(struct autofs_sb_info *sbi)
233 {
234         return d_inode(sbi->sb->s_root)->i_ino;
235 }
236
237 static inline void __autofs_add_expiring(struct dentry *dentry)
238 {
239         struct autofs_sb_info *sbi = autofs_sbi(dentry->d_sb);
240         struct autofs_info *ino = autofs_dentry_ino(dentry);
241
242         if (ino) {
243                 if (list_empty(&ino->expiring))
244                         list_add(&ino->expiring, &sbi->expiring_list);
245         }
246 }
247
248 static inline void autofs_add_expiring(struct dentry *dentry)
249 {
250         struct autofs_sb_info *sbi = autofs_sbi(dentry->d_sb);
251         struct autofs_info *ino = autofs_dentry_ino(dentry);
252
253         if (ino) {
254                 spin_lock(&sbi->lookup_lock);
255                 if (list_empty(&ino->expiring))
256                         list_add(&ino->expiring, &sbi->expiring_list);
257                 spin_unlock(&sbi->lookup_lock);
258         }
259 }
260
261 static inline void autofs_del_expiring(struct dentry *dentry)
262 {
263         struct autofs_sb_info *sbi = autofs_sbi(dentry->d_sb);
264         struct autofs_info *ino = autofs_dentry_ino(dentry);
265
266         if (ino) {
267                 spin_lock(&sbi->lookup_lock);
268                 if (!list_empty(&ino->expiring))
269                         list_del_init(&ino->expiring);
270                 spin_unlock(&sbi->lookup_lock);
271         }
272 }
273
274 void autofs_kill_sb(struct super_block *);