]> CyberLeo.Net >> Repos - FreeBSD/releng/8.2.git/blob - sys/cddl/contrib/opensolaris/uts/common/fs/zfs/dmu_send.c
Copy stable/8 to releng/8.2 in preparation for FreeBSD-8.2 release.
[FreeBSD/releng/8.2.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 2009 Sun Microsystems, Inc.  All rights reserved.
23  * Use is subject to license terms.
24  */
25
26 #include <sys/dmu.h>
27 #include <sys/dmu_impl.h>
28 #include <sys/dmu_tx.h>
29 #include <sys/dbuf.h>
30 #include <sys/dnode.h>
31 #include <sys/zfs_context.h>
32 #include <sys/dmu_objset.h>
33 #include <sys/dmu_traverse.h>
34 #include <sys/dsl_dataset.h>
35 #include <sys/dsl_dir.h>
36 #include <sys/dsl_pool.h>
37 #include <sys/dsl_synctask.h>
38 #include <sys/zfs_ioctl.h>
39 #include <sys/zap.h>
40 #include <sys/zio_checksum.h>
41
42 static char *dmu_recv_tag = "dmu_recv_tag";
43
44 struct backuparg {
45         dmu_replay_record_t *drr;
46         kthread_t *td;
47         struct file *fp;
48         offset_t *off;
49         objset_t *os;
50         zio_cksum_t zc;
51         int err;
52 };
53
54 static int
55 dump_bytes(struct backuparg *ba, void *buf, int len)
56 {
57         struct uio auio;
58         struct iovec aiov;
59
60         ASSERT3U(len % 8, ==, 0);
61
62         fletcher_4_incremental_native(buf, len, &ba->zc);
63
64         aiov.iov_base = buf;
65         aiov.iov_len = len;
66         auio.uio_iov = &aiov;
67         auio.uio_iovcnt = 1;
68         auio.uio_resid = len;
69         auio.uio_segflg = UIO_SYSSPACE;
70         auio.uio_rw = UIO_WRITE;
71         auio.uio_offset = (off_t)-1;
72         auio.uio_td = ba->td;
73 #ifdef _KERNEL
74         if (ba->fp->f_type == DTYPE_VNODE)
75                 bwillwrite();
76         ba->err = fo_write(ba->fp, &auio, ba->td->td_ucred, 0, ba->td);
77 #else
78         fprintf(stderr, "%s: returning EOPNOTSUPP\n", __func__);
79         ba->err = EOPNOTSUPP;
80 #endif
81         *ba->off += len;
82
83         return (ba->err);
84 }
85
86 static int
87 dump_free(struct backuparg *ba, uint64_t object, uint64_t offset,
88     uint64_t length)
89 {
90         /* write a FREE record */
91         bzero(ba->drr, sizeof (dmu_replay_record_t));
92         ba->drr->drr_type = DRR_FREE;
93         ba->drr->drr_u.drr_free.drr_object = object;
94         ba->drr->drr_u.drr_free.drr_offset = offset;
95         ba->drr->drr_u.drr_free.drr_length = length;
96
97         if (dump_bytes(ba, ba->drr, sizeof (dmu_replay_record_t)))
98                 return (EINTR);
99         return (0);
100 }
101
102 static int
103 dump_data(struct backuparg *ba, dmu_object_type_t type,
104     uint64_t object, uint64_t offset, int blksz, void *data)
105 {
106         /* write a DATA record */
107         bzero(ba->drr, sizeof (dmu_replay_record_t));
108         ba->drr->drr_type = DRR_WRITE;
109         ba->drr->drr_u.drr_write.drr_object = object;
110         ba->drr->drr_u.drr_write.drr_type = type;
111         ba->drr->drr_u.drr_write.drr_offset = offset;
112         ba->drr->drr_u.drr_write.drr_length = blksz;
113
114         if (dump_bytes(ba, ba->drr, sizeof (dmu_replay_record_t)))
115                 return (EINTR);
116         if (dump_bytes(ba, data, blksz))
117                 return (EINTR);
118         return (0);
119 }
120
121 static int
122 dump_freeobjects(struct backuparg *ba, uint64_t firstobj, uint64_t numobjs)
123 {
124         /* write a FREEOBJECTS record */
125         bzero(ba->drr, sizeof (dmu_replay_record_t));
126         ba->drr->drr_type = DRR_FREEOBJECTS;
127         ba->drr->drr_u.drr_freeobjects.drr_firstobj = firstobj;
128         ba->drr->drr_u.drr_freeobjects.drr_numobjs = numobjs;
129
130         if (dump_bytes(ba, ba->drr, sizeof (dmu_replay_record_t)))
131                 return (EINTR);
132         return (0);
133 }
134
135 static int
136 dump_dnode(struct backuparg *ba, uint64_t object, dnode_phys_t *dnp)
137 {
138         if (dnp == NULL || dnp->dn_type == DMU_OT_NONE)
139                 return (dump_freeobjects(ba, object, 1));
140
141         /* write an OBJECT record */
142         bzero(ba->drr, sizeof (dmu_replay_record_t));
143         ba->drr->drr_type = DRR_OBJECT;
144         ba->drr->drr_u.drr_object.drr_object = object;
145         ba->drr->drr_u.drr_object.drr_type = dnp->dn_type;
146         ba->drr->drr_u.drr_object.drr_bonustype = dnp->dn_bonustype;
147         ba->drr->drr_u.drr_object.drr_blksz =
148             dnp->dn_datablkszsec << SPA_MINBLOCKSHIFT;
149         ba->drr->drr_u.drr_object.drr_bonuslen = dnp->dn_bonuslen;
150         ba->drr->drr_u.drr_object.drr_checksum = dnp->dn_checksum;
151         ba->drr->drr_u.drr_object.drr_compress = dnp->dn_compress;
152
153         if (dump_bytes(ba, ba->drr, sizeof (dmu_replay_record_t)))
154                 return (EINTR);
155
156         if (dump_bytes(ba, DN_BONUS(dnp), P2ROUNDUP(dnp->dn_bonuslen, 8)))
157                 return (EINTR);
158
159         /* free anything past the end of the file */
160         if (dump_free(ba, object, (dnp->dn_maxblkid + 1) *
161             (dnp->dn_datablkszsec << SPA_MINBLOCKSHIFT), -1ULL))
162                 return (EINTR);
163         if (ba->err)
164                 return (EINTR);
165         return (0);
166 }
167
168 #define BP_SPAN(dnp, level) \
169         (((uint64_t)dnp->dn_datablkszsec) << (SPA_MINBLOCKSHIFT + \
170         (level) * (dnp->dn_indblkshift - SPA_BLKPTRSHIFT)))
171
172 static int
173 backup_cb(spa_t *spa, blkptr_t *bp, const zbookmark_t *zb,
174     const dnode_phys_t *dnp, void *arg)
175 {
176         struct backuparg *ba = arg;
177         dmu_object_type_t type = bp ? BP_GET_TYPE(bp) : DMU_OT_NONE;
178         int err = 0;
179
180         if (issig(JUSTLOOKING) && issig(FORREAL))
181                 return (EINTR);
182
183         if (zb->zb_object != 0 && DMU_OBJECT_IS_SPECIAL(zb->zb_object)) {
184                 return (0);
185         } else if (bp == NULL && zb->zb_object == 0) {
186                 uint64_t span = BP_SPAN(dnp, zb->zb_level);
187                 uint64_t dnobj = (zb->zb_blkid * span) >> DNODE_SHIFT;
188                 err = dump_freeobjects(ba, dnobj, span >> DNODE_SHIFT);
189         } else if (bp == NULL) {
190                 uint64_t span = BP_SPAN(dnp, zb->zb_level);
191                 err = dump_free(ba, zb->zb_object, zb->zb_blkid * span, span);
192         } else if (zb->zb_level > 0 || type == DMU_OT_OBJSET) {
193                 return (0);
194         } else if (type == DMU_OT_DNODE) {
195                 dnode_phys_t *blk;
196                 int i;
197                 int blksz = BP_GET_LSIZE(bp);
198                 uint32_t aflags = ARC_WAIT;
199                 arc_buf_t *abuf;
200
201                 if (arc_read_nolock(NULL, spa, bp,
202                     arc_getbuf_func, &abuf, ZIO_PRIORITY_ASYNC_READ,
203                     ZIO_FLAG_CANFAIL, &aflags, zb) != 0)
204                         return (EIO);
205
206                 blk = abuf->b_data;
207                 for (i = 0; i < blksz >> DNODE_SHIFT; i++) {
208                         uint64_t dnobj = (zb->zb_blkid <<
209                             (DNODE_BLOCK_SHIFT - DNODE_SHIFT)) + i;
210                         err = dump_dnode(ba, dnobj, blk+i);
211                         if (err)
212                                 break;
213                 }
214                 (void) arc_buf_remove_ref(abuf, &abuf);
215         } else { /* it's a level-0 block of a regular object */
216                 uint32_t aflags = ARC_WAIT;
217                 arc_buf_t *abuf;
218                 int blksz = BP_GET_LSIZE(bp);
219
220                 if (arc_read_nolock(NULL, spa, bp,
221                     arc_getbuf_func, &abuf, ZIO_PRIORITY_ASYNC_READ,
222                     ZIO_FLAG_CANFAIL, &aflags, zb) != 0)
223                         return (EIO);
224
225                 err = dump_data(ba, type, zb->zb_object, zb->zb_blkid * blksz,
226                     blksz, abuf->b_data);
227                 (void) arc_buf_remove_ref(abuf, &abuf);
228         }
229
230         ASSERT(err == 0 || err == EINTR);
231         return (err);
232 }
233
234 int
235 dmu_sendbackup(objset_t *tosnap, objset_t *fromsnap, boolean_t fromorigin,
236     struct file *fp, offset_t *off)
237 {
238         dsl_dataset_t *ds = tosnap->os->os_dsl_dataset;
239         dsl_dataset_t *fromds = fromsnap ? fromsnap->os->os_dsl_dataset : NULL;
240         dmu_replay_record_t *drr;
241         struct backuparg ba;
242         int err;
243         uint64_t fromtxg = 0;
244
245         /* tosnap must be a snapshot */
246         if (ds->ds_phys->ds_next_snap_obj == 0)
247                 return (EINVAL);
248
249         /* fromsnap must be an earlier snapshot from the same fs as tosnap */
250         if (fromds && (ds->ds_dir != fromds->ds_dir ||
251             fromds->ds_phys->ds_creation_txg >= ds->ds_phys->ds_creation_txg))
252                 return (EXDEV);
253
254         if (fromorigin) {
255                 dsl_pool_t *dp = ds->ds_dir->dd_pool;
256
257                 if (fromsnap)
258                         return (EINVAL);
259
260                 if (dsl_dir_is_clone(ds->ds_dir)) {
261                         rw_enter(&dp->dp_config_rwlock, RW_READER);
262                         err = dsl_dataset_hold_obj(dp,
263                             ds->ds_dir->dd_phys->dd_origin_obj, FTAG, &fromds);
264                         rw_exit(&dp->dp_config_rwlock);
265                         if (err)
266                                 return (err);
267                 } else {
268                         fromorigin = B_FALSE;
269                 }
270         }
271
272
273         drr = kmem_zalloc(sizeof (dmu_replay_record_t), KM_SLEEP);
274         drr->drr_type = DRR_BEGIN;
275         drr->drr_u.drr_begin.drr_magic = DMU_BACKUP_MAGIC;
276         drr->drr_u.drr_begin.drr_version = DMU_BACKUP_STREAM_VERSION;
277         drr->drr_u.drr_begin.drr_creation_time =
278             ds->ds_phys->ds_creation_time;
279         drr->drr_u.drr_begin.drr_type = tosnap->os->os_phys->os_type;
280         if (fromorigin)
281                 drr->drr_u.drr_begin.drr_flags |= DRR_FLAG_CLONE;
282         drr->drr_u.drr_begin.drr_toguid = ds->ds_phys->ds_guid;
283         if (ds->ds_phys->ds_flags & DS_FLAG_CI_DATASET)
284                 drr->drr_u.drr_begin.drr_flags |= DRR_FLAG_CI_DATA;
285
286         if (fromds)
287                 drr->drr_u.drr_begin.drr_fromguid = fromds->ds_phys->ds_guid;
288         dsl_dataset_name(ds, drr->drr_u.drr_begin.drr_toname);
289
290         if (fromds)
291                 fromtxg = fromds->ds_phys->ds_creation_txg;
292         if (fromorigin)
293                 dsl_dataset_rele(fromds, FTAG);
294
295         ba.drr = drr;
296         ba.td = curthread;
297         ba.fp = fp;
298         ba.os = tosnap;
299         ba.off = off;
300         ZIO_SET_CHECKSUM(&ba.zc, 0, 0, 0, 0);
301
302         if (dump_bytes(&ba, drr, sizeof (dmu_replay_record_t))) {
303                 kmem_free(drr, sizeof (dmu_replay_record_t));
304                 return (ba.err);
305         }
306
307         err = traverse_dataset(ds, fromtxg, TRAVERSE_PRE | TRAVERSE_PREFETCH,
308             backup_cb, &ba);
309
310         if (err) {
311                 if (err == EINTR && ba.err)
312                         err = ba.err;
313                 kmem_free(drr, sizeof (dmu_replay_record_t));
314                 return (err);
315         }
316
317         bzero(drr, sizeof (dmu_replay_record_t));
318         drr->drr_type = DRR_END;
319         drr->drr_u.drr_end.drr_checksum = ba.zc;
320
321         if (dump_bytes(&ba, drr, sizeof (dmu_replay_record_t))) {
322                 kmem_free(drr, sizeof (dmu_replay_record_t));
323                 return (ba.err);
324         }
325
326         kmem_free(drr, sizeof (dmu_replay_record_t));
327
328         return (0);
329 }
330
331 struct recvbeginsyncarg {
332         const char *tofs;
333         const char *tosnap;
334         dsl_dataset_t *origin;
335         uint64_t fromguid;
336         dmu_objset_type_t type;
337         void *tag;
338         boolean_t force;
339         uint64_t dsflags;
340         char clonelastname[MAXNAMELEN];
341         dsl_dataset_t *ds; /* the ds to recv into; returned from the syncfunc */
342 };
343
344 static dsl_dataset_t *
345 recv_full_sync_impl(dsl_pool_t *dp, uint64_t dsobj, dmu_objset_type_t type,
346     cred_t *cr, dmu_tx_t *tx)
347 {
348         dsl_dataset_t *ds;
349
350         /* This should always work, since we just created it */
351         /* XXX - create should return an owned ds */
352         VERIFY(0 == dsl_dataset_own_obj(dp, dsobj,
353             DS_MODE_INCONSISTENT, dmu_recv_tag, &ds));
354
355         if (type != DMU_OST_NONE) {
356                 (void) dmu_objset_create_impl(dp->dp_spa,
357                     ds, &ds->ds_phys->ds_bp, type, tx);
358         }
359
360         spa_history_internal_log(LOG_DS_REPLAY_FULL_SYNC,
361             dp->dp_spa, tx, cr, "dataset = %lld", dsobj);
362
363         return (ds);
364 }
365
366 /* ARGSUSED */
367 static int
368 recv_full_check(void *arg1, void *arg2, dmu_tx_t *tx)
369 {
370         dsl_dir_t *dd = arg1;
371         struct recvbeginsyncarg *rbsa = arg2;
372         objset_t *mos = dd->dd_pool->dp_meta_objset;
373         uint64_t val;
374         int err;
375
376         err = zap_lookup(mos, dd->dd_phys->dd_child_dir_zapobj,
377             strrchr(rbsa->tofs, '/') + 1, sizeof (uint64_t), 1, &val);
378
379         if (err != ENOENT)
380                 return (err ? err : EEXIST);
381
382         if (rbsa->origin) {
383                 /* make sure it's a snap in the same pool */
384                 if (rbsa->origin->ds_dir->dd_pool != dd->dd_pool)
385                         return (EXDEV);
386                 if (rbsa->origin->ds_phys->ds_num_children == 0)
387                         return (EINVAL);
388                 if (rbsa->origin->ds_phys->ds_guid != rbsa->fromguid)
389                         return (ENODEV);
390         }
391
392         return (0);
393 }
394
395 static void
396 recv_full_sync(void *arg1, void *arg2, cred_t *cr, dmu_tx_t *tx)
397 {
398         dsl_dir_t *dd = arg1;
399         struct recvbeginsyncarg *rbsa = arg2;
400         uint64_t flags = DS_FLAG_INCONSISTENT | rbsa->dsflags;
401         uint64_t dsobj;
402
403         dsobj = dsl_dataset_create_sync(dd, strrchr(rbsa->tofs, '/') + 1,
404             rbsa->origin, flags, cr, tx);
405
406         rbsa->ds = recv_full_sync_impl(dd->dd_pool, dsobj,
407             rbsa->origin ? DMU_OST_NONE : rbsa->type, cr, tx);
408 }
409
410 static int
411 recv_full_existing_check(void *arg1, void *arg2, dmu_tx_t *tx)
412 {
413         dsl_dataset_t *ds = arg1;
414         struct recvbeginsyncarg *rbsa = arg2;
415         int err;
416
417         /* must be a head ds */
418         if (ds->ds_phys->ds_next_snap_obj != 0)
419                 return (EINVAL);
420
421         /* must not be a clone ds */
422         if (dsl_dir_is_clone(ds->ds_dir))
423                 return (EINVAL);
424
425         err = dsl_dataset_destroy_check(ds, rbsa->tag, tx);
426         if (err)
427                 return (err);
428
429         if (rbsa->origin) {
430                 /* make sure it's a snap in the same pool */
431                 if (rbsa->origin->ds_dir->dd_pool != ds->ds_dir->dd_pool)
432                         return (EXDEV);
433                 if (rbsa->origin->ds_phys->ds_num_children == 0)
434                         return (EINVAL);
435                 if (rbsa->origin->ds_phys->ds_guid != rbsa->fromguid)
436                         return (ENODEV);
437         }
438
439         return (0);
440 }
441
442 static void
443 recv_full_existing_sync(void *arg1, void *arg2, cred_t *cr, dmu_tx_t *tx)
444 {
445         dsl_dataset_t *ds = arg1;
446         struct recvbeginsyncarg *rbsa = arg2;
447         dsl_dir_t *dd = ds->ds_dir;
448         uint64_t flags = DS_FLAG_INCONSISTENT | rbsa->dsflags;
449         uint64_t dsobj;
450
451         /*
452          * NB: caller must provide an extra hold on the dsl_dir_t, so it
453          * won't go away when dsl_dataset_destroy_sync() closes the
454          * dataset.
455          */
456         dsl_dataset_destroy_sync(ds, rbsa->tag, cr, tx);
457
458         dsobj = dsl_dataset_create_sync_dd(dd, rbsa->origin, flags, tx);
459
460         rbsa->ds = recv_full_sync_impl(dd->dd_pool, dsobj,
461             rbsa->origin ? DMU_OST_NONE : rbsa->type, cr, tx);
462 }
463
464 /* ARGSUSED */
465 static int
466 recv_incremental_check(void *arg1, void *arg2, dmu_tx_t *tx)
467 {
468         dsl_dataset_t *ds = arg1;
469         struct recvbeginsyncarg *rbsa = arg2;
470         int err;
471         uint64_t val;
472
473         /* must not have any changes since most recent snapshot */
474         if (!rbsa->force && dsl_dataset_modified_since_lastsnap(ds))
475                 return (ETXTBSY);
476
477         /* must already be a snapshot of this fs */
478         if (ds->ds_phys->ds_prev_snap_obj == 0)
479                 return (ENODEV);
480
481         /* most recent snapshot must match fromguid */
482         if (ds->ds_prev->ds_phys->ds_guid != rbsa->fromguid)
483                 return (ENODEV);
484
485         /* temporary clone name must not exist */
486         err = zap_lookup(ds->ds_dir->dd_pool->dp_meta_objset,
487             ds->ds_dir->dd_phys->dd_child_dir_zapobj,
488             rbsa->clonelastname, 8, 1, &val);
489         if (err == 0)
490                 return (EEXIST);
491         if (err != ENOENT)
492                 return (err);
493
494         /* new snapshot name must not exist */
495         err = zap_lookup(ds->ds_dir->dd_pool->dp_meta_objset,
496             ds->ds_phys->ds_snapnames_zapobj, rbsa->tosnap, 8, 1, &val);
497         if (err == 0)
498                 return (EEXIST);
499         if (err != ENOENT)
500                 return (err);
501         return (0);
502 }
503
504 /* ARGSUSED */
505 static void
506 recv_online_incremental_sync(void *arg1, void *arg2, cred_t *cr, dmu_tx_t *tx)
507 {
508         dsl_dataset_t *ohds = arg1;
509         struct recvbeginsyncarg *rbsa = arg2;
510         dsl_pool_t *dp = ohds->ds_dir->dd_pool;
511         dsl_dataset_t *ods, *cds;
512         uint64_t flags = DS_FLAG_INCONSISTENT | rbsa->dsflags;
513         uint64_t dsobj;
514
515         /* create the temporary clone */
516         VERIFY(0 == dsl_dataset_hold_obj(dp, ohds->ds_phys->ds_prev_snap_obj,
517             FTAG, &ods));
518         dsobj = dsl_dataset_create_sync(ohds->ds_dir,
519             rbsa->clonelastname, ods, flags, cr, tx);
520         dsl_dataset_rele(ods, FTAG);
521
522         /* open the temporary clone */
523         VERIFY(0 == dsl_dataset_own_obj(dp, dsobj,
524             DS_MODE_INCONSISTENT, dmu_recv_tag, &cds));
525
526         /* copy the refquota from the target fs to the clone */
527         if (ohds->ds_quota > 0)
528                 dsl_dataset_set_quota_sync(cds, &ohds->ds_quota, cr, tx);
529
530         rbsa->ds = cds;
531
532         spa_history_internal_log(LOG_DS_REPLAY_INC_SYNC,
533             dp->dp_spa, tx, cr, "dataset = %lld", dsobj);
534 }
535
536 /* ARGSUSED */
537 static void
538 recv_offline_incremental_sync(void *arg1, void *arg2, cred_t *cr, dmu_tx_t *tx)
539 {
540         dsl_dataset_t *ds = arg1;
541
542         dmu_buf_will_dirty(ds->ds_dbuf, tx);
543         ds->ds_phys->ds_flags |= DS_FLAG_INCONSISTENT;
544
545         spa_history_internal_log(LOG_DS_REPLAY_INC_SYNC,
546             ds->ds_dir->dd_pool->dp_spa, tx, cr, "dataset = %lld",
547             ds->ds_object);
548 }
549
550 /*
551  * NB: callers *MUST* call dmu_recv_stream() if dmu_recv_begin()
552  * succeeds; otherwise we will leak the holds on the datasets.
553  */
554 int
555 dmu_recv_begin(char *tofs, char *tosnap, struct drr_begin *drrb,
556     boolean_t force, objset_t *origin, boolean_t online, dmu_recv_cookie_t *drc)
557 {
558         int err = 0;
559         boolean_t byteswap;
560         struct recvbeginsyncarg rbsa;
561         uint64_t version;
562         int flags;
563         dsl_dataset_t *ds;
564
565         if (drrb->drr_magic == DMU_BACKUP_MAGIC)
566                 byteswap = FALSE;
567         else if (drrb->drr_magic == BSWAP_64(DMU_BACKUP_MAGIC))
568                 byteswap = TRUE;
569         else
570                 return (EINVAL);
571
572         rbsa.tofs = tofs;
573         rbsa.tosnap = tosnap;
574         rbsa.origin = origin ? origin->os->os_dsl_dataset : NULL;
575         rbsa.fromguid = drrb->drr_fromguid;
576         rbsa.type = drrb->drr_type;
577         rbsa.tag = FTAG;
578         rbsa.dsflags = 0;
579         version = drrb->drr_version;
580         flags = drrb->drr_flags;
581
582         if (byteswap) {
583                 rbsa.type = BSWAP_32(rbsa.type);
584                 rbsa.fromguid = BSWAP_64(rbsa.fromguid);
585                 version = BSWAP_64(version);
586                 flags = BSWAP_32(flags);
587         }
588
589         if (version != DMU_BACKUP_STREAM_VERSION ||
590             rbsa.type >= DMU_OST_NUMTYPES ||
591             ((flags & DRR_FLAG_CLONE) && origin == NULL))
592                 return (EINVAL);
593
594         if (flags & DRR_FLAG_CI_DATA)
595                 rbsa.dsflags = DS_FLAG_CI_DATASET;
596
597         bzero(drc, sizeof (dmu_recv_cookie_t));
598         drc->drc_drrb = drrb;
599         drc->drc_tosnap = tosnap;
600         drc->drc_force = force;
601
602         /*
603          * Process the begin in syncing context.
604          */
605         if (rbsa.fromguid && !(flags & DRR_FLAG_CLONE) && !online) {
606                 /* offline incremental receive */
607                 err = dsl_dataset_own(tofs, 0, dmu_recv_tag, &ds);
608                 if (err)
609                         return (err);
610
611                 /*
612                  * Only do the rollback if the most recent snapshot
613                  * matches the incremental source
614                  */
615                 if (force) {
616                         if (ds->ds_prev == NULL ||
617                             ds->ds_prev->ds_phys->ds_guid !=
618                             rbsa.fromguid) {
619                                 dsl_dataset_disown(ds, dmu_recv_tag);
620                                 return (ENODEV);
621                         }
622                         (void) dsl_dataset_rollback(ds, DMU_OST_NONE);
623                 }
624                 rbsa.force = B_FALSE;
625                 err = dsl_sync_task_do(ds->ds_dir->dd_pool,
626                     recv_incremental_check,
627                     recv_offline_incremental_sync, ds, &rbsa, 1);
628                 if (err) {
629                         dsl_dataset_disown(ds, dmu_recv_tag);
630                         return (err);
631                 }
632                 drc->drc_logical_ds = drc->drc_real_ds = ds;
633         } else if (rbsa.fromguid && !(flags & DRR_FLAG_CLONE)) {
634                 /* online incremental receive */
635
636                 /* tmp clone name is: tofs/%tosnap" */
637                 (void) snprintf(rbsa.clonelastname, sizeof (rbsa.clonelastname),
638                     "%%%s", tosnap);
639
640                 /* open the dataset we are logically receiving into */
641                 err = dsl_dataset_hold(tofs, dmu_recv_tag, &ds);
642                 if (err)
643                         return (err);
644
645                 rbsa.force = force;
646                 err = dsl_sync_task_do(ds->ds_dir->dd_pool,
647                     recv_incremental_check,
648                     recv_online_incremental_sync, ds, &rbsa, 5);
649                 if (err) {
650                         dsl_dataset_rele(ds, dmu_recv_tag);
651                         return (err);
652                 }
653                 drc->drc_logical_ds = ds;
654                 drc->drc_real_ds = rbsa.ds;
655         } else {
656                 /* create new fs -- full backup or clone */
657                 dsl_dir_t *dd = NULL;
658                 const char *tail;
659
660                 err = dsl_dir_open(tofs, FTAG, &dd, &tail);
661                 if (err)
662                         return (err);
663                 if (tail == NULL) {
664                         if (!force) {
665                                 dsl_dir_close(dd, FTAG);
666                                 return (EEXIST);
667                         }
668
669                         rw_enter(&dd->dd_pool->dp_config_rwlock, RW_READER);
670                         err = dsl_dataset_own_obj(dd->dd_pool,
671                             dd->dd_phys->dd_head_dataset_obj,
672                             DS_MODE_INCONSISTENT, FTAG, &ds);
673                         rw_exit(&dd->dd_pool->dp_config_rwlock);
674                         if (err) {
675                                 dsl_dir_close(dd, FTAG);
676                                 return (err);
677                         }
678
679                         dsl_dataset_make_exclusive(ds, FTAG);
680                         err = dsl_sync_task_do(dd->dd_pool,
681                             recv_full_existing_check,
682                             recv_full_existing_sync, ds, &rbsa, 5);
683                         dsl_dataset_disown(ds, FTAG);
684                 } else {
685                         err = dsl_sync_task_do(dd->dd_pool, recv_full_check,
686                             recv_full_sync, dd, &rbsa, 5);
687                 }
688                 dsl_dir_close(dd, FTAG);
689                 if (err)
690                         return (err);
691                 drc->drc_logical_ds = drc->drc_real_ds = rbsa.ds;
692                 drc->drc_newfs = B_TRUE;
693         }
694
695         return (0);
696 }
697
698 struct restorearg {
699         int err;
700         int byteswap;
701         kthread_t *td;
702         struct file *fp;
703         char *buf;
704         uint64_t voff;
705         int bufsize; /* amount of memory allocated for buf */
706         zio_cksum_t cksum;
707 };
708
709 static int
710 restore_bytes(struct restorearg *ra, void *buf, int len, off_t off, int *resid)
711 {
712         struct uio auio;
713         struct iovec aiov;
714         int error;
715
716         aiov.iov_base = buf;
717         aiov.iov_len = len;
718         auio.uio_iov = &aiov;
719         auio.uio_iovcnt = 1;
720         auio.uio_resid = len;
721         auio.uio_segflg = UIO_SYSSPACE;
722         auio.uio_rw = UIO_READ;
723         auio.uio_offset = off;
724         auio.uio_td = ra->td;
725 #ifdef _KERNEL
726         error = fo_read(ra->fp, &auio, ra->td->td_ucred, FOF_OFFSET, ra->td);
727 #else
728         fprintf(stderr, "%s: returning EOPNOTSUPP\n", __func__);
729         error = EOPNOTSUPP;
730 #endif
731         *resid = auio.uio_resid;
732         return (error);
733 }
734
735 static void *
736 restore_read(struct restorearg *ra, int len)
737 {
738         void *rv;
739         int done = 0;
740
741         /* some things will require 8-byte alignment, so everything must */
742         ASSERT3U(len % 8, ==, 0);
743
744         while (done < len) {
745                 int resid;
746
747                 ra->err = restore_bytes(ra, (caddr_t)ra->buf + done,
748                     len - done, ra->voff, &resid);
749
750                 if (resid == len - done)
751                         ra->err = EINVAL;
752                 ra->voff += len - done - resid;
753                 done = len - resid;
754                 if (ra->err)
755                         return (NULL);
756         }
757
758         ASSERT3U(done, ==, len);
759         rv = ra->buf;
760         if (ra->byteswap)
761                 fletcher_4_incremental_byteswap(rv, len, &ra->cksum);
762         else
763                 fletcher_4_incremental_native(rv, len, &ra->cksum);
764         return (rv);
765 }
766
767 static void
768 backup_byteswap(dmu_replay_record_t *drr)
769 {
770 #define DO64(X) (drr->drr_u.X = BSWAP_64(drr->drr_u.X))
771 #define DO32(X) (drr->drr_u.X = BSWAP_32(drr->drr_u.X))
772         drr->drr_type = BSWAP_32(drr->drr_type);
773         drr->drr_payloadlen = BSWAP_32(drr->drr_payloadlen);
774         switch (drr->drr_type) {
775         case DRR_BEGIN:
776                 DO64(drr_begin.drr_magic);
777                 DO64(drr_begin.drr_version);
778                 DO64(drr_begin.drr_creation_time);
779                 DO32(drr_begin.drr_type);
780                 DO32(drr_begin.drr_flags);
781                 DO64(drr_begin.drr_toguid);
782                 DO64(drr_begin.drr_fromguid);
783                 break;
784         case DRR_OBJECT:
785                 DO64(drr_object.drr_object);
786                 /* DO64(drr_object.drr_allocation_txg); */
787                 DO32(drr_object.drr_type);
788                 DO32(drr_object.drr_bonustype);
789                 DO32(drr_object.drr_blksz);
790                 DO32(drr_object.drr_bonuslen);
791                 break;
792         case DRR_FREEOBJECTS:
793                 DO64(drr_freeobjects.drr_firstobj);
794                 DO64(drr_freeobjects.drr_numobjs);
795                 break;
796         case DRR_WRITE:
797                 DO64(drr_write.drr_object);
798                 DO32(drr_write.drr_type);
799                 DO64(drr_write.drr_offset);
800                 DO64(drr_write.drr_length);
801                 break;
802         case DRR_FREE:
803                 DO64(drr_free.drr_object);
804                 DO64(drr_free.drr_offset);
805                 DO64(drr_free.drr_length);
806                 break;
807         case DRR_END:
808                 DO64(drr_end.drr_checksum.zc_word[0]);
809                 DO64(drr_end.drr_checksum.zc_word[1]);
810                 DO64(drr_end.drr_checksum.zc_word[2]);
811                 DO64(drr_end.drr_checksum.zc_word[3]);
812                 break;
813         }
814 #undef DO64
815 #undef DO32
816 }
817
818 static int
819 restore_object(struct restorearg *ra, objset_t *os, struct drr_object *drro)
820 {
821         int err;
822         dmu_tx_t *tx;
823         void *data = NULL;
824
825         if (drro->drr_type == DMU_OT_NONE ||
826             drro->drr_type >= DMU_OT_NUMTYPES ||
827             drro->drr_bonustype >= DMU_OT_NUMTYPES ||
828             drro->drr_checksum >= ZIO_CHECKSUM_FUNCTIONS ||
829             drro->drr_compress >= ZIO_COMPRESS_FUNCTIONS ||
830             P2PHASE(drro->drr_blksz, SPA_MINBLOCKSIZE) ||
831             drro->drr_blksz < SPA_MINBLOCKSIZE ||
832             drro->drr_blksz > SPA_MAXBLOCKSIZE ||
833             drro->drr_bonuslen > DN_MAX_BONUSLEN) {
834                 return (EINVAL);
835         }
836
837         err = dmu_object_info(os, drro->drr_object, NULL);
838
839         if (err != 0 && err != ENOENT)
840                 return (EINVAL);
841
842         if (drro->drr_bonuslen) {
843                 data = restore_read(ra, P2ROUNDUP(drro->drr_bonuslen, 8));
844                 if (ra->err)
845                         return (ra->err);
846         }
847
848         if (err == ENOENT) {
849                 /* currently free, want to be allocated */
850                 tx = dmu_tx_create(os);
851                 dmu_tx_hold_bonus(tx, DMU_NEW_OBJECT);
852                 err = dmu_tx_assign(tx, TXG_WAIT);
853                 if (err) {
854                         dmu_tx_abort(tx);
855                         return (err);
856                 }
857                 err = dmu_object_claim(os, drro->drr_object,
858                     drro->drr_type, drro->drr_blksz,
859                     drro->drr_bonustype, drro->drr_bonuslen, tx);
860                 dmu_tx_commit(tx);
861         } else {
862                 /* currently allocated, want to be allocated */
863                 err = dmu_object_reclaim(os, drro->drr_object,
864                     drro->drr_type, drro->drr_blksz,
865                     drro->drr_bonustype, drro->drr_bonuslen);
866         }
867         if (err)
868                 return (EINVAL);
869
870         tx = dmu_tx_create(os);
871         dmu_tx_hold_bonus(tx, drro->drr_object);
872         err = dmu_tx_assign(tx, TXG_WAIT);
873         if (err) {
874                 dmu_tx_abort(tx);
875                 return (err);
876         }
877
878         dmu_object_set_checksum(os, drro->drr_object, drro->drr_checksum, tx);
879         dmu_object_set_compress(os, drro->drr_object, drro->drr_compress, tx);
880
881         if (data != NULL) {
882                 dmu_buf_t *db;
883
884                 VERIFY(0 == dmu_bonus_hold(os, drro->drr_object, FTAG, &db));
885                 dmu_buf_will_dirty(db, tx);
886
887                 ASSERT3U(db->db_size, >=, drro->drr_bonuslen);
888                 bcopy(data, db->db_data, drro->drr_bonuslen);
889                 if (ra->byteswap) {
890                         dmu_ot[drro->drr_bonustype].ot_byteswap(db->db_data,
891                             drro->drr_bonuslen);
892                 }
893                 dmu_buf_rele(db, FTAG);
894         }
895         dmu_tx_commit(tx);
896         return (0);
897 }
898
899 /* ARGSUSED */
900 static int
901 restore_freeobjects(struct restorearg *ra, objset_t *os,
902     struct drr_freeobjects *drrfo)
903 {
904         uint64_t obj;
905
906         if (drrfo->drr_firstobj + drrfo->drr_numobjs < drrfo->drr_firstobj)
907                 return (EINVAL);
908
909         for (obj = drrfo->drr_firstobj;
910             obj < drrfo->drr_firstobj + drrfo->drr_numobjs;
911             (void) dmu_object_next(os, &obj, FALSE, 0)) {
912                 int err;
913
914                 if (dmu_object_info(os, obj, NULL) != 0)
915                         continue;
916
917                 err = dmu_free_object(os, obj);
918                 if (err)
919                         return (err);
920         }
921         return (0);
922 }
923
924 static int
925 restore_write(struct restorearg *ra, objset_t *os,
926     struct drr_write *drrw)
927 {
928         dmu_tx_t *tx;
929         void *data;
930         int err;
931
932         if (drrw->drr_offset + drrw->drr_length < drrw->drr_offset ||
933             drrw->drr_type >= DMU_OT_NUMTYPES)
934                 return (EINVAL);
935
936         data = restore_read(ra, drrw->drr_length);
937         if (data == NULL)
938                 return (ra->err);
939
940         if (dmu_object_info(os, drrw->drr_object, NULL) != 0)
941                 return (EINVAL);
942
943         tx = dmu_tx_create(os);
944
945         dmu_tx_hold_write(tx, drrw->drr_object,
946             drrw->drr_offset, drrw->drr_length);
947         err = dmu_tx_assign(tx, TXG_WAIT);
948         if (err) {
949                 dmu_tx_abort(tx);
950                 return (err);
951         }
952         if (ra->byteswap)
953                 dmu_ot[drrw->drr_type].ot_byteswap(data, drrw->drr_length);
954         dmu_write(os, drrw->drr_object,
955             drrw->drr_offset, drrw->drr_length, data, tx);
956         dmu_tx_commit(tx);
957         return (0);
958 }
959
960 /* ARGSUSED */
961 static int
962 restore_free(struct restorearg *ra, objset_t *os,
963     struct drr_free *drrf)
964 {
965         int err;
966
967         if (drrf->drr_length != -1ULL &&
968             drrf->drr_offset + drrf->drr_length < drrf->drr_offset)
969                 return (EINVAL);
970
971         if (dmu_object_info(os, drrf->drr_object, NULL) != 0)
972                 return (EINVAL);
973
974         err = dmu_free_long_range(os, drrf->drr_object,
975             drrf->drr_offset, drrf->drr_length);
976         return (err);
977 }
978
979 void
980 dmu_recv_abort_cleanup(dmu_recv_cookie_t *drc)
981 {
982         if (drc->drc_newfs || drc->drc_real_ds != drc->drc_logical_ds) {
983                 /*
984                  * online incremental or new fs: destroy the fs (which
985                  * may be a clone) that we created
986                  */
987                 (void) dsl_dataset_destroy(drc->drc_real_ds, dmu_recv_tag);
988                 if (drc->drc_real_ds != drc->drc_logical_ds)
989                         dsl_dataset_rele(drc->drc_logical_ds, dmu_recv_tag);
990         } else {
991                 /*
992                  * offline incremental: rollback to most recent snapshot.
993                  */
994                 (void) dsl_dataset_rollback(drc->drc_real_ds, DMU_OST_NONE);
995                 dsl_dataset_disown(drc->drc_real_ds, dmu_recv_tag);
996         }
997 }
998
999 /*
1000  * NB: callers *must* call dmu_recv_end() if this succeeds.
1001  */
1002 int
1003 dmu_recv_stream(dmu_recv_cookie_t *drc, struct file *fp, offset_t *voffp)
1004 {
1005         kthread_t *td = curthread;
1006         struct restorearg ra = { 0 };
1007         dmu_replay_record_t *drr;
1008         objset_t *os;
1009         zio_cksum_t pcksum;
1010
1011         if (drc->drc_drrb->drr_magic == BSWAP_64(DMU_BACKUP_MAGIC))
1012                 ra.byteswap = TRUE;
1013
1014         {
1015                 /* compute checksum of drr_begin record */
1016                 dmu_replay_record_t *drr;
1017                 drr = kmem_zalloc(sizeof (dmu_replay_record_t), KM_SLEEP);
1018
1019                 drr->drr_type = DRR_BEGIN;
1020                 drr->drr_u.drr_begin = *drc->drc_drrb;
1021                 if (ra.byteswap) {
1022                         fletcher_4_incremental_byteswap(drr,
1023                             sizeof (dmu_replay_record_t), &ra.cksum);
1024                 } else {
1025                         fletcher_4_incremental_native(drr,
1026                             sizeof (dmu_replay_record_t), &ra.cksum);
1027                 }
1028                 kmem_free(drr, sizeof (dmu_replay_record_t));
1029         }
1030
1031         if (ra.byteswap) {
1032                 struct drr_begin *drrb = drc->drc_drrb;
1033                 drrb->drr_magic = BSWAP_64(drrb->drr_magic);
1034                 drrb->drr_version = BSWAP_64(drrb->drr_version);
1035                 drrb->drr_creation_time = BSWAP_64(drrb->drr_creation_time);
1036                 drrb->drr_type = BSWAP_32(drrb->drr_type);
1037                 drrb->drr_toguid = BSWAP_64(drrb->drr_toguid);
1038                 drrb->drr_fromguid = BSWAP_64(drrb->drr_fromguid);
1039         }
1040
1041         ra.td = td;
1042         ra.fp = fp;
1043         ra.voff = *voffp;
1044         ra.bufsize = 1<<20;
1045         ra.buf = kmem_alloc(ra.bufsize, KM_SLEEP);
1046
1047         /* these were verified in dmu_recv_begin */
1048         ASSERT(drc->drc_drrb->drr_version == DMU_BACKUP_STREAM_VERSION);
1049         ASSERT(drc->drc_drrb->drr_type < DMU_OST_NUMTYPES);
1050
1051         /*
1052          * Open the objset we are modifying.
1053          */
1054         VERIFY(dmu_objset_open_ds(drc->drc_real_ds, DMU_OST_ANY, &os) == 0);
1055
1056         ASSERT(drc->drc_real_ds->ds_phys->ds_flags & DS_FLAG_INCONSISTENT);
1057
1058         /*
1059          * Read records and process them.
1060          */
1061         pcksum = ra.cksum;
1062         while (ra.err == 0 &&
1063             NULL != (drr = restore_read(&ra, sizeof (*drr)))) {
1064                 if (issig(JUSTLOOKING) && issig(FORREAL)) {
1065                         ra.err = EINTR;
1066                         goto out;
1067                 }
1068
1069                 if (ra.byteswap)
1070                         backup_byteswap(drr);
1071
1072                 switch (drr->drr_type) {
1073                 case DRR_OBJECT:
1074                 {
1075                         /*
1076                          * We need to make a copy of the record header,
1077                          * because restore_{object,write} may need to
1078                          * restore_read(), which will invalidate drr.
1079                          */
1080                         struct drr_object drro = drr->drr_u.drr_object;
1081                         ra.err = restore_object(&ra, os, &drro);
1082                         break;
1083                 }
1084                 case DRR_FREEOBJECTS:
1085                 {
1086                         struct drr_freeobjects drrfo =
1087                             drr->drr_u.drr_freeobjects;
1088                         ra.err = restore_freeobjects(&ra, os, &drrfo);
1089                         break;
1090                 }
1091                 case DRR_WRITE:
1092                 {
1093                         struct drr_write drrw = drr->drr_u.drr_write;
1094                         ra.err = restore_write(&ra, os, &drrw);
1095                         break;
1096                 }
1097                 case DRR_FREE:
1098                 {
1099                         struct drr_free drrf = drr->drr_u.drr_free;
1100                         ra.err = restore_free(&ra, os, &drrf);
1101                         break;
1102                 }
1103                 case DRR_END:
1104                 {
1105                         struct drr_end drre = drr->drr_u.drr_end;
1106                         /*
1107                          * We compare against the *previous* checksum
1108                          * value, because the stored checksum is of
1109                          * everything before the DRR_END record.
1110                          */
1111                         if (!ZIO_CHECKSUM_EQUAL(drre.drr_checksum, pcksum))
1112                                 ra.err = ECKSUM;
1113                         goto out;
1114                 }
1115                 default:
1116                         ra.err = EINVAL;
1117                         goto out;
1118                 }
1119                 pcksum = ra.cksum;
1120         }
1121         ASSERT(ra.err != 0);
1122
1123 out:
1124         dmu_objset_close(os);
1125
1126         if (ra.err != 0) {
1127                 /*
1128                  * rollback or destroy what we created, so we don't
1129                  * leave it in the restoring state.
1130                  */
1131                 txg_wait_synced(drc->drc_real_ds->ds_dir->dd_pool, 0);
1132                 dmu_recv_abort_cleanup(drc);
1133         }
1134
1135         kmem_free(ra.buf, ra.bufsize);
1136         *voffp = ra.voff;
1137         return (ra.err);
1138 }
1139
1140 struct recvendsyncarg {
1141         char *tosnap;
1142         uint64_t creation_time;
1143         uint64_t toguid;
1144 };
1145
1146 static int
1147 recv_end_check(void *arg1, void *arg2, dmu_tx_t *tx)
1148 {
1149         dsl_dataset_t *ds = arg1;
1150         struct recvendsyncarg *resa = arg2;
1151
1152         return (dsl_dataset_snapshot_check(ds, resa->tosnap, tx));
1153 }
1154
1155 static void
1156 recv_end_sync(void *arg1, void *arg2, cred_t *cr, dmu_tx_t *tx)
1157 {
1158         dsl_dataset_t *ds = arg1;
1159         struct recvendsyncarg *resa = arg2;
1160
1161         dsl_dataset_snapshot_sync(ds, resa->tosnap, cr, tx);
1162
1163         /* set snapshot's creation time and guid */
1164         dmu_buf_will_dirty(ds->ds_prev->ds_dbuf, tx);
1165         ds->ds_prev->ds_phys->ds_creation_time = resa->creation_time;
1166         ds->ds_prev->ds_phys->ds_guid = resa->toguid;
1167         ds->ds_prev->ds_phys->ds_flags &= ~DS_FLAG_INCONSISTENT;
1168
1169         dmu_buf_will_dirty(ds->ds_dbuf, tx);
1170         ds->ds_phys->ds_flags &= ~DS_FLAG_INCONSISTENT;
1171 }
1172
1173 int
1174 dmu_recv_end(dmu_recv_cookie_t *drc)
1175 {
1176         struct recvendsyncarg resa;
1177         dsl_dataset_t *ds = drc->drc_logical_ds;
1178         int err;
1179
1180         /*
1181          * XXX hack; seems the ds is still dirty and
1182          * dsl_pool_zil_clean() expects it to have a ds_user_ptr
1183          * (and zil), but clone_swap() can close it.
1184          */
1185         txg_wait_synced(ds->ds_dir->dd_pool, 0);
1186
1187         if (ds != drc->drc_real_ds) {
1188                 /* we are doing an online recv */
1189                 if (dsl_dataset_tryown(ds, FALSE, dmu_recv_tag)) {
1190                         err = dsl_dataset_clone_swap(drc->drc_real_ds, ds,
1191                             drc->drc_force);
1192                         if (err)
1193                                 dsl_dataset_disown(ds, dmu_recv_tag);
1194                 } else {
1195                         err = EBUSY;
1196                         dsl_dataset_rele(ds, dmu_recv_tag);
1197                 }
1198                 /* dsl_dataset_destroy() will disown the ds */
1199                 (void) dsl_dataset_destroy(drc->drc_real_ds, dmu_recv_tag);
1200                 if (err)
1201                         return (err);
1202         }
1203
1204         resa.creation_time = drc->drc_drrb->drr_creation_time;
1205         resa.toguid = drc->drc_drrb->drr_toguid;
1206         resa.tosnap = drc->drc_tosnap;
1207
1208         err = dsl_sync_task_do(ds->ds_dir->dd_pool,
1209             recv_end_check, recv_end_sync, ds, &resa, 3);
1210         if (err) {
1211                 if (drc->drc_newfs) {
1212                         ASSERT(ds == drc->drc_real_ds);
1213                         (void) dsl_dataset_destroy(ds, dmu_recv_tag);
1214                         return (err);
1215                 } else {
1216                         (void) dsl_dataset_rollback(ds, DMU_OST_NONE);
1217                 }
1218         }
1219
1220         /* release the hold from dmu_recv_begin */
1221         dsl_dataset_disown(ds, dmu_recv_tag);
1222         return (err);
1223 }