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