sys/cddl/contrib/opensolaris/uts/common/fs/zfs/sys/zfs_vfsops.h

   1 /*
   2  * CDDL HEADER START
   3  *
   4  * The contents of this file are subject to the terms of the
   5  * Common Development and Distribution License (the "License").
   6  * You may not use this file except in compliance with the License.
   7  *
   8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
   9  * or http://www.opensolaris.org/os/licensing.
  10  * See the License for the specific language governing permissions
  11  * and limitations under the License.
  12  *
  13  * When distributing Covered Code, include this CDDL HEADER in each
  14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  15  * If applicable, add the following below this CDDL HEADER, with the
  16  * fields enclosed by brackets "[]" replaced with your own identifying
  17  * information: Portions Copyright [yyyy] [name of copyright owner]
  18  *
  19  * CDDL HEADER END
  20  */
  21 /*
  22  * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
  23  * Copyright (c) 2011 Pawel Jakub Dawidek <pawel@dawidek.net>.
  24  * All rights reserved.
  25  */
  26
  27 #ifndef _SYS_FS_ZFS_VFSOPS_H
  28 #define _SYS_FS_ZFS_VFSOPS_H
  29
  30 #include <sys/list.h>
  31 #include <sys/vfs.h>
  32 #include <sys/zil.h>
  33 #include <sys/sa.h>
  34 #include <sys/rrwlock.h>
  35 #include <sys/zfs_ioctl.h>
  36 #include <sys/rmlock.h>
  37
  38 #ifdef  __cplusplus
  39 extern "C" {
  40 #endif
  41
  42 typedef struct zfsvfs zfsvfs_t;
  43 struct znode;
  44
  45 struct zfsvfs {
  46         vfs_t           *z_vfs;         /* generic fs struct */
  47         zfsvfs_t        *z_parent;      /* parent fs */
  48         objset_t        *z_os;          /* objset reference */
  49         uint64_t        z_root;         /* id of root znode */
  50         uint64_t        z_unlinkedobj;  /* id of unlinked zapobj */
  51         uint64_t        z_max_blksz;    /* maximum block size for files */
  52         uint64_t        z_fuid_obj;     /* fuid table object number */
  53         uint64_t        z_fuid_size;    /* fuid table size */
  54         avl_tree_t      z_fuid_idx;     /* fuid tree keyed by index */
  55         avl_tree_t      z_fuid_domain;  /* fuid tree keyed by domain */
  56         krwlock_t       z_fuid_lock;    /* fuid lock */
  57         boolean_t       z_fuid_loaded;  /* fuid tables are loaded */
  58         boolean_t       z_fuid_dirty;   /* need to sync fuid table ? */
  59         struct zfs_fuid_info    *z_fuid_replay; /* fuid info for replay */
  60         zilog_t         *z_log;         /* intent log pointer */
  61         uint_t          z_acl_mode;     /* acl chmod/mode behavior */
  62         uint_t          z_acl_inherit;  /* acl inheritance behavior */
  63         zfs_case_t      z_case;         /* case-sense */
  64         boolean_t       z_utf8;         /* utf8-only */
  65         int             z_norm;         /* normalization flags */
  66         boolean_t       z_atime;        /* enable atimes mount option */
  67         boolean_t       z_unmounted;    /* unmounted */
  68         rrmlock_t       z_teardown_lock;
  69         struct rmslock  z_teardown_inactive_lock;
  70         list_t          z_all_znodes;   /* all vnodes in the fs */
  71         kmutex_t        z_znodes_lock;  /* lock for z_all_znodes */
  72         struct zfsctl_root      *z_ctldir;      /* .zfs directory pointer */
  73         boolean_t       z_show_ctldir;  /* expose .zfs in the root dir */
  74         boolean_t       z_issnap;       /* true if this is a snapshot */
  75         boolean_t       z_vscan;        /* virus scan on/off */
  76         boolean_t       z_use_fuids;    /* version allows fuids */
  77         boolean_t       z_replay;       /* set during ZIL replay */
  78         boolean_t       z_use_sa;       /* version allow system attributes */
  79         boolean_t       z_use_namecache;/* make use of FreeBSD name cache */
  80         uint64_t        z_version;      /* ZPL version */
  81         uint64_t        z_shares_dir;   /* hidden shares dir */
  82         kmutex_t        z_lock;
  83         uint64_t        z_userquota_obj;
  84         uint64_t        z_groupquota_obj;
  85         uint64_t        z_replay_eof;   /* New end of file - replay only */
  86         sa_attr_type_t  *z_attr_table;  /* SA attr mapping->id */
  87 #define ZFS_OBJ_MTX_SZ  64
  88         kmutex_t        z_hold_mtx[ZFS_OBJ_MTX_SZ];     /* znode hold locks */
  89 #if defined(__FreeBSD__)
  90         struct task     z_unlinked_drain_task;
  91 #endif
  92 };
  93
  94 #define ZFS_TRYRLOCK_TEARDOWN_INACTIVE(zfsvfs) \
  95                 rms_try_rlock(&(zfsvfs)->z_teardown_inactive_lock)
  96
  97 #define ZFS_RLOCK_TEARDOWN_INACTIVE(zfsvfs) \
  98                 rms_rlock(&(zfsvfs)->z_teardown_inactive_lock)
  99
 100 #define ZFS_RUNLOCK_TEARDOWN_INACTIVE(zfsvfs) \
 101                 rms_runlock(&(zfsvfs)->z_teardown_inactive_lock)
 102
 103 #define ZFS_WLOCK_TEARDOWN_INACTIVE(zfsvfs) \
 104                 rms_wlock(&(zfsvfs)->z_teardown_inactive_lock)
 105
 106 #define ZFS_WUNLOCK_TEARDOWN_INACTIVE(zfsvfs) \
 107                 rms_wunlock(&(zfsvfs)->z_teardown_inactive_lock)
 108
 109 #define ZFS_TEARDOWN_INACTIVE_WLOCKED(zfsvfs) \
 110                 rms_wowned(&(zfsvfs)->z_teardown_inactive_lock)
 111
 112 /*
 113  * Normal filesystems (those not under .zfs/snapshot) have a total
 114  * file ID size limited to 12 bytes (including the length field) due to
 115  * NFSv2 protocol's limitation of 32 bytes for a filehandle.  For historical
 116  * reasons, this same limit is being imposed by the Solaris NFSv3 implementation
 117  * (although the NFSv3 protocol actually permits a maximum of 64 bytes).  It
 118  * is not possible to expand beyond 12 bytes without abandoning support
 119  * of NFSv2.
 120  *
 121  * For normal filesystems, we partition up the available space as follows:
 122  *      2 bytes         fid length (required)
 123  *      6 bytes         object number (48 bits)
 124  *      4 bytes         generation number (32 bits)
 125  *
 126  * We reserve only 48 bits for the object number, as this is the limit
 127  * currently defined and imposed by the DMU.
 128  */
 129 typedef struct zfid_short {
 130         uint16_t        zf_len;
 131         uint8_t         zf_object[6];           /* obj[i] = obj >> (8 * i) */
 132         uint8_t         zf_gen[4];              /* gen[i] = gen >> (8 * i) */
 133 } zfid_short_t;
 134
 135 /*
 136  * Filesystems under .zfs/snapshot have a total file ID size of 22[*] bytes
 137  * (including the length field).  This makes files under .zfs/snapshot
 138  * accessible by NFSv3 and NFSv4, but not NFSv2.
 139  *
 140  * For files under .zfs/snapshot, we partition up the available space
 141  * as follows:
 142  *      2 bytes         fid length (required)
 143  *      6 bytes         object number (48 bits)
 144  *      4 bytes         generation number (32 bits)
 145  *      6 bytes         objset id (48 bits)
 146  *      4 bytes[**]     currently just zero (32 bits)
 147  *
 148  * We reserve only 48 bits for the object number and objset id, as these are
 149  * the limits currently defined and imposed by the DMU.
 150  *
 151  * [*] 20 bytes on FreeBSD to fit into the size of struct fid.
 152  * [**] 2 bytes on FreeBSD for the above reason.
 153  */
 154 typedef struct zfid_long {
 155         zfid_short_t    z_fid;
 156         uint8_t         zf_setid[6];            /* obj[i] = obj >> (8 * i) */
 157         uint8_t         zf_setgen[2];           /* gen[i] = gen >> (8 * i) */
 158 } zfid_long_t;
 159
 160 #define SHORT_FID_LEN   (sizeof (zfid_short_t) - sizeof (uint16_t))
 161 #define LONG_FID_LEN    (sizeof (zfid_long_t) - sizeof (uint16_t))
 162
 163 extern uint_t zfs_fsyncer_key;
 164 extern int zfs_super_owner;
 165
 166 extern int zfs_suspend_fs(zfsvfs_t *zfsvfs);
 167 extern int zfs_resume_fs(zfsvfs_t *zfsvfs, struct dsl_dataset *ds);
 168 extern int zfs_userspace_one(zfsvfs_t *zfsvfs, zfs_userquota_prop_t type,
 169     const char *domain, uint64_t rid, uint64_t *valuep);
 170 extern int zfs_userspace_many(zfsvfs_t *zfsvfs, zfs_userquota_prop_t type,
 171     uint64_t *cookiep, void *vbuf, uint64_t *bufsizep);
 172 extern int zfs_set_userquota(zfsvfs_t *zfsvfs, zfs_userquota_prop_t type,
 173     const char *domain, uint64_t rid, uint64_t quota);
 174 extern boolean_t zfs_owner_overquota(zfsvfs_t *zfsvfs, struct znode *,
 175     boolean_t isgroup);
 176 extern boolean_t zfs_fuid_overquota(zfsvfs_t *zfsvfs, boolean_t isgroup,
 177     uint64_t fuid);
 178 extern int zfs_set_version(zfsvfs_t *zfsvfs, uint64_t newvers);
 179 extern int zfsvfs_create(const char *name, zfsvfs_t **zfvp);
 180 extern int zfsvfs_create_impl(zfsvfs_t **zfvp, zfsvfs_t *zfsvfs, objset_t *os);
 181 extern void zfsvfs_free(zfsvfs_t *zfsvfs);
 182 extern int zfs_check_global_label(const char *dsname, const char *hexsl);
 183
 184 #ifdef _KERNEL
 185 extern void zfsvfs_update_fromname(const char *oldname, const char *newname);
 186 #endif
 187
 188 #ifdef  __cplusplus
 189 }
 190 #endif
 191
 192 #endif  /* _SYS_FS_ZFS_VFSOPS_H */