sched: document wait_for_completion_* return values
PATCH 1/1 sched: document wait_for_completion_* return values
From: J. Bruce Fields <[email protected]>
The return-value convention for these functions varies depending on whether they're interruptible or can timeout. It can be a little confusing--document it.
--- kernel/sched.c | 13 +++++++++++++ 1 files changed, 13 insertions(+), 0 deletions(-)
kernel/sched.c +13 -0
@@ -4690,6 +4690,9 @@ EXPORT_SYMBOL(wait_for_completion);* This waits for either a completion of a specific task to be signaled or for a * specified timeout to expire. The timeout is in jiffies. It is not * interruptible. +* +* The return value is 0 if timed out, and positive (at least 1, or number of +* jiffies left till timeout) if completed. */ unsigned long __sched wait_for_completion_timeout (struct completion *x,unsigned long timeout)
@@ -4704,6 +4707,8 @@ EXPORT_SYMBOL(wait_for_completion_timeout);* * This waits for completion of a specific task to be signaled. It is * interruptible. +* +* The return value is -ERESTARTSYS if interrupted, 0 if completed. */ int __sched wait_for_completion_interruptible(struct completion *x) {
@@ -4721,6 +4726,9 @@ EXPORT_SYMBOL(wait_for_completion_interruptible);* * This waits for either a completion of a specific task to be signaled or for a * specified timeout to expire. It is interruptible. The timeout is in jiffies. +* +* The return value is -ERESTARTSYS if interrupted, 0 if timed out, +* positive (at least 1, or number of jiffies left till timeout) if completed. */ long __sched wait_for_completion_interruptible_timeout(struct completion *x,
@@ -4736,6 +4744,8 @@ EXPORT_SYMBOL(wait_for_completion_interruptible_timeout);* * This waits to be signaled for completion of a specific task. It can be * interrupted by a kill signal. +* +* The return value is -ERESTARTSYS if interrupted, 0 if completed. */ int __sched wait_for_completion_killable(struct completion *x) {
@@ -4754,6 +4764,9 @@ EXPORT_SYMBOL(wait_for_completion_killable);* This waits for either a completion of a specific task to be * signaled or for a specified timeout to expire. It can be * interrupted by a kill signal. The timeout is in jiffies. +* +* The return value is -ERESTARTSYS if interrupted, 0 if timed out, +* positive (at least 1, or number of jiffies left till timeout) if completed. */ long __sched wait_for_completion_killable_timeout(struct completion *x,
Signature · 1 line
1.7.4.1
Quoted 5 lines · bfields
From: J. Bruce Fields <[email protected]>
The return-value convention for these functions varies depending on whether they're interruptible or can timeout. It can be a little confusing--document it.
Ping? Should I resend this or send it someplace different?
--b.
Quoted 61 lines
Signed-off-by J. Bruce Fields <[email protected]>--- kernel/sched.c | 13 +++++++++++++ 1 files changed, 13 insertions(+), 0 deletions(-)kernel/sched.c +13
-0@@ -4690,6 +4690,9 @@ EXPORT_SYMBOL(wait_for_completion);* This waits for either a completion of a specific task to be signaled or for a * specified timeout to expire. The timeout is in jiffies. It is not * interruptible. +* +* The return value is 0 if timed out, and positive (at least 1, or number of +* jiffies left till timeout) if completed. */ unsigned long __sched wait_for_completion_timeout (struct completion *x,unsigned long timeout)@@ -4704,6 +4707,8 @@ EXPORT_SYMBOL(wait_for_completion_timeout);* * This waits for completion of a specific task to be signaled. It is * interruptible. +* +* The return value is -ERESTARTSYS if interrupted, 0 if completed. */ int __sched wait_for_completion_interruptible(struct completion *x) {@@ -4721,6 +4726,9 @@ EXPORT_SYMBOL(wait_for_completion_interruptible);* * This waits for either a completion of a specific task to be signaled or for a * specified timeout to expire. It is interruptible. The timeout is in jiffies. +* +* The return value is -ERESTARTSYS if interrupted, 0 if timed out, +* positive (at least 1, or number of jiffies left till timeout) if completed. */ long __sched wait_for_completion_interruptible_timeout(struct completion *x,@@ -4736,6 +4744,8 @@ EXPORT_SYMBOL(wait_for_completion_interruptible_timeout);* * This waits to be signaled for completion of a specific task. It can be * interrupted by a kill signal. +* +* The return value is -ERESTARTSYS if interrupted, 0 if completed. */ int __sched wait_for_completion_killable(struct completion *x) {@@ -4754,6 +4764,9 @@ EXPORT_SYMBOL(wait_for_completion_killable);* This waits for either a completion of a specific task to be * signaled or for a specified timeout to expire. It can be * interrupted by a kill signal. The timeout is in jiffies. +* +* The return value is -ERESTARTSYS if interrupted, 0 if timed out, +* positive (at least 1, or number of jiffies left till timeout) if completed. */ long __sched wait_for_completion_killable_timeout(struct completion *x,Signature · 1 line
1.7.4.1
Quoted 1 line · J. Bruce Fields
Ping? Should I resend this or send it someplace different?
Its in my queue somewhere, conferences got in the way.
Quoted 4 lines · Peter Zijlstra
Quoted 1 line · J. Bruce Fields
Ping? Should I resend this or send it someplace different?
Its in my queue somewhere, conferences got in the way.
Great, thanks!
--b.
[tip:sched/core] sched: Document wait_for_completion_*() return values
In reply to J. Bruce FieldsCommit-ID: c6dc7f055d333ef35f397b8d7c3abcd1918bf8cb Gitweb: http://git.kernel.org/tip/c6dc7f055d333ef35f397b8d7c3abcd1918bf8cb Author: J. Bruce Fields <[email protected]> AuthorDate: Thu, 6 Oct 2011 15:22:46 -0400 Committer: Ingo Molnar <[email protected]> CommitDate: Mon, 14 Nov 2011 12:50:37 +0100
sched: Document wait_for_completion_*() return values
The return-value convention for these functions varies depending on whether they're interruptible or can timeout. It can be a little confusing--document it.
--- kernel/sched.c | 13 +++++++++++++ 1 files changed, 13 insertions(+), 0 deletions(-)
kernel/sched.c +13 -0
@@ -4810,6 +4810,9 @@ EXPORT_SYMBOL(wait_for_completion);* This waits for either a completion of a specific task to be signaled or for a * specified timeout to expire. The timeout is in jiffies. It is not * interruptible. +* +* The return value is 0 if timed out, and positive (at least 1, or number of +* jiffies left till timeout) if completed. */ unsigned long __sched wait_for_completion_timeout (struct completion *x,unsigned long timeout)
@@ -4824,6 +4827,8 @@ EXPORT_SYMBOL(wait_for_completion_timeout);* * This waits for completion of a specific task to be signaled. It is * interruptible. +* +* The return value is -ERESTARTSYS if interrupted, 0 if completed. */ int __sched wait_for_completion_interruptible(struct completion *x) {
@@ -4841,6 +4846,9 @@ EXPORT_SYMBOL(wait_for_completion_interruptible);* * This waits for either a completion of a specific task to be signaled or for a * specified timeout to expire. It is interruptible. The timeout is in jiffies. +* +* The return value is -ERESTARTSYS if interrupted, 0 if timed out, +* positive (at least 1, or number of jiffies left till timeout) if completed. */ long __sched wait_for_completion_interruptible_timeout(struct completion *x,
@@ -4856,6 +4864,8 @@ EXPORT_SYMBOL(wait_for_completion_interruptible_timeout);* * This waits to be signaled for completion of a specific task. It can be * interrupted by a kill signal. +* +* The return value is -ERESTARTSYS if interrupted, 0 if completed. */ int __sched wait_for_completion_killable(struct completion *x) {
@@ -4874,6 +4884,9 @@ EXPORT_SYMBOL(wait_for_completion_killable);* This waits for either a completion of a specific task to be * signaled or for a specified timeout to expire. It can be * interrupted by a kill signal. The timeout is in jiffies. +* +* The return value is -ERESTARTSYS if interrupted, 0 if timed out, +* positive (at least 1, or number of jiffies left till timeout) if completed. */ long __sched wait_for_completion_killable_timeout(struct completion *x,