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