lib/mainloop.c

   1 /*
   2  *      UCW Library -- Main Loop
   3  *
   4  *      (c) 2004--2005 Martin Mares <mj@ucw.cz>
   5  *
   6  *      This software may be freely distributed and used according to the terms
   7  *      of the GNU Lesser General Public License.
   8  */
   9
  10 #undef LOCAL_DEBUG
  11
  12 #include "lib/lib.h"
  13 #include "lib/mainloop.h"
  14
  15 #include <stdio.h>
  16 #include <string.h>
  17 #include <stdlib.h>
  18 #include <unistd.h>
  19 #include <signal.h>
  20 #include <fcntl.h>
  21 #include <errno.h>
  22 #include <time.h>
  23 #include <sys/poll.h>
  24 #include <sys/wait.h>
  25 #include <sys/time.h>
  26
  27 timestamp_t main_now;
  28 sh_time_t main_now_seconds;
  29 uns main_shutdown;
  30
  31 clist main_timer_list, main_file_list, main_hook_list, main_process_list;
  32 static uns main_file_cnt;
  33 static uns main_poll_table_obsolete, main_poll_table_size;
  34 static struct pollfd *main_poll_table;
  35 static uns main_sigchld_set_up;
  36
  37 static void
  38 main_get_time(void)
  39 {
  40   struct timeval tv;
  41   gettimeofday(&tv, NULL);
  42   main_now_seconds = tv.tv_sec;
  43   main_now = (timestamp_t)tv.tv_sec * 1000 + tv.tv_usec / 1000;
  44   DBG("It's %Ld o'clock", (long long) main_now);
  45 }
  46
  47 void
  48 main_init(void)
  49 {
  50   DBG("MAIN: Initializing");
  51   clist_init(&main_timer_list);
  52   clist_init(&main_file_list);
  53   clist_init(&main_hook_list);
  54   clist_init(&main_process_list);
  55   main_get_time();
  56 }
  57
  58 void
  59 timer_add(struct main_timer *tm, timestamp_t expires)
  60 {
  61   if (tm->expires)
  62     clist_remove(&tm->n);
  63   tm->expires = expires;
  64   if (expires)
  65     {
  66       cnode *t = main_timer_list.head.next;
  67       while (t != &main_timer_list.head && ((struct main_timer *) t)->expires < expires)
  68         t = t->next;
  69       clist_insert_before(&tm->n, t);
  70     }
  71 }
  72
  73 void
  74 timer_del(struct main_timer *tm)
  75 {
  76   timer_add(tm, 0);
  77 }
  78
  79 static void
  80 file_timer_expired(struct main_timer *tm)
  81 {
  82   struct main_file *fi = tm->data;
  83   timer_del(&fi->timer);
  84   if (fi->error_handler)
  85     fi->error_handler(fi, MFERR_TIMEOUT);
  86 }
  87
  88 void
  89 file_add(struct main_file *fi)
  90 {
  91   ASSERT(!fi->n.next);
  92   clist_add_tail(&main_file_list, &fi->n);
  93   fi->timer.handler = file_timer_expired;
  94   fi->timer.data = fi;
  95   main_file_cnt++;
  96   main_poll_table_obsolete = 1;
  97   if (fcntl(fi->fd, F_SETFL, O_NONBLOCK) < 0)
  98     log(L_ERROR, "Error setting fd %d to non-blocking mode: %m. Keep fingers crossed.", fi->fd);
  99 }
 100
 101 void
 102 file_chg(struct main_file *fi)
 103 {
 104   struct pollfd *p = fi->pollfd;
 105   if (p)
 106     {
 107       p->events = 0;
 108       if (fi->read_handler)
 109         p->events |= POLLIN | POLLHUP | POLLERR;
 110       if (fi->write_handler)
 111         p->events |= POLLOUT | POLLERR;
 112     }
 113 }
 114
 115 void
 116 file_del(struct main_file *fi)
 117 {
 118   ASSERT(fi->n.next);
 119   timer_del(&fi->timer);
 120   clist_remove(&fi->n);
 121   main_file_cnt--;
 122   main_poll_table_obsolete = 1;
 123   fi->n.next = fi->n.prev = NULL;
 124 }
 125
 126 static int
 127 file_read_handler(struct main_file *fi)
 128 {
 129   while (fi->rpos < fi->rlen)
 130     {
 131       int l = read(fi->fd, fi->rbuf + fi->rpos, fi->rlen - fi->rpos);
 132       DBG("MAIN: FD %d: read %d", fi->fd, l);
 133       if (l < 0)
 134         {
 135           if (errno != EINTR && errno != EAGAIN && fi->error_handler)
 136             fi->error_handler(fi, MFERR_READ);
 137           return 0;
 138         }
 139       else if (!l)
 140         break;
 141       fi->rpos += l;
 142     }
 143   DBG("MAIN: FD %d done read %d of %d", fi->fd, fi->rpos, fi->rlen);
 144   fi->read_handler = NULL;
 145   file_chg(fi);
 146   fi->read_done(fi);
 147   return 1;
 148 }
 149
 150 static int
 151 file_write_handler(struct main_file *fi)
 152 {
 153   while (fi->wpos < fi->wlen)
 154     {
 155       int l = write(fi->fd, fi->wbuf + fi->wpos, fi->wlen - fi->wpos);
 156       DBG("MAIN: FD %d: write %d", fi->fd, l);
 157       if (l < 0)
 158         {
 159           if (errno != EINTR && errno != EAGAIN && fi->error_handler)
 160             fi->error_handler(fi, MFERR_WRITE);
 161           return 0;
 162         }
 163       fi->wpos += l;
 164     }
 165   DBG("MAIN: FD %d done write %d", fi->fd, fi->wpos);
 166   fi->write_handler = NULL;
 167   file_chg(fi);
 168   fi->write_done(fi);
 169   return 1;
 170 }
 171
 172 void
 173 file_read(struct main_file *fi, void *buf, uns len)
 174 {
 175   ASSERT(fi->n.next);
 176   if (len)
 177     {
 178       fi->read_handler = file_read_handler;
 179       fi->rbuf = buf;
 180       fi->rpos = 0;
 181       fi->rlen = len;
 182     }
 183   else
 184     {
 185       fi->read_handler = NULL;
 186       fi->rbuf = NULL;
 187       fi->rpos = fi->rlen = 0;
 188     }
 189   file_chg(fi);
 190 }
 191
 192 void
 193 file_write(struct main_file *fi, void *buf, uns len)
 194 {
 195   ASSERT(fi->n.next);
 196   if (len)
 197     {
 198       fi->write_handler = file_write_handler;
 199       fi->wbuf = buf;
 200       fi->wpos = 0;
 201       fi->wlen = len;
 202     }
 203   else
 204     {
 205       fi->write_handler = NULL;
 206       fi->wbuf = NULL;
 207       fi->wpos = fi->wlen = 0;
 208     }
 209   file_chg(fi);
 210 }
 211
 212 void
 213 file_set_timeout(struct main_file *fi, timestamp_t expires)
 214 {
 215   ASSERT(fi->n.next);
 216   timer_add(&fi->timer, expires);
 217 }
 218
 219 void
 220 hook_add(struct main_hook *ho)
 221 {
 222   ASSERT(!ho->n.next);
 223   clist_add_tail(&main_hook_list, &ho->n);
 224 }
 225
 226 void
 227 hook_del(struct main_hook *ho)
 228 {
 229   ASSERT(ho->n.next);
 230   clist_remove(&ho->n);
 231   ho->n.next = ho->n.prev = NULL;
 232 }
 233
 234 static void
 235 main_sigchld_handler(int x UNUSED)
 236 {
 237   DBG("SIGCHLD received");
 238 }
 239
 240 void
 241 process_add(struct main_process *mp)
 242 {
 243   ASSERT(!mp->n.next);
 244   ASSERT(mp->handler);
 245   clist_add_tail(&main_process_list, &mp->n);
 246   if (!main_sigchld_set_up)
 247     {
 248       struct sigaction sa;
 249       bzero(&sa, sizeof(sa));
 250       sa.sa_handler = main_sigchld_handler;
 251       sa.sa_flags = SA_NOCLDSTOP | SA_RESTART;
 252       sigaction(SIGCHLD, &sa, NULL);
 253       main_sigchld_set_up = 1;
 254     }
 255 }
 256
 257 void
 258 process_del(struct main_process *mp)
 259 {
 260   ASSERT(mp->n.next);
 261   clist_remove(&mp->n);
 262   mp->pid = 0;
 263   mp->n.next = NULL;
 264 }
 265
 266 int
 267 process_fork(struct main_process *mp)
 268 {
 269   ASSERT(!mp->pid);
 270   pid_t pid = fork();
 271   if (pid < 0)
 272     {
 273       DBG("MAIN: Fork failed");
 274       mp->status = -1;
 275       format_exit_status(mp->status_msg, -1);
 276       mp->handler(mp);
 277       return 1;
 278     }
 279   else if (!pid)
 280     return 0;
 281   else
 282     {
 283       DBG("MAIN: Forked process %d", (int) pid);
 284       mp->pid = pid;
 285       process_add(mp);
 286       return 1;
 287     }
 288 }
 289
 290 void
 291 main_debug(void)
 292 {
 293 #ifdef CONFIG_DEBUG
 294   log(L_DEBUG, "### Main loop status on %Ld", (long long)main_now);
 295   log(L_DEBUG, "\tActive timers:");
 296   struct main_timer *tm;
 297   CLIST_WALK(tm, main_timer_list)
 298     log(L_DEBUG, "\t\t%p (expires %Ld, data %p)", tm, (long long)(tm->expires ? tm->expires-main_now : 999999), tm->data);
 299   struct main_file *fi;
 300   log(L_DEBUG, "\tActive files:");
 301   CLIST_WALK(fi, main_file_list)
 302     log(L_DEBUG, "\t\t%p (fd %d, rh %p, wh %p, eh %p, expires %Ld, data %p)",
 303         fi, fi->fd, fi->read_handler, fi->write_handler, fi->error_handler,
 304         (long long)(fi->timer.expires ? fi->timer.expires-main_now : 999999), fi->data);
 305   log(L_DEBUG, "\tActive hooks:");
 306   struct main_hook *ho;
 307   CLIST_WALK(ho, main_hook_list)
 308     log(L_DEBUG, "\t\t%p (func %p, data %p)", ho, ho->handler, ho->data);
 309   log(L_DEBUG, "\tActive processes:");
 310   struct main_process *pr;
 311   CLIST_WALK(pr, main_process_list)
 312     log(L_DEBUG, "\t\t%p (pid %d, data %p)", pr, pr->pid, pr->data);
 313 #endif
 314 }
 315
 316 static void
 317 main_rebuild_poll_table(void)
 318 {
 319   struct main_file *fi;
 320   if (main_poll_table_size < main_file_cnt)
 321     {
 322       if (main_poll_table)
 323         xfree(main_poll_table);
 324       else
 325         main_poll_table_size = 1;
 326       while (main_poll_table_size < main_file_cnt)
 327         main_poll_table_size *= 2;
 328       main_poll_table = xmalloc(sizeof(struct pollfd) * main_poll_table_size);
 329     }
 330   struct pollfd *p = main_poll_table;
 331   DBG("MAIN: Rebuliding poll table: %d of %d entries set", main_file_cnt, main_poll_table_size);
 332   CLIST_WALK(fi, main_file_list)
 333     {
 334       p->fd = fi->fd;
 335       fi->pollfd = p++;
 336       file_chg(fi);
 337     }
 338   main_poll_table_obsolete = 0;
 339 }
 340
 341 void
 342 main_loop(void)
 343 {
 344   DBG("MAIN: Entering main_loop");
 345   ASSERT(main_timer_list.head.next);
 346
 347   struct main_file *fi;
 348   struct main_hook *ho;
 349   struct main_timer *tm;
 350   struct main_process *pr;
 351   cnode *tmp;
 352
 353   while (!main_shutdown)
 354     {
 355       main_get_time();
 356       timestamp_t wake = main_now + 1000000000;
 357       while ((tm = clist_head(&main_timer_list)) && tm->expires <= main_now)
 358         {
 359           DBG("MAIN: Timer %p expired at %Ld", tm, (long long) tm->expires);
 360           tm->handler(tm);
 361         }
 362       CLIST_WALK_DELSAFE(ho, main_hook_list, tmp)
 363         {
 364           DBG("MAIN: Hook %p", ho);
 365           if (ho->handler(ho))
 366             wake = 0;
 367         }
 368       if (main_poll_table_obsolete)
 369         main_rebuild_poll_table();
 370       if (!clist_empty(&main_process_list))
 371         {
 372           int stat;
 373           pid_t pid;
 374           wake = MIN(wake, main_now + 10000);
 375           while ((pid = waitpid(-1, &stat, WNOHANG)) > 0)
 376             {
 377               DBG("MAIN: Child %d exited with status %x", pid, stat);
 378               CLIST_WALK(pr, main_process_list)
 379                 if (pr->pid == pid)
 380                   {
 381                     pr->status = stat;
 382                     process_del(pr);
 383                     format_exit_status(pr->status_msg, pr->status);
 384                     DBG("MAIN: Calling process exit handler");
 385                     pr->handler(pr);
 386                     break;
 387                   }
 388               wake = 0;
 389             }
 390         }
 391       /* FIXME: Here is a small race window where SIGCHLD can come unnoticed. */
 392       if ((tm = clist_head(&main_timer_list)) && tm->expires < wake)
 393         wake = tm->expires;
 394       int timeout = (wake ? wake - main_now : 0);
 395       DBG("MAIN: Poll for %d fds and timeout %d ms", main_file_cnt, timeout);
 396       if (poll(main_poll_table, main_file_cnt, timeout))
 397         {
 398           struct pollfd *p = main_poll_table;
 399           main_get_time();
 400           CLIST_WALK(fi, main_file_list)
 401             {
 402               if (p->revents & (POLLIN | POLLHUP | POLLERR))
 403                 {
 404                   do
 405                     DBG("MAIN: Read event on fd %d", p->fd);
 406                   while (fi->read_handler && fi->read_handler(fi) && !main_poll_table_obsolete);
 407                   if (main_poll_table_obsolete) /* File entries have been inserted or deleted => better not risk continuing to nowhere */
 408                     break;
 409                 }
 410               if (p->revents & (POLLOUT | POLLERR))
 411                 {
 412                   do
 413                     DBG("MAIN: Write event on fd %d", p->fd);
 414                   while (fi->write_handler && fi->write_handler(fi) && !main_poll_table_obsolete);
 415                   if (main_poll_table_obsolete)
 416                     break;
 417                 }
 418               p++;
 419             }
 420         }
 421     }
 422 }
 423
 424 #ifdef TEST
 425
 426 static struct main_process mp;
 427 static struct main_file fin, fout;
 428 static struct main_hook hook;
 429 static struct main_timer tm;
 430
 431 static byte rb[16];
 432
 433 static void dread(struct main_file *fi)
 434 {
 435   if (fi->rpos < fi->rlen)
 436     {
 437       log(L_INFO, "Read EOF");
 438       file_del(fi);
 439     }
 440   else
 441     {
 442       log(L_INFO, "Read done");
 443       file_read(fi, rb, sizeof(rb));
 444     }
 445 }
 446
 447 static void derror(struct main_file *fi, int cause)
 448 {
 449   log(L_INFO, "Error: %m !!! (cause %d)", cause);
 450   file_del(fi);
 451 }
 452
 453 static void dwrite(struct main_file *fi UNUSED)
 454 {
 455   log(L_INFO, "Write done");
 456 }
 457
 458 static int dhook(struct main_hook *ho UNUSED)
 459 {
 460   log(L_INFO, "Hook called");
 461   return 0;
 462 }
 463
 464 static void dtimer(struct main_timer *tm)
 465 {
 466   log(L_INFO, "Timer tick");
 467   timer_add(tm, main_now + 10000);
 468 }
 469
 470 static void dentry(void)
 471 {
 472   log(L_INFO, "*** SUBPROCESS START ***");
 473   sleep(2);
 474   log(L_INFO, "*** SUBPROCESS FINISH ***");
 475   exit(0);
 476 }
 477
 478 static void dexit(struct main_process *pr)
 479 {
 480   log(L_INFO, "Subprocess %d exited with status %x", pr->pid, pr->status);
 481 }
 482
 483 int
 484 main(void)
 485 {
 486   log_init(NULL);
 487   main_init();
 488
 489   fin.fd = 0;
 490   fin.read_done = dread;
 491   fin.error_handler = derror;
 492   file_add(&fin);
 493   file_read(&fin, rb, sizeof(rb));
 494
 495   fout.fd = 1;
 496   fout.write_done = dwrite;
 497   fout.error_handler = derror;
 498   file_add(&fout);
 499   file_write(&fout, "Hello, world!\n", 14);
 500
 501   hook.handler = dhook;
 502   hook_add(&hook);
 503
 504   tm.handler = dtimer;
 505   timer_add(&tm, main_now + 1000);
 506
 507   mp.handler = dexit;
 508   if (!process_fork(&mp))
 509     dentry();
 510
 511   main_debug();
 512
 513   main_loop();
 514   log(L_INFO, "Finished.");
 515 }
 516
 517 #endif