From: Martin Waitz New kernel-doc comments for might_sleep & wait_event_* Signed-off-by: Martin Waitz Signed-off-by: Andrew Morton --- 25-akpm/include/linux/kernel.h | 12 +++++++- 25-akpm/include/linux/wait.h | 60 +++++++++++++++++++++++++++++++++++++++++ 2 files changed, 71 insertions(+), 1 deletion(-) diff -puN include/linux/kernel.h~docbook-new-kernel-doc-comments-for-might_sleep-wait_event_ include/linux/kernel.h --- 25/include/linux/kernel.h~docbook-new-kernel-doc-comments-for-might_sleep-wait_event_ Thu Mar 3 16:55:26 2005 +++ 25-akpm/include/linux/kernel.h Thu Mar 3 16:55:26 2005 @@ -48,10 +48,20 @@ extern int console_printk[]; struct completion; +/** + * might_sleep - annotation for functions that can sleep + * + * this macro will print a stack trace if it is executed in an atomic + * context (spinlock, irq-handler, ...). + * + * This is a useful debugging help to be able to catch problems early and not + * be biten later when the calling function happens to sleep when it is not + * supposed to. + */ #ifdef CONFIG_DEBUG_SPINLOCK_SLEEP -void __might_sleep(char *file, int line); #define might_sleep() __might_sleep(__FILE__, __LINE__) #define might_sleep_if(cond) do { if (unlikely(cond)) might_sleep(); } while (0) +void __might_sleep(char *file, int line); #else #define might_sleep() do {} while(0) #define might_sleep_if(cond) do {} while (0) diff -puN include/linux/wait.h~docbook-new-kernel-doc-comments-for-might_sleep-wait_event_ include/linux/wait.h --- 25/include/linux/wait.h~docbook-new-kernel-doc-comments-for-might_sleep-wait_event_ Thu Mar 3 16:55:26 2005 +++ 25-akpm/include/linux/wait.h Thu Mar 3 16:55:26 2005 @@ -169,6 +169,18 @@ do { \ finish_wait(&wq, &__wait); \ } while (0) +/** + * wait_event - sleep until a condition gets true + * @wq: the waitqueue to wait on + * @condition: a C expression for the event to wait for + * + * The process is put to sleep (TASK_UNINTERRUPTIBLE) until the + * @condition evaluates to true. The @condition is checked each time + * the waitqueue @wq is woken up. + * + * wake_up() has to be called after changing any variable that could + * change the result of the wait condition. + */ #define wait_event(wq, condition) \ do { \ if (condition) \ @@ -191,6 +203,22 @@ do { \ finish_wait(&wq, &__wait); \ } while (0) +/** + * wait_event_timeout - sleep until a condition gets true or a timeout elapses + * @wq: the waitqueue to wait on + * @condition: a C expression for the event to wait for + * @timeout: timeout, in jiffies + * + * The process is put to sleep (TASK_UNINTERRUPTIBLE) until the + * @condition evaluates to true. The @condition is checked each time + * the waitqueue @wq is woken up. + * + * wake_up() has to be called after changing any variable that could + * change the result of the wait condition. + * + * The function returns 0 if the @timeout elapsed, and the remaining + * jiffies if the condition evaluated to true before the timeout elapsed. + */ #define wait_event_timeout(wq, condition, timeout) \ ({ \ long __ret = timeout; \ @@ -217,6 +245,21 @@ do { \ finish_wait(&wq, &__wait); \ } while (0) +/** + * wait_event_interruptible - sleep until a condition gets true + * @wq: the waitqueue to wait on + * @condition: a C expression for the event to wait for + * + * The process is put to sleep (TASK_INTERRUPTIBLE) until the + * @condition evaluates to true or a signal is received. + * The @condition is checked each time the waitqueue @wq is woken up. + * + * wake_up() has to be called after changing any variable that could + * change the result of the wait condition. + * + * The function will return -ERESTARTSYS if it was interrupted by a + * signal and 0 if @condition evaluated to true. + */ #define wait_event_interruptible(wq, condition) \ ({ \ int __ret = 0; \ @@ -245,6 +288,23 @@ do { \ finish_wait(&wq, &__wait); \ } while (0) +/** + * wait_event_interruptible_timeout - sleep until a condition gets true or a timeout elapses + * @wq: the waitqueue to wait on + * @condition: a C expression for the event to wait for + * @timeout: timeout, in jiffies + * + * The process is put to sleep (TASK_INTERRUPTIBLE) until the + * @condition evaluates to true or a signal is received. + * The @condition is checked each time the waitqueue @wq is woken up. + * + * wake_up() has to be called after changing any variable that could + * change the result of the wait condition. + * + * The function returns 0 if the @timeout elapsed, -ERESTARTSYS if it + * was interrupted by a signal, and the remaining jiffies otherwise + * if the condition evaluated to true before the timeout elapsed. + */ #define wait_event_interruptible_timeout(wq, condition, timeout) \ ({ \ long __ret = timeout; \ _