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 | |
|
|
38 | typedef double tstamp; |
|
|
39 | extern tstamp NOW; |
|
|
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 |
28 | #define IOM_IO 1 |
49 | # define IOM_IO 1 |
|
|
50 | # undef IOM_TIME |
29 | #define IOM_TIME 1 |
51 | # define IOM_TIME 1 |
30 | #define IOM_CHECK 1 |
52 | # undef IOM_IDLE // NYI |
31 | #define IOM_IDLE 0 |
53 | # undef IOM_SIG // NYI |
|
|
54 | # undef IOM_CHILD // NYI |
|
|
55 | #endif |
32 | |
56 | |
|
|
57 | struct watcher; |
33 | #if IOM_IO |
58 | #if IOM_IO |
34 | typedef double tstamp; |
|
|
35 | extern tstamp NOW; |
|
|
36 | |
|
|
37 | struct io_watcher; |
59 | struct io_watcher; |
38 | #endif |
60 | #endif |
39 | #if IOM_TIME |
61 | #if IOM_TIME |
40 | struct time_watcher; |
62 | struct time_watcher; |
41 | #endif |
63 | #endif |
42 | #if IOM_CHECK |
64 | #if IOM_CHECK |
43 | struct check_watcher; |
65 | struct check_watcher; |
44 | #endif |
66 | #endif |
45 | #if IOM_IDLE |
67 | #if IOM_IDLE |
46 | struct idle_watcher; |
68 | struct idle_watcher; |
47 | #endif |
69 | #endif |
|
|
70 | #if IOM_SIG |
|
|
71 | struct sig_watcher; |
|
|
72 | #endif |
|
|
73 | #if IOM_CHILD |
|
|
74 | struct child_watcher; |
|
|
75 | #endif |
48 | |
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 |
49 | class io_manager { |
91 | class io_manager { |
|
|
92 | template<class watcher> |
|
|
93 | static void reg (watcher &w, io_manager_vec<watcher> &queue); |
|
|
94 | |
|
|
95 | template<class watcher> |
|
|
96 | static void unreg (watcher &w, io_manager_vec<watcher> &queue); |
|
|
97 | |
|
|
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 | |
|
|
107 | // register a watcher |
|
|
108 | #ifndef IOM_LIBEVENT |
50 | #if IOM_IO |
109 | #if IOM_IO |
51 | simplevec<io_watcher *> iow; |
110 | static void reg (io_watcher &w); static void unreg (io_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); |
52 | #endif |
117 | #endif |
53 | #if IOM_CHECK |
118 | #if IOM_CHECK |
54 | simplevec<check_watcher *> cw; |
119 | static void reg (check_watcher &w); static void unreg (check_watcher &w); |
55 | #endif |
120 | #endif |
56 | #if IOM_TIME |
|
|
57 | simplevec<time_watcher *> tw; |
|
|
58 | #endif |
121 | #endif |
59 | #if IOM_IDLE |
122 | #if IOM_IDLE |
60 | simplevec<idle_watcher *> iw; |
123 | static void reg (idle_watcher &w); static void unreg (idle_watcher &w); |
61 | #endif |
124 | #endif |
|
|
125 | #if IOM_CHILD |
|
|
126 | static void reg (child_watcher &w); static void unreg (child_watcher &w); |
|
|
127 | #endif |
|
|
128 | |
|
|
129 | static void loop (); |
|
|
130 | }; |
62 | |
131 | |
63 | template<class watcher> |
132 | struct watcher { |
64 | void reg (watcher *w, simplevec<watcher *> &queue); |
133 | int active; /* 0 == inactive, else index into respective vector */ |
65 | |
134 | |
66 | template<class watcher> |
135 | bool is_active () { return active; } |
67 | void unreg (watcher *w, simplevec<watcher *> &queue); |
|
|
68 | |
136 | |
69 | public: |
137 | watcher () : active (0) { } |
70 | // register a watcher |
138 | }; |
|
|
139 | |
71 | #if IOM_IO |
140 | #if IOM_IO |
72 | void reg (io_watcher *w); void unreg (io_watcher *w); |
141 | #ifdef IOM_LIBEVENT |
73 | #endif |
142 | enum { EVENT_UNDEF = -1, EVENT_NONE = 0, EVENT_READ = EV_READ, EVENT_WRITE = EV_WRITE }; |
74 | #if IOM_TIME |
|
|
75 | void reg (time_watcher *w); void unreg (time_watcher *w); |
|
|
76 | #endif |
|
|
77 | #if IOM_CHECK |
|
|
78 | void reg (check_watcher *w); void unreg (check_watcher *w); |
|
|
79 | #endif |
|
|
80 | #if IOM_IDLE |
|
|
81 | void reg (idle_watcher *w); void unreg (idle_watcher *w); |
|
|
82 | #endif |
|
|
83 | |
|
|
84 | void loop (); |
|
|
85 | |
143 | |
86 | io_manager (); |
144 | void iom_io_c_callback (int fd, short events, void *data); |
87 | ~io_manager (); |
|
|
88 | }; |
|
|
89 | |
145 | |
90 | extern io_manager iom; // a singleton, together with it's construction/destruction problems. |
|
|
91 | |
|
|
92 | #if IOM_IO |
|
|
93 | enum { EVENT_READ = 1, EVENT_WRITE = 2 }; |
|
|
94 | |
|
|
95 | struct io_watcher : callback2<void, io_watcher &, short> { |
146 | struct io_watcher : watcher, callback<void (io_watcher &, short)> { |
|
|
147 | struct event ev; |
96 | int fd; |
148 | int fd; |
97 | short events; |
149 | short events; |
98 | |
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 | |
99 | template<class O1, class O2> |
157 | template<class O, class M> |
100 | io_watcher (O1 *object, void (O2::*method)(io_watcher &, short)) |
158 | io_watcher (O object, M method) |
101 | : callback2<void, io_watcher &, short>(object,method) |
159 | : callback<void (io_watcher &, short)> (object, method) |
102 | { } |
160 | { } |
|
|
161 | ~io_watcher () { stop (); } |
|
|
162 | }; |
|
|
163 | #else |
|
|
164 | enum { EVENT_UNDEF = -1, EVENT_NONE = 0, EVENT_READ = 1, EVENT_WRITE = 2 }; |
103 | |
165 | |
104 | ~io_watcher (); |
166 | struct io_watcher : watcher, callback<void (io_watcher &, short)> { |
|
|
167 | int fd; |
|
|
168 | short events; |
105 | |
169 | |
106 | void set (int fd_, short events_) { fd = fd_; events = events_; } |
170 | void set (int fd_, short events_) { fd = fd_; events = events_; } |
107 | |
171 | |
108 | void set (short events_) { set (fd, events_); } |
172 | void set (short events_) { set (fd, events_); } |
109 | void start () { iom.reg (this); } |
173 | void start () { io_manager::reg (*this); } |
110 | void start (int fd_, short events_) { set (fd_, events_); iom.reg (this); } |
174 | void start (int fd_, short events_) { set (fd_, events_); start (); } |
111 | void stop () { iom.unreg (this); } |
175 | void stop () { io_manager::unreg (*this); } |
112 | }; |
|
|
113 | #endif |
|
|
114 | |
176 | |
115 | #if IOM_TIME |
177 | template<class O, class M> |
116 | enum { TSTAMP_CANCEL = -1 }; |
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 |
117 | |
185 | |
|
|
186 | #if IOM_TIME |
|
|
187 | #ifdef IOM_LIBEVENT |
|
|
188 | void iom_time_c_callback (int fd, short events, void *data); |
|
|
189 | |
118 | struct time_watcher : callback1<void, time_watcher &> { |
190 | struct time_watcher : watcher, callback<void (time_watcher &)> { |
|
|
191 | struct event ev; |
119 | tstamp at; |
192 | tstamp at; |
120 | |
193 | |
121 | template<class O1, class O2> |
|
|
122 | time_watcher (O1 *object, void (O2::*method)(time_watcher &)) |
|
|
123 | : callback1<void, time_watcher &>(object,method) |
|
|
124 | { } |
|
|
125 | |
|
|
126 | ~time_watcher (); |
|
|
127 | |
|
|
128 | void trigger (); |
194 | void trigger (); |
129 | |
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 | |
130 | void set (tstamp when) { at = when; } |
219 | void set (tstamp when) { at = when; } |
131 | void operator ()() { trigger (); } |
220 | void operator () () { trigger (); } |
132 | void start () { iom.reg (this); } |
221 | void start () { io_manager::reg (*this); } |
133 | void start (tstamp when) { set (when); iom.reg (this); } |
222 | void start (tstamp when) { set (when); start (); } |
134 | void stop () { iom.unreg (this); } |
223 | void stop () { io_manager::unreg (*this); } |
135 | |
224 | |
136 | void reset (tstamp when = TSTAMP_CANCEL) |
225 | template<class O, class M> |
137 | { |
226 | time_watcher (O object, M method) |
138 | stop (); |
227 | : callback<void (time_watcher &)> (object, method), at (0) |
139 | at = when; |
|
|
140 | } |
228 | { } |
|
|
229 | ~time_watcher () { stop (); } |
141 | }; |
230 | }; |
|
|
231 | #endif |
142 | #endif |
232 | #endif |
143 | |
233 | |
144 | #if IOM_CHECK |
234 | #if IOM_CHECK |
145 | // run before checking for new events |
235 | // run before checking for new events |
146 | struct check_watcher : callback1<void, check_watcher &> { |
236 | struct check_watcher : watcher, callback<void (check_watcher &)> { |
|
|
237 | void start () { io_manager::reg (*this); } |
|
|
238 | void stop () { io_manager::unreg (*this); } |
|
|
239 | |
147 | template<class O1, class O2> |
240 | template<class O, class M> |
148 | check_watcher (O1 *object, void (O2::*method)(check_watcher &)) |
241 | check_watcher (O object, M method) |
149 | : callback1<void, check_watcher &>(object,method) |
242 | : callback<void (check_watcher &)> (object, method) |
150 | { } |
243 | { } |
151 | |
|
|
152 | ~check_watcher (); |
244 | ~check_watcher () { stop (); } |
153 | |
|
|
154 | void start () { iom.reg (this); } |
|
|
155 | void stop () { iom.unreg (this); } |
|
|
156 | }; |
245 | }; |
157 | #endif |
246 | #endif |
158 | |
247 | |
159 | #if IOM_IDLE |
248 | #if IOM_IDLE |
160 | // run after checking for any i/o, but before waiting |
249 | // run after checking for any i/o, but before waiting |
161 | struct idle_watcher : callback1<void, idle_watcher &> { |
250 | struct idle_watcher : watcher, callback<void (idle_watcher &)> { |
|
|
251 | void start () { io_manager::reg (*this); } |
|
|
252 | void stop () { io_manager::unreg (*this); } |
|
|
253 | |
162 | template<class O1, class O2> |
254 | template<class O, class M> |
163 | idle_watcher (O1 *object, void (O2::*method)(idle_watcher &)) |
255 | idle_watcher (O object, M method) |
164 | : callback1<void, idle_watcher &>(object,method) |
256 | : callback<void (idle_watcher &)> (object, method) |
165 | { } |
257 | { } |
166 | |
|
|
167 | ~idle_watcher (); |
258 | ~idle_watcher () { stop (); } |
|
|
259 | }; |
|
|
260 | #endif |
168 | |
261 | |
169 | void start () { iom.reg (this); } |
262 | #if IOM_SIG |
|
|
263 | struct sig_watcher : watcher, callback<void (sig_watcher &)> { |
|
|
264 | int signum; |
|
|
265 | |
|
|
266 | void start (int signum); |
170 | void stop () { iom.unreg (this); } |
267 | void stop () { io_manager::unreg (*this); } |
171 | }; |
|
|
172 | #endif |
|
|
173 | |
268 | |
|
|
269 | template<class O, class M> |
|
|
270 | sig_watcher (O object, M method) |
|
|
271 | : callback<void(sig_watcher &)> (object, method), signum (0) |
|
|
272 | { } |
|
|
273 | ~sig_watcher () { stop (); } |
|
|
274 | }; |
174 | #endif |
275 | #endif |
175 | |
276 | |
|
|
277 | #if IOM_CHILD |
|
|
278 | struct child_watcher : watcher, callback<void (child_watcher &, int)> { |
|
|
279 | int /*pid_t*/ pid; |
|
|
280 | |
|
|
281 | void start (int pid) { this->pid = pid; io_manager::reg (*this); } |
|
|
282 | void stop () { io_manager::unreg (*this); } |
|
|
283 | |
|
|
284 | template<class O, class M> |
|
|
285 | child_watcher (O object, M method) |
|
|
286 | : callback<void (child_watcher &, int)> (object, method), pid (0) |
|
|
287 | { } |
|
|
288 | ~child_watcher () { stop (); } |
|
|
289 | }; |
|
|
290 | #endif |
|
|
291 | |
|
|
292 | #endif |
|
|
293 | |