1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21 
22 /*
23  * Copyright (c) 2012, 2020 by Delphix. All rights reserved.
24  * Copyright (c) 2014 Integros [integros.com]
25  * Copyright 2017 RackTop Systems.
26  * Copyright (c) 2017 Datto Inc.
27  */
28 
29 #ifndef	_LIBZFS_CORE_H
30 #define	_LIBZFS_CORE_H
31 
32 #include <libnvpair.h>
33 #include <sys/param.h>
34 #include <sys/types.h>
35 #include <sys/fs/zfs.h>
36 
37 
38 #ifdef	__cplusplus
39 extern "C" {
40 #endif
41 
42 int libzfs_core_init(void);
43 void libzfs_core_fini(void);
44 
45 /*
46  * NB: this type should be kept binary compatible with dmu_objset_type_t.
47  */
48 enum lzc_dataset_type {
49 	LZC_DATSET_TYPE_ZFS = 2,
50 	LZC_DATSET_TYPE_ZVOL
51 };
52 
53 int lzc_remap(const char *fsname);
54 int lzc_snapshot(nvlist_t *, nvlist_t *, nvlist_t **);
55 int lzc_create(const char *, enum lzc_dataset_type, nvlist_t *, uint8_t *,
56     uint_t);
57 int lzc_clone(const char *, const char *, nvlist_t *);
58 int lzc_promote(const char *, char *, int);
59 int lzc_destroy_snaps(nvlist_t *, boolean_t, nvlist_t **);
60 int lzc_bookmark(nvlist_t *, nvlist_t **);
61 int lzc_get_bookmarks(const char *, nvlist_t *, nvlist_t **);
62 int lzc_destroy_bookmarks(nvlist_t *, nvlist_t **);
63 int lzc_initialize(const char *, pool_initialize_func_t, nvlist_t *,
64     nvlist_t **);
65 int lzc_trim(const char *, pool_trim_func_t, uint64_t, boolean_t,
66     nvlist_t *, nvlist_t **);
67 
68 int lzc_load_key(const char *, boolean_t, uint8_t *, uint_t);
69 int lzc_unload_key(const char *);
70 int lzc_change_key(const char *, uint64_t, nvlist_t *, uint8_t *, uint_t);
71 
72 int lzc_snaprange_space(const char *, const char *, uint64_t *);
73 
74 int lzc_hold(nvlist_t *, int, nvlist_t **);
75 int lzc_release(nvlist_t *, nvlist_t **);
76 int lzc_get_holds(const char *, nvlist_t **);
77 
78 enum lzc_send_flags {
79 	LZC_SEND_FLAG_EMBED_DATA = 1 << 0,
80 	LZC_SEND_FLAG_LARGE_BLOCK = 1 << 1,
81 	LZC_SEND_FLAG_COMPRESS = 1 << 2,
82 	LZC_SEND_FLAG_RAW = 1 << 3
83 };
84 
85 int lzc_send(const char *, const char *, int, enum lzc_send_flags);
86 int lzc_send_resume(const char *, const char *, int,
87     enum lzc_send_flags, uint64_t, uint64_t);
88 int lzc_send_space(const char *, const char *, enum lzc_send_flags, uint64_t *);
89 
90 struct dmu_replay_record;
91 
92 int lzc_receive(const char *, nvlist_t *, const char *, boolean_t,
93     boolean_t, int);
94 int lzc_receive_resumable(const char *, nvlist_t *, const char *,
95     boolean_t, boolean_t, int);
96 int lzc_receive_with_header(const char *, nvlist_t *, const char *, boolean_t,
97     boolean_t, boolean_t, int, const struct dmu_replay_record *);
98 int lzc_receive_with_cmdprops(const char *, nvlist_t *, nvlist_t *,
99     uint8_t *, uint_t, const char *, boolean_t, boolean_t, boolean_t, int,
100     const struct dmu_replay_record *, int, uint64_t *, uint64_t *,
101     uint64_t *, nvlist_t **);
102 
103 boolean_t lzc_exists(const char *);
104 
105 int lzc_rollback(const char *, char *, int);
106 int lzc_rollback_to(const char *, const char *);
107 
108 int lzc_sync(const char *, nvlist_t *, nvlist_t **);
109 
110 int lzc_rename(const char *, const char *);
111 int lzc_destroy(const char *);
112 
113 int lzc_channel_program(const char *, const char *, uint64_t,
114     uint64_t, nvlist_t *, nvlist_t **);
115 int lzc_channel_program_nosync(const char *, const char *, uint64_t,
116     uint64_t, nvlist_t *, nvlist_t **);
117 
118 int lzc_pool_checkpoint(const char *);
119 int lzc_pool_checkpoint_discard(const char *);
120 
121 int lzc_set_bootenv(const char *, const nvlist_t *);
122 int lzc_get_bootenv(const char *, nvlist_t **);
123 #ifdef	__cplusplus
124 }
125 #endif
126 
127 #endif	/* _LIBZFS_CORE_H */
128