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/ktime.h>
  12
  13 struct bio_set;
  14 struct bio;
  15 struct bio_integrity_payload;
  16 struct page;
  17 struct io_context;
  18 struct cgroup_subsys_state;
  19 typedef void (bio_end_io_t) (struct bio *);
  20 struct bio_crypt_ctx;
  21
  22 struct block_device {
  23         dev_t                   bd_dev;
  24         int                     bd_openers;
  25         struct inode *          bd_inode;       /* will die */
  26         struct super_block *    bd_super;
  27         struct mutex            bd_mutex;       /* open/close mutex */
  28         void *                  bd_claiming;
  29         void *                  bd_holder;
  30         int                     bd_holders;
  31         bool                    bd_write_holder;
  32 #ifdef CONFIG_SYSFS
  33         struct list_head        bd_holder_disks;
  34 #endif
  35         u8                      bd_partno;
  36         struct hd_struct *      bd_part;
  37         /* number of times partitions within this device have been opened. */
  38         unsigned                bd_part_count;
  39
  40         spinlock_t              bd_size_lock; /* for bd_inode->i_size updates */
  41         struct gendisk *        bd_disk;
  42         struct backing_dev_info *bd_bdi;
  43
  44         /* The counter of freeze processes */
  45         int                     bd_fsfreeze_count;
  46         /* Mutex for freeze */
  47         struct mutex            bd_fsfreeze_mutex;
  48         struct super_block      *bd_fsfreeze_sb;
  49 } __randomize_layout;
  50
  51 #define bdev_whole(_bdev) \
  52         ((_bdev)->bd_disk->part0.bdev)
  53
  54 #define bdev_kobj(_bdev) \
  55         (&part_to_dev((_bdev)->bd_part)->kobj)
  56
  57 /*
  58  * Block error status values.  See block/blk-core:blk_errors for the details.
  59  * Alpha cannot write a byte atomically, so we need to use 32-bit value.
  60  */
  61 #if defined(CONFIG_ALPHA) && !defined(__alpha_bwx__)
  62 typedef u32 __bitwise blk_status_t;
  63 #else
  64 typedef u8 __bitwise blk_status_t;
  65 #endif
  66 #define BLK_STS_OK 0
  67 #define BLK_STS_NOTSUPP         ((__force blk_status_t)1)
  68 #define BLK_STS_TIMEOUT         ((__force blk_status_t)2)
  69 #define BLK_STS_NOSPC           ((__force blk_status_t)3)
  70 #define BLK_STS_TRANSPORT       ((__force blk_status_t)4)
  71 #define BLK_STS_TARGET          ((__force blk_status_t)5)
  72 #define BLK_STS_NEXUS           ((__force blk_status_t)6)
  73 #define BLK_STS_MEDIUM          ((__force blk_status_t)7)
  74 #define BLK_STS_PROTECTION      ((__force blk_status_t)8)
  75 #define BLK_STS_RESOURCE        ((__force blk_status_t)9)
  76 #define BLK_STS_IOERR           ((__force blk_status_t)10)
  77
  78 /* hack for device mapper, don't use elsewhere: */
  79 #define BLK_STS_DM_REQUEUE    ((__force blk_status_t)11)
  80
  81 #define BLK_STS_AGAIN           ((__force blk_status_t)12)
  82
  83 /*
  84  * BLK_STS_DEV_RESOURCE is returned from the driver to the block layer if
  85  * device related resources are unavailable, but the driver can guarantee
  86  * that the queue will be rerun in the future once resources become
  87  * available again. This is typically the case for device specific
  88  * resources that are consumed for IO. If the driver fails allocating these
  89  * resources, we know that inflight (or pending) IO will free these
  90  * resource upon completion.
  91  *
  92  * This is different from BLK_STS_RESOURCE in that it explicitly references
  93  * a device specific resource. For resources of wider scope, allocation
  94  * failure can happen without having pending IO. This means that we can't
  95  * rely on request completions freeing these resources, as IO may not be in
  96  * flight. Examples of that are kernel memory allocations, DMA mappings, or
  97  * any other system wide resources.
  98  */
  99 #define BLK_STS_DEV_RESOURCE    ((__force blk_status_t)13)
 100
 101 /*
 102  * BLK_STS_ZONE_RESOURCE is returned from the driver to the block layer if zone
 103  * related resources are unavailable, but the driver can guarantee the queue
 104  * will be rerun in the future once the resources become available again.
 105  *
 106  * This is different from BLK_STS_DEV_RESOURCE in that it explicitly references
 107  * a zone specific resource and IO to a different zone on the same device could
 108  * still be served. Examples of that are zones that are write-locked, but a read
 109  * to the same zone could be served.
 110  */
 111 #define BLK_STS_ZONE_RESOURCE   ((__force blk_status_t)14)
 112
 113 /*
 114  * BLK_STS_ZONE_OPEN_RESOURCE is returned from the driver in the completion
 115  * path if the device returns a status indicating that too many zone resources
 116  * are currently open. The same command should be successful if resubmitted
 117  * after the number of open zones decreases below the device's limits, which is
 118  * reported in the request_queue's max_open_zones.
 119  */
 120 #define BLK_STS_ZONE_OPEN_RESOURCE      ((__force blk_status_t)15)
 121
 122 /*
 123  * BLK_STS_ZONE_ACTIVE_RESOURCE is returned from the driver in the completion
 124  * path if the device returns a status indicating that too many zone resources
 125  * are currently active. The same command should be successful if resubmitted
 126  * after the number of active zones decreases below the device's limits, which
 127  * is reported in the request_queue's max_active_zones.
 128  */
 129 #define BLK_STS_ZONE_ACTIVE_RESOURCE    ((__force blk_status_t)16)
 130
 131 /**
 132  * blk_path_error - returns true if error may be path related
 133  * @error: status the request was completed with
 134  *
 135  * Description:
 136  *     This classifies block error status into non-retryable errors and ones
 137  *     that may be successful if retried on a failover path.
 138  *
 139  * Return:
 140  *     %false - retrying failover path will not help
 141  *     %true  - may succeed if retried
 142  */
 143 static inline bool blk_path_error(blk_status_t error)
 144 {
 145         switch (error) {
 146         case BLK_STS_NOTSUPP:
 147         case BLK_STS_NOSPC:
 148         case BLK_STS_TARGET:
 149         case BLK_STS_NEXUS:
 150         case BLK_STS_MEDIUM:
 151         case BLK_STS_PROTECTION:
 152                 return false;
 153         }
 154
 155         /* Anything else could be a path failure, so should be retried */
 156         return true;
 157 }
 158
 159 /*
 160  * From most significant bit:
 161  * 1 bit: reserved for other usage, see below
 162  * 12 bits: original size of bio
 163  * 51 bits: issue time of bio
 164  */
 165 #define BIO_ISSUE_RES_BITS      1
 166 #define BIO_ISSUE_SIZE_BITS     12
 167 #define BIO_ISSUE_RES_SHIFT     (64 - BIO_ISSUE_RES_BITS)
 168 #define BIO_ISSUE_SIZE_SHIFT    (BIO_ISSUE_RES_SHIFT - BIO_ISSUE_SIZE_BITS)
 169 #define BIO_ISSUE_TIME_MASK     ((1ULL << BIO_ISSUE_SIZE_SHIFT) - 1)
 170 #define BIO_ISSUE_SIZE_MASK     \
 171         (((1ULL << BIO_ISSUE_SIZE_BITS) - 1) << BIO_ISSUE_SIZE_SHIFT)
 172 #define BIO_ISSUE_RES_MASK      (~((1ULL << BIO_ISSUE_RES_SHIFT) - 1))
 173
 174 /* Reserved bit for blk-throtl */
 175 #define BIO_ISSUE_THROTL_SKIP_LATENCY (1ULL << 63)
 176
 177 struct bio_issue {
 178         u64 value;
 179 };
 180
 181 static inline u64 __bio_issue_time(u64 time)
 182 {
 183         return time & BIO_ISSUE_TIME_MASK;
 184 }
 185
 186 static inline u64 bio_issue_time(struct bio_issue *issue)
 187 {
 188         return __bio_issue_time(issue->value);
 189 }
 190
 191 static inline sector_t bio_issue_size(struct bio_issue *issue)
 192 {
 193         return ((issue->value & BIO_ISSUE_SIZE_MASK) >> BIO_ISSUE_SIZE_SHIFT);
 194 }
 195
 196 static inline void bio_issue_init(struct bio_issue *issue,
 197                                        sector_t size)
 198 {
 199         size &= (1ULL << BIO_ISSUE_SIZE_BITS) - 1;
 200         issue->value = ((issue->value & BIO_ISSUE_RES_MASK) |
 201                         (ktime_get_ns() & BIO_ISSUE_TIME_MASK) |
 202                         ((u64)size << BIO_ISSUE_SIZE_SHIFT));
 203 }
 204
 205 /*
 206  * main unit of I/O for the block layer and lower layers (ie drivers and
 207  * stacking drivers)
 208  */
 209 struct bio {
 210         struct bio              *bi_next;       /* request queue link */
 211         struct gendisk          *bi_disk;
 212         unsigned int            bi_opf;         /* bottom bits req flags,
 213                                                  * top bits REQ_OP. Use
 214                                                  * accessors.
 215                                                  */
 216         unsigned short          bi_flags;       /* status, etc and bvec pool number */
 217         unsigned short          bi_ioprio;
 218         unsigned short          bi_write_hint;
 219         blk_status_t            bi_status;
 220         u8                      bi_partno;
 221         atomic_t                __bi_remaining;
 222
 223         struct bvec_iter        bi_iter;
 224
 225         bio_end_io_t            *bi_end_io;
 226
 227         void                    *bi_private;
 228 #ifdef CONFIG_BLK_CGROUP
 229         /*
 230          * Represents the association of the css and request_queue for the bio.
 231          * If a bio goes direct to device, it will not have a blkg as it will
 232          * not have a request_queue associated with it.  The reference is put
 233          * on release of the bio.
 234          */
 235         struct blkcg_gq         *bi_blkg;
 236         struct bio_issue        bi_issue;
 237 #ifdef CONFIG_BLK_CGROUP_IOCOST
 238         u64                     bi_iocost_cost;
 239 #endif
 240 #endif
 241
 242 #ifdef CONFIG_BLK_INLINE_ENCRYPTION
 243         struct bio_crypt_ctx    *bi_crypt_context;
 244 #endif
 245
 246         union {
 247 #if defined(CONFIG_BLK_DEV_INTEGRITY)
 248                 struct bio_integrity_payload *bi_integrity; /* data integrity */
 249 #endif
 250         };
 251
 252         unsigned short          bi_vcnt;        /* how many bio_vec's */
 253
 254         /*
 255          * Everything starting with bi_max_vecs will be preserved by bio_reset()
 256          */
 257
 258         unsigned short          bi_max_vecs;    /* max bvl_vecs we can hold */
 259
 260         atomic_t                __bi_cnt;       /* pin count */
 261
 262         struct bio_vec          *bi_io_vec;     /* the actual vec list */
 263
 264         struct bio_set          *bi_pool;
 265
 266         /*
 267          * We can inline a number of vecs at the end of the bio, to avoid
 268          * double allocations for a small number of bio_vecs. This member
 269          * MUST obviously be kept at the very end of the bio.
 270          */
 271         struct bio_vec          bi_inline_vecs[];
 272 };
 273
 274 #define BIO_RESET_BYTES         offsetof(struct bio, bi_max_vecs)
 275
 276 /*
 277  * bio flags
 278  */
 279 enum {
 280         BIO_NO_PAGE_REF,        /* don't put release vec pages */
 281         BIO_CLONED,             /* doesn't own data */
 282         BIO_BOUNCED,            /* bio is a bounce bio */
 283         BIO_WORKINGSET,         /* contains userspace workingset pages */
 284         BIO_QUIET,              /* Make BIO Quiet */
 285         BIO_CHAIN,              /* chained bio, ->bi_remaining in effect */
 286         BIO_REFFED,             /* bio has elevated ->bi_cnt */
 287         BIO_THROTTLED,          /* This bio has already been subjected to
 288                                  * throttling rules. Don't do it again. */
 289         BIO_TRACE_COMPLETION,   /* bio_endio() should trace the final completion
 290                                  * of this bio. */
 291         BIO_CGROUP_ACCT,        /* has been accounted to a cgroup */
 292         BIO_TRACKED,            /* set if bio goes through the rq_qos path */
 293         BIO_FLAG_LAST
 294 };
 295
 296 /* See BVEC_POOL_OFFSET below before adding new flags */
 297
 298 /*
 299  * We support 6 different bvec pools, the last one is magic in that it
 300  * is backed by a mempool.
 301  */
 302 #define BVEC_POOL_NR            6
 303 #define BVEC_POOL_MAX           (BVEC_POOL_NR - 1)
 304
 305 /*
 306  * Top 3 bits of bio flags indicate the pool the bvecs came from.  We add
 307  * 1 to the actual index so that 0 indicates that there are no bvecs to be
 308  * freed.
 309  */
 310 #define BVEC_POOL_BITS          (3)
 311 #define BVEC_POOL_OFFSET        (16 - BVEC_POOL_BITS)
 312 #define BVEC_POOL_IDX(bio)      ((bio)->bi_flags >> BVEC_POOL_OFFSET)
 313 #if (1<< BVEC_POOL_BITS) < (BVEC_POOL_NR+1)
 314 # error "BVEC_POOL_BITS is too small"
 315 #endif
 316
 317 /*
 318  * Flags starting here get preserved by bio_reset() - this includes
 319  * only BVEC_POOL_IDX()
 320  */
 321 #define BIO_RESET_BITS  BVEC_POOL_OFFSET
 322
 323 typedef __u32 __bitwise blk_mq_req_flags_t;
 324
 325 /*
 326  * Operations and flags common to the bio and request structures.
 327  * We use 8 bits for encoding the operation, and the remaining 24 for flags.
 328  *
 329  * The least significant bit of the operation number indicates the data
 330  * transfer direction:
 331  *
 332  *   - if the least significant bit is set transfers are TO the device
 333  *   - if the least significant bit is not set transfers are FROM the device
 334  *
 335  * If a operation does not transfer data the least significant bit has no
 336  * meaning.
 337  */
 338 #define REQ_OP_BITS     8
 339 #define REQ_OP_MASK     ((1 << REQ_OP_BITS) - 1)
 340 #define REQ_FLAG_BITS   24
 341
 342 enum req_opf {
 343         /* read sectors from the device */
 344         REQ_OP_READ             = 0,
 345         /* write sectors to the device */
 346         REQ_OP_WRITE            = 1,
 347         /* flush the volatile write cache */
 348         REQ_OP_FLUSH            = 2,
 349         /* discard sectors */
 350         REQ_OP_DISCARD          = 3,
 351         /* securely erase sectors */
 352         REQ_OP_SECURE_ERASE     = 5,
 353         /* write the same sector many times */
 354         REQ_OP_WRITE_SAME       = 7,
 355         /* write the zero filled sector many times */
 356         REQ_OP_WRITE_ZEROES     = 9,
 357         /* Open a zone */
 358         REQ_OP_ZONE_OPEN        = 10,
 359         /* Close a zone */
 360         REQ_OP_ZONE_CLOSE       = 11,
 361         /* Transition a zone to full */
 362         REQ_OP_ZONE_FINISH      = 12,
 363         /* write data at the current zone write pointer */
 364         REQ_OP_ZONE_APPEND      = 13,
 365         /* reset a zone write pointer */
 366         REQ_OP_ZONE_RESET       = 15,
 367         /* reset all the zone present on the device */
 368         REQ_OP_ZONE_RESET_ALL   = 17,
 369
 370         /* SCSI passthrough using struct scsi_request */
 371         REQ_OP_SCSI_IN          = 32,
 372         REQ_OP_SCSI_OUT         = 33,
 373         /* Driver private requests */
 374         REQ_OP_DRV_IN           = 34,
 375         REQ_OP_DRV_OUT          = 35,
 376
 377         REQ_OP_LAST,
 378 };
 379
 380 enum req_flag_bits {
 381         __REQ_FAILFAST_DEV =    /* no driver retries of device errors */
 382                 REQ_OP_BITS,
 383         __REQ_FAILFAST_TRANSPORT, /* no driver retries of transport errors */
 384         __REQ_FAILFAST_DRIVER,  /* no driver retries of driver errors */
 385         __REQ_SYNC,             /* request is sync (sync write or read) */
 386         __REQ_META,             /* metadata io request */
 387         __REQ_PRIO,             /* boost priority in cfq */
 388         __REQ_NOMERGE,          /* don't touch this for merging */
 389         __REQ_IDLE,             /* anticipate more IO after this one */
 390         __REQ_INTEGRITY,        /* I/O includes block integrity payload */
 391         __REQ_FUA,              /* forced unit access */
 392         __REQ_PREFLUSH,         /* request for cache flush */
 393         __REQ_RAHEAD,           /* read ahead, can fail anytime */
 394         __REQ_BACKGROUND,       /* background IO */
 395         __REQ_NOWAIT,           /* Don't wait if request will block */
 396         /*
 397          * When a shared kthread needs to issue a bio for a cgroup, doing
 398          * so synchronously can lead to priority inversions as the kthread
 399          * can be trapped waiting for that cgroup.  CGROUP_PUNT flag makes
 400          * submit_bio() punt the actual issuing to a dedicated per-blkcg
 401          * work item to avoid such priority inversions.
 402          */
 403         __REQ_CGROUP_PUNT,
 404
 405         /* command specific flags for REQ_OP_WRITE_ZEROES: */
 406         __REQ_NOUNMAP,          /* do not free blocks when zeroing */
 407
 408         __REQ_HIPRI,
 409
 410         /* for driver use */
 411         __REQ_DRV,
 412         __REQ_SWAP,             /* swapping request. */
 413         __REQ_NR_BITS,          /* stops here */
 414 };
 415
 416 #define REQ_FAILFAST_DEV        (1ULL << __REQ_FAILFAST_DEV)
 417 #define REQ_FAILFAST_TRANSPORT  (1ULL << __REQ_FAILFAST_TRANSPORT)
 418 #define REQ_FAILFAST_DRIVER     (1ULL << __REQ_FAILFAST_DRIVER)
 419 #define REQ_SYNC                (1ULL << __REQ_SYNC)
 420 #define REQ_META                (1ULL << __REQ_META)
 421 #define REQ_PRIO                (1ULL << __REQ_PRIO)
 422 #define REQ_NOMERGE             (1ULL << __REQ_NOMERGE)
 423 #define REQ_IDLE                (1ULL << __REQ_IDLE)
 424 #define REQ_INTEGRITY           (1ULL << __REQ_INTEGRITY)
 425 #define REQ_FUA                 (1ULL << __REQ_FUA)
 426 #define REQ_PREFLUSH            (1ULL << __REQ_PREFLUSH)
 427 #define REQ_RAHEAD              (1ULL << __REQ_RAHEAD)
 428 #define REQ_BACKGROUND          (1ULL << __REQ_BACKGROUND)
 429 #define REQ_NOWAIT              (1ULL << __REQ_NOWAIT)
 430 #define REQ_CGROUP_PUNT         (1ULL << __REQ_CGROUP_PUNT)
 431
 432 #define REQ_NOUNMAP             (1ULL << __REQ_NOUNMAP)
 433 #define REQ_HIPRI               (1ULL << __REQ_HIPRI)
 434
 435 #define REQ_DRV                 (1ULL << __REQ_DRV)
 436 #define REQ_SWAP                (1ULL << __REQ_SWAP)
 437
 438 #define REQ_FAILFAST_MASK \
 439         (REQ_FAILFAST_DEV | REQ_FAILFAST_TRANSPORT | REQ_FAILFAST_DRIVER)
 440
 441 #define REQ_NOMERGE_FLAGS \
 442         (REQ_NOMERGE | REQ_PREFLUSH | REQ_FUA)
 443
 444 enum stat_group {
 445         STAT_READ,
 446         STAT_WRITE,
 447         STAT_DISCARD,
 448         STAT_FLUSH,
 449
 450         NR_STAT_GROUPS
 451 };
 452
 453 #define bio_op(bio) \
 454         ((bio)->bi_opf & REQ_OP_MASK)
 455 #define req_op(req) \
 456         ((req)->cmd_flags & REQ_OP_MASK)
 457
 458 /* obsolete, don't use in new code */
 459 static inline void bio_set_op_attrs(struct bio *bio, unsigned op,
 460                 unsigned op_flags)
 461 {
 462         bio->bi_opf = op | op_flags;
 463 }
 464
 465 static inline bool op_is_write(unsigned int op)
 466 {
 467         return (op & 1);
 468 }
 469
 470 /*
 471  * Check if the bio or request is one that needs special treatment in the
 472  * flush state machine.
 473  */
 474 static inline bool op_is_flush(unsigned int op)
 475 {
 476         return op & (REQ_FUA | REQ_PREFLUSH);
 477 }
 478
 479 /*
 480  * Reads are always treated as synchronous, as are requests with the FUA or
 481  * PREFLUSH flag.  Other operations may be marked as synchronous using the
 482  * REQ_SYNC flag.
 483  */
 484 static inline bool op_is_sync(unsigned int op)
 485 {
 486         return (op & REQ_OP_MASK) == REQ_OP_READ ||
 487                 (op & (REQ_SYNC | REQ_FUA | REQ_PREFLUSH));
 488 }
 489
 490 static inline bool op_is_discard(unsigned int op)
 491 {
 492         return (op & REQ_OP_MASK) == REQ_OP_DISCARD;
 493 }
 494
 495 /*
 496  * Check if a bio or request operation is a zone management operation, with
 497  * the exception of REQ_OP_ZONE_RESET_ALL which is treated as a special case
 498  * due to its different handling in the block layer and device response in
 499  * case of command failure.
 500  */
 501 static inline bool op_is_zone_mgmt(enum req_opf op)
 502 {
 503         switch (op & REQ_OP_MASK) {
 504         case REQ_OP_ZONE_RESET:
 505         case REQ_OP_ZONE_OPEN:
 506         case REQ_OP_ZONE_CLOSE:
 507         case REQ_OP_ZONE_FINISH:
 508                 return true;
 509         default:
 510                 return false;
 511         }
 512 }
 513
 514 static inline int op_stat_group(unsigned int op)
 515 {
 516         if (op_is_discard(op))
 517                 return STAT_DISCARD;
 518         return op_is_write(op);
 519 }
 520
 521 typedef unsigned int blk_qc_t;
 522 #define BLK_QC_T_NONE           -1U
 523 #define BLK_QC_T_SHIFT          16
 524 #define BLK_QC_T_INTERNAL       (1U << 31)
 525
 526 static inline bool blk_qc_t_valid(blk_qc_t cookie)
 527 {
 528         return cookie != BLK_QC_T_NONE;
 529 }
 530
 531 static inline unsigned int blk_qc_t_to_queue_num(blk_qc_t cookie)
 532 {
 533         return (cookie & ~BLK_QC_T_INTERNAL) >> BLK_QC_T_SHIFT;
 534 }
 535
 536 static inline unsigned int blk_qc_t_to_tag(blk_qc_t cookie)
 537 {
 538         return cookie & ((1u << BLK_QC_T_SHIFT) - 1);
 539 }
 540
 541 static inline bool blk_qc_t_is_internal(blk_qc_t cookie)
 542 {
 543         return (cookie & BLK_QC_T_INTERNAL) != 0;
 544 }
 545
 546 struct blk_rq_stat {
 547         u64 mean;
 548         u64 min;
 549         u64 max;
 550         u32 nr_samples;
 551         u64 batch;
 552 };
 553
 554 #endif /* __LINUX_BLK_TYPES_H */