]>
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. |
5d43cc9a | 23 | * Copyright (c) 2012, 2018 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 | #include <sys/zfs_acl.h> |
31 | #include <sys/zil.h> | |
9c5167d1 | 32 | #include <sys/zfs_project.h> |
34dc7c2f BB |
33 | |
34 | #ifdef __cplusplus | |
35 | extern "C" { | |
36 | #endif | |
37 | ||
38 | /* | |
39 | * Additional file level attributes, that are stored | |
40 | * in the upper half of zp_flags | |
41 | */ | |
c5b3a7bb RC |
42 | #define ZFS_READONLY 0x0000000100000000ull |
43 | #define ZFS_HIDDEN 0x0000000200000000ull | |
44 | #define ZFS_SYSTEM 0x0000000400000000ull | |
45 | #define ZFS_ARCHIVE 0x0000000800000000ull | |
46 | #define ZFS_IMMUTABLE 0x0000001000000000ull | |
47 | #define ZFS_NOUNLINK 0x0000002000000000ull | |
48 | #define ZFS_APPENDONLY 0x0000004000000000ull | |
49 | #define ZFS_NODUMP 0x0000008000000000ull | |
50 | #define ZFS_OPAQUE 0x0000010000000000ull | |
5484965a BB |
51 | #define ZFS_AV_QUARANTINED 0x0000020000000000ull |
52 | #define ZFS_AV_MODIFIED 0x0000040000000000ull | |
c5b3a7bb RC |
53 | #define ZFS_REPARSE 0x0000080000000000ull |
54 | #define ZFS_OFFLINE 0x0000100000000000ull | |
55 | #define ZFS_SPARSE 0x0000200000000000ull | |
34dc7c2f | 56 | |
9c5167d1 NF |
57 | /* |
58 | * PROJINHERIT attribute is used to indicate that the child object under the | |
59 | * directory which has the PROJINHERIT attribute needs to inherit its parent | |
60 | * project ID that is used by project quota. | |
61 | */ | |
62 | #define ZFS_PROJINHERIT 0x0000400000000000ull | |
63 | ||
64 | /* | |
65 | * PROJID attr is used internally to indicate that the object has project ID. | |
66 | */ | |
67 | #define ZFS_PROJID 0x0000800000000000ull | |
68 | ||
428870ff | 69 | #define ZFS_ATTR_SET(zp, attr, value, pflags, tx) \ |
34dc7c2f BB |
70 | { \ |
71 | if (value) \ | |
428870ff | 72 | pflags |= attr; \ |
34dc7c2f | 73 | else \ |
428870ff | 74 | pflags &= ~attr; \ |
5484965a | 75 | VERIFY(0 == sa_update(zp->z_sa_hdl, SA_ZPL_FLAGS(ZTOZSB(zp)), \ |
428870ff | 76 | &pflags, sizeof (pflags), tx)); \ |
34dc7c2f BB |
77 | } |
78 | ||
79 | /* | |
80 | * Define special zfs pflags | |
81 | */ | |
82 | #define ZFS_XATTR 0x1 /* is an extended attribute */ | |
83 | #define ZFS_INHERIT_ACE 0x2 /* ace has inheritable ACEs */ | |
5484965a BB |
84 | #define ZFS_ACL_TRIVIAL 0x4 /* files ACL is trivial */ |
85 | #define ZFS_ACL_OBJ_ACE 0x8 /* ACL has CMPLX Object ACE */ | |
34dc7c2f BB |
86 | #define ZFS_ACL_PROTECTED 0x10 /* ACL protected */ |
87 | #define ZFS_ACL_DEFAULTED 0x20 /* ACL should be defaulted */ | |
88 | #define ZFS_ACL_AUTO_INHERIT 0x40 /* ACL should be inherited */ | |
89 | #define ZFS_BONUS_SCANSTAMP 0x80 /* Scanstamp in bonus area */ | |
45d1cae3 | 90 | #define ZFS_NO_EXECS_DENIED 0x100 /* exec was given to everyone */ |
34dc7c2f | 91 | |
428870ff BB |
92 | #define SA_ZPL_ATIME(z) z->z_attr_table[ZPL_ATIME] |
93 | #define SA_ZPL_MTIME(z) z->z_attr_table[ZPL_MTIME] | |
94 | #define SA_ZPL_CTIME(z) z->z_attr_table[ZPL_CTIME] | |
95 | #define SA_ZPL_CRTIME(z) z->z_attr_table[ZPL_CRTIME] | |
96 | #define SA_ZPL_GEN(z) z->z_attr_table[ZPL_GEN] | |
97 | #define SA_ZPL_DACL_ACES(z) z->z_attr_table[ZPL_DACL_ACES] | |
98 | #define SA_ZPL_XATTR(z) z->z_attr_table[ZPL_XATTR] | |
99 | #define SA_ZPL_SYMLINK(z) z->z_attr_table[ZPL_SYMLINK] | |
100 | #define SA_ZPL_RDEV(z) z->z_attr_table[ZPL_RDEV] | |
101 | #define SA_ZPL_SCANSTAMP(z) z->z_attr_table[ZPL_SCANSTAMP] | |
102 | #define SA_ZPL_UID(z) z->z_attr_table[ZPL_UID] | |
103 | #define SA_ZPL_GID(z) z->z_attr_table[ZPL_GID] | |
104 | #define SA_ZPL_PARENT(z) z->z_attr_table[ZPL_PARENT] | |
105 | #define SA_ZPL_LINKS(z) z->z_attr_table[ZPL_LINKS] | |
106 | #define SA_ZPL_MODE(z) z->z_attr_table[ZPL_MODE] | |
107 | #define SA_ZPL_DACL_COUNT(z) z->z_attr_table[ZPL_DACL_COUNT] | |
108 | #define SA_ZPL_FLAGS(z) z->z_attr_table[ZPL_FLAGS] | |
109 | #define SA_ZPL_SIZE(z) z->z_attr_table[ZPL_SIZE] | |
110 | #define SA_ZPL_ZNODE_ACL(z) z->z_attr_table[ZPL_ZNODE_ACL] | |
82a37189 | 111 | #define SA_ZPL_DXATTR(z) z->z_attr_table[ZPL_DXATTR] |
428870ff | 112 | #define SA_ZPL_PAD(z) z->z_attr_table[ZPL_PAD] |
9c5167d1 | 113 | #define SA_ZPL_PROJID(z) z->z_attr_table[ZPL_PROJID] |
428870ff | 114 | |
34dc7c2f BB |
115 | /* |
116 | * Is ID ephemeral? | |
117 | */ | |
118 | #define IS_EPHEMERAL(x) (x > MAXUID) | |
119 | ||
120 | /* | |
121 | * Should we use FUIDs? | |
122 | */ | |
428870ff | 123 | #define USE_FUIDS(version, os) (version >= ZPL_VERSION_FUID && \ |
34dc7c2f | 124 | spa_version(dmu_objset_spa(os)) >= SPA_VERSION_FUID) |
428870ff BB |
125 | #define USE_SA(version, os) (version >= ZPL_VERSION_SA && \ |
126 | spa_version(dmu_objset_spa(os)) >= SPA_VERSION_SA) | |
34dc7c2f BB |
127 | |
128 | #define MASTER_NODE_OBJ 1 | |
129 | ||
130 | /* | |
131 | * Special attributes for master node. | |
9c5167d1 | 132 | * "userquota@", "groupquota@" and "projectquota@" are also valid (from |
9babb374 | 133 | * zfs_userquota_prop_prefixes[]). |
34dc7c2f BB |
134 | */ |
135 | #define ZFS_FSID "FSID" | |
136 | #define ZFS_UNLINKED_SET "DELETE_QUEUE" | |
137 | #define ZFS_ROOT_OBJ "ROOT" | |
138 | #define ZPL_VERSION_STR "VERSION" | |
139 | #define ZFS_FUID_TABLES "FUID" | |
9babb374 | 140 | #define ZFS_SHARES_DIR "SHARES" |
428870ff | 141 | #define ZFS_SA_ATTRS "SA_ATTRS" |
34dc7c2f | 142 | |
34dc7c2f BB |
143 | /* |
144 | * Convert mode bits (zp_mode) to BSD-style DT_* values for storing in | |
054bc00b BB |
145 | * the directory entries. On Linux systems this value is already |
146 | * defined correctly as part of the /usr/include/dirent.h header file. | |
34dc7c2f | 147 | */ |
054bc00b | 148 | #ifndef IFTODT |
34dc7c2f | 149 | #define IFTODT(mode) (((mode) & S_IFMT) >> 12) |
054bc00b | 150 | #endif |
34dc7c2f BB |
151 | |
152 | /* | |
153 | * The directory entry has the type (currently unused on Solaris) in the | |
154 | * top 4 bits, and the object number in the low 48 bits. The "middle" | |
155 | * 12 bits are unused. | |
156 | */ | |
157 | #define ZFS_DIRENT_TYPE(de) BF64_GET(de, 60, 4) | |
158 | #define ZFS_DIRENT_OBJ(de) BF64_GET(de, 0, 48) | |
159 | ||
27ece2ee MM |
160 | extern int zfs_obj_to_path(objset_t *osp, uint64_t obj, char *buf, int len); |
161 | ||
162 | #ifdef _KERNEL | |
163 | #include <sys/zfs_znode_impl.h> | |
164 | ||
34dc7c2f BB |
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 | */ | |
34dc7c2f BB |
170 | typedef struct zfs_dirlock { |
171 | char *dl_name; /* directory entry being locked */ | |
172 | uint32_t dl_sharecnt; /* 0 if exclusive, > 0 if shared */ | |
428870ff | 173 | uint8_t dl_namelock; /* 1 if z_name_lock is NOT held */ |
34dc7c2f BB |
174 | uint16_t dl_namesize; /* set if dl_name was allocated */ |
175 | kcondvar_t dl_cv; /* wait for entry to be unlocked */ | |
176 | struct znode *dl_dzp; /* directory znode */ | |
177 | struct zfs_dirlock *dl_next; /* next in z_dirlocks list */ | |
178 | } zfs_dirlock_t; | |
179 | ||
180 | typedef struct znode { | |
34dc7c2f BB |
181 | uint64_t z_id; /* object ID for this znode */ |
182 | kmutex_t z_lock; /* znode modification lock */ | |
34dc7c2f BB |
183 | krwlock_t z_parent_lock; /* parent lock for directories */ |
184 | krwlock_t z_name_lock; /* "master" lock for dirent locks */ | |
185 | zfs_dirlock_t *z_dirlocks; /* directory entry lock list */ | |
bd4dde8e | 186 | zfs_rangelock_t z_rangelock; /* file range locks */ |
a43570c5 TK |
187 | boolean_t z_unlinked; /* file has been unlinked */ |
188 | boolean_t z_atime_dirty; /* atime needs to be synced */ | |
189 | boolean_t z_zn_prefetch; /* Prefetch znodes? */ | |
190 | boolean_t z_moved; /* Has this znode been moved? */ | |
191 | boolean_t z_is_sa; /* are we native sa? */ | |
192 | boolean_t z_is_mapped; /* are we mmap'ed */ | |
193 | boolean_t z_is_ctldir; /* are we .zfs entry */ | |
194 | boolean_t z_is_stale; /* are we stale due to rollback? */ | |
e7a2fa70 | 195 | boolean_t z_suspended; /* extra ref from a suspend? */ |
34dc7c2f BB |
196 | uint_t z_blksz; /* block size in bytes */ |
197 | uint_t z_seq; /* modification sequence number */ | |
198 | uint64_t z_mapcnt; /* number of pages mapped to file */ | |
50c957f7 | 199 | uint64_t z_dnodesize; /* dnode size */ |
428870ff | 200 | uint64_t z_size; /* file size (cached) */ |
428870ff | 201 | uint64_t z_pflags; /* pflags (cached) */ |
34dc7c2f | 202 | uint32_t z_sync_cnt; /* synchronous open count */ |
7f89ae6b | 203 | mode_t z_mode; /* mode (cached) */ |
34dc7c2f | 204 | kmutex_t z_acl_lock; /* acl data lock */ |
45d1cae3 | 205 | zfs_acl_t *z_acl_cached; /* cached acl */ |
82a37189 | 206 | krwlock_t z_xattr_lock; /* xattr data lock */ |
d1d7e268 | 207 | nvlist_t *z_xattr_cached; /* cached xattrs */ |
98701490 | 208 | uint64_t z_xattr_parent; /* parent obj for this xattr */ |
9c5167d1 | 209 | uint64_t z_projid; /* project ID */ |
34dc7c2f | 210 | list_node_t z_link_node; /* all znodes in fs link */ |
428870ff | 211 | sa_handle_t *z_sa_hdl; /* handle to sa data */ |
27ece2ee MM |
212 | |
213 | /* | |
214 | * Platform specific field, defined by each platform and only | |
dd4bc569 | 215 | * accessible from platform specific code. |
27ece2ee MM |
216 | */ |
217 | ZNODE_OS_FIELDS; | |
34dc7c2f BB |
218 | } znode_t; |
219 | ||
c96c36fa BB |
220 | typedef struct znode_hold { |
221 | uint64_t zh_obj; /* object id */ | |
222 | kmutex_t zh_lock; /* lock serializing object access */ | |
223 | avl_node_t zh_node; /* avl tree linkage */ | |
c13060e4 | 224 | zfs_refcount_t zh_refcount; /* active consumer reference count */ |
c96c36fa | 225 | } znode_hold_t; |
34dc7c2f | 226 | |
9c5167d1 NF |
227 | static inline uint64_t |
228 | zfs_inherit_projid(znode_t *dzp) | |
229 | { | |
230 | return ((dzp->z_pflags & ZFS_PROJINHERIT) ? dzp->z_projid : | |
231 | ZFS_DEFAULT_PROJID); | |
232 | } | |
233 | ||
34dc7c2f BB |
234 | /* |
235 | * Timestamp defines | |
236 | */ | |
3558fd73 BB |
237 | #define ACCESSED (ATTR_ATIME) |
238 | #define STATE_CHANGED (ATTR_CTIME) | |
239 | #define CONTENT_MODIFIED (ATTR_MTIME | ATTR_CTIME) | |
34dc7c2f | 240 | |
0037b49e | 241 | extern int zfs_init_fs(zfsvfs_t *, znode_t **); |
34dc7c2f BB |
242 | extern void zfs_set_dataprop(objset_t *); |
243 | extern void zfs_create_fs(objset_t *os, cred_t *cr, nvlist_t *, | |
244 | dmu_tx_t *tx); | |
428870ff | 245 | extern void zfs_tstamp_update_setup(znode_t *, uint_t, uint64_t [2], |
0df9673f | 246 | uint64_t [2]); |
34dc7c2f BB |
247 | extern void zfs_grow_blocksize(znode_t *, uint64_t, dmu_tx_t *); |
248 | extern int zfs_freesp(znode_t *, uint64_t, uint64_t, int, boolean_t); | |
249 | extern void zfs_znode_init(void); | |
250 | extern void zfs_znode_fini(void); | |
c96c36fa | 251 | extern int zfs_znode_hold_compare(const void *, const void *); |
0037b49e | 252 | extern int zfs_zget(zfsvfs_t *, uint64_t, znode_t **); |
34dc7c2f BB |
253 | extern int zfs_rezget(znode_t *); |
254 | extern void zfs_zinactive(znode_t *); | |
255 | extern void zfs_znode_delete(znode_t *, dmu_tx_t *); | |
0bc8fd78 BB |
256 | extern void zfs_remove_op_tables(void); |
257 | extern int zfs_create_op_tables(void); | |
34dc7c2f BB |
258 | extern dev_t zfs_cmpldev(uint64_t); |
259 | extern int zfs_get_zplprop(objset_t *os, zfs_prop_t prop, uint64_t *value); | |
34dc7c2f | 260 | extern int zfs_get_stats(objset_t *os, nvlist_t *nv); |
a08abc1b | 261 | extern boolean_t zfs_get_vfs_flag_unmounted(objset_t *os); |
34dc7c2f BB |
262 | extern void zfs_znode_dmu_fini(znode_t *); |
263 | ||
264 | extern void zfs_log_create(zilog_t *zilog, dmu_tx_t *tx, uint64_t txtype, | |
265 | znode_t *dzp, znode_t *zp, char *name, vsecattr_t *, zfs_fuid_info_t *, | |
266 | vattr_t *vap); | |
267 | extern int zfs_log_create_txtype(zil_create_t, vsecattr_t *vsecp, | |
268 | vattr_t *vap); | |
269 | extern void zfs_log_remove(zilog_t *zilog, dmu_tx_t *tx, uint64_t txtype, | |
8e556c5e | 270 | znode_t *dzp, char *name, uint64_t foid, boolean_t unlinked); |
572e2857 | 271 | #define ZFS_NO_OBJECT 0 /* no object id */ |
34dc7c2f BB |
272 | extern void zfs_log_link(zilog_t *zilog, dmu_tx_t *tx, uint64_t txtype, |
273 | znode_t *dzp, znode_t *zp, char *name); | |
274 | extern void zfs_log_symlink(zilog_t *zilog, dmu_tx_t *tx, uint64_t txtype, | |
275 | znode_t *dzp, znode_t *zp, char *name, char *link); | |
276 | extern void zfs_log_rename(zilog_t *zilog, dmu_tx_t *tx, uint64_t txtype, | |
277 | znode_t *sdzp, char *sname, znode_t *tdzp, char *dname, znode_t *szp); | |
278 | extern void zfs_log_write(zilog_t *zilog, dmu_tx_t *tx, int txtype, | |
119a394a ED |
279 | znode_t *zp, offset_t off, ssize_t len, int ioflag, |
280 | zil_callback_t callback, void *callback_data); | |
34dc7c2f BB |
281 | extern void zfs_log_truncate(zilog_t *zilog, dmu_tx_t *tx, int txtype, |
282 | znode_t *zp, uint64_t off, uint64_t len); | |
283 | extern void zfs_log_setattr(zilog_t *zilog, dmu_tx_t *tx, int txtype, | |
5484965a | 284 | znode_t *zp, vattr_t *vap, uint_t mask_applied, zfs_fuid_info_t *fuidp); |
34dc7c2f BB |
285 | extern void zfs_log_acl(zilog_t *zilog, dmu_tx_t *tx, znode_t *zp, |
286 | vsecattr_t *vsecp, zfs_fuid_info_t *fuidp); | |
428870ff | 287 | extern void zfs_xvattr_set(znode_t *zp, xvattr_t *xvap, dmu_tx_t *tx); |
0037b49e | 288 | extern void zfs_upgrade(zfsvfs_t *zfsvfs, dmu_tx_t *tx); |
34dc7c2f | 289 | |
27ece2ee | 290 | #endif |
34dc7c2f BB |
291 | #ifdef __cplusplus |
292 | } | |
293 | #endif | |
294 | ||
295 | #endif /* _SYS_FS_ZFS_ZNODE_H */ |