Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

sched: replace INIT_COMPLETION with reinit_completion

For the casual device driver writer, it is hard to remember when to use
init_completion (to init a completion structure) or INIT_COMPLETION (to
*reinit* a completion structure). Furthermore, while all other
completion functions exepct a pointer as a parameter, INIT_COMPLETION
does not. To make it easier to remember which function to use and to
make code more readable, introduce a new inline function with the proper
name and consistent argument type. Update the kernel-doc for
init_completion while we are here.

Signed-off-by: Wolfram Sang <wsa@the-dreams.de>
Acked-by: Linus Walleij <linus.walleij@linaro.org> (personally at LCE13)
Cc: Ingo Molnar <mingo@kernel.org>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>

authored by

Wolfram Sang and committed by
Linus Torvalds
c32f74ab 406bf318

+15 -3
+15 -3
include/linux/completion.h
··· 19 19 * 20 20 * See also: complete(), wait_for_completion() (and friends _timeout, 21 21 * _interruptible, _interruptible_timeout, and _killable), init_completion(), 22 - * and macros DECLARE_COMPLETION(), DECLARE_COMPLETION_ONSTACK(), and 23 - * INIT_COMPLETION(). 22 + * reinit_completion(), and macros DECLARE_COMPLETION(), 23 + * DECLARE_COMPLETION_ONSTACK(). 24 24 */ 25 25 struct completion { 26 26 unsigned int done; ··· 65 65 66 66 /** 67 67 * init_completion - Initialize a dynamically allocated completion 68 - * @x: completion structure that is to be initialized 68 + * @x: pointer to completion structure that is to be initialized 69 69 * 70 70 * This inline function will initialize a dynamically created completion 71 71 * structure. ··· 74 74 { 75 75 x->done = 0; 76 76 init_waitqueue_head(&x->wait); 77 + } 78 + 79 + /** 80 + * reinit_completion - reinitialize a completion structure 81 + * @x: pointer to completion structure that is to be reinitialized 82 + * 83 + * This inline function should be used to reinitialize a completion structure so it can 84 + * be reused. This is especially important after complete_all() is used. 85 + */ 86 + static inline void reinit_completion(struct completion *x) 87 + { 88 + x->done = 0; 77 89 } 78 90 79 91 extern void wait_for_completion(struct completion *);