xref: /illumos-gate/usr/src/lib/libzfs_core/common/libzfs_core.h (revision 566b4223c74de6cad48ddbedf35a12d6a511c8c5)
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, 2016 by Delphix. All rights reserved.
24  * Copyright (c) 2014 Integros [integros.com]
25  * Copyright 2017 RackTop Systems.
26  */
27 
28 #ifndef	_LIBZFS_CORE_H
29 #define	_LIBZFS_CORE_H
30 
31 #include <libnvpair.h>
32 #include <sys/param.h>
33 #include <sys/types.h>
34 #include <sys/fs/zfs.h>
35 
36 
37 #ifdef	__cplusplus
38 extern "C" {
39 #endif
40 
41 int libzfs_core_init(void);
42 void libzfs_core_fini(void);
43 
44 /*
45  * NB: this type should be kept binary compatible with dmu_objset_type_t.
46  */
47 enum lzc_dataset_type {
48 	LZC_DATSET_TYPE_ZFS = 2,
49 	LZC_DATSET_TYPE_ZVOL
50 };
51 
52 int lzc_remap(const char *fsname);
53 int lzc_snapshot(nvlist_t *, nvlist_t *, nvlist_t **);
54 int lzc_create(const char *, enum lzc_dataset_type, nvlist_t *);
55 int lzc_clone(const char *, const char *, nvlist_t *);
56 int lzc_promote(const char *, char *, int);
57 int lzc_destroy_snaps(nvlist_t *, boolean_t, nvlist_t **);
58 int lzc_bookmark(nvlist_t *, nvlist_t **);
59 int lzc_get_bookmarks(const char *, nvlist_t *, nvlist_t **);
60 int lzc_destroy_bookmarks(nvlist_t *, nvlist_t **);
61 int lzc_initialize(const char *, pool_initialize_func_t, nvlist_t *,
62     nvlist_t **);
63 
64 int lzc_snaprange_space(const char *, const char *, uint64_t *);
65 
66 int lzc_hold(nvlist_t *, int, nvlist_t **);
67 int lzc_release(nvlist_t *, nvlist_t **);
68 int lzc_get_holds(const char *, nvlist_t **);
69 
70 enum lzc_send_flags {
71 	LZC_SEND_FLAG_EMBED_DATA = 1 << 0,
72 	LZC_SEND_FLAG_LARGE_BLOCK = 1 << 1,
73 	LZC_SEND_FLAG_COMPRESS = 1 << 2
74 };
75 
76 int lzc_send(const char *, const char *, int, enum lzc_send_flags);
77 int lzc_send_resume(const char *, const char *, int,
78     enum lzc_send_flags, uint64_t, uint64_t);
79 int lzc_send_space(const char *, const char *, enum lzc_send_flags, uint64_t *);
80 
81 struct dmu_replay_record;
82 
83 int lzc_receive(const char *, nvlist_t *, const char *, boolean_t, int);
84 int lzc_receive_resumable(const char *, nvlist_t *, const char *,
85     boolean_t, int);
86 int lzc_receive_with_header(const char *, nvlist_t *, const char *, boolean_t,
87     boolean_t, int, const struct dmu_replay_record *);
88 
89 boolean_t lzc_exists(const char *);
90 
91 int lzc_rollback(const char *, char *, int);
92 int lzc_rollback_to(const char *, const char *);
93 
94 int lzc_channel_program(const char *, const char *, uint64_t,
95     uint64_t, nvlist_t *, nvlist_t **);
96 int lzc_channel_program_nosync(const char *, const char *, uint64_t,
97     uint64_t, nvlist_t *, nvlist_t **);
98 
99 int lzc_pool_checkpoint(const char *);
100 int lzc_pool_checkpoint_discard(const char *);
101 
102 #ifdef	__cplusplus
103 }
104 #endif
105 
106 #endif	/* _LIBZFS_CORE_H */
107