X-Git-Url: https://sigrok.org/gitweb/?p=libsigrok.git;a=blobdiff_plain;f=session.c;h=d8a3b00b5efabe157ab546498bee39139b249853;hp=13e606194a126d60f086e3ac5e0c320501668596;hb=43cd4637285833706f8a404ca027bcf0ee75b9ae;hpb=e7eb703fff0167897f7e094e2edbf7d5798857ea diff --git a/session.c b/session.c index 13e60619..d8a3b00b 100644 --- a/session.c +++ b/session.c @@ -1,5 +1,5 @@ /* - * This file is part of the sigrok project. + * This file is part of the libsigrok project. * * Copyright (C) 2010-2012 Bert Vermeulen * @@ -22,86 +22,118 @@ #include #include #include -#include "sigrok.h" -#include "sigrok-internal.h" +#include "libsigrok.h" +#include "libsigrok-internal.h" -/* demo.c. TODO: Should not be global! */ -extern SR_PRIV GIOChannel channels[2]; +/** @cond PRIVATE */ +#define LOG_PREFIX "session" +/** @endcond */ + +/** + * @file + * + * Creating, using, or destroying libsigrok sessions. + */ + +/** + * @defgroup grp_session Session handling + * + * Creating, using, or destroying libsigrok sessions. + * + * @{ + */ struct source { - int fd; - int events; int timeout; sr_receive_data_callback cb; - void *user_data; -}; + void *cb_data; -/* There can only be one session at a time. */ -/* 'session' is not static, it's used elsewhere (via 'extern'). */ -struct sr_session *session; -static int num_sources = 0; + /* This is used to keep track of the object (fd, pollfd or channel) which is + * being polled and will be used to match the source when removing it again. + */ + gintptr poll_object; +}; -static struct source *sources = NULL; -static int source_timeout = -1; +struct datafeed_callback { + sr_datafeed_callback cb; + void *cb_data; +}; /** * Create a new session. + * Currently, there can be only one session at a time within the same process. * - * TODO: Should it use the file-global "session" variable or take an argument? - * The same question applies to all the other session functions. + * @retval SR_OK Success. + * @retval SR_ERR_BUG A session exists already. * - * @return A pointer to the newly allocated session, or NULL upon errors. + * @since 0.4.0 */ -SR_API struct sr_session *sr_session_new(void) +SR_API int sr_session_new(struct sr_session **new_session) { - if (!(session = g_try_malloc0(sizeof(struct sr_session)))) { - sr_err("session: %s: session malloc failed", __func__); - return NULL; /* TODO: SR_ERR_MALLOC? */ - } + struct sr_session *session; - return session; + session = g_malloc0(sizeof(struct sr_session)); + + session->source_timeout = -1; + session->running = FALSE; + session->abort_session = FALSE; + g_mutex_init(&session->stop_mutex); + + *new_session = session; + + return SR_OK; } /** - * Destroy the current session. - * + * Destroy a session. * This frees up all memory used by the session. * - * @return SR_OK upon success, SR_ERR_BUG if no session exists. + * @retval SR_OK Success. + * @retval SR_ERR_ARG Invalid session passed. + * + * @since 0.4.0 */ -SR_API int sr_session_destroy(void) +SR_API int sr_session_destroy(struct sr_session *session) { if (!session) { - sr_err("session: %s: session was NULL", __func__); - return SR_ERR_BUG; + sr_err("%s: session was NULL", __func__); + return SR_ERR_ARG; } - g_slist_free(session->devs); - session->devs = NULL; - - /* TODO: Error checks needed? */ - - /* TODO: Loop over protocol decoders and free them. */ + sr_session_dev_remove_all(session); + g_mutex_clear(&session->stop_mutex); + if (session->trigger) + sr_trigger_free(session->trigger); g_free(session); - session = NULL; return SR_OK; } /** - * Remove all the devices from the current session. TODO? + * Remove all the devices from a session. * * The session itself (i.e., the struct sr_session) is not free'd and still * exists after this function returns. * - * @return SR_OK upon success, SR_ERR_BUG if no session exists. + * @retval SR_OK Success. + * @retval SR_ERR_BUG Invalid session passed. + * + * @since 0.4.0 */ -SR_API int sr_session_dev_clear(void) +SR_API int sr_session_dev_remove_all(struct sr_session *session) { + struct sr_dev_inst *sdi; + GSList *l; + if (!session) { - sr_err("session: %s: session was NULL", __func__); - return SR_ERR_BUG; + sr_err("%s: session was NULL", __func__); + return SR_ERR_ARG; + } + + for (l = session->devs; l; l = l->next) { + sdi = (struct sr_dev_inst *) l->data; + sdi->session = NULL; } g_slist_free(session->devs); @@ -111,175 +143,311 @@ SR_API int sr_session_dev_clear(void) } /** - * Add a device to the current session. + * Add a device instance to a session. * - * @param dev The device to add to the current session. Must not be NULL. - * Also, dev->plugin and dev->plugin->dev_open must not be NULL. + * @param sdi The device instance to add to a session. Must not + * be NULL. Also, sdi->driver and sdi->driver->dev_open must + * not be NULL. * - * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments. + * @retval SR_OK Success. + * @retval SR_ERR_ARG Invalid argument. + * + * @since 0.4.0 */ -SR_API int sr_session_dev_add(struct sr_dev *dev) +SR_API int sr_session_dev_add(struct sr_session *session, + struct sr_dev_inst *sdi) { int ret; - if (!dev) { - sr_err("session: %s: dev was NULL", __func__); + if (!sdi) { + sr_err("%s: sdi was NULL", __func__); return SR_ERR_ARG; } - if (!dev->plugin) { - sr_err("session: %s: dev->plugin was NULL", __func__); + if (!session) { + sr_err("%s: session was NULL", __func__); return SR_ERR_ARG; } - if (!dev->plugin->dev_open) { - sr_err("session: %s: dev->plugin->dev_open was NULL", - __func__); + /* If sdi->session is not NULL, the device is already in this or + * another session. */ + if (sdi->session) { + sr_err("%s: already assigned to session", __func__); return SR_ERR_ARG; } - if (!session) { - sr_err("session: %s: session was NULL", __func__); - return SR_ERR; /* TODO: SR_ERR_BUG? */ + /* If sdi->driver is NULL, this is a virtual device. */ + if (!sdi->driver) { + sr_dbg("%s: sdi->driver was NULL, this seems to be " + "a virtual device; continuing", __func__); + /* Just add the device, don't run dev_open(). */ + session->devs = g_slist_append(session->devs, (gpointer)sdi); + sdi->session = session; + return SR_OK; } - if ((ret = dev->plugin->dev_open(dev->plugin_index)) != SR_OK) { - sr_err("session: %s: dev_open failed (%d)", __func__, ret); - return ret; + /* sdi->driver is non-NULL (i.e. we have a real device). */ + if (!sdi->driver->dev_open) { + sr_err("%s: sdi->driver->dev_open was NULL", __func__); + return SR_ERR_BUG; } - session->devs = g_slist_append(session->devs, dev); + session->devs = g_slist_append(session->devs, (gpointer)sdi); + sdi->session = session; + + if (session->running) { + /* Adding a device to a running session. Commit settings + * and start acquisition on that device now. */ + if ((ret = sr_config_commit(sdi)) != SR_OK) { + sr_err("Failed to commit device settings before " + "starting acquisition in running session (%s)", + sr_strerror(ret)); + return ret; + } + if ((ret = sdi->driver->dev_acquisition_start(sdi, + (void *)sdi)) != SR_OK) { + sr_err("Failed to start acquisition of device in " + "running session (%s)", sr_strerror(ret)); + return ret; + } + } return SR_OK; } /** - * Clear all datafeed callbacks in the current session. + * List all device instances attached to a session. + * + * @param devlist A pointer where the device instance list will be + * stored on return. If no devices are in the session, + * this will be NULL. Each element in the list points + * to a struct sr_dev_inst *. + * The list must be freed by the caller, but not the + * elements pointed to. * - * @return SR_OK upon success, SR_ERR_BUG if no session exists. + * @retval SR_OK Success. + * @retval SR_ERR_ARG Invalid argument. + * + * @since 0.4.0 */ -SR_API int sr_session_datafeed_callback_clear(void) +SR_API int sr_session_dev_list(struct sr_session *session, GSList **devlist) +{ + if (!session) + return SR_ERR_ARG; + + if (!devlist) + return SR_ERR_ARG; + + *devlist = g_slist_copy(session->devs); + + return SR_OK; +} + +/** + * Remove all datafeed callbacks in a session. + * + * @retval SR_OK Success. + * @retval SR_ERR_ARG Invalid session passed. + * + * @since 0.4.0 + */ +SR_API int sr_session_datafeed_callback_remove_all(struct sr_session *session) { if (!session) { - sr_err("session: %s: session was NULL", __func__); - return SR_ERR_BUG; + sr_err("%s: session was NULL", __func__); + return SR_ERR_ARG; } - g_slist_free(session->datafeed_callbacks); + g_slist_free_full(session->datafeed_callbacks, g_free); session->datafeed_callbacks = NULL; return SR_OK; } /** - * Add a datafeed callback to the current session. + * Add a datafeed callback to a session. * - * @param callback Function to call when a chunk of data is received. + * @param cb Function to call when a chunk of data is received. + * Must not be NULL. + * @param cb_data Opaque pointer passed in by the caller. * - * @return SR_OK upon success, SR_ERR_BUG if no session exists. + * @retval SR_OK Success. + * @retval SR_ERR_BUG No session exists. + * + * @since 0.3.0 */ -SR_API int sr_session_datafeed_callback_add(sr_datafeed_callback callback) +SR_API int sr_session_datafeed_callback_add(struct sr_session *session, + sr_datafeed_callback cb, void *cb_data) { + struct datafeed_callback *cb_struct; + if (!session) { - sr_err("session: %s: session was NULL", __func__); + sr_err("%s: session was NULL", __func__); return SR_ERR_BUG; } - /* TODO: Is 'callback' allowed to be NULL? */ + if (!cb) { + sr_err("%s: cb was NULL", __func__); + return SR_ERR_ARG; + } + + if (!(cb_struct = g_try_malloc0(sizeof(struct datafeed_callback)))) + return SR_ERR_MALLOC; + + cb_struct->cb = cb; + cb_struct->cb_data = cb_data; session->datafeed_callbacks = - g_slist_append(session->datafeed_callbacks, callback); + g_slist_append(session->datafeed_callbacks, cb_struct); + + return SR_OK; +} + +SR_API struct sr_trigger *sr_session_trigger_get(struct sr_session *session) +{ + return session->trigger; +} + +SR_API int sr_session_trigger_set(struct sr_session *session, struct sr_trigger *trig) +{ + session->trigger = trig; return SR_OK; } /** - * TODO. + * Call every device in the current session's callback. + * + * For sessions not driven by select loops such as sr_session_run(), + * but driven by another scheduler, this can be used to poll the devices + * from within that scheduler. + * + * @param block If TRUE, this call will wait for any of the session's + * sources to fire an event on the file descriptors, or + * any of their timeouts to activate. In other words, this + * can be used as a select loop. + * If FALSE, all sources have their callback run, regardless + * of file descriptor or timeout status. + * + * @retval SR_OK Success. + * @retval SR_ERR Error occured. */ -static int sr_session_run_poll(void) +static int sr_session_iteration(struct sr_session *session, gboolean block) { - GPollFD *fds, my_gpollfd; - int ret, i; - - fds = NULL; - while (session->running) { - /* TODO: Add comment. */ - g_free(fds); - - /* Construct g_poll()'s array. */ - if (!(fds = g_try_malloc(sizeof(GPollFD) * num_sources))) { - sr_err("session: %s: fds malloc failed", __func__); - return SR_ERR_MALLOC; + unsigned int i; + int ret; + + ret = g_poll(session->pollfds, session->num_sources, + block ? session->source_timeout : 0); + for (i = 0; i < session->num_sources; i++) { + if (session->pollfds[i].revents > 0 || (ret == 0 + && session->source_timeout == session->sources[i].timeout)) { + /* + * Invoke the source's callback on an event, + * or if the poll timed out and this source + * asked for that timeout. + */ + if (!session->sources[i].cb(session->pollfds[i].fd, + session->pollfds[i].revents, + session->sources[i].cb_data)) + sr_session_source_remove(session, + session->sources[i].poll_object); } - for (i = 0; i < num_sources; i++) { -#ifdef _WIN32 - g_io_channel_win32_make_pollfd(&channels[0], - sources[i].events, &my_gpollfd); -#else - my_gpollfd.fd = sources[i].fd; - my_gpollfd.events = sources[i].events; - fds[i] = my_gpollfd; -#endif + /* + * We want to take as little time as possible to stop + * the session if we have been told to do so. Therefore, + * we check the flag after processing every source, not + * just once per main event loop. + */ + g_mutex_lock(&session->stop_mutex); + if (session->abort_session) { + sr_session_stop_sync(session); + /* But once is enough. */ + session->abort_session = FALSE; } + g_mutex_unlock(&session->stop_mutex); + } - ret = g_poll(fds, num_sources, source_timeout); - - for (i = 0; i < num_sources; i++) { - if (fds[i].revents > 0 || (ret == 0 - && source_timeout == sources[i].timeout)) { - /* - * Invoke the source's callback on an event, - * or if the poll timeout out and this source - * asked for that timeout. - */ - if (!sources[i].cb(fds[i].fd, fds[i].revents, - sources[i].user_data)) - sr_session_source_remove(sources[i].fd); + return SR_OK; +} + + +static int verify_trigger(struct sr_trigger *trigger) +{ + struct sr_trigger_stage *stage; + struct sr_trigger_match *match; + GSList *l, *m; + + if (!trigger->stages) { + sr_err("No trigger stages defined."); + return SR_ERR; + } + + sr_spew("Checking trigger:"); + for (l = trigger->stages; l; l = l->next) { + stage = l->data; + if (!stage->matches) { + sr_err("Stage %d has no matches defined.", stage->stage); + return SR_ERR; + } + for (m = stage->matches; m; m = m->next) { + match = m->data; + if (!match->channel) { + sr_err("Stage %d match has no channel.", stage->stage); + return SR_ERR; } + if (!match->match) { + sr_err("Stage %d match is not defined.", stage->stage); + return SR_ERR; + } + sr_spew("Stage %d match on channel %s, match %d", stage->stage, + match->channel->name, match->match); } } - g_free(fds); return SR_OK; } - /** * Start a session. * - * There can only be one session at a time. + * @retval SR_OK Success. + * @retval SR_ERR_ARG Invalid session passed. * - * @return SR_OK upon success, SR_ERR upon errors. + * @since 0.4.0 */ -SR_API int sr_session_start(void) +SR_API int sr_session_start(struct sr_session *session) { - struct sr_dev *dev; + struct sr_dev_inst *sdi; GSList *l; int ret; if (!session) { - sr_err("session: %s: session was NULL; a session must be " - "created first, before starting it.", __func__); - return SR_ERR; /* TODO: SR_ERR_BUG? */ + sr_err("%s: session was NULL", __func__); + return SR_ERR_ARG; } if (!session->devs) { - /* TODO: Actually the case? */ - sr_err("session: %s: session->devs was NULL; a session " + sr_err("%s: session->devs was NULL; a session " "cannot be started without devices.", __func__); - return SR_ERR; /* TODO: SR_ERR_BUG? */ + return SR_ERR_ARG; } - /* TODO: Check plugin_index validity? */ + if (session->trigger && verify_trigger(session->trigger) != SR_OK) + return SR_ERR; - sr_info("session: starting"); + sr_info("Starting."); + ret = SR_OK; for (l = session->devs; l; l = l->next) { - dev = l->data; - /* TODO: Check for dev != NULL. */ - if ((ret = dev->plugin->acquisition_start( - dev->plugin_index, dev)) != SR_OK) { - sr_err("session: %s: could not start an acquisition " - "(%d)", __func__, ret); + sdi = l->data; + if ((ret = sr_config_commit(sdi)) != SR_OK) { + sr_err("Failed to commit device settings before " + "starting acquisition (%s)", sr_strerror(ret)); + break; + } + if ((ret = sdi->driver->dev_acquisition_start(sdi, sdi)) != SR_OK) { + sr_err("%s: could not start an acquisition " + "(%s)", __func__, sr_strerror(ret)); break; } } @@ -290,95 +458,108 @@ SR_API int sr_session_start(void) } /** - * Run the session. + * Run a session. * - * TODO: Various error checks etc. + * @retval SR_OK Success. + * @retval SR_ERR_ARG Invalid session passed. * - * @return SR_OK upon success, SR_ERR_BUG upon errors. + * @since 0.4.0 */ -SR_API int sr_session_run(void) +SR_API int sr_session_run(struct sr_session *session) { if (!session) { - sr_err("session: %s: session was NULL; a session must be " - "created first, before running it.", __func__); - return SR_ERR_BUG; + sr_err("%s: session was NULL", __func__); + return SR_ERR_ARG; } if (!session->devs) { /* TODO: Actually the case? */ - sr_err("session: %s: session->devs was NULL; a session " + sr_err("%s: session->devs was NULL; a session " "cannot be run without devices.", __func__); - return SR_ERR_BUG; + return SR_ERR_ARG; } - - sr_info("session: running"); session->running = TRUE; + sr_info("Running."); + /* Do we have real sources? */ - if (num_sources == 1 && sources[0].fd == -1) { + if (session->num_sources == 1 && session->pollfds[0].fd == -1) { /* Dummy source, freewheel over it. */ - while (session->running) - sources[0].cb(-1, 0, sources[0].user_data); + while (session->num_sources) + session->sources[0].cb(-1, 0, session->sources[0].cb_data); } else { /* Real sources, use g_poll() main loop. */ - sr_session_run_poll(); + while (session->num_sources) + sr_session_iteration(session, TRUE); } return SR_OK; } /** - * Halt the current session. + * Stop a session. + * + * The session is stopped immediately, with all acquisition sessions stopped + * and hardware drivers cleaned up. + * + * This must be called from within the session thread, to prevent freeing + * resources that the session thread will try to use. * - * This requests the current session be stopped as soon as possible, for - * example on receiving an SR_DF_END packet. + * @retval SR_OK Success. + * @retval SR_ERR_ARG Invalid session passed. * - * @return SR_OK upon success, SR_ERR_BUG if no session exists. + * @private */ -SR_API int sr_session_halt(void) +SR_PRIV int sr_session_stop_sync(struct sr_session *session) { + struct sr_dev_inst *sdi; + GSList *l; + if (!session) { - sr_err("session: %s: session was NULL", __func__); - return SR_ERR_BUG; + sr_err("%s: session was NULL", __func__); + return SR_ERR_ARG; } - sr_info("session: halting"); + sr_info("Stopping."); + + for (l = session->devs; l; l = l->next) { + sdi = l->data; + if (sdi->driver) { + if (sdi->driver->dev_acquisition_stop) + sdi->driver->dev_acquisition_stop(sdi, sdi); + } + } session->running = FALSE; return SR_OK; } /** - * Stop the current session. + * Stop a session. + * + * The session is stopped immediately, with all acquisition sessions being + * stopped and hardware drivers cleaned up. + * + * If the session is run in a separate thread, this function will not block + * until the session is finished executing. It is the caller's responsibility + * to wait for the session thread to return before assuming that the session is + * completely decommissioned. * - * The current session is stopped immediately, with all acquisition sessions - * being stopped and hardware plugins cleaned up. + * @retval SR_OK Success. + * @retval SR_ERR_ARG Invalid session passed. * - * @return SR_OK upon success, SR_ERR_BUG if no session exists. + * @since 0.4.0 */ -SR_API int sr_session_stop(void) +SR_API int sr_session_stop(struct sr_session *session) { - struct sr_dev *dev; - GSList *l; - if (!session) { - sr_err("session: %s: session was NULL", __func__); + sr_err("%s: session was NULL", __func__); return SR_ERR_BUG; } - sr_info("session: stopping"); - session->running = FALSE; - - for (l = session->devs; l; l = l->next) { - dev = l->data; - /* Check for dev != NULL. */ - if (dev->plugin) { - if (dev->plugin->acquisition_stop) - dev->plugin->acquisition_stop(dev->plugin_index, dev); - if (dev->plugin->cleanup) - dev->plugin->cleanup(); - } - } + g_mutex_lock(&session->stop_mutex); + session->abort_session = TRUE; + g_mutex_unlock(&session->stop_mutex); return SR_OK; } @@ -388,27 +569,42 @@ SR_API int sr_session_stop(void) * * @param packet The packet to show debugging information for. */ -static void datafeed_dump(struct sr_datafeed_packet *packet) +static void datafeed_dump(const struct sr_datafeed_packet *packet) { - struct sr_datafeed_logic *logic; + const struct sr_datafeed_logic *logic; + const struct sr_datafeed_analog *analog; switch (packet->type) { case SR_DF_HEADER: - sr_dbg("bus: received SR_DF_HEADER"); + sr_dbg("bus: Received SR_DF_HEADER packet."); break; case SR_DF_TRIGGER: - sr_dbg("bus: received SR_DF_TRIGGER"); + sr_dbg("bus: Received SR_DF_TRIGGER packet."); + break; + case SR_DF_META: + sr_dbg("bus: Received SR_DF_META packet."); break; case SR_DF_LOGIC: logic = packet->payload; - /* TODO: Check for logic != NULL. */ - sr_dbg("bus: received SR_DF_LOGIC %" PRIu64 " bytes", logic->length); + sr_dbg("bus: Received SR_DF_LOGIC packet (%" PRIu64 " bytes, " + "unitsize = %d).", logic->length, logic->unitsize); + break; + case SR_DF_ANALOG: + analog = packet->payload; + sr_dbg("bus: Received SR_DF_ANALOG packet (%d samples).", + analog->num_samples); break; case SR_DF_END: - sr_dbg("bus: received SR_DF_END"); + sr_dbg("bus: Received SR_DF_END packet."); + break; + case SR_DF_FRAME_BEGIN: + sr_dbg("bus: Received SR_DF_FRAME_BEGIN packet."); + break; + case SR_DF_FRAME_END: + sr_dbg("bus: Received SR_DF_FRAME_END packet."); break; default: - sr_dbg("bus: received unknown packet type %d", packet->type); + sr_dbg("bus: Received unknown packet type: %d.", packet->type); break; } } @@ -418,139 +614,297 @@ static void datafeed_dump(struct sr_datafeed_packet *packet) * * Hardware drivers use this to send a data packet to the frontend. * - * @param dev TODO. - * @param packet TODO. + * @param sdi TODO. + * @param packet The datafeed packet to send to the session bus. * - * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments. + * @retval SR_OK Success. + * @retval SR_ERR_ARG Invalid argument. + * + * @private */ -SR_PRIV int sr_session_bus(struct sr_dev *dev, - struct sr_datafeed_packet *packet) +SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi, + const struct sr_datafeed_packet *packet) { GSList *l; - sr_datafeed_callback cb; - - if (!dev) { - sr_err("session: %s: dev was NULL", __func__); - return SR_ERR_ARG; - } + struct datafeed_callback *cb_struct; - if (!dev->plugin) { - sr_err("session: %s: dev->plugin was NULL", __func__); + if (!sdi) { + sr_err("%s: sdi was NULL", __func__); return SR_ERR_ARG; } if (!packet) { - sr_err("session: %s: packet was NULL", __func__); + sr_err("%s: packet was NULL", __func__); return SR_ERR_ARG; } - for (l = session->datafeed_callbacks; l; l = l->next) { + for (l = sdi->session->datafeed_callbacks; l; l = l->next) { if (sr_log_loglevel_get() >= SR_LOG_DBG) datafeed_dump(packet); - cb = l->data; - /* TODO: Check for cb != NULL. */ - cb(dev, packet); + cb_struct = l->data; + cb_struct->cb(sdi, packet, cb_struct->cb_data); } return SR_OK; } /** - * TODO. - * - * TODO: More error checks etc. - * - * @param fd TODO. - * @param events TODO. - * @param timeout TODO. - * @param callback TODO. - * @param user_data TODO. - * - * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or - * SR_ERR_MALLOC upon memory allocation errors. + * Add an event source for a file descriptor. + * + * @param pollfd The GPollFD. + * @param[in] timeout Max time to wait before the callback is called, + * ignored if 0. + * @param cb Callback function to add. Must not be NULL. + * @param cb_data Data for the callback function. Can be NULL. + * @param poll_object TODO. + * + * @retval SR_OK Success. + * @retval SR_ERR_ARG Invalid argument. + * @retval SR_ERR_MALLOC Memory allocation error. */ -SR_API int sr_session_source_add(int fd, int events, int timeout, - sr_receive_data_callback callback, void *user_data) +static int _sr_session_source_add(struct sr_session *session, GPollFD *pollfd, + int timeout, sr_receive_data_callback cb, void *cb_data, gintptr poll_object) { struct source *new_sources, *s; + GPollFD *new_pollfds; - if (!callback) { - sr_err("session: %s: callback was NULL", __func__); + if (!cb) { + sr_err("%s: cb was NULL", __func__); return SR_ERR_ARG; } - /* Note: user_data can be NULL, that's not a bug. */ + /* Note: cb_data can be NULL, that's not a bug. */ - new_sources = g_try_malloc0(sizeof(struct source) * (num_sources + 1)); - if (!new_sources) { - sr_err("session: %s: new_sources malloc failed", __func__); + new_pollfds = g_try_realloc(session->pollfds, + sizeof(GPollFD) * (session->num_sources + 1)); + if (!new_pollfds) { + sr_err("%s: new_pollfds malloc failed", __func__); return SR_ERR_MALLOC; } - if (sources) { - memcpy(new_sources, sources, - sizeof(struct source) * num_sources); - g_free(sources); + new_sources = g_try_realloc(session->sources, sizeof(struct source) * + (session->num_sources + 1)); + if (!new_sources) { + sr_err("%s: new_sources malloc failed", __func__); + return SR_ERR_MALLOC; } - s = &new_sources[num_sources++]; - s->fd = fd; - s->events = events; + new_pollfds[session->num_sources] = *pollfd; + s = &new_sources[session->num_sources++]; s->timeout = timeout; - s->cb = callback; - s->user_data = user_data; - sources = new_sources; + s->cb = cb; + s->cb_data = cb_data; + s->poll_object = poll_object; + session->pollfds = new_pollfds; + session->sources = new_sources; - if (timeout != source_timeout && timeout > 0 - && (source_timeout == -1 || timeout < source_timeout)) - source_timeout = timeout; + if (timeout != session->source_timeout && timeout > 0 + && (session->source_timeout == -1 || timeout < session->source_timeout)) + session->source_timeout = timeout; return SR_OK; } /** - * Remove the source belonging to the specified file descriptor. + * Add an event source for a file descriptor. * - * TODO: More error checks. + * @param fd The file descriptor. + * @param events Events to check for. + * @param timeout Max time to wait before the callback is called, ignored if 0. + * @param cb Callback function to add. Must not be NULL. + * @param cb_data Data for the callback function. Can be NULL. * - * @param fd TODO. + * @retval SR_OK Success. + * @retval SR_ERR_ARG Invalid argument. + * @retval SR_ERR_MALLOC Memory allocation error. * - * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or - * SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon - * internal errors. + * @since 0.3.0 + */ +SR_API int sr_session_source_add(struct sr_session *session, int fd, + int events, int timeout, sr_receive_data_callback cb, void *cb_data) +{ + GPollFD p; + + (void) session; + + p.fd = fd; + p.events = events; + + return _sr_session_source_add(session, &p, timeout, cb, cb_data, (gintptr)fd); +} + +/** + * Add an event source for a GPollFD. + * + * @param pollfd The GPollFD. + * @param timeout Max time to wait before the callback is called, ignored if 0. + * @param cb Callback function to add. Must not be NULL. + * @param cb_data Data for the callback function. Can be NULL. + * + * @retval SR_OK Success. + * @retval SR_ERR_ARG Invalid argument. + * @retval SR_ERR_MALLOC Memory allocation error. + * + * @since 0.3.0 + */ +SR_API int sr_session_source_add_pollfd(struct sr_session *session, + GPollFD *pollfd, int timeout, sr_receive_data_callback cb, + void *cb_data) +{ + (void) session; + + return _sr_session_source_add(session, pollfd, timeout, cb, + cb_data, (gintptr)pollfd); +} + +/** + * Add an event source for a GIOChannel. + * + * @param channel The GIOChannel. + * @param events Events to poll on. + * @param timeout Max time to wait before the callback is called, ignored if 0. + * @param cb Callback function to add. Must not be NULL. + * @param cb_data Data for the callback function. Can be NULL. + * + * @retval SR_OK Success. + * @retval SR_ERR_ARG Invalid argument. + * @retval SR_ERR_MALLOC Memory allocation error. + * + * @since 0.3.0 */ -SR_API int sr_session_source_remove(int fd) +SR_API int sr_session_source_add_channel(struct sr_session *session, + GIOChannel *channel, int events, int timeout, + sr_receive_data_callback cb, void *cb_data) +{ + GPollFD p; + + (void) session; + +#ifdef _WIN32 + g_io_channel_win32_make_pollfd(channel, events, &p); +#else + p.fd = g_io_channel_unix_get_fd(channel); + p.events = events; +#endif + + return _sr_session_source_add(session, &p, timeout, cb, cb_data, (gintptr)channel); +} + +/** + * Remove the source belonging to the specified channel. + * + * @todo Add more error checks and logging. + * + * @param poll_object The channel for which the source should be removed. + * + * @retval SR_OK Success + * @retval SR_ERR_ARG Invalid arguments + * @retval SR_ERR_MALLOC Memory allocation error + * @retval SR_ERR_BUG Internal error + */ +static int _sr_session_source_remove(struct sr_session *session, gintptr poll_object) { struct source *new_sources; - int old, new; + GPollFD *new_pollfds; + unsigned int old; + + if (!session->sources || !session->num_sources) { + sr_err("%s: sources was NULL", __func__); + return SR_ERR_BUG; + } - if (!sources) { - sr_err("session: %s: sources was NULL", __func__); - return SR_ERR_BUG; /* TODO: Other? */ + for (old = 0; old < session->num_sources; old++) { + if (session->sources[old].poll_object == poll_object) + break; } - /* TODO: Check if 'fd' valid. */ + /* fd not found, nothing to do */ + if (old == session->num_sources) + return SR_OK; - new_sources = g_try_malloc0(sizeof(struct source) * num_sources); - if (!new_sources) { - sr_err("session: %s: new_sources malloc failed", __func__); - return SR_ERR_MALLOC; + session->num_sources -= 1; + + if (old != session->num_sources) { + memmove(&session->pollfds[old], &session->pollfds[old+1], + (session->num_sources - old) * sizeof(GPollFD)); + memmove(&session->sources[old], &session->sources[old+1], + (session->num_sources - old) * sizeof(struct source)); } - for (old = 0, new = 0; old < num_sources; old++) { - if (sources[old].fd != fd) - memcpy(&new_sources[new++], &sources[old], - sizeof(struct source)); + new_pollfds = g_try_realloc(session->pollfds, sizeof(GPollFD) * session->num_sources); + if (!new_pollfds && session->num_sources > 0) { + sr_err("%s: new_pollfds malloc failed", __func__); + return SR_ERR_MALLOC; } - if (old != new) { - g_free(sources); - sources = new_sources; - num_sources--; - } else { - /* Target fd was not found. */ - g_free(new_sources); + new_sources = g_try_realloc(session->sources, sizeof(struct source) * session->num_sources); + if (!new_sources && session->num_sources > 0) { + sr_err("%s: new_sources malloc failed", __func__); + return SR_ERR_MALLOC; } + session->pollfds = new_pollfds; + session->sources = new_sources; + return SR_OK; } + +/** + * Remove the source belonging to the specified file descriptor. + * + * @param fd The file descriptor for which the source should be removed. + * + * @retval SR_OK Success + * @retval SR_ERR_ARG Invalid argument + * @retval SR_ERR_MALLOC Memory allocation error. + * @retval SR_ERR_BUG Internal error. + * + * @since 0.3.0 + */ +SR_API int sr_session_source_remove(struct sr_session *session, int fd) +{ + (void) session; + + return _sr_session_source_remove(session, (gintptr)fd); +} + +/** + * Remove the source belonging to the specified poll descriptor. + * + * @param pollfd The poll descriptor for which the source should be removed. + * + * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or + * SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon + * internal errors. + * + * @since 0.2.0 + */ +SR_API int sr_session_source_remove_pollfd(struct sr_session *session, + GPollFD *pollfd) +{ + (void) session; + + return _sr_session_source_remove(session, (gintptr)pollfd); +} + +/** + * Remove the source belonging to the specified channel. + * + * @param channel The channel for which the source should be removed. + * + * @retval SR_OK Success. + * @retval SR_ERR_ARG Invalid argument. + * @retval SR_ERR_MALLOC Memory allocation error. + * @return SR_ERR_BUG Internal error. + * + * @since 0.2.0 + */ +SR_API int sr_session_source_remove_channel(struct sr_session *session, + GIOChannel *channel) +{ + (void) session; + + return _sr_session_source_remove(session, (gintptr)channel); +} + +/** @} */