faux/faux/eloop/eloop.c

/** @file eloop.c
 * @brief Event loop.
 *
 * It's a class to organize main event loop. Class has unified interface to get
 * different types of events: signals, file descriptor events, scheduled time
 * events. User can register callbacks for interested events. Callback has
 * the same prototype for all types of events. Callback is called with
 * associated data. Assiciated data is user data, type of event and additional
 * data with information about things specific for current type. It's a number
 * of signal for signals, file descriptor and type of file event for file
 * descriptor events, event ID and pointer to special event object for scheduled
 * time events.
 */

#ifdef HAVE_CONFIG_H
#include "config.h"
#endif /* HAVE_CONFIG_H */

#include <stdlib.h>
#include <stdint.h>
#include <stdio.h>
#include <string.h>
#include <assert.h>
#include <unistd.h>
#include <errno.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <time.h>
#include <signal.h>
#include <poll.h>
#include <sys/signalfd.h>

#include "faux/faux.h"
#include "faux/str.h"
#include "faux/net.h"
#include "faux/sched.h"
#include "faux/eloop.h"

#include "private.h"

#define TIMESPEC_TO_MILISECONDS(t) ((t.tv_sec * 1000) + (t.tv_nsec / 1000000l))

#ifdef HAVE_SIGNALFD
#define SIGNALFD_FLAGS (SFD_NONBLOCK | SFD_CLOEXEC)

#else // Standard signals
static void *faux_eloop_static_user_data = NULL;

/** @brief Signal handler sends signal number to programm over pipe.
 *
 * Static service function. It's used for non-linux implementation on systems
 * that has no signalfd() function. The pipe pair is created. The write end is
 * used in signal handler to write signo to it. The read end of pipe is used
 * with poll()-like function to get signal number in main programm. It is
 * necessary to solve race problem with poll() function and signal handlers. See
 * manpage for select() and pselect().
 */
static void faux_eloop_static_sighandler(int signo)
{
	int pipe = -1;

	if (!faux_eloop_static_user_data)
		return;

	pipe = *((int *)faux_eloop_static_user_data);

	write(pipe, &signo, sizeof(signo));
}
#endif


/** @brief Callback compare function for fd list.
 */
static int faux_eloop_fd_compare(const void *first, const void *second)
{
	const faux_eloop_fd_t *f = (const faux_eloop_fd_t *)first;
	const faux_eloop_fd_t *s = (const faux_eloop_fd_t *)second;

	return (f->fd - s->fd);
}


/** @brief Callback compare function for fd list to search by key.
 */
static int faux_eloop_fd_kcompare(const void *key, const void *list_item)
{
	int *f = (int *)key;
	const faux_eloop_fd_t *s = (const faux_eloop_fd_t *)list_item;

	return (*f - s->fd);
}


/** @brief Callback compare function for signal list.
 */
static int faux_eloop_signal_compare(const void *first, const void *second)
{
	const faux_eloop_signal_t *f = (const faux_eloop_signal_t *)first;
	const faux_eloop_signal_t *s = (const faux_eloop_signal_t *)second;

	return (f->signo - s->signo);
}


/** @brief Callback compare function for signal list to search by key.
 */
static int faux_eloop_signal_kcompare(const void *key, const void *list_item)
{
	int *f = (int *)key;
	const faux_eloop_signal_t *s = (const faux_eloop_signal_t *)list_item;

	return (*f - s->signo);
}


/** @brief Create new event loop object.
 *
 * Function gets default event callback as argument. It will be used for all
 * events if private callback for event is not specified.
 *
 * @param [in] default_event_cb Default event callback.
 * @return Allocated faux_eloop_t object or NULL on error.
 */
faux_eloop_t *faux_eloop_new(faux_eloop_cb_fn default_event_cb)
{
	faux_eloop_t *eloop = NULL;

	eloop = faux_zmalloc(sizeof(*eloop));
	assert(eloop);
	if (!eloop)
		return NULL;

	// Init
	eloop->working = BOOL_FALSE;
	eloop->default_event_cb = default_event_cb;

	// Sched
	eloop->sched = faux_sched_new();
	assert(eloop->sched);

	// FD
	eloop->fds = faux_list_new(FAUX_LIST_SORTED, FAUX_LIST_UNIQUE,
		faux_eloop_fd_compare, faux_eloop_fd_kcompare, faux_free);
	assert(eloop->fds);
	eloop->pollfds = faux_pollfd_new();
	assert(eloop->pollfds);

	// Signal
	eloop->signals = faux_list_new(FAUX_LIST_SORTED, FAUX_LIST_UNIQUE,
		faux_eloop_signal_compare, faux_eloop_signal_kcompare, faux_free);
	assert(eloop->signals);
	sigemptyset(&eloop->sig_set);
	sigfillset(&eloop->sig_mask);
#ifdef HAVE_SIGNALFD
	eloop->signal_fd = -1;
#endif

	return eloop;
}


/** @brief Free event loop object.
 *
 * @param [in] Event loop object.
 */
void faux_eloop_free(faux_eloop_t *eloop)
{
	if (!eloop)
		return;

	faux_list_free(eloop->signals);
	faux_pollfd_free(eloop->pollfds);
	faux_list_free(eloop->fds);
	faux_sched_free(eloop->sched);

	faux_free(eloop);
}


/** @brief Event loop function.
 *
 * Function blocks and waits for registered events. When event occurs the
 * correspondent callback will be called. Callback returns bool_t value. If
 * callback returns BOOL_FALSE then loop will break and unblock the programm.
 * On BOOL_TRUE the loop will wait for the next event.
 *
 * @param [in] eloop Allocated and initialized event loop object.
 * @returns BOOL_TRUE - success, BOOL_FALSE - error.
 */
bool_t faux_eloop_loop(faux_eloop_t *eloop)
{
	bool_t retval = BOOL_TRUE;
	bool_t stop = BOOL_FALSE;
	sigset_t blocked_signals;
	sigset_t orig_sig_set;
#ifdef HAVE_PPOLL
	sigset_t *sigset_for_ppoll = NULL;
#endif // HAVE_PPOLL
#ifndef HAVE_SIGNALFD
	int signal_pipe[2];
	int fflags = 0;
	void *saved_static_user_data = NULL;
#endif // not HAVE_SIGNALFD

	// If event loop is active already and we try to start nested loop
	// then return.
	if (eloop->working)
		return BOOL_FALSE;
	eloop->working = BOOL_TRUE;

	// Block signals to prevent race conditions while loop and ppoll()
	// Catch signals while ppoll() only
	sigfillset(&blocked_signals);
	sigprocmask(SIG_SETMASK, &blocked_signals, &orig_sig_set);

#ifdef HAVE_SIGNALFD
	// Create Linux-specific signal file descriptor. Wait for signals.
	eloop->signal_fd = signalfd(eloop->signal_fd, &eloop->sig_set,
		SIGNALFD_FLAGS);
	faux_pollfd_add(eloop->pollfds, eloop->signal_fd, POLLIN);

#else // Standard signal processing
#ifdef PPOLL
	sigset_for_ppoll = &eloop->sig_mask;
#endif // HAVE_PPOLL

	// Create signal pipe pair to get signal number on pipe read end
	pipe(signal_pipe);
	fcntl(signal_pipe[0], F_SETFD, FD_CLOEXEC);
	fflags = fcntl(signal_pipe[0], F_GETFL);
	fcntl(signal_pipe[0], F_SETFL, fflags | O_NONBLOCK);
	fcntl(signal_pipe[1], F_SETFD, FD_CLOEXEC);
	fflags = fcntl(signal_pipe[1], F_GETFL);
	fcntl(signal_pipe[1], F_SETFL, fflags | O_NONBLOCK);
	// Save previous value of static user data. It can be a nested
	// invocation of faux_eloop_loop() (i.e. same function but different
	// faux_eloop_t objects). So it need to be restored after loop.
	saved_static_user_data = faux_eloop_static_user_data;
	faux_eloop_static_user_data = &signal_pipe[1];
	faux_pollfd_add(eloop->pollfds, signal_pipe[0], POLLIN);

	if (faux_list_len(eloop->signals) != 0) {
		faux_list_node_t *iter = faux_list_head(eloop->signals);
		faux_eloop_signal_t *sig = NULL;
		struct sigaction sig_act = {};

		sig_act.sa_flags = 0;
		sig_act.sa_mask = eloop->sig_set;
		sig_act.sa_handler = &faux_eloop_static_sighandler;
		while ((sig = (faux_eloop_signal_t *)faux_list_each(&iter)))
			sigaction(sig->signo, &sig_act, &sig->oldact);
	}
#endif // HAVE_SIGNALFD

	// Main loop
	while (!stop) {
		int sn = 0;
		struct timespec *timeout = NULL;
		struct timespec next_interval = {};
		faux_pollfd_iterator_t pollfd_iter;
		struct pollfd *pollfd = NULL;

		// Find out next scheduled interval
		if (!faux_sched_next_interval(eloop->sched, &next_interval))
			timeout = NULL;
		else
			timeout = &next_interval;

		// Wait for events
#ifdef HAVE_PPOLL
		sn = ppoll(faux_pollfd_vector(eloop->pollfds),
			faux_pollfd_len(eloop->pollfds), timeout, sigset_for_ppoll);
#else // poll()
		sigprocmask(SIG_SETMASK, &eloop->sig_mask, NULL);
		sn = poll(faux_pollfd_vector(eloop->pollfds),
			faux_pollfd_len(eloop->pollfds),
			timeout ? TIMESPEC_TO_MILISECONDS(next_interval) : -1);
		sigprocmask(SIG_SETMASK, &blocked_signals, NULL);
#endif // HAVE_PPOLL

		// Error or signal
		if (sn < 0) {
			// Let poll() read signal pipe or signalfd on next step
			if (EINTR == errno)
				continue;
			retval = BOOL_FALSE;
			break;
		}

		// Scheduled event
		if (0 == sn) {
			faux_ev_t *ev = NULL;

			// Some scheduled events
			while((ev = faux_sched_pop(eloop->sched))) {
				faux_eloop_info_sched_t info = {};
				bool_t r = BOOL_TRUE;
				int ev_id = faux_ev_id(ev);
				faux_eloop_context_t *context =
					(faux_eloop_context_t *)faux_ev_data(ev);
				faux_eloop_cb_fn event_cb = context->event_cb;
				void *user_data = context->user_data;

				if (!faux_ev_is_busy(ev)) {
					faux_ev_free(ev);
					ev = NULL;
				}
				if (!event_cb)
					event_cb = eloop->default_event_cb;
				if (!event_cb) // Callback is not defined
					continue;
				info.ev_id = ev_id;
				// Callback will get only rescheduled event object.
				// If event is not scheduled, callback will get NULL.
				info.ev = ev;
				// Execute callback
				r = event_cb(eloop, FAUX_ELOOP_SCHED, &info,
					user_data);
				// BOOL_FALSE return value means "break the loop"
				if (!r)
					stop = BOOL_TRUE;
			}
			continue;
		}

		// File descriptor
		faux_pollfd_init_iterator(eloop->pollfds, &pollfd_iter);
		while ((pollfd = faux_pollfd_each_active(eloop->pollfds, &pollfd_iter))) {
			int fd = pollfd->fd;
			faux_eloop_info_fd_t info = {};
			faux_eloop_cb_fn event_cb = NULL;
			faux_eloop_fd_t *entry = NULL;
			bool_t r = BOOL_TRUE;

			// Read special signal file descriptor
#ifdef HAVE_SIGNALFD
			if (fd == eloop->signal_fd) {
				struct signalfd_siginfo signal_info = {};
				while (faux_read(fd, &signal_info,
					sizeof(signal_info)) == sizeof(signal_info)) {
					int signo = signal_info.ssi_signo;
#else
			if (fd == signal_pipe[0]) {
				int tmp = 0;
				while (faux_read(fd, &tmp,
					sizeof(tmp)) == sizeof(tmp)) {
					int signo = tmp;
#endif // HAVE_SIGNALFD
					faux_eloop_info_signal_t sinfo = {};
					faux_eloop_signal_t *sentry =
						(faux_eloop_signal_t *)faux_list_kfind(
						eloop->signals, &signo);

					if (!sentry) // Not registered signal. Drop it.
						continue;
					event_cb = sentry->context.event_cb;
					if (!event_cb)
						event_cb = eloop->default_event_cb;
					if (!event_cb) // Callback is not defined
						continue;
					sinfo.signo = signo;

					// Execute callback
					r = event_cb(eloop, FAUX_ELOOP_SIGNAL, &sinfo,
						sentry->context.user_data);
					// BOOL_FALSE return value means "break the loop"
					if (!r)
						stop = BOOL_TRUE;
				}
				continue; // Another fds are common, not signal
			}

			// File descriptor
			entry = (faux_eloop_fd_t *)faux_list_kfind(eloop->fds, &fd);
			assert(entry);
			if (!entry) // Something went wrong
				continue;
			event_cb = entry->context.event_cb;
			if (!event_cb)
				event_cb = eloop->default_event_cb;
			if (!event_cb) // Callback function is not defined for this event
				continue;
			info.fd = fd;
			info.revents = pollfd->revents;

			// Execute callback
			r = event_cb(eloop, FAUX_ELOOP_FD, &info, entry->context.user_data);
			// BOOL_FALSE return value means "break the loop"
			if (!r)
				stop = BOOL_TRUE;
		}

	} // Loop end

#ifdef HAVE_SIGNALFD
	// Close signal file descriptor
	faux_pollfd_del_by_fd(eloop->pollfds, eloop->signal_fd);
	close(eloop->signal_fd);
	eloop->signal_fd = -1;

#else // Standard signals. Restore signal handlers
	// Restore saved static_user_data. It must be done before sigaction()
	// that restores old signal handlers.
	faux_eloop_static_user_data = saved_static_user_data;
	if (faux_list_len(eloop->signals) != 0) {
		faux_list_node_t *iter = faux_list_head(eloop->signals);
		faux_eloop_signal_t *sig = NULL;

		while ((sig = (faux_eloop_signal_t *)faux_list_each(&iter)))
			sigaction(sig->signo, &sig->oldact, NULL);
	}

	faux_pollfd_del_by_fd(eloop->pollfds, signal_pipe[0]);
	close(signal_pipe[0]);
	close(signal_pipe[1]);
#endif

	// Unblock signals
	sigprocmask(SIG_SETMASK, &orig_sig_set, NULL);

	// Deactivate loop flag
	eloop->working = BOOL_FALSE;

	return retval;
}


/** @brief Registers file descriptor to wait for events.
 *
 * See poll() for explanation of possible file events ("events" argument).
 *
 * @param [in] eloop Allocated and initialized event loop object.
 * @param [in] fd File descriptor to wait on.
 * @param [in] events File events mask like POLLIN, POLLOUT.
 * @param [in] event_cb Callback for event.
 * @param [in] user_data User data to pass to callback.
 * @return BOOL_TRUE - success, BOOL_FALSE - error.
 */
bool_t faux_eloop_add_fd(faux_eloop_t *eloop, int fd, short events,
	faux_eloop_cb_fn event_cb, void *user_data)
{
	faux_eloop_fd_t *entry = NULL;
	faux_list_node_t *new_node = NULL;

	assert(eloop);
	if (!eloop || (fd < 0))
		return BOOL_FALSE;

	entry = faux_zmalloc(sizeof(*entry));
	if (!entry)
		return BOOL_FALSE;
	entry->fd = fd;
	entry->events = events;
	entry->context.event_cb = event_cb;
	entry->context.user_data = user_data;

	if (!(new_node = faux_list_add(eloop->fds, entry))) {
		faux_free(entry);
		return BOOL_FALSE;
	}

	if (!faux_pollfd_add(eloop->pollfds, entry->fd, entry->events)) {
		faux_list_del(eloop->fds, new_node);
		faux_free(entry);
		return BOOL_FALSE;
	}

	return BOOL_TRUE;
}


/** @brief Registers additional event for specified fd.
 *
 * See poll() for explanation of possible file events ("events" argument).
 * Suppose some fd was added by faux_eloop_add_fd(). User have specified some
 * events like POLLIN. Now user wants to track POLLOUT event too. So it's not
 * necessary to remove fd by faux_eloop_del_fd() and then re-add it with new
 * event mask. User can include additional events by
 * faux_eloop_include_fd_event(). Specified event will be added to existent
 * event mask.
 *
 * @param [in] eloop Allocated and initialized event loop object.
 * @param [in] fd File descriptor to change event mask.
 * @param [in] events File event to include (like POLLIN, POLLOUT).
 * @return BOOL_TRUE - success, BOOL_FALSE - error.
 */
bool_t faux_eloop_include_fd_event(faux_eloop_t *eloop, int fd, short event)
{
	faux_eloop_fd_t *entry = NULL;

	assert(eloop);
	if (!eloop)
		return BOOL_FALSE;
	assert(fd >= 0);
	if (fd < 0)
		return BOOL_FALSE;

	entry = (faux_eloop_fd_t *)faux_list_kfind(eloop->fds, &fd);
	if (!entry)
		return BOOL_FALSE;
	entry->events = entry->events | event;
	faux_pollfd_del_by_fd(eloop->pollfds, fd);
	faux_pollfd_add(eloop->pollfds, fd, entry->events);

	return BOOL_TRUE;
}


/** @brief Unregisters event for specified fd.
 *
 * See poll() for explanation of possible file events ("events" argument).
 * Suppose some fd was added by faux_eloop_add_fd(). User have specified some
 * events like POLLIN, POLLOUT. Now user doesn't wants to track one of the
 * events (POLLOUT for example). So it's not necessary to remove fd by
 * faux_eloop_del_fd() and then re-add it with new event mask. User can exclude
 * event by faux_eloop_include_fd_event(). Specified event will be excluded from
 * existent event mask.
 *
 * @param [in] eloop Allocated and initialized event loop object.
 * @param [in] fd File descriptor to change event mask.
 * @param [in] events File event to exclude (like POLLIN, POLLOUT).
 * @return BOOL_TRUE - success, BOOL_FALSE - error.
 */
bool_t faux_eloop_exclude_fd_event(faux_eloop_t *eloop, int fd, short event)
{
	faux_eloop_fd_t *entry = NULL;

	assert(eloop);
	if (!eloop)
		return BOOL_FALSE;
	assert(fd >= 0);
	if (fd < 0)
		return BOOL_FALSE;

	entry = (faux_eloop_fd_t *)faux_list_kfind(eloop->fds, &fd);
	if (!entry)
		return BOOL_FALSE;
	entry->events = entry->events & (~event);
	faux_pollfd_del_by_fd(eloop->pollfds, fd);
	faux_pollfd_add(eloop->pollfds, fd, entry->events);

	return BOOL_TRUE;
}


/** @brief Unregisters file descriptor.
 *
 * @param [in] eloop Allocated and initialized event loop object.
 * @param [in] fd File descriptor to unregister.
 * @return BOOL_TRUE - success, BOOL_FALSE - error.
 */
bool_t faux_eloop_del_fd(faux_eloop_t *eloop, int fd)
{
	if (!eloop || (fd < 0))
		return BOOL_FALSE;

	if (!faux_list_kdel(eloop->fds, &fd))
		return BOOL_FALSE;

	if (!faux_pollfd_del_by_fd(eloop->pollfds, fd))
		return BOOL_FALSE;

	return BOOL_TRUE;
}


/** @brief Unregisters all file descriptors.
 *
 * @param [in] eloop Allocated and initialized event loop object.
 * @return BOOL_TRUE - success, BOOL_FALSE - error.
 */
bool_t faux_eloop_del_fd_all(faux_eloop_t *eloop)
{
	faux_list_node_t *iter = NULL;

	if (!eloop)
		return BOOL_FALSE;

	// "Del all" function is so complex because pollfd object
	// contains not user added fds only. It contains special fd for signals,
	// service pipe and may be something else. So del all fds one by one.
	while ((iter = faux_list_tail(eloop->fds))) {
		faux_eloop_fd_t *entry = NULL;
		entry = (faux_eloop_fd_t *)faux_list_data(iter);
		faux_eloop_del_fd(eloop, entry->fd);
	}

	return BOOL_TRUE;
}


/** @brief Registers signal to wait for.
 *
 * @param [in] eloop Allocated and initialized event loop object.
 * @param [in] signal Signal number to wait for.
 * @param [in] event_cb Callback for event.
 * @param [in] user_data User data to pass to callback.
 * @return BOOL_TRUE - success, BOOL_FALSE - error.
 */
bool_t faux_eloop_add_signal(faux_eloop_t *eloop, int signo,
	faux_eloop_cb_fn event_cb, void *user_data)
{
	faux_eloop_signal_t *entry = NULL;

	if (!eloop || (signo < 0))
		return BOOL_FALSE;

	if (sigismember(&eloop->sig_set, signo) == 1) { // Already exists
		// Signal must be reassigned. So remove previous one
		if (!faux_eloop_del_signal(eloop, signo))
			return BOOL_FALSE;
	}

	// Firstly try to add signal to sigset. Library function will validate
	// signal number value.
	if (sigaddset(&eloop->sig_set, signo) < 0)
		return BOOL_FALSE; // Invalid signal number
	sigdelset(&eloop->sig_mask, signo);

	entry = faux_zmalloc(sizeof(*entry));
	if (!entry) {
		sigdelset(&eloop->sig_set, signo);
		sigaddset(&eloop->sig_mask, signo);
		return BOOL_FALSE;
	}
	entry->signo = signo;
	entry->context.event_cb = event_cb;
	entry->context.user_data = user_data;

	if (!faux_list_add(eloop->signals, entry)) {
		faux_free(entry);
		sigdelset(&eloop->sig_set, signo);
		sigaddset(&eloop->sig_mask, signo);
		return BOOL_FALSE;
	}

	if (eloop->working) { // Add signal on the fly
#ifdef HAVE_SIGNALFD
		// Reattach signalfd handler with updated sig_set
		eloop->signal_fd = signalfd(eloop->signal_fd, &eloop->sig_set,
			SIGNALFD_FLAGS);

#else // Standard signals
		struct sigaction sig_act = {};
		sig_act.sa_flags = 0;
		sig_act.sa_mask = eloop->sig_set;
		sig_act.sa_handler = &faux_eloop_static_sighandler;
		sigaction(signo, &sig_act, &entry->oldact);
#endif
	}

	return BOOL_TRUE;
}


/** @brief Unregisters signal to wait for.
 *
 * @param [in] eloop Allocated and initialized event loop object.
 * @param [in] signal Signal to unregister.
 * @return BOOL_TRUE - success, BOOL_FALSE - error.
 */
bool_t faux_eloop_del_signal(faux_eloop_t *eloop, int signo)
{
	if (!eloop || (signo < 0))
		return BOOL_FALSE;

	if (sigismember(&eloop->sig_set, signo) != 1)
		return BOOL_FALSE; // Doesn't exist

	sigdelset(&eloop->sig_set, signo);
	sigaddset(&eloop->sig_mask, signo);

	if (eloop->working) { // Del signal on the fly
#ifdef HAVE_SIGNALFD
		// Reattach signalfd handler with updated sig_set
		eloop->signal_fd = signalfd(eloop->signal_fd, &eloop->sig_set,
			SIGNALFD_FLAGS);

#else // Standard signals
		faux_eloop_signal_t *sig = faux_list_kfind(eloop->signals, &signo);
		sigaction(signo, &sig->oldact, NULL);
#endif
	}

	faux_list_kdel(eloop->signals, &signo);

	return BOOL_TRUE;
}


/** @brief Unregisters all signals to wait for.
 *
 * @param [in] eloop Allocated and initialized event loop object.
 * @return BOOL_TRUE - success, BOOL_FALSE - error.
 */
bool_t faux_eloop_del_signal_all(faux_eloop_t *eloop)
{
	faux_list_node_t *iter = NULL;

	if (!eloop)
		return BOOL_FALSE;

	// "Del all" function is so complex because signals can be set now
	// and deletion is not only removing from list.
	// So del all signals one by one.
	while ((iter = faux_list_tail(eloop->signals))) {
		faux_eloop_signal_t *entry = NULL;
		entry = (faux_eloop_signal_t *)faux_list_data(iter);
		faux_eloop_del_signal(eloop, entry->signo);
	}

	return BOOL_TRUE;
}


/** @brief Service function to create new context for event.
 *
 * @param [in] event_cb Callback for event.
 * @param [in] data User data for event.
 * @return Allocated context structure or NULL on error.
 */
static faux_eloop_context_t *faux_eloop_new_context(
	faux_eloop_cb_fn event_cb, void *data)
{
	faux_eloop_context_t *context = NULL;

	context = faux_zmalloc(sizeof(*context));
	assert(context);
	if (!context)
		return NULL;

	context->event_cb = event_cb;
	context->user_data = data;

	return context;
}


/** @brief Registers scheduled time event. See faux_sched_once().
 *
 * @param [in] eloop Allocated and initialized event loop object.
 * @param [in] time See faux_sched_once().
 * @param [in] ev_id See faux_sched_once().
 * @param [in] event_cb See faux_sched_once().
 * @param [in] data See faux_sched_once().
 * @return Pointer to created faux_ev_t object or NULL on error.
 */
faux_ev_t *faux_eloop_add_sched_once(faux_eloop_t *eloop, const struct timespec *time,
	int ev_id, faux_eloop_cb_fn event_cb, void *data)
{
	faux_eloop_context_t *context = NULL;
	faux_ev_t *ev = NULL;

	assert(eloop);
	if (!eloop)
		return NULL;

	context = faux_eloop_new_context(event_cb, data);
	assert(context);
	if (!context)
		return NULL;

	if (!(ev = faux_sched_once(eloop->sched, time, ev_id, context))) {
		faux_free(context);
		return NULL;
	}
	faux_ev_set_free_data_cb(ev, faux_free);

	return ev;
}


/** @brief Registers scheduled time event. See faux_sched_once_delayed().
 *
 * @param [in] eloop Allocated and initialized event loop object.
 * @param [in] interval See faux_sched_once_delayed().
 * @param [in] ev_id See faux_sched_once_delayed().
 * @param [in] event_cb See faux_sched_once_delayed().
 * @param [in] data See faux_sched_once_delayed().
 * @return Pointer to created faux_ev_t object or NULL on error.
 */
faux_ev_t *faux_eloop_add_sched_once_delayed(faux_eloop_t *eloop, const struct timespec *interval,
	int ev_id, faux_eloop_cb_fn event_cb, void *data)
{
	faux_eloop_context_t *context = NULL;
	faux_ev_t *ev = NULL;

	assert(eloop);
	if (!eloop)
		return NULL;

	context = faux_eloop_new_context(event_cb, data);
	assert(context);
	if (!context)
		return NULL;

	if (!(ev = faux_sched_once_delayed(eloop->sched, interval, ev_id, context))) {
		faux_free(context);
		return NULL;
	}
	faux_ev_set_free_data_cb(ev, faux_free);

	return ev;
}


/** @brief Registers scheduled time event. See faux_sched_periodic().
 *
 * @param [in] eloop Allocated and initialized event loop object.
 * @param [in] time See faux_sched_periodic().
 * @param [in] ev_id See faux_sched_periodic().
 * @param [in] event_cb See faux_sched_periodic().
 * @param [in] data See faux_sched_periodic().
 * @param [in] period See faux_sched_periodic().
 * @param [in] cycle_num See faux_sched_periodic().
 * @return Pointer to created faux_ev_t object or NULL on error.
 */
faux_ev_t *faux_eloop_add_sched_periodic(faux_eloop_t *eloop, const struct timespec *time,
	int ev_id, faux_eloop_cb_fn event_cb, void *data,
	const struct timespec *period, unsigned int cycle_num)
{
	faux_eloop_context_t *context = NULL;
	faux_ev_t *ev = NULL;

	assert(eloop);
	if (!eloop)
		return NULL;

	context = faux_eloop_new_context(event_cb, data);
	assert(context);
	if (!context)
		return NULL;

	if (!(ev = faux_sched_periodic(eloop->sched, time, ev_id, context,
		period, cycle_num))) {
		faux_free(context);
		return NULL;
	}
	faux_ev_set_free_data_cb(ev, faux_free);

	return ev;
}


/** @brief Registers scheduled time event. See faux_sched_periodic_delayed().
 *
 * @param [in] eloop Allocated and initialized event loop object.
 * @param [in] ev_id See faux_sched_periodic_delayed().
 * @param [in] event_cb See faux_sched_periodic_delayed().
 * @param [in] data See faux_sched_periodic_delayed().
 * @param [in] period See faux_sched_periodic_delayed().
 * @param [in] cycle_num See faux_sched_periodic_delayed().
 * @return Pointer to created faux_ev_t object or NULL on error.
 */
faux_ev_t *faux_eloop_add_sched_periodic_delayed(faux_eloop_t *eloop,
	int ev_id, faux_eloop_cb_fn event_cb, void *data,
	const struct timespec *period, unsigned int cycle_num)
{
	faux_eloop_context_t *context = NULL;
	faux_ev_t *ev = NULL;

	assert(eloop);
	if (!eloop)
		return NULL;

	context = faux_eloop_new_context(event_cb, data);
	assert(context);
	if (!context)
		return NULL;

	if (!(ev = faux_sched_periodic_delayed(eloop->sched, ev_id, context,
		period, cycle_num))) {
		faux_free(context);
		return NULL;
	}
	faux_ev_set_free_data_cb(ev, faux_free);

	return ev;
}


/** @brief Unregisters scheduled time event.
 *
 * @param [in] eloop Allocated and initialized event loop object.
 * @param [in] ev Event object to unregister.
 * @return Number of unregistered entries or < 0 on error.
 */
ssize_t faux_eloop_del_sched(faux_eloop_t *eloop, faux_ev_t *ev)
{
	assert(eloop);
	if (!eloop)
		return -1;

	return faux_sched_del(eloop->sched, ev);
}


/** @brief Unregisters all scheduled time events.
 *
 * @param [in] eloop Allocated and initialized event loop object.
 * @return BOOL_TRUE - success, BOOL_FALSE - error.
 */
bool_t faux_eloop_del_sched_all(faux_eloop_t *eloop)
{
	assert(eloop);
	if (!eloop)
		return BOOL_FALSE;

	faux_sched_del_all(eloop->sched);

	return BOOL_TRUE;
}


/** @brief Unregisters scheduled time event by event ID.
 *
 * @param [in] eloop Allocated and initialized event loop object.
 * @param [in] ev_id Event ID to unregister.
 * @return Number of unregistered entries or < 0 on error.
 */
ssize_t faux_eloop_del_sched_by_id(faux_eloop_t *eloop, int ev_id)
{
	assert(eloop);
	if (!eloop)
		return -1;

	return faux_sched_del_by_id(eloop->sched, ev_id);
}