1 // SPDX-License-Identifier: CDDL-1.0 2 /* 3 * CDDL HEADER START 4 * 5 * The contents of this file are subject to the terms of the 6 * Common Development and Distribution License (the "License"). 7 * You may not use this file except in compliance with the License. 8 * 9 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 10 * or https://opensource.org/licenses/CDDL-1.0. 11 * See the License for the specific language governing permissions 12 * and limitations under the License. 13 * 14 * When distributing Covered Code, include this CDDL HEADER in each 15 * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 16 * If applicable, add the following below this CDDL HEADER, with the 17 * fields enclosed by brackets "[]" replaced with your own identifying 18 * information: Portions Copyright [yyyy] [name of copyright owner] 19 * 20 * CDDL HEADER END 21 */ 22 /* 23 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved. 24 * Copyright (c) 2013, 2018 by Delphix. All rights reserved. 25 * Copyright (c) 2026, TrueNAS. 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/isa_defs.h> 33 #include <sys/types32.h> 34 #include <sys/list.h> 35 #include <sys/vfs.h> 36 #include <sys/zil.h> 37 #include <sys/sa.h> 38 #include <sys/rrwlock.h> 39 #include <sys/dsl_dataset.h> 40 #include <sys/zfs_ioctl.h> 41 #include <sys/objlist.h> 42 43 #ifdef __cplusplus 44 extern "C" { 45 #endif 46 47 typedef struct zfsvfs zfsvfs_t; 48 struct znode; 49 50 /* 51 * This structure emulates the vfs_t from other platforms. It's purpose 52 * is to facilitate the handling of mount options and minimize structural 53 * differences between the platforms. 54 */ 55 typedef struct vfs { 56 struct zfsvfs *vfs_data; 57 char *vfs_mntpoint; /* Primary mount point */ 58 uint64_t vfs_xattr; 59 boolean_t vfs_readonly; 60 boolean_t vfs_do_readonly; 61 boolean_t vfs_setuid; 62 boolean_t vfs_do_setuid; 63 boolean_t vfs_exec; 64 boolean_t vfs_do_exec; 65 boolean_t vfs_devices; 66 boolean_t vfs_do_devices; 67 boolean_t vfs_do_xattr; 68 boolean_t vfs_atime; 69 boolean_t vfs_do_atime; 70 boolean_t vfs_relatime; 71 boolean_t vfs_do_relatime; 72 boolean_t vfs_nbmand; 73 boolean_t vfs_do_nbmand; 74 kmutex_t vfs_mntpt_lock; 75 } vfs_t; 76 77 struct zfsvfs { 78 vfs_t *z_vfs; /* generic fs struct */ 79 struct super_block *z_sb; /* generic super_block */ 80 struct zfsvfs *z_parent; /* parent fs */ 81 objset_t *z_os; /* objset reference */ 82 uint64_t z_flags; /* super_block flags */ 83 uint64_t z_root; /* id of root znode */ 84 uint64_t z_unlinkedobj; /* id of unlinked zapobj */ 85 uint64_t z_max_blksz; /* maximum block size for files */ 86 uint64_t z_fuid_obj; /* fuid table object number */ 87 uint64_t z_fuid_size; /* fuid table size */ 88 avl_tree_t z_fuid_idx; /* fuid tree keyed by index */ 89 avl_tree_t z_fuid_domain; /* fuid tree keyed by domain */ 90 krwlock_t z_fuid_lock; /* fuid lock */ 91 boolean_t z_fuid_loaded; /* fuid tables are loaded */ 92 boolean_t z_fuid_dirty; /* need to sync fuid table ? */ 93 struct zfs_fuid_info *z_fuid_replay; /* fuid info for replay */ 94 zilog_t *z_log; /* intent log pointer */ 95 uint_t z_acl_mode; /* acl chmod/mode behavior */ 96 uint_t z_acl_inherit; /* acl inheritance behavior */ 97 uint_t z_acl_type; /* type of ACL usable on this FS */ 98 zfs_case_t z_case; /* case-sense */ 99 boolean_t z_utf8; /* utf8-only */ 100 int z_norm; /* normalization flags */ 101 boolean_t z_relatime; /* enable relatime mount option */ 102 boolean_t z_unmounted; /* unmounted */ 103 rrmlock_t z_teardown_lock; 104 krwlock_t z_teardown_inactive_lock; 105 list_t z_all_znodes; /* all znodes in the fs */ 106 unsigned long z_rollback_time; /* last online rollback time */ 107 unsigned long z_snap_defer_time; /* last snapshot unmount deferral */ 108 kmutex_t z_znodes_lock; /* lock for z_all_znodes */ 109 arc_prune_t *z_arc_prune; /* called by ARC to prune caches */ 110 struct inode *z_ctldir; /* .zfs directory inode */ 111 uint_t z_show_ctldir; /* how to expose .zfs in the root dir */ 112 boolean_t z_issnap; /* true if this is a snapshot */ 113 boolean_t z_use_fuids; /* version allows fuids */ 114 boolean_t z_replay; /* set during ZIL replay */ 115 boolean_t z_use_sa; /* version allow system attributes */ 116 boolean_t z_xattr_sa; /* allow xattrs to be stores as SA */ 117 boolean_t z_draining; /* is true when drain is active */ 118 boolean_t z_drain_cancel; /* signal the unlinked drain to stop */ 119 boolean_t z_longname; /* Dataset supports long names */ 120 uint64_t z_version; /* ZPL version */ 121 uint64_t z_shares_dir; /* hidden shares dir */ 122 dataset_kstats_t z_kstat; /* fs kstats */ 123 kmutex_t z_lock; 124 uint64_t z_userquota_obj; 125 uint64_t z_groupquota_obj; 126 uint64_t z_userobjquota_obj; 127 uint64_t z_groupobjquota_obj; 128 uint64_t z_projectquota_obj; 129 uint64_t z_projectobjquota_obj; 130 uint64_t z_defaultuserquota; 131 uint64_t z_defaultgroupquota; 132 uint64_t z_defaultprojectquota; 133 uint64_t z_defaultuserobjquota; 134 uint64_t z_defaultgroupobjquota; 135 uint64_t z_defaultprojectobjquota; 136 uint64_t z_replay_eof; /* New end of file - replay only */ 137 sa_attr_type_t *z_attr_table; /* SA attr mapping->id */ 138 uint64_t z_hold_size; /* znode hold array size */ 139 avl_tree_t *z_hold_trees; /* znode hold trees */ 140 kmutex_t *z_hold_locks; /* znode hold locks */ 141 taskqid_t z_drain_task; /* task id for the unlink drain task */ 142 }; 143 144 #define ZFS_TEARDOWN_INIT(zfsvfs) \ 145 rrm_init(&(zfsvfs)->z_teardown_lock, B_FALSE) 146 147 #define ZFS_TEARDOWN_DESTROY(zfsvfs) \ 148 rrm_destroy(&(zfsvfs)->z_teardown_lock) 149 150 #define ZFS_TEARDOWN_ENTER_READ(zfsvfs, tag) \ 151 rrm_enter_read(&(zfsvfs)->z_teardown_lock, tag); 152 153 #define ZFS_TEARDOWN_EXIT_READ(zfsvfs, tag) \ 154 rrm_exit(&(zfsvfs)->z_teardown_lock, tag) 155 156 #define ZFS_TEARDOWN_ENTER_WRITE(zfsvfs, tag) \ 157 rrm_enter(&(zfsvfs)->z_teardown_lock, RW_WRITER, tag) 158 159 #define ZFS_TEARDOWN_EXIT_WRITE(zfsvfs) \ 160 rrm_exit(&(zfsvfs)->z_teardown_lock, tag) 161 162 #define ZFS_TEARDOWN_EXIT(zfsvfs, tag) \ 163 rrm_exit(&(zfsvfs)->z_teardown_lock, tag) 164 165 #define ZFS_TEARDOWN_READ_HELD(zfsvfs) \ 166 RRM_READ_HELD(&(zfsvfs)->z_teardown_lock) 167 168 #define ZFS_TEARDOWN_WRITE_HELD(zfsvfs) \ 169 RRM_WRITE_HELD(&(zfsvfs)->z_teardown_lock) 170 171 #define ZFS_TEARDOWN_HELD(zfsvfs) \ 172 RRM_LOCK_HELD(&(zfsvfs)->z_teardown_lock) 173 174 #define ZSB_XATTR 0x0001 /* Enable user xattrs */ 175 176 /* 177 * Allow a maximum number of links. While ZFS does not internally limit 178 * this the inode->i_nlink member is defined as an unsigned int. To be 179 * safe we use 2^31-1 as the limit. 180 */ 181 #define ZFS_LINK_MAX ((1U << 31) - 1U) 182 183 /* 184 * Normal filesystems (those not under .zfs/snapshot) have a total 185 * file ID size limited to 12 bytes (including the length field) due to 186 * NFSv2 protocol's limitation of 32 bytes for a filehandle. For historical 187 * reasons, this same limit is being imposed by the Solaris NFSv3 implementation 188 * (although the NFSv3 protocol actually permits a maximum of 64 bytes). It 189 * is not possible to expand beyond 12 bytes without abandoning support 190 * of NFSv2. 191 * 192 * For normal filesystems, we partition up the available space as follows: 193 * 2 bytes fid length (required) 194 * 6 bytes object number (48 bits) 195 * 4 bytes generation number (32 bits) 196 * 197 * We reserve only 48 bits for the object number, as this is the limit 198 * currently defined and imposed by the DMU. 199 */ 200 typedef struct zfid_short { 201 uint16_t zf_len; 202 uint8_t zf_object[6]; /* obj[i] = obj >> (8 * i) */ 203 uint8_t zf_gen[4]; /* gen[i] = gen >> (8 * i) */ 204 } zfid_short_t; 205 206 /* 207 * Filesystems under .zfs/snapshot have a total file ID size of 22 bytes 208 * (including the length field). This makes files under .zfs/snapshot 209 * accessible by NFSv3 and NFSv4, but not NFSv2. 210 * 211 * For files under .zfs/snapshot, we partition up the available space 212 * as follows: 213 * 2 bytes fid length (required) 214 * 6 bytes object number (48 bits) 215 * 4 bytes generation number (32 bits) 216 * 6 bytes objset id (48 bits) 217 * 4 bytes currently just zero (32 bits) 218 * 219 * We reserve only 48 bits for the object number and objset id, as these are 220 * the limits currently defined and imposed by the DMU. 221 */ 222 typedef struct zfid_long { 223 zfid_short_t z_fid; 224 uint8_t zf_setid[6]; /* obj[i] = obj >> (8 * i) */ 225 uint8_t zf_setgen[4]; /* gen[i] = gen >> (8 * i) */ 226 } zfid_long_t; 227 228 #define SHORT_FID_LEN (sizeof (zfid_short_t) - sizeof (uint16_t)) 229 #define LONG_FID_LEN (sizeof (zfid_long_t) - sizeof (uint16_t)) 230 231 extern void zfs_init(void); 232 extern void zfs_fini(void); 233 234 extern int zfs_suspend_fs(zfsvfs_t *zfsvfs); 235 extern int zfs_resume_fs(zfsvfs_t *zfsvfs, struct dsl_dataset *ds); 236 extern int zfs_end_fs(zfsvfs_t *zfsvfs, struct dsl_dataset *ds); 237 extern void zfs_exit_fs(zfsvfs_t *zfsvfs); 238 extern int zfs_set_version(zfsvfs_t *zfsvfs, uint64_t newvers); 239 extern int zfsvfs_create(const char *name, boolean_t readony, zfsvfs_t **zfvp); 240 extern int zfsvfs_create_impl(zfsvfs_t **zfvp, zfsvfs_t *zfsvfs, objset_t *os); 241 extern void zfsvfs_free(zfsvfs_t *zfsvfs); 242 extern int zfs_check_global_label(const char *dsname, const char *hexsl); 243 244 extern vfs_t *zfsvfs_vfs_alloc(void); 245 extern void zfsvfs_vfs_free(vfs_t *vfsp); 246 247 extern boolean_t zfs_is_readonly(zfsvfs_t *zfsvfs); 248 extern int zfs_domount(struct super_block *sb, const char *osname, 249 vfs_t *mntopts, int silent); 250 extern void zfs_preumount(struct super_block *sb); 251 extern int zfs_umount(struct super_block *sb); 252 extern int zfs_remount(struct super_block *sb, vfs_t *mntopts, int flags); 253 extern int zfs_statvfs(struct inode *ip, struct kstatfs *statp); 254 extern int zfs_vget(struct super_block *sb, struct inode **ipp, fid_t *fidp); 255 extern int zfs_prune(struct super_block *sb, unsigned long nr_to_scan, 256 int *objects); 257 extern int zfs_get_temporary_prop(dsl_dataset_t *ds, zfs_prop_t zfs_prop, 258 uint64_t *val, char *setpoint); 259 extern int zfs_set_default_quota(zfsvfs_t *zfsvfs, zfs_prop_t zfs_prop, 260 uint64_t quota); 261 262 #ifdef __cplusplus 263 } 264 #endif 265 266 #endif /* _SYS_FS_ZFS_VFSOPS_H */ 267