4 * The contents of this file are subject to the terms of the
5 * Common Development and Distribution License (the "License").
6 * You may not use this file except in compliance with the License.
8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 * or http://www.opensolaris.org/os/licensing.
10 * See the License for the specific language governing permissions
11 * and limitations under the License.
13 * When distributing Covered Code, include this CDDL HEADER in each
14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 * If applicable, add the following below this CDDL HEADER, with the
16 * fields enclosed by brackets "[]" replaced with your own identifying
17 * information: Portions Copyright [yyyy] [name of copyright owner]
23 * Copyright (c) 2012, 2017 by Delphix. All rights reserved.
24 * Copyright (c) 2013 Steven Hartland. All rights reserved.
25 * Copyright (c) 2014 Integros [integros.com]
26 * Copyright 2017 RackTop Systems.
30 * LibZFS_Core (lzc) is intended to replace most functionality in libzfs.
31 * It has the following characteristics:
33 * - Thread Safe. libzfs_core is accessible concurrently from multiple
34 * threads. This is accomplished primarily by avoiding global data
35 * (e.g. caching). Since it's thread-safe, there is no reason for a
36 * process to have multiple libzfs "instances". Therefore, we store
37 * our few pieces of data (e.g. the file descriptor) in global
38 * variables. The fd is reference-counted so that the libzfs_core
39 * library can be "initialized" multiple times (e.g. by different
40 * consumers within the same process).
42 * - Committed Interface. The libzfs_core interface will be committed,
43 * therefore consumers can compile against it and be confident that
44 * their code will continue to work on future releases of this code.
45 * Currently, the interface is Evolving (not Committed), but we intend
46 * to commit to it once it is more complete and we determine that it
47 * meets the needs of all consumers.
49 * - Programatic Error Handling. libzfs_core communicates errors with
50 * defined error numbers, and doesn't print anything to stdout/stderr.
52 * - Thin Layer. libzfs_core is a thin layer, marshaling arguments
53 * to/from the kernel ioctls. There is generally a 1:1 correspondence
54 * between libzfs_core functions and ioctls to /dev/zfs.
56 * - Clear Atomicity. Because libzfs_core functions are generally 1:1
57 * with kernel ioctls, and kernel ioctls are general atomic, each
58 * libzfs_core function is atomic. For example, creating multiple
59 * snapshots with a single call to lzc_snapshot() is atomic -- it
60 * can't fail with only some of the requested snapshots created, even
61 * in the event of power loss or system crash.
63 * - Continued libzfs Support. Some higher-level operations (e.g.
64 * support for "zfs send -R") are too complicated to fit the scope of
65 * libzfs_core. This functionality will continue to live in libzfs.
66 * Where appropriate, libzfs will use the underlying atomic operations
67 * of libzfs_core. For example, libzfs may implement "zfs send -R |
68 * zfs receive" by using individual "send one snapshot", rename,
69 * destroy, and "receive one snapshot" operations in libzfs_core.
70 * /sbin/zfs and /zbin/zpool will link with both libzfs and
71 * libzfs_core. Other consumers should aim to use only libzfs_core,
72 * since that will be the supported, stable interface going forwards.
75 #define _IN_LIBZFS_CORE_
77 #include <libzfs_core.h>
85 #include <sys/nvpair.h>
86 #include <sys/param.h>
87 #include <sys/types.h>
89 #include <sys/zfs_ioctl.h>
90 #include "libzfs_core_compat.h"
91 #include "libzfs_compat.h"
94 extern int zfs_ioctl_version;
98 static pthread_mutex_t g_lock = PTHREAD_MUTEX_INITIALIZER;
99 static int g_refcount;
102 libzfs_core_init(void)
104 (void) pthread_mutex_lock(&g_lock);
105 if (g_refcount == 0) {
106 g_fd = open("/dev/zfs", O_RDWR);
108 (void) pthread_mutex_unlock(&g_lock);
113 (void) pthread_mutex_unlock(&g_lock);
119 libzfs_core_fini(void)
121 (void) pthread_mutex_lock(&g_lock);
122 ASSERT3S(g_refcount, >, 0);
126 (void) pthread_mutex_unlock(&g_lock);
130 lzc_ioctl(zfs_ioc_t ioc, const char *name,
131 nvlist_t *source, nvlist_t **resultp)
133 zfs_cmd_t zc = { 0 };
141 ASSERT3S(g_refcount, >, 0);
143 (void) strlcpy(zc.zc_name, name, sizeof (zc.zc_name));
146 if (zfs_ioctl_version == ZFS_IOCVER_UNDEF)
147 zfs_ioctl_version = get_zfs_ioctl_version();
149 if (zfs_ioctl_version < ZFS_IOCVER_LZC) {
151 error = lzc_compat_pre(&zc, &ioc, &source);
157 packed = fnvlist_pack(source, &size);
158 zc.zc_nvlist_src = (uint64_t)(uintptr_t)packed;
159 zc.zc_nvlist_src_size = size;
161 if (resultp != NULL) {
163 if (ioc == ZFS_IOC_CHANNEL_PROGRAM) {
164 zc.zc_nvlist_dst_size = fnvlist_lookup_uint64(source,
167 zc.zc_nvlist_dst_size = MAX(size * 2, 128 * 1024);
169 zc.zc_nvlist_dst = (uint64_t)(uintptr_t)
170 malloc(zc.zc_nvlist_dst_size);
172 if (zc.zc_nvlist_dst == NULL) {
174 if (zc.zc_nvlist_dst == 0) {
181 while (ioctl(g_fd, ioc, &zc) != 0) {
183 * If ioctl exited with ENOMEM, we retry the ioctl after
184 * increasing the size of the destination nvlist.
186 * Channel programs that exit with ENOMEM ran over the
187 * lua memory sandbox; they should not be retried.
189 if (errno == ENOMEM && resultp != NULL &&
190 ioc != ZFS_IOC_CHANNEL_PROGRAM) {
191 free((void *)(uintptr_t)zc.zc_nvlist_dst);
192 zc.zc_nvlist_dst_size *= 2;
193 zc.zc_nvlist_dst = (uint64_t)(uintptr_t)
194 malloc(zc.zc_nvlist_dst_size);
196 if (zc.zc_nvlist_dst == NULL) {
198 if (zc.zc_nvlist_dst == 0) {
210 if (zfs_ioctl_version < ZFS_IOCVER_LZC)
211 lzc_compat_post(&zc, ioc);
213 if (zc.zc_nvlist_dst_filled) {
214 *resultp = fnvlist_unpack((void *)(uintptr_t)zc.zc_nvlist_dst,
215 zc.zc_nvlist_dst_size);
218 if (zfs_ioctl_version < ZFS_IOCVER_LZC)
219 lzc_compat_outnvl(&zc, ioc, resultp);
223 if (zfs_ioctl_version < ZFS_IOCVER_LZC) {
224 if (source != oldsource)
229 fnvlist_pack_free(packed, size);
230 free((void *)(uintptr_t)zc.zc_nvlist_dst);
235 lzc_create(const char *fsname, enum lzc_dataset_type type, nvlist_t *props)
238 nvlist_t *args = fnvlist_alloc();
239 fnvlist_add_int32(args, "type", (dmu_objset_type_t)type);
241 fnvlist_add_nvlist(args, "props", props);
242 error = lzc_ioctl(ZFS_IOC_CREATE, fsname, args, NULL);
248 lzc_clone(const char *fsname, const char *origin,
252 nvlist_t *args = fnvlist_alloc();
253 fnvlist_add_string(args, "origin", origin);
255 fnvlist_add_nvlist(args, "props", props);
256 error = lzc_ioctl(ZFS_IOC_CLONE, fsname, args, NULL);
262 lzc_promote(const char *fsname, char *snapnamebuf, int snapnamelen)
265 * The promote ioctl is still legacy, so we need to construct our
266 * own zfs_cmd_t rather than using lzc_ioctl().
268 zfs_cmd_t zc = { 0 };
270 ASSERT3S(g_refcount, >, 0);
271 VERIFY3S(g_fd, !=, -1);
273 (void) strlcpy(zc.zc_name, fsname, sizeof (zc.zc_name));
274 if (ioctl(g_fd, ZFS_IOC_PROMOTE, &zc) != 0) {
276 if (error == EEXIST && snapnamebuf != NULL)
277 (void) strlcpy(snapnamebuf, zc.zc_string, snapnamelen);
286 * The keys in the snaps nvlist are the snapshots to be created.
287 * They must all be in the same pool.
289 * The props nvlist is properties to set. Currently only user properties
290 * are supported. { user:prop_name -> string value }
292 * The returned results nvlist will have an entry for each snapshot that failed.
293 * The value will be the (int32) error code.
295 * The return value will be 0 if all snapshots were created, otherwise it will
296 * be the errno of a (unspecified) snapshot that failed.
299 lzc_snapshot(nvlist_t *snaps, nvlist_t *props, nvlist_t **errlist)
304 char pool[ZFS_MAX_DATASET_NAME_LEN];
308 /* determine the pool name */
309 elem = nvlist_next_nvpair(snaps, NULL);
312 (void) strlcpy(pool, nvpair_name(elem), sizeof (pool));
313 pool[strcspn(pool, "/@")] = '\0';
315 args = fnvlist_alloc();
316 fnvlist_add_nvlist(args, "snaps", snaps);
318 fnvlist_add_nvlist(args, "props", props);
320 error = lzc_ioctl(ZFS_IOC_SNAPSHOT, pool, args, errlist);
327 * Destroys snapshots.
329 * The keys in the snaps nvlist are the snapshots to be destroyed.
330 * They must all be in the same pool.
332 * Snapshots that do not exist will be silently ignored.
334 * If 'defer' is not set, and a snapshot has user holds or clones, the
335 * destroy operation will fail and none of the snapshots will be
338 * If 'defer' is set, and a snapshot has user holds or clones, it will be
339 * marked for deferred destruction, and will be destroyed when the last hold
340 * or clone is removed/destroyed.
342 * The return value will be 0 if all snapshots were destroyed (or marked for
343 * later destruction if 'defer' is set) or didn't exist to begin with.
345 * Otherwise the return value will be the errno of a (unspecified) snapshot
346 * that failed, no snapshots will be destroyed, and the errlist will have an
347 * entry for each snapshot that failed. The value in the errlist will be
348 * the (int32) error code.
351 lzc_destroy_snaps(nvlist_t *snaps, boolean_t defer, nvlist_t **errlist)
356 char pool[ZFS_MAX_DATASET_NAME_LEN];
358 /* determine the pool name */
359 elem = nvlist_next_nvpair(snaps, NULL);
362 (void) strlcpy(pool, nvpair_name(elem), sizeof (pool));
363 pool[strcspn(pool, "/@")] = '\0';
365 args = fnvlist_alloc();
366 fnvlist_add_nvlist(args, "snaps", snaps);
368 fnvlist_add_boolean(args, "defer");
370 error = lzc_ioctl(ZFS_IOC_DESTROY_SNAPS, pool, args, errlist);
377 lzc_snaprange_space(const char *firstsnap, const char *lastsnap,
383 char fs[ZFS_MAX_DATASET_NAME_LEN];
386 /* determine the fs name */
387 (void) strlcpy(fs, firstsnap, sizeof (fs));
388 atp = strchr(fs, '@');
393 args = fnvlist_alloc();
394 fnvlist_add_string(args, "firstsnap", firstsnap);
396 err = lzc_ioctl(ZFS_IOC_SPACE_SNAPS, lastsnap, args, &result);
399 *usedp = fnvlist_lookup_uint64(result, "used");
400 fnvlist_free(result);
406 lzc_exists(const char *dataset)
409 * The objset_stats ioctl is still legacy, so we need to construct our
410 * own zfs_cmd_t rather than using lzc_ioctl().
412 zfs_cmd_t zc = { 0 };
414 (void) strlcpy(zc.zc_name, dataset, sizeof (zc.zc_name));
415 return (ioctl(g_fd, ZFS_IOC_OBJSET_STATS, &zc) == 0);
419 * Create "user holds" on snapshots. If there is a hold on a snapshot,
420 * the snapshot can not be destroyed. (However, it can be marked for deletion
421 * by lzc_destroy_snaps(defer=B_TRUE).)
423 * The keys in the nvlist are snapshot names.
424 * The snapshots must all be in the same pool.
425 * The value is the name of the hold (string type).
427 * If cleanup_fd is not -1, it must be the result of open("/dev/zfs", O_EXCL).
428 * In this case, when the cleanup_fd is closed (including on process
429 * termination), the holds will be released. If the system is shut down
430 * uncleanly, the holds will be released when the pool is next opened
433 * Holds for snapshots which don't exist will be skipped and have an entry
434 * added to errlist, but will not cause an overall failure.
436 * The return value will be 0 if all holds, for snapshots that existed,
437 * were succesfully created.
439 * Otherwise the return value will be the errno of a (unspecified) hold that
440 * failed and no holds will be created.
442 * In all cases the errlist will have an entry for each hold that failed
443 * (name = snapshot), with its value being the error code (int32).
446 lzc_hold(nvlist_t *holds, int cleanup_fd, nvlist_t **errlist)
448 char pool[ZFS_MAX_DATASET_NAME_LEN];
453 /* determine the pool name */
454 elem = nvlist_next_nvpair(holds, NULL);
457 (void) strlcpy(pool, nvpair_name(elem), sizeof (pool));
458 pool[strcspn(pool, "/@")] = '\0';
460 args = fnvlist_alloc();
461 fnvlist_add_nvlist(args, "holds", holds);
462 if (cleanup_fd != -1)
463 fnvlist_add_int32(args, "cleanup_fd", cleanup_fd);
465 error = lzc_ioctl(ZFS_IOC_HOLD, pool, args, errlist);
471 * Release "user holds" on snapshots. If the snapshot has been marked for
472 * deferred destroy (by lzc_destroy_snaps(defer=B_TRUE)), it does not have
473 * any clones, and all the user holds are removed, then the snapshot will be
476 * The keys in the nvlist are snapshot names.
477 * The snapshots must all be in the same pool.
478 * The value is a nvlist whose keys are the holds to remove.
480 * Holds which failed to release because they didn't exist will have an entry
481 * added to errlist, but will not cause an overall failure.
483 * The return value will be 0 if the nvl holds was empty or all holds that
484 * existed, were successfully removed.
486 * Otherwise the return value will be the errno of a (unspecified) hold that
487 * failed to release and no holds will be released.
489 * In all cases the errlist will have an entry for each hold that failed to
493 lzc_release(nvlist_t *holds, nvlist_t **errlist)
495 char pool[ZFS_MAX_DATASET_NAME_LEN];
498 /* determine the pool name */
499 elem = nvlist_next_nvpair(holds, NULL);
502 (void) strlcpy(pool, nvpair_name(elem), sizeof (pool));
503 pool[strcspn(pool, "/@")] = '\0';
505 return (lzc_ioctl(ZFS_IOC_RELEASE, pool, holds, errlist));
509 * Retrieve list of user holds on the specified snapshot.
511 * On success, *holdsp will be set to a nvlist which the caller must free.
512 * The keys are the names of the holds, and the value is the creation time
513 * of the hold (uint64) in seconds since the epoch.
516 lzc_get_holds(const char *snapname, nvlist_t **holdsp)
519 nvlist_t *innvl = fnvlist_alloc();
520 error = lzc_ioctl(ZFS_IOC_GET_HOLDS, snapname, innvl, holdsp);
526 * Generate a zfs send stream for the specified snapshot and write it to
527 * the specified file descriptor.
529 * "snapname" is the full name of the snapshot to send (e.g. "pool/fs@snap")
531 * If "from" is NULL, a full (non-incremental) stream will be sent.
532 * If "from" is non-NULL, it must be the full name of a snapshot or
533 * bookmark to send an incremental from (e.g. "pool/fs@earlier_snap" or
534 * "pool/fs#earlier_bmark"). If non-NULL, the specified snapshot or
535 * bookmark must represent an earlier point in the history of "snapname").
536 * It can be an earlier snapshot in the same filesystem or zvol as "snapname",
537 * or it can be the origin of "snapname"'s filesystem, or an earlier
538 * snapshot in the origin, etc.
540 * "fd" is the file descriptor to write the send stream to.
542 * If "flags" contains LZC_SEND_FLAG_LARGE_BLOCK, the stream is permitted
543 * to contain DRR_WRITE records with drr_length > 128K, and DRR_OBJECT
544 * records with drr_blksz > 128K.
546 * If "flags" contains LZC_SEND_FLAG_EMBED_DATA, the stream is permitted
547 * to contain DRR_WRITE_EMBEDDED records with drr_etype==BP_EMBEDDED_TYPE_DATA,
548 * which the receiving system must support (as indicated by support
549 * for the "embedded_data" feature).
552 lzc_send(const char *snapname, const char *from, int fd,
553 enum lzc_send_flags flags)
555 return (lzc_send_resume(snapname, from, fd, flags, 0, 0));
559 lzc_send_resume(const char *snapname, const char *from, int fd,
560 enum lzc_send_flags flags, uint64_t resumeobj, uint64_t resumeoff)
565 args = fnvlist_alloc();
566 fnvlist_add_int32(args, "fd", fd);
568 fnvlist_add_string(args, "fromsnap", from);
569 if (flags & LZC_SEND_FLAG_LARGE_BLOCK)
570 fnvlist_add_boolean(args, "largeblockok");
571 if (flags & LZC_SEND_FLAG_EMBED_DATA)
572 fnvlist_add_boolean(args, "embedok");
573 if (flags & LZC_SEND_FLAG_COMPRESS)
574 fnvlist_add_boolean(args, "compressok");
575 if (resumeobj != 0 || resumeoff != 0) {
576 fnvlist_add_uint64(args, "resume_object", resumeobj);
577 fnvlist_add_uint64(args, "resume_offset", resumeoff);
579 err = lzc_ioctl(ZFS_IOC_SEND_NEW, snapname, args, NULL);
585 * "from" can be NULL, a snapshot, or a bookmark.
587 * If from is NULL, a full (non-incremental) stream will be estimated. This
588 * is calculated very efficiently.
590 * If from is a snapshot, lzc_send_space uses the deadlists attached to
591 * each snapshot to efficiently estimate the stream size.
593 * If from is a bookmark, the indirect blocks in the destination snapshot
594 * are traversed, looking for blocks with a birth time since the creation TXG of
595 * the snapshot this bookmark was created from. This will result in
596 * significantly more I/O and be less efficient than a send space estimation on
597 * an equivalent snapshot.
600 lzc_send_space(const char *snapname, const char *from,
601 enum lzc_send_flags flags, uint64_t *spacep)
607 args = fnvlist_alloc();
609 fnvlist_add_string(args, "from", from);
610 if (flags & LZC_SEND_FLAG_LARGE_BLOCK)
611 fnvlist_add_boolean(args, "largeblockok");
612 if (flags & LZC_SEND_FLAG_EMBED_DATA)
613 fnvlist_add_boolean(args, "embedok");
614 if (flags & LZC_SEND_FLAG_COMPRESS)
615 fnvlist_add_boolean(args, "compressok");
616 err = lzc_ioctl(ZFS_IOC_SEND_SPACE, snapname, args, &result);
619 *spacep = fnvlist_lookup_uint64(result, "space");
625 recv_read(int fd, void *buf, int ilen)
632 rv = read(fd, cp, len);
637 if (rv < 0 || len != 0)
644 recv_impl(const char *snapname, nvlist_t *props, const char *origin,
645 boolean_t force, boolean_t resumable, int fd,
646 const dmu_replay_record_t *begin_record)
649 * The receive ioctl is still legacy, so we need to construct our own
650 * zfs_cmd_t rather than using zfsc_ioctl().
652 zfs_cmd_t zc = { 0 };
658 ASSERT3S(g_refcount, >, 0);
660 /* zc_name is name of containing filesystem */
661 (void) strlcpy(zc.zc_name, snapname, sizeof (zc.zc_name));
662 atp = strchr(zc.zc_name, '@');
667 /* if the fs does not exist, try its parent. */
668 if (!lzc_exists(zc.zc_name)) {
669 char *slashp = strrchr(zc.zc_name, '/');
676 /* zc_value is full name of the snapshot to create */
677 (void) strlcpy(zc.zc_value, snapname, sizeof (zc.zc_value));
680 /* zc_nvlist_src is props to set */
681 packed = fnvlist_pack(props, &size);
682 zc.zc_nvlist_src = (uint64_t)(uintptr_t)packed;
683 zc.zc_nvlist_src_size = size;
686 /* zc_string is name of clone origin (if DRR_FLAG_CLONE) */
688 (void) strlcpy(zc.zc_string, origin, sizeof (zc.zc_string));
690 /* zc_begin_record is non-byteswapped BEGIN record */
691 if (begin_record == NULL) {
692 error = recv_read(fd, &zc.zc_begin_record,
693 sizeof (zc.zc_begin_record));
697 zc.zc_begin_record = *begin_record;
700 /* zc_cookie is fd to read from */
703 /* zc guid is force flag */
706 zc.zc_resumable = resumable;
708 /* zc_cleanup_fd is unused */
709 zc.zc_cleanup_fd = -1;
711 error = ioctl(g_fd, ZFS_IOC_RECV, &zc);
717 fnvlist_pack_free(packed, size);
718 free((void*)(uintptr_t)zc.zc_nvlist_dst);
723 * The simplest receive case: receive from the specified fd, creating the
724 * specified snapshot. Apply the specified properties as "received" properties
725 * (which can be overridden by locally-set properties). If the stream is a
726 * clone, its origin snapshot must be specified by 'origin'. The 'force'
727 * flag will cause the target filesystem to be rolled back or destroyed if
728 * necessary to receive.
730 * Return 0 on success or an errno on failure.
732 * Note: this interface does not work on dedup'd streams
733 * (those with DMU_BACKUP_FEATURE_DEDUP).
736 lzc_receive(const char *snapname, nvlist_t *props, const char *origin,
737 boolean_t force, int fd)
739 return (recv_impl(snapname, props, origin, force, B_FALSE, fd, NULL));
743 * Like lzc_receive, but if the receive fails due to premature stream
744 * termination, the intermediate state will be preserved on disk. In this
745 * case, ECKSUM will be returned. The receive may subsequently be resumed
746 * with a resuming send stream generated by lzc_send_resume().
749 lzc_receive_resumable(const char *snapname, nvlist_t *props, const char *origin,
750 boolean_t force, int fd)
752 return (recv_impl(snapname, props, origin, force, B_TRUE, fd, NULL));
756 * Like lzc_receive, but allows the caller to read the begin record and then to
757 * pass it in. That could be useful if the caller wants to derive, for example,
758 * the snapname or the origin parameters based on the information contained in
760 * The begin record must be in its original form as read from the stream,
761 * in other words, it should not be byteswapped.
763 * The 'resumable' parameter allows to obtain the same behavior as with
764 * lzc_receive_resumable.
767 lzc_receive_with_header(const char *snapname, nvlist_t *props,
768 const char *origin, boolean_t force, boolean_t resumable, int fd,
769 const dmu_replay_record_t *begin_record)
771 if (begin_record == NULL)
773 return (recv_impl(snapname, props, origin, force, resumable, fd,
778 * Roll back this filesystem or volume to its most recent snapshot.
779 * If snapnamebuf is not NULL, it will be filled in with the name
780 * of the most recent snapshot.
781 * Note that the latest snapshot may change if a new one is concurrently
782 * created or the current one is destroyed. lzc_rollback_to can be used
783 * to roll back to a specific latest snapshot.
785 * Return 0 on success or an errno on failure.
788 lzc_rollback(const char *fsname, char *snapnamebuf, int snapnamelen)
794 args = fnvlist_alloc();
795 err = lzc_ioctl(ZFS_IOC_ROLLBACK, fsname, args, &result);
797 if (err == 0 && snapnamebuf != NULL) {
798 const char *snapname = fnvlist_lookup_string(result, "target");
799 (void) strlcpy(snapnamebuf, snapname, snapnamelen);
807 * Roll back this filesystem or volume to the specified snapshot,
810 * Return 0 on success or an errno on failure.
813 lzc_rollback_to(const char *fsname, const char *snapname)
819 args = fnvlist_alloc();
820 fnvlist_add_string(args, "target", snapname);
821 err = lzc_ioctl(ZFS_IOC_ROLLBACK, fsname, args, &result);
830 * The bookmarks nvlist maps from name of the bookmark (e.g. "pool/fs#bmark") to
831 * the name of the snapshot (e.g. "pool/fs@snap"). All the bookmarks and
832 * snapshots must be in the same pool.
834 * The returned results nvlist will have an entry for each bookmark that failed.
835 * The value will be the (int32) error code.
837 * The return value will be 0 if all bookmarks were created, otherwise it will
838 * be the errno of a (undetermined) bookmarks that failed.
841 lzc_bookmark(nvlist_t *bookmarks, nvlist_t **errlist)
845 char pool[ZFS_MAX_DATASET_NAME_LEN];
847 /* determine the pool name */
848 elem = nvlist_next_nvpair(bookmarks, NULL);
851 (void) strlcpy(pool, nvpair_name(elem), sizeof (pool));
852 pool[strcspn(pool, "/#")] = '\0';
854 error = lzc_ioctl(ZFS_IOC_BOOKMARK, pool, bookmarks, errlist);
860 * Retrieve bookmarks.
862 * Retrieve the list of bookmarks for the given file system. The props
863 * parameter is an nvlist of property names (with no values) that will be
864 * returned for each bookmark.
866 * The following are valid properties on bookmarks, all of which are numbers
867 * (represented as uint64 in the nvlist)
869 * "guid" - globally unique identifier of the snapshot it refers to
870 * "createtxg" - txg when the snapshot it refers to was created
871 * "creation" - timestamp when the snapshot it refers to was created
873 * The format of the returned nvlist as follows:
874 * <short name of bookmark> -> {
875 * <name of property> -> {
881 lzc_get_bookmarks(const char *fsname, nvlist_t *props, nvlist_t **bmarks)
883 return (lzc_ioctl(ZFS_IOC_GET_BOOKMARKS, fsname, props, bmarks));
887 * Destroys bookmarks.
889 * The keys in the bmarks nvlist are the bookmarks to be destroyed.
890 * They must all be in the same pool. Bookmarks are specified as
893 * Bookmarks that do not exist will be silently ignored.
895 * The return value will be 0 if all bookmarks that existed were destroyed.
897 * Otherwise the return value will be the errno of a (undetermined) bookmark
898 * that failed, no bookmarks will be destroyed, and the errlist will have an
899 * entry for each bookmarks that failed. The value in the errlist will be
900 * the (int32) error code.
903 lzc_destroy_bookmarks(nvlist_t *bmarks, nvlist_t **errlist)
907 char pool[ZFS_MAX_DATASET_NAME_LEN];
909 /* determine the pool name */
910 elem = nvlist_next_nvpair(bmarks, NULL);
913 (void) strlcpy(pool, nvpair_name(elem), sizeof (pool));
914 pool[strcspn(pool, "/#")] = '\0';
916 error = lzc_ioctl(ZFS_IOC_DESTROY_BOOKMARKS, pool, bmarks, errlist);
922 * Executes a channel program.
924 * If this function returns 0 the channel program was successfully loaded and
925 * ran without failing. Note that individual commands the channel program ran
926 * may have failed and the channel program is responsible for reporting such
927 * errors through outnvl if they are important.
929 * This method may also return:
931 * EINVAL The program contains syntax errors, or an invalid memory or time
932 * limit was given. No part of the channel program was executed.
933 * If caused by syntax errors, 'outnvl' contains information about the
936 * EDOM The program was executed, but encountered a runtime error, such as
937 * calling a function with incorrect arguments, invoking the error()
938 * function directly, failing an assert() command, etc. Some portion
939 * of the channel program may have executed and committed changes.
940 * Information about the failure can be found in 'outnvl'.
942 * ENOMEM The program fully executed, but the output buffer was not large
943 * enough to store the returned value. No output is returned through
946 * ENOSPC The program was terminated because it exceeded its memory usage
947 * limit. Some portion of the channel program may have executed and
948 * committed changes to disk. No output is returned through 'outnvl'.
950 * ETIMEDOUT The program was terminated because it exceeded its Lua instruction
951 * limit. Some portion of the channel program may have executed and
952 * committed changes to disk. No output is returned through 'outnvl'.
955 lzc_channel_program(const char *pool, const char *program, uint64_t instrlimit,
956 uint64_t memlimit, nvlist_t *argnvl, nvlist_t **outnvl)
961 args = fnvlist_alloc();
962 fnvlist_add_string(args, ZCP_ARG_PROGRAM, program);
963 fnvlist_add_nvlist(args, ZCP_ARG_ARGLIST, argnvl);
964 fnvlist_add_uint64(args, ZCP_ARG_INSTRLIMIT, instrlimit);
965 fnvlist_add_uint64(args, ZCP_ARG_MEMLIMIT, memlimit);
966 error = lzc_ioctl(ZFS_IOC_CHANNEL_PROGRAM, pool, args, outnvl);