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