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) 2012, 2018 by Delphix. All rights reserved. 24 * Copyright 2016 Nexenta Systems, Inc. All rights reserved. 25 */ 26 27#ifndef _SYS_FS_ZFS_ZNODE_H 28#define _SYS_FS_ZFS_ZNODE_H 29 30#include <sys/zfs_acl.h> 31#include <sys/zil.h> 32#include <sys/zfs_project.h> 33 34#ifdef __cplusplus 35extern "C" { 36#endif 37 38/* 39 * Additional file level attributes, that are stored 40 * in the upper half of z_pflags 41 */ 42#define ZFS_READONLY 0x0000000100000000ull 43#define ZFS_HIDDEN 0x0000000200000000ull 44#define ZFS_SYSTEM 0x0000000400000000ull 45#define ZFS_ARCHIVE 0x0000000800000000ull 46#define ZFS_IMMUTABLE 0x0000001000000000ull 47#define ZFS_NOUNLINK 0x0000002000000000ull 48#define ZFS_APPENDONLY 0x0000004000000000ull 49#define ZFS_NODUMP 0x0000008000000000ull 50#define ZFS_OPAQUE 0x0000010000000000ull 51#define ZFS_AV_QUARANTINED 0x0000020000000000ull 52#define ZFS_AV_MODIFIED 0x0000040000000000ull 53#define ZFS_REPARSE 0x0000080000000000ull 54#define ZFS_OFFLINE 0x0000100000000000ull 55#define ZFS_SPARSE 0x0000200000000000ull 56 57/* 58 * PROJINHERIT attribute is used to indicate that the child object under the 59 * directory which has the PROJINHERIT attribute needs to inherit its parent 60 * project ID that is used by project quota. 61 */ 62#define ZFS_PROJINHERIT 0x0000400000000000ull 63 64/* 65 * PROJID attr is used internally to indicate that the object has project ID. 66 */ 67#define ZFS_PROJID 0x0000800000000000ull 68 69#define ZFS_ATTR_SET(zp, attr, value, pflags, tx) \ 70{ \ 71 if (value) \ 72 pflags |= attr; \ 73 else \ 74 pflags &= ~attr; \ 75 VERIFY(0 == sa_update(zp->z_sa_hdl, SA_ZPL_FLAGS(ZTOZSB(zp)), \ 76 &pflags, sizeof (pflags), tx)); \ 77} 78 79/* 80 * Define special zfs pflags 81 */ 82#define ZFS_XATTR 0x1 /* is an extended attribute */ 83#define ZFS_INHERIT_ACE 0x2 /* ace has inheritable ACEs */ 84#define ZFS_ACL_TRIVIAL 0x4 /* files ACL is trivial */ 85#define ZFS_ACL_OBJ_ACE 0x8 /* ACL has CMPLX Object ACE */ 86#define ZFS_ACL_PROTECTED 0x10 /* ACL protected */ 87#define ZFS_ACL_DEFAULTED 0x20 /* ACL should be defaulted */ 88#define ZFS_ACL_AUTO_INHERIT 0x40 /* ACL should be inherited */ 89#define ZFS_BONUS_SCANSTAMP 0x80 /* Scanstamp in bonus area */ 90#define ZFS_NO_EXECS_DENIED 0x100 /* exec was given to everyone */ 91 92#define SA_ZPL_ATIME(z) z->z_attr_table[ZPL_ATIME] 93#define SA_ZPL_MTIME(z) z->z_attr_table[ZPL_MTIME] 94#define SA_ZPL_CTIME(z) z->z_attr_table[ZPL_CTIME] 95#define SA_ZPL_CRTIME(z) z->z_attr_table[ZPL_CRTIME] 96#define SA_ZPL_GEN(z) z->z_attr_table[ZPL_GEN] 97#define SA_ZPL_DACL_ACES(z) z->z_attr_table[ZPL_DACL_ACES] 98#define SA_ZPL_XATTR(z) z->z_attr_table[ZPL_XATTR] 99#define SA_ZPL_SYMLINK(z) z->z_attr_table[ZPL_SYMLINK] 100#define SA_ZPL_RDEV(z) z->z_attr_table[ZPL_RDEV] 101#define SA_ZPL_SCANSTAMP(z) z->z_attr_table[ZPL_SCANSTAMP] 102#define SA_ZPL_UID(z) z->z_attr_table[ZPL_UID] 103#define SA_ZPL_GID(z) z->z_attr_table[ZPL_GID] 104#define SA_ZPL_PARENT(z) z->z_attr_table[ZPL_PARENT] 105#define SA_ZPL_LINKS(z) z->z_attr_table[ZPL_LINKS] 106#define SA_ZPL_MODE(z) z->z_attr_table[ZPL_MODE] 107#define SA_ZPL_DACL_COUNT(z) z->z_attr_table[ZPL_DACL_COUNT] 108#define SA_ZPL_FLAGS(z) z->z_attr_table[ZPL_FLAGS] 109#define SA_ZPL_SIZE(z) z->z_attr_table[ZPL_SIZE] 110#define SA_ZPL_ZNODE_ACL(z) z->z_attr_table[ZPL_ZNODE_ACL] 111#define SA_ZPL_DXATTR(z) z->z_attr_table[ZPL_DXATTR] 112#define SA_ZPL_PAD(z) z->z_attr_table[ZPL_PAD] 113#define SA_ZPL_PROJID(z) z->z_attr_table[ZPL_PROJID] 114 115/* 116 * Is ID ephemeral? 117 */ 118#define IS_EPHEMERAL(x) (x > MAXUID) 119 120/* 121 * Should we use FUIDs? 122 */ 123#define USE_FUIDS(version, os) (version >= ZPL_VERSION_FUID && \ 124 spa_version(dmu_objset_spa(os)) >= SPA_VERSION_FUID) 125#define USE_SA(version, os) (version >= ZPL_VERSION_SA && \ 126 spa_version(dmu_objset_spa(os)) >= SPA_VERSION_SA) 127 128#define MASTER_NODE_OBJ 1 129 130/* 131 * Special attributes for master node. 132 * "userquota@", "groupquota@" and "projectquota@" are also valid (from 133 * zfs_userquota_prop_prefixes[]). 134 */ 135#define ZFS_FSID "FSID" 136#define ZFS_UNLINKED_SET "DELETE_QUEUE" 137#define ZFS_ROOT_OBJ "ROOT" 138#define ZPL_VERSION_STR "VERSION" 139#define ZFS_FUID_TABLES "FUID" 140#define ZFS_SHARES_DIR "SHARES" 141#define ZFS_SA_ATTRS "SA_ATTRS" 142 143/* 144 * Convert mode bits (zp_mode) to BSD-style DT_* values for storing in 145 * the directory entries. On Linux systems this value is already 146 * defined correctly as part of the /usr/include/dirent.h header file. 147 */ 148#ifndef IFTODT 149#define IFTODT(mode) (((mode) & S_IFMT) >> 12) 150#endif 151 152/* 153 * The directory entry has the type (currently unused on Solaris) in the 154 * top 4 bits, and the object number in the low 48 bits. The "middle" 155 * 12 bits are unused. 156 */ 157#define ZFS_DIRENT_TYPE(de) BF64_GET(de, 60, 4) 158#define ZFS_DIRENT_OBJ(de) BF64_GET(de, 0, 48) 159 160extern int zfs_obj_to_path(objset_t *osp, uint64_t obj, char *buf, int len); 161extern int zfs_get_zplprop(objset_t *os, zfs_prop_t prop, uint64_t *value); 162 163#ifdef _KERNEL 164#include <sys/zfs_znode_impl.h> 165 166/* 167 * Directory entry locks control access to directory entries. 168 * They are used to protect creates, deletes, and renames. 169 * Each directory znode has a mutex and a list of locked names. 170 */ 171typedef struct zfs_dirlock { 172 char *dl_name; /* directory entry being locked */ 173 uint32_t dl_sharecnt; /* 0 if exclusive, > 0 if shared */ 174 uint8_t dl_namelock; /* 1 if z_name_lock is NOT held */ 175 uint16_t dl_namesize; /* set if dl_name was allocated */ 176 kcondvar_t dl_cv; /* wait for entry to be unlocked */ 177 struct znode *dl_dzp; /* directory znode */ 178 struct zfs_dirlock *dl_next; /* next in z_dirlocks list */ 179} zfs_dirlock_t; 180 181typedef struct znode { 182 uint64_t z_id; /* object ID for this znode */ 183 kmutex_t z_lock; /* znode modification lock */ 184 krwlock_t z_parent_lock; /* parent lock for directories */ 185 krwlock_t z_name_lock; /* "master" lock for dirent locks */ 186 zfs_dirlock_t *z_dirlocks; /* directory entry lock list */ 187 zfs_rangelock_t z_rangelock; /* file range locks */ 188 boolean_t z_unlinked; /* file has been unlinked */ 189 boolean_t z_atime_dirty; /* atime needs to be synced */ 190 boolean_t z_zn_prefetch; /* Prefetch znodes? */ 191 boolean_t z_is_sa; /* are we native sa? */ 192 boolean_t z_is_ctldir; /* are we .zfs entry */ 193 boolean_t z_suspended; /* extra ref from a suspend? */ 194 uint_t z_blksz; /* block size in bytes */ 195 uint_t z_seq; /* modification sequence number */ 196 uint64_t z_mapcnt; /* number of pages mapped to file */ 197 uint64_t z_dnodesize; /* dnode size */ 198 uint64_t z_size; /* file size (cached) */ 199 uint64_t z_pflags; /* pflags (cached) */ 200 uint32_t z_sync_cnt; /* synchronous open count */ 201 uint32_t z_sync_writes_cnt; /* synchronous write count */ 202 uint32_t z_async_writes_cnt; /* asynchronous write count */ 203 mode_t z_mode; /* mode (cached) */ 204 kmutex_t z_acl_lock; /* acl data lock */ 205 zfs_acl_t *z_acl_cached; /* cached acl */ 206 krwlock_t z_xattr_lock; /* xattr data lock */ 207 nvlist_t *z_xattr_cached; /* cached xattrs */ 208 uint64_t z_xattr_parent; /* parent obj for this xattr */ 209 uint64_t z_projid; /* project ID */ 210 list_node_t z_link_node; /* all znodes in fs link */ 211 sa_handle_t *z_sa_hdl; /* handle to sa data */ 212 213 /* 214 * Platform specific field, defined by each platform and only 215 * accessible from platform specific code. 216 */ 217 ZNODE_OS_FIELDS; 218} znode_t; 219 220/* Verifies the znode is valid. */ 221static inline int 222zfs_verify_zp(znode_t *zp) 223{ 224 if (unlikely(zp->z_sa_hdl == NULL)) 225 return (SET_ERROR(EIO)); 226 return (0); 227} 228 229/* zfs_enter and zfs_verify_zp together */ 230static inline int 231zfs_enter_verify_zp(zfsvfs_t *zfsvfs, znode_t *zp, const char *tag) 232{ 233 int error; 234 if ((error = zfs_enter(zfsvfs, tag)) != 0) 235 return (error); 236 if ((error = zfs_verify_zp(zp)) != 0) { 237 zfs_exit(zfsvfs, tag); 238 return (error); 239 } 240 return (0); 241} 242 243typedef struct znode_hold { 244 uint64_t zh_obj; /* object id */ 245 avl_node_t zh_node; /* avl tree linkage */ 246 kmutex_t zh_lock; /* lock serializing object access */ 247 int zh_refcount; /* active consumer reference count */ 248} znode_hold_t; 249 250static inline uint64_t 251zfs_inherit_projid(znode_t *dzp) 252{ 253 return ((dzp->z_pflags & ZFS_PROJINHERIT) ? dzp->z_projid : 254 ZFS_DEFAULT_PROJID); 255} 256 257/* 258 * Timestamp defines 259 */ 260#define ACCESSED (ATTR_ATIME) 261#define STATE_CHANGED (ATTR_CTIME) 262#define CONTENT_MODIFIED (ATTR_MTIME | ATTR_CTIME) 263 264extern int zfs_init_fs(zfsvfs_t *, znode_t **); 265extern void zfs_set_dataprop(objset_t *); 266extern void zfs_create_fs(objset_t *os, cred_t *cr, nvlist_t *, 267 dmu_tx_t *tx); 268extern void zfs_tstamp_update_setup(znode_t *, uint_t, uint64_t [2], 269 uint64_t [2]); 270extern void zfs_grow_blocksize(znode_t *, uint64_t, dmu_tx_t *); 271extern int zfs_freesp(znode_t *, uint64_t, uint64_t, int, boolean_t); 272extern void zfs_znode_init(void); 273extern void zfs_znode_fini(void); 274extern int zfs_znode_hold_compare(const void *, const void *); 275extern znode_hold_t *zfs_znode_hold_enter(zfsvfs_t *, uint64_t); 276extern void zfs_znode_hold_exit(zfsvfs_t *, znode_hold_t *); 277extern int zfs_zget(zfsvfs_t *, uint64_t, znode_t **); 278extern int zfs_rezget(znode_t *); 279extern void zfs_zinactive(znode_t *); 280extern void zfs_znode_delete(znode_t *, dmu_tx_t *); 281extern void zfs_remove_op_tables(void); 282extern int zfs_create_op_tables(void); 283extern dev_t zfs_cmpldev(uint64_t); 284extern int zfs_get_stats(objset_t *os, nvlist_t *nv); 285extern boolean_t zfs_get_vfs_flag_unmounted(objset_t *os); 286extern void zfs_znode_dmu_fini(znode_t *); 287 288extern void zfs_log_create(zilog_t *zilog, dmu_tx_t *tx, uint64_t txtype, 289 znode_t *dzp, znode_t *zp, const char *name, vsecattr_t *, 290 zfs_fuid_info_t *, vattr_t *vap); 291extern int zfs_log_create_txtype(zil_create_t, vsecattr_t *vsecp, 292 vattr_t *vap); 293extern void zfs_log_remove(zilog_t *zilog, dmu_tx_t *tx, uint64_t txtype, 294 znode_t *dzp, const char *name, uint64_t foid, boolean_t unlinked); 295#define ZFS_NO_OBJECT 0 /* no object id */ 296extern void zfs_log_link(zilog_t *zilog, dmu_tx_t *tx, uint64_t txtype, 297 znode_t *dzp, znode_t *zp, const char *name); 298extern void zfs_log_symlink(zilog_t *zilog, dmu_tx_t *tx, uint64_t txtype, 299 znode_t *dzp, znode_t *zp, const char *name, const char *link); 300extern void zfs_log_rename(zilog_t *zilog, dmu_tx_t *tx, uint64_t txtype, 301 znode_t *sdzp, const char *sname, znode_t *tdzp, const char *dname, 302 znode_t *szp); 303extern void zfs_log_rename_exchange(zilog_t *zilog, dmu_tx_t *tx, 304 uint64_t txtype, znode_t *sdzp, const char *sname, znode_t *tdzp, 305 const char *dname, znode_t *szp); 306extern void zfs_log_rename_whiteout(zilog_t *zilog, dmu_tx_t *tx, 307 uint64_t txtype, znode_t *sdzp, const char *sname, znode_t *tdzp, 308 const char *dname, znode_t *szp, znode_t *wzp); 309extern void zfs_log_write(zilog_t *zilog, dmu_tx_t *tx, int txtype, 310 znode_t *zp, offset_t off, ssize_t len, boolean_t commit, 311 zil_callback_t callback, void *callback_data); 312extern void zfs_log_truncate(zilog_t *zilog, dmu_tx_t *tx, int txtype, 313 znode_t *zp, uint64_t off, uint64_t len); 314extern void zfs_log_setattr(zilog_t *zilog, dmu_tx_t *tx, int txtype, 315 znode_t *zp, vattr_t *vap, uint_t mask_applied, zfs_fuid_info_t *fuidp); 316extern void zfs_log_acl(zilog_t *zilog, dmu_tx_t *tx, znode_t *zp, 317 vsecattr_t *vsecp, zfs_fuid_info_t *fuidp); 318extern void zfs_log_clone_range(zilog_t *zilog, dmu_tx_t *tx, int txtype, 319 znode_t *zp, uint64_t offset, uint64_t length, uint64_t blksz, 320 const blkptr_t *bps, size_t nbps); 321extern void zfs_xvattr_set(znode_t *zp, xvattr_t *xvap, dmu_tx_t *tx); 322extern void zfs_upgrade(zfsvfs_t *zfsvfs, dmu_tx_t *tx); 323extern void zfs_log_setsaxattr(zilog_t *zilog, dmu_tx_t *tx, int txtype, 324 znode_t *zp, const char *name, const void *value, size_t size); 325 326extern void zfs_znode_update_vfs(struct znode *); 327 328#endif 329#ifdef __cplusplus 330} 331#endif 332 333#endif /* _SYS_FS_ZFS_ZNODE_H */ 334