xref: /illumos-gate/usr/src/uts/common/fs/zfs/zil.c (revision 9edfe05d4409cbacbb3b06ebbb1fa8dd497745b0)
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) 2011, 2018 by Delphix. All rights reserved.
24  * Copyright (c) 2014 Integros [integros.com]
25  */
26 
27 /* Portions Copyright 2010 Robert Milkowski */
28 
29 #include <sys/zfs_context.h>
30 #include <sys/spa.h>
31 #include <sys/spa_impl.h>
32 #include <sys/dmu.h>
33 #include <sys/zap.h>
34 #include <sys/arc.h>
35 #include <sys/stat.h>
36 #include <sys/resource.h>
37 #include <sys/zil.h>
38 #include <sys/zil_impl.h>
39 #include <sys/dsl_dataset.h>
40 #include <sys/vdev_impl.h>
41 #include <sys/dmu_tx.h>
42 #include <sys/dsl_pool.h>
43 #include <sys/abd.h>
44 
45 /*
46  * The ZFS Intent Log (ZIL) saves "transaction records" (itxs) of system
47  * calls that change the file system. Each itx has enough information to
48  * be able to replay them after a system crash, power loss, or
49  * equivalent failure mode. These are stored in memory until either:
50  *
51  *   1. they are committed to the pool by the DMU transaction group
52  *      (txg), at which point they can be discarded; or
53  *   2. they are committed to the on-disk ZIL for the dataset being
54  *      modified (e.g. due to an fsync, O_DSYNC, or other synchronous
55  *      requirement).
56  *
57  * In the event of a crash or power loss, the itxs contained by each
58  * dataset's on-disk ZIL will be replayed when that dataset is first
59  * instantianted (e.g. if the dataset is a normal fileystem, when it is
60  * first mounted).
61  *
62  * As hinted at above, there is one ZIL per dataset (both the in-memory
63  * representation, and the on-disk representation). The on-disk format
64  * consists of 3 parts:
65  *
66  *	- a single, per-dataset, ZIL header; which points to a chain of
67  *	- zero or more ZIL blocks; each of which contains
68  *	- zero or more ZIL records
69  *
70  * A ZIL record holds the information necessary to replay a single
71  * system call transaction. A ZIL block can hold many ZIL records, and
72  * the blocks are chained together, similarly to a singly linked list.
73  *
74  * Each ZIL block contains a block pointer (blkptr_t) to the next ZIL
75  * block in the chain, and the ZIL header points to the first block in
76  * the chain.
77  *
78  * Note, there is not a fixed place in the pool to hold these ZIL
79  * blocks; they are dynamically allocated and freed as needed from the
80  * blocks available on the pool, though they can be preferentially
81  * allocated from a dedicated "log" vdev.
82  */
83 
84 /*
85  * This controls the amount of time that a ZIL block (lwb) will remain
86  * "open" when it isn't "full", and it has a thread waiting for it to be
87  * committed to stable storage. Please refer to the zil_commit_waiter()
88  * function (and the comments within it) for more details.
89  */
90 int zfs_commit_timeout_pct = 5;
91 
92 /*
93  * Disable intent logging replay.  This global ZIL switch affects all pools.
94  */
95 int zil_replay_disable = 0;
96 
97 /*
98  * Disable the DKIOCFLUSHWRITECACHE commands that are normally sent to
99  * the disk(s) by the ZIL after an LWB write has completed. Setting this
100  * will cause ZIL corruption on power loss if a volatile out-of-order
101  * write cache is enabled.
102  */
103 boolean_t zil_nocacheflush = B_FALSE;
104 
105 /*
106  * Limit SLOG write size per commit executed with synchronous priority.
107  * Any writes above that will be executed with lower (asynchronous) priority
108  * to limit potential SLOG device abuse by single active ZIL writer.
109  */
110 uint64_t zil_slog_bulk = 768 * 1024;
111 
112 static kmem_cache_t *zil_lwb_cache;
113 static kmem_cache_t *zil_zcw_cache;
114 
115 #define	LWB_EMPTY(lwb) ((BP_GET_LSIZE(&lwb->lwb_blk) - \
116     sizeof (zil_chain_t)) == (lwb->lwb_sz - lwb->lwb_nused))
117 
118 static int
zil_bp_compare(const void * x1,const void * x2)119 zil_bp_compare(const void *x1, const void *x2)
120 {
121 	const dva_t *dva1 = &((zil_bp_node_t *)x1)->zn_dva;
122 	const dva_t *dva2 = &((zil_bp_node_t *)x2)->zn_dva;
123 
124 	int cmp = TREE_CMP(DVA_GET_VDEV(dva1), DVA_GET_VDEV(dva2));
125 	if (likely(cmp))
126 		return (cmp);
127 
128 	return (TREE_CMP(DVA_GET_OFFSET(dva1), DVA_GET_OFFSET(dva2)));
129 }
130 
131 static void
zil_bp_tree_init(zilog_t * zilog)132 zil_bp_tree_init(zilog_t *zilog)
133 {
134 	avl_create(&zilog->zl_bp_tree, zil_bp_compare,
135 	    sizeof (zil_bp_node_t), offsetof(zil_bp_node_t, zn_node));
136 }
137 
138 static void
zil_bp_tree_fini(zilog_t * zilog)139 zil_bp_tree_fini(zilog_t *zilog)
140 {
141 	avl_tree_t *t = &zilog->zl_bp_tree;
142 	zil_bp_node_t *zn;
143 	void *cookie = NULL;
144 
145 	while ((zn = avl_destroy_nodes(t, &cookie)) != NULL)
146 		kmem_free(zn, sizeof (zil_bp_node_t));
147 
148 	avl_destroy(t);
149 }
150 
151 int
zil_bp_tree_add(zilog_t * zilog,const blkptr_t * bp)152 zil_bp_tree_add(zilog_t *zilog, const blkptr_t *bp)
153 {
154 	avl_tree_t *t = &zilog->zl_bp_tree;
155 	const dva_t *dva;
156 	zil_bp_node_t *zn;
157 	avl_index_t where;
158 
159 	if (BP_IS_EMBEDDED(bp))
160 		return (0);
161 
162 	dva = BP_IDENTITY(bp);
163 
164 	if (avl_find(t, dva, &where) != NULL)
165 		return (SET_ERROR(EEXIST));
166 
167 	zn = kmem_alloc(sizeof (zil_bp_node_t), KM_SLEEP);
168 	zn->zn_dva = *dva;
169 	avl_insert(t, zn, where);
170 
171 	return (0);
172 }
173 
174 static zil_header_t *
zil_header_in_syncing_context(zilog_t * zilog)175 zil_header_in_syncing_context(zilog_t *zilog)
176 {
177 	return ((zil_header_t *)zilog->zl_header);
178 }
179 
180 static void
zil_init_log_chain(zilog_t * zilog,blkptr_t * bp)181 zil_init_log_chain(zilog_t *zilog, blkptr_t *bp)
182 {
183 	zio_cksum_t *zc = &bp->blk_cksum;
184 
185 	zc->zc_word[ZIL_ZC_GUID_0] = spa_get_random(-1ULL);
186 	zc->zc_word[ZIL_ZC_GUID_1] = spa_get_random(-1ULL);
187 	zc->zc_word[ZIL_ZC_OBJSET] = dmu_objset_id(zilog->zl_os);
188 	zc->zc_word[ZIL_ZC_SEQ] = 1ULL;
189 }
190 
191 /*
192  * Read a log block and make sure it's valid.
193  */
194 static int
zil_read_log_block(zilog_t * zilog,boolean_t decrypt,const blkptr_t * bp,blkptr_t * nbp,void * dst,char ** end)195 zil_read_log_block(zilog_t *zilog, boolean_t decrypt, const blkptr_t *bp,
196     blkptr_t *nbp, void *dst, char **end)
197 {
198 	enum zio_flag zio_flags = ZIO_FLAG_CANFAIL;
199 	arc_flags_t aflags = ARC_FLAG_WAIT;
200 	arc_buf_t *abuf = NULL;
201 	zbookmark_phys_t zb;
202 	int error;
203 
204 	if (zilog->zl_header->zh_claim_txg == 0)
205 		zio_flags |= ZIO_FLAG_SPECULATIVE | ZIO_FLAG_SCRUB;
206 
207 	if (!(zilog->zl_header->zh_flags & ZIL_CLAIM_LR_SEQ_VALID))
208 		zio_flags |= ZIO_FLAG_SPECULATIVE;
209 
210 	if (!decrypt)
211 		zio_flags |= ZIO_FLAG_RAW;
212 
213 	SET_BOOKMARK(&zb, bp->blk_cksum.zc_word[ZIL_ZC_OBJSET],
214 	    ZB_ZIL_OBJECT, ZB_ZIL_LEVEL, bp->blk_cksum.zc_word[ZIL_ZC_SEQ]);
215 
216 	error = arc_read(NULL, zilog->zl_spa, bp, arc_getbuf_func,
217 	    &abuf, ZIO_PRIORITY_SYNC_READ, zio_flags, &aflags, &zb);
218 
219 	if (error == 0) {
220 		zio_cksum_t cksum = bp->blk_cksum;
221 
222 		/*
223 		 * Validate the checksummed log block.
224 		 *
225 		 * Sequence numbers should be... sequential.  The checksum
226 		 * verifier for the next block should be bp's checksum plus 1.
227 		 *
228 		 * Also check the log chain linkage and size used.
229 		 */
230 		cksum.zc_word[ZIL_ZC_SEQ]++;
231 
232 		if (BP_GET_CHECKSUM(bp) == ZIO_CHECKSUM_ZILOG2) {
233 			zil_chain_t *zilc = abuf->b_data;
234 			char *lr = (char *)(zilc + 1);
235 			uint64_t len = zilc->zc_nused - sizeof (zil_chain_t);
236 
237 			if (bcmp(&cksum, &zilc->zc_next_blk.blk_cksum,
238 			    sizeof (cksum)) || BP_IS_HOLE(&zilc->zc_next_blk)) {
239 				error = SET_ERROR(ECKSUM);
240 			} else {
241 				ASSERT3U(len, <=, SPA_OLD_MAXBLOCKSIZE);
242 				bcopy(lr, dst, len);
243 				*end = (char *)dst + len;
244 				*nbp = zilc->zc_next_blk;
245 			}
246 		} else {
247 			char *lr = abuf->b_data;
248 			uint64_t size = BP_GET_LSIZE(bp);
249 			zil_chain_t *zilc = (zil_chain_t *)(lr + size) - 1;
250 
251 			if (bcmp(&cksum, &zilc->zc_next_blk.blk_cksum,
252 			    sizeof (cksum)) || BP_IS_HOLE(&zilc->zc_next_blk) ||
253 			    (zilc->zc_nused > (size - sizeof (*zilc)))) {
254 				error = SET_ERROR(ECKSUM);
255 			} else {
256 				ASSERT3U(zilc->zc_nused, <=,
257 				    SPA_OLD_MAXBLOCKSIZE);
258 				bcopy(lr, dst, zilc->zc_nused);
259 				*end = (char *)dst + zilc->zc_nused;
260 				*nbp = zilc->zc_next_blk;
261 			}
262 		}
263 
264 		arc_buf_destroy(abuf, &abuf);
265 	}
266 
267 	return (error);
268 }
269 
270 /*
271  * Read a TX_WRITE log data block.
272  */
273 static int
zil_read_log_data(zilog_t * zilog,const lr_write_t * lr,void * wbuf)274 zil_read_log_data(zilog_t *zilog, const lr_write_t *lr, void *wbuf)
275 {
276 	enum zio_flag zio_flags = ZIO_FLAG_CANFAIL;
277 	const blkptr_t *bp = &lr->lr_blkptr;
278 	arc_flags_t aflags = ARC_FLAG_WAIT;
279 	arc_buf_t *abuf = NULL;
280 	zbookmark_phys_t zb;
281 	int error;
282 
283 	if (BP_IS_HOLE(bp)) {
284 		if (wbuf != NULL)
285 			bzero(wbuf, MAX(BP_GET_LSIZE(bp), lr->lr_length));
286 		return (0);
287 	}
288 
289 	if (zilog->zl_header->zh_claim_txg == 0)
290 		zio_flags |= ZIO_FLAG_SPECULATIVE | ZIO_FLAG_SCRUB;
291 
292 	/*
293 	 * If we are not using the resulting data, we are just checking that
294 	 * it hasn't been corrupted so we don't need to waste CPU time
295 	 * decompressing and decrypting it.
296 	 */
297 	if (wbuf == NULL)
298 		zio_flags |= ZIO_FLAG_RAW;
299 
300 	SET_BOOKMARK(&zb, dmu_objset_id(zilog->zl_os), lr->lr_foid,
301 	    ZB_ZIL_LEVEL, lr->lr_offset / BP_GET_LSIZE(bp));
302 
303 	error = arc_read(NULL, zilog->zl_spa, bp, arc_getbuf_func, &abuf,
304 	    ZIO_PRIORITY_SYNC_READ, zio_flags, &aflags, &zb);
305 
306 	if (error == 0) {
307 		if (wbuf != NULL)
308 			bcopy(abuf->b_data, wbuf, arc_buf_size(abuf));
309 		arc_buf_destroy(abuf, &abuf);
310 	}
311 
312 	return (error);
313 }
314 
315 /*
316  * Parse the intent log, and call parse_func for each valid record within.
317  */
318 int
zil_parse(zilog_t * zilog,zil_parse_blk_func_t * parse_blk_func,zil_parse_lr_func_t * parse_lr_func,void * arg,uint64_t txg,boolean_t decrypt)319 zil_parse(zilog_t *zilog, zil_parse_blk_func_t *parse_blk_func,
320     zil_parse_lr_func_t *parse_lr_func, void *arg, uint64_t txg,
321     boolean_t decrypt)
322 {
323 	const zil_header_t *zh = zilog->zl_header;
324 	boolean_t claimed = !!zh->zh_claim_txg;
325 	uint64_t claim_blk_seq = claimed ? zh->zh_claim_blk_seq : UINT64_MAX;
326 	uint64_t claim_lr_seq = claimed ? zh->zh_claim_lr_seq : UINT64_MAX;
327 	uint64_t max_blk_seq = 0;
328 	uint64_t max_lr_seq = 0;
329 	uint64_t blk_count = 0;
330 	uint64_t lr_count = 0;
331 	blkptr_t blk, next_blk;
332 	char *lrbuf, *lrp;
333 	int error = 0;
334 
335 	/*
336 	 * Old logs didn't record the maximum zh_claim_lr_seq.
337 	 */
338 	if (!(zh->zh_flags & ZIL_CLAIM_LR_SEQ_VALID))
339 		claim_lr_seq = UINT64_MAX;
340 
341 	/*
342 	 * Starting at the block pointed to by zh_log we read the log chain.
343 	 * For each block in the chain we strongly check that block to
344 	 * ensure its validity.  We stop when an invalid block is found.
345 	 * For each block pointer in the chain we call parse_blk_func().
346 	 * For each record in each valid block we call parse_lr_func().
347 	 * If the log has been claimed, stop if we encounter a sequence
348 	 * number greater than the highest claimed sequence number.
349 	 */
350 	lrbuf = zio_buf_alloc(SPA_OLD_MAXBLOCKSIZE);
351 	zil_bp_tree_init(zilog);
352 
353 	for (blk = zh->zh_log; !BP_IS_HOLE(&blk); blk = next_blk) {
354 		uint64_t blk_seq = blk.blk_cksum.zc_word[ZIL_ZC_SEQ];
355 		int reclen;
356 		char *end;
357 
358 		if (blk_seq > claim_blk_seq)
359 			break;
360 
361 		error = parse_blk_func(zilog, &blk, arg, txg);
362 		if (error != 0)
363 			break;
364 		ASSERT3U(max_blk_seq, <, blk_seq);
365 		max_blk_seq = blk_seq;
366 		blk_count++;
367 
368 		if (max_lr_seq == claim_lr_seq && max_blk_seq == claim_blk_seq)
369 			break;
370 
371 		error = zil_read_log_block(zilog, decrypt, &blk, &next_blk,
372 		    lrbuf, &end);
373 		if (error != 0)
374 			break;
375 
376 		for (lrp = lrbuf; lrp < end; lrp += reclen) {
377 			lr_t *lr = (lr_t *)lrp;
378 			reclen = lr->lrc_reclen;
379 			ASSERT3U(reclen, >=, sizeof (lr_t));
380 			if (lr->lrc_seq > claim_lr_seq)
381 				goto done;
382 
383 			error = parse_lr_func(zilog, lr, arg, txg);
384 			if (error != 0)
385 				goto done;
386 			ASSERT3U(max_lr_seq, <, lr->lrc_seq);
387 			max_lr_seq = lr->lrc_seq;
388 			lr_count++;
389 		}
390 	}
391 done:
392 	zilog->zl_parse_error = error;
393 	zilog->zl_parse_blk_seq = max_blk_seq;
394 	zilog->zl_parse_lr_seq = max_lr_seq;
395 	zilog->zl_parse_blk_count = blk_count;
396 	zilog->zl_parse_lr_count = lr_count;
397 
398 	ASSERT(!claimed || !(zh->zh_flags & ZIL_CLAIM_LR_SEQ_VALID) ||
399 	    (max_blk_seq == claim_blk_seq && max_lr_seq == claim_lr_seq) ||
400 	    (decrypt && error == EIO));
401 
402 	zil_bp_tree_fini(zilog);
403 	zio_buf_free(lrbuf, SPA_OLD_MAXBLOCKSIZE);
404 
405 	return (error);
406 }
407 
408 /* ARGSUSED */
409 static int
zil_clear_log_block(zilog_t * zilog,blkptr_t * bp,void * tx,uint64_t first_txg)410 zil_clear_log_block(zilog_t *zilog, blkptr_t *bp, void *tx, uint64_t first_txg)
411 {
412 	ASSERT(!BP_IS_HOLE(bp));
413 
414 	/*
415 	 * As we call this function from the context of a rewind to a
416 	 * checkpoint, each ZIL block whose txg is later than the txg
417 	 * that we rewind to is invalid. Thus, we return -1 so
418 	 * zil_parse() doesn't attempt to read it.
419 	 */
420 	if (bp->blk_birth >= first_txg)
421 		return (-1);
422 
423 	if (zil_bp_tree_add(zilog, bp) != 0)
424 		return (0);
425 
426 	zio_free(zilog->zl_spa, first_txg, bp);
427 	return (0);
428 }
429 
430 /* ARGSUSED */
431 static int
zil_noop_log_record(zilog_t * zilog,lr_t * lrc,void * tx,uint64_t first_txg)432 zil_noop_log_record(zilog_t *zilog, lr_t *lrc, void *tx, uint64_t first_txg)
433 {
434 	return (0);
435 }
436 
437 static int
zil_claim_log_block(zilog_t * zilog,blkptr_t * bp,void * tx,uint64_t first_txg)438 zil_claim_log_block(zilog_t *zilog, blkptr_t *bp, void *tx, uint64_t first_txg)
439 {
440 	/*
441 	 * Claim log block if not already committed and not already claimed.
442 	 * If tx == NULL, just verify that the block is claimable.
443 	 */
444 	if (BP_IS_HOLE(bp) || bp->blk_birth < first_txg ||
445 	    zil_bp_tree_add(zilog, bp) != 0)
446 		return (0);
447 
448 	return (zio_wait(zio_claim(NULL, zilog->zl_spa,
449 	    tx == NULL ? 0 : first_txg, bp, spa_claim_notify, NULL,
450 	    ZIO_FLAG_CANFAIL | ZIO_FLAG_SPECULATIVE | ZIO_FLAG_SCRUB)));
451 }
452 
453 static int
zil_claim_log_record(zilog_t * zilog,lr_t * lrc,void * tx,uint64_t first_txg)454 zil_claim_log_record(zilog_t *zilog, lr_t *lrc, void *tx, uint64_t first_txg)
455 {
456 	lr_write_t *lr = (lr_write_t *)lrc;
457 	int error;
458 
459 	if (lrc->lrc_txtype != TX_WRITE)
460 		return (0);
461 
462 	/*
463 	 * If the block is not readable, don't claim it.  This can happen
464 	 * in normal operation when a log block is written to disk before
465 	 * some of the dmu_sync() blocks it points to.  In this case, the
466 	 * transaction cannot have been committed to anyone (we would have
467 	 * waited for all writes to be stable first), so it is semantically
468 	 * correct to declare this the end of the log.
469 	 */
470 	if (lr->lr_blkptr.blk_birth >= first_txg) {
471 		error = zil_read_log_data(zilog, lr, NULL);
472 		if (error != 0)
473 			return (error);
474 	}
475 
476 	return (zil_claim_log_block(zilog, &lr->lr_blkptr, tx, first_txg));
477 }
478 
479 /* ARGSUSED */
480 static int
zil_free_log_block(zilog_t * zilog,blkptr_t * bp,void * tx,uint64_t claim_txg)481 zil_free_log_block(zilog_t *zilog, blkptr_t *bp, void *tx, uint64_t claim_txg)
482 {
483 	zio_free(zilog->zl_spa, dmu_tx_get_txg(tx), bp);
484 
485 	return (0);
486 }
487 
488 static int
zil_free_log_record(zilog_t * zilog,lr_t * lrc,void * tx,uint64_t claim_txg)489 zil_free_log_record(zilog_t *zilog, lr_t *lrc, void *tx, uint64_t claim_txg)
490 {
491 	lr_write_t *lr = (lr_write_t *)lrc;
492 	blkptr_t *bp = &lr->lr_blkptr;
493 
494 	/*
495 	 * If we previously claimed it, we need to free it.
496 	 */
497 	if (claim_txg != 0 && lrc->lrc_txtype == TX_WRITE &&
498 	    bp->blk_birth >= claim_txg && zil_bp_tree_add(zilog, bp) == 0 &&
499 	    !BP_IS_HOLE(bp))
500 		zio_free(zilog->zl_spa, dmu_tx_get_txg(tx), bp);
501 
502 	return (0);
503 }
504 
505 static int
zil_lwb_vdev_compare(const void * x1,const void * x2)506 zil_lwb_vdev_compare(const void *x1, const void *x2)
507 {
508 	const uint64_t v1 = ((zil_vdev_node_t *)x1)->zv_vdev;
509 	const uint64_t v2 = ((zil_vdev_node_t *)x2)->zv_vdev;
510 
511 	return (TREE_CMP(v1, v2));
512 }
513 
514 static lwb_t *
zil_alloc_lwb(zilog_t * zilog,blkptr_t * bp,boolean_t slog,uint64_t txg)515 zil_alloc_lwb(zilog_t *zilog, blkptr_t *bp, boolean_t slog, uint64_t txg)
516 {
517 	lwb_t *lwb;
518 
519 	lwb = kmem_cache_alloc(zil_lwb_cache, KM_SLEEP);
520 	lwb->lwb_zilog = zilog;
521 	lwb->lwb_blk = *bp;
522 	lwb->lwb_slog = slog;
523 	lwb->lwb_state = LWB_STATE_CLOSED;
524 	lwb->lwb_buf = zio_buf_alloc(BP_GET_LSIZE(bp));
525 	lwb->lwb_max_txg = txg;
526 	lwb->lwb_write_zio = NULL;
527 	lwb->lwb_root_zio = NULL;
528 	lwb->lwb_tx = NULL;
529 	lwb->lwb_issued_timestamp = 0;
530 	if (BP_GET_CHECKSUM(bp) == ZIO_CHECKSUM_ZILOG2) {
531 		lwb->lwb_nused = sizeof (zil_chain_t);
532 		lwb->lwb_sz = BP_GET_LSIZE(bp);
533 	} else {
534 		lwb->lwb_nused = 0;
535 		lwb->lwb_sz = BP_GET_LSIZE(bp) - sizeof (zil_chain_t);
536 	}
537 
538 	mutex_enter(&zilog->zl_lock);
539 	list_insert_tail(&zilog->zl_lwb_list, lwb);
540 	mutex_exit(&zilog->zl_lock);
541 
542 	ASSERT(!MUTEX_HELD(&lwb->lwb_vdev_lock));
543 	ASSERT(avl_is_empty(&lwb->lwb_vdev_tree));
544 	VERIFY(list_is_empty(&lwb->lwb_waiters));
545 
546 	return (lwb);
547 }
548 
549 static void
zil_free_lwb(zilog_t * zilog,lwb_t * lwb)550 zil_free_lwb(zilog_t *zilog, lwb_t *lwb)
551 {
552 	ASSERT(MUTEX_HELD(&zilog->zl_lock));
553 	ASSERT(!MUTEX_HELD(&lwb->lwb_vdev_lock));
554 	VERIFY(list_is_empty(&lwb->lwb_waiters));
555 	ASSERT(avl_is_empty(&lwb->lwb_vdev_tree));
556 	ASSERT3P(lwb->lwb_write_zio, ==, NULL);
557 	ASSERT3P(lwb->lwb_root_zio, ==, NULL);
558 	ASSERT3U(lwb->lwb_max_txg, <=, spa_syncing_txg(zilog->zl_spa));
559 	ASSERT(lwb->lwb_state == LWB_STATE_CLOSED ||
560 	    lwb->lwb_state == LWB_STATE_FLUSH_DONE);
561 
562 	/*
563 	 * Clear the zilog's field to indicate this lwb is no longer
564 	 * valid, and prevent use-after-free errors.
565 	 */
566 	if (zilog->zl_last_lwb_opened == lwb)
567 		zilog->zl_last_lwb_opened = NULL;
568 
569 	kmem_cache_free(zil_lwb_cache, lwb);
570 }
571 
572 /*
573  * Called when we create in-memory log transactions so that we know
574  * to cleanup the itxs at the end of spa_sync().
575  */
576 void
zilog_dirty(zilog_t * zilog,uint64_t txg)577 zilog_dirty(zilog_t *zilog, uint64_t txg)
578 {
579 	dsl_pool_t *dp = zilog->zl_dmu_pool;
580 	dsl_dataset_t *ds = dmu_objset_ds(zilog->zl_os);
581 
582 	ASSERT(spa_writeable(zilog->zl_spa));
583 
584 	if (ds->ds_is_snapshot)
585 		panic("dirtying snapshot!");
586 
587 	if (txg_list_add(&dp->dp_dirty_zilogs, zilog, txg)) {
588 		/* up the hold count until we can be written out */
589 		dmu_buf_add_ref(ds->ds_dbuf, zilog);
590 
591 		zilog->zl_dirty_max_txg = MAX(txg, zilog->zl_dirty_max_txg);
592 	}
593 }
594 
595 /*
596  * Determine if the zil is dirty in the specified txg. Callers wanting to
597  * ensure that the dirty state does not change must hold the itxg_lock for
598  * the specified txg. Holding the lock will ensure that the zil cannot be
599  * dirtied (zil_itx_assign) or cleaned (zil_clean) while we check its current
600  * state.
601  */
602 boolean_t
zilog_is_dirty_in_txg(zilog_t * zilog,uint64_t txg)603 zilog_is_dirty_in_txg(zilog_t *zilog, uint64_t txg)
604 {
605 	dsl_pool_t *dp = zilog->zl_dmu_pool;
606 
607 	if (txg_list_member(&dp->dp_dirty_zilogs, zilog, txg & TXG_MASK))
608 		return (B_TRUE);
609 	return (B_FALSE);
610 }
611 
612 /*
613  * Determine if the zil is dirty. The zil is considered dirty if it has
614  * any pending itx records that have not been cleaned by zil_clean().
615  */
616 boolean_t
zilog_is_dirty(zilog_t * zilog)617 zilog_is_dirty(zilog_t *zilog)
618 {
619 	dsl_pool_t *dp = zilog->zl_dmu_pool;
620 
621 	for (int t = 0; t < TXG_SIZE; t++) {
622 		if (txg_list_member(&dp->dp_dirty_zilogs, zilog, t))
623 			return (B_TRUE);
624 	}
625 	return (B_FALSE);
626 }
627 
628 /*
629  * Create an on-disk intent log.
630  */
631 static lwb_t *
zil_create(zilog_t * zilog)632 zil_create(zilog_t *zilog)
633 {
634 	const zil_header_t *zh = zilog->zl_header;
635 	lwb_t *lwb = NULL;
636 	uint64_t txg = 0;
637 	dmu_tx_t *tx = NULL;
638 	blkptr_t blk;
639 	int error = 0;
640 	boolean_t slog = FALSE;
641 
642 	/*
643 	 * Wait for any previous destroy to complete.
644 	 */
645 	txg_wait_synced(zilog->zl_dmu_pool, zilog->zl_destroy_txg);
646 
647 	ASSERT(zh->zh_claim_txg == 0);
648 	ASSERT(zh->zh_replay_seq == 0);
649 
650 	blk = zh->zh_log;
651 
652 	/*
653 	 * Allocate an initial log block if:
654 	 *    - there isn't one already
655 	 *    - the existing block is the wrong endianess
656 	 */
657 	if (BP_IS_HOLE(&blk) || BP_SHOULD_BYTESWAP(&blk)) {
658 		tx = dmu_tx_create(zilog->zl_os);
659 		VERIFY0(dmu_tx_assign(tx, TXG_WAIT));
660 		dsl_dataset_dirty(dmu_objset_ds(zilog->zl_os), tx);
661 		txg = dmu_tx_get_txg(tx);
662 
663 		if (!BP_IS_HOLE(&blk)) {
664 			zio_free(zilog->zl_spa, txg, &blk);
665 			BP_ZERO(&blk);
666 		}
667 
668 		error = zio_alloc_zil(zilog->zl_spa, zilog->zl_os, txg, &blk,
669 		    NULL, ZIL_MIN_BLKSZ, &slog);
670 
671 		if (error == 0)
672 			zil_init_log_chain(zilog, &blk);
673 	}
674 
675 	/*
676 	 * Allocate a log write block (lwb) for the first log block.
677 	 */
678 	if (error == 0)
679 		lwb = zil_alloc_lwb(zilog, &blk, slog, txg);
680 
681 	/*
682 	 * If we just allocated the first log block, commit our transaction
683 	 * and wait for zil_sync() to stuff the block poiner into zh_log.
684 	 * (zh is part of the MOS, so we cannot modify it in open context.)
685 	 */
686 	if (tx != NULL) {
687 		dmu_tx_commit(tx);
688 		txg_wait_synced(zilog->zl_dmu_pool, txg);
689 	}
690 
691 	ASSERT(error != 0 || bcmp(&blk, &zh->zh_log, sizeof (blk)) == 0);
692 	IMPLY(error == 0, lwb != NULL);
693 
694 	return (lwb);
695 }
696 
697 /*
698  * In one tx, free all log blocks and clear the log header. If keep_first
699  * is set, then we're replaying a log with no content. We want to keep the
700  * first block, however, so that the first synchronous transaction doesn't
701  * require a txg_wait_synced() in zil_create(). We don't need to
702  * txg_wait_synced() here either when keep_first is set, because both
703  * zil_create() and zil_destroy() will wait for any in-progress destroys
704  * to complete.
705  */
706 void
zil_destroy(zilog_t * zilog,boolean_t keep_first)707 zil_destroy(zilog_t *zilog, boolean_t keep_first)
708 {
709 	const zil_header_t *zh = zilog->zl_header;
710 	lwb_t *lwb;
711 	dmu_tx_t *tx;
712 	uint64_t txg;
713 
714 	/*
715 	 * Wait for any previous destroy to complete.
716 	 */
717 	txg_wait_synced(zilog->zl_dmu_pool, zilog->zl_destroy_txg);
718 
719 	zilog->zl_old_header = *zh;		/* debugging aid */
720 
721 	if (BP_IS_HOLE(&zh->zh_log))
722 		return;
723 
724 	tx = dmu_tx_create(zilog->zl_os);
725 	VERIFY0(dmu_tx_assign(tx, TXG_WAIT));
726 	dsl_dataset_dirty(dmu_objset_ds(zilog->zl_os), tx);
727 	txg = dmu_tx_get_txg(tx);
728 
729 	mutex_enter(&zilog->zl_lock);
730 
731 	ASSERT3U(zilog->zl_destroy_txg, <, txg);
732 	zilog->zl_destroy_txg = txg;
733 	zilog->zl_keep_first = keep_first;
734 
735 	if (!list_is_empty(&zilog->zl_lwb_list)) {
736 		ASSERT(zh->zh_claim_txg == 0);
737 		VERIFY(!keep_first);
738 		while ((lwb = list_head(&zilog->zl_lwb_list)) != NULL) {
739 			list_remove(&zilog->zl_lwb_list, lwb);
740 			if (lwb->lwb_buf != NULL)
741 				zio_buf_free(lwb->lwb_buf, lwb->lwb_sz);
742 			zio_free(zilog->zl_spa, txg, &lwb->lwb_blk);
743 			zil_free_lwb(zilog, lwb);
744 		}
745 	} else if (!keep_first) {
746 		zil_destroy_sync(zilog, tx);
747 	}
748 	mutex_exit(&zilog->zl_lock);
749 
750 	dmu_tx_commit(tx);
751 }
752 
753 void
zil_destroy_sync(zilog_t * zilog,dmu_tx_t * tx)754 zil_destroy_sync(zilog_t *zilog, dmu_tx_t *tx)
755 {
756 	ASSERT(list_is_empty(&zilog->zl_lwb_list));
757 	(void) zil_parse(zilog, zil_free_log_block,
758 	    zil_free_log_record, tx, zilog->zl_header->zh_claim_txg, B_FALSE);
759 }
760 
761 int
zil_claim(dsl_pool_t * dp,dsl_dataset_t * ds,void * txarg)762 zil_claim(dsl_pool_t *dp, dsl_dataset_t *ds, void *txarg)
763 {
764 	dmu_tx_t *tx = txarg;
765 	zilog_t *zilog;
766 	uint64_t first_txg;
767 	zil_header_t *zh;
768 	objset_t *os;
769 	int error;
770 
771 	error = dmu_objset_own_obj(dp, ds->ds_object,
772 	    DMU_OST_ANY, B_FALSE, B_FALSE, FTAG, &os);
773 	if (error != 0) {
774 		/*
775 		 * EBUSY indicates that the objset is inconsistent, in which
776 		 * case it can not have a ZIL.
777 		 */
778 		if (error != EBUSY) {
779 			cmn_err(CE_WARN, "can't open objset for %llu, error %u",
780 			    (unsigned long long)ds->ds_object, error);
781 		}
782 		return (0);
783 	}
784 
785 	zilog = dmu_objset_zil(os);
786 	zh = zil_header_in_syncing_context(zilog);
787 	ASSERT3U(tx->tx_txg, ==, spa_first_txg(zilog->zl_spa));
788 	first_txg = spa_min_claim_txg(zilog->zl_spa);
789 
790 	/*
791 	 * If the spa_log_state is not set to be cleared, check whether
792 	 * the current uberblock is a checkpoint one and if the current
793 	 * header has been claimed before moving on.
794 	 *
795 	 * If the current uberblock is a checkpointed uberblock then
796 	 * one of the following scenarios took place:
797 	 *
798 	 * 1] We are currently rewinding to the checkpoint of the pool.
799 	 * 2] We crashed in the middle of a checkpoint rewind but we
800 	 *    did manage to write the checkpointed uberblock to the
801 	 *    vdev labels, so when we tried to import the pool again
802 	 *    the checkpointed uberblock was selected from the import
803 	 *    procedure.
804 	 *
805 	 * In both cases we want to zero out all the ZIL blocks, except
806 	 * the ones that have been claimed at the time of the checkpoint
807 	 * (their zh_claim_txg != 0). The reason is that these blocks
808 	 * may be corrupted since we may have reused their locations on
809 	 * disk after we took the checkpoint.
810 	 *
811 	 * We could try to set spa_log_state to SPA_LOG_CLEAR earlier
812 	 * when we first figure out whether the current uberblock is
813 	 * checkpointed or not. Unfortunately, that would discard all
814 	 * the logs, including the ones that are claimed, and we would
815 	 * leak space.
816 	 */
817 	if (spa_get_log_state(zilog->zl_spa) == SPA_LOG_CLEAR ||
818 	    (zilog->zl_spa->spa_uberblock.ub_checkpoint_txg != 0 &&
819 	    zh->zh_claim_txg == 0)) {
820 		if (!BP_IS_HOLE(&zh->zh_log)) {
821 			(void) zil_parse(zilog, zil_clear_log_block,
822 			    zil_noop_log_record, tx, first_txg, B_FALSE);
823 		}
824 		BP_ZERO(&zh->zh_log);
825 		if (os->os_encrypted)
826 			os->os_next_write_raw[tx->tx_txg & TXG_MASK] = B_TRUE;
827 		dsl_dataset_dirty(dmu_objset_ds(os), tx);
828 		dmu_objset_disown(os, B_FALSE, FTAG);
829 		return (0);
830 	}
831 
832 	/*
833 	 * If we are not rewinding and opening the pool normally, then
834 	 * the min_claim_txg should be equal to the first txg of the pool.
835 	 */
836 	ASSERT3U(first_txg, ==, spa_first_txg(zilog->zl_spa));
837 
838 	/*
839 	 * Claim all log blocks if we haven't already done so, and remember
840 	 * the highest claimed sequence number.  This ensures that if we can
841 	 * read only part of the log now (e.g. due to a missing device),
842 	 * but we can read the entire log later, we will not try to replay
843 	 * or destroy beyond the last block we successfully claimed.
844 	 */
845 	ASSERT3U(zh->zh_claim_txg, <=, first_txg);
846 	if (zh->zh_claim_txg == 0 && !BP_IS_HOLE(&zh->zh_log)) {
847 		(void) zil_parse(zilog, zil_claim_log_block,
848 		    zil_claim_log_record, tx, first_txg, B_FALSE);
849 		zh->zh_claim_txg = first_txg;
850 		zh->zh_claim_blk_seq = zilog->zl_parse_blk_seq;
851 		zh->zh_claim_lr_seq = zilog->zl_parse_lr_seq;
852 		if (zilog->zl_parse_lr_count || zilog->zl_parse_blk_count > 1)
853 			zh->zh_flags |= ZIL_REPLAY_NEEDED;
854 		zh->zh_flags |= ZIL_CLAIM_LR_SEQ_VALID;
855 		if (os->os_encrypted)
856 			os->os_next_write_raw[tx->tx_txg & TXG_MASK] = B_TRUE;
857 		dsl_dataset_dirty(dmu_objset_ds(os), tx);
858 	}
859 
860 	ASSERT3U(first_txg, ==, (spa_last_synced_txg(zilog->zl_spa) + 1));
861 	dmu_objset_disown(os, B_FALSE, FTAG);
862 	return (0);
863 }
864 
865 /*
866  * Check the log by walking the log chain.
867  * Checksum errors are ok as they indicate the end of the chain.
868  * Any other error (no device or read failure) returns an error.
869  */
870 /* ARGSUSED */
871 int
zil_check_log_chain(dsl_pool_t * dp,dsl_dataset_t * ds,void * tx)872 zil_check_log_chain(dsl_pool_t *dp, dsl_dataset_t *ds, void *tx)
873 {
874 	zilog_t *zilog;
875 	objset_t *os;
876 	blkptr_t *bp;
877 	int error;
878 
879 	ASSERT(tx == NULL);
880 
881 	error = dmu_objset_from_ds(ds, &os);
882 	if (error != 0) {
883 		cmn_err(CE_WARN, "can't open objset %llu, error %d",
884 		    (unsigned long long)ds->ds_object, error);
885 		return (0);
886 	}
887 
888 	zilog = dmu_objset_zil(os);
889 	bp = (blkptr_t *)&zilog->zl_header->zh_log;
890 
891 	if (!BP_IS_HOLE(bp)) {
892 		vdev_t *vd;
893 		boolean_t valid = B_TRUE;
894 
895 		/*
896 		 * Check the first block and determine if it's on a log device
897 		 * which may have been removed or faulted prior to loading this
898 		 * pool.  If so, there's no point in checking the rest of the
899 		 * log as its content should have already been synced to the
900 		 * pool.
901 		 */
902 		spa_config_enter(os->os_spa, SCL_STATE, FTAG, RW_READER);
903 		vd = vdev_lookup_top(os->os_spa, DVA_GET_VDEV(&bp->blk_dva[0]));
904 		if (vd->vdev_islog && vdev_is_dead(vd))
905 			valid = vdev_log_state_valid(vd);
906 		spa_config_exit(os->os_spa, SCL_STATE, FTAG);
907 
908 		if (!valid)
909 			return (0);
910 
911 		/*
912 		 * Check whether the current uberblock is checkpointed (e.g.
913 		 * we are rewinding) and whether the current header has been
914 		 * claimed or not. If it hasn't then skip verifying it. We
915 		 * do this because its ZIL blocks may be part of the pool's
916 		 * state before the rewind, which is no longer valid.
917 		 */
918 		zil_header_t *zh = zil_header_in_syncing_context(zilog);
919 		if (zilog->zl_spa->spa_uberblock.ub_checkpoint_txg != 0 &&
920 		    zh->zh_claim_txg == 0)
921 			return (0);
922 	}
923 
924 	/*
925 	 * Because tx == NULL, zil_claim_log_block() will not actually claim
926 	 * any blocks, but just determine whether it is possible to do so.
927 	 * In addition to checking the log chain, zil_claim_log_block()
928 	 * will invoke zio_claim() with a done func of spa_claim_notify(),
929 	 * which will update spa_max_claim_txg.  See spa_load() for details.
930 	 */
931 	error = zil_parse(zilog, zil_claim_log_block, zil_claim_log_record, tx,
932 	    zilog->zl_header->zh_claim_txg ? -1ULL :
933 	    spa_min_claim_txg(os->os_spa), B_FALSE);
934 
935 	return ((error == ECKSUM || error == ENOENT) ? 0 : error);
936 }
937 
938 /*
939  * When an itx is "skipped", this function is used to properly mark the
940  * waiter as "done, and signal any thread(s) waiting on it. An itx can
941  * be skipped (and not committed to an lwb) for a variety of reasons,
942  * one of them being that the itx was committed via spa_sync(), prior to
943  * it being committed to an lwb; this can happen if a thread calling
944  * zil_commit() is racing with spa_sync().
945  */
946 static void
zil_commit_waiter_skip(zil_commit_waiter_t * zcw)947 zil_commit_waiter_skip(zil_commit_waiter_t *zcw)
948 {
949 	mutex_enter(&zcw->zcw_lock);
950 	ASSERT3B(zcw->zcw_done, ==, B_FALSE);
951 	zcw->zcw_done = B_TRUE;
952 	cv_broadcast(&zcw->zcw_cv);
953 	mutex_exit(&zcw->zcw_lock);
954 }
955 
956 /*
957  * This function is used when the given waiter is to be linked into an
958  * lwb's "lwb_waiter" list; i.e. when the itx is committed to the lwb.
959  * At this point, the waiter will no longer be referenced by the itx,
960  * and instead, will be referenced by the lwb.
961  */
962 static void
zil_commit_waiter_link_lwb(zil_commit_waiter_t * zcw,lwb_t * lwb)963 zil_commit_waiter_link_lwb(zil_commit_waiter_t *zcw, lwb_t *lwb)
964 {
965 	/*
966 	 * The lwb_waiters field of the lwb is protected by the zilog's
967 	 * zl_lock, thus it must be held when calling this function.
968 	 */
969 	ASSERT(MUTEX_HELD(&lwb->lwb_zilog->zl_lock));
970 
971 	mutex_enter(&zcw->zcw_lock);
972 	ASSERT(!list_link_active(&zcw->zcw_node));
973 	ASSERT3P(zcw->zcw_lwb, ==, NULL);
974 	ASSERT3P(lwb, !=, NULL);
975 	ASSERT(lwb->lwb_state == LWB_STATE_OPENED ||
976 	    lwb->lwb_state == LWB_STATE_ISSUED ||
977 	    lwb->lwb_state == LWB_STATE_WRITE_DONE);
978 
979 	list_insert_tail(&lwb->lwb_waiters, zcw);
980 	zcw->zcw_lwb = lwb;
981 	mutex_exit(&zcw->zcw_lock);
982 }
983 
984 /*
985  * This function is used when zio_alloc_zil() fails to allocate a ZIL
986  * block, and the given waiter must be linked to the "nolwb waiters"
987  * list inside of zil_process_commit_list().
988  */
989 static void
zil_commit_waiter_link_nolwb(zil_commit_waiter_t * zcw,list_t * nolwb)990 zil_commit_waiter_link_nolwb(zil_commit_waiter_t *zcw, list_t *nolwb)
991 {
992 	mutex_enter(&zcw->zcw_lock);
993 	ASSERT(!list_link_active(&zcw->zcw_node));
994 	ASSERT3P(zcw->zcw_lwb, ==, NULL);
995 	list_insert_tail(nolwb, zcw);
996 	mutex_exit(&zcw->zcw_lock);
997 }
998 
999 void
zil_lwb_add_block(lwb_t * lwb,const blkptr_t * bp)1000 zil_lwb_add_block(lwb_t *lwb, const blkptr_t *bp)
1001 {
1002 	avl_tree_t *t = &lwb->lwb_vdev_tree;
1003 	avl_index_t where;
1004 	zil_vdev_node_t *zv, zvsearch;
1005 	int ndvas = BP_GET_NDVAS(bp);
1006 	int i;
1007 
1008 	if (zil_nocacheflush)
1009 		return;
1010 
1011 	mutex_enter(&lwb->lwb_vdev_lock);
1012 	for (i = 0; i < ndvas; i++) {
1013 		zvsearch.zv_vdev = DVA_GET_VDEV(&bp->blk_dva[i]);
1014 		if (avl_find(t, &zvsearch, &where) == NULL) {
1015 			zv = kmem_alloc(sizeof (*zv), KM_SLEEP);
1016 			zv->zv_vdev = zvsearch.zv_vdev;
1017 			avl_insert(t, zv, where);
1018 		}
1019 	}
1020 	mutex_exit(&lwb->lwb_vdev_lock);
1021 }
1022 
1023 static void
zil_lwb_flush_defer(lwb_t * lwb,lwb_t * nlwb)1024 zil_lwb_flush_defer(lwb_t *lwb, lwb_t *nlwb)
1025 {
1026 	avl_tree_t *src = &lwb->lwb_vdev_tree;
1027 	avl_tree_t *dst = &nlwb->lwb_vdev_tree;
1028 	void *cookie = NULL;
1029 	zil_vdev_node_t *zv;
1030 
1031 	ASSERT3S(lwb->lwb_state, ==, LWB_STATE_WRITE_DONE);
1032 	ASSERT3S(nlwb->lwb_state, !=, LWB_STATE_WRITE_DONE);
1033 	ASSERT3S(nlwb->lwb_state, !=, LWB_STATE_FLUSH_DONE);
1034 
1035 	/*
1036 	 * While 'lwb' is at a point in its lifetime where lwb_vdev_tree does
1037 	 * not need the protection of lwb_vdev_lock (it will only be modified
1038 	 * while holding zilog->zl_lock) as its writes and those of its
1039 	 * children have all completed.  The younger 'nlwb' may be waiting on
1040 	 * future writes to additional vdevs.
1041 	 */
1042 	mutex_enter(&nlwb->lwb_vdev_lock);
1043 	/*
1044 	 * Tear down the 'lwb' vdev tree, ensuring that entries which do not
1045 	 * exist in 'nlwb' are moved to it, freeing any would-be duplicates.
1046 	 */
1047 	while ((zv = avl_destroy_nodes(src, &cookie)) != NULL) {
1048 		avl_index_t where;
1049 
1050 		if (avl_find(dst, zv, &where) == NULL) {
1051 			avl_insert(dst, zv, where);
1052 		} else {
1053 			kmem_free(zv, sizeof (*zv));
1054 		}
1055 	}
1056 	mutex_exit(&nlwb->lwb_vdev_lock);
1057 }
1058 
1059 void
zil_lwb_add_txg(lwb_t * lwb,uint64_t txg)1060 zil_lwb_add_txg(lwb_t *lwb, uint64_t txg)
1061 {
1062 	lwb->lwb_max_txg = MAX(lwb->lwb_max_txg, txg);
1063 }
1064 
1065 /*
1066  * This function is a called after all vdevs associated with a given lwb
1067  * write have completed their DKIOCFLUSHWRITECACHE command; or as soon
1068  * as the lwb write completes, if "zil_nocacheflush" is set. Further,
1069  * all "previous" lwb's will have completed before this function is
1070  * called; i.e. this function is called for all previous lwbs before
1071  * it's called for "this" lwb (enforced via zio the dependencies
1072  * configured in zil_lwb_set_zio_dependency()).
1073  *
1074  * The intention is for this function to be called as soon as the
1075  * contents of an lwb are considered "stable" on disk, and will survive
1076  * any sudden loss of power. At this point, any threads waiting for the
1077  * lwb to reach this state are signalled, and the "waiter" structures
1078  * are marked "done".
1079  */
1080 static void
zil_lwb_flush_vdevs_done(zio_t * zio)1081 zil_lwb_flush_vdevs_done(zio_t *zio)
1082 {
1083 	lwb_t *lwb = zio->io_private;
1084 	zilog_t *zilog = lwb->lwb_zilog;
1085 	dmu_tx_t *tx = lwb->lwb_tx;
1086 	zil_commit_waiter_t *zcw;
1087 
1088 	spa_config_exit(zilog->zl_spa, SCL_STATE, lwb);
1089 
1090 	zio_buf_free(lwb->lwb_buf, lwb->lwb_sz);
1091 
1092 	mutex_enter(&zilog->zl_lock);
1093 
1094 	/*
1095 	 * Ensure the lwb buffer pointer is cleared before releasing the
1096 	 * txg. If we have had an allocation failure and the txg is
1097 	 * waiting to sync then we want zil_sync() to remove the lwb so
1098 	 * that it's not picked up as the next new one in
1099 	 * zil_process_commit_list(). zil_sync() will only remove the
1100 	 * lwb if lwb_buf is null.
1101 	 */
1102 	lwb->lwb_buf = NULL;
1103 	lwb->lwb_tx = NULL;
1104 
1105 	ASSERT3U(lwb->lwb_issued_timestamp, >, 0);
1106 	zilog->zl_last_lwb_latency = gethrtime() - lwb->lwb_issued_timestamp;
1107 
1108 	lwb->lwb_root_zio = NULL;
1109 
1110 	ASSERT3S(lwb->lwb_state, ==, LWB_STATE_WRITE_DONE);
1111 	lwb->lwb_state = LWB_STATE_FLUSH_DONE;
1112 
1113 	if (zilog->zl_last_lwb_opened == lwb) {
1114 		/*
1115 		 * Remember the highest committed log sequence number
1116 		 * for ztest. We only update this value when all the log
1117 		 * writes succeeded, because ztest wants to ASSERT that
1118 		 * it got the whole log chain.
1119 		 */
1120 		zilog->zl_commit_lr_seq = zilog->zl_lr_seq;
1121 	}
1122 
1123 	while ((zcw = list_head(&lwb->lwb_waiters)) != NULL) {
1124 		mutex_enter(&zcw->zcw_lock);
1125 
1126 		ASSERT(list_link_active(&zcw->zcw_node));
1127 		list_remove(&lwb->lwb_waiters, zcw);
1128 
1129 		ASSERT3P(zcw->zcw_lwb, ==, lwb);
1130 		zcw->zcw_lwb = NULL;
1131 
1132 		zcw->zcw_zio_error = zio->io_error;
1133 
1134 		ASSERT3B(zcw->zcw_done, ==, B_FALSE);
1135 		zcw->zcw_done = B_TRUE;
1136 		cv_broadcast(&zcw->zcw_cv);
1137 
1138 		mutex_exit(&zcw->zcw_lock);
1139 	}
1140 
1141 	mutex_exit(&zilog->zl_lock);
1142 
1143 	/*
1144 	 * Now that we've written this log block, we have a stable pointer
1145 	 * to the next block in the chain, so it's OK to let the txg in
1146 	 * which we allocated the next block sync.
1147 	 */
1148 	dmu_tx_commit(tx);
1149 }
1150 
1151 /*
1152  * This is called when an lwb's write zio completes. The callback's
1153  * purpose is to issue the DKIOCFLUSHWRITECACHE commands for the vdevs
1154  * in the lwb's lwb_vdev_tree. The tree will contain the vdevs involved
1155  * in writing out this specific lwb's data, and in the case that cache
1156  * flushes have been deferred, vdevs involved in writing the data for
1157  * previous lwbs. The writes corresponding to all the vdevs in the
1158  * lwb_vdev_tree will have completed by the time this is called, due to
1159  * the zio dependencies configured in zil_lwb_set_zio_dependency(),
1160  * which takes deferred flushes into account. The lwb will be "done"
1161  * once zil_lwb_flush_vdevs_done() is called, which occurs in the zio
1162  * completion callback for the lwb's root zio.
1163  */
1164 static void
zil_lwb_write_done(zio_t * zio)1165 zil_lwb_write_done(zio_t *zio)
1166 {
1167 	lwb_t *lwb = zio->io_private;
1168 	spa_t *spa = zio->io_spa;
1169 	zilog_t *zilog = lwb->lwb_zilog;
1170 	avl_tree_t *t = &lwb->lwb_vdev_tree;
1171 	void *cookie = NULL;
1172 	zil_vdev_node_t *zv;
1173 	lwb_t *nlwb;
1174 
1175 	ASSERT3S(spa_config_held(spa, SCL_STATE, RW_READER), !=, 0);
1176 
1177 	ASSERT(BP_GET_COMPRESS(zio->io_bp) == ZIO_COMPRESS_OFF);
1178 	ASSERT(BP_GET_TYPE(zio->io_bp) == DMU_OT_INTENT_LOG);
1179 	ASSERT(BP_GET_LEVEL(zio->io_bp) == 0);
1180 	ASSERT(BP_GET_BYTEORDER(zio->io_bp) == ZFS_HOST_BYTEORDER);
1181 	ASSERT(!BP_IS_GANG(zio->io_bp));
1182 	ASSERT(!BP_IS_HOLE(zio->io_bp));
1183 	ASSERT(BP_GET_FILL(zio->io_bp) == 0);
1184 
1185 	abd_put(zio->io_abd);
1186 
1187 	mutex_enter(&zilog->zl_lock);
1188 	ASSERT3S(lwb->lwb_state, ==, LWB_STATE_ISSUED);
1189 	lwb->lwb_state = LWB_STATE_WRITE_DONE;
1190 	lwb->lwb_write_zio = NULL;
1191 	nlwb = list_next(&zilog->zl_lwb_list, lwb);
1192 	mutex_exit(&zilog->zl_lock);
1193 
1194 	if (avl_numnodes(t) == 0)
1195 		return;
1196 
1197 	/*
1198 	 * If there was an IO error, we're not going to call zio_flush()
1199 	 * on these vdevs, so we simply empty the tree and free the
1200 	 * nodes. We avoid calling zio_flush() since there isn't any
1201 	 * good reason for doing so, after the lwb block failed to be
1202 	 * written out.
1203 	 */
1204 	if (zio->io_error != 0) {
1205 		while ((zv = avl_destroy_nodes(t, &cookie)) != NULL)
1206 			kmem_free(zv, sizeof (*zv));
1207 		return;
1208 	}
1209 
1210 	/*
1211 	 * If this lwb does not have any threads waiting for it to
1212 	 * complete, we want to defer issuing the DKIOCFLUSHWRITECACHE
1213 	 * command to the vdevs written to by "this" lwb, and instead
1214 	 * rely on the "next" lwb to handle the DKIOCFLUSHWRITECACHE
1215 	 * command for those vdevs. Thus, we merge the vdev tree of
1216 	 * "this" lwb with the vdev tree of the "next" lwb in the list,
1217 	 * and assume the "next" lwb will handle flushing the vdevs (or
1218 	 * deferring the flush(s) again).
1219 	 *
1220 	 * This is a useful performance optimization, especially for
1221 	 * workloads with lots of async write activity and few sync
1222 	 * write and/or fsync activity, as it has the potential to
1223 	 * coalesce multiple flush commands to a vdev into one.
1224 	 */
1225 	if (list_head(&lwb->lwb_waiters) == NULL && nlwb != NULL) {
1226 		zil_lwb_flush_defer(lwb, nlwb);
1227 		ASSERT(avl_is_empty(&lwb->lwb_vdev_tree));
1228 		return;
1229 	}
1230 
1231 	while ((zv = avl_destroy_nodes(t, &cookie)) != NULL) {
1232 		vdev_t *vd = vdev_lookup_top(spa, zv->zv_vdev);
1233 		if (vd != NULL)
1234 			zio_flush(lwb->lwb_root_zio, vd);
1235 		kmem_free(zv, sizeof (*zv));
1236 	}
1237 }
1238 
1239 static void
zil_lwb_set_zio_dependency(zilog_t * zilog,lwb_t * lwb)1240 zil_lwb_set_zio_dependency(zilog_t *zilog, lwb_t *lwb)
1241 {
1242 	lwb_t *last_lwb_opened = zilog->zl_last_lwb_opened;
1243 
1244 	ASSERT(MUTEX_HELD(&zilog->zl_issuer_lock));
1245 	ASSERT(MUTEX_HELD(&zilog->zl_lock));
1246 
1247 	/*
1248 	 * The zilog's "zl_last_lwb_opened" field is used to build the
1249 	 * lwb/zio dependency chain, which is used to preserve the
1250 	 * ordering of lwb completions that is required by the semantics
1251 	 * of the ZIL. Each new lwb zio becomes a parent of the
1252 	 * "previous" lwb zio, such that the new lwb's zio cannot
1253 	 * complete until the "previous" lwb's zio completes.
1254 	 *
1255 	 * This is required by the semantics of zil_commit(); the commit
1256 	 * waiters attached to the lwbs will be woken in the lwb zio's
1257 	 * completion callback, so this zio dependency graph ensures the
1258 	 * waiters are woken in the correct order (the same order the
1259 	 * lwbs were created).
1260 	 */
1261 	if (last_lwb_opened != NULL &&
1262 	    last_lwb_opened->lwb_state != LWB_STATE_FLUSH_DONE) {
1263 		ASSERT(last_lwb_opened->lwb_state == LWB_STATE_OPENED ||
1264 		    last_lwb_opened->lwb_state == LWB_STATE_ISSUED ||
1265 		    last_lwb_opened->lwb_state == LWB_STATE_WRITE_DONE);
1266 
1267 		ASSERT3P(last_lwb_opened->lwb_root_zio, !=, NULL);
1268 		zio_add_child(lwb->lwb_root_zio,
1269 		    last_lwb_opened->lwb_root_zio);
1270 
1271 		/*
1272 		 * If the previous lwb's write hasn't already completed,
1273 		 * we also want to order the completion of the lwb write
1274 		 * zios (above, we only order the completion of the lwb
1275 		 * root zios). This is required because of how we can
1276 		 * defer the DKIOCFLUSHWRITECACHE commands for each lwb.
1277 		 *
1278 		 * When the DKIOCFLUSHWRITECACHE commands are deferred,
1279 		 * the previous lwb will rely on this lwb to flush the
1280 		 * vdevs written to by that previous lwb. Thus, we need
1281 		 * to ensure this lwb doesn't issue the flush until
1282 		 * after the previous lwb's write completes. We ensure
1283 		 * this ordering by setting the zio parent/child
1284 		 * relationship here.
1285 		 *
1286 		 * Without this relationship on the lwb's write zio,
1287 		 * it's possible for this lwb's write to complete prior
1288 		 * to the previous lwb's write completing; and thus, the
1289 		 * vdevs for the previous lwb would be flushed prior to
1290 		 * that lwb's data being written to those vdevs (the
1291 		 * vdevs are flushed in the lwb write zio's completion
1292 		 * handler, zil_lwb_write_done()).
1293 		 */
1294 		if (last_lwb_opened->lwb_state != LWB_STATE_WRITE_DONE) {
1295 			ASSERT(last_lwb_opened->lwb_state == LWB_STATE_OPENED ||
1296 			    last_lwb_opened->lwb_state == LWB_STATE_ISSUED);
1297 
1298 			ASSERT3P(last_lwb_opened->lwb_write_zio, !=, NULL);
1299 			zio_add_child(lwb->lwb_write_zio,
1300 			    last_lwb_opened->lwb_write_zio);
1301 		}
1302 	}
1303 }
1304 
1305 
1306 /*
1307  * This function's purpose is to "open" an lwb such that it is ready to
1308  * accept new itxs being committed to it. To do this, the lwb's zio
1309  * structures are created, and linked to the lwb. This function is
1310  * idempotent; if the passed in lwb has already been opened, this
1311  * function is essentially a no-op.
1312  */
1313 static void
zil_lwb_write_open(zilog_t * zilog,lwb_t * lwb)1314 zil_lwb_write_open(zilog_t *zilog, lwb_t *lwb)
1315 {
1316 	zbookmark_phys_t zb;
1317 	zio_priority_t prio;
1318 
1319 	ASSERT(MUTEX_HELD(&zilog->zl_issuer_lock));
1320 	ASSERT3P(lwb, !=, NULL);
1321 	EQUIV(lwb->lwb_root_zio == NULL, lwb->lwb_state == LWB_STATE_CLOSED);
1322 	EQUIV(lwb->lwb_root_zio != NULL, lwb->lwb_state == LWB_STATE_OPENED);
1323 
1324 	SET_BOOKMARK(&zb, lwb->lwb_blk.blk_cksum.zc_word[ZIL_ZC_OBJSET],
1325 	    ZB_ZIL_OBJECT, ZB_ZIL_LEVEL,
1326 	    lwb->lwb_blk.blk_cksum.zc_word[ZIL_ZC_SEQ]);
1327 
1328 	if (lwb->lwb_root_zio == NULL) {
1329 		abd_t *lwb_abd = abd_get_from_buf(lwb->lwb_buf,
1330 		    BP_GET_LSIZE(&lwb->lwb_blk));
1331 
1332 		if (!lwb->lwb_slog || zilog->zl_cur_used <= zil_slog_bulk)
1333 			prio = ZIO_PRIORITY_SYNC_WRITE;
1334 		else
1335 			prio = ZIO_PRIORITY_ASYNC_WRITE;
1336 
1337 		lwb->lwb_root_zio = zio_root(zilog->zl_spa,
1338 		    zil_lwb_flush_vdevs_done, lwb, ZIO_FLAG_CANFAIL);
1339 		ASSERT3P(lwb->lwb_root_zio, !=, NULL);
1340 
1341 		lwb->lwb_write_zio = zio_rewrite(lwb->lwb_root_zio,
1342 		    zilog->zl_spa, 0, &lwb->lwb_blk, lwb_abd,
1343 		    BP_GET_LSIZE(&lwb->lwb_blk), zil_lwb_write_done, lwb,
1344 		    prio, ZIO_FLAG_CANFAIL | ZIO_FLAG_DONT_PROPAGATE, &zb);
1345 		ASSERT3P(lwb->lwb_write_zio, !=, NULL);
1346 
1347 		lwb->lwb_state = LWB_STATE_OPENED;
1348 
1349 		mutex_enter(&zilog->zl_lock);
1350 		zil_lwb_set_zio_dependency(zilog, lwb);
1351 		zilog->zl_last_lwb_opened = lwb;
1352 		mutex_exit(&zilog->zl_lock);
1353 	}
1354 
1355 	ASSERT3P(lwb->lwb_root_zio, !=, NULL);
1356 	ASSERT3P(lwb->lwb_write_zio, !=, NULL);
1357 	ASSERT3S(lwb->lwb_state, ==, LWB_STATE_OPENED);
1358 }
1359 
1360 /*
1361  * Define a limited set of intent log block sizes.
1362  *
1363  * These must be a multiple of 4KB. Note only the amount used (again
1364  * aligned to 4KB) actually gets written. However, we can't always just
1365  * allocate SPA_OLD_MAXBLOCKSIZE as the slog space could be exhausted.
1366  */
1367 uint64_t zil_block_buckets[] = {
1368     4096,		/* non TX_WRITE */
1369     8192+4096,		/* data base */
1370     32*1024 + 4096,	/* NFS writes */
1371     UINT64_MAX
1372 };
1373 
1374 /*
1375  * Start a log block write and advance to the next log block.
1376  * Calls are serialized.
1377  */
1378 static lwb_t *
zil_lwb_write_issue(zilog_t * zilog,lwb_t * lwb)1379 zil_lwb_write_issue(zilog_t *zilog, lwb_t *lwb)
1380 {
1381 	lwb_t *nlwb = NULL;
1382 	zil_chain_t *zilc;
1383 	spa_t *spa = zilog->zl_spa;
1384 	blkptr_t *bp;
1385 	dmu_tx_t *tx;
1386 	uint64_t txg;
1387 	uint64_t zil_blksz, wsz;
1388 	int i, error;
1389 	boolean_t slog;
1390 
1391 	ASSERT(MUTEX_HELD(&zilog->zl_issuer_lock));
1392 	ASSERT3P(lwb->lwb_root_zio, !=, NULL);
1393 	ASSERT3P(lwb->lwb_write_zio, !=, NULL);
1394 	ASSERT3S(lwb->lwb_state, ==, LWB_STATE_OPENED);
1395 
1396 	if (BP_GET_CHECKSUM(&lwb->lwb_blk) == ZIO_CHECKSUM_ZILOG2) {
1397 		zilc = (zil_chain_t *)lwb->lwb_buf;
1398 		bp = &zilc->zc_next_blk;
1399 	} else {
1400 		zilc = (zil_chain_t *)(lwb->lwb_buf + lwb->lwb_sz);
1401 		bp = &zilc->zc_next_blk;
1402 	}
1403 
1404 	ASSERT(lwb->lwb_nused <= lwb->lwb_sz);
1405 
1406 	/*
1407 	 * Allocate the next block and save its address in this block
1408 	 * before writing it in order to establish the log chain.
1409 	 * Note that if the allocation of nlwb synced before we wrote
1410 	 * the block that points at it (lwb), we'd leak it if we crashed.
1411 	 * Therefore, we don't do dmu_tx_commit() until zil_lwb_write_done().
1412 	 * We dirty the dataset to ensure that zil_sync() will be called
1413 	 * to clean up in the event of allocation failure or I/O failure.
1414 	 */
1415 
1416 	tx = dmu_tx_create(zilog->zl_os);
1417 
1418 	/*
1419 	 * Since we are not going to create any new dirty data, and we
1420 	 * can even help with clearing the existing dirty data, we
1421 	 * should not be subject to the dirty data based delays. We
1422 	 * use TXG_NOTHROTTLE to bypass the delay mechanism.
1423 	 */
1424 	VERIFY0(dmu_tx_assign(tx, TXG_WAIT | TXG_NOTHROTTLE));
1425 
1426 	dsl_dataset_dirty(dmu_objset_ds(zilog->zl_os), tx);
1427 	txg = dmu_tx_get_txg(tx);
1428 
1429 	lwb->lwb_tx = tx;
1430 
1431 	/*
1432 	 * Log blocks are pre-allocated. Here we select the size of the next
1433 	 * block, based on size used in the last block.
1434 	 * - first find the smallest bucket that will fit the block from a
1435 	 *   limited set of block sizes. This is because it's faster to write
1436 	 *   blocks allocated from the same metaslab as they are adjacent or
1437 	 *   close.
1438 	 * - next find the maximum from the new suggested size and an array of
1439 	 *   previous sizes. This lessens a picket fence effect of wrongly
1440 	 *   guesssing the size if we have a stream of say 2k, 64k, 2k, 64k
1441 	 *   requests.
1442 	 *
1443 	 * Note we only write what is used, but we can't just allocate
1444 	 * the maximum block size because we can exhaust the available
1445 	 * pool log space.
1446 	 */
1447 	zil_blksz = zilog->zl_cur_used + sizeof (zil_chain_t);
1448 	for (i = 0; zil_blksz > zil_block_buckets[i]; i++)
1449 		continue;
1450 	zil_blksz = zil_block_buckets[i];
1451 	if (zil_blksz == UINT64_MAX)
1452 		zil_blksz = SPA_OLD_MAXBLOCKSIZE;
1453 	zilog->zl_prev_blks[zilog->zl_prev_rotor] = zil_blksz;
1454 	for (i = 0; i < ZIL_PREV_BLKS; i++)
1455 		zil_blksz = MAX(zil_blksz, zilog->zl_prev_blks[i]);
1456 	zilog->zl_prev_rotor = (zilog->zl_prev_rotor + 1) & (ZIL_PREV_BLKS - 1);
1457 
1458 	BP_ZERO(bp);
1459 
1460 	/* pass the old blkptr in order to spread log blocks across devs */
1461 	error = zio_alloc_zil(spa, zilog->zl_os, txg, bp, &lwb->lwb_blk,
1462 	    zil_blksz, &slog);
1463 
1464 	if (error == 0) {
1465 		ASSERT3U(bp->blk_birth, ==, txg);
1466 		bp->blk_cksum = lwb->lwb_blk.blk_cksum;
1467 		bp->blk_cksum.zc_word[ZIL_ZC_SEQ]++;
1468 
1469 		/*
1470 		 * Allocate a new log write block (lwb).
1471 		 */
1472 		nlwb = zil_alloc_lwb(zilog, bp, slog, txg);
1473 	}
1474 
1475 	if (BP_GET_CHECKSUM(&lwb->lwb_blk) == ZIO_CHECKSUM_ZILOG2) {
1476 		/* For Slim ZIL only write what is used. */
1477 		wsz = P2ROUNDUP_TYPED(lwb->lwb_nused, ZIL_MIN_BLKSZ, uint64_t);
1478 		ASSERT3U(wsz, <=, lwb->lwb_sz);
1479 		zio_shrink(lwb->lwb_write_zio, wsz);
1480 
1481 	} else {
1482 		wsz = lwb->lwb_sz;
1483 	}
1484 
1485 	zilc->zc_pad = 0;
1486 	zilc->zc_nused = lwb->lwb_nused;
1487 	zilc->zc_eck.zec_cksum = lwb->lwb_blk.blk_cksum;
1488 
1489 	/*
1490 	 * clear unused data for security
1491 	 */
1492 	bzero(lwb->lwb_buf + lwb->lwb_nused, wsz - lwb->lwb_nused);
1493 
1494 	spa_config_enter(zilog->zl_spa, SCL_STATE, lwb, RW_READER);
1495 
1496 	zil_lwb_add_block(lwb, &lwb->lwb_blk);
1497 	lwb->lwb_issued_timestamp = gethrtime();
1498 	lwb->lwb_state = LWB_STATE_ISSUED;
1499 
1500 	zio_nowait(lwb->lwb_root_zio);
1501 	zio_nowait(lwb->lwb_write_zio);
1502 
1503 	/*
1504 	 * If there was an allocation failure then nlwb will be null which
1505 	 * forces a txg_wait_synced().
1506 	 */
1507 	return (nlwb);
1508 }
1509 
1510 static lwb_t *
zil_lwb_commit(zilog_t * zilog,itx_t * itx,lwb_t * lwb)1511 zil_lwb_commit(zilog_t *zilog, itx_t *itx, lwb_t *lwb)
1512 {
1513 	lr_t *lrcb, *lrc;
1514 	lr_write_t *lrwb, *lrw;
1515 	char *lr_buf;
1516 	uint64_t dlen, dnow, lwb_sp, reclen, txg;
1517 
1518 	ASSERT(MUTEX_HELD(&zilog->zl_issuer_lock));
1519 	ASSERT3P(lwb, !=, NULL);
1520 	ASSERT3P(lwb->lwb_buf, !=, NULL);
1521 
1522 	zil_lwb_write_open(zilog, lwb);
1523 
1524 	lrc = &itx->itx_lr;
1525 	lrw = (lr_write_t *)lrc;
1526 
1527 	/*
1528 	 * A commit itx doesn't represent any on-disk state; instead
1529 	 * it's simply used as a place holder on the commit list, and
1530 	 * provides a mechanism for attaching a "commit waiter" onto the
1531 	 * correct lwb (such that the waiter can be signalled upon
1532 	 * completion of that lwb). Thus, we don't process this itx's
1533 	 * log record if it's a commit itx (these itx's don't have log
1534 	 * records), and instead link the itx's waiter onto the lwb's
1535 	 * list of waiters.
1536 	 *
1537 	 * For more details, see the comment above zil_commit().
1538 	 */
1539 	if (lrc->lrc_txtype == TX_COMMIT) {
1540 		mutex_enter(&zilog->zl_lock);
1541 		zil_commit_waiter_link_lwb(itx->itx_private, lwb);
1542 		itx->itx_private = NULL;
1543 		mutex_exit(&zilog->zl_lock);
1544 		return (lwb);
1545 	}
1546 
1547 	if (lrc->lrc_txtype == TX_WRITE && itx->itx_wr_state == WR_NEED_COPY) {
1548 		dlen = P2ROUNDUP_TYPED(
1549 		    lrw->lr_length, sizeof (uint64_t), uint64_t);
1550 	} else {
1551 		dlen = 0;
1552 	}
1553 	reclen = lrc->lrc_reclen;
1554 	zilog->zl_cur_used += (reclen + dlen);
1555 	txg = lrc->lrc_txg;
1556 
1557 	ASSERT3U(zilog->zl_cur_used, <, UINT64_MAX - (reclen + dlen));
1558 
1559 cont:
1560 	/*
1561 	 * If this record won't fit in the current log block, start a new one.
1562 	 * For WR_NEED_COPY optimize layout for minimal number of chunks.
1563 	 */
1564 	lwb_sp = lwb->lwb_sz - lwb->lwb_nused;
1565 	if (reclen > lwb_sp || (reclen + dlen > lwb_sp &&
1566 	    lwb_sp < ZIL_MAX_WASTE_SPACE && (dlen % ZIL_MAX_LOG_DATA == 0 ||
1567 	    lwb_sp < reclen + dlen % ZIL_MAX_LOG_DATA))) {
1568 		lwb = zil_lwb_write_issue(zilog, lwb);
1569 		if (lwb == NULL)
1570 			return (NULL);
1571 		zil_lwb_write_open(zilog, lwb);
1572 		ASSERT(LWB_EMPTY(lwb));
1573 		lwb_sp = lwb->lwb_sz - lwb->lwb_nused;
1574 		ASSERT3U(reclen + MIN(dlen, sizeof (uint64_t)), <=, lwb_sp);
1575 	}
1576 
1577 	dnow = MIN(dlen, lwb_sp - reclen);
1578 	lr_buf = lwb->lwb_buf + lwb->lwb_nused;
1579 	bcopy(lrc, lr_buf, reclen);
1580 	lrcb = (lr_t *)lr_buf;		/* Like lrc, but inside lwb. */
1581 	lrwb = (lr_write_t *)lrcb;	/* Like lrw, but inside lwb. */
1582 
1583 	/*
1584 	 * If it's a write, fetch the data or get its blkptr as appropriate.
1585 	 */
1586 	if (lrc->lrc_txtype == TX_WRITE) {
1587 		if (txg > spa_freeze_txg(zilog->zl_spa))
1588 			txg_wait_synced(zilog->zl_dmu_pool, txg);
1589 		if (itx->itx_wr_state != WR_COPIED) {
1590 			char *dbuf;
1591 			int error;
1592 
1593 			if (itx->itx_wr_state == WR_NEED_COPY) {
1594 				dbuf = lr_buf + reclen;
1595 				lrcb->lrc_reclen += dnow;
1596 				if (lrwb->lr_length > dnow)
1597 					lrwb->lr_length = dnow;
1598 				lrw->lr_offset += dnow;
1599 				lrw->lr_length -= dnow;
1600 			} else {
1601 				ASSERT(itx->itx_wr_state == WR_INDIRECT);
1602 				dbuf = NULL;
1603 			}
1604 
1605 			/*
1606 			 * We pass in the "lwb_write_zio" rather than
1607 			 * "lwb_root_zio" so that the "lwb_write_zio"
1608 			 * becomes the parent of any zio's created by
1609 			 * the "zl_get_data" callback. The vdevs are
1610 			 * flushed after the "lwb_write_zio" completes,
1611 			 * so we want to make sure that completion
1612 			 * callback waits for these additional zio's,
1613 			 * such that the vdevs used by those zio's will
1614 			 * be included in the lwb's vdev tree, and those
1615 			 * vdevs will be properly flushed. If we passed
1616 			 * in "lwb_root_zio" here, then these additional
1617 			 * vdevs may not be flushed; e.g. if these zio's
1618 			 * completed after "lwb_write_zio" completed.
1619 			 */
1620 			error = zilog->zl_get_data(itx->itx_private,
1621 			    lrwb, dbuf, lwb, lwb->lwb_write_zio);
1622 
1623 			if (error == EIO) {
1624 				txg_wait_synced(zilog->zl_dmu_pool, txg);
1625 				return (lwb);
1626 			}
1627 			if (error != 0) {
1628 				ASSERT(error == ENOENT || error == EEXIST ||
1629 				    error == EALREADY);
1630 				return (lwb);
1631 			}
1632 		}
1633 	}
1634 
1635 	/*
1636 	 * We're actually making an entry, so update lrc_seq to be the
1637 	 * log record sequence number.  Note that this is generally not
1638 	 * equal to the itx sequence number because not all transactions
1639 	 * are synchronous, and sometimes spa_sync() gets there first.
1640 	 */
1641 	lrcb->lrc_seq = ++zilog->zl_lr_seq;
1642 	lwb->lwb_nused += reclen + dnow;
1643 
1644 	zil_lwb_add_txg(lwb, txg);
1645 
1646 	ASSERT3U(lwb->lwb_nused, <=, lwb->lwb_sz);
1647 	ASSERT0(P2PHASE(lwb->lwb_nused, sizeof (uint64_t)));
1648 
1649 	dlen -= dnow;
1650 	if (dlen > 0) {
1651 		zilog->zl_cur_used += reclen;
1652 		goto cont;
1653 	}
1654 
1655 	return (lwb);
1656 }
1657 
1658 itx_t *
zil_itx_create(uint64_t txtype,size_t lrsize)1659 zil_itx_create(uint64_t txtype, size_t lrsize)
1660 {
1661 	itx_t *itx;
1662 
1663 	lrsize = P2ROUNDUP_TYPED(lrsize, sizeof (uint64_t), size_t);
1664 
1665 	itx = kmem_alloc(offsetof(itx_t, itx_lr) + lrsize, KM_SLEEP);
1666 	itx->itx_lr.lrc_txtype = txtype;
1667 	itx->itx_lr.lrc_reclen = lrsize;
1668 	itx->itx_lr.lrc_seq = 0;	/* defensive */
1669 	itx->itx_sync = B_TRUE;		/* default is synchronous */
1670 
1671 	return (itx);
1672 }
1673 
1674 void
zil_itx_destroy(itx_t * itx)1675 zil_itx_destroy(itx_t *itx)
1676 {
1677 	kmem_free(itx, offsetof(itx_t, itx_lr) + itx->itx_lr.lrc_reclen);
1678 }
1679 
1680 /*
1681  * Free up the sync and async itxs. The itxs_t has already been detached
1682  * so no locks are needed.
1683  */
1684 static void
zil_itxg_clean(itxs_t * itxs)1685 zil_itxg_clean(itxs_t *itxs)
1686 {
1687 	itx_t *itx;
1688 	list_t *list;
1689 	avl_tree_t *t;
1690 	void *cookie;
1691 	itx_async_node_t *ian;
1692 
1693 	list = &itxs->i_sync_list;
1694 	while ((itx = list_head(list)) != NULL) {
1695 		/*
1696 		 * In the general case, commit itxs will not be found
1697 		 * here, as they'll be committed to an lwb via
1698 		 * zil_lwb_commit(), and free'd in that function. Having
1699 		 * said that, it is still possible for commit itxs to be
1700 		 * found here, due to the following race:
1701 		 *
1702 		 *	- a thread calls zil_commit() which assigns the
1703 		 *	  commit itx to a per-txg i_sync_list
1704 		 *	- zil_itxg_clean() is called (e.g. via spa_sync())
1705 		 *	  while the waiter is still on the i_sync_list
1706 		 *
1707 		 * There's nothing to prevent syncing the txg while the
1708 		 * waiter is on the i_sync_list. This normally doesn't
1709 		 * happen because spa_sync() is slower than zil_commit(),
1710 		 * but if zil_commit() calls txg_wait_synced() (e.g.
1711 		 * because zil_create() or zil_commit_writer_stall() is
1712 		 * called) we will hit this case.
1713 		 */
1714 		if (itx->itx_lr.lrc_txtype == TX_COMMIT)
1715 			zil_commit_waiter_skip(itx->itx_private);
1716 
1717 		list_remove(list, itx);
1718 		zil_itx_destroy(itx);
1719 	}
1720 
1721 	cookie = NULL;
1722 	t = &itxs->i_async_tree;
1723 	while ((ian = avl_destroy_nodes(t, &cookie)) != NULL) {
1724 		list = &ian->ia_list;
1725 		while ((itx = list_head(list)) != NULL) {
1726 			list_remove(list, itx);
1727 			/* commit itxs should never be on the async lists. */
1728 			ASSERT3U(itx->itx_lr.lrc_txtype, !=, TX_COMMIT);
1729 			zil_itx_destroy(itx);
1730 		}
1731 		list_destroy(list);
1732 		kmem_free(ian, sizeof (itx_async_node_t));
1733 	}
1734 	avl_destroy(t);
1735 
1736 	kmem_free(itxs, sizeof (itxs_t));
1737 }
1738 
1739 static int
zil_aitx_compare(const void * x1,const void * x2)1740 zil_aitx_compare(const void *x1, const void *x2)
1741 {
1742 	const uint64_t o1 = ((itx_async_node_t *)x1)->ia_foid;
1743 	const uint64_t o2 = ((itx_async_node_t *)x2)->ia_foid;
1744 
1745 	return (TREE_CMP(o1, o2));
1746 }
1747 
1748 /*
1749  * Remove all async itx with the given oid.
1750  */
1751 void
zil_remove_async(zilog_t * zilog,uint64_t oid)1752 zil_remove_async(zilog_t *zilog, uint64_t oid)
1753 {
1754 	uint64_t otxg, txg;
1755 	itx_async_node_t *ian;
1756 	avl_tree_t *t;
1757 	avl_index_t where;
1758 	list_t clean_list;
1759 	itx_t *itx;
1760 
1761 	ASSERT(oid != 0);
1762 	list_create(&clean_list, sizeof (itx_t), offsetof(itx_t, itx_node));
1763 
1764 	if (spa_freeze_txg(zilog->zl_spa) != UINT64_MAX) /* ziltest support */
1765 		otxg = ZILTEST_TXG;
1766 	else
1767 		otxg = spa_last_synced_txg(zilog->zl_spa) + 1;
1768 
1769 	for (txg = otxg; txg < (otxg + TXG_CONCURRENT_STATES); txg++) {
1770 		itxg_t *itxg = &zilog->zl_itxg[txg & TXG_MASK];
1771 
1772 		mutex_enter(&itxg->itxg_lock);
1773 		if (itxg->itxg_txg != txg) {
1774 			mutex_exit(&itxg->itxg_lock);
1775 			continue;
1776 		}
1777 
1778 		/*
1779 		 * Locate the object node and append its list.
1780 		 */
1781 		t = &itxg->itxg_itxs->i_async_tree;
1782 		ian = avl_find(t, &oid, &where);
1783 		if (ian != NULL)
1784 			list_move_tail(&clean_list, &ian->ia_list);
1785 		mutex_exit(&itxg->itxg_lock);
1786 	}
1787 	while ((itx = list_head(&clean_list)) != NULL) {
1788 		list_remove(&clean_list, itx);
1789 		/* commit itxs should never be on the async lists. */
1790 		ASSERT3U(itx->itx_lr.lrc_txtype, !=, TX_COMMIT);
1791 		zil_itx_destroy(itx);
1792 	}
1793 	list_destroy(&clean_list);
1794 }
1795 
1796 void
zil_itx_assign(zilog_t * zilog,itx_t * itx,dmu_tx_t * tx)1797 zil_itx_assign(zilog_t *zilog, itx_t *itx, dmu_tx_t *tx)
1798 {
1799 	uint64_t txg;
1800 	itxg_t *itxg;
1801 	itxs_t *itxs, *clean = NULL;
1802 
1803 	/*
1804 	 * Ensure the data of a renamed file is committed before the rename.
1805 	 */
1806 	if ((itx->itx_lr.lrc_txtype & ~TX_CI) == TX_RENAME)
1807 		zil_async_to_sync(zilog, itx->itx_oid);
1808 
1809 	if (spa_freeze_txg(zilog->zl_spa) != UINT64_MAX)
1810 		txg = ZILTEST_TXG;
1811 	else
1812 		txg = dmu_tx_get_txg(tx);
1813 
1814 	itxg = &zilog->zl_itxg[txg & TXG_MASK];
1815 	mutex_enter(&itxg->itxg_lock);
1816 	itxs = itxg->itxg_itxs;
1817 	if (itxg->itxg_txg != txg) {
1818 		if (itxs != NULL) {
1819 			/*
1820 			 * The zil_clean callback hasn't got around to cleaning
1821 			 * this itxg. Save the itxs for release below.
1822 			 * This should be rare.
1823 			 */
1824 			zfs_dbgmsg("zil_itx_assign: missed itx cleanup for "
1825 			    "txg %llu", itxg->itxg_txg);
1826 			clean = itxg->itxg_itxs;
1827 		}
1828 		itxg->itxg_txg = txg;
1829 		itxs = itxg->itxg_itxs = kmem_zalloc(sizeof (itxs_t), KM_SLEEP);
1830 
1831 		list_create(&itxs->i_sync_list, sizeof (itx_t),
1832 		    offsetof(itx_t, itx_node));
1833 		avl_create(&itxs->i_async_tree, zil_aitx_compare,
1834 		    sizeof (itx_async_node_t),
1835 		    offsetof(itx_async_node_t, ia_node));
1836 	}
1837 	if (itx->itx_sync) {
1838 		list_insert_tail(&itxs->i_sync_list, itx);
1839 	} else {
1840 		avl_tree_t *t = &itxs->i_async_tree;
1841 		uint64_t foid =
1842 		    LR_FOID_GET_OBJ(((lr_ooo_t *)&itx->itx_lr)->lr_foid);
1843 		itx_async_node_t *ian;
1844 		avl_index_t where;
1845 
1846 		ian = avl_find(t, &foid, &where);
1847 		if (ian == NULL) {
1848 			ian = kmem_alloc(sizeof (itx_async_node_t), KM_SLEEP);
1849 			list_create(&ian->ia_list, sizeof (itx_t),
1850 			    offsetof(itx_t, itx_node));
1851 			ian->ia_foid = foid;
1852 			avl_insert(t, ian, where);
1853 		}
1854 		list_insert_tail(&ian->ia_list, itx);
1855 	}
1856 
1857 	itx->itx_lr.lrc_txg = dmu_tx_get_txg(tx);
1858 
1859 	/*
1860 	 * We don't want to dirty the ZIL using ZILTEST_TXG, because
1861 	 * zil_clean() will never be called using ZILTEST_TXG. Thus, we
1862 	 * need to be careful to always dirty the ZIL using the "real"
1863 	 * TXG (not itxg_txg) even when the SPA is frozen.
1864 	 */
1865 	zilog_dirty(zilog, dmu_tx_get_txg(tx));
1866 	mutex_exit(&itxg->itxg_lock);
1867 
1868 	/* Release the old itxs now we've dropped the lock */
1869 	if (clean != NULL)
1870 		zil_itxg_clean(clean);
1871 }
1872 
1873 /*
1874  * If there are any in-memory intent log transactions which have now been
1875  * synced then start up a taskq to free them. We should only do this after we
1876  * have written out the uberblocks (i.e. txg has been comitted) so that
1877  * don't inadvertently clean out in-memory log records that would be required
1878  * by zil_commit().
1879  */
1880 void
zil_clean(zilog_t * zilog,uint64_t synced_txg)1881 zil_clean(zilog_t *zilog, uint64_t synced_txg)
1882 {
1883 	itxg_t *itxg = &zilog->zl_itxg[synced_txg & TXG_MASK];
1884 	itxs_t *clean_me;
1885 
1886 	ASSERT3U(synced_txg, <, ZILTEST_TXG);
1887 
1888 	mutex_enter(&itxg->itxg_lock);
1889 	if (itxg->itxg_itxs == NULL || itxg->itxg_txg == ZILTEST_TXG) {
1890 		mutex_exit(&itxg->itxg_lock);
1891 		return;
1892 	}
1893 	ASSERT3U(itxg->itxg_txg, <=, synced_txg);
1894 	ASSERT3U(itxg->itxg_txg, !=, 0);
1895 	clean_me = itxg->itxg_itxs;
1896 	itxg->itxg_itxs = NULL;
1897 	itxg->itxg_txg = 0;
1898 	mutex_exit(&itxg->itxg_lock);
1899 	/*
1900 	 * Preferably start a task queue to free up the old itxs but
1901 	 * if taskq_dispatch can't allocate resources to do that then
1902 	 * free it in-line. This should be rare. Note, using TQ_SLEEP
1903 	 * created a bad performance problem.
1904 	 */
1905 	ASSERT3P(zilog->zl_dmu_pool, !=, NULL);
1906 	ASSERT3P(zilog->zl_dmu_pool->dp_zil_clean_taskq, !=, NULL);
1907 	if (taskq_dispatch(zilog->zl_dmu_pool->dp_zil_clean_taskq,
1908 	    (void (*)(void *))zil_itxg_clean, clean_me, TQ_NOSLEEP) ==
1909 	    TASKQID_INVALID)
1910 		zil_itxg_clean(clean_me);
1911 }
1912 
1913 /*
1914  * This function will traverse the queue of itxs that need to be
1915  * committed, and move them onto the ZIL's zl_itx_commit_list.
1916  */
1917 static void
zil_get_commit_list(zilog_t * zilog)1918 zil_get_commit_list(zilog_t *zilog)
1919 {
1920 	uint64_t otxg, txg;
1921 	list_t *commit_list = &zilog->zl_itx_commit_list;
1922 
1923 	ASSERT(MUTEX_HELD(&zilog->zl_issuer_lock));
1924 
1925 	if (spa_freeze_txg(zilog->zl_spa) != UINT64_MAX) /* ziltest support */
1926 		otxg = ZILTEST_TXG;
1927 	else
1928 		otxg = spa_last_synced_txg(zilog->zl_spa) + 1;
1929 
1930 	/*
1931 	 * This is inherently racy, since there is nothing to prevent
1932 	 * the last synced txg from changing. That's okay since we'll
1933 	 * only commit things in the future.
1934 	 */
1935 	for (txg = otxg; txg < (otxg + TXG_CONCURRENT_STATES); txg++) {
1936 		itxg_t *itxg = &zilog->zl_itxg[txg & TXG_MASK];
1937 
1938 		mutex_enter(&itxg->itxg_lock);
1939 		if (itxg->itxg_txg != txg) {
1940 			mutex_exit(&itxg->itxg_lock);
1941 			continue;
1942 		}
1943 
1944 		/*
1945 		 * If we're adding itx records to the zl_itx_commit_list,
1946 		 * then the zil better be dirty in this "txg". We can assert
1947 		 * that here since we're holding the itxg_lock which will
1948 		 * prevent spa_sync from cleaning it. Once we add the itxs
1949 		 * to the zl_itx_commit_list we must commit it to disk even
1950 		 * if it's unnecessary (i.e. the txg was synced).
1951 		 */
1952 		ASSERT(zilog_is_dirty_in_txg(zilog, txg) ||
1953 		    spa_freeze_txg(zilog->zl_spa) != UINT64_MAX);
1954 		list_move_tail(commit_list, &itxg->itxg_itxs->i_sync_list);
1955 
1956 		mutex_exit(&itxg->itxg_lock);
1957 	}
1958 }
1959 
1960 /*
1961  * Move the async itxs for a specified object to commit into sync lists.
1962  */
1963 void
zil_async_to_sync(zilog_t * zilog,uint64_t foid)1964 zil_async_to_sync(zilog_t *zilog, uint64_t foid)
1965 {
1966 	uint64_t otxg, txg;
1967 	itx_async_node_t *ian;
1968 	avl_tree_t *t;
1969 	avl_index_t where;
1970 
1971 	if (spa_freeze_txg(zilog->zl_spa) != UINT64_MAX) /* ziltest support */
1972 		otxg = ZILTEST_TXG;
1973 	else
1974 		otxg = spa_last_synced_txg(zilog->zl_spa) + 1;
1975 
1976 	/*
1977 	 * This is inherently racy, since there is nothing to prevent
1978 	 * the last synced txg from changing.
1979 	 */
1980 	for (txg = otxg; txg < (otxg + TXG_CONCURRENT_STATES); txg++) {
1981 		itxg_t *itxg = &zilog->zl_itxg[txg & TXG_MASK];
1982 
1983 		mutex_enter(&itxg->itxg_lock);
1984 		if (itxg->itxg_txg != txg) {
1985 			mutex_exit(&itxg->itxg_lock);
1986 			continue;
1987 		}
1988 
1989 		/*
1990 		 * If a foid is specified then find that node and append its
1991 		 * list. Otherwise walk the tree appending all the lists
1992 		 * to the sync list. We add to the end rather than the
1993 		 * beginning to ensure the create has happened.
1994 		 */
1995 		t = &itxg->itxg_itxs->i_async_tree;
1996 		if (foid != 0) {
1997 			ian = avl_find(t, &foid, &where);
1998 			if (ian != NULL) {
1999 				list_move_tail(&itxg->itxg_itxs->i_sync_list,
2000 				    &ian->ia_list);
2001 			}
2002 		} else {
2003 			void *cookie = NULL;
2004 
2005 			while ((ian = avl_destroy_nodes(t, &cookie)) != NULL) {
2006 				list_move_tail(&itxg->itxg_itxs->i_sync_list,
2007 				    &ian->ia_list);
2008 				list_destroy(&ian->ia_list);
2009 				kmem_free(ian, sizeof (itx_async_node_t));
2010 			}
2011 		}
2012 		mutex_exit(&itxg->itxg_lock);
2013 	}
2014 }
2015 
2016 /*
2017  * This function will prune commit itxs that are at the head of the
2018  * commit list (it won't prune past the first non-commit itx), and
2019  * either: a) attach them to the last lwb that's still pending
2020  * completion, or b) skip them altogether.
2021  *
2022  * This is used as a performance optimization to prevent commit itxs
2023  * from generating new lwbs when it's unnecessary to do so.
2024  */
2025 static void
zil_prune_commit_list(zilog_t * zilog)2026 zil_prune_commit_list(zilog_t *zilog)
2027 {
2028 	itx_t *itx;
2029 
2030 	ASSERT(MUTEX_HELD(&zilog->zl_issuer_lock));
2031 
2032 	while (itx = list_head(&zilog->zl_itx_commit_list)) {
2033 		lr_t *lrc = &itx->itx_lr;
2034 		if (lrc->lrc_txtype != TX_COMMIT)
2035 			break;
2036 
2037 		mutex_enter(&zilog->zl_lock);
2038 
2039 		lwb_t *last_lwb = zilog->zl_last_lwb_opened;
2040 		if (last_lwb == NULL ||
2041 		    last_lwb->lwb_state == LWB_STATE_FLUSH_DONE) {
2042 			/*
2043 			 * All of the itxs this waiter was waiting on
2044 			 * must have already completed (or there were
2045 			 * never any itx's for it to wait on), so it's
2046 			 * safe to skip this waiter and mark it done.
2047 			 */
2048 			zil_commit_waiter_skip(itx->itx_private);
2049 		} else {
2050 			zil_commit_waiter_link_lwb(itx->itx_private, last_lwb);
2051 			itx->itx_private = NULL;
2052 		}
2053 
2054 		mutex_exit(&zilog->zl_lock);
2055 
2056 		list_remove(&zilog->zl_itx_commit_list, itx);
2057 		zil_itx_destroy(itx);
2058 	}
2059 
2060 	IMPLY(itx != NULL, itx->itx_lr.lrc_txtype != TX_COMMIT);
2061 }
2062 
2063 static void
zil_commit_writer_stall(zilog_t * zilog)2064 zil_commit_writer_stall(zilog_t *zilog)
2065 {
2066 	/*
2067 	 * When zio_alloc_zil() fails to allocate the next lwb block on
2068 	 * disk, we must call txg_wait_synced() to ensure all of the
2069 	 * lwbs in the zilog's zl_lwb_list are synced and then freed (in
2070 	 * zil_sync()), such that any subsequent ZIL writer (i.e. a call
2071 	 * to zil_process_commit_list()) will have to call zil_create(),
2072 	 * and start a new ZIL chain.
2073 	 *
2074 	 * Since zil_alloc_zil() failed, the lwb that was previously
2075 	 * issued does not have a pointer to the "next" lwb on disk.
2076 	 * Thus, if another ZIL writer thread was to allocate the "next"
2077 	 * on-disk lwb, that block could be leaked in the event of a
2078 	 * crash (because the previous lwb on-disk would not point to
2079 	 * it).
2080 	 *
2081 	 * We must hold the zilog's zl_issuer_lock while we do this, to
2082 	 * ensure no new threads enter zil_process_commit_list() until
2083 	 * all lwb's in the zl_lwb_list have been synced and freed
2084 	 * (which is achieved via the txg_wait_synced() call).
2085 	 */
2086 	ASSERT(MUTEX_HELD(&zilog->zl_issuer_lock));
2087 	txg_wait_synced(zilog->zl_dmu_pool, 0);
2088 	ASSERT3P(list_tail(&zilog->zl_lwb_list), ==, NULL);
2089 }
2090 
2091 /*
2092  * This function will traverse the commit list, creating new lwbs as
2093  * needed, and committing the itxs from the commit list to these newly
2094  * created lwbs. Additionally, as a new lwb is created, the previous
2095  * lwb will be issued to the zio layer to be written to disk.
2096  */
2097 static void
zil_process_commit_list(zilog_t * zilog)2098 zil_process_commit_list(zilog_t *zilog)
2099 {
2100 	spa_t *spa = zilog->zl_spa;
2101 	list_t nolwb_waiters;
2102 	lwb_t *lwb;
2103 	itx_t *itx;
2104 
2105 	ASSERT(MUTEX_HELD(&zilog->zl_issuer_lock));
2106 
2107 	/*
2108 	 * Return if there's nothing to commit before we dirty the fs by
2109 	 * calling zil_create().
2110 	 */
2111 	if (list_head(&zilog->zl_itx_commit_list) == NULL)
2112 		return;
2113 
2114 	list_create(&nolwb_waiters, sizeof (zil_commit_waiter_t),
2115 	    offsetof(zil_commit_waiter_t, zcw_node));
2116 
2117 	lwb = list_tail(&zilog->zl_lwb_list);
2118 	if (lwb == NULL) {
2119 		lwb = zil_create(zilog);
2120 	} else {
2121 		ASSERT3S(lwb->lwb_state, !=, LWB_STATE_ISSUED);
2122 		ASSERT3S(lwb->lwb_state, !=, LWB_STATE_WRITE_DONE);
2123 		ASSERT3S(lwb->lwb_state, !=, LWB_STATE_FLUSH_DONE);
2124 	}
2125 
2126 	while (itx = list_head(&zilog->zl_itx_commit_list)) {
2127 		lr_t *lrc = &itx->itx_lr;
2128 		uint64_t txg = lrc->lrc_txg;
2129 
2130 		ASSERT3U(txg, !=, 0);
2131 
2132 		if (lrc->lrc_txtype == TX_COMMIT) {
2133 			DTRACE_PROBE2(zil__process__commit__itx,
2134 			    zilog_t *, zilog, itx_t *, itx);
2135 		} else {
2136 			DTRACE_PROBE2(zil__process__normal__itx,
2137 			    zilog_t *, zilog, itx_t *, itx);
2138 		}
2139 
2140 		boolean_t synced = txg <= spa_last_synced_txg(spa);
2141 		boolean_t frozen = txg > spa_freeze_txg(spa);
2142 
2143 		/*
2144 		 * If the txg of this itx has already been synced out, then
2145 		 * we don't need to commit this itx to an lwb. This is
2146 		 * because the data of this itx will have already been
2147 		 * written to the main pool. This is inherently racy, and
2148 		 * it's still ok to commit an itx whose txg has already
2149 		 * been synced; this will result in a write that's
2150 		 * unnecessary, but will do no harm.
2151 		 *
2152 		 * With that said, we always want to commit TX_COMMIT itxs
2153 		 * to an lwb, regardless of whether or not that itx's txg
2154 		 * has been synced out. We do this to ensure any OPENED lwb
2155 		 * will always have at least one zil_commit_waiter_t linked
2156 		 * to the lwb.
2157 		 *
2158 		 * As a counter-example, if we skipped TX_COMMIT itx's
2159 		 * whose txg had already been synced, the following
2160 		 * situation could occur if we happened to be racing with
2161 		 * spa_sync:
2162 		 *
2163 		 * 1. we commit a non-TX_COMMIT itx to an lwb, where the
2164 		 *    itx's txg is 10 and the last synced txg is 9.
2165 		 * 2. spa_sync finishes syncing out txg 10.
2166 		 * 3. we move to the next itx in the list, it's a TX_COMMIT
2167 		 *    whose txg is 10, so we skip it rather than committing
2168 		 *    it to the lwb used in (1).
2169 		 *
2170 		 * If the itx that is skipped in (3) is the last TX_COMMIT
2171 		 * itx in the commit list, than it's possible for the lwb
2172 		 * used in (1) to remain in the OPENED state indefinitely.
2173 		 *
2174 		 * To prevent the above scenario from occuring, ensuring
2175 		 * that once an lwb is OPENED it will transition to ISSUED
2176 		 * and eventually DONE, we always commit TX_COMMIT itx's to
2177 		 * an lwb here, even if that itx's txg has already been
2178 		 * synced.
2179 		 *
2180 		 * Finally, if the pool is frozen, we _always_ commit the
2181 		 * itx.  The point of freezing the pool is to prevent data
2182 		 * from being written to the main pool via spa_sync, and
2183 		 * instead rely solely on the ZIL to persistently store the
2184 		 * data; i.e.  when the pool is frozen, the last synced txg
2185 		 * value can't be trusted.
2186 		 */
2187 		if (frozen || !synced || lrc->lrc_txtype == TX_COMMIT) {
2188 			if (lwb != NULL) {
2189 				lwb = zil_lwb_commit(zilog, itx, lwb);
2190 			} else if (lrc->lrc_txtype == TX_COMMIT) {
2191 				ASSERT3P(lwb, ==, NULL);
2192 				zil_commit_waiter_link_nolwb(
2193 				    itx->itx_private, &nolwb_waiters);
2194 			}
2195 		}
2196 
2197 		list_remove(&zilog->zl_itx_commit_list, itx);
2198 		zil_itx_destroy(itx);
2199 	}
2200 
2201 	if (lwb == NULL) {
2202 		/*
2203 		 * This indicates zio_alloc_zil() failed to allocate the
2204 		 * "next" lwb on-disk. When this happens, we must stall
2205 		 * the ZIL write pipeline; see the comment within
2206 		 * zil_commit_writer_stall() for more details.
2207 		 */
2208 		zil_commit_writer_stall(zilog);
2209 
2210 		/*
2211 		 * Additionally, we have to signal and mark the "nolwb"
2212 		 * waiters as "done" here, since without an lwb, we
2213 		 * can't do this via zil_lwb_flush_vdevs_done() like
2214 		 * normal.
2215 		 */
2216 		zil_commit_waiter_t *zcw;
2217 		while (zcw = list_head(&nolwb_waiters)) {
2218 			zil_commit_waiter_skip(zcw);
2219 			list_remove(&nolwb_waiters, zcw);
2220 		}
2221 	} else {
2222 		ASSERT(list_is_empty(&nolwb_waiters));
2223 		ASSERT3P(lwb, !=, NULL);
2224 		ASSERT3S(lwb->lwb_state, !=, LWB_STATE_ISSUED);
2225 		ASSERT3S(lwb->lwb_state, !=, LWB_STATE_WRITE_DONE);
2226 		ASSERT3S(lwb->lwb_state, !=, LWB_STATE_FLUSH_DONE);
2227 
2228 		/*
2229 		 * At this point, the ZIL block pointed at by the "lwb"
2230 		 * variable is in one of the following states: "closed"
2231 		 * or "open".
2232 		 *
2233 		 * If its "closed", then no itxs have been committed to
2234 		 * it, so there's no point in issuing its zio (i.e.
2235 		 * it's "empty").
2236 		 *
2237 		 * If its "open" state, then it contains one or more
2238 		 * itxs that eventually need to be committed to stable
2239 		 * storage. In this case we intentionally do not issue
2240 		 * the lwb's zio to disk yet, and instead rely on one of
2241 		 * the following two mechanisms for issuing the zio:
2242 		 *
2243 		 * 1. Ideally, there will be more ZIL activity occuring
2244 		 * on the system, such that this function will be
2245 		 * immediately called again (not necessarily by the same
2246 		 * thread) and this lwb's zio will be issued via
2247 		 * zil_lwb_commit(). This way, the lwb is guaranteed to
2248 		 * be "full" when it is issued to disk, and we'll make
2249 		 * use of the lwb's size the best we can.
2250 		 *
2251 		 * 2. If there isn't sufficient ZIL activity occuring on
2252 		 * the system, such that this lwb's zio isn't issued via
2253 		 * zil_lwb_commit(), zil_commit_waiter() will issue the
2254 		 * lwb's zio. If this occurs, the lwb is not guaranteed
2255 		 * to be "full" by the time its zio is issued, and means
2256 		 * the size of the lwb was "too large" given the amount
2257 		 * of ZIL activity occuring on the system at that time.
2258 		 *
2259 		 * We do this for a couple of reasons:
2260 		 *
2261 		 * 1. To try and reduce the number of IOPs needed to
2262 		 * write the same number of itxs. If an lwb has space
2263 		 * available in it's buffer for more itxs, and more itxs
2264 		 * will be committed relatively soon (relative to the
2265 		 * latency of performing a write), then it's beneficial
2266 		 * to wait for these "next" itxs. This way, more itxs
2267 		 * can be committed to stable storage with fewer writes.
2268 		 *
2269 		 * 2. To try and use the largest lwb block size that the
2270 		 * incoming rate of itxs can support. Again, this is to
2271 		 * try and pack as many itxs into as few lwbs as
2272 		 * possible, without significantly impacting the latency
2273 		 * of each individual itx.
2274 		 */
2275 	}
2276 }
2277 
2278 /*
2279  * This function is responsible for ensuring the passed in commit waiter
2280  * (and associated commit itx) is committed to an lwb. If the waiter is
2281  * not already committed to an lwb, all itxs in the zilog's queue of
2282  * itxs will be processed. The assumption is the passed in waiter's
2283  * commit itx will found in the queue just like the other non-commit
2284  * itxs, such that when the entire queue is processed, the waiter will
2285  * have been commited to an lwb.
2286  *
2287  * The lwb associated with the passed in waiter is not guaranteed to
2288  * have been issued by the time this function completes. If the lwb is
2289  * not issued, we rely on future calls to zil_commit_writer() to issue
2290  * the lwb, or the timeout mechanism found in zil_commit_waiter().
2291  */
2292 static void
zil_commit_writer(zilog_t * zilog,zil_commit_waiter_t * zcw)2293 zil_commit_writer(zilog_t *zilog, zil_commit_waiter_t *zcw)
2294 {
2295 	ASSERT(!MUTEX_HELD(&zilog->zl_lock));
2296 	ASSERT(spa_writeable(zilog->zl_spa));
2297 
2298 	mutex_enter(&zilog->zl_issuer_lock);
2299 
2300 	if (zcw->zcw_lwb != NULL || zcw->zcw_done) {
2301 		/*
2302 		 * It's possible that, while we were waiting to acquire
2303 		 * the "zl_issuer_lock", another thread committed this
2304 		 * waiter to an lwb. If that occurs, we bail out early,
2305 		 * without processing any of the zilog's queue of itxs.
2306 		 *
2307 		 * On certain workloads and system configurations, the
2308 		 * "zl_issuer_lock" can become highly contended. In an
2309 		 * attempt to reduce this contention, we immediately drop
2310 		 * the lock if the waiter has already been processed.
2311 		 *
2312 		 * We've measured this optimization to reduce CPU spent
2313 		 * contending on this lock by up to 5%, using a system
2314 		 * with 32 CPUs, low latency storage (~50 usec writes),
2315 		 * and 1024 threads performing sync writes.
2316 		 */
2317 		goto out;
2318 	}
2319 
2320 	zil_get_commit_list(zilog);
2321 	zil_prune_commit_list(zilog);
2322 	zil_process_commit_list(zilog);
2323 
2324 out:
2325 	mutex_exit(&zilog->zl_issuer_lock);
2326 }
2327 
2328 static void
zil_commit_waiter_timeout(zilog_t * zilog,zil_commit_waiter_t * zcw)2329 zil_commit_waiter_timeout(zilog_t *zilog, zil_commit_waiter_t *zcw)
2330 {
2331 	ASSERT(!MUTEX_HELD(&zilog->zl_issuer_lock));
2332 	ASSERT(MUTEX_HELD(&zcw->zcw_lock));
2333 	ASSERT3B(zcw->zcw_done, ==, B_FALSE);
2334 
2335 	lwb_t *lwb = zcw->zcw_lwb;
2336 	ASSERT3P(lwb, !=, NULL);
2337 	ASSERT3S(lwb->lwb_state, !=, LWB_STATE_CLOSED);
2338 
2339 	/*
2340 	 * If the lwb has already been issued by another thread, we can
2341 	 * immediately return since there's no work to be done (the
2342 	 * point of this function is to issue the lwb). Additionally, we
2343 	 * do this prior to acquiring the zl_issuer_lock, to avoid
2344 	 * acquiring it when it's not necessary to do so.
2345 	 */
2346 	if (lwb->lwb_state == LWB_STATE_ISSUED ||
2347 	    lwb->lwb_state == LWB_STATE_WRITE_DONE ||
2348 	    lwb->lwb_state == LWB_STATE_FLUSH_DONE)
2349 		return;
2350 
2351 	/*
2352 	 * In order to call zil_lwb_write_issue() we must hold the
2353 	 * zilog's "zl_issuer_lock". We can't simply acquire that lock,
2354 	 * since we're already holding the commit waiter's "zcw_lock",
2355 	 * and those two locks are aquired in the opposite order
2356 	 * elsewhere.
2357 	 */
2358 	mutex_exit(&zcw->zcw_lock);
2359 	mutex_enter(&zilog->zl_issuer_lock);
2360 	mutex_enter(&zcw->zcw_lock);
2361 
2362 	/*
2363 	 * Since we just dropped and re-acquired the commit waiter's
2364 	 * lock, we have to re-check to see if the waiter was marked
2365 	 * "done" during that process. If the waiter was marked "done",
2366 	 * the "lwb" pointer is no longer valid (it can be free'd after
2367 	 * the waiter is marked "done"), so without this check we could
2368 	 * wind up with a use-after-free error below.
2369 	 */
2370 	if (zcw->zcw_done)
2371 		goto out;
2372 
2373 	ASSERT3P(lwb, ==, zcw->zcw_lwb);
2374 
2375 	/*
2376 	 * We've already checked this above, but since we hadn't acquired
2377 	 * the zilog's zl_issuer_lock, we have to perform this check a
2378 	 * second time while holding the lock.
2379 	 *
2380 	 * We don't need to hold the zl_lock since the lwb cannot transition
2381 	 * from OPENED to ISSUED while we hold the zl_issuer_lock. The lwb
2382 	 * _can_ transition from ISSUED to DONE, but it's OK to race with
2383 	 * that transition since we treat the lwb the same, whether it's in
2384 	 * the ISSUED or DONE states.
2385 	 *
2386 	 * The important thing, is we treat the lwb differently depending on
2387 	 * if it's ISSUED or OPENED, and block any other threads that might
2388 	 * attempt to issue this lwb. For that reason we hold the
2389 	 * zl_issuer_lock when checking the lwb_state; we must not call
2390 	 * zil_lwb_write_issue() if the lwb had already been issued.
2391 	 *
2392 	 * See the comment above the lwb_state_t structure definition for
2393 	 * more details on the lwb states, and locking requirements.
2394 	 */
2395 	if (lwb->lwb_state == LWB_STATE_ISSUED ||
2396 	    lwb->lwb_state == LWB_STATE_WRITE_DONE ||
2397 	    lwb->lwb_state == LWB_STATE_FLUSH_DONE)
2398 		goto out;
2399 
2400 	ASSERT3S(lwb->lwb_state, ==, LWB_STATE_OPENED);
2401 
2402 	/*
2403 	 * As described in the comments above zil_commit_waiter() and
2404 	 * zil_process_commit_list(), we need to issue this lwb's zio
2405 	 * since we've reached the commit waiter's timeout and it still
2406 	 * hasn't been issued.
2407 	 */
2408 	lwb_t *nlwb = zil_lwb_write_issue(zilog, lwb);
2409 
2410 	IMPLY(nlwb != NULL, lwb->lwb_state != LWB_STATE_OPENED);
2411 
2412 	/*
2413 	 * Since the lwb's zio hadn't been issued by the time this thread
2414 	 * reached its timeout, we reset the zilog's "zl_cur_used" field
2415 	 * to influence the zil block size selection algorithm.
2416 	 *
2417 	 * By having to issue the lwb's zio here, it means the size of the
2418 	 * lwb was too large, given the incoming throughput of itxs.  By
2419 	 * setting "zl_cur_used" to zero, we communicate this fact to the
2420 	 * block size selection algorithm, so it can take this informaiton
2421 	 * into account, and potentially select a smaller size for the
2422 	 * next lwb block that is allocated.
2423 	 */
2424 	zilog->zl_cur_used = 0;
2425 
2426 	if (nlwb == NULL) {
2427 		/*
2428 		 * When zil_lwb_write_issue() returns NULL, this
2429 		 * indicates zio_alloc_zil() failed to allocate the
2430 		 * "next" lwb on-disk. When this occurs, the ZIL write
2431 		 * pipeline must be stalled; see the comment within the
2432 		 * zil_commit_writer_stall() function for more details.
2433 		 *
2434 		 * We must drop the commit waiter's lock prior to
2435 		 * calling zil_commit_writer_stall() or else we can wind
2436 		 * up with the following deadlock:
2437 		 *
2438 		 * - This thread is waiting for the txg to sync while
2439 		 *   holding the waiter's lock; txg_wait_synced() is
2440 		 *   used within txg_commit_writer_stall().
2441 		 *
2442 		 * - The txg can't sync because it is waiting for this
2443 		 *   lwb's zio callback to call dmu_tx_commit().
2444 		 *
2445 		 * - The lwb's zio callback can't call dmu_tx_commit()
2446 		 *   because it's blocked trying to acquire the waiter's
2447 		 *   lock, which occurs prior to calling dmu_tx_commit()
2448 		 */
2449 		mutex_exit(&zcw->zcw_lock);
2450 		zil_commit_writer_stall(zilog);
2451 		mutex_enter(&zcw->zcw_lock);
2452 	}
2453 
2454 out:
2455 	mutex_exit(&zilog->zl_issuer_lock);
2456 	ASSERT(MUTEX_HELD(&zcw->zcw_lock));
2457 }
2458 
2459 /*
2460  * This function is responsible for performing the following two tasks:
2461  *
2462  * 1. its primary responsibility is to block until the given "commit
2463  *    waiter" is considered "done".
2464  *
2465  * 2. its secondary responsibility is to issue the zio for the lwb that
2466  *    the given "commit waiter" is waiting on, if this function has
2467  *    waited "long enough" and the lwb is still in the "open" state.
2468  *
2469  * Given a sufficient amount of itxs being generated and written using
2470  * the ZIL, the lwb's zio will be issued via the zil_lwb_commit()
2471  * function. If this does not occur, this secondary responsibility will
2472  * ensure the lwb is issued even if there is not other synchronous
2473  * activity on the system.
2474  *
2475  * For more details, see zil_process_commit_list(); more specifically,
2476  * the comment at the bottom of that function.
2477  */
2478 static void
zil_commit_waiter(zilog_t * zilog,zil_commit_waiter_t * zcw)2479 zil_commit_waiter(zilog_t *zilog, zil_commit_waiter_t *zcw)
2480 {
2481 	ASSERT(!MUTEX_HELD(&zilog->zl_lock));
2482 	ASSERT(!MUTEX_HELD(&zilog->zl_issuer_lock));
2483 	ASSERT(spa_writeable(zilog->zl_spa));
2484 
2485 	mutex_enter(&zcw->zcw_lock);
2486 
2487 	/*
2488 	 * The timeout is scaled based on the lwb latency to avoid
2489 	 * significantly impacting the latency of each individual itx.
2490 	 * For more details, see the comment at the bottom of the
2491 	 * zil_process_commit_list() function.
2492 	 */
2493 	int pct = MAX(zfs_commit_timeout_pct, 1);
2494 	hrtime_t sleep = (zilog->zl_last_lwb_latency * pct) / 100;
2495 	hrtime_t wakeup = gethrtime() + sleep;
2496 	boolean_t timedout = B_FALSE;
2497 
2498 	while (!zcw->zcw_done) {
2499 		ASSERT(MUTEX_HELD(&zcw->zcw_lock));
2500 
2501 		lwb_t *lwb = zcw->zcw_lwb;
2502 
2503 		/*
2504 		 * Usually, the waiter will have a non-NULL lwb field here,
2505 		 * but it's possible for it to be NULL as a result of
2506 		 * zil_commit() racing with spa_sync().
2507 		 *
2508 		 * When zil_clean() is called, it's possible for the itxg
2509 		 * list (which may be cleaned via a taskq) to contain
2510 		 * commit itxs. When this occurs, the commit waiters linked
2511 		 * off of these commit itxs will not be committed to an
2512 		 * lwb.  Additionally, these commit waiters will not be
2513 		 * marked done until zil_commit_waiter_skip() is called via
2514 		 * zil_itxg_clean().
2515 		 *
2516 		 * Thus, it's possible for this commit waiter (i.e. the
2517 		 * "zcw" variable) to be found in this "in between" state;
2518 		 * where it's "zcw_lwb" field is NULL, and it hasn't yet
2519 		 * been skipped, so it's "zcw_done" field is still B_FALSE.
2520 		 */
2521 		IMPLY(lwb != NULL, lwb->lwb_state != LWB_STATE_CLOSED);
2522 
2523 		if (lwb != NULL && lwb->lwb_state == LWB_STATE_OPENED) {
2524 			ASSERT3B(timedout, ==, B_FALSE);
2525 
2526 			/*
2527 			 * If the lwb hasn't been issued yet, then we
2528 			 * need to wait with a timeout, in case this
2529 			 * function needs to issue the lwb after the
2530 			 * timeout is reached; responsibility (2) from
2531 			 * the comment above this function.
2532 			 */
2533 			clock_t timeleft = cv_timedwait_hires(&zcw->zcw_cv,
2534 			    &zcw->zcw_lock, wakeup, USEC2NSEC(1),
2535 			    CALLOUT_FLAG_ABSOLUTE);
2536 
2537 			if (timeleft >= 0 || zcw->zcw_done)
2538 				continue;
2539 
2540 			timedout = B_TRUE;
2541 			zil_commit_waiter_timeout(zilog, zcw);
2542 
2543 			if (!zcw->zcw_done) {
2544 				/*
2545 				 * If the commit waiter has already been
2546 				 * marked "done", it's possible for the
2547 				 * waiter's lwb structure to have already
2548 				 * been freed.  Thus, we can only reliably
2549 				 * make these assertions if the waiter
2550 				 * isn't done.
2551 				 */
2552 				ASSERT3P(lwb, ==, zcw->zcw_lwb);
2553 				ASSERT3S(lwb->lwb_state, !=, LWB_STATE_OPENED);
2554 			}
2555 		} else {
2556 			/*
2557 			 * If the lwb isn't open, then it must have already
2558 			 * been issued. In that case, there's no need to
2559 			 * use a timeout when waiting for the lwb to
2560 			 * complete.
2561 			 *
2562 			 * Additionally, if the lwb is NULL, the waiter
2563 			 * will soon be signalled and marked done via
2564 			 * zil_clean() and zil_itxg_clean(), so no timeout
2565 			 * is required.
2566 			 */
2567 
2568 			IMPLY(lwb != NULL,
2569 			    lwb->lwb_state == LWB_STATE_ISSUED ||
2570 			    lwb->lwb_state == LWB_STATE_WRITE_DONE ||
2571 			    lwb->lwb_state == LWB_STATE_FLUSH_DONE);
2572 			cv_wait(&zcw->zcw_cv, &zcw->zcw_lock);
2573 		}
2574 	}
2575 
2576 	mutex_exit(&zcw->zcw_lock);
2577 }
2578 
2579 static zil_commit_waiter_t *
zil_alloc_commit_waiter()2580 zil_alloc_commit_waiter()
2581 {
2582 	zil_commit_waiter_t *zcw = kmem_cache_alloc(zil_zcw_cache, KM_SLEEP);
2583 
2584 	cv_init(&zcw->zcw_cv, NULL, CV_DEFAULT, NULL);
2585 	mutex_init(&zcw->zcw_lock, NULL, MUTEX_DEFAULT, NULL);
2586 	list_link_init(&zcw->zcw_node);
2587 	zcw->zcw_lwb = NULL;
2588 	zcw->zcw_done = B_FALSE;
2589 	zcw->zcw_zio_error = 0;
2590 
2591 	return (zcw);
2592 }
2593 
2594 static void
zil_free_commit_waiter(zil_commit_waiter_t * zcw)2595 zil_free_commit_waiter(zil_commit_waiter_t *zcw)
2596 {
2597 	ASSERT(!list_link_active(&zcw->zcw_node));
2598 	ASSERT3P(zcw->zcw_lwb, ==, NULL);
2599 	ASSERT3B(zcw->zcw_done, ==, B_TRUE);
2600 	mutex_destroy(&zcw->zcw_lock);
2601 	cv_destroy(&zcw->zcw_cv);
2602 	kmem_cache_free(zil_zcw_cache, zcw);
2603 }
2604 
2605 /*
2606  * This function is used to create a TX_COMMIT itx and assign it. This
2607  * way, it will be linked into the ZIL's list of synchronous itxs, and
2608  * then later committed to an lwb (or skipped) when
2609  * zil_process_commit_list() is called.
2610  */
2611 static void
zil_commit_itx_assign(zilog_t * zilog,zil_commit_waiter_t * zcw)2612 zil_commit_itx_assign(zilog_t *zilog, zil_commit_waiter_t *zcw)
2613 {
2614 	dmu_tx_t *tx = dmu_tx_create(zilog->zl_os);
2615 	VERIFY0(dmu_tx_assign(tx, TXG_WAIT));
2616 
2617 	itx_t *itx = zil_itx_create(TX_COMMIT, sizeof (lr_t));
2618 	itx->itx_sync = B_TRUE;
2619 	itx->itx_private = zcw;
2620 
2621 	zil_itx_assign(zilog, itx, tx);
2622 
2623 	dmu_tx_commit(tx);
2624 }
2625 
2626 /*
2627  * Commit ZFS Intent Log transactions (itxs) to stable storage.
2628  *
2629  * When writing ZIL transactions to the on-disk representation of the
2630  * ZIL, the itxs are committed to a Log Write Block (lwb). Multiple
2631  * itxs can be committed to a single lwb. Once a lwb is written and
2632  * committed to stable storage (i.e. the lwb is written, and vdevs have
2633  * been flushed), each itx that was committed to that lwb is also
2634  * considered to be committed to stable storage.
2635  *
2636  * When an itx is committed to an lwb, the log record (lr_t) contained
2637  * by the itx is copied into the lwb's zio buffer, and once this buffer
2638  * is written to disk, it becomes an on-disk ZIL block.
2639  *
2640  * As itxs are generated, they're inserted into the ZIL's queue of
2641  * uncommitted itxs. The semantics of zil_commit() are such that it will
2642  * block until all itxs that were in the queue when it was called, are
2643  * committed to stable storage.
2644  *
2645  * If "foid" is zero, this means all "synchronous" and "asynchronous"
2646  * itxs, for all objects in the dataset, will be committed to stable
2647  * storage prior to zil_commit() returning. If "foid" is non-zero, all
2648  * "synchronous" itxs for all objects, but only "asynchronous" itxs
2649  * that correspond to the foid passed in, will be committed to stable
2650  * storage prior to zil_commit() returning.
2651  *
2652  * Generally speaking, when zil_commit() is called, the consumer doesn't
2653  * actually care about _all_ of the uncommitted itxs. Instead, they're
2654  * simply trying to waiting for a specific itx to be committed to disk,
2655  * but the interface(s) for interacting with the ZIL don't allow such
2656  * fine-grained communication. A better interface would allow a consumer
2657  * to create and assign an itx, and then pass a reference to this itx to
2658  * zil_commit(); such that zil_commit() would return as soon as that
2659  * specific itx was committed to disk (instead of waiting for _all_
2660  * itxs to be committed).
2661  *
2662  * When a thread calls zil_commit() a special "commit itx" will be
2663  * generated, along with a corresponding "waiter" for this commit itx.
2664  * zil_commit() will wait on this waiter's CV, such that when the waiter
2665  * is marked done, and signalled, zil_commit() will return.
2666  *
2667  * This commit itx is inserted into the queue of uncommitted itxs. This
2668  * provides an easy mechanism for determining which itxs were in the
2669  * queue prior to zil_commit() having been called, and which itxs were
2670  * added after zil_commit() was called.
2671  *
2672  * The commit it is special; it doesn't have any on-disk representation.
2673  * When a commit itx is "committed" to an lwb, the waiter associated
2674  * with it is linked onto the lwb's list of waiters. Then, when that lwb
2675  * completes, each waiter on the lwb's list is marked done and signalled
2676  * -- allowing the thread waiting on the waiter to return from zil_commit().
2677  *
2678  * It's important to point out a few critical factors that allow us
2679  * to make use of the commit itxs, commit waiters, per-lwb lists of
2680  * commit waiters, and zio completion callbacks like we're doing:
2681  *
2682  *   1. The list of waiters for each lwb is traversed, and each commit
2683  *      waiter is marked "done" and signalled, in the zio completion
2684  *      callback of the lwb's zio[*].
2685  *
2686  *      * Actually, the waiters are signalled in the zio completion
2687  *        callback of the root zio for the DKIOCFLUSHWRITECACHE commands
2688  *        that are sent to the vdevs upon completion of the lwb zio.
2689  *
2690  *   2. When the itxs are inserted into the ZIL's queue of uncommitted
2691  *      itxs, the order in which they are inserted is preserved[*]; as
2692  *      itxs are added to the queue, they are added to the tail of
2693  *      in-memory linked lists.
2694  *
2695  *      When committing the itxs to lwbs (to be written to disk), they
2696  *      are committed in the same order in which the itxs were added to
2697  *      the uncommitted queue's linked list(s); i.e. the linked list of
2698  *      itxs to commit is traversed from head to tail, and each itx is
2699  *      committed to an lwb in that order.
2700  *
2701  *      * To clarify:
2702  *
2703  *        - the order of "sync" itxs is preserved w.r.t. other
2704  *          "sync" itxs, regardless of the corresponding objects.
2705  *        - the order of "async" itxs is preserved w.r.t. other
2706  *          "async" itxs corresponding to the same object.
2707  *        - the order of "async" itxs is *not* preserved w.r.t. other
2708  *          "async" itxs corresponding to different objects.
2709  *        - the order of "sync" itxs w.r.t. "async" itxs (or vice
2710  *          versa) is *not* preserved, even for itxs that correspond
2711  *          to the same object.
2712  *
2713  *      For more details, see: zil_itx_assign(), zil_async_to_sync(),
2714  *      zil_get_commit_list(), and zil_process_commit_list().
2715  *
2716  *   3. The lwbs represent a linked list of blocks on disk. Thus, any
2717  *      lwb cannot be considered committed to stable storage, until its
2718  *      "previous" lwb is also committed to stable storage. This fact,
2719  *      coupled with the fact described above, means that itxs are
2720  *      committed in (roughly) the order in which they were generated.
2721  *      This is essential because itxs are dependent on prior itxs.
2722  *      Thus, we *must not* deem an itx as being committed to stable
2723  *      storage, until *all* prior itxs have also been committed to
2724  *      stable storage.
2725  *
2726  *      To enforce this ordering of lwb zio's, while still leveraging as
2727  *      much of the underlying storage performance as possible, we rely
2728  *      on two fundamental concepts:
2729  *
2730  *          1. The creation and issuance of lwb zio's is protected by
2731  *             the zilog's "zl_issuer_lock", which ensures only a single
2732  *             thread is creating and/or issuing lwb's at a time
2733  *          2. The "previous" lwb is a child of the "current" lwb
2734  *             (leveraging the zio parent-child depenency graph)
2735  *
2736  *      By relying on this parent-child zio relationship, we can have
2737  *      many lwb zio's concurrently issued to the underlying storage,
2738  *      but the order in which they complete will be the same order in
2739  *      which they were created.
2740  */
2741 void
zil_commit(zilog_t * zilog,uint64_t foid)2742 zil_commit(zilog_t *zilog, uint64_t foid)
2743 {
2744 	/*
2745 	 * We should never attempt to call zil_commit on a snapshot for
2746 	 * a couple of reasons:
2747 	 *
2748 	 * 1. A snapshot may never be modified, thus it cannot have any
2749 	 *    in-flight itxs that would have modified the dataset.
2750 	 *
2751 	 * 2. By design, when zil_commit() is called, a commit itx will
2752 	 *    be assigned to this zilog; as a result, the zilog will be
2753 	 *    dirtied. We must not dirty the zilog of a snapshot; there's
2754 	 *    checks in the code that enforce this invariant, and will
2755 	 *    cause a panic if it's not upheld.
2756 	 */
2757 	ASSERT3B(dmu_objset_is_snapshot(zilog->zl_os), ==, B_FALSE);
2758 
2759 	if (zilog->zl_sync == ZFS_SYNC_DISABLED)
2760 		return;
2761 
2762 	if (!spa_writeable(zilog->zl_spa)) {
2763 		/*
2764 		 * If the SPA is not writable, there should never be any
2765 		 * pending itxs waiting to be committed to disk. If that
2766 		 * weren't true, we'd skip writing those itxs out, and
2767 		 * would break the sematics of zil_commit(); thus, we're
2768 		 * verifying that truth before we return to the caller.
2769 		 */
2770 		ASSERT(list_is_empty(&zilog->zl_lwb_list));
2771 		ASSERT3P(zilog->zl_last_lwb_opened, ==, NULL);
2772 		for (int i = 0; i < TXG_SIZE; i++)
2773 			ASSERT3P(zilog->zl_itxg[i].itxg_itxs, ==, NULL);
2774 		return;
2775 	}
2776 
2777 	/*
2778 	 * If the ZIL is suspended, we don't want to dirty it by calling
2779 	 * zil_commit_itx_assign() below, nor can we write out
2780 	 * lwbs like would be done in zil_commit_write(). Thus, we
2781 	 * simply rely on txg_wait_synced() to maintain the necessary
2782 	 * semantics, and avoid calling those functions altogether.
2783 	 */
2784 	if (zilog->zl_suspend > 0) {
2785 		txg_wait_synced(zilog->zl_dmu_pool, 0);
2786 		return;
2787 	}
2788 
2789 	zil_commit_impl(zilog, foid);
2790 }
2791 
2792 void
zil_commit_impl(zilog_t * zilog,uint64_t foid)2793 zil_commit_impl(zilog_t *zilog, uint64_t foid)
2794 {
2795 	/*
2796 	 * Move the "async" itxs for the specified foid to the "sync"
2797 	 * queues, such that they will be later committed (or skipped)
2798 	 * to an lwb when zil_process_commit_list() is called.
2799 	 *
2800 	 * Since these "async" itxs must be committed prior to this
2801 	 * call to zil_commit returning, we must perform this operation
2802 	 * before we call zil_commit_itx_assign().
2803 	 */
2804 	zil_async_to_sync(zilog, foid);
2805 
2806 	/*
2807 	 * We allocate a new "waiter" structure which will initially be
2808 	 * linked to the commit itx using the itx's "itx_private" field.
2809 	 * Since the commit itx doesn't represent any on-disk state,
2810 	 * when it's committed to an lwb, rather than copying the its
2811 	 * lr_t into the lwb's buffer, the commit itx's "waiter" will be
2812 	 * added to the lwb's list of waiters. Then, when the lwb is
2813 	 * committed to stable storage, each waiter in the lwb's list of
2814 	 * waiters will be marked "done", and signalled.
2815 	 *
2816 	 * We must create the waiter and assign the commit itx prior to
2817 	 * calling zil_commit_writer(), or else our specific commit itx
2818 	 * is not guaranteed to be committed to an lwb prior to calling
2819 	 * zil_commit_waiter().
2820 	 */
2821 	zil_commit_waiter_t *zcw = zil_alloc_commit_waiter();
2822 	zil_commit_itx_assign(zilog, zcw);
2823 
2824 	zil_commit_writer(zilog, zcw);
2825 	zil_commit_waiter(zilog, zcw);
2826 
2827 	if (zcw->zcw_zio_error != 0) {
2828 		/*
2829 		 * If there was an error writing out the ZIL blocks that
2830 		 * this thread is waiting on, then we fallback to
2831 		 * relying on spa_sync() to write out the data this
2832 		 * thread is waiting on. Obviously this has performance
2833 		 * implications, but the expectation is for this to be
2834 		 * an exceptional case, and shouldn't occur often.
2835 		 */
2836 		DTRACE_PROBE2(zil__commit__io__error,
2837 		    zilog_t *, zilog, zil_commit_waiter_t *, zcw);
2838 		txg_wait_synced(zilog->zl_dmu_pool, 0);
2839 	}
2840 
2841 	zil_free_commit_waiter(zcw);
2842 }
2843 
2844 /*
2845  * Called in syncing context to free committed log blocks and update log header.
2846  */
2847 void
zil_sync(zilog_t * zilog,dmu_tx_t * tx)2848 zil_sync(zilog_t *zilog, dmu_tx_t *tx)
2849 {
2850 	zil_header_t *zh = zil_header_in_syncing_context(zilog);
2851 	uint64_t txg = dmu_tx_get_txg(tx);
2852 	spa_t *spa = zilog->zl_spa;
2853 	uint64_t *replayed_seq = &zilog->zl_replayed_seq[txg & TXG_MASK];
2854 	lwb_t *lwb;
2855 
2856 	/*
2857 	 * We don't zero out zl_destroy_txg, so make sure we don't try
2858 	 * to destroy it twice.
2859 	 */
2860 	if (spa_sync_pass(spa) != 1)
2861 		return;
2862 
2863 	mutex_enter(&zilog->zl_lock);
2864 
2865 	ASSERT(zilog->zl_stop_sync == 0);
2866 
2867 	if (*replayed_seq != 0) {
2868 		ASSERT(zh->zh_replay_seq < *replayed_seq);
2869 		zh->zh_replay_seq = *replayed_seq;
2870 		*replayed_seq = 0;
2871 	}
2872 
2873 	if (zilog->zl_destroy_txg == txg) {
2874 		blkptr_t blk = zh->zh_log;
2875 
2876 		ASSERT(list_head(&zilog->zl_lwb_list) == NULL);
2877 
2878 		bzero(zh, sizeof (zil_header_t));
2879 		bzero(zilog->zl_replayed_seq, sizeof (zilog->zl_replayed_seq));
2880 
2881 		if (zilog->zl_keep_first) {
2882 			/*
2883 			 * If this block was part of log chain that couldn't
2884 			 * be claimed because a device was missing during
2885 			 * zil_claim(), but that device later returns,
2886 			 * then this block could erroneously appear valid.
2887 			 * To guard against this, assign a new GUID to the new
2888 			 * log chain so it doesn't matter what blk points to.
2889 			 */
2890 			zil_init_log_chain(zilog, &blk);
2891 			zh->zh_log = blk;
2892 		}
2893 	}
2894 
2895 	while ((lwb = list_head(&zilog->zl_lwb_list)) != NULL) {
2896 		zh->zh_log = lwb->lwb_blk;
2897 		if (lwb->lwb_buf != NULL || lwb->lwb_max_txg > txg)
2898 			break;
2899 		list_remove(&zilog->zl_lwb_list, lwb);
2900 		zio_free(spa, txg, &lwb->lwb_blk);
2901 		zil_free_lwb(zilog, lwb);
2902 
2903 		/*
2904 		 * If we don't have anything left in the lwb list then
2905 		 * we've had an allocation failure and we need to zero
2906 		 * out the zil_header blkptr so that we don't end
2907 		 * up freeing the same block twice.
2908 		 */
2909 		if (list_head(&zilog->zl_lwb_list) == NULL)
2910 			BP_ZERO(&zh->zh_log);
2911 	}
2912 	mutex_exit(&zilog->zl_lock);
2913 }
2914 
2915 /* ARGSUSED */
2916 static int
zil_lwb_cons(void * vbuf,void * unused,int kmflag)2917 zil_lwb_cons(void *vbuf, void *unused, int kmflag)
2918 {
2919 	lwb_t *lwb = vbuf;
2920 	list_create(&lwb->lwb_waiters, sizeof (zil_commit_waiter_t),
2921 	    offsetof(zil_commit_waiter_t, zcw_node));
2922 	avl_create(&lwb->lwb_vdev_tree, zil_lwb_vdev_compare,
2923 	    sizeof (zil_vdev_node_t), offsetof(zil_vdev_node_t, zv_node));
2924 	mutex_init(&lwb->lwb_vdev_lock, NULL, MUTEX_DEFAULT, NULL);
2925 	return (0);
2926 }
2927 
2928 /* ARGSUSED */
2929 static void
zil_lwb_dest(void * vbuf,void * unused)2930 zil_lwb_dest(void *vbuf, void *unused)
2931 {
2932 	lwb_t *lwb = vbuf;
2933 	mutex_destroy(&lwb->lwb_vdev_lock);
2934 	avl_destroy(&lwb->lwb_vdev_tree);
2935 	list_destroy(&lwb->lwb_waiters);
2936 }
2937 
2938 void
zil_init(void)2939 zil_init(void)
2940 {
2941 	zil_lwb_cache = kmem_cache_create("zil_lwb_cache",
2942 	    sizeof (lwb_t), 0, zil_lwb_cons, zil_lwb_dest, NULL, NULL, NULL, 0);
2943 
2944 	zil_zcw_cache = kmem_cache_create("zil_zcw_cache",
2945 	    sizeof (zil_commit_waiter_t), 0, NULL, NULL, NULL, NULL, NULL, 0);
2946 }
2947 
2948 void
zil_fini(void)2949 zil_fini(void)
2950 {
2951 	kmem_cache_destroy(zil_zcw_cache);
2952 	kmem_cache_destroy(zil_lwb_cache);
2953 }
2954 
2955 void
zil_set_sync(zilog_t * zilog,uint64_t sync)2956 zil_set_sync(zilog_t *zilog, uint64_t sync)
2957 {
2958 	zilog->zl_sync = sync;
2959 }
2960 
2961 void
zil_set_logbias(zilog_t * zilog,uint64_t logbias)2962 zil_set_logbias(zilog_t *zilog, uint64_t logbias)
2963 {
2964 	zilog->zl_logbias = logbias;
2965 }
2966 
2967 zilog_t *
zil_alloc(objset_t * os,zil_header_t * zh_phys)2968 zil_alloc(objset_t *os, zil_header_t *zh_phys)
2969 {
2970 	zilog_t *zilog;
2971 
2972 	zilog = kmem_zalloc(sizeof (zilog_t), KM_SLEEP);
2973 
2974 	zilog->zl_header = zh_phys;
2975 	zilog->zl_os = os;
2976 	zilog->zl_spa = dmu_objset_spa(os);
2977 	zilog->zl_dmu_pool = dmu_objset_pool(os);
2978 	zilog->zl_destroy_txg = TXG_INITIAL - 1;
2979 	zilog->zl_logbias = dmu_objset_logbias(os);
2980 	zilog->zl_sync = dmu_objset_syncprop(os);
2981 	zilog->zl_dirty_max_txg = 0;
2982 	zilog->zl_last_lwb_opened = NULL;
2983 	zilog->zl_last_lwb_latency = 0;
2984 
2985 	mutex_init(&zilog->zl_lock, NULL, MUTEX_DEFAULT, NULL);
2986 	mutex_init(&zilog->zl_issuer_lock, NULL, MUTEX_DEFAULT, NULL);
2987 
2988 	for (int i = 0; i < TXG_SIZE; i++) {
2989 		mutex_init(&zilog->zl_itxg[i].itxg_lock, NULL,
2990 		    MUTEX_DEFAULT, NULL);
2991 	}
2992 
2993 	list_create(&zilog->zl_lwb_list, sizeof (lwb_t),
2994 	    offsetof(lwb_t, lwb_node));
2995 
2996 	list_create(&zilog->zl_itx_commit_list, sizeof (itx_t),
2997 	    offsetof(itx_t, itx_node));
2998 
2999 	cv_init(&zilog->zl_cv_suspend, NULL, CV_DEFAULT, NULL);
3000 
3001 	return (zilog);
3002 }
3003 
3004 void
zil_free(zilog_t * zilog)3005 zil_free(zilog_t *zilog)
3006 {
3007 	zilog->zl_stop_sync = 1;
3008 
3009 	ASSERT0(zilog->zl_suspend);
3010 	ASSERT0(zilog->zl_suspending);
3011 
3012 	ASSERT(list_is_empty(&zilog->zl_lwb_list));
3013 	list_destroy(&zilog->zl_lwb_list);
3014 
3015 	ASSERT(list_is_empty(&zilog->zl_itx_commit_list));
3016 	list_destroy(&zilog->zl_itx_commit_list);
3017 
3018 	for (int i = 0; i < TXG_SIZE; i++) {
3019 		/*
3020 		 * It's possible for an itx to be generated that doesn't dirty
3021 		 * a txg (e.g. ztest TX_TRUNCATE). So there's no zil_clean()
3022 		 * callback to remove the entry. We remove those here.
3023 		 *
3024 		 * Also free up the ziltest itxs.
3025 		 */
3026 		if (zilog->zl_itxg[i].itxg_itxs)
3027 			zil_itxg_clean(zilog->zl_itxg[i].itxg_itxs);
3028 		mutex_destroy(&zilog->zl_itxg[i].itxg_lock);
3029 	}
3030 
3031 	mutex_destroy(&zilog->zl_issuer_lock);
3032 	mutex_destroy(&zilog->zl_lock);
3033 
3034 	cv_destroy(&zilog->zl_cv_suspend);
3035 
3036 	kmem_free(zilog, sizeof (zilog_t));
3037 }
3038 
3039 /*
3040  * Open an intent log.
3041  */
3042 zilog_t *
zil_open(objset_t * os,zil_get_data_t * get_data)3043 zil_open(objset_t *os, zil_get_data_t *get_data)
3044 {
3045 	zilog_t *zilog = dmu_objset_zil(os);
3046 
3047 	ASSERT3P(zilog->zl_get_data, ==, NULL);
3048 	ASSERT3P(zilog->zl_last_lwb_opened, ==, NULL);
3049 	ASSERT(list_is_empty(&zilog->zl_lwb_list));
3050 
3051 	zilog->zl_get_data = get_data;
3052 
3053 	return (zilog);
3054 }
3055 
3056 /*
3057  * Close an intent log.
3058  */
3059 void
zil_close(zilog_t * zilog)3060 zil_close(zilog_t *zilog)
3061 {
3062 	lwb_t *lwb;
3063 	uint64_t txg;
3064 
3065 	if (!dmu_objset_is_snapshot(zilog->zl_os)) {
3066 		zil_commit(zilog, 0);
3067 	} else {
3068 		ASSERT3P(list_tail(&zilog->zl_lwb_list), ==, NULL);
3069 		ASSERT0(zilog->zl_dirty_max_txg);
3070 		ASSERT3B(zilog_is_dirty(zilog), ==, B_FALSE);
3071 	}
3072 
3073 	mutex_enter(&zilog->zl_lock);
3074 	lwb = list_tail(&zilog->zl_lwb_list);
3075 	if (lwb == NULL)
3076 		txg = zilog->zl_dirty_max_txg;
3077 	else
3078 		txg = MAX(zilog->zl_dirty_max_txg, lwb->lwb_max_txg);
3079 	mutex_exit(&zilog->zl_lock);
3080 
3081 	/*
3082 	 * We need to use txg_wait_synced() to wait long enough for the
3083 	 * ZIL to be clean, and to wait for all pending lwbs to be
3084 	 * written out.
3085 	 */
3086 	if (txg != 0)
3087 		txg_wait_synced(zilog->zl_dmu_pool, txg);
3088 
3089 	if (zilog_is_dirty(zilog))
3090 		zfs_dbgmsg("zil (%p) is dirty, txg %llu", zilog, txg);
3091 	if (txg < spa_freeze_txg(zilog->zl_spa))
3092 		VERIFY(!zilog_is_dirty(zilog));
3093 
3094 	zilog->zl_get_data = NULL;
3095 
3096 	/*
3097 	 * We should have only one lwb left on the list; remove it now.
3098 	 */
3099 	mutex_enter(&zilog->zl_lock);
3100 	lwb = list_head(&zilog->zl_lwb_list);
3101 	if (lwb != NULL) {
3102 		ASSERT3P(lwb, ==, list_tail(&zilog->zl_lwb_list));
3103 		ASSERT3S(lwb->lwb_state, !=, LWB_STATE_ISSUED);
3104 		list_remove(&zilog->zl_lwb_list, lwb);
3105 		zio_buf_free(lwb->lwb_buf, lwb->lwb_sz);
3106 		zil_free_lwb(zilog, lwb);
3107 	}
3108 	mutex_exit(&zilog->zl_lock);
3109 }
3110 
3111 static char *suspend_tag = "zil suspending";
3112 
3113 /*
3114  * Suspend an intent log.  While in suspended mode, we still honor
3115  * synchronous semantics, but we rely on txg_wait_synced() to do it.
3116  * On old version pools, we suspend the log briefly when taking a
3117  * snapshot so that it will have an empty intent log.
3118  *
3119  * Long holds are not really intended to be used the way we do here --
3120  * held for such a short time.  A concurrent caller of dsl_dataset_long_held()
3121  * could fail.  Therefore we take pains to only put a long hold if it is
3122  * actually necessary.  Fortunately, it will only be necessary if the
3123  * objset is currently mounted (or the ZVOL equivalent).  In that case it
3124  * will already have a long hold, so we are not really making things any worse.
3125  *
3126  * Ideally, we would locate the existing long-holder (i.e. the zfsvfs_t or
3127  * zvol_state_t), and use their mechanism to prevent their hold from being
3128  * dropped (e.g. VFS_HOLD()).  However, that would be even more pain for
3129  * very little gain.
3130  *
3131  * if cookiep == NULL, this does both the suspend & resume.
3132  * Otherwise, it returns with the dataset "long held", and the cookie
3133  * should be passed into zil_resume().
3134  */
3135 int
zil_suspend(const char * osname,void ** cookiep)3136 zil_suspend(const char *osname, void **cookiep)
3137 {
3138 	objset_t *os;
3139 	zilog_t *zilog;
3140 	const zil_header_t *zh;
3141 	int error;
3142 
3143 	error = dmu_objset_hold(osname, suspend_tag, &os);
3144 	if (error != 0)
3145 		return (error);
3146 	zilog = dmu_objset_zil(os);
3147 
3148 	mutex_enter(&zilog->zl_lock);
3149 	zh = zilog->zl_header;
3150 
3151 	if (zh->zh_flags & ZIL_REPLAY_NEEDED) {		/* unplayed log */
3152 		mutex_exit(&zilog->zl_lock);
3153 		dmu_objset_rele(os, suspend_tag);
3154 		return (SET_ERROR(EBUSY));
3155 	}
3156 
3157 	/*
3158 	 * Don't put a long hold in the cases where we can avoid it.  This
3159 	 * is when there is no cookie so we are doing a suspend & resume
3160 	 * (i.e. called from zil_vdev_offline()), and there's nothing to do
3161 	 * for the suspend because it's already suspended, or there's no ZIL.
3162 	 */
3163 	if (cookiep == NULL && !zilog->zl_suspending &&
3164 	    (zilog->zl_suspend > 0 || BP_IS_HOLE(&zh->zh_log))) {
3165 		mutex_exit(&zilog->zl_lock);
3166 		dmu_objset_rele(os, suspend_tag);
3167 		return (0);
3168 	}
3169 
3170 	dsl_dataset_long_hold(dmu_objset_ds(os), suspend_tag);
3171 	dsl_pool_rele(dmu_objset_pool(os), suspend_tag);
3172 
3173 	zilog->zl_suspend++;
3174 
3175 	if (zilog->zl_suspend > 1) {
3176 		/*
3177 		 * Someone else is already suspending it.
3178 		 * Just wait for them to finish.
3179 		 */
3180 
3181 		while (zilog->zl_suspending)
3182 			cv_wait(&zilog->zl_cv_suspend, &zilog->zl_lock);
3183 		mutex_exit(&zilog->zl_lock);
3184 
3185 		if (cookiep == NULL)
3186 			zil_resume(os);
3187 		else
3188 			*cookiep = os;
3189 		return (0);
3190 	}
3191 
3192 	/*
3193 	 * If there is no pointer to an on-disk block, this ZIL must not
3194 	 * be active (e.g. filesystem not mounted), so there's nothing
3195 	 * to clean up.
3196 	 */
3197 	if (BP_IS_HOLE(&zh->zh_log)) {
3198 		ASSERT(cookiep != NULL); /* fast path already handled */
3199 
3200 		*cookiep = os;
3201 		mutex_exit(&zilog->zl_lock);
3202 		return (0);
3203 	}
3204 
3205 	/*
3206 	 * The ZIL has work to do. Ensure that the associated encryption
3207 	 * key will remain mapped while we are committing the log by
3208 	 * grabbing a reference to it. If the key isn't loaded we have no
3209 	 * choice but to return an error until the wrapping key is loaded.
3210 	 */
3211 	if (os->os_encrypted &&
3212 	    dsl_dataset_create_key_mapping(dmu_objset_ds(os)) != 0) {
3213 		zilog->zl_suspend--;
3214 		mutex_exit(&zilog->zl_lock);
3215 		dsl_dataset_long_rele(dmu_objset_ds(os), suspend_tag);
3216 		dsl_dataset_rele(dmu_objset_ds(os), suspend_tag);
3217 		return (SET_ERROR(EBUSY));
3218 	}
3219 
3220 	zilog->zl_suspending = B_TRUE;
3221 	mutex_exit(&zilog->zl_lock);
3222 
3223 	/*
3224 	 * We need to use zil_commit_impl to ensure we wait for all
3225 	 * LWB_STATE_OPENED and LWB_STATE_ISSUED lwb's to be committed
3226 	 * to disk before proceeding. If we used zil_commit instead, it
3227 	 * would just call txg_wait_synced(), because zl_suspend is set.
3228 	 * txg_wait_synced() doesn't wait for these lwb's to be
3229 	 * LWB_STATE_FLUSH_DONE before returning.
3230 	 */
3231 	zil_commit_impl(zilog, 0);
3232 
3233 	/*
3234 	 * Now that we've ensured all lwb's are LWB_STATE_DONE,
3235 	 * txg_wait_synced() will be called from within zil_destroy(),
3236 	 * which will ensure the data from the zilog has migrated to the
3237 	 * main pool before it returns.
3238 	 */
3239 	txg_wait_synced(zilog->zl_dmu_pool, 0);
3240 
3241 	zil_destroy(zilog, B_FALSE);
3242 
3243 	mutex_enter(&zilog->zl_lock);
3244 	zilog->zl_suspending = B_FALSE;
3245 	cv_broadcast(&zilog->zl_cv_suspend);
3246 	mutex_exit(&zilog->zl_lock);
3247 
3248 	if (os->os_encrypted)
3249 		dsl_dataset_remove_key_mapping(dmu_objset_ds(os));
3250 
3251 	if (cookiep == NULL)
3252 		zil_resume(os);
3253 	else
3254 		*cookiep = os;
3255 	return (0);
3256 }
3257 
3258 void
zil_resume(void * cookie)3259 zil_resume(void *cookie)
3260 {
3261 	objset_t *os = cookie;
3262 	zilog_t *zilog = dmu_objset_zil(os);
3263 
3264 	mutex_enter(&zilog->zl_lock);
3265 	ASSERT(zilog->zl_suspend != 0);
3266 	zilog->zl_suspend--;
3267 	mutex_exit(&zilog->zl_lock);
3268 	dsl_dataset_long_rele(dmu_objset_ds(os), suspend_tag);
3269 	dsl_dataset_rele(dmu_objset_ds(os), suspend_tag);
3270 }
3271 
3272 typedef struct zil_replay_arg {
3273 	zil_replay_func_t **zr_replay;
3274 	void		*zr_arg;
3275 	boolean_t	zr_byteswap;
3276 	char		*zr_lr;
3277 } zil_replay_arg_t;
3278 
3279 static int
zil_replay_error(zilog_t * zilog,lr_t * lr,int error)3280 zil_replay_error(zilog_t *zilog, lr_t *lr, int error)
3281 {
3282 	char name[ZFS_MAX_DATASET_NAME_LEN];
3283 
3284 	zilog->zl_replaying_seq--;	/* didn't actually replay this one */
3285 
3286 	dmu_objset_name(zilog->zl_os, name);
3287 
3288 	cmn_err(CE_WARN, "ZFS replay transaction error %d, "
3289 	    "dataset %s, seq 0x%llx, txtype %llu %s\n", error, name,
3290 	    (u_longlong_t)lr->lrc_seq,
3291 	    (u_longlong_t)(lr->lrc_txtype & ~TX_CI),
3292 	    (lr->lrc_txtype & TX_CI) ? "CI" : "");
3293 
3294 	return (error);
3295 }
3296 
3297 static int
zil_replay_log_record(zilog_t * zilog,lr_t * lr,void * zra,uint64_t claim_txg)3298 zil_replay_log_record(zilog_t *zilog, lr_t *lr, void *zra, uint64_t claim_txg)
3299 {
3300 	zil_replay_arg_t *zr = zra;
3301 	const zil_header_t *zh = zilog->zl_header;
3302 	uint64_t reclen = lr->lrc_reclen;
3303 	uint64_t txtype = lr->lrc_txtype;
3304 	int error = 0;
3305 
3306 	zilog->zl_replaying_seq = lr->lrc_seq;
3307 
3308 	if (lr->lrc_seq <= zh->zh_replay_seq)	/* already replayed */
3309 		return (0);
3310 
3311 	if (lr->lrc_txg < claim_txg)		/* already committed */
3312 		return (0);
3313 
3314 	/* Strip case-insensitive bit, still present in log record */
3315 	txtype &= ~TX_CI;
3316 
3317 	if (txtype == 0 || txtype >= TX_MAX_TYPE)
3318 		return (zil_replay_error(zilog, lr, EINVAL));
3319 
3320 	/*
3321 	 * If this record type can be logged out of order, the object
3322 	 * (lr_foid) may no longer exist.  That's legitimate, not an error.
3323 	 */
3324 	if (TX_OOO(txtype)) {
3325 		error = dmu_object_info(zilog->zl_os,
3326 		    LR_FOID_GET_OBJ(((lr_ooo_t *)lr)->lr_foid), NULL);
3327 		if (error == ENOENT || error == EEXIST)
3328 			return (0);
3329 	}
3330 
3331 	/*
3332 	 * Make a copy of the data so we can revise and extend it.
3333 	 */
3334 	bcopy(lr, zr->zr_lr, reclen);
3335 
3336 	/*
3337 	 * If this is a TX_WRITE with a blkptr, suck in the data.
3338 	 */
3339 	if (txtype == TX_WRITE && reclen == sizeof (lr_write_t)) {
3340 		error = zil_read_log_data(zilog, (lr_write_t *)lr,
3341 		    zr->zr_lr + reclen);
3342 		if (error != 0)
3343 			return (zil_replay_error(zilog, lr, error));
3344 	}
3345 
3346 	/*
3347 	 * The log block containing this lr may have been byteswapped
3348 	 * so that we can easily examine common fields like lrc_txtype.
3349 	 * However, the log is a mix of different record types, and only the
3350 	 * replay vectors know how to byteswap their records.  Therefore, if
3351 	 * the lr was byteswapped, undo it before invoking the replay vector.
3352 	 */
3353 	if (zr->zr_byteswap)
3354 		byteswap_uint64_array(zr->zr_lr, reclen);
3355 
3356 	/*
3357 	 * We must now do two things atomically: replay this log record,
3358 	 * and update the log header sequence number to reflect the fact that
3359 	 * we did so. At the end of each replay function the sequence number
3360 	 * is updated if we are in replay mode.
3361 	 */
3362 	error = zr->zr_replay[txtype](zr->zr_arg, zr->zr_lr, zr->zr_byteswap);
3363 	if (error != 0) {
3364 		/*
3365 		 * The DMU's dnode layer doesn't see removes until the txg
3366 		 * commits, so a subsequent claim can spuriously fail with
3367 		 * EEXIST. So if we receive any error we try syncing out
3368 		 * any removes then retry the transaction.  Note that we
3369 		 * specify B_FALSE for byteswap now, so we don't do it twice.
3370 		 */
3371 		txg_wait_synced(spa_get_dsl(zilog->zl_spa), 0);
3372 		error = zr->zr_replay[txtype](zr->zr_arg, zr->zr_lr, B_FALSE);
3373 		if (error != 0)
3374 			return (zil_replay_error(zilog, lr, error));
3375 	}
3376 	return (0);
3377 }
3378 
3379 /* ARGSUSED */
3380 static int
zil_incr_blks(zilog_t * zilog,blkptr_t * bp,void * arg,uint64_t claim_txg)3381 zil_incr_blks(zilog_t *zilog, blkptr_t *bp, void *arg, uint64_t claim_txg)
3382 {
3383 	zilog->zl_replay_blks++;
3384 
3385 	return (0);
3386 }
3387 
3388 /*
3389  * If this dataset has a non-empty intent log, replay it and destroy it.
3390  */
3391 void
zil_replay(objset_t * os,void * arg,zil_replay_func_t * replay_func[TX_MAX_TYPE])3392 zil_replay(objset_t *os, void *arg, zil_replay_func_t *replay_func[TX_MAX_TYPE])
3393 {
3394 	zilog_t *zilog = dmu_objset_zil(os);
3395 	const zil_header_t *zh = zilog->zl_header;
3396 	zil_replay_arg_t zr;
3397 
3398 	if ((zh->zh_flags & ZIL_REPLAY_NEEDED) == 0) {
3399 		zil_destroy(zilog, B_TRUE);
3400 		return;
3401 	}
3402 
3403 	zr.zr_replay = replay_func;
3404 	zr.zr_arg = arg;
3405 	zr.zr_byteswap = BP_SHOULD_BYTESWAP(&zh->zh_log);
3406 	zr.zr_lr = kmem_alloc(2 * SPA_MAXBLOCKSIZE, KM_SLEEP);
3407 
3408 	/*
3409 	 * Wait for in-progress removes to sync before starting replay.
3410 	 */
3411 	txg_wait_synced(zilog->zl_dmu_pool, 0);
3412 
3413 	zilog->zl_replay = B_TRUE;
3414 	zilog->zl_replay_time = ddi_get_lbolt();
3415 	ASSERT(zilog->zl_replay_blks == 0);
3416 	(void) zil_parse(zilog, zil_incr_blks, zil_replay_log_record, &zr,
3417 	    zh->zh_claim_txg, B_TRUE);
3418 	kmem_free(zr.zr_lr, 2 * SPA_MAXBLOCKSIZE);
3419 
3420 	zil_destroy(zilog, B_FALSE);
3421 	txg_wait_synced(zilog->zl_dmu_pool, zilog->zl_destroy_txg);
3422 	zilog->zl_replay = B_FALSE;
3423 }
3424 
3425 boolean_t
zil_replaying(zilog_t * zilog,dmu_tx_t * tx)3426 zil_replaying(zilog_t *zilog, dmu_tx_t *tx)
3427 {
3428 	if (zilog->zl_sync == ZFS_SYNC_DISABLED)
3429 		return (B_TRUE);
3430 
3431 	if (zilog->zl_replay) {
3432 		dsl_dataset_dirty(dmu_objset_ds(zilog->zl_os), tx);
3433 		zilog->zl_replayed_seq[dmu_tx_get_txg(tx) & TXG_MASK] =
3434 		    zilog->zl_replaying_seq;
3435 		return (B_TRUE);
3436 	}
3437 
3438 	return (B_FALSE);
3439 }
3440 
3441 /* ARGSUSED */
3442 int
zil_reset(const char * osname,void * arg)3443 zil_reset(const char *osname, void *arg)
3444 {
3445 	int error;
3446 
3447 	error = zil_suspend(osname, NULL);
3448 	if (error != 0)
3449 		return (SET_ERROR(EEXIST));
3450 	return (0);
3451 }
3452