]> git.proxmox.com Git - mirror_zfs.git/blame - module/zfs/dmu_send.c
Add realloc() success check in zpool_history_unpack()
[mirror_zfs.git] / module / zfs / dmu_send.c
CommitLineData
34dc7c2f
BB
1/*
2 * CDDL HEADER START
3 *
4 * The contents of this file are subject to the terms of the
5 * Common Development and Distribution License (the "License").
6 * You may not use this file except in compliance with the License.
7 *
8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 * or http://www.opensolaris.org/os/licensing.
10 * See the License for the specific language governing permissions
11 * and limitations under the License.
12 *
13 * When distributing Covered Code, include this CDDL HEADER in each
14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 * If applicable, add the following below this CDDL HEADER, with the
16 * fields enclosed by brackets "[]" replaced with your own identifying
17 * information: Portions Copyright [yyyy] [name of copyright owner]
18 *
19 * CDDL HEADER END
20 */
21/*
428870ff 22 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
8d35c149 23 * Copyright 2011 Nexenta Systems, Inc. All rights reserved.
e6d3a843 24 * Copyright (c) 2011, 2015 by Delphix. All rights reserved.
788eb90c 25 * Copyright (c) 2014, Joyent, Inc. All rights reserved.
47dfff3b 26 * Copyright 2014 HybridCluster. All rights reserved.
b607405f 27 * Copyright 2016 RackTop Systems.
a0bd735a 28 * Copyright (c) 2016 Actifio, Inc. All rights reserved.
8d35c149 29 */
34dc7c2f 30
34dc7c2f
BB
31#include <sys/dmu.h>
32#include <sys/dmu_impl.h>
33#include <sys/dmu_tx.h>
34#include <sys/dbuf.h>
35#include <sys/dnode.h>
36#include <sys/zfs_context.h>
37#include <sys/dmu_objset.h>
38#include <sys/dmu_traverse.h>
39#include <sys/dsl_dataset.h>
40#include <sys/dsl_dir.h>
428870ff 41#include <sys/dsl_prop.h>
34dc7c2f
BB
42#include <sys/dsl_pool.h>
43#include <sys/dsl_synctask.h>
044baf00 44#include <sys/spa_impl.h>
34dc7c2f
BB
45#include <sys/zfs_ioctl.h>
46#include <sys/zap.h>
47#include <sys/zio_checksum.h>
428870ff
BB
48#include <sys/zfs_znode.h>
49#include <zfs_fletcher.h>
50#include <sys/avl.h>
51#include <sys/ddt.h>
572e2857 52#include <sys/zfs_onexit.h>
13fe0198
MA
53#include <sys/dmu_send.h>
54#include <sys/dsl_destroy.h>
9b67f605 55#include <sys/blkptr.h>
da536844 56#include <sys/dsl_bookmark.h>
9b67f605 57#include <sys/zfeature.h>
fcff0f35 58#include <sys/bqueue.h>
a0bd735a 59#include <sys/zvol.h>
f74b821a 60#include <sys/policy.h>
34dc7c2f 61
330d06f9
MA
62/* Set this tunable to TRUE to replace corrupt data with 0x2f5baddb10c */
63int zfs_send_corrupt_data = B_FALSE;
fcff0f35
PD
64int zfs_send_queue_length = 16 * 1024 * 1024;
65int zfs_recv_queue_length = 16 * 1024 * 1024;
b607405f
AS
66/* Set this tunable to FALSE to disable setting of DRR_FLAG_FREERECORDS */
67int zfs_send_set_freerecords_bit = B_TRUE;
330d06f9 68
34dc7c2f 69static char *dmu_recv_tag = "dmu_recv_tag";
47dfff3b 70const char *recv_clone_name = "%recv";
34dc7c2f 71
fcff0f35
PD
72#define BP_SPAN(datablkszsec, indblkshift, level) \
73 (((uint64_t)datablkszsec) << (SPA_MINBLOCKSHIFT + \
74 (level) * (indblkshift - SPA_BLKPTRSHIFT)))
75
47dfff3b
MA
76static void byteswap_record(dmu_replay_record_t *drr);
77
fcff0f35
PD
78struct send_thread_arg {
79 bqueue_t q;
80 dsl_dataset_t *ds; /* Dataset to traverse */
81 uint64_t fromtxg; /* Traverse from this txg */
82 int flags; /* flags to pass to traverse_dataset */
83 int error_code;
84 boolean_t cancel;
47dfff3b 85 zbookmark_phys_t resume;
fcff0f35
PD
86};
87
88struct send_block_record {
89 boolean_t eos_marker; /* Marks the end of the stream */
90 blkptr_t bp;
91 zbookmark_phys_t zb;
92 uint8_t indblkshift;
93 uint16_t datablkszsec;
94 bqueue_node_t ln;
95};
96
044baf00
BB
97typedef struct dump_bytes_io {
98 dmu_sendarg_t *dbi_dsp;
99 void *dbi_buf;
100 int dbi_len;
101} dump_bytes_io_t;
102
103static void
b58986ee 104dump_bytes_cb(void *arg)
34dc7c2f 105{
044baf00
BB
106 dump_bytes_io_t *dbi = (dump_bytes_io_t *)arg;
107 dmu_sendarg_t *dsp = dbi->dbi_dsp;
47dfff3b 108 dsl_dataset_t *ds = dmu_objset_ds(dsp->dsa_os);
34dc7c2f 109 ssize_t resid; /* have to get resid to get detailed errno */
f8866f8a
ER
110
111 /*
112 * The code does not rely on this (len being a multiple of 8). We keep
113 * this assertion because of the corresponding assertion in
114 * receive_read(). Keeping this assertion ensures that we do not
115 * inadvertently break backwards compatibility (causing the assertion
116 * in receive_read() to trigger on old software).
117 *
118 * Removing the assertions could be rolled into a new feature that uses
119 * data that isn't 8-byte aligned; if the assertions were removed, a
120 * feature flag would have to be added.
121 */
122
c99c9001 123 ASSERT0(dbi->dbi_len % 8);
34dc7c2f 124
37abac6d 125 dsp->dsa_err = vn_rdwr(UIO_WRITE, dsp->dsa_vp,
044baf00 126 (caddr_t)dbi->dbi_buf, dbi->dbi_len,
34dc7c2f 127 0, UIO_SYSSPACE, FAPPEND, RLIM64_INFINITY, CRED(), &resid);
37abac6d
BP
128
129 mutex_enter(&ds->ds_sendstream_lock);
044baf00 130 *dsp->dsa_off += dbi->dbi_len;
37abac6d 131 mutex_exit(&ds->ds_sendstream_lock);
044baf00
BB
132}
133
134static int
135dump_bytes(dmu_sendarg_t *dsp, void *buf, int len)
136{
137 dump_bytes_io_t dbi;
138
139 dbi.dbi_dsp = dsp;
140 dbi.dbi_buf = buf;
141 dbi.dbi_len = len;
142
b58986ee
BB
143#if defined(HAVE_LARGE_STACKS)
144 dump_bytes_cb(&dbi);
145#else
044baf00
BB
146 /*
147 * The vn_rdwr() call is performed in a taskq to ensure that there is
148 * always enough stack space to write safely to the target filesystem.
149 * The ZIO_TYPE_FREE threads are used because there can be a lot of
150 * them and they are used in vdev_file.c for a similar purpose.
151 */
152 spa_taskq_dispatch_sync(dmu_objset_spa(dsp->dsa_os), ZIO_TYPE_FREE,
b58986ee
BB
153 ZIO_TASKQ_ISSUE, dump_bytes_cb, &dbi, TQ_SLEEP);
154#endif /* HAVE_LARGE_STACKS */
37abac6d
BP
155
156 return (dsp->dsa_err);
34dc7c2f
BB
157}
158
37f8a883
MA
159/*
160 * For all record types except BEGIN, fill in the checksum (overlaid in
161 * drr_u.drr_checksum.drr_checksum). The checksum verifies everything
162 * up to the start of the checksum itself.
163 */
164static int
165dump_record(dmu_sendarg_t *dsp, void *payload, int payload_len)
166{
167 ASSERT3U(offsetof(dmu_replay_record_t, drr_u.drr_checksum.drr_checksum),
168 ==, sizeof (dmu_replay_record_t) - sizeof (zio_cksum_t));
a6255b7f 169 (void) fletcher_4_incremental_native(dsp->dsa_drr,
37f8a883
MA
170 offsetof(dmu_replay_record_t, drr_u.drr_checksum.drr_checksum),
171 &dsp->dsa_zc);
51907a31
K
172 if (dsp->dsa_drr->drr_type == DRR_BEGIN) {
173 dsp->dsa_sent_begin = B_TRUE;
174 } else {
37f8a883
MA
175 ASSERT(ZIO_CHECKSUM_IS_ZERO(&dsp->dsa_drr->drr_u.
176 drr_checksum.drr_checksum));
177 dsp->dsa_drr->drr_u.drr_checksum.drr_checksum = dsp->dsa_zc;
178 }
51907a31
K
179 if (dsp->dsa_drr->drr_type == DRR_END) {
180 dsp->dsa_sent_end = B_TRUE;
181 }
a6255b7f 182 (void) fletcher_4_incremental_native(&dsp->dsa_drr->
37f8a883
MA
183 drr_u.drr_checksum.drr_checksum,
184 sizeof (zio_cksum_t), &dsp->dsa_zc);
185 if (dump_bytes(dsp, dsp->dsa_drr, sizeof (dmu_replay_record_t)) != 0)
186 return (SET_ERROR(EINTR));
187 if (payload_len != 0) {
a6255b7f 188 (void) fletcher_4_incremental_native(payload, payload_len,
37f8a883
MA
189 &dsp->dsa_zc);
190 if (dump_bytes(dsp, payload, payload_len) != 0)
191 return (SET_ERROR(EINTR));
192 }
193 return (0);
194}
195
e6d3a843
PD
196/*
197 * Fill in the drr_free struct, or perform aggregation if the previous record is
198 * also a free record, and the two are adjacent.
199 *
200 * Note that we send free records even for a full send, because we want to be
201 * able to receive a full send as a clone, which requires a list of all the free
202 * and freeobject records that were generated on the source.
203 */
34dc7c2f 204static int
37abac6d 205dump_free(dmu_sendarg_t *dsp, uint64_t object, uint64_t offset,
34dc7c2f
BB
206 uint64_t length)
207{
37abac6d 208 struct drr_free *drrf = &(dsp->dsa_drr->drr_u.drr_free);
428870ff 209
ea97f8ce
MA
210 /*
211 * When we receive a free record, dbuf_free_range() assumes
212 * that the receiving system doesn't have any dbufs in the range
213 * being freed. This is always true because there is a one-record
214 * constraint: we only send one WRITE record for any given
47dfff3b 215 * object,offset. We know that the one-record constraint is
ea97f8ce
MA
216 * true because we always send data in increasing order by
217 * object,offset.
218 *
219 * If the increasing-order constraint ever changes, we should find
220 * another way to assert that the one-record constraint is still
221 * satisfied.
222 */
223 ASSERT(object > dsp->dsa_last_data_object ||
224 (object == dsp->dsa_last_data_object &&
225 offset > dsp->dsa_last_data_offset));
226
c578f007
SK
227 if (length != -1ULL && offset + length < offset)
228 length = -1ULL;
229
428870ff
BB
230 /*
231 * If there is a pending op, but it's not PENDING_FREE, push it out,
232 * since free block aggregation can only be done for blocks of the
233 * same type (i.e., DRR_FREE records can only be aggregated with
234 * other DRR_FREE records. DRR_FREEOBJECTS records can only be
235 * aggregated with other DRR_FREEOBJECTS records.
236 */
37abac6d
BP
237 if (dsp->dsa_pending_op != PENDING_NONE &&
238 dsp->dsa_pending_op != PENDING_FREE) {
37f8a883 239 if (dump_record(dsp, NULL, 0) != 0)
2e528b49 240 return (SET_ERROR(EINTR));
37abac6d 241 dsp->dsa_pending_op = PENDING_NONE;
428870ff
BB
242 }
243
37abac6d 244 if (dsp->dsa_pending_op == PENDING_FREE) {
428870ff
BB
245 /*
246 * There should never be a PENDING_FREE if length is -1
247 * (because dump_dnode is the only place where this
248 * function is called with a -1, and only after flushing
249 * any pending record).
250 */
251 ASSERT(length != -1ULL);
252 /*
253 * Check to see whether this free block can be aggregated
254 * with pending one.
255 */
256 if (drrf->drr_object == object && drrf->drr_offset +
257 drrf->drr_length == offset) {
258 drrf->drr_length += length;
259 return (0);
260 } else {
261 /* not a continuation. Push out pending record */
37f8a883 262 if (dump_record(dsp, NULL, 0) != 0)
2e528b49 263 return (SET_ERROR(EINTR));
37abac6d 264 dsp->dsa_pending_op = PENDING_NONE;
428870ff
BB
265 }
266 }
267 /* create a FREE record and make it pending */
37abac6d
BP
268 bzero(dsp->dsa_drr, sizeof (dmu_replay_record_t));
269 dsp->dsa_drr->drr_type = DRR_FREE;
428870ff
BB
270 drrf->drr_object = object;
271 drrf->drr_offset = offset;
272 drrf->drr_length = length;
37abac6d 273 drrf->drr_toguid = dsp->dsa_toguid;
428870ff 274 if (length == -1ULL) {
37f8a883 275 if (dump_record(dsp, NULL, 0) != 0)
2e528b49 276 return (SET_ERROR(EINTR));
428870ff 277 } else {
37abac6d 278 dsp->dsa_pending_op = PENDING_FREE;
428870ff 279 }
34dc7c2f 280
34dc7c2f
BB
281 return (0);
282}
283
284static int
9b67f605 285dump_write(dmu_sendarg_t *dsp, dmu_object_type_t type,
2aa34383
DK
286 uint64_t object, uint64_t offset, int lsize, int psize, const blkptr_t *bp,
287 void *data)
34dc7c2f 288{
2aa34383 289 uint64_t payload_size;
37abac6d 290 struct drr_write *drrw = &(dsp->dsa_drr->drr_u.drr_write);
428870ff 291
ea97f8ce
MA
292 /*
293 * We send data in increasing object, offset order.
294 * See comment in dump_free() for details.
295 */
296 ASSERT(object > dsp->dsa_last_data_object ||
297 (object == dsp->dsa_last_data_object &&
298 offset > dsp->dsa_last_data_offset));
299 dsp->dsa_last_data_object = object;
2aa34383 300 dsp->dsa_last_data_offset = offset + lsize - 1;
428870ff
BB
301
302 /*
303 * If there is any kind of pending aggregation (currently either
304 * a grouping of free objects or free blocks), push it out to
305 * the stream, since aggregation can't be done across operations
306 * of different types.
307 */
37abac6d 308 if (dsp->dsa_pending_op != PENDING_NONE) {
37f8a883 309 if (dump_record(dsp, NULL, 0) != 0)
2e528b49 310 return (SET_ERROR(EINTR));
37abac6d 311 dsp->dsa_pending_op = PENDING_NONE;
428870ff 312 }
37f8a883 313 /* write a WRITE record */
37abac6d
BP
314 bzero(dsp->dsa_drr, sizeof (dmu_replay_record_t));
315 dsp->dsa_drr->drr_type = DRR_WRITE;
428870ff
BB
316 drrw->drr_object = object;
317 drrw->drr_type = type;
318 drrw->drr_offset = offset;
37abac6d 319 drrw->drr_toguid = dsp->dsa_toguid;
2aa34383
DK
320 drrw->drr_logical_size = lsize;
321
322 /* only set the compression fields if the buf is compressed */
323 if (lsize != psize) {
324 ASSERT(dsp->dsa_featureflags & DMU_BACKUP_FEATURE_COMPRESSED);
325 ASSERT(!BP_IS_EMBEDDED(bp));
326 ASSERT(!BP_SHOULD_BYTESWAP(bp));
327 ASSERT(!DMU_OT_IS_METADATA(BP_GET_TYPE(bp)));
328 ASSERT3U(BP_GET_COMPRESS(bp), !=, ZIO_COMPRESS_OFF);
329 ASSERT3S(psize, >, 0);
330 ASSERT3S(lsize, >=, psize);
331
332 drrw->drr_compressiontype = BP_GET_COMPRESS(bp);
333 drrw->drr_compressed_size = psize;
334 payload_size = drrw->drr_compressed_size;
335 } else {
336 payload_size = drrw->drr_logical_size;
337 }
338
f1512ee6 339 if (bp == NULL || BP_IS_EMBEDDED(bp)) {
9b67f605 340 /*
f1512ee6
MA
341 * There's no pre-computed checksum for partial-block
342 * writes or embedded BP's, so (like
343 * fletcher4-checkummed blocks) userland will have to
344 * compute a dedup-capable checksum itself.
9b67f605
MA
345 */
346 drrw->drr_checksumtype = ZIO_CHECKSUM_OFF;
347 } else {
348 drrw->drr_checksumtype = BP_GET_CHECKSUM(bp);
3c67d83a
TH
349 if (zio_checksum_table[drrw->drr_checksumtype].ci_flags &
350 ZCHECKSUM_FLAG_DEDUP)
9b67f605
MA
351 drrw->drr_checksumflags |= DRR_CHECKSUM_DEDUP;
352 DDK_SET_LSIZE(&drrw->drr_key, BP_GET_LSIZE(bp));
353 DDK_SET_PSIZE(&drrw->drr_key, BP_GET_PSIZE(bp));
354 DDK_SET_COMPRESS(&drrw->drr_key, BP_GET_COMPRESS(bp));
355 drrw->drr_key.ddk_cksum = bp->blk_cksum;
356 }
428870ff 357
2aa34383 358 if (dump_record(dsp, data, payload_size) != 0)
2e528b49 359 return (SET_ERROR(EINTR));
428870ff
BB
360 return (0);
361}
362
9b67f605
MA
363static int
364dump_write_embedded(dmu_sendarg_t *dsp, uint64_t object, uint64_t offset,
365 int blksz, const blkptr_t *bp)
366{
367 char buf[BPE_PAYLOAD_SIZE];
368 struct drr_write_embedded *drrw =
369 &(dsp->dsa_drr->drr_u.drr_write_embedded);
370
371 if (dsp->dsa_pending_op != PENDING_NONE) {
37f8a883 372 if (dump_record(dsp, NULL, 0) != 0)
9b67f605
MA
373 return (EINTR);
374 dsp->dsa_pending_op = PENDING_NONE;
375 }
376
377 ASSERT(BP_IS_EMBEDDED(bp));
378
379 bzero(dsp->dsa_drr, sizeof (dmu_replay_record_t));
380 dsp->dsa_drr->drr_type = DRR_WRITE_EMBEDDED;
381 drrw->drr_object = object;
382 drrw->drr_offset = offset;
383 drrw->drr_length = blksz;
384 drrw->drr_toguid = dsp->dsa_toguid;
385 drrw->drr_compression = BP_GET_COMPRESS(bp);
386 drrw->drr_etype = BPE_GET_ETYPE(bp);
387 drrw->drr_lsize = BPE_GET_LSIZE(bp);
388 drrw->drr_psize = BPE_GET_PSIZE(bp);
389
390 decode_embedded_bp_compressed(bp, buf);
391
37f8a883 392 if (dump_record(dsp, buf, P2ROUNDUP(drrw->drr_psize, 8)) != 0)
9b67f605
MA
393 return (EINTR);
394 return (0);
395}
396
428870ff 397static int
37abac6d 398dump_spill(dmu_sendarg_t *dsp, uint64_t object, int blksz, void *data)
428870ff 399{
37abac6d 400 struct drr_spill *drrs = &(dsp->dsa_drr->drr_u.drr_spill);
428870ff 401
37abac6d 402 if (dsp->dsa_pending_op != PENDING_NONE) {
37f8a883 403 if (dump_record(dsp, NULL, 0) != 0)
2e528b49 404 return (SET_ERROR(EINTR));
37abac6d 405 dsp->dsa_pending_op = PENDING_NONE;
428870ff
BB
406 }
407
408 /* write a SPILL record */
37abac6d
BP
409 bzero(dsp->dsa_drr, sizeof (dmu_replay_record_t));
410 dsp->dsa_drr->drr_type = DRR_SPILL;
428870ff
BB
411 drrs->drr_object = object;
412 drrs->drr_length = blksz;
37abac6d 413 drrs->drr_toguid = dsp->dsa_toguid;
34dc7c2f 414
37f8a883 415 if (dump_record(dsp, data, blksz) != 0)
2e528b49 416 return (SET_ERROR(EINTR));
34dc7c2f
BB
417 return (0);
418}
419
420static int
37abac6d 421dump_freeobjects(dmu_sendarg_t *dsp, uint64_t firstobj, uint64_t numobjs)
34dc7c2f 422{
37abac6d 423 struct drr_freeobjects *drrfo = &(dsp->dsa_drr->drr_u.drr_freeobjects);
428870ff
BB
424
425 /*
426 * If there is a pending op, but it's not PENDING_FREEOBJECTS,
427 * push it out, since free block aggregation can only be done for
428 * blocks of the same type (i.e., DRR_FREE records can only be
429 * aggregated with other DRR_FREE records. DRR_FREEOBJECTS records
430 * can only be aggregated with other DRR_FREEOBJECTS records.
431 */
37abac6d
BP
432 if (dsp->dsa_pending_op != PENDING_NONE &&
433 dsp->dsa_pending_op != PENDING_FREEOBJECTS) {
37f8a883 434 if (dump_record(dsp, NULL, 0) != 0)
2e528b49 435 return (SET_ERROR(EINTR));
37abac6d 436 dsp->dsa_pending_op = PENDING_NONE;
428870ff 437 }
37abac6d 438 if (dsp->dsa_pending_op == PENDING_FREEOBJECTS) {
428870ff
BB
439 /*
440 * See whether this free object array can be aggregated
441 * with pending one
442 */
443 if (drrfo->drr_firstobj + drrfo->drr_numobjs == firstobj) {
444 drrfo->drr_numobjs += numobjs;
445 return (0);
446 } else {
447 /* can't be aggregated. Push out pending record */
37f8a883 448 if (dump_record(dsp, NULL, 0) != 0)
2e528b49 449 return (SET_ERROR(EINTR));
37abac6d 450 dsp->dsa_pending_op = PENDING_NONE;
428870ff
BB
451 }
452 }
453
34dc7c2f 454 /* write a FREEOBJECTS record */
37abac6d
BP
455 bzero(dsp->dsa_drr, sizeof (dmu_replay_record_t));
456 dsp->dsa_drr->drr_type = DRR_FREEOBJECTS;
428870ff
BB
457 drrfo->drr_firstobj = firstobj;
458 drrfo->drr_numobjs = numobjs;
37abac6d 459 drrfo->drr_toguid = dsp->dsa_toguid;
428870ff 460
37abac6d 461 dsp->dsa_pending_op = PENDING_FREEOBJECTS;
34dc7c2f 462
34dc7c2f
BB
463 return (0);
464}
465
466static int
37abac6d 467dump_dnode(dmu_sendarg_t *dsp, uint64_t object, dnode_phys_t *dnp)
34dc7c2f 468{
37abac6d 469 struct drr_object *drro = &(dsp->dsa_drr->drr_u.drr_object);
428870ff 470
47dfff3b
MA
471 if (object < dsp->dsa_resume_object) {
472 /*
473 * Note: when resuming, we will visit all the dnodes in
474 * the block of dnodes that we are resuming from. In
475 * this case it's unnecessary to send the dnodes prior to
476 * the one we are resuming from. We should be at most one
477 * block's worth of dnodes behind the resume point.
478 */
479 ASSERT3U(dsp->dsa_resume_object - object, <,
480 1 << (DNODE_BLOCK_SHIFT - DNODE_SHIFT));
481 return (0);
482 }
483
34dc7c2f 484 if (dnp == NULL || dnp->dn_type == DMU_OT_NONE)
37abac6d 485 return (dump_freeobjects(dsp, object, 1));
34dc7c2f 486
37abac6d 487 if (dsp->dsa_pending_op != PENDING_NONE) {
37f8a883 488 if (dump_record(dsp, NULL, 0) != 0)
2e528b49 489 return (SET_ERROR(EINTR));
37abac6d 490 dsp->dsa_pending_op = PENDING_NONE;
428870ff
BB
491 }
492
34dc7c2f 493 /* write an OBJECT record */
37abac6d
BP
494 bzero(dsp->dsa_drr, sizeof (dmu_replay_record_t));
495 dsp->dsa_drr->drr_type = DRR_OBJECT;
428870ff
BB
496 drro->drr_object = object;
497 drro->drr_type = dnp->dn_type;
498 drro->drr_bonustype = dnp->dn_bonustype;
499 drro->drr_blksz = dnp->dn_datablkszsec << SPA_MINBLOCKSHIFT;
500 drro->drr_bonuslen = dnp->dn_bonuslen;
50c957f7 501 drro->drr_dn_slots = dnp->dn_extra_slots + 1;
428870ff
BB
502 drro->drr_checksumtype = dnp->dn_checksum;
503 drro->drr_compress = dnp->dn_compress;
37abac6d 504 drro->drr_toguid = dsp->dsa_toguid;
428870ff 505
f1512ee6
MA
506 if (!(dsp->dsa_featureflags & DMU_BACKUP_FEATURE_LARGE_BLOCKS) &&
507 drro->drr_blksz > SPA_OLD_MAXBLOCKSIZE)
508 drro->drr_blksz = SPA_OLD_MAXBLOCKSIZE;
509
37f8a883
MA
510 if (dump_record(dsp, DN_BONUS(dnp),
511 P2ROUNDUP(dnp->dn_bonuslen, 8)) != 0) {
2e528b49 512 return (SET_ERROR(EINTR));
37f8a883 513 }
34dc7c2f 514
ea97f8ce 515 /* Free anything past the end of the file. */
37abac6d 516 if (dump_free(dsp, object, (dnp->dn_maxblkid + 1) *
ea97f8ce 517 (dnp->dn_datablkszsec << SPA_MINBLOCKSHIFT), -1ULL) != 0)
2e528b49 518 return (SET_ERROR(EINTR));
13fe0198 519 if (dsp->dsa_err != 0)
2e528b49 520 return (SET_ERROR(EINTR));
34dc7c2f
BB
521 return (0);
522}
523
9b67f605
MA
524static boolean_t
525backup_do_embed(dmu_sendarg_t *dsp, const blkptr_t *bp)
526{
527 if (!BP_IS_EMBEDDED(bp))
528 return (B_FALSE);
529
530 /*
531 * Compression function must be legacy, or explicitly enabled.
532 */
533 if ((BP_GET_COMPRESS(bp) >= ZIO_COMPRESS_LEGACY_FUNCTIONS &&
2aa34383 534 !(dsp->dsa_featureflags & DMU_BACKUP_FEATURE_LZ4)))
9b67f605
MA
535 return (B_FALSE);
536
537 /*
538 * Embed type must be explicitly enabled.
539 */
540 switch (BPE_GET_ETYPE(bp)) {
541 case BP_EMBEDDED_TYPE_DATA:
542 if (dsp->dsa_featureflags & DMU_BACKUP_FEATURE_EMBED_DATA)
543 return (B_TRUE);
544 break;
545 default:
546 return (B_FALSE);
547 }
548 return (B_FALSE);
549}
550
fcff0f35
PD
551/*
552 * This is the callback function to traverse_dataset that acts as the worker
553 * thread for dmu_send_impl.
554 */
555/*ARGSUSED*/
556static int
557send_cb(spa_t *spa, zilog_t *zilog, const blkptr_t *bp,
558 const zbookmark_phys_t *zb, const struct dnode_phys *dnp, void *arg)
559{
560 struct send_thread_arg *sta = arg;
561 struct send_block_record *record;
562 uint64_t record_size;
563 int err = 0;
564
47dfff3b
MA
565 ASSERT(zb->zb_object == DMU_META_DNODE_OBJECT ||
566 zb->zb_object >= sta->resume.zb_object);
567
fcff0f35
PD
568 if (sta->cancel)
569 return (SET_ERROR(EINTR));
34dc7c2f 570
fcff0f35
PD
571 if (bp == NULL) {
572 ASSERT3U(zb->zb_level, ==, ZB_DNODE_LEVEL);
573 return (0);
574 } else if (zb->zb_level < 0) {
575 return (0);
576 }
577
578 record = kmem_zalloc(sizeof (struct send_block_record), KM_SLEEP);
579 record->eos_marker = B_FALSE;
580 record->bp = *bp;
581 record->zb = *zb;
582 record->indblkshift = dnp->dn_indblkshift;
583 record->datablkszsec = dnp->dn_datablkszsec;
584 record_size = dnp->dn_datablkszsec << SPA_MINBLOCKSHIFT;
585 bqueue_enqueue(&sta->q, record, record_size);
586
587 return (err);
588}
589
590/*
591 * This function kicks off the traverse_dataset. It also handles setting the
592 * error code of the thread in case something goes wrong, and pushes the End of
593 * Stream record when the traverse_dataset call has finished. If there is no
594 * dataset to traverse, the thread immediately pushes End of Stream marker.
595 */
596static void
597send_traverse_thread(void *arg)
598{
599 struct send_thread_arg *st_arg = arg;
600 int err;
601 struct send_block_record *data;
3e635ac1 602 fstrans_cookie_t cookie = spl_fstrans_mark();
fcff0f35
PD
603
604 if (st_arg->ds != NULL) {
47dfff3b
MA
605 err = traverse_dataset_resume(st_arg->ds,
606 st_arg->fromtxg, &st_arg->resume,
607 st_arg->flags, send_cb, st_arg);
608
fcff0f35
PD
609 if (err != EINTR)
610 st_arg->error_code = err;
611 }
612 data = kmem_zalloc(sizeof (*data), KM_SLEEP);
613 data->eos_marker = B_TRUE;
614 bqueue_enqueue(&st_arg->q, data, 1);
3e635ac1 615 spl_fstrans_unmark(cookie);
34a6b428 616 thread_exit();
fcff0f35
PD
617}
618
619/*
620 * This function actually handles figuring out what kind of record needs to be
621 * dumped, reading the data (which has hopefully been prefetched), and calling
622 * the appropriate helper function.
623 */
34dc7c2f 624static int
fcff0f35 625do_dump(dmu_sendarg_t *dsa, struct send_block_record *data)
34dc7c2f 626{
fcff0f35
PD
627 dsl_dataset_t *ds = dmu_objset_ds(dsa->dsa_os);
628 const blkptr_t *bp = &data->bp;
629 const zbookmark_phys_t *zb = &data->zb;
630 uint8_t indblkshift = data->indblkshift;
631 uint16_t dblkszsec = data->datablkszsec;
632 spa_t *spa = ds->ds_dir->dd_pool->dp_spa;
34dc7c2f 633 dmu_object_type_t type = bp ? BP_GET_TYPE(bp) : DMU_OT_NONE;
34dc7c2f 634 int err = 0;
fcff0f35 635 uint64_t dnobj;
34dc7c2f 636
fcff0f35 637 ASSERT3U(zb->zb_level, >=, 0);
34dc7c2f 638
47dfff3b
MA
639 ASSERT(zb->zb_object == DMU_META_DNODE_OBJECT ||
640 zb->zb_object >= dsa->dsa_resume_object);
641
428870ff
BB
642 if (zb->zb_object != DMU_META_DNODE_OBJECT &&
643 DMU_OBJECT_IS_SPECIAL(zb->zb_object)) {
9babb374 644 return (0);
b0bc7a84
MG
645 } else if (BP_IS_HOLE(bp) &&
646 zb->zb_object == DMU_META_DNODE_OBJECT) {
fcff0f35 647 uint64_t span = BP_SPAN(dblkszsec, indblkshift, zb->zb_level);
b128c09f 648 uint64_t dnobj = (zb->zb_blkid * span) >> DNODE_SHIFT;
fcff0f35 649 err = dump_freeobjects(dsa, dnobj, span >> DNODE_SHIFT);
b0bc7a84 650 } else if (BP_IS_HOLE(bp)) {
fcff0f35
PD
651 uint64_t span = BP_SPAN(dblkszsec, indblkshift, zb->zb_level);
652 uint64_t offset = zb->zb_blkid * span;
653 err = dump_free(dsa, zb->zb_object, offset, span);
b128c09f
BB
654 } else if (zb->zb_level > 0 || type == DMU_OT_OBJSET) {
655 return (0);
656 } else if (type == DMU_OT_DNODE) {
50c957f7
NB
657 dnode_phys_t *blk;
658 int epb = BP_GET_LSIZE(bp) >> DNODE_SHIFT;
2a432414 659 arc_flags_t aflags = ARC_FLAG_WAIT;
b128c09f 660 arc_buf_t *abuf;
fcff0f35
PD
661 int i;
662
663 ASSERT0(zb->zb_level);
b128c09f 664
294f6806
GW
665 if (arc_read(NULL, spa, bp, arc_getbuf_func, &abuf,
666 ZIO_PRIORITY_ASYNC_READ, ZIO_FLAG_CANFAIL,
667 &aflags, zb) != 0)
2e528b49 668 return (SET_ERROR(EIO));
34dc7c2f 669
b128c09f 670 blk = abuf->b_data;
50c957f7
NB
671 dnobj = zb->zb_blkid * epb;
672 for (i = 0; i < epb; i += blk[i].dn_extra_slots + 1) {
fcff0f35 673 err = dump_dnode(dsa, dnobj + i, blk + i);
13fe0198 674 if (err != 0)
34dc7c2f
BB
675 break;
676 }
d3c2ae1c 677 arc_buf_destroy(abuf, &abuf);
428870ff 678 } else if (type == DMU_OT_SA) {
2a432414 679 arc_flags_t aflags = ARC_FLAG_WAIT;
b128c09f 680 arc_buf_t *abuf;
34dc7c2f 681 int blksz = BP_GET_LSIZE(bp);
b128c09f 682
294f6806
GW
683 if (arc_read(NULL, spa, bp, arc_getbuf_func, &abuf,
684 ZIO_PRIORITY_ASYNC_READ, ZIO_FLAG_CANFAIL,
685 &aflags, zb) != 0)
2e528b49 686 return (SET_ERROR(EIO));
b128c09f 687
fcff0f35 688 err = dump_spill(dsa, zb->zb_object, blksz, abuf->b_data);
d3c2ae1c 689 arc_buf_destroy(abuf, &abuf);
fcff0f35 690 } else if (backup_do_embed(dsa, bp)) {
9b67f605 691 /* it's an embedded level-0 block of a regular object */
fcff0f35
PD
692 int blksz = dblkszsec << SPA_MINBLOCKSHIFT;
693 ASSERT0(zb->zb_level);
694 err = dump_write_embedded(dsa, zb->zb_object,
9b67f605 695 zb->zb_blkid * blksz, blksz, bp);
fcff0f35
PD
696 } else {
697 /* it's a level-0 block of a regular object */
2a432414 698 arc_flags_t aflags = ARC_FLAG_WAIT;
428870ff 699 arc_buf_t *abuf;
fcff0f35
PD
700 int blksz = dblkszsec << SPA_MINBLOCKSHIFT;
701 uint64_t offset;
2aa34383
DK
702 enum zio_flag zioflags = ZIO_FLAG_CANFAIL;
703
704 /*
705 * If we have large blocks stored on disk but the send flags
706 * don't allow us to send large blocks, we split the data from
707 * the arc buf into chunks.
708 */
709 boolean_t split_large_blocks =
710 data->datablkszsec > SPA_OLD_MAXBLOCKSIZE &&
711 !(dsa->dsa_featureflags & DMU_BACKUP_FEATURE_LARGE_BLOCKS);
712 /*
713 * We should only request compressed data from the ARC if all
714 * the following are true:
715 * - stream compression was requested
716 * - we aren't splitting large blocks into smaller chunks
717 * - the data won't need to be byteswapped before sending
718 * - this isn't an embedded block
719 * - this isn't metadata (if receiving on a different endian
720 * system it can be byteswapped more easily)
721 */
722 boolean_t request_compressed =
723 (dsa->dsa_featureflags & DMU_BACKUP_FEATURE_COMPRESSED) &&
724 !split_large_blocks && !BP_SHOULD_BYTESWAP(bp) &&
725 !BP_IS_EMBEDDED(bp) && !DMU_OT_IS_METADATA(BP_GET_TYPE(bp));
428870ff 726
da536844 727 ASSERT0(zb->zb_level);
47dfff3b
MA
728 ASSERT(zb->zb_object > dsa->dsa_resume_object ||
729 (zb->zb_object == dsa->dsa_resume_object &&
730 zb->zb_blkid * blksz >= dsa->dsa_resume_offset));
731
2aa34383
DK
732 if (request_compressed)
733 zioflags |= ZIO_FLAG_RAW;
734
294f6806 735 if (arc_read(NULL, spa, bp, arc_getbuf_func, &abuf,
2aa34383 736 ZIO_PRIORITY_ASYNC_READ, zioflags,
294f6806 737 &aflags, zb) != 0) {
330d06f9
MA
738 if (zfs_send_corrupt_data) {
739 uint64_t *ptr;
740 /* Send a block filled with 0x"zfs badd bloc" */
2aa34383
DK
741 abuf = arc_alloc_buf(spa, &abuf, ARC_BUFC_DATA,
742 blksz);
330d06f9
MA
743 for (ptr = abuf->b_data;
744 (char *)ptr < (char *)abuf->b_data + blksz;
745 ptr++)
dd26aa53 746 *ptr = 0x2f5baddb10cULL;
330d06f9 747 } else {
2e528b49 748 return (SET_ERROR(EIO));
330d06f9
MA
749 }
750 }
428870ff 751
f1512ee6
MA
752 offset = zb->zb_blkid * blksz;
753
2aa34383 754 if (split_large_blocks) {
f1512ee6 755 char *buf = abuf->b_data;
2aa34383
DK
756 ASSERT3U(arc_get_compression(abuf), ==,
757 ZIO_COMPRESS_OFF);
f1512ee6
MA
758 while (blksz > 0 && err == 0) {
759 int n = MIN(blksz, SPA_OLD_MAXBLOCKSIZE);
fcff0f35 760 err = dump_write(dsa, type, zb->zb_object,
2aa34383 761 offset, n, n, NULL, buf);
f1512ee6
MA
762 offset += n;
763 buf += n;
764 blksz -= n;
765 }
766 } else {
2aa34383
DK
767 err = dump_write(dsa, type, zb->zb_object, offset,
768 blksz, arc_buf_size(abuf), bp,
769 abuf->b_data);
f1512ee6 770 }
d3c2ae1c 771 arc_buf_destroy(abuf, &abuf);
34dc7c2f
BB
772 }
773
774 ASSERT(err == 0 || err == EINTR);
775 return (err);
776}
777
6f1ffb06 778/*
fcff0f35
PD
779 * Pop the new data off the queue, and free the old data.
780 */
781static struct send_block_record *
782get_next_record(bqueue_t *bq, struct send_block_record *data)
783{
784 struct send_block_record *tmp = bqueue_dequeue(bq);
785 kmem_free(data, sizeof (*data));
786 return (tmp);
787}
788
789/*
790 * Actually do the bulk of the work in a zfs send.
791 *
792 * Note: Releases dp using the specified tag.
6f1ffb06 793 */
13fe0198 794static int
fcff0f35 795dmu_send_impl(void *tag, dsl_pool_t *dp, dsl_dataset_t *to_ds,
2aa34383
DK
796 zfs_bookmark_phys_t *ancestor_zb, boolean_t is_clone,
797 boolean_t embedok, boolean_t large_block_ok, boolean_t compressok,
798 int outfd, uint64_t resumeobj, uint64_t resumeoff,
47dfff3b 799 vnode_t *vp, offset_t *off)
34dc7c2f 800{
13fe0198 801 objset_t *os;
34dc7c2f 802 dmu_replay_record_t *drr;
37abac6d 803 dmu_sendarg_t *dsp;
34dc7c2f
BB
804 int err;
805 uint64_t fromtxg = 0;
9b67f605 806 uint64_t featureflags = 0;
fcff0f35 807 struct send_thread_arg to_arg;
47dfff3b
MA
808 void *payload = NULL;
809 size_t payload_len = 0;
fcff0f35 810 struct send_block_record *to_data;
34dc7c2f 811
fcff0f35 812 err = dmu_objset_from_ds(to_ds, &os);
13fe0198 813 if (err != 0) {
13fe0198
MA
814 dsl_pool_rele(dp, tag);
815 return (err);
816 }
34dc7c2f 817
34dc7c2f
BB
818 drr = kmem_zalloc(sizeof (dmu_replay_record_t), KM_SLEEP);
819 drr->drr_type = DRR_BEGIN;
820 drr->drr_u.drr_begin.drr_magic = DMU_BACKUP_MAGIC;
428870ff
BB
821 DMU_SET_STREAM_HDRTYPE(drr->drr_u.drr_begin.drr_versioninfo,
822 DMU_SUBSTREAM);
823
47dfff3b
MA
824 bzero(&to_arg, sizeof (to_arg));
825
428870ff 826#ifdef _KERNEL
13fe0198 827 if (dmu_objset_type(os) == DMU_OST_ZFS) {
428870ff 828 uint64_t version;
13fe0198 829 if (zfs_get_zplprop(os, ZFS_PROP_VERSION, &version) != 0) {
37abac6d 830 kmem_free(drr, sizeof (dmu_replay_record_t));
13fe0198 831 dsl_pool_rele(dp, tag);
2e528b49 832 return (SET_ERROR(EINVAL));
37abac6d 833 }
13fe0198 834 if (version >= ZPL_VERSION_SA) {
9b67f605 835 featureflags |= DMU_BACKUP_FEATURE_SA_SPILL;
428870ff
BB
836 }
837 }
838#endif
839
fcff0f35 840 if (large_block_ok && to_ds->ds_feature_inuse[SPA_FEATURE_LARGE_BLOCKS])
f1512ee6 841 featureflags |= DMU_BACKUP_FEATURE_LARGE_BLOCKS;
50c957f7
NB
842 if (to_ds->ds_feature_inuse[SPA_FEATURE_LARGE_DNODE])
843 featureflags |= DMU_BACKUP_FEATURE_LARGE_DNODE;
9b67f605
MA
844 if (embedok &&
845 spa_feature_is_active(dp->dp_spa, SPA_FEATURE_EMBEDDED_DATA)) {
846 featureflags |= DMU_BACKUP_FEATURE_EMBED_DATA;
2aa34383
DK
847 }
848 if (compressok) {
849 featureflags |= DMU_BACKUP_FEATURE_COMPRESSED;
850 }
851 if ((featureflags &
852 (DMU_BACKUP_FEATURE_EMBED_DATA | DMU_BACKUP_FEATURE_COMPRESSED)) !=
853 0 && spa_feature_is_active(dp->dp_spa, SPA_FEATURE_LZ4_COMPRESS)) {
854 featureflags |= DMU_BACKUP_FEATURE_LZ4;
9b67f605
MA
855 }
856
47dfff3b
MA
857 if (resumeobj != 0 || resumeoff != 0) {
858 featureflags |= DMU_BACKUP_FEATURE_RESUMING;
859 }
860
9b67f605
MA
861 DMU_SET_FEATUREFLAGS(drr->drr_u.drr_begin.drr_versioninfo,
862 featureflags);
863
34dc7c2f 864 drr->drr_u.drr_begin.drr_creation_time =
fcff0f35 865 dsl_dataset_phys(to_ds)->ds_creation_time;
13fe0198 866 drr->drr_u.drr_begin.drr_type = dmu_objset_type(os);
da536844 867 if (is_clone)
34dc7c2f 868 drr->drr_u.drr_begin.drr_flags |= DRR_FLAG_CLONE;
fcff0f35
PD
869 drr->drr_u.drr_begin.drr_toguid = dsl_dataset_phys(to_ds)->ds_guid;
870 if (dsl_dataset_phys(to_ds)->ds_flags & DS_FLAG_CI_DATASET)
34dc7c2f 871 drr->drr_u.drr_begin.drr_flags |= DRR_FLAG_CI_DATA;
b607405f
AS
872 if (zfs_send_set_freerecords_bit)
873 drr->drr_u.drr_begin.drr_flags |= DRR_FLAG_FREERECORDS;
34dc7c2f 874
fcff0f35
PD
875 if (ancestor_zb != NULL) {
876 drr->drr_u.drr_begin.drr_fromguid =
877 ancestor_zb->zbm_guid;
878 fromtxg = ancestor_zb->zbm_creation_txg;
da536844 879 }
fcff0f35
PD
880 dsl_dataset_name(to_ds, drr->drr_u.drr_begin.drr_toname);
881 if (!to_ds->ds_is_snapshot) {
da536844
MA
882 (void) strlcat(drr->drr_u.drr_begin.drr_toname, "@--head--",
883 sizeof (drr->drr_u.drr_begin.drr_toname));
13fe0198 884 }
34dc7c2f 885
37abac6d
BP
886 dsp = kmem_zalloc(sizeof (dmu_sendarg_t), KM_SLEEP);
887
888 dsp->dsa_drr = drr;
889 dsp->dsa_vp = vp;
890 dsp->dsa_outfd = outfd;
891 dsp->dsa_proc = curproc;
13fe0198 892 dsp->dsa_os = os;
37abac6d 893 dsp->dsa_off = off;
fcff0f35 894 dsp->dsa_toguid = dsl_dataset_phys(to_ds)->ds_guid;
37abac6d 895 dsp->dsa_pending_op = PENDING_NONE;
9b67f605 896 dsp->dsa_featureflags = featureflags;
47dfff3b
MA
897 dsp->dsa_resume_object = resumeobj;
898 dsp->dsa_resume_offset = resumeoff;
37abac6d 899
fcff0f35
PD
900 mutex_enter(&to_ds->ds_sendstream_lock);
901 list_insert_head(&to_ds->ds_sendstreams, dsp);
902 mutex_exit(&to_ds->ds_sendstream_lock);
37abac6d 903
fcff0f35 904 dsl_dataset_long_hold(to_ds, FTAG);
7ec09286
MA
905 dsl_pool_rele(dp, tag);
906
47dfff3b
MA
907 if (resumeobj != 0 || resumeoff != 0) {
908 dmu_object_info_t to_doi;
909 nvlist_t *nvl;
910 err = dmu_object_info(os, resumeobj, &to_doi);
911 if (err != 0)
912 goto out;
913 SET_BOOKMARK(&to_arg.resume, to_ds->ds_object, resumeobj, 0,
914 resumeoff / to_doi.doi_data_block_size);
915
916 nvl = fnvlist_alloc();
917 fnvlist_add_uint64(nvl, "resume_object", resumeobj);
918 fnvlist_add_uint64(nvl, "resume_offset", resumeoff);
919 payload = fnvlist_pack(nvl, &payload_len);
920 drr->drr_payloadlen = payload_len;
921 fnvlist_free(nvl);
922 }
923
924 err = dump_record(dsp, payload, payload_len);
925 fnvlist_pack_free(payload, payload_len);
926 if (err != 0) {
37abac6d
BP
927 err = dsp->dsa_err;
928 goto out;
34dc7c2f
BB
929 }
930
fcff0f35
PD
931 err = bqueue_init(&to_arg.q, zfs_send_queue_length,
932 offsetof(struct send_block_record, ln));
933 to_arg.error_code = 0;
934 to_arg.cancel = B_FALSE;
935 to_arg.ds = to_ds;
936 to_arg.fromtxg = fromtxg;
937 to_arg.flags = TRAVERSE_PRE | TRAVERSE_PREFETCH;
938 (void) thread_create(NULL, 0, send_traverse_thread, &to_arg, 0, curproc,
939 TS_RUN, minclsyspri);
940
941 to_data = bqueue_dequeue(&to_arg.q);
942
943 while (!to_data->eos_marker && err == 0) {
944 err = do_dump(dsp, to_data);
945 to_data = get_next_record(&to_arg.q, to_data);
946 if (issig(JUSTLOOKING) && issig(FORREAL))
947 err = EINTR;
948 }
949
950 if (err != 0) {
951 to_arg.cancel = B_TRUE;
952 while (!to_data->eos_marker) {
953 to_data = get_next_record(&to_arg.q, to_data);
954 }
955 }
956 kmem_free(to_data, sizeof (*to_data));
957
958 bqueue_destroy(&to_arg.q);
959
960 if (err == 0 && to_arg.error_code != 0)
961 err = to_arg.error_code;
962
963 if (err != 0)
964 goto out;
34dc7c2f 965
37abac6d 966 if (dsp->dsa_pending_op != PENDING_NONE)
37f8a883 967 if (dump_record(dsp, NULL, 0) != 0)
2e528b49 968 err = SET_ERROR(EINTR);
428870ff 969
13fe0198
MA
970 if (err != 0) {
971 if (err == EINTR && dsp->dsa_err != 0)
37abac6d
BP
972 err = dsp->dsa_err;
973 goto out;
34dc7c2f
BB
974 }
975
976 bzero(drr, sizeof (dmu_replay_record_t));
977 drr->drr_type = DRR_END;
37abac6d
BP
978 drr->drr_u.drr_end.drr_checksum = dsp->dsa_zc;
979 drr->drr_u.drr_end.drr_toguid = dsp->dsa_toguid;
34dc7c2f 980
fcff0f35 981 if (dump_record(dsp, NULL, 0) != 0)
37abac6d 982 err = dsp->dsa_err;
34dc7c2f 983
37abac6d 984out:
fcff0f35
PD
985 mutex_enter(&to_ds->ds_sendstream_lock);
986 list_remove(&to_ds->ds_sendstreams, dsp);
987 mutex_exit(&to_ds->ds_sendstream_lock);
37abac6d 988
51907a31
K
989 VERIFY(err != 0 || (dsp->dsa_sent_begin && dsp->dsa_sent_end));
990
34dc7c2f 991 kmem_free(drr, sizeof (dmu_replay_record_t));
37abac6d 992 kmem_free(dsp, sizeof (dmu_sendarg_t));
34dc7c2f 993
fcff0f35 994 dsl_dataset_long_rele(to_ds, FTAG);
13fe0198 995
37abac6d 996 return (err);
34dc7c2f
BB
997}
998
330d06f9 999int
13fe0198 1000dmu_send_obj(const char *pool, uint64_t tosnap, uint64_t fromsnap,
2aa34383 1001 boolean_t embedok, boolean_t large_block_ok, boolean_t compressok,
f1512ee6 1002 int outfd, vnode_t *vp, offset_t *off)
13fe0198
MA
1003{
1004 dsl_pool_t *dp;
1005 dsl_dataset_t *ds;
1006 dsl_dataset_t *fromds = NULL;
1007 int err;
1008
1009 err = dsl_pool_hold(pool, FTAG, &dp);
1010 if (err != 0)
1011 return (err);
1012
1013 err = dsl_dataset_hold_obj(dp, tosnap, FTAG, &ds);
1014 if (err != 0) {
1015 dsl_pool_rele(dp, FTAG);
1016 return (err);
1017 }
1018
1019 if (fromsnap != 0) {
da536844
MA
1020 zfs_bookmark_phys_t zb;
1021 boolean_t is_clone;
1022
13fe0198
MA
1023 err = dsl_dataset_hold_obj(dp, fromsnap, FTAG, &fromds);
1024 if (err != 0) {
1025 dsl_dataset_rele(ds, FTAG);
1026 dsl_pool_rele(dp, FTAG);
1027 return (err);
1028 }
da536844
MA
1029 if (!dsl_dataset_is_before(ds, fromds, 0))
1030 err = SET_ERROR(EXDEV);
d683ddbb
JG
1031 zb.zbm_creation_time =
1032 dsl_dataset_phys(fromds)->ds_creation_time;
1033 zb.zbm_creation_txg = dsl_dataset_phys(fromds)->ds_creation_txg;
1034 zb.zbm_guid = dsl_dataset_phys(fromds)->ds_guid;
da536844
MA
1035 is_clone = (fromds->ds_dir != ds->ds_dir);
1036 dsl_dataset_rele(fromds, FTAG);
f1512ee6 1037 err = dmu_send_impl(FTAG, dp, ds, &zb, is_clone,
2aa34383 1038 embedok, large_block_ok, compressok, outfd, 0, 0, vp, off);
da536844 1039 } else {
f1512ee6 1040 err = dmu_send_impl(FTAG, dp, ds, NULL, B_FALSE,
2aa34383 1041 embedok, large_block_ok, compressok, outfd, 0, 0, vp, off);
13fe0198 1042 }
da536844
MA
1043 dsl_dataset_rele(ds, FTAG);
1044 return (err);
13fe0198
MA
1045}
1046
1047int
47dfff3b 1048dmu_send(const char *tosnap, const char *fromsnap, boolean_t embedok,
2aa34383
DK
1049 boolean_t large_block_ok, boolean_t compressok, int outfd,
1050 uint64_t resumeobj, uint64_t resumeoff,
47dfff3b 1051 vnode_t *vp, offset_t *off)
13fe0198
MA
1052{
1053 dsl_pool_t *dp;
1054 dsl_dataset_t *ds;
13fe0198 1055 int err;
da536844 1056 boolean_t owned = B_FALSE;
13fe0198 1057
da536844 1058 if (fromsnap != NULL && strpbrk(fromsnap, "@#") == NULL)
2e528b49 1059 return (SET_ERROR(EINVAL));
13fe0198
MA
1060
1061 err = dsl_pool_hold(tosnap, FTAG, &dp);
1062 if (err != 0)
1063 return (err);
1064
da536844
MA
1065 if (strchr(tosnap, '@') == NULL && spa_writeable(dp->dp_spa)) {
1066 /*
1067 * We are sending a filesystem or volume. Ensure
1068 * that it doesn't change by owning the dataset.
1069 */
1070 err = dsl_dataset_own(dp, tosnap, FTAG, &ds);
1071 owned = B_TRUE;
1072 } else {
1073 err = dsl_dataset_hold(dp, tosnap, FTAG, &ds);
1074 }
13fe0198
MA
1075 if (err != 0) {
1076 dsl_pool_rele(dp, FTAG);
1077 return (err);
1078 }
1079
1080 if (fromsnap != NULL) {
da536844
MA
1081 zfs_bookmark_phys_t zb;
1082 boolean_t is_clone = B_FALSE;
1083 int fsnamelen = strchr(tosnap, '@') - tosnap;
1084
1085 /*
1086 * If the fromsnap is in a different filesystem, then
1087 * mark the send stream as a clone.
1088 */
1089 if (strncmp(tosnap, fromsnap, fsnamelen) != 0 ||
1090 (fromsnap[fsnamelen] != '@' &&
1091 fromsnap[fsnamelen] != '#')) {
1092 is_clone = B_TRUE;
1093 }
1094
1095 if (strchr(fromsnap, '@')) {
1096 dsl_dataset_t *fromds;
1097 err = dsl_dataset_hold(dp, fromsnap, FTAG, &fromds);
1098 if (err == 0) {
1099 if (!dsl_dataset_is_before(ds, fromds, 0))
1100 err = SET_ERROR(EXDEV);
1101 zb.zbm_creation_time =
d683ddbb 1102 dsl_dataset_phys(fromds)->ds_creation_time;
da536844 1103 zb.zbm_creation_txg =
d683ddbb
JG
1104 dsl_dataset_phys(fromds)->ds_creation_txg;
1105 zb.zbm_guid = dsl_dataset_phys(fromds)->ds_guid;
da536844
MA
1106 is_clone = (ds->ds_dir != fromds->ds_dir);
1107 dsl_dataset_rele(fromds, FTAG);
1108 }
1109 } else {
1110 err = dsl_bookmark_lookup(dp, fromsnap, ds, &zb);
1111 }
13fe0198
MA
1112 if (err != 0) {
1113 dsl_dataset_rele(ds, FTAG);
1114 dsl_pool_rele(dp, FTAG);
1115 return (err);
1116 }
f1512ee6 1117 err = dmu_send_impl(FTAG, dp, ds, &zb, is_clone,
2aa34383 1118 embedok, large_block_ok, compressok,
47dfff3b 1119 outfd, resumeobj, resumeoff, vp, off);
da536844 1120 } else {
f1512ee6 1121 err = dmu_send_impl(FTAG, dp, ds, NULL, B_FALSE,
2aa34383 1122 embedok, large_block_ok, compressok,
47dfff3b 1123 outfd, resumeobj, resumeoff, vp, off);
13fe0198 1124 }
da536844
MA
1125 if (owned)
1126 dsl_dataset_disown(ds, FTAG);
1127 else
1128 dsl_dataset_rele(ds, FTAG);
1129 return (err);
13fe0198
MA
1130}
1131
5dc8b736 1132static int
2aa34383
DK
1133dmu_adjust_send_estimate_for_indirects(dsl_dataset_t *ds, uint64_t uncompressed,
1134 uint64_t compressed, boolean_t stream_compressed, uint64_t *sizep)
5dc8b736
MG
1135{
1136 int err;
2aa34383 1137 uint64_t size;
5dc8b736
MG
1138 /*
1139 * Assume that space (both on-disk and in-stream) is dominated by
1140 * data. We will adjust for indirect blocks and the copies property,
1141 * but ignore per-object space used (eg, dnodes and DRR_OBJECT records).
1142 */
1143
2aa34383
DK
1144 uint64_t recordsize;
1145 uint64_t record_count;
1146
1147 /* Assume all (uncompressed) blocks are recordsize. */
1148 err = dsl_prop_get_int_ds(ds, zfs_prop_to_name(ZFS_PROP_RECORDSIZE),
1149 &recordsize);
1150 if (err != 0)
1151 return (err);
1152 record_count = uncompressed / recordsize;
1153
1154 /*
1155 * If we're estimating a send size for a compressed stream, use the
1156 * compressed data size to estimate the stream size. Otherwise, use the
1157 * uncompressed data size.
1158 */
1159 size = stream_compressed ? compressed : uncompressed;
1160
5dc8b736
MG
1161 /*
1162 * Subtract out approximate space used by indirect blocks.
1163 * Assume most space is used by data blocks (non-indirect, non-dnode).
2aa34383 1164 * Assume no ditto blocks or internal fragmentation.
5dc8b736
MG
1165 *
1166 * Therefore, space used by indirect blocks is sizeof(blkptr_t) per
2aa34383 1167 * block.
5dc8b736 1168 */
2aa34383 1169 size -= record_count * sizeof (blkptr_t);
5dc8b736
MG
1170
1171 /* Add in the space for the record associated with each block. */
2aa34383 1172 size += record_count * sizeof (dmu_replay_record_t);
5dc8b736
MG
1173
1174 *sizep = size;
1175
1176 return (0);
1177}
1178
13fe0198 1179int
2aa34383
DK
1180dmu_send_estimate(dsl_dataset_t *ds, dsl_dataset_t *fromds,
1181 boolean_t stream_compressed, uint64_t *sizep)
330d06f9 1182{
330d06f9 1183 int err;
2aa34383 1184 uint64_t uncomp, comp;
13fe0198 1185
fd0fd646 1186 ASSERT(dsl_pool_config_held(ds->ds_dir->dd_pool));
330d06f9
MA
1187
1188 /* tosnap must be a snapshot */
0c66c32d 1189 if (!ds->ds_is_snapshot)
2e528b49 1190 return (SET_ERROR(EINVAL));
330d06f9 1191
71e2fe41
AG
1192 /* fromsnap, if provided, must be a snapshot */
1193 if (fromds != NULL && !fromds->ds_is_snapshot)
1194 return (SET_ERROR(EINVAL));
1195
6f1ffb06
MA
1196 /*
1197 * fromsnap must be an earlier snapshot from the same fs as tosnap,
1198 * or the origin's fs.
1199 */
da536844 1200 if (fromds != NULL && !dsl_dataset_is_before(ds, fromds, 0))
2e528b49 1201 return (SET_ERROR(EXDEV));
330d06f9 1202
2aa34383 1203 /* Get compressed and uncompressed size estimates of changed data. */
330d06f9 1204 if (fromds == NULL) {
2aa34383
DK
1205 uncomp = dsl_dataset_phys(ds)->ds_uncompressed_bytes;
1206 comp = dsl_dataset_phys(ds)->ds_compressed_bytes;
330d06f9 1207 } else {
2aa34383 1208 uint64_t used;
330d06f9 1209 err = dsl_dataset_space_written(fromds, ds,
2aa34383 1210 &used, &comp, &uncomp);
13fe0198 1211 if (err != 0)
330d06f9
MA
1212 return (err);
1213 }
1214
2aa34383
DK
1215 err = dmu_adjust_send_estimate_for_indirects(ds, uncomp, comp,
1216 stream_compressed, sizep);
5dc8b736
MG
1217 return (err);
1218}
330d06f9 1219
2aa34383
DK
1220struct calculate_send_arg {
1221 uint64_t uncompressed;
1222 uint64_t compressed;
1223};
1224
5dc8b736
MG
1225/*
1226 * Simple callback used to traverse the blocks of a snapshot and sum their
2aa34383 1227 * uncompressed and compressed sizes.
5dc8b736
MG
1228 */
1229/* ARGSUSED */
1230static int
1231dmu_calculate_send_traversal(spa_t *spa, zilog_t *zilog, const blkptr_t *bp,
1232 const zbookmark_phys_t *zb, const dnode_phys_t *dnp, void *arg)
1233{
2aa34383 1234 struct calculate_send_arg *space = arg;
5dc8b736 1235 if (bp != NULL && !BP_IS_HOLE(bp)) {
2aa34383
DK
1236 space->uncompressed += BP_GET_UCSIZE(bp);
1237 space->compressed += BP_GET_PSIZE(bp);
5dc8b736
MG
1238 }
1239 return (0);
1240}
1241
1242/*
1243 * Given a desination snapshot and a TXG, calculate the approximate size of a
1244 * send stream sent from that TXG. from_txg may be zero, indicating that the
1245 * whole snapshot will be sent.
1246 */
1247int
1248dmu_send_estimate_from_txg(dsl_dataset_t *ds, uint64_t from_txg,
2aa34383 1249 boolean_t stream_compressed, uint64_t *sizep)
5dc8b736 1250{
5dc8b736 1251 int err;
2aa34383 1252 struct calculate_send_arg size = { 0 };
5dc8b736 1253
fd0fd646 1254 ASSERT(dsl_pool_config_held(ds->ds_dir->dd_pool));
5dc8b736
MG
1255
1256 /* tosnap must be a snapshot */
1257 if (!dsl_dataset_is_snapshot(ds))
1258 return (SET_ERROR(EINVAL));
1259
1260 /* verify that from_txg is before the provided snapshot was taken */
1261 if (from_txg >= dsl_dataset_phys(ds)->ds_creation_txg) {
1262 return (SET_ERROR(EXDEV));
1263 }
330d06f9 1264 /*
5dc8b736
MG
1265 * traverse the blocks of the snapshot with birth times after
1266 * from_txg, summing their uncompressed size
330d06f9 1267 */
5dc8b736
MG
1268 err = traverse_dataset(ds, from_txg, TRAVERSE_POST,
1269 dmu_calculate_send_traversal, &size);
2aa34383 1270
5dc8b736 1271 if (err)
330d06f9 1272 return (err);
330d06f9 1273
2aa34383
DK
1274 err = dmu_adjust_send_estimate_for_indirects(ds, size.uncompressed,
1275 size.compressed, stream_compressed, sizep);
5dc8b736 1276 return (err);
330d06f9
MA
1277}
1278
13fe0198
MA
1279typedef struct dmu_recv_begin_arg {
1280 const char *drba_origin;
1281 dmu_recv_cookie_t *drba_cookie;
1282 cred_t *drba_cred;
19580676 1283 uint64_t drba_snapobj;
13fe0198 1284} dmu_recv_begin_arg_t;
34dc7c2f 1285
34dc7c2f 1286static int
13fe0198
MA
1287recv_begin_check_existing_impl(dmu_recv_begin_arg_t *drba, dsl_dataset_t *ds,
1288 uint64_t fromguid)
34dc7c2f 1289{
34dc7c2f 1290 uint64_t val;
13fe0198
MA
1291 int error;
1292 dsl_pool_t *dp = ds->ds_dir->dd_pool;
34dc7c2f 1293
13fe0198
MA
1294 /* temporary clone name must not exist */
1295 error = zap_lookup(dp->dp_meta_objset,
d683ddbb 1296 dsl_dir_phys(ds->ds_dir)->dd_child_dir_zapobj, recv_clone_name,
13fe0198
MA
1297 8, 1, &val);
1298 if (error != ENOENT)
1299 return (error == 0 ? EBUSY : error);
1300
572e2857 1301 /* new snapshot name must not exist */
13fe0198 1302 error = zap_lookup(dp->dp_meta_objset,
d683ddbb
JG
1303 dsl_dataset_phys(ds)->ds_snapnames_zapobj,
1304 drba->drba_cookie->drc_tosnap, 8, 1, &val);
13fe0198
MA
1305 if (error != ENOENT)
1306 return (error == 0 ? EEXIST : error);
572e2857 1307
788eb90c
JJ
1308 /*
1309 * Check snapshot limit before receiving. We'll recheck again at the
1310 * end, but might as well abort before receiving if we're already over
1311 * the limit.
1312 *
1313 * Note that we do not check the file system limit with
1314 * dsl_dir_fscount_check because the temporary %clones don't count
1315 * against that limit.
1316 */
1317 error = dsl_fs_ss_limit_check(ds->ds_dir, 1, ZFS_PROP_SNAPSHOT_LIMIT,
1318 NULL, drba->drba_cred);
1319 if (error != 0)
1320 return (error);
1321
13fe0198 1322 if (fromguid != 0) {
19580676 1323 dsl_dataset_t *snap;
d683ddbb 1324 uint64_t obj = dsl_dataset_phys(ds)->ds_prev_snap_obj;
19580676
MA
1325
1326 /* Find snapshot in this dir that matches fromguid. */
1327 while (obj != 0) {
1328 error = dsl_dataset_hold_obj(dp, obj, FTAG,
1329 &snap);
1330 if (error != 0)
1331 return (SET_ERROR(ENODEV));
1332 if (snap->ds_dir != ds->ds_dir) {
1333 dsl_dataset_rele(snap, FTAG);
1334 return (SET_ERROR(ENODEV));
1335 }
d683ddbb 1336 if (dsl_dataset_phys(snap)->ds_guid == fromguid)
19580676 1337 break;
d683ddbb 1338 obj = dsl_dataset_phys(snap)->ds_prev_snap_obj;
19580676
MA
1339 dsl_dataset_rele(snap, FTAG);
1340 }
1341 if (obj == 0)
2e528b49 1342 return (SET_ERROR(ENODEV));
34dc7c2f 1343
19580676
MA
1344 if (drba->drba_cookie->drc_force) {
1345 drba->drba_snapobj = obj;
1346 } else {
1347 /*
1348 * If we are not forcing, there must be no
1349 * changes since fromsnap.
1350 */
1351 if (dsl_dataset_modified_since_snap(ds, snap)) {
428870ff 1352 dsl_dataset_rele(snap, FTAG);
19580676 1353 return (SET_ERROR(ETXTBSY));
428870ff 1354 }
19580676 1355 drba->drba_snapobj = ds->ds_prev->ds_object;
428870ff 1356 }
19580676
MA
1357
1358 dsl_dataset_rele(snap, FTAG);
428870ff 1359 } else {
cf50a2b0
AG
1360 /* if full, then must be forced */
1361 if (!drba->drba_cookie->drc_force)
1362 return (SET_ERROR(EEXIST));
1363 /* start from $ORIGIN@$ORIGIN, if supported */
1364 drba->drba_snapobj = dp->dp_origin_snap != NULL ?
1365 dp->dp_origin_snap->ds_object : 0;
428870ff 1366 }
34dc7c2f 1367
34dc7c2f 1368 return (0);
13fe0198
MA
1369
1370}
1371
1372static int
1373dmu_recv_begin_check(void *arg, dmu_tx_t *tx)
1374{
1375 dmu_recv_begin_arg_t *drba = arg;
1376 dsl_pool_t *dp = dmu_tx_pool(tx);
1377 struct drr_begin *drrb = drba->drba_cookie->drc_drrb;
1378 uint64_t fromguid = drrb->drr_fromguid;
1379 int flags = drrb->drr_flags;
1380 int error;
9b67f605 1381 uint64_t featureflags = DMU_GET_FEATUREFLAGS(drrb->drr_versioninfo);
13fe0198
MA
1382 dsl_dataset_t *ds;
1383 const char *tofs = drba->drba_cookie->drc_tofs;
1384
1385 /* already checked */
1386 ASSERT3U(drrb->drr_magic, ==, DMU_BACKUP_MAGIC);
47dfff3b 1387 ASSERT(!(featureflags & DMU_BACKUP_FEATURE_RESUMING));
13fe0198
MA
1388
1389 if (DMU_GET_STREAM_HDRTYPE(drrb->drr_versioninfo) ==
1390 DMU_COMPOUNDSTREAM ||
1391 drrb->drr_type >= DMU_OST_NUMTYPES ||
1392 ((flags & DRR_FLAG_CLONE) && drba->drba_origin == NULL))
2e528b49 1393 return (SET_ERROR(EINVAL));
13fe0198
MA
1394
1395 /* Verify pool version supports SA if SA_SPILL feature set */
9b67f605
MA
1396 if ((featureflags & DMU_BACKUP_FEATURE_SA_SPILL) &&
1397 spa_version(dp->dp_spa) < SPA_VERSION_SA)
1398 return (SET_ERROR(ENOTSUP));
1399
47dfff3b
MA
1400 if (drba->drba_cookie->drc_resumable &&
1401 !spa_feature_is_enabled(dp->dp_spa, SPA_FEATURE_EXTENSIBLE_DATASET))
1402 return (SET_ERROR(ENOTSUP));
1403
9b67f605
MA
1404 /*
1405 * The receiving code doesn't know how to translate a WRITE_EMBEDDED
2aa34383 1406 * record to a plain WRITE record, so the pool must have the
9b67f605
MA
1407 * EMBEDDED_DATA feature enabled if the stream has WRITE_EMBEDDED
1408 * records. Same with WRITE_EMBEDDED records that use LZ4 compression.
1409 */
1410 if ((featureflags & DMU_BACKUP_FEATURE_EMBED_DATA) &&
1411 !spa_feature_is_enabled(dp->dp_spa, SPA_FEATURE_EMBEDDED_DATA))
1412 return (SET_ERROR(ENOTSUP));
2aa34383 1413 if ((featureflags & DMU_BACKUP_FEATURE_LZ4) &&
9b67f605 1414 !spa_feature_is_enabled(dp->dp_spa, SPA_FEATURE_LZ4_COMPRESS))
2e528b49 1415 return (SET_ERROR(ENOTSUP));
13fe0198 1416
f1512ee6
MA
1417 /*
1418 * The receiving code doesn't know how to translate large blocks
1419 * to smaller ones, so the pool must have the LARGE_BLOCKS
1420 * feature enabled if the stream has LARGE_BLOCKS.
1421 */
1422 if ((featureflags & DMU_BACKUP_FEATURE_LARGE_BLOCKS) &&
1423 !spa_feature_is_enabled(dp->dp_spa, SPA_FEATURE_LARGE_BLOCKS))
1424 return (SET_ERROR(ENOTSUP));
1425
50c957f7
NB
1426 /*
1427 * The receiving code doesn't know how to translate large dnodes
1428 * to smaller ones, so the pool must have the LARGE_DNODE
1429 * feature enabled if the stream has LARGE_DNODE.
1430 */
1431 if ((featureflags & DMU_BACKUP_FEATURE_LARGE_DNODE) &&
1432 !spa_feature_is_enabled(dp->dp_spa, SPA_FEATURE_LARGE_DNODE))
1433 return (SET_ERROR(ENOTSUP));
1434
13fe0198
MA
1435 error = dsl_dataset_hold(dp, tofs, FTAG, &ds);
1436 if (error == 0) {
1437 /* target fs already exists; recv into temp clone */
1438
1439 /* Can't recv a clone into an existing fs */
e6d3a843 1440 if (flags & DRR_FLAG_CLONE || drba->drba_origin) {
13fe0198 1441 dsl_dataset_rele(ds, FTAG);
2e528b49 1442 return (SET_ERROR(EINVAL));
13fe0198
MA
1443 }
1444
1445 error = recv_begin_check_existing_impl(drba, ds, fromguid);
1446 dsl_dataset_rele(ds, FTAG);
1447 } else if (error == ENOENT) {
1448 /* target fs does not exist; must be a full backup or clone */
eca7b760 1449 char buf[ZFS_MAX_DATASET_NAME_LEN];
13fe0198
MA
1450
1451 /*
1452 * If it's a non-clone incremental, we are missing the
1453 * target fs, so fail the recv.
1454 */
fcff0f35
PD
1455 if (fromguid != 0 && !(flags & DRR_FLAG_CLONE ||
1456 drba->drba_origin))
2e528b49 1457 return (SET_ERROR(ENOENT));
13fe0198 1458
e6d3a843
PD
1459 /*
1460 * If we're receiving a full send as a clone, and it doesn't
1461 * contain all the necessary free records and freeobject
1462 * records, reject it.
1463 */
1464 if (fromguid == 0 && drba->drba_origin &&
1465 !(flags & DRR_FLAG_FREERECORDS))
1466 return (SET_ERROR(EINVAL));
1467
13fe0198 1468 /* Open the parent of tofs */
eca7b760 1469 ASSERT3U(strlen(tofs), <, sizeof (buf));
13fe0198
MA
1470 (void) strlcpy(buf, tofs, strrchr(tofs, '/') - tofs + 1);
1471 error = dsl_dataset_hold(dp, buf, FTAG, &ds);
1472 if (error != 0)
1473 return (error);
1474
788eb90c
JJ
1475 /*
1476 * Check filesystem and snapshot limits before receiving. We'll
1477 * recheck snapshot limits again at the end (we create the
1478 * filesystems and increment those counts during begin_sync).
1479 */
1480 error = dsl_fs_ss_limit_check(ds->ds_dir, 1,
1481 ZFS_PROP_FILESYSTEM_LIMIT, NULL, drba->drba_cred);
1482 if (error != 0) {
1483 dsl_dataset_rele(ds, FTAG);
1484 return (error);
1485 }
1486
1487 error = dsl_fs_ss_limit_check(ds->ds_dir, 1,
1488 ZFS_PROP_SNAPSHOT_LIMIT, NULL, drba->drba_cred);
1489 if (error != 0) {
1490 dsl_dataset_rele(ds, FTAG);
1491 return (error);
1492 }
1493
13fe0198
MA
1494 if (drba->drba_origin != NULL) {
1495 dsl_dataset_t *origin;
1496 error = dsl_dataset_hold(dp, drba->drba_origin,
1497 FTAG, &origin);
1498 if (error != 0) {
1499 dsl_dataset_rele(ds, FTAG);
1500 return (error);
1501 }
0c66c32d 1502 if (!origin->ds_is_snapshot) {
13fe0198
MA
1503 dsl_dataset_rele(origin, FTAG);
1504 dsl_dataset_rele(ds, FTAG);
2e528b49 1505 return (SET_ERROR(EINVAL));
13fe0198 1506 }
e6d3a843
PD
1507 if (dsl_dataset_phys(origin)->ds_guid != fromguid &&
1508 fromguid != 0) {
13fe0198
MA
1509 dsl_dataset_rele(origin, FTAG);
1510 dsl_dataset_rele(ds, FTAG);
2e528b49 1511 return (SET_ERROR(ENODEV));
13fe0198
MA
1512 }
1513 dsl_dataset_rele(origin, FTAG);
1514 }
1515 dsl_dataset_rele(ds, FTAG);
1516 error = 0;
1517 }
1518 return (error);
34dc7c2f
BB
1519}
1520
34dc7c2f 1521static void
13fe0198 1522dmu_recv_begin_sync(void *arg, dmu_tx_t *tx)
34dc7c2f 1523{
13fe0198
MA
1524 dmu_recv_begin_arg_t *drba = arg;
1525 dsl_pool_t *dp = dmu_tx_pool(tx);
47dfff3b 1526 objset_t *mos = dp->dp_meta_objset;
13fe0198
MA
1527 struct drr_begin *drrb = drba->drba_cookie->drc_drrb;
1528 const char *tofs = drba->drba_cookie->drc_tofs;
1529 dsl_dataset_t *ds, *newds;
34dc7c2f 1530 uint64_t dsobj;
13fe0198 1531 int error;
47dfff3b 1532 uint64_t crflags = 0;
13fe0198 1533
47dfff3b
MA
1534 if (drrb->drr_flags & DRR_FLAG_CI_DATA)
1535 crflags |= DS_FLAG_CI_DATASET;
34dc7c2f 1536
13fe0198
MA
1537 error = dsl_dataset_hold(dp, tofs, FTAG, &ds);
1538 if (error == 0) {
1539 /* create temporary clone */
19580676
MA
1540 dsl_dataset_t *snap = NULL;
1541 if (drba->drba_snapobj != 0) {
1542 VERIFY0(dsl_dataset_hold_obj(dp,
1543 drba->drba_snapobj, FTAG, &snap));
1544 }
13fe0198 1545 dsobj = dsl_dataset_create_sync(ds->ds_dir, recv_clone_name,
19580676 1546 snap, crflags, drba->drba_cred, tx);
6b42ea85
PD
1547 if (drba->drba_snapobj != 0)
1548 dsl_dataset_rele(snap, FTAG);
13fe0198
MA
1549 dsl_dataset_rele(ds, FTAG);
1550 } else {
1551 dsl_dir_t *dd;
1552 const char *tail;
1553 dsl_dataset_t *origin = NULL;
1554
1555 VERIFY0(dsl_dir_hold(dp, tofs, FTAG, &dd, &tail));
1556
1557 if (drba->drba_origin != NULL) {
1558 VERIFY0(dsl_dataset_hold(dp, drba->drba_origin,
1559 FTAG, &origin));
1560 }
1561
1562 /* Create new dataset. */
1563 dsobj = dsl_dataset_create_sync(dd,
1564 strrchr(tofs, '/') + 1,
1565 origin, crflags, drba->drba_cred, tx);
1566 if (origin != NULL)
1567 dsl_dataset_rele(origin, FTAG);
1568 dsl_dir_rele(dd, FTAG);
1569 drba->drba_cookie->drc_newfs = B_TRUE;
1570 }
1571 VERIFY0(dsl_dataset_own_obj(dp, dsobj, dmu_recv_tag, &newds));
1572
47dfff3b
MA
1573 if (drba->drba_cookie->drc_resumable) {
1574 uint64_t one = 1;
1575 uint64_t zero = 0;
1576
1577 dsl_dataset_zapify(newds, tx);
1578 if (drrb->drr_fromguid != 0) {
1579 VERIFY0(zap_add(mos, dsobj, DS_FIELD_RESUME_FROMGUID,
1580 8, 1, &drrb->drr_fromguid, tx));
1581 }
1582 VERIFY0(zap_add(mos, dsobj, DS_FIELD_RESUME_TOGUID,
1583 8, 1, &drrb->drr_toguid, tx));
1584 VERIFY0(zap_add(mos, dsobj, DS_FIELD_RESUME_TONAME,
1585 1, strlen(drrb->drr_toname) + 1, drrb->drr_toname, tx));
1586 VERIFY0(zap_add(mos, dsobj, DS_FIELD_RESUME_OBJECT,
1587 8, 1, &one, tx));
1588 VERIFY0(zap_add(mos, dsobj, DS_FIELD_RESUME_OFFSET,
1589 8, 1, &zero, tx));
1590 VERIFY0(zap_add(mos, dsobj, DS_FIELD_RESUME_BYTES,
1591 8, 1, &zero, tx));
2aa34383
DK
1592 if (DMU_GET_FEATUREFLAGS(drrb->drr_versioninfo) &
1593 DMU_BACKUP_FEATURE_LARGE_BLOCKS) {
1594 VERIFY0(zap_add(mos, dsobj, DS_FIELD_RESUME_LARGEBLOCK,
02730c33 1595 8, 1, &one, tx));
2aa34383 1596 }
47dfff3b
MA
1597 if (DMU_GET_FEATUREFLAGS(drrb->drr_versioninfo) &
1598 DMU_BACKUP_FEATURE_EMBED_DATA) {
1599 VERIFY0(zap_add(mos, dsobj, DS_FIELD_RESUME_EMBEDOK,
1600 8, 1, &one, tx));
1601 }
2aa34383
DK
1602 if (DMU_GET_FEATUREFLAGS(drrb->drr_versioninfo) &
1603 DMU_BACKUP_FEATURE_COMPRESSED) {
1604 VERIFY0(zap_add(mos, dsobj, DS_FIELD_RESUME_COMPRESSOK,
1605 8, 1, &one, tx));
1606 }
47dfff3b
MA
1607 }
1608
13fe0198 1609 dmu_buf_will_dirty(newds->ds_dbuf, tx);
d683ddbb 1610 dsl_dataset_phys(newds)->ds_flags |= DS_FLAG_INCONSISTENT;
34dc7c2f 1611
428870ff
BB
1612 /*
1613 * If we actually created a non-clone, we need to create the
1614 * objset in our new dataset.
1615 */
13fe0198 1616 if (BP_IS_HOLE(dsl_dataset_get_blkptr(newds))) {
428870ff 1617 (void) dmu_objset_create_impl(dp->dp_spa,
13fe0198 1618 newds, dsl_dataset_get_blkptr(newds), drrb->drr_type, tx);
428870ff 1619 }
34dc7c2f 1620
13fe0198 1621 drba->drba_cookie->drc_ds = newds;
428870ff 1622
13fe0198 1623 spa_history_log_internal_ds(newds, "receive", tx, "");
34dc7c2f
BB
1624}
1625
47dfff3b
MA
1626static int
1627dmu_recv_resume_begin_check(void *arg, dmu_tx_t *tx)
1628{
1629 dmu_recv_begin_arg_t *drba = arg;
1630 dsl_pool_t *dp = dmu_tx_pool(tx);
1631 struct drr_begin *drrb = drba->drba_cookie->drc_drrb;
1632 int error;
1633 uint64_t featureflags = DMU_GET_FEATUREFLAGS(drrb->drr_versioninfo);
1634 dsl_dataset_t *ds;
1635 const char *tofs = drba->drba_cookie->drc_tofs;
47dfff3b
MA
1636 uint64_t val;
1637
eca7b760
IK
1638 /* 6 extra bytes for /%recv */
1639 char recvname[ZFS_MAX_DATASET_NAME_LEN + 6];
1640
47dfff3b
MA
1641 /* already checked */
1642 ASSERT3U(drrb->drr_magic, ==, DMU_BACKUP_MAGIC);
1643 ASSERT(featureflags & DMU_BACKUP_FEATURE_RESUMING);
1644
1645 if (DMU_GET_STREAM_HDRTYPE(drrb->drr_versioninfo) ==
1646 DMU_COMPOUNDSTREAM ||
1647 drrb->drr_type >= DMU_OST_NUMTYPES)
1648 return (SET_ERROR(EINVAL));
1649
1650 /* Verify pool version supports SA if SA_SPILL feature set */
1651 if ((featureflags & DMU_BACKUP_FEATURE_SA_SPILL) &&
1652 spa_version(dp->dp_spa) < SPA_VERSION_SA)
1653 return (SET_ERROR(ENOTSUP));
1654
1655 /*
1656 * The receiving code doesn't know how to translate a WRITE_EMBEDDED
1657 * record to a plain WRITE record, so the pool must have the
1658 * EMBEDDED_DATA feature enabled if the stream has WRITE_EMBEDDED
1659 * records. Same with WRITE_EMBEDDED records that use LZ4 compression.
1660 */
1661 if ((featureflags & DMU_BACKUP_FEATURE_EMBED_DATA) &&
1662 !spa_feature_is_enabled(dp->dp_spa, SPA_FEATURE_EMBEDDED_DATA))
1663 return (SET_ERROR(ENOTSUP));
2aa34383 1664 if ((featureflags & DMU_BACKUP_FEATURE_LZ4) &&
47dfff3b
MA
1665 !spa_feature_is_enabled(dp->dp_spa, SPA_FEATURE_LZ4_COMPRESS))
1666 return (SET_ERROR(ENOTSUP));
1667
1668 (void) snprintf(recvname, sizeof (recvname), "%s/%s",
1669 tofs, recv_clone_name);
1670
1671 if (dsl_dataset_hold(dp, recvname, FTAG, &ds) != 0) {
1672 /* %recv does not exist; continue in tofs */
1673 error = dsl_dataset_hold(dp, tofs, FTAG, &ds);
1674 if (error != 0)
1675 return (error);
1676 }
1677
1678 /* check that ds is marked inconsistent */
1679 if (!DS_IS_INCONSISTENT(ds)) {
1680 dsl_dataset_rele(ds, FTAG);
1681 return (SET_ERROR(EINVAL));
1682 }
1683
1684 /* check that there is resuming data, and that the toguid matches */
1685 if (!dsl_dataset_is_zapified(ds)) {
1686 dsl_dataset_rele(ds, FTAG);
1687 return (SET_ERROR(EINVAL));
1688 }
1689 error = zap_lookup(dp->dp_meta_objset, ds->ds_object,
1690 DS_FIELD_RESUME_TOGUID, sizeof (val), 1, &val);
1691 if (error != 0 || drrb->drr_toguid != val) {
1692 dsl_dataset_rele(ds, FTAG);
1693 return (SET_ERROR(EINVAL));
1694 }
1695
1696 /*
1697 * Check if the receive is still running. If so, it will be owned.
1698 * Note that nothing else can own the dataset (e.g. after the receive
1699 * fails) because it will be marked inconsistent.
1700 */
1701 if (dsl_dataset_has_owner(ds)) {
1702 dsl_dataset_rele(ds, FTAG);
1703 return (SET_ERROR(EBUSY));
1704 }
1705
1706 /* There should not be any snapshots of this fs yet. */
1707 if (ds->ds_prev != NULL && ds->ds_prev->ds_dir == ds->ds_dir) {
1708 dsl_dataset_rele(ds, FTAG);
1709 return (SET_ERROR(EINVAL));
1710 }
1711
1712 /*
1713 * Note: resume point will be checked when we process the first WRITE
1714 * record.
1715 */
1716
1717 /* check that the origin matches */
1718 val = 0;
1719 (void) zap_lookup(dp->dp_meta_objset, ds->ds_object,
1720 DS_FIELD_RESUME_FROMGUID, sizeof (val), 1, &val);
1721 if (drrb->drr_fromguid != val) {
1722 dsl_dataset_rele(ds, FTAG);
1723 return (SET_ERROR(EINVAL));
1724 }
1725
1726 dsl_dataset_rele(ds, FTAG);
1727 return (0);
1728}
1729
1730static void
1731dmu_recv_resume_begin_sync(void *arg, dmu_tx_t *tx)
1732{
1733 dmu_recv_begin_arg_t *drba = arg;
1734 dsl_pool_t *dp = dmu_tx_pool(tx);
1735 const char *tofs = drba->drba_cookie->drc_tofs;
1736 dsl_dataset_t *ds;
1737 uint64_t dsobj;
eca7b760
IK
1738 /* 6 extra bytes for /%recv */
1739 char recvname[ZFS_MAX_DATASET_NAME_LEN + 6];
47dfff3b
MA
1740
1741 (void) snprintf(recvname, sizeof (recvname), "%s/%s",
1742 tofs, recv_clone_name);
1743
1744 if (dsl_dataset_hold(dp, recvname, FTAG, &ds) != 0) {
1745 /* %recv does not exist; continue in tofs */
1746 VERIFY0(dsl_dataset_hold(dp, tofs, FTAG, &ds));
1747 drba->drba_cookie->drc_newfs = B_TRUE;
1748 }
1749
1750 /* clear the inconsistent flag so that we can own it */
1751 ASSERT(DS_IS_INCONSISTENT(ds));
1752 dmu_buf_will_dirty(ds->ds_dbuf, tx);
1753 dsl_dataset_phys(ds)->ds_flags &= ~DS_FLAG_INCONSISTENT;
1754 dsobj = ds->ds_object;
1755 dsl_dataset_rele(ds, FTAG);
1756
1757 VERIFY0(dsl_dataset_own_obj(dp, dsobj, dmu_recv_tag, &ds));
1758
1759 dmu_buf_will_dirty(ds->ds_dbuf, tx);
1760 dsl_dataset_phys(ds)->ds_flags |= DS_FLAG_INCONSISTENT;
1761
1762 ASSERT(!BP_IS_HOLE(dsl_dataset_get_blkptr(ds)));
1763
1764 drba->drba_cookie->drc_ds = ds;
1765
1766 spa_history_log_internal_ds(ds, "resume receive", tx, "");
1767}
1768
34dc7c2f
BB
1769/*
1770 * NB: callers *MUST* call dmu_recv_stream() if dmu_recv_begin()
1771 * succeeds; otherwise we will leak the holds on the datasets.
1772 */
1773int
47dfff3b
MA
1774dmu_recv_begin(char *tofs, char *tosnap, dmu_replay_record_t *drr_begin,
1775 boolean_t force, boolean_t resumable, char *origin, dmu_recv_cookie_t *drc)
34dc7c2f 1776{
13fe0198 1777 dmu_recv_begin_arg_t drba = { 0 };
34dc7c2f
BB
1778
1779 bzero(drc, sizeof (dmu_recv_cookie_t));
47dfff3b
MA
1780 drc->drc_drr_begin = drr_begin;
1781 drc->drc_drrb = &drr_begin->drr_u.drr_begin;
34dc7c2f 1782 drc->drc_tosnap = tosnap;
13fe0198 1783 drc->drc_tofs = tofs;
34dc7c2f 1784 drc->drc_force = force;
47dfff3b 1785 drc->drc_resumable = resumable;
788eb90c 1786 drc->drc_cred = CRED();
34dc7c2f 1787
47dfff3b 1788 if (drc->drc_drrb->drr_magic == BSWAP_64(DMU_BACKUP_MAGIC)) {
13fe0198 1789 drc->drc_byteswap = B_TRUE;
a6255b7f 1790 (void) fletcher_4_incremental_byteswap(drr_begin,
13fe0198 1791 sizeof (dmu_replay_record_t), &drc->drc_cksum);
47dfff3b
MA
1792 byteswap_record(drr_begin);
1793 } else if (drc->drc_drrb->drr_magic == DMU_BACKUP_MAGIC) {
a6255b7f 1794 (void) fletcher_4_incremental_native(drr_begin,
13fe0198 1795 sizeof (dmu_replay_record_t), &drc->drc_cksum);
47dfff3b
MA
1796 } else {
1797 return (SET_ERROR(EINVAL));
34dc7c2f
BB
1798 }
1799
13fe0198
MA
1800 drba.drba_origin = origin;
1801 drba.drba_cookie = drc;
1802 drba.drba_cred = CRED();
1803
47dfff3b
MA
1804 if (DMU_GET_FEATUREFLAGS(drc->drc_drrb->drr_versioninfo) &
1805 DMU_BACKUP_FEATURE_RESUMING) {
1806 return (dsl_sync_task(tofs,
1807 dmu_recv_resume_begin_check, dmu_recv_resume_begin_sync,
1808 &drba, 5, ZFS_SPACE_CHECK_NORMAL));
1809 } else {
1810 return (dsl_sync_task(tofs,
1811 dmu_recv_begin_check, dmu_recv_begin_sync,
1812 &drba, 5, ZFS_SPACE_CHECK_NORMAL));
1813 }
34dc7c2f
BB
1814}
1815
fcff0f35
PD
1816struct receive_record_arg {
1817 dmu_replay_record_t header;
1818 void *payload; /* Pointer to a buffer containing the payload */
1819 /*
1820 * If the record is a write, pointer to the arc_buf_t containing the
1821 * payload.
1822 */
1823 arc_buf_t *write_buf;
1824 int payload_size;
47dfff3b 1825 uint64_t bytes_read; /* bytes read from stream when record created */
fcff0f35
PD
1826 boolean_t eos_marker; /* Marks the end of the stream */
1827 bqueue_node_t node;
1828};
1829
1830struct receive_writer_arg {
37f8a883 1831 objset_t *os;
13fe0198 1832 boolean_t byteswap;
fcff0f35 1833 bqueue_t q;
47dfff3b 1834
fcff0f35
PD
1835 /*
1836 * These three args are used to signal to the main thread that we're
1837 * done.
1838 */
1839 kmutex_t mutex;
1840 kcondvar_t cv;
1841 boolean_t done;
47dfff3b 1842
fcff0f35
PD
1843 int err;
1844 /* A map from guid to dataset to help handle dedup'd streams. */
1845 avl_tree_t *guid_to_ds_map;
47dfff3b
MA
1846 boolean_t resumable;
1847 uint64_t last_object, last_offset;
1848 uint64_t bytes_read; /* bytes read when current record created */
fcff0f35 1849};
37f8a883 1850
e6d3a843
PD
1851struct objlist {
1852 list_t list; /* List of struct receive_objnode. */
1853 /*
1854 * Last object looked up. Used to assert that objects are being looked
1855 * up in ascending order.
1856 */
1857 uint64_t last_lookup;
1858};
1859
1860struct receive_objnode {
1861 list_node_t node;
1862 uint64_t object;
1863};
1864
fcff0f35
PD
1865struct receive_arg {
1866 objset_t *os;
1867 vnode_t *vp; /* The vnode to read the stream from */
1868 uint64_t voff; /* The current offset in the stream */
47dfff3b 1869 uint64_t bytes_read;
fcff0f35
PD
1870 /*
1871 * A record that has had its payload read in, but hasn't yet been handed
1872 * off to the worker thread.
1873 */
1874 struct receive_record_arg *rrd;
1875 /* A record that has had its header read in, but not its payload. */
1876 struct receive_record_arg *next_rrd;
34dc7c2f 1877 zio_cksum_t cksum;
37f8a883 1878 zio_cksum_t prev_cksum;
fcff0f35
PD
1879 int err;
1880 boolean_t byteswap;
1881 /* Sorted list of objects not to issue prefetches for. */
e6d3a843 1882 struct objlist ignore_objlist;
34dc7c2f
BB
1883};
1884
428870ff
BB
1885typedef struct guid_map_entry {
1886 uint64_t guid;
1887 dsl_dataset_t *gme_ds;
1888 avl_node_t avlnode;
1889} guid_map_entry_t;
1890
1891static int
1892guid_compare(const void *arg1, const void *arg2)
1893{
ee36c709
GN
1894 const guid_map_entry_t *gmep1 = (const guid_map_entry_t *)arg1;
1895 const guid_map_entry_t *gmep2 = (const guid_map_entry_t *)arg2;
428870ff 1896
ee36c709 1897 return (AVL_CMP(gmep1->guid, gmep2->guid));
428870ff
BB
1898}
1899
572e2857
BB
1900static void
1901free_guid_map_onexit(void *arg)
1902{
1903 avl_tree_t *ca = arg;
1904 void *cookie = NULL;
1905 guid_map_entry_t *gmep;
1906
1907 while ((gmep = avl_destroy_nodes(ca, &cookie)) != NULL) {
13fe0198 1908 dsl_dataset_long_rele(gmep->gme_ds, gmep);
7ec09286 1909 dsl_dataset_rele(gmep->gme_ds, gmep);
572e2857
BB
1910 kmem_free(gmep, sizeof (guid_map_entry_t));
1911 }
1912 avl_destroy(ca);
1913 kmem_free(ca, sizeof (avl_tree_t));
1914}
1915
37f8a883 1916static int
fcff0f35 1917receive_read(struct receive_arg *ra, int len, void *buf)
34dc7c2f 1918{
34dc7c2f
BB
1919 int done = 0;
1920
f8866f8a
ER
1921 /*
1922 * The code doesn't rely on this (lengths being multiples of 8). See
1923 * comment in dump_bytes.
1924 */
c99c9001 1925 ASSERT0(len % 8);
34dc7c2f
BB
1926
1927 while (done < len) {
1928 ssize_t resid;
1929
1930 ra->err = vn_rdwr(UIO_READ, ra->vp,
37f8a883 1931 (char *)buf + done, len - done,
34dc7c2f
BB
1932 ra->voff, UIO_SYSSPACE, FAPPEND,
1933 RLIM64_INFINITY, CRED(), &resid);
1934
47dfff3b
MA
1935 if (resid == len - done) {
1936 /*
1937 * Note: ECKSUM indicates that the receive
1938 * was interrupted and can potentially be resumed.
1939 */
1940 ra->err = SET_ERROR(ECKSUM);
1941 }
34dc7c2f
BB
1942 ra->voff += len - done - resid;
1943 done = len - resid;
13fe0198 1944 if (ra->err != 0)
37f8a883 1945 return (ra->err);
34dc7c2f
BB
1946 }
1947
47dfff3b
MA
1948 ra->bytes_read += len;
1949
34dc7c2f 1950 ASSERT3U(done, ==, len);
37f8a883 1951 return (0);
34dc7c2f
BB
1952}
1953
60948de1 1954noinline static void
37f8a883 1955byteswap_record(dmu_replay_record_t *drr)
34dc7c2f
BB
1956{
1957#define DO64(X) (drr->drr_u.X = BSWAP_64(drr->drr_u.X))
1958#define DO32(X) (drr->drr_u.X = BSWAP_32(drr->drr_u.X))
1959 drr->drr_type = BSWAP_32(drr->drr_type);
1960 drr->drr_payloadlen = BSWAP_32(drr->drr_payloadlen);
37f8a883 1961
34dc7c2f
BB
1962 switch (drr->drr_type) {
1963 case DRR_BEGIN:
1964 DO64(drr_begin.drr_magic);
428870ff 1965 DO64(drr_begin.drr_versioninfo);
34dc7c2f
BB
1966 DO64(drr_begin.drr_creation_time);
1967 DO32(drr_begin.drr_type);
1968 DO32(drr_begin.drr_flags);
1969 DO64(drr_begin.drr_toguid);
1970 DO64(drr_begin.drr_fromguid);
1971 break;
1972 case DRR_OBJECT:
1973 DO64(drr_object.drr_object);
34dc7c2f
BB
1974 DO32(drr_object.drr_type);
1975 DO32(drr_object.drr_bonustype);
1976 DO32(drr_object.drr_blksz);
1977 DO32(drr_object.drr_bonuslen);
428870ff 1978 DO64(drr_object.drr_toguid);
34dc7c2f
BB
1979 break;
1980 case DRR_FREEOBJECTS:
1981 DO64(drr_freeobjects.drr_firstobj);
1982 DO64(drr_freeobjects.drr_numobjs);
428870ff 1983 DO64(drr_freeobjects.drr_toguid);
34dc7c2f
BB
1984 break;
1985 case DRR_WRITE:
1986 DO64(drr_write.drr_object);
1987 DO32(drr_write.drr_type);
1988 DO64(drr_write.drr_offset);
2aa34383 1989 DO64(drr_write.drr_logical_size);
428870ff 1990 DO64(drr_write.drr_toguid);
37f8a883 1991 ZIO_CHECKSUM_BSWAP(&drr->drr_u.drr_write.drr_key.ddk_cksum);
428870ff 1992 DO64(drr_write.drr_key.ddk_prop);
2aa34383 1993 DO64(drr_write.drr_compressed_size);
428870ff
BB
1994 break;
1995 case DRR_WRITE_BYREF:
1996 DO64(drr_write_byref.drr_object);
1997 DO64(drr_write_byref.drr_offset);
1998 DO64(drr_write_byref.drr_length);
1999 DO64(drr_write_byref.drr_toguid);
2000 DO64(drr_write_byref.drr_refguid);
2001 DO64(drr_write_byref.drr_refobject);
2002 DO64(drr_write_byref.drr_refoffset);
37f8a883
MA
2003 ZIO_CHECKSUM_BSWAP(&drr->drr_u.drr_write_byref.
2004 drr_key.ddk_cksum);
428870ff 2005 DO64(drr_write_byref.drr_key.ddk_prop);
34dc7c2f 2006 break;
9b67f605
MA
2007 case DRR_WRITE_EMBEDDED:
2008 DO64(drr_write_embedded.drr_object);
2009 DO64(drr_write_embedded.drr_offset);
2010 DO64(drr_write_embedded.drr_length);
2011 DO64(drr_write_embedded.drr_toguid);
2012 DO32(drr_write_embedded.drr_lsize);
2013 DO32(drr_write_embedded.drr_psize);
2014 break;
34dc7c2f
BB
2015 case DRR_FREE:
2016 DO64(drr_free.drr_object);
2017 DO64(drr_free.drr_offset);
2018 DO64(drr_free.drr_length);
428870ff
BB
2019 DO64(drr_free.drr_toguid);
2020 break;
2021 case DRR_SPILL:
2022 DO64(drr_spill.drr_object);
2023 DO64(drr_spill.drr_length);
2024 DO64(drr_spill.drr_toguid);
34dc7c2f
BB
2025 break;
2026 case DRR_END:
428870ff 2027 DO64(drr_end.drr_toguid);
37f8a883 2028 ZIO_CHECKSUM_BSWAP(&drr->drr_u.drr_end.drr_checksum);
34dc7c2f 2029 break;
e75c13c3
BB
2030 default:
2031 break;
34dc7c2f 2032 }
37f8a883
MA
2033
2034 if (drr->drr_type != DRR_BEGIN) {
2035 ZIO_CHECKSUM_BSWAP(&drr->drr_u.drr_checksum.drr_checksum);
2036 }
2037
34dc7c2f
BB
2038#undef DO64
2039#undef DO32
2040}
2041
6c59307a
MA
2042static inline uint8_t
2043deduce_nblkptr(dmu_object_type_t bonus_type, uint64_t bonus_size)
2044{
2045 if (bonus_type == DMU_OT_SA) {
2046 return (1);
2047 } else {
2048 return (1 +
50c957f7
NB
2049 ((DN_OLD_MAX_BONUSLEN -
2050 MIN(DN_OLD_MAX_BONUSLEN, bonus_size)) >> SPA_BLKPTRSHIFT));
6c59307a
MA
2051 }
2052}
2053
47dfff3b
MA
2054static void
2055save_resume_state(struct receive_writer_arg *rwa,
2056 uint64_t object, uint64_t offset, dmu_tx_t *tx)
2057{
2058 int txgoff = dmu_tx_get_txg(tx) & TXG_MASK;
2059
2060 if (!rwa->resumable)
2061 return;
2062
2063 /*
2064 * We use ds_resume_bytes[] != 0 to indicate that we need to
2065 * update this on disk, so it must not be 0.
2066 */
2067 ASSERT(rwa->bytes_read != 0);
2068
2069 /*
2070 * We only resume from write records, which have a valid
2071 * (non-meta-dnode) object number.
2072 */
2073 ASSERT(object != 0);
2074
2075 /*
2076 * For resuming to work correctly, we must receive records in order,
2077 * sorted by object,offset. This is checked by the callers, but
2078 * assert it here for good measure.
2079 */
2080 ASSERT3U(object, >=, rwa->os->os_dsl_dataset->ds_resume_object[txgoff]);
2081 ASSERT(object != rwa->os->os_dsl_dataset->ds_resume_object[txgoff] ||
2082 offset >= rwa->os->os_dsl_dataset->ds_resume_offset[txgoff]);
2083 ASSERT3U(rwa->bytes_read, >=,
2084 rwa->os->os_dsl_dataset->ds_resume_bytes[txgoff]);
2085
2086 rwa->os->os_dsl_dataset->ds_resume_object[txgoff] = object;
2087 rwa->os->os_dsl_dataset->ds_resume_offset[txgoff] = offset;
2088 rwa->os->os_dsl_dataset->ds_resume_bytes[txgoff] = rwa->bytes_read;
2089}
2090
60948de1 2091noinline static int
fcff0f35 2092receive_object(struct receive_writer_arg *rwa, struct drr_object *drro,
4ea3f864 2093 void *data)
34dc7c2f 2094{
6c59307a 2095 dmu_object_info_t doi;
34dc7c2f 2096 dmu_tx_t *tx;
6c59307a
MA
2097 uint64_t object;
2098 int err;
34dc7c2f 2099
34dc7c2f 2100 if (drro->drr_type == DMU_OT_NONE ||
9ae529ec
CS
2101 !DMU_OT_IS_VALID(drro->drr_type) ||
2102 !DMU_OT_IS_VALID(drro->drr_bonustype) ||
428870ff 2103 drro->drr_checksumtype >= ZIO_CHECKSUM_FUNCTIONS ||
34dc7c2f
BB
2104 drro->drr_compress >= ZIO_COMPRESS_FUNCTIONS ||
2105 P2PHASE(drro->drr_blksz, SPA_MINBLOCKSIZE) ||
2106 drro->drr_blksz < SPA_MINBLOCKSIZE ||
fcff0f35 2107 drro->drr_blksz > spa_maxblocksize(dmu_objset_spa(rwa->os)) ||
50c957f7
NB
2108 drro->drr_bonuslen >
2109 DN_BONUS_SIZE(spa_maxdnodesize(dmu_objset_spa(rwa->os)))) {
2e528b49 2110 return (SET_ERROR(EINVAL));
34dc7c2f
BB
2111 }
2112
fcff0f35 2113 err = dmu_object_info(rwa->os, drro->drr_object, &doi);
9babb374
BB
2114
2115 if (err != 0 && err != ENOENT)
2e528b49 2116 return (SET_ERROR(EINVAL));
6c59307a 2117 object = err == 0 ? drro->drr_object : DMU_NEW_OBJECT;
9babb374 2118
6c59307a
MA
2119 /*
2120 * If we are losing blkptrs or changing the block size this must
2121 * be a new file instance. We must clear out the previous file
2122 * contents before we can change this type of metadata in the dnode.
2123 */
2124 if (err == 0) {
2125 int nblkptr;
2126
2127 nblkptr = deduce_nblkptr(drro->drr_bonustype,
2128 drro->drr_bonuslen);
2129
2130 if (drro->drr_blksz != doi.doi_data_block_size ||
2131 nblkptr < doi.doi_nblkptr) {
fcff0f35 2132 err = dmu_free_long_range(rwa->os, drro->drr_object,
6c59307a
MA
2133 0, DMU_OBJECT_END);
2134 if (err != 0)
2135 return (SET_ERROR(EINVAL));
34dc7c2f 2136 }
6c59307a
MA
2137 }
2138
fcff0f35 2139 tx = dmu_tx_create(rwa->os);
6c59307a
MA
2140 dmu_tx_hold_bonus(tx, object);
2141 err = dmu_tx_assign(tx, TXG_WAIT);
2142 if (err != 0) {
2143 dmu_tx_abort(tx);
2144 return (err);
2145 }
2146
2147 if (object == DMU_NEW_OBJECT) {
2148 /* currently free, want to be allocated */
50c957f7 2149 err = dmu_object_claim_dnsize(rwa->os, drro->drr_object,
34dc7c2f 2150 drro->drr_type, drro->drr_blksz,
50c957f7
NB
2151 drro->drr_bonustype, drro->drr_bonuslen,
2152 drro->drr_dn_slots << DNODE_SHIFT, tx);
6c59307a
MA
2153 } else if (drro->drr_type != doi.doi_type ||
2154 drro->drr_blksz != doi.doi_data_block_size ||
2155 drro->drr_bonustype != doi.doi_bonus_type ||
2156 drro->drr_bonuslen != doi.doi_bonus_size) {
2157 /* currently allocated, but with different properties */
fcff0f35 2158 err = dmu_object_reclaim(rwa->os, drro->drr_object,
34dc7c2f 2159 drro->drr_type, drro->drr_blksz,
6c59307a 2160 drro->drr_bonustype, drro->drr_bonuslen, tx);
34dc7c2f 2161 }
13fe0198 2162 if (err != 0) {
6c59307a 2163 dmu_tx_commit(tx);
2e528b49 2164 return (SET_ERROR(EINVAL));
428870ff 2165 }
9babb374 2166
fcff0f35 2167 dmu_object_set_checksum(rwa->os, drro->drr_object,
37f8a883 2168 drro->drr_checksumtype, tx);
fcff0f35 2169 dmu_object_set_compress(rwa->os, drro->drr_object,
37f8a883 2170 drro->drr_compress, tx);
34dc7c2f 2171
b128c09f 2172 if (data != NULL) {
34dc7c2f 2173 dmu_buf_t *db;
b128c09f 2174
fcff0f35 2175 VERIFY0(dmu_bonus_hold(rwa->os, drro->drr_object, FTAG, &db));
34dc7c2f
BB
2176 dmu_buf_will_dirty(db, tx);
2177
2178 ASSERT3U(db->db_size, >=, drro->drr_bonuslen);
34dc7c2f 2179 bcopy(data, db->db_data, drro->drr_bonuslen);
fcff0f35 2180 if (rwa->byteswap) {
9ae529ec
CS
2181 dmu_object_byteswap_t byteswap =
2182 DMU_OT_BYTESWAP(drro->drr_bonustype);
2183 dmu_ot_byteswap[byteswap].ob_func(db->db_data,
34dc7c2f
BB
2184 drro->drr_bonuslen);
2185 }
2186 dmu_buf_rele(db, FTAG);
2187 }
2188 dmu_tx_commit(tx);
47dfff3b 2189
34dc7c2f
BB
2190 return (0);
2191}
2192
2193/* ARGSUSED */
60948de1 2194noinline static int
fcff0f35 2195receive_freeobjects(struct receive_writer_arg *rwa,
34dc7c2f
BB
2196 struct drr_freeobjects *drrfo)
2197{
2198 uint64_t obj;
e6d3a843 2199 int next_err = 0;
34dc7c2f
BB
2200
2201 if (drrfo->drr_firstobj + drrfo->drr_numobjs < drrfo->drr_firstobj)
2e528b49 2202 return (SET_ERROR(EINVAL));
34dc7c2f 2203
50c957f7 2204 for (obj = drrfo->drr_firstobj == 0 ? 1 : drrfo->drr_firstobj;
e6d3a843
PD
2205 obj < drrfo->drr_firstobj + drrfo->drr_numobjs && next_err == 0;
2206 next_err = dmu_object_next(rwa->os, &obj, FALSE, 0)) {
50c957f7 2207 dmu_object_info_t doi;
34dc7c2f
BB
2208 int err;
2209
50c957f7
NB
2210 err = dmu_object_info(rwa->os, obj, &doi);
2211 if (err == ENOENT) {
2212 obj++;
34dc7c2f 2213 continue;
50c957f7
NB
2214 } else if (err != 0) {
2215 return (err);
2216 }
34dc7c2f 2217
fcff0f35 2218 err = dmu_free_long_object(rwa->os, obj);
13fe0198 2219 if (err != 0)
34dc7c2f 2220 return (err);
34dc7c2f 2221 }
e6d3a843
PD
2222 if (next_err != ESRCH)
2223 return (next_err);
34dc7c2f
BB
2224 return (0);
2225}
2226
60948de1 2227noinline static int
fcff0f35 2228receive_write(struct receive_writer_arg *rwa, struct drr_write *drrw,
4ea3f864 2229 arc_buf_t *abuf)
34dc7c2f
BB
2230{
2231 dmu_tx_t *tx;
88904bb3 2232 dmu_buf_t *bonus;
34dc7c2f
BB
2233 int err;
2234
2aa34383 2235 if (drrw->drr_offset + drrw->drr_logical_size < drrw->drr_offset ||
9ae529ec 2236 !DMU_OT_IS_VALID(drrw->drr_type))
2e528b49 2237 return (SET_ERROR(EINVAL));
34dc7c2f 2238
47dfff3b
MA
2239 /*
2240 * For resuming to work, records must be in increasing order
2241 * by (object, offset).
2242 */
2243 if (drrw->drr_object < rwa->last_object ||
2244 (drrw->drr_object == rwa->last_object &&
2245 drrw->drr_offset < rwa->last_offset)) {
2246 return (SET_ERROR(EINVAL));
2247 }
2248 rwa->last_object = drrw->drr_object;
2249 rwa->last_offset = drrw->drr_offset;
2250
fcff0f35 2251 if (dmu_object_info(rwa->os, drrw->drr_object, NULL) != 0)
88904bb3
MA
2252 return (SET_ERROR(EINVAL));
2253
fcff0f35 2254 tx = dmu_tx_create(rwa->os);
34dc7c2f
BB
2255
2256 dmu_tx_hold_write(tx, drrw->drr_object,
2aa34383 2257 drrw->drr_offset, drrw->drr_logical_size);
34dc7c2f 2258 err = dmu_tx_assign(tx, TXG_WAIT);
13fe0198 2259 if (err != 0) {
34dc7c2f
BB
2260 dmu_tx_abort(tx);
2261 return (err);
2262 }
fcff0f35 2263 if (rwa->byteswap) {
9ae529ec
CS
2264 dmu_object_byteswap_t byteswap =
2265 DMU_OT_BYTESWAP(drrw->drr_type);
37f8a883 2266 dmu_ot_byteswap[byteswap].ob_func(abuf->b_data,
2aa34383 2267 DRR_WRITE_PAYLOAD_SIZE(drrw));
9ae529ec 2268 }
37f8a883 2269
2aa34383 2270 /* use the bonus buf to look up the dnode in dmu_assign_arcbuf */
fcff0f35 2271 if (dmu_bonus_hold(rwa->os, drrw->drr_object, FTAG, &bonus) != 0)
37f8a883 2272 return (SET_ERROR(EINVAL));
88904bb3 2273 dmu_assign_arcbuf(bonus, drrw->drr_offset, abuf, tx);
47dfff3b
MA
2274
2275 /*
2276 * Note: If the receive fails, we want the resume stream to start
2277 * with the same record that we last successfully received (as opposed
2278 * to the next record), so that we can verify that we are
2279 * resuming from the correct location.
2280 */
2281 save_resume_state(rwa, drrw->drr_object, drrw->drr_offset, tx);
34dc7c2f 2282 dmu_tx_commit(tx);
88904bb3 2283 dmu_buf_rele(bonus, FTAG);
47dfff3b 2284
34dc7c2f
BB
2285 return (0);
2286}
2287
428870ff
BB
2288/*
2289 * Handle a DRR_WRITE_BYREF record. This record is used in dedup'ed
2290 * streams to refer to a copy of the data that is already on the
2291 * system because it came in earlier in the stream. This function
2292 * finds the earlier copy of the data, and uses that copy instead of
2293 * data from the stream to fulfill this write.
2294 */
2295static int
fcff0f35
PD
2296receive_write_byref(struct receive_writer_arg *rwa,
2297 struct drr_write_byref *drrwbr)
428870ff
BB
2298{
2299 dmu_tx_t *tx;
2300 int err;
2301 guid_map_entry_t gmesrch;
2302 guid_map_entry_t *gmep;
9b67f605 2303 avl_index_t where;
428870ff
BB
2304 objset_t *ref_os = NULL;
2305 dmu_buf_t *dbp;
2306
2307 if (drrwbr->drr_offset + drrwbr->drr_length < drrwbr->drr_offset)
2e528b49 2308 return (SET_ERROR(EINVAL));
428870ff
BB
2309
2310 /*
2311 * If the GUID of the referenced dataset is different from the
2312 * GUID of the target dataset, find the referenced dataset.
2313 */
2314 if (drrwbr->drr_toguid != drrwbr->drr_refguid) {
2315 gmesrch.guid = drrwbr->drr_refguid;
fcff0f35 2316 if ((gmep = avl_find(rwa->guid_to_ds_map, &gmesrch,
428870ff 2317 &where)) == NULL) {
2e528b49 2318 return (SET_ERROR(EINVAL));
428870ff
BB
2319 }
2320 if (dmu_objset_from_ds(gmep->gme_ds, &ref_os))
2e528b49 2321 return (SET_ERROR(EINVAL));
428870ff 2322 } else {
fcff0f35 2323 ref_os = rwa->os;
428870ff
BB
2324 }
2325
c65aa5b2
BB
2326 err = dmu_buf_hold(ref_os, drrwbr->drr_refobject,
2327 drrwbr->drr_refoffset, FTAG, &dbp, DMU_READ_PREFETCH);
9b67f605 2328 if (err != 0)
428870ff
BB
2329 return (err);
2330
fcff0f35 2331 tx = dmu_tx_create(rwa->os);
428870ff
BB
2332
2333 dmu_tx_hold_write(tx, drrwbr->drr_object,
2334 drrwbr->drr_offset, drrwbr->drr_length);
2335 err = dmu_tx_assign(tx, TXG_WAIT);
13fe0198 2336 if (err != 0) {
428870ff
BB
2337 dmu_tx_abort(tx);
2338 return (err);
2339 }
fcff0f35 2340 dmu_write(rwa->os, drrwbr->drr_object,
428870ff
BB
2341 drrwbr->drr_offset, drrwbr->drr_length, dbp->db_data, tx);
2342 dmu_buf_rele(dbp, FTAG);
47dfff3b
MA
2343
2344 /* See comment in restore_write. */
2345 save_resume_state(rwa, drrwbr->drr_object, drrwbr->drr_offset, tx);
428870ff
BB
2346 dmu_tx_commit(tx);
2347 return (0);
2348}
2349
9b67f605 2350static int
fcff0f35 2351receive_write_embedded(struct receive_writer_arg *rwa,
47dfff3b 2352 struct drr_write_embedded *drrwe, void *data)
9b67f605
MA
2353{
2354 dmu_tx_t *tx;
2355 int err;
9b67f605 2356
47dfff3b 2357 if (drrwe->drr_offset + drrwe->drr_length < drrwe->drr_offset)
9b67f605
MA
2358 return (EINVAL);
2359
47dfff3b 2360 if (drrwe->drr_psize > BPE_PAYLOAD_SIZE)
9b67f605
MA
2361 return (EINVAL);
2362
47dfff3b 2363 if (drrwe->drr_etype >= NUM_BP_EMBEDDED_TYPES)
9b67f605 2364 return (EINVAL);
47dfff3b 2365 if (drrwe->drr_compression >= ZIO_COMPRESS_FUNCTIONS)
9b67f605
MA
2366 return (EINVAL);
2367
fcff0f35 2368 tx = dmu_tx_create(rwa->os);
9b67f605 2369
47dfff3b
MA
2370 dmu_tx_hold_write(tx, drrwe->drr_object,
2371 drrwe->drr_offset, drrwe->drr_length);
9b67f605
MA
2372 err = dmu_tx_assign(tx, TXG_WAIT);
2373 if (err != 0) {
2374 dmu_tx_abort(tx);
2375 return (err);
2376 }
2377
47dfff3b
MA
2378 dmu_write_embedded(rwa->os, drrwe->drr_object,
2379 drrwe->drr_offset, data, drrwe->drr_etype,
2380 drrwe->drr_compression, drrwe->drr_lsize, drrwe->drr_psize,
fcff0f35 2381 rwa->byteswap ^ ZFS_HOST_BYTEORDER, tx);
9b67f605 2382
47dfff3b
MA
2383 /* See comment in restore_write. */
2384 save_resume_state(rwa, drrwe->drr_object, drrwe->drr_offset, tx);
9b67f605
MA
2385 dmu_tx_commit(tx);
2386 return (0);
2387}
2388
428870ff 2389static int
fcff0f35
PD
2390receive_spill(struct receive_writer_arg *rwa, struct drr_spill *drrs,
2391 void *data)
428870ff
BB
2392{
2393 dmu_tx_t *tx;
428870ff
BB
2394 dmu_buf_t *db, *db_spill;
2395 int err;
2396
2397 if (drrs->drr_length < SPA_MINBLOCKSIZE ||
fcff0f35 2398 drrs->drr_length > spa_maxblocksize(dmu_objset_spa(rwa->os)))
2e528b49 2399 return (SET_ERROR(EINVAL));
428870ff 2400
fcff0f35 2401 if (dmu_object_info(rwa->os, drrs->drr_object, NULL) != 0)
2e528b49 2402 return (SET_ERROR(EINVAL));
428870ff 2403
fcff0f35 2404 VERIFY0(dmu_bonus_hold(rwa->os, drrs->drr_object, FTAG, &db));
428870ff
BB
2405 if ((err = dmu_spill_hold_by_bonus(db, FTAG, &db_spill)) != 0) {
2406 dmu_buf_rele(db, FTAG);
2407 return (err);
2408 }
2409
fcff0f35 2410 tx = dmu_tx_create(rwa->os);
428870ff
BB
2411
2412 dmu_tx_hold_spill(tx, db->db_object);
2413
2414 err = dmu_tx_assign(tx, TXG_WAIT);
13fe0198 2415 if (err != 0) {
428870ff
BB
2416 dmu_buf_rele(db, FTAG);
2417 dmu_buf_rele(db_spill, FTAG);
2418 dmu_tx_abort(tx);
2419 return (err);
2420 }
2421 dmu_buf_will_dirty(db_spill, tx);
2422
2423 if (db_spill->db_size < drrs->drr_length)
2424 VERIFY(0 == dbuf_spill_set_blksz(db_spill,
2425 drrs->drr_length, tx));
2426 bcopy(data, db_spill->db_data, drrs->drr_length);
2427
2428 dmu_buf_rele(db, FTAG);
2429 dmu_buf_rele(db_spill, FTAG);
2430
2431 dmu_tx_commit(tx);
2432 return (0);
2433}
2434
34dc7c2f 2435/* ARGSUSED */
60948de1 2436noinline static int
fcff0f35 2437receive_free(struct receive_writer_arg *rwa, struct drr_free *drrf)
34dc7c2f 2438{
34dc7c2f
BB
2439 int err;
2440
2441 if (drrf->drr_length != -1ULL &&
2442 drrf->drr_offset + drrf->drr_length < drrf->drr_offset)
2e528b49 2443 return (SET_ERROR(EINVAL));
34dc7c2f 2444
fcff0f35 2445 if (dmu_object_info(rwa->os, drrf->drr_object, NULL) != 0)
2e528b49 2446 return (SET_ERROR(EINVAL));
34dc7c2f 2447
fcff0f35 2448 err = dmu_free_long_range(rwa->os, drrf->drr_object,
34dc7c2f 2449 drrf->drr_offset, drrf->drr_length);
fcff0f35 2450
34dc7c2f
BB
2451 return (err);
2452}
2453
13fe0198
MA
2454/* used to destroy the drc_ds on error */
2455static void
2456dmu_recv_cleanup_ds(dmu_recv_cookie_t *drc)
2457{
47dfff3b
MA
2458 if (drc->drc_resumable) {
2459 /* wait for our resume state to be written to disk */
2460 txg_wait_synced(drc->drc_ds->ds_dir->dd_pool, 0);
2461 dsl_dataset_disown(drc->drc_ds, dmu_recv_tag);
2462 } else {
eca7b760 2463 char name[ZFS_MAX_DATASET_NAME_LEN];
47dfff3b
MA
2464 dsl_dataset_name(drc->drc_ds, name);
2465 dsl_dataset_disown(drc->drc_ds, dmu_recv_tag);
2466 (void) dsl_destroy_head(name);
2467 }
13fe0198
MA
2468}
2469
37f8a883 2470static void
fcff0f35 2471receive_cksum(struct receive_arg *ra, int len, void *buf)
37f8a883
MA
2472{
2473 if (ra->byteswap) {
a6255b7f 2474 (void) fletcher_4_incremental_byteswap(buf, len, &ra->cksum);
37f8a883 2475 } else {
a6255b7f 2476 (void) fletcher_4_incremental_native(buf, len, &ra->cksum);
37f8a883
MA
2477 }
2478}
2479
2480/*
fcff0f35
PD
2481 * Read the payload into a buffer of size len, and update the current record's
2482 * payload field.
2483 * Allocate ra->next_rrd and read the next record's header into
2484 * ra->next_rrd->header.
37f8a883
MA
2485 * Verify checksum of payload and next record.
2486 */
2487static int
fcff0f35 2488receive_read_payload_and_next_header(struct receive_arg *ra, int len, void *buf)
37f8a883
MA
2489{
2490 int err;
2491 zio_cksum_t cksum_orig;
2492 zio_cksum_t *cksump;
2493
2494 if (len != 0) {
fcff0f35 2495 ASSERT3U(len, <=, SPA_MAXBLOCKSIZE);
47dfff3b 2496 err = receive_read(ra, len, buf);
37f8a883
MA
2497 if (err != 0)
2498 return (err);
47dfff3b
MA
2499 receive_cksum(ra, len, buf);
2500
2501 /* note: rrd is NULL when reading the begin record's payload */
2502 if (ra->rrd != NULL) {
2503 ra->rrd->payload = buf;
2504 ra->rrd->payload_size = len;
2505 ra->rrd->bytes_read = ra->bytes_read;
2506 }
37f8a883
MA
2507 }
2508
2509 ra->prev_cksum = ra->cksum;
2510
fcff0f35
PD
2511 ra->next_rrd = kmem_zalloc(sizeof (*ra->next_rrd), KM_SLEEP);
2512 err = receive_read(ra, sizeof (ra->next_rrd->header),
2513 &ra->next_rrd->header);
47dfff3b 2514 ra->next_rrd->bytes_read = ra->bytes_read;
fcff0f35
PD
2515 if (err != 0) {
2516 kmem_free(ra->next_rrd, sizeof (*ra->next_rrd));
2517 ra->next_rrd = NULL;
37f8a883 2518 return (err);
fcff0f35
PD
2519 }
2520 if (ra->next_rrd->header.drr_type == DRR_BEGIN) {
2521 kmem_free(ra->next_rrd, sizeof (*ra->next_rrd));
2522 ra->next_rrd = NULL;
37f8a883 2523 return (SET_ERROR(EINVAL));
fcff0f35 2524 }
37f8a883
MA
2525
2526 /*
2527 * Note: checksum is of everything up to but not including the
2528 * checksum itself.
2529 */
2530 ASSERT3U(offsetof(dmu_replay_record_t, drr_u.drr_checksum.drr_checksum),
2531 ==, sizeof (dmu_replay_record_t) - sizeof (zio_cksum_t));
fcff0f35 2532 receive_cksum(ra,
37f8a883 2533 offsetof(dmu_replay_record_t, drr_u.drr_checksum.drr_checksum),
fcff0f35 2534 &ra->next_rrd->header);
37f8a883 2535
fcff0f35
PD
2536 cksum_orig = ra->next_rrd->header.drr_u.drr_checksum.drr_checksum;
2537 cksump = &ra->next_rrd->header.drr_u.drr_checksum.drr_checksum;
37f8a883
MA
2538
2539 if (ra->byteswap)
fcff0f35 2540 byteswap_record(&ra->next_rrd->header);
37f8a883
MA
2541
2542 if ((!ZIO_CHECKSUM_IS_ZERO(cksump)) &&
fcff0f35
PD
2543 !ZIO_CHECKSUM_EQUAL(ra->cksum, *cksump)) {
2544 kmem_free(ra->next_rrd, sizeof (*ra->next_rrd));
2545 ra->next_rrd = NULL;
37f8a883 2546 return (SET_ERROR(ECKSUM));
fcff0f35 2547 }
37f8a883 2548
fcff0f35 2549 receive_cksum(ra, sizeof (cksum_orig), &cksum_orig);
37f8a883
MA
2550
2551 return (0);
2552}
2553
e6d3a843
PD
2554static void
2555objlist_create(struct objlist *list)
2556{
2557 list_create(&list->list, sizeof (struct receive_objnode),
2558 offsetof(struct receive_objnode, node));
2559 list->last_lookup = 0;
2560}
2561
2562static void
2563objlist_destroy(struct objlist *list)
2564{
2565 struct receive_objnode *n;
2566
2567 for (n = list_remove_head(&list->list);
2568 n != NULL; n = list_remove_head(&list->list)) {
2569 kmem_free(n, sizeof (*n));
2570 }
2571 list_destroy(&list->list);
2572}
2573
2574/*
2575 * This function looks through the objlist to see if the specified object number
2576 * is contained in the objlist. In the process, it will remove all object
2577 * numbers in the list that are smaller than the specified object number. Thus,
2578 * any lookup of an object number smaller than a previously looked up object
2579 * number will always return false; therefore, all lookups should be done in
2580 * ascending order.
2581 */
2582static boolean_t
2583objlist_exists(struct objlist *list, uint64_t object)
2584{
2585 struct receive_objnode *node = list_head(&list->list);
2586 ASSERT3U(object, >=, list->last_lookup);
2587 list->last_lookup = object;
2588 while (node != NULL && node->object < object) {
2589 VERIFY3P(node, ==, list_remove_head(&list->list));
2590 kmem_free(node, sizeof (*node));
2591 node = list_head(&list->list);
2592 }
2593 return (node != NULL && node->object == object);
2594}
2595
2596/*
2597 * The objlist is a list of object numbers stored in ascending order. However,
2598 * the insertion of new object numbers does not seek out the correct location to
2599 * store a new object number; instead, it appends it to the list for simplicity.
2600 * Thus, any users must take care to only insert new object numbers in ascending
2601 * order.
2602 */
2603static void
2604objlist_insert(struct objlist *list, uint64_t object)
2605{
2606 struct receive_objnode *node = kmem_zalloc(sizeof (*node), KM_SLEEP);
2607 node->object = object;
2608#ifdef ZFS_DEBUG
2609 {
2610 struct receive_objnode *last_object = list_tail(&list->list);
2611 uint64_t last_objnum = (last_object != NULL ? last_object->object : 0);
2612 ASSERT3U(node->object, >, last_objnum);
2613 }
2614#endif
2615 list_insert_tail(&list->list, node);
2616}
2617
fcff0f35
PD
2618/*
2619 * Issue the prefetch reads for any necessary indirect blocks.
2620 *
2621 * We use the object ignore list to tell us whether or not to issue prefetches
2622 * for a given object. We do this for both correctness (in case the blocksize
2623 * of an object has changed) and performance (if the object doesn't exist, don't
2624 * needlessly try to issue prefetches). We also trim the list as we go through
2625 * the stream to prevent it from growing to an unbounded size.
2626 *
2627 * The object numbers within will always be in sorted order, and any write
2628 * records we see will also be in sorted order, but they're not sorted with
2629 * respect to each other (i.e. we can get several object records before
2630 * receiving each object's write records). As a result, once we've reached a
2631 * given object number, we can safely remove any reference to lower object
2632 * numbers in the ignore list. In practice, we receive up to 32 object records
2633 * before receiving write records, so the list can have up to 32 nodes in it.
2634 */
2635/* ARGSUSED */
2636static void
2637receive_read_prefetch(struct receive_arg *ra,
2638 uint64_t object, uint64_t offset, uint64_t length)
2639{
e6d3a843 2640 if (!objlist_exists(&ra->ignore_objlist, object)) {
fcff0f35
PD
2641 dmu_prefetch(ra->os, object, 1, offset, length,
2642 ZIO_PRIORITY_SYNC_READ);
2643 }
2644}
2645
2646/*
2647 * Read records off the stream, issuing any necessary prefetches.
2648 */
37f8a883 2649static int
fcff0f35 2650receive_read_record(struct receive_arg *ra)
37f8a883
MA
2651{
2652 int err;
2653
fcff0f35 2654 switch (ra->rrd->header.drr_type) {
37f8a883
MA
2655 case DRR_OBJECT:
2656 {
fcff0f35
PD
2657 struct drr_object *drro = &ra->rrd->header.drr_u.drr_object;
2658 uint32_t size = P2ROUNDUP(drro->drr_bonuslen, 8);
2659 void *buf = kmem_zalloc(size, KM_SLEEP);
2660 dmu_object_info_t doi;
2661 err = receive_read_payload_and_next_header(ra, size, buf);
2662 if (err != 0) {
2663 kmem_free(buf, size);
37f8a883 2664 return (err);
fcff0f35
PD
2665 }
2666 err = dmu_object_info(ra->os, drro->drr_object, &doi);
2667 /*
2668 * See receive_read_prefetch for an explanation why we're
2669 * storing this object in the ignore_obj_list.
2670 */
2671 if (err == ENOENT ||
2672 (err == 0 && doi.doi_data_block_size != drro->drr_blksz)) {
e6d3a843 2673 objlist_insert(&ra->ignore_objlist, drro->drr_object);
fcff0f35
PD
2674 err = 0;
2675 }
2676 return (err);
37f8a883
MA
2677 }
2678 case DRR_FREEOBJECTS:
2679 {
fcff0f35
PD
2680 err = receive_read_payload_and_next_header(ra, 0, NULL);
2681 return (err);
37f8a883
MA
2682 }
2683 case DRR_WRITE:
2684 {
fcff0f35 2685 struct drr_write *drrw = &ra->rrd->header.drr_u.drr_write;
2aa34383
DK
2686 arc_buf_t *abuf;
2687 boolean_t is_meta = DMU_OT_IS_METADATA(drrw->drr_type);
2688 if (DRR_WRITE_COMPRESSED(drrw)) {
2689 ASSERT3U(drrw->drr_compressed_size, >, 0);
2690 ASSERT3U(drrw->drr_logical_size, >=,
2691 drrw->drr_compressed_size);
2692 ASSERT(!is_meta);
2693 abuf = arc_loan_compressed_buf(
2694 dmu_objset_spa(ra->os),
2695 drrw->drr_compressed_size, drrw->drr_logical_size,
2696 drrw->drr_compressiontype);
2697 } else {
2698 abuf = arc_loan_buf(dmu_objset_spa(ra->os),
2699 is_meta, drrw->drr_logical_size);
2700 }
37f8a883 2701
fcff0f35 2702 err = receive_read_payload_and_next_header(ra,
2aa34383 2703 DRR_WRITE_PAYLOAD_SIZE(drrw), abuf->b_data);
fcff0f35 2704 if (err != 0) {
37f8a883 2705 dmu_return_arcbuf(abuf);
fcff0f35
PD
2706 return (err);
2707 }
2708 ra->rrd->write_buf = abuf;
2709 receive_read_prefetch(ra, drrw->drr_object, drrw->drr_offset,
2aa34383 2710 drrw->drr_logical_size);
37f8a883
MA
2711 return (err);
2712 }
2713 case DRR_WRITE_BYREF:
2714 {
fcff0f35
PD
2715 struct drr_write_byref *drrwb =
2716 &ra->rrd->header.drr_u.drr_write_byref;
2717 err = receive_read_payload_and_next_header(ra, 0, NULL);
2718 receive_read_prefetch(ra, drrwb->drr_object, drrwb->drr_offset,
2719 drrwb->drr_length);
2720 return (err);
37f8a883
MA
2721 }
2722 case DRR_WRITE_EMBEDDED:
2723 {
2724 struct drr_write_embedded *drrwe =
fcff0f35
PD
2725 &ra->rrd->header.drr_u.drr_write_embedded;
2726 uint32_t size = P2ROUNDUP(drrwe->drr_psize, 8);
2727 void *buf = kmem_zalloc(size, KM_SLEEP);
2728
2729 err = receive_read_payload_and_next_header(ra, size, buf);
2730 if (err != 0) {
2731 kmem_free(buf, size);
37f8a883 2732 return (err);
fcff0f35
PD
2733 }
2734
2735 receive_read_prefetch(ra, drrwe->drr_object, drrwe->drr_offset,
2736 drrwe->drr_length);
2737 return (err);
37f8a883
MA
2738 }
2739 case DRR_FREE:
2740 {
fcff0f35
PD
2741 /*
2742 * It might be beneficial to prefetch indirect blocks here, but
2743 * we don't really have the data to decide for sure.
2744 */
2745 err = receive_read_payload_and_next_header(ra, 0, NULL);
2746 return (err);
37f8a883
MA
2747 }
2748 case DRR_END:
2749 {
fcff0f35 2750 struct drr_end *drre = &ra->rrd->header.drr_u.drr_end;
37f8a883 2751 if (!ZIO_CHECKSUM_EQUAL(ra->prev_cksum, drre->drr_checksum))
47dfff3b 2752 return (SET_ERROR(ECKSUM));
37f8a883
MA
2753 return (0);
2754 }
2755 case DRR_SPILL:
2756 {
fcff0f35
PD
2757 struct drr_spill *drrs = &ra->rrd->header.drr_u.drr_spill;
2758 void *buf = kmem_zalloc(drrs->drr_length, KM_SLEEP);
2759 err = receive_read_payload_and_next_header(ra, drrs->drr_length,
2760 buf);
37f8a883 2761 if (err != 0)
fcff0f35
PD
2762 kmem_free(buf, drrs->drr_length);
2763 return (err);
2764 }
2765 default:
2766 return (SET_ERROR(EINVAL));
2767 }
2768}
2769
2770/*
2771 * Commit the records to the pool.
2772 */
2773static int
2774receive_process_record(struct receive_writer_arg *rwa,
2775 struct receive_record_arg *rrd)
2776{
2777 int err;
2778
47dfff3b
MA
2779 /* Processing in order, therefore bytes_read should be increasing. */
2780 ASSERT3U(rrd->bytes_read, >=, rwa->bytes_read);
2781 rwa->bytes_read = rrd->bytes_read;
2782
fcff0f35
PD
2783 switch (rrd->header.drr_type) {
2784 case DRR_OBJECT:
2785 {
2786 struct drr_object *drro = &rrd->header.drr_u.drr_object;
2787 err = receive_object(rwa, drro, rrd->payload);
2788 kmem_free(rrd->payload, rrd->payload_size);
2789 rrd->payload = NULL;
2790 return (err);
2791 }
2792 case DRR_FREEOBJECTS:
2793 {
2794 struct drr_freeobjects *drrfo =
2795 &rrd->header.drr_u.drr_freeobjects;
2796 return (receive_freeobjects(rwa, drrfo));
2797 }
2798 case DRR_WRITE:
2799 {
2800 struct drr_write *drrw = &rrd->header.drr_u.drr_write;
2801 err = receive_write(rwa, drrw, rrd->write_buf);
2802 /* if receive_write() is successful, it consumes the arc_buf */
2803 if (err != 0)
2804 dmu_return_arcbuf(rrd->write_buf);
2805 rrd->write_buf = NULL;
2806 rrd->payload = NULL;
2807 return (err);
2808 }
2809 case DRR_WRITE_BYREF:
2810 {
2811 struct drr_write_byref *drrwbr =
2812 &rrd->header.drr_u.drr_write_byref;
2813 return (receive_write_byref(rwa, drrwbr));
2814 }
2815 case DRR_WRITE_EMBEDDED:
2816 {
2817 struct drr_write_embedded *drrwe =
2818 &rrd->header.drr_u.drr_write_embedded;
2819 err = receive_write_embedded(rwa, drrwe, rrd->payload);
2820 kmem_free(rrd->payload, rrd->payload_size);
2821 rrd->payload = NULL;
2822 return (err);
2823 }
2824 case DRR_FREE:
2825 {
2826 struct drr_free *drrf = &rrd->header.drr_u.drr_free;
2827 return (receive_free(rwa, drrf));
2828 }
2829 case DRR_SPILL:
2830 {
2831 struct drr_spill *drrs = &rrd->header.drr_u.drr_spill;
2832 err = receive_spill(rwa, drrs, rrd->payload);
2833 kmem_free(rrd->payload, rrd->payload_size);
2834 rrd->payload = NULL;
2835 return (err);
37f8a883
MA
2836 }
2837 default:
2838 return (SET_ERROR(EINVAL));
2839 }
2840}
2841
34dc7c2f 2842/*
fcff0f35
PD
2843 * dmu_recv_stream's worker thread; pull records off the queue, and then call
2844 * receive_process_record When we're done, signal the main thread and exit.
2845 */
2846static void
2847receive_writer_thread(void *arg)
2848{
2849 struct receive_writer_arg *rwa = arg;
2850 struct receive_record_arg *rrd;
3e635ac1
TC
2851 fstrans_cookie_t cookie = spl_fstrans_mark();
2852
fcff0f35
PD
2853 for (rrd = bqueue_dequeue(&rwa->q); !rrd->eos_marker;
2854 rrd = bqueue_dequeue(&rwa->q)) {
2855 /*
2856 * If there's an error, the main thread will stop putting things
2857 * on the queue, but we need to clear everything in it before we
2858 * can exit.
2859 */
2860 if (rwa->err == 0) {
2861 rwa->err = receive_process_record(rwa, rrd);
2862 } else if (rrd->write_buf != NULL) {
2863 dmu_return_arcbuf(rrd->write_buf);
2864 rrd->write_buf = NULL;
2865 rrd->payload = NULL;
2866 } else if (rrd->payload != NULL) {
2867 kmem_free(rrd->payload, rrd->payload_size);
2868 rrd->payload = NULL;
2869 }
2870 kmem_free(rrd, sizeof (*rrd));
2871 }
2872 kmem_free(rrd, sizeof (*rrd));
2873 mutex_enter(&rwa->mutex);
2874 rwa->done = B_TRUE;
2875 cv_signal(&rwa->cv);
2876 mutex_exit(&rwa->mutex);
3e635ac1 2877 spl_fstrans_unmark(cookie);
34a6b428 2878 thread_exit();
fcff0f35
PD
2879}
2880
47dfff3b
MA
2881static int
2882resume_check(struct receive_arg *ra, nvlist_t *begin_nvl)
2883{
2884 uint64_t val;
2885 objset_t *mos = dmu_objset_pool(ra->os)->dp_meta_objset;
2886 uint64_t dsobj = dmu_objset_id(ra->os);
2887 uint64_t resume_obj, resume_off;
2888
2889 if (nvlist_lookup_uint64(begin_nvl,
2890 "resume_object", &resume_obj) != 0 ||
2891 nvlist_lookup_uint64(begin_nvl,
2892 "resume_offset", &resume_off) != 0) {
2893 return (SET_ERROR(EINVAL));
2894 }
2895 VERIFY0(zap_lookup(mos, dsobj,
2896 DS_FIELD_RESUME_OBJECT, sizeof (val), 1, &val));
2897 if (resume_obj != val)
2898 return (SET_ERROR(EINVAL));
2899 VERIFY0(zap_lookup(mos, dsobj,
2900 DS_FIELD_RESUME_OFFSET, sizeof (val), 1, &val));
2901 if (resume_off != val)
2902 return (SET_ERROR(EINVAL));
2903
2904 return (0);
2905}
2906
fcff0f35
PD
2907/*
2908 * Read in the stream's records, one by one, and apply them to the pool. There
2909 * are two threads involved; the thread that calls this function will spin up a
2910 * worker thread, read the records off the stream one by one, and issue
2911 * prefetches for any necessary indirect blocks. It will then push the records
2912 * onto an internal blocking queue. The worker thread will pull the records off
2913 * the queue, and actually write the data into the DMU. This way, the worker
2914 * thread doesn't have to wait for reads to complete, since everything it needs
2915 * (the indirect blocks) will be prefetched.
2916 *
34dc7c2f
BB
2917 * NB: callers *must* call dmu_recv_end() if this succeeds.
2918 */
2919int
572e2857
BB
2920dmu_recv_stream(dmu_recv_cookie_t *drc, vnode_t *vp, offset_t *voffp,
2921 int cleanup_fd, uint64_t *action_handlep)
34dc7c2f 2922{
37f8a883 2923 int err = 0;
04bc4610
NB
2924 struct receive_arg *ra;
2925 struct receive_writer_arg *rwa;
428870ff 2926 int featureflags;
47dfff3b
MA
2927 uint32_t payloadlen;
2928 void *payload;
2929 nvlist_t *begin_nvl = NULL;
34dc7c2f 2930
04bc4610
NB
2931 ra = kmem_zalloc(sizeof (*ra), KM_SLEEP);
2932 rwa = kmem_zalloc(sizeof (*rwa), KM_SLEEP);
2933
2934 ra->byteswap = drc->drc_byteswap;
2935 ra->cksum = drc->drc_cksum;
2936 ra->vp = vp;
2937 ra->voff = *voffp;
47dfff3b
MA
2938
2939 if (dsl_dataset_is_zapified(drc->drc_ds)) {
2940 (void) zap_lookup(drc->drc_ds->ds_dir->dd_pool->dp_meta_objset,
2941 drc->drc_ds->ds_object, DS_FIELD_RESUME_BYTES,
2942 sizeof (ra->bytes_read), 1, &ra->bytes_read);
2943 }
2944
e6d3a843 2945 objlist_create(&ra->ignore_objlist);
34dc7c2f
BB
2946
2947 /* these were verified in dmu_recv_begin */
13fe0198 2948 ASSERT3U(DMU_GET_STREAM_HDRTYPE(drc->drc_drrb->drr_versioninfo), ==,
428870ff 2949 DMU_SUBSTREAM);
13fe0198 2950 ASSERT3U(drc->drc_drrb->drr_type, <, DMU_OST_NUMTYPES);
34dc7c2f
BB
2951
2952 /*
2953 * Open the objset we are modifying.
2954 */
04bc4610 2955 VERIFY0(dmu_objset_from_ds(drc->drc_ds, &ra->os));
34dc7c2f 2956
d683ddbb 2957 ASSERT(dsl_dataset_phys(drc->drc_ds)->ds_flags & DS_FLAG_INCONSISTENT);
34dc7c2f 2958
428870ff
BB
2959 featureflags = DMU_GET_FEATUREFLAGS(drc->drc_drrb->drr_versioninfo);
2960
2961 /* if this stream is dedup'ed, set up the avl tree for guid mapping */
2962 if (featureflags & DMU_BACKUP_FEATURE_DEDUP) {
572e2857
BB
2963 minor_t minor;
2964
2965 if (cleanup_fd == -1) {
04bc4610 2966 ra->err = SET_ERROR(EBADF);
572e2857
BB
2967 goto out;
2968 }
04bc4610
NB
2969 ra->err = zfs_onexit_fd_hold(cleanup_fd, &minor);
2970 if (ra->err != 0) {
572e2857
BB
2971 cleanup_fd = -1;
2972 goto out;
2973 }
2974
2975 if (*action_handlep == 0) {
04bc4610 2976 rwa->guid_to_ds_map =
572e2857 2977 kmem_alloc(sizeof (avl_tree_t), KM_SLEEP);
04bc4610 2978 avl_create(rwa->guid_to_ds_map, guid_compare,
572e2857
BB
2979 sizeof (guid_map_entry_t),
2980 offsetof(guid_map_entry_t, avlnode));
37f8a883 2981 err = zfs_onexit_add_cb(minor,
04bc4610 2982 free_guid_map_onexit, rwa->guid_to_ds_map,
572e2857 2983 action_handlep);
04bc4610 2984 if (ra->err != 0)
572e2857
BB
2985 goto out;
2986 } else {
37f8a883 2987 err = zfs_onexit_cb_data(minor, *action_handlep,
04bc4610
NB
2988 (void **)&rwa->guid_to_ds_map);
2989 if (ra->err != 0)
572e2857
BB
2990 goto out;
2991 }
8d35c149 2992
04bc4610 2993 drc->drc_guid_to_ds_map = rwa->guid_to_ds_map;
428870ff
BB
2994 }
2995
47dfff3b
MA
2996 payloadlen = drc->drc_drr_begin->drr_payloadlen;
2997 payload = NULL;
2998 if (payloadlen != 0)
2999 payload = kmem_alloc(payloadlen, KM_SLEEP);
3000
3001 err = receive_read_payload_and_next_header(ra, payloadlen, payload);
3002 if (err != 0) {
3003 if (payloadlen != 0)
3004 kmem_free(payload, payloadlen);
37f8a883 3005 goto out;
47dfff3b
MA
3006 }
3007 if (payloadlen != 0) {
3008 err = nvlist_unpack(payload, payloadlen, &begin_nvl, KM_SLEEP);
3009 kmem_free(payload, payloadlen);
3010 if (err != 0)
3011 goto out;
3012 }
3013
3014 if (featureflags & DMU_BACKUP_FEATURE_RESUMING) {
3015 err = resume_check(ra, begin_nvl);
3016 if (err != 0)
3017 goto out;
3018 }
37f8a883 3019
04bc4610 3020 (void) bqueue_init(&rwa->q, zfs_recv_queue_length,
fcff0f35 3021 offsetof(struct receive_record_arg, node));
04bc4610
NB
3022 cv_init(&rwa->cv, NULL, CV_DEFAULT, NULL);
3023 mutex_init(&rwa->mutex, NULL, MUTEX_DEFAULT, NULL);
3024 rwa->os = ra->os;
3025 rwa->byteswap = drc->drc_byteswap;
47dfff3b 3026 rwa->resumable = drc->drc_resumable;
fcff0f35 3027
04bc4610 3028 (void) thread_create(NULL, 0, receive_writer_thread, rwa, 0, curproc,
fcff0f35
PD
3029 TS_RUN, minclsyspri);
3030 /*
04bc4610 3031 * We're reading rwa->err without locks, which is safe since we are the
fcff0f35
PD
3032 * only reader, and the worker thread is the only writer. It's ok if we
3033 * miss a write for an iteration or two of the loop, since the writer
3034 * thread will keep freeing records we send it until we send it an eos
3035 * marker.
3036 *
04bc4610 3037 * We can leave this loop in 3 ways: First, if rwa->err is
fcff0f35
PD
3038 * non-zero. In that case, the writer thread will free the rrd we just
3039 * pushed. Second, if we're interrupted; in that case, either it's the
47dfff3b 3040 * first loop and ra->rrd was never allocated, or it's later and ra->rrd
fcff0f35
PD
3041 * has been handed off to the writer thread who will free it. Finally,
3042 * if receive_read_record fails or we're at the end of the stream, then
04bc4610 3043 * we free ra->rrd and exit.
fcff0f35 3044 */
04bc4610 3045 while (rwa->err == 0) {
34dc7c2f 3046 if (issig(JUSTLOOKING) && issig(FORREAL)) {
37f8a883
MA
3047 err = SET_ERROR(EINTR);
3048 break;
34dc7c2f
BB
3049 }
3050
04bc4610
NB
3051 ASSERT3P(ra->rrd, ==, NULL);
3052 ra->rrd = ra->next_rrd;
3053 ra->next_rrd = NULL;
3054 /* Allocates and loads header into ra->next_rrd */
3055 err = receive_read_record(ra);
34dc7c2f 3056
04bc4610
NB
3057 if (ra->rrd->header.drr_type == DRR_END || err != 0) {
3058 kmem_free(ra->rrd, sizeof (*ra->rrd));
3059 ra->rrd = NULL;
428870ff 3060 break;
fcff0f35
PD
3061 }
3062
04bc4610
NB
3063 bqueue_enqueue(&rwa->q, ra->rrd,
3064 sizeof (struct receive_record_arg) + ra->rrd->payload_size);
3065 ra->rrd = NULL;
fcff0f35 3066 }
04bc4610
NB
3067 if (ra->next_rrd == NULL)
3068 ra->next_rrd = kmem_zalloc(sizeof (*ra->next_rrd), KM_SLEEP);
3069 ra->next_rrd->eos_marker = B_TRUE;
3070 bqueue_enqueue(&rwa->q, ra->next_rrd, 1);
fcff0f35 3071
04bc4610
NB
3072 mutex_enter(&rwa->mutex);
3073 while (!rwa->done) {
3074 cv_wait(&rwa->cv, &rwa->mutex);
34dc7c2f 3075 }
04bc4610 3076 mutex_exit(&rwa->mutex);
fcff0f35 3077
04bc4610
NB
3078 cv_destroy(&rwa->cv);
3079 mutex_destroy(&rwa->mutex);
3080 bqueue_destroy(&rwa->q);
fcff0f35 3081 if (err == 0)
04bc4610 3082 err = rwa->err;
34dc7c2f
BB
3083
3084out:
47dfff3b 3085 nvlist_free(begin_nvl);
572e2857
BB
3086 if ((featureflags & DMU_BACKUP_FEATURE_DEDUP) && (cleanup_fd != -1))
3087 zfs_onexit_fd_rele(cleanup_fd);
3088
37f8a883 3089 if (err != 0) {
34dc7c2f 3090 /*
47dfff3b
MA
3091 * Clean up references. If receive is not resumable,
3092 * destroy what we created, so we don't leave it in
3093 * the inconsistent state.
34dc7c2f 3094 */
13fe0198 3095 dmu_recv_cleanup_ds(drc);
34dc7c2f
BB
3096 }
3097
04bc4610 3098 *voffp = ra->voff;
e6d3a843 3099 objlist_destroy(&ra->ignore_objlist);
04bc4610
NB
3100 kmem_free(ra, sizeof (*ra));
3101 kmem_free(rwa, sizeof (*rwa));
37f8a883 3102 return (err);
34dc7c2f
BB
3103}
3104
34dc7c2f 3105static int
13fe0198 3106dmu_recv_end_check(void *arg, dmu_tx_t *tx)
34dc7c2f 3107{
13fe0198
MA
3108 dmu_recv_cookie_t *drc = arg;
3109 dsl_pool_t *dp = dmu_tx_pool(tx);
3110 int error;
3111
3112 ASSERT3P(drc->drc_ds->ds_owner, ==, dmu_recv_tag);
3113
3114 if (!drc->drc_newfs) {
3115 dsl_dataset_t *origin_head;
3116
3117 error = dsl_dataset_hold(dp, drc->drc_tofs, FTAG, &origin_head);
3118 if (error != 0)
3119 return (error);
19580676
MA
3120 if (drc->drc_force) {
3121 /*
3122 * We will destroy any snapshots in tofs (i.e. before
3123 * origin_head) that are after the origin (which is
3124 * the snap before drc_ds, because drc_ds can not
3125 * have any snaps of its own).
3126 */
d683ddbb
JG
3127 uint64_t obj;
3128
3129 obj = dsl_dataset_phys(origin_head)->ds_prev_snap_obj;
3130 while (obj !=
3131 dsl_dataset_phys(drc->drc_ds)->ds_prev_snap_obj) {
19580676
MA
3132 dsl_dataset_t *snap;
3133 error = dsl_dataset_hold_obj(dp, obj, FTAG,
3134 &snap);
3135 if (error != 0)
b6640117 3136 break;
19580676
MA
3137 if (snap->ds_dir != origin_head->ds_dir)
3138 error = SET_ERROR(EINVAL);
3139 if (error == 0) {
3140 error = dsl_destroy_snapshot_check_impl(
3141 snap, B_FALSE);
3142 }
d683ddbb 3143 obj = dsl_dataset_phys(snap)->ds_prev_snap_obj;
19580676
MA
3144 dsl_dataset_rele(snap, FTAG);
3145 if (error != 0)
b6640117
AG
3146 break;
3147 }
3148 if (error != 0) {
3149 dsl_dataset_rele(origin_head, FTAG);
3150 return (error);
19580676
MA
3151 }
3152 }
13fe0198 3153 error = dsl_dataset_clone_swap_check_impl(drc->drc_ds,
831baf06 3154 origin_head, drc->drc_force, drc->drc_owner, tx);
13fe0198
MA
3155 if (error != 0) {
3156 dsl_dataset_rele(origin_head, FTAG);
3157 return (error);
3158 }
3159 error = dsl_dataset_snapshot_check_impl(origin_head,
788eb90c 3160 drc->drc_tosnap, tx, B_TRUE, 1, drc->drc_cred);
13fe0198
MA
3161 dsl_dataset_rele(origin_head, FTAG);
3162 if (error != 0)
3163 return (error);
34dc7c2f 3164
13fe0198
MA
3165 error = dsl_destroy_head_check_impl(drc->drc_ds, 1);
3166 } else {
3167 error = dsl_dataset_snapshot_check_impl(drc->drc_ds,
788eb90c 3168 drc->drc_tosnap, tx, B_TRUE, 1, drc->drc_cred);
13fe0198
MA
3169 }
3170 return (error);
34dc7c2f
BB
3171}
3172
3173static void
13fe0198 3174dmu_recv_end_sync(void *arg, dmu_tx_t *tx)
34dc7c2f 3175{
13fe0198
MA
3176 dmu_recv_cookie_t *drc = arg;
3177 dsl_pool_t *dp = dmu_tx_pool(tx);
3178
3179 spa_history_log_internal_ds(drc->drc_ds, "finish receiving",
3180 tx, "snap=%s", drc->drc_tosnap);
3181
3182 if (!drc->drc_newfs) {
3183 dsl_dataset_t *origin_head;
3184
3185 VERIFY0(dsl_dataset_hold(dp, drc->drc_tofs, FTAG,
3186 &origin_head));
19580676
MA
3187
3188 if (drc->drc_force) {
3189 /*
3190 * Destroy any snapshots of drc_tofs (origin_head)
3191 * after the origin (the snap before drc_ds).
3192 */
d683ddbb
JG
3193 uint64_t obj;
3194
3195 obj = dsl_dataset_phys(origin_head)->ds_prev_snap_obj;
3196 while (obj !=
3197 dsl_dataset_phys(drc->drc_ds)->ds_prev_snap_obj) {
19580676
MA
3198 dsl_dataset_t *snap;
3199 VERIFY0(dsl_dataset_hold_obj(dp, obj, FTAG,
3200 &snap));
3201 ASSERT3P(snap->ds_dir, ==, origin_head->ds_dir);
d683ddbb 3202 obj = dsl_dataset_phys(snap)->ds_prev_snap_obj;
19580676
MA
3203 dsl_destroy_snapshot_sync_impl(snap,
3204 B_FALSE, tx);
3205 dsl_dataset_rele(snap, FTAG);
3206 }
3207 }
3208 VERIFY3P(drc->drc_ds->ds_prev, ==,
3209 origin_head->ds_prev);
3210
13fe0198
MA
3211 dsl_dataset_clone_swap_sync_impl(drc->drc_ds,
3212 origin_head, tx);
3213 dsl_dataset_snapshot_sync_impl(origin_head,
3214 drc->drc_tosnap, tx);
3215
3216 /* set snapshot's creation time and guid */
3217 dmu_buf_will_dirty(origin_head->ds_prev->ds_dbuf, tx);
d683ddbb 3218 dsl_dataset_phys(origin_head->ds_prev)->ds_creation_time =
13fe0198 3219 drc->drc_drrb->drr_creation_time;
d683ddbb 3220 dsl_dataset_phys(origin_head->ds_prev)->ds_guid =
13fe0198 3221 drc->drc_drrb->drr_toguid;
d683ddbb 3222 dsl_dataset_phys(origin_head->ds_prev)->ds_flags &=
13fe0198
MA
3223 ~DS_FLAG_INCONSISTENT;
3224
3225 dmu_buf_will_dirty(origin_head->ds_dbuf, tx);
d683ddbb
JG
3226 dsl_dataset_phys(origin_head)->ds_flags &=
3227 ~DS_FLAG_INCONSISTENT;
13fe0198
MA
3228
3229 dsl_dataset_rele(origin_head, FTAG);
3230 dsl_destroy_head_sync_impl(drc->drc_ds, tx);
831baf06
KW
3231
3232 if (drc->drc_owner != NULL)
3233 VERIFY3P(origin_head->ds_owner, ==, drc->drc_owner);
13fe0198
MA
3234 } else {
3235 dsl_dataset_t *ds = drc->drc_ds;
34dc7c2f 3236
13fe0198 3237 dsl_dataset_snapshot_sync_impl(ds, drc->drc_tosnap, tx);
34dc7c2f 3238
13fe0198
MA
3239 /* set snapshot's creation time and guid */
3240 dmu_buf_will_dirty(ds->ds_prev->ds_dbuf, tx);
d683ddbb 3241 dsl_dataset_phys(ds->ds_prev)->ds_creation_time =
13fe0198 3242 drc->drc_drrb->drr_creation_time;
d683ddbb
JG
3243 dsl_dataset_phys(ds->ds_prev)->ds_guid =
3244 drc->drc_drrb->drr_toguid;
3245 dsl_dataset_phys(ds->ds_prev)->ds_flags &=
3246 ~DS_FLAG_INCONSISTENT;
34dc7c2f 3247
13fe0198 3248 dmu_buf_will_dirty(ds->ds_dbuf, tx);
d683ddbb 3249 dsl_dataset_phys(ds)->ds_flags &= ~DS_FLAG_INCONSISTENT;
47dfff3b
MA
3250 if (dsl_dataset_has_resume_receive_state(ds)) {
3251 (void) zap_remove(dp->dp_meta_objset, ds->ds_object,
3252 DS_FIELD_RESUME_FROMGUID, tx);
3253 (void) zap_remove(dp->dp_meta_objset, ds->ds_object,
3254 DS_FIELD_RESUME_OBJECT, tx);
3255 (void) zap_remove(dp->dp_meta_objset, ds->ds_object,
3256 DS_FIELD_RESUME_OFFSET, tx);
3257 (void) zap_remove(dp->dp_meta_objset, ds->ds_object,
3258 DS_FIELD_RESUME_BYTES, tx);
3259 (void) zap_remove(dp->dp_meta_objset, ds->ds_object,
3260 DS_FIELD_RESUME_TOGUID, tx);
3261 (void) zap_remove(dp->dp_meta_objset, ds->ds_object,
3262 DS_FIELD_RESUME_TONAME, tx);
3263 }
13fe0198 3264 }
d683ddbb 3265 drc->drc_newsnapobj = dsl_dataset_phys(drc->drc_ds)->ds_prev_snap_obj;
a0bd735a 3266 zvol_create_minors(dp->dp_spa, drc->drc_tofs, B_TRUE);
13fe0198
MA
3267 /*
3268 * Release the hold from dmu_recv_begin. This must be done before
3269 * we return to open context, so that when we free the dataset's dnode,
3270 * we can evict its bonus buffer.
3271 */
3272 dsl_dataset_disown(drc->drc_ds, dmu_recv_tag);
3273 drc->drc_ds = NULL;
34dc7c2f
BB
3274}
3275
8d35c149 3276static int
13fe0198 3277add_ds_to_guidmap(const char *name, avl_tree_t *guid_map, uint64_t snapobj)
8d35c149 3278{
13fe0198 3279 dsl_pool_t *dp;
8d35c149
AS
3280 dsl_dataset_t *snapds;
3281 guid_map_entry_t *gmep;
3282 int err;
3283
3284 ASSERT(guid_map != NULL);
3285
13fe0198
MA
3286 err = dsl_pool_hold(name, FTAG, &dp);
3287 if (err != 0)
3288 return (err);
7ec09286
MA
3289 gmep = kmem_alloc(sizeof (*gmep), KM_SLEEP);
3290 err = dsl_dataset_hold_obj(dp, snapobj, gmep, &snapds);
8d35c149 3291 if (err == 0) {
d683ddbb 3292 gmep->guid = dsl_dataset_phys(snapds)->ds_guid;
8d35c149
AS
3293 gmep->gme_ds = snapds;
3294 avl_add(guid_map, gmep);
13fe0198 3295 dsl_dataset_long_hold(snapds, gmep);
7ec09286
MA
3296 } else {
3297 kmem_free(gmep, sizeof (*gmep));
8d35c149
AS
3298 }
3299
13fe0198 3300 dsl_pool_rele(dp, FTAG);
8d35c149
AS
3301 return (err);
3302}
3303
13fe0198
MA
3304static int dmu_recv_end_modified_blocks = 3;
3305
428870ff
BB
3306static int
3307dmu_recv_existing_end(dmu_recv_cookie_t *drc)
34dc7c2f 3308{
13fe0198 3309 int error;
34dc7c2f 3310
13fe0198 3311#ifdef _KERNEL
13fe0198
MA
3312 /*
3313 * We will be destroying the ds; make sure its origin is unmounted if
3314 * necessary.
3315 */
eca7b760 3316 char name[ZFS_MAX_DATASET_NAME_LEN];
13fe0198
MA
3317 dsl_dataset_name(drc->drc_ds, name);
3318 zfs_destroy_unmount_origin(name);
13fe0198 3319#endif
34dc7c2f 3320
13fe0198
MA
3321 error = dsl_sync_task(drc->drc_tofs,
3322 dmu_recv_end_check, dmu_recv_end_sync, drc,
3d45fdd6 3323 dmu_recv_end_modified_blocks, ZFS_SPACE_CHECK_NORMAL);
13fe0198
MA
3324
3325 if (error != 0)
3326 dmu_recv_cleanup_ds(drc);
3327 return (error);
34dc7c2f 3328}
428870ff
BB
3329
3330static int
3331dmu_recv_new_end(dmu_recv_cookie_t *drc)
3332{
13fe0198 3333 int error;
428870ff 3334
13fe0198
MA
3335 error = dsl_sync_task(drc->drc_tofs,
3336 dmu_recv_end_check, dmu_recv_end_sync, drc,
3d45fdd6 3337 dmu_recv_end_modified_blocks, ZFS_SPACE_CHECK_NORMAL);
428870ff 3338
13fe0198
MA
3339 if (error != 0) {
3340 dmu_recv_cleanup_ds(drc);
3341 } else if (drc->drc_guid_to_ds_map != NULL) {
3342 (void) add_ds_to_guidmap(drc->drc_tofs,
3343 drc->drc_guid_to_ds_map,
3344 drc->drc_newsnapobj);
428870ff 3345 }
13fe0198 3346 return (error);
428870ff
BB
3347}
3348
3349int
831baf06 3350dmu_recv_end(dmu_recv_cookie_t *drc, void *owner)
428870ff 3351{
831baf06
KW
3352 drc->drc_owner = owner;
3353
13fe0198 3354 if (drc->drc_newfs)
428870ff 3355 return (dmu_recv_new_end(drc));
13fe0198
MA
3356 else
3357 return (dmu_recv_existing_end(drc));
428870ff 3358}
ea97f8ce
MA
3359
3360/*
3361 * Return TRUE if this objset is currently being received into.
3362 */
3363boolean_t
3364dmu_objset_is_receiving(objset_t *os)
3365{
3366 return (os->os_dsl_dataset != NULL &&
3367 os->os_dsl_dataset->ds_owner == dmu_recv_tag);
3368}
fd8febbd
TF
3369
3370#if defined(_KERNEL)
3371module_param(zfs_send_corrupt_data, int, 0644);
3372MODULE_PARM_DESC(zfs_send_corrupt_data, "Allow sending corrupt data");
3373#endif