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         spinlock_t              mq_flush_lock;
  29 };
  30
  31 extern struct kmem_cache *blk_requestq_cachep;
  32 extern struct kobj_type blk_queue_ktype;
  33 extern struct ida blk_queue_ida;
  34
  35 static inline struct blk_flush_queue *
  36 blk_get_flush_queue(struct request_queue *q, struct blk_mq_ctx *ctx)
  37 {
  38         return blk_mq_map_queue(q, REQ_OP_FLUSH, ctx)->fq;
  39 }
  40
  41 static inline void __blk_get_queue(struct request_queue *q)
  42 {
  43         kobject_get(&q->kobj);
  44 }
  45
  46 static inline bool
  47 is_flush_rq(struct request *req, struct blk_mq_hw_ctx *hctx)
  48 {
  49         return hctx->fq->flush_rq == req;
  50 }
  51
  52 struct blk_flush_queue *blk_alloc_flush_queue(int node, int cmd_size,
  53                                               gfp_t flags);
  54 void blk_free_flush_queue(struct blk_flush_queue *q);
  55
  56 void blk_freeze_queue(struct request_queue *q);
  57
  58 static inline bool biovec_phys_mergeable(struct request_queue *q,
  59                 struct bio_vec *vec1, struct bio_vec *vec2)
  60 {
  61         unsigned long mask = queue_segment_boundary(q);
  62         phys_addr_t addr1 = page_to_phys(vec1->bv_page) + vec1->bv_offset;
  63         phys_addr_t addr2 = page_to_phys(vec2->bv_page) + vec2->bv_offset;
  64
  65         if (addr1 + vec1->bv_len != addr2)
  66                 return false;
  67         if (xen_domain() && !xen_biovec_phys_mergeable(vec1, vec2->bv_page))
  68                 return false;
  69         if ((addr1 | mask) != ((addr2 + vec2->bv_len - 1) | mask))
  70                 return false;
  71         return true;
  72 }
  73
  74 static inline bool __bvec_gap_to_prev(struct request_queue *q,
  75                 struct bio_vec *bprv, unsigned int offset)
  76 {
  77         return (offset & queue_virt_boundary(q)) ||
  78                 ((bprv->bv_offset + bprv->bv_len) & queue_virt_boundary(q));
  79 }
  80
  81 /*
  82  * Check if adding a bio_vec after bprv with offset would create a gap in
  83  * the SG list. Most drivers don't care about this, but some do.
  84  */
  85 static inline bool bvec_gap_to_prev(struct request_queue *q,
  86                 struct bio_vec *bprv, unsigned int offset)
  87 {
  88         if (!queue_virt_boundary(q))
  89                 return false;
  90         return __bvec_gap_to_prev(q, bprv, offset);
  91 }
  92
  93 static inline void blk_rq_bio_prep(struct request *rq, struct bio *bio,
  94                 unsigned int nr_segs)
  95 {
  96         rq->nr_phys_segments = nr_segs;
  97         rq->__data_len = bio->bi_iter.bi_size;
  98         rq->bio = rq->biotail = bio;
  99         rq->ioprio = bio_prio(bio);
 100
 101         if (bio->bi_disk)
 102                 rq->rq_disk = bio->bi_disk;
 103 }
 104
 105 #ifdef CONFIG_BLK_DEV_INTEGRITY
 106 void blk_flush_integrity(void);
 107 bool __bio_integrity_endio(struct bio *);
 108 void bio_integrity_free(struct bio *bio);
 109 static inline bool bio_integrity_endio(struct bio *bio)
 110 {
 111         if (bio_integrity(bio))
 112                 return __bio_integrity_endio(bio);
 113         return true;
 114 }
 115
 116 bool blk_integrity_merge_rq(struct request_queue *, struct request *,
 117                 struct request *);
 118 bool blk_integrity_merge_bio(struct request_queue *, struct request *,
 119                 struct bio *);
 120
 121 static inline bool integrity_req_gap_back_merge(struct request *req,
 122                 struct bio *next)
 123 {
 124         struct bio_integrity_payload *bip = bio_integrity(req->bio);
 125         struct bio_integrity_payload *bip_next = bio_integrity(next);
 126
 127         return bvec_gap_to_prev(req->q, &bip->bip_vec[bip->bip_vcnt - 1],
 128                                 bip_next->bip_vec[0].bv_offset);
 129 }
 130
 131 static inline bool integrity_req_gap_front_merge(struct request *req,
 132                 struct bio *bio)
 133 {
 134         struct bio_integrity_payload *bip = bio_integrity(bio);
 135         struct bio_integrity_payload *bip_next = bio_integrity(req->bio);
 136
 137         return bvec_gap_to_prev(req->q, &bip->bip_vec[bip->bip_vcnt - 1],
 138                                 bip_next->bip_vec[0].bv_offset);
 139 }
 140
 141 void blk_integrity_add(struct gendisk *);
 142 void blk_integrity_del(struct gendisk *);
 143 #else /* CONFIG_BLK_DEV_INTEGRITY */
 144 static inline bool blk_integrity_merge_rq(struct request_queue *rq,
 145                 struct request *r1, struct request *r2)
 146 {
 147         return true;
 148 }
 149 static inline bool blk_integrity_merge_bio(struct request_queue *rq,
 150                 struct request *r, struct bio *b)
 151 {
 152         return true;
 153 }
 154 static inline bool integrity_req_gap_back_merge(struct request *req,
 155                 struct bio *next)
 156 {
 157         return false;
 158 }
 159 static inline bool integrity_req_gap_front_merge(struct request *req,
 160                 struct bio *bio)
 161 {
 162         return false;
 163 }
 164
 165 static inline void blk_flush_integrity(void)
 166 {
 167 }
 168 static inline bool bio_integrity_endio(struct bio *bio)
 169 {
 170         return true;
 171 }
 172 static inline void bio_integrity_free(struct bio *bio)
 173 {
 174 }
 175 static inline void blk_integrity_add(struct gendisk *disk)
 176 {
 177 }
 178 static inline void blk_integrity_del(struct gendisk *disk)
 179 {
 180 }
 181 #endif /* CONFIG_BLK_DEV_INTEGRITY */
 182
 183 unsigned long blk_rq_timeout(unsigned long timeout);
 184 void blk_add_timer(struct request *req);
 185
 186 bool blk_attempt_plug_merge(struct request_queue *q, struct bio *bio,
 187                 unsigned int nr_segs, struct request **same_queue_rq);
 188 bool blk_bio_list_merge(struct request_queue *q, struct list_head *list,
 189                         struct bio *bio, unsigned int nr_segs);
 190
 191 void blk_account_io_start(struct request *req);
 192 void blk_account_io_done(struct request *req, u64 now);
 193
 194 /*
 195  * Internal elevator interface
 196  */
 197 #define ELV_ON_HASH(rq) ((rq)->rq_flags & RQF_HASHED)
 198
 199 void blk_insert_flush(struct request *rq);
 200
 201 void elevator_init_mq(struct request_queue *q);
 202 int elevator_switch_mq(struct request_queue *q,
 203                               struct elevator_type *new_e);
 204 void __elevator_exit(struct request_queue *, struct elevator_queue *);
 205 int elv_register_queue(struct request_queue *q, bool uevent);
 206 void elv_unregister_queue(struct request_queue *q);
 207
 208 static inline void elevator_exit(struct request_queue *q,
 209                 struct elevator_queue *e)
 210 {
 211         lockdep_assert_held(&q->sysfs_lock);
 212
 213         blk_mq_sched_free_requests(q);
 214         __elevator_exit(q, e);
 215 }
 216
 217 struct block_device *__disk_get_part(struct gendisk *disk, int partno);
 218
 219 ssize_t part_size_show(struct device *dev, struct device_attribute *attr,
 220                 char *buf);
 221 ssize_t part_stat_show(struct device *dev, struct device_attribute *attr,
 222                 char *buf);
 223 ssize_t part_inflight_show(struct device *dev, struct device_attribute *attr,
 224                 char *buf);
 225 ssize_t part_fail_show(struct device *dev, struct device_attribute *attr,
 226                 char *buf);
 227 ssize_t part_fail_store(struct device *dev, struct device_attribute *attr,
 228                 const char *buf, size_t count);
 229 ssize_t part_timeout_show(struct device *, struct device_attribute *, char *);
 230 ssize_t part_timeout_store(struct device *, struct device_attribute *,
 231                                 const char *, size_t);
 232
 233 void __blk_queue_split(struct bio **bio, unsigned int *nr_segs);
 234 int ll_back_merge_fn(struct request *req, struct bio *bio,
 235                 unsigned int nr_segs);
 236 int blk_attempt_req_merge(struct request_queue *q, struct request *rq,
 237                                 struct request *next);
 238 unsigned int blk_recalc_rq_segments(struct request *rq);
 239 void blk_rq_set_mixed_merge(struct request *rq);
 240 bool blk_rq_merge_ok(struct request *rq, struct bio *bio);
 241 enum elv_merge blk_try_merge(struct request *rq, struct bio *bio);
 242
 243 int blk_dev_init(void);
 244
 245 /*
 246  * Contribute to IO statistics IFF:
 247  *
 248  *      a) it's attached to a gendisk, and
 249  *      b) the queue had IO stats enabled when this request was started
 250  */
 251 static inline bool blk_do_io_stat(struct request *rq)
 252 {
 253         return rq->rq_disk && (rq->rq_flags & RQF_IO_STAT);
 254 }
 255
 256 static inline void req_set_nomerge(struct request_queue *q, struct request *req)
 257 {
 258         req->cmd_flags |= REQ_NOMERGE;
 259         if (req == q->last_merge)
 260                 q->last_merge = NULL;
 261 }
 262
 263 /*
 264  * The max size one bio can handle is UINT_MAX becasue bvec_iter.bi_size
 265  * is defined as 'unsigned int', meantime it has to aligned to with logical
 266  * block size which is the minimum accepted unit by hardware.
 267  */
 268 static inline unsigned int bio_allowed_max_sectors(struct request_queue *q)
 269 {
 270         return round_down(UINT_MAX, queue_logical_block_size(q)) >> 9;
 271 }
 272
 273 /*
 274  * The max bio size which is aligned to q->limits.discard_granularity. This
 275  * is a hint to split large discard bio in generic block layer, then if device
 276  * driver needs to split the discard bio into smaller ones, their bi_size can
 277  * be very probably and easily aligned to discard_granularity of the device's
 278  * queue.
 279  */
 280 static inline unsigned int bio_aligned_discard_max_sectors(
 281                                         struct request_queue *q)
 282 {
 283         return round_down(UINT_MAX, q->limits.discard_granularity) >>
 284                         SECTOR_SHIFT;
 285 }
 286
 287 /*
 288  * Internal io_context interface
 289  */
 290 void get_io_context(struct io_context *ioc);
 291 struct io_cq *ioc_lookup_icq(struct io_context *ioc, struct request_queue *q);
 292 struct io_cq *ioc_create_icq(struct io_context *ioc, struct request_queue *q,
 293                              gfp_t gfp_mask);
 294 void ioc_clear_queue(struct request_queue *q);
 295
 296 int create_task_io_context(struct task_struct *task, gfp_t gfp_mask, int node);
 297
 298 /*
 299  * Internal throttling interface
 300  */
 301 #ifdef CONFIG_BLK_DEV_THROTTLING
 302 extern int blk_throtl_init(struct request_queue *q);
 303 extern void blk_throtl_exit(struct request_queue *q);
 304 extern void blk_throtl_register_queue(struct request_queue *q);
 305 bool blk_throtl_bio(struct bio *bio);
 306 #else /* CONFIG_BLK_DEV_THROTTLING */
 307 static inline int blk_throtl_init(struct request_queue *q) { return 0; }
 308 static inline void blk_throtl_exit(struct request_queue *q) { }
 309 static inline void blk_throtl_register_queue(struct request_queue *q) { }
 310 static inline bool blk_throtl_bio(struct bio *bio) { return false; }
 311 #endif /* CONFIG_BLK_DEV_THROTTLING */
 312 #ifdef CONFIG_BLK_DEV_THROTTLING_LOW
 313 extern ssize_t blk_throtl_sample_time_show(struct request_queue *q, char *page);
 314 extern ssize_t blk_throtl_sample_time_store(struct request_queue *q,
 315         const char *page, size_t count);
 316 extern void blk_throtl_bio_endio(struct bio *bio);
 317 extern void blk_throtl_stat_add(struct request *rq, u64 time);
 318 #else
 319 static inline void blk_throtl_bio_endio(struct bio *bio) { }
 320 static inline void blk_throtl_stat_add(struct request *rq, u64 time) { }
 321 #endif
 322
 323 #ifdef CONFIG_BOUNCE
 324 extern int init_emergency_isa_pool(void);
 325 extern void blk_queue_bounce(struct request_queue *q, struct bio **bio);
 326 #else
 327 static inline int init_emergency_isa_pool(void)
 328 {
 329         return 0;
 330 }
 331 static inline void blk_queue_bounce(struct request_queue *q, struct bio **bio)
 332 {
 333 }
 334 #endif /* CONFIG_BOUNCE */
 335
 336 #ifdef CONFIG_BLK_CGROUP_IOLATENCY
 337 extern int blk_iolatency_init(struct request_queue *q);
 338 #else
 339 static inline int blk_iolatency_init(struct request_queue *q) { return 0; }
 340 #endif
 341
 342 struct bio *blk_next_bio(struct bio *bio, unsigned int nr_pages, gfp_t gfp);
 343
 344 #ifdef CONFIG_BLK_DEV_ZONED
 345 void blk_queue_free_zone_bitmaps(struct request_queue *q);
 346 #else
 347 static inline void blk_queue_free_zone_bitmaps(struct request_queue *q) {}
 348 #endif
 349
 350 struct block_device *disk_map_sector_rcu(struct gendisk *disk, sector_t sector);
 351
 352 int blk_alloc_devt(struct block_device *part, dev_t *devt);
 353 void blk_free_devt(dev_t devt);
 354 char *disk_name(struct gendisk *hd, int partno, char *buf);
 355 #define ADDPART_FLAG_NONE       0
 356 #define ADDPART_FLAG_RAID       1
 357 #define ADDPART_FLAG_WHOLEDISK  2
 358 void delete_partition(struct block_device *part);
 359 int bdev_add_partition(struct block_device *bdev, int partno,
 360                 sector_t start, sector_t length);
 361 int bdev_del_partition(struct block_device *bdev, int partno);
 362 int bdev_resize_partition(struct block_device *bdev, int partno,
 363                 sector_t start, sector_t length);
 364 int disk_expand_part_tbl(struct gendisk *disk, int target);
 365
 366 int bio_add_hw_page(struct request_queue *q, struct bio *bio,
 367                 struct page *page, unsigned int len, unsigned int offset,
 368                 unsigned int max_sectors, bool *same_page);
 369
 370 #endif /* BLK_INTERNAL_H */