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) 2017 Datto Inc.
25 * Copyright 2017 RackTop Systems.
26 * Copyright (c) 2017 Open-E, Inc. All Rights Reserved.
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#ifdef	__cplusplus
38extern "C" {
39#endif
40
41int libzfs_core_init(void);
42void libzfs_core_fini(void);
43
44/*
45 * NB: this type should be kept binary compatible with dmu_objset_type_t.
46 */
47enum lzc_dataset_type {
48	LZC_DATSET_TYPE_ZFS = 2,
49	LZC_DATSET_TYPE_ZVOL
50};
51
52int lzc_snapshot(nvlist_t *, nvlist_t *, nvlist_t **);
53int lzc_create(const char *, enum lzc_dataset_type, nvlist_t *, uint8_t *,
54    uint_t);
55int lzc_clone(const char *, const char *, nvlist_t *);
56int lzc_promote(const char *, char *, int);
57int lzc_destroy_snaps(nvlist_t *, boolean_t, nvlist_t **);
58int lzc_bookmark(nvlist_t *, nvlist_t **);
59int lzc_get_bookmarks(const char *, nvlist_t *, nvlist_t **);
60int lzc_get_bookmark_props(const char *, nvlist_t **);
61int lzc_destroy_bookmarks(nvlist_t *, nvlist_t **);
62int lzc_load_key(const char *, boolean_t, uint8_t *, uint_t);
63int lzc_unload_key(const char *);
64int lzc_change_key(const char *, uint64_t, nvlist_t *, uint8_t *, uint_t);
65int lzc_initialize(const char *, pool_initialize_func_t, nvlist_t *,
66    nvlist_t **);
67int lzc_trim(const char *, pool_trim_func_t, uint64_t, boolean_t,
68    nvlist_t *, nvlist_t **);
69int lzc_redact(const char *, const char *, nvlist_t *);
70
71int lzc_snaprange_space(const char *, const char *, uint64_t *);
72
73int lzc_hold(nvlist_t *, int, nvlist_t **);
74int lzc_release(nvlist_t *, nvlist_t **);
75int lzc_get_holds(const char *, nvlist_t **);
76
77enum lzc_send_flags {
78	LZC_SEND_FLAG_EMBED_DATA = 1 << 0,
79	LZC_SEND_FLAG_LARGE_BLOCK = 1 << 1,
80	LZC_SEND_FLAG_COMPRESS = 1 << 2,
81	LZC_SEND_FLAG_RAW = 1 << 3,
82	LZC_SEND_FLAG_SAVED = 1 << 4,
83};
84
85int lzc_send(const char *, const char *, int, enum lzc_send_flags);
86int lzc_send_resume(const char *, const char *, int,
87    enum lzc_send_flags, uint64_t, uint64_t);
88int lzc_send_space(const char *, const char *, enum lzc_send_flags, uint64_t *);
89
90struct dmu_replay_record;
91
92int lzc_send_redacted(const char *, const char *, int, enum lzc_send_flags,
93    const char *);
94int lzc_send_resume_redacted(const char *, const char *, int,
95    enum lzc_send_flags, uint64_t, uint64_t, const char *);
96int lzc_receive(const char *, nvlist_t *, const char *, boolean_t, boolean_t,
97    int);
98int lzc_receive_resumable(const char *, nvlist_t *, const char *, boolean_t,
99    boolean_t, int);
100int lzc_receive_with_header(const char *, nvlist_t *, const char *, boolean_t,
101    boolean_t, boolean_t, int, const struct dmu_replay_record *);
102int lzc_receive_one(const char *, nvlist_t *, const char *, boolean_t,
103    boolean_t, boolean_t, int, const struct dmu_replay_record *, int,
104    uint64_t *, uint64_t *, uint64_t *, nvlist_t **);
105int lzc_receive_with_cmdprops(const char *, nvlist_t *, nvlist_t *,
106    uint8_t *, uint_t, const char *, boolean_t, boolean_t, boolean_t, int,
107    const struct dmu_replay_record *, int, uint64_t *, uint64_t *,
108    uint64_t *, nvlist_t **);
109int lzc_send_space(const char *, const char *, enum lzc_send_flags, uint64_t *);
110int lzc_send_space_resume_redacted(const char *, const char *,
111    enum lzc_send_flags, uint64_t, uint64_t, uint64_t, const char *,
112    int, uint64_t *);
113uint64_t lzc_send_progress(int);
114
115boolean_t lzc_exists(const char *);
116
117int lzc_rollback(const char *, char *, int);
118int lzc_rollback_to(const char *, const char *);
119
120int lzc_rename(const char *, const char *);
121int lzc_destroy(const char *);
122
123int lzc_channel_program(const char *, const char *, uint64_t,
124    uint64_t, nvlist_t *, nvlist_t **);
125int lzc_channel_program_nosync(const char *, const char *, uint64_t,
126    uint64_t, nvlist_t *, nvlist_t **);
127
128int lzc_sync(const char *, nvlist_t *, nvlist_t **);
129int lzc_reopen(const char *, boolean_t);
130
131int lzc_pool_checkpoint(const char *);
132int lzc_pool_checkpoint_discard(const char *);
133
134int lzc_wait(const char *, zpool_wait_activity_t, boolean_t *);
135int lzc_wait_tag(const char *, zpool_wait_activity_t, uint64_t, boolean_t *);
136int lzc_wait_fs(const char *, zfs_wait_activity_t, boolean_t *);
137
138int lzc_set_bootenv(const char *, const nvlist_t *);
139int lzc_get_bootenv(const char *, nvlist_t **);
140#ifdef	__cplusplus
141}
142#endif
143
144#endif	/* _LIBZFS_CORE_H */
145