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
,
1247 (void) fprintf(fout
, "\t%llu",
1251 zfs_nicebytes(size
, buf
, sizeof (buf
));
1252 (void) fprintf(fout
, dgettext(TEXT_DOMAIN
,
1253 " estimated size is %s"), buf
);
1256 (void) fprintf(fout
, "\n");
1260 dump_snapshot(zfs_handle_t
*zhp
, void *arg
)
1262 send_dump_data_t
*sdd
= arg
;
1263 progress_arg_t pa
= { 0 };
1266 enum lzc_send_flags flags
= 0;
1268 boolean_t isfromsnap
, istosnap
, fromorigin
;
1269 boolean_t exclude
= B_FALSE
;
1270 FILE *fout
= sdd
->std_out
? stdout
: stderr
;
1273 thissnap
= strchr(zhp
->zfs_name
, '@') + 1;
1274 isfromsnap
= (sdd
->fromsnap
!= NULL
&&
1275 strcmp(sdd
->fromsnap
, thissnap
) == 0);
1277 if (!sdd
->seenfrom
&& isfromsnap
) {
1278 gather_holds(zhp
, sdd
);
1279 sdd
->seenfrom
= B_TRUE
;
1280 (void) strlcpy(sdd
->prevsnap
, thissnap
,
1281 sizeof (sdd
->prevsnap
));
1282 sdd
->prevsnap_obj
= zfs_prop_get_int(zhp
, ZFS_PROP_OBJSETID
);
1287 if (sdd
->seento
|| !sdd
->seenfrom
) {
1292 istosnap
= (strcmp(sdd
->tosnap
, thissnap
) == 0);
1294 sdd
->seento
= B_TRUE
;
1296 if (sdd
->large_block
)
1297 flags
|= LZC_SEND_FLAG_LARGE_BLOCK
;
1298 if (sdd
->embed_data
)
1299 flags
|= LZC_SEND_FLAG_EMBED_DATA
;
1301 flags
|= LZC_SEND_FLAG_COMPRESS
;
1303 flags
|= LZC_SEND_FLAG_RAW
;
1305 if (!sdd
->doall
&& !isfromsnap
&& !istosnap
) {
1306 if (sdd
->replicate
) {
1308 nvlist_t
*snapprops
;
1310 * Filter out all intermediate snapshots except origin
1311 * snapshots needed to replicate clones.
1313 nvlist_t
*nvfs
= fsavl_find(sdd
->fsavl
,
1314 zhp
->zfs_dmustats
.dds_guid
, &snapname
);
1316 VERIFY(0 == nvlist_lookup_nvlist(nvfs
,
1317 "snapprops", &snapprops
));
1318 VERIFY(0 == nvlist_lookup_nvlist(snapprops
,
1319 thissnap
, &snapprops
));
1320 exclude
= !nvlist_exists(snapprops
, "is_clone_origin");
1327 * If a filter function exists, call it to determine whether
1328 * this snapshot will be sent.
1330 if (exclude
|| (sdd
->filter_cb
!= NULL
&&
1331 sdd
->filter_cb(zhp
, sdd
->filter_cb_arg
) == B_FALSE
)) {
1333 * This snapshot is filtered out. Don't send it, and don't
1334 * set prevsnap_obj, so it will be as if this snapshot didn't
1335 * exist, and the next accepted snapshot will be sent as
1336 * an incremental from the last accepted one, or as the
1337 * first (and full) snapshot in the case of a replication,
1338 * non-incremental send.
1344 gather_holds(zhp
, sdd
);
1345 fromorigin
= sdd
->prevsnap
[0] == '\0' &&
1346 (sdd
->fromorigin
|| sdd
->replicate
);
1350 char fromds
[ZFS_MAX_DATASET_NAME_LEN
];
1352 if (sdd
->prevsnap
[0] != '\0') {
1353 (void) strlcpy(fromds
, zhp
->zfs_name
, sizeof (fromds
));
1354 *(strchr(fromds
, '@') + 1) = '\0';
1355 (void) strlcat(fromds
, sdd
->prevsnap
, sizeof (fromds
));
1357 if (zfs_send_space(zhp
, zhp
->zfs_name
,
1358 sdd
->prevsnap
[0] ? fromds
: NULL
, flags
, &size
) != 0) {
1359 size
= 0; /* cannot estimate send space */
1361 send_print_verbose(fout
, zhp
->zfs_name
,
1362 sdd
->prevsnap
[0] ? sdd
->prevsnap
: NULL
,
1363 size
, sdd
->parsable
);
1370 * If progress reporting is requested, spawn a new thread to
1371 * poll ZFS_IOC_SEND_PROGRESS at a regular interval.
1373 if (sdd
->progress
) {
1375 pa
.pa_fd
= sdd
->outfd
;
1376 pa
.pa_parsable
= sdd
->parsable
;
1378 if ((err
= pthread_create(&tid
, NULL
,
1379 send_progress_thread
, &pa
)) != 0) {
1385 err
= dump_ioctl(zhp
, sdd
->prevsnap
, sdd
->prevsnap_obj
,
1386 fromorigin
, sdd
->outfd
, flags
, sdd
->debugnv
);
1388 if (sdd
->progress
) {
1389 (void) pthread_cancel(tid
);
1390 (void) pthread_join(tid
, NULL
);
1394 (void) strcpy(sdd
->prevsnap
, thissnap
);
1395 sdd
->prevsnap_obj
= zfs_prop_get_int(zhp
, ZFS_PROP_OBJSETID
);
1401 dump_filesystem(zfs_handle_t
*zhp
, void *arg
)
1404 send_dump_data_t
*sdd
= arg
;
1405 boolean_t missingfrom
= B_FALSE
;
1406 zfs_cmd_t zc
= {"\0"};
1408 (void) snprintf(zc
.zc_name
, sizeof (zc
.zc_name
), "%s@%s",
1409 zhp
->zfs_name
, sdd
->tosnap
);
1410 if (ioctl(zhp
->zfs_hdl
->libzfs_fd
, ZFS_IOC_OBJSET_STATS
, &zc
) != 0) {
1411 (void) fprintf(stderr
, dgettext(TEXT_DOMAIN
,
1412 "WARNING: could not send %s@%s: does not exist\n"),
1413 zhp
->zfs_name
, sdd
->tosnap
);
1418 if (sdd
->replicate
&& sdd
->fromsnap
) {
1420 * If this fs does not have fromsnap, and we're doing
1421 * recursive, we need to send a full stream from the
1422 * beginning (or an incremental from the origin if this
1423 * is a clone). If we're doing non-recursive, then let
1424 * them get the error.
1426 (void) snprintf(zc
.zc_name
, sizeof (zc
.zc_name
), "%s@%s",
1427 zhp
->zfs_name
, sdd
->fromsnap
);
1428 if (ioctl(zhp
->zfs_hdl
->libzfs_fd
,
1429 ZFS_IOC_OBJSET_STATS
, &zc
) != 0) {
1430 missingfrom
= B_TRUE
;
1434 sdd
->seenfrom
= sdd
->seento
= sdd
->prevsnap
[0] = 0;
1435 sdd
->prevsnap_obj
= 0;
1436 if (sdd
->fromsnap
== NULL
|| missingfrom
)
1437 sdd
->seenfrom
= B_TRUE
;
1439 rv
= zfs_iter_snapshots_sorted(zhp
, dump_snapshot
, arg
);
1440 if (!sdd
->seenfrom
) {
1441 (void) fprintf(stderr
, dgettext(TEXT_DOMAIN
,
1442 "WARNING: could not send %s@%s:\n"
1443 "incremental source (%s@%s) does not exist\n"),
1444 zhp
->zfs_name
, sdd
->tosnap
,
1445 zhp
->zfs_name
, sdd
->fromsnap
);
1447 } else if (!sdd
->seento
) {
1448 if (sdd
->fromsnap
) {
1449 (void) fprintf(stderr
, dgettext(TEXT_DOMAIN
,
1450 "WARNING: could not send %s@%s:\n"
1451 "incremental source (%s@%s) "
1452 "is not earlier than it\n"),
1453 zhp
->zfs_name
, sdd
->tosnap
,
1454 zhp
->zfs_name
, sdd
->fromsnap
);
1456 (void) fprintf(stderr
, dgettext(TEXT_DOMAIN
,
1458 "could not send %s@%s: does not exist\n"),
1459 zhp
->zfs_name
, sdd
->tosnap
);
1468 dump_filesystems(zfs_handle_t
*rzhp
, void *arg
)
1470 send_dump_data_t
*sdd
= arg
;
1472 boolean_t needagain
, progress
;
1474 if (!sdd
->replicate
)
1475 return (dump_filesystem(rzhp
, sdd
));
1477 /* Mark the clone origin snapshots. */
1478 for (fspair
= nvlist_next_nvpair(sdd
->fss
, NULL
); fspair
;
1479 fspair
= nvlist_next_nvpair(sdd
->fss
, fspair
)) {
1481 uint64_t origin_guid
= 0;
1483 VERIFY(0 == nvpair_value_nvlist(fspair
, &nvfs
));
1484 (void) nvlist_lookup_uint64(nvfs
, "origin", &origin_guid
);
1485 if (origin_guid
!= 0) {
1487 nvlist_t
*origin_nv
= fsavl_find(sdd
->fsavl
,
1488 origin_guid
, &snapname
);
1489 if (origin_nv
!= NULL
) {
1490 nvlist_t
*snapprops
;
1491 VERIFY(0 == nvlist_lookup_nvlist(origin_nv
,
1492 "snapprops", &snapprops
));
1493 VERIFY(0 == nvlist_lookup_nvlist(snapprops
,
1494 snapname
, &snapprops
));
1495 VERIFY(0 == nvlist_add_boolean(
1496 snapprops
, "is_clone_origin"));
1501 needagain
= progress
= B_FALSE
;
1502 for (fspair
= nvlist_next_nvpair(sdd
->fss
, NULL
); fspair
;
1503 fspair
= nvlist_next_nvpair(sdd
->fss
, fspair
)) {
1504 nvlist_t
*fslist
, *parent_nv
;
1508 uint64_t origin_guid
= 0;
1509 uint64_t parent_guid
= 0;
1511 VERIFY(nvpair_value_nvlist(fspair
, &fslist
) == 0);
1512 if (nvlist_lookup_boolean(fslist
, "sent") == 0)
1515 VERIFY(nvlist_lookup_string(fslist
, "name", &fsname
) == 0);
1516 (void) nvlist_lookup_uint64(fslist
, "origin", &origin_guid
);
1517 (void) nvlist_lookup_uint64(fslist
, "parentfromsnap",
1520 if (parent_guid
!= 0) {
1521 parent_nv
= fsavl_find(sdd
->fsavl
, parent_guid
, NULL
);
1522 if (!nvlist_exists(parent_nv
, "sent")) {
1523 /* parent has not been sent; skip this one */
1529 if (origin_guid
!= 0) {
1530 nvlist_t
*origin_nv
= fsavl_find(sdd
->fsavl
,
1532 if (origin_nv
!= NULL
&&
1533 !nvlist_exists(origin_nv
, "sent")) {
1535 * origin has not been sent yet;
1543 zhp
= zfs_open(rzhp
->zfs_hdl
, fsname
, ZFS_TYPE_DATASET
);
1546 err
= dump_filesystem(zhp
, sdd
);
1547 VERIFY(nvlist_add_boolean(fslist
, "sent") == 0);
1558 /* clean out the sent flags in case we reuse this fss */
1559 for (fspair
= nvlist_next_nvpair(sdd
->fss
, NULL
); fspair
;
1560 fspair
= nvlist_next_nvpair(sdd
->fss
, fspair
)) {
1563 VERIFY(nvpair_value_nvlist(fspair
, &fslist
) == 0);
1564 (void) nvlist_remove_all(fslist
, "sent");
1571 zfs_send_resume_token_to_nvlist(libzfs_handle_t
*hdl
, const char *token
)
1573 unsigned int version
;
1575 unsigned long long checksum
, packed_len
;
1578 * Decode token header, which is:
1579 * <token version>-<checksum of payload>-<uncompressed payload length>
1580 * Note that the only supported token version is 1.
1582 nread
= sscanf(token
, "%u-%llx-%llx-",
1583 &version
, &checksum
, &packed_len
);
1585 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1586 "resume token is corrupt (invalid format)"));
1590 if (version
!= ZFS_SEND_RESUME_TOKEN_VERSION
) {
1591 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1592 "resume token is corrupt (invalid version %u)"),
1597 /* convert hexadecimal representation to binary */
1598 token
= strrchr(token
, '-') + 1;
1599 int len
= strlen(token
) / 2;
1600 unsigned char *compressed
= zfs_alloc(hdl
, len
);
1601 for (i
= 0; i
< len
; i
++) {
1602 nread
= sscanf(token
+ i
* 2, "%2hhx", compressed
+ i
);
1605 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1606 "resume token is corrupt "
1607 "(payload is not hex-encoded)"));
1612 /* verify checksum */
1614 fletcher_4_native_varsize(compressed
, len
, &cksum
);
1615 if (cksum
.zc_word
[0] != checksum
) {
1617 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1618 "resume token is corrupt (incorrect checksum)"));
1623 void *packed
= zfs_alloc(hdl
, packed_len
);
1624 uLongf packed_len_long
= packed_len
;
1625 if (uncompress(packed
, &packed_len_long
, compressed
, len
) != Z_OK
||
1626 packed_len_long
!= packed_len
) {
1629 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1630 "resume token is corrupt (decompression failed)"));
1636 int error
= nvlist_unpack(packed
, packed_len
, &nv
, KM_SLEEP
);
1640 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1641 "resume token is corrupt (nvlist_unpack failed)"));
1648 zfs_send_resume(libzfs_handle_t
*hdl
, sendflags_t
*flags
, int outfd
,
1649 const char *resume_token
)
1653 char *fromname
= NULL
;
1654 uint64_t resumeobj
, resumeoff
, toguid
, fromguid
, bytes
;
1657 char name
[ZFS_MAX_DATASET_NAME_LEN
];
1658 enum lzc_send_flags lzc_flags
= 0;
1660 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
1661 "cannot resume send"));
1663 nvlist_t
*resume_nvl
=
1664 zfs_send_resume_token_to_nvlist(hdl
, resume_token
);
1665 if (resume_nvl
== NULL
) {
1667 * zfs_error_aux has already been set by
1668 * zfs_send_resume_token_to_nvlist
1670 return (zfs_error(hdl
, EZFS_FAULT
, errbuf
));
1672 if (flags
->verbose
) {
1673 (void) fprintf(stderr
, dgettext(TEXT_DOMAIN
,
1674 "resume token contents:\n"));
1675 nvlist_print(stderr
, resume_nvl
);
1678 if (nvlist_lookup_string(resume_nvl
, "toname", &toname
) != 0 ||
1679 nvlist_lookup_uint64(resume_nvl
, "object", &resumeobj
) != 0 ||
1680 nvlist_lookup_uint64(resume_nvl
, "offset", &resumeoff
) != 0 ||
1681 nvlist_lookup_uint64(resume_nvl
, "bytes", &bytes
) != 0 ||
1682 nvlist_lookup_uint64(resume_nvl
, "toguid", &toguid
) != 0) {
1683 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1684 "resume token is corrupt"));
1685 return (zfs_error(hdl
, EZFS_FAULT
, errbuf
));
1688 (void) nvlist_lookup_uint64(resume_nvl
, "fromguid", &fromguid
);
1690 if (flags
->largeblock
|| nvlist_exists(resume_nvl
, "largeblockok"))
1691 lzc_flags
|= LZC_SEND_FLAG_LARGE_BLOCK
;
1692 if (flags
->embed_data
|| nvlist_exists(resume_nvl
, "embedok"))
1693 lzc_flags
|= LZC_SEND_FLAG_EMBED_DATA
;
1694 if (flags
->compress
|| nvlist_exists(resume_nvl
, "compressok"))
1695 lzc_flags
|= LZC_SEND_FLAG_COMPRESS
;
1696 if (flags
->raw
|| nvlist_exists(resume_nvl
, "rawok"))
1697 lzc_flags
|= LZC_SEND_FLAG_RAW
;
1699 if (guid_to_name(hdl
, toname
, toguid
, B_FALSE
, name
) != 0) {
1700 if (zfs_dataset_exists(hdl
, toname
, ZFS_TYPE_DATASET
)) {
1701 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1702 "'%s' is no longer the same snapshot used in "
1703 "the initial send"), toname
);
1705 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1706 "'%s' used in the initial send no longer exists"),
1709 return (zfs_error(hdl
, EZFS_BADPATH
, errbuf
));
1711 zhp
= zfs_open(hdl
, name
, ZFS_TYPE_DATASET
);
1713 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1714 "unable to access '%s'"), name
);
1715 return (zfs_error(hdl
, EZFS_BADPATH
, errbuf
));
1718 if (fromguid
!= 0) {
1719 if (guid_to_name(hdl
, toname
, fromguid
, B_TRUE
, name
) != 0) {
1720 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1721 "incremental source %#llx no longer exists"),
1722 (longlong_t
)fromguid
);
1723 return (zfs_error(hdl
, EZFS_BADPATH
, errbuf
));
1728 if (flags
->verbose
) {
1730 error
= lzc_send_space(zhp
->zfs_name
, fromname
,
1733 size
= MAX(0, (int64_t)(size
- bytes
));
1734 send_print_verbose(stderr
, zhp
->zfs_name
, fromname
,
1735 size
, flags
->parsable
);
1738 if (!flags
->dryrun
) {
1739 progress_arg_t pa
= { 0 };
1742 * If progress reporting is requested, spawn a new thread to
1743 * poll ZFS_IOC_SEND_PROGRESS at a regular interval.
1745 if (flags
->progress
) {
1748 pa
.pa_parsable
= flags
->parsable
;
1750 error
= pthread_create(&tid
, NULL
,
1751 send_progress_thread
, &pa
);
1758 error
= lzc_send_resume(zhp
->zfs_name
, fromname
, outfd
,
1759 lzc_flags
, resumeobj
, resumeoff
);
1761 if (flags
->progress
) {
1762 (void) pthread_cancel(tid
);
1763 (void) pthread_join(tid
, NULL
);
1767 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
1768 "warning: cannot send '%s'"), zhp
->zfs_name
);
1776 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1777 "source key must be loaded"));
1778 return (zfs_error(hdl
, EZFS_CRYPTOFAILED
, errbuf
));
1793 zfs_error_aux(hdl
, strerror(errno
));
1794 return (zfs_error(hdl
, EZFS_BADBACKUP
, errbuf
));
1797 return (zfs_standard_error(hdl
, errno
, errbuf
));
1808 * Generate a send stream for the dataset identified by the argument zhp.
1810 * The content of the send stream is the snapshot identified by
1811 * 'tosnap'. Incremental streams are requested in two ways:
1812 * - from the snapshot identified by "fromsnap" (if non-null) or
1813 * - from the origin of the dataset identified by zhp, which must
1814 * be a clone. In this case, "fromsnap" is null and "fromorigin"
1817 * The send stream is recursive (i.e. dumps a hierarchy of snapshots) and
1818 * uses a special header (with a hdrtype field of DMU_COMPOUNDSTREAM)
1819 * if "replicate" is set. If "doall" is set, dump all the intermediate
1820 * snapshots. The DMU_COMPOUNDSTREAM header is used in the "doall"
1821 * case too. If "props" is set, send properties.
1824 zfs_send(zfs_handle_t
*zhp
, const char *fromsnap
, const char *tosnap
,
1825 sendflags_t
*flags
, int outfd
, snapfilter_cb_t filter_func
,
1826 void *cb_arg
, nvlist_t
**debugnvp
)
1829 send_dump_data_t sdd
= { 0 };
1831 nvlist_t
*fss
= NULL
;
1832 avl_tree_t
*fsavl
= NULL
;
1833 static uint64_t holdseq
;
1837 dedup_arg_t dda
= { 0 };
1838 int featureflags
= 0;
1841 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
1842 "cannot send '%s'"), zhp
->zfs_name
);
1844 if (fromsnap
&& fromsnap
[0] == '\0') {
1845 zfs_error_aux(zhp
->zfs_hdl
, dgettext(TEXT_DOMAIN
,
1846 "zero-length incremental source"));
1847 return (zfs_error(zhp
->zfs_hdl
, EZFS_NOENT
, errbuf
));
1850 if (zhp
->zfs_type
== ZFS_TYPE_FILESYSTEM
) {
1852 version
= zfs_prop_get_int(zhp
, ZFS_PROP_VERSION
);
1853 if (version
>= ZPL_VERSION_SA
) {
1854 featureflags
|= DMU_BACKUP_FEATURE_SA_SPILL
;
1859 * Start the dedup thread if this is a dedup stream. We do not bother
1860 * doing this if this a raw send of an encrypted dataset with dedup off
1861 * because normal encrypted blocks won't dedup.
1863 if (flags
->dedup
&& !flags
->dryrun
&& !(flags
->raw
&&
1864 zfs_prop_get_int(zhp
, ZFS_PROP_ENCRYPTION
) != ZIO_CRYPT_OFF
&&
1865 zfs_prop_get_int(zhp
, ZFS_PROP_DEDUP
) == ZIO_CHECKSUM_OFF
)) {
1866 featureflags
|= (DMU_BACKUP_FEATURE_DEDUP
|
1867 DMU_BACKUP_FEATURE_DEDUPPROPS
);
1868 if ((err
= socketpair(AF_UNIX
, SOCK_STREAM
, 0, pipefd
)) != 0) {
1869 zfs_error_aux(zhp
->zfs_hdl
, strerror(errno
));
1870 return (zfs_error(zhp
->zfs_hdl
, EZFS_PIPEFAILED
,
1873 dda
.outputfd
= outfd
;
1874 dda
.inputfd
= pipefd
[1];
1875 dda
.dedup_hdl
= zhp
->zfs_hdl
;
1876 if ((err
= pthread_create(&tid
, NULL
, cksummer
, &dda
)) != 0) {
1877 (void) close(pipefd
[0]);
1878 (void) close(pipefd
[1]);
1879 zfs_error_aux(zhp
->zfs_hdl
, strerror(errno
));
1880 return (zfs_error(zhp
->zfs_hdl
,
1881 EZFS_THREADCREATEFAILED
, errbuf
));
1885 if (flags
->replicate
|| flags
->doall
|| flags
->props
) {
1886 dmu_replay_record_t drr
= { 0 };
1887 char *packbuf
= NULL
;
1891 ZIO_SET_CHECKSUM(&zc
, 0, 0, 0, 0);
1893 if (flags
->replicate
|| flags
->props
) {
1896 VERIFY(0 == nvlist_alloc(&hdrnv
, NV_UNIQUE_NAME
, 0));
1898 VERIFY(0 == nvlist_add_string(hdrnv
,
1899 "fromsnap", fromsnap
));
1901 VERIFY(0 == nvlist_add_string(hdrnv
, "tosnap", tosnap
));
1902 if (!flags
->replicate
) {
1903 VERIFY(0 == nvlist_add_boolean(hdrnv
,
1907 VERIFY(0 == nvlist_add_boolean(hdrnv
, "raw"));
1910 err
= gather_nvlist(zhp
->zfs_hdl
, zhp
->zfs_name
,
1911 fromsnap
, tosnap
, flags
->replicate
, flags
->raw
,
1912 flags
->verbose
, &fss
, &fsavl
);
1915 VERIFY(0 == nvlist_add_nvlist(hdrnv
, "fss", fss
));
1916 err
= nvlist_pack(hdrnv
, &packbuf
, &buflen
,
1926 if (!flags
->dryrun
) {
1927 /* write first begin record */
1928 drr
.drr_type
= DRR_BEGIN
;
1929 drr
.drr_u
.drr_begin
.drr_magic
= DMU_BACKUP_MAGIC
;
1930 DMU_SET_STREAM_HDRTYPE(drr
.drr_u
.drr_begin
.
1931 drr_versioninfo
, DMU_COMPOUNDSTREAM
);
1932 DMU_SET_FEATUREFLAGS(drr
.drr_u
.drr_begin
.
1933 drr_versioninfo
, featureflags
);
1934 if (snprintf(drr
.drr_u
.drr_begin
.drr_toname
,
1935 sizeof (drr
.drr_u
.drr_begin
.drr_toname
),
1936 "%s@%s", zhp
->zfs_name
, tosnap
) >=
1937 sizeof (drr
.drr_u
.drr_begin
.drr_toname
)) {
1941 drr
.drr_payloadlen
= buflen
;
1943 err
= dump_record(&drr
, packbuf
, buflen
, &zc
, outfd
);
1948 /* write end record */
1949 bzero(&drr
, sizeof (drr
));
1950 drr
.drr_type
= DRR_END
;
1951 drr
.drr_u
.drr_end
.drr_checksum
= zc
;
1952 err
= write(outfd
, &drr
, sizeof (drr
));
1962 /* dump each stream */
1963 sdd
.fromsnap
= fromsnap
;
1964 sdd
.tosnap
= tosnap
;
1966 sdd
.outfd
= pipefd
[0];
1969 sdd
.replicate
= flags
->replicate
;
1970 sdd
.doall
= flags
->doall
;
1971 sdd
.fromorigin
= flags
->fromorigin
;
1974 sdd
.verbose
= flags
->verbose
;
1975 sdd
.parsable
= flags
->parsable
;
1976 sdd
.progress
= flags
->progress
;
1977 sdd
.dryrun
= flags
->dryrun
;
1978 sdd
.large_block
= flags
->largeblock
;
1979 sdd
.embed_data
= flags
->embed_data
;
1980 sdd
.compress
= flags
->compress
;
1981 sdd
.raw
= flags
->raw
;
1982 sdd
.filter_cb
= filter_func
;
1983 sdd
.filter_cb_arg
= cb_arg
;
1985 sdd
.debugnv
= *debugnvp
;
1986 if (sdd
.verbose
&& sdd
.dryrun
)
1987 sdd
.std_out
= B_TRUE
;
1988 fout
= sdd
.std_out
? stdout
: stderr
;
1991 * Some flags require that we place user holds on the datasets that are
1992 * being sent so they don't get destroyed during the send. We can skip
1993 * this step if the pool is imported read-only since the datasets cannot
1996 if (!flags
->dryrun
&& !zpool_get_prop_int(zfs_get_pool_handle(zhp
),
1997 ZPOOL_PROP_READONLY
, NULL
) &&
1998 zfs_spa_version(zhp
, &spa_version
) == 0 &&
1999 spa_version
>= SPA_VERSION_USERREFS
&&
2000 (flags
->doall
|| flags
->replicate
)) {
2002 (void) snprintf(sdd
.holdtag
, sizeof (sdd
.holdtag
),
2003 ".send-%d-%llu", getpid(), (u_longlong_t
)holdseq
);
2004 sdd
.cleanup_fd
= open(ZFS_DEV
, O_RDWR
);
2005 if (sdd
.cleanup_fd
< 0) {
2009 sdd
.snapholds
= fnvlist_alloc();
2011 sdd
.cleanup_fd
= -1;
2012 sdd
.snapholds
= NULL
;
2014 if (flags
->verbose
|| sdd
.snapholds
!= NULL
) {
2016 * Do a verbose no-op dry run to get all the verbose output
2017 * or to gather snapshot hold's before generating any data,
2018 * then do a non-verbose real run to generate the streams.
2020 sdd
.dryrun
= B_TRUE
;
2021 err
= dump_filesystems(zhp
, &sdd
);
2026 if (flags
->verbose
) {
2027 if (flags
->parsable
) {
2028 (void) fprintf(fout
, "size\t%llu\n",
2029 (longlong_t
)sdd
.size
);
2032 zfs_nicebytes(sdd
.size
, buf
, sizeof (buf
));
2033 (void) fprintf(fout
, dgettext(TEXT_DOMAIN
,
2034 "total estimated size is %s\n"), buf
);
2038 /* Ensure no snaps found is treated as an error. */
2044 /* Skip the second run if dryrun was requested. */
2048 if (sdd
.snapholds
!= NULL
) {
2049 err
= zfs_hold_nvl(zhp
, sdd
.cleanup_fd
, sdd
.snapholds
);
2053 fnvlist_free(sdd
.snapholds
);
2054 sdd
.snapholds
= NULL
;
2057 sdd
.dryrun
= B_FALSE
;
2058 sdd
.verbose
= B_FALSE
;
2061 err
= dump_filesystems(zhp
, &sdd
);
2062 fsavl_destroy(fsavl
);
2065 /* Ensure no snaps found is treated as an error. */
2066 if (err
== 0 && !sdd
.seento
)
2071 (void) pthread_cancel(tid
);
2072 (void) close(pipefd
[0]);
2073 (void) pthread_join(tid
, NULL
);
2076 if (sdd
.cleanup_fd
!= -1) {
2077 VERIFY(0 == close(sdd
.cleanup_fd
));
2078 sdd
.cleanup_fd
= -1;
2081 if (!flags
->dryrun
&& (flags
->replicate
|| flags
->doall
||
2084 * write final end record. NB: want to do this even if
2085 * there was some error, because it might not be totally
2088 dmu_replay_record_t drr
= { 0 };
2089 drr
.drr_type
= DRR_END
;
2090 if (write(outfd
, &drr
, sizeof (drr
)) == -1) {
2091 return (zfs_standard_error(zhp
->zfs_hdl
,
2096 return (err
|| sdd
.err
);
2099 err
= zfs_standard_error(zhp
->zfs_hdl
, err
, errbuf
);
2101 fsavl_destroy(fsavl
);
2103 fnvlist_free(sdd
.snapholds
);
2105 if (sdd
.cleanup_fd
!= -1)
2106 VERIFY(0 == close(sdd
.cleanup_fd
));
2108 (void) pthread_cancel(tid
);
2109 (void) close(pipefd
[0]);
2110 (void) pthread_join(tid
, NULL
);
2116 zfs_send_one(zfs_handle_t
*zhp
, const char *from
, int fd
,
2117 enum lzc_send_flags flags
)
2120 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
2123 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
2124 "warning: cannot send '%s'"), zhp
->zfs_name
);
2126 err
= lzc_send(zhp
->zfs_name
, from
, fd
, flags
);
2130 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
2131 "not an earlier snapshot from the same fs"));
2132 return (zfs_error(hdl
, EZFS_CROSSTARGET
, errbuf
));
2136 if (lzc_exists(zhp
->zfs_name
)) {
2137 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
2138 "incremental source (%s) does not exist"),
2141 return (zfs_error(hdl
, EZFS_NOENT
, errbuf
));
2144 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
2145 "dataset key must be loaded"));
2146 return (zfs_error(hdl
, EZFS_CRYPTOFAILED
, errbuf
));
2149 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
2150 "target is busy; if a filesystem, "
2151 "it must not be mounted"));
2152 return (zfs_error(hdl
, EZFS_BUSY
, errbuf
));
2165 zfs_error_aux(hdl
, strerror(errno
));
2166 return (zfs_error(hdl
, EZFS_BADBACKUP
, errbuf
));
2169 return (zfs_standard_error(hdl
, errno
, errbuf
));
2176 * Routines specific to "zfs recv"
2180 recv_read(libzfs_handle_t
*hdl
, int fd
, void *buf
, int ilen
,
2181 boolean_t byteswap
, zio_cksum_t
*zc
)
2187 assert(ilen
<= SPA_MAXBLOCKSIZE
);
2190 rv
= read(fd
, cp
, len
);
2195 if (rv
< 0 || len
!= 0) {
2196 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
2197 "failed to read from stream"));
2198 return (zfs_error(hdl
, EZFS_BADSTREAM
, dgettext(TEXT_DOMAIN
,
2199 "cannot receive")));
2204 fletcher_4_incremental_byteswap(buf
, ilen
, zc
);
2206 fletcher_4_incremental_native(buf
, ilen
, zc
);
2212 recv_read_nvlist(libzfs_handle_t
*hdl
, int fd
, int len
, nvlist_t
**nvp
,
2213 boolean_t byteswap
, zio_cksum_t
*zc
)
2218 buf
= zfs_alloc(hdl
, len
);
2222 err
= recv_read(hdl
, fd
, buf
, len
, byteswap
, zc
);
2228 err
= nvlist_unpack(buf
, len
, nvp
, 0);
2231 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
, "invalid "
2232 "stream (malformed nvlist)"));
2239 * Returns the grand origin (origin of origin of origin...) of a given handle.
2240 * If this dataset is not a clone, it simply returns a copy of the original
2243 static zfs_handle_t
*
2244 recv_open_grand_origin(zfs_handle_t
*zhp
)
2246 char origin
[ZFS_MAX_DATASET_NAME_LEN
];
2248 zfs_handle_t
*ozhp
= zfs_handle_dup(zhp
);
2250 while (ozhp
!= NULL
) {
2251 if (zfs_prop_get(ozhp
, ZFS_PROP_ORIGIN
, origin
,
2252 sizeof (origin
), &src
, NULL
, 0, B_FALSE
) != 0)
2255 (void) zfs_close(ozhp
);
2256 ozhp
= zfs_open(zhp
->zfs_hdl
, origin
, ZFS_TYPE_FILESYSTEM
);
2263 recv_rename_impl(zfs_handle_t
*zhp
, zfs_cmd_t
*zc
)
2266 zfs_handle_t
*ozhp
= NULL
;
2269 * Attempt to rename the dataset. If it fails with EACCES we have
2270 * attempted to rename the dataset outside of its encryption root.
2271 * Force the dataset to become an encryption root and try again.
2273 err
= ioctl(zhp
->zfs_hdl
->libzfs_fd
, ZFS_IOC_RENAME
, &zc
);
2274 if (err
== EACCES
) {
2275 ozhp
= recv_open_grand_origin(zhp
);
2281 err
= lzc_change_key(ozhp
->zfs_name
, DCP_CMD_FORCE_NEW_KEY
,
2286 err
= ioctl(zhp
->zfs_hdl
->libzfs_fd
, ZFS_IOC_RENAME
, &zc
);
2296 recv_rename(libzfs_handle_t
*hdl
, const char *name
, const char *tryname
,
2297 int baselen
, char *newname
, recvflags_t
*flags
)
2300 zfs_cmd_t zc
= {"\0"};
2302 prop_changelist_t
*clp
= NULL
;
2303 zfs_handle_t
*zhp
= NULL
;
2305 zhp
= zfs_open(hdl
, name
, ZFS_TYPE_DATASET
);
2310 clp
= changelist_gather(zhp
, ZFS_PROP_NAME
, 0,
2311 flags
->force
? MS_FORCE
: 0);
2316 err
= changelist_prefix(clp
);
2320 zc
.zc_objset_type
= DMU_OST_ZFS
;
2321 (void) strlcpy(zc
.zc_name
, name
, sizeof (zc
.zc_name
));
2324 (void) strcpy(newname
, tryname
);
2326 (void) strlcpy(zc
.zc_value
, tryname
, sizeof (zc
.zc_value
));
2328 if (flags
->verbose
) {
2329 (void) printf("attempting rename %s to %s\n",
2330 zc
.zc_name
, zc
.zc_value
);
2332 err
= recv_rename_impl(zhp
, &zc
);
2334 changelist_rename(clp
, name
, tryname
);
2339 if (err
!= 0 && strncmp(name
+ baselen
, "recv-", 5) != 0) {
2342 (void) snprintf(newname
, ZFS_MAX_DATASET_NAME_LEN
,
2343 "%.*srecv-%u-%u", baselen
, name
, getpid(), seq
);
2344 (void) strlcpy(zc
.zc_value
, newname
, sizeof (zc
.zc_value
));
2346 if (flags
->verbose
) {
2347 (void) printf("failed - trying rename %s to %s\n",
2348 zc
.zc_name
, zc
.zc_value
);
2350 err
= recv_rename_impl(zhp
, &zc
);
2352 changelist_rename(clp
, name
, newname
);
2353 if (err
&& flags
->verbose
) {
2354 (void) printf("failed (%u) - "
2355 "will try again on next pass\n", errno
);
2358 } else if (flags
->verbose
) {
2360 (void) printf("success\n");
2362 (void) printf("failed (%u)\n", errno
);
2365 (void) changelist_postfix(clp
);
2369 changelist_free(clp
);
2377 recv_promote(libzfs_handle_t
*hdl
, const char *fsname
,
2378 const char *origin_fsname
, recvflags_t
*flags
)
2381 zfs_cmd_t zc
= {"\0"};
2382 zfs_handle_t
*zhp
= NULL
, *ozhp
= NULL
;
2385 (void) printf("promoting %s\n", fsname
);
2387 (void) strlcpy(zc
.zc_value
, origin_fsname
, sizeof (zc
.zc_value
));
2388 (void) strlcpy(zc
.zc_name
, fsname
, sizeof (zc
.zc_name
));
2391 * Attempt to promote the dataset. If it fails with EACCES the
2392 * promotion would cause this dataset to leave its encryption root.
2393 * Force the origin to become an encryption root and try again.
2395 err
= zfs_ioctl(hdl
, ZFS_IOC_PROMOTE
, &zc
);
2396 if (err
== EACCES
) {
2397 zhp
= zfs_open(hdl
, fsname
, ZFS_TYPE_DATASET
);
2403 ozhp
= recv_open_grand_origin(zhp
);
2409 err
= lzc_change_key(ozhp
->zfs_name
, DCP_CMD_FORCE_NEW_KEY
,
2414 err
= zfs_ioctl(hdl
, ZFS_IOC_PROMOTE
, &zc
);
2427 recv_destroy(libzfs_handle_t
*hdl
, const char *name
, int baselen
,
2428 char *newname
, recvflags_t
*flags
)
2430 zfs_cmd_t zc
= {"\0"};
2432 prop_changelist_t
*clp
;
2434 boolean_t defer
= B_FALSE
;
2437 zhp
= zfs_open(hdl
, name
, ZFS_TYPE_DATASET
);
2440 clp
= changelist_gather(zhp
, ZFS_PROP_NAME
, 0,
2441 flags
->force
? MS_FORCE
: 0);
2442 if (zfs_get_type(zhp
) == ZFS_TYPE_SNAPSHOT
&&
2443 zfs_spa_version(zhp
, &spa_version
) == 0 &&
2444 spa_version
>= SPA_VERSION_USERREFS
)
2449 err
= changelist_prefix(clp
);
2453 zc
.zc_objset_type
= DMU_OST_ZFS
;
2454 zc
.zc_defer_destroy
= defer
;
2455 (void) strlcpy(zc
.zc_name
, name
, sizeof (zc
.zc_name
));
2458 (void) printf("attempting destroy %s\n", zc
.zc_name
);
2459 err
= ioctl(hdl
->libzfs_fd
, ZFS_IOC_DESTROY
, &zc
);
2462 (void) printf("success\n");
2463 changelist_remove(clp
, zc
.zc_name
);
2466 (void) changelist_postfix(clp
);
2467 changelist_free(clp
);
2470 * Deferred destroy might destroy the snapshot or only mark it to be
2471 * destroyed later, and it returns success in either case.
2473 if (err
!= 0 || (defer
&& zfs_dataset_exists(hdl
, name
,
2474 ZFS_TYPE_SNAPSHOT
))) {
2475 err
= recv_rename(hdl
, name
, NULL
, baselen
, newname
, flags
);
2481 typedef struct guid_to_name_data
{
2483 boolean_t bookmark_ok
;
2486 } guid_to_name_data_t
;
2489 guid_to_name_cb(zfs_handle_t
*zhp
, void *arg
)
2491 guid_to_name_data_t
*gtnd
= arg
;
2495 if (gtnd
->skip
!= NULL
&&
2496 (slash
= strrchr(zhp
->zfs_name
, '/')) != NULL
&&
2497 strcmp(slash
+ 1, gtnd
->skip
) == 0) {
2502 if (zfs_prop_get_int(zhp
, ZFS_PROP_GUID
) == gtnd
->guid
) {
2503 (void) strcpy(gtnd
->name
, zhp
->zfs_name
);
2508 err
= zfs_iter_children(zhp
, guid_to_name_cb
, gtnd
);
2509 if (err
!= EEXIST
&& gtnd
->bookmark_ok
)
2510 err
= zfs_iter_bookmarks(zhp
, guid_to_name_cb
, gtnd
);
2516 * Attempt to find the local dataset associated with this guid. In the case of
2517 * multiple matches, we attempt to find the "best" match by searching
2518 * progressively larger portions of the hierarchy. This allows one to send a
2519 * tree of datasets individually and guarantee that we will find the source
2520 * guid within that hierarchy, even if there are multiple matches elsewhere.
2523 guid_to_name(libzfs_handle_t
*hdl
, const char *parent
, uint64_t guid
,
2524 boolean_t bookmark_ok
, char *name
)
2526 char pname
[ZFS_MAX_DATASET_NAME_LEN
];
2527 guid_to_name_data_t gtnd
;
2530 gtnd
.bookmark_ok
= bookmark_ok
;
2535 * Search progressively larger portions of the hierarchy, starting
2536 * with the filesystem specified by 'parent'. This will
2537 * select the "most local" version of the origin snapshot in the case
2538 * that there are multiple matching snapshots in the system.
2540 (void) strlcpy(pname
, parent
, sizeof (pname
));
2541 char *cp
= strrchr(pname
, '@');
2543 cp
= strchr(pname
, '\0');
2544 for (; cp
!= NULL
; cp
= strrchr(pname
, '/')) {
2545 /* Chop off the last component and open the parent */
2547 zfs_handle_t
*zhp
= make_dataset_handle(hdl
, pname
);
2551 int err
= guid_to_name_cb(zfs_handle_dup(zhp
), >nd
);
2553 err
= zfs_iter_children(zhp
, guid_to_name_cb
, >nd
);
2554 if (err
!= EEXIST
&& bookmark_ok
)
2555 err
= zfs_iter_bookmarks(zhp
, guid_to_name_cb
, >nd
);
2561 * Remember the last portion of the dataset so we skip it next
2562 * time through (as we've already searched that portion of the
2565 gtnd
.skip
= strrchr(pname
, '/') + 1;
2572 * Return +1 if guid1 is before guid2, 0 if they are the same, and -1 if
2573 * guid1 is after guid2.
2576 created_before(libzfs_handle_t
*hdl
, avl_tree_t
*avl
,
2577 uint64_t guid1
, uint64_t guid2
)
2580 char *fsname
= NULL
, *snapname
= NULL
;
2581 char buf
[ZFS_MAX_DATASET_NAME_LEN
];
2583 zfs_handle_t
*guid1hdl
, *guid2hdl
;
2584 uint64_t create1
, create2
;
2591 nvfs
= fsavl_find(avl
, guid1
, &snapname
);
2592 VERIFY(0 == nvlist_lookup_string(nvfs
, "name", &fsname
));
2593 (void) snprintf(buf
, sizeof (buf
), "%s@%s", fsname
, snapname
);
2594 guid1hdl
= zfs_open(hdl
, buf
, ZFS_TYPE_SNAPSHOT
);
2595 if (guid1hdl
== NULL
)
2598 nvfs
= fsavl_find(avl
, guid2
, &snapname
);
2599 VERIFY(0 == nvlist_lookup_string(nvfs
, "name", &fsname
));
2600 (void) snprintf(buf
, sizeof (buf
), "%s@%s", fsname
, snapname
);
2601 guid2hdl
= zfs_open(hdl
, buf
, ZFS_TYPE_SNAPSHOT
);
2602 if (guid2hdl
== NULL
) {
2603 zfs_close(guid1hdl
);
2607 create1
= zfs_prop_get_int(guid1hdl
, ZFS_PROP_CREATETXG
);
2608 create2
= zfs_prop_get_int(guid2hdl
, ZFS_PROP_CREATETXG
);
2610 if (create1
< create2
)
2612 else if (create1
> create2
)
2617 zfs_close(guid1hdl
);
2618 zfs_close(guid2hdl
);
2624 * This function reestablishes the heirarchy of encryption roots after a
2625 * recursive incremental receive has completed. This must be done after the
2626 * second call to recv_incremental_replication() has renamed and promoted all
2627 * sent datasets to their final locations in the dataset heriarchy.
2630 recv_fix_encryption_heirarchy(libzfs_handle_t
*hdl
, const char *destname
,
2631 nvlist_t
*stream_nv
, avl_tree_t
*stream_avl
)
2634 nvpair_t
*fselem
= NULL
;
2635 nvlist_t
*stream_fss
;
2637 VERIFY(0 == nvlist_lookup_nvlist(stream_nv
, "fss", &stream_fss
));
2639 while ((fselem
= nvlist_next_nvpair(stream_fss
, fselem
)) != NULL
) {
2640 zfs_handle_t
*zhp
= NULL
;
2642 nvlist_t
*snaps
, *props
, *stream_nvfs
= NULL
;
2643 nvpair_t
*snapel
= NULL
;
2644 boolean_t is_encroot
, is_clone
, stream_encroot
;
2646 char *stream_keylocation
= NULL
;
2647 char keylocation
[MAXNAMELEN
];
2648 char fsname
[ZFS_MAX_DATASET_NAME_LEN
];
2650 keylocation
[0] = '\0';
2651 VERIFY(0 == nvpair_value_nvlist(fselem
, &stream_nvfs
));
2652 VERIFY(0 == nvlist_lookup_nvlist(stream_nvfs
, "snaps", &snaps
));
2653 VERIFY(0 == nvlist_lookup_nvlist(stream_nvfs
, "props", &props
));
2654 stream_encroot
= nvlist_exists(stream_nvfs
, "is_encroot");
2656 /* find a snapshot from the stream that exists locally */
2658 while ((snapel
= nvlist_next_nvpair(snaps
, snapel
)) != NULL
) {
2661 VERIFY(0 == nvpair_value_uint64(snapel
, &guid
));
2662 err
= guid_to_name(hdl
, destname
, guid
, B_FALSE
,
2671 cp
= strchr(fsname
, '@');
2675 zhp
= zfs_open(hdl
, fsname
, ZFS_TYPE_DATASET
);
2681 crypt
= zfs_prop_get_int(zhp
, ZFS_PROP_ENCRYPTION
);
2682 is_clone
= zhp
->zfs_dmustats
.dds_origin
[0] != '\0';
2683 (void) zfs_crypto_get_encryption_root(zhp
, &is_encroot
, NULL
);
2685 /* we don't need to do anything for unencrypted filesystems */
2686 if (crypt
== ZIO_CRYPT_OFF
) {
2692 * If the dataset is flagged as an encryption root, was not
2693 * received as a clone and is not currently an encryption root,
2694 * force it to become one. Fixup the keylocation if necessary.
2696 if (stream_encroot
) {
2697 if (!is_clone
&& !is_encroot
) {
2698 err
= lzc_change_key(fsname
,
2699 DCP_CMD_FORCE_NEW_KEY
, NULL
, NULL
, 0);
2706 VERIFY(0 == nvlist_lookup_string(props
,
2707 zfs_prop_to_name(ZFS_PROP_KEYLOCATION
),
2708 &stream_keylocation
));
2711 * Refresh the properties in case the call to
2712 * lzc_change_key() changed the value.
2714 zfs_refresh_properties(zhp
);
2715 err
= zfs_prop_get(zhp
, ZFS_PROP_KEYLOCATION
,
2716 keylocation
, sizeof (keylocation
), NULL
, NULL
,
2723 if (strcmp(keylocation
, stream_keylocation
) != 0) {
2724 err
= zfs_prop_set(zhp
,
2725 zfs_prop_to_name(ZFS_PROP_KEYLOCATION
),
2726 stream_keylocation
);
2735 * If the dataset is not flagged as an encryption root and is
2736 * currently an encryption root, force it to inherit from its
2739 if (!stream_encroot
&& is_encroot
) {
2740 err
= lzc_change_key(fsname
, DCP_CMD_FORCE_INHERIT
,
2758 recv_incremental_replication(libzfs_handle_t
*hdl
, const char *tofs
,
2759 recvflags_t
*flags
, nvlist_t
*stream_nv
, avl_tree_t
*stream_avl
,
2762 nvlist_t
*local_nv
, *deleted
= NULL
;
2763 avl_tree_t
*local_avl
;
2764 nvpair_t
*fselem
, *nextfselem
;
2766 char newname
[ZFS_MAX_DATASET_NAME_LEN
];
2769 boolean_t needagain
, progress
, recursive
;
2772 VERIFY(0 == nvlist_lookup_string(stream_nv
, "fromsnap", &fromsnap
));
2774 recursive
= (nvlist_lookup_boolean(stream_nv
, "not_recursive") ==
2781 needagain
= progress
= B_FALSE
;
2783 VERIFY(0 == nvlist_alloc(&deleted
, NV_UNIQUE_NAME
, 0));
2785 if ((error
= gather_nvlist(hdl
, tofs
, fromsnap
, NULL
,
2786 recursive
, B_TRUE
, B_FALSE
, &local_nv
, &local_avl
)) != 0)
2790 * Process deletes and renames
2792 for (fselem
= nvlist_next_nvpair(local_nv
, NULL
);
2793 fselem
; fselem
= nextfselem
) {
2794 nvlist_t
*nvfs
, *snaps
;
2795 nvlist_t
*stream_nvfs
= NULL
;
2796 nvpair_t
*snapelem
, *nextsnapelem
;
2797 uint64_t fromguid
= 0;
2798 uint64_t originguid
= 0;
2799 uint64_t stream_originguid
= 0;
2800 uint64_t parent_fromsnap_guid
, stream_parent_fromsnap_guid
;
2801 char *fsname
, *stream_fsname
;
2803 nextfselem
= nvlist_next_nvpair(local_nv
, fselem
);
2805 VERIFY(0 == nvpair_value_nvlist(fselem
, &nvfs
));
2806 VERIFY(0 == nvlist_lookup_nvlist(nvfs
, "snaps", &snaps
));
2807 VERIFY(0 == nvlist_lookup_string(nvfs
, "name", &fsname
));
2808 VERIFY(0 == nvlist_lookup_uint64(nvfs
, "parentfromsnap",
2809 &parent_fromsnap_guid
));
2810 (void) nvlist_lookup_uint64(nvfs
, "origin", &originguid
);
2813 * First find the stream's fs, so we can check for
2814 * a different origin (due to "zfs promote")
2816 for (snapelem
= nvlist_next_nvpair(snaps
, NULL
);
2817 snapelem
; snapelem
= nvlist_next_nvpair(snaps
, snapelem
)) {
2820 VERIFY(0 == nvpair_value_uint64(snapelem
, &thisguid
));
2821 stream_nvfs
= fsavl_find(stream_avl
, thisguid
, NULL
);
2823 if (stream_nvfs
!= NULL
)
2827 /* check for promote */
2828 (void) nvlist_lookup_uint64(stream_nvfs
, "origin",
2829 &stream_originguid
);
2830 if (stream_nvfs
&& originguid
!= stream_originguid
) {
2831 switch (created_before(hdl
, local_avl
,
2832 stream_originguid
, originguid
)) {
2835 nvlist_t
*origin_nvfs
;
2836 char *origin_fsname
;
2838 origin_nvfs
= fsavl_find(local_avl
, originguid
,
2840 VERIFY(0 == nvlist_lookup_string(origin_nvfs
,
2841 "name", &origin_fsname
));
2842 error
= recv_promote(hdl
, fsname
, origin_fsname
,
2851 fsavl_destroy(local_avl
);
2852 nvlist_free(local_nv
);
2856 * We had/have the wrong origin, therefore our
2857 * list of snapshots is wrong. Need to handle
2858 * them on the next pass.
2864 for (snapelem
= nvlist_next_nvpair(snaps
, NULL
);
2865 snapelem
; snapelem
= nextsnapelem
) {
2867 char *stream_snapname
;
2868 nvlist_t
*found
, *props
;
2870 nextsnapelem
= nvlist_next_nvpair(snaps
, snapelem
);
2872 VERIFY(0 == nvpair_value_uint64(snapelem
, &thisguid
));
2873 found
= fsavl_find(stream_avl
, thisguid
,
2876 /* check for delete */
2877 if (found
== NULL
) {
2878 char name
[ZFS_MAX_DATASET_NAME_LEN
];
2883 (void) snprintf(name
, sizeof (name
), "%s@%s",
2884 fsname
, nvpair_name(snapelem
));
2886 error
= recv_destroy(hdl
, name
,
2887 strlen(fsname
)+1, newname
, flags
);
2892 sprintf(guidname
, "%llu",
2893 (u_longlong_t
)thisguid
);
2894 nvlist_add_boolean(deleted
, guidname
);
2898 stream_nvfs
= found
;
2900 if (0 == nvlist_lookup_nvlist(stream_nvfs
, "snapprops",
2901 &props
) && 0 == nvlist_lookup_nvlist(props
,
2902 stream_snapname
, &props
)) {
2903 zfs_cmd_t zc
= {"\0"};
2905 zc
.zc_cookie
= B_TRUE
; /* received */
2906 (void) snprintf(zc
.zc_name
, sizeof (zc
.zc_name
),
2907 "%s@%s", fsname
, nvpair_name(snapelem
));
2908 if (zcmd_write_src_nvlist(hdl
, &zc
,
2910 (void) zfs_ioctl(hdl
,
2911 ZFS_IOC_SET_PROP
, &zc
);
2912 zcmd_free_nvlists(&zc
);
2916 /* check for different snapname */
2917 if (strcmp(nvpair_name(snapelem
),
2918 stream_snapname
) != 0) {
2919 char name
[ZFS_MAX_DATASET_NAME_LEN
];
2920 char tryname
[ZFS_MAX_DATASET_NAME_LEN
];
2922 (void) snprintf(name
, sizeof (name
), "%s@%s",
2923 fsname
, nvpair_name(snapelem
));
2924 (void) snprintf(tryname
, sizeof (name
), "%s@%s",
2925 fsname
, stream_snapname
);
2927 error
= recv_rename(hdl
, name
, tryname
,
2928 strlen(fsname
)+1, newname
, flags
);
2935 if (strcmp(stream_snapname
, fromsnap
) == 0)
2936 fromguid
= thisguid
;
2939 /* check for delete */
2940 if (stream_nvfs
== NULL
) {
2944 error
= recv_destroy(hdl
, fsname
, strlen(tofs
)+1,
2950 sprintf(guidname
, "%llu",
2951 (u_longlong_t
)parent_fromsnap_guid
);
2952 nvlist_add_boolean(deleted
, guidname
);
2956 if (fromguid
== 0) {
2957 if (flags
->verbose
) {
2958 (void) printf("local fs %s does not have "
2959 "fromsnap (%s in stream); must have "
2960 "been deleted locally; ignoring\n",
2966 VERIFY(0 == nvlist_lookup_string(stream_nvfs
,
2967 "name", &stream_fsname
));
2968 VERIFY(0 == nvlist_lookup_uint64(stream_nvfs
,
2969 "parentfromsnap", &stream_parent_fromsnap_guid
));
2971 s1
= strrchr(fsname
, '/');
2972 s2
= strrchr(stream_fsname
, '/');
2975 * Check if we're going to rename based on parent guid change
2976 * and the current parent guid was also deleted. If it was then
2977 * rename will fail and is likely unneeded, so avoid this and
2978 * force an early retry to determine the new
2979 * parent_fromsnap_guid.
2981 if (stream_parent_fromsnap_guid
!= 0 &&
2982 parent_fromsnap_guid
!= 0 &&
2983 stream_parent_fromsnap_guid
!= parent_fromsnap_guid
) {
2984 sprintf(guidname
, "%llu",
2985 (u_longlong_t
)parent_fromsnap_guid
);
2986 if (nvlist_exists(deleted
, guidname
)) {
2994 * Check for rename. If the exact receive path is specified, it
2995 * does not count as a rename, but we still need to check the
2996 * datasets beneath it.
2998 if ((stream_parent_fromsnap_guid
!= 0 &&
2999 parent_fromsnap_guid
!= 0 &&
3000 stream_parent_fromsnap_guid
!= parent_fromsnap_guid
) ||
3001 ((flags
->isprefix
|| strcmp(tofs
, fsname
) != 0) &&
3002 (s1
!= NULL
) && (s2
!= NULL
) && strcmp(s1
, s2
) != 0)) {
3004 char tryname
[ZFS_MAX_DATASET_NAME_LEN
];
3006 parent
= fsavl_find(local_avl
,
3007 stream_parent_fromsnap_guid
, NULL
);
3009 * NB: parent might not be found if we used the
3010 * tosnap for stream_parent_fromsnap_guid,
3011 * because the parent is a newly-created fs;
3012 * we'll be able to rename it after we recv the
3015 if (parent
!= NULL
) {
3018 VERIFY(0 == nvlist_lookup_string(parent
, "name",
3020 (void) snprintf(tryname
, sizeof (tryname
),
3021 "%s%s", pname
, strrchr(stream_fsname
, '/'));
3024 if (flags
->verbose
) {
3025 (void) printf("local fs %s new parent "
3026 "not found\n", fsname
);
3032 error
= recv_rename(hdl
, fsname
, tryname
,
3033 strlen(tofs
)+1, newname
, flags
);
3035 if (renamed
!= NULL
&& newname
[0] != '\0') {
3036 VERIFY(0 == nvlist_add_boolean(renamed
,
3048 fsavl_destroy(local_avl
);
3049 nvlist_free(local_nv
);
3050 nvlist_free(deleted
);
3052 if (needagain
&& progress
) {
3053 /* do another pass to fix up temporary names */
3055 (void) printf("another pass:\n");
3059 return (needagain
|| error
!= 0);
3063 zfs_receive_package(libzfs_handle_t
*hdl
, int fd
, const char *destname
,
3064 recvflags_t
*flags
, dmu_replay_record_t
*drr
, zio_cksum_t
*zc
,
3065 char **top_zfs
, int cleanup_fd
, uint64_t *action_handlep
,
3068 nvlist_t
*stream_nv
= NULL
;
3069 avl_tree_t
*stream_avl
= NULL
;
3070 char *fromsnap
= NULL
;
3071 char *sendsnap
= NULL
;
3073 char tofs
[ZFS_MAX_DATASET_NAME_LEN
];
3074 char sendfs
[ZFS_MAX_DATASET_NAME_LEN
];
3076 dmu_replay_record_t drre
;
3078 boolean_t anyerr
= B_FALSE
;
3079 boolean_t softerr
= B_FALSE
;
3080 boolean_t recursive
, raw
;
3082 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
3085 assert(drr
->drr_type
== DRR_BEGIN
);
3086 assert(drr
->drr_u
.drr_begin
.drr_magic
== DMU_BACKUP_MAGIC
);
3087 assert(DMU_GET_STREAM_HDRTYPE(drr
->drr_u
.drr_begin
.drr_versioninfo
) ==
3088 DMU_COMPOUNDSTREAM
);
3091 * Read in the nvlist from the stream.
3093 if (drr
->drr_payloadlen
!= 0) {
3094 error
= recv_read_nvlist(hdl
, fd
, drr
->drr_payloadlen
,
3095 &stream_nv
, flags
->byteswap
, zc
);
3097 error
= zfs_error(hdl
, EZFS_BADSTREAM
, errbuf
);
3102 recursive
= (nvlist_lookup_boolean(stream_nv
, "not_recursive") ==
3104 raw
= (nvlist_lookup_boolean(stream_nv
, "raw") == 0);
3106 if (recursive
&& strchr(destname
, '@')) {
3107 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3108 "cannot specify snapshot name for multi-snapshot stream"));
3109 error
= zfs_error(hdl
, EZFS_BADSTREAM
, errbuf
);
3114 * Read in the end record and verify checksum.
3116 if (0 != (error
= recv_read(hdl
, fd
, &drre
, sizeof (drre
),
3117 flags
->byteswap
, NULL
)))
3119 if (flags
->byteswap
) {
3120 drre
.drr_type
= BSWAP_32(drre
.drr_type
);
3121 drre
.drr_u
.drr_end
.drr_checksum
.zc_word
[0] =
3122 BSWAP_64(drre
.drr_u
.drr_end
.drr_checksum
.zc_word
[0]);
3123 drre
.drr_u
.drr_end
.drr_checksum
.zc_word
[1] =
3124 BSWAP_64(drre
.drr_u
.drr_end
.drr_checksum
.zc_word
[1]);
3125 drre
.drr_u
.drr_end
.drr_checksum
.zc_word
[2] =
3126 BSWAP_64(drre
.drr_u
.drr_end
.drr_checksum
.zc_word
[2]);
3127 drre
.drr_u
.drr_end
.drr_checksum
.zc_word
[3] =
3128 BSWAP_64(drre
.drr_u
.drr_end
.drr_checksum
.zc_word
[3]);
3130 if (drre
.drr_type
!= DRR_END
) {
3131 error
= zfs_error(hdl
, EZFS_BADSTREAM
, errbuf
);
3134 if (!ZIO_CHECKSUM_EQUAL(drre
.drr_u
.drr_end
.drr_checksum
, *zc
)) {
3135 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3136 "incorrect header checksum"));
3137 error
= zfs_error(hdl
, EZFS_BADSTREAM
, errbuf
);
3141 (void) nvlist_lookup_string(stream_nv
, "fromsnap", &fromsnap
);
3143 if (drr
->drr_payloadlen
!= 0) {
3144 nvlist_t
*stream_fss
;
3146 VERIFY(0 == nvlist_lookup_nvlist(stream_nv
, "fss",
3148 if ((stream_avl
= fsavl_create(stream_fss
)) == NULL
) {
3149 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3150 "couldn't allocate avl tree"));
3151 error
= zfs_error(hdl
, EZFS_NOMEM
, errbuf
);
3155 if (fromsnap
!= NULL
&& recursive
) {
3156 nvlist_t
*renamed
= NULL
;
3157 nvpair_t
*pair
= NULL
;
3159 (void) strlcpy(tofs
, destname
, sizeof (tofs
));
3160 if (flags
->isprefix
) {
3161 struct drr_begin
*drrb
= &drr
->drr_u
.drr_begin
;
3164 if (flags
->istail
) {
3165 cp
= strrchr(drrb
->drr_toname
, '/');
3167 (void) strlcat(tofs
, "/",
3171 i
= (cp
- drrb
->drr_toname
);
3174 i
= strcspn(drrb
->drr_toname
, "/@");
3176 /* zfs_receive_one() will create_parents() */
3177 (void) strlcat(tofs
, &drrb
->drr_toname
[i
],
3179 *strchr(tofs
, '@') = '\0';
3182 if (!flags
->dryrun
&& !flags
->nomount
) {
3183 VERIFY(0 == nvlist_alloc(&renamed
,
3184 NV_UNIQUE_NAME
, 0));
3187 softerr
= recv_incremental_replication(hdl
, tofs
, flags
,
3188 stream_nv
, stream_avl
, renamed
);
3190 /* Unmount renamed filesystems before receiving. */
3191 while ((pair
= nvlist_next_nvpair(renamed
,
3194 prop_changelist_t
*clp
= NULL
;
3196 zhp
= zfs_open(hdl
, nvpair_name(pair
),
3197 ZFS_TYPE_FILESYSTEM
);
3199 clp
= changelist_gather(zhp
,
3200 ZFS_PROP_MOUNTPOINT
, 0, 0);
3204 changelist_prefix(clp
);
3205 changelist_free(clp
);
3210 nvlist_free(renamed
);
3215 * Get the fs specified by the first path in the stream (the top level
3216 * specified by 'zfs send') and pass it to each invocation of
3217 * zfs_receive_one().
3219 (void) strlcpy(sendfs
, drr
->drr_u
.drr_begin
.drr_toname
,
3221 if ((cp
= strchr(sendfs
, '@')) != NULL
) {
3224 * Find the "sendsnap", the final snapshot in a replication
3225 * stream. zfs_receive_one() handles certain errors
3226 * differently, depending on if the contained stream is the
3229 sendsnap
= (cp
+ 1);
3232 /* Finally, receive each contained stream */
3235 * we should figure out if it has a recoverable
3236 * error, in which case do a recv_skip() and drive on.
3237 * Note, if we fail due to already having this guid,
3238 * zfs_receive_one() will take care of it (ie,
3239 * recv_skip() and return 0).
3241 error
= zfs_receive_impl(hdl
, destname
, NULL
, flags
, fd
,
3242 sendfs
, stream_nv
, stream_avl
, top_zfs
, cleanup_fd
,
3243 action_handlep
, sendsnap
, cmdprops
);
3244 if (error
== ENODATA
) {
3249 } while (error
== 0);
3251 if (drr
->drr_payloadlen
!= 0 && recursive
&& fromsnap
!= NULL
) {
3253 * Now that we have the fs's they sent us, try the
3256 softerr
= recv_incremental_replication(hdl
, tofs
, flags
,
3257 stream_nv
, stream_avl
, NULL
);
3260 if (raw
&& softerr
== 0) {
3261 softerr
= recv_fix_encryption_heirarchy(hdl
, destname
,
3262 stream_nv
, stream_avl
);
3266 fsavl_destroy(stream_avl
);
3267 nvlist_free(stream_nv
);
3276 trunc_prop_errs(int truncated
)
3278 ASSERT(truncated
!= 0);
3281 (void) fprintf(stderr
, dgettext(TEXT_DOMAIN
,
3282 "1 more property could not be set\n"));
3284 (void) fprintf(stderr
, dgettext(TEXT_DOMAIN
,
3285 "%d more properties could not be set\n"), truncated
);
3289 recv_skip(libzfs_handle_t
*hdl
, int fd
, boolean_t byteswap
)
3291 dmu_replay_record_t
*drr
;
3292 void *buf
= zfs_alloc(hdl
, SPA_MAXBLOCKSIZE
);
3295 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
3296 "cannot receive:"));
3298 /* XXX would be great to use lseek if possible... */
3301 while (recv_read(hdl
, fd
, drr
, sizeof (dmu_replay_record_t
),
3302 byteswap
, NULL
) == 0) {
3304 drr
->drr_type
= BSWAP_32(drr
->drr_type
);
3306 switch (drr
->drr_type
) {
3308 if (drr
->drr_payloadlen
!= 0) {
3309 (void) recv_read(hdl
, fd
, buf
,
3310 drr
->drr_payloadlen
, B_FALSE
, NULL
);
3320 drr
->drr_u
.drr_object
.drr_bonuslen
=
3321 BSWAP_32(drr
->drr_u
.drr_object
.
3324 (void) recv_read(hdl
, fd
, buf
,
3325 P2ROUNDUP(drr
->drr_u
.drr_object
.drr_bonuslen
, 8),
3331 drr
->drr_u
.drr_write
.drr_logical_size
=
3333 drr
->drr_u
.drr_write
.drr_logical_size
);
3334 drr
->drr_u
.drr_write
.drr_compressed_size
=
3336 drr
->drr_u
.drr_write
.drr_compressed_size
);
3338 uint64_t payload_size
=
3339 DRR_WRITE_PAYLOAD_SIZE(&drr
->drr_u
.drr_write
);
3340 (void) recv_read(hdl
, fd
, buf
,
3341 payload_size
, B_FALSE
, NULL
);
3345 drr
->drr_u
.drr_spill
.drr_length
=
3346 BSWAP_64(drr
->drr_u
.drr_spill
.drr_length
);
3348 (void) recv_read(hdl
, fd
, buf
,
3349 drr
->drr_u
.drr_spill
.drr_length
, B_FALSE
, NULL
);
3351 case DRR_WRITE_EMBEDDED
:
3353 drr
->drr_u
.drr_write_embedded
.drr_psize
=
3354 BSWAP_32(drr
->drr_u
.drr_write_embedded
.
3357 (void) recv_read(hdl
, fd
, buf
,
3358 P2ROUNDUP(drr
->drr_u
.drr_write_embedded
.drr_psize
,
3361 case DRR_WRITE_BYREF
:
3362 case DRR_FREEOBJECTS
:
3367 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3368 "invalid record type"));
3370 return (zfs_error(hdl
, EZFS_BADSTREAM
, errbuf
));
3379 recv_ecksum_set_aux(libzfs_handle_t
*hdl
, const char *target_snap
,
3380 boolean_t resumable
)
3382 char target_fs
[ZFS_MAX_DATASET_NAME_LEN
];
3384 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3385 "checksum mismatch or incomplete stream"));
3389 (void) strlcpy(target_fs
, target_snap
, sizeof (target_fs
));
3390 *strchr(target_fs
, '@') = '\0';
3391 zfs_handle_t
*zhp
= zfs_open(hdl
, target_fs
,
3392 ZFS_TYPE_FILESYSTEM
| ZFS_TYPE_VOLUME
);
3396 char token_buf
[ZFS_MAXPROPLEN
];
3397 int error
= zfs_prop_get(zhp
, ZFS_PROP_RECEIVE_RESUME_TOKEN
,
3398 token_buf
, sizeof (token_buf
),
3399 NULL
, NULL
, 0, B_TRUE
);
3401 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3402 "checksum mismatch or incomplete stream.\n"
3403 "Partially received snapshot is saved.\n"
3404 "A resuming stream can be generated on the sending "
3405 "system by running:\n"
3413 * Prepare a new nvlist of properties that are to override (-o) or be excluded
3414 * (-x) from the received dataset
3415 * recvprops: received properties from the send stream
3416 * cmdprops: raw input properties from command line
3417 * origprops: properties, both locally-set and received, currently set on the
3418 * target dataset if it exists, NULL otherwise.
3419 * oxprops: valid output override (-o) and excluded (-x) properties
3422 zfs_setup_cmdline_props(libzfs_handle_t
*hdl
, zfs_type_t type
, boolean_t zoned
,
3423 boolean_t recursive
, boolean_t toplevel
, nvlist_t
*recvprops
,
3424 nvlist_t
*cmdprops
, nvlist_t
*origprops
, nvlist_t
**oxprops
,
3428 nvlist_t
*oprops
, *voprops
;
3429 zfs_handle_t
*zhp
= NULL
;
3430 zpool_handle_t
*zpool_hdl
= NULL
;
3433 if (nvlist_empty(cmdprops
))
3434 return (0); /* No properties to override or exclude */
3436 *oxprops
= fnvlist_alloc();
3437 oprops
= fnvlist_alloc();
3440 * first iteration: process excluded (-x) properties now and gather
3441 * added (-o) properties to be later processed by zfs_valid_proplist()
3444 while ((nvp
= nvlist_next_nvpair(cmdprops
, nvp
)) != NULL
) {
3445 const char *name
= nvpair_name(nvp
);
3446 zfs_prop_t prop
= zfs_name_to_prop(name
);
3448 /* "origin" is processed separately, don't handle it here */
3449 if (prop
== ZFS_PROP_ORIGIN
)
3453 * we're trying to override or exclude a property that does not
3454 * make sense for this type of dataset, but we don't want to
3455 * fail if the receive is recursive: this comes in handy when
3456 * the send stream contains, for instance, a child ZVOL and
3457 * we're trying to receive it with "-o atime=on"
3459 if (!zfs_prop_valid_for_type(prop
, type
, B_FALSE
) &&
3460 !zfs_prop_user(name
)) {
3463 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3464 "property '%s' does not apply to datasets of this "
3466 ret
= zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
3470 switch (nvpair_type(nvp
)) {
3471 case DATA_TYPE_BOOLEAN
: /* -x property */
3473 * DATA_TYPE_BOOLEAN is the way we're asked to "exclude"
3474 * a property: this is done by forcing an explicit
3475 * inherit on the destination so the effective value is
3476 * not the one we received from the send stream.
3477 * We do this only if the property is not already
3478 * locally-set, in which case its value will take
3479 * priority over the received anyway.
3481 if (nvlist_exists(origprops
, name
)) {
3484 attrs
= fnvlist_lookup_nvlist(origprops
, name
);
3485 if (strcmp(fnvlist_lookup_string(attrs
,
3486 ZPROP_SOURCE
), ZPROP_SOURCE_VAL_RECVD
) != 0)
3490 * We can't force an explicit inherit on non-inheritable
3491 * properties: if we're asked to exclude this kind of
3492 * values we remove them from "recvprops" input nvlist.
3494 if (!zfs_prop_inheritable(prop
) &&
3495 !zfs_prop_user(name
) && /* can be inherited too */
3496 nvlist_exists(recvprops
, name
))
3497 fnvlist_remove(recvprops
, name
);
3499 fnvlist_add_nvpair(*oxprops
, nvp
);
3501 case DATA_TYPE_STRING
: /* -o property=value */
3502 fnvlist_add_nvpair(oprops
, nvp
);
3505 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3506 "property '%s' must be a string or boolean"), name
);
3507 ret
= zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
3513 /* convert override strings properties to native */
3514 if ((voprops
= zfs_valid_proplist(hdl
, ZFS_TYPE_DATASET
,
3515 oprops
, zoned
, zhp
, zpool_hdl
, B_FALSE
, errbuf
)) == NULL
) {
3516 ret
= zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
3520 /* second pass: process "-o" properties */
3521 fnvlist_merge(*oxprops
, voprops
);
3522 fnvlist_free(voprops
);
3524 /* override props on child dataset are inherited */
3526 while ((nvp
= nvlist_next_nvpair(oprops
, nvp
)) != NULL
) {
3527 const char *name
= nvpair_name(nvp
);
3528 fnvlist_add_boolean(*oxprops
, name
);
3533 fnvlist_free(oprops
);
3538 * Restores a backup of tosnap from the file descriptor specified by infd.
3541 zfs_receive_one(libzfs_handle_t
*hdl
, int infd
, const char *tosnap
,
3542 const char *originsnap
, recvflags_t
*flags
, dmu_replay_record_t
*drr
,
3543 dmu_replay_record_t
*drr_noswap
, const char *sendfs
, nvlist_t
*stream_nv
,
3544 avl_tree_t
*stream_avl
, char **top_zfs
, int cleanup_fd
,
3545 uint64_t *action_handlep
, const char *finalsnap
, nvlist_t
*cmdprops
)
3548 int ioctl_err
, ioctl_errno
, err
;
3550 struct drr_begin
*drrb
= &drr
->drr_u
.drr_begin
;
3552 const char *chopprefix
;
3553 boolean_t newfs
= B_FALSE
;
3554 boolean_t stream_wantsnewfs
;
3555 boolean_t newprops
= B_FALSE
;
3556 uint64_t read_bytes
= 0;
3557 uint64_t errflags
= 0;
3558 uint64_t parent_snapguid
= 0;
3559 prop_changelist_t
*clp
= NULL
;
3560 nvlist_t
*snapprops_nvlist
= NULL
;
3561 zprop_errflags_t prop_errflags
;
3562 nvlist_t
*prop_errors
= NULL
;
3563 boolean_t recursive
;
3564 char *snapname
= NULL
;
3565 char destsnap
[MAXPATHLEN
* 2];
3566 char origin
[MAXNAMELEN
];
3567 char name
[MAXPATHLEN
];
3568 char tmp_keylocation
[MAXNAMELEN
];
3569 nvlist_t
*rcvprops
= NULL
; /* props received from the send stream */
3570 nvlist_t
*oxprops
= NULL
; /* override (-o) and exclude (-x) props */
3571 nvlist_t
*origprops
= NULL
; /* original props (if destination exists) */
3574 boolean_t zoned
= B_FALSE
;
3576 begin_time
= time(NULL
);
3577 bzero(origin
, MAXNAMELEN
);
3578 bzero(tmp_keylocation
, MAXNAMELEN
);
3580 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
3583 recursive
= (nvlist_lookup_boolean(stream_nv
, "not_recursive") ==
3586 if (stream_avl
!= NULL
) {
3587 char *keylocation
= NULL
;
3588 nvlist_t
*lookup
= NULL
;
3589 nvlist_t
*fs
= fsavl_find(stream_avl
, drrb
->drr_toguid
,
3592 (void) nvlist_lookup_uint64(fs
, "parentfromsnap",
3594 err
= nvlist_lookup_nvlist(fs
, "props", &rcvprops
);
3596 VERIFY(0 == nvlist_alloc(&rcvprops
, NV_UNIQUE_NAME
, 0));
3601 * The keylocation property may only be set on encryption roots,
3602 * but this dataset might not become an encryption root until
3603 * recv_fix_encryption_heirarchy() is called. That function
3604 * will fixup the keylocation anyway, so we temporarily unset
3605 * the keylocation for now to avoid any errors from the receive
3608 err
= nvlist_lookup_string(rcvprops
,
3609 zfs_prop_to_name(ZFS_PROP_KEYLOCATION
), &keylocation
);
3611 strcpy(tmp_keylocation
, keylocation
);
3612 (void) nvlist_remove_all(rcvprops
,
3613 zfs_prop_to_name(ZFS_PROP_KEYLOCATION
));
3616 if (flags
->canmountoff
) {
3617 VERIFY(0 == nvlist_add_uint64(rcvprops
,
3618 zfs_prop_to_name(ZFS_PROP_CANMOUNT
), 0));
3620 if (0 == nvlist_lookup_nvlist(fs
, "snapprops", &lookup
)) {
3621 VERIFY(0 == nvlist_lookup_nvlist(lookup
,
3622 snapname
, &snapprops_nvlist
));
3629 * Determine how much of the snapshot name stored in the stream
3630 * we are going to tack on to the name they specified on the
3631 * command line, and how much we are going to chop off.
3633 * If they specified a snapshot, chop the entire name stored in
3636 if (flags
->istail
) {
3638 * A filesystem was specified with -e. We want to tack on only
3639 * the tail of the sent snapshot path.
3641 if (strchr(tosnap
, '@')) {
3642 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
, "invalid "
3643 "argument - snapshot not allowed with -e"));
3644 err
= zfs_error(hdl
, EZFS_INVALIDNAME
, errbuf
);
3648 chopprefix
= strrchr(sendfs
, '/');
3650 if (chopprefix
== NULL
) {
3652 * The tail is the poolname, so we need to
3653 * prepend a path separator.
3655 int len
= strlen(drrb
->drr_toname
);
3656 cp
= malloc(len
+ 2);
3658 (void) strcpy(&cp
[1], drrb
->drr_toname
);
3661 chopprefix
= drrb
->drr_toname
+ (chopprefix
- sendfs
);
3663 } else if (flags
->isprefix
) {
3665 * A filesystem was specified with -d. We want to tack on
3666 * everything but the first element of the sent snapshot path
3667 * (all but the pool name).
3669 if (strchr(tosnap
, '@')) {
3670 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
, "invalid "
3671 "argument - snapshot not allowed with -d"));
3672 err
= zfs_error(hdl
, EZFS_INVALIDNAME
, errbuf
);
3676 chopprefix
= strchr(drrb
->drr_toname
, '/');
3677 if (chopprefix
== NULL
)
3678 chopprefix
= strchr(drrb
->drr_toname
, '@');
3679 } else if (strchr(tosnap
, '@') == NULL
) {
3681 * If a filesystem was specified without -d or -e, we want to
3682 * tack on everything after the fs specified by 'zfs send'.
3684 chopprefix
= drrb
->drr_toname
+ strlen(sendfs
);
3686 /* A snapshot was specified as an exact path (no -d or -e). */
3688 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3689 "cannot specify snapshot name for multi-snapshot "
3691 err
= zfs_error(hdl
, EZFS_BADSTREAM
, errbuf
);
3694 chopprefix
= drrb
->drr_toname
+ strlen(drrb
->drr_toname
);
3697 ASSERT(strstr(drrb
->drr_toname
, sendfs
) == drrb
->drr_toname
);
3698 ASSERT(chopprefix
> drrb
->drr_toname
);
3699 ASSERT(chopprefix
<= drrb
->drr_toname
+ strlen(drrb
->drr_toname
));
3700 ASSERT(chopprefix
[0] == '/' || chopprefix
[0] == '@' ||
3701 chopprefix
[0] == '\0');
3704 * Determine name of destination snapshot.
3706 (void) strlcpy(destsnap
, tosnap
, sizeof (destsnap
));
3707 (void) strlcat(destsnap
, chopprefix
, sizeof (destsnap
));
3709 if (!zfs_name_valid(destsnap
, ZFS_TYPE_SNAPSHOT
)) {
3710 err
= zfs_error(hdl
, EZFS_INVALIDNAME
, errbuf
);
3715 * Determine the name of the origin snapshot.
3718 (void) strncpy(origin
, originsnap
, sizeof (origin
));
3720 (void) printf("using provided clone origin %s\n",
3722 } else if (drrb
->drr_flags
& DRR_FLAG_CLONE
) {
3723 if (guid_to_name(hdl
, destsnap
,
3724 drrb
->drr_fromguid
, B_FALSE
, origin
) != 0) {
3725 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3726 "local origin for clone %s does not exist"),
3728 err
= zfs_error(hdl
, EZFS_NOENT
, errbuf
);
3732 (void) printf("found clone origin %s\n", origin
);
3735 boolean_t resuming
= DMU_GET_FEATUREFLAGS(drrb
->drr_versioninfo
) &
3736 DMU_BACKUP_FEATURE_RESUMING
;
3737 boolean_t raw
= DMU_GET_FEATUREFLAGS(drrb
->drr_versioninfo
) &
3738 DMU_BACKUP_FEATURE_RAW
;
3739 boolean_t embedded
= DMU_GET_FEATUREFLAGS(drrb
->drr_versioninfo
) &
3740 DMU_BACKUP_FEATURE_EMBED_DATA
;
3741 stream_wantsnewfs
= (drrb
->drr_fromguid
== 0 ||
3742 (drrb
->drr_flags
& DRR_FLAG_CLONE
) || originsnap
) && !resuming
;
3744 if (stream_wantsnewfs
) {
3746 * if the parent fs does not exist, look for it based on
3747 * the parent snap GUID
3749 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
3750 "cannot receive new filesystem stream"));
3752 (void) strcpy(name
, destsnap
);
3753 cp
= strrchr(name
, '/');
3757 !zfs_dataset_exists(hdl
, name
, ZFS_TYPE_DATASET
)) {
3758 char suffix
[ZFS_MAX_DATASET_NAME_LEN
];
3759 (void) strcpy(suffix
, strrchr(destsnap
, '/'));
3760 if (guid_to_name(hdl
, name
, parent_snapguid
,
3761 B_FALSE
, destsnap
) == 0) {
3762 *strchr(destsnap
, '@') = '\0';
3763 (void) strcat(destsnap
, suffix
);
3768 * if the fs does not exist, look for it based on the
3771 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
3772 "cannot receive incremental stream"));
3774 (void) strcpy(name
, destsnap
);
3775 *strchr(name
, '@') = '\0';
3778 * If the exact receive path was specified and this is the
3779 * topmost path in the stream, then if the fs does not exist we
3780 * should look no further.
3782 if ((flags
->isprefix
|| (*(chopprefix
= drrb
->drr_toname
+
3783 strlen(sendfs
)) != '\0' && *chopprefix
!= '@')) &&
3784 !zfs_dataset_exists(hdl
, name
, ZFS_TYPE_DATASET
)) {
3785 char snap
[ZFS_MAX_DATASET_NAME_LEN
];
3786 (void) strcpy(snap
, strchr(destsnap
, '@'));
3787 if (guid_to_name(hdl
, name
, drrb
->drr_fromguid
,
3788 B_FALSE
, destsnap
) == 0) {
3789 *strchr(destsnap
, '@') = '\0';
3790 (void) strcat(destsnap
, snap
);
3795 (void) strcpy(name
, destsnap
);
3796 *strchr(name
, '@') = '\0';
3798 if (zfs_dataset_exists(hdl
, name
, ZFS_TYPE_DATASET
)) {
3799 zfs_cmd_t zc
= {"\0"};
3802 (void) strcpy(zc
.zc_name
, name
);
3805 * Destination fs exists. It must be one of these cases:
3806 * - an incremental send stream
3807 * - the stream specifies a new fs (full stream or clone)
3808 * and they want us to blow away the existing fs (and
3809 * have therefore specified -F and removed any snapshots)
3810 * - we are resuming a failed receive.
3812 if (stream_wantsnewfs
) {
3813 if (!flags
->force
) {
3814 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3815 "destination '%s' exists\n"
3816 "must specify -F to overwrite it"), name
);
3817 err
= zfs_error(hdl
, EZFS_EXISTS
, errbuf
);
3820 if (ioctl(hdl
->libzfs_fd
, ZFS_IOC_SNAPSHOT_LIST_NEXT
,
3822 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3823 "destination has snapshots (eg. %s)\n"
3824 "must destroy them to overwrite it"),
3826 err
= zfs_error(hdl
, EZFS_EXISTS
, errbuf
);
3831 if ((zhp
= zfs_open(hdl
, name
,
3832 ZFS_TYPE_FILESYSTEM
| ZFS_TYPE_VOLUME
)) == NULL
) {
3837 if (stream_wantsnewfs
&&
3838 zhp
->zfs_dmustats
.dds_origin
[0]) {
3840 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3841 "destination '%s' is a clone\n"
3842 "must destroy it to overwrite it"), name
);
3843 err
= zfs_error(hdl
, EZFS_EXISTS
, errbuf
);
3848 * zfs recv -F cant be used to blow away an existing
3849 * encrypted filesystem. This is because it would require
3850 * the dsl dir to point to the the new key (or lack of a
3851 * key) and the old key at the same time. The -F flag may
3852 * still be used for deleting intermediate snapshots that
3853 * would otherwise prevent the receive from working.
3855 if (stream_wantsnewfs
&& flags
->force
&&
3856 zfs_prop_get_int(zhp
, ZFS_PROP_ENCRYPTION
) !=
3859 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3860 "zfs receive -F cannot be used to "
3861 "destroy an encrypted filesystem"));
3862 err
= zfs_error(hdl
, EZFS_BADRESTORE
, errbuf
);
3867 if (!flags
->dryrun
&& zhp
->zfs_type
== ZFS_TYPE_FILESYSTEM
&&
3868 stream_wantsnewfs
) {
3869 /* We can't do online recv in this case */
3870 clp
= changelist_gather(zhp
, ZFS_PROP_NAME
, 0, 0);
3876 if (changelist_prefix(clp
) != 0) {
3877 changelist_free(clp
);
3885 * If we are resuming a newfs, set newfs here so that we will
3886 * mount it if the recv succeeds this time. We can tell
3887 * that it was a newfs on the first recv because the fs
3888 * itself will be inconsistent (if the fs existed when we
3889 * did the first recv, we would have received it into
3892 if (resuming
&& zfs_prop_get_int(zhp
, ZFS_PROP_INCONSISTENT
))
3895 /* we want to know if we're zoned when validating -o|-x props */
3896 zoned
= zfs_prop_get_int(zhp
, ZFS_PROP_ZONED
);
3898 /* gather existing properties on destination */
3899 origprops
= fnvlist_alloc();
3900 fnvlist_merge(origprops
, zhp
->zfs_props
);
3901 fnvlist_merge(origprops
, zhp
->zfs_user_props
);
3908 * Destination filesystem does not exist. Therefore we better
3909 * be creating a new filesystem (either from a full backup, or
3910 * a clone). It would therefore be invalid if the user
3911 * specified only the pool name (i.e. if the destination name
3912 * contained no slash character).
3914 cp
= strrchr(name
, '/');
3916 if (!stream_wantsnewfs
|| cp
== NULL
) {
3917 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3918 "destination '%s' does not exist"), name
);
3919 err
= zfs_error(hdl
, EZFS_NOENT
, errbuf
);
3924 * Trim off the final dataset component so we perform the
3925 * recvbackup ioctl to the filesystems's parent.
3929 if (flags
->isprefix
&& !flags
->istail
&& !flags
->dryrun
&&
3930 create_parents(hdl
, destsnap
, strlen(tosnap
)) != 0) {
3931 err
= zfs_error(hdl
, EZFS_BADRESTORE
, errbuf
);
3936 * It is invalid to receive a properties stream that was
3937 * unencrypted on the send side as a child of an encrypted
3938 * parent. Technically there is nothing preventing this, but
3939 * it would mean that the encryption=off property which is
3940 * locally set on the send side would not be received correctly.
3941 * We can infer encryption=off if the stream is not raw and
3942 * properties were included since the send side will only ever
3943 * send the encryption property in a raw nvlist header.
3945 if (!raw
&& rcvprops
!= NULL
) {
3948 zhp
= zfs_open(hdl
, name
, ZFS_TYPE_DATASET
);
3950 err
= zfs_error(hdl
, EZFS_BADRESTORE
, errbuf
);
3954 crypt
= zfs_prop_get_int(zhp
, ZFS_PROP_ENCRYPTION
);
3957 if (crypt
!= ZIO_CRYPT_OFF
) {
3958 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3959 "parent '%s' must not be encrypted to "
3960 "receive unenecrypted property"), name
);
3961 err
= zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
3970 if (flags
->verbose
) {
3971 (void) printf("%s %s stream of %s into %s\n",
3972 flags
->dryrun
? "would receive" : "receiving",
3973 drrb
->drr_fromguid
? "incremental" : "full",
3974 drrb
->drr_toname
, destsnap
);
3975 (void) fflush(stdout
);
3978 if (flags
->dryrun
) {
3979 err
= recv_skip(hdl
, infd
, flags
->byteswap
);
3983 toplevel
= chopprefix
[0] != '/';
3984 if (drrb
->drr_type
== DMU_OST_ZVOL
) {
3985 type
= ZFS_TYPE_VOLUME
;
3986 } else if (drrb
->drr_type
== DMU_OST_ZFS
) {
3987 type
= ZFS_TYPE_FILESYSTEM
;
3989 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3990 "invalid record type: 0x%d"), drrb
->drr_type
);
3991 err
= zfs_error(hdl
, EZFS_BADSTREAM
, errbuf
);
3994 if ((err
= zfs_setup_cmdline_props(hdl
, type
, zoned
, recursive
,
3995 toplevel
, rcvprops
, cmdprops
, origprops
, &oxprops
, errbuf
)) != 0)
3998 err
= ioctl_err
= lzc_receive_with_cmdprops(destsnap
, rcvprops
, oxprops
,
3999 origin
, flags
->force
, flags
->resumable
, raw
, infd
, drr_noswap
,
4000 cleanup_fd
, &read_bytes
, &errflags
, action_handlep
, &prop_errors
);
4001 ioctl_errno
= ioctl_err
;
4002 prop_errflags
= errflags
;
4005 nvpair_t
*prop_err
= NULL
;
4007 while ((prop_err
= nvlist_next_nvpair(prop_errors
,
4008 prop_err
)) != NULL
) {
4013 prop
= zfs_name_to_prop(nvpair_name(prop_err
));
4014 (void) nvpair_value_int32(prop_err
, &intval
);
4015 if (strcmp(nvpair_name(prop_err
),
4016 ZPROP_N_MORE_ERRORS
) == 0) {
4017 trunc_prop_errs(intval
);
4019 } else if (snapname
== NULL
|| finalsnap
== NULL
||
4020 strcmp(finalsnap
, snapname
) == 0 ||
4021 strcmp(nvpair_name(prop_err
),
4022 zfs_prop_to_name(ZFS_PROP_REFQUOTA
)) != 0) {
4024 * Skip the special case of, for example,
4025 * "refquota", errors on intermediate
4026 * snapshots leading up to a final one.
4027 * That's why we have all of the checks above.
4029 * See zfs_ioctl.c's extract_delay_props() for
4030 * a list of props which can fail on
4031 * intermediate snapshots, but shouldn't
4032 * affect the overall receive.
4034 (void) snprintf(tbuf
, sizeof (tbuf
),
4035 dgettext(TEXT_DOMAIN
,
4036 "cannot receive %s property on %s"),
4037 nvpair_name(prop_err
), name
);
4038 zfs_setprop_error(hdl
, prop
, intval
, tbuf
);
4043 if (err
== 0 && snapprops_nvlist
) {
4044 zfs_cmd_t zc
= {"\0"};
4046 (void) strcpy(zc
.zc_name
, destsnap
);
4047 zc
.zc_cookie
= B_TRUE
; /* received */
4048 if (zcmd_write_src_nvlist(hdl
, &zc
, snapprops_nvlist
) == 0) {
4049 (void) zfs_ioctl(hdl
, ZFS_IOC_SET_PROP
, &zc
);
4050 zcmd_free_nvlists(&zc
);
4054 if (err
&& (ioctl_errno
== ENOENT
|| ioctl_errno
== EEXIST
)) {
4056 * It may be that this snapshot already exists,
4057 * in which case we want to consume & ignore it
4058 * rather than failing.
4060 avl_tree_t
*local_avl
;
4061 nvlist_t
*local_nv
, *fs
;
4062 cp
= strchr(destsnap
, '@');
4065 * XXX Do this faster by just iterating over snaps in
4066 * this fs. Also if zc_value does not exist, we will
4067 * get a strange "does not exist" error message.
4070 if (gather_nvlist(hdl
, destsnap
, NULL
, NULL
, B_FALSE
, B_TRUE
,
4071 B_FALSE
, &local_nv
, &local_avl
) == 0) {
4073 fs
= fsavl_find(local_avl
, drrb
->drr_toguid
, NULL
);
4074 fsavl_destroy(local_avl
);
4075 nvlist_free(local_nv
);
4078 if (flags
->verbose
) {
4079 (void) printf("snap %s already exists; "
4080 "ignoring\n", destsnap
);
4082 err
= ioctl_err
= recv_skip(hdl
, infd
,
4089 if (ioctl_err
!= 0) {
4090 switch (ioctl_errno
) {
4092 cp
= strchr(destsnap
, '@');
4094 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4095 "most recent snapshot of %s does not\n"
4096 "match incremental source"), destsnap
);
4097 (void) zfs_error(hdl
, EZFS_BADRESTORE
, errbuf
);
4101 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4102 "destination %s has been modified\n"
4103 "since most recent snapshot"), name
);
4104 (void) zfs_error(hdl
, EZFS_BADRESTORE
, errbuf
);
4107 if (raw
&& stream_wantsnewfs
) {
4108 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4109 "failed to create encryption key"));
4110 } else if (raw
&& !stream_wantsnewfs
) {
4111 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4112 "encryption key does not match "
4115 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4116 "inherited key must be loaded"));
4118 (void) zfs_error(hdl
, EZFS_CRYPTOFAILED
, errbuf
);
4121 cp
= strchr(destsnap
, '@');
4123 /* it's the containing fs that exists */
4126 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4127 "destination already exists"));
4128 (void) zfs_error_fmt(hdl
, EZFS_EXISTS
,
4129 dgettext(TEXT_DOMAIN
, "cannot restore to %s"),
4134 if (flags
->resumable
)
4135 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4136 "kernel modules must be upgraded to "
4137 "receive this stream."));
4138 if (embedded
&& !raw
)
4139 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4140 "incompatible embedded data stream "
4141 "feature with encrypted receive."));
4142 (void) zfs_error(hdl
, EZFS_BADSTREAM
, errbuf
);
4145 recv_ecksum_set_aux(hdl
, destsnap
, flags
->resumable
);
4146 (void) zfs_error(hdl
, EZFS_BADSTREAM
, errbuf
);
4149 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4150 "pool must be upgraded to receive this stream."));
4151 (void) zfs_error(hdl
, EZFS_BADVERSION
, errbuf
);
4154 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4155 "destination %s space quota exceeded"), name
);
4156 (void) zfs_error(hdl
, EZFS_NOSPC
, errbuf
);
4159 (void) zfs_standard_error(hdl
, ioctl_errno
, errbuf
);
4164 * Mount the target filesystem (if created). Also mount any
4165 * children of the target filesystem if we did a replication
4166 * receive (indicated by stream_avl being non-NULL).
4168 cp
= strchr(destsnap
, '@');
4169 if (cp
&& (ioctl_err
== 0 || !newfs
)) {
4173 h
= zfs_open(hdl
, destsnap
,
4174 ZFS_TYPE_FILESYSTEM
| ZFS_TYPE_VOLUME
);
4176 if (h
->zfs_type
== ZFS_TYPE_VOLUME
) {
4178 } else if (newfs
|| stream_avl
) {
4180 * Track the first/top of hierarchy fs,
4181 * for mounting and sharing later.
4183 if (top_zfs
&& *top_zfs
== NULL
)
4184 *top_zfs
= zfs_strdup(hdl
, destsnap
);
4192 if (!flags
->nomount
)
4193 err
|= changelist_postfix(clp
);
4194 changelist_free(clp
);
4197 if (prop_errflags
& ZPROP_ERR_NOCLEAR
) {
4198 (void) fprintf(stderr
, dgettext(TEXT_DOMAIN
, "Warning: "
4199 "failed to clear unreceived properties on %s"), name
);
4200 (void) fprintf(stderr
, "\n");
4202 if (prop_errflags
& ZPROP_ERR_NORESTORE
) {
4203 (void) fprintf(stderr
, dgettext(TEXT_DOMAIN
, "Warning: "
4204 "failed to restore original properties on %s"), name
);
4205 (void) fprintf(stderr
, "\n");
4208 if (err
|| ioctl_err
) {
4213 if (flags
->verbose
) {
4216 uint64_t bytes
= read_bytes
;
4217 time_t delta
= time(NULL
) - begin_time
;
4220 zfs_nicebytes(bytes
, buf1
, sizeof (buf1
));
4221 zfs_nicebytes(bytes
/delta
, buf2
, sizeof (buf1
));
4223 (void) printf("received %s stream in %lu seconds (%s/sec)\n",
4229 if (prop_errors
!= NULL
)
4230 nvlist_free(prop_errors
);
4232 if (tmp_keylocation
[0] != '\0') {
4233 VERIFY(0 == nvlist_add_string(rcvprops
,
4234 zfs_prop_to_name(ZFS_PROP_KEYLOCATION
), tmp_keylocation
));
4238 nvlist_free(rcvprops
);
4240 nvlist_free(oxprops
);
4241 nvlist_free(origprops
);
4247 * Check properties we were asked to override (both -o|-x)
4250 zfs_receive_checkprops(libzfs_handle_t
*hdl
, nvlist_t
*props
,
4258 while ((nvp
= nvlist_next_nvpair(props
, nvp
)) != NULL
) {
4259 name
= nvpair_name(nvp
);
4260 prop
= zfs_name_to_prop(name
);
4262 if (prop
== ZPROP_INVAL
) {
4263 if (!zfs_prop_user(name
)) {
4264 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4265 "invalid property '%s'"), name
);
4271 * "origin" is readonly but is used to receive datasets as
4272 * clones so we don't raise an error here
4274 if (prop
== ZFS_PROP_ORIGIN
)
4278 * cannot override readonly, set-once and other specific
4279 * settable properties
4281 if (zfs_prop_readonly(prop
) || prop
== ZFS_PROP_VERSION
||
4282 prop
== ZFS_PROP_VOLSIZE
) {
4283 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4284 "invalid property '%s'"), name
);
4293 zfs_receive_impl(libzfs_handle_t
*hdl
, const char *tosnap
,
4294 const char *originsnap
, recvflags_t
*flags
, int infd
, const char *sendfs
,
4295 nvlist_t
*stream_nv
, avl_tree_t
*stream_avl
, char **top_zfs
, int cleanup_fd
,
4296 uint64_t *action_handlep
, const char *finalsnap
, nvlist_t
*cmdprops
)
4299 dmu_replay_record_t drr
, drr_noswap
;
4300 struct drr_begin
*drrb
= &drr
.drr_u
.drr_begin
;
4302 zio_cksum_t zcksum
= { { 0 } };
4303 uint64_t featureflags
;
4306 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
4309 /* check cmdline props, raise an error if they cannot be received */
4310 if (!zfs_receive_checkprops(hdl
, cmdprops
, errbuf
)) {
4311 return (zfs_error(hdl
, EZFS_BADPROP
, errbuf
));
4314 if (flags
->isprefix
&&
4315 !zfs_dataset_exists(hdl
, tosnap
, ZFS_TYPE_DATASET
)) {
4316 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
, "specified fs "
4317 "(%s) does not exist"), tosnap
);
4318 return (zfs_error(hdl
, EZFS_NOENT
, errbuf
));
4321 !zfs_dataset_exists(hdl
, originsnap
, ZFS_TYPE_DATASET
)) {
4322 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
, "specified origin fs "
4323 "(%s) does not exist"), originsnap
);
4324 return (zfs_error(hdl
, EZFS_NOENT
, errbuf
));
4327 /* read in the BEGIN record */
4328 if (0 != (err
= recv_read(hdl
, infd
, &drr
, sizeof (drr
), B_FALSE
,
4332 if (drr
.drr_type
== DRR_END
|| drr
.drr_type
== BSWAP_32(DRR_END
)) {
4333 /* It's the double end record at the end of a package */
4337 /* the kernel needs the non-byteswapped begin record */
4340 flags
->byteswap
= B_FALSE
;
4341 if (drrb
->drr_magic
== BSWAP_64(DMU_BACKUP_MAGIC
)) {
4343 * We computed the checksum in the wrong byteorder in
4344 * recv_read() above; do it again correctly.
4346 bzero(&zcksum
, sizeof (zio_cksum_t
));
4347 fletcher_4_incremental_byteswap(&drr
, sizeof (drr
), &zcksum
);
4348 flags
->byteswap
= B_TRUE
;
4350 drr
.drr_type
= BSWAP_32(drr
.drr_type
);
4351 drr
.drr_payloadlen
= BSWAP_32(drr
.drr_payloadlen
);
4352 drrb
->drr_magic
= BSWAP_64(drrb
->drr_magic
);
4353 drrb
->drr_versioninfo
= BSWAP_64(drrb
->drr_versioninfo
);
4354 drrb
->drr_creation_time
= BSWAP_64(drrb
->drr_creation_time
);
4355 drrb
->drr_type
= BSWAP_32(drrb
->drr_type
);
4356 drrb
->drr_flags
= BSWAP_32(drrb
->drr_flags
);
4357 drrb
->drr_toguid
= BSWAP_64(drrb
->drr_toguid
);
4358 drrb
->drr_fromguid
= BSWAP_64(drrb
->drr_fromguid
);
4361 if (drrb
->drr_magic
!= DMU_BACKUP_MAGIC
|| drr
.drr_type
!= DRR_BEGIN
) {
4362 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
, "invalid "
4363 "stream (bad magic number)"));
4364 return (zfs_error(hdl
, EZFS_BADSTREAM
, errbuf
));
4367 featureflags
= DMU_GET_FEATUREFLAGS(drrb
->drr_versioninfo
);
4368 hdrtype
= DMU_GET_STREAM_HDRTYPE(drrb
->drr_versioninfo
);
4370 if (!DMU_STREAM_SUPPORTED(featureflags
) ||
4371 (hdrtype
!= DMU_SUBSTREAM
&& hdrtype
!= DMU_COMPOUNDSTREAM
)) {
4372 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4373 "stream has unsupported feature, feature flags = %lx"),
4375 return (zfs_error(hdl
, EZFS_BADSTREAM
, errbuf
));
4378 if (strchr(drrb
->drr_toname
, '@') == NULL
) {
4379 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
, "invalid "
4380 "stream (bad snapshot name)"));
4381 return (zfs_error(hdl
, EZFS_BADSTREAM
, errbuf
));
4384 if (DMU_GET_STREAM_HDRTYPE(drrb
->drr_versioninfo
) == DMU_SUBSTREAM
) {
4385 char nonpackage_sendfs
[ZFS_MAX_DATASET_NAME_LEN
];
4386 if (sendfs
== NULL
) {
4388 * We were not called from zfs_receive_package(). Get
4389 * the fs specified by 'zfs send'.
4392 (void) strlcpy(nonpackage_sendfs
,
4393 drr
.drr_u
.drr_begin
.drr_toname
,
4394 sizeof (nonpackage_sendfs
));
4395 if ((cp
= strchr(nonpackage_sendfs
, '@')) != NULL
)
4397 sendfs
= nonpackage_sendfs
;
4398 VERIFY(finalsnap
== NULL
);
4400 return (zfs_receive_one(hdl
, infd
, tosnap
, originsnap
, flags
,
4401 &drr
, &drr_noswap
, sendfs
, stream_nv
, stream_avl
, top_zfs
,
4402 cleanup_fd
, action_handlep
, finalsnap
, cmdprops
));
4404 assert(DMU_GET_STREAM_HDRTYPE(drrb
->drr_versioninfo
) ==
4405 DMU_COMPOUNDSTREAM
);
4406 return (zfs_receive_package(hdl
, infd
, tosnap
, flags
, &drr
,
4407 &zcksum
, top_zfs
, cleanup_fd
, action_handlep
, cmdprops
));
4412 * Restores a backup of tosnap from the file descriptor specified by infd.
4413 * Return 0 on total success, -2 if some things couldn't be
4414 * destroyed/renamed/promoted, -1 if some things couldn't be received.
4415 * (-1 will override -2, if -1 and the resumable flag was specified the
4416 * transfer can be resumed if the sending side supports it).
4419 zfs_receive(libzfs_handle_t
*hdl
, const char *tosnap
, nvlist_t
*props
,
4420 recvflags_t
*flags
, int infd
, avl_tree_t
*stream_avl
)
4422 char *top_zfs
= NULL
;
4425 uint64_t action_handle
= 0;
4427 char *originsnap
= NULL
;
4430 * The only way fstat can fail is if we do not have a valid file
4433 if (fstat(infd
, &sb
) == -1) {
4439 #ifndef F_SETPIPE_SZ
4440 #define F_SETPIPE_SZ (F_SETLEASE + 7)
4441 #endif /* F_SETPIPE_SZ */
4443 #ifndef F_GETPIPE_SZ
4444 #define F_GETPIPE_SZ (F_GETLEASE + 7)
4445 #endif /* F_GETPIPE_SZ */
4448 * It is not uncommon for gigabytes to be processed in zfs receive.
4449 * Speculatively increase the buffer size via Linux-specific fcntl()
4452 if (S_ISFIFO(sb
.st_mode
)) {
4453 FILE *procf
= fopen("/proc/sys/fs/pipe-max-size", "r");
4455 if (procf
!= NULL
) {
4456 unsigned long max_psize
;
4458 if (fscanf(procf
, "%lu", &max_psize
) > 0) {
4459 cur_psize
= fcntl(infd
, F_GETPIPE_SZ
);
4460 if (cur_psize
> 0 &&
4461 max_psize
> (unsigned long) cur_psize
)
4462 (void) fcntl(infd
, F_SETPIPE_SZ
,
4468 #endif /* __linux__ */
4471 err
= nvlist_lookup_string(props
, "origin", &originsnap
);
4472 if (err
&& err
!= ENOENT
)
4476 cleanup_fd
= open(ZFS_DEV
, O_RDWR
);
4477 VERIFY(cleanup_fd
>= 0);
4479 err
= zfs_receive_impl(hdl
, tosnap
, originsnap
, flags
, infd
, NULL
, NULL
,
4480 stream_avl
, &top_zfs
, cleanup_fd
, &action_handle
, NULL
, props
);
4482 VERIFY(0 == close(cleanup_fd
));
4484 if (err
== 0 && !flags
->nomount
&& top_zfs
) {
4485 zfs_handle_t
*zhp
= NULL
;
4486 prop_changelist_t
*clp
= NULL
;
4488 zhp
= zfs_open(hdl
, top_zfs
, ZFS_TYPE_FILESYSTEM
);
4490 clp
= changelist_gather(zhp
, ZFS_PROP_MOUNTPOINT
,
4491 CL_GATHER_MOUNT_ALWAYS
, 0);
4494 /* mount and share received datasets */
4495 err
= changelist_postfix(clp
);
4496 changelist_free(clp
);
4499 if (zhp
== NULL
|| clp
== NULL
|| err
)