Skip to contentSkip to conversation

PCI/switchtec: Fix init_completion race condition with poll_wait()

PATCH Applied Logan Gunthorpe 3 participants 5 messages Mar 13, 2020 – Mar 21, 2020

Subsystems (2)
lore
Share & tools
lore

Logan Gunthorpe

author maintainer
#0 lore raw

PATCH 1/1 PCI/switchtec: Fix init_completion race condition with poll_wait()

The call to init_completion() in mrpc_queue_cmd() can theoretically race with the call to poll_wait() in switchtec_dev_poll().

poll() write()

    switchtec_dev_poll()   	  switchtec_dev_write()
      poll_wait(&s->comp.wait);      mrpc_queue_cmd()
			               init_completion(&s->comp)
				         init_waitqueue_head(&s->comp.wait)

To my knowledge, no one has hit this bug, but we should fix it for correctness.

Fix this by using reinit_completion() instead of init_completion() in mrpc_queue_cmd().

Fixes 080b47def5e5 ("MicroSemi Switchtec management interface driver")
---
 drivers/pci/switch/switchtec.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/pci/switch/switchtec.c +1 -1
index a823b4b8ef8a..81dc7ac01381 100644
@@ -175,7 +175,7 @@ static int mrpc_queue_cmd(struct switchtec_user *stuser)
 	kref_get(&stuser->kref);
 	stuser->read_len = sizeof(stuser->data);
 	stuser_set_state(stuser, MRPC_QUEUED);
-	init_completion(&stuser->comp);
+	reinit_completion(&stuser->comp);
 	list_add_tail(&stuser->list, &stdev->mrpc_queue);
 
 	mrpc_cmd_submit(stdev);
Signature · 1 line
2.20.1
Acked-by on v1 1/1
#1 lore raw

Logan,

Quoted 8 lines · Logan Gunthorpe

The call to init_completion() in mrpc_queue_cmd() can theoretically race with the call to poll_wait() in switchtec_dev_poll().

poll() write()

    switchtec_dev_poll()   	  switchtec_dev_write()
      poll_wait(&s->comp.wait);      mrpc_queue_cmd()
			               init_completion(&s->comp)
				         init_waitqueue_head(&s->comp.wait)

just a nitpick. As you took the liberty to copy the description of the race, which was btw. disovered by me, verbatim from a changelog written by someone else w/o providing the courtesy of linking to that original analysis, allow me the liberty to add the missing link:

Quoted 2 lines

To my knowledge, no one has hit this bug, but we should fix it for correctness.

s/,but we should fix/.Fix/ ?

Quoted 6 lines

Fix this by using reinit_completion() instead of init_completion() in mrpc_queue_cmd().

Fixes 080b47def5e5 ("MicroSemi Switchtec management interface driver")

@Bjorn: Can you please hold off on this for a few days until we sorted
out the remaining issues to avoid potential merge conflicts vs. the completion series?

Thanks,

tglx

author maintainer
#2 lore raw
Quoted 13 lines · Thomas Gleixner

Logan,

Quoted 8 lines · Logan Gunthorpe

The call to init_completion() in mrpc_queue_cmd() can theoretically race with the call to poll_wait() in switchtec_dev_poll().

poll() write()

    switchtec_dev_poll()   	  switchtec_dev_write()
      poll_wait(&s->comp.wait);      mrpc_queue_cmd()
			               init_completion(&s->comp)
				         init_waitqueue_head(&s->comp.wait)
Quoted 6 lines

just a nitpick. As you took the liberty to copy the description of the race, which was btw. disovered by me, verbatim from a changelog written by someone else w/o providing the courtesy of linking to that original analysis, allow me the liberty to add the missing link:

Well, I just copied the call chain. I had no way to know you were the one who discovered the bug given the way it was presented to me. And the original patch didn't include much in the way of analysis of the bug, just "It's Racy".

I didn't deliberately omit the link, it just never occurred to me to add it. In retrospect, I should have included it, sorry about that.

Quoted 4 lines
Quoted 2 lines

To my knowledge, no one has hit this bug, but we should fix it for correctness.

s/,but we should fix/.Fix/ ?

Yes, that's an improvement.

Quoted 8 lines
Quoted 6 lines

Fix this by using reinit_completion() instead of init_completion() in mrpc_queue_cmd().

Fixes 080b47def5e5 ("MicroSemi Switchtec management interface driver")

Thanks.

Quoted 3 lines

@Bjorn: Can you please hold off on this for a few days until we sorted
out the remaining issues to avoid potential merge conflicts vs. the completion series?

I'd suggest simply rebasing the completion patch on this patch, or a patch like it. Then we'll have the proper bug fix commit and there won't be a conflict.

Logan

#3 lore raw
Quoted 8 lines · Logan Gunthorpe
Quoted 3 lines · Thomas Gleixner

@Bjorn: Can you please hold off on this for a few days until we sorted
out the remaining issues to avoid potential merge conflicts vs. the completion series?

I'd suggest simply rebasing the completion patch on this patch, or a patch like it. Then we'll have the proper bug fix commit and there won't be a conflict.

The conflict is not a question of rebasing or not. The conflict arises when this patch is routed through PCI simply because then the rest of the completion work is stuck until this hits mainline.

Thanks,

tglx

#4 lore raw
In reply to Logan Gunthorpe
The following commit has been merged into the locking/core branch of tip:

The following commit has been merged into the locking/core branch of tip:

Commit-ID:     efbdc769601f4d50018bf7ca50fc9f7c67392ece
Gitweb:        https://git.kernel.org/tip/efbdc769601f4d50018bf7ca50fc9f7c67392ece
Author:        Logan Gunthorpe <[email protected]>
AuthorDate:    Sat, 21 Mar 2020 12:25:45 +01:00
Committer:     Peter Zijlstra <[email protected]>
CommitterDate: Sat, 21 Mar 2020 16:00:20 +01:00

PCI/switchtec: Fix init_completion race condition with poll_wait()

The call to init_completion() in mrpc_queue_cmd() can theoretically race with the call to poll_wait() in switchtec_dev_poll().

poll() write()

    switchtec_dev_poll()   	  switchtec_dev_write()
      poll_wait(&s->comp.wait);      mrpc_queue_cmd()
			               init_completion(&s->comp)
				         init_waitqueue_head(&s->comp.wait)

To my knowledge, no one has hit this bug.

Fix this by using reinit_completion() instead of init_completion() in mrpc_queue_cmd().

Fixes 080b47def5e5 ("MicroSemi Switchtec management interface driver")
---
 drivers/pci/switch/switchtec.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/pci/switch/switchtec.c +1 -1
index a823b4b..81dc7ac 100644
@@ -175,7 +175,7 @@ static int mrpc_queue_cmd(struct switchtec_user *stuser)
 	kref_get(&stuser->kref);
 	stuser->read_len = sizeof(stuser->data);
 	stuser_set_state(stuser, MRPC_QUEUED);
-	init_completion(&stuser->comp);
+	reinit_completion(&stuser->comp);
 	list_add_tail(&stuser->list, &stdev->mrpc_queue);
 
 	mrpc_cmd_submit(stdev);