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         mode_t  mode;
  93         size_t  size;
  94 };
  95
  96 #define AUTOFS_INF_EXPIRING     (1<<0) /* dentry is in the process of expiring */
  97 #define AUTOFS_INF_PENDING      (1<<2) /* dentry pending mount */
  98
  99 struct autofs_wait_queue {
 100         wait_queue_head_t queue;
 101         struct autofs_wait_queue *next;
 102         autofs_wqt_t wait_queue_token;
 103         /* We use the following to see what we are waiting for */
 104         struct qstr name;
 105         u32 dev;
 106         u64 ino;
 107         uid_t uid;
 108         gid_t gid;
 109         pid_t pid;
 110         pid_t tgid;
 111         /* This is for status reporting upon return */
 112         int status;
 113         unsigned int wait_ctr;
 114 };
 115
 116 #define AUTOFS_SBI_MAGIC 0x6d4a556d
 117
 118 struct autofs_sb_info {
 119         u32 magic;
 120         int pipefd;
 121         struct file *pipe;
 122         pid_t oz_pgrp;
 123         int catatonic;
 124         int version;
 125         int sub_version;
 126         int min_proto;
 127         int max_proto;
 128         unsigned long exp_timeout;
 129         unsigned int type;
 130         int reghost_enabled;
 131         int needs_reghost;
 132         struct super_block *sb;
 133         struct mutex wq_mutex;
 134         spinlock_t fs_lock;
 135         struct autofs_wait_queue *queues; /* Wait queue pointer */
 136         spinlock_t lookup_lock;
 137         struct list_head active_list;
 138         struct list_head expiring_list;
 139 };
 140
 141 static inline struct autofs_sb_info *autofs4_sbi(struct super_block *sb)
 142 {
 143         return (struct autofs_sb_info *)(sb->s_fs_info);
 144 }
 145
 146 static inline struct autofs_info *autofs4_dentry_ino(struct dentry *dentry)
 147 {
 148         return (struct autofs_info *)(dentry->d_fsdata);
 149 }
 150
 151 /* autofs4_oz_mode(): do we see the man behind the curtain?  (The
 152    processes which do manipulations for us in user space sees the raw
 153    filesystem without "magic".) */
 154
 155 static inline int autofs4_oz_mode(struct autofs_sb_info *sbi) {
 156         return sbi->catatonic || task_pgrp_nr(current) == sbi->oz_pgrp;
 157 }
 158
 159 /* Does a dentry have some pending activity? */
 160 static inline int autofs4_ispending(struct dentry *dentry)
 161 {
 162         struct autofs_info *inf = autofs4_dentry_ino(dentry);
 163
 164         if (inf->flags & AUTOFS_INF_PENDING)
 165                 return 1;
 166
 167         if (inf->flags & AUTOFS_INF_EXPIRING)
 168                 return 1;
 169
 170         return 0;
 171 }
 172
 173 struct inode *autofs4_get_inode(struct super_block *, struct autofs_info *);
 174 void autofs4_free_ino(struct autofs_info *);
 175
 176 /* Expiration */
 177 int is_autofs4_dentry(struct dentry *);
 178 int autofs4_expire_wait(struct dentry *dentry);
 179 int autofs4_expire_run(struct super_block *, struct vfsmount *,
 180                         struct autofs_sb_info *,
 181                         struct autofs_packet_expire __user *);
 182 int autofs4_do_expire_multi(struct super_block *sb, struct vfsmount *mnt,
 183                             struct autofs_sb_info *sbi, int when);
 184 int autofs4_expire_multi(struct super_block *, struct vfsmount *,
 185                         struct autofs_sb_info *, int __user *);
 186 struct dentry *autofs4_expire_direct(struct super_block *sb,
 187                                      struct vfsmount *mnt,
 188                                      struct autofs_sb_info *sbi, int how);
 189 struct dentry *autofs4_expire_indirect(struct super_block *sb,
 190                                        struct vfsmount *mnt,
 191                                        struct autofs_sb_info *sbi, int how);
 192
 193 /* Device node initialization */
 194
 195 int autofs_dev_ioctl_init(void);
 196 void autofs_dev_ioctl_exit(void);
 197
 198 /* Operations structures */
 199
 200 extern const struct inode_operations autofs4_symlink_inode_operations;
 201 extern const struct inode_operations autofs4_dir_inode_operations;
 202 extern const struct file_operations autofs4_dir_operations;
 203 extern const struct file_operations autofs4_root_operations;
 204 extern const struct dentry_operations autofs4_dentry_operations;
 205
 206 /* VFS automount flags management functions */
 207
 208 static inline void __managed_dentry_set_automount(struct dentry *dentry)
 209 {
 210         dentry->d_flags |= DCACHE_NEED_AUTOMOUNT;
 211 }
 212
 213 static inline void managed_dentry_set_automount(struct dentry *dentry)
 214 {
 215         spin_lock(&dentry->d_lock);
 216         __managed_dentry_set_automount(dentry);
 217         spin_unlock(&dentry->d_lock);
 218 }
 219
 220 static inline void __managed_dentry_clear_automount(struct dentry *dentry)
 221 {
 222         dentry->d_flags &= ~DCACHE_NEED_AUTOMOUNT;
 223 }
 224
 225 static inline void managed_dentry_clear_automount(struct dentry *dentry)
 226 {
 227         spin_lock(&dentry->d_lock);
 228         __managed_dentry_clear_automount(dentry);
 229         spin_unlock(&dentry->d_lock);
 230 }
 231
 232 static inline void __managed_dentry_set_transit(struct dentry *dentry)
 233 {
 234         dentry->d_flags |= DCACHE_MANAGE_TRANSIT;
 235 }
 236
 237 static inline void managed_dentry_set_transit(struct dentry *dentry)
 238 {
 239         spin_lock(&dentry->d_lock);
 240         __managed_dentry_set_transit(dentry);
 241         spin_unlock(&dentry->d_lock);
 242 }
 243
 244 static inline void __managed_dentry_clear_transit(struct dentry *dentry)
 245 {
 246         dentry->d_flags &= ~DCACHE_MANAGE_TRANSIT;
 247 }
 248
 249 static inline void managed_dentry_clear_transit(struct dentry *dentry)
 250 {
 251         spin_lock(&dentry->d_lock);
 252         __managed_dentry_clear_transit(dentry);
 253         spin_unlock(&dentry->d_lock);
 254 }
 255
 256 static inline void __managed_dentry_set_managed(struct dentry *dentry)
 257 {
 258         dentry->d_flags |= (DCACHE_NEED_AUTOMOUNT|DCACHE_MANAGE_TRANSIT);
 259 }
 260
 261 static inline void managed_dentry_set_managed(struct dentry *dentry)
 262 {
 263         spin_lock(&dentry->d_lock);
 264         __managed_dentry_set_managed(dentry);
 265         spin_unlock(&dentry->d_lock);
 266 }
 267
 268 static inline void __managed_dentry_clear_managed(struct dentry *dentry)
 269 {
 270         dentry->d_flags &= ~(DCACHE_NEED_AUTOMOUNT|DCACHE_MANAGE_TRANSIT);
 271 }
 272
 273 static inline void managed_dentry_clear_managed(struct dentry *dentry)
 274 {
 275         spin_lock(&dentry->d_lock);
 276         __managed_dentry_clear_managed(dentry);
 277         spin_unlock(&dentry->d_lock);
 278 }
 279
 280 /* Initializing function */
 281
 282 int autofs4_fill_super(struct super_block *, void *, int);
 283 struct autofs_info *autofs4_init_ino(struct autofs_info *, struct autofs_sb_info *sbi, mode_t mode);
 284
 285 /* Queue management functions */
 286
 287 int autofs4_wait(struct autofs_sb_info *,struct dentry *, enum autofs_notify);
 288 int autofs4_wait_release(struct autofs_sb_info *,autofs_wqt_t,int);
 289 void autofs4_catatonic_mode(struct autofs_sb_info *);
 290
 291 static inline u32 autofs4_get_dev(struct autofs_sb_info *sbi)
 292 {
 293         return new_encode_dev(sbi->sb->s_dev);
 294 }
 295
 296 static inline u64 autofs4_get_ino(struct autofs_sb_info *sbi)
 297 {
 298         return sbi->sb->s_root->d_inode->i_ino;
 299 }
 300
 301 static inline int simple_positive(struct dentry *dentry)
 302 {
 303         return dentry->d_inode && !d_unhashed(dentry);
 304 }
 305
 306 static inline void __autofs4_add_expiring(struct dentry *dentry)
 307 {
 308         struct autofs_sb_info *sbi = autofs4_sbi(dentry->d_sb);
 309         struct autofs_info *ino = autofs4_dentry_ino(dentry);
 310         if (ino) {
 311                 if (list_empty(&ino->expiring))
 312                         list_add(&ino->expiring, &sbi->expiring_list);
 313         }
 314         return;
 315 }
 316
 317 static inline void autofs4_add_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_add(&ino->expiring, &sbi->expiring_list);
 325                 spin_unlock(&sbi->lookup_lock);
 326         }
 327         return;
 328 }
 329
 330 static inline void autofs4_del_expiring(struct dentry *dentry)
 331 {
 332         struct autofs_sb_info *sbi = autofs4_sbi(dentry->d_sb);
 333         struct autofs_info *ino = autofs4_dentry_ino(dentry);
 334         if (ino) {
 335                 spin_lock(&sbi->lookup_lock);
 336                 if (!list_empty(&ino->expiring))
 337                         list_del_init(&ino->expiring);
 338                 spin_unlock(&sbi->lookup_lock);
 339         }
 340         return;
 341 }
 342
 343 void autofs4_dentry_release(struct dentry *);
 344 extern void autofs4_kill_sb(struct super_block *);