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/auto_dev-ioctl.h>
  18 #include <linux/mutex.h>
  19 #include <linux/spinlock.h>
  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
  26 #define AUTOFS_DEV_IOCTL_IOC_FIRST      (AUTOFS_DEV_IOCTL_VERSION)
  27 #define AUTOFS_DEV_IOCTL_IOC_COUNT      (AUTOFS_IOC_COUNT - 11)
  28
  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
  42 #ifdef DEBUG
  43 #define DPRINTK(fmt, args...)                           \
  44 do {                                                    \
  45         printk(KERN_DEBUG "pid %d: %s: " fmt "\n",      \
  46                 current->pid, __func__, ##args);        \
  47 } while (0)
  48 #else
  49 #define DPRINTK(fmt, args...) do {} while (0)
  50 #endif
  51
  52 #define AUTOFS_WARN(fmt, args...)                       \
  53 do {                                                    \
  54         printk(KERN_WARNING "pid %d: %s: " fmt "\n",    \
  55                 current->pid, __func__, ##args);        \
  56 } while (0)
  57
  58 #define AUTOFS_ERROR(fmt, args...)                      \
  59 do {                                                    \
  60         printk(KERN_ERR "pid %d: %s: " fmt "\n",        \
  61                 current->pid, __func__, ##args);        \
  62 } while (0)
  63
  64 extern spinlock_t autofs4_lock;
  65
  66 /* Unified info structure.  This is pointed to by both the dentry and
  67    inode structures.  Each file in the filesystem has an instance of this
  68    structure.  It holds a reference to the dentry, so dentries are never
  69    flushed while the file exists.  All name lookups are dealt with at the
  70    dentry level, although the filesystem can interfere in the validation
  71    process.  Readdir is implemented by traversing the dentry lists. */
  72 struct autofs_info {
  73         struct dentry   *dentry;
  74         struct inode    *inode;
  75
  76         int             flags;
  77
  78         struct completion expire_complete;
  79
  80         struct list_head active;
  81         int active_count;
  82
  83         struct list_head expiring;
  84
  85         struct autofs_sb_info *sbi;
  86         unsigned long last_used;
  87         atomic_t count;
  88
  89         uid_t uid;
  90         gid_t gid;
  91
  92         size_t  size;
  93 };
  94
  95 #define AUTOFS_INF_EXPIRING     (1<<0) /* dentry is in the process of expiring */
  96 #define AUTOFS_INF_PENDING      (1<<2) /* dentry pending mount */
  97
  98 struct autofs_wait_queue {
  99         wait_queue_head_t queue;
 100         struct autofs_wait_queue *next;
 101         autofs_wqt_t wait_queue_token;
 102         /* We use the following to see what we are waiting for */
 103         struct qstr name;
 104         u32 dev;
 105         u64 ino;
 106         uid_t uid;
 107         gid_t gid;
 108         pid_t pid;
 109         pid_t tgid;
 110         /* This is for status reporting upon return */
 111         int status;
 112         unsigned int wait_ctr;
 113 };
 114
 115 #define AUTOFS_SBI_MAGIC 0x6d4a556d
 116
 117 struct autofs_sb_info {
 118         u32 magic;
 119         int pipefd;
 120         struct file *pipe;
 121         pid_t oz_pgrp;
 122         int catatonic;
 123         int version;
 124         int sub_version;
 125         int min_proto;
 126         int max_proto;
 127         unsigned long exp_timeout;
 128         unsigned int type;
 129         int reghost_enabled;
 130         int needs_reghost;
 131         struct super_block *sb;
 132         struct mutex wq_mutex;
 133         spinlock_t fs_lock;
 134         struct autofs_wait_queue *queues; /* Wait queue pointer */
 135         spinlock_t lookup_lock;
 136         struct list_head active_list;
 137         struct list_head expiring_list;
 138 };
 139
 140 static inline struct autofs_sb_info *autofs4_sbi(struct super_block *sb)
 141 {
 142         return (struct autofs_sb_info *)(sb->s_fs_info);
 143 }
 144
 145 static inline struct autofs_info *autofs4_dentry_ino(struct dentry *dentry)
 146 {
 147         return (struct autofs_info *)(dentry->d_fsdata);
 148 }
 149
 150 /* autofs4_oz_mode(): do we see the man behind the curtain?  (The
 151    processes which do manipulations for us in user space sees the raw
 152    filesystem without "magic".) */
 153
 154 static inline int autofs4_oz_mode(struct autofs_sb_info *sbi) {
 155         return sbi->catatonic || task_pgrp_nr(current) == sbi->oz_pgrp;
 156 }
 157
 158 /* Does a dentry have some pending activity? */
 159 static inline int autofs4_ispending(struct dentry *dentry)
 160 {
 161         struct autofs_info *inf = autofs4_dentry_ino(dentry);
 162
 163         if (inf->flags & AUTOFS_INF_PENDING)
 164                 return 1;
 165
 166         if (inf->flags & AUTOFS_INF_EXPIRING)
 167                 return 1;
 168
 169         return 0;
 170 }
 171
 172 struct inode *autofs4_get_inode(struct super_block *, struct autofs_info *, mode_t);
 173 void autofs4_free_ino(struct autofs_info *);
 174
 175 /* Expiration */
 176 int is_autofs4_dentry(struct dentry *);
 177 int autofs4_expire_wait(struct dentry *dentry);
 178 int autofs4_expire_run(struct super_block *, struct vfsmount *,
 179                         struct autofs_sb_info *,
 180                         struct autofs_packet_expire __user *);
 181 int autofs4_do_expire_multi(struct super_block *sb, struct vfsmount *mnt,
 182                             struct autofs_sb_info *sbi, int when);
 183 int autofs4_expire_multi(struct super_block *, struct vfsmount *,
 184                         struct autofs_sb_info *, int __user *);
 185 struct dentry *autofs4_expire_direct(struct super_block *sb,
 186                                      struct vfsmount *mnt,
 187                                      struct autofs_sb_info *sbi, int how);
 188 struct dentry *autofs4_expire_indirect(struct super_block *sb,
 189                                        struct vfsmount *mnt,
 190                                        struct autofs_sb_info *sbi, int how);
 191
 192 /* Device node initialization */
 193
 194 int autofs_dev_ioctl_init(void);
 195 void autofs_dev_ioctl_exit(void);
 196
 197 /* Operations structures */
 198
 199 extern const struct inode_operations autofs4_symlink_inode_operations;
 200 extern const struct inode_operations autofs4_dir_inode_operations;
 201 extern const struct file_operations autofs4_dir_operations;
 202 extern const struct file_operations autofs4_root_operations;
 203 extern const struct dentry_operations autofs4_dentry_operations;
 204
 205 /* VFS automount flags management functions */
 206
 207 static inline void __managed_dentry_set_automount(struct dentry *dentry)
 208 {
 209         dentry->d_flags |= DCACHE_NEED_AUTOMOUNT;
 210 }
 211
 212 static inline void managed_dentry_set_automount(struct dentry *dentry)
 213 {
 214         spin_lock(&dentry->d_lock);
 215         __managed_dentry_set_automount(dentry);
 216         spin_unlock(&dentry->d_lock);
 217 }
 218
 219 static inline void __managed_dentry_clear_automount(struct dentry *dentry)
 220 {
 221         dentry->d_flags &= ~DCACHE_NEED_AUTOMOUNT;
 222 }
 223
 224 static inline void managed_dentry_clear_automount(struct dentry *dentry)
 225 {
 226         spin_lock(&dentry->d_lock);
 227         __managed_dentry_clear_automount(dentry);
 228         spin_unlock(&dentry->d_lock);
 229 }
 230
 231 static inline void __managed_dentry_set_transit(struct dentry *dentry)
 232 {
 233         dentry->d_flags |= DCACHE_MANAGE_TRANSIT;
 234 }
 235
 236 static inline void managed_dentry_set_transit(struct dentry *dentry)
 237 {
 238         spin_lock(&dentry->d_lock);
 239         __managed_dentry_set_transit(dentry);
 240         spin_unlock(&dentry->d_lock);
 241 }
 242
 243 static inline void __managed_dentry_clear_transit(struct dentry *dentry)
 244 {
 245         dentry->d_flags &= ~DCACHE_MANAGE_TRANSIT;
 246 }
 247
 248 static inline void managed_dentry_clear_transit(struct dentry *dentry)
 249 {
 250         spin_lock(&dentry->d_lock);
 251         __managed_dentry_clear_transit(dentry);
 252         spin_unlock(&dentry->d_lock);
 253 }
 254
 255 static inline void __managed_dentry_set_managed(struct dentry *dentry)
 256 {
 257         dentry->d_flags |= (DCACHE_NEED_AUTOMOUNT|DCACHE_MANAGE_TRANSIT);
 258 }
 259
 260 static inline void managed_dentry_set_managed(struct dentry *dentry)
 261 {
 262         spin_lock(&dentry->d_lock);
 263         __managed_dentry_set_managed(dentry);
 264         spin_unlock(&dentry->d_lock);
 265 }
 266
 267 static inline void __managed_dentry_clear_managed(struct dentry *dentry)
 268 {
 269         dentry->d_flags &= ~(DCACHE_NEED_AUTOMOUNT|DCACHE_MANAGE_TRANSIT);
 270 }
 271
 272 static inline void managed_dentry_clear_managed(struct dentry *dentry)
 273 {
 274         spin_lock(&dentry->d_lock);
 275         __managed_dentry_clear_managed(dentry);
 276         spin_unlock(&dentry->d_lock);
 277 }
 278
 279 /* Initializing function */
 280
 281 int autofs4_fill_super(struct super_block *, void *, int);
 282 struct autofs_info *autofs4_init_ino(struct autofs_info *, struct autofs_sb_info *sbi);
 283
 284 /* Queue management functions */
 285
 286 int autofs4_wait(struct autofs_sb_info *,struct dentry *, enum autofs_notify);
 287 int autofs4_wait_release(struct autofs_sb_info *,autofs_wqt_t,int);
 288 void autofs4_catatonic_mode(struct autofs_sb_info *);
 289
 290 static inline u32 autofs4_get_dev(struct autofs_sb_info *sbi)
 291 {
 292         return new_encode_dev(sbi->sb->s_dev);
 293 }
 294
 295 static inline u64 autofs4_get_ino(struct autofs_sb_info *sbi)
 296 {
 297         return sbi->sb->s_root->d_inode->i_ino;
 298 }
 299
 300 static inline int simple_positive(struct dentry *dentry)
 301 {
 302         return dentry->d_inode && !d_unhashed(dentry);
 303 }
 304
 305 static inline void __autofs4_add_expiring(struct dentry *dentry)
 306 {
 307         struct autofs_sb_info *sbi = autofs4_sbi(dentry->d_sb);
 308         struct autofs_info *ino = autofs4_dentry_ino(dentry);
 309         if (ino) {
 310                 if (list_empty(&ino->expiring))
 311                         list_add(&ino->expiring, &sbi->expiring_list);
 312         }
 313         return;
 314 }
 315
 316 static inline void autofs4_add_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_add(&ino->expiring, &sbi->expiring_list);
 324                 spin_unlock(&sbi->lookup_lock);
 325         }
 326         return;
 327 }
 328
 329 static inline void autofs4_del_expiring(struct dentry *dentry)
 330 {
 331         struct autofs_sb_info *sbi = autofs4_sbi(dentry->d_sb);
 332         struct autofs_info *ino = autofs4_dentry_ino(dentry);
 333         if (ino) {
 334                 spin_lock(&sbi->lookup_lock);
 335                 if (!list_empty(&ino->expiring))
 336                         list_del_init(&ino->expiring);
 337                 spin_unlock(&sbi->lookup_lock);
 338         }
 339         return;
 340 }
 341
 342 void autofs4_dentry_release(struct dentry *);
 343 extern void autofs4_kill_sb(struct super_block *);