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) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
23  * Copyright 2011 Nexenta Systems, Inc. All rights reserved.
24  * Copyright (c) 2011, 2020 by Delphix. All rights reserved.
25  * Copyright (c) 2014, Joyent, Inc. All rights reserved.
26  * Copyright 2014 HybridCluster. All rights reserved.
27  * Copyright (c) 2018, loli10K <[email protected]>. All rights reserved.
28  * Copyright (c) 2019, Klara Inc.
29  * Copyright (c) 2019, Allan Jude
30  * Copyright (c) 2019 Datto Inc.
31  * Copyright (c) 2022 Axcient.
32  */
33 
34 #include <sys/arc.h>
35 #include <sys/spa_impl.h>
36 #include <sys/dmu.h>
37 #include <sys/dmu_impl.h>
38 #include <sys/dmu_send.h>
39 #include <sys/dmu_recv.h>
40 #include <sys/dmu_tx.h>
41 #include <sys/dbuf.h>
42 #include <sys/dnode.h>
43 #include <sys/zfs_context.h>
44 #include <sys/dmu_objset.h>
45 #include <sys/dmu_traverse.h>
46 #include <sys/dsl_dataset.h>
47 #include <sys/dsl_dir.h>
48 #include <sys/dsl_prop.h>
49 #include <sys/dsl_pool.h>
50 #include <sys/dsl_synctask.h>
51 #include <sys/zfs_ioctl.h>
52 #include <sys/zap.h>
53 #include <sys/zvol.h>
54 #include <sys/zio_checksum.h>
55 #include <sys/zfs_znode.h>
56 #include <zfs_fletcher.h>
57 #include <sys/avl.h>
58 #include <sys/ddt.h>
59 #include <sys/zfs_onexit.h>
60 #include <sys/dsl_destroy.h>
61 #include <sys/blkptr.h>
62 #include <sys/dsl_bookmark.h>
63 #include <sys/zfeature.h>
64 #include <sys/bqueue.h>
65 #include <sys/objlist.h>
66 #ifdef _KERNEL
67 #include <sys/zfs_vfsops.h>
68 #endif
69 #include <sys/zfs_file.h>
70 
71 static uint_t zfs_recv_queue_length = SPA_MAXBLOCKSIZE;
72 static uint_t zfs_recv_queue_ff = 20;
73 static uint_t zfs_recv_write_batch_size = 1024 * 1024;
74 static int zfs_recv_best_effort_corrective = 0;
75 
76 static const void *const dmu_recv_tag = "dmu_recv_tag";
77 const char *const recv_clone_name = "%recv";
78 
79 typedef enum {
80 	ORNS_NO,
81 	ORNS_YES,
82 	ORNS_MAYBE
83 } or_need_sync_t;
84 
85 static int receive_read_payload_and_next_header(dmu_recv_cookie_t *ra, int len,
86     void *buf);
87 
88 struct receive_record_arg {
89 	dmu_replay_record_t header;
90 	void *payload; /* Pointer to a buffer containing the payload */
91 	/*
92 	 * If the record is a WRITE or SPILL, pointer to the abd containing the
93 	 * payload.
94 	 */
95 	abd_t *abd;
96 	int payload_size;
97 	uint64_t bytes_read; /* bytes read from stream when record created */
98 	boolean_t eos_marker; /* Marks the end of the stream */
99 	bqueue_node_t node;
100 };
101 
102 struct receive_writer_arg {
103 	objset_t *os;
104 	boolean_t byteswap;
105 	bqueue_t q;
106 
107 	/*
108 	 * These three members are used to signal to the main thread when
109 	 * we're done.
110 	 */
111 	kmutex_t mutex;
112 	kcondvar_t cv;
113 	boolean_t done;
114 
115 	int err;
116 	const char *tofs;
117 	boolean_t heal;
118 	boolean_t resumable;
119 	boolean_t raw;   /* DMU_BACKUP_FEATURE_RAW set */
120 	boolean_t spill; /* DRR_FLAG_SPILL_BLOCK set */
121 	boolean_t full;  /* this is a full send stream */
122 	uint64_t last_object;
123 	uint64_t last_offset;
124 	uint64_t max_object; /* highest object ID referenced in stream */
125 	uint64_t bytes_read; /* bytes read when current record created */
126 
127 	list_t write_batch;
128 
129 	/* Encryption parameters for the last received DRR_OBJECT_RANGE */
130 	boolean_t or_crypt_params_present;
131 	uint64_t or_firstobj;
132 	uint64_t or_numslots;
133 	uint8_t or_salt[ZIO_DATA_SALT_LEN];
134 	uint8_t or_iv[ZIO_DATA_IV_LEN];
135 	uint8_t or_mac[ZIO_DATA_MAC_LEN];
136 	boolean_t or_byteorder;
137 	zio_t *heal_pio;
138 
139 	/* Keep track of DRR_FREEOBJECTS right after DRR_OBJECT_RANGE */
140 	or_need_sync_t or_need_sync;
141 };
142 
143 typedef struct dmu_recv_begin_arg {
144 	const char *drba_origin;
145 	dmu_recv_cookie_t *drba_cookie;
146 	cred_t *drba_cred;
147 	proc_t *drba_proc;
148 	dsl_crypto_params_t *drba_dcp;
149 } dmu_recv_begin_arg_t;
150 
151 static void
byteswap_record(dmu_replay_record_t * drr)152 byteswap_record(dmu_replay_record_t *drr)
153 {
154 #define	DO64(X) (drr->drr_u.X = BSWAP_64(drr->drr_u.X))
155 #define	DO32(X) (drr->drr_u.X = BSWAP_32(drr->drr_u.X))
156 	drr->drr_type = BSWAP_32(drr->drr_type);
157 	drr->drr_payloadlen = BSWAP_32(drr->drr_payloadlen);
158 
159 	switch (drr->drr_type) {
160 	case DRR_BEGIN:
161 		DO64(drr_begin.drr_magic);
162 		DO64(drr_begin.drr_versioninfo);
163 		DO64(drr_begin.drr_creation_time);
164 		DO32(drr_begin.drr_type);
165 		DO32(drr_begin.drr_flags);
166 		DO64(drr_begin.drr_toguid);
167 		DO64(drr_begin.drr_fromguid);
168 		break;
169 	case DRR_OBJECT:
170 		DO64(drr_object.drr_object);
171 		DO32(drr_object.drr_type);
172 		DO32(drr_object.drr_bonustype);
173 		DO32(drr_object.drr_blksz);
174 		DO32(drr_object.drr_bonuslen);
175 		DO32(drr_object.drr_raw_bonuslen);
176 		DO64(drr_object.drr_toguid);
177 		DO64(drr_object.drr_maxblkid);
178 		break;
179 	case DRR_FREEOBJECTS:
180 		DO64(drr_freeobjects.drr_firstobj);
181 		DO64(drr_freeobjects.drr_numobjs);
182 		DO64(drr_freeobjects.drr_toguid);
183 		break;
184 	case DRR_WRITE:
185 		DO64(drr_write.drr_object);
186 		DO32(drr_write.drr_type);
187 		DO64(drr_write.drr_offset);
188 		DO64(drr_write.drr_logical_size);
189 		DO64(drr_write.drr_toguid);
190 		ZIO_CHECKSUM_BSWAP(&drr->drr_u.drr_write.drr_key.ddk_cksum);
191 		DO64(drr_write.drr_key.ddk_prop);
192 		DO64(drr_write.drr_compressed_size);
193 		break;
194 	case DRR_WRITE_EMBEDDED:
195 		DO64(drr_write_embedded.drr_object);
196 		DO64(drr_write_embedded.drr_offset);
197 		DO64(drr_write_embedded.drr_length);
198 		DO64(drr_write_embedded.drr_toguid);
199 		DO32(drr_write_embedded.drr_lsize);
200 		DO32(drr_write_embedded.drr_psize);
201 		break;
202 	case DRR_FREE:
203 		DO64(drr_free.drr_object);
204 		DO64(drr_free.drr_offset);
205 		DO64(drr_free.drr_length);
206 		DO64(drr_free.drr_toguid);
207 		break;
208 	case DRR_SPILL:
209 		DO64(drr_spill.drr_object);
210 		DO64(drr_spill.drr_length);
211 		DO64(drr_spill.drr_toguid);
212 		DO64(drr_spill.drr_compressed_size);
213 		DO32(drr_spill.drr_type);
214 		break;
215 	case DRR_OBJECT_RANGE:
216 		DO64(drr_object_range.drr_firstobj);
217 		DO64(drr_object_range.drr_numslots);
218 		DO64(drr_object_range.drr_toguid);
219 		break;
220 	case DRR_REDACT:
221 		DO64(drr_redact.drr_object);
222 		DO64(drr_redact.drr_offset);
223 		DO64(drr_redact.drr_length);
224 		DO64(drr_redact.drr_toguid);
225 		break;
226 	case DRR_END:
227 		DO64(drr_end.drr_toguid);
228 		ZIO_CHECKSUM_BSWAP(&drr->drr_u.drr_end.drr_checksum);
229 		break;
230 	default:
231 		break;
232 	}
233 
234 	if (drr->drr_type != DRR_BEGIN) {
235 		ZIO_CHECKSUM_BSWAP(&drr->drr_u.drr_checksum.drr_checksum);
236 	}
237 
238 #undef DO64
239 #undef DO32
240 }
241 
242 static boolean_t
redact_snaps_contains(uint64_t * snaps,uint64_t num_snaps,uint64_t guid)243 redact_snaps_contains(uint64_t *snaps, uint64_t num_snaps, uint64_t guid)
244 {
245 	for (int i = 0; i < num_snaps; i++) {
246 		if (snaps[i] == guid)
247 			return (B_TRUE);
248 	}
249 	return (B_FALSE);
250 }
251 
252 /*
253  * Check that the new stream we're trying to receive is redacted with respect to
254  * a subset of the snapshots that the origin was redacted with respect to.  For
255  * the reasons behind this, see the man page on redacted zfs sends and receives.
256  */
257 static boolean_t
compatible_redact_snaps(uint64_t * origin_snaps,uint64_t origin_num_snaps,uint64_t * redact_snaps,uint64_t num_redact_snaps)258 compatible_redact_snaps(uint64_t *origin_snaps, uint64_t origin_num_snaps,
259     uint64_t *redact_snaps, uint64_t num_redact_snaps)
260 {
261 	/*
262 	 * Short circuit the comparison; if we are redacted with respect to
263 	 * more snapshots than the origin, we can't be redacted with respect
264 	 * to a subset.
265 	 */
266 	if (num_redact_snaps > origin_num_snaps) {
267 		return (B_FALSE);
268 	}
269 
270 	for (int i = 0; i < num_redact_snaps; i++) {
271 		if (!redact_snaps_contains(origin_snaps, origin_num_snaps,
272 		    redact_snaps[i])) {
273 			return (B_FALSE);
274 		}
275 	}
276 	return (B_TRUE);
277 }
278 
279 static boolean_t
redact_check(dmu_recv_begin_arg_t * drba,dsl_dataset_t * origin)280 redact_check(dmu_recv_begin_arg_t *drba, dsl_dataset_t *origin)
281 {
282 	uint64_t *origin_snaps;
283 	uint64_t origin_num_snaps;
284 	dmu_recv_cookie_t *drc = drba->drba_cookie;
285 	struct drr_begin *drrb = drc->drc_drrb;
286 	int featureflags = DMU_GET_FEATUREFLAGS(drrb->drr_versioninfo);
287 	int err = 0;
288 	boolean_t ret = B_TRUE;
289 	uint64_t *redact_snaps;
290 	uint_t numredactsnaps;
291 
292 	/*
293 	 * If this is a full send stream, we're safe no matter what.
294 	 */
295 	if (drrb->drr_fromguid == 0)
296 		return (ret);
297 
298 	VERIFY(dsl_dataset_get_uint64_array_feature(origin,
299 	    SPA_FEATURE_REDACTED_DATASETS, &origin_num_snaps, &origin_snaps));
300 
301 	if (nvlist_lookup_uint64_array(drc->drc_begin_nvl,
302 	    BEGINNV_REDACT_FROM_SNAPS, &redact_snaps, &numredactsnaps) ==
303 	    0) {
304 		/*
305 		 * If the send stream was sent from the redaction bookmark or
306 		 * the redacted version of the dataset, then we're safe.  Verify
307 		 * that this is from the a compatible redaction bookmark or
308 		 * redacted dataset.
309 		 */
310 		if (!compatible_redact_snaps(origin_snaps, origin_num_snaps,
311 		    redact_snaps, numredactsnaps)) {
312 			err = EINVAL;
313 		}
314 	} else if (featureflags & DMU_BACKUP_FEATURE_REDACTED) {
315 		/*
316 		 * If the stream is redacted, it must be redacted with respect
317 		 * to a subset of what the origin is redacted with respect to.
318 		 * See case number 2 in the zfs man page section on redacted zfs
319 		 * send.
320 		 */
321 		err = nvlist_lookup_uint64_array(drc->drc_begin_nvl,
322 		    BEGINNV_REDACT_SNAPS, &redact_snaps, &numredactsnaps);
323 
324 		if (err != 0 || !compatible_redact_snaps(origin_snaps,
325 		    origin_num_snaps, redact_snaps, numredactsnaps)) {
326 			err = EINVAL;
327 		}
328 	} else if (!redact_snaps_contains(origin_snaps, origin_num_snaps,
329 	    drrb->drr_toguid)) {
330 		/*
331 		 * If the stream isn't redacted but the origin is, this must be
332 		 * one of the snapshots the origin is redacted with respect to.
333 		 * See case number 1 in the zfs man page section on redacted zfs
334 		 * send.
335 		 */
336 		err = EINVAL;
337 	}
338 
339 	if (err != 0)
340 		ret = B_FALSE;
341 	return (ret);
342 }
343 
344 /*
345  * If we previously received a stream with --large-block, we don't support
346  * receiving an incremental on top of it without --large-block.  This avoids
347  * forcing a read-modify-write or trying to re-aggregate a string of WRITE
348  * records.
349  */
350 static int
recv_check_large_blocks(dsl_dataset_t * ds,uint64_t featureflags)351 recv_check_large_blocks(dsl_dataset_t *ds, uint64_t featureflags)
352 {
353 	if (dsl_dataset_feature_is_active(ds, SPA_FEATURE_LARGE_BLOCKS) &&
354 	    !(featureflags & DMU_BACKUP_FEATURE_LARGE_BLOCKS))
355 		return (SET_ERROR(ZFS_ERR_STREAM_LARGE_BLOCK_MISMATCH));
356 	return (0);
357 }
358 
359 static int
recv_begin_check_existing_impl(dmu_recv_begin_arg_t * drba,dsl_dataset_t * ds,uint64_t fromguid,uint64_t featureflags)360 recv_begin_check_existing_impl(dmu_recv_begin_arg_t *drba, dsl_dataset_t *ds,
361     uint64_t fromguid, uint64_t featureflags)
362 {
363 	uint64_t obj;
364 	uint64_t children;
365 	int error;
366 	dsl_dataset_t *snap;
367 	dsl_pool_t *dp = ds->ds_dir->dd_pool;
368 	boolean_t encrypted = ds->ds_dir->dd_crypto_obj != 0;
369 	boolean_t raw = (featureflags & DMU_BACKUP_FEATURE_RAW) != 0;
370 	boolean_t embed = (featureflags & DMU_BACKUP_FEATURE_EMBED_DATA) != 0;
371 
372 	/* Temporary clone name must not exist. */
373 	error = zap_lookup(dp->dp_meta_objset,
374 	    dsl_dir_phys(ds->ds_dir)->dd_child_dir_zapobj, recv_clone_name,
375 	    8, 1, &obj);
376 	if (error != ENOENT)
377 		return (error == 0 ? SET_ERROR(EBUSY) : error);
378 
379 	/* Resume state must not be set. */
380 	if (dsl_dataset_has_resume_receive_state(ds))
381 		return (SET_ERROR(EBUSY));
382 
383 	/* New snapshot name must not exist if we're not healing it. */
384 	error = zap_lookup(dp->dp_meta_objset,
385 	    dsl_dataset_phys(ds)->ds_snapnames_zapobj,
386 	    drba->drba_cookie->drc_tosnap, 8, 1, &obj);
387 	if (drba->drba_cookie->drc_heal) {
388 		if (error != 0)
389 			return (error);
390 	} else if (error != ENOENT) {
391 		return (error == 0 ? SET_ERROR(EEXIST) : error);
392 	}
393 
394 	/* Must not have children if receiving a ZVOL. */
395 	error = zap_count(dp->dp_meta_objset,
396 	    dsl_dir_phys(ds->ds_dir)->dd_child_dir_zapobj, &children);
397 	if (error != 0)
398 		return (error);
399 	if (drba->drba_cookie->drc_drrb->drr_type != DMU_OST_ZFS &&
400 	    children > 0)
401 		return (SET_ERROR(ZFS_ERR_WRONG_PARENT));
402 
403 	/*
404 	 * Check snapshot limit before receiving. We'll recheck again at the
405 	 * end, but might as well abort before receiving if we're already over
406 	 * the limit.
407 	 *
408 	 * Note that we do not check the file system limit with
409 	 * dsl_dir_fscount_check because the temporary %clones don't count
410 	 * against that limit.
411 	 */
412 	error = dsl_fs_ss_limit_check(ds->ds_dir, 1, ZFS_PROP_SNAPSHOT_LIMIT,
413 	    NULL, drba->drba_cred, drba->drba_proc);
414 	if (error != 0)
415 		return (error);
416 
417 	if (drba->drba_cookie->drc_heal) {
418 		/* Encryption is incompatible with embedded data. */
419 		if (encrypted && embed)
420 			return (SET_ERROR(EINVAL));
421 
422 		/* Healing is not supported when in 'force' mode. */
423 		if (drba->drba_cookie->drc_force)
424 			return (SET_ERROR(EINVAL));
425 
426 		/* Must have keys loaded if doing encrypted non-raw recv. */
427 		if (encrypted && !raw) {
428 			if (spa_keystore_lookup_key(dp->dp_spa, ds->ds_object,
429 			    NULL, NULL) != 0)
430 				return (SET_ERROR(EACCES));
431 		}
432 
433 		error = dsl_dataset_hold_obj(dp, obj, FTAG, &snap);
434 		if (error != 0)
435 			return (error);
436 
437 		/*
438 		 * When not doing best effort corrective recv healing can only
439 		 * be done if the send stream is for the same snapshot as the
440 		 * one we are trying to heal.
441 		 */
442 		if (zfs_recv_best_effort_corrective == 0 &&
443 		    drba->drba_cookie->drc_drrb->drr_toguid !=
444 		    dsl_dataset_phys(snap)->ds_guid) {
445 			dsl_dataset_rele(snap, FTAG);
446 			return (SET_ERROR(ENOTSUP));
447 		}
448 		dsl_dataset_rele(snap, FTAG);
449 	} else if (fromguid != 0) {
450 		/* Sanity check the incremental recv */
451 		uint64_t obj = dsl_dataset_phys(ds)->ds_prev_snap_obj;
452 
453 		/* Can't perform a raw receive on top of a non-raw receive */
454 		if (!encrypted && raw)
455 			return (SET_ERROR(EINVAL));
456 
457 		/* Encryption is incompatible with embedded data */
458 		if (encrypted && embed)
459 			return (SET_ERROR(EINVAL));
460 
461 		/* Find snapshot in this dir that matches fromguid. */
462 		while (obj != 0) {
463 			error = dsl_dataset_hold_obj(dp, obj, FTAG,
464 			    &snap);
465 			if (error != 0)
466 				return (SET_ERROR(ENODEV));
467 			if (snap->ds_dir != ds->ds_dir) {
468 				dsl_dataset_rele(snap, FTAG);
469 				return (SET_ERROR(ENODEV));
470 			}
471 			if (dsl_dataset_phys(snap)->ds_guid == fromguid)
472 				break;
473 			obj = dsl_dataset_phys(snap)->ds_prev_snap_obj;
474 			dsl_dataset_rele(snap, FTAG);
475 		}
476 		if (obj == 0)
477 			return (SET_ERROR(ENODEV));
478 
479 		if (drba->drba_cookie->drc_force) {
480 			drba->drba_cookie->drc_fromsnapobj = obj;
481 		} else {
482 			/*
483 			 * If we are not forcing, there must be no
484 			 * changes since fromsnap. Raw sends have an
485 			 * additional constraint that requires that
486 			 * no "noop" snapshots exist between fromsnap
487 			 * and tosnap for the IVset checking code to
488 			 * work properly.
489 			 */
490 			if (dsl_dataset_modified_since_snap(ds, snap) ||
491 			    (raw &&
492 			    dsl_dataset_phys(ds)->ds_prev_snap_obj !=
493 			    snap->ds_object)) {
494 				dsl_dataset_rele(snap, FTAG);
495 				return (SET_ERROR(ETXTBSY));
496 			}
497 			drba->drba_cookie->drc_fromsnapobj =
498 			    ds->ds_prev->ds_object;
499 		}
500 
501 		if (dsl_dataset_feature_is_active(snap,
502 		    SPA_FEATURE_REDACTED_DATASETS) && !redact_check(drba,
503 		    snap)) {
504 			dsl_dataset_rele(snap, FTAG);
505 			return (SET_ERROR(EINVAL));
506 		}
507 
508 		error = recv_check_large_blocks(snap, featureflags);
509 		if (error != 0) {
510 			dsl_dataset_rele(snap, FTAG);
511 			return (error);
512 		}
513 
514 		dsl_dataset_rele(snap, FTAG);
515 	} else {
516 		/* If full and not healing then must be forced. */
517 		if (!drba->drba_cookie->drc_force)
518 			return (SET_ERROR(EEXIST));
519 
520 		/*
521 		 * We don't support using zfs recv -F to blow away
522 		 * encrypted filesystems. This would require the
523 		 * dsl dir to point to the old encryption key and
524 		 * the new one at the same time during the receive.
525 		 */
526 		if ((!encrypted && raw) || encrypted)
527 			return (SET_ERROR(EINVAL));
528 
529 		/*
530 		 * Perform the same encryption checks we would if
531 		 * we were creating a new dataset from scratch.
532 		 */
533 		if (!raw) {
534 			boolean_t will_encrypt;
535 
536 			error = dmu_objset_create_crypt_check(
537 			    ds->ds_dir->dd_parent, drba->drba_dcp,
538 			    &will_encrypt);
539 			if (error != 0)
540 				return (error);
541 
542 			if (will_encrypt && embed)
543 				return (SET_ERROR(EINVAL));
544 		}
545 	}
546 
547 	return (0);
548 }
549 
550 /*
551  * Check that any feature flags used in the data stream we're receiving are
552  * supported by the pool we are receiving into.
553  *
554  * Note that some of the features we explicitly check here have additional
555  * (implicit) features they depend on, but those dependencies are enforced
556  * through the zfeature_register() calls declaring the features that we
557  * explicitly check.
558  */
559 static int
recv_begin_check_feature_flags_impl(uint64_t featureflags,spa_t * spa)560 recv_begin_check_feature_flags_impl(uint64_t featureflags, spa_t *spa)
561 {
562 	/*
563 	 * Check if there are any unsupported feature flags.
564 	 */
565 	if (!DMU_STREAM_SUPPORTED(featureflags)) {
566 		return (SET_ERROR(ZFS_ERR_UNKNOWN_SEND_STREAM_FEATURE));
567 	}
568 
569 	/* Verify pool version supports SA if SA_SPILL feature set */
570 	if ((featureflags & DMU_BACKUP_FEATURE_SA_SPILL) &&
571 	    spa_version(spa) < SPA_VERSION_SA)
572 		return (SET_ERROR(ENOTSUP));
573 
574 	/*
575 	 * LZ4 compressed, ZSTD compressed, embedded, mooched, large blocks,
576 	 * and large_dnodes in the stream can only be used if those pool
577 	 * features are enabled because we don't attempt to decompress /
578 	 * un-embed / un-mooch / split up the blocks / dnodes during the
579 	 * receive process.
580 	 */
581 	if ((featureflags & DMU_BACKUP_FEATURE_LZ4) &&
582 	    !spa_feature_is_enabled(spa, SPA_FEATURE_LZ4_COMPRESS))
583 		return (SET_ERROR(ENOTSUP));
584 	if ((featureflags & DMU_BACKUP_FEATURE_ZSTD) &&
585 	    !spa_feature_is_enabled(spa, SPA_FEATURE_ZSTD_COMPRESS))
586 		return (SET_ERROR(ENOTSUP));
587 	if ((featureflags & DMU_BACKUP_FEATURE_EMBED_DATA) &&
588 	    !spa_feature_is_enabled(spa, SPA_FEATURE_EMBEDDED_DATA))
589 		return (SET_ERROR(ENOTSUP));
590 	if ((featureflags & DMU_BACKUP_FEATURE_LARGE_BLOCKS) &&
591 	    !spa_feature_is_enabled(spa, SPA_FEATURE_LARGE_BLOCKS))
592 		return (SET_ERROR(ENOTSUP));
593 	if ((featureflags & DMU_BACKUP_FEATURE_LARGE_DNODE) &&
594 	    !spa_feature_is_enabled(spa, SPA_FEATURE_LARGE_DNODE))
595 		return (SET_ERROR(ENOTSUP));
596 
597 	/*
598 	 * Receiving redacted streams requires that redacted datasets are
599 	 * enabled.
600 	 */
601 	if ((featureflags & DMU_BACKUP_FEATURE_REDACTED) &&
602 	    !spa_feature_is_enabled(spa, SPA_FEATURE_REDACTED_DATASETS))
603 		return (SET_ERROR(ENOTSUP));
604 
605 	return (0);
606 }
607 
608 static int
dmu_recv_begin_check(void * arg,dmu_tx_t * tx)609 dmu_recv_begin_check(void *arg, dmu_tx_t *tx)
610 {
611 	dmu_recv_begin_arg_t *drba = arg;
612 	dsl_pool_t *dp = dmu_tx_pool(tx);
613 	struct drr_begin *drrb = drba->drba_cookie->drc_drrb;
614 	uint64_t fromguid = drrb->drr_fromguid;
615 	int flags = drrb->drr_flags;
616 	ds_hold_flags_t dsflags = DS_HOLD_FLAG_NONE;
617 	int error;
618 	uint64_t featureflags = drba->drba_cookie->drc_featureflags;
619 	dsl_dataset_t *ds;
620 	const char *tofs = drba->drba_cookie->drc_tofs;
621 
622 	/* already checked */
623 	ASSERT3U(drrb->drr_magic, ==, DMU_BACKUP_MAGIC);
624 	ASSERT(!(featureflags & DMU_BACKUP_FEATURE_RESUMING));
625 
626 	if (DMU_GET_STREAM_HDRTYPE(drrb->drr_versioninfo) ==
627 	    DMU_COMPOUNDSTREAM ||
628 	    drrb->drr_type >= DMU_OST_NUMTYPES ||
629 	    ((flags & DRR_FLAG_CLONE) && drba->drba_origin == NULL))
630 		return (SET_ERROR(EINVAL));
631 
632 	error = recv_begin_check_feature_flags_impl(featureflags, dp->dp_spa);
633 	if (error != 0)
634 		return (error);
635 
636 	/* Resumable receives require extensible datasets */
637 	if (drba->drba_cookie->drc_resumable &&
638 	    !spa_feature_is_enabled(dp->dp_spa, SPA_FEATURE_EXTENSIBLE_DATASET))
639 		return (SET_ERROR(ENOTSUP));
640 
641 	if (featureflags & DMU_BACKUP_FEATURE_RAW) {
642 		/* raw receives require the encryption feature */
643 		if (!spa_feature_is_enabled(dp->dp_spa, SPA_FEATURE_ENCRYPTION))
644 			return (SET_ERROR(ENOTSUP));
645 
646 		/* embedded data is incompatible with encryption and raw recv */
647 		if (featureflags & DMU_BACKUP_FEATURE_EMBED_DATA)
648 			return (SET_ERROR(EINVAL));
649 
650 		/* raw receives require spill block allocation flag */
651 		if (!(flags & DRR_FLAG_SPILL_BLOCK))
652 			return (SET_ERROR(ZFS_ERR_SPILL_BLOCK_FLAG_MISSING));
653 	} else {
654 		/*
655 		 * We support unencrypted datasets below encrypted ones now,
656 		 * so add the DS_HOLD_FLAG_DECRYPT flag only if we are dealing
657 		 * with a dataset we may encrypt.
658 		 */
659 		if (drba->drba_dcp == NULL ||
660 		    drba->drba_dcp->cp_crypt != ZIO_CRYPT_OFF) {
661 			dsflags |= DS_HOLD_FLAG_DECRYPT;
662 		}
663 	}
664 
665 	error = dsl_dataset_hold_flags(dp, tofs, dsflags, FTAG, &ds);
666 	if (error == 0) {
667 		/* target fs already exists; recv into temp clone */
668 
669 		/* Can't recv a clone into an existing fs */
670 		if (flags & DRR_FLAG_CLONE || drba->drba_origin) {
671 			dsl_dataset_rele_flags(ds, dsflags, FTAG);
672 			return (SET_ERROR(EINVAL));
673 		}
674 
675 		error = recv_begin_check_existing_impl(drba, ds, fromguid,
676 		    featureflags);
677 		dsl_dataset_rele_flags(ds, dsflags, FTAG);
678 	} else if (error == ENOENT) {
679 		/* target fs does not exist; must be a full backup or clone */
680 		char buf[ZFS_MAX_DATASET_NAME_LEN];
681 		objset_t *os;
682 
683 		/* healing recv must be done "into" an existing snapshot */
684 		if (drba->drba_cookie->drc_heal == B_TRUE)
685 			return (SET_ERROR(ENOTSUP));
686 
687 		/*
688 		 * If it's a non-clone incremental, we are missing the
689 		 * target fs, so fail the recv.
690 		 */
691 		if (fromguid != 0 && !((flags & DRR_FLAG_CLONE) ||
692 		    drba->drba_origin))
693 			return (SET_ERROR(ENOENT));
694 
695 		/*
696 		 * If we're receiving a full send as a clone, and it doesn't
697 		 * contain all the necessary free records and freeobject
698 		 * records, reject it.
699 		 */
700 		if (fromguid == 0 && drba->drba_origin != NULL &&
701 		    !(flags & DRR_FLAG_FREERECORDS))
702 			return (SET_ERROR(EINVAL));
703 
704 		/* Open the parent of tofs */
705 		ASSERT3U(strlen(tofs), <, sizeof (buf));
706 		(void) strlcpy(buf, tofs, strrchr(tofs, '/') - tofs + 1);
707 		error = dsl_dataset_hold(dp, buf, FTAG, &ds);
708 		if (error != 0)
709 			return (error);
710 
711 		if ((featureflags & DMU_BACKUP_FEATURE_RAW) == 0 &&
712 		    drba->drba_origin == NULL) {
713 			boolean_t will_encrypt;
714 
715 			/*
716 			 * Check that we aren't breaking any encryption rules
717 			 * and that we have all the parameters we need to
718 			 * create an encrypted dataset if necessary. If we are
719 			 * making an encrypted dataset the stream can't have
720 			 * embedded data.
721 			 */
722 			error = dmu_objset_create_crypt_check(ds->ds_dir,
723 			    drba->drba_dcp, &will_encrypt);
724 			if (error != 0) {
725 				dsl_dataset_rele(ds, FTAG);
726 				return (error);
727 			}
728 
729 			if (will_encrypt &&
730 			    (featureflags & DMU_BACKUP_FEATURE_EMBED_DATA)) {
731 				dsl_dataset_rele(ds, FTAG);
732 				return (SET_ERROR(EINVAL));
733 			}
734 		}
735 
736 		/*
737 		 * Check filesystem and snapshot limits before receiving. We'll
738 		 * recheck snapshot limits again at the end (we create the
739 		 * filesystems and increment those counts during begin_sync).
740 		 */
741 		error = dsl_fs_ss_limit_check(ds->ds_dir, 1,
742 		    ZFS_PROP_FILESYSTEM_LIMIT, NULL,
743 		    drba->drba_cred, drba->drba_proc);
744 		if (error != 0) {
745 			dsl_dataset_rele(ds, FTAG);
746 			return (error);
747 		}
748 
749 		error = dsl_fs_ss_limit_check(ds->ds_dir, 1,
750 		    ZFS_PROP_SNAPSHOT_LIMIT, NULL,
751 		    drba->drba_cred, drba->drba_proc);
752 		if (error != 0) {
753 			dsl_dataset_rele(ds, FTAG);
754 			return (error);
755 		}
756 
757 		/* can't recv below anything but filesystems (eg. no ZVOLs) */
758 		error = dmu_objset_from_ds(ds, &os);
759 		if (error != 0) {
760 			dsl_dataset_rele(ds, FTAG);
761 			return (error);
762 		}
763 		if (dmu_objset_type(os) != DMU_OST_ZFS) {
764 			dsl_dataset_rele(ds, FTAG);
765 			return (SET_ERROR(ZFS_ERR_WRONG_PARENT));
766 		}
767 
768 		if (drba->drba_origin != NULL) {
769 			dsl_dataset_t *origin;
770 			error = dsl_dataset_hold_flags(dp, drba->drba_origin,
771 			    dsflags, FTAG, &origin);
772 			if (error != 0) {
773 				dsl_dataset_rele(ds, FTAG);
774 				return (error);
775 			}
776 			if (!origin->ds_is_snapshot) {
777 				dsl_dataset_rele_flags(origin, dsflags, FTAG);
778 				dsl_dataset_rele(ds, FTAG);
779 				return (SET_ERROR(EINVAL));
780 			}
781 			if (dsl_dataset_phys(origin)->ds_guid != fromguid &&
782 			    fromguid != 0) {
783 				dsl_dataset_rele_flags(origin, dsflags, FTAG);
784 				dsl_dataset_rele(ds, FTAG);
785 				return (SET_ERROR(ENODEV));
786 			}
787 
788 			if (origin->ds_dir->dd_crypto_obj != 0 &&
789 			    (featureflags & DMU_BACKUP_FEATURE_EMBED_DATA)) {
790 				dsl_dataset_rele_flags(origin, dsflags, FTAG);
791 				dsl_dataset_rele(ds, FTAG);
792 				return (SET_ERROR(EINVAL));
793 			}
794 
795 			/*
796 			 * If the origin is redacted we need to verify that this
797 			 * send stream can safely be received on top of the
798 			 * origin.
799 			 */
800 			if (dsl_dataset_feature_is_active(origin,
801 			    SPA_FEATURE_REDACTED_DATASETS)) {
802 				if (!redact_check(drba, origin)) {
803 					dsl_dataset_rele_flags(origin, dsflags,
804 					    FTAG);
805 					dsl_dataset_rele_flags(ds, dsflags,
806 					    FTAG);
807 					return (SET_ERROR(EINVAL));
808 				}
809 			}
810 
811 			error = recv_check_large_blocks(ds, featureflags);
812 			if (error != 0) {
813 				dsl_dataset_rele_flags(origin, dsflags, FTAG);
814 				dsl_dataset_rele_flags(ds, dsflags, FTAG);
815 				return (error);
816 			}
817 
818 			dsl_dataset_rele_flags(origin, dsflags, FTAG);
819 		}
820 
821 		dsl_dataset_rele(ds, FTAG);
822 		error = 0;
823 	}
824 	return (error);
825 }
826 
827 static void
dmu_recv_begin_sync(void * arg,dmu_tx_t * tx)828 dmu_recv_begin_sync(void *arg, dmu_tx_t *tx)
829 {
830 	dmu_recv_begin_arg_t *drba = arg;
831 	dsl_pool_t *dp = dmu_tx_pool(tx);
832 	objset_t *mos = dp->dp_meta_objset;
833 	dmu_recv_cookie_t *drc = drba->drba_cookie;
834 	struct drr_begin *drrb = drc->drc_drrb;
835 	const char *tofs = drc->drc_tofs;
836 	uint64_t featureflags = drc->drc_featureflags;
837 	dsl_dataset_t *ds, *newds;
838 	objset_t *os;
839 	uint64_t dsobj;
840 	ds_hold_flags_t dsflags = DS_HOLD_FLAG_NONE;
841 	int error;
842 	uint64_t crflags = 0;
843 	dsl_crypto_params_t dummy_dcp = { 0 };
844 	dsl_crypto_params_t *dcp = drba->drba_dcp;
845 
846 	if (drrb->drr_flags & DRR_FLAG_CI_DATA)
847 		crflags |= DS_FLAG_CI_DATASET;
848 
849 	if ((featureflags & DMU_BACKUP_FEATURE_RAW) == 0)
850 		dsflags |= DS_HOLD_FLAG_DECRYPT;
851 
852 	/*
853 	 * Raw, non-incremental recvs always use a dummy dcp with
854 	 * the raw cmd set. Raw incremental recvs do not use a dcp
855 	 * since the encryption parameters are already set in stone.
856 	 */
857 	if (dcp == NULL && drrb->drr_fromguid == 0 &&
858 	    drba->drba_origin == NULL) {
859 		ASSERT3P(dcp, ==, NULL);
860 		dcp = &dummy_dcp;
861 
862 		if (featureflags & DMU_BACKUP_FEATURE_RAW)
863 			dcp->cp_cmd = DCP_CMD_RAW_RECV;
864 	}
865 
866 	error = dsl_dataset_hold_flags(dp, tofs, dsflags, FTAG, &ds);
867 	if (error == 0) {
868 		/* Create temporary clone unless we're doing corrective recv */
869 		dsl_dataset_t *snap = NULL;
870 
871 		if (drba->drba_cookie->drc_fromsnapobj != 0) {
872 			VERIFY0(dsl_dataset_hold_obj(dp,
873 			    drba->drba_cookie->drc_fromsnapobj, FTAG, &snap));
874 			ASSERT3P(dcp, ==, NULL);
875 		}
876 		if (drc->drc_heal) {
877 			/* When healing we want to use the provided snapshot */
878 			VERIFY0(dsl_dataset_snap_lookup(ds, drc->drc_tosnap,
879 			    &dsobj));
880 		} else {
881 			dsobj = dsl_dataset_create_sync(ds->ds_dir,
882 			    recv_clone_name, snap, crflags, drba->drba_cred,
883 			    dcp, tx);
884 		}
885 		if (drba->drba_cookie->drc_fromsnapobj != 0)
886 			dsl_dataset_rele(snap, FTAG);
887 		dsl_dataset_rele_flags(ds, dsflags, FTAG);
888 	} else {
889 		dsl_dir_t *dd;
890 		const char *tail;
891 		dsl_dataset_t *origin = NULL;
892 
893 		VERIFY0(dsl_dir_hold(dp, tofs, FTAG, &dd, &tail));
894 
895 		if (drba->drba_origin != NULL) {
896 			VERIFY0(dsl_dataset_hold(dp, drba->drba_origin,
897 			    FTAG, &origin));
898 			ASSERT3P(dcp, ==, NULL);
899 		}
900 
901 		/* Create new dataset. */
902 		dsobj = dsl_dataset_create_sync(dd, strrchr(tofs, '/') + 1,
903 		    origin, crflags, drba->drba_cred, dcp, tx);
904 		if (origin != NULL)
905 			dsl_dataset_rele(origin, FTAG);
906 		dsl_dir_rele(dd, FTAG);
907 		drc->drc_newfs = B_TRUE;
908 	}
909 	VERIFY0(dsl_dataset_own_obj_force(dp, dsobj, dsflags, dmu_recv_tag,
910 	    &newds));
911 	if (dsl_dataset_feature_is_active(newds,
912 	    SPA_FEATURE_REDACTED_DATASETS)) {
913 		/*
914 		 * If the origin dataset is redacted, the child will be redacted
915 		 * when we create it.  We clear the new dataset's
916 		 * redaction info; if it should be redacted, we'll fill
917 		 * in its information later.
918 		 */
919 		dsl_dataset_deactivate_feature(newds,
920 		    SPA_FEATURE_REDACTED_DATASETS, tx);
921 	}
922 	VERIFY0(dmu_objset_from_ds(newds, &os));
923 
924 	if (drc->drc_resumable) {
925 		dsl_dataset_zapify(newds, tx);
926 		if (drrb->drr_fromguid != 0) {
927 			VERIFY0(zap_add(mos, dsobj, DS_FIELD_RESUME_FROMGUID,
928 			    8, 1, &drrb->drr_fromguid, tx));
929 		}
930 		VERIFY0(zap_add(mos, dsobj, DS_FIELD_RESUME_TOGUID,
931 		    8, 1, &drrb->drr_toguid, tx));
932 		VERIFY0(zap_add(mos, dsobj, DS_FIELD_RESUME_TONAME,
933 		    1, strlen(drrb->drr_toname) + 1, drrb->drr_toname, tx));
934 		uint64_t one = 1;
935 		uint64_t zero = 0;
936 		VERIFY0(zap_add(mos, dsobj, DS_FIELD_RESUME_OBJECT,
937 		    8, 1, &one, tx));
938 		VERIFY0(zap_add(mos, dsobj, DS_FIELD_RESUME_OFFSET,
939 		    8, 1, &zero, tx));
940 		VERIFY0(zap_add(mos, dsobj, DS_FIELD_RESUME_BYTES,
941 		    8, 1, &zero, tx));
942 		if (featureflags & DMU_BACKUP_FEATURE_LARGE_BLOCKS) {
943 			VERIFY0(zap_add(mos, dsobj, DS_FIELD_RESUME_LARGEBLOCK,
944 			    8, 1, &one, tx));
945 		}
946 		if (featureflags & DMU_BACKUP_FEATURE_EMBED_DATA) {
947 			VERIFY0(zap_add(mos, dsobj, DS_FIELD_RESUME_EMBEDOK,
948 			    8, 1, &one, tx));
949 		}
950 		if (featureflags & DMU_BACKUP_FEATURE_COMPRESSED) {
951 			VERIFY0(zap_add(mos, dsobj, DS_FIELD_RESUME_COMPRESSOK,
952 			    8, 1, &one, tx));
953 		}
954 		if (featureflags & DMU_BACKUP_FEATURE_RAW) {
955 			VERIFY0(zap_add(mos, dsobj, DS_FIELD_RESUME_RAWOK,
956 			    8, 1, &one, tx));
957 		}
958 
959 		uint64_t *redact_snaps;
960 		uint_t numredactsnaps;
961 		if (nvlist_lookup_uint64_array(drc->drc_begin_nvl,
962 		    BEGINNV_REDACT_FROM_SNAPS, &redact_snaps,
963 		    &numredactsnaps) == 0) {
964 			VERIFY0(zap_add(mos, dsobj,
965 			    DS_FIELD_RESUME_REDACT_BOOKMARK_SNAPS,
966 			    sizeof (*redact_snaps), numredactsnaps,
967 			    redact_snaps, tx));
968 		}
969 	}
970 
971 	/*
972 	 * Usually the os->os_encrypted value is tied to the presence of a
973 	 * DSL Crypto Key object in the dd. However, that will not be received
974 	 * until dmu_recv_stream(), so we set the value manually for now.
975 	 */
976 	if (featureflags & DMU_BACKUP_FEATURE_RAW) {
977 		os->os_encrypted = B_TRUE;
978 		drba->drba_cookie->drc_raw = B_TRUE;
979 	}
980 
981 	if (featureflags & DMU_BACKUP_FEATURE_REDACTED) {
982 		uint64_t *redact_snaps;
983 		uint_t numredactsnaps;
984 		VERIFY0(nvlist_lookup_uint64_array(drc->drc_begin_nvl,
985 		    BEGINNV_REDACT_SNAPS, &redact_snaps, &numredactsnaps));
986 		dsl_dataset_activate_redaction(newds, redact_snaps,
987 		    numredactsnaps, tx);
988 	}
989 
990 	dmu_buf_will_dirty(newds->ds_dbuf, tx);
991 	dsl_dataset_phys(newds)->ds_flags |= DS_FLAG_INCONSISTENT;
992 
993 	/*
994 	 * If we actually created a non-clone, we need to create the objset
995 	 * in our new dataset. If this is a raw send we postpone this until
996 	 * dmu_recv_stream() so that we can allocate the metadnode with the
997 	 * properties from the DRR_BEGIN payload.
998 	 */
999 	rrw_enter(&newds->ds_bp_rwlock, RW_READER, FTAG);
1000 	if (BP_IS_HOLE(dsl_dataset_get_blkptr(newds)) &&
1001 	    (featureflags & DMU_BACKUP_FEATURE_RAW) == 0 &&
1002 	    !drc->drc_heal) {
1003 		(void) dmu_objset_create_impl(dp->dp_spa,
1004 		    newds, dsl_dataset_get_blkptr(newds), drrb->drr_type, tx);
1005 	}
1006 	rrw_exit(&newds->ds_bp_rwlock, FTAG);
1007 
1008 	drba->drba_cookie->drc_ds = newds;
1009 	drba->drba_cookie->drc_os = os;
1010 
1011 	spa_history_log_internal_ds(newds, "receive", tx, " ");
1012 }
1013 
1014 static int
dmu_recv_resume_begin_check(void * arg,dmu_tx_t * tx)1015 dmu_recv_resume_begin_check(void *arg, dmu_tx_t *tx)
1016 {
1017 	dmu_recv_begin_arg_t *drba = arg;
1018 	dmu_recv_cookie_t *drc = drba->drba_cookie;
1019 	dsl_pool_t *dp = dmu_tx_pool(tx);
1020 	struct drr_begin *drrb = drc->drc_drrb;
1021 	int error;
1022 	ds_hold_flags_t dsflags = DS_HOLD_FLAG_NONE;
1023 	dsl_dataset_t *ds;
1024 	const char *tofs = drc->drc_tofs;
1025 
1026 	/* already checked */
1027 	ASSERT3U(drrb->drr_magic, ==, DMU_BACKUP_MAGIC);
1028 	ASSERT(drc->drc_featureflags & DMU_BACKUP_FEATURE_RESUMING);
1029 
1030 	if (DMU_GET_STREAM_HDRTYPE(drrb->drr_versioninfo) ==
1031 	    DMU_COMPOUNDSTREAM ||
1032 	    drrb->drr_type >= DMU_OST_NUMTYPES)
1033 		return (SET_ERROR(EINVAL));
1034 
1035 	/*
1036 	 * This is mostly a sanity check since we should have already done these
1037 	 * checks during a previous attempt to receive the data.
1038 	 */
1039 	error = recv_begin_check_feature_flags_impl(drc->drc_featureflags,
1040 	    dp->dp_spa);
1041 	if (error != 0)
1042 		return (error);
1043 
1044 	/* 6 extra bytes for /%recv */
1045 	char recvname[ZFS_MAX_DATASET_NAME_LEN + 6];
1046 
1047 	(void) snprintf(recvname, sizeof (recvname), "%s/%s",
1048 	    tofs, recv_clone_name);
1049 
1050 	if (drc->drc_featureflags & DMU_BACKUP_FEATURE_RAW) {
1051 		/* raw receives require spill block allocation flag */
1052 		if (!(drrb->drr_flags & DRR_FLAG_SPILL_BLOCK))
1053 			return (SET_ERROR(ZFS_ERR_SPILL_BLOCK_FLAG_MISSING));
1054 	} else {
1055 		dsflags |= DS_HOLD_FLAG_DECRYPT;
1056 	}
1057 
1058 	boolean_t recvexist = B_TRUE;
1059 	if (dsl_dataset_hold_flags(dp, recvname, dsflags, FTAG, &ds) != 0) {
1060 		/* %recv does not exist; continue in tofs */
1061 		recvexist = B_FALSE;
1062 		error = dsl_dataset_hold_flags(dp, tofs, dsflags, FTAG, &ds);
1063 		if (error != 0)
1064 			return (error);
1065 	}
1066 
1067 	/*
1068 	 * Resume of full/newfs recv on existing dataset should be done with
1069 	 * force flag
1070 	 */
1071 	if (recvexist && drrb->drr_fromguid == 0 && !drc->drc_force) {
1072 		dsl_dataset_rele_flags(ds, dsflags, FTAG);
1073 		return (SET_ERROR(ZFS_ERR_RESUME_EXISTS));
1074 	}
1075 
1076 	/* check that ds is marked inconsistent */
1077 	if (!DS_IS_INCONSISTENT(ds)) {
1078 		dsl_dataset_rele_flags(ds, dsflags, FTAG);
1079 		return (SET_ERROR(EINVAL));
1080 	}
1081 
1082 	/* check that there is resuming data, and that the toguid matches */
1083 	if (!dsl_dataset_is_zapified(ds)) {
1084 		dsl_dataset_rele_flags(ds, dsflags, FTAG);
1085 		return (SET_ERROR(EINVAL));
1086 	}
1087 	uint64_t val;
1088 	error = zap_lookup(dp->dp_meta_objset, ds->ds_object,
1089 	    DS_FIELD_RESUME_TOGUID, sizeof (val), 1, &val);
1090 	if (error != 0 || drrb->drr_toguid != val) {
1091 		dsl_dataset_rele_flags(ds, dsflags, FTAG);
1092 		return (SET_ERROR(EINVAL));
1093 	}
1094 
1095 	/*
1096 	 * Check if the receive is still running.  If so, it will be owned.
1097 	 * Note that nothing else can own the dataset (e.g. after the receive
1098 	 * fails) because it will be marked inconsistent.
1099 	 */
1100 	if (dsl_dataset_has_owner(ds)) {
1101 		dsl_dataset_rele_flags(ds, dsflags, FTAG);
1102 		return (SET_ERROR(EBUSY));
1103 	}
1104 
1105 	/* There should not be any snapshots of this fs yet. */
1106 	if (ds->ds_prev != NULL && ds->ds_prev->ds_dir == ds->ds_dir) {
1107 		dsl_dataset_rele_flags(ds, dsflags, FTAG);
1108 		return (SET_ERROR(EINVAL));
1109 	}
1110 
1111 	/*
1112 	 * Note: resume point will be checked when we process the first WRITE
1113 	 * record.
1114 	 */
1115 
1116 	/* check that the origin matches */
1117 	val = 0;
1118 	(void) zap_lookup(dp->dp_meta_objset, ds->ds_object,
1119 	    DS_FIELD_RESUME_FROMGUID, sizeof (val), 1, &val);
1120 	if (drrb->drr_fromguid != val) {
1121 		dsl_dataset_rele_flags(ds, dsflags, FTAG);
1122 		return (SET_ERROR(EINVAL));
1123 	}
1124 
1125 	if (ds->ds_prev != NULL && drrb->drr_fromguid != 0)
1126 		drc->drc_fromsnapobj = ds->ds_prev->ds_object;
1127 
1128 	/*
1129 	 * If we're resuming, and the send is redacted, then the original send
1130 	 * must have been redacted, and must have been redacted with respect to
1131 	 * the same snapshots.
1132 	 */
1133 	if (drc->drc_featureflags & DMU_BACKUP_FEATURE_REDACTED) {
1134 		uint64_t num_ds_redact_snaps;
1135 		uint64_t *ds_redact_snaps;
1136 
1137 		uint_t num_stream_redact_snaps;
1138 		uint64_t *stream_redact_snaps;
1139 
1140 		if (nvlist_lookup_uint64_array(drc->drc_begin_nvl,
1141 		    BEGINNV_REDACT_SNAPS, &stream_redact_snaps,
1142 		    &num_stream_redact_snaps) != 0) {
1143 			dsl_dataset_rele_flags(ds, dsflags, FTAG);
1144 			return (SET_ERROR(EINVAL));
1145 		}
1146 
1147 		if (!dsl_dataset_get_uint64_array_feature(ds,
1148 		    SPA_FEATURE_REDACTED_DATASETS, &num_ds_redact_snaps,
1149 		    &ds_redact_snaps)) {
1150 			dsl_dataset_rele_flags(ds, dsflags, FTAG);
1151 			return (SET_ERROR(EINVAL));
1152 		}
1153 
1154 		for (int i = 0; i < num_ds_redact_snaps; i++) {
1155 			if (!redact_snaps_contains(ds_redact_snaps,
1156 			    num_ds_redact_snaps, stream_redact_snaps[i])) {
1157 				dsl_dataset_rele_flags(ds, dsflags, FTAG);
1158 				return (SET_ERROR(EINVAL));
1159 			}
1160 		}
1161 	}
1162 
1163 	error = recv_check_large_blocks(ds, drc->drc_featureflags);
1164 	if (error != 0) {
1165 		dsl_dataset_rele_flags(ds, dsflags, FTAG);
1166 		return (error);
1167 	}
1168 
1169 	dsl_dataset_rele_flags(ds, dsflags, FTAG);
1170 	return (0);
1171 }
1172 
1173 static void
dmu_recv_resume_begin_sync(void * arg,dmu_tx_t * tx)1174 dmu_recv_resume_begin_sync(void *arg, dmu_tx_t *tx)
1175 {
1176 	dmu_recv_begin_arg_t *drba = arg;
1177 	dsl_pool_t *dp = dmu_tx_pool(tx);
1178 	const char *tofs = drba->drba_cookie->drc_tofs;
1179 	uint64_t featureflags = drba->drba_cookie->drc_featureflags;
1180 	dsl_dataset_t *ds;
1181 	ds_hold_flags_t dsflags = DS_HOLD_FLAG_NONE;
1182 	/* 6 extra bytes for /%recv */
1183 	char recvname[ZFS_MAX_DATASET_NAME_LEN + 6];
1184 
1185 	(void) snprintf(recvname, sizeof (recvname), "%s/%s", tofs,
1186 	    recv_clone_name);
1187 
1188 	if (featureflags & DMU_BACKUP_FEATURE_RAW) {
1189 		drba->drba_cookie->drc_raw = B_TRUE;
1190 	} else {
1191 		dsflags |= DS_HOLD_FLAG_DECRYPT;
1192 	}
1193 
1194 	if (dsl_dataset_own_force(dp, recvname, dsflags, dmu_recv_tag, &ds)
1195 	    != 0) {
1196 		/* %recv does not exist; continue in tofs */
1197 		VERIFY0(dsl_dataset_own_force(dp, tofs, dsflags, dmu_recv_tag,
1198 		    &ds));
1199 		drba->drba_cookie->drc_newfs = B_TRUE;
1200 	}
1201 
1202 	ASSERT(DS_IS_INCONSISTENT(ds));
1203 	rrw_enter(&ds->ds_bp_rwlock, RW_READER, FTAG);
1204 	ASSERT(!BP_IS_HOLE(dsl_dataset_get_blkptr(ds)) ||
1205 	    drba->drba_cookie->drc_raw);
1206 	rrw_exit(&ds->ds_bp_rwlock, FTAG);
1207 
1208 	drba->drba_cookie->drc_ds = ds;
1209 	VERIFY0(dmu_objset_from_ds(ds, &drba->drba_cookie->drc_os));
1210 	drba->drba_cookie->drc_should_save = B_TRUE;
1211 
1212 	spa_history_log_internal_ds(ds, "resume receive", tx, " ");
1213 }
1214 
1215 /*
1216  * NB: callers *MUST* call dmu_recv_stream() if dmu_recv_begin()
1217  * succeeds; otherwise we will leak the holds on the datasets.
1218  */
1219 int
dmu_recv_begin(const char * tofs,const char * tosnap,dmu_replay_record_t * drr_begin,boolean_t force,boolean_t heal,boolean_t resumable,nvlist_t * localprops,nvlist_t * hidden_args,const char * origin,dmu_recv_cookie_t * drc,zfs_file_t * fp,offset_t * voffp)1220 dmu_recv_begin(const char *tofs, const char *tosnap,
1221     dmu_replay_record_t *drr_begin, boolean_t force, boolean_t heal,
1222     boolean_t resumable, nvlist_t *localprops, nvlist_t *hidden_args,
1223     const char *origin, dmu_recv_cookie_t *drc, zfs_file_t *fp,
1224     offset_t *voffp)
1225 {
1226 	dmu_recv_begin_arg_t drba = { 0 };
1227 	int err = 0;
1228 
1229 	memset(drc, 0, sizeof (dmu_recv_cookie_t));
1230 	drc->drc_drr_begin = drr_begin;
1231 	drc->drc_drrb = &drr_begin->drr_u.drr_begin;
1232 	drc->drc_tosnap = tosnap;
1233 	drc->drc_tofs = tofs;
1234 	drc->drc_force = force;
1235 	drc->drc_heal = heal;
1236 	drc->drc_resumable = resumable;
1237 	drc->drc_cred = CRED();
1238 	drc->drc_proc = curproc;
1239 	drc->drc_clone = (origin != NULL);
1240 
1241 	if (drc->drc_drrb->drr_magic == BSWAP_64(DMU_BACKUP_MAGIC)) {
1242 		drc->drc_byteswap = B_TRUE;
1243 		(void) fletcher_4_incremental_byteswap(drr_begin,
1244 		    sizeof (dmu_replay_record_t), &drc->drc_cksum);
1245 		byteswap_record(drr_begin);
1246 	} else if (drc->drc_drrb->drr_magic == DMU_BACKUP_MAGIC) {
1247 		(void) fletcher_4_incremental_native(drr_begin,
1248 		    sizeof (dmu_replay_record_t), &drc->drc_cksum);
1249 	} else {
1250 		return (SET_ERROR(EINVAL));
1251 	}
1252 
1253 	drc->drc_fp = fp;
1254 	drc->drc_voff = *voffp;
1255 	drc->drc_featureflags =
1256 	    DMU_GET_FEATUREFLAGS(drc->drc_drrb->drr_versioninfo);
1257 
1258 	uint32_t payloadlen = drc->drc_drr_begin->drr_payloadlen;
1259 
1260 	/*
1261 	 * Since OpenZFS 2.0.0, we have enforced a 64MB limit in userspace
1262 	 * configurable via ZFS_SENDRECV_MAX_NVLIST. We enforce 256MB as a hard
1263 	 * upper limit. Systems with less than 1GB of RAM will see a lower
1264 	 * limit from `arc_all_memory() / 4`.
1265 	 */
1266 	if (payloadlen > (MIN((1U << 28), arc_all_memory() / 4)))
1267 		return (E2BIG);
1268 
1269 
1270 	if (payloadlen != 0) {
1271 		void *payload = vmem_alloc(payloadlen, KM_SLEEP);
1272 		/*
1273 		 * For compatibility with recursive send streams, we don't do
1274 		 * this here if the stream could be part of a package. Instead,
1275 		 * we'll do it in dmu_recv_stream. If we pull the next header
1276 		 * too early, and it's the END record, we break the `recv_skip`
1277 		 * logic.
1278 		 */
1279 
1280 		err = receive_read_payload_and_next_header(drc, payloadlen,
1281 		    payload);
1282 		if (err != 0) {
1283 			vmem_free(payload, payloadlen);
1284 			return (err);
1285 		}
1286 		err = nvlist_unpack(payload, payloadlen, &drc->drc_begin_nvl,
1287 		    KM_SLEEP);
1288 		vmem_free(payload, payloadlen);
1289 		if (err != 0) {
1290 			kmem_free(drc->drc_next_rrd,
1291 			    sizeof (*drc->drc_next_rrd));
1292 			return (err);
1293 		}
1294 	}
1295 
1296 	if (drc->drc_drrb->drr_flags & DRR_FLAG_SPILL_BLOCK)
1297 		drc->drc_spill = B_TRUE;
1298 
1299 	drba.drba_origin = origin;
1300 	drba.drba_cookie = drc;
1301 	drba.drba_cred = CRED();
1302 	drba.drba_proc = curproc;
1303 
1304 	if (drc->drc_featureflags & DMU_BACKUP_FEATURE_RESUMING) {
1305 		err = dsl_sync_task(tofs,
1306 		    dmu_recv_resume_begin_check, dmu_recv_resume_begin_sync,
1307 		    &drba, 5, ZFS_SPACE_CHECK_NORMAL);
1308 	} else {
1309 		/*
1310 		 * For non-raw, non-incremental, non-resuming receives the
1311 		 * user can specify encryption parameters on the command line
1312 		 * with "zfs recv -o". For these receives we create a dcp and
1313 		 * pass it to the sync task. Creating the dcp will implicitly
1314 		 * remove the encryption params from the localprops nvlist,
1315 		 * which avoids errors when trying to set these normally
1316 		 * read-only properties. Any other kind of receive that
1317 		 * attempts to set these properties will fail as a result.
1318 		 */
1319 		if ((DMU_GET_FEATUREFLAGS(drc->drc_drrb->drr_versioninfo) &
1320 		    DMU_BACKUP_FEATURE_RAW) == 0 &&
1321 		    origin == NULL && drc->drc_drrb->drr_fromguid == 0) {
1322 			err = dsl_crypto_params_create_nvlist(DCP_CMD_NONE,
1323 			    localprops, hidden_args, &drba.drba_dcp);
1324 		}
1325 
1326 		if (err == 0) {
1327 			err = dsl_sync_task(tofs,
1328 			    dmu_recv_begin_check, dmu_recv_begin_sync,
1329 			    &drba, 5, ZFS_SPACE_CHECK_NORMAL);
1330 			dsl_crypto_params_free(drba.drba_dcp, !!err);
1331 		}
1332 	}
1333 
1334 	if (err != 0) {
1335 		kmem_free(drc->drc_next_rrd, sizeof (*drc->drc_next_rrd));
1336 		nvlist_free(drc->drc_begin_nvl);
1337 	}
1338 	return (err);
1339 }
1340 
1341 /*
1342  * Holds data need for corrective recv callback
1343  */
1344 typedef struct cr_cb_data {
1345 	uint64_t size;
1346 	zbookmark_phys_t zb;
1347 	spa_t *spa;
1348 } cr_cb_data_t;
1349 
1350 static void
corrective_read_done(zio_t * zio)1351 corrective_read_done(zio_t *zio)
1352 {
1353 	cr_cb_data_t *data = zio->io_private;
1354 	/* Corruption corrected; update error log if needed */
1355 	if (zio->io_error == 0)
1356 		spa_remove_error(data->spa, &data->zb, &zio->io_bp->blk_birth);
1357 	kmem_free(data, sizeof (cr_cb_data_t));
1358 	abd_free(zio->io_abd);
1359 }
1360 
1361 /*
1362  * zio_rewrite the data pointed to by bp with the data from the rrd's abd.
1363  */
1364 static int
do_corrective_recv(struct receive_writer_arg * rwa,struct drr_write * drrw,struct receive_record_arg * rrd,blkptr_t * bp)1365 do_corrective_recv(struct receive_writer_arg *rwa, struct drr_write *drrw,
1366     struct receive_record_arg *rrd, blkptr_t *bp)
1367 {
1368 	int err;
1369 	zio_t *io;
1370 	zbookmark_phys_t zb;
1371 	dnode_t *dn;
1372 	abd_t *abd = rrd->abd;
1373 	zio_cksum_t bp_cksum = bp->blk_cksum;
1374 	zio_flag_t flags = ZIO_FLAG_SPECULATIVE | ZIO_FLAG_DONT_RETRY |
1375 	    ZIO_FLAG_CANFAIL;
1376 
1377 	if (rwa->raw)
1378 		flags |= ZIO_FLAG_RAW;
1379 
1380 	err = dnode_hold(rwa->os, drrw->drr_object, FTAG, &dn);
1381 	if (err != 0)
1382 		return (err);
1383 	SET_BOOKMARK(&zb, dmu_objset_id(rwa->os), drrw->drr_object, 0,
1384 	    dbuf_whichblock(dn, 0, drrw->drr_offset));
1385 	dnode_rele(dn, FTAG);
1386 
1387 	if (!rwa->raw && DRR_WRITE_COMPRESSED(drrw)) {
1388 		/* Decompress the stream data */
1389 		abd_t *dabd = abd_alloc_linear(
1390 		    drrw->drr_logical_size, B_FALSE);
1391 		err = zio_decompress_data(drrw->drr_compressiontype,
1392 		    abd, abd_to_buf(dabd), abd_get_size(abd),
1393 		    abd_get_size(dabd), NULL);
1394 
1395 		if (err != 0) {
1396 			abd_free(dabd);
1397 			return (err);
1398 		}
1399 		/* Swap in the newly decompressed data into the abd */
1400 		abd_free(abd);
1401 		abd = dabd;
1402 	}
1403 
1404 	if (!rwa->raw && BP_GET_COMPRESS(bp) != ZIO_COMPRESS_OFF) {
1405 		/* Recompress the data */
1406 		abd_t *cabd = abd_alloc_linear(BP_GET_PSIZE(bp),
1407 		    B_FALSE);
1408 		void *buf = abd_to_buf(cabd);
1409 		uint64_t csize = zio_compress_data(BP_GET_COMPRESS(bp),
1410 		    abd, &buf, abd_get_size(abd),
1411 		    rwa->os->os_complevel);
1412 		abd_zero_off(cabd, csize, BP_GET_PSIZE(bp) - csize);
1413 		/* Swap in newly compressed data into the abd */
1414 		abd_free(abd);
1415 		abd = cabd;
1416 		flags |= ZIO_FLAG_RAW_COMPRESS;
1417 	}
1418 
1419 	/*
1420 	 * The stream is not encrypted but the data on-disk is.
1421 	 * We need to re-encrypt the buf using the same
1422 	 * encryption type, salt, iv, and mac that was used to encrypt
1423 	 * the block previosly.
1424 	 */
1425 	if (!rwa->raw && BP_USES_CRYPT(bp)) {
1426 		dsl_dataset_t *ds;
1427 		dsl_crypto_key_t *dck = NULL;
1428 		uint8_t salt[ZIO_DATA_SALT_LEN];
1429 		uint8_t iv[ZIO_DATA_IV_LEN];
1430 		uint8_t mac[ZIO_DATA_MAC_LEN];
1431 		boolean_t no_crypt = B_FALSE;
1432 		dsl_pool_t *dp = dmu_objset_pool(rwa->os);
1433 		abd_t *eabd = abd_alloc_linear(BP_GET_PSIZE(bp), B_FALSE);
1434 
1435 		zio_crypt_decode_params_bp(bp, salt, iv);
1436 		zio_crypt_decode_mac_bp(bp, mac);
1437 
1438 		dsl_pool_config_enter(dp, FTAG);
1439 		err = dsl_dataset_hold_flags(dp, rwa->tofs,
1440 		    DS_HOLD_FLAG_DECRYPT, FTAG, &ds);
1441 		if (err != 0) {
1442 			dsl_pool_config_exit(dp, FTAG);
1443 			abd_free(eabd);
1444 			return (SET_ERROR(EACCES));
1445 		}
1446 
1447 		/* Look up the key from the spa's keystore */
1448 		err = spa_keystore_lookup_key(rwa->os->os_spa,
1449 		    zb.zb_objset, FTAG, &dck);
1450 		if (err != 0) {
1451 			dsl_dataset_rele_flags(ds, DS_HOLD_FLAG_DECRYPT,
1452 			    FTAG);
1453 			dsl_pool_config_exit(dp, FTAG);
1454 			abd_free(eabd);
1455 			return (SET_ERROR(EACCES));
1456 		}
1457 
1458 		err = zio_do_crypt_abd(B_TRUE, &dck->dck_key,
1459 		    BP_GET_TYPE(bp), BP_SHOULD_BYTESWAP(bp), salt, iv,
1460 		    mac, abd_get_size(abd), abd, eabd, &no_crypt);
1461 
1462 		spa_keystore_dsl_key_rele(rwa->os->os_spa, dck, FTAG);
1463 		dsl_dataset_rele_flags(ds, DS_HOLD_FLAG_DECRYPT, FTAG);
1464 		dsl_pool_config_exit(dp, FTAG);
1465 
1466 		ASSERT0(no_crypt);
1467 		if (err != 0) {
1468 			abd_free(eabd);
1469 			return (err);
1470 		}
1471 		/* Swap in the newly encrypted data into the abd */
1472 		abd_free(abd);
1473 		abd = eabd;
1474 
1475 		/*
1476 		 * We want to prevent zio_rewrite() from trying to
1477 		 * encrypt the data again
1478 		 */
1479 		flags |= ZIO_FLAG_RAW_ENCRYPT;
1480 	}
1481 	rrd->abd = abd;
1482 
1483 	io = zio_rewrite(NULL, rwa->os->os_spa, bp->blk_birth, bp, abd,
1484 	    BP_GET_PSIZE(bp), NULL, NULL, ZIO_PRIORITY_SYNC_WRITE, flags, &zb);
1485 
1486 	ASSERT(abd_get_size(abd) == BP_GET_LSIZE(bp) ||
1487 	    abd_get_size(abd) == BP_GET_PSIZE(bp));
1488 
1489 	/* compute new bp checksum value and make sure it matches the old one */
1490 	zio_checksum_compute(io, BP_GET_CHECKSUM(bp), abd, abd_get_size(abd));
1491 	if (!ZIO_CHECKSUM_EQUAL(bp_cksum, io->io_bp->blk_cksum)) {
1492 		zio_destroy(io);
1493 		if (zfs_recv_best_effort_corrective != 0)
1494 			return (0);
1495 		return (SET_ERROR(ECKSUM));
1496 	}
1497 
1498 	/* Correct the corruption in place */
1499 	err = zio_wait(io);
1500 	if (err == 0) {
1501 		cr_cb_data_t *cb_data =
1502 		    kmem_alloc(sizeof (cr_cb_data_t), KM_SLEEP);
1503 		cb_data->spa = rwa->os->os_spa;
1504 		cb_data->size = drrw->drr_logical_size;
1505 		cb_data->zb = zb;
1506 		/* Test if healing worked by re-reading the bp */
1507 		err = zio_wait(zio_read(rwa->heal_pio, rwa->os->os_spa, bp,
1508 		    abd_alloc_for_io(drrw->drr_logical_size, B_FALSE),
1509 		    drrw->drr_logical_size, corrective_read_done,
1510 		    cb_data, ZIO_PRIORITY_ASYNC_READ, flags, NULL));
1511 	}
1512 	if (err != 0 && zfs_recv_best_effort_corrective != 0)
1513 		err = 0;
1514 
1515 	return (err);
1516 }
1517 
1518 static int
receive_read(dmu_recv_cookie_t * drc,int len,void * buf)1519 receive_read(dmu_recv_cookie_t *drc, int len, void *buf)
1520 {
1521 	int done = 0;
1522 
1523 	/*
1524 	 * The code doesn't rely on this (lengths being multiples of 8).  See
1525 	 * comment in dump_bytes.
1526 	 */
1527 	ASSERT(len % 8 == 0 ||
1528 	    (drc->drc_featureflags & DMU_BACKUP_FEATURE_RAW) != 0);
1529 
1530 	while (done < len) {
1531 		ssize_t resid = len - done;
1532 		zfs_file_t *fp = drc->drc_fp;
1533 		int err = zfs_file_read(fp, (char *)buf + done,
1534 		    len - done, &resid);
1535 		if (err == 0 && resid == len - done) {
1536 			/*
1537 			 * Note: ECKSUM or ZFS_ERR_STREAM_TRUNCATED indicates
1538 			 * that the receive was interrupted and can
1539 			 * potentially be resumed.
1540 			 */
1541 			err = SET_ERROR(ZFS_ERR_STREAM_TRUNCATED);
1542 		}
1543 		drc->drc_voff += len - done - resid;
1544 		done = len - resid;
1545 		if (err != 0)
1546 			return (err);
1547 	}
1548 
1549 	drc->drc_bytes_read += len;
1550 
1551 	ASSERT3U(done, ==, len);
1552 	return (0);
1553 }
1554 
1555 static inline uint8_t
deduce_nblkptr(dmu_object_type_t bonus_type,uint64_t bonus_size)1556 deduce_nblkptr(dmu_object_type_t bonus_type, uint64_t bonus_size)
1557 {
1558 	if (bonus_type == DMU_OT_SA) {
1559 		return (1);
1560 	} else {
1561 		return (1 +
1562 		    ((DN_OLD_MAX_BONUSLEN -
1563 		    MIN(DN_OLD_MAX_BONUSLEN, bonus_size)) >> SPA_BLKPTRSHIFT));
1564 	}
1565 }
1566 
1567 static void
save_resume_state(struct receive_writer_arg * rwa,uint64_t object,uint64_t offset,dmu_tx_t * tx)1568 save_resume_state(struct receive_writer_arg *rwa,
1569     uint64_t object, uint64_t offset, dmu_tx_t *tx)
1570 {
1571 	int txgoff = dmu_tx_get_txg(tx) & TXG_MASK;
1572 
1573 	if (!rwa->resumable)
1574 		return;
1575 
1576 	/*
1577 	 * We use ds_resume_bytes[] != 0 to indicate that we need to
1578 	 * update this on disk, so it must not be 0.
1579 	 */
1580 	ASSERT(rwa->bytes_read != 0);
1581 
1582 	/*
1583 	 * We only resume from write records, which have a valid
1584 	 * (non-meta-dnode) object number.
1585 	 */
1586 	ASSERT(object != 0);
1587 
1588 	/*
1589 	 * For resuming to work correctly, we must receive records in order,
1590 	 * sorted by object,offset.  This is checked by the callers, but
1591 	 * assert it here for good measure.
1592 	 */
1593 	ASSERT3U(object, >=, rwa->os->os_dsl_dataset->ds_resume_object[txgoff]);
1594 	ASSERT(object != rwa->os->os_dsl_dataset->ds_resume_object[txgoff] ||
1595 	    offset >= rwa->os->os_dsl_dataset->ds_resume_offset[txgoff]);
1596 	ASSERT3U(rwa->bytes_read, >=,
1597 	    rwa->os->os_dsl_dataset->ds_resume_bytes[txgoff]);
1598 
1599 	rwa->os->os_dsl_dataset->ds_resume_object[txgoff] = object;
1600 	rwa->os->os_dsl_dataset->ds_resume_offset[txgoff] = offset;
1601 	rwa->os->os_dsl_dataset->ds_resume_bytes[txgoff] = rwa->bytes_read;
1602 }
1603 
1604 static int
receive_object_is_same_generation(objset_t * os,uint64_t object,dmu_object_type_t old_bonus_type,dmu_object_type_t new_bonus_type,const void * new_bonus,boolean_t * samegenp)1605 receive_object_is_same_generation(objset_t *os, uint64_t object,
1606     dmu_object_type_t old_bonus_type, dmu_object_type_t new_bonus_type,
1607     const void *new_bonus, boolean_t *samegenp)
1608 {
1609 	zfs_file_info_t zoi;
1610 	int err;
1611 
1612 	dmu_buf_t *old_bonus_dbuf;
1613 	err = dmu_bonus_hold(os, object, FTAG, &old_bonus_dbuf);
1614 	if (err != 0)
1615 		return (err);
1616 	err = dmu_get_file_info(os, old_bonus_type, old_bonus_dbuf->db_data,
1617 	    &zoi);
1618 	dmu_buf_rele(old_bonus_dbuf, FTAG);
1619 	if (err != 0)
1620 		return (err);
1621 	uint64_t old_gen = zoi.zfi_generation;
1622 
1623 	err = dmu_get_file_info(os, new_bonus_type, new_bonus, &zoi);
1624 	if (err != 0)
1625 		return (err);
1626 	uint64_t new_gen = zoi.zfi_generation;
1627 
1628 	*samegenp = (old_gen == new_gen);
1629 	return (0);
1630 }
1631 
1632 static int
receive_handle_existing_object(const struct receive_writer_arg * rwa,const struct drr_object * drro,const dmu_object_info_t * doi,const void * bonus_data,uint64_t * object_to_hold,uint32_t * new_blksz)1633 receive_handle_existing_object(const struct receive_writer_arg *rwa,
1634     const struct drr_object *drro, const dmu_object_info_t *doi,
1635     const void *bonus_data,
1636     uint64_t *object_to_hold, uint32_t *new_blksz)
1637 {
1638 	uint32_t indblksz = drro->drr_indblkshift ?
1639 	    1ULL << drro->drr_indblkshift : 0;
1640 	int nblkptr = deduce_nblkptr(drro->drr_bonustype,
1641 	    drro->drr_bonuslen);
1642 	uint8_t dn_slots = drro->drr_dn_slots != 0 ?
1643 	    drro->drr_dn_slots : DNODE_MIN_SLOTS;
1644 	boolean_t do_free_range = B_FALSE;
1645 	int err;
1646 
1647 	*object_to_hold = drro->drr_object;
1648 
1649 	/* nblkptr should be bounded by the bonus size and type */
1650 	if (rwa->raw && nblkptr != drro->drr_nblkptr)
1651 		return (SET_ERROR(EINVAL));
1652 
1653 	/*
1654 	 * After the previous send stream, the sending system may
1655 	 * have freed this object, and then happened to re-allocate
1656 	 * this object number in a later txg. In this case, we are
1657 	 * receiving a different logical file, and the block size may
1658 	 * appear to be different.  i.e. we may have a different
1659 	 * block size for this object than what the send stream says.
1660 	 * In this case we need to remove the object's contents,
1661 	 * so that its structure can be changed and then its contents
1662 	 * entirely replaced by subsequent WRITE records.
1663 	 *
1664 	 * If this is a -L (--large-block) incremental stream, and
1665 	 * the previous stream was not -L, the block size may appear
1666 	 * to increase.  i.e. we may have a smaller block size for
1667 	 * this object than what the send stream says.  In this case
1668 	 * we need to keep the object's contents and block size
1669 	 * intact, so that we don't lose parts of the object's
1670 	 * contents that are not changed by this incremental send
1671 	 * stream.
1672 	 *
1673 	 * We can distinguish between the two above cases by using
1674 	 * the ZPL's generation number (see
1675 	 * receive_object_is_same_generation()).  However, we only
1676 	 * want to rely on the generation number when absolutely
1677 	 * necessary, because with raw receives, the generation is
1678 	 * encrypted.  We also want to minimize dependence on the
1679 	 * ZPL, so that other types of datasets can also be received
1680 	 * (e.g. ZVOLs, although note that ZVOLS currently do not
1681 	 * reallocate their objects or change their structure).
1682 	 * Therefore, we check a number of different cases where we
1683 	 * know it is safe to discard the object's contents, before
1684 	 * using the ZPL's generation number to make the above
1685 	 * distinction.
1686 	 */
1687 	if (drro->drr_blksz != doi->doi_data_block_size) {
1688 		if (rwa->raw) {
1689 			/*
1690 			 * RAW streams always have large blocks, so
1691 			 * we are sure that the data is not needed
1692 			 * due to changing --large-block to be on.
1693 			 * Which is fortunate since the bonus buffer
1694 			 * (which contains the ZPL generation) is
1695 			 * encrypted, and the key might not be
1696 			 * loaded.
1697 			 */
1698 			do_free_range = B_TRUE;
1699 		} else if (rwa->full) {
1700 			/*
1701 			 * This is a full send stream, so it always
1702 			 * replaces what we have.  Even if the
1703 			 * generation numbers happen to match, this
1704 			 * can not actually be the same logical file.
1705 			 * This is relevant when receiving a full
1706 			 * send as a clone.
1707 			 */
1708 			do_free_range = B_TRUE;
1709 		} else if (drro->drr_type !=
1710 		    DMU_OT_PLAIN_FILE_CONTENTS ||
1711 		    doi->doi_type != DMU_OT_PLAIN_FILE_CONTENTS) {
1712 			/*
1713 			 * PLAIN_FILE_CONTENTS are the only type of
1714 			 * objects that have ever been stored with
1715 			 * large blocks, so we don't need the special
1716 			 * logic below.  ZAP blocks can shrink (when
1717 			 * there's only one block), so we don't want
1718 			 * to hit the error below about block size
1719 			 * only increasing.
1720 			 */
1721 			do_free_range = B_TRUE;
1722 		} else if (doi->doi_max_offset <=
1723 		    doi->doi_data_block_size) {
1724 			/*
1725 			 * There is only one block.  We can free it,
1726 			 * because its contents will be replaced by a
1727 			 * WRITE record.  This can not be the no-L ->
1728 			 * -L case, because the no-L case would have
1729 			 * resulted in multiple blocks.  If we
1730 			 * supported -L -> no-L, it would not be safe
1731 			 * to free the file's contents.  Fortunately,
1732 			 * that is not allowed (see
1733 			 * recv_check_large_blocks()).
1734 			 */
1735 			do_free_range = B_TRUE;
1736 		} else {
1737 			boolean_t is_same_gen;
1738 			err = receive_object_is_same_generation(rwa->os,
1739 			    drro->drr_object, doi->doi_bonus_type,
1740 			    drro->drr_bonustype, bonus_data, &is_same_gen);
1741 			if (err != 0)
1742 				return (SET_ERROR(EINVAL));
1743 
1744 			if (is_same_gen) {
1745 				/*
1746 				 * This is the same logical file, and
1747 				 * the block size must be increasing.
1748 				 * It could only decrease if
1749 				 * --large-block was changed to be
1750 				 * off, which is checked in
1751 				 * recv_check_large_blocks().
1752 				 */
1753 				if (drro->drr_blksz <=
1754 				    doi->doi_data_block_size)
1755 					return (SET_ERROR(EINVAL));
1756 				/*
1757 				 * We keep the existing blocksize and
1758 				 * contents.
1759 				 */
1760 				*new_blksz =
1761 				    doi->doi_data_block_size;
1762 			} else {
1763 				do_free_range = B_TRUE;
1764 			}
1765 		}
1766 	}
1767 
1768 	/* nblkptr can only decrease if the object was reallocated */
1769 	if (nblkptr < doi->doi_nblkptr)
1770 		do_free_range = B_TRUE;
1771 
1772 	/* number of slots can only change on reallocation */
1773 	if (dn_slots != doi->doi_dnodesize >> DNODE_SHIFT)
1774 		do_free_range = B_TRUE;
1775 
1776 	/*
1777 	 * For raw sends we also check a few other fields to
1778 	 * ensure we are preserving the objset structure exactly
1779 	 * as it was on the receive side:
1780 	 *     - A changed indirect block size
1781 	 *     - A smaller nlevels
1782 	 */
1783 	if (rwa->raw) {
1784 		if (indblksz != doi->doi_metadata_block_size)
1785 			do_free_range = B_TRUE;
1786 		if (drro->drr_nlevels < doi->doi_indirection)
1787 			do_free_range = B_TRUE;
1788 	}
1789 
1790 	if (do_free_range) {
1791 		err = dmu_free_long_range(rwa->os, drro->drr_object,
1792 		    0, DMU_OBJECT_END);
1793 		if (err != 0)
1794 			return (SET_ERROR(EINVAL));
1795 	}
1796 
1797 	/*
1798 	 * The dmu does not currently support decreasing nlevels or changing
1799 	 * indirect block size if there is already one, same as changing the
1800 	 * number of of dnode slots on an object.  For non-raw sends this
1801 	 * does not matter and the new object can just use the previous one's
1802 	 * parameters.  For raw sends, however, the structure of the received
1803 	 * dnode (including indirects and dnode slots) must match that of the
1804 	 * send side.  Therefore, instead of using dmu_object_reclaim(), we
1805 	 * must free the object completely and call dmu_object_claim_dnsize()
1806 	 * instead.
1807 	 */
1808 	if ((rwa->raw && ((doi->doi_indirection > 1 &&
1809 	    indblksz != doi->doi_metadata_block_size) ||
1810 	    drro->drr_nlevels < doi->doi_indirection)) ||
1811 	    dn_slots != doi->doi_dnodesize >> DNODE_SHIFT) {
1812 		err = dmu_free_long_object(rwa->os, drro->drr_object);
1813 		if (err != 0)
1814 			return (SET_ERROR(EINVAL));
1815 
1816 		txg_wait_synced(dmu_objset_pool(rwa->os), 0);
1817 		*object_to_hold = DMU_NEW_OBJECT;
1818 	}
1819 
1820 	/*
1821 	 * For raw receives, free everything beyond the new incoming
1822 	 * maxblkid. Normally this would be done with a DRR_FREE
1823 	 * record that would come after this DRR_OBJECT record is
1824 	 * processed. However, for raw receives we manually set the
1825 	 * maxblkid from the drr_maxblkid and so we must first free
1826 	 * everything above that blkid to ensure the DMU is always
1827 	 * consistent with itself. We will never free the first block
1828 	 * of the object here because a maxblkid of 0 could indicate
1829 	 * an object with a single block or one with no blocks. This
1830 	 * free may be skipped when dmu_free_long_range() was called
1831 	 * above since it covers the entire object's contents.
1832 	 */
1833 	if (rwa->raw && *object_to_hold != DMU_NEW_OBJECT && !do_free_range) {
1834 		err = dmu_free_long_range(rwa->os, drro->drr_object,
1835 		    (drro->drr_maxblkid + 1) * doi->doi_data_block_size,
1836 		    DMU_OBJECT_END);
1837 		if (err != 0)
1838 			return (SET_ERROR(EINVAL));
1839 	}
1840 	return (0);
1841 }
1842 
1843 noinline static int
receive_object(struct receive_writer_arg * rwa,struct drr_object * drro,void * data)1844 receive_object(struct receive_writer_arg *rwa, struct drr_object *drro,
1845     void *data)
1846 {
1847 	dmu_object_info_t doi;
1848 	dmu_tx_t *tx;
1849 	int err;
1850 	uint32_t new_blksz = drro->drr_blksz;
1851 	uint8_t dn_slots = drro->drr_dn_slots != 0 ?
1852 	    drro->drr_dn_slots : DNODE_MIN_SLOTS;
1853 
1854 	if (drro->drr_type == DMU_OT_NONE ||
1855 	    !DMU_OT_IS_VALID(drro->drr_type) ||
1856 	    !DMU_OT_IS_VALID(drro->drr_bonustype) ||
1857 	    drro->drr_checksumtype >= ZIO_CHECKSUM_FUNCTIONS ||
1858 	    drro->drr_compress >= ZIO_COMPRESS_FUNCTIONS ||
1859 	    P2PHASE(drro->drr_blksz, SPA_MINBLOCKSIZE) ||
1860 	    drro->drr_blksz < SPA_MINBLOCKSIZE ||
1861 	    drro->drr_blksz > spa_maxblocksize(dmu_objset_spa(rwa->os)) ||
1862 	    drro->drr_bonuslen >
1863 	    DN_BONUS_SIZE(spa_maxdnodesize(dmu_objset_spa(rwa->os))) ||
1864 	    dn_slots >
1865 	    (spa_maxdnodesize(dmu_objset_spa(rwa->os)) >> DNODE_SHIFT)) {
1866 		return (SET_ERROR(EINVAL));
1867 	}
1868 
1869 	if (rwa->raw) {
1870 		/*
1871 		 * We should have received a DRR_OBJECT_RANGE record
1872 		 * containing this block and stored it in rwa.
1873 		 */
1874 		if (drro->drr_object < rwa->or_firstobj ||
1875 		    drro->drr_object >= rwa->or_firstobj + rwa->or_numslots ||
1876 		    drro->drr_raw_bonuslen < drro->drr_bonuslen ||
1877 		    drro->drr_indblkshift > SPA_MAXBLOCKSHIFT ||
1878 		    drro->drr_nlevels > DN_MAX_LEVELS ||
1879 		    drro->drr_nblkptr > DN_MAX_NBLKPTR ||
1880 		    DN_SLOTS_TO_BONUSLEN(dn_slots) <
1881 		    drro->drr_raw_bonuslen)
1882 			return (SET_ERROR(EINVAL));
1883 	} else {
1884 		/*
1885 		 * The DRR_OBJECT_SPILL flag is valid when the DRR_BEGIN
1886 		 * record indicates this by setting DRR_FLAG_SPILL_BLOCK.
1887 		 */
1888 		if (((drro->drr_flags & ~(DRR_OBJECT_SPILL))) ||
1889 		    (!rwa->spill && DRR_OBJECT_HAS_SPILL(drro->drr_flags))) {
1890 			return (SET_ERROR(EINVAL));
1891 		}
1892 
1893 		if (drro->drr_raw_bonuslen != 0 || drro->drr_nblkptr != 0 ||
1894 		    drro->drr_indblkshift != 0 || drro->drr_nlevels != 0) {
1895 			return (SET_ERROR(EINVAL));
1896 		}
1897 	}
1898 
1899 	err = dmu_object_info(rwa->os, drro->drr_object, &doi);
1900 
1901 	if (err != 0 && err != ENOENT && err != EEXIST)
1902 		return (SET_ERROR(EINVAL));
1903 
1904 	if (drro->drr_object > rwa->max_object)
1905 		rwa->max_object = drro->drr_object;
1906 
1907 	/*
1908 	 * If we are losing blkptrs or changing the block size this must
1909 	 * be a new file instance.  We must clear out the previous file
1910 	 * contents before we can change this type of metadata in the dnode.
1911 	 * Raw receives will also check that the indirect structure of the
1912 	 * dnode hasn't changed.
1913 	 */
1914 	uint64_t object_to_hold;
1915 	if (err == 0) {
1916 		err = receive_handle_existing_object(rwa, drro, &doi, data,
1917 		    &object_to_hold, &new_blksz);
1918 		if (err != 0)
1919 			return (err);
1920 	} else if (err == EEXIST) {
1921 		/*
1922 		 * The object requested is currently an interior slot of a
1923 		 * multi-slot dnode. This will be resolved when the next txg
1924 		 * is synced out, since the send stream will have told us
1925 		 * to free this slot when we freed the associated dnode
1926 		 * earlier in the stream.
1927 		 */
1928 		txg_wait_synced(dmu_objset_pool(rwa->os), 0);
1929 
1930 		if (dmu_object_info(rwa->os, drro->drr_object, NULL) != ENOENT)
1931 			return (SET_ERROR(EINVAL));
1932 
1933 		/* object was freed and we are about to allocate a new one */
1934 		object_to_hold = DMU_NEW_OBJECT;
1935 	} else {
1936 		/*
1937 		 * If the only record in this range so far was DRR_FREEOBJECTS
1938 		 * with at least one actually freed object, it's possible that
1939 		 * the block will now be converted to a hole. We need to wait
1940 		 * for the txg to sync to prevent races.
1941 		 */
1942 		if (rwa->or_need_sync == ORNS_YES)
1943 			txg_wait_synced(dmu_objset_pool(rwa->os), 0);
1944 
1945 		/* object is free and we are about to allocate a new one */
1946 		object_to_hold = DMU_NEW_OBJECT;
1947 	}
1948 
1949 	/* Only relevant for the first object in the range */
1950 	rwa->or_need_sync = ORNS_NO;
1951 
1952 	/*
1953 	 * If this is a multi-slot dnode there is a chance that this
1954 	 * object will expand into a slot that is already used by
1955 	 * another object from the previous snapshot. We must free
1956 	 * these objects before we attempt to allocate the new dnode.
1957 	 */
1958 	if (dn_slots > 1) {
1959 		boolean_t need_sync = B_FALSE;
1960 
1961 		for (uint64_t slot = drro->drr_object + 1;
1962 		    slot < drro->drr_object + dn_slots;
1963 		    slot++) {
1964 			dmu_object_info_t slot_doi;
1965 
1966 			err = dmu_object_info(rwa->os, slot, &slot_doi);
1967 			if (err == ENOENT || err == EEXIST)
1968 				continue;
1969 			else if (err != 0)
1970 				return (err);
1971 
1972 			err = dmu_free_long_object(rwa->os, slot);
1973 			if (err != 0)
1974 				return (err);
1975 
1976 			need_sync = B_TRUE;
1977 		}
1978 
1979 		if (need_sync)
1980 			txg_wait_synced(dmu_objset_pool(rwa->os), 0);
1981 	}
1982 
1983 	tx = dmu_tx_create(rwa->os);
1984 	dmu_tx_hold_bonus(tx, object_to_hold);
1985 	dmu_tx_hold_write(tx, object_to_hold, 0, 0);
1986 	err = dmu_tx_assign(tx, TXG_WAIT);
1987 	if (err != 0) {
1988 		dmu_tx_abort(tx);
1989 		return (err);
1990 	}
1991 
1992 	if (object_to_hold == DMU_NEW_OBJECT) {
1993 		/* Currently free, wants to be allocated */
1994 		err = dmu_object_claim_dnsize(rwa->os, drro->drr_object,
1995 		    drro->drr_type, new_blksz,
1996 		    drro->drr_bonustype, drro->drr_bonuslen,
1997 		    dn_slots << DNODE_SHIFT, tx);
1998 	} else if (drro->drr_type != doi.doi_type ||
1999 	    new_blksz != doi.doi_data_block_size ||
2000 	    drro->drr_bonustype != doi.doi_bonus_type ||
2001 	    drro->drr_bonuslen != doi.doi_bonus_size) {
2002 		/* Currently allocated, but with different properties */
2003 		err = dmu_object_reclaim_dnsize(rwa->os, drro->drr_object,
2004 		    drro->drr_type, new_blksz,
2005 		    drro->drr_bonustype, drro->drr_bonuslen,
2006 		    dn_slots << DNODE_SHIFT, rwa->spill ?
2007 		    DRR_OBJECT_HAS_SPILL(drro->drr_flags) : B_FALSE, tx);
2008 	} else if (rwa->spill && !DRR_OBJECT_HAS_SPILL(drro->drr_flags)) {
2009 		/*
2010 		 * Currently allocated, the existing version of this object
2011 		 * may reference a spill block that is no longer allocated
2012 		 * at the source and needs to be freed.
2013 		 */
2014 		err = dmu_object_rm_spill(rwa->os, drro->drr_object, tx);
2015 	}
2016 
2017 	if (err != 0) {
2018 		dmu_tx_commit(tx);
2019 		return (SET_ERROR(EINVAL));
2020 	}
2021 
2022 	if (rwa->or_crypt_params_present) {
2023 		/*
2024 		 * Set the crypt params for the buffer associated with this
2025 		 * range of dnodes.  This causes the blkptr_t to have the
2026 		 * same crypt params (byteorder, salt, iv, mac) as on the
2027 		 * sending side.
2028 		 *
2029 		 * Since we are committing this tx now, it is possible for
2030 		 * the dnode block to end up on-disk with the incorrect MAC,
2031 		 * if subsequent objects in this block are received in a
2032 		 * different txg.  However, since the dataset is marked as
2033 		 * inconsistent, no code paths will do a non-raw read (or
2034 		 * decrypt the block / verify the MAC). The receive code and
2035 		 * scrub code can safely do raw reads and verify the
2036 		 * checksum.  They don't need to verify the MAC.
2037 		 */
2038 		dmu_buf_t *db = NULL;
2039 		uint64_t offset = rwa->or_firstobj * DNODE_MIN_SIZE;
2040 
2041 		err = dmu_buf_hold_by_dnode(DMU_META_DNODE(rwa->os),
2042 		    offset, FTAG, &db, DMU_READ_PREFETCH | DMU_READ_NO_DECRYPT);
2043 		if (err != 0) {
2044 			dmu_tx_commit(tx);
2045 			return (SET_ERROR(EINVAL));
2046 		}
2047 
2048 		dmu_buf_set_crypt_params(db, rwa->or_byteorder,
2049 		    rwa->or_salt, rwa->or_iv, rwa->or_mac, tx);
2050 
2051 		dmu_buf_rele(db, FTAG);
2052 
2053 		rwa->or_crypt_params_present = B_FALSE;
2054 	}
2055 
2056 	dmu_object_set_checksum(rwa->os, drro->drr_object,
2057 	    drro->drr_checksumtype, tx);
2058 	dmu_object_set_compress(rwa->os, drro->drr_object,
2059 	    drro->drr_compress, tx);
2060 
2061 	/* handle more restrictive dnode structuring for raw recvs */
2062 	if (rwa->raw) {
2063 		/*
2064 		 * Set the indirect block size, block shift, nlevels.
2065 		 * This will not fail because we ensured all of the
2066 		 * blocks were freed earlier if this is a new object.
2067 		 * For non-new objects block size and indirect block
2068 		 * shift cannot change and nlevels can only increase.
2069 		 */
2070 		ASSERT3U(new_blksz, ==, drro->drr_blksz);
2071 		VERIFY0(dmu_object_set_blocksize(rwa->os, drro->drr_object,
2072 		    drro->drr_blksz, drro->drr_indblkshift, tx));
2073 		VERIFY0(dmu_object_set_nlevels(rwa->os, drro->drr_object,
2074 		    drro->drr_nlevels, tx));
2075 
2076 		/*
2077 		 * Set the maxblkid. This will always succeed because
2078 		 * we freed all blocks beyond the new maxblkid above.
2079 		 */
2080 		VERIFY0(dmu_object_set_maxblkid(rwa->os, drro->drr_object,
2081 		    drro->drr_maxblkid, tx));
2082 	}
2083 
2084 	if (data != NULL) {
2085 		dmu_buf_t *db;
2086 		dnode_t *dn;
2087 		uint32_t flags = DMU_READ_NO_PREFETCH;
2088 
2089 		if (rwa->raw)
2090 			flags |= DMU_READ_NO_DECRYPT;
2091 
2092 		VERIFY0(dnode_hold(rwa->os, drro->drr_object, FTAG, &dn));
2093 		VERIFY0(dmu_bonus_hold_by_dnode(dn, FTAG, &db, flags));
2094 
2095 		dmu_buf_will_dirty(db, tx);
2096 
2097 		ASSERT3U(db->db_size, >=, drro->drr_bonuslen);
2098 		memcpy(db->db_data, data, DRR_OBJECT_PAYLOAD_SIZE(drro));
2099 
2100 		/*
2101 		 * Raw bonus buffers have their byteorder determined by the
2102 		 * DRR_OBJECT_RANGE record.
2103 		 */
2104 		if (rwa->byteswap && !rwa->raw) {
2105 			dmu_object_byteswap_t byteswap =
2106 			    DMU_OT_BYTESWAP(drro->drr_bonustype);
2107 			dmu_ot_byteswap[byteswap].ob_func(db->db_data,
2108 			    DRR_OBJECT_PAYLOAD_SIZE(drro));
2109 		}
2110 		dmu_buf_rele(db, FTAG);
2111 		dnode_rele(dn, FTAG);
2112 	}
2113 
2114 	/*
2115 	 * If the receive fails, we want the resume stream to start with the
2116 	 * same record that we last successfully received. There is no way to
2117 	 * request resume from the object record, but we can benefit from the
2118 	 * fact that sender always sends object record before anything else,
2119 	 * after which it will "resend" data at offset 0 and resume normally.
2120 	 */
2121 	save_resume_state(rwa, drro->drr_object, 0, tx);
2122 
2123 	dmu_tx_commit(tx);
2124 
2125 	return (0);
2126 }
2127 
2128 noinline static int
receive_freeobjects(struct receive_writer_arg * rwa,struct drr_freeobjects * drrfo)2129 receive_freeobjects(struct receive_writer_arg *rwa,
2130     struct drr_freeobjects *drrfo)
2131 {
2132 	uint64_t obj;
2133 	int next_err = 0;
2134 
2135 	if (drrfo->drr_firstobj + drrfo->drr_numobjs < drrfo->drr_firstobj)
2136 		return (SET_ERROR(EINVAL));
2137 
2138 	for (obj = drrfo->drr_firstobj == 0 ? 1 : drrfo->drr_firstobj;
2139 	    obj < drrfo->drr_firstobj + drrfo->drr_numobjs &&
2140 	    obj < DN_MAX_OBJECT && next_err == 0;
2141 	    next_err = dmu_object_next(rwa->os, &obj, FALSE, 0)) {
2142 		dmu_object_info_t doi;
2143 		int err;
2144 
2145 		err = dmu_object_info(rwa->os, obj, &doi);
2146 		if (err == ENOENT)
2147 			continue;
2148 		else if (err != 0)
2149 			return (err);
2150 
2151 		err = dmu_free_long_object(rwa->os, obj);
2152 
2153 		if (err != 0)
2154 			return (err);
2155 
2156 		if (rwa->or_need_sync == ORNS_MAYBE)
2157 			rwa->or_need_sync = ORNS_YES;
2158 	}
2159 	if (next_err != ESRCH)
2160 		return (next_err);
2161 	return (0);
2162 }
2163 
2164 /*
2165  * Note: if this fails, the caller will clean up any records left on the
2166  * rwa->write_batch list.
2167  */
2168 static int
flush_write_batch_impl(struct receive_writer_arg * rwa)2169 flush_write_batch_impl(struct receive_writer_arg *rwa)
2170 {
2171 	dnode_t *dn;
2172 	int err;
2173 
2174 	if (dnode_hold(rwa->os, rwa->last_object, FTAG, &dn) != 0)
2175 		return (SET_ERROR(EINVAL));
2176 
2177 	struct receive_record_arg *last_rrd = list_tail(&rwa->write_batch);
2178 	struct drr_write *last_drrw = &last_rrd->header.drr_u.drr_write;
2179 
2180 	struct receive_record_arg *first_rrd = list_head(&rwa->write_batch);
2181 	struct drr_write *first_drrw = &first_rrd->header.drr_u.drr_write;
2182 
2183 	ASSERT3U(rwa->last_object, ==, last_drrw->drr_object);
2184 	ASSERT3U(rwa->last_offset, ==, last_drrw->drr_offset);
2185 
2186 	dmu_tx_t *tx = dmu_tx_create(rwa->os);
2187 	dmu_tx_hold_write_by_dnode(tx, dn, first_drrw->drr_offset,
2188 	    last_drrw->drr_offset - first_drrw->drr_offset +
2189 	    last_drrw->drr_logical_size);
2190 	err = dmu_tx_assign(tx, TXG_WAIT);
2191 	if (err != 0) {
2192 		dmu_tx_abort(tx);
2193 		dnode_rele(dn, FTAG);
2194 		return (err);
2195 	}
2196 
2197 	struct receive_record_arg *rrd;
2198 	while ((rrd = list_head(&rwa->write_batch)) != NULL) {
2199 		struct drr_write *drrw = &rrd->header.drr_u.drr_write;
2200 		abd_t *abd = rrd->abd;
2201 
2202 		ASSERT3U(drrw->drr_object, ==, rwa->last_object);
2203 
2204 		if (drrw->drr_logical_size != dn->dn_datablksz) {
2205 			/*
2206 			 * The WRITE record is larger than the object's block
2207 			 * size.  We must be receiving an incremental
2208 			 * large-block stream into a dataset that previously did
2209 			 * a non-large-block receive.  Lightweight writes must
2210 			 * be exactly one block, so we need to decompress the
2211 			 * data (if compressed) and do a normal dmu_write().
2212 			 */
2213 			ASSERT3U(drrw->drr_logical_size, >, dn->dn_datablksz);
2214 			if (DRR_WRITE_COMPRESSED(drrw)) {
2215 				abd_t *decomp_abd =
2216 				    abd_alloc_linear(drrw->drr_logical_size,
2217 				    B_FALSE);
2218 
2219 				err = zio_decompress_data(
2220 				    drrw->drr_compressiontype,
2221 				    abd, abd_to_buf(decomp_abd),
2222 				    abd_get_size(abd),
2223 				    abd_get_size(decomp_abd), NULL);
2224 
2225 				if (err == 0) {
2226 					dmu_write_by_dnode(dn,
2227 					    drrw->drr_offset,
2228 					    drrw->drr_logical_size,
2229 					    abd_to_buf(decomp_abd), tx);
2230 				}
2231 				abd_free(decomp_abd);
2232 			} else {
2233 				dmu_write_by_dnode(dn,
2234 				    drrw->drr_offset,
2235 				    drrw->drr_logical_size,
2236 				    abd_to_buf(abd), tx);
2237 			}
2238 			if (err == 0)
2239 				abd_free(abd);
2240 		} else {
2241 			zio_prop_t zp = {0};
2242 			dmu_write_policy(rwa->os, dn, 0, 0, &zp);
2243 
2244 			zio_flag_t zio_flags = 0;
2245 
2246 			if (rwa->raw) {
2247 				zp.zp_encrypt = B_TRUE;
2248 				zp.zp_compress = drrw->drr_compressiontype;
2249 				zp.zp_byteorder = ZFS_HOST_BYTEORDER ^
2250 				    !!DRR_IS_RAW_BYTESWAPPED(drrw->drr_flags) ^
2251 				    rwa->byteswap;
2252 				memcpy(zp.zp_salt, drrw->drr_salt,
2253 				    ZIO_DATA_SALT_LEN);
2254 				memcpy(zp.zp_iv, drrw->drr_iv,
2255 				    ZIO_DATA_IV_LEN);
2256 				memcpy(zp.zp_mac, drrw->drr_mac,
2257 				    ZIO_DATA_MAC_LEN);
2258 				if (DMU_OT_IS_ENCRYPTED(zp.zp_type)) {
2259 					zp.zp_nopwrite = B_FALSE;
2260 					zp.zp_copies = MIN(zp.zp_copies,
2261 					    SPA_DVAS_PER_BP - 1);
2262 				}
2263 				zio_flags |= ZIO_FLAG_RAW;
2264 			} else if (DRR_WRITE_COMPRESSED(drrw)) {
2265 				ASSERT3U(drrw->drr_compressed_size, >, 0);
2266 				ASSERT3U(drrw->drr_logical_size, >=,
2267 				    drrw->drr_compressed_size);
2268 				zp.zp_compress = drrw->drr_compressiontype;
2269 				zio_flags |= ZIO_FLAG_RAW_COMPRESS;
2270 			} else if (rwa->byteswap) {
2271 				/*
2272 				 * Note: compressed blocks never need to be
2273 				 * byteswapped, because WRITE records for
2274 				 * metadata blocks are never compressed. The
2275 				 * exception is raw streams, which are written
2276 				 * in the original byteorder, and the byteorder
2277 				 * bit is preserved in the BP by setting
2278 				 * zp_byteorder above.
2279 				 */
2280 				dmu_object_byteswap_t byteswap =
2281 				    DMU_OT_BYTESWAP(drrw->drr_type);
2282 				dmu_ot_byteswap[byteswap].ob_func(
2283 				    abd_to_buf(abd),
2284 				    DRR_WRITE_PAYLOAD_SIZE(drrw));
2285 			}
2286 
2287 			/*
2288 			 * Since this data can't be read until the receive
2289 			 * completes, we can do a "lightweight" write for
2290 			 * improved performance.
2291 			 */
2292 			err = dmu_lightweight_write_by_dnode(dn,
2293 			    drrw->drr_offset, abd, &zp, zio_flags, tx);
2294 		}
2295 
2296 		if (err != 0) {
2297 			/*
2298 			 * This rrd is left on the list, so the caller will
2299 			 * free it (and the abd).
2300 			 */
2301 			break;
2302 		}
2303 
2304 		/*
2305 		 * Note: If the receive fails, we want the resume stream to
2306 		 * start with the same record that we last successfully
2307 		 * received (as opposed to the next record), so that we can
2308 		 * verify that we are resuming from the correct location.
2309 		 */
2310 		save_resume_state(rwa, drrw->drr_object, drrw->drr_offset, tx);
2311 
2312 		list_remove(&rwa->write_batch, rrd);
2313 		kmem_free(rrd, sizeof (*rrd));
2314 	}
2315 
2316 	dmu_tx_commit(tx);
2317 	dnode_rele(dn, FTAG);
2318 	return (err);
2319 }
2320 
2321 noinline static int
flush_write_batch(struct receive_writer_arg * rwa)2322 flush_write_batch(struct receive_writer_arg *rwa)
2323 {
2324 	if (list_is_empty(&rwa->write_batch))
2325 		return (0);
2326 	int err = rwa->err;
2327 	if (err == 0)
2328 		err = flush_write_batch_impl(rwa);
2329 	if (err != 0) {
2330 		struct receive_record_arg *rrd;
2331 		while ((rrd = list_remove_head(&rwa->write_batch)) != NULL) {
2332 			abd_free(rrd->abd);
2333 			kmem_free(rrd, sizeof (*rrd));
2334 		}
2335 	}
2336 	ASSERT(list_is_empty(&rwa->write_batch));
2337 	return (err);
2338 }
2339 
2340 noinline static int
receive_process_write_record(struct receive_writer_arg * rwa,struct receive_record_arg * rrd)2341 receive_process_write_record(struct receive_writer_arg *rwa,
2342     struct receive_record_arg *rrd)
2343 {
2344 	int err = 0;
2345 
2346 	ASSERT3U(rrd->header.drr_type, ==, DRR_WRITE);
2347 	struct drr_write *drrw = &rrd->header.drr_u.drr_write;
2348 
2349 	if (drrw->drr_offset + drrw->drr_logical_size < drrw->drr_offset ||
2350 	    !DMU_OT_IS_VALID(drrw->drr_type))
2351 		return (SET_ERROR(EINVAL));
2352 
2353 	if (rwa->heal) {
2354 		blkptr_t *bp;
2355 		dmu_buf_t *dbp;
2356 		int flags = DB_RF_CANFAIL;
2357 
2358 		if (rwa->raw)
2359 			flags |= DB_RF_NO_DECRYPT;
2360 
2361 		if (rwa->byteswap) {
2362 			dmu_object_byteswap_t byteswap =
2363 			    DMU_OT_BYTESWAP(drrw->drr_type);
2364 			dmu_ot_byteswap[byteswap].ob_func(abd_to_buf(rrd->abd),
2365 			    DRR_WRITE_PAYLOAD_SIZE(drrw));
2366 		}
2367 
2368 		err = dmu_buf_hold_noread(rwa->os, drrw->drr_object,
2369 		    drrw->drr_offset, FTAG, &dbp);
2370 		if (err != 0)
2371 			return (err);
2372 
2373 		/* Try to read the object to see if it needs healing */
2374 		err = dbuf_read((dmu_buf_impl_t *)dbp, NULL, flags);
2375 		/*
2376 		 * We only try to heal when dbuf_read() returns a ECKSUMs.
2377 		 * Other errors (even EIO) get returned to caller.
2378 		 * EIO indicates that the device is not present/accessible,
2379 		 * so writing to it will likely fail.
2380 		 * If the block is healthy, we don't want to overwrite it
2381 		 * unnecessarily.
2382 		 */
2383 		if (err != ECKSUM) {
2384 			dmu_buf_rele(dbp, FTAG);
2385 			return (err);
2386 		}
2387 		/* Make sure the on-disk block and recv record sizes match */
2388 		if (drrw->drr_logical_size != dbp->db_size) {
2389 			err = ENOTSUP;
2390 			dmu_buf_rele(dbp, FTAG);
2391 			return (err);
2392 		}
2393 		/* Get the block pointer for the corrupted block */
2394 		bp = dmu_buf_get_blkptr(dbp);
2395 		err = do_corrective_recv(rwa, drrw, rrd, bp);
2396 		dmu_buf_rele(dbp, FTAG);
2397 		return (err);
2398 	}
2399 
2400 	/*
2401 	 * For resuming to work, records must be in increasing order
2402 	 * by (object, offset).
2403 	 */
2404 	if (drrw->drr_object < rwa->last_object ||
2405 	    (drrw->drr_object == rwa->last_object &&
2406 	    drrw->drr_offset < rwa->last_offset)) {
2407 		return (SET_ERROR(EINVAL));
2408 	}
2409 
2410 	struct receive_record_arg *first_rrd = list_head(&rwa->write_batch);
2411 	struct drr_write *first_drrw = &first_rrd->header.drr_u.drr_write;
2412 	uint64_t batch_size =
2413 	    MIN(zfs_recv_write_batch_size, DMU_MAX_ACCESS / 2);
2414 	if (first_rrd != NULL &&
2415 	    (drrw->drr_object != first_drrw->drr_object ||
2416 	    drrw->drr_offset >= first_drrw->drr_offset + batch_size)) {
2417 		err = flush_write_batch(rwa);
2418 		if (err != 0)
2419 			return (err);
2420 	}
2421 
2422 	rwa->last_object = drrw->drr_object;
2423 	rwa->last_offset = drrw->drr_offset;
2424 
2425 	if (rwa->last_object > rwa->max_object)
2426 		rwa->max_object = rwa->last_object;
2427 
2428 	list_insert_tail(&rwa->write_batch, rrd);
2429 	/*
2430 	 * Return EAGAIN to indicate that we will use this rrd again,
2431 	 * so the caller should not free it
2432 	 */
2433 	return (EAGAIN);
2434 }
2435 
2436 static int
receive_write_embedded(struct receive_writer_arg * rwa,struct drr_write_embedded * drrwe,void * data)2437 receive_write_embedded(struct receive_writer_arg *rwa,
2438     struct drr_write_embedded *drrwe, void *data)
2439 {
2440 	dmu_tx_t *tx;
2441 	int err;
2442 
2443 	if (drrwe->drr_offset + drrwe->drr_length < drrwe->drr_offset)
2444 		return (SET_ERROR(EINVAL));
2445 
2446 	if (drrwe->drr_psize > BPE_PAYLOAD_SIZE)
2447 		return (SET_ERROR(EINVAL));
2448 
2449 	if (drrwe->drr_etype >= NUM_BP_EMBEDDED_TYPES)
2450 		return (SET_ERROR(EINVAL));
2451 	if (drrwe->drr_compression >= ZIO_COMPRESS_FUNCTIONS)
2452 		return (SET_ERROR(EINVAL));
2453 	if (rwa->raw)
2454 		return (SET_ERROR(EINVAL));
2455 
2456 	if (drrwe->drr_object > rwa->max_object)
2457 		rwa->max_object = drrwe->drr_object;
2458 
2459 	tx = dmu_tx_create(rwa->os);
2460 
2461 	dmu_tx_hold_write(tx, drrwe->drr_object,
2462 	    drrwe->drr_offset, drrwe->drr_length);
2463 	err = dmu_tx_assign(tx, TXG_WAIT);
2464 	if (err != 0) {
2465 		dmu_tx_abort(tx);
2466 		return (err);
2467 	}
2468 
2469 	dmu_write_embedded(rwa->os, drrwe->drr_object,
2470 	    drrwe->drr_offset, data, drrwe->drr_etype,
2471 	    drrwe->drr_compression, drrwe->drr_lsize, drrwe->drr_psize,
2472 	    rwa->byteswap ^ ZFS_HOST_BYTEORDER, tx);
2473 
2474 	/* See comment in restore_write. */
2475 	save_resume_state(rwa, drrwe->drr_object, drrwe->drr_offset, tx);
2476 	dmu_tx_commit(tx);
2477 	return (0);
2478 }
2479 
2480 static int
receive_spill(struct receive_writer_arg * rwa,struct drr_spill * drrs,abd_t * abd)2481 receive_spill(struct receive_writer_arg *rwa, struct drr_spill *drrs,
2482     abd_t *abd)
2483 {
2484 	dmu_buf_t *db, *db_spill;
2485 	int err;
2486 
2487 	if (drrs->drr_length < SPA_MINBLOCKSIZE ||
2488 	    drrs->drr_length > spa_maxblocksize(dmu_objset_spa(rwa->os)))
2489 		return (SET_ERROR(EINVAL));
2490 
2491 	/*
2492 	 * This is an unmodified spill block which was added to the stream
2493 	 * to resolve an issue with incorrectly removing spill blocks.  It
2494 	 * should be ignored by current versions of the code which support
2495 	 * the DRR_FLAG_SPILL_BLOCK flag.
2496 	 */
2497 	if (rwa->spill && DRR_SPILL_IS_UNMODIFIED(drrs->drr_flags)) {
2498 		abd_free(abd);
2499 		return (0);
2500 	}
2501 
2502 	if (rwa->raw) {
2503 		if (!DMU_OT_IS_VALID(drrs->drr_type) ||
2504 		    drrs->drr_compressiontype >= ZIO_COMPRESS_FUNCTIONS ||
2505 		    drrs->drr_compressed_size == 0)
2506 			return (SET_ERROR(EINVAL));
2507 	}
2508 
2509 	if (dmu_object_info(rwa->os, drrs->drr_object, NULL) != 0)
2510 		return (SET_ERROR(EINVAL));
2511 
2512 	if (drrs->drr_object > rwa->max_object)
2513 		rwa->max_object = drrs->drr_object;
2514 
2515 	VERIFY0(dmu_bonus_hold(rwa->os, drrs->drr_object, FTAG, &db));
2516 	if ((err = dmu_spill_hold_by_bonus(db, DMU_READ_NO_DECRYPT, FTAG,
2517 	    &db_spill)) != 0) {
2518 		dmu_buf_rele(db, FTAG);
2519 		return (err);
2520 	}
2521 
2522 	dmu_tx_t *tx = dmu_tx_create(rwa->os);
2523 
2524 	dmu_tx_hold_spill(tx, db->db_object);
2525 
2526 	err = dmu_tx_assign(tx, TXG_WAIT);
2527 	if (err != 0) {
2528 		dmu_buf_rele(db, FTAG);
2529 		dmu_buf_rele(db_spill, FTAG);
2530 		dmu_tx_abort(tx);
2531 		return (err);
2532 	}
2533 
2534 	/*
2535 	 * Spill blocks may both grow and shrink.  When a change in size
2536 	 * occurs any existing dbuf must be updated to match the logical
2537 	 * size of the provided arc_buf_t.
2538 	 */
2539 	if (db_spill->db_size != drrs->drr_length) {
2540 		dmu_buf_will_fill(db_spill, tx, B_FALSE);
2541 		VERIFY0(dbuf_spill_set_blksz(db_spill,
2542 		    drrs->drr_length, tx));
2543 	}
2544 
2545 	arc_buf_t *abuf;
2546 	if (rwa->raw) {
2547 		boolean_t byteorder = ZFS_HOST_BYTEORDER ^
2548 		    !!DRR_IS_RAW_BYTESWAPPED(drrs->drr_flags) ^
2549 		    rwa->byteswap;
2550 
2551 		abuf = arc_loan_raw_buf(dmu_objset_spa(rwa->os),
2552 		    drrs->drr_object, byteorder, drrs->drr_salt,
2553 		    drrs->drr_iv, drrs->drr_mac, drrs->drr_type,
2554 		    drrs->drr_compressed_size, drrs->drr_length,
2555 		    drrs->drr_compressiontype, 0);
2556 	} else {
2557 		abuf = arc_loan_buf(dmu_objset_spa(rwa->os),
2558 		    DMU_OT_IS_METADATA(drrs->drr_type),
2559 		    drrs->drr_length);
2560 		if (rwa->byteswap) {
2561 			dmu_object_byteswap_t byteswap =
2562 			    DMU_OT_BYTESWAP(drrs->drr_type);
2563 			dmu_ot_byteswap[byteswap].ob_func(abd_to_buf(abd),
2564 			    DRR_SPILL_PAYLOAD_SIZE(drrs));
2565 		}
2566 	}
2567 
2568 	memcpy(abuf->b_data, abd_to_buf(abd), DRR_SPILL_PAYLOAD_SIZE(drrs));
2569 	abd_free(abd);
2570 	dbuf_assign_arcbuf((dmu_buf_impl_t *)db_spill, abuf, tx);
2571 
2572 	dmu_buf_rele(db, FTAG);
2573 	dmu_buf_rele(db_spill, FTAG);
2574 
2575 	dmu_tx_commit(tx);
2576 	return (0);
2577 }
2578 
2579 noinline static int
receive_free(struct receive_writer_arg * rwa,struct drr_free * drrf)2580 receive_free(struct receive_writer_arg *rwa, struct drr_free *drrf)
2581 {
2582 	int err;
2583 
2584 	if (drrf->drr_length != -1ULL &&
2585 	    drrf->drr_offset + drrf->drr_length < drrf->drr_offset)
2586 		return (SET_ERROR(EINVAL));
2587 
2588 	if (dmu_object_info(rwa->os, drrf->drr_object, NULL) != 0)
2589 		return (SET_ERROR(EINVAL));
2590 
2591 	if (drrf->drr_object > rwa->max_object)
2592 		rwa->max_object = drrf->drr_object;
2593 
2594 	err = dmu_free_long_range(rwa->os, drrf->drr_object,
2595 	    drrf->drr_offset, drrf->drr_length);
2596 
2597 	return (err);
2598 }
2599 
2600 static int
receive_object_range(struct receive_writer_arg * rwa,struct drr_object_range * drror)2601 receive_object_range(struct receive_writer_arg *rwa,
2602     struct drr_object_range *drror)
2603 {
2604 	/*
2605 	 * By default, we assume this block is in our native format
2606 	 * (ZFS_HOST_BYTEORDER). We then take into account whether
2607 	 * the send stream is byteswapped (rwa->byteswap). Finally,
2608 	 * we need to byteswap again if this particular block was
2609 	 * in non-native format on the send side.
2610 	 */
2611 	boolean_t byteorder = ZFS_HOST_BYTEORDER ^ rwa->byteswap ^
2612 	    !!DRR_IS_RAW_BYTESWAPPED(drror->drr_flags);
2613 
2614 	/*
2615 	 * Since dnode block sizes are constant, we should not need to worry
2616 	 * about making sure that the dnode block size is the same on the
2617 	 * sending and receiving sides for the time being. For non-raw sends,
2618 	 * this does not matter (and in fact we do not send a DRR_OBJECT_RANGE
2619 	 * record at all). Raw sends require this record type because the
2620 	 * encryption parameters are used to protect an entire block of bonus
2621 	 * buffers. If the size of dnode blocks ever becomes variable,
2622 	 * handling will need to be added to ensure that dnode block sizes
2623 	 * match on the sending and receiving side.
2624 	 */
2625 	if (drror->drr_numslots != DNODES_PER_BLOCK ||
2626 	    P2PHASE(drror->drr_firstobj, DNODES_PER_BLOCK) != 0 ||
2627 	    !rwa->raw)
2628 		return (SET_ERROR(EINVAL));
2629 
2630 	if (drror->drr_firstobj > rwa->max_object)
2631 		rwa->max_object = drror->drr_firstobj;
2632 
2633 	/*
2634 	 * The DRR_OBJECT_RANGE handling must be deferred to receive_object()
2635 	 * so that the block of dnodes is not written out when it's empty,
2636 	 * and converted to a HOLE BP.
2637 	 */
2638 	rwa->or_crypt_params_present = B_TRUE;
2639 	rwa->or_firstobj = drror->drr_firstobj;
2640 	rwa->or_numslots = drror->drr_numslots;
2641 	memcpy(rwa->or_salt, drror->drr_salt, ZIO_DATA_SALT_LEN);
2642 	memcpy(rwa->or_iv, drror->drr_iv, ZIO_DATA_IV_LEN);
2643 	memcpy(rwa->or_mac, drror->drr_mac, ZIO_DATA_MAC_LEN);
2644 	rwa->or_byteorder = byteorder;
2645 
2646 	rwa->or_need_sync = ORNS_MAYBE;
2647 
2648 	return (0);
2649 }
2650 
2651 /*
2652  * Until we have the ability to redact large ranges of data efficiently, we
2653  * process these records as frees.
2654  */
2655 noinline static int
receive_redact(struct receive_writer_arg * rwa,struct drr_redact * drrr)2656 receive_redact(struct receive_writer_arg *rwa, struct drr_redact *drrr)
2657 {
2658 	struct drr_free drrf = {0};
2659 	drrf.drr_length = drrr->drr_length;
2660 	drrf.drr_object = drrr->drr_object;
2661 	drrf.drr_offset = drrr->drr_offset;
2662 	drrf.drr_toguid = drrr->drr_toguid;
2663 	return (receive_free(rwa, &drrf));
2664 }
2665 
2666 /* used to destroy the drc_ds on error */
2667 static void
dmu_recv_cleanup_ds(dmu_recv_cookie_t * drc)2668 dmu_recv_cleanup_ds(dmu_recv_cookie_t *drc)
2669 {
2670 	dsl_dataset_t *ds = drc->drc_ds;
2671 	ds_hold_flags_t dsflags;
2672 
2673 	dsflags = (drc->drc_raw) ? DS_HOLD_FLAG_NONE : DS_HOLD_FLAG_DECRYPT;
2674 	/*
2675 	 * Wait for the txg sync before cleaning up the receive. For
2676 	 * resumable receives, this ensures that our resume state has
2677 	 * been written out to disk. For raw receives, this ensures
2678 	 * that the user accounting code will not attempt to do anything
2679 	 * after we stopped receiving the dataset.
2680 	 */
2681 	txg_wait_synced(ds->ds_dir->dd_pool, 0);
2682 	ds->ds_objset->os_raw_receive = B_FALSE;
2683 
2684 	rrw_enter(&ds->ds_bp_rwlock, RW_READER, FTAG);
2685 	if (drc->drc_resumable && drc->drc_should_save &&
2686 	    !BP_IS_HOLE(dsl_dataset_get_blkptr(ds))) {
2687 		rrw_exit(&ds->ds_bp_rwlock, FTAG);
2688 		dsl_dataset_disown(ds, dsflags, dmu_recv_tag);
2689 	} else {
2690 		char name[ZFS_MAX_DATASET_NAME_LEN];
2691 		rrw_exit(&ds->ds_bp_rwlock, FTAG);
2692 		dsl_dataset_name(ds, name);
2693 		dsl_dataset_disown(ds, dsflags, dmu_recv_tag);
2694 		if (!drc->drc_heal)
2695 			(void) dsl_destroy_head(name);
2696 	}
2697 }
2698 
2699 static void
receive_cksum(dmu_recv_cookie_t * drc,int len,void * buf)2700 receive_cksum(dmu_recv_cookie_t *drc, int len, void *buf)
2701 {
2702 	if (drc->drc_byteswap) {
2703 		(void) fletcher_4_incremental_byteswap(buf, len,
2704 		    &drc->drc_cksum);
2705 	} else {
2706 		(void) fletcher_4_incremental_native(buf, len, &drc->drc_cksum);
2707 	}
2708 }
2709 
2710 /*
2711  * Read the payload into a buffer of size len, and update the current record's
2712  * payload field.
2713  * Allocate drc->drc_next_rrd and read the next record's header into
2714  * drc->drc_next_rrd->header.
2715  * Verify checksum of payload and next record.
2716  */
2717 static int
receive_read_payload_and_next_header(dmu_recv_cookie_t * drc,int len,void * buf)2718 receive_read_payload_and_next_header(dmu_recv_cookie_t *drc, int len, void *buf)
2719 {
2720 	int err;
2721 
2722 	if (len != 0) {
2723 		ASSERT3U(len, <=, SPA_MAXBLOCKSIZE);
2724 		err = receive_read(drc, len, buf);
2725 		if (err != 0)
2726 			return (err);
2727 		receive_cksum(drc, len, buf);
2728 
2729 		/* note: rrd is NULL when reading the begin record's payload */
2730 		if (drc->drc_rrd != NULL) {
2731 			drc->drc_rrd->payload = buf;
2732 			drc->drc_rrd->payload_size = len;
2733 			drc->drc_rrd->bytes_read = drc->drc_bytes_read;
2734 		}
2735 	} else {
2736 		ASSERT3P(buf, ==, NULL);
2737 	}
2738 
2739 	drc->drc_prev_cksum = drc->drc_cksum;
2740 
2741 	drc->drc_next_rrd = kmem_zalloc(sizeof (*drc->drc_next_rrd), KM_SLEEP);
2742 	err = receive_read(drc, sizeof (drc->drc_next_rrd->header),
2743 	    &drc->drc_next_rrd->header);
2744 	drc->drc_next_rrd->bytes_read = drc->drc_bytes_read;
2745 
2746 	if (err != 0) {
2747 		kmem_free(drc->drc_next_rrd, sizeof (*drc->drc_next_rrd));
2748 		drc->drc_next_rrd = NULL;
2749 		return (err);
2750 	}
2751 	if (drc->drc_next_rrd->header.drr_type == DRR_BEGIN) {
2752 		kmem_free(drc->drc_next_rrd, sizeof (*drc->drc_next_rrd));
2753 		drc->drc_next_rrd = NULL;
2754 		return (SET_ERROR(EINVAL));
2755 	}
2756 
2757 	/*
2758 	 * Note: checksum is of everything up to but not including the
2759 	 * checksum itself.
2760 	 */
2761 	ASSERT3U(offsetof(dmu_replay_record_t, drr_u.drr_checksum.drr_checksum),
2762 	    ==, sizeof (dmu_replay_record_t) - sizeof (zio_cksum_t));
2763 	receive_cksum(drc,
2764 	    offsetof(dmu_replay_record_t, drr_u.drr_checksum.drr_checksum),
2765 	    &drc->drc_next_rrd->header);
2766 
2767 	zio_cksum_t cksum_orig =
2768 	    drc->drc_next_rrd->header.drr_u.drr_checksum.drr_checksum;
2769 	zio_cksum_t *cksump =
2770 	    &drc->drc_next_rrd->header.drr_u.drr_checksum.drr_checksum;
2771 
2772 	if (drc->drc_byteswap)
2773 		byteswap_record(&drc->drc_next_rrd->header);
2774 
2775 	if ((!ZIO_CHECKSUM_IS_ZERO(cksump)) &&
2776 	    !ZIO_CHECKSUM_EQUAL(drc->drc_cksum, *cksump)) {
2777 		kmem_free(drc->drc_next_rrd, sizeof (*drc->drc_next_rrd));
2778 		drc->drc_next_rrd = NULL;
2779 		return (SET_ERROR(ECKSUM));
2780 	}
2781 
2782 	receive_cksum(drc, sizeof (cksum_orig), &cksum_orig);
2783 
2784 	return (0);
2785 }
2786 
2787 /*
2788  * Issue the prefetch reads for any necessary indirect blocks.
2789  *
2790  * We use the object ignore list to tell us whether or not to issue prefetches
2791  * for a given object.  We do this for both correctness (in case the blocksize
2792  * of an object has changed) and performance (if the object doesn't exist, don't
2793  * needlessly try to issue prefetches).  We also trim the list as we go through
2794  * the stream to prevent it from growing to an unbounded size.
2795  *
2796  * The object numbers within will always be in sorted order, and any write
2797  * records we see will also be in sorted order, but they're not sorted with
2798  * respect to each other (i.e. we can get several object records before
2799  * receiving each object's write records).  As a result, once we've reached a
2800  * given object number, we can safely remove any reference to lower object
2801  * numbers in the ignore list. In practice, we receive up to 32 object records
2802  * before receiving write records, so the list can have up to 32 nodes in it.
2803  */
2804 static void
receive_read_prefetch(dmu_recv_cookie_t * drc,uint64_t object,uint64_t offset,uint64_t length)2805 receive_read_prefetch(dmu_recv_cookie_t *drc, uint64_t object, uint64_t offset,
2806     uint64_t length)
2807 {
2808 	if (!objlist_exists(drc->drc_ignore_objlist, object)) {
2809 		dmu_prefetch(drc->drc_os, object, 1, offset, length,
2810 		    ZIO_PRIORITY_SYNC_READ);
2811 	}
2812 }
2813 
2814 /*
2815  * Read records off the stream, issuing any necessary prefetches.
2816  */
2817 static int
receive_read_record(dmu_recv_cookie_t * drc)2818 receive_read_record(dmu_recv_cookie_t *drc)
2819 {
2820 	int err;
2821 
2822 	switch (drc->drc_rrd->header.drr_type) {
2823 	case DRR_OBJECT:
2824 	{
2825 		struct drr_object *drro =
2826 		    &drc->drc_rrd->header.drr_u.drr_object;
2827 		uint32_t size = DRR_OBJECT_PAYLOAD_SIZE(drro);
2828 		void *buf = NULL;
2829 		dmu_object_info_t doi;
2830 
2831 		if (size != 0)
2832 			buf = kmem_zalloc(size, KM_SLEEP);
2833 
2834 		err = receive_read_payload_and_next_header(drc, size, buf);
2835 		if (err != 0) {
2836 			kmem_free(buf, size);
2837 			return (err);
2838 		}
2839 		err = dmu_object_info(drc->drc_os, drro->drr_object, &doi);
2840 		/*
2841 		 * See receive_read_prefetch for an explanation why we're
2842 		 * storing this object in the ignore_obj_list.
2843 		 */
2844 		if (err == ENOENT || err == EEXIST ||
2845 		    (err == 0 && doi.doi_data_block_size != drro->drr_blksz)) {
2846 			objlist_insert(drc->drc_ignore_objlist,
2847 			    drro->drr_object);
2848 			err = 0;
2849 		}
2850 		return (err);
2851 	}
2852 	case DRR_FREEOBJECTS:
2853 	{
2854 		err = receive_read_payload_and_next_header(drc, 0, NULL);
2855 		return (err);
2856 	}
2857 	case DRR_WRITE:
2858 	{
2859 		struct drr_write *drrw = &drc->drc_rrd->header.drr_u.drr_write;
2860 		int size = DRR_WRITE_PAYLOAD_SIZE(drrw);
2861 		abd_t *abd = abd_alloc_linear(size, B_FALSE);
2862 		err = receive_read_payload_and_next_header(drc, size,
2863 		    abd_to_buf(abd));
2864 		if (err != 0) {
2865 			abd_free(abd);
2866 			return (err);
2867 		}
2868 		drc->drc_rrd->abd = abd;
2869 		receive_read_prefetch(drc, drrw->drr_object, drrw->drr_offset,
2870 		    drrw->drr_logical_size);
2871 		return (err);
2872 	}
2873 	case DRR_WRITE_EMBEDDED:
2874 	{
2875 		struct drr_write_embedded *drrwe =
2876 		    &drc->drc_rrd->header.drr_u.drr_write_embedded;
2877 		uint32_t size = P2ROUNDUP(drrwe->drr_psize, 8);
2878 		void *buf = kmem_zalloc(size, KM_SLEEP);
2879 
2880 		err = receive_read_payload_and_next_header(drc, size, buf);
2881 		if (err != 0) {
2882 			kmem_free(buf, size);
2883 			return (err);
2884 		}
2885 
2886 		receive_read_prefetch(drc, drrwe->drr_object, drrwe->drr_offset,
2887 		    drrwe->drr_length);
2888 		return (err);
2889 	}
2890 	case DRR_FREE:
2891 	case DRR_REDACT:
2892 	{
2893 		/*
2894 		 * It might be beneficial to prefetch indirect blocks here, but
2895 		 * we don't really have the data to decide for sure.
2896 		 */
2897 		err = receive_read_payload_and_next_header(drc, 0, NULL);
2898 		return (err);
2899 	}
2900 	case DRR_END:
2901 	{
2902 		struct drr_end *drre = &drc->drc_rrd->header.drr_u.drr_end;
2903 		if (!ZIO_CHECKSUM_EQUAL(drc->drc_prev_cksum,
2904 		    drre->drr_checksum))
2905 			return (SET_ERROR(ECKSUM));
2906 		return (0);
2907 	}
2908 	case DRR_SPILL:
2909 	{
2910 		struct drr_spill *drrs = &drc->drc_rrd->header.drr_u.drr_spill;
2911 		int size = DRR_SPILL_PAYLOAD_SIZE(drrs);
2912 		abd_t *abd = abd_alloc_linear(size, B_FALSE);
2913 		err = receive_read_payload_and_next_header(drc, size,
2914 		    abd_to_buf(abd));
2915 		if (err != 0)
2916 			abd_free(abd);
2917 		else
2918 			drc->drc_rrd->abd = abd;
2919 		return (err);
2920 	}
2921 	case DRR_OBJECT_RANGE:
2922 	{
2923 		err = receive_read_payload_and_next_header(drc, 0, NULL);
2924 		return (err);
2925 
2926 	}
2927 	default:
2928 		return (SET_ERROR(EINVAL));
2929 	}
2930 }
2931 
2932 
2933 
2934 static void
dprintf_drr(struct receive_record_arg * rrd,int err)2935 dprintf_drr(struct receive_record_arg *rrd, int err)
2936 {
2937 #ifdef ZFS_DEBUG
2938 	switch (rrd->header.drr_type) {
2939 	case DRR_OBJECT:
2940 	{
2941 		struct drr_object *drro = &rrd->header.drr_u.drr_object;
2942 		dprintf("drr_type = OBJECT obj = %llu type = %u "
2943 		    "bonustype = %u blksz = %u bonuslen = %u cksumtype = %u "
2944 		    "compress = %u dn_slots = %u err = %d\n",
2945 		    (u_longlong_t)drro->drr_object, drro->drr_type,
2946 		    drro->drr_bonustype, drro->drr_blksz, drro->drr_bonuslen,
2947 		    drro->drr_checksumtype, drro->drr_compress,
2948 		    drro->drr_dn_slots, err);
2949 		break;
2950 	}
2951 	case DRR_FREEOBJECTS:
2952 	{
2953 		struct drr_freeobjects *drrfo =
2954 		    &rrd->header.drr_u.drr_freeobjects;
2955 		dprintf("drr_type = FREEOBJECTS firstobj = %llu "
2956 		    "numobjs = %llu err = %d\n",
2957 		    (u_longlong_t)drrfo->drr_firstobj,
2958 		    (u_longlong_t)drrfo->drr_numobjs, err);
2959 		break;
2960 	}
2961 	case DRR_WRITE:
2962 	{
2963 		struct drr_write *drrw = &rrd->header.drr_u.drr_write;
2964 		dprintf("drr_type = WRITE obj = %llu type = %u offset = %llu "
2965 		    "lsize = %llu cksumtype = %u flags = %u "
2966 		    "compress = %u psize = %llu err = %d\n",
2967 		    (u_longlong_t)drrw->drr_object, drrw->drr_type,
2968 		    (u_longlong_t)drrw->drr_offset,
2969 		    (u_longlong_t)drrw->drr_logical_size,
2970 		    drrw->drr_checksumtype, drrw->drr_flags,
2971 		    drrw->drr_compressiontype,
2972 		    (u_longlong_t)drrw->drr_compressed_size, err);
2973 		break;
2974 	}
2975 	case DRR_WRITE_BYREF:
2976 	{
2977 		struct drr_write_byref *drrwbr =
2978 		    &rrd->header.drr_u.drr_write_byref;
2979 		dprintf("drr_type = WRITE_BYREF obj = %llu offset = %llu "
2980 		    "length = %llu toguid = %llx refguid = %llx "
2981 		    "refobject = %llu refoffset = %llu cksumtype = %u "
2982 		    "flags = %u err = %d\n",
2983 		    (u_longlong_t)drrwbr->drr_object,
2984 		    (u_longlong_t)drrwbr->drr_offset,
2985 		    (u_longlong_t)drrwbr->drr_length,
2986 		    (u_longlong_t)drrwbr->drr_toguid,
2987 		    (u_longlong_t)drrwbr->drr_refguid,
2988 		    (u_longlong_t)drrwbr->drr_refobject,
2989 		    (u_longlong_t)drrwbr->drr_refoffset,
2990 		    drrwbr->drr_checksumtype, drrwbr->drr_flags, err);
2991 		break;
2992 	}
2993 	case DRR_WRITE_EMBEDDED:
2994 	{
2995 		struct drr_write_embedded *drrwe =
2996 		    &rrd->header.drr_u.drr_write_embedded;
2997 		dprintf("drr_type = WRITE_EMBEDDED obj = %llu offset = %llu "
2998 		    "length = %llu compress = %u etype = %u lsize = %u "
2999 		    "psize = %u err = %d\n",
3000 		    (u_longlong_t)drrwe->drr_object,
3001 		    (u_longlong_t)drrwe->drr_offset,
3002 		    (u_longlong_t)drrwe->drr_length,
3003 		    drrwe->drr_compression, drrwe->drr_etype,
3004 		    drrwe->drr_lsize, drrwe->drr_psize, err);
3005 		break;
3006 	}
3007 	case DRR_FREE:
3008 	{
3009 		struct drr_free *drrf = &rrd->header.drr_u.drr_free;
3010 		dprintf("drr_type = FREE obj = %llu offset = %llu "
3011 		    "length = %lld err = %d\n",
3012 		    (u_longlong_t)drrf->drr_object,
3013 		    (u_longlong_t)drrf->drr_offset,
3014 		    (longlong_t)drrf->drr_length,
3015 		    err);
3016 		break;
3017 	}
3018 	case DRR_SPILL:
3019 	{
3020 		struct drr_spill *drrs = &rrd->header.drr_u.drr_spill;
3021 		dprintf("drr_type = SPILL obj = %llu length = %llu "
3022 		    "err = %d\n", (u_longlong_t)drrs->drr_object,
3023 		    (u_longlong_t)drrs->drr_length, err);
3024 		break;
3025 	}
3026 	case DRR_OBJECT_RANGE:
3027 	{
3028 		struct drr_object_range *drror =
3029 		    &rrd->header.drr_u.drr_object_range;
3030 		dprintf("drr_type = OBJECT_RANGE firstobj = %llu "
3031 		    "numslots = %llu flags = %u err = %d\n",
3032 		    (u_longlong_t)drror->drr_firstobj,
3033 		    (u_longlong_t)drror->drr_numslots,
3034 		    drror->drr_flags, err);
3035 		break;
3036 	}
3037 	default:
3038 		return;
3039 	}
3040 #endif
3041 }
3042 
3043 /*
3044  * Commit the records to the pool.
3045  */
3046 static int
receive_process_record(struct receive_writer_arg * rwa,struct receive_record_arg * rrd)3047 receive_process_record(struct receive_writer_arg *rwa,
3048     struct receive_record_arg *rrd)
3049 {
3050 	int err;
3051 
3052 	/* Processing in order, therefore bytes_read should be increasing. */
3053 	ASSERT3U(rrd->bytes_read, >=, rwa->bytes_read);
3054 	rwa->bytes_read = rrd->bytes_read;
3055 
3056 	/* We can only heal write records; other ones get ignored */
3057 	if (rwa->heal && rrd->header.drr_type != DRR_WRITE) {
3058 		if (rrd->abd != NULL) {
3059 			abd_free(rrd->abd);
3060 			rrd->abd = NULL;
3061 		} else if (rrd->payload != NULL) {
3062 			kmem_free(rrd->payload, rrd->payload_size);
3063 			rrd->payload = NULL;
3064 		}
3065 		return (0);
3066 	}
3067 
3068 	if (!rwa->heal && rrd->header.drr_type != DRR_WRITE) {
3069 		err = flush_write_batch(rwa);
3070 		if (err != 0) {
3071 			if (rrd->abd != NULL) {
3072 				abd_free(rrd->abd);
3073 				rrd->abd = NULL;
3074 				rrd->payload = NULL;
3075 			} else if (rrd->payload != NULL) {
3076 				kmem_free(rrd->payload, rrd->payload_size);
3077 				rrd->payload = NULL;
3078 			}
3079 
3080 			return (err);
3081 		}
3082 	}
3083 
3084 	switch (rrd->header.drr_type) {
3085 	case DRR_OBJECT:
3086 	{
3087 		struct drr_object *drro = &rrd->header.drr_u.drr_object;
3088 		err = receive_object(rwa, drro, rrd->payload);
3089 		kmem_free(rrd->payload, rrd->payload_size);
3090 		rrd->payload = NULL;
3091 		break;
3092 	}
3093 	case DRR_FREEOBJECTS:
3094 	{
3095 		struct drr_freeobjects *drrfo =
3096 		    &rrd->header.drr_u.drr_freeobjects;
3097 		err = receive_freeobjects(rwa, drrfo);
3098 		break;
3099 	}
3100 	case DRR_WRITE:
3101 	{
3102 		err = receive_process_write_record(rwa, rrd);
3103 		if (rwa->heal) {
3104 			/*
3105 			 * If healing - always free the abd after processing
3106 			 */
3107 			abd_free(rrd->abd);
3108 			rrd->abd = NULL;
3109 		} else if (err != EAGAIN) {
3110 			/*
3111 			 * On success, a non-healing
3112 			 * receive_process_write_record() returns
3113 			 * EAGAIN to indicate that we do not want to free
3114 			 * the rrd or arc_buf.
3115 			 */
3116 			ASSERT(err != 0);
3117 			abd_free(rrd->abd);
3118 			rrd->abd = NULL;
3119 		}
3120 		break;
3121 	}
3122 	case DRR_WRITE_EMBEDDED:
3123 	{
3124 		struct drr_write_embedded *drrwe =
3125 		    &rrd->header.drr_u.drr_write_embedded;
3126 		err = receive_write_embedded(rwa, drrwe, rrd->payload);
3127 		kmem_free(rrd->payload, rrd->payload_size);
3128 		rrd->payload = NULL;
3129 		break;
3130 	}
3131 	case DRR_FREE:
3132 	{
3133 		struct drr_free *drrf = &rrd->header.drr_u.drr_free;
3134 		err = receive_free(rwa, drrf);
3135 		break;
3136 	}
3137 	case DRR_SPILL:
3138 	{
3139 		struct drr_spill *drrs = &rrd->header.drr_u.drr_spill;
3140 		err = receive_spill(rwa, drrs, rrd->abd);
3141 		if (err != 0)
3142 			abd_free(rrd->abd);
3143 		rrd->abd = NULL;
3144 		rrd->payload = NULL;
3145 		break;
3146 	}
3147 	case DRR_OBJECT_RANGE:
3148 	{
3149 		struct drr_object_range *drror =
3150 		    &rrd->header.drr_u.drr_object_range;
3151 		err = receive_object_range(rwa, drror);
3152 		break;
3153 	}
3154 	case DRR_REDACT:
3155 	{
3156 		struct drr_redact *drrr = &rrd->header.drr_u.drr_redact;
3157 		err = receive_redact(rwa, drrr);
3158 		break;
3159 	}
3160 	default:
3161 		err = (SET_ERROR(EINVAL));
3162 	}
3163 
3164 	if (err != 0)
3165 		dprintf_drr(rrd, err);
3166 
3167 	return (err);
3168 }
3169 
3170 /*
3171  * dmu_recv_stream's worker thread; pull records off the queue, and then call
3172  * receive_process_record  When we're done, signal the main thread and exit.
3173  */
3174 static __attribute__((noreturn)) void
receive_writer_thread(void * arg)3175 receive_writer_thread(void *arg)
3176 {
3177 	struct receive_writer_arg *rwa = arg;
3178 	struct receive_record_arg *rrd;
3179 	fstrans_cookie_t cookie = spl_fstrans_mark();
3180 
3181 	for (rrd = bqueue_dequeue(&rwa->q); !rrd->eos_marker;
3182 	    rrd = bqueue_dequeue(&rwa->q)) {
3183 		/*
3184 		 * If there's an error, the main thread will stop putting things
3185 		 * on the queue, but we need to clear everything in it before we
3186 		 * can exit.
3187 		 */
3188 		int err = 0;
3189 		if (rwa->err == 0) {
3190 			err = receive_process_record(rwa, rrd);
3191 		} else if (rrd->abd != NULL) {
3192 			abd_free(rrd->abd);
3193 			rrd->abd = NULL;
3194 			rrd->payload = NULL;
3195 		} else if (rrd->payload != NULL) {
3196 			kmem_free(rrd->payload, rrd->payload_size);
3197 			rrd->payload = NULL;
3198 		}
3199 		/*
3200 		 * EAGAIN indicates that this record has been saved (on
3201 		 * raw->write_batch), and will be used again, so we don't
3202 		 * free it.
3203 		 * When healing data we always need to free the record.
3204 		 */
3205 		if (err != EAGAIN || rwa->heal) {
3206 			if (rwa->err == 0)
3207 				rwa->err = err;
3208 			kmem_free(rrd, sizeof (*rrd));
3209 		}
3210 	}
3211 	kmem_free(rrd, sizeof (*rrd));
3212 
3213 	if (rwa->heal) {
3214 		zio_wait(rwa->heal_pio);
3215 	} else {
3216 		int err = flush_write_batch(rwa);
3217 		if (rwa->err == 0)
3218 			rwa->err = err;
3219 	}
3220 	mutex_enter(&rwa->mutex);
3221 	rwa->done = B_TRUE;
3222 	cv_signal(&rwa->cv);
3223 	mutex_exit(&rwa->mutex);
3224 	spl_fstrans_unmark(cookie);
3225 	thread_exit();
3226 }
3227 
3228 static int
resume_check(dmu_recv_cookie_t * drc,nvlist_t * begin_nvl)3229 resume_check(dmu_recv_cookie_t *drc, nvlist_t *begin_nvl)
3230 {
3231 	uint64_t val;
3232 	objset_t *mos = dmu_objset_pool(drc->drc_os)->dp_meta_objset;
3233 	uint64_t dsobj = dmu_objset_id(drc->drc_os);
3234 	uint64_t resume_obj, resume_off;
3235 
3236 	if (nvlist_lookup_uint64(begin_nvl,
3237 	    "resume_object", &resume_obj) != 0 ||
3238 	    nvlist_lookup_uint64(begin_nvl,
3239 	    "resume_offset", &resume_off) != 0) {
3240 		return (SET_ERROR(EINVAL));
3241 	}
3242 	VERIFY0(zap_lookup(mos, dsobj,
3243 	    DS_FIELD_RESUME_OBJECT, sizeof (val), 1, &val));
3244 	if (resume_obj != val)
3245 		return (SET_ERROR(EINVAL));
3246 	VERIFY0(zap_lookup(mos, dsobj,
3247 	    DS_FIELD_RESUME_OFFSET, sizeof (val), 1, &val));
3248 	if (resume_off != val)
3249 		return (SET_ERROR(EINVAL));
3250 
3251 	return (0);
3252 }
3253 
3254 /*
3255  * Read in the stream's records, one by one, and apply them to the pool.  There
3256  * are two threads involved; the thread that calls this function will spin up a
3257  * worker thread, read the records off the stream one by one, and issue
3258  * prefetches for any necessary indirect blocks.  It will then push the records
3259  * onto an internal blocking queue.  The worker thread will pull the records off
3260  * the queue, and actually write the data into the DMU.  This way, the worker
3261  * thread doesn't have to wait for reads to complete, since everything it needs
3262  * (the indirect blocks) will be prefetched.
3263  *
3264  * NB: callers *must* call dmu_recv_end() if this succeeds.
3265  */
3266 int
dmu_recv_stream(dmu_recv_cookie_t * drc,offset_t * voffp)3267 dmu_recv_stream(dmu_recv_cookie_t *drc, offset_t *voffp)
3268 {
3269 	int err = 0;
3270 	struct receive_writer_arg *rwa = kmem_zalloc(sizeof (*rwa), KM_SLEEP);
3271 
3272 	if (dsl_dataset_has_resume_receive_state(drc->drc_ds)) {
3273 		uint64_t bytes = 0;
3274 		(void) zap_lookup(drc->drc_ds->ds_dir->dd_pool->dp_meta_objset,
3275 		    drc->drc_ds->ds_object, DS_FIELD_RESUME_BYTES,
3276 		    sizeof (bytes), 1, &bytes);
3277 		drc->drc_bytes_read += bytes;
3278 	}
3279 
3280 	drc->drc_ignore_objlist = objlist_create();
3281 
3282 	/* these were verified in dmu_recv_begin */
3283 	ASSERT3U(DMU_GET_STREAM_HDRTYPE(drc->drc_drrb->drr_versioninfo), ==,
3284 	    DMU_SUBSTREAM);
3285 	ASSERT3U(drc->drc_drrb->drr_type, <, DMU_OST_NUMTYPES);
3286 
3287 	ASSERT(dsl_dataset_phys(drc->drc_ds)->ds_flags & DS_FLAG_INCONSISTENT);
3288 	ASSERT0(drc->drc_os->os_encrypted &&
3289 	    (drc->drc_featureflags & DMU_BACKUP_FEATURE_EMBED_DATA));
3290 
3291 	/* handle DSL encryption key payload */
3292 	if (drc->drc_featureflags & DMU_BACKUP_FEATURE_RAW) {
3293 		nvlist_t *keynvl = NULL;
3294 
3295 		ASSERT(drc->drc_os->os_encrypted);
3296 		ASSERT(drc->drc_raw);
3297 
3298 		err = nvlist_lookup_nvlist(drc->drc_begin_nvl, "crypt_keydata",
3299 		    &keynvl);
3300 		if (err != 0)
3301 			goto out;
3302 
3303 		if (!drc->drc_heal) {
3304 			/*
3305 			 * If this is a new dataset we set the key immediately.
3306 			 * Otherwise we don't want to change the key until we
3307 			 * are sure the rest of the receive succeeded so we
3308 			 * stash the keynvl away until then.
3309 			 */
3310 			err = dsl_crypto_recv_raw(spa_name(drc->drc_os->os_spa),
3311 			    drc->drc_ds->ds_object, drc->drc_fromsnapobj,
3312 			    drc->drc_drrb->drr_type, keynvl, drc->drc_newfs);
3313 			if (err != 0)
3314 				goto out;
3315 		}
3316 
3317 		/* see comment in dmu_recv_end_sync() */
3318 		drc->drc_ivset_guid = 0;
3319 		(void) nvlist_lookup_uint64(keynvl, "to_ivset_guid",
3320 		    &drc->drc_ivset_guid);
3321 
3322 		if (!drc->drc_newfs)
3323 			drc->drc_keynvl = fnvlist_dup(keynvl);
3324 	}
3325 
3326 	if (drc->drc_featureflags & DMU_BACKUP_FEATURE_RESUMING) {
3327 		err = resume_check(drc, drc->drc_begin_nvl);
3328 		if (err != 0)
3329 			goto out;
3330 	}
3331 
3332 	/*
3333 	 * For compatibility with recursive send streams, we do this here,
3334 	 * rather than in dmu_recv_begin. If we pull the next header too
3335 	 * early, and it's the END record, we break the `recv_skip` logic.
3336 	 */
3337 	if (drc->drc_drr_begin->drr_payloadlen == 0) {
3338 		err = receive_read_payload_and_next_header(drc, 0, NULL);
3339 		if (err != 0)
3340 			goto out;
3341 	}
3342 
3343 	/*
3344 	 * If we failed before this point we will clean up any new resume
3345 	 * state that was created. Now that we've gotten past the initial
3346 	 * checks we are ok to retain that resume state.
3347 	 */
3348 	drc->drc_should_save = B_TRUE;
3349 
3350 	(void) bqueue_init(&rwa->q, zfs_recv_queue_ff,
3351 	    MAX(zfs_recv_queue_length, 2 * zfs_max_recordsize),
3352 	    offsetof(struct receive_record_arg, node));
3353 	cv_init(&rwa->cv, NULL, CV_DEFAULT, NULL);
3354 	mutex_init(&rwa->mutex, NULL, MUTEX_DEFAULT, NULL);
3355 	rwa->os = drc->drc_os;
3356 	rwa->byteswap = drc->drc_byteswap;
3357 	rwa->heal = drc->drc_heal;
3358 	rwa->tofs = drc->drc_tofs;
3359 	rwa->resumable = drc->drc_resumable;
3360 	rwa->raw = drc->drc_raw;
3361 	rwa->spill = drc->drc_spill;
3362 	rwa->full = (drc->drc_drr_begin->drr_u.drr_begin.drr_fromguid == 0);
3363 	rwa->os->os_raw_receive = drc->drc_raw;
3364 	if (drc->drc_heal) {
3365 		rwa->heal_pio = zio_root(drc->drc_os->os_spa, NULL, NULL,
3366 		    ZIO_FLAG_GODFATHER);
3367 	}
3368 	list_create(&rwa->write_batch, sizeof (struct receive_record_arg),
3369 	    offsetof(struct receive_record_arg, node.bqn_node));
3370 
3371 	(void) thread_create(NULL, 0, receive_writer_thread, rwa, 0, curproc,
3372 	    TS_RUN, minclsyspri);
3373 	/*
3374 	 * We're reading rwa->err without locks, which is safe since we are the
3375 	 * only reader, and the worker thread is the only writer.  It's ok if we
3376 	 * miss a write for an iteration or two of the loop, since the writer
3377 	 * thread will keep freeing records we send it until we send it an eos
3378 	 * marker.
3379 	 *
3380 	 * We can leave this loop in 3 ways:  First, if rwa->err is
3381 	 * non-zero.  In that case, the writer thread will free the rrd we just
3382 	 * pushed.  Second, if  we're interrupted; in that case, either it's the
3383 	 * first loop and drc->drc_rrd was never allocated, or it's later, and
3384 	 * drc->drc_rrd has been handed off to the writer thread who will free
3385 	 * it.  Finally, if receive_read_record fails or we're at the end of the
3386 	 * stream, then we free drc->drc_rrd and exit.
3387 	 */
3388 	while (rwa->err == 0) {
3389 		if (issig(JUSTLOOKING) && issig(FORREAL)) {
3390 			err = SET_ERROR(EINTR);
3391 			break;
3392 		}
3393 
3394 		ASSERT3P(drc->drc_rrd, ==, NULL);
3395 		drc->drc_rrd = drc->drc_next_rrd;
3396 		drc->drc_next_rrd = NULL;
3397 		/* Allocates and loads header into drc->drc_next_rrd */
3398 		err = receive_read_record(drc);
3399 
3400 		if (drc->drc_rrd->header.drr_type == DRR_END || err != 0) {
3401 			kmem_free(drc->drc_rrd, sizeof (*drc->drc_rrd));
3402 			drc->drc_rrd = NULL;
3403 			break;
3404 		}
3405 
3406 		bqueue_enqueue(&rwa->q, drc->drc_rrd,
3407 		    sizeof (struct receive_record_arg) +
3408 		    drc->drc_rrd->payload_size);
3409 		drc->drc_rrd = NULL;
3410 	}
3411 
3412 	ASSERT3P(drc->drc_rrd, ==, NULL);
3413 	drc->drc_rrd = kmem_zalloc(sizeof (*drc->drc_rrd), KM_SLEEP);
3414 	drc->drc_rrd->eos_marker = B_TRUE;
3415 	bqueue_enqueue_flush(&rwa->q, drc->drc_rrd, 1);
3416 
3417 	mutex_enter(&rwa->mutex);
3418 	while (!rwa->done) {
3419 		/*
3420 		 * We need to use cv_wait_sig() so that any process that may
3421 		 * be sleeping here can still fork.
3422 		 */
3423 		(void) cv_wait_sig(&rwa->cv, &rwa->mutex);
3424 	}
3425 	mutex_exit(&rwa->mutex);
3426 
3427 	/*
3428 	 * If we are receiving a full stream as a clone, all object IDs which
3429 	 * are greater than the maximum ID referenced in the stream are
3430 	 * by definition unused and must be freed.
3431 	 */
3432 	if (drc->drc_clone && drc->drc_drrb->drr_fromguid == 0) {
3433 		uint64_t obj = rwa->max_object + 1;
3434 		int free_err = 0;
3435 		int next_err = 0;
3436 
3437 		while (next_err == 0) {
3438 			free_err = dmu_free_long_object(rwa->os, obj);
3439 			if (free_err != 0 && free_err != ENOENT)
3440 				break;
3441 
3442 			next_err = dmu_object_next(rwa->os, &obj, FALSE, 0);
3443 		}
3444 
3445 		if (err == 0) {
3446 			if (free_err != 0 && free_err != ENOENT)
3447 				err = free_err;
3448 			else if (next_err != ESRCH)
3449 				err = next_err;
3450 		}
3451 	}
3452 
3453 	cv_destroy(&rwa->cv);
3454 	mutex_destroy(&rwa->mutex);
3455 	bqueue_destroy(&rwa->q);
3456 	list_destroy(&rwa->write_batch);
3457 	if (err == 0)
3458 		err = rwa->err;
3459 
3460 out:
3461 	/*
3462 	 * If we hit an error before we started the receive_writer_thread
3463 	 * we need to clean up the next_rrd we create by processing the
3464 	 * DRR_BEGIN record.
3465 	 */
3466 	if (drc->drc_next_rrd != NULL)
3467 		kmem_free(drc->drc_next_rrd, sizeof (*drc->drc_next_rrd));
3468 
3469 	/*
3470 	 * The objset will be invalidated by dmu_recv_end() when we do
3471 	 * dsl_dataset_clone_swap_sync_impl().
3472 	 */
3473 	drc->drc_os = NULL;
3474 
3475 	kmem_free(rwa, sizeof (*rwa));
3476 	nvlist_free(drc->drc_begin_nvl);
3477 
3478 	if (err != 0) {
3479 		/*
3480 		 * Clean up references. If receive is not resumable,
3481 		 * destroy what we created, so we don't leave it in
3482 		 * the inconsistent state.
3483 		 */
3484 		dmu_recv_cleanup_ds(drc);
3485 		nvlist_free(drc->drc_keynvl);
3486 	}
3487 
3488 	objlist_destroy(drc->drc_ignore_objlist);
3489 	drc->drc_ignore_objlist = NULL;
3490 	*voffp = drc->drc_voff;
3491 	return (err);
3492 }
3493 
3494 static int
dmu_recv_end_check(void * arg,dmu_tx_t * tx)3495 dmu_recv_end_check(void *arg, dmu_tx_t *tx)
3496 {
3497 	dmu_recv_cookie_t *drc = arg;
3498 	dsl_pool_t *dp = dmu_tx_pool(tx);
3499 	int error;
3500 
3501 	ASSERT3P(drc->drc_ds->ds_owner, ==, dmu_recv_tag);
3502 
3503 	if (drc->drc_heal) {
3504 		error = 0;
3505 	} else if (!drc->drc_newfs) {
3506 		dsl_dataset_t *origin_head;
3507 
3508 		error = dsl_dataset_hold(dp, drc->drc_tofs, FTAG, &origin_head);
3509 		if (error != 0)
3510 			return (error);
3511 		if (drc->drc_force) {
3512 			/*
3513 			 * We will destroy any snapshots in tofs (i.e. before
3514 			 * origin_head) that are after the origin (which is
3515 			 * the snap before drc_ds, because drc_ds can not
3516 			 * have any snaps of its own).
3517 			 */
3518 			uint64_t obj;
3519 
3520 			obj = dsl_dataset_phys(origin_head)->ds_prev_snap_obj;
3521 			while (obj !=
3522 			    dsl_dataset_phys(drc->drc_ds)->ds_prev_snap_obj) {
3523 				dsl_dataset_t *snap;
3524 				error = dsl_dataset_hold_obj(dp, obj, FTAG,
3525 				    &snap);
3526 				if (error != 0)
3527 					break;
3528 				if (snap->ds_dir != origin_head->ds_dir)
3529 					error = SET_ERROR(EINVAL);
3530 				if (error == 0)  {
3531 					error = dsl_destroy_snapshot_check_impl(
3532 					    snap, B_FALSE);
3533 				}
3534 				obj = dsl_dataset_phys(snap)->ds_prev_snap_obj;
3535 				dsl_dataset_rele(snap, FTAG);
3536 				if (error != 0)
3537 					break;
3538 			}
3539 			if (error != 0) {
3540 				dsl_dataset_rele(origin_head, FTAG);
3541 				return (error);
3542 			}
3543 		}
3544 		if (drc->drc_keynvl != NULL) {
3545 			error = dsl_crypto_recv_raw_key_check(drc->drc_ds,
3546 			    drc->drc_keynvl, tx);
3547 			if (error != 0) {
3548 				dsl_dataset_rele(origin_head, FTAG);
3549 				return (error);
3550 			}
3551 		}
3552 
3553 		error = dsl_dataset_clone_swap_check_impl(drc->drc_ds,
3554 		    origin_head, drc->drc_force, drc->drc_owner, tx);
3555 		if (error != 0) {
3556 			dsl_dataset_rele(origin_head, FTAG);
3557 			return (error);
3558 		}
3559 		error = dsl_dataset_snapshot_check_impl(origin_head,
3560 		    drc->drc_tosnap, tx, B_TRUE, 1,
3561 		    drc->drc_cred, drc->drc_proc);
3562 		dsl_dataset_rele(origin_head, FTAG);
3563 		if (error != 0)
3564 			return (error);
3565 
3566 		error = dsl_destroy_head_check_impl(drc->drc_ds, 1);
3567 	} else {
3568 		error = dsl_dataset_snapshot_check_impl(drc->drc_ds,
3569 		    drc->drc_tosnap, tx, B_TRUE, 1,
3570 		    drc->drc_cred, drc->drc_proc);
3571 	}
3572 	return (error);
3573 }
3574 
3575 static void
dmu_recv_end_sync(void * arg,dmu_tx_t * tx)3576 dmu_recv_end_sync(void *arg, dmu_tx_t *tx)
3577 {
3578 	dmu_recv_cookie_t *drc = arg;
3579 	dsl_pool_t *dp = dmu_tx_pool(tx);
3580 	boolean_t encrypted = drc->drc_ds->ds_dir->dd_crypto_obj != 0;
3581 	uint64_t newsnapobj = 0;
3582 
3583 	spa_history_log_internal_ds(drc->drc_ds, "finish receiving",
3584 	    tx, "snap=%s", drc->drc_tosnap);
3585 	drc->drc_ds->ds_objset->os_raw_receive = B_FALSE;
3586 
3587 	if (drc->drc_heal) {
3588 		if (drc->drc_keynvl != NULL) {
3589 			nvlist_free(drc->drc_keynvl);
3590 			drc->drc_keynvl = NULL;
3591 		}
3592 	} else if (!drc->drc_newfs) {
3593 		dsl_dataset_t *origin_head;
3594 
3595 		VERIFY0(dsl_dataset_hold(dp, drc->drc_tofs, FTAG,
3596 		    &origin_head));
3597 
3598 		if (drc->drc_force) {
3599 			/*
3600 			 * Destroy any snapshots of drc_tofs (origin_head)
3601 			 * after the origin (the snap before drc_ds).
3602 			 */
3603 			uint64_t obj;
3604 
3605 			obj = dsl_dataset_phys(origin_head)->ds_prev_snap_obj;
3606 			while (obj !=
3607 			    dsl_dataset_phys(drc->drc_ds)->ds_prev_snap_obj) {
3608 				dsl_dataset_t *snap;
3609 				VERIFY0(dsl_dataset_hold_obj(dp, obj, FTAG,
3610 				    &snap));
3611 				ASSERT3P(snap->ds_dir, ==, origin_head->ds_dir);
3612 				obj = dsl_dataset_phys(snap)->ds_prev_snap_obj;
3613 				dsl_destroy_snapshot_sync_impl(snap,
3614 				    B_FALSE, tx);
3615 				dsl_dataset_rele(snap, FTAG);
3616 			}
3617 		}
3618 		if (drc->drc_keynvl != NULL) {
3619 			dsl_crypto_recv_raw_key_sync(drc->drc_ds,
3620 			    drc->drc_keynvl, tx);
3621 			nvlist_free(drc->drc_keynvl);
3622 			drc->drc_keynvl = NULL;
3623 		}
3624 
3625 		VERIFY3P(drc->drc_ds->ds_prev, ==,
3626 		    origin_head->ds_prev);
3627 
3628 		dsl_dataset_clone_swap_sync_impl(drc->drc_ds,
3629 		    origin_head, tx);
3630 		/*
3631 		 * The objset was evicted by dsl_dataset_clone_swap_sync_impl,
3632 		 * so drc_os is no longer valid.
3633 		 */
3634 		drc->drc_os = NULL;
3635 
3636 		dsl_dataset_snapshot_sync_impl(origin_head,
3637 		    drc->drc_tosnap, tx);
3638 
3639 		/* set snapshot's creation time and guid */
3640 		dmu_buf_will_dirty(origin_head->ds_prev->ds_dbuf, tx);
3641 		dsl_dataset_phys(origin_head->ds_prev)->ds_creation_time =
3642 		    drc->drc_drrb->drr_creation_time;
3643 		dsl_dataset_phys(origin_head->ds_prev)->ds_guid =
3644 		    drc->drc_drrb->drr_toguid;
3645 		dsl_dataset_phys(origin_head->ds_prev)->ds_flags &=
3646 		    ~DS_FLAG_INCONSISTENT;
3647 
3648 		dmu_buf_will_dirty(origin_head->ds_dbuf, tx);
3649 		dsl_dataset_phys(origin_head)->ds_flags &=
3650 		    ~DS_FLAG_INCONSISTENT;
3651 
3652 		newsnapobj =
3653 		    dsl_dataset_phys(origin_head)->ds_prev_snap_obj;
3654 
3655 		dsl_dataset_rele(origin_head, FTAG);
3656 		dsl_destroy_head_sync_impl(drc->drc_ds, tx);
3657 
3658 		if (drc->drc_owner != NULL)
3659 			VERIFY3P(origin_head->ds_owner, ==, drc->drc_owner);
3660 	} else {
3661 		dsl_dataset_t *ds = drc->drc_ds;
3662 
3663 		dsl_dataset_snapshot_sync_impl(ds, drc->drc_tosnap, tx);
3664 
3665 		/* set snapshot's creation time and guid */
3666 		dmu_buf_will_dirty(ds->ds_prev->ds_dbuf, tx);
3667 		dsl_dataset_phys(ds->ds_prev)->ds_creation_time =
3668 		    drc->drc_drrb->drr_creation_time;
3669 		dsl_dataset_phys(ds->ds_prev)->ds_guid =
3670 		    drc->drc_drrb->drr_toguid;
3671 		dsl_dataset_phys(ds->ds_prev)->ds_flags &=
3672 		    ~DS_FLAG_INCONSISTENT;
3673 
3674 		dmu_buf_will_dirty(ds->ds_dbuf, tx);
3675 		dsl_dataset_phys(ds)->ds_flags &= ~DS_FLAG_INCONSISTENT;
3676 		if (dsl_dataset_has_resume_receive_state(ds)) {
3677 			(void) zap_remove(dp->dp_meta_objset, ds->ds_object,
3678 			    DS_FIELD_RESUME_FROMGUID, tx);
3679 			(void) zap_remove(dp->dp_meta_objset, ds->ds_object,
3680 			    DS_FIELD_RESUME_OBJECT, tx);
3681 			(void) zap_remove(dp->dp_meta_objset, ds->ds_object,
3682 			    DS_FIELD_RESUME_OFFSET, tx);
3683 			(void) zap_remove(dp->dp_meta_objset, ds->ds_object,
3684 			    DS_FIELD_RESUME_BYTES, tx);
3685 			(void) zap_remove(dp->dp_meta_objset, ds->ds_object,
3686 			    DS_FIELD_RESUME_TOGUID, tx);
3687 			(void) zap_remove(dp->dp_meta_objset, ds->ds_object,
3688 			    DS_FIELD_RESUME_TONAME, tx);
3689 			(void) zap_remove(dp->dp_meta_objset, ds->ds_object,
3690 			    DS_FIELD_RESUME_REDACT_BOOKMARK_SNAPS, tx);
3691 		}
3692 		newsnapobj =
3693 		    dsl_dataset_phys(drc->drc_ds)->ds_prev_snap_obj;
3694 	}
3695 
3696 	/*
3697 	 * If this is a raw receive, the crypt_keydata nvlist will include
3698 	 * a to_ivset_guid for us to set on the new snapshot. This value
3699 	 * will override the value generated by the snapshot code. However,
3700 	 * this value may not be present, because older implementations of
3701 	 * the raw send code did not include this value, and we are still
3702 	 * allowed to receive them if the zfs_disable_ivset_guid_check
3703 	 * tunable is set, in which case we will leave the newly-generated
3704 	 * value.
3705 	 */
3706 	if (!drc->drc_heal && drc->drc_raw && drc->drc_ivset_guid != 0) {
3707 		dmu_object_zapify(dp->dp_meta_objset, newsnapobj,
3708 		    DMU_OT_DSL_DATASET, tx);
3709 		VERIFY0(zap_update(dp->dp_meta_objset, newsnapobj,
3710 		    DS_FIELD_IVSET_GUID, sizeof (uint64_t), 1,
3711 		    &drc->drc_ivset_guid, tx));
3712 	}
3713 
3714 	/*
3715 	 * Release the hold from dmu_recv_begin.  This must be done before
3716 	 * we return to open context, so that when we free the dataset's dnode
3717 	 * we can evict its bonus buffer. Since the dataset may be destroyed
3718 	 * at this point (and therefore won't have a valid pointer to the spa)
3719 	 * we release the key mapping manually here while we do have a valid
3720 	 * pointer, if it exists.
3721 	 */
3722 	if (!drc->drc_raw && encrypted) {
3723 		(void) spa_keystore_remove_mapping(dmu_tx_pool(tx)->dp_spa,
3724 		    drc->drc_ds->ds_object, drc->drc_ds);
3725 	}
3726 	dsl_dataset_disown(drc->drc_ds, 0, dmu_recv_tag);
3727 	drc->drc_ds = NULL;
3728 }
3729 
3730 static int dmu_recv_end_modified_blocks = 3;
3731 
3732 static int
dmu_recv_existing_end(dmu_recv_cookie_t * drc)3733 dmu_recv_existing_end(dmu_recv_cookie_t *drc)
3734 {
3735 #ifdef _KERNEL
3736 	/*
3737 	 * We will be destroying the ds; make sure its origin is unmounted if
3738 	 * necessary.
3739 	 */
3740 	char name[ZFS_MAX_DATASET_NAME_LEN];
3741 	dsl_dataset_name(drc->drc_ds, name);
3742 	zfs_destroy_unmount_origin(name);
3743 #endif
3744 
3745 	return (dsl_sync_task(drc->drc_tofs,
3746 	    dmu_recv_end_check, dmu_recv_end_sync, drc,
3747 	    dmu_recv_end_modified_blocks, ZFS_SPACE_CHECK_NORMAL));
3748 }
3749 
3750 static int
dmu_recv_new_end(dmu_recv_cookie_t * drc)3751 dmu_recv_new_end(dmu_recv_cookie_t *drc)
3752 {
3753 	return (dsl_sync_task(drc->drc_tofs,
3754 	    dmu_recv_end_check, dmu_recv_end_sync, drc,
3755 	    dmu_recv_end_modified_blocks, ZFS_SPACE_CHECK_NORMAL));
3756 }
3757 
3758 int
dmu_recv_end(dmu_recv_cookie_t * drc,void * owner)3759 dmu_recv_end(dmu_recv_cookie_t *drc, void *owner)
3760 {
3761 	int error;
3762 
3763 	drc->drc_owner = owner;
3764 
3765 	if (drc->drc_newfs)
3766 		error = dmu_recv_new_end(drc);
3767 	else
3768 		error = dmu_recv_existing_end(drc);
3769 
3770 	if (error != 0) {
3771 		dmu_recv_cleanup_ds(drc);
3772 		nvlist_free(drc->drc_keynvl);
3773 	} else if (!drc->drc_heal) {
3774 		if (drc->drc_newfs) {
3775 			zvol_create_minor(drc->drc_tofs);
3776 		}
3777 		char *snapname = kmem_asprintf("%s@%s",
3778 		    drc->drc_tofs, drc->drc_tosnap);
3779 		zvol_create_minor(snapname);
3780 		kmem_strfree(snapname);
3781 	}
3782 	return (error);
3783 }
3784 
3785 /*
3786  * Return TRUE if this objset is currently being received into.
3787  */
3788 boolean_t
dmu_objset_is_receiving(objset_t * os)3789 dmu_objset_is_receiving(objset_t *os)
3790 {
3791 	return (os->os_dsl_dataset != NULL &&
3792 	    os->os_dsl_dataset->ds_owner == dmu_recv_tag);
3793 }
3794 
3795 ZFS_MODULE_PARAM(zfs_recv, zfs_recv_, queue_length, UINT, ZMOD_RW,
3796 	"Maximum receive queue length");
3797 
3798 ZFS_MODULE_PARAM(zfs_recv, zfs_recv_, queue_ff, UINT, ZMOD_RW,
3799 	"Receive queue fill fraction");
3800 
3801 ZFS_MODULE_PARAM(zfs_recv, zfs_recv_, write_batch_size, UINT, ZMOD_RW,
3802 	"Maximum amount of writes to batch into one transaction");
3803 
3804 ZFS_MODULE_PARAM(zfs_recv, zfs_recv_, best_effort_corrective, INT, ZMOD_RW,
3805 	"Ignore errors during corrective receive");
3806 /* END CSTYLED */
3807