fs/xfs/linux-2.6/xfs_vfs.h

   1 /*
   2  * Copyright (c) 2000-2005 Silicon Graphics, Inc.
   3  * All Rights Reserved.
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU General Public License as
   7  * published by the Free Software Foundation.
   8  *
   9  * This program is distributed in the hope that it would be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write the Free Software Foundation,
  16  * Inc.,  51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  17  */
  18 #ifndef __XFS_VFS_H__
  19 #define __XFS_VFS_H__
  20
  21 #include <linux/vfs.h>
  22 #include "xfs_fs.h"
  23
  24 struct fid;
  25 struct vfs;
  26 struct cred;
  27 struct vnode;
  28 struct kstatfs;
  29 struct seq_file;
  30 struct super_block;
  31 struct xfs_mount_args;
  32
  33 typedef struct kstatfs xfs_statfs_t;
  34
  35 typedef struct vfs_sync_work {
  36         struct list_head        w_list;
  37         struct vfs              *w_vfs;
  38         void                    *w_data;        /* syncer routine argument */
  39         void                    (*w_syncer)(struct vfs *, void *);
  40 } vfs_sync_work_t;
  41
  42 typedef struct vfs {
  43         u_int                   vfs_flag;       /* flags */
  44         xfs_fsid_t              vfs_fsid;       /* file system ID */
  45         xfs_fsid_t              *vfs_altfsid;   /* An ID fixed for life of FS */
  46         bhv_head_t              vfs_bh;         /* head of vfs behavior chain */
  47         struct super_block      *vfs_super;     /* generic superblock pointer */
  48         struct task_struct      *vfs_sync_task; /* generalised sync thread */
  49         vfs_sync_work_t         vfs_sync_work;  /* work item for VFS_SYNC */
  50         struct list_head        vfs_sync_list;  /* sync thread work item list */
  51         spinlock_t              vfs_sync_lock;  /* work item list lock */
  52         int                     vfs_sync_seq;   /* sync thread generation no. */
  53         wait_queue_head_t       vfs_wait_single_sync_task;
  54 } vfs_t;
  55
  56 #define vfs_fbhv                vfs_bh.bh_first /* 1st on vfs behavior chain */
  57
  58 #define bhvtovfs(bdp)           ( (struct vfs *)BHV_VOBJ(bdp) )
  59 #define bhvtovfsops(bdp)        ( (struct vfsops *)BHV_OPS(bdp) )
  60 #define VFS_BHVHEAD(vfs)        ( &(vfs)->vfs_bh )
  61 #define VFS_REMOVEBHV(vfs, bdp) ( bhv_remove(VFS_BHVHEAD(vfs), bdp) )
  62
  63 #define VFS_POSITION_BASE       BHV_POSITION_BASE       /* chain bottom */
  64 #define VFS_POSITION_TOP        BHV_POSITION_TOP        /* chain top */
  65 #define VFS_POSITION_INVALID    BHV_POSITION_INVALID    /* invalid pos. num */
  66
  67 typedef enum {
  68         VFS_BHV_UNKNOWN,        /* not specified */
  69         VFS_BHV_XFS,            /* xfs */
  70         VFS_BHV_DM,             /* data migration */
  71         VFS_BHV_QM,             /* quota manager */
  72         VFS_BHV_IO,             /* IO path */
  73         VFS_BHV_END             /* housekeeping end-of-range */
  74 } vfs_bhv_t;
  75
  76 #define VFS_POSITION_XFS        (BHV_POSITION_BASE)
  77 #define VFS_POSITION_DM         (VFS_POSITION_BASE+10)
  78 #define VFS_POSITION_QM         (VFS_POSITION_BASE+20)
  79 #define VFS_POSITION_IO         (VFS_POSITION_BASE+30)
  80
  81 #define VFS_RDONLY              0x0001  /* read-only vfs */
  82 #define VFS_GRPID               0x0002  /* group-ID assigned from directory */
  83 #define VFS_DMI                 0x0004  /* filesystem has the DMI enabled */
  84 #define VFS_32BITINODES         0x0008  /* do not use inums above 32 bits */
  85 #define VFS_END                 0x0008  /* max flag */
  86
  87 #define SYNC_ATTR               0x0001  /* sync attributes */
  88 #define SYNC_CLOSE              0x0002  /* close file system down */
  89 #define SYNC_DELWRI             0x0004  /* look at delayed writes */
  90 #define SYNC_WAIT               0x0008  /* wait for i/o to complete */
  91 #define SYNC_BDFLUSH            0x0010  /* BDFLUSH is calling -- don't block */
  92 #define SYNC_FSDATA             0x0020  /* flush fs data (e.g. superblocks) */
  93 #define SYNC_REFCACHE           0x0040  /* prune some of the nfs ref cache */
  94 #define SYNC_REMOUNT            0x0080  /* remount readonly, no dummy LRs */
  95 #define SYNC_QUIESCE            0x0100  /* quiesce fileystem for a snapshot */
  96
  97 typedef int     (*vfs_mount_t)(bhv_desc_t *,
  98                                 struct xfs_mount_args *, struct cred *);
  99 typedef int     (*vfs_parseargs_t)(bhv_desc_t *, char *,
 100                                 struct xfs_mount_args *, int);
 101 typedef int     (*vfs_showargs_t)(bhv_desc_t *, struct seq_file *);
 102 typedef int     (*vfs_unmount_t)(bhv_desc_t *, int, struct cred *);
 103 typedef int     (*vfs_mntupdate_t)(bhv_desc_t *, int *,
 104                                 struct xfs_mount_args *);
 105 typedef int     (*vfs_root_t)(bhv_desc_t *, struct vnode **);
 106 typedef int     (*vfs_statvfs_t)(bhv_desc_t *, xfs_statfs_t *, struct vnode *);
 107 typedef int     (*vfs_sync_t)(bhv_desc_t *, int, struct cred *);
 108 typedef int     (*vfs_vget_t)(bhv_desc_t *, struct vnode **, struct fid *);
 109 typedef int     (*vfs_dmapiops_t)(bhv_desc_t *, caddr_t);
 110 typedef int     (*vfs_quotactl_t)(bhv_desc_t *, int, int, caddr_t);
 111 typedef void    (*vfs_init_vnode_t)(bhv_desc_t *,
 112                                 struct vnode *, bhv_desc_t *, int);
 113 typedef void    (*vfs_force_shutdown_t)(bhv_desc_t *, int, char *, int);
 114 typedef void    (*vfs_freeze_t)(bhv_desc_t *);
 115
 116 typedef struct vfsops {
 117         bhv_position_t          vf_position;    /* behavior chain position */
 118         vfs_mount_t             vfs_mount;      /* mount file system */
 119         vfs_parseargs_t         vfs_parseargs;  /* parse mount options */
 120         vfs_showargs_t          vfs_showargs;   /* unparse mount options */
 121         vfs_unmount_t           vfs_unmount;    /* unmount file system */
 122         vfs_mntupdate_t         vfs_mntupdate;  /* update file system options */
 123         vfs_root_t              vfs_root;       /* get root vnode */
 124         vfs_statvfs_t           vfs_statvfs;    /* file system statistics */
 125         vfs_sync_t              vfs_sync;       /* flush files */
 126         vfs_vget_t              vfs_vget;       /* get vnode from fid */
 127         vfs_dmapiops_t          vfs_dmapiops;   /* data migration */
 128         vfs_quotactl_t          vfs_quotactl;   /* disk quota */
 129         vfs_init_vnode_t        vfs_init_vnode; /* initialize a new vnode */
 130         vfs_force_shutdown_t    vfs_force_shutdown;     /* crash and burn */
 131         vfs_freeze_t            vfs_freeze;     /* freeze fs for snapshot */
 132 } vfsops_t;
 133
 134 /*
 135  * VFS's.  Operates on vfs structure pointers (starts at bhv head).
 136  */
 137 #define VHEAD(v)                        ((v)->vfs_fbhv)
 138 #define VFS_MOUNT(v, ma,cr, rv)         ((rv) = vfs_mount(VHEAD(v), ma,cr))
 139 #define VFS_PARSEARGS(v, o,ma,f, rv)    ((rv) = vfs_parseargs(VHEAD(v), o,ma,f))
 140 #define VFS_SHOWARGS(v, m, rv)          ((rv) = vfs_showargs(VHEAD(v), m))
 141 #define VFS_UNMOUNT(v, f, cr, rv)       ((rv) = vfs_unmount(VHEAD(v), f,cr))
 142 #define VFS_MNTUPDATE(v, fl, args, rv)  ((rv) = vfs_mntupdate(VHEAD(v), fl, args))
 143 #define VFS_ROOT(v, vpp, rv)            ((rv) = vfs_root(VHEAD(v), vpp))
 144 #define VFS_STATVFS(v, sp,vp, rv)       ((rv) = vfs_statvfs(VHEAD(v), sp,vp))
 145 #define VFS_SYNC(v, flag,cr, rv)        ((rv) = vfs_sync(VHEAD(v), flag,cr))
 146 #define VFS_VGET(v, vpp,fidp, rv)       ((rv) = vfs_vget(VHEAD(v), vpp,fidp))
 147 #define VFS_DMAPIOPS(v, p, rv)          ((rv) = vfs_dmapiops(VHEAD(v), p))
 148 #define VFS_QUOTACTL(v, c,id,p, rv)     ((rv) = vfs_quotactl(VHEAD(v), c,id,p))
 149 #define VFS_INIT_VNODE(v, vp,b,ul)      ( vfs_init_vnode(VHEAD(v), vp,b,ul) )
 150 #define VFS_FORCE_SHUTDOWN(v, fl,f,l)   ( vfs_force_shutdown(VHEAD(v), fl,f,l) )
 151 #define VFS_FREEZE(v)                   ( vfs_freeze(VHEAD(v)) )
 152
 153 /*
 154  * PVFS's.  Operates on behavior descriptor pointers.
 155  */
 156 #define PVFS_MOUNT(b, ma,cr, rv)        ((rv) = vfs_mount(b, ma,cr))
 157 #define PVFS_PARSEARGS(b, o,ma,f, rv)   ((rv) = vfs_parseargs(b, o,ma,f))
 158 #define PVFS_SHOWARGS(b, m, rv)         ((rv) = vfs_showargs(b, m))
 159 #define PVFS_UNMOUNT(b, f,cr, rv)       ((rv) = vfs_unmount(b, f,cr))
 160 #define PVFS_MNTUPDATE(b, fl, args, rv) ((rv) = vfs_mntupdate(b, fl, args))
 161 #define PVFS_ROOT(b, vpp, rv)           ((rv) = vfs_root(b, vpp))
 162 #define PVFS_STATVFS(b, sp,vp, rv)      ((rv) = vfs_statvfs(b, sp,vp))
 163 #define PVFS_SYNC(b, flag,cr, rv)       ((rv) = vfs_sync(b, flag,cr))
 164 #define PVFS_VGET(b, vpp,fidp, rv)      ((rv) = vfs_vget(b, vpp,fidp))
 165 #define PVFS_DMAPIOPS(b, p, rv)         ((rv) = vfs_dmapiops(b, p))
 166 #define PVFS_QUOTACTL(b, c,id,p, rv)    ((rv) = vfs_quotactl(b, c,id,p))
 167 #define PVFS_INIT_VNODE(b, vp,b2,ul)    ( vfs_init_vnode(b, vp,b2,ul) )
 168 #define PVFS_FORCE_SHUTDOWN(b, fl,f,l)  ( vfs_force_shutdown(b, fl,f,l) )
 169 #define PVFS_FREEZE(b)                  ( vfs_freeze(b) )
 170
 171 extern int vfs_mount(bhv_desc_t *, struct xfs_mount_args *, struct cred *);
 172 extern int vfs_parseargs(bhv_desc_t *, char *, struct xfs_mount_args *, int);
 173 extern int vfs_showargs(bhv_desc_t *, struct seq_file *);
 174 extern int vfs_unmount(bhv_desc_t *, int, struct cred *);
 175 extern int vfs_mntupdate(bhv_desc_t *, int *, struct xfs_mount_args *);
 176 extern int vfs_root(bhv_desc_t *, struct vnode **);
 177 extern int vfs_statvfs(bhv_desc_t *, xfs_statfs_t *, struct vnode *);
 178 extern int vfs_sync(bhv_desc_t *, int, struct cred *);
 179 extern int vfs_vget(bhv_desc_t *, struct vnode **, struct fid *);
 180 extern int vfs_dmapiops(bhv_desc_t *, caddr_t);
 181 extern int vfs_quotactl(bhv_desc_t *, int, int, caddr_t);
 182 extern void vfs_init_vnode(bhv_desc_t *, struct vnode *, bhv_desc_t *, int);
 183 extern void vfs_force_shutdown(bhv_desc_t *, int, char *, int);
 184 extern void vfs_freeze(bhv_desc_t *);
 185
 186 typedef struct bhv_vfsops {
 187         struct vfsops           bhv_common;
 188         void *                  bhv_custom;
 189 } bhv_vfsops_t;
 190
 191 #define vfs_bhv_lookup(v, id)   ( bhv_lookup_range(&(v)->vfs_bh, (id), (id)) )
 192 #define vfs_bhv_custom(b)       ( ((bhv_vfsops_t *)BHV_OPS(b))->bhv_custom )
 193 #define vfs_bhv_set_custom(b,o) ( (b)->bhv_custom = (void *)(o))
 194 #define vfs_bhv_clr_custom(b)   ( (b)->bhv_custom = NULL )
 195
 196 extern vfs_t *vfs_allocate(void);
 197 extern void vfs_deallocate(vfs_t *);
 198 extern void vfs_insertops(vfs_t *, bhv_vfsops_t *);
 199 extern void vfs_insertbhv(vfs_t *, bhv_desc_t *, vfsops_t *, void *);
 200
 201 extern void bhv_insert_all_vfsops(struct vfs *);
 202 extern void bhv_remove_all_vfsops(struct vfs *, int);
 203 extern void bhv_remove_vfsops(struct vfs *, int);
 204
 205 #define fs_frozen(vfsp)         ((vfsp)->vfs_super->s_frozen)
 206 #define fs_check_frozen(vfsp, level) \
 207         vfs_check_frozen(vfsp->vfs_super, level);
 208
 209 #endif  /* __XFS_VFS_H__ */