]> mj.ucw.cz Git - libucw.git/blob - ucw/mainloop.c
7b5d504506d9c09ee54d07d661cdbf940c63f3af
[libucw.git] / ucw / mainloop.c
1 /*
2  *      UCW Library -- Main Loop
3  *
4  *      (c) 2004--2010 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 "ucw/lib.h"
13 #include "ucw/heap.h"
14 #include "ucw/mainloop.h"
15 #include "ucw/threads.h"
16 #include "ucw/gary.h"
17
18 #include <stdio.h>
19 #include <string.h>
20 #include <stdlib.h>
21 #include <unistd.h>
22 #include <signal.h>
23 #include <fcntl.h>
24 #include <errno.h>
25 #include <time.h>
26 #include <sys/poll.h>
27 #include <sys/wait.h>
28 #include <sys/time.h>
29
30 #ifdef CONFIG_UCW_THREADS
31 #include <pthread.h>
32 #define THREAD_SIGMASK pthread_sigmask
33 #else
34 #define THREAD_SIGMASK sigprocmask
35 #endif
36
37 #define MAIN_TIMER_LESS(x,y) ((x)->expires < (y)->expires)
38 #define MAIN_TIMER_SWAP(heap,a,b,t) (t=heap[a], heap[a]=heap[b], heap[b]=t, heap[a]->index=(a), heap[b]->index=(b))
39
40 static void
41 do_main_get_time(struct main_context *m)
42 {
43   struct timeval tv;
44   gettimeofday(&tv, NULL);
45   m->now_seconds = tv.tv_sec;
46   m->now = (timestamp_t)tv.tv_sec * 1000 + tv.tv_usec / 1000;
47 }
48
49 struct main_context *
50 main_new(void)
51 {
52   struct main_context *m = xmalloc_zero(sizeof(*m));
53
54   DBG("MAIN: New context");
55   clist_init(&m->file_list);
56   clist_init(&m->hook_list);
57   clist_init(&m->hook_done_list);
58   clist_init(&m->process_list);
59   clist_init(&m->signal_list);
60   m->poll_table_obsolete = 1;
61   do_main_get_time(m);
62   sigemptyset(&m->want_signals);
63   m->sig_pipe_recv = m->sig_pipe_send = -1;
64
65   return m;
66 }
67
68 void
69 main_delete(struct main_context *m)
70 {
71   if (m->sigchld_handler)
72     signal_del(m->sigchld_handler);
73   if (m->sig_pipe_file)
74     file_del(m->sig_pipe_file);
75   if (m->sig_pipe_recv >= 0)
76     {
77       close(m->sig_pipe_recv);
78       close(m->sig_pipe_send);
79     }
80   ASSERT(clist_empty(&m->file_list));
81   ASSERT(clist_empty(&m->hook_list));
82   ASSERT(clist_empty(&m->hook_done_list));
83   ASSERT(clist_empty(&m->process_list));
84   ASSERT(clist_empty(&m->signal_list));
85   if (m->timer_table)
86     GARY_FREE(m->timer_table);
87   xfree(m->poll_table);
88   xfree(m);
89   // FIXME: Some mechanism for cleaning up after fork()
90 }
91
92 struct main_context *
93 main_switch_context(struct main_context *m)
94 {
95   struct ucwlib_context *c = ucwlib_thread_context();
96   struct main_context *m0 = c->main_context;
97
98   /*
99    *  Not only we need to switch the signal sets of the two contexts,
100    *  but it is also necessary to avoid invoking a signal handler
101    *  in the middle of changing c->main_context.
102    */
103   if (m0 && !clist_empty(&m0->signal_list))
104     THREAD_SIGMASK(SIG_BLOCK, &m0->want_signals, NULL);
105   c->main_context = m;
106   if (m && !clist_empty(&m->signal_list))
107     THREAD_SIGMASK(SIG_UNBLOCK, &m->want_signals, NULL);
108
109   return m0;
110 }
111
112 struct main_context *
113 main_current(void)
114 {
115   struct ucwlib_context *c = ucwlib_thread_context();
116   struct main_context *m = c->main_context;
117   ASSERT(m);
118   return m;
119 }
120
121 void
122 main_init(void)
123 {
124   struct main_context *m = main_switch_context(main_new());
125   ASSERT(!m);
126 }
127
128 void
129 main_cleanup(void)
130 {
131   struct main_context *m = main_switch_context(NULL);
132   main_delete(m);
133 }
134
135 void
136 main_get_time(void)
137 {
138   do_main_get_time(main_current());
139 }
140
141 static inline uns
142 count_timers(struct main_context *m)
143 {
144   return GARY_SIZE(m->timer_table) - 1;
145 }
146
147 void
148 timer_add(struct main_timer *tm, timestamp_t expires)
149 {
150   struct main_context *m = main_current();
151
152   if (!m->timer_table)
153     {
154       GARY_INIT(m->timer_table, 1);
155       m->timer_table[0] = NULL;
156     }
157
158   if (expires)
159     DBG("MAIN: Setting timer %p (expire at now+%lld)", tm, (long long)(expires - m->now));
160   else
161     DBG("MAIN: Clearing timer %p", tm);
162   uns num_timers = count_timers(m);
163   if (tm->expires < expires)
164     {
165       if (!tm->expires)
166         {
167           tm->expires = expires;
168           tm->index = num_timers + 1;
169           *GARY_PUSH(m->timer_table, 1) = tm;
170           HEAP_INSERT(struct main_timer *, m->timer_table, tm->index, MAIN_TIMER_LESS, MAIN_TIMER_SWAP);
171         }
172       else
173         {
174           tm->expires = expires;
175           HEAP_INCREASE(struct main_timer *, m->timer_table, num_timers, MAIN_TIMER_LESS, MAIN_TIMER_SWAP, tm->index);
176         }
177     }
178   else if (tm->expires > expires)
179     {
180       if (!expires)
181         {
182           ASSERT(tm->index && tm->index <= num_timers);
183           HEAP_DELETE(struct main_timer *, m->timer_table, num_timers, MAIN_TIMER_LESS, MAIN_TIMER_SWAP, tm->index);
184           tm->index = 0;
185           tm->expires = 0;
186           GARY_POP(m->timer_table, 1);
187         }
188       else
189         {
190           tm->expires = expires;
191           HEAP_DECREASE(struct main_timer *, m->timer_table, num_timers, MAIN_TIMER_LESS, MAIN_TIMER_SWAP, tm->index);
192         }
193     }
194 }
195
196 void
197 timer_add_rel(struct main_timer *tm, timestamp_t expires_delta)
198 {
199   struct main_context *m = main_current();
200   return timer_add(tm, m->now + expires_delta);
201 }
202
203 void
204 timer_del(struct main_timer *tm)
205 {
206   timer_add(tm, 0);
207 }
208
209 void
210 file_add(struct main_file *fi)
211 {
212   struct main_context *m = main_current();
213
214   DBG("MAIN: Adding file %p (fd=%d)", fi, fi->fd);
215   ASSERT(!fi->n.next);
216   clist_add_tail(&m->file_list, &fi->n);
217   m->file_cnt++;
218   m->poll_table_obsolete = 1;
219   if (fcntl(fi->fd, F_SETFL, O_NONBLOCK) < 0)
220     msg(L_ERROR, "Error setting fd %d to non-blocking mode: %m. Keep fingers crossed.", fi->fd);
221 }
222
223 void
224 file_chg(struct main_file *fi)
225 {
226   struct pollfd *p = fi->pollfd;
227   if (p)
228     {
229       p->events = 0;
230       if (fi->read_handler)
231         p->events |= POLLIN | POLLHUP | POLLERR;
232       if (fi->write_handler)
233         p->events |= POLLOUT | POLLERR;
234     }
235 }
236
237 void
238 file_del(struct main_file *fi)
239 {
240   struct main_context *m = main_current();
241
242   DBG("MAIN: Deleting file %p (fd=%d)", fi, fi->fd);
243   ASSERT(fi->n.next);
244   clist_remove(&fi->n);
245   m->file_cnt--;
246   m->poll_table_obsolete = 1;
247   fi->n.next = fi->n.prev = NULL;
248 }
249
250 void
251 file_close_all(void)
252 {
253   struct main_context *m = main_current();
254
255   CLIST_FOR_EACH(struct main_file *, f, m->file_list)
256     close(f->fd);
257 }
258
259 void
260 hook_add(struct main_hook *ho)
261 {
262   struct main_context *m = main_current();
263
264   DBG("MAIN: Adding hook %p", ho);
265   ASSERT(!ho->n.next);
266   clist_add_tail(&m->hook_list, &ho->n);
267 }
268
269 void
270 hook_del(struct main_hook *ho)
271 {
272   DBG("MAIN: Deleting hook %p", ho);
273   ASSERT(ho->n.next);
274   clist_remove(&ho->n);
275   ho->n.next = ho->n.prev = NULL;
276 }
277
278 static void
279 sigchld_received(struct main_signal *sg UNUSED)
280 {
281   struct main_context *m = main_current();
282   int stat;
283   pid_t pid;
284
285   while ((pid = waitpid(-1, &stat, WNOHANG)) > 0)
286     {
287       DBG("MAIN: Child %d exited with status %x", pid, stat);
288       CLIST_FOR_EACH(struct main_process *, pr, m->process_list)
289         if (pr->pid == pid)
290           {
291             pr->status = stat;
292             process_del(pr);
293             format_exit_status(pr->status_msg, pr->status);
294             DBG("MAIN: Calling process exit handler");
295             pr->handler(pr);
296             break;
297           }
298     }
299 }
300
301 void
302 process_add(struct main_process *mp)
303 {
304   struct main_context *m = main_current();
305
306   DBG("MAIN: Adding process %p (pid=%d)", mp, mp->pid);
307   ASSERT(!mp->n.next);
308   ASSERT(mp->handler);
309   clist_add_tail(&m->process_list, &mp->n);
310   if (!m->sigchld_handler)
311     {
312       struct main_signal *sg = xmalloc_zero(sizeof(*sg));
313       m->sigchld_handler = sg;
314       sg->signum = SIGCHLD;
315       sg->handler = sigchld_received;
316       signal_add(sg);
317     }
318 }
319
320 void
321 process_del(struct main_process *mp)
322 {
323   DBG("MAIN: Deleting process %p (pid=%d)", mp, mp->pid);
324   ASSERT(mp->n.next);
325   clist_remove(&mp->n);
326   mp->n.next = NULL;
327 }
328
329 int
330 process_fork(struct main_process *mp)
331 {
332   pid_t pid = fork();
333   if (pid < 0)
334     {
335       DBG("MAIN: Fork failed");
336       mp->status = -1;
337       format_exit_status(mp->status_msg, -1);
338       mp->handler(mp);
339       return 1;
340     }
341   else if (!pid)
342     return 0;
343   else
344     {
345       DBG("MAIN: Forked process %d", (int) pid);
346       mp->pid = pid;
347       process_add(mp);
348       return 1;
349     }
350 }
351
352 static int
353 pipe_read_handler(struct main_file *mf UNUSED)
354 {
355   struct main_context *m = main_current();
356   int signum;
357   int n = read(m->sig_pipe_recv, &signum, sizeof(signum));
358
359   if (n < 0)
360     {
361       if (errno != EAGAIN)
362         msg(L_ERROR, "Error reading signal pipe: %m");
363       return 0;
364     }
365   ASSERT(n == sizeof(signum));
366
367   DBG("MAIN: Sigpipe: received signal %d", signum);
368   struct main_signal *tmp;
369   CLIST_FOR_EACH_DELSAFE(struct main_signal *, sg, m->signal_list, tmp)
370     if (sg->signum == signum)
371       {
372         DBG("MAIN: Sigpipe: invoking handler %p", sg);
373         // FIXME: Can the handler disappear from here?
374         sg->handler(sg);
375       }
376
377   return 1;
378 }
379
380 static void
381 pipe_configure(int fd)
382 {
383   int flags;
384   if ((flags = fcntl(fd, F_GETFL)) < 0 || fcntl(fd, F_SETFL, flags|O_NONBLOCK) < 0)
385     die("Could not set file descriptor %d to non-blocking: %m", fd);
386 }
387
388 static void
389 pipe_setup(struct main_context *m)
390 {
391   DBG("MAIN: Sigpipe: Setting up the pipe");
392
393   int pipe_result[2];
394   if (pipe(pipe_result) == -1)
395     die("Could not create signal pipe: %m");
396   pipe_configure(pipe_result[0]);
397   pipe_configure(pipe_result[1]);
398   m->sig_pipe_recv = pipe_result[0];
399   m->sig_pipe_send = pipe_result[1];
400
401   struct main_file *f = xmalloc_zero(sizeof(*f));
402   m->sig_pipe_file = f;
403   f->fd = m->sig_pipe_recv;
404   f->read_handler = pipe_read_handler;
405   file_add(f);
406 }
407
408 static void
409 signal_handler_pipe(int signum)
410 {
411   struct main_context *m = main_current();
412 #ifdef LOCAL_DEBUG
413   msg(L_DEBUG | L_SIGHANDLER, "MAIN: Sigpipe: sending signal %d down the drain", signum);
414 #endif
415   write(m->sig_pipe_send, &signum, sizeof(signum));
416 }
417
418 void
419 signal_add(struct main_signal *ms)
420 {
421   struct main_context *m = main_current();
422
423   DBG("MAIN: Adding signal %p (sig=%d)", ms, ms->signum);
424
425   ASSERT(!ms->n.next);
426   clist_add_tail(&m->signal_list, &ms->n);
427   if (m->sig_pipe_recv < 0)
428     pipe_setup(m);
429
430   struct sigaction sa = {
431     .sa_handler = signal_handler_pipe,
432     .sa_flags = SA_NOCLDSTOP | SA_RESTART,
433   };
434   sigaction(ms->signum, &sa, NULL);
435
436   sigset_t ss;
437   sigemptyset(&ss);
438   sigaddset(&ss, ms->signum);
439   THREAD_SIGMASK(SIG_UNBLOCK, &ss, NULL);
440   sigaddset(&m->want_signals, ms->signum);
441 }
442
443 void
444 signal_del(struct main_signal *ms)
445 {
446   struct main_context *m = main_current();
447
448   DBG("MAIN: Deleting signal %p (sig=%d)", ms, ms->signum);
449
450   ASSERT(ms->n.next);
451   clist_remove(&ms->n);
452   ms->n.next = ms->n.prev = NULL;
453
454   int another = 0;
455   CLIST_FOR_EACH(struct main_signal *, s, m->signal_list)
456     if (s->signum == ms->signum)
457       another++;
458   if (!another)
459     {
460       sigset_t ss;
461       sigemptyset(&ss);
462       sigaddset(&ss, ms->signum);
463       THREAD_SIGMASK(SIG_BLOCK, &ss, NULL);
464       sigdelset(&m->want_signals, ms->signum);
465     }
466 }
467
468 void
469 main_debug_context(struct main_context *m UNUSED)
470 {
471 #ifdef CONFIG_DEBUG
472   msg(L_DEBUG, "### Main loop status on %lld", (long long) m->now);
473   msg(L_DEBUG, "\tActive timers:");
474   uns num_timers = count_timers(m);
475   for (uns i = 1; i <= num_timers; i++)
476     {
477       struct main_timer *tm = m->timer_table[i];
478       msg(L_DEBUG, "\t\t%p (expires %lld, data %p)", tm, (long long)(tm->expires ? tm->expires - m->now : 999999), tm->data);
479     }
480   msg(L_DEBUG, "\tActive files:");
481   CLIST_FOR_EACH(struct main_file *, fi, m->file_list)
482     msg(L_DEBUG, "\t\t%p (fd %d, rh %p, wh %p, data %p)",
483         fi, fi->fd, fi->read_handler, fi->write_handler, fi->data);
484     // FIXME: Can we display status of block_io requests somehow?
485   msg(L_DEBUG, "\tActive hooks:");
486   CLIST_FOR_EACH(struct main_hook *, ho, m->hook_done_list)
487     msg(L_DEBUG, "\t\t%p (func %p, data %p)", ho, ho->handler, ho->data);
488   CLIST_FOR_EACH(struct main_hook *, ho, m->hook_list)
489     msg(L_DEBUG, "\t\t%p (func %p, data %p)", ho, ho->handler, ho->data);
490   msg(L_DEBUG, "\tActive processes:");
491   CLIST_FOR_EACH(struct main_process *, pr, m->process_list)
492     msg(L_DEBUG, "\t\t%p (pid %d, func %p, data %p)", pr, pr->pid, pr->handler, pr->data);
493   msg(L_DEBUG, "\tActive signal catchers:");
494   CLIST_FOR_EACH(struct main_signal *, sg, m->signal_list)
495     msg(L_DEBUG, "\t\t%p (sig %d, func %p, data %p)", sg, sg->signum, sg->handler, sg->data);
496 #endif
497 }
498
499 static void
500 main_rebuild_poll_table(struct main_context *m)
501 {
502   struct main_file *fi;
503   if (m->poll_table_size < m->file_cnt)
504     {
505       if (m->poll_table)
506         xfree(m->poll_table);
507       else
508         m->poll_table_size = 1;
509       while (m->poll_table_size < m->file_cnt)
510         m->poll_table_size *= 2;
511       m->poll_table = xmalloc(sizeof(struct pollfd) * m->poll_table_size);
512     }
513   struct pollfd *p = m->poll_table;
514   DBG("MAIN: Rebuilding poll table: %d of %d entries set", m->file_cnt, m->poll_table_size);
515   CLIST_WALK(fi, m->file_list)
516     {
517       p->fd = fi->fd;
518       fi->pollfd = p++;
519       file_chg(fi);
520     }
521   m->poll_table_obsolete = 0;
522 }
523
524 void
525 main_loop(void)
526 {
527   DBG("MAIN: Entering main_loop");
528   struct main_context *m = main_current();
529
530   struct main_file *fi;
531   struct main_hook *ho;
532   struct main_timer *tm;
533
534   do_main_get_time(m);
535   for (;;)
536     {
537       timestamp_t wake = m->now + 1000000000;
538       while (GARY_SIZE(m->timer_table) > 1 && (tm = m->timer_table[1])->expires <= m->now)
539         {
540           DBG("MAIN: Timer %p expired at now-%lld", tm, (long long)(m->now - tm->expires));
541           tm->handler(tm);
542         }
543       int hook_min = HOOK_RETRY;
544       int hook_max = HOOK_SHUTDOWN;
545       while (ho = clist_remove_head(&m->hook_list))
546         {
547           clist_add_tail(&m->hook_done_list, &ho->n);
548           DBG("MAIN: Hook %p", ho);
549           int ret = ho->handler(ho);
550           hook_min = MIN(hook_min, ret);
551           hook_max = MAX(hook_max, ret);
552         }
553       clist_move(&m->hook_list, &m->hook_done_list);
554       if (hook_min == HOOK_SHUTDOWN ||
555           hook_min == HOOK_DONE && hook_max == HOOK_DONE ||
556           m->shutdown)
557         {
558           DBG("MAIN: Shut down by %s", m->shutdown ? "main_shutdown" : "a hook");
559           return;
560         }
561       if (hook_max == HOOK_RETRY)
562         wake = 0;
563       if (m->poll_table_obsolete)
564         main_rebuild_poll_table(m);
565       if (count_timers(m) && (tm = m->timer_table[1])->expires < wake)
566         wake = tm->expires;
567       do_main_get_time(m);
568       int timeout = ((wake > m->now) ? wake - m->now : 0);
569       DBG("MAIN: Poll for %d fds and timeout %d ms", m->file_cnt, timeout);
570       int p = poll(m->poll_table, m->file_cnt, timeout);
571       timestamp_t old_now = m->now;
572       do_main_get_time(m);
573       m->idle_time += m->now - old_now;
574       if (p > 0)
575         {
576           struct pollfd *p = m->poll_table;
577           CLIST_WALK(fi, m->file_list)
578             {
579               if (p->revents & (POLLIN | POLLHUP | POLLERR))
580                 {
581                   do
582                     DBG("MAIN: Read event on fd %d", p->fd);
583                   while (fi->read_handler && fi->read_handler(fi) && !m->poll_table_obsolete);
584                   if (m->poll_table_obsolete)   /* File entries have been inserted or deleted => better not risk continuing to nowhere */
585                     break;
586                 }
587               if (p->revents & (POLLOUT | POLLERR))
588                 {
589                   do
590                     DBG("MAIN: Write event on fd %d", p->fd);
591                   while (fi->write_handler && fi->write_handler(fi) && !m->poll_table_obsolete);
592                   if (m->poll_table_obsolete)
593                     break;
594                 }
595               p++;
596             }
597         }
598     }
599 }
600
601 #ifdef TEST
602
603 static struct main_process mp;
604 static struct main_block_io fin, fout;
605 static struct main_hook hook;
606 static struct main_timer tm;
607 static struct main_signal sg;
608
609 static byte rb[16];
610
611 static void dread(struct main_block_io *bio)
612 {
613   if (bio->rpos < bio->rlen)
614     {
615       msg(L_INFO, "Read EOF");
616       block_io_del(bio);
617     }
618   else
619     {
620       msg(L_INFO, "Read done");
621       block_io_read(bio, rb, sizeof(rb));
622     }
623 }
624
625 static void derror(struct main_block_io *bio, int cause)
626 {
627   msg(L_INFO, "Error: %m !!! (cause %d)", cause);
628   block_io_del(bio);
629 }
630
631 static void dwrite(struct main_block_io *bio UNUSED)
632 {
633   msg(L_INFO, "Write done");
634 }
635
636 static int dhook(struct main_hook *ho UNUSED)
637 {
638   msg(L_INFO, "Hook called");
639   return 0;
640 }
641
642 static void dtimer(struct main_timer *tm)
643 {
644   msg(L_INFO, "Timer tick");
645   timer_add_rel(tm, 11000);
646   timer_add_rel(tm, 10000);
647 }
648
649 static void dentry(void)
650 {
651   msg(L_INFO, "*** SUBPROCESS START ***");
652   sleep(2);
653   msg(L_INFO, "*** SUBPROCESS FINISH ***");
654   exit(0);
655 }
656
657 static void dexit(struct main_process *pr)
658 {
659   msg(L_INFO, "Subprocess %d exited with status %x", pr->pid, pr->status);
660 }
661
662 static void dsignal(struct main_signal *sg UNUSED)
663 {
664   msg(L_INFO, "SIGINT received (use Ctrl-\\ to really quit)");
665 }
666
667 int
668 main(void)
669 {
670   log_init(NULL);
671   main_init();
672
673   fin.read_done = dread;
674   fin.error_handler = derror;
675   block_io_add(&fin, 0);
676   block_io_read(&fin, rb, sizeof(rb));
677
678   fout.write_done = dwrite;
679   fout.error_handler = derror;
680   block_io_add(&fout, 1);
681   block_io_write(&fout, "Hello, world!\n", 14);
682
683   hook.handler = dhook;
684   hook_add(&hook);
685
686   tm.handler = dtimer;
687   timer_add_rel(&tm,  1000);
688
689   sg.signum = SIGINT;
690   sg.handler = dsignal;
691   signal_add(&sg);
692
693   mp.handler = dexit;
694   if (!process_fork(&mp))
695     dentry();
696
697   main_debug();
698
699   main_loop();
700   msg(L_INFO, "Finished.");
701 }
702
703 #endif