include/linux/blk_types.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   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
   9 #include <linux/types.h>
  10 #include <linux/bvec.h>
  11 #include <linux/device.h>
  12 #include <linux/ktime.h>
  13
  14 struct bio_set;
  15 struct bio;
  16 struct bio_integrity_payload;
  17 struct page;
  18 struct io_context;
  19 struct cgroup_subsys_state;
  20 typedef void (bio_end_io_t) (struct bio *);
  21 struct bio_crypt_ctx;
  22
  23 /*
  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.
  28  */
  29 #ifndef SECTOR_SHIFT
  30 #define SECTOR_SHIFT 9
  31 #endif
  32 #ifndef SECTOR_SIZE
  33 #define SECTOR_SIZE (1 << SECTOR_SHIFT)
  34 #endif
  35
  36 #define PAGE_SECTORS_SHIFT      (PAGE_SHIFT - SECTOR_SHIFT)
  37 #define PAGE_SECTORS            (1 << PAGE_SECTORS_SHIFT)
  38 #define SECTOR_MASK             (PAGE_SECTORS - 1)
  39
  40 struct block_device {
  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 */
  46         dev_t                   bd_dev;
  47         int                     bd_openers;
  48         struct inode *          bd_inode;       /* will die */
  49         struct super_block *    bd_super;
  50         void *                  bd_claiming;
  51         struct device           bd_device;
  52         void *                  bd_holder;
  53         int                     bd_holders;
  54         bool                    bd_write_holder;
  55         struct kobject          *bd_holder_dir;
  56         u8                      bd_partno;
  57         spinlock_t              bd_size_lock; /* for bd_inode->i_size updates */
  58         struct gendisk *        bd_disk;
  59         struct request_queue *  bd_queue;
  60
  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;
  66
  67         struct partition_meta_info *bd_meta_info;
  68 #ifdef CONFIG_FAIL_MAKE_REQUEST
  69         bool                    bd_make_it_fail;
  70 #endif
  71 } __randomize_layout;
  72
  73 #define bdev_whole(_bdev) \
  74         ((_bdev)->bd_disk->part0)
  75
  76 #define dev_to_bdev(device) \
  77         container_of((device), struct block_device, bd_device)
  78
  79 #define bdev_kobj(_bdev) \
  80         (&((_bdev)->bd_device.kobj))
  81
  82 /*
  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.
  85  */
  86 #if defined(CONFIG_ALPHA) && !defined(__alpha_bwx__)
  87 typedef u32 __bitwise blk_status_t;
  88 #else
  89 typedef u8 __bitwise blk_status_t;
  90 #endif
  91 #define BLK_STS_OK 0
  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)
 102
 103 /* hack for device mapper, don't use elsewhere: */
 104 #define BLK_STS_DM_REQUEUE    ((__force blk_status_t)11)
 105
 106 #define BLK_STS_AGAIN           ((__force blk_status_t)12)
 107
 108 /*
 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.
 116  *
 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.
 123  */
 124 #define BLK_STS_DEV_RESOURCE    ((__force blk_status_t)13)
 125
 126 /*
 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.
 130  *
 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.
 135  */
 136 #define BLK_STS_ZONE_RESOURCE   ((__force blk_status_t)14)
 137
 138 /*
 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.
 144  */
 145 #define BLK_STS_ZONE_OPEN_RESOURCE      ((__force blk_status_t)15)
 146
 147 /*
 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.
 153  */
 154 #define BLK_STS_ZONE_ACTIVE_RESOURCE    ((__force blk_status_t)16)
 155
 156 /*
 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.
 160  */
 161 #define BLK_STS_OFFLINE         ((__force blk_status_t)17)
 162
 163 /**
 164  * blk_path_error - returns true if error may be path related
 165  * @error: status the request was completed with
 166  *
 167  * Description:
 168  *     This classifies block error status into non-retryable errors and ones
 169  *     that may be successful if retried on a failover path.
 170  *
 171  * Return:
 172  *     %false - retrying failover path will not help
 173  *     %true  - may succeed if retried
 174  */
 175 static inline bool blk_path_error(blk_status_t error)
 176 {
 177         switch (error) {
 178         case BLK_STS_NOTSUPP:
 179         case BLK_STS_NOSPC:
 180         case BLK_STS_TARGET:
 181         case BLK_STS_NEXUS:
 182         case BLK_STS_MEDIUM:
 183         case BLK_STS_PROTECTION:
 184                 return false;
 185         }
 186
 187         /* Anything else could be a path failure, so should be retried */
 188         return true;
 189 }
 190
 191 /*
 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
 196  */
 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))
 205
 206 /* Reserved bit for blk-throtl */
 207 #define BIO_ISSUE_THROTL_SKIP_LATENCY (1ULL << 63)
 208
 209 struct bio_issue {
 210         u64 value;
 211 };
 212
 213 static inline u64 __bio_issue_time(u64 time)
 214 {
 215         return time & BIO_ISSUE_TIME_MASK;
 216 }
 217
 218 static inline u64 bio_issue_time(struct bio_issue *issue)
 219 {
 220         return __bio_issue_time(issue->value);
 221 }
 222
 223 static inline sector_t bio_issue_size(struct bio_issue *issue)
 224 {
 225         return ((issue->value & BIO_ISSUE_SIZE_MASK) >> BIO_ISSUE_SIZE_SHIFT);
 226 }
 227
 228 static inline void bio_issue_init(struct bio_issue *issue,
 229                                        sector_t size)
 230 {
 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));
 235 }
 236
 237 typedef unsigned int blk_qc_t;
 238 #define BLK_QC_T_NONE           -1U
 239
 240 /*
 241  * main unit of I/O for the block layer and lower layers (ie drivers and
 242  * stacking drivers)
 243  */
 244 struct bio {
 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
 249                                                  * accessors.
 250                                                  */
 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;
 256
 257         struct bvec_iter        bi_iter;
 258
 259         blk_qc_t                bi_cookie;
 260         bio_end_io_t            *bi_end_io;
 261         void                    *bi_private;
 262 #ifdef CONFIG_BLK_CGROUP
 263         /*
 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.
 268          */
 269         struct blkcg_gq         *bi_blkg;
 270         struct bio_issue        bi_issue;
 271 #ifdef CONFIG_BLK_CGROUP_IOCOST
 272         u64                     bi_iocost_cost;
 273 #endif
 274 #endif
 275
 276 #ifdef CONFIG_BLK_INLINE_ENCRYPTION
 277         struct bio_crypt_ctx    *bi_crypt_context;
 278 #endif
 279
 280         union {
 281 #if defined(CONFIG_BLK_DEV_INTEGRITY)
 282                 struct bio_integrity_payload *bi_integrity; /* data integrity */
 283 #endif
 284         };
 285
 286         unsigned short          bi_vcnt;        /* how many bio_vec's */
 287
 288         /*
 289          * Everything starting with bi_max_vecs will be preserved by bio_reset()
 290          */
 291
 292         unsigned short          bi_max_vecs;    /* max bvl_vecs we can hold */
 293
 294         atomic_t                __bi_cnt;       /* pin count */
 295
 296         struct bio_vec          *bi_io_vec;     /* the actual vec list */
 297
 298         struct bio_set          *bi_pool;
 299
 300         /*
 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.
 304          */
 305         struct bio_vec          bi_inline_vecs[];
 306 };
 307
 308 #define BIO_RESET_BYTES         offsetof(struct bio, bi_max_vecs)
 309 #define BIO_MAX_SECTORS         (UINT_MAX >> SECTOR_SHIFT)
 310
 311 /*
 312  * bio flags
 313  */
 314 enum {
 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
 325                                  * of this bio. */
 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 */
 329         BIO_REMAPPED,
 330         BIO_ZONE_WRITE_LOCKED,  /* Owns a zoned device zone write lock */
 331         BIO_PERCPU_CACHE,       /* can participate in per-cpu alloc cache */
 332         BIO_FLAG_LAST
 333 };
 334
 335 typedef __u32 __bitwise blk_mq_req_flags_t;
 336
 337 /*
 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.
 340  *
 341  * The least significant bit of the operation number indicates the data
 342  * transfer direction:
 343  *
 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
 346  *
 347  * If a operation does not transfer data the least significant bit has no
 348  * meaning.
 349  */
 350 #define REQ_OP_BITS     8
 351 #define REQ_OP_MASK     ((1 << REQ_OP_BITS) - 1)
 352 #define REQ_FLAG_BITS   24
 353
 354 enum req_opf {
 355         /* read sectors from the device */
 356         REQ_OP_READ             = 0,
 357         /* write sectors to the device */
 358         REQ_OP_WRITE            = 1,
 359         /* flush the volatile write cache */
 360         REQ_OP_FLUSH            = 2,
 361         /* discard sectors */
 362         REQ_OP_DISCARD          = 3,
 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,
 369         /* Open a zone */
 370         REQ_OP_ZONE_OPEN        = 10,
 371         /* Close a zone */
 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,
 381
 382         /* Driver private requests */
 383         REQ_OP_DRV_IN           = 34,
 384         REQ_OP_DRV_OUT          = 35,
 385
 386         REQ_OP_LAST,
 387 };
 388
 389 enum req_flag_bits {
 390         __REQ_FAILFAST_DEV =    /* no driver retries of device errors */
 391                 REQ_OP_BITS,
 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 */
 405         /*
 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.
 411          */
 412         __REQ_CGROUP_PUNT,
 413
 414         /* command specific flags for REQ_OP_WRITE_ZEROES: */
 415         __REQ_NOUNMAP,          /* do not free blocks when zeroing */
 416
 417         __REQ_POLLED,           /* caller polls for completion using bio_poll */
 418
 419         /* for driver use */
 420         __REQ_DRV,
 421         __REQ_SWAP,             /* swapping request. */
 422         __REQ_NR_BITS,          /* stops here */
 423 };
 424
 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)
 440
 441 #define REQ_NOUNMAP             (1ULL << __REQ_NOUNMAP)
 442 #define REQ_POLLED              (1ULL << __REQ_POLLED)
 443
 444 #define REQ_DRV                 (1ULL << __REQ_DRV)
 445 #define REQ_SWAP                (1ULL << __REQ_SWAP)
 446
 447 #define REQ_FAILFAST_MASK \
 448         (REQ_FAILFAST_DEV | REQ_FAILFAST_TRANSPORT | REQ_FAILFAST_DRIVER)
 449
 450 #define REQ_NOMERGE_FLAGS \
 451         (REQ_NOMERGE | REQ_PREFLUSH | REQ_FUA)
 452
 453 enum stat_group {
 454         STAT_READ,
 455         STAT_WRITE,
 456         STAT_DISCARD,
 457         STAT_FLUSH,
 458
 459         NR_STAT_GROUPS
 460 };
 461
 462 #define bio_op(bio) \
 463         ((bio)->bi_opf & REQ_OP_MASK)
 464
 465 /* obsolete, don't use in new code */
 466 static inline void bio_set_op_attrs(struct bio *bio, unsigned op,
 467                 unsigned op_flags)
 468 {
 469         bio->bi_opf = op | op_flags;
 470 }
 471
 472 static inline bool op_is_write(unsigned int op)
 473 {
 474         return (op & 1);
 475 }
 476
 477 /*
 478  * Check if the bio or request is one that needs special treatment in the
 479  * flush state machine.
 480  */
 481 static inline bool op_is_flush(unsigned int op)
 482 {
 483         return op & (REQ_FUA | REQ_PREFLUSH);
 484 }
 485
 486 /*
 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
 489  * REQ_SYNC flag.
 490  */
 491 static inline bool op_is_sync(unsigned int op)
 492 {
 493         return (op & REQ_OP_MASK) == REQ_OP_READ ||
 494                 (op & (REQ_SYNC | REQ_FUA | REQ_PREFLUSH));
 495 }
 496
 497 static inline bool op_is_discard(unsigned int op)
 498 {
 499         return (op & REQ_OP_MASK) == REQ_OP_DISCARD;
 500 }
 501
 502 /*
 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.
 507  */
 508 static inline bool op_is_zone_mgmt(enum req_opf op)
 509 {
 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:
 515                 return true;
 516         default:
 517                 return false;
 518         }
 519 }
 520
 521 static inline int op_stat_group(unsigned int op)
 522 {
 523         if (op_is_discard(op))
 524                 return STAT_DISCARD;
 525         return op_is_write(op);
 526 }
 527
 528 struct blk_rq_stat {
 529         u64 mean;
 530         u64 min;
 531         u64 max;
 532         u32 nr_samples;
 533         u64 batch;
 534 };
 535
 536 #endif /* __LINUX_BLK_TYPES_H */