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 https://opensource.org/licenses/CDDL-1.0. 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 */ 25 26 #ifndef _SYS_FS_ZFS_VFSOPS_H 27 #define _SYS_FS_ZFS_VFSOPS_H 28 29 #include <sys/dataset_kstats.h> 30 #include <sys/isa_defs.h> 31 #include <sys/types32.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/dsl_dataset.h> 38 #include <sys/zfs_ioctl.h> 39 #include <sys/objlist.h> 40 41 #ifdef __cplusplus 42 extern "C" { 43 #endif 44 45 typedef struct zfsvfs zfsvfs_t; 46 struct znode; 47 48 extern int zfs_bclone_enabled; 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 } vfs_t; 75 76 typedef struct zfs_mnt { 77 const char *mnt_osname; /* Objset name */ 78 char *mnt_data; /* Raw mount options */ 79 } zfs_mnt_t; 80 81 struct zfsvfs { 82 vfs_t *z_vfs; /* generic fs struct */ 83 struct super_block *z_sb; /* generic super_block */ 84 struct zfsvfs *z_parent; /* parent fs */ 85 objset_t *z_os; /* objset reference */ 86 uint64_t z_flags; /* super_block flags */ 87 uint64_t z_root; /* id of root znode */ 88 uint64_t z_unlinkedobj; /* id of unlinked zapobj */ 89 uint64_t z_max_blksz; /* maximum block size for files */ 90 uint64_t z_fuid_obj; /* fuid table object number */ 91 uint64_t z_fuid_size; /* fuid table size */ 92 avl_tree_t z_fuid_idx; /* fuid tree keyed by index */ 93 avl_tree_t z_fuid_domain; /* fuid tree keyed by domain */ 94 krwlock_t z_fuid_lock; /* fuid lock */ 95 boolean_t z_fuid_loaded; /* fuid tables are loaded */ 96 boolean_t z_fuid_dirty; /* need to sync fuid table ? */ 97 struct zfs_fuid_info *z_fuid_replay; /* fuid info for replay */ 98 zilog_t *z_log; /* intent log pointer */ 99 uint_t z_acl_mode; /* acl chmod/mode behavior */ 100 uint_t z_acl_inherit; /* acl inheritance behavior */ 101 uint_t z_acl_type; /* type of ACL usable on this FS */ 102 zfs_case_t z_case; /* case-sense */ 103 boolean_t z_utf8; /* utf8-only */ 104 int z_norm; /* normalization flags */ 105 boolean_t z_relatime; /* enable relatime mount option */ 106 boolean_t z_unmounted; /* unmounted */ 107 rrmlock_t z_teardown_lock; 108 krwlock_t z_teardown_inactive_lock; 109 list_t z_all_znodes; /* all znodes in the fs */ 110 unsigned long z_rollback_time; /* last online rollback time */ 111 unsigned long z_snap_defer_time; /* last snapshot unmount deferral */ 112 kmutex_t z_znodes_lock; /* lock for z_all_znodes */ 113 arc_prune_t *z_arc_prune; /* called by ARC to prune caches */ 114 struct inode *z_ctldir; /* .zfs directory inode */ 115 boolean_t z_show_ctldir; /* expose .zfs in the root dir */ 116 boolean_t z_issnap; /* true if this is a snapshot */ 117 boolean_t z_use_fuids; /* version allows fuids */ 118 boolean_t z_replay; /* set during ZIL replay */ 119 boolean_t z_use_sa; /* version allow system attributes */ 120 boolean_t z_xattr_sa; /* allow xattrs to be stores as SA */ 121 boolean_t z_draining; /* is true when drain is active */ 122 boolean_t z_drain_cancel; /* signal the unlinked drain to stop */ 123 uint64_t z_version; /* ZPL version */ 124 uint64_t z_shares_dir; /* hidden shares dir */ 125 dataset_kstats_t z_kstat; /* fs kstats */ 126 kmutex_t z_lock; 127 uint64_t z_userquota_obj; 128 uint64_t z_groupquota_obj; 129 uint64_t z_userobjquota_obj; 130 uint64_t z_groupobjquota_obj; 131 uint64_t z_projectquota_obj; 132 uint64_t z_projectobjquota_obj; 133 uint64_t z_replay_eof; /* New end of file - replay only */ 134 sa_attr_type_t *z_attr_table; /* SA attr mapping->id */ 135 uint64_t z_hold_size; /* znode hold array size */ 136 avl_tree_t *z_hold_trees; /* znode hold trees */ 137 kmutex_t *z_hold_locks; /* znode hold locks */ 138 taskqid_t z_drain_task; /* task id for the unlink drain task */ 139 }; 140 141 #define ZFS_TEARDOWN_INIT(zfsvfs) \ 142 rrm_init(&(zfsvfs)->z_teardown_lock, B_FALSE) 143 144 #define ZFS_TEARDOWN_DESTROY(zfsvfs) \ 145 rrm_destroy(&(zfsvfs)->z_teardown_lock) 146 147 #define ZFS_TEARDOWN_ENTER_READ(zfsvfs, tag) \ 148 rrm_enter_read(&(zfsvfs)->z_teardown_lock, tag); 149 150 #define ZFS_TEARDOWN_EXIT_READ(zfsvfs, tag) \ 151 rrm_exit(&(zfsvfs)->z_teardown_lock, tag) 152 153 #define ZFS_TEARDOWN_ENTER_WRITE(zfsvfs, tag) \ 154 rrm_enter(&(zfsvfs)->z_teardown_lock, RW_WRITER, tag) 155 156 #define ZFS_TEARDOWN_EXIT_WRITE(zfsvfs) \ 157 rrm_exit(&(zfsvfs)->z_teardown_lock, tag) 158 159 #define ZFS_TEARDOWN_EXIT(zfsvfs, tag) \ 160 rrm_exit(&(zfsvfs)->z_teardown_lock, tag) 161 162 #define ZFS_TEARDOWN_READ_HELD(zfsvfs) \ 163 RRM_READ_HELD(&(zfsvfs)->z_teardown_lock) 164 165 #define ZFS_TEARDOWN_WRITE_HELD(zfsvfs) \ 166 RRM_WRITE_HELD(&(zfsvfs)->z_teardown_lock) 167 168 #define ZFS_TEARDOWN_HELD(zfsvfs) \ 169 RRM_LOCK_HELD(&(zfsvfs)->z_teardown_lock) 170 171 #define ZSB_XATTR 0x0001 /* Enable user xattrs */ 172 173 /* 174 * Allow a maximum number of links. While ZFS does not internally limit 175 * this the inode->i_nlink member is defined as an unsigned int. To be 176 * safe we use 2^31-1 as the limit. 177 */ 178 #define ZFS_LINK_MAX ((1U << 31) - 1U) 179 180 /* 181 * Normal filesystems (those not under .zfs/snapshot) have a total 182 * file ID size limited to 12 bytes (including the length field) due to 183 * NFSv2 protocol's limitation of 32 bytes for a filehandle. For historical 184 * reasons, this same limit is being imposed by the Solaris NFSv3 implementation 185 * (although the NFSv3 protocol actually permits a maximum of 64 bytes). It 186 * is not possible to expand beyond 12 bytes without abandoning support 187 * of NFSv2. 188 * 189 * For normal filesystems, we partition up the available space as follows: 190 * 2 bytes fid length (required) 191 * 6 bytes object number (48 bits) 192 * 4 bytes generation number (32 bits) 193 * 194 * We reserve only 48 bits for the object number, as this is the limit 195 * currently defined and imposed by the DMU. 196 */ 197 typedef struct zfid_short { 198 uint16_t zf_len; 199 uint8_t zf_object[6]; /* obj[i] = obj >> (8 * i) */ 200 uint8_t zf_gen[4]; /* gen[i] = gen >> (8 * i) */ 201 } zfid_short_t; 202 203 /* 204 * Filesystems under .zfs/snapshot have a total file ID size of 22 bytes 205 * (including the length field). This makes files under .zfs/snapshot 206 * accessible by NFSv3 and NFSv4, but not NFSv2. 207 * 208 * For files under .zfs/snapshot, we partition up the available space 209 * as follows: 210 * 2 bytes fid length (required) 211 * 6 bytes object number (48 bits) 212 * 4 bytes generation number (32 bits) 213 * 6 bytes objset id (48 bits) 214 * 4 bytes currently just zero (32 bits) 215 * 216 * We reserve only 48 bits for the object number and objset id, as these are 217 * the limits currently defined and imposed by the DMU. 218 */ 219 typedef struct zfid_long { 220 zfid_short_t z_fid; 221 uint8_t zf_setid[6]; /* obj[i] = obj >> (8 * i) */ 222 uint8_t zf_setgen[4]; /* gen[i] = gen >> (8 * i) */ 223 } zfid_long_t; 224 225 #define SHORT_FID_LEN (sizeof (zfid_short_t) - sizeof (uint16_t)) 226 #define LONG_FID_LEN (sizeof (zfid_long_t) - sizeof (uint16_t)) 227 228 extern void zfs_init(void); 229 extern void zfs_fini(void); 230 231 extern int zfs_suspend_fs(zfsvfs_t *zfsvfs); 232 extern int zfs_resume_fs(zfsvfs_t *zfsvfs, struct dsl_dataset *ds); 233 extern int zfs_end_fs(zfsvfs_t *zfsvfs, struct dsl_dataset *ds); 234 extern void zfs_exit_fs(zfsvfs_t *zfsvfs); 235 extern int zfs_set_version(zfsvfs_t *zfsvfs, uint64_t newvers); 236 extern int zfsvfs_create(const char *name, boolean_t readony, zfsvfs_t **zfvp); 237 extern int zfsvfs_create_impl(zfsvfs_t **zfvp, zfsvfs_t *zfsvfs, objset_t *os); 238 extern void zfsvfs_free(zfsvfs_t *zfsvfs); 239 extern int zfs_check_global_label(const char *dsname, const char *hexsl); 240 241 extern boolean_t zfs_is_readonly(zfsvfs_t *zfsvfs); 242 extern int zfs_domount(struct super_block *sb, zfs_mnt_t *zm, int silent); 243 extern void zfs_preumount(struct super_block *sb); 244 extern int zfs_umount(struct super_block *sb); 245 extern int zfs_remount(struct super_block *sb, int *flags, zfs_mnt_t *zm); 246 extern int zfs_statvfs(struct inode *ip, struct kstatfs *statp); 247 extern int zfs_vget(struct super_block *sb, struct inode **ipp, fid_t *fidp); 248 extern int zfs_prune(struct super_block *sb, unsigned long nr_to_scan, 249 int *objects); 250 extern int zfs_get_temporary_prop(dsl_dataset_t *ds, zfs_prop_t zfs_prop, 251 uint64_t *val, char *setpoint); 252 253 #ifdef __cplusplus 254 } 255 #endif 256 257 #endif /* _SYS_FS_ZFS_VFSOPS_H */ 258