dmu_send.c revision 228103
1/*
2 * CDDL HEADER START
3 *
4 * The contents of this file are subject to the terms of the
5 * Common Development and Distribution License (the "License").
6 * You may not use this file except in compliance with the License.
7 *
8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 * or http://www.opensolaris.org/os/licensing.
10 * See the License for the specific language governing permissions
11 * and limitations under the License.
12 *
13 * When distributing Covered Code, include this CDDL HEADER in each
14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 * If applicable, add the following below this CDDL HEADER, with the
16 * fields enclosed by brackets "[]" replaced with your own identifying
17 * information: Portions Copyright [yyyy] [name of copyright owner]
18 *
19 * CDDL HEADER END
20 */
21/*
22 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
23 * Copyright (c) 2011 by Delphix. All rights reserved.
24 */
25/*
26 * Copyright 2011 Nexenta Systems, Inc. All rights reserved.
27 * Copyright (c) 2011 by Delphix. All rights reserved.
28 */
29
30#include <sys/dmu.h>
31#include <sys/dmu_impl.h>
32#include <sys/dmu_tx.h>
33#include <sys/dbuf.h>
34#include <sys/dnode.h>
35#include <sys/zfs_context.h>
36#include <sys/dmu_objset.h>
37#include <sys/dmu_traverse.h>
38#include <sys/dsl_dataset.h>
39#include <sys/dsl_dir.h>
40#include <sys/dsl_prop.h>
41#include <sys/dsl_pool.h>
42#include <sys/dsl_synctask.h>
43#include <sys/zfs_ioctl.h>
44#include <sys/zap.h>
45#include <sys/zio_checksum.h>
46#include <sys/zfs_znode.h>
47#include <zfs_fletcher.h>
48#include <sys/avl.h>
49#include <sys/ddt.h>
50#include <sys/zfs_onexit.h>
51
52/* Set this tunable to TRUE to replace corrupt data with 0x2f5baddb10c */
53int zfs_send_corrupt_data = B_FALSE;
54
55static char *dmu_recv_tag = "dmu_recv_tag";
56
57/*
58 * The list of data whose inclusion in a send stream can be pending from
59 * one call to backup_cb to another.  Multiple calls to dump_free() and
60 * dump_freeobjects() can be aggregated into a single DRR_FREE or
61 * DRR_FREEOBJECTS replay record.
62 */
63typedef enum {
64	PENDING_NONE,
65	PENDING_FREE,
66	PENDING_FREEOBJECTS
67} pendop_t;
68
69struct backuparg {
70	dmu_replay_record_t *drr;
71	kthread_t *td;
72	struct file *fp;
73	offset_t *off;
74	objset_t *os;
75	zio_cksum_t zc;
76	uint64_t toguid;
77	int err;
78	pendop_t pending_op;
79};
80
81static int
82dump_bytes(struct backuparg *ba, void *buf, int len)
83{
84	struct uio auio;
85	struct iovec aiov;
86	ASSERT3U(len % 8, ==, 0);
87
88	fletcher_4_incremental_native(buf, len, &ba->zc);
89	aiov.iov_base = buf;
90	aiov.iov_len = len;
91	auio.uio_iov = &aiov;
92	auio.uio_iovcnt = 1;
93	auio.uio_resid = len;
94	auio.uio_segflg = UIO_SYSSPACE;
95	auio.uio_rw = UIO_WRITE;
96	auio.uio_offset = (off_t)-1;
97	auio.uio_td = ba->td;
98#ifdef _KERNEL
99	if (ba->fp->f_type == DTYPE_VNODE)
100		bwillwrite();
101	ba->err = fo_write(ba->fp, &auio, ba->td->td_ucred, 0, ba->td);
102#else
103	fprintf(stderr, "%s: returning EOPNOTSUPP\n", __func__);
104	ba->err = EOPNOTSUPP;
105#endif
106	*ba->off += len;
107	return (ba->err);
108}
109
110static int
111dump_free(struct backuparg *ba, uint64_t object, uint64_t offset,
112    uint64_t length)
113{
114	struct drr_free *drrf = &(ba->drr->drr_u.drr_free);
115
116	/*
117	 * If there is a pending op, but it's not PENDING_FREE, push it out,
118	 * since free block aggregation can only be done for blocks of the
119	 * same type (i.e., DRR_FREE records can only be aggregated with
120	 * other DRR_FREE records.  DRR_FREEOBJECTS records can only be
121	 * aggregated with other DRR_FREEOBJECTS records.
122	 */
123	if (ba->pending_op != PENDING_NONE && ba->pending_op != PENDING_FREE) {
124		if (dump_bytes(ba, ba->drr, sizeof (dmu_replay_record_t)) != 0)
125			return (EINTR);
126		ba->pending_op = PENDING_NONE;
127	}
128
129	if (ba->pending_op == PENDING_FREE) {
130		/*
131		 * There should never be a PENDING_FREE if length is -1
132		 * (because dump_dnode is the only place where this
133		 * function is called with a -1, and only after flushing
134		 * any pending record).
135		 */
136		ASSERT(length != -1ULL);
137		/*
138		 * Check to see whether this free block can be aggregated
139		 * with pending one.
140		 */
141		if (drrf->drr_object == object && drrf->drr_offset +
142		    drrf->drr_length == offset) {
143			drrf->drr_length += length;
144			return (0);
145		} else {
146			/* not a continuation.  Push out pending record */
147			if (dump_bytes(ba, ba->drr,
148			    sizeof (dmu_replay_record_t)) != 0)
149				return (EINTR);
150			ba->pending_op = PENDING_NONE;
151		}
152	}
153	/* create a FREE record and make it pending */
154	bzero(ba->drr, sizeof (dmu_replay_record_t));
155	ba->drr->drr_type = DRR_FREE;
156	drrf->drr_object = object;
157	drrf->drr_offset = offset;
158	drrf->drr_length = length;
159	drrf->drr_toguid = ba->toguid;
160	if (length == -1ULL) {
161		if (dump_bytes(ba, ba->drr, sizeof (dmu_replay_record_t)) != 0)
162			return (EINTR);
163	} else {
164		ba->pending_op = PENDING_FREE;
165	}
166
167	return (0);
168}
169
170static int
171dump_data(struct backuparg *ba, dmu_object_type_t type,
172    uint64_t object, uint64_t offset, int blksz, const blkptr_t *bp, void *data)
173{
174	struct drr_write *drrw = &(ba->drr->drr_u.drr_write);
175
176
177	/*
178	 * If there is any kind of pending aggregation (currently either
179	 * a grouping of free objects or free blocks), push it out to
180	 * the stream, since aggregation can't be done across operations
181	 * of different types.
182	 */
183	if (ba->pending_op != PENDING_NONE) {
184		if (dump_bytes(ba, ba->drr, sizeof (dmu_replay_record_t)) != 0)
185			return (EINTR);
186		ba->pending_op = PENDING_NONE;
187	}
188	/* write a DATA record */
189	bzero(ba->drr, sizeof (dmu_replay_record_t));
190	ba->drr->drr_type = DRR_WRITE;
191	drrw->drr_object = object;
192	drrw->drr_type = type;
193	drrw->drr_offset = offset;
194	drrw->drr_length = blksz;
195	drrw->drr_toguid = ba->toguid;
196	drrw->drr_checksumtype = BP_GET_CHECKSUM(bp);
197	if (zio_checksum_table[drrw->drr_checksumtype].ci_dedup)
198		drrw->drr_checksumflags |= DRR_CHECKSUM_DEDUP;
199	DDK_SET_LSIZE(&drrw->drr_key, BP_GET_LSIZE(bp));
200	DDK_SET_PSIZE(&drrw->drr_key, BP_GET_PSIZE(bp));
201	DDK_SET_COMPRESS(&drrw->drr_key, BP_GET_COMPRESS(bp));
202	drrw->drr_key.ddk_cksum = bp->blk_cksum;
203
204	if (dump_bytes(ba, ba->drr, sizeof (dmu_replay_record_t)) != 0)
205		return (EINTR);
206	if (dump_bytes(ba, data, blksz) != 0)
207		return (EINTR);
208	return (0);
209}
210
211static int
212dump_spill(struct backuparg *ba, uint64_t object, int blksz, void *data)
213{
214	struct drr_spill *drrs = &(ba->drr->drr_u.drr_spill);
215
216	if (ba->pending_op != PENDING_NONE) {
217		if (dump_bytes(ba, ba->drr, sizeof (dmu_replay_record_t)) != 0)
218			return (EINTR);
219		ba->pending_op = PENDING_NONE;
220	}
221
222	/* write a SPILL record */
223	bzero(ba->drr, sizeof (dmu_replay_record_t));
224	ba->drr->drr_type = DRR_SPILL;
225	drrs->drr_object = object;
226	drrs->drr_length = blksz;
227	drrs->drr_toguid = ba->toguid;
228
229	if (dump_bytes(ba, ba->drr, sizeof (dmu_replay_record_t)))
230		return (EINTR);
231	if (dump_bytes(ba, data, blksz))
232		return (EINTR);
233	return (0);
234}
235
236static int
237dump_freeobjects(struct backuparg *ba, uint64_t firstobj, uint64_t numobjs)
238{
239	struct drr_freeobjects *drrfo = &(ba->drr->drr_u.drr_freeobjects);
240
241	/*
242	 * If there is a pending op, but it's not PENDING_FREEOBJECTS,
243	 * push it out, since free block aggregation can only be done for
244	 * blocks of the same type (i.e., DRR_FREE records can only be
245	 * aggregated with other DRR_FREE records.  DRR_FREEOBJECTS records
246	 * can only be aggregated with other DRR_FREEOBJECTS records.
247	 */
248	if (ba->pending_op != PENDING_NONE &&
249	    ba->pending_op != PENDING_FREEOBJECTS) {
250		if (dump_bytes(ba, ba->drr, sizeof (dmu_replay_record_t)) != 0)
251			return (EINTR);
252		ba->pending_op = PENDING_NONE;
253	}
254	if (ba->pending_op == PENDING_FREEOBJECTS) {
255		/*
256		 * See whether this free object array can be aggregated
257		 * with pending one
258		 */
259		if (drrfo->drr_firstobj + drrfo->drr_numobjs == firstobj) {
260			drrfo->drr_numobjs += numobjs;
261			return (0);
262		} else {
263			/* can't be aggregated.  Push out pending record */
264			if (dump_bytes(ba, ba->drr,
265			    sizeof (dmu_replay_record_t)) != 0)
266				return (EINTR);
267			ba->pending_op = PENDING_NONE;
268		}
269	}
270
271	/* write a FREEOBJECTS record */
272	bzero(ba->drr, sizeof (dmu_replay_record_t));
273	ba->drr->drr_type = DRR_FREEOBJECTS;
274	drrfo->drr_firstobj = firstobj;
275	drrfo->drr_numobjs = numobjs;
276	drrfo->drr_toguid = ba->toguid;
277
278	ba->pending_op = PENDING_FREEOBJECTS;
279
280	return (0);
281}
282
283static int
284dump_dnode(struct backuparg *ba, uint64_t object, dnode_phys_t *dnp)
285{
286	struct drr_object *drro = &(ba->drr->drr_u.drr_object);
287
288	if (dnp == NULL || dnp->dn_type == DMU_OT_NONE)
289		return (dump_freeobjects(ba, object, 1));
290
291	if (ba->pending_op != PENDING_NONE) {
292		if (dump_bytes(ba, ba->drr, sizeof (dmu_replay_record_t)) != 0)
293			return (EINTR);
294		ba->pending_op = PENDING_NONE;
295	}
296
297	/* write an OBJECT record */
298	bzero(ba->drr, sizeof (dmu_replay_record_t));
299	ba->drr->drr_type = DRR_OBJECT;
300	drro->drr_object = object;
301	drro->drr_type = dnp->dn_type;
302	drro->drr_bonustype = dnp->dn_bonustype;
303	drro->drr_blksz = dnp->dn_datablkszsec << SPA_MINBLOCKSHIFT;
304	drro->drr_bonuslen = dnp->dn_bonuslen;
305	drro->drr_checksumtype = dnp->dn_checksum;
306	drro->drr_compress = dnp->dn_compress;
307	drro->drr_toguid = ba->toguid;
308
309	if (dump_bytes(ba, ba->drr, sizeof (dmu_replay_record_t)) != 0)
310		return (EINTR);
311
312	if (dump_bytes(ba, DN_BONUS(dnp), P2ROUNDUP(dnp->dn_bonuslen, 8)) != 0)
313		return (EINTR);
314
315	/* free anything past the end of the file */
316	if (dump_free(ba, object, (dnp->dn_maxblkid + 1) *
317	    (dnp->dn_datablkszsec << SPA_MINBLOCKSHIFT), -1ULL))
318		return (EINTR);
319	if (ba->err)
320		return (EINTR);
321	return (0);
322}
323
324#define	BP_SPAN(dnp, level) \
325	(((uint64_t)dnp->dn_datablkszsec) << (SPA_MINBLOCKSHIFT + \
326	(level) * (dnp->dn_indblkshift - SPA_BLKPTRSHIFT)))
327
328/* ARGSUSED */
329static int
330backup_cb(spa_t *spa, zilog_t *zilog, const blkptr_t *bp, arc_buf_t *pbuf,
331    const zbookmark_t *zb, const dnode_phys_t *dnp, void *arg)
332{
333	struct backuparg *ba = arg;
334	dmu_object_type_t type = bp ? BP_GET_TYPE(bp) : DMU_OT_NONE;
335	int err = 0;
336
337	if (issig(JUSTLOOKING) && issig(FORREAL))
338		return (EINTR);
339
340	if (zb->zb_object != DMU_META_DNODE_OBJECT &&
341	    DMU_OBJECT_IS_SPECIAL(zb->zb_object)) {
342		return (0);
343	} else if (bp == NULL && zb->zb_object == DMU_META_DNODE_OBJECT) {
344		uint64_t span = BP_SPAN(dnp, zb->zb_level);
345		uint64_t dnobj = (zb->zb_blkid * span) >> DNODE_SHIFT;
346		err = dump_freeobjects(ba, dnobj, span >> DNODE_SHIFT);
347	} else if (bp == NULL) {
348		uint64_t span = BP_SPAN(dnp, zb->zb_level);
349		err = dump_free(ba, zb->zb_object, zb->zb_blkid * span, span);
350	} else if (zb->zb_level > 0 || type == DMU_OT_OBJSET) {
351		return (0);
352	} else if (type == DMU_OT_DNODE) {
353		dnode_phys_t *blk;
354		int i;
355		int blksz = BP_GET_LSIZE(bp);
356		uint32_t aflags = ARC_WAIT;
357		arc_buf_t *abuf;
358
359		if (dsl_read(NULL, spa, bp, pbuf,
360		    arc_getbuf_func, &abuf, ZIO_PRIORITY_ASYNC_READ,
361		    ZIO_FLAG_CANFAIL, &aflags, zb) != 0)
362			return (EIO);
363
364		blk = abuf->b_data;
365		for (i = 0; i < blksz >> DNODE_SHIFT; i++) {
366			uint64_t dnobj = (zb->zb_blkid <<
367			    (DNODE_BLOCK_SHIFT - DNODE_SHIFT)) + i;
368			err = dump_dnode(ba, dnobj, blk+i);
369			if (err)
370				break;
371		}
372		(void) arc_buf_remove_ref(abuf, &abuf);
373	} else if (type == DMU_OT_SA) {
374		uint32_t aflags = ARC_WAIT;
375		arc_buf_t *abuf;
376		int blksz = BP_GET_LSIZE(bp);
377
378		if (arc_read_nolock(NULL, spa, bp,
379		    arc_getbuf_func, &abuf, ZIO_PRIORITY_ASYNC_READ,
380		    ZIO_FLAG_CANFAIL, &aflags, zb) != 0)
381			return (EIO);
382
383		err = dump_spill(ba, zb->zb_object, blksz, abuf->b_data);
384		(void) arc_buf_remove_ref(abuf, &abuf);
385	} else { /* it's a level-0 block of a regular object */
386		uint32_t aflags = ARC_WAIT;
387		arc_buf_t *abuf;
388		int blksz = BP_GET_LSIZE(bp);
389
390		if (dsl_read(NULL, spa, bp, pbuf,
391		    arc_getbuf_func, &abuf, ZIO_PRIORITY_ASYNC_READ,
392		    ZIO_FLAG_CANFAIL, &aflags, zb) != 0) {
393			if (zfs_send_corrupt_data) {
394				/* Send a block filled with 0x"zfs badd bloc" */
395				abuf = arc_buf_alloc(spa, blksz, &abuf,
396				    ARC_BUFC_DATA);
397				uint64_t *ptr;
398				for (ptr = abuf->b_data;
399				    (char *)ptr < (char *)abuf->b_data + blksz;
400				    ptr++)
401					*ptr = 0x2f5baddb10c;
402			} else {
403				return (EIO);
404			}
405		}
406
407		err = dump_data(ba, type, zb->zb_object, zb->zb_blkid * blksz,
408		    blksz, bp, abuf->b_data);
409		(void) arc_buf_remove_ref(abuf, &abuf);
410	}
411
412	ASSERT(err == 0 || err == EINTR);
413	return (err);
414}
415
416int
417dmu_sendbackup(objset_t *tosnap, objset_t *fromsnap, boolean_t fromorigin,
418    struct file *fp, offset_t *off)
419{
420	dsl_dataset_t *ds = tosnap->os_dsl_dataset;
421	dsl_dataset_t *fromds = fromsnap ? fromsnap->os_dsl_dataset : NULL;
422	dmu_replay_record_t *drr;
423	struct backuparg ba;
424	int err;
425	uint64_t fromtxg = 0;
426
427	/* tosnap must be a snapshot */
428	if (ds->ds_phys->ds_next_snap_obj == 0)
429		return (EINVAL);
430
431	/* fromsnap must be an earlier snapshot from the same fs as tosnap */
432	if (fromds && (ds->ds_dir != fromds->ds_dir ||
433	    fromds->ds_phys->ds_creation_txg >= ds->ds_phys->ds_creation_txg))
434		return (EXDEV);
435
436	if (fromorigin) {
437		dsl_pool_t *dp = ds->ds_dir->dd_pool;
438
439		if (fromsnap)
440			return (EINVAL);
441
442		if (dsl_dir_is_clone(ds->ds_dir)) {
443			rw_enter(&dp->dp_config_rwlock, RW_READER);
444			err = dsl_dataset_hold_obj(dp,
445			    ds->ds_dir->dd_phys->dd_origin_obj, FTAG, &fromds);
446			rw_exit(&dp->dp_config_rwlock);
447			if (err)
448				return (err);
449		} else {
450			fromorigin = B_FALSE;
451		}
452	}
453
454
455	drr = kmem_zalloc(sizeof (dmu_replay_record_t), KM_SLEEP);
456	drr->drr_type = DRR_BEGIN;
457	drr->drr_u.drr_begin.drr_magic = DMU_BACKUP_MAGIC;
458	DMU_SET_STREAM_HDRTYPE(drr->drr_u.drr_begin.drr_versioninfo,
459	    DMU_SUBSTREAM);
460
461#ifdef _KERNEL
462	if (dmu_objset_type(tosnap) == DMU_OST_ZFS) {
463		uint64_t version;
464		if (zfs_get_zplprop(tosnap, ZFS_PROP_VERSION, &version) != 0)
465			return (EINVAL);
466		if (version == ZPL_VERSION_SA) {
467			DMU_SET_FEATUREFLAGS(
468			    drr->drr_u.drr_begin.drr_versioninfo,
469			    DMU_BACKUP_FEATURE_SA_SPILL);
470		}
471	}
472#endif
473
474	drr->drr_u.drr_begin.drr_creation_time =
475	    ds->ds_phys->ds_creation_time;
476	drr->drr_u.drr_begin.drr_type = tosnap->os_phys->os_type;
477	if (fromorigin)
478		drr->drr_u.drr_begin.drr_flags |= DRR_FLAG_CLONE;
479	drr->drr_u.drr_begin.drr_toguid = ds->ds_phys->ds_guid;
480	if (ds->ds_phys->ds_flags & DS_FLAG_CI_DATASET)
481		drr->drr_u.drr_begin.drr_flags |= DRR_FLAG_CI_DATA;
482
483	if (fromds)
484		drr->drr_u.drr_begin.drr_fromguid = fromds->ds_phys->ds_guid;
485	dsl_dataset_name(ds, drr->drr_u.drr_begin.drr_toname);
486
487	if (fromds)
488		fromtxg = fromds->ds_phys->ds_creation_txg;
489	if (fromorigin)
490		dsl_dataset_rele(fromds, FTAG);
491
492	ba.drr = drr;
493	ba.td = curthread;
494	ba.fp = fp;
495	ba.os = tosnap;
496	ba.off = off;
497	ba.toguid = ds->ds_phys->ds_guid;
498	ZIO_SET_CHECKSUM(&ba.zc, 0, 0, 0, 0);
499	ba.pending_op = PENDING_NONE;
500
501	if (dump_bytes(&ba, drr, sizeof (dmu_replay_record_t)) != 0) {
502		kmem_free(drr, sizeof (dmu_replay_record_t));
503		return (ba.err);
504	}
505
506	err = traverse_dataset(ds, fromtxg, TRAVERSE_PRE | TRAVERSE_PREFETCH,
507	    backup_cb, &ba);
508
509	if (ba.pending_op != PENDING_NONE)
510		if (dump_bytes(&ba, drr, sizeof (dmu_replay_record_t)) != 0)
511			err = EINTR;
512
513	if (err) {
514		if (err == EINTR && ba.err)
515			err = ba.err;
516		kmem_free(drr, sizeof (dmu_replay_record_t));
517		return (err);
518	}
519
520	bzero(drr, sizeof (dmu_replay_record_t));
521	drr->drr_type = DRR_END;
522	drr->drr_u.drr_end.drr_checksum = ba.zc;
523	drr->drr_u.drr_end.drr_toguid = ba.toguid;
524
525	if (dump_bytes(&ba, drr, sizeof (dmu_replay_record_t)) != 0) {
526		kmem_free(drr, sizeof (dmu_replay_record_t));
527		return (ba.err);
528	}
529
530	kmem_free(drr, sizeof (dmu_replay_record_t));
531
532	return (0);
533}
534
535int
536dmu_send_estimate(objset_t *tosnap, objset_t *fromsnap, boolean_t fromorigin,
537    uint64_t *sizep)
538{
539	dsl_dataset_t *ds = tosnap->os_dsl_dataset;
540	dsl_dataset_t *fromds = fromsnap ? fromsnap->os_dsl_dataset : NULL;
541	dsl_pool_t *dp = ds->ds_dir->dd_pool;
542	int err;
543	uint64_t size;
544
545	/* tosnap must be a snapshot */
546	if (ds->ds_phys->ds_next_snap_obj == 0)
547		return (EINVAL);
548
549	/* fromsnap must be an earlier snapshot from the same fs as tosnap */
550	if (fromds && (ds->ds_dir != fromds->ds_dir ||
551	    fromds->ds_phys->ds_creation_txg >= ds->ds_phys->ds_creation_txg))
552		return (EXDEV);
553
554	if (fromorigin) {
555		if (fromsnap)
556			return (EINVAL);
557
558		if (dsl_dir_is_clone(ds->ds_dir)) {
559			rw_enter(&dp->dp_config_rwlock, RW_READER);
560			err = dsl_dataset_hold_obj(dp,
561			    ds->ds_dir->dd_phys->dd_origin_obj, FTAG, &fromds);
562			rw_exit(&dp->dp_config_rwlock);
563			if (err)
564				return (err);
565		} else {
566			fromorigin = B_FALSE;
567		}
568	}
569
570	/* Get uncompressed size estimate of changed data. */
571	if (fromds == NULL) {
572		size = ds->ds_phys->ds_uncompressed_bytes;
573	} else {
574		uint64_t used, comp;
575		err = dsl_dataset_space_written(fromds, ds,
576		    &used, &comp, &size);
577		if (fromorigin)
578			dsl_dataset_rele(fromds, FTAG);
579		if (err)
580			return (err);
581	}
582
583	/*
584	 * Assume that space (both on-disk and in-stream) is dominated by
585	 * data.  We will adjust for indirect blocks and the copies property,
586	 * but ignore per-object space used (eg, dnodes and DRR_OBJECT records).
587	 */
588
589	/*
590	 * Subtract out approximate space used by indirect blocks.
591	 * Assume most space is used by data blocks (non-indirect, non-dnode).
592	 * Assume all blocks are recordsize.  Assume ditto blocks and
593	 * internal fragmentation counter out compression.
594	 *
595	 * Therefore, space used by indirect blocks is sizeof(blkptr_t) per
596	 * block, which we observe in practice.
597	 */
598	uint64_t recordsize;
599	rw_enter(&dp->dp_config_rwlock, RW_READER);
600	err = dsl_prop_get_ds(ds, "recordsize",
601	    sizeof (recordsize), 1, &recordsize, NULL);
602	rw_exit(&dp->dp_config_rwlock);
603	if (err)
604		return (err);
605	size -= size / recordsize * sizeof (blkptr_t);
606
607	/* Add in the space for the record associated with each block. */
608	size += size / recordsize * sizeof (dmu_replay_record_t);
609
610	*sizep = size;
611
612	return (0);
613}
614
615struct recvbeginsyncarg {
616	const char *tofs;
617	const char *tosnap;
618	dsl_dataset_t *origin;
619	uint64_t fromguid;
620	dmu_objset_type_t type;
621	void *tag;
622	boolean_t force;
623	uint64_t dsflags;
624	char clonelastname[MAXNAMELEN];
625	dsl_dataset_t *ds; /* the ds to recv into; returned from the syncfunc */
626	cred_t *cr;
627};
628
629/* ARGSUSED */
630static int
631recv_new_check(void *arg1, void *arg2, dmu_tx_t *tx)
632{
633	dsl_dir_t *dd = arg1;
634	struct recvbeginsyncarg *rbsa = arg2;
635	objset_t *mos = dd->dd_pool->dp_meta_objset;
636	uint64_t val;
637	int err;
638
639	err = zap_lookup(mos, dd->dd_phys->dd_child_dir_zapobj,
640	    strrchr(rbsa->tofs, '/') + 1, sizeof (uint64_t), 1, &val);
641
642	if (err != ENOENT)
643		return (err ? err : EEXIST);
644
645	if (rbsa->origin) {
646		/* make sure it's a snap in the same pool */
647		if (rbsa->origin->ds_dir->dd_pool != dd->dd_pool)
648			return (EXDEV);
649		if (!dsl_dataset_is_snapshot(rbsa->origin))
650			return (EINVAL);
651		if (rbsa->origin->ds_phys->ds_guid != rbsa->fromguid)
652			return (ENODEV);
653	}
654
655	return (0);
656}
657
658static void
659recv_new_sync(void *arg1, void *arg2, dmu_tx_t *tx)
660{
661	dsl_dir_t *dd = arg1;
662	struct recvbeginsyncarg *rbsa = arg2;
663	uint64_t flags = DS_FLAG_INCONSISTENT | rbsa->dsflags;
664	uint64_t dsobj;
665
666	/* Create and open new dataset. */
667	dsobj = dsl_dataset_create_sync(dd, strrchr(rbsa->tofs, '/') + 1,
668	    rbsa->origin, flags, rbsa->cr, tx);
669	VERIFY(0 == dsl_dataset_own_obj(dd->dd_pool, dsobj,
670	    B_TRUE, dmu_recv_tag, &rbsa->ds));
671
672	if (rbsa->origin == NULL) {
673		(void) dmu_objset_create_impl(dd->dd_pool->dp_spa,
674		    rbsa->ds, &rbsa->ds->ds_phys->ds_bp, rbsa->type, tx);
675	}
676
677	spa_history_log_internal(LOG_DS_REPLAY_FULL_SYNC,
678	    dd->dd_pool->dp_spa, tx, "dataset = %lld", dsobj);
679}
680
681/* ARGSUSED */
682static int
683recv_existing_check(void *arg1, void *arg2, dmu_tx_t *tx)
684{
685	dsl_dataset_t *ds = arg1;
686	struct recvbeginsyncarg *rbsa = arg2;
687	int err;
688	uint64_t val;
689
690	/* must not have any changes since most recent snapshot */
691	if (!rbsa->force && dsl_dataset_modified_since_lastsnap(ds))
692		return (ETXTBSY);
693
694	/* new snapshot name must not exist */
695	err = zap_lookup(ds->ds_dir->dd_pool->dp_meta_objset,
696	    ds->ds_phys->ds_snapnames_zapobj, rbsa->tosnap, 8, 1, &val);
697	if (err == 0)
698		return (EEXIST);
699	if (err != ENOENT)
700		return (err);
701
702	if (rbsa->fromguid) {
703		/* if incremental, most recent snapshot must match fromguid */
704		if (ds->ds_prev == NULL)
705			return (ENODEV);
706
707		/*
708		 * most recent snapshot must match fromguid, or there are no
709		 * changes since the fromguid one
710		 */
711		if (ds->ds_prev->ds_phys->ds_guid != rbsa->fromguid) {
712			uint64_t birth = ds->ds_prev->ds_phys->ds_bp.blk_birth;
713			uint64_t obj = ds->ds_prev->ds_phys->ds_prev_snap_obj;
714			while (obj != 0) {
715				dsl_dataset_t *snap;
716				err = dsl_dataset_hold_obj(ds->ds_dir->dd_pool,
717				    obj, FTAG, &snap);
718				if (err)
719					return (ENODEV);
720				if (snap->ds_phys->ds_creation_txg < birth) {
721					dsl_dataset_rele(snap, FTAG);
722					return (ENODEV);
723				}
724				if (snap->ds_phys->ds_guid == rbsa->fromguid) {
725					dsl_dataset_rele(snap, FTAG);
726					break; /* it's ok */
727				}
728				obj = snap->ds_phys->ds_prev_snap_obj;
729				dsl_dataset_rele(snap, FTAG);
730			}
731			if (obj == 0)
732				return (ENODEV);
733		}
734	} else {
735		/* if full, most recent snapshot must be $ORIGIN */
736		if (ds->ds_phys->ds_prev_snap_txg >= TXG_INITIAL)
737			return (ENODEV);
738	}
739
740	/* temporary clone name must not exist */
741	err = zap_lookup(ds->ds_dir->dd_pool->dp_meta_objset,
742	    ds->ds_dir->dd_phys->dd_child_dir_zapobj,
743	    rbsa->clonelastname, 8, 1, &val);
744	if (err == 0)
745		return (EEXIST);
746	if (err != ENOENT)
747		return (err);
748
749	return (0);
750}
751
752/* ARGSUSED */
753static void
754recv_existing_sync(void *arg1, void *arg2, dmu_tx_t *tx)
755{
756	dsl_dataset_t *ohds = arg1;
757	struct recvbeginsyncarg *rbsa = arg2;
758	dsl_pool_t *dp = ohds->ds_dir->dd_pool;
759	dsl_dataset_t *cds;
760	uint64_t flags = DS_FLAG_INCONSISTENT | rbsa->dsflags;
761	uint64_t dsobj;
762
763	/* create and open the temporary clone */
764	dsobj = dsl_dataset_create_sync(ohds->ds_dir, rbsa->clonelastname,
765	    ohds->ds_prev, flags, rbsa->cr, tx);
766	VERIFY(0 == dsl_dataset_own_obj(dp, dsobj, B_TRUE, dmu_recv_tag, &cds));
767
768	/*
769	 * If we actually created a non-clone, we need to create the
770	 * objset in our new dataset.
771	 */
772	if (BP_IS_HOLE(dsl_dataset_get_blkptr(cds))) {
773		(void) dmu_objset_create_impl(dp->dp_spa,
774		    cds, dsl_dataset_get_blkptr(cds), rbsa->type, tx);
775	}
776
777	rbsa->ds = cds;
778
779	spa_history_log_internal(LOG_DS_REPLAY_INC_SYNC,
780	    dp->dp_spa, tx, "dataset = %lld", dsobj);
781}
782
783static boolean_t
784dmu_recv_verify_features(dsl_dataset_t *ds, struct drr_begin *drrb)
785{
786	int featureflags;
787
788	featureflags = DMU_GET_FEATUREFLAGS(drrb->drr_versioninfo);
789
790	/* Verify pool version supports SA if SA_SPILL feature set */
791	return ((featureflags & DMU_BACKUP_FEATURE_SA_SPILL) &&
792	    (spa_version(dsl_dataset_get_spa(ds)) < SPA_VERSION_SA));
793}
794
795/*
796 * NB: callers *MUST* call dmu_recv_stream() if dmu_recv_begin()
797 * succeeds; otherwise we will leak the holds on the datasets.
798 */
799int
800dmu_recv_begin(char *tofs, char *tosnap, char *top_ds, struct drr_begin *drrb,
801    boolean_t force, objset_t *origin, dmu_recv_cookie_t *drc)
802{
803	int err = 0;
804	boolean_t byteswap;
805	struct recvbeginsyncarg rbsa = { 0 };
806	uint64_t versioninfo;
807	int flags;
808	dsl_dataset_t *ds;
809
810	if (drrb->drr_magic == DMU_BACKUP_MAGIC)
811		byteswap = FALSE;
812	else if (drrb->drr_magic == BSWAP_64(DMU_BACKUP_MAGIC))
813		byteswap = TRUE;
814	else
815		return (EINVAL);
816
817	rbsa.tofs = tofs;
818	rbsa.tosnap = tosnap;
819	rbsa.origin = origin ? origin->os_dsl_dataset : NULL;
820	rbsa.fromguid = drrb->drr_fromguid;
821	rbsa.type = drrb->drr_type;
822	rbsa.tag = FTAG;
823	rbsa.dsflags = 0;
824	rbsa.cr = CRED();
825	versioninfo = drrb->drr_versioninfo;
826	flags = drrb->drr_flags;
827
828	if (byteswap) {
829		rbsa.type = BSWAP_32(rbsa.type);
830		rbsa.fromguid = BSWAP_64(rbsa.fromguid);
831		versioninfo = BSWAP_64(versioninfo);
832		flags = BSWAP_32(flags);
833	}
834
835	if (DMU_GET_STREAM_HDRTYPE(versioninfo) == DMU_COMPOUNDSTREAM ||
836	    rbsa.type >= DMU_OST_NUMTYPES ||
837	    ((flags & DRR_FLAG_CLONE) && origin == NULL))
838		return (EINVAL);
839
840	if (flags & DRR_FLAG_CI_DATA)
841		rbsa.dsflags = DS_FLAG_CI_DATASET;
842
843	bzero(drc, sizeof (dmu_recv_cookie_t));
844	drc->drc_drrb = drrb;
845	drc->drc_tosnap = tosnap;
846	drc->drc_top_ds = top_ds;
847	drc->drc_force = force;
848
849	/*
850	 * Process the begin in syncing context.
851	 */
852
853	/* open the dataset we are logically receiving into */
854	err = dsl_dataset_hold(tofs, dmu_recv_tag, &ds);
855	if (err == 0) {
856		if (dmu_recv_verify_features(ds, drrb)) {
857			dsl_dataset_rele(ds, dmu_recv_tag);
858			return (ENOTSUP);
859		}
860		/* target fs already exists; recv into temp clone */
861
862		/* Can't recv a clone into an existing fs */
863		if (flags & DRR_FLAG_CLONE) {
864			dsl_dataset_rele(ds, dmu_recv_tag);
865			return (EINVAL);
866		}
867
868		/* must not have an incremental recv already in progress */
869		if (!mutex_tryenter(&ds->ds_recvlock)) {
870			dsl_dataset_rele(ds, dmu_recv_tag);
871			return (EBUSY);
872		}
873
874		/* tmp clone name is: tofs/%tosnap" */
875		(void) snprintf(rbsa.clonelastname, sizeof (rbsa.clonelastname),
876		    "%%%s", tosnap);
877		rbsa.force = force;
878		err = dsl_sync_task_do(ds->ds_dir->dd_pool,
879		    recv_existing_check, recv_existing_sync, ds, &rbsa, 5);
880		if (err) {
881			mutex_exit(&ds->ds_recvlock);
882			dsl_dataset_rele(ds, dmu_recv_tag);
883			return (err);
884		}
885		drc->drc_logical_ds = ds;
886		drc->drc_real_ds = rbsa.ds;
887	} else if (err == ENOENT) {
888		/* target fs does not exist; must be a full backup or clone */
889		char *cp;
890
891		/*
892		 * If it's a non-clone incremental, we are missing the
893		 * target fs, so fail the recv.
894		 */
895		if (rbsa.fromguid && !(flags & DRR_FLAG_CLONE))
896			return (ENOENT);
897
898		/* Open the parent of tofs */
899		cp = strrchr(tofs, '/');
900		*cp = '\0';
901		err = dsl_dataset_hold(tofs, FTAG, &ds);
902		*cp = '/';
903		if (err)
904			return (err);
905
906		if (dmu_recv_verify_features(ds, drrb)) {
907			dsl_dataset_rele(ds, FTAG);
908			return (ENOTSUP);
909		}
910
911		err = dsl_sync_task_do(ds->ds_dir->dd_pool,
912		    recv_new_check, recv_new_sync, ds->ds_dir, &rbsa, 5);
913		dsl_dataset_rele(ds, FTAG);
914		if (err)
915			return (err);
916		drc->drc_logical_ds = drc->drc_real_ds = rbsa.ds;
917		drc->drc_newfs = B_TRUE;
918	}
919
920	return (err);
921}
922
923struct restorearg {
924	int err;
925	int byteswap;
926	kthread_t *td;
927	struct file *fp;
928	char *buf;
929	uint64_t voff;
930	int bufsize; /* amount of memory allocated for buf */
931	zio_cksum_t cksum;
932	avl_tree_t *guid_to_ds_map;
933};
934
935typedef struct guid_map_entry {
936	uint64_t	guid;
937	dsl_dataset_t	*gme_ds;
938	avl_node_t	avlnode;
939} guid_map_entry_t;
940
941static int
942guid_compare(const void *arg1, const void *arg2)
943{
944	const guid_map_entry_t *gmep1 = arg1;
945	const guid_map_entry_t *gmep2 = arg2;
946
947	if (gmep1->guid < gmep2->guid)
948		return (-1);
949	else if (gmep1->guid > gmep2->guid)
950		return (1);
951	return (0);
952}
953
954static void
955free_guid_map_onexit(void *arg)
956{
957	avl_tree_t *ca = arg;
958	void *cookie = NULL;
959	guid_map_entry_t *gmep;
960
961	while ((gmep = avl_destroy_nodes(ca, &cookie)) != NULL) {
962		dsl_dataset_rele(gmep->gme_ds, ca);
963		kmem_free(gmep, sizeof (guid_map_entry_t));
964	}
965	avl_destroy(ca);
966	kmem_free(ca, sizeof (avl_tree_t));
967}
968
969static int
970restore_bytes(struct restorearg *ra, void *buf, int len, off_t off, ssize_t *resid)
971{
972	struct uio auio;
973	struct iovec aiov;
974	int error;
975
976	aiov.iov_base = buf;
977	aiov.iov_len = len;
978	auio.uio_iov = &aiov;
979	auio.uio_iovcnt = 1;
980	auio.uio_resid = len;
981	auio.uio_segflg = UIO_SYSSPACE;
982	auio.uio_rw = UIO_READ;
983	auio.uio_offset = off;
984	auio.uio_td = ra->td;
985#ifdef _KERNEL
986	error = fo_read(ra->fp, &auio, ra->td->td_ucred, FOF_OFFSET, ra->td);
987#else
988	fprintf(stderr, "%s: returning EOPNOTSUPP\n", __func__);
989	error = EOPNOTSUPP;
990#endif
991	*resid = auio.uio_resid;
992	return (error);
993}
994
995static void *
996restore_read(struct restorearg *ra, int len)
997{
998	void *rv;
999	int done = 0;
1000
1001	/* some things will require 8-byte alignment, so everything must */
1002	ASSERT3U(len % 8, ==, 0);
1003
1004	while (done < len) {
1005		ssize_t resid;
1006
1007		ra->err = restore_bytes(ra, (caddr_t)ra->buf + done,
1008		    len - done, ra->voff, &resid);
1009
1010		if (resid == len - done)
1011			ra->err = EINVAL;
1012		ra->voff += len - done - resid;
1013		done = len - resid;
1014		if (ra->err)
1015			return (NULL);
1016	}
1017
1018	ASSERT3U(done, ==, len);
1019	rv = ra->buf;
1020	if (ra->byteswap)
1021		fletcher_4_incremental_byteswap(rv, len, &ra->cksum);
1022	else
1023		fletcher_4_incremental_native(rv, len, &ra->cksum);
1024	return (rv);
1025}
1026
1027static void
1028backup_byteswap(dmu_replay_record_t *drr)
1029{
1030#define	DO64(X) (drr->drr_u.X = BSWAP_64(drr->drr_u.X))
1031#define	DO32(X) (drr->drr_u.X = BSWAP_32(drr->drr_u.X))
1032	drr->drr_type = BSWAP_32(drr->drr_type);
1033	drr->drr_payloadlen = BSWAP_32(drr->drr_payloadlen);
1034	switch (drr->drr_type) {
1035	case DRR_BEGIN:
1036		DO64(drr_begin.drr_magic);
1037		DO64(drr_begin.drr_versioninfo);
1038		DO64(drr_begin.drr_creation_time);
1039		DO32(drr_begin.drr_type);
1040		DO32(drr_begin.drr_flags);
1041		DO64(drr_begin.drr_toguid);
1042		DO64(drr_begin.drr_fromguid);
1043		break;
1044	case DRR_OBJECT:
1045		DO64(drr_object.drr_object);
1046		/* DO64(drr_object.drr_allocation_txg); */
1047		DO32(drr_object.drr_type);
1048		DO32(drr_object.drr_bonustype);
1049		DO32(drr_object.drr_blksz);
1050		DO32(drr_object.drr_bonuslen);
1051		DO64(drr_object.drr_toguid);
1052		break;
1053	case DRR_FREEOBJECTS:
1054		DO64(drr_freeobjects.drr_firstobj);
1055		DO64(drr_freeobjects.drr_numobjs);
1056		DO64(drr_freeobjects.drr_toguid);
1057		break;
1058	case DRR_WRITE:
1059		DO64(drr_write.drr_object);
1060		DO32(drr_write.drr_type);
1061		DO64(drr_write.drr_offset);
1062		DO64(drr_write.drr_length);
1063		DO64(drr_write.drr_toguid);
1064		DO64(drr_write.drr_key.ddk_cksum.zc_word[0]);
1065		DO64(drr_write.drr_key.ddk_cksum.zc_word[1]);
1066		DO64(drr_write.drr_key.ddk_cksum.zc_word[2]);
1067		DO64(drr_write.drr_key.ddk_cksum.zc_word[3]);
1068		DO64(drr_write.drr_key.ddk_prop);
1069		break;
1070	case DRR_WRITE_BYREF:
1071		DO64(drr_write_byref.drr_object);
1072		DO64(drr_write_byref.drr_offset);
1073		DO64(drr_write_byref.drr_length);
1074		DO64(drr_write_byref.drr_toguid);
1075		DO64(drr_write_byref.drr_refguid);
1076		DO64(drr_write_byref.drr_refobject);
1077		DO64(drr_write_byref.drr_refoffset);
1078		DO64(drr_write_byref.drr_key.ddk_cksum.zc_word[0]);
1079		DO64(drr_write_byref.drr_key.ddk_cksum.zc_word[1]);
1080		DO64(drr_write_byref.drr_key.ddk_cksum.zc_word[2]);
1081		DO64(drr_write_byref.drr_key.ddk_cksum.zc_word[3]);
1082		DO64(drr_write_byref.drr_key.ddk_prop);
1083		break;
1084	case DRR_FREE:
1085		DO64(drr_free.drr_object);
1086		DO64(drr_free.drr_offset);
1087		DO64(drr_free.drr_length);
1088		DO64(drr_free.drr_toguid);
1089		break;
1090	case DRR_SPILL:
1091		DO64(drr_spill.drr_object);
1092		DO64(drr_spill.drr_length);
1093		DO64(drr_spill.drr_toguid);
1094		break;
1095	case DRR_END:
1096		DO64(drr_end.drr_checksum.zc_word[0]);
1097		DO64(drr_end.drr_checksum.zc_word[1]);
1098		DO64(drr_end.drr_checksum.zc_word[2]);
1099		DO64(drr_end.drr_checksum.zc_word[3]);
1100		DO64(drr_end.drr_toguid);
1101		break;
1102	}
1103#undef DO64
1104#undef DO32
1105}
1106
1107static int
1108restore_object(struct restorearg *ra, objset_t *os, struct drr_object *drro)
1109{
1110	int err;
1111	dmu_tx_t *tx;
1112	void *data = NULL;
1113
1114	if (drro->drr_type == DMU_OT_NONE ||
1115	    drro->drr_type >= DMU_OT_NUMTYPES ||
1116	    drro->drr_bonustype >= DMU_OT_NUMTYPES ||
1117	    drro->drr_checksumtype >= ZIO_CHECKSUM_FUNCTIONS ||
1118	    drro->drr_compress >= ZIO_COMPRESS_FUNCTIONS ||
1119	    P2PHASE(drro->drr_blksz, SPA_MINBLOCKSIZE) ||
1120	    drro->drr_blksz < SPA_MINBLOCKSIZE ||
1121	    drro->drr_blksz > SPA_MAXBLOCKSIZE ||
1122	    drro->drr_bonuslen > DN_MAX_BONUSLEN) {
1123		return (EINVAL);
1124	}
1125
1126	err = dmu_object_info(os, drro->drr_object, NULL);
1127
1128	if (err != 0 && err != ENOENT)
1129		return (EINVAL);
1130
1131	if (drro->drr_bonuslen) {
1132		data = restore_read(ra, P2ROUNDUP(drro->drr_bonuslen, 8));
1133		if (ra->err)
1134			return (ra->err);
1135	}
1136
1137	if (err == ENOENT) {
1138		/* currently free, want to be allocated */
1139		tx = dmu_tx_create(os);
1140		dmu_tx_hold_bonus(tx, DMU_NEW_OBJECT);
1141		err = dmu_tx_assign(tx, TXG_WAIT);
1142		if (err) {
1143			dmu_tx_abort(tx);
1144			return (err);
1145		}
1146		err = dmu_object_claim(os, drro->drr_object,
1147		    drro->drr_type, drro->drr_blksz,
1148		    drro->drr_bonustype, drro->drr_bonuslen, tx);
1149		dmu_tx_commit(tx);
1150	} else {
1151		/* currently allocated, want to be allocated */
1152		err = dmu_object_reclaim(os, drro->drr_object,
1153		    drro->drr_type, drro->drr_blksz,
1154		    drro->drr_bonustype, drro->drr_bonuslen);
1155	}
1156	if (err) {
1157		return (EINVAL);
1158	}
1159
1160	tx = dmu_tx_create(os);
1161	dmu_tx_hold_bonus(tx, drro->drr_object);
1162	err = dmu_tx_assign(tx, TXG_WAIT);
1163	if (err) {
1164		dmu_tx_abort(tx);
1165		return (err);
1166	}
1167
1168	dmu_object_set_checksum(os, drro->drr_object, drro->drr_checksumtype,
1169	    tx);
1170	dmu_object_set_compress(os, drro->drr_object, drro->drr_compress, tx);
1171
1172	if (data != NULL) {
1173		dmu_buf_t *db;
1174
1175		VERIFY(0 == dmu_bonus_hold(os, drro->drr_object, FTAG, &db));
1176		dmu_buf_will_dirty(db, tx);
1177
1178		ASSERT3U(db->db_size, >=, drro->drr_bonuslen);
1179		bcopy(data, db->db_data, drro->drr_bonuslen);
1180		if (ra->byteswap) {
1181			dmu_ot[drro->drr_bonustype].ot_byteswap(db->db_data,
1182			    drro->drr_bonuslen);
1183		}
1184		dmu_buf_rele(db, FTAG);
1185	}
1186	dmu_tx_commit(tx);
1187	return (0);
1188}
1189
1190/* ARGSUSED */
1191static int
1192restore_freeobjects(struct restorearg *ra, objset_t *os,
1193    struct drr_freeobjects *drrfo)
1194{
1195	uint64_t obj;
1196
1197	if (drrfo->drr_firstobj + drrfo->drr_numobjs < drrfo->drr_firstobj)
1198		return (EINVAL);
1199
1200	for (obj = drrfo->drr_firstobj;
1201	    obj < drrfo->drr_firstobj + drrfo->drr_numobjs;
1202	    (void) dmu_object_next(os, &obj, FALSE, 0)) {
1203		int err;
1204
1205		if (dmu_object_info(os, obj, NULL) != 0)
1206			continue;
1207
1208		err = dmu_free_object(os, obj);
1209		if (err)
1210			return (err);
1211	}
1212	return (0);
1213}
1214
1215static int
1216restore_write(struct restorearg *ra, objset_t *os,
1217    struct drr_write *drrw)
1218{
1219	dmu_tx_t *tx;
1220	void *data;
1221	int err;
1222
1223	if (drrw->drr_offset + drrw->drr_length < drrw->drr_offset ||
1224	    drrw->drr_type >= DMU_OT_NUMTYPES)
1225		return (EINVAL);
1226
1227	data = restore_read(ra, drrw->drr_length);
1228	if (data == NULL)
1229		return (ra->err);
1230
1231	if (dmu_object_info(os, drrw->drr_object, NULL) != 0)
1232		return (EINVAL);
1233
1234	tx = dmu_tx_create(os);
1235
1236	dmu_tx_hold_write(tx, drrw->drr_object,
1237	    drrw->drr_offset, drrw->drr_length);
1238	err = dmu_tx_assign(tx, TXG_WAIT);
1239	if (err) {
1240		dmu_tx_abort(tx);
1241		return (err);
1242	}
1243	if (ra->byteswap)
1244		dmu_ot[drrw->drr_type].ot_byteswap(data, drrw->drr_length);
1245	dmu_write(os, drrw->drr_object,
1246	    drrw->drr_offset, drrw->drr_length, data, tx);
1247	dmu_tx_commit(tx);
1248	return (0);
1249}
1250
1251/*
1252 * Handle a DRR_WRITE_BYREF record.  This record is used in dedup'ed
1253 * streams to refer to a copy of the data that is already on the
1254 * system because it came in earlier in the stream.  This function
1255 * finds the earlier copy of the data, and uses that copy instead of
1256 * data from the stream to fulfill this write.
1257 */
1258static int
1259restore_write_byref(struct restorearg *ra, objset_t *os,
1260    struct drr_write_byref *drrwbr)
1261{
1262	dmu_tx_t *tx;
1263	int err;
1264	guid_map_entry_t gmesrch;
1265	guid_map_entry_t *gmep;
1266	avl_index_t	where;
1267	objset_t *ref_os = NULL;
1268	dmu_buf_t *dbp;
1269
1270	if (drrwbr->drr_offset + drrwbr->drr_length < drrwbr->drr_offset)
1271		return (EINVAL);
1272
1273	/*
1274	 * If the GUID of the referenced dataset is different from the
1275	 * GUID of the target dataset, find the referenced dataset.
1276	 */
1277	if (drrwbr->drr_toguid != drrwbr->drr_refguid) {
1278		gmesrch.guid = drrwbr->drr_refguid;
1279		if ((gmep = avl_find(ra->guid_to_ds_map, &gmesrch,
1280		    &where)) == NULL) {
1281			return (EINVAL);
1282		}
1283		if (dmu_objset_from_ds(gmep->gme_ds, &ref_os))
1284			return (EINVAL);
1285	} else {
1286		ref_os = os;
1287	}
1288
1289	if (err = dmu_buf_hold(ref_os, drrwbr->drr_refobject,
1290	    drrwbr->drr_refoffset, FTAG, &dbp, DMU_READ_PREFETCH))
1291		return (err);
1292
1293	tx = dmu_tx_create(os);
1294
1295	dmu_tx_hold_write(tx, drrwbr->drr_object,
1296	    drrwbr->drr_offset, drrwbr->drr_length);
1297	err = dmu_tx_assign(tx, TXG_WAIT);
1298	if (err) {
1299		dmu_tx_abort(tx);
1300		return (err);
1301	}
1302	dmu_write(os, drrwbr->drr_object,
1303	    drrwbr->drr_offset, drrwbr->drr_length, dbp->db_data, tx);
1304	dmu_buf_rele(dbp, FTAG);
1305	dmu_tx_commit(tx);
1306	return (0);
1307}
1308
1309static int
1310restore_spill(struct restorearg *ra, objset_t *os, struct drr_spill *drrs)
1311{
1312	dmu_tx_t *tx;
1313	void *data;
1314	dmu_buf_t *db, *db_spill;
1315	int err;
1316
1317	if (drrs->drr_length < SPA_MINBLOCKSIZE ||
1318	    drrs->drr_length > SPA_MAXBLOCKSIZE)
1319		return (EINVAL);
1320
1321	data = restore_read(ra, drrs->drr_length);
1322	if (data == NULL)
1323		return (ra->err);
1324
1325	if (dmu_object_info(os, drrs->drr_object, NULL) != 0)
1326		return (EINVAL);
1327
1328	VERIFY(0 == dmu_bonus_hold(os, drrs->drr_object, FTAG, &db));
1329	if ((err = dmu_spill_hold_by_bonus(db, FTAG, &db_spill)) != 0) {
1330		dmu_buf_rele(db, FTAG);
1331		return (err);
1332	}
1333
1334	tx = dmu_tx_create(os);
1335
1336	dmu_tx_hold_spill(tx, db->db_object);
1337
1338	err = dmu_tx_assign(tx, TXG_WAIT);
1339	if (err) {
1340		dmu_buf_rele(db, FTAG);
1341		dmu_buf_rele(db_spill, FTAG);
1342		dmu_tx_abort(tx);
1343		return (err);
1344	}
1345	dmu_buf_will_dirty(db_spill, tx);
1346
1347	if (db_spill->db_size < drrs->drr_length)
1348		VERIFY(0 == dbuf_spill_set_blksz(db_spill,
1349		    drrs->drr_length, tx));
1350	bcopy(data, db_spill->db_data, drrs->drr_length);
1351
1352	dmu_buf_rele(db, FTAG);
1353	dmu_buf_rele(db_spill, FTAG);
1354
1355	dmu_tx_commit(tx);
1356	return (0);
1357}
1358
1359/* ARGSUSED */
1360static int
1361restore_free(struct restorearg *ra, objset_t *os,
1362    struct drr_free *drrf)
1363{
1364	int err;
1365
1366	if (drrf->drr_length != -1ULL &&
1367	    drrf->drr_offset + drrf->drr_length < drrf->drr_offset)
1368		return (EINVAL);
1369
1370	if (dmu_object_info(os, drrf->drr_object, NULL) != 0)
1371		return (EINVAL);
1372
1373	err = dmu_free_long_range(os, drrf->drr_object,
1374	    drrf->drr_offset, drrf->drr_length);
1375	return (err);
1376}
1377
1378/*
1379 * NB: callers *must* call dmu_recv_end() if this succeeds.
1380 */
1381int
1382dmu_recv_stream(dmu_recv_cookie_t *drc, struct file *fp, offset_t *voffp,
1383    int cleanup_fd, uint64_t *action_handlep)
1384{
1385	struct restorearg ra = { 0 };
1386	dmu_replay_record_t *drr;
1387	objset_t *os;
1388	zio_cksum_t pcksum;
1389	int featureflags;
1390
1391	if (drc->drc_drrb->drr_magic == BSWAP_64(DMU_BACKUP_MAGIC))
1392		ra.byteswap = TRUE;
1393
1394	{
1395		/* compute checksum of drr_begin record */
1396		dmu_replay_record_t *drr;
1397		drr = kmem_zalloc(sizeof (dmu_replay_record_t), KM_SLEEP);
1398
1399		drr->drr_type = DRR_BEGIN;
1400		drr->drr_u.drr_begin = *drc->drc_drrb;
1401		if (ra.byteswap) {
1402			fletcher_4_incremental_byteswap(drr,
1403			    sizeof (dmu_replay_record_t), &ra.cksum);
1404		} else {
1405			fletcher_4_incremental_native(drr,
1406			    sizeof (dmu_replay_record_t), &ra.cksum);
1407		}
1408		kmem_free(drr, sizeof (dmu_replay_record_t));
1409	}
1410
1411	if (ra.byteswap) {
1412		struct drr_begin *drrb = drc->drc_drrb;
1413		drrb->drr_magic = BSWAP_64(drrb->drr_magic);
1414		drrb->drr_versioninfo = BSWAP_64(drrb->drr_versioninfo);
1415		drrb->drr_creation_time = BSWAP_64(drrb->drr_creation_time);
1416		drrb->drr_type = BSWAP_32(drrb->drr_type);
1417		drrb->drr_toguid = BSWAP_64(drrb->drr_toguid);
1418		drrb->drr_fromguid = BSWAP_64(drrb->drr_fromguid);
1419	}
1420
1421	ra.td = curthread;
1422	ra.fp = fp;
1423	ra.voff = *voffp;
1424	ra.bufsize = 1<<20;
1425	ra.buf = kmem_alloc(ra.bufsize, KM_SLEEP);
1426
1427	/* these were verified in dmu_recv_begin */
1428	ASSERT(DMU_GET_STREAM_HDRTYPE(drc->drc_drrb->drr_versioninfo) ==
1429	    DMU_SUBSTREAM);
1430	ASSERT(drc->drc_drrb->drr_type < DMU_OST_NUMTYPES);
1431
1432	/*
1433	 * Open the objset we are modifying.
1434	 */
1435	VERIFY(dmu_objset_from_ds(drc->drc_real_ds, &os) == 0);
1436
1437	ASSERT(drc->drc_real_ds->ds_phys->ds_flags & DS_FLAG_INCONSISTENT);
1438
1439	featureflags = DMU_GET_FEATUREFLAGS(drc->drc_drrb->drr_versioninfo);
1440
1441	/* if this stream is dedup'ed, set up the avl tree for guid mapping */
1442	if (featureflags & DMU_BACKUP_FEATURE_DEDUP) {
1443		minor_t minor;
1444
1445		if (cleanup_fd == -1) {
1446			ra.err = EBADF;
1447			goto out;
1448		}
1449		ra.err = zfs_onexit_fd_hold(cleanup_fd, &minor);
1450		if (ra.err) {
1451			cleanup_fd = -1;
1452			goto out;
1453		}
1454
1455		if (*action_handlep == 0) {
1456			ra.guid_to_ds_map =
1457			    kmem_alloc(sizeof (avl_tree_t), KM_SLEEP);
1458			avl_create(ra.guid_to_ds_map, guid_compare,
1459			    sizeof (guid_map_entry_t),
1460			    offsetof(guid_map_entry_t, avlnode));
1461			ra.err = zfs_onexit_add_cb(minor,
1462			    free_guid_map_onexit, ra.guid_to_ds_map,
1463			    action_handlep);
1464			if (ra.err)
1465				goto out;
1466		} else {
1467			ra.err = zfs_onexit_cb_data(minor, *action_handlep,
1468			    (void **)&ra.guid_to_ds_map);
1469			if (ra.err)
1470				goto out;
1471		}
1472
1473		drc->drc_guid_to_ds_map = ra.guid_to_ds_map;
1474	}
1475
1476	/*
1477	 * Read records and process them.
1478	 */
1479	pcksum = ra.cksum;
1480	while (ra.err == 0 &&
1481	    NULL != (drr = restore_read(&ra, sizeof (*drr)))) {
1482		if (issig(JUSTLOOKING) && issig(FORREAL)) {
1483			ra.err = EINTR;
1484			goto out;
1485		}
1486
1487		if (ra.byteswap)
1488			backup_byteswap(drr);
1489
1490		switch (drr->drr_type) {
1491		case DRR_OBJECT:
1492		{
1493			/*
1494			 * We need to make a copy of the record header,
1495			 * because restore_{object,write} may need to
1496			 * restore_read(), which will invalidate drr.
1497			 */
1498			struct drr_object drro = drr->drr_u.drr_object;
1499			ra.err = restore_object(&ra, os, &drro);
1500			break;
1501		}
1502		case DRR_FREEOBJECTS:
1503		{
1504			struct drr_freeobjects drrfo =
1505			    drr->drr_u.drr_freeobjects;
1506			ra.err = restore_freeobjects(&ra, os, &drrfo);
1507			break;
1508		}
1509		case DRR_WRITE:
1510		{
1511			struct drr_write drrw = drr->drr_u.drr_write;
1512			ra.err = restore_write(&ra, os, &drrw);
1513			break;
1514		}
1515		case DRR_WRITE_BYREF:
1516		{
1517			struct drr_write_byref drrwbr =
1518			    drr->drr_u.drr_write_byref;
1519			ra.err = restore_write_byref(&ra, os, &drrwbr);
1520			break;
1521		}
1522		case DRR_FREE:
1523		{
1524			struct drr_free drrf = drr->drr_u.drr_free;
1525			ra.err = restore_free(&ra, os, &drrf);
1526			break;
1527		}
1528		case DRR_END:
1529		{
1530			struct drr_end drre = drr->drr_u.drr_end;
1531			/*
1532			 * We compare against the *previous* checksum
1533			 * value, because the stored checksum is of
1534			 * everything before the DRR_END record.
1535			 */
1536			if (!ZIO_CHECKSUM_EQUAL(drre.drr_checksum, pcksum))
1537				ra.err = ECKSUM;
1538			goto out;
1539		}
1540		case DRR_SPILL:
1541		{
1542			struct drr_spill drrs = drr->drr_u.drr_spill;
1543			ra.err = restore_spill(&ra, os, &drrs);
1544			break;
1545		}
1546		default:
1547			ra.err = EINVAL;
1548			goto out;
1549		}
1550		pcksum = ra.cksum;
1551	}
1552	ASSERT(ra.err != 0);
1553
1554out:
1555	if ((featureflags & DMU_BACKUP_FEATURE_DEDUP) && (cleanup_fd != -1))
1556		zfs_onexit_fd_rele(cleanup_fd);
1557
1558	if (ra.err != 0) {
1559		/*
1560		 * destroy what we created, so we don't leave it in the
1561		 * inconsistent restoring state.
1562		 */
1563		txg_wait_synced(drc->drc_real_ds->ds_dir->dd_pool, 0);
1564
1565		(void) dsl_dataset_destroy(drc->drc_real_ds, dmu_recv_tag,
1566		    B_FALSE);
1567		if (drc->drc_real_ds != drc->drc_logical_ds) {
1568			mutex_exit(&drc->drc_logical_ds->ds_recvlock);
1569			dsl_dataset_rele(drc->drc_logical_ds, dmu_recv_tag);
1570		}
1571	}
1572
1573	kmem_free(ra.buf, ra.bufsize);
1574	*voffp = ra.voff;
1575	return (ra.err);
1576}
1577
1578struct recvendsyncarg {
1579	char *tosnap;
1580	uint64_t creation_time;
1581	uint64_t toguid;
1582};
1583
1584static int
1585recv_end_check(void *arg1, void *arg2, dmu_tx_t *tx)
1586{
1587	dsl_dataset_t *ds = arg1;
1588	struct recvendsyncarg *resa = arg2;
1589
1590	return (dsl_dataset_snapshot_check(ds, resa->tosnap, tx));
1591}
1592
1593static void
1594recv_end_sync(void *arg1, void *arg2, dmu_tx_t *tx)
1595{
1596	dsl_dataset_t *ds = arg1;
1597	struct recvendsyncarg *resa = arg2;
1598
1599	dsl_dataset_snapshot_sync(ds, resa->tosnap, tx);
1600
1601	/* set snapshot's creation time and guid */
1602	dmu_buf_will_dirty(ds->ds_prev->ds_dbuf, tx);
1603	ds->ds_prev->ds_phys->ds_creation_time = resa->creation_time;
1604	ds->ds_prev->ds_phys->ds_guid = resa->toguid;
1605	ds->ds_prev->ds_phys->ds_flags &= ~DS_FLAG_INCONSISTENT;
1606
1607	dmu_buf_will_dirty(ds->ds_dbuf, tx);
1608	ds->ds_phys->ds_flags &= ~DS_FLAG_INCONSISTENT;
1609}
1610
1611static int
1612add_ds_to_guidmap(avl_tree_t *guid_map, dsl_dataset_t *ds)
1613{
1614	dsl_pool_t *dp = ds->ds_dir->dd_pool;
1615	uint64_t snapobj = ds->ds_phys->ds_prev_snap_obj;
1616	dsl_dataset_t *snapds;
1617	guid_map_entry_t *gmep;
1618	int err;
1619
1620	ASSERT(guid_map != NULL);
1621
1622	rw_enter(&dp->dp_config_rwlock, RW_READER);
1623	err = dsl_dataset_hold_obj(dp, snapobj, guid_map, &snapds);
1624	if (err == 0) {
1625		gmep = kmem_alloc(sizeof (guid_map_entry_t), KM_SLEEP);
1626		gmep->guid = snapds->ds_phys->ds_guid;
1627		gmep->gme_ds = snapds;
1628		avl_add(guid_map, gmep);
1629	}
1630
1631	rw_exit(&dp->dp_config_rwlock);
1632	return (err);
1633}
1634
1635static int
1636dmu_recv_existing_end(dmu_recv_cookie_t *drc)
1637{
1638	struct recvendsyncarg resa;
1639	dsl_dataset_t *ds = drc->drc_logical_ds;
1640	int err, myerr;
1641
1642	/*
1643	 * XXX hack; seems the ds is still dirty and dsl_pool_zil_clean()
1644	 * expects it to have a ds_user_ptr (and zil), but clone_swap()
1645	 * can close it.
1646	 */
1647	txg_wait_synced(ds->ds_dir->dd_pool, 0);
1648
1649	if (dsl_dataset_tryown(ds, FALSE, dmu_recv_tag)) {
1650		err = dsl_dataset_clone_swap(drc->drc_real_ds, ds,
1651		    drc->drc_force);
1652		if (err)
1653			goto out;
1654	} else {
1655		mutex_exit(&ds->ds_recvlock);
1656		dsl_dataset_rele(ds, dmu_recv_tag);
1657		(void) dsl_dataset_destroy(drc->drc_real_ds, dmu_recv_tag,
1658		    B_FALSE);
1659		return (EBUSY);
1660	}
1661
1662	resa.creation_time = drc->drc_drrb->drr_creation_time;
1663	resa.toguid = drc->drc_drrb->drr_toguid;
1664	resa.tosnap = drc->drc_tosnap;
1665
1666	err = dsl_sync_task_do(ds->ds_dir->dd_pool,
1667	    recv_end_check, recv_end_sync, ds, &resa, 3);
1668	if (err) {
1669		/* swap back */
1670		(void) dsl_dataset_clone_swap(drc->drc_real_ds, ds, B_TRUE);
1671	}
1672
1673out:
1674	mutex_exit(&ds->ds_recvlock);
1675	if (err == 0 && drc->drc_guid_to_ds_map != NULL)
1676		(void) add_ds_to_guidmap(drc->drc_guid_to_ds_map, ds);
1677	dsl_dataset_disown(ds, dmu_recv_tag);
1678	myerr = dsl_dataset_destroy(drc->drc_real_ds, dmu_recv_tag, B_FALSE);
1679	ASSERT3U(myerr, ==, 0);
1680	return (err);
1681}
1682
1683static int
1684dmu_recv_new_end(dmu_recv_cookie_t *drc)
1685{
1686	struct recvendsyncarg resa;
1687	dsl_dataset_t *ds = drc->drc_logical_ds;
1688	int err;
1689
1690	/*
1691	 * XXX hack; seems the ds is still dirty and dsl_pool_zil_clean()
1692	 * expects it to have a ds_user_ptr (and zil), but clone_swap()
1693	 * can close it.
1694	 */
1695	txg_wait_synced(ds->ds_dir->dd_pool, 0);
1696
1697	resa.creation_time = drc->drc_drrb->drr_creation_time;
1698	resa.toguid = drc->drc_drrb->drr_toguid;
1699	resa.tosnap = drc->drc_tosnap;
1700
1701	err = dsl_sync_task_do(ds->ds_dir->dd_pool,
1702	    recv_end_check, recv_end_sync, ds, &resa, 3);
1703	if (err) {
1704		/* clean up the fs we just recv'd into */
1705		(void) dsl_dataset_destroy(ds, dmu_recv_tag, B_FALSE);
1706	} else {
1707		if (drc->drc_guid_to_ds_map != NULL)
1708			(void) add_ds_to_guidmap(drc->drc_guid_to_ds_map, ds);
1709		/* release the hold from dmu_recv_begin */
1710		dsl_dataset_disown(ds, dmu_recv_tag);
1711	}
1712	return (err);
1713}
1714
1715int
1716dmu_recv_end(dmu_recv_cookie_t *drc)
1717{
1718	if (drc->drc_logical_ds != drc->drc_real_ds)
1719		return (dmu_recv_existing_end(drc));
1720	else
1721		return (dmu_recv_new_end(drc));
1722}
1723