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