xref: /freebsd/sys/contrib/openzfs/module/zfs/spa_errlog.c (revision 66fd12cf4896eb08ad8e7a2627537f84ead84dd3)
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 https://opensource.org/licenses/CDDL-1.0.
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) 2006, 2010, Oracle and/or its affiliates. All rights reserved.
23  * Copyright (c) 2013, 2014, Delphix. All rights reserved.
24  * Copyright (c) 2019 Datto Inc.
25  * Copyright (c) 2021, 2022, George Amanakis. All rights reserved.
26  */
27 
28 /*
29  * Routines to manage the on-disk persistent error log.
30  *
31  * Each pool stores a log of all logical data errors seen during normal
32  * operation.  This is actually the union of two distinct logs: the last log,
33  * and the current log.  All errors seen are logged to the current log.  When a
34  * scrub completes, the current log becomes the last log, the last log is thrown
35  * out, and the current log is reinitialized.  This way, if an error is somehow
36  * corrected, a new scrub will show that it no longer exists, and will be
37  * deleted from the log when the scrub completes.
38  *
39  * The log is stored using a ZAP object whose key is a string form of the
40  * zbookmark_phys tuple (objset, object, level, blkid), and whose contents is an
41  * optional 'objset:object' human-readable string describing the data.  When an
42  * error is first logged, this string will be empty, indicating that no name is
43  * known.  This prevents us from having to issue a potentially large amount of
44  * I/O to discover the object name during an error path.  Instead, we do the
45  * calculation when the data is requested, storing the result so future queries
46  * will be faster.
47  *
48  * If the head_errlog feature is enabled, a different on-disk format is used.
49  * The error log of each head dataset is stored separately in the zap object
50  * and keyed by the head id. This enables listing every dataset affected in
51  * userland. In order to be able to track whether an error block has been
52  * modified or added to snapshots since it was marked as an error, a new tuple
53  * is introduced: zbookmark_err_phys_t. It allows the storage of the birth
54  * transaction group of an error block on-disk. The birth transaction group is
55  * used by check_filesystem() to assess whether this block was freed,
56  * re-written or added to a snapshot since its marking as an error.
57  *
58  * This log is then shipped into an nvlist where the key is the dataset name and
59  * the value is the object name.  Userland is then responsible for uniquifying
60  * this list and displaying it to the user.
61  */
62 
63 #include <sys/dmu_tx.h>
64 #include <sys/spa.h>
65 #include <sys/spa_impl.h>
66 #include <sys/zap.h>
67 #include <sys/zio.h>
68 #include <sys/dsl_dir.h>
69 #include <sys/dmu_objset.h>
70 #include <sys/dbuf.h>
71 #include <sys/zfs_znode.h>
72 
73 #define	NAME_MAX_LEN 64
74 
75 typedef struct clones {
76 	uint64_t clone_ds;
77 	list_node_t node;
78 } clones_t;
79 
80 /*
81  * spa_upgrade_errlog_limit : A zfs module parameter that controls the number
82  *		of on-disk error log entries that will be converted to the new
83  *		format when enabling head_errlog. Defaults to 0 which converts
84  *		all log entries.
85  */
86 static uint_t spa_upgrade_errlog_limit = 0;
87 
88 /*
89  * Convert a bookmark to a string.
90  */
91 static void
92 bookmark_to_name(zbookmark_phys_t *zb, char *buf, size_t len)
93 {
94 	(void) snprintf(buf, len, "%llx:%llx:%llx:%llx",
95 	    (u_longlong_t)zb->zb_objset, (u_longlong_t)zb->zb_object,
96 	    (u_longlong_t)zb->zb_level, (u_longlong_t)zb->zb_blkid);
97 }
98 
99 /*
100  * Convert an err_phys to a string.
101  */
102 static void
103 errphys_to_name(zbookmark_err_phys_t *zep, char *buf, size_t len)
104 {
105 	(void) snprintf(buf, len, "%llx:%llx:%llx:%llx",
106 	    (u_longlong_t)zep->zb_object, (u_longlong_t)zep->zb_level,
107 	    (u_longlong_t)zep->zb_blkid, (u_longlong_t)zep->zb_birth);
108 }
109 
110 /*
111  * Convert a string to a err_phys.
112  */
113 void
114 name_to_errphys(char *buf, zbookmark_err_phys_t *zep)
115 {
116 	zep->zb_object = zfs_strtonum(buf, &buf);
117 	ASSERT(*buf == ':');
118 	zep->zb_level = (int)zfs_strtonum(buf + 1, &buf);
119 	ASSERT(*buf == ':');
120 	zep->zb_blkid = zfs_strtonum(buf + 1, &buf);
121 	ASSERT(*buf == ':');
122 	zep->zb_birth = zfs_strtonum(buf + 1, &buf);
123 	ASSERT(*buf == '\0');
124 }
125 
126 /*
127  * Convert a string to a bookmark.
128  */
129 static void
130 name_to_bookmark(char *buf, zbookmark_phys_t *zb)
131 {
132 	zb->zb_objset = zfs_strtonum(buf, &buf);
133 	ASSERT(*buf == ':');
134 	zb->zb_object = zfs_strtonum(buf + 1, &buf);
135 	ASSERT(*buf == ':');
136 	zb->zb_level = (int)zfs_strtonum(buf + 1, &buf);
137 	ASSERT(*buf == ':');
138 	zb->zb_blkid = zfs_strtonum(buf + 1, &buf);
139 	ASSERT(*buf == '\0');
140 }
141 
142 void
143 zep_to_zb(uint64_t dataset, zbookmark_err_phys_t *zep, zbookmark_phys_t *zb)
144 {
145 	zb->zb_objset = dataset;
146 	zb->zb_object = zep->zb_object;
147 	zb->zb_level = zep->zb_level;
148 	zb->zb_blkid = zep->zb_blkid;
149 }
150 
151 static void
152 name_to_object(char *buf, uint64_t *obj)
153 {
154 	*obj = zfs_strtonum(buf, &buf);
155 	ASSERT(*buf == '\0');
156 }
157 
158 /*
159  * Retrieve the head filesystem.
160  */
161 static int get_head_ds(spa_t *spa, uint64_t dsobj, uint64_t *head_ds)
162 {
163 	dsl_dataset_t *ds;
164 	int error = dsl_dataset_hold_obj_flags(spa->spa_dsl_pool,
165 	    dsobj, DS_HOLD_FLAG_DECRYPT, FTAG, &ds);
166 
167 	if (error != 0)
168 		return (error);
169 
170 	ASSERT(head_ds);
171 	*head_ds = dsl_dir_phys(ds->ds_dir)->dd_head_dataset_obj;
172 	dsl_dataset_rele_flags(ds, DS_HOLD_FLAG_DECRYPT, FTAG);
173 
174 	return (error);
175 }
176 
177 /*
178  * Log an uncorrectable error to the persistent error log.  We add it to the
179  * spa's list of pending errors.  The changes are actually synced out to disk
180  * during spa_errlog_sync().
181  */
182 void
183 spa_log_error(spa_t *spa, const zbookmark_phys_t *zb, const uint64_t *birth)
184 {
185 	spa_error_entry_t search;
186 	spa_error_entry_t *new;
187 	avl_tree_t *tree;
188 	avl_index_t where;
189 
190 	/*
191 	 * If we are trying to import a pool, ignore any errors, as we won't be
192 	 * writing to the pool any time soon.
193 	 */
194 	if (spa_load_state(spa) == SPA_LOAD_TRYIMPORT)
195 		return;
196 
197 	mutex_enter(&spa->spa_errlist_lock);
198 
199 	/*
200 	 * If we have had a request to rotate the log, log it to the next list
201 	 * instead of the current one.
202 	 */
203 	if (spa->spa_scrub_active || spa->spa_scrub_finished)
204 		tree = &spa->spa_errlist_scrub;
205 	else
206 		tree = &spa->spa_errlist_last;
207 
208 	search.se_bookmark = *zb;
209 	if (avl_find(tree, &search, &where) != NULL) {
210 		mutex_exit(&spa->spa_errlist_lock);
211 		return;
212 	}
213 
214 	new = kmem_zalloc(sizeof (spa_error_entry_t), KM_SLEEP);
215 	new->se_bookmark = *zb;
216 
217 	/*
218 	 * If the head_errlog feature is enabled, store the birth txg now. In
219 	 * case the file is deleted before spa_errlog_sync() runs, we will not
220 	 * be able to retrieve the birth txg.
221 	 */
222 	if (spa_feature_is_enabled(spa, SPA_FEATURE_HEAD_ERRLOG)) {
223 		new->se_zep.zb_object = zb->zb_object;
224 		new->se_zep.zb_level = zb->zb_level;
225 		new->se_zep.zb_blkid = zb->zb_blkid;
226 
227 		/*
228 		 * birth may end up being NULL, e.g. in zio_done(). We
229 		 * will handle this in process_error_block().
230 		 */
231 		if (birth != NULL)
232 			new->se_zep.zb_birth = *birth;
233 	}
234 
235 	avl_insert(tree, new, where);
236 	mutex_exit(&spa->spa_errlist_lock);
237 }
238 
239 int
240 find_birth_txg(dsl_dataset_t *ds, zbookmark_err_phys_t *zep,
241     uint64_t *birth_txg)
242 {
243 	objset_t *os;
244 	int error = dmu_objset_from_ds(ds, &os);
245 	if (error != 0)
246 		return (error);
247 
248 	dnode_t *dn;
249 	blkptr_t bp;
250 
251 	error = dnode_hold(os, zep->zb_object, FTAG, &dn);
252 	if (error != 0)
253 		return (error);
254 
255 	rw_enter(&dn->dn_struct_rwlock, RW_READER);
256 	error = dbuf_dnode_findbp(dn, zep->zb_level, zep->zb_blkid, &bp, NULL,
257 	    NULL);
258 	if (error == 0 && BP_IS_HOLE(&bp))
259 		error = SET_ERROR(ENOENT);
260 
261 	*birth_txg = bp.blk_birth;
262 	rw_exit(&dn->dn_struct_rwlock);
263 	dnode_rele(dn, FTAG);
264 	return (error);
265 }
266 
267 /*
268  * This function finds the oldest affected filesystem containing an error
269  * block.
270  */
271 int
272 find_top_affected_fs(spa_t *spa, uint64_t head_ds, zbookmark_err_phys_t *zep,
273     uint64_t *top_affected_fs)
274 {
275 	uint64_t oldest_dsobj;
276 	int error = dsl_dataset_oldest_snapshot(spa, head_ds, zep->zb_birth,
277 	    &oldest_dsobj);
278 	if (error != 0)
279 		return (error);
280 
281 	dsl_dataset_t *ds;
282 	error = dsl_dataset_hold_obj_flags(spa->spa_dsl_pool, oldest_dsobj,
283 	    DS_HOLD_FLAG_DECRYPT, FTAG, &ds);
284 	if (error != 0)
285 		return (error);
286 
287 	*top_affected_fs =
288 	    dsl_dir_phys(ds->ds_dir)->dd_head_dataset_obj;
289 	dsl_dataset_rele_flags(ds, DS_HOLD_FLAG_DECRYPT, FTAG);
290 	return (0);
291 }
292 
293 
294 #ifdef _KERNEL
295 /*
296  * Copy the bookmark to the end of the user-space buffer which starts at
297  * uaddr and has *count unused entries, and decrement *count by 1.
298  */
299 static int
300 copyout_entry(const zbookmark_phys_t *zb, void *uaddr, uint64_t *count)
301 {
302 	if (*count == 0)
303 		return (SET_ERROR(ENOMEM));
304 
305 	*count -= 1;
306 	if (copyout(zb, (char *)uaddr + (*count) * sizeof (zbookmark_phys_t),
307 	    sizeof (zbookmark_phys_t)) != 0)
308 		return (SET_ERROR(EFAULT));
309 	return (0);
310 }
311 
312 /*
313  * Each time the error block is referenced by a snapshot or clone, add a
314  * zbookmark_phys_t entry to the userspace array at uaddr. The array is
315  * filled from the back and the in-out parameter *count is modified to be the
316  * number of unused entries at the beginning of the array. The function
317  * scrub_filesystem() is modelled after this one.
318  */
319 static int
320 check_filesystem(spa_t *spa, uint64_t head_ds, zbookmark_err_phys_t *zep,
321     void *uaddr, uint64_t *count, list_t *clones_list)
322 {
323 	dsl_dataset_t *ds;
324 	dsl_pool_t *dp = spa->spa_dsl_pool;
325 
326 	int error = dsl_dataset_hold_obj_flags(dp, head_ds,
327 	    DS_HOLD_FLAG_DECRYPT, FTAG, &ds);
328 	if (error != 0)
329 		return (error);
330 
331 	uint64_t latest_txg;
332 	uint64_t txg_to_consider = spa->spa_syncing_txg;
333 	boolean_t check_snapshot = B_TRUE;
334 	error = find_birth_txg(ds, zep, &latest_txg);
335 
336 	/*
337 	 * If find_birth_txg() errors out otherwise, let txg_to_consider be
338 	 * equal to the spa's syncing txg: if check_filesystem() errors out
339 	 * then affected snapshots or clones will not be checked.
340 	 */
341 	if (error == 0 && zep->zb_birth == latest_txg) {
342 		/* Block neither free nor rewritten. */
343 		zbookmark_phys_t zb;
344 		zep_to_zb(head_ds, zep, &zb);
345 		error = copyout_entry(&zb, uaddr, count);
346 		if (error != 0) {
347 			dsl_dataset_rele_flags(ds, DS_HOLD_FLAG_DECRYPT, FTAG);
348 			return (error);
349 		}
350 		check_snapshot = B_FALSE;
351 	} else if (error == 0) {
352 		txg_to_consider = latest_txg;
353 	}
354 
355 	/*
356 	 * Retrieve the number of snapshots if the dataset is not a snapshot.
357 	 */
358 	uint64_t snap_count = 0;
359 	if (dsl_dataset_phys(ds)->ds_snapnames_zapobj != 0) {
360 
361 		error = zap_count(spa->spa_meta_objset,
362 		    dsl_dataset_phys(ds)->ds_snapnames_zapobj, &snap_count);
363 
364 		if (error != 0) {
365 			dsl_dataset_rele_flags(ds, DS_HOLD_FLAG_DECRYPT, FTAG);
366 			return (error);
367 		}
368 	}
369 
370 	if (snap_count == 0) {
371 		/* Filesystem without snapshots. */
372 		dsl_dataset_rele_flags(ds, DS_HOLD_FLAG_DECRYPT, FTAG);
373 		return (0);
374 	}
375 
376 	uint64_t *snap_obj_array = kmem_zalloc(snap_count * sizeof (uint64_t),
377 	    KM_SLEEP);
378 
379 	int aff_snap_count = 0;
380 	uint64_t snap_obj = dsl_dataset_phys(ds)->ds_prev_snap_obj;
381 	uint64_t snap_obj_txg = dsl_dataset_phys(ds)->ds_prev_snap_txg;
382 	uint64_t zap_clone = dsl_dir_phys(ds->ds_dir)->dd_clones;
383 
384 	dsl_dataset_rele_flags(ds, DS_HOLD_FLAG_DECRYPT, FTAG);
385 
386 	/* Check only snapshots created from this file system. */
387 	while (snap_obj != 0 && zep->zb_birth < snap_obj_txg &&
388 	    snap_obj_txg <= txg_to_consider) {
389 
390 		error = dsl_dataset_hold_obj_flags(dp, snap_obj,
391 		    DS_HOLD_FLAG_DECRYPT, FTAG, &ds);
392 		if (error != 0)
393 			goto out;
394 
395 		if (dsl_dir_phys(ds->ds_dir)->dd_head_dataset_obj != head_ds) {
396 			snap_obj = dsl_dataset_phys(ds)->ds_prev_snap_obj;
397 			snap_obj_txg = dsl_dataset_phys(ds)->ds_prev_snap_txg;
398 			dsl_dataset_rele_flags(ds, DS_HOLD_FLAG_DECRYPT, FTAG);
399 			continue;
400 		}
401 
402 		boolean_t affected = B_TRUE;
403 		if (check_snapshot) {
404 			uint64_t blk_txg;
405 			error = find_birth_txg(ds, zep, &blk_txg);
406 			affected = (error == 0 && zep->zb_birth == blk_txg);
407 		}
408 
409 		/* Report errors in snapshots. */
410 		if (affected) {
411 			snap_obj_array[aff_snap_count] = snap_obj;
412 			aff_snap_count++;
413 
414 			zbookmark_phys_t zb;
415 			zep_to_zb(snap_obj, zep, &zb);
416 			error = copyout_entry(&zb, uaddr, count);
417 			if (error != 0) {
418 				dsl_dataset_rele_flags(ds, DS_HOLD_FLAG_DECRYPT,
419 				    FTAG);
420 				goto out;
421 			}
422 		}
423 		snap_obj = dsl_dataset_phys(ds)->ds_prev_snap_obj;
424 		snap_obj_txg = dsl_dataset_phys(ds)->ds_prev_snap_txg;
425 		dsl_dataset_rele_flags(ds, DS_HOLD_FLAG_DECRYPT, FTAG);
426 	}
427 
428 	if (zap_clone == 0 || aff_snap_count == 0)
429 		return (0);
430 
431 	/* Check clones. */
432 	zap_cursor_t *zc;
433 	zap_attribute_t *za;
434 
435 	zc = kmem_zalloc(sizeof (zap_cursor_t), KM_SLEEP);
436 	za = kmem_zalloc(sizeof (zap_attribute_t), KM_SLEEP);
437 
438 	for (zap_cursor_init(zc, spa->spa_meta_objset, zap_clone);
439 	    zap_cursor_retrieve(zc, za) == 0;
440 	    zap_cursor_advance(zc)) {
441 
442 		dsl_dataset_t *clone;
443 		error = dsl_dataset_hold_obj_flags(dp, za->za_first_integer,
444 		    DS_HOLD_FLAG_DECRYPT, FTAG, &clone);
445 
446 		if (error != 0)
447 			break;
448 
449 		/*
450 		 * Only clones whose origins were affected could also
451 		 * have affected snapshots.
452 		 */
453 		boolean_t found = B_FALSE;
454 		for (int i = 0; i < snap_count; i++) {
455 			if (dsl_dir_phys(clone->ds_dir)->dd_origin_obj
456 			    == snap_obj_array[i])
457 				found = B_TRUE;
458 		}
459 		dsl_dataset_rele_flags(clone, DS_HOLD_FLAG_DECRYPT, FTAG);
460 
461 		if (!found)
462 			continue;
463 
464 		clones_t *ct = kmem_zalloc(sizeof (*ct), KM_SLEEP);
465 		ct->clone_ds = za->za_first_integer;
466 		list_insert_tail(clones_list, ct);
467 	}
468 
469 	zap_cursor_fini(zc);
470 	kmem_free(za, sizeof (*za));
471 	kmem_free(zc, sizeof (*zc));
472 
473 out:
474 	kmem_free(snap_obj_array, sizeof (*snap_obj_array));
475 	return (error);
476 }
477 
478 static int
479 process_error_block(spa_t *spa, uint64_t head_ds, zbookmark_err_phys_t *zep,
480     void *uaddr, uint64_t *count)
481 {
482 	/*
483 	 * If zb_birth == 0 or head_ds == 0 it means we failed to retrieve the
484 	 * birth txg or the head filesystem of the block pointer. This may
485 	 * happen e.g. when an encrypted filesystem is not mounted or when
486 	 * the key is not loaded. In this case do not proceed to
487 	 * check_filesystem(), instead do the accounting here.
488 	 */
489 	if (zep->zb_birth == 0 || head_ds == 0) {
490 		zbookmark_phys_t zb;
491 		zep_to_zb(head_ds, zep, &zb);
492 		int error = copyout_entry(&zb, uaddr, count);
493 		if (error != 0) {
494 			return (error);
495 		}
496 		return (0);
497 	}
498 
499 	uint64_t top_affected_fs;
500 	uint64_t init_count = *count;
501 	int error = find_top_affected_fs(spa, head_ds, zep, &top_affected_fs);
502 	if (error == 0) {
503 		clones_t *ct;
504 		list_t clones_list;
505 
506 		list_create(&clones_list, sizeof (clones_t),
507 		    offsetof(clones_t, node));
508 
509 		error = check_filesystem(spa, top_affected_fs, zep,
510 		    uaddr, count, &clones_list);
511 
512 		while ((ct = list_remove_head(&clones_list)) != NULL) {
513 			error = check_filesystem(spa, ct->clone_ds, zep,
514 			    uaddr, count, &clones_list);
515 			kmem_free(ct, sizeof (*ct));
516 
517 			if (error) {
518 				while (!list_is_empty(&clones_list)) {
519 					ct = list_remove_head(&clones_list);
520 					kmem_free(ct, sizeof (*ct));
521 				}
522 				break;
523 			}
524 		}
525 
526 		list_destroy(&clones_list);
527 	}
528 	if (error == 0 && init_count == *count) {
529 		/*
530 		 * If we reach this point, no errors have been detected
531 		 * in the checked filesystems/snapshots. Before returning mark
532 		 * the error block to be removed from the error lists and logs.
533 		 */
534 		zbookmark_phys_t zb;
535 		zep_to_zb(head_ds, zep, &zb);
536 		spa_remove_error(spa, &zb, &zep->zb_birth);
537 	}
538 
539 	return (error);
540 }
541 #endif
542 
543 /* Return the number of errors in the error log */
544 uint64_t
545 spa_get_last_errlog_size(spa_t *spa)
546 {
547 	uint64_t total = 0, count;
548 	mutex_enter(&spa->spa_errlog_lock);
549 
550 	if (spa->spa_errlog_last != 0 &&
551 	    zap_count(spa->spa_meta_objset, spa->spa_errlog_last,
552 	    &count) == 0)
553 		total += count;
554 	mutex_exit(&spa->spa_errlog_lock);
555 	return (total);
556 }
557 
558 /*
559  * If a healed bookmark matches an entry in the error log we stash it in a tree
560  * so that we can later remove the related log entries in sync context.
561  */
562 static void
563 spa_add_healed_error(spa_t *spa, uint64_t obj, zbookmark_phys_t *healed_zb,
564     const uint64_t *birth)
565 {
566 	char name[NAME_MAX_LEN];
567 
568 	if (obj == 0)
569 		return;
570 
571 	boolean_t held_list = B_FALSE;
572 	boolean_t held_log = B_FALSE;
573 
574 	if (!spa_feature_is_enabled(spa, SPA_FEATURE_HEAD_ERRLOG)) {
575 		bookmark_to_name(healed_zb, name, sizeof (name));
576 
577 		if (zap_contains(spa->spa_meta_objset, healed_zb->zb_objset,
578 		    name) == 0) {
579 			if (!MUTEX_HELD(&spa->spa_errlog_lock)) {
580 				mutex_enter(&spa->spa_errlog_lock);
581 				held_log = B_TRUE;
582 			}
583 
584 			/*
585 			 * Found an error matching healed zb, add zb to our
586 			 * tree of healed errors
587 			 */
588 			avl_tree_t *tree = &spa->spa_errlist_healed;
589 			spa_error_entry_t search;
590 			spa_error_entry_t *new;
591 			avl_index_t where;
592 			search.se_bookmark = *healed_zb;
593 			if (!MUTEX_HELD(&spa->spa_errlist_lock)) {
594 				mutex_enter(&spa->spa_errlist_lock);
595 				held_list = B_TRUE;
596 			}
597 			if (avl_find(tree, &search, &where) != NULL) {
598 				if (held_list)
599 					mutex_exit(&spa->spa_errlist_lock);
600 				if (held_log)
601 					mutex_exit(&spa->spa_errlog_lock);
602 				return;
603 			}
604 			new = kmem_zalloc(sizeof (spa_error_entry_t), KM_SLEEP);
605 			new->se_bookmark = *healed_zb;
606 			avl_insert(tree, new, where);
607 			if (held_list)
608 				mutex_exit(&spa->spa_errlist_lock);
609 			if (held_log)
610 				mutex_exit(&spa->spa_errlog_lock);
611 		}
612 		return;
613 	}
614 
615 	zbookmark_err_phys_t healed_zep;
616 	healed_zep.zb_object = healed_zb->zb_object;
617 	healed_zep.zb_level = healed_zb->zb_level;
618 	healed_zep.zb_blkid = healed_zb->zb_blkid;
619 
620 	if (birth != NULL)
621 		healed_zep.zb_birth = *birth;
622 	else
623 		healed_zep.zb_birth = 0;
624 
625 	errphys_to_name(&healed_zep, name, sizeof (name));
626 
627 	zap_cursor_t zc;
628 	zap_attribute_t za;
629 	for (zap_cursor_init(&zc, spa->spa_meta_objset, spa->spa_errlog_last);
630 	    zap_cursor_retrieve(&zc, &za) == 0; zap_cursor_advance(&zc)) {
631 		if (zap_contains(spa->spa_meta_objset, za.za_first_integer,
632 		    name) == 0) {
633 			if (!MUTEX_HELD(&spa->spa_errlog_lock)) {
634 				mutex_enter(&spa->spa_errlog_lock);
635 				held_log = B_TRUE;
636 			}
637 
638 			avl_tree_t *tree = &spa->spa_errlist_healed;
639 			spa_error_entry_t search;
640 			spa_error_entry_t *new;
641 			avl_index_t where;
642 			search.se_bookmark = *healed_zb;
643 
644 			if (!MUTEX_HELD(&spa->spa_errlist_lock)) {
645 				mutex_enter(&spa->spa_errlist_lock);
646 				held_list = B_TRUE;
647 			}
648 
649 			if (avl_find(tree, &search, &where) != NULL) {
650 				if (held_list)
651 					mutex_exit(&spa->spa_errlist_lock);
652 				if (held_log)
653 					mutex_exit(&spa->spa_errlog_lock);
654 				continue;
655 			}
656 			new = kmem_zalloc(sizeof (spa_error_entry_t), KM_SLEEP);
657 			new->se_bookmark = *healed_zb;
658 			new->se_zep = healed_zep;
659 			avl_insert(tree, new, where);
660 
661 			if (held_list)
662 				mutex_exit(&spa->spa_errlist_lock);
663 			if (held_log)
664 				mutex_exit(&spa->spa_errlog_lock);
665 		}
666 	}
667 	zap_cursor_fini(&zc);
668 }
669 
670 /*
671  * If this error exists in the given tree remove it.
672  */
673 static void
674 remove_error_from_list(spa_t *spa, avl_tree_t *t, const zbookmark_phys_t *zb)
675 {
676 	spa_error_entry_t search, *found;
677 	avl_index_t where;
678 
679 	mutex_enter(&spa->spa_errlist_lock);
680 	search.se_bookmark = *zb;
681 	if ((found = avl_find(t, &search, &where)) != NULL) {
682 		avl_remove(t, found);
683 		kmem_free(found, sizeof (spa_error_entry_t));
684 	}
685 	mutex_exit(&spa->spa_errlist_lock);
686 }
687 
688 
689 /*
690  * Removes all of the recv healed errors from both on-disk error logs
691  */
692 static void
693 spa_remove_healed_errors(spa_t *spa, avl_tree_t *s, avl_tree_t *l, dmu_tx_t *tx)
694 {
695 	char name[NAME_MAX_LEN];
696 	spa_error_entry_t *se;
697 	void *cookie = NULL;
698 
699 	ASSERT(MUTEX_HELD(&spa->spa_errlog_lock));
700 
701 	while ((se = avl_destroy_nodes(&spa->spa_errlist_healed,
702 	    &cookie)) != NULL) {
703 		remove_error_from_list(spa, s, &se->se_bookmark);
704 		remove_error_from_list(spa, l, &se->se_bookmark);
705 
706 		if (!spa_feature_is_enabled(spa, SPA_FEATURE_HEAD_ERRLOG)) {
707 			bookmark_to_name(&se->se_bookmark, name, sizeof (name));
708 			(void) zap_remove(spa->spa_meta_objset,
709 			    spa->spa_errlog_last, name, tx);
710 			(void) zap_remove(spa->spa_meta_objset,
711 			    spa->spa_errlog_scrub, name, tx);
712 		} else {
713 			errphys_to_name(&se->se_zep, name, sizeof (name));
714 			zap_cursor_t zc;
715 			zap_attribute_t za;
716 			for (zap_cursor_init(&zc, spa->spa_meta_objset,
717 			    spa->spa_errlog_last);
718 			    zap_cursor_retrieve(&zc, &za) == 0;
719 			    zap_cursor_advance(&zc)) {
720 				zap_remove(spa->spa_meta_objset,
721 				    za.za_first_integer, name, tx);
722 			}
723 			zap_cursor_fini(&zc);
724 
725 			for (zap_cursor_init(&zc, spa->spa_meta_objset,
726 			    spa->spa_errlog_scrub);
727 			    zap_cursor_retrieve(&zc, &za) == 0;
728 			    zap_cursor_advance(&zc)) {
729 				zap_remove(spa->spa_meta_objset,
730 				    za.za_first_integer, name, tx);
731 			}
732 			zap_cursor_fini(&zc);
733 		}
734 		kmem_free(se, sizeof (spa_error_entry_t));
735 	}
736 }
737 
738 /*
739  * Stash away healed bookmarks to remove them from the on-disk error logs
740  * later in spa_remove_healed_errors().
741  */
742 void
743 spa_remove_error(spa_t *spa, zbookmark_phys_t *zb, const uint64_t *birth)
744 {
745 	spa_add_healed_error(spa, spa->spa_errlog_last, zb, birth);
746 	spa_add_healed_error(spa, spa->spa_errlog_scrub, zb, birth);
747 }
748 
749 static uint64_t
750 approx_errlog_size_impl(spa_t *spa, uint64_t spa_err_obj)
751 {
752 	if (spa_err_obj == 0)
753 		return (0);
754 	uint64_t total = 0;
755 
756 	zap_cursor_t zc;
757 	zap_attribute_t za;
758 	for (zap_cursor_init(&zc, spa->spa_meta_objset, spa_err_obj);
759 	    zap_cursor_retrieve(&zc, &za) == 0; zap_cursor_advance(&zc)) {
760 		uint64_t count;
761 		if (zap_count(spa->spa_meta_objset, za.za_first_integer,
762 		    &count) == 0)
763 			total += count;
764 	}
765 	zap_cursor_fini(&zc);
766 	return (total);
767 }
768 
769 /*
770  * Return the approximate number of errors currently in the error log.  This
771  * will be nonzero if there are some errors, but otherwise it may be more
772  * or less than the number of entries returned by spa_get_errlog().
773  */
774 uint64_t
775 spa_approx_errlog_size(spa_t *spa)
776 {
777 	uint64_t total = 0;
778 
779 	if (!spa_feature_is_enabled(spa, SPA_FEATURE_HEAD_ERRLOG)) {
780 		mutex_enter(&spa->spa_errlog_lock);
781 		uint64_t count;
782 		if (spa->spa_errlog_scrub != 0 &&
783 		    zap_count(spa->spa_meta_objset, spa->spa_errlog_scrub,
784 		    &count) == 0)
785 			total += count;
786 
787 		if (spa->spa_errlog_last != 0 && !spa->spa_scrub_finished &&
788 		    zap_count(spa->spa_meta_objset, spa->spa_errlog_last,
789 		    &count) == 0)
790 			total += count;
791 		mutex_exit(&spa->spa_errlog_lock);
792 
793 	} else {
794 		mutex_enter(&spa->spa_errlog_lock);
795 		total += approx_errlog_size_impl(spa, spa->spa_errlog_last);
796 		total += approx_errlog_size_impl(spa, spa->spa_errlog_scrub);
797 		mutex_exit(&spa->spa_errlog_lock);
798 	}
799 	mutex_enter(&spa->spa_errlist_lock);
800 	total += avl_numnodes(&spa->spa_errlist_last);
801 	total += avl_numnodes(&spa->spa_errlist_scrub);
802 	mutex_exit(&spa->spa_errlist_lock);
803 	return (total);
804 }
805 
806 /*
807  * This function sweeps through an on-disk error log and stores all bookmarks
808  * as error bookmarks in a new ZAP object. At the end we discard the old one,
809  * and spa_update_errlog() will set the spa's on-disk error log to new ZAP
810  * object.
811  */
812 static void
813 sync_upgrade_errlog(spa_t *spa, uint64_t spa_err_obj, uint64_t *newobj,
814     dmu_tx_t *tx)
815 {
816 	zap_cursor_t zc;
817 	zap_attribute_t za;
818 	zbookmark_phys_t zb;
819 	uint64_t count;
820 
821 	*newobj = zap_create(spa->spa_meta_objset, DMU_OT_ERROR_LOG,
822 	    DMU_OT_NONE, 0, tx);
823 
824 	/*
825 	 * If we cannnot perform the upgrade we should clear the old on-disk
826 	 * error logs.
827 	 */
828 	if (zap_count(spa->spa_meta_objset, spa_err_obj, &count) != 0) {
829 		VERIFY0(dmu_object_free(spa->spa_meta_objset, spa_err_obj, tx));
830 		return;
831 	}
832 
833 	for (zap_cursor_init(&zc, spa->spa_meta_objset, spa_err_obj);
834 	    zap_cursor_retrieve(&zc, &za) == 0;
835 	    zap_cursor_advance(&zc)) {
836 		if (spa_upgrade_errlog_limit != 0 &&
837 		    zc.zc_cd == spa_upgrade_errlog_limit)
838 			break;
839 
840 		name_to_bookmark(za.za_name, &zb);
841 
842 		zbookmark_err_phys_t zep;
843 		zep.zb_object = zb.zb_object;
844 		zep.zb_level = zb.zb_level;
845 		zep.zb_blkid = zb.zb_blkid;
846 		zep.zb_birth = 0;
847 
848 		/*
849 		 * In case of an error we should simply continue instead of
850 		 * returning prematurely. See the next comment.
851 		 */
852 		uint64_t head_ds;
853 		dsl_pool_t *dp = spa->spa_dsl_pool;
854 		dsl_dataset_t *ds;
855 		objset_t *os;
856 
857 		int error = dsl_dataset_hold_obj_flags(dp, zb.zb_objset,
858 		    DS_HOLD_FLAG_DECRYPT, FTAG, &ds);
859 		if (error != 0)
860 			continue;
861 
862 		head_ds = dsl_dir_phys(ds->ds_dir)->dd_head_dataset_obj;
863 
864 		/*
865 		 * The objset and the dnode are required for getting the block
866 		 * pointer, which is used to determine if BP_IS_HOLE(). If
867 		 * getting the objset or the dnode fails, do not create a
868 		 * zap entry (presuming we know the dataset) as this may create
869 		 * spurious errors that we cannot ever resolve. If an error is
870 		 * truly persistent, it should re-appear after a scan.
871 		 */
872 		if (dmu_objset_from_ds(ds, &os) != 0) {
873 			dsl_dataset_rele_flags(ds, DS_HOLD_FLAG_DECRYPT, FTAG);
874 			continue;
875 		}
876 
877 		dnode_t *dn;
878 		blkptr_t bp;
879 
880 		if (dnode_hold(os, zep.zb_object, FTAG, &dn) != 0) {
881 			dsl_dataset_rele_flags(ds, DS_HOLD_FLAG_DECRYPT, FTAG);
882 			continue;
883 		}
884 
885 		rw_enter(&dn->dn_struct_rwlock, RW_READER);
886 		error = dbuf_dnode_findbp(dn, zep.zb_level, zep.zb_blkid, &bp,
887 		    NULL, NULL);
888 		if (error == EACCES)
889 			error = 0;
890 		else if (!error)
891 			zep.zb_birth = bp.blk_birth;
892 
893 		rw_exit(&dn->dn_struct_rwlock);
894 		dnode_rele(dn, FTAG);
895 		dsl_dataset_rele_flags(ds, DS_HOLD_FLAG_DECRYPT, FTAG);
896 
897 		if (error != 0 || BP_IS_HOLE(&bp))
898 			continue;
899 
900 		uint64_t err_obj;
901 		error = zap_lookup_int_key(spa->spa_meta_objset, *newobj,
902 		    head_ds, &err_obj);
903 
904 		if (error == ENOENT) {
905 			err_obj = zap_create(spa->spa_meta_objset,
906 			    DMU_OT_ERROR_LOG, DMU_OT_NONE, 0, tx);
907 
908 			(void) zap_update_int_key(spa->spa_meta_objset,
909 			    *newobj, head_ds, err_obj, tx);
910 		}
911 
912 		char buf[64];
913 		errphys_to_name(&zep, buf, sizeof (buf));
914 
915 		const char *name = "";
916 		(void) zap_update(spa->spa_meta_objset, err_obj,
917 		    buf, 1, strlen(name) + 1, name, tx);
918 	}
919 	zap_cursor_fini(&zc);
920 
921 	VERIFY0(dmu_object_free(spa->spa_meta_objset, spa_err_obj, tx));
922 }
923 
924 void
925 spa_upgrade_errlog(spa_t *spa, dmu_tx_t *tx)
926 {
927 	uint64_t newobj = 0;
928 
929 	mutex_enter(&spa->spa_errlog_lock);
930 	if (spa->spa_errlog_last != 0) {
931 		sync_upgrade_errlog(spa, spa->spa_errlog_last, &newobj, tx);
932 		spa->spa_errlog_last = newobj;
933 	}
934 
935 	if (spa->spa_errlog_scrub != 0) {
936 		sync_upgrade_errlog(spa, spa->spa_errlog_scrub, &newobj, tx);
937 		spa->spa_errlog_scrub = newobj;
938 	}
939 	mutex_exit(&spa->spa_errlog_lock);
940 }
941 
942 #ifdef _KERNEL
943 /*
944  * If an error block is shared by two datasets it will be counted twice.
945  */
946 static int
947 process_error_log(spa_t *spa, uint64_t obj, void *uaddr, uint64_t *count)
948 {
949 	if (obj == 0)
950 		return (0);
951 
952 	zap_cursor_t *zc;
953 	zap_attribute_t *za;
954 
955 	zc = kmem_zalloc(sizeof (zap_cursor_t), KM_SLEEP);
956 	za = kmem_zalloc(sizeof (zap_attribute_t), KM_SLEEP);
957 
958 	if (!spa_feature_is_enabled(spa, SPA_FEATURE_HEAD_ERRLOG)) {
959 		for (zap_cursor_init(zc, spa->spa_meta_objset, obj);
960 		    zap_cursor_retrieve(zc, za) == 0;
961 		    zap_cursor_advance(zc)) {
962 			if (*count == 0) {
963 				zap_cursor_fini(zc);
964 				kmem_free(zc, sizeof (*zc));
965 				kmem_free(za, sizeof (*za));
966 				return (SET_ERROR(ENOMEM));
967 			}
968 
969 			zbookmark_phys_t zb;
970 			name_to_bookmark(za->za_name, &zb);
971 
972 			int error = copyout_entry(&zb, uaddr, count);
973 			if (error != 0) {
974 				zap_cursor_fini(zc);
975 				kmem_free(zc, sizeof (*zc));
976 				kmem_free(za, sizeof (*za));
977 				return (error);
978 			}
979 		}
980 		zap_cursor_fini(zc);
981 		kmem_free(zc, sizeof (*zc));
982 		kmem_free(za, sizeof (*za));
983 		return (0);
984 	}
985 
986 	for (zap_cursor_init(zc, spa->spa_meta_objset, obj);
987 	    zap_cursor_retrieve(zc, za) == 0;
988 	    zap_cursor_advance(zc)) {
989 
990 		zap_cursor_t *head_ds_cursor;
991 		zap_attribute_t *head_ds_attr;
992 
993 		head_ds_cursor = kmem_zalloc(sizeof (zap_cursor_t), KM_SLEEP);
994 		head_ds_attr = kmem_zalloc(sizeof (zap_attribute_t), KM_SLEEP);
995 
996 		uint64_t head_ds_err_obj = za->za_first_integer;
997 		uint64_t head_ds;
998 		name_to_object(za->za_name, &head_ds);
999 		for (zap_cursor_init(head_ds_cursor, spa->spa_meta_objset,
1000 		    head_ds_err_obj); zap_cursor_retrieve(head_ds_cursor,
1001 		    head_ds_attr) == 0; zap_cursor_advance(head_ds_cursor)) {
1002 
1003 			zbookmark_err_phys_t head_ds_block;
1004 			name_to_errphys(head_ds_attr->za_name, &head_ds_block);
1005 			int error = process_error_block(spa, head_ds,
1006 			    &head_ds_block, uaddr, count);
1007 
1008 			if (error != 0) {
1009 				zap_cursor_fini(head_ds_cursor);
1010 				kmem_free(head_ds_cursor,
1011 				    sizeof (*head_ds_cursor));
1012 				kmem_free(head_ds_attr, sizeof (*head_ds_attr));
1013 
1014 				zap_cursor_fini(zc);
1015 				kmem_free(za, sizeof (*za));
1016 				kmem_free(zc, sizeof (*zc));
1017 				return (error);
1018 			}
1019 		}
1020 		zap_cursor_fini(head_ds_cursor);
1021 		kmem_free(head_ds_cursor, sizeof (*head_ds_cursor));
1022 		kmem_free(head_ds_attr, sizeof (*head_ds_attr));
1023 	}
1024 	zap_cursor_fini(zc);
1025 	kmem_free(za, sizeof (*za));
1026 	kmem_free(zc, sizeof (*zc));
1027 	return (0);
1028 }
1029 
1030 static int
1031 process_error_list(spa_t *spa, avl_tree_t *list, void *uaddr, uint64_t *count)
1032 {
1033 	spa_error_entry_t *se;
1034 
1035 	if (!spa_feature_is_enabled(spa, SPA_FEATURE_HEAD_ERRLOG)) {
1036 		for (se = avl_first(list); se != NULL;
1037 		    se = AVL_NEXT(list, se)) {
1038 			int error =
1039 			    copyout_entry(&se->se_bookmark, uaddr, count);
1040 			if (error != 0) {
1041 				return (error);
1042 			}
1043 		}
1044 		return (0);
1045 	}
1046 
1047 	for (se = avl_first(list); se != NULL; se = AVL_NEXT(list, se)) {
1048 		uint64_t head_ds = 0;
1049 		int error = get_head_ds(spa, se->se_bookmark.zb_objset,
1050 		    &head_ds);
1051 
1052 		/*
1053 		 * If get_head_ds() errors out, set the head filesystem
1054 		 * to the filesystem stored in the bookmark of the
1055 		 * error block.
1056 		 */
1057 		if (error != 0)
1058 			head_ds = se->se_bookmark.zb_objset;
1059 
1060 		error = process_error_block(spa, head_ds,
1061 		    &se->se_zep, uaddr, count);
1062 		if (error != 0)
1063 			return (error);
1064 	}
1065 	return (0);
1066 }
1067 #endif
1068 
1069 /*
1070  * Copy all known errors to userland as an array of bookmarks.  This is
1071  * actually a union of the on-disk last log and current log, as well as any
1072  * pending error requests.
1073  *
1074  * Because the act of reading the on-disk log could cause errors to be
1075  * generated, we have two separate locks: one for the error log and one for the
1076  * in-core error lists.  We only need the error list lock to log and error, so
1077  * we grab the error log lock while we read the on-disk logs, and only pick up
1078  * the error list lock when we are finished.
1079  */
1080 int
1081 spa_get_errlog(spa_t *spa, void *uaddr, uint64_t *count)
1082 {
1083 	int ret = 0;
1084 
1085 #ifdef _KERNEL
1086 	/*
1087 	 * The pool config lock is needed to hold a dataset_t via (among other
1088 	 * places) process_error_list() -> process_error_block()->
1089 	 * find_top_affected_fs(), and lock ordering requires that we get it
1090 	 * before the spa_errlog_lock.
1091 	 */
1092 	dsl_pool_config_enter(spa->spa_dsl_pool, FTAG);
1093 	mutex_enter(&spa->spa_errlog_lock);
1094 
1095 	ret = process_error_log(spa, spa->spa_errlog_scrub, uaddr, count);
1096 
1097 	if (!ret && !spa->spa_scrub_finished)
1098 		ret = process_error_log(spa, spa->spa_errlog_last, uaddr,
1099 		    count);
1100 
1101 	mutex_enter(&spa->spa_errlist_lock);
1102 	if (!ret)
1103 		ret = process_error_list(spa, &spa->spa_errlist_scrub, uaddr,
1104 		    count);
1105 	if (!ret)
1106 		ret = process_error_list(spa, &spa->spa_errlist_last, uaddr,
1107 		    count);
1108 	mutex_exit(&spa->spa_errlist_lock);
1109 
1110 	mutex_exit(&spa->spa_errlog_lock);
1111 	dsl_pool_config_exit(spa->spa_dsl_pool, FTAG);
1112 #else
1113 	(void) spa, (void) uaddr, (void) count;
1114 #endif
1115 
1116 	return (ret);
1117 }
1118 
1119 /*
1120  * Called when a scrub completes.  This simply set a bit which tells which AVL
1121  * tree to add new errors.  spa_errlog_sync() is responsible for actually
1122  * syncing the changes to the underlying objects.
1123  */
1124 void
1125 spa_errlog_rotate(spa_t *spa)
1126 {
1127 	mutex_enter(&spa->spa_errlist_lock);
1128 	spa->spa_scrub_finished = B_TRUE;
1129 	mutex_exit(&spa->spa_errlist_lock);
1130 }
1131 
1132 /*
1133  * Discard any pending errors from the spa_t.  Called when unloading a faulted
1134  * pool, as the errors encountered during the open cannot be synced to disk.
1135  */
1136 void
1137 spa_errlog_drain(spa_t *spa)
1138 {
1139 	spa_error_entry_t *se;
1140 	void *cookie;
1141 
1142 	mutex_enter(&spa->spa_errlist_lock);
1143 
1144 	cookie = NULL;
1145 	while ((se = avl_destroy_nodes(&spa->spa_errlist_last,
1146 	    &cookie)) != NULL)
1147 		kmem_free(se, sizeof (spa_error_entry_t));
1148 	cookie = NULL;
1149 	while ((se = avl_destroy_nodes(&spa->spa_errlist_scrub,
1150 	    &cookie)) != NULL)
1151 		kmem_free(se, sizeof (spa_error_entry_t));
1152 
1153 	mutex_exit(&spa->spa_errlist_lock);
1154 }
1155 
1156 /*
1157  * Process a list of errors into the current on-disk log.
1158  */
1159 void
1160 sync_error_list(spa_t *spa, avl_tree_t *t, uint64_t *obj, dmu_tx_t *tx)
1161 {
1162 	spa_error_entry_t *se;
1163 	char buf[NAME_MAX_LEN];
1164 	void *cookie;
1165 
1166 	if (avl_numnodes(t) == 0)
1167 		return;
1168 
1169 	/* create log if necessary */
1170 	if (*obj == 0)
1171 		*obj = zap_create(spa->spa_meta_objset, DMU_OT_ERROR_LOG,
1172 		    DMU_OT_NONE, 0, tx);
1173 
1174 	/* add errors to the current log */
1175 	if (!spa_feature_is_enabled(spa, SPA_FEATURE_HEAD_ERRLOG)) {
1176 		for (se = avl_first(t); se != NULL; se = AVL_NEXT(t, se)) {
1177 			bookmark_to_name(&se->se_bookmark, buf, sizeof (buf));
1178 
1179 			const char *name = se->se_name ? se->se_name : "";
1180 			(void) zap_update(spa->spa_meta_objset, *obj, buf, 1,
1181 			    strlen(name) + 1, name, tx);
1182 		}
1183 	} else {
1184 		for (se = avl_first(t); se != NULL; se = AVL_NEXT(t, se)) {
1185 			zbookmark_err_phys_t zep;
1186 			zep.zb_object = se->se_zep.zb_object;
1187 			zep.zb_level = se->se_zep.zb_level;
1188 			zep.zb_blkid = se->se_zep.zb_blkid;
1189 			zep.zb_birth = se->se_zep.zb_birth;
1190 
1191 			uint64_t head_ds = 0;
1192 			int error = get_head_ds(spa, se->se_bookmark.zb_objset,
1193 			    &head_ds);
1194 
1195 			/*
1196 			 * If get_head_ds() errors out, set the head filesystem
1197 			 * to the filesystem stored in the bookmark of the
1198 			 * error block.
1199 			 */
1200 			if (error != 0)
1201 				head_ds = se->se_bookmark.zb_objset;
1202 
1203 			uint64_t err_obj;
1204 			error = zap_lookup_int_key(spa->spa_meta_objset,
1205 			    *obj, head_ds, &err_obj);
1206 
1207 			if (error == ENOENT) {
1208 				err_obj = zap_create(spa->spa_meta_objset,
1209 				    DMU_OT_ERROR_LOG, DMU_OT_NONE, 0, tx);
1210 
1211 				(void) zap_update_int_key(spa->spa_meta_objset,
1212 				    *obj, head_ds, err_obj, tx);
1213 			}
1214 			errphys_to_name(&zep, buf, sizeof (buf));
1215 
1216 			const char *name = se->se_name ? se->se_name : "";
1217 			(void) zap_update(spa->spa_meta_objset,
1218 			    err_obj, buf, 1, strlen(name) + 1, name, tx);
1219 		}
1220 	}
1221 	/* purge the error list */
1222 	cookie = NULL;
1223 	while ((se = avl_destroy_nodes(t, &cookie)) != NULL)
1224 		kmem_free(se, sizeof (spa_error_entry_t));
1225 }
1226 
1227 static void
1228 delete_errlog(spa_t *spa, uint64_t spa_err_obj, dmu_tx_t *tx)
1229 {
1230 	if (spa_feature_is_enabled(spa, SPA_FEATURE_HEAD_ERRLOG)) {
1231 		zap_cursor_t zc;
1232 		zap_attribute_t za;
1233 		for (zap_cursor_init(&zc, spa->spa_meta_objset, spa_err_obj);
1234 		    zap_cursor_retrieve(&zc, &za) == 0;
1235 		    zap_cursor_advance(&zc)) {
1236 			VERIFY0(dmu_object_free(spa->spa_meta_objset,
1237 			    za.za_first_integer, tx));
1238 		}
1239 		zap_cursor_fini(&zc);
1240 	}
1241 	VERIFY0(dmu_object_free(spa->spa_meta_objset, spa_err_obj, tx));
1242 }
1243 
1244 /*
1245  * Sync the error log out to disk.  This is a little tricky because the act of
1246  * writing the error log requires the spa_errlist_lock.  So, we need to lock the
1247  * error lists, take a copy of the lists, and then reinitialize them.  Then, we
1248  * drop the error list lock and take the error log lock, at which point we
1249  * do the errlog processing.  Then, if we encounter an I/O error during this
1250  * process, we can successfully add the error to the list.  Note that this will
1251  * result in the perpetual recycling of errors, but it is an unlikely situation
1252  * and not a performance critical operation.
1253  */
1254 void
1255 spa_errlog_sync(spa_t *spa, uint64_t txg)
1256 {
1257 	dmu_tx_t *tx;
1258 	avl_tree_t scrub, last;
1259 	int scrub_finished;
1260 
1261 	mutex_enter(&spa->spa_errlist_lock);
1262 
1263 	/*
1264 	 * Bail out early under normal circumstances.
1265 	 */
1266 	if (avl_numnodes(&spa->spa_errlist_scrub) == 0 &&
1267 	    avl_numnodes(&spa->spa_errlist_last) == 0 &&
1268 	    avl_numnodes(&spa->spa_errlist_healed) == 0 &&
1269 	    !spa->spa_scrub_finished) {
1270 		mutex_exit(&spa->spa_errlist_lock);
1271 		return;
1272 	}
1273 
1274 	spa_get_errlists(spa, &last, &scrub);
1275 	scrub_finished = spa->spa_scrub_finished;
1276 	spa->spa_scrub_finished = B_FALSE;
1277 
1278 	mutex_exit(&spa->spa_errlist_lock);
1279 
1280 	/*
1281 	 * The pool config lock is needed to hold a dataset_t via
1282 	 * sync_error_list() -> get_head_ds(), and lock ordering
1283 	 * requires that we get it before the spa_errlog_lock.
1284 	 */
1285 	dsl_pool_config_enter(spa->spa_dsl_pool, FTAG);
1286 	mutex_enter(&spa->spa_errlog_lock);
1287 
1288 	tx = dmu_tx_create_assigned(spa->spa_dsl_pool, txg);
1289 
1290 	/*
1291 	 * Remove healed errors from errors.
1292 	 */
1293 	spa_remove_healed_errors(spa, &last, &scrub, tx);
1294 
1295 	/*
1296 	 * Sync out the current list of errors.
1297 	 */
1298 	sync_error_list(spa, &last, &spa->spa_errlog_last, tx);
1299 
1300 	/*
1301 	 * Rotate the log if necessary.
1302 	 */
1303 	if (scrub_finished) {
1304 		if (spa->spa_errlog_last != 0)
1305 			delete_errlog(spa, spa->spa_errlog_last, tx);
1306 		spa->spa_errlog_last = spa->spa_errlog_scrub;
1307 		spa->spa_errlog_scrub = 0;
1308 
1309 		sync_error_list(spa, &scrub, &spa->spa_errlog_last, tx);
1310 	}
1311 
1312 	/*
1313 	 * Sync out any pending scrub errors.
1314 	 */
1315 	sync_error_list(spa, &scrub, &spa->spa_errlog_scrub, tx);
1316 
1317 	/*
1318 	 * Update the MOS to reflect the new values.
1319 	 */
1320 	(void) zap_update(spa->spa_meta_objset, DMU_POOL_DIRECTORY_OBJECT,
1321 	    DMU_POOL_ERRLOG_LAST, sizeof (uint64_t), 1,
1322 	    &spa->spa_errlog_last, tx);
1323 	(void) zap_update(spa->spa_meta_objset, DMU_POOL_DIRECTORY_OBJECT,
1324 	    DMU_POOL_ERRLOG_SCRUB, sizeof (uint64_t), 1,
1325 	    &spa->spa_errlog_scrub, tx);
1326 
1327 	dmu_tx_commit(tx);
1328 
1329 	mutex_exit(&spa->spa_errlog_lock);
1330 	dsl_pool_config_exit(spa->spa_dsl_pool, FTAG);
1331 }
1332 
1333 static void
1334 delete_dataset_errlog(spa_t *spa, uint64_t spa_err_obj, uint64_t ds,
1335     dmu_tx_t *tx)
1336 {
1337 	if (spa_err_obj == 0)
1338 		return;
1339 
1340 	zap_cursor_t zc;
1341 	zap_attribute_t za;
1342 	for (zap_cursor_init(&zc, spa->spa_meta_objset, spa_err_obj);
1343 	    zap_cursor_retrieve(&zc, &za) == 0; zap_cursor_advance(&zc)) {
1344 		uint64_t head_ds;
1345 		name_to_object(za.za_name, &head_ds);
1346 		if (head_ds == ds) {
1347 			(void) zap_remove(spa->spa_meta_objset, spa_err_obj,
1348 			    za.za_name, tx);
1349 			VERIFY0(dmu_object_free(spa->spa_meta_objset,
1350 			    za.za_first_integer, tx));
1351 			break;
1352 		}
1353 	}
1354 	zap_cursor_fini(&zc);
1355 }
1356 
1357 void
1358 spa_delete_dataset_errlog(spa_t *spa, uint64_t ds, dmu_tx_t *tx)
1359 {
1360 	mutex_enter(&spa->spa_errlog_lock);
1361 	delete_dataset_errlog(spa, spa->spa_errlog_scrub, ds, tx);
1362 	delete_dataset_errlog(spa, spa->spa_errlog_last, ds, tx);
1363 	mutex_exit(&spa->spa_errlog_lock);
1364 }
1365 
1366 static int
1367 find_txg_ancestor_snapshot(spa_t *spa, uint64_t new_head, uint64_t old_head,
1368     uint64_t *txg)
1369 {
1370 	dsl_dataset_t *ds;
1371 	dsl_pool_t *dp = spa->spa_dsl_pool;
1372 
1373 	int error = dsl_dataset_hold_obj_flags(dp, old_head,
1374 	    DS_HOLD_FLAG_DECRYPT, FTAG, &ds);
1375 	if (error != 0)
1376 		return (error);
1377 
1378 	uint64_t prev_obj = dsl_dataset_phys(ds)->ds_prev_snap_obj;
1379 	uint64_t prev_obj_txg = dsl_dataset_phys(ds)->ds_prev_snap_txg;
1380 
1381 	while (prev_obj != 0) {
1382 		dsl_dataset_rele_flags(ds, DS_HOLD_FLAG_DECRYPT, FTAG);
1383 		if ((error = dsl_dataset_hold_obj_flags(dp, prev_obj,
1384 		    DS_HOLD_FLAG_DECRYPT, FTAG, &ds)) == 0 &&
1385 		    dsl_dir_phys(ds->ds_dir)->dd_head_dataset_obj == new_head)
1386 			break;
1387 
1388 		if (error != 0)
1389 			return (error);
1390 
1391 		prev_obj_txg = dsl_dataset_phys(ds)->ds_prev_snap_txg;
1392 		prev_obj = dsl_dataset_phys(ds)->ds_prev_snap_obj;
1393 	}
1394 	dsl_dataset_rele_flags(ds, DS_HOLD_FLAG_DECRYPT, FTAG);
1395 	ASSERT(prev_obj != 0);
1396 	*txg = prev_obj_txg;
1397 	return (0);
1398 }
1399 
1400 static void
1401 swap_errlog(spa_t *spa, uint64_t spa_err_obj, uint64_t new_head, uint64_t
1402     old_head, dmu_tx_t *tx)
1403 {
1404 	if (spa_err_obj == 0)
1405 		return;
1406 
1407 	uint64_t old_head_errlog;
1408 	int error = zap_lookup_int_key(spa->spa_meta_objset, spa_err_obj,
1409 	    old_head, &old_head_errlog);
1410 
1411 	/* If no error log, then there is nothing to do. */
1412 	if (error != 0)
1413 		return;
1414 
1415 	uint64_t txg;
1416 	error = find_txg_ancestor_snapshot(spa, new_head, old_head, &txg);
1417 	if (error != 0)
1418 		return;
1419 
1420 	/*
1421 	 * Create an error log if the file system being promoted does not
1422 	 * already have one.
1423 	 */
1424 	uint64_t new_head_errlog;
1425 	error = zap_lookup_int_key(spa->spa_meta_objset, spa_err_obj, new_head,
1426 	    &new_head_errlog);
1427 
1428 	if (error != 0) {
1429 		new_head_errlog = zap_create(spa->spa_meta_objset,
1430 		    DMU_OT_ERROR_LOG, DMU_OT_NONE, 0, tx);
1431 
1432 		(void) zap_update_int_key(spa->spa_meta_objset, spa_err_obj,
1433 		    new_head, new_head_errlog, tx);
1434 	}
1435 
1436 	zap_cursor_t zc;
1437 	zap_attribute_t za;
1438 	zbookmark_err_phys_t err_block;
1439 	for (zap_cursor_init(&zc, spa->spa_meta_objset, old_head_errlog);
1440 	    zap_cursor_retrieve(&zc, &za) == 0; zap_cursor_advance(&zc)) {
1441 
1442 		const char *name = "";
1443 		name_to_errphys(za.za_name, &err_block);
1444 		if (err_block.zb_birth < txg) {
1445 			(void) zap_update(spa->spa_meta_objset, new_head_errlog,
1446 			    za.za_name, 1, strlen(name) + 1, name, tx);
1447 
1448 			(void) zap_remove(spa->spa_meta_objset, old_head_errlog,
1449 			    za.za_name, tx);
1450 		}
1451 	}
1452 	zap_cursor_fini(&zc);
1453 }
1454 
1455 void
1456 spa_swap_errlog(spa_t *spa, uint64_t new_head_ds, uint64_t old_head_ds,
1457     dmu_tx_t *tx)
1458 {
1459 	mutex_enter(&spa->spa_errlog_lock);
1460 	swap_errlog(spa, spa->spa_errlog_scrub, new_head_ds, old_head_ds, tx);
1461 	swap_errlog(spa, spa->spa_errlog_last, new_head_ds, old_head_ds, tx);
1462 	mutex_exit(&spa->spa_errlog_lock);
1463 }
1464 
1465 #if defined(_KERNEL)
1466 /* error handling */
1467 EXPORT_SYMBOL(spa_log_error);
1468 EXPORT_SYMBOL(spa_approx_errlog_size);
1469 EXPORT_SYMBOL(spa_get_last_errlog_size);
1470 EXPORT_SYMBOL(spa_get_errlog);
1471 EXPORT_SYMBOL(spa_errlog_rotate);
1472 EXPORT_SYMBOL(spa_errlog_drain);
1473 EXPORT_SYMBOL(spa_errlog_sync);
1474 EXPORT_SYMBOL(spa_get_errlists);
1475 EXPORT_SYMBOL(spa_delete_dataset_errlog);
1476 EXPORT_SYMBOL(spa_swap_errlog);
1477 EXPORT_SYMBOL(sync_error_list);
1478 EXPORT_SYMBOL(spa_upgrade_errlog);
1479 EXPORT_SYMBOL(find_top_affected_fs);
1480 EXPORT_SYMBOL(find_birth_txg);
1481 EXPORT_SYMBOL(zep_to_zb);
1482 EXPORT_SYMBOL(name_to_errphys);
1483 #endif
1484 
1485 /* BEGIN CSTYLED */
1486 ZFS_MODULE_PARAM(zfs_spa, spa_, upgrade_errlog_limit, UINT, ZMOD_RW,
1487 	"Limit the number of errors which will be upgraded to the new "
1488 	"on-disk error log when enabling head_errlog");
1489 /* END CSTYLED */
1490