Commit 12ac6782 authored by Davidlohr Bueso's avatar Davidlohr Bueso Committed by Peter Zijlstra

sched/swait: Reword some of the main description

With both the increased use of swait and kvm no longer using
it, we can reword some of the comments. While removing Linus'
valid rant, I've also cared to explicitly mention that swait
is very different than regular wait. In addition it is
mentioned against using swait in favor of the regular flavor.
Signed-off-by: default avatarDavidlohr Bueso <dbueso@suse.de>
Signed-off-by: default avatarPeter Zijlstra (Intel) <peterz@infradead.org>
Link: https://lkml.kernel.org/r/20200422040739.18601-6-dave@stgolabs.net
parent 17c891ab
...@@ -9,23 +9,10 @@ ...@@ -9,23 +9,10 @@
#include <asm/current.h> #include <asm/current.h>
/* /*
* BROKEN wait-queues. * Simple waitqueues are semantically very different to regular wait queues
* * (wait.h). The most important difference is that the simple waitqueue allows
* These "simple" wait-queues are broken garbage, and should never be * for deterministic behaviour -- IOW it has strictly bounded IRQ and lock hold
* used. The comments below claim that they are "similar" to regular * times.
* wait-queues, but the semantics are actually completely different, and
* every single user we have ever had has been buggy (or pointless).
*
* A "swake_up_one()" only wakes up _one_ waiter, which is not at all what
* "wake_up()" does, and has led to problems. In other cases, it has
* been fine, because there's only ever one waiter (kvm), but in that
* case gthe whole "simple" wait-queue is just pointless to begin with,
* since there is no "queue". Use "wake_up_process()" with a direct
* pointer instead.
*
* While these are very similar to regular wait queues (wait.h) the most
* important difference is that the simple waitqueue allows for deterministic
* behaviour -- IOW it has strictly bounded IRQ and lock hold times.
* *
* Mainly, this is accomplished by two things. Firstly not allowing swake_up_all * Mainly, this is accomplished by two things. Firstly not allowing swake_up_all
* from IRQ disabled, and dropping the lock upon every wakeup, giving a higher * from IRQ disabled, and dropping the lock upon every wakeup, giving a higher
...@@ -39,7 +26,7 @@ ...@@ -39,7 +26,7 @@
* sleeper state. * sleeper state.
* *
* - the !exclusive mode; because that leads to O(n) wakeups, everything is * - the !exclusive mode; because that leads to O(n) wakeups, everything is
* exclusive. * exclusive. As such swake_up_one will only ever awake _one_ waiter.
* *
* - custom wake callback functions; because you cannot give any guarantees * - custom wake callback functions; because you cannot give any guarantees
* about random code. This also allows swait to be used in RT, such that * about random code. This also allows swait to be used in RT, such that
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment