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