fs/xfs/linux/xfs_vfs.h

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