]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blame - fs/autofs4/autofs_i.h
hfsplus: propagate umode_t
[mirror_ubuntu-jammy-kernel.git] / fs / autofs4 / autofs_i.h
CommitLineData
1da177e4
LT
1/* -*- c -*- ------------------------------------------------------------- *
2 *
3 * linux/fs/autofs/autofs_i.h
4 *
5 * Copyright 1997-1998 Transmeta Corporation - All Rights Reserved
34ca959c 6 * Copyright 2005-2006 Ian Kent <raven@themaw.net>
1da177e4
LT
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>
8d7b48e0 17#include <linux/auto_dev-ioctl.h>
1d5599e3 18#include <linux/mutex.h>
b5c84bf6 19#include <linux/spinlock.h>
1da177e4
LT
20#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
8d7b48e0
IK
26#define AUTOFS_DEV_IOCTL_IOC_FIRST (AUTOFS_DEV_IOCTL_VERSION)
27#define AUTOFS_DEV_IOCTL_IOC_COUNT (AUTOFS_IOC_COUNT - 11)
28
1da177e4
LT
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>
39
40/* #define DEBUG */
41
c3ad9962
LT
42#define DPRINTK(fmt, ...) \
43 pr_debug("pid %d: %s: " fmt "\n", \
44 current->pid, __func__, ##__VA_ARGS__)
1da177e4 45
c3ad9962 46#define AUTOFS_WARN(fmt, ...) \
8d7b48e0 47 printk(KERN_WARNING "pid %d: %s: " fmt "\n", \
c3ad9962 48 current->pid, __func__, ##__VA_ARGS__)
8d7b48e0 49
c3ad9962 50#define AUTOFS_ERROR(fmt, ...) \
8d7b48e0 51 printk(KERN_ERR "pid %d: %s: " fmt "\n", \
c3ad9962 52 current->pid, __func__, ##__VA_ARGS__)
8d7b48e0 53
1da177e4
LT
54/* 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
6e60a9ab
IK
66 struct completion expire_complete;
67
25767378 68 struct list_head active;
4f8427d1
IK
69 int active_count;
70
5f6f4f28 71 struct list_head expiring;
f50b6f86 72
1da177e4
LT
73 struct autofs_sb_info *sbi;
74 unsigned long last_used;
1aff3c8b 75 atomic_t count;
1da177e4 76
c0f54d3e
IK
77 uid_t uid;
78 gid_t gid;
1da177e4
LT
79};
80
81#define AUTOFS_INF_EXPIRING (1<<0) /* dentry is in the process of expiring */
aa952eb2 82#define AUTOFS_INF_PENDING (1<<2) /* dentry pending mount */
1da177e4
LT
83
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 */
70b52a0a 89 struct qstr name;
5c0a32fc
IK
90 u32 dev;
91 u64 ino;
92 uid_t uid;
93 gid_t gid;
94 pid_t pid;
95 pid_t tgid;
1da177e4
LT
96 /* This is for status reporting upon return */
97 int status;
296f7bf7 98 unsigned int wait_ctr;
1da177e4
LT
99};
100
101#define AUTOFS_SBI_MAGIC 0x6d4a556d
102
103struct autofs_sb_info {
104 u32 magic;
d7c4a5f1 105 int pipefd;
1da177e4
LT
106 struct file *pipe;
107 pid_t oz_pgrp;
108 int catatonic;
109 int version;
110 int sub_version;
d7c4a5f1
IK
111 int min_proto;
112 int max_proto;
1da177e4 113 unsigned long exp_timeout;
34ca959c 114 unsigned int type;
1da177e4
LT
115 int reghost_enabled;
116 int needs_reghost;
117 struct super_block *sb;
1d5599e3 118 struct mutex wq_mutex;
3a9720ce 119 spinlock_t fs_lock;
1da177e4 120 struct autofs_wait_queue *queues; /* Wait queue pointer */
5f6f4f28 121 spinlock_t lookup_lock;
25767378 122 struct list_head active_list;
5f6f4f28 123 struct list_head expiring_list;
1da177e4
LT
124};
125
126static inline struct autofs_sb_info *autofs4_sbi(struct super_block *sb)
127{
128 return (struct autofs_sb_info *)(sb->s_fs_info);
129}
130
131static inline struct autofs_info *autofs4_dentry_ino(struct dentry *dentry)
132{
133 return (struct autofs_info *)(dentry->d_fsdata);
134}
135
136/* autofs4_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
140static inline int autofs4_oz_mode(struct autofs_sb_info *sbi) {
a47afb0f 141 return sbi->catatonic || task_pgrp_nr(current) == sbi->oz_pgrp;
1da177e4
LT
142}
143
144/* Does a dentry have some pending activity? */
145static inline int autofs4_ispending(struct dentry *dentry)
146{
147 struct autofs_info *inf = autofs4_dentry_ino(dentry);
148
aa952eb2 149 if (inf->flags & AUTOFS_INF_PENDING)
3a9720ce
IK
150 return 1;
151
97e7449a
IK
152 if (inf->flags & AUTOFS_INF_EXPIRING)
153 return 1;
3a9720ce 154
97e7449a 155 return 0;
1da177e4
LT
156}
157
726a5e06 158struct inode *autofs4_get_inode(struct super_block *, mode_t);
1da177e4
LT
159void autofs4_free_ino(struct autofs_info *);
160
161/* Expiration */
162int is_autofs4_dentry(struct dentry *);
06a35985 163int autofs4_expire_wait(struct dentry *dentry);
1da177e4
LT
164int autofs4_expire_run(struct super_block *, struct vfsmount *,
165 struct autofs_sb_info *,
166 struct autofs_packet_expire __user *);
56fcef75
IK
167int autofs4_do_expire_multi(struct super_block *sb, struct vfsmount *mnt,
168 struct autofs_sb_info *sbi, int when);
1da177e4
LT
169int autofs4_expire_multi(struct super_block *, struct vfsmount *,
170 struct autofs_sb_info *, int __user *);
8d7b48e0
IK
171struct dentry *autofs4_expire_direct(struct super_block *sb,
172 struct vfsmount *mnt,
173 struct autofs_sb_info *sbi, int how);
174struct dentry *autofs4_expire_indirect(struct super_block *sb,
175 struct vfsmount *mnt,
176 struct autofs_sb_info *sbi, int how);
177
178/* Device node initialization */
179
180int autofs_dev_ioctl_init(void);
181void autofs_dev_ioctl_exit(void);
1da177e4
LT
182
183/* Operations structures */
184
754661f1
AV
185extern const struct inode_operations autofs4_symlink_inode_operations;
186extern const struct inode_operations autofs4_dir_inode_operations;
4b6f5d20
AV
187extern const struct file_operations autofs4_dir_operations;
188extern const struct file_operations autofs4_root_operations;
71e469db 189extern const struct dentry_operations autofs4_dentry_operations;
10584211
IK
190
191/* VFS automount flags management functions */
192
193static inline void __managed_dentry_set_automount(struct dentry *dentry)
194{
195 dentry->d_flags |= DCACHE_NEED_AUTOMOUNT;
196}
197
198static inline void managed_dentry_set_automount(struct dentry *dentry)
199{
200 spin_lock(&dentry->d_lock);
201 __managed_dentry_set_automount(dentry);
202 spin_unlock(&dentry->d_lock);
203}
204
205static inline void __managed_dentry_clear_automount(struct dentry *dentry)
206{
207 dentry->d_flags &= ~DCACHE_NEED_AUTOMOUNT;
208}
209
210static inline void managed_dentry_clear_automount(struct dentry *dentry)
211{
212 spin_lock(&dentry->d_lock);
213 __managed_dentry_clear_automount(dentry);
214 spin_unlock(&dentry->d_lock);
215}
216
b5b80177
IK
217static inline void __managed_dentry_set_transit(struct dentry *dentry)
218{
219 dentry->d_flags |= DCACHE_MANAGE_TRANSIT;
220}
221
222static inline void managed_dentry_set_transit(struct dentry *dentry)
223{
224 spin_lock(&dentry->d_lock);
225 __managed_dentry_set_transit(dentry);
226 spin_unlock(&dentry->d_lock);
227}
228
229static inline void __managed_dentry_clear_transit(struct dentry *dentry)
230{
231 dentry->d_flags &= ~DCACHE_MANAGE_TRANSIT;
232}
233
234static inline void managed_dentry_clear_transit(struct dentry *dentry)
235{
236 spin_lock(&dentry->d_lock);
237 __managed_dentry_clear_transit(dentry);
238 spin_unlock(&dentry->d_lock);
239}
240
241static inline void __managed_dentry_set_managed(struct dentry *dentry)
242{
243 dentry->d_flags |= (DCACHE_NEED_AUTOMOUNT|DCACHE_MANAGE_TRANSIT);
244}
245
246static inline void managed_dentry_set_managed(struct dentry *dentry)
247{
248 spin_lock(&dentry->d_lock);
249 __managed_dentry_set_managed(dentry);
250 spin_unlock(&dentry->d_lock);
251}
252
253static inline void __managed_dentry_clear_managed(struct dentry *dentry)
254{
255 dentry->d_flags &= ~(DCACHE_NEED_AUTOMOUNT|DCACHE_MANAGE_TRANSIT);
256}
257
258static inline void managed_dentry_clear_managed(struct dentry *dentry)
259{
260 spin_lock(&dentry->d_lock);
261 __managed_dentry_clear_managed(dentry);
262 spin_unlock(&dentry->d_lock);
263}
264
1da177e4
LT
265/* Initializing function */
266
267int autofs4_fill_super(struct super_block *, void *, int);
26e6c910
AV
268struct autofs_info *autofs4_new_ino(struct autofs_sb_info *);
269void autofs4_clean_ino(struct autofs_info *);
1da177e4
LT
270
271/* Queue management functions */
272
1da177e4
LT
273int autofs4_wait(struct autofs_sb_info *,struct dentry *, enum autofs_notify);
274int autofs4_wait_release(struct autofs_sb_info *,autofs_wqt_t,int);
275void autofs4_catatonic_mode(struct autofs_sb_info *);
276
5c0a32fc
IK
277static inline u32 autofs4_get_dev(struct autofs_sb_info *sbi)
278{
279 return new_encode_dev(sbi->sb->s_dev);
280}
281
282static inline u64 autofs4_get_ino(struct autofs_sb_info *sbi)
283{
284 return sbi->sb->s_root->d_inode->i_ino;
285}
286
1da177e4
LT
287static inline int simple_positive(struct dentry *dentry)
288{
289 return dentry->d_inode && !d_unhashed(dentry);
290}
291
2fd6b7f5
NP
292static inline void __autofs4_add_expiring(struct dentry *dentry)
293{
294 struct autofs_sb_info *sbi = autofs4_sbi(dentry->d_sb);
295 struct autofs_info *ino = autofs4_dentry_ino(dentry);
296 if (ino) {
297 if (list_empty(&ino->expiring))
298 list_add(&ino->expiring, &sbi->expiring_list);
299 }
300 return;
301}
302
c4cd70b3
IK
303static inline void autofs4_add_expiring(struct dentry *dentry)
304{
305 struct autofs_sb_info *sbi = autofs4_sbi(dentry->d_sb);
306 struct autofs_info *ino = autofs4_dentry_ino(dentry);
307 if (ino) {
308 spin_lock(&sbi->lookup_lock);
309 if (list_empty(&ino->expiring))
310 list_add(&ino->expiring, &sbi->expiring_list);
311 spin_unlock(&sbi->lookup_lock);
312 }
313 return;
314}
315
316static inline void autofs4_del_expiring(struct dentry *dentry)
317{
318 struct autofs_sb_info *sbi = autofs4_sbi(dentry->d_sb);
319 struct autofs_info *ino = autofs4_dentry_ino(dentry);
320 if (ino) {
321 spin_lock(&sbi->lookup_lock);
322 if (!list_empty(&ino->expiring))
323 list_del_init(&ino->expiring);
324 spin_unlock(&sbi->lookup_lock);
325 }
326 return;
327}
328
6ce31523 329extern void autofs4_kill_sb(struct super_block *);