SAFE public projects git trees. - safe/jmp/linux-2.6/blob - 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/list.h>
  20
  21 /* This is the range of ioctl() numbers we claim as ours */
  22 #define AUTOFS_IOC_FIRST     AUTOFS_IOC_READY
  23 #define AUTOFS_IOC_COUNT     32
  24
  25 #define AUTOFS_DEV_IOCTL_IOC_FIRST      (AUTOFS_DEV_IOCTL_VERSION)
  26 #define AUTOFS_DEV_IOCTL_IOC_COUNT      (AUTOFS_IOC_COUNT - 11)
  27
  28 #include <linux/kernel.h>
  29 #include <linux/slab.h>
  30 #include <linux/time.h>
  31 #include <linux/string.h>
  32 #include <linux/wait.h>
  33 #include <linux/sched.h>
  34 #include <linux/mount.h>
  35 #include <linux/namei.h>
  36 #include <asm/current.h>
  37 #include <asm/uaccess.h>
  38
  39 /* #define DEBUG */
  40
  41 #ifdef DEBUG
  42 #define DPRINTK(fmt, args...)                           \
  43 do {                                                    \
  44         printk(KERN_DEBUG "pid %d: %s: " fmt "\n",      \
  45                 current->pid, __func__, ##args);        \
  46 } while (0)
  47 #else
  48 #define DPRINTK(fmt, args...) do {} while (0)
  49 #endif
  50
  51 #define AUTOFS_WARN(fmt, args...)                       \
  52 do {                                                    \
  53         printk(KERN_WARNING "pid %d: %s: " fmt "\n",    \
  54                 current->pid, __func__, ##args);        \
  55 } while (0)
  56
  57 #define AUTOFS_ERROR(fmt, args...)                      \
  58 do {                                                    \
  59         printk(KERN_ERR "pid %d: %s: " fmt "\n",        \
  60                 current->pid, __func__, ##args);        \
  61 } while (0)
  62
  63 /* Unified info structure.  This is pointed to by both the dentry and
  64    inode structures.  Each file in the filesystem has an instance of this
  65    structure.  It holds a reference to the dentry, so dentries are never
  66    flushed while the file exists.  All name lookups are dealt with at the
  67    dentry level, although the filesystem can interfere in the validation
  68    process.  Readdir is implemented by traversing the dentry lists. */
  69 struct autofs_info {
  70         struct dentry   *dentry;
  71         struct inode    *inode;
  72
  73         int             flags;
  74
  75         struct completion expire_complete;
  76
  77         struct list_head active;
  78         int active_count;
  79
  80         struct list_head expiring;
  81
  82         struct autofs_sb_info *sbi;
  83         unsigned long last_used;
  84         atomic_t count;
  85
  86         uid_t uid;
  87         gid_t gid;
  88
  89         mode_t  mode;
  90         size_t  size;
  91
  92         void (*free)(struct autofs_info *);
  93         union {
  94                 const char *symlink;
  95         } u;
  96 };
  97
  98 #define AUTOFS_INF_EXPIRING     (1<<0) /* dentry is in the process of expiring */
  99 #define AUTOFS_INF_MOUNTPOINT   (1<<1) /* mountpoint status for direct expire */
 100
 101 struct autofs_wait_queue {
 102         wait_queue_head_t queue;
 103         struct autofs_wait_queue *next;
 104         autofs_wqt_t wait_queue_token;
 105         /* We use the following to see what we are waiting for */
 106         struct qstr name;
 107         u32 dev;
 108         u64 ino;
 109         uid_t uid;
 110         gid_t gid;
 111         pid_t pid;
 112         pid_t tgid;
 113         /* This is for status reporting upon return */
 114         int status;
 115         unsigned int wait_ctr;
 116 };
 117
 118 #define AUTOFS_SBI_MAGIC 0x6d4a556d
 119
 120 struct autofs_sb_info {
 121         u32 magic;
 122         int pipefd;
 123         struct file *pipe;
 124         pid_t oz_pgrp;
 125         int catatonic;
 126         int version;
 127         int sub_version;
 128         int min_proto;
 129         int max_proto;
 130         unsigned long exp_timeout;
 131         unsigned int type;
 132         int reghost_enabled;
 133         int needs_reghost;
 134         struct super_block *sb;
 135         struct mutex wq_mutex;
 136         spinlock_t fs_lock;
 137         struct autofs_wait_queue *queues; /* Wait queue pointer */
 138         spinlock_t lookup_lock;
 139         struct list_head active_list;
 140         struct list_head expiring_list;
 141 };
 142
 143 static inline struct autofs_sb_info *autofs4_sbi(struct super_block *sb)
 144 {
 145         return (struct autofs_sb_info *)(sb->s_fs_info);
 146 }
 147
 148 static inline struct autofs_info *autofs4_dentry_ino(struct dentry *dentry)
 149 {
 150         return (struct autofs_info *)(dentry->d_fsdata);
 151 }
 152
 153 /* autofs4_oz_mode(): do we see the man behind the curtain?  (The
 154    processes which do manipulations for us in user space sees the raw
 155    filesystem without "magic".) */
 156
 157 static inline int autofs4_oz_mode(struct autofs_sb_info *sbi) {
 158         return sbi->catatonic || task_pgrp_nr(current) == sbi->oz_pgrp;
 159 }
 160
 161 /* Does a dentry have some pending activity? */
 162 static inline int autofs4_ispending(struct dentry *dentry)
 163 {
 164         struct autofs_info *inf = autofs4_dentry_ino(dentry);
 165
 166         if (dentry->d_flags & DCACHE_AUTOFS_PENDING)
 167                 return 1;
 168
 169         if (inf->flags & AUTOFS_INF_EXPIRING)
 170                 return 1;
 171
 172         return 0;
 173 }
 174
 175 static inline void autofs4_copy_atime(struct file *src, struct file *dst)
 176 {
 177         dst->f_path.dentry->d_inode->i_atime =
 178                 src->f_path.dentry->d_inode->i_atime;
 179         return;
 180 }
 181
 182 struct inode *autofs4_get_inode(struct super_block *, struct autofs_info *);
 183 void autofs4_free_ino(struct autofs_info *);
 184
 185 /* Expiration */
 186 int is_autofs4_dentry(struct dentry *);
 187 int autofs4_expire_wait(struct dentry *dentry);
 188 int autofs4_expire_run(struct super_block *, struct vfsmount *,
 189                         struct autofs_sb_info *,
 190                         struct autofs_packet_expire __user *);
 191 int autofs4_do_expire_multi(struct super_block *sb, struct vfsmount *mnt,
 192                             struct autofs_sb_info *sbi, int when);
 193 int autofs4_expire_multi(struct super_block *, struct vfsmount *,
 194                         struct autofs_sb_info *, int __user *);
 195 struct dentry *autofs4_expire_direct(struct super_block *sb,
 196                                      struct vfsmount *mnt,
 197                                      struct autofs_sb_info *sbi, int how);
 198 struct dentry *autofs4_expire_indirect(struct super_block *sb,
 199                                        struct vfsmount *mnt,
 200                                        struct autofs_sb_info *sbi, int how);
 201
 202 /* Device node initialization */
 203
 204 int autofs_dev_ioctl_init(void);
 205 void autofs_dev_ioctl_exit(void);
 206
 207 /* Operations structures */
 208
 209 extern const struct inode_operations autofs4_symlink_inode_operations;
 210 extern const struct inode_operations autofs4_dir_inode_operations;
 211 extern const struct inode_operations autofs4_root_inode_operations;
 212 extern const struct inode_operations autofs4_indirect_root_inode_operations;
 213 extern const struct inode_operations autofs4_direct_root_inode_operations;
 214 extern const struct file_operations autofs4_dir_operations;
 215 extern const struct file_operations autofs4_root_operations;
 216
 217 /* Initializing function */
 218
 219 int autofs4_fill_super(struct super_block *, void *, int);
 220 struct autofs_info *autofs4_init_ino(struct autofs_info *, struct autofs_sb_info *sbi, mode_t mode);
 221
 222 /* Queue management functions */
 223
 224 int autofs4_wait(struct autofs_sb_info *,struct dentry *, enum autofs_notify);
 225 int autofs4_wait_release(struct autofs_sb_info *,autofs_wqt_t,int);
 226 void autofs4_catatonic_mode(struct autofs_sb_info *);
 227
 228 static inline int autofs4_follow_mount(struct path *path)
 229 {
 230         int res = 0;
 231
 232         while (d_mountpoint(path->dentry)) {
 233                 int followed = follow_down(path);
 234                 if (!followed)
 235                         break;
 236                 res = 1;
 237         }
 238         return res;
 239 }
 240
 241 static inline u32 autofs4_get_dev(struct autofs_sb_info *sbi)
 242 {
 243         return new_encode_dev(sbi->sb->s_dev);
 244 }
 245
 246 static inline u64 autofs4_get_ino(struct autofs_sb_info *sbi)
 247 {
 248         return sbi->sb->s_root->d_inode->i_ino;
 249 }
 250
 251 static inline int simple_positive(struct dentry *dentry)
 252 {
 253         return dentry->d_inode && !d_unhashed(dentry);
 254 }
 255
 256 static inline int __simple_empty(struct dentry *dentry)
 257 {
 258         struct dentry *child;
 259         int ret = 0;
 260
 261         list_for_each_entry(child, &dentry->d_subdirs, d_u.d_child)
 262                 if (simple_positive(child))
 263                         goto out;
 264         ret = 1;
 265 out:
 266         return ret;
 267 }
 268
 269 static inline void autofs4_add_expiring(struct dentry *dentry)
 270 {
 271         struct autofs_sb_info *sbi = autofs4_sbi(dentry->d_sb);
 272         struct autofs_info *ino = autofs4_dentry_ino(dentry);
 273         if (ino) {
 274                 spin_lock(&sbi->lookup_lock);
 275                 if (list_empty(&ino->expiring))
 276                         list_add(&ino->expiring, &sbi->expiring_list);
 277                 spin_unlock(&sbi->lookup_lock);
 278         }
 279         return;
 280 }
 281
 282 static inline void autofs4_del_expiring(struct dentry *dentry)
 283 {
 284         struct autofs_sb_info *sbi = autofs4_sbi(dentry->d_sb);
 285         struct autofs_info *ino = autofs4_dentry_ino(dentry);
 286         if (ino) {
 287                 spin_lock(&sbi->lookup_lock);
 288                 if (!list_empty(&ino->expiring))
 289                         list_del_init(&ino->expiring);
 290                 spin_unlock(&sbi->lookup_lock);
 291         }
 292         return;
 293 }
 294
 295 void autofs4_dentry_release(struct dentry *);
 296 extern void autofs4_kill_sb(struct super_block *);