fa9e4066f08beec538e775443c5be79dd423fcabahrens/*
fa9e4066f08beec538e775443c5be79dd423fcabahrens * CDDL HEADER START
fa9e4066f08beec538e775443c5be79dd423fcabahrens *
fa9e4066f08beec538e775443c5be79dd423fcabahrens * The contents of this file are subject to the terms of the
ea8dc4b6d2251b437950c0056bc626b311c73c27eschrock * Common Development and Distribution License (the "License").
ea8dc4b6d2251b437950c0056bc626b311c73c27eschrock * You may not use this file except in compliance with the License.
fa9e4066f08beec538e775443c5be79dd423fcabahrens *
fa9e4066f08beec538e775443c5be79dd423fcabahrens * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
fa9e4066f08beec538e775443c5be79dd423fcabahrens * or http://www.opensolaris.org/os/licensing.
fa9e4066f08beec538e775443c5be79dd423fcabahrens * See the License for the specific language governing permissions
fa9e4066f08beec538e775443c5be79dd423fcabahrens * and limitations under the License.
fa9e4066f08beec538e775443c5be79dd423fcabahrens *
fa9e4066f08beec538e775443c5be79dd423fcabahrens * When distributing Covered Code, include this CDDL HEADER in each
fa9e4066f08beec538e775443c5be79dd423fcabahrens * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
fa9e4066f08beec538e775443c5be79dd423fcabahrens * If applicable, add the following below this CDDL HEADER, with the
fa9e4066f08beec538e775443c5be79dd423fcabahrens * fields enclosed by brackets "[]" replaced with your own identifying
fa9e4066f08beec538e775443c5be79dd423fcabahrens * information: Portions Copyright [yyyy] [name of copyright owner]
fa9e4066f08beec538e775443c5be79dd423fcabahrens *
fa9e4066f08beec538e775443c5be79dd423fcabahrens * CDDL HEADER END
fa9e4066f08beec538e775443c5be79dd423fcabahrens */
fa9e4066f08beec538e775443c5be79dd423fcabahrens/*
744947dc83c634d985ed3ad79ac9c5e28d1865fdTom Erickson * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
9adfa60d484ce2435f5af77cc99dcd4e692b6660Matthew Ahrens * Copyright (c) 2012, 2015 by Delphix. All rights reserved.
c3d26abc9ee97b4f60233556aadeb57e0bd30bb9Matthew Ahrens * Copyright (c) 2014 Integros [integros.com]
eb721827677c553ce8dd0d4390630a857f923f98Alek Pinchuk * Copyright 2016 Nexenta Systems, Inc. All rights reserved.
fa9e4066f08beec538e775443c5be79dd423fcabahrens */
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens#ifndef _SYS_FS_ZFS_ZNODE_H
fa9e4066f08beec538e775443c5be79dd423fcabahrens#define _SYS_FS_ZFS_ZNODE_H
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens#ifdef _KERNEL
fa9e4066f08beec538e775443c5be79dd423fcabahrens#include <sys/isa_defs.h>
fa9e4066f08beec538e775443c5be79dd423fcabahrens#include <sys/types32.h>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw#include <sys/attr.h>
fa9e4066f08beec538e775443c5be79dd423fcabahrens#include <sys/list.h>
fa9e4066f08beec538e775443c5be79dd423fcabahrens#include <sys/dmu.h>
0a586cea3ceec7e5e50e7e54c745082a7a333ac2Mark Shellenbaum#include <sys/sa.h>
fa9e4066f08beec538e775443c5be79dd423fcabahrens#include <sys/zfs_vfsops.h>
f18faf3f3e5def85fdfff681617d227703ace2adek#include <sys/rrwlock.h>
0a586cea3ceec7e5e50e7e54c745082a7a333ac2Mark Shellenbaum#include <sys/zfs_sa.h>
99d5e173470cf967aa87653364ed614299e7b511Tim Haley#include <sys/zfs_stat.h>
fa9e4066f08beec538e775443c5be79dd423fcabahrens#endif
fa9e4066f08beec538e775443c5be79dd423fcabahrens#include <sys/zfs_acl.h>
fa9e4066f08beec538e775443c5be79dd423fcabahrens#include <sys/zil.h>
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens#ifdef __cplusplus
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern "C" {
fa9e4066f08beec538e775443c5be79dd423fcabahrens#endif
fa9e4066f08beec538e775443c5be79dd423fcabahrens
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw/*
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw * Additional file level attributes, that are stored
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw * in the upper half of zp_flags
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw */
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw#define ZFS_READONLY 0x0000000100000000
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw#define ZFS_HIDDEN 0x0000000200000000
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw#define ZFS_SYSTEM 0x0000000400000000
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw#define ZFS_ARCHIVE 0x0000000800000000
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw#define ZFS_IMMUTABLE 0x0000001000000000
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw#define ZFS_NOUNLINK 0x0000002000000000
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw#define ZFS_APPENDONLY 0x0000004000000000
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw#define ZFS_NODUMP 0x0000008000000000
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw#define ZFS_OPAQUE 0x0000010000000000
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw#define ZFS_AV_QUARANTINED 0x0000020000000000
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw#define ZFS_AV_MODIFIED 0x0000040000000000
7a286c471efbab8562f7655a82931904703fffe0Dai Ngo#define ZFS_REPARSE 0x0000080000000000
fd9ee8b58485b20072eeef1310a88ff348d5e7fajoyce mcintosh#define ZFS_OFFLINE 0x0000100000000000
fd9ee8b58485b20072eeef1310a88ff348d5e7fajoyce mcintosh#define ZFS_SPARSE 0x0000200000000000
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw
0a586cea3ceec7e5e50e7e54c745082a7a333ac2Mark Shellenbaum#define ZFS_ATTR_SET(zp, attr, value, pflags, tx) \
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw{ \
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw if (value) \
0a586cea3ceec7e5e50e7e54c745082a7a333ac2Mark Shellenbaum pflags |= attr; \
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw else \
0a586cea3ceec7e5e50e7e54c745082a7a333ac2Mark Shellenbaum pflags &= ~attr; \
0a586cea3ceec7e5e50e7e54c745082a7a333ac2Mark Shellenbaum VERIFY(0 == sa_update(zp->z_sa_hdl, SA_ZPL_FLAGS(zp->z_zfsvfs), \
0a586cea3ceec7e5e50e7e54c745082a7a333ac2Mark Shellenbaum &pflags, sizeof (pflags), tx)); \
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw}
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw
fa9e4066f08beec538e775443c5be79dd423fcabahrens/*
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Define special zfs pflags
fa9e4066f08beec538e775443c5be79dd423fcabahrens */
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw#define ZFS_XATTR 0x1 /* is an extended attribute */
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw#define ZFS_INHERIT_ACE 0x2 /* ace has inheritable ACEs */
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw#define ZFS_ACL_TRIVIAL 0x4 /* files ACL is trivial */
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw#define ZFS_ACL_OBJ_ACE 0x8 /* ACL has CMPLX Object ACE */
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw#define ZFS_ACL_PROTECTED 0x10 /* ACL protected */
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw#define ZFS_ACL_DEFAULTED 0x20 /* ACL should be defaulted */
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw#define ZFS_ACL_AUTO_INHERIT 0x40 /* ACL should be inherited */
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw#define ZFS_BONUS_SCANSTAMP 0x80 /* Scanstamp in bonus area */
d47621a49c68c359358f6630aa45cc320762f51fTim Haley#define ZFS_NO_EXECS_DENIED 0x100 /* exec was given to everyone */
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw
0a586cea3ceec7e5e50e7e54c745082a7a333ac2Mark Shellenbaum#define SA_ZPL_ATIME(z) z->z_attr_table[ZPL_ATIME]
0a586cea3ceec7e5e50e7e54c745082a7a333ac2Mark Shellenbaum#define SA_ZPL_MTIME(z) z->z_attr_table[ZPL_MTIME]
0a586cea3ceec7e5e50e7e54c745082a7a333ac2Mark Shellenbaum#define SA_ZPL_CTIME(z) z->z_attr_table[ZPL_CTIME]
0a586cea3ceec7e5e50e7e54c745082a7a333ac2Mark Shellenbaum#define SA_ZPL_CRTIME(z) z->z_attr_table[ZPL_CRTIME]
0a586cea3ceec7e5e50e7e54c745082a7a333ac2Mark Shellenbaum#define SA_ZPL_GEN(z) z->z_attr_table[ZPL_GEN]
0a586cea3ceec7e5e50e7e54c745082a7a333ac2Mark Shellenbaum#define SA_ZPL_DACL_ACES(z) z->z_attr_table[ZPL_DACL_ACES]
0a586cea3ceec7e5e50e7e54c745082a7a333ac2Mark Shellenbaum#define SA_ZPL_XATTR(z) z->z_attr_table[ZPL_XATTR]
0a586cea3ceec7e5e50e7e54c745082a7a333ac2Mark Shellenbaum#define SA_ZPL_SYMLINK(z) z->z_attr_table[ZPL_SYMLINK]
0a586cea3ceec7e5e50e7e54c745082a7a333ac2Mark Shellenbaum#define SA_ZPL_RDEV(z) z->z_attr_table[ZPL_RDEV]
0a586cea3ceec7e5e50e7e54c745082a7a333ac2Mark Shellenbaum#define SA_ZPL_SCANSTAMP(z) z->z_attr_table[ZPL_SCANSTAMP]
0a586cea3ceec7e5e50e7e54c745082a7a333ac2Mark Shellenbaum#define SA_ZPL_UID(z) z->z_attr_table[ZPL_UID]
0a586cea3ceec7e5e50e7e54c745082a7a333ac2Mark Shellenbaum#define SA_ZPL_GID(z) z->z_attr_table[ZPL_GID]
0a586cea3ceec7e5e50e7e54c745082a7a333ac2Mark Shellenbaum#define SA_ZPL_PARENT(z) z->z_attr_table[ZPL_PARENT]
0a586cea3ceec7e5e50e7e54c745082a7a333ac2Mark Shellenbaum#define SA_ZPL_LINKS(z) z->z_attr_table[ZPL_LINKS]
0a586cea3ceec7e5e50e7e54c745082a7a333ac2Mark Shellenbaum#define SA_ZPL_MODE(z) z->z_attr_table[ZPL_MODE]
0a586cea3ceec7e5e50e7e54c745082a7a333ac2Mark Shellenbaum#define SA_ZPL_DACL_COUNT(z) z->z_attr_table[ZPL_DACL_COUNT]
0a586cea3ceec7e5e50e7e54c745082a7a333ac2Mark Shellenbaum#define SA_ZPL_FLAGS(z) z->z_attr_table[ZPL_FLAGS]
0a586cea3ceec7e5e50e7e54c745082a7a333ac2Mark Shellenbaum#define SA_ZPL_SIZE(z) z->z_attr_table[ZPL_SIZE]
0a586cea3ceec7e5e50e7e54c745082a7a333ac2Mark Shellenbaum#define SA_ZPL_ZNODE_ACL(z) z->z_attr_table[ZPL_ZNODE_ACL]
0a586cea3ceec7e5e50e7e54c745082a7a333ac2Mark Shellenbaum#define SA_ZPL_PAD(z) z->z_attr_table[ZPL_PAD]
0a586cea3ceec7e5e50e7e54c745082a7a333ac2Mark Shellenbaum
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw/*
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw * Is ID ephemeral?
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw */
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw#define IS_EPHEMERAL(x) (x > MAXUID)
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw/*
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw * Should we use FUIDs?
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw */
0a586cea3ceec7e5e50e7e54c745082a7a333ac2Mark Shellenbaum#define USE_FUIDS(version, os) (version >= ZPL_VERSION_FUID && \
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw spa_version(dmu_objset_spa(os)) >= SPA_VERSION_FUID)
0a586cea3ceec7e5e50e7e54c745082a7a333ac2Mark Shellenbaum#define USE_SA(version, os) (version >= ZPL_VERSION_SA && \
0a586cea3ceec7e5e50e7e54c745082a7a333ac2Mark Shellenbaum spa_version(dmu_objset_spa(os)) >= SPA_VERSION_SA)
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens#define MASTER_NODE_OBJ 1
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens/*
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw * Special attributes for master node.
148434217c040ea38dc844384f6ba68d9b325906Matthew Ahrens * "userquota@" and "groupquota@" are also valid (from
148434217c040ea38dc844384f6ba68d9b325906Matthew Ahrens * zfs_userquota_prop_prefixes[]).
fa9e4066f08beec538e775443c5be79dd423fcabahrens */
fa9e4066f08beec538e775443c5be79dd423fcabahrens#define ZFS_FSID "FSID"
893a6d32980d24be1349478f44169009d4801c25ahrens#define ZFS_UNLINKED_SET "DELETE_QUEUE"
fa9e4066f08beec538e775443c5be79dd423fcabahrens#define ZFS_ROOT_OBJ "ROOT"
e7437265dc2a4920c197ed4337665539d358b22cahrens#define ZPL_VERSION_STR "VERSION"
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw#define ZFS_FUID_TABLES "FUID"
743a77ed89085d3c232c4a2f65ab4e19576839e2Alan Wright#define ZFS_SHARES_DIR "SHARES"
0a586cea3ceec7e5e50e7e54c745082a7a333ac2Mark Shellenbaum#define ZFS_SA_ATTRS "SA_ATTRS"
fa9e4066f08beec538e775443c5be79dd423fcabahrens
e7437265dc2a4920c197ed4337665539d358b22cahrens/*
e7437265dc2a4920c197ed4337665539d358b22cahrens * Convert mode bits (zp_mode) to BSD-style DT_* values for storing in
e7437265dc2a4920c197ed4337665539d358b22cahrens * the directory entries.
e7437265dc2a4920c197ed4337665539d358b22cahrens */
e7437265dc2a4920c197ed4337665539d358b22cahrens#define IFTODT(mode) (((mode) & S_IFMT) >> 12)
e7437265dc2a4920c197ed4337665539d358b22cahrens
b1b8ab34de515a5e83206da22c3d7e563241b021lling/*
b1b8ab34de515a5e83206da22c3d7e563241b021lling * The directory entry has the type (currently unused on Solaris) in the
b1b8ab34de515a5e83206da22c3d7e563241b021lling * top 4 bits, and the object number in the low 48 bits. The "middle"
b1b8ab34de515a5e83206da22c3d7e563241b021lling * 12 bits are unused.
b1b8ab34de515a5e83206da22c3d7e563241b021lling */
b1b8ab34de515a5e83206da22c3d7e563241b021lling#define ZFS_DIRENT_TYPE(de) BF64_GET(de, 60, 4)
b1b8ab34de515a5e83206da22c3d7e563241b021lling#define ZFS_DIRENT_OBJ(de) BF64_GET(de, 0, 48)
b1b8ab34de515a5e83206da22c3d7e563241b021lling
fa9e4066f08beec538e775443c5be79dd423fcabahrens/*
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Directory entry locks control access to directory entries.
fa9e4066f08beec538e775443c5be79dd423fcabahrens * They are used to protect creates, deletes, and renames.
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Each directory znode has a mutex and a list of locked names.
fa9e4066f08beec538e775443c5be79dd423fcabahrens */
fa9e4066f08beec538e775443c5be79dd423fcabahrens#ifdef _KERNEL
fa9e4066f08beec538e775443c5be79dd423fcabahrenstypedef struct zfs_dirlock {
fa9e4066f08beec538e775443c5be79dd423fcabahrens char *dl_name; /* directory entry being locked */
fa9e4066f08beec538e775443c5be79dd423fcabahrens uint32_t dl_sharecnt; /* 0 if exclusive, > 0 if shared */
afefc7e4027e02291d2f534f969cfd38b9dd1db3Sanjeev Bagewadi uint8_t dl_namelock; /* 1 if z_name_lock is NOT held */
fa9e4066f08beec538e775443c5be79dd423fcabahrens uint16_t dl_namesize; /* set if dl_name was allocated */
fa9e4066f08beec538e775443c5be79dd423fcabahrens kcondvar_t dl_cv; /* wait for entry to be unlocked */
fa9e4066f08beec538e775443c5be79dd423fcabahrens struct znode *dl_dzp; /* directory znode */
fa9e4066f08beec538e775443c5be79dd423fcabahrens struct zfs_dirlock *dl_next; /* next in z_dirlocks list */
fa9e4066f08beec538e775443c5be79dd423fcabahrens} zfs_dirlock_t;
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrenstypedef struct znode {
fa9e4066f08beec538e775443c5be79dd423fcabahrens struct zfsvfs *z_zfsvfs;
fa9e4066f08beec538e775443c5be79dd423fcabahrens vnode_t *z_vnode;
fa9e4066f08beec538e775443c5be79dd423fcabahrens uint64_t z_id; /* object ID for this znode */
fa9e4066f08beec538e775443c5be79dd423fcabahrens kmutex_t z_lock; /* znode modification lock */
104e2ed78d9ef0a0f89f320108b8ca29ca3850d5perrin krwlock_t z_parent_lock; /* parent lock for directories */
af2c4821c0a23e873f2a63bca4145080aa2183e3maybee krwlock_t z_name_lock; /* "master" lock for dirent locks */
fa9e4066f08beec538e775443c5be79dd423fcabahrens zfs_dirlock_t *z_dirlocks; /* directory entry lock list */
104e2ed78d9ef0a0f89f320108b8ca29ca3850d5perrin kmutex_t z_range_lock; /* protects changes to z_range_avl */
104e2ed78d9ef0a0f89f320108b8ca29ca3850d5perrin avl_tree_t z_range_avl; /* avl tree of file range locks */
893a6d32980d24be1349478f44169009d4801c25ahrens uint8_t z_unlinked; /* file has been unlinked */
fa9e4066f08beec538e775443c5be79dd423fcabahrens uint8_t z_atime_dirty; /* atime needs to be synced */
7f6e3e7d4ebf3d6d45073854bef004ca26f8e918perrin uint8_t z_zn_prefetch; /* Prefetch znodes? */
744947dc83c634d985ed3ad79ac9c5e28d1865fdTom Erickson uint8_t z_moved; /* Has this znode been moved? */
fa9e4066f08beec538e775443c5be79dd423fcabahrens uint_t z_blksz; /* block size in bytes */
fa9e4066f08beec538e775443c5be79dd423fcabahrens uint_t z_seq; /* modification sequence number */
ea8dc4b6d2251b437950c0056bc626b311c73c27eschrock uint64_t z_mapcnt; /* number of pages mapped to file */
0a586cea3ceec7e5e50e7e54c745082a7a333ac2Mark Shellenbaum uint64_t z_gen; /* generation (cached) */
0a586cea3ceec7e5e50e7e54c745082a7a333ac2Mark Shellenbaum uint64_t z_size; /* file size (cached) */
0a586cea3ceec7e5e50e7e54c745082a7a333ac2Mark Shellenbaum uint64_t z_atime[2]; /* atime (cached) */
0a586cea3ceec7e5e50e7e54c745082a7a333ac2Mark Shellenbaum uint64_t z_links; /* file links (cached) */
0a586cea3ceec7e5e50e7e54c745082a7a333ac2Mark Shellenbaum uint64_t z_pflags; /* pflags (cached) */
f1696b231bb1209e1cea95b7ff29b8c60493daa0Mark Shellenbaum uint64_t z_uid; /* uid fuid (cached) */
f1696b231bb1209e1cea95b7ff29b8c60493daa0Mark Shellenbaum uint64_t z_gid; /* gid fuid (cached) */
0a586cea3ceec7e5e50e7e54c745082a7a333ac2Mark Shellenbaum mode_t z_mode; /* mode (cached) */
67bd71c6cc629bab3aa0d595c624a667f1574254perrin uint32_t z_sync_cnt; /* synchronous open count */
fa9e4066f08beec538e775443c5be79dd423fcabahrens kmutex_t z_acl_lock; /* acl data lock */
d47621a49c68c359358f6630aa45cc320762f51fTim Haley zfs_acl_t *z_acl_cached; /* cached acl */
fa9e4066f08beec538e775443c5be79dd423fcabahrens list_node_t z_link_node; /* all znodes in fs link */
0a586cea3ceec7e5e50e7e54c745082a7a333ac2Mark Shellenbaum sa_handle_t *z_sa_hdl; /* handle to sa data */
0a586cea3ceec7e5e50e7e54c745082a7a333ac2Mark Shellenbaum boolean_t z_is_sa; /* are we native sa? */
fa9e4066f08beec538e775443c5be79dd423fcabahrens} znode_t;
fa9e4066f08beec538e775443c5be79dd423fcabahrens
104e2ed78d9ef0a0f89f320108b8ca29ca3850d5perrin
fa9e4066f08beec538e775443c5be79dd423fcabahrens/*
104e2ed78d9ef0a0f89f320108b8ca29ca3850d5perrin * Range locking rules
104e2ed78d9ef0a0f89f320108b8ca29ca3850d5perrin * --------------------
104e2ed78d9ef0a0f89f320108b8ca29ca3850d5perrin * 1. When truncating a file (zfs_create, zfs_setattr, zfs_space) the whole
104e2ed78d9ef0a0f89f320108b8ca29ca3850d5perrin * file range needs to be locked as RL_WRITER. Only then can the pages be
104e2ed78d9ef0a0f89f320108b8ca29ca3850d5perrin * freed etc and zp_size reset. zp_size must be set within range lock.
104e2ed78d9ef0a0f89f320108b8ca29ca3850d5perrin * 2. For writes and punching holes (zfs_write & zfs_space) just the range
104e2ed78d9ef0a0f89f320108b8ca29ca3850d5perrin * being written or freed needs to be locked as RL_WRITER.
104e2ed78d9ef0a0f89f320108b8ca29ca3850d5perrin * Multiple writes at the end of the file must coordinate zp_size updates
104e2ed78d9ef0a0f89f320108b8ca29ca3850d5perrin * to ensure data isn't lost. A compare and swap loop is currently used
104e2ed78d9ef0a0f89f320108b8ca29ca3850d5perrin * to ensure the file size is at least the offset last written.
104e2ed78d9ef0a0f89f320108b8ca29ca3850d5perrin * 3. For reads (zfs_read, zfs_get_data & zfs_putapage) just the range being
104e2ed78d9ef0a0f89f320108b8ca29ca3850d5perrin * read needs to be locked as RL_READER. A check against zp_size can then
104e2ed78d9ef0a0f89f320108b8ca29ca3850d5perrin * be made for reading beyond end of file.
fa9e4066f08beec538e775443c5be79dd423fcabahrens */
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens/*
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Convert between znode pointers and vnode pointers
fa9e4066f08beec538e775443c5be79dd423fcabahrens */
fa9e4066f08beec538e775443c5be79dd423fcabahrens#define ZTOV(ZP) ((ZP)->z_vnode)
fa9e4066f08beec538e775443c5be79dd423fcabahrens#define VTOZ(VP) ((znode_t *)(VP)->v_data)
fa9e4066f08beec538e775443c5be79dd423fcabahrens
f7170741490edba9d1d9c697c177c887172bc741Will Andrews/* Called on entry to each ZFS vnode and vfs operation */
fa9e4066f08beec538e775443c5be79dd423fcabahrens#define ZFS_ENTER(zfsvfs) \
fa9e4066f08beec538e775443c5be79dd423fcabahrens { \
c9030f6c93613fe30ee0c16f92b96da7816ac052Alexander Motin rrm_enter_read(&(zfsvfs)->z_teardown_lock, FTAG); \
91ebeef555ce7f899b6270a3c2df47b51f7ad59aahrens if ((zfsvfs)->z_unmounted) { \
fa9e4066f08beec538e775443c5be79dd423fcabahrens ZFS_EXIT(zfsvfs); \
fa9e4066f08beec538e775443c5be79dd423fcabahrens return (EIO); \
fa9e4066f08beec538e775443c5be79dd423fcabahrens } \
fa9e4066f08beec538e775443c5be79dd423fcabahrens }
91ebeef555ce7f899b6270a3c2df47b51f7ad59aahrens
f7170741490edba9d1d9c697c177c887172bc741Will Andrews/* Must be called before exiting the vop */
c9030f6c93613fe30ee0c16f92b96da7816ac052Alexander Motin#define ZFS_EXIT(zfsvfs) rrm_exit(&(zfsvfs)->z_teardown_lock, FTAG)
f18faf3f3e5def85fdfff681617d227703ace2adek
f7170741490edba9d1d9c697c177c887172bc741Will Andrews/* Verifies the znode is valid */
3cb34c601f3ef3016f638574f5982e80c3735c71ahrens#define ZFS_VERIFY_ZP(zp) \
0a586cea3ceec7e5e50e7e54c745082a7a333ac2Mark Shellenbaum if ((zp)->z_sa_hdl == NULL) { \
3cb34c601f3ef3016f638574f5982e80c3735c71ahrens ZFS_EXIT((zp)->z_zfsvfs); \
3cb34c601f3ef3016f638574f5982e80c3735c71ahrens return (EIO); \
3cb34c601f3ef3016f638574f5982e80c3735c71ahrens } \
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens/*
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Macros for dealing with dmu_buf_hold
fa9e4066f08beec538e775443c5be79dd423fcabahrens */
4ccbb6e737373468bb9dc1709618384cce4c9f92ahrens#define ZFS_OBJ_HASH(obj_num) ((obj_num) & (ZFS_OBJ_MTX_SZ - 1))
b5fca8f855054d167d04d3b4de5210c83ed2083ctomee#define ZFS_OBJ_MUTEX(zfsvfs, obj_num) \
b5fca8f855054d167d04d3b4de5210c83ed2083ctomee (&(zfsvfs)->z_hold_mtx[ZFS_OBJ_HASH(obj_num)])
fa9e4066f08beec538e775443c5be79dd423fcabahrens#define ZFS_OBJ_HOLD_ENTER(zfsvfs, obj_num) \
b5fca8f855054d167d04d3b4de5210c83ed2083ctomee mutex_enter(ZFS_OBJ_MUTEX((zfsvfs), (obj_num)))
a66b2b3504619207b55d222c87bdd9df52832f15Tom Erickson#define ZFS_OBJ_HOLD_TRYENTER(zfsvfs, obj_num) \
a66b2b3504619207b55d222c87bdd9df52832f15Tom Erickson mutex_tryenter(ZFS_OBJ_MUTEX((zfsvfs), (obj_num)))
fa9e4066f08beec538e775443c5be79dd423fcabahrens#define ZFS_OBJ_HOLD_EXIT(zfsvfs, obj_num) \
b5fca8f855054d167d04d3b4de5210c83ed2083ctomee mutex_exit(ZFS_OBJ_MUTEX((zfsvfs), (obj_num)))
fa9e4066f08beec538e775443c5be79dd423fcabahrens
f7170741490edba9d1d9c697c177c887172bc741Will Andrews/* Encode ZFS stored time values from a struct timespec */
fa9e4066f08beec538e775443c5be79dd423fcabahrens#define ZFS_TIME_ENCODE(tp, stmp) \
fa9e4066f08beec538e775443c5be79dd423fcabahrens{ \
b5fca8f855054d167d04d3b4de5210c83ed2083ctomee (stmp)[0] = (uint64_t)(tp)->tv_sec; \
4ccbb6e737373468bb9dc1709618384cce4c9f92ahrens (stmp)[1] = (uint64_t)(tp)->tv_nsec; \
fa9e4066f08beec538e775443c5be79dd423fcabahrens}
fa9e4066f08beec538e775443c5be79dd423fcabahrens
f7170741490edba9d1d9c697c177c887172bc741Will Andrews/* Decode ZFS stored time values to a struct timespec */
fa9e4066f08beec538e775443c5be79dd423fcabahrens#define ZFS_TIME_DECODE(tp, stmp) \
fa9e4066f08beec538e775443c5be79dd423fcabahrens{ \
4ccbb6e737373468bb9dc1709618384cce4c9f92ahrens (tp)->tv_sec = (time_t)(stmp)[0]; \
4ccbb6e737373468bb9dc1709618384cce4c9f92ahrens (tp)->tv_nsec = (long)(stmp)[1]; \
fa9e4066f08beec538e775443c5be79dd423fcabahrens}
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens/*
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Timestamp defines
fa9e4066f08beec538e775443c5be79dd423fcabahrens */
fa9e4066f08beec538e775443c5be79dd423fcabahrens#define ACCESSED (AT_ATIME)
fa9e4066f08beec538e775443c5be79dd423fcabahrens#define STATE_CHANGED (AT_CTIME)
fa9e4066f08beec538e775443c5be79dd423fcabahrens#define CONTENT_MODIFIED (AT_MTIME | AT_CTIME)
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens#define ZFS_ACCESSTIME_STAMP(zfsvfs, zp) \
fa9e4066f08beec538e775443c5be79dd423fcabahrens if ((zfsvfs)->z_atime && !((zfsvfs)->z_vfs->vfs_flag & VFS_RDONLY)) \
0a586cea3ceec7e5e50e7e54c745082a7a333ac2Mark Shellenbaum zfs_tstamp_update_setup(zp, ACCESSED, NULL, NULL, B_FALSE);
fa9e4066f08beec538e775443c5be79dd423fcabahrens
088f389458728c464569a5506b58070254fa4f7dahrensextern int zfs_init_fs(zfsvfs_t *, znode_t **);
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern void zfs_set_dataprop(objset_t *);
de8267e0f723ed2c38ea9def92d465f69a300f56timhextern void zfs_create_fs(objset_t *os, cred_t *cr, nvlist_t *,
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw dmu_tx_t *tx);
0a586cea3ceec7e5e50e7e54c745082a7a333ac2Mark Shellenbaumextern void zfs_tstamp_update_setup(znode_t *, uint_t, uint64_t [2],
0a586cea3ceec7e5e50e7e54c745082a7a333ac2Mark Shellenbaum uint64_t [2], boolean_t);
104e2ed78d9ef0a0f89f320108b8ca29ca3850d5perrinextern void zfs_grow_blocksize(znode_t *, uint64_t, dmu_tx_t *);
5730cc9a43c5f11a472d7536ed81facfd10f1e2emaybeeextern int zfs_freesp(znode_t *, uint64_t, uint64_t, int, boolean_t);
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern void zfs_znode_init(void);
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern void zfs_znode_fini(void);
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern int zfs_zget(zfsvfs_t *, uint64_t, znode_t **);
f18faf3f3e5def85fdfff681617d227703ace2adekextern int zfs_rezget(znode_t *);
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern void zfs_zinactive(znode_t *);
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern void zfs_znode_delete(znode_t *, dmu_tx_t *);
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern void zfs_znode_free(znode_t *);
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern void zfs_remove_op_tables();
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern int zfs_create_op_tables();
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern int zfs_sync(vfs_t *vfsp, short flag, cred_t *cr);
72fc53bc90bd3b199d29d03ee68adb4a5a17d35bmarksextern dev_t zfs_cmpldev(uint64_t);
de8267e0f723ed2c38ea9def92d465f69a300f56timhextern int zfs_get_zplprop(objset_t *os, zfs_prop_t prop, uint64_t *value);
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwextern int zfs_get_stats(objset_t *os, nvlist_t *nv);
eb721827677c553ce8dd0d4390630a857f923f98Alek Pinchukextern boolean_t zfs_get_vfs_flag_unmounted(objset_t *os);
874395d5f8cae2b9cd2d1fcbfcfe963a0c23966dmaybeeextern void zfs_znode_dmu_fini(znode_t *);
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwextern void zfs_log_create(zilog_t *zilog, dmu_tx_t *tx, uint64_t txtype,
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw znode_t *dzp, znode_t *zp, char *name, vsecattr_t *, zfs_fuid_info_t *,
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw vattr_t *vap);
4ccbb6e737373468bb9dc1709618384cce4c9f92ahrensextern int zfs_log_create_txtype(zil_create_t, vsecattr_t *vsecp,
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw vattr_t *vap);
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwextern void zfs_log_remove(zilog_t *zilog, dmu_tx_t *tx, uint64_t txtype,
5002558f6bfef3915c7f3b4ecb7c19c7f044bf5bNeil Perrin znode_t *dzp, char *name, uint64_t foid);
5002558f6bfef3915c7f3b4ecb7c19c7f044bf5bNeil Perrin#define ZFS_NO_OBJECT 0 /* no object id */
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwextern void zfs_log_link(zilog_t *zilog, dmu_tx_t *tx, uint64_t txtype,
fa9e4066f08beec538e775443c5be79dd423fcabahrens znode_t *dzp, znode_t *zp, char *name);
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwextern void zfs_log_symlink(zilog_t *zilog, dmu_tx_t *tx, uint64_t txtype,
fa9e4066f08beec538e775443c5be79dd423fcabahrens znode_t *dzp, znode_t *zp, char *name, char *link);
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwextern void zfs_log_rename(zilog_t *zilog, dmu_tx_t *tx, uint64_t txtype,
91de656b0815c0aeab4e6fc638e9bb4577aa9513Neil Perrin znode_t *sdzp, char *sname, znode_t *tdzp, char *dname, znode_t *szp);
b19a79ec1a527828a60c4d325ccd8dcbeb2b2e8bperrinextern void zfs_log_write(zilog_t *zilog, dmu_tx_t *tx, int txtype,
feb08c6bb47ceffa5bb7a70f2c0549113f40fcc5billm znode_t *zp, offset_t off, ssize_t len, int ioflag);
b19a79ec1a527828a60c4d325ccd8dcbeb2b2e8bperrinextern void zfs_log_truncate(zilog_t *zilog, dmu_tx_t *tx, int txtype,
fa9e4066f08beec538e775443c5be79dd423fcabahrens znode_t *zp, uint64_t off, uint64_t len);
b19a79ec1a527828a60c4d325ccd8dcbeb2b2e8bperrinextern void zfs_log_setattr(zilog_t *zilog, dmu_tx_t *tx, int txtype,
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw znode_t *zp, vattr_t *vap, uint_t mask_applied, zfs_fuid_info_t *fuidp);
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwextern void zfs_log_acl(zilog_t *zilog, dmu_tx_t *tx, znode_t *zp,
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw vsecattr_t *vsecp, zfs_fuid_info_t *fuidp);
0a586cea3ceec7e5e50e7e54c745082a7a333ac2Mark Shellenbaumextern void zfs_xvattr_set(znode_t *zp, xvattr_t *xvap, dmu_tx_t *tx);
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwextern void zfs_upgrade(zfsvfs_t *zfsvfs, dmu_tx_t *tx);
148434217c040ea38dc844384f6ba68d9b325906Matthew Ahrensextern int zfs_create_share_dir(zfsvfs_t *zfsvfs, dmu_tx_t *tx);
fa9e4066f08beec538e775443c5be79dd423fcabahrens
0fab61babcfe4e703c15518d8ef8d07e1a545650Jonathan W Adamsextern caddr_t zfs_map_page(page_t *, enum seg_rw);
0fab61babcfe4e703c15518d8ef8d07e1a545650Jonathan W Adamsextern void zfs_unmap_page(page_t *, caddr_t);
0fab61babcfe4e703c15518d8ef8d07e1a545650Jonathan W Adams
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern zil_get_data_t zfs_get_data;
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern zil_replay_func_t *zfs_replay_vector[TX_MAX_TYPE];
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern int zfsfstype;
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens#endif /* _KERNEL */
fa9e4066f08beec538e775443c5be79dd423fcabahrens
55434c770c89aa1b84474f2559a106803511aba0ekextern int zfs_obj_to_path(objset_t *osp, uint64_t obj, char *buf, int len);
55434c770c89aa1b84474f2559a106803511aba0ek
fa9e4066f08beec538e775443c5be79dd423fcabahrens#ifdef __cplusplus
fa9e4066f08beec538e775443c5be79dd423fcabahrens}
fa9e4066f08beec538e775443c5be79dd423fcabahrens#endif
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens#endif /* _SYS_FS_ZFS_ZNODE_H */