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