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 #include <linux/kernel.h>
  25 #include <linux/slab.h>
  26 #include <linux/time.h>
  27 #include <linux/string.h>
  28 #include <linux/wait.h>
  29 #include <linux/sched.h>
  30 #include <linux/mount.h>
  31 #include <linux/namei.h>
  32 #include <asm/current.h>
  33 #include <asm/uaccess.h>
  34
  35 /* #define DEBUG */
  36
  37 #ifdef DEBUG
  38 #define DPRINTK(fmt,args...) do { printk(KERN_DEBUG "pid %d: %s: " fmt "\n" , current->pid , __FUNCTION__ , ##args); } while(0)
  39 #else
  40 #define DPRINTK(fmt,args...) do {} while(0)
  41 #endif
  42
  43 #define AUTOFS_SUPER_MAGIC 0x0187
  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 autofs_sb_info *sbi;
  58         unsigned long last_used;
  59         atomic_t count;
  60
  61         mode_t  mode;
  62         size_t  size;
  63
  64         void (*free)(struct autofs_info *);
  65         union {
  66                 const char *symlink;
  67         } u;
  68 };
  69
  70 #define AUTOFS_INF_EXPIRING     (1<<0) /* dentry is in the process of expiring */
  71
  72 struct autofs_wait_queue {
  73         wait_queue_head_t queue;
  74         struct autofs_wait_queue *next;
  75         autofs_wqt_t wait_queue_token;
  76         /* We use the following to see what we are waiting for */
  77         unsigned int hash;
  78         unsigned int len;
  79         char *name;
  80         u32 dev;
  81         u64 ino;
  82         uid_t uid;
  83         gid_t gid;
  84         pid_t pid;
  85         pid_t tgid;
  86         /* This is for status reporting upon return */
  87         int status;
  88         atomic_t wait_ctr;
  89 };
  90
  91 #define AUTOFS_SBI_MAGIC 0x6d4a556d
  92
  93 #define AUTOFS_TYPE_INDIRECT     0x0001
  94 #define AUTOFS_TYPE_DIRECT       0x0002
  95 #define AUTOFS_TYPE_OFFSET       0x0004
  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 };
 116
 117 static inline struct autofs_sb_info *autofs4_sbi(struct super_block *sb)
 118 {
 119         return (struct autofs_sb_info *)(sb->s_fs_info);
 120 }
 121
 122 static inline struct autofs_info *autofs4_dentry_ino(struct dentry *dentry)
 123 {
 124         return (struct autofs_info *)(dentry->d_fsdata);
 125 }
 126
 127 /* autofs4_oz_mode(): do we see the man behind the curtain?  (The
 128    processes which do manipulations for us in user space sees the raw
 129    filesystem without "magic".) */
 130
 131 static inline int autofs4_oz_mode(struct autofs_sb_info *sbi) {
 132         return sbi->catatonic || process_group(current) == sbi->oz_pgrp;
 133 }
 134
 135 /* Does a dentry have some pending activity? */
 136 static inline int autofs4_ispending(struct dentry *dentry)
 137 {
 138         struct autofs_info *inf = autofs4_dentry_ino(dentry);
 139         int pending = 0;
 140
 141         if (dentry->d_flags & DCACHE_AUTOFS_PENDING)
 142                 return 1;
 143
 144         if (inf) {
 145                 spin_lock(&inf->sbi->fs_lock);
 146                 pending = inf->flags & AUTOFS_INF_EXPIRING;
 147                 spin_unlock(&inf->sbi->fs_lock);
 148         }
 149
 150         return pending;
 151 }
 152
 153 static inline void autofs4_copy_atime(struct file *src, struct file *dst)
 154 {
 155         dst->f_dentry->d_inode->i_atime = src->f_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_run(struct super_block *, struct vfsmount *,
 165                         struct autofs_sb_info *,
 166                         struct autofs_packet_expire __user *);
 167 int autofs4_expire_multi(struct super_block *, struct vfsmount *,
 168                         struct autofs_sb_info *, int __user *);
 169
 170 /* Operations structures */
 171
 172 extern struct inode_operations autofs4_symlink_inode_operations;
 173 extern struct inode_operations autofs4_dir_inode_operations;
 174 extern struct inode_operations autofs4_root_inode_operations;
 175 extern struct inode_operations autofs4_indirect_root_inode_operations;
 176 extern struct inode_operations autofs4_direct_root_inode_operations;
 177 extern const struct file_operations autofs4_dir_operations;
 178 extern const struct file_operations autofs4_root_operations;
 179
 180 /* Initializing function */
 181
 182 int autofs4_fill_super(struct super_block *, void *, int);
 183 struct autofs_info *autofs4_init_ino(struct autofs_info *, struct autofs_sb_info *sbi, mode_t mode);
 184
 185 /* Queue management functions */
 186
 187 int autofs4_wait(struct autofs_sb_info *,struct dentry *, enum autofs_notify);
 188 int autofs4_wait_release(struct autofs_sb_info *,autofs_wqt_t,int);
 189 void autofs4_catatonic_mode(struct autofs_sb_info *);
 190
 191 static inline int autofs4_follow_mount(struct vfsmount **mnt, struct dentry **dentry)
 192 {
 193         int res = 0;
 194
 195         while (d_mountpoint(*dentry)) {
 196                 int followed = follow_down(mnt, dentry);
 197                 if (!followed)
 198                         break;
 199                 res = 1;
 200         }
 201         return res;
 202 }
 203
 204 static inline u32 autofs4_get_dev(struct autofs_sb_info *sbi)
 205 {
 206         return new_encode_dev(sbi->sb->s_dev);
 207 }
 208
 209 static inline u64 autofs4_get_ino(struct autofs_sb_info *sbi)
 210 {
 211         return sbi->sb->s_root->d_inode->i_ino;
 212 }
 213
 214 static inline int simple_positive(struct dentry *dentry)
 215 {
 216         return dentry->d_inode && !d_unhashed(dentry);
 217 }
 218
 219 static inline int __simple_empty(struct dentry *dentry)
 220 {
 221         struct dentry *child;
 222         int ret = 0;
 223
 224         list_for_each_entry(child, &dentry->d_subdirs, d_u.d_child)
 225                 if (simple_positive(child))
 226                         goto out;
 227         ret = 1;
 228 out:
 229         return ret;
 230 }
 231
 232 void autofs4_dentry_release(struct dentry *);
 233 extern void autofs4_kill_sb(struct super_block *);