xref: /illumos-gate/usr/src/lib/libzfs_core/common/libzfs_core.h (revision 5f82aa32fbc5dc2c59bca6ff315f44a4c4c9ea86)
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 
35 #ifdef	__cplusplus
36 extern "C" {
37 #endif
38 
39 int libzfs_core_init(void);
40 void libzfs_core_fini(void);
41 
42 /*
43  * NB: this type should be kept binary compatible with dmu_objset_type_t.
44  */
45 enum lzc_dataset_type {
46 	LZC_DATSET_TYPE_ZFS = 2,
47 	LZC_DATSET_TYPE_ZVOL
48 };
49 
50 int lzc_snapshot(nvlist_t *, nvlist_t *, nvlist_t **);
51 int lzc_create(const char *, enum lzc_dataset_type, nvlist_t *);
52 int lzc_clone(const char *, const char *, nvlist_t *);
53 int lzc_promote(const char *, char *, int);
54 int lzc_destroy_snaps(nvlist_t *, boolean_t, nvlist_t **);
55 int lzc_bookmark(nvlist_t *, nvlist_t **);
56 int lzc_get_bookmarks(const char *, nvlist_t *, nvlist_t **);
57 int lzc_destroy_bookmarks(nvlist_t *, nvlist_t **);
58 
59 int lzc_snaprange_space(const char *, const char *, uint64_t *);
60 
61 int lzc_hold(nvlist_t *, int, nvlist_t **);
62 int lzc_release(nvlist_t *, nvlist_t **);
63 int lzc_get_holds(const char *, nvlist_t **);
64 
65 enum lzc_send_flags {
66 	LZC_SEND_FLAG_EMBED_DATA = 1 << 0,
67 	LZC_SEND_FLAG_LARGE_BLOCK = 1 << 1,
68 	LZC_SEND_FLAG_COMPRESS = 1 << 2
69 };
70 
71 int lzc_send(const char *, const char *, int, enum lzc_send_flags);
72 int lzc_send_resume(const char *, const char *, int,
73     enum lzc_send_flags, uint64_t, uint64_t);
74 int lzc_send_space(const char *, const char *, enum lzc_send_flags, uint64_t *);
75 
76 struct dmu_replay_record;
77 
78 int lzc_receive(const char *, nvlist_t *, const char *, boolean_t, int);
79 int lzc_receive_resumable(const char *, nvlist_t *, const char *,
80     boolean_t, int);
81 int lzc_receive_with_header(const char *, nvlist_t *, const char *, boolean_t,
82     boolean_t, int, const struct dmu_replay_record *);
83 
84 boolean_t lzc_exists(const char *);
85 
86 int lzc_rollback(const char *, char *, int);
87 int lzc_rollback_to(const char *, const char *);
88 
89 int lzc_channel_program(const char *, const char *, uint64_t, uint64_t,
90     nvlist_t *, nvlist_t **);
91 
92 #ifdef	__cplusplus
93 }
94 #endif
95 
96 #endif	/* _LIBZFS_CORE_H */
97