]>
Commit | Line | Data |
---|---|---|
7cc01581 TH |
1 | /* |
2 | * Block data types and constants. Directly include this file only to | |
3 | * break include dependency loop. | |
4 | */ | |
5 | #ifndef __LINUX_BLK_TYPES_H | |
6 | #define __LINUX_BLK_TYPES_H | |
7 | ||
7cc01581 | 8 | #include <linux/types.h> |
0781e79e | 9 | #include <linux/bvec.h> |
7cc01581 TH |
10 | |
11 | struct bio_set; | |
12 | struct bio; | |
13 | struct bio_integrity_payload; | |
14 | struct page; | |
15 | struct block_device; | |
852c788f TH |
16 | struct io_context; |
17 | struct cgroup_subsys_state; | |
4246a0b6 | 18 | typedef void (bio_end_io_t) (struct bio *); |
7cc01581 | 19 | |
b9147dd1 SL |
20 | struct blk_issue_stat { |
21 | u64 stat; | |
22 | }; | |
23 | ||
7cc01581 TH |
24 | /* |
25 | * main unit of I/O for the block layer and lower layers (ie drivers and | |
26 | * stacking drivers) | |
27 | */ | |
28 | struct bio { | |
7cc01581 TH |
29 | struct bio *bi_next; /* request queue link */ |
30 | struct block_device *bi_bdev; | |
2c68f6dc | 31 | int bi_error; |
1eff9d32 JA |
32 | unsigned int bi_opf; /* bottom bits req flags, |
33 | * top bits REQ_OP. Use | |
34 | * accessors. | |
4e1b2d52 | 35 | */ |
dbde775c | 36 | unsigned short bi_flags; /* status, etc and bvec pool number */ |
43b62ce3 | 37 | unsigned short bi_ioprio; |
7cc01581 | 38 | |
4f024f37 | 39 | struct bvec_iter bi_iter; |
7cc01581 TH |
40 | |
41 | /* Number of segments in this BIO after | |
42 | * physical address coalescing is performed. | |
43 | */ | |
44 | unsigned int bi_phys_segments; | |
45 | ||
7cc01581 TH |
46 | /* |
47 | * To keep track of the max segment size, we account for the | |
48 | * sizes of the first and last mergeable segments in this bio. | |
49 | */ | |
50 | unsigned int bi_seg_front_size; | |
51 | unsigned int bi_seg_back_size; | |
52 | ||
c4cf5261 | 53 | atomic_t __bi_remaining; |
196d38bc | 54 | |
7cc01581 TH |
55 | bio_end_io_t *bi_end_io; |
56 | ||
57 | void *bi_private; | |
852c788f TH |
58 | #ifdef CONFIG_BLK_CGROUP |
59 | /* | |
60 | * Optional ioc and css associated with this bio. Put on bio | |
61 | * release. Read comment on top of bio_associate_current(). | |
62 | */ | |
63 | struct io_context *bi_ioc; | |
64 | struct cgroup_subsys_state *bi_css; | |
9e234eea SL |
65 | #ifdef CONFIG_BLK_DEV_THROTTLING_LOW |
66 | void *bi_cg_private; | |
b9147dd1 | 67 | struct blk_issue_stat bi_issue_stat; |
9e234eea | 68 | #endif |
852c788f | 69 | #endif |
180b2f95 | 70 | union { |
7cc01581 | 71 | #if defined(CONFIG_BLK_DEV_INTEGRITY) |
180b2f95 | 72 | struct bio_integrity_payload *bi_integrity; /* data integrity */ |
7cc01581 | 73 | #endif |
180b2f95 | 74 | }; |
7cc01581 | 75 | |
4f024f37 KO |
76 | unsigned short bi_vcnt; /* how many bio_vec's */ |
77 | ||
f44b48c7 KO |
78 | /* |
79 | * Everything starting with bi_max_vecs will be preserved by bio_reset() | |
80 | */ | |
81 | ||
4f024f37 | 82 | unsigned short bi_max_vecs; /* max bvl_vecs we can hold */ |
f44b48c7 | 83 | |
dac56212 | 84 | atomic_t __bi_cnt; /* pin count */ |
f44b48c7 KO |
85 | |
86 | struct bio_vec *bi_io_vec; /* the actual vec list */ | |
87 | ||
395c72a7 KO |
88 | struct bio_set *bi_pool; |
89 | ||
7cc01581 TH |
90 | /* |
91 | * We can inline a number of vecs at the end of the bio, to avoid | |
92 | * double allocations for a small number of bio_vecs. This member | |
93 | * MUST obviously be kept at the very end of the bio. | |
94 | */ | |
95 | struct bio_vec bi_inline_vecs[0]; | |
96 | }; | |
97 | ||
f44b48c7 KO |
98 | #define BIO_RESET_BYTES offsetof(struct bio, bi_max_vecs) |
99 | ||
7cc01581 TH |
100 | /* |
101 | * bio flags | |
102 | */ | |
b2dbe0a6 JA |
103 | #define BIO_SEG_VALID 1 /* bi_phys_segments valid */ |
104 | #define BIO_CLONED 2 /* doesn't own data */ | |
105 | #define BIO_BOUNCED 3 /* bio is a bounce bio */ | |
106 | #define BIO_USER_MAPPED 4 /* contains user pages */ | |
107 | #define BIO_NULL_MAPPED 5 /* contains invalid user pages */ | |
108 | #define BIO_QUIET 6 /* Make BIO Quiet */ | |
a3ad0a9d JK |
109 | #define BIO_CHAIN 7 /* chained bio, ->bi_remaining in effect */ |
110 | #define BIO_REFFED 8 /* bio has elevated ->bi_cnt */ | |
8d2bbd4c CH |
111 | #define BIO_THROTTLED 9 /* This bio has already been subjected to |
112 | * throttling rules. Don't do it again. */ | |
fbbaf700 N |
113 | #define BIO_TRACE_COMPLETION 10 /* bio_endio() should trace the final completion |
114 | * of this bio. */ | |
dbde775c | 115 | /* See BVEC_POOL_OFFSET below before adding new flags */ |
f44b48c7 | 116 | |
7cc01581 | 117 | /* |
ed996a52 CH |
118 | * We support 6 different bvec pools, the last one is magic in that it |
119 | * is backed by a mempool. | |
7cc01581 | 120 | */ |
ed996a52 CH |
121 | #define BVEC_POOL_NR 6 |
122 | #define BVEC_POOL_MAX (BVEC_POOL_NR - 1) | |
123 | ||
124 | /* | |
dbde775c | 125 | * Top 3 bits of bio flags indicate the pool the bvecs came from. We add |
ed996a52 CH |
126 | * 1 to the actual index so that 0 indicates that there are no bvecs to be |
127 | * freed. | |
128 | */ | |
dbde775c | 129 | #define BVEC_POOL_BITS (3) |
c0acf12a | 130 | #define BVEC_POOL_OFFSET (16 - BVEC_POOL_BITS) |
ed996a52 | 131 | #define BVEC_POOL_IDX(bio) ((bio)->bi_flags >> BVEC_POOL_OFFSET) |
dbde775c N |
132 | #if (1<< BVEC_POOL_BITS) < (BVEC_POOL_NR+1) |
133 | # error "BVEC_POOL_BITS is too small" | |
134 | #endif | |
135 | ||
136 | /* | |
137 | * Flags starting here get preserved by bio_reset() - this includes | |
138 | * only BVEC_POOL_IDX() | |
139 | */ | |
140 | #define BIO_RESET_BITS BVEC_POOL_OFFSET | |
7cc01581 TH |
141 | |
142 | /* | |
ef295ecf CH |
143 | * Operations and flags common to the bio and request structures. |
144 | * We use 8 bits for encoding the operation, and the remaining 24 for flags. | |
87374179 CH |
145 | * |
146 | * The least significant bit of the operation number indicates the data | |
147 | * transfer direction: | |
148 | * | |
149 | * - if the least significant bit is set transfers are TO the device | |
150 | * - if the least significant bit is not set transfers are FROM the device | |
151 | * | |
152 | * If a operation does not transfer data the least significant bit has no | |
153 | * meaning. | |
7cc01581 | 154 | */ |
ef295ecf CH |
155 | #define REQ_OP_BITS 8 |
156 | #define REQ_OP_MASK ((1 << REQ_OP_BITS) - 1) | |
157 | #define REQ_FLAG_BITS 24 | |
158 | ||
159 | enum req_opf { | |
87374179 CH |
160 | /* read sectors from the device */ |
161 | REQ_OP_READ = 0, | |
162 | /* write sectors to the device */ | |
163 | REQ_OP_WRITE = 1, | |
164 | /* flush the volatile write cache */ | |
165 | REQ_OP_FLUSH = 2, | |
166 | /* discard sectors */ | |
167 | REQ_OP_DISCARD = 3, | |
168 | /* get zone information */ | |
169 | REQ_OP_ZONE_REPORT = 4, | |
170 | /* securely erase sectors */ | |
171 | REQ_OP_SECURE_ERASE = 5, | |
172 | /* seset a zone write pointer */ | |
173 | REQ_OP_ZONE_RESET = 6, | |
174 | /* write the same sector many times */ | |
175 | REQ_OP_WRITE_SAME = 7, | |
a6f0788e | 176 | /* write the zero filled sector many times */ |
1d62ac13 | 177 | REQ_OP_WRITE_ZEROES = 9, |
ef295ecf | 178 | |
aebf526b CH |
179 | /* SCSI passthrough using struct scsi_request */ |
180 | REQ_OP_SCSI_IN = 32, | |
181 | REQ_OP_SCSI_OUT = 33, | |
182 | /* Driver private requests */ | |
183 | REQ_OP_DRV_IN = 34, | |
184 | REQ_OP_DRV_OUT = 35, | |
185 | ||
ef295ecf CH |
186 | REQ_OP_LAST, |
187 | }; | |
188 | ||
189 | enum req_flag_bits { | |
190 | __REQ_FAILFAST_DEV = /* no driver retries of device errors */ | |
191 | REQ_OP_BITS, | |
7cc01581 TH |
192 | __REQ_FAILFAST_TRANSPORT, /* no driver retries of transport errors */ |
193 | __REQ_FAILFAST_DRIVER, /* no driver retries of driver errors */ | |
7cc01581 TH |
194 | __REQ_SYNC, /* request is sync (sync write or read) */ |
195 | __REQ_META, /* metadata io request */ | |
65299a3b | 196 | __REQ_PRIO, /* boost priority in cfq */ |
bd1c1c21 | 197 | __REQ_NOMERGE, /* don't touch this for merging */ |
a2b80967 | 198 | __REQ_IDLE, /* anticipate more IO after this one */ |
180b2f95 | 199 | __REQ_INTEGRITY, /* I/O includes block integrity payload */ |
8e4bf844 | 200 | __REQ_FUA, /* forced unit access */ |
28a8f0d3 | 201 | __REQ_PREFLUSH, /* request for cache flush */ |
188bd2b1 | 202 | __REQ_RAHEAD, /* read ahead, can fail anytime */ |
1d796d6a | 203 | __REQ_BACKGROUND, /* background IO */ |
d928be9f CH |
204 | |
205 | /* command specific flags for REQ_OP_WRITE_ZEROES: */ | |
206 | __REQ_NOUNMAP, /* do not free blocks when zeroing */ | |
207 | ||
7cc01581 TH |
208 | __REQ_NR_BITS, /* stops here */ |
209 | }; | |
210 | ||
5953316d JA |
211 | #define REQ_FAILFAST_DEV (1ULL << __REQ_FAILFAST_DEV) |
212 | #define REQ_FAILFAST_TRANSPORT (1ULL << __REQ_FAILFAST_TRANSPORT) | |
213 | #define REQ_FAILFAST_DRIVER (1ULL << __REQ_FAILFAST_DRIVER) | |
214 | #define REQ_SYNC (1ULL << __REQ_SYNC) | |
215 | #define REQ_META (1ULL << __REQ_META) | |
216 | #define REQ_PRIO (1ULL << __REQ_PRIO) | |
ef295ecf | 217 | #define REQ_NOMERGE (1ULL << __REQ_NOMERGE) |
a2b80967 | 218 | #define REQ_IDLE (1ULL << __REQ_IDLE) |
180b2f95 | 219 | #define REQ_INTEGRITY (1ULL << __REQ_INTEGRITY) |
ef295ecf CH |
220 | #define REQ_FUA (1ULL << __REQ_FUA) |
221 | #define REQ_PREFLUSH (1ULL << __REQ_PREFLUSH) | |
222 | #define REQ_RAHEAD (1ULL << __REQ_RAHEAD) | |
1d796d6a | 223 | #define REQ_BACKGROUND (1ULL << __REQ_BACKGROUND) |
7cc01581 | 224 | |
d928be9f CH |
225 | #define REQ_NOUNMAP (1ULL << __REQ_NOUNMAP) |
226 | ||
7cc01581 TH |
227 | #define REQ_FAILFAST_MASK \ |
228 | (REQ_FAILFAST_DEV | REQ_FAILFAST_TRANSPORT | REQ_FAILFAST_DRIVER) | |
7cc01581 | 229 | |
e2a60da7 | 230 | #define REQ_NOMERGE_FLAGS \ |
e8064021 | 231 | (REQ_NOMERGE | REQ_PREFLUSH | REQ_FUA) |
e2a60da7 | 232 | |
ef295ecf CH |
233 | #define bio_op(bio) \ |
234 | ((bio)->bi_opf & REQ_OP_MASK) | |
235 | #define req_op(req) \ | |
236 | ((req)->cmd_flags & REQ_OP_MASK) | |
7cc01581 | 237 | |
ef295ecf | 238 | /* obsolete, don't use in new code */ |
93c5bdf7 CH |
239 | static inline void bio_set_op_attrs(struct bio *bio, unsigned op, |
240 | unsigned op_flags) | |
241 | { | |
242 | bio->bi_opf = op | op_flags; | |
243 | } | |
c11f0c0b | 244 | |
87374179 CH |
245 | static inline bool op_is_write(unsigned int op) |
246 | { | |
247 | return (op & 1); | |
248 | } | |
249 | ||
f73f44eb CH |
250 | /* |
251 | * Check if the bio or request is one that needs special treatment in the | |
252 | * flush state machine. | |
253 | */ | |
254 | static inline bool op_is_flush(unsigned int op) | |
255 | { | |
256 | return op & (REQ_FUA | REQ_PREFLUSH); | |
257 | } | |
258 | ||
b685d3d6 CH |
259 | /* |
260 | * Reads are always treated as synchronous, as are requests with the FUA or | |
261 | * PREFLUSH flag. Other operations may be marked as synchronous using the | |
262 | * REQ_SYNC flag. | |
263 | */ | |
ef295ecf CH |
264 | static inline bool op_is_sync(unsigned int op) |
265 | { | |
b685d3d6 CH |
266 | return (op & REQ_OP_MASK) == REQ_OP_READ || |
267 | (op & (REQ_SYNC | REQ_FUA | REQ_PREFLUSH)); | |
ef295ecf | 268 | } |
c11f0c0b | 269 | |
dece1635 | 270 | typedef unsigned int blk_qc_t; |
fd2d3326 JA |
271 | #define BLK_QC_T_NONE -1U |
272 | #define BLK_QC_T_SHIFT 16 | |
273 | #define BLK_QC_T_INTERNAL (1U << 31) | |
dece1635 JA |
274 | |
275 | static inline bool blk_qc_t_valid(blk_qc_t cookie) | |
276 | { | |
277 | return cookie != BLK_QC_T_NONE; | |
278 | } | |
279 | ||
fd2d3326 JA |
280 | static inline blk_qc_t blk_tag_to_qc_t(unsigned int tag, unsigned int queue_num, |
281 | bool internal) | |
dece1635 | 282 | { |
fd2d3326 JA |
283 | blk_qc_t ret = tag | (queue_num << BLK_QC_T_SHIFT); |
284 | ||
285 | if (internal) | |
286 | ret |= BLK_QC_T_INTERNAL; | |
287 | ||
288 | return ret; | |
dece1635 JA |
289 | } |
290 | ||
291 | static inline unsigned int blk_qc_t_to_queue_num(blk_qc_t cookie) | |
292 | { | |
fd2d3326 | 293 | return (cookie & ~BLK_QC_T_INTERNAL) >> BLK_QC_T_SHIFT; |
dece1635 JA |
294 | } |
295 | ||
296 | static inline unsigned int blk_qc_t_to_tag(blk_qc_t cookie) | |
297 | { | |
e3a7a3bf | 298 | return cookie & ((1u << BLK_QC_T_SHIFT) - 1); |
dece1635 JA |
299 | } |
300 | ||
fd2d3326 JA |
301 | static inline bool blk_qc_t_is_internal(blk_qc_t cookie) |
302 | { | |
303 | return (cookie & BLK_QC_T_INTERNAL) != 0; | |
304 | } | |
305 | ||
cf43e6be JA |
306 | struct blk_rq_stat { |
307 | s64 mean; | |
308 | u64 min; | |
309 | u64 max; | |
310 | s32 nr_samples; | |
311 | s32 nr_batch; | |
312 | u64 batch; | |
cf43e6be JA |
313 | }; |
314 | ||
7cc01581 | 315 | #endif /* __LINUX_BLK_TYPES_H */ |