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.
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.
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]
23 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Copyright (c) 2011, 2015 by Delphix. All rights reserved.
25 * Copyright (c) 2012, Joyent, Inc. All rights reserved.
26 * Copyright (c) 2012 Pawel Jakub Dawidek <pawel@dawidek.net>.
28 * Copyright (c) 2013 Steven Hartland. All rights reserved.
29 * Copyright 2015, OmniTI Computer Consulting, Inc. All rights reserved.
42 #include <sys/mount.h>
43 #include <sys/mntent.h>
44 #include <sys/mnttab.h>
46 #include <sys/debug.h>
54 #include <libzfs_core.h>
56 #include "zfs_namecheck.h"
58 #include "zfs_fletcher.h"
59 #include "libzfs_impl.h"
61 #include <sys/zio_checksum.h>
63 #include <sys/socket.h>
65 /* in libzfs_dataset.c */
66 extern void zfs_setprop_error(libzfs_handle_t
*, zfs_prop_t
, int, char *);
68 static int zfs_receive_impl(libzfs_handle_t
*, const char *, const char *,
69 recvflags_t
*, int, const char *, nvlist_t
*, avl_tree_t
*, char **, int,
70 uint64_t *, const char *);
71 static int guid_to_name(libzfs_handle_t
*, const char *,
72 uint64_t, boolean_t
, char *);
74 static const zio_cksum_t zero_cksum
= { { 0 } };
76 typedef struct dedup_arg
{
79 libzfs_handle_t
*dedup_hdl
;
82 typedef struct progress_arg
{
85 boolean_t pa_parsable
;
88 typedef struct dataref
{
94 typedef struct dedup_entry
{
95 struct dedup_entry
*dde_next
;
96 zio_cksum_t dde_chksum
;
101 #define MAX_DDT_PHYSMEM_PERCENT 20
102 #define SMALLEST_POSSIBLE_MAX_DDT_MB 128
104 typedef struct dedup_table
{
105 dedup_entry_t
**dedup_hash_array
;
106 umem_cache_t
*ddecache
;
107 uint64_t max_ddt_size
; /* max dedup table size in bytes */
108 uint64_t cur_ddt_size
; /* current dedup table size in bytes */
115 high_order_bit(uint64_t n
)
119 for (count
= 0; n
!= 0; count
++)
125 ssread(void *buf
, size_t len
, FILE *stream
)
129 if ((outlen
= fread(buf
, len
, 1, stream
)) == 0)
136 ddt_hash_append(libzfs_handle_t
*hdl
, dedup_table_t
*ddt
, dedup_entry_t
**ddepp
,
137 zio_cksum_t
*cs
, uint64_t prop
, dataref_t
*dr
)
141 if (ddt
->cur_ddt_size
>= ddt
->max_ddt_size
) {
142 if (ddt
->ddt_full
== B_FALSE
) {
143 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
144 "Dedup table full. Deduplication will continue "
145 "with existing table entries"));
146 ddt
->ddt_full
= B_TRUE
;
151 if ((dde
= umem_cache_alloc(ddt
->ddecache
, UMEM_DEFAULT
))
153 assert(*ddepp
== NULL
);
154 dde
->dde_next
= NULL
;
155 dde
->dde_chksum
= *cs
;
156 dde
->dde_prop
= prop
;
159 ddt
->cur_ddt_size
+= sizeof (dedup_entry_t
);
165 * Using the specified dedup table, do a lookup for an entry with
166 * the checksum cs. If found, return the block's reference info
167 * in *dr. Otherwise, insert a new entry in the dedup table, using
168 * the reference information specified by *dr.
170 * return value: true - entry was found
171 * false - entry was not found
174 ddt_update(libzfs_handle_t
*hdl
, dedup_table_t
*ddt
, zio_cksum_t
*cs
,
175 uint64_t prop
, dataref_t
*dr
)
178 dedup_entry_t
**ddepp
;
180 hashcode
= BF64_GET(cs
->zc_word
[0], 0, ddt
->numhashbits
);
182 for (ddepp
= &(ddt
->dedup_hash_array
[hashcode
]); *ddepp
!= NULL
;
183 ddepp
= &((*ddepp
)->dde_next
)) {
184 if (ZIO_CHECKSUM_EQUAL(((*ddepp
)->dde_chksum
), *cs
) &&
185 (*ddepp
)->dde_prop
== prop
) {
186 *dr
= (*ddepp
)->dde_ref
;
190 ddt_hash_append(hdl
, ddt
, ddepp
, cs
, prop
, dr
);
195 dump_record(dmu_replay_record_t
*drr
, void *payload
, int payload_len
,
196 zio_cksum_t
*zc
, int outfd
)
198 ASSERT3U(offsetof(dmu_replay_record_t
, drr_u
.drr_checksum
.drr_checksum
),
199 ==, sizeof (dmu_replay_record_t
) - sizeof (zio_cksum_t
));
200 fletcher_4_incremental_native(drr
,
201 offsetof(dmu_replay_record_t
, drr_u
.drr_checksum
.drr_checksum
), zc
);
202 if (drr
->drr_type
!= DRR_BEGIN
) {
203 ASSERT(ZIO_CHECKSUM_IS_ZERO(&drr
->drr_u
.
204 drr_checksum
.drr_checksum
));
205 drr
->drr_u
.drr_checksum
.drr_checksum
= *zc
;
207 fletcher_4_incremental_native(&drr
->drr_u
.drr_checksum
.drr_checksum
,
208 sizeof (zio_cksum_t
), zc
);
209 if (write(outfd
, drr
, sizeof (*drr
)) == -1)
211 if (payload_len
!= 0) {
212 fletcher_4_incremental_native(payload
, payload_len
, zc
);
213 if (write(outfd
, payload
, payload_len
) == -1)
220 * This function is started in a separate thread when the dedup option
221 * has been requested. The main send thread determines the list of
222 * snapshots to be included in the send stream and makes the ioctl calls
223 * for each one. But instead of having the ioctl send the output to the
224 * the output fd specified by the caller of zfs_send()), the
225 * ioctl is told to direct the output to a pipe, which is read by the
226 * alternate thread running THIS function. This function does the
228 * 1. building a dedup table (the DDT)
229 * 2. doing checksums on each data block and inserting a record in the DDT
230 * 3. looking for matching checksums, and
231 * 4. sending a DRR_WRITE_BYREF record instead of a write record whenever
232 * a duplicate block is found.
233 * The output of this function then goes to the output fd requested
234 * by the caller of zfs_send().
239 dedup_arg_t
*dda
= arg
;
240 char *buf
= zfs_alloc(dda
->dedup_hdl
, SPA_MAXBLOCKSIZE
);
241 dmu_replay_record_t thedrr
= { 0 };
242 dmu_replay_record_t
*drr
= &thedrr
;
246 zio_cksum_t stream_cksum
;
247 uint64_t physmem
= sysconf(_SC_PHYS_PAGES
) * sysconf(_SC_PAGESIZE
);
251 MAX((physmem
* MAX_DDT_PHYSMEM_PERCENT
) / 100,
252 SMALLEST_POSSIBLE_MAX_DDT_MB
<< 20);
254 numbuckets
= ddt
.max_ddt_size
/ (sizeof (dedup_entry_t
));
257 * numbuckets must be a power of 2. Increase number to
258 * a power of 2 if necessary.
260 if (!ISP2(numbuckets
))
261 numbuckets
= 1 << high_order_bit(numbuckets
);
263 ddt
.dedup_hash_array
= calloc(numbuckets
, sizeof (dedup_entry_t
*));
264 ddt
.ddecache
= umem_cache_create("dde", sizeof (dedup_entry_t
), 0,
265 NULL
, NULL
, NULL
, NULL
, NULL
, 0);
266 ddt
.cur_ddt_size
= numbuckets
* sizeof (dedup_entry_t
*);
267 ddt
.numhashbits
= high_order_bit(numbuckets
) - 1;
268 ddt
.ddt_full
= B_FALSE
;
270 outfd
= dda
->outputfd
;
271 ofp
= fdopen(dda
->inputfd
, "r");
272 while (ssread(drr
, sizeof (*drr
), ofp
) != 0) {
274 switch (drr
->drr_type
) {
277 struct drr_begin
*drrb
= &drr
->drr_u
.drr_begin
;
280 ZIO_SET_CHECKSUM(&stream_cksum
, 0, 0, 0, 0);
282 ASSERT3U(drrb
->drr_magic
, ==, DMU_BACKUP_MAGIC
);
284 /* set the DEDUP feature flag for this stream */
285 fflags
= DMU_GET_FEATUREFLAGS(drrb
->drr_versioninfo
);
286 fflags
|= (DMU_BACKUP_FEATURE_DEDUP
|
287 DMU_BACKUP_FEATURE_DEDUPPROPS
);
288 DMU_SET_FEATUREFLAGS(drrb
->drr_versioninfo
, fflags
);
290 if (drr
->drr_payloadlen
!= 0) {
291 sz
= drr
->drr_payloadlen
;
293 if (sz
> SPA_MAXBLOCKSIZE
) {
294 buf
= zfs_realloc(dda
->dedup_hdl
, buf
,
295 SPA_MAXBLOCKSIZE
, sz
);
297 (void) ssread(buf
, sz
, ofp
);
301 if (dump_record(drr
, buf
, sz
, &stream_cksum
,
309 struct drr_end
*drre
= &drr
->drr_u
.drr_end
;
310 /* use the recalculated checksum */
311 drre
->drr_checksum
= stream_cksum
;
312 if (dump_record(drr
, NULL
, 0, &stream_cksum
,
320 struct drr_object
*drro
= &drr
->drr_u
.drr_object
;
321 if (drro
->drr_bonuslen
> 0) {
323 P2ROUNDUP((uint64_t)drro
->drr_bonuslen
, 8),
326 if (dump_record(drr
, buf
,
327 P2ROUNDUP((uint64_t)drro
->drr_bonuslen
, 8),
328 &stream_cksum
, outfd
) != 0)
335 struct drr_spill
*drrs
= &drr
->drr_u
.drr_spill
;
336 (void) ssread(buf
, drrs
->drr_length
, ofp
);
337 if (dump_record(drr
, buf
, drrs
->drr_length
,
338 &stream_cksum
, outfd
) != 0)
343 case DRR_FREEOBJECTS
:
345 if (dump_record(drr
, NULL
, 0, &stream_cksum
,
353 struct drr_write
*drrw
= &drr
->drr_u
.drr_write
;
355 uint64_t payload_size
;
357 payload_size
= DRR_WRITE_PAYLOAD_SIZE(drrw
);
358 (void) ssread(buf
, payload_size
, ofp
);
361 * Use the existing checksum if it's dedup-capable,
362 * else calculate a SHA256 checksum for it.
365 if (ZIO_CHECKSUM_EQUAL(drrw
->drr_key
.ddk_cksum
,
367 !DRR_IS_DEDUP_CAPABLE(drrw
->drr_checksumflags
)) {
368 zio_cksum_t tmpsha256
;
370 zio_checksum_SHA256(buf
,
371 payload_size
, &tmpsha256
);
373 drrw
->drr_key
.ddk_cksum
.zc_word
[0] =
374 BE_64(tmpsha256
.zc_word
[0]);
375 drrw
->drr_key
.ddk_cksum
.zc_word
[1] =
376 BE_64(tmpsha256
.zc_word
[1]);
377 drrw
->drr_key
.ddk_cksum
.zc_word
[2] =
378 BE_64(tmpsha256
.zc_word
[2]);
379 drrw
->drr_key
.ddk_cksum
.zc_word
[3] =
380 BE_64(tmpsha256
.zc_word
[3]);
381 drrw
->drr_checksumtype
= ZIO_CHECKSUM_SHA256
;
382 drrw
->drr_checksumflags
= DRR_CHECKSUM_DEDUP
;
385 dataref
.ref_guid
= drrw
->drr_toguid
;
386 dataref
.ref_object
= drrw
->drr_object
;
387 dataref
.ref_offset
= drrw
->drr_offset
;
389 if (ddt_update(dda
->dedup_hdl
, &ddt
,
390 &drrw
->drr_key
.ddk_cksum
, drrw
->drr_key
.ddk_prop
,
392 dmu_replay_record_t wbr_drr
= {0};
393 struct drr_write_byref
*wbr_drrr
=
394 &wbr_drr
.drr_u
.drr_write_byref
;
396 /* block already present in stream */
397 wbr_drr
.drr_type
= DRR_WRITE_BYREF
;
399 wbr_drrr
->drr_object
= drrw
->drr_object
;
400 wbr_drrr
->drr_offset
= drrw
->drr_offset
;
401 wbr_drrr
->drr_length
= drrw
->drr_logical_size
;
402 wbr_drrr
->drr_toguid
= drrw
->drr_toguid
;
403 wbr_drrr
->drr_refguid
= dataref
.ref_guid
;
404 wbr_drrr
->drr_refobject
=
406 wbr_drrr
->drr_refoffset
=
409 wbr_drrr
->drr_checksumtype
=
410 drrw
->drr_checksumtype
;
411 wbr_drrr
->drr_checksumflags
=
412 drrw
->drr_checksumtype
;
413 wbr_drrr
->drr_key
.ddk_cksum
=
414 drrw
->drr_key
.ddk_cksum
;
415 wbr_drrr
->drr_key
.ddk_prop
=
416 drrw
->drr_key
.ddk_prop
;
418 if (dump_record(&wbr_drr
, NULL
, 0,
419 &stream_cksum
, outfd
) != 0)
422 /* block not previously seen */
423 if (dump_record(drr
, buf
, payload_size
,
424 &stream_cksum
, outfd
) != 0)
430 case DRR_WRITE_EMBEDDED
:
432 struct drr_write_embedded
*drrwe
=
433 &drr
->drr_u
.drr_write_embedded
;
435 P2ROUNDUP((uint64_t)drrwe
->drr_psize
, 8), ofp
);
436 if (dump_record(drr
, buf
,
437 P2ROUNDUP((uint64_t)drrwe
->drr_psize
, 8),
438 &stream_cksum
, outfd
) != 0)
445 if (dump_record(drr
, NULL
, 0, &stream_cksum
,
452 (void) fprintf(stderr
, "INVALID record type 0x%x\n",
454 /* should never happen, so assert */
459 umem_cache_destroy(ddt
.ddecache
);
460 free(ddt
.dedup_hash_array
);
468 * Routines for dealing with the AVL tree of fs-nvlists
470 typedef struct fsavl_node
{
478 fsavl_compare(const void *arg1
, const void *arg2
)
480 const fsavl_node_t
*fn1
= (const fsavl_node_t
*)arg1
;
481 const fsavl_node_t
*fn2
= (const fsavl_node_t
*)arg2
;
483 return (AVL_CMP(fn1
->fn_guid
, fn2
->fn_guid
));
487 * Given the GUID of a snapshot, find its containing filesystem and
491 fsavl_find(avl_tree_t
*avl
, uint64_t snapguid
, char **snapname
)
493 fsavl_node_t fn_find
;
496 fn_find
.fn_guid
= snapguid
;
498 fn
= avl_find(avl
, &fn_find
, NULL
);
501 *snapname
= fn
->fn_snapname
;
502 return (fn
->fn_nvfs
);
508 fsavl_destroy(avl_tree_t
*avl
)
517 while ((fn
= avl_destroy_nodes(avl
, &cookie
)) != NULL
)
524 * Given an nvlist, produce an avl tree of snapshots, ordered by guid
527 fsavl_create(nvlist_t
*fss
)
530 nvpair_t
*fselem
= NULL
;
532 if ((fsavl
= malloc(sizeof (avl_tree_t
))) == NULL
)
535 avl_create(fsavl
, fsavl_compare
, sizeof (fsavl_node_t
),
536 offsetof(fsavl_node_t
, fn_node
));
538 while ((fselem
= nvlist_next_nvpair(fss
, fselem
)) != NULL
) {
539 nvlist_t
*nvfs
, *snaps
;
540 nvpair_t
*snapelem
= NULL
;
542 VERIFY(0 == nvpair_value_nvlist(fselem
, &nvfs
));
543 VERIFY(0 == nvlist_lookup_nvlist(nvfs
, "snaps", &snaps
));
546 nvlist_next_nvpair(snaps
, snapelem
)) != NULL
) {
550 VERIFY(0 == nvpair_value_uint64(snapelem
, &guid
));
551 if ((fn
= malloc(sizeof (fsavl_node_t
))) == NULL
) {
552 fsavl_destroy(fsavl
);
556 fn
->fn_snapname
= nvpair_name(snapelem
);
560 * Note: if there are multiple snaps with the
561 * same GUID, we ignore all but one.
563 if (avl_find(fsavl
, fn
, NULL
) == NULL
)
574 * Routines for dealing with the giant nvlist of fs-nvlists, etc.
576 typedef struct send_data
{
578 * assigned inside every recursive call,
579 * restored from *_save on return:
581 * guid of fromsnap snapshot in parent dataset
582 * txg of fromsnap snapshot in current dataset
583 * txg of tosnap snapshot in current dataset
586 uint64_t parent_fromsnap_guid
;
587 uint64_t fromsnap_txg
;
590 /* the nvlists get accumulated during depth-first traversal */
591 nvlist_t
*parent_snaps
;
595 /* send-receive configuration, does not change during traversal */
597 const char *fromsnap
;
605 * The header nvlist is of the following format:
608 * "fromsnap" -> string (if incremental)
612 * "name" -> string (full name; for debugging)
613 * "parentfromsnap" -> number (guid of fromsnap in parent)
615 * "props" -> { name -> value (only if set here) }
616 * "snaps" -> { name (lastname) -> number (guid) }
617 * "snapprops" -> { name (lastname) -> { name -> value } }
619 * "origin" -> number (guid) (if clone)
620 * "sent" -> boolean (not on-disk)
628 static void send_iterate_prop(zfs_handle_t
*zhp
, nvlist_t
*nv
);
631 send_iterate_snap(zfs_handle_t
*zhp
, void *arg
)
633 send_data_t
*sd
= arg
;
634 uint64_t guid
= zhp
->zfs_dmustats
.dds_guid
;
635 uint64_t txg
= zhp
->zfs_dmustats
.dds_creation_txg
;
638 boolean_t isfromsnap
, istosnap
, istosnapwithnofrom
;
640 snapname
= strrchr(zhp
->zfs_name
, '@')+1;
641 isfromsnap
= (sd
->fromsnap
!= NULL
&&
642 strcmp(sd
->fromsnap
, snapname
) == 0);
643 istosnap
= (sd
->tosnap
!= NULL
&& (strcmp(sd
->tosnap
, snapname
) == 0));
644 istosnapwithnofrom
= (istosnap
&& sd
->fromsnap
== NULL
);
646 if (sd
->tosnap_txg
!= 0 && txg
> sd
->tosnap_txg
) {
648 (void) fprintf(stderr
, dgettext(TEXT_DOMAIN
,
649 "skipping snapshot %s because it was created "
650 "after the destination snapshot (%s)\n"),
651 zhp
->zfs_name
, sd
->tosnap
);
657 VERIFY(0 == nvlist_add_uint64(sd
->parent_snaps
, snapname
, guid
));
659 * NB: if there is no fromsnap here (it's a newly created fs in
660 * an incremental replication), we will substitute the tosnap.
662 if (isfromsnap
|| (sd
->parent_fromsnap_guid
== 0 && istosnap
)) {
663 sd
->parent_fromsnap_guid
= guid
;
666 if (!sd
->recursive
) {
667 if (!sd
->seenfrom
&& isfromsnap
) {
668 sd
->seenfrom
= B_TRUE
;
673 if ((sd
->seento
|| !sd
->seenfrom
) && !istosnapwithnofrom
) {
682 VERIFY(0 == nvlist_alloc(&nv
, NV_UNIQUE_NAME
, 0));
683 send_iterate_prop(zhp
, nv
);
684 VERIFY(0 == nvlist_add_nvlist(sd
->snapprops
, snapname
, nv
));
692 send_iterate_prop(zfs_handle_t
*zhp
, nvlist_t
*nv
)
694 nvpair_t
*elem
= NULL
;
696 while ((elem
= nvlist_next_nvpair(zhp
->zfs_props
, elem
)) != NULL
) {
697 char *propname
= nvpair_name(elem
);
698 zfs_prop_t prop
= zfs_name_to_prop(propname
);
701 if (!zfs_prop_user(propname
)) {
703 * Realistically, this should never happen. However,
704 * we want the ability to add DSL properties without
705 * needing to make incompatible version changes. We
706 * need to ignore unknown properties to allow older
707 * software to still send datasets containing these
708 * properties, with the unknown properties elided.
710 if (prop
== ZPROP_INVAL
)
713 if (zfs_prop_readonly(prop
))
717 verify(nvpair_value_nvlist(elem
, &propnv
) == 0);
718 if (prop
== ZFS_PROP_QUOTA
|| prop
== ZFS_PROP_RESERVATION
||
719 prop
== ZFS_PROP_REFQUOTA
||
720 prop
== ZFS_PROP_REFRESERVATION
) {
723 verify(nvlist_lookup_uint64(propnv
,
724 ZPROP_VALUE
, &value
) == 0);
725 if (zhp
->zfs_type
== ZFS_TYPE_SNAPSHOT
)
728 * May have no source before SPA_VERSION_RECVD_PROPS,
729 * but is still modifiable.
731 if (nvlist_lookup_string(propnv
,
732 ZPROP_SOURCE
, &source
) == 0) {
733 if ((strcmp(source
, zhp
->zfs_name
) != 0) &&
735 ZPROP_SOURCE_VAL_RECVD
) != 0))
740 if (nvlist_lookup_string(propnv
,
741 ZPROP_SOURCE
, &source
) != 0)
743 if ((strcmp(source
, zhp
->zfs_name
) != 0) &&
744 (strcmp(source
, ZPROP_SOURCE_VAL_RECVD
) != 0))
748 if (zfs_prop_user(propname
) ||
749 zfs_prop_get_type(prop
) == PROP_TYPE_STRING
) {
751 verify(nvlist_lookup_string(propnv
,
752 ZPROP_VALUE
, &value
) == 0);
753 VERIFY(0 == nvlist_add_string(nv
, propname
, value
));
756 verify(nvlist_lookup_uint64(propnv
,
757 ZPROP_VALUE
, &value
) == 0);
758 VERIFY(0 == nvlist_add_uint64(nv
, propname
, value
));
764 * returns snapshot creation txg
765 * and returns 0 if the snapshot does not exist
768 get_snap_txg(libzfs_handle_t
*hdl
, const char *fs
, const char *snap
)
770 char name
[ZFS_MAX_DATASET_NAME_LEN
];
773 if (fs
== NULL
|| fs
[0] == '\0' || snap
== NULL
|| snap
[0] == '\0')
776 (void) snprintf(name
, sizeof (name
), "%s@%s", fs
, snap
);
777 if (zfs_dataset_exists(hdl
, name
, ZFS_TYPE_SNAPSHOT
)) {
778 zfs_handle_t
*zhp
= zfs_open(hdl
, name
, ZFS_TYPE_SNAPSHOT
);
780 txg
= zfs_prop_get_int(zhp
, ZFS_PROP_CREATETXG
);
789 * recursively generate nvlists describing datasets. See comment
790 * for the data structure send_data_t above for description of contents
794 send_iterate_fs(zfs_handle_t
*zhp
, void *arg
)
796 send_data_t
*sd
= arg
;
799 uint64_t parent_fromsnap_guid_save
= sd
->parent_fromsnap_guid
;
800 uint64_t fromsnap_txg_save
= sd
->fromsnap_txg
;
801 uint64_t tosnap_txg_save
= sd
->tosnap_txg
;
802 uint64_t txg
= zhp
->zfs_dmustats
.dds_creation_txg
;
803 uint64_t guid
= zhp
->zfs_dmustats
.dds_guid
;
804 uint64_t fromsnap_txg
, tosnap_txg
;
807 fromsnap_txg
= get_snap_txg(zhp
->zfs_hdl
, zhp
->zfs_name
, sd
->fromsnap
);
808 if (fromsnap_txg
!= 0)
809 sd
->fromsnap_txg
= fromsnap_txg
;
811 tosnap_txg
= get_snap_txg(zhp
->zfs_hdl
, zhp
->zfs_name
, sd
->tosnap
);
813 sd
->tosnap_txg
= tosnap_txg
;
816 * on the send side, if the current dataset does not have tosnap,
817 * perform two additional checks:
819 * - skip sending the current dataset if it was created later than
821 * - return error if the current dataset was created earlier than
824 if (sd
->tosnap
!= NULL
&& tosnap_txg
== 0) {
825 if (sd
->tosnap_txg
!= 0 && txg
> sd
->tosnap_txg
) {
827 (void) fprintf(stderr
, dgettext(TEXT_DOMAIN
,
828 "skipping dataset %s: snapshot %s does "
829 "not exist\n"), zhp
->zfs_name
, sd
->tosnap
);
832 (void) fprintf(stderr
, dgettext(TEXT_DOMAIN
,
833 "cannot send %s@%s%s: snapshot %s@%s does not "
834 "exist\n"), sd
->fsname
, sd
->tosnap
, sd
->recursive
?
835 dgettext(TEXT_DOMAIN
, " recursively") : "",
836 zhp
->zfs_name
, sd
->tosnap
);
842 VERIFY(0 == nvlist_alloc(&nvfs
, NV_UNIQUE_NAME
, 0));
843 VERIFY(0 == nvlist_add_string(nvfs
, "name", zhp
->zfs_name
));
844 VERIFY(0 == nvlist_add_uint64(nvfs
, "parentfromsnap",
845 sd
->parent_fromsnap_guid
));
847 if (zhp
->zfs_dmustats
.dds_origin
[0]) {
848 zfs_handle_t
*origin
= zfs_open(zhp
->zfs_hdl
,
849 zhp
->zfs_dmustats
.dds_origin
, ZFS_TYPE_SNAPSHOT
);
850 if (origin
== NULL
) {
854 VERIFY(0 == nvlist_add_uint64(nvfs
, "origin",
855 origin
->zfs_dmustats
.dds_guid
));
858 /* iterate over props */
859 VERIFY(0 == nvlist_alloc(&nv
, NV_UNIQUE_NAME
, 0));
860 send_iterate_prop(zhp
, nv
);
861 VERIFY(0 == nvlist_add_nvlist(nvfs
, "props", nv
));
864 /* iterate over snaps, and set sd->parent_fromsnap_guid */
865 sd
->parent_fromsnap_guid
= 0;
866 VERIFY(0 == nvlist_alloc(&sd
->parent_snaps
, NV_UNIQUE_NAME
, 0));
867 VERIFY(0 == nvlist_alloc(&sd
->snapprops
, NV_UNIQUE_NAME
, 0));
868 (void) zfs_iter_snapshots_sorted(zhp
, send_iterate_snap
, sd
);
869 VERIFY(0 == nvlist_add_nvlist(nvfs
, "snaps", sd
->parent_snaps
));
870 VERIFY(0 == nvlist_add_nvlist(nvfs
, "snapprops", sd
->snapprops
));
871 nvlist_free(sd
->parent_snaps
);
872 nvlist_free(sd
->snapprops
);
874 /* add this fs to nvlist */
875 (void) snprintf(guidstring
, sizeof (guidstring
),
876 "0x%llx", (longlong_t
)guid
);
877 VERIFY(0 == nvlist_add_nvlist(sd
->fss
, guidstring
, nvfs
));
880 /* iterate over children */
882 rv
= zfs_iter_filesystems(zhp
, send_iterate_fs
, sd
);
885 sd
->parent_fromsnap_guid
= parent_fromsnap_guid_save
;
886 sd
->fromsnap_txg
= fromsnap_txg_save
;
887 sd
->tosnap_txg
= tosnap_txg_save
;
894 gather_nvlist(libzfs_handle_t
*hdl
, const char *fsname
, const char *fromsnap
,
895 const char *tosnap
, boolean_t recursive
, boolean_t verbose
,
896 nvlist_t
**nvlp
, avl_tree_t
**avlp
)
899 send_data_t sd
= { 0 };
902 zhp
= zfs_open(hdl
, fsname
, ZFS_TYPE_FILESYSTEM
| ZFS_TYPE_VOLUME
);
904 return (EZFS_BADTYPE
);
906 VERIFY(0 == nvlist_alloc(&sd
.fss
, NV_UNIQUE_NAME
, 0));
908 sd
.fromsnap
= fromsnap
;
910 sd
.recursive
= recursive
;
911 sd
.verbose
= verbose
;
913 if ((error
= send_iterate_fs(zhp
, &sd
)) != 0) {
921 if (avlp
!= NULL
&& (*avlp
= fsavl_create(sd
.fss
)) == NULL
) {
932 * Routines specific to "zfs send"
934 typedef struct send_dump_data
{
935 /* these are all just the short snapname (the part after the @) */
936 const char *fromsnap
;
938 char prevsnap
[ZFS_MAX_DATASET_NAME_LEN
];
939 uint64_t prevsnap_obj
;
940 boolean_t seenfrom
, seento
, replicate
, doall
, fromorigin
;
941 boolean_t verbose
, dryrun
, parsable
, progress
, embed_data
, std_out
;
942 boolean_t large_block
, compress
;
948 snapfilter_cb_t
*filter_cb
;
951 char holdtag
[ZFS_MAX_DATASET_NAME_LEN
];
957 estimate_ioctl(zfs_handle_t
*zhp
, uint64_t fromsnap_obj
,
958 boolean_t fromorigin
, enum lzc_send_flags flags
, uint64_t *sizep
)
960 zfs_cmd_t zc
= {"\0"};
961 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
963 assert(zhp
->zfs_type
== ZFS_TYPE_SNAPSHOT
);
964 assert(fromsnap_obj
== 0 || !fromorigin
);
966 (void) strlcpy(zc
.zc_name
, zhp
->zfs_name
, sizeof (zc
.zc_name
));
967 zc
.zc_obj
= fromorigin
;
968 zc
.zc_sendobj
= zfs_prop_get_int(zhp
, ZFS_PROP_OBJSETID
);
969 zc
.zc_fromobj
= fromsnap_obj
;
970 zc
.zc_guid
= 1; /* estimate flag */
973 if (zfs_ioctl(zhp
->zfs_hdl
, ZFS_IOC_SEND
, &zc
) != 0) {
975 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
976 "warning: cannot estimate space for '%s'"), zhp
->zfs_name
);
980 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
981 "not an earlier snapshot from the same fs"));
982 return (zfs_error(hdl
, EZFS_CROSSTARGET
, errbuf
));
985 if (zfs_dataset_exists(hdl
, zc
.zc_name
,
986 ZFS_TYPE_SNAPSHOT
)) {
987 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
988 "incremental source (@%s) does not exist"),
991 return (zfs_error(hdl
, EZFS_NOENT
, errbuf
));
1004 zfs_error_aux(hdl
, strerror(errno
));
1005 return (zfs_error(hdl
, EZFS_BADBACKUP
, errbuf
));
1008 return (zfs_standard_error(hdl
, errno
, errbuf
));
1012 *sizep
= zc
.zc_objset_type
;
1018 * Dumps a backup of the given snapshot (incremental from fromsnap if it's not
1019 * NULL) to the file descriptor specified by outfd.
1022 dump_ioctl(zfs_handle_t
*zhp
, const char *fromsnap
, uint64_t fromsnap_obj
,
1023 boolean_t fromorigin
, int outfd
, enum lzc_send_flags flags
,
1026 zfs_cmd_t zc
= {"\0"};
1027 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
1030 assert(zhp
->zfs_type
== ZFS_TYPE_SNAPSHOT
);
1031 assert(fromsnap_obj
== 0 || !fromorigin
);
1033 (void) strlcpy(zc
.zc_name
, zhp
->zfs_name
, sizeof (zc
.zc_name
));
1034 zc
.zc_cookie
= outfd
;
1035 zc
.zc_obj
= fromorigin
;
1036 zc
.zc_sendobj
= zfs_prop_get_int(zhp
, ZFS_PROP_OBJSETID
);
1037 zc
.zc_fromobj
= fromsnap_obj
;
1038 zc
.zc_flags
= flags
;
1040 VERIFY(0 == nvlist_alloc(&thisdbg
, NV_UNIQUE_NAME
, 0));
1041 if (fromsnap
&& fromsnap
[0] != '\0') {
1042 VERIFY(0 == nvlist_add_string(thisdbg
,
1043 "fromsnap", fromsnap
));
1046 if (zfs_ioctl(zhp
->zfs_hdl
, ZFS_IOC_SEND
, &zc
) != 0) {
1048 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
1049 "warning: cannot send '%s'"), zhp
->zfs_name
);
1051 VERIFY(0 == nvlist_add_uint64(thisdbg
, "error", errno
));
1053 VERIFY(0 == nvlist_add_nvlist(debugnv
,
1054 zhp
->zfs_name
, thisdbg
));
1056 nvlist_free(thisdbg
);
1060 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1061 "not an earlier snapshot from the same fs"));
1062 return (zfs_error(hdl
, EZFS_CROSSTARGET
, errbuf
));
1065 if (zfs_dataset_exists(hdl
, zc
.zc_name
,
1066 ZFS_TYPE_SNAPSHOT
)) {
1067 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1068 "incremental source (@%s) does not exist"),
1071 return (zfs_error(hdl
, EZFS_NOENT
, errbuf
));
1084 zfs_error_aux(hdl
, strerror(errno
));
1085 return (zfs_error(hdl
, EZFS_BADBACKUP
, errbuf
));
1088 return (zfs_standard_error(hdl
, errno
, errbuf
));
1093 VERIFY(0 == nvlist_add_nvlist(debugnv
, zhp
->zfs_name
, thisdbg
));
1094 nvlist_free(thisdbg
);
1100 gather_holds(zfs_handle_t
*zhp
, send_dump_data_t
*sdd
)
1102 assert(zhp
->zfs_type
== ZFS_TYPE_SNAPSHOT
);
1105 * zfs_send() only sets snapholds for sends that need them,
1106 * e.g. replication and doall.
1108 if (sdd
->snapholds
== NULL
)
1111 fnvlist_add_string(sdd
->snapholds
, zhp
->zfs_name
, sdd
->holdtag
);
1115 send_progress_thread(void *arg
)
1117 progress_arg_t
*pa
= arg
;
1118 zfs_cmd_t zc
= {"\0"};
1119 zfs_handle_t
*zhp
= pa
->pa_zhp
;
1120 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
1121 unsigned long long bytes
;
1126 (void) strlcpy(zc
.zc_name
, zhp
->zfs_name
, sizeof (zc
.zc_name
));
1128 if (!pa
->pa_parsable
)
1129 (void) fprintf(stderr
, "TIME SENT SNAPSHOT\n");
1132 * Print the progress from ZFS_IOC_SEND_PROGRESS every second.
1137 zc
.zc_cookie
= pa
->pa_fd
;
1138 if (zfs_ioctl(hdl
, ZFS_IOC_SEND_PROGRESS
, &zc
) != 0)
1139 return ((void *)-1);
1143 bytes
= zc
.zc_cookie
;
1145 if (pa
->pa_parsable
) {
1146 (void) fprintf(stderr
, "%02d:%02d:%02d\t%llu\t%s\n",
1147 tm
->tm_hour
, tm
->tm_min
, tm
->tm_sec
,
1148 bytes
, zhp
->zfs_name
);
1150 zfs_nicenum(bytes
, buf
, sizeof (buf
));
1151 (void) fprintf(stderr
, "%02d:%02d:%02d %5s %s\n",
1152 tm
->tm_hour
, tm
->tm_min
, tm
->tm_sec
,
1153 buf
, zhp
->zfs_name
);
1159 send_print_verbose(FILE *fout
, const char *tosnap
, const char *fromsnap
,
1160 uint64_t size
, boolean_t parsable
)
1163 if (fromsnap
!= NULL
) {
1164 (void) fprintf(fout
, "incremental\t%s\t%s",
1167 (void) fprintf(fout
, "full\t%s",
1171 if (fromsnap
!= NULL
) {
1172 if (strchr(fromsnap
, '@') == NULL
&&
1173 strchr(fromsnap
, '#') == NULL
) {
1174 (void) fprintf(fout
, dgettext(TEXT_DOMAIN
,
1175 "send from @%s to %s"),
1178 (void) fprintf(fout
, dgettext(TEXT_DOMAIN
,
1179 "send from %s to %s"),
1183 (void) fprintf(fout
, dgettext(TEXT_DOMAIN
,
1191 (void) fprintf(fout
, "\t%llu",
1195 zfs_nicenum(size
, buf
, sizeof (buf
));
1196 (void) fprintf(fout
, dgettext(TEXT_DOMAIN
,
1197 " estimated size is %s"), buf
);
1200 (void) fprintf(fout
, "\n");
1204 dump_snapshot(zfs_handle_t
*zhp
, void *arg
)
1206 send_dump_data_t
*sdd
= arg
;
1207 progress_arg_t pa
= { 0 };
1210 enum lzc_send_flags flags
= 0;
1212 boolean_t isfromsnap
, istosnap
, fromorigin
;
1213 boolean_t exclude
= B_FALSE
;
1214 FILE *fout
= sdd
->std_out
? stdout
: stderr
;
1217 thissnap
= strchr(zhp
->zfs_name
, '@') + 1;
1218 isfromsnap
= (sdd
->fromsnap
!= NULL
&&
1219 strcmp(sdd
->fromsnap
, thissnap
) == 0);
1221 if (!sdd
->seenfrom
&& isfromsnap
) {
1222 gather_holds(zhp
, sdd
);
1223 sdd
->seenfrom
= B_TRUE
;
1224 (void) strlcpy(sdd
->prevsnap
, thissnap
,
1225 sizeof (sdd
->prevsnap
));
1226 sdd
->prevsnap_obj
= zfs_prop_get_int(zhp
, ZFS_PROP_OBJSETID
);
1231 if (sdd
->seento
|| !sdd
->seenfrom
) {
1236 istosnap
= (strcmp(sdd
->tosnap
, thissnap
) == 0);
1238 sdd
->seento
= B_TRUE
;
1240 if (sdd
->large_block
)
1241 flags
|= LZC_SEND_FLAG_LARGE_BLOCK
;
1242 if (sdd
->embed_data
)
1243 flags
|= LZC_SEND_FLAG_EMBED_DATA
;
1245 flags
|= LZC_SEND_FLAG_COMPRESS
;
1247 if (!sdd
->doall
&& !isfromsnap
&& !istosnap
) {
1248 if (sdd
->replicate
) {
1250 nvlist_t
*snapprops
;
1252 * Filter out all intermediate snapshots except origin
1253 * snapshots needed to replicate clones.
1255 nvlist_t
*nvfs
= fsavl_find(sdd
->fsavl
,
1256 zhp
->zfs_dmustats
.dds_guid
, &snapname
);
1258 VERIFY(0 == nvlist_lookup_nvlist(nvfs
,
1259 "snapprops", &snapprops
));
1260 VERIFY(0 == nvlist_lookup_nvlist(snapprops
,
1261 thissnap
, &snapprops
));
1262 exclude
= !nvlist_exists(snapprops
, "is_clone_origin");
1269 * If a filter function exists, call it to determine whether
1270 * this snapshot will be sent.
1272 if (exclude
|| (sdd
->filter_cb
!= NULL
&&
1273 sdd
->filter_cb(zhp
, sdd
->filter_cb_arg
) == B_FALSE
)) {
1275 * This snapshot is filtered out. Don't send it, and don't
1276 * set prevsnap_obj, so it will be as if this snapshot didn't
1277 * exist, and the next accepted snapshot will be sent as
1278 * an incremental from the last accepted one, or as the
1279 * first (and full) snapshot in the case of a replication,
1280 * non-incremental send.
1286 gather_holds(zhp
, sdd
);
1287 fromorigin
= sdd
->prevsnap
[0] == '\0' &&
1288 (sdd
->fromorigin
|| sdd
->replicate
);
1292 (void) estimate_ioctl(zhp
, sdd
->prevsnap_obj
,
1293 fromorigin
, flags
, &size
);
1295 send_print_verbose(fout
, zhp
->zfs_name
,
1296 sdd
->prevsnap
[0] ? sdd
->prevsnap
: NULL
,
1297 size
, sdd
->parsable
);
1303 * If progress reporting is requested, spawn a new thread to
1304 * poll ZFS_IOC_SEND_PROGRESS at a regular interval.
1306 if (sdd
->progress
) {
1308 pa
.pa_fd
= sdd
->outfd
;
1309 pa
.pa_parsable
= sdd
->parsable
;
1311 if ((err
= pthread_create(&tid
, NULL
,
1312 send_progress_thread
, &pa
))) {
1318 err
= dump_ioctl(zhp
, sdd
->prevsnap
, sdd
->prevsnap_obj
,
1319 fromorigin
, sdd
->outfd
, flags
, sdd
->debugnv
);
1321 if (sdd
->progress
) {
1322 (void) pthread_cancel(tid
);
1323 (void) pthread_join(tid
, NULL
);
1327 (void) strcpy(sdd
->prevsnap
, thissnap
);
1328 sdd
->prevsnap_obj
= zfs_prop_get_int(zhp
, ZFS_PROP_OBJSETID
);
1334 dump_filesystem(zfs_handle_t
*zhp
, void *arg
)
1337 send_dump_data_t
*sdd
= arg
;
1338 boolean_t missingfrom
= B_FALSE
;
1339 zfs_cmd_t zc
= {"\0"};
1341 (void) snprintf(zc
.zc_name
, sizeof (zc
.zc_name
), "%s@%s",
1342 zhp
->zfs_name
, sdd
->tosnap
);
1343 if (ioctl(zhp
->zfs_hdl
->libzfs_fd
, ZFS_IOC_OBJSET_STATS
, &zc
) != 0) {
1344 (void) fprintf(stderr
, dgettext(TEXT_DOMAIN
,
1345 "WARNING: could not send %s@%s: does not exist\n"),
1346 zhp
->zfs_name
, sdd
->tosnap
);
1351 if (sdd
->replicate
&& sdd
->fromsnap
) {
1353 * If this fs does not have fromsnap, and we're doing
1354 * recursive, we need to send a full stream from the
1355 * beginning (or an incremental from the origin if this
1356 * is a clone). If we're doing non-recursive, then let
1357 * them get the error.
1359 (void) snprintf(zc
.zc_name
, sizeof (zc
.zc_name
), "%s@%s",
1360 zhp
->zfs_name
, sdd
->fromsnap
);
1361 if (ioctl(zhp
->zfs_hdl
->libzfs_fd
,
1362 ZFS_IOC_OBJSET_STATS
, &zc
) != 0) {
1363 missingfrom
= B_TRUE
;
1367 sdd
->seenfrom
= sdd
->seento
= sdd
->prevsnap
[0] = 0;
1368 sdd
->prevsnap_obj
= 0;
1369 if (sdd
->fromsnap
== NULL
|| missingfrom
)
1370 sdd
->seenfrom
= B_TRUE
;
1372 rv
= zfs_iter_snapshots_sorted(zhp
, dump_snapshot
, arg
);
1373 if (!sdd
->seenfrom
) {
1374 (void) fprintf(stderr
, dgettext(TEXT_DOMAIN
,
1375 "WARNING: could not send %s@%s:\n"
1376 "incremental source (%s@%s) does not exist\n"),
1377 zhp
->zfs_name
, sdd
->tosnap
,
1378 zhp
->zfs_name
, sdd
->fromsnap
);
1380 } else if (!sdd
->seento
) {
1381 if (sdd
->fromsnap
) {
1382 (void) fprintf(stderr
, dgettext(TEXT_DOMAIN
,
1383 "WARNING: could not send %s@%s:\n"
1384 "incremental source (%s@%s) "
1385 "is not earlier than it\n"),
1386 zhp
->zfs_name
, sdd
->tosnap
,
1387 zhp
->zfs_name
, sdd
->fromsnap
);
1389 (void) fprintf(stderr
, dgettext(TEXT_DOMAIN
,
1391 "could not send %s@%s: does not exist\n"),
1392 zhp
->zfs_name
, sdd
->tosnap
);
1401 dump_filesystems(zfs_handle_t
*rzhp
, void *arg
)
1403 send_dump_data_t
*sdd
= arg
;
1405 boolean_t needagain
, progress
;
1407 if (!sdd
->replicate
)
1408 return (dump_filesystem(rzhp
, sdd
));
1410 /* Mark the clone origin snapshots. */
1411 for (fspair
= nvlist_next_nvpair(sdd
->fss
, NULL
); fspair
;
1412 fspair
= nvlist_next_nvpair(sdd
->fss
, fspair
)) {
1414 uint64_t origin_guid
= 0;
1416 VERIFY(0 == nvpair_value_nvlist(fspair
, &nvfs
));
1417 (void) nvlist_lookup_uint64(nvfs
, "origin", &origin_guid
);
1418 if (origin_guid
!= 0) {
1420 nvlist_t
*origin_nv
= fsavl_find(sdd
->fsavl
,
1421 origin_guid
, &snapname
);
1422 if (origin_nv
!= NULL
) {
1423 nvlist_t
*snapprops
;
1424 VERIFY(0 == nvlist_lookup_nvlist(origin_nv
,
1425 "snapprops", &snapprops
));
1426 VERIFY(0 == nvlist_lookup_nvlist(snapprops
,
1427 snapname
, &snapprops
));
1428 VERIFY(0 == nvlist_add_boolean(
1429 snapprops
, "is_clone_origin"));
1434 needagain
= progress
= B_FALSE
;
1435 for (fspair
= nvlist_next_nvpair(sdd
->fss
, NULL
); fspair
;
1436 fspair
= nvlist_next_nvpair(sdd
->fss
, fspair
)) {
1437 nvlist_t
*fslist
, *parent_nv
;
1441 uint64_t origin_guid
= 0;
1442 uint64_t parent_guid
= 0;
1444 VERIFY(nvpair_value_nvlist(fspair
, &fslist
) == 0);
1445 if (nvlist_lookup_boolean(fslist
, "sent") == 0)
1448 VERIFY(nvlist_lookup_string(fslist
, "name", &fsname
) == 0);
1449 (void) nvlist_lookup_uint64(fslist
, "origin", &origin_guid
);
1450 (void) nvlist_lookup_uint64(fslist
, "parentfromsnap",
1453 if (parent_guid
!= 0) {
1454 parent_nv
= fsavl_find(sdd
->fsavl
, parent_guid
, NULL
);
1455 if (!nvlist_exists(parent_nv
, "sent")) {
1456 /* parent has not been sent; skip this one */
1462 if (origin_guid
!= 0) {
1463 nvlist_t
*origin_nv
= fsavl_find(sdd
->fsavl
,
1465 if (origin_nv
!= NULL
&&
1466 !nvlist_exists(origin_nv
, "sent")) {
1468 * origin has not been sent yet;
1476 zhp
= zfs_open(rzhp
->zfs_hdl
, fsname
, ZFS_TYPE_DATASET
);
1479 err
= dump_filesystem(zhp
, sdd
);
1480 VERIFY(nvlist_add_boolean(fslist
, "sent") == 0);
1491 /* clean out the sent flags in case we reuse this fss */
1492 for (fspair
= nvlist_next_nvpair(sdd
->fss
, NULL
); fspair
;
1493 fspair
= nvlist_next_nvpair(sdd
->fss
, fspair
)) {
1496 VERIFY(nvpair_value_nvlist(fspair
, &fslist
) == 0);
1497 (void) nvlist_remove_all(fslist
, "sent");
1504 zfs_send_resume_token_to_nvlist(libzfs_handle_t
*hdl
, const char *token
)
1506 unsigned int version
;
1508 unsigned long long checksum
, packed_len
;
1511 * Decode token header, which is:
1512 * <token version>-<checksum of payload>-<uncompressed payload length>
1513 * Note that the only supported token version is 1.
1515 nread
= sscanf(token
, "%u-%llx-%llx-",
1516 &version
, &checksum
, &packed_len
);
1518 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1519 "resume token is corrupt (invalid format)"));
1523 if (version
!= ZFS_SEND_RESUME_TOKEN_VERSION
) {
1524 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1525 "resume token is corrupt (invalid version %u)"),
1530 /* convert hexadecimal representation to binary */
1531 token
= strrchr(token
, '-') + 1;
1532 int len
= strlen(token
) / 2;
1533 unsigned char *compressed
= zfs_alloc(hdl
, len
);
1534 for (i
= 0; i
< len
; i
++) {
1535 nread
= sscanf(token
+ i
* 2, "%2hhx", compressed
+ i
);
1538 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1539 "resume token is corrupt "
1540 "(payload is not hex-encoded)"));
1545 /* verify checksum */
1547 fletcher_4_native_varsize(compressed
, len
, &cksum
);
1548 if (cksum
.zc_word
[0] != checksum
) {
1550 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1551 "resume token is corrupt (incorrect checksum)"));
1556 void *packed
= zfs_alloc(hdl
, packed_len
);
1557 uLongf packed_len_long
= packed_len
;
1558 if (uncompress(packed
, &packed_len_long
, compressed
, len
) != Z_OK
||
1559 packed_len_long
!= packed_len
) {
1562 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1563 "resume token is corrupt (decompression failed)"));
1569 int error
= nvlist_unpack(packed
, packed_len
, &nv
, KM_SLEEP
);
1573 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1574 "resume token is corrupt (nvlist_unpack failed)"));
1581 zfs_send_resume(libzfs_handle_t
*hdl
, sendflags_t
*flags
, int outfd
,
1582 const char *resume_token
)
1586 char *fromname
= NULL
;
1587 uint64_t resumeobj
, resumeoff
, toguid
, fromguid
, bytes
;
1590 char name
[ZFS_MAX_DATASET_NAME_LEN
];
1591 enum lzc_send_flags lzc_flags
= 0;
1593 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
1594 "cannot resume send"));
1596 nvlist_t
*resume_nvl
=
1597 zfs_send_resume_token_to_nvlist(hdl
, resume_token
);
1598 if (resume_nvl
== NULL
) {
1600 * zfs_error_aux has already been set by
1601 * zfs_send_resume_token_to_nvlist
1603 return (zfs_error(hdl
, EZFS_FAULT
, errbuf
));
1605 if (flags
->verbose
) {
1606 (void) fprintf(stderr
, dgettext(TEXT_DOMAIN
,
1607 "resume token contents:\n"));
1608 nvlist_print(stderr
, resume_nvl
);
1611 if (nvlist_lookup_string(resume_nvl
, "toname", &toname
) != 0 ||
1612 nvlist_lookup_uint64(resume_nvl
, "object", &resumeobj
) != 0 ||
1613 nvlist_lookup_uint64(resume_nvl
, "offset", &resumeoff
) != 0 ||
1614 nvlist_lookup_uint64(resume_nvl
, "bytes", &bytes
) != 0 ||
1615 nvlist_lookup_uint64(resume_nvl
, "toguid", &toguid
) != 0) {
1616 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1617 "resume token is corrupt"));
1618 return (zfs_error(hdl
, EZFS_FAULT
, errbuf
));
1621 (void) nvlist_lookup_uint64(resume_nvl
, "fromguid", &fromguid
);
1623 if (flags
->largeblock
|| nvlist_exists(resume_nvl
, "largeblockok"))
1624 lzc_flags
|= LZC_SEND_FLAG_LARGE_BLOCK
;
1625 if (flags
->embed_data
|| nvlist_exists(resume_nvl
, "embedok"))
1626 lzc_flags
|= LZC_SEND_FLAG_EMBED_DATA
;
1627 if (flags
->compress
|| nvlist_exists(resume_nvl
, "compressok"))
1628 lzc_flags
|= LZC_SEND_FLAG_COMPRESS
;
1630 if (guid_to_name(hdl
, toname
, toguid
, B_FALSE
, name
) != 0) {
1631 if (zfs_dataset_exists(hdl
, toname
, ZFS_TYPE_DATASET
)) {
1632 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1633 "'%s' is no longer the same snapshot used in "
1634 "the initial send"), toname
);
1636 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1637 "'%s' used in the initial send no longer exists"),
1640 return (zfs_error(hdl
, EZFS_BADPATH
, errbuf
));
1642 zhp
= zfs_open(hdl
, name
, ZFS_TYPE_DATASET
);
1644 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1645 "unable to access '%s'"), name
);
1646 return (zfs_error(hdl
, EZFS_BADPATH
, errbuf
));
1649 if (fromguid
!= 0) {
1650 if (guid_to_name(hdl
, toname
, fromguid
, B_TRUE
, name
) != 0) {
1651 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1652 "incremental source %#llx no longer exists"),
1653 (longlong_t
)fromguid
);
1654 return (zfs_error(hdl
, EZFS_BADPATH
, errbuf
));
1659 if (flags
->verbose
) {
1661 error
= lzc_send_space(zhp
->zfs_name
, fromname
,
1664 size
= MAX(0, (int64_t)(size
- bytes
));
1665 send_print_verbose(stderr
, zhp
->zfs_name
, fromname
,
1666 size
, flags
->parsable
);
1669 if (!flags
->dryrun
) {
1670 progress_arg_t pa
= { 0 };
1673 * If progress reporting is requested, spawn a new thread to
1674 * poll ZFS_IOC_SEND_PROGRESS at a regular interval.
1676 if (flags
->progress
) {
1679 pa
.pa_parsable
= flags
->parsable
;
1681 error
= pthread_create(&tid
, NULL
,
1682 send_progress_thread
, &pa
);
1689 error
= lzc_send_resume(zhp
->zfs_name
, fromname
, outfd
,
1690 lzc_flags
, resumeobj
, resumeoff
);
1692 if (flags
->progress
) {
1693 (void) pthread_cancel(tid
);
1694 (void) pthread_join(tid
, NULL
);
1698 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
1699 "warning: cannot send '%s'"), zhp
->zfs_name
);
1719 zfs_error_aux(hdl
, strerror(errno
));
1720 return (zfs_error(hdl
, EZFS_BADBACKUP
, errbuf
));
1723 return (zfs_standard_error(hdl
, errno
, errbuf
));
1734 * Generate a send stream for the dataset identified by the argument zhp.
1736 * The content of the send stream is the snapshot identified by
1737 * 'tosnap'. Incremental streams are requested in two ways:
1738 * - from the snapshot identified by "fromsnap" (if non-null) or
1739 * - from the origin of the dataset identified by zhp, which must
1740 * be a clone. In this case, "fromsnap" is null and "fromorigin"
1743 * The send stream is recursive (i.e. dumps a hierarchy of snapshots) and
1744 * uses a special header (with a hdrtype field of DMU_COMPOUNDSTREAM)
1745 * if "replicate" is set. If "doall" is set, dump all the intermediate
1746 * snapshots. The DMU_COMPOUNDSTREAM header is used in the "doall"
1747 * case too. If "props" is set, send properties.
1750 zfs_send(zfs_handle_t
*zhp
, const char *fromsnap
, const char *tosnap
,
1751 sendflags_t
*flags
, int outfd
, snapfilter_cb_t filter_func
,
1752 void *cb_arg
, nvlist_t
**debugnvp
)
1755 send_dump_data_t sdd
= { 0 };
1757 nvlist_t
*fss
= NULL
;
1758 avl_tree_t
*fsavl
= NULL
;
1759 static uint64_t holdseq
;
1763 dedup_arg_t dda
= { 0 };
1764 int featureflags
= 0;
1767 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
1768 "cannot send '%s'"), zhp
->zfs_name
);
1770 if (fromsnap
&& fromsnap
[0] == '\0') {
1771 zfs_error_aux(zhp
->zfs_hdl
, dgettext(TEXT_DOMAIN
,
1772 "zero-length incremental source"));
1773 return (zfs_error(zhp
->zfs_hdl
, EZFS_NOENT
, errbuf
));
1776 if (zhp
->zfs_type
== ZFS_TYPE_FILESYSTEM
) {
1778 version
= zfs_prop_get_int(zhp
, ZFS_PROP_VERSION
);
1779 if (version
>= ZPL_VERSION_SA
) {
1780 featureflags
|= DMU_BACKUP_FEATURE_SA_SPILL
;
1784 if (flags
->dedup
&& !flags
->dryrun
) {
1785 featureflags
|= (DMU_BACKUP_FEATURE_DEDUP
|
1786 DMU_BACKUP_FEATURE_DEDUPPROPS
);
1787 if ((err
= socketpair(AF_UNIX
, SOCK_STREAM
, 0, pipefd
))) {
1788 zfs_error_aux(zhp
->zfs_hdl
, strerror(errno
));
1789 return (zfs_error(zhp
->zfs_hdl
, EZFS_PIPEFAILED
,
1792 dda
.outputfd
= outfd
;
1793 dda
.inputfd
= pipefd
[1];
1794 dda
.dedup_hdl
= zhp
->zfs_hdl
;
1795 if ((err
= pthread_create(&tid
, NULL
, cksummer
, &dda
))) {
1796 (void) close(pipefd
[0]);
1797 (void) close(pipefd
[1]);
1798 zfs_error_aux(zhp
->zfs_hdl
, strerror(errno
));
1799 return (zfs_error(zhp
->zfs_hdl
,
1800 EZFS_THREADCREATEFAILED
, errbuf
));
1804 if (flags
->replicate
|| flags
->doall
|| flags
->props
) {
1805 dmu_replay_record_t drr
= { 0 };
1806 char *packbuf
= NULL
;
1810 ZIO_SET_CHECKSUM(&zc
, 0, 0, 0, 0);
1812 if (flags
->replicate
|| flags
->props
) {
1815 VERIFY(0 == nvlist_alloc(&hdrnv
, NV_UNIQUE_NAME
, 0));
1817 VERIFY(0 == nvlist_add_string(hdrnv
,
1818 "fromsnap", fromsnap
));
1820 VERIFY(0 == nvlist_add_string(hdrnv
, "tosnap", tosnap
));
1821 if (!flags
->replicate
) {
1822 VERIFY(0 == nvlist_add_boolean(hdrnv
,
1826 err
= gather_nvlist(zhp
->zfs_hdl
, zhp
->zfs_name
,
1827 fromsnap
, tosnap
, flags
->replicate
, flags
->verbose
,
1831 VERIFY(0 == nvlist_add_nvlist(hdrnv
, "fss", fss
));
1832 err
= nvlist_pack(hdrnv
, &packbuf
, &buflen
,
1842 if (!flags
->dryrun
) {
1843 /* write first begin record */
1844 drr
.drr_type
= DRR_BEGIN
;
1845 drr
.drr_u
.drr_begin
.drr_magic
= DMU_BACKUP_MAGIC
;
1846 DMU_SET_STREAM_HDRTYPE(drr
.drr_u
.drr_begin
.
1847 drr_versioninfo
, DMU_COMPOUNDSTREAM
);
1848 DMU_SET_FEATUREFLAGS(drr
.drr_u
.drr_begin
.
1849 drr_versioninfo
, featureflags
);
1850 (void) snprintf(drr
.drr_u
.drr_begin
.drr_toname
,
1851 sizeof (drr
.drr_u
.drr_begin
.drr_toname
),
1852 "%s@%s", zhp
->zfs_name
, tosnap
);
1853 drr
.drr_payloadlen
= buflen
;
1855 err
= dump_record(&drr
, packbuf
, buflen
, &zc
, outfd
);
1860 /* write end record */
1861 bzero(&drr
, sizeof (drr
));
1862 drr
.drr_type
= DRR_END
;
1863 drr
.drr_u
.drr_end
.drr_checksum
= zc
;
1864 err
= write(outfd
, &drr
, sizeof (drr
));
1874 /* dump each stream */
1875 sdd
.fromsnap
= fromsnap
;
1876 sdd
.tosnap
= tosnap
;
1878 sdd
.outfd
= pipefd
[0];
1881 sdd
.replicate
= flags
->replicate
;
1882 sdd
.doall
= flags
->doall
;
1883 sdd
.fromorigin
= flags
->fromorigin
;
1886 sdd
.verbose
= flags
->verbose
;
1887 sdd
.parsable
= flags
->parsable
;
1888 sdd
.progress
= flags
->progress
;
1889 sdd
.dryrun
= flags
->dryrun
;
1890 sdd
.large_block
= flags
->largeblock
;
1891 sdd
.embed_data
= flags
->embed_data
;
1892 sdd
.compress
= flags
->compress
;
1893 sdd
.filter_cb
= filter_func
;
1894 sdd
.filter_cb_arg
= cb_arg
;
1896 sdd
.debugnv
= *debugnvp
;
1897 if (sdd
.verbose
&& sdd
.dryrun
)
1898 sdd
.std_out
= B_TRUE
;
1899 fout
= sdd
.std_out
? stdout
: stderr
;
1902 * Some flags require that we place user holds on the datasets that are
1903 * being sent so they don't get destroyed during the send. We can skip
1904 * this step if the pool is imported read-only since the datasets cannot
1907 if (!flags
->dryrun
&& !zpool_get_prop_int(zfs_get_pool_handle(zhp
),
1908 ZPOOL_PROP_READONLY
, NULL
) &&
1909 zfs_spa_version(zhp
, &spa_version
) == 0 &&
1910 spa_version
>= SPA_VERSION_USERREFS
&&
1911 (flags
->doall
|| flags
->replicate
)) {
1913 (void) snprintf(sdd
.holdtag
, sizeof (sdd
.holdtag
),
1914 ".send-%d-%llu", getpid(), (u_longlong_t
)holdseq
);
1915 sdd
.cleanup_fd
= open(ZFS_DEV
, O_RDWR
);
1916 if (sdd
.cleanup_fd
< 0) {
1920 sdd
.snapholds
= fnvlist_alloc();
1922 sdd
.cleanup_fd
= -1;
1923 sdd
.snapholds
= NULL
;
1925 if (flags
->verbose
|| sdd
.snapholds
!= NULL
) {
1927 * Do a verbose no-op dry run to get all the verbose output
1928 * or to gather snapshot hold's before generating any data,
1929 * then do a non-verbose real run to generate the streams.
1931 sdd
.dryrun
= B_TRUE
;
1932 err
= dump_filesystems(zhp
, &sdd
);
1937 if (flags
->verbose
) {
1938 if (flags
->parsable
) {
1939 (void) fprintf(fout
, "size\t%llu\n",
1940 (longlong_t
)sdd
.size
);
1943 zfs_nicenum(sdd
.size
, buf
, sizeof (buf
));
1944 (void) fprintf(fout
, dgettext(TEXT_DOMAIN
,
1945 "total estimated size is %s\n"), buf
);
1949 /* Ensure no snaps found is treated as an error. */
1955 /* Skip the second run if dryrun was requested. */
1959 if (sdd
.snapholds
!= NULL
) {
1960 err
= zfs_hold_nvl(zhp
, sdd
.cleanup_fd
, sdd
.snapholds
);
1964 fnvlist_free(sdd
.snapholds
);
1965 sdd
.snapholds
= NULL
;
1968 sdd
.dryrun
= B_FALSE
;
1969 sdd
.verbose
= B_FALSE
;
1972 err
= dump_filesystems(zhp
, &sdd
);
1973 fsavl_destroy(fsavl
);
1976 /* Ensure no snaps found is treated as an error. */
1977 if (err
== 0 && !sdd
.seento
)
1982 (void) pthread_cancel(tid
);
1983 (void) close(pipefd
[0]);
1984 (void) pthread_join(tid
, NULL
);
1987 if (sdd
.cleanup_fd
!= -1) {
1988 VERIFY(0 == close(sdd
.cleanup_fd
));
1989 sdd
.cleanup_fd
= -1;
1992 if (!flags
->dryrun
&& (flags
->replicate
|| flags
->doall
||
1995 * write final end record. NB: want to do this even if
1996 * there was some error, because it might not be totally
1999 dmu_replay_record_t drr
= { 0 };
2000 drr
.drr_type
= DRR_END
;
2001 if (write(outfd
, &drr
, sizeof (drr
)) == -1) {
2002 return (zfs_standard_error(zhp
->zfs_hdl
,
2007 return (err
|| sdd
.err
);
2010 err
= zfs_standard_error(zhp
->zfs_hdl
, err
, errbuf
);
2012 fsavl_destroy(fsavl
);
2014 fnvlist_free(sdd
.snapholds
);
2016 if (sdd
.cleanup_fd
!= -1)
2017 VERIFY(0 == close(sdd
.cleanup_fd
));
2019 (void) pthread_cancel(tid
);
2020 (void) close(pipefd
[0]);
2021 (void) pthread_join(tid
, NULL
);
2027 zfs_send_one(zfs_handle_t
*zhp
, const char *from
, int fd
,
2028 enum lzc_send_flags flags
)
2031 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
2034 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
2035 "warning: cannot send '%s'"), zhp
->zfs_name
);
2037 err
= lzc_send(zhp
->zfs_name
, from
, fd
, flags
);
2041 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
2042 "not an earlier snapshot from the same fs"));
2043 return (zfs_error(hdl
, EZFS_CROSSTARGET
, errbuf
));
2047 if (lzc_exists(zhp
->zfs_name
)) {
2048 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
2049 "incremental source (%s) does not exist"),
2052 return (zfs_error(hdl
, EZFS_NOENT
, errbuf
));
2055 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
2056 "target is busy; if a filesystem, "
2057 "it must not be mounted"));
2058 return (zfs_error(hdl
, EZFS_BUSY
, errbuf
));
2071 zfs_error_aux(hdl
, strerror(errno
));
2072 return (zfs_error(hdl
, EZFS_BADBACKUP
, errbuf
));
2075 return (zfs_standard_error(hdl
, errno
, errbuf
));
2082 * Routines specific to "zfs recv"
2086 recv_read(libzfs_handle_t
*hdl
, int fd
, void *buf
, int ilen
,
2087 boolean_t byteswap
, zio_cksum_t
*zc
)
2093 assert(ilen
<= SPA_MAXBLOCKSIZE
);
2096 rv
= read(fd
, cp
, len
);
2101 if (rv
< 0 || len
!= 0) {
2102 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
2103 "failed to read from stream"));
2104 return (zfs_error(hdl
, EZFS_BADSTREAM
, dgettext(TEXT_DOMAIN
,
2105 "cannot receive")));
2110 fletcher_4_incremental_byteswap(buf
, ilen
, zc
);
2112 fletcher_4_incremental_native(buf
, ilen
, zc
);
2118 recv_read_nvlist(libzfs_handle_t
*hdl
, int fd
, int len
, nvlist_t
**nvp
,
2119 boolean_t byteswap
, zio_cksum_t
*zc
)
2124 buf
= zfs_alloc(hdl
, len
);
2128 err
= recv_read(hdl
, fd
, buf
, len
, byteswap
, zc
);
2134 err
= nvlist_unpack(buf
, len
, nvp
, 0);
2137 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
, "invalid "
2138 "stream (malformed nvlist)"));
2145 recv_rename(libzfs_handle_t
*hdl
, const char *name
, const char *tryname
,
2146 int baselen
, char *newname
, recvflags_t
*flags
)
2149 zfs_cmd_t zc
= {"\0"};
2151 prop_changelist_t
*clp
;
2154 zhp
= zfs_open(hdl
, name
, ZFS_TYPE_DATASET
);
2157 clp
= changelist_gather(zhp
, ZFS_PROP_NAME
, 0,
2158 flags
->force
? MS_FORCE
: 0);
2162 err
= changelist_prefix(clp
);
2166 zc
.zc_objset_type
= DMU_OST_ZFS
;
2167 (void) strlcpy(zc
.zc_name
, name
, sizeof (zc
.zc_name
));
2170 (void) strcpy(newname
, tryname
);
2172 (void) strlcpy(zc
.zc_value
, tryname
, sizeof (zc
.zc_value
));
2174 if (flags
->verbose
) {
2175 (void) printf("attempting rename %s to %s\n",
2176 zc
.zc_name
, zc
.zc_value
);
2178 err
= ioctl(hdl
->libzfs_fd
, ZFS_IOC_RENAME
, &zc
);
2180 changelist_rename(clp
, name
, tryname
);
2185 if (err
!= 0 && strncmp(name
+ baselen
, "recv-", 5) != 0) {
2188 (void) snprintf(newname
, ZFS_MAX_DATASET_NAME_LEN
,
2189 "%.*srecv-%u-%u", baselen
, name
, getpid(), seq
);
2190 (void) strlcpy(zc
.zc_value
, newname
, sizeof (zc
.zc_value
));
2192 if (flags
->verbose
) {
2193 (void) printf("failed - trying rename %s to %s\n",
2194 zc
.zc_name
, zc
.zc_value
);
2196 err
= ioctl(hdl
->libzfs_fd
, ZFS_IOC_RENAME
, &zc
);
2198 changelist_rename(clp
, name
, newname
);
2199 if (err
&& flags
->verbose
) {
2200 (void) printf("failed (%u) - "
2201 "will try again on next pass\n", errno
);
2204 } else if (flags
->verbose
) {
2206 (void) printf("success\n");
2208 (void) printf("failed (%u)\n", errno
);
2211 (void) changelist_postfix(clp
);
2212 changelist_free(clp
);
2218 recv_destroy(libzfs_handle_t
*hdl
, const char *name
, int baselen
,
2219 char *newname
, recvflags_t
*flags
)
2221 zfs_cmd_t zc
= {"\0"};
2223 prop_changelist_t
*clp
;
2225 boolean_t defer
= B_FALSE
;
2228 zhp
= zfs_open(hdl
, name
, ZFS_TYPE_DATASET
);
2231 clp
= changelist_gather(zhp
, ZFS_PROP_NAME
, 0,
2232 flags
->force
? MS_FORCE
: 0);
2233 if (zfs_get_type(zhp
) == ZFS_TYPE_SNAPSHOT
&&
2234 zfs_spa_version(zhp
, &spa_version
) == 0 &&
2235 spa_version
>= SPA_VERSION_USERREFS
)
2240 err
= changelist_prefix(clp
);
2244 zc
.zc_objset_type
= DMU_OST_ZFS
;
2245 zc
.zc_defer_destroy
= defer
;
2246 (void) strlcpy(zc
.zc_name
, name
, sizeof (zc
.zc_name
));
2249 (void) printf("attempting destroy %s\n", zc
.zc_name
);
2250 err
= ioctl(hdl
->libzfs_fd
, ZFS_IOC_DESTROY
, &zc
);
2253 (void) printf("success\n");
2254 changelist_remove(clp
, zc
.zc_name
);
2257 (void) changelist_postfix(clp
);
2258 changelist_free(clp
);
2261 * Deferred destroy might destroy the snapshot or only mark it to be
2262 * destroyed later, and it returns success in either case.
2264 if (err
!= 0 || (defer
&& zfs_dataset_exists(hdl
, name
,
2265 ZFS_TYPE_SNAPSHOT
))) {
2266 err
= recv_rename(hdl
, name
, NULL
, baselen
, newname
, flags
);
2272 typedef struct guid_to_name_data
{
2274 boolean_t bookmark_ok
;
2277 } guid_to_name_data_t
;
2280 guid_to_name_cb(zfs_handle_t
*zhp
, void *arg
)
2282 guid_to_name_data_t
*gtnd
= arg
;
2286 if (gtnd
->skip
!= NULL
&&
2287 (slash
= strrchr(zhp
->zfs_name
, '/')) != NULL
&&
2288 strcmp(slash
+ 1, gtnd
->skip
) == 0) {
2293 if (zfs_prop_get_int(zhp
, ZFS_PROP_GUID
) == gtnd
->guid
) {
2294 (void) strcpy(gtnd
->name
, zhp
->zfs_name
);
2299 err
= zfs_iter_children(zhp
, guid_to_name_cb
, gtnd
);
2300 if (err
!= EEXIST
&& gtnd
->bookmark_ok
)
2301 err
= zfs_iter_bookmarks(zhp
, guid_to_name_cb
, gtnd
);
2307 * Attempt to find the local dataset associated with this guid. In the case of
2308 * multiple matches, we attempt to find the "best" match by searching
2309 * progressively larger portions of the hierarchy. This allows one to send a
2310 * tree of datasets individually and guarantee that we will find the source
2311 * guid within that hierarchy, even if there are multiple matches elsewhere.
2314 guid_to_name(libzfs_handle_t
*hdl
, const char *parent
, uint64_t guid
,
2315 boolean_t bookmark_ok
, char *name
)
2317 char pname
[ZFS_MAX_DATASET_NAME_LEN
];
2318 guid_to_name_data_t gtnd
;
2321 gtnd
.bookmark_ok
= bookmark_ok
;
2326 * Search progressively larger portions of the hierarchy, starting
2327 * with the filesystem specified by 'parent'. This will
2328 * select the "most local" version of the origin snapshot in the case
2329 * that there are multiple matching snapshots in the system.
2331 (void) strlcpy(pname
, parent
, sizeof (pname
));
2332 char *cp
= strrchr(pname
, '@');
2334 cp
= strchr(pname
, '\0');
2335 for (; cp
!= NULL
; cp
= strrchr(pname
, '/')) {
2336 /* Chop off the last component and open the parent */
2338 zfs_handle_t
*zhp
= make_dataset_handle(hdl
, pname
);
2342 int err
= guid_to_name_cb(zfs_handle_dup(zhp
), >nd
);
2344 err
= zfs_iter_children(zhp
, guid_to_name_cb
, >nd
);
2345 if (err
!= EEXIST
&& bookmark_ok
)
2346 err
= zfs_iter_bookmarks(zhp
, guid_to_name_cb
, >nd
);
2352 * Remember the last portion of the dataset so we skip it next
2353 * time through (as we've already searched that portion of the
2356 gtnd
.skip
= strrchr(pname
, '/') + 1;
2363 * Return +1 if guid1 is before guid2, 0 if they are the same, and -1 if
2364 * guid1 is after guid2.
2367 created_before(libzfs_handle_t
*hdl
, avl_tree_t
*avl
,
2368 uint64_t guid1
, uint64_t guid2
)
2371 char *fsname
= NULL
, *snapname
= NULL
;
2372 char buf
[ZFS_MAX_DATASET_NAME_LEN
];
2374 zfs_handle_t
*guid1hdl
, *guid2hdl
;
2375 uint64_t create1
, create2
;
2382 nvfs
= fsavl_find(avl
, guid1
, &snapname
);
2383 VERIFY(0 == nvlist_lookup_string(nvfs
, "name", &fsname
));
2384 (void) snprintf(buf
, sizeof (buf
), "%s@%s", fsname
, snapname
);
2385 guid1hdl
= zfs_open(hdl
, buf
, ZFS_TYPE_SNAPSHOT
);
2386 if (guid1hdl
== NULL
)
2389 nvfs
= fsavl_find(avl
, guid2
, &snapname
);
2390 VERIFY(0 == nvlist_lookup_string(nvfs
, "name", &fsname
));
2391 (void) snprintf(buf
, sizeof (buf
), "%s@%s", fsname
, snapname
);
2392 guid2hdl
= zfs_open(hdl
, buf
, ZFS_TYPE_SNAPSHOT
);
2393 if (guid2hdl
== NULL
) {
2394 zfs_close(guid1hdl
);
2398 create1
= zfs_prop_get_int(guid1hdl
, ZFS_PROP_CREATETXG
);
2399 create2
= zfs_prop_get_int(guid2hdl
, ZFS_PROP_CREATETXG
);
2401 if (create1
< create2
)
2403 else if (create1
> create2
)
2408 zfs_close(guid1hdl
);
2409 zfs_close(guid2hdl
);
2415 recv_incremental_replication(libzfs_handle_t
*hdl
, const char *tofs
,
2416 recvflags_t
*flags
, nvlist_t
*stream_nv
, avl_tree_t
*stream_avl
,
2419 nvlist_t
*local_nv
, *deleted
= NULL
;
2420 avl_tree_t
*local_avl
;
2421 nvpair_t
*fselem
, *nextfselem
;
2423 char newname
[ZFS_MAX_DATASET_NAME_LEN
];
2426 boolean_t needagain
, progress
, recursive
;
2429 VERIFY(0 == nvlist_lookup_string(stream_nv
, "fromsnap", &fromsnap
));
2431 recursive
= (nvlist_lookup_boolean(stream_nv
, "not_recursive") ==
2438 needagain
= progress
= B_FALSE
;
2440 VERIFY(0 == nvlist_alloc(&deleted
, NV_UNIQUE_NAME
, 0));
2442 if ((error
= gather_nvlist(hdl
, tofs
, fromsnap
, NULL
,
2443 recursive
, B_FALSE
, &local_nv
, &local_avl
)) != 0)
2447 * Process deletes and renames
2449 for (fselem
= nvlist_next_nvpair(local_nv
, NULL
);
2450 fselem
; fselem
= nextfselem
) {
2451 nvlist_t
*nvfs
, *snaps
;
2452 nvlist_t
*stream_nvfs
= NULL
;
2453 nvpair_t
*snapelem
, *nextsnapelem
;
2454 uint64_t fromguid
= 0;
2455 uint64_t originguid
= 0;
2456 uint64_t stream_originguid
= 0;
2457 uint64_t parent_fromsnap_guid
, stream_parent_fromsnap_guid
;
2458 char *fsname
, *stream_fsname
;
2460 nextfselem
= nvlist_next_nvpair(local_nv
, fselem
);
2462 VERIFY(0 == nvpair_value_nvlist(fselem
, &nvfs
));
2463 VERIFY(0 == nvlist_lookup_nvlist(nvfs
, "snaps", &snaps
));
2464 VERIFY(0 == nvlist_lookup_string(nvfs
, "name", &fsname
));
2465 VERIFY(0 == nvlist_lookup_uint64(nvfs
, "parentfromsnap",
2466 &parent_fromsnap_guid
));
2467 (void) nvlist_lookup_uint64(nvfs
, "origin", &originguid
);
2470 * First find the stream's fs, so we can check for
2471 * a different origin (due to "zfs promote")
2473 for (snapelem
= nvlist_next_nvpair(snaps
, NULL
);
2474 snapelem
; snapelem
= nvlist_next_nvpair(snaps
, snapelem
)) {
2477 VERIFY(0 == nvpair_value_uint64(snapelem
, &thisguid
));
2478 stream_nvfs
= fsavl_find(stream_avl
, thisguid
, NULL
);
2480 if (stream_nvfs
!= NULL
)
2484 /* check for promote */
2485 (void) nvlist_lookup_uint64(stream_nvfs
, "origin",
2486 &stream_originguid
);
2487 if (stream_nvfs
&& originguid
!= stream_originguid
) {
2488 switch (created_before(hdl
, local_avl
,
2489 stream_originguid
, originguid
)) {
2492 zfs_cmd_t zc
= {"\0"};
2493 nvlist_t
*origin_nvfs
;
2494 char *origin_fsname
;
2497 (void) printf("promoting %s\n", fsname
);
2499 origin_nvfs
= fsavl_find(local_avl
, originguid
,
2501 VERIFY(0 == nvlist_lookup_string(origin_nvfs
,
2502 "name", &origin_fsname
));
2503 (void) strlcpy(zc
.zc_value
, origin_fsname
,
2504 sizeof (zc
.zc_value
));
2505 (void) strlcpy(zc
.zc_name
, fsname
,
2506 sizeof (zc
.zc_name
));
2507 error
= zfs_ioctl(hdl
, ZFS_IOC_PROMOTE
, &zc
);
2515 fsavl_destroy(local_avl
);
2516 nvlist_free(local_nv
);
2520 * We had/have the wrong origin, therefore our
2521 * list of snapshots is wrong. Need to handle
2522 * them on the next pass.
2528 for (snapelem
= nvlist_next_nvpair(snaps
, NULL
);
2529 snapelem
; snapelem
= nextsnapelem
) {
2531 char *stream_snapname
;
2532 nvlist_t
*found
, *props
;
2534 nextsnapelem
= nvlist_next_nvpair(snaps
, snapelem
);
2536 VERIFY(0 == nvpair_value_uint64(snapelem
, &thisguid
));
2537 found
= fsavl_find(stream_avl
, thisguid
,
2540 /* check for delete */
2541 if (found
== NULL
) {
2542 char name
[ZFS_MAX_DATASET_NAME_LEN
];
2547 (void) snprintf(name
, sizeof (name
), "%s@%s",
2548 fsname
, nvpair_name(snapelem
));
2550 error
= recv_destroy(hdl
, name
,
2551 strlen(fsname
)+1, newname
, flags
);
2556 sprintf(guidname
, "%llu",
2557 (u_longlong_t
)thisguid
);
2558 nvlist_add_boolean(deleted
, guidname
);
2562 stream_nvfs
= found
;
2564 if (0 == nvlist_lookup_nvlist(stream_nvfs
, "snapprops",
2565 &props
) && 0 == nvlist_lookup_nvlist(props
,
2566 stream_snapname
, &props
)) {
2567 zfs_cmd_t zc
= {"\0"};
2569 zc
.zc_cookie
= B_TRUE
; /* received */
2570 (void) snprintf(zc
.zc_name
, sizeof (zc
.zc_name
),
2571 "%s@%s", fsname
, nvpair_name(snapelem
));
2572 if (zcmd_write_src_nvlist(hdl
, &zc
,
2574 (void) zfs_ioctl(hdl
,
2575 ZFS_IOC_SET_PROP
, &zc
);
2576 zcmd_free_nvlists(&zc
);
2580 /* check for different snapname */
2581 if (strcmp(nvpair_name(snapelem
),
2582 stream_snapname
) != 0) {
2583 char name
[ZFS_MAX_DATASET_NAME_LEN
];
2584 char tryname
[ZFS_MAX_DATASET_NAME_LEN
];
2586 (void) snprintf(name
, sizeof (name
), "%s@%s",
2587 fsname
, nvpair_name(snapelem
));
2588 (void) snprintf(tryname
, sizeof (name
), "%s@%s",
2589 fsname
, stream_snapname
);
2591 error
= recv_rename(hdl
, name
, tryname
,
2592 strlen(fsname
)+1, newname
, flags
);
2599 if (strcmp(stream_snapname
, fromsnap
) == 0)
2600 fromguid
= thisguid
;
2603 /* check for delete */
2604 if (stream_nvfs
== NULL
) {
2608 error
= recv_destroy(hdl
, fsname
, strlen(tofs
)+1,
2614 sprintf(guidname
, "%llu",
2615 (u_longlong_t
) parent_fromsnap_guid
);
2616 nvlist_add_boolean(deleted
, guidname
);
2620 if (fromguid
== 0) {
2621 if (flags
->verbose
) {
2622 (void) printf("local fs %s does not have "
2623 "fromsnap (%s in stream); must have "
2624 "been deleted locally; ignoring\n",
2630 VERIFY(0 == nvlist_lookup_string(stream_nvfs
,
2631 "name", &stream_fsname
));
2632 VERIFY(0 == nvlist_lookup_uint64(stream_nvfs
,
2633 "parentfromsnap", &stream_parent_fromsnap_guid
));
2635 s1
= strrchr(fsname
, '/');
2636 s2
= strrchr(stream_fsname
, '/');
2639 * Check if we're going to rename based on parent guid change
2640 * and the current parent guid was also deleted. If it was then
2641 * rename will fail and is likely unneeded, so avoid this and
2642 * force an early retry to determine the new
2643 * parent_fromsnap_guid.
2645 if (stream_parent_fromsnap_guid
!= 0 &&
2646 parent_fromsnap_guid
!= 0 &&
2647 stream_parent_fromsnap_guid
!= parent_fromsnap_guid
) {
2648 sprintf(guidname
, "%llu",
2649 (u_longlong_t
) parent_fromsnap_guid
);
2650 if (nvlist_exists(deleted
, guidname
)) {
2658 * Check for rename. If the exact receive path is specified, it
2659 * does not count as a rename, but we still need to check the
2660 * datasets beneath it.
2662 if ((stream_parent_fromsnap_guid
!= 0 &&
2663 parent_fromsnap_guid
!= 0 &&
2664 stream_parent_fromsnap_guid
!= parent_fromsnap_guid
) ||
2665 ((flags
->isprefix
|| strcmp(tofs
, fsname
) != 0) &&
2666 (s1
!= NULL
) && (s2
!= NULL
) && strcmp(s1
, s2
) != 0)) {
2668 char tryname
[ZFS_MAX_DATASET_NAME_LEN
];
2670 parent
= fsavl_find(local_avl
,
2671 stream_parent_fromsnap_guid
, NULL
);
2673 * NB: parent might not be found if we used the
2674 * tosnap for stream_parent_fromsnap_guid,
2675 * because the parent is a newly-created fs;
2676 * we'll be able to rename it after we recv the
2679 if (parent
!= NULL
) {
2682 VERIFY(0 == nvlist_lookup_string(parent
, "name",
2684 (void) snprintf(tryname
, sizeof (tryname
),
2685 "%s%s", pname
, strrchr(stream_fsname
, '/'));
2688 if (flags
->verbose
) {
2689 (void) printf("local fs %s new parent "
2690 "not found\n", fsname
);
2696 error
= recv_rename(hdl
, fsname
, tryname
,
2697 strlen(tofs
)+1, newname
, flags
);
2699 if (renamed
!= NULL
&& newname
[0] != '\0') {
2700 VERIFY(0 == nvlist_add_boolean(renamed
,
2712 fsavl_destroy(local_avl
);
2713 nvlist_free(local_nv
);
2714 nvlist_free(deleted
);
2716 if (needagain
&& progress
) {
2717 /* do another pass to fix up temporary names */
2719 (void) printf("another pass:\n");
2727 zfs_receive_package(libzfs_handle_t
*hdl
, int fd
, const char *destname
,
2728 recvflags_t
*flags
, dmu_replay_record_t
*drr
, zio_cksum_t
*zc
,
2729 char **top_zfs
, int cleanup_fd
, uint64_t *action_handlep
)
2731 nvlist_t
*stream_nv
= NULL
;
2732 avl_tree_t
*stream_avl
= NULL
;
2733 char *fromsnap
= NULL
;
2734 char *sendsnap
= NULL
;
2736 char tofs
[ZFS_MAX_DATASET_NAME_LEN
];
2737 char sendfs
[ZFS_MAX_DATASET_NAME_LEN
];
2739 dmu_replay_record_t drre
;
2741 boolean_t anyerr
= B_FALSE
;
2742 boolean_t softerr
= B_FALSE
;
2743 boolean_t recursive
;
2745 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
2748 assert(drr
->drr_type
== DRR_BEGIN
);
2749 assert(drr
->drr_u
.drr_begin
.drr_magic
== DMU_BACKUP_MAGIC
);
2750 assert(DMU_GET_STREAM_HDRTYPE(drr
->drr_u
.drr_begin
.drr_versioninfo
) ==
2751 DMU_COMPOUNDSTREAM
);
2754 * Read in the nvlist from the stream.
2756 if (drr
->drr_payloadlen
!= 0) {
2757 error
= recv_read_nvlist(hdl
, fd
, drr
->drr_payloadlen
,
2758 &stream_nv
, flags
->byteswap
, zc
);
2760 error
= zfs_error(hdl
, EZFS_BADSTREAM
, errbuf
);
2765 recursive
= (nvlist_lookup_boolean(stream_nv
, "not_recursive") ==
2768 if (recursive
&& strchr(destname
, '@')) {
2769 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
2770 "cannot specify snapshot name for multi-snapshot stream"));
2771 error
= zfs_error(hdl
, EZFS_BADSTREAM
, errbuf
);
2776 * Read in the end record and verify checksum.
2778 if (0 != (error
= recv_read(hdl
, fd
, &drre
, sizeof (drre
),
2779 flags
->byteswap
, NULL
)))
2781 if (flags
->byteswap
) {
2782 drre
.drr_type
= BSWAP_32(drre
.drr_type
);
2783 drre
.drr_u
.drr_end
.drr_checksum
.zc_word
[0] =
2784 BSWAP_64(drre
.drr_u
.drr_end
.drr_checksum
.zc_word
[0]);
2785 drre
.drr_u
.drr_end
.drr_checksum
.zc_word
[1] =
2786 BSWAP_64(drre
.drr_u
.drr_end
.drr_checksum
.zc_word
[1]);
2787 drre
.drr_u
.drr_end
.drr_checksum
.zc_word
[2] =
2788 BSWAP_64(drre
.drr_u
.drr_end
.drr_checksum
.zc_word
[2]);
2789 drre
.drr_u
.drr_end
.drr_checksum
.zc_word
[3] =
2790 BSWAP_64(drre
.drr_u
.drr_end
.drr_checksum
.zc_word
[3]);
2792 if (drre
.drr_type
!= DRR_END
) {
2793 error
= zfs_error(hdl
, EZFS_BADSTREAM
, errbuf
);
2796 if (!ZIO_CHECKSUM_EQUAL(drre
.drr_u
.drr_end
.drr_checksum
, *zc
)) {
2797 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
2798 "incorrect header checksum"));
2799 error
= zfs_error(hdl
, EZFS_BADSTREAM
, errbuf
);
2803 (void) nvlist_lookup_string(stream_nv
, "fromsnap", &fromsnap
);
2805 if (drr
->drr_payloadlen
!= 0) {
2806 nvlist_t
*stream_fss
;
2808 VERIFY(0 == nvlist_lookup_nvlist(stream_nv
, "fss",
2810 if ((stream_avl
= fsavl_create(stream_fss
)) == NULL
) {
2811 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
2812 "couldn't allocate avl tree"));
2813 error
= zfs_error(hdl
, EZFS_NOMEM
, errbuf
);
2817 if (fromsnap
!= NULL
) {
2818 nvlist_t
*renamed
= NULL
;
2819 nvpair_t
*pair
= NULL
;
2821 (void) strlcpy(tofs
, destname
, sizeof (tofs
));
2822 if (flags
->isprefix
) {
2823 struct drr_begin
*drrb
= &drr
->drr_u
.drr_begin
;
2826 if (flags
->istail
) {
2827 cp
= strrchr(drrb
->drr_toname
, '/');
2829 (void) strlcat(tofs
, "/",
2833 i
= (cp
- drrb
->drr_toname
);
2836 i
= strcspn(drrb
->drr_toname
, "/@");
2838 /* zfs_receive_one() will create_parents() */
2839 (void) strlcat(tofs
, &drrb
->drr_toname
[i
],
2841 *strchr(tofs
, '@') = '\0';
2844 if (recursive
&& !flags
->dryrun
&& !flags
->nomount
) {
2845 VERIFY(0 == nvlist_alloc(&renamed
,
2846 NV_UNIQUE_NAME
, 0));
2849 softerr
= recv_incremental_replication(hdl
, tofs
, flags
,
2850 stream_nv
, stream_avl
, renamed
);
2852 /* Unmount renamed filesystems before receiving. */
2853 while ((pair
= nvlist_next_nvpair(renamed
,
2856 prop_changelist_t
*clp
= NULL
;
2858 zhp
= zfs_open(hdl
, nvpair_name(pair
),
2859 ZFS_TYPE_FILESYSTEM
);
2861 clp
= changelist_gather(zhp
,
2862 ZFS_PROP_MOUNTPOINT
, 0, 0);
2866 changelist_prefix(clp
);
2867 changelist_free(clp
);
2872 nvlist_free(renamed
);
2877 * Get the fs specified by the first path in the stream (the top level
2878 * specified by 'zfs send') and pass it to each invocation of
2879 * zfs_receive_one().
2881 (void) strlcpy(sendfs
, drr
->drr_u
.drr_begin
.drr_toname
,
2883 if ((cp
= strchr(sendfs
, '@')) != NULL
) {
2886 * Find the "sendsnap", the final snapshot in a replication
2887 * stream. zfs_receive_one() handles certain errors
2888 * differently, depending on if the contained stream is the
2891 sendsnap
= (cp
+ 1);
2894 /* Finally, receive each contained stream */
2897 * we should figure out if it has a recoverable
2898 * error, in which case do a recv_skip() and drive on.
2899 * Note, if we fail due to already having this guid,
2900 * zfs_receive_one() will take care of it (ie,
2901 * recv_skip() and return 0).
2903 error
= zfs_receive_impl(hdl
, destname
, NULL
, flags
, fd
,
2904 sendfs
, stream_nv
, stream_avl
, top_zfs
, cleanup_fd
,
2905 action_handlep
, sendsnap
);
2906 if (error
== ENODATA
) {
2911 } while (error
== 0);
2913 if (drr
->drr_payloadlen
!= 0 && fromsnap
!= NULL
) {
2915 * Now that we have the fs's they sent us, try the
2918 softerr
= recv_incremental_replication(hdl
, tofs
, flags
,
2919 stream_nv
, stream_avl
, NULL
);
2923 fsavl_destroy(stream_avl
);
2924 nvlist_free(stream_nv
);
2933 trunc_prop_errs(int truncated
)
2935 ASSERT(truncated
!= 0);
2938 (void) fprintf(stderr
, dgettext(TEXT_DOMAIN
,
2939 "1 more property could not be set\n"));
2941 (void) fprintf(stderr
, dgettext(TEXT_DOMAIN
,
2942 "%d more properties could not be set\n"), truncated
);
2946 recv_skip(libzfs_handle_t
*hdl
, int fd
, boolean_t byteswap
)
2948 dmu_replay_record_t
*drr
;
2949 void *buf
= zfs_alloc(hdl
, SPA_MAXBLOCKSIZE
);
2952 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
2953 "cannot receive:"));
2955 /* XXX would be great to use lseek if possible... */
2958 while (recv_read(hdl
, fd
, drr
, sizeof (dmu_replay_record_t
),
2959 byteswap
, NULL
) == 0) {
2961 drr
->drr_type
= BSWAP_32(drr
->drr_type
);
2963 switch (drr
->drr_type
) {
2965 if (drr
->drr_payloadlen
!= 0) {
2966 (void) recv_read(hdl
, fd
, buf
,
2967 drr
->drr_payloadlen
, B_FALSE
, NULL
);
2977 drr
->drr_u
.drr_object
.drr_bonuslen
=
2978 BSWAP_32(drr
->drr_u
.drr_object
.
2981 (void) recv_read(hdl
, fd
, buf
,
2982 P2ROUNDUP(drr
->drr_u
.drr_object
.drr_bonuslen
, 8),
2988 drr
->drr_u
.drr_write
.drr_logical_size
=
2990 drr
->drr_u
.drr_write
.drr_logical_size
);
2991 drr
->drr_u
.drr_write
.drr_compressed_size
=
2993 drr
->drr_u
.drr_write
.drr_compressed_size
);
2995 uint64_t payload_size
=
2996 DRR_WRITE_PAYLOAD_SIZE(&drr
->drr_u
.drr_write
);
2997 (void) recv_read(hdl
, fd
, buf
,
2998 payload_size
, B_FALSE
, NULL
);
3002 drr
->drr_u
.drr_spill
.drr_length
=
3003 BSWAP_64(drr
->drr_u
.drr_spill
.drr_length
);
3005 (void) recv_read(hdl
, fd
, buf
,
3006 drr
->drr_u
.drr_spill
.drr_length
, B_FALSE
, NULL
);
3008 case DRR_WRITE_EMBEDDED
:
3010 drr
->drr_u
.drr_write_embedded
.drr_psize
=
3011 BSWAP_32(drr
->drr_u
.drr_write_embedded
.
3014 (void) recv_read(hdl
, fd
, buf
,
3015 P2ROUNDUP(drr
->drr_u
.drr_write_embedded
.drr_psize
,
3018 case DRR_WRITE_BYREF
:
3019 case DRR_FREEOBJECTS
:
3024 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3025 "invalid record type"));
3026 return (zfs_error(hdl
, EZFS_BADSTREAM
, errbuf
));
3035 recv_ecksum_set_aux(libzfs_handle_t
*hdl
, const char *target_snap
,
3036 boolean_t resumable
)
3038 char target_fs
[ZFS_MAX_DATASET_NAME_LEN
];
3040 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3041 "checksum mismatch or incomplete stream"));
3045 (void) strlcpy(target_fs
, target_snap
, sizeof (target_fs
));
3046 *strchr(target_fs
, '@') = '\0';
3047 zfs_handle_t
*zhp
= zfs_open(hdl
, target_fs
,
3048 ZFS_TYPE_FILESYSTEM
| ZFS_TYPE_VOLUME
);
3052 char token_buf
[ZFS_MAXPROPLEN
];
3053 int error
= zfs_prop_get(zhp
, ZFS_PROP_RECEIVE_RESUME_TOKEN
,
3054 token_buf
, sizeof (token_buf
),
3055 NULL
, NULL
, 0, B_TRUE
);
3057 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3058 "checksum mismatch or incomplete stream.\n"
3059 "Partially received snapshot is saved.\n"
3060 "A resuming stream can be generated on the sending "
3061 "system by running:\n"
3069 * Restores a backup of tosnap from the file descriptor specified by infd.
3072 zfs_receive_one(libzfs_handle_t
*hdl
, int infd
, const char *tosnap
,
3073 const char *originsnap
, recvflags_t
*flags
, dmu_replay_record_t
*drr
,
3074 dmu_replay_record_t
*drr_noswap
, const char *sendfs
, nvlist_t
*stream_nv
,
3075 avl_tree_t
*stream_avl
, char **top_zfs
, int cleanup_fd
,
3076 uint64_t *action_handlep
, const char *finalsnap
)
3079 int ioctl_err
, ioctl_errno
, err
;
3081 struct drr_begin
*drrb
= &drr
->drr_u
.drr_begin
;
3083 const char *chopprefix
;
3084 boolean_t newfs
= B_FALSE
;
3085 boolean_t stream_wantsnewfs
;
3086 boolean_t newprops
= B_FALSE
;
3087 uint64_t read_bytes
= 0;
3088 uint64_t errflags
= 0;
3089 uint64_t parent_snapguid
= 0;
3090 prop_changelist_t
*clp
= NULL
;
3091 nvlist_t
*snapprops_nvlist
= NULL
;
3092 zprop_errflags_t prop_errflags
;
3093 nvlist_t
*prop_errors
= NULL
;
3094 boolean_t recursive
;
3095 char *snapname
= NULL
;
3096 char destsnap
[MAXPATHLEN
* 2];
3097 char origin
[MAXNAMELEN
];
3098 char name
[MAXPATHLEN
];
3099 nvlist_t
*props
= NULL
;
3101 begin_time
= time(NULL
);
3102 bzero(origin
, MAXNAMELEN
);
3104 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
3107 recursive
= (nvlist_lookup_boolean(stream_nv
, "not_recursive") ==
3110 if (stream_avl
!= NULL
) {
3111 nvlist_t
*fs
= fsavl_find(stream_avl
, drrb
->drr_toguid
,
3114 (void) nvlist_lookup_uint64(fs
, "parentfromsnap",
3116 err
= nvlist_lookup_nvlist(fs
, "props", &props
);
3118 VERIFY(0 == nvlist_alloc(&props
, NV_UNIQUE_NAME
, 0));
3122 if (flags
->canmountoff
) {
3123 VERIFY(0 == nvlist_add_uint64(props
,
3124 zfs_prop_to_name(ZFS_PROP_CANMOUNT
), 0));
3131 * Determine how much of the snapshot name stored in the stream
3132 * we are going to tack on to the name they specified on the
3133 * command line, and how much we are going to chop off.
3135 * If they specified a snapshot, chop the entire name stored in
3138 if (flags
->istail
) {
3140 * A filesystem was specified with -e. We want to tack on only
3141 * the tail of the sent snapshot path.
3143 if (strchr(tosnap
, '@')) {
3144 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
, "invalid "
3145 "argument - snapshot not allowed with -e"));
3146 err
= zfs_error(hdl
, EZFS_INVALIDNAME
, errbuf
);
3150 chopprefix
= strrchr(sendfs
, '/');
3152 if (chopprefix
== NULL
) {
3154 * The tail is the poolname, so we need to
3155 * prepend a path separator.
3157 int len
= strlen(drrb
->drr_toname
);
3158 cp
= malloc(len
+ 2);
3160 (void) strcpy(&cp
[1], drrb
->drr_toname
);
3163 chopprefix
= drrb
->drr_toname
+ (chopprefix
- sendfs
);
3165 } else if (flags
->isprefix
) {
3167 * A filesystem was specified with -d. We want to tack on
3168 * everything but the first element of the sent snapshot path
3169 * (all but the pool name).
3171 if (strchr(tosnap
, '@')) {
3172 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
, "invalid "
3173 "argument - snapshot not allowed with -d"));
3174 err
= zfs_error(hdl
, EZFS_INVALIDNAME
, errbuf
);
3178 chopprefix
= strchr(drrb
->drr_toname
, '/');
3179 if (chopprefix
== NULL
)
3180 chopprefix
= strchr(drrb
->drr_toname
, '@');
3181 } else if (strchr(tosnap
, '@') == NULL
) {
3183 * If a filesystem was specified without -d or -e, we want to
3184 * tack on everything after the fs specified by 'zfs send'.
3186 chopprefix
= drrb
->drr_toname
+ strlen(sendfs
);
3188 /* A snapshot was specified as an exact path (no -d or -e). */
3190 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3191 "cannot specify snapshot name for multi-snapshot "
3193 err
= zfs_error(hdl
, EZFS_BADSTREAM
, errbuf
);
3196 chopprefix
= drrb
->drr_toname
+ strlen(drrb
->drr_toname
);
3199 ASSERT(strstr(drrb
->drr_toname
, sendfs
) == drrb
->drr_toname
);
3200 ASSERT(chopprefix
> drrb
->drr_toname
);
3201 ASSERT(chopprefix
<= drrb
->drr_toname
+ strlen(drrb
->drr_toname
));
3202 ASSERT(chopprefix
[0] == '/' || chopprefix
[0] == '@' ||
3203 chopprefix
[0] == '\0');
3206 * Determine name of destination snapshot.
3208 (void) strcpy(destsnap
, tosnap
);
3209 (void) strlcat(destsnap
, chopprefix
, sizeof (destsnap
));
3211 if (!zfs_name_valid(destsnap
, ZFS_TYPE_SNAPSHOT
)) {
3212 err
= zfs_error(hdl
, EZFS_INVALIDNAME
, errbuf
);
3217 * Determine the name of the origin snapshot.
3219 if (drrb
->drr_flags
& DRR_FLAG_CLONE
) {
3220 if (guid_to_name(hdl
, destsnap
,
3221 drrb
->drr_fromguid
, B_FALSE
, origin
) != 0) {
3222 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3223 "local origin for clone %s does not exist"),
3225 err
= zfs_error(hdl
, EZFS_NOENT
, errbuf
);
3229 (void) printf("found clone origin %s\n", origin
);
3230 } else if (originsnap
) {
3231 (void) strncpy(origin
, originsnap
, sizeof (origin
));
3233 (void) printf("using provided clone origin %s\n",
3237 boolean_t resuming
= DMU_GET_FEATUREFLAGS(drrb
->drr_versioninfo
) &
3238 DMU_BACKUP_FEATURE_RESUMING
;
3239 stream_wantsnewfs
= (drrb
->drr_fromguid
== 0 ||
3240 (drrb
->drr_flags
& DRR_FLAG_CLONE
) || originsnap
) && !resuming
;
3242 if (stream_wantsnewfs
) {
3244 * if the parent fs does not exist, look for it based on
3245 * the parent snap GUID
3247 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
3248 "cannot receive new filesystem stream"));
3250 (void) strcpy(name
, destsnap
);
3251 cp
= strrchr(name
, '/');
3255 !zfs_dataset_exists(hdl
, name
, ZFS_TYPE_DATASET
)) {
3256 char suffix
[ZFS_MAX_DATASET_NAME_LEN
];
3257 (void) strcpy(suffix
, strrchr(destsnap
, '/'));
3258 if (guid_to_name(hdl
, name
, parent_snapguid
,
3259 B_FALSE
, destsnap
) == 0) {
3260 *strchr(destsnap
, '@') = '\0';
3261 (void) strcat(destsnap
, suffix
);
3266 * if the fs does not exist, look for it based on the
3269 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
3270 "cannot receive incremental stream"));
3272 (void) strcpy(name
, destsnap
);
3273 *strchr(name
, '@') = '\0';
3276 * If the exact receive path was specified and this is the
3277 * topmost path in the stream, then if the fs does not exist we
3278 * should look no further.
3280 if ((flags
->isprefix
|| (*(chopprefix
= drrb
->drr_toname
+
3281 strlen(sendfs
)) != '\0' && *chopprefix
!= '@')) &&
3282 !zfs_dataset_exists(hdl
, name
, ZFS_TYPE_DATASET
)) {
3283 char snap
[ZFS_MAX_DATASET_NAME_LEN
];
3284 (void) strcpy(snap
, strchr(destsnap
, '@'));
3285 if (guid_to_name(hdl
, name
, drrb
->drr_fromguid
,
3286 B_FALSE
, destsnap
) == 0) {
3287 *strchr(destsnap
, '@') = '\0';
3288 (void) strcat(destsnap
, snap
);
3293 (void) strcpy(name
, destsnap
);
3294 *strchr(name
, '@') = '\0';
3296 if (zfs_dataset_exists(hdl
, name
, ZFS_TYPE_DATASET
)) {
3297 zfs_cmd_t zc
= {"\0"};
3300 (void) strcpy(zc
.zc_name
, name
);
3303 * Destination fs exists. It must be one of these cases:
3304 * - an incremental send stream
3305 * - the stream specifies a new fs (full stream or clone)
3306 * and they want us to blow away the existing fs (and
3307 * have therefore specified -F and removed any snapshots)
3308 * - we are resuming a failed receive.
3310 if (stream_wantsnewfs
) {
3311 if (!flags
->force
) {
3312 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3313 "destination '%s' exists\n"
3314 "must specify -F to overwrite it"), name
);
3315 err
= zfs_error(hdl
, EZFS_EXISTS
, errbuf
);
3318 if (ioctl(hdl
->libzfs_fd
, ZFS_IOC_SNAPSHOT_LIST_NEXT
,
3320 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3321 "destination has snapshots (eg. %s)\n"
3322 "must destroy them to overwrite it"),
3324 err
= zfs_error(hdl
, EZFS_EXISTS
, errbuf
);
3329 if ((zhp
= zfs_open(hdl
, name
,
3330 ZFS_TYPE_FILESYSTEM
| ZFS_TYPE_VOLUME
)) == NULL
) {
3335 if (stream_wantsnewfs
&&
3336 zhp
->zfs_dmustats
.dds_origin
[0]) {
3338 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3339 "destination '%s' is a clone\n"
3340 "must destroy it to overwrite it"), name
);
3341 err
= zfs_error(hdl
, EZFS_EXISTS
, errbuf
);
3345 if (!flags
->dryrun
&& zhp
->zfs_type
== ZFS_TYPE_FILESYSTEM
&&
3346 stream_wantsnewfs
) {
3347 /* We can't do online recv in this case */
3348 clp
= changelist_gather(zhp
, ZFS_PROP_NAME
, 0, 0);
3354 if (changelist_prefix(clp
) != 0) {
3355 changelist_free(clp
);
3363 * If we are resuming a newfs, set newfs here so that we will
3364 * mount it if the recv succeeds this time. We can tell
3365 * that it was a newfs on the first recv because the fs
3366 * itself will be inconsistent (if the fs existed when we
3367 * did the first recv, we would have received it into
3370 if (resuming
&& zfs_prop_get_int(zhp
, ZFS_PROP_INCONSISTENT
))
3376 * Destination filesystem does not exist. Therefore we better
3377 * be creating a new filesystem (either from a full backup, or
3378 * a clone). It would therefore be invalid if the user
3379 * specified only the pool name (i.e. if the destination name
3380 * contained no slash character).
3382 cp
= strrchr(name
, '/');
3384 if (!stream_wantsnewfs
|| cp
== NULL
) {
3385 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3386 "destination '%s' does not exist"), name
);
3387 err
= zfs_error(hdl
, EZFS_NOENT
, errbuf
);
3392 * Trim off the final dataset component so we perform the
3393 * recvbackup ioctl to the filesystems's parent.
3397 if (flags
->isprefix
&& !flags
->istail
&& !flags
->dryrun
&&
3398 create_parents(hdl
, destsnap
, strlen(tosnap
)) != 0) {
3399 err
= zfs_error(hdl
, EZFS_BADRESTORE
, errbuf
);
3406 if (flags
->verbose
) {
3407 (void) printf("%s %s stream of %s into %s\n",
3408 flags
->dryrun
? "would receive" : "receiving",
3409 drrb
->drr_fromguid
? "incremental" : "full",
3410 drrb
->drr_toname
, destsnap
);
3411 (void) fflush(stdout
);
3414 if (flags
->dryrun
) {
3415 err
= recv_skip(hdl
, infd
, flags
->byteswap
);
3419 err
= ioctl_err
= lzc_receive_one(destsnap
, props
, origin
,
3420 flags
->force
, flags
->resumable
, infd
, drr_noswap
, cleanup_fd
,
3421 &read_bytes
, &errflags
, action_handlep
, &prop_errors
);
3422 ioctl_errno
= ioctl_err
;
3423 prop_errflags
= errflags
;
3426 nvpair_t
*prop_err
= NULL
;
3428 while ((prop_err
= nvlist_next_nvpair(prop_errors
,
3429 prop_err
)) != NULL
) {
3434 prop
= zfs_name_to_prop(nvpair_name(prop_err
));
3435 (void) nvpair_value_int32(prop_err
, &intval
);
3436 if (strcmp(nvpair_name(prop_err
),
3437 ZPROP_N_MORE_ERRORS
) == 0) {
3438 trunc_prop_errs(intval
);
3440 } else if (snapname
== NULL
|| finalsnap
== NULL
||
3441 strcmp(finalsnap
, snapname
) == 0 ||
3442 strcmp(nvpair_name(prop_err
),
3443 zfs_prop_to_name(ZFS_PROP_REFQUOTA
)) != 0) {
3445 * Skip the special case of, for example,
3446 * "refquota", errors on intermediate
3447 * snapshots leading up to a final one.
3448 * That's why we have all of the checks above.
3450 * See zfs_ioctl.c's extract_delay_props() for
3451 * a list of props which can fail on
3452 * intermediate snapshots, but shouldn't
3453 * affect the overall receive.
3455 (void) snprintf(tbuf
, sizeof (tbuf
),
3456 dgettext(TEXT_DOMAIN
,
3457 "cannot receive %s property on %s"),
3458 nvpair_name(prop_err
), name
);
3459 zfs_setprop_error(hdl
, prop
, intval
, tbuf
);
3464 if (err
== 0 && snapprops_nvlist
) {
3465 zfs_cmd_t zc
= {"\0"};
3467 (void) strcpy(zc
.zc_name
, destsnap
);
3468 zc
.zc_cookie
= B_TRUE
; /* received */
3469 if (zcmd_write_src_nvlist(hdl
, &zc
, snapprops_nvlist
) == 0) {
3470 (void) zfs_ioctl(hdl
, ZFS_IOC_SET_PROP
, &zc
);
3471 zcmd_free_nvlists(&zc
);
3475 if (err
&& (ioctl_errno
== ENOENT
|| ioctl_errno
== EEXIST
)) {
3477 * It may be that this snapshot already exists,
3478 * in which case we want to consume & ignore it
3479 * rather than failing.
3481 avl_tree_t
*local_avl
;
3482 nvlist_t
*local_nv
, *fs
;
3483 cp
= strchr(destsnap
, '@');
3486 * XXX Do this faster by just iterating over snaps in
3487 * this fs. Also if zc_value does not exist, we will
3488 * get a strange "does not exist" error message.
3491 if (gather_nvlist(hdl
, destsnap
, NULL
, NULL
, B_FALSE
,
3492 B_FALSE
, &local_nv
, &local_avl
) == 0) {
3494 fs
= fsavl_find(local_avl
, drrb
->drr_toguid
, NULL
);
3495 fsavl_destroy(local_avl
);
3496 nvlist_free(local_nv
);
3499 if (flags
->verbose
) {
3500 (void) printf("snap %s already exists; "
3501 "ignoring\n", destsnap
);
3503 err
= ioctl_err
= recv_skip(hdl
, infd
,
3510 if (ioctl_err
!= 0) {
3511 switch (ioctl_errno
) {
3513 cp
= strchr(destsnap
, '@');
3515 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3516 "most recent snapshot of %s does not\n"
3517 "match incremental source"), destsnap
);
3518 (void) zfs_error(hdl
, EZFS_BADRESTORE
, errbuf
);
3522 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3523 "destination %s has been modified\n"
3524 "since most recent snapshot"), name
);
3525 (void) zfs_error(hdl
, EZFS_BADRESTORE
, errbuf
);
3528 cp
= strchr(destsnap
, '@');
3530 /* it's the containing fs that exists */
3533 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3534 "destination already exists"));
3535 (void) zfs_error_fmt(hdl
, EZFS_EXISTS
,
3536 dgettext(TEXT_DOMAIN
, "cannot restore to %s"),
3541 if (flags
->resumable
)
3542 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3543 "kernel modules must be upgraded to "
3544 "receive this stream."));
3545 (void) zfs_error(hdl
, EZFS_BADSTREAM
, errbuf
);
3548 recv_ecksum_set_aux(hdl
, destsnap
, flags
->resumable
);
3549 (void) zfs_error(hdl
, EZFS_BADSTREAM
, errbuf
);
3552 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3553 "pool must be upgraded to receive this stream."));
3554 (void) zfs_error(hdl
, EZFS_BADVERSION
, errbuf
);
3557 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3558 "destination %s space quota exceeded"), name
);
3559 (void) zfs_error(hdl
, EZFS_NOSPC
, errbuf
);
3562 (void) zfs_standard_error(hdl
, ioctl_errno
, errbuf
);
3567 * Mount the target filesystem (if created). Also mount any
3568 * children of the target filesystem if we did a replication
3569 * receive (indicated by stream_avl being non-NULL).
3571 cp
= strchr(destsnap
, '@');
3572 if (cp
&& (ioctl_err
== 0 || !newfs
)) {
3576 h
= zfs_open(hdl
, destsnap
,
3577 ZFS_TYPE_FILESYSTEM
| ZFS_TYPE_VOLUME
);
3579 if (h
->zfs_type
== ZFS_TYPE_VOLUME
) {
3581 } else if (newfs
|| stream_avl
) {
3583 * Track the first/top of hierarchy fs,
3584 * for mounting and sharing later.
3586 if (top_zfs
&& *top_zfs
== NULL
)
3587 *top_zfs
= zfs_strdup(hdl
, destsnap
);
3595 err
|= changelist_postfix(clp
);
3596 changelist_free(clp
);
3599 if (prop_errflags
& ZPROP_ERR_NOCLEAR
) {
3600 (void) fprintf(stderr
, dgettext(TEXT_DOMAIN
, "Warning: "
3601 "failed to clear unreceived properties on %s"), name
);
3602 (void) fprintf(stderr
, "\n");
3604 if (prop_errflags
& ZPROP_ERR_NORESTORE
) {
3605 (void) fprintf(stderr
, dgettext(TEXT_DOMAIN
, "Warning: "
3606 "failed to restore original properties on %s"), name
);
3607 (void) fprintf(stderr
, "\n");
3610 if (err
|| ioctl_err
) {
3615 if (flags
->verbose
) {
3618 uint64_t bytes
= read_bytes
;
3619 time_t delta
= time(NULL
) - begin_time
;
3622 zfs_nicenum(bytes
, buf1
, sizeof (buf1
));
3623 zfs_nicenum(bytes
/delta
, buf2
, sizeof (buf1
));
3625 (void) printf("received %sB stream in %lu seconds (%sB/sec)\n",
3631 if (prop_errors
!= NULL
)
3632 nvlist_free(prop_errors
);
3641 zfs_receive_impl(libzfs_handle_t
*hdl
, const char *tosnap
,
3642 const char *originsnap
, recvflags_t
*flags
, int infd
, const char *sendfs
,
3643 nvlist_t
*stream_nv
, avl_tree_t
*stream_avl
, char **top_zfs
, int cleanup_fd
,
3644 uint64_t *action_handlep
, const char *finalsnap
)
3647 dmu_replay_record_t drr
, drr_noswap
;
3648 struct drr_begin
*drrb
= &drr
.drr_u
.drr_begin
;
3650 zio_cksum_t zcksum
= { { 0 } };
3651 uint64_t featureflags
;
3654 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
3657 if (flags
->isprefix
&&
3658 !zfs_dataset_exists(hdl
, tosnap
, ZFS_TYPE_DATASET
)) {
3659 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
, "specified fs "
3660 "(%s) does not exist"), tosnap
);
3661 return (zfs_error(hdl
, EZFS_NOENT
, errbuf
));
3664 !zfs_dataset_exists(hdl
, originsnap
, ZFS_TYPE_DATASET
)) {
3665 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
, "specified origin fs "
3666 "(%s) does not exist"), originsnap
);
3667 return (zfs_error(hdl
, EZFS_NOENT
, errbuf
));
3670 /* read in the BEGIN record */
3671 if (0 != (err
= recv_read(hdl
, infd
, &drr
, sizeof (drr
), B_FALSE
,
3675 if (drr
.drr_type
== DRR_END
|| drr
.drr_type
== BSWAP_32(DRR_END
)) {
3676 /* It's the double end record at the end of a package */
3680 /* the kernel needs the non-byteswapped begin record */
3683 flags
->byteswap
= B_FALSE
;
3684 if (drrb
->drr_magic
== BSWAP_64(DMU_BACKUP_MAGIC
)) {
3686 * We computed the checksum in the wrong byteorder in
3687 * recv_read() above; do it again correctly.
3689 bzero(&zcksum
, sizeof (zio_cksum_t
));
3690 fletcher_4_incremental_byteswap(&drr
, sizeof (drr
), &zcksum
);
3691 flags
->byteswap
= B_TRUE
;
3693 drr
.drr_type
= BSWAP_32(drr
.drr_type
);
3694 drr
.drr_payloadlen
= BSWAP_32(drr
.drr_payloadlen
);
3695 drrb
->drr_magic
= BSWAP_64(drrb
->drr_magic
);
3696 drrb
->drr_versioninfo
= BSWAP_64(drrb
->drr_versioninfo
);
3697 drrb
->drr_creation_time
= BSWAP_64(drrb
->drr_creation_time
);
3698 drrb
->drr_type
= BSWAP_32(drrb
->drr_type
);
3699 drrb
->drr_flags
= BSWAP_32(drrb
->drr_flags
);
3700 drrb
->drr_toguid
= BSWAP_64(drrb
->drr_toguid
);
3701 drrb
->drr_fromguid
= BSWAP_64(drrb
->drr_fromguid
);
3704 if (drrb
->drr_magic
!= DMU_BACKUP_MAGIC
|| drr
.drr_type
!= DRR_BEGIN
) {
3705 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
, "invalid "
3706 "stream (bad magic number)"));
3707 return (zfs_error(hdl
, EZFS_BADSTREAM
, errbuf
));
3710 featureflags
= DMU_GET_FEATUREFLAGS(drrb
->drr_versioninfo
);
3711 hdrtype
= DMU_GET_STREAM_HDRTYPE(drrb
->drr_versioninfo
);
3713 if (!DMU_STREAM_SUPPORTED(featureflags
) ||
3714 (hdrtype
!= DMU_SUBSTREAM
&& hdrtype
!= DMU_COMPOUNDSTREAM
)) {
3715 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3716 "stream has unsupported feature, feature flags = %lx"),
3718 return (zfs_error(hdl
, EZFS_BADSTREAM
, errbuf
));
3721 if (strchr(drrb
->drr_toname
, '@') == NULL
) {
3722 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
, "invalid "
3723 "stream (bad snapshot name)"));
3724 return (zfs_error(hdl
, EZFS_BADSTREAM
, errbuf
));
3727 if (DMU_GET_STREAM_HDRTYPE(drrb
->drr_versioninfo
) == DMU_SUBSTREAM
) {
3728 char nonpackage_sendfs
[ZFS_MAX_DATASET_NAME_LEN
];
3729 if (sendfs
== NULL
) {
3731 * We were not called from zfs_receive_package(). Get
3732 * the fs specified by 'zfs send'.
3735 (void) strlcpy(nonpackage_sendfs
,
3736 drr
.drr_u
.drr_begin
.drr_toname
,
3737 sizeof (nonpackage_sendfs
));
3738 if ((cp
= strchr(nonpackage_sendfs
, '@')) != NULL
)
3740 sendfs
= nonpackage_sendfs
;
3741 VERIFY(finalsnap
== NULL
);
3743 return (zfs_receive_one(hdl
, infd
, tosnap
, originsnap
, flags
,
3744 &drr
, &drr_noswap
, sendfs
, stream_nv
, stream_avl
, top_zfs
,
3745 cleanup_fd
, action_handlep
, finalsnap
));
3747 assert(DMU_GET_STREAM_HDRTYPE(drrb
->drr_versioninfo
) ==
3748 DMU_COMPOUNDSTREAM
);
3749 return (zfs_receive_package(hdl
, infd
, tosnap
, flags
, &drr
,
3750 &zcksum
, top_zfs
, cleanup_fd
, action_handlep
));
3755 * Restores a backup of tosnap from the file descriptor specified by infd.
3756 * Return 0 on total success, -2 if some things couldn't be
3757 * destroyed/renamed/promoted, -1 if some things couldn't be received.
3758 * (-1 will override -2, if -1 and the resumable flag was specified the
3759 * transfer can be resumed if the sending side supports it).
3762 zfs_receive(libzfs_handle_t
*hdl
, const char *tosnap
, nvlist_t
*props
,
3763 recvflags_t
*flags
, int infd
, avl_tree_t
*stream_avl
)
3765 char *top_zfs
= NULL
;
3768 uint64_t action_handle
= 0;
3770 char *originsnap
= NULL
;
3773 * The only way fstat can fail is if we do not have a valid file
3776 if (fstat(infd
, &sb
) == -1) {
3782 #ifndef F_SETPIPE_SZ
3783 #define F_SETPIPE_SZ (F_SETLEASE + 7)
3784 #endif /* F_SETPIPE_SZ */
3786 #ifndef F_GETPIPE_SZ
3787 #define F_GETPIPE_SZ (F_GETLEASE + 7)
3788 #endif /* F_GETPIPE_SZ */
3791 * It is not uncommon for gigabytes to be processed in zfs receive.
3792 * Speculatively increase the buffer size via Linux-specific fcntl()
3795 if (S_ISFIFO(sb
.st_mode
)) {
3796 FILE *procf
= fopen("/proc/sys/fs/pipe-max-size", "r");
3798 if (procf
!= NULL
) {
3799 unsigned long max_psize
;
3801 if (fscanf(procf
, "%lu", &max_psize
) > 0) {
3802 cur_psize
= fcntl(infd
, F_GETPIPE_SZ
);
3803 if (cur_psize
> 0 &&
3804 max_psize
> (unsigned long) cur_psize
)
3805 (void) fcntl(infd
, F_SETPIPE_SZ
,
3811 #endif /* __linux__ */
3814 err
= nvlist_lookup_string(props
, "origin", &originsnap
);
3815 if (err
&& err
!= ENOENT
)
3819 cleanup_fd
= open(ZFS_DEV
, O_RDWR
);
3820 VERIFY(cleanup_fd
>= 0);
3822 err
= zfs_receive_impl(hdl
, tosnap
, originsnap
, flags
, infd
, NULL
, NULL
,
3823 stream_avl
, &top_zfs
, cleanup_fd
, &action_handle
, NULL
);
3825 VERIFY(0 == close(cleanup_fd
));
3827 if (err
== 0 && !flags
->nomount
&& top_zfs
) {
3828 zfs_handle_t
*zhp
= NULL
;
3829 prop_changelist_t
*clp
= NULL
;
3831 zhp
= zfs_open(hdl
, top_zfs
, ZFS_TYPE_FILESYSTEM
);
3833 clp
= changelist_gather(zhp
, ZFS_PROP_MOUNTPOINT
,
3834 CL_GATHER_MOUNT_ALWAYS
, 0);
3837 /* mount and share received datasets */
3838 err
= changelist_postfix(clp
);
3839 changelist_free(clp
);
3842 if (zhp
== NULL
|| clp
== NULL
|| err
)