1 /* SPDX-License-Identifier: GPL-2.0 */
3 * Block data types and constants. Directly include this file only to
4 * break include dependency loop.
6 #ifndef __LINUX_BLK_TYPES_H
7 #define __LINUX_BLK_TYPES_H
9 #include <linux/types.h>
10 #include <linux/bvec.h>
11 #include <linux/device.h>
12 #include <linux/ktime.h>
16 struct bio_integrity_payload;
19 struct cgroup_subsys_state;
20 typedef void (bio_end_io_t) (struct bio *);
24 * The basic unit of block I/O is a sector. It is used in a number of contexts
25 * in Linux (blk, bio, genhd). The size of one sector is 512 = 2**9
26 * bytes. Variables of type sector_t represent an offset or size that is a
27 * multiple of 512 bytes. Hence these two constants.
30 #define SECTOR_SHIFT 9
33 #define SECTOR_SIZE (1 << SECTOR_SHIFT)
36 #define PAGE_SECTORS_SHIFT (PAGE_SHIFT - SECTOR_SHIFT)
37 #define PAGE_SECTORS (1 << PAGE_SECTORS_SHIFT)
38 #define SECTOR_MASK (PAGE_SECTORS - 1)
41 sector_t bd_start_sect;
42 sector_t bd_nr_sectors;
43 struct disk_stats __percpu *bd_stats;
44 unsigned long bd_stamp;
45 bool bd_read_only; /* read-only policy */
48 struct inode * bd_inode; /* will die */
49 struct super_block * bd_super;
51 struct device bd_device;
55 struct kobject *bd_holder_dir;
57 spinlock_t bd_size_lock; /* for bd_inode->i_size updates */
58 struct gendisk * bd_disk;
59 struct request_queue * bd_queue;
61 /* The counter of freeze processes */
62 int bd_fsfreeze_count;
63 /* Mutex for freeze */
64 struct mutex bd_fsfreeze_mutex;
65 struct super_block *bd_fsfreeze_sb;
67 struct partition_meta_info *bd_meta_info;
68 #ifdef CONFIG_FAIL_MAKE_REQUEST
73 #define bdev_whole(_bdev) \
74 ((_bdev)->bd_disk->part0)
76 #define dev_to_bdev(device) \
77 container_of((device), struct block_device, bd_device)
79 #define bdev_kobj(_bdev) \
80 (&((_bdev)->bd_device.kobj))
83 * Block error status values. See block/blk-core:blk_errors for the details.
84 * Alpha cannot write a byte atomically, so we need to use 32-bit value.
86 #if defined(CONFIG_ALPHA) && !defined(__alpha_bwx__)
87 typedef u32 __bitwise blk_status_t;
89 typedef u8 __bitwise blk_status_t;
92 #define BLK_STS_NOTSUPP ((__force blk_status_t)1)
93 #define BLK_STS_TIMEOUT ((__force blk_status_t)2)
94 #define BLK_STS_NOSPC ((__force blk_status_t)3)
95 #define BLK_STS_TRANSPORT ((__force blk_status_t)4)
96 #define BLK_STS_TARGET ((__force blk_status_t)5)
97 #define BLK_STS_NEXUS ((__force blk_status_t)6)
98 #define BLK_STS_MEDIUM ((__force blk_status_t)7)
99 #define BLK_STS_PROTECTION ((__force blk_status_t)8)
100 #define BLK_STS_RESOURCE ((__force blk_status_t)9)
101 #define BLK_STS_IOERR ((__force blk_status_t)10)
103 /* hack for device mapper, don't use elsewhere: */
104 #define BLK_STS_DM_REQUEUE ((__force blk_status_t)11)
106 #define BLK_STS_AGAIN ((__force blk_status_t)12)
109 * BLK_STS_DEV_RESOURCE is returned from the driver to the block layer if
110 * device related resources are unavailable, but the driver can guarantee
111 * that the queue will be rerun in the future once resources become
112 * available again. This is typically the case for device specific
113 * resources that are consumed for IO. If the driver fails allocating these
114 * resources, we know that inflight (or pending) IO will free these
115 * resource upon completion.
117 * This is different from BLK_STS_RESOURCE in that it explicitly references
118 * a device specific resource. For resources of wider scope, allocation
119 * failure can happen without having pending IO. This means that we can't
120 * rely on request completions freeing these resources, as IO may not be in
121 * flight. Examples of that are kernel memory allocations, DMA mappings, or
122 * any other system wide resources.
124 #define BLK_STS_DEV_RESOURCE ((__force blk_status_t)13)
127 * BLK_STS_ZONE_RESOURCE is returned from the driver to the block layer if zone
128 * related resources are unavailable, but the driver can guarantee the queue
129 * will be rerun in the future once the resources become available again.
131 * This is different from BLK_STS_DEV_RESOURCE in that it explicitly references
132 * a zone specific resource and IO to a different zone on the same device could
133 * still be served. Examples of that are zones that are write-locked, but a read
134 * to the same zone could be served.
136 #define BLK_STS_ZONE_RESOURCE ((__force blk_status_t)14)
139 * BLK_STS_ZONE_OPEN_RESOURCE is returned from the driver in the completion
140 * path if the device returns a status indicating that too many zone resources
141 * are currently open. The same command should be successful if resubmitted
142 * after the number of open zones decreases below the device's limits, which is
143 * reported in the request_queue's max_open_zones.
145 #define BLK_STS_ZONE_OPEN_RESOURCE ((__force blk_status_t)15)
148 * BLK_STS_ZONE_ACTIVE_RESOURCE is returned from the driver in the completion
149 * path if the device returns a status indicating that too many zone resources
150 * are currently active. The same command should be successful if resubmitted
151 * after the number of active zones decreases below the device's limits, which
152 * is reported in the request_queue's max_active_zones.
154 #define BLK_STS_ZONE_ACTIVE_RESOURCE ((__force blk_status_t)16)
157 * BLK_STS_OFFLINE is returned from the driver when the target device is offline
158 * or is being taken offline. This could help differentiate the case where a
159 * device is intentionally being shut down from a real I/O error.
161 #define BLK_STS_OFFLINE ((__force blk_status_t)17)
164 * blk_path_error - returns true if error may be path related
165 * @error: status the request was completed with
168 * This classifies block error status into non-retryable errors and ones
169 * that may be successful if retried on a failover path.
172 * %false - retrying failover path will not help
173 * %true - may succeed if retried
175 static inline bool blk_path_error(blk_status_t error)
178 case BLK_STS_NOTSUPP:
183 case BLK_STS_PROTECTION:
187 /* Anything else could be a path failure, so should be retried */
192 * From most significant bit:
193 * 1 bit: reserved for other usage, see below
194 * 12 bits: original size of bio
195 * 51 bits: issue time of bio
197 #define BIO_ISSUE_RES_BITS 1
198 #define BIO_ISSUE_SIZE_BITS 12
199 #define BIO_ISSUE_RES_SHIFT (64 - BIO_ISSUE_RES_BITS)
200 #define BIO_ISSUE_SIZE_SHIFT (BIO_ISSUE_RES_SHIFT - BIO_ISSUE_SIZE_BITS)
201 #define BIO_ISSUE_TIME_MASK ((1ULL << BIO_ISSUE_SIZE_SHIFT) - 1)
202 #define BIO_ISSUE_SIZE_MASK \
203 (((1ULL << BIO_ISSUE_SIZE_BITS) - 1) << BIO_ISSUE_SIZE_SHIFT)
204 #define BIO_ISSUE_RES_MASK (~((1ULL << BIO_ISSUE_RES_SHIFT) - 1))
206 /* Reserved bit for blk-throtl */
207 #define BIO_ISSUE_THROTL_SKIP_LATENCY (1ULL << 63)
213 static inline u64 __bio_issue_time(u64 time)
215 return time & BIO_ISSUE_TIME_MASK;
218 static inline u64 bio_issue_time(struct bio_issue *issue)
220 return __bio_issue_time(issue->value);
223 static inline sector_t bio_issue_size(struct bio_issue *issue)
225 return ((issue->value & BIO_ISSUE_SIZE_MASK) >> BIO_ISSUE_SIZE_SHIFT);
228 static inline void bio_issue_init(struct bio_issue *issue,
231 size &= (1ULL << BIO_ISSUE_SIZE_BITS) - 1;
232 issue->value = ((issue->value & BIO_ISSUE_RES_MASK) |
233 (ktime_get_ns() & BIO_ISSUE_TIME_MASK) |
234 ((u64)size << BIO_ISSUE_SIZE_SHIFT));
237 typedef unsigned int blk_qc_t;
238 #define BLK_QC_T_NONE -1U
241 * main unit of I/O for the block layer and lower layers (ie drivers and
245 struct bio *bi_next; /* request queue link */
246 struct block_device *bi_bdev;
247 unsigned int bi_opf; /* bottom bits req flags,
248 * top bits REQ_OP. Use
251 unsigned short bi_flags; /* BIO_* below */
252 unsigned short bi_ioprio;
253 unsigned short bi_write_hint;
254 blk_status_t bi_status;
255 atomic_t __bi_remaining;
257 struct bvec_iter bi_iter;
260 bio_end_io_t *bi_end_io;
262 #ifdef CONFIG_BLK_CGROUP
264 * Represents the association of the css and request_queue for the bio.
265 * If a bio goes direct to device, it will not have a blkg as it will
266 * not have a request_queue associated with it. The reference is put
267 * on release of the bio.
269 struct blkcg_gq *bi_blkg;
270 struct bio_issue bi_issue;
271 #ifdef CONFIG_BLK_CGROUP_IOCOST
276 #ifdef CONFIG_BLK_INLINE_ENCRYPTION
277 struct bio_crypt_ctx *bi_crypt_context;
281 #if defined(CONFIG_BLK_DEV_INTEGRITY)
282 struct bio_integrity_payload *bi_integrity; /* data integrity */
286 unsigned short bi_vcnt; /* how many bio_vec's */
289 * Everything starting with bi_max_vecs will be preserved by bio_reset()
292 unsigned short bi_max_vecs; /* max bvl_vecs we can hold */
294 atomic_t __bi_cnt; /* pin count */
296 struct bio_vec *bi_io_vec; /* the actual vec list */
298 struct bio_set *bi_pool;
301 * We can inline a number of vecs at the end of the bio, to avoid
302 * double allocations for a small number of bio_vecs. This member
303 * MUST obviously be kept at the very end of the bio.
305 struct bio_vec bi_inline_vecs[];
308 #define BIO_RESET_BYTES offsetof(struct bio, bi_max_vecs)
309 #define BIO_MAX_SECTORS (UINT_MAX >> SECTOR_SHIFT)
315 BIO_NO_PAGE_REF, /* don't put release vec pages */
316 BIO_CLONED, /* doesn't own data */
317 BIO_BOUNCED, /* bio is a bounce bio */
318 BIO_WORKINGSET, /* contains userspace workingset pages */
319 BIO_QUIET, /* Make BIO Quiet */
320 BIO_CHAIN, /* chained bio, ->bi_remaining in effect */
321 BIO_REFFED, /* bio has elevated ->bi_cnt */
322 BIO_THROTTLED, /* This bio has already been subjected to
323 * throttling rules. Don't do it again. */
324 BIO_TRACE_COMPLETION, /* bio_endio() should trace the final completion
326 BIO_CGROUP_ACCT, /* has been accounted to a cgroup */
327 BIO_QOS_THROTTLED, /* bio went through rq_qos throttle path */
328 BIO_QOS_MERGED, /* but went through rq_qos merge path */
330 BIO_ZONE_WRITE_LOCKED, /* Owns a zoned device zone write lock */
331 BIO_PERCPU_CACHE, /* can participate in per-cpu alloc cache */
335 typedef __u32 __bitwise blk_mq_req_flags_t;
338 * Operations and flags common to the bio and request structures.
339 * We use 8 bits for encoding the operation, and the remaining 24 for flags.
341 * The least significant bit of the operation number indicates the data
342 * transfer direction:
344 * - if the least significant bit is set transfers are TO the device
345 * - if the least significant bit is not set transfers are FROM the device
347 * If a operation does not transfer data the least significant bit has no
350 #define REQ_OP_BITS 8
351 #define REQ_OP_MASK ((1 << REQ_OP_BITS) - 1)
352 #define REQ_FLAG_BITS 24
355 /* read sectors from the device */
357 /* write sectors to the device */
359 /* flush the volatile write cache */
361 /* discard sectors */
363 /* securely erase sectors */
364 REQ_OP_SECURE_ERASE = 5,
365 /* write the same sector many times */
366 REQ_OP_WRITE_SAME = 7,
367 /* write the zero filled sector many times */
368 REQ_OP_WRITE_ZEROES = 9,
370 REQ_OP_ZONE_OPEN = 10,
372 REQ_OP_ZONE_CLOSE = 11,
373 /* Transition a zone to full */
374 REQ_OP_ZONE_FINISH = 12,
375 /* write data at the current zone write pointer */
376 REQ_OP_ZONE_APPEND = 13,
377 /* reset a zone write pointer */
378 REQ_OP_ZONE_RESET = 15,
379 /* reset all the zone present on the device */
380 REQ_OP_ZONE_RESET_ALL = 17,
382 /* Driver private requests */
390 __REQ_FAILFAST_DEV = /* no driver retries of device errors */
392 __REQ_FAILFAST_TRANSPORT, /* no driver retries of transport errors */
393 __REQ_FAILFAST_DRIVER, /* no driver retries of driver errors */
394 __REQ_SYNC, /* request is sync (sync write or read) */
395 __REQ_META, /* metadata io request */
396 __REQ_PRIO, /* boost priority in cfq */
397 __REQ_NOMERGE, /* don't touch this for merging */
398 __REQ_IDLE, /* anticipate more IO after this one */
399 __REQ_INTEGRITY, /* I/O includes block integrity payload */
400 __REQ_FUA, /* forced unit access */
401 __REQ_PREFLUSH, /* request for cache flush */
402 __REQ_RAHEAD, /* read ahead, can fail anytime */
403 __REQ_BACKGROUND, /* background IO */
404 __REQ_NOWAIT, /* Don't wait if request will block */
406 * When a shared kthread needs to issue a bio for a cgroup, doing
407 * so synchronously can lead to priority inversions as the kthread
408 * can be trapped waiting for that cgroup. CGROUP_PUNT flag makes
409 * submit_bio() punt the actual issuing to a dedicated per-blkcg
410 * work item to avoid such priority inversions.
414 /* command specific flags for REQ_OP_WRITE_ZEROES: */
415 __REQ_NOUNMAP, /* do not free blocks when zeroing */
417 __REQ_POLLED, /* caller polls for completion using bio_poll */
421 __REQ_SWAP, /* swapping request. */
422 __REQ_NR_BITS, /* stops here */
425 #define REQ_FAILFAST_DEV (1ULL << __REQ_FAILFAST_DEV)
426 #define REQ_FAILFAST_TRANSPORT (1ULL << __REQ_FAILFAST_TRANSPORT)
427 #define REQ_FAILFAST_DRIVER (1ULL << __REQ_FAILFAST_DRIVER)
428 #define REQ_SYNC (1ULL << __REQ_SYNC)
429 #define REQ_META (1ULL << __REQ_META)
430 #define REQ_PRIO (1ULL << __REQ_PRIO)
431 #define REQ_NOMERGE (1ULL << __REQ_NOMERGE)
432 #define REQ_IDLE (1ULL << __REQ_IDLE)
433 #define REQ_INTEGRITY (1ULL << __REQ_INTEGRITY)
434 #define REQ_FUA (1ULL << __REQ_FUA)
435 #define REQ_PREFLUSH (1ULL << __REQ_PREFLUSH)
436 #define REQ_RAHEAD (1ULL << __REQ_RAHEAD)
437 #define REQ_BACKGROUND (1ULL << __REQ_BACKGROUND)
438 #define REQ_NOWAIT (1ULL << __REQ_NOWAIT)
439 #define REQ_CGROUP_PUNT (1ULL << __REQ_CGROUP_PUNT)
441 #define REQ_NOUNMAP (1ULL << __REQ_NOUNMAP)
442 #define REQ_POLLED (1ULL << __REQ_POLLED)
444 #define REQ_DRV (1ULL << __REQ_DRV)
445 #define REQ_SWAP (1ULL << __REQ_SWAP)
447 #define REQ_FAILFAST_MASK \
448 (REQ_FAILFAST_DEV | REQ_FAILFAST_TRANSPORT | REQ_FAILFAST_DRIVER)
450 #define REQ_NOMERGE_FLAGS \
451 (REQ_NOMERGE | REQ_PREFLUSH | REQ_FUA)
462 #define bio_op(bio) \
463 ((bio)->bi_opf & REQ_OP_MASK)
465 /* obsolete, don't use in new code */
466 static inline void bio_set_op_attrs(struct bio *bio, unsigned op,
469 bio->bi_opf = op | op_flags;
472 static inline bool op_is_write(unsigned int op)
478 * Check if the bio or request is one that needs special treatment in the
479 * flush state machine.
481 static inline bool op_is_flush(unsigned int op)
483 return op & (REQ_FUA | REQ_PREFLUSH);
487 * Reads are always treated as synchronous, as are requests with the FUA or
488 * PREFLUSH flag. Other operations may be marked as synchronous using the
491 static inline bool op_is_sync(unsigned int op)
493 return (op & REQ_OP_MASK) == REQ_OP_READ ||
494 (op & (REQ_SYNC | REQ_FUA | REQ_PREFLUSH));
497 static inline bool op_is_discard(unsigned int op)
499 return (op & REQ_OP_MASK) == REQ_OP_DISCARD;
503 * Check if a bio or request operation is a zone management operation, with
504 * the exception of REQ_OP_ZONE_RESET_ALL which is treated as a special case
505 * due to its different handling in the block layer and device response in
506 * case of command failure.
508 static inline bool op_is_zone_mgmt(enum req_opf op)
510 switch (op & REQ_OP_MASK) {
511 case REQ_OP_ZONE_RESET:
512 case REQ_OP_ZONE_OPEN:
513 case REQ_OP_ZONE_CLOSE:
514 case REQ_OP_ZONE_FINISH:
521 static inline int op_stat_group(unsigned int op)
523 if (op_is_discard(op))
525 return op_is_write(op);
536 #endif /* __LINUX_BLK_TYPES_H */