1 /* 2 * CDDL HEADER START 3 * 4 * The contents of this file are subject to the terms of the 5 * Common Development and Distribution License (the "License"). 6 * You may not use this file except in compliance with the License. 7 * 8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9 * or http://www.opensolaris.org/os/licensing. 10 * See the License for the specific language governing permissions 11 * and limitations under the License. 12 * 13 * When distributing Covered Code, include this CDDL HEADER in each 14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15 * If applicable, add the following below this CDDL HEADER, with the 16 * fields enclosed by brackets "[]" replaced with your own identifying 17 * information: Portions Copyright [yyyy] [name of copyright owner] 18 * 19 * CDDL HEADER END 20 */ 21 22 /* 23 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved. 24 * Copyright (c) 2011, 2020 by Delphix. All rights reserved. 25 * Copyright (c) 2012, Joyent, Inc. All rights reserved. 26 * Copyright (c) 2012 Pawel Jakub Dawidek <pawel@dawidek.net>. 27 * All rights reserved 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) 2018, loli10K <ezomori.nozomu@gmail.com>. All rights reserved. 32 * Copyright (c) 2019 Datto Inc. 33 */ 34 35 #include <assert.h> 36 #include <ctype.h> 37 #include <errno.h> 38 #include <libintl.h> 39 #include <stdio.h> 40 #include <stdlib.h> 41 #include <strings.h> 42 #include <unistd.h> 43 #include <stddef.h> 44 #include <fcntl.h> 45 #include <sys/mount.h> 46 #include <sys/mntent.h> 47 #include <sys/mnttab.h> 48 #include <sys/avl.h> 49 #include <sys/debug.h> 50 #include <sys/stat.h> 51 #include <stddef.h> 52 #include <pthread.h> 53 #include <umem.h> 54 #include <time.h> 55 56 #include <libzfs.h> 57 #include <libzfs_core.h> 58 #include <libzutil.h> 59 60 #include "zfs_namecheck.h" 61 #include "zfs_prop.h" 62 #include "zfs_fletcher.h" 63 #include "libzfs_impl.h" 64 #include <cityhash.h> 65 #include <zlib.h> 66 #include <sys/zio_checksum.h> 67 #include <sys/dsl_crypt.h> 68 #include <sys/ddt.h> 69 #include <sys/socket.h> 70 #include <sys/sha2.h> 71 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 **, 74 const char *, nvlist_t *); 75 static int guid_to_name_redact_snaps(libzfs_handle_t *hdl, const char *parent, 76 uint64_t guid, boolean_t bookmark_ok, uint64_t *redact_snap_guids, 77 uint64_t num_redact_snaps, char *name); 78 static int guid_to_name(libzfs_handle_t *, const char *, 79 uint64_t, boolean_t, char *); 80 81 typedef struct progress_arg { 82 zfs_handle_t *pa_zhp; 83 int pa_fd; 84 boolean_t pa_parsable; 85 boolean_t pa_estimate; 86 int pa_verbosity; 87 } progress_arg_t; 88 89 static int 90 dump_record(dmu_replay_record_t *drr, void *payload, int payload_len, 91 zio_cksum_t *zc, int outfd) 92 { 93 ASSERT3U(offsetof(dmu_replay_record_t, drr_u.drr_checksum.drr_checksum), 94 ==, sizeof (dmu_replay_record_t) - sizeof (zio_cksum_t)); 95 fletcher_4_incremental_native(drr, 96 offsetof(dmu_replay_record_t, drr_u.drr_checksum.drr_checksum), zc); 97 if (drr->drr_type != DRR_BEGIN) { 98 ASSERT(ZIO_CHECKSUM_IS_ZERO(&drr->drr_u. 99 drr_checksum.drr_checksum)); 100 drr->drr_u.drr_checksum.drr_checksum = *zc; 101 } 102 fletcher_4_incremental_native(&drr->drr_u.drr_checksum.drr_checksum, 103 sizeof (zio_cksum_t), zc); 104 if (write(outfd, drr, sizeof (*drr)) == -1) 105 return (errno); 106 if (payload_len != 0) { 107 fletcher_4_incremental_native(payload, payload_len, zc); 108 if (write(outfd, payload, payload_len) == -1) 109 return (errno); 110 } 111 return (0); 112 } 113 114 /* 115 * Routines for dealing with the AVL tree of fs-nvlists 116 */ 117 typedef struct fsavl_node { 118 avl_node_t fn_node; 119 nvlist_t *fn_nvfs; 120 char *fn_snapname; 121 uint64_t fn_guid; 122 } fsavl_node_t; 123 124 static int 125 fsavl_compare(const void *arg1, const void *arg2) 126 { 127 const fsavl_node_t *fn1 = (const fsavl_node_t *)arg1; 128 const fsavl_node_t *fn2 = (const fsavl_node_t *)arg2; 129 130 return (TREE_CMP(fn1->fn_guid, fn2->fn_guid)); 131 } 132 133 /* 134 * Given the GUID of a snapshot, find its containing filesystem and 135 * (optionally) name. 136 */ 137 static nvlist_t * 138 fsavl_find(avl_tree_t *avl, uint64_t snapguid, char **snapname) 139 { 140 fsavl_node_t fn_find; 141 fsavl_node_t *fn; 142 143 fn_find.fn_guid = snapguid; 144 145 fn = avl_find(avl, &fn_find, NULL); 146 if (fn) { 147 if (snapname) 148 *snapname = fn->fn_snapname; 149 return (fn->fn_nvfs); 150 } 151 return (NULL); 152 } 153 154 static void 155 fsavl_destroy(avl_tree_t *avl) 156 { 157 fsavl_node_t *fn; 158 void *cookie; 159 160 if (avl == NULL) 161 return; 162 163 cookie = NULL; 164 while ((fn = avl_destroy_nodes(avl, &cookie)) != NULL) 165 free(fn); 166 avl_destroy(avl); 167 free(avl); 168 } 169 170 /* 171 * Given an nvlist, produce an avl tree of snapshots, ordered by guid 172 */ 173 static avl_tree_t * 174 fsavl_create(nvlist_t *fss) 175 { 176 avl_tree_t *fsavl; 177 nvpair_t *fselem = NULL; 178 179 if ((fsavl = malloc(sizeof (avl_tree_t))) == NULL) 180 return (NULL); 181 182 avl_create(fsavl, fsavl_compare, sizeof (fsavl_node_t), 183 offsetof(fsavl_node_t, fn_node)); 184 185 while ((fselem = nvlist_next_nvpair(fss, fselem)) != NULL) { 186 nvlist_t *nvfs, *snaps; 187 nvpair_t *snapelem = NULL; 188 189 VERIFY(0 == nvpair_value_nvlist(fselem, &nvfs)); 190 VERIFY(0 == nvlist_lookup_nvlist(nvfs, "snaps", &snaps)); 191 192 while ((snapelem = 193 nvlist_next_nvpair(snaps, snapelem)) != NULL) { 194 fsavl_node_t *fn; 195 uint64_t guid; 196 197 VERIFY(0 == nvpair_value_uint64(snapelem, &guid)); 198 if ((fn = malloc(sizeof (fsavl_node_t))) == NULL) { 199 fsavl_destroy(fsavl); 200 return (NULL); 201 } 202 fn->fn_nvfs = nvfs; 203 fn->fn_snapname = nvpair_name(snapelem); 204 fn->fn_guid = guid; 205 206 /* 207 * Note: if there are multiple snaps with the 208 * same GUID, we ignore all but one. 209 */ 210 if (avl_find(fsavl, fn, NULL) == NULL) 211 avl_add(fsavl, fn); 212 else 213 free(fn); 214 } 215 } 216 217 return (fsavl); 218 } 219 220 /* 221 * Routines for dealing with the giant nvlist of fs-nvlists, etc. 222 */ 223 typedef struct send_data { 224 /* 225 * assigned inside every recursive call, 226 * restored from *_save on return: 227 * 228 * guid of fromsnap snapshot in parent dataset 229 * txg of fromsnap snapshot in current dataset 230 * txg of tosnap snapshot in current dataset 231 */ 232 233 uint64_t parent_fromsnap_guid; 234 uint64_t fromsnap_txg; 235 uint64_t tosnap_txg; 236 237 /* the nvlists get accumulated during depth-first traversal */ 238 nvlist_t *parent_snaps; 239 nvlist_t *fss; 240 nvlist_t *snapprops; 241 nvlist_t *snapholds; /* user holds */ 242 243 /* send-receive configuration, does not change during traversal */ 244 const char *fsname; 245 const char *fromsnap; 246 const char *tosnap; 247 boolean_t recursive; 248 boolean_t raw; 249 boolean_t doall; 250 boolean_t replicate; 251 boolean_t verbose; 252 boolean_t backup; 253 boolean_t seenfrom; 254 boolean_t seento; 255 boolean_t holds; /* were holds requested with send -h */ 256 boolean_t props; 257 258 /* 259 * The header nvlist is of the following format: 260 * { 261 * "tosnap" -> string 262 * "fromsnap" -> string (if incremental) 263 * "fss" -> { 264 * id -> { 265 * 266 * "name" -> string (full name; for debugging) 267 * "parentfromsnap" -> number (guid of fromsnap in parent) 268 * 269 * "props" -> { name -> value (only if set here) } 270 * "snaps" -> { name (lastname) -> number (guid) } 271 * "snapprops" -> { name (lastname) -> { name -> value } } 272 * "snapholds" -> { name (lastname) -> { holdname -> crtime } } 273 * 274 * "origin" -> number (guid) (if clone) 275 * "is_encroot" -> boolean 276 * "sent" -> boolean (not on-disk) 277 * } 278 * } 279 * } 280 * 281 */ 282 } send_data_t; 283 284 static void 285 send_iterate_prop(zfs_handle_t *zhp, boolean_t received_only, nvlist_t *nv); 286 287 static int 288 send_iterate_snap(zfs_handle_t *zhp, void *arg) 289 { 290 send_data_t *sd = arg; 291 uint64_t guid = zhp->zfs_dmustats.dds_guid; 292 uint64_t txg = zhp->zfs_dmustats.dds_creation_txg; 293 char *snapname; 294 nvlist_t *nv; 295 boolean_t isfromsnap, istosnap, istosnapwithnofrom; 296 297 snapname = strrchr(zhp->zfs_name, '@')+1; 298 isfromsnap = (sd->fromsnap != NULL && 299 strcmp(sd->fromsnap, snapname) == 0); 300 istosnap = (sd->tosnap != NULL && (strcmp(sd->tosnap, snapname) == 0)); 301 istosnapwithnofrom = (istosnap && sd->fromsnap == NULL); 302 303 if (sd->tosnap_txg != 0 && txg > sd->tosnap_txg) { 304 if (sd->verbose) { 305 (void) fprintf(stderr, dgettext(TEXT_DOMAIN, 306 "skipping snapshot %s because it was created " 307 "after the destination snapshot (%s)\n"), 308 zhp->zfs_name, sd->tosnap); 309 } 310 zfs_close(zhp); 311 return (0); 312 } 313 314 VERIFY(0 == nvlist_add_uint64(sd->parent_snaps, snapname, guid)); 315 /* 316 * NB: if there is no fromsnap here (it's a newly created fs in 317 * an incremental replication), we will substitute the tosnap. 318 */ 319 if (isfromsnap || (sd->parent_fromsnap_guid == 0 && istosnap)) { 320 sd->parent_fromsnap_guid = guid; 321 } 322 323 if (!sd->recursive) { 324 if (!sd->seenfrom && isfromsnap) { 325 sd->seenfrom = B_TRUE; 326 zfs_close(zhp); 327 return (0); 328 } 329 330 if ((sd->seento || !sd->seenfrom) && !istosnapwithnofrom) { 331 zfs_close(zhp); 332 return (0); 333 } 334 335 if (istosnap) 336 sd->seento = B_TRUE; 337 } 338 339 VERIFY(0 == nvlist_alloc(&nv, NV_UNIQUE_NAME, 0)); 340 send_iterate_prop(zhp, sd->backup, nv); 341 VERIFY(0 == nvlist_add_nvlist(sd->snapprops, snapname, nv)); 342 nvlist_free(nv); 343 if (sd->holds) { 344 nvlist_t *holds = fnvlist_alloc(); 345 int err = lzc_get_holds(zhp->zfs_name, &holds); 346 if (err == 0) { 347 VERIFY(0 == nvlist_add_nvlist(sd->snapholds, 348 snapname, holds)); 349 } 350 fnvlist_free(holds); 351 } 352 353 zfs_close(zhp); 354 return (0); 355 } 356 357 static void 358 send_iterate_prop(zfs_handle_t *zhp, boolean_t received_only, nvlist_t *nv) 359 { 360 nvlist_t *props = NULL; 361 nvpair_t *elem = NULL; 362 363 if (received_only) 364 props = zfs_get_recvd_props(zhp); 365 else 366 props = zhp->zfs_props; 367 368 while ((elem = nvlist_next_nvpair(props, elem)) != NULL) { 369 char *propname = nvpair_name(elem); 370 zfs_prop_t prop = zfs_name_to_prop(propname); 371 nvlist_t *propnv; 372 373 if (!zfs_prop_user(propname)) { 374 /* 375 * Realistically, this should never happen. However, 376 * we want the ability to add DSL properties without 377 * needing to make incompatible version changes. We 378 * need to ignore unknown properties to allow older 379 * software to still send datasets containing these 380 * properties, with the unknown properties elided. 381 */ 382 if (prop == ZPROP_INVAL) 383 continue; 384 385 if (zfs_prop_readonly(prop)) 386 continue; 387 } 388 389 verify(nvpair_value_nvlist(elem, &propnv) == 0); 390 if (prop == ZFS_PROP_QUOTA || prop == ZFS_PROP_RESERVATION || 391 prop == ZFS_PROP_REFQUOTA || 392 prop == ZFS_PROP_REFRESERVATION) { 393 char *source; 394 uint64_t value; 395 verify(nvlist_lookup_uint64(propnv, 396 ZPROP_VALUE, &value) == 0); 397 if (zhp->zfs_type == ZFS_TYPE_SNAPSHOT) 398 continue; 399 /* 400 * May have no source before SPA_VERSION_RECVD_PROPS, 401 * but is still modifiable. 402 */ 403 if (nvlist_lookup_string(propnv, 404 ZPROP_SOURCE, &source) == 0) { 405 if ((strcmp(source, zhp->zfs_name) != 0) && 406 (strcmp(source, 407 ZPROP_SOURCE_VAL_RECVD) != 0)) 408 continue; 409 } 410 } else { 411 char *source; 412 if (nvlist_lookup_string(propnv, 413 ZPROP_SOURCE, &source) != 0) 414 continue; 415 if ((strcmp(source, zhp->zfs_name) != 0) && 416 (strcmp(source, ZPROP_SOURCE_VAL_RECVD) != 0)) 417 continue; 418 } 419 420 if (zfs_prop_user(propname) || 421 zfs_prop_get_type(prop) == PROP_TYPE_STRING) { 422 char *value; 423 verify(nvlist_lookup_string(propnv, 424 ZPROP_VALUE, &value) == 0); 425 VERIFY(0 == nvlist_add_string(nv, propname, value)); 426 } else { 427 uint64_t value; 428 verify(nvlist_lookup_uint64(propnv, 429 ZPROP_VALUE, &value) == 0); 430 VERIFY(0 == nvlist_add_uint64(nv, propname, value)); 431 } 432 } 433 } 434 435 /* 436 * returns snapshot creation txg 437 * and returns 0 if the snapshot does not exist 438 */ 439 static uint64_t 440 get_snap_txg(libzfs_handle_t *hdl, const char *fs, const char *snap) 441 { 442 char name[ZFS_MAX_DATASET_NAME_LEN]; 443 uint64_t txg = 0; 444 445 if (fs == NULL || fs[0] == '\0' || snap == NULL || snap[0] == '\0') 446 return (txg); 447 448 (void) snprintf(name, sizeof (name), "%s@%s", fs, snap); 449 if (zfs_dataset_exists(hdl, name, ZFS_TYPE_SNAPSHOT)) { 450 zfs_handle_t *zhp = zfs_open(hdl, name, ZFS_TYPE_SNAPSHOT); 451 if (zhp != NULL) { 452 txg = zfs_prop_get_int(zhp, ZFS_PROP_CREATETXG); 453 zfs_close(zhp); 454 } 455 } 456 457 return (txg); 458 } 459 460 /* 461 * recursively generate nvlists describing datasets. See comment 462 * for the data structure send_data_t above for description of contents 463 * of the nvlist. 464 */ 465 static int 466 send_iterate_fs(zfs_handle_t *zhp, void *arg) 467 { 468 send_data_t *sd = arg; 469 nvlist_t *nvfs = NULL, *nv = NULL; 470 int rv = 0; 471 uint64_t min_txg = 0, max_txg = 0; 472 uint64_t parent_fromsnap_guid_save = sd->parent_fromsnap_guid; 473 uint64_t fromsnap_txg_save = sd->fromsnap_txg; 474 uint64_t tosnap_txg_save = sd->tosnap_txg; 475 uint64_t txg = zhp->zfs_dmustats.dds_creation_txg; 476 uint64_t guid = zhp->zfs_dmustats.dds_guid; 477 uint64_t fromsnap_txg, tosnap_txg; 478 char guidstring[64]; 479 480 fromsnap_txg = get_snap_txg(zhp->zfs_hdl, zhp->zfs_name, sd->fromsnap); 481 if (fromsnap_txg != 0) 482 sd->fromsnap_txg = fromsnap_txg; 483 484 tosnap_txg = get_snap_txg(zhp->zfs_hdl, zhp->zfs_name, sd->tosnap); 485 if (tosnap_txg != 0) 486 sd->tosnap_txg = tosnap_txg; 487 488 /* 489 * on the send side, if the current dataset does not have tosnap, 490 * perform two additional checks: 491 * 492 * - skip sending the current dataset if it was created later than 493 * the parent tosnap 494 * - return error if the current dataset was created earlier than 495 * the parent tosnap 496 */ 497 if (sd->tosnap != NULL && tosnap_txg == 0) { 498 if (sd->tosnap_txg != 0 && txg > sd->tosnap_txg) { 499 if (sd->verbose) { 500 (void) fprintf(stderr, dgettext(TEXT_DOMAIN, 501 "skipping dataset %s: snapshot %s does " 502 "not exist\n"), zhp->zfs_name, sd->tosnap); 503 } 504 } else { 505 (void) fprintf(stderr, dgettext(TEXT_DOMAIN, 506 "cannot send %s@%s%s: snapshot %s@%s does not " 507 "exist\n"), sd->fsname, sd->tosnap, sd->recursive ? 508 dgettext(TEXT_DOMAIN, " recursively") : "", 509 zhp->zfs_name, sd->tosnap); 510 rv = EZFS_NOENT; 511 } 512 goto out; 513 } 514 515 nvfs = fnvlist_alloc(); 516 fnvlist_add_string(nvfs, "name", zhp->zfs_name); 517 fnvlist_add_uint64(nvfs, "parentfromsnap", 518 sd->parent_fromsnap_guid); 519 520 if (zhp->zfs_dmustats.dds_origin[0]) { 521 zfs_handle_t *origin = zfs_open(zhp->zfs_hdl, 522 zhp->zfs_dmustats.dds_origin, ZFS_TYPE_SNAPSHOT); 523 if (origin == NULL) { 524 rv = -1; 525 goto out; 526 } 527 fnvlist_add_uint64(nvfs, "origin", 528 origin->zfs_dmustats.dds_guid); 529 530 zfs_close(origin); 531 } 532 533 /* iterate over props */ 534 if (sd->props || sd->backup || sd->recursive) { 535 nv = fnvlist_alloc(); 536 send_iterate_prop(zhp, sd->backup, nv); 537 } 538 if (zfs_prop_get_int(zhp, ZFS_PROP_ENCRYPTION) != ZIO_CRYPT_OFF) { 539 boolean_t encroot; 540 541 /* determine if this dataset is an encryption root */ 542 if (zfs_crypto_get_encryption_root(zhp, &encroot, NULL) != 0) { 543 rv = -1; 544 goto out; 545 } 546 547 if (encroot) 548 fnvlist_add_boolean(nvfs, "is_encroot"); 549 550 /* 551 * Encrypted datasets can only be sent with properties if 552 * the raw flag is specified because the receive side doesn't 553 * currently have a mechanism for recursively asking the user 554 * for new encryption parameters. 555 */ 556 if (!sd->raw) { 557 (void) fprintf(stderr, dgettext(TEXT_DOMAIN, 558 "cannot send %s@%s: encrypted dataset %s may not " 559 "be sent with properties without the raw flag\n"), 560 sd->fsname, sd->tosnap, zhp->zfs_name); 561 rv = -1; 562 goto out; 563 } 564 565 } 566 567 if (nv != NULL) 568 fnvlist_add_nvlist(nvfs, "props", nv); 569 570 /* iterate over snaps, and set sd->parent_fromsnap_guid */ 571 sd->parent_fromsnap_guid = 0; 572 sd->parent_snaps = fnvlist_alloc(); 573 sd->snapprops = fnvlist_alloc(); 574 if (sd->holds) 575 VERIFY(0 == nvlist_alloc(&sd->snapholds, NV_UNIQUE_NAME, 0)); 576 577 578 /* 579 * If this is a "doall" send, a replicate send or we're just trying 580 * to gather a list of previous snapshots, iterate through all the 581 * snaps in the txg range. Otherwise just look at the one we're 582 * interested in. 583 */ 584 if (sd->doall || sd->replicate || sd->tosnap == NULL) { 585 if (!sd->replicate && fromsnap_txg != 0) 586 min_txg = fromsnap_txg; 587 if (!sd->replicate && tosnap_txg != 0) 588 max_txg = tosnap_txg; 589 (void) zfs_iter_snapshots_sorted(zhp, send_iterate_snap, sd, 590 min_txg, max_txg); 591 } else { 592 char snapname[MAXPATHLEN] = { 0 }; 593 zfs_handle_t *snap; 594 595 (void) snprintf(snapname, sizeof (snapname), "%s@%s", 596 zhp->zfs_name, sd->tosnap); 597 if (sd->fromsnap != NULL) 598 sd->seenfrom = B_TRUE; 599 snap = zfs_open(zhp->zfs_hdl, snapname, 600 ZFS_TYPE_SNAPSHOT); 601 if (snap != NULL) 602 (void) send_iterate_snap(snap, sd); 603 } 604 605 fnvlist_add_nvlist(nvfs, "snaps", sd->parent_snaps); 606 fnvlist_add_nvlist(nvfs, "snapprops", sd->snapprops); 607 if (sd->holds) 608 fnvlist_add_nvlist(nvfs, "snapholds", sd->snapholds); 609 fnvlist_free(sd->parent_snaps); 610 fnvlist_free(sd->snapprops); 611 fnvlist_free(sd->snapholds); 612 613 /* Do not allow the size of the properties list to exceed the limit */ 614 if ((fnvlist_size(nvfs) + fnvlist_size(sd->fss)) > 615 zhp->zfs_hdl->libzfs_max_nvlist) { 616 (void) fprintf(stderr, dgettext(TEXT_DOMAIN, 617 "warning: cannot send %s@%s: the size of the list of " 618 "snapshots and properties is too large to be received " 619 "successfully.\n" 620 "Select a smaller number of snapshots to send.\n"), 621 zhp->zfs_name, sd->tosnap); 622 rv = EZFS_NOSPC; 623 goto out; 624 } 625 /* add this fs to nvlist */ 626 (void) snprintf(guidstring, sizeof (guidstring), 627 "0x%llx", (longlong_t)guid); 628 fnvlist_add_nvlist(sd->fss, guidstring, nvfs); 629 630 /* iterate over children */ 631 if (sd->recursive) 632 rv = zfs_iter_filesystems(zhp, send_iterate_fs, sd); 633 634 out: 635 sd->parent_fromsnap_guid = parent_fromsnap_guid_save; 636 sd->fromsnap_txg = fromsnap_txg_save; 637 sd->tosnap_txg = tosnap_txg_save; 638 fnvlist_free(nv); 639 fnvlist_free(nvfs); 640 641 zfs_close(zhp); 642 return (rv); 643 } 644 645 static int 646 gather_nvlist(libzfs_handle_t *hdl, const char *fsname, const char *fromsnap, 647 const char *tosnap, boolean_t recursive, boolean_t raw, boolean_t doall, 648 boolean_t replicate, boolean_t verbose, boolean_t backup, boolean_t holds, 649 boolean_t props, nvlist_t **nvlp, avl_tree_t **avlp) 650 { 651 zfs_handle_t *zhp; 652 send_data_t sd = { 0 }; 653 int error; 654 655 zhp = zfs_open(hdl, fsname, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME); 656 if (zhp == NULL) 657 return (EZFS_BADTYPE); 658 659 VERIFY(0 == nvlist_alloc(&sd.fss, NV_UNIQUE_NAME, 0)); 660 sd.fsname = fsname; 661 sd.fromsnap = fromsnap; 662 sd.tosnap = tosnap; 663 sd.recursive = recursive; 664 sd.raw = raw; 665 sd.doall = doall; 666 sd.replicate = replicate; 667 sd.verbose = verbose; 668 sd.backup = backup; 669 sd.holds = holds; 670 sd.props = props; 671 672 if ((error = send_iterate_fs(zhp, &sd)) != 0) { 673 nvlist_free(sd.fss); 674 if (avlp != NULL) 675 *avlp = NULL; 676 *nvlp = NULL; 677 return (error); 678 } 679 680 if (avlp != NULL && (*avlp = fsavl_create(sd.fss)) == NULL) { 681 nvlist_free(sd.fss); 682 *nvlp = NULL; 683 return (EZFS_NOMEM); 684 } 685 686 *nvlp = sd.fss; 687 return (0); 688 } 689 690 /* 691 * Routines specific to "zfs send" 692 */ 693 typedef struct send_dump_data { 694 /* these are all just the short snapname (the part after the @) */ 695 const char *fromsnap; 696 const char *tosnap; 697 char prevsnap[ZFS_MAX_DATASET_NAME_LEN]; 698 uint64_t prevsnap_obj; 699 boolean_t seenfrom, seento, replicate, doall, fromorigin; 700 boolean_t dryrun, parsable, progress, embed_data, std_out; 701 boolean_t large_block, compress, raw, holds; 702 int outfd; 703 boolean_t err; 704 nvlist_t *fss; 705 nvlist_t *snapholds; 706 avl_tree_t *fsavl; 707 snapfilter_cb_t *filter_cb; 708 void *filter_cb_arg; 709 nvlist_t *debugnv; 710 char holdtag[ZFS_MAX_DATASET_NAME_LEN]; 711 int cleanup_fd; 712 int verbosity; 713 uint64_t size; 714 } send_dump_data_t; 715 716 static int 717 zfs_send_space(zfs_handle_t *zhp, const char *snapname, const char *from, 718 enum lzc_send_flags flags, uint64_t *spacep) 719 { 720 libzfs_handle_t *hdl = zhp->zfs_hdl; 721 int error; 722 723 assert(snapname != NULL); 724 error = lzc_send_space(snapname, from, flags, spacep); 725 726 if (error != 0) { 727 char errbuf[1024]; 728 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN, 729 "warning: cannot estimate space for '%s'"), snapname); 730 731 switch (error) { 732 case EXDEV: 733 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 734 "not an earlier snapshot from the same fs")); 735 return (zfs_error(hdl, EZFS_CROSSTARGET, errbuf)); 736 737 case ENOENT: 738 if (zfs_dataset_exists(hdl, snapname, 739 ZFS_TYPE_SNAPSHOT)) { 740 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 741 "incremental source (%s) does not exist"), 742 snapname); 743 } 744 return (zfs_error(hdl, EZFS_NOENT, errbuf)); 745 746 case EDQUOT: 747 case EFBIG: 748 case EIO: 749 case ENOLINK: 750 case ENOSPC: 751 case ENOSTR: 752 case ENXIO: 753 case EPIPE: 754 case ERANGE: 755 case EFAULT: 756 case EROFS: 757 case EINVAL: 758 zfs_error_aux(hdl, strerror(error)); 759 return (zfs_error(hdl, EZFS_BADBACKUP, errbuf)); 760 761 default: 762 return (zfs_standard_error(hdl, error, errbuf)); 763 } 764 } 765 766 return (0); 767 } 768 769 /* 770 * Dumps a backup of the given snapshot (incremental from fromsnap if it's not 771 * NULL) to the file descriptor specified by outfd. 772 */ 773 static int 774 dump_ioctl(zfs_handle_t *zhp, const char *fromsnap, uint64_t fromsnap_obj, 775 boolean_t fromorigin, int outfd, enum lzc_send_flags flags, 776 nvlist_t *debugnv) 777 { 778 zfs_cmd_t zc = {"\0"}; 779 libzfs_handle_t *hdl = zhp->zfs_hdl; 780 nvlist_t *thisdbg; 781 782 assert(zhp->zfs_type == ZFS_TYPE_SNAPSHOT); 783 assert(fromsnap_obj == 0 || !fromorigin); 784 785 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name)); 786 zc.zc_cookie = outfd; 787 zc.zc_obj = fromorigin; 788 zc.zc_sendobj = zfs_prop_get_int(zhp, ZFS_PROP_OBJSETID); 789 zc.zc_fromobj = fromsnap_obj; 790 zc.zc_flags = flags; 791 792 VERIFY(0 == nvlist_alloc(&thisdbg, NV_UNIQUE_NAME, 0)); 793 if (fromsnap && fromsnap[0] != '\0') { 794 VERIFY(0 == nvlist_add_string(thisdbg, 795 "fromsnap", fromsnap)); 796 } 797 798 if (zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_SEND, &zc) != 0) { 799 char errbuf[1024]; 800 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN, 801 "warning: cannot send '%s'"), zhp->zfs_name); 802 803 VERIFY(0 == nvlist_add_uint64(thisdbg, "error", errno)); 804 if (debugnv) { 805 VERIFY(0 == nvlist_add_nvlist(debugnv, 806 zhp->zfs_name, thisdbg)); 807 } 808 nvlist_free(thisdbg); 809 810 switch (errno) { 811 case EXDEV: 812 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 813 "not an earlier snapshot from the same fs")); 814 return (zfs_error(hdl, EZFS_CROSSTARGET, errbuf)); 815 816 case EACCES: 817 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 818 "source key must be loaded")); 819 return (zfs_error(hdl, EZFS_CRYPTOFAILED, errbuf)); 820 821 case ENOENT: 822 if (zfs_dataset_exists(hdl, zc.zc_name, 823 ZFS_TYPE_SNAPSHOT)) { 824 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 825 "incremental source (@%s) does not exist"), 826 zc.zc_value); 827 } 828 return (zfs_error(hdl, EZFS_NOENT, errbuf)); 829 830 case EDQUOT: 831 case EFBIG: 832 case EIO: 833 case ENOLINK: 834 case ENOSPC: 835 case ENOSTR: 836 case ENXIO: 837 case EPIPE: 838 case ERANGE: 839 case EFAULT: 840 case EROFS: 841 zfs_error_aux(hdl, strerror(errno)); 842 return (zfs_error(hdl, EZFS_BADBACKUP, errbuf)); 843 844 default: 845 return (zfs_standard_error(hdl, errno, errbuf)); 846 } 847 } 848 849 if (debugnv) 850 VERIFY(0 == nvlist_add_nvlist(debugnv, zhp->zfs_name, thisdbg)); 851 nvlist_free(thisdbg); 852 853 return (0); 854 } 855 856 static void 857 gather_holds(zfs_handle_t *zhp, send_dump_data_t *sdd) 858 { 859 assert(zhp->zfs_type == ZFS_TYPE_SNAPSHOT); 860 861 /* 862 * zfs_send() only sets snapholds for sends that need them, 863 * e.g. replication and doall. 864 */ 865 if (sdd->snapholds == NULL) 866 return; 867 868 fnvlist_add_string(sdd->snapholds, zhp->zfs_name, sdd->holdtag); 869 } 870 871 int 872 zfs_send_progress(zfs_handle_t *zhp, int fd, uint64_t *bytes_written, 873 uint64_t *blocks_visited) 874 { 875 zfs_cmd_t zc = {"\0"}; 876 877 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name)); 878 zc.zc_cookie = fd; 879 if (zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_SEND_PROGRESS, &zc) != 0) 880 return (errno); 881 if (bytes_written != NULL) 882 *bytes_written = zc.zc_cookie; 883 if (blocks_visited != NULL) 884 *blocks_visited = zc.zc_objset_type; 885 return (0); 886 } 887 888 static void * 889 send_progress_thread(void *arg) 890 { 891 progress_arg_t *pa = arg; 892 zfs_handle_t *zhp = pa->pa_zhp; 893 uint64_t bytes; 894 uint64_t blocks; 895 char buf[16]; 896 time_t t; 897 struct tm *tm; 898 boolean_t firstloop = B_TRUE; 899 900 /* 901 * Print the progress from ZFS_IOC_SEND_PROGRESS every second. 902 */ 903 for (;;) { 904 int err; 905 (void) sleep(1); 906 if ((err = zfs_send_progress(zhp, pa->pa_fd, &bytes, 907 &blocks)) != 0) { 908 if (err == EINTR || err == ENOENT) 909 return ((void *)0); 910 return ((void *)(uintptr_t)err); 911 } 912 913 if (firstloop && !pa->pa_parsable) { 914 (void) fprintf(stderr, 915 "TIME %s %sSNAPSHOT %s\n", 916 pa->pa_estimate ? "BYTES" : " SENT", 917 pa->pa_verbosity >= 2 ? " BLOCKS " : "", 918 zhp->zfs_name); 919 firstloop = B_FALSE; 920 } 921 922 (void) time(&t); 923 tm = localtime(&t); 924 925 if (pa->pa_verbosity >= 2 && pa->pa_parsable) { 926 (void) fprintf(stderr, 927 "%02d:%02d:%02d\t%llu\t%llu\t%s\n", 928 tm->tm_hour, tm->tm_min, tm->tm_sec, 929 (u_longlong_t)bytes, (u_longlong_t)blocks, 930 zhp->zfs_name); 931 } else if (pa->pa_verbosity >= 2) { 932 zfs_nicenum(bytes, buf, sizeof (buf)); 933 (void) fprintf(stderr, 934 "%02d:%02d:%02d %5s %8llu %s\n", 935 tm->tm_hour, tm->tm_min, tm->tm_sec, 936 buf, (u_longlong_t)blocks, zhp->zfs_name); 937 } else if (pa->pa_parsable) { 938 (void) fprintf(stderr, "%02d:%02d:%02d\t%llu\t%s\n", 939 tm->tm_hour, tm->tm_min, tm->tm_sec, 940 (u_longlong_t)bytes, zhp->zfs_name); 941 } else { 942 zfs_nicebytes(bytes, buf, sizeof (buf)); 943 (void) fprintf(stderr, "%02d:%02d:%02d %5s %s\n", 944 tm->tm_hour, tm->tm_min, tm->tm_sec, 945 buf, zhp->zfs_name); 946 } 947 } 948 } 949 950 static void 951 send_print_verbose(FILE *fout, const char *tosnap, const char *fromsnap, 952 uint64_t size, boolean_t parsable) 953 { 954 if (parsable) { 955 if (fromsnap != NULL) { 956 (void) fprintf(fout, "incremental\t%s\t%s", 957 fromsnap, tosnap); 958 } else { 959 (void) fprintf(fout, "full\t%s", 960 tosnap); 961 } 962 } else { 963 if (fromsnap != NULL) { 964 if (strchr(fromsnap, '@') == NULL && 965 strchr(fromsnap, '#') == NULL) { 966 (void) fprintf(fout, dgettext(TEXT_DOMAIN, 967 "send from @%s to %s"), 968 fromsnap, tosnap); 969 } else { 970 (void) fprintf(fout, dgettext(TEXT_DOMAIN, 971 "send from %s to %s"), 972 fromsnap, tosnap); 973 } 974 } else { 975 (void) fprintf(fout, dgettext(TEXT_DOMAIN, 976 "full send of %s"), 977 tosnap); 978 } 979 } 980 981 if (parsable) { 982 (void) fprintf(fout, "\t%llu", 983 (longlong_t)size); 984 } else if (size != 0) { 985 char buf[16]; 986 zfs_nicebytes(size, buf, sizeof (buf)); 987 (void) fprintf(fout, dgettext(TEXT_DOMAIN, 988 " estimated size is %s"), buf); 989 } 990 (void) fprintf(fout, "\n"); 991 } 992 993 static int 994 dump_snapshot(zfs_handle_t *zhp, void *arg) 995 { 996 send_dump_data_t *sdd = arg; 997 progress_arg_t pa = { 0 }; 998 pthread_t tid; 999 char *thissnap; 1000 enum lzc_send_flags flags = 0; 1001 int err; 1002 boolean_t isfromsnap, istosnap, fromorigin; 1003 boolean_t exclude = B_FALSE; 1004 FILE *fout = sdd->std_out ? stdout : stderr; 1005 1006 err = 0; 1007 thissnap = strchr(zhp->zfs_name, '@') + 1; 1008 isfromsnap = (sdd->fromsnap != NULL && 1009 strcmp(sdd->fromsnap, thissnap) == 0); 1010 1011 if (!sdd->seenfrom && isfromsnap) { 1012 gather_holds(zhp, sdd); 1013 sdd->seenfrom = B_TRUE; 1014 (void) strlcpy(sdd->prevsnap, thissnap, 1015 sizeof (sdd->prevsnap)); 1016 sdd->prevsnap_obj = zfs_prop_get_int(zhp, ZFS_PROP_OBJSETID); 1017 zfs_close(zhp); 1018 return (0); 1019 } 1020 1021 if (sdd->seento || !sdd->seenfrom) { 1022 zfs_close(zhp); 1023 return (0); 1024 } 1025 1026 istosnap = (strcmp(sdd->tosnap, thissnap) == 0); 1027 if (istosnap) 1028 sdd->seento = B_TRUE; 1029 1030 if (sdd->large_block) 1031 flags |= LZC_SEND_FLAG_LARGE_BLOCK; 1032 if (sdd->embed_data) 1033 flags |= LZC_SEND_FLAG_EMBED_DATA; 1034 if (sdd->compress) 1035 flags |= LZC_SEND_FLAG_COMPRESS; 1036 if (sdd->raw) 1037 flags |= LZC_SEND_FLAG_RAW; 1038 1039 if (!sdd->doall && !isfromsnap && !istosnap) { 1040 if (sdd->replicate) { 1041 char *snapname; 1042 nvlist_t *snapprops; 1043 /* 1044 * Filter out all intermediate snapshots except origin 1045 * snapshots needed to replicate clones. 1046 */ 1047 nvlist_t *nvfs = fsavl_find(sdd->fsavl, 1048 zhp->zfs_dmustats.dds_guid, &snapname); 1049 1050 VERIFY(0 == nvlist_lookup_nvlist(nvfs, 1051 "snapprops", &snapprops)); 1052 VERIFY(0 == nvlist_lookup_nvlist(snapprops, 1053 thissnap, &snapprops)); 1054 exclude = !nvlist_exists(snapprops, "is_clone_origin"); 1055 } else { 1056 exclude = B_TRUE; 1057 } 1058 } 1059 1060 /* 1061 * If a filter function exists, call it to determine whether 1062 * this snapshot will be sent. 1063 */ 1064 if (exclude || (sdd->filter_cb != NULL && 1065 sdd->filter_cb(zhp, sdd->filter_cb_arg) == B_FALSE)) { 1066 /* 1067 * This snapshot is filtered out. Don't send it, and don't 1068 * set prevsnap_obj, so it will be as if this snapshot didn't 1069 * exist, and the next accepted snapshot will be sent as 1070 * an incremental from the last accepted one, or as the 1071 * first (and full) snapshot in the case of a replication, 1072 * non-incremental send. 1073 */ 1074 zfs_close(zhp); 1075 return (0); 1076 } 1077 1078 gather_holds(zhp, sdd); 1079 fromorigin = sdd->prevsnap[0] == '\0' && 1080 (sdd->fromorigin || sdd->replicate); 1081 1082 if (sdd->verbosity != 0) { 1083 uint64_t size = 0; 1084 char fromds[ZFS_MAX_DATASET_NAME_LEN]; 1085 1086 if (sdd->prevsnap[0] != '\0') { 1087 (void) strlcpy(fromds, zhp->zfs_name, sizeof (fromds)); 1088 *(strchr(fromds, '@') + 1) = '\0'; 1089 (void) strlcat(fromds, sdd->prevsnap, sizeof (fromds)); 1090 } 1091 if (zfs_send_space(zhp, zhp->zfs_name, 1092 sdd->prevsnap[0] ? fromds : NULL, flags, &size) != 0) { 1093 size = 0; /* cannot estimate send space */ 1094 } else { 1095 send_print_verbose(fout, zhp->zfs_name, 1096 sdd->prevsnap[0] ? sdd->prevsnap : NULL, 1097 size, sdd->parsable); 1098 } 1099 sdd->size += size; 1100 } 1101 1102 if (!sdd->dryrun) { 1103 /* 1104 * If progress reporting is requested, spawn a new thread to 1105 * poll ZFS_IOC_SEND_PROGRESS at a regular interval. 1106 */ 1107 if (sdd->progress) { 1108 pa.pa_zhp = zhp; 1109 pa.pa_fd = sdd->outfd; 1110 pa.pa_parsable = sdd->parsable; 1111 pa.pa_estimate = B_FALSE; 1112 pa.pa_verbosity = sdd->verbosity; 1113 1114 if ((err = pthread_create(&tid, NULL, 1115 send_progress_thread, &pa)) != 0) { 1116 zfs_close(zhp); 1117 return (err); 1118 } 1119 } 1120 1121 err = dump_ioctl(zhp, sdd->prevsnap, sdd->prevsnap_obj, 1122 fromorigin, sdd->outfd, flags, sdd->debugnv); 1123 1124 if (sdd->progress) { 1125 void *status = NULL; 1126 (void) pthread_cancel(tid); 1127 (void) pthread_join(tid, &status); 1128 int error = (int)(uintptr_t)status; 1129 if (error != 0 && status != PTHREAD_CANCELED) { 1130 char errbuf[1024]; 1131 (void) snprintf(errbuf, sizeof (errbuf), 1132 dgettext(TEXT_DOMAIN, 1133 "progress thread exited nonzero")); 1134 return (zfs_standard_error(zhp->zfs_hdl, error, 1135 errbuf)); 1136 } 1137 } 1138 } 1139 1140 (void) strcpy(sdd->prevsnap, thissnap); 1141 sdd->prevsnap_obj = zfs_prop_get_int(zhp, ZFS_PROP_OBJSETID); 1142 zfs_close(zhp); 1143 return (err); 1144 } 1145 1146 static int 1147 dump_filesystem(zfs_handle_t *zhp, void *arg) 1148 { 1149 int rv = 0; 1150 send_dump_data_t *sdd = arg; 1151 boolean_t missingfrom = B_FALSE; 1152 zfs_cmd_t zc = {"\0"}; 1153 uint64_t min_txg = 0, max_txg = 0; 1154 1155 (void) snprintf(zc.zc_name, sizeof (zc.zc_name), "%s@%s", 1156 zhp->zfs_name, sdd->tosnap); 1157 if (zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_OBJSET_STATS, &zc) != 0) { 1158 (void) fprintf(stderr, dgettext(TEXT_DOMAIN, 1159 "WARNING: could not send %s@%s: does not exist\n"), 1160 zhp->zfs_name, sdd->tosnap); 1161 sdd->err = B_TRUE; 1162 return (0); 1163 } 1164 1165 if (sdd->replicate && sdd->fromsnap) { 1166 /* 1167 * If this fs does not have fromsnap, and we're doing 1168 * recursive, we need to send a full stream from the 1169 * beginning (or an incremental from the origin if this 1170 * is a clone). If we're doing non-recursive, then let 1171 * them get the error. 1172 */ 1173 (void) snprintf(zc.zc_name, sizeof (zc.zc_name), "%s@%s", 1174 zhp->zfs_name, sdd->fromsnap); 1175 if (zfs_ioctl(zhp->zfs_hdl, 1176 ZFS_IOC_OBJSET_STATS, &zc) != 0) { 1177 missingfrom = B_TRUE; 1178 } 1179 } 1180 1181 sdd->seenfrom = sdd->seento = sdd->prevsnap[0] = 0; 1182 sdd->prevsnap_obj = 0; 1183 if (sdd->fromsnap == NULL || missingfrom) 1184 sdd->seenfrom = B_TRUE; 1185 1186 1187 1188 /* 1189 * Iterate through all snapshots and process the ones we will be 1190 * sending. If we only have a "from" and "to" snapshot to deal 1191 * with, we can avoid iterating through all the other snapshots. 1192 */ 1193 if (sdd->doall || sdd->replicate || sdd->tosnap == NULL) { 1194 if (!sdd->replicate && sdd->fromsnap != NULL) 1195 min_txg = get_snap_txg(zhp->zfs_hdl, zhp->zfs_name, 1196 sdd->fromsnap); 1197 if (!sdd->replicate && sdd->tosnap != NULL) 1198 max_txg = get_snap_txg(zhp->zfs_hdl, zhp->zfs_name, 1199 sdd->tosnap); 1200 rv = zfs_iter_snapshots_sorted(zhp, dump_snapshot, arg, 1201 min_txg, max_txg); 1202 } else { 1203 char snapname[MAXPATHLEN] = { 0 }; 1204 zfs_handle_t *snap; 1205 1206 if (!sdd->seenfrom) { 1207 (void) snprintf(snapname, sizeof (snapname), 1208 "%s@%s", zhp->zfs_name, sdd->fromsnap); 1209 snap = zfs_open(zhp->zfs_hdl, snapname, 1210 ZFS_TYPE_SNAPSHOT); 1211 if (snap != NULL) 1212 rv = dump_snapshot(snap, sdd); 1213 else 1214 rv = -1; 1215 } 1216 1217 if (rv == 0) { 1218 (void) snprintf(snapname, sizeof (snapname), 1219 "%s@%s", zhp->zfs_name, sdd->tosnap); 1220 snap = zfs_open(zhp->zfs_hdl, snapname, 1221 ZFS_TYPE_SNAPSHOT); 1222 if (snap != NULL) 1223 rv = dump_snapshot(snap, sdd); 1224 else 1225 rv = -1; 1226 } 1227 } 1228 1229 if (!sdd->seenfrom) { 1230 (void) fprintf(stderr, dgettext(TEXT_DOMAIN, 1231 "WARNING: could not send %s@%s:\n" 1232 "incremental source (%s@%s) does not exist\n"), 1233 zhp->zfs_name, sdd->tosnap, 1234 zhp->zfs_name, sdd->fromsnap); 1235 sdd->err = B_TRUE; 1236 } else if (!sdd->seento) { 1237 if (sdd->fromsnap) { 1238 (void) fprintf(stderr, dgettext(TEXT_DOMAIN, 1239 "WARNING: could not send %s@%s:\n" 1240 "incremental source (%s@%s) " 1241 "is not earlier than it\n"), 1242 zhp->zfs_name, sdd->tosnap, 1243 zhp->zfs_name, sdd->fromsnap); 1244 } else { 1245 (void) fprintf(stderr, dgettext(TEXT_DOMAIN, 1246 "WARNING: " 1247 "could not send %s@%s: does not exist\n"), 1248 zhp->zfs_name, sdd->tosnap); 1249 } 1250 sdd->err = B_TRUE; 1251 } 1252 1253 return (rv); 1254 } 1255 1256 static int 1257 dump_filesystems(zfs_handle_t *rzhp, void *arg) 1258 { 1259 send_dump_data_t *sdd = arg; 1260 nvpair_t *fspair; 1261 boolean_t needagain, progress; 1262 1263 if (!sdd->replicate) 1264 return (dump_filesystem(rzhp, sdd)); 1265 1266 /* Mark the clone origin snapshots. */ 1267 for (fspair = nvlist_next_nvpair(sdd->fss, NULL); fspair; 1268 fspair = nvlist_next_nvpair(sdd->fss, fspair)) { 1269 nvlist_t *nvfs; 1270 uint64_t origin_guid = 0; 1271 1272 VERIFY(0 == nvpair_value_nvlist(fspair, &nvfs)); 1273 (void) nvlist_lookup_uint64(nvfs, "origin", &origin_guid); 1274 if (origin_guid != 0) { 1275 char *snapname; 1276 nvlist_t *origin_nv = fsavl_find(sdd->fsavl, 1277 origin_guid, &snapname); 1278 if (origin_nv != NULL) { 1279 nvlist_t *snapprops; 1280 VERIFY(0 == nvlist_lookup_nvlist(origin_nv, 1281 "snapprops", &snapprops)); 1282 VERIFY(0 == nvlist_lookup_nvlist(snapprops, 1283 snapname, &snapprops)); 1284 VERIFY(0 == nvlist_add_boolean( 1285 snapprops, "is_clone_origin")); 1286 } 1287 } 1288 } 1289 again: 1290 needagain = progress = B_FALSE; 1291 for (fspair = nvlist_next_nvpair(sdd->fss, NULL); fspair; 1292 fspair = nvlist_next_nvpair(sdd->fss, fspair)) { 1293 nvlist_t *fslist, *parent_nv; 1294 char *fsname; 1295 zfs_handle_t *zhp; 1296 int err; 1297 uint64_t origin_guid = 0; 1298 uint64_t parent_guid = 0; 1299 1300 VERIFY(nvpair_value_nvlist(fspair, &fslist) == 0); 1301 if (nvlist_lookup_boolean(fslist, "sent") == 0) 1302 continue; 1303 1304 VERIFY(nvlist_lookup_string(fslist, "name", &fsname) == 0); 1305 (void) nvlist_lookup_uint64(fslist, "origin", &origin_guid); 1306 (void) nvlist_lookup_uint64(fslist, "parentfromsnap", 1307 &parent_guid); 1308 1309 if (parent_guid != 0) { 1310 parent_nv = fsavl_find(sdd->fsavl, parent_guid, NULL); 1311 if (!nvlist_exists(parent_nv, "sent")) { 1312 /* parent has not been sent; skip this one */ 1313 needagain = B_TRUE; 1314 continue; 1315 } 1316 } 1317 1318 if (origin_guid != 0) { 1319 nvlist_t *origin_nv = fsavl_find(sdd->fsavl, 1320 origin_guid, NULL); 1321 if (origin_nv != NULL && 1322 !nvlist_exists(origin_nv, "sent")) { 1323 /* 1324 * origin has not been sent yet; 1325 * skip this clone. 1326 */ 1327 needagain = B_TRUE; 1328 continue; 1329 } 1330 } 1331 1332 zhp = zfs_open(rzhp->zfs_hdl, fsname, ZFS_TYPE_DATASET); 1333 if (zhp == NULL) 1334 return (-1); 1335 err = dump_filesystem(zhp, sdd); 1336 VERIFY(nvlist_add_boolean(fslist, "sent") == 0); 1337 progress = B_TRUE; 1338 zfs_close(zhp); 1339 if (err) 1340 return (err); 1341 } 1342 if (needagain) { 1343 assert(progress); 1344 goto again; 1345 } 1346 1347 /* clean out the sent flags in case we reuse this fss */ 1348 for (fspair = nvlist_next_nvpair(sdd->fss, NULL); fspair; 1349 fspair = nvlist_next_nvpair(sdd->fss, fspair)) { 1350 nvlist_t *fslist; 1351 1352 VERIFY(nvpair_value_nvlist(fspair, &fslist) == 0); 1353 (void) nvlist_remove_all(fslist, "sent"); 1354 } 1355 1356 return (0); 1357 } 1358 1359 nvlist_t * 1360 zfs_send_resume_token_to_nvlist(libzfs_handle_t *hdl, const char *token) 1361 { 1362 unsigned int version; 1363 int nread, i; 1364 unsigned long long checksum, packed_len; 1365 1366 /* 1367 * Decode token header, which is: 1368 * <token version>-<checksum of payload>-<uncompressed payload length> 1369 * Note that the only supported token version is 1. 1370 */ 1371 nread = sscanf(token, "%u-%llx-%llx-", 1372 &version, &checksum, &packed_len); 1373 if (nread != 3) { 1374 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1375 "resume token is corrupt (invalid format)")); 1376 return (NULL); 1377 } 1378 1379 if (version != ZFS_SEND_RESUME_TOKEN_VERSION) { 1380 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1381 "resume token is corrupt (invalid version %u)"), 1382 version); 1383 return (NULL); 1384 } 1385 1386 /* convert hexadecimal representation to binary */ 1387 token = strrchr(token, '-') + 1; 1388 int len = strlen(token) / 2; 1389 unsigned char *compressed = zfs_alloc(hdl, len); 1390 for (i = 0; i < len; i++) { 1391 nread = sscanf(token + i * 2, "%2hhx", compressed + i); 1392 if (nread != 1) { 1393 free(compressed); 1394 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1395 "resume token is corrupt " 1396 "(payload is not hex-encoded)")); 1397 return (NULL); 1398 } 1399 } 1400 1401 /* verify checksum */ 1402 zio_cksum_t cksum; 1403 fletcher_4_native_varsize(compressed, len, &cksum); 1404 if (cksum.zc_word[0] != checksum) { 1405 free(compressed); 1406 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1407 "resume token is corrupt (incorrect checksum)")); 1408 return (NULL); 1409 } 1410 1411 /* uncompress */ 1412 void *packed = zfs_alloc(hdl, packed_len); 1413 uLongf packed_len_long = packed_len; 1414 if (uncompress(packed, &packed_len_long, compressed, len) != Z_OK || 1415 packed_len_long != packed_len) { 1416 free(packed); 1417 free(compressed); 1418 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1419 "resume token is corrupt (decompression failed)")); 1420 return (NULL); 1421 } 1422 1423 /* unpack nvlist */ 1424 nvlist_t *nv; 1425 int error = nvlist_unpack(packed, packed_len, &nv, KM_SLEEP); 1426 free(packed); 1427 free(compressed); 1428 if (error != 0) { 1429 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1430 "resume token is corrupt (nvlist_unpack failed)")); 1431 return (NULL); 1432 } 1433 return (nv); 1434 } 1435 static enum lzc_send_flags 1436 lzc_flags_from_sendflags(const sendflags_t *flags) 1437 { 1438 enum lzc_send_flags lzc_flags = 0; 1439 if (flags->largeblock) 1440 lzc_flags |= LZC_SEND_FLAG_LARGE_BLOCK; 1441 if (flags->embed_data) 1442 lzc_flags |= LZC_SEND_FLAG_EMBED_DATA; 1443 if (flags->compress) 1444 lzc_flags |= LZC_SEND_FLAG_COMPRESS; 1445 if (flags->raw) 1446 lzc_flags |= LZC_SEND_FLAG_RAW; 1447 if (flags->saved) 1448 lzc_flags |= LZC_SEND_FLAG_SAVED; 1449 return (lzc_flags); 1450 } 1451 1452 static int 1453 estimate_size(zfs_handle_t *zhp, const char *from, int fd, sendflags_t *flags, 1454 uint64_t resumeobj, uint64_t resumeoff, uint64_t bytes, 1455 const char *redactbook, char *errbuf) 1456 { 1457 uint64_t size; 1458 FILE *fout = flags->dryrun ? stdout : stderr; 1459 progress_arg_t pa = { 0 }; 1460 int err = 0; 1461 pthread_t ptid; 1462 1463 if (flags->progress) { 1464 pa.pa_zhp = zhp; 1465 pa.pa_fd = fd; 1466 pa.pa_parsable = flags->parsable; 1467 pa.pa_estimate = B_TRUE; 1468 pa.pa_verbosity = flags->verbosity; 1469 1470 err = pthread_create(&ptid, NULL, 1471 send_progress_thread, &pa); 1472 if (err != 0) { 1473 zfs_error_aux(zhp->zfs_hdl, strerror(errno)); 1474 return (zfs_error(zhp->zfs_hdl, 1475 EZFS_THREADCREATEFAILED, errbuf)); 1476 } 1477 } 1478 1479 err = lzc_send_space_resume_redacted(zhp->zfs_name, from, 1480 lzc_flags_from_sendflags(flags), resumeobj, resumeoff, bytes, 1481 redactbook, fd, &size); 1482 1483 if (flags->progress) { 1484 void *status = NULL; 1485 (void) pthread_cancel(ptid); 1486 (void) pthread_join(ptid, &status); 1487 int error = (int)(uintptr_t)status; 1488 if (error != 0 && status != PTHREAD_CANCELED) { 1489 char errbuf[1024]; 1490 (void) snprintf(errbuf, sizeof (errbuf), 1491 dgettext(TEXT_DOMAIN, "progress thread exited " 1492 "nonzero")); 1493 return (zfs_standard_error(zhp->zfs_hdl, error, 1494 errbuf)); 1495 } 1496 } 1497 1498 if (err != 0) { 1499 zfs_error_aux(zhp->zfs_hdl, strerror(err)); 1500 return (zfs_error(zhp->zfs_hdl, EZFS_BADBACKUP, 1501 errbuf)); 1502 } 1503 send_print_verbose(fout, zhp->zfs_name, from, size, 1504 flags->parsable); 1505 1506 if (flags->parsable) { 1507 (void) fprintf(fout, "size\t%llu\n", (longlong_t)size); 1508 } else { 1509 char buf[16]; 1510 zfs_nicenum(size, buf, sizeof (buf)); 1511 (void) fprintf(fout, dgettext(TEXT_DOMAIN, 1512 "total estimated size is %s\n"), buf); 1513 } 1514 return (0); 1515 } 1516 1517 static boolean_t 1518 redact_snaps_contains(const uint64_t *snaps, uint64_t num_snaps, uint64_t guid) 1519 { 1520 for (int i = 0; i < num_snaps; i++) { 1521 if (snaps[i] == guid) 1522 return (B_TRUE); 1523 } 1524 return (B_FALSE); 1525 } 1526 1527 static boolean_t 1528 redact_snaps_equal(const uint64_t *snaps1, uint64_t num_snaps1, 1529 const uint64_t *snaps2, uint64_t num_snaps2) 1530 { 1531 if (num_snaps1 != num_snaps2) 1532 return (B_FALSE); 1533 for (int i = 0; i < num_snaps1; i++) { 1534 if (!redact_snaps_contains(snaps2, num_snaps2, snaps1[i])) 1535 return (B_FALSE); 1536 } 1537 return (B_TRUE); 1538 } 1539 1540 /* 1541 * Check that the list of redaction snapshots in the bookmark matches the send 1542 * we're resuming, and return whether or not it's complete. 1543 * 1544 * Note that the caller needs to free the contents of *bookname with free() if 1545 * this function returns successfully. 1546 */ 1547 static int 1548 find_redact_book(libzfs_handle_t *hdl, const char *path, 1549 const uint64_t *redact_snap_guids, int num_redact_snaps, 1550 char **bookname) 1551 { 1552 char errbuf[1024]; 1553 int error = 0; 1554 nvlist_t *props = fnvlist_alloc(); 1555 nvlist_t *bmarks; 1556 1557 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN, 1558 "cannot resume send")); 1559 1560 fnvlist_add_boolean(props, "redact_complete"); 1561 fnvlist_add_boolean(props, zfs_prop_to_name(ZFS_PROP_REDACT_SNAPS)); 1562 error = lzc_get_bookmarks(path, props, &bmarks); 1563 nvlist_free(props); 1564 if (error != 0) { 1565 if (error == ESRCH) { 1566 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1567 "nonexistent redaction bookmark provided")); 1568 } else if (error == ENOENT) { 1569 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1570 "dataset to be sent no longer exists")); 1571 } else { 1572 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1573 "unknown error: %s"), strerror(error)); 1574 } 1575 return (zfs_error(hdl, EZFS_BADPROP, errbuf)); 1576 } 1577 nvpair_t *pair; 1578 for (pair = nvlist_next_nvpair(bmarks, NULL); pair; 1579 pair = nvlist_next_nvpair(bmarks, pair)) { 1580 1581 nvlist_t *bmark = fnvpair_value_nvlist(pair); 1582 nvlist_t *vallist = fnvlist_lookup_nvlist(bmark, 1583 zfs_prop_to_name(ZFS_PROP_REDACT_SNAPS)); 1584 uint_t len = 0; 1585 uint64_t *bmarksnaps = fnvlist_lookup_uint64_array(vallist, 1586 ZPROP_VALUE, &len); 1587 if (redact_snaps_equal(redact_snap_guids, 1588 num_redact_snaps, bmarksnaps, len)) { 1589 break; 1590 } 1591 } 1592 if (pair == NULL) { 1593 fnvlist_free(bmarks); 1594 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1595 "no appropriate redaction bookmark exists")); 1596 return (zfs_error(hdl, EZFS_BADPROP, errbuf)); 1597 } 1598 char *name = nvpair_name(pair); 1599 nvlist_t *bmark = fnvpair_value_nvlist(pair); 1600 nvlist_t *vallist = fnvlist_lookup_nvlist(bmark, "redact_complete"); 1601 boolean_t complete = fnvlist_lookup_boolean_value(vallist, 1602 ZPROP_VALUE); 1603 if (!complete) { 1604 fnvlist_free(bmarks); 1605 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1606 "incomplete redaction bookmark provided")); 1607 return (zfs_error(hdl, EZFS_BADPROP, errbuf)); 1608 } 1609 *bookname = strndup(name, ZFS_MAX_DATASET_NAME_LEN); 1610 ASSERT3P(*bookname, !=, NULL); 1611 fnvlist_free(bmarks); 1612 return (0); 1613 } 1614 1615 static int 1616 zfs_send_resume_impl(libzfs_handle_t *hdl, sendflags_t *flags, int outfd, 1617 nvlist_t *resume_nvl) 1618 { 1619 char errbuf[1024]; 1620 char *toname; 1621 char *fromname = NULL; 1622 uint64_t resumeobj, resumeoff, toguid, fromguid, bytes; 1623 zfs_handle_t *zhp; 1624 int error = 0; 1625 char name[ZFS_MAX_DATASET_NAME_LEN]; 1626 enum lzc_send_flags lzc_flags = 0; 1627 FILE *fout = (flags->verbosity > 0 && flags->dryrun) ? stdout : stderr; 1628 uint64_t *redact_snap_guids = NULL; 1629 int num_redact_snaps = 0; 1630 char *redact_book = NULL; 1631 1632 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN, 1633 "cannot resume send")); 1634 1635 if (flags->verbosity != 0) { 1636 (void) fprintf(fout, dgettext(TEXT_DOMAIN, 1637 "resume token contents:\n")); 1638 nvlist_print(fout, resume_nvl); 1639 } 1640 1641 if (nvlist_lookup_string(resume_nvl, "toname", &toname) != 0 || 1642 nvlist_lookup_uint64(resume_nvl, "object", &resumeobj) != 0 || 1643 nvlist_lookup_uint64(resume_nvl, "offset", &resumeoff) != 0 || 1644 nvlist_lookup_uint64(resume_nvl, "bytes", &bytes) != 0 || 1645 nvlist_lookup_uint64(resume_nvl, "toguid", &toguid) != 0) { 1646 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1647 "resume token is corrupt")); 1648 return (zfs_error(hdl, EZFS_FAULT, errbuf)); 1649 } 1650 fromguid = 0; 1651 (void) nvlist_lookup_uint64(resume_nvl, "fromguid", &fromguid); 1652 1653 if (flags->largeblock || nvlist_exists(resume_nvl, "largeblockok")) 1654 lzc_flags |= LZC_SEND_FLAG_LARGE_BLOCK; 1655 if (flags->embed_data || nvlist_exists(resume_nvl, "embedok")) 1656 lzc_flags |= LZC_SEND_FLAG_EMBED_DATA; 1657 if (flags->compress || nvlist_exists(resume_nvl, "compressok")) 1658 lzc_flags |= LZC_SEND_FLAG_COMPRESS; 1659 if (flags->raw || nvlist_exists(resume_nvl, "rawok")) 1660 lzc_flags |= LZC_SEND_FLAG_RAW; 1661 if (flags->saved || nvlist_exists(resume_nvl, "savedok")) 1662 lzc_flags |= LZC_SEND_FLAG_SAVED; 1663 1664 if (flags->saved) { 1665 (void) strcpy(name, toname); 1666 } else { 1667 error = guid_to_name(hdl, toname, toguid, B_FALSE, name); 1668 if (error != 0) { 1669 if (zfs_dataset_exists(hdl, toname, ZFS_TYPE_DATASET)) { 1670 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1671 "'%s' is no longer the same snapshot " 1672 "used in the initial send"), toname); 1673 } else { 1674 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1675 "'%s' used in the initial send no " 1676 "longer exists"), toname); 1677 } 1678 return (zfs_error(hdl, EZFS_BADPATH, errbuf)); 1679 } 1680 } 1681 1682 zhp = zfs_open(hdl, name, ZFS_TYPE_DATASET); 1683 if (zhp == NULL) { 1684 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1685 "unable to access '%s'"), name); 1686 return (zfs_error(hdl, EZFS_BADPATH, errbuf)); 1687 } 1688 1689 if (nvlist_lookup_uint64_array(resume_nvl, "book_redact_snaps", 1690 &redact_snap_guids, (uint_t *)&num_redact_snaps) != 0) { 1691 num_redact_snaps = -1; 1692 } 1693 1694 if (fromguid != 0) { 1695 if (guid_to_name_redact_snaps(hdl, toname, fromguid, B_TRUE, 1696 redact_snap_guids, num_redact_snaps, name) != 0) { 1697 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1698 "incremental source %#llx no longer exists"), 1699 (longlong_t)fromguid); 1700 return (zfs_error(hdl, EZFS_BADPATH, errbuf)); 1701 } 1702 fromname = name; 1703 } 1704 1705 redact_snap_guids = NULL; 1706 1707 if (nvlist_lookup_uint64_array(resume_nvl, 1708 zfs_prop_to_name(ZFS_PROP_REDACT_SNAPS), &redact_snap_guids, 1709 (uint_t *)&num_redact_snaps) == 0) { 1710 char path[ZFS_MAX_DATASET_NAME_LEN]; 1711 1712 (void) strlcpy(path, toname, sizeof (path)); 1713 char *at = strchr(path, '@'); 1714 ASSERT3P(at, !=, NULL); 1715 1716 *at = '\0'; 1717 1718 if ((error = find_redact_book(hdl, path, redact_snap_guids, 1719 num_redact_snaps, &redact_book)) != 0) { 1720 return (error); 1721 } 1722 } 1723 1724 if (flags->verbosity != 0) { 1725 /* 1726 * Some of these may have come from the resume token, set them 1727 * here for size estimate purposes. 1728 */ 1729 sendflags_t tmpflags = *flags; 1730 if (lzc_flags & LZC_SEND_FLAG_LARGE_BLOCK) 1731 tmpflags.largeblock = B_TRUE; 1732 if (lzc_flags & LZC_SEND_FLAG_COMPRESS) 1733 tmpflags.compress = B_TRUE; 1734 if (lzc_flags & LZC_SEND_FLAG_EMBED_DATA) 1735 tmpflags.embed_data = B_TRUE; 1736 error = estimate_size(zhp, fromname, outfd, &tmpflags, 1737 resumeobj, resumeoff, bytes, redact_book, errbuf); 1738 } 1739 1740 if (!flags->dryrun) { 1741 progress_arg_t pa = { 0 }; 1742 pthread_t tid; 1743 /* 1744 * If progress reporting is requested, spawn a new thread to 1745 * poll ZFS_IOC_SEND_PROGRESS at a regular interval. 1746 */ 1747 if (flags->progress) { 1748 pa.pa_zhp = zhp; 1749 pa.pa_fd = outfd; 1750 pa.pa_parsable = flags->parsable; 1751 pa.pa_estimate = B_FALSE; 1752 pa.pa_verbosity = flags->verbosity; 1753 1754 error = pthread_create(&tid, NULL, 1755 send_progress_thread, &pa); 1756 if (error != 0) { 1757 if (redact_book != NULL) 1758 free(redact_book); 1759 zfs_close(zhp); 1760 return (error); 1761 } 1762 } 1763 1764 error = lzc_send_resume_redacted(zhp->zfs_name, fromname, outfd, 1765 lzc_flags, resumeobj, resumeoff, redact_book); 1766 if (redact_book != NULL) 1767 free(redact_book); 1768 1769 if (flags->progress) { 1770 void *status = NULL; 1771 (void) pthread_cancel(tid); 1772 (void) pthread_join(tid, &status); 1773 int error = (int)(uintptr_t)status; 1774 if (error != 0 && status != PTHREAD_CANCELED) { 1775 char errbuf[1024]; 1776 (void) snprintf(errbuf, sizeof (errbuf), 1777 dgettext(TEXT_DOMAIN, 1778 "progress thread exited nonzero")); 1779 return (zfs_standard_error(hdl, error, errbuf)); 1780 } 1781 } 1782 1783 char errbuf[1024]; 1784 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN, 1785 "warning: cannot send '%s'"), zhp->zfs_name); 1786 1787 zfs_close(zhp); 1788 1789 switch (error) { 1790 case 0: 1791 return (0); 1792 case EACCES: 1793 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1794 "source key must be loaded")); 1795 return (zfs_error(hdl, EZFS_CRYPTOFAILED, errbuf)); 1796 case ESRCH: 1797 if (lzc_exists(zhp->zfs_name)) { 1798 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1799 "incremental source could not be found")); 1800 } 1801 return (zfs_error(hdl, EZFS_NOENT, errbuf)); 1802 1803 case EXDEV: 1804 case ENOENT: 1805 case EDQUOT: 1806 case EFBIG: 1807 case EIO: 1808 case ENOLINK: 1809 case ENOSPC: 1810 case ENOSTR: 1811 case ENXIO: 1812 case EPIPE: 1813 case ERANGE: 1814 case EFAULT: 1815 case EROFS: 1816 zfs_error_aux(hdl, strerror(errno)); 1817 return (zfs_error(hdl, EZFS_BADBACKUP, errbuf)); 1818 1819 default: 1820 return (zfs_standard_error(hdl, errno, errbuf)); 1821 } 1822 } else { 1823 if (redact_book != NULL) 1824 free(redact_book); 1825 } 1826 1827 zfs_close(zhp); 1828 1829 return (error); 1830 } 1831 1832 int 1833 zfs_send_resume(libzfs_handle_t *hdl, sendflags_t *flags, int outfd, 1834 const char *resume_token) 1835 { 1836 int ret; 1837 char errbuf[1024]; 1838 nvlist_t *resume_nvl; 1839 1840 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN, 1841 "cannot resume send")); 1842 1843 resume_nvl = zfs_send_resume_token_to_nvlist(hdl, resume_token); 1844 if (resume_nvl == NULL) { 1845 /* 1846 * zfs_error_aux has already been set by 1847 * zfs_send_resume_token_to_nvlist() 1848 */ 1849 return (zfs_error(hdl, EZFS_FAULT, errbuf)); 1850 } 1851 1852 ret = zfs_send_resume_impl(hdl, flags, outfd, resume_nvl); 1853 nvlist_free(resume_nvl); 1854 1855 return (ret); 1856 } 1857 1858 int 1859 zfs_send_saved(zfs_handle_t *zhp, sendflags_t *flags, int outfd, 1860 const char *resume_token) 1861 { 1862 int ret; 1863 libzfs_handle_t *hdl = zhp->zfs_hdl; 1864 nvlist_t *saved_nvl = NULL, *resume_nvl = NULL; 1865 uint64_t saved_guid = 0, resume_guid = 0; 1866 uint64_t obj = 0, off = 0, bytes = 0; 1867 char token_buf[ZFS_MAXPROPLEN]; 1868 char errbuf[1024]; 1869 1870 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN, 1871 "saved send failed")); 1872 1873 ret = zfs_prop_get(zhp, ZFS_PROP_RECEIVE_RESUME_TOKEN, 1874 token_buf, sizeof (token_buf), NULL, NULL, 0, B_TRUE); 1875 if (ret != 0) 1876 goto out; 1877 1878 saved_nvl = zfs_send_resume_token_to_nvlist(hdl, token_buf); 1879 if (saved_nvl == NULL) { 1880 /* 1881 * zfs_error_aux has already been set by 1882 * zfs_send_resume_token_to_nvlist() 1883 */ 1884 ret = zfs_error(hdl, EZFS_FAULT, errbuf); 1885 goto out; 1886 } 1887 1888 /* 1889 * If a resume token is provided we use the object and offset 1890 * from that instead of the default, which starts from the 1891 * beginning. 1892 */ 1893 if (resume_token != NULL) { 1894 resume_nvl = zfs_send_resume_token_to_nvlist(hdl, 1895 resume_token); 1896 if (resume_nvl == NULL) { 1897 ret = zfs_error(hdl, EZFS_FAULT, errbuf); 1898 goto out; 1899 } 1900 1901 if (nvlist_lookup_uint64(resume_nvl, "object", &obj) != 0 || 1902 nvlist_lookup_uint64(resume_nvl, "offset", &off) != 0 || 1903 nvlist_lookup_uint64(resume_nvl, "bytes", &bytes) != 0 || 1904 nvlist_lookup_uint64(resume_nvl, "toguid", 1905 &resume_guid) != 0) { 1906 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1907 "provided resume token is corrupt")); 1908 ret = zfs_error(hdl, EZFS_FAULT, errbuf); 1909 goto out; 1910 } 1911 1912 if (nvlist_lookup_uint64(saved_nvl, "toguid", 1913 &saved_guid)) { 1914 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1915 "dataset's resume token is corrupt")); 1916 ret = zfs_error(hdl, EZFS_FAULT, errbuf); 1917 goto out; 1918 } 1919 1920 if (resume_guid != saved_guid) { 1921 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1922 "provided resume token does not match dataset")); 1923 ret = zfs_error(hdl, EZFS_BADBACKUP, errbuf); 1924 goto out; 1925 } 1926 } 1927 1928 (void) nvlist_remove_all(saved_nvl, "object"); 1929 fnvlist_add_uint64(saved_nvl, "object", obj); 1930 1931 (void) nvlist_remove_all(saved_nvl, "offset"); 1932 fnvlist_add_uint64(saved_nvl, "offset", off); 1933 1934 (void) nvlist_remove_all(saved_nvl, "bytes"); 1935 fnvlist_add_uint64(saved_nvl, "bytes", bytes); 1936 1937 (void) nvlist_remove_all(saved_nvl, "toname"); 1938 fnvlist_add_string(saved_nvl, "toname", zhp->zfs_name); 1939 1940 ret = zfs_send_resume_impl(hdl, flags, outfd, saved_nvl); 1941 1942 out: 1943 nvlist_free(saved_nvl); 1944 nvlist_free(resume_nvl); 1945 return (ret); 1946 } 1947 1948 /* 1949 * This function informs the target system that the recursive send is complete. 1950 * The record is also expected in the case of a send -p. 1951 */ 1952 static int 1953 send_conclusion_record(int fd, zio_cksum_t *zc) 1954 { 1955 dmu_replay_record_t drr = { 0 }; 1956 drr.drr_type = DRR_END; 1957 if (zc != NULL) 1958 drr.drr_u.drr_end.drr_checksum = *zc; 1959 if (write(fd, &drr, sizeof (drr)) == -1) { 1960 return (errno); 1961 } 1962 return (0); 1963 } 1964 1965 /* 1966 * This function is responsible for sending the records that contain the 1967 * necessary information for the target system's libzfs to be able to set the 1968 * properties of the filesystem being received, or to be able to prepare for 1969 * a recursive receive. 1970 * 1971 * The "zhp" argument is the handle of the snapshot we are sending 1972 * (the "tosnap"). The "from" argument is the short snapshot name (the part 1973 * after the @) of the incremental source. 1974 */ 1975 static int 1976 send_prelim_records(zfs_handle_t *zhp, const char *from, int fd, 1977 boolean_t gather_props, boolean_t recursive, boolean_t verbose, 1978 boolean_t dryrun, boolean_t raw, boolean_t replicate, boolean_t backup, 1979 boolean_t holds, boolean_t props, boolean_t doall, 1980 nvlist_t **fssp, avl_tree_t **fsavlp) 1981 { 1982 int err = 0; 1983 char *packbuf = NULL; 1984 size_t buflen = 0; 1985 zio_cksum_t zc = { {0} }; 1986 int featureflags = 0; 1987 /* name of filesystem/volume that contains snapshot we are sending */ 1988 char tofs[ZFS_MAX_DATASET_NAME_LEN]; 1989 /* short name of snap we are sending */ 1990 char *tosnap = ""; 1991 1992 char errbuf[1024]; 1993 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN, 1994 "warning: cannot send '%s'"), zhp->zfs_name); 1995 if (zhp->zfs_type == ZFS_TYPE_FILESYSTEM && zfs_prop_get_int(zhp, 1996 ZFS_PROP_VERSION) >= ZPL_VERSION_SA) { 1997 featureflags |= DMU_BACKUP_FEATURE_SA_SPILL; 1998 } 1999 2000 if (holds) 2001 featureflags |= DMU_BACKUP_FEATURE_HOLDS; 2002 2003 (void) strlcpy(tofs, zhp->zfs_name, ZFS_MAX_DATASET_NAME_LEN); 2004 char *at = strchr(tofs, '@'); 2005 if (at != NULL) { 2006 *at = '\0'; 2007 tosnap = at + 1; 2008 } 2009 2010 if (gather_props) { 2011 nvlist_t *hdrnv = fnvlist_alloc(); 2012 nvlist_t *fss = NULL; 2013 2014 if (from != NULL) 2015 fnvlist_add_string(hdrnv, "fromsnap", from); 2016 fnvlist_add_string(hdrnv, "tosnap", tosnap); 2017 if (!recursive) 2018 fnvlist_add_boolean(hdrnv, "not_recursive"); 2019 2020 if (raw) { 2021 VERIFY0(nvlist_add_boolean(hdrnv, "raw")); 2022 } 2023 2024 if ((err = gather_nvlist(zhp->zfs_hdl, tofs, 2025 from, tosnap, recursive, raw, doall, replicate, verbose, 2026 backup, holds, props, &fss, fsavlp)) != 0) { 2027 return (zfs_error(zhp->zfs_hdl, EZFS_BADBACKUP, 2028 errbuf)); 2029 } 2030 /* 2031 * Do not allow the size of the properties list to exceed 2032 * the limit 2033 */ 2034 if ((fnvlist_size(fss) + fnvlist_size(hdrnv)) > 2035 zhp->zfs_hdl->libzfs_max_nvlist) { 2036 (void) snprintf(errbuf, sizeof (errbuf), 2037 dgettext(TEXT_DOMAIN, "warning: cannot send '%s': " 2038 "the size of the list of snapshots and properties " 2039 "is too large to be received successfully.\n" 2040 "Select a smaller number of snapshots to send.\n"), 2041 zhp->zfs_name); 2042 return (zfs_error(zhp->zfs_hdl, EZFS_NOSPC, 2043 errbuf)); 2044 } 2045 fnvlist_add_nvlist(hdrnv, "fss", fss); 2046 VERIFY0(nvlist_pack(hdrnv, &packbuf, &buflen, NV_ENCODE_XDR, 2047 0)); 2048 if (fssp != NULL) { 2049 *fssp = fss; 2050 } else { 2051 nvlist_free(fss); 2052 } 2053 nvlist_free(hdrnv); 2054 } 2055 2056 if (!dryrun) { 2057 dmu_replay_record_t drr = { 0 }; 2058 /* write first begin record */ 2059 drr.drr_type = DRR_BEGIN; 2060 drr.drr_u.drr_begin.drr_magic = DMU_BACKUP_MAGIC; 2061 DMU_SET_STREAM_HDRTYPE(drr.drr_u.drr_begin. 2062 drr_versioninfo, DMU_COMPOUNDSTREAM); 2063 DMU_SET_FEATUREFLAGS(drr.drr_u.drr_begin. 2064 drr_versioninfo, featureflags); 2065 if (snprintf(drr.drr_u.drr_begin.drr_toname, 2066 sizeof (drr.drr_u.drr_begin.drr_toname), "%s@%s", tofs, 2067 tosnap) >= sizeof (drr.drr_u.drr_begin.drr_toname)) { 2068 return (zfs_error(zhp->zfs_hdl, EZFS_BADBACKUP, 2069 errbuf)); 2070 } 2071 drr.drr_payloadlen = buflen; 2072 2073 err = dump_record(&drr, packbuf, buflen, &zc, fd); 2074 free(packbuf); 2075 if (err != 0) { 2076 zfs_error_aux(zhp->zfs_hdl, strerror(err)); 2077 return (zfs_error(zhp->zfs_hdl, EZFS_BADBACKUP, 2078 errbuf)); 2079 } 2080 err = send_conclusion_record(fd, &zc); 2081 if (err != 0) { 2082 zfs_error_aux(zhp->zfs_hdl, strerror(err)); 2083 return (zfs_error(zhp->zfs_hdl, EZFS_BADBACKUP, 2084 errbuf)); 2085 } 2086 } 2087 return (0); 2088 } 2089 2090 /* 2091 * Generate a send stream. The "zhp" argument is the filesystem/volume 2092 * that contains the snapshot to send. The "fromsnap" argument is the 2093 * short name (the part after the '@') of the snapshot that is the 2094 * incremental source to send from (if non-NULL). The "tosnap" argument 2095 * is the short name of the snapshot to send. 2096 * 2097 * The content of the send stream is the snapshot identified by 2098 * 'tosnap'. Incremental streams are requested in two ways: 2099 * - from the snapshot identified by "fromsnap" (if non-null) or 2100 * - from the origin of the dataset identified by zhp, which must 2101 * be a clone. In this case, "fromsnap" is null and "fromorigin" 2102 * is TRUE. 2103 * 2104 * The send stream is recursive (i.e. dumps a hierarchy of snapshots) and 2105 * uses a special header (with a hdrtype field of DMU_COMPOUNDSTREAM) 2106 * if "replicate" is set. If "doall" is set, dump all the intermediate 2107 * snapshots. The DMU_COMPOUNDSTREAM header is used in the "doall" 2108 * case too. If "props" is set, send properties. 2109 */ 2110 int 2111 zfs_send(zfs_handle_t *zhp, const char *fromsnap, const char *tosnap, 2112 sendflags_t *flags, int outfd, snapfilter_cb_t filter_func, 2113 void *cb_arg, nvlist_t **debugnvp) 2114 { 2115 char errbuf[1024]; 2116 send_dump_data_t sdd = { 0 }; 2117 int err = 0; 2118 nvlist_t *fss = NULL; 2119 avl_tree_t *fsavl = NULL; 2120 static uint64_t holdseq; 2121 int spa_version; 2122 int featureflags = 0; 2123 FILE *fout; 2124 2125 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN, 2126 "cannot send '%s'"), zhp->zfs_name); 2127 2128 if (fromsnap && fromsnap[0] == '\0') { 2129 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN, 2130 "zero-length incremental source")); 2131 return (zfs_error(zhp->zfs_hdl, EZFS_NOENT, errbuf)); 2132 } 2133 2134 if (zhp->zfs_type == ZFS_TYPE_FILESYSTEM) { 2135 uint64_t version; 2136 version = zfs_prop_get_int(zhp, ZFS_PROP_VERSION); 2137 if (version >= ZPL_VERSION_SA) { 2138 featureflags |= DMU_BACKUP_FEATURE_SA_SPILL; 2139 } 2140 } 2141 2142 if (flags->holds) 2143 featureflags |= DMU_BACKUP_FEATURE_HOLDS; 2144 2145 if (flags->replicate || flags->doall || flags->props || 2146 flags->holds || flags->backup) { 2147 char full_tosnap_name[ZFS_MAX_DATASET_NAME_LEN]; 2148 if (snprintf(full_tosnap_name, sizeof (full_tosnap_name), 2149 "%s@%s", zhp->zfs_name, tosnap) >= 2150 sizeof (full_tosnap_name)) { 2151 err = EINVAL; 2152 goto stderr_out; 2153 } 2154 zfs_handle_t *tosnap = zfs_open(zhp->zfs_hdl, 2155 full_tosnap_name, ZFS_TYPE_SNAPSHOT); 2156 if (tosnap == NULL) { 2157 err = -1; 2158 goto err_out; 2159 } 2160 err = send_prelim_records(tosnap, fromsnap, outfd, 2161 flags->replicate || flags->props || flags->holds, 2162 flags->replicate, flags->verbosity > 0, flags->dryrun, 2163 flags->raw, flags->replicate, flags->backup, flags->holds, 2164 flags->props, flags->doall, &fss, &fsavl); 2165 zfs_close(tosnap); 2166 if (err != 0) 2167 goto err_out; 2168 } 2169 2170 /* dump each stream */ 2171 sdd.fromsnap = fromsnap; 2172 sdd.tosnap = tosnap; 2173 sdd.outfd = outfd; 2174 sdd.replicate = flags->replicate; 2175 sdd.doall = flags->doall; 2176 sdd.fromorigin = flags->fromorigin; 2177 sdd.fss = fss; 2178 sdd.fsavl = fsavl; 2179 sdd.verbosity = flags->verbosity; 2180 sdd.parsable = flags->parsable; 2181 sdd.progress = flags->progress; 2182 sdd.dryrun = flags->dryrun; 2183 sdd.large_block = flags->largeblock; 2184 sdd.embed_data = flags->embed_data; 2185 sdd.compress = flags->compress; 2186 sdd.raw = flags->raw; 2187 sdd.holds = flags->holds; 2188 sdd.filter_cb = filter_func; 2189 sdd.filter_cb_arg = cb_arg; 2190 if (debugnvp) 2191 sdd.debugnv = *debugnvp; 2192 if (sdd.verbosity != 0 && sdd.dryrun) 2193 sdd.std_out = B_TRUE; 2194 fout = sdd.std_out ? stdout : stderr; 2195 2196 /* 2197 * Some flags require that we place user holds on the datasets that are 2198 * being sent so they don't get destroyed during the send. We can skip 2199 * this step if the pool is imported read-only since the datasets cannot 2200 * be destroyed. 2201 */ 2202 if (!flags->dryrun && !zpool_get_prop_int(zfs_get_pool_handle(zhp), 2203 ZPOOL_PROP_READONLY, NULL) && 2204 zfs_spa_version(zhp, &spa_version) == 0 && 2205 spa_version >= SPA_VERSION_USERREFS && 2206 (flags->doall || flags->replicate)) { 2207 ++holdseq; 2208 (void) snprintf(sdd.holdtag, sizeof (sdd.holdtag), 2209 ".send-%d-%llu", getpid(), (u_longlong_t)holdseq); 2210 sdd.cleanup_fd = open(ZFS_DEV, O_RDWR); 2211 if (sdd.cleanup_fd < 0) { 2212 err = errno; 2213 goto stderr_out; 2214 } 2215 sdd.snapholds = fnvlist_alloc(); 2216 } else { 2217 sdd.cleanup_fd = -1; 2218 sdd.snapholds = NULL; 2219 } 2220 2221 if (flags->verbosity != 0 || sdd.snapholds != NULL) { 2222 /* 2223 * Do a verbose no-op dry run to get all the verbose output 2224 * or to gather snapshot hold's before generating any data, 2225 * then do a non-verbose real run to generate the streams. 2226 */ 2227 sdd.dryrun = B_TRUE; 2228 err = dump_filesystems(zhp, &sdd); 2229 2230 if (err != 0) 2231 goto stderr_out; 2232 2233 if (flags->verbosity != 0) { 2234 if (flags->parsable) { 2235 (void) fprintf(fout, "size\t%llu\n", 2236 (longlong_t)sdd.size); 2237 } else { 2238 char buf[16]; 2239 zfs_nicebytes(sdd.size, buf, sizeof (buf)); 2240 (void) fprintf(fout, dgettext(TEXT_DOMAIN, 2241 "total estimated size is %s\n"), buf); 2242 } 2243 } 2244 2245 /* Ensure no snaps found is treated as an error. */ 2246 if (!sdd.seento) { 2247 err = ENOENT; 2248 goto err_out; 2249 } 2250 2251 /* Skip the second run if dryrun was requested. */ 2252 if (flags->dryrun) 2253 goto err_out; 2254 2255 if (sdd.snapholds != NULL) { 2256 err = zfs_hold_nvl(zhp, sdd.cleanup_fd, sdd.snapholds); 2257 if (err != 0) 2258 goto stderr_out; 2259 2260 fnvlist_free(sdd.snapholds); 2261 sdd.snapholds = NULL; 2262 } 2263 2264 sdd.dryrun = B_FALSE; 2265 sdd.verbosity = 0; 2266 } 2267 2268 err = dump_filesystems(zhp, &sdd); 2269 fsavl_destroy(fsavl); 2270 nvlist_free(fss); 2271 2272 /* Ensure no snaps found is treated as an error. */ 2273 if (err == 0 && !sdd.seento) 2274 err = ENOENT; 2275 2276 if (sdd.cleanup_fd != -1) { 2277 VERIFY(0 == close(sdd.cleanup_fd)); 2278 sdd.cleanup_fd = -1; 2279 } 2280 2281 if (!flags->dryrun && (flags->replicate || flags->doall || 2282 flags->props || flags->backup || flags->holds)) { 2283 /* 2284 * write final end record. NB: want to do this even if 2285 * there was some error, because it might not be totally 2286 * failed. 2287 */ 2288 err = send_conclusion_record(outfd, NULL); 2289 if (err != 0) 2290 return (zfs_standard_error(zhp->zfs_hdl, err, errbuf)); 2291 } 2292 2293 return (err || sdd.err); 2294 2295 stderr_out: 2296 err = zfs_standard_error(zhp->zfs_hdl, err, errbuf); 2297 err_out: 2298 fsavl_destroy(fsavl); 2299 nvlist_free(fss); 2300 fnvlist_free(sdd.snapholds); 2301 2302 if (sdd.cleanup_fd != -1) 2303 VERIFY(0 == close(sdd.cleanup_fd)); 2304 return (err); 2305 } 2306 2307 static zfs_handle_t * 2308 name_to_dir_handle(libzfs_handle_t *hdl, const char *snapname) 2309 { 2310 char dirname[ZFS_MAX_DATASET_NAME_LEN]; 2311 (void) strlcpy(dirname, snapname, ZFS_MAX_DATASET_NAME_LEN); 2312 char *c = strchr(dirname, '@'); 2313 if (c != NULL) 2314 *c = '\0'; 2315 return (zfs_open(hdl, dirname, ZFS_TYPE_DATASET)); 2316 } 2317 2318 /* 2319 * Returns B_TRUE if earlier is an earlier snapshot in later's timeline; either 2320 * an earlier snapshot in the same filesystem, or a snapshot before later's 2321 * origin, or it's origin's origin, etc. 2322 */ 2323 static boolean_t 2324 snapshot_is_before(zfs_handle_t *earlier, zfs_handle_t *later) 2325 { 2326 boolean_t ret; 2327 uint64_t later_txg = 2328 (later->zfs_type == ZFS_TYPE_FILESYSTEM || 2329 later->zfs_type == ZFS_TYPE_VOLUME ? 2330 UINT64_MAX : zfs_prop_get_int(later, ZFS_PROP_CREATETXG)); 2331 uint64_t earlier_txg = zfs_prop_get_int(earlier, ZFS_PROP_CREATETXG); 2332 2333 if (earlier_txg >= later_txg) 2334 return (B_FALSE); 2335 2336 zfs_handle_t *earlier_dir = name_to_dir_handle(earlier->zfs_hdl, 2337 earlier->zfs_name); 2338 zfs_handle_t *later_dir = name_to_dir_handle(later->zfs_hdl, 2339 later->zfs_name); 2340 2341 if (strcmp(earlier_dir->zfs_name, later_dir->zfs_name) == 0) { 2342 zfs_close(earlier_dir); 2343 zfs_close(later_dir); 2344 return (B_TRUE); 2345 } 2346 2347 char clonename[ZFS_MAX_DATASET_NAME_LEN]; 2348 if (zfs_prop_get(later_dir, ZFS_PROP_ORIGIN, clonename, 2349 ZFS_MAX_DATASET_NAME_LEN, NULL, NULL, 0, B_TRUE) != 0) { 2350 zfs_close(earlier_dir); 2351 zfs_close(later_dir); 2352 return (B_FALSE); 2353 } 2354 2355 zfs_handle_t *origin = zfs_open(earlier->zfs_hdl, clonename, 2356 ZFS_TYPE_DATASET); 2357 uint64_t origin_txg = zfs_prop_get_int(origin, ZFS_PROP_CREATETXG); 2358 2359 /* 2360 * If "earlier" is exactly the origin, then 2361 * snapshot_is_before(earlier, origin) will return false (because 2362 * they're the same). 2363 */ 2364 if (origin_txg == earlier_txg && 2365 strcmp(origin->zfs_name, earlier->zfs_name) == 0) { 2366 zfs_close(earlier_dir); 2367 zfs_close(later_dir); 2368 zfs_close(origin); 2369 return (B_TRUE); 2370 } 2371 zfs_close(earlier_dir); 2372 zfs_close(later_dir); 2373 2374 ret = snapshot_is_before(earlier, origin); 2375 zfs_close(origin); 2376 return (ret); 2377 } 2378 2379 /* 2380 * The "zhp" argument is the handle of the dataset to send (typically a 2381 * snapshot). The "from" argument is the full name of the snapshot or 2382 * bookmark that is the incremental source. 2383 */ 2384 int 2385 zfs_send_one(zfs_handle_t *zhp, const char *from, int fd, sendflags_t *flags, 2386 const char *redactbook) 2387 { 2388 int err; 2389 libzfs_handle_t *hdl = zhp->zfs_hdl; 2390 char *name = zhp->zfs_name; 2391 int orig_fd = fd; 2392 pthread_t ptid; 2393 progress_arg_t pa = { 0 }; 2394 2395 char errbuf[1024]; 2396 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN, 2397 "warning: cannot send '%s'"), name); 2398 2399 if (from != NULL && strchr(from, '@')) { 2400 zfs_handle_t *from_zhp = zfs_open(hdl, from, 2401 ZFS_TYPE_DATASET); 2402 if (from_zhp == NULL) 2403 return (-1); 2404 if (!snapshot_is_before(from_zhp, zhp)) { 2405 zfs_close(from_zhp); 2406 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 2407 "not an earlier snapshot from the same fs")); 2408 return (zfs_error(hdl, EZFS_CROSSTARGET, errbuf)); 2409 } 2410 zfs_close(from_zhp); 2411 } 2412 2413 if (redactbook != NULL) { 2414 char bookname[ZFS_MAX_DATASET_NAME_LEN]; 2415 nvlist_t *redact_snaps; 2416 zfs_handle_t *book_zhp; 2417 char *at, *pound; 2418 int dsnamelen; 2419 2420 pound = strchr(redactbook, '#'); 2421 if (pound != NULL) 2422 redactbook = pound + 1; 2423 at = strchr(name, '@'); 2424 if (at == NULL) { 2425 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 2426 "cannot do a redacted send to a filesystem")); 2427 return (zfs_error(hdl, EZFS_BADTYPE, errbuf)); 2428 } 2429 dsnamelen = at - name; 2430 if (snprintf(bookname, sizeof (bookname), "%.*s#%s", 2431 dsnamelen, name, redactbook) 2432 >= sizeof (bookname)) { 2433 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 2434 "invalid bookmark name")); 2435 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf)); 2436 } 2437 book_zhp = zfs_open(hdl, bookname, ZFS_TYPE_BOOKMARK); 2438 if (book_zhp == NULL) 2439 return (-1); 2440 if (nvlist_lookup_nvlist(book_zhp->zfs_props, 2441 zfs_prop_to_name(ZFS_PROP_REDACT_SNAPS), 2442 &redact_snaps) != 0 || redact_snaps == NULL) { 2443 zfs_close(book_zhp); 2444 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 2445 "not a redaction bookmark")); 2446 return (zfs_error(hdl, EZFS_BADTYPE, errbuf)); 2447 } 2448 zfs_close(book_zhp); 2449 } 2450 2451 /* 2452 * Send fs properties 2453 */ 2454 if (flags->props || flags->holds || flags->backup) { 2455 /* 2456 * Note: the header generated by send_prelim_records() 2457 * assumes that the incremental source is in the same 2458 * filesystem/volume as the target (which is a requirement 2459 * when doing "zfs send -R"). But that isn't always the 2460 * case here (e.g. send from snap in origin, or send from 2461 * bookmark). We pass from=NULL, which will omit this 2462 * information from the prelim records; it isn't used 2463 * when receiving this type of stream. 2464 */ 2465 err = send_prelim_records(zhp, NULL, fd, B_TRUE, B_FALSE, 2466 flags->verbosity > 0, flags->dryrun, flags->raw, 2467 flags->replicate, flags->backup, flags->holds, 2468 flags->props, flags->doall, NULL, NULL); 2469 if (err != 0) 2470 return (err); 2471 } 2472 2473 /* 2474 * Perform size estimate if verbose was specified. 2475 */ 2476 if (flags->verbosity != 0) { 2477 err = estimate_size(zhp, from, fd, flags, 0, 0, 0, redactbook, 2478 errbuf); 2479 if (err != 0) 2480 return (err); 2481 } 2482 2483 if (flags->dryrun) 2484 return (0); 2485 2486 /* 2487 * If progress reporting is requested, spawn a new thread to poll 2488 * ZFS_IOC_SEND_PROGRESS at a regular interval. 2489 */ 2490 if (flags->progress) { 2491 pa.pa_zhp = zhp; 2492 pa.pa_fd = fd; 2493 pa.pa_parsable = flags->parsable; 2494 pa.pa_estimate = B_FALSE; 2495 pa.pa_verbosity = flags->verbosity; 2496 2497 err = pthread_create(&ptid, NULL, 2498 send_progress_thread, &pa); 2499 if (err != 0) { 2500 zfs_error_aux(zhp->zfs_hdl, strerror(errno)); 2501 return (zfs_error(zhp->zfs_hdl, 2502 EZFS_THREADCREATEFAILED, errbuf)); 2503 } 2504 } 2505 2506 err = lzc_send_redacted(name, from, fd, 2507 lzc_flags_from_sendflags(flags), redactbook); 2508 2509 if (flags->progress) { 2510 void *status = NULL; 2511 if (err != 0) 2512 (void) pthread_cancel(ptid); 2513 (void) pthread_join(ptid, &status); 2514 int error = (int)(uintptr_t)status; 2515 if (error != 0 && status != PTHREAD_CANCELED) { 2516 char errbuf[1024]; 2517 (void) snprintf(errbuf, sizeof (errbuf), 2518 dgettext(TEXT_DOMAIN, "progress thread exited " 2519 "nonzero")); 2520 return (zfs_standard_error(hdl, error, errbuf)); 2521 } 2522 } 2523 2524 if (flags->props || flags->holds || flags->backup) { 2525 /* Write the final end record. */ 2526 err = send_conclusion_record(orig_fd, NULL); 2527 if (err != 0) 2528 return (zfs_standard_error(hdl, err, errbuf)); 2529 } 2530 if (err != 0) { 2531 switch (errno) { 2532 case EXDEV: 2533 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 2534 "not an earlier snapshot from the same fs")); 2535 return (zfs_error(hdl, EZFS_CROSSTARGET, errbuf)); 2536 2537 case ENOENT: 2538 case ESRCH: 2539 if (lzc_exists(name)) { 2540 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 2541 "incremental source (%s) does not exist"), 2542 from); 2543 } 2544 return (zfs_error(hdl, EZFS_NOENT, errbuf)); 2545 2546 case EACCES: 2547 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 2548 "dataset key must be loaded")); 2549 return (zfs_error(hdl, EZFS_CRYPTOFAILED, errbuf)); 2550 2551 case EBUSY: 2552 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 2553 "target is busy; if a filesystem, " 2554 "it must not be mounted")); 2555 return (zfs_error(hdl, EZFS_BUSY, errbuf)); 2556 2557 case EDQUOT: 2558 case EFAULT: 2559 case EFBIG: 2560 case EINVAL: 2561 case EIO: 2562 case ENOLINK: 2563 case ENOSPC: 2564 case ENOSTR: 2565 case ENXIO: 2566 case EPIPE: 2567 case ERANGE: 2568 case EROFS: 2569 zfs_error_aux(hdl, strerror(errno)); 2570 return (zfs_error(hdl, EZFS_BADBACKUP, errbuf)); 2571 2572 default: 2573 return (zfs_standard_error(hdl, errno, errbuf)); 2574 } 2575 } 2576 return (err != 0); 2577 } 2578 2579 /* 2580 * Routines specific to "zfs recv" 2581 */ 2582 2583 static int 2584 recv_read(libzfs_handle_t *hdl, int fd, void *buf, int ilen, 2585 boolean_t byteswap, zio_cksum_t *zc) 2586 { 2587 char *cp = buf; 2588 int rv; 2589 int len = ilen; 2590 2591 do { 2592 rv = read(fd, cp, len); 2593 cp += rv; 2594 len -= rv; 2595 } while (rv > 0); 2596 2597 if (rv < 0 || len != 0) { 2598 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 2599 "failed to read from stream")); 2600 return (zfs_error(hdl, EZFS_BADSTREAM, dgettext(TEXT_DOMAIN, 2601 "cannot receive"))); 2602 } 2603 2604 if (zc) { 2605 if (byteswap) 2606 fletcher_4_incremental_byteswap(buf, ilen, zc); 2607 else 2608 fletcher_4_incremental_native(buf, ilen, zc); 2609 } 2610 return (0); 2611 } 2612 2613 static int 2614 recv_read_nvlist(libzfs_handle_t *hdl, int fd, int len, nvlist_t **nvp, 2615 boolean_t byteswap, zio_cksum_t *zc) 2616 { 2617 char *buf; 2618 int err; 2619 2620 buf = zfs_alloc(hdl, len); 2621 if (buf == NULL) 2622 return (ENOMEM); 2623 2624 if (len > hdl->libzfs_max_nvlist) { 2625 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, "nvlist too large")); 2626 free(buf); 2627 return (ENOMEM); 2628 } 2629 2630 err = recv_read(hdl, fd, buf, len, byteswap, zc); 2631 if (err != 0) { 2632 free(buf); 2633 return (err); 2634 } 2635 2636 err = nvlist_unpack(buf, len, nvp, 0); 2637 free(buf); 2638 if (err != 0) { 2639 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, "invalid " 2640 "stream (malformed nvlist)")); 2641 return (EINVAL); 2642 } 2643 return (0); 2644 } 2645 2646 /* 2647 * Returns the grand origin (origin of origin of origin...) of a given handle. 2648 * If this dataset is not a clone, it simply returns a copy of the original 2649 * handle. 2650 */ 2651 static zfs_handle_t * 2652 recv_open_grand_origin(zfs_handle_t *zhp) 2653 { 2654 char origin[ZFS_MAX_DATASET_NAME_LEN]; 2655 zprop_source_t src; 2656 zfs_handle_t *ozhp = zfs_handle_dup(zhp); 2657 2658 while (ozhp != NULL) { 2659 if (zfs_prop_get(ozhp, ZFS_PROP_ORIGIN, origin, 2660 sizeof (origin), &src, NULL, 0, B_FALSE) != 0) 2661 break; 2662 2663 (void) zfs_close(ozhp); 2664 ozhp = zfs_open(zhp->zfs_hdl, origin, ZFS_TYPE_FILESYSTEM); 2665 } 2666 2667 return (ozhp); 2668 } 2669 2670 static int 2671 recv_rename_impl(zfs_handle_t *zhp, const char *name, const char *newname) 2672 { 2673 int err; 2674 zfs_handle_t *ozhp = NULL; 2675 2676 /* 2677 * Attempt to rename the dataset. If it fails with EACCES we have 2678 * attempted to rename the dataset outside of its encryption root. 2679 * Force the dataset to become an encryption root and try again. 2680 */ 2681 err = lzc_rename(name, newname); 2682 if (err == EACCES) { 2683 ozhp = recv_open_grand_origin(zhp); 2684 if (ozhp == NULL) { 2685 err = ENOENT; 2686 goto out; 2687 } 2688 2689 err = lzc_change_key(ozhp->zfs_name, DCP_CMD_FORCE_NEW_KEY, 2690 NULL, NULL, 0); 2691 if (err != 0) 2692 goto out; 2693 2694 err = lzc_rename(name, newname); 2695 } 2696 2697 out: 2698 if (ozhp != NULL) 2699 zfs_close(ozhp); 2700 return (err); 2701 } 2702 2703 static int 2704 recv_rename(libzfs_handle_t *hdl, const char *name, const char *tryname, 2705 int baselen, char *newname, recvflags_t *flags) 2706 { 2707 static int seq; 2708 int err; 2709 prop_changelist_t *clp = NULL; 2710 zfs_handle_t *zhp = NULL; 2711 2712 zhp = zfs_open(hdl, name, ZFS_TYPE_DATASET); 2713 if (zhp == NULL) { 2714 err = -1; 2715 goto out; 2716 } 2717 clp = changelist_gather(zhp, ZFS_PROP_NAME, 0, 2718 flags->force ? MS_FORCE : 0); 2719 if (clp == NULL) { 2720 err = -1; 2721 goto out; 2722 } 2723 err = changelist_prefix(clp); 2724 if (err) 2725 goto out; 2726 2727 if (tryname) { 2728 (void) strcpy(newname, tryname); 2729 if (flags->verbose) { 2730 (void) printf("attempting rename %s to %s\n", 2731 name, newname); 2732 } 2733 err = recv_rename_impl(zhp, name, newname); 2734 if (err == 0) 2735 changelist_rename(clp, name, tryname); 2736 } else { 2737 err = ENOENT; 2738 } 2739 2740 if (err != 0 && strncmp(name + baselen, "recv-", 5) != 0) { 2741 seq++; 2742 2743 (void) snprintf(newname, ZFS_MAX_DATASET_NAME_LEN, 2744 "%.*srecv-%u-%u", baselen, name, getpid(), seq); 2745 2746 if (flags->verbose) { 2747 (void) printf("failed - trying rename %s to %s\n", 2748 name, newname); 2749 } 2750 err = recv_rename_impl(zhp, name, newname); 2751 if (err == 0) 2752 changelist_rename(clp, name, newname); 2753 if (err && flags->verbose) { 2754 (void) printf("failed (%u) - " 2755 "will try again on next pass\n", errno); 2756 } 2757 err = EAGAIN; 2758 } else if (flags->verbose) { 2759 if (err == 0) 2760 (void) printf("success\n"); 2761 else 2762 (void) printf("failed (%u)\n", errno); 2763 } 2764 2765 (void) changelist_postfix(clp); 2766 2767 out: 2768 if (clp != NULL) 2769 changelist_free(clp); 2770 if (zhp != NULL) 2771 zfs_close(zhp); 2772 2773 return (err); 2774 } 2775 2776 static int 2777 recv_promote(libzfs_handle_t *hdl, const char *fsname, 2778 const char *origin_fsname, recvflags_t *flags) 2779 { 2780 int err; 2781 zfs_cmd_t zc = {"\0"}; 2782 zfs_handle_t *zhp = NULL, *ozhp = NULL; 2783 2784 if (flags->verbose) 2785 (void) printf("promoting %s\n", fsname); 2786 2787 (void) strlcpy(zc.zc_value, origin_fsname, sizeof (zc.zc_value)); 2788 (void) strlcpy(zc.zc_name, fsname, sizeof (zc.zc_name)); 2789 2790 /* 2791 * Attempt to promote the dataset. If it fails with EACCES the 2792 * promotion would cause this dataset to leave its encryption root. 2793 * Force the origin to become an encryption root and try again. 2794 */ 2795 err = zfs_ioctl(hdl, ZFS_IOC_PROMOTE, &zc); 2796 if (err == EACCES) { 2797 zhp = zfs_open(hdl, fsname, ZFS_TYPE_DATASET); 2798 if (zhp == NULL) { 2799 err = -1; 2800 goto out; 2801 } 2802 2803 ozhp = recv_open_grand_origin(zhp); 2804 if (ozhp == NULL) { 2805 err = -1; 2806 goto out; 2807 } 2808 2809 err = lzc_change_key(ozhp->zfs_name, DCP_CMD_FORCE_NEW_KEY, 2810 NULL, NULL, 0); 2811 if (err != 0) 2812 goto out; 2813 2814 err = zfs_ioctl(hdl, ZFS_IOC_PROMOTE, &zc); 2815 } 2816 2817 out: 2818 if (zhp != NULL) 2819 zfs_close(zhp); 2820 if (ozhp != NULL) 2821 zfs_close(ozhp); 2822 2823 return (err); 2824 } 2825 2826 static int 2827 recv_destroy(libzfs_handle_t *hdl, const char *name, int baselen, 2828 char *newname, recvflags_t *flags) 2829 { 2830 int err = 0; 2831 prop_changelist_t *clp; 2832 zfs_handle_t *zhp; 2833 boolean_t defer = B_FALSE; 2834 int spa_version; 2835 2836 zhp = zfs_open(hdl, name, ZFS_TYPE_DATASET); 2837 if (zhp == NULL) 2838 return (-1); 2839 clp = changelist_gather(zhp, ZFS_PROP_NAME, 0, 2840 flags->force ? MS_FORCE : 0); 2841 if (zfs_get_type(zhp) == ZFS_TYPE_SNAPSHOT && 2842 zfs_spa_version(zhp, &spa_version) == 0 && 2843 spa_version >= SPA_VERSION_USERREFS) 2844 defer = B_TRUE; 2845 zfs_close(zhp); 2846 if (clp == NULL) 2847 return (-1); 2848 err = changelist_prefix(clp); 2849 if (err) 2850 return (err); 2851 2852 if (flags->verbose) 2853 (void) printf("attempting destroy %s\n", name); 2854 if (zhp->zfs_type == ZFS_TYPE_SNAPSHOT) { 2855 nvlist_t *nv = fnvlist_alloc(); 2856 fnvlist_add_boolean(nv, name); 2857 err = lzc_destroy_snaps(nv, defer, NULL); 2858 fnvlist_free(nv); 2859 } else { 2860 err = lzc_destroy(name); 2861 } 2862 if (err == 0) { 2863 if (flags->verbose) 2864 (void) printf("success\n"); 2865 changelist_remove(clp, name); 2866 } 2867 2868 (void) changelist_postfix(clp); 2869 changelist_free(clp); 2870 2871 /* 2872 * Deferred destroy might destroy the snapshot or only mark it to be 2873 * destroyed later, and it returns success in either case. 2874 */ 2875 if (err != 0 || (defer && zfs_dataset_exists(hdl, name, 2876 ZFS_TYPE_SNAPSHOT))) { 2877 err = recv_rename(hdl, name, NULL, baselen, newname, flags); 2878 } 2879 2880 return (err); 2881 } 2882 2883 typedef struct guid_to_name_data { 2884 uint64_t guid; 2885 boolean_t bookmark_ok; 2886 char *name; 2887 char *skip; 2888 uint64_t *redact_snap_guids; 2889 uint64_t num_redact_snaps; 2890 } guid_to_name_data_t; 2891 2892 static boolean_t 2893 redact_snaps_match(zfs_handle_t *zhp, guid_to_name_data_t *gtnd) 2894 { 2895 uint64_t *bmark_snaps; 2896 uint_t bmark_num_snaps; 2897 nvlist_t *nvl; 2898 if (zhp->zfs_type != ZFS_TYPE_BOOKMARK) 2899 return (B_FALSE); 2900 2901 nvl = fnvlist_lookup_nvlist(zhp->zfs_props, 2902 zfs_prop_to_name(ZFS_PROP_REDACT_SNAPS)); 2903 bmark_snaps = fnvlist_lookup_uint64_array(nvl, ZPROP_VALUE, 2904 &bmark_num_snaps); 2905 if (bmark_num_snaps != gtnd->num_redact_snaps) 2906 return (B_FALSE); 2907 int i = 0; 2908 for (; i < bmark_num_snaps; i++) { 2909 int j = 0; 2910 for (; j < bmark_num_snaps; j++) { 2911 if (bmark_snaps[i] == gtnd->redact_snap_guids[j]) 2912 break; 2913 } 2914 if (j == bmark_num_snaps) 2915 break; 2916 } 2917 return (i == bmark_num_snaps); 2918 } 2919 2920 static int 2921 guid_to_name_cb(zfs_handle_t *zhp, void *arg) 2922 { 2923 guid_to_name_data_t *gtnd = arg; 2924 const char *slash; 2925 int err; 2926 2927 if (gtnd->skip != NULL && 2928 (slash = strrchr(zhp->zfs_name, '/')) != NULL && 2929 strcmp(slash + 1, gtnd->skip) == 0) { 2930 zfs_close(zhp); 2931 return (0); 2932 } 2933 2934 if (zfs_prop_get_int(zhp, ZFS_PROP_GUID) == gtnd->guid && 2935 (gtnd->num_redact_snaps == -1 || redact_snaps_match(zhp, gtnd))) { 2936 (void) strcpy(gtnd->name, zhp->zfs_name); 2937 zfs_close(zhp); 2938 return (EEXIST); 2939 } 2940 2941 err = zfs_iter_children(zhp, guid_to_name_cb, gtnd); 2942 if (err != EEXIST && gtnd->bookmark_ok) 2943 err = zfs_iter_bookmarks(zhp, guid_to_name_cb, gtnd); 2944 zfs_close(zhp); 2945 return (err); 2946 } 2947 2948 /* 2949 * Attempt to find the local dataset associated with this guid. In the case of 2950 * multiple matches, we attempt to find the "best" match by searching 2951 * progressively larger portions of the hierarchy. This allows one to send a 2952 * tree of datasets individually and guarantee that we will find the source 2953 * guid within that hierarchy, even if there are multiple matches elsewhere. 2954 * 2955 * If num_redact_snaps is not -1, we attempt to find a redaction bookmark with 2956 * the specified number of redaction snapshots. If num_redact_snaps isn't 0 or 2957 * -1, then redact_snap_guids will be an array of the guids of the snapshots the 2958 * redaction bookmark was created with. If num_redact_snaps is -1, then we will 2959 * attempt to find a snapshot or bookmark (if bookmark_ok is passed) with the 2960 * given guid. Note that a redaction bookmark can be returned if 2961 * num_redact_snaps == -1. 2962 */ 2963 static int 2964 guid_to_name_redact_snaps(libzfs_handle_t *hdl, const char *parent, 2965 uint64_t guid, boolean_t bookmark_ok, uint64_t *redact_snap_guids, 2966 uint64_t num_redact_snaps, char *name) 2967 { 2968 char pname[ZFS_MAX_DATASET_NAME_LEN]; 2969 guid_to_name_data_t gtnd; 2970 2971 gtnd.guid = guid; 2972 gtnd.bookmark_ok = bookmark_ok; 2973 gtnd.name = name; 2974 gtnd.skip = NULL; 2975 gtnd.redact_snap_guids = redact_snap_guids; 2976 gtnd.num_redact_snaps = num_redact_snaps; 2977 2978 /* 2979 * Search progressively larger portions of the hierarchy, starting 2980 * with the filesystem specified by 'parent'. This will 2981 * select the "most local" version of the origin snapshot in the case 2982 * that there are multiple matching snapshots in the system. 2983 */ 2984 (void) strlcpy(pname, parent, sizeof (pname)); 2985 char *cp = strrchr(pname, '@'); 2986 if (cp == NULL) 2987 cp = strchr(pname, '\0'); 2988 for (; cp != NULL; cp = strrchr(pname, '/')) { 2989 /* Chop off the last component and open the parent */ 2990 *cp = '\0'; 2991 zfs_handle_t *zhp = make_dataset_handle(hdl, pname); 2992 2993 if (zhp == NULL) 2994 continue; 2995 int err = guid_to_name_cb(zfs_handle_dup(zhp), >nd); 2996 if (err != EEXIST) 2997 err = zfs_iter_children(zhp, guid_to_name_cb, >nd); 2998 if (err != EEXIST && bookmark_ok) 2999 err = zfs_iter_bookmarks(zhp, guid_to_name_cb, >nd); 3000 zfs_close(zhp); 3001 if (err == EEXIST) 3002 return (0); 3003 3004 /* 3005 * Remember the last portion of the dataset so we skip it next 3006 * time through (as we've already searched that portion of the 3007 * hierarchy). 3008 */ 3009 gtnd.skip = strrchr(pname, '/') + 1; 3010 } 3011 3012 return (ENOENT); 3013 } 3014 3015 static int 3016 guid_to_name(libzfs_handle_t *hdl, const char *parent, uint64_t guid, 3017 boolean_t bookmark_ok, char *name) 3018 { 3019 return (guid_to_name_redact_snaps(hdl, parent, guid, bookmark_ok, NULL, 3020 -1, name)); 3021 } 3022 3023 /* 3024 * Return +1 if guid1 is before guid2, 0 if they are the same, and -1 if 3025 * guid1 is after guid2. 3026 */ 3027 static int 3028 created_before(libzfs_handle_t *hdl, avl_tree_t *avl, 3029 uint64_t guid1, uint64_t guid2) 3030 { 3031 nvlist_t *nvfs; 3032 char *fsname = NULL, *snapname = NULL; 3033 char buf[ZFS_MAX_DATASET_NAME_LEN]; 3034 int rv; 3035 zfs_handle_t *guid1hdl, *guid2hdl; 3036 uint64_t create1, create2; 3037 3038 if (guid2 == 0) 3039 return (0); 3040 if (guid1 == 0) 3041 return (1); 3042 3043 nvfs = fsavl_find(avl, guid1, &snapname); 3044 VERIFY(0 == nvlist_lookup_string(nvfs, "name", &fsname)); 3045 (void) snprintf(buf, sizeof (buf), "%s@%s", fsname, snapname); 3046 guid1hdl = zfs_open(hdl, buf, ZFS_TYPE_SNAPSHOT); 3047 if (guid1hdl == NULL) 3048 return (-1); 3049 3050 nvfs = fsavl_find(avl, guid2, &snapname); 3051 VERIFY(0 == nvlist_lookup_string(nvfs, "name", &fsname)); 3052 (void) snprintf(buf, sizeof (buf), "%s@%s", fsname, snapname); 3053 guid2hdl = zfs_open(hdl, buf, ZFS_TYPE_SNAPSHOT); 3054 if (guid2hdl == NULL) { 3055 zfs_close(guid1hdl); 3056 return (-1); 3057 } 3058 3059 create1 = zfs_prop_get_int(guid1hdl, ZFS_PROP_CREATETXG); 3060 create2 = zfs_prop_get_int(guid2hdl, ZFS_PROP_CREATETXG); 3061 3062 if (create1 < create2) 3063 rv = -1; 3064 else if (create1 > create2) 3065 rv = +1; 3066 else 3067 rv = 0; 3068 3069 zfs_close(guid1hdl); 3070 zfs_close(guid2hdl); 3071 3072 return (rv); 3073 } 3074 3075 /* 3076 * This function reestablishes the hierarchy of encryption roots after a 3077 * recursive incremental receive has completed. This must be done after the 3078 * second call to recv_incremental_replication() has renamed and promoted all 3079 * sent datasets to their final locations in the dataset hierarchy. 3080 */ 3081 static int 3082 recv_fix_encryption_hierarchy(libzfs_handle_t *hdl, const char *top_zfs, 3083 nvlist_t *stream_nv, avl_tree_t *stream_avl) 3084 { 3085 int err; 3086 nvpair_t *fselem = NULL; 3087 nvlist_t *stream_fss; 3088 3089 VERIFY(0 == nvlist_lookup_nvlist(stream_nv, "fss", &stream_fss)); 3090 3091 while ((fselem = nvlist_next_nvpair(stream_fss, fselem)) != NULL) { 3092 zfs_handle_t *zhp = NULL; 3093 uint64_t crypt; 3094 nvlist_t *snaps, *props, *stream_nvfs = NULL; 3095 nvpair_t *snapel = NULL; 3096 boolean_t is_encroot, is_clone, stream_encroot; 3097 char *cp; 3098 char *stream_keylocation = NULL; 3099 char keylocation[MAXNAMELEN]; 3100 char fsname[ZFS_MAX_DATASET_NAME_LEN]; 3101 3102 keylocation[0] = '\0'; 3103 VERIFY(0 == nvpair_value_nvlist(fselem, &stream_nvfs)); 3104 VERIFY(0 == nvlist_lookup_nvlist(stream_nvfs, "snaps", &snaps)); 3105 VERIFY(0 == nvlist_lookup_nvlist(stream_nvfs, "props", &props)); 3106 stream_encroot = nvlist_exists(stream_nvfs, "is_encroot"); 3107 3108 /* find a snapshot from the stream that exists locally */ 3109 err = ENOENT; 3110 while ((snapel = nvlist_next_nvpair(snaps, snapel)) != NULL) { 3111 uint64_t guid; 3112 3113 VERIFY(0 == nvpair_value_uint64(snapel, &guid)); 3114 err = guid_to_name(hdl, top_zfs, guid, B_FALSE, 3115 fsname); 3116 if (err == 0) 3117 break; 3118 } 3119 3120 if (err != 0) 3121 continue; 3122 3123 cp = strchr(fsname, '@'); 3124 if (cp != NULL) 3125 *cp = '\0'; 3126 3127 zhp = zfs_open(hdl, fsname, ZFS_TYPE_DATASET); 3128 if (zhp == NULL) { 3129 err = ENOENT; 3130 goto error; 3131 } 3132 3133 crypt = zfs_prop_get_int(zhp, ZFS_PROP_ENCRYPTION); 3134 is_clone = zhp->zfs_dmustats.dds_origin[0] != '\0'; 3135 (void) zfs_crypto_get_encryption_root(zhp, &is_encroot, NULL); 3136 3137 /* we don't need to do anything for unencrypted datasets */ 3138 if (crypt == ZIO_CRYPT_OFF) { 3139 zfs_close(zhp); 3140 continue; 3141 } 3142 3143 /* 3144 * If the dataset is flagged as an encryption root, was not 3145 * received as a clone and is not currently an encryption root, 3146 * force it to become one. Fixup the keylocation if necessary. 3147 */ 3148 if (stream_encroot) { 3149 if (!is_clone && !is_encroot) { 3150 err = lzc_change_key(fsname, 3151 DCP_CMD_FORCE_NEW_KEY, NULL, NULL, 0); 3152 if (err != 0) { 3153 zfs_close(zhp); 3154 goto error; 3155 } 3156 } 3157 3158 VERIFY(0 == nvlist_lookup_string(props, 3159 zfs_prop_to_name(ZFS_PROP_KEYLOCATION), 3160 &stream_keylocation)); 3161 3162 /* 3163 * Refresh the properties in case the call to 3164 * lzc_change_key() changed the value. 3165 */ 3166 zfs_refresh_properties(zhp); 3167 err = zfs_prop_get(zhp, ZFS_PROP_KEYLOCATION, 3168 keylocation, sizeof (keylocation), NULL, NULL, 3169 0, B_TRUE); 3170 if (err != 0) { 3171 zfs_close(zhp); 3172 goto error; 3173 } 3174 3175 if (strcmp(keylocation, stream_keylocation) != 0) { 3176 err = zfs_prop_set(zhp, 3177 zfs_prop_to_name(ZFS_PROP_KEYLOCATION), 3178 stream_keylocation); 3179 if (err != 0) { 3180 zfs_close(zhp); 3181 goto error; 3182 } 3183 } 3184 } 3185 3186 /* 3187 * If the dataset is not flagged as an encryption root and is 3188 * currently an encryption root, force it to inherit from its 3189 * parent. The root of a raw send should never be 3190 * force-inherited. 3191 */ 3192 if (!stream_encroot && is_encroot && 3193 strcmp(top_zfs, fsname) != 0) { 3194 err = lzc_change_key(fsname, DCP_CMD_FORCE_INHERIT, 3195 NULL, NULL, 0); 3196 if (err != 0) { 3197 zfs_close(zhp); 3198 goto error; 3199 } 3200 } 3201 3202 zfs_close(zhp); 3203 } 3204 3205 return (0); 3206 3207 error: 3208 return (err); 3209 } 3210 3211 static int 3212 recv_incremental_replication(libzfs_handle_t *hdl, const char *tofs, 3213 recvflags_t *flags, nvlist_t *stream_nv, avl_tree_t *stream_avl, 3214 nvlist_t *renamed) 3215 { 3216 nvlist_t *local_nv, *deleted = NULL; 3217 avl_tree_t *local_avl; 3218 nvpair_t *fselem, *nextfselem; 3219 char *fromsnap; 3220 char newname[ZFS_MAX_DATASET_NAME_LEN]; 3221 char guidname[32]; 3222 int error; 3223 boolean_t needagain, progress, recursive; 3224 char *s1, *s2; 3225 3226 VERIFY(0 == nvlist_lookup_string(stream_nv, "fromsnap", &fromsnap)); 3227 3228 recursive = (nvlist_lookup_boolean(stream_nv, "not_recursive") == 3229 ENOENT); 3230 3231 if (flags->dryrun) 3232 return (0); 3233 3234 again: 3235 needagain = progress = B_FALSE; 3236 3237 VERIFY(0 == nvlist_alloc(&deleted, NV_UNIQUE_NAME, 0)); 3238 3239 if ((error = gather_nvlist(hdl, tofs, fromsnap, NULL, 3240 recursive, B_TRUE, B_FALSE, recursive, B_FALSE, B_FALSE, 3241 B_FALSE, B_TRUE, &local_nv, &local_avl)) != 0) 3242 return (error); 3243 3244 /* 3245 * Process deletes and renames 3246 */ 3247 for (fselem = nvlist_next_nvpair(local_nv, NULL); 3248 fselem; fselem = nextfselem) { 3249 nvlist_t *nvfs, *snaps; 3250 nvlist_t *stream_nvfs = NULL; 3251 nvpair_t *snapelem, *nextsnapelem; 3252 uint64_t fromguid = 0; 3253 uint64_t originguid = 0; 3254 uint64_t stream_originguid = 0; 3255 uint64_t parent_fromsnap_guid, stream_parent_fromsnap_guid; 3256 char *fsname, *stream_fsname; 3257 3258 nextfselem = nvlist_next_nvpair(local_nv, fselem); 3259 3260 VERIFY(0 == nvpair_value_nvlist(fselem, &nvfs)); 3261 VERIFY(0 == nvlist_lookup_nvlist(nvfs, "snaps", &snaps)); 3262 VERIFY(0 == nvlist_lookup_string(nvfs, "name", &fsname)); 3263 VERIFY(0 == nvlist_lookup_uint64(nvfs, "parentfromsnap", 3264 &parent_fromsnap_guid)); 3265 (void) nvlist_lookup_uint64(nvfs, "origin", &originguid); 3266 3267 /* 3268 * First find the stream's fs, so we can check for 3269 * a different origin (due to "zfs promote") 3270 */ 3271 for (snapelem = nvlist_next_nvpair(snaps, NULL); 3272 snapelem; snapelem = nvlist_next_nvpair(snaps, snapelem)) { 3273 uint64_t thisguid; 3274 3275 VERIFY(0 == nvpair_value_uint64(snapelem, &thisguid)); 3276 stream_nvfs = fsavl_find(stream_avl, thisguid, NULL); 3277 3278 if (stream_nvfs != NULL) 3279 break; 3280 } 3281 3282 /* check for promote */ 3283 (void) nvlist_lookup_uint64(stream_nvfs, "origin", 3284 &stream_originguid); 3285 if (stream_nvfs && originguid != stream_originguid) { 3286 switch (created_before(hdl, local_avl, 3287 stream_originguid, originguid)) { 3288 case 1: { 3289 /* promote it! */ 3290 nvlist_t *origin_nvfs; 3291 char *origin_fsname; 3292 3293 origin_nvfs = fsavl_find(local_avl, originguid, 3294 NULL); 3295 VERIFY(0 == nvlist_lookup_string(origin_nvfs, 3296 "name", &origin_fsname)); 3297 error = recv_promote(hdl, fsname, origin_fsname, 3298 flags); 3299 if (error == 0) 3300 progress = B_TRUE; 3301 break; 3302 } 3303 default: 3304 break; 3305 case -1: 3306 fsavl_destroy(local_avl); 3307 nvlist_free(local_nv); 3308 return (-1); 3309 } 3310 /* 3311 * We had/have the wrong origin, therefore our 3312 * list of snapshots is wrong. Need to handle 3313 * them on the next pass. 3314 */ 3315 needagain = B_TRUE; 3316 continue; 3317 } 3318 3319 for (snapelem = nvlist_next_nvpair(snaps, NULL); 3320 snapelem; snapelem = nextsnapelem) { 3321 uint64_t thisguid; 3322 char *stream_snapname; 3323 nvlist_t *found, *props; 3324 3325 nextsnapelem = nvlist_next_nvpair(snaps, snapelem); 3326 3327 VERIFY(0 == nvpair_value_uint64(snapelem, &thisguid)); 3328 found = fsavl_find(stream_avl, thisguid, 3329 &stream_snapname); 3330 3331 /* check for delete */ 3332 if (found == NULL) { 3333 char name[ZFS_MAX_DATASET_NAME_LEN]; 3334 3335 if (!flags->force) 3336 continue; 3337 3338 (void) snprintf(name, sizeof (name), "%s@%s", 3339 fsname, nvpair_name(snapelem)); 3340 3341 error = recv_destroy(hdl, name, 3342 strlen(fsname)+1, newname, flags); 3343 if (error) 3344 needagain = B_TRUE; 3345 else 3346 progress = B_TRUE; 3347 sprintf(guidname, "%llu", 3348 (u_longlong_t)thisguid); 3349 nvlist_add_boolean(deleted, guidname); 3350 continue; 3351 } 3352 3353 stream_nvfs = found; 3354 3355 if (0 == nvlist_lookup_nvlist(stream_nvfs, "snapprops", 3356 &props) && 0 == nvlist_lookup_nvlist(props, 3357 stream_snapname, &props)) { 3358 zfs_cmd_t zc = {"\0"}; 3359 3360 zc.zc_cookie = B_TRUE; /* received */ 3361 (void) snprintf(zc.zc_name, sizeof (zc.zc_name), 3362 "%s@%s", fsname, nvpair_name(snapelem)); 3363 if (zcmd_write_src_nvlist(hdl, &zc, 3364 props) == 0) { 3365 (void) zfs_ioctl(hdl, 3366 ZFS_IOC_SET_PROP, &zc); 3367 zcmd_free_nvlists(&zc); 3368 } 3369 } 3370 3371 /* check for different snapname */ 3372 if (strcmp(nvpair_name(snapelem), 3373 stream_snapname) != 0) { 3374 char name[ZFS_MAX_DATASET_NAME_LEN]; 3375 char tryname[ZFS_MAX_DATASET_NAME_LEN]; 3376 3377 (void) snprintf(name, sizeof (name), "%s@%s", 3378 fsname, nvpair_name(snapelem)); 3379 (void) snprintf(tryname, sizeof (name), "%s@%s", 3380 fsname, stream_snapname); 3381 3382 error = recv_rename(hdl, name, tryname, 3383 strlen(fsname)+1, newname, flags); 3384 if (error) 3385 needagain = B_TRUE; 3386 else 3387 progress = B_TRUE; 3388 } 3389 3390 if (strcmp(stream_snapname, fromsnap) == 0) 3391 fromguid = thisguid; 3392 } 3393 3394 /* check for delete */ 3395 if (stream_nvfs == NULL) { 3396 if (!flags->force) 3397 continue; 3398 3399 error = recv_destroy(hdl, fsname, strlen(tofs)+1, 3400 newname, flags); 3401 if (error) 3402 needagain = B_TRUE; 3403 else 3404 progress = B_TRUE; 3405 sprintf(guidname, "%llu", 3406 (u_longlong_t)parent_fromsnap_guid); 3407 nvlist_add_boolean(deleted, guidname); 3408 continue; 3409 } 3410 3411 if (fromguid == 0) { 3412 if (flags->verbose) { 3413 (void) printf("local fs %s does not have " 3414 "fromsnap (%s in stream); must have " 3415 "been deleted locally; ignoring\n", 3416 fsname, fromsnap); 3417 } 3418 continue; 3419 } 3420 3421 VERIFY(0 == nvlist_lookup_string(stream_nvfs, 3422 "name", &stream_fsname)); 3423 VERIFY(0 == nvlist_lookup_uint64(stream_nvfs, 3424 "parentfromsnap", &stream_parent_fromsnap_guid)); 3425 3426 s1 = strrchr(fsname, '/'); 3427 s2 = strrchr(stream_fsname, '/'); 3428 3429 /* 3430 * Check if we're going to rename based on parent guid change 3431 * and the current parent guid was also deleted. If it was then 3432 * rename will fail and is likely unneeded, so avoid this and 3433 * force an early retry to determine the new 3434 * parent_fromsnap_guid. 3435 */ 3436 if (stream_parent_fromsnap_guid != 0 && 3437 parent_fromsnap_guid != 0 && 3438 stream_parent_fromsnap_guid != parent_fromsnap_guid) { 3439 sprintf(guidname, "%llu", 3440 (u_longlong_t)parent_fromsnap_guid); 3441 if (nvlist_exists(deleted, guidname)) { 3442 progress = B_TRUE; 3443 needagain = B_TRUE; 3444 goto doagain; 3445 } 3446 } 3447 3448 /* 3449 * Check for rename. If the exact receive path is specified, it 3450 * does not count as a rename, but we still need to check the 3451 * datasets beneath it. 3452 */ 3453 if ((stream_parent_fromsnap_guid != 0 && 3454 parent_fromsnap_guid != 0 && 3455 stream_parent_fromsnap_guid != parent_fromsnap_guid) || 3456 ((flags->isprefix || strcmp(tofs, fsname) != 0) && 3457 (s1 != NULL) && (s2 != NULL) && strcmp(s1, s2) != 0)) { 3458 nvlist_t *parent; 3459 char tryname[ZFS_MAX_DATASET_NAME_LEN]; 3460 3461 parent = fsavl_find(local_avl, 3462 stream_parent_fromsnap_guid, NULL); 3463 /* 3464 * NB: parent might not be found if we used the 3465 * tosnap for stream_parent_fromsnap_guid, 3466 * because the parent is a newly-created fs; 3467 * we'll be able to rename it after we recv the 3468 * new fs. 3469 */ 3470 if (parent != NULL) { 3471 char *pname; 3472 3473 VERIFY(0 == nvlist_lookup_string(parent, "name", 3474 &pname)); 3475 (void) snprintf(tryname, sizeof (tryname), 3476 "%s%s", pname, strrchr(stream_fsname, '/')); 3477 } else { 3478 tryname[0] = '\0'; 3479 if (flags->verbose) { 3480 (void) printf("local fs %s new parent " 3481 "not found\n", fsname); 3482 } 3483 } 3484 3485 newname[0] = '\0'; 3486 3487 error = recv_rename(hdl, fsname, tryname, 3488 strlen(tofs)+1, newname, flags); 3489 3490 if (renamed != NULL && newname[0] != '\0') { 3491 VERIFY(0 == nvlist_add_boolean(renamed, 3492 newname)); 3493 } 3494 3495 if (error) 3496 needagain = B_TRUE; 3497 else 3498 progress = B_TRUE; 3499 } 3500 } 3501 3502 doagain: 3503 fsavl_destroy(local_avl); 3504 nvlist_free(local_nv); 3505 nvlist_free(deleted); 3506 3507 if (needagain && progress) { 3508 /* do another pass to fix up temporary names */ 3509 if (flags->verbose) 3510 (void) printf("another pass:\n"); 3511 goto again; 3512 } 3513 3514 return (needagain || error != 0); 3515 } 3516 3517 static int 3518 zfs_receive_package(libzfs_handle_t *hdl, int fd, const char *destname, 3519 recvflags_t *flags, dmu_replay_record_t *drr, zio_cksum_t *zc, 3520 char **top_zfs, nvlist_t *cmdprops) 3521 { 3522 nvlist_t *stream_nv = NULL; 3523 avl_tree_t *stream_avl = NULL; 3524 char *fromsnap = NULL; 3525 char *sendsnap = NULL; 3526 char *cp; 3527 char tofs[ZFS_MAX_DATASET_NAME_LEN]; 3528 char sendfs[ZFS_MAX_DATASET_NAME_LEN]; 3529 char errbuf[1024]; 3530 dmu_replay_record_t drre; 3531 int error; 3532 boolean_t anyerr = B_FALSE; 3533 boolean_t softerr = B_FALSE; 3534 boolean_t recursive, raw; 3535 3536 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN, 3537 "cannot receive")); 3538 3539 assert(drr->drr_type == DRR_BEGIN); 3540 assert(drr->drr_u.drr_begin.drr_magic == DMU_BACKUP_MAGIC); 3541 assert(DMU_GET_STREAM_HDRTYPE(drr->drr_u.drr_begin.drr_versioninfo) == 3542 DMU_COMPOUNDSTREAM); 3543 3544 /* 3545 * Read in the nvlist from the stream. 3546 */ 3547 if (drr->drr_payloadlen != 0) { 3548 error = recv_read_nvlist(hdl, fd, drr->drr_payloadlen, 3549 &stream_nv, flags->byteswap, zc); 3550 if (error) { 3551 error = zfs_error(hdl, EZFS_BADSTREAM, errbuf); 3552 goto out; 3553 } 3554 } 3555 3556 recursive = (nvlist_lookup_boolean(stream_nv, "not_recursive") == 3557 ENOENT); 3558 raw = (nvlist_lookup_boolean(stream_nv, "raw") == 0); 3559 3560 if (recursive && strchr(destname, '@')) { 3561 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 3562 "cannot specify snapshot name for multi-snapshot stream")); 3563 error = zfs_error(hdl, EZFS_BADSTREAM, errbuf); 3564 goto out; 3565 } 3566 3567 /* 3568 * Read in the end record and verify checksum. 3569 */ 3570 if (0 != (error = recv_read(hdl, fd, &drre, sizeof (drre), 3571 flags->byteswap, NULL))) 3572 goto out; 3573 if (flags->byteswap) { 3574 drre.drr_type = BSWAP_32(drre.drr_type); 3575 drre.drr_u.drr_end.drr_checksum.zc_word[0] = 3576 BSWAP_64(drre.drr_u.drr_end.drr_checksum.zc_word[0]); 3577 drre.drr_u.drr_end.drr_checksum.zc_word[1] = 3578 BSWAP_64(drre.drr_u.drr_end.drr_checksum.zc_word[1]); 3579 drre.drr_u.drr_end.drr_checksum.zc_word[2] = 3580 BSWAP_64(drre.drr_u.drr_end.drr_checksum.zc_word[2]); 3581 drre.drr_u.drr_end.drr_checksum.zc_word[3] = 3582 BSWAP_64(drre.drr_u.drr_end.drr_checksum.zc_word[3]); 3583 } 3584 if (drre.drr_type != DRR_END) { 3585 error = zfs_error(hdl, EZFS_BADSTREAM, errbuf); 3586 goto out; 3587 } 3588 if (!ZIO_CHECKSUM_EQUAL(drre.drr_u.drr_end.drr_checksum, *zc)) { 3589 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 3590 "incorrect header checksum")); 3591 error = zfs_error(hdl, EZFS_BADSTREAM, errbuf); 3592 goto out; 3593 } 3594 3595 (void) nvlist_lookup_string(stream_nv, "fromsnap", &fromsnap); 3596 3597 if (drr->drr_payloadlen != 0) { 3598 nvlist_t *stream_fss; 3599 3600 VERIFY(0 == nvlist_lookup_nvlist(stream_nv, "fss", 3601 &stream_fss)); 3602 if ((stream_avl = fsavl_create(stream_fss)) == NULL) { 3603 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 3604 "couldn't allocate avl tree")); 3605 error = zfs_error(hdl, EZFS_NOMEM, errbuf); 3606 goto out; 3607 } 3608 3609 if (fromsnap != NULL && recursive) { 3610 nvlist_t *renamed = NULL; 3611 nvpair_t *pair = NULL; 3612 3613 (void) strlcpy(tofs, destname, sizeof (tofs)); 3614 if (flags->isprefix) { 3615 struct drr_begin *drrb = &drr->drr_u.drr_begin; 3616 int i; 3617 3618 if (flags->istail) { 3619 cp = strrchr(drrb->drr_toname, '/'); 3620 if (cp == NULL) { 3621 (void) strlcat(tofs, "/", 3622 sizeof (tofs)); 3623 i = 0; 3624 } else { 3625 i = (cp - drrb->drr_toname); 3626 } 3627 } else { 3628 i = strcspn(drrb->drr_toname, "/@"); 3629 } 3630 /* zfs_receive_one() will create_parents() */ 3631 (void) strlcat(tofs, &drrb->drr_toname[i], 3632 sizeof (tofs)); 3633 *strchr(tofs, '@') = '\0'; 3634 } 3635 3636 if (!flags->dryrun && !flags->nomount) { 3637 VERIFY(0 == nvlist_alloc(&renamed, 3638 NV_UNIQUE_NAME, 0)); 3639 } 3640 3641 softerr = recv_incremental_replication(hdl, tofs, flags, 3642 stream_nv, stream_avl, renamed); 3643 3644 /* Unmount renamed filesystems before receiving. */ 3645 while ((pair = nvlist_next_nvpair(renamed, 3646 pair)) != NULL) { 3647 zfs_handle_t *zhp; 3648 prop_changelist_t *clp = NULL; 3649 3650 zhp = zfs_open(hdl, nvpair_name(pair), 3651 ZFS_TYPE_FILESYSTEM); 3652 if (zhp != NULL) { 3653 clp = changelist_gather(zhp, 3654 ZFS_PROP_MOUNTPOINT, 0, 3655 flags->forceunmount ? MS_FORCE : 0); 3656 zfs_close(zhp); 3657 if (clp != NULL) { 3658 softerr |= 3659 changelist_prefix(clp); 3660 changelist_free(clp); 3661 } 3662 } 3663 } 3664 3665 nvlist_free(renamed); 3666 } 3667 } 3668 3669 /* 3670 * Get the fs specified by the first path in the stream (the top level 3671 * specified by 'zfs send') and pass it to each invocation of 3672 * zfs_receive_one(). 3673 */ 3674 (void) strlcpy(sendfs, drr->drr_u.drr_begin.drr_toname, 3675 sizeof (sendfs)); 3676 if ((cp = strchr(sendfs, '@')) != NULL) { 3677 *cp = '\0'; 3678 /* 3679 * Find the "sendsnap", the final snapshot in a replication 3680 * stream. zfs_receive_one() handles certain errors 3681 * differently, depending on if the contained stream is the 3682 * last one or not. 3683 */ 3684 sendsnap = (cp + 1); 3685 } 3686 3687 /* Finally, receive each contained stream */ 3688 do { 3689 /* 3690 * we should figure out if it has a recoverable 3691 * error, in which case do a recv_skip() and drive on. 3692 * Note, if we fail due to already having this guid, 3693 * zfs_receive_one() will take care of it (ie, 3694 * recv_skip() and return 0). 3695 */ 3696 error = zfs_receive_impl(hdl, destname, NULL, flags, fd, 3697 sendfs, stream_nv, stream_avl, top_zfs, sendsnap, cmdprops); 3698 if (error == ENODATA) { 3699 error = 0; 3700 break; 3701 } 3702 anyerr |= error; 3703 } while (error == 0); 3704 3705 if (drr->drr_payloadlen != 0 && recursive && fromsnap != NULL) { 3706 /* 3707 * Now that we have the fs's they sent us, try the 3708 * renames again. 3709 */ 3710 softerr = recv_incremental_replication(hdl, tofs, flags, 3711 stream_nv, stream_avl, NULL); 3712 } 3713 3714 if (raw && softerr == 0 && *top_zfs != NULL) { 3715 softerr = recv_fix_encryption_hierarchy(hdl, *top_zfs, 3716 stream_nv, stream_avl); 3717 } 3718 3719 out: 3720 fsavl_destroy(stream_avl); 3721 nvlist_free(stream_nv); 3722 if (softerr) 3723 error = -2; 3724 if (anyerr) 3725 error = -1; 3726 return (error); 3727 } 3728 3729 static void 3730 trunc_prop_errs(int truncated) 3731 { 3732 ASSERT(truncated != 0); 3733 3734 if (truncated == 1) 3735 (void) fprintf(stderr, dgettext(TEXT_DOMAIN, 3736 "1 more property could not be set\n")); 3737 else 3738 (void) fprintf(stderr, dgettext(TEXT_DOMAIN, 3739 "%d more properties could not be set\n"), truncated); 3740 } 3741 3742 static int 3743 recv_skip(libzfs_handle_t *hdl, int fd, boolean_t byteswap) 3744 { 3745 dmu_replay_record_t *drr; 3746 void *buf = zfs_alloc(hdl, SPA_MAXBLOCKSIZE); 3747 uint64_t payload_size; 3748 char errbuf[1024]; 3749 3750 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN, 3751 "cannot receive")); 3752 3753 /* XXX would be great to use lseek if possible... */ 3754 drr = buf; 3755 3756 while (recv_read(hdl, fd, drr, sizeof (dmu_replay_record_t), 3757 byteswap, NULL) == 0) { 3758 if (byteswap) 3759 drr->drr_type = BSWAP_32(drr->drr_type); 3760 3761 switch (drr->drr_type) { 3762 case DRR_BEGIN: 3763 if (drr->drr_payloadlen != 0) { 3764 (void) recv_read(hdl, fd, buf, 3765 drr->drr_payloadlen, B_FALSE, NULL); 3766 } 3767 break; 3768 3769 case DRR_END: 3770 free(buf); 3771 return (0); 3772 3773 case DRR_OBJECT: 3774 if (byteswap) { 3775 drr->drr_u.drr_object.drr_bonuslen = 3776 BSWAP_32(drr->drr_u.drr_object. 3777 drr_bonuslen); 3778 drr->drr_u.drr_object.drr_raw_bonuslen = 3779 BSWAP_32(drr->drr_u.drr_object. 3780 drr_raw_bonuslen); 3781 } 3782 3783 payload_size = 3784 DRR_OBJECT_PAYLOAD_SIZE(&drr->drr_u.drr_object); 3785 (void) recv_read(hdl, fd, buf, payload_size, 3786 B_FALSE, NULL); 3787 break; 3788 3789 case DRR_WRITE: 3790 if (byteswap) { 3791 drr->drr_u.drr_write.drr_logical_size = 3792 BSWAP_64( 3793 drr->drr_u.drr_write.drr_logical_size); 3794 drr->drr_u.drr_write.drr_compressed_size = 3795 BSWAP_64( 3796 drr->drr_u.drr_write.drr_compressed_size); 3797 } 3798 payload_size = 3799 DRR_WRITE_PAYLOAD_SIZE(&drr->drr_u.drr_write); 3800 assert(payload_size <= SPA_MAXBLOCKSIZE); 3801 (void) recv_read(hdl, fd, buf, 3802 payload_size, B_FALSE, NULL); 3803 break; 3804 case DRR_SPILL: 3805 if (byteswap) { 3806 drr->drr_u.drr_spill.drr_length = 3807 BSWAP_64(drr->drr_u.drr_spill.drr_length); 3808 drr->drr_u.drr_spill.drr_compressed_size = 3809 BSWAP_64(drr->drr_u.drr_spill. 3810 drr_compressed_size); 3811 } 3812 3813 payload_size = 3814 DRR_SPILL_PAYLOAD_SIZE(&drr->drr_u.drr_spill); 3815 (void) recv_read(hdl, fd, buf, payload_size, 3816 B_FALSE, NULL); 3817 break; 3818 case DRR_WRITE_EMBEDDED: 3819 if (byteswap) { 3820 drr->drr_u.drr_write_embedded.drr_psize = 3821 BSWAP_32(drr->drr_u.drr_write_embedded. 3822 drr_psize); 3823 } 3824 (void) recv_read(hdl, fd, buf, 3825 P2ROUNDUP(drr->drr_u.drr_write_embedded.drr_psize, 3826 8), B_FALSE, NULL); 3827 break; 3828 case DRR_OBJECT_RANGE: 3829 case DRR_WRITE_BYREF: 3830 case DRR_FREEOBJECTS: 3831 case DRR_FREE: 3832 break; 3833 3834 default: 3835 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 3836 "invalid record type")); 3837 free(buf); 3838 return (zfs_error(hdl, EZFS_BADSTREAM, errbuf)); 3839 } 3840 } 3841 3842 free(buf); 3843 return (-1); 3844 } 3845 3846 static void 3847 recv_ecksum_set_aux(libzfs_handle_t *hdl, const char *target_snap, 3848 boolean_t resumable, boolean_t checksum) 3849 { 3850 char target_fs[ZFS_MAX_DATASET_NAME_LEN]; 3851 3852 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, (checksum ? 3853 "checksum mismatch" : "incomplete stream"))); 3854 3855 if (!resumable) 3856 return; 3857 (void) strlcpy(target_fs, target_snap, sizeof (target_fs)); 3858 *strchr(target_fs, '@') = '\0'; 3859 zfs_handle_t *zhp = zfs_open(hdl, target_fs, 3860 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME); 3861 if (zhp == NULL) 3862 return; 3863 3864 char token_buf[ZFS_MAXPROPLEN]; 3865 int error = zfs_prop_get(zhp, ZFS_PROP_RECEIVE_RESUME_TOKEN, 3866 token_buf, sizeof (token_buf), 3867 NULL, NULL, 0, B_TRUE); 3868 if (error == 0) { 3869 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 3870 "checksum mismatch or incomplete stream.\n" 3871 "Partially received snapshot is saved.\n" 3872 "A resuming stream can be generated on the sending " 3873 "system by running:\n" 3874 " zfs send -t %s"), 3875 token_buf); 3876 } 3877 zfs_close(zhp); 3878 } 3879 3880 /* 3881 * Prepare a new nvlist of properties that are to override (-o) or be excluded 3882 * (-x) from the received dataset 3883 * recvprops: received properties from the send stream 3884 * cmdprops: raw input properties from command line 3885 * origprops: properties, both locally-set and received, currently set on the 3886 * target dataset if it exists, NULL otherwise. 3887 * oxprops: valid output override (-o) and excluded (-x) properties 3888 */ 3889 static int 3890 zfs_setup_cmdline_props(libzfs_handle_t *hdl, zfs_type_t type, 3891 char *fsname, boolean_t zoned, boolean_t recursive, boolean_t newfs, 3892 boolean_t raw, boolean_t toplevel, nvlist_t *recvprops, nvlist_t *cmdprops, 3893 nvlist_t *origprops, nvlist_t **oxprops, uint8_t **wkeydata_out, 3894 uint_t *wkeylen_out, const char *errbuf) 3895 { 3896 nvpair_t *nvp; 3897 nvlist_t *oprops, *voprops; 3898 zfs_handle_t *zhp = NULL; 3899 zpool_handle_t *zpool_hdl = NULL; 3900 char *cp; 3901 int ret = 0; 3902 char namebuf[ZFS_MAX_DATASET_NAME_LEN]; 3903 3904 if (nvlist_empty(cmdprops)) 3905 return (0); /* No properties to override or exclude */ 3906 3907 *oxprops = fnvlist_alloc(); 3908 oprops = fnvlist_alloc(); 3909 3910 strlcpy(namebuf, fsname, ZFS_MAX_DATASET_NAME_LEN); 3911 3912 /* 3913 * Get our dataset handle. The target dataset may not exist yet. 3914 */ 3915 if (zfs_dataset_exists(hdl, namebuf, ZFS_TYPE_DATASET)) { 3916 zhp = zfs_open(hdl, namebuf, ZFS_TYPE_DATASET); 3917 if (zhp == NULL) { 3918 ret = -1; 3919 goto error; 3920 } 3921 } 3922 3923 /* open the zpool handle */ 3924 cp = strchr(namebuf, '/'); 3925 if (cp != NULL) 3926 *cp = '\0'; 3927 zpool_hdl = zpool_open(hdl, namebuf); 3928 if (zpool_hdl == NULL) { 3929 ret = -1; 3930 goto error; 3931 } 3932 3933 /* restore namebuf to match fsname for later use */ 3934 if (cp != NULL) 3935 *cp = '/'; 3936 3937 /* 3938 * first iteration: process excluded (-x) properties now and gather 3939 * added (-o) properties to be later processed by zfs_valid_proplist() 3940 */ 3941 nvp = NULL; 3942 while ((nvp = nvlist_next_nvpair(cmdprops, nvp)) != NULL) { 3943 const char *name = nvpair_name(nvp); 3944 zfs_prop_t prop = zfs_name_to_prop(name); 3945 3946 /* "origin" is processed separately, don't handle it here */ 3947 if (prop == ZFS_PROP_ORIGIN) 3948 continue; 3949 3950 /* 3951 * we're trying to override or exclude a property that does not 3952 * make sense for this type of dataset, but we don't want to 3953 * fail if the receive is recursive: this comes in handy when 3954 * the send stream contains, for instance, a child ZVOL and 3955 * we're trying to receive it with "-o atime=on" 3956 */ 3957 if (!zfs_prop_valid_for_type(prop, type, B_FALSE) && 3958 !zfs_prop_user(name)) { 3959 if (recursive) 3960 continue; 3961 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 3962 "property '%s' does not apply to datasets of this " 3963 "type"), name); 3964 ret = zfs_error(hdl, EZFS_BADPROP, errbuf); 3965 goto error; 3966 } 3967 3968 /* raw streams can't override encryption properties */ 3969 if ((zfs_prop_encryption_key_param(prop) || 3970 prop == ZFS_PROP_ENCRYPTION) && raw) { 3971 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 3972 "encryption property '%s' cannot " 3973 "be set or excluded for raw streams."), name); 3974 ret = zfs_error(hdl, EZFS_BADPROP, errbuf); 3975 goto error; 3976 } 3977 3978 /* incremental streams can only exclude encryption properties */ 3979 if ((zfs_prop_encryption_key_param(prop) || 3980 prop == ZFS_PROP_ENCRYPTION) && !newfs && 3981 nvpair_type(nvp) != DATA_TYPE_BOOLEAN) { 3982 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 3983 "encryption property '%s' cannot " 3984 "be set for incremental streams."), name); 3985 ret = zfs_error(hdl, EZFS_BADPROP, errbuf); 3986 goto error; 3987 } 3988 3989 switch (nvpair_type(nvp)) { 3990 case DATA_TYPE_BOOLEAN: /* -x property */ 3991 /* 3992 * DATA_TYPE_BOOLEAN is the way we're asked to "exclude" 3993 * a property: this is done by forcing an explicit 3994 * inherit on the destination so the effective value is 3995 * not the one we received from the send stream. 3996 * We do this only if the property is not already 3997 * locally-set, in which case its value will take 3998 * priority over the received anyway. 3999 */ 4000 if (nvlist_exists(origprops, name)) { 4001 nvlist_t *attrs; 4002 char *source = NULL; 4003 4004 attrs = fnvlist_lookup_nvlist(origprops, name); 4005 if (nvlist_lookup_string(attrs, 4006 ZPROP_SOURCE, &source) == 0 && 4007 strcmp(source, ZPROP_SOURCE_VAL_RECVD) != 0) 4008 continue; 4009 } 4010 /* 4011 * We can't force an explicit inherit on non-inheritable 4012 * properties: if we're asked to exclude this kind of 4013 * values we remove them from "recvprops" input nvlist. 4014 */ 4015 if (!zfs_prop_inheritable(prop) && 4016 !zfs_prop_user(name) && /* can be inherited too */ 4017 nvlist_exists(recvprops, name)) 4018 fnvlist_remove(recvprops, name); 4019 else 4020 fnvlist_add_nvpair(*oxprops, nvp); 4021 break; 4022 case DATA_TYPE_STRING: /* -o property=value */ 4023 fnvlist_add_nvpair(oprops, nvp); 4024 break; 4025 default: 4026 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 4027 "property '%s' must be a string or boolean"), name); 4028 ret = zfs_error(hdl, EZFS_BADPROP, errbuf); 4029 goto error; 4030 } 4031 } 4032 4033 if (toplevel) { 4034 /* convert override strings properties to native */ 4035 if ((voprops = zfs_valid_proplist(hdl, ZFS_TYPE_DATASET, 4036 oprops, zoned, zhp, zpool_hdl, B_FALSE, errbuf)) == NULL) { 4037 ret = zfs_error(hdl, EZFS_BADPROP, errbuf); 4038 goto error; 4039 } 4040 4041 /* 4042 * zfs_crypto_create() requires the parent name. Get it 4043 * by truncating the fsname copy stored in namebuf. 4044 */ 4045 cp = strrchr(namebuf, '/'); 4046 if (cp != NULL) 4047 *cp = '\0'; 4048 4049 if (!raw && zfs_crypto_create(hdl, namebuf, voprops, NULL, 4050 B_FALSE, wkeydata_out, wkeylen_out) != 0) { 4051 fnvlist_free(voprops); 4052 ret = zfs_error(hdl, EZFS_CRYPTOFAILED, errbuf); 4053 goto error; 4054 } 4055 4056 /* second pass: process "-o" properties */ 4057 fnvlist_merge(*oxprops, voprops); 4058 fnvlist_free(voprops); 4059 } else { 4060 /* override props on child dataset are inherited */ 4061 nvp = NULL; 4062 while ((nvp = nvlist_next_nvpair(oprops, nvp)) != NULL) { 4063 const char *name = nvpair_name(nvp); 4064 fnvlist_add_boolean(*oxprops, name); 4065 } 4066 } 4067 4068 error: 4069 if (zhp != NULL) 4070 zfs_close(zhp); 4071 if (zpool_hdl != NULL) 4072 zpool_close(zpool_hdl); 4073 fnvlist_free(oprops); 4074 return (ret); 4075 } 4076 4077 /* 4078 * Restores a backup of tosnap from the file descriptor specified by infd. 4079 */ 4080 static int 4081 zfs_receive_one(libzfs_handle_t *hdl, int infd, const char *tosnap, 4082 const char *originsnap, recvflags_t *flags, dmu_replay_record_t *drr, 4083 dmu_replay_record_t *drr_noswap, const char *sendfs, nvlist_t *stream_nv, 4084 avl_tree_t *stream_avl, char **top_zfs, 4085 const char *finalsnap, nvlist_t *cmdprops) 4086 { 4087 time_t begin_time; 4088 int ioctl_err, ioctl_errno, err; 4089 char *cp; 4090 struct drr_begin *drrb = &drr->drr_u.drr_begin; 4091 char errbuf[1024]; 4092 const char *chopprefix; 4093 boolean_t newfs = B_FALSE; 4094 boolean_t stream_wantsnewfs, stream_resumingnewfs; 4095 boolean_t newprops = B_FALSE; 4096 uint64_t read_bytes = 0; 4097 uint64_t errflags = 0; 4098 uint64_t parent_snapguid = 0; 4099 prop_changelist_t *clp = NULL; 4100 nvlist_t *snapprops_nvlist = NULL; 4101 nvlist_t *snapholds_nvlist = NULL; 4102 zprop_errflags_t prop_errflags; 4103 nvlist_t *prop_errors = NULL; 4104 boolean_t recursive; 4105 char *snapname = NULL; 4106 char destsnap[MAXPATHLEN * 2]; 4107 char origin[MAXNAMELEN]; 4108 char name[MAXPATHLEN]; 4109 char tmp_keylocation[MAXNAMELEN]; 4110 nvlist_t *rcvprops = NULL; /* props received from the send stream */ 4111 nvlist_t *oxprops = NULL; /* override (-o) and exclude (-x) props */ 4112 nvlist_t *origprops = NULL; /* original props (if destination exists) */ 4113 zfs_type_t type; 4114 boolean_t toplevel = B_FALSE; 4115 boolean_t zoned = B_FALSE; 4116 boolean_t hastoken = B_FALSE; 4117 boolean_t redacted; 4118 uint8_t *wkeydata = NULL; 4119 uint_t wkeylen = 0; 4120 4121 begin_time = time(NULL); 4122 bzero(origin, MAXNAMELEN); 4123 bzero(tmp_keylocation, MAXNAMELEN); 4124 4125 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN, 4126 "cannot receive")); 4127 4128 recursive = (nvlist_lookup_boolean(stream_nv, "not_recursive") == 4129 ENOENT); 4130 4131 /* Did the user request holds be skipped via zfs recv -k? */ 4132 boolean_t holds = flags->holds && !flags->skipholds; 4133 4134 if (stream_avl != NULL) { 4135 char *keylocation = NULL; 4136 nvlist_t *lookup = NULL; 4137 nvlist_t *fs = fsavl_find(stream_avl, drrb->drr_toguid, 4138 &snapname); 4139 4140 (void) nvlist_lookup_uint64(fs, "parentfromsnap", 4141 &parent_snapguid); 4142 err = nvlist_lookup_nvlist(fs, "props", &rcvprops); 4143 if (err) { 4144 VERIFY(0 == nvlist_alloc(&rcvprops, NV_UNIQUE_NAME, 0)); 4145 newprops = B_TRUE; 4146 } 4147 4148 /* 4149 * The keylocation property may only be set on encryption roots, 4150 * but this dataset might not become an encryption root until 4151 * recv_fix_encryption_hierarchy() is called. That function 4152 * will fixup the keylocation anyway, so we temporarily unset 4153 * the keylocation for now to avoid any errors from the receive 4154 * ioctl. 4155 */ 4156 err = nvlist_lookup_string(rcvprops, 4157 zfs_prop_to_name(ZFS_PROP_KEYLOCATION), &keylocation); 4158 if (err == 0) { 4159 strcpy(tmp_keylocation, keylocation); 4160 (void) nvlist_remove_all(rcvprops, 4161 zfs_prop_to_name(ZFS_PROP_KEYLOCATION)); 4162 } 4163 4164 if (flags->canmountoff) { 4165 VERIFY(0 == nvlist_add_uint64(rcvprops, 4166 zfs_prop_to_name(ZFS_PROP_CANMOUNT), 0)); 4167 } else if (newprops) { /* nothing in rcvprops, eliminate it */ 4168 nvlist_free(rcvprops); 4169 rcvprops = NULL; 4170 newprops = B_FALSE; 4171 } 4172 if (0 == nvlist_lookup_nvlist(fs, "snapprops", &lookup)) { 4173 VERIFY(0 == nvlist_lookup_nvlist(lookup, 4174 snapname, &snapprops_nvlist)); 4175 } 4176 if (holds) { 4177 if (0 == nvlist_lookup_nvlist(fs, "snapholds", 4178 &lookup)) { 4179 VERIFY(0 == nvlist_lookup_nvlist(lookup, 4180 snapname, &snapholds_nvlist)); 4181 } 4182 } 4183 } 4184 4185 cp = NULL; 4186 4187 /* 4188 * Determine how much of the snapshot name stored in the stream 4189 * we are going to tack on to the name they specified on the 4190 * command line, and how much we are going to chop off. 4191 * 4192 * If they specified a snapshot, chop the entire name stored in 4193 * the stream. 4194 */ 4195 if (flags->istail) { 4196 /* 4197 * A filesystem was specified with -e. We want to tack on only 4198 * the tail of the sent snapshot path. 4199 */ 4200 if (strchr(tosnap, '@')) { 4201 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, "invalid " 4202 "argument - snapshot not allowed with -e")); 4203 err = zfs_error(hdl, EZFS_INVALIDNAME, errbuf); 4204 goto out; 4205 } 4206 4207 chopprefix = strrchr(sendfs, '/'); 4208 4209 if (chopprefix == NULL) { 4210 /* 4211 * The tail is the poolname, so we need to 4212 * prepend a path separator. 4213 */ 4214 int len = strlen(drrb->drr_toname); 4215 cp = malloc(len + 2); 4216 cp[0] = '/'; 4217 (void) strcpy(&cp[1], drrb->drr_toname); 4218 chopprefix = cp; 4219 } else { 4220 chopprefix = drrb->drr_toname + (chopprefix - sendfs); 4221 } 4222 } else if (flags->isprefix) { 4223 /* 4224 * A filesystem was specified with -d. We want to tack on 4225 * everything but the first element of the sent snapshot path 4226 * (all but the pool name). 4227 */ 4228 if (strchr(tosnap, '@')) { 4229 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, "invalid " 4230 "argument - snapshot not allowed with -d")); 4231 err = zfs_error(hdl, EZFS_INVALIDNAME, errbuf); 4232 goto out; 4233 } 4234 4235 chopprefix = strchr(drrb->drr_toname, '/'); 4236 if (chopprefix == NULL) 4237 chopprefix = strchr(drrb->drr_toname, '@'); 4238 } else if (strchr(tosnap, '@') == NULL) { 4239 /* 4240 * If a filesystem was specified without -d or -e, we want to 4241 * tack on everything after the fs specified by 'zfs send'. 4242 */ 4243 chopprefix = drrb->drr_toname + strlen(sendfs); 4244 } else { 4245 /* A snapshot was specified as an exact path (no -d or -e). */ 4246 if (recursive) { 4247 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 4248 "cannot specify snapshot name for multi-snapshot " 4249 "stream")); 4250 err = zfs_error(hdl, EZFS_BADSTREAM, errbuf); 4251 goto out; 4252 } 4253 chopprefix = drrb->drr_toname + strlen(drrb->drr_toname); 4254 } 4255 4256 ASSERT(strstr(drrb->drr_toname, sendfs) == drrb->drr_toname); 4257 ASSERT(chopprefix > drrb->drr_toname || strchr(sendfs, '/') == NULL); 4258 ASSERT(chopprefix <= drrb->drr_toname + strlen(drrb->drr_toname) || 4259 strchr(sendfs, '/') == NULL); 4260 ASSERT(chopprefix[0] == '/' || chopprefix[0] == '@' || 4261 chopprefix[0] == '\0'); 4262 4263 /* 4264 * Determine name of destination snapshot. 4265 */ 4266 (void) strlcpy(destsnap, tosnap, sizeof (destsnap)); 4267 (void) strlcat(destsnap, chopprefix, sizeof (destsnap)); 4268 free(cp); 4269 if (!zfs_name_valid(destsnap, ZFS_TYPE_SNAPSHOT)) { 4270 err = zfs_error(hdl, EZFS_INVALIDNAME, errbuf); 4271 goto out; 4272 } 4273 4274 /* 4275 * Determine the name of the origin snapshot. 4276 */ 4277 if (originsnap) { 4278 (void) strlcpy(origin, originsnap, sizeof (origin)); 4279 if (flags->verbose) 4280 (void) printf("using provided clone origin %s\n", 4281 origin); 4282 } else if (drrb->drr_flags & DRR_FLAG_CLONE) { 4283 if (guid_to_name(hdl, destsnap, 4284 drrb->drr_fromguid, B_FALSE, origin) != 0) { 4285 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 4286 "local origin for clone %s does not exist"), 4287 destsnap); 4288 err = zfs_error(hdl, EZFS_NOENT, errbuf); 4289 goto out; 4290 } 4291 if (flags->verbose) 4292 (void) printf("found clone origin %s\n", origin); 4293 } 4294 4295 if ((DMU_GET_FEATUREFLAGS(drrb->drr_versioninfo) & 4296 DMU_BACKUP_FEATURE_DEDUP)) { 4297 (void) fprintf(stderr, 4298 gettext("ERROR: \"zfs receive\" no longer supports " 4299 "deduplicated send streams. Use\n" 4300 "the \"zstream redup\" command to convert this stream " 4301 "to a regular,\n" 4302 "non-deduplicated stream.\n")); 4303 err = zfs_error(hdl, EZFS_NOTSUP, errbuf); 4304 goto out; 4305 } 4306 4307 boolean_t resuming = DMU_GET_FEATUREFLAGS(drrb->drr_versioninfo) & 4308 DMU_BACKUP_FEATURE_RESUMING; 4309 boolean_t raw = DMU_GET_FEATUREFLAGS(drrb->drr_versioninfo) & 4310 DMU_BACKUP_FEATURE_RAW; 4311 boolean_t embedded = DMU_GET_FEATUREFLAGS(drrb->drr_versioninfo) & 4312 DMU_BACKUP_FEATURE_EMBED_DATA; 4313 stream_wantsnewfs = (drrb->drr_fromguid == 0 || 4314 (drrb->drr_flags & DRR_FLAG_CLONE) || originsnap) && !resuming; 4315 stream_resumingnewfs = (drrb->drr_fromguid == 0 || 4316 (drrb->drr_flags & DRR_FLAG_CLONE) || originsnap) && resuming; 4317 4318 if (stream_wantsnewfs) { 4319 /* 4320 * if the parent fs does not exist, look for it based on 4321 * the parent snap GUID 4322 */ 4323 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN, 4324 "cannot receive new filesystem stream")); 4325 4326 (void) strcpy(name, destsnap); 4327 cp = strrchr(name, '/'); 4328 if (cp) 4329 *cp = '\0'; 4330 if (cp && 4331 !zfs_dataset_exists(hdl, name, ZFS_TYPE_DATASET)) { 4332 char suffix[ZFS_MAX_DATASET_NAME_LEN]; 4333 (void) strcpy(suffix, strrchr(destsnap, '/')); 4334 if (guid_to_name(hdl, name, parent_snapguid, 4335 B_FALSE, destsnap) == 0) { 4336 *strchr(destsnap, '@') = '\0'; 4337 (void) strcat(destsnap, suffix); 4338 } 4339 } 4340 } else { 4341 /* 4342 * If the fs does not exist, look for it based on the 4343 * fromsnap GUID. 4344 */ 4345 if (resuming) { 4346 (void) snprintf(errbuf, sizeof (errbuf), 4347 dgettext(TEXT_DOMAIN, 4348 "cannot receive resume stream")); 4349 } else { 4350 (void) snprintf(errbuf, sizeof (errbuf), 4351 dgettext(TEXT_DOMAIN, 4352 "cannot receive incremental stream")); 4353 } 4354 4355 (void) strcpy(name, destsnap); 4356 *strchr(name, '@') = '\0'; 4357 4358 /* 4359 * If the exact receive path was specified and this is the 4360 * topmost path in the stream, then if the fs does not exist we 4361 * should look no further. 4362 */ 4363 if ((flags->isprefix || (*(chopprefix = drrb->drr_toname + 4364 strlen(sendfs)) != '\0' && *chopprefix != '@')) && 4365 !zfs_dataset_exists(hdl, name, ZFS_TYPE_DATASET)) { 4366 char snap[ZFS_MAX_DATASET_NAME_LEN]; 4367 (void) strcpy(snap, strchr(destsnap, '@')); 4368 if (guid_to_name(hdl, name, drrb->drr_fromguid, 4369 B_FALSE, destsnap) == 0) { 4370 *strchr(destsnap, '@') = '\0'; 4371 (void) strcat(destsnap, snap); 4372 } 4373 } 4374 } 4375 4376 (void) strcpy(name, destsnap); 4377 *strchr(name, '@') = '\0'; 4378 4379 redacted = DMU_GET_FEATUREFLAGS(drrb->drr_versioninfo) & 4380 DMU_BACKUP_FEATURE_REDACTED; 4381 4382 if (zfs_dataset_exists(hdl, name, ZFS_TYPE_DATASET)) { 4383 zfs_cmd_t zc = {"\0"}; 4384 zfs_handle_t *zhp; 4385 boolean_t encrypted; 4386 4387 (void) strcpy(zc.zc_name, name); 4388 4389 /* 4390 * Destination fs exists. It must be one of these cases: 4391 * - an incremental send stream 4392 * - the stream specifies a new fs (full stream or clone) 4393 * and they want us to blow away the existing fs (and 4394 * have therefore specified -F and removed any snapshots) 4395 * - we are resuming a failed receive. 4396 */ 4397 if (stream_wantsnewfs) { 4398 boolean_t is_volume = drrb->drr_type == DMU_OST_ZVOL; 4399 if (!flags->force) { 4400 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 4401 "destination '%s' exists\n" 4402 "must specify -F to overwrite it"), name); 4403 err = zfs_error(hdl, EZFS_EXISTS, errbuf); 4404 goto out; 4405 } 4406 if (zfs_ioctl(hdl, ZFS_IOC_SNAPSHOT_LIST_NEXT, 4407 &zc) == 0) { 4408 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 4409 "destination has snapshots (eg. %s)\n" 4410 "must destroy them to overwrite it"), 4411 zc.zc_name); 4412 err = zfs_error(hdl, EZFS_EXISTS, errbuf); 4413 goto out; 4414 } 4415 if (is_volume && strrchr(name, '/') == NULL) { 4416 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 4417 "destination %s is the root dataset\n" 4418 "cannot overwrite with a ZVOL"), 4419 name); 4420 err = zfs_error(hdl, EZFS_EXISTS, errbuf); 4421 goto out; 4422 } 4423 if (is_volume && 4424 zfs_ioctl(hdl, ZFS_IOC_DATASET_LIST_NEXT, 4425 &zc) == 0) { 4426 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 4427 "destination has children (eg. %s)\n" 4428 "cannot overwrite with a ZVOL"), 4429 zc.zc_name); 4430 err = zfs_error(hdl, EZFS_WRONG_PARENT, errbuf); 4431 goto out; 4432 } 4433 } 4434 4435 if ((zhp = zfs_open(hdl, name, 4436 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME)) == NULL) { 4437 err = -1; 4438 goto out; 4439 } 4440 4441 if (stream_wantsnewfs && 4442 zhp->zfs_dmustats.dds_origin[0]) { 4443 zfs_close(zhp); 4444 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 4445 "destination '%s' is a clone\n" 4446 "must destroy it to overwrite it"), name); 4447 err = zfs_error(hdl, EZFS_EXISTS, errbuf); 4448 goto out; 4449 } 4450 4451 /* 4452 * Raw sends can not be performed as an incremental on top 4453 * of existing unencrypted datasets. zfs recv -F can't be 4454 * used to blow away an existing encrypted filesystem. This 4455 * is because it would require the dsl dir to point to the 4456 * new key (or lack of a key) and the old key at the same 4457 * time. The -F flag may still be used for deleting 4458 * intermediate snapshots that would otherwise prevent the 4459 * receive from working. 4460 */ 4461 encrypted = zfs_prop_get_int(zhp, ZFS_PROP_ENCRYPTION) != 4462 ZIO_CRYPT_OFF; 4463 if (!stream_wantsnewfs && !encrypted && raw) { 4464 zfs_close(zhp); 4465 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 4466 "cannot perform raw receive on top of " 4467 "existing unencrypted dataset")); 4468 err = zfs_error(hdl, EZFS_BADRESTORE, errbuf); 4469 goto out; 4470 } 4471 4472 if (stream_wantsnewfs && flags->force && 4473 ((raw && !encrypted) || encrypted)) { 4474 zfs_close(zhp); 4475 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 4476 "zfs receive -F cannot be used to destroy an " 4477 "encrypted filesystem or overwrite an " 4478 "unencrypted one with an encrypted one")); 4479 err = zfs_error(hdl, EZFS_BADRESTORE, errbuf); 4480 goto out; 4481 } 4482 4483 if (!flags->dryrun && zhp->zfs_type == ZFS_TYPE_FILESYSTEM && 4484 (stream_wantsnewfs || stream_resumingnewfs)) { 4485 /* We can't do online recv in this case */ 4486 clp = changelist_gather(zhp, ZFS_PROP_NAME, 0, 4487 flags->forceunmount ? MS_FORCE : 0); 4488 if (clp == NULL) { 4489 zfs_close(zhp); 4490 err = -1; 4491 goto out; 4492 } 4493 if (changelist_prefix(clp) != 0) { 4494 changelist_free(clp); 4495 zfs_close(zhp); 4496 err = -1; 4497 goto out; 4498 } 4499 } 4500 4501 /* 4502 * If we are resuming a newfs, set newfs here so that we will 4503 * mount it if the recv succeeds this time. We can tell 4504 * that it was a newfs on the first recv because the fs 4505 * itself will be inconsistent (if the fs existed when we 4506 * did the first recv, we would have received it into 4507 * .../%recv). 4508 */ 4509 if (resuming && zfs_prop_get_int(zhp, ZFS_PROP_INCONSISTENT)) 4510 newfs = B_TRUE; 4511 4512 /* we want to know if we're zoned when validating -o|-x props */ 4513 zoned = zfs_prop_get_int(zhp, ZFS_PROP_ZONED); 4514 4515 /* may need this info later, get it now we have zhp around */ 4516 if (zfs_prop_get(zhp, ZFS_PROP_RECEIVE_RESUME_TOKEN, NULL, 0, 4517 NULL, NULL, 0, B_TRUE) == 0) 4518 hastoken = B_TRUE; 4519 4520 /* gather existing properties on destination */ 4521 origprops = fnvlist_alloc(); 4522 fnvlist_merge(origprops, zhp->zfs_props); 4523 fnvlist_merge(origprops, zhp->zfs_user_props); 4524 4525 zfs_close(zhp); 4526 } else { 4527 zfs_handle_t *zhp; 4528 4529 /* 4530 * Destination filesystem does not exist. Therefore we better 4531 * be creating a new filesystem (either from a full backup, or 4532 * a clone). It would therefore be invalid if the user 4533 * specified only the pool name (i.e. if the destination name 4534 * contained no slash character). 4535 */ 4536 cp = strrchr(name, '/'); 4537 4538 if (!stream_wantsnewfs || cp == NULL) { 4539 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 4540 "destination '%s' does not exist"), name); 4541 err = zfs_error(hdl, EZFS_NOENT, errbuf); 4542 goto out; 4543 } 4544 4545 /* 4546 * Trim off the final dataset component so we perform the 4547 * recvbackup ioctl to the filesystems's parent. 4548 */ 4549 *cp = '\0'; 4550 4551 if (flags->isprefix && !flags->istail && !flags->dryrun && 4552 create_parents(hdl, destsnap, strlen(tosnap)) != 0) { 4553 err = zfs_error(hdl, EZFS_BADRESTORE, errbuf); 4554 goto out; 4555 } 4556 4557 /* validate parent */ 4558 zhp = zfs_open(hdl, name, ZFS_TYPE_DATASET); 4559 if (zhp == NULL) { 4560 err = zfs_error(hdl, EZFS_BADRESTORE, errbuf); 4561 goto out; 4562 } 4563 if (zfs_get_type(zhp) != ZFS_TYPE_FILESYSTEM) { 4564 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 4565 "parent '%s' is not a filesystem"), name); 4566 err = zfs_error(hdl, EZFS_WRONG_PARENT, errbuf); 4567 zfs_close(zhp); 4568 goto out; 4569 } 4570 4571 zfs_close(zhp); 4572 4573 newfs = B_TRUE; 4574 *cp = '/'; 4575 } 4576 4577 if (flags->verbose) { 4578 (void) printf("%s %s stream of %s into %s\n", 4579 flags->dryrun ? "would receive" : "receiving", 4580 drrb->drr_fromguid ? "incremental" : "full", 4581 drrb->drr_toname, destsnap); 4582 (void) fflush(stdout); 4583 } 4584 4585 if (flags->dryrun) { 4586 void *buf = zfs_alloc(hdl, SPA_MAXBLOCKSIZE); 4587 4588 /* 4589 * We have read the DRR_BEGIN record, but we have 4590 * not yet read the payload. For non-dryrun sends 4591 * this will be done by the kernel, so we must 4592 * emulate that here, before attempting to read 4593 * more records. 4594 */ 4595 err = recv_read(hdl, infd, buf, drr->drr_payloadlen, 4596 flags->byteswap, NULL); 4597 free(buf); 4598 if (err != 0) 4599 goto out; 4600 4601 err = recv_skip(hdl, infd, flags->byteswap); 4602 goto out; 4603 } 4604 4605 /* 4606 * If this is the top-level dataset, record it so we can use it 4607 * for recursive operations later. 4608 */ 4609 if (top_zfs != NULL && 4610 (*top_zfs == NULL || strcmp(*top_zfs, name) == 0)) { 4611 toplevel = B_TRUE; 4612 if (*top_zfs == NULL) 4613 *top_zfs = zfs_strdup(hdl, name); 4614 } 4615 4616 if (drrb->drr_type == DMU_OST_ZVOL) { 4617 type = ZFS_TYPE_VOLUME; 4618 } else if (drrb->drr_type == DMU_OST_ZFS) { 4619 type = ZFS_TYPE_FILESYSTEM; 4620 } else { 4621 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 4622 "invalid record type: 0x%d"), drrb->drr_type); 4623 err = zfs_error(hdl, EZFS_BADSTREAM, errbuf); 4624 goto out; 4625 } 4626 if ((err = zfs_setup_cmdline_props(hdl, type, name, zoned, recursive, 4627 stream_wantsnewfs, raw, toplevel, rcvprops, cmdprops, origprops, 4628 &oxprops, &wkeydata, &wkeylen, errbuf)) != 0) 4629 goto out; 4630 4631 /* 4632 * When sending with properties (zfs send -p), the encryption property 4633 * is not included because it is a SETONCE property and therefore 4634 * treated as read only. However, we are always able to determine its 4635 * value because raw sends will include it in the DRR_BDEGIN payload 4636 * and non-raw sends with properties are not allowed for encrypted 4637 * datasets. Therefore, if this is a non-raw properties stream, we can 4638 * infer that the value should be ZIO_CRYPT_OFF and manually add that 4639 * to the received properties. 4640 */ 4641 if (stream_wantsnewfs && !raw && rcvprops != NULL && 4642 !nvlist_exists(cmdprops, zfs_prop_to_name(ZFS_PROP_ENCRYPTION))) { 4643 if (oxprops == NULL) 4644 oxprops = fnvlist_alloc(); 4645 fnvlist_add_uint64(oxprops, 4646 zfs_prop_to_name(ZFS_PROP_ENCRYPTION), ZIO_CRYPT_OFF); 4647 } 4648 4649 err = ioctl_err = lzc_receive_with_cmdprops(destsnap, rcvprops, 4650 oxprops, wkeydata, wkeylen, origin, flags->force, flags->resumable, 4651 raw, infd, drr_noswap, -1, &read_bytes, &errflags, 4652 NULL, &prop_errors); 4653 ioctl_errno = ioctl_err; 4654 prop_errflags = errflags; 4655 4656 if (err == 0) { 4657 nvpair_t *prop_err = NULL; 4658 4659 while ((prop_err = nvlist_next_nvpair(prop_errors, 4660 prop_err)) != NULL) { 4661 char tbuf[1024]; 4662 zfs_prop_t prop; 4663 int intval; 4664 4665 prop = zfs_name_to_prop(nvpair_name(prop_err)); 4666 (void) nvpair_value_int32(prop_err, &intval); 4667 if (strcmp(nvpair_name(prop_err), 4668 ZPROP_N_MORE_ERRORS) == 0) { 4669 trunc_prop_errs(intval); 4670 break; 4671 } else if (snapname == NULL || finalsnap == NULL || 4672 strcmp(finalsnap, snapname) == 0 || 4673 strcmp(nvpair_name(prop_err), 4674 zfs_prop_to_name(ZFS_PROP_REFQUOTA)) != 0) { 4675 /* 4676 * Skip the special case of, for example, 4677 * "refquota", errors on intermediate 4678 * snapshots leading up to a final one. 4679 * That's why we have all of the checks above. 4680 * 4681 * See zfs_ioctl.c's extract_delay_props() for 4682 * a list of props which can fail on 4683 * intermediate snapshots, but shouldn't 4684 * affect the overall receive. 4685 */ 4686 (void) snprintf(tbuf, sizeof (tbuf), 4687 dgettext(TEXT_DOMAIN, 4688 "cannot receive %s property on %s"), 4689 nvpair_name(prop_err), name); 4690 zfs_setprop_error(hdl, prop, intval, tbuf); 4691 } 4692 } 4693 } 4694 4695 if (err == 0 && snapprops_nvlist) { 4696 zfs_cmd_t zc = {"\0"}; 4697 4698 (void) strcpy(zc.zc_name, destsnap); 4699 zc.zc_cookie = B_TRUE; /* received */ 4700 if (zcmd_write_src_nvlist(hdl, &zc, snapprops_nvlist) == 0) { 4701 (void) zfs_ioctl(hdl, ZFS_IOC_SET_PROP, &zc); 4702 zcmd_free_nvlists(&zc); 4703 } 4704 } 4705 if (err == 0 && snapholds_nvlist) { 4706 nvpair_t *pair; 4707 nvlist_t *holds, *errors = NULL; 4708 int cleanup_fd = -1; 4709 4710 VERIFY(0 == nvlist_alloc(&holds, 0, KM_SLEEP)); 4711 for (pair = nvlist_next_nvpair(snapholds_nvlist, NULL); 4712 pair != NULL; 4713 pair = nvlist_next_nvpair(snapholds_nvlist, pair)) { 4714 VERIFY(0 == nvlist_add_string(holds, destsnap, 4715 nvpair_name(pair))); 4716 } 4717 (void) lzc_hold(holds, cleanup_fd, &errors); 4718 nvlist_free(snapholds_nvlist); 4719 nvlist_free(holds); 4720 } 4721 4722 if (err && (ioctl_errno == ENOENT || ioctl_errno == EEXIST)) { 4723 /* 4724 * It may be that this snapshot already exists, 4725 * in which case we want to consume & ignore it 4726 * rather than failing. 4727 */ 4728 avl_tree_t *local_avl; 4729 nvlist_t *local_nv, *fs; 4730 cp = strchr(destsnap, '@'); 4731 4732 /* 4733 * XXX Do this faster by just iterating over snaps in 4734 * this fs. Also if zc_value does not exist, we will 4735 * get a strange "does not exist" error message. 4736 */ 4737 *cp = '\0'; 4738 if (gather_nvlist(hdl, destsnap, NULL, NULL, B_FALSE, B_TRUE, 4739 B_FALSE, B_FALSE, B_FALSE, B_FALSE, B_FALSE, B_TRUE, 4740 &local_nv, &local_avl) == 0) { 4741 *cp = '@'; 4742 fs = fsavl_find(local_avl, drrb->drr_toguid, NULL); 4743 fsavl_destroy(local_avl); 4744 nvlist_free(local_nv); 4745 4746 if (fs != NULL) { 4747 if (flags->verbose) { 4748 (void) printf("snap %s already exists; " 4749 "ignoring\n", destsnap); 4750 } 4751 err = ioctl_err = recv_skip(hdl, infd, 4752 flags->byteswap); 4753 } 4754 } 4755 *cp = '@'; 4756 } 4757 4758 if (ioctl_err != 0) { 4759 switch (ioctl_errno) { 4760 case ENODEV: 4761 cp = strchr(destsnap, '@'); 4762 *cp = '\0'; 4763 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 4764 "most recent snapshot of %s does not\n" 4765 "match incremental source"), destsnap); 4766 (void) zfs_error(hdl, EZFS_BADRESTORE, errbuf); 4767 *cp = '@'; 4768 break; 4769 case ETXTBSY: 4770 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 4771 "destination %s has been modified\n" 4772 "since most recent snapshot"), name); 4773 (void) zfs_error(hdl, EZFS_BADRESTORE, errbuf); 4774 break; 4775 case EACCES: 4776 if (raw && stream_wantsnewfs) { 4777 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 4778 "failed to create encryption key")); 4779 } else if (raw && !stream_wantsnewfs) { 4780 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 4781 "encryption key does not match " 4782 "existing key")); 4783 } else { 4784 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 4785 "inherited key must be loaded")); 4786 } 4787 (void) zfs_error(hdl, EZFS_CRYPTOFAILED, errbuf); 4788 break; 4789 case EEXIST: 4790 cp = strchr(destsnap, '@'); 4791 if (newfs) { 4792 /* it's the containing fs that exists */ 4793 *cp = '\0'; 4794 } 4795 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 4796 "destination already exists")); 4797 (void) zfs_error_fmt(hdl, EZFS_EXISTS, 4798 dgettext(TEXT_DOMAIN, "cannot restore to %s"), 4799 destsnap); 4800 *cp = '@'; 4801 break; 4802 case EINVAL: 4803 if (flags->resumable) { 4804 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 4805 "kernel modules must be upgraded to " 4806 "receive this stream.")); 4807 } else if (embedded && !raw) { 4808 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 4809 "incompatible embedded data stream " 4810 "feature with encrypted receive.")); 4811 } 4812 (void) zfs_error(hdl, EZFS_BADSTREAM, errbuf); 4813 break; 4814 case ECKSUM: 4815 case ZFS_ERR_STREAM_TRUNCATED: 4816 recv_ecksum_set_aux(hdl, destsnap, flags->resumable, 4817 ioctl_err == ECKSUM); 4818 (void) zfs_error(hdl, EZFS_BADSTREAM, errbuf); 4819 break; 4820 case ZFS_ERR_STREAM_LARGE_BLOCK_MISMATCH: 4821 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 4822 "incremental send stream requires -L " 4823 "(--large-block), to match previous receive.")); 4824 (void) zfs_error(hdl, EZFS_BADSTREAM, errbuf); 4825 break; 4826 case ENOTSUP: 4827 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 4828 "pool must be upgraded to receive this stream.")); 4829 (void) zfs_error(hdl, EZFS_BADVERSION, errbuf); 4830 break; 4831 case EDQUOT: 4832 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 4833 "destination %s space quota exceeded."), name); 4834 (void) zfs_error(hdl, EZFS_NOSPC, errbuf); 4835 break; 4836 case ZFS_ERR_FROM_IVSET_GUID_MISSING: 4837 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 4838 "IV set guid missing. See errata %u at " 4839 "https://openzfs.github.io/openzfs-docs/msg/" 4840 "ZFS-8000-ER."), 4841 ZPOOL_ERRATA_ZOL_8308_ENCRYPTION); 4842 (void) zfs_error(hdl, EZFS_BADSTREAM, errbuf); 4843 break; 4844 case ZFS_ERR_FROM_IVSET_GUID_MISMATCH: 4845 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 4846 "IV set guid mismatch. See the 'zfs receive' " 4847 "man page section\n discussing the limitations " 4848 "of raw encrypted send streams.")); 4849 (void) zfs_error(hdl, EZFS_BADSTREAM, errbuf); 4850 break; 4851 case ZFS_ERR_SPILL_BLOCK_FLAG_MISSING: 4852 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 4853 "Spill block flag missing for raw send.\n" 4854 "The zfs software on the sending system must " 4855 "be updated.")); 4856 (void) zfs_error(hdl, EZFS_BADSTREAM, errbuf); 4857 break; 4858 case EBUSY: 4859 if (hastoken) { 4860 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 4861 "destination %s contains " 4862 "partially-complete state from " 4863 "\"zfs receive -s\"."), name); 4864 (void) zfs_error(hdl, EZFS_BUSY, errbuf); 4865 break; 4866 } 4867 /* fallthru */ 4868 default: 4869 (void) zfs_standard_error(hdl, ioctl_errno, errbuf); 4870 } 4871 } 4872 4873 /* 4874 * Mount the target filesystem (if created). Also mount any 4875 * children of the target filesystem if we did a replication 4876 * receive (indicated by stream_avl being non-NULL). 4877 */ 4878 if (clp) { 4879 if (!flags->nomount) 4880 err |= changelist_postfix(clp); 4881 changelist_free(clp); 4882 } 4883 4884 if ((newfs || stream_avl) && type == ZFS_TYPE_FILESYSTEM && !redacted) 4885 flags->domount = B_TRUE; 4886 4887 if (prop_errflags & ZPROP_ERR_NOCLEAR) { 4888 (void) fprintf(stderr, dgettext(TEXT_DOMAIN, "Warning: " 4889 "failed to clear unreceived properties on %s"), name); 4890 (void) fprintf(stderr, "\n"); 4891 } 4892 if (prop_errflags & ZPROP_ERR_NORESTORE) { 4893 (void) fprintf(stderr, dgettext(TEXT_DOMAIN, "Warning: " 4894 "failed to restore original properties on %s"), name); 4895 (void) fprintf(stderr, "\n"); 4896 } 4897 4898 if (err || ioctl_err) { 4899 err = -1; 4900 goto out; 4901 } 4902 4903 if (flags->verbose) { 4904 char buf1[64]; 4905 char buf2[64]; 4906 uint64_t bytes = read_bytes; 4907 time_t delta = time(NULL) - begin_time; 4908 if (delta == 0) 4909 delta = 1; 4910 zfs_nicebytes(bytes, buf1, sizeof (buf1)); 4911 zfs_nicebytes(bytes/delta, buf2, sizeof (buf1)); 4912 4913 (void) printf("received %s stream in %lld seconds (%s/sec)\n", 4914 buf1, (longlong_t)delta, buf2); 4915 } 4916 4917 err = 0; 4918 out: 4919 if (prop_errors != NULL) 4920 nvlist_free(prop_errors); 4921 4922 if (tmp_keylocation[0] != '\0') { 4923 VERIFY(0 == nvlist_add_string(rcvprops, 4924 zfs_prop_to_name(ZFS_PROP_KEYLOCATION), tmp_keylocation)); 4925 } 4926 4927 if (newprops) 4928 nvlist_free(rcvprops); 4929 4930 nvlist_free(oxprops); 4931 nvlist_free(origprops); 4932 4933 return (err); 4934 } 4935 4936 /* 4937 * Check properties we were asked to override (both -o|-x) 4938 */ 4939 static boolean_t 4940 zfs_receive_checkprops(libzfs_handle_t *hdl, nvlist_t *props, 4941 const char *errbuf) 4942 { 4943 nvpair_t *nvp; 4944 zfs_prop_t prop; 4945 const char *name; 4946 4947 nvp = NULL; 4948 while ((nvp = nvlist_next_nvpair(props, nvp)) != NULL) { 4949 name = nvpair_name(nvp); 4950 prop = zfs_name_to_prop(name); 4951 4952 if (prop == ZPROP_INVAL) { 4953 if (!zfs_prop_user(name)) { 4954 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 4955 "invalid property '%s'"), name); 4956 return (B_FALSE); 4957 } 4958 continue; 4959 } 4960 /* 4961 * "origin" is readonly but is used to receive datasets as 4962 * clones so we don't raise an error here 4963 */ 4964 if (prop == ZFS_PROP_ORIGIN) 4965 continue; 4966 4967 /* encryption params have their own verification later */ 4968 if (prop == ZFS_PROP_ENCRYPTION || 4969 zfs_prop_encryption_key_param(prop)) 4970 continue; 4971 4972 /* 4973 * cannot override readonly, set-once and other specific 4974 * settable properties 4975 */ 4976 if (zfs_prop_readonly(prop) || prop == ZFS_PROP_VERSION || 4977 prop == ZFS_PROP_VOLSIZE) { 4978 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 4979 "invalid property '%s'"), name); 4980 return (B_FALSE); 4981 } 4982 } 4983 4984 return (B_TRUE); 4985 } 4986 4987 static int 4988 zfs_receive_impl(libzfs_handle_t *hdl, const char *tosnap, 4989 const char *originsnap, recvflags_t *flags, int infd, const char *sendfs, 4990 nvlist_t *stream_nv, avl_tree_t *stream_avl, char **top_zfs, 4991 const char *finalsnap, nvlist_t *cmdprops) 4992 { 4993 int err; 4994 dmu_replay_record_t drr, drr_noswap; 4995 struct drr_begin *drrb = &drr.drr_u.drr_begin; 4996 char errbuf[1024]; 4997 zio_cksum_t zcksum = { { 0 } }; 4998 uint64_t featureflags; 4999 int hdrtype; 5000 5001 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN, 5002 "cannot receive")); 5003 5004 /* check cmdline props, raise an error if they cannot be received */ 5005 if (!zfs_receive_checkprops(hdl, cmdprops, errbuf)) { 5006 return (zfs_error(hdl, EZFS_BADPROP, errbuf)); 5007 } 5008 5009 if (flags->isprefix && 5010 !zfs_dataset_exists(hdl, tosnap, ZFS_TYPE_DATASET)) { 5011 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, "specified fs " 5012 "(%s) does not exist"), tosnap); 5013 return (zfs_error(hdl, EZFS_NOENT, errbuf)); 5014 } 5015 if (originsnap && 5016 !zfs_dataset_exists(hdl, originsnap, ZFS_TYPE_DATASET)) { 5017 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, "specified origin fs " 5018 "(%s) does not exist"), originsnap); 5019 return (zfs_error(hdl, EZFS_NOENT, errbuf)); 5020 } 5021 5022 /* read in the BEGIN record */ 5023 if (0 != (err = recv_read(hdl, infd, &drr, sizeof (drr), B_FALSE, 5024 &zcksum))) 5025 return (err); 5026 5027 if (drr.drr_type == DRR_END || drr.drr_type == BSWAP_32(DRR_END)) { 5028 /* It's the double end record at the end of a package */ 5029 return (ENODATA); 5030 } 5031 5032 /* the kernel needs the non-byteswapped begin record */ 5033 drr_noswap = drr; 5034 5035 flags->byteswap = B_FALSE; 5036 if (drrb->drr_magic == BSWAP_64(DMU_BACKUP_MAGIC)) { 5037 /* 5038 * We computed the checksum in the wrong byteorder in 5039 * recv_read() above; do it again correctly. 5040 */ 5041 bzero(&zcksum, sizeof (zio_cksum_t)); 5042 fletcher_4_incremental_byteswap(&drr, sizeof (drr), &zcksum); 5043 flags->byteswap = B_TRUE; 5044 5045 drr.drr_type = BSWAP_32(drr.drr_type); 5046 drr.drr_payloadlen = BSWAP_32(drr.drr_payloadlen); 5047 drrb->drr_magic = BSWAP_64(drrb->drr_magic); 5048 drrb->drr_versioninfo = BSWAP_64(drrb->drr_versioninfo); 5049 drrb->drr_creation_time = BSWAP_64(drrb->drr_creation_time); 5050 drrb->drr_type = BSWAP_32(drrb->drr_type); 5051 drrb->drr_flags = BSWAP_32(drrb->drr_flags); 5052 drrb->drr_toguid = BSWAP_64(drrb->drr_toguid); 5053 drrb->drr_fromguid = BSWAP_64(drrb->drr_fromguid); 5054 } 5055 5056 if (drrb->drr_magic != DMU_BACKUP_MAGIC || drr.drr_type != DRR_BEGIN) { 5057 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, "invalid " 5058 "stream (bad magic number)")); 5059 return (zfs_error(hdl, EZFS_BADSTREAM, errbuf)); 5060 } 5061 5062 featureflags = DMU_GET_FEATUREFLAGS(drrb->drr_versioninfo); 5063 hdrtype = DMU_GET_STREAM_HDRTYPE(drrb->drr_versioninfo); 5064 5065 if (!DMU_STREAM_SUPPORTED(featureflags) || 5066 (hdrtype != DMU_SUBSTREAM && hdrtype != DMU_COMPOUNDSTREAM)) { 5067 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 5068 "stream has unsupported feature, feature flags = %lx"), 5069 featureflags); 5070 return (zfs_error(hdl, EZFS_BADSTREAM, errbuf)); 5071 } 5072 5073 /* Holds feature is set once in the compound stream header. */ 5074 if (featureflags & DMU_BACKUP_FEATURE_HOLDS) 5075 flags->holds = B_TRUE; 5076 5077 if (strchr(drrb->drr_toname, '@') == NULL) { 5078 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, "invalid " 5079 "stream (bad snapshot name)")); 5080 return (zfs_error(hdl, EZFS_BADSTREAM, errbuf)); 5081 } 5082 5083 if (DMU_GET_STREAM_HDRTYPE(drrb->drr_versioninfo) == DMU_SUBSTREAM) { 5084 char nonpackage_sendfs[ZFS_MAX_DATASET_NAME_LEN]; 5085 if (sendfs == NULL) { 5086 /* 5087 * We were not called from zfs_receive_package(). Get 5088 * the fs specified by 'zfs send'. 5089 */ 5090 char *cp; 5091 (void) strlcpy(nonpackage_sendfs, 5092 drr.drr_u.drr_begin.drr_toname, 5093 sizeof (nonpackage_sendfs)); 5094 if ((cp = strchr(nonpackage_sendfs, '@')) != NULL) 5095 *cp = '\0'; 5096 sendfs = nonpackage_sendfs; 5097 VERIFY(finalsnap == NULL); 5098 } 5099 return (zfs_receive_one(hdl, infd, tosnap, originsnap, flags, 5100 &drr, &drr_noswap, sendfs, stream_nv, stream_avl, top_zfs, 5101 finalsnap, cmdprops)); 5102 } else { 5103 assert(DMU_GET_STREAM_HDRTYPE(drrb->drr_versioninfo) == 5104 DMU_COMPOUNDSTREAM); 5105 return (zfs_receive_package(hdl, infd, tosnap, flags, &drr, 5106 &zcksum, top_zfs, cmdprops)); 5107 } 5108 } 5109 5110 /* 5111 * Restores a backup of tosnap from the file descriptor specified by infd. 5112 * Return 0 on total success, -2 if some things couldn't be 5113 * destroyed/renamed/promoted, -1 if some things couldn't be received. 5114 * (-1 will override -2, if -1 and the resumable flag was specified the 5115 * transfer can be resumed if the sending side supports it). 5116 */ 5117 int 5118 zfs_receive(libzfs_handle_t *hdl, const char *tosnap, nvlist_t *props, 5119 recvflags_t *flags, int infd, avl_tree_t *stream_avl) 5120 { 5121 char *top_zfs = NULL; 5122 int err; 5123 struct stat sb; 5124 char *originsnap = NULL; 5125 5126 /* 5127 * The only way fstat can fail is if we do not have a valid file 5128 * descriptor. 5129 */ 5130 if (fstat(infd, &sb) == -1) { 5131 perror("fstat"); 5132 return (-2); 5133 } 5134 5135 /* 5136 * It is not uncommon for gigabytes to be processed in zfs receive. 5137 * Speculatively increase the buffer size if supported by the platform. 5138 */ 5139 if (S_ISFIFO(sb.st_mode)) 5140 libzfs_set_pipe_max(infd); 5141 5142 if (props) { 5143 err = nvlist_lookup_string(props, "origin", &originsnap); 5144 if (err && err != ENOENT) 5145 return (err); 5146 } 5147 5148 err = zfs_receive_impl(hdl, tosnap, originsnap, flags, infd, NULL, NULL, 5149 stream_avl, &top_zfs, NULL, props); 5150 5151 if (err == 0 && !flags->nomount && flags->domount && top_zfs) { 5152 zfs_handle_t *zhp = NULL; 5153 prop_changelist_t *clp = NULL; 5154 5155 zhp = zfs_open(hdl, top_zfs, 5156 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME); 5157 if (zhp == NULL) { 5158 err = -1; 5159 goto out; 5160 } else { 5161 if (zhp->zfs_type == ZFS_TYPE_VOLUME) { 5162 zfs_close(zhp); 5163 goto out; 5164 } 5165 5166 clp = changelist_gather(zhp, ZFS_PROP_MOUNTPOINT, 5167 CL_GATHER_MOUNT_ALWAYS, 5168 flags->forceunmount ? MS_FORCE : 0); 5169 zfs_close(zhp); 5170 if (clp == NULL) { 5171 err = -1; 5172 goto out; 5173 } 5174 5175 /* mount and share received datasets */ 5176 err = changelist_postfix(clp); 5177 changelist_free(clp); 5178 if (err != 0) 5179 err = -1; 5180 } 5181 } 5182 5183 out: 5184 if (top_zfs) 5185 free(top_zfs); 5186 5187 return (err); 5188 } 5189