2 * UCW Library -- Main Loop
4 * (c) 2004--2012 Martin Mares <mj@ucw.cz>
6 * This software may be freely distributed and used according to the terms
7 * of the GNU Lesser General Public License.
10 #ifndef _UCW_MAINLOOP_H
11 #define _UCW_MAINLOOP_H
13 #include <ucw/clists.h>
14 #include <ucw/process.h>
23 * First of all, let us take a look at the basic operations with main loop contexts.
26 /** The main loop context **/
28 timestamp_t now; /* [*] Current time in milliseconds since an unknown epoch. See main_get_time(). */
29 timestamp_t idle_time; /* [*] Total time in milliseconds spent by waiting for events. */
30 uns shutdown; /* [*] Setting this to nonzero forces the main_loop() function to terminate. */
32 clist file_active_list;
39 #ifdef CONFIG_UCW_EPOLL
40 int epoll_fd; /* File descriptor used for epoll */
41 struct epoll_event *epoll_events;
42 clist file_recalc_list;
44 uns poll_table_obsolete;
45 struct pollfd *poll_table;
46 struct main_file **poll_file_table;
48 struct main_timer **timer_table; /* Growing array containing the heap of timers */
49 sigset_t want_signals;
52 struct main_file *sig_pipe_file;
53 struct main_signal *sigchld_handler;
56 struct main_context *main_new(void); /** Create a new context. **/
59 * Delete a context, assuming it does have any event handlers attached. Does nothing if @m is NULL.
60 * It is allowed to call @main_delete() from a hook function of the same context, but you must
61 * never return to the main loop -- e.g., you can exit() the process instead.
63 void main_delete(struct main_context *m);
66 * Delete a context. If there are any event handlers attached, they are deactivated
67 * (but the responsibility to free the memory there were allocated from lies upon you).
68 * If there are any file handlers, the corresponding file descriptors are closed.
70 void main_destroy(struct main_context *m);
72 /** Switch the current context of the calling thread. Returns the previous current context. **/
73 struct main_context *main_switch_context(struct main_context *m);
75 /** Return the current context. Dies if there is none or if the context has been deleted. **/
76 struct main_context *main_current(void);
78 /** Initialize the main loop module and create a top-level context. **/
81 /** Deinitialize the main loop module, calling @main_delete() on the top-level context. **/
82 void main_cleanup(void);
85 * Deinitialize the main loop module, calling @main_destroy() on the top-level context.
86 * This is especially useful in a freshly forked-off child process.
88 void main_teardown(void);
91 * Start the event loop on the current context.
92 * It will watch the provided objects and call callbacks.
93 * Terminates when someone calls @main_shut_down(),
94 * or when all <<hook,hooks>> return <<enum_main_hook_return,`HOOK_DONE`>>
95 * or at last one <<hook,hook>> returns <<enum_main_hook_return,`HOOK_SHUTDOWN`>>.
100 * Perform a single iteration of the main loop.
101 * Check if there are any events ready and process them.
102 * If there are none, do not wait.
104 void main_step(void);
106 /** Ask the main loop to terminate at the nearest occasion. **/
107 static inline void main_shut_down(void)
109 main_current()->shutdown = 1;
113 * Show the current state of a given context (use @main_debug() for the current context).
114 * Available only if LibUCW has been compiled with `CONFIG_UCW_DEBUG`.
116 void main_debug_context(struct main_context *m);
121 main_debug_context(main_current());
129 * The event loop provides the current time, measured as a 64-bit number
130 * of milliseconds since the system epoch (represented in the type `timestamp_t`).
132 * You can also register timers, which call a handler function at a given moment.
133 * The handler function must either call @timer_del() to delete the timer, or call
134 * @timer_add() with a different expiration time.
138 * Get the current timestamp cached in the current context. It is refreshed in every
139 * iteration of the event loop, or explicitly by calling @main_get_time().
141 static inline timestamp_t main_get_now(void)
143 return main_current()->now;
147 * This is a description of a timer.
148 * You define the handler function and possibly user-defined data you wish
149 * to pass to the handler, and then you invoke @timer_add().
155 void (*handler)(struct main_timer *tm); /* [*] Function to be called when the timer expires. */
156 void *data; /* [*] Data for use by the handler */
160 * Add a new timer into the main loop to be watched and called
161 * when it expires. It can also be used to modify an already running
162 * timer. It is permitted (and usual) to call this function from the
163 * timer's handler itself if you want the timer to trigger again.
165 * The @expire parameter is absolute (in the same time scale as @main_get_now()),
166 * use @timer_add_rel() for a relative version.
168 void timer_add(struct main_timer *tm, timestamp_t expires);
170 /** Like @timer_add(), but the expiration time is relative to the current time. **/
171 void timer_add_rel(struct main_timer *tm, timestamp_t expires_delta);
174 * Removes a timer from the active ones. It is permitted (and common) to call
175 * this function from the timer's handler itself if you want to deactivate
176 * the timer. Removing an already removed timer does nothing.
178 void timer_del(struct main_timer *tm);
180 /** Tells whether a timer is running. **/
181 static inline int timer_is_active(struct main_timer *tm)
183 return !!tm->expires;
187 * Forces refresh of the current timestamp cached in the active context.
188 * You usually do not need to call this, since it is called every time the
189 * loop polls for events. It is here if you need extra precision or some of the
190 * hooks takes a long time.
192 void main_get_time(void);
194 /** Show current state of a timer. Available only if LibUCW has been compiled with `CONFIG_UCW_DEBUG`. **/
195 void timer_debug(struct main_timer *tm);
202 * The hooks are called whenever the main loop performs an iteration.
203 * You can shutdown the main loop from within them or request an iteration
204 * to happen without sleeping (just poll, no waiting for events).
208 * A hook. It contains the function to call and some user data.
210 * The handler() must return one value from
211 * <<enum_main_hook_return,`main_hook_return`>>.
213 * Fill with the hook and data and pass it to @hook_add().
217 int (*handler)(struct main_hook *ho); /* [*] Hook function; returns HOOK_xxx */
218 void *data; /* [*] For use by the handler */
222 * Return value of the hook handler().
223 * Specifies what should happen next.
225 * - `HOOK_IDLE` -- Let the loop sleep until something happens, call after that.
226 * - `HOOK_RETRY` -- Force the loop to perform another iteration without sleeping.
227 * This will cause calling of all the hooks again soon.
228 * - `HOOK_DONE` -- The loop will terminate if all hooks return this.
229 * - `HOOK_SHUTDOWN` -- Shuts down the loop.
231 * The `HOOK_IDLE` and `HOOK_RETRY` constants are also used as return values
234 enum main_hook_return {
242 * Inserts a new hook into the loop.
243 * The hook will be scheduled at least once before next sleep.
244 * May be called from inside a hook handler too.
245 * Adding an already added hook is permitted and if the hook has been run,
246 * it will be run again before next sleep.
248 void hook_add(struct main_hook *ho);
251 * Removes an existing hook from the loop.
252 * May be called from inside a hook handler (to delete itself or another hook).
253 * Removing an already removed hook does nothing.
255 void hook_del(struct main_hook *ho);
257 /** Tells if a hook is active (i.e., added). **/
258 static inline int hook_is_active(struct main_hook *ho)
260 return clist_is_linked(&ho->n);
263 /** Show current state of a hook. Available only if LibUCW has been compiled with `CONFIG_UCW_DEBUG`. **/
264 void hook_debug(struct main_hook *ho);
269 * Activity on file descriptors
270 * ----------------------------
272 * You can ask the main loop to watch a set of file descriptors for activity.
273 * (This is a generalization of the select() and poll() system calls. Internally,
274 * it uses either poll() or the more efficient epoll().)
276 * You create a <<struct_main_file,`struct main_file`>>, fill in a file descriptor
277 * and pointers to handler functions to be called when the descriptor becomes
278 * ready for reading and/or writing, and call @file_add(). When you need to
279 * modify the handlers (e.g., to set them to NULL if you are no longer interested
280 * in a given event), you should call @file_chg() to notify the main loop about
283 * From within the handler functions, you are allowed to call @file_chg() and even
286 * The return value of a handler function should be either <<enum_main_hook_return,`HOOK_RETRY`>>
287 * or <<enum_main_hook_return,`HOOK_IDLE`>>. <<enum_main_hook_return,`HOOK_RETRY`>>
288 * signals that the function would like to consume more data immediately
289 * (i.e., it wants to be called again soon, but the event loop can postpone it after
290 * processing other events to avoid starvation). <<enum_main_hook_return,`HOOK_IDLE`>>
291 * tells that the handler wants to be called when the descriptor becomes ready again.
293 * For backward compatibility, 0 can be used instead of <<enum_main_hook_return,`HOOK_IDLE`>>
294 * and 1 for <<enum_main_hook_return,`HOOK_RETRY`>>.
296 * If you want to read/write fixed-size blocks of data asynchronously, the
297 * <<blockio,Asynchronous block I/O>> interface could be more convenient.
301 * This structure describes a file descriptor to be watched and the handlers
302 * to be called when the descriptor is ready for reading and/or writing.
306 int fd; /* [*] File descriptor */
307 int (*read_handler)(struct main_file *fi); /* [*] To be called when ready for reading/writing; must call file_chg() afterwards */
308 int (*write_handler)(struct main_file *fi);
309 void *data; /* [*] Data for use by the handlers */
311 #ifdef CONFIG_UCW_EPOLL
312 uns last_want_events;
314 struct pollfd *pollfd;
319 * Insert a <<struct_main_file,`main_file`>> structure into the main loop to be
320 * watched for activity. You can call this at any time, even inside a handler
321 * (of course for a different file descriptor than the one of the handler).
323 * The file descriptor is automatically set to the non-blocking mode.
325 void file_add(struct main_file *fi);
328 * Tell the main loop that the file structure has changed. Call it whenever you
329 * change any of the handlers.
331 * Can be called only on active files (only the ones added by @file_add()).
333 void file_chg(struct main_file *fi);
336 * Removes a file from the watched set. If you want to close a descriptor,
337 * please use this function first.
339 * Can be called from a handler.
340 * Removing an already removed file does nothing.
342 void file_del(struct main_file *fi);
344 /** Tells if a file is active (i.e., added). **/
345 static inline int file_is_active(struct main_file *fi)
347 return clist_is_linked(&fi->n);
350 /** Show current state of a file. Available only if LibUCW has been compiled with `CONFIG_UCW_DEBUG`. **/
351 void file_debug(struct main_file *fi);
355 * Asynchronous block I/O
356 * ----------------------
358 * If you are reading or writing fixed-size blocks of data, you can let the
359 * block I/O interface handle the boring routine of handling partial reads
360 * and writes for you.
362 * You just create <<struct_main_block_io,`struct main_block_io`>> and call
363 * @block_io_add() on it, which sets up some <<struct_main_file,`main_file`>>s internally.
364 * Then you can just call @block_io_read() or @block_io_write() to ask for
365 * reading or writing of a given block. When the operation is finished,
366 * your handler function is called.
368 * Additionally, the block I/O is equipped with a timer, which can be used
369 * to detect communication timeouts. The timer is not touched internally
370 * (except that it gets added and deleted at the right places), feel free
371 * to adjust it from your handler functions by @block_io_set_timeout().
372 * When the timer expires, the error handler is automatically called with
373 * <<enum_block_io_err_cause,`BIO_ERR_TIMEOUT`>>.
376 /** The block I/O structure. **/
377 struct main_block_io {
378 struct main_file file;
379 byte *rbuf; /* Read/write pointers for use by file_read/write */
383 void (*read_done)(struct main_block_io *bio); /* [*] Called when file_read is finished; rpos < rlen if EOF */
384 void (*write_done)(struct main_block_io *bio); /* [*] Called when file_write is finished */
385 void (*error_handler)(struct main_block_io *bio, int cause); /* [*] Handler to call on errors */
386 struct main_timer timer;
387 void *data; /* [*] Data for use by the handlers */
390 /** Activate a block I/O structure. **/
391 void block_io_add(struct main_block_io *bio, int fd);
393 /** Deactivate a block I/O structure. Calling twice is safe. **/
394 void block_io_del(struct main_block_io *bio);
397 * Specifies when or why an error happened. This is passed to the error handler.
398 * `errno` is still set to the original source of error. The only exception
399 * is `BIO_ERR_TIMEOUT`, in which case `errno` is not set and the only possible
400 * cause of it is timeout of the timer associated with the block_io
401 * (see @block_io_set_timeout()).
403 enum block_io_err_cause {
410 * Ask the main loop to read @len bytes of data from @bio into @buf.
411 * It cancels any previous unfinished read requested in this way.
413 * When the read is done, the read_done() handler is called. If an EOF occurred,
414 * `rpos < rlen` (eg. not all data were read).
416 * Can be called from a handler.
418 * You can use a call with zero @len to cancel the current read, but all read data
419 * will be thrown away.
421 void block_io_read(struct main_block_io *bio, void *buf, uns len);
424 * Request that the main loop writes @len bytes of data from @buf to @bio.
425 * Cancels any previous unfinished write and overwrites `write_handler`.
427 * When it is written, the write_done() handler is called.
429 * Can be called from a handler.
431 * If you call it with zero @len, it will cancel the previous write, but note
432 * that some data may already be written.
434 void block_io_write(struct main_block_io *bio, void *buf, uns len);
437 * Sets a timer for a file @bio. If the timer is not overwritten or disabled
438 * until @expires_delta milliseconds, the file timeouts and error_handler() is called with
439 * <<enum_block_io_err_cause,`BIO_ERR_TIMEOUT`>>. A value of `0` stops the timer.
441 * Previous setting of the timeout on the same file will be overwritten.
443 * The use-cases for this are mainly sockets or pipes, when:
445 * - You want to drop inactive connections (no data comes in or out for a given time, not
446 * incomplete messages).
447 * - You want to enforce answer in a given time (for example authentication).
448 * - Watching maximum time for a whole connection.
450 void block_io_set_timeout(struct main_block_io *bio, timestamp_t expires_delta);
452 /** Tells if a @bio is active (i.e., added). **/
453 static inline int block_io_is_active(struct main_block_io *bio)
455 return file_is_active(&bio->file);
460 * Asynchronous record I/O
461 * -----------------------
463 * Record-based I/O is another front-end to the main loop file operations.
464 * Unlike its older cousin `main_block_io`, it is able to process records
465 * of variable length.
467 * To set it up, you create <<struct_main_rec_io,`struct main_rec_io`>> and call
468 * @rec_io_add() on it, which sets up some <<struct_main_file,`main_file`>>s internally.
470 * To read data from the file, call @rec_io_start_read() first. Whenever any data
471 * arrive from the file, they are appended to an internal buffer and the `read_handler`
472 * hook is called. The hook checks if the buffer already contains a complete record.
473 * If it is so, it processes the record and returns the number of bytes consumed.
474 * Otherwise, it returns 0 to tell the buffering machinery that more data are needed.
475 * When the read handler decides to destroy the `main_rec_io`, it must return `~0U`.
477 * On the write side, `main_rec_io` maintains a buffer keeping all data that should
478 * be written to the file. The @rec_io_write() function appends data to this buffer
479 * and it is written on background. A simple flow-control mechanism can be asked
480 * for: when more than `write_throttle_read` data are buffered for writing, reading
481 * is temporarily suspended.
483 * Additionally, the record I/O is equipped with a timer, which can be used
484 * to detect communication timeouts. The timer is not touched internally
485 * (except that it gets added and deleted at the right places), feel free
486 * to adjust it from your handler functions by @rec_io_set_timeout().
488 * All important events are passed to the `notify_handler`: errors when
489 * reading or writing, timeouts, the write buffer becoming empty, ... See
490 * <<enum_rec_io_notify_status,`enum rec_io_notify_status`>> for a complete list.
493 /** The record I/O structure. **/
495 struct main_file file;
497 byte *read_rec_start; /* [*] Start of current record */
498 uns read_avail; /* [*] How much data is available */
499 uns read_prev_avail; /* [*] How much data was available in previous read_handler */
500 uns read_buf_size; /* [*] Read buffer size allocated (can be set before rec_io_add()) */
501 uns read_started; /* Reading requested by user */
502 uns read_running; /* Reading really runs (read_started && not stopped by write_throttle_read) */
503 uns read_rec_max; /* [*] Maximum record size (0=unlimited) */
504 clist busy_write_buffers;
505 clist idle_write_buffers;
506 uns write_buf_size; /* [*] Write buffer size allocated (can be set before rec_io_add()) */
507 uns write_watermark; /* [*] How much data are waiting to be written */
508 uns write_throttle_read; /* [*] If more than write_throttle_read bytes are buffered, stop reading; 0=no stopping */
509 uns (*read_handler)(struct main_rec_io *rio); /* [*] Called whenever more bytes are read; returns 0 (want more) or number of bytes eaten */
510 int (*notify_handler)(struct main_rec_io *rio, int status); /* [*] Called to notify about errors and other events */
511 /* Returns either HOOK_RETRY or HOOK_IDLE. */
512 struct main_timer timer;
513 struct main_hook start_read_hook; /* Used internally to defer rec_io_start_read() */
514 void *data; /* [*] Data for use by the handlers */
517 /** Activate a record I/O structure. **/
518 void rec_io_add(struct main_rec_io *rio, int fd);
520 /** Deactivate a record I/O structure. Calling twice is safe. **/
521 void rec_io_del(struct main_rec_io *rio);
526 * When there were some data in the buffer (e.g., because @rec_io_stop_read()
527 * was called from the `read_handler`), it is processed as if it were read
528 * from the file once again. That is, `read_prev_avail` is reset to 0 and
529 * the `read_handler` is called to process all buffered data.
531 void rec_io_start_read(struct main_rec_io *rio);
533 /** Stop reading. **/
534 void rec_io_stop_read(struct main_rec_io *rio);
536 /** Analogous to @block_io_set_timeout(). **/
537 void rec_io_set_timeout(struct main_rec_io *bio, timestamp_t expires_delta);
539 void rec_io_write(struct main_rec_io *rio, void *data, uns len);
542 * An auxiliary function used for parsing of lines. When called in the @read_handler,
543 * it searches for the end of line character. When a complete line is found, the length
544 * of the line (including the end of line character) is returned. Otherwise, it returns zero.
546 uns rec_io_parse_line(struct main_rec_io *rio);
549 * Specifies what kind of error or other event happened, when the @notify_handler
550 * is called. In case of I/O errors, `errno` is still set.
552 * Upon @RIO_ERR_READ, @RIO_ERR_RECORD_TOO_LARGE and @RIO_EVENT_EOF, reading is stopped
553 * automatically. Upon @RIO_ERR_WRITE, writing is stopped. Upon @RIO_ERR_TIMEOUT, only the
554 * timer is deactivated.
556 * In all cases, the notification handler is allowed to call @rec_io_del(), but it
557 * must return @HOOK_IDLE in such cases.
559 enum rec_io_notify_status {
560 RIO_ERR_READ = -1, /* read() returned an error, errno set */
561 RIO_ERR_WRITE = -2, /* write() returned an error, errno set */
562 RIO_ERR_TIMEOUT = -3, /* A timeout has occurred */
563 RIO_ERR_RECORD_TOO_LARGE = -4, /* Read: read_rec_max has been exceeded */
564 RIO_EVENT_ALL_WRITTEN = 1, /* All buffered data has been written */
565 RIO_EVENT_PART_WRITTEN = 2, /* Some buffered data has been written, but more remains */
566 RIO_EVENT_EOF = 3, /* Read: EOF seen */
569 /** Tells if a @rio is active (i.e., added). **/
570 static inline int rec_io_is_active(struct main_rec_io *rio)
572 return file_is_active(&rio->file);
580 * The main loop can watch child processes and notify you,
581 * when some of them terminates.
585 * Description of a watched process.
586 * You fill in the handler() and `data`.
587 * The rest is set with @process_fork().
589 struct main_process {
591 int pid; /* Process id (0=not running) */
592 int status; /* Exit status (-1=fork failed) */
593 char status_msg[EXIT_STATUS_MSG_SIZE];
594 void (*handler)(struct main_process *mp); /* [*] Called when the process exits; process_del done automatically */
595 void *data; /* [*] For use by the handler */
599 * Asks the main loop to watch this process.
600 * As it is done automatically in @process_fork(), you need this only
601 * if you removed the process previously by @process_del().
603 void process_add(struct main_process *mp);
606 * Removes the process from the watched set. This is done
607 * automatically, when the process terminates, so you need it only
608 * when you do not want to watch a running process any more.
609 * Removing an already removed process does nothing.
611 void process_del(struct main_process *mp);
614 * Forks and fills the @mp with information about the new process.
616 * If the fork() succeeds, it:
618 * - Returns 0 in the child.
619 * - Returns 1 in the parent and calls @process_add() on it.
621 * In the case of unsuccessful fork(), it:
623 * - Fills in the `status_msg` and sets `status` to -1.
624 * - Calls the handler() as if the process terminated.
627 int process_fork(struct main_process *mp);
629 /** Tells if a process is active (i.e., added). **/
630 static inline int process_is_active(struct main_process *mp)
632 return clist_is_linked(&mp->n);
635 /** Show current state of a process. Available only if LibUCW has been compiled with `CONFIG_UCW_DEBUG`. **/
636 void process_debug(struct main_process *pr);
640 * Synchronous delivery of signals
641 * -------------------------------
643 * UNIX signals are delivered to processes in an asynchronous way: when a signal
644 * arrives (and it is not blocked), the process is interrupted and the corresponding
645 * signal handler function is called. However, most data structures and even most
646 * system library calls are not safe with respect to interrupts, so most program
647 * using signals contain subtle race conditions and may fail once in a long while.
649 * To avoid this problem, the event loop can be asked for synchronous delivery
650 * of signals. When a signal registered with @signal_add() arrives, it wakes up
651 * the loop (if it is not already awake) and it is processed in the same way
652 * as all other events.
654 * When used in a multi-threaded program, the signals are delivered to the thread
655 * which is currently using the particular main loop context. If the context is not
656 * current in any thread, the signals are blocked.
658 * As usually with UNIX signals, multiple instances of a single signal can be
659 * merged and delivered only once. (Some implementations of the main loop can even
660 * drop a signal completely during very intensive signal traffic, when an internal
661 * signal queue overflows.)
664 /** Description of a signal to catch. **/
667 int signum; /* [*] Signal to catch */
668 void (*handler)(struct main_signal *ms); /* [*] Called when the signal arrives */
669 void *data; /* [*] For use by the handler */
672 /** Request a signal to be caught and delivered synchronously. **/
673 void signal_add(struct main_signal *ms);
675 /** Cancel a request for signal catching. Calling twice is safe. **/
676 void signal_del(struct main_signal *ms);
678 /** Tells if a signal catcher is active (i.e., added). **/
679 static inline int signal_is_active(struct main_signal *ms)
681 return clist_is_linked(&ms->n);
684 /** Show current state of a signal catcher. Available only if LibUCW has been compiled with `CONFIG_UCW_DEBUG`. **/
685 void signal_debug(struct main_signal *sg);