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  * Copyright (c) 2010, Oracle and/or its affiliates. All rights reserved.
23  * Copyright (c) 2012, 2014 by Delphix. All rights reserved.
24  */
25 
26 #ifndef	_SYS_BPOBJ_H
27 #define	_SYS_BPOBJ_H
28 
29 #include <sys/dmu.h>
30 #include <sys/spa.h>
31 #include <sys/txg.h>
32 #include <sys/zio.h>
33 #include <sys/zfs_context.h>
34 
35 #ifdef	__cplusplus
36 extern "C" {
37 #endif
38 
39 typedef struct bpobj_phys {
40 	/*
41 	 * This is the bonus buffer for the dead lists.  The object's
42 	 * contents is an array of bpo_entries blkptr_t's, representing
43 	 * a total of bpo_bytes physical space.
44 	 */
45 	uint64_t	bpo_num_blkptrs;
46 	uint64_t	bpo_bytes;
47 	uint64_t	bpo_comp;
48 	uint64_t	bpo_uncomp;
49 	uint64_t	bpo_subobjs;
50 	uint64_t	bpo_num_subobjs;
51 } bpobj_phys_t;
52 
53 #define	BPOBJ_SIZE_V0	(2 * sizeof (uint64_t))
54 #define	BPOBJ_SIZE_V1	(4 * sizeof (uint64_t))
55 
56 typedef struct bpobj {
57 	kmutex_t	bpo_lock;
58 	objset_t	*bpo_os;
59 	uint64_t	bpo_object;
60 	int		bpo_epb;
61 	uint8_t		bpo_havecomp;
62 	uint8_t		bpo_havesubobj;
63 	bpobj_phys_t	*bpo_phys;
64 	dmu_buf_t	*bpo_dbuf;
65 	dmu_buf_t	*bpo_cached_dbuf;
66 } bpobj_t;
67 
68 typedef int bpobj_itor_t(void *arg, const blkptr_t *bp, dmu_tx_t *tx);
69 
70 uint64_t bpobj_alloc(objset_t *mos, int blocksize, dmu_tx_t *tx);
71 uint64_t bpobj_alloc_empty(objset_t *os, int blocksize, dmu_tx_t *tx);
72 void bpobj_free(objset_t *os, uint64_t obj, dmu_tx_t *tx);
73 void bpobj_decr_empty(objset_t *os, dmu_tx_t *tx);
74 
75 int bpobj_open(bpobj_t *bpo, objset_t *mos, uint64_t object);
76 void bpobj_close(bpobj_t *bpo);
77 
78 int bpobj_iterate(bpobj_t *bpo, bpobj_itor_t func, void *arg, dmu_tx_t *tx);
79 int bpobj_iterate_nofree(bpobj_t *bpo, bpobj_itor_t func, void *, dmu_tx_t *);
80 
81 void bpobj_enqueue_subobj(bpobj_t *bpo, uint64_t subobj, dmu_tx_t *tx);
82 void bpobj_enqueue(bpobj_t *bpo, const blkptr_t *bp, dmu_tx_t *tx);
83 
84 int bpobj_space(bpobj_t *bpo,
85     uint64_t *usedp, uint64_t *compp, uint64_t *uncompp);
86 int bpobj_space_range(bpobj_t *bpo, uint64_t mintxg, uint64_t maxtxg,
87     uint64_t *usedp, uint64_t *compp, uint64_t *uncompp);
88 
89 #ifdef	__cplusplus
90 }
91 #endif
92 
93 #endif /* _SYS_BPOBJ_H */
94