Commit fea55691 authored by Bart Van Assche's avatar Bart Van Assche Committed by Jens Axboe
Browse files

blk-mq: Fix more tag iteration function documentation 



Commit 8ab30a33 ("blk-mq: Drop busy_iter_fn blk_mq_hw_ctx argument")
removed the hctx argument from the callback functions called by
bt_for_each() and blk_mq_queue_tag_busy_iter(). Commit 2dd6532e
("blk-mq: Drop 'reserved' arg of busy_tag_iter_fn") removed the
'reserved' argument of the busy_tag_iter_fn function pointer type. Bring
the documentation of the tag iteration functions in sync with these
changes.

Cc: John Garry <john.g.garry@oracle.com>
Cc: Ming Lei <ming.lei@redhat.com>
Cc: Christoph Hellwig <hch@infradead.org>
Signed-off-by: default avatarBart Van Assche <bvanassche@acm.org>
Signed-off-by: default avatarJens Axboe <axboe@kernel.dk>
parent a3835a44

block/blk-mq-tag.c

+15 −17
Original line number Diff line number Diff line
@@ -297,15 +297,15 @@ static bool bt_iter(struct sbitmap *bitmap, unsigned int bitnr, void *data) 
/**

 * bt_for_each - iterate over the requests associated with a hardware queue

 * @hctx:	Hardware queue to examine.

 * @q:		Request queue to examine.

 * @q:		Request queue @hctx is associated with (@hctx->queue).

 * @bt:		sbitmap to examine. This is either the breserved_tags member

 *		or the bitmap_tags member of struct blk_mq_tags.

 * @fn:		Pointer to the function that will be called for each request

 *		associated with @hctx that has been assigned a driver tag.

 *		@fn will be called as follows: @fn(@hctx, rq, @data, @reserved)

 *		where rq is a pointer to a request. Return true to continue

 *		iterating tags, false to stop.

 * @data:	Will be passed as third argument to @fn.

 *		@fn will be called as follows: @fn(rq, @data) where rq is a

 *		pointer to a request. Return %true to continue iterating tags;

 *		%false to stop.

 * @data:	Will be passed as second argument to @fn.

 * @reserved:	Indicates whether @bt is the breserved_tags member or the

 *		bitmap_tags member of struct blk_mq_tags.

 */
@@ -371,9 +371,9 @@ static bool bt_tags_iter(struct sbitmap *bitmap, unsigned int bitnr, void *data) 
 * @bt:		sbitmap to examine. This is either the breserved_tags member

 *		or the bitmap_tags member of struct blk_mq_tags.

 * @fn:		Pointer to the function that will be called for each started

 *		request. @fn will be called as follows: @fn(rq, @data,

 *		@reserved) where rq is a pointer to a request. Return true

 *		to continue iterating tags, false to stop.

 *		request. @fn will be called as follows: @fn(rq, @data) where rq

 *		is a pointer to a request. Return %true to continue iterating

 *		tags; %false to stop.

 * @data:	Will be passed as second argument to @fn.

 * @flags:	BT_TAG_ITER_*

 */
@@ -406,10 +406,9 @@ static void __blk_mq_all_tag_iter(struct blk_mq_tags *tags, 
 * blk_mq_all_tag_iter - iterate over all requests in a tag map

 * @tags:	Tag map to iterate over.

 * @fn:		Pointer to the function that will be called for each

 *		request. @fn will be called as follows: @fn(rq, @priv,

 *		reserved) where rq is a pointer to a request. 'reserved'

 *		indicates whether or not @rq is a reserved request. Return

 *		true to continue iterating tags, false to stop.

 *		request. @fn will be called as follows: @fn(rq, @priv) where rq

 *		is a pointer to a request. Return %true to continue iterating

 *		tags; %false to stop.

 * @priv:	Will be passed as second argument to @fn.

 *

 * Caller has to pass the tag map from which requests are allocated.
@@ -485,11 +484,10 @@ EXPORT_SYMBOL(blk_mq_tagset_wait_completed_request); 
 * blk_mq_queue_tag_busy_iter - iterate over all requests with a driver tag

 * @q:		Request queue to examine.

 * @fn:		Pointer to the function that will be called for each request

 *		on @q. @fn will be called as follows: @fn(hctx, rq, @priv,

 *		reserved) where rq is a pointer to a request and hctx points

 *		to the hardware queue associated with the request. 'reserved'

 *		indicates whether or not @rq is a reserved request.

 * @priv:	Will be passed as third argument to @fn.

 *		on @q. @fn will be called as follows: @fn(rq, @priv) where rq

 *		is a pointer to a request and hctx points to the hardware queue

 *		associated with the request.

 * @priv:	Will be passed as second argument to @fn.

 *

 * Note: if @q->tag_set is shared with other request queues then @fn will be

 * called for all requests on all queues that share that tag set and not only