zfs_znode.h revision 269419
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/*
22 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
23 * Copyright (c) 2012 by Delphix. All rights reserved.
24 */
25
26#ifndef	_SYS_FS_ZFS_ZNODE_H
27#define	_SYS_FS_ZFS_ZNODE_H
28
29#ifdef _KERNEL
30#include <sys/list.h>
31#include <sys/dmu.h>
32#include <sys/sa.h>
33#include <sys/zfs_vfsops.h>
34#include <sys/rrwlock.h>
35#include <sys/zfs_sa.h>
36#include <sys/zfs_stat.h>
37#endif
38#include <sys/zfs_acl.h>
39#include <sys/zil.h>
40
41#ifdef	__cplusplus
42extern "C" {
43#endif
44
45/*
46 * Additional file level attributes, that are stored
47 * in the upper half of zp_flags
48 */
49#define	ZFS_READONLY		0x0000000100000000
50#define	ZFS_HIDDEN		0x0000000200000000
51#define	ZFS_SYSTEM		0x0000000400000000
52#define	ZFS_ARCHIVE		0x0000000800000000
53#define	ZFS_IMMUTABLE		0x0000001000000000
54#define	ZFS_NOUNLINK		0x0000002000000000
55#define	ZFS_APPENDONLY		0x0000004000000000
56#define	ZFS_NODUMP		0x0000008000000000
57#define	ZFS_OPAQUE		0x0000010000000000
58#define	ZFS_AV_QUARANTINED 	0x0000020000000000
59#define	ZFS_AV_MODIFIED 	0x0000040000000000
60#define	ZFS_REPARSE		0x0000080000000000
61#define	ZFS_OFFLINE		0x0000100000000000
62#define	ZFS_SPARSE		0x0000200000000000
63
64#define	ZFS_ATTR_SET(zp, attr, value, pflags, tx) \
65{ \
66	if (value) \
67		pflags |= attr; \
68	else \
69		pflags &= ~attr; \
70	VERIFY(0 == sa_update(zp->z_sa_hdl, SA_ZPL_FLAGS(zp->z_zfsvfs), \
71	    &pflags, sizeof (pflags), tx)); \
72}
73
74/*
75 * Define special zfs pflags
76 */
77#define	ZFS_XATTR		0x1		/* is an extended attribute */
78#define	ZFS_INHERIT_ACE		0x2		/* ace has inheritable ACEs */
79#define	ZFS_ACL_TRIVIAL 	0x4		/* files ACL is trivial */
80#define	ZFS_ACL_OBJ_ACE 	0x8		/* ACL has CMPLX Object ACE */
81#define	ZFS_ACL_PROTECTED	0x10		/* ACL protected */
82#define	ZFS_ACL_DEFAULTED	0x20		/* ACL should be defaulted */
83#define	ZFS_ACL_AUTO_INHERIT	0x40		/* ACL should be inherited */
84#define	ZFS_BONUS_SCANSTAMP	0x80		/* Scanstamp in bonus area */
85#define	ZFS_NO_EXECS_DENIED	0x100		/* exec was given to everyone */
86
87#define	SA_ZPL_ATIME(z)		z->z_attr_table[ZPL_ATIME]
88#define	SA_ZPL_MTIME(z)		z->z_attr_table[ZPL_MTIME]
89#define	SA_ZPL_CTIME(z)		z->z_attr_table[ZPL_CTIME]
90#define	SA_ZPL_CRTIME(z)	z->z_attr_table[ZPL_CRTIME]
91#define	SA_ZPL_GEN(z)		z->z_attr_table[ZPL_GEN]
92#define	SA_ZPL_DACL_ACES(z)	z->z_attr_table[ZPL_DACL_ACES]
93#define	SA_ZPL_XATTR(z)		z->z_attr_table[ZPL_XATTR]
94#define	SA_ZPL_SYMLINK(z)	z->z_attr_table[ZPL_SYMLINK]
95#define	SA_ZPL_RDEV(z)		z->z_attr_table[ZPL_RDEV]
96#define	SA_ZPL_SCANSTAMP(z)	z->z_attr_table[ZPL_SCANSTAMP]
97#define	SA_ZPL_UID(z)		z->z_attr_table[ZPL_UID]
98#define	SA_ZPL_GID(z)		z->z_attr_table[ZPL_GID]
99#define	SA_ZPL_PARENT(z)	z->z_attr_table[ZPL_PARENT]
100#define	SA_ZPL_LINKS(z)		z->z_attr_table[ZPL_LINKS]
101#define	SA_ZPL_MODE(z)		z->z_attr_table[ZPL_MODE]
102#define	SA_ZPL_DACL_COUNT(z)	z->z_attr_table[ZPL_DACL_COUNT]
103#define	SA_ZPL_FLAGS(z)		z->z_attr_table[ZPL_FLAGS]
104#define	SA_ZPL_SIZE(z)		z->z_attr_table[ZPL_SIZE]
105#define	SA_ZPL_ZNODE_ACL(z)	z->z_attr_table[ZPL_ZNODE_ACL]
106#define	SA_ZPL_PAD(z)		z->z_attr_table[ZPL_PAD]
107
108/*
109 * Is ID ephemeral?
110 */
111#define	IS_EPHEMERAL(x)		(x > MAXUID)
112
113/*
114 * Should we use FUIDs?
115 */
116#define	USE_FUIDS(version, os)	(version >= ZPL_VERSION_FUID && \
117    spa_version(dmu_objset_spa(os)) >= SPA_VERSION_FUID)
118#define	USE_SA(version, os) (version >= ZPL_VERSION_SA && \
119    spa_version(dmu_objset_spa(os)) >= SPA_VERSION_SA)
120
121#define	MASTER_NODE_OBJ	1
122
123/*
124 * Special attributes for master node.
125 * "userquota@" and "groupquota@" are also valid (from
126 * zfs_userquota_prop_prefixes[]).
127 */
128#define	ZFS_FSID		"FSID"
129#define	ZFS_UNLINKED_SET	"DELETE_QUEUE"
130#define	ZFS_ROOT_OBJ		"ROOT"
131#define	ZPL_VERSION_STR		"VERSION"
132#define	ZFS_FUID_TABLES		"FUID"
133#define	ZFS_SHARES_DIR		"SHARES"
134#define	ZFS_SA_ATTRS		"SA_ATTRS"
135
136#define	ZFS_MAX_BLOCKSIZE	(SPA_MAXBLOCKSIZE)
137
138/*
139 * Path component length
140 *
141 * The generic fs code uses MAXNAMELEN to represent
142 * what the largest component length is.  Unfortunately,
143 * this length includes the terminating NULL.  ZFS needs
144 * to tell the users via pathconf() and statvfs() what the
145 * true maximum length of a component is, excluding the NULL.
146 */
147#define	ZFS_MAXNAMELEN	(MAXNAMELEN - 1)
148
149/*
150 * Convert mode bits (zp_mode) to BSD-style DT_* values for storing in
151 * the directory entries.
152 */
153#ifndef IFTODT
154#define	IFTODT(mode) (((mode) & S_IFMT) >> 12)
155#endif
156
157/*
158 * The directory entry has the type (currently unused on Solaris) in the
159 * top 4 bits, and the object number in the low 48 bits.  The "middle"
160 * 12 bits are unused.
161 */
162#define	ZFS_DIRENT_TYPE(de) BF64_GET(de, 60, 4)
163#define	ZFS_DIRENT_OBJ(de) BF64_GET(de, 0, 48)
164
165/*
166 * Directory entry locks control access to directory entries.
167 * They are used to protect creates, deletes, and renames.
168 * Each directory znode has a mutex and a list of locked names.
169 */
170#ifdef _KERNEL
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	struct zfsvfs	*z_zfsvfs;
183	vnode_t		*z_vnode;
184	uint64_t	z_id;		/* object ID for this znode */
185	kmutex_t	z_lock;		/* znode modification lock */
186	krwlock_t	z_parent_lock;	/* parent lock for directories */
187	krwlock_t	z_name_lock;	/* "master" lock for dirent locks */
188	zfs_dirlock_t	*z_dirlocks;	/* directory entry lock list */
189	kmutex_t	z_range_lock;	/* protects changes to z_range_avl */
190	avl_tree_t	z_range_avl;	/* avl tree of file range locks */
191	uint8_t		z_unlinked;	/* file has been unlinked */
192	uint8_t		z_atime_dirty;	/* atime needs to be synced */
193	uint8_t		z_zn_prefetch;	/* Prefetch znodes? */
194	uint8_t		z_moved;	/* Has this znode been moved? */
195	uint_t		z_blksz;	/* block size in bytes */
196	uint_t		z_seq;		/* modification sequence number */
197	uint64_t	z_mapcnt;	/* number of pages mapped to file */
198	uint64_t	z_gen;		/* generation (cached) */
199	uint64_t	z_size;		/* file size (cached) */
200	uint64_t	z_atime[2];	/* atime (cached) */
201	uint64_t	z_links;	/* file links (cached) */
202	uint64_t	z_pflags;	/* pflags (cached) */
203	uint64_t	z_uid;		/* uid fuid (cached) */
204	uint64_t	z_gid;		/* gid fuid (cached) */
205	mode_t		z_mode;		/* mode (cached) */
206	uint32_t	z_sync_cnt;	/* synchronous open count */
207	kmutex_t	z_acl_lock;	/* acl data lock */
208	zfs_acl_t	*z_acl_cached;	/* cached acl */
209	list_node_t	z_link_node;	/* all znodes in fs link */
210	sa_handle_t	*z_sa_hdl;	/* handle to sa data */
211	boolean_t	z_is_sa;	/* are we native sa? */
212} znode_t;
213
214
215/*
216 * Range locking rules
217 * --------------------
218 * 1. When truncating a file (zfs_create, zfs_setattr, zfs_space) the whole
219 *    file range needs to be locked as RL_WRITER. Only then can the pages be
220 *    freed etc and zp_size reset. zp_size must be set within range lock.
221 * 2. For writes and punching holes (zfs_write & zfs_space) just the range
222 *    being written or freed needs to be locked as RL_WRITER.
223 *    Multiple writes at the end of the file must coordinate zp_size updates
224 *    to ensure data isn't lost. A compare and swap loop is currently used
225 *    to ensure the file size is at least the offset last written.
226 * 3. For reads (zfs_read, zfs_get_data & zfs_putapage) just the range being
227 *    read needs to be locked as RL_READER. A check against zp_size can then
228 *    be made for reading beyond end of file.
229 */
230
231/*
232 * Convert between znode pointers and vnode pointers
233 */
234#ifdef DEBUG
235static __inline vnode_t *
236ZTOV(znode_t *zp)
237{
238	vnode_t *vp = zp->z_vnode;
239
240	ASSERT(vp == NULL || vp->v_data == NULL || vp->v_data == zp);
241	return (vp);
242}
243static __inline znode_t *
244VTOZ(vnode_t *vp)
245{
246	znode_t *zp = (znode_t *)vp->v_data;
247
248	ASSERT(zp == NULL || zp->z_vnode == NULL || zp->z_vnode == vp);
249	return (zp);
250}
251#else
252#define	ZTOV(ZP)	((ZP)->z_vnode)
253#define	VTOZ(VP)	((znode_t *)(VP)->v_data)
254#endif
255
256/* Called on entry to each ZFS vnode and vfs operation  */
257#define	ZFS_ENTER(zfsvfs) \
258	{ \
259		rrm_enter_read(&(zfsvfs)->z_teardown_lock, FTAG); \
260		if ((zfsvfs)->z_unmounted) { \
261			ZFS_EXIT(zfsvfs); \
262			return (EIO); \
263		} \
264	}
265
266/* Called on entry to each ZFS vnode and vfs operation that can not return EIO */
267#define	ZFS_ENTER_NOERROR(zfsvfs) \
268	rrm_enter(&(zfsvfs)->z_teardown_lock, RW_READER, FTAG)
269
270/* Must be called before exiting the vop */
271#define	ZFS_EXIT(zfsvfs) rrm_exit(&(zfsvfs)->z_teardown_lock, FTAG)
272
273/* Verifies the znode is valid */
274#define	ZFS_VERIFY_ZP(zp) \
275	if ((zp)->z_sa_hdl == NULL) { \
276		ZFS_EXIT((zp)->z_zfsvfs); \
277		return (EIO); \
278	} \
279
280/*
281 * Macros for dealing with dmu_buf_hold
282 */
283#define	ZFS_OBJ_HASH(obj_num)	((obj_num) & (ZFS_OBJ_MTX_SZ - 1))
284#define	ZFS_OBJ_MUTEX(zfsvfs, obj_num)	\
285	(&(zfsvfs)->z_hold_mtx[ZFS_OBJ_HASH(obj_num)])
286#define	ZFS_OBJ_HOLD_ENTER(zfsvfs, obj_num) \
287	mutex_enter(ZFS_OBJ_MUTEX((zfsvfs), (obj_num)))
288#define	ZFS_OBJ_HOLD_TRYENTER(zfsvfs, obj_num) \
289	mutex_tryenter(ZFS_OBJ_MUTEX((zfsvfs), (obj_num)))
290#define	ZFS_OBJ_HOLD_EXIT(zfsvfs, obj_num) \
291	mutex_exit(ZFS_OBJ_MUTEX((zfsvfs), (obj_num)))
292
293/* Encode ZFS stored time values from a struct timespec */
294#define	ZFS_TIME_ENCODE(tp, stmp)		\
295{						\
296	(stmp)[0] = (uint64_t)(tp)->tv_sec;	\
297	(stmp)[1] = (uint64_t)(tp)->tv_nsec;	\
298}
299
300/* Decode ZFS stored time values to a struct timespec */
301#define	ZFS_TIME_DECODE(tp, stmp)		\
302{						\
303	(tp)->tv_sec = (time_t)(stmp)[0];		\
304	(tp)->tv_nsec = (long)(stmp)[1];		\
305}
306
307/*
308 * Timestamp defines
309 */
310#define	ACCESSED		(AT_ATIME)
311#define	STATE_CHANGED		(AT_CTIME)
312#define	CONTENT_MODIFIED	(AT_MTIME | AT_CTIME)
313
314#define	ZFS_ACCESSTIME_STAMP(zfsvfs, zp) \
315	if ((zfsvfs)->z_atime && !((zfsvfs)->z_vfs->vfs_flag & VFS_RDONLY)) \
316		zfs_tstamp_update_setup(zp, ACCESSED, NULL, NULL, B_FALSE);
317
318extern int	zfs_init_fs(zfsvfs_t *, znode_t **);
319extern void	zfs_set_dataprop(objset_t *);
320extern void	zfs_create_fs(objset_t *os, cred_t *cr, nvlist_t *,
321    dmu_tx_t *tx);
322extern void	zfs_tstamp_update_setup(znode_t *, uint_t, uint64_t [2],
323    uint64_t [2], boolean_t);
324extern void	zfs_grow_blocksize(znode_t *, uint64_t, dmu_tx_t *);
325extern int	zfs_freesp(znode_t *, uint64_t, uint64_t, int, boolean_t);
326extern void	zfs_znode_init(void);
327extern void	zfs_znode_fini(void);
328extern int	zfs_zget(zfsvfs_t *, uint64_t, znode_t **);
329extern int	zfs_rezget(znode_t *);
330extern void	zfs_zinactive(znode_t *);
331extern void	zfs_znode_delete(znode_t *, dmu_tx_t *);
332extern void	zfs_znode_free(znode_t *);
333extern void	zfs_remove_op_tables();
334extern int	zfs_create_op_tables();
335extern dev_t	zfs_cmpldev(uint64_t);
336extern int	zfs_get_zplprop(objset_t *os, zfs_prop_t prop, uint64_t *value);
337extern int	zfs_get_stats(objset_t *os, nvlist_t *nv);
338extern void	zfs_znode_dmu_fini(znode_t *);
339
340extern void zfs_log_create(zilog_t *zilog, dmu_tx_t *tx, uint64_t txtype,
341    znode_t *dzp, znode_t *zp, char *name, vsecattr_t *, zfs_fuid_info_t *,
342    vattr_t *vap);
343extern int zfs_log_create_txtype(zil_create_t, vsecattr_t *vsecp,
344    vattr_t *vap);
345extern void zfs_log_remove(zilog_t *zilog, dmu_tx_t *tx, uint64_t txtype,
346    znode_t *dzp, char *name, uint64_t foid);
347#define	ZFS_NO_OBJECT	0	/* no object id */
348extern void zfs_log_link(zilog_t *zilog, dmu_tx_t *tx, uint64_t txtype,
349    znode_t *dzp, znode_t *zp, char *name);
350extern void zfs_log_symlink(zilog_t *zilog, dmu_tx_t *tx, uint64_t txtype,
351    znode_t *dzp, znode_t *zp, char *name, char *link);
352extern void zfs_log_rename(zilog_t *zilog, dmu_tx_t *tx, uint64_t txtype,
353    znode_t *sdzp, char *sname, znode_t *tdzp, char *dname, znode_t *szp);
354extern void zfs_log_write(zilog_t *zilog, dmu_tx_t *tx, int txtype,
355    znode_t *zp, offset_t off, ssize_t len, int ioflag);
356extern void zfs_log_truncate(zilog_t *zilog, dmu_tx_t *tx, int txtype,
357    znode_t *zp, uint64_t off, uint64_t len);
358extern void zfs_log_setattr(zilog_t *zilog, dmu_tx_t *tx, int txtype,
359    znode_t *zp, vattr_t *vap, uint_t mask_applied, zfs_fuid_info_t *fuidp);
360#ifndef ZFS_NO_ACL
361extern void zfs_log_acl(zilog_t *zilog, dmu_tx_t *tx, znode_t *zp,
362    vsecattr_t *vsecp, zfs_fuid_info_t *fuidp);
363#endif
364extern void zfs_xvattr_set(znode_t *zp, xvattr_t *xvap, dmu_tx_t *tx);
365extern void zfs_upgrade(zfsvfs_t *zfsvfs, dmu_tx_t *tx);
366extern int zfs_create_share_dir(zfsvfs_t *zfsvfs, dmu_tx_t *tx);
367
368extern zil_get_data_t zfs_get_data;
369extern zil_replay_func_t *zfs_replay_vector[TX_MAX_TYPE];
370extern int zfsfstype;
371
372#endif /* _KERNEL */
373
374extern int zfs_obj_to_path(objset_t *osp, uint64_t obj, char *buf, int len);
375
376#ifdef	__cplusplus
377}
378#endif
379
380#endif	/* _SYS_FS_ZFS_ZNODE_H */
381