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.
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.
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]
22 * Copyright 2009 Sun Microsystems, Inc. All rights reserved.
23 * Use is subject to license terms.
26 #ifndef _SYS_FS_ZFS_ZNODE_H
27 #define _SYS_FS_ZFS_ZNODE_H
30 #include <sys/isa_defs.h>
31 #include <sys/types32.h>
35 #include <sys/zfs_vfsops.h>
36 #include <sys/rrwlock.h>
38 #include <sys/zfs_acl.h>
46 * Additional file level attributes, that are stored
47 * in the upper half of zp_flags
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
61 #define ZFS_ATTR_SET(zp, attr, value) \
64 zp->z_phys->zp_flags |= attr; \
66 zp->z_phys->zp_flags &= ~attr; \
70 * Define special zfs pflags
72 #define ZFS_XATTR 0x1 /* is an extended attribute */
73 #define ZFS_INHERIT_ACE 0x2 /* ace has inheritable ACEs */
74 #define ZFS_ACL_TRIVIAL 0x4 /* files ACL is trivial */
75 #define ZFS_ACL_OBJ_ACE 0x8 /* ACL has CMPLX Object ACE */
76 #define ZFS_ACL_PROTECTED 0x10 /* ACL protected */
77 #define ZFS_ACL_DEFAULTED 0x20 /* ACL should be defaulted */
78 #define ZFS_ACL_AUTO_INHERIT 0x40 /* ACL should be inherited */
79 #define ZFS_BONUS_SCANSTAMP 0x80 /* Scanstamp in bonus area */
80 #define ZFS_NO_EXECS_DENIED 0x100 /* exec was given to everyone */
85 #define IS_EPHEMERAL(x) (x > MAXUID)
88 * Should we use FUIDs?
90 #define USE_FUIDS(version, os) (version >= ZPL_VERSION_FUID &&\
91 spa_version(dmu_objset_spa(os)) >= SPA_VERSION_FUID)
93 #define MASTER_NODE_OBJ 1
96 * Special attributes for master node.
97 * "userquota@" and "groupquota@" are also valid (from
98 * zfs_userquota_prop_prefixes[]).
100 #define ZFS_FSID "FSID"
101 #define ZFS_UNLINKED_SET "DELETE_QUEUE"
102 #define ZFS_ROOT_OBJ "ROOT"
103 #define ZPL_VERSION_STR "VERSION"
104 #define ZFS_FUID_TABLES "FUID"
105 #define ZFS_SHARES_DIR "SHARES"
107 #define ZFS_MAX_BLOCKSIZE (SPA_MAXBLOCKSIZE)
109 /* Path component length */
111 * The generic fs code uses MAXNAMELEN to represent
112 * what the largest component length is. Unfortunately,
113 * this length includes the terminating NULL. ZFS needs
114 * to tell the users via pathconf() and statvfs() what the
115 * true maximum length of a component is, excluding the NULL.
117 #define ZFS_MAXNAMELEN (MAXNAMELEN - 1)
120 * Convert mode bits (zp_mode) to BSD-style DT_* values for storing in
121 * the directory entries.
123 #define IFTODT(mode) (((mode) & S_IFMT) >> 12)
126 * The directory entry has the type (currently unused on Solaris) in the
127 * top 4 bits, and the object number in the low 48 bits. The "middle"
128 * 12 bits are unused.
130 #define ZFS_DIRENT_TYPE(de) BF64_GET(de, 60, 4)
131 #define ZFS_DIRENT_OBJ(de) BF64_GET(de, 0, 48)
134 * This is the persistent portion of the znode. It is stored
135 * in the "bonus buffer" of the file. Short symbolic links
136 * are also stored in the bonus buffer.
138 typedef struct znode_phys {
139 uint64_t zp_atime[2]; /* 0 - last file access time */
140 uint64_t zp_mtime[2]; /* 16 - last file modification time */
141 uint64_t zp_ctime[2]; /* 32 - last file change time */
142 uint64_t zp_crtime[2]; /* 48 - creation time */
143 uint64_t zp_gen; /* 64 - generation (txg of creation) */
144 uint64_t zp_mode; /* 72 - file mode bits */
145 uint64_t zp_size; /* 80 - size of file */
146 uint64_t zp_parent; /* 88 - directory parent (`..') */
147 uint64_t zp_links; /* 96 - number of links to file */
148 uint64_t zp_xattr; /* 104 - DMU object for xattrs */
149 uint64_t zp_rdev; /* 112 - dev_t for VBLK & VCHR files */
150 uint64_t zp_flags; /* 120 - persistent flags */
151 uint64_t zp_uid; /* 128 - file owner */
152 uint64_t zp_gid; /* 136 - owning group */
153 uint64_t zp_zap; /* 144 - extra attributes */
154 uint64_t zp_pad[3]; /* 152 - future */
155 zfs_acl_phys_t zp_acl; /* 176 - 263 ACL */
157 * Data may pad out any remaining bytes in the znode buffer, eg:
159 * |<---------------------- dnode_phys (512) ------------------------>|
160 * |<-- dnode (192) --->|<----------- "bonus" buffer (320) ---------->|
161 * |<---- znode (264) ---->|<---- data (56) ---->|
163 * At present, we use this space for the following:
165 * - 32-byte anti-virus scanstamp (regular files only)
170 * Directory entry locks control access to directory entries.
171 * They are used to protect creates, deletes, and renames.
172 * Each directory znode has a mutex and a list of locked names.
175 typedef struct zfs_dirlock {
176 char *dl_name; /* directory entry being locked */
177 uint32_t dl_sharecnt; /* 0 if exclusive, > 0 if shared */
178 uint16_t dl_namesize; /* set if dl_name was allocated */
179 kcondvar_t dl_cv; /* wait for entry to be unlocked */
180 struct znode *dl_dzp; /* directory znode */
181 struct zfs_dirlock *dl_next; /* next in z_dirlocks list */
184 typedef struct znode {
185 struct zfsvfs *z_zfsvfs;
187 uint64_t z_id; /* object ID for this znode */
188 kmutex_t z_lock; /* znode modification lock */
189 krwlock_t z_parent_lock; /* parent lock for directories */
190 krwlock_t z_name_lock; /* "master" lock for dirent locks */
191 zfs_dirlock_t *z_dirlocks; /* directory entry lock list */
192 kmutex_t z_range_lock; /* protects changes to z_range_avl */
193 avl_tree_t z_range_avl; /* avl tree of file range locks */
194 uint8_t z_unlinked; /* file has been unlinked */
195 uint8_t z_atime_dirty; /* atime needs to be synced */
196 uint8_t z_zn_prefetch; /* Prefetch znodes? */
197 uint_t z_blksz; /* block size in bytes */
198 uint_t z_seq; /* modification sequence number */
199 uint64_t z_mapcnt; /* number of pages mapped to file */
200 uint64_t z_last_itx; /* last ZIL itx on this znode */
201 uint64_t z_gen; /* generation (same as zp_gen) */
202 uint32_t z_sync_cnt; /* synchronous open count */
203 kmutex_t z_acl_lock; /* acl data lock */
204 zfs_acl_t *z_acl_cached; /* cached acl */
205 list_node_t z_link_node; /* all znodes in fs link */
207 * These are dmu managed fields.
209 znode_phys_t *z_phys; /* pointer to persistent znode */
210 dmu_buf_t *z_dbuf; /* buffer containing the z_phys */
215 * Range locking rules
216 * --------------------
217 * 1. When truncating a file (zfs_create, zfs_setattr, zfs_space) the whole
218 * file range needs to be locked as RL_WRITER. Only then can the pages be
219 * freed etc and zp_size reset. zp_size must be set within range lock.
220 * 2. For writes and punching holes (zfs_write & zfs_space) just the range
221 * being written or freed needs to be locked as RL_WRITER.
222 * Multiple writes at the end of the file must coordinate zp_size updates
223 * to ensure data isn't lost. A compare and swap loop is currently used
224 * to ensure the file size is at least the offset last written.
225 * 3. For reads (zfs_read, zfs_get_data & zfs_putapage) just the range being
226 * read needs to be locked as RL_READER. A check against zp_size can then
227 * be made for reading beyond end of file.
231 * Convert between znode pointers and vnode pointers
233 #define ZTOV(ZP) ((ZP)->z_vnode)
234 #define VTOZ(VP) ((znode_t *)(VP)->v_data)
237 * ZFS_ENTER() is called on entry to each ZFS vnode and vfs operation.
238 * ZFS_EXIT() must be called before exitting the vop.
239 * ZFS_VERIFY_ZP() verifies the znode is valid.
241 #define ZFS_ENTER(zfsvfs) \
243 rrw_enter(&(zfsvfs)->z_teardown_lock, RW_READER, FTAG); \
244 if ((zfsvfs)->z_unmounted) { \
250 #define ZFS_EXIT(zfsvfs) rrw_exit(&(zfsvfs)->z_teardown_lock, FTAG)
252 #define ZFS_VERIFY_ZP(zp) \
253 if ((zp)->z_dbuf == NULL) { \
254 ZFS_EXIT((zp)->z_zfsvfs); \
259 * Macros for dealing with dmu_buf_hold
261 #define ZFS_OBJ_HASH(obj_num) ((obj_num) & (ZFS_OBJ_MTX_SZ - 1))
262 #define ZFS_OBJ_MUTEX(zfsvfs, obj_num) \
263 (&(zfsvfs)->z_hold_mtx[ZFS_OBJ_HASH(obj_num)])
264 #define ZFS_OBJ_HOLD_ENTER(zfsvfs, obj_num) \
265 mutex_enter(ZFS_OBJ_MUTEX((zfsvfs), (obj_num)))
266 #define ZFS_OBJ_HOLD_TRYENTER(zfsvfs, obj_num) \
267 mutex_tryenter(ZFS_OBJ_MUTEX((zfsvfs), (obj_num)))
268 #define ZFS_OBJ_HOLD_EXIT(zfsvfs, obj_num) \
269 mutex_exit(ZFS_OBJ_MUTEX((zfsvfs), (obj_num)))
272 * Macros to encode/decode ZFS stored time values from/to struct timespec
274 #define ZFS_TIME_ENCODE(tp, stmp) \
276 (stmp)[0] = (uint64_t)(tp)->tv_sec; \
277 (stmp)[1] = (uint64_t)(tp)->tv_nsec; \
280 #define ZFS_TIME_DECODE(tp, stmp) \
282 (tp)->tv_sec = (time_t)(stmp)[0]; \
283 (tp)->tv_nsec = (long)(stmp)[1]; \
289 #define ACCESSED (AT_ATIME)
290 #define STATE_CHANGED (AT_CTIME)
291 #define CONTENT_MODIFIED (AT_MTIME | AT_CTIME)
293 #define ZFS_ACCESSTIME_STAMP(zfsvfs, zp) \
294 if ((zfsvfs)->z_atime && !((zfsvfs)->z_vfs->vfs_flag & VFS_RDONLY)) \
295 zfs_time_stamper(zp, ACCESSED, NULL)
297 extern int zfs_init_fs(zfsvfs_t *, znode_t **);
298 extern void zfs_set_dataprop(objset_t *);
299 extern void zfs_create_fs(objset_t *os, cred_t *cr, nvlist_t *,
301 extern void zfs_time_stamper(znode_t *, uint_t, dmu_tx_t *);
302 extern void zfs_time_stamper_locked(znode_t *, uint_t, dmu_tx_t *);
303 extern void zfs_grow_blocksize(znode_t *, uint64_t, dmu_tx_t *);
304 extern int zfs_freesp(znode_t *, uint64_t, uint64_t, int, boolean_t);
305 extern void zfs_znode_init(void);
306 extern void zfs_znode_fini(void);
307 extern int zfs_zget(zfsvfs_t *, uint64_t, znode_t **);
308 extern int zfs_rezget(znode_t *);
309 extern void zfs_zinactive(znode_t *);
310 extern void zfs_znode_delete(znode_t *, dmu_tx_t *);
311 extern void zfs_znode_free(znode_t *);
312 extern void zfs_remove_op_tables();
313 extern int zfs_create_op_tables();
314 extern int zfs_sync(vfs_t *vfsp, short flag, cred_t *cr);
315 extern dev_t zfs_cmpldev(uint64_t);
316 extern int zfs_get_zplprop(objset_t *os, zfs_prop_t prop, uint64_t *value);
317 extern int zfs_get_stats(objset_t *os, nvlist_t *nv);
318 extern void zfs_znode_dmu_fini(znode_t *);
320 extern void zfs_log_create(zilog_t *zilog, dmu_tx_t *tx, uint64_t txtype,
321 znode_t *dzp, znode_t *zp, char *name, vsecattr_t *, zfs_fuid_info_t *,
323 extern int zfs_log_create_txtype(zil_create_t, vsecattr_t *vsecp,
325 extern void zfs_log_remove(zilog_t *zilog, dmu_tx_t *tx, uint64_t txtype,
326 znode_t *dzp, char *name);
327 extern void zfs_log_link(zilog_t *zilog, dmu_tx_t *tx, uint64_t txtype,
328 znode_t *dzp, znode_t *zp, char *name);
329 extern void zfs_log_symlink(zilog_t *zilog, dmu_tx_t *tx, uint64_t txtype,
330 znode_t *dzp, znode_t *zp, char *name, char *link);
331 extern void zfs_log_rename(zilog_t *zilog, dmu_tx_t *tx, uint64_t txtype,
332 znode_t *sdzp, char *sname, znode_t *tdzp, char *dname, znode_t *szp);
333 extern void zfs_log_write(zilog_t *zilog, dmu_tx_t *tx, int txtype,
334 znode_t *zp, offset_t off, ssize_t len, int ioflag);
335 extern void zfs_log_truncate(zilog_t *zilog, dmu_tx_t *tx, int txtype,
336 znode_t *zp, uint64_t off, uint64_t len);
337 extern void zfs_log_setattr(zilog_t *zilog, dmu_tx_t *tx, int txtype,
338 znode_t *zp, vattr_t *vap, uint_t mask_applied, zfs_fuid_info_t *fuidp);
339 extern void zfs_log_acl(zilog_t *zilog, dmu_tx_t *tx, znode_t *zp,
340 vsecattr_t *vsecp, zfs_fuid_info_t *fuidp);
341 extern void zfs_xvattr_set(znode_t *zp, xvattr_t *xvap);
342 extern void zfs_upgrade(zfsvfs_t *zfsvfs, dmu_tx_t *tx);
343 extern int zfs_create_share_dir(zfsvfs_t *zfsvfs, dmu_tx_t *tx);
345 extern caddr_t zfs_map_page(page_t *, enum seg_rw);
346 extern void zfs_unmap_page(page_t *, caddr_t);
348 extern zil_get_data_t zfs_get_data;
349 extern zil_replay_func_t *zfs_replay_vector[TX_MAX_TYPE];
350 extern int zfsfstype;
354 extern int zfs_obj_to_path(objset_t *osp, uint64_t obj, char *buf, int len);
360 #endif /* _SYS_FS_ZFS_ZNODE_H */