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