include/linux/blkdev.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /*
   3  * Portions Copyright (C) 1992 Drew Eckhardt
   4  */
   5 #ifndef _LINUX_BLKDEV_H
   6 #define _LINUX_BLKDEV_H
   7
   8 #include <linux/types.h>
   9 #include <linux/blk_types.h>
  10 #include <linux/device.h>
  11 #include <linux/list.h>
  12 #include <linux/llist.h>
  13 #include <linux/minmax.h>
  14 #include <linux/timer.h>
  15 #include <linux/workqueue.h>
  16 #include <linux/wait.h>
  17 #include <linux/bio.h>
  18 #include <linux/gfp.h>
  19 #include <linux/kdev_t.h>
  20 #include <linux/rcupdate.h>
  21 #include <linux/percpu-refcount.h>
  22 #include <linux/blkzoned.h>
  23 #include <linux/sched.h>
  24 #include <linux/sbitmap.h>
  25 #include <linux/uuid.h>
  26 #include <linux/xarray.h>
  27 #include <linux/file.h>
  28
  29 struct module;
  30 struct request_queue;
  31 struct elevator_queue;
  32 struct blk_trace;
  33 struct request;
  34 struct sg_io_hdr;
  35 struct blkcg_gq;
  36 struct blk_flush_queue;
  37 struct kiocb;
  38 struct pr_ops;
  39 struct rq_qos;
  40 struct blk_queue_stats;
  41 struct blk_stat_callback;
  42 struct blk_crypto_profile;
  43
  44 extern const struct device_type disk_type;
  45 extern const struct device_type part_type;
  46 extern const struct class block_class;
  47
  48 /*
  49  * Maximum number of blkcg policies allowed to be registered concurrently.
  50  * Defined here to simplify include dependency.
  51  */
  52 #define BLKCG_MAX_POLS          6
  53
  54 #define DISK_MAX_PARTS                  256
  55 #define DISK_NAME_LEN                   32
  56
  57 #define PARTITION_META_INFO_VOLNAMELTH  64
  58 /*
  59  * Enough for the string representation of any kind of UUID plus NULL.
  60  * EFI UUID is 36 characters. MSDOS UUID is 11 characters.
  61  */
  62 #define PARTITION_META_INFO_UUIDLTH     (UUID_STRING_LEN + 1)
  63
  64 struct partition_meta_info {
  65         char uuid[PARTITION_META_INFO_UUIDLTH];
  66         u8 volname[PARTITION_META_INFO_VOLNAMELTH];
  67 };
  68
  69 /**
  70  * DOC: genhd capability flags
  71  *
  72  * ``GENHD_FL_REMOVABLE``: indicates that the block device gives access to
  73  * removable media.  When set, the device remains present even when media is not
  74  * inserted.  Shall not be set for devices which are removed entirely when the
  75  * media is removed.
  76  *
  77  * ``GENHD_FL_HIDDEN``: the block device is hidden; it doesn't produce events,
  78  * doesn't appear in sysfs, and can't be opened from userspace or using
  79  * blkdev_get*. Used for the underlying components of multipath devices.
  80  *
  81  * ``GENHD_FL_NO_PART``: partition support is disabled.  The kernel will not
  82  * scan for partitions from add_disk, and users can't add partitions manually.
  83  *
  84  */
  85 enum {
  86         GENHD_FL_REMOVABLE                      = 1 << 0,
  87         GENHD_FL_HIDDEN                         = 1 << 1,
  88         GENHD_FL_NO_PART                        = 1 << 2,
  89 };
  90
  91 enum {
  92         DISK_EVENT_MEDIA_CHANGE                 = 1 << 0, /* media changed */
  93         DISK_EVENT_EJECT_REQUEST                = 1 << 1, /* eject requested */
  94 };
  95
  96 enum {
  97         /* Poll even if events_poll_msecs is unset */
  98         DISK_EVENT_FLAG_POLL                    = 1 << 0,
  99         /* Forward events to udev */
 100         DISK_EVENT_FLAG_UEVENT                  = 1 << 1,
 101         /* Block event polling when open for exclusive write */
 102         DISK_EVENT_FLAG_BLOCK_ON_EXCL_WRITE     = 1 << 2,
 103 };
 104
 105 struct disk_events;
 106 struct badblocks;
 107
 108 struct blk_integrity {
 109         const struct blk_integrity_profile      *profile;
 110         unsigned char                           flags;
 111         unsigned char                           tuple_size;
 112         unsigned char                           pi_offset;
 113         unsigned char                           interval_exp;
 114         unsigned char                           tag_size;
 115 };
 116
 117 typedef unsigned int __bitwise blk_mode_t;
 118
 119 /* open for reading */
 120 #define BLK_OPEN_READ           ((__force blk_mode_t)(1 << 0))
 121 /* open for writing */
 122 #define BLK_OPEN_WRITE          ((__force blk_mode_t)(1 << 1))
 123 /* open exclusively (vs other exclusive openers */
 124 #define BLK_OPEN_EXCL           ((__force blk_mode_t)(1 << 2))
 125 /* opened with O_NDELAY */
 126 #define BLK_OPEN_NDELAY         ((__force blk_mode_t)(1 << 3))
 127 /* open for "writes" only for ioctls (specialy hack for floppy.c) */
 128 #define BLK_OPEN_WRITE_IOCTL    ((__force blk_mode_t)(1 << 4))
 129 /* open is exclusive wrt all other BLK_OPEN_WRITE opens to the device */
 130 #define BLK_OPEN_RESTRICT_WRITES        ((__force blk_mode_t)(1 << 5))
 131 /* return partition scanning errors */
 132 #define BLK_OPEN_STRICT_SCAN    ((__force blk_mode_t)(1 << 6))
 133
 134 struct gendisk {
 135         /*
 136          * major/first_minor/minors should not be set by any new driver, the
 137          * block core will take care of allocating them automatically.
 138          */
 139         int major;
 140         int first_minor;
 141         int minors;
 142
 143         char disk_name[DISK_NAME_LEN];  /* name of major driver */
 144
 145         unsigned short events;          /* supported events */
 146         unsigned short event_flags;     /* flags related to event processing */
 147
 148         struct xarray part_tbl;
 149         struct block_device *part0;
 150
 151         const struct block_device_operations *fops;
 152         struct request_queue *queue;
 153         void *private_data;
 154
 155         struct bio_set bio_split;
 156
 157         int flags;
 158         unsigned long state;
 159 #define GD_NEED_PART_SCAN               0
 160 #define GD_READ_ONLY                    1
 161 #define GD_DEAD                         2
 162 #define GD_NATIVE_CAPACITY              3
 163 #define GD_ADDED                        4
 164 #define GD_SUPPRESS_PART_SCAN           5
 165 #define GD_OWNS_QUEUE                   6
 166
 167         struct mutex open_mutex;        /* open/close mutex */
 168         unsigned open_partitions;       /* number of open partitions */
 169
 170         struct backing_dev_info *bdi;
 171         struct kobject queue_kobj;      /* the queue/ directory */
 172         struct kobject *slave_dir;
 173 #ifdef CONFIG_BLOCK_HOLDER_DEPRECATED
 174         struct list_head slave_bdevs;
 175 #endif
 176         struct timer_rand_state *random;
 177         atomic_t sync_io;               /* RAID */
 178         struct disk_events *ev;
 179
 180 #ifdef CONFIG_BLK_DEV_ZONED
 181         /*
 182          * Zoned block device information for request dispatch control.
 183          * nr_zones is the total number of zones of the device. This is always
 184          * 0 for regular block devices. conv_zones_bitmap is a bitmap of nr_zones
 185          * bits which indicates if a zone is conventional (bit set) or
 186          * sequential (bit clear). seq_zones_wlock is a bitmap of nr_zones
 187          * bits which indicates if a zone is write locked, that is, if a write
 188          * request targeting the zone was dispatched.
 189          *
 190          * Reads of this information must be protected with blk_queue_enter() /
 191          * blk_queue_exit(). Modifying this information is only allowed while
 192          * no requests are being processed. See also blk_mq_freeze_queue() and
 193          * blk_mq_unfreeze_queue().
 194          */
 195         unsigned int            nr_zones;
 196         unsigned long           *conv_zones_bitmap;
 197         unsigned long           *seq_zones_wlock;
 198 #endif /* CONFIG_BLK_DEV_ZONED */
 199
 200 #if IS_ENABLED(CONFIG_CDROM)
 201         struct cdrom_device_info *cdi;
 202 #endif
 203         int node_id;
 204         struct badblocks *bb;
 205         struct lockdep_map lockdep_map;
 206         u64 diskseq;
 207         blk_mode_t open_mode;
 208
 209         /*
 210          * Independent sector access ranges. This is always NULL for
 211          * devices that do not have multiple independent access ranges.
 212          */
 213         struct blk_independent_access_ranges *ia_ranges;
 214 };
 215
 216 static inline bool disk_live(struct gendisk *disk)
 217 {
 218         return !inode_unhashed(disk->part0->bd_inode);
 219 }
 220
 221 /**
 222  * disk_openers - returns how many openers are there for a disk
 223  * @disk: disk to check
 224  *
 225  * This returns the number of openers for a disk.  Note that this value is only
 226  * stable if disk->open_mutex is held.
 227  *
 228  * Note: Due to a quirk in the block layer open code, each open partition is
 229  * only counted once even if there are multiple openers.
 230  */
 231 static inline unsigned int disk_openers(struct gendisk *disk)
 232 {
 233         return atomic_read(&disk->part0->bd_openers);
 234 }
 235
 236 /**
 237  * disk_has_partscan - return %true if partition scanning is enabled on a disk
 238  * @disk: disk to check
 239  *
 240  * Returns %true if partitions scanning is enabled for @disk, or %false if
 241  * partition scanning is disabled either permanently or temporarily.
 242  */
 243 static inline bool disk_has_partscan(struct gendisk *disk)
 244 {
 245         return !(disk->flags & (GENHD_FL_NO_PART | GENHD_FL_HIDDEN)) &&
 246                 !test_bit(GD_SUPPRESS_PART_SCAN, &disk->state);
 247 }
 248
 249 /*
 250  * The gendisk is refcounted by the part0 block_device, and the bd_device
 251  * therein is also used for device model presentation in sysfs.
 252  */
 253 #define dev_to_disk(device) \
 254         (dev_to_bdev(device)->bd_disk)
 255 #define disk_to_dev(disk) \
 256         (&((disk)->part0->bd_device))
 257
 258 #if IS_REACHABLE(CONFIG_CDROM)
 259 #define disk_to_cdi(disk)       ((disk)->cdi)
 260 #else
 261 #define disk_to_cdi(disk)       NULL
 262 #endif
 263
 264 static inline dev_t disk_devt(struct gendisk *disk)
 265 {
 266         return MKDEV(disk->major, disk->first_minor);
 267 }
 268
 269 static inline int blk_validate_block_size(unsigned long bsize)
 270 {
 271         if (bsize < 512 || bsize > PAGE_SIZE || !is_power_of_2(bsize))
 272                 return -EINVAL;
 273
 274         return 0;
 275 }
 276
 277 static inline bool blk_op_is_passthrough(blk_opf_t op)
 278 {
 279         op &= REQ_OP_MASK;
 280         return op == REQ_OP_DRV_IN || op == REQ_OP_DRV_OUT;
 281 }
 282
 283 /*
 284  * BLK_BOUNCE_NONE:     never bounce (default)
 285  * BLK_BOUNCE_HIGH:     bounce all highmem pages
 286  */
 287 enum blk_bounce {
 288         BLK_BOUNCE_NONE,
 289         BLK_BOUNCE_HIGH,
 290 };
 291
 292 struct queue_limits {
 293         enum blk_bounce         bounce;
 294         unsigned long           seg_boundary_mask;
 295         unsigned long           virt_boundary_mask;
 296
 297         unsigned int            max_hw_sectors;
 298         unsigned int            max_dev_sectors;
 299         unsigned int            chunk_sectors;
 300         unsigned int            max_sectors;
 301         unsigned int            max_user_sectors;
 302         unsigned int            max_segment_size;
 303         unsigned int            physical_block_size;
 304         unsigned int            logical_block_size;
 305         unsigned int            alignment_offset;
 306         unsigned int            io_min;
 307         unsigned int            io_opt;
 308         unsigned int            max_discard_sectors;
 309         unsigned int            max_hw_discard_sectors;
 310         unsigned int            max_user_discard_sectors;
 311         unsigned int            max_secure_erase_sectors;
 312         unsigned int            max_write_zeroes_sectors;
 313         unsigned int            max_zone_append_sectors;
 314         unsigned int            discard_granularity;
 315         unsigned int            discard_alignment;
 316         unsigned int            zone_write_granularity;
 317
 318         unsigned short          max_segments;
 319         unsigned short          max_integrity_segments;
 320         unsigned short          max_discard_segments;
 321
 322         unsigned char           misaligned;
 323         unsigned char           discard_misaligned;
 324         unsigned char           raid_partial_stripes_expensive;
 325         bool                    zoned;
 326         unsigned int            max_open_zones;
 327         unsigned int            max_active_zones;
 328
 329         /*
 330          * Drivers that set dma_alignment to less than 511 must be prepared to
 331          * handle individual bvec's that are not a multiple of a SECTOR_SIZE
 332          * due to possible offsets.
 333          */
 334         unsigned int            dma_alignment;
 335 };
 336
 337 typedef int (*report_zones_cb)(struct blk_zone *zone, unsigned int idx,
 338                                void *data);
 339
 340 void disk_set_zoned(struct gendisk *disk);
 341
 342 #define BLK_ALL_ZONES  ((unsigned int)-1)
 343 int blkdev_report_zones(struct block_device *bdev, sector_t sector,
 344                 unsigned int nr_zones, report_zones_cb cb, void *data);
 345 int blkdev_zone_mgmt(struct block_device *bdev, enum req_op op,
 346                 sector_t sectors, sector_t nr_sectors);
 347 int blk_revalidate_disk_zones(struct gendisk *disk,
 348                 void (*update_driver_data)(struct gendisk *disk));
 349
 350 /*
 351  * Independent access ranges: struct blk_independent_access_range describes
 352  * a range of contiguous sectors that can be accessed using device command
 353  * execution resources that are independent from the resources used for
 354  * other access ranges. This is typically found with single-LUN multi-actuator
 355  * HDDs where each access range is served by a different set of heads.
 356  * The set of independent ranges supported by the device is defined using
 357  * struct blk_independent_access_ranges. The independent ranges must not overlap
 358  * and must include all sectors within the disk capacity (no sector holes
 359  * allowed).
 360  * For a device with multiple ranges, requests targeting sectors in different
 361  * ranges can be executed in parallel. A request can straddle an access range
 362  * boundary.
 363  */
 364 struct blk_independent_access_range {
 365         struct kobject          kobj;
 366         sector_t                sector;
 367         sector_t                nr_sectors;
 368 };
 369
 370 struct blk_independent_access_ranges {
 371         struct kobject                          kobj;
 372         bool                                    sysfs_registered;
 373         unsigned int                            nr_ia_ranges;
 374         struct blk_independent_access_range     ia_range[];
 375 };
 376
 377 struct request_queue {
 378         /*
 379          * The queue owner gets to use this for whatever they like.
 380          * ll_rw_blk doesn't touch it.
 381          */
 382         void                    *queuedata;
 383
 384         struct elevator_queue   *elevator;
 385
 386         const struct blk_mq_ops *mq_ops;
 387
 388         /* sw queues */
 389         struct blk_mq_ctx __percpu      *queue_ctx;
 390
 391         /*
 392          * various queue flags, see QUEUE_* below
 393          */
 394         unsigned long           queue_flags;
 395
 396         unsigned int            rq_timeout;
 397
 398         unsigned int            queue_depth;
 399
 400         refcount_t              refs;
 401
 402         /* hw dispatch queues */
 403         unsigned int            nr_hw_queues;
 404         struct xarray           hctx_table;
 405
 406         struct percpu_ref       q_usage_counter;
 407
 408         struct request          *last_merge;
 409
 410         spinlock_t              queue_lock;
 411
 412         int                     quiesce_depth;
 413
 414         struct gendisk          *disk;
 415
 416         /*
 417          * mq queue kobject
 418          */
 419         struct kobject *mq_kobj;
 420
 421         struct queue_limits     limits;
 422
 423 #ifdef  CONFIG_BLK_DEV_INTEGRITY
 424         struct blk_integrity integrity;
 425 #endif  /* CONFIG_BLK_DEV_INTEGRITY */
 426
 427 #ifdef CONFIG_PM
 428         struct device           *dev;
 429         enum rpm_status         rpm_status;
 430 #endif
 431
 432         /*
 433          * Number of contexts that have called blk_set_pm_only(). If this
 434          * counter is above zero then only RQF_PM requests are processed.
 435          */
 436         atomic_t                pm_only;
 437
 438         struct blk_queue_stats  *stats;
 439         struct rq_qos           *rq_qos;
 440         struct mutex            rq_qos_mutex;
 441
 442         /*
 443          * ida allocated id for this queue.  Used to index queues from
 444          * ioctx.
 445          */
 446         int                     id;
 447
 448         unsigned int            dma_pad_mask;
 449
 450         /*
 451          * queue settings
 452          */
 453         unsigned long           nr_requests;    /* Max # of requests */
 454
 455 #ifdef CONFIG_BLK_INLINE_ENCRYPTION
 456         struct blk_crypto_profile *crypto_profile;
 457         struct kobject *crypto_kobject;
 458 #endif
 459
 460         struct timer_list       timeout;
 461         struct work_struct      timeout_work;
 462
 463         atomic_t                nr_active_requests_shared_tags;
 464
 465         unsigned int            required_elevator_features;
 466
 467         struct blk_mq_tags      *sched_shared_tags;
 468
 469         struct list_head        icq_list;
 470 #ifdef CONFIG_BLK_CGROUP
 471         DECLARE_BITMAP          (blkcg_pols, BLKCG_MAX_POLS);
 472         struct blkcg_gq         *root_blkg;
 473         struct list_head        blkg_list;
 474         struct mutex            blkcg_mutex;
 475 #endif
 476
 477         int                     node;
 478
 479         spinlock_t              requeue_lock;
 480         struct list_head        requeue_list;
 481         struct delayed_work     requeue_work;
 482
 483 #ifdef CONFIG_BLK_DEV_IO_TRACE
 484         struct blk_trace __rcu  *blk_trace;
 485 #endif
 486         /*
 487          * for flush operations
 488          */
 489         struct blk_flush_queue  *fq;
 490         struct list_head        flush_list;
 491
 492         struct mutex            sysfs_lock;
 493         struct mutex            sysfs_dir_lock;
 494         struct mutex            limits_lock;
 495
 496         /*
 497          * for reusing dead hctx instance in case of updating
 498          * nr_hw_queues
 499          */
 500         struct list_head        unused_hctx_list;
 501         spinlock_t              unused_hctx_lock;
 502
 503         int                     mq_freeze_depth;
 504
 505 #ifdef CONFIG_BLK_DEV_THROTTLING
 506         /* Throttle data */
 507         struct throtl_data *td;
 508 #endif
 509         struct rcu_head         rcu_head;
 510         wait_queue_head_t       mq_freeze_wq;
 511         /*
 512          * Protect concurrent access to q_usage_counter by
 513          * percpu_ref_kill() and percpu_ref_reinit().
 514          */
 515         struct mutex            mq_freeze_lock;
 516
 517         struct blk_mq_tag_set   *tag_set;
 518         struct list_head        tag_set_list;
 519
 520         struct dentry           *debugfs_dir;
 521         struct dentry           *sched_debugfs_dir;
 522         struct dentry           *rqos_debugfs_dir;
 523         /*
 524          * Serializes all debugfs metadata operations using the above dentries.
 525          */
 526         struct mutex            debugfs_mutex;
 527
 528         bool                    mq_sysfs_init_done;
 529 };
 530
 531 /* Keep blk_queue_flag_name[] in sync with the definitions below */
 532 #define QUEUE_FLAG_STOPPED      0       /* queue is stopped */
 533 #define QUEUE_FLAG_DYING        1       /* queue being torn down */
 534 #define QUEUE_FLAG_NOMERGES     3       /* disable merge attempts */
 535 #define QUEUE_FLAG_SAME_COMP    4       /* complete on same CPU-group */
 536 #define QUEUE_FLAG_FAIL_IO      5       /* fake timeout */
 537 #define QUEUE_FLAG_NONROT       6       /* non-rotational device (SSD) */
 538 #define QUEUE_FLAG_VIRT         QUEUE_FLAG_NONROT /* paravirt device */
 539 #define QUEUE_FLAG_IO_STAT      7       /* do disk/partitions IO accounting */
 540 #define QUEUE_FLAG_NOXMERGES    9       /* No extended merges */
 541 #define QUEUE_FLAG_ADD_RANDOM   10      /* Contributes to random pool */
 542 #define QUEUE_FLAG_SYNCHRONOUS  11      /* always completes in submit context */
 543 #define QUEUE_FLAG_SAME_FORCE   12      /* force complete on same CPU */
 544 #define QUEUE_FLAG_HW_WC        13      /* Write back caching supported */
 545 #define QUEUE_FLAG_INIT_DONE    14      /* queue is initialized */
 546 #define QUEUE_FLAG_STABLE_WRITES 15     /* don't modify blks until WB is done */
 547 #define QUEUE_FLAG_POLL         16      /* IO polling enabled if set */
 548 #define QUEUE_FLAG_WC           17      /* Write back caching */
 549 #define QUEUE_FLAG_FUA          18      /* device supports FUA writes */
 550 #define QUEUE_FLAG_DAX          19      /* device supports DAX */
 551 #define QUEUE_FLAG_STATS        20      /* track IO start and completion times */
 552 #define QUEUE_FLAG_REGISTERED   22      /* queue has been registered to a disk */
 553 #define QUEUE_FLAG_QUIESCED     24      /* queue has been quiesced */
 554 #define QUEUE_FLAG_PCI_P2PDMA   25      /* device supports PCI p2p requests */
 555 #define QUEUE_FLAG_ZONE_RESETALL 26     /* supports Zone Reset All */
 556 #define QUEUE_FLAG_RQ_ALLOC_TIME 27     /* record rq->alloc_time_ns */
 557 #define QUEUE_FLAG_HCTX_ACTIVE  28      /* at least one blk-mq hctx is active */
 558 #define QUEUE_FLAG_NOWAIT       29      /* device supports NOWAIT */
 559 #define QUEUE_FLAG_SQ_SCHED     30      /* single queue style io dispatch */
 560 #define QUEUE_FLAG_SKIP_TAGSET_QUIESCE  31 /* quiesce_tagset skip the queue*/
 561
 562 #define QUEUE_FLAG_MQ_DEFAULT   ((1UL << QUEUE_FLAG_IO_STAT) |          \
 563                                  (1UL << QUEUE_FLAG_SAME_COMP) |        \
 564                                  (1UL << QUEUE_FLAG_NOWAIT))
 565
 566 void blk_queue_flag_set(unsigned int flag, struct request_queue *q);
 567 void blk_queue_flag_clear(unsigned int flag, struct request_queue *q);
 568 bool blk_queue_flag_test_and_set(unsigned int flag, struct request_queue *q);
 569
 570 #define blk_queue_stopped(q)    test_bit(QUEUE_FLAG_STOPPED, &(q)->queue_flags)
 571 #define blk_queue_dying(q)      test_bit(QUEUE_FLAG_DYING, &(q)->queue_flags)
 572 #define blk_queue_init_done(q)  test_bit(QUEUE_FLAG_INIT_DONE, &(q)->queue_flags)
 573 #define blk_queue_nomerges(q)   test_bit(QUEUE_FLAG_NOMERGES, &(q)->queue_flags)
 574 #define blk_queue_noxmerges(q)  \
 575         test_bit(QUEUE_FLAG_NOXMERGES, &(q)->queue_flags)
 576 #define blk_queue_nonrot(q)     test_bit(QUEUE_FLAG_NONROT, &(q)->queue_flags)
 577 #define blk_queue_stable_writes(q) \
 578         test_bit(QUEUE_FLAG_STABLE_WRITES, &(q)->queue_flags)
 579 #define blk_queue_io_stat(q)    test_bit(QUEUE_FLAG_IO_STAT, &(q)->queue_flags)
 580 #define blk_queue_add_random(q) test_bit(QUEUE_FLAG_ADD_RANDOM, &(q)->queue_flags)
 581 #define blk_queue_zone_resetall(q)      \
 582         test_bit(QUEUE_FLAG_ZONE_RESETALL, &(q)->queue_flags)
 583 #define blk_queue_dax(q)        test_bit(QUEUE_FLAG_DAX, &(q)->queue_flags)
 584 #define blk_queue_pci_p2pdma(q) \
 585         test_bit(QUEUE_FLAG_PCI_P2PDMA, &(q)->queue_flags)
 586 #ifdef CONFIG_BLK_RQ_ALLOC_TIME
 587 #define blk_queue_rq_alloc_time(q)      \
 588         test_bit(QUEUE_FLAG_RQ_ALLOC_TIME, &(q)->queue_flags)
 589 #else
 590 #define blk_queue_rq_alloc_time(q)      false
 591 #endif
 592
 593 #define blk_noretry_request(rq) \
 594         ((rq)->cmd_flags & (REQ_FAILFAST_DEV|REQ_FAILFAST_TRANSPORT| \
 595                              REQ_FAILFAST_DRIVER))
 596 #define blk_queue_quiesced(q)   test_bit(QUEUE_FLAG_QUIESCED, &(q)->queue_flags)
 597 #define blk_queue_pm_only(q)    atomic_read(&(q)->pm_only)
 598 #define blk_queue_registered(q) test_bit(QUEUE_FLAG_REGISTERED, &(q)->queue_flags)
 599 #define blk_queue_sq_sched(q)   test_bit(QUEUE_FLAG_SQ_SCHED, &(q)->queue_flags)
 600 #define blk_queue_skip_tagset_quiesce(q) \
 601         test_bit(QUEUE_FLAG_SKIP_TAGSET_QUIESCE, &(q)->queue_flags)
 602
 603 extern void blk_set_pm_only(struct request_queue *q);
 604 extern void blk_clear_pm_only(struct request_queue *q);
 605
 606 #define list_entry_rq(ptr)      list_entry((ptr), struct request, queuelist)
 607
 608 #define dma_map_bvec(dev, bv, dir, attrs) \
 609         dma_map_page_attrs(dev, (bv)->bv_page, (bv)->bv_offset, (bv)->bv_len, \
 610         (dir), (attrs))
 611
 612 static inline bool queue_is_mq(struct request_queue *q)
 613 {
 614         return q->mq_ops;
 615 }
 616
 617 #ifdef CONFIG_PM
 618 static inline enum rpm_status queue_rpm_status(struct request_queue *q)
 619 {
 620         return q->rpm_status;
 621 }
 622 #else
 623 static inline enum rpm_status queue_rpm_status(struct request_queue *q)
 624 {
 625         return RPM_ACTIVE;
 626 }
 627 #endif
 628
 629 static inline bool blk_queue_is_zoned(struct request_queue *q)
 630 {
 631         return IS_ENABLED(CONFIG_BLK_DEV_ZONED) && q->limits.zoned;
 632 }
 633
 634 #ifdef CONFIG_BLK_DEV_ZONED
 635 unsigned int bdev_nr_zones(struct block_device *bdev);
 636
 637 static inline unsigned int disk_nr_zones(struct gendisk *disk)
 638 {
 639         return blk_queue_is_zoned(disk->queue) ? disk->nr_zones : 0;
 640 }
 641
 642 static inline unsigned int disk_zone_no(struct gendisk *disk, sector_t sector)
 643 {
 644         if (!blk_queue_is_zoned(disk->queue))
 645                 return 0;
 646         return sector >> ilog2(disk->queue->limits.chunk_sectors);
 647 }
 648
 649 static inline bool disk_zone_is_seq(struct gendisk *disk, sector_t sector)
 650 {
 651         if (!blk_queue_is_zoned(disk->queue))
 652                 return false;
 653         if (!disk->conv_zones_bitmap)
 654                 return true;
 655         return !test_bit(disk_zone_no(disk, sector), disk->conv_zones_bitmap);
 656 }
 657
 658 static inline void disk_set_max_open_zones(struct gendisk *disk,
 659                 unsigned int max_open_zones)
 660 {
 661         disk->queue->limits.max_open_zones = max_open_zones;
 662 }
 663
 664 static inline void disk_set_max_active_zones(struct gendisk *disk,
 665                 unsigned int max_active_zones)
 666 {
 667         disk->queue->limits.max_active_zones = max_active_zones;
 668 }
 669
 670 static inline unsigned int bdev_max_open_zones(struct block_device *bdev)
 671 {
 672         return bdev->bd_disk->queue->limits.max_open_zones;
 673 }
 674
 675 static inline unsigned int bdev_max_active_zones(struct block_device *bdev)
 676 {
 677         return bdev->bd_disk->queue->limits.max_active_zones;
 678 }
 679
 680 #else /* CONFIG_BLK_DEV_ZONED */
 681 static inline unsigned int bdev_nr_zones(struct block_device *bdev)
 682 {
 683         return 0;
 684 }
 685
 686 static inline unsigned int disk_nr_zones(struct gendisk *disk)
 687 {
 688         return 0;
 689 }
 690 static inline bool disk_zone_is_seq(struct gendisk *disk, sector_t sector)
 691 {
 692         return false;
 693 }
 694 static inline unsigned int disk_zone_no(struct gendisk *disk, sector_t sector)
 695 {
 696         return 0;
 697 }
 698 static inline unsigned int bdev_max_open_zones(struct block_device *bdev)
 699 {
 700         return 0;
 701 }
 702
 703 static inline unsigned int bdev_max_active_zones(struct block_device *bdev)
 704 {
 705         return 0;
 706 }
 707 #endif /* CONFIG_BLK_DEV_ZONED */
 708
 709 static inline unsigned int blk_queue_depth(struct request_queue *q)
 710 {
 711         if (q->queue_depth)
 712                 return q->queue_depth;
 713
 714         return q->nr_requests;
 715 }
 716
 717 /*
 718  * default timeout for SG_IO if none specified
 719  */
 720 #define BLK_DEFAULT_SG_TIMEOUT  (60 * HZ)
 721 #define BLK_MIN_SG_TIMEOUT      (7 * HZ)
 722
 723 /* This should not be used directly - use rq_for_each_segment */
 724 #define for_each_bio(_bio)              \
 725         for (; _bio; _bio = _bio->bi_next)
 726
 727 int __must_check device_add_disk(struct device *parent, struct gendisk *disk,
 728                                  const struct attribute_group **groups);
 729 static inline int __must_check add_disk(struct gendisk *disk)
 730 {
 731         return device_add_disk(NULL, disk, NULL);
 732 }
 733 void del_gendisk(struct gendisk *gp);
 734 void invalidate_disk(struct gendisk *disk);
 735 void set_disk_ro(struct gendisk *disk, bool read_only);
 736 void disk_uevent(struct gendisk *disk, enum kobject_action action);
 737
 738 static inline int get_disk_ro(struct gendisk *disk)
 739 {
 740         return disk->part0->bd_read_only ||
 741                 test_bit(GD_READ_ONLY, &disk->state);
 742 }
 743
 744 static inline int bdev_read_only(struct block_device *bdev)
 745 {
 746         return bdev->bd_read_only || get_disk_ro(bdev->bd_disk);
 747 }
 748
 749 bool set_capacity_and_notify(struct gendisk *disk, sector_t size);
 750 void disk_force_media_change(struct gendisk *disk);
 751 void bdev_mark_dead(struct block_device *bdev, bool surprise);
 752
 753 void add_disk_randomness(struct gendisk *disk) __latent_entropy;
 754 void rand_initialize_disk(struct gendisk *disk);
 755
 756 static inline sector_t get_start_sect(struct block_device *bdev)
 757 {
 758         return bdev->bd_start_sect;
 759 }
 760
 761 static inline sector_t bdev_nr_sectors(struct block_device *bdev)
 762 {
 763         return bdev->bd_nr_sectors;
 764 }
 765
 766 static inline loff_t bdev_nr_bytes(struct block_device *bdev)
 767 {
 768         return (loff_t)bdev_nr_sectors(bdev) << SECTOR_SHIFT;
 769 }
 770
 771 static inline sector_t get_capacity(struct gendisk *disk)
 772 {
 773         return bdev_nr_sectors(disk->part0);
 774 }
 775
 776 static inline u64 sb_bdev_nr_blocks(struct super_block *sb)
 777 {
 778         return bdev_nr_sectors(sb->s_bdev) >>
 779                 (sb->s_blocksize_bits - SECTOR_SHIFT);
 780 }
 781
 782 int bdev_disk_changed(struct gendisk *disk, bool invalidate);
 783
 784 void put_disk(struct gendisk *disk);
 785 struct gendisk *__blk_alloc_disk(struct queue_limits *lim, int node,
 786                 struct lock_class_key *lkclass);
 787
 788 /**
 789  * blk_alloc_disk - allocate a gendisk structure
 790  * @lim: queue limits to be used for this disk.
 791  * @node_id: numa node to allocate on
 792  *
 793  * Allocate and pre-initialize a gendisk structure for use with BIO based
 794  * drivers.
 795  *
 796  * Returns an ERR_PTR on error, else the allocated disk.
 797  *
 798  * Context: can sleep
 799  */
 800 #define blk_alloc_disk(lim, node_id)                                    \
 801 ({                                                                      \
 802         static struct lock_class_key __key;                             \
 803                                                                         \
 804         __blk_alloc_disk(lim, node_id, &__key);                         \
 805 })
 806
 807 int __register_blkdev(unsigned int major, const char *name,
 808                 void (*probe)(dev_t devt));
 809 #define register_blkdev(major, name) \
 810         __register_blkdev(major, name, NULL)
 811 void unregister_blkdev(unsigned int major, const char *name);
 812
 813 bool disk_check_media_change(struct gendisk *disk);
 814 void set_capacity(struct gendisk *disk, sector_t size);
 815
 816 #ifdef CONFIG_BLOCK_HOLDER_DEPRECATED
 817 int bd_link_disk_holder(struct block_device *bdev, struct gendisk *disk);
 818 void bd_unlink_disk_holder(struct block_device *bdev, struct gendisk *disk);
 819 #else
 820 static inline int bd_link_disk_holder(struct block_device *bdev,
 821                                       struct gendisk *disk)
 822 {
 823         return 0;
 824 }
 825 static inline void bd_unlink_disk_holder(struct block_device *bdev,
 826                                          struct gendisk *disk)
 827 {
 828 }
 829 #endif /* CONFIG_BLOCK_HOLDER_DEPRECATED */
 830
 831 dev_t part_devt(struct gendisk *disk, u8 partno);
 832 void inc_diskseq(struct gendisk *disk);
 833 void blk_request_module(dev_t devt);
 834
 835 extern int blk_register_queue(struct gendisk *disk);
 836 extern void blk_unregister_queue(struct gendisk *disk);
 837 void submit_bio_noacct(struct bio *bio);
 838 struct bio *bio_split_to_limits(struct bio *bio);
 839
 840 extern int blk_lld_busy(struct request_queue *q);
 841 extern int blk_queue_enter(struct request_queue *q, blk_mq_req_flags_t flags);
 842 extern void blk_queue_exit(struct request_queue *q);
 843 extern void blk_sync_queue(struct request_queue *q);
 844
 845 /* Helper to convert REQ_OP_XXX to its string format XXX */
 846 extern const char *blk_op_str(enum req_op op);
 847
 848 int blk_status_to_errno(blk_status_t status);
 849 blk_status_t errno_to_blk_status(int errno);
 850 const char *blk_status_to_str(blk_status_t status);
 851
 852 /* only poll the hardware once, don't continue until a completion was found */
 853 #define BLK_POLL_ONESHOT                (1 << 0)
 854 int bio_poll(struct bio *bio, struct io_comp_batch *iob, unsigned int flags);
 855 int iocb_bio_iopoll(struct kiocb *kiocb, struct io_comp_batch *iob,
 856                         unsigned int flags);
 857
 858 static inline struct request_queue *bdev_get_queue(struct block_device *bdev)
 859 {
 860         return bdev->bd_queue;  /* this is never NULL */
 861 }
 862
 863 /* Helper to convert BLK_ZONE_ZONE_XXX to its string format XXX */
 864 const char *blk_zone_cond_str(enum blk_zone_cond zone_cond);
 865
 866 static inline unsigned int bio_zone_no(struct bio *bio)
 867 {
 868         return disk_zone_no(bio->bi_bdev->bd_disk, bio->bi_iter.bi_sector);
 869 }
 870
 871 static inline unsigned int bio_zone_is_seq(struct bio *bio)
 872 {
 873         return disk_zone_is_seq(bio->bi_bdev->bd_disk, bio->bi_iter.bi_sector);
 874 }
 875
 876 /*
 877  * Return how much of the chunk is left to be used for I/O at a given offset.
 878  */
 879 static inline unsigned int blk_chunk_sectors_left(sector_t offset,
 880                 unsigned int chunk_sectors)
 881 {
 882         if (unlikely(!is_power_of_2(chunk_sectors)))
 883                 return chunk_sectors - sector_div(offset, chunk_sectors);
 884         return chunk_sectors - (offset & (chunk_sectors - 1));
 885 }
 886
 887 /**
 888  * queue_limits_start_update - start an atomic update of queue limits
 889  * @q:          queue to update
 890  *
 891  * This functions starts an atomic update of the queue limits.  It takes a lock
 892  * to prevent other updates and returns a snapshot of the current limits that
 893  * the caller can modify.  The caller must call queue_limits_commit_update()
 894  * to finish the update.
 895  *
 896  * Context: process context.  The caller must have frozen the queue or ensured
 897  * that there is outstanding I/O by other means.
 898  */
 899 static inline struct queue_limits
 900 queue_limits_start_update(struct request_queue *q)
 901         __acquires(q->limits_lock)
 902 {
 903         mutex_lock(&q->limits_lock);
 904         return q->limits;
 905 }
 906 int queue_limits_commit_update(struct request_queue *q,
 907                 struct queue_limits *lim);
 908 int queue_limits_set(struct request_queue *q, struct queue_limits *lim);
 909
 910 /*
 911  * Access functions for manipulating queue properties
 912  */
 913 void blk_queue_bounce_limit(struct request_queue *q, enum blk_bounce limit);
 914 extern void blk_queue_max_hw_sectors(struct request_queue *, unsigned int);
 915 extern void blk_queue_chunk_sectors(struct request_queue *, unsigned int);
 916 extern void blk_queue_max_segments(struct request_queue *, unsigned short);
 917 extern void blk_queue_max_discard_segments(struct request_queue *,
 918                 unsigned short);
 919 void blk_queue_max_secure_erase_sectors(struct request_queue *q,
 920                 unsigned int max_sectors);
 921 extern void blk_queue_max_segment_size(struct request_queue *, unsigned int);
 922 extern void blk_queue_max_discard_sectors(struct request_queue *q,
 923                 unsigned int max_discard_sectors);
 924 extern void blk_queue_max_write_zeroes_sectors(struct request_queue *q,
 925                 unsigned int max_write_same_sectors);
 926 extern void blk_queue_logical_block_size(struct request_queue *, unsigned int);
 927 extern void blk_queue_max_zone_append_sectors(struct request_queue *q,
 928                 unsigned int max_zone_append_sectors);
 929 extern void blk_queue_physical_block_size(struct request_queue *, unsigned int);
 930 void blk_queue_zone_write_granularity(struct request_queue *q,
 931                                       unsigned int size);
 932 extern void blk_queue_alignment_offset(struct request_queue *q,
 933                                        unsigned int alignment);
 934 void disk_update_readahead(struct gendisk *disk);
 935 extern void blk_limits_io_min(struct queue_limits *limits, unsigned int min);
 936 extern void blk_queue_io_min(struct request_queue *q, unsigned int min);
 937 extern void blk_limits_io_opt(struct queue_limits *limits, unsigned int opt);
 938 extern void blk_queue_io_opt(struct request_queue *q, unsigned int opt);
 939 extern void blk_set_queue_depth(struct request_queue *q, unsigned int depth);
 940 extern void blk_set_stacking_limits(struct queue_limits *lim);
 941 extern int blk_stack_limits(struct queue_limits *t, struct queue_limits *b,
 942                             sector_t offset);
 943 void queue_limits_stack_bdev(struct queue_limits *t, struct block_device *bdev,
 944                 sector_t offset, const char *pfx);
 945 extern void blk_queue_update_dma_pad(struct request_queue *, unsigned int);
 946 extern void blk_queue_segment_boundary(struct request_queue *, unsigned long);
 947 extern void blk_queue_virt_boundary(struct request_queue *, unsigned long);
 948 extern void blk_queue_dma_alignment(struct request_queue *, int);
 949 extern void blk_queue_update_dma_alignment(struct request_queue *, int);
 950 extern void blk_queue_rq_timeout(struct request_queue *, unsigned int);
 951 extern void blk_queue_write_cache(struct request_queue *q, bool enabled, bool fua);
 952
 953 struct blk_independent_access_ranges *
 954 disk_alloc_independent_access_ranges(struct gendisk *disk, int nr_ia_ranges);
 955 void disk_set_independent_access_ranges(struct gendisk *disk,
 956                                 struct blk_independent_access_ranges *iars);
 957
 958 /*
 959  * Elevator features for blk_queue_required_elevator_features:
 960  */
 961 /* Supports zoned block devices sequential write constraint */
 962 #define ELEVATOR_F_ZBD_SEQ_WRITE        (1U << 0)
 963
 964 extern void blk_queue_required_elevator_features(struct request_queue *q,
 965                                                  unsigned int features);
 966 extern bool blk_queue_can_use_dma_map_merging(struct request_queue *q,
 967                                               struct device *dev);
 968
 969 bool __must_check blk_get_queue(struct request_queue *);
 970 extern void blk_put_queue(struct request_queue *);
 971
 972 void blk_mark_disk_dead(struct gendisk *disk);
 973
 974 #ifdef CONFIG_BLOCK
 975 /*
 976  * blk_plug permits building a queue of related requests by holding the I/O
 977  * fragments for a short period. This allows merging of sequential requests
 978  * into single larger request. As the requests are moved from a per-task list to
 979  * the device's request_queue in a batch, this results in improved scalability
 980  * as the lock contention for request_queue lock is reduced.
 981  *
 982  * It is ok not to disable preemption when adding the request to the plug list
 983  * or when attempting a merge. For details, please see schedule() where
 984  * blk_flush_plug() is called.
 985  */
 986 struct blk_plug {
 987         struct request *mq_list; /* blk-mq requests */
 988
 989         /* if ios_left is > 1, we can batch tag/rq allocations */
 990         struct request *cached_rq;
 991         u64 cur_ktime;
 992         unsigned short nr_ios;
 993
 994         unsigned short rq_count;
 995
 996         bool multiple_queues;
 997         bool has_elevator;
 998
 999         struct list_head cb_list; /* md requires an unplug callback */
1000 };
1001
1002 struct blk_plug_cb;
1003 typedef void (*blk_plug_cb_fn)(struct blk_plug_cb *, bool);
1004 struct blk_plug_cb {
1005         struct list_head list;
1006         blk_plug_cb_fn callback;
1007         void *data;
1008 };
1009 extern struct blk_plug_cb *blk_check_plugged(blk_plug_cb_fn unplug,
1010                                              void *data, int size);
1011 extern void blk_start_plug(struct blk_plug *);
1012 extern void blk_start_plug_nr_ios(struct blk_plug *, unsigned short);
1013 extern void blk_finish_plug(struct blk_plug *);
1014
1015 void __blk_flush_plug(struct blk_plug *plug, bool from_schedule);
1016 static inline void blk_flush_plug(struct blk_plug *plug, bool async)
1017 {
1018         if (plug)
1019                 __blk_flush_plug(plug, async);
1020 }
1021
1022 /*
1023  * tsk == current here
1024  */
1025 static inline void blk_plug_invalidate_ts(struct task_struct *tsk)
1026 {
1027         struct blk_plug *plug = tsk->plug;
1028
1029         if (plug)
1030                 plug->cur_ktime = 0;
1031         current->flags &= ~PF_BLOCK_TS;
1032 }
1033
1034 int blkdev_issue_flush(struct block_device *bdev);
1035 long nr_blockdev_pages(void);
1036 #else /* CONFIG_BLOCK */
1037 struct blk_plug {
1038 };
1039
1040 static inline void blk_start_plug_nr_ios(struct blk_plug *plug,
1041                                          unsigned short nr_ios)
1042 {
1043 }
1044
1045 static inline void blk_start_plug(struct blk_plug *plug)
1046 {
1047 }
1048
1049 static inline void blk_finish_plug(struct blk_plug *plug)
1050 {
1051 }
1052
1053 static inline void blk_flush_plug(struct blk_plug *plug, bool async)
1054 {
1055 }
1056
1057 static inline void blk_plug_invalidate_ts(struct task_struct *tsk)
1058 {
1059 }
1060
1061 static inline int blkdev_issue_flush(struct block_device *bdev)
1062 {
1063         return 0;
1064 }
1065
1066 static inline long nr_blockdev_pages(void)
1067 {
1068         return 0;
1069 }
1070 #endif /* CONFIG_BLOCK */
1071
1072 extern void blk_io_schedule(void);
1073
1074 int blkdev_issue_discard(struct block_device *bdev, sector_t sector,
1075                 sector_t nr_sects, gfp_t gfp_mask);
1076 int __blkdev_issue_discard(struct block_device *bdev, sector_t sector,
1077                 sector_t nr_sects, gfp_t gfp_mask, struct bio **biop);
1078 int blkdev_issue_secure_erase(struct block_device *bdev, sector_t sector,
1079                 sector_t nr_sects, gfp_t gfp);
1080
1081 #define BLKDEV_ZERO_NOUNMAP     (1 << 0)  /* do not free blocks */
1082 #define BLKDEV_ZERO_NOFALLBACK  (1 << 1)  /* don't write explicit zeroes */
1083
1084 extern int __blkdev_issue_zeroout(struct block_device *bdev, sector_t sector,
1085                 sector_t nr_sects, gfp_t gfp_mask, struct bio **biop,
1086                 unsigned flags);
1087 extern int blkdev_issue_zeroout(struct block_device *bdev, sector_t sector,
1088                 sector_t nr_sects, gfp_t gfp_mask, unsigned flags);
1089
1090 static inline int sb_issue_discard(struct super_block *sb, sector_t block,
1091                 sector_t nr_blocks, gfp_t gfp_mask, unsigned long flags)
1092 {
1093         return blkdev_issue_discard(sb->s_bdev,
1094                                     block << (sb->s_blocksize_bits -
1095                                               SECTOR_SHIFT),
1096                                     nr_blocks << (sb->s_blocksize_bits -
1097                                                   SECTOR_SHIFT),
1098                                     gfp_mask);
1099 }
1100 static inline int sb_issue_zeroout(struct super_block *sb, sector_t block,
1101                 sector_t nr_blocks, gfp_t gfp_mask)
1102 {
1103         return blkdev_issue_zeroout(sb->s_bdev,
1104                                     block << (sb->s_blocksize_bits -
1105                                               SECTOR_SHIFT),
1106                                     nr_blocks << (sb->s_blocksize_bits -
1107                                                   SECTOR_SHIFT),
1108                                     gfp_mask, 0);
1109 }
1110
1111 static inline bool bdev_is_partition(struct block_device *bdev)
1112 {
1113         return bdev->bd_partno;
1114 }
1115
1116 enum blk_default_limits {
1117         BLK_MAX_SEGMENTS        = 128,
1118         BLK_SAFE_MAX_SECTORS    = 255,
1119         BLK_MAX_SEGMENT_SIZE    = 65536,
1120         BLK_SEG_BOUNDARY_MASK   = 0xFFFFFFFFUL,
1121 };
1122
1123 /*
1124  * Default upper limit for the software max_sectors limit used for
1125  * regular file system I/O.  This can be increased through sysfs.
1126  *
1127  * Not to be confused with the max_hw_sector limit that is entirely
1128  * controlled by the driver, usually based on hardware limits.
1129  */
1130 #define BLK_DEF_MAX_SECTORS_CAP 2560u
1131
1132 static inline unsigned long queue_segment_boundary(const struct request_queue *q)
1133 {
1134         return q->limits.seg_boundary_mask;
1135 }
1136
1137 static inline unsigned long queue_virt_boundary(const struct request_queue *q)
1138 {
1139         return q->limits.virt_boundary_mask;
1140 }
1141
1142 static inline unsigned int queue_max_sectors(const struct request_queue *q)
1143 {
1144         return q->limits.max_sectors;
1145 }
1146
1147 static inline unsigned int queue_max_bytes(struct request_queue *q)
1148 {
1149         return min_t(unsigned int, queue_max_sectors(q), INT_MAX >> 9) << 9;
1150 }
1151
1152 static inline unsigned int queue_max_hw_sectors(const struct request_queue *q)
1153 {
1154         return q->limits.max_hw_sectors;
1155 }
1156
1157 static inline unsigned short queue_max_segments(const struct request_queue *q)
1158 {
1159         return q->limits.max_segments;
1160 }
1161
1162 static inline unsigned short queue_max_discard_segments(const struct request_queue *q)
1163 {
1164         return q->limits.max_discard_segments;
1165 }
1166
1167 static inline unsigned int queue_max_segment_size(const struct request_queue *q)
1168 {
1169         return q->limits.max_segment_size;
1170 }
1171
1172 static inline unsigned int queue_max_zone_append_sectors(const struct request_queue *q)
1173 {
1174
1175         const struct queue_limits *l = &q->limits;
1176
1177         return min(l->max_zone_append_sectors, l->max_sectors);
1178 }
1179
1180 static inline unsigned int
1181 bdev_max_zone_append_sectors(struct block_device *bdev)
1182 {
1183         return queue_max_zone_append_sectors(bdev_get_queue(bdev));
1184 }
1185
1186 static inline unsigned int bdev_max_segments(struct block_device *bdev)
1187 {
1188         return queue_max_segments(bdev_get_queue(bdev));
1189 }
1190
1191 static inline unsigned queue_logical_block_size(const struct request_queue *q)
1192 {
1193         int retval = 512;
1194
1195         if (q && q->limits.logical_block_size)
1196                 retval = q->limits.logical_block_size;
1197
1198         return retval;
1199 }
1200
1201 static inline unsigned int bdev_logical_block_size(struct block_device *bdev)
1202 {
1203         return queue_logical_block_size(bdev_get_queue(bdev));
1204 }
1205
1206 static inline unsigned int queue_physical_block_size(const struct request_queue *q)
1207 {
1208         return q->limits.physical_block_size;
1209 }
1210
1211 static inline unsigned int bdev_physical_block_size(struct block_device *bdev)
1212 {
1213         return queue_physical_block_size(bdev_get_queue(bdev));
1214 }
1215
1216 static inline unsigned int queue_io_min(const struct request_queue *q)
1217 {
1218         return q->limits.io_min;
1219 }
1220
1221 static inline int bdev_io_min(struct block_device *bdev)
1222 {
1223         return queue_io_min(bdev_get_queue(bdev));
1224 }
1225
1226 static inline unsigned int queue_io_opt(const struct request_queue *q)
1227 {
1228         return q->limits.io_opt;
1229 }
1230
1231 static inline int bdev_io_opt(struct block_device *bdev)
1232 {
1233         return queue_io_opt(bdev_get_queue(bdev));
1234 }
1235
1236 static inline unsigned int
1237 queue_zone_write_granularity(const struct request_queue *q)
1238 {
1239         return q->limits.zone_write_granularity;
1240 }
1241
1242 static inline unsigned int
1243 bdev_zone_write_granularity(struct block_device *bdev)
1244 {
1245         return queue_zone_write_granularity(bdev_get_queue(bdev));
1246 }
1247
1248 int bdev_alignment_offset(struct block_device *bdev);
1249 unsigned int bdev_discard_alignment(struct block_device *bdev);
1250
1251 static inline unsigned int bdev_max_discard_sectors(struct block_device *bdev)
1252 {
1253         return bdev_get_queue(bdev)->limits.max_discard_sectors;
1254 }
1255
1256 static inline unsigned int bdev_discard_granularity(struct block_device *bdev)
1257 {
1258         return bdev_get_queue(bdev)->limits.discard_granularity;
1259 }
1260
1261 static inline unsigned int
1262 bdev_max_secure_erase_sectors(struct block_device *bdev)
1263 {
1264         return bdev_get_queue(bdev)->limits.max_secure_erase_sectors;
1265 }
1266
1267 static inline unsigned int bdev_write_zeroes_sectors(struct block_device *bdev)
1268 {
1269         struct request_queue *q = bdev_get_queue(bdev);
1270
1271         if (q)
1272                 return q->limits.max_write_zeroes_sectors;
1273
1274         return 0;
1275 }
1276
1277 static inline bool bdev_nonrot(struct block_device *bdev)
1278 {
1279         return blk_queue_nonrot(bdev_get_queue(bdev));
1280 }
1281
1282 static inline bool bdev_synchronous(struct block_device *bdev)
1283 {
1284         return test_bit(QUEUE_FLAG_SYNCHRONOUS,
1285                         &bdev_get_queue(bdev)->queue_flags);
1286 }
1287
1288 static inline bool bdev_stable_writes(struct block_device *bdev)
1289 {
1290         return test_bit(QUEUE_FLAG_STABLE_WRITES,
1291                         &bdev_get_queue(bdev)->queue_flags);
1292 }
1293
1294 static inline bool bdev_write_cache(struct block_device *bdev)
1295 {
1296         return test_bit(QUEUE_FLAG_WC, &bdev_get_queue(bdev)->queue_flags);
1297 }
1298
1299 static inline bool bdev_fua(struct block_device *bdev)
1300 {
1301         return test_bit(QUEUE_FLAG_FUA, &bdev_get_queue(bdev)->queue_flags);
1302 }
1303
1304 static inline bool bdev_nowait(struct block_device *bdev)
1305 {
1306         return test_bit(QUEUE_FLAG_NOWAIT, &bdev_get_queue(bdev)->queue_flags);
1307 }
1308
1309 static inline bool bdev_is_zoned(struct block_device *bdev)
1310 {
1311         return blk_queue_is_zoned(bdev_get_queue(bdev));
1312 }
1313
1314 static inline unsigned int bdev_zone_no(struct block_device *bdev, sector_t sec)
1315 {
1316         return disk_zone_no(bdev->bd_disk, sec);
1317 }
1318
1319 /* Whether write serialization is required for @op on zoned devices. */
1320 static inline bool op_needs_zoned_write_locking(enum req_op op)
1321 {
1322         return op == REQ_OP_WRITE || op == REQ_OP_WRITE_ZEROES;
1323 }
1324
1325 static inline bool bdev_op_is_zoned_write(struct block_device *bdev,
1326                                           enum req_op op)
1327 {
1328         return bdev_is_zoned(bdev) && op_needs_zoned_write_locking(op);
1329 }
1330
1331 static inline sector_t bdev_zone_sectors(struct block_device *bdev)
1332 {
1333         struct request_queue *q = bdev_get_queue(bdev);
1334
1335         if (!blk_queue_is_zoned(q))
1336                 return 0;
1337         return q->limits.chunk_sectors;
1338 }
1339
1340 static inline sector_t bdev_offset_from_zone_start(struct block_device *bdev,
1341                                                    sector_t sector)
1342 {
1343         return sector & (bdev_zone_sectors(bdev) - 1);
1344 }
1345
1346 static inline bool bdev_is_zone_start(struct block_device *bdev,
1347                                       sector_t sector)
1348 {
1349         return bdev_offset_from_zone_start(bdev, sector) == 0;
1350 }
1351
1352 static inline int queue_dma_alignment(const struct request_queue *q)
1353 {
1354         return q ? q->limits.dma_alignment : 511;
1355 }
1356
1357 static inline unsigned int bdev_dma_alignment(struct block_device *bdev)
1358 {
1359         return queue_dma_alignment(bdev_get_queue(bdev));
1360 }
1361
1362 static inline bool bdev_iter_is_aligned(struct block_device *bdev,
1363                                         struct iov_iter *iter)
1364 {
1365         return iov_iter_is_aligned(iter, bdev_dma_alignment(bdev),
1366                                    bdev_logical_block_size(bdev) - 1);
1367 }
1368
1369 static inline int blk_rq_aligned(struct request_queue *q, unsigned long addr,
1370                                  unsigned int len)
1371 {
1372         unsigned int alignment = queue_dma_alignment(q) | q->dma_pad_mask;
1373         return !(addr & alignment) && !(len & alignment);
1374 }
1375
1376 /* assumes size > 256 */
1377 static inline unsigned int blksize_bits(unsigned int size)
1378 {
1379         return order_base_2(size >> SECTOR_SHIFT) + SECTOR_SHIFT;
1380 }
1381
1382 static inline unsigned int block_size(struct block_device *bdev)
1383 {
1384         return 1 << bdev->bd_inode->i_blkbits;
1385 }
1386
1387 int kblockd_schedule_work(struct work_struct *work);
1388 int kblockd_mod_delayed_work_on(int cpu, struct delayed_work *dwork, unsigned long delay);
1389
1390 #define MODULE_ALIAS_BLOCKDEV(major,minor) \
1391         MODULE_ALIAS("block-major-" __stringify(major) "-" __stringify(minor))
1392 #define MODULE_ALIAS_BLOCKDEV_MAJOR(major) \
1393         MODULE_ALIAS("block-major-" __stringify(major) "-*")
1394
1395 #ifdef CONFIG_BLK_INLINE_ENCRYPTION
1396
1397 bool blk_crypto_register(struct blk_crypto_profile *profile,
1398                          struct request_queue *q);
1399
1400 #else /* CONFIG_BLK_INLINE_ENCRYPTION */
1401
1402 static inline bool blk_crypto_register(struct blk_crypto_profile *profile,
1403                                        struct request_queue *q)
1404 {
1405         return true;
1406 }
1407
1408 #endif /* CONFIG_BLK_INLINE_ENCRYPTION */
1409
1410 enum blk_unique_id {
1411         /* these match the Designator Types specified in SPC */
1412         BLK_UID_T10     = 1,
1413         BLK_UID_EUI64   = 2,
1414         BLK_UID_NAA     = 3,
1415 };
1416
1417 struct block_device_operations {
1418         void (*submit_bio)(struct bio *bio);
1419         int (*poll_bio)(struct bio *bio, struct io_comp_batch *iob,
1420                         unsigned int flags);
1421         int (*open)(struct gendisk *disk, blk_mode_t mode);
1422         void (*release)(struct gendisk *disk);
1423         int (*ioctl)(struct block_device *bdev, blk_mode_t mode,
1424                         unsigned cmd, unsigned long arg);
1425         int (*compat_ioctl)(struct block_device *bdev, blk_mode_t mode,
1426                         unsigned cmd, unsigned long arg);
1427         unsigned int (*check_events) (struct gendisk *disk,
1428                                       unsigned int clearing);
1429         void (*unlock_native_capacity) (struct gendisk *);
1430         int (*getgeo)(struct block_device *, struct hd_geometry *);
1431         int (*set_read_only)(struct block_device *bdev, bool ro);
1432         void (*free_disk)(struct gendisk *disk);
1433         /* this callback is with swap_lock and sometimes page table lock held */
1434         void (*swap_slot_free_notify) (struct block_device *, unsigned long);
1435         int (*report_zones)(struct gendisk *, sector_t sector,
1436                         unsigned int nr_zones, report_zones_cb cb, void *data);
1437         char *(*devnode)(struct gendisk *disk, umode_t *mode);
1438         /* returns the length of the identifier or a negative errno: */
1439         int (*get_unique_id)(struct gendisk *disk, u8 id[16],
1440                         enum blk_unique_id id_type);
1441         struct module *owner;
1442         const struct pr_ops *pr_ops;
1443
1444         /*
1445          * Special callback for probing GPT entry at a given sector.
1446          * Needed by Android devices, used by GPT scanner and MMC blk
1447          * driver.
1448          */
1449         int (*alternative_gpt_sector)(struct gendisk *disk, sector_t *sector);
1450 };
1451
1452 #ifdef CONFIG_COMPAT
1453 extern int blkdev_compat_ptr_ioctl(struct block_device *, blk_mode_t,
1454                                       unsigned int, unsigned long);
1455 #else
1456 #define blkdev_compat_ptr_ioctl NULL
1457 #endif
1458
1459 static inline void blk_wake_io_task(struct task_struct *waiter)
1460 {
1461         /*
1462          * If we're polling, the task itself is doing the completions. For
1463          * that case, we don't need to signal a wakeup, it's enough to just
1464          * mark us as RUNNING.
1465          */
1466         if (waiter == current)
1467                 __set_current_state(TASK_RUNNING);
1468         else
1469                 wake_up_process(waiter);
1470 }
1471
1472 unsigned long bdev_start_io_acct(struct block_device *bdev, enum req_op op,
1473                                  unsigned long start_time);
1474 void bdev_end_io_acct(struct block_device *bdev, enum req_op op,
1475                       unsigned int sectors, unsigned long start_time);
1476
1477 unsigned long bio_start_io_acct(struct bio *bio);
1478 void bio_end_io_acct_remapped(struct bio *bio, unsigned long start_time,
1479                 struct block_device *orig_bdev);
1480
1481 /**
1482  * bio_end_io_acct - end I/O accounting for bio based drivers
1483  * @bio:        bio to end account for
1484  * @start_time: start time returned by bio_start_io_acct()
1485  */
1486 static inline void bio_end_io_acct(struct bio *bio, unsigned long start_time)
1487 {
1488         return bio_end_io_acct_remapped(bio, start_time, bio->bi_bdev);
1489 }
1490
1491 int bdev_read_only(struct block_device *bdev);
1492 int set_blocksize(struct block_device *bdev, int size);
1493
1494 int lookup_bdev(const char *pathname, dev_t *dev);
1495
1496 void blkdev_show(struct seq_file *seqf, off_t offset);
1497
1498 #define BDEVNAME_SIZE   32      /* Largest string for a blockdev identifier */
1499 #define BDEVT_SIZE      10      /* Largest string for MAJ:MIN for blkdev */
1500 #ifdef CONFIG_BLOCK
1501 #define BLKDEV_MAJOR_MAX        512
1502 #else
1503 #define BLKDEV_MAJOR_MAX        0
1504 #endif
1505
1506 struct blk_holder_ops {
1507         void (*mark_dead)(struct block_device *bdev, bool surprise);
1508
1509         /*
1510          * Sync the file system mounted on the block device.
1511          */
1512         void (*sync)(struct block_device *bdev);
1513
1514         /*
1515          * Freeze the file system mounted on the block device.
1516          */
1517         int (*freeze)(struct block_device *bdev);
1518
1519         /*
1520          * Thaw the file system mounted on the block device.
1521          */
1522         int (*thaw)(struct block_device *bdev);
1523 };
1524
1525 /*
1526  * For filesystems using @fs_holder_ops, the @holder argument passed to
1527  * helpers used to open and claim block devices via
1528  * bd_prepare_to_claim() must point to a superblock.
1529  */
1530 extern const struct blk_holder_ops fs_holder_ops;
1531
1532 /*
1533  * Return the correct open flags for blkdev_get_by_* for super block flags
1534  * as stored in sb->s_flags.
1535  */
1536 #define sb_open_mode(flags) \
1537         (BLK_OPEN_READ | BLK_OPEN_RESTRICT_WRITES | \
1538          (((flags) & SB_RDONLY) ? 0 : BLK_OPEN_WRITE))
1539
1540 struct file *bdev_file_open_by_dev(dev_t dev, blk_mode_t mode, void *holder,
1541                 const struct blk_holder_ops *hops);
1542 struct file *bdev_file_open_by_path(const char *path, blk_mode_t mode,
1543                 void *holder, const struct blk_holder_ops *hops);
1544 int bd_prepare_to_claim(struct block_device *bdev, void *holder,
1545                 const struct blk_holder_ops *hops);
1546 void bd_abort_claiming(struct block_device *bdev, void *holder);
1547
1548 /* just for blk-cgroup, don't use elsewhere */
1549 struct block_device *blkdev_get_no_open(dev_t dev);
1550 void blkdev_put_no_open(struct block_device *bdev);
1551
1552 struct block_device *I_BDEV(struct inode *inode);
1553 struct block_device *file_bdev(struct file *bdev_file);
1554
1555 #ifdef CONFIG_BLOCK
1556 void invalidate_bdev(struct block_device *bdev);
1557 int sync_blockdev(struct block_device *bdev);
1558 int sync_blockdev_range(struct block_device *bdev, loff_t lstart, loff_t lend);
1559 int sync_blockdev_nowait(struct block_device *bdev);
1560 void sync_bdevs(bool wait);
1561 void bdev_statx_dioalign(struct inode *inode, struct kstat *stat);
1562 void printk_all_partitions(void);
1563 int __init early_lookup_bdev(const char *pathname, dev_t *dev);
1564 #else
1565 static inline void invalidate_bdev(struct block_device *bdev)
1566 {
1567 }
1568 static inline int sync_blockdev(struct block_device *bdev)
1569 {
1570         return 0;
1571 }
1572 static inline int sync_blockdev_nowait(struct block_device *bdev)
1573 {
1574         return 0;
1575 }
1576 static inline void sync_bdevs(bool wait)
1577 {
1578 }
1579 static inline void bdev_statx_dioalign(struct inode *inode, struct kstat *stat)
1580 {
1581 }
1582 static inline void printk_all_partitions(void)
1583 {
1584 }
1585 static inline int early_lookup_bdev(const char *pathname, dev_t *dev)
1586 {
1587         return -EINVAL;
1588 }
1589 #endif /* CONFIG_BLOCK */
1590
1591 int bdev_freeze(struct block_device *bdev);
1592 int bdev_thaw(struct block_device *bdev);
1593 void bdev_fput(struct file *bdev_file);
1594
1595 struct io_comp_batch {
1596         struct request *req_list;
1597         bool need_ts;
1598         void (*complete)(struct io_comp_batch *);
1599 };
1600
1601 #define DEFINE_IO_COMP_BATCH(name)      struct io_comp_batch name = { }
1602
1603 #endif /* _LINUX_BLKDEV_H */