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