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 2010 Sun Microsystems, Inc. All rights reserved. 24 * Use is subject to license terms. 25 */ 26 27 #include <assert.h> 28 #include <ctype.h> 29 #include <errno.h> 30 #include <libintl.h> 31 #include <stdio.h> 32 #include <stdlib.h> 33 #include <strings.h> 34 #include <unistd.h> 35 #include <stddef.h> 36 #include <fcntl.h> 37 #include <sys/mount.h> 38 #include <pthread.h> 39 #include <umem.h> 40 41 #include <libzfs.h> 42 43 #include "zfs_namecheck.h" 44 #include "zfs_prop.h" 45 #include "zfs_fletcher.h" 46 #include "libzfs_impl.h" 47 #include <sha2.h> 48 #include <sys/zio_checksum.h> 49 #include <sys/ddt.h> 50 51 /* in libzfs_dataset.c */ 52 extern void zfs_setprop_error(libzfs_handle_t *, zfs_prop_t, int, char *); 53 54 static int zfs_receive_impl(libzfs_handle_t *, const char *, recvflags_t, 55 int, avl_tree_t *, char **); 56 57 static const zio_cksum_t zero_cksum = { 0 }; 58 59 typedef struct dedup_arg { 60 int inputfd; 61 int outputfd; 62 libzfs_handle_t *dedup_hdl; 63 } dedup_arg_t; 64 65 typedef struct dataref { 66 uint64_t ref_guid; 67 uint64_t ref_object; 68 uint64_t ref_offset; 69 } dataref_t; 70 71 typedef struct dedup_entry { 72 struct dedup_entry *dde_next; 73 zio_cksum_t dde_chksum; 74 uint64_t dde_prop; 75 dataref_t dde_ref; 76 } dedup_entry_t; 77 78 #define MAX_DDT_PHYSMEM_PERCENT 20 79 #define SMALLEST_POSSIBLE_MAX_DDT_MB 128 80 81 typedef struct dedup_table { 82 dedup_entry_t **dedup_hash_array; 83 umem_cache_t *ddecache; 84 uint64_t max_ddt_size; /* max dedup table size in bytes */ 85 uint64_t cur_ddt_size; /* current dedup table size in bytes */ 86 uint64_t ddt_count; 87 int numhashbits; 88 boolean_t ddt_full; 89 } dedup_table_t; 90 91 static int 92 high_order_bit(uint64_t n) 93 { 94 int count; 95 96 for (count = 0; n != 0; count++) 97 n >>= 1; 98 return (count); 99 } 100 101 static size_t 102 ssread(void *buf, size_t len, FILE *stream) 103 { 104 size_t outlen; 105 106 if ((outlen = fread(buf, len, 1, stream)) == 0) 107 return (0); 108 109 return (outlen); 110 } 111 112 static void 113 ddt_hash_append(libzfs_handle_t *hdl, dedup_table_t *ddt, dedup_entry_t **ddepp, 114 zio_cksum_t *cs, uint64_t prop, dataref_t *dr) 115 { 116 dedup_entry_t *dde; 117 118 if (ddt->cur_ddt_size >= ddt->max_ddt_size) { 119 if (ddt->ddt_full == B_FALSE) { 120 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 121 "Dedup table full. Deduplication will continue " 122 "with existing table entries")); 123 ddt->ddt_full = B_TRUE; 124 } 125 return; 126 } 127 128 if ((dde = umem_cache_alloc(ddt->ddecache, UMEM_DEFAULT)) 129 != NULL) { 130 assert(*ddepp == NULL); 131 dde->dde_next = NULL; 132 dde->dde_chksum = *cs; 133 dde->dde_prop = prop; 134 dde->dde_ref = *dr; 135 *ddepp = dde; 136 ddt->cur_ddt_size += sizeof (dedup_entry_t); 137 ddt->ddt_count++; 138 } 139 } 140 141 /* 142 * Using the specified dedup table, do a lookup for an entry with 143 * the checksum cs. If found, return the block's reference info 144 * in *dr. Otherwise, insert a new entry in the dedup table, using 145 * the reference information specified by *dr. 146 * 147 * return value: true - entry was found 148 * false - entry was not found 149 */ 150 static boolean_t 151 ddt_update(libzfs_handle_t *hdl, dedup_table_t *ddt, zio_cksum_t *cs, 152 uint64_t prop, dataref_t *dr) 153 { 154 uint32_t hashcode; 155 dedup_entry_t **ddepp; 156 157 hashcode = BF64_GET(cs->zc_word[0], 0, ddt->numhashbits); 158 159 for (ddepp = &(ddt->dedup_hash_array[hashcode]); *ddepp != NULL; 160 ddepp = &((*ddepp)->dde_next)) { 161 if (ZIO_CHECKSUM_EQUAL(((*ddepp)->dde_chksum), *cs) && 162 (*ddepp)->dde_prop == prop) { 163 *dr = (*ddepp)->dde_ref; 164 return (B_TRUE); 165 } 166 } 167 ddt_hash_append(hdl, ddt, ddepp, cs, prop, dr); 168 return (B_FALSE); 169 } 170 171 static int 172 cksum_and_write(const void *buf, uint64_t len, zio_cksum_t *zc, int outfd) 173 { 174 fletcher_4_incremental_native(buf, len, zc); 175 return (write(outfd, buf, len)); 176 } 177 178 /* 179 * This function is started in a separate thread when the dedup option 180 * has been requested. The main send thread determines the list of 181 * snapshots to be included in the send stream and makes the ioctl calls 182 * for each one. But instead of having the ioctl send the output to the 183 * the output fd specified by the caller of zfs_send()), the 184 * ioctl is told to direct the output to a pipe, which is read by the 185 * alternate thread running THIS function. This function does the 186 * dedup'ing by: 187 * 1. building a dedup table (the DDT) 188 * 2. doing checksums on each data block and inserting a record in the DDT 189 * 3. looking for matching checksums, and 190 * 4. sending a DRR_WRITE_BYREF record instead of a write record whenever 191 * a duplicate block is found. 192 * The output of this function then goes to the output fd requested 193 * by the caller of zfs_send(). 194 */ 195 static void * 196 cksummer(void *arg) 197 { 198 dedup_arg_t *dda = arg; 199 char *buf = malloc(1<<20); 200 dmu_replay_record_t thedrr; 201 dmu_replay_record_t *drr = &thedrr; 202 struct drr_begin *drrb = &thedrr.drr_u.drr_begin; 203 struct drr_end *drre = &thedrr.drr_u.drr_end; 204 struct drr_object *drro = &thedrr.drr_u.drr_object; 205 struct drr_write *drrw = &thedrr.drr_u.drr_write; 206 FILE *ofp; 207 int outfd; 208 dmu_replay_record_t wbr_drr = {0}; 209 struct drr_write_byref *wbr_drrr = &wbr_drr.drr_u.drr_write_byref; 210 dedup_table_t ddt; 211 zio_cksum_t stream_cksum; 212 uint64_t physmem = sysconf(_SC_PHYS_PAGES) * sysconf(_SC_PAGESIZE); 213 uint64_t numbuckets; 214 215 ddt.max_ddt_size = 216 MAX((physmem * MAX_DDT_PHYSMEM_PERCENT)/100, 217 SMALLEST_POSSIBLE_MAX_DDT_MB<<20); 218 219 numbuckets = ddt.max_ddt_size/(sizeof (dedup_entry_t)); 220 221 /* 222 * numbuckets must be a power of 2. Increase number to 223 * a power of 2 if necessary. 224 */ 225 if (!ISP2(numbuckets)) 226 numbuckets = 1 << high_order_bit(numbuckets); 227 228 ddt.dedup_hash_array = calloc(numbuckets, sizeof (dedup_entry_t *)); 229 ddt.ddecache = umem_cache_create("dde", sizeof (dedup_entry_t), 0, 230 NULL, NULL, NULL, NULL, NULL, 0); 231 ddt.cur_ddt_size = numbuckets * sizeof (dedup_entry_t *); 232 ddt.numhashbits = high_order_bit(numbuckets) - 1; 233 ddt.ddt_full = B_FALSE; 234 235 /* Initialize the write-by-reference block. */ 236 wbr_drr.drr_type = DRR_WRITE_BYREF; 237 wbr_drr.drr_payloadlen = 0; 238 239 outfd = dda->outputfd; 240 ofp = fdopen(dda->inputfd, "r"); 241 while (ssread(drr, sizeof (dmu_replay_record_t), ofp) != 0) { 242 243 switch (drr->drr_type) { 244 case DRR_BEGIN: 245 { 246 int fflags; 247 ZIO_SET_CHECKSUM(&stream_cksum, 0, 0, 0, 0); 248 249 /* set the DEDUP feature flag for this stream */ 250 fflags = DMU_GET_FEATUREFLAGS(drrb->drr_versioninfo); 251 fflags |= (DMU_BACKUP_FEATURE_DEDUP | 252 DMU_BACKUP_FEATURE_DEDUPPROPS); 253 DMU_SET_FEATUREFLAGS(drrb->drr_versioninfo, fflags); 254 255 if (cksum_and_write(drr, sizeof (dmu_replay_record_t), 256 &stream_cksum, outfd) == -1) 257 goto out; 258 if (DMU_GET_STREAM_HDRTYPE(drrb->drr_versioninfo) == 259 DMU_COMPOUNDSTREAM && drr->drr_payloadlen != 0) { 260 int sz = drr->drr_payloadlen; 261 262 if (sz > 1<<20) { 263 free(buf); 264 buf = malloc(sz); 265 } 266 (void) ssread(buf, sz, ofp); 267 if (ferror(stdin)) 268 perror("fread"); 269 if (cksum_and_write(buf, sz, &stream_cksum, 270 outfd) == -1) 271 goto out; 272 } 273 break; 274 } 275 276 case DRR_END: 277 { 278 /* use the recalculated checksum */ 279 ZIO_SET_CHECKSUM(&drre->drr_checksum, 280 stream_cksum.zc_word[0], stream_cksum.zc_word[1], 281 stream_cksum.zc_word[2], stream_cksum.zc_word[3]); 282 if ((write(outfd, drr, 283 sizeof (dmu_replay_record_t))) == -1) 284 goto out; 285 break; 286 } 287 288 case DRR_OBJECT: 289 { 290 if (cksum_and_write(drr, sizeof (dmu_replay_record_t), 291 &stream_cksum, outfd) == -1) 292 goto out; 293 if (drro->drr_bonuslen > 0) { 294 (void) ssread(buf, 295 P2ROUNDUP((uint64_t)drro->drr_bonuslen, 8), 296 ofp); 297 if (cksum_and_write(buf, 298 P2ROUNDUP((uint64_t)drro->drr_bonuslen, 8), 299 &stream_cksum, outfd) == -1) 300 goto out; 301 } 302 break; 303 } 304 305 case DRR_FREEOBJECTS: 306 { 307 if (cksum_and_write(drr, sizeof (dmu_replay_record_t), 308 &stream_cksum, outfd) == -1) 309 goto out; 310 break; 311 } 312 313 case DRR_WRITE: 314 { 315 dataref_t dataref; 316 317 (void) ssread(buf, drrw->drr_length, ofp); 318 319 /* 320 * Use the existing checksum if it's dedup-capable, 321 * else calculate a SHA256 checksum for it. 322 */ 323 324 if (ZIO_CHECKSUM_EQUAL(drrw->drr_key.ddk_cksum, 325 zero_cksum) || 326 !DRR_IS_DEDUP_CAPABLE(drrw->drr_checksumflags)) { 327 SHA256_CTX ctx; 328 zio_cksum_t tmpsha256; 329 330 SHA256Init(&ctx); 331 SHA256Update(&ctx, buf, drrw->drr_length); 332 SHA256Final(&tmpsha256, &ctx); 333 drrw->drr_key.ddk_cksum.zc_word[0] = 334 BE_64(tmpsha256.zc_word[0]); 335 drrw->drr_key.ddk_cksum.zc_word[1] = 336 BE_64(tmpsha256.zc_word[1]); 337 drrw->drr_key.ddk_cksum.zc_word[2] = 338 BE_64(tmpsha256.zc_word[2]); 339 drrw->drr_key.ddk_cksum.zc_word[3] = 340 BE_64(tmpsha256.zc_word[3]); 341 drrw->drr_checksumtype = ZIO_CHECKSUM_SHA256; 342 drrw->drr_checksumflags = DRR_CHECKSUM_DEDUP; 343 } 344 345 dataref.ref_guid = drrw->drr_toguid; 346 dataref.ref_object = drrw->drr_object; 347 dataref.ref_offset = drrw->drr_offset; 348 349 if (ddt_update(dda->dedup_hdl, &ddt, 350 &drrw->drr_key.ddk_cksum, drrw->drr_key.ddk_prop, 351 &dataref)) { 352 /* block already present in stream */ 353 wbr_drrr->drr_object = drrw->drr_object; 354 wbr_drrr->drr_offset = drrw->drr_offset; 355 wbr_drrr->drr_length = drrw->drr_length; 356 wbr_drrr->drr_toguid = drrw->drr_toguid; 357 wbr_drrr->drr_refguid = dataref.ref_guid; 358 wbr_drrr->drr_refobject = 359 dataref.ref_object; 360 wbr_drrr->drr_refoffset = 361 dataref.ref_offset; 362 363 wbr_drrr->drr_checksumtype = 364 drrw->drr_checksumtype; 365 wbr_drrr->drr_checksumflags = 366 drrw->drr_checksumtype; 367 wbr_drrr->drr_key.ddk_cksum = 368 drrw->drr_key.ddk_cksum; 369 wbr_drrr->drr_key.ddk_prop = 370 drrw->drr_key.ddk_prop; 371 372 if (cksum_and_write(&wbr_drr, 373 sizeof (dmu_replay_record_t), &stream_cksum, 374 outfd) == -1) 375 goto out; 376 } else { 377 /* block not previously seen */ 378 if (cksum_and_write(drr, 379 sizeof (dmu_replay_record_t), &stream_cksum, 380 outfd) == -1) 381 goto out; 382 if (cksum_and_write(buf, 383 drrw->drr_length, 384 &stream_cksum, outfd) == -1) 385 goto out; 386 } 387 break; 388 } 389 390 case DRR_FREE: 391 { 392 if (cksum_and_write(drr, sizeof (dmu_replay_record_t), 393 &stream_cksum, outfd) == -1) 394 goto out; 395 break; 396 } 397 398 default: 399 (void) printf("INVALID record type 0x%x\n", 400 drr->drr_type); 401 /* should never happen, so assert */ 402 assert(B_FALSE); 403 } 404 } 405 out: 406 umem_cache_destroy(ddt.ddecache); 407 free(ddt.dedup_hash_array); 408 free(buf); 409 (void) fclose(ofp); 410 411 return (NULL); 412 } 413 414 /* 415 * Routines for dealing with the AVL tree of fs-nvlists 416 */ 417 typedef struct fsavl_node { 418 avl_node_t fn_node; 419 nvlist_t *fn_nvfs; 420 char *fn_snapname; 421 uint64_t fn_guid; 422 } fsavl_node_t; 423 424 static int 425 fsavl_compare(const void *arg1, const void *arg2) 426 { 427 const fsavl_node_t *fn1 = arg1; 428 const fsavl_node_t *fn2 = arg2; 429 430 if (fn1->fn_guid > fn2->fn_guid) 431 return (+1); 432 else if (fn1->fn_guid < fn2->fn_guid) 433 return (-1); 434 else 435 return (0); 436 } 437 438 /* 439 * Given the GUID of a snapshot, find its containing filesystem and 440 * (optionally) name. 441 */ 442 static nvlist_t * 443 fsavl_find(avl_tree_t *avl, uint64_t snapguid, char **snapname) 444 { 445 fsavl_node_t fn_find; 446 fsavl_node_t *fn; 447 448 fn_find.fn_guid = snapguid; 449 450 fn = avl_find(avl, &fn_find, NULL); 451 if (fn) { 452 if (snapname) 453 *snapname = fn->fn_snapname; 454 return (fn->fn_nvfs); 455 } 456 return (NULL); 457 } 458 459 static void 460 fsavl_destroy(avl_tree_t *avl) 461 { 462 fsavl_node_t *fn; 463 void *cookie; 464 465 if (avl == NULL) 466 return; 467 468 cookie = NULL; 469 while ((fn = avl_destroy_nodes(avl, &cookie)) != NULL) 470 free(fn); 471 avl_destroy(avl); 472 free(avl); 473 } 474 475 /* 476 * Given an nvlist, produce an avl tree of snapshots, ordered by guid 477 */ 478 static avl_tree_t * 479 fsavl_create(nvlist_t *fss) 480 { 481 avl_tree_t *fsavl; 482 nvpair_t *fselem = NULL; 483 484 if ((fsavl = malloc(sizeof (avl_tree_t))) == NULL) 485 return (NULL); 486 487 avl_create(fsavl, fsavl_compare, sizeof (fsavl_node_t), 488 offsetof(fsavl_node_t, fn_node)); 489 490 while ((fselem = nvlist_next_nvpair(fss, fselem)) != NULL) { 491 nvlist_t *nvfs, *snaps; 492 nvpair_t *snapelem = NULL; 493 494 VERIFY(0 == nvpair_value_nvlist(fselem, &nvfs)); 495 VERIFY(0 == nvlist_lookup_nvlist(nvfs, "snaps", &snaps)); 496 497 while ((snapelem = 498 nvlist_next_nvpair(snaps, snapelem)) != NULL) { 499 fsavl_node_t *fn; 500 uint64_t guid; 501 502 VERIFY(0 == nvpair_value_uint64(snapelem, &guid)); 503 if ((fn = malloc(sizeof (fsavl_node_t))) == NULL) { 504 fsavl_destroy(fsavl); 505 return (NULL); 506 } 507 fn->fn_nvfs = nvfs; 508 fn->fn_snapname = nvpair_name(snapelem); 509 fn->fn_guid = guid; 510 511 /* 512 * Note: if there are multiple snaps with the 513 * same GUID, we ignore all but one. 514 */ 515 if (avl_find(fsavl, fn, NULL) == NULL) 516 avl_add(fsavl, fn); 517 else 518 free(fn); 519 } 520 } 521 522 return (fsavl); 523 } 524 525 /* 526 * Routines for dealing with the giant nvlist of fs-nvlists, etc. 527 */ 528 typedef struct send_data { 529 uint64_t parent_fromsnap_guid; 530 nvlist_t *parent_snaps; 531 nvlist_t *fss; 532 nvlist_t *snapprops; 533 const char *fromsnap; 534 const char *tosnap; 535 boolean_t recursive; 536 537 /* 538 * The header nvlist is of the following format: 539 * { 540 * "tosnap" -> string 541 * "fromsnap" -> string (if incremental) 542 * "fss" -> { 543 * id -> { 544 * 545 * "name" -> string (full name; for debugging) 546 * "parentfromsnap" -> number (guid of fromsnap in parent) 547 * 548 * "props" -> { name -> value (only if set here) } 549 * "snaps" -> { name (lastname) -> number (guid) } 550 * "snapprops" -> { name (lastname) -> { name -> value } } 551 * 552 * "origin" -> number (guid) (if clone) 553 * "sent" -> boolean (not on-disk) 554 * } 555 * } 556 * } 557 * 558 */ 559 } send_data_t; 560 561 static void send_iterate_prop(zfs_handle_t *zhp, nvlist_t *nv); 562 563 static int 564 send_iterate_snap(zfs_handle_t *zhp, void *arg) 565 { 566 send_data_t *sd = arg; 567 uint64_t guid = zhp->zfs_dmustats.dds_guid; 568 char *snapname; 569 nvlist_t *nv; 570 571 snapname = strrchr(zhp->zfs_name, '@')+1; 572 573 VERIFY(0 == nvlist_add_uint64(sd->parent_snaps, snapname, guid)); 574 /* 575 * NB: if there is no fromsnap here (it's a newly created fs in 576 * an incremental replication), we will substitute the tosnap. 577 */ 578 if ((sd->fromsnap && strcmp(snapname, sd->fromsnap) == 0) || 579 (sd->parent_fromsnap_guid == 0 && sd->tosnap && 580 strcmp(snapname, sd->tosnap) == 0)) { 581 sd->parent_fromsnap_guid = guid; 582 } 583 584 VERIFY(0 == nvlist_alloc(&nv, NV_UNIQUE_NAME, 0)); 585 send_iterate_prop(zhp, nv); 586 VERIFY(0 == nvlist_add_nvlist(sd->snapprops, snapname, nv)); 587 nvlist_free(nv); 588 589 zfs_close(zhp); 590 return (0); 591 } 592 593 static void 594 send_iterate_prop(zfs_handle_t *zhp, nvlist_t *nv) 595 { 596 nvpair_t *elem = NULL; 597 598 while ((elem = nvlist_next_nvpair(zhp->zfs_props, elem)) != NULL) { 599 char *propname = nvpair_name(elem); 600 zfs_prop_t prop = zfs_name_to_prop(propname); 601 nvlist_t *propnv; 602 603 if (!zfs_prop_user(propname)) { 604 /* 605 * Realistically, this should never happen. However, 606 * we want the ability to add DSL properties without 607 * needing to make incompatible version changes. We 608 * need to ignore unknown properties to allow older 609 * software to still send datasets containing these 610 * properties, with the unknown properties elided. 611 */ 612 if (prop == ZPROP_INVAL) 613 continue; 614 615 if (zfs_prop_readonly(prop)) 616 continue; 617 } 618 619 verify(nvpair_value_nvlist(elem, &propnv) == 0); 620 if (prop == ZFS_PROP_QUOTA || prop == ZFS_PROP_RESERVATION || 621 prop == ZFS_PROP_REFQUOTA || 622 prop == ZFS_PROP_REFRESERVATION) { 623 char *source; 624 uint64_t value; 625 verify(nvlist_lookup_uint64(propnv, 626 ZPROP_VALUE, &value) == 0); 627 if (zhp->zfs_type == ZFS_TYPE_SNAPSHOT) 628 continue; 629 /* 630 * May have no source before SPA_VERSION_RECVD_PROPS, 631 * but is still modifiable. 632 */ 633 if (nvlist_lookup_string(propnv, 634 ZPROP_SOURCE, &source) == 0) { 635 if ((strcmp(source, zhp->zfs_name) != 0) && 636 (strcmp(source, 637 ZPROP_SOURCE_VAL_RECVD) != 0)) 638 continue; 639 } 640 } else { 641 char *source; 642 if (nvlist_lookup_string(propnv, 643 ZPROP_SOURCE, &source) != 0) 644 continue; 645 if ((strcmp(source, zhp->zfs_name) != 0) && 646 (strcmp(source, ZPROP_SOURCE_VAL_RECVD) != 0)) 647 continue; 648 } 649 650 if (zfs_prop_user(propname) || 651 zfs_prop_get_type(prop) == PROP_TYPE_STRING) { 652 char *value; 653 verify(nvlist_lookup_string(propnv, 654 ZPROP_VALUE, &value) == 0); 655 VERIFY(0 == nvlist_add_string(nv, propname, value)); 656 } else { 657 uint64_t value; 658 verify(nvlist_lookup_uint64(propnv, 659 ZPROP_VALUE, &value) == 0); 660 VERIFY(0 == nvlist_add_uint64(nv, propname, value)); 661 } 662 } 663 } 664 665 /* 666 * recursively generate nvlists describing datasets. See comment 667 * for the data structure send_data_t above for description of contents 668 * of the nvlist. 669 */ 670 static int 671 send_iterate_fs(zfs_handle_t *zhp, void *arg) 672 { 673 send_data_t *sd = arg; 674 nvlist_t *nvfs, *nv; 675 int rv = 0; 676 uint64_t parent_fromsnap_guid_save = sd->parent_fromsnap_guid; 677 uint64_t guid = zhp->zfs_dmustats.dds_guid; 678 char guidstring[64]; 679 680 VERIFY(0 == nvlist_alloc(&nvfs, NV_UNIQUE_NAME, 0)); 681 VERIFY(0 == nvlist_add_string(nvfs, "name", zhp->zfs_name)); 682 VERIFY(0 == nvlist_add_uint64(nvfs, "parentfromsnap", 683 sd->parent_fromsnap_guid)); 684 685 if (zhp->zfs_dmustats.dds_origin[0]) { 686 zfs_handle_t *origin = zfs_open(zhp->zfs_hdl, 687 zhp->zfs_dmustats.dds_origin, ZFS_TYPE_SNAPSHOT); 688 if (origin == NULL) 689 return (-1); 690 VERIFY(0 == nvlist_add_uint64(nvfs, "origin", 691 origin->zfs_dmustats.dds_guid)); 692 } 693 694 /* iterate over props */ 695 VERIFY(0 == nvlist_alloc(&nv, NV_UNIQUE_NAME, 0)); 696 send_iterate_prop(zhp, nv); 697 VERIFY(0 == nvlist_add_nvlist(nvfs, "props", nv)); 698 nvlist_free(nv); 699 700 /* iterate over snaps, and set sd->parent_fromsnap_guid */ 701 sd->parent_fromsnap_guid = 0; 702 VERIFY(0 == nvlist_alloc(&sd->parent_snaps, NV_UNIQUE_NAME, 0)); 703 VERIFY(0 == nvlist_alloc(&sd->snapprops, NV_UNIQUE_NAME, 0)); 704 (void) zfs_iter_snapshots(zhp, send_iterate_snap, sd); 705 VERIFY(0 == nvlist_add_nvlist(nvfs, "snaps", sd->parent_snaps)); 706 VERIFY(0 == nvlist_add_nvlist(nvfs, "snapprops", sd->snapprops)); 707 nvlist_free(sd->parent_snaps); 708 nvlist_free(sd->snapprops); 709 710 /* add this fs to nvlist */ 711 (void) snprintf(guidstring, sizeof (guidstring), 712 "0x%llx", (longlong_t)guid); 713 VERIFY(0 == nvlist_add_nvlist(sd->fss, guidstring, nvfs)); 714 nvlist_free(nvfs); 715 716 /* iterate over children */ 717 if (sd->recursive) 718 rv = zfs_iter_filesystems(zhp, send_iterate_fs, sd); 719 720 sd->parent_fromsnap_guid = parent_fromsnap_guid_save; 721 722 zfs_close(zhp); 723 return (rv); 724 } 725 726 static int 727 gather_nvlist(libzfs_handle_t *hdl, const char *fsname, const char *fromsnap, 728 const char *tosnap, boolean_t recursive, nvlist_t **nvlp, avl_tree_t **avlp) 729 { 730 zfs_handle_t *zhp; 731 send_data_t sd = { 0 }; 732 int error; 733 734 zhp = zfs_open(hdl, fsname, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME); 735 if (zhp == NULL) 736 return (EZFS_BADTYPE); 737 738 VERIFY(0 == nvlist_alloc(&sd.fss, NV_UNIQUE_NAME, 0)); 739 sd.fromsnap = fromsnap; 740 sd.tosnap = tosnap; 741 sd.recursive = recursive; 742 743 if ((error = send_iterate_fs(zhp, &sd)) != 0) { 744 nvlist_free(sd.fss); 745 if (avlp != NULL) 746 *avlp = NULL; 747 *nvlp = NULL; 748 return (error); 749 } 750 751 if (avlp != NULL && (*avlp = fsavl_create(sd.fss)) == NULL) { 752 nvlist_free(sd.fss); 753 *nvlp = NULL; 754 return (EZFS_NOMEM); 755 } 756 757 *nvlp = sd.fss; 758 return (0); 759 } 760 761 /* 762 * Routines for dealing with the sorted snapshot functionality 763 */ 764 typedef struct zfs_node { 765 zfs_handle_t *zn_handle; 766 avl_node_t zn_avlnode; 767 } zfs_node_t; 768 769 static int 770 zfs_sort_snaps(zfs_handle_t *zhp, void *data) 771 { 772 avl_tree_t *avl = data; 773 zfs_node_t *node = zfs_alloc(zhp->zfs_hdl, sizeof (zfs_node_t)); 774 775 node->zn_handle = zhp; 776 avl_add(avl, node); 777 return (0); 778 } 779 780 /* ARGSUSED */ 781 static int 782 zfs_snapshot_compare(const void *larg, const void *rarg) 783 { 784 zfs_handle_t *l = ((zfs_node_t *)larg)->zn_handle; 785 zfs_handle_t *r = ((zfs_node_t *)rarg)->zn_handle; 786 uint64_t lcreate, rcreate; 787 788 /* 789 * Sort them according to creation time. We use the hidden 790 * CREATETXG property to get an absolute ordering of snapshots. 791 */ 792 lcreate = zfs_prop_get_int(l, ZFS_PROP_CREATETXG); 793 rcreate = zfs_prop_get_int(r, ZFS_PROP_CREATETXG); 794 795 if (lcreate < rcreate) 796 return (-1); 797 else if (lcreate > rcreate) 798 return (+1); 799 else 800 return (0); 801 } 802 803 int 804 zfs_iter_snapshots_sorted(zfs_handle_t *zhp, zfs_iter_f callback, void *data) 805 { 806 int ret = 0; 807 zfs_node_t *node; 808 avl_tree_t avl; 809 void *cookie = NULL; 810 811 avl_create(&avl, zfs_snapshot_compare, 812 sizeof (zfs_node_t), offsetof(zfs_node_t, zn_avlnode)); 813 814 ret = zfs_iter_snapshots(zhp, zfs_sort_snaps, &avl); 815 816 for (node = avl_first(&avl); node != NULL; node = AVL_NEXT(&avl, node)) 817 ret |= callback(node->zn_handle, data); 818 819 while ((node = avl_destroy_nodes(&avl, &cookie)) != NULL) 820 free(node); 821 822 avl_destroy(&avl); 823 824 return (ret); 825 } 826 827 /* 828 * Routines specific to "zfs send" 829 */ 830 typedef struct send_dump_data { 831 /* these are all just the short snapname (the part after the @) */ 832 const char *fromsnap; 833 const char *tosnap; 834 char prevsnap[ZFS_MAXNAMELEN]; 835 boolean_t seenfrom, seento, replicate, doall, fromorigin; 836 boolean_t verbose; 837 int outfd; 838 boolean_t err; 839 nvlist_t *fss; 840 avl_tree_t *fsavl; 841 snapfilter_cb_t *filter_cb; 842 void *filter_cb_arg; 843 } send_dump_data_t; 844 845 /* 846 * Dumps a backup of the given snapshot (incremental from fromsnap if it's not 847 * NULL) to the file descriptor specified by outfd. 848 */ 849 static int 850 dump_ioctl(zfs_handle_t *zhp, const char *fromsnap, boolean_t fromorigin, 851 int outfd) 852 { 853 zfs_cmd_t zc = { 0 }; 854 libzfs_handle_t *hdl = zhp->zfs_hdl; 855 856 assert(zhp->zfs_type == ZFS_TYPE_SNAPSHOT); 857 assert(fromsnap == NULL || fromsnap[0] == '\0' || !fromorigin); 858 859 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name)); 860 if (fromsnap) 861 (void) strlcpy(zc.zc_value, fromsnap, sizeof (zc.zc_value)); 862 zc.zc_cookie = outfd; 863 zc.zc_obj = fromorigin; 864 865 if (ioctl(zhp->zfs_hdl->libzfs_fd, ZFS_IOC_SEND, &zc) != 0) { 866 char errbuf[1024]; 867 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN, 868 "warning: cannot send '%s'"), zhp->zfs_name); 869 870 switch (errno) { 871 872 case EXDEV: 873 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 874 "not an earlier snapshot from the same fs")); 875 return (zfs_error(hdl, EZFS_CROSSTARGET, errbuf)); 876 877 case ENOENT: 878 if (zfs_dataset_exists(hdl, zc.zc_name, 879 ZFS_TYPE_SNAPSHOT)) { 880 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 881 "incremental source (@%s) does not exist"), 882 zc.zc_value); 883 } 884 return (zfs_error(hdl, EZFS_NOENT, errbuf)); 885 886 case EDQUOT: 887 case EFBIG: 888 case EIO: 889 case ENOLINK: 890 case ENOSPC: 891 case ENOSTR: 892 case ENXIO: 893 case EPIPE: 894 case ERANGE: 895 case EFAULT: 896 case EROFS: 897 zfs_error_aux(hdl, strerror(errno)); 898 return (zfs_error(hdl, EZFS_BADBACKUP, errbuf)); 899 900 default: 901 return (zfs_standard_error(hdl, errno, errbuf)); 902 } 903 } 904 905 return (0); 906 } 907 908 static int 909 dump_snapshot(zfs_handle_t *zhp, void *arg) 910 { 911 send_dump_data_t *sdd = arg; 912 const char *thissnap; 913 int err; 914 915 thissnap = strchr(zhp->zfs_name, '@') + 1; 916 917 if (sdd->fromsnap && !sdd->seenfrom && 918 strcmp(sdd->fromsnap, thissnap) == 0) { 919 sdd->seenfrom = B_TRUE; 920 (void) strcpy(sdd->prevsnap, thissnap); 921 zfs_close(zhp); 922 return (0); 923 } 924 925 if (sdd->seento || !sdd->seenfrom) { 926 zfs_close(zhp); 927 return (0); 928 } 929 930 if (strcmp(sdd->tosnap, thissnap) == 0) 931 sdd->seento = B_TRUE; 932 933 /* 934 * If a filter function exists, call it to determine whether 935 * this snapshot will be sent. 936 */ 937 if (sdd->filter_cb != NULL && 938 sdd->filter_cb(zhp, sdd->filter_cb_arg) == B_FALSE) { 939 /* 940 * This snapshot is filtered out. Don't send it, and don't 941 * set prevsnap, so it will be as if this snapshot didn't 942 * exist, and the next accepted snapshot will be sent as 943 * an incremental from the last accepted one, or as the 944 * first (and full) snapshot in the case of a replication, 945 * non-incremental send. 946 */ 947 zfs_close(zhp); 948 return (0); 949 } 950 951 /* send it */ 952 if (sdd->verbose) { 953 (void) fprintf(stderr, "sending from @%s to %s\n", 954 sdd->prevsnap, zhp->zfs_name); 955 } 956 957 err = dump_ioctl(zhp, sdd->prevsnap, 958 sdd->prevsnap[0] == '\0' && (sdd->fromorigin || sdd->replicate), 959 sdd->outfd); 960 961 (void) strcpy(sdd->prevsnap, thissnap); 962 zfs_close(zhp); 963 return (err); 964 } 965 966 static int 967 dump_filesystem(zfs_handle_t *zhp, void *arg) 968 { 969 int rv = 0; 970 send_dump_data_t *sdd = arg; 971 boolean_t missingfrom = B_FALSE; 972 zfs_cmd_t zc = { 0 }; 973 974 (void) snprintf(zc.zc_name, sizeof (zc.zc_name), "%s@%s", 975 zhp->zfs_name, sdd->tosnap); 976 if (ioctl(zhp->zfs_hdl->libzfs_fd, ZFS_IOC_OBJSET_STATS, &zc) != 0) { 977 (void) fprintf(stderr, "WARNING: " 978 "could not send %s@%s: does not exist\n", 979 zhp->zfs_name, sdd->tosnap); 980 sdd->err = B_TRUE; 981 return (0); 982 } 983 984 if (sdd->replicate && sdd->fromsnap) { 985 /* 986 * If this fs does not have fromsnap, and we're doing 987 * recursive, we need to send a full stream from the 988 * beginning (or an incremental from the origin if this 989 * is a clone). If we're doing non-recursive, then let 990 * them get the error. 991 */ 992 (void) snprintf(zc.zc_name, sizeof (zc.zc_name), "%s@%s", 993 zhp->zfs_name, sdd->fromsnap); 994 if (ioctl(zhp->zfs_hdl->libzfs_fd, 995 ZFS_IOC_OBJSET_STATS, &zc) != 0) { 996 missingfrom = B_TRUE; 997 } 998 } 999 1000 if (sdd->doall) { 1001 sdd->seenfrom = sdd->seento = sdd->prevsnap[0] = 0; 1002 if (sdd->fromsnap == NULL || missingfrom) 1003 sdd->seenfrom = B_TRUE; 1004 1005 rv = zfs_iter_snapshots_sorted(zhp, dump_snapshot, arg); 1006 if (!sdd->seenfrom) { 1007 (void) fprintf(stderr, 1008 "WARNING: could not send %s@%s:\n" 1009 "incremental source (%s@%s) does not exist\n", 1010 zhp->zfs_name, sdd->tosnap, 1011 zhp->zfs_name, sdd->fromsnap); 1012 sdd->err = B_TRUE; 1013 } else if (!sdd->seento) { 1014 if (sdd->fromsnap) { 1015 (void) fprintf(stderr, 1016 "WARNING: could not send %s@%s:\n" 1017 "incremental source (%s@%s) " 1018 "is not earlier than it\n", 1019 zhp->zfs_name, sdd->tosnap, 1020 zhp->zfs_name, sdd->fromsnap); 1021 } else { 1022 (void) fprintf(stderr, "WARNING: " 1023 "could not send %s@%s: does not exist\n", 1024 zhp->zfs_name, sdd->tosnap); 1025 } 1026 sdd->err = B_TRUE; 1027 } 1028 } else { 1029 zfs_handle_t *snapzhp; 1030 char snapname[ZFS_MAXNAMELEN]; 1031 1032 (void) snprintf(snapname, sizeof (snapname), "%s@%s", 1033 zfs_get_name(zhp), sdd->tosnap); 1034 snapzhp = zfs_open(zhp->zfs_hdl, snapname, ZFS_TYPE_SNAPSHOT); 1035 if (snapzhp == NULL) { 1036 rv = -1; 1037 } else { 1038 if (sdd->filter_cb == NULL || 1039 sdd->filter_cb(snapzhp, sdd->filter_cb_arg) == 1040 B_TRUE) { 1041 rv = dump_ioctl(snapzhp, 1042 missingfrom ? NULL : sdd->fromsnap, 1043 sdd->fromorigin || missingfrom, 1044 sdd->outfd); 1045 } 1046 sdd->seento = B_TRUE; 1047 zfs_close(snapzhp); 1048 } 1049 } 1050 1051 return (rv); 1052 } 1053 1054 static int 1055 dump_filesystems(zfs_handle_t *rzhp, void *arg) 1056 { 1057 send_dump_data_t *sdd = arg; 1058 nvpair_t *fspair; 1059 boolean_t needagain, progress; 1060 1061 if (!sdd->replicate) 1062 return (dump_filesystem(rzhp, sdd)); 1063 1064 again: 1065 needagain = progress = B_FALSE; 1066 for (fspair = nvlist_next_nvpair(sdd->fss, NULL); fspair; 1067 fspair = nvlist_next_nvpair(sdd->fss, fspair)) { 1068 nvlist_t *fslist; 1069 char *fsname; 1070 zfs_handle_t *zhp; 1071 int err; 1072 uint64_t origin_guid = 0; 1073 nvlist_t *origin_nv; 1074 1075 VERIFY(nvpair_value_nvlist(fspair, &fslist) == 0); 1076 if (nvlist_lookup_boolean(fslist, "sent") == 0) 1077 continue; 1078 1079 VERIFY(nvlist_lookup_string(fslist, "name", &fsname) == 0); 1080 (void) nvlist_lookup_uint64(fslist, "origin", &origin_guid); 1081 1082 origin_nv = fsavl_find(sdd->fsavl, origin_guid, NULL); 1083 if (origin_nv && 1084 nvlist_lookup_boolean(origin_nv, "sent") == ENOENT) { 1085 /* 1086 * origin has not been sent yet; 1087 * skip this clone. 1088 */ 1089 needagain = B_TRUE; 1090 continue; 1091 } 1092 1093 zhp = zfs_open(rzhp->zfs_hdl, fsname, ZFS_TYPE_DATASET); 1094 if (zhp == NULL) 1095 return (-1); 1096 err = dump_filesystem(zhp, sdd); 1097 VERIFY(nvlist_add_boolean(fslist, "sent") == 0); 1098 progress = B_TRUE; 1099 zfs_close(zhp); 1100 if (err) 1101 return (err); 1102 } 1103 if (needagain) { 1104 assert(progress); 1105 goto again; 1106 } 1107 return (0); 1108 } 1109 1110 /* 1111 * Generate a send stream for the dataset identified by the argument zhp. 1112 * 1113 * The content of the send stream is the snapshot identified by 1114 * 'tosnap'. Incremental streams are requested in two ways: 1115 * - from the snapshot identified by "fromsnap" (if non-null) or 1116 * - from the origin of the dataset identified by zhp, which must 1117 * be a clone. In this case, "fromsnap" is null and "fromorigin" 1118 * is TRUE. 1119 * 1120 * The send stream is recursive (i.e. dumps a hierarchy of snapshots) and 1121 * uses a special header (with a hdrtype field of DMU_COMPOUNDSTREAM) 1122 * if "replicate" is set. If "doall" is set, dump all the intermediate 1123 * snapshots. The DMU_COMPOUNDSTREAM header is used in the "doall" 1124 * case too. If "props" is set, send properties. 1125 */ 1126 int 1127 zfs_send(zfs_handle_t *zhp, const char *fromsnap, const char *tosnap, 1128 sendflags_t flags, int outfd, snapfilter_cb_t filter_func, 1129 void *cb_arg) 1130 { 1131 char errbuf[1024]; 1132 send_dump_data_t sdd = { 0 }; 1133 int err; 1134 nvlist_t *fss = NULL; 1135 avl_tree_t *fsavl = NULL; 1136 char holdtag[128]; 1137 static uint64_t holdseq; 1138 int spa_version; 1139 boolean_t holdsnaps = B_FALSE; 1140 pthread_t tid; 1141 int pipefd[2]; 1142 dedup_arg_t dda = { 0 }; 1143 int featureflags = 0; 1144 1145 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN, 1146 "cannot send '%s'"), zhp->zfs_name); 1147 1148 if (fromsnap && fromsnap[0] == '\0') { 1149 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN, 1150 "zero-length incremental source")); 1151 return (zfs_error(zhp->zfs_hdl, EZFS_NOENT, errbuf)); 1152 } 1153 1154 if (zfs_spa_version(zhp, &spa_version) == 0 && 1155 spa_version >= SPA_VERSION_USERREFS) 1156 holdsnaps = B_TRUE; 1157 1158 if (flags.dedup) { 1159 featureflags |= (DMU_BACKUP_FEATURE_DEDUP | 1160 DMU_BACKUP_FEATURE_DEDUPPROPS); 1161 if (err = pipe(pipefd)) { 1162 zfs_error_aux(zhp->zfs_hdl, strerror(errno)); 1163 return (zfs_error(zhp->zfs_hdl, EZFS_PIPEFAILED, 1164 errbuf)); 1165 } 1166 dda.outputfd = outfd; 1167 dda.inputfd = pipefd[1]; 1168 dda.dedup_hdl = zhp->zfs_hdl; 1169 if (err = pthread_create(&tid, NULL, cksummer, &dda)) { 1170 (void) close(pipefd[0]); 1171 (void) close(pipefd[1]); 1172 zfs_error_aux(zhp->zfs_hdl, strerror(errno)); 1173 return (zfs_error(zhp->zfs_hdl, 1174 EZFS_THREADCREATEFAILED, errbuf)); 1175 } 1176 } 1177 1178 if (flags.replicate || flags.doall || flags.props) { 1179 dmu_replay_record_t drr = { 0 }; 1180 char *packbuf = NULL; 1181 size_t buflen = 0; 1182 zio_cksum_t zc = { 0 }; 1183 1184 if (holdsnaps) { 1185 (void) snprintf(holdtag, sizeof (holdtag), 1186 ".send-%d-%llu", getpid(), (u_longlong_t)holdseq); 1187 ++holdseq; 1188 err = zfs_hold_range(zhp, fromsnap, tosnap, 1189 holdtag, B_TRUE); 1190 if (err) 1191 goto err_out; 1192 } 1193 1194 if (flags.replicate || flags.props) { 1195 nvlist_t *hdrnv; 1196 1197 VERIFY(0 == nvlist_alloc(&hdrnv, NV_UNIQUE_NAME, 0)); 1198 if (fromsnap) { 1199 VERIFY(0 == nvlist_add_string(hdrnv, 1200 "fromsnap", fromsnap)); 1201 } 1202 VERIFY(0 == nvlist_add_string(hdrnv, "tosnap", tosnap)); 1203 if (!flags.replicate) { 1204 VERIFY(0 == nvlist_add_boolean(hdrnv, 1205 "not_recursive")); 1206 } 1207 1208 err = gather_nvlist(zhp->zfs_hdl, zhp->zfs_name, 1209 fromsnap, tosnap, flags.replicate, &fss, &fsavl); 1210 if (err) { 1211 if (holdsnaps) { 1212 (void) zfs_release_range(zhp, fromsnap, 1213 tosnap, holdtag); 1214 } 1215 goto err_out; 1216 } 1217 VERIFY(0 == nvlist_add_nvlist(hdrnv, "fss", fss)); 1218 err = nvlist_pack(hdrnv, &packbuf, &buflen, 1219 NV_ENCODE_XDR, 0); 1220 nvlist_free(hdrnv); 1221 if (err) { 1222 fsavl_destroy(fsavl); 1223 nvlist_free(fss); 1224 if (holdsnaps) { 1225 (void) zfs_release_range(zhp, fromsnap, 1226 tosnap, holdtag); 1227 } 1228 goto stderr_out; 1229 } 1230 } 1231 1232 /* write first begin record */ 1233 drr.drr_type = DRR_BEGIN; 1234 drr.drr_u.drr_begin.drr_magic = DMU_BACKUP_MAGIC; 1235 DMU_SET_STREAM_HDRTYPE(drr.drr_u.drr_begin.drr_versioninfo, 1236 DMU_COMPOUNDSTREAM); 1237 DMU_SET_FEATUREFLAGS(drr.drr_u.drr_begin.drr_versioninfo, 1238 featureflags); 1239 (void) snprintf(drr.drr_u.drr_begin.drr_toname, 1240 sizeof (drr.drr_u.drr_begin.drr_toname), 1241 "%s@%s", zhp->zfs_name, tosnap); 1242 drr.drr_payloadlen = buflen; 1243 err = cksum_and_write(&drr, sizeof (drr), &zc, outfd); 1244 1245 /* write header nvlist */ 1246 if (err != -1 && packbuf != NULL) { 1247 err = cksum_and_write(packbuf, buflen, &zc, outfd); 1248 } 1249 free(packbuf); 1250 if (err == -1) { 1251 fsavl_destroy(fsavl); 1252 nvlist_free(fss); 1253 if (holdsnaps) { 1254 (void) zfs_release_range(zhp, fromsnap, tosnap, 1255 holdtag); 1256 } 1257 err = errno; 1258 goto stderr_out; 1259 } 1260 1261 /* write end record */ 1262 if (err != -1) { 1263 bzero(&drr, sizeof (drr)); 1264 drr.drr_type = DRR_END; 1265 drr.drr_u.drr_end.drr_checksum = zc; 1266 err = write(outfd, &drr, sizeof (drr)); 1267 if (err == -1) { 1268 fsavl_destroy(fsavl); 1269 nvlist_free(fss); 1270 if (holdsnaps) { 1271 (void) zfs_release_range(zhp, fromsnap, 1272 tosnap, holdtag); 1273 } 1274 err = errno; 1275 goto stderr_out; 1276 } 1277 } 1278 } 1279 1280 /* dump each stream */ 1281 sdd.fromsnap = fromsnap; 1282 sdd.tosnap = tosnap; 1283 if (flags.dedup) 1284 sdd.outfd = pipefd[0]; 1285 else 1286 sdd.outfd = outfd; 1287 sdd.replicate = flags.replicate; 1288 sdd.doall = flags.doall; 1289 sdd.fromorigin = flags.fromorigin; 1290 sdd.fss = fss; 1291 sdd.fsavl = fsavl; 1292 sdd.verbose = flags.verbose; 1293 sdd.filter_cb = filter_func; 1294 sdd.filter_cb_arg = cb_arg; 1295 err = dump_filesystems(zhp, &sdd); 1296 fsavl_destroy(fsavl); 1297 nvlist_free(fss); 1298 1299 if (flags.dedup) { 1300 (void) close(pipefd[0]); 1301 (void) pthread_join(tid, NULL); 1302 } 1303 1304 if (flags.replicate || flags.doall || flags.props) { 1305 /* 1306 * write final end record. NB: want to do this even if 1307 * there was some error, because it might not be totally 1308 * failed. 1309 */ 1310 dmu_replay_record_t drr = { 0 }; 1311 drr.drr_type = DRR_END; 1312 if (holdsnaps) { 1313 (void) zfs_release_range(zhp, fromsnap, tosnap, 1314 holdtag); 1315 } 1316 if (write(outfd, &drr, sizeof (drr)) == -1) { 1317 return (zfs_standard_error(zhp->zfs_hdl, 1318 errno, errbuf)); 1319 } 1320 } 1321 1322 return (err || sdd.err); 1323 1324 stderr_out: 1325 err = zfs_standard_error(zhp->zfs_hdl, err, errbuf); 1326 err_out: 1327 if (flags.dedup) { 1328 (void) pthread_cancel(tid); 1329 (void) pthread_join(tid, NULL); 1330 (void) close(pipefd[0]); 1331 } 1332 return (err); 1333 } 1334 1335 /* 1336 * Routines specific to "zfs recv" 1337 */ 1338 1339 static int 1340 recv_read(libzfs_handle_t *hdl, int fd, void *buf, int ilen, 1341 boolean_t byteswap, zio_cksum_t *zc) 1342 { 1343 char *cp = buf; 1344 int rv; 1345 int len = ilen; 1346 1347 do { 1348 rv = read(fd, cp, len); 1349 cp += rv; 1350 len -= rv; 1351 } while (rv > 0); 1352 1353 if (rv < 0 || len != 0) { 1354 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1355 "failed to read from stream")); 1356 return (zfs_error(hdl, EZFS_BADSTREAM, dgettext(TEXT_DOMAIN, 1357 "cannot receive"))); 1358 } 1359 1360 if (zc) { 1361 if (byteswap) 1362 fletcher_4_incremental_byteswap(buf, ilen, zc); 1363 else 1364 fletcher_4_incremental_native(buf, ilen, zc); 1365 } 1366 return (0); 1367 } 1368 1369 static int 1370 recv_read_nvlist(libzfs_handle_t *hdl, int fd, int len, nvlist_t **nvp, 1371 boolean_t byteswap, zio_cksum_t *zc) 1372 { 1373 char *buf; 1374 int err; 1375 1376 buf = zfs_alloc(hdl, len); 1377 if (buf == NULL) 1378 return (ENOMEM); 1379 1380 err = recv_read(hdl, fd, buf, len, byteswap, zc); 1381 if (err != 0) { 1382 free(buf); 1383 return (err); 1384 } 1385 1386 err = nvlist_unpack(buf, len, nvp, 0); 1387 free(buf); 1388 if (err != 0) { 1389 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, "invalid " 1390 "stream (malformed nvlist)")); 1391 return (EINVAL); 1392 } 1393 return (0); 1394 } 1395 1396 static int 1397 recv_rename(libzfs_handle_t *hdl, const char *name, const char *tryname, 1398 int baselen, char *newname, recvflags_t flags) 1399 { 1400 static int seq; 1401 zfs_cmd_t zc = { 0 }; 1402 int err; 1403 prop_changelist_t *clp; 1404 zfs_handle_t *zhp; 1405 1406 zhp = zfs_open(hdl, name, ZFS_TYPE_DATASET); 1407 if (zhp == NULL) 1408 return (-1); 1409 clp = changelist_gather(zhp, ZFS_PROP_NAME, 0, 1410 flags.force ? MS_FORCE : 0); 1411 zfs_close(zhp); 1412 if (clp == NULL) 1413 return (-1); 1414 err = changelist_prefix(clp); 1415 if (err) 1416 return (err); 1417 1418 zc.zc_objset_type = DMU_OST_ZFS; 1419 (void) strlcpy(zc.zc_name, name, sizeof (zc.zc_name)); 1420 1421 if (tryname) { 1422 (void) strcpy(newname, tryname); 1423 1424 (void) strlcpy(zc.zc_value, tryname, sizeof (zc.zc_value)); 1425 1426 if (flags.verbose) { 1427 (void) printf("attempting rename %s to %s\n", 1428 zc.zc_name, zc.zc_value); 1429 } 1430 err = ioctl(hdl->libzfs_fd, ZFS_IOC_RENAME, &zc); 1431 if (err == 0) 1432 changelist_rename(clp, name, tryname); 1433 } else { 1434 err = ENOENT; 1435 } 1436 1437 if (err != 0 && strncmp(name+baselen, "recv-", 5) != 0) { 1438 seq++; 1439 1440 (void) strncpy(newname, name, baselen); 1441 (void) snprintf(newname+baselen, ZFS_MAXNAMELEN-baselen, 1442 "recv-%u-%u", getpid(), seq); 1443 (void) strlcpy(zc.zc_value, newname, sizeof (zc.zc_value)); 1444 1445 if (flags.verbose) { 1446 (void) printf("failed - trying rename %s to %s\n", 1447 zc.zc_name, zc.zc_value); 1448 } 1449 err = ioctl(hdl->libzfs_fd, ZFS_IOC_RENAME, &zc); 1450 if (err == 0) 1451 changelist_rename(clp, name, newname); 1452 if (err && flags.verbose) { 1453 (void) printf("failed (%u) - " 1454 "will try again on next pass\n", errno); 1455 } 1456 err = EAGAIN; 1457 } else if (flags.verbose) { 1458 if (err == 0) 1459 (void) printf("success\n"); 1460 else 1461 (void) printf("failed (%u)\n", errno); 1462 } 1463 1464 (void) changelist_postfix(clp); 1465 changelist_free(clp); 1466 1467 return (err); 1468 } 1469 1470 static int 1471 recv_destroy(libzfs_handle_t *hdl, const char *name, int baselen, 1472 char *newname, recvflags_t flags) 1473 { 1474 zfs_cmd_t zc = { 0 }; 1475 int err = 0; 1476 prop_changelist_t *clp; 1477 zfs_handle_t *zhp; 1478 boolean_t defer = B_FALSE; 1479 int spa_version; 1480 1481 zhp = zfs_open(hdl, name, ZFS_TYPE_DATASET); 1482 if (zhp == NULL) 1483 return (-1); 1484 clp = changelist_gather(zhp, ZFS_PROP_NAME, 0, 1485 flags.force ? MS_FORCE : 0); 1486 if (zfs_get_type(zhp) == ZFS_TYPE_SNAPSHOT && 1487 zfs_spa_version(zhp, &spa_version) == 0 && 1488 spa_version >= SPA_VERSION_USERREFS) 1489 defer = B_TRUE; 1490 zfs_close(zhp); 1491 if (clp == NULL) 1492 return (-1); 1493 err = changelist_prefix(clp); 1494 if (err) 1495 return (err); 1496 1497 zc.zc_objset_type = DMU_OST_ZFS; 1498 zc.zc_defer_destroy = defer; 1499 (void) strlcpy(zc.zc_name, name, sizeof (zc.zc_name)); 1500 1501 if (flags.verbose) 1502 (void) printf("attempting destroy %s\n", zc.zc_name); 1503 err = ioctl(hdl->libzfs_fd, ZFS_IOC_DESTROY, &zc); 1504 if (err == 0) { 1505 if (flags.verbose) 1506 (void) printf("success\n"); 1507 changelist_remove(clp, zc.zc_name); 1508 } 1509 1510 (void) changelist_postfix(clp); 1511 changelist_free(clp); 1512 1513 /* 1514 * Deferred destroy might destroy the snapshot or only mark it to be 1515 * destroyed later, and it returns success in either case. 1516 */ 1517 if (err != 0 || (defer && zfs_dataset_exists(hdl, name, 1518 ZFS_TYPE_SNAPSHOT))) { 1519 err = recv_rename(hdl, name, NULL, baselen, newname, flags); 1520 } 1521 1522 return (err); 1523 } 1524 1525 typedef struct guid_to_name_data { 1526 uint64_t guid; 1527 char *name; 1528 } guid_to_name_data_t; 1529 1530 static int 1531 guid_to_name_cb(zfs_handle_t *zhp, void *arg) 1532 { 1533 guid_to_name_data_t *gtnd = arg; 1534 int err; 1535 1536 if (zhp->zfs_dmustats.dds_guid == gtnd->guid) { 1537 (void) strcpy(gtnd->name, zhp->zfs_name); 1538 return (EEXIST); 1539 } 1540 err = zfs_iter_children(zhp, guid_to_name_cb, gtnd); 1541 zfs_close(zhp); 1542 return (err); 1543 } 1544 1545 static int 1546 guid_to_name(libzfs_handle_t *hdl, const char *parent, uint64_t guid, 1547 char *name) 1548 { 1549 /* exhaustive search all local snapshots */ 1550 guid_to_name_data_t gtnd; 1551 int err = 0; 1552 zfs_handle_t *zhp; 1553 char *cp; 1554 1555 gtnd.guid = guid; 1556 gtnd.name = name; 1557 1558 if (strchr(parent, '@') == NULL) { 1559 zhp = make_dataset_handle(hdl, parent); 1560 if (zhp != NULL) { 1561 err = zfs_iter_children(zhp, guid_to_name_cb, >nd); 1562 zfs_close(zhp); 1563 if (err == EEXIST) 1564 return (0); 1565 } 1566 } 1567 1568 cp = strchr(parent, '/'); 1569 if (cp) 1570 *cp = '\0'; 1571 zhp = make_dataset_handle(hdl, parent); 1572 if (cp) 1573 *cp = '/'; 1574 1575 if (zhp) { 1576 err = zfs_iter_children(zhp, guid_to_name_cb, >nd); 1577 zfs_close(zhp); 1578 } 1579 1580 return (err == EEXIST ? 0 : ENOENT); 1581 1582 } 1583 1584 /* 1585 * Return true if dataset guid1 is created before guid2. 1586 */ 1587 static int 1588 created_before(libzfs_handle_t *hdl, avl_tree_t *avl, 1589 uint64_t guid1, uint64_t guid2) 1590 { 1591 nvlist_t *nvfs; 1592 char *fsname, *snapname; 1593 char buf[ZFS_MAXNAMELEN]; 1594 int rv; 1595 zfs_node_t zn1, zn2; 1596 1597 if (guid2 == 0) 1598 return (0); 1599 if (guid1 == 0) 1600 return (1); 1601 1602 nvfs = fsavl_find(avl, guid1, &snapname); 1603 VERIFY(0 == nvlist_lookup_string(nvfs, "name", &fsname)); 1604 (void) snprintf(buf, sizeof (buf), "%s@%s", fsname, snapname); 1605 zn1.zn_handle = zfs_open(hdl, buf, ZFS_TYPE_SNAPSHOT); 1606 if (zn1.zn_handle == NULL) 1607 return (-1); 1608 1609 nvfs = fsavl_find(avl, guid2, &snapname); 1610 VERIFY(0 == nvlist_lookup_string(nvfs, "name", &fsname)); 1611 (void) snprintf(buf, sizeof (buf), "%s@%s", fsname, snapname); 1612 zn2.zn_handle = zfs_open(hdl, buf, ZFS_TYPE_SNAPSHOT); 1613 if (zn2.zn_handle == NULL) { 1614 zfs_close(zn2.zn_handle); 1615 return (-1); 1616 } 1617 1618 rv = (zfs_snapshot_compare(&zn1, &zn2) == -1); 1619 1620 zfs_close(zn1.zn_handle); 1621 zfs_close(zn2.zn_handle); 1622 1623 return (rv); 1624 } 1625 1626 static int 1627 recv_incremental_replication(libzfs_handle_t *hdl, const char *tofs, 1628 recvflags_t flags, nvlist_t *stream_nv, avl_tree_t *stream_avl) 1629 { 1630 nvlist_t *local_nv; 1631 avl_tree_t *local_avl; 1632 nvpair_t *fselem, *nextfselem; 1633 char *tosnap, *fromsnap; 1634 char newname[ZFS_MAXNAMELEN]; 1635 int error; 1636 boolean_t needagain, progress, recursive; 1637 char *s1, *s2; 1638 1639 VERIFY(0 == nvlist_lookup_string(stream_nv, "fromsnap", &fromsnap)); 1640 VERIFY(0 == nvlist_lookup_string(stream_nv, "tosnap", &tosnap)); 1641 1642 recursive = (nvlist_lookup_boolean(stream_nv, "not_recursive") == 1643 ENOENT); 1644 1645 if (flags.dryrun) 1646 return (0); 1647 1648 again: 1649 needagain = progress = B_FALSE; 1650 1651 if ((error = gather_nvlist(hdl, tofs, fromsnap, NULL, 1652 recursive, &local_nv, &local_avl)) != 0) 1653 return (error); 1654 1655 /* 1656 * Process deletes and renames 1657 */ 1658 for (fselem = nvlist_next_nvpair(local_nv, NULL); 1659 fselem; fselem = nextfselem) { 1660 nvlist_t *nvfs, *snaps; 1661 nvlist_t *stream_nvfs = NULL; 1662 nvpair_t *snapelem, *nextsnapelem; 1663 uint64_t fromguid = 0; 1664 uint64_t originguid = 0; 1665 uint64_t stream_originguid = 0; 1666 uint64_t parent_fromsnap_guid, stream_parent_fromsnap_guid; 1667 char *fsname, *stream_fsname; 1668 1669 nextfselem = nvlist_next_nvpair(local_nv, fselem); 1670 1671 VERIFY(0 == nvpair_value_nvlist(fselem, &nvfs)); 1672 VERIFY(0 == nvlist_lookup_nvlist(nvfs, "snaps", &snaps)); 1673 VERIFY(0 == nvlist_lookup_string(nvfs, "name", &fsname)); 1674 VERIFY(0 == nvlist_lookup_uint64(nvfs, "parentfromsnap", 1675 &parent_fromsnap_guid)); 1676 (void) nvlist_lookup_uint64(nvfs, "origin", &originguid); 1677 1678 /* 1679 * First find the stream's fs, so we can check for 1680 * a different origin (due to "zfs promote") 1681 */ 1682 for (snapelem = nvlist_next_nvpair(snaps, NULL); 1683 snapelem; snapelem = nvlist_next_nvpair(snaps, snapelem)) { 1684 uint64_t thisguid; 1685 1686 VERIFY(0 == nvpair_value_uint64(snapelem, &thisguid)); 1687 stream_nvfs = fsavl_find(stream_avl, thisguid, NULL); 1688 1689 if (stream_nvfs != NULL) 1690 break; 1691 } 1692 1693 /* check for promote */ 1694 (void) nvlist_lookup_uint64(stream_nvfs, "origin", 1695 &stream_originguid); 1696 if (stream_nvfs && originguid != stream_originguid) { 1697 switch (created_before(hdl, local_avl, 1698 stream_originguid, originguid)) { 1699 case 1: { 1700 /* promote it! */ 1701 zfs_cmd_t zc = { 0 }; 1702 nvlist_t *origin_nvfs; 1703 char *origin_fsname; 1704 1705 if (flags.verbose) 1706 (void) printf("promoting %s\n", fsname); 1707 1708 origin_nvfs = fsavl_find(local_avl, originguid, 1709 NULL); 1710 VERIFY(0 == nvlist_lookup_string(origin_nvfs, 1711 "name", &origin_fsname)); 1712 (void) strlcpy(zc.zc_value, origin_fsname, 1713 sizeof (zc.zc_value)); 1714 (void) strlcpy(zc.zc_name, fsname, 1715 sizeof (zc.zc_name)); 1716 error = zfs_ioctl(hdl, ZFS_IOC_PROMOTE, &zc); 1717 if (error == 0) 1718 progress = B_TRUE; 1719 break; 1720 } 1721 default: 1722 break; 1723 case -1: 1724 fsavl_destroy(local_avl); 1725 nvlist_free(local_nv); 1726 return (-1); 1727 } 1728 /* 1729 * We had/have the wrong origin, therefore our 1730 * list of snapshots is wrong. Need to handle 1731 * them on the next pass. 1732 */ 1733 needagain = B_TRUE; 1734 continue; 1735 } 1736 1737 for (snapelem = nvlist_next_nvpair(snaps, NULL); 1738 snapelem; snapelem = nextsnapelem) { 1739 uint64_t thisguid; 1740 char *stream_snapname; 1741 nvlist_t *found, *props; 1742 1743 nextsnapelem = nvlist_next_nvpair(snaps, snapelem); 1744 1745 VERIFY(0 == nvpair_value_uint64(snapelem, &thisguid)); 1746 found = fsavl_find(stream_avl, thisguid, 1747 &stream_snapname); 1748 1749 /* check for delete */ 1750 if (found == NULL) { 1751 char name[ZFS_MAXNAMELEN]; 1752 1753 if (!flags.force) 1754 continue; 1755 1756 (void) snprintf(name, sizeof (name), "%s@%s", 1757 fsname, nvpair_name(snapelem)); 1758 1759 error = recv_destroy(hdl, name, 1760 strlen(fsname)+1, newname, flags); 1761 if (error) 1762 needagain = B_TRUE; 1763 else 1764 progress = B_TRUE; 1765 continue; 1766 } 1767 1768 stream_nvfs = found; 1769 1770 if (0 == nvlist_lookup_nvlist(stream_nvfs, "snapprops", 1771 &props) && 0 == nvlist_lookup_nvlist(props, 1772 stream_snapname, &props)) { 1773 zfs_cmd_t zc = { 0 }; 1774 1775 zc.zc_cookie = B_TRUE; /* received */ 1776 (void) snprintf(zc.zc_name, sizeof (zc.zc_name), 1777 "%s@%s", fsname, nvpair_name(snapelem)); 1778 if (zcmd_write_src_nvlist(hdl, &zc, 1779 props) == 0) { 1780 (void) zfs_ioctl(hdl, 1781 ZFS_IOC_SET_PROP, &zc); 1782 zcmd_free_nvlists(&zc); 1783 } 1784 } 1785 1786 /* check for different snapname */ 1787 if (strcmp(nvpair_name(snapelem), 1788 stream_snapname) != 0) { 1789 char name[ZFS_MAXNAMELEN]; 1790 char tryname[ZFS_MAXNAMELEN]; 1791 1792 (void) snprintf(name, sizeof (name), "%s@%s", 1793 fsname, nvpair_name(snapelem)); 1794 (void) snprintf(tryname, sizeof (name), "%s@%s", 1795 fsname, stream_snapname); 1796 1797 error = recv_rename(hdl, name, tryname, 1798 strlen(fsname)+1, newname, flags); 1799 if (error) 1800 needagain = B_TRUE; 1801 else 1802 progress = B_TRUE; 1803 } 1804 1805 if (strcmp(stream_snapname, fromsnap) == 0) 1806 fromguid = thisguid; 1807 } 1808 1809 /* check for delete */ 1810 if (stream_nvfs == NULL) { 1811 if (!flags.force) 1812 continue; 1813 1814 error = recv_destroy(hdl, fsname, strlen(tofs)+1, 1815 newname, flags); 1816 if (error) 1817 needagain = B_TRUE; 1818 else 1819 progress = B_TRUE; 1820 continue; 1821 } 1822 1823 if (fromguid == 0 && flags.verbose) { 1824 (void) printf("local fs %s does not have fromsnap " 1825 "(%s in stream); must have been deleted locally; " 1826 "ignoring\n", fsname, fromsnap); 1827 continue; 1828 } 1829 1830 VERIFY(0 == nvlist_lookup_string(stream_nvfs, 1831 "name", &stream_fsname)); 1832 VERIFY(0 == nvlist_lookup_uint64(stream_nvfs, 1833 "parentfromsnap", &stream_parent_fromsnap_guid)); 1834 1835 s1 = strrchr(fsname, '/'); 1836 s2 = strrchr(stream_fsname, '/'); 1837 1838 /* check for rename */ 1839 if ((stream_parent_fromsnap_guid != 0 && 1840 stream_parent_fromsnap_guid != parent_fromsnap_guid) || 1841 ((s1 != NULL) && (s2 != NULL) && strcmp(s1, s2) != 0)) { 1842 nvlist_t *parent; 1843 char tryname[ZFS_MAXNAMELEN]; 1844 1845 parent = fsavl_find(local_avl, 1846 stream_parent_fromsnap_guid, NULL); 1847 /* 1848 * NB: parent might not be found if we used the 1849 * tosnap for stream_parent_fromsnap_guid, 1850 * because the parent is a newly-created fs; 1851 * we'll be able to rename it after we recv the 1852 * new fs. 1853 */ 1854 if (parent != NULL) { 1855 char *pname; 1856 1857 VERIFY(0 == nvlist_lookup_string(parent, "name", 1858 &pname)); 1859 (void) snprintf(tryname, sizeof (tryname), 1860 "%s%s", pname, strrchr(stream_fsname, '/')); 1861 } else { 1862 tryname[0] = '\0'; 1863 if (flags.verbose) { 1864 (void) printf("local fs %s new parent " 1865 "not found\n", fsname); 1866 } 1867 } 1868 1869 error = recv_rename(hdl, fsname, tryname, 1870 strlen(tofs)+1, newname, flags); 1871 if (error) 1872 needagain = B_TRUE; 1873 else 1874 progress = B_TRUE; 1875 } 1876 } 1877 1878 fsavl_destroy(local_avl); 1879 nvlist_free(local_nv); 1880 1881 if (needagain && progress) { 1882 /* do another pass to fix up temporary names */ 1883 if (flags.verbose) 1884 (void) printf("another pass:\n"); 1885 goto again; 1886 } 1887 1888 return (needagain); 1889 } 1890 1891 static int 1892 zfs_receive_package(libzfs_handle_t *hdl, int fd, const char *destname, 1893 recvflags_t flags, dmu_replay_record_t *drr, zio_cksum_t *zc, 1894 char **top_zfs) 1895 { 1896 nvlist_t *stream_nv = NULL; 1897 avl_tree_t *stream_avl = NULL; 1898 char *fromsnap = NULL; 1899 char tofs[ZFS_MAXNAMELEN]; 1900 char errbuf[1024]; 1901 dmu_replay_record_t drre; 1902 int error; 1903 boolean_t anyerr = B_FALSE; 1904 boolean_t softerr = B_FALSE; 1905 1906 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN, 1907 "cannot receive")); 1908 1909 if (strchr(destname, '@')) { 1910 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1911 "can not specify snapshot name for multi-snapshot stream")); 1912 return (zfs_error(hdl, EZFS_BADSTREAM, errbuf)); 1913 } 1914 1915 assert(drr->drr_type == DRR_BEGIN); 1916 assert(drr->drr_u.drr_begin.drr_magic == DMU_BACKUP_MAGIC); 1917 assert(DMU_GET_STREAM_HDRTYPE(drr->drr_u.drr_begin.drr_versioninfo) == 1918 DMU_COMPOUNDSTREAM); 1919 1920 /* 1921 * Read in the nvlist from the stream. 1922 */ 1923 if (drr->drr_payloadlen != 0) { 1924 error = recv_read_nvlist(hdl, fd, drr->drr_payloadlen, 1925 &stream_nv, flags.byteswap, zc); 1926 if (error) { 1927 error = zfs_error(hdl, EZFS_BADSTREAM, errbuf); 1928 goto out; 1929 } 1930 } 1931 1932 /* 1933 * Read in the end record and verify checksum. 1934 */ 1935 if (0 != (error = recv_read(hdl, fd, &drre, sizeof (drre), 1936 flags.byteswap, NULL))) 1937 goto out; 1938 if (flags.byteswap) { 1939 drre.drr_type = BSWAP_32(drre.drr_type); 1940 drre.drr_u.drr_end.drr_checksum.zc_word[0] = 1941 BSWAP_64(drre.drr_u.drr_end.drr_checksum.zc_word[0]); 1942 drre.drr_u.drr_end.drr_checksum.zc_word[1] = 1943 BSWAP_64(drre.drr_u.drr_end.drr_checksum.zc_word[1]); 1944 drre.drr_u.drr_end.drr_checksum.zc_word[2] = 1945 BSWAP_64(drre.drr_u.drr_end.drr_checksum.zc_word[2]); 1946 drre.drr_u.drr_end.drr_checksum.zc_word[3] = 1947 BSWAP_64(drre.drr_u.drr_end.drr_checksum.zc_word[3]); 1948 } 1949 if (drre.drr_type != DRR_END) { 1950 error = zfs_error(hdl, EZFS_BADSTREAM, errbuf); 1951 goto out; 1952 } 1953 if (!ZIO_CHECKSUM_EQUAL(drre.drr_u.drr_end.drr_checksum, *zc)) { 1954 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1955 "incorrect header checksum")); 1956 error = zfs_error(hdl, EZFS_BADSTREAM, errbuf); 1957 goto out; 1958 } 1959 1960 (void) nvlist_lookup_string(stream_nv, "fromsnap", &fromsnap); 1961 1962 if (drr->drr_payloadlen != 0) { 1963 nvlist_t *stream_fss; 1964 1965 VERIFY(0 == nvlist_lookup_nvlist(stream_nv, "fss", 1966 &stream_fss)); 1967 if ((stream_avl = fsavl_create(stream_fss)) == NULL) { 1968 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1969 "couldn't allocate avl tree")); 1970 error = zfs_error(hdl, EZFS_NOMEM, errbuf); 1971 goto out; 1972 } 1973 1974 if (fromsnap != NULL) { 1975 (void) strlcpy(tofs, destname, ZFS_MAXNAMELEN); 1976 if (flags.isprefix) { 1977 int i = strcspn(drr->drr_u.drr_begin.drr_toname, 1978 "/@"); 1979 /* zfs_receive_one() will create_parents() */ 1980 (void) strlcat(tofs, 1981 &drr->drr_u.drr_begin.drr_toname[i], 1982 ZFS_MAXNAMELEN); 1983 *strchr(tofs, '@') = '\0'; 1984 } 1985 softerr = recv_incremental_replication(hdl, tofs, 1986 flags, stream_nv, stream_avl); 1987 } 1988 } 1989 1990 1991 /* Finally, receive each contained stream */ 1992 do { 1993 /* 1994 * we should figure out if it has a recoverable 1995 * error, in which case do a recv_skip() and drive on. 1996 * Note, if we fail due to already having this guid, 1997 * zfs_receive_one() will take care of it (ie, 1998 * recv_skip() and return 0). 1999 */ 2000 error = zfs_receive_impl(hdl, destname, flags, fd, 2001 stream_avl, top_zfs); 2002 if (error == ENODATA) { 2003 error = 0; 2004 break; 2005 } 2006 anyerr |= error; 2007 } while (error == 0); 2008 2009 if (drr->drr_payloadlen != 0 && fromsnap != NULL) { 2010 /* 2011 * Now that we have the fs's they sent us, try the 2012 * renames again. 2013 */ 2014 softerr = recv_incremental_replication(hdl, tofs, flags, 2015 stream_nv, stream_avl); 2016 } 2017 2018 out: 2019 fsavl_destroy(stream_avl); 2020 if (stream_nv) 2021 nvlist_free(stream_nv); 2022 if (softerr) 2023 error = -2; 2024 if (anyerr) 2025 error = -1; 2026 return (error); 2027 } 2028 2029 static void 2030 trunc_prop_errs(int truncated) 2031 { 2032 ASSERT(truncated != 0); 2033 2034 if (truncated == 1) 2035 (void) fprintf(stderr, dgettext(TEXT_DOMAIN, 2036 "1 more property could not be set\n")); 2037 else 2038 (void) fprintf(stderr, dgettext(TEXT_DOMAIN, 2039 "%d more properties could not be set\n"), truncated); 2040 } 2041 2042 static int 2043 recv_skip(libzfs_handle_t *hdl, int fd, boolean_t byteswap) 2044 { 2045 dmu_replay_record_t *drr; 2046 void *buf = malloc(1<<20); 2047 char errbuf[1024]; 2048 2049 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN, 2050 "cannot receive:")); 2051 2052 /* XXX would be great to use lseek if possible... */ 2053 drr = buf; 2054 2055 while (recv_read(hdl, fd, drr, sizeof (dmu_replay_record_t), 2056 byteswap, NULL) == 0) { 2057 if (byteswap) 2058 drr->drr_type = BSWAP_32(drr->drr_type); 2059 2060 switch (drr->drr_type) { 2061 case DRR_BEGIN: 2062 /* NB: not to be used on v2 stream packages */ 2063 if (drr->drr_payloadlen != 0) { 2064 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 2065 "invalid substream header")); 2066 return (zfs_error(hdl, EZFS_BADSTREAM, errbuf)); 2067 } 2068 break; 2069 2070 case DRR_END: 2071 free(buf); 2072 return (0); 2073 2074 case DRR_OBJECT: 2075 if (byteswap) { 2076 drr->drr_u.drr_object.drr_bonuslen = 2077 BSWAP_32(drr->drr_u.drr_object. 2078 drr_bonuslen); 2079 } 2080 (void) recv_read(hdl, fd, buf, 2081 P2ROUNDUP(drr->drr_u.drr_object.drr_bonuslen, 8), 2082 B_FALSE, NULL); 2083 break; 2084 2085 case DRR_WRITE: 2086 if (byteswap) { 2087 drr->drr_u.drr_write.drr_length = 2088 BSWAP_64(drr->drr_u.drr_write.drr_length); 2089 } 2090 (void) recv_read(hdl, fd, buf, 2091 drr->drr_u.drr_write.drr_length, B_FALSE, NULL); 2092 break; 2093 2094 case DRR_WRITE_BYREF: 2095 case DRR_FREEOBJECTS: 2096 case DRR_FREE: 2097 break; 2098 2099 default: 2100 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 2101 "invalid record type")); 2102 return (zfs_error(hdl, EZFS_BADSTREAM, errbuf)); 2103 } 2104 } 2105 2106 free(buf); 2107 return (-1); 2108 } 2109 2110 /* 2111 * Restores a backup of tosnap from the file descriptor specified by infd. 2112 */ 2113 static int 2114 zfs_receive_one(libzfs_handle_t *hdl, int infd, const char *tosnap, 2115 recvflags_t flags, dmu_replay_record_t *drr, 2116 dmu_replay_record_t *drr_noswap, avl_tree_t *stream_avl, 2117 char **top_zfs) 2118 { 2119 zfs_cmd_t zc = { 0 }; 2120 time_t begin_time; 2121 int ioctl_err, ioctl_errno, err, choplen; 2122 char *cp; 2123 struct drr_begin *drrb = &drr->drr_u.drr_begin; 2124 char errbuf[1024]; 2125 char prop_errbuf[1024]; 2126 char chopprefix[ZFS_MAXNAMELEN]; 2127 boolean_t newfs = B_FALSE; 2128 boolean_t stream_wantsnewfs; 2129 uint64_t parent_snapguid = 0; 2130 prop_changelist_t *clp = NULL; 2131 nvlist_t *snapprops_nvlist = NULL; 2132 zprop_errflags_t prop_errflags; 2133 2134 begin_time = time(NULL); 2135 2136 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN, 2137 "cannot receive")); 2138 2139 if (stream_avl != NULL) { 2140 char *snapname; 2141 nvlist_t *fs = fsavl_find(stream_avl, drrb->drr_toguid, 2142 &snapname); 2143 nvlist_t *props; 2144 int ret; 2145 2146 (void) nvlist_lookup_uint64(fs, "parentfromsnap", 2147 &parent_snapguid); 2148 err = nvlist_lookup_nvlist(fs, "props", &props); 2149 if (err) 2150 VERIFY(0 == nvlist_alloc(&props, NV_UNIQUE_NAME, 0)); 2151 2152 if (flags.canmountoff) { 2153 VERIFY(0 == nvlist_add_uint64(props, 2154 zfs_prop_to_name(ZFS_PROP_CANMOUNT), 0)); 2155 } 2156 ret = zcmd_write_src_nvlist(hdl, &zc, props); 2157 if (err) 2158 nvlist_free(props); 2159 2160 if (0 == nvlist_lookup_nvlist(fs, "snapprops", &props)) { 2161 VERIFY(0 == nvlist_lookup_nvlist(props, 2162 snapname, &snapprops_nvlist)); 2163 } 2164 2165 if (ret != 0) 2166 return (-1); 2167 } 2168 2169 /* 2170 * Determine how much of the snapshot name stored in the stream 2171 * we are going to tack on to the name they specified on the 2172 * command line, and how much we are going to chop off. 2173 * 2174 * If they specified a snapshot, chop the entire name stored in 2175 * the stream. 2176 */ 2177 (void) strcpy(chopprefix, drrb->drr_toname); 2178 if (flags.isprefix) { 2179 /* 2180 * They specified a fs with -d or -e. We want to tack on 2181 * everything but the first element of the sent snapshot path 2182 * (all but the pool name) in the case of -d, or only the tail 2183 * of the sent snapshot path in the case of -e. 2184 */ 2185 if (strchr(tosnap, '@')) { 2186 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, "invalid " 2187 "argument - snapshot not allowed with %s"), 2188 (flags.istail ? "-e" : "-d")); 2189 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf)); 2190 } 2191 cp = (flags.istail ? strrchr(chopprefix, '/') : 2192 strchr(chopprefix, '/')); 2193 if (cp == NULL) 2194 cp = strchr(chopprefix, '@'); 2195 *cp = '\0'; 2196 } else if (strchr(tosnap, '@') == NULL) { 2197 /* 2198 * If they specified a filesystem without -d or -e, we want to 2199 * tack on everything after the fs specified in the first name 2200 * from the stream. 2201 */ 2202 cp = strchr(chopprefix, '@'); 2203 *cp = '\0'; 2204 } 2205 choplen = strlen(chopprefix); 2206 2207 /* 2208 * Determine name of destination snapshot, store in zc_value. 2209 */ 2210 (void) strcpy(zc.zc_top_ds, tosnap); 2211 (void) strcpy(zc.zc_value, tosnap); 2212 (void) strncat(zc.zc_value, drrb->drr_toname+choplen, 2213 sizeof (zc.zc_value)); 2214 if (!zfs_name_valid(zc.zc_value, ZFS_TYPE_SNAPSHOT)) { 2215 zcmd_free_nvlists(&zc); 2216 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf)); 2217 } 2218 2219 /* 2220 * Determine the name of the origin snapshot, store in zc_string. 2221 */ 2222 if (drrb->drr_flags & DRR_FLAG_CLONE) { 2223 if (guid_to_name(hdl, tosnap, 2224 drrb->drr_fromguid, zc.zc_string) != 0) { 2225 zcmd_free_nvlists(&zc); 2226 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 2227 "local origin for clone %s does not exist"), 2228 zc.zc_value); 2229 return (zfs_error(hdl, EZFS_NOENT, errbuf)); 2230 } 2231 if (flags.verbose) 2232 (void) printf("found clone origin %s\n", zc.zc_string); 2233 } 2234 2235 stream_wantsnewfs = (drrb->drr_fromguid == NULL || 2236 (drrb->drr_flags & DRR_FLAG_CLONE)); 2237 2238 if (stream_wantsnewfs) { 2239 /* 2240 * if the parent fs does not exist, look for it based on 2241 * the parent snap GUID 2242 */ 2243 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN, 2244 "cannot receive new filesystem stream")); 2245 2246 (void) strcpy(zc.zc_name, zc.zc_value); 2247 cp = strrchr(zc.zc_name, '/'); 2248 if (cp) 2249 *cp = '\0'; 2250 if (cp && 2251 !zfs_dataset_exists(hdl, zc.zc_name, ZFS_TYPE_DATASET)) { 2252 char suffix[ZFS_MAXNAMELEN]; 2253 (void) strcpy(suffix, strrchr(zc.zc_value, '/')); 2254 if (guid_to_name(hdl, tosnap, parent_snapguid, 2255 zc.zc_value) == 0) { 2256 *strchr(zc.zc_value, '@') = '\0'; 2257 (void) strcat(zc.zc_value, suffix); 2258 } 2259 } 2260 } else { 2261 /* 2262 * if the fs does not exist, look for it based on the 2263 * fromsnap GUID 2264 */ 2265 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN, 2266 "cannot receive incremental stream")); 2267 2268 (void) strcpy(zc.zc_name, zc.zc_value); 2269 *strchr(zc.zc_name, '@') = '\0'; 2270 2271 if (!zfs_dataset_exists(hdl, zc.zc_name, ZFS_TYPE_DATASET)) { 2272 char snap[ZFS_MAXNAMELEN]; 2273 (void) strcpy(snap, strchr(zc.zc_value, '@')); 2274 if (guid_to_name(hdl, tosnap, drrb->drr_fromguid, 2275 zc.zc_value) == 0) { 2276 *strchr(zc.zc_value, '@') = '\0'; 2277 (void) strcat(zc.zc_value, snap); 2278 } 2279 } 2280 } 2281 2282 (void) strcpy(zc.zc_name, zc.zc_value); 2283 *strchr(zc.zc_name, '@') = '\0'; 2284 2285 if (zfs_dataset_exists(hdl, zc.zc_name, ZFS_TYPE_DATASET)) { 2286 zfs_handle_t *zhp; 2287 /* 2288 * Destination fs exists. Therefore this should either 2289 * be an incremental, or the stream specifies a new fs 2290 * (full stream or clone) and they want us to blow it 2291 * away (and have therefore specified -F and removed any 2292 * snapshots). 2293 */ 2294 2295 if (stream_wantsnewfs) { 2296 if (!flags.force) { 2297 zcmd_free_nvlists(&zc); 2298 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 2299 "destination '%s' exists\n" 2300 "must specify -F to overwrite it"), 2301 zc.zc_name); 2302 return (zfs_error(hdl, EZFS_EXISTS, errbuf)); 2303 } 2304 if (ioctl(hdl->libzfs_fd, ZFS_IOC_SNAPSHOT_LIST_NEXT, 2305 &zc) == 0) { 2306 zcmd_free_nvlists(&zc); 2307 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 2308 "destination has snapshots (eg. %s)\n" 2309 "must destroy them to overwrite it"), 2310 zc.zc_name); 2311 return (zfs_error(hdl, EZFS_EXISTS, errbuf)); 2312 } 2313 } 2314 2315 if ((zhp = zfs_open(hdl, zc.zc_name, 2316 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME)) == NULL) { 2317 zcmd_free_nvlists(&zc); 2318 return (-1); 2319 } 2320 2321 if (stream_wantsnewfs && 2322 zhp->zfs_dmustats.dds_origin[0]) { 2323 zcmd_free_nvlists(&zc); 2324 zfs_close(zhp); 2325 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 2326 "destination '%s' is a clone\n" 2327 "must destroy it to overwrite it"), 2328 zc.zc_name); 2329 return (zfs_error(hdl, EZFS_EXISTS, errbuf)); 2330 } 2331 2332 if (!flags.dryrun && zhp->zfs_type == ZFS_TYPE_FILESYSTEM && 2333 stream_wantsnewfs) { 2334 /* We can't do online recv in this case */ 2335 clp = changelist_gather(zhp, ZFS_PROP_NAME, 0, 0); 2336 if (clp == NULL) { 2337 zfs_close(zhp); 2338 zcmd_free_nvlists(&zc); 2339 return (-1); 2340 } 2341 if (changelist_prefix(clp) != 0) { 2342 changelist_free(clp); 2343 zfs_close(zhp); 2344 zcmd_free_nvlists(&zc); 2345 return (-1); 2346 } 2347 } 2348 zfs_close(zhp); 2349 } else { 2350 /* 2351 * Destination filesystem does not exist. Therefore we better 2352 * be creating a new filesystem (either from a full backup, or 2353 * a clone). It would therefore be invalid if the user 2354 * specified only the pool name (i.e. if the destination name 2355 * contained no slash character). 2356 */ 2357 if (!stream_wantsnewfs || 2358 (cp = strrchr(zc.zc_name, '/')) == NULL) { 2359 zcmd_free_nvlists(&zc); 2360 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 2361 "destination '%s' does not exist"), zc.zc_name); 2362 return (zfs_error(hdl, EZFS_NOENT, errbuf)); 2363 } 2364 2365 /* 2366 * Trim off the final dataset component so we perform the 2367 * recvbackup ioctl to the filesystems's parent. 2368 */ 2369 *cp = '\0'; 2370 2371 if (flags.isprefix && !flags.dryrun && 2372 create_parents(hdl, zc.zc_value, strlen(tosnap)) != 0) { 2373 zcmd_free_nvlists(&zc); 2374 return (zfs_error(hdl, EZFS_BADRESTORE, errbuf)); 2375 } 2376 2377 newfs = B_TRUE; 2378 } 2379 2380 zc.zc_begin_record = drr_noswap->drr_u.drr_begin; 2381 zc.zc_cookie = infd; 2382 zc.zc_guid = flags.force; 2383 if (flags.verbose) { 2384 (void) printf("%s %s stream of %s into %s\n", 2385 flags.dryrun ? "would receive" : "receiving", 2386 drrb->drr_fromguid ? "incremental" : "full", 2387 drrb->drr_toname, zc.zc_value); 2388 (void) fflush(stdout); 2389 } 2390 2391 if (flags.dryrun) { 2392 zcmd_free_nvlists(&zc); 2393 return (recv_skip(hdl, infd, flags.byteswap)); 2394 } 2395 2396 zc.zc_nvlist_dst = (uint64_t)(uintptr_t)prop_errbuf; 2397 zc.zc_nvlist_dst_size = sizeof (prop_errbuf); 2398 2399 err = ioctl_err = zfs_ioctl(hdl, ZFS_IOC_RECV, &zc); 2400 ioctl_errno = errno; 2401 prop_errflags = (zprop_errflags_t)zc.zc_obj; 2402 2403 if (err == 0) { 2404 nvlist_t *prop_errors; 2405 VERIFY(0 == nvlist_unpack((void *)(uintptr_t)zc.zc_nvlist_dst, 2406 zc.zc_nvlist_dst_size, &prop_errors, 0)); 2407 2408 nvpair_t *prop_err = NULL; 2409 2410 while ((prop_err = nvlist_next_nvpair(prop_errors, 2411 prop_err)) != NULL) { 2412 char tbuf[1024]; 2413 zfs_prop_t prop; 2414 int intval; 2415 2416 prop = zfs_name_to_prop(nvpair_name(prop_err)); 2417 (void) nvpair_value_int32(prop_err, &intval); 2418 if (strcmp(nvpair_name(prop_err), 2419 ZPROP_N_MORE_ERRORS) == 0) { 2420 trunc_prop_errs(intval); 2421 break; 2422 } else { 2423 (void) snprintf(tbuf, sizeof (tbuf), 2424 dgettext(TEXT_DOMAIN, 2425 "cannot receive %s property on %s"), 2426 nvpair_name(prop_err), zc.zc_name); 2427 zfs_setprop_error(hdl, prop, intval, tbuf); 2428 } 2429 } 2430 nvlist_free(prop_errors); 2431 } 2432 2433 zc.zc_nvlist_dst = 0; 2434 zc.zc_nvlist_dst_size = 0; 2435 zcmd_free_nvlists(&zc); 2436 2437 if (err == 0 && snapprops_nvlist) { 2438 zfs_cmd_t zc2 = { 0 }; 2439 2440 (void) strcpy(zc2.zc_name, zc.zc_value); 2441 zc2.zc_cookie = B_TRUE; /* received */ 2442 if (zcmd_write_src_nvlist(hdl, &zc2, snapprops_nvlist) == 0) { 2443 (void) zfs_ioctl(hdl, ZFS_IOC_SET_PROP, &zc2); 2444 zcmd_free_nvlists(&zc2); 2445 } 2446 } 2447 2448 if (err && (ioctl_errno == ENOENT || ioctl_errno == ENODEV)) { 2449 /* 2450 * It may be that this snapshot already exists, 2451 * in which case we want to consume & ignore it 2452 * rather than failing. 2453 */ 2454 avl_tree_t *local_avl; 2455 nvlist_t *local_nv, *fs; 2456 char *cp = strchr(zc.zc_value, '@'); 2457 2458 /* 2459 * XXX Do this faster by just iterating over snaps in 2460 * this fs. Also if zc_value does not exist, we will 2461 * get a strange "does not exist" error message. 2462 */ 2463 *cp = '\0'; 2464 if (gather_nvlist(hdl, zc.zc_value, NULL, NULL, B_FALSE, 2465 &local_nv, &local_avl) == 0) { 2466 *cp = '@'; 2467 fs = fsavl_find(local_avl, drrb->drr_toguid, NULL); 2468 fsavl_destroy(local_avl); 2469 nvlist_free(local_nv); 2470 2471 if (fs != NULL) { 2472 if (flags.verbose) { 2473 (void) printf("snap %s already exists; " 2474 "ignoring\n", zc.zc_value); 2475 } 2476 err = ioctl_err = recv_skip(hdl, infd, 2477 flags.byteswap); 2478 } 2479 } 2480 *cp = '@'; 2481 } 2482 2483 if (ioctl_err != 0) { 2484 switch (ioctl_errno) { 2485 case ENODEV: 2486 cp = strchr(zc.zc_value, '@'); 2487 *cp = '\0'; 2488 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 2489 "most recent snapshot of %s does not\n" 2490 "match incremental source"), zc.zc_value); 2491 (void) zfs_error(hdl, EZFS_BADRESTORE, errbuf); 2492 *cp = '@'; 2493 break; 2494 case ETXTBSY: 2495 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 2496 "destination %s has been modified\n" 2497 "since most recent snapshot"), zc.zc_name); 2498 (void) zfs_error(hdl, EZFS_BADRESTORE, errbuf); 2499 break; 2500 case EEXIST: 2501 cp = strchr(zc.zc_value, '@'); 2502 if (newfs) { 2503 /* it's the containing fs that exists */ 2504 *cp = '\0'; 2505 } 2506 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 2507 "destination already exists")); 2508 (void) zfs_error_fmt(hdl, EZFS_EXISTS, 2509 dgettext(TEXT_DOMAIN, "cannot restore to %s"), 2510 zc.zc_value); 2511 *cp = '@'; 2512 break; 2513 case EINVAL: 2514 (void) zfs_error(hdl, EZFS_BADSTREAM, errbuf); 2515 break; 2516 case ECKSUM: 2517 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 2518 "invalid stream (checksum mismatch)")); 2519 (void) zfs_error(hdl, EZFS_BADSTREAM, errbuf); 2520 break; 2521 default: 2522 (void) zfs_standard_error(hdl, ioctl_errno, errbuf); 2523 } 2524 } 2525 2526 /* 2527 * Mount the target filesystem (if created). Also mount any 2528 * children of the target filesystem if we did a replication 2529 * receive (indicated by stream_avl being non-NULL). 2530 */ 2531 cp = strchr(zc.zc_value, '@'); 2532 if (cp && (ioctl_err == 0 || !newfs)) { 2533 zfs_handle_t *h; 2534 2535 *cp = '\0'; 2536 h = zfs_open(hdl, zc.zc_value, 2537 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME); 2538 if (h != NULL) { 2539 if (h->zfs_type == ZFS_TYPE_VOLUME) { 2540 *cp = '@'; 2541 } else if (newfs || stream_avl) { 2542 /* 2543 * Track the first/top of hierarchy fs, 2544 * for mounting and sharing later. 2545 */ 2546 if (top_zfs && *top_zfs == NULL) 2547 *top_zfs = zfs_strdup(hdl, zc.zc_value); 2548 } 2549 zfs_close(h); 2550 } 2551 *cp = '@'; 2552 } 2553 2554 if (clp) { 2555 err |= changelist_postfix(clp); 2556 changelist_free(clp); 2557 } 2558 2559 if (prop_errflags & ZPROP_ERR_NOCLEAR) { 2560 (void) fprintf(stderr, dgettext(TEXT_DOMAIN, "Warning: " 2561 "failed to clear unreceived properties on %s"), 2562 zc.zc_name); 2563 (void) fprintf(stderr, "\n"); 2564 } 2565 if (prop_errflags & ZPROP_ERR_NORESTORE) { 2566 (void) fprintf(stderr, dgettext(TEXT_DOMAIN, "Warning: " 2567 "failed to restore original properties on %s"), 2568 zc.zc_name); 2569 (void) fprintf(stderr, "\n"); 2570 } 2571 2572 if (err || ioctl_err) 2573 return (-1); 2574 2575 if (flags.verbose) { 2576 char buf1[64]; 2577 char buf2[64]; 2578 uint64_t bytes = zc.zc_cookie; 2579 time_t delta = time(NULL) - begin_time; 2580 if (delta == 0) 2581 delta = 1; 2582 zfs_nicenum(bytes, buf1, sizeof (buf1)); 2583 zfs_nicenum(bytes/delta, buf2, sizeof (buf1)); 2584 2585 (void) printf("received %sB stream in %lu seconds (%sB/sec)\n", 2586 buf1, delta, buf2); 2587 } 2588 2589 return (0); 2590 } 2591 2592 static int 2593 zfs_receive_impl(libzfs_handle_t *hdl, const char *tosnap, recvflags_t flags, 2594 int infd, avl_tree_t *stream_avl, char **top_zfs) 2595 { 2596 int err; 2597 dmu_replay_record_t drr, drr_noswap; 2598 struct drr_begin *drrb = &drr.drr_u.drr_begin; 2599 char errbuf[1024]; 2600 zio_cksum_t zcksum = { 0 }; 2601 uint64_t featureflags; 2602 int hdrtype; 2603 2604 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN, 2605 "cannot receive")); 2606 2607 if (flags.isprefix && 2608 !zfs_dataset_exists(hdl, tosnap, ZFS_TYPE_DATASET)) { 2609 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, "specified fs " 2610 "(%s) does not exist"), tosnap); 2611 return (zfs_error(hdl, EZFS_NOENT, errbuf)); 2612 } 2613 2614 /* read in the BEGIN record */ 2615 if (0 != (err = recv_read(hdl, infd, &drr, sizeof (drr), B_FALSE, 2616 &zcksum))) 2617 return (err); 2618 2619 if (drr.drr_type == DRR_END || drr.drr_type == BSWAP_32(DRR_END)) { 2620 /* It's the double end record at the end of a package */ 2621 return (ENODATA); 2622 } 2623 2624 /* the kernel needs the non-byteswapped begin record */ 2625 drr_noswap = drr; 2626 2627 flags.byteswap = B_FALSE; 2628 if (drrb->drr_magic == BSWAP_64(DMU_BACKUP_MAGIC)) { 2629 /* 2630 * We computed the checksum in the wrong byteorder in 2631 * recv_read() above; do it again correctly. 2632 */ 2633 bzero(&zcksum, sizeof (zio_cksum_t)); 2634 fletcher_4_incremental_byteswap(&drr, sizeof (drr), &zcksum); 2635 flags.byteswap = B_TRUE; 2636 2637 drr.drr_type = BSWAP_32(drr.drr_type); 2638 drr.drr_payloadlen = BSWAP_32(drr.drr_payloadlen); 2639 drrb->drr_magic = BSWAP_64(drrb->drr_magic); 2640 drrb->drr_versioninfo = BSWAP_64(drrb->drr_versioninfo); 2641 drrb->drr_creation_time = BSWAP_64(drrb->drr_creation_time); 2642 drrb->drr_type = BSWAP_32(drrb->drr_type); 2643 drrb->drr_flags = BSWAP_32(drrb->drr_flags); 2644 drrb->drr_toguid = BSWAP_64(drrb->drr_toguid); 2645 drrb->drr_fromguid = BSWAP_64(drrb->drr_fromguid); 2646 } 2647 2648 if (drrb->drr_magic != DMU_BACKUP_MAGIC || drr.drr_type != DRR_BEGIN) { 2649 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, "invalid " 2650 "stream (bad magic number)")); 2651 return (zfs_error(hdl, EZFS_BADSTREAM, errbuf)); 2652 } 2653 2654 featureflags = DMU_GET_FEATUREFLAGS(drrb->drr_versioninfo); 2655 hdrtype = DMU_GET_STREAM_HDRTYPE(drrb->drr_versioninfo); 2656 2657 if (!DMU_STREAM_SUPPORTED(featureflags) || 2658 (hdrtype != DMU_SUBSTREAM && hdrtype != DMU_COMPOUNDSTREAM)) { 2659 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 2660 "stream has unsupported feature, feature flags = %lx"), 2661 featureflags); 2662 return (zfs_error(hdl, EZFS_BADSTREAM, errbuf)); 2663 } 2664 2665 if (strchr(drrb->drr_toname, '@') == NULL) { 2666 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, "invalid " 2667 "stream (bad snapshot name)")); 2668 return (zfs_error(hdl, EZFS_BADSTREAM, errbuf)); 2669 } 2670 2671 if (DMU_GET_STREAM_HDRTYPE(drrb->drr_versioninfo) == DMU_SUBSTREAM) { 2672 return (zfs_receive_one(hdl, infd, tosnap, flags, 2673 &drr, &drr_noswap, stream_avl, top_zfs)); 2674 } else { /* must be DMU_COMPOUNDSTREAM */ 2675 assert(DMU_GET_STREAM_HDRTYPE(drrb->drr_versioninfo) == 2676 DMU_COMPOUNDSTREAM); 2677 return (zfs_receive_package(hdl, infd, tosnap, flags, 2678 &drr, &zcksum, top_zfs)); 2679 } 2680 } 2681 2682 /* 2683 * Restores a backup of tosnap from the file descriptor specified by infd. 2684 * Return 0 on total success, -2 if some things couldn't be 2685 * destroyed/renamed/promoted, -1 if some things couldn't be received. 2686 * (-1 will override -2). 2687 */ 2688 int 2689 zfs_receive(libzfs_handle_t *hdl, const char *tosnap, recvflags_t flags, 2690 int infd, avl_tree_t *stream_avl) 2691 { 2692 char *top_zfs = NULL; 2693 int err; 2694 2695 err = zfs_receive_impl(hdl, tosnap, flags, infd, stream_avl, &top_zfs); 2696 2697 if (err == 0 && !flags.nomount && top_zfs) { 2698 zfs_handle_t *zhp; 2699 prop_changelist_t *clp; 2700 2701 zhp = zfs_open(hdl, top_zfs, ZFS_TYPE_FILESYSTEM); 2702 if (zhp != NULL) { 2703 clp = changelist_gather(zhp, ZFS_PROP_MOUNTPOINT, 2704 CL_GATHER_MOUNT_ALWAYS, 0); 2705 zfs_close(zhp); 2706 if (clp != NULL) { 2707 /* mount and share received datasets */ 2708 err = changelist_postfix(clp); 2709 changelist_free(clp); 2710 } 2711 } 2712 if (zhp == NULL || clp == NULL || err) 2713 err = -1; 2714 } 2715 if (top_zfs) 2716 free(top_zfs); 2717 2718 return (err); 2719 } 2720