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 (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
23 * Copyright (c) 2012 by Delphix. All rights reserved.
26 /* Portions Copyright 2010 Robert Milkowski */
31 #include <sys/types.h>
43 * Each objset has its own intent log. The log header (zil_header_t)
44 * for objset N's intent log is kept in the Nth object of the SPA's
45 * intent_log objset. The log header points to a chain of log blocks,
46 * each of which contains log records (i.e., transactions) followed by
47 * a log block trailer (zil_trailer_t). The format of a log record
48 * depends on the record (or transaction) type, but all records begin
49 * with a common structure that defines the type, length, and txg.
53 * Intent log header - this on disk structure holds fields to manage
54 * the log. All fields are 64 bit to easily handle cross architectures.
56 typedef struct zil_header
{
57 uint64_t zh_claim_txg
; /* txg in which log blocks were claimed */
58 uint64_t zh_replay_seq
; /* highest replayed sequence number */
59 blkptr_t zh_log
; /* log chain */
60 uint64_t zh_claim_blk_seq
; /* highest claimed block sequence number */
61 uint64_t zh_flags
; /* header flags */
62 uint64_t zh_claim_lr_seq
; /* highest claimed lr sequence number */
67 * zh_flags bit settings
69 #define ZIL_REPLAY_NEEDED 0x1 /* replay needed - internal only */
70 #define ZIL_CLAIM_LR_SEQ_VALID 0x2 /* zh_claim_lr_seq field is valid */
75 * Log blocks are chained together. Originally they were chained at the
76 * end of the block. For performance reasons the chain was moved to the
77 * beginning of the block which allows writes for only the data being used.
78 * The older position is supported for backwards compatability.
80 * The zio_eck_t contains a zec_cksum which for the intent log is
81 * the sequence number of this log block. A seq of 0 is invalid.
82 * The zec_cksum is checked by the SPA against the sequence
83 * number passed in the blk_cksum field of the blkptr_t
85 typedef struct zil_chain
{
87 blkptr_t zc_next_blk
; /* next block in chain */
88 uint64_t zc_nused
; /* bytes in log block used */
89 zio_eck_t zc_eck
; /* block trailer */
92 #define ZIL_MIN_BLKSZ 4096ULL
95 * The words of a log block checksum.
97 #define ZIL_ZC_GUID_0 0
98 #define ZIL_ZC_GUID_1 1
99 #define ZIL_ZC_OBJSET 2
102 typedef enum zil_create
{
109 * size of xvattr log section.
110 * its composed of lr_attr_t + xvattr bitmap + 2 64 bit timestamps
111 * for create time and a single 64 bit integer for all of the attributes,
112 * and 4 64 bit integers (32 bytes) for the scanstamp.
116 #define ZIL_XVAT_SIZE(mapsize) \
117 sizeof (lr_attr_t) + (sizeof (uint32_t) * (mapsize - 1)) + \
118 (sizeof (uint64_t) * 7)
121 * Size of ACL in log. The ACE data is padded out to properly align
122 * on 8 byte boundary.
125 #define ZIL_ACE_LENGTH(x) (roundup(x, sizeof (uint64_t)))
128 * Intent log transaction types and record structures
130 #define TX_CREATE 1 /* Create file */
131 #define TX_MKDIR 2 /* Make directory */
132 #define TX_MKXATTR 3 /* Make XATTR directory */
133 #define TX_SYMLINK 4 /* Create symbolic link to a file */
134 #define TX_REMOVE 5 /* Remove file */
135 #define TX_RMDIR 6 /* Remove directory */
136 #define TX_LINK 7 /* Create hard link to a file */
137 #define TX_RENAME 8 /* Rename a file */
138 #define TX_WRITE 9 /* File write */
139 #define TX_TRUNCATE 10 /* Truncate a file */
140 #define TX_SETATTR 11 /* Set file attributes */
141 #define TX_ACL_V0 12 /* Set old formatted ACL */
142 #define TX_ACL 13 /* Set ACL */
143 #define TX_CREATE_ACL 14 /* create with ACL */
144 #define TX_CREATE_ATTR 15 /* create + attrs */
145 #define TX_CREATE_ACL_ATTR 16 /* create with ACL + attrs */
146 #define TX_MKDIR_ACL 17 /* mkdir with ACL */
147 #define TX_MKDIR_ATTR 18 /* mkdir with attr */
148 #define TX_MKDIR_ACL_ATTR 19 /* mkdir with ACL + attrs */
149 #define TX_WRITE2 20 /* dmu_sync EALREADY write */
150 #define TX_MAX_TYPE 21 /* Max transaction type */
153 * The transactions for mkdir, symlink, remove, rmdir, link, and rename
154 * may have the following bit set, indicating the original request
155 * specified case-insensitive handling of names.
157 #define TX_CI ((uint64_t)0x1 << 63) /* case-insensitive behavior requested */
160 * Transactions for write, truncate, setattr, acl_v0, and acl can be logged
161 * out of order. For convenience in the code, all such records must have
162 * lr_foid at the same offset.
164 #define TX_OOO(txtype) \
165 ((txtype) == TX_WRITE || \
166 (txtype) == TX_TRUNCATE || \
167 (txtype) == TX_SETATTR || \
168 (txtype) == TX_ACL_V0 || \
169 (txtype) == TX_ACL || \
170 (txtype) == TX_WRITE2)
173 * Format of log records.
174 * The fields are carefully defined to allow them to be aligned
175 * and sized the same on sparc & intel architectures.
176 * Each log record has a common structure at the beginning.
178 * The log record on disk (lrc_seq) holds the sequence number of all log
179 * records which is used to ensure we don't replay the same record.
181 typedef struct { /* common log record header */
182 uint64_t lrc_txtype
; /* intent log transaction type */
183 uint64_t lrc_reclen
; /* transaction record length */
184 uint64_t lrc_txg
; /* dmu transaction group number */
185 uint64_t lrc_seq
; /* see comment above */
189 * Common start of all out-of-order record types (TX_OOO() above).
192 lr_t lr_common
; /* common portion of log record */
193 uint64_t lr_foid
; /* object id */
197 * Handle option extended vattr attributes.
199 * Whenever new attributes are added the version number
200 * will need to be updated as will code in
201 * zfs_log.c and zfs_replay.c
204 uint32_t lr_attr_masksize
; /* number of elements in array */
205 uint32_t lr_attr_bitmap
; /* First entry of array */
206 /* remainder of array and any additional fields */
210 * log record for creates without optional ACL.
211 * This log record does support optional xvattr_t attributes.
214 lr_t lr_common
; /* common portion of log record */
215 uint64_t lr_doid
; /* object id of directory */
216 uint64_t lr_foid
; /* object id of created file object */
217 uint64_t lr_mode
; /* mode of object */
218 uint64_t lr_uid
; /* uid of object */
219 uint64_t lr_gid
; /* gid of object */
220 uint64_t lr_gen
; /* generation (txg of creation) */
221 uint64_t lr_crtime
[2]; /* creation time */
222 uint64_t lr_rdev
; /* rdev of object to create */
223 /* name of object to create follows this */
224 /* for symlinks, link content follows name */
225 /* for creates with xvattr data, the name follows the xvattr info */
229 * FUID ACL record will be an array of ACEs from the original ACL.
230 * If this array includes ephemeral IDs, the record will also include
231 * an array of log-specific FUIDs to replace the ephemeral IDs.
232 * Only one copy of each unique domain will be present, so the log-specific
233 * FUIDs will use an index into a compressed domain table. On replay this
234 * information will be used to construct real FUIDs (and bypass idmap,
235 * since it may not be available).
239 * Log record for creates with optional ACL
240 * This log record is also used for recording any FUID
241 * information needed for replaying the create. If the
242 * file doesn't have any actual ACEs then the lr_aclcnt
245 * After lr_acl_flags, there are a lr_acl_bytes number of variable sized ace's.
246 * If create is also setting xvattr's, then acl data follows xvattr.
247 * If ACE FUIDs are needed then they will follow the xvattr_t. Following
248 * the FUIDs will be the domain table information. The FUIDs for the owner
249 * and group will be in lr_create. Name follows ACL data.
252 lr_create_t lr_create
; /* common create portion */
253 uint64_t lr_aclcnt
; /* number of ACEs in ACL */
254 uint64_t lr_domcnt
; /* number of unique domains */
255 uint64_t lr_fuidcnt
; /* number of real fuids */
256 uint64_t lr_acl_bytes
; /* number of bytes in ACL */
257 uint64_t lr_acl_flags
; /* ACL flags */
261 lr_t lr_common
; /* common portion of log record */
262 uint64_t lr_doid
; /* obj id of directory */
263 /* name of object to remove follows this */
267 lr_t lr_common
; /* common portion of log record */
268 uint64_t lr_doid
; /* obj id of directory */
269 uint64_t lr_link_obj
; /* obj id of link */
270 /* name of object to link follows this */
274 lr_t lr_common
; /* common portion of log record */
275 uint64_t lr_sdoid
; /* obj id of source directory */
276 uint64_t lr_tdoid
; /* obj id of target directory */
277 /* 2 strings: names of source and destination follow this */
281 lr_t lr_common
; /* common portion of log record */
282 uint64_t lr_foid
; /* file object to write */
283 uint64_t lr_offset
; /* offset to write to */
284 uint64_t lr_length
; /* user data length to write */
285 uint64_t lr_blkoff
; /* no longer used */
286 blkptr_t lr_blkptr
; /* spa block pointer for replay */
287 /* write data will follow for small writes */
291 lr_t lr_common
; /* common portion of log record */
292 uint64_t lr_foid
; /* object id of file to truncate */
293 uint64_t lr_offset
; /* offset to truncate from */
294 uint64_t lr_length
; /* length to truncate */
298 lr_t lr_common
; /* common portion of log record */
299 uint64_t lr_foid
; /* file object to change attributes */
300 uint64_t lr_mask
; /* mask of attributes to set */
301 uint64_t lr_mode
; /* mode to set */
302 uint64_t lr_uid
; /* uid to set */
303 uint64_t lr_gid
; /* gid to set */
304 uint64_t lr_size
; /* size to set */
305 uint64_t lr_atime
[2]; /* access time */
306 uint64_t lr_mtime
[2]; /* modification time */
307 /* optional attribute lr_attr_t may be here */
311 lr_t lr_common
; /* common portion of log record */
312 uint64_t lr_foid
; /* obj id of file */
313 uint64_t lr_aclcnt
; /* number of acl entries */
314 /* lr_aclcnt number of ace_t entries follow this */
318 lr_t lr_common
; /* common portion of log record */
319 uint64_t lr_foid
; /* obj id of file */
320 uint64_t lr_aclcnt
; /* number of ACEs in ACL */
321 uint64_t lr_domcnt
; /* number of unique domains */
322 uint64_t lr_fuidcnt
; /* number of real fuids */
323 uint64_t lr_acl_bytes
; /* number of bytes in ACL */
324 uint64_t lr_acl_flags
; /* ACL flags */
325 /* lr_acl_bytes number of variable sized ace's follows */
329 * ZIL structure definitions, interface function prototype and globals.
333 * Writes are handled in three different ways:
336 * In this mode, if we need to commit the write later, then the block
337 * is immediately written into the file system (using dmu_sync),
338 * and a pointer to the block is put into the log record.
339 * When the txg commits the block is linked in.
340 * This saves additionally writing the data into the log record.
341 * There are a few requirements for this to occur:
342 * - write is greater than zfs/zvol_immediate_write_sz
343 * - not using slogs (as slogs are assumed to always be faster
344 * than writing into the main pool)
345 * - the write occupies only one block
347 * If we know we'll immediately be committing the
348 * transaction (FSYNC or FDSYNC), the we allocate a larger
349 * log record here for the data and copy the data in.
351 * Otherwise we don't allocate a buffer, and *if* we need to
352 * flush the write later then a buffer is allocated and
353 * we retrieve the data using the dmu.
356 WR_INDIRECT
, /* indirect - a large write (dmu_sync() data */
357 /* and put blkptr in log, rather than actual data) */
358 WR_COPIED
, /* immediate - data is copied into lr_write_t */
359 WR_NEED_COPY
, /* immediate - data needs to be copied if pushed */
360 WR_NUM_STATES
/* number of states */
363 typedef void (*zil_callback_t
)(void *data
);
366 list_node_t itx_node
; /* linkage on zl_itx_list */
367 void *itx_private
; /* type-specific opaque data */
368 itx_wr_state_t itx_wr_state
; /* write state */
369 uint8_t itx_sync
; /* synchronous transaction */
370 zil_callback_t itx_callback
; /* Called when the itx is persistent */
371 void *itx_callback_data
; /* User data for the callback */
372 uint64_t itx_sod
; /* record size on disk */
373 uint64_t itx_oid
; /* object id */
374 lr_t itx_lr
; /* common part of log record */
375 /* followed by type-specific part of lr_xx_t and its immediate data */
379 * Used for zil kstat.
381 typedef struct zil_stats
{
383 * Number of times a ZIL commit (e.g. fsync) has been requested.
385 kstat_named_t zil_commit_count
;
388 * Number of times the ZIL has been flushed to stable storage.
389 * This is less than zil_commit_count when commits are "merged"
390 * (see the documentation above zil_commit()).
392 kstat_named_t zil_commit_writer_count
;
395 * Number of transactions (reads, writes, renames, etc.)
396 * that have been commited.
398 kstat_named_t zil_itx_count
;
401 * See the documentation for itx_wr_state_t above.
402 * Note that "bytes" accumulates the length of the transactions
403 * (i.e. data), not the actual log record sizes.
405 kstat_named_t zil_itx_indirect_count
;
406 kstat_named_t zil_itx_indirect_bytes
;
407 kstat_named_t zil_itx_copied_count
;
408 kstat_named_t zil_itx_copied_bytes
;
409 kstat_named_t zil_itx_needcopy_count
;
410 kstat_named_t zil_itx_needcopy_bytes
;
413 * Transactions which have been allocated to the "normal"
414 * (i.e. not slog) storage pool. Note that "bytes" accumulate
415 * the actual log record sizes - which do not include the actual
416 * data in case of indirect writes.
418 kstat_named_t zil_itx_metaslab_normal_count
;
419 kstat_named_t zil_itx_metaslab_normal_bytes
;
422 * Transactions which have been allocated to the "slog" storage pool.
423 * If there are no separate log devices, this is the same as the
426 kstat_named_t zil_itx_metaslab_slog_count
;
427 kstat_named_t zil_itx_metaslab_slog_bytes
;
430 extern zil_stats_t zil_stats
;
432 #define ZIL_STAT_INCR(stat, val) \
433 atomic_add_64(&zil_stats.stat.value.ui64, (val));
434 #define ZIL_STAT_BUMP(stat) \
435 ZIL_STAT_INCR(stat, 1);
437 typedef int zil_parse_blk_func_t(zilog_t
*zilog
, blkptr_t
*bp
, void *arg
,
439 typedef int zil_parse_lr_func_t(zilog_t
*zilog
, lr_t
*lr
, void *arg
,
441 typedef int (*const zil_replay_func_t
)(void *, char *, boolean_t
);
442 typedef int zil_get_data_t(void *arg
, lr_write_t
*lr
, char *dbuf
, zio_t
*zio
);
444 extern int zil_parse(zilog_t
*zilog
, zil_parse_blk_func_t
*parse_blk_func
,
445 zil_parse_lr_func_t
*parse_lr_func
, void *arg
, uint64_t txg
);
447 extern void zil_init(void);
448 extern void zil_fini(void);
450 extern zilog_t
*zil_alloc(objset_t
*os
, zil_header_t
*zh_phys
);
451 extern void zil_free(zilog_t
*zilog
);
453 extern zilog_t
*zil_open(objset_t
*os
, zil_get_data_t
*get_data
);
454 extern void zil_close(zilog_t
*zilog
);
456 extern void zil_replay(objset_t
*os
, void *arg
,
457 zil_replay_func_t replay_func
[TX_MAX_TYPE
]);
458 extern boolean_t
zil_replaying(zilog_t
*zilog
, dmu_tx_t
*tx
);
459 extern void zil_destroy(zilog_t
*zilog
, boolean_t keep_first
);
460 extern void zil_destroy_sync(zilog_t
*zilog
, dmu_tx_t
*tx
);
462 extern itx_t
*zil_itx_create(uint64_t txtype
, size_t lrsize
);
463 extern void zil_itx_destroy(itx_t
*itx
);
464 extern void zil_itx_assign(zilog_t
*zilog
, itx_t
*itx
, dmu_tx_t
*tx
);
466 extern void zil_commit(zilog_t
*zilog
, uint64_t oid
);
468 extern int zil_vdev_offline(const char *osname
, void *txarg
);
469 extern int zil_claim(const char *osname
, void *txarg
);
470 extern int zil_check_log_chain(const char *osname
, void *txarg
);
471 extern void zil_sync(zilog_t
*zilog
, dmu_tx_t
*tx
);
472 extern void zil_clean(zilog_t
*zilog
, uint64_t synced_txg
);
474 extern int zil_suspend(const char *osname
, void **cookiep
);
475 extern void zil_resume(void *cookie
);
477 extern void zil_add_block(zilog_t
*zilog
, const blkptr_t
*bp
);
478 extern int zil_bp_tree_add(zilog_t
*zilog
, const blkptr_t
*bp
);
480 extern void zil_set_sync(zilog_t
*zilog
, uint64_t syncval
);
482 extern void zil_set_logbias(zilog_t
*zilog
, uint64_t slogval
);
484 extern int zil_replay_disable
;
490 #endif /* _SYS_ZIL_H */