1168404Spjd/* 2168404Spjd * CDDL HEADER START 3168404Spjd * 4168404Spjd * The contents of this file are subject to the terms of the 5168404Spjd * Common Development and Distribution License (the "License"). 6168404Spjd * You may not use this file except in compliance with the License. 7168404Spjd * 8168404Spjd * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9168404Spjd * or http://www.opensolaris.org/os/licensing. 10168404Spjd * See the License for the specific language governing permissions 11168404Spjd * and limitations under the License. 12168404Spjd * 13168404Spjd * When distributing Covered Code, include this CDDL HEADER in each 14168404Spjd * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15168404Spjd * If applicable, add the following below this CDDL HEADER, with the 16168404Spjd * fields enclosed by brackets "[]" replaced with your own identifying 17168404Spjd * information: Portions Copyright [yyyy] [name of copyright owner] 18168404Spjd * 19168404Spjd * CDDL HEADER END 20168404Spjd */ 21168404Spjd/* 22219089Spjd * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved. 23249643Smm * Copyright (c) 2012 by Delphix. All rights reserved. 24168404Spjd */ 25168404Spjd 26168404Spjd#ifndef _SYS_FS_ZFS_ZNODE_H 27168404Spjd#define _SYS_FS_ZFS_ZNODE_H 28168404Spjd 29168404Spjd#ifdef _KERNEL 30168404Spjd#include <sys/list.h> 31168404Spjd#include <sys/dmu.h> 32219089Spjd#include <sys/sa.h> 33168404Spjd#include <sys/zfs_vfsops.h> 34185029Spjd#include <sys/rrwlock.h> 35219089Spjd#include <sys/zfs_sa.h> 36219089Spjd#include <sys/zfs_stat.h> 37168404Spjd#endif 38168404Spjd#include <sys/zfs_acl.h> 39168404Spjd#include <sys/zil.h> 40168404Spjd 41168404Spjd#ifdef __cplusplus 42168404Spjdextern "C" { 43168404Spjd#endif 44168404Spjd 45168404Spjd/* 46185029Spjd * Additional file level attributes, that are stored 47185029Spjd * in the upper half of zp_flags 48185029Spjd */ 49185029Spjd#define ZFS_READONLY 0x0000000100000000 50185029Spjd#define ZFS_HIDDEN 0x0000000200000000 51185029Spjd#define ZFS_SYSTEM 0x0000000400000000 52185029Spjd#define ZFS_ARCHIVE 0x0000000800000000 53185029Spjd#define ZFS_IMMUTABLE 0x0000001000000000 54185029Spjd#define ZFS_NOUNLINK 0x0000002000000000 55185029Spjd#define ZFS_APPENDONLY 0x0000004000000000 56185029Spjd#define ZFS_NODUMP 0x0000008000000000 57185029Spjd#define ZFS_OPAQUE 0x0000010000000000 58185029Spjd#define ZFS_AV_QUARANTINED 0x0000020000000000 59185029Spjd#define ZFS_AV_MODIFIED 0x0000040000000000 60219089Spjd#define ZFS_REPARSE 0x0000080000000000 61219089Spjd#define ZFS_OFFLINE 0x0000100000000000 62219089Spjd#define ZFS_SPARSE 0x0000200000000000 63185029Spjd 64219089Spjd#define ZFS_ATTR_SET(zp, attr, value, pflags, tx) \ 65185029Spjd{ \ 66185029Spjd if (value) \ 67219089Spjd pflags |= attr; \ 68185029Spjd else \ 69219089Spjd pflags &= ~attr; \ 70219089Spjd VERIFY(0 == sa_update(zp->z_sa_hdl, SA_ZPL_FLAGS(zp->z_zfsvfs), \ 71219089Spjd &pflags, sizeof (pflags), tx)); \ 72185029Spjd} 73185029Spjd 74185029Spjd/* 75168404Spjd * Define special zfs pflags 76168404Spjd */ 77185029Spjd#define ZFS_XATTR 0x1 /* is an extended attribute */ 78185029Spjd#define ZFS_INHERIT_ACE 0x2 /* ace has inheritable ACEs */ 79185029Spjd#define ZFS_ACL_TRIVIAL 0x4 /* files ACL is trivial */ 80185029Spjd#define ZFS_ACL_OBJ_ACE 0x8 /* ACL has CMPLX Object ACE */ 81185029Spjd#define ZFS_ACL_PROTECTED 0x10 /* ACL protected */ 82185029Spjd#define ZFS_ACL_DEFAULTED 0x20 /* ACL should be defaulted */ 83185029Spjd#define ZFS_ACL_AUTO_INHERIT 0x40 /* ACL should be inherited */ 84185029Spjd#define ZFS_BONUS_SCANSTAMP 0x80 /* Scanstamp in bonus area */ 85211932Smm#define ZFS_NO_EXECS_DENIED 0x100 /* exec was given to everyone */ 86168404Spjd 87219089Spjd#define SA_ZPL_ATIME(z) z->z_attr_table[ZPL_ATIME] 88219089Spjd#define SA_ZPL_MTIME(z) z->z_attr_table[ZPL_MTIME] 89219089Spjd#define SA_ZPL_CTIME(z) z->z_attr_table[ZPL_CTIME] 90219089Spjd#define SA_ZPL_CRTIME(z) z->z_attr_table[ZPL_CRTIME] 91219089Spjd#define SA_ZPL_GEN(z) z->z_attr_table[ZPL_GEN] 92219089Spjd#define SA_ZPL_DACL_ACES(z) z->z_attr_table[ZPL_DACL_ACES] 93219089Spjd#define SA_ZPL_XATTR(z) z->z_attr_table[ZPL_XATTR] 94219089Spjd#define SA_ZPL_SYMLINK(z) z->z_attr_table[ZPL_SYMLINK] 95219089Spjd#define SA_ZPL_RDEV(z) z->z_attr_table[ZPL_RDEV] 96219089Spjd#define SA_ZPL_SCANSTAMP(z) z->z_attr_table[ZPL_SCANSTAMP] 97219089Spjd#define SA_ZPL_UID(z) z->z_attr_table[ZPL_UID] 98219089Spjd#define SA_ZPL_GID(z) z->z_attr_table[ZPL_GID] 99219089Spjd#define SA_ZPL_PARENT(z) z->z_attr_table[ZPL_PARENT] 100219089Spjd#define SA_ZPL_LINKS(z) z->z_attr_table[ZPL_LINKS] 101219089Spjd#define SA_ZPL_MODE(z) z->z_attr_table[ZPL_MODE] 102219089Spjd#define SA_ZPL_DACL_COUNT(z) z->z_attr_table[ZPL_DACL_COUNT] 103219089Spjd#define SA_ZPL_FLAGS(z) z->z_attr_table[ZPL_FLAGS] 104219089Spjd#define SA_ZPL_SIZE(z) z->z_attr_table[ZPL_SIZE] 105219089Spjd#define SA_ZPL_ZNODE_ACL(z) z->z_attr_table[ZPL_ZNODE_ACL] 106219089Spjd#define SA_ZPL_PAD(z) z->z_attr_table[ZPL_PAD] 107219089Spjd 108185029Spjd/* 109185029Spjd * Is ID ephemeral? 110185029Spjd */ 111185029Spjd#define IS_EPHEMERAL(x) (x > MAXUID) 112185029Spjd 113185029Spjd/* 114185029Spjd * Should we use FUIDs? 115185029Spjd */ 116219089Spjd#define USE_FUIDS(version, os) (version >= ZPL_VERSION_FUID && \ 117185029Spjd spa_version(dmu_objset_spa(os)) >= SPA_VERSION_FUID) 118219089Spjd#define USE_SA(version, os) (version >= ZPL_VERSION_SA && \ 119219089Spjd spa_version(dmu_objset_spa(os)) >= SPA_VERSION_SA) 120185029Spjd 121168404Spjd#define MASTER_NODE_OBJ 1 122168404Spjd 123168404Spjd/* 124185029Spjd * Special attributes for master node. 125219089Spjd * "userquota@" and "groupquota@" are also valid (from 126219089Spjd * zfs_userquota_prop_prefixes[]). 127168404Spjd */ 128168404Spjd#define ZFS_FSID "FSID" 129168404Spjd#define ZFS_UNLINKED_SET "DELETE_QUEUE" 130168404Spjd#define ZFS_ROOT_OBJ "ROOT" 131185029Spjd#define ZPL_VERSION_STR "VERSION" 132185029Spjd#define ZFS_FUID_TABLES "FUID" 133209962Smm#define ZFS_SHARES_DIR "SHARES" 134219089Spjd#define ZFS_SA_ATTRS "SA_ATTRS" 135168404Spjd 136168404Spjd#define ZFS_MAX_BLOCKSIZE (SPA_MAXBLOCKSIZE) 137168404Spjd 138168404Spjd/* 139252751Sdelphij * Path component length 140252751Sdelphij * 141168404Spjd * The generic fs code uses MAXNAMELEN to represent 142168404Spjd * what the largest component length is. Unfortunately, 143168404Spjd * this length includes the terminating NULL. ZFS needs 144168404Spjd * to tell the users via pathconf() and statvfs() what the 145168404Spjd * true maximum length of a component is, excluding the NULL. 146168404Spjd */ 147168404Spjd#define ZFS_MAXNAMELEN (MAXNAMELEN - 1) 148168404Spjd 149168404Spjd/* 150185029Spjd * Convert mode bits (zp_mode) to BSD-style DT_* values for storing in 151185029Spjd * the directory entries. 152185029Spjd */ 153185029Spjd#ifndef IFTODT 154185029Spjd#define IFTODT(mode) (((mode) & S_IFMT) >> 12) 155185029Spjd#endif 156185029Spjd 157185029Spjd/* 158168404Spjd * The directory entry has the type (currently unused on Solaris) in the 159168404Spjd * top 4 bits, and the object number in the low 48 bits. The "middle" 160168404Spjd * 12 bits are unused. 161168404Spjd */ 162168404Spjd#define ZFS_DIRENT_TYPE(de) BF64_GET(de, 60, 4) 163168404Spjd#define ZFS_DIRENT_OBJ(de) BF64_GET(de, 0, 48) 164168404Spjd 165168404Spjd/* 166168404Spjd * Directory entry locks control access to directory entries. 167168404Spjd * They are used to protect creates, deletes, and renames. 168168404Spjd * Each directory znode has a mutex and a list of locked names. 169168404Spjd */ 170168404Spjd#ifdef _KERNEL 171168404Spjdtypedef struct zfs_dirlock { 172168404Spjd char *dl_name; /* directory entry being locked */ 173168404Spjd uint32_t dl_sharecnt; /* 0 if exclusive, > 0 if shared */ 174208131Smm uint8_t dl_namelock; /* 1 if z_name_lock is NOT held */ 175168404Spjd uint16_t dl_namesize; /* set if dl_name was allocated */ 176168404Spjd kcondvar_t dl_cv; /* wait for entry to be unlocked */ 177168404Spjd struct znode *dl_dzp; /* directory znode */ 178168404Spjd struct zfs_dirlock *dl_next; /* next in z_dirlocks list */ 179168404Spjd} zfs_dirlock_t; 180168404Spjd 181168404Spjdtypedef struct znode { 182168404Spjd struct zfsvfs *z_zfsvfs; 183168404Spjd vnode_t *z_vnode; 184168404Spjd uint64_t z_id; /* object ID for this znode */ 185168404Spjd kmutex_t z_lock; /* znode modification lock */ 186168404Spjd krwlock_t z_parent_lock; /* parent lock for directories */ 187168404Spjd krwlock_t z_name_lock; /* "master" lock for dirent locks */ 188168404Spjd zfs_dirlock_t *z_dirlocks; /* directory entry lock list */ 189168404Spjd kmutex_t z_range_lock; /* protects changes to z_range_avl */ 190168404Spjd avl_tree_t z_range_avl; /* avl tree of file range locks */ 191168404Spjd uint8_t z_unlinked; /* file has been unlinked */ 192168404Spjd uint8_t z_atime_dirty; /* atime needs to be synced */ 193168404Spjd uint8_t z_zn_prefetch; /* Prefetch znodes? */ 194219089Spjd uint8_t z_moved; /* Has this znode been moved? */ 195168404Spjd uint_t z_blksz; /* block size in bytes */ 196168404Spjd uint_t z_seq; /* modification sequence number */ 197168404Spjd uint64_t z_mapcnt; /* number of pages mapped to file */ 198219089Spjd uint64_t z_gen; /* generation (cached) */ 199219089Spjd uint64_t z_size; /* file size (cached) */ 200219089Spjd uint64_t z_atime[2]; /* atime (cached) */ 201219089Spjd uint64_t z_links; /* file links (cached) */ 202219089Spjd uint64_t z_pflags; /* pflags (cached) */ 203219089Spjd uint64_t z_uid; /* uid fuid (cached) */ 204219089Spjd uint64_t z_gid; /* gid fuid (cached) */ 205219089Spjd mode_t z_mode; /* mode (cached) */ 206168404Spjd uint32_t z_sync_cnt; /* synchronous open count */ 207168404Spjd kmutex_t z_acl_lock; /* acl data lock */ 208211932Smm zfs_acl_t *z_acl_cached; /* cached acl */ 209168404Spjd list_node_t z_link_node; /* all znodes in fs link */ 210219089Spjd sa_handle_t *z_sa_hdl; /* handle to sa data */ 211219089Spjd boolean_t z_is_sa; /* are we native sa? */ 212168404Spjd} znode_t; 213168404Spjd 214168404Spjd 215168404Spjd/* 216168404Spjd * Range locking rules 217168404Spjd * -------------------- 218168404Spjd * 1. When truncating a file (zfs_create, zfs_setattr, zfs_space) the whole 219168404Spjd * file range needs to be locked as RL_WRITER. Only then can the pages be 220168404Spjd * freed etc and zp_size reset. zp_size must be set within range lock. 221168404Spjd * 2. For writes and punching holes (zfs_write & zfs_space) just the range 222168404Spjd * being written or freed needs to be locked as RL_WRITER. 223168404Spjd * Multiple writes at the end of the file must coordinate zp_size updates 224168404Spjd * to ensure data isn't lost. A compare and swap loop is currently used 225168404Spjd * to ensure the file size is at least the offset last written. 226168404Spjd * 3. For reads (zfs_read, zfs_get_data & zfs_putapage) just the range being 227168404Spjd * read needs to be locked as RL_READER. A check against zp_size can then 228168404Spjd * be made for reading beyond end of file. 229168404Spjd */ 230168404Spjd 231168404Spjd/* 232168404Spjd * Convert between znode pointers and vnode pointers 233168404Spjd */ 234197153Spjd#ifdef DEBUG 235197153Spjdstatic __inline vnode_t * 236197153SpjdZTOV(znode_t *zp) 237197153Spjd{ 238197153Spjd vnode_t *vp = zp->z_vnode; 239197153Spjd 240197153Spjd ASSERT(vp == NULL || vp->v_data == NULL || vp->v_data == zp); 241197153Spjd return (vp); 242197153Spjd} 243197153Spjdstatic __inline znode_t * 244197153SpjdVTOZ(vnode_t *vp) 245197153Spjd{ 246197153Spjd znode_t *zp = (znode_t *)vp->v_data; 247197153Spjd 248197153Spjd ASSERT(zp == NULL || zp->z_vnode == NULL || zp->z_vnode == vp); 249197153Spjd return (zp); 250197153Spjd} 251197153Spjd#else 252168404Spjd#define ZTOV(ZP) ((ZP)->z_vnode) 253168404Spjd#define VTOZ(VP) ((znode_t *)(VP)->v_data) 254197153Spjd#endif 255168404Spjd 256252751Sdelphij/* Called on entry to each ZFS vnode and vfs operation */ 257168404Spjd#define ZFS_ENTER(zfsvfs) \ 258168404Spjd { \ 259249643Smm rrw_enter_read(&(zfsvfs)->z_teardown_lock, FTAG); \ 260185029Spjd if ((zfsvfs)->z_unmounted) { \ 261168404Spjd ZFS_EXIT(zfsvfs); \ 262168404Spjd return (EIO); \ 263168404Spjd } \ 264168404Spjd } 265168404Spjd 266252751Sdelphij/* Called on entry to each ZFS vnode and vfs operation that can not return EIO */ 267197459Spjd#define ZFS_ENTER_NOERROR(zfsvfs) \ 268197459Spjd rrw_enter(&(zfsvfs)->z_teardown_lock, RW_READER, FTAG) 269197459Spjd 270252751Sdelphij/* Must be called before exiting the vop */ 271185029Spjd#define ZFS_EXIT(zfsvfs) rrw_exit(&(zfsvfs)->z_teardown_lock, FTAG) 272185029Spjd 273252751Sdelphij/* Verifies the znode is valid */ 274185029Spjd#define ZFS_VERIFY_ZP(zp) \ 275219089Spjd if ((zp)->z_sa_hdl == NULL) { \ 276185029Spjd ZFS_EXIT((zp)->z_zfsvfs); \ 277185029Spjd return (EIO); \ 278185029Spjd } \ 279185029Spjd 280168404Spjd/* 281168404Spjd * Macros for dealing with dmu_buf_hold 282168404Spjd */ 283185029Spjd#define ZFS_OBJ_HASH(obj_num) ((obj_num) & (ZFS_OBJ_MTX_SZ - 1)) 284185029Spjd#define ZFS_OBJ_MUTEX(zfsvfs, obj_num) \ 285185029Spjd (&(zfsvfs)->z_hold_mtx[ZFS_OBJ_HASH(obj_num)]) 286168404Spjd#define ZFS_OBJ_HOLD_ENTER(zfsvfs, obj_num) \ 287185029Spjd mutex_enter(ZFS_OBJ_MUTEX((zfsvfs), (obj_num))) 288185029Spjd#define ZFS_OBJ_HOLD_TRYENTER(zfsvfs, obj_num) \ 289185029Spjd mutex_tryenter(ZFS_OBJ_MUTEX((zfsvfs), (obj_num))) 290168404Spjd#define ZFS_OBJ_HOLD_EXIT(zfsvfs, obj_num) \ 291185029Spjd mutex_exit(ZFS_OBJ_MUTEX((zfsvfs), (obj_num))) 292168404Spjd 293252751Sdelphij/* Encode ZFS stored time values from a struct timespec */ 294168404Spjd#define ZFS_TIME_ENCODE(tp, stmp) \ 295168404Spjd{ \ 296185029Spjd (stmp)[0] = (uint64_t)(tp)->tv_sec; \ 297185029Spjd (stmp)[1] = (uint64_t)(tp)->tv_nsec; \ 298168404Spjd} 299168404Spjd 300252751Sdelphij/* Decode ZFS stored time values to a struct timespec */ 301168404Spjd#define ZFS_TIME_DECODE(tp, stmp) \ 302168404Spjd{ \ 303185029Spjd (tp)->tv_sec = (time_t)(stmp)[0]; \ 304185029Spjd (tp)->tv_nsec = (long)(stmp)[1]; \ 305168404Spjd} 306168404Spjd 307168404Spjd/* 308168404Spjd * Timestamp defines 309168404Spjd */ 310168404Spjd#define ACCESSED (AT_ATIME) 311168404Spjd#define STATE_CHANGED (AT_CTIME) 312168404Spjd#define CONTENT_MODIFIED (AT_MTIME | AT_CTIME) 313168404Spjd 314168404Spjd#define ZFS_ACCESSTIME_STAMP(zfsvfs, zp) \ 315168404Spjd if ((zfsvfs)->z_atime && !((zfsvfs)->z_vfs->vfs_flag & VFS_RDONLY)) \ 316219089Spjd zfs_tstamp_update_setup(zp, ACCESSED, NULL, NULL, B_FALSE); 317168404Spjd 318185029Spjdextern int zfs_init_fs(zfsvfs_t *, znode_t **); 319168404Spjdextern void zfs_set_dataprop(objset_t *); 320185029Spjdextern void zfs_create_fs(objset_t *os, cred_t *cr, nvlist_t *, 321185029Spjd dmu_tx_t *tx); 322219089Spjdextern void zfs_tstamp_update_setup(znode_t *, uint_t, uint64_t [2], 323219089Spjd uint64_t [2], boolean_t); 324168404Spjdextern void zfs_grow_blocksize(znode_t *, uint64_t, dmu_tx_t *); 325168404Spjdextern int zfs_freesp(znode_t *, uint64_t, uint64_t, int, boolean_t); 326168404Spjdextern void zfs_znode_init(void); 327168404Spjdextern void zfs_znode_fini(void); 328168404Spjdextern int zfs_zget(zfsvfs_t *, uint64_t, znode_t **); 329185029Spjdextern int zfs_rezget(znode_t *); 330168404Spjdextern void zfs_zinactive(znode_t *); 331168404Spjdextern void zfs_znode_delete(znode_t *, dmu_tx_t *); 332168404Spjdextern void zfs_znode_free(znode_t *); 333168404Spjdextern void zfs_remove_op_tables(); 334168404Spjdextern int zfs_create_op_tables(); 335168404Spjdextern dev_t zfs_cmpldev(uint64_t); 336185029Spjdextern int zfs_get_zplprop(objset_t *os, zfs_prop_t prop, uint64_t *value); 337185029Spjdextern int zfs_get_stats(objset_t *os, nvlist_t *nv); 338185029Spjdextern void zfs_znode_dmu_fini(znode_t *); 339168404Spjd 340185029Spjdextern void zfs_log_create(zilog_t *zilog, dmu_tx_t *tx, uint64_t txtype, 341185029Spjd znode_t *dzp, znode_t *zp, char *name, vsecattr_t *, zfs_fuid_info_t *, 342185029Spjd vattr_t *vap); 343185029Spjdextern int zfs_log_create_txtype(zil_create_t, vsecattr_t *vsecp, 344185029Spjd vattr_t *vap); 345185029Spjdextern void zfs_log_remove(zilog_t *zilog, dmu_tx_t *tx, uint64_t txtype, 346219089Spjd znode_t *dzp, char *name, uint64_t foid); 347219089Spjd#define ZFS_NO_OBJECT 0 /* no object id */ 348185029Spjdextern void zfs_log_link(zilog_t *zilog, dmu_tx_t *tx, uint64_t txtype, 349168404Spjd znode_t *dzp, znode_t *zp, char *name); 350185029Spjdextern void zfs_log_symlink(zilog_t *zilog, dmu_tx_t *tx, uint64_t txtype, 351168404Spjd znode_t *dzp, znode_t *zp, char *name, char *link); 352185029Spjdextern void zfs_log_rename(zilog_t *zilog, dmu_tx_t *tx, uint64_t txtype, 353168404Spjd znode_t *sdzp, char *sname, znode_t *tdzp, char *dname, znode_t *szp); 354168404Spjdextern void zfs_log_write(zilog_t *zilog, dmu_tx_t *tx, int txtype, 355168404Spjd znode_t *zp, offset_t off, ssize_t len, int ioflag); 356168404Spjdextern void zfs_log_truncate(zilog_t *zilog, dmu_tx_t *tx, int txtype, 357168404Spjd znode_t *zp, uint64_t off, uint64_t len); 358168404Spjdextern void zfs_log_setattr(zilog_t *zilog, dmu_tx_t *tx, int txtype, 359185029Spjd znode_t *zp, vattr_t *vap, uint_t mask_applied, zfs_fuid_info_t *fuidp); 360168404Spjd#ifndef ZFS_NO_ACL 361185029Spjdextern void zfs_log_acl(zilog_t *zilog, dmu_tx_t *tx, znode_t *zp, 362185029Spjd vsecattr_t *vsecp, zfs_fuid_info_t *fuidp); 363168404Spjd#endif 364219089Spjdextern void zfs_xvattr_set(znode_t *zp, xvattr_t *xvap, dmu_tx_t *tx); 365185029Spjdextern void zfs_upgrade(zfsvfs_t *zfsvfs, dmu_tx_t *tx); 366209962Smmextern int zfs_create_share_dir(zfsvfs_t *zfsvfs, dmu_tx_t *tx); 367168404Spjd 368168404Spjdextern zil_get_data_t zfs_get_data; 369168404Spjdextern zil_replay_func_t *zfs_replay_vector[TX_MAX_TYPE]; 370168404Spjdextern int zfsfstype; 371168404Spjd 372168404Spjd#endif /* _KERNEL */ 373168404Spjd 374168404Spjdextern int zfs_obj_to_path(objset_t *osp, uint64_t obj, char *buf, int len); 375168404Spjd 376168404Spjd#ifdef __cplusplus 377168404Spjd} 378168404Spjd#endif 379168404Spjd 380168404Spjd#endif /* _SYS_FS_ZFS_ZNODE_H */ 381