xref: /freebsd/sys/contrib/openzfs/include/libzfs_core.h (revision 59c8e88e72633afbc47a4ace0d2170d00d51f7dc)
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 2017 RackTop Systems.
25  * Copyright (c) 2017 Open-E, Inc. All Rights Reserved.
26  * Copyright (c) 2019 Datto Inc.
27  */
28 
29 #ifndef	_LIBZFS_CORE_H
30 #define	_LIBZFS_CORE_H extern __attribute__((visibility("default")))
31 
32 #include <libnvpair.h>
33 #include <sys/param.h>
34 #include <sys/types.h>
35 #include <sys/fs/zfs.h>
36 
37 #ifdef	__cplusplus
38 extern "C" {
39 #endif
40 
41 _LIBZFS_CORE_H int libzfs_core_init(void);
42 _LIBZFS_CORE_H void libzfs_core_fini(void);
43 
44 struct zfs_cmd;
45 _LIBZFS_CORE_H int lzc_ioctl_fd(int, unsigned long, struct zfs_cmd *);
46 
47 /*
48  * NB: this type should be kept binary-compatible with dmu_objset_type_t.
49  */
50 enum lzc_dataset_type {
51 	LZC_DATSET_TYPE_ZFS = 2,
52 	LZC_DATSET_TYPE_ZVOL
53 };
54 
55 _LIBZFS_CORE_H int lzc_snapshot(nvlist_t *, nvlist_t *, nvlist_t **);
56 _LIBZFS_CORE_H int lzc_create(const char *, enum lzc_dataset_type, nvlist_t *,
57     uint8_t *, uint_t);
58 _LIBZFS_CORE_H int lzc_clone(const char *, const char *, nvlist_t *);
59 _LIBZFS_CORE_H int lzc_promote(const char *, char *, int);
60 _LIBZFS_CORE_H int lzc_destroy_snaps(nvlist_t *, boolean_t, nvlist_t **);
61 _LIBZFS_CORE_H int lzc_bookmark(nvlist_t *, nvlist_t **);
62 _LIBZFS_CORE_H int lzc_get_bookmarks(const char *, nvlist_t *, nvlist_t **);
63 _LIBZFS_CORE_H int lzc_get_bookmark_props(const char *, nvlist_t **);
64 _LIBZFS_CORE_H int lzc_destroy_bookmarks(nvlist_t *, nvlist_t **);
65 _LIBZFS_CORE_H int lzc_load_key(const char *, boolean_t, uint8_t *, uint_t);
66 _LIBZFS_CORE_H int lzc_unload_key(const char *);
67 _LIBZFS_CORE_H int lzc_change_key(const char *, uint64_t, nvlist_t *, uint8_t *,
68     uint_t);
69 _LIBZFS_CORE_H int lzc_initialize(const char *, pool_initialize_func_t,
70     nvlist_t *, nvlist_t **);
71 _LIBZFS_CORE_H int lzc_trim(const char *, pool_trim_func_t, uint64_t, boolean_t,
72     nvlist_t *, nvlist_t **);
73 _LIBZFS_CORE_H int lzc_redact(const char *, const char *, nvlist_t *);
74 
75 _LIBZFS_CORE_H int lzc_snaprange_space(const char *, const char *, uint64_t *);
76 
77 _LIBZFS_CORE_H int lzc_hold(nvlist_t *, int, nvlist_t **);
78 _LIBZFS_CORE_H int lzc_release(nvlist_t *, nvlist_t **);
79 _LIBZFS_CORE_H int lzc_get_holds(const char *, nvlist_t **);
80 
81 enum lzc_send_flags {
82 	LZC_SEND_FLAG_EMBED_DATA = 1 << 0,
83 	LZC_SEND_FLAG_LARGE_BLOCK = 1 << 1,
84 	LZC_SEND_FLAG_COMPRESS = 1 << 2,
85 	LZC_SEND_FLAG_RAW = 1 << 3,
86 	LZC_SEND_FLAG_SAVED = 1 << 4,
87 };
88 
89 _LIBZFS_CORE_H int lzc_send_wrapper(int (*)(int, void *), int, void *);
90 _LIBZFS_CORE_H int lzc_send(const char *, const char *, int,
91     enum lzc_send_flags);
92 _LIBZFS_CORE_H int lzc_send_resume(const char *, const char *, int,
93     enum lzc_send_flags, uint64_t, uint64_t);
94 _LIBZFS_CORE_H int lzc_send_space(const char *, const char *,
95     enum lzc_send_flags, uint64_t *);
96 
97 struct dmu_replay_record;
98 
99 _LIBZFS_CORE_H int lzc_send_redacted(const char *, const char *, int,
100     enum lzc_send_flags, const char *);
101 _LIBZFS_CORE_H int lzc_send_resume_redacted(const char *, const char *, int,
102     enum lzc_send_flags, uint64_t, uint64_t, const char *);
103 _LIBZFS_CORE_H int lzc_receive(const char *, nvlist_t *, const char *,
104     boolean_t, boolean_t, int);
105 _LIBZFS_CORE_H int lzc_receive_resumable(const char *, nvlist_t *, const char *,
106     boolean_t, boolean_t, int);
107 _LIBZFS_CORE_H int lzc_receive_with_header(const char *, nvlist_t *,
108     const char *, boolean_t, boolean_t, boolean_t, int,
109     const struct dmu_replay_record *);
110 _LIBZFS_CORE_H int lzc_receive_one(const char *, nvlist_t *, const char *,
111     boolean_t, boolean_t, boolean_t, int, const struct dmu_replay_record *, int,
112     uint64_t *, uint64_t *, uint64_t *, nvlist_t **);
113 _LIBZFS_CORE_H int lzc_receive_with_cmdprops(const char *, nvlist_t *,
114     nvlist_t *, uint8_t *, uint_t, const char *, boolean_t, boolean_t,
115     boolean_t, int, const struct dmu_replay_record *, int, uint64_t *,
116     uint64_t *, uint64_t *, nvlist_t **);
117 _LIBZFS_CORE_H int lzc_receive_with_heal(const char *, nvlist_t *, nvlist_t *,
118     uint8_t *, uint_t, const char *, boolean_t, boolean_t, boolean_t, boolean_t,
119     int, const struct dmu_replay_record *, int, uint64_t *, uint64_t *,
120     uint64_t *, nvlist_t **);
121 _LIBZFS_CORE_H int lzc_send_space(const char *, const char *,
122     enum lzc_send_flags, uint64_t *);
123 _LIBZFS_CORE_H int lzc_send_space_resume_redacted(const char *, const char *,
124     enum lzc_send_flags, uint64_t, uint64_t, uint64_t, const char *,
125     int, uint64_t *);
126 _LIBZFS_CORE_H uint64_t lzc_send_progress(int);
127 
128 _LIBZFS_CORE_H boolean_t lzc_exists(const char *);
129 
130 _LIBZFS_CORE_H int lzc_rollback(const char *, char *, int);
131 _LIBZFS_CORE_H int lzc_rollback_to(const char *, const char *);
132 
133 _LIBZFS_CORE_H int lzc_rename(const char *, const char *);
134 _LIBZFS_CORE_H int lzc_destroy(const char *);
135 
136 _LIBZFS_CORE_H int lzc_channel_program(const char *, const char *, uint64_t,
137     uint64_t, nvlist_t *, nvlist_t **);
138 _LIBZFS_CORE_H int lzc_channel_program_nosync(const char *, const char *,
139     uint64_t, uint64_t, nvlist_t *, nvlist_t **);
140 
141 _LIBZFS_CORE_H int lzc_sync(const char *, nvlist_t *, nvlist_t **);
142 _LIBZFS_CORE_H int lzc_reopen(const char *, boolean_t);
143 
144 _LIBZFS_CORE_H int lzc_pool_checkpoint(const char *);
145 _LIBZFS_CORE_H int lzc_pool_checkpoint_discard(const char *);
146 
147 _LIBZFS_CORE_H int lzc_wait(const char *, zpool_wait_activity_t, boolean_t *);
148 _LIBZFS_CORE_H int lzc_wait_tag(const char *, zpool_wait_activity_t, uint64_t,
149     boolean_t *);
150 _LIBZFS_CORE_H int lzc_wait_fs(const char *, zfs_wait_activity_t, boolean_t *);
151 
152 _LIBZFS_CORE_H int lzc_set_bootenv(const char *, const nvlist_t *);
153 _LIBZFS_CORE_H int lzc_get_bootenv(const char *, nvlist_t **);
154 
155 _LIBZFS_CORE_H int lzc_get_vdev_prop(const char *, nvlist_t *, nvlist_t **);
156 _LIBZFS_CORE_H int lzc_set_vdev_prop(const char *, nvlist_t *, nvlist_t **);
157 
158 _LIBZFS_CORE_H int lzc_scrub(zfs_ioc_t, const char *, nvlist_t *, nvlist_t **);
159 
160 #ifdef	__cplusplus
161 }
162 #endif
163 
164 #endif	/* _LIBZFS_CORE_H */
165