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