]>
Commit | Line | Data |
---|---|---|
a6255b7f DQ |
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) 2014 by Chunwei Chen. All rights reserved. | |
23 | * Copyright (c) 2016 by Delphix. All rights reserved. | |
24 | */ | |
25 | ||
26 | #ifndef _ABD_H | |
27 | #define _ABD_H | |
28 | ||
29 | #include <sys/isa_defs.h> | |
30 | #include <sys/int_types.h> | |
31 | #include <sys/debug.h> | |
32 | #include <sys/refcount.h> | |
33 | #ifdef _KERNEL | |
34 | #include <linux/mm.h> | |
b0be93e8 | 35 | #include <linux/bio.h> |
a6255b7f DQ |
36 | #include <sys/uio.h> |
37 | #endif | |
38 | ||
39 | #ifdef __cplusplus | |
40 | extern "C" { | |
41 | #endif | |
42 | ||
43 | typedef enum abd_flags { | |
44 | ABD_FLAG_LINEAR = 1 << 0, /* is buffer linear (or scattered)? */ | |
45 | ABD_FLAG_OWNER = 1 << 1, /* does it own its data buffers? */ | |
98295748 CC |
46 | ABD_FLAG_META = 1 << 2, /* does this represent FS metadata? */ |
47 | ABD_FLAG_MULTI_ZONE = 1 << 3, /* pages split over memory zones */ | |
48 | ABD_FLAG_MULTI_CHUNK = 1 << 4 /* pages split over multiple chunks */ | |
a6255b7f DQ |
49 | } abd_flags_t; |
50 | ||
51 | typedef struct abd { | |
52 | abd_flags_t abd_flags; | |
53 | uint_t abd_size; /* excludes scattered abd_offset */ | |
54 | struct abd *abd_parent; | |
55 | refcount_t abd_children; | |
56 | union { | |
57 | struct abd_scatter { | |
58 | uint_t abd_offset; | |
98295748 CC |
59 | uint_t abd_nents; |
60 | struct scatterlist *abd_sgl; | |
a6255b7f DQ |
61 | } abd_scatter; |
62 | struct abd_linear { | |
63 | void *abd_buf; | |
64 | } abd_linear; | |
65 | } abd_u; | |
66 | } abd_t; | |
67 | ||
68 | typedef int abd_iter_func_t(void *buf, size_t len, void *private); | |
69 | typedef int abd_iter_func2_t(void *bufa, void *bufb, size_t len, void *private); | |
70 | ||
71 | extern int zfs_abd_scatter_enabled; | |
72 | ||
73 | static inline boolean_t | |
74 | abd_is_linear(abd_t *abd) | |
75 | { | |
76 | return ((abd->abd_flags & ABD_FLAG_LINEAR) != 0); | |
77 | } | |
78 | ||
79 | /* | |
80 | * Allocations and deallocations | |
81 | */ | |
82 | ||
83 | abd_t *abd_alloc(size_t, boolean_t); | |
84 | abd_t *abd_alloc_linear(size_t, boolean_t); | |
85 | abd_t *abd_alloc_for_io(size_t, boolean_t); | |
86 | abd_t *abd_alloc_sametype(abd_t *, size_t); | |
87 | void abd_free(abd_t *); | |
88 | abd_t *abd_get_offset(abd_t *, size_t); | |
a206522c | 89 | abd_t *abd_get_offset_size(abd_t *, size_t, size_t); |
a6255b7f DQ |
90 | abd_t *abd_get_from_buf(void *, size_t); |
91 | void abd_put(abd_t *); | |
92 | ||
93 | /* | |
94 | * Conversion to and from a normal buffer | |
95 | */ | |
96 | ||
97 | void *abd_to_buf(abd_t *); | |
98 | void *abd_borrow_buf(abd_t *, size_t); | |
99 | void *abd_borrow_buf_copy(abd_t *, size_t); | |
100 | void abd_return_buf(abd_t *, void *, size_t); | |
101 | void abd_return_buf_copy(abd_t *, void *, size_t); | |
102 | void abd_take_ownership_of_buf(abd_t *, boolean_t); | |
103 | void abd_release_ownership_of_buf(abd_t *); | |
104 | ||
105 | /* | |
106 | * ABD operations | |
107 | */ | |
108 | ||
109 | int abd_iterate_func(abd_t *, size_t, size_t, abd_iter_func_t *, void *); | |
110 | int abd_iterate_func2(abd_t *, abd_t *, size_t, size_t, size_t, | |
111 | abd_iter_func2_t *, void *); | |
112 | void abd_copy_off(abd_t *, abd_t *, size_t, size_t, size_t); | |
113 | void abd_copy_from_buf_off(abd_t *, const void *, size_t, size_t); | |
114 | void abd_copy_to_buf_off(void *, abd_t *, size_t, size_t); | |
115 | int abd_cmp(abd_t *, abd_t *); | |
116 | int abd_cmp_buf_off(abd_t *, const void *, size_t, size_t); | |
117 | void abd_zero_off(abd_t *, size_t, size_t); | |
118 | ||
b0be93e8 IH |
119 | #if defined(_KERNEL) && defined(HAVE_SPL) |
120 | unsigned int abd_scatter_bio_map_off(struct bio *, abd_t *, unsigned int, | |
121 | size_t); | |
122 | unsigned long abd_nr_pages_off(abd_t *, unsigned int, size_t); | |
123 | #endif | |
124 | ||
a206522c GN |
125 | void abd_raidz_gen_iterate(abd_t **cabds, abd_t *dabd, |
126 | ssize_t csize, ssize_t dsize, const unsigned parity, | |
127 | void (*func_raidz_gen)(void **, const void *, size_t, size_t)); | |
128 | void abd_raidz_rec_iterate(abd_t **cabds, abd_t **tabds, | |
129 | ssize_t tsize, const unsigned parity, | |
130 | void (*func_raidz_rec)(void **t, const size_t tsize, void **c, | |
131 | const unsigned *mul), | |
132 | const unsigned *mul); | |
133 | ||
a6255b7f DQ |
134 | /* |
135 | * Wrappers for calls with offsets of 0 | |
136 | */ | |
137 | ||
138 | static inline void | |
139 | abd_copy(abd_t *dabd, abd_t *sabd, size_t size) | |
140 | { | |
141 | abd_copy_off(dabd, sabd, 0, 0, size); | |
142 | } | |
143 | ||
144 | static inline void | |
145 | abd_copy_from_buf(abd_t *abd, void *buf, size_t size) | |
146 | { | |
147 | abd_copy_from_buf_off(abd, buf, 0, size); | |
148 | } | |
149 | ||
150 | static inline void | |
151 | abd_copy_to_buf(void* buf, abd_t *abd, size_t size) | |
152 | { | |
153 | abd_copy_to_buf_off(buf, abd, 0, size); | |
154 | } | |
155 | ||
156 | static inline int | |
157 | abd_cmp_buf(abd_t *abd, void *buf, size_t size) | |
158 | { | |
159 | return (abd_cmp_buf_off(abd, buf, 0, size)); | |
160 | } | |
161 | ||
162 | static inline void | |
163 | abd_zero(abd_t *abd, size_t size) | |
164 | { | |
165 | abd_zero_off(abd, 0, size); | |
166 | } | |
167 | ||
168 | /* | |
169 | * Module lifecycle | |
170 | */ | |
171 | ||
172 | void abd_init(void); | |
173 | void abd_fini(void); | |
174 | ||
175 | #ifdef __cplusplus | |
176 | } | |
177 | #endif | |
178 | ||
179 | #endif /* _ABD_H */ |