X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=session.c;h=514b620ab9f3ca3e2895757ca09387a70da2c1bd;hb=d1056603a00b92d12170e6e7d3da33473147c5f5;hp=7bff474b0aeb982afe448e5e3a73e12dfd5f4ade;hpb=a421dc1d7b24bb7b8f2127b6c07df6b68eb5001f;p=libsigrok.git diff --git a/session.c b/session.c index 7bff474b..514b620a 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,14 +25,14 @@ #include "libsigrok.h" #include "libsigrok-internal.h" -/* Message logging helpers with driver-specific prefix string. */ -#define DRIVER_LOG_DOMAIN "session: " -#define sr_log(l, s, args...) sr_log(l, DRIVER_LOG_DOMAIN s, ## args) -#define sr_spew(s, args...) sr_spew(DRIVER_LOG_DOMAIN s, ## args) -#define sr_dbg(s, args...) sr_dbg(DRIVER_LOG_DOMAIN s, ## args) -#define sr_info(s, args...) sr_info(DRIVER_LOG_DOMAIN s, ## args) -#define sr_warn(s, args...) sr_warn(DRIVER_LOG_DOMAIN s, ## args) -#define sr_err(s, args...) sr_err(DRIVER_LOG_DOMAIN s, ## args) +/* Message logging helpers with subsystem-specific prefix string. */ +#define LOG_PREFIX "session: " +#define sr_log(l, s, args...) sr_log(l, LOG_PREFIX s, ## args) +#define sr_spew(s, args...) sr_spew(LOG_PREFIX s, ## args) +#define sr_dbg(s, args...) sr_dbg(LOG_PREFIX s, ## args) +#define sr_info(s, args...) sr_info(LOG_PREFIX s, ## args) +#define sr_warn(s, args...) sr_warn(LOG_PREFIX s, ## args) +#define sr_err(s, args...) sr_err(LOG_PREFIX s, ## args) /** * @file @@ -59,6 +59,11 @@ struct source { gintptr poll_object; }; +struct datafeed_callback { + sr_datafeed_callback_t cb; + 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; @@ -79,6 +84,8 @@ SR_API struct sr_session *sr_session_new(void) } session->source_timeout = -1; + session->abort_session = FALSE; + g_mutex_init(&session->stop_mutex); return session; } @@ -101,18 +108,14 @@ SR_API int sr_session_destroy(void) /* TODO: Error checks needed? */ + g_mutex_clear(&session->stop_mutex); + 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. * @@ -128,7 +131,7 @@ SR_API int sr_session_dev_remove_all(void) return SR_ERR_BUG; } - g_slist_free_full(session->devs, (GDestroyNotify)sr_dev_close); + g_slist_free(session->devs); session->devs = NULL; return SR_OK; @@ -145,7 +148,6 @@ SR_API int sr_session_dev_remove_all(void) */ SR_API int sr_session_dev_add(const struct sr_dev_inst *sdi) { - int ret; if (!sdi) { sr_err("%s: sdi was NULL", __func__); @@ -172,11 +174,6 @@ SR_API int sr_session_dev_add(const struct sr_dev_inst *sdi) return SR_ERR_BUG; } - if ((ret = sdi->driver->dev_open((struct sr_dev_inst *)sdi)) != SR_OK) { - sr_err("%s: dev_open failed (%d)", __func__, ret); - return ret; - } - session->devs = g_slist_append(session->devs, (gpointer)sdi); return SR_OK; @@ -194,7 +191,7 @@ SR_API int sr_session_datafeed_callback_remove_all(void) return SR_ERR_BUG; } - g_slist_free(session->datafeed_callbacks); + g_slist_free_full(session->datafeed_callbacks, g_free); session->datafeed_callbacks = NULL; return SR_OK; @@ -205,11 +202,14 @@ SR_API int sr_session_datafeed_callback_remove_all(void) * * @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. */ -SR_API int sr_session_datafeed_callback_add(sr_datafeed_callback_t cb) +SR_API int sr_session_datafeed_callback_add(sr_datafeed_callback_t cb, void *cb_data) { + struct datafeed_callback *cb_struct; + if (!session) { sr_err("%s: session was NULL", __func__); return SR_ERR_BUG; @@ -220,34 +220,67 @@ SR_API int sr_session_datafeed_callback_add(sr_datafeed_callback_t cb) 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; } -static int sr_session_run_poll(void) +/** + * Call every device in the 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. + * + * @return SR_OK upon success, SR_ERR on errors. + */ +SR_PRIV int sr_session_iteration(gboolean block) { unsigned int i; int ret; - while (session->num_sources > 0) { - 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 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->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->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(); + /* But once is enough. */ + session->abort_session = FALSE; } + g_mutex_unlock(&session->stop_mutex); } return SR_OK; @@ -278,7 +311,7 @@ SR_API int sr_session_start(void) return SR_ERR_BUG; } - sr_info("session: starting"); + sr_info("Starting."); ret = SR_OK; for (l = session->devs; l; l = l->next) { @@ -324,35 +357,25 @@ SR_API int sr_session_run(void) 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(TRUE); } return SR_OK; } -/** - * Halt the current 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(). - * - * @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. * * The current session is stopped immediately, with all acquisition sessions * being 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. + * * @return SR_OK upon success, SR_ERR_BUG if no session exists. */ -SR_API int sr_session_stop(void) +SR_PRIV int sr_session_stop_sync(void) { struct sr_dev_inst *sdi; GSList *l; @@ -372,14 +395,32 @@ SR_API int sr_session_stop(void) } } - /* - * Some sources may not be necessarily associated with a device. - * Those sources may still be present even after stopping all devices. - * We need to make sure all sources are removed, or we risk running the - * session in an infinite loop. - */ - while (session->num_sources) - sr_session_source_remove(session->sources[0].poll_object); + return SR_OK; +} + +/** + * Stop the current session. + * + * The current 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. + * + * @return SR_OK upon success, SR_ERR_BUG if no session exists. + */ +SR_API int sr_session_stop(void) +{ + 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; } @@ -445,7 +486,7 @@ SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi, const struct sr_datafeed_packet *packet) { GSList *l; - sr_datafeed_callback_t cb; + struct datafeed_callback *cb_struct; if (!sdi) { sr_err("%s: sdi was NULL", __func__); @@ -460,8 +501,8 @@ SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi, for (l = 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;