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 | #define IOM_IO 1 |
38 | typedef double tstamp; |
29 | #define IOM_TIME 1 |
39 | extern tstamp NOW; |
30 | #define IOM_CHECK 1 |
|
|
31 | |
40 | |
|
|
41 | // TSTAMP_MAX must still fit into a positive struct timeval |
|
|
42 | #define TSTAMP_MAX (double)(1UL<<31) |
|
|
43 | |
|
|
44 | struct watcher; |
32 | #if IOM_IO |
45 | #if IOM_IO |
33 | typedef double tstamp; |
|
|
34 | extern tstamp NOW; |
|
|
35 | |
|
|
36 | struct io_watcher; |
46 | struct io_watcher; |
37 | #endif |
47 | #endif |
38 | #if IOM_TIME |
48 | #if IOM_TIME |
39 | struct time_watcher; |
49 | struct time_watcher; |
40 | #endif |
50 | #endif |
41 | #if IOM_CHECK |
51 | #if IOM_CHECK |
42 | struct check_watcher; |
52 | struct check_watcher; |
43 | #endif |
53 | #endif |
|
|
54 | #if IOM_IDLE |
|
|
55 | struct idle_watcher; |
|
|
56 | #endif |
|
|
57 | #if IOM_SIG |
|
|
58 | struct sig_watcher; |
|
|
59 | #endif |
|
|
60 | #if IOM_CHILD |
|
|
61 | struct child_watcher; |
|
|
62 | #endif |
44 | |
63 | |
|
|
64 | template<class watcher> |
|
|
65 | struct io_manager_vec : vector<watcher *> { |
|
|
66 | void erase_unordered (unsigned int pos) |
|
|
67 | { |
|
|
68 | watcher *w = (*this)[this->size () - 1]; |
|
|
69 | this->pop_back (); |
|
|
70 | |
|
|
71 | if (!this->empty ()) |
|
|
72 | if (((*this)[pos] = w)) // '=' is correct! |
|
|
73 | w->active = pos + 1; |
|
|
74 | } |
|
|
75 | }; |
|
|
76 | |
|
|
77 | // only used as a namespace, and for initialisation purposes |
45 | class io_manager { |
78 | class io_manager { |
46 | #if IOM_IO |
|
|
47 | simplevec<io_watcher *> iow; |
|
|
48 | #endif |
|
|
49 | #if IOM_CHECK |
|
|
50 | simplevec<check_watcher *> cw; |
|
|
51 | #endif |
|
|
52 | #if IOM_TIME |
|
|
53 | simplevec<time_watcher *> tw; |
|
|
54 | #endif |
|
|
55 | |
|
|
56 | template<class watcher> |
79 | template<class watcher> |
57 | void reg (watcher *w, simplevec<watcher *> &queue); |
80 | static void reg (watcher &w, io_manager_vec<watcher> &queue); |
58 | |
81 | |
59 | template<class watcher> |
82 | template<class watcher> |
60 | void unreg (watcher *w, simplevec<watcher *> &queue); |
83 | static void unreg (watcher &w, io_manager_vec<watcher> &queue); |
61 | |
84 | |
62 | public: |
85 | public: |
|
|
86 | #if IOM_TIME |
|
|
87 | // fetch time only |
|
|
88 | static tstamp now (); |
|
|
89 | |
|
|
90 | // set NOW |
|
|
91 | static void set_now (); |
|
|
92 | #endif |
|
|
93 | |
63 | // register a watcher |
94 | // register a watcher |
64 | #if IOM_IO |
95 | #if IOM_IO |
65 | void reg (io_watcher *w); void unreg (io_watcher *w); |
96 | static void reg (io_watcher &w); static void unreg (io_watcher &w); |
66 | #endif |
97 | #endif |
67 | #if IOM_TIME |
98 | #if IOM_TIME |
68 | void reg (time_watcher *w); void unreg (time_watcher *w); |
99 | static void reg (time_watcher &w); static void unreg (time_watcher &w); |
69 | #endif |
100 | #endif |
70 | #if IOM_CHECK |
101 | #if IOM_CHECK |
71 | void reg (check_watcher *w); void unreg (check_watcher *w); |
102 | static void reg (check_watcher &w); static void unreg (check_watcher &w); |
|
|
103 | #endif |
|
|
104 | #if IOM_IDLE |
|
|
105 | static void reg (idle_watcher &w); static void unreg (idle_watcher &w); |
|
|
106 | #endif |
|
|
107 | #if IOM_SIG |
|
|
108 | static void reg (sig_watcher &w); static void unreg (sig_watcher &w); |
|
|
109 | #endif |
|
|
110 | #if IOM_CHILD |
|
|
111 | static void reg (child_watcher &w); static void unreg (child_watcher &w); |
72 | #endif |
112 | #endif |
73 | |
113 | |
74 | void loop (); |
114 | static void loop (); |
75 | |
|
|
76 | io_manager (); |
|
|
77 | ~io_manager (); |
|
|
78 | }; |
115 | }; |
79 | |
116 | |
80 | extern io_manager iom; // a singleton, together with it's construction/destruction problems. |
117 | struct watcher { |
|
|
118 | int active; /* 0 == inactive, else index into respective vector */ |
|
|
119 | |
|
|
120 | bool is_active () { return active; } |
|
|
121 | |
|
|
122 | watcher () : active (0) { } |
|
|
123 | }; |
81 | |
124 | |
82 | #if IOM_IO |
125 | #if IOM_IO |
83 | enum { EVENT_READ = 1, EVENT_WRITE = 2 }; |
126 | enum { EVENT_UNDEF = -1, EVENT_NONE = 0, EVENT_READ = 1, EVENT_WRITE = 2 }; |
84 | |
127 | |
85 | struct io_watcher : callback2<void, io_watcher &, short> { |
128 | struct io_watcher : watcher, callback<void (io_watcher &, short)> { |
86 | int fd; |
129 | int fd; |
87 | short events; |
130 | short events; |
88 | |
131 | |
89 | template<class O1, class O2> |
|
|
90 | io_watcher (O1 *object, void (O2::*method)(io_watcher &, short)) |
|
|
91 | : callback2<void, io_watcher &, short>(object,method) |
|
|
92 | { } |
|
|
93 | |
|
|
94 | ~io_watcher (); |
|
|
95 | |
|
|
96 | void set(int fd_, short events_) { fd = fd_; events = events_; } |
132 | void set (int fd_, short events_) { fd = fd_; events = events_; } |
97 | |
133 | |
98 | void set(short events_) { set (fd, events_); } |
134 | void set (short events_) { set (fd, events_); } |
|
|
135 | void start () { io_manager::reg (*this); } |
99 | void start (int fd_, short events_) { set (fd_, events_); iom.reg (this); } |
136 | void start (int fd_, short events_) { set (fd_, events_); io_manager::reg (*this); } |
100 | void stop () { iom.unreg (this); } |
137 | void stop () { io_manager::unreg (*this); } |
101 | }; |
|
|
102 | #endif |
|
|
103 | |
138 | |
104 | #if IOM_TIME |
139 | template<class O, class M> |
105 | enum { TSTAMP_CANCEL = -1 }; |
140 | io_watcher (O object, M method) |
|
|
141 | : callback<void (io_watcher &, short)> (object, method) |
|
|
142 | { } |
|
|
143 | ~io_watcher () { stop (); } |
|
|
144 | }; |
|
|
145 | #endif |
106 | |
146 | |
|
|
147 | #if IOM_TIME |
107 | struct time_watcher : callback1<void, time_watcher &> { |
148 | struct time_watcher : watcher, callback<void (time_watcher &)> { |
108 | tstamp at; |
149 | tstamp at; |
109 | |
150 | |
110 | template<class O1, class O2> |
|
|
111 | time_watcher (O1 *object, void (O2::*method)(time_watcher &)) |
|
|
112 | : callback1<void, time_watcher &>(object,method) |
|
|
113 | { } |
|
|
114 | |
|
|
115 | ~time_watcher (); |
|
|
116 | |
|
|
117 | void trigger (); |
151 | void trigger (); |
118 | |
152 | |
119 | void set (tstamp when) { at = when; } |
153 | void set (tstamp when) { at = when; } |
120 | void operator ()() { trigger (); } |
154 | void operator () () { trigger (); } |
121 | void start () { iom.reg (this); } |
155 | void start () { io_manager::reg (*this); } |
122 | void start (tstamp when) { set (when); iom.reg (this); } |
156 | void start (tstamp when) { set (when); io_manager::reg (*this); } |
123 | void stop () { iom.unreg (this); } |
157 | void stop () { io_manager::unreg (*this); } |
124 | |
158 | |
125 | void reset (tstamp when = TSTAMP_CANCEL) |
159 | template<class O, class M> |
126 | { |
160 | time_watcher (O object, M method) |
127 | stop (); |
161 | : callback<void (time_watcher &)> (object, method), at (0) |
128 | at = when; |
|
|
129 | } |
162 | { } |
|
|
163 | ~time_watcher () { stop (); } |
130 | }; |
164 | }; |
131 | #endif |
165 | #endif |
132 | |
166 | |
133 | #if IOM_CHECK |
167 | #if IOM_CHECK |
134 | // run before checking for new events |
168 | // run before checking for new events |
135 | struct check_watcher : callback1<void, check_watcher &> { |
169 | struct check_watcher : watcher, callback<void (check_watcher &)> { |
|
|
170 | void start () { io_manager::reg (*this); } |
|
|
171 | void stop () { io_manager::unreg (*this); } |
|
|
172 | |
136 | template<class O1, class O2> |
173 | template<class O, class M> |
137 | check_watcher (O1 *object, void (O2::*method)(check_watcher &)) |
174 | check_watcher (O object, M method) |
138 | : callback1<void, check_watcher &>(object,method) |
175 | : callback<void (check_watcher &)> (object, method) |
|
|
176 | { } |
|
|
177 | ~check_watcher () { stop (); } |
|
|
178 | }; |
|
|
179 | #endif |
|
|
180 | |
|
|
181 | #if IOM_IDLE |
|
|
182 | // run after checking for any i/o, but before waiting |
|
|
183 | struct idle_watcher : watcher, callback<void (idle_watcher &)> { |
|
|
184 | void start () { io_manager::reg (*this); } |
|
|
185 | void stop () { io_manager::unreg (*this); } |
|
|
186 | |
|
|
187 | template<class O, class M> |
|
|
188 | idle_watcher (O object, M method) |
|
|
189 | : callback<void (idle_watcher &)> (object, method) |
139 | { } |
190 | { } |
|
|
191 | ~idle_watcher () { stop (); } |
|
|
192 | }; |
|
|
193 | #endif |
140 | |
194 | |
141 | ~check_watcher (); |
195 | #if IOM_SIG |
|
|
196 | struct sig_watcher : watcher, callback<void (sig_watcher &)> { |
|
|
197 | int signum; |
142 | |
198 | |
143 | void start () { iom.reg (this); } |
199 | void start (int signum); |
144 | void stop () { iom.unreg (this); } |
200 | void stop () { io_manager::unreg (*this); } |
145 | }; |
|
|
146 | #endif |
|
|
147 | |
201 | |
|
|
202 | template<class O, class M> |
|
|
203 | sig_watcher (O object, M method) |
|
|
204 | : callback<void(sig_watcher &)> (object, method), signum (0) |
|
|
205 | { } |
|
|
206 | ~sig_watcher () { stop (); } |
|
|
207 | }; |
148 | #endif |
208 | #endif |
149 | |
209 | |
|
|
210 | #if IOM_CHILD |
|
|
211 | struct child_watcher : watcher, callback<void (child_watcher &, int)> { |
|
|
212 | int /*pid_t*/ pid; |
|
|
213 | |
|
|
214 | void start (int pid) { this->pid = pid; io_manager::reg (*this); } |
|
|
215 | void stop () { io_manager::unreg (*this); } |
|
|
216 | |
|
|
217 | template<class O, class M> |
|
|
218 | child_watcher (O object, M method) |
|
|
219 | : callback<void (child_watcher &, int)> (object, method), pid (0) |
|
|
220 | { } |
|
|
221 | ~child_watcher () { stop (); } |
|
|
222 | }; |
|
|
223 | #endif |
|
|
224 | |
|
|
225 | #endif |
|
|
226 | |