]>
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 | |
62a8067a | 20 | #ifdef CONFIG_BLOCK |
7cc01581 TH |
21 | /* |
22 | * main unit of I/O for the block layer and lower layers (ie drivers and | |
23 | * stacking drivers) | |
24 | */ | |
25 | struct bio { | |
7cc01581 TH |
26 | struct bio *bi_next; /* request queue link */ |
27 | struct block_device *bi_bdev; | |
2c68f6dc | 28 | int bi_error; |
1eff9d32 JA |
29 | unsigned int bi_opf; /* bottom bits req flags, |
30 | * top bits REQ_OP. Use | |
31 | * accessors. | |
4e1b2d52 | 32 | */ |
c0acf12a | 33 | unsigned short bi_flags; /* status, command, etc */ |
43b62ce3 | 34 | unsigned short bi_ioprio; |
7cc01581 | 35 | |
4f024f37 | 36 | struct bvec_iter bi_iter; |
7cc01581 TH |
37 | |
38 | /* Number of segments in this BIO after | |
39 | * physical address coalescing is performed. | |
40 | */ | |
41 | unsigned int bi_phys_segments; | |
42 | ||
7cc01581 TH |
43 | /* |
44 | * To keep track of the max segment size, we account for the | |
45 | * sizes of the first and last mergeable segments in this bio. | |
46 | */ | |
47 | unsigned int bi_seg_front_size; | |
48 | unsigned int bi_seg_back_size; | |
49 | ||
c4cf5261 | 50 | atomic_t __bi_remaining; |
196d38bc | 51 | |
7cc01581 TH |
52 | bio_end_io_t *bi_end_io; |
53 | ||
54 | void *bi_private; | |
852c788f TH |
55 | #ifdef CONFIG_BLK_CGROUP |
56 | /* | |
57 | * Optional ioc and css associated with this bio. Put on bio | |
58 | * release. Read comment on top of bio_associate_current(). | |
59 | */ | |
60 | struct io_context *bi_ioc; | |
61 | struct cgroup_subsys_state *bi_css; | |
62 | #endif | |
180b2f95 | 63 | union { |
7cc01581 | 64 | #if defined(CONFIG_BLK_DEV_INTEGRITY) |
180b2f95 | 65 | struct bio_integrity_payload *bi_integrity; /* data integrity */ |
7cc01581 | 66 | #endif |
180b2f95 | 67 | }; |
7cc01581 | 68 | |
4f024f37 KO |
69 | unsigned short bi_vcnt; /* how many bio_vec's */ |
70 | ||
f44b48c7 KO |
71 | /* |
72 | * Everything starting with bi_max_vecs will be preserved by bio_reset() | |
73 | */ | |
74 | ||
4f024f37 | 75 | unsigned short bi_max_vecs; /* max bvl_vecs we can hold */ |
f44b48c7 | 76 | |
dac56212 | 77 | atomic_t __bi_cnt; /* pin count */ |
f44b48c7 KO |
78 | |
79 | struct bio_vec *bi_io_vec; /* the actual vec list */ | |
80 | ||
395c72a7 KO |
81 | struct bio_set *bi_pool; |
82 | ||
7cc01581 TH |
83 | /* |
84 | * We can inline a number of vecs at the end of the bio, to avoid | |
85 | * double allocations for a small number of bio_vecs. This member | |
86 | * MUST obviously be kept at the very end of the bio. | |
87 | */ | |
88 | struct bio_vec bi_inline_vecs[0]; | |
89 | }; | |
90 | ||
637ca77b | 91 | #define BIO_OP_SHIFT (8 * FIELD_SIZEOF(struct bio, bi_opf) - REQ_OP_BITS) |
4382e33a | 92 | #define bio_flags(bio) ((bio)->bi_opf & ((1 << BIO_OP_SHIFT) - 1)) |
1eff9d32 | 93 | #define bio_op(bio) ((bio)->bi_opf >> BIO_OP_SHIFT) |
4e1b2d52 | 94 | |
3e1de31b BVA |
95 | #define bio_set_op_attrs(bio, op, op_flags) do { \ |
96 | if (__builtin_constant_p(op)) \ | |
97 | BUILD_BUG_ON((op) + 0U >= (1U << REQ_OP_BITS)); \ | |
98 | else \ | |
99 | WARN_ON_ONCE((op) + 0U >= (1U << REQ_OP_BITS)); \ | |
100 | if (__builtin_constant_p(op_flags)) \ | |
101 | BUILD_BUG_ON((op_flags) + 0U >= (1U << BIO_OP_SHIFT)); \ | |
102 | else \ | |
103 | WARN_ON_ONCE((op_flags) + 0U >= (1U << BIO_OP_SHIFT)); \ | |
104 | (bio)->bi_opf = bio_flags(bio); \ | |
105 | (bio)->bi_opf |= (((op) + 0U) << BIO_OP_SHIFT); \ | |
106 | (bio)->bi_opf |= (op_flags); \ | |
4e1b2d52 MC |
107 | } while (0) |
108 | ||
f44b48c7 KO |
109 | #define BIO_RESET_BYTES offsetof(struct bio, bi_max_vecs) |
110 | ||
7cc01581 TH |
111 | /* |
112 | * bio flags | |
113 | */ | |
b2dbe0a6 JA |
114 | #define BIO_SEG_VALID 1 /* bi_phys_segments valid */ |
115 | #define BIO_CLONED 2 /* doesn't own data */ | |
116 | #define BIO_BOUNCED 3 /* bio is a bounce bio */ | |
117 | #define BIO_USER_MAPPED 4 /* contains user pages */ | |
118 | #define BIO_NULL_MAPPED 5 /* contains invalid user pages */ | |
119 | #define BIO_QUIET 6 /* Make BIO Quiet */ | |
a3ad0a9d JK |
120 | #define BIO_CHAIN 7 /* chained bio, ->bi_remaining in effect */ |
121 | #define BIO_REFFED 8 /* bio has elevated ->bi_cnt */ | |
8d2bbd4c CH |
122 | #define BIO_THROTTLED 9 /* This bio has already been subjected to |
123 | * throttling rules. Don't do it again. */ | |
f44b48c7 KO |
124 | |
125 | /* | |
126 | * Flags starting here get preserved by bio_reset() - this includes | |
ed996a52 | 127 | * BVEC_POOL_IDX() |
f44b48c7 | 128 | */ |
c0acf12a | 129 | #define BIO_RESET_BITS 10 |
f44b48c7 | 130 | |
7cc01581 | 131 | /* |
ed996a52 CH |
132 | * We support 6 different bvec pools, the last one is magic in that it |
133 | * is backed by a mempool. | |
7cc01581 | 134 | */ |
ed996a52 CH |
135 | #define BVEC_POOL_NR 6 |
136 | #define BVEC_POOL_MAX (BVEC_POOL_NR - 1) | |
137 | ||
138 | /* | |
139 | * Top 4 bits of bio flags indicate the pool the bvecs came from. We add | |
140 | * 1 to the actual index so that 0 indicates that there are no bvecs to be | |
141 | * freed. | |
142 | */ | |
143 | #define BVEC_POOL_BITS (4) | |
c0acf12a | 144 | #define BVEC_POOL_OFFSET (16 - BVEC_POOL_BITS) |
ed996a52 | 145 | #define BVEC_POOL_IDX(bio) ((bio)->bi_flags >> BVEC_POOL_OFFSET) |
7cc01581 | 146 | |
de75d60d JA |
147 | #endif /* CONFIG_BLOCK */ |
148 | ||
7cc01581 TH |
149 | /* |
150 | * Request flags. For use in the cmd_flags field of struct request, and in | |
1eff9d32 | 151 | * bi_opf of struct bio. Note that some flags are only valid in either one. |
7cc01581 TH |
152 | */ |
153 | enum rq_flag_bits { | |
154 | /* common flags */ | |
7cc01581 TH |
155 | __REQ_FAILFAST_DEV, /* no driver retries of device errors */ |
156 | __REQ_FAILFAST_TRANSPORT, /* no driver retries of transport errors */ | |
157 | __REQ_FAILFAST_DRIVER, /* no driver retries of driver errors */ | |
158 | ||
7cc01581 TH |
159 | __REQ_SYNC, /* request is sync (sync write or read) */ |
160 | __REQ_META, /* metadata io request */ | |
65299a3b | 161 | __REQ_PRIO, /* boost priority in cfq */ |
8e4bf844 | 162 | |
bd1c1c21 | 163 | __REQ_NOMERGE, /* don't touch this for merging */ |
7cc01581 | 164 | __REQ_NOIDLE, /* don't anticipate more IO after this one */ |
180b2f95 | 165 | __REQ_INTEGRITY, /* I/O includes block integrity payload */ |
8e4bf844 | 166 | __REQ_FUA, /* forced unit access */ |
28a8f0d3 | 167 | __REQ_PREFLUSH, /* request for cache flush */ |
188bd2b1 | 168 | __REQ_RAHEAD, /* read ahead, can fail anytime */ |
7cc01581 | 169 | |
7cc01581 TH |
170 | /* request only flags */ |
171 | __REQ_SORTED, /* elevator knows about this request */ | |
172 | __REQ_SOFTBARRIER, /* may not be passed by ioscheduler */ | |
7cc01581 TH |
173 | __REQ_STARTED, /* drive already may have started this one */ |
174 | __REQ_DONTPREP, /* don't call prep for this one */ | |
175 | __REQ_QUEUED, /* uses queueing */ | |
176 | __REQ_ELVPRIV, /* elevator private data attached */ | |
177 | __REQ_FAILED, /* set if the request failed */ | |
178 | __REQ_QUIET, /* don't worry about errors */ | |
bba0bdd7 BVA |
179 | __REQ_PREEMPT, /* set for "ide_preempt" requests and also |
180 | for requests for which the SCSI "quiesce" | |
181 | state must be ignored. */ | |
7cc01581 TH |
182 | __REQ_ALLOCED, /* request came from our alloc pool */ |
183 | __REQ_COPY_USER, /* contains copies of user pages */ | |
414b4ff5 | 184 | __REQ_FLUSH_SEQ, /* request for flush sequence */ |
7cc01581 TH |
185 | __REQ_IO_STAT, /* account I/O stat */ |
186 | __REQ_MIXED_MERGE, /* merge of different types, fail separately */ | |
66311274 | 187 | __REQ_PM, /* runtime pm request */ |
360f92c2 | 188 | __REQ_HASHED, /* on IO scheduler merge hash */ |
0d2602ca | 189 | __REQ_MQ_INFLIGHT, /* track inflight for MQ */ |
7cc01581 TH |
190 | __REQ_NR_BITS, /* stops here */ |
191 | }; | |
192 | ||
5953316d JA |
193 | #define REQ_FAILFAST_DEV (1ULL << __REQ_FAILFAST_DEV) |
194 | #define REQ_FAILFAST_TRANSPORT (1ULL << __REQ_FAILFAST_TRANSPORT) | |
195 | #define REQ_FAILFAST_DRIVER (1ULL << __REQ_FAILFAST_DRIVER) | |
196 | #define REQ_SYNC (1ULL << __REQ_SYNC) | |
197 | #define REQ_META (1ULL << __REQ_META) | |
198 | #define REQ_PRIO (1ULL << __REQ_PRIO) | |
5953316d | 199 | #define REQ_NOIDLE (1ULL << __REQ_NOIDLE) |
180b2f95 | 200 | #define REQ_INTEGRITY (1ULL << __REQ_INTEGRITY) |
7cc01581 TH |
201 | |
202 | #define REQ_FAILFAST_MASK \ | |
203 | (REQ_FAILFAST_DEV | REQ_FAILFAST_TRANSPORT | REQ_FAILFAST_DRIVER) | |
204 | #define REQ_COMMON_MASK \ | |
4e1b2d52 | 205 | (REQ_FAILFAST_MASK | REQ_SYNC | REQ_META | REQ_PRIO | REQ_NOIDLE | \ |
188bd2b1 | 206 | REQ_PREFLUSH | REQ_FUA | REQ_INTEGRITY | REQ_NOMERGE | REQ_RAHEAD) |
3a2edd0d | 207 | #define REQ_CLONE_MASK REQ_COMMON_MASK |
7cc01581 | 208 | |
e2a60da7 MP |
209 | /* This mask is used for both bio and request merge checking */ |
210 | #define REQ_NOMERGE_FLAGS \ | |
28a8f0d3 | 211 | (REQ_NOMERGE | REQ_STARTED | REQ_SOFTBARRIER | REQ_PREFLUSH | REQ_FUA | REQ_FLUSH_SEQ) |
e2a60da7 | 212 | |
5953316d | 213 | #define REQ_RAHEAD (1ULL << __REQ_RAHEAD) |
5953316d JA |
214 | #define REQ_SORTED (1ULL << __REQ_SORTED) |
215 | #define REQ_SOFTBARRIER (1ULL << __REQ_SOFTBARRIER) | |
216 | #define REQ_FUA (1ULL << __REQ_FUA) | |
217 | #define REQ_NOMERGE (1ULL << __REQ_NOMERGE) | |
218 | #define REQ_STARTED (1ULL << __REQ_STARTED) | |
219 | #define REQ_DONTPREP (1ULL << __REQ_DONTPREP) | |
220 | #define REQ_QUEUED (1ULL << __REQ_QUEUED) | |
221 | #define REQ_ELVPRIV (1ULL << __REQ_ELVPRIV) | |
222 | #define REQ_FAILED (1ULL << __REQ_FAILED) | |
223 | #define REQ_QUIET (1ULL << __REQ_QUIET) | |
224 | #define REQ_PREEMPT (1ULL << __REQ_PREEMPT) | |
225 | #define REQ_ALLOCED (1ULL << __REQ_ALLOCED) | |
226 | #define REQ_COPY_USER (1ULL << __REQ_COPY_USER) | |
28a8f0d3 | 227 | #define REQ_PREFLUSH (1ULL << __REQ_PREFLUSH) |
5953316d JA |
228 | #define REQ_FLUSH_SEQ (1ULL << __REQ_FLUSH_SEQ) |
229 | #define REQ_IO_STAT (1ULL << __REQ_IO_STAT) | |
230 | #define REQ_MIXED_MERGE (1ULL << __REQ_MIXED_MERGE) | |
5953316d | 231 | #define REQ_PM (1ULL << __REQ_PM) |
360f92c2 | 232 | #define REQ_HASHED (1ULL << __REQ_HASHED) |
0d2602ca | 233 | #define REQ_MQ_INFLIGHT (1ULL << __REQ_MQ_INFLIGHT) |
7cc01581 | 234 | |
c11f0c0b JA |
235 | enum req_op { |
236 | REQ_OP_READ, | |
237 | REQ_OP_WRITE, | |
238 | REQ_OP_DISCARD, /* request to discard sectors */ | |
239 | REQ_OP_SECURE_ERASE, /* request to securely erase sectors */ | |
240 | REQ_OP_WRITE_SAME, /* write same block many times */ | |
241 | REQ_OP_FLUSH, /* request for cache flush */ | |
2d253440 ST |
242 | REQ_OP_ZONE_REPORT, /* Get zone information */ |
243 | REQ_OP_ZONE_RESET, /* Reset a zone write pointer */ | |
c11f0c0b JA |
244 | }; |
245 | ||
246 | #define REQ_OP_BITS 3 | |
247 | ||
dece1635 JA |
248 | typedef unsigned int blk_qc_t; |
249 | #define BLK_QC_T_NONE -1U | |
250 | #define BLK_QC_T_SHIFT 16 | |
251 | ||
252 | static inline bool blk_qc_t_valid(blk_qc_t cookie) | |
253 | { | |
254 | return cookie != BLK_QC_T_NONE; | |
255 | } | |
256 | ||
257 | static inline blk_qc_t blk_tag_to_qc_t(unsigned int tag, unsigned int queue_num) | |
258 | { | |
259 | return tag | (queue_num << BLK_QC_T_SHIFT); | |
260 | } | |
261 | ||
262 | static inline unsigned int blk_qc_t_to_queue_num(blk_qc_t cookie) | |
263 | { | |
264 | return cookie >> BLK_QC_T_SHIFT; | |
265 | } | |
266 | ||
267 | static inline unsigned int blk_qc_t_to_tag(blk_qc_t cookie) | |
268 | { | |
e3a7a3bf | 269 | return cookie & ((1u << BLK_QC_T_SHIFT) - 1); |
dece1635 JA |
270 | } |
271 | ||
7cc01581 | 272 | #endif /* __LINUX_BLK_TYPES_H */ |