X-Git-Url: http://mj.ucw.cz/gitweb/?a=blobdiff_plain;f=ucw%2Fmainloop.h;h=5669e22e38ff27babcb6578675414db03ae2ba1a;hb=77c84c65dc22afe21bc52d95cd3996b8e1c7d065;hp=bf5cfcaef4f5737104be2c840d3a93ffe6b6f1e1;hpb=42f0e0e3c19a22cd0643f7f8739d0e9585904f0c;p=libucw.git diff --git a/ucw/mainloop.h b/ucw/mainloop.h index bf5cfcae..5669e22e 100644 --- a/ucw/mainloop.h +++ b/ucw/mainloop.h @@ -1,7 +1,7 @@ /* * UCW Library -- Main Loop * - * (c) 2004--2011 Martin Mares + * (c) 2004--2012 Martin Mares * * This software may be freely distributed and used according to the terms * of the GNU Lesser General Public License. @@ -10,10 +10,56 @@ #ifndef _UCW_MAINLOOP_H #define _UCW_MAINLOOP_H -#include "ucw/clists.h" +#include +#include #include +#ifdef CONFIG_UCW_CLEAN_ABI +#define block_io_add ucw_block_io_add +#define block_io_del ucw_block_io_del +#define block_io_read ucw_block_io_read +#define block_io_set_timeout ucw_block_io_set_timeout +#define block_io_write ucw_block_io_write +#define file_add ucw_file_add +#define file_chg ucw_file_chg +#define file_debug ucw_file_debug +#define file_del ucw_file_del +#define hook_add ucw_hook_add +#define hook_debug ucw_hook_debug +#define hook_del ucw_hook_del +#define main_cleanup ucw_main_cleanup +#define main_current ucw_main_current +#define main_debug_context ucw_main_debug_context +#define main_delete ucw_main_delete +#define main_destroy ucw_main_destroy +#define main_get_time ucw_main_get_time +#define main_init ucw_main_init +#define main_loop ucw_main_loop +#define main_new ucw_main_new +#define main_step ucw_main_step +#define main_switch_context ucw_main_switch_context +#define main_teardown ucw_main_teardown +#define process_add ucw_process_add +#define process_debug ucw_process_debug +#define process_del ucw_process_del +#define process_fork ucw_process_fork +#define rec_io_add ucw_rec_io_add +#define rec_io_del ucw_rec_io_del +#define rec_io_parse_line ucw_rec_io_parse_line +#define rec_io_set_timeout ucw_rec_io_set_timeout +#define rec_io_start_read ucw_rec_io_start_read +#define rec_io_stop_read ucw_rec_io_stop_read +#define rec_io_write ucw_rec_io_write +#define signal_add ucw_signal_add +#define signal_debug ucw_signal_debug +#define signal_del ucw_signal_del +#define timer_add ucw_timer_add +#define timer_add_rel ucw_timer_add_rel +#define timer_debug ucw_timer_debug +#define timer_del ucw_timer_del +#endif + /*** * [[basic]] * Basic operations @@ -24,8 +70,7 @@ /** The main loop context **/ struct main_context { - timestamp_t now; /* [*] Current time in milliseconds since the UNIX epoch. See main_get_time(). */ - ucw_time_t now_seconds; /* [*] Current time in seconds since the epoch. */ + timestamp_t now; /* [*] Current time in milliseconds since an unknown epoch. See main_get_time(). */ timestamp_t idle_time; /* [*] Total time in milliseconds spent by waiting for events. */ uns shutdown; /* [*] Setting this to nonzero forces the main_loop() function to terminate. */ clist file_list; @@ -111,12 +156,11 @@ static inline void main_shut_down(void) /** * Show the current state of a given context (use @main_debug() for the current context). - * Available only if LibUCW has been compiled with `CONFIG_DEBUG`. + * Available only if LibUCW has been compiled with `CONFIG_UCW_DEBUG`. **/ void main_debug_context(struct main_context *m); -static inline void -main_debug(void) +static inline void main_debug(void) { main_debug_context(main_current()); } @@ -143,12 +187,6 @@ static inline timestamp_t main_get_now(void) return main_current()->now; } -/** An analog of @main_get_now() returning the number of seconds since the system epoch. **/ -static inline ucw_time_t main_get_now_seconds(void) -{ - return main_current()->now_seconds; -} - /** * This is a description of a timer. * You define the handler function and possibly user-defined data you wish @@ -168,7 +206,8 @@ struct main_timer { * timer. It is permitted (and usual) to call this function from the * timer's handler itself if you want the timer to trigger again. * - * The @expire parameter is absolute, use @timer_add_rel() for a relative version. + * The @expire parameter is absolute (in the same time scale as @main_get_now()), + * use @timer_add_rel() for a relative version. **/ void timer_add(struct main_timer *tm, timestamp_t expires); @@ -178,10 +217,16 @@ void timer_add_rel(struct main_timer *tm, timestamp_t expires_delta); /** * Removes a timer from the active ones. It is permitted (and common) to call * this function from the timer's handler itself if you want to deactivate - * the timer. + * the timer. Removing an already removed timer does nothing. **/ void timer_del(struct main_timer *tm); +/** Tells whether a timer is running. **/ +static inline int timer_is_active(struct main_timer *tm) +{ + return !!tm->expires; +} + /** * Forces refresh of the current timestamp cached in the active context. * You usually do not need to call this, since it is called every time the @@ -190,7 +235,7 @@ void timer_del(struct main_timer *tm); **/ void main_get_time(void); -/** Show current state of a timer. Available only if LibUCW has been compiled with `CONFIG_DEBUG`. **/ +/** Show current state of a timer. Available only if LibUCW has been compiled with `CONFIG_UCW_DEBUG`. **/ void timer_debug(struct main_timer *tm); /*** @@ -241,16 +286,25 @@ enum main_hook_return { * Inserts a new hook into the loop. * The hook will be scheduled at least once before next sleep. * May be called from inside a hook handler too. + * Adding an already added hook is permitted and if the hook has been run, + * it will be run again before next sleep. **/ void hook_add(struct main_hook *ho); /** * Removes an existing hook from the loop. * May be called from inside a hook handler (to delete itself or another hook). + * Removing an already removed hook does nothing. **/ void hook_del(struct main_hook *ho); -/** Show current state of a hook. Available only if LibUCW has been compiled with `CONFIG_DEBUG`. **/ +/** Tells if a hook is active (i.e., added). **/ +static inline int hook_is_active(struct main_hook *ho) +{ + return clist_is_linked(&ho->n); +} + +/** Show current state of a hook. Available only if LibUCW has been compiled with `CONFIG_UCW_DEBUG`. **/ void hook_debug(struct main_hook *ho); @@ -327,10 +381,17 @@ void file_chg(struct main_file *fi); * please use this function first. * * Can be called from a handler. + * Removing an already removed file does nothing. **/ void file_del(struct main_file *fi); -/** Show current state of a file. Available only if LibUCW has been compiled with `CONFIG_DEBUG`. **/ +/** Tells if a file is active (i.e., added). **/ +static inline int file_is_active(struct main_file *fi) +{ + return clist_is_linked(&fi->n); +} + +/** Show current state of a file. Available only if LibUCW has been compiled with `CONFIG_UCW_DEBUG`. **/ void file_debug(struct main_file *fi); /*** @@ -373,7 +434,7 @@ struct main_block_io { /** Activate a block I/O structure. **/ void block_io_add(struct main_block_io *bio, int fd); -/** Deactivate a block I/O structure. **/ +/** Deactivate a block I/O structure. Calling twice is safe. **/ void block_io_del(struct main_block_io *bio); /** @@ -432,6 +493,12 @@ void block_io_write(struct main_block_io *bio, void *buf, uns len); **/ void block_io_set_timeout(struct main_block_io *bio, timestamp_t expires_delta); +/** Tells if a @bio is active (i.e., added). **/ +static inline int block_io_is_active(struct main_block_io *bio) +{ + return file_is_active(&bio->file); +} + /*** * [[recordio]] * Asynchronous record I/O @@ -494,7 +561,7 @@ struct main_rec_io { /** Activate a record I/O structure. **/ void rec_io_add(struct main_rec_io *rio, int fd); -/** Deactivate a record I/O structure. **/ +/** Deactivate a record I/O structure. Calling twice is safe. **/ void rec_io_del(struct main_rec_io *rio); /** @@ -511,7 +578,7 @@ void rec_io_start_read(struct main_rec_io *rio); void rec_io_stop_read(struct main_rec_io *rio); /** Analogous to @block_io_set_timeout(). **/ -void rec_io_set_timeout(struct main_rec_io *bio, timestamp_t expires_delta); +void rec_io_set_timeout(struct main_rec_io *rio, timestamp_t expires_delta); void rec_io_write(struct main_rec_io *rio, void *data, uns len); @@ -543,6 +610,12 @@ enum rec_io_notify_status { RIO_EVENT_EOF = 3, /* Read: EOF seen */ }; +/** Tells if a @rio is active (i.e., added). **/ +static inline int rec_io_is_active(struct main_rec_io *rio) +{ + return file_is_active(&rio->file); +} + /*** * [[process]] * Child processes @@ -577,6 +650,7 @@ void process_add(struct main_process *mp); * Removes the process from the watched set. This is done * automatically, when the process terminates, so you need it only * when you do not want to watch a running process any more. + * Removing an already removed process does nothing. */ void process_del(struct main_process *mp); @@ -596,7 +670,13 @@ void process_del(struct main_process *mp); **/ int process_fork(struct main_process *mp); -/** Show current state of a process. Available only if LibUCW has been compiled with `CONFIG_DEBUG`. **/ +/** Tells if a process is active (i.e., added). **/ +static inline int process_is_active(struct main_process *mp) +{ + return clist_is_linked(&mp->n); +} + +/** Show current state of a process. Available only if LibUCW has been compiled with `CONFIG_UCW_DEBUG`. **/ void process_debug(struct main_process *pr); /*** @@ -636,10 +716,16 @@ struct main_signal { /** Request a signal to be caught and delivered synchronously. **/ void signal_add(struct main_signal *ms); -/** Cancel a request for signal catching. **/ +/** Cancel a request for signal catching. Calling twice is safe. **/ void signal_del(struct main_signal *ms); -/** Show current state of a signal catcher. Available only if LibUCW has been compiled with `CONFIG_DEBUG`. **/ +/** Tells if a signal catcher is active (i.e., added). **/ +static inline int signal_is_active(struct main_signal *ms) +{ + return clist_is_linked(&ms->n); +} + +/** Show current state of a signal catcher. Available only if LibUCW has been compiled with `CONFIG_UCW_DEBUG`. **/ void signal_debug(struct main_signal *sg); #endif