]>
Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | #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. | |
b8a21626 | 8 | * See kernel/sched/completion.c for details. |
1da177e4 LT |
9 | */ |
10 | ||
11 | #include <linux/wait.h> | |
ea3f2c0f | 12 | #ifdef CONFIG_LOCKDEP_COMPLETIONS |
cd8084f9 BP |
13 | #include <linux/lockdep.h> |
14 | #endif | |
1da177e4 | 15 | |
ee2f154a | 16 | /* |
65eb3dc6 KD |
17 | * struct completion - structure used to maintain state for a "completion" |
18 | * | |
19 | * This is the opaque structure used to maintain the state for a "completion". | |
20 | * Completions currently use a FIFO to queue threads that have to wait for | |
21 | * the "completion" event. | |
22 | * | |
23 | * See also: complete(), wait_for_completion() (and friends _timeout, | |
24 | * _interruptible, _interruptible_timeout, and _killable), init_completion(), | |
c32f74ab WS |
25 | * reinit_completion(), and macros DECLARE_COMPLETION(), |
26 | * DECLARE_COMPLETION_ONSTACK(). | |
65eb3dc6 | 27 | */ |
1da177e4 LT |
28 | struct completion { |
29 | unsigned int done; | |
30 | wait_queue_head_t wait; | |
ea3f2c0f | 31 | #ifdef CONFIG_LOCKDEP_COMPLETIONS |
cd8084f9 BP |
32 | struct lockdep_map_cross map; |
33 | #endif | |
1da177e4 LT |
34 | }; |
35 | ||
ea3f2c0f | 36 | #ifdef CONFIG_LOCKDEP_COMPLETIONS |
cd8084f9 BP |
37 | static inline void complete_acquire(struct completion *x) |
38 | { | |
39 | lock_acquire_exclusive((struct lockdep_map *)&x->map, 0, 0, NULL, _RET_IP_); | |
40 | } | |
41 | ||
42 | static inline void complete_release(struct completion *x) | |
43 | { | |
44 | lock_release((struct lockdep_map *)&x->map, 0, _RET_IP_); | |
45 | } | |
46 | ||
47 | static inline void complete_release_commit(struct completion *x) | |
48 | { | |
49 | lock_commit_crosslock((struct lockdep_map *)&x->map); | |
50 | } | |
51 | ||
52 | #define init_completion(x) \ | |
53 | do { \ | |
54 | static struct lock_class_key __key; \ | |
55 | lockdep_init_map_crosslock((struct lockdep_map *)&(x)->map, \ | |
56 | "(complete)" #x, \ | |
57 | &__key, 0); \ | |
58 | __init_completion(x); \ | |
59 | } while (0) | |
60 | #else | |
61 | #define init_completion(x) __init_completion(x) | |
62 | static inline void complete_acquire(struct completion *x) {} | |
63 | static inline void complete_release(struct completion *x) {} | |
64 | static inline void complete_release_commit(struct completion *x) {} | |
65 | #endif | |
66 | ||
ea3f2c0f | 67 | #ifdef CONFIG_LOCKDEP_COMPLETIONS |
cd8084f9 BP |
68 | #define COMPLETION_INITIALIZER(work) \ |
69 | { 0, __WAIT_QUEUE_HEAD_INITIALIZER((work).wait), \ | |
70 | STATIC_CROSS_LOCKDEP_MAP_INIT("(complete)" #work, &(work)) } | |
71 | #else | |
1da177e4 LT |
72 | #define COMPLETION_INITIALIZER(work) \ |
73 | { 0, __WAIT_QUEUE_HEAD_INITIALIZER((work).wait) } | |
cd8084f9 | 74 | #endif |
1da177e4 | 75 | |
f86bf9b7 | 76 | #define COMPLETION_INITIALIZER_ONSTACK(work) \ |
ec81048c | 77 | (*({ init_completion(&work); &work; })) |
f86bf9b7 | 78 | |
65eb3dc6 | 79 | /** |
ee2f154a | 80 | * DECLARE_COMPLETION - declare and initialize a completion structure |
65eb3dc6 KD |
81 | * @work: identifier for the completion structure |
82 | * | |
83 | * This macro declares and initializes a completion structure. Generally used | |
84 | * for static declarations. You should use the _ONSTACK variant for automatic | |
85 | * variables. | |
86 | */ | |
1da177e4 LT |
87 | #define DECLARE_COMPLETION(work) \ |
88 | struct completion work = COMPLETION_INITIALIZER(work) | |
89 | ||
8b3db9c5 IM |
90 | /* |
91 | * Lockdep needs to run a non-constant initializer for on-stack | |
92 | * completions - so we use the _ONSTACK() variant for those that | |
93 | * are on the kernel stack: | |
94 | */ | |
65eb3dc6 | 95 | /** |
ee2f154a | 96 | * DECLARE_COMPLETION_ONSTACK - declare and initialize a completion structure |
65eb3dc6 KD |
97 | * @work: identifier for the completion structure |
98 | * | |
99 | * This macro declares and initializes a completion structure on the kernel | |
100 | * stack. | |
101 | */ | |
8b3db9c5 IM |
102 | #ifdef CONFIG_LOCKDEP |
103 | # define DECLARE_COMPLETION_ONSTACK(work) \ | |
f86bf9b7 | 104 | struct completion work = COMPLETION_INITIALIZER_ONSTACK(work) |
8b3db9c5 IM |
105 | #else |
106 | # define DECLARE_COMPLETION_ONSTACK(work) DECLARE_COMPLETION(work) | |
107 | #endif | |
108 | ||
65eb3dc6 | 109 | /** |
ee2f154a | 110 | * init_completion - Initialize a dynamically allocated completion |
c32f74ab | 111 | * @x: pointer to completion structure that is to be initialized |
65eb3dc6 KD |
112 | * |
113 | * This inline function will initialize a dynamically created completion | |
114 | * structure. | |
115 | */ | |
cd8084f9 | 116 | static inline void __init_completion(struct completion *x) |
1da177e4 LT |
117 | { |
118 | x->done = 0; | |
119 | init_waitqueue_head(&x->wait); | |
120 | } | |
121 | ||
c32f74ab WS |
122 | /** |
123 | * reinit_completion - reinitialize a completion structure | |
124 | * @x: pointer to completion structure that is to be reinitialized | |
125 | * | |
126 | * This inline function should be used to reinitialize a completion structure so it can | |
127 | * be reused. This is especially important after complete_all() is used. | |
128 | */ | |
129 | static inline void reinit_completion(struct completion *x) | |
130 | { | |
131 | x->done = 0; | |
132 | } | |
133 | ||
b15136e9 | 134 | extern void wait_for_completion(struct completion *); |
686855f5 | 135 | extern void wait_for_completion_io(struct completion *); |
b15136e9 | 136 | extern int wait_for_completion_interruptible(struct completion *x); |
009e577e | 137 | extern int wait_for_completion_killable(struct completion *x); |
b15136e9 IM |
138 | extern unsigned long wait_for_completion_timeout(struct completion *x, |
139 | unsigned long timeout); | |
686855f5 VD |
140 | extern unsigned long wait_for_completion_io_timeout(struct completion *x, |
141 | unsigned long timeout); | |
6bf41237 N |
142 | extern long wait_for_completion_interruptible_timeout( |
143 | struct completion *x, unsigned long timeout); | |
144 | extern long wait_for_completion_killable_timeout( | |
145 | struct completion *x, unsigned long timeout); | |
be4de352 DC |
146 | extern bool try_wait_for_completion(struct completion *x); |
147 | extern bool completion_done(struct completion *x); | |
b15136e9 IM |
148 | |
149 | extern void complete(struct completion *); | |
150 | extern void complete_all(struct completion *); | |
1da177e4 | 151 | |
1da177e4 | 152 | #endif |