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