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 https://opensource.org/licenses/CDDL-1.0. 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) 2012, 2020 by Delphix. All rights reserved. 24 * Copyright (c) 2013 Steven Hartland. All rights reserved. 25 * Copyright 2017 RackTop Systems. 26 * Copyright (c) 2017 Open-E, Inc. All Rights Reserved. 27 * Copyright (c) 2019, 2020 by Christian Schwarz. All rights reserved. 28 * Copyright (c) 2019 Datto Inc. 29 */ 30 31 /* 32 * LibZFS_Core (lzc) is intended to replace most functionality in libzfs. 33 * It has the following characteristics: 34 * 35 * - Thread Safe. libzfs_core is accessible concurrently from multiple 36 * threads. This is accomplished primarily by avoiding global data 37 * (e.g. caching). Since it's thread-safe, there is no reason for a 38 * process to have multiple libzfs "instances". Therefore, we store 39 * our few pieces of data (e.g. the file descriptor) in global 40 * variables. The fd is reference-counted so that the libzfs_core 41 * library can be "initialized" multiple times (e.g. by different 42 * consumers within the same process). 43 * 44 * - Committed Interface. The libzfs_core interface will be committed, 45 * therefore consumers can compile against it and be confident that 46 * their code will continue to work on future releases of this code. 47 * Currently, the interface is Evolving (not Committed), but we intend 48 * to commit to it once it is more complete and we determine that it 49 * meets the needs of all consumers. 50 * 51 * - Programmatic Error Handling. libzfs_core communicates errors with 52 * defined error numbers, and doesn't print anything to stdout/stderr. 53 * 54 * - Thin Layer. libzfs_core is a thin layer, marshaling arguments 55 * to/from the kernel ioctls. There is generally a 1:1 correspondence 56 * between libzfs_core functions and ioctls to ZFS_DEV. 57 * 58 * - Clear Atomicity. Because libzfs_core functions are generally 1:1 59 * with kernel ioctls, and kernel ioctls are general atomic, each 60 * libzfs_core function is atomic. For example, creating multiple 61 * snapshots with a single call to lzc_snapshot() is atomic -- it 62 * can't fail with only some of the requested snapshots created, even 63 * in the event of power loss or system crash. 64 * 65 * - Continued libzfs Support. Some higher-level operations (e.g. 66 * support for "zfs send -R") are too complicated to fit the scope of 67 * libzfs_core. This functionality will continue to live in libzfs. 68 * Where appropriate, libzfs will use the underlying atomic operations 69 * of libzfs_core. For example, libzfs may implement "zfs send -R | 70 * zfs receive" by using individual "send one snapshot", rename, 71 * destroy, and "receive one snapshot" operations in libzfs_core. 72 * /sbin/zfs and /sbin/zpool will link with both libzfs and 73 * libzfs_core. Other consumers should aim to use only libzfs_core, 74 * since that will be the supported, stable interface going forwards. 75 */ 76 77 #include <libzfs_core.h> 78 #include <ctype.h> 79 #include <unistd.h> 80 #include <stdlib.h> 81 #include <string.h> 82 #ifdef ZFS_DEBUG 83 #include <stdio.h> 84 #endif 85 #include <errno.h> 86 #include <fcntl.h> 87 #include <pthread.h> 88 #include <libzutil.h> 89 #include <sys/nvpair.h> 90 #include <sys/param.h> 91 #include <sys/types.h> 92 #include <sys/stat.h> 93 #include <sys/zfs_ioctl.h> 94 #if __FreeBSD__ 95 #define BIG_PIPE_SIZE (64 * 1024) /* From sys/pipe.h */ 96 #endif 97 98 static int g_fd = -1; 99 static pthread_mutex_t g_lock = PTHREAD_MUTEX_INITIALIZER; 100 static int g_refcount; 101 102 #ifdef ZFS_DEBUG 103 static zfs_ioc_t fail_ioc_cmd = ZFS_IOC_LAST; 104 static zfs_errno_t fail_ioc_err; 105 106 static void 107 libzfs_core_debug_ioc(void) 108 { 109 /* 110 * To test running newer user space binaries with kernel's 111 * that don't yet support an ioctl or a new ioctl arg we 112 * provide an override to intentionally fail an ioctl. 113 * 114 * USAGE: 115 * The override variable, ZFS_IOC_TEST, is of the form "cmd:err" 116 * 117 * For example, to fail a ZFS_IOC_POOL_CHECKPOINT with a 118 * ZFS_ERR_IOC_CMD_UNAVAIL, the string would be "0x5a4d:1029" 119 * 120 * $ sudo sh -c "ZFS_IOC_TEST=0x5a4d:1029 zpool checkpoint tank" 121 * cannot checkpoint 'tank': the loaded zfs module does not support 122 * this operation. A reboot may be required to enable this operation. 123 */ 124 if (fail_ioc_cmd == ZFS_IOC_LAST) { 125 char *ioc_test = getenv("ZFS_IOC_TEST"); 126 unsigned int ioc_num = 0, ioc_err = 0; 127 128 if (ioc_test != NULL && 129 sscanf(ioc_test, "%i:%i", &ioc_num, &ioc_err) == 2 && 130 ioc_num < ZFS_IOC_LAST) { 131 fail_ioc_cmd = ioc_num; 132 fail_ioc_err = ioc_err; 133 } 134 } 135 } 136 #endif 137 138 int 139 libzfs_core_init(void) 140 { 141 (void) pthread_mutex_lock(&g_lock); 142 if (g_refcount == 0) { 143 g_fd = open(ZFS_DEV, O_RDWR|O_CLOEXEC); 144 if (g_fd < 0) { 145 (void) pthread_mutex_unlock(&g_lock); 146 return (errno); 147 } 148 } 149 g_refcount++; 150 151 #ifdef ZFS_DEBUG 152 libzfs_core_debug_ioc(); 153 #endif 154 (void) pthread_mutex_unlock(&g_lock); 155 return (0); 156 } 157 158 void 159 libzfs_core_fini(void) 160 { 161 (void) pthread_mutex_lock(&g_lock); 162 ASSERT3S(g_refcount, >, 0); 163 164 g_refcount--; 165 166 if (g_refcount == 0 && g_fd != -1) { 167 (void) close(g_fd); 168 g_fd = -1; 169 } 170 (void) pthread_mutex_unlock(&g_lock); 171 } 172 173 static int 174 lzc_ioctl(zfs_ioc_t ioc, const char *name, 175 nvlist_t *source, nvlist_t **resultp) 176 { 177 zfs_cmd_t zc = {"\0"}; 178 int error = 0; 179 char *packed = NULL; 180 size_t size = 0; 181 182 ASSERT3S(g_refcount, >, 0); 183 VERIFY3S(g_fd, !=, -1); 184 185 #ifdef ZFS_DEBUG 186 if (ioc == fail_ioc_cmd) 187 return (fail_ioc_err); 188 #endif 189 190 if (name != NULL) 191 (void) strlcpy(zc.zc_name, name, sizeof (zc.zc_name)); 192 193 if (source != NULL) { 194 packed = fnvlist_pack(source, &size); 195 zc.zc_nvlist_src = (uint64_t)(uintptr_t)packed; 196 zc.zc_nvlist_src_size = size; 197 } 198 199 if (resultp != NULL) { 200 *resultp = NULL; 201 if (ioc == ZFS_IOC_CHANNEL_PROGRAM) { 202 zc.zc_nvlist_dst_size = fnvlist_lookup_uint64(source, 203 ZCP_ARG_MEMLIMIT); 204 } else { 205 zc.zc_nvlist_dst_size = MAX(size * 2, 128 * 1024); 206 } 207 zc.zc_nvlist_dst = (uint64_t)(uintptr_t) 208 malloc(zc.zc_nvlist_dst_size); 209 if (zc.zc_nvlist_dst == (uint64_t)0) { 210 error = ENOMEM; 211 goto out; 212 } 213 } 214 215 while (lzc_ioctl_fd(g_fd, ioc, &zc) != 0) { 216 /* 217 * If ioctl exited with ENOMEM, we retry the ioctl after 218 * increasing the size of the destination nvlist. 219 * 220 * Channel programs that exit with ENOMEM ran over the 221 * lua memory sandbox; they should not be retried. 222 */ 223 if (errno == ENOMEM && resultp != NULL && 224 ioc != ZFS_IOC_CHANNEL_PROGRAM) { 225 free((void *)(uintptr_t)zc.zc_nvlist_dst); 226 zc.zc_nvlist_dst_size *= 2; 227 zc.zc_nvlist_dst = (uint64_t)(uintptr_t) 228 malloc(zc.zc_nvlist_dst_size); 229 if (zc.zc_nvlist_dst == (uint64_t)0) { 230 error = ENOMEM; 231 goto out; 232 } 233 } else { 234 error = errno; 235 break; 236 } 237 } 238 if (zc.zc_nvlist_dst_filled && resultp != NULL) { 239 *resultp = fnvlist_unpack((void *)(uintptr_t)zc.zc_nvlist_dst, 240 zc.zc_nvlist_dst_size); 241 } 242 243 out: 244 if (packed != NULL) 245 fnvlist_pack_free(packed, size); 246 free((void *)(uintptr_t)zc.zc_nvlist_dst); 247 return (error); 248 } 249 250 int 251 lzc_scrub(zfs_ioc_t ioc, const char *name, 252 nvlist_t *source, nvlist_t **resultp) 253 { 254 return (lzc_ioctl(ioc, name, source, resultp)); 255 } 256 257 int 258 lzc_create(const char *fsname, enum lzc_dataset_type type, nvlist_t *props, 259 uint8_t *wkeydata, uint_t wkeylen) 260 { 261 int error; 262 nvlist_t *hidden_args = NULL; 263 nvlist_t *args = fnvlist_alloc(); 264 265 fnvlist_add_int32(args, "type", (dmu_objset_type_t)type); 266 if (props != NULL) 267 fnvlist_add_nvlist(args, "props", props); 268 269 if (wkeydata != NULL) { 270 hidden_args = fnvlist_alloc(); 271 fnvlist_add_uint8_array(hidden_args, "wkeydata", wkeydata, 272 wkeylen); 273 fnvlist_add_nvlist(args, ZPOOL_HIDDEN_ARGS, hidden_args); 274 } 275 276 error = lzc_ioctl(ZFS_IOC_CREATE, fsname, args, NULL); 277 nvlist_free(hidden_args); 278 nvlist_free(args); 279 return (error); 280 } 281 282 int 283 lzc_clone(const char *fsname, const char *origin, nvlist_t *props) 284 { 285 int error; 286 nvlist_t *hidden_args = NULL; 287 nvlist_t *args = fnvlist_alloc(); 288 289 fnvlist_add_string(args, "origin", origin); 290 if (props != NULL) 291 fnvlist_add_nvlist(args, "props", props); 292 error = lzc_ioctl(ZFS_IOC_CLONE, fsname, args, NULL); 293 nvlist_free(hidden_args); 294 nvlist_free(args); 295 return (error); 296 } 297 298 int 299 lzc_promote(const char *fsname, char *snapnamebuf, int snapnamelen) 300 { 301 /* 302 * The promote ioctl is still legacy, so we need to construct our 303 * own zfs_cmd_t rather than using lzc_ioctl(). 304 */ 305 zfs_cmd_t zc = {"\0"}; 306 307 ASSERT3S(g_refcount, >, 0); 308 VERIFY3S(g_fd, !=, -1); 309 310 (void) strlcpy(zc.zc_name, fsname, sizeof (zc.zc_name)); 311 if (lzc_ioctl_fd(g_fd, ZFS_IOC_PROMOTE, &zc) != 0) { 312 int error = errno; 313 if (error == EEXIST && snapnamebuf != NULL) 314 (void) strlcpy(snapnamebuf, zc.zc_string, snapnamelen); 315 return (error); 316 } 317 return (0); 318 } 319 320 int 321 lzc_rename(const char *source, const char *target) 322 { 323 zfs_cmd_t zc = {"\0"}; 324 int error; 325 326 ASSERT3S(g_refcount, >, 0); 327 VERIFY3S(g_fd, !=, -1); 328 (void) strlcpy(zc.zc_name, source, sizeof (zc.zc_name)); 329 (void) strlcpy(zc.zc_value, target, sizeof (zc.zc_value)); 330 error = lzc_ioctl_fd(g_fd, ZFS_IOC_RENAME, &zc); 331 if (error != 0) 332 error = errno; 333 return (error); 334 } 335 336 int 337 lzc_destroy(const char *fsname) 338 { 339 int error; 340 nvlist_t *args = fnvlist_alloc(); 341 error = lzc_ioctl(ZFS_IOC_DESTROY, fsname, args, NULL); 342 nvlist_free(args); 343 return (error); 344 } 345 346 /* 347 * Creates snapshots. 348 * 349 * The keys in the snaps nvlist are the snapshots to be created. 350 * They must all be in the same pool. 351 * 352 * The props nvlist is properties to set. Currently only user properties 353 * are supported. { user:prop_name -> string value } 354 * 355 * The returned results nvlist will have an entry for each snapshot that failed. 356 * The value will be the (int32) error code. 357 * 358 * The return value will be 0 if all snapshots were created, otherwise it will 359 * be the errno of a (unspecified) snapshot that failed. 360 */ 361 int 362 lzc_snapshot(nvlist_t *snaps, nvlist_t *props, nvlist_t **errlist) 363 { 364 nvpair_t *elem; 365 nvlist_t *args; 366 int error; 367 char pool[ZFS_MAX_DATASET_NAME_LEN]; 368 369 *errlist = NULL; 370 371 /* determine the pool name */ 372 elem = nvlist_next_nvpair(snaps, NULL); 373 if (elem == NULL) 374 return (0); 375 (void) strlcpy(pool, nvpair_name(elem), sizeof (pool)); 376 pool[strcspn(pool, "/@")] = '\0'; 377 378 args = fnvlist_alloc(); 379 fnvlist_add_nvlist(args, "snaps", snaps); 380 if (props != NULL) 381 fnvlist_add_nvlist(args, "props", props); 382 383 error = lzc_ioctl(ZFS_IOC_SNAPSHOT, pool, args, errlist); 384 nvlist_free(args); 385 386 return (error); 387 } 388 389 /* 390 * Destroys snapshots. 391 * 392 * The keys in the snaps nvlist are the snapshots to be destroyed. 393 * They must all be in the same pool. 394 * 395 * Snapshots that do not exist will be silently ignored. 396 * 397 * If 'defer' is not set, and a snapshot has user holds or clones, the 398 * destroy operation will fail and none of the snapshots will be 399 * destroyed. 400 * 401 * If 'defer' is set, and a snapshot has user holds or clones, it will be 402 * marked for deferred destruction, and will be destroyed when the last hold 403 * or clone is removed/destroyed. 404 * 405 * The return value will be 0 if all snapshots were destroyed (or marked for 406 * later destruction if 'defer' is set) or didn't exist to begin with. 407 * 408 * Otherwise the return value will be the errno of a (unspecified) snapshot 409 * that failed, no snapshots will be destroyed, and the errlist will have an 410 * entry for each snapshot that failed. The value in the errlist will be 411 * the (int32) error code. 412 */ 413 int 414 lzc_destroy_snaps(nvlist_t *snaps, boolean_t defer, nvlist_t **errlist) 415 { 416 nvpair_t *elem; 417 nvlist_t *args; 418 int error; 419 char pool[ZFS_MAX_DATASET_NAME_LEN]; 420 421 /* determine the pool name */ 422 elem = nvlist_next_nvpair(snaps, NULL); 423 if (elem == NULL) 424 return (0); 425 (void) strlcpy(pool, nvpair_name(elem), sizeof (pool)); 426 pool[strcspn(pool, "/@")] = '\0'; 427 428 args = fnvlist_alloc(); 429 fnvlist_add_nvlist(args, "snaps", snaps); 430 if (defer) 431 fnvlist_add_boolean(args, "defer"); 432 433 error = lzc_ioctl(ZFS_IOC_DESTROY_SNAPS, pool, args, errlist); 434 nvlist_free(args); 435 436 return (error); 437 } 438 439 int 440 lzc_snaprange_space(const char *firstsnap, const char *lastsnap, 441 uint64_t *usedp) 442 { 443 nvlist_t *args; 444 nvlist_t *result; 445 int err; 446 char fs[ZFS_MAX_DATASET_NAME_LEN]; 447 char *atp; 448 449 /* determine the fs name */ 450 (void) strlcpy(fs, firstsnap, sizeof (fs)); 451 atp = strchr(fs, '@'); 452 if (atp == NULL) 453 return (EINVAL); 454 *atp = '\0'; 455 456 args = fnvlist_alloc(); 457 fnvlist_add_string(args, "firstsnap", firstsnap); 458 459 err = lzc_ioctl(ZFS_IOC_SPACE_SNAPS, lastsnap, args, &result); 460 nvlist_free(args); 461 if (err == 0) 462 *usedp = fnvlist_lookup_uint64(result, "used"); 463 fnvlist_free(result); 464 465 return (err); 466 } 467 468 boolean_t 469 lzc_exists(const char *dataset) 470 { 471 /* 472 * The objset_stats ioctl is still legacy, so we need to construct our 473 * own zfs_cmd_t rather than using lzc_ioctl(). 474 */ 475 zfs_cmd_t zc = {"\0"}; 476 477 ASSERT3S(g_refcount, >, 0); 478 VERIFY3S(g_fd, !=, -1); 479 480 (void) strlcpy(zc.zc_name, dataset, sizeof (zc.zc_name)); 481 return (lzc_ioctl_fd(g_fd, ZFS_IOC_OBJSET_STATS, &zc) == 0); 482 } 483 484 /* 485 * outnvl is unused. 486 * It was added to preserve the function signature in case it is 487 * needed in the future. 488 */ 489 int 490 lzc_sync(const char *pool_name, nvlist_t *innvl, nvlist_t **outnvl) 491 { 492 (void) outnvl; 493 return (lzc_ioctl(ZFS_IOC_POOL_SYNC, pool_name, innvl, NULL)); 494 } 495 496 /* 497 * Create "user holds" on snapshots. If there is a hold on a snapshot, 498 * the snapshot can not be destroyed. (However, it can be marked for deletion 499 * by lzc_destroy_snaps(defer=B_TRUE).) 500 * 501 * The keys in the nvlist are snapshot names. 502 * The snapshots must all be in the same pool. 503 * The value is the name of the hold (string type). 504 * 505 * If cleanup_fd is not -1, it must be the result of open(ZFS_DEV, O_EXCL). 506 * In this case, when the cleanup_fd is closed (including on process 507 * termination), the holds will be released. If the system is shut down 508 * uncleanly, the holds will be released when the pool is next opened 509 * or imported. 510 * 511 * Holds for snapshots which don't exist will be skipped and have an entry 512 * added to errlist, but will not cause an overall failure. 513 * 514 * The return value will be 0 if all holds, for snapshots that existed, 515 * were successfully created. 516 * 517 * Otherwise the return value will be the errno of a (unspecified) hold that 518 * failed and no holds will be created. 519 * 520 * In all cases the errlist will have an entry for each hold that failed 521 * (name = snapshot), with its value being the error code (int32). 522 */ 523 int 524 lzc_hold(nvlist_t *holds, int cleanup_fd, nvlist_t **errlist) 525 { 526 char pool[ZFS_MAX_DATASET_NAME_LEN]; 527 nvlist_t *args; 528 nvpair_t *elem; 529 int error; 530 531 /* determine the pool name */ 532 elem = nvlist_next_nvpair(holds, NULL); 533 if (elem == NULL) 534 return (0); 535 (void) strlcpy(pool, nvpair_name(elem), sizeof (pool)); 536 pool[strcspn(pool, "/@")] = '\0'; 537 538 args = fnvlist_alloc(); 539 fnvlist_add_nvlist(args, "holds", holds); 540 if (cleanup_fd != -1) 541 fnvlist_add_int32(args, "cleanup_fd", cleanup_fd); 542 543 error = lzc_ioctl(ZFS_IOC_HOLD, pool, args, errlist); 544 nvlist_free(args); 545 return (error); 546 } 547 548 /* 549 * Release "user holds" on snapshots. If the snapshot has been marked for 550 * deferred destroy (by lzc_destroy_snaps(defer=B_TRUE)), it does not have 551 * any clones, and all the user holds are removed, then the snapshot will be 552 * destroyed. 553 * 554 * The keys in the nvlist are snapshot names. 555 * The snapshots must all be in the same pool. 556 * The value is an nvlist whose keys are the holds to remove. 557 * 558 * Holds which failed to release because they didn't exist will have an entry 559 * added to errlist, but will not cause an overall failure. 560 * 561 * The return value will be 0 if the nvl holds was empty or all holds that 562 * existed, were successfully removed. 563 * 564 * Otherwise the return value will be the errno of a (unspecified) hold that 565 * failed to release and no holds will be released. 566 * 567 * In all cases the errlist will have an entry for each hold that failed to 568 * to release. 569 */ 570 int 571 lzc_release(nvlist_t *holds, nvlist_t **errlist) 572 { 573 char pool[ZFS_MAX_DATASET_NAME_LEN]; 574 nvpair_t *elem; 575 576 /* determine the pool name */ 577 elem = nvlist_next_nvpair(holds, NULL); 578 if (elem == NULL) 579 return (0); 580 (void) strlcpy(pool, nvpair_name(elem), sizeof (pool)); 581 pool[strcspn(pool, "/@")] = '\0'; 582 583 return (lzc_ioctl(ZFS_IOC_RELEASE, pool, holds, errlist)); 584 } 585 586 /* 587 * Retrieve list of user holds on the specified snapshot. 588 * 589 * On success, *holdsp will be set to an nvlist which the caller must free. 590 * The keys are the names of the holds, and the value is the creation time 591 * of the hold (uint64) in seconds since the epoch. 592 */ 593 int 594 lzc_get_holds(const char *snapname, nvlist_t **holdsp) 595 { 596 return (lzc_ioctl(ZFS_IOC_GET_HOLDS, snapname, NULL, holdsp)); 597 } 598 599 static unsigned int 600 max_pipe_buffer(int infd) 601 { 602 #if __linux__ 603 static unsigned int max; 604 if (max == 0) { 605 max = 1048576; /* fs/pipe.c default */ 606 607 FILE *procf = fopen("/proc/sys/fs/pipe-max-size", "re"); 608 if (procf != NULL) { 609 if (fscanf(procf, "%u", &max) <= 0) { 610 /* ignore error: max untouched if parse fails */ 611 } 612 fclose(procf); 613 } 614 } 615 616 unsigned int cur = fcntl(infd, F_GETPIPE_SZ); 617 /* 618 * Sadly, Linux has an unfixed deadlock if you do SETPIPE_SZ on a pipe 619 * with data in it. 620 * cf. #13232, https://bugzilla.kernel.org/show_bug.cgi?id=212295 621 * 622 * And since the problem is in waking up the writer, there's nothing 623 * we can do about it from here. 624 * 625 * So if people want to, they can set this, but they 626 * may regret it... 627 */ 628 if (getenv("ZFS_SET_PIPE_MAX") == NULL) 629 return (cur); 630 if (cur < max && fcntl(infd, F_SETPIPE_SZ, max) != -1) 631 cur = max; 632 return (cur); 633 #else 634 /* FreeBSD automatically resizes */ 635 (void) infd; 636 return (BIG_PIPE_SIZE); 637 #endif 638 } 639 640 #if __linux__ 641 struct send_worker_ctx { 642 int from; /* read end of pipe, with send data; closed on exit */ 643 int to; /* original arbitrary output fd; mustn't be a pipe */ 644 }; 645 646 static void * 647 send_worker(void *arg) 648 { 649 struct send_worker_ctx *ctx = arg; 650 unsigned int bufsiz = max_pipe_buffer(ctx->from); 651 ssize_t rd; 652 653 while ((rd = splice(ctx->from, NULL, ctx->to, NULL, bufsiz, 654 SPLICE_F_MOVE | SPLICE_F_MORE)) > 0) 655 ; 656 657 int err = (rd == -1) ? errno : 0; 658 close(ctx->from); 659 return ((void *)(uintptr_t)err); 660 } 661 #endif 662 663 /* 664 * Since Linux 5.10, 4d03e3cc59828c82ee89ea6e27a2f3cdf95aaadf 665 * ("fs: don't allow kernel reads and writes without iter ops"), 666 * ZFS_IOC_SEND* will EINVAL when writing to /dev/null, /dev/zero, &c. 667 * 668 * This wrapper transparently executes func() with a pipe 669 * by spawning a thread to copy from that pipe to the original output 670 * in the background. 671 * 672 * Returns the error from func(), if nonzero, 673 * otherwise the error from the thread. 674 * 675 * No-op if orig_fd is -1, already a pipe (but the buffer size is bumped), 676 * and on not-Linux; as such, it is safe to wrap/call wrapped functions 677 * in a wrapped context. 678 */ 679 int 680 lzc_send_wrapper(int (*func)(int, void *), int orig_fd, void *data) 681 { 682 #if __linux__ 683 struct stat sb; 684 if (orig_fd != -1 && fstat(orig_fd, &sb) == -1) 685 return (errno); 686 if (orig_fd == -1 || S_ISFIFO(sb.st_mode)) { 687 if (orig_fd != -1) 688 (void) max_pipe_buffer(orig_fd); 689 return (func(orig_fd, data)); 690 } 691 if ((fcntl(orig_fd, F_GETFL) & O_ACCMODE) == O_RDONLY) 692 return (errno = EBADF); 693 694 int rw[2]; 695 if (pipe2(rw, O_CLOEXEC) == -1) 696 return (errno); 697 698 int err; 699 pthread_t send_thread; 700 struct send_worker_ctx ctx = {.from = rw[0], .to = orig_fd}; 701 if ((err = pthread_create(&send_thread, NULL, send_worker, &ctx)) 702 != 0) { 703 close(rw[0]); 704 close(rw[1]); 705 return (errno = err); 706 } 707 708 err = func(rw[1], data); 709 710 void *send_err; 711 close(rw[1]); 712 pthread_join(send_thread, &send_err); 713 if (err == 0 && send_err != 0) 714 errno = err = (uintptr_t)send_err; 715 716 return (err); 717 #else 718 return (func(orig_fd, data)); 719 #endif 720 } 721 722 /* 723 * Generate a zfs send stream for the specified snapshot and write it to 724 * the specified file descriptor. 725 * 726 * "snapname" is the full name of the snapshot to send (e.g. "pool/fs@snap") 727 * 728 * If "from" is NULL, a full (non-incremental) stream will be sent. 729 * If "from" is non-NULL, it must be the full name of a snapshot or 730 * bookmark to send an incremental from (e.g. "pool/fs@earlier_snap" or 731 * "pool/fs#earlier_bmark"). If non-NULL, the specified snapshot or 732 * bookmark must represent an earlier point in the history of "snapname"). 733 * It can be an earlier snapshot in the same filesystem or zvol as "snapname", 734 * or it can be the origin of "snapname"'s filesystem, or an earlier 735 * snapshot in the origin, etc. 736 * 737 * "fd" is the file descriptor to write the send stream to. 738 * 739 * If "flags" contains LZC_SEND_FLAG_LARGE_BLOCK, the stream is permitted 740 * to contain DRR_WRITE records with drr_length > 128K, and DRR_OBJECT 741 * records with drr_blksz > 128K. 742 * 743 * If "flags" contains LZC_SEND_FLAG_EMBED_DATA, the stream is permitted 744 * to contain DRR_WRITE_EMBEDDED records with drr_etype==BP_EMBEDDED_TYPE_DATA, 745 * which the receiving system must support (as indicated by support 746 * for the "embedded_data" feature). 747 * 748 * If "flags" contains LZC_SEND_FLAG_COMPRESS, the stream is generated by using 749 * compressed WRITE records for blocks which are compressed on disk and in 750 * memory. If the lz4_compress feature is active on the sending system, then 751 * the receiving system must have that feature enabled as well. 752 * 753 * If "flags" contains LZC_SEND_FLAG_RAW, the stream is generated, for encrypted 754 * datasets, by sending data exactly as it exists on disk. This allows backups 755 * to be taken even if encryption keys are not currently loaded. 756 */ 757 int 758 lzc_send(const char *snapname, const char *from, int fd, 759 enum lzc_send_flags flags) 760 { 761 return (lzc_send_resume_redacted(snapname, from, fd, flags, 0, 0, 762 NULL)); 763 } 764 765 int 766 lzc_send_redacted(const char *snapname, const char *from, int fd, 767 enum lzc_send_flags flags, const char *redactbook) 768 { 769 return (lzc_send_resume_redacted(snapname, from, fd, flags, 0, 0, 770 redactbook)); 771 } 772 773 int 774 lzc_send_resume(const char *snapname, const char *from, int fd, 775 enum lzc_send_flags flags, uint64_t resumeobj, uint64_t resumeoff) 776 { 777 return (lzc_send_resume_redacted(snapname, from, fd, flags, resumeobj, 778 resumeoff, NULL)); 779 } 780 781 /* 782 * snapname: The name of the "tosnap", or the snapshot whose contents we are 783 * sending. 784 * from: The name of the "fromsnap", or the incremental source. 785 * fd: File descriptor to write the stream to. 786 * flags: flags that determine features to be used by the stream. 787 * resumeobj: Object to resume from, for resuming send 788 * resumeoff: Offset to resume from, for resuming send. 789 * redactnv: nvlist of string -> boolean(ignored) containing the names of all 790 * the snapshots that we should redact with respect to. 791 * redactbook: Name of the redaction bookmark to create. 792 * 793 * Pre-wrapped. 794 */ 795 static int 796 lzc_send_resume_redacted_cb_impl(const char *snapname, const char *from, int fd, 797 enum lzc_send_flags flags, uint64_t resumeobj, uint64_t resumeoff, 798 const char *redactbook) 799 { 800 nvlist_t *args; 801 int err; 802 803 args = fnvlist_alloc(); 804 fnvlist_add_int32(args, "fd", fd); 805 if (from != NULL) 806 fnvlist_add_string(args, "fromsnap", from); 807 if (flags & LZC_SEND_FLAG_LARGE_BLOCK) 808 fnvlist_add_boolean(args, "largeblockok"); 809 if (flags & LZC_SEND_FLAG_EMBED_DATA) 810 fnvlist_add_boolean(args, "embedok"); 811 if (flags & LZC_SEND_FLAG_COMPRESS) 812 fnvlist_add_boolean(args, "compressok"); 813 if (flags & LZC_SEND_FLAG_RAW) 814 fnvlist_add_boolean(args, "rawok"); 815 if (flags & LZC_SEND_FLAG_SAVED) 816 fnvlist_add_boolean(args, "savedok"); 817 if (resumeobj != 0 || resumeoff != 0) { 818 fnvlist_add_uint64(args, "resume_object", resumeobj); 819 fnvlist_add_uint64(args, "resume_offset", resumeoff); 820 } 821 if (redactbook != NULL) 822 fnvlist_add_string(args, "redactbook", redactbook); 823 824 err = lzc_ioctl(ZFS_IOC_SEND_NEW, snapname, args, NULL); 825 nvlist_free(args); 826 return (err); 827 } 828 829 struct lzc_send_resume_redacted { 830 const char *snapname; 831 const char *from; 832 enum lzc_send_flags flags; 833 uint64_t resumeobj; 834 uint64_t resumeoff; 835 const char *redactbook; 836 }; 837 838 static int 839 lzc_send_resume_redacted_cb(int fd, void *arg) 840 { 841 struct lzc_send_resume_redacted *zsrr = arg; 842 return (lzc_send_resume_redacted_cb_impl(zsrr->snapname, zsrr->from, 843 fd, zsrr->flags, zsrr->resumeobj, zsrr->resumeoff, 844 zsrr->redactbook)); 845 } 846 847 int 848 lzc_send_resume_redacted(const char *snapname, const char *from, int fd, 849 enum lzc_send_flags flags, uint64_t resumeobj, uint64_t resumeoff, 850 const char *redactbook) 851 { 852 struct lzc_send_resume_redacted zsrr = { 853 .snapname = snapname, 854 .from = from, 855 .flags = flags, 856 .resumeobj = resumeobj, 857 .resumeoff = resumeoff, 858 .redactbook = redactbook, 859 }; 860 return (lzc_send_wrapper(lzc_send_resume_redacted_cb, fd, &zsrr)); 861 } 862 863 /* 864 * "from" can be NULL, a snapshot, or a bookmark. 865 * 866 * If from is NULL, a full (non-incremental) stream will be estimated. This 867 * is calculated very efficiently. 868 * 869 * If from is a snapshot, lzc_send_space uses the deadlists attached to 870 * each snapshot to efficiently estimate the stream size. 871 * 872 * If from is a bookmark, the indirect blocks in the destination snapshot 873 * are traversed, looking for blocks with a birth time since the creation TXG of 874 * the snapshot this bookmark was created from. This will result in 875 * significantly more I/O and be less efficient than a send space estimation on 876 * an equivalent snapshot. This process is also used if redact_snaps is 877 * non-null. 878 * 879 * Pre-wrapped. 880 */ 881 static int 882 lzc_send_space_resume_redacted_cb_impl(const char *snapname, const char *from, 883 enum lzc_send_flags flags, uint64_t resumeobj, uint64_t resumeoff, 884 uint64_t resume_bytes, const char *redactbook, int fd, uint64_t *spacep) 885 { 886 nvlist_t *args; 887 nvlist_t *result; 888 int err; 889 890 args = fnvlist_alloc(); 891 if (from != NULL) 892 fnvlist_add_string(args, "from", from); 893 if (flags & LZC_SEND_FLAG_LARGE_BLOCK) 894 fnvlist_add_boolean(args, "largeblockok"); 895 if (flags & LZC_SEND_FLAG_EMBED_DATA) 896 fnvlist_add_boolean(args, "embedok"); 897 if (flags & LZC_SEND_FLAG_COMPRESS) 898 fnvlist_add_boolean(args, "compressok"); 899 if (flags & LZC_SEND_FLAG_RAW) 900 fnvlist_add_boolean(args, "rawok"); 901 if (resumeobj != 0 || resumeoff != 0) { 902 fnvlist_add_uint64(args, "resume_object", resumeobj); 903 fnvlist_add_uint64(args, "resume_offset", resumeoff); 904 fnvlist_add_uint64(args, "bytes", resume_bytes); 905 } 906 if (redactbook != NULL) 907 fnvlist_add_string(args, "redactbook", redactbook); 908 if (fd != -1) 909 fnvlist_add_int32(args, "fd", fd); 910 911 err = lzc_ioctl(ZFS_IOC_SEND_SPACE, snapname, args, &result); 912 nvlist_free(args); 913 if (err == 0) 914 *spacep = fnvlist_lookup_uint64(result, "space"); 915 nvlist_free(result); 916 return (err); 917 } 918 919 struct lzc_send_space_resume_redacted { 920 const char *snapname; 921 const char *from; 922 enum lzc_send_flags flags; 923 uint64_t resumeobj; 924 uint64_t resumeoff; 925 uint64_t resume_bytes; 926 const char *redactbook; 927 uint64_t *spacep; 928 }; 929 930 static int 931 lzc_send_space_resume_redacted_cb(int fd, void *arg) 932 { 933 struct lzc_send_space_resume_redacted *zssrr = arg; 934 return (lzc_send_space_resume_redacted_cb_impl(zssrr->snapname, 935 zssrr->from, zssrr->flags, zssrr->resumeobj, zssrr->resumeoff, 936 zssrr->resume_bytes, zssrr->redactbook, fd, zssrr->spacep)); 937 } 938 939 int 940 lzc_send_space_resume_redacted(const char *snapname, const char *from, 941 enum lzc_send_flags flags, uint64_t resumeobj, uint64_t resumeoff, 942 uint64_t resume_bytes, const char *redactbook, int fd, uint64_t *spacep) 943 { 944 struct lzc_send_space_resume_redacted zssrr = { 945 .snapname = snapname, 946 .from = from, 947 .flags = flags, 948 .resumeobj = resumeobj, 949 .resumeoff = resumeoff, 950 .resume_bytes = resume_bytes, 951 .redactbook = redactbook, 952 .spacep = spacep, 953 }; 954 return (lzc_send_wrapper(lzc_send_space_resume_redacted_cb, 955 fd, &zssrr)); 956 } 957 958 int 959 lzc_send_space(const char *snapname, const char *from, 960 enum lzc_send_flags flags, uint64_t *spacep) 961 { 962 return (lzc_send_space_resume_redacted(snapname, from, flags, 0, 0, 0, 963 NULL, -1, spacep)); 964 } 965 966 static int 967 recv_read(int fd, void *buf, int ilen) 968 { 969 char *cp = buf; 970 int rv; 971 int len = ilen; 972 973 do { 974 rv = read(fd, cp, len); 975 cp += rv; 976 len -= rv; 977 } while (rv > 0); 978 979 if (rv < 0 || len != 0) 980 return (EIO); 981 982 return (0); 983 } 984 985 /* 986 * Linux adds ZFS_IOC_RECV_NEW for resumable and raw streams and preserves the 987 * legacy ZFS_IOC_RECV user/kernel interface. The new interface supports all 988 * stream options but is currently only used for resumable streams. This way 989 * updated user space utilities will interoperate with older kernel modules. 990 * 991 * Non-Linux OpenZFS platforms have opted to modify the legacy interface. 992 */ 993 static int 994 recv_impl(const char *snapname, nvlist_t *recvdprops, nvlist_t *localprops, 995 uint8_t *wkeydata, uint_t wkeylen, const char *origin, boolean_t force, 996 boolean_t heal, boolean_t resumable, boolean_t raw, int input_fd, 997 const dmu_replay_record_t *begin_record, uint64_t *read_bytes, 998 uint64_t *errflags, nvlist_t **errors) 999 { 1000 dmu_replay_record_t drr; 1001 char fsname[MAXPATHLEN]; 1002 char *atp; 1003 int error; 1004 boolean_t payload = B_FALSE; 1005 1006 ASSERT3S(g_refcount, >, 0); 1007 VERIFY3S(g_fd, !=, -1); 1008 1009 /* Set 'fsname' to the name of containing filesystem */ 1010 (void) strlcpy(fsname, snapname, sizeof (fsname)); 1011 atp = strchr(fsname, '@'); 1012 if (atp == NULL) 1013 return (EINVAL); 1014 *atp = '\0'; 1015 1016 /* If the fs does not exist, try its parent. */ 1017 if (!lzc_exists(fsname)) { 1018 char *slashp = strrchr(fsname, '/'); 1019 if (slashp == NULL) 1020 return (ENOENT); 1021 *slashp = '\0'; 1022 } 1023 1024 /* 1025 * It is not uncommon for gigabytes to be processed by zfs receive. 1026 * Speculatively increase the buffer size if supported by the platform. 1027 */ 1028 struct stat sb; 1029 if (fstat(input_fd, &sb) == -1) 1030 return (errno); 1031 if (S_ISFIFO(sb.st_mode)) 1032 (void) max_pipe_buffer(input_fd); 1033 1034 /* 1035 * The begin_record is normally a non-byteswapped BEGIN record. 1036 * For resumable streams it may be set to any non-byteswapped 1037 * dmu_replay_record_t. 1038 */ 1039 if (begin_record == NULL) { 1040 error = recv_read(input_fd, &drr, sizeof (drr)); 1041 if (error != 0) 1042 return (error); 1043 } else { 1044 drr = *begin_record; 1045 payload = (begin_record->drr_payloadlen != 0); 1046 } 1047 1048 /* 1049 * All receives with a payload should use the new interface. 1050 */ 1051 if (resumable || heal || raw || wkeydata != NULL || payload) { 1052 nvlist_t *outnvl = NULL; 1053 nvlist_t *innvl = fnvlist_alloc(); 1054 1055 fnvlist_add_string(innvl, "snapname", snapname); 1056 1057 if (recvdprops != NULL) 1058 fnvlist_add_nvlist(innvl, "props", recvdprops); 1059 1060 if (localprops != NULL) 1061 fnvlist_add_nvlist(innvl, "localprops", localprops); 1062 1063 if (wkeydata != NULL) { 1064 /* 1065 * wkeydata must be placed in the special 1066 * ZPOOL_HIDDEN_ARGS nvlist so that it 1067 * will not be printed to the zpool history. 1068 */ 1069 nvlist_t *hidden_args = fnvlist_alloc(); 1070 fnvlist_add_uint8_array(hidden_args, "wkeydata", 1071 wkeydata, wkeylen); 1072 fnvlist_add_nvlist(innvl, ZPOOL_HIDDEN_ARGS, 1073 hidden_args); 1074 nvlist_free(hidden_args); 1075 } 1076 1077 if (origin != NULL && strlen(origin)) 1078 fnvlist_add_string(innvl, "origin", origin); 1079 1080 fnvlist_add_byte_array(innvl, "begin_record", 1081 (uchar_t *)&drr, sizeof (drr)); 1082 1083 fnvlist_add_int32(innvl, "input_fd", input_fd); 1084 1085 if (force) 1086 fnvlist_add_boolean(innvl, "force"); 1087 1088 if (resumable) 1089 fnvlist_add_boolean(innvl, "resumable"); 1090 1091 if (heal) 1092 fnvlist_add_boolean(innvl, "heal"); 1093 1094 error = lzc_ioctl(ZFS_IOC_RECV_NEW, fsname, innvl, &outnvl); 1095 1096 if (error == 0 && read_bytes != NULL) 1097 error = nvlist_lookup_uint64(outnvl, "read_bytes", 1098 read_bytes); 1099 1100 if (error == 0 && errflags != NULL) 1101 error = nvlist_lookup_uint64(outnvl, "error_flags", 1102 errflags); 1103 1104 if (error == 0 && errors != NULL) { 1105 nvlist_t *nvl; 1106 error = nvlist_lookup_nvlist(outnvl, "errors", &nvl); 1107 if (error == 0) 1108 *errors = fnvlist_dup(nvl); 1109 } 1110 1111 fnvlist_free(innvl); 1112 fnvlist_free(outnvl); 1113 } else { 1114 zfs_cmd_t zc = {"\0"}; 1115 char *rp_packed = NULL; 1116 char *lp_packed = NULL; 1117 size_t size; 1118 1119 ASSERT3S(g_refcount, >, 0); 1120 1121 (void) strlcpy(zc.zc_name, fsname, sizeof (zc.zc_name)); 1122 (void) strlcpy(zc.zc_value, snapname, sizeof (zc.zc_value)); 1123 1124 if (recvdprops != NULL) { 1125 rp_packed = fnvlist_pack(recvdprops, &size); 1126 zc.zc_nvlist_src = (uint64_t)(uintptr_t)rp_packed; 1127 zc.zc_nvlist_src_size = size; 1128 } 1129 1130 if (localprops != NULL) { 1131 lp_packed = fnvlist_pack(localprops, &size); 1132 zc.zc_nvlist_conf = (uint64_t)(uintptr_t)lp_packed; 1133 zc.zc_nvlist_conf_size = size; 1134 } 1135 1136 if (origin != NULL) 1137 (void) strlcpy(zc.zc_string, origin, 1138 sizeof (zc.zc_string)); 1139 1140 ASSERT3S(drr.drr_type, ==, DRR_BEGIN); 1141 zc.zc_begin_record = drr.drr_u.drr_begin; 1142 zc.zc_guid = force; 1143 zc.zc_cookie = input_fd; 1144 zc.zc_cleanup_fd = -1; 1145 zc.zc_action_handle = 0; 1146 1147 zc.zc_nvlist_dst_size = 128 * 1024; 1148 zc.zc_nvlist_dst = (uint64_t)(uintptr_t) 1149 malloc(zc.zc_nvlist_dst_size); 1150 1151 error = lzc_ioctl_fd(g_fd, ZFS_IOC_RECV, &zc); 1152 if (error != 0) { 1153 error = errno; 1154 } else { 1155 if (read_bytes != NULL) 1156 *read_bytes = zc.zc_cookie; 1157 1158 if (errflags != NULL) 1159 *errflags = zc.zc_obj; 1160 1161 if (errors != NULL) 1162 VERIFY0(nvlist_unpack( 1163 (void *)(uintptr_t)zc.zc_nvlist_dst, 1164 zc.zc_nvlist_dst_size, errors, KM_SLEEP)); 1165 } 1166 1167 if (rp_packed != NULL) 1168 fnvlist_pack_free(rp_packed, size); 1169 if (lp_packed != NULL) 1170 fnvlist_pack_free(lp_packed, size); 1171 free((void *)(uintptr_t)zc.zc_nvlist_dst); 1172 } 1173 1174 return (error); 1175 } 1176 1177 /* 1178 * The simplest receive case: receive from the specified fd, creating the 1179 * specified snapshot. Apply the specified properties as "received" properties 1180 * (which can be overridden by locally-set properties). If the stream is a 1181 * clone, its origin snapshot must be specified by 'origin'. The 'force' 1182 * flag will cause the target filesystem to be rolled back or destroyed if 1183 * necessary to receive. 1184 * 1185 * Return 0 on success or an errno on failure. 1186 * 1187 * Note: this interface does not work on dedup'd streams 1188 * (those with DMU_BACKUP_FEATURE_DEDUP). 1189 */ 1190 int 1191 lzc_receive(const char *snapname, nvlist_t *props, const char *origin, 1192 boolean_t force, boolean_t raw, int fd) 1193 { 1194 return (recv_impl(snapname, props, NULL, NULL, 0, origin, force, 1195 B_FALSE, B_FALSE, raw, fd, NULL, NULL, NULL, NULL)); 1196 } 1197 1198 /* 1199 * Like lzc_receive, but if the receive fails due to premature stream 1200 * termination, the intermediate state will be preserved on disk. In this 1201 * case, ECKSUM will be returned. The receive may subsequently be resumed 1202 * with a resuming send stream generated by lzc_send_resume(). 1203 */ 1204 int 1205 lzc_receive_resumable(const char *snapname, nvlist_t *props, const char *origin, 1206 boolean_t force, boolean_t raw, int fd) 1207 { 1208 return (recv_impl(snapname, props, NULL, NULL, 0, origin, force, 1209 B_FALSE, B_TRUE, raw, fd, NULL, NULL, NULL, NULL)); 1210 } 1211 1212 /* 1213 * Like lzc_receive, but allows the caller to read the begin record and then to 1214 * pass it in. That could be useful if the caller wants to derive, for example, 1215 * the snapname or the origin parameters based on the information contained in 1216 * the begin record. 1217 * The begin record must be in its original form as read from the stream, 1218 * in other words, it should not be byteswapped. 1219 * 1220 * The 'resumable' parameter allows to obtain the same behavior as with 1221 * lzc_receive_resumable. 1222 */ 1223 int 1224 lzc_receive_with_header(const char *snapname, nvlist_t *props, 1225 const char *origin, boolean_t force, boolean_t resumable, boolean_t raw, 1226 int fd, const dmu_replay_record_t *begin_record) 1227 { 1228 if (begin_record == NULL) 1229 return (EINVAL); 1230 1231 return (recv_impl(snapname, props, NULL, NULL, 0, origin, force, 1232 B_FALSE, resumable, raw, fd, begin_record, NULL, NULL, NULL)); 1233 } 1234 1235 /* 1236 * Like lzc_receive, but allows the caller to pass all supported arguments 1237 * and retrieve all values returned. The only additional input parameter 1238 * is 'cleanup_fd' which is used to set a cleanup-on-exit file descriptor. 1239 * 1240 * The following parameters all provide return values. Several may be set 1241 * in the failure case and will contain additional information. 1242 * 1243 * The 'read_bytes' value will be set to the total number of bytes read. 1244 * 1245 * The 'errflags' value will contain zprop_errflags_t flags which are 1246 * used to describe any failures. 1247 * 1248 * The 'action_handle' and 'cleanup_fd' are no longer used, and are ignored. 1249 * 1250 * The 'errors' nvlist contains an entry for each unapplied received 1251 * property. Callers are responsible for freeing this nvlist. 1252 */ 1253 int 1254 lzc_receive_one(const char *snapname, nvlist_t *props, 1255 const char *origin, boolean_t force, boolean_t resumable, boolean_t raw, 1256 int input_fd, const dmu_replay_record_t *begin_record, int cleanup_fd, 1257 uint64_t *read_bytes, uint64_t *errflags, uint64_t *action_handle, 1258 nvlist_t **errors) 1259 { 1260 (void) action_handle, (void) cleanup_fd; 1261 return (recv_impl(snapname, props, NULL, NULL, 0, origin, force, 1262 B_FALSE, resumable, raw, input_fd, begin_record, 1263 read_bytes, errflags, errors)); 1264 } 1265 1266 /* 1267 * Like lzc_receive_one, but allows the caller to pass an additional 'cmdprops' 1268 * argument. 1269 * 1270 * The 'cmdprops' nvlist contains both override ('zfs receive -o') and 1271 * exclude ('zfs receive -x') properties. Callers are responsible for freeing 1272 * this nvlist 1273 */ 1274 int 1275 lzc_receive_with_cmdprops(const char *snapname, nvlist_t *props, 1276 nvlist_t *cmdprops, uint8_t *wkeydata, uint_t wkeylen, const char *origin, 1277 boolean_t force, boolean_t resumable, boolean_t raw, int input_fd, 1278 const dmu_replay_record_t *begin_record, int cleanup_fd, 1279 uint64_t *read_bytes, uint64_t *errflags, uint64_t *action_handle, 1280 nvlist_t **errors) 1281 { 1282 (void) action_handle, (void) cleanup_fd; 1283 return (recv_impl(snapname, props, cmdprops, wkeydata, wkeylen, origin, 1284 force, B_FALSE, resumable, raw, input_fd, begin_record, 1285 read_bytes, errflags, errors)); 1286 } 1287 1288 /* 1289 * Like lzc_receive_with_cmdprops, but allows the caller to pass an additional 1290 * 'heal' argument. 1291 * 1292 * The heal arguments tells us to heal the provided snapshot using the provided 1293 * send stream 1294 */ 1295 int lzc_receive_with_heal(const char *snapname, nvlist_t *props, 1296 nvlist_t *cmdprops, uint8_t *wkeydata, uint_t wkeylen, const char *origin, 1297 boolean_t force, boolean_t heal, boolean_t resumable, boolean_t raw, 1298 int input_fd, const dmu_replay_record_t *begin_record, int cleanup_fd, 1299 uint64_t *read_bytes, uint64_t *errflags, uint64_t *action_handle, 1300 nvlist_t **errors) 1301 { 1302 (void) action_handle, (void) cleanup_fd; 1303 return (recv_impl(snapname, props, cmdprops, wkeydata, wkeylen, origin, 1304 force, heal, resumable, raw, input_fd, begin_record, 1305 read_bytes, errflags, errors)); 1306 } 1307 1308 /* 1309 * Roll back this filesystem or volume to its most recent snapshot. 1310 * If snapnamebuf is not NULL, it will be filled in with the name 1311 * of the most recent snapshot. 1312 * Note that the latest snapshot may change if a new one is concurrently 1313 * created or the current one is destroyed. lzc_rollback_to can be used 1314 * to roll back to a specific latest snapshot. 1315 * 1316 * Return 0 on success or an errno on failure. 1317 */ 1318 int 1319 lzc_rollback(const char *fsname, char *snapnamebuf, int snapnamelen) 1320 { 1321 nvlist_t *args; 1322 nvlist_t *result; 1323 int err; 1324 1325 args = fnvlist_alloc(); 1326 err = lzc_ioctl(ZFS_IOC_ROLLBACK, fsname, args, &result); 1327 nvlist_free(args); 1328 if (err == 0 && snapnamebuf != NULL) { 1329 const char *snapname = fnvlist_lookup_string(result, "target"); 1330 (void) strlcpy(snapnamebuf, snapname, snapnamelen); 1331 } 1332 nvlist_free(result); 1333 1334 return (err); 1335 } 1336 1337 /* 1338 * Roll back this filesystem or volume to the specified snapshot, 1339 * if possible. 1340 * 1341 * Return 0 on success or an errno on failure. 1342 */ 1343 int 1344 lzc_rollback_to(const char *fsname, const char *snapname) 1345 { 1346 nvlist_t *args; 1347 nvlist_t *result; 1348 int err; 1349 1350 args = fnvlist_alloc(); 1351 fnvlist_add_string(args, "target", snapname); 1352 err = lzc_ioctl(ZFS_IOC_ROLLBACK, fsname, args, &result); 1353 nvlist_free(args); 1354 nvlist_free(result); 1355 return (err); 1356 } 1357 1358 /* 1359 * Creates new bookmarks from existing snapshot or bookmark. 1360 * 1361 * The bookmarks nvlist maps from the full name of the new bookmark to 1362 * the full name of the source snapshot or bookmark. 1363 * All the bookmarks and snapshots must be in the same pool. 1364 * The new bookmarks names must be unique. 1365 * => see function dsl_bookmark_create_nvl_validate 1366 * 1367 * The returned results nvlist will have an entry for each bookmark that failed. 1368 * The value will be the (int32) error code. 1369 * 1370 * The return value will be 0 if all bookmarks were created, otherwise it will 1371 * be the errno of a (undetermined) bookmarks that failed. 1372 */ 1373 int 1374 lzc_bookmark(nvlist_t *bookmarks, nvlist_t **errlist) 1375 { 1376 nvpair_t *elem; 1377 int error; 1378 char pool[ZFS_MAX_DATASET_NAME_LEN]; 1379 1380 /* determine pool name from first bookmark */ 1381 elem = nvlist_next_nvpair(bookmarks, NULL); 1382 if (elem == NULL) 1383 return (0); 1384 (void) strlcpy(pool, nvpair_name(elem), sizeof (pool)); 1385 pool[strcspn(pool, "/#")] = '\0'; 1386 1387 error = lzc_ioctl(ZFS_IOC_BOOKMARK, pool, bookmarks, errlist); 1388 1389 return (error); 1390 } 1391 1392 /* 1393 * Retrieve bookmarks. 1394 * 1395 * Retrieve the list of bookmarks for the given file system. The props 1396 * parameter is an nvlist of property names (with no values) that will be 1397 * returned for each bookmark. 1398 * 1399 * The following are valid properties on bookmarks, most of which are numbers 1400 * (represented as uint64 in the nvlist), except redact_snaps, which is a 1401 * uint64 array, and redact_complete, which is a boolean 1402 * 1403 * "guid" - globally unique identifier of the snapshot it refers to 1404 * "createtxg" - txg when the snapshot it refers to was created 1405 * "creation" - timestamp when the snapshot it refers to was created 1406 * "ivsetguid" - IVset guid for identifying encrypted snapshots 1407 * "redact_snaps" - list of guids of the redaction snapshots for the specified 1408 * bookmark. If the bookmark is not a redaction bookmark, the nvlist will 1409 * not contain an entry for this value. If it is redacted with respect to 1410 * no snapshots, it will contain value -> NULL uint64 array 1411 * "redact_complete" - boolean value; true if the redaction bookmark is 1412 * complete, false otherwise. 1413 * 1414 * The format of the returned nvlist as follows: 1415 * <short name of bookmark> -> { 1416 * <name of property> -> { 1417 * "value" -> uint64 1418 * } 1419 * ... 1420 * "redact_snaps" -> { 1421 * "value" -> uint64 array 1422 * } 1423 * "redact_complete" -> { 1424 * "value" -> boolean value 1425 * } 1426 * } 1427 */ 1428 int 1429 lzc_get_bookmarks(const char *fsname, nvlist_t *props, nvlist_t **bmarks) 1430 { 1431 return (lzc_ioctl(ZFS_IOC_GET_BOOKMARKS, fsname, props, bmarks)); 1432 } 1433 1434 /* 1435 * Get bookmark properties. 1436 * 1437 * Given a bookmark's full name, retrieve all properties for the bookmark. 1438 * 1439 * The format of the returned property list is as follows: 1440 * { 1441 * <name of property> -> { 1442 * "value" -> uint64 1443 * } 1444 * ... 1445 * "redact_snaps" -> { 1446 * "value" -> uint64 array 1447 * } 1448 */ 1449 int 1450 lzc_get_bookmark_props(const char *bookmark, nvlist_t **props) 1451 { 1452 int error; 1453 1454 nvlist_t *innvl = fnvlist_alloc(); 1455 error = lzc_ioctl(ZFS_IOC_GET_BOOKMARK_PROPS, bookmark, innvl, props); 1456 fnvlist_free(innvl); 1457 1458 return (error); 1459 } 1460 1461 /* 1462 * Destroys bookmarks. 1463 * 1464 * The keys in the bmarks nvlist are the bookmarks to be destroyed. 1465 * They must all be in the same pool. Bookmarks are specified as 1466 * <fs>#<bmark>. 1467 * 1468 * Bookmarks that do not exist will be silently ignored. 1469 * 1470 * The return value will be 0 if all bookmarks that existed were destroyed. 1471 * 1472 * Otherwise the return value will be the errno of a (undetermined) bookmark 1473 * that failed, no bookmarks will be destroyed, and the errlist will have an 1474 * entry for each bookmarks that failed. The value in the errlist will be 1475 * the (int32) error code. 1476 */ 1477 int 1478 lzc_destroy_bookmarks(nvlist_t *bmarks, nvlist_t **errlist) 1479 { 1480 nvpair_t *elem; 1481 int error; 1482 char pool[ZFS_MAX_DATASET_NAME_LEN]; 1483 1484 /* determine the pool name */ 1485 elem = nvlist_next_nvpair(bmarks, NULL); 1486 if (elem == NULL) 1487 return (0); 1488 (void) strlcpy(pool, nvpair_name(elem), sizeof (pool)); 1489 pool[strcspn(pool, "/#")] = '\0'; 1490 1491 error = lzc_ioctl(ZFS_IOC_DESTROY_BOOKMARKS, pool, bmarks, errlist); 1492 1493 return (error); 1494 } 1495 1496 static int 1497 lzc_channel_program_impl(const char *pool, const char *program, boolean_t sync, 1498 uint64_t instrlimit, uint64_t memlimit, nvlist_t *argnvl, nvlist_t **outnvl) 1499 { 1500 int error; 1501 nvlist_t *args; 1502 1503 args = fnvlist_alloc(); 1504 fnvlist_add_string(args, ZCP_ARG_PROGRAM, program); 1505 fnvlist_add_nvlist(args, ZCP_ARG_ARGLIST, argnvl); 1506 fnvlist_add_boolean_value(args, ZCP_ARG_SYNC, sync); 1507 fnvlist_add_uint64(args, ZCP_ARG_INSTRLIMIT, instrlimit); 1508 fnvlist_add_uint64(args, ZCP_ARG_MEMLIMIT, memlimit); 1509 error = lzc_ioctl(ZFS_IOC_CHANNEL_PROGRAM, pool, args, outnvl); 1510 fnvlist_free(args); 1511 1512 return (error); 1513 } 1514 1515 /* 1516 * Executes a channel program. 1517 * 1518 * If this function returns 0 the channel program was successfully loaded and 1519 * ran without failing. Note that individual commands the channel program ran 1520 * may have failed and the channel program is responsible for reporting such 1521 * errors through outnvl if they are important. 1522 * 1523 * This method may also return: 1524 * 1525 * EINVAL The program contains syntax errors, or an invalid memory or time 1526 * limit was given. No part of the channel program was executed. 1527 * If caused by syntax errors, 'outnvl' contains information about the 1528 * errors. 1529 * 1530 * ECHRNG The program was executed, but encountered a runtime error, such as 1531 * calling a function with incorrect arguments, invoking the error() 1532 * function directly, failing an assert() command, etc. Some portion 1533 * of the channel program may have executed and committed changes. 1534 * Information about the failure can be found in 'outnvl'. 1535 * 1536 * ENOMEM The program fully executed, but the output buffer was not large 1537 * enough to store the returned value. No output is returned through 1538 * 'outnvl'. 1539 * 1540 * ENOSPC The program was terminated because it exceeded its memory usage 1541 * limit. Some portion of the channel program may have executed and 1542 * committed changes to disk. No output is returned through 'outnvl'. 1543 * 1544 * ETIME The program was terminated because it exceeded its Lua instruction 1545 * limit. Some portion of the channel program may have executed and 1546 * committed changes to disk. No output is returned through 'outnvl'. 1547 */ 1548 int 1549 lzc_channel_program(const char *pool, const char *program, uint64_t instrlimit, 1550 uint64_t memlimit, nvlist_t *argnvl, nvlist_t **outnvl) 1551 { 1552 return (lzc_channel_program_impl(pool, program, B_TRUE, instrlimit, 1553 memlimit, argnvl, outnvl)); 1554 } 1555 1556 /* 1557 * Creates a checkpoint for the specified pool. 1558 * 1559 * If this function returns 0 the pool was successfully checkpointed. 1560 * 1561 * This method may also return: 1562 * 1563 * ZFS_ERR_CHECKPOINT_EXISTS 1564 * The pool already has a checkpoint. A pools can only have one 1565 * checkpoint at most, at any given time. 1566 * 1567 * ZFS_ERR_DISCARDING_CHECKPOINT 1568 * ZFS is in the middle of discarding a checkpoint for this pool. 1569 * The pool can be checkpointed again once the discard is done. 1570 * 1571 * ZFS_DEVRM_IN_PROGRESS 1572 * A vdev is currently being removed. The pool cannot be 1573 * checkpointed until the device removal is done. 1574 * 1575 * ZFS_VDEV_TOO_BIG 1576 * One or more top-level vdevs exceed the maximum vdev size 1577 * supported for this feature. 1578 */ 1579 int 1580 lzc_pool_checkpoint(const char *pool) 1581 { 1582 int error; 1583 1584 nvlist_t *result = NULL; 1585 nvlist_t *args = fnvlist_alloc(); 1586 1587 error = lzc_ioctl(ZFS_IOC_POOL_CHECKPOINT, pool, args, &result); 1588 1589 fnvlist_free(args); 1590 fnvlist_free(result); 1591 1592 return (error); 1593 } 1594 1595 /* 1596 * Discard the checkpoint from the specified pool. 1597 * 1598 * If this function returns 0 the checkpoint was successfully discarded. 1599 * 1600 * This method may also return: 1601 * 1602 * ZFS_ERR_NO_CHECKPOINT 1603 * The pool does not have a checkpoint. 1604 * 1605 * ZFS_ERR_DISCARDING_CHECKPOINT 1606 * ZFS is already in the middle of discarding the checkpoint. 1607 */ 1608 int 1609 lzc_pool_checkpoint_discard(const char *pool) 1610 { 1611 int error; 1612 1613 nvlist_t *result = NULL; 1614 nvlist_t *args = fnvlist_alloc(); 1615 1616 error = lzc_ioctl(ZFS_IOC_POOL_DISCARD_CHECKPOINT, pool, args, &result); 1617 1618 fnvlist_free(args); 1619 fnvlist_free(result); 1620 1621 return (error); 1622 } 1623 1624 /* 1625 * Executes a read-only channel program. 1626 * 1627 * A read-only channel program works programmatically the same way as a 1628 * normal channel program executed with lzc_channel_program(). The only 1629 * difference is it runs exclusively in open-context and therefore can 1630 * return faster. The downside to that, is that the program cannot change 1631 * on-disk state by calling functions from the zfs.sync submodule. 1632 * 1633 * The return values of this function (and their meaning) are exactly the 1634 * same as the ones described in lzc_channel_program(). 1635 */ 1636 int 1637 lzc_channel_program_nosync(const char *pool, const char *program, 1638 uint64_t timeout, uint64_t memlimit, nvlist_t *argnvl, nvlist_t **outnvl) 1639 { 1640 return (lzc_channel_program_impl(pool, program, B_FALSE, timeout, 1641 memlimit, argnvl, outnvl)); 1642 } 1643 1644 int 1645 lzc_get_vdev_prop(const char *poolname, nvlist_t *innvl, nvlist_t **outnvl) 1646 { 1647 return (lzc_ioctl(ZFS_IOC_VDEV_GET_PROPS, poolname, innvl, outnvl)); 1648 } 1649 1650 int 1651 lzc_set_vdev_prop(const char *poolname, nvlist_t *innvl, nvlist_t **outnvl) 1652 { 1653 return (lzc_ioctl(ZFS_IOC_VDEV_SET_PROPS, poolname, innvl, outnvl)); 1654 } 1655 1656 /* 1657 * Performs key management functions 1658 * 1659 * crypto_cmd should be a value from dcp_cmd_t. If the command specifies to 1660 * load or change a wrapping key, the key should be specified in the 1661 * hidden_args nvlist so that it is not logged. 1662 */ 1663 int 1664 lzc_load_key(const char *fsname, boolean_t noop, uint8_t *wkeydata, 1665 uint_t wkeylen) 1666 { 1667 int error; 1668 nvlist_t *ioc_args; 1669 nvlist_t *hidden_args; 1670 1671 if (wkeydata == NULL) 1672 return (EINVAL); 1673 1674 ioc_args = fnvlist_alloc(); 1675 hidden_args = fnvlist_alloc(); 1676 fnvlist_add_uint8_array(hidden_args, "wkeydata", wkeydata, wkeylen); 1677 fnvlist_add_nvlist(ioc_args, ZPOOL_HIDDEN_ARGS, hidden_args); 1678 if (noop) 1679 fnvlist_add_boolean(ioc_args, "noop"); 1680 error = lzc_ioctl(ZFS_IOC_LOAD_KEY, fsname, ioc_args, NULL); 1681 nvlist_free(hidden_args); 1682 nvlist_free(ioc_args); 1683 1684 return (error); 1685 } 1686 1687 int 1688 lzc_unload_key(const char *fsname) 1689 { 1690 return (lzc_ioctl(ZFS_IOC_UNLOAD_KEY, fsname, NULL, NULL)); 1691 } 1692 1693 int 1694 lzc_change_key(const char *fsname, uint64_t crypt_cmd, nvlist_t *props, 1695 uint8_t *wkeydata, uint_t wkeylen) 1696 { 1697 int error; 1698 nvlist_t *ioc_args = fnvlist_alloc(); 1699 nvlist_t *hidden_args = NULL; 1700 1701 fnvlist_add_uint64(ioc_args, "crypt_cmd", crypt_cmd); 1702 1703 if (wkeydata != NULL) { 1704 hidden_args = fnvlist_alloc(); 1705 fnvlist_add_uint8_array(hidden_args, "wkeydata", wkeydata, 1706 wkeylen); 1707 fnvlist_add_nvlist(ioc_args, ZPOOL_HIDDEN_ARGS, hidden_args); 1708 } 1709 1710 if (props != NULL) 1711 fnvlist_add_nvlist(ioc_args, "props", props); 1712 1713 error = lzc_ioctl(ZFS_IOC_CHANGE_KEY, fsname, ioc_args, NULL); 1714 nvlist_free(hidden_args); 1715 nvlist_free(ioc_args); 1716 1717 return (error); 1718 } 1719 1720 int 1721 lzc_reopen(const char *pool_name, boolean_t scrub_restart) 1722 { 1723 nvlist_t *args = fnvlist_alloc(); 1724 int error; 1725 1726 fnvlist_add_boolean_value(args, "scrub_restart", scrub_restart); 1727 1728 error = lzc_ioctl(ZFS_IOC_POOL_REOPEN, pool_name, args, NULL); 1729 nvlist_free(args); 1730 return (error); 1731 } 1732 1733 /* 1734 * Changes initializing state. 1735 * 1736 * vdevs should be a list of (<key>, guid) where guid is a uint64 vdev GUID. 1737 * The key is ignored. 1738 * 1739 * If there are errors related to vdev arguments, per-vdev errors are returned 1740 * in an nvlist with the key "vdevs". Each error is a (guid, errno) pair where 1741 * guid is stringified with PRIu64, and errno is one of the following as 1742 * an int64_t: 1743 * - ENODEV if the device was not found 1744 * - EINVAL if the devices is not a leaf or is not concrete (e.g. missing) 1745 * - EROFS if the device is not writeable 1746 * - EBUSY start requested but the device is already being either 1747 * initialized or trimmed 1748 * - ESRCH cancel/suspend requested but device is not being initialized 1749 * 1750 * If the errlist is empty, then return value will be: 1751 * - EINVAL if one or more arguments was invalid 1752 * - Other spa_open failures 1753 * - 0 if the operation succeeded 1754 */ 1755 int 1756 lzc_initialize(const char *poolname, pool_initialize_func_t cmd_type, 1757 nvlist_t *vdevs, nvlist_t **errlist) 1758 { 1759 int error; 1760 1761 nvlist_t *args = fnvlist_alloc(); 1762 fnvlist_add_uint64(args, ZPOOL_INITIALIZE_COMMAND, (uint64_t)cmd_type); 1763 fnvlist_add_nvlist(args, ZPOOL_INITIALIZE_VDEVS, vdevs); 1764 1765 error = lzc_ioctl(ZFS_IOC_POOL_INITIALIZE, poolname, args, errlist); 1766 1767 fnvlist_free(args); 1768 1769 return (error); 1770 } 1771 1772 /* 1773 * Changes TRIM state. 1774 * 1775 * vdevs should be a list of (<key>, guid) where guid is a uint64 vdev GUID. 1776 * The key is ignored. 1777 * 1778 * If there are errors related to vdev arguments, per-vdev errors are returned 1779 * in an nvlist with the key "vdevs". Each error is a (guid, errno) pair where 1780 * guid is stringified with PRIu64, and errno is one of the following as 1781 * an int64_t: 1782 * - ENODEV if the device was not found 1783 * - EINVAL if the devices is not a leaf or is not concrete (e.g. missing) 1784 * - EROFS if the device is not writeable 1785 * - EBUSY start requested but the device is already being either trimmed 1786 * or initialized 1787 * - ESRCH cancel/suspend requested but device is not being initialized 1788 * - EOPNOTSUPP if the device does not support TRIM (or secure TRIM) 1789 * 1790 * If the errlist is empty, then return value will be: 1791 * - EINVAL if one or more arguments was invalid 1792 * - Other spa_open failures 1793 * - 0 if the operation succeeded 1794 */ 1795 int 1796 lzc_trim(const char *poolname, pool_trim_func_t cmd_type, uint64_t rate, 1797 boolean_t secure, nvlist_t *vdevs, nvlist_t **errlist) 1798 { 1799 int error; 1800 1801 nvlist_t *args = fnvlist_alloc(); 1802 fnvlist_add_uint64(args, ZPOOL_TRIM_COMMAND, (uint64_t)cmd_type); 1803 fnvlist_add_nvlist(args, ZPOOL_TRIM_VDEVS, vdevs); 1804 fnvlist_add_uint64(args, ZPOOL_TRIM_RATE, rate); 1805 fnvlist_add_boolean_value(args, ZPOOL_TRIM_SECURE, secure); 1806 1807 error = lzc_ioctl(ZFS_IOC_POOL_TRIM, poolname, args, errlist); 1808 1809 fnvlist_free(args); 1810 1811 return (error); 1812 } 1813 1814 /* 1815 * Create a redaction bookmark named bookname by redacting snapshot with respect 1816 * to all the snapshots in snapnv. 1817 */ 1818 int 1819 lzc_redact(const char *snapshot, const char *bookname, nvlist_t *snapnv) 1820 { 1821 nvlist_t *args = fnvlist_alloc(); 1822 fnvlist_add_string(args, "bookname", bookname); 1823 fnvlist_add_nvlist(args, "snapnv", snapnv); 1824 int error = lzc_ioctl(ZFS_IOC_REDACT, snapshot, args, NULL); 1825 fnvlist_free(args); 1826 return (error); 1827 } 1828 1829 static int 1830 wait_common(const char *pool, zpool_wait_activity_t activity, boolean_t use_tag, 1831 uint64_t tag, boolean_t *waited) 1832 { 1833 nvlist_t *args = fnvlist_alloc(); 1834 nvlist_t *result = NULL; 1835 1836 fnvlist_add_int32(args, ZPOOL_WAIT_ACTIVITY, activity); 1837 if (use_tag) 1838 fnvlist_add_uint64(args, ZPOOL_WAIT_TAG, tag); 1839 1840 int error = lzc_ioctl(ZFS_IOC_WAIT, pool, args, &result); 1841 1842 if (error == 0 && waited != NULL) 1843 *waited = fnvlist_lookup_boolean_value(result, 1844 ZPOOL_WAIT_WAITED); 1845 1846 fnvlist_free(args); 1847 fnvlist_free(result); 1848 1849 return (error); 1850 } 1851 1852 int 1853 lzc_wait(const char *pool, zpool_wait_activity_t activity, boolean_t *waited) 1854 { 1855 return (wait_common(pool, activity, B_FALSE, 0, waited)); 1856 } 1857 1858 int 1859 lzc_wait_tag(const char *pool, zpool_wait_activity_t activity, uint64_t tag, 1860 boolean_t *waited) 1861 { 1862 return (wait_common(pool, activity, B_TRUE, tag, waited)); 1863 } 1864 1865 int 1866 lzc_wait_fs(const char *fs, zfs_wait_activity_t activity, boolean_t *waited) 1867 { 1868 nvlist_t *args = fnvlist_alloc(); 1869 nvlist_t *result = NULL; 1870 1871 fnvlist_add_int32(args, ZFS_WAIT_ACTIVITY, activity); 1872 1873 int error = lzc_ioctl(ZFS_IOC_WAIT_FS, fs, args, &result); 1874 1875 if (error == 0 && waited != NULL) 1876 *waited = fnvlist_lookup_boolean_value(result, 1877 ZFS_WAIT_WAITED); 1878 1879 fnvlist_free(args); 1880 fnvlist_free(result); 1881 1882 return (error); 1883 } 1884 1885 /* 1886 * Set the bootenv contents for the given pool. 1887 */ 1888 int 1889 lzc_set_bootenv(const char *pool, const nvlist_t *env) 1890 { 1891 return (lzc_ioctl(ZFS_IOC_SET_BOOTENV, pool, (nvlist_t *)env, NULL)); 1892 } 1893 1894 /* 1895 * Get the contents of the bootenv of the given pool. 1896 */ 1897 int 1898 lzc_get_bootenv(const char *pool, nvlist_t **outnvl) 1899 { 1900 return (lzc_ioctl(ZFS_IOC_GET_BOOTENV, pool, NULL, outnvl)); 1901 } 1902