block/blk.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef BLK_INTERNAL_H
   3 #define BLK_INTERNAL_H
   4
   5 #include <linux/idr.h>
   6 #include <linux/blk-mq.h>
   7 #include <linux/part_stat.h>
   8 #include <linux/blk-crypto.h>
   9 #include <xen/xen.h>
  10 #include "blk-crypto-internal.h"
  11 #include "blk-mq.h"
  12 #include "blk-mq-sched.h"
  13
  14 /* Max future timer expiry for timeouts */
  15 #define BLK_MAX_TIMEOUT         (5 * HZ)
  16
  17 extern struct dentry *blk_debugfs_root;
  18
  19 struct blk_flush_queue {
  20         unsigned int            flush_pending_idx:1;
  21         unsigned int            flush_running_idx:1;
  22         blk_status_t            rq_status;
  23         unsigned long           flush_pending_since;
  24         struct list_head        flush_queue[2];
  25         struct list_head        flush_data_in_flight;
  26         struct request          *flush_rq;
  27
  28         struct lock_class_key   key;
  29         spinlock_t              mq_flush_lock;
  30 };
  31
  32 enum bio_merge_status {
  33         BIO_MERGE_OK,
  34         BIO_MERGE_NONE,
  35         BIO_MERGE_FAILED,
  36 };
  37
  38 extern struct kmem_cache *blk_requestq_cachep;
  39 extern struct kobj_type blk_queue_ktype;
  40 extern struct ida blk_queue_ida;
  41
  42 static inline struct blk_flush_queue *
  43 blk_get_flush_queue(struct request_queue *q, struct blk_mq_ctx *ctx)
  44 {
  45         return blk_mq_map_queue(q, REQ_OP_FLUSH, ctx)->fq;
  46 }
  47
  48 static inline void __blk_get_queue(struct request_queue *q)
  49 {
  50         kobject_get(&q->kobj);
  51 }
  52
  53 static inline bool
  54 is_flush_rq(struct request *req, struct blk_mq_hw_ctx *hctx)
  55 {
  56         return hctx->fq->flush_rq == req;
  57 }
  58
  59 struct blk_flush_queue *blk_alloc_flush_queue(int node, int cmd_size,
  60                                               gfp_t flags);
  61 void blk_free_flush_queue(struct blk_flush_queue *q);
  62
  63 void blk_freeze_queue(struct request_queue *q);
  64
  65 static inline bool biovec_phys_mergeable(struct request_queue *q,
  66                 struct bio_vec *vec1, struct bio_vec *vec2)
  67 {
  68         unsigned long mask = queue_segment_boundary(q);
  69         phys_addr_t addr1 = page_to_phys(vec1->bv_page) + vec1->bv_offset;
  70         phys_addr_t addr2 = page_to_phys(vec2->bv_page) + vec2->bv_offset;
  71
  72         if (addr1 + vec1->bv_len != addr2)
  73                 return false;
  74         if (xen_domain() && !xen_biovec_phys_mergeable(vec1, vec2->bv_page))
  75                 return false;
  76         if ((addr1 | mask) != ((addr2 + vec2->bv_len - 1) | mask))
  77                 return false;
  78         return true;
  79 }
  80
  81 static inline bool __bvec_gap_to_prev(struct request_queue *q,
  82                 struct bio_vec *bprv, unsigned int offset)
  83 {
  84         return (offset & queue_virt_boundary(q)) ||
  85                 ((bprv->bv_offset + bprv->bv_len) & queue_virt_boundary(q));
  86 }
  87
  88 /*
  89  * Check if adding a bio_vec after bprv with offset would create a gap in
  90  * the SG list. Most drivers don't care about this, but some do.
  91  */
  92 static inline bool bvec_gap_to_prev(struct request_queue *q,
  93                 struct bio_vec *bprv, unsigned int offset)
  94 {
  95         if (!queue_virt_boundary(q))
  96                 return false;
  97         return __bvec_gap_to_prev(q, bprv, offset);
  98 }
  99
 100 static inline void blk_rq_bio_prep(struct request *rq, struct bio *bio,
 101                 unsigned int nr_segs)
 102 {
 103         rq->nr_phys_segments = nr_segs;
 104         rq->__data_len = bio->bi_iter.bi_size;
 105         rq->bio = rq->biotail = bio;
 106         rq->ioprio = bio_prio(bio);
 107
 108         if (bio->bi_disk)
 109                 rq->rq_disk = bio->bi_disk;
 110 }
 111
 112 #ifdef CONFIG_BLK_DEV_INTEGRITY
 113 void blk_flush_integrity(void);
 114 bool __bio_integrity_endio(struct bio *);
 115 void bio_integrity_free(struct bio *bio);
 116 static inline bool bio_integrity_endio(struct bio *bio)
 117 {
 118         if (bio_integrity(bio))
 119                 return __bio_integrity_endio(bio);
 120         return true;
 121 }
 122
 123 static inline bool integrity_req_gap_back_merge(struct request *req,
 124                 struct bio *next)
 125 {
 126         struct bio_integrity_payload *bip = bio_integrity(req->bio);
 127         struct bio_integrity_payload *bip_next = bio_integrity(next);
 128
 129         return bvec_gap_to_prev(req->q, &bip->bip_vec[bip->bip_vcnt - 1],
 130                                 bip_next->bip_vec[0].bv_offset);
 131 }
 132
 133 static inline bool integrity_req_gap_front_merge(struct request *req,
 134                 struct bio *bio)
 135 {
 136         struct bio_integrity_payload *bip = bio_integrity(bio);
 137         struct bio_integrity_payload *bip_next = bio_integrity(req->bio);
 138
 139         return bvec_gap_to_prev(req->q, &bip->bip_vec[bip->bip_vcnt - 1],
 140                                 bip_next->bip_vec[0].bv_offset);
 141 }
 142
 143 void blk_integrity_add(struct gendisk *);
 144 void blk_integrity_del(struct gendisk *);
 145 #else /* CONFIG_BLK_DEV_INTEGRITY */
 146 static inline bool integrity_req_gap_back_merge(struct request *req,
 147                 struct bio *next)
 148 {
 149         return false;
 150 }
 151 static inline bool integrity_req_gap_front_merge(struct request *req,
 152                 struct bio *bio)
 153 {
 154         return false;
 155 }
 156
 157 static inline void blk_flush_integrity(void)
 158 {
 159 }
 160 static inline bool bio_integrity_endio(struct bio *bio)
 161 {
 162         return true;
 163 }
 164 static inline void bio_integrity_free(struct bio *bio)
 165 {
 166 }
 167 static inline void blk_integrity_add(struct gendisk *disk)
 168 {
 169 }
 170 static inline void blk_integrity_del(struct gendisk *disk)
 171 {
 172 }
 173 #endif /* CONFIG_BLK_DEV_INTEGRITY */
 174
 175 unsigned long blk_rq_timeout(unsigned long timeout);
 176 void blk_add_timer(struct request *req);
 177
 178 enum bio_merge_status bio_attempt_front_merge(struct request *req,
 179                                               struct bio *bio,
 180                                               unsigned int nr_segs);
 181 enum bio_merge_status bio_attempt_back_merge(struct request *req,
 182                                              struct bio *bio,
 183                                              unsigned int nr_segs);
 184 enum bio_merge_status bio_attempt_discard_merge(struct request_queue *q,
 185                                                 struct request *req,
 186                                                 struct bio *bio);
 187 bool blk_attempt_plug_merge(struct request_queue *q, struct bio *bio,
 188                 unsigned int nr_segs, struct request **same_queue_rq);
 189 bool blk_bio_list_merge(struct request_queue *q, struct list_head *list,
 190                         struct bio *bio, unsigned int nr_segs);
 191
 192 void blk_account_io_start(struct request *req);
 193 void blk_account_io_done(struct request *req, u64 now);
 194
 195 /*
 196  * Internal elevator interface
 197  */
 198 #define ELV_ON_HASH(rq) ((rq)->rq_flags & RQF_HASHED)
 199
 200 void blk_insert_flush(struct request *rq);
 201
 202 void elevator_init_mq(struct request_queue *q);
 203 int elevator_switch_mq(struct request_queue *q,
 204                               struct elevator_type *new_e);
 205 void __elevator_exit(struct request_queue *, struct elevator_queue *);
 206 int elv_register_queue(struct request_queue *q, bool uevent);
 207 void elv_unregister_queue(struct request_queue *q);
 208
 209 static inline void elevator_exit(struct request_queue *q,
 210                 struct elevator_queue *e)
 211 {
 212         lockdep_assert_held(&q->sysfs_lock);
 213
 214         blk_mq_sched_free_requests(q);
 215         __elevator_exit(q, e);
 216 }
 217
 218 struct hd_struct *__disk_get_part(struct gendisk *disk, int partno);
 219
 220 ssize_t part_size_show(struct device *dev, struct device_attribute *attr,
 221                 char *buf);
 222 ssize_t part_stat_show(struct device *dev, struct device_attribute *attr,
 223                 char *buf);
 224 ssize_t part_inflight_show(struct device *dev, struct device_attribute *attr,
 225                 char *buf);
 226 ssize_t part_fail_show(struct device *dev, struct device_attribute *attr,
 227                 char *buf);
 228 ssize_t part_fail_store(struct device *dev, struct device_attribute *attr,
 229                 const char *buf, size_t count);
 230 ssize_t part_timeout_show(struct device *, struct device_attribute *, char *);
 231 ssize_t part_timeout_store(struct device *, struct device_attribute *,
 232                                 const char *, size_t);
 233
 234 void __blk_queue_split(struct bio **bio, unsigned int *nr_segs);
 235 int ll_back_merge_fn(struct request *req, struct bio *bio,
 236                 unsigned int nr_segs);
 237 int ll_front_merge_fn(struct request *req,  struct bio *bio,
 238                 unsigned int nr_segs);
 239 struct request *attempt_back_merge(struct request_queue *q, struct request *rq);
 240 struct request *attempt_front_merge(struct request_queue *q, struct request *rq);
 241 int blk_attempt_req_merge(struct request_queue *q, struct request *rq,
 242                                 struct request *next);
 243 unsigned int blk_recalc_rq_segments(struct request *rq);
 244 void blk_rq_set_mixed_merge(struct request *rq);
 245 bool blk_rq_merge_ok(struct request *rq, struct bio *bio);
 246 enum elv_merge blk_try_merge(struct request *rq, struct bio *bio);
 247
 248 int blk_dev_init(void);
 249
 250 /*
 251  * Contribute to IO statistics IFF:
 252  *
 253  *      a) it's attached to a gendisk, and
 254  *      b) the queue had IO stats enabled when this request was started
 255  */
 256 static inline bool blk_do_io_stat(struct request *rq)
 257 {
 258         return rq->rq_disk && (rq->rq_flags & RQF_IO_STAT);
 259 }
 260
 261 static inline void req_set_nomerge(struct request_queue *q, struct request *req)
 262 {
 263         req->cmd_flags |= REQ_NOMERGE;
 264         if (req == q->last_merge)
 265                 q->last_merge = NULL;
 266 }
 267
 268 /*
 269  * The max size one bio can handle is UINT_MAX becasue bvec_iter.bi_size
 270  * is defined as 'unsigned int', meantime it has to aligned to with logical
 271  * block size which is the minimum accepted unit by hardware.
 272  */
 273 static inline unsigned int bio_allowed_max_sectors(struct request_queue *q)
 274 {
 275         return round_down(UINT_MAX, queue_logical_block_size(q)) >> 9;
 276 }
 277
 278 /*
 279  * The max bio size which is aligned to q->limits.discard_granularity. This
 280  * is a hint to split large discard bio in generic block layer, then if device
 281  * driver needs to split the discard bio into smaller ones, their bi_size can
 282  * be very probably and easily aligned to discard_granularity of the device's
 283  * queue.
 284  */
 285 static inline unsigned int bio_aligned_discard_max_sectors(
 286                                         struct request_queue *q)
 287 {
 288         return round_down(UINT_MAX, q->limits.discard_granularity) >>
 289                         SECTOR_SHIFT;
 290 }
 291
 292 /*
 293  * Internal io_context interface
 294  */
 295 void get_io_context(struct io_context *ioc);
 296 struct io_cq *ioc_lookup_icq(struct io_context *ioc, struct request_queue *q);
 297 struct io_cq *ioc_create_icq(struct io_context *ioc, struct request_queue *q,
 298                              gfp_t gfp_mask);
 299 void ioc_clear_queue(struct request_queue *q);
 300
 301 int create_task_io_context(struct task_struct *task, gfp_t gfp_mask, int node);
 302
 303 /*
 304  * Internal throttling interface
 305  */
 306 #ifdef CONFIG_BLK_DEV_THROTTLING
 307 extern int blk_throtl_init(struct request_queue *q);
 308 extern void blk_throtl_exit(struct request_queue *q);
 309 extern void blk_throtl_register_queue(struct request_queue *q);
 310 bool blk_throtl_bio(struct bio *bio);
 311 #else /* CONFIG_BLK_DEV_THROTTLING */
 312 static inline int blk_throtl_init(struct request_queue *q) { return 0; }
 313 static inline void blk_throtl_exit(struct request_queue *q) { }
 314 static inline void blk_throtl_register_queue(struct request_queue *q) { }
 315 static inline bool blk_throtl_bio(struct bio *bio) { return false; }
 316 #endif /* CONFIG_BLK_DEV_THROTTLING */
 317 #ifdef CONFIG_BLK_DEV_THROTTLING_LOW
 318 extern ssize_t blk_throtl_sample_time_show(struct request_queue *q, char *page);
 319 extern ssize_t blk_throtl_sample_time_store(struct request_queue *q,
 320         const char *page, size_t count);
 321 extern void blk_throtl_bio_endio(struct bio *bio);
 322 extern void blk_throtl_stat_add(struct request *rq, u64 time);
 323 #else
 324 static inline void blk_throtl_bio_endio(struct bio *bio) { }
 325 static inline void blk_throtl_stat_add(struct request *rq, u64 time) { }
 326 #endif
 327
 328 #ifdef CONFIG_BOUNCE
 329 extern int init_emergency_isa_pool(void);
 330 extern void blk_queue_bounce(struct request_queue *q, struct bio **bio);
 331 #else
 332 static inline int init_emergency_isa_pool(void)
 333 {
 334         return 0;
 335 }
 336 static inline void blk_queue_bounce(struct request_queue *q, struct bio **bio)
 337 {
 338 }
 339 #endif /* CONFIG_BOUNCE */
 340
 341 #ifdef CONFIG_BLK_CGROUP_IOLATENCY
 342 extern int blk_iolatency_init(struct request_queue *q);
 343 #else
 344 static inline int blk_iolatency_init(struct request_queue *q) { return 0; }
 345 #endif
 346
 347 struct bio *blk_next_bio(struct bio *bio, unsigned int nr_pages, gfp_t gfp);
 348
 349 #ifdef CONFIG_BLK_DEV_ZONED
 350 void blk_queue_free_zone_bitmaps(struct request_queue *q);
 351 #else
 352 static inline void blk_queue_free_zone_bitmaps(struct request_queue *q) {}
 353 #endif
 354
 355 struct hd_struct *disk_map_sector_rcu(struct gendisk *disk, sector_t sector);
 356
 357 int blk_alloc_devt(struct hd_struct *part, dev_t *devt);
 358 void blk_free_devt(dev_t devt);
 359 void blk_invalidate_devt(dev_t devt);
 360 char *disk_name(struct gendisk *hd, int partno, char *buf);
 361 #define ADDPART_FLAG_NONE       0
 362 #define ADDPART_FLAG_RAID       1
 363 #define ADDPART_FLAG_WHOLEDISK  2
 364 void delete_partition(struct hd_struct *part);
 365 int bdev_add_partition(struct block_device *bdev, int partno,
 366                 sector_t start, sector_t length);
 367 int bdev_del_partition(struct block_device *bdev, int partno);
 368 int bdev_resize_partition(struct block_device *bdev, int partno,
 369                 sector_t start, sector_t length);
 370 int disk_expand_part_tbl(struct gendisk *disk, int target);
 371 int hd_ref_init(struct hd_struct *part);
 372
 373 /* no need to get/put refcount of part0 */
 374 static inline int hd_struct_try_get(struct hd_struct *part)
 375 {
 376         if (part->partno)
 377                 return percpu_ref_tryget_live(&part->ref);
 378         return 1;
 379 }
 380
 381 static inline void hd_struct_put(struct hd_struct *part)
 382 {
 383         if (part->partno)
 384                 percpu_ref_put(&part->ref);
 385 }
 386
 387 static inline void hd_free_part(struct hd_struct *part)
 388 {
 389         free_percpu(part->dkstats);
 390         kfree(part->info);
 391         percpu_ref_exit(&part->ref);
 392 }
 393
 394 /*
 395  * Any access of part->nr_sects which is not protected by partition
 396  * bd_mutex or gendisk bdev bd_mutex, should be done using this
 397  * accessor function.
 398  *
 399  * Code written along the lines of i_size_read() and i_size_write().
 400  * CONFIG_PREEMPTION case optimizes the case of UP kernel with preemption
 401  * on.
 402  */
 403 static inline sector_t part_nr_sects_read(struct hd_struct *part)
 404 {
 405 #if BITS_PER_LONG==32 && defined(CONFIG_SMP)
 406         sector_t nr_sects;
 407         unsigned seq;
 408         do {
 409                 seq = read_seqcount_begin(&part->nr_sects_seq);
 410                 nr_sects = part->nr_sects;
 411         } while (read_seqcount_retry(&part->nr_sects_seq, seq));
 412         return nr_sects;
 413 #elif BITS_PER_LONG==32 && defined(CONFIG_PREEMPTION)
 414         sector_t nr_sects;
 415
 416         preempt_disable();
 417         nr_sects = part->nr_sects;
 418         preempt_enable();
 419         return nr_sects;
 420 #else
 421         return part->nr_sects;
 422 #endif
 423 }
 424
 425 /*
 426  * Should be called with mutex lock held (typically bd_mutex) of partition
 427  * to provide mutual exlusion among writers otherwise seqcount might be
 428  * left in wrong state leaving the readers spinning infinitely.
 429  */
 430 static inline void part_nr_sects_write(struct hd_struct *part, sector_t size)
 431 {
 432 #if BITS_PER_LONG==32 && defined(CONFIG_SMP)
 433         preempt_disable();
 434         write_seqcount_begin(&part->nr_sects_seq);
 435         part->nr_sects = size;
 436         write_seqcount_end(&part->nr_sects_seq);
 437         preempt_enable();
 438 #elif BITS_PER_LONG==32 && defined(CONFIG_PREEMPTION)
 439         preempt_disable();
 440         part->nr_sects = size;
 441         preempt_enable();
 442 #else
 443         part->nr_sects = size;
 444 #endif
 445 }
 446
 447 int bio_add_hw_page(struct request_queue *q, struct bio *bio,
 448                 struct page *page, unsigned int len, unsigned int offset,
 449                 unsigned int max_sectors, bool *same_page);
 450
 451 #endif /* BLK_INTERNAL_H */