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