1 | /* |
1 | /* |
2 | iom.h -- generic I/O multiplexor |
2 | iom.h -- generic I/O multiplexer |
3 | Copyright (C) 2003 Marc Lehmann <pcg@goof.com> |
3 | Copyright (C) 2003-2006 Marc Lehmann <gvpe@schmorp.de> |
4 | |
4 | |
|
|
5 | This file is part of GVPE. |
|
|
6 | |
5 | This program is free software; you can redistribute it and/or modify |
7 | GVPE is free software; you can redistribute it and/or modify |
6 | it under the terms of the GNU General Public License as published by |
8 | it under the terms of the GNU General Public License as published by |
7 | the Free Software Foundation; either version 2 of the License, or |
9 | the Free Software Foundation; either version 2 of the License, or |
8 | (at your option) any later version. |
10 | (at your option) any later version. |
9 | |
11 | |
10 | This program is distributed in the hope that it will be useful, |
12 | This program is distributed in the hope that it will be useful, |
11 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
13 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
12 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
14 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
13 | GNU General Public License for more details. |
15 | GNU General Public License for more details. |
14 | |
16 | |
15 | You should have received a copy of the GNU General Public License |
17 | You should have received a copy of the GNU General Public License |
16 | along with this program; if not, write to the Free Software |
18 | along with gvpe; if not, write to the Free Software |
17 | Foundation, Inc. 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
19 | Foundation, Inc. 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA |
18 | */ |
20 | */ |
19 | |
21 | |
20 | #ifndef VPE_IOM_H__ |
22 | #ifndef IOM_H__ |
21 | #define VPE_IOM_H__ |
23 | #define IOM_H__ |
22 | |
24 | |
23 | #include <cassert> |
25 | // required: |
|
|
26 | // - a vector template like simplevec or stl's vector |
|
|
27 | // - defines for all watcher types required in your app |
|
|
28 | // edit iom_conf.h as appropriate. |
|
|
29 | #include "iom_conf.h" |
24 | |
30 | |
25 | #include "rxvtvec.h" |
31 | #if IOM_CHILD |
|
|
32 | # undef IOM_SIG |
|
|
33 | # define IOM_SIG 1 |
|
|
34 | #endif |
|
|
35 | |
26 | #include "callback.h" |
36 | #include "callback.h" |
27 | |
37 | |
28 | typedef double tstamp; |
38 | typedef double tstamp; |
29 | |
|
|
30 | extern tstamp NOW; |
39 | extern tstamp NOW; |
31 | |
40 | |
|
|
41 | // TSTAMP_MAX must still fit into a positive struct timeval |
|
|
42 | #define TSTAMP_MAX (double)(1UL<<31) |
|
|
43 | |
|
|
44 | //#define IOM_LIBEVENT "event.h" *NOT* a supported feature |
|
|
45 | #ifdef IOM_LIBEVENT |
|
|
46 | # include <sys/time.h> |
|
|
47 | # include IOM_LIBEVENT |
|
|
48 | # undef IOM_IO |
|
|
49 | # define IOM_IO 1 |
|
|
50 | # undef IOM_TIME |
|
|
51 | # define IOM_TIME 1 |
|
|
52 | # undef IOM_IDLE // NYI |
|
|
53 | # undef IOM_SIG // NYI |
|
|
54 | # undef IOM_CHILD // NYI |
|
|
55 | #endif |
|
|
56 | |
|
|
57 | struct watcher; |
|
|
58 | #if IOM_IO |
32 | struct io_watcher; |
59 | struct io_watcher; |
|
|
60 | #endif |
|
|
61 | #if IOM_TIME |
33 | struct time_watcher; |
62 | struct time_watcher; |
|
|
63 | #endif |
|
|
64 | #if IOM_CHECK |
|
|
65 | struct check_watcher; |
|
|
66 | #endif |
|
|
67 | #if IOM_IDLE |
|
|
68 | struct idle_watcher; |
|
|
69 | #endif |
|
|
70 | #if IOM_SIG |
|
|
71 | struct sig_watcher; |
|
|
72 | #endif |
|
|
73 | #if IOM_CHILD |
|
|
74 | struct child_watcher; |
|
|
75 | #endif |
34 | |
76 | |
|
|
77 | template<class watcher> |
|
|
78 | struct io_manager_vec : vector<watcher *> { |
|
|
79 | void erase_unordered (unsigned int pos) |
|
|
80 | { |
|
|
81 | watcher *w = (*this)[this->size () - 1]; |
|
|
82 | this->pop_back (); |
|
|
83 | |
|
|
84 | if (!this->empty ()) |
|
|
85 | if (((*this)[pos] = w)) // '=' is correct! |
|
|
86 | w->active = pos + 1; |
|
|
87 | } |
|
|
88 | }; |
|
|
89 | |
|
|
90 | // only used as a namespace, and for initialisation purposes |
35 | class io_manager { |
91 | class io_manager { |
36 | simplevec<io_watcher *> iow; |
92 | template<class watcher> |
37 | simplevec<time_watcher *> tw; // actually a heap |
93 | static void reg (watcher &w, io_manager_vec<watcher> &queue); |
38 | |
94 | |
39 | void idle_cb (time_watcher &w); time_watcher *idle; |
95 | template<class watcher> |
|
|
96 | static void unreg (watcher &w, io_manager_vec<watcher> &queue); |
|
|
97 | |
40 | public: |
98 | public: |
|
|
99 | #if IOM_TIME |
|
|
100 | // fetch time only |
|
|
101 | static tstamp now (); |
|
|
102 | |
|
|
103 | // set NOW |
|
|
104 | static void set_now (); |
|
|
105 | #endif |
|
|
106 | |
41 | // register a watcher |
107 | // register a watcher |
42 | void reg (io_watcher *w); |
108 | #ifndef IOM_LIBEVENT |
43 | void unreg (io_watcher *w); |
109 | #if IOM_IO |
44 | void reg (time_watcher *w); |
110 | static void reg (io_watcher &w); static void unreg (io_watcher &w); |
45 | void unreg (time_watcher *w); |
111 | #endif |
|
|
112 | #if IOM_TIME |
|
|
113 | static void reg (time_watcher &w); static void unreg (time_watcher &w); |
|
|
114 | #endif |
|
|
115 | #if IOM_SIG |
|
|
116 | static void reg (sig_watcher &w); static void unreg (sig_watcher &w); |
|
|
117 | #endif |
|
|
118 | #if IOM_CHECK |
|
|
119 | static void reg (check_watcher &w); static void unreg (check_watcher &w); |
|
|
120 | #endif |
|
|
121 | #endif |
|
|
122 | #if IOM_IDLE |
|
|
123 | static void reg (idle_watcher &w); static void unreg (idle_watcher &w); |
|
|
124 | #endif |
|
|
125 | #if IOM_CHILD |
|
|
126 | static void reg (child_watcher &w); static void unreg (child_watcher &w); |
|
|
127 | #endif |
46 | |
128 | |
47 | void loop (); |
129 | static void loop (); |
48 | |
|
|
49 | io_manager (); |
|
|
50 | ~io_manager (); |
|
|
51 | }; |
130 | }; |
52 | |
131 | |
53 | extern io_manager iom; // a singleton, together with it's construction/destruction problems. |
132 | struct watcher { |
|
|
133 | int active; /* 0 == inactive, else index into respective vector */ |
54 | |
134 | |
55 | enum { EVENT_READ = 1, EVENT_WRITE = 2 }; |
135 | bool is_active () { return active; } |
56 | |
136 | |
|
|
137 | watcher () : active (0) { } |
|
|
138 | }; |
|
|
139 | |
|
|
140 | #if IOM_IO |
|
|
141 | #ifdef IOM_LIBEVENT |
|
|
142 | enum { EVENT_UNDEF = -1, EVENT_NONE = 0, EVENT_READ = EV_READ, EVENT_WRITE = EV_WRITE }; |
|
|
143 | |
|
|
144 | void iom_io_c_callback (int fd, short events, void *data); |
|
|
145 | |
57 | struct io_watcher : callback2<void, io_watcher &, short> { |
146 | struct io_watcher : watcher, callback<void (io_watcher &, short)> { |
|
|
147 | struct event ev; |
58 | int fd; |
148 | int fd; |
59 | short events; |
149 | short events; |
60 | |
150 | |
|
|
151 | void set (int fd_, short events_); |
|
|
152 | void set (short events_) { set (fd, events_); } |
|
|
153 | void start () { if (!active) event_add (&ev, 0); active = 1; } |
|
|
154 | void start (int fd_, short events_) { set (fd_, events_); start (); } |
|
|
155 | void stop () { if (active) event_del (&ev); active = 0; } |
|
|
156 | |
61 | template<class O1, class O2> |
157 | template<class O, class M> |
62 | io_watcher (O1 *object, void (O2::*method)(io_watcher &, short)) |
158 | io_watcher (O object, M method) |
63 | : callback2<void, io_watcher &, short>(object,method) |
159 | : callback<void (io_watcher &, short)> (object, method) |
|
|
160 | { } |
|
|
161 | ~io_watcher () { stop (); } |
|
|
162 | }; |
|
|
163 | #else |
|
|
164 | enum { EVENT_UNDEF = -1, EVENT_NONE = 0, EVENT_READ = 1, EVENT_WRITE = 2 }; |
|
|
165 | |
|
|
166 | struct io_watcher : watcher, callback<void (io_watcher &, short)> { |
|
|
167 | int fd; |
|
|
168 | short events; |
|
|
169 | |
|
|
170 | void set (int fd_, short events_) { fd = fd_; events = events_; } |
|
|
171 | |
|
|
172 | void set (short events_) { set (fd, events_); } |
|
|
173 | void start () { io_manager::reg (*this); } |
|
|
174 | void start (int fd_, short events_) { set (fd_, events_); start (); } |
|
|
175 | void stop () { io_manager::unreg (*this); } |
|
|
176 | |
|
|
177 | template<class O, class M> |
|
|
178 | io_watcher (O object, M method) |
|
|
179 | : callback<void (io_watcher &, short)> (object, method) |
|
|
180 | { } |
|
|
181 | ~io_watcher () { stop (); } |
|
|
182 | }; |
|
|
183 | #endif |
|
|
184 | #endif |
|
|
185 | |
|
|
186 | #if IOM_TIME |
|
|
187 | #ifdef IOM_LIBEVENT |
|
|
188 | void iom_time_c_callback (int fd, short events, void *data); |
|
|
189 | |
|
|
190 | struct time_watcher : watcher, callback<void (time_watcher &)> { |
|
|
191 | struct event ev; |
|
|
192 | tstamp at; |
|
|
193 | |
|
|
194 | void trigger (); |
|
|
195 | |
|
|
196 | void set (tstamp when) |
|
|
197 | { |
|
|
198 | at = when; |
|
|
199 | if (active) |
|
|
200 | start (); |
|
|
201 | } |
|
|
202 | void operator () () { trigger (); } |
|
|
203 | void start (); |
|
|
204 | void start (tstamp when) { at = when; start (); } |
|
|
205 | void stop () { if (active) evtimer_del (&ev); active = 0; } |
|
|
206 | |
|
|
207 | template<class O, class M> |
|
|
208 | time_watcher (O object, M method) |
|
|
209 | : callback<void (time_watcher &)> (object, method), at (0) |
|
|
210 | { } |
|
|
211 | ~time_watcher () { stop (); } |
|
|
212 | }; |
|
|
213 | #else |
|
|
214 | struct time_watcher : watcher, callback<void (time_watcher &)> { |
|
|
215 | tstamp at; |
|
|
216 | |
|
|
217 | void trigger (); |
|
|
218 | |
|
|
219 | void set (tstamp when) { at = when; } |
|
|
220 | void operator () () { trigger (); } |
|
|
221 | void start () { io_manager::reg (*this); } |
|
|
222 | void start (tstamp when) { set (when); start (); } |
|
|
223 | void stop () { io_manager::unreg (*this); } |
|
|
224 | |
|
|
225 | template<class O, class M> |
|
|
226 | time_watcher (O object, M method) |
|
|
227 | : callback<void (time_watcher &)> (object, method), at (0) |
|
|
228 | { } |
|
|
229 | ~time_watcher () { stop (); } |
|
|
230 | }; |
|
|
231 | #endif |
|
|
232 | #endif |
|
|
233 | |
|
|
234 | #if IOM_CHECK |
|
|
235 | // run before checking for new events |
|
|
236 | struct check_watcher : watcher, callback<void (check_watcher &)> { |
|
|
237 | void start () { io_manager::reg (*this); } |
|
|
238 | void stop () { io_manager::unreg (*this); } |
|
|
239 | |
|
|
240 | template<class O, class M> |
|
|
241 | check_watcher (O object, M method) |
|
|
242 | : callback<void (check_watcher &)> (object, method) |
|
|
243 | { } |
|
|
244 | ~check_watcher () { stop (); } |
|
|
245 | }; |
|
|
246 | #endif |
|
|
247 | |
|
|
248 | #if IOM_IDLE |
|
|
249 | // run after checking for any i/o, but before waiting |
|
|
250 | struct idle_watcher : watcher, callback<void (idle_watcher &)> { |
|
|
251 | void start () { io_manager::reg (*this); } |
|
|
252 | void stop () { io_manager::unreg (*this); } |
|
|
253 | |
|
|
254 | template<class O, class M> |
|
|
255 | idle_watcher (O object, M method) |
|
|
256 | : callback<void (idle_watcher &)> (object, method) |
64 | { } |
257 | { } |
|
|
258 | ~idle_watcher () { stop (); } |
|
|
259 | }; |
|
|
260 | #endif |
65 | |
261 | |
66 | ~io_watcher (); |
262 | #if IOM_SIG |
|
|
263 | struct sig_watcher : watcher, callback<void (sig_watcher &)> { |
|
|
264 | int signum; |
67 | |
265 | |
68 | void set(int fd_, short events_) { fd = fd_; events = events_; } |
266 | void start (int signum); |
69 | |
|
|
70 | void set(short events_) { set (fd, events_); } |
|
|
71 | void start (int fd_, short events_) { set (fd_, events_); iom.reg (this); } |
|
|
72 | void stop () { iom.unreg (this); } |
267 | void stop () { io_manager::unreg (*this); } |
73 | }; |
|
|
74 | |
268 | |
75 | #define TSTAMP_CANCEL -1. |
|
|
76 | |
|
|
77 | struct time_watcher : callback1<void, time_watcher &> { |
|
|
78 | tstamp at; |
|
|
79 | |
|
|
80 | template<class O1, class O2> |
269 | template<class O, class M> |
81 | time_watcher (O1 *object, void (O2::*method)(time_watcher &)) |
270 | sig_watcher (O object, M method) |
82 | : callback1<void, time_watcher &>(object,method) |
271 | : callback<void(sig_watcher &)> (object, method), signum (0) |
83 | { } |
272 | { } |
|
|
273 | ~sig_watcher () { stop (); } |
|
|
274 | }; |
|
|
275 | #endif |
84 | |
276 | |
85 | ~time_watcher (); |
277 | #if IOM_CHILD |
|
|
278 | struct child_watcher : watcher, callback<void (child_watcher &, int)> { |
|
|
279 | int /*pid_t*/ pid; |
86 | |
280 | |
87 | void trigger (); |
281 | void start (int pid) { this->pid = pid; io_manager::reg (*this); } |
88 | |
|
|
89 | void set (tstamp when) { at = when; } |
|
|
90 | void operator ()() { trigger (); } |
|
|
91 | void start () { iom.reg (this); } |
|
|
92 | void start (tstamp when) { set (when); iom.reg (this); } |
|
|
93 | void stop () { iom.unreg (this); } |
282 | void stop () { io_manager::unreg (*this); } |
94 | |
283 | |
95 | void reset (tstamp when = TSTAMP_CANCEL) |
284 | template<class O, class M> |
96 | { |
285 | child_watcher (O object, M method) |
97 | stop (); |
286 | : callback<void (child_watcher &, int)> (object, method), pid (0) |
98 | at = when; |
|
|
99 | } |
287 | { } |
|
|
288 | ~child_watcher () { stop (); } |
100 | }; |
289 | }; |
101 | |
|
|
102 | #endif |
290 | #endif |
103 | |
291 | |
|
|
292 | #endif |
|
|
293 | |