blob: d8d8e7ba6a1e1bf52c367a73514aeaa202b8fcea [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/* -*- c -*- ------------------------------------------------------------- *
2 *
3 * linux/fs/autofs/autofs_i.h
4 *
5 * Copyright 1997-1998 Transmeta Corporation - All Rights Reserved
Ian Kent34ca9592006-03-27 01:14:54 -08006 * Copyright 2005-2006 Ian Kent <raven@themaw.net>
Linus Torvalds1da177e2005-04-16 15:20:36 -07007 *
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>
Ian Kent8d7b48e2008-10-15 22:02:54 -070017#include <linux/auto_dev-ioctl.h>
Ingo Molnar1d5599e2006-03-23 03:00:41 -080018#include <linux/mutex.h>
Nick Pigginb5c84bf2011-01-07 17:49:38 +110019#include <linux/spinlock.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070020#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
Ian Kent8d7b48e2008-10-15 22:02:54 -070026#define AUTOFS_DEV_IOCTL_IOC_FIRST (AUTOFS_DEV_IOCTL_VERSION)
27#define AUTOFS_DEV_IOCTL_IOC_COUNT (AUTOFS_IOC_COUNT - 11)
28
Linus Torvalds1da177e2005-04-16 15:20:36 -070029#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
Linus Torvaldsc3ad9962011-08-08 11:35:17 -070042#define DPRINTK(fmt, ...) \
43 pr_debug("pid %d: %s: " fmt "\n", \
44 current->pid, __func__, ##__VA_ARGS__)
Linus Torvalds1da177e2005-04-16 15:20:36 -070045
Linus Torvaldsc3ad9962011-08-08 11:35:17 -070046#define AUTOFS_WARN(fmt, ...) \
Ian Kent8d7b48e2008-10-15 22:02:54 -070047 printk(KERN_WARNING "pid %d: %s: " fmt "\n", \
Linus Torvaldsc3ad9962011-08-08 11:35:17 -070048 current->pid, __func__, ##__VA_ARGS__)
Ian Kent8d7b48e2008-10-15 22:02:54 -070049
Linus Torvaldsc3ad9962011-08-08 11:35:17 -070050#define AUTOFS_ERROR(fmt, ...) \
Ian Kent8d7b48e2008-10-15 22:02:54 -070051 printk(KERN_ERR "pid %d: %s: " fmt "\n", \
Linus Torvaldsc3ad9962011-08-08 11:35:17 -070052 current->pid, __func__, ##__VA_ARGS__)
Ian Kent8d7b48e2008-10-15 22:02:54 -070053
Linus Torvalds1da177e2005-04-16 15:20:36 -070054/* Unified info structure. This is pointed to by both the dentry and
55 inode structures. Each file in the filesystem has an instance of this
56 structure. It holds a reference to the dentry, so dentries are never
57 flushed while the file exists. All name lookups are dealt with at the
58 dentry level, although the filesystem can interfere in the validation
59 process. Readdir is implemented by traversing the dentry lists. */
60struct autofs_info {
61 struct dentry *dentry;
62 struct inode *inode;
63
64 int flags;
65
Ian Kent6e60a9a2008-07-23 21:30:27 -070066 struct completion expire_complete;
67
Ian Kent25767372008-07-23 21:30:12 -070068 struct list_head active;
Ian Kent4f8427d2009-12-15 16:45:42 -080069 int active_count;
70
Ian Kent5f6f4f22008-07-23 21:30:09 -070071 struct list_head expiring;
Ian Kentf50b6f82007-02-20 13:58:10 -080072
Linus Torvalds1da177e2005-04-16 15:20:36 -070073 struct autofs_sb_info *sbi;
74 unsigned long last_used;
Ian Kent1aff3c82006-03-27 01:14:46 -080075 atomic_t count;
Linus Torvalds1da177e2005-04-16 15:20:36 -070076
Ian Kentc0f54d32008-10-15 22:02:52 -070077 uid_t uid;
78 gid_t gid;
Linus Torvalds1da177e2005-04-16 15:20:36 -070079};
80
81#define AUTOFS_INF_EXPIRING (1<<0) /* dentry is in the process of expiring */
Ian Kentaa952eb2009-12-15 16:45:45 -080082#define AUTOFS_INF_PENDING (1<<2) /* dentry pending mount */
Linus Torvalds1da177e2005-04-16 15:20:36 -070083
84struct 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 */
Jeff Moyer70b52a02008-07-23 21:30:16 -070089 struct qstr name;
Ian Kent5c0a32f2006-03-27 01:14:55 -080090 u32 dev;
91 u64 ino;
92 uid_t uid;
93 gid_t gid;
94 pid_t pid;
95 pid_t tgid;
Linus Torvalds1da177e2005-04-16 15:20:36 -070096 /* This is for status reporting upon return */
97 int status;
Ian Kent296f7bf2008-07-23 21:30:21 -070098 unsigned int wait_ctr;
Linus Torvalds1da177e2005-04-16 15:20:36 -070099};
100
101#define AUTOFS_SBI_MAGIC 0x6d4a556d
102
103struct autofs_sb_info {
104 u32 magic;
Ian Kentd7c4a5f2006-03-27 01:14:49 -0800105 int pipefd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106 struct file *pipe;
107 pid_t oz_pgrp;
108 int catatonic;
109 int version;
110 int sub_version;
Ian Kentd7c4a5f2006-03-27 01:14:49 -0800111 int min_proto;
112 int max_proto;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113 unsigned long exp_timeout;
Ian Kent34ca9592006-03-27 01:14:54 -0800114 unsigned int type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115 int reghost_enabled;
116 int needs_reghost;
117 struct super_block *sb;
Ingo Molnar1d5599e2006-03-23 03:00:41 -0800118 struct mutex wq_mutex;
Al Virod668dc52012-01-10 22:35:38 -0500119 struct mutex pipe_mutex;
Ian Kent3a9720c2005-05-01 08:59:17 -0700120 spinlock_t fs_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121 struct autofs_wait_queue *queues; /* Wait queue pointer */
Ian Kent5f6f4f22008-07-23 21:30:09 -0700122 spinlock_t lookup_lock;
Ian Kent25767372008-07-23 21:30:12 -0700123 struct list_head active_list;
Ian Kent5f6f4f22008-07-23 21:30:09 -0700124 struct list_head expiring_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125};
126
127static inline struct autofs_sb_info *autofs4_sbi(struct super_block *sb)
128{
129 return (struct autofs_sb_info *)(sb->s_fs_info);
130}
131
132static inline struct autofs_info *autofs4_dentry_ino(struct dentry *dentry)
133{
134 return (struct autofs_info *)(dentry->d_fsdata);
135}
136
137/* autofs4_oz_mode(): do we see the man behind the curtain? (The
138 processes which do manipulations for us in user space sees the raw
139 filesystem without "magic".) */
140
141static inline int autofs4_oz_mode(struct autofs_sb_info *sbi) {
Pavel Emelianova47afb02007-10-18 23:39:46 -0700142 return sbi->catatonic || task_pgrp_nr(current) == sbi->oz_pgrp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143}
144
145/* Does a dentry have some pending activity? */
146static inline int autofs4_ispending(struct dentry *dentry)
147{
148 struct autofs_info *inf = autofs4_dentry_ino(dentry);
149
Ian Kentaa952eb2009-12-15 16:45:45 -0800150 if (inf->flags & AUTOFS_INF_PENDING)
Ian Kent3a9720c2005-05-01 08:59:17 -0700151 return 1;
152
Ian Kent97e74492008-07-23 21:30:26 -0700153 if (inf->flags & AUTOFS_INF_EXPIRING)
154 return 1;
Ian Kent3a9720c2005-05-01 08:59:17 -0700155
Ian Kent97e74492008-07-23 21:30:26 -0700156 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157}
158
Al Viro030a8ba2011-07-26 03:29:03 -0400159struct inode *autofs4_get_inode(struct super_block *, umode_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160void autofs4_free_ino(struct autofs_info *);
161
162/* Expiration */
163int is_autofs4_dentry(struct dentry *);
Ian Kent06a35982008-07-23 21:30:28 -0700164int autofs4_expire_wait(struct dentry *dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165int autofs4_expire_run(struct super_block *, struct vfsmount *,
166 struct autofs_sb_info *,
167 struct autofs_packet_expire __user *);
Ian Kent56fcef72009-03-31 15:24:43 -0700168int autofs4_do_expire_multi(struct super_block *sb, struct vfsmount *mnt,
169 struct autofs_sb_info *sbi, int when);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170int autofs4_expire_multi(struct super_block *, struct vfsmount *,
171 struct autofs_sb_info *, int __user *);
Ian Kent8d7b48e2008-10-15 22:02:54 -0700172struct dentry *autofs4_expire_direct(struct super_block *sb,
173 struct vfsmount *mnt,
174 struct autofs_sb_info *sbi, int how);
175struct dentry *autofs4_expire_indirect(struct super_block *sb,
176 struct vfsmount *mnt,
177 struct autofs_sb_info *sbi, int how);
178
179/* Device node initialization */
180
181int autofs_dev_ioctl_init(void);
182void autofs_dev_ioctl_exit(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183
184/* Operations structures */
185
Arjan van de Ven754661f2007-02-12 00:55:38 -0800186extern const struct inode_operations autofs4_symlink_inode_operations;
187extern const struct inode_operations autofs4_dir_inode_operations;
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -0800188extern const struct file_operations autofs4_dir_operations;
189extern const struct file_operations autofs4_root_operations;
Ian Kent71e469d2011-01-14 18:46:19 +0000190extern const struct dentry_operations autofs4_dentry_operations;
Ian Kent10584212011-01-14 18:45:58 +0000191
192/* VFS automount flags management functions */
193
194static inline void __managed_dentry_set_automount(struct dentry *dentry)
195{
196 dentry->d_flags |= DCACHE_NEED_AUTOMOUNT;
197}
198
199static inline void managed_dentry_set_automount(struct dentry *dentry)
200{
201 spin_lock(&dentry->d_lock);
202 __managed_dentry_set_automount(dentry);
203 spin_unlock(&dentry->d_lock);
204}
205
206static inline void __managed_dentry_clear_automount(struct dentry *dentry)
207{
208 dentry->d_flags &= ~DCACHE_NEED_AUTOMOUNT;
209}
210
211static inline void managed_dentry_clear_automount(struct dentry *dentry)
212{
213 spin_lock(&dentry->d_lock);
214 __managed_dentry_clear_automount(dentry);
215 spin_unlock(&dentry->d_lock);
216}
217
Ian Kentb5b80172011-01-14 18:46:03 +0000218static inline void __managed_dentry_set_transit(struct dentry *dentry)
219{
220 dentry->d_flags |= DCACHE_MANAGE_TRANSIT;
221}
222
223static inline void managed_dentry_set_transit(struct dentry *dentry)
224{
225 spin_lock(&dentry->d_lock);
226 __managed_dentry_set_transit(dentry);
227 spin_unlock(&dentry->d_lock);
228}
229
230static inline void __managed_dentry_clear_transit(struct dentry *dentry)
231{
232 dentry->d_flags &= ~DCACHE_MANAGE_TRANSIT;
233}
234
235static inline void managed_dentry_clear_transit(struct dentry *dentry)
236{
237 spin_lock(&dentry->d_lock);
238 __managed_dentry_clear_transit(dentry);
239 spin_unlock(&dentry->d_lock);
240}
241
242static inline void __managed_dentry_set_managed(struct dentry *dentry)
243{
244 dentry->d_flags |= (DCACHE_NEED_AUTOMOUNT|DCACHE_MANAGE_TRANSIT);
245}
246
247static inline void managed_dentry_set_managed(struct dentry *dentry)
248{
249 spin_lock(&dentry->d_lock);
250 __managed_dentry_set_managed(dentry);
251 spin_unlock(&dentry->d_lock);
252}
253
254static inline void __managed_dentry_clear_managed(struct dentry *dentry)
255{
256 dentry->d_flags &= ~(DCACHE_NEED_AUTOMOUNT|DCACHE_MANAGE_TRANSIT);
257}
258
259static inline void managed_dentry_clear_managed(struct dentry *dentry)
260{
261 spin_lock(&dentry->d_lock);
262 __managed_dentry_clear_managed(dentry);
263 spin_unlock(&dentry->d_lock);
264}
265
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266/* Initializing function */
267
268int autofs4_fill_super(struct super_block *, void *, int);
Al Viro26e6c912011-01-16 18:43:40 -0500269struct autofs_info *autofs4_new_ino(struct autofs_sb_info *);
270void autofs4_clean_ino(struct autofs_info *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700271
272/* Queue management functions */
273
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274int autofs4_wait(struct autofs_sb_info *,struct dentry *, enum autofs_notify);
275int autofs4_wait_release(struct autofs_sb_info *,autofs_wqt_t,int);
276void autofs4_catatonic_mode(struct autofs_sb_info *);
277
Ian Kent5c0a32f2006-03-27 01:14:55 -0800278static inline u32 autofs4_get_dev(struct autofs_sb_info *sbi)
279{
280 return new_encode_dev(sbi->sb->s_dev);
281}
282
283static inline u64 autofs4_get_ino(struct autofs_sb_info *sbi)
284{
285 return sbi->sb->s_root->d_inode->i_ino;
286}
287
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288static inline int simple_positive(struct dentry *dentry)
289{
290 return dentry->d_inode && !d_unhashed(dentry);
291}
292
Nick Piggin2fd6b7f2011-01-07 17:49:34 +1100293static inline void __autofs4_add_expiring(struct dentry *dentry)
294{
295 struct autofs_sb_info *sbi = autofs4_sbi(dentry->d_sb);
296 struct autofs_info *ino = autofs4_dentry_ino(dentry);
297 if (ino) {
298 if (list_empty(&ino->expiring))
299 list_add(&ino->expiring, &sbi->expiring_list);
300 }
301 return;
302}
303
Ian Kentc4cd70b2009-12-15 16:45:43 -0800304static inline void autofs4_add_expiring(struct dentry *dentry)
305{
306 struct autofs_sb_info *sbi = autofs4_sbi(dentry->d_sb);
307 struct autofs_info *ino = autofs4_dentry_ino(dentry);
308 if (ino) {
309 spin_lock(&sbi->lookup_lock);
310 if (list_empty(&ino->expiring))
311 list_add(&ino->expiring, &sbi->expiring_list);
312 spin_unlock(&sbi->lookup_lock);
313 }
314 return;
315}
316
317static inline void autofs4_del_expiring(struct dentry *dentry)
318{
319 struct autofs_sb_info *sbi = autofs4_sbi(dentry->d_sb);
320 struct autofs_info *ino = autofs4_dentry_ino(dentry);
321 if (ino) {
322 spin_lock(&sbi->lookup_lock);
323 if (!list_empty(&ino->expiring))
324 list_del_init(&ino->expiring);
325 spin_unlock(&sbi->lookup_lock);
326 }
327 return;
328}
329
David Howells6ce31522006-10-11 01:22:15 -0700330extern void autofs4_kill_sb(struct super_block *);