blob: 605df9b3de8f5f92410f68a9c5495df081cbf802 [file] [log] [blame]
Jens Axboe86db1e22008-01-29 14:53:40 +01001/*
2 * Functions related to setting various queue properties from drivers
3 */
4#include <linux/kernel.h>
5#include <linux/module.h>
6#include <linux/init.h>
7#include <linux/bio.h>
8#include <linux/blkdev.h>
9#include <linux/bootmem.h> /* for max_pfn/max_low_pfn */
Martin K. Petersen70dd5bf2009-07-31 11:49:12 -040010#include <linux/gcd.h>
Randy Dunlapad5ebd22009-11-11 13:47:45 +010011#include <linux/jiffies.h>
Jens Axboe86db1e22008-01-29 14:53:40 +010012
13#include "blk.h"
14
Jens Axboe6728cb02008-01-31 13:03:55 +010015unsigned long blk_max_low_pfn;
Jens Axboe86db1e22008-01-29 14:53:40 +010016EXPORT_SYMBOL(blk_max_low_pfn);
Jens Axboe6728cb02008-01-31 13:03:55 +010017
18unsigned long blk_max_pfn;
Jens Axboe86db1e22008-01-29 14:53:40 +010019
20/**
21 * blk_queue_prep_rq - set a prepare_request function for queue
22 * @q: queue
23 * @pfn: prepare_request function
24 *
25 * It's possible for a queue to register a prepare_request callback which
26 * is invoked before the request is handed to the request_fn. The goal of
27 * the function is to prepare a request for I/O, it can be used to build a
28 * cdb from the request data for instance.
29 *
30 */
31void blk_queue_prep_rq(struct request_queue *q, prep_rq_fn *pfn)
32{
33 q->prep_rq_fn = pfn;
34}
Jens Axboe86db1e22008-01-29 14:53:40 +010035EXPORT_SYMBOL(blk_queue_prep_rq);
36
37/**
38 * blk_queue_merge_bvec - set a merge_bvec function for queue
39 * @q: queue
40 * @mbfn: merge_bvec_fn
41 *
42 * Usually queues have static limitations on the max sectors or segments that
43 * we can put in a request. Stacking drivers may have some settings that
44 * are dynamic, and thus we have to query the queue whether it is ok to
45 * add a new bio_vec to a bio at a given offset or not. If the block device
46 * has such limitations, it needs to register a merge_bvec_fn to control
47 * the size of bio's sent to it. Note that a block device *must* allow a
48 * single page to be added to an empty bio. The block device driver may want
49 * to use the bio_split() function to deal with these bio's. By default
50 * no merge_bvec_fn is defined for a queue, and only the fixed limits are
51 * honored.
52 */
53void blk_queue_merge_bvec(struct request_queue *q, merge_bvec_fn *mbfn)
54{
55 q->merge_bvec_fn = mbfn;
56}
Jens Axboe86db1e22008-01-29 14:53:40 +010057EXPORT_SYMBOL(blk_queue_merge_bvec);
58
59void blk_queue_softirq_done(struct request_queue *q, softirq_done_fn *fn)
60{
61 q->softirq_done_fn = fn;
62}
Jens Axboe86db1e22008-01-29 14:53:40 +010063EXPORT_SYMBOL(blk_queue_softirq_done);
64
Jens Axboe242f9dc2008-09-14 05:55:09 -070065void blk_queue_rq_timeout(struct request_queue *q, unsigned int timeout)
66{
67 q->rq_timeout = timeout;
68}
69EXPORT_SYMBOL_GPL(blk_queue_rq_timeout);
70
71void blk_queue_rq_timed_out(struct request_queue *q, rq_timed_out_fn *fn)
72{
73 q->rq_timed_out_fn = fn;
74}
75EXPORT_SYMBOL_GPL(blk_queue_rq_timed_out);
76
Kiyoshi Uedaef9e3fa2008-10-01 16:12:15 +020077void blk_queue_lld_busy(struct request_queue *q, lld_busy_fn *fn)
78{
79 q->lld_busy_fn = fn;
80}
81EXPORT_SYMBOL_GPL(blk_queue_lld_busy);
82
Jens Axboe86db1e22008-01-29 14:53:40 +010083/**
Martin K. Petersene475bba2009-06-16 08:23:52 +020084 * blk_set_default_limits - reset limits to default values
Randy Dunlapf740f5ca2009-06-19 09:18:32 +020085 * @lim: the queue_limits structure to reset
Martin K. Petersene475bba2009-06-16 08:23:52 +020086 *
87 * Description:
88 * Returns a queue_limit struct to its default state. Can be used by
89 * stacking drivers like DM that stage table swaps and reuse an
90 * existing device queue.
91 */
92void blk_set_default_limits(struct queue_limits *lim)
93{
94 lim->max_phys_segments = MAX_PHYS_SEGMENTS;
95 lim->max_hw_segments = MAX_HW_SEGMENTS;
96 lim->seg_boundary_mask = BLK_SEG_BOUNDARY_MASK;
97 lim->max_segment_size = MAX_SEGMENT_SIZE;
Martin K. Petersen5dee2472009-09-21 21:46:05 +020098 lim->max_sectors = BLK_DEF_MAX_SECTORS;
99 lim->max_hw_sectors = INT_MAX;
Martin K. Petersen86b37282009-11-10 11:50:21 +0100100 lim->max_discard_sectors = 0;
101 lim->discard_granularity = 0;
102 lim->discard_alignment = 0;
103 lim->discard_misaligned = 0;
Martin K. Petersen98262f22009-12-03 09:24:48 +0100104 lim->discard_zeroes_data = -1;
Martin K. Petersene475bba2009-06-16 08:23:52 +0200105 lim->logical_block_size = lim->physical_block_size = lim->io_min = 512;
Martin K. Petersen3a02c8e2009-06-18 09:56:03 +0200106 lim->bounce_pfn = (unsigned long)(BLK_BOUNCE_ANY >> PAGE_SHIFT);
Martin K. Petersene475bba2009-06-16 08:23:52 +0200107 lim->alignment_offset = 0;
108 lim->io_opt = 0;
109 lim->misaligned = 0;
110 lim->no_cluster = 0;
111}
112EXPORT_SYMBOL(blk_set_default_limits);
113
114/**
Jens Axboe86db1e22008-01-29 14:53:40 +0100115 * blk_queue_make_request - define an alternate make_request function for a device
116 * @q: the request queue for the device to be affected
117 * @mfn: the alternate make_request function
118 *
119 * Description:
120 * The normal way for &struct bios to be passed to a device
121 * driver is for them to be collected into requests on a request
122 * queue, and then to allow the device driver to select requests
123 * off that queue when it is ready. This works well for many block
124 * devices. However some block devices (typically virtual devices
125 * such as md or lvm) do not benefit from the processing on the
126 * request queue, and are served best by having the requests passed
127 * directly to them. This can be achieved by providing a function
128 * to blk_queue_make_request().
129 *
130 * Caveat:
131 * The driver that does this *must* be able to deal appropriately
132 * with buffers in "highmemory". This can be accomplished by either calling
133 * __bio_kmap_atomic() to get a temporary kernel mapping, or by calling
134 * blk_queue_bounce() to create a buffer in normal memory.
135 **/
Jens Axboe6728cb02008-01-31 13:03:55 +0100136void blk_queue_make_request(struct request_queue *q, make_request_fn *mfn)
Jens Axboe86db1e22008-01-29 14:53:40 +0100137{
138 /*
139 * set defaults
140 */
141 q->nr_requests = BLKDEV_MAX_RQ;
Milan Broz0e435ac2008-12-03 12:55:08 +0100142
Jens Axboe86db1e22008-01-29 14:53:40 +0100143 q->make_request_fn = mfn;
Jens Axboe86db1e22008-01-29 14:53:40 +0100144 blk_queue_dma_alignment(q, 511);
145 blk_queue_congestion_threshold(q);
146 q->nr_batching = BLK_BATCH_REQ;
147
148 q->unplug_thresh = 4; /* hmm */
Randy Dunlapad5ebd22009-11-11 13:47:45 +0100149 q->unplug_delay = msecs_to_jiffies(3); /* 3 milliseconds */
Jens Axboe86db1e22008-01-29 14:53:40 +0100150 if (q->unplug_delay == 0)
151 q->unplug_delay = 1;
152
Jens Axboe86db1e22008-01-29 14:53:40 +0100153 q->unplug_timer.function = blk_unplug_timeout;
154 q->unplug_timer.data = (unsigned long)q;
155
Martin K. Petersene475bba2009-06-16 08:23:52 +0200156 blk_set_default_limits(&q->limits);
Martin K. Petersen80ddf242009-09-18 22:54:37 +0200157 blk_queue_max_sectors(q, SAFE_MAX_SECTORS);
Martin K. Petersene475bba2009-06-16 08:23:52 +0200158
Jens Axboe86db1e22008-01-29 14:53:40 +0100159 /*
Jens Axboea4e7d462009-07-28 09:07:29 +0200160 * If the caller didn't supply a lock, fall back to our embedded
161 * per-queue locks
162 */
163 if (!q->queue_lock)
164 q->queue_lock = &q->__queue_lock;
165
166 /*
Jens Axboe86db1e22008-01-29 14:53:40 +0100167 * by default assume old behaviour and bounce for any highmem page
168 */
169 blk_queue_bounce_limit(q, BLK_BOUNCE_HIGH);
170}
Jens Axboe86db1e22008-01-29 14:53:40 +0100171EXPORT_SYMBOL(blk_queue_make_request);
172
173/**
174 * blk_queue_bounce_limit - set bounce buffer limit for queue
Tejun Heocd0aca2d2009-04-15 22:10:25 +0900175 * @q: the request queue for the device
176 * @dma_mask: the maximum address the device can handle
Jens Axboe86db1e22008-01-29 14:53:40 +0100177 *
178 * Description:
179 * Different hardware can have different requirements as to what pages
180 * it can do I/O directly to. A low level driver can call
181 * blk_queue_bounce_limit to have lower memory pages allocated as bounce
Tejun Heocd0aca2d2009-04-15 22:10:25 +0900182 * buffers for doing I/O to pages residing above @dma_mask.
Jens Axboe86db1e22008-01-29 14:53:40 +0100183 **/
Tejun Heocd0aca2d2009-04-15 22:10:25 +0900184void blk_queue_bounce_limit(struct request_queue *q, u64 dma_mask)
Jens Axboe86db1e22008-01-29 14:53:40 +0100185{
Tejun Heocd0aca2d2009-04-15 22:10:25 +0900186 unsigned long b_pfn = dma_mask >> PAGE_SHIFT;
Jens Axboe86db1e22008-01-29 14:53:40 +0100187 int dma = 0;
188
189 q->bounce_gfp = GFP_NOIO;
190#if BITS_PER_LONG == 64
Tejun Heocd0aca2d2009-04-15 22:10:25 +0900191 /*
192 * Assume anything <= 4GB can be handled by IOMMU. Actually
193 * some IOMMUs can handle everything, but I don't know of a
194 * way to test this here.
195 */
196 if (b_pfn < (min_t(u64, 0xffffffffUL, BLK_BOUNCE_HIGH) >> PAGE_SHIFT))
Jens Axboe86db1e22008-01-29 14:53:40 +0100197 dma = 1;
Martin K. Petersen025146e2009-05-22 17:17:51 -0400198 q->limits.bounce_pfn = max_low_pfn;
Jens Axboe86db1e22008-01-29 14:53:40 +0100199#else
Jens Axboe6728cb02008-01-31 13:03:55 +0100200 if (b_pfn < blk_max_low_pfn)
Jens Axboe86db1e22008-01-29 14:53:40 +0100201 dma = 1;
Martin K. Petersen025146e2009-05-22 17:17:51 -0400202 q->limits.bounce_pfn = b_pfn;
Jens Axboe86db1e22008-01-29 14:53:40 +0100203#endif
204 if (dma) {
205 init_emergency_isa_pool();
206 q->bounce_gfp = GFP_NOIO | GFP_DMA;
Martin K. Petersen025146e2009-05-22 17:17:51 -0400207 q->limits.bounce_pfn = b_pfn;
Jens Axboe86db1e22008-01-29 14:53:40 +0100208 }
209}
Jens Axboe86db1e22008-01-29 14:53:40 +0100210EXPORT_SYMBOL(blk_queue_bounce_limit);
211
212/**
213 * blk_queue_max_sectors - set max sectors for a request for this queue
214 * @q: the request queue for the device
Martin K. Petersen2800aac2010-02-26 00:20:35 -0500215 * @max_hw_sectors: max hardware sectors in the usual 512b unit
Jens Axboe86db1e22008-01-29 14:53:40 +0100216 *
217 * Description:
Martin K. Petersen2800aac2010-02-26 00:20:35 -0500218 * Enables a low level driver to set a hard upper limit,
219 * max_hw_sectors, on the size of requests. max_hw_sectors is set by
220 * the device driver based upon the combined capabilities of I/O
221 * controller and storage device.
222 *
223 * max_sectors is a soft limit imposed by the block layer for
224 * filesystem type requests. This value can be overridden on a
225 * per-device basis in /sys/block/<device>/queue/max_sectors_kb.
226 * The soft limit can not exceed max_hw_sectors.
Jens Axboe86db1e22008-01-29 14:53:40 +0100227 **/
Martin K. Petersen2800aac2010-02-26 00:20:35 -0500228void blk_queue_max_sectors(struct request_queue *q, unsigned int max_hw_sectors)
Jens Axboe86db1e22008-01-29 14:53:40 +0100229{
Martin K. Petersen2800aac2010-02-26 00:20:35 -0500230 if ((max_hw_sectors << 9) < PAGE_CACHE_SIZE) {
231 max_hw_sectors = 1 << (PAGE_CACHE_SHIFT - 9);
Harvey Harrison24c03d42008-05-01 04:35:17 -0700232 printk(KERN_INFO "%s: set to minimum %d\n",
Martin K. Petersen2800aac2010-02-26 00:20:35 -0500233 __func__, max_hw_sectors);
Jens Axboe86db1e22008-01-29 14:53:40 +0100234 }
235
Martin K. Petersen2800aac2010-02-26 00:20:35 -0500236 q->limits.max_hw_sectors = max_hw_sectors;
237 q->limits.max_sectors = min_t(unsigned int, max_hw_sectors,
238 BLK_DEF_MAX_SECTORS);
Jens Axboe86db1e22008-01-29 14:53:40 +0100239}
Jens Axboe86db1e22008-01-29 14:53:40 +0100240EXPORT_SYMBOL(blk_queue_max_sectors);
241
Martin K. Petersenae03bf62009-05-22 17:17:50 -0400242void blk_queue_max_hw_sectors(struct request_queue *q, unsigned int max_sectors)
243{
244 if (BLK_DEF_MAX_SECTORS > max_sectors)
Martin K. Petersen025146e2009-05-22 17:17:51 -0400245 q->limits.max_hw_sectors = BLK_DEF_MAX_SECTORS;
Martin K. Petersenae03bf62009-05-22 17:17:50 -0400246 else
Martin K. Petersen025146e2009-05-22 17:17:51 -0400247 q->limits.max_hw_sectors = max_sectors;
Martin K. Petersenae03bf62009-05-22 17:17:50 -0400248}
249EXPORT_SYMBOL(blk_queue_max_hw_sectors);
250
Jens Axboe86db1e22008-01-29 14:53:40 +0100251/**
Christoph Hellwig67efc922009-09-30 13:54:20 +0200252 * blk_queue_max_discard_sectors - set max sectors for a single discard
253 * @q: the request queue for the device
Randy Dunlapc7ebf062009-10-12 08:20:47 +0200254 * @max_discard_sectors: maximum number of sectors to discard
Christoph Hellwig67efc922009-09-30 13:54:20 +0200255 **/
256void blk_queue_max_discard_sectors(struct request_queue *q,
257 unsigned int max_discard_sectors)
258{
259 q->limits.max_discard_sectors = max_discard_sectors;
260}
261EXPORT_SYMBOL(blk_queue_max_discard_sectors);
262
263/**
Jens Axboe86db1e22008-01-29 14:53:40 +0100264 * blk_queue_max_phys_segments - set max phys segments for a request for this queue
265 * @q: the request queue for the device
266 * @max_segments: max number of segments
267 *
268 * Description:
269 * Enables a low level driver to set an upper limit on the number of
270 * physical data segments in a request. This would be the largest sized
271 * scatter list the driver could handle.
272 **/
273void blk_queue_max_phys_segments(struct request_queue *q,
274 unsigned short max_segments)
275{
276 if (!max_segments) {
277 max_segments = 1;
Harvey Harrison24c03d42008-05-01 04:35:17 -0700278 printk(KERN_INFO "%s: set to minimum %d\n",
279 __func__, max_segments);
Jens Axboe86db1e22008-01-29 14:53:40 +0100280 }
281
Martin K. Petersen025146e2009-05-22 17:17:51 -0400282 q->limits.max_phys_segments = max_segments;
Jens Axboe86db1e22008-01-29 14:53:40 +0100283}
Jens Axboe86db1e22008-01-29 14:53:40 +0100284EXPORT_SYMBOL(blk_queue_max_phys_segments);
285
286/**
287 * blk_queue_max_hw_segments - set max hw segments for a request for this queue
288 * @q: the request queue for the device
289 * @max_segments: max number of segments
290 *
291 * Description:
292 * Enables a low level driver to set an upper limit on the number of
293 * hw data segments in a request. This would be the largest number of
Randy Dunlap710027a2008-08-19 20:13:11 +0200294 * address/length pairs the host adapter can actually give at once
Jens Axboe86db1e22008-01-29 14:53:40 +0100295 * to the device.
296 **/
297void blk_queue_max_hw_segments(struct request_queue *q,
298 unsigned short max_segments)
299{
300 if (!max_segments) {
301 max_segments = 1;
Harvey Harrison24c03d42008-05-01 04:35:17 -0700302 printk(KERN_INFO "%s: set to minimum %d\n",
303 __func__, max_segments);
Jens Axboe86db1e22008-01-29 14:53:40 +0100304 }
305
Martin K. Petersen025146e2009-05-22 17:17:51 -0400306 q->limits.max_hw_segments = max_segments;
Jens Axboe86db1e22008-01-29 14:53:40 +0100307}
Jens Axboe86db1e22008-01-29 14:53:40 +0100308EXPORT_SYMBOL(blk_queue_max_hw_segments);
309
310/**
311 * blk_queue_max_segment_size - set max segment size for blk_rq_map_sg
312 * @q: the request queue for the device
313 * @max_size: max size of segment in bytes
314 *
315 * Description:
316 * Enables a low level driver to set an upper limit on the size of a
317 * coalesced segment
318 **/
319void blk_queue_max_segment_size(struct request_queue *q, unsigned int max_size)
320{
321 if (max_size < PAGE_CACHE_SIZE) {
322 max_size = PAGE_CACHE_SIZE;
Harvey Harrison24c03d42008-05-01 04:35:17 -0700323 printk(KERN_INFO "%s: set to minimum %d\n",
324 __func__, max_size);
Jens Axboe86db1e22008-01-29 14:53:40 +0100325 }
326
Martin K. Petersen025146e2009-05-22 17:17:51 -0400327 q->limits.max_segment_size = max_size;
Jens Axboe86db1e22008-01-29 14:53:40 +0100328}
Jens Axboe86db1e22008-01-29 14:53:40 +0100329EXPORT_SYMBOL(blk_queue_max_segment_size);
330
331/**
Martin K. Petersene1defc42009-05-22 17:17:49 -0400332 * blk_queue_logical_block_size - set logical block size for the queue
Jens Axboe86db1e22008-01-29 14:53:40 +0100333 * @q: the request queue for the device
Martin K. Petersene1defc42009-05-22 17:17:49 -0400334 * @size: the logical block size, in bytes
Jens Axboe86db1e22008-01-29 14:53:40 +0100335 *
336 * Description:
Martin K. Petersene1defc42009-05-22 17:17:49 -0400337 * This should be set to the lowest possible block size that the
338 * storage device can address. The default of 512 covers most
339 * hardware.
Jens Axboe86db1e22008-01-29 14:53:40 +0100340 **/
Martin K. Petersene1defc42009-05-22 17:17:49 -0400341void blk_queue_logical_block_size(struct request_queue *q, unsigned short size)
Jens Axboe86db1e22008-01-29 14:53:40 +0100342{
Martin K. Petersen025146e2009-05-22 17:17:51 -0400343 q->limits.logical_block_size = size;
Martin K. Petersenc72758f2009-05-22 17:17:53 -0400344
345 if (q->limits.physical_block_size < size)
346 q->limits.physical_block_size = size;
347
348 if (q->limits.io_min < q->limits.physical_block_size)
349 q->limits.io_min = q->limits.physical_block_size;
Jens Axboe86db1e22008-01-29 14:53:40 +0100350}
Martin K. Petersene1defc42009-05-22 17:17:49 -0400351EXPORT_SYMBOL(blk_queue_logical_block_size);
Jens Axboe86db1e22008-01-29 14:53:40 +0100352
Martin K. Petersenc72758f2009-05-22 17:17:53 -0400353/**
354 * blk_queue_physical_block_size - set physical block size for the queue
355 * @q: the request queue for the device
356 * @size: the physical block size, in bytes
357 *
358 * Description:
359 * This should be set to the lowest possible sector size that the
360 * hardware can operate on without reverting to read-modify-write
361 * operations.
362 */
363void blk_queue_physical_block_size(struct request_queue *q, unsigned short size)
364{
365 q->limits.physical_block_size = size;
366
367 if (q->limits.physical_block_size < q->limits.logical_block_size)
368 q->limits.physical_block_size = q->limits.logical_block_size;
369
370 if (q->limits.io_min < q->limits.physical_block_size)
371 q->limits.io_min = q->limits.physical_block_size;
372}
373EXPORT_SYMBOL(blk_queue_physical_block_size);
374
375/**
376 * blk_queue_alignment_offset - set physical block alignment offset
377 * @q: the request queue for the device
Randy Dunlap8ebf9752009-06-11 20:00:41 -0700378 * @offset: alignment offset in bytes
Martin K. Petersenc72758f2009-05-22 17:17:53 -0400379 *
380 * Description:
381 * Some devices are naturally misaligned to compensate for things like
382 * the legacy DOS partition table 63-sector offset. Low-level drivers
383 * should call this function for devices whose first sector is not
384 * naturally aligned.
385 */
386void blk_queue_alignment_offset(struct request_queue *q, unsigned int offset)
387{
388 q->limits.alignment_offset =
389 offset & (q->limits.physical_block_size - 1);
390 q->limits.misaligned = 0;
391}
392EXPORT_SYMBOL(blk_queue_alignment_offset);
393
394/**
Martin K. Petersen7c958e32009-07-31 11:49:11 -0400395 * blk_limits_io_min - set minimum request size for a device
396 * @limits: the queue limits
397 * @min: smallest I/O size in bytes
398 *
399 * Description:
400 * Some devices have an internal block size bigger than the reported
401 * hardware sector size. This function can be used to signal the
402 * smallest I/O the device can perform without incurring a performance
403 * penalty.
404 */
405void blk_limits_io_min(struct queue_limits *limits, unsigned int min)
406{
407 limits->io_min = min;
408
409 if (limits->io_min < limits->logical_block_size)
410 limits->io_min = limits->logical_block_size;
411
412 if (limits->io_min < limits->physical_block_size)
413 limits->io_min = limits->physical_block_size;
414}
415EXPORT_SYMBOL(blk_limits_io_min);
416
417/**
Martin K. Petersenc72758f2009-05-22 17:17:53 -0400418 * blk_queue_io_min - set minimum request size for the queue
419 * @q: the request queue for the device
Randy Dunlap8ebf9752009-06-11 20:00:41 -0700420 * @min: smallest I/O size in bytes
Martin K. Petersenc72758f2009-05-22 17:17:53 -0400421 *
422 * Description:
Martin K. Petersen7e5f5fb2009-07-31 11:49:13 -0400423 * Storage devices may report a granularity or preferred minimum I/O
424 * size which is the smallest request the device can perform without
425 * incurring a performance penalty. For disk drives this is often the
426 * physical block size. For RAID arrays it is often the stripe chunk
427 * size. A properly aligned multiple of minimum_io_size is the
428 * preferred request size for workloads where a high number of I/O
429 * operations is desired.
Martin K. Petersenc72758f2009-05-22 17:17:53 -0400430 */
431void blk_queue_io_min(struct request_queue *q, unsigned int min)
432{
Martin K. Petersen7c958e32009-07-31 11:49:11 -0400433 blk_limits_io_min(&q->limits, min);
Martin K. Petersenc72758f2009-05-22 17:17:53 -0400434}
435EXPORT_SYMBOL(blk_queue_io_min);
436
437/**
Martin K. Petersen3c5820c2009-09-11 21:54:52 +0200438 * blk_limits_io_opt - set optimal request size for a device
439 * @limits: the queue limits
440 * @opt: smallest I/O size in bytes
441 *
442 * Description:
443 * Storage devices may report an optimal I/O size, which is the
444 * device's preferred unit for sustained I/O. This is rarely reported
445 * for disk drives. For RAID arrays it is usually the stripe width or
446 * the internal track size. A properly aligned multiple of
447 * optimal_io_size is the preferred request size for workloads where
448 * sustained throughput is desired.
449 */
450void blk_limits_io_opt(struct queue_limits *limits, unsigned int opt)
451{
452 limits->io_opt = opt;
453}
454EXPORT_SYMBOL(blk_limits_io_opt);
455
456/**
Martin K. Petersenc72758f2009-05-22 17:17:53 -0400457 * blk_queue_io_opt - set optimal request size for the queue
458 * @q: the request queue for the device
Randy Dunlap8ebf9752009-06-11 20:00:41 -0700459 * @opt: optimal request size in bytes
Martin K. Petersenc72758f2009-05-22 17:17:53 -0400460 *
461 * Description:
Martin K. Petersen7e5f5fb2009-07-31 11:49:13 -0400462 * Storage devices may report an optimal I/O size, which is the
463 * device's preferred unit for sustained I/O. This is rarely reported
464 * for disk drives. For RAID arrays it is usually the stripe width or
465 * the internal track size. A properly aligned multiple of
466 * optimal_io_size is the preferred request size for workloads where
467 * sustained throughput is desired.
Martin K. Petersenc72758f2009-05-22 17:17:53 -0400468 */
469void blk_queue_io_opt(struct request_queue *q, unsigned int opt)
470{
Martin K. Petersen3c5820c2009-09-11 21:54:52 +0200471 blk_limits_io_opt(&q->limits, opt);
Martin K. Petersenc72758f2009-05-22 17:17:53 -0400472}
473EXPORT_SYMBOL(blk_queue_io_opt);
474
Jens Axboe86db1e22008-01-29 14:53:40 +0100475/*
476 * Returns the minimum that is _not_ zero, unless both are zero.
477 */
478#define min_not_zero(l, r) (l == 0) ? r : ((r == 0) ? l : min(l, r))
479
480/**
481 * blk_queue_stack_limits - inherit underlying queue limits for stacked drivers
482 * @t: the stacking driver (top)
483 * @b: the underlying device (bottom)
484 **/
485void blk_queue_stack_limits(struct request_queue *t, struct request_queue *b)
486{
Martin K. Petersenfef246672009-07-31 11:49:10 -0400487 blk_stack_limits(&t->limits, &b->limits, 0);
Martin K. Petersen025146e2009-05-22 17:17:51 -0400488
Neil Browne7e72bf2008-05-14 16:05:54 -0700489 if (!t->queue_lock)
490 WARN_ON_ONCE(1);
491 else if (!test_bit(QUEUE_FLAG_CLUSTER, &b->queue_flags)) {
492 unsigned long flags;
493 spin_lock_irqsave(t->queue_lock, flags);
Nick Piggin75ad23b2008-04-29 14:48:33 +0200494 queue_flag_clear(QUEUE_FLAG_CLUSTER, t);
Neil Browne7e72bf2008-05-14 16:05:54 -0700495 spin_unlock_irqrestore(t->queue_lock, flags);
496 }
Jens Axboe86db1e22008-01-29 14:53:40 +0100497}
Jens Axboe86db1e22008-01-29 14:53:40 +0100498EXPORT_SYMBOL(blk_queue_stack_limits);
499
Martin K. Petersen86b37282009-11-10 11:50:21 +0100500static unsigned int lcm(unsigned int a, unsigned int b)
501{
502 if (a && b)
503 return (a * b) / gcd(a, b);
504 else if (b)
505 return b;
506
507 return a;
508}
509
Jens Axboe86db1e22008-01-29 14:53:40 +0100510/**
Martin K. Petersenc72758f2009-05-22 17:17:53 -0400511 * blk_stack_limits - adjust queue_limits for stacked devices
Martin K. Petersen81744ee2009-12-29 08:35:35 +0100512 * @t: the stacking driver limits (top device)
513 * @b: the underlying queue limits (bottom, component device)
Martin K. Petersene03a72e2010-01-11 03:21:51 -0500514 * @start: first data sector within component device
Martin K. Petersenc72758f2009-05-22 17:17:53 -0400515 *
516 * Description:
Martin K. Petersen81744ee2009-12-29 08:35:35 +0100517 * This function is used by stacking drivers like MD and DM to ensure
518 * that all component devices have compatible block sizes and
519 * alignments. The stacking driver must provide a queue_limits
520 * struct (top) and then iteratively call the stacking function for
521 * all component (bottom) devices. The stacking function will
522 * attempt to combine the values and ensure proper alignment.
523 *
524 * Returns 0 if the top and bottom queue_limits are compatible. The
525 * top device's block sizes and alignment offsets may be adjusted to
526 * ensure alignment with the bottom device. If no compatible sizes
527 * and alignments exist, -1 is returned and the resulting top
528 * queue_limits will have the misaligned flag set to indicate that
529 * the alignment_offset is undefined.
Martin K. Petersenc72758f2009-05-22 17:17:53 -0400530 */
531int blk_stack_limits(struct queue_limits *t, struct queue_limits *b,
Martin K. Petersene03a72e2010-01-11 03:21:51 -0500532 sector_t start)
Martin K. Petersenc72758f2009-05-22 17:17:53 -0400533{
Martin K. Petersene03a72e2010-01-11 03:21:51 -0500534 unsigned int top, bottom, alignment, ret = 0;
Martin K. Petersen86b37282009-11-10 11:50:21 +0100535
Martin K. Petersenc72758f2009-05-22 17:17:53 -0400536 t->max_sectors = min_not_zero(t->max_sectors, b->max_sectors);
537 t->max_hw_sectors = min_not_zero(t->max_hw_sectors, b->max_hw_sectors);
Martin K. Petersen77634f32009-06-09 06:23:22 +0200538 t->bounce_pfn = min_not_zero(t->bounce_pfn, b->bounce_pfn);
Martin K. Petersenc72758f2009-05-22 17:17:53 -0400539
540 t->seg_boundary_mask = min_not_zero(t->seg_boundary_mask,
541 b->seg_boundary_mask);
542
543 t->max_phys_segments = min_not_zero(t->max_phys_segments,
544 b->max_phys_segments);
545
546 t->max_hw_segments = min_not_zero(t->max_hw_segments,
547 b->max_hw_segments);
548
549 t->max_segment_size = min_not_zero(t->max_segment_size,
550 b->max_segment_size);
551
Martin K. Petersenfe0b3932010-01-11 03:21:47 -0500552 t->misaligned |= b->misaligned;
553
Martin K. Petersene03a72e2010-01-11 03:21:51 -0500554 alignment = queue_limit_alignment_offset(b, start);
Martin K. Petersen9504e082009-12-21 15:55:51 +0100555
Martin K. Petersen81744ee2009-12-29 08:35:35 +0100556 /* Bottom device has different alignment. Check that it is
557 * compatible with the current top alignment.
558 */
Martin K. Petersen9504e082009-12-21 15:55:51 +0100559 if (t->alignment_offset != alignment) {
560
561 top = max(t->physical_block_size, t->io_min)
562 + t->alignment_offset;
Martin K. Petersen81744ee2009-12-29 08:35:35 +0100563 bottom = max(b->physical_block_size, b->io_min) + alignment;
Martin K. Petersen9504e082009-12-21 15:55:51 +0100564
Martin K. Petersen81744ee2009-12-29 08:35:35 +0100565 /* Verify that top and bottom intervals line up */
Martin K. Petersenfe0b3932010-01-11 03:21:47 -0500566 if (max(top, bottom) & (min(top, bottom) - 1)) {
Martin K. Petersen9504e082009-12-21 15:55:51 +0100567 t->misaligned = 1;
Martin K. Petersenfe0b3932010-01-11 03:21:47 -0500568 ret = -1;
569 }
Martin K. Petersen9504e082009-12-21 15:55:51 +0100570 }
571
Martin K. Petersenc72758f2009-05-22 17:17:53 -0400572 t->logical_block_size = max(t->logical_block_size,
573 b->logical_block_size);
574
575 t->physical_block_size = max(t->physical_block_size,
576 b->physical_block_size);
577
578 t->io_min = max(t->io_min, b->io_min);
Martin K. Petersen9504e082009-12-21 15:55:51 +0100579 t->io_opt = lcm(t->io_opt, b->io_opt);
580
Martin K. Petersenc72758f2009-05-22 17:17:53 -0400581 t->no_cluster |= b->no_cluster;
Martin K. Petersen98262f22009-12-03 09:24:48 +0100582 t->discard_zeroes_data &= b->discard_zeroes_data;
Martin K. Petersenc72758f2009-05-22 17:17:53 -0400583
Martin K. Petersen81744ee2009-12-29 08:35:35 +0100584 /* Physical block size a multiple of the logical block size? */
Martin K. Petersen9504e082009-12-21 15:55:51 +0100585 if (t->physical_block_size & (t->logical_block_size - 1)) {
586 t->physical_block_size = t->logical_block_size;
Martin K. Petersenc72758f2009-05-22 17:17:53 -0400587 t->misaligned = 1;
Martin K. Petersenfe0b3932010-01-11 03:21:47 -0500588 ret = -1;
Martin K. Petersen86b37282009-11-10 11:50:21 +0100589 }
590
Martin K. Petersen81744ee2009-12-29 08:35:35 +0100591 /* Minimum I/O a multiple of the physical block size? */
Martin K. Petersen9504e082009-12-21 15:55:51 +0100592 if (t->io_min & (t->physical_block_size - 1)) {
593 t->io_min = t->physical_block_size;
Martin K. Petersenc72758f2009-05-22 17:17:53 -0400594 t->misaligned = 1;
Martin K. Petersenfe0b3932010-01-11 03:21:47 -0500595 ret = -1;
Martin K. Petersenc72758f2009-05-22 17:17:53 -0400596 }
597
Martin K. Petersen81744ee2009-12-29 08:35:35 +0100598 /* Optimal I/O a multiple of the physical block size? */
Martin K. Petersen9504e082009-12-21 15:55:51 +0100599 if (t->io_opt & (t->physical_block_size - 1)) {
600 t->io_opt = 0;
601 t->misaligned = 1;
Martin K. Petersenfe0b3932010-01-11 03:21:47 -0500602 ret = -1;
Martin K. Petersen9504e082009-12-21 15:55:51 +0100603 }
Martin K. Petersen70dd5bf2009-07-31 11:49:12 -0400604
Martin K. Petersen81744ee2009-12-29 08:35:35 +0100605 /* Find lowest common alignment_offset */
Martin K. Petersen9504e082009-12-21 15:55:51 +0100606 t->alignment_offset = lcm(t->alignment_offset, alignment)
607 & (max(t->physical_block_size, t->io_min) - 1);
Martin K. Petersen70dd5bf2009-07-31 11:49:12 -0400608
Martin K. Petersen81744ee2009-12-29 08:35:35 +0100609 /* Verify that new alignment_offset is on a logical block boundary */
Martin K. Petersenfe0b3932010-01-11 03:21:47 -0500610 if (t->alignment_offset & (t->logical_block_size - 1)) {
Martin K. Petersen9504e082009-12-21 15:55:51 +0100611 t->misaligned = 1;
Martin K. Petersenfe0b3932010-01-11 03:21:47 -0500612 ret = -1;
613 }
Martin K. Petersen9504e082009-12-21 15:55:51 +0100614
615 /* Discard alignment and granularity */
616 if (b->discard_granularity) {
Martin K. Petersene03a72e2010-01-11 03:21:51 -0500617 alignment = queue_limit_discard_alignment(b, start);
Martin K. Petersen9504e082009-12-21 15:55:51 +0100618
619 if (t->discard_granularity != 0 &&
620 t->discard_alignment != alignment) {
621 top = t->discard_granularity + t->discard_alignment;
622 bottom = b->discard_granularity + alignment;
623
624 /* Verify that top and bottom intervals line up */
625 if (max(top, bottom) & (min(top, bottom) - 1))
626 t->discard_misaligned = 1;
627 }
628
Martin K. Petersen81744ee2009-12-29 08:35:35 +0100629 t->max_discard_sectors = min_not_zero(t->max_discard_sectors,
630 b->max_discard_sectors);
Martin K. Petersen9504e082009-12-21 15:55:51 +0100631 t->discard_granularity = max(t->discard_granularity,
632 b->discard_granularity);
633 t->discard_alignment = lcm(t->discard_alignment, alignment) &
634 (t->discard_granularity - 1);
635 }
636
Martin K. Petersenfe0b3932010-01-11 03:21:47 -0500637 return ret;
Martin K. Petersenc72758f2009-05-22 17:17:53 -0400638}
Mike Snitzer5d85d322009-05-28 11:04:53 +0200639EXPORT_SYMBOL(blk_stack_limits);
Martin K. Petersenc72758f2009-05-22 17:17:53 -0400640
641/**
Martin K. Petersen17be8c22010-01-11 03:21:49 -0500642 * bdev_stack_limits - adjust queue limits for stacked drivers
643 * @t: the stacking driver limits (top device)
644 * @bdev: the component block_device (bottom)
645 * @start: first data sector within component device
646 *
647 * Description:
648 * Merges queue limits for a top device and a block_device. Returns
649 * 0 if alignment didn't change. Returns -1 if adding the bottom
650 * device caused misalignment.
651 */
652int bdev_stack_limits(struct queue_limits *t, struct block_device *bdev,
653 sector_t start)
654{
655 struct request_queue *bq = bdev_get_queue(bdev);
656
657 start += get_start_sect(bdev);
658
Martin K. Petersene03a72e2010-01-11 03:21:51 -0500659 return blk_stack_limits(t, &bq->limits, start);
Martin K. Petersen17be8c22010-01-11 03:21:49 -0500660}
661EXPORT_SYMBOL(bdev_stack_limits);
662
663/**
Martin K. Petersenc72758f2009-05-22 17:17:53 -0400664 * disk_stack_limits - adjust queue limits for stacked drivers
Martin K. Petersen77634f32009-06-09 06:23:22 +0200665 * @disk: MD/DM gendisk (top)
Martin K. Petersenc72758f2009-05-22 17:17:53 -0400666 * @bdev: the underlying block device (bottom)
667 * @offset: offset to beginning of data within component device
668 *
669 * Description:
Martin K. Petersene03a72e2010-01-11 03:21:51 -0500670 * Merges the limits for a top level gendisk and a bottom level
671 * block_device.
Martin K. Petersenc72758f2009-05-22 17:17:53 -0400672 */
673void disk_stack_limits(struct gendisk *disk, struct block_device *bdev,
674 sector_t offset)
675{
676 struct request_queue *t = disk->queue;
677 struct request_queue *b = bdev_get_queue(bdev);
678
Martin K. Petersene03a72e2010-01-11 03:21:51 -0500679 if (bdev_stack_limits(&t->limits, bdev, offset >> 9) < 0) {
Martin K. Petersenc72758f2009-05-22 17:17:53 -0400680 char top[BDEVNAME_SIZE], bottom[BDEVNAME_SIZE];
681
682 disk_name(disk, 0, top);
683 bdevname(bdev, bottom);
684
685 printk(KERN_NOTICE "%s: Warning: Device %s is misaligned\n",
686 top, bottom);
687 }
688
689 if (!t->queue_lock)
690 WARN_ON_ONCE(1);
691 else if (!test_bit(QUEUE_FLAG_CLUSTER, &b->queue_flags)) {
692 unsigned long flags;
693
694 spin_lock_irqsave(t->queue_lock, flags);
695 if (!test_bit(QUEUE_FLAG_CLUSTER, &b->queue_flags))
696 queue_flag_clear(QUEUE_FLAG_CLUSTER, t);
697 spin_unlock_irqrestore(t->queue_lock, flags);
698 }
699}
700EXPORT_SYMBOL(disk_stack_limits);
701
702/**
Tejun Heoe3790c72008-03-04 11:18:17 +0100703 * blk_queue_dma_pad - set pad mask
704 * @q: the request queue for the device
705 * @mask: pad mask
706 *
FUJITA Tomonori27f82212008-07-04 09:30:03 +0200707 * Set dma pad mask.
Tejun Heoe3790c72008-03-04 11:18:17 +0100708 *
FUJITA Tomonori27f82212008-07-04 09:30:03 +0200709 * Appending pad buffer to a request modifies the last entry of a
710 * scatter list such that it includes the pad buffer.
Tejun Heoe3790c72008-03-04 11:18:17 +0100711 **/
712void blk_queue_dma_pad(struct request_queue *q, unsigned int mask)
713{
714 q->dma_pad_mask = mask;
715}
716EXPORT_SYMBOL(blk_queue_dma_pad);
717
718/**
FUJITA Tomonori27f82212008-07-04 09:30:03 +0200719 * blk_queue_update_dma_pad - update pad mask
720 * @q: the request queue for the device
721 * @mask: pad mask
722 *
723 * Update dma pad mask.
724 *
725 * Appending pad buffer to a request modifies the last entry of a
726 * scatter list such that it includes the pad buffer.
727 **/
728void blk_queue_update_dma_pad(struct request_queue *q, unsigned int mask)
729{
730 if (mask > q->dma_pad_mask)
731 q->dma_pad_mask = mask;
732}
733EXPORT_SYMBOL(blk_queue_update_dma_pad);
734
735/**
Jens Axboe86db1e22008-01-29 14:53:40 +0100736 * blk_queue_dma_drain - Set up a drain buffer for excess dma.
Jens Axboe86db1e22008-01-29 14:53:40 +0100737 * @q: the request queue for the device
Tejun Heo2fb98e82008-02-19 11:36:53 +0100738 * @dma_drain_needed: fn which returns non-zero if drain is necessary
Jens Axboe86db1e22008-01-29 14:53:40 +0100739 * @buf: physically contiguous buffer
740 * @size: size of the buffer in bytes
741 *
742 * Some devices have excess DMA problems and can't simply discard (or
743 * zero fill) the unwanted piece of the transfer. They have to have a
744 * real area of memory to transfer it into. The use case for this is
745 * ATAPI devices in DMA mode. If the packet command causes a transfer
746 * bigger than the transfer size some HBAs will lock up if there
747 * aren't DMA elements to contain the excess transfer. What this API
748 * does is adjust the queue so that the buf is always appended
749 * silently to the scatterlist.
750 *
751 * Note: This routine adjusts max_hw_segments to make room for
752 * appending the drain buffer. If you call
753 * blk_queue_max_hw_segments() or blk_queue_max_phys_segments() after
754 * calling this routine, you must set the limit to one fewer than your
755 * device can support otherwise there won't be room for the drain
756 * buffer.
757 */
Harvey Harrison448da4d2008-03-04 11:30:18 +0100758int blk_queue_dma_drain(struct request_queue *q,
Tejun Heo2fb98e82008-02-19 11:36:53 +0100759 dma_drain_needed_fn *dma_drain_needed,
760 void *buf, unsigned int size)
Jens Axboe86db1e22008-01-29 14:53:40 +0100761{
Martin K. Petersenae03bf62009-05-22 17:17:50 -0400762 if (queue_max_hw_segments(q) < 2 || queue_max_phys_segments(q) < 2)
Jens Axboe86db1e22008-01-29 14:53:40 +0100763 return -EINVAL;
764 /* make room for appending the drain */
Martin K. Petersenae03bf62009-05-22 17:17:50 -0400765 blk_queue_max_hw_segments(q, queue_max_hw_segments(q) - 1);
766 blk_queue_max_phys_segments(q, queue_max_phys_segments(q) - 1);
Tejun Heo2fb98e82008-02-19 11:36:53 +0100767 q->dma_drain_needed = dma_drain_needed;
Jens Axboe86db1e22008-01-29 14:53:40 +0100768 q->dma_drain_buffer = buf;
769 q->dma_drain_size = size;
770
771 return 0;
772}
Jens Axboe86db1e22008-01-29 14:53:40 +0100773EXPORT_SYMBOL_GPL(blk_queue_dma_drain);
774
775/**
776 * blk_queue_segment_boundary - set boundary rules for segment merging
777 * @q: the request queue for the device
778 * @mask: the memory boundary mask
779 **/
780void blk_queue_segment_boundary(struct request_queue *q, unsigned long mask)
781{
782 if (mask < PAGE_CACHE_SIZE - 1) {
783 mask = PAGE_CACHE_SIZE - 1;
Harvey Harrison24c03d42008-05-01 04:35:17 -0700784 printk(KERN_INFO "%s: set to minimum %lx\n",
785 __func__, mask);
Jens Axboe86db1e22008-01-29 14:53:40 +0100786 }
787
Martin K. Petersen025146e2009-05-22 17:17:51 -0400788 q->limits.seg_boundary_mask = mask;
Jens Axboe86db1e22008-01-29 14:53:40 +0100789}
Jens Axboe86db1e22008-01-29 14:53:40 +0100790EXPORT_SYMBOL(blk_queue_segment_boundary);
791
792/**
793 * blk_queue_dma_alignment - set dma length and memory alignment
794 * @q: the request queue for the device
795 * @mask: alignment mask
796 *
797 * description:
Randy Dunlap710027a2008-08-19 20:13:11 +0200798 * set required memory and length alignment for direct dma transactions.
Alan Cox8feb4d22009-04-01 15:01:39 +0100799 * this is used when building direct io requests for the queue.
Jens Axboe86db1e22008-01-29 14:53:40 +0100800 *
801 **/
802void blk_queue_dma_alignment(struct request_queue *q, int mask)
803{
804 q->dma_alignment = mask;
805}
Jens Axboe86db1e22008-01-29 14:53:40 +0100806EXPORT_SYMBOL(blk_queue_dma_alignment);
807
808/**
809 * blk_queue_update_dma_alignment - update dma length and memory alignment
810 * @q: the request queue for the device
811 * @mask: alignment mask
812 *
813 * description:
Randy Dunlap710027a2008-08-19 20:13:11 +0200814 * update required memory and length alignment for direct dma transactions.
Jens Axboe86db1e22008-01-29 14:53:40 +0100815 * If the requested alignment is larger than the current alignment, then
816 * the current queue alignment is updated to the new value, otherwise it
817 * is left alone. The design of this is to allow multiple objects
818 * (driver, device, transport etc) to set their respective
819 * alignments without having them interfere.
820 *
821 **/
822void blk_queue_update_dma_alignment(struct request_queue *q, int mask)
823{
824 BUG_ON(mask > PAGE_SIZE);
825
826 if (mask > q->dma_alignment)
827 q->dma_alignment = mask;
828}
Jens Axboe86db1e22008-01-29 14:53:40 +0100829EXPORT_SYMBOL(blk_queue_update_dma_alignment);
830
Harvey Harrisonaeb3d3a2008-08-28 09:27:42 +0200831static int __init blk_settings_init(void)
Jens Axboe86db1e22008-01-29 14:53:40 +0100832{
833 blk_max_low_pfn = max_low_pfn - 1;
834 blk_max_pfn = max_pfn - 1;
835 return 0;
836}
837subsys_initcall(blk_settings_init);