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.
30 * Copyright 2016 Igor Kozhukhov <ikozhukhov@gmail.com>
31 * Copyright (c) 2017, loli10K <ezomori.nozomu@gmail.com>. All rights reserved.
44 #include <sys/mount.h>
45 #include <sys/mntent.h>
46 #include <sys/mnttab.h>
48 #include <sys/debug.h>
56 #include <libzfs_core.h>
58 #include "zfs_namecheck.h"
60 #include "zfs_fletcher.h"
61 #include "libzfs_impl.h"
63 #include <sys/zio_checksum.h>
64 #include <sys/dsl_crypt.h>
66 #include <sys/socket.h>
69 /* in libzfs_dataset.c */
70 extern void zfs_setprop_error(libzfs_handle_t
*, zfs_prop_t
, int, char *);
72 static int zfs_receive_impl(libzfs_handle_t
*, const char *, const char *,
73 recvflags_t
*, int, const char *, nvlist_t
*, avl_tree_t
*, char **, int,
74 uint64_t *, const char *, nvlist_t
*);
75 static int guid_to_name(libzfs_handle_t
*, const char *,
76 uint64_t, boolean_t
, char *);
78 static const zio_cksum_t zero_cksum
= { { 0 } };
80 typedef struct dedup_arg
{
83 libzfs_handle_t
*dedup_hdl
;
86 typedef struct progress_arg
{
89 boolean_t pa_parsable
;
92 typedef struct dataref
{
98 typedef struct dedup_entry
{
99 struct dedup_entry
*dde_next
;
100 zio_cksum_t dde_chksum
;
105 #define MAX_DDT_PHYSMEM_PERCENT 20
106 #define SMALLEST_POSSIBLE_MAX_DDT_MB 128
108 typedef struct dedup_table
{
109 dedup_entry_t
**dedup_hash_array
;
110 umem_cache_t
*ddecache
;
111 uint64_t max_ddt_size
; /* max dedup table size in bytes */
112 uint64_t cur_ddt_size
; /* current dedup table size in bytes */
119 high_order_bit(uint64_t n
)
123 for (count
= 0; n
!= 0; count
++)
129 ssread(void *buf
, size_t len
, FILE *stream
)
133 if ((outlen
= fread(buf
, len
, 1, stream
)) == 0)
140 ddt_hash_append(libzfs_handle_t
*hdl
, dedup_table_t
*ddt
, dedup_entry_t
**ddepp
,
141 zio_cksum_t
*cs
, uint64_t prop
, dataref_t
*dr
)
145 if (ddt
->cur_ddt_size
>= ddt
->max_ddt_size
) {
146 if (ddt
->ddt_full
== B_FALSE
) {
147 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
148 "Dedup table full. Deduplication will continue "
149 "with existing table entries"));
150 ddt
->ddt_full
= B_TRUE
;
155 if ((dde
= umem_cache_alloc(ddt
->ddecache
, UMEM_DEFAULT
))
157 assert(*ddepp
== NULL
);
158 dde
->dde_next
= NULL
;
159 dde
->dde_chksum
= *cs
;
160 dde
->dde_prop
= prop
;
163 ddt
->cur_ddt_size
+= sizeof (dedup_entry_t
);
169 * Using the specified dedup table, do a lookup for an entry with
170 * the checksum cs. If found, return the block's reference info
171 * in *dr. Otherwise, insert a new entry in the dedup table, using
172 * the reference information specified by *dr.
174 * return value: true - entry was found
175 * false - entry was not found
178 ddt_update(libzfs_handle_t
*hdl
, dedup_table_t
*ddt
, zio_cksum_t
*cs
,
179 uint64_t prop
, dataref_t
*dr
)
182 dedup_entry_t
**ddepp
;
184 hashcode
= BF64_GET(cs
->zc_word
[0], 0, ddt
->numhashbits
);
186 for (ddepp
= &(ddt
->dedup_hash_array
[hashcode
]); *ddepp
!= NULL
;
187 ddepp
= &((*ddepp
)->dde_next
)) {
188 if (ZIO_CHECKSUM_EQUAL(((*ddepp
)->dde_chksum
), *cs
) &&
189 (*ddepp
)->dde_prop
== prop
) {
190 *dr
= (*ddepp
)->dde_ref
;
194 ddt_hash_append(hdl
, ddt
, ddepp
, cs
, prop
, dr
);
199 dump_record(dmu_replay_record_t
*drr
, void *payload
, int payload_len
,
200 zio_cksum_t
*zc
, int outfd
)
202 ASSERT3U(offsetof(dmu_replay_record_t
, drr_u
.drr_checksum
.drr_checksum
),
203 ==, sizeof (dmu_replay_record_t
) - sizeof (zio_cksum_t
));
204 fletcher_4_incremental_native(drr
,
205 offsetof(dmu_replay_record_t
, drr_u
.drr_checksum
.drr_checksum
), zc
);
206 if (drr
->drr_type
!= DRR_BEGIN
) {
207 ASSERT(ZIO_CHECKSUM_IS_ZERO(&drr
->drr_u
.
208 drr_checksum
.drr_checksum
));
209 drr
->drr_u
.drr_checksum
.drr_checksum
= *zc
;
211 fletcher_4_incremental_native(&drr
->drr_u
.drr_checksum
.drr_checksum
,
212 sizeof (zio_cksum_t
), zc
);
213 if (write(outfd
, drr
, sizeof (*drr
)) == -1)
215 if (payload_len
!= 0) {
216 fletcher_4_incremental_native(payload
, payload_len
, zc
);
217 if (write(outfd
, payload
, payload_len
) == -1)
224 * This function is started in a separate thread when the dedup option
225 * has been requested. The main send thread determines the list of
226 * snapshots to be included in the send stream and makes the ioctl calls
227 * for each one. But instead of having the ioctl send the output to the
228 * the output fd specified by the caller of zfs_send()), the
229 * ioctl is told to direct the output to a pipe, which is read by the
230 * alternate thread running THIS function. This function does the
232 * 1. building a dedup table (the DDT)
233 * 2. doing checksums on each data block and inserting a record in the DDT
234 * 3. looking for matching checksums, and
235 * 4. sending a DRR_WRITE_BYREF record instead of a write record whenever
236 * a duplicate block is found.
237 * The output of this function then goes to the output fd requested
238 * by the caller of zfs_send().
243 dedup_arg_t
*dda
= arg
;
244 char *buf
= zfs_alloc(dda
->dedup_hdl
, SPA_MAXBLOCKSIZE
);
245 dmu_replay_record_t thedrr
= { 0 };
246 dmu_replay_record_t
*drr
= &thedrr
;
250 zio_cksum_t stream_cksum
;
254 ddt
.max_ddt_size
= SMALLEST_POSSIBLE_MAX_DDT_MB
<< 20;
256 uint64_t physmem
= sysconf(_SC_PHYS_PAGES
) * sysconf(_SC_PAGESIZE
);
258 MAX((physmem
* MAX_DDT_PHYSMEM_PERCENT
) / 100,
259 SMALLEST_POSSIBLE_MAX_DDT_MB
<< 20);
262 numbuckets
= ddt
.max_ddt_size
/ (sizeof (dedup_entry_t
));
265 * numbuckets must be a power of 2. Increase number to
266 * a power of 2 if necessary.
268 if (!ISP2(numbuckets
))
269 numbuckets
= 1ULL << high_order_bit(numbuckets
);
271 ddt
.dedup_hash_array
= calloc(numbuckets
, sizeof (dedup_entry_t
*));
272 ddt
.ddecache
= umem_cache_create("dde", sizeof (dedup_entry_t
), 0,
273 NULL
, NULL
, NULL
, NULL
, NULL
, 0);
274 ddt
.cur_ddt_size
= numbuckets
* sizeof (dedup_entry_t
*);
275 ddt
.numhashbits
= high_order_bit(numbuckets
) - 1;
276 ddt
.ddt_full
= B_FALSE
;
278 outfd
= dda
->outputfd
;
279 ofp
= fdopen(dda
->inputfd
, "r");
280 while (ssread(drr
, sizeof (*drr
), ofp
) != 0) {
283 * kernel filled in checksum, we are going to write same
284 * record, but need to regenerate checksum.
286 if (drr
->drr_type
!= DRR_BEGIN
) {
287 bzero(&drr
->drr_u
.drr_checksum
.drr_checksum
,
288 sizeof (drr
->drr_u
.drr_checksum
.drr_checksum
));
291 switch (drr
->drr_type
) {
294 struct drr_begin
*drrb
= &drr
->drr_u
.drr_begin
;
297 ZIO_SET_CHECKSUM(&stream_cksum
, 0, 0, 0, 0);
299 ASSERT3U(drrb
->drr_magic
, ==, DMU_BACKUP_MAGIC
);
301 /* set the DEDUP feature flag for this stream */
302 fflags
= DMU_GET_FEATUREFLAGS(drrb
->drr_versioninfo
);
303 fflags
|= (DMU_BACKUP_FEATURE_DEDUP
|
304 DMU_BACKUP_FEATURE_DEDUPPROPS
);
305 DMU_SET_FEATUREFLAGS(drrb
->drr_versioninfo
, fflags
);
307 if (drr
->drr_payloadlen
!= 0) {
308 sz
= drr
->drr_payloadlen
;
310 if (sz
> SPA_MAXBLOCKSIZE
) {
311 buf
= zfs_realloc(dda
->dedup_hdl
, buf
,
312 SPA_MAXBLOCKSIZE
, sz
);
314 (void) ssread(buf
, sz
, ofp
);
318 if (dump_record(drr
, buf
, sz
, &stream_cksum
,
326 struct drr_end
*drre
= &drr
->drr_u
.drr_end
;
327 /* use the recalculated checksum */
328 drre
->drr_checksum
= stream_cksum
;
329 if (dump_record(drr
, NULL
, 0, &stream_cksum
,
337 struct drr_object
*drro
= &drr
->drr_u
.drr_object
;
338 if (drro
->drr_bonuslen
> 0) {
340 DRR_OBJECT_PAYLOAD_SIZE(drro
), ofp
);
342 if (dump_record(drr
, buf
, DRR_OBJECT_PAYLOAD_SIZE(drro
),
343 &stream_cksum
, outfd
) != 0)
350 struct drr_spill
*drrs
= &drr
->drr_u
.drr_spill
;
351 (void) ssread(buf
, DRR_SPILL_PAYLOAD_SIZE(drrs
), ofp
);
352 if (dump_record(drr
, buf
, DRR_SPILL_PAYLOAD_SIZE(drrs
),
353 &stream_cksum
, outfd
) != 0)
358 case DRR_FREEOBJECTS
:
360 if (dump_record(drr
, NULL
, 0, &stream_cksum
,
368 struct drr_write
*drrw
= &drr
->drr_u
.drr_write
;
370 uint64_t payload_size
;
372 payload_size
= DRR_WRITE_PAYLOAD_SIZE(drrw
);
373 (void) ssread(buf
, payload_size
, ofp
);
376 * Use the existing checksum if it's dedup-capable,
377 * else calculate a SHA256 checksum for it.
380 if (ZIO_CHECKSUM_EQUAL(drrw
->drr_key
.ddk_cksum
,
382 !DRR_IS_DEDUP_CAPABLE(drrw
->drr_flags
)) {
384 zio_cksum_t tmpsha256
;
386 SHA2Init(SHA256
, &ctx
);
387 SHA2Update(&ctx
, buf
, payload_size
);
388 SHA2Final(&tmpsha256
, &ctx
);
390 drrw
->drr_key
.ddk_cksum
.zc_word
[0] =
391 BE_64(tmpsha256
.zc_word
[0]);
392 drrw
->drr_key
.ddk_cksum
.zc_word
[1] =
393 BE_64(tmpsha256
.zc_word
[1]);
394 drrw
->drr_key
.ddk_cksum
.zc_word
[2] =
395 BE_64(tmpsha256
.zc_word
[2]);
396 drrw
->drr_key
.ddk_cksum
.zc_word
[3] =
397 BE_64(tmpsha256
.zc_word
[3]);
398 drrw
->drr_checksumtype
= ZIO_CHECKSUM_SHA256
;
399 drrw
->drr_flags
|= DRR_CHECKSUM_DEDUP
;
402 dataref
.ref_guid
= drrw
->drr_toguid
;
403 dataref
.ref_object
= drrw
->drr_object
;
404 dataref
.ref_offset
= drrw
->drr_offset
;
406 if (ddt_update(dda
->dedup_hdl
, &ddt
,
407 &drrw
->drr_key
.ddk_cksum
, drrw
->drr_key
.ddk_prop
,
409 dmu_replay_record_t wbr_drr
= {0};
410 struct drr_write_byref
*wbr_drrr
=
411 &wbr_drr
.drr_u
.drr_write_byref
;
413 /* block already present in stream */
414 wbr_drr
.drr_type
= DRR_WRITE_BYREF
;
416 wbr_drrr
->drr_object
= drrw
->drr_object
;
417 wbr_drrr
->drr_offset
= drrw
->drr_offset
;
418 wbr_drrr
->drr_length
= drrw
->drr_logical_size
;
419 wbr_drrr
->drr_toguid
= drrw
->drr_toguid
;
420 wbr_drrr
->drr_refguid
= dataref
.ref_guid
;
421 wbr_drrr
->drr_refobject
=
423 wbr_drrr
->drr_refoffset
=
426 wbr_drrr
->drr_checksumtype
=
427 drrw
->drr_checksumtype
;
428 wbr_drrr
->drr_flags
= drrw
->drr_flags
;
429 wbr_drrr
->drr_key
.ddk_cksum
=
430 drrw
->drr_key
.ddk_cksum
;
431 wbr_drrr
->drr_key
.ddk_prop
=
432 drrw
->drr_key
.ddk_prop
;
434 if (dump_record(&wbr_drr
, NULL
, 0,
435 &stream_cksum
, outfd
) != 0)
438 /* block not previously seen */
439 if (dump_record(drr
, buf
, payload_size
,
440 &stream_cksum
, outfd
) != 0)
446 case DRR_WRITE_EMBEDDED
:
448 struct drr_write_embedded
*drrwe
=
449 &drr
->drr_u
.drr_write_embedded
;
451 P2ROUNDUP((uint64_t)drrwe
->drr_psize
, 8), ofp
);
452 if (dump_record(drr
, buf
,
453 P2ROUNDUP((uint64_t)drrwe
->drr_psize
, 8),
454 &stream_cksum
, outfd
) != 0)
461 if (dump_record(drr
, NULL
, 0, &stream_cksum
,
467 case DRR_OBJECT_RANGE
:
469 if (dump_record(drr
, NULL
, 0, &stream_cksum
,
476 (void) fprintf(stderr
, "INVALID record type 0x%x\n",
478 /* should never happen, so assert */
483 umem_cache_destroy(ddt
.ddecache
);
484 free(ddt
.dedup_hash_array
);
492 * Routines for dealing with the AVL tree of fs-nvlists
494 typedef struct fsavl_node
{
502 fsavl_compare(const void *arg1
, const void *arg2
)
504 const fsavl_node_t
*fn1
= (const fsavl_node_t
*)arg1
;
505 const fsavl_node_t
*fn2
= (const fsavl_node_t
*)arg2
;
507 return (AVL_CMP(fn1
->fn_guid
, fn2
->fn_guid
));
511 * Given the GUID of a snapshot, find its containing filesystem and
515 fsavl_find(avl_tree_t
*avl
, uint64_t snapguid
, char **snapname
)
517 fsavl_node_t fn_find
;
520 fn_find
.fn_guid
= snapguid
;
522 fn
= avl_find(avl
, &fn_find
, NULL
);
525 *snapname
= fn
->fn_snapname
;
526 return (fn
->fn_nvfs
);
532 fsavl_destroy(avl_tree_t
*avl
)
541 while ((fn
= avl_destroy_nodes(avl
, &cookie
)) != NULL
)
548 * Given an nvlist, produce an avl tree of snapshots, ordered by guid
551 fsavl_create(nvlist_t
*fss
)
554 nvpair_t
*fselem
= NULL
;
556 if ((fsavl
= malloc(sizeof (avl_tree_t
))) == NULL
)
559 avl_create(fsavl
, fsavl_compare
, sizeof (fsavl_node_t
),
560 offsetof(fsavl_node_t
, fn_node
));
562 while ((fselem
= nvlist_next_nvpair(fss
, fselem
)) != NULL
) {
563 nvlist_t
*nvfs
, *snaps
;
564 nvpair_t
*snapelem
= NULL
;
566 VERIFY(0 == nvpair_value_nvlist(fselem
, &nvfs
));
567 VERIFY(0 == nvlist_lookup_nvlist(nvfs
, "snaps", &snaps
));
570 nvlist_next_nvpair(snaps
, snapelem
)) != NULL
) {
574 VERIFY(0 == nvpair_value_uint64(snapelem
, &guid
));
575 if ((fn
= malloc(sizeof (fsavl_node_t
))) == NULL
) {
576 fsavl_destroy(fsavl
);
580 fn
->fn_snapname
= nvpair_name(snapelem
);
584 * Note: if there are multiple snaps with the
585 * same GUID, we ignore all but one.
587 if (avl_find(fsavl
, fn
, NULL
) == NULL
)
598 * Routines for dealing with the giant nvlist of fs-nvlists, etc.
600 typedef struct send_data
{
602 * assigned inside every recursive call,
603 * restored from *_save on return:
605 * guid of fromsnap snapshot in parent dataset
606 * txg of fromsnap snapshot in current dataset
607 * txg of tosnap snapshot in current dataset
610 uint64_t parent_fromsnap_guid
;
611 uint64_t fromsnap_txg
;
614 /* the nvlists get accumulated during depth-first traversal */
615 nvlist_t
*parent_snaps
;
619 /* send-receive configuration, does not change during traversal */
621 const char *fromsnap
;
630 * The header nvlist is of the following format:
633 * "fromsnap" -> string (if incremental)
637 * "name" -> string (full name; for debugging)
638 * "parentfromsnap" -> number (guid of fromsnap in parent)
640 * "props" -> { name -> value (only if set here) }
641 * "snaps" -> { name (lastname) -> number (guid) }
642 * "snapprops" -> { name (lastname) -> { name -> value } }
644 * "origin" -> number (guid) (if clone)
645 * "is_encroot" -> boolean
646 * "sent" -> boolean (not on-disk)
654 static void send_iterate_prop(zfs_handle_t
*zhp
, nvlist_t
*nv
);
657 send_iterate_snap(zfs_handle_t
*zhp
, void *arg
)
659 send_data_t
*sd
= arg
;
660 uint64_t guid
= zhp
->zfs_dmustats
.dds_guid
;
661 uint64_t txg
= zhp
->zfs_dmustats
.dds_creation_txg
;
664 boolean_t isfromsnap
, istosnap
, istosnapwithnofrom
;
666 snapname
= strrchr(zhp
->zfs_name
, '@')+1;
667 isfromsnap
= (sd
->fromsnap
!= NULL
&&
668 strcmp(sd
->fromsnap
, snapname
) == 0);
669 istosnap
= (sd
->tosnap
!= NULL
&& (strcmp(sd
->tosnap
, snapname
) == 0));
670 istosnapwithnofrom
= (istosnap
&& sd
->fromsnap
== NULL
);
672 if (sd
->tosnap_txg
!= 0 && txg
> sd
->tosnap_txg
) {
674 (void) fprintf(stderr
, dgettext(TEXT_DOMAIN
,
675 "skipping snapshot %s because it was created "
676 "after the destination snapshot (%s)\n"),
677 zhp
->zfs_name
, sd
->tosnap
);
683 VERIFY(0 == nvlist_add_uint64(sd
->parent_snaps
, snapname
, guid
));
685 * NB: if there is no fromsnap here (it's a newly created fs in
686 * an incremental replication), we will substitute the tosnap.
688 if (isfromsnap
|| (sd
->parent_fromsnap_guid
== 0 && istosnap
)) {
689 sd
->parent_fromsnap_guid
= guid
;
692 if (!sd
->recursive
) {
693 if (!sd
->seenfrom
&& isfromsnap
) {
694 sd
->seenfrom
= B_TRUE
;
699 if ((sd
->seento
|| !sd
->seenfrom
) && !istosnapwithnofrom
) {
708 VERIFY(0 == nvlist_alloc(&nv
, NV_UNIQUE_NAME
, 0));
709 send_iterate_prop(zhp
, nv
);
710 VERIFY(0 == nvlist_add_nvlist(sd
->snapprops
, snapname
, nv
));
718 send_iterate_prop(zfs_handle_t
*zhp
, nvlist_t
*nv
)
720 nvpair_t
*elem
= NULL
;
722 while ((elem
= nvlist_next_nvpair(zhp
->zfs_props
, elem
)) != NULL
) {
723 char *propname
= nvpair_name(elem
);
724 zfs_prop_t prop
= zfs_name_to_prop(propname
);
727 if (!zfs_prop_user(propname
)) {
729 * Realistically, this should never happen. However,
730 * we want the ability to add DSL properties without
731 * needing to make incompatible version changes. We
732 * need to ignore unknown properties to allow older
733 * software to still send datasets containing these
734 * properties, with the unknown properties elided.
736 if (prop
== ZPROP_INVAL
)
739 if (zfs_prop_readonly(prop
))
743 verify(nvpair_value_nvlist(elem
, &propnv
) == 0);
744 if (prop
== ZFS_PROP_QUOTA
|| prop
== ZFS_PROP_RESERVATION
||
745 prop
== ZFS_PROP_REFQUOTA
||
746 prop
== ZFS_PROP_REFRESERVATION
) {
749 verify(nvlist_lookup_uint64(propnv
,
750 ZPROP_VALUE
, &value
) == 0);
751 if (zhp
->zfs_type
== ZFS_TYPE_SNAPSHOT
)
754 * May have no source before SPA_VERSION_RECVD_PROPS,
755 * but is still modifiable.
757 if (nvlist_lookup_string(propnv
,
758 ZPROP_SOURCE
, &source
) == 0) {
759 if ((strcmp(source
, zhp
->zfs_name
) != 0) &&
761 ZPROP_SOURCE_VAL_RECVD
) != 0))
766 if (nvlist_lookup_string(propnv
,
767 ZPROP_SOURCE
, &source
) != 0)
769 if ((strcmp(source
, zhp
->zfs_name
) != 0) &&
770 (strcmp(source
, ZPROP_SOURCE_VAL_RECVD
) != 0))
774 if (zfs_prop_user(propname
) ||
775 zfs_prop_get_type(prop
) == PROP_TYPE_STRING
) {
777 verify(nvlist_lookup_string(propnv
,
778 ZPROP_VALUE
, &value
) == 0);
779 VERIFY(0 == nvlist_add_string(nv
, propname
, value
));
782 verify(nvlist_lookup_uint64(propnv
,
783 ZPROP_VALUE
, &value
) == 0);
784 VERIFY(0 == nvlist_add_uint64(nv
, propname
, value
));
790 * returns snapshot creation txg
791 * and returns 0 if the snapshot does not exist
794 get_snap_txg(libzfs_handle_t
*hdl
, const char *fs
, const char *snap
)
796 char name
[ZFS_MAX_DATASET_NAME_LEN
];
799 if (fs
== NULL
|| fs
[0] == '\0' || snap
== NULL
|| snap
[0] == '\0')
802 (void) snprintf(name
, sizeof (name
), "%s@%s", fs
, snap
);
803 if (zfs_dataset_exists(hdl
, name
, ZFS_TYPE_SNAPSHOT
)) {
804 zfs_handle_t
*zhp
= zfs_open(hdl
, name
, ZFS_TYPE_SNAPSHOT
);
806 txg
= zfs_prop_get_int(zhp
, ZFS_PROP_CREATETXG
);
815 * recursively generate nvlists describing datasets. See comment
816 * for the data structure send_data_t above for description of contents
820 send_iterate_fs(zfs_handle_t
*zhp
, void *arg
)
822 send_data_t
*sd
= arg
;
823 nvlist_t
*nvfs
= NULL
, *nv
= NULL
;
825 uint64_t parent_fromsnap_guid_save
= sd
->parent_fromsnap_guid
;
826 uint64_t fromsnap_txg_save
= sd
->fromsnap_txg
;
827 uint64_t tosnap_txg_save
= sd
->tosnap_txg
;
828 uint64_t txg
= zhp
->zfs_dmustats
.dds_creation_txg
;
829 uint64_t guid
= zhp
->zfs_dmustats
.dds_guid
;
830 uint64_t fromsnap_txg
, tosnap_txg
;
833 fromsnap_txg
= get_snap_txg(zhp
->zfs_hdl
, zhp
->zfs_name
, sd
->fromsnap
);
834 if (fromsnap_txg
!= 0)
835 sd
->fromsnap_txg
= fromsnap_txg
;
837 tosnap_txg
= get_snap_txg(zhp
->zfs_hdl
, zhp
->zfs_name
, sd
->tosnap
);
839 sd
->tosnap_txg
= tosnap_txg
;
842 * on the send side, if the current dataset does not have tosnap,
843 * perform two additional checks:
845 * - skip sending the current dataset if it was created later than
847 * - return error if the current dataset was created earlier than
850 if (sd
->tosnap
!= NULL
&& tosnap_txg
== 0) {
851 if (sd
->tosnap_txg
!= 0 && txg
> sd
->tosnap_txg
) {
853 (void) fprintf(stderr
, dgettext(TEXT_DOMAIN
,
854 "skipping dataset %s: snapshot %s does "
855 "not exist\n"), zhp
->zfs_name
, sd
->tosnap
);
858 (void) fprintf(stderr
, dgettext(TEXT_DOMAIN
,
859 "cannot send %s@%s%s: snapshot %s@%s does not "
860 "exist\n"), sd
->fsname
, sd
->tosnap
, sd
->recursive
?
861 dgettext(TEXT_DOMAIN
, " recursively") : "",
862 zhp
->zfs_name
, sd
->tosnap
);
868 VERIFY(0 == nvlist_alloc(&nvfs
, NV_UNIQUE_NAME
, 0));
869 VERIFY(0 == nvlist_add_string(nvfs
, "name", zhp
->zfs_name
));
870 VERIFY(0 == nvlist_add_uint64(nvfs
, "parentfromsnap",
871 sd
->parent_fromsnap_guid
));
873 if (zhp
->zfs_dmustats
.dds_origin
[0]) {
874 zfs_handle_t
*origin
= zfs_open(zhp
->zfs_hdl
,
875 zhp
->zfs_dmustats
.dds_origin
, ZFS_TYPE_SNAPSHOT
);
876 if (origin
== NULL
) {
880 VERIFY(0 == nvlist_add_uint64(nvfs
, "origin",
881 origin
->zfs_dmustats
.dds_guid
));
886 /* iterate over props */
887 VERIFY(0 == nvlist_alloc(&nv
, NV_UNIQUE_NAME
, 0));
888 send_iterate_prop(zhp
, nv
);
890 if (zfs_prop_get_int(zhp
, ZFS_PROP_ENCRYPTION
) != ZIO_CRYPT_OFF
) {
893 /* determine if this dataset is an encryption root */
894 if (zfs_crypto_get_encryption_root(zhp
, &encroot
, NULL
) != 0) {
900 VERIFY(0 == nvlist_add_boolean(nvfs
, "is_encroot"));
903 * Encrypted datasets can only be sent with properties if
904 * the raw flag is specified because the receive side doesn't
905 * currently have a mechanism for recursively asking the user
906 * for new encryption parameters.
909 (void) fprintf(stderr
, dgettext(TEXT_DOMAIN
,
910 "cannot send %s@%s: encrypted dataset %s may not "
911 "be sent with properties without the raw flag\n"),
912 sd
->fsname
, sd
->tosnap
, zhp
->zfs_name
);
919 VERIFY(0 == nvlist_add_nvlist(nvfs
, "props", nv
));
921 /* iterate over snaps, and set sd->parent_fromsnap_guid */
922 sd
->parent_fromsnap_guid
= 0;
923 VERIFY(0 == nvlist_alloc(&sd
->parent_snaps
, NV_UNIQUE_NAME
, 0));
924 VERIFY(0 == nvlist_alloc(&sd
->snapprops
, NV_UNIQUE_NAME
, 0));
925 (void) zfs_iter_snapshots_sorted(zhp
, send_iterate_snap
, sd
);
926 VERIFY(0 == nvlist_add_nvlist(nvfs
, "snaps", sd
->parent_snaps
));
927 VERIFY(0 == nvlist_add_nvlist(nvfs
, "snapprops", sd
->snapprops
));
928 nvlist_free(sd
->parent_snaps
);
929 nvlist_free(sd
->snapprops
);
931 /* add this fs to nvlist */
932 (void) snprintf(guidstring
, sizeof (guidstring
),
933 "0x%llx", (longlong_t
)guid
);
934 VERIFY(0 == nvlist_add_nvlist(sd
->fss
, guidstring
, nvfs
));
936 /* iterate over children */
938 rv
= zfs_iter_filesystems(zhp
, send_iterate_fs
, sd
);
941 sd
->parent_fromsnap_guid
= parent_fromsnap_guid_save
;
942 sd
->fromsnap_txg
= fromsnap_txg_save
;
943 sd
->tosnap_txg
= tosnap_txg_save
;
952 gather_nvlist(libzfs_handle_t
*hdl
, const char *fsname
, const char *fromsnap
,
953 const char *tosnap
, boolean_t recursive
, boolean_t raw
, boolean_t verbose
,
954 nvlist_t
**nvlp
, avl_tree_t
**avlp
)
957 send_data_t sd
= { 0 };
960 zhp
= zfs_open(hdl
, fsname
, ZFS_TYPE_FILESYSTEM
| ZFS_TYPE_VOLUME
);
962 return (EZFS_BADTYPE
);
964 VERIFY(0 == nvlist_alloc(&sd
.fss
, NV_UNIQUE_NAME
, 0));
966 sd
.fromsnap
= fromsnap
;
968 sd
.recursive
= recursive
;
970 sd
.verbose
= verbose
;
972 if ((error
= send_iterate_fs(zhp
, &sd
)) != 0) {
980 if (avlp
!= NULL
&& (*avlp
= fsavl_create(sd
.fss
)) == NULL
) {
991 * Routines specific to "zfs send"
993 typedef struct send_dump_data
{
994 /* these are all just the short snapname (the part after the @) */
995 const char *fromsnap
;
997 char prevsnap
[ZFS_MAX_DATASET_NAME_LEN
];
998 uint64_t prevsnap_obj
;
999 boolean_t seenfrom
, seento
, replicate
, doall
, fromorigin
;
1000 boolean_t verbose
, dryrun
, parsable
, progress
, embed_data
, std_out
;
1001 boolean_t large_block
, compress
, raw
;
1005 nvlist_t
*snapholds
;
1007 snapfilter_cb_t
*filter_cb
;
1008 void *filter_cb_arg
;
1010 char holdtag
[ZFS_MAX_DATASET_NAME_LEN
];
1016 zfs_send_space(zfs_handle_t
*zhp
, const char *snapname
, const char *from
,
1017 enum lzc_send_flags flags
, uint64_t *spacep
)
1019 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
1022 assert(snapname
!= NULL
);
1023 error
= lzc_send_space(snapname
, from
, flags
, spacep
);
1027 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
1028 "warning: cannot estimate space for '%s'"), snapname
);
1032 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1033 "not an earlier snapshot from the same fs"));
1034 return (zfs_error(hdl
, EZFS_CROSSTARGET
, errbuf
));
1037 if (zfs_dataset_exists(hdl
, snapname
,
1038 ZFS_TYPE_SNAPSHOT
)) {
1039 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1040 "incremental source (%s) does not exist"),
1043 return (zfs_error(hdl
, EZFS_NOENT
, errbuf
));
1057 zfs_error_aux(hdl
, strerror(error
));
1058 return (zfs_error(hdl
, EZFS_BADBACKUP
, errbuf
));
1061 return (zfs_standard_error(hdl
, error
, errbuf
));
1069 * Dumps a backup of the given snapshot (incremental from fromsnap if it's not
1070 * NULL) to the file descriptor specified by outfd.
1073 dump_ioctl(zfs_handle_t
*zhp
, const char *fromsnap
, uint64_t fromsnap_obj
,
1074 boolean_t fromorigin
, int outfd
, enum lzc_send_flags flags
,
1077 zfs_cmd_t zc
= {"\0"};
1078 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
1081 assert(zhp
->zfs_type
== ZFS_TYPE_SNAPSHOT
);
1082 assert(fromsnap_obj
== 0 || !fromorigin
);
1084 (void) strlcpy(zc
.zc_name
, zhp
->zfs_name
, sizeof (zc
.zc_name
));
1085 zc
.zc_cookie
= outfd
;
1086 zc
.zc_obj
= fromorigin
;
1087 zc
.zc_sendobj
= zfs_prop_get_int(zhp
, ZFS_PROP_OBJSETID
);
1088 zc
.zc_fromobj
= fromsnap_obj
;
1089 zc
.zc_flags
= flags
;
1091 VERIFY(0 == nvlist_alloc(&thisdbg
, NV_UNIQUE_NAME
, 0));
1092 if (fromsnap
&& fromsnap
[0] != '\0') {
1093 VERIFY(0 == nvlist_add_string(thisdbg
,
1094 "fromsnap", fromsnap
));
1097 if (zfs_ioctl(zhp
->zfs_hdl
, ZFS_IOC_SEND
, &zc
) != 0) {
1099 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
1100 "warning: cannot send '%s'"), zhp
->zfs_name
);
1102 VERIFY(0 == nvlist_add_uint64(thisdbg
, "error", errno
));
1104 VERIFY(0 == nvlist_add_nvlist(debugnv
,
1105 zhp
->zfs_name
, thisdbg
));
1107 nvlist_free(thisdbg
);
1111 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1112 "not an earlier snapshot from the same fs"));
1113 return (zfs_error(hdl
, EZFS_CROSSTARGET
, errbuf
));
1116 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1117 "source key must be loaded"));
1118 return (zfs_error(hdl
, EZFS_CRYPTOFAILED
, errbuf
));
1121 if (zfs_dataset_exists(hdl
, zc
.zc_name
,
1122 ZFS_TYPE_SNAPSHOT
)) {
1123 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1124 "incremental source (@%s) does not exist"),
1127 return (zfs_error(hdl
, EZFS_NOENT
, errbuf
));
1140 zfs_error_aux(hdl
, strerror(errno
));
1141 return (zfs_error(hdl
, EZFS_BADBACKUP
, errbuf
));
1144 return (zfs_standard_error(hdl
, errno
, errbuf
));
1149 VERIFY(0 == nvlist_add_nvlist(debugnv
, zhp
->zfs_name
, thisdbg
));
1150 nvlist_free(thisdbg
);
1156 gather_holds(zfs_handle_t
*zhp
, send_dump_data_t
*sdd
)
1158 assert(zhp
->zfs_type
== ZFS_TYPE_SNAPSHOT
);
1161 * zfs_send() only sets snapholds for sends that need them,
1162 * e.g. replication and doall.
1164 if (sdd
->snapholds
== NULL
)
1167 fnvlist_add_string(sdd
->snapholds
, zhp
->zfs_name
, sdd
->holdtag
);
1171 send_progress_thread(void *arg
)
1173 progress_arg_t
*pa
= arg
;
1174 zfs_cmd_t zc
= {"\0"};
1175 zfs_handle_t
*zhp
= pa
->pa_zhp
;
1176 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
1177 unsigned long long bytes
;
1182 (void) strlcpy(zc
.zc_name
, zhp
->zfs_name
, sizeof (zc
.zc_name
));
1184 if (!pa
->pa_parsable
)
1185 (void) fprintf(stderr
, "TIME SENT SNAPSHOT\n");
1188 * Print the progress from ZFS_IOC_SEND_PROGRESS every second.
1193 zc
.zc_cookie
= pa
->pa_fd
;
1194 if (zfs_ioctl(hdl
, ZFS_IOC_SEND_PROGRESS
, &zc
) != 0)
1195 return ((void *)-1);
1199 bytes
= zc
.zc_cookie
;
1201 if (pa
->pa_parsable
) {
1202 (void) fprintf(stderr
, "%02d:%02d:%02d\t%llu\t%s\n",
1203 tm
->tm_hour
, tm
->tm_min
, tm
->tm_sec
,
1204 bytes
, zhp
->zfs_name
);
1206 zfs_nicebytes(bytes
, buf
, sizeof (buf
));
1207 (void) fprintf(stderr
, "%02d:%02d:%02d %5s %s\n",
1208 tm
->tm_hour
, tm
->tm_min
, tm
->tm_sec
,
1209 buf
, zhp
->zfs_name
);
1215 send_print_verbose(FILE *fout
, const char *tosnap
, const char *fromsnap
,
1216 uint64_t size
, boolean_t parsable
)
1219 if (fromsnap
!= NULL
) {
1220 (void) fprintf(fout
, "incremental\t%s\t%s",
1223 (void) fprintf(fout
, "full\t%s",
1227 if (fromsnap
!= NULL
) {
1228 if (strchr(fromsnap
, '@') == NULL
&&
1229 strchr(fromsnap
, '#') == NULL
) {
1230 (void) fprintf(fout
, dgettext(TEXT_DOMAIN
,
1231 "send from @%s to %s"),
1234 (void) fprintf(fout
, dgettext(TEXT_DOMAIN
,
1235 "send from %s to %s"),
1239 (void) fprintf(fout
, dgettext(TEXT_DOMAIN
,
1246 (void) fprintf(fout
, "\t%llu",
1248 } else if (size
!= 0) {
1250 zfs_nicebytes(size
, buf
, sizeof (buf
));
1251 (void) fprintf(fout
, dgettext(TEXT_DOMAIN
,
1252 " estimated size is %s"), buf
);
1254 (void) fprintf(fout
, "\n");
1258 dump_snapshot(zfs_handle_t
*zhp
, void *arg
)
1260 send_dump_data_t
*sdd
= arg
;
1261 progress_arg_t pa
= { 0 };
1264 enum lzc_send_flags flags
= 0;
1266 boolean_t isfromsnap
, istosnap
, fromorigin
;
1267 boolean_t exclude
= B_FALSE
;
1268 FILE *fout
= sdd
->std_out
? stdout
: stderr
;
1271 thissnap
= strchr(zhp
->zfs_name
, '@') + 1;
1272 isfromsnap
= (sdd
->fromsnap
!= NULL
&&
1273 strcmp(sdd
->fromsnap
, thissnap
) == 0);
1275 if (!sdd
->seenfrom
&& isfromsnap
) {
1276 gather_holds(zhp
, sdd
);
1277 sdd
->seenfrom
= B_TRUE
;
1278 (void) strlcpy(sdd
->prevsnap
, thissnap
,
1279 sizeof (sdd
->prevsnap
));
1280 sdd
->prevsnap_obj
= zfs_prop_get_int(zhp
, ZFS_PROP_OBJSETID
);
1285 if (sdd
->seento
|| !sdd
->seenfrom
) {
1290 istosnap
= (strcmp(sdd
->tosnap
, thissnap
) == 0);
1292 sdd
->seento
= B_TRUE
;
1294 if (sdd
->large_block
)
1295 flags
|= LZC_SEND_FLAG_LARGE_BLOCK
;
1296 if (sdd
->embed_data
)
1297 flags
|= LZC_SEND_FLAG_EMBED_DATA
;
1299 flags
|= LZC_SEND_FLAG_COMPRESS
;
1301 flags
|= LZC_SEND_FLAG_RAW
;
1303 if (!sdd
->doall
&& !isfromsnap
&& !istosnap
) {
1304 if (sdd
->replicate
) {
1306 nvlist_t
*snapprops
;
1308 * Filter out all intermediate snapshots except origin
1309 * snapshots needed to replicate clones.
1311 nvlist_t
*nvfs
= fsavl_find(sdd
->fsavl
,
1312 zhp
->zfs_dmustats
.dds_guid
, &snapname
);
1314 VERIFY(0 == nvlist_lookup_nvlist(nvfs
,
1315 "snapprops", &snapprops
));
1316 VERIFY(0 == nvlist_lookup_nvlist(snapprops
,
1317 thissnap
, &snapprops
));
1318 exclude
= !nvlist_exists(snapprops
, "is_clone_origin");
1325 * If a filter function exists, call it to determine whether
1326 * this snapshot will be sent.
1328 if (exclude
|| (sdd
->filter_cb
!= NULL
&&
1329 sdd
->filter_cb(zhp
, sdd
->filter_cb_arg
) == B_FALSE
)) {
1331 * This snapshot is filtered out. Don't send it, and don't
1332 * set prevsnap_obj, so it will be as if this snapshot didn't
1333 * exist, and the next accepted snapshot will be sent as
1334 * an incremental from the last accepted one, or as the
1335 * first (and full) snapshot in the case of a replication,
1336 * non-incremental send.
1342 gather_holds(zhp
, sdd
);
1343 fromorigin
= sdd
->prevsnap
[0] == '\0' &&
1344 (sdd
->fromorigin
|| sdd
->replicate
);
1348 char fromds
[ZFS_MAX_DATASET_NAME_LEN
];
1350 if (sdd
->prevsnap
[0] != '\0') {
1351 (void) strlcpy(fromds
, zhp
->zfs_name
, sizeof (fromds
));
1352 *(strchr(fromds
, '@') + 1) = '\0';
1353 (void) strlcat(fromds
, sdd
->prevsnap
, sizeof (fromds
));
1355 if (zfs_send_space(zhp
, zhp
->zfs_name
,
1356 sdd
->prevsnap
[0] ? fromds
: NULL
, flags
, &size
) != 0) {
1357 size
= 0; /* cannot estimate send space */
1359 send_print_verbose(fout
, zhp
->zfs_name
,
1360 sdd
->prevsnap
[0] ? sdd
->prevsnap
: NULL
,
1361 size
, sdd
->parsable
);
1368 * If progress reporting is requested, spawn a new thread to
1369 * poll ZFS_IOC_SEND_PROGRESS at a regular interval.
1371 if (sdd
->progress
) {
1373 pa
.pa_fd
= sdd
->outfd
;
1374 pa
.pa_parsable
= sdd
->parsable
;
1376 if ((err
= pthread_create(&tid
, NULL
,
1377 send_progress_thread
, &pa
)) != 0) {
1383 err
= dump_ioctl(zhp
, sdd
->prevsnap
, sdd
->prevsnap_obj
,
1384 fromorigin
, sdd
->outfd
, flags
, sdd
->debugnv
);
1386 if (sdd
->progress
) {
1387 (void) pthread_cancel(tid
);
1388 (void) pthread_join(tid
, NULL
);
1392 (void) strcpy(sdd
->prevsnap
, thissnap
);
1393 sdd
->prevsnap_obj
= zfs_prop_get_int(zhp
, ZFS_PROP_OBJSETID
);
1399 dump_filesystem(zfs_handle_t
*zhp
, void *arg
)
1402 send_dump_data_t
*sdd
= arg
;
1403 boolean_t missingfrom
= B_FALSE
;
1404 zfs_cmd_t zc
= {"\0"};
1406 (void) snprintf(zc
.zc_name
, sizeof (zc
.zc_name
), "%s@%s",
1407 zhp
->zfs_name
, sdd
->tosnap
);
1408 if (ioctl(zhp
->zfs_hdl
->libzfs_fd
, ZFS_IOC_OBJSET_STATS
, &zc
) != 0) {
1409 (void) fprintf(stderr
, dgettext(TEXT_DOMAIN
,
1410 "WARNING: could not send %s@%s: does not exist\n"),
1411 zhp
->zfs_name
, sdd
->tosnap
);
1416 if (sdd
->replicate
&& sdd
->fromsnap
) {
1418 * If this fs does not have fromsnap, and we're doing
1419 * recursive, we need to send a full stream from the
1420 * beginning (or an incremental from the origin if this
1421 * is a clone). If we're doing non-recursive, then let
1422 * them get the error.
1424 (void) snprintf(zc
.zc_name
, sizeof (zc
.zc_name
), "%s@%s",
1425 zhp
->zfs_name
, sdd
->fromsnap
);
1426 if (ioctl(zhp
->zfs_hdl
->libzfs_fd
,
1427 ZFS_IOC_OBJSET_STATS
, &zc
) != 0) {
1428 missingfrom
= B_TRUE
;
1432 sdd
->seenfrom
= sdd
->seento
= sdd
->prevsnap
[0] = 0;
1433 sdd
->prevsnap_obj
= 0;
1434 if (sdd
->fromsnap
== NULL
|| missingfrom
)
1435 sdd
->seenfrom
= B_TRUE
;
1437 rv
= zfs_iter_snapshots_sorted(zhp
, dump_snapshot
, arg
);
1438 if (!sdd
->seenfrom
) {
1439 (void) fprintf(stderr
, dgettext(TEXT_DOMAIN
,
1440 "WARNING: could not send %s@%s:\n"
1441 "incremental source (%s@%s) does not exist\n"),
1442 zhp
->zfs_name
, sdd
->tosnap
,
1443 zhp
->zfs_name
, sdd
->fromsnap
);
1445 } else if (!sdd
->seento
) {
1446 if (sdd
->fromsnap
) {
1447 (void) fprintf(stderr
, dgettext(TEXT_DOMAIN
,
1448 "WARNING: could not send %s@%s:\n"
1449 "incremental source (%s@%s) "
1450 "is not earlier than it\n"),
1451 zhp
->zfs_name
, sdd
->tosnap
,
1452 zhp
->zfs_name
, sdd
->fromsnap
);
1454 (void) fprintf(stderr
, dgettext(TEXT_DOMAIN
,
1456 "could not send %s@%s: does not exist\n"),
1457 zhp
->zfs_name
, sdd
->tosnap
);
1466 dump_filesystems(zfs_handle_t
*rzhp
, void *arg
)
1468 send_dump_data_t
*sdd
= arg
;
1470 boolean_t needagain
, progress
;
1472 if (!sdd
->replicate
)
1473 return (dump_filesystem(rzhp
, sdd
));
1475 /* Mark the clone origin snapshots. */
1476 for (fspair
= nvlist_next_nvpair(sdd
->fss
, NULL
); fspair
;
1477 fspair
= nvlist_next_nvpair(sdd
->fss
, fspair
)) {
1479 uint64_t origin_guid
= 0;
1481 VERIFY(0 == nvpair_value_nvlist(fspair
, &nvfs
));
1482 (void) nvlist_lookup_uint64(nvfs
, "origin", &origin_guid
);
1483 if (origin_guid
!= 0) {
1485 nvlist_t
*origin_nv
= fsavl_find(sdd
->fsavl
,
1486 origin_guid
, &snapname
);
1487 if (origin_nv
!= NULL
) {
1488 nvlist_t
*snapprops
;
1489 VERIFY(0 == nvlist_lookup_nvlist(origin_nv
,
1490 "snapprops", &snapprops
));
1491 VERIFY(0 == nvlist_lookup_nvlist(snapprops
,
1492 snapname
, &snapprops
));
1493 VERIFY(0 == nvlist_add_boolean(
1494 snapprops
, "is_clone_origin"));
1499 needagain
= progress
= B_FALSE
;
1500 for (fspair
= nvlist_next_nvpair(sdd
->fss
, NULL
); fspair
;
1501 fspair
= nvlist_next_nvpair(sdd
->fss
, fspair
)) {
1502 nvlist_t
*fslist
, *parent_nv
;
1506 uint64_t origin_guid
= 0;
1507 uint64_t parent_guid
= 0;
1509 VERIFY(nvpair_value_nvlist(fspair
, &fslist
) == 0);
1510 if (nvlist_lookup_boolean(fslist
, "sent") == 0)
1513 VERIFY(nvlist_lookup_string(fslist
, "name", &fsname
) == 0);
1514 (void) nvlist_lookup_uint64(fslist
, "origin", &origin_guid
);
1515 (void) nvlist_lookup_uint64(fslist
, "parentfromsnap",
1518 if (parent_guid
!= 0) {
1519 parent_nv
= fsavl_find(sdd
->fsavl
, parent_guid
, NULL
);
1520 if (!nvlist_exists(parent_nv
, "sent")) {
1521 /* parent has not been sent; skip this one */
1527 if (origin_guid
!= 0) {
1528 nvlist_t
*origin_nv
= fsavl_find(sdd
->fsavl
,
1530 if (origin_nv
!= NULL
&&
1531 !nvlist_exists(origin_nv
, "sent")) {
1533 * origin has not been sent yet;
1541 zhp
= zfs_open(rzhp
->zfs_hdl
, fsname
, ZFS_TYPE_DATASET
);
1544 err
= dump_filesystem(zhp
, sdd
);
1545 VERIFY(nvlist_add_boolean(fslist
, "sent") == 0);
1556 /* clean out the sent flags in case we reuse this fss */
1557 for (fspair
= nvlist_next_nvpair(sdd
->fss
, NULL
); fspair
;
1558 fspair
= nvlist_next_nvpair(sdd
->fss
, fspair
)) {
1561 VERIFY(nvpair_value_nvlist(fspair
, &fslist
) == 0);
1562 (void) nvlist_remove_all(fslist
, "sent");
1569 zfs_send_resume_token_to_nvlist(libzfs_handle_t
*hdl
, const char *token
)
1571 unsigned int version
;
1573 unsigned long long checksum
, packed_len
;
1576 * Decode token header, which is:
1577 * <token version>-<checksum of payload>-<uncompressed payload length>
1578 * Note that the only supported token version is 1.
1580 nread
= sscanf(token
, "%u-%llx-%llx-",
1581 &version
, &checksum
, &packed_len
);
1583 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1584 "resume token is corrupt (invalid format)"));
1588 if (version
!= ZFS_SEND_RESUME_TOKEN_VERSION
) {
1589 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1590 "resume token is corrupt (invalid version %u)"),
1595 /* convert hexadecimal representation to binary */
1596 token
= strrchr(token
, '-') + 1;
1597 int len
= strlen(token
) / 2;
1598 unsigned char *compressed
= zfs_alloc(hdl
, len
);
1599 for (i
= 0; i
< len
; i
++) {
1600 nread
= sscanf(token
+ i
* 2, "%2hhx", compressed
+ i
);
1603 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1604 "resume token is corrupt "
1605 "(payload is not hex-encoded)"));
1610 /* verify checksum */
1612 fletcher_4_native_varsize(compressed
, len
, &cksum
);
1613 if (cksum
.zc_word
[0] != checksum
) {
1615 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1616 "resume token is corrupt (incorrect checksum)"));
1621 void *packed
= zfs_alloc(hdl
, packed_len
);
1622 uLongf packed_len_long
= packed_len
;
1623 if (uncompress(packed
, &packed_len_long
, compressed
, len
) != Z_OK
||
1624 packed_len_long
!= packed_len
) {
1627 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1628 "resume token is corrupt (decompression failed)"));
1634 int error
= nvlist_unpack(packed
, packed_len
, &nv
, KM_SLEEP
);
1638 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1639 "resume token is corrupt (nvlist_unpack failed)"));
1646 zfs_send_resume(libzfs_handle_t
*hdl
, sendflags_t
*flags
, int outfd
,
1647 const char *resume_token
)
1651 char *fromname
= NULL
;
1652 uint64_t resumeobj
, resumeoff
, toguid
, fromguid
, bytes
;
1655 char name
[ZFS_MAX_DATASET_NAME_LEN
];
1656 enum lzc_send_flags lzc_flags
= 0;
1657 FILE *fout
= (flags
->verbose
&& flags
->dryrun
) ? stdout
: stderr
;
1659 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
1660 "cannot resume send"));
1662 nvlist_t
*resume_nvl
=
1663 zfs_send_resume_token_to_nvlist(hdl
, resume_token
);
1664 if (resume_nvl
== NULL
) {
1666 * zfs_error_aux has already been set by
1667 * zfs_send_resume_token_to_nvlist
1669 return (zfs_error(hdl
, EZFS_FAULT
, errbuf
));
1671 if (flags
->verbose
) {
1672 (void) fprintf(fout
, dgettext(TEXT_DOMAIN
,
1673 "resume token contents:\n"));
1674 nvlist_print(fout
, resume_nvl
);
1677 if (nvlist_lookup_string(resume_nvl
, "toname", &toname
) != 0 ||
1678 nvlist_lookup_uint64(resume_nvl
, "object", &resumeobj
) != 0 ||
1679 nvlist_lookup_uint64(resume_nvl
, "offset", &resumeoff
) != 0 ||
1680 nvlist_lookup_uint64(resume_nvl
, "bytes", &bytes
) != 0 ||
1681 nvlist_lookup_uint64(resume_nvl
, "toguid", &toguid
) != 0) {
1682 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1683 "resume token is corrupt"));
1684 return (zfs_error(hdl
, EZFS_FAULT
, errbuf
));
1687 (void) nvlist_lookup_uint64(resume_nvl
, "fromguid", &fromguid
);
1689 if (flags
->largeblock
|| nvlist_exists(resume_nvl
, "largeblockok"))
1690 lzc_flags
|= LZC_SEND_FLAG_LARGE_BLOCK
;
1691 if (flags
->embed_data
|| nvlist_exists(resume_nvl
, "embedok"))
1692 lzc_flags
|= LZC_SEND_FLAG_EMBED_DATA
;
1693 if (flags
->compress
|| nvlist_exists(resume_nvl
, "compressok"))
1694 lzc_flags
|= LZC_SEND_FLAG_COMPRESS
;
1695 if (flags
->raw
|| nvlist_exists(resume_nvl
, "rawok"))
1696 lzc_flags
|= LZC_SEND_FLAG_RAW
;
1698 if (guid_to_name(hdl
, toname
, toguid
, B_FALSE
, name
) != 0) {
1699 if (zfs_dataset_exists(hdl
, toname
, ZFS_TYPE_DATASET
)) {
1700 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1701 "'%s' is no longer the same snapshot used in "
1702 "the initial send"), toname
);
1704 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1705 "'%s' used in the initial send no longer exists"),
1708 return (zfs_error(hdl
, EZFS_BADPATH
, errbuf
));
1710 zhp
= zfs_open(hdl
, name
, ZFS_TYPE_DATASET
);
1712 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1713 "unable to access '%s'"), name
);
1714 return (zfs_error(hdl
, EZFS_BADPATH
, errbuf
));
1717 if (fromguid
!= 0) {
1718 if (guid_to_name(hdl
, toname
, fromguid
, B_TRUE
, name
) != 0) {
1719 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1720 "incremental source %#llx no longer exists"),
1721 (longlong_t
)fromguid
);
1722 return (zfs_error(hdl
, EZFS_BADPATH
, errbuf
));
1727 if (flags
->verbose
) {
1729 error
= lzc_send_space(zhp
->zfs_name
, fromname
,
1732 size
= MAX(0, (int64_t)(size
- bytes
));
1733 send_print_verbose(fout
, zhp
->zfs_name
, fromname
,
1734 size
, flags
->parsable
);
1737 if (!flags
->dryrun
) {
1738 progress_arg_t pa
= { 0 };
1741 * If progress reporting is requested, spawn a new thread to
1742 * poll ZFS_IOC_SEND_PROGRESS at a regular interval.
1744 if (flags
->progress
) {
1747 pa
.pa_parsable
= flags
->parsable
;
1749 error
= pthread_create(&tid
, NULL
,
1750 send_progress_thread
, &pa
);
1757 error
= lzc_send_resume(zhp
->zfs_name
, fromname
, outfd
,
1758 lzc_flags
, resumeobj
, resumeoff
);
1760 if (flags
->progress
) {
1761 (void) pthread_cancel(tid
);
1762 (void) pthread_join(tid
, NULL
);
1766 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
1767 "warning: cannot send '%s'"), zhp
->zfs_name
);
1775 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1776 "source key must be loaded"));
1777 return (zfs_error(hdl
, EZFS_CRYPTOFAILED
, errbuf
));
1792 zfs_error_aux(hdl
, strerror(errno
));
1793 return (zfs_error(hdl
, EZFS_BADBACKUP
, errbuf
));
1796 return (zfs_standard_error(hdl
, errno
, errbuf
));
1807 * Generate a send stream for the dataset identified by the argument zhp.
1809 * The content of the send stream is the snapshot identified by
1810 * 'tosnap'. Incremental streams are requested in two ways:
1811 * - from the snapshot identified by "fromsnap" (if non-null) or
1812 * - from the origin of the dataset identified by zhp, which must
1813 * be a clone. In this case, "fromsnap" is null and "fromorigin"
1816 * The send stream is recursive (i.e. dumps a hierarchy of snapshots) and
1817 * uses a special header (with a hdrtype field of DMU_COMPOUNDSTREAM)
1818 * if "replicate" is set. If "doall" is set, dump all the intermediate
1819 * snapshots. The DMU_COMPOUNDSTREAM header is used in the "doall"
1820 * case too. If "props" is set, send properties.
1823 zfs_send(zfs_handle_t
*zhp
, const char *fromsnap
, const char *tosnap
,
1824 sendflags_t
*flags
, int outfd
, snapfilter_cb_t filter_func
,
1825 void *cb_arg
, nvlist_t
**debugnvp
)
1828 send_dump_data_t sdd
= { 0 };
1830 nvlist_t
*fss
= NULL
;
1831 avl_tree_t
*fsavl
= NULL
;
1832 static uint64_t holdseq
;
1836 dedup_arg_t dda
= { 0 };
1837 int featureflags
= 0;
1840 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
1841 "cannot send '%s'"), zhp
->zfs_name
);
1843 if (fromsnap
&& fromsnap
[0] == '\0') {
1844 zfs_error_aux(zhp
->zfs_hdl
, dgettext(TEXT_DOMAIN
,
1845 "zero-length incremental source"));
1846 return (zfs_error(zhp
->zfs_hdl
, EZFS_NOENT
, errbuf
));
1849 if (zhp
->zfs_type
== ZFS_TYPE_FILESYSTEM
) {
1851 version
= zfs_prop_get_int(zhp
, ZFS_PROP_VERSION
);
1852 if (version
>= ZPL_VERSION_SA
) {
1853 featureflags
|= DMU_BACKUP_FEATURE_SA_SPILL
;
1858 * Start the dedup thread if this is a dedup stream. We do not bother
1859 * doing this if this a raw send of an encrypted dataset with dedup off
1860 * because normal encrypted blocks won't dedup.
1862 if (flags
->dedup
&& !flags
->dryrun
&& !(flags
->raw
&&
1863 zfs_prop_get_int(zhp
, ZFS_PROP_ENCRYPTION
) != ZIO_CRYPT_OFF
&&
1864 zfs_prop_get_int(zhp
, ZFS_PROP_DEDUP
) == ZIO_CHECKSUM_OFF
)) {
1865 featureflags
|= (DMU_BACKUP_FEATURE_DEDUP
|
1866 DMU_BACKUP_FEATURE_DEDUPPROPS
);
1867 if ((err
= socketpair(AF_UNIX
, SOCK_STREAM
, 0, pipefd
)) != 0) {
1868 zfs_error_aux(zhp
->zfs_hdl
, strerror(errno
));
1869 return (zfs_error(zhp
->zfs_hdl
, EZFS_PIPEFAILED
,
1872 dda
.outputfd
= outfd
;
1873 dda
.inputfd
= pipefd
[1];
1874 dda
.dedup_hdl
= zhp
->zfs_hdl
;
1875 if ((err
= pthread_create(&tid
, NULL
, cksummer
, &dda
)) != 0) {
1876 (void) close(pipefd
[0]);
1877 (void) close(pipefd
[1]);
1878 zfs_error_aux(zhp
->zfs_hdl
, strerror(errno
));
1879 return (zfs_error(zhp
->zfs_hdl
,
1880 EZFS_THREADCREATEFAILED
, errbuf
));
1884 if (flags
->replicate
|| flags
->doall
|| flags
->props
) {
1885 dmu_replay_record_t drr
= { 0 };
1886 char *packbuf
= NULL
;
1890 ZIO_SET_CHECKSUM(&zc
, 0, 0, 0, 0);
1892 if (flags
->replicate
|| flags
->props
) {
1895 VERIFY(0 == nvlist_alloc(&hdrnv
, NV_UNIQUE_NAME
, 0));
1897 VERIFY(0 == nvlist_add_string(hdrnv
,
1898 "fromsnap", fromsnap
));
1900 VERIFY(0 == nvlist_add_string(hdrnv
, "tosnap", tosnap
));
1901 if (!flags
->replicate
) {
1902 VERIFY(0 == nvlist_add_boolean(hdrnv
,
1906 VERIFY(0 == nvlist_add_boolean(hdrnv
, "raw"));
1909 err
= gather_nvlist(zhp
->zfs_hdl
, zhp
->zfs_name
,
1910 fromsnap
, tosnap
, flags
->replicate
, flags
->raw
,
1911 flags
->verbose
, &fss
, &fsavl
);
1914 VERIFY(0 == nvlist_add_nvlist(hdrnv
, "fss", fss
));
1915 err
= nvlist_pack(hdrnv
, &packbuf
, &buflen
,
1925 if (!flags
->dryrun
) {
1926 /* write first begin record */
1927 drr
.drr_type
= DRR_BEGIN
;
1928 drr
.drr_u
.drr_begin
.drr_magic
= DMU_BACKUP_MAGIC
;
1929 DMU_SET_STREAM_HDRTYPE(drr
.drr_u
.drr_begin
.
1930 drr_versioninfo
, DMU_COMPOUNDSTREAM
);
1931 DMU_SET_FEATUREFLAGS(drr
.drr_u
.drr_begin
.
1932 drr_versioninfo
, featureflags
);
1933 if (snprintf(drr
.drr_u
.drr_begin
.drr_toname
,
1934 sizeof (drr
.drr_u
.drr_begin
.drr_toname
),
1935 "%s@%s", zhp
->zfs_name
, tosnap
) >=
1936 sizeof (drr
.drr_u
.drr_begin
.drr_toname
)) {
1940 drr
.drr_payloadlen
= buflen
;
1942 err
= dump_record(&drr
, packbuf
, buflen
, &zc
, outfd
);
1947 /* write end record */
1948 bzero(&drr
, sizeof (drr
));
1949 drr
.drr_type
= DRR_END
;
1950 drr
.drr_u
.drr_end
.drr_checksum
= zc
;
1951 err
= write(outfd
, &drr
, sizeof (drr
));
1961 /* dump each stream */
1962 sdd
.fromsnap
= fromsnap
;
1963 sdd
.tosnap
= tosnap
;
1965 sdd
.outfd
= pipefd
[0];
1968 sdd
.replicate
= flags
->replicate
;
1969 sdd
.doall
= flags
->doall
;
1970 sdd
.fromorigin
= flags
->fromorigin
;
1973 sdd
.verbose
= flags
->verbose
;
1974 sdd
.parsable
= flags
->parsable
;
1975 sdd
.progress
= flags
->progress
;
1976 sdd
.dryrun
= flags
->dryrun
;
1977 sdd
.large_block
= flags
->largeblock
;
1978 sdd
.embed_data
= flags
->embed_data
;
1979 sdd
.compress
= flags
->compress
;
1980 sdd
.raw
= flags
->raw
;
1981 sdd
.filter_cb
= filter_func
;
1982 sdd
.filter_cb_arg
= cb_arg
;
1984 sdd
.debugnv
= *debugnvp
;
1985 if (sdd
.verbose
&& sdd
.dryrun
)
1986 sdd
.std_out
= B_TRUE
;
1987 fout
= sdd
.std_out
? stdout
: stderr
;
1990 * Some flags require that we place user holds on the datasets that are
1991 * being sent so they don't get destroyed during the send. We can skip
1992 * this step if the pool is imported read-only since the datasets cannot
1995 if (!flags
->dryrun
&& !zpool_get_prop_int(zfs_get_pool_handle(zhp
),
1996 ZPOOL_PROP_READONLY
, NULL
) &&
1997 zfs_spa_version(zhp
, &spa_version
) == 0 &&
1998 spa_version
>= SPA_VERSION_USERREFS
&&
1999 (flags
->doall
|| flags
->replicate
)) {
2001 (void) snprintf(sdd
.holdtag
, sizeof (sdd
.holdtag
),
2002 ".send-%d-%llu", getpid(), (u_longlong_t
)holdseq
);
2003 sdd
.cleanup_fd
= open(ZFS_DEV
, O_RDWR
);
2004 if (sdd
.cleanup_fd
< 0) {
2008 sdd
.snapholds
= fnvlist_alloc();
2010 sdd
.cleanup_fd
= -1;
2011 sdd
.snapholds
= NULL
;
2013 if (flags
->verbose
|| sdd
.snapholds
!= NULL
) {
2015 * Do a verbose no-op dry run to get all the verbose output
2016 * or to gather snapshot hold's before generating any data,
2017 * then do a non-verbose real run to generate the streams.
2019 sdd
.dryrun
= B_TRUE
;
2020 err
= dump_filesystems(zhp
, &sdd
);
2025 if (flags
->verbose
) {
2026 if (flags
->parsable
) {
2027 (void) fprintf(fout
, "size\t%llu\n",
2028 (longlong_t
)sdd
.size
);
2031 zfs_nicebytes(sdd
.size
, buf
, sizeof (buf
));
2032 (void) fprintf(fout
, dgettext(TEXT_DOMAIN
,
2033 "total estimated size is %s\n"), buf
);
2037 /* Ensure no snaps found is treated as an error. */
2043 /* Skip the second run if dryrun was requested. */
2047 if (sdd
.snapholds
!= NULL
) {
2048 err
= zfs_hold_nvl(zhp
, sdd
.cleanup_fd
, sdd
.snapholds
);
2052 fnvlist_free(sdd
.snapholds
);
2053 sdd
.snapholds
= NULL
;
2056 sdd
.dryrun
= B_FALSE
;
2057 sdd
.verbose
= B_FALSE
;
2060 err
= dump_filesystems(zhp
, &sdd
);
2061 fsavl_destroy(fsavl
);
2064 /* Ensure no snaps found is treated as an error. */
2065 if (err
== 0 && !sdd
.seento
)
2070 (void) pthread_cancel(tid
);
2071 (void) close(pipefd
[0]);
2072 (void) pthread_join(tid
, NULL
);
2075 if (sdd
.cleanup_fd
!= -1) {
2076 VERIFY(0 == close(sdd
.cleanup_fd
));
2077 sdd
.cleanup_fd
= -1;
2080 if (!flags
->dryrun
&& (flags
->replicate
|| flags
->doall
||
2083 * write final end record. NB: want to do this even if
2084 * there was some error, because it might not be totally
2087 dmu_replay_record_t drr
= { 0 };
2088 drr
.drr_type
= DRR_END
;
2089 if (write(outfd
, &drr
, sizeof (drr
)) == -1) {
2090 return (zfs_standard_error(zhp
->zfs_hdl
,
2095 return (err
|| sdd
.err
);
2098 err
= zfs_standard_error(zhp
->zfs_hdl
, err
, errbuf
);
2100 fsavl_destroy(fsavl
);
2102 fnvlist_free(sdd
.snapholds
);
2104 if (sdd
.cleanup_fd
!= -1)
2105 VERIFY(0 == close(sdd
.cleanup_fd
));
2107 (void) pthread_cancel(tid
);
2108 (void) close(pipefd
[0]);
2109 (void) pthread_join(tid
, NULL
);
2115 zfs_send_one(zfs_handle_t
*zhp
, const char *from
, int fd
, sendflags_t flags
)
2118 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
2119 enum lzc_send_flags lzc_flags
= 0;
2120 FILE *fout
= (flags
.verbose
&& flags
.dryrun
) ? stdout
: stderr
;
2123 if (flags
.largeblock
)
2124 lzc_flags
|= LZC_SEND_FLAG_LARGE_BLOCK
;
2125 if (flags
.embed_data
)
2126 lzc_flags
|= LZC_SEND_FLAG_EMBED_DATA
;
2128 lzc_flags
|= LZC_SEND_FLAG_COMPRESS
;
2130 lzc_flags
|= LZC_SEND_FLAG_RAW
;
2132 if (flags
.verbose
) {
2134 err
= lzc_send_space(zhp
->zfs_name
, from
, lzc_flags
, &size
);
2136 send_print_verbose(fout
, zhp
->zfs_name
, from
, size
,
2139 (void) fprintf(stderr
, "Cannot estimate send size: "
2140 "%s\n", strerror(errno
));
2147 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
2148 "warning: cannot send '%s'"), zhp
->zfs_name
);
2150 err
= lzc_send(zhp
->zfs_name
, from
, fd
, lzc_flags
);
2154 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
2155 "not an earlier snapshot from the same fs"));
2156 return (zfs_error(hdl
, EZFS_CROSSTARGET
, errbuf
));
2160 if (lzc_exists(zhp
->zfs_name
)) {
2161 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
2162 "incremental source (%s) does not exist"),
2165 return (zfs_error(hdl
, EZFS_NOENT
, errbuf
));
2168 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
2169 "dataset key must be loaded"));
2170 return (zfs_error(hdl
, EZFS_CRYPTOFAILED
, errbuf
));
2173 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
2174 "target is busy; if a filesystem, "
2175 "it must not be mounted"));
2176 return (zfs_error(hdl
, EZFS_BUSY
, errbuf
));
2189 zfs_error_aux(hdl
, strerror(errno
));
2190 return (zfs_error(hdl
, EZFS_BADBACKUP
, errbuf
));
2193 return (zfs_standard_error(hdl
, errno
, errbuf
));
2200 * Routines specific to "zfs recv"
2204 recv_read(libzfs_handle_t
*hdl
, int fd
, void *buf
, int ilen
,
2205 boolean_t byteswap
, zio_cksum_t
*zc
)
2211 assert(ilen
<= SPA_MAXBLOCKSIZE
);
2214 rv
= read(fd
, cp
, len
);
2219 if (rv
< 0 || len
!= 0) {
2220 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
2221 "failed to read from stream"));
2222 return (zfs_error(hdl
, EZFS_BADSTREAM
, dgettext(TEXT_DOMAIN
,
2223 "cannot receive")));
2228 fletcher_4_incremental_byteswap(buf
, ilen
, zc
);
2230 fletcher_4_incremental_native(buf
, ilen
, zc
);
2236 recv_read_nvlist(libzfs_handle_t
*hdl
, int fd
, int len
, nvlist_t
**nvp
,
2237 boolean_t byteswap
, zio_cksum_t
*zc
)
2242 buf
= zfs_alloc(hdl
, len
);
2246 err
= recv_read(hdl
, fd
, buf
, len
, byteswap
, zc
);
2252 err
= nvlist_unpack(buf
, len
, nvp
, 0);
2255 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
, "invalid "
2256 "stream (malformed nvlist)"));
2263 * Returns the grand origin (origin of origin of origin...) of a given handle.
2264 * If this dataset is not a clone, it simply returns a copy of the original
2267 static zfs_handle_t
*
2268 recv_open_grand_origin(zfs_handle_t
*zhp
)
2270 char origin
[ZFS_MAX_DATASET_NAME_LEN
];
2272 zfs_handle_t
*ozhp
= zfs_handle_dup(zhp
);
2274 while (ozhp
!= NULL
) {
2275 if (zfs_prop_get(ozhp
, ZFS_PROP_ORIGIN
, origin
,
2276 sizeof (origin
), &src
, NULL
, 0, B_FALSE
) != 0)
2279 (void) zfs_close(ozhp
);
2280 ozhp
= zfs_open(zhp
->zfs_hdl
, origin
, ZFS_TYPE_FILESYSTEM
);
2287 recv_rename_impl(zfs_handle_t
*zhp
, zfs_cmd_t
*zc
)
2290 zfs_handle_t
*ozhp
= NULL
;
2293 * Attempt to rename the dataset. If it fails with EACCES we have
2294 * attempted to rename the dataset outside of its encryption root.
2295 * Force the dataset to become an encryption root and try again.
2297 err
= ioctl(zhp
->zfs_hdl
->libzfs_fd
, ZFS_IOC_RENAME
, &zc
);
2298 if (err
== EACCES
) {
2299 ozhp
= recv_open_grand_origin(zhp
);
2305 err
= lzc_change_key(ozhp
->zfs_name
, DCP_CMD_FORCE_NEW_KEY
,
2310 err
= ioctl(zhp
->zfs_hdl
->libzfs_fd
, ZFS_IOC_RENAME
, &zc
);
2320 recv_rename(libzfs_handle_t
*hdl
, const char *name
, const char *tryname
,
2321 int baselen
, char *newname
, recvflags_t
*flags
)
2324 zfs_cmd_t zc
= {"\0"};
2326 prop_changelist_t
*clp
= NULL
;
2327 zfs_handle_t
*zhp
= NULL
;
2329 zhp
= zfs_open(hdl
, name
, ZFS_TYPE_DATASET
);
2334 clp
= changelist_gather(zhp
, ZFS_PROP_NAME
, 0,
2335 flags
->force
? MS_FORCE
: 0);
2340 err
= changelist_prefix(clp
);
2344 zc
.zc_objset_type
= DMU_OST_ZFS
;
2345 (void) strlcpy(zc
.zc_name
, name
, sizeof (zc
.zc_name
));
2348 (void) strcpy(newname
, tryname
);
2350 (void) strlcpy(zc
.zc_value
, tryname
, sizeof (zc
.zc_value
));
2352 if (flags
->verbose
) {
2353 (void) printf("attempting rename %s to %s\n",
2354 zc
.zc_name
, zc
.zc_value
);
2356 err
= recv_rename_impl(zhp
, &zc
);
2358 changelist_rename(clp
, name
, tryname
);
2363 if (err
!= 0 && strncmp(name
+ baselen
, "recv-", 5) != 0) {
2366 (void) snprintf(newname
, ZFS_MAX_DATASET_NAME_LEN
,
2367 "%.*srecv-%u-%u", baselen
, name
, getpid(), seq
);
2368 (void) strlcpy(zc
.zc_value
, newname
, sizeof (zc
.zc_value
));
2370 if (flags
->verbose
) {
2371 (void) printf("failed - trying rename %s to %s\n",
2372 zc
.zc_name
, zc
.zc_value
);
2374 err
= recv_rename_impl(zhp
, &zc
);
2376 changelist_rename(clp
, name
, newname
);
2377 if (err
&& flags
->verbose
) {
2378 (void) printf("failed (%u) - "
2379 "will try again on next pass\n", errno
);
2382 } else if (flags
->verbose
) {
2384 (void) printf("success\n");
2386 (void) printf("failed (%u)\n", errno
);
2389 (void) changelist_postfix(clp
);
2393 changelist_free(clp
);
2401 recv_promote(libzfs_handle_t
*hdl
, const char *fsname
,
2402 const char *origin_fsname
, recvflags_t
*flags
)
2405 zfs_cmd_t zc
= {"\0"};
2406 zfs_handle_t
*zhp
= NULL
, *ozhp
= NULL
;
2409 (void) printf("promoting %s\n", fsname
);
2411 (void) strlcpy(zc
.zc_value
, origin_fsname
, sizeof (zc
.zc_value
));
2412 (void) strlcpy(zc
.zc_name
, fsname
, sizeof (zc
.zc_name
));
2415 * Attempt to promote the dataset. If it fails with EACCES the
2416 * promotion would cause this dataset to leave its encryption root.
2417 * Force the origin to become an encryption root and try again.
2419 err
= zfs_ioctl(hdl
, ZFS_IOC_PROMOTE
, &zc
);
2420 if (err
== EACCES
) {
2421 zhp
= zfs_open(hdl
, fsname
, ZFS_TYPE_DATASET
);
2427 ozhp
= recv_open_grand_origin(zhp
);
2433 err
= lzc_change_key(ozhp
->zfs_name
, DCP_CMD_FORCE_NEW_KEY
,
2438 err
= zfs_ioctl(hdl
, ZFS_IOC_PROMOTE
, &zc
);
2451 recv_destroy(libzfs_handle_t
*hdl
, const char *name
, int baselen
,
2452 char *newname
, recvflags_t
*flags
)
2454 zfs_cmd_t zc
= {"\0"};
2456 prop_changelist_t
*clp
;
2458 boolean_t defer
= B_FALSE
;
2461 zhp
= zfs_open(hdl
, name
, ZFS_TYPE_DATASET
);
2464 clp
= changelist_gather(zhp
, ZFS_PROP_NAME
, 0,
2465 flags
->force
? MS_FORCE
: 0);
2466 if (zfs_get_type(zhp
) == ZFS_TYPE_SNAPSHOT
&&
2467 zfs_spa_version(zhp
, &spa_version
) == 0 &&
2468 spa_version
>= SPA_VERSION_USERREFS
)
2473 err
= changelist_prefix(clp
);
2477 zc
.zc_objset_type
= DMU_OST_ZFS
;
2478 zc
.zc_defer_destroy
= defer
;
2479 (void) strlcpy(zc
.zc_name
, name
, sizeof (zc
.zc_name
));
2482 (void) printf("attempting destroy %s\n", zc
.zc_name
);
2483 err
= ioctl(hdl
->libzfs_fd
, ZFS_IOC_DESTROY
, &zc
);
2486 (void) printf("success\n");
2487 changelist_remove(clp
, zc
.zc_name
);
2490 (void) changelist_postfix(clp
);
2491 changelist_free(clp
);
2494 * Deferred destroy might destroy the snapshot or only mark it to be
2495 * destroyed later, and it returns success in either case.
2497 if (err
!= 0 || (defer
&& zfs_dataset_exists(hdl
, name
,
2498 ZFS_TYPE_SNAPSHOT
))) {
2499 err
= recv_rename(hdl
, name
, NULL
, baselen
, newname
, flags
);
2505 typedef struct guid_to_name_data
{
2507 boolean_t bookmark_ok
;
2510 } guid_to_name_data_t
;
2513 guid_to_name_cb(zfs_handle_t
*zhp
, void *arg
)
2515 guid_to_name_data_t
*gtnd
= arg
;
2519 if (gtnd
->skip
!= NULL
&&
2520 (slash
= strrchr(zhp
->zfs_name
, '/')) != NULL
&&
2521 strcmp(slash
+ 1, gtnd
->skip
) == 0) {
2526 if (zfs_prop_get_int(zhp
, ZFS_PROP_GUID
) == gtnd
->guid
) {
2527 (void) strcpy(gtnd
->name
, zhp
->zfs_name
);
2532 err
= zfs_iter_children(zhp
, guid_to_name_cb
, gtnd
);
2533 if (err
!= EEXIST
&& gtnd
->bookmark_ok
)
2534 err
= zfs_iter_bookmarks(zhp
, guid_to_name_cb
, gtnd
);
2540 * Attempt to find the local dataset associated with this guid. In the case of
2541 * multiple matches, we attempt to find the "best" match by searching
2542 * progressively larger portions of the hierarchy. This allows one to send a
2543 * tree of datasets individually and guarantee that we will find the source
2544 * guid within that hierarchy, even if there are multiple matches elsewhere.
2547 guid_to_name(libzfs_handle_t
*hdl
, const char *parent
, uint64_t guid
,
2548 boolean_t bookmark_ok
, char *name
)
2550 char pname
[ZFS_MAX_DATASET_NAME_LEN
];
2551 guid_to_name_data_t gtnd
;
2554 gtnd
.bookmark_ok
= bookmark_ok
;
2559 * Search progressively larger portions of the hierarchy, starting
2560 * with the filesystem specified by 'parent'. This will
2561 * select the "most local" version of the origin snapshot in the case
2562 * that there are multiple matching snapshots in the system.
2564 (void) strlcpy(pname
, parent
, sizeof (pname
));
2565 char *cp
= strrchr(pname
, '@');
2567 cp
= strchr(pname
, '\0');
2568 for (; cp
!= NULL
; cp
= strrchr(pname
, '/')) {
2569 /* Chop off the last component and open the parent */
2571 zfs_handle_t
*zhp
= make_dataset_handle(hdl
, pname
);
2575 int err
= guid_to_name_cb(zfs_handle_dup(zhp
), >nd
);
2577 err
= zfs_iter_children(zhp
, guid_to_name_cb
, >nd
);
2578 if (err
!= EEXIST
&& bookmark_ok
)
2579 err
= zfs_iter_bookmarks(zhp
, guid_to_name_cb
, >nd
);
2585 * Remember the last portion of the dataset so we skip it next
2586 * time through (as we've already searched that portion of the
2589 gtnd
.skip
= strrchr(pname
, '/') + 1;
2596 * Return +1 if guid1 is before guid2, 0 if they are the same, and -1 if
2597 * guid1 is after guid2.
2600 created_before(libzfs_handle_t
*hdl
, avl_tree_t
*avl
,
2601 uint64_t guid1
, uint64_t guid2
)
2604 char *fsname
= NULL
, *snapname
= NULL
;
2605 char buf
[ZFS_MAX_DATASET_NAME_LEN
];
2607 zfs_handle_t
*guid1hdl
, *guid2hdl
;
2608 uint64_t create1
, create2
;
2615 nvfs
= fsavl_find(avl
, guid1
, &snapname
);
2616 VERIFY(0 == nvlist_lookup_string(nvfs
, "name", &fsname
));
2617 (void) snprintf(buf
, sizeof (buf
), "%s@%s", fsname
, snapname
);
2618 guid1hdl
= zfs_open(hdl
, buf
, ZFS_TYPE_SNAPSHOT
);
2619 if (guid1hdl
== NULL
)
2622 nvfs
= fsavl_find(avl
, guid2
, &snapname
);
2623 VERIFY(0 == nvlist_lookup_string(nvfs
, "name", &fsname
));
2624 (void) snprintf(buf
, sizeof (buf
), "%s@%s", fsname
, snapname
);
2625 guid2hdl
= zfs_open(hdl
, buf
, ZFS_TYPE_SNAPSHOT
);
2626 if (guid2hdl
== NULL
) {
2627 zfs_close(guid1hdl
);
2631 create1
= zfs_prop_get_int(guid1hdl
, ZFS_PROP_CREATETXG
);
2632 create2
= zfs_prop_get_int(guid2hdl
, ZFS_PROP_CREATETXG
);
2634 if (create1
< create2
)
2636 else if (create1
> create2
)
2641 zfs_close(guid1hdl
);
2642 zfs_close(guid2hdl
);
2648 * This function reestablishes the heirarchy of encryption roots after a
2649 * recursive incremental receive has completed. This must be done after the
2650 * second call to recv_incremental_replication() has renamed and promoted all
2651 * sent datasets to their final locations in the dataset heriarchy.
2654 recv_fix_encryption_heirarchy(libzfs_handle_t
*hdl
, const char *destname
,
2655 nvlist_t
*stream_nv
, avl_tree_t
*stream_avl
)
2658 nvpair_t
*fselem
= NULL
;
2659 nvlist_t
*stream_fss
;
2661 VERIFY(0 == nvlist_lookup_nvlist(stream_nv
, "fss", &stream_fss
));
2663 while ((fselem
= nvlist_next_nvpair(stream_fss
, fselem
)) != NULL
) {
2664 zfs_handle_t
*zhp
= NULL
;
2666 nvlist_t
*snaps
, *props
, *stream_nvfs
= NULL
;
2667 nvpair_t
*snapel
= NULL
;
2668 boolean_t is_encroot
, is_clone
, stream_encroot
;
2670 char *stream_keylocation
= NULL
;
2671 char keylocation
[MAXNAMELEN
];
2672 char fsname
[ZFS_MAX_DATASET_NAME_LEN
];
2674 keylocation
[0] = '\0';
2675 VERIFY(0 == nvpair_value_nvlist(fselem
, &stream_nvfs
));
2676 VERIFY(0 == nvlist_lookup_nvlist(stream_nvfs
, "snaps", &snaps
));
2677 VERIFY(0 == nvlist_lookup_nvlist(stream_nvfs
, "props", &props
));
2678 stream_encroot
= nvlist_exists(stream_nvfs
, "is_encroot");
2680 /* find a snapshot from the stream that exists locally */
2682 while ((snapel
= nvlist_next_nvpair(snaps
, snapel
)) != NULL
) {
2685 VERIFY(0 == nvpair_value_uint64(snapel
, &guid
));
2686 err
= guid_to_name(hdl
, destname
, guid
, B_FALSE
,
2695 cp
= strchr(fsname
, '@');
2699 zhp
= zfs_open(hdl
, fsname
, ZFS_TYPE_DATASET
);
2705 crypt
= zfs_prop_get_int(zhp
, ZFS_PROP_ENCRYPTION
);
2706 is_clone
= zhp
->zfs_dmustats
.dds_origin
[0] != '\0';
2707 (void) zfs_crypto_get_encryption_root(zhp
, &is_encroot
, NULL
);
2709 /* we don't need to do anything for unencrypted filesystems */
2710 if (crypt
== ZIO_CRYPT_OFF
) {
2716 * If the dataset is flagged as an encryption root, was not
2717 * received as a clone and is not currently an encryption root,
2718 * force it to become one. Fixup the keylocation if necessary.
2720 if (stream_encroot
) {
2721 if (!is_clone
&& !is_encroot
) {
2722 err
= lzc_change_key(fsname
,
2723 DCP_CMD_FORCE_NEW_KEY
, NULL
, NULL
, 0);
2730 VERIFY(0 == nvlist_lookup_string(props
,
2731 zfs_prop_to_name(ZFS_PROP_KEYLOCATION
),
2732 &stream_keylocation
));
2735 * Refresh the properties in case the call to
2736 * lzc_change_key() changed the value.
2738 zfs_refresh_properties(zhp
);
2739 err
= zfs_prop_get(zhp
, ZFS_PROP_KEYLOCATION
,
2740 keylocation
, sizeof (keylocation
), NULL
, NULL
,
2747 if (strcmp(keylocation
, stream_keylocation
) != 0) {
2748 err
= zfs_prop_set(zhp
,
2749 zfs_prop_to_name(ZFS_PROP_KEYLOCATION
),
2750 stream_keylocation
);
2759 * If the dataset is not flagged as an encryption root and is
2760 * currently an encryption root, force it to inherit from its
2763 if (!stream_encroot
&& is_encroot
) {
2764 err
= lzc_change_key(fsname
, DCP_CMD_FORCE_INHERIT
,
2782 recv_incremental_replication(libzfs_handle_t
*hdl
, const char *tofs
,
2783 recvflags_t
*flags
, nvlist_t
*stream_nv
, avl_tree_t
*stream_avl
,
2786 nvlist_t
*local_nv
, *deleted
= NULL
;
2787 avl_tree_t
*local_avl
;
2788 nvpair_t
*fselem
, *nextfselem
;
2790 char newname
[ZFS_MAX_DATASET_NAME_LEN
];
2793 boolean_t needagain
, progress
, recursive
;
2796 VERIFY(0 == nvlist_lookup_string(stream_nv
, "fromsnap", &fromsnap
));
2798 recursive
= (nvlist_lookup_boolean(stream_nv
, "not_recursive") ==
2805 needagain
= progress
= B_FALSE
;
2807 VERIFY(0 == nvlist_alloc(&deleted
, NV_UNIQUE_NAME
, 0));
2809 if ((error
= gather_nvlist(hdl
, tofs
, fromsnap
, NULL
,
2810 recursive
, B_TRUE
, B_FALSE
, &local_nv
, &local_avl
)) != 0)
2814 * Process deletes and renames
2816 for (fselem
= nvlist_next_nvpair(local_nv
, NULL
);
2817 fselem
; fselem
= nextfselem
) {
2818 nvlist_t
*nvfs
, *snaps
;
2819 nvlist_t
*stream_nvfs
= NULL
;
2820 nvpair_t
*snapelem
, *nextsnapelem
;
2821 uint64_t fromguid
= 0;
2822 uint64_t originguid
= 0;
2823 uint64_t stream_originguid
= 0;
2824 uint64_t parent_fromsnap_guid
, stream_parent_fromsnap_guid
;
2825 char *fsname
, *stream_fsname
;
2827 nextfselem
= nvlist_next_nvpair(local_nv
, fselem
);
2829 VERIFY(0 == nvpair_value_nvlist(fselem
, &nvfs
));
2830 VERIFY(0 == nvlist_lookup_nvlist(nvfs
, "snaps", &snaps
));
2831 VERIFY(0 == nvlist_lookup_string(nvfs
, "name", &fsname
));
2832 VERIFY(0 == nvlist_lookup_uint64(nvfs
, "parentfromsnap",
2833 &parent_fromsnap_guid
));
2834 (void) nvlist_lookup_uint64(nvfs
, "origin", &originguid
);
2837 * First find the stream's fs, so we can check for
2838 * a different origin (due to "zfs promote")
2840 for (snapelem
= nvlist_next_nvpair(snaps
, NULL
);
2841 snapelem
; snapelem
= nvlist_next_nvpair(snaps
, snapelem
)) {
2844 VERIFY(0 == nvpair_value_uint64(snapelem
, &thisguid
));
2845 stream_nvfs
= fsavl_find(stream_avl
, thisguid
, NULL
);
2847 if (stream_nvfs
!= NULL
)
2851 /* check for promote */
2852 (void) nvlist_lookup_uint64(stream_nvfs
, "origin",
2853 &stream_originguid
);
2854 if (stream_nvfs
&& originguid
!= stream_originguid
) {
2855 switch (created_before(hdl
, local_avl
,
2856 stream_originguid
, originguid
)) {
2859 nvlist_t
*origin_nvfs
;
2860 char *origin_fsname
;
2862 origin_nvfs
= fsavl_find(local_avl
, originguid
,
2864 VERIFY(0 == nvlist_lookup_string(origin_nvfs
,
2865 "name", &origin_fsname
));
2866 error
= recv_promote(hdl
, fsname
, origin_fsname
,
2875 fsavl_destroy(local_avl
);
2876 nvlist_free(local_nv
);
2880 * We had/have the wrong origin, therefore our
2881 * list of snapshots is wrong. Need to handle
2882 * them on the next pass.
2888 for (snapelem
= nvlist_next_nvpair(snaps
, NULL
);
2889 snapelem
; snapelem
= nextsnapelem
) {
2891 char *stream_snapname
;
2892 nvlist_t
*found
, *props
;
2894 nextsnapelem
= nvlist_next_nvpair(snaps
, snapelem
);
2896 VERIFY(0 == nvpair_value_uint64(snapelem
, &thisguid
));
2897 found
= fsavl_find(stream_avl
, thisguid
,
2900 /* check for delete */
2901 if (found
== NULL
) {
2902 char name
[ZFS_MAX_DATASET_NAME_LEN
];
2907 (void) snprintf(name
, sizeof (name
), "%s@%s",
2908 fsname
, nvpair_name(snapelem
));
2910 error
= recv_destroy(hdl
, name
,
2911 strlen(fsname
)+1, newname
, flags
);
2916 sprintf(guidname
, "%llu",
2917 (u_longlong_t
)thisguid
);
2918 nvlist_add_boolean(deleted
, guidname
);
2922 stream_nvfs
= found
;
2924 if (0 == nvlist_lookup_nvlist(stream_nvfs
, "snapprops",
2925 &props
) && 0 == nvlist_lookup_nvlist(props
,
2926 stream_snapname
, &props
)) {
2927 zfs_cmd_t zc
= {"\0"};
2929 zc
.zc_cookie
= B_TRUE
; /* received */
2930 (void) snprintf(zc
.zc_name
, sizeof (zc
.zc_name
),
2931 "%s@%s", fsname
, nvpair_name(snapelem
));
2932 if (zcmd_write_src_nvlist(hdl
, &zc
,
2934 (void) zfs_ioctl(hdl
,
2935 ZFS_IOC_SET_PROP
, &zc
);
2936 zcmd_free_nvlists(&zc
);
2940 /* check for different snapname */
2941 if (strcmp(nvpair_name(snapelem
),
2942 stream_snapname
) != 0) {
2943 char name
[ZFS_MAX_DATASET_NAME_LEN
];
2944 char tryname
[ZFS_MAX_DATASET_NAME_LEN
];
2946 (void) snprintf(name
, sizeof (name
), "%s@%s",
2947 fsname
, nvpair_name(snapelem
));
2948 (void) snprintf(tryname
, sizeof (name
), "%s@%s",
2949 fsname
, stream_snapname
);
2951 error
= recv_rename(hdl
, name
, tryname
,
2952 strlen(fsname
)+1, newname
, flags
);
2959 if (strcmp(stream_snapname
, fromsnap
) == 0)
2960 fromguid
= thisguid
;
2963 /* check for delete */
2964 if (stream_nvfs
== NULL
) {
2968 error
= recv_destroy(hdl
, fsname
, strlen(tofs
)+1,
2974 sprintf(guidname
, "%llu",
2975 (u_longlong_t
)parent_fromsnap_guid
);
2976 nvlist_add_boolean(deleted
, guidname
);
2980 if (fromguid
== 0) {
2981 if (flags
->verbose
) {
2982 (void) printf("local fs %s does not have "
2983 "fromsnap (%s in stream); must have "
2984 "been deleted locally; ignoring\n",
2990 VERIFY(0 == nvlist_lookup_string(stream_nvfs
,
2991 "name", &stream_fsname
));
2992 VERIFY(0 == nvlist_lookup_uint64(stream_nvfs
,
2993 "parentfromsnap", &stream_parent_fromsnap_guid
));
2995 s1
= strrchr(fsname
, '/');
2996 s2
= strrchr(stream_fsname
, '/');
2999 * Check if we're going to rename based on parent guid change
3000 * and the current parent guid was also deleted. If it was then
3001 * rename will fail and is likely unneeded, so avoid this and
3002 * force an early retry to determine the new
3003 * parent_fromsnap_guid.
3005 if (stream_parent_fromsnap_guid
!= 0 &&
3006 parent_fromsnap_guid
!= 0 &&
3007 stream_parent_fromsnap_guid
!= parent_fromsnap_guid
) {
3008 sprintf(guidname
, "%llu",
3009 (u_longlong_t
)parent_fromsnap_guid
);
3010 if (nvlist_exists(deleted
, guidname
)) {
3018 * Check for rename. If the exact receive path is specified, it
3019 * does not count as a rename, but we still need to check the
3020 * datasets beneath it.
3022 if ((stream_parent_fromsnap_guid
!= 0 &&
3023 parent_fromsnap_guid
!= 0 &&
3024 stream_parent_fromsnap_guid
!= parent_fromsnap_guid
) ||
3025 ((flags
->isprefix
|| strcmp(tofs
, fsname
) != 0) &&
3026 (s1
!= NULL
) && (s2
!= NULL
) && strcmp(s1
, s2
) != 0)) {
3028 char tryname
[ZFS_MAX_DATASET_NAME_LEN
];
3030 parent
= fsavl_find(local_avl
,
3031 stream_parent_fromsnap_guid
, NULL
);
3033 * NB: parent might not be found if we used the
3034 * tosnap for stream_parent_fromsnap_guid,
3035 * because the parent is a newly-created fs;
3036 * we'll be able to rename it after we recv the
3039 if (parent
!= NULL
) {
3042 VERIFY(0 == nvlist_lookup_string(parent
, "name",
3044 (void) snprintf(tryname
, sizeof (tryname
),
3045 "%s%s", pname
, strrchr(stream_fsname
, '/'));
3048 if (flags
->verbose
) {
3049 (void) printf("local fs %s new parent "
3050 "not found\n", fsname
);
3056 error
= recv_rename(hdl
, fsname
, tryname
,
3057 strlen(tofs
)+1, newname
, flags
);
3059 if (renamed
!= NULL
&& newname
[0] != '\0') {
3060 VERIFY(0 == nvlist_add_boolean(renamed
,
3072 fsavl_destroy(local_avl
);
3073 nvlist_free(local_nv
);
3074 nvlist_free(deleted
);
3076 if (needagain
&& progress
) {
3077 /* do another pass to fix up temporary names */
3079 (void) printf("another pass:\n");
3083 return (needagain
|| error
!= 0);
3087 zfs_receive_package(libzfs_handle_t
*hdl
, int fd
, const char *destname
,
3088 recvflags_t
*flags
, dmu_replay_record_t
*drr
, zio_cksum_t
*zc
,
3089 char **top_zfs
, int cleanup_fd
, uint64_t *action_handlep
,
3092 nvlist_t
*stream_nv
= NULL
;
3093 avl_tree_t
*stream_avl
= NULL
;
3094 char *fromsnap
= NULL
;
3095 char *sendsnap
= NULL
;
3097 char tofs
[ZFS_MAX_DATASET_NAME_LEN
];
3098 char sendfs
[ZFS_MAX_DATASET_NAME_LEN
];
3100 dmu_replay_record_t drre
;
3102 boolean_t anyerr
= B_FALSE
;
3103 boolean_t softerr
= B_FALSE
;
3104 boolean_t recursive
, raw
;
3106 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
3109 assert(drr
->drr_type
== DRR_BEGIN
);
3110 assert(drr
->drr_u
.drr_begin
.drr_magic
== DMU_BACKUP_MAGIC
);
3111 assert(DMU_GET_STREAM_HDRTYPE(drr
->drr_u
.drr_begin
.drr_versioninfo
) ==
3112 DMU_COMPOUNDSTREAM
);
3115 * Read in the nvlist from the stream.
3117 if (drr
->drr_payloadlen
!= 0) {
3118 error
= recv_read_nvlist(hdl
, fd
, drr
->drr_payloadlen
,
3119 &stream_nv
, flags
->byteswap
, zc
);
3121 error
= zfs_error(hdl
, EZFS_BADSTREAM
, errbuf
);
3126 recursive
= (nvlist_lookup_boolean(stream_nv
, "not_recursive") ==
3128 raw
= (nvlist_lookup_boolean(stream_nv
, "raw") == 0);
3130 if (recursive
&& strchr(destname
, '@')) {
3131 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3132 "cannot specify snapshot name for multi-snapshot stream"));
3133 error
= zfs_error(hdl
, EZFS_BADSTREAM
, errbuf
);
3138 * Read in the end record and verify checksum.
3140 if (0 != (error
= recv_read(hdl
, fd
, &drre
, sizeof (drre
),
3141 flags
->byteswap
, NULL
)))
3143 if (flags
->byteswap
) {
3144 drre
.drr_type
= BSWAP_32(drre
.drr_type
);
3145 drre
.drr_u
.drr_end
.drr_checksum
.zc_word
[0] =
3146 BSWAP_64(drre
.drr_u
.drr_end
.drr_checksum
.zc_word
[0]);
3147 drre
.drr_u
.drr_end
.drr_checksum
.zc_word
[1] =
3148 BSWAP_64(drre
.drr_u
.drr_end
.drr_checksum
.zc_word
[1]);
3149 drre
.drr_u
.drr_end
.drr_checksum
.zc_word
[2] =
3150 BSWAP_64(drre
.drr_u
.drr_end
.drr_checksum
.zc_word
[2]);
3151 drre
.drr_u
.drr_end
.drr_checksum
.zc_word
[3] =
3152 BSWAP_64(drre
.drr_u
.drr_end
.drr_checksum
.zc_word
[3]);
3154 if (drre
.drr_type
!= DRR_END
) {
3155 error
= zfs_error(hdl
, EZFS_BADSTREAM
, errbuf
);
3158 if (!ZIO_CHECKSUM_EQUAL(drre
.drr_u
.drr_end
.drr_checksum
, *zc
)) {
3159 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3160 "incorrect header checksum"));
3161 error
= zfs_error(hdl
, EZFS_BADSTREAM
, errbuf
);
3165 (void) nvlist_lookup_string(stream_nv
, "fromsnap", &fromsnap
);
3167 if (drr
->drr_payloadlen
!= 0) {
3168 nvlist_t
*stream_fss
;
3170 VERIFY(0 == nvlist_lookup_nvlist(stream_nv
, "fss",
3172 if ((stream_avl
= fsavl_create(stream_fss
)) == NULL
) {
3173 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3174 "couldn't allocate avl tree"));
3175 error
= zfs_error(hdl
, EZFS_NOMEM
, errbuf
);
3179 if (fromsnap
!= NULL
&& recursive
) {
3180 nvlist_t
*renamed
= NULL
;
3181 nvpair_t
*pair
= NULL
;
3183 (void) strlcpy(tofs
, destname
, sizeof (tofs
));
3184 if (flags
->isprefix
) {
3185 struct drr_begin
*drrb
= &drr
->drr_u
.drr_begin
;
3188 if (flags
->istail
) {
3189 cp
= strrchr(drrb
->drr_toname
, '/');
3191 (void) strlcat(tofs
, "/",
3195 i
= (cp
- drrb
->drr_toname
);
3198 i
= strcspn(drrb
->drr_toname
, "/@");
3200 /* zfs_receive_one() will create_parents() */
3201 (void) strlcat(tofs
, &drrb
->drr_toname
[i
],
3203 *strchr(tofs
, '@') = '\0';
3206 if (!flags
->dryrun
&& !flags
->nomount
) {
3207 VERIFY(0 == nvlist_alloc(&renamed
,
3208 NV_UNIQUE_NAME
, 0));
3211 softerr
= recv_incremental_replication(hdl
, tofs
, flags
,
3212 stream_nv
, stream_avl
, renamed
);
3214 /* Unmount renamed filesystems before receiving. */
3215 while ((pair
= nvlist_next_nvpair(renamed
,
3218 prop_changelist_t
*clp
= NULL
;
3220 zhp
= zfs_open(hdl
, nvpair_name(pair
),
3221 ZFS_TYPE_FILESYSTEM
);
3223 clp
= changelist_gather(zhp
,
3224 ZFS_PROP_MOUNTPOINT
, 0, 0);
3228 changelist_prefix(clp
);
3229 changelist_free(clp
);
3234 nvlist_free(renamed
);
3239 * Get the fs specified by the first path in the stream (the top level
3240 * specified by 'zfs send') and pass it to each invocation of
3241 * zfs_receive_one().
3243 (void) strlcpy(sendfs
, drr
->drr_u
.drr_begin
.drr_toname
,
3245 if ((cp
= strchr(sendfs
, '@')) != NULL
) {
3248 * Find the "sendsnap", the final snapshot in a replication
3249 * stream. zfs_receive_one() handles certain errors
3250 * differently, depending on if the contained stream is the
3253 sendsnap
= (cp
+ 1);
3256 /* Finally, receive each contained stream */
3259 * we should figure out if it has a recoverable
3260 * error, in which case do a recv_skip() and drive on.
3261 * Note, if we fail due to already having this guid,
3262 * zfs_receive_one() will take care of it (ie,
3263 * recv_skip() and return 0).
3265 error
= zfs_receive_impl(hdl
, destname
, NULL
, flags
, fd
,
3266 sendfs
, stream_nv
, stream_avl
, top_zfs
, cleanup_fd
,
3267 action_handlep
, sendsnap
, cmdprops
);
3268 if (error
== ENODATA
) {
3273 } while (error
== 0);
3275 if (drr
->drr_payloadlen
!= 0 && recursive
&& fromsnap
!= NULL
) {
3277 * Now that we have the fs's they sent us, try the
3280 softerr
= recv_incremental_replication(hdl
, tofs
, flags
,
3281 stream_nv
, stream_avl
, NULL
);
3284 if (raw
&& softerr
== 0) {
3285 softerr
= recv_fix_encryption_heirarchy(hdl
, destname
,
3286 stream_nv
, stream_avl
);
3290 fsavl_destroy(stream_avl
);
3291 nvlist_free(stream_nv
);
3300 trunc_prop_errs(int truncated
)
3302 ASSERT(truncated
!= 0);
3305 (void) fprintf(stderr
, dgettext(TEXT_DOMAIN
,
3306 "1 more property could not be set\n"));
3308 (void) fprintf(stderr
, dgettext(TEXT_DOMAIN
,
3309 "%d more properties could not be set\n"), truncated
);
3313 recv_skip(libzfs_handle_t
*hdl
, int fd
, boolean_t byteswap
)
3315 dmu_replay_record_t
*drr
;
3316 void *buf
= zfs_alloc(hdl
, SPA_MAXBLOCKSIZE
);
3319 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
3320 "cannot receive:"));
3322 /* XXX would be great to use lseek if possible... */
3325 while (recv_read(hdl
, fd
, drr
, sizeof (dmu_replay_record_t
),
3326 byteswap
, NULL
) == 0) {
3328 drr
->drr_type
= BSWAP_32(drr
->drr_type
);
3330 switch (drr
->drr_type
) {
3332 if (drr
->drr_payloadlen
!= 0) {
3333 (void) recv_read(hdl
, fd
, buf
,
3334 drr
->drr_payloadlen
, B_FALSE
, NULL
);
3344 drr
->drr_u
.drr_object
.drr_bonuslen
=
3345 BSWAP_32(drr
->drr_u
.drr_object
.
3348 (void) recv_read(hdl
, fd
, buf
,
3349 P2ROUNDUP(drr
->drr_u
.drr_object
.drr_bonuslen
, 8),
3355 drr
->drr_u
.drr_write
.drr_logical_size
=
3357 drr
->drr_u
.drr_write
.drr_logical_size
);
3358 drr
->drr_u
.drr_write
.drr_compressed_size
=
3360 drr
->drr_u
.drr_write
.drr_compressed_size
);
3362 uint64_t payload_size
=
3363 DRR_WRITE_PAYLOAD_SIZE(&drr
->drr_u
.drr_write
);
3364 (void) recv_read(hdl
, fd
, buf
,
3365 payload_size
, B_FALSE
, NULL
);
3369 drr
->drr_u
.drr_spill
.drr_length
=
3370 BSWAP_64(drr
->drr_u
.drr_spill
.drr_length
);
3372 (void) recv_read(hdl
, fd
, buf
,
3373 drr
->drr_u
.drr_spill
.drr_length
, B_FALSE
, NULL
);
3375 case DRR_WRITE_EMBEDDED
:
3377 drr
->drr_u
.drr_write_embedded
.drr_psize
=
3378 BSWAP_32(drr
->drr_u
.drr_write_embedded
.
3381 (void) recv_read(hdl
, fd
, buf
,
3382 P2ROUNDUP(drr
->drr_u
.drr_write_embedded
.drr_psize
,
3385 case DRR_WRITE_BYREF
:
3386 case DRR_FREEOBJECTS
:
3391 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3392 "invalid record type"));
3394 return (zfs_error(hdl
, EZFS_BADSTREAM
, errbuf
));
3403 recv_ecksum_set_aux(libzfs_handle_t
*hdl
, const char *target_snap
,
3404 boolean_t resumable
)
3406 char target_fs
[ZFS_MAX_DATASET_NAME_LEN
];
3408 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3409 "checksum mismatch or incomplete stream"));
3413 (void) strlcpy(target_fs
, target_snap
, sizeof (target_fs
));
3414 *strchr(target_fs
, '@') = '\0';
3415 zfs_handle_t
*zhp
= zfs_open(hdl
, target_fs
,
3416 ZFS_TYPE_FILESYSTEM
| ZFS_TYPE_VOLUME
);
3420 char token_buf
[ZFS_MAXPROPLEN
];
3421 int error
= zfs_prop_get(zhp
, ZFS_PROP_RECEIVE_RESUME_TOKEN
,
3422 token_buf
, sizeof (token_buf
),
3423 NULL
, NULL
, 0, B_TRUE
);
3425 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3426 "checksum mismatch or incomplete stream.\n"
3427 "Partially received snapshot is saved.\n"
3428 "A resuming stream can be generated on the sending "
3429 "system by running:\n"
3437 * Prepare a new nvlist of properties that are to override (-o) or be excluded
3438 * (-x) from the received dataset
3439 * recvprops: received properties from the send stream
3440 * cmdprops: raw input properties from command line
3441 * origprops: properties, both locally-set and received, currently set on the
3442 * target dataset if it exists, NULL otherwise.
3443 * oxprops: valid output override (-o) and excluded (-x) properties
3446 zfs_setup_cmdline_props(libzfs_handle_t
*hdl
, zfs_type_t type
, boolean_t zoned
,
3447 boolean_t recursive
, boolean_t toplevel
, nvlist_t
*recvprops
,
3448 nvlist_t
*cmdprops
, nvlist_t
*origprops
, nvlist_t
**oxprops
,
3452 nvlist_t
*oprops
, *voprops
;
3453 zfs_handle_t
*zhp
= NULL
;
3454 zpool_handle_t
*zpool_hdl
= NULL
;
3457 if (nvlist_empty(cmdprops
))
3458 return (0); /* No properties to override or exclude */
3460 *oxprops
= fnvlist_alloc();
3461 oprops
= fnvlist_alloc();
3464 * first iteration: process excluded (-x) properties now and gather
3465 * added (-o) properties to be later processed by zfs_valid_proplist()
3468 while ((nvp
= nvlist_next_nvpair(cmdprops
, nvp
)) != NULL
) {
3469 const char *name
= nvpair_name(nvp
);
3470 zfs_prop_t prop
= zfs_name_to_prop(name
);
3472 /* "origin" is processed separately, don't handle it here */
3473 if (prop
== ZFS_PROP_ORIGIN
)
3477 * we're trying to override or exclude a property that does not
3478 * make sense for this type of dataset, but we don't want to
3479 * fail if the receive is recursive: this comes in handy when
3480 * the send stream contains, for instance, a child ZVOL and
3481 * we're trying to receive it with "-o atime=on"
3483 if (!zfs_prop_valid_for_type(prop
, type
, B_FALSE
) &&
3484 !zfs_prop_user(name
)) {
3487 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3488 "property '%s' does not apply to datasets of this "
3490 ret
= zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
3494 switch (nvpair_type(nvp
)) {
3495 case DATA_TYPE_BOOLEAN
: /* -x property */
3497 * DATA_TYPE_BOOLEAN is the way we're asked to "exclude"
3498 * a property: this is done by forcing an explicit
3499 * inherit on the destination so the effective value is
3500 * not the one we received from the send stream.
3501 * We do this only if the property is not already
3502 * locally-set, in which case its value will take
3503 * priority over the received anyway.
3505 if (nvlist_exists(origprops
, name
)) {
3508 attrs
= fnvlist_lookup_nvlist(origprops
, name
);
3509 if (strcmp(fnvlist_lookup_string(attrs
,
3510 ZPROP_SOURCE
), ZPROP_SOURCE_VAL_RECVD
) != 0)
3514 * We can't force an explicit inherit on non-inheritable
3515 * properties: if we're asked to exclude this kind of
3516 * values we remove them from "recvprops" input nvlist.
3518 if (!zfs_prop_inheritable(prop
) &&
3519 !zfs_prop_user(name
) && /* can be inherited too */
3520 nvlist_exists(recvprops
, name
))
3521 fnvlist_remove(recvprops
, name
);
3523 fnvlist_add_nvpair(*oxprops
, nvp
);
3525 case DATA_TYPE_STRING
: /* -o property=value */
3526 fnvlist_add_nvpair(oprops
, nvp
);
3529 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3530 "property '%s' must be a string or boolean"), name
);
3531 ret
= zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
3537 /* convert override strings properties to native */
3538 if ((voprops
= zfs_valid_proplist(hdl
, ZFS_TYPE_DATASET
,
3539 oprops
, zoned
, zhp
, zpool_hdl
, B_FALSE
, errbuf
)) == NULL
) {
3540 ret
= zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
3544 /* second pass: process "-o" properties */
3545 fnvlist_merge(*oxprops
, voprops
);
3546 fnvlist_free(voprops
);
3548 /* override props on child dataset are inherited */
3550 while ((nvp
= nvlist_next_nvpair(oprops
, nvp
)) != NULL
) {
3551 const char *name
= nvpair_name(nvp
);
3552 fnvlist_add_boolean(*oxprops
, name
);
3557 fnvlist_free(oprops
);
3562 * Restores a backup of tosnap from the file descriptor specified by infd.
3565 zfs_receive_one(libzfs_handle_t
*hdl
, int infd
, const char *tosnap
,
3566 const char *originsnap
, recvflags_t
*flags
, dmu_replay_record_t
*drr
,
3567 dmu_replay_record_t
*drr_noswap
, const char *sendfs
, nvlist_t
*stream_nv
,
3568 avl_tree_t
*stream_avl
, char **top_zfs
, int cleanup_fd
,
3569 uint64_t *action_handlep
, const char *finalsnap
, nvlist_t
*cmdprops
)
3572 int ioctl_err
, ioctl_errno
, err
;
3574 struct drr_begin
*drrb
= &drr
->drr_u
.drr_begin
;
3576 const char *chopprefix
;
3577 boolean_t newfs
= B_FALSE
;
3578 boolean_t stream_wantsnewfs
;
3579 boolean_t newprops
= B_FALSE
;
3580 uint64_t read_bytes
= 0;
3581 uint64_t errflags
= 0;
3582 uint64_t parent_snapguid
= 0;
3583 prop_changelist_t
*clp
= NULL
;
3584 nvlist_t
*snapprops_nvlist
= NULL
;
3585 zprop_errflags_t prop_errflags
;
3586 nvlist_t
*prop_errors
= NULL
;
3587 boolean_t recursive
;
3588 char *snapname
= NULL
;
3589 char destsnap
[MAXPATHLEN
* 2];
3590 char origin
[MAXNAMELEN
];
3591 char name
[MAXPATHLEN
];
3592 char tmp_keylocation
[MAXNAMELEN
];
3593 nvlist_t
*rcvprops
= NULL
; /* props received from the send stream */
3594 nvlist_t
*oxprops
= NULL
; /* override (-o) and exclude (-x) props */
3595 nvlist_t
*origprops
= NULL
; /* original props (if destination exists) */
3598 boolean_t zoned
= B_FALSE
;
3600 begin_time
= time(NULL
);
3601 bzero(origin
, MAXNAMELEN
);
3602 bzero(tmp_keylocation
, MAXNAMELEN
);
3604 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
3607 recursive
= (nvlist_lookup_boolean(stream_nv
, "not_recursive") ==
3610 if (stream_avl
!= NULL
) {
3611 char *keylocation
= NULL
;
3612 nvlist_t
*lookup
= NULL
;
3613 nvlist_t
*fs
= fsavl_find(stream_avl
, drrb
->drr_toguid
,
3616 (void) nvlist_lookup_uint64(fs
, "parentfromsnap",
3618 err
= nvlist_lookup_nvlist(fs
, "props", &rcvprops
);
3620 VERIFY(0 == nvlist_alloc(&rcvprops
, NV_UNIQUE_NAME
, 0));
3625 * The keylocation property may only be set on encryption roots,
3626 * but this dataset might not become an encryption root until
3627 * recv_fix_encryption_heirarchy() is called. That function
3628 * will fixup the keylocation anyway, so we temporarily unset
3629 * the keylocation for now to avoid any errors from the receive
3632 err
= nvlist_lookup_string(rcvprops
,
3633 zfs_prop_to_name(ZFS_PROP_KEYLOCATION
), &keylocation
);
3635 strcpy(tmp_keylocation
, keylocation
);
3636 (void) nvlist_remove_all(rcvprops
,
3637 zfs_prop_to_name(ZFS_PROP_KEYLOCATION
));
3640 if (flags
->canmountoff
) {
3641 VERIFY(0 == nvlist_add_uint64(rcvprops
,
3642 zfs_prop_to_name(ZFS_PROP_CANMOUNT
), 0));
3644 if (0 == nvlist_lookup_nvlist(fs
, "snapprops", &lookup
)) {
3645 VERIFY(0 == nvlist_lookup_nvlist(lookup
,
3646 snapname
, &snapprops_nvlist
));
3653 * Determine how much of the snapshot name stored in the stream
3654 * we are going to tack on to the name they specified on the
3655 * command line, and how much we are going to chop off.
3657 * If they specified a snapshot, chop the entire name stored in
3660 if (flags
->istail
) {
3662 * A filesystem was specified with -e. We want to tack on only
3663 * the tail of the sent snapshot path.
3665 if (strchr(tosnap
, '@')) {
3666 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
, "invalid "
3667 "argument - snapshot not allowed with -e"));
3668 err
= zfs_error(hdl
, EZFS_INVALIDNAME
, errbuf
);
3672 chopprefix
= strrchr(sendfs
, '/');
3674 if (chopprefix
== NULL
) {
3676 * The tail is the poolname, so we need to
3677 * prepend a path separator.
3679 int len
= strlen(drrb
->drr_toname
);
3680 cp
= malloc(len
+ 2);
3682 (void) strcpy(&cp
[1], drrb
->drr_toname
);
3685 chopprefix
= drrb
->drr_toname
+ (chopprefix
- sendfs
);
3687 } else if (flags
->isprefix
) {
3689 * A filesystem was specified with -d. We want to tack on
3690 * everything but the first element of the sent snapshot path
3691 * (all but the pool name).
3693 if (strchr(tosnap
, '@')) {
3694 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
, "invalid "
3695 "argument - snapshot not allowed with -d"));
3696 err
= zfs_error(hdl
, EZFS_INVALIDNAME
, errbuf
);
3700 chopprefix
= strchr(drrb
->drr_toname
, '/');
3701 if (chopprefix
== NULL
)
3702 chopprefix
= strchr(drrb
->drr_toname
, '@');
3703 } else if (strchr(tosnap
, '@') == NULL
) {
3705 * If a filesystem was specified without -d or -e, we want to
3706 * tack on everything after the fs specified by 'zfs send'.
3708 chopprefix
= drrb
->drr_toname
+ strlen(sendfs
);
3710 /* A snapshot was specified as an exact path (no -d or -e). */
3712 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3713 "cannot specify snapshot name for multi-snapshot "
3715 err
= zfs_error(hdl
, EZFS_BADSTREAM
, errbuf
);
3718 chopprefix
= drrb
->drr_toname
+ strlen(drrb
->drr_toname
);
3721 ASSERT(strstr(drrb
->drr_toname
, sendfs
) == drrb
->drr_toname
);
3722 ASSERT(chopprefix
> drrb
->drr_toname
);
3723 ASSERT(chopprefix
<= drrb
->drr_toname
+ strlen(drrb
->drr_toname
));
3724 ASSERT(chopprefix
[0] == '/' || chopprefix
[0] == '@' ||
3725 chopprefix
[0] == '\0');
3728 * Determine name of destination snapshot.
3730 (void) strlcpy(destsnap
, tosnap
, sizeof (destsnap
));
3731 (void) strlcat(destsnap
, chopprefix
, sizeof (destsnap
));
3733 if (!zfs_name_valid(destsnap
, ZFS_TYPE_SNAPSHOT
)) {
3734 err
= zfs_error(hdl
, EZFS_INVALIDNAME
, errbuf
);
3739 * Determine the name of the origin snapshot.
3742 (void) strncpy(origin
, originsnap
, sizeof (origin
));
3744 (void) printf("using provided clone origin %s\n",
3746 } else if (drrb
->drr_flags
& DRR_FLAG_CLONE
) {
3747 if (guid_to_name(hdl
, destsnap
,
3748 drrb
->drr_fromguid
, B_FALSE
, origin
) != 0) {
3749 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3750 "local origin for clone %s does not exist"),
3752 err
= zfs_error(hdl
, EZFS_NOENT
, errbuf
);
3756 (void) printf("found clone origin %s\n", origin
);
3759 boolean_t resuming
= DMU_GET_FEATUREFLAGS(drrb
->drr_versioninfo
) &
3760 DMU_BACKUP_FEATURE_RESUMING
;
3761 boolean_t raw
= DMU_GET_FEATUREFLAGS(drrb
->drr_versioninfo
) &
3762 DMU_BACKUP_FEATURE_RAW
;
3763 boolean_t embedded
= DMU_GET_FEATUREFLAGS(drrb
->drr_versioninfo
) &
3764 DMU_BACKUP_FEATURE_EMBED_DATA
;
3765 stream_wantsnewfs
= (drrb
->drr_fromguid
== 0 ||
3766 (drrb
->drr_flags
& DRR_FLAG_CLONE
) || originsnap
) && !resuming
;
3768 if (stream_wantsnewfs
) {
3770 * if the parent fs does not exist, look for it based on
3771 * the parent snap GUID
3773 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
3774 "cannot receive new filesystem stream"));
3776 (void) strcpy(name
, destsnap
);
3777 cp
= strrchr(name
, '/');
3781 !zfs_dataset_exists(hdl
, name
, ZFS_TYPE_DATASET
)) {
3782 char suffix
[ZFS_MAX_DATASET_NAME_LEN
];
3783 (void) strcpy(suffix
, strrchr(destsnap
, '/'));
3784 if (guid_to_name(hdl
, name
, parent_snapguid
,
3785 B_FALSE
, destsnap
) == 0) {
3786 *strchr(destsnap
, '@') = '\0';
3787 (void) strcat(destsnap
, suffix
);
3792 * if the fs does not exist, look for it based on the
3795 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
3796 "cannot receive incremental stream"));
3798 (void) strcpy(name
, destsnap
);
3799 *strchr(name
, '@') = '\0';
3802 * If the exact receive path was specified and this is the
3803 * topmost path in the stream, then if the fs does not exist we
3804 * should look no further.
3806 if ((flags
->isprefix
|| (*(chopprefix
= drrb
->drr_toname
+
3807 strlen(sendfs
)) != '\0' && *chopprefix
!= '@')) &&
3808 !zfs_dataset_exists(hdl
, name
, ZFS_TYPE_DATASET
)) {
3809 char snap
[ZFS_MAX_DATASET_NAME_LEN
];
3810 (void) strcpy(snap
, strchr(destsnap
, '@'));
3811 if (guid_to_name(hdl
, name
, drrb
->drr_fromguid
,
3812 B_FALSE
, destsnap
) == 0) {
3813 *strchr(destsnap
, '@') = '\0';
3814 (void) strcat(destsnap
, snap
);
3819 (void) strcpy(name
, destsnap
);
3820 *strchr(name
, '@') = '\0';
3822 if (zfs_dataset_exists(hdl
, name
, ZFS_TYPE_DATASET
)) {
3823 zfs_cmd_t zc
= {"\0"};
3826 (void) strcpy(zc
.zc_name
, name
);
3829 * Destination fs exists. It must be one of these cases:
3830 * - an incremental send stream
3831 * - the stream specifies a new fs (full stream or clone)
3832 * and they want us to blow away the existing fs (and
3833 * have therefore specified -F and removed any snapshots)
3834 * - we are resuming a failed receive.
3836 if (stream_wantsnewfs
) {
3837 if (!flags
->force
) {
3838 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3839 "destination '%s' exists\n"
3840 "must specify -F to overwrite it"), name
);
3841 err
= zfs_error(hdl
, EZFS_EXISTS
, errbuf
);
3844 if (ioctl(hdl
->libzfs_fd
, ZFS_IOC_SNAPSHOT_LIST_NEXT
,
3846 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3847 "destination has snapshots (eg. %s)\n"
3848 "must destroy them to overwrite it"),
3850 err
= zfs_error(hdl
, EZFS_EXISTS
, errbuf
);
3855 if ((zhp
= zfs_open(hdl
, name
,
3856 ZFS_TYPE_FILESYSTEM
| ZFS_TYPE_VOLUME
)) == NULL
) {
3861 if (stream_wantsnewfs
&&
3862 zhp
->zfs_dmustats
.dds_origin
[0]) {
3864 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3865 "destination '%s' is a clone\n"
3866 "must destroy it to overwrite it"), name
);
3867 err
= zfs_error(hdl
, EZFS_EXISTS
, errbuf
);
3872 * zfs recv -F cant be used to blow away an existing
3873 * encrypted filesystem. This is because it would require
3874 * the dsl dir to point to the the new key (or lack of a
3875 * key) and the old key at the same time. The -F flag may
3876 * still be used for deleting intermediate snapshots that
3877 * would otherwise prevent the receive from working.
3879 if (stream_wantsnewfs
&& flags
->force
&&
3880 zfs_prop_get_int(zhp
, ZFS_PROP_ENCRYPTION
) !=
3883 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3884 "zfs receive -F cannot be used to "
3885 "destroy an encrypted filesystem"));
3886 err
= zfs_error(hdl
, EZFS_BADRESTORE
, errbuf
);
3891 if (!flags
->dryrun
&& zhp
->zfs_type
== ZFS_TYPE_FILESYSTEM
&&
3892 stream_wantsnewfs
) {
3893 /* We can't do online recv in this case */
3894 clp
= changelist_gather(zhp
, ZFS_PROP_NAME
, 0, 0);
3900 if (changelist_prefix(clp
) != 0) {
3901 changelist_free(clp
);
3909 * If we are resuming a newfs, set newfs here so that we will
3910 * mount it if the recv succeeds this time. We can tell
3911 * that it was a newfs on the first recv because the fs
3912 * itself will be inconsistent (if the fs existed when we
3913 * did the first recv, we would have received it into
3916 if (resuming
&& zfs_prop_get_int(zhp
, ZFS_PROP_INCONSISTENT
))
3919 /* we want to know if we're zoned when validating -o|-x props */
3920 zoned
= zfs_prop_get_int(zhp
, ZFS_PROP_ZONED
);
3922 /* gather existing properties on destination */
3923 origprops
= fnvlist_alloc();
3924 fnvlist_merge(origprops
, zhp
->zfs_props
);
3925 fnvlist_merge(origprops
, zhp
->zfs_user_props
);
3932 * Destination filesystem does not exist. Therefore we better
3933 * be creating a new filesystem (either from a full backup, or
3934 * a clone). It would therefore be invalid if the user
3935 * specified only the pool name (i.e. if the destination name
3936 * contained no slash character).
3938 cp
= strrchr(name
, '/');
3940 if (!stream_wantsnewfs
|| cp
== NULL
) {
3941 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3942 "destination '%s' does not exist"), name
);
3943 err
= zfs_error(hdl
, EZFS_NOENT
, errbuf
);
3948 * Trim off the final dataset component so we perform the
3949 * recvbackup ioctl to the filesystems's parent.
3953 if (flags
->isprefix
&& !flags
->istail
&& !flags
->dryrun
&&
3954 create_parents(hdl
, destsnap
, strlen(tosnap
)) != 0) {
3955 err
= zfs_error(hdl
, EZFS_BADRESTORE
, errbuf
);
3960 * It is invalid to receive a properties stream that was
3961 * unencrypted on the send side as a child of an encrypted
3962 * parent. Technically there is nothing preventing this, but
3963 * it would mean that the encryption=off property which is
3964 * locally set on the send side would not be received correctly.
3965 * We can infer encryption=off if the stream is not raw and
3966 * properties were included since the send side will only ever
3967 * send the encryption property in a raw nvlist header.
3969 if (!raw
&& rcvprops
!= NULL
) {
3972 zhp
= zfs_open(hdl
, name
, ZFS_TYPE_DATASET
);
3974 err
= zfs_error(hdl
, EZFS_BADRESTORE
, errbuf
);
3978 crypt
= zfs_prop_get_int(zhp
, ZFS_PROP_ENCRYPTION
);
3981 if (crypt
!= ZIO_CRYPT_OFF
) {
3982 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3983 "parent '%s' must not be encrypted to "
3984 "receive unenecrypted property"), name
);
3985 err
= zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
3994 if (flags
->verbose
) {
3995 (void) printf("%s %s stream of %s into %s\n",
3996 flags
->dryrun
? "would receive" : "receiving",
3997 drrb
->drr_fromguid
? "incremental" : "full",
3998 drrb
->drr_toname
, destsnap
);
3999 (void) fflush(stdout
);
4002 if (flags
->dryrun
) {
4003 err
= recv_skip(hdl
, infd
, flags
->byteswap
);
4007 toplevel
= chopprefix
[0] != '/';
4008 if (drrb
->drr_type
== DMU_OST_ZVOL
) {
4009 type
= ZFS_TYPE_VOLUME
;
4010 } else if (drrb
->drr_type
== DMU_OST_ZFS
) {
4011 type
= ZFS_TYPE_FILESYSTEM
;
4013 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4014 "invalid record type: 0x%d"), drrb
->drr_type
);
4015 err
= zfs_error(hdl
, EZFS_BADSTREAM
, errbuf
);
4018 if ((err
= zfs_setup_cmdline_props(hdl
, type
, zoned
, recursive
,
4019 toplevel
, rcvprops
, cmdprops
, origprops
, &oxprops
, errbuf
)) != 0)
4022 err
= ioctl_err
= lzc_receive_with_cmdprops(destsnap
, rcvprops
, oxprops
,
4023 origin
, flags
->force
, flags
->resumable
, raw
, infd
, drr_noswap
,
4024 cleanup_fd
, &read_bytes
, &errflags
, action_handlep
, &prop_errors
);
4025 ioctl_errno
= ioctl_err
;
4026 prop_errflags
= errflags
;
4029 nvpair_t
*prop_err
= NULL
;
4031 while ((prop_err
= nvlist_next_nvpair(prop_errors
,
4032 prop_err
)) != NULL
) {
4037 prop
= zfs_name_to_prop(nvpair_name(prop_err
));
4038 (void) nvpair_value_int32(prop_err
, &intval
);
4039 if (strcmp(nvpair_name(prop_err
),
4040 ZPROP_N_MORE_ERRORS
) == 0) {
4041 trunc_prop_errs(intval
);
4043 } else if (snapname
== NULL
|| finalsnap
== NULL
||
4044 strcmp(finalsnap
, snapname
) == 0 ||
4045 strcmp(nvpair_name(prop_err
),
4046 zfs_prop_to_name(ZFS_PROP_REFQUOTA
)) != 0) {
4048 * Skip the special case of, for example,
4049 * "refquota", errors on intermediate
4050 * snapshots leading up to a final one.
4051 * That's why we have all of the checks above.
4053 * See zfs_ioctl.c's extract_delay_props() for
4054 * a list of props which can fail on
4055 * intermediate snapshots, but shouldn't
4056 * affect the overall receive.
4058 (void) snprintf(tbuf
, sizeof (tbuf
),
4059 dgettext(TEXT_DOMAIN
,
4060 "cannot receive %s property on %s"),
4061 nvpair_name(prop_err
), name
);
4062 zfs_setprop_error(hdl
, prop
, intval
, tbuf
);
4067 if (err
== 0 && snapprops_nvlist
) {
4068 zfs_cmd_t zc
= {"\0"};
4070 (void) strcpy(zc
.zc_name
, destsnap
);
4071 zc
.zc_cookie
= B_TRUE
; /* received */
4072 if (zcmd_write_src_nvlist(hdl
, &zc
, snapprops_nvlist
) == 0) {
4073 (void) zfs_ioctl(hdl
, ZFS_IOC_SET_PROP
, &zc
);
4074 zcmd_free_nvlists(&zc
);
4078 if (err
&& (ioctl_errno
== ENOENT
|| ioctl_errno
== EEXIST
)) {
4080 * It may be that this snapshot already exists,
4081 * in which case we want to consume & ignore it
4082 * rather than failing.
4084 avl_tree_t
*local_avl
;
4085 nvlist_t
*local_nv
, *fs
;
4086 cp
= strchr(destsnap
, '@');
4089 * XXX Do this faster by just iterating over snaps in
4090 * this fs. Also if zc_value does not exist, we will
4091 * get a strange "does not exist" error message.
4094 if (gather_nvlist(hdl
, destsnap
, NULL
, NULL
, B_FALSE
, B_TRUE
,
4095 B_FALSE
, &local_nv
, &local_avl
) == 0) {
4097 fs
= fsavl_find(local_avl
, drrb
->drr_toguid
, NULL
);
4098 fsavl_destroy(local_avl
);
4099 nvlist_free(local_nv
);
4102 if (flags
->verbose
) {
4103 (void) printf("snap %s already exists; "
4104 "ignoring\n", destsnap
);
4106 err
= ioctl_err
= recv_skip(hdl
, infd
,
4113 if (ioctl_err
!= 0) {
4114 switch (ioctl_errno
) {
4116 cp
= strchr(destsnap
, '@');
4118 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4119 "most recent snapshot of %s does not\n"
4120 "match incremental source"), destsnap
);
4121 (void) zfs_error(hdl
, EZFS_BADRESTORE
, errbuf
);
4125 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4126 "destination %s has been modified\n"
4127 "since most recent snapshot"), name
);
4128 (void) zfs_error(hdl
, EZFS_BADRESTORE
, errbuf
);
4131 if (raw
&& stream_wantsnewfs
) {
4132 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4133 "failed to create encryption key"));
4134 } else if (raw
&& !stream_wantsnewfs
) {
4135 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4136 "encryption key does not match "
4139 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4140 "inherited key must be loaded"));
4142 (void) zfs_error(hdl
, EZFS_CRYPTOFAILED
, errbuf
);
4145 cp
= strchr(destsnap
, '@');
4147 /* it's the containing fs that exists */
4150 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4151 "destination already exists"));
4152 (void) zfs_error_fmt(hdl
, EZFS_EXISTS
,
4153 dgettext(TEXT_DOMAIN
, "cannot restore to %s"),
4158 if (flags
->resumable
)
4159 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4160 "kernel modules must be upgraded to "
4161 "receive this stream."));
4162 if (embedded
&& !raw
)
4163 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4164 "incompatible embedded data stream "
4165 "feature with encrypted receive."));
4166 (void) zfs_error(hdl
, EZFS_BADSTREAM
, errbuf
);
4169 recv_ecksum_set_aux(hdl
, destsnap
, flags
->resumable
);
4170 (void) zfs_error(hdl
, EZFS_BADSTREAM
, errbuf
);
4173 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4174 "pool must be upgraded to receive this stream."));
4175 (void) zfs_error(hdl
, EZFS_BADVERSION
, errbuf
);
4178 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4179 "destination %s space quota exceeded"), name
);
4180 (void) zfs_error(hdl
, EZFS_NOSPC
, errbuf
);
4183 (void) zfs_standard_error(hdl
, ioctl_errno
, errbuf
);
4188 * Mount the target filesystem (if created). Also mount any
4189 * children of the target filesystem if we did a replication
4190 * receive (indicated by stream_avl being non-NULL).
4192 cp
= strchr(destsnap
, '@');
4193 if (cp
&& (ioctl_err
== 0 || !newfs
)) {
4197 h
= zfs_open(hdl
, destsnap
,
4198 ZFS_TYPE_FILESYSTEM
| ZFS_TYPE_VOLUME
);
4200 if (h
->zfs_type
== ZFS_TYPE_VOLUME
) {
4202 } else if (newfs
|| stream_avl
) {
4204 * Track the first/top of hierarchy fs,
4205 * for mounting and sharing later.
4207 if (top_zfs
&& *top_zfs
== NULL
)
4208 *top_zfs
= zfs_strdup(hdl
, destsnap
);
4216 if (!flags
->nomount
)
4217 err
|= changelist_postfix(clp
);
4218 changelist_free(clp
);
4221 if (prop_errflags
& ZPROP_ERR_NOCLEAR
) {
4222 (void) fprintf(stderr
, dgettext(TEXT_DOMAIN
, "Warning: "
4223 "failed to clear unreceived properties on %s"), name
);
4224 (void) fprintf(stderr
, "\n");
4226 if (prop_errflags
& ZPROP_ERR_NORESTORE
) {
4227 (void) fprintf(stderr
, dgettext(TEXT_DOMAIN
, "Warning: "
4228 "failed to restore original properties on %s"), name
);
4229 (void) fprintf(stderr
, "\n");
4232 if (err
|| ioctl_err
) {
4237 if (flags
->verbose
) {
4240 uint64_t bytes
= read_bytes
;
4241 time_t delta
= time(NULL
) - begin_time
;
4244 zfs_nicebytes(bytes
, buf1
, sizeof (buf1
));
4245 zfs_nicebytes(bytes
/delta
, buf2
, sizeof (buf1
));
4247 (void) printf("received %s stream in %lu seconds (%s/sec)\n",
4253 if (prop_errors
!= NULL
)
4254 nvlist_free(prop_errors
);
4256 if (tmp_keylocation
[0] != '\0') {
4257 VERIFY(0 == nvlist_add_string(rcvprops
,
4258 zfs_prop_to_name(ZFS_PROP_KEYLOCATION
), tmp_keylocation
));
4262 nvlist_free(rcvprops
);
4264 nvlist_free(oxprops
);
4265 nvlist_free(origprops
);
4271 * Check properties we were asked to override (both -o|-x)
4274 zfs_receive_checkprops(libzfs_handle_t
*hdl
, nvlist_t
*props
,
4282 while ((nvp
= nvlist_next_nvpair(props
, nvp
)) != NULL
) {
4283 name
= nvpair_name(nvp
);
4284 prop
= zfs_name_to_prop(name
);
4286 if (prop
== ZPROP_INVAL
) {
4287 if (!zfs_prop_user(name
)) {
4288 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4289 "invalid property '%s'"), name
);
4295 * "origin" is readonly but is used to receive datasets as
4296 * clones so we don't raise an error here
4298 if (prop
== ZFS_PROP_ORIGIN
)
4302 * cannot override readonly, set-once and other specific
4303 * settable properties
4305 if (zfs_prop_readonly(prop
) || prop
== ZFS_PROP_VERSION
||
4306 prop
== ZFS_PROP_VOLSIZE
) {
4307 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4308 "invalid property '%s'"), name
);
4317 zfs_receive_impl(libzfs_handle_t
*hdl
, const char *tosnap
,
4318 const char *originsnap
, recvflags_t
*flags
, int infd
, const char *sendfs
,
4319 nvlist_t
*stream_nv
, avl_tree_t
*stream_avl
, char **top_zfs
, int cleanup_fd
,
4320 uint64_t *action_handlep
, const char *finalsnap
, nvlist_t
*cmdprops
)
4323 dmu_replay_record_t drr
, drr_noswap
;
4324 struct drr_begin
*drrb
= &drr
.drr_u
.drr_begin
;
4326 zio_cksum_t zcksum
= { { 0 } };
4327 uint64_t featureflags
;
4330 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
4333 /* check cmdline props, raise an error if they cannot be received */
4334 if (!zfs_receive_checkprops(hdl
, cmdprops
, errbuf
)) {
4335 return (zfs_error(hdl
, EZFS_BADPROP
, errbuf
));
4338 if (flags
->isprefix
&&
4339 !zfs_dataset_exists(hdl
, tosnap
, ZFS_TYPE_DATASET
)) {
4340 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
, "specified fs "
4341 "(%s) does not exist"), tosnap
);
4342 return (zfs_error(hdl
, EZFS_NOENT
, errbuf
));
4345 !zfs_dataset_exists(hdl
, originsnap
, ZFS_TYPE_DATASET
)) {
4346 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
, "specified origin fs "
4347 "(%s) does not exist"), originsnap
);
4348 return (zfs_error(hdl
, EZFS_NOENT
, errbuf
));
4351 /* read in the BEGIN record */
4352 if (0 != (err
= recv_read(hdl
, infd
, &drr
, sizeof (drr
), B_FALSE
,
4356 if (drr
.drr_type
== DRR_END
|| drr
.drr_type
== BSWAP_32(DRR_END
)) {
4357 /* It's the double end record at the end of a package */
4361 /* the kernel needs the non-byteswapped begin record */
4364 flags
->byteswap
= B_FALSE
;
4365 if (drrb
->drr_magic
== BSWAP_64(DMU_BACKUP_MAGIC
)) {
4367 * We computed the checksum in the wrong byteorder in
4368 * recv_read() above; do it again correctly.
4370 bzero(&zcksum
, sizeof (zio_cksum_t
));
4371 fletcher_4_incremental_byteswap(&drr
, sizeof (drr
), &zcksum
);
4372 flags
->byteswap
= B_TRUE
;
4374 drr
.drr_type
= BSWAP_32(drr
.drr_type
);
4375 drr
.drr_payloadlen
= BSWAP_32(drr
.drr_payloadlen
);
4376 drrb
->drr_magic
= BSWAP_64(drrb
->drr_magic
);
4377 drrb
->drr_versioninfo
= BSWAP_64(drrb
->drr_versioninfo
);
4378 drrb
->drr_creation_time
= BSWAP_64(drrb
->drr_creation_time
);
4379 drrb
->drr_type
= BSWAP_32(drrb
->drr_type
);
4380 drrb
->drr_flags
= BSWAP_32(drrb
->drr_flags
);
4381 drrb
->drr_toguid
= BSWAP_64(drrb
->drr_toguid
);
4382 drrb
->drr_fromguid
= BSWAP_64(drrb
->drr_fromguid
);
4385 if (drrb
->drr_magic
!= DMU_BACKUP_MAGIC
|| drr
.drr_type
!= DRR_BEGIN
) {
4386 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
, "invalid "
4387 "stream (bad magic number)"));
4388 return (zfs_error(hdl
, EZFS_BADSTREAM
, errbuf
));
4391 featureflags
= DMU_GET_FEATUREFLAGS(drrb
->drr_versioninfo
);
4392 hdrtype
= DMU_GET_STREAM_HDRTYPE(drrb
->drr_versioninfo
);
4394 if (!DMU_STREAM_SUPPORTED(featureflags
) ||
4395 (hdrtype
!= DMU_SUBSTREAM
&& hdrtype
!= DMU_COMPOUNDSTREAM
)) {
4396 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4397 "stream has unsupported feature, feature flags = %lx"),
4399 return (zfs_error(hdl
, EZFS_BADSTREAM
, errbuf
));
4402 if (strchr(drrb
->drr_toname
, '@') == NULL
) {
4403 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
, "invalid "
4404 "stream (bad snapshot name)"));
4405 return (zfs_error(hdl
, EZFS_BADSTREAM
, errbuf
));
4408 if (DMU_GET_STREAM_HDRTYPE(drrb
->drr_versioninfo
) == DMU_SUBSTREAM
) {
4409 char nonpackage_sendfs
[ZFS_MAX_DATASET_NAME_LEN
];
4410 if (sendfs
== NULL
) {
4412 * We were not called from zfs_receive_package(). Get
4413 * the fs specified by 'zfs send'.
4416 (void) strlcpy(nonpackage_sendfs
,
4417 drr
.drr_u
.drr_begin
.drr_toname
,
4418 sizeof (nonpackage_sendfs
));
4419 if ((cp
= strchr(nonpackage_sendfs
, '@')) != NULL
)
4421 sendfs
= nonpackage_sendfs
;
4422 VERIFY(finalsnap
== NULL
);
4424 return (zfs_receive_one(hdl
, infd
, tosnap
, originsnap
, flags
,
4425 &drr
, &drr_noswap
, sendfs
, stream_nv
, stream_avl
, top_zfs
,
4426 cleanup_fd
, action_handlep
, finalsnap
, cmdprops
));
4428 assert(DMU_GET_STREAM_HDRTYPE(drrb
->drr_versioninfo
) ==
4429 DMU_COMPOUNDSTREAM
);
4430 return (zfs_receive_package(hdl
, infd
, tosnap
, flags
, &drr
,
4431 &zcksum
, top_zfs
, cleanup_fd
, action_handlep
, cmdprops
));
4436 * Restores a backup of tosnap from the file descriptor specified by infd.
4437 * Return 0 on total success, -2 if some things couldn't be
4438 * destroyed/renamed/promoted, -1 if some things couldn't be received.
4439 * (-1 will override -2, if -1 and the resumable flag was specified the
4440 * transfer can be resumed if the sending side supports it).
4443 zfs_receive(libzfs_handle_t
*hdl
, const char *tosnap
, nvlist_t
*props
,
4444 recvflags_t
*flags
, int infd
, avl_tree_t
*stream_avl
)
4446 char *top_zfs
= NULL
;
4449 uint64_t action_handle
= 0;
4451 char *originsnap
= NULL
;
4454 * The only way fstat can fail is if we do not have a valid file
4457 if (fstat(infd
, &sb
) == -1) {
4463 #ifndef F_SETPIPE_SZ
4464 #define F_SETPIPE_SZ (F_SETLEASE + 7)
4465 #endif /* F_SETPIPE_SZ */
4467 #ifndef F_GETPIPE_SZ
4468 #define F_GETPIPE_SZ (F_GETLEASE + 7)
4469 #endif /* F_GETPIPE_SZ */
4472 * It is not uncommon for gigabytes to be processed in zfs receive.
4473 * Speculatively increase the buffer size via Linux-specific fcntl()
4476 if (S_ISFIFO(sb
.st_mode
)) {
4477 FILE *procf
= fopen("/proc/sys/fs/pipe-max-size", "r");
4479 if (procf
!= NULL
) {
4480 unsigned long max_psize
;
4482 if (fscanf(procf
, "%lu", &max_psize
) > 0) {
4483 cur_psize
= fcntl(infd
, F_GETPIPE_SZ
);
4484 if (cur_psize
> 0 &&
4485 max_psize
> (unsigned long) cur_psize
)
4486 (void) fcntl(infd
, F_SETPIPE_SZ
,
4492 #endif /* __linux__ */
4495 err
= nvlist_lookup_string(props
, "origin", &originsnap
);
4496 if (err
&& err
!= ENOENT
)
4500 cleanup_fd
= open(ZFS_DEV
, O_RDWR
);
4501 VERIFY(cleanup_fd
>= 0);
4503 err
= zfs_receive_impl(hdl
, tosnap
, originsnap
, flags
, infd
, NULL
, NULL
,
4504 stream_avl
, &top_zfs
, cleanup_fd
, &action_handle
, NULL
, props
);
4506 VERIFY(0 == close(cleanup_fd
));
4508 if (err
== 0 && !flags
->nomount
&& top_zfs
) {
4509 zfs_handle_t
*zhp
= NULL
;
4510 prop_changelist_t
*clp
= NULL
;
4512 zhp
= zfs_open(hdl
, top_zfs
, ZFS_TYPE_FILESYSTEM
);
4514 clp
= changelist_gather(zhp
, ZFS_PROP_MOUNTPOINT
,
4515 CL_GATHER_MOUNT_ALWAYS
, 0);
4518 /* mount and share received datasets */
4519 err
= changelist_postfix(clp
);
4520 changelist_free(clp
);
4523 if (zhp
== NULL
|| clp
== NULL
|| err
)