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