[mirror_zfs.git] / include / sys / zfs_znode.h

/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License (the "License").
 * You may not use this file except in compliance with the License.
 *
 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
 * or http://www.opensolaris.org/os/licensing.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information: Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 */
/*
 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
 * Copyright (c) 2012, 2015 by Delphix. All rights reserved.
 * Copyright 2016 Nexenta Systems, Inc. All rights reserved.
 */

#ifndef	_SYS_FS_ZFS_ZNODE_H
#define	_SYS_FS_ZFS_ZNODE_H

#ifdef _KERNEL
#include <sys/isa_defs.h>
#include <sys/types32.h>
#include <sys/attr.h>
#include <sys/list.h>
#include <sys/dmu.h>
#include <sys/sa.h>
#include <sys/zfs_vfsops.h>
#include <sys/rrwlock.h>
#include <sys/zfs_sa.h>
#include <sys/zfs_stat.h>
#include <sys/zfs_rlock.h>
#endif
#include <sys/zfs_acl.h>
#include <sys/zil.h>
#include <sys/zfs_project.h>

#ifdef	__cplusplus
extern "C" {
#endif

/*
 * Additional file level attributes, that are stored
 * in the upper half of zp_flags
 */
#define	ZFS_READONLY		0x0000000100000000ull
#define	ZFS_HIDDEN		0x0000000200000000ull
#define	ZFS_SYSTEM		0x0000000400000000ull
#define	ZFS_ARCHIVE		0x0000000800000000ull
#define	ZFS_IMMUTABLE		0x0000001000000000ull
#define	ZFS_NOUNLINK		0x0000002000000000ull
#define	ZFS_APPENDONLY		0x0000004000000000ull
#define	ZFS_NODUMP		0x0000008000000000ull
#define	ZFS_OPAQUE		0x0000010000000000ull
#define	ZFS_AV_QUARANTINED	0x0000020000000000ull
#define	ZFS_AV_MODIFIED		0x0000040000000000ull
#define	ZFS_REPARSE		0x0000080000000000ull
#define	ZFS_OFFLINE		0x0000100000000000ull
#define	ZFS_SPARSE		0x0000200000000000ull

/*
 * PROJINHERIT attribute is used to indicate that the child object under the
 * directory which has the PROJINHERIT attribute needs to inherit its parent
 * project ID that is used by project quota.
 */
#define	ZFS_PROJINHERIT		0x0000400000000000ull

/*
 * PROJID attr is used internally to indicate that the object has project ID.
 */
#define	ZFS_PROJID		0x0000800000000000ull

#define	ZFS_ATTR_SET(zp, attr, value, pflags, tx) \
{ \
	if (value) \
		pflags |= attr; \
	else \
		pflags &= ~attr; \
	VERIFY(0 == sa_update(zp->z_sa_hdl, SA_ZPL_FLAGS(ZTOZSB(zp)), \
	    &pflags, sizeof (pflags), tx)); \
}

/*
 * Define special zfs pflags
 */
#define	ZFS_XATTR		0x1		/* is an extended attribute */
#define	ZFS_INHERIT_ACE		0x2		/* ace has inheritable ACEs */
#define	ZFS_ACL_TRIVIAL		0x4		/* files ACL is trivial */
#define	ZFS_ACL_OBJ_ACE		0x8		/* ACL has CMPLX Object ACE */
#define	ZFS_ACL_PROTECTED	0x10		/* ACL protected */
#define	ZFS_ACL_DEFAULTED	0x20		/* ACL should be defaulted */
#define	ZFS_ACL_AUTO_INHERIT	0x40		/* ACL should be inherited */
#define	ZFS_BONUS_SCANSTAMP	0x80		/* Scanstamp in bonus area */
#define	ZFS_NO_EXECS_DENIED	0x100		/* exec was given to everyone */

#define	SA_ZPL_ATIME(z)		z->z_attr_table[ZPL_ATIME]
#define	SA_ZPL_MTIME(z)		z->z_attr_table[ZPL_MTIME]
#define	SA_ZPL_CTIME(z)		z->z_attr_table[ZPL_CTIME]
#define	SA_ZPL_CRTIME(z)	z->z_attr_table[ZPL_CRTIME]
#define	SA_ZPL_GEN(z)		z->z_attr_table[ZPL_GEN]
#define	SA_ZPL_DACL_ACES(z)	z->z_attr_table[ZPL_DACL_ACES]
#define	SA_ZPL_XATTR(z)		z->z_attr_table[ZPL_XATTR]
#define	SA_ZPL_SYMLINK(z)	z->z_attr_table[ZPL_SYMLINK]
#define	SA_ZPL_RDEV(z)		z->z_attr_table[ZPL_RDEV]
#define	SA_ZPL_SCANSTAMP(z)	z->z_attr_table[ZPL_SCANSTAMP]
#define	SA_ZPL_UID(z)		z->z_attr_table[ZPL_UID]
#define	SA_ZPL_GID(z)		z->z_attr_table[ZPL_GID]
#define	SA_ZPL_PARENT(z)	z->z_attr_table[ZPL_PARENT]
#define	SA_ZPL_LINKS(z)		z->z_attr_table[ZPL_LINKS]
#define	SA_ZPL_MODE(z)		z->z_attr_table[ZPL_MODE]
#define	SA_ZPL_DACL_COUNT(z)	z->z_attr_table[ZPL_DACL_COUNT]
#define	SA_ZPL_FLAGS(z)		z->z_attr_table[ZPL_FLAGS]
#define	SA_ZPL_SIZE(z)		z->z_attr_table[ZPL_SIZE]
#define	SA_ZPL_ZNODE_ACL(z)	z->z_attr_table[ZPL_ZNODE_ACL]
#define	SA_ZPL_DXATTR(z)	z->z_attr_table[ZPL_DXATTR]
#define	SA_ZPL_PAD(z)		z->z_attr_table[ZPL_PAD]
#define	SA_ZPL_PROJID(z)	z->z_attr_table[ZPL_PROJID]

/*
 * Is ID ephemeral?
 */
#define	IS_EPHEMERAL(x)		(x > MAXUID)

/*
 * Should we use FUIDs?
 */
#define	USE_FUIDS(version, os)	(version >= ZPL_VERSION_FUID && \
    spa_version(dmu_objset_spa(os)) >= SPA_VERSION_FUID)
#define	USE_SA(version, os) (version >= ZPL_VERSION_SA && \
    spa_version(dmu_objset_spa(os)) >= SPA_VERSION_SA)

#define	MASTER_NODE_OBJ	1

/*
 * Special attributes for master node.
 * "userquota@", "groupquota@" and "projectquota@" are also valid (from
 * zfs_userquota_prop_prefixes[]).
 */
#define	ZFS_FSID		"FSID"
#define	ZFS_UNLINKED_SET	"DELETE_QUEUE"
#define	ZFS_ROOT_OBJ		"ROOT"
#define	ZPL_VERSION_STR		"VERSION"
#define	ZFS_FUID_TABLES		"FUID"
#define	ZFS_SHARES_DIR		"SHARES"
#define	ZFS_SA_ATTRS		"SA_ATTRS"

/*
 * Convert mode bits (zp_mode) to BSD-style DT_* values for storing in
 * the directory entries.  On Linux systems this value is already
 * defined correctly as part of the /usr/include/dirent.h header file.
 */
#ifndef IFTODT
#define	IFTODT(mode) (((mode) & S_IFMT) >> 12)
#endif

/*
 * The directory entry has the type (currently unused on Solaris) in the
 * top 4 bits, and the object number in the low 48 bits.  The "middle"
 * 12 bits are unused.
 */
#define	ZFS_DIRENT_TYPE(de) BF64_GET(de, 60, 4)
#define	ZFS_DIRENT_OBJ(de) BF64_GET(de, 0, 48)

/*
 * Directory entry locks control access to directory entries.
 * They are used to protect creates, deletes, and renames.
 * Each directory znode has a mutex and a list of locked names.
 */
#ifdef _KERNEL
typedef struct zfs_dirlock {
	char		*dl_name;	/* directory entry being locked */
	uint32_t	dl_sharecnt;	/* 0 if exclusive, > 0 if shared */
	uint8_t		dl_namelock;	/* 1 if z_name_lock is NOT held */
	uint16_t	dl_namesize;	/* set if dl_name was allocated */
	kcondvar_t	dl_cv;		/* wait for entry to be unlocked */
	struct znode	*dl_dzp;	/* directory znode */
	struct zfs_dirlock *dl_next;	/* next in z_dirlocks list */
} zfs_dirlock_t;

typedef struct znode {
	uint64_t	z_id;		/* object ID for this znode */
	kmutex_t	z_lock;		/* znode modification lock */
	krwlock_t	z_parent_lock;	/* parent lock for directories */
	krwlock_t	z_name_lock;	/* "master" lock for dirent locks */
	zfs_dirlock_t	*z_dirlocks;	/* directory entry lock list */
	zfs_rlock_t	z_range_lock;	/* file range lock */
	uint8_t		z_unlinked;	/* file has been unlinked */
	uint8_t		z_atime_dirty;	/* atime needs to be synced */
	uint8_t		z_zn_prefetch;	/* Prefetch znodes? */
	uint8_t		z_moved;	/* Has this znode been moved? */
	uint_t		z_blksz;	/* block size in bytes */
	uint_t		z_seq;		/* modification sequence number */
	uint64_t	z_mapcnt;	/* number of pages mapped to file */
	uint64_t	z_dnodesize;	/* dnode size */
	uint64_t	z_size;		/* file size (cached) */
	uint64_t	z_pflags;	/* pflags (cached) */
	uint32_t	z_sync_cnt;	/* synchronous open count */
	mode_t		z_mode;		/* mode (cached) */
	kmutex_t	z_acl_lock;	/* acl data lock */
	zfs_acl_t	*z_acl_cached;	/* cached acl */
	krwlock_t	z_xattr_lock;	/* xattr data lock */
	nvlist_t	*z_xattr_cached; /* cached xattrs */
	uint64_t	z_xattr_parent;	/* parent obj for this xattr */
	uint64_t	z_projid;	/* project ID */
	list_node_t	z_link_node;	/* all znodes in fs link */
	sa_handle_t	*z_sa_hdl;	/* handle to sa data */
	boolean_t	z_is_sa;	/* are we native sa? */
	boolean_t	z_is_mapped;	/* are we mmap'ed */
	boolean_t	z_is_ctldir;	/* are we .zfs entry */
	boolean_t	z_is_stale;	/* are we stale due to rollback? */
	struct inode	z_inode;	/* generic vfs inode */
} znode_t;

typedef struct znode_hold {
	uint64_t	zh_obj;		/* object id */
	kmutex_t	zh_lock;	/* lock serializing object access */
	avl_node_t	zh_node;	/* avl tree linkage */
	refcount_t	zh_refcount;	/* active consumer reference count */
} znode_hold_t;

static inline uint64_t
zfs_inherit_projid(znode_t *dzp)
{
	return ((dzp->z_pflags & ZFS_PROJINHERIT) ? dzp->z_projid :
	    ZFS_DEFAULT_PROJID);
}

/*
 * Range locking rules
 * --------------------
 * 1. When truncating a file (zfs_create, zfs_setattr, zfs_space) the whole
 *    file range needs to be locked as RL_WRITER. Only then can the pages be
 *    freed etc and zp_size reset. zp_size must be set within range lock.
 * 2. For writes and punching holes (zfs_write & zfs_space) just the range
 *    being written or freed needs to be locked as RL_WRITER.
 *    Multiple writes at the end of the file must coordinate zp_size updates
 *    to ensure data isn't lost. A compare and swap loop is currently used
 *    to ensure the file size is at least the offset last written.
 * 3. For reads (zfs_read, zfs_get_data & zfs_putapage) just the range being
 *    read needs to be locked as RL_READER. A check against zp_size can then
 *    be made for reading beyond end of file.
 */

/*
 * Convert between znode pointers and inode pointers
 */
#define	ZTOI(znode)	(&((znode)->z_inode))
#define	ITOZ(inode)	(container_of((inode), znode_t, z_inode))
#define	ZTOZSB(znode)	((zfsvfs_t *)(ZTOI(znode)->i_sb->s_fs_info))
#define	ITOZSB(inode)	((zfsvfs_t *)((inode)->i_sb->s_fs_info))

#define	S_ISDEV(mode)	(S_ISCHR(mode) || S_ISBLK(mode) || S_ISFIFO(mode))

/* Called on entry to each ZFS vnode and vfs operation  */
#define	ZFS_ENTER(zfsvfs) \
	{ \
		rrm_enter_read(&(zfsvfs)->z_teardown_lock, FTAG); \
		if ((zfsvfs)->z_unmounted) { \
			ZFS_EXIT(zfsvfs); \
			return (EIO); \
		} \
	}

/* Must be called before exiting the vop */
#define	ZFS_EXIT(zfsvfs) \
	{ \
		rrm_exit(&(zfsvfs)->z_teardown_lock, FTAG); \
	}

/* Verifies the znode is valid */
#define	ZFS_VERIFY_ZP(zp) \
	if ((zp)->z_sa_hdl == NULL) { \
		ZFS_EXIT(ZTOZSB(zp)); \
		return (EIO); \
	}

/*
 * Macros for dealing with dmu_buf_hold
 */
#define	ZFS_OBJ_MTX_SZ		64
#define	ZFS_OBJ_MTX_MAX		(1024 * 1024)
#define	ZFS_OBJ_HASH(zfsvfs, obj)	((obj) & ((zfsvfs->z_hold_size) - 1))

extern unsigned int zfs_object_mutex_size;

/* Encode ZFS stored time values from a struct timespec */
#define	ZFS_TIME_ENCODE(tp, stmp)		\
{						\
	(stmp)[0] = (uint64_t)(tp)->tv_sec;	\
	(stmp)[1] = (uint64_t)(tp)->tv_nsec;	\
}

/* Decode ZFS stored time values to a struct timespec */
#define	ZFS_TIME_DECODE(tp, stmp)		\
{						\
	(tp)->tv_sec = (time_t)(stmp)[0];		\
	(tp)->tv_nsec = (long)(stmp)[1];		\
}

/*
 * Timestamp defines
 */
#define	ACCESSED		(ATTR_ATIME)
#define	STATE_CHANGED		(ATTR_CTIME)
#define	CONTENT_MODIFIED	(ATTR_MTIME | ATTR_CTIME)

extern int	zfs_init_fs(zfsvfs_t *, znode_t **);
extern void	zfs_set_dataprop(objset_t *);
extern void	zfs_create_fs(objset_t *os, cred_t *cr, nvlist_t *,
    dmu_tx_t *tx);
extern void	zfs_tstamp_update_setup(znode_t *, uint_t, uint64_t [2],
    uint64_t [2]);
extern void	zfs_grow_blocksize(znode_t *, uint64_t, dmu_tx_t *);
extern int	zfs_freesp(znode_t *, uint64_t, uint64_t, int, boolean_t);
extern void	zfs_znode_init(void);
extern void	zfs_znode_fini(void);
extern int	zfs_znode_hold_compare(const void *, const void *);
extern int	zfs_zget(zfsvfs_t *, uint64_t, znode_t **);
extern int	zfs_rezget(znode_t *);
extern void	zfs_zinactive(znode_t *);
extern void	zfs_znode_delete(znode_t *, dmu_tx_t *);
extern void	zfs_remove_op_tables(void);
extern int	zfs_create_op_tables(void);
extern int	zfs_sync(struct super_block *, int, cred_t *);
extern dev_t	zfs_cmpldev(uint64_t);
extern int	zfs_get_zplprop(objset_t *os, zfs_prop_t prop, uint64_t *value);
extern int	zfs_get_stats(objset_t *os, nvlist_t *nv);
extern boolean_t zfs_get_vfs_flag_unmounted(objset_t *os);
extern void	zfs_znode_dmu_fini(znode_t *);
extern int	zfs_inode_alloc(struct super_block *, struct inode **ip);
extern void	zfs_inode_destroy(struct inode *);
extern void	zfs_inode_update(znode_t *);
extern void	zfs_mark_inode_dirty(struct inode *);

extern void zfs_log_create(zilog_t *zilog, dmu_tx_t *tx, uint64_t txtype,
    znode_t *dzp, znode_t *zp, char *name, vsecattr_t *, zfs_fuid_info_t *,
    vattr_t *vap);
extern int zfs_log_create_txtype(zil_create_t, vsecattr_t *vsecp,
    vattr_t *vap);
extern void zfs_log_remove(zilog_t *zilog, dmu_tx_t *tx, uint64_t txtype,
    znode_t *dzp, char *name, uint64_t foid);
#define	ZFS_NO_OBJECT	0	/* no object id */
extern void zfs_log_link(zilog_t *zilog, dmu_tx_t *tx, uint64_t txtype,
    znode_t *dzp, znode_t *zp, char *name);
extern void zfs_log_symlink(zilog_t *zilog, dmu_tx_t *tx, uint64_t txtype,
    znode_t *dzp, znode_t *zp, char *name, char *link);
extern void zfs_log_rename(zilog_t *zilog, dmu_tx_t *tx, uint64_t txtype,
    znode_t *sdzp, char *sname, znode_t *tdzp, char *dname, znode_t *szp);
extern void zfs_log_write(zilog_t *zilog, dmu_tx_t *tx, int txtype,
    znode_t *zp, offset_t off, ssize_t len, int ioflag,
    zil_callback_t callback, void *callback_data);
extern void zfs_log_truncate(zilog_t *zilog, dmu_tx_t *tx, int txtype,
    znode_t *zp, uint64_t off, uint64_t len);
extern void zfs_log_setattr(zilog_t *zilog, dmu_tx_t *tx, int txtype,
    znode_t *zp, vattr_t *vap, uint_t mask_applied, zfs_fuid_info_t *fuidp);
extern void zfs_log_acl(zilog_t *zilog, dmu_tx_t *tx, znode_t *zp,
    vsecattr_t *vsecp, zfs_fuid_info_t *fuidp);
extern void zfs_xvattr_set(znode_t *zp, xvattr_t *xvap, dmu_tx_t *tx);
extern void zfs_upgrade(zfsvfs_t *zfsvfs, dmu_tx_t *tx);
extern int zfs_create_share_dir(zfsvfs_t *zfsvfs, dmu_tx_t *tx);

#if defined(HAVE_UIO_RW)
extern caddr_t zfs_map_page(page_t *, enum seg_rw);
extern void zfs_unmap_page(page_t *, caddr_t);
#endif /* HAVE_UIO_RW */

extern zil_get_data_t zfs_get_data;
extern zil_replay_func_t *zfs_replay_vector[TX_MAX_TYPE];
extern int zfsfstype;

#endif /* _KERNEL */

extern int zfs_obj_to_path(objset_t *osp, uint64_t obj, char *buf, int len);

#ifdef	__cplusplus
}
#endif

#endif	/* _SYS_FS_ZFS_ZNODE_H */
Commit	Line	Data
34dc7c2f BB	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 http://www.opensolaris.org/os/licensing.
	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	/*
572e2857	22	* Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
eca7b760	23	* Copyright (c) 2012, 2015 by Delphix. All rights reserved.
a08abc1b	24	* Copyright 2016 Nexenta Systems, Inc. All rights reserved.
34dc7c2f BB	25	*/
	26
	27	#ifndef _SYS_FS_ZFS_ZNODE_H
	28	#define _SYS_FS_ZFS_ZNODE_H
	29
34dc7c2f BB	30	#ifdef _KERNEL
	31	#include <sys/isa_defs.h>
	32	#include <sys/types32.h>
	33	#include <sys/attr.h>
	34	#include <sys/list.h>
	35	#include <sys/dmu.h>
428870ff	36	#include <sys/sa.h>
34dc7c2f BB	37	#include <sys/zfs_vfsops.h>
34dc7c2f BB	38	#include <sys/rrwlock.h>
428870ff	39	#include <sys/zfs_sa.h>
572e2857	40	#include <sys/zfs_stat.h>
d88895a0	41	#include <sys/zfs_rlock.h>
34dc7c2f BB	42	#endif
	43	#include <sys/zfs_acl.h>
	44	#include <sys/zil.h>
9c5167d1	45	#include <sys/zfs_project.h>
34dc7c2f BB	46
	47	#ifdef __cplusplus
	48	extern "C" {
	49	#endif
	50
	51	/*
	52	* Additional file level attributes, that are stored
	53	* in the upper half of zp_flags
	54	*/
c5b3a7bb RC	55	#define ZFS_READONLY 0x0000000100000000ull
	56	#define ZFS_HIDDEN 0x0000000200000000ull
	57	#define ZFS_SYSTEM 0x0000000400000000ull
	58	#define ZFS_ARCHIVE 0x0000000800000000ull
	59	#define ZFS_IMMUTABLE 0x0000001000000000ull
	60	#define ZFS_NOUNLINK 0x0000002000000000ull
	61	#define ZFS_APPENDONLY 0x0000004000000000ull
	62	#define ZFS_NODUMP 0x0000008000000000ull
	63	#define ZFS_OPAQUE 0x0000010000000000ull
5484965a BB	64	#define ZFS_AV_QUARANTINED 0x0000020000000000ull
5484965a BB	65	#define ZFS_AV_MODIFIED 0x0000040000000000ull
c5b3a7bb RC	66	#define ZFS_REPARSE 0x0000080000000000ull
	67	#define ZFS_OFFLINE 0x0000100000000000ull
	68	#define ZFS_SPARSE 0x0000200000000000ull
34dc7c2f	69
9c5167d1 NF	70	/*
	71	* PROJINHERIT attribute is used to indicate that the child object under the
	72	* directory which has the PROJINHERIT attribute needs to inherit its parent
	73	* project ID that is used by project quota.
	74	*/
	75	#define ZFS_PROJINHERIT 0x0000400000000000ull
	76
	77	/*
	78	* PROJID attr is used internally to indicate that the object has project ID.
	79	*/
	80	#define ZFS_PROJID 0x0000800000000000ull
	81
428870ff	82	#define ZFS_ATTR_SET(zp, attr, value, pflags, tx) \
34dc7c2f BB	83	{ \
34dc7c2f BB	84	if (value) \
428870ff	85	pflags \|= attr; \
34dc7c2f	86	else \
428870ff	87	pflags &= ~attr; \
5484965a	88	VERIFY(0 == sa_update(zp->z_sa_hdl, SA_ZPL_FLAGS(ZTOZSB(zp)), \
428870ff	89	&pflags, sizeof (pflags), tx)); \
34dc7c2f BB	90	}
	91
	92	/*
	93	* Define special zfs pflags
	94	*/
	95	#define ZFS_XATTR 0x1 /* is an extended attribute */
	96	#define ZFS_INHERIT_ACE 0x2 /* ace has inheritable ACEs */
5484965a BB	97	#define ZFS_ACL_TRIVIAL 0x4 /* files ACL is trivial */
5484965a BB	98	#define ZFS_ACL_OBJ_ACE 0x8 /* ACL has CMPLX Object ACE */
34dc7c2f BB	99	#define ZFS_ACL_PROTECTED 0x10 /* ACL protected */
	100	#define ZFS_ACL_DEFAULTED 0x20 /* ACL should be defaulted */
	101	#define ZFS_ACL_AUTO_INHERIT 0x40 /* ACL should be inherited */
	102	#define ZFS_BONUS_SCANSTAMP 0x80 /* Scanstamp in bonus area */
45d1cae3	103	#define ZFS_NO_EXECS_DENIED 0x100 /* exec was given to everyone */
34dc7c2f	104
428870ff BB	105	#define SA_ZPL_ATIME(z) z->z_attr_table[ZPL_ATIME]
	106	#define SA_ZPL_MTIME(z) z->z_attr_table[ZPL_MTIME]
	107	#define SA_ZPL_CTIME(z) z->z_attr_table[ZPL_CTIME]
	108	#define SA_ZPL_CRTIME(z) z->z_attr_table[ZPL_CRTIME]
	109	#define SA_ZPL_GEN(z) z->z_attr_table[ZPL_GEN]
	110	#define SA_ZPL_DACL_ACES(z) z->z_attr_table[ZPL_DACL_ACES]
	111	#define SA_ZPL_XATTR(z) z->z_attr_table[ZPL_XATTR]
	112	#define SA_ZPL_SYMLINK(z) z->z_attr_table[ZPL_SYMLINK]
	113	#define SA_ZPL_RDEV(z) z->z_attr_table[ZPL_RDEV]
	114	#define SA_ZPL_SCANSTAMP(z) z->z_attr_table[ZPL_SCANSTAMP]
	115	#define SA_ZPL_UID(z) z->z_attr_table[ZPL_UID]
	116	#define SA_ZPL_GID(z) z->z_attr_table[ZPL_GID]
	117	#define SA_ZPL_PARENT(z) z->z_attr_table[ZPL_PARENT]
	118	#define SA_ZPL_LINKS(z) z->z_attr_table[ZPL_LINKS]
	119	#define SA_ZPL_MODE(z) z->z_attr_table[ZPL_MODE]
	120	#define SA_ZPL_DACL_COUNT(z) z->z_attr_table[ZPL_DACL_COUNT]
	121	#define SA_ZPL_FLAGS(z) z->z_attr_table[ZPL_FLAGS]
	122	#define SA_ZPL_SIZE(z) z->z_attr_table[ZPL_SIZE]
	123	#define SA_ZPL_ZNODE_ACL(z) z->z_attr_table[ZPL_ZNODE_ACL]
82a37189	124	#define SA_ZPL_DXATTR(z) z->z_attr_table[ZPL_DXATTR]
428870ff	125	#define SA_ZPL_PAD(z) z->z_attr_table[ZPL_PAD]
9c5167d1	126	#define SA_ZPL_PROJID(z) z->z_attr_table[ZPL_PROJID]
428870ff	127
34dc7c2f BB	128	/*
	129	* Is ID ephemeral?
	130	*/
	131	#define IS_EPHEMERAL(x) (x > MAXUID)
	132
	133	/*
	134	* Should we use FUIDs?
	135	*/
428870ff	136	#define USE_FUIDS(version, os) (version >= ZPL_VERSION_FUID && \
34dc7c2f	137	spa_version(dmu_objset_spa(os)) >= SPA_VERSION_FUID)
428870ff BB	138	#define USE_SA(version, os) (version >= ZPL_VERSION_SA && \
428870ff BB	139	spa_version(dmu_objset_spa(os)) >= SPA_VERSION_SA)
34dc7c2f BB	140
	141	#define MASTER_NODE_OBJ 1
	142
	143	/*
	144	* Special attributes for master node.
9c5167d1	145	* "userquota@", "groupquota@" and "projectquota@" are also valid (from
9babb374	146	* zfs_userquota_prop_prefixes[]).
34dc7c2f BB	147	*/
	148	#define ZFS_FSID "FSID"
	149	#define ZFS_UNLINKED_SET "DELETE_QUEUE"
	150	#define ZFS_ROOT_OBJ "ROOT"
	151	#define ZPL_VERSION_STR "VERSION"
	152	#define ZFS_FUID_TABLES "FUID"
9babb374	153	#define ZFS_SHARES_DIR "SHARES"
428870ff	154	#define ZFS_SA_ATTRS "SA_ATTRS"
34dc7c2f	155
34dc7c2f BB	156	/*
34dc7c2f BB	157	* Convert mode bits (zp_mode) to BSD-style DT_* values for storing in
054bc00b BB	158	* the directory entries. On Linux systems this value is already
054bc00b BB	159	* defined correctly as part of the /usr/include/dirent.h header file.
34dc7c2f	160	*/
054bc00b	161	#ifndef IFTODT
34dc7c2f	162	#define IFTODT(mode) (((mode) & S_IFMT) >> 12)
054bc00b	163	#endif
34dc7c2f BB	164
	165	/*
	166	* The directory entry has the type (currently unused on Solaris) in the
	167	* top 4 bits, and the object number in the low 48 bits. The "middle"
	168	* 12 bits are unused.
	169	*/
	170	#define ZFS_DIRENT_TYPE(de) BF64_GET(de, 60, 4)
	171	#define ZFS_DIRENT_OBJ(de) BF64_GET(de, 0, 48)
	172
34dc7c2f BB	173	/*
	174	* Directory entry locks control access to directory entries.
	175	* They are used to protect creates, deletes, and renames.
	176	* Each directory znode has a mutex and a list of locked names.
	177	*/
	178	#ifdef _KERNEL
	179	typedef struct zfs_dirlock {
	180	char dl_name; / directory entry being locked */
	181	uint32_t dl_sharecnt; /* 0 if exclusive, > 0 if shared */
428870ff	182	uint8_t dl_namelock; /* 1 if z_name_lock is NOT held */
34dc7c2f BB	183	uint16_t dl_namesize; /* set if dl_name was allocated */
	184	kcondvar_t dl_cv; /* wait for entry to be unlocked */
	185	struct znode dl_dzp; / directory znode */
	186	struct zfs_dirlock dl_next; / next in z_dirlocks list */
	187	} zfs_dirlock_t;
	188
	189	typedef struct znode {
34dc7c2f BB	190	uint64_t z_id; /* object ID for this znode */
34dc7c2f BB	191	kmutex_t z_lock; /* znode modification lock */
34dc7c2f BB	192	krwlock_t z_parent_lock; /* parent lock for directories */
	193	krwlock_t z_name_lock; /* "master" lock for dirent locks */
	194	zfs_dirlock_t z_dirlocks; / directory entry lock list */
d88895a0	195	zfs_rlock_t z_range_lock; /* file range lock */
34dc7c2f BB	196	uint8_t z_unlinked; /* file has been unlinked */
	197	uint8_t z_atime_dirty; /* atime needs to be synced */
	198	uint8_t z_zn_prefetch; /* Prefetch znodes? */
572e2857	199	uint8_t z_moved; /* Has this znode been moved? */
34dc7c2f BB	200	uint_t z_blksz; /* block size in bytes */
	201	uint_t z_seq; /* modification sequence number */
	202	uint64_t z_mapcnt; /* number of pages mapped to file */
50c957f7	203	uint64_t z_dnodesize; /* dnode size */
428870ff	204	uint64_t z_size; /* file size (cached) */
428870ff	205	uint64_t z_pflags; /* pflags (cached) */
34dc7c2f	206	uint32_t z_sync_cnt; /* synchronous open count */
7f89ae6b	207	mode_t z_mode; /* mode (cached) */
34dc7c2f	208	kmutex_t z_acl_lock; /* acl data lock */
45d1cae3	209	zfs_acl_t z_acl_cached; / cached acl */
82a37189	210	krwlock_t z_xattr_lock; /* xattr data lock */
d1d7e268	211	nvlist_t z_xattr_cached; / cached xattrs */
98701490	212	uint64_t z_xattr_parent; /* parent obj for this xattr */
9c5167d1	213	uint64_t z_projid; /* project ID */
34dc7c2f	214	list_node_t z_link_node; /* all znodes in fs link */
428870ff BB	215	sa_handle_t z_sa_hdl; / handle to sa data */
428870ff BB	216	boolean_t z_is_sa; /* are we native sa? */
c0d35759	217	boolean_t z_is_mapped; /* are we mmap'ed */
ebe7e575	218	boolean_t z_is_ctldir; /* are we .zfs entry */
7b3e34ba	219	boolean_t z_is_stale; /* are we stale due to rollback? */
7304b6e5	220	struct inode z_inode; /* generic vfs inode */
34dc7c2f BB	221	} znode_t;
34dc7c2f BB	222
c96c36fa BB	223	typedef struct znode_hold {
	224	uint64_t zh_obj; /* object id */
	225	kmutex_t zh_lock; /* lock serializing object access */
	226	avl_node_t zh_node; /* avl tree linkage */
	227	refcount_t zh_refcount; /* active consumer reference count */
	228	} znode_hold_t;
34dc7c2f	229
9c5167d1 NF	230	static inline uint64_t
	231	zfs_inherit_projid(znode_t *dzp)
	232	{
	233	return ((dzp->z_pflags & ZFS_PROJINHERIT) ? dzp->z_projid :
	234	ZFS_DEFAULT_PROJID);
	235	}
	236
34dc7c2f BB	237	/*
	238	* Range locking rules
	239	* --------------------
	240	* 1. When truncating a file (zfs_create, zfs_setattr, zfs_space) the whole
	241	* file range needs to be locked as RL_WRITER. Only then can the pages be
	242	* freed etc and zp_size reset. zp_size must be set within range lock.
	243	* 2. For writes and punching holes (zfs_write & zfs_space) just the range
	244	* being written or freed needs to be locked as RL_WRITER.
	245	* Multiple writes at the end of the file must coordinate zp_size updates
	246	* to ensure data isn't lost. A compare and swap loop is currently used
	247	* to ensure the file size is at least the offset last written.
	248	* 3. For reads (zfs_read, zfs_get_data & zfs_putapage) just the range being
	249	* read needs to be locked as RL_READER. A check against zp_size can then
	250	* be made for reading beyond end of file.
	251	*/
	252
	253	/*
7304b6e5	254	* Convert between znode pointers and inode pointers
34dc7c2f	255	*/
3558fd73 BB	256	#define ZTOI(znode) (&((znode)->z_inode))
3558fd73 BB	257	#define ITOZ(inode) (container_of((inode), znode_t, z_inode))
0037b49e BB	258	#define ZTOZSB(znode) ((zfsvfs_t *)(ZTOI(znode)->i_sb->s_fs_info))
0037b49e BB	259	#define ITOZSB(inode) ((zfsvfs_t *)((inode)->i_sb->s_fs_info))
34dc7c2f	260
3558fd73	261	#define S_ISDEV(mode) (S_ISCHR(mode) \|\| S_ISBLK(mode) \|\| S_ISFIFO(mode))
7304b6e5	262
d3cc8b15	263	/* Called on entry to each ZFS vnode and vfs operation */
0037b49e	264	#define ZFS_ENTER(zfsvfs) \
34dc7c2f	265	{ \
0037b49e BB	266	rrm_enter_read(&(zfsvfs)->z_teardown_lock, FTAG); \
	267	if ((zfsvfs)->z_unmounted) { \
	268	ZFS_EXIT(zfsvfs); \
34dc7c2f BB	269	return (EIO); \
	270	} \
	271	}
	272
d3cc8b15	273	/* Must be called before exiting the vop */
0037b49e	274	#define ZFS_EXIT(zfsvfs) \
3558fd73	275	{ \
0037b49e	276	rrm_exit(&(zfsvfs)->z_teardown_lock, FTAG); \
3558fd73	277	}
34dc7c2f	278
d3cc8b15	279	/* Verifies the znode is valid */
34dc7c2f	280	#define ZFS_VERIFY_ZP(zp) \
428870ff	281	if ((zp)->z_sa_hdl == NULL) { \
3558fd73	282	ZFS_EXIT(ZTOZSB(zp)); \
34dc7c2f	283	return (EIO); \
3558fd73	284	}
34dc7c2f BB	285
	286	/*
	287	* Macros for dealing with dmu_buf_hold
	288	*/
c96c36fa BB	289	#define ZFS_OBJ_MTX_SZ 64
c96c36fa BB	290	#define ZFS_OBJ_MTX_MAX (1024 * 1024)
0037b49e	291	#define ZFS_OBJ_HASH(zfsvfs, obj) ((obj) & ((zfsvfs->z_hold_size) - 1))
0720116d BB	292
	293	extern unsigned int zfs_object_mutex_size;
	294
d3cc8b15	295	/* Encode ZFS stored time values from a struct timespec */
34dc7c2f BB	296	#define ZFS_TIME_ENCODE(tp, stmp) \
34dc7c2f BB	297	{ \
b128c09f	298	(stmp)[0] = (uint64_t)(tp)->tv_sec; \
34dc7c2f BB	299	(stmp)[1] = (uint64_t)(tp)->tv_nsec; \
	300	}
	301
d3cc8b15	302	/* Decode ZFS stored time values to a struct timespec */
34dc7c2f BB	303	#define ZFS_TIME_DECODE(tp, stmp) \
	304	{ \
	305	(tp)->tv_sec = (time_t)(stmp)[0]; \
	306	(tp)->tv_nsec = (long)(stmp)[1]; \
	307	}
	308
	309	/*
	310	* Timestamp defines
	311	*/
3558fd73 BB	312	#define ACCESSED (ATTR_ATIME)
	313	#define STATE_CHANGED (ATTR_CTIME)
	314	#define CONTENT_MODIFIED (ATTR_MTIME \| ATTR_CTIME)
34dc7c2f	315
0037b49e	316	extern int zfs_init_fs(zfsvfs_t , znode_t *);
34dc7c2f BB	317	extern void zfs_set_dataprop(objset_t *);
	318	extern void zfs_create_fs(objset_t os, cred_t cr, nvlist_t *,
	319	dmu_tx_t *tx);
428870ff	320	extern void zfs_tstamp_update_setup(znode_t *, uint_t, uint64_t [2],
0df9673f	321	uint64_t [2]);
34dc7c2f BB	322	extern void zfs_grow_blocksize(znode_t , uint64_t, dmu_tx_t );
	323	extern int zfs_freesp(znode_t *, uint64_t, uint64_t, int, boolean_t);
	324	extern void zfs_znode_init(void);
	325	extern void zfs_znode_fini(void);
c96c36fa	326	extern int zfs_znode_hold_compare(const void , const void );
0037b49e	327	extern int zfs_zget(zfsvfs_t , uint64_t, znode_t *);
34dc7c2f BB	328	extern int zfs_rezget(znode_t *);
	329	extern void zfs_zinactive(znode_t *);
	330	extern void zfs_znode_delete(znode_t , dmu_tx_t );
0bc8fd78 BB	331	extern void zfs_remove_op_tables(void);
0bc8fd78 BB	332	extern int zfs_create_op_tables(void);
03f9ba9d	333	extern int zfs_sync(struct super_block , int, cred_t );
34dc7c2f BB	334	extern dev_t zfs_cmpldev(uint64_t);
34dc7c2f BB	335	extern int zfs_get_zplprop(objset_t os, zfs_prop_t prop, uint64_t value);
34dc7c2f	336	extern int zfs_get_stats(objset_t os, nvlist_t nv);
a08abc1b	337	extern boolean_t zfs_get_vfs_flag_unmounted(objset_t *os);
34dc7c2f	338	extern void zfs_znode_dmu_fini(znode_t *);
3558fd73 BB	339	extern int zfs_inode_alloc(struct super_block , struct inode *ip);
3558fd73 BB	340	extern void zfs_inode_destroy(struct inode *);
960e08fe	341	extern void zfs_inode_update(znode_t *);
1e8db771	342	extern void zfs_mark_inode_dirty(struct inode *);
34dc7c2f BB	343
	344	extern void zfs_log_create(zilog_t zilog, dmu_tx_t tx, uint64_t txtype,
	345	znode_t dzp, znode_t zp, char name, vsecattr_t , zfs_fuid_info_t *,
	346	vattr_t *vap);
	347	extern int zfs_log_create_txtype(zil_create_t, vsecattr_t *vsecp,
	348	vattr_t *vap);
	349	extern void zfs_log_remove(zilog_t zilog, dmu_tx_t tx, uint64_t txtype,
572e2857 BB	350	znode_t dzp, char name, uint64_t foid);
572e2857 BB	351	#define ZFS_NO_OBJECT 0 /* no object id */
34dc7c2f BB	352	extern void zfs_log_link(zilog_t zilog, dmu_tx_t tx, uint64_t txtype,
	353	znode_t dzp, znode_t zp, char *name);
	354	extern void zfs_log_symlink(zilog_t zilog, dmu_tx_t tx, uint64_t txtype,
	355	znode_t dzp, znode_t zp, char name, char link);
	356	extern void zfs_log_rename(zilog_t zilog, dmu_tx_t tx, uint64_t txtype,
	357	znode_t sdzp, char sname, znode_t tdzp, char dname, znode_t *szp);
	358	extern void zfs_log_write(zilog_t zilog, dmu_tx_t tx, int txtype,
119a394a ED	359	znode_t *zp, offset_t off, ssize_t len, int ioflag,
119a394a ED	360	zil_callback_t callback, void *callback_data);
34dc7c2f BB	361	extern void zfs_log_truncate(zilog_t zilog, dmu_tx_t tx, int txtype,
	362	znode_t *zp, uint64_t off, uint64_t len);
	363	extern void zfs_log_setattr(zilog_t zilog, dmu_tx_t tx, int txtype,
5484965a	364	znode_t zp, vattr_t vap, uint_t mask_applied, zfs_fuid_info_t *fuidp);
34dc7c2f BB	365	extern void zfs_log_acl(zilog_t zilog, dmu_tx_t tx, znode_t *zp,
34dc7c2f BB	366	vsecattr_t vsecp, zfs_fuid_info_t fuidp);
428870ff	367	extern void zfs_xvattr_set(znode_t zp, xvattr_t xvap, dmu_tx_t *tx);
0037b49e BB	368	extern void zfs_upgrade(zfsvfs_t zfsvfs, dmu_tx_t tx);
0037b49e BB	369	extern int zfs_create_share_dir(zfsvfs_t zfsvfs, dmu_tx_t tx);
34dc7c2f	370
60101509	371	#if defined(HAVE_UIO_RW)
b128c09f BB	372	extern caddr_t zfs_map_page(page_t *, enum seg_rw);
b128c09f BB	373	extern void zfs_unmap_page(page_t *, caddr_t);
60101509	374	#endif /* HAVE_UIO_RW */
b128c09f	375
34dc7c2f	376	extern zil_get_data_t zfs_get_data;
867959b5	377	extern zil_replay_func_t *zfs_replay_vector[TX_MAX_TYPE];
34dc7c2f BB	378	extern int zfsfstype;
	379
	380	#endif /* _KERNEL */
	381
	382	extern int zfs_obj_to_path(objset_t osp, uint64_t obj, char buf, int len);
	383
	384	#ifdef __cplusplus
	385	}
	386	#endif
	387
	388	#endif /* _SYS_FS_ZFS_ZNODE_H */