Skip to contentSkip to conversation

staging: r8188eu: use completions and clean rtw_cmd_thread()

PATCH Superseded Fabio M. De Francesco 2 participants 7 messages Oct 17, 2021 – Oct 19, 2021 Staging

v2 of 3 Superseded Latest is v3 →

lore
Share & tools
lore
#0 lore raw

v2 cover staging: r8188eu: use completions and clean rtw_cmd_thread()

This series replaces two semaphores with three completion variables in rtw_cmd_thread(). Completions variables are better suited for the purposes that are explained in detail in the commit messages of patches 1/3 and 2/3. Furthermore, patch 3/3 removes a redundant 'if' statement from that same rtw_cmd_thread().

Tested with ASUSTek Computer, Inc. Realtek 8188EUS [USB-N10 Nano]

Many thanks to Dan Carpenter <[email protected]> who helped with his review of the RFC Patch.

v1 => v2:
Patch 1/3: No changes;
Patch 2/3: Replace wait_for_completion_killable() with
wait_for_completion() because killing the kthread is not allowed and so there is no need for killable wait;
Patch 3/3: No changes.

Fabio M. De Francesco (3):
staging: r8188eu: Use completions for signaling start and end of
kthread
staging: r8188eu: Use completions for signaling enqueueing
staging: r8188eu: Remove redundant 'if' statement

 drivers/staging/r8188eu/core/rtw_cmd.c    | 20 +++++++-------------
 drivers/staging/r8188eu/include/rtw_cmd.h |  5 +++--
 drivers/staging/r8188eu/os_dep/os_intfs.c |  8 +++++---
 3 files changed, 15 insertions(+), 18 deletions(-)
Signature · 1 line
2.33.0
#1 lore raw

PATCH v2 1/3 staging: r8188eu: Use completions for signaling start / end kthread

rtw_cmd_thread() "up(s)" a semaphore twice, first to notify callers when its execution is started and then to notify when it is about to end.

It makes the same semaphore go "up" twice in the same thread. This construct makes Smatch to warn of duplicate "up(s)".

This thread uses interruptible semaphores where instead completions are more suitable. For this purpose it calls an helper (_rtw_down_sema()) that returns values that are never checked. It may lead to bugs.

To address the above-mentioned issues, use two completions variables instead of semaphores. Use the uninterruptible versions of wake_for_completion*() because the interruptible / killable versions are not necessary.

Tested with "ASUSTek Computer, Inc. Realtek 8188EUS [USB-N10 Nano]".

---
 drivers/staging/r8188eu/core/rtw_cmd.c    | 7 ++++---
 drivers/staging/r8188eu/include/rtw_cmd.h | 3 ++-
 drivers/staging/r8188eu/os_dep/os_intfs.c | 6 ++++--
 3 files changed, 10 insertions(+), 6 deletions(-)
drivers/staging/r8188eu/core/rtw_cmd.c +4 -3
index e17332677daa..195390449502 100644
@@ -23,7 +23,8 @@ static int _rtw_init_cmd_priv(struct cmd_priv *pcmdpriv)
 
 	sema_init(&pcmdpriv->cmd_queue_sema, 0);
 	/* sema_init(&(pcmdpriv->cmd_done_sema), 0); */
-	sema_init(&pcmdpriv->terminate_cmdthread_sema, 0);
+	init_completion(&pcmdpriv->start_cmd_thread);
+	init_completion(&pcmdpriv->stop_cmd_thread);
 
 	rtw_init_queue(&pcmdpriv->cmd_queue);
 
@@ -248,7 +249,7 @@ int rtw_cmd_thread(void *context)
 	pcmdbuf = pcmdpriv->cmd_buf;
 
 	pcmdpriv->cmdthd_running = true;
-	up(&pcmdpriv->terminate_cmdthread_sema);
+	complete(&pcmdpriv->start_cmd_thread);
 
 	while (1) {
 		if (_rtw_down_sema(&pcmdpriv->cmd_queue_sema) == _FAIL)
@@ -329,7 +330,7 @@ int rtw_cmd_thread(void *context)
 		rtw_free_cmd_obj(pcmd);
 	} while (1);
 
-	up(&pcmdpriv->terminate_cmdthread_sema);
+	complete(&pcmdpriv->stop_cmd_thread);
 
 	thread_exit();
 }
drivers/staging/r8188eu/include/rtw_cmd.h +2 -1
index 83fbb922db2c..b6266e3e2c40 100644
@@ -34,7 +34,8 @@ struct cmd_obj {
 
 struct cmd_priv {
 	struct semaphore cmd_queue_sema;
-	struct semaphore terminate_cmdthread_sema;
+	struct completion start_cmd_thread;
+	struct completion stop_cmd_thread;
 	struct __queue cmd_queue;
 	u8	cmd_seq;
 	u8	*cmd_buf;	/* shall be non-paged, and 4 bytes aligned */
drivers/staging/r8188eu/os_dep/os_intfs.c +4 -2
index e7964a048c99..0bcea66f550b 100644
@@ -385,7 +385,8 @@ u32 rtw_start_drv_threads(struct adapter *padapter)
 	if (IS_ERR(padapter->cmdThread))
 		_status = _FAIL;
 	else
-		_rtw_down_sema(&padapter->cmdpriv.terminate_cmdthread_sema); /* wait for cmd_thread to run */
+		/* wait for rtw_cmd_thread() to start running */
+		wait_for_completion(&padapter->cmdpriv.start_cmd_thread);
 
 	return _status;
 }
@@ -395,7 +396,8 @@ void rtw_stop_drv_threads(struct adapter *padapter)
 	/* Below is to termindate rtw_cmd_thread & event_thread... */
 	up(&padapter->cmdpriv.cmd_queue_sema);
 	if (padapter->cmdThread)
-		_rtw_down_sema(&padapter->cmdpriv.terminate_cmdthread_sema);
+		/* wait for rtw_cmd_thread() to stop running */
+		wait_for_completion(&padapter->cmdpriv.stop_cmd_thread);
 }
 
 static u8 rtw_init_default_value(struct adapter *padapter)
Signature · 1 line
2.33.0
#2 lore raw

PATCH v2 2/3 staging: r8188eu: Use completions for signaling enqueueing

In reply to Fabio M. De Francesco

rtw_enqueue_cmd() uses a semaphore to notify rtw_cmd_thread() that it has enqueued commands. rtw_cmd_thread() "down(s)" in interruptible mode to wait to be notified.

Use completion variables because they are better suited for the purpose.

In rtw_cmd_thread(), wait in uninterruptible mode, even if the original code uses down_interruptible(), because the interruption of rtw_cmd_thread() is not allowed and unwanted.

---
 drivers/staging/r8188eu/core/rtw_cmd.c    | 7 +++----
 drivers/staging/r8188eu/include/rtw_cmd.h | 2 +-
 drivers/staging/r8188eu/os_dep/os_intfs.c | 2 +-
 3 files changed, 5 insertions(+), 6 deletions(-)
drivers/staging/r8188eu/core/rtw_cmd.c +3 -4
index 195390449502..6fb79d711692 100644
@@ -21,7 +21,7 @@ static int _rtw_init_cmd_priv(struct cmd_priv *pcmdpriv)
 {
 	int res = _SUCCESS;
 
-	sema_init(&pcmdpriv->cmd_queue_sema, 0);
+	init_completion(&pcmdpriv->enqueue_cmd);
 	/* sema_init(&(pcmdpriv->cmd_done_sema), 0); */
 	init_completion(&pcmdpriv->start_cmd_thread);
 	init_completion(&pcmdpriv->stop_cmd_thread);
@@ -198,7 +198,7 @@ u32 rtw_enqueue_cmd(struct cmd_priv *pcmdpriv, struct cmd_obj *cmd_obj)
 	res = _rtw_enqueue_cmd(&pcmdpriv->cmd_queue, cmd_obj);
 
 	if (res == _SUCCESS)
-		up(&pcmdpriv->cmd_queue_sema);
+		complete(&pcmdpriv->enqueue_cmd);
 
 exit:
 
@@ -252,8 +252,7 @@ int rtw_cmd_thread(void *context)
 	complete(&pcmdpriv->start_cmd_thread);
 
 	while (1) {
-		if (_rtw_down_sema(&pcmdpriv->cmd_queue_sema) == _FAIL)
-			break;
+		wait_for_completion(&pcmdpriv->enqueue_cmd);
 
 		if (padapter->bDriverStopped ||
 		    padapter->bSurpriseRemoved) {
drivers/staging/r8188eu/include/rtw_cmd.h +1 -1
index b6266e3e2c40..47c3c80cc24a 100644
@@ -33,7 +33,7 @@ struct cmd_obj {
 };
 
 struct cmd_priv {
-	struct semaphore cmd_queue_sema;
+	struct completion enqueue_cmd;
 	struct completion start_cmd_thread;
 	struct completion stop_cmd_thread;
 	struct __queue cmd_queue;
drivers/staging/r8188eu/os_dep/os_intfs.c +1 -1
index 0bcea66f550b..96e9897085fe 100644
@@ -394,7 +394,7 @@ u32 rtw_start_drv_threads(struct adapter *padapter)
 void rtw_stop_drv_threads(struct adapter *padapter)
 {
 	/* Below is to termindate rtw_cmd_thread & event_thread... */
-	up(&padapter->cmdpriv.cmd_queue_sema);
+	complete(&padapter->cmdpriv.enqueue_cmd);
 	if (padapter->cmdThread)
 		/* wait for rtw_cmd_thread() to stop running */
 		wait_for_completion(&padapter->cmdpriv.stop_cmd_thread);
Signature · 1 line
2.33.0
#3 lore raw

PATCH v2 3/3 staging: r8188eu: Remove redundant 'if' statement

In reply to Fabio M. De Francesco

Remove a redundant 'if' statement.

---
 drivers/staging/r8188eu/core/rtw_cmd.c | 6 ------
 1 file changed, 6 deletions(-)
drivers/staging/r8188eu/core/rtw_cmd.c +0 -6
index 6fb79d711692..42084b029473 100644
@@ -254,12 +254,6 @@ int rtw_cmd_thread(void *context)
 	while (1) {
 		wait_for_completion(&pcmdpriv->enqueue_cmd);
 
-		if (padapter->bDriverStopped ||
-		    padapter->bSurpriseRemoved) {
-			DBG_88E("%s: DriverStopped(%d) SurpriseRemoved(%d) break at line %d\n",
-				__func__, padapter->bDriverStopped, padapter->bSurpriseRemoved, __LINE__);
-			break;
-		}
 _next:
 		if (padapter->bDriverStopped ||
 		    padapter->bSurpriseRemoved) {
Signature · 1 line
2.33.0
#4 lore raw

Re: [PATCH 3/3] staging: r8188eu: Remove redundant 'if' statement

Quoted 8 lines · Fabio M. De Francesco

Remove a redundant 'if' statement.

---
 drivers/staging/r8188eu/core/rtw_cmd.c | 6 ------
 1 file changed, 6 deletions(-)

Why is there not a "v2" in the subject line like the other patches in this series?

Quoted 6 lines
drivers/staging/r8188eu/core/rtw_cmd.c +0 -0
index 6fb79d711692..42084b029473 100644

drivers/staging/r8188eu/core/rtw_cmd.c int rtw_cmd_thread(void *context) · line 262

Quoted 9 lines
drivers/staging/r8188eu/core/rtw_cmd.c +0 -6
@@ -254,12 +254,6 @@ int rtw_cmd_thread(void *context)
 	while (1) {
 		wait_for_completion(&pcmdpriv->enqueue_cmd);
 
-		if (padapter->bDriverStopped ||
-		    padapter->bSurpriseRemoved) {
-			DBG_88E("%s: DriverStopped(%d) SurpriseRemoved(%d) break at line %d\n",
-				__func__, padapter->bDriverStopped, padapter->bSurpriseRemoved, __LINE__);
-			break;
-		}

Why is this redundant?

It is not obvious from the diff what is going on so you should say a bit more in the changelog text please.

thanks,

greg k-h

#5 lore raw

Re: [PATCH 3/3] staging: r8188eu: Remove redundant 'if' statement

Quoted 10 lines · CEST Greg Kroah-Hartman
Quoted 8 lines · Fabio M. De Francesco

Remove a redundant 'if' statement.

---
 drivers/staging/r8188eu/core/rtw_cmd.c | 6 ------
 1 file changed, 6 deletions(-)
Quoted 2 lines

Why is there not a "v2" in the subject line like the other patches in this series?

Simply because I edited manually the "Subject" and overlooked to write "v2".

Quoted 3 lines

drivers/staging/

Quoted 3 lines
drivers/staging/ renamed from drivers/staging/r8188eu/core/rtw_cmd.c +0 -0

r8188eu/core/rtw_cmd.c

Quoted 10 lines

drivers/staging/r8188eu/core/rtw_cmd.c int rtw_cmd_thread(void *context) · line 259

Quoted 10 lines

index 6fb79d711692..42084b029473 100644

drivers/staging/r8188eu/core/rtw_cmd.c +0 -3
@@ -254,12 +254,6 @@ int rtw_cmd_thread(void *context)
 	while (1) {
 		wait_for_completion(&pcmdpriv->enqueue_cmd);
 
-		if (padapter->bDriverStopped ||
-		    padapter->bSurpriseRemoved) {
-			DBG_88E("%s: DriverStopped(%d) 

SurpriseRemoved(%d) break at line %d\n",

Quoted 10 lines

drivers/staging/r8188eu/core/rtw_cmd.c int rtw_cmd_thread(void *context) · line 260

Quoted 1 line
drivers/staging/r8188eu/core/rtw_cmd.c +0 -1
-				__func__, padapter-

bDriverStopped, padapter->bSurpriseRemoved, __LINE__);

drivers/staging/r8188eu/core/rtw_cmd.c int rtw_cmd_thread(void *context) · line 262

Quoted 2 lines
drivers/staging/r8188eu/core/rtw_cmd.c +0 -2
-			break;
-		}

Why is this redundant?

It is not obvious from the diff what is going on so you should say a bit more in the changelog text please.

Yes you are right. I wrongly thought that is was "obvious", but re-reading my own text I noticed that it is not.

In 1/3 and 2/3 I was particularly careful in writing changelogs. Instead in 3/3 I forgot that commit messages _must_ explain "what" and "why" :(

I've just sent version 3 of the series.

Thanks for reviewing my work,

Fabio

Quoted 5 lines

thanks,

greg k-h

#6 lore raw

Re: [PATCH 3/3] staging: r8188eu: Remove redundant 'if' statement

Quoted 11 lines · Fabio M. De Francesco
Quoted 10 lines · CEST Greg Kroah-Hartman
Quoted 8 lines · Fabio M. De Francesco

Remove a redundant 'if' statement.

---
 drivers/staging/r8188eu/core/rtw_cmd.c | 6 ------
 1 file changed, 6 deletions(-)
Quoted 4 lines
Quoted 2 lines

Why is there not a "v2" in the subject line like the other patches in this series?

Simply because I edited manually the "Subject" and overlooked to write "v2".

'git format-patchj -v 2' is your friend.