X-Git-Url: https://sigrok.org/gitweb/?p=libsigrok.git;a=blobdiff_plain;f=session.c;h=d8a3b00b5efabe157ab546498bee39139b249853;hp=23e4e49559739d74740ab2b1aacdd74998f1b6d5;hb=43cd4637285833706f8a404ca027bcf0ee75b9ae;hpb=e8d3d6c84378481b5c0b53236e2fb09288e211b1 diff --git a/session.c b/session.c index 23e4e495..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 * @@ -25,9 +25,27 @@ #include "libsigrok.h" #include "libsigrok-internal.h" +/** @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 timeout; - sr_receive_data_callback_t cb; + sr_receive_data_callback cb; void *cb_data; /* This is used to keep track of the object (fd, pollfd or channel) which is @@ -36,236 +54,400 @@ struct source { gintptr poll_object; }; -/* There can only be one session at a time. */ -/* 'session' is not static, it's used elsewhere (via 'extern'). */ -struct sr_session *session; +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; + + 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 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; } - sr_session_dev_remove_all(); - - /* 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; } -static void sr_dev_close(struct sr_dev_inst *sdi) -{ - if (sdi->driver && sdi->driver->dev_close) - sdi->driver->dev_close(sdi); -} - /** - * 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_remove_all(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_full(session->devs, (GDestroyNotify)sr_dev_close); + g_slist_free(session->devs); session->devs = NULL; return SR_OK; } /** - * Add a device to the current session. + * Add a device instance to a session. * - * @param dev The device instance to add to the current session. Must not + * @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(const struct sr_dev_inst *sdi) +SR_API int sr_session_dev_add(struct sr_session *session, + struct sr_dev_inst *sdi) { int ret; if (!sdi) { - sr_err("session: %s: sdi was NULL", __func__); + sr_err("%s: sdi was NULL", __func__); return SR_ERR_ARG; } 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; + } + + /* 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 sdi->driver is NULL, this is a virtual device. */ if (!sdi->driver) { - sr_dbg("session: %s: sdi->driver was NULL, this seems to be " + 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; } /* sdi->driver is non-NULL (i.e. we have a real device). */ if (!sdi->driver->dev_open) { - sr_err("session: %s: sdi->driver->dev_open was NULL", __func__); + sr_err("%s: sdi->driver->dev_open was NULL", __func__); return SR_ERR_BUG; } - if ((ret = sdi->driver->dev_open((struct sr_dev_inst *)sdi)) != SR_OK) { - sr_err("session: %s: dev_open failed (%d)", __func__, ret); - return ret; + 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; + } } - session->devs = g_slist_append(session->devs, (gpointer)sdi); + return SR_OK; +} + +/** + * 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. + * + * @retval SR_OK Success. + * @retval SR_ERR_ARG Invalid argument. + * + * @since 0.4.0 + */ +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 the current session. + * Remove all datafeed callbacks in a 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_datafeed_callback_remove_all(void) +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 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_t cb) +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; } if (!cb) { - sr_err("session: %s: cb was NULL", __func__); + 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, cb); + 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) { unsigned int i; int ret; - while (session->running) { - ret = g_poll(session->pollfds, session->num_sources, session->source_timeout); - - 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 timeout 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->sources[i].poll_object); - } + 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); + } + /* + * 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); } 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); + } + } + + 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_inst *sdi; GSList *l; int ret; if (!session) { - sr_err("session: %s: session was NULL; a session must be " - "created before starting it.", __func__); - return SR_ERR_BUG; + sr_err("%s: session was NULL", __func__); + return SR_ERR_ARG; } if (!session->devs) { - 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_BUG; + return SR_ERR_ARG; } - sr_info("session: starting"); + if (session->trigger && verify_trigger(session->trigger) != SR_OK) + return SR_ERR; + + sr_info("Starting."); + ret = SR_OK; for (l = session->devs; l; l = l->next) { 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("session: %s: could not start an acquisition " - "(%d)", __func__, ret); + sr_err("%s: could not start an acquisition " + "(%s)", __func__, sr_strerror(ret)); break; } } @@ -276,77 +458,69 @@ 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 (session->num_sources == 1 && session->pollfds[0].fd == -1) { /* Dummy source, freewheel over it. */ - while (session->running) + 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. * - * This function is deprecated and should not be used in new code, use - * sr_session_stop() instead. The behaviour of this function is identical to - * sr_session_stop(). + * The session is stopped immediately, with all acquisition sessions stopped + * and hardware drivers cleaned up. * - * @return SR_OK upon success, SR_ERR_BUG if no session exists. - */ -SR_API int sr_session_halt(void) -{ - return sr_session_stop(); -} - -/** - * Stop the current session. + * This must be called from within the session thread, to prevent freeing + * resources that the session thread will try to use. * - * The current session is stopped immediately, with all acquisition sessions - * being stopped and hardware drivers 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. + * @private */ -SR_API int sr_session_stop(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: stopping"); - session->running = FALSE; + sr_info("Stopping."); for (l = session->devs; l; l = l->next) { sdi = l->data; @@ -355,6 +529,37 @@ SR_API int sr_session_stop(void) sdi->driver->dev_acquisition_stop(sdi, sdi); } } + session->running = FALSE; + + return SR_OK; +} + +/** + * 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. + * + * @retval SR_OK Success. + * @retval SR_ERR_ARG Invalid session passed. + * + * @since 0.4.0 + */ +SR_API int sr_session_stop(struct sr_session *session) +{ + if (!session) { + sr_err("%s: session was NULL", __func__); + return SR_ERR_BUG; + } + + g_mutex_lock(&session->stop_mutex); + session->abort_session = TRUE; + g_mutex_unlock(&session->stop_mutex); return SR_OK; } @@ -364,45 +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; - struct sr_datafeed_analog *analog; + 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_LOGIC: - sr_dbg("bus: received SR_DF_META_LOGIC"); + 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); - break; - case SR_DF_META_ANALOG: - sr_dbg("bus: received SR_DF_META_LOGIC"); + sr_dbg("bus: Received SR_DF_LOGIC packet (%" PRIu64 " bytes, " + "unitsize = %d).", logic->length, logic->unitsize); break; case SR_DF_ANALOG: analog = packet->payload; - /* TODO: Check for analog != NULL. */ - sr_dbg("bus: received SR_DF_ANALOG %d samples", analog->num_samples); + 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"); + sr_dbg("bus: Received SR_DF_FRAME_BEGIN packet."); break; case SR_DF_FRAME_END: - sr_dbg("bus: received 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; } } @@ -412,45 +614,62 @@ 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 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_send(const struct sr_dev_inst *sdi, - struct sr_datafeed_packet *packet) + const struct sr_datafeed_packet *packet) { GSList *l; - sr_datafeed_callback_t cb; + struct datafeed_callback *cb_struct; if (!sdi) { - sr_err("session: %s: sdi was NULL", __func__); + 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; - cb(sdi, packet); + cb_struct = l->data; + cb_struct->cb(sdi, packet, cb_struct->cb_data); } return SR_OK; } -static int _sr_session_source_add(GPollFD *pollfd, int timeout, - sr_receive_data_callback_t cb, void *cb_data, gintptr poll_object) +/** + * 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. + */ +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 (!cb) { - sr_err("session: %s: cb was NULL", __func__); + sr_err("%s: cb was NULL", __func__); return SR_ERR_ARG; } @@ -459,14 +678,14 @@ static int _sr_session_source_add(GPollFD *pollfd, int timeout, new_pollfds = g_try_realloc(session->pollfds, sizeof(GPollFD) * (session->num_sources + 1)); if (!new_pollfds) { - sr_err("session: %s: new_pollfds malloc failed", __func__); + sr_err("%s: new_pollfds malloc failed", __func__); return SR_ERR_MALLOC; } new_sources = g_try_realloc(session->sources, sizeof(struct source) * (session->num_sources + 1)); if (!new_sources) { - sr_err("session: %s: new_sources malloc failed", __func__); + sr_err("%s: new_sources malloc failed", __func__); return SR_ERR_MALLOC; } @@ -487,7 +706,7 @@ static int _sr_session_source_add(GPollFD *pollfd, int timeout, } /** - * Add a event source for a file descriptor. + * Add an event source for a file descriptor. * * @param fd The file descriptor. * @param events Events to check for. @@ -495,79 +714,102 @@ static int _sr_session_source_add(GPollFD *pollfd, int timeout, * @param cb Callback function to add. Must not be NULL. * @param cb_data Data for the callback function. Can be NULL. * - * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or - * SR_ERR_MALLOC upon memory allocation errors. + * @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(int fd, int events, int timeout, - sr_receive_data_callback_t cb, void *cb_data) +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(&p, timeout, cb, cb_data, (gintptr)fd); + return _sr_session_source_add(session, &p, timeout, cb, cb_data, (gintptr)fd); } /** * Add an event source for a GPollFD. * - * TODO: More error checks etc. - * * @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. * - * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or - * SR_ERR_MALLOC upon memory allocation errors. + * @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(GPollFD *pollfd, int timeout, - sr_receive_data_callback_t cb, void *cb_data) +SR_API int sr_session_source_add_pollfd(struct sr_session *session, + GPollFD *pollfd, int timeout, sr_receive_data_callback cb, + void *cb_data) { - return _sr_session_source_add(pollfd, timeout, cb, + (void) session; + + return _sr_session_source_add(session, pollfd, timeout, cb, cb_data, (gintptr)pollfd); } /** * Add an event source for a GIOChannel. * - * TODO: More error checks etc. - * * @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. * - * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or - * SR_ERR_MALLOC upon memory allocation errors. + * @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_channel(GIOChannel *channel, int events, - int timeout, sr_receive_data_callback_t cb, void *cb_data) +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); + 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(&p, timeout, cb, cb_data, (gintptr)channel); + return _sr_session_source_add(session, &p, timeout, cb, cb_data, (gintptr)channel); } - -static int _sr_session_source_remove(gintptr poll_object) +/** + * 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; GPollFD *new_pollfds; unsigned int old; if (!session->sources || !session->num_sources) { - sr_err("session: %s: sources was NULL", __func__); + sr_err("%s: sources was NULL", __func__); return SR_ERR_BUG; } @@ -591,13 +833,13 @@ static int _sr_session_source_remove(gintptr poll_object) new_pollfds = g_try_realloc(session->pollfds, sizeof(GPollFD) * session->num_sources); if (!new_pollfds && session->num_sources > 0) { - sr_err("session: %s: new_pollfds malloc failed", __func__); + sr_err("%s: new_pollfds malloc failed", __func__); return SR_ERR_MALLOC; } new_sources = g_try_realloc(session->sources, sizeof(struct source) * session->num_sources); if (!new_sources && session->num_sources > 0) { - sr_err("session: %s: new_sources malloc failed", __func__); + sr_err("%s: new_sources malloc failed", __func__); return SR_ERR_MALLOC; } @@ -607,50 +849,62 @@ static int _sr_session_source_remove(gintptr poll_object) return SR_OK; } -/* +/** * Remove the source belonging to the specified file descriptor. * - * TODO: More error checks. - * * @param fd The file 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. + * @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(int fd) +SR_API int sr_session_source_remove(struct sr_session *session, int fd) { - return _sr_session_source_remove((gintptr)fd); + (void) session; + + return _sr_session_source_remove(session, (gintptr)fd); } /** * Remove the source belonging to the specified poll descriptor. * - * TODO: More error checks. - * * @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(GPollFD *pollfd) +SR_API int sr_session_source_remove_pollfd(struct sr_session *session, + GPollFD *pollfd) { - return _sr_session_source_remove((gintptr)pollfd); + (void) session; + + return _sr_session_source_remove(session, (gintptr)pollfd); } -/* +/** * Remove the source belonging to the specified channel. * - * TODO: More error checks. - * * @param channel The channel 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. + * @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(GIOChannel *channel) +SR_API int sr_session_source_remove_channel(struct sr_session *session, + GIOChannel *channel) { - return _sr_session_source_remove((gintptr)channel); + (void) session; + + return _sr_session_source_remove(session, (gintptr)channel); } + +/** @} */