xref: /illumos-gate/usr/src/uts/common/fs/zfs/sys/zfs_znode.h (revision 5730cc9a43c5f11a472d7536ed81facfd10f1e2e)
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 2006 Sun Microsystems, Inc.  All rights reserved.
23  * Use is subject to license terms.
24  */
25 
26 #ifndef	_SYS_FS_ZFS_ZNODE_H
27 #define	_SYS_FS_ZFS_ZNODE_H
28 
29 #pragma ident	"%Z%%M%	%I%	%E% SMI"
30 
31 #ifdef _KERNEL
32 #include <sys/isa_defs.h>
33 #include <sys/types32.h>
34 #include <sys/list.h>
35 #include <sys/dmu.h>
36 #include <sys/zfs_vfsops.h>
37 #endif
38 #include <sys/zfs_acl.h>
39 #include <sys/zil.h>
40 
41 #ifdef	__cplusplus
42 extern "C" {
43 #endif
44 
45 /*
46  * Define special zfs pflags
47  */
48 #define	ZFS_XATTR	0x1		/* is an extended attribute */
49 #define	ZFS_INHERIT_ACE	0x2		/* ace has inheritable ACEs */
50 #define	ZFS_ACL_TRIVIAL 0x4		/* files ACL is trivial */
51 
52 #define	MASTER_NODE_OBJ	1
53 
54 /*
55  * special attributes for master node.
56  */
57 
58 #define	ZFS_FSID		"FSID"
59 #define	ZFS_DELETE_QUEUE	"DELETE_QUEUE"
60 #define	ZFS_ROOT_OBJ		"ROOT"
61 #define	ZPL_VERSION_OBJ		"VERSION"
62 #define	ZFS_PROP_BLOCKPERPAGE	"BLOCKPERPAGE"
63 #define	ZFS_PROP_NOGROWBLOCKS	"NOGROWBLOCKS"
64 
65 #define	ZFS_FLAG_BLOCKPERPAGE	0x1
66 #define	ZFS_FLAG_NOGROWBLOCKS	0x2
67 
68 /*
69  * ZPL version - rev'd whenever an incompatible on-disk format change
70  * occurs.  Independent of SPA/DMU/ZAP versioning.
71  */
72 
73 #define	ZPL_VERSION		1ULL
74 
75 #define	ZFS_MAX_BLOCKSIZE	(SPA_MAXBLOCKSIZE)
76 
77 /* Path component length */
78 /*
79  * The generic fs code uses MAXNAMELEN to represent
80  * what the largest component length is.  Unfortunately,
81  * this length includes the terminating NULL.  ZFS needs
82  * to tell the users via pathconf() and statvfs() what the
83  * true maximum length of a component is, excluding the NULL.
84  */
85 #define	ZFS_MAXNAMELEN	(MAXNAMELEN - 1)
86 
87 /*
88  * This is the persistent portion of the znode.  It is stored
89  * in the "bonus buffer" of the file.  Short symbolic links
90  * are also stored in the bonus buffer.
91  */
92 typedef struct znode_phys {
93 	uint64_t zp_atime[2];		/*  0 - last file access time */
94 	uint64_t zp_mtime[2];		/* 16 - last file modification time */
95 	uint64_t zp_ctime[2];		/* 32 - last file change time */
96 	uint64_t zp_crtime[2];		/* 48 - creation time */
97 	uint64_t zp_gen;		/* 64 - generation (txg of creation) */
98 	uint64_t zp_mode;		/* 72 - file mode bits */
99 	uint64_t zp_size;		/* 80 - size of file */
100 	uint64_t zp_parent;		/* 88 - directory parent (`..') */
101 	uint64_t zp_links;		/* 96 - number of links to file */
102 	uint64_t zp_xattr;		/* 104 - DMU object for xattrs */
103 	uint64_t zp_rdev;		/* 112 - dev_t for VBLK & VCHR files */
104 	uint64_t zp_flags;		/* 120 - persistent flags */
105 	uint64_t zp_uid;		/* 128 - file owner */
106 	uint64_t zp_gid;		/* 136 - owning group */
107 	uint64_t zp_pad[4];		/* 144 - future */
108 	zfs_znode_acl_t zp_acl;		/* 176 - 263 ACL */
109 	/*
110 	 * Data may pad out any remaining bytes in the znode buffer, eg:
111 	 *
112 	 * |<---------------------- dnode_phys (512) ------------------------>|
113 	 * |<-- dnode (192) --->|<----------- "bonus" buffer (320) ---------->|
114 	 *			|<---- znode (264) ---->|<---- data (56) ---->|
115 	 *
116 	 * At present, we only use this space to store symbolic links.
117 	 */
118 } znode_phys_t;
119 
120 /*
121  * Directory entry locks control access to directory entries.
122  * They are used to protect creates, deletes, and renames.
123  * Each directory znode has a mutex and a list of locked names.
124  */
125 #ifdef _KERNEL
126 typedef struct zfs_dirlock {
127 	char		*dl_name;	/* directory entry being locked */
128 	uint32_t	dl_sharecnt;	/* 0 if exclusive, > 0 if shared */
129 	uint16_t	dl_namesize;	/* set if dl_name was allocated */
130 	kcondvar_t	dl_cv;		/* wait for entry to be unlocked */
131 	struct znode	*dl_dzp;	/* directory znode */
132 	struct zfs_dirlock *dl_next;	/* next in z_dirlocks list */
133 } zfs_dirlock_t;
134 
135 typedef struct znode {
136 	struct zfsvfs	*z_zfsvfs;
137 	vnode_t		*z_vnode;
138 	list_node_t 	z_list_node;	/* deleted znodes */
139 	uint64_t	z_id;		/* object ID for this znode */
140 	kmutex_t	z_lock;		/* znode modification lock */
141 	krwlock_t	z_map_lock;	/* page map lock */
142 	krwlock_t	z_parent_lock;	/* parent lock for directories */
143 	zfs_dirlock_t	*z_dirlocks;	/* directory entry lock list */
144 	kmutex_t	z_range_lock;	/* protects changes to z_range_avl */
145 	avl_tree_t	z_range_avl;	/* avl tree of file range locks */
146 	uint8_t		z_active;	/* znode is in use */
147 	uint8_t		z_reap;		/* reap file at last reference */
148 	uint8_t		z_atime_dirty;	/* atime needs to be synced */
149 	uint8_t		z_dbuf_held;	/* Is z_dbuf already held? */
150 	uint8_t		z_zn_prefetch;	/* Prefetch znodes? */
151 	uint_t		z_blksz;	/* block size in bytes */
152 	uint_t		z_seq;		/* modification sequence number */
153 	uint64_t	z_mapcnt;	/* number of pages mapped to file */
154 	uint64_t	z_last_itx;	/* last ZIL itx on this znode */
155 	kmutex_t	z_acl_lock;	/* acl data lock */
156 	list_node_t	z_link_node;	/* all znodes in fs link */
157 	/*
158 	 * These are dmu managed fields.
159 	 */
160 	znode_phys_t	*z_phys;	/* pointer to persistent znode */
161 	dmu_buf_t	*z_dbuf;	/* buffer containing the z_phys */
162 } znode_t;
163 
164 
165 /*
166  * Range locking rules
167  * --------------------
168  * 1. When truncating a file (zfs_create, zfs_setattr, zfs_space) the whole
169  *    file range needs to be locked as RL_WRITER. Only then can the pages be
170  *    freed etc and zp_size reset. zp_size must be set within range lock.
171  * 2. For writes and punching holes (zfs_write & zfs_space) just the range
172  *    being written or freed needs to be locked as RL_WRITER.
173  *    Multiple writes at the end of the file must coordinate zp_size updates
174  *    to ensure data isn't lost. A compare and swap loop is currently used
175  *    to ensure the file size is at least the offset last written.
176  * 3. For reads (zfs_read, zfs_get_data & zfs_putapage) just the range being
177  *    read needs to be locked as RL_READER. A check against zp_size can then
178  *    be made for reading beyond end of file.
179  */
180 
181 /*
182  * Convert between znode pointers and vnode pointers
183  */
184 #define	ZTOV(ZP)	((ZP)->z_vnode)
185 #define	VTOZ(VP)	((znode_t *)(VP)->v_data)
186 
187 /*
188  * ZFS_ENTER() is called on entry to each ZFS vnode and vfs operation.
189  * ZFS_EXIT() must be called before exitting the vop.
190  */
191 #define	ZFS_ENTER(zfsvfs) \
192 	{ \
193 		atomic_add_32(&(zfsvfs)->z_op_cnt, 1); \
194 		if ((zfsvfs)->z_unmounted1) { \
195 			ZFS_EXIT(zfsvfs); \
196 			return (EIO); \
197 		} \
198 	}
199 #define	ZFS_EXIT(zfsvfs) atomic_add_32(&(zfsvfs)->z_op_cnt, -1)
200 
201 /*
202  * Macros for dealing with dmu_buf_hold
203  */
204 #define	ZFS_OBJ_HASH(obj_num)	(obj_num & (ZFS_OBJ_MTX_SZ - 1))
205 #define	ZFS_OBJ_MUTEX(zp)	\
206 	(&zp->z_zfsvfs->z_hold_mtx[ZFS_OBJ_HASH(zp->z_id)])
207 #define	ZFS_OBJ_HOLD_ENTER(zfsvfs, obj_num) \
208 	mutex_enter(&zfsvfs->z_hold_mtx[ZFS_OBJ_HASH(obj_num)]);
209 
210 #define	ZFS_OBJ_HOLD_EXIT(zfsvfs, obj_num) \
211 	mutex_exit(&zfsvfs->z_hold_mtx[ZFS_OBJ_HASH(obj_num)])
212 
213 /*
214  * Macros to encode/decode ZFS stored time values from/to struct timespec
215  */
216 #define	ZFS_TIME_ENCODE(tp, stmp)		\
217 {						\
218 	stmp[0] = (uint64_t)(tp)->tv_sec; 	\
219 	stmp[1] = (uint64_t)(tp)->tv_nsec;	\
220 }
221 
222 #define	ZFS_TIME_DECODE(tp, stmp)		\
223 {						\
224 	(tp)->tv_sec = (time_t)stmp[0];		\
225 	(tp)->tv_nsec = (long)stmp[1];		\
226 }
227 
228 /*
229  * Timestamp defines
230  */
231 #define	ACCESSED		(AT_ATIME)
232 #define	STATE_CHANGED		(AT_CTIME)
233 #define	CONTENT_MODIFIED	(AT_MTIME | AT_CTIME)
234 
235 #define	ZFS_ACCESSTIME_STAMP(zfsvfs, zp) \
236 	if ((zfsvfs)->z_atime && !((zfsvfs)->z_vfs->vfs_flag & VFS_RDONLY)) \
237 		zfs_time_stamper(zp, ACCESSED, NULL)
238 
239 extern int	zfs_init_fs(zfsvfs_t *, znode_t **, cred_t *);
240 extern void	zfs_set_dataprop(objset_t *);
241 extern void	zfs_create_fs(objset_t *os, cred_t *cr, dmu_tx_t *tx);
242 extern void	zfs_time_stamper(znode_t *, uint_t, dmu_tx_t *);
243 extern void	zfs_time_stamper_locked(znode_t *, uint_t, dmu_tx_t *);
244 extern void	zfs_grow_blocksize(znode_t *, uint64_t, dmu_tx_t *);
245 extern int	zfs_freesp(znode_t *, uint64_t, uint64_t, int, boolean_t);
246 extern void	zfs_znode_init(void);
247 extern void	zfs_znode_fini(void);
248 extern int	zfs_zget(zfsvfs_t *, uint64_t, znode_t **);
249 extern void	zfs_zinactive(znode_t *);
250 extern void	zfs_znode_delete(znode_t *, dmu_tx_t *);
251 extern void	zfs_znode_free(znode_t *);
252 extern int	zfs_delete_thread_target(zfsvfs_t *zfsvfs, int nthreads);
253 extern void	zfs_delete_wait_empty(zfsvfs_t *zfsvfs);
254 extern void	zfs_remove_op_tables();
255 extern int	zfs_create_op_tables();
256 extern int	zfs_sync(vfs_t *vfsp, short flag, cred_t *cr);
257 extern dev_t	zfs_cmpldev(uint64_t);
258 
259 extern uint64_t zfs_log_create(zilog_t *zilog, dmu_tx_t *tx, int txtype,
260     znode_t *dzp, znode_t *zp, char *name);
261 extern uint64_t zfs_log_remove(zilog_t *zilog, dmu_tx_t *tx, int txtype,
262     znode_t *dzp, char *name);
263 extern uint64_t zfs_log_link(zilog_t *zilog, dmu_tx_t *tx, int txtype,
264     znode_t *dzp, znode_t *zp, char *name);
265 extern uint64_t zfs_log_symlink(zilog_t *zilog, dmu_tx_t *tx, int txtype,
266     znode_t *dzp, znode_t *zp, char *name, char *link);
267 extern uint64_t zfs_log_rename(zilog_t *zilog, dmu_tx_t *tx, int txtype,
268     znode_t *sdzp, char *sname, znode_t *tdzp, char *dname, znode_t *szp);
269 extern uint64_t zfs_log_write(zilog_t *zilog, dmu_tx_t *tx, int txtype,
270     znode_t *zp, offset_t off, ssize_t len, int ioflag, uio_t *uio);
271 extern uint64_t zfs_log_truncate(zilog_t *zilog, dmu_tx_t *tx, int txtype,
272     znode_t *zp, uint64_t off, uint64_t len);
273 extern uint64_t zfs_log_setattr(zilog_t *zilog, dmu_tx_t *tx, int txtype,
274     znode_t *zp, vattr_t *vap, uint_t mask_applied);
275 extern uint64_t zfs_log_acl(zilog_t *zilog, dmu_tx_t *tx, int txtype,
276     znode_t *zp, int aclcnt, ace_t *z_ace);
277 
278 extern zil_get_data_t zfs_get_data;
279 extern zil_replay_func_t *zfs_replay_vector[TX_MAX_TYPE];
280 extern int zfsfstype;
281 
282 #endif /* _KERNEL */
283 
284 #ifdef	__cplusplus
285 }
286 #endif
287 
288 #endif	/* _SYS_FS_ZFS_ZNODE_H */
289