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 <pcg@goof.com> |
4 | |
4 | |
5 | This program is free software; you can redistribute it and/or modify |
5 | This program is free software; you can redistribute it and/or modify |
6 | it under the terms of the GNU General Public License as published by |
6 | 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 |
7 | the Free Software Foundation; either version 2 of the License, or |
8 | (at your option) any later version. |
8 | (at your option) any later version. |
… | |
… | |
15 | You should have received a copy of the GNU General Public License |
15 | You should have received a copy of the GNU General Public License |
16 | along with this program; if not, write to the Free Software |
16 | along with this program; if not, write to the Free Software |
17 | Foundation, Inc. 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
17 | Foundation, Inc. 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
18 | */ |
18 | */ |
19 | |
19 | |
20 | #ifndef VPE_IOM_H__ |
20 | #ifndef IOM_H__ |
21 | #define VPE_IOM_H__ |
21 | #define IOM_H__ |
22 | |
22 | |
23 | #include <cassert> |
23 | // required: |
|
|
24 | // - a vector template like simplevec or stl's vector |
|
|
25 | // - defines for all watcher types required in your app |
|
|
26 | // edit iom_conf.h as appropriate. |
|
|
27 | #include "iom_conf.h" |
24 | |
28 | |
25 | #include "callback.h" |
29 | #include "callback.h" |
26 | #include "rxvtvec.h" |
|
|
27 | |
30 | |
28 | #ifndef IOM_IO |
31 | #ifndef IOM_IO |
29 | # define IOM_IO 1 |
32 | # define IOM_IO 0 |
30 | #endif |
33 | #endif |
31 | #ifndef IOM_TIME |
34 | #ifndef IOM_TIME |
32 | # define IOM_TIME 1 |
35 | # define IOM_TIME 0 |
33 | #endif |
36 | #endif |
34 | #ifndef IOM_CHECK |
37 | #ifndef IOM_CHECK |
35 | # define IOM_CHECK 1 |
38 | # define IOM_CHECK 0 |
36 | #endif |
39 | #endif |
37 | #ifndef IOM_IDLE |
40 | #ifndef IOM_IDLE |
38 | # define IOM_IDLE 0 |
41 | # define IOM_IDLE 0 |
39 | #endif |
42 | #endif |
|
|
43 | #ifndef IOM_SIG |
|
|
44 | # define IOM_SIG 0 |
|
|
45 | #endif |
40 | |
46 | |
41 | typedef double tstamp; |
47 | typedef double tstamp; |
42 | extern tstamp NOW; |
48 | extern tstamp NOW; |
43 | |
49 | |
|
|
50 | struct watcher; |
44 | #if IOM_IO |
51 | #if IOM_IO |
45 | struct io_watcher; |
52 | struct io_watcher; |
46 | #endif |
53 | #endif |
47 | #if IOM_TIME |
54 | #if IOM_TIME |
48 | struct time_watcher; |
55 | struct time_watcher; |
49 | #endif |
56 | #endif |
50 | #if IOM_CHECK |
57 | #if IOM_CHECK |
51 | struct check_watcher; |
58 | struct check_watcher; |
52 | #endif |
59 | #endif |
53 | #if IOM_IDLE |
60 | #if IOM_IDLE |
54 | struct idle_watcher; |
61 | struct idle_watcher; |
|
|
62 | #endif |
|
|
63 | #if IOM_SIG |
|
|
64 | struct sig_watcher; |
55 | #endif |
65 | #endif |
56 | |
66 | |
57 | template<class watcher> |
67 | template<class watcher> |
58 | struct io_manager_vec : protected simplevec<watcher *> { |
68 | struct io_manager_vec : vector<watcher *> { |
59 | friend class io_manager; |
|
|
60 | protected: |
|
|
61 | void erase_unordered (unsigned int pos) |
69 | void erase_unordered (unsigned int pos) |
62 | { |
70 | { |
63 | watcher *w = (*this)[size () - 1]; |
71 | watcher *w = (*this)[this->size () - 1]; |
64 | pop_back (); |
72 | this->pop_back (); |
65 | |
73 | |
66 | if (size ()) |
74 | if (!this->empty ()) |
67 | if ((*this)[pos] = w) |
75 | if (((*this)[pos] = w)) // '=' is correct! |
68 | w->active = pos + 1; |
76 | w->active = pos + 1; |
69 | } |
77 | } |
70 | }; |
78 | }; |
71 | |
79 | |
|
|
80 | // only used as a namespace, and for initialisation purposes |
72 | class io_manager { |
81 | class io_manager { |
73 | #if IOM_IO |
|
|
74 | io_manager_vec<io_watcher> iow; |
|
|
75 | #endif |
|
|
76 | #if IOM_CHECK |
|
|
77 | io_manager_vec<check_watcher> cw; |
|
|
78 | #endif |
|
|
79 | #if IOM_TIME |
|
|
80 | io_manager_vec<time_watcher> tw; |
|
|
81 | #endif |
|
|
82 | #if IOM_IDLE |
|
|
83 | io_manager_vec<idle_watcher> iw; |
|
|
84 | #endif |
|
|
85 | |
|
|
86 | template<class watcher> |
82 | template<class watcher> |
87 | void reg (watcher *w, simplevec<watcher *> &queue); |
83 | static void reg (watcher &w, io_manager_vec<watcher> &queue); |
88 | |
84 | |
89 | template<class watcher> |
85 | template<class watcher> |
90 | void unreg (watcher *w, simplevec<watcher *> &queue); |
86 | static void unreg (watcher &w, io_manager_vec<watcher> &queue); |
91 | |
87 | |
92 | public: |
88 | public: |
|
|
89 | #if IOM_TIME |
|
|
90 | // fetch time only |
|
|
91 | static tstamp now (); |
|
|
92 | |
|
|
93 | // set NOW |
|
|
94 | static void set_now (); |
|
|
95 | #endif |
|
|
96 | |
93 | // register a watcher |
97 | // register a watcher |
94 | #if IOM_IO |
98 | #if IOM_IO |
95 | void reg (io_watcher *w); void unreg (io_watcher *w); |
99 | static void reg (io_watcher &w); static void unreg (io_watcher &w); |
96 | #endif |
100 | #endif |
97 | #if IOM_TIME |
101 | #if IOM_TIME |
98 | void reg (time_watcher *w); void unreg (time_watcher *w); |
102 | static void reg (time_watcher &w); static void unreg (time_watcher &w); |
99 | #endif |
103 | #endif |
100 | #if IOM_CHECK |
104 | #if IOM_CHECK |
101 | void reg (check_watcher *w); void unreg (check_watcher *w); |
105 | static void reg (check_watcher &w); static void unreg (check_watcher &w); |
102 | #endif |
106 | #endif |
103 | #if IOM_IDLE |
107 | #if IOM_IDLE |
104 | void reg (idle_watcher *w); void unreg (idle_watcher *w); |
108 | static void reg (idle_watcher &w); static void unreg (idle_watcher &w); |
|
|
109 | #endif |
|
|
110 | #if IOM_SIG |
|
|
111 | static void reg (sig_watcher &w); static void unreg (sig_watcher &w); |
105 | #endif |
112 | #endif |
106 | |
113 | |
107 | void loop (); |
114 | static void loop (); |
108 | |
|
|
109 | io_manager (); |
|
|
110 | ~io_manager (); |
|
|
111 | }; |
115 | }; |
112 | |
|
|
113 | extern io_manager iom; // a singleton, together with it's construction/destruction problems. |
|
|
114 | |
116 | |
115 | struct watcher { |
117 | struct watcher { |
116 | int active; /* 0 == inactive, else index into respective vector */ |
118 | int active; /* 0 == inactive, else index into respective vector */ |
117 | |
119 | |
118 | watcher() : active(0) { } |
120 | watcher () : active (0) { } |
119 | }; |
121 | }; |
120 | |
122 | |
121 | #if IOM_IO |
123 | #if IOM_IO |
122 | enum { EVENT_READ = 1, EVENT_WRITE = 2 }; |
124 | enum { EVENT_READ = 1, EVENT_WRITE = 2 }; |
123 | |
125 | |
… | |
… | |
126 | short events; |
128 | short events; |
127 | |
129 | |
128 | void set (int fd_, short events_) { fd = fd_; events = events_; } |
130 | void set (int fd_, short events_) { fd = fd_; events = events_; } |
129 | |
131 | |
130 | void set (short events_) { set (fd, events_); } |
132 | void set (short events_) { set (fd, events_); } |
131 | void start () { iom.reg (this); } |
133 | void start () { io_manager::reg (*this); } |
132 | void start (int fd_, short events_) { set (fd_, events_); iom.reg (this); } |
134 | void start (int fd_, short events_) { set (fd_, events_); io_manager::reg (*this); } |
133 | void stop () { iom.unreg (this); } |
135 | void stop () { io_manager::unreg (*this); } |
134 | |
136 | |
135 | template<class O1, class O2> |
137 | template<class O1, class O2> |
136 | io_watcher (O1 *object, void (O2::*method)(io_watcher &, short)) |
138 | io_watcher (O1 *object, void (O2::*method) (io_watcher &, short)) |
137 | : callback2<void, io_watcher &, short>(object,method) |
139 | : callback2<void, io_watcher &, short> (object,method) |
138 | { } |
140 | { } |
139 | ~io_watcher () { stop (); } |
141 | ~io_watcher () { stop (); } |
140 | }; |
142 | }; |
141 | #endif |
143 | #endif |
142 | |
144 | |
… | |
… | |
145 | tstamp at; |
147 | tstamp at; |
146 | |
148 | |
147 | void trigger (); |
149 | void trigger (); |
148 | |
150 | |
149 | void set (tstamp when) { at = when; } |
151 | void set (tstamp when) { at = when; } |
150 | void operator ()() { trigger (); } |
152 | void operator () () { trigger (); } |
151 | void start () { iom.reg (this); } |
153 | void start () { io_manager::reg (*this); } |
152 | void start (tstamp when) { set (when); iom.reg (this); } |
154 | void start (tstamp when) { set (when); io_manager::reg (*this); } |
153 | void stop () { iom.unreg (this); } |
155 | void stop () { io_manager::unreg (*this); } |
154 | |
156 | |
155 | template<class O1, class O2> |
157 | template<class O1, class O2> |
156 | time_watcher (O1 *object, void (O2::*method)(time_watcher &)) |
158 | time_watcher (O1 *object, void (O2::*method) (time_watcher &)) |
157 | : callback1<void, time_watcher &>(object,method) |
159 | : callback1<void, time_watcher &> (object,method), at (0) |
158 | { } |
160 | { } |
159 | ~time_watcher () { stop (); } |
161 | ~time_watcher () { stop (); } |
160 | }; |
162 | }; |
161 | #endif |
163 | #endif |
162 | |
164 | |
163 | #if IOM_CHECK |
165 | #if IOM_CHECK |
164 | // run before checking for new events |
166 | // run before checking for new events |
165 | struct check_watcher : watcher, callback1<void, check_watcher &> { |
167 | struct check_watcher : watcher, callback1<void, check_watcher &> { |
166 | void start () { iom.reg (this); } |
168 | void start () { io_manager::reg (*this); } |
167 | void stop () { iom.unreg (this); } |
169 | void stop () { io_manager::unreg (*this); } |
168 | |
170 | |
169 | template<class O1, class O2> |
171 | template<class O1, class O2> |
170 | check_watcher (O1 *object, void (O2::*method)(check_watcher &)) |
172 | check_watcher (O1 *object, void (O2::*method) (check_watcher &)) |
171 | : callback1<void, check_watcher &>(object,method) |
173 | : callback1<void, check_watcher &> (object,method) |
172 | { } |
174 | { } |
173 | ~check_watcher () { stop (); } |
175 | ~check_watcher () { stop (); } |
174 | }; |
176 | }; |
175 | #endif |
177 | #endif |
176 | |
178 | |
177 | #if IOM_IDLE |
179 | #if IOM_IDLE |
178 | // run after checking for any i/o, but before waiting |
180 | // run after checking for any i/o, but before waiting |
179 | struct idle_watcher : watcher, callback1<void, idle_watcher &> { |
181 | struct idle_watcher : watcher, callback1<void, idle_watcher &> { |
180 | void start () { iom.reg (this); } |
182 | void start () { io_manager::reg (*this); } |
181 | void stop () { iom.unreg (this); } |
183 | void stop () { io_manager::unreg (*this); } |
182 | |
184 | |
183 | template<class O1, class O2> |
185 | template<class O1, class O2> |
184 | idle_watcher (O1 *object, void (O2::*method)(idle_watcher &)) |
186 | idle_watcher (O1 *object, void (O2::*method) (idle_watcher &)) |
185 | : callback1<void, idle_watcher &>(object,method) |
187 | : callback1<void, idle_watcher &> (object,method) |
186 | { } |
188 | { } |
187 | ~idle_watcher () { stop (); } |
189 | ~idle_watcher () { stop (); } |
188 | }; |
190 | }; |
189 | #endif |
191 | #endif |
190 | |
192 | |
191 | #endif |
193 | #if IOM_SIG |
|
|
194 | struct sig_watcher : watcher, callback1<void, sig_watcher &> { |
|
|
195 | int signum; |
192 | |
196 | |
|
|
197 | void start (int signum); |
|
|
198 | void stop () { io_manager::unreg (*this); } |
|
|
199 | |
|
|
200 | template<class O1, class O2> |
|
|
201 | sig_watcher (O1 *object, void (O2::*method) (sig_watcher &)) |
|
|
202 | : callback1<void, sig_watcher &> (object,method), signum (-1) |
|
|
203 | { } |
|
|
204 | ~sig_watcher () { stop (); } |
|
|
205 | }; |
|
|
206 | #endif |
|
|
207 | |
|
|
208 | #endif |
|
|
209 | |