sys/gnu/fs/xfs/FreeBSD/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 <sys/mount.h>
  36 #include "xfs_fs.h"
  37
  38 struct fid;
  39 struct cred;
  40 struct xfs_vnode;
  41 struct statfs;
  42 struct sbuf;
  43 struct xfs_mount_args;
  44 struct mount;
  45
  46 typedef struct statfs xfs_statfs_t;
  47
  48 typedef struct xfs_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 mount            *vfs_mp;        /* FreeBSD mount struct */
  54 } xfs_vfs_t;
  55
  56 #define MNTTOXVFS(mp)           ((struct xfs_vfs*)(mp)->mnt_data)
  57 #define XVFSTOMNT(vfs)          ((vfs)->vfs_mp)
  58
  59 #define vfs_fbhv                vfs_bh.bh_first /* 1st on vfs behavior chain */
  60
  61 #define bhvtovfs(bdp)           ( (struct xfs_vfs *)BHV_VOBJ(bdp) )
  62 #define bhvtovfsops(bdp)        ( (struct xvfsops *)BHV_OPS(bdp) )
  63 #define VFS_BHVHEAD(vfs)        ( &(vfs)->vfs_bh )
  64 #define VFS_REMOVEBHV(vfs, bdp) ( bhv_remove(VFS_BHVHEAD(vfs), bdp) )
  65
  66 #define VFS_POSITION_BASE       BHV_POSITION_BASE       /* chain bottom */
  67 #define VFS_POSITION_TOP        BHV_POSITION_TOP        /* chain top */
  68 #define VFS_POSITION_INVALID    BHV_POSITION_INVALID    /* invalid pos. num */
  69
  70 typedef enum {
  71         VFS_BHV_UNKNOWN,        /* not specified */
  72         VFS_BHV_XFS,            /* xfs */
  73         VFS_BHV_DM,             /* data migration */
  74         VFS_BHV_QM,             /* quota manager */
  75         VFS_BHV_IO,             /* IO path */
  76         VFS_BHV_END             /* housekeeping end-of-range */
  77 } vfs_bhv_t;
  78
  79 #define VFS_POSITION_XFS        (BHV_POSITION_BASE)
  80 #define VFS_POSITION_DM         (VFS_POSITION_BASE+10)
  81 #define VFS_POSITION_QM         (VFS_POSITION_BASE+20)
  82 #define VFS_POSITION_IO         (VFS_POSITION_BASE+30)
  83
  84 #define VFS_RDONLY              0x0001  /* read-only vfs */
  85 #define VFS_GRPID               0x0002  /* group-ID assigned from directory */
  86 #define VFS_DMI                 0x0004  /* filesystem has the DMI enabled */
  87 #define VFS_32BITINODES         0x0008  /* do not use inums above 32 bits */
  88 #define VFS_END                 0x0008  /* max flag */
  89
  90 #define SYNC_ATTR               0x0001  /* sync attributes */
  91 #define SYNC_CLOSE              0x0002  /* close file system down */
  92 #define SYNC_DELWRI             0x0004  /* look at delayed writes */
  93 #define SYNC_WAIT               0x0008  /* wait for i/o to complete */
  94 #define SYNC_BDFLUSH            0x0010  /* BDFLUSH is calling -- don't block */
  95 #define SYNC_FSDATA             0x0020  /* flush fs data (e.g. superblocks) */
  96 #define SYNC_REFCACHE           0x0040  /* prune some of the nfs ref cache */
  97 #define SYNC_REMOUNT            0x0080  /* remount readonly, no dummy LRs */
  98 #define SYNC_QUIESCE            0x0100  /* quiesce filesystem for a snapshot */
  99
 100 #define IGET_NOALLOC            0x0001  /* vfs_get_inode may return NULL */
 101
 102 typedef int     (*xvfs_mount_t)(bhv_desc_t *,
 103                                 struct xfs_mount_args *, struct cred *);
 104 typedef int     (*xvfs_parseargs_t)(bhv_desc_t *, char *,
 105                                 struct xfs_mount_args *, int);
 106 typedef int     (*xvfs_showargs_t)(bhv_desc_t *, struct sbuf *);
 107 typedef int     (*xvfs_unmount_t)(bhv_desc_t *, int, struct cred *);
 108 typedef int     (*xvfs_mntupdate_t)(bhv_desc_t *, int *,
 109                                 struct xfs_mount_args *);
 110 typedef int     (*xvfs_root_t)(bhv_desc_t *, struct xfs_vnode **);
 111 typedef int     (*xvfs_statvfs_t)(bhv_desc_t *, xfs_statfs_t *, struct xfs_vnode *);
 112 typedef int     (*xvfs_sync_t)(bhv_desc_t *, int, struct cred *);
 113 typedef int     (*xvfs_vget_t)(bhv_desc_t *, struct xfs_vnode **, struct fid *);
 114 typedef int     (*xvfs_dmapiops_t)(bhv_desc_t *, caddr_t);
 115 typedef int     (*xvfs_quotactl_t)(bhv_desc_t *, int, int, caddr_t);
 116 typedef void    (*xvfs_init_vnode_t)(bhv_desc_t *,
 117                                 struct xfs_vnode *, bhv_desc_t *, int);
 118 typedef void    (*xvfs_force_shutdown_t)(bhv_desc_t *, int, char *, int);
 119 typedef struct inode * (*xvfs_get_inode_t)(bhv_desc_t *, xfs_ino_t, int);
 120 typedef void    (*xvfs_freeze_t)(bhv_desc_t *);
 121
 122 typedef struct xvfsops {
 123         bhv_position_t          xvfs_position;  /* behavior chain position */
 124         xvfs_mount_t            xvfs_mount;     /* mount file system */
 125         xvfs_parseargs_t        xvfs_parseargs; /* parse mount options */
 126         xvfs_showargs_t         xvfs_showargs;  /* unparse mount options */
 127         xvfs_unmount_t          xvfs_unmount;   /* unmount file system */
 128         xvfs_mntupdate_t        xvfs_mntupdate; /* update file system options */
 129         xvfs_root_t             xvfs_root;      /* get root vnode */
 130         xvfs_statvfs_t          xvfs_statvfs;   /* file system statistics */
 131         xvfs_sync_t             xvfs_sync;      /* flush files */
 132         xvfs_vget_t             xvfs_vget;      /* get vnode from fid */
 133         xvfs_dmapiops_t         xvfs_dmapiops;  /* data migration */
 134         xvfs_quotactl_t         xvfs_quotactl;  /* disk quota */
 135         xvfs_get_inode_t        xvfs_get_inode; /* bhv specific iget */
 136         xvfs_init_vnode_t       xvfs_init_vnode;        /* initialize a new vnode */
 137         xvfs_force_shutdown_t   xvfs_force_shutdown;    /* crash and burn */
 138         xvfs_freeze_t           xvfs_freeze;    /* freeze fs for snapshot */
 139 } xvfsops_t;
 140
 141 /*
 142  * VFS's.  Operates on vfs structure pointers (starts at bhv head).
 143  */
 144 #define VHEAD(v)                        ((v)->vfs_fbhv)
 145 #define XVFS_MOUNT(v, ma,cr, rv)        ((rv) = xvfs_mount(VHEAD(v), ma,cr))
 146 #define XVFS_PARSEARGS(v, o,ma,f, rv)   ((rv) = xvfs_parseargs(VHEAD(v), o,ma,f))
 147 #define XVFS_SHOWARGS(v, m, rv)         ((rv) = xvfs_showargs(VHEAD(v), m))
 148 #define XVFS_UNMOUNT(v, f, cr, rv)      ((rv) = xvfs_unmount(VHEAD(v), f,cr))
 149 #define XVFS_MNTUPDATE(v, fl, args, rv) ((rv) = xvfs_mntupdate(VHEAD(v), fl, args))
 150 #define XVFS_ROOT(v, vpp, rv)           ((rv) = xvfs_root(VHEAD(v), vpp))
 151 #define XVFS_STATVFS(v, sp,vp, rv)      ((rv) = xvfs_statvfs(VHEAD(v), sp,vp))
 152 #define XVFS_SYNC(v, flag,cr, rv)       ((rv) = xvfs_sync(VHEAD(v), flag,cr))
 153 #define XVFS_VGET(v, vpp,fidp, rv)      ((rv) = xvfs_vget(VHEAD(v), vpp,fidp))
 154 #define XVFS_DMAPIOPS(v, p, rv)         ((rv) = xvfs_dmapiops(VHEAD(v), p))
 155 #define XVFS_QUOTACTL(v, c,id,p, rv)    ((rv) = xvfs_quotactl(VHEAD(v), c,id,p))
 156 #define XVFS_GET_INODE(v, ino, fl)      ( xvfs_get_inode(VHEAD(v), ino,fl) )
 157 #define XVFS_INIT_VNODE(v, vp,b,ul)     ( xvfs_init_vnode(VHEAD(v), vp,b,ul) )
 158 #define XVFS_FORCE_SHUTDOWN(v, fl,f,l)  ( xvfs_force_shutdown(VHEAD(v), fl,f,l) )
 159
 160 /*
 161  * PVFS's.  Operates on behavior descriptor pointers.
 162  */
 163 #define PVFS_MOUNT(b, ma,cr, rv)        ((rv) = xvfs_mount(b, ma,cr))
 164 #define PVFS_PARSEARGS(b, o,ma,f, rv)   ((rv) = xvfs_parseargs(b, o,ma,f))
 165 #define PVFS_SHOWARGS(b, m, rv)         ((rv) = xvfs_showargs(b, m))
 166 #define PVFS_UNMOUNT(b, f,cr, rv)       ((rv) = xvfs_unmount(b, f,cr))
 167 #define PVFS_MNTUPDATE(b, fl, args, rv) ((rv) = xvfs_mntupdate(b, fl, args))
 168 #define PVFS_ROOT(b, vpp, rv)           ((rv) = xvfs_root(b, vpp))
 169 #define PVFS_STATVFS(b, sp,vp, rv)      ((rv) = xvfs_statvfs(b, sp,vp))
 170 #define PVFS_SYNC(b, flag,cr, rv)       ((rv) = xvfs_sync(b, flag,cr))
 171 #define PVFS_VGET(b, vpp,fidp, rv)      ((rv) = xvfs_vget(b, vpp,fidp))
 172 #define PVFS_DMAPIOPS(b, p, rv)         ((rv) = xvfs_dmapiops(b, p))
 173 #define PVFS_QUOTACTL(b, c,id,p, rv)    ((rv) = xvfs_quotactl(b, c,id,p))
 174 #define PVFS_GET_INODE(b, ino,fl)       ( xvfs_get_inode(b, ino,fl) )
 175 #define PVFS_INIT_VNODE(b, vp,b2,ul)    ( xvfs_init_vnode(b, vp,b2,ul) )
 176 #define PVFS_FORCE_SHUTDOWN(b, fl,f,l)  ( xvfs_force_shutdown(b, fl,f,l) )
 177
 178 extern int xvfs_mount(bhv_desc_t *, struct xfs_mount_args *, struct cred *);
 179 extern int xvfs_parseargs(bhv_desc_t *, char *, struct xfs_mount_args *, int);
 180 extern int xvfs_showargs(bhv_desc_t *, struct sbuf *);
 181 extern int xvfs_unmount(bhv_desc_t *, int, struct cred *);
 182 extern int xvfs_mntupdate(bhv_desc_t *, int *, struct xfs_mount_args *);
 183 extern int xvfs_root(bhv_desc_t *, struct xfs_vnode **);
 184 extern int xvfs_statvfs(bhv_desc_t *, xfs_statfs_t *, struct xfs_vnode *);
 185 extern int xvfs_sync(bhv_desc_t *, int, struct cred *);
 186 extern int xvfs_vget(bhv_desc_t *, struct xfs_vnode **, struct fid *);
 187 extern int xvfs_dmapiops(bhv_desc_t *, caddr_t);
 188 extern int xvfs_quotactl(bhv_desc_t *, int, int, caddr_t);
 189 extern struct inode *xvfs_get_inode(bhv_desc_t *, xfs_ino_t, int);
 190 extern void xvfs_init_vnode(bhv_desc_t *, struct xfs_vnode *, bhv_desc_t *, int);
 191 extern void xvfs_force_shutdown(bhv_desc_t *, int, char *, int);
 192
 193 #define XFS_DMOPS               "xfs_dm_operations"     /* Data Migration */
 194 #define XFS_QMOPS               "xfs_qm_operations"     /* Quota Manager  */
 195 #define XFS_IOOPS               "xfs_io_operations"     /* I/O subsystem  */
 196 #define XFS_DM_MODULE           "xfs_dmapi"
 197 #define XFS_QM_MODULE           "xfs_quota"
 198 #define XFS_IO_MODULE           "xfs_ioops"
 199
 200 typedef struct bhv_vfsops {
 201         struct xvfsops          bhv_common;
 202         void *                  bhv_custom;
 203 } bhv_vfsops_t;
 204
 205 typedef struct bhv_module {
 206         bhv_desc_t              bm_desc;
 207         const char *            bm_name;
 208         bhv_vfsops_t *          bm_ops;
 209 } bhv_module_t;
 210
 211 #define vfs_bhv_lookup(v, id)   ( bhv_lookup_range(&(v)->vfs_bh, (id), (id)) )
 212 #define vfs_bhv_custom(b)       ( ((bhv_vfsops_t *)BHV_OPS(b))->bhv_custom )
 213 #define vfs_bhv_set_custom(b,o) ( (b)->bhv_custom = (void *)(o))
 214 #define vfs_bhv_clr_custom(b)   ( (b)->bhv_custom = NULL )
 215
 216 extern xfs_vfs_t *vfs_allocate(struct mount *);
 217 extern void vfs_deallocate(xfs_vfs_t *);
 218 extern void vfs_insertops(xfs_vfs_t *, bhv_vfsops_t *);
 219 extern void vfs_insertbhv(xfs_vfs_t *, bhv_desc_t *, xvfsops_t *, void *);
 220
 221 #define bhv_lookup_module(n,m)  ( (m) ? \
 222                                 inter_module_get_request(n, m) : \
 223                                 inter_module_get(n) )
 224 #define bhv_remove_module(n)    inter_module_put(n)
 225 #define bhv_module_init(n,m,op) inter_module_register(n,m,op)
 226 #define bhv_module_exit(n)      inter_module_unregister(n)
 227
 228 extern void bhv_insert_all_vfsops(struct xfs_vfs *);
 229 extern void bhv_remove_all_vfsops(struct xfs_vfs *, int);
 230 extern void bhv_remove_vfsops(struct xfs_vfs *, int);
 231
 232 #endif  /* __XFS_VFS_H__ */