block: Update blk_queue_max_sectors and documentation
[safe/jmp/linux-2.6] / block / blk-settings.c
1 /*
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 */
10 #include <linux/gcd.h>
11 #include <linux/jiffies.h>
12
13 #include "blk.h"
14
15 unsigned long blk_max_low_pfn;
16 EXPORT_SYMBOL(blk_max_low_pfn);
17
18 unsigned long blk_max_pfn;
19
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  */
31 void blk_queue_prep_rq(struct request_queue *q, prep_rq_fn *pfn)
32 {
33         q->prep_rq_fn = pfn;
34 }
35 EXPORT_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  */
53 void blk_queue_merge_bvec(struct request_queue *q, merge_bvec_fn *mbfn)
54 {
55         q->merge_bvec_fn = mbfn;
56 }
57 EXPORT_SYMBOL(blk_queue_merge_bvec);
58
59 void blk_queue_softirq_done(struct request_queue *q, softirq_done_fn *fn)
60 {
61         q->softirq_done_fn = fn;
62 }
63 EXPORT_SYMBOL(blk_queue_softirq_done);
64
65 void blk_queue_rq_timeout(struct request_queue *q, unsigned int timeout)
66 {
67         q->rq_timeout = timeout;
68 }
69 EXPORT_SYMBOL_GPL(blk_queue_rq_timeout);
70
71 void blk_queue_rq_timed_out(struct request_queue *q, rq_timed_out_fn *fn)
72 {
73         q->rq_timed_out_fn = fn;
74 }
75 EXPORT_SYMBOL_GPL(blk_queue_rq_timed_out);
76
77 void blk_queue_lld_busy(struct request_queue *q, lld_busy_fn *fn)
78 {
79         q->lld_busy_fn = fn;
80 }
81 EXPORT_SYMBOL_GPL(blk_queue_lld_busy);
82
83 /**
84  * blk_set_default_limits - reset limits to default values
85  * @lim:  the queue_limits structure to reset
86  *
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  */
92 void 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;
98         lim->max_sectors = BLK_DEF_MAX_SECTORS;
99         lim->max_hw_sectors = INT_MAX;
100         lim->max_discard_sectors = 0;
101         lim->discard_granularity = 0;
102         lim->discard_alignment = 0;
103         lim->discard_misaligned = 0;
104         lim->discard_zeroes_data = -1;
105         lim->logical_block_size = lim->physical_block_size = lim->io_min = 512;
106         lim->bounce_pfn = (unsigned long)(BLK_BOUNCE_ANY >> PAGE_SHIFT);
107         lim->alignment_offset = 0;
108         lim->io_opt = 0;
109         lim->misaligned = 0;
110         lim->no_cluster = 0;
111 }
112 EXPORT_SYMBOL(blk_set_default_limits);
113
114 /**
115  * 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  **/
136 void blk_queue_make_request(struct request_queue *q, make_request_fn *mfn)
137 {
138         /*
139          * set defaults
140          */
141         q->nr_requests = BLKDEV_MAX_RQ;
142
143         q->make_request_fn = mfn;
144         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 */
149         q->unplug_delay = msecs_to_jiffies(3);  /* 3 milliseconds */
150         if (q->unplug_delay == 0)
151                 q->unplug_delay = 1;
152
153         q->unplug_timer.function = blk_unplug_timeout;
154         q->unplug_timer.data = (unsigned long)q;
155
156         blk_set_default_limits(&q->limits);
157         blk_queue_max_sectors(q, SAFE_MAX_SECTORS);
158
159         /*
160          * 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         /*
167          * by default assume old behaviour and bounce for any highmem page
168          */
169         blk_queue_bounce_limit(q, BLK_BOUNCE_HIGH);
170 }
171 EXPORT_SYMBOL(blk_queue_make_request);
172
173 /**
174  * blk_queue_bounce_limit - set bounce buffer limit for queue
175  * @q: the request queue for the device
176  * @dma_mask: the maximum address the device can handle
177  *
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
182  *    buffers for doing I/O to pages residing above @dma_mask.
183  **/
184 void blk_queue_bounce_limit(struct request_queue *q, u64 dma_mask)
185 {
186         unsigned long b_pfn = dma_mask >> PAGE_SHIFT;
187         int dma = 0;
188
189         q->bounce_gfp = GFP_NOIO;
190 #if BITS_PER_LONG == 64
191         /*
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))
197                 dma = 1;
198         q->limits.bounce_pfn = max_low_pfn;
199 #else
200         if (b_pfn < blk_max_low_pfn)
201                 dma = 1;
202         q->limits.bounce_pfn = b_pfn;
203 #endif
204         if (dma) {
205                 init_emergency_isa_pool();
206                 q->bounce_gfp = GFP_NOIO | GFP_DMA;
207                 q->limits.bounce_pfn = b_pfn;
208         }
209 }
210 EXPORT_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
215  * @max_hw_sectors:  max hardware sectors in the usual 512b unit
216  *
217  * Description:
218  *    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.
227  **/
228 void blk_queue_max_sectors(struct request_queue *q, unsigned int max_hw_sectors)
229 {
230         if ((max_hw_sectors << 9) < PAGE_CACHE_SIZE) {
231                 max_hw_sectors = 1 << (PAGE_CACHE_SHIFT - 9);
232                 printk(KERN_INFO "%s: set to minimum %d\n",
233                        __func__, max_hw_sectors);
234         }
235
236         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);
239 }
240 EXPORT_SYMBOL(blk_queue_max_sectors);
241
242 void blk_queue_max_hw_sectors(struct request_queue *q, unsigned int max_sectors)
243 {
244         if (BLK_DEF_MAX_SECTORS > max_sectors)
245                 q->limits.max_hw_sectors = BLK_DEF_MAX_SECTORS;
246         else
247                 q->limits.max_hw_sectors = max_sectors;
248 }
249 EXPORT_SYMBOL(blk_queue_max_hw_sectors);
250
251 /**
252  * blk_queue_max_discard_sectors - set max sectors for a single discard
253  * @q:  the request queue for the device
254  * @max_discard_sectors: maximum number of sectors to discard
255  **/
256 void 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 }
261 EXPORT_SYMBOL(blk_queue_max_discard_sectors);
262
263 /**
264  * 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  **/
273 void blk_queue_max_phys_segments(struct request_queue *q,
274                                  unsigned short max_segments)
275 {
276         if (!max_segments) {
277                 max_segments = 1;
278                 printk(KERN_INFO "%s: set to minimum %d\n",
279                        __func__, max_segments);
280         }
281
282         q->limits.max_phys_segments = max_segments;
283 }
284 EXPORT_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
294  *    address/length pairs the host adapter can actually give at once
295  *    to the device.
296  **/
297 void blk_queue_max_hw_segments(struct request_queue *q,
298                                unsigned short max_segments)
299 {
300         if (!max_segments) {
301                 max_segments = 1;
302                 printk(KERN_INFO "%s: set to minimum %d\n",
303                        __func__, max_segments);
304         }
305
306         q->limits.max_hw_segments = max_segments;
307 }
308 EXPORT_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  **/
319 void 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;
323                 printk(KERN_INFO "%s: set to minimum %d\n",
324                        __func__, max_size);
325         }
326
327         q->limits.max_segment_size = max_size;
328 }
329 EXPORT_SYMBOL(blk_queue_max_segment_size);
330
331 /**
332  * blk_queue_logical_block_size - set logical block size for the queue
333  * @q:  the request queue for the device
334  * @size:  the logical block size, in bytes
335  *
336  * Description:
337  *   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.
340  **/
341 void blk_queue_logical_block_size(struct request_queue *q, unsigned short size)
342 {
343         q->limits.logical_block_size = size;
344
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;
350 }
351 EXPORT_SYMBOL(blk_queue_logical_block_size);
352
353 /**
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  */
363 void 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 }
373 EXPORT_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
378  * @offset: alignment offset in bytes
379  *
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  */
386 void 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 }
392 EXPORT_SYMBOL(blk_queue_alignment_offset);
393
394 /**
395  * 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  */
405 void 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 }
415 EXPORT_SYMBOL(blk_limits_io_min);
416
417 /**
418  * blk_queue_io_min - set minimum request size for the queue
419  * @q:  the request queue for the device
420  * @min:  smallest I/O size in bytes
421  *
422  * Description:
423  *   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.
430  */
431 void blk_queue_io_min(struct request_queue *q, unsigned int min)
432 {
433         blk_limits_io_min(&q->limits, min);
434 }
435 EXPORT_SYMBOL(blk_queue_io_min);
436
437 /**
438  * 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  */
450 void blk_limits_io_opt(struct queue_limits *limits, unsigned int opt)
451 {
452         limits->io_opt = opt;
453 }
454 EXPORT_SYMBOL(blk_limits_io_opt);
455
456 /**
457  * blk_queue_io_opt - set optimal request size for the queue
458  * @q:  the request queue for the device
459  * @opt:  optimal request size in bytes
460  *
461  * Description:
462  *   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.
468  */
469 void blk_queue_io_opt(struct request_queue *q, unsigned int opt)
470 {
471         blk_limits_io_opt(&q->limits, opt);
472 }
473 EXPORT_SYMBOL(blk_queue_io_opt);
474
475 /*
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  **/
485 void blk_queue_stack_limits(struct request_queue *t, struct request_queue *b)
486 {
487         blk_stack_limits(&t->limits, &b->limits, 0);
488
489         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);
494                 queue_flag_clear(QUEUE_FLAG_CLUSTER, t);
495                 spin_unlock_irqrestore(t->queue_lock, flags);
496         }
497 }
498 EXPORT_SYMBOL(blk_queue_stack_limits);
499
500 static 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
510 /**
511  * blk_stack_limits - adjust queue_limits for stacked devices
512  * @t:  the stacking driver limits (top device)
513  * @b:  the underlying queue limits (bottom, component device)
514  * @start:  first data sector within component device
515  *
516  * Description:
517  *    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.
530  */
531 int blk_stack_limits(struct queue_limits *t, struct queue_limits *b,
532                      sector_t start)
533 {
534         unsigned int top, bottom, alignment, ret = 0;
535
536         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);
538         t->bounce_pfn = min_not_zero(t->bounce_pfn, b->bounce_pfn);
539
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
552         t->misaligned |= b->misaligned;
553
554         alignment = queue_limit_alignment_offset(b, start);
555
556         /* Bottom device has different alignment.  Check that it is
557          * compatible with the current top alignment.
558          */
559         if (t->alignment_offset != alignment) {
560
561                 top = max(t->physical_block_size, t->io_min)
562                         + t->alignment_offset;
563                 bottom = max(b->physical_block_size, b->io_min) + alignment;
564
565                 /* Verify that top and bottom intervals line up */
566                 if (max(top, bottom) & (min(top, bottom) - 1)) {
567                         t->misaligned = 1;
568                         ret = -1;
569                 }
570         }
571
572         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);
579         t->io_opt = lcm(t->io_opt, b->io_opt);
580
581         t->no_cluster |= b->no_cluster;
582         t->discard_zeroes_data &= b->discard_zeroes_data;
583
584         /* Physical block size a multiple of the logical block size? */
585         if (t->physical_block_size & (t->logical_block_size - 1)) {
586                 t->physical_block_size = t->logical_block_size;
587                 t->misaligned = 1;
588                 ret = -1;
589         }
590
591         /* Minimum I/O a multiple of the physical block size? */
592         if (t->io_min & (t->physical_block_size - 1)) {
593                 t->io_min = t->physical_block_size;
594                 t->misaligned = 1;
595                 ret = -1;
596         }
597
598         /* Optimal I/O a multiple of the physical block size? */
599         if (t->io_opt & (t->physical_block_size - 1)) {
600                 t->io_opt = 0;
601                 t->misaligned = 1;
602                 ret = -1;
603         }
604
605         /* Find lowest common alignment_offset */
606         t->alignment_offset = lcm(t->alignment_offset, alignment)
607                 & (max(t->physical_block_size, t->io_min) - 1);
608
609         /* Verify that new alignment_offset is on a logical block boundary */
610         if (t->alignment_offset & (t->logical_block_size - 1)) {
611                 t->misaligned = 1;
612                 ret = -1;
613         }
614
615         /* Discard alignment and granularity */
616         if (b->discard_granularity) {
617                 alignment = queue_limit_discard_alignment(b, start);
618
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
629                 t->max_discard_sectors = min_not_zero(t->max_discard_sectors,
630                                                       b->max_discard_sectors);
631                 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
637         return ret;
638 }
639 EXPORT_SYMBOL(blk_stack_limits);
640
641 /**
642  * 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  */
652 int 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
659         return blk_stack_limits(t, &bq->limits, start);
660 }
661 EXPORT_SYMBOL(bdev_stack_limits);
662
663 /**
664  * disk_stack_limits - adjust queue limits for stacked drivers
665  * @disk:  MD/DM gendisk (top)
666  * @bdev:  the underlying block device (bottom)
667  * @offset:  offset to beginning of data within component device
668  *
669  * Description:
670  *    Merges the limits for a top level gendisk and a bottom level
671  *    block_device.
672  */
673 void 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
679         if (bdev_stack_limits(&t->limits, bdev, offset >> 9) < 0) {
680                 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 }
700 EXPORT_SYMBOL(disk_stack_limits);
701
702 /**
703  * blk_queue_dma_pad - set pad mask
704  * @q:     the request queue for the device
705  * @mask:  pad mask
706  *
707  * Set dma pad mask.
708  *
709  * Appending pad buffer to a request modifies the last entry of a
710  * scatter list such that it includes the pad buffer.
711  **/
712 void blk_queue_dma_pad(struct request_queue *q, unsigned int mask)
713 {
714         q->dma_pad_mask = mask;
715 }
716 EXPORT_SYMBOL(blk_queue_dma_pad);
717
718 /**
719  * 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  **/
728 void 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 }
733 EXPORT_SYMBOL(blk_queue_update_dma_pad);
734
735 /**
736  * blk_queue_dma_drain - Set up a drain buffer for excess dma.
737  * @q:  the request queue for the device
738  * @dma_drain_needed: fn which returns non-zero if drain is necessary
739  * @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  */
758 int blk_queue_dma_drain(struct request_queue *q,
759                                dma_drain_needed_fn *dma_drain_needed,
760                                void *buf, unsigned int size)
761 {
762         if (queue_max_hw_segments(q) < 2 || queue_max_phys_segments(q) < 2)
763                 return -EINVAL;
764         /* make room for appending the drain */
765         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);
767         q->dma_drain_needed = dma_drain_needed;
768         q->dma_drain_buffer = buf;
769         q->dma_drain_size = size;
770
771         return 0;
772 }
773 EXPORT_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  **/
780 void 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;
784                 printk(KERN_INFO "%s: set to minimum %lx\n",
785                        __func__, mask);
786         }
787
788         q->limits.seg_boundary_mask = mask;
789 }
790 EXPORT_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:
798  *    set required memory and length alignment for direct dma transactions.
799  *    this is used when building direct io requests for the queue.
800  *
801  **/
802 void blk_queue_dma_alignment(struct request_queue *q, int mask)
803 {
804         q->dma_alignment = mask;
805 }
806 EXPORT_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:
814  *    update required memory and length alignment for direct dma transactions.
815  *    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  **/
822 void 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 }
829 EXPORT_SYMBOL(blk_queue_update_dma_alignment);
830
831 static int __init blk_settings_init(void)
832 {
833         blk_max_low_pfn = max_low_pfn - 1;
834         blk_max_pfn = max_pfn - 1;
835         return 0;
836 }
837 subsys_initcall(blk_settings_init);