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