kernel/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 <linux/delay.h>
  38 #include <asm/current.h>
  39 #include <asm/uaccess.h>
  40
  41 /* #define DEBUG */
  42
  43 #define DPRINTK(fmt, ...)                               \
  44         pr_debug("pid %d: %s: " fmt "\n",               \
  45                 current->pid, __func__, ##__VA_ARGS__)
  46
  47 #define AUTOFS_WARN(fmt, ...)                           \
  48         printk(KERN_WARNING "pid %d: %s: " fmt "\n",    \
  49                 current->pid, __func__, ##__VA_ARGS__)
  50
  51 #define AUTOFS_ERROR(fmt, ...)                          \
  52         printk(KERN_ERR "pid %d: %s: " fmt "\n",        \
  53                 current->pid, __func__, ##__VA_ARGS__)
  54
  55 /* Unified info structure.  This is pointed to by both the dentry and
  56    inode structures.  Each file in the filesystem has an instance of this
  57    structure.  It holds a reference to the dentry, so dentries are never
  58    flushed while the file exists.  All name lookups are dealt with at the
  59    dentry level, although the filesystem can interfere in the validation
  60    process.  Readdir is implemented by traversing the dentry lists. */
  61 struct autofs_info {
  62         struct dentry   *dentry;
  63         struct inode    *inode;
  64
  65         int             flags;
  66
  67         struct completion expire_complete;
  68
  69         struct list_head active;
  70         int active_count;
  71
  72         struct list_head expiring;
  73
  74         struct autofs_sb_info *sbi;
  75         unsigned long last_used;
  76         atomic_t count;
  77
  78         kuid_t uid;
  79         kgid_t gid;
  80 };
  81
  82 #define AUTOFS_INF_EXPIRING     (1<<0) /* dentry is in the process of expiring */
  83 #define AUTOFS_INF_NO_RCU       (1<<1) /* the dentry is being considered
  84                                         * for expiry, so RCU_walk is
  85                                         * not permitted
  86                                         */
  87 #define AUTOFS_INF_PENDING      (1<<2) /* dentry pending mount */
  88
  89 struct autofs_wait_queue {
  90         wait_queue_head_t queue;
  91         struct autofs_wait_queue *next;
  92         autofs_wqt_t wait_queue_token;
  93         /* We use the following to see what we are waiting for */
  94         struct qstr name;
  95         u32 dev;
  96         u64 ino;
  97         kuid_t uid;
  98         kgid_t gid;
  99         pid_t pid;
 100         pid_t tgid;
 101         /* This is for status reporting upon return */
 102         int status;
 103         unsigned int wait_ctr;
 104 };
 105
 106 #define AUTOFS_SBI_MAGIC 0x6d4a556d
 107
 108 struct autofs_sb_info {
 109         u32 magic;
 110         int pipefd;
 111         struct file *pipe;
 112         struct pid *oz_pgrp;
 113         int catatonic;
 114         int version;
 115         int sub_version;
 116         int min_proto;
 117         int max_proto;
 118         unsigned long exp_timeout;
 119         unsigned int type;
 120         int reghost_enabled;
 121         int needs_reghost;
 122         struct super_block *sb;
 123         struct mutex wq_mutex;
 124         struct mutex pipe_mutex;
 125         spinlock_t fs_lock;
 126         struct autofs_wait_queue *queues; /* Wait queue pointer */
 127         spinlock_t lookup_lock;
 128         struct list_head active_list;
 129         struct list_head expiring_list;
 130         struct rcu_head rcu;
 131 };
 132
 133 static inline struct autofs_sb_info *autofs4_sbi(struct super_block *sb)
 134 {
 135         return (struct autofs_sb_info *)(sb->s_fs_info);
 136 }
 137
 138 static inline struct autofs_info *autofs4_dentry_ino(struct dentry *dentry)
 139 {
 140         return (struct autofs_info *)(dentry->d_fsdata);
 141 }
 142
 143 /* autofs4_oz_mode(): do we see the man behind the curtain?  (The
 144    processes which do manipulations for us in user space sees the raw
 145    filesystem without "magic".) */
 146
 147 static inline int autofs4_oz_mode(struct autofs_sb_info *sbi) {
 148         return sbi->catatonic || task_pgrp(current) == sbi->oz_pgrp;
 149 }
 150
 151 struct inode *autofs4_get_inode(struct super_block *, umode_t);
 152 void autofs4_free_ino(struct autofs_info *);
 153
 154 /* Expiration */
 155 int is_autofs4_dentry(struct dentry *);
 156 int autofs4_expire_wait(struct dentry *dentry, int rcu_walk);
 157 int autofs4_expire_run(struct super_block *, struct vfsmount *,
 158                         struct autofs_sb_info *,
 159                         struct autofs_packet_expire __user *);
 160 int autofs4_do_expire_multi(struct super_block *sb, struct vfsmount *mnt,
 161                             struct autofs_sb_info *sbi, int when);
 162 int autofs4_expire_multi(struct super_block *, struct vfsmount *,
 163                         struct autofs_sb_info *, int __user *);
 164 struct dentry *autofs4_expire_direct(struct super_block *sb,
 165                                      struct vfsmount *mnt,
 166                                      struct autofs_sb_info *sbi, int how);
 167 struct dentry *autofs4_expire_indirect(struct super_block *sb,
 168                                        struct vfsmount *mnt,
 169                                        struct autofs_sb_info *sbi, int how);
 170
 171 /* Device node initialization */
 172
 173 int autofs_dev_ioctl_init(void);
 174 void autofs_dev_ioctl_exit(void);
 175
 176 /* Operations structures */
 177
 178 extern const struct inode_operations autofs4_symlink_inode_operations;
 179 extern const struct inode_operations autofs4_dir_inode_operations;
 180 extern const struct file_operations autofs4_dir_operations;
 181 extern const struct file_operations autofs4_root_operations;
 182 extern const struct dentry_operations autofs4_dentry_operations;
 183
 184 /* VFS automount flags management functions */
 185 static inline void __managed_dentry_set_managed(struct dentry *dentry)
 186 {
 187         dentry->d_flags |= (DCACHE_NEED_AUTOMOUNT|DCACHE_MANAGE_TRANSIT);
 188 }
 189
 190 static inline void managed_dentry_set_managed(struct dentry *dentry)
 191 {
 192         spin_lock(&dentry->d_lock);
 193         __managed_dentry_set_managed(dentry);
 194         spin_unlock(&dentry->d_lock);
 195 }
 196
 197 static inline void __managed_dentry_clear_managed(struct dentry *dentry)
 198 {
 199         dentry->d_flags &= ~(DCACHE_NEED_AUTOMOUNT|DCACHE_MANAGE_TRANSIT);
 200 }
 201
 202 static inline void managed_dentry_clear_managed(struct dentry *dentry)
 203 {
 204         spin_lock(&dentry->d_lock);
 205         __managed_dentry_clear_managed(dentry);
 206         spin_unlock(&dentry->d_lock);
 207 }
 208
 209 /* Initializing function */
 210
 211 int autofs4_fill_super(struct super_block *, void *, int);
 212 struct autofs_info *autofs4_new_ino(struct autofs_sb_info *);
 213 void autofs4_clean_ino(struct autofs_info *);
 214
 215 static inline int autofs_prepare_pipe(struct file *pipe)
 216 {
 217         if (!(pipe->f_mode & FMODE_CAN_WRITE))
 218                 return -EINVAL;
 219         if (!S_ISFIFO(file_inode(pipe)->i_mode))
 220                 return -EINVAL;
 221         /* We want a packet pipe */
 222         pipe->f_flags |= O_DIRECT;
 223         return 0;
 224 }
 225
 226 /* Queue management functions */
 227
 228 int autofs4_wait(struct autofs_sb_info *,struct dentry *, enum autofs_notify);
 229 int autofs4_wait_release(struct autofs_sb_info *,autofs_wqt_t,int);
 230 void autofs4_catatonic_mode(struct autofs_sb_info *);
 231
 232 static inline u32 autofs4_get_dev(struct autofs_sb_info *sbi)
 233 {
 234         return new_encode_dev(sbi->sb->s_dev);
 235 }
 236
 237 static inline u64 autofs4_get_ino(struct autofs_sb_info *sbi)
 238 {
 239         return d_inode(sbi->sb->s_root)->i_ino;
 240 }
 241
 242 static inline int simple_positive(struct dentry *dentry)
 243 {
 244         return d_really_is_positive(dentry) && !d_unhashed(dentry);
 245 }
 246
 247 static inline void __autofs4_add_expiring(struct dentry *dentry)
 248 {
 249         struct autofs_sb_info *sbi = autofs4_sbi(dentry->d_sb);
 250         struct autofs_info *ino = autofs4_dentry_ino(dentry);
 251         if (ino) {
 252                 if (list_empty(&ino->expiring))
 253                         list_add(&ino->expiring, &sbi->expiring_list);
 254         }
 255         return;
 256 }
 257
 258 static inline void autofs4_add_expiring(struct dentry *dentry)
 259 {
 260         struct autofs_sb_info *sbi = autofs4_sbi(dentry->d_sb);
 261         struct autofs_info *ino = autofs4_dentry_ino(dentry);
 262         if (ino) {
 263                 spin_lock(&sbi->lookup_lock);
 264                 if (list_empty(&ino->expiring))
 265                         list_add(&ino->expiring, &sbi->expiring_list);
 266                 spin_unlock(&sbi->lookup_lock);
 267         }
 268         return;
 269 }
 270
 271 static inline void autofs4_del_expiring(struct dentry *dentry)
 272 {
 273         struct autofs_sb_info *sbi = autofs4_sbi(dentry->d_sb);
 274         struct autofs_info *ino = autofs4_dentry_ino(dentry);
 275         if (ino) {
 276                 spin_lock(&sbi->lookup_lock);
 277                 if (!list_empty(&ino->expiring))
 278                         list_del_init(&ino->expiring);
 279                 spin_unlock(&sbi->lookup_lock);
 280         }
 281         return;
 282 }
 283
 284 extern void autofs4_kill_sb(struct super_block *);