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