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 #include <sys/dataset_kstats.h>
  31 #include <sys/list.h>
  32 #include <sys/vfs.h>
  33 #include <sys/zil.h>
  34 #include <sys/sa.h>
  35 #include <sys/rrwlock.h>
  36 #include <sys/zfs_ioctl.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_flags;        /* super_block flags */
  50         uint64_t        z_root;         /* id of root znode */
  51         uint64_t        z_unlinkedobj;  /* id of unlinked zapobj */
  52         uint64_t        z_max_blksz;    /* maximum block size for files */
  53         uint64_t        z_fuid_obj;     /* fuid table object number */
  54         uint64_t        z_fuid_size;    /* fuid table size */
  55         avl_tree_t      z_fuid_idx;     /* fuid tree keyed by index */
  56         avl_tree_t      z_fuid_domain;  /* fuid tree keyed by domain */
  57         krwlock_t       z_fuid_lock;    /* fuid lock */
  58         boolean_t       z_fuid_loaded;  /* fuid tables are loaded */
  59         boolean_t       z_fuid_dirty;   /* need to sync fuid table ? */
  60         struct zfs_fuid_info    *z_fuid_replay; /* fuid info for replay */
  61         zilog_t         *z_log;         /* intent log pointer */
  62         uint_t          z_acl_mode;     /* acl chmod/mode behavior */
  63         uint_t          z_acl_inherit;  /* acl inheritance behavior */
  64         zfs_case_t      z_case;         /* case-sense */
  65         boolean_t       z_utf8;         /* utf8-only */
  66         int             z_norm;         /* normalization flags */
  67         boolean_t       z_atime;        /* enable atimes mount option */
  68         boolean_t       z_unmounted;    /* unmounted */
  69         rrmlock_t       z_teardown_lock;
  70         krwlock_t       z_teardown_inactive_lock;
  71         list_t          z_all_znodes;   /* all vnodes in the fs */
  72         uint64_t        z_nr_znodes;    /* number of znodes in the fs */
  73         kmutex_t        z_znodes_lock;  /* lock for z_all_znodes */
  74         struct zfsctl_root      *z_ctldir;      /* .zfs directory pointer */
  75         boolean_t       z_show_ctldir;  /* expose .zfs in the root dir */
  76         boolean_t       z_issnap;       /* true if this is a snapshot */
  77         boolean_t       z_vscan;        /* virus scan on/off */
  78         boolean_t       z_use_fuids;    /* version allows fuids */
  79         boolean_t       z_replay;       /* set during ZIL replay */
  80         boolean_t       z_use_sa;       /* version allow system attributes */
  81         boolean_t       z_xattr_sa;     /* allow xattrs to be stores as SA */
  82         boolean_t       z_use_namecache; /* make use of FreeBSD name cache */
  83         uint8_t         z_xattr;        /* xattr type in use */
  84         uint64_t        z_version;      /* ZPL version */
  85         uint64_t        z_shares_dir;   /* hidden shares dir */
  86         dataset_kstats_t        z_kstat;        /* fs kstats */
  87         kmutex_t        z_lock;
  88         uint64_t        z_userquota_obj;
  89         uint64_t        z_groupquota_obj;
  90         uint64_t        z_userobjquota_obj;
  91         uint64_t        z_groupobjquota_obj;
  92         uint64_t        z_projectquota_obj;
  93         uint64_t        z_projectobjquota_obj;
  94         uint64_t        z_replay_eof;   /* New end of file - replay only */
  95         sa_attr_type_t  *z_attr_table;  /* SA attr mapping->id */
  96 #define ZFS_OBJ_MTX_SZ  64
  97         kmutex_t        z_hold_mtx[ZFS_OBJ_MTX_SZ];     /* znode hold locks */
  98         struct task     z_unlinked_drain_task;
  99 };
 100
 101 #define ZSB_XATTR       0x0001          /* Enable user xattrs */
 102 /*
 103  * Normal filesystems (those not under .zfs/snapshot) have a total
 104  * file ID size limited to 12 bytes (including the length field) due to
 105  * NFSv2 protocol's limitation of 32 bytes for a filehandle.  For historical
 106  * reasons, this same limit is being imposed by the Solaris NFSv3 implementation
 107  * (although the NFSv3 protocol actually permits a maximum of 64 bytes).  It
 108  * is not possible to expand beyond 12 bytes without abandoning support
 109  * of NFSv2.
 110  *
 111  * For normal filesystems, we partition up the available space as follows:
 112  *      2 bytes         fid length (required)
 113  *      6 bytes         object number (48 bits)
 114  *      4 bytes         generation number (32 bits)
 115  *
 116  * We reserve only 48 bits for the object number, as this is the limit
 117  * currently defined and imposed by the DMU.
 118  */
 119 typedef struct zfid_short {
 120         uint16_t        zf_len;
 121         uint8_t         zf_object[6];           /* obj[i] = obj >> (8 * i) */
 122         uint8_t         zf_gen[4];              /* gen[i] = gen >> (8 * i) */
 123 } zfid_short_t;
 124
 125 /*
 126  * Filesystems under .zfs/snapshot have a total file ID size of 22[*] bytes
 127  * (including the length field).  This makes files under .zfs/snapshot
 128  * accessible by NFSv3 and NFSv4, but not NFSv2.
 129  *
 130  * For files under .zfs/snapshot, we partition up the available space
 131  * as follows:
 132  *      2 bytes         fid length (required)
 133  *      6 bytes         object number (48 bits)
 134  *      4 bytes         generation number (32 bits)
 135  *      6 bytes         objset id (48 bits)
 136  *      4 bytes[**]     currently just zero (32 bits)
 137  *
 138  * We reserve only 48 bits for the object number and objset id, as these are
 139  * the limits currently defined and imposed by the DMU.
 140  *
 141  * [*] 20 bytes on FreeBSD to fit into the size of struct fid.
 142  * [**] 2 bytes on FreeBSD for the above reason.
 143  */
 144 typedef struct zfid_long {
 145         zfid_short_t    z_fid;
 146         uint8_t         zf_setid[6];            /* obj[i] = obj >> (8 * i) */
 147         uint8_t         zf_setgen[2];           /* gen[i] = gen >> (8 * i) */
 148 } zfid_long_t;
 149
 150 #define SHORT_FID_LEN   (sizeof (zfid_short_t) - sizeof (uint16_t))
 151 #define LONG_FID_LEN    (sizeof (zfid_long_t) - sizeof (uint16_t))
 152
 153 extern uint_t zfs_fsyncer_key;
 154 extern int zfs_super_owner;
 155
 156 extern void zfs_init(void);
 157 extern void zfs_fini(void);
 158
 159 extern int zfs_suspend_fs(zfsvfs_t *zfsvfs);
 160 extern int zfs_resume_fs(zfsvfs_t *zfsvfs, struct dsl_dataset *ds);
 161 extern int zfs_end_fs(zfsvfs_t *zfsvfs, struct dsl_dataset *ds);
 162 extern int zfs_set_version(zfsvfs_t *zfsvfs, uint64_t newvers);
 163 extern int zfsvfs_create(const char *name, boolean_t readonly, zfsvfs_t **zfvp);
 164 extern int zfsvfs_create_impl(zfsvfs_t **zfvp, zfsvfs_t *zfsvfs, objset_t *os);
 165 extern void zfsvfs_free(zfsvfs_t *zfsvfs);
 166 extern int zfs_check_global_label(const char *dsname, const char *hexsl);
 167 extern boolean_t zfs_is_readonly(zfsvfs_t *zfsvfs);
 168 extern int zfs_get_temporary_prop(struct dsl_dataset *ds, zfs_prop_t zfs_prop,
 169     uint64_t *val, char *setpoint);
 170 extern int zfs_busy(void);
 171
 172 #ifdef  __cplusplus
 173 }
 174 #endif
 175
 176 #endif  /* _SYS_FS_ZFS_VFSOPS_H */