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