Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
From:   Imran Khan <imran.f.khan@oracle.com>
To:     tj@kernel.org, jiangshanlai@gmail.com, gregkh@linuxfoundation.org,
        jirislaby@kernel.org, rafael@kernel.org, pavel@ucw.cz,
        len.brown@intel.com
Cc:     linux-kernel@vger.kernel.org, linux-pm@vger.kernel.org
Subject: [RFC PATCH v3] workqueue: Introduce show_one_worker_pool and show_one_workqueue.
Date:   Sat, 16 Oct 2021 11:20:07 +1100
Message-Id: <20211016002007.143661-1-imran.f.khan@oracle.com>
Content-Transfer-Encoding: 8bit
Content-Type: text/plain
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?Omp0+QciLBC3v5xDGIgO55xvCAweoyXoyMw4IE+2EDmVB9kah0HsRJTWfKDf?=
 =?us-ascii?Q?wXgLHWEh/nyE5z+3HEvRQyt3I5yQu/yt+qAnawTaeU9MlPa/Qg5riQZWTO5W?=
 =?us-ascii?Q?DW2O1dQL2GWeYf7fPux8h88h7jp9BUhRT93FAeB6JddrtwqE1H/Rd5EwhozS?=
 =?us-ascii?Q?a+7lGiUV6Pp2F8rU+AuaX9IAON/QZv2bn8zJZaCwiRTL2dyXM93y2iN8padL?=
 =?us-ascii?Q?52HK+ccNFADfQYDwhc2DehM/zBHaY8sr5aWd0l3W0YmsyD1sPRsau0EWtWB9?=
 =?us-ascii?Q?3jTHBX0frfou7v0E2jPyQN5rVQmXW4fN8cPZjCHB98BYd9Z8/dpcsDqx7M3g?=
 =?us-ascii?Q?SdV9ay6SV1xZ8TX78uXeCaeuVPmDg59HRNJiAkXEtJUQowKxJBsg5vXlr9ed?=
 =?us-ascii?Q?HKGEVzAEdKrO36VQRv9YszA33EQ+4fvzeDblXNrGXMC1pPnP5wy6VJIzuNlD?=
 =?us-ascii?Q?6KvnVKDjw55mdxpqdMoDlQZPh+eW2XT+AHjC+M4E7oMGuHQrHOCf54Hin0dV?=
 =?us-ascii?Q?muV+jhdghZd9MAtOajIrOm29qgoMYCyUu+a+fh80k0DQOmMMzzKtXSAFlrMC?=
 =?us-ascii?Q?j6hkXI+JrMu+MrZmeMk1RlE7Wwc0wBYFwxdBx1lX2zPUqtY4b7AJC1uhdQxe?=
 =?us-ascii?Q?lzXsuihQQ7mzAxK5r5Xg97mc9v6Ou6yw3OAdEzbAkYygcHv909mIl+DTG2yA?=
 =?us-ascii?Q?1Vo+U+4Wwl4JdRA5NhhQlRnAd24Kza6l/ZLvllPnfj8ihhax5vxrjuvd0e6B?=
 =?us-ascii?Q?IdeUKNpa/4HyK1tebjvqOwSPYdchdiaz+bMzixOh9EMM/egPuSIBQq5cVGbY?=
 =?us-ascii?Q?fNyKkEnJohoBbM0uAH4AK613XsHnJ9obDeI9kUcQq+tPQ/isch9ZF9pk1GqR?=
 =?us-ascii?Q?tGQU+Eix89mV3H2szfNlfpQ/4vdOMbo6ZEche7nQpidN4zzYUnjYPcUK84gH?=
 =?us-ascii?Q?iX71e8GmeYTjv70lm5H6JK4xgflzYr9/E/TXsEperJvbFC14rL412kjt68QV?=
 =?us-ascii?Q?ernod86JkcNgLDUzI3Mm8AcSBvkKyHUFniDaSp8et+KpcJ4fpelnJ9bqfgfM?=
 =?us-ascii?Q?zLBU/2ajuwy8fzXfq+qD/0kbjQtIhfVvmfbTelkzAGPD8S4WpbFo6xeQf7WI?=
 =?us-ascii?Q?U+Mu+FCrhg0P2GdniFsW2o03HA/8+UcHI6yBrJuYKSy0uziGFNb1du0Lzjsw?=
 =?us-ascii?Q?XofVAcjp4THjB2W8eyYdx3CdSGGtD+ez0t84+bqvcJrrZRgEPkSO+KxRQqdd?=
 =?us-ascii?Q?8Bx4hiLASyHCMpSIy2No+nb/C9rqAo6LylXMFPq8nvj//anVeZ1LKwT9NQ9t?=
 =?us-ascii?Q?DAcjlxFJ06lq2ZYmF4eBF5GmJq+6GV57KwiZDUKws483QrYmyEnabO2KurUY?=
 =?us-ascii?Q?qut5blo=3D?=
X-OriginatorOrg: oracle.com
X-MS-Exchange-CrossTenant-Network-Message-Id: ac612df1-7e6c-4698-a530-08d9903ac059
X-MS-Exchange-CrossTenant-AuthSource: CO1PR10MB4468.namprd10.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 16 Oct 2021 00:20:26.3709
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 4e2c6054-71cb-48f1-bd6c-3a9705aca71b
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: 3/IisAoGqPJbJwODT3qcsLJIPRV0qwfkQOc2WqFr2ll1PNtzoj/wxU4gGcVHcsj8xWY1ck+V60KNHGYKuZonmw==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: MWHPR10MB1247
X-Proofpoint-Virus-Version: vendor=nai engine=6300 definitions=10138 signatures=668683
X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 mlxlogscore=999 suspectscore=0
 malwarescore=0 bulkscore=0 phishscore=0 adultscore=0 spamscore=0
 mlxscore=0 classifier=spam adjust=0 reason=mlx scancount=1
 engine=8.12.0-2109230001 definitions=main-2110150148
X-Proofpoint-ORIG-GUID: wArvQI32n8f9JiqEl-u3V_vc6f8ssPFC
X-Proofpoint-GUID: wArvQI32n8f9JiqEl-u3V_vc6f8ssPFC
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

Currently show_workqueue_state shows the state of all workqueues and of
all worker pools. In certain cases we may need to dump state of only a
specific workqueue or worker pool. For example in destroy_workqueue we
only need to show state of the workqueue which is getting destroyed.

So rename show_workqueue_state to show_all_workqueues(to signify it
dumps state of all busy workqueues) and divide it into more granular
functions (show_one_workqueue and show_one_worker_pool), that would show
states of individual workqueues and worker pools and can be used in
cases such as the one mentioned above.

Also, as mentioned earlier, make destroy_workqueue dump data pertaining
to only the workqueue that is being destroyed and make user(s) of
earlier interface(show_workqueue_state), use new interface
(show_all_workqueues).

Signed-off-by: Imran Khan <imran.f.khan@oracle.com>
---
Changes in v3:
  - Address review comments regarding function names
  - Change users of show_workqueue_state to use show_all_workqueues

 drivers/tty/sysrq.c       |   2 +-
 include/linux/workqueue.h |   3 +-
 kernel/power/process.c    |   2 +-
 kernel/workqueue.c        | 148 +++++++++++++++++++++-----------------
 4 files changed, 88 insertions(+), 67 deletions(-)

diff --git a/drivers/tty/sysrq.c b/drivers/tty/sysrq.c
index c911196ac893..8d0f07509ca7 100644
--- a/drivers/tty/sysrq.c
+++ b/drivers/tty/sysrq.c
@@ -296,7 +296,7 @@ static const struct sysrq_key_op sysrq_showregs_op = {
 static void sysrq_handle_showstate(int key)
 {
 	show_state();
-	show_workqueue_state();
+	show_all_workqueues();
 }
 static const struct sysrq_key_op sysrq_showstate_op = {
 	.handler	= sysrq_handle_showstate,
diff --git a/include/linux/workqueue.h b/include/linux/workqueue.h
index 2ebef6b1a3d6..c48f86e38d89 100644
--- a/include/linux/workqueue.h
+++ b/include/linux/workqueue.h
@@ -470,7 +470,8 @@ extern bool workqueue_congested(int cpu, struct workqueue_struct *wq);
 extern unsigned int work_busy(struct work_struct *work);
 extern __printf(1, 2) void set_worker_desc(const char *fmt, ...);
 extern void print_worker_info(const char *log_lvl, struct task_struct *task);
-extern void show_workqueue_state(void);
+extern void show_all_workqueues(void);
+extern void show_one_workqueue(struct workqueue_struct *wq);
 extern void wq_worker_comm(char *buf, size_t size, struct task_struct *task);
 
 /**
diff --git a/kernel/power/process.c b/kernel/power/process.c
index 37401c99b7d7..b7e7798637b8 100644
--- a/kernel/power/process.c
+++ b/kernel/power/process.c
@@ -94,7 +94,7 @@ static int try_to_freeze_tasks(bool user_only)
 		       todo - wq_busy, wq_busy);
 
 		if (wq_busy)
-			show_workqueue_state();
+			show_all_workqueues();
 
 		if (!wakeup || pm_debug_messages_on) {
 			read_lock(&tasklist_lock);
diff --git a/kernel/workqueue.c b/kernel/workqueue.c
index 9a042a449002..dbdf14738ca6 100644
--- a/kernel/workqueue.c
+++ b/kernel/workqueue.c
@@ -375,6 +375,7 @@ EXPORT_SYMBOL_GPL(system_freezable_power_efficient_wq);
 static int worker_thread(void *__worker);
 static void workqueue_sysfs_unregister(struct workqueue_struct *wq);
 static void show_pwq(struct pool_workqueue *pwq);
+static void show_one_worker_pool(struct worker_pool *pool);
 
 #define CREATE_TRACE_POINTS
 #include <trace/events/workqueue.h>
@@ -4447,7 +4448,7 @@ void destroy_workqueue(struct workqueue_struct *wq)
 			raw_spin_unlock_irq(&pwq->pool->lock);
 			mutex_unlock(&wq->mutex);
 			mutex_unlock(&wq_pool_mutex);
-			show_workqueue_state();
+			show_one_workqueue(wq);
 			return;
 		}
 		raw_spin_unlock_irq(&pwq->pool->lock);
@@ -4797,83 +4798,102 @@ static void show_pwq(struct pool_workqueue *pwq)
 }
 
 /**
- * show_workqueue_state - dump workqueue state
- *
- * Called from a sysrq handler or try_to_freeze_tasks() and prints out
- * all busy workqueues and pools.
+ * show_one_workqueue - dump state of specified workqueue
+ * @wq: workqueue whose state will be printed
  */
-void show_workqueue_state(void)
+void show_one_workqueue(struct workqueue_struct *wq)
 {
-	struct workqueue_struct *wq;
-	struct worker_pool *pool;
+	struct pool_workqueue *pwq;
+	bool idle = true;
 	unsigned long flags;
-	int pi;
-
-	rcu_read_lock();
-
-	pr_info("Showing busy workqueues and worker pools:\n");
-
-	list_for_each_entry_rcu(wq, &workqueues, list) {
-		struct pool_workqueue *pwq;
-		bool idle = true;
-
-		for_each_pwq(pwq, wq) {
-			if (pwq->nr_active || !list_empty(&pwq->inactive_works)) {
-				idle = false;
-				break;
-			}
-		}
-		if (idle)
-			continue;
-
-		pr_info("workqueue %s: flags=0x%x\n", wq->name, wq->flags);
 
-		for_each_pwq(pwq, wq) {
-			raw_spin_lock_irqsave(&pwq->pool->lock, flags);
-			if (pwq->nr_active || !list_empty(&pwq->inactive_works))
-				show_pwq(pwq);
-			raw_spin_unlock_irqrestore(&pwq->pool->lock, flags);
-			/*
-			 * We could be printing a lot from atomic context, e.g.
-			 * sysrq-t -> show_workqueue_state(). Avoid triggering
-			 * hard lockup.
-			 */
-			touch_nmi_watchdog();
+	for_each_pwq(pwq, wq) {
+		if (pwq->nr_active || !list_empty(&pwq->inactive_works)) {
+			idle = false;
+			break;
 		}
 	}
+	if (idle) /* Nothing to print for idle workqueue */
+		return;
 
-	for_each_pool(pool, pi) {
-		struct worker *worker;
-		bool first = true;
+	pr_info("workqueue %s: flags=0x%x\n", wq->name, wq->flags);
 
-		raw_spin_lock_irqsave(&pool->lock, flags);
-		if (pool->nr_workers == pool->nr_idle)
-			goto next_pool;
-
-		pr_info("pool %d:", pool->id);
-		pr_cont_pool_info(pool);
-		pr_cont(" hung=%us workers=%d",
-			jiffies_to_msecs(jiffies - pool->watchdog_ts) / 1000,
-			pool->nr_workers);
-		if (pool->manager)
-			pr_cont(" manager: %d",
-				task_pid_nr(pool->manager->task));
-		list_for_each_entry(worker, &pool->idle_list, entry) {
-			pr_cont(" %s%d", first ? "idle: " : "",
-				task_pid_nr(worker->task));
-			first = false;
-		}
-		pr_cont("\n");
-	next_pool:
-		raw_spin_unlock_irqrestore(&pool->lock, flags);
+	for_each_pwq(pwq, wq) {
+		raw_spin_lock_irqsave(&pwq->pool->lock, flags);
+		if (pwq->nr_active || !list_empty(&pwq->inactive_works))
+			show_pwq(pwq);
+		raw_spin_unlock_irqrestore(&pwq->pool->lock, flags);
 		/*
 		 * We could be printing a lot from atomic context, e.g.
-		 * sysrq-t -> show_workqueue_state(). Avoid triggering
+		 * sysrq-t -> show_all_workqueues(). Avoid triggering
 		 * hard lockup.
 		 */
 		touch_nmi_watchdog();
 	}
 
+}
+
+/**
+ * show_one_worker_pool - dump state of specified worker pool
+ * @pool: worker pool whose state will be printed
+ */
+static void show_one_worker_pool(struct worker_pool *pool)
+{
+	struct worker *worker;
+	bool first = true;
+	unsigned long flags;
+
+	raw_spin_lock_irqsave(&pool->lock, flags);
+	if (pool->nr_workers == pool->nr_idle)
+		goto next_pool;
+
+	pr_info("pool %d:", pool->id);
+	pr_cont_pool_info(pool);
+	pr_cont(" hung=%us workers=%d",
+		jiffies_to_msecs(jiffies - pool->watchdog_ts) / 1000,
+		pool->nr_workers);
+	if (pool->manager)
+		pr_cont(" manager: %d",
+			task_pid_nr(pool->manager->task));
+	list_for_each_entry(worker, &pool->idle_list, entry) {
+		pr_cont(" %s%d", first ? "idle: " : "",
+			task_pid_nr(worker->task));
+		first = false;
+	}
+	pr_cont("\n");
+next_pool:
+	raw_spin_unlock_irqrestore(&pool->lock, flags);
+	/*
+	 * We could be printing a lot from atomic context, e.g.
+	 * sysrq-t -> show_all_workqueues(). Avoid triggering
+	 * hard lockup.
+	 */
+	touch_nmi_watchdog();
+
+}
+
+/**
+ * show_all_workqueues - dump workqueue state
+ *
+ * Called from a sysrq handler or try_to_freeze_tasks() and prints out
+ * all busy workqueues and pools.
+ */
+void show_all_workqueues(void)
+{
+	struct workqueue_struct *wq;
+	struct worker_pool *pool;
+	int pi;
+
+	rcu_read_lock();
+
+	pr_info("Showing busy workqueues and worker pools:\n");
+
+	list_for_each_entry_rcu(wq, &workqueues, list)
+		show_one_workqueue(wq);
+
+	for_each_pool(pool, pi)
+		show_one_worker_pool(pool);
+
 	rcu_read_unlock();
 }
 
@@ -5855,7 +5875,7 @@ static void wq_watchdog_timer_fn(struct timer_list *unused)
 	rcu_read_unlock();
 
 	if (lockup_detected)
-		show_workqueue_state();
+		show_all_workqueues();
 
 	wq_watchdog_reset_touched();
 	mod_timer(&wq_watchdog_timer, jiffies + thresh);

base-commit: 683f29b781aeaab6bf302eeb2ef08a5e5f9d8a27
-- 
2.30.2