null_blk: Delete nullb.{queue_depth, nr_queues}
[linux-block.git] / block / blk-settings.c
CommitLineData
3dcf60bc 1// SPDX-License-Identifier: GPL-2.0
86db1e29
JA
2/*
3 * Functions related to setting various queue properties from drivers
4 */
5#include <linux/kernel.h>
6#include <linux/module.h>
7#include <linux/init.h>
8#include <linux/bio.h>
9#include <linux/blkdev.h>
4ee60ec1 10#include <linux/pagemap.h>
edb0872f 11#include <linux/backing-dev-defs.h>
70dd5bf3 12#include <linux/gcd.h>
2cda2728 13#include <linux/lcm.h>
ad5ebd2f 14#include <linux/jiffies.h>
5a0e3ad6 15#include <linux/gfp.h>
45147fb5 16#include <linux/dma-mapping.h>
86db1e29
JA
17
18#include "blk.h"
0bc65bd4 19#include "blk-rq-qos.h"
87760e5e 20#include "blk-wbt.h"
86db1e29 21
242f9dcb
JA
22void blk_queue_rq_timeout(struct request_queue *q, unsigned int timeout)
23{
24 q->rq_timeout = timeout;
25}
26EXPORT_SYMBOL_GPL(blk_queue_rq_timeout);
27
b1bd055d
MP
28/**
29 * blk_set_stacking_limits - set default limits for stacking devices
30 * @lim: the queue_limits structure to reset
31 *
c490f226
CH
32 * Prepare queue limits for applying limits from underlying devices using
33 * blk_stack_limits().
b1bd055d
MP
34 */
35void blk_set_stacking_limits(struct queue_limits *lim)
36{
c490f226
CH
37 memset(lim, 0, sizeof(*lim));
38 lim->logical_block_size = SECTOR_SIZE;
39 lim->physical_block_size = SECTOR_SIZE;
40 lim->io_min = SECTOR_SIZE;
41 lim->discard_granularity = SECTOR_SIZE;
42 lim->dma_alignment = SECTOR_SIZE - 1;
43 lim->seg_boundary_mask = BLK_SEG_BOUNDARY_MASK;
b1bd055d
MP
44
45 /* Inherit limits from component devices */
b1bd055d 46 lim->max_segments = USHRT_MAX;
42c9cdfe 47 lim->max_discard_segments = USHRT_MAX;
b1bd055d 48 lim->max_hw_sectors = UINT_MAX;
d82ae52e 49 lim->max_segment_size = UINT_MAX;
fe86cdce 50 lim->max_sectors = UINT_MAX;
ca369d51 51 lim->max_dev_sectors = UINT_MAX;
a6f0788e 52 lim->max_write_zeroes_sectors = UINT_MAX;
0512a75b 53 lim->max_zone_append_sectors = UINT_MAX;
4f563a64 54 lim->max_user_discard_sectors = UINT_MAX;
b1bd055d
MP
55}
56EXPORT_SYMBOL(blk_set_stacking_limits);
57
b9947297
CH
58static void blk_apply_bdi_limits(struct backing_dev_info *bdi,
59 struct queue_limits *lim)
60{
61 /*
62 * For read-ahead of large files to be effective, we need to read ahead
63 * at least twice the optimal I/O size.
64 */
65 bdi->ra_pages = max(lim->io_opt * 2 / PAGE_SIZE, VM_READAHEAD_PAGES);
66 bdi->io_pages = lim->max_sectors >> PAGE_SECTORS_SHIFT;
67}
68
d690cb8a
CH
69static int blk_validate_zoned_limits(struct queue_limits *lim)
70{
71 if (!lim->zoned) {
72 if (WARN_ON_ONCE(lim->max_open_zones) ||
73 WARN_ON_ONCE(lim->max_active_zones) ||
74 WARN_ON_ONCE(lim->zone_write_granularity) ||
75 WARN_ON_ONCE(lim->max_zone_append_sectors))
76 return -EINVAL;
77 return 0;
78 }
79
80 if (WARN_ON_ONCE(!IS_ENABLED(CONFIG_BLK_DEV_ZONED)))
81 return -EINVAL;
82
83 if (lim->zone_write_granularity < lim->logical_block_size)
84 lim->zone_write_granularity = lim->logical_block_size;
85
86 if (lim->max_zone_append_sectors) {
87 /*
88 * The Zone Append size is limited by the maximum I/O size
89 * and the zone size given that it can't span zones.
90 */
91 lim->max_zone_append_sectors =
92 min3(lim->max_hw_sectors,
93 lim->max_zone_append_sectors,
94 lim->chunk_sectors);
95 }
96
97 return 0;
98}
99
100/*
101 * Check that the limits in lim are valid, initialize defaults for unset
102 * values, and cap values based on others where needed.
103 */
104static int blk_validate_limits(struct queue_limits *lim)
105{
106 unsigned int max_hw_sectors;
107
108 /*
109 * Unless otherwise specified, default to 512 byte logical blocks and a
110 * physical block size equal to the logical block size.
111 */
112 if (!lim->logical_block_size)
113 lim->logical_block_size = SECTOR_SIZE;
114 if (lim->physical_block_size < lim->logical_block_size)
115 lim->physical_block_size = lim->logical_block_size;
116
117 /*
118 * The minimum I/O size defaults to the physical block size unless
119 * explicitly overridden.
120 */
121 if (lim->io_min < lim->physical_block_size)
122 lim->io_min = lim->physical_block_size;
123
124 /*
125 * max_hw_sectors has a somewhat weird default for historical reason,
126 * but driver really should set their own instead of relying on this
127 * value.
128 *
129 * The block layer relies on the fact that every driver can
130 * handle at lest a page worth of data per I/O, and needs the value
131 * aligned to the logical block size.
132 */
133 if (!lim->max_hw_sectors)
134 lim->max_hw_sectors = BLK_SAFE_MAX_SECTORS;
135 if (WARN_ON_ONCE(lim->max_hw_sectors < PAGE_SECTORS))
136 return -EINVAL;
137 lim->max_hw_sectors = round_down(lim->max_hw_sectors,
138 lim->logical_block_size >> SECTOR_SHIFT);
139
140 /*
141 * The actual max_sectors value is a complex beast and also takes the
142 * max_dev_sectors value (set by SCSI ULPs) and a user configurable
143 * value into account. The ->max_sectors value is always calculated
144 * from these, so directly setting it won't have any effect.
145 */
146 max_hw_sectors = min_not_zero(lim->max_hw_sectors,
147 lim->max_dev_sectors);
148 if (lim->max_user_sectors) {
149 if (lim->max_user_sectors > max_hw_sectors ||
150 lim->max_user_sectors < PAGE_SIZE / SECTOR_SIZE)
151 return -EINVAL;
152 lim->max_sectors = min(max_hw_sectors, lim->max_user_sectors);
153 } else {
154 lim->max_sectors = min(max_hw_sectors, BLK_DEF_MAX_SECTORS_CAP);
155 }
156 lim->max_sectors = round_down(lim->max_sectors,
157 lim->logical_block_size >> SECTOR_SHIFT);
158
159 /*
160 * Random default for the maximum number of segments. Driver should not
161 * rely on this and set their own.
162 */
163 if (!lim->max_segments)
164 lim->max_segments = BLK_MAX_SEGMENTS;
165
4f563a64
CH
166 lim->max_discard_sectors =
167 min(lim->max_hw_discard_sectors, lim->max_user_discard_sectors);
168
d690cb8a
CH
169 if (!lim->max_discard_segments)
170 lim->max_discard_segments = 1;
171
172 if (lim->discard_granularity < lim->physical_block_size)
173 lim->discard_granularity = lim->physical_block_size;
174
175 /*
176 * By default there is no limit on the segment boundary alignment,
177 * but if there is one it can't be smaller than the page size as
178 * that would break all the normal I/O patterns.
179 */
180 if (!lim->seg_boundary_mask)
181 lim->seg_boundary_mask = BLK_SEG_BOUNDARY_MASK;
182 if (WARN_ON_ONCE(lim->seg_boundary_mask < PAGE_SIZE - 1))
183 return -EINVAL;
184
d690cb8a
CH
185 /*
186 * Devices that require a virtual boundary do not support scatter/gather
187 * I/O natively, but instead require a descriptor list entry for each
188 * page (which might not be identical to the Linux PAGE_SIZE). Because
189 * of that they are not limited by our notion of "segment size".
190 */
191 if (lim->virt_boundary_mask) {
192 if (WARN_ON_ONCE(lim->max_segment_size &&
193 lim->max_segment_size != UINT_MAX))
194 return -EINVAL;
195 lim->max_segment_size = UINT_MAX;
a3911966
CH
196 } else {
197 /*
198 * The maximum segment size has an odd historic 64k default that
199 * drivers probably should override. Just like the I/O size we
200 * require drivers to at least handle a full page per segment.
201 */
202 if (!lim->max_segment_size)
203 lim->max_segment_size = BLK_MAX_SEGMENT_SIZE;
204 if (WARN_ON_ONCE(lim->max_segment_size < PAGE_SIZE))
205 return -EINVAL;
d690cb8a
CH
206 }
207
208 /*
209 * We require drivers to at least do logical block aligned I/O, but
210 * historically could not check for that due to the separate calls
211 * to set the limits. Once the transition is finished the check
212 * below should be narrowed down to check the logical block size.
213 */
214 if (!lim->dma_alignment)
215 lim->dma_alignment = SECTOR_SIZE - 1;
216 if (WARN_ON_ONCE(lim->dma_alignment > PAGE_SIZE))
217 return -EINVAL;
218
219 if (lim->alignment_offset) {
220 lim->alignment_offset &= (lim->physical_block_size - 1);
221 lim->misaligned = 0;
222 }
223
224 return blk_validate_zoned_limits(lim);
225}
226
227/*
228 * Set the default limits for a newly allocated queue. @lim contains the
229 * initial limits set by the driver, which could be no limit in which case
230 * all fields are cleared to zero.
231 */
232int blk_set_default_limits(struct queue_limits *lim)
233{
4f563a64
CH
234 /*
235 * Most defaults are set by capping the bounds in blk_validate_limits,
236 * but max_user_discard_sectors is special and needs an explicit
237 * initialization to the max value here.
238 */
239 lim->max_user_discard_sectors = UINT_MAX;
d690cb8a
CH
240 return blk_validate_limits(lim);
241}
242
243/**
244 * queue_limits_commit_update - commit an atomic update of queue limits
245 * @q: queue to update
246 * @lim: limits to apply
247 *
248 * Apply the limits in @lim that were obtained from queue_limits_start_update()
249 * and updated by the caller to @q.
250 *
251 * Returns 0 if successful, else a negative error code.
252 */
253int queue_limits_commit_update(struct request_queue *q,
254 struct queue_limits *lim)
255 __releases(q->limits_lock)
256{
257 int error = blk_validate_limits(lim);
258
259 if (!error) {
260 q->limits = *lim;
261 if (q->disk)
262 blk_apply_bdi_limits(q->disk->bdi, lim);
263 }
264 mutex_unlock(&q->limits_lock);
265 return error;
266}
267EXPORT_SYMBOL_GPL(queue_limits_commit_update);
268
86db1e29
JA
269/**
270 * blk_queue_bounce_limit - set bounce buffer limit for queue
cd0aca2d 271 * @q: the request queue for the device
9bb33f24 272 * @bounce: bounce limit to enforce
86db1e29
JA
273 *
274 * Description:
9bb33f24
CH
275 * Force bouncing for ISA DMA ranges or highmem.
276 *
277 * DEPRECATED, don't use in new code.
86db1e29 278 **/
9bb33f24 279void blk_queue_bounce_limit(struct request_queue *q, enum blk_bounce bounce)
86db1e29 280{
9bb33f24 281 q->limits.bounce = bounce;
86db1e29 282}
86db1e29
JA
283EXPORT_SYMBOL(blk_queue_bounce_limit);
284
285/**
ca369d51
MP
286 * blk_queue_max_hw_sectors - set max sectors for a request for this queue
287 * @q: the request queue for the device
2800aac1 288 * @max_hw_sectors: max hardware sectors in the usual 512b unit
86db1e29
JA
289 *
290 * Description:
2800aac1
MP
291 * Enables a low level driver to set a hard upper limit,
292 * max_hw_sectors, on the size of requests. max_hw_sectors is set by
4f258a46
MP
293 * the device driver based upon the capabilities of the I/O
294 * controller.
2800aac1 295 *
ca369d51
MP
296 * max_dev_sectors is a hard limit imposed by the storage device for
297 * READ/WRITE requests. It is set by the disk driver.
298 *
2800aac1
MP
299 * max_sectors is a soft limit imposed by the block layer for
300 * filesystem type requests. This value can be overridden on a
301 * per-device basis in /sys/block/<device>/queue/max_sectors_kb.
302 * The soft limit can not exceed max_hw_sectors.
86db1e29 303 **/
ca369d51 304void blk_queue_max_hw_sectors(struct request_queue *q, unsigned int max_hw_sectors)
86db1e29 305{
ca369d51
MP
306 struct queue_limits *limits = &q->limits;
307 unsigned int max_sectors;
308
09cbfeaf
KS
309 if ((max_hw_sectors << 9) < PAGE_SIZE) {
310 max_hw_sectors = 1 << (PAGE_SHIFT - 9);
f19d1e3b 311 pr_info("%s: set to minimum %u\n", __func__, max_hw_sectors);
86db1e29
JA
312 }
313
817046ec
DLM
314 max_hw_sectors = round_down(max_hw_sectors,
315 limits->logical_block_size >> SECTOR_SHIFT);
30e2bc08 316 limits->max_hw_sectors = max_hw_sectors;
817046ec 317
ca369d51 318 max_sectors = min_not_zero(max_hw_sectors, limits->max_dev_sectors);
c9c77418
KB
319
320 if (limits->max_user_sectors)
321 max_sectors = min(max_sectors, limits->max_user_sectors);
322 else
d6b9f4e6 323 max_sectors = min(max_sectors, BLK_DEF_MAX_SECTORS_CAP);
c9c77418 324
817046ec
DLM
325 max_sectors = round_down(max_sectors,
326 limits->logical_block_size >> SECTOR_SHIFT);
ca369d51 327 limits->max_sectors = max_sectors;
817046ec 328
d152c682 329 if (!q->disk)
edb0872f 330 return;
d152c682 331 q->disk->bdi->io_pages = max_sectors >> (PAGE_SHIFT - 9);
86db1e29 332}
086fa5ff 333EXPORT_SYMBOL(blk_queue_max_hw_sectors);
86db1e29 334
762380ad
JA
335/**
336 * blk_queue_chunk_sectors - set size of the chunk for this queue
337 * @q: the request queue for the device
338 * @chunk_sectors: chunk sectors in the usual 512b unit
339 *
340 * Description:
341 * If a driver doesn't want IOs to cross a given chunk size, it can set
07d098e6
MS
342 * this limit and prevent merging across chunks. Note that the block layer
343 * must accept a page worth of data at any offset. So if the crossing of
344 * chunks is a hard limitation in the driver, it must still be prepared
345 * to split single page bios.
762380ad
JA
346 **/
347void blk_queue_chunk_sectors(struct request_queue *q, unsigned int chunk_sectors)
348{
762380ad
JA
349 q->limits.chunk_sectors = chunk_sectors;
350}
351EXPORT_SYMBOL(blk_queue_chunk_sectors);
352
67efc925
CH
353/**
354 * blk_queue_max_discard_sectors - set max sectors for a single discard
355 * @q: the request queue for the device
c7ebf065 356 * @max_discard_sectors: maximum number of sectors to discard
67efc925
CH
357 **/
358void blk_queue_max_discard_sectors(struct request_queue *q,
359 unsigned int max_discard_sectors)
360{
4f563a64
CH
361 struct queue_limits *lim = &q->limits;
362
363 lim->max_hw_discard_sectors = max_discard_sectors;
364 lim->max_discard_sectors =
365 min(max_discard_sectors, lim->max_user_discard_sectors);
67efc925
CH
366}
367EXPORT_SYMBOL(blk_queue_max_discard_sectors);
368
44abff2c
CH
369/**
370 * blk_queue_max_secure_erase_sectors - set max sectors for a secure erase
371 * @q: the request queue for the device
372 * @max_sectors: maximum number of sectors to secure_erase
373 **/
374void blk_queue_max_secure_erase_sectors(struct request_queue *q,
375 unsigned int max_sectors)
376{
377 q->limits.max_secure_erase_sectors = max_sectors;
378}
379EXPORT_SYMBOL(blk_queue_max_secure_erase_sectors);
380
a6f0788e
CK
381/**
382 * blk_queue_max_write_zeroes_sectors - set max sectors for a single
383 * write zeroes
384 * @q: the request queue for the device
385 * @max_write_zeroes_sectors: maximum number of sectors to write per command
386 **/
387void blk_queue_max_write_zeroes_sectors(struct request_queue *q,
388 unsigned int max_write_zeroes_sectors)
389{
390 q->limits.max_write_zeroes_sectors = max_write_zeroes_sectors;
391}
392EXPORT_SYMBOL(blk_queue_max_write_zeroes_sectors);
393
0512a75b
KB
394/**
395 * blk_queue_max_zone_append_sectors - set max sectors for a single zone append
396 * @q: the request queue for the device
397 * @max_zone_append_sectors: maximum number of sectors to write per command
398 **/
399void blk_queue_max_zone_append_sectors(struct request_queue *q,
400 unsigned int max_zone_append_sectors)
401{
402 unsigned int max_sectors;
403
404 if (WARN_ON(!blk_queue_is_zoned(q)))
405 return;
406
407 max_sectors = min(q->limits.max_hw_sectors, max_zone_append_sectors);
408 max_sectors = min(q->limits.chunk_sectors, max_sectors);
409
410 /*
411 * Signal eventual driver bugs resulting in the max_zone_append sectors limit
412 * being 0 due to a 0 argument, the chunk_sectors limit (zone size) not set,
413 * or the max_hw_sectors limit not set.
414 */
415 WARN_ON(!max_sectors);
416
417 q->limits.max_zone_append_sectors = max_sectors;
418}
419EXPORT_SYMBOL_GPL(blk_queue_max_zone_append_sectors);
420
86db1e29 421/**
8a78362c 422 * blk_queue_max_segments - set max hw segments for a request for this queue
86db1e29
JA
423 * @q: the request queue for the device
424 * @max_segments: max number of segments
425 *
426 * Description:
427 * Enables a low level driver to set an upper limit on the number of
8a78362c 428 * hw data segments in a request.
86db1e29 429 **/
8a78362c 430void blk_queue_max_segments(struct request_queue *q, unsigned short max_segments)
86db1e29
JA
431{
432 if (!max_segments) {
433 max_segments = 1;
f19d1e3b 434 pr_info("%s: set to minimum %u\n", __func__, max_segments);
86db1e29
JA
435 }
436
8a78362c 437 q->limits.max_segments = max_segments;
86db1e29 438}
8a78362c 439EXPORT_SYMBOL(blk_queue_max_segments);
86db1e29 440
1e739730
CH
441/**
442 * blk_queue_max_discard_segments - set max segments for discard requests
443 * @q: the request queue for the device
444 * @max_segments: max number of segments
445 *
446 * Description:
447 * Enables a low level driver to set an upper limit on the number of
448 * segments in a discard request.
449 **/
450void blk_queue_max_discard_segments(struct request_queue *q,
451 unsigned short max_segments)
452{
453 q->limits.max_discard_segments = max_segments;
454}
455EXPORT_SYMBOL_GPL(blk_queue_max_discard_segments);
456
86db1e29
JA
457/**
458 * blk_queue_max_segment_size - set max segment size for blk_rq_map_sg
459 * @q: the request queue for the device
460 * @max_size: max size of segment in bytes
461 *
462 * Description:
463 * Enables a low level driver to set an upper limit on the size of a
464 * coalesced segment
465 **/
466void blk_queue_max_segment_size(struct request_queue *q, unsigned int max_size)
467{
09cbfeaf
KS
468 if (max_size < PAGE_SIZE) {
469 max_size = PAGE_SIZE;
f19d1e3b 470 pr_info("%s: set to minimum %u\n", __func__, max_size);
86db1e29
JA
471 }
472
09324d32
CH
473 /* see blk_queue_virt_boundary() for the explanation */
474 WARN_ON_ONCE(q->limits.virt_boundary_mask);
475
025146e1 476 q->limits.max_segment_size = max_size;
86db1e29 477}
86db1e29
JA
478EXPORT_SYMBOL(blk_queue_max_segment_size);
479
480/**
e1defc4f 481 * blk_queue_logical_block_size - set logical block size for the queue
86db1e29 482 * @q: the request queue for the device
e1defc4f 483 * @size: the logical block size, in bytes
86db1e29
JA
484 *
485 * Description:
e1defc4f
MP
486 * This should be set to the lowest possible block size that the
487 * storage device can address. The default of 512 covers most
488 * hardware.
86db1e29 489 **/
ad6bf88a 490void blk_queue_logical_block_size(struct request_queue *q, unsigned int size)
86db1e29 491{
817046ec
DLM
492 struct queue_limits *limits = &q->limits;
493
494 limits->logical_block_size = size;
495
3c407dc7
CH
496 if (limits->discard_granularity < limits->logical_block_size)
497 limits->discard_granularity = limits->logical_block_size;
498
817046ec
DLM
499 if (limits->physical_block_size < size)
500 limits->physical_block_size = size;
c72758f3 501
817046ec
DLM
502 if (limits->io_min < limits->physical_block_size)
503 limits->io_min = limits->physical_block_size;
c72758f3 504
817046ec
DLM
505 limits->max_hw_sectors =
506 round_down(limits->max_hw_sectors, size >> SECTOR_SHIFT);
507 limits->max_sectors =
508 round_down(limits->max_sectors, size >> SECTOR_SHIFT);
86db1e29 509}
e1defc4f 510EXPORT_SYMBOL(blk_queue_logical_block_size);
86db1e29 511
c72758f3
MP
512/**
513 * blk_queue_physical_block_size - set physical block size for the queue
514 * @q: the request queue for the device
515 * @size: the physical block size, in bytes
516 *
517 * Description:
518 * This should be set to the lowest possible sector size that the
519 * hardware can operate on without reverting to read-modify-write
520 * operations.
521 */
892b6f90 522void blk_queue_physical_block_size(struct request_queue *q, unsigned int size)
c72758f3
MP
523{
524 q->limits.physical_block_size = size;
525
526 if (q->limits.physical_block_size < q->limits.logical_block_size)
527 q->limits.physical_block_size = q->limits.logical_block_size;
528
458aa1a0
CH
529 if (q->limits.discard_granularity < q->limits.physical_block_size)
530 q->limits.discard_granularity = q->limits.physical_block_size;
531
c72758f3
MP
532 if (q->limits.io_min < q->limits.physical_block_size)
533 q->limits.io_min = q->limits.physical_block_size;
534}
535EXPORT_SYMBOL(blk_queue_physical_block_size);
536
a805a4fa
DLM
537/**
538 * blk_queue_zone_write_granularity - set zone write granularity for the queue
539 * @q: the request queue for the zoned device
540 * @size: the zone write granularity size, in bytes
541 *
542 * Description:
543 * This should be set to the lowest possible size allowing to write in
544 * sequential zones of a zoned block device.
545 */
546void blk_queue_zone_write_granularity(struct request_queue *q,
547 unsigned int size)
548{
549 if (WARN_ON_ONCE(!blk_queue_is_zoned(q)))
550 return;
551
552 q->limits.zone_write_granularity = size;
553
554 if (q->limits.zone_write_granularity < q->limits.logical_block_size)
555 q->limits.zone_write_granularity = q->limits.logical_block_size;
556}
557EXPORT_SYMBOL_GPL(blk_queue_zone_write_granularity);
558
c72758f3
MP
559/**
560 * blk_queue_alignment_offset - set physical block alignment offset
561 * @q: the request queue for the device
8ebf9756 562 * @offset: alignment offset in bytes
c72758f3
MP
563 *
564 * Description:
565 * Some devices are naturally misaligned to compensate for things like
566 * the legacy DOS partition table 63-sector offset. Low-level drivers
567 * should call this function for devices whose first sector is not
568 * naturally aligned.
569 */
570void blk_queue_alignment_offset(struct request_queue *q, unsigned int offset)
571{
572 q->limits.alignment_offset =
573 offset & (q->limits.physical_block_size - 1);
574 q->limits.misaligned = 0;
575}
576EXPORT_SYMBOL(blk_queue_alignment_offset);
577
471aa704 578void disk_update_readahead(struct gendisk *disk)
c2e4cd57 579{
b9947297 580 blk_apply_bdi_limits(disk->bdi, &disk->queue->limits);
c2e4cd57 581}
471aa704 582EXPORT_SYMBOL_GPL(disk_update_readahead);
c2e4cd57 583
7c958e32
MP
584/**
585 * blk_limits_io_min - set minimum request size for a device
586 * @limits: the queue limits
587 * @min: smallest I/O size in bytes
588 *
589 * Description:
590 * Some devices have an internal block size bigger than the reported
591 * hardware sector size. This function can be used to signal the
592 * smallest I/O the device can perform without incurring a performance
593 * penalty.
594 */
595void blk_limits_io_min(struct queue_limits *limits, unsigned int min)
596{
597 limits->io_min = min;
598
599 if (limits->io_min < limits->logical_block_size)
600 limits->io_min = limits->logical_block_size;
601
602 if (limits->io_min < limits->physical_block_size)
603 limits->io_min = limits->physical_block_size;
604}
605EXPORT_SYMBOL(blk_limits_io_min);
606
c72758f3
MP
607/**
608 * blk_queue_io_min - set minimum request size for the queue
609 * @q: the request queue for the device
8ebf9756 610 * @min: smallest I/O size in bytes
c72758f3
MP
611 *
612 * Description:
7e5f5fb0
MP
613 * Storage devices may report a granularity or preferred minimum I/O
614 * size which is the smallest request the device can perform without
615 * incurring a performance penalty. For disk drives this is often the
616 * physical block size. For RAID arrays it is often the stripe chunk
617 * size. A properly aligned multiple of minimum_io_size is the
618 * preferred request size for workloads where a high number of I/O
619 * operations is desired.
c72758f3
MP
620 */
621void blk_queue_io_min(struct request_queue *q, unsigned int min)
622{
7c958e32 623 blk_limits_io_min(&q->limits, min);
c72758f3
MP
624}
625EXPORT_SYMBOL(blk_queue_io_min);
626
3c5820c7
MP
627/**
628 * blk_limits_io_opt - set optimal request size for a device
629 * @limits: the queue limits
630 * @opt: smallest I/O size in bytes
631 *
632 * Description:
633 * Storage devices may report an optimal I/O size, which is the
634 * device's preferred unit for sustained I/O. This is rarely reported
635 * for disk drives. For RAID arrays it is usually the stripe width or
636 * the internal track size. A properly aligned multiple of
637 * optimal_io_size is the preferred request size for workloads where
638 * sustained throughput is desired.
639 */
640void blk_limits_io_opt(struct queue_limits *limits, unsigned int opt)
641{
642 limits->io_opt = opt;
643}
644EXPORT_SYMBOL(blk_limits_io_opt);
645
c72758f3
MP
646/**
647 * blk_queue_io_opt - set optimal request size for the queue
648 * @q: the request queue for the device
8ebf9756 649 * @opt: optimal request size in bytes
c72758f3
MP
650 *
651 * Description:
7e5f5fb0
MP
652 * Storage devices may report an optimal I/O size, which is the
653 * device's preferred unit for sustained I/O. This is rarely reported
654 * for disk drives. For RAID arrays it is usually the stripe width or
655 * the internal track size. A properly aligned multiple of
656 * optimal_io_size is the preferred request size for workloads where
657 * sustained throughput is desired.
c72758f3
MP
658 */
659void blk_queue_io_opt(struct request_queue *q, unsigned int opt)
660{
3c5820c7 661 blk_limits_io_opt(&q->limits, opt);
d152c682 662 if (!q->disk)
edb0872f 663 return;
d152c682 664 q->disk->bdi->ra_pages =
c2e4cd57 665 max(queue_io_opt(q) * 2 / PAGE_SIZE, VM_READAHEAD_PAGES);
c72758f3
MP
666}
667EXPORT_SYMBOL(blk_queue_io_opt);
668
aa261f20 669static int queue_limit_alignment_offset(const struct queue_limits *lim,
89098b07
CH
670 sector_t sector)
671{
672 unsigned int granularity = max(lim->physical_block_size, lim->io_min);
673 unsigned int alignment = sector_div(sector, granularity >> SECTOR_SHIFT)
674 << SECTOR_SHIFT;
675
676 return (granularity + lim->alignment_offset - alignment) % granularity;
677}
678
aa261f20
BVA
679static unsigned int queue_limit_discard_alignment(
680 const struct queue_limits *lim, sector_t sector)
5c4b4a5c
CH
681{
682 unsigned int alignment, granularity, offset;
683
684 if (!lim->max_discard_sectors)
685 return 0;
686
687 /* Why are these in bytes, not sectors? */
688 alignment = lim->discard_alignment >> SECTOR_SHIFT;
689 granularity = lim->discard_granularity >> SECTOR_SHIFT;
690 if (!granularity)
691 return 0;
692
693 /* Offset of the partition start in 'granularity' sectors */
694 offset = sector_div(sector, granularity);
695
696 /* And why do we do this modulus *again* in blkdev_issue_discard()? */
697 offset = (granularity + alignment - offset) % granularity;
698
699 /* Turn it back into bytes, gaah */
700 return offset << SECTOR_SHIFT;
701}
702
97f433c3
MP
703static unsigned int blk_round_down_sectors(unsigned int sectors, unsigned int lbs)
704{
705 sectors = round_down(sectors, lbs >> SECTOR_SHIFT);
706 if (sectors < PAGE_SIZE >> SECTOR_SHIFT)
707 sectors = PAGE_SIZE >> SECTOR_SHIFT;
708 return sectors;
709}
710
c72758f3
MP
711/**
712 * blk_stack_limits - adjust queue_limits for stacked devices
81744ee4
MP
713 * @t: the stacking driver limits (top device)
714 * @b: the underlying queue limits (bottom, component device)
e03a72e1 715 * @start: first data sector within component device
c72758f3
MP
716 *
717 * Description:
81744ee4
MP
718 * This function is used by stacking drivers like MD and DM to ensure
719 * that all component devices have compatible block sizes and
720 * alignments. The stacking driver must provide a queue_limits
721 * struct (top) and then iteratively call the stacking function for
722 * all component (bottom) devices. The stacking function will
723 * attempt to combine the values and ensure proper alignment.
724 *
725 * Returns 0 if the top and bottom queue_limits are compatible. The
726 * top device's block sizes and alignment offsets may be adjusted to
727 * ensure alignment with the bottom device. If no compatible sizes
728 * and alignments exist, -1 is returned and the resulting top
729 * queue_limits will have the misaligned flag set to indicate that
730 * the alignment_offset is undefined.
c72758f3
MP
731 */
732int blk_stack_limits(struct queue_limits *t, struct queue_limits *b,
e03a72e1 733 sector_t start)
c72758f3 734{
e03a72e1 735 unsigned int top, bottom, alignment, ret = 0;
86b37281 736
c72758f3
MP
737 t->max_sectors = min_not_zero(t->max_sectors, b->max_sectors);
738 t->max_hw_sectors = min_not_zero(t->max_hw_sectors, b->max_hw_sectors);
ca369d51 739 t->max_dev_sectors = min_not_zero(t->max_dev_sectors, b->max_dev_sectors);
a6f0788e
CK
740 t->max_write_zeroes_sectors = min(t->max_write_zeroes_sectors,
741 b->max_write_zeroes_sectors);
0512a75b
KB
742 t->max_zone_append_sectors = min(t->max_zone_append_sectors,
743 b->max_zone_append_sectors);
9bb33f24 744 t->bounce = max(t->bounce, b->bounce);
c72758f3
MP
745
746 t->seg_boundary_mask = min_not_zero(t->seg_boundary_mask,
747 b->seg_boundary_mask);
03100aad
KB
748 t->virt_boundary_mask = min_not_zero(t->virt_boundary_mask,
749 b->virt_boundary_mask);
c72758f3 750
8a78362c 751 t->max_segments = min_not_zero(t->max_segments, b->max_segments);
1e739730
CH
752 t->max_discard_segments = min_not_zero(t->max_discard_segments,
753 b->max_discard_segments);
13f05c8d
MP
754 t->max_integrity_segments = min_not_zero(t->max_integrity_segments,
755 b->max_integrity_segments);
c72758f3
MP
756
757 t->max_segment_size = min_not_zero(t->max_segment_size,
758 b->max_segment_size);
759
fe0b393f
MP
760 t->misaligned |= b->misaligned;
761
e03a72e1 762 alignment = queue_limit_alignment_offset(b, start);
9504e086 763
81744ee4
MP
764 /* Bottom device has different alignment. Check that it is
765 * compatible with the current top alignment.
766 */
9504e086
MP
767 if (t->alignment_offset != alignment) {
768
769 top = max(t->physical_block_size, t->io_min)
770 + t->alignment_offset;
81744ee4 771 bottom = max(b->physical_block_size, b->io_min) + alignment;
9504e086 772
81744ee4 773 /* Verify that top and bottom intervals line up */
b8839b8c 774 if (max(top, bottom) % min(top, bottom)) {
9504e086 775 t->misaligned = 1;
fe0b393f
MP
776 ret = -1;
777 }
9504e086
MP
778 }
779
c72758f3
MP
780 t->logical_block_size = max(t->logical_block_size,
781 b->logical_block_size);
782
783 t->physical_block_size = max(t->physical_block_size,
784 b->physical_block_size);
785
786 t->io_min = max(t->io_min, b->io_min);
e9637415 787 t->io_opt = lcm_not_zero(t->io_opt, b->io_opt);
c964d62f 788 t->dma_alignment = max(t->dma_alignment, b->dma_alignment);
7e7986f9
MS
789
790 /* Set non-power-of-2 compatible chunk_sectors boundary */
791 if (b->chunk_sectors)
792 t->chunk_sectors = gcd(t->chunk_sectors, b->chunk_sectors);
9504e086 793
81744ee4 794 /* Physical block size a multiple of the logical block size? */
9504e086
MP
795 if (t->physical_block_size & (t->logical_block_size - 1)) {
796 t->physical_block_size = t->logical_block_size;
c72758f3 797 t->misaligned = 1;
fe0b393f 798 ret = -1;
86b37281
MP
799 }
800
81744ee4 801 /* Minimum I/O a multiple of the physical block size? */
9504e086
MP
802 if (t->io_min & (t->physical_block_size - 1)) {
803 t->io_min = t->physical_block_size;
804 t->misaligned = 1;
fe0b393f 805 ret = -1;
c72758f3
MP
806 }
807
81744ee4 808 /* Optimal I/O a multiple of the physical block size? */
9504e086
MP
809 if (t->io_opt & (t->physical_block_size - 1)) {
810 t->io_opt = 0;
811 t->misaligned = 1;
fe0b393f 812 ret = -1;
9504e086 813 }
c72758f3 814
22ada802
MS
815 /* chunk_sectors a multiple of the physical block size? */
816 if ((t->chunk_sectors << 9) & (t->physical_block_size - 1)) {
817 t->chunk_sectors = 0;
818 t->misaligned = 1;
819 ret = -1;
820 }
821
c78afc62
KO
822 t->raid_partial_stripes_expensive =
823 max(t->raid_partial_stripes_expensive,
824 b->raid_partial_stripes_expensive);
825
81744ee4 826 /* Find lowest common alignment_offset */
e9637415 827 t->alignment_offset = lcm_not_zero(t->alignment_offset, alignment)
b8839b8c 828 % max(t->physical_block_size, t->io_min);
86b37281 829
81744ee4 830 /* Verify that new alignment_offset is on a logical block boundary */
fe0b393f 831 if (t->alignment_offset & (t->logical_block_size - 1)) {
c72758f3 832 t->misaligned = 1;
fe0b393f
MP
833 ret = -1;
834 }
c72758f3 835
97f433c3
MP
836 t->max_sectors = blk_round_down_sectors(t->max_sectors, t->logical_block_size);
837 t->max_hw_sectors = blk_round_down_sectors(t->max_hw_sectors, t->logical_block_size);
838 t->max_dev_sectors = blk_round_down_sectors(t->max_dev_sectors, t->logical_block_size);
839
9504e086
MP
840 /* Discard alignment and granularity */
841 if (b->discard_granularity) {
e03a72e1 842 alignment = queue_limit_discard_alignment(b, start);
9504e086
MP
843
844 if (t->discard_granularity != 0 &&
845 t->discard_alignment != alignment) {
846 top = t->discard_granularity + t->discard_alignment;
847 bottom = b->discard_granularity + alignment;
70dd5bf3 848
9504e086 849 /* Verify that top and bottom intervals line up */
8dd2cb7e 850 if ((max(top, bottom) % min(top, bottom)) != 0)
9504e086
MP
851 t->discard_misaligned = 1;
852 }
853
81744ee4
MP
854 t->max_discard_sectors = min_not_zero(t->max_discard_sectors,
855 b->max_discard_sectors);
0034af03
JA
856 t->max_hw_discard_sectors = min_not_zero(t->max_hw_discard_sectors,
857 b->max_hw_discard_sectors);
9504e086
MP
858 t->discard_granularity = max(t->discard_granularity,
859 b->discard_granularity);
e9637415 860 t->discard_alignment = lcm_not_zero(t->discard_alignment, alignment) %
8dd2cb7e 861 t->discard_granularity;
9504e086 862 }
44abff2c
CH
863 t->max_secure_erase_sectors = min_not_zero(t->max_secure_erase_sectors,
864 b->max_secure_erase_sectors);
a805a4fa
DLM
865 t->zone_write_granularity = max(t->zone_write_granularity,
866 b->zone_write_granularity);
3093a479 867 t->zoned = max(t->zoned, b->zoned);
fe0b393f 868 return ret;
c72758f3 869}
5d85d324 870EXPORT_SYMBOL(blk_stack_limits);
c72758f3
MP
871
872/**
873 * disk_stack_limits - adjust queue limits for stacked drivers
77634f33 874 * @disk: MD/DM gendisk (top)
c72758f3
MP
875 * @bdev: the underlying block device (bottom)
876 * @offset: offset to beginning of data within component device
877 *
878 * Description:
e03a72e1
MP
879 * Merges the limits for a top level gendisk and a bottom level
880 * block_device.
c72758f3
MP
881 */
882void disk_stack_limits(struct gendisk *disk, struct block_device *bdev,
883 sector_t offset)
884{
885 struct request_queue *t = disk->queue;
c72758f3 886
9efa82ef 887 if (blk_stack_limits(&t->limits, &bdev_get_queue(bdev)->limits,
453b8ab6
CH
888 get_start_sect(bdev) + (offset >> 9)) < 0)
889 pr_notice("%s: Warning: Device %pg is misaligned\n",
890 disk->disk_name, bdev);
e74d93e9 891
471aa704 892 disk_update_readahead(disk);
c72758f3
MP
893}
894EXPORT_SYMBOL(disk_stack_limits);
895
27f8221a
FT
896/**
897 * blk_queue_update_dma_pad - update pad mask
898 * @q: the request queue for the device
899 * @mask: pad mask
900 *
901 * Update dma pad mask.
902 *
903 * Appending pad buffer to a request modifies the last entry of a
904 * scatter list such that it includes the pad buffer.
905 **/
906void blk_queue_update_dma_pad(struct request_queue *q, unsigned int mask)
907{
908 if (mask > q->dma_pad_mask)
909 q->dma_pad_mask = mask;
910}
911EXPORT_SYMBOL(blk_queue_update_dma_pad);
912
86db1e29
JA
913/**
914 * blk_queue_segment_boundary - set boundary rules for segment merging
915 * @q: the request queue for the device
916 * @mask: the memory boundary mask
917 **/
918void blk_queue_segment_boundary(struct request_queue *q, unsigned long mask)
919{
09cbfeaf
KS
920 if (mask < PAGE_SIZE - 1) {
921 mask = PAGE_SIZE - 1;
f19d1e3b 922 pr_info("%s: set to minimum %lx\n", __func__, mask);
86db1e29
JA
923 }
924
025146e1 925 q->limits.seg_boundary_mask = mask;
86db1e29 926}
86db1e29
JA
927EXPORT_SYMBOL(blk_queue_segment_boundary);
928
03100aad
KB
929/**
930 * blk_queue_virt_boundary - set boundary rules for bio merging
931 * @q: the request queue for the device
932 * @mask: the memory boundary mask
933 **/
934void blk_queue_virt_boundary(struct request_queue *q, unsigned long mask)
935{
936 q->limits.virt_boundary_mask = mask;
09324d32
CH
937
938 /*
939 * Devices that require a virtual boundary do not support scatter/gather
940 * I/O natively, but instead require a descriptor list entry for each
941 * page (which might not be idential to the Linux PAGE_SIZE). Because
942 * of that they are not limited by our notion of "segment size".
943 */
c6c84f78
CH
944 if (mask)
945 q->limits.max_segment_size = UINT_MAX;
03100aad
KB
946}
947EXPORT_SYMBOL(blk_queue_virt_boundary);
948
86db1e29
JA
949/**
950 * blk_queue_dma_alignment - set dma length and memory alignment
951 * @q: the request queue for the device
952 * @mask: alignment mask
953 *
954 * description:
710027a4 955 * set required memory and length alignment for direct dma transactions.
8feb4d20 956 * this is used when building direct io requests for the queue.
86db1e29
JA
957 *
958 **/
959void blk_queue_dma_alignment(struct request_queue *q, int mask)
960{
c964d62f 961 q->limits.dma_alignment = mask;
86db1e29 962}
86db1e29
JA
963EXPORT_SYMBOL(blk_queue_dma_alignment);
964
965/**
966 * blk_queue_update_dma_alignment - update dma length and memory alignment
967 * @q: the request queue for the device
968 * @mask: alignment mask
969 *
970 * description:
710027a4 971 * update required memory and length alignment for direct dma transactions.
86db1e29
JA
972 * If the requested alignment is larger than the current alignment, then
973 * the current queue alignment is updated to the new value, otherwise it
974 * is left alone. The design of this is to allow multiple objects
975 * (driver, device, transport etc) to set their respective
976 * alignments without having them interfere.
977 *
978 **/
979void blk_queue_update_dma_alignment(struct request_queue *q, int mask)
980{
981 BUG_ON(mask > PAGE_SIZE);
982
c964d62f
KB
983 if (mask > q->limits.dma_alignment)
984 q->limits.dma_alignment = mask;
86db1e29 985}
86db1e29
JA
986EXPORT_SYMBOL(blk_queue_update_dma_alignment);
987
d278d4a8
JA
988/**
989 * blk_set_queue_depth - tell the block layer about the device queue depth
990 * @q: the request queue for the device
991 * @depth: queue depth
992 *
993 */
994void blk_set_queue_depth(struct request_queue *q, unsigned int depth)
995{
996 q->queue_depth = depth;
9677a3e0 997 rq_qos_queue_depth_changed(q);
d278d4a8
JA
998}
999EXPORT_SYMBOL(blk_set_queue_depth);
1000
93e9d8e8
JA
1001/**
1002 * blk_queue_write_cache - configure queue's write cache
1003 * @q: the request queue for the device
1004 * @wc: write back cache on or off
1005 * @fua: device supports FUA writes, if true
1006 *
1007 * Tell the block layer about the write cache of @q.
1008 */
1009void blk_queue_write_cache(struct request_queue *q, bool wc, bool fua)
1010{
43c9835b
CH
1011 if (wc) {
1012 blk_queue_flag_set(QUEUE_FLAG_HW_WC, q);
57d74df9 1013 blk_queue_flag_set(QUEUE_FLAG_WC, q);
43c9835b
CH
1014 } else {
1015 blk_queue_flag_clear(QUEUE_FLAG_HW_WC, q);
57d74df9 1016 blk_queue_flag_clear(QUEUE_FLAG_WC, q);
43c9835b 1017 }
c888a8f9 1018 if (fua)
57d74df9 1019 blk_queue_flag_set(QUEUE_FLAG_FUA, q);
c888a8f9 1020 else
57d74df9 1021 blk_queue_flag_clear(QUEUE_FLAG_FUA, q);
93e9d8e8
JA
1022}
1023EXPORT_SYMBOL_GPL(blk_queue_write_cache);
1024
68c43f13
DLM
1025/**
1026 * blk_queue_required_elevator_features - Set a queue required elevator features
1027 * @q: the request queue for the target device
1028 * @features: Required elevator features OR'ed together
1029 *
1030 * Tell the block layer that for the device controlled through @q, only the
1031 * only elevators that can be used are those that implement at least the set of
1032 * features specified by @features.
1033 */
1034void blk_queue_required_elevator_features(struct request_queue *q,
1035 unsigned int features)
1036{
1037 q->required_elevator_features = features;
1038}
1039EXPORT_SYMBOL_GPL(blk_queue_required_elevator_features);
1040
45147fb5
YS
1041/**
1042 * blk_queue_can_use_dma_map_merging - configure queue for merging segments.
1043 * @q: the request queue for the device
1044 * @dev: the device pointer for dma
1045 *
1046 * Tell the block layer about merging the segments by dma map of @q.
1047 */
1048bool blk_queue_can_use_dma_map_merging(struct request_queue *q,
1049 struct device *dev)
1050{
1051 unsigned long boundary = dma_get_merge_boundary(dev);
1052
1053 if (!boundary)
1054 return false;
1055
1056 /* No need to update max_segment_size. see blk_queue_virt_boundary() */
1057 blk_queue_virt_boundary(q, boundary);
1058
1059 return true;
1060}
1061EXPORT_SYMBOL_GPL(blk_queue_can_use_dma_map_merging);
1062
27ba3e8f 1063/**
d73e93b4
CH
1064 * disk_set_zoned - inidicate a zoned device
1065 * @disk: gendisk to configure
27ba3e8f 1066 */
d73e93b4 1067void disk_set_zoned(struct gendisk *disk)
27ba3e8f 1068{
a805a4fa
DLM
1069 struct request_queue *q = disk->queue;
1070
d73e93b4
CH
1071 WARN_ON_ONCE(!IS_ENABLED(CONFIG_BLK_DEV_ZONED));
1072
1073 /*
1074 * Set the zone write granularity to the device logical block
1075 * size by default. The driver can change this value if needed.
1076 */
1077 q->limits.zoned = true;
1078 blk_queue_zone_write_granularity(q, queue_logical_block_size(q));
27ba3e8f 1079}
6b2bd274 1080EXPORT_SYMBOL_GPL(disk_set_zoned);
89098b07
CH
1081
1082int bdev_alignment_offset(struct block_device *bdev)
1083{
1084 struct request_queue *q = bdev_get_queue(bdev);
1085
1086 if (q->limits.misaligned)
1087 return -1;
1088 if (bdev_is_partition(bdev))
1089 return queue_limit_alignment_offset(&q->limits,
1090 bdev->bd_start_sect);
1091 return q->limits.alignment_offset;
1092}
1093EXPORT_SYMBOL_GPL(bdev_alignment_offset);
5c4b4a5c
CH
1094
1095unsigned int bdev_discard_alignment(struct block_device *bdev)
1096{
1097 struct request_queue *q = bdev_get_queue(bdev);
1098
1099 if (bdev_is_partition(bdev))
1100 return queue_limit_discard_alignment(&q->limits,
1101 bdev->bd_start_sect);
1102 return q->limits.discard_alignment;
1103}
1104EXPORT_SYMBOL_GPL(bdev_discard_alignment);