diff mbox series

blk-mq: Document some blk_mq_ctx fields

Message ID 20210311081729.2763232-1-nborisov@suse.com (mailing list archive)
State New, archived
Headers show
Series blk-mq: Document some blk_mq_ctx fields | expand

Commit Message

Nikolay Borisov March 11, 2021, 8:17 a.m. UTC
Signed-off-by: Nikolay Borisov <nborisov@suse.com>
---
 block/blk-mq.h | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

Comments

Johannes Thumshirn March 11, 2021, 11:19 a.m. UTC | #1
Looks good,
Reviewed-by: Johannes Thumshirn <johannes.thumshirn@wdc.com>
Nikolay Borisov April 6, 2021, 7:06 a.m. UTC | #2
On 11.03.21 г. 10:17, Nikolay Borisov wrote:
> Signed-off-by: Nikolay Borisov <nborisov@suse.com>

Ping

> ---
>  block/blk-mq.h | 17 +++++++++++++++++
>  1 file changed, 17 insertions(+)
> 
> diff --git a/block/blk-mq.h b/block/blk-mq.h
> index 3616453ca28c..f0079e177bba 100644
> --- a/block/blk-mq.h
> +++ b/block/blk-mq.h
> @@ -17,12 +17,26 @@ struct blk_mq_ctxs {
>   */
>  struct blk_mq_ctx {
>  	struct {
> +		/** @lock: Protects the rq_lists */
>  		spinlock_t		lock;
>  		struct list_head	rq_lists[HCTX_MAX_TYPES];
>  	} ____cacheline_aligned_in_smp;
>  
> +	/**
> +	 * @cpu: id of cpu owning this context
> +	 */
>  	unsigned int		cpu;
> +
> +	/**
> +	 * @index_hw: Number of software queues mapped to the hw queue for each
> +	 * hardware queue type
> +	 */
>  	unsigned short		index_hw[HCTX_MAX_TYPES];
> +
> +	/**
> +	 * @hctxs: Hardware queue this queue maps to for each hardware queue
> +	 * type
> +	 */
>  	struct blk_mq_hw_ctx 	*hctxs[HCTX_MAX_TYPES];
>  
>  	/* incremented at dispatch time */
> @@ -32,6 +46,9 @@ struct blk_mq_ctx {
>  	/* incremented at completion time */
>  	unsigned long		____cacheline_aligned_in_smp rq_completed[2];
>  
> +	/**
> +	 * @queue: Pointer to the request queue that owns this software context.
> +	 */
>  	struct request_queue	*queue;
>  	struct blk_mq_ctxs      *ctxs;
>  	struct kobject		kobj;
>
diff mbox series

Patch

diff --git a/block/blk-mq.h b/block/blk-mq.h
index 3616453ca28c..f0079e177bba 100644
--- a/block/blk-mq.h
+++ b/block/blk-mq.h
@@ -17,12 +17,26 @@  struct blk_mq_ctxs {
  */
 struct blk_mq_ctx {
 	struct {
+		/** @lock: Protects the rq_lists */
 		spinlock_t		lock;
 		struct list_head	rq_lists[HCTX_MAX_TYPES];
 	} ____cacheline_aligned_in_smp;
 
+	/**
+	 * @cpu: id of cpu owning this context
+	 */
 	unsigned int		cpu;
+
+	/**
+	 * @index_hw: Number of software queues mapped to the hw queue for each
+	 * hardware queue type
+	 */
 	unsigned short		index_hw[HCTX_MAX_TYPES];
+
+	/**
+	 * @hctxs: Hardware queue this queue maps to for each hardware queue
+	 * type
+	 */
 	struct blk_mq_hw_ctx 	*hctxs[HCTX_MAX_TYPES];
 
 	/* incremented at dispatch time */
@@ -32,6 +46,9 @@  struct blk_mq_ctx {
 	/* incremented at completion time */
 	unsigned long		____cacheline_aligned_in_smp rq_completed[2];
 
+	/**
+	 * @queue: Pointer to the request queue that owns this software context.
+	 */
 	struct request_queue	*queue;
 	struct blk_mq_ctxs      *ctxs;
 	struct kobject		kobj;