xref: /freebsd/sys/contrib/openzfs/include/sys/dmu_recv.h (revision 2a58b312b62f908ec92311d1bd8536dbaeb8e55b)
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) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
24  * Copyright (c) 2012, 2020 by Delphix. All rights reserved.
25  * Copyright 2011 Nexenta Systems, Inc. All rights reserved.
26  * Copyright (c) 2013, Joyent, Inc. All rights reserved.
27  * Copyright (c) 2019 Datto Inc.
28  */
29 
30 #ifndef _DMU_RECV_H
31 #define	_DMU_RECV_H
32 
33 #include <sys/inttypes.h>
34 #include <sys/dsl_bookmark.h>
35 #include <sys/dsl_dataset.h>
36 #include <sys/spa.h>
37 #include <sys/objlist.h>
38 
39 extern const char *const recv_clone_name;
40 
41 typedef struct dmu_recv_cookie {
42 	struct dsl_dataset *drc_ds;
43 	struct dmu_replay_record *drc_drr_begin;
44 	struct drr_begin *drc_drrb;
45 	const char *drc_tofs;
46 	const char *drc_tosnap;
47 	boolean_t drc_newfs;
48 	boolean_t drc_byteswap;
49 	uint64_t drc_featureflags;
50 	boolean_t drc_force;
51 	boolean_t drc_heal;
52 	boolean_t drc_resumable;
53 	boolean_t drc_should_save;
54 	boolean_t drc_raw;
55 	boolean_t drc_clone;
56 	boolean_t drc_spill;
57 	nvlist_t *drc_keynvl;
58 	uint64_t drc_fromsnapobj;
59 	uint64_t drc_ivset_guid;
60 	void *drc_owner;
61 	cred_t *drc_cred;
62 	proc_t *drc_proc;
63 	nvlist_t *drc_begin_nvl;
64 
65 	objset_t *drc_os;
66 	zfs_file_t *drc_fp; /* The file to read the stream from */
67 	uint64_t drc_voff; /* The current offset in the stream */
68 	uint64_t drc_bytes_read;
69 	/*
70 	 * A record that has had its payload read in, but hasn't yet been handed
71 	 * off to the worker thread.
72 	 */
73 	struct receive_record_arg *drc_rrd;
74 	/* A record that has had its header read in, but not its payload. */
75 	struct receive_record_arg *drc_next_rrd;
76 	zio_cksum_t drc_cksum;
77 	zio_cksum_t drc_prev_cksum;
78 	/* Sorted list of objects not to issue prefetches for. */
79 	objlist_t *drc_ignore_objlist;
80 } dmu_recv_cookie_t;
81 
82 int dmu_recv_begin(const char *, const char *, dmu_replay_record_t *,
83     boolean_t, boolean_t, boolean_t, nvlist_t *, nvlist_t *, const char *,
84     dmu_recv_cookie_t *, zfs_file_t *, offset_t *);
85 int dmu_recv_stream(dmu_recv_cookie_t *, offset_t *);
86 int dmu_recv_end(dmu_recv_cookie_t *, void *);
87 boolean_t dmu_objset_is_receiving(objset_t *);
88 
89 #endif /* _DMU_RECV_H */
90