1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717
|
#if 0
INDI
Copyright (C) 2003 Elwood C. Downey
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
#endif
/* suite of functions to implement an event driven program.
*
* callbacks may be registered that are triggered when a file descriptor
* will not block when read;
*
* timers may be registered that will run no sooner than a specified delay from
* the moment they were registered;
*
* work procedures may be registered that are called when there is nothing
* else to do;
*
#define MAIN_TEST for a stand-alone test program.
*/
#include <math.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <time.h>
#include <unistd.h>
#include <sys/types.h>
#include <sys/time.h>
#include "eventloop.h"
/* info about one registered callback.
* the malloced array cback is never shrunk, entries are reused. new id's are
* the index of first unused slot in array (and thus reused like unix' open(2)).
*/
typedef struct
{
int in_use; /* flag to mark this record is active */
int fd; /* fd descriptor to watch for read */
void *ud; /* user's data handle */
CBF *fp; /* callback function */
} CB;
static CB *cback; /* malloced list of callbacks */
static int ncback; /* n entries in cback[] */
static int ncbinuse; /* n entries in cback[] marked in_use */
static int lastcb; /* cback index of last cb called */
/* info about one registered timer function.
* the entries are kept sorted by increasing time from epoch, ie,
* the next entry to fire is at the begin of the list.
*/
typedef struct TF
{
double tgo; /* trigger time, ms from epoch */
int interval; /* repeat timer if interval > 0, ms */
void *ud; /* user's data handle */
TCF *fp; /* timer function */
int tid; /* unique id for this timer */
struct TF *next; /* pointer to next item */
} TF;
static TF timefunc_null = {0, 0, NULL, NULL, 0, NULL};
static TF *timefunc = &timefunc_null; /* list of timer functions */
static int tid = 0; /* source of unique timer ids */
#define EPOCHDT(tp) /* ms from epoch to timeval *tp */ (((tp)->tv_usec) / 1000.0 + ((tp)->tv_sec) * 1000.0)
/* info about one registered work procedure.
* the malloced array wproc is never shrunk, entries are reused. new id's are
* the index of first unused slot in array (and thus reused like unix' open(2)).
*/
typedef struct
{
int in_use; /* flag to mark this record is active */
void *ud; /* user's data handle */
WPF *fp; /* work proc function function */
} WP;
static WP *wproc; /* malloced list of work procedures */
static int nwproc; /* n entries in wproc[] */
static int nwpinuse; /* n entries in wproc[] marked in-use */
static int lastwp; /* wproc index of last workproc called*/
static void runWorkProc(void);
static void callCallback(fd_set *rfdp);
static void checkTimer();
static void oneLoop(void);
static void deferTO(void *p);
static void runImmediates();
/* inf loop to dispatch callbacks, work procs and timers as necessary.
* never returns.
*/
void eventLoop()
{
/* run loop forever */
while (1)
oneLoop();
}
/* allow other timers/callbacks/workprocs to run until time out in maxms
* or *flagp becomes non-0. wait forever if maxms is 0.
* return 0 if flag did flip, else -1 if never changed and we timed out.
* the expected usage for this is for the caller to arrange for a T/C/W to set
* a flag, then give caller an in-line way to wait for the flag to change.
*/
int deferLoop(int maxms, int *flagp)
{
int toflag = 0;
int totid = maxms ? addTimer(maxms, deferTO, &toflag) : 0;
while (!*flagp)
{
oneLoop();
if (toflag)
return (-1); /* totid already dead */
}
if (totid)
rmTimer(totid);
return (0);
}
/* allow other timers/callbacks/workprocs to run until time out in maxms
* or *flagp becomes 0. wait forever if maxms is 0.
* return 0 if flag did flip, else -1 if never changed and we timed out.
* the expected usage for this is for the caller to arrange for a T/C/W to set
* a flag, then give caller an in-line way to wait for the flag to change.
*/
int deferLoop0(int maxms, int *flagp)
{
int toflag = 0;
int totid = maxms ? addTimer(maxms, deferTO, &toflag) : 0;
while (*flagp)
{
oneLoop();
if (toflag)
return (-1); /* totid already dead */
}
if (totid)
rmTimer(totid);
return (0);
}
/* register a new callback, fp, to be called with ud as arg when fd is ready.
* return a unique callback id for use with rmCallback().
*/
int addCallback(int fd, CBF *fp, void *ud)
{
CB *cp;
/* reuse first unused slot or grow */
for (cp = cback; cp < &cback[ncback]; cp++)
if (!cp->in_use)
break;
if (cp == &cback[ncback])
{
cback = realloc(cback, (ncback + 1) * sizeof(CB));
cp = &cback[ncback++];
}
/* init new entry */
cp->in_use = 1;
cp->fp = fp;
cp->ud = ud;
cp->fd = fd;
ncbinuse++;
/* id is index into array */
return (cp - cback);
}
/* remove the callback with the given id, as returned from addCallback().
* silently ignore if id not valid.
*/
void rmCallback(int cid)
{
CB *cp;
/* validate id */
if (cid < 0 || cid >= ncback)
return;
cp = &cback[cid];
if (!cp->in_use)
return;
/* mark for reuse */
cp->in_use = 0;
ncbinuse--;
}
/* insert maintaining sort */
static void insertTimer(TF *node)
{
TF *it = timefunc;
for(; ; it = it->next)
{
if (it->next == NULL || node->tgo < it->next->tgo)
{
node->next = it->next;
it->next = node;
break;
}
}
}
/* register a new timer function, fp, to be called with ud as arg after ms
* milliseconds. add to list in order of increasing time from epoch, ie,
* first entry runs soonest. return id for use with rmTimer().
*/
static int addTimerImpl(int delay, int interval, TCF *fp, void *ud)
{
struct timeval t;
TF *node;
/* get time now */
gettimeofday(&t, NULL);
/* create entry */
node = (TF*)malloc(sizeof(TF));
/* init new entry */
node->ud = ud;
node->fp = fp;
node->tid = ++tid; /* store new unique id */
node->tgo = EPOCHDT(&t) + delay;
node->interval = interval;
insertTimer(node);
return node->tid;
}
int addTimer(int ms, TCF *fp, void *ud)
{
return addTimerImpl(ms, 0, fp, ud);
}
int addPeriodicTimer(int ms, TCF *fp, void *ud)
{
return addTimerImpl(ms, ms, fp, ud);
}
/* find the timer and remove from list */
static TF *dettachTimer(TF *node)
{
TF *it = timefunc;
for(; it->next != NULL; it = it->next)
{
if (it->next == node)
{
it->next = node->next;
return node;
}
}
return NULL;
}
/* find the timer by id */
static TF *findTimer(int timer_id)
{
TF *it = timefunc->next;
for(; it != NULL; it = it->next)
if (it->tid == timer_id)
return it;
return NULL;
}
/* remove the timer with the given id, as returned from addTimer().
* silently ignore if id not found.
*/
void rmTimer(int timer_id)
{
TF *node, *it = timefunc;
for(; (node = it->next) != NULL; it = it->next)
{
if (node->tid == timer_id)
{
it->next = node->next;
free(node);
break;
}
}
}
/* Returns the timer's remaining value in milliseconds left until the timeout. */
static double remainingTimerNode(TF *node)
{
struct timeval now;
gettimeofday(&now, NULL);
return (node->tgo - EPOCHDT(&now));
}
/* Returns the timer's remaining value in milliseconds left until the timeout.
* If the timer not exists, the returned value will be -1.
*/
int remainingTimer(int timer_id)
{
TF *it = findTimer(timer_id);
return it == NULL ? -1 : remainingTimerNode(it);
}
/* Returns the timer's remaining value in nanoseconds left until the timeout.
* If the timer not exists, the returned value will be -1.
*/
int64_t nsecsRemainingTimer(int timer_id)
{
TF *it = findTimer(timer_id);
return it == NULL ? -1 : remainingTimerNode(it) * 1000000;
}
/* add a new work procedure, fp, to be called with ud when nothing else to do.
* return unique id for use with rmWorkProc().
*/
int addWorkProc(WPF *fp, void *ud)
{
WP *wp;
/* reuse first unused slot or grow */
for (wp = wproc; wp < &wproc[nwproc]; wp++)
if (!wp->in_use)
break;
if (wp == &wproc[nwproc])
{
wproc = (WP *)realloc(wproc, (nwproc + 1) * sizeof(WP));
wp = &wproc[nwproc++];
}
/* init new entry */
wp->in_use = 1;
wp->fp = fp;
wp->ud = ud;
nwpinuse++;
/* id is index into array */
return (wp - wproc);
}
/* remove the work proc with the given id, as returned from addWorkProc().
* silently ignore if id not found.
*/
void rmWorkProc(int wid)
{
WP *wp;
/* validate id */
if (wid < 0 || wid >= nwproc)
return;
wp = &wproc[wid];
if (!wp->in_use)
return;
/* mark for reuse */
wp->in_use = 0;
nwpinuse--;
}
/* run next work procedure */
static void runWorkProc()
{
WP *wp;
/* skip if list is empty */
if (!nwpinuse)
return;
/* find next */
do
{
lastwp = (lastwp + 1) % nwproc;
wp = &wproc[lastwp];
} while (!wp->in_use);
/* run */
(*wp->fp)(wp->ud);
}
/* run next callback whose fd is listed as ready to go in rfdp */
static void callCallback(fd_set *rfdp)
{
CB *cp;
/* skip if list is empty */
if (!ncbinuse)
return;
/* find next */
do
{
lastcb = (lastcb + 1) % ncback;
cp = &cback[lastcb];
} while (!cp->in_use || !FD_ISSET(cp->fd, rfdp));
/* run */
(*cp->fp)(cp->fd, cp->ud);
}
/* run the next timer callback whose time has come, if any. all we have to do
* is is check the first entry in timefunc because it is sorted in increasing
* order of time from epoch to run, ie, first entry runs soonest.
*/
static void checkTimer()
{
TF *node = timefunc->next;
if (node == NULL || remainingTimerNode(node) > 0)
return;
(*node->fp)(node->ud);
node = dettachTimer(node);
if (node == NULL)
return;
if (node->interval > 0)
{
node->tgo += node->interval;
insertTimer(node);
} else {
free(node);
}
}
/* check fd's from each active callback.
* if any ready, call their callbacks else call each registered work procedure.
*/
static void oneLoop()
{
struct timeval tv, *tvp;
fd_set rfd;
CB *cp;
int maxfd, ns;
/* build list of callback file descriptors to check */
FD_ZERO(&rfd);
maxfd = -1;
for (cp = cback; cp < &cback[ncback]; cp++)
{
if (cp->in_use)
{
FD_SET(cp->fd, &rfd);
if (cp->fd > maxfd)
maxfd = cp->fd;
}
}
/* determine timeout:
* if there are work procs
* set delay = 0
* else if there is at least one timer func
* set delay = time until soonest timer func expires
* else
* set delay = forever
*/
if (nwpinuse > 0)
{
tvp = &tv;
tvp->tv_sec = tvp->tv_usec = 0;
}
else if (timefunc->next != NULL)
{
double late = remainingTimerNode(timefunc->next); /* ms late */
if (late < 0)
late = 0;
late /= 1000.0; /* secs late */
tvp = &tv;
tvp->tv_sec = (long)floor(late);
tvp->tv_usec = (long)floor((late - tvp->tv_sec) * 1000000.0);
}
else
tvp = NULL;
/* check file descriptors, timeout depending on pending work */
ns = select(maxfd + 1, &rfd, NULL, NULL, tvp);
if (ns < 0)
{
perror("select");
return;
}
/* dispatch */
checkTimer();
if (ns == 0)
runWorkProc();
else
callCallback(&rfd);
runImmediates();
}
/* timer callback used to implement deferLoop().
* arg is pointer to int which we set to 1
*/
static void deferTO(void *p)
{
*(int *)p = 1;
}
typedef struct Immediate
{
void *ud;
WPF * fp;
struct Immediate * prev, *next;
} Immediate;
static Immediate * firstImmediate = NULL;
static Immediate * lastImmediate = NULL;
void addImmediateWork(TCF * fp, void *ud)
{
Immediate * immediate = (Immediate*)malloc(sizeof(Immediate));
immediate->fp = fp;
immediate->ud = ud;
immediate->prev = lastImmediate;
immediate->next = NULL;
if (lastImmediate) {
lastImmediate->next = immediate;
} else {
firstImmediate = immediate;
}
lastImmediate = immediate;
}
static int peekImmediate(Immediate * into)
{
if (!firstImmediate) {
return 0;
}
Immediate * o = firstImmediate;
into->fp = o->fp;
into->ud = o->ud;
firstImmediate = o->next;
if (o->next) {
o->next->prev = NULL;
} else {
lastImmediate = NULL;
}
free(o);
return 1;
}
void runImmediates() {
Immediate immediate;
while((peekImmediate(&immediate))) {
(*immediate.fp)(immediate.ud);
}
}
/* "INDI" wrappers to the more generic eventloop facility. */
typedef void(IE_CBF)(int readfiledes, void *userpointer);
typedef void(IE_TCF)(void *userpointer);
typedef void(IE_WPF)(void *userpointer);
int IEAddCallback(int readfiledes, IE_CBF *fp, void *p)
{
return (addCallback(readfiledes, (CBF *)fp, p));
}
void IERmCallback(int callbackid)
{
rmCallback(callbackid);
}
int IEAddTimer(int millisecs, IE_TCF *fp, void *p)
{
return (addTimer(millisecs, (TCF *)fp, p));
}
int IEAddPeriodicTimer(int millisecs, IE_TCF *fp, void *p)
{
return (addPeriodicTimer(millisecs, (TCF *)fp, p));
}
int IERemainingTimer(int timerid)
{
return (remainingTimer(timerid));
}
int64_t IENSecsRemainingTimer(int timerid)
{
return (nsecsRemainingTimer(timerid));
}
void IERmTimer(int timerid)
{
rmTimer(timerid);
}
int IEAddWorkProc(IE_WPF *fp, void *p)
{
return (addWorkProc((WPF *)fp, p));
}
void IERmWorkProc(int workprocid)
{
rmWorkProc(workprocid);
}
int IEDeferLoop(int maxms, int *flagp)
{
return (deferLoop(maxms, flagp));
}
int IEDeferLoop0(int maxms, int *flagp)
{
return (deferLoop0(maxms, flagp));
}
#if defined(MAIN_TEST)
/* make a small stand-alone test program.
*/
#include <unistd.h>
#include <sys/time.h>
int mycid;
int mywid;
int mytid;
int user_a;
int user_b;
int counter;
void wp(void *ud)
{
struct timeval tv;
gettimeofday(&tv, NULL);
printf("workproc @ %ld.%03ld %d %d\n", (long)tv.tv_sec, (long)tv.tv_usec / 1000, counter, ++(*(int *)ud));
}
void to(void *ud)
{
printf("timeout %d\n", (int)ud);
}
void stdinCB(int fd, void *ud)
{
char c;
if (read(fd, &c, 1) != 1)
{
perror("read");
return;
}
switch (c)
{
case '+':
counter++;
break;
case '-':
counter--;
break;
case 'W':
mywid = addWorkProc(wp, &user_b);
break;
case 'w':
rmWorkProc(mywid);
break;
case 'c':
rmCallback(mycid);
break;
case 't':
rmTimer(mytid);
break;
case '1':
mytid = addTimer(1000, to, (void *)1);
break;
case '2':
mytid = addTimer(2000, to, (void *)2);
break;
case '3':
mytid = addTimer(3000, to, (void *)3);
break;
case '4':
mytid = addTimer(4000, to, (void *)4);
break;
case '5':
mytid = addTimer(5000, to, (void *)5);
break;
default:
return; /* silently absorb other chars like \n */
}
printf("callback: %d\n", ++(*(int *)ud));
}
int main(int ac, char *av[])
{
(void)addCallback(0, stdinCB, &user_a);
eventLoop();
exit(0);
}
#endif
|