sys/contrib/openzfs/include/os/freebsd/zfs/sys/zfs_vfsops_os.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 #if __FreeBSD_version >= 1300109
  31 #define TEARDOWN_INACTIVE_RMS
  32 #endif
  33
  34 #include <sys/dataset_kstats.h>
  35 #include <sys/list.h>
  36 #include <sys/vfs.h>
  37 #include <sys/zil.h>
  38 #include <sys/sa.h>
  39 #include <sys/rrwlock.h>
  40 #ifdef TEARDOWN_INACTIVE_RMS
  41 #include <sys/rmlock.h>
  42 #endif
  43 #include <sys/zfs_ioctl.h>
  44
  45 #ifdef  __cplusplus
  46 extern "C" {
  47 #endif
  48
  49 #ifdef TEARDOWN_INACTIVE_RMS
  50 typedef struct rmslock zfs_teardown_lock_t;
  51 #else
  52 #define zfs_teardown_lock_t krwlock_t
  53 #endif
  54
  55 typedef struct zfsvfs zfsvfs_t;
  56 struct znode;
  57
  58 struct zfsvfs {
  59         vfs_t           *z_vfs;         /* generic fs struct */
  60         zfsvfs_t        *z_parent;      /* parent fs */
  61         objset_t        *z_os;          /* objset reference */
  62         uint64_t        z_flags;        /* super_block flags */
  63         uint64_t        z_root;         /* id of root znode */
  64         uint64_t        z_unlinkedobj;  /* id of unlinked zapobj */
  65         uint64_t        z_max_blksz;    /* maximum block size for files */
  66         uint64_t        z_fuid_obj;     /* fuid table object number */
  67         uint64_t        z_fuid_size;    /* fuid table size */
  68         avl_tree_t      z_fuid_idx;     /* fuid tree keyed by index */
  69         avl_tree_t      z_fuid_domain;  /* fuid tree keyed by domain */
  70         krwlock_t       z_fuid_lock;    /* fuid lock */
  71         boolean_t       z_fuid_loaded;  /* fuid tables are loaded */
  72         boolean_t       z_fuid_dirty;   /* need to sync fuid table ? */
  73         struct zfs_fuid_info    *z_fuid_replay; /* fuid info for replay */
  74         zilog_t         *z_log;         /* intent log pointer */
  75         uint_t          z_acl_type;     /* type of acl usable on this fs */
  76         uint_t          z_acl_mode;     /* acl chmod/mode behavior */
  77         uint_t          z_acl_inherit;  /* acl inheritance behavior */
  78         zfs_case_t      z_case;         /* case-sense */
  79         boolean_t       z_utf8;         /* utf8-only */
  80         int             z_norm;         /* normalization flags */
  81         boolean_t       z_atime;        /* enable atimes mount option */
  82         boolean_t       z_unmounted;    /* unmounted */
  83         rrmlock_t       z_teardown_lock;
  84         zfs_teardown_lock_t z_teardown_inactive_lock;
  85         list_t          z_all_znodes;   /* all vnodes in the fs */
  86         uint64_t        z_nr_znodes;    /* number of znodes in the fs */
  87         kmutex_t        z_znodes_lock;  /* lock for z_all_znodes */
  88         struct zfsctl_root      *z_ctldir;      /* .zfs directory pointer */
  89         boolean_t       z_show_ctldir;  /* expose .zfs in the root dir */
  90         boolean_t       z_issnap;       /* true if this is a snapshot */
  91         boolean_t       z_vscan;        /* virus scan on/off */
  92         boolean_t       z_use_fuids;    /* version allows fuids */
  93         boolean_t       z_replay;       /* set during ZIL replay */
  94         boolean_t       z_use_sa;       /* version allow system attributes */
  95         boolean_t       z_xattr_sa;     /* allow xattrs to be stores as SA */
  96         boolean_t       z_use_namecache; /* make use of FreeBSD name cache */
  97         uint8_t         z_xattr;        /* xattr type in use */
  98         uint64_t        z_version;      /* ZPL version */
  99         uint64_t        z_shares_dir;   /* hidden shares dir */
 100         dataset_kstats_t        z_kstat;        /* fs kstats */
 101         kmutex_t        z_lock;
 102         uint64_t        z_userquota_obj;
 103         uint64_t        z_groupquota_obj;
 104         uint64_t        z_userobjquota_obj;
 105         uint64_t        z_groupobjquota_obj;
 106         uint64_t        z_projectquota_obj;
 107         uint64_t        z_projectobjquota_obj;
 108         uint64_t        z_replay_eof;   /* New end of file - replay only */
 109         sa_attr_type_t  *z_attr_table;  /* SA attr mapping->id */
 110 #define ZFS_OBJ_MTX_SZ  64
 111         kmutex_t        z_hold_mtx[ZFS_OBJ_MTX_SZ];     /* znode hold locks */
 112         struct task     z_unlinked_drain_task;
 113 };
 114
 115 #ifdef TEARDOWN_INACTIVE_RMS
 116 #define ZFS_INIT_TEARDOWN_INACTIVE(zfsvfs)      \
 117         rms_init(&(zfsvfs)->z_teardown_inactive_lock, "zfs teardown inactive")
 118
 119 #define ZFS_DESTROY_TEARDOWN_INACTIVE(zfsvfs)   \
 120         rms_destroy(&(zfsvfs)->z_teardown_inactive_lock)
 121
 122 #define ZFS_TRYRLOCK_TEARDOWN_INACTIVE(zfsvfs)  \
 123         rms_try_rlock(&(zfsvfs)->z_teardown_inactive_lock)
 124
 125 #define ZFS_RLOCK_TEARDOWN_INACTIVE(zfsvfs)     \
 126         rms_rlock(&(zfsvfs)->z_teardown_inactive_lock)
 127
 128 #define ZFS_RUNLOCK_TEARDOWN_INACTIVE(zfsvfs)   \
 129         rms_runlock(&(zfsvfs)->z_teardown_inactive_lock)
 130
 131 #define ZFS_WLOCK_TEARDOWN_INACTIVE(zfsvfs)     \
 132         rms_wlock(&(zfsvfs)->z_teardown_inactive_lock)
 133
 134 #define ZFS_WUNLOCK_TEARDOWN_INACTIVE(zfsvfs)   \
 135         rms_wunlock(&(zfsvfs)->z_teardown_inactive_lock)
 136
 137 #define ZFS_TEARDOWN_INACTIVE_WLOCKED(zfsvfs)   \
 138         rms_wowned(&(zfsvfs)->z_teardown_inactive_lock)
 139 #else
 140 #define ZFS_INIT_TEARDOWN_INACTIVE(zfsvfs)      \
 141         rw_init(&(zfsvfs)->z_teardown_inactive_lock, NULL, RW_DEFAULT, NULL)
 142
 143 #define ZFS_DESTROY_TEARDOWN_INACTIVE(zfsvfs)   \
 144         rw_destroy(&(zfsvfs)->z_teardown_inactive_lock)
 145
 146 #define ZFS_TRYRLOCK_TEARDOWN_INACTIVE(zfsvfs)  \
 147         rw_tryenter(&(zfsvfs)->z_teardown_inactive_lock, RW_READER)
 148
 149 #define ZFS_RLOCK_TEARDOWN_INACTIVE(zfsvfs)     \
 150         rw_enter(&(zfsvfs)->z_teardown_inactive_lock, RW_READER)
 151
 152 #define ZFS_RUNLOCK_TEARDOWN_INACTIVE(zfsvfs)   \
 153         rw_exit(&(zfsvfs)->z_teardown_inactive_lock)
 154
 155 #define ZFS_WLOCK_TEARDOWN_INACTIVE(zfsvfs)     \
 156         rw_enter(&(zfsvfs)->z_teardown_inactive_lock, RW_WRITER)
 157
 158 #define ZFS_WUNLOCK_TEARDOWN_INACTIVE(zfsvfs)   \
 159         rw_exit(&(zfsvfs)->z_teardown_inactive_lock)
 160
 161 #define ZFS_TEARDOWN_INACTIVE_WLOCKED(zfsvfs)   \
 162         RW_WRITE_HELD(&(zfsvfs)->z_teardown_inactive_lock)
 163 #endif
 164
 165 #define ZSB_XATTR       0x0001          /* Enable user xattrs */
 166 /*
 167  * Normal filesystems (those not under .zfs/snapshot) have a total
 168  * file ID size limited to 12 bytes (including the length field) due to
 169  * NFSv2 protocol's limitation of 32 bytes for a filehandle.  For historical
 170  * reasons, this same limit is being imposed by the Solaris NFSv3 implementation
 171  * (although the NFSv3 protocol actually permits a maximum of 64 bytes).  It
 172  * is not possible to expand beyond 12 bytes without abandoning support
 173  * of NFSv2.
 174  *
 175  * For normal filesystems, we partition up the available space as follows:
 176  *      2 bytes         fid length (required)
 177  *      6 bytes         object number (48 bits)
 178  *      4 bytes         generation number (32 bits)
 179  *
 180  * We reserve only 48 bits for the object number, as this is the limit
 181  * currently defined and imposed by the DMU.
 182  */
 183 typedef struct zfid_short {
 184         uint16_t        zf_len;
 185         uint8_t         zf_object[6];           /* obj[i] = obj >> (8 * i) */
 186         uint8_t         zf_gen[4];              /* gen[i] = gen >> (8 * i) */
 187 } zfid_short_t;
 188
 189 /*
 190  * Filesystems under .zfs/snapshot have a total file ID size of 22[*] bytes
 191  * (including the length field).  This makes files under .zfs/snapshot
 192  * accessible by NFSv3 and NFSv4, but not NFSv2.
 193  *
 194  * For files under .zfs/snapshot, we partition up the available space
 195  * as follows:
 196  *      2 bytes         fid length (required)
 197  *      6 bytes         object number (48 bits)
 198  *      4 bytes         generation number (32 bits)
 199  *      6 bytes         objset id (48 bits)
 200  *      4 bytes[**]     currently just zero (32 bits)
 201  *
 202  * We reserve only 48 bits for the object number and objset id, as these are
 203  * the limits currently defined and imposed by the DMU.
 204  *
 205  * [*] 20 bytes on FreeBSD to fit into the size of struct fid.
 206  * [**] 2 bytes on FreeBSD for the above reason.
 207  */
 208 typedef struct zfid_long {
 209         zfid_short_t    z_fid;
 210         uint8_t         zf_setid[6];            /* obj[i] = obj >> (8 * i) */
 211         uint8_t         zf_setgen[2];           /* gen[i] = gen >> (8 * i) */
 212 } zfid_long_t;
 213
 214 #define SHORT_FID_LEN   (sizeof (zfid_short_t) - sizeof (uint16_t))
 215 #define LONG_FID_LEN    (sizeof (zfid_long_t) - sizeof (uint16_t))
 216
 217 extern uint_t zfs_fsyncer_key;
 218 extern int zfs_super_owner;
 219
 220 extern void zfs_init(void);
 221 extern void zfs_fini(void);
 222
 223 extern int zfs_suspend_fs(zfsvfs_t *zfsvfs);
 224 extern int zfs_resume_fs(zfsvfs_t *zfsvfs, struct dsl_dataset *ds);
 225 extern int zfs_end_fs(zfsvfs_t *zfsvfs, struct dsl_dataset *ds);
 226 extern int zfs_set_version(zfsvfs_t *zfsvfs, uint64_t newvers);
 227 extern int zfsvfs_create(const char *name, boolean_t readonly, zfsvfs_t **zfvp);
 228 extern int zfsvfs_create_impl(zfsvfs_t **zfvp, zfsvfs_t *zfsvfs, objset_t *os);
 229 extern void zfsvfs_free(zfsvfs_t *zfsvfs);
 230 extern int zfs_check_global_label(const char *dsname, const char *hexsl);
 231 extern boolean_t zfs_is_readonly(zfsvfs_t *zfsvfs);
 232 extern int zfs_get_temporary_prop(struct dsl_dataset *ds, zfs_prop_t zfs_prop,
 233     uint64_t *val, char *setpoint);
 234 extern int zfs_busy(void);
 235
 236 #ifdef  __cplusplus
 237 }
 238 #endif
 239
 240 #endif  /* _SYS_FS_ZFS_VFSOPS_H */