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