blob: d2961b66d53dbab52a3f69cd30a441725c4000ee [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#ifndef __LINUX_COMPLETION_H
2#define __LINUX_COMPLETION_H
3
4/*
5 * (C) Copyright 2001 Linus Torvalds
6 *
7 * Atomic wait-for-completion handler data structures.
8 * See kernel/sched.c for details.
9 */
10
11#include <linux/wait.h>
12
13struct completion {
14 unsigned int done;
15 wait_queue_head_t wait;
16};
17
18#define COMPLETION_INITIALIZER(work) \
19 { 0, __WAIT_QUEUE_HEAD_INITIALIZER((work).wait) }
20
Ingo Molnarf86bf9b2006-07-10 04:44:05 -070021#define COMPLETION_INITIALIZER_ONSTACK(work) \
22 ({ init_completion(&work); work; })
23
Linus Torvalds1da177e2005-04-16 15:20:36 -070024#define DECLARE_COMPLETION(work) \
25 struct completion work = COMPLETION_INITIALIZER(work)
26
Ingo Molnar8b3db9c2006-07-03 00:24:28 -070027/*
28 * Lockdep needs to run a non-constant initializer for on-stack
29 * completions - so we use the _ONSTACK() variant for those that
30 * are on the kernel stack:
31 */
32#ifdef CONFIG_LOCKDEP
33# define DECLARE_COMPLETION_ONSTACK(work) \
Ingo Molnarf86bf9b2006-07-10 04:44:05 -070034 struct completion work = COMPLETION_INITIALIZER_ONSTACK(work)
Ingo Molnar8b3db9c2006-07-03 00:24:28 -070035#else
36# define DECLARE_COMPLETION_ONSTACK(work) DECLARE_COMPLETION(work)
37#endif
38
Linus Torvalds1da177e2005-04-16 15:20:36 -070039static inline void init_completion(struct completion *x)
40{
41 x->done = 0;
42 init_waitqueue_head(&x->wait);
43}
44
Ingo Molnarb15136e2007-10-24 18:23:48 +020045extern void wait_for_completion(struct completion *);
46extern int wait_for_completion_interruptible(struct completion *x);
Matthew Wilcox009e5772007-12-06 12:29:54 -050047extern int wait_for_completion_killable(struct completion *x);
Ingo Molnarb15136e2007-10-24 18:23:48 +020048extern unsigned long wait_for_completion_timeout(struct completion *x,
49 unsigned long timeout);
50extern unsigned long wait_for_completion_interruptible_timeout(
51 struct completion *x, unsigned long timeout);
Linus Torvalds1da177e2005-04-16 15:20:36 -070052
Ingo Molnarb15136e2007-10-24 18:23:48 +020053extern void complete(struct completion *);
54extern void complete_all(struct completion *);
Linus Torvalds1da177e2005-04-16 15:20:36 -070055
56#define INIT_COMPLETION(x) ((x).done = 0)
57
58#endif