lists.openwall.net   lists  /  announce  owl-users  owl-dev  john-users  john-dev  passwdqc-users  yescrypt  popa3d-users  /  oss-security  kernel-hardening  musl  sabotage  tlsify  passwords  /  crypt-dev  xvendor  /  Bugtraq  Full-Disclosure  linux-kernel  linux-netdev  linux-ext4  linux-hardening  linux-cve-announce  PHC 
Open Source and information security mailing list archives
 
Hash Suite: Windows password security audit tool. GUI, reports in PDF.
[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]
Message-Id: <20250725-ufshcd-hardirq-v2-2-884c11e0b0df@linaro.org>
Date: Fri, 25 Jul 2025 15:16:16 +0100
From: André Draszik <andre.draszik@...aro.org>
To: Alim Akhtar <alim.akhtar@...sung.com>, 
 Avri Altman <avri.altman@....com>, Bart Van Assche <bvanassche@....org>, 
 "James E.J. Bottomley" <James.Bottomley@...senPartnership.com>, 
 "Martin K. Petersen" <martin.petersen@...cle.com>, 
 Neil Armstrong <neil.armstrong@...aro.org>
Cc: Peter Griffin <peter.griffin@...aro.org>, 
 Tudor Ambarus <tudor.ambarus@...aro.org>, 
 Will McVicker <willmcvicker@...gle.com>, 
 Manivannan Sadhasivam <mani@...nel.org>, kernel-team@...roid.com, 
 linux-arm-msm@...r.kernel.org, linux-samsung-soc@...r.kernel.org, 
 linux-scsi@...r.kernel.org, linux-kernel@...r.kernel.org, 
 André Draszik <andre.draszik@...aro.org>, 
 stable@...r.kernel.org
Subject: [PATCH v2 2/2] scsi: ufs: core: move some irq handling back to
 hardirq (with time limit)

Commit 3c7ac40d7322 ("scsi: ufs: core: Delegate the interrupt service
routine to a threaded IRQ handler") introduced a massive performance
drop for various work loads on UFSHC versions < 4 due to the extra
latency introduced by moving all of the IRQ handling into a threaded
handler. See below for a summary.

To resolve this performance drop, move IRQ handling back into hardirq
context, but apply a time limit which, once expired, will cause the
remainder of the work to be deferred to the threaded handler.

Above commit is trying to avoid unduly delay of other subsystem
interrupts while the UFS events are being handled. By limiting the
amount of time spent in hardirq context, we can still ensure that.

The time limit itself was chosen because I have generally seen
interrupt handling to have been completed within 20 usecs, with the
occasional spikes of a couple 100 usecs.

This commits brings UFS performance roughly back to original
performance, and should still avoid other subsystem's starvation thanks
to dealing with these spikes.

fio results for 4k block size on Pixel 6, all values being the average
of 5 runs each:
  read / 1 job      original      after  this commit
    min IOPS        4,653.60   2,704.40     3,902.80
    max IOPS        6,151.80   4,847.60     6,103.40
    avg IOPS        5,488.82   4,226.61     5,314.89
    cpu % usr           1.85       1.72         1.97
    cpu % sys          32.46      28.88        33.29
    bw MB/s            21.46      16.50        20.76

  read / 8 jobs     original      after  this commit
    min IOPS       18,207.80  11,323.00    17,911.80
    max IOPS       25,535.80  14,477.40    24,373.60
    avg IOPS       22,529.93  13,325.59    21,868.85
    cpu % usr           1.70       1.41         1.67
    cpu % sys          27.89      21.85        27.23
    bw MB/s            88.10      52.10        84.48

  write / 1 job     original      after  this commit
    min IOPS        6,524.20   3,136.00     5,988.40
    max IOPS        7,303.60   5,144.40     7,232.40
    avg IOPS        7,169.80   4,608.29     7,014.66
    cpu % usr           2.29       2.34         2.23
    cpu % sys          41.91      39.34        42.48
    bw MB/s            28.02      18.00        27.42

  write / 8 jobs    original      after  this commit
    min IOPS       12,685.40  13,783.00    12,622.40
    max IOPS       30,814.20  22,122.00    29,636.00
    avg IOPS       21,539.04  18,552.63    21,134.65
    cpu % usr           2.08       1.61         2.07
    cpu % sys          30.86      23.88        30.64
    bw MB/s            84.18      72.54        82.62

Closes: https://lore.kernel.org/all/1e06161bf49a3a88c4ea2e7a406815be56114c4f.camel@linaro.org
Fixes: 3c7ac40d7322 ("scsi: ufs: core: Delegate the interrupt service routine to a threaded IRQ handler")
Cc: stable@...r.kernel.org
Signed-off-by: André Draszik <andre.draszik@...aro.org>

---
v2:
* update some inline & kerneldoc comments
* mention 4k block size and 5 runs were used in fio runs
* add missing jiffies.h include
---
 drivers/ufs/core/ufshcd.c | 191 +++++++++++++++++++++++++++++++++++++---------
 1 file changed, 154 insertions(+), 37 deletions(-)

diff --git a/drivers/ufs/core/ufshcd.c b/drivers/ufs/core/ufshcd.c
index d8e2eabacd3efbf07458e81cc4d15ba7f05d3913..404a4e075a21e73d22ae6bb89f77f69aebb7cd6a 100644
--- a/drivers/ufs/core/ufshcd.c
+++ b/drivers/ufs/core/ufshcd.c
@@ -19,6 +19,7 @@
 #include <linux/clk.h>
 #include <linux/delay.h>
 #include <linux/interrupt.h>
+#include <linux/jiffies.h>
 #include <linux/module.h>
 #include <linux/pm_opp.h>
 #include <linux/regulator/consumer.h>
@@ -111,6 +112,9 @@ enum {
 /* bMaxNumOfRTT is equal to two after device manufacturing */
 #define DEFAULT_MAX_NUM_RTT 2
 
+/* Time limit in usecs for hardirq context */
+#define HARDIRQ_TIMELIMIT 20
+
 /* UFSHC 4.0 compliant HC support this mode. */
 static bool use_mcq_mode = true;
 
@@ -5603,26 +5607,56 @@ void ufshcd_compl_one_cqe(struct ufs_hba *hba, int task_tag,
  * __ufshcd_transfer_req_compl - handle SCSI and query command completion
  * @hba: per adapter instance
  * @completed_reqs: bitmask that indicates which requests to complete
+ * @time_limit: time limit in jiffies to not exceed executing command completion
+ *
+ * This completes the individual requests as per @completed_reqs with an
+ * optional time limit. If a time limit is given and it expired before all
+ * requests were handled, the return value will indicate which requests have not
+ * been handled.
+ *
+ * Return: Bitmask that indicates which requests have not been completed due to
+ * time limit expiry.
  */
-static void __ufshcd_transfer_req_compl(struct ufs_hba *hba,
-					unsigned long completed_reqs)
+static unsigned long __ufshcd_transfer_req_compl(struct ufs_hba *hba,
+						 unsigned long completed_reqs,
+						 unsigned long time_limit)
 {
 	int tag;
 
-	for_each_set_bit(tag, &completed_reqs, hba->nutrs)
+	for_each_set_bit(tag, &completed_reqs, hba->nutrs) {
 		ufshcd_compl_one_cqe(hba, tag, NULL);
+		__clear_bit(tag, &completed_reqs);
+		if (time_limit && time_after_eq(jiffies, time_limit))
+			break;
+	}
+
+	/* any bits still set represent unhandled requests due to timeout */
+	return completed_reqs;
 }
 
-/*
- * Return: > 0 if one or more commands have been completed or 0 if no
- * requests have been completed.
+/**
+ * ufshcd_poll_impl - handle SCSI and query command completion helper
+ * @shost: Scsi_Host instance
+ * @queue_num: The h/w queue number, or UFSHCD_POLL_FROM_INTERRUPT_CONTEXT when
+ *             invoked from the interrupt handler
+ * @time_limit: time limit in jiffies to not exceed executing command completion
+ * @__pending: Pointer to store any still pending requests in case of time limit
+ *             expiry
+ *
+ * This handles completed commands with an optional time limit. If a time limit
+ * is given and it expires, @__pending will be set to the requests that could
+ * not be completed in time and are still pending.
+ *
+ * Return: true if one or more commands have been completed, false otherwise.
  */
-static int ufshcd_poll(struct Scsi_Host *shost, unsigned int queue_num)
+static int ufshcd_poll_impl(struct Scsi_Host *shost, unsigned int queue_num,
+			    unsigned long time_limit, unsigned long *__pending)
 {
 	struct ufs_hba *hba = shost_priv(shost);
 	unsigned long completed_reqs, flags;
 	u32 tr_doorbell;
 	struct ufs_hw_queue *hwq;
+	unsigned long pending = 0;
 
 	if (hba->mcq_enabled) {
 		hwq = &hba->uhq[queue_num];
@@ -5636,15 +5670,34 @@ static int ufshcd_poll(struct Scsi_Host *shost, unsigned int queue_num)
 	WARN_ONCE(completed_reqs & ~hba->outstanding_reqs,
 		  "completed: %#lx; outstanding: %#lx\n", completed_reqs,
 		  hba->outstanding_reqs);
-	hba->outstanding_reqs &= ~completed_reqs;
+
+	if (completed_reqs) {
+		pending = __ufshcd_transfer_req_compl(hba, completed_reqs,
+						      time_limit);
+		completed_reqs &= ~pending;
+		hba->outstanding_reqs &= ~completed_reqs;
+	}
+
 	spin_unlock_irqrestore(&hba->outstanding_lock, flags);
 
-	if (completed_reqs)
-		__ufshcd_transfer_req_compl(hba, completed_reqs);
+	if (__pending)
+		*__pending = pending;
 
 	return completed_reqs != 0;
 }
 
+/*
+ * ufshcd_poll - SCSI interface of blk_poll to poll for IO completions
+ * @shost: Scsi_Host instance
+ * @queue_num: The h/w queue number
+ *
+ * Return: true if one or more commands have been completed, false otherwise.
+ */
+static int ufshcd_poll(struct Scsi_Host *shost, unsigned int queue_num)
+{
+	return ufshcd_poll_impl(shost, queue_num, 0, NULL);
+}
+
 /**
  * ufshcd_mcq_compl_pending_transfer - MCQ mode function. It is
  * invoked from the error handler context or ufshcd_host_reset_and_restore()
@@ -5698,13 +5751,19 @@ static void ufshcd_mcq_compl_pending_transfer(struct ufs_hba *hba,
 /**
  * ufshcd_transfer_req_compl - handle SCSI and query command completion
  * @hba: per adapter instance
+ * @time_limit: time limit in jiffies to not exceed executing command completion
  *
  * Return:
- *  IRQ_HANDLED - If interrupt is valid
- *  IRQ_NONE    - If invalid interrupt
+ *  IRQ_HANDLED     - If interrupt is valid
+ *  IRQ_WAKE_THREAD - If further interrupt processing should be delegated to the
+ *                    thread
+ *  IRQ_NONE        - If invalid interrupt
  */
-static irqreturn_t ufshcd_transfer_req_compl(struct ufs_hba *hba)
+static irqreturn_t ufshcd_transfer_req_compl(struct ufs_hba *hba,
+					     unsigned long time_limit)
 {
+	unsigned long pending;
+
 	/* Resetting interrupt aggregation counters first and reading the
 	 * DOOR_BELL afterward allows us to handle all the completed requests.
 	 * In order to prevent other interrupts starvation the DB is read once
@@ -5720,12 +5779,18 @@ static irqreturn_t ufshcd_transfer_req_compl(struct ufs_hba *hba)
 		return IRQ_HANDLED;
 
 	/*
-	 * Ignore the ufshcd_poll() return value and return IRQ_HANDLED since we
-	 * do not want polling to trigger spurious interrupt complaints.
+	 * Ignore the ufshcd_poll() return value and return IRQ_HANDLED or
+	 * IRQ_WAKE_THREAD since we do not want polling to trigger spurious
+	 * interrupt complaints.
 	 */
-	ufshcd_poll(hba->host, 0);
+	ufshcd_poll_impl(hba->host, 0, time_limit, &pending);
 
-	return IRQ_HANDLED;
+	/*
+	 * If a time limit was set, some request completions might not have been
+	 * handled yet and will need to be dealt with in the threaded interrupt
+	 * handler.
+	 */
+	return pending ? IRQ_WAKE_THREAD : IRQ_HANDLED;
 }
 
 int __ufshcd_write_ee_control(struct ufs_hba *hba, u32 ee_ctrl_mask)
@@ -6286,7 +6351,7 @@ static void ufshcd_complete_requests(struct ufs_hba *hba, bool force_compl)
 	if (hba->mcq_enabled)
 		ufshcd_mcq_compl_pending_transfer(hba, force_compl);
 	else
-		ufshcd_transfer_req_compl(hba);
+		ufshcd_transfer_req_compl(hba, 0);
 
 	ufshcd_tmc_handler(hba);
 }
@@ -6988,12 +7053,16 @@ static irqreturn_t ufshcd_handle_mcq_cq_events(struct ufs_hba *hba)
  * ufshcd_sl_intr - Interrupt service routine
  * @hba: per adapter instance
  * @intr_status: contains interrupts generated by the controller
+ * @time_limit: time limit in jiffies to not exceed executing command completion
  *
  * Return:
- *  IRQ_HANDLED - If interrupt is valid
- *  IRQ_NONE    - If invalid interrupt
+ *  IRQ_HANDLED     - If interrupt is valid
+ *  IRQ_WAKE_THREAD - If further interrupt processing should be delegated to the
+ *                    thread
+ *  IRQ_NONE        - If invalid interrupt
  */
-static irqreturn_t ufshcd_sl_intr(struct ufs_hba *hba, u32 intr_status)
+static irqreturn_t ufshcd_sl_intr(struct ufs_hba *hba, u32 intr_status,
+				  unsigned long time_limit)
 {
 	irqreturn_t retval = IRQ_NONE;
 
@@ -7007,7 +7076,7 @@ static irqreturn_t ufshcd_sl_intr(struct ufs_hba *hba, u32 intr_status)
 		retval |= ufshcd_tmc_handler(hba);
 
 	if (intr_status & UTP_TRANSFER_REQ_COMPL)
-		retval |= ufshcd_transfer_req_compl(hba);
+		retval |= ufshcd_transfer_req_compl(hba, time_limit);
 
 	if (intr_status & MCQ_CQ_EVENT_STATUS)
 		retval |= ufshcd_handle_mcq_cq_events(hba);
@@ -7016,15 +7085,25 @@ static irqreturn_t ufshcd_sl_intr(struct ufs_hba *hba, u32 intr_status)
 }
 
 /**
- * ufshcd_threaded_intr - Threaded interrupt service routine
+ * ufshcd_intr_helper - hardirq and threaded interrupt service routine
  * @irq: irq number
  * @__hba: pointer to adapter instance
+ * @time_limit: time limit in jiffies to not exceed during execution
+ *
+ * Interrupts are initially served from hardirq context with a time limit, but
+ * if there is more work to be done than can be completed before the limit
+ * expires, remaining work is delegated to the IRQ thread. This helper does the
+ * bulk of the work in either case - if @time_limit is set, it is being run from
+ * hardirq context, otherwise from the threaded interrupt handler.
  *
  * Return:
- *  IRQ_HANDLED - If interrupt is valid
- *  IRQ_NONE    - If invalid interrupt
+ *  IRQ_HANDLED     - If interrupt was fully handled
+ *  IRQ_WAKE_THREAD - If further interrupt processing should be delegated to the
+ *                    thread
+ *  IRQ_NONE        - If invalid interrupt
  */
-static irqreturn_t ufshcd_threaded_intr(int irq, void *__hba)
+static irqreturn_t ufshcd_intr_helper(int irq, void *__hba,
+				      unsigned long time_limit)
 {
 	u32 last_intr_status, intr_status, enabled_intr_status = 0;
 	irqreturn_t retval = IRQ_NONE;
@@ -7038,15 +7117,22 @@ static irqreturn_t ufshcd_threaded_intr(int irq, void *__hba)
 	 * if the reqs get finished 1 by 1 after the interrupt status is
 	 * read, make sure we handle them by checking the interrupt status
 	 * again in a loop until we process all of the reqs before returning.
+	 * This is done until the time limit is exceeded, at which point further
+	 * processing is delegated to the threaded handler.
 	 */
-	while (intr_status && retries--) {
+	while (intr_status && !(retval & IRQ_WAKE_THREAD) && retries--) {
 		enabled_intr_status =
 			intr_status & ufshcd_readl(hba, REG_INTERRUPT_ENABLE);
 		ufshcd_writel(hba, intr_status, REG_INTERRUPT_STATUS);
 		if (enabled_intr_status)
-			retval |= ufshcd_sl_intr(hba, enabled_intr_status);
+			retval |= ufshcd_sl_intr(hba, enabled_intr_status,
+						 time_limit);
 
 		intr_status = ufshcd_readl(hba, REG_INTERRUPT_STATUS);
+
+		if (intr_status && time_limit && time_after_eq(jiffies,
+							       time_limit))
+			retval |= IRQ_WAKE_THREAD;
 	}
 
 	if (enabled_intr_status && retval == IRQ_NONE &&
@@ -7063,6 +7149,20 @@ static irqreturn_t ufshcd_threaded_intr(int irq, void *__hba)
 	return retval;
 }
 
+/**
+ * ufshcd_threaded_intr - Threaded interrupt service routine
+ * @irq: irq number
+ * @__hba: pointer to adapter instance
+ *
+ * Return:
+ *  IRQ_HANDLED - If interrupt was fully handled
+ *  IRQ_NONE    - If invalid interrupt
+ */
+static irqreturn_t ufshcd_threaded_intr(int irq, void *__hba)
+{
+	return ufshcd_intr_helper(irq, __hba, 0);
+}
+
 /**
  * ufshcd_intr - Main interrupt service routine
  * @irq: irq number
@@ -7070,20 +7170,37 @@ static irqreturn_t ufshcd_threaded_intr(int irq, void *__hba)
  *
  * Return:
  *  IRQ_HANDLED     - If interrupt is valid
- *  IRQ_WAKE_THREAD - If handling is moved to threaded handled
+ *  IRQ_WAKE_THREAD - If handling is moved to threaded handler
  *  IRQ_NONE        - If invalid interrupt
  */
 static irqreturn_t ufshcd_intr(int irq, void *__hba)
 {
 	struct ufs_hba *hba = __hba;
+	unsigned long time_limit = jiffies +
+		usecs_to_jiffies(HARDIRQ_TIMELIMIT);
 
-	/* Move interrupt handling to thread when MCQ & ESI are not enabled */
-	if (!hba->mcq_enabled || !hba->mcq_esi_enabled)
-		return IRQ_WAKE_THREAD;
+	/*
+	 * Directly handle interrupts when MCQ & ESI are enabled since MCQ
+	 * ESI handlers do the hard job.
+	 */
+	if (hba->mcq_enabled && hba->mcq_esi_enabled)
+		return ufshcd_sl_intr(hba,
+				      ufshcd_readl(hba, REG_INTERRUPT_STATUS) &
+				      ufshcd_readl(hba, REG_INTERRUPT_ENABLE),
+				      0);
 
-	/* Directly handle interrupts since MCQ ESI handlers does the hard job */
-	return ufshcd_sl_intr(hba, ufshcd_readl(hba, REG_INTERRUPT_STATUS) &
-				   ufshcd_readl(hba, REG_INTERRUPT_ENABLE));
+	/*
+	 * Otherwise handle interrupt in hardirq context until the time limit
+	 * expires, at which point the remaining work will be completed in
+	 * interrupt thread context.
+	 */
+	if (!time_limit)
+		/*
+		 * To deal with jiffies wrapping, we just add one so that other
+		 * code can reliably detect if a time limit was requested.
+		 */
+		time_limit++;
+	return ufshcd_intr_helper(irq, __hba, time_limit);
 }
 
 static int ufshcd_clear_tm_cmd(struct ufs_hba *hba, int tag)
@@ -7516,7 +7633,7 @@ static int ufshcd_eh_device_reset_handler(struct scsi_cmnd *cmd)
 				__func__, pos);
 		}
 	}
-	__ufshcd_transfer_req_compl(hba, pending_reqs & ~not_cleared_mask);
+	__ufshcd_transfer_req_compl(hba, pending_reqs & ~not_cleared_mask, 0);
 
 out:
 	hba->req_abort_count = 0;
@@ -7672,7 +7789,7 @@ static int ufshcd_abort(struct scsi_cmnd *cmd)
 		dev_err(hba->dev,
 		"%s: cmd was completed, but without a notifying intr, tag = %d",
 		__func__, tag);
-		__ufshcd_transfer_req_compl(hba, 1UL << tag);
+		__ufshcd_transfer_req_compl(hba, 1UL << tag, 0);
 		goto release;
 	}
 

-- 
2.50.1.487.gc89ff58d15-goog


Powered by blists - more mailing lists

Powered by Openwall GNU/*/Linux Powered by OpenVZ