1 | /* |
1 | /* |
2 | iom.h -- I/O multiplexor |
2 | iom.h -- generic I/O multiplexor |
|
|
3 | Copyright (C) 2003, 2004 Marc Lehmann <pcg@goof.com> |
3 | |
4 | |
4 | 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 |
5 | 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 |
6 | the Free Software Foundation; either version 2 of the License, or |
7 | the Free Software Foundation; either version 2 of the License, or |
7 | (at your option) any later version. |
8 | (at your option) any later version. |
… | |
… | |
14 | 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 |
15 | along with this program; if not, write to the Free Software |
16 | along with this program; if not, write to the Free Software |
16 | 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 |
17 | */ |
18 | */ |
18 | |
19 | |
19 | #ifndef VPE_IOM_H__ |
20 | #ifndef IOM_H__ |
20 | #define VPE_IOM_H__ |
21 | #define IOM_H__ |
21 | |
22 | |
22 | #include <vector> |
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" |
23 | |
28 | |
24 | #include <sys/poll.h> |
29 | #include "callback.h" |
25 | |
30 | |
26 | #include "slog.h" |
31 | #ifndef IOM_IO |
|
|
32 | # define IOM_IO 0 |
|
|
33 | #endif |
|
|
34 | #ifndef IOM_TIME |
|
|
35 | # define IOM_TIME 0 |
|
|
36 | #endif |
|
|
37 | #ifndef IOM_CHECK |
|
|
38 | # define IOM_CHECK 0 |
|
|
39 | #endif |
|
|
40 | #ifndef IOM_IDLE |
|
|
41 | # define IOM_IDLE 0 |
|
|
42 | #endif |
|
|
43 | #ifndef IOM_SIG |
|
|
44 | # define IOM_SIG 0 |
|
|
45 | #endif |
|
|
46 | #ifndef IOM_ACCURACY |
|
|
47 | # define IOM_ACCURACY 0.001 // start timers at most this much earlier (can be 0) |
|
|
48 | #endif |
27 | |
49 | |
28 | typedef double tstamp; |
50 | typedef double tstamp; |
29 | |
|
|
30 | extern tstamp NOW; |
51 | extern tstamp NOW; |
31 | |
52 | |
32 | template<class R, class A> class callback; |
53 | struct watcher; |
|
|
54 | #if IOM_IO |
33 | struct io_watcher; |
55 | struct io_watcher; |
|
|
56 | #endif |
|
|
57 | #if IOM_TIME |
34 | struct time_watcher; |
58 | struct time_watcher; |
|
|
59 | #endif |
|
|
60 | #if IOM_CHECK |
|
|
61 | struct check_watcher; |
|
|
62 | #endif |
|
|
63 | #if IOM_IDLE |
|
|
64 | struct idle_watcher; |
|
|
65 | #endif |
|
|
66 | #if IOM_SIG |
|
|
67 | struct sig_watcher; |
|
|
68 | #endif |
35 | |
69 | |
|
|
70 | template<class watcher> |
|
|
71 | struct io_manager_vec : vector<watcher *> { |
|
|
72 | void erase_unordered (unsigned int pos) |
|
|
73 | { |
|
|
74 | watcher *w = (*this)[this->size () - 1]; |
|
|
75 | this->pop_back (); |
|
|
76 | |
|
|
77 | if (this->size ()) |
|
|
78 | if (((*this)[pos] = w)) // '=' is correct! |
|
|
79 | w->active = pos + 1; |
|
|
80 | } |
|
|
81 | }; |
|
|
82 | |
|
|
83 | // only used as a namespace, and for initialisation purposes |
36 | class io_manager { |
84 | class io_manager { |
37 | vector<pollfd> pfs; |
85 | template<class watcher> |
38 | vector<io_watcher *> iow; |
86 | static void reg (watcher &w, io_manager_vec<watcher> &queue); |
39 | vector<time_watcher *> tw; // actually a heap |
87 | |
|
|
88 | template<class watcher> |
|
|
89 | static void unreg (watcher &w, io_manager_vec<watcher> &queue); |
|
|
90 | |
40 | public: |
91 | public: |
41 | |
|
|
42 | // register a watcher |
92 | // register a watcher |
43 | void reg (int fd, short events, io_watcher *w); |
93 | #if IOM_IO |
44 | void unreg (io_watcher *w); |
94 | static void reg (io_watcher &w); static void unreg (io_watcher &w); |
45 | void reg (time_watcher *w); |
95 | #endif |
46 | void unreg (time_watcher *w); |
96 | #if IOM_TIME |
|
|
97 | static void reg (time_watcher &w); static void unreg (time_watcher &w); |
|
|
98 | #endif |
|
|
99 | #if IOM_CHECK |
|
|
100 | static void reg (check_watcher &w); static void unreg (check_watcher &w); |
|
|
101 | #endif |
|
|
102 | #if IOM_IDLE |
|
|
103 | static void reg (idle_watcher &w); static void unreg (idle_watcher &w); |
|
|
104 | #endif |
|
|
105 | #if IOM_SIG |
|
|
106 | static void reg (sig_watcher &w); static void unreg (sig_watcher &w); |
|
|
107 | #endif |
47 | |
108 | |
48 | void loop (); |
109 | static void loop (); |
49 | |
|
|
50 | io_manager (); |
|
|
51 | ~io_manager (); |
|
|
52 | }; |
110 | }; |
53 | |
111 | |
54 | extern io_manager iom; |
112 | struct watcher { |
|
|
113 | int active; /* 0 == inactive, else index into respective vector */ |
55 | |
114 | |
|
|
115 | watcher () : active (0) { } |
|
|
116 | }; |
|
|
117 | |
|
|
118 | #if IOM_IO |
|
|
119 | enum { EVENT_READ = 1, EVENT_WRITE = 2 }; |
|
|
120 | |
|
|
121 | struct io_watcher : watcher, callback2<void, io_watcher &, short> { |
|
|
122 | int fd; |
|
|
123 | short events; |
|
|
124 | |
|
|
125 | void set (int fd_, short events_) { fd = fd_; events = events_; } |
|
|
126 | |
|
|
127 | void set (short events_) { set (fd, events_); } |
|
|
128 | void start () { io_manager::reg (*this); } |
|
|
129 | void start (int fd_, short events_) { set (fd_, events_); io_manager::reg (*this); } |
|
|
130 | void stop () { io_manager::unreg (*this); } |
|
|
131 | |
56 | template<class R, class A> |
132 | template<class O1, class O2> |
57 | class callback { |
|
|
58 | struct object { }; |
|
|
59 | |
|
|
60 | void *obj; |
|
|
61 | R (object::*meth)(A arg); |
|
|
62 | |
|
|
63 | // a proxy is a kind of recipe on how to call a specific class method |
|
|
64 | struct proxy_base { |
|
|
65 | virtual R call (void *obj, void (object::*meth)(A), A arg) = 0; |
|
|
66 | }; |
|
|
67 | template<class O1, class O2> |
|
|
68 | struct proxy : proxy_base { |
|
|
69 | virtual R call (void *obj, void (object::*meth)(A), A arg) |
|
|
70 | { |
|
|
71 | ((reinterpret_cast<O1 *>(obj)) ->* (reinterpret_cast<void (O2::*)(A)>(meth))) |
|
|
72 | (arg); |
|
|
73 | } |
|
|
74 | }; |
|
|
75 | |
|
|
76 | proxy_base *prxy; |
|
|
77 | |
|
|
78 | public: |
|
|
79 | template<class O1, class O2> |
|
|
80 | callback (O1 *object, void (O2::*method)(A)) |
|
|
81 | { |
|
|
82 | static proxy<O1,O2> p; |
|
|
83 | obj = reinterpret_cast<void *>(object); |
|
|
84 | meth = reinterpret_cast<void (object::*)(A)>(method); |
|
|
85 | prxy = &p; |
|
|
86 | } |
|
|
87 | |
|
|
88 | R call(A arg) |
|
|
89 | { |
|
|
90 | return prxy->call (obj, meth, arg); |
|
|
91 | } |
|
|
92 | |
|
|
93 | void stop () |
|
|
94 | { |
|
|
95 | iom.unreg (this); |
|
|
96 | } |
|
|
97 | }; |
|
|
98 | |
|
|
99 | struct io_watcher : callback<void, short> { |
|
|
100 | template<class O1, class O2> |
|
|
101 | io_watcher (O1 *object, void (O2::*method)(short revents)) |
133 | io_watcher (O1 *object, void (O2::*method) (io_watcher &, short)) |
|
|
134 | : callback2<void, io_watcher &, short> (object,method) |
|
|
135 | { } |
|
|
136 | ~io_watcher () { stop (); } |
|
|
137 | }; |
|
|
138 | #endif |
|
|
139 | |
|
|
140 | #if IOM_TIME |
|
|
141 | struct time_watcher : watcher, callback1<void, time_watcher &> { |
|
|
142 | tstamp at; |
|
|
143 | |
|
|
144 | void trigger (); |
|
|
145 | |
|
|
146 | void set (tstamp when) { at = when; } |
|
|
147 | void operator () () { trigger (); } |
|
|
148 | void start () { io_manager::reg (*this); } |
|
|
149 | void start (tstamp when) { set (when); io_manager::reg (*this); } |
|
|
150 | void stop () { io_manager::unreg (*this); } |
|
|
151 | |
|
|
152 | template<class O1, class O2> |
|
|
153 | time_watcher (O1 *object, void (O2::*method) (time_watcher &)) |
|
|
154 | : callback1<void, time_watcher &> (object,method), at (0) |
|
|
155 | { } |
|
|
156 | ~time_watcher () { stop (); } |
|
|
157 | }; |
|
|
158 | #endif |
|
|
159 | |
|
|
160 | #if IOM_CHECK |
|
|
161 | // run before checking for new events |
|
|
162 | struct check_watcher : watcher, callback1<void, check_watcher &> { |
|
|
163 | void start () { io_manager::reg (*this); } |
|
|
164 | void stop () { io_manager::unreg (*this); } |
|
|
165 | |
|
|
166 | template<class O1, class O2> |
|
|
167 | check_watcher (O1 *object, void (O2::*method) (check_watcher &)) |
|
|
168 | : callback1<void, check_watcher &> (object,method) |
|
|
169 | { } |
|
|
170 | ~check_watcher () { stop (); } |
|
|
171 | }; |
|
|
172 | #endif |
|
|
173 | |
|
|
174 | #if IOM_IDLE |
|
|
175 | // run after checking for any i/o, but before waiting |
|
|
176 | struct idle_watcher : watcher, callback1<void, idle_watcher &> { |
|
|
177 | void start () { io_manager::reg (*this); } |
|
|
178 | void stop () { io_manager::unreg (*this); } |
|
|
179 | |
|
|
180 | template<class O1, class O2> |
|
|
181 | idle_watcher (O1 *object, void (O2::*method) (idle_watcher &)) |
102 | : callback<void, short>(object,method) |
182 | : callback1<void, idle_watcher &> (object,method) |
103 | { } |
183 | { } |
104 | |
184 | ~idle_watcher () { stop (); } |
105 | void start (int fd, short events) |
|
|
106 | { |
|
|
107 | iom.reg (fd, events, this); |
|
|
108 | } |
|
|
109 | |
|
|
110 | }; |
185 | }; |
|
|
186 | #endif |
111 | |
187 | |
112 | struct time_watcher : callback<void, tstamp &> { |
188 | #if IOM_SIG |
113 | tstamp at; |
189 | struct sig_watcher : watcher, callback1<void, sig_watcher &> { |
|
|
190 | int signum; |
114 | |
191 | |
|
|
192 | void start (int signum); |
|
|
193 | void stop () { io_manager::unreg (*this); } |
|
|
194 | |
115 | template<class O1, class O2> |
195 | template<class O1, class O2> |
116 | time_watcher (O1 *object, void (O2::*method)(tstamp &)) |
196 | sig_watcher (O1 *object, void (O2::*method) (sig_watcher &)) |
117 | : callback<void, tstamp &>(object,method) |
197 | : callback1<void, sig_watcher &> (object,method), signum (-1) |
118 | { } |
198 | { } |
119 | |
199 | ~sig_watcher () { stop (); } |
120 | void set (tstamp when); |
|
|
121 | |
|
|
122 | void trigger () |
|
|
123 | { |
|
|
124 | call (at); |
|
|
125 | } |
|
|
126 | |
|
|
127 | void start (tstamp when = NOW) |
|
|
128 | { |
|
|
129 | set (when); |
|
|
130 | } |
|
|
131 | }; |
200 | }; |
132 | |
|
|
133 | #endif |
201 | #endif |
134 | |
202 | |
|
|
203 | #endif |
|
|
204 | |