]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - block/blk-tag.c
UBUNTU: Ubuntu-4.13.0-45.50
[mirror_ubuntu-artful-kernel.git] / block / blk-tag.c
CommitLineData
8324aa91
JA
1/*
2 * Functions related to tagged command queuing
3 */
4#include <linux/kernel.h>
5#include <linux/module.h>
6#include <linux/bio.h>
7#include <linux/blkdev.h>
5a0e3ad6 8#include <linux/slab.h>
8324aa91 9
278caf01
AB
10#include "blk.h"
11
8324aa91
JA
12/**
13 * blk_queue_find_tag - find a request by its tag and queue
14 * @q: The request queue for the device
15 * @tag: The tag of the request
16 *
17 * Notes:
18 * Should be used when a device returns a tag and you want to match
19 * it with a request.
20 *
21 * no locks need be held.
22 **/
23struct request *blk_queue_find_tag(struct request_queue *q, int tag)
24{
25 return blk_map_queue_find_tag(q->queue_tags, tag);
26}
8324aa91
JA
27EXPORT_SYMBOL(blk_queue_find_tag);
28
29/**
d45b3279 30 * blk_free_tags - release a given set of tag maintenance info
8324aa91
JA
31 * @bqt: the tag map to free
32 *
d45b3279
CH
33 * Drop the reference count on @bqt and frees it when the last reference
34 * is dropped.
8324aa91 35 */
d45b3279 36void blk_free_tags(struct blk_queue_tag *bqt)
8324aa91 37{
d45b3279 38 if (atomic_dec_and_test(&bqt->refcnt)) {
0e3eb45e
MW
39 BUG_ON(find_first_bit(bqt->tag_map, bqt->max_depth) <
40 bqt->max_depth);
8324aa91
JA
41
42 kfree(bqt->tag_index);
43 bqt->tag_index = NULL;
44
45 kfree(bqt->tag_map);
46 bqt->tag_map = NULL;
47
48 kfree(bqt);
49 }
8324aa91 50}
d45b3279 51EXPORT_SYMBOL(blk_free_tags);
8324aa91
JA
52
53/**
54 * __blk_queue_free_tags - release tag maintenance info
55 * @q: the request queue for the device
56 *
57 * Notes:
58 * blk_cleanup_queue() will take care of calling this function, if tagging
59 * has been used. So there's no need to call this directly.
60 **/
61void __blk_queue_free_tags(struct request_queue *q)
62{
63 struct blk_queue_tag *bqt = q->queue_tags;
64
65 if (!bqt)
66 return;
67
d45b3279 68 blk_free_tags(bqt);
8324aa91
JA
69
70 q->queue_tags = NULL;
aa94b537 71 queue_flag_clear_unlocked(QUEUE_FLAG_QUEUED, q);
8324aa91
JA
72}
73
8324aa91
JA
74/**
75 * blk_queue_free_tags - release tag maintenance info
76 * @q: the request queue for the device
77 *
78 * Notes:
710027a4 79 * This is used to disable tagged queuing to a device, yet leave
8324aa91
JA
80 * queue in function.
81 **/
82void blk_queue_free_tags(struct request_queue *q)
83{
aa94b537 84 queue_flag_clear_unlocked(QUEUE_FLAG_QUEUED, q);
8324aa91 85}
8324aa91
JA
86EXPORT_SYMBOL(blk_queue_free_tags);
87
88static int
89init_tag_map(struct request_queue *q, struct blk_queue_tag *tags, int depth)
90{
91 struct request **tag_index;
92 unsigned long *tag_map;
93 int nr_ulongs;
94
95 if (q && depth > q->nr_requests * 2) {
96 depth = q->nr_requests * 2;
97 printk(KERN_ERR "%s: adjusted depth to %d\n",
24c03d47 98 __func__, depth);
8324aa91
JA
99 }
100
101 tag_index = kzalloc(depth * sizeof(struct request *), GFP_ATOMIC);
102 if (!tag_index)
103 goto fail;
104
105 nr_ulongs = ALIGN(depth, BITS_PER_LONG) / BITS_PER_LONG;
106 tag_map = kzalloc(nr_ulongs * sizeof(unsigned long), GFP_ATOMIC);
107 if (!tag_map)
108 goto fail;
109
110 tags->real_max_depth = depth;
111 tags->max_depth = depth;
112 tags->tag_index = tag_index;
113 tags->tag_map = tag_map;
114
115 return 0;
116fail:
117 kfree(tag_index);
118 return -ENOMEM;
119}
120
121static struct blk_queue_tag *__blk_queue_init_tags(struct request_queue *q,
ee1b6f7a 122 int depth, int alloc_policy)
8324aa91
JA
123{
124 struct blk_queue_tag *tags;
125
126 tags = kmalloc(sizeof(struct blk_queue_tag), GFP_ATOMIC);
127 if (!tags)
128 goto fail;
129
130 if (init_tag_map(q, tags, depth))
131 goto fail;
132
8324aa91 133 atomic_set(&tags->refcnt, 1);
ee1b6f7a
SL
134 tags->alloc_policy = alloc_policy;
135 tags->next_tag = 0;
8324aa91
JA
136 return tags;
137fail:
138 kfree(tags);
139 return NULL;
140}
141
142/**
143 * blk_init_tags - initialize the tag info for an external tag map
144 * @depth: the maximum queue depth supported
ee1b6f7a 145 * @alloc_policy: tag allocation policy
8324aa91 146 **/
ee1b6f7a 147struct blk_queue_tag *blk_init_tags(int depth, int alloc_policy)
8324aa91 148{
ee1b6f7a 149 return __blk_queue_init_tags(NULL, depth, alloc_policy);
8324aa91
JA
150}
151EXPORT_SYMBOL(blk_init_tags);
152
153/**
154 * blk_queue_init_tags - initialize the queue tag info
155 * @q: the request queue for the device
156 * @depth: the maximum queue depth supported
157 * @tags: the tag to use
ee1b6f7a 158 * @alloc_policy: tag allocation policy
aa94b537
JA
159 *
160 * Queue lock must be held here if the function is called to resize an
161 * existing map.
8324aa91
JA
162 **/
163int blk_queue_init_tags(struct request_queue *q, int depth,
ee1b6f7a 164 struct blk_queue_tag *tags, int alloc_policy)
8324aa91
JA
165{
166 int rc;
167
168 BUG_ON(tags && q->queue_tags && tags != q->queue_tags);
169
170 if (!tags && !q->queue_tags) {
ee1b6f7a 171 tags = __blk_queue_init_tags(q, depth, alloc_policy);
8324aa91
JA
172
173 if (!tags)
d41570b7
PST
174 return -ENOMEM;
175
8324aa91 176 } else if (q->queue_tags) {
6728cb0e
JA
177 rc = blk_queue_resize_tags(q, depth);
178 if (rc)
8324aa91 179 return rc;
75ad23bc 180 queue_flag_set(QUEUE_FLAG_QUEUED, q);
8324aa91
JA
181 return 0;
182 } else
183 atomic_inc(&tags->refcnt);
184
185 /*
186 * assign it, all done
187 */
188 q->queue_tags = tags;
aa94b537 189 queue_flag_set_unlocked(QUEUE_FLAG_QUEUED, q);
8324aa91
JA
190 INIT_LIST_HEAD(&q->tag_busy_list);
191 return 0;
8324aa91 192}
8324aa91
JA
193EXPORT_SYMBOL(blk_queue_init_tags);
194
195/**
196 * blk_queue_resize_tags - change the queueing depth
197 * @q: the request queue for the device
198 * @new_depth: the new max command queueing depth
199 *
200 * Notes:
201 * Must be called with the queue lock held.
202 **/
203int blk_queue_resize_tags(struct request_queue *q, int new_depth)
204{
205 struct blk_queue_tag *bqt = q->queue_tags;
206 struct request **tag_index;
207 unsigned long *tag_map;
208 int max_depth, nr_ulongs;
209
210 if (!bqt)
211 return -ENXIO;
212
213 /*
214 * if we already have large enough real_max_depth. just
215 * adjust max_depth. *NOTE* as requests with tag value
216 * between new_depth and real_max_depth can be in-flight, tag
217 * map can not be shrunk blindly here.
218 */
219 if (new_depth <= bqt->real_max_depth) {
220 bqt->max_depth = new_depth;
221 return 0;
222 }
223
224 /*
225 * Currently cannot replace a shared tag map with a new
226 * one, so error out if this is the case
227 */
228 if (atomic_read(&bqt->refcnt) != 1)
229 return -EBUSY;
230
231 /*
232 * save the old state info, so we can copy it back
233 */
234 tag_index = bqt->tag_index;
235 tag_map = bqt->tag_map;
236 max_depth = bqt->real_max_depth;
237
238 if (init_tag_map(q, bqt, new_depth))
239 return -ENOMEM;
240
241 memcpy(bqt->tag_index, tag_index, max_depth * sizeof(struct request *));
242 nr_ulongs = ALIGN(max_depth, BITS_PER_LONG) / BITS_PER_LONG;
243 memcpy(bqt->tag_map, tag_map, nr_ulongs * sizeof(unsigned long));
244
245 kfree(tag_index);
246 kfree(tag_map);
247 return 0;
248}
8324aa91
JA
249EXPORT_SYMBOL(blk_queue_resize_tags);
250
251/**
252 * blk_queue_end_tag - end tag operations for a request
253 * @q: the request queue for the device
254 * @rq: the request that has completed
255 *
256 * Description:
710027a4 257 * Typically called when end_that_request_first() returns %0, meaning
8324aa91
JA
258 * all transfers have been done for a request. It's important to call
259 * this function before end_that_request_last(), as that will put the
260 * request back on the free list thus corrupting the internal tag list.
8324aa91
JA
261 **/
262void blk_queue_end_tag(struct request_queue *q, struct request *rq)
263{
264 struct blk_queue_tag *bqt = q->queue_tags;
f2b20d43 265 unsigned tag = rq->tag; /* negative tags invalid */
8324aa91 266
2fff8a92
BVA
267 lockdep_assert_held(q->queue_lock);
268
f2b20d43 269 BUG_ON(tag >= bqt->real_max_depth);
8324aa91
JA
270
271 list_del_init(&rq->queuelist);
e8064021 272 rq->rq_flags &= ~RQF_QUEUED;
8324aa91 273 rq->tag = -1;
bd166ef1 274 rq->internal_tag = -1;
8324aa91
JA
275
276 if (unlikely(bqt->tag_index[tag] == NULL))
277 printk(KERN_ERR "%s: tag %d is missing\n",
24c03d47 278 __func__, tag);
8324aa91
JA
279
280 bqt->tag_index[tag] = NULL;
281
282 if (unlikely(!test_bit(tag, bqt->tag_map))) {
283 printk(KERN_ERR "%s: attempt to clear non-busy tag (%d)\n",
24c03d47 284 __func__, tag);
8324aa91
JA
285 return;
286 }
287 /*
288 * The tag_map bit acts as a lock for tag_index[bit], so we need
289 * unlock memory barrier semantics.
290 */
291 clear_bit_unlock(tag, bqt->tag_map);
8324aa91 292}
8324aa91
JA
293EXPORT_SYMBOL(blk_queue_end_tag);
294
295/**
296 * blk_queue_start_tag - find a free tag and assign it
297 * @q: the request queue for the device
298 * @rq: the block request that needs tagging
299 *
300 * Description:
301 * This can either be used as a stand-alone helper, or possibly be
302 * assigned as the queue &prep_rq_fn (in which case &struct request
303 * automagically gets a tag assigned). Note that this function
304 * assumes that any type of request can be queued! if this is not
305 * true for your device, you must check the request type before
306 * calling this function. The request will also be removed from
307 * the request queue, so it's the drivers responsibility to readd
308 * it if it should need to be restarted for some reason.
8324aa91
JA
309 **/
310int blk_queue_start_tag(struct request_queue *q, struct request *rq)
311{
312 struct blk_queue_tag *bqt = q->queue_tags;
0a7ae2ff 313 unsigned max_depth;
8324aa91
JA
314 int tag;
315
2fff8a92
BVA
316 lockdep_assert_held(q->queue_lock);
317
e8064021 318 if (unlikely((rq->rq_flags & RQF_QUEUED))) {
6728cb0e 319 printk(KERN_ERR
8324aa91 320 "%s: request %p for device [%s] already tagged %d",
24c03d47 321 __func__, rq,
8324aa91
JA
322 rq->rq_disk ? rq->rq_disk->disk_name : "?", rq->tag);
323 BUG();
324 }
325
326 /*
327 * Protect against shared tag maps, as we may not have exclusive
328 * access to the tag map.
e3ba9ae5
JA
329 *
330 * We reserve a few tags just for sync IO, since we don't want
331 * to starve sync IO on behalf of flooding async IO.
8324aa91 332 */
e3ba9ae5 333 max_depth = bqt->max_depth;
0a7ae2ff 334 if (!rq_is_sync(rq) && max_depth > 1) {
a6b3f761
JK
335 switch (max_depth) {
336 case 2:
0a7ae2ff 337 max_depth = 1;
a6b3f761
JK
338 break;
339 case 3:
340 max_depth = 2;
341 break;
342 default:
343 max_depth -= 2;
344 }
1b59dd51 345 if (q->in_flight[BLK_RW_ASYNC] > max_depth)
0a7ae2ff
JA
346 return 1;
347 }
e3ba9ae5 348
8324aa91 349 do {
ee1b6f7a
SL
350 if (bqt->alloc_policy == BLK_TAG_ALLOC_FIFO) {
351 tag = find_first_zero_bit(bqt->tag_map, max_depth);
352 if (tag >= max_depth)
353 return 1;
354 } else {
355 int start = bqt->next_tag;
356 int size = min_t(int, bqt->max_depth, max_depth + start);
357 tag = find_next_zero_bit(bqt->tag_map, size, start);
358 if (tag >= size && start + size > bqt->max_depth) {
359 size = start + size - bqt->max_depth;
360 tag = find_first_zero_bit(bqt->tag_map, size);
361 }
362 if (tag >= size)
363 return 1;
364 }
8324aa91
JA
365
366 } while (test_and_set_bit_lock(tag, bqt->tag_map));
367 /*
368 * We need lock ordering semantics given by test_and_set_bit_lock.
369 * See blk_queue_end_tag for details.
370 */
371
ee1b6f7a 372 bqt->next_tag = (tag + 1) % bqt->max_depth;
e8064021 373 rq->rq_flags |= RQF_QUEUED;
8324aa91
JA
374 rq->tag = tag;
375 bqt->tag_index[tag] = rq;
9934c8c0 376 blk_start_request(rq);
8324aa91 377 list_add(&rq->queuelist, &q->tag_busy_list);
8324aa91
JA
378 return 0;
379}
8324aa91
JA
380EXPORT_SYMBOL(blk_queue_start_tag);
381
382/**
383 * blk_queue_invalidate_tags - invalidate all pending tags
384 * @q: the request queue for the device
385 *
386 * Description:
387 * Hardware conditions may dictate a need to stop all pending requests.
388 * In this case, we will safely clear the block side of the tag queue and
389 * readd all requests to the request queue in the right order.
8324aa91
JA
390 **/
391void blk_queue_invalidate_tags(struct request_queue *q)
392{
393 struct list_head *tmp, *n;
394
2fff8a92
BVA
395 lockdep_assert_held(q->queue_lock);
396
8324aa91
JA
397 list_for_each_safe(tmp, n, &q->tag_busy_list)
398 blk_requeue_request(q, list_entry_rq(tmp));
399}
8324aa91 400EXPORT_SYMBOL(blk_queue_invalidate_tags);