| 1 |
/* |
| 2 |
iom.C -- generic I/O multiplexor |
| 3 |
Copyright (C) 2003, 2004 Marc Lehmann <pcg@goof.com> |
| 4 |
|
| 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 |
| 7 |
the Free Software Foundation; either version 2 of the License, or |
| 8 |
(at your option) any later version. |
| 9 |
|
| 10 |
This program is distributed in the hope that it will be useful, |
| 11 |
but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 12 |
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 13 |
GNU General Public License for more details. |
| 14 |
|
| 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 |
| 17 |
Foundation, Inc. 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
| 18 |
*/ |
| 19 |
|
| 20 |
#include "iom.h" |
| 21 |
|
| 22 |
#include <cstdio> |
| 23 |
#include <cstdlib> |
| 24 |
#include <cerrno> |
| 25 |
|
| 26 |
#include <sys/time.h> |
| 27 |
|
| 28 |
#include <assert.h> |
| 29 |
|
| 30 |
#if 1 // older unices need these includes for select (2) |
| 31 |
# include <unistd.h> |
| 32 |
# include <sys/types.h> |
| 33 |
# include <time.h> |
| 34 |
#endif |
| 35 |
|
| 36 |
// for IOM_SIG |
| 37 |
#if IOM_SIG |
| 38 |
# include <signal.h> |
| 39 |
# include <fcntl.h> |
| 40 |
#endif |
| 41 |
|
| 42 |
// if the BSDs would at least be marginally POSIX-compatible.. *sigh* |
| 43 |
// until that happens, sys/select.h must come last |
| 44 |
#include <sys/select.h> |
| 45 |
|
| 46 |
// TSTAMP_MAX must still fit into a positive struct timeval |
| 47 |
#define TSTAMP_MAX (double)(1UL<<31) |
| 48 |
|
| 49 |
#define TIMEVAL timeval |
| 50 |
#define TV_FRAC tv_usec |
| 51 |
#define TV_MULT 1000000L |
| 52 |
|
| 53 |
#if IOM_IO |
| 54 |
static io_manager_vec<io_watcher> iow; |
| 55 |
#endif |
| 56 |
#if IOM_CHECK |
| 57 |
static io_manager_vec<check_watcher> cw; |
| 58 |
#endif |
| 59 |
#if IOM_TIME |
| 60 |
static io_manager_vec<time_watcher> tw; |
| 61 |
#endif |
| 62 |
#if IOM_IDLE |
| 63 |
static io_manager_vec<idle_watcher> iw; |
| 64 |
#endif |
| 65 |
#if IOM_SIG |
| 66 |
static int sigpipe[2]; // signal signalling pipe |
| 67 |
static sigset_t sigs; |
| 68 |
struct sig_vec : io_manager_vec<sig_watcher> { |
| 69 |
int pending; |
| 70 |
sig_vec () |
| 71 |
: pending (false) |
| 72 |
{ } |
| 73 |
}; |
| 74 |
static vector<sig_vec *> sw; |
| 75 |
#endif |
| 76 |
|
| 77 |
// this is a dummy time watcher to ensure that the first |
| 78 |
// time watcher is _always_ valid, this gets rid of a lot |
| 79 |
// of null-pointer-checks |
| 80 |
// (must come _before_ iom is being defined) |
| 81 |
static struct tw0 : time_watcher |
| 82 |
{ |
| 83 |
void cb (time_watcher &w) |
| 84 |
{ |
| 85 |
// should never get called |
| 86 |
// reached end-of-time, or tstamp has a bogus definition, |
| 87 |
// or compiler initialisation order broken, or something else :) |
| 88 |
abort (); |
| 89 |
} |
| 90 |
|
| 91 |
tw0 () |
| 92 |
: time_watcher (this, &tw0::cb) |
| 93 |
{ } |
| 94 |
} tw0; |
| 95 |
|
| 96 |
tstamp NOW; |
| 97 |
|
| 98 |
#if IOM_TIME |
| 99 |
inline void set_now (void) |
| 100 |
{ |
| 101 |
struct timeval tv; |
| 102 |
|
| 103 |
gettimeofday (&tv, 0); |
| 104 |
NOW = (tstamp)tv.tv_sec + (tstamp)tv.tv_usec / 1000000.; |
| 105 |
} |
| 106 |
#endif |
| 107 |
|
| 108 |
static bool iom_valid; |
| 109 |
|
| 110 |
// used for initialisation only |
| 111 |
static struct init { |
| 112 |
init () |
| 113 |
{ |
| 114 |
#if IOM_SIG |
| 115 |
sigemptyset (&sigs); |
| 116 |
|
| 117 |
if (pipe (sigpipe)) |
| 118 |
{ |
| 119 |
perror ("io_manager: unable to create signal pipe, aborting."); |
| 120 |
abort (); |
| 121 |
} |
| 122 |
|
| 123 |
fcntl (sigpipe[0], F_SETFL, O_NONBLOCK); |
| 124 |
fcntl (sigpipe[1], F_SETFL, O_NONBLOCK); |
| 125 |
#endif |
| 126 |
|
| 127 |
iom_valid = true; |
| 128 |
|
| 129 |
#if IOM_TIME |
| 130 |
set_now (); |
| 131 |
|
| 132 |
tw0.start (TSTAMP_MAX); |
| 133 |
#endif |
| 134 |
} |
| 135 |
|
| 136 |
static void required (); |
| 137 |
} init; |
| 138 |
|
| 139 |
void |
| 140 |
init::required () |
| 141 |
{ |
| 142 |
if (!iom_valid) |
| 143 |
{ |
| 144 |
write (2, "io_manager: early registration attempt, aborting.\n", |
| 145 |
sizeof ("io_manager: early registration attempt, aborting.\n") - 1); |
| 146 |
abort (); |
| 147 |
} |
| 148 |
} |
| 149 |
|
| 150 |
template<class watcher> |
| 151 |
void io_manager::reg (watcher &w, io_manager_vec<watcher> &queue) |
| 152 |
{ |
| 153 |
init::required (); |
| 154 |
|
| 155 |
if (!w.active) |
| 156 |
{ |
| 157 |
#if IOM_CHECK |
| 158 |
queue.activity = true; |
| 159 |
#endif |
| 160 |
queue.push_back (&w); |
| 161 |
w.active = queue.size (); |
| 162 |
} |
| 163 |
} |
| 164 |
|
| 165 |
template<class watcher> |
| 166 |
void io_manager::unreg (watcher &w, io_manager_vec<watcher> &queue) |
| 167 |
{ |
| 168 |
if (!iom_valid) |
| 169 |
return; |
| 170 |
|
| 171 |
if (w.active) |
| 172 |
{ |
| 173 |
queue [w.active - 1] = 0; |
| 174 |
w.active = 0; |
| 175 |
} |
| 176 |
} |
| 177 |
|
| 178 |
#if IOM_TIME |
| 179 |
void time_watcher::trigger () |
| 180 |
{ |
| 181 |
call (*this); |
| 182 |
io_manager::reg (*this); |
| 183 |
} |
| 184 |
|
| 185 |
void io_manager::reg (time_watcher &w) { io_manager::reg (w, tw); } |
| 186 |
void io_manager::unreg (time_watcher &w) { io_manager::unreg (w, tw); } |
| 187 |
#endif |
| 188 |
|
| 189 |
#if IOM_IO |
| 190 |
void io_manager::reg (io_watcher &w) { io_manager::reg (w, iow); } |
| 191 |
void io_manager::unreg (io_watcher &w) { io_manager::unreg (w, iow); } |
| 192 |
#endif |
| 193 |
|
| 194 |
#if IOM_CHECK |
| 195 |
void io_manager::reg (check_watcher &w) { io_manager::reg (w, cw); } |
| 196 |
void io_manager::unreg (check_watcher &w) { io_manager::unreg (w, cw); } |
| 197 |
#endif |
| 198 |
|
| 199 |
#if IOM_IDLE |
| 200 |
void io_manager::reg (idle_watcher &w) { io_manager::reg (w, iw); } |
| 201 |
void io_manager::unreg (idle_watcher &w) { io_manager::unreg (w, iw); } |
| 202 |
#endif |
| 203 |
|
| 204 |
#if IOM_SIG |
| 205 |
static void |
| 206 |
sighandler (int signum) |
| 207 |
{ |
| 208 |
sw [signum - 1]->pending = true; |
| 209 |
|
| 210 |
// we use a pipe for signal notifications, as most current |
| 211 |
// OSes (Linux...) do not implement pselect correctly. ugh. |
| 212 |
char ch = signum; // actual content not used |
| 213 |
write (sigpipe[1], &ch, 1); |
| 214 |
} |
| 215 |
|
| 216 |
void io_manager::reg (sig_watcher &w) |
| 217 |
{ |
| 218 |
assert (0 < w.signum); |
| 219 |
|
| 220 |
sw.reserve (w.signum); |
| 221 |
|
| 222 |
while (sw.size () < w.signum) // pathetic |
| 223 |
sw.push_back (0); |
| 224 |
|
| 225 |
sig_vec *&sv = sw[w.signum - 1]; |
| 226 |
|
| 227 |
if (!sv) |
| 228 |
{ |
| 229 |
sv = new sig_vec; |
| 230 |
|
| 231 |
sigaddset (&sigs, w.signum); |
| 232 |
sigprocmask (SIG_BLOCK, &sigs, NULL); |
| 233 |
|
| 234 |
struct sigaction sa; |
| 235 |
sa.sa_handler = sighandler; |
| 236 |
sigfillset (&sa.sa_mask); |
| 237 |
sa.sa_flags = SA_RESTART; |
| 238 |
|
| 239 |
if (sigaction (w.signum, &sa, 0)) |
| 240 |
{ |
| 241 |
perror ("io_manager: error while installing signal handler, ignoring."); |
| 242 |
abort (); |
| 243 |
} |
| 244 |
|
| 245 |
} |
| 246 |
|
| 247 |
io_manager::reg (w, *sv); |
| 248 |
} |
| 249 |
|
| 250 |
void io_manager::unreg (sig_watcher &w) |
| 251 |
{ |
| 252 |
if (!w.active) |
| 253 |
return; |
| 254 |
|
| 255 |
assert (0 < w.signum && w.signum <= sw.size ()); |
| 256 |
|
| 257 |
io_manager::unreg (w, *sw[w.signum - 1]); |
| 258 |
} |
| 259 |
|
| 260 |
void sig_watcher::start (int signum) |
| 261 |
{ |
| 262 |
stop (); |
| 263 |
this->signum = signum; |
| 264 |
io_manager::reg (*this); |
| 265 |
} |
| 266 |
#endif |
| 267 |
|
| 268 |
void io_manager::loop () |
| 269 |
{ |
| 270 |
init::required (); |
| 271 |
|
| 272 |
#if IOM_TIME |
| 273 |
set_now (); |
| 274 |
#endif |
| 275 |
|
| 276 |
for (;;) |
| 277 |
{ |
| 278 |
struct TIMEVAL *to = 0; |
| 279 |
struct TIMEVAL tval; |
| 280 |
|
| 281 |
#if IOM_IDLE |
| 282 |
if (iw.size ()) |
| 283 |
{ |
| 284 |
tval.tv_sec = 0; |
| 285 |
tval.TV_FRAC = 0; |
| 286 |
to = &tval; |
| 287 |
} |
| 288 |
else |
| 289 |
#endif |
| 290 |
{ |
| 291 |
#if IOM_TIME |
| 292 |
time_watcher *next; |
| 293 |
|
| 294 |
for (;;) |
| 295 |
{ |
| 296 |
next = tw[0]; // the first time-watcher must exist at ALL times |
| 297 |
|
| 298 |
for (int i = tw.size (); i--; ) |
| 299 |
if (!tw[i]) |
| 300 |
tw.erase_unordered (i); |
| 301 |
else if (tw[i]->at < next->at) |
| 302 |
next = tw[i]; |
| 303 |
|
| 304 |
if (next->at > NOW) |
| 305 |
{ |
| 306 |
if (next != tw[0]) |
| 307 |
{ |
| 308 |
double diff = next->at - NOW; |
| 309 |
tval.tv_sec = (int)diff; |
| 310 |
tval.TV_FRAC = (int) ((diff - tval.tv_sec) * TV_MULT); |
| 311 |
to = &tval; |
| 312 |
} |
| 313 |
break; |
| 314 |
} |
| 315 |
else |
| 316 |
{ |
| 317 |
unreg (*next); |
| 318 |
next->call (*next); |
| 319 |
} |
| 320 |
} |
| 321 |
#endif |
| 322 |
} |
| 323 |
|
| 324 |
#if IOM_CHECK |
| 325 |
tw.activity = false; |
| 326 |
|
| 327 |
for (int i = cw.size (); i--; ) |
| 328 |
if (!cw[i]) |
| 329 |
cw.erase_unordered (i); |
| 330 |
else |
| 331 |
cw[i]->call (*cw[i]); |
| 332 |
|
| 333 |
if (tw.activity) |
| 334 |
{ |
| 335 |
tval.tv_sec = 0; |
| 336 |
tval.TV_FRAC = 0; |
| 337 |
to = &tval; |
| 338 |
} |
| 339 |
#endif |
| 340 |
|
| 341 |
#if IOM_IO || IOM_SIG |
| 342 |
fd_set rfd, wfd; |
| 343 |
|
| 344 |
FD_ZERO (&rfd); |
| 345 |
FD_ZERO (&wfd); |
| 346 |
|
| 347 |
int fds = 0; |
| 348 |
|
| 349 |
# if IOM_IO |
| 350 |
for (io_manager_vec<io_watcher>::iterator i = iow.end (); i-- > iow.begin (); ) |
| 351 |
if (*i) |
| 352 |
{ |
| 353 |
if ((*i)->events & EVENT_READ ) FD_SET ((*i)->fd, &rfd); |
| 354 |
if ((*i)->events & EVENT_WRITE) FD_SET ((*i)->fd, &wfd); |
| 355 |
|
| 356 |
if ((*i)->fd >= fds) fds = (*i)->fd + 1; |
| 357 |
} |
| 358 |
# endif |
| 359 |
|
| 360 |
if (!to && !fds) //TODO: also check idle_watchers and check_watchers |
| 361 |
break; // no events |
| 362 |
|
| 363 |
# if IOM_SIG |
| 364 |
FD_SET (sigpipe[0], &rfd); |
| 365 |
if (sigpipe[0] >= fds) fds = sigpipe[0] + 1; |
| 366 |
# endif |
| 367 |
|
| 368 |
# if IOM_SIG |
| 369 |
// there is no race, as we use a pipe for signals, so select |
| 370 |
// will return if a signal is caught. |
| 371 |
sigprocmask (SIG_UNBLOCK, &sigs, NULL); |
| 372 |
# endif |
| 373 |
fds = select (fds, &rfd, &wfd, NULL, to); |
| 374 |
# if IOM_SIG |
| 375 |
sigprocmask (SIG_BLOCK, &sigs, NULL); |
| 376 |
# endif |
| 377 |
|
| 378 |
# if IOM_TIME |
| 379 |
set_now (); |
| 380 |
# endif |
| 381 |
|
| 382 |
if (fds > 0) |
| 383 |
{ |
| 384 |
# if IOM_SIG |
| 385 |
if (FD_ISSET (sigpipe[0], &rfd)) |
| 386 |
{ |
| 387 |
char ch; |
| 388 |
|
| 389 |
while (read (sigpipe[0], &ch, 1) > 0) |
| 390 |
; |
| 391 |
|
| 392 |
for (sig_vec **svp = sw.end (); svp-- > sw.begin (); ) |
| 393 |
if (*svp && (*svp)->pending) |
| 394 |
{ |
| 395 |
sig_vec &sv = **svp; |
| 396 |
for (int i = sv.size (); i--; ) |
| 397 |
if (!sv[i]) |
| 398 |
sv.erase_unordered (i); |
| 399 |
else |
| 400 |
sv[i]->call (*sv[i]); |
| 401 |
|
| 402 |
sv.pending = false; |
| 403 |
} |
| 404 |
} |
| 405 |
# endif |
| 406 |
|
| 407 |
# if IOM_IO |
| 408 |
for (int i = iow.size (); i--; ) |
| 409 |
if (!iow[i]) |
| 410 |
iow.erase_unordered (i); |
| 411 |
else |
| 412 |
{ |
| 413 |
short revents = iow[i]->events; |
| 414 |
|
| 415 |
if (!FD_ISSET (iow[i]->fd, &rfd)) revents &= ~EVENT_READ; |
| 416 |
if (!FD_ISSET (iow[i]->fd, &wfd)) revents &= ~EVENT_WRITE; |
| 417 |
|
| 418 |
if (revents) |
| 419 |
iow[i]->call (*iow[i], revents); |
| 420 |
} |
| 421 |
#endif |
| 422 |
} |
| 423 |
else if (fds < 0 && errno != EINTR) |
| 424 |
{ |
| 425 |
perror ("io_manager: fatal error while waiting for I/O or time event, aborting."); |
| 426 |
abort (); |
| 427 |
} |
| 428 |
#if IOM_IDLE |
| 429 |
else |
| 430 |
for (int i = iw.size (); i--; ) |
| 431 |
if (!iw[i]) |
| 432 |
iw.erase_unordered (i); |
| 433 |
else |
| 434 |
iw[i]->call (*iw[i]); |
| 435 |
#endif |
| 436 |
|
| 437 |
#elif IOM_TIME |
| 438 |
if (!to) |
| 439 |
break; |
| 440 |
|
| 441 |
select (0, 0, 0, 0, &to); |
| 442 |
set_now (); |
| 443 |
#else |
| 444 |
break; |
| 445 |
#endif |
| 446 |
} |
| 447 |
} |
| 448 |
|
