X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=session.c;h=acf1158b4e3ad0e75061c4aa9ab831f5c5aadbd1;hb=2150a69b7633ebd1bcf13f645c026506f3dfe03b;hp=07a21cf59c1b0ac7415f4e8dbee0cc088530ed4a;hpb=9213ad012accac3dbfbc6b72d6e99228e87740a4;p=libsigrok.git diff --git a/session.c b/session.c index 07a21cf5..acf1158b 100644 --- a/session.c +++ b/session.c @@ -25,6 +25,29 @@ #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) + +/** + * @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; @@ -43,7 +66,7 @@ struct sr_session *session; /** * Create a new session. * - * TODO: Should it use the file-global "session" variable or take an argument? + * @todo Should it use the file-global "session" variable or take an argument? * The same question applies to all the other session functions. * * @return A pointer to the newly allocated session, or NULL upon errors. @@ -51,11 +74,13 @@ struct sr_session *session; SR_API struct sr_session *sr_session_new(void) { if (!(session = g_try_malloc0(sizeof(struct sr_session)))) { - sr_err("session: %s: session malloc failed", __func__); - return NULL; /* TODO: SR_ERR_MALLOC? */ + sr_err("Session malloc failed."); + return NULL; } session->source_timeout = -1; + session->abort_session = FALSE; + g_mutex_init(&session->stop_mutex); return session; } @@ -70,7 +95,7 @@ SR_API struct sr_session *sr_session_new(void) SR_API int sr_session_destroy(void) { if (!session) { - sr_err("session: %s: session was NULL", __func__); + sr_err("%s: session was NULL", __func__); return SR_ERR_BUG; } @@ -78,7 +103,7 @@ SR_API int sr_session_destroy(void) /* TODO: Error checks needed? */ - /* TODO: Loop over protocol decoders and free them. */ + g_mutex_clear(&session->stop_mutex); g_free(session); session = NULL; @@ -86,14 +111,50 @@ SR_API int sr_session_destroy(void) return SR_OK; } -static void sr_dev_close(struct sr_dev *dev) +/** + * Close a device instance. + * + * @param sdi The device instance to close. Must not be NULL. Also, + * sdi->driver, sdi->driver->priv, and sdi->priv must not be NULL. + */ +static void sr_dev_close(struct sr_dev_inst *sdi) { - if (dev->driver->dev_close) - dev->driver->dev_close(dev->driver_index); + int ret; + + if (!sdi) { + sr_err("Invalid device instance, can't close device."); + return; + } + + /* In the drivers sdi->priv is a 'struct dev_context *devc'. */ + if (!sdi->priv) { + /* + * Should be sr_err() in theory, but the 'demo' driver has + * NULL for sdi->priv, so we use sr_dbg() until that's fixed. + */ + sr_dbg("Invalid device context, can't close device."); + return; + } + + if (!sdi->driver) { + sr_err("Invalid driver, can't close device."); + return; + } + + if (!sdi->driver->priv) { + sr_err("Driver not initialized, can't close device."); + return; + } + + sr_spew("Closing '%s' device instance %d.", sdi->driver->name, + sdi->index); + + if ((ret = sdi->driver->dev_close(sdi)) < 0) + sr_err("Failed to close device instance: %d.", ret); } /** - * Remove all the devices from the current session. TODO? + * Remove all the devices from the current session. * * The session itself (i.e., the struct sr_session) is not free'd and still * exists after this function returns. @@ -103,7 +164,7 @@ static void sr_dev_close(struct sr_dev *dev) SR_API int sr_session_dev_remove_all(void) { if (!session) { - sr_err("session: %s: session was NULL", __func__); + sr_err("%s: session was NULL", __func__); return SR_ERR_BUG; } @@ -114,49 +175,49 @@ SR_API int sr_session_dev_remove_all(void) } /** - * Add a device to the current session. + * Add a device instance to the current session. * - * @param dev The device to add to the current session. Must not be NULL. - * Also, dev->driver and dev->driver->dev_open must not be NULL. + * @param sdi The device instance to add to the current 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. */ -SR_API int sr_session_dev_add(struct sr_dev *dev) +SR_API int sr_session_dev_add(const 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 (!session) { - sr_err("session: %s: session was NULL", __func__); + sr_err("%s: session was NULL", __func__); return SR_ERR_BUG; } - /* If dev->driver is NULL, this is a virtual device. */ - if (!dev->driver) { - sr_dbg("session: %s: dev->driver was NULL, this seems to be " + /* 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, dev); + session->devs = g_slist_append(session->devs, (gpointer)sdi); return SR_OK; } - /* dev->driver is non-NULL (i.e. we have a real device). */ - if (!dev->driver->dev_open) { - sr_err("session: %s: dev->driver->dev_open was NULL", - __func__); + /* 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; } - if ((ret = dev->driver->dev_open(dev->driver_index)) != SR_OK) { - sr_err("session: %s: dev_open failed (%d)", __func__, ret); + 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, dev); + session->devs = g_slist_append(session->devs, (gpointer)sdi); return SR_OK; } @@ -169,7 +230,7 @@ SR_API int sr_session_dev_add(struct sr_dev *dev) SR_API int sr_session_datafeed_callback_remove_all(void) { if (!session) { - sr_err("session: %s: session was NULL", __func__); + sr_err("%s: session was NULL", __func__); return SR_ERR_BUG; } @@ -190,12 +251,12 @@ SR_API int sr_session_datafeed_callback_remove_all(void) SR_API int sr_session_datafeed_callback_add(sr_datafeed_callback_t cb) { 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; } @@ -205,29 +266,37 @@ SR_API int sr_session_datafeed_callback_add(sr_datafeed_callback_t cb) return SR_OK; } -/** - * TODO. - */ static int sr_session_run_poll(void) { unsigned int i; int ret; - while (session->running) { - ret = g_poll(session->pollfds, session->num_sources, session->source_timeout); - + 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 timeout out and this source + * 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)) + 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(); + g_mutex_unlock(&session->stop_mutex); } } @@ -243,33 +312,29 @@ static int sr_session_run_poll(void) */ SR_API int sr_session_start(void) { - 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__); + sr_err("%s: session was NULL; a session must be " + "created before starting it.", __func__); return SR_ERR_BUG; } 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_BUG; } - /* TODO: Check driver_index validity? */ - - 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->driver->dev_acquisition_start( - dev->driver_index, dev)) != SR_OK) { - sr_err("session: %s: could not start an acquisition " + sdi = l->data; + if ((ret = sdi->driver->dev_acquisition_start(sdi, sdi)) != SR_OK) { + sr_err("%s: could not start an acquisition " "(%d)", __func__, ret); break; } @@ -283,32 +348,29 @@ SR_API int sr_session_start(void) /** * Run the session. * - * TODO: Various error checks etc. - * * @return SR_OK upon success, SR_ERR_BUG upon errors. */ SR_API int sr_session_run(void) { if (!session) { - sr_err("session: %s: session was NULL; a session must be " + sr_err("%s: session was NULL; a session must be " "created first, before running it.", __func__); return SR_ERR_BUG; } 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; } - 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. */ @@ -319,22 +381,44 @@ SR_API int sr_session_run(void) } /** - * Halt the current session. + * Stop the current session. * - * This requests the current session be stopped as soon as possible, for - * example on receiving an SR_DF_END packet. + * 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_halt(void) +SR_PRIV int sr_session_stop_sync(void) { + struct sr_dev_inst *sdi; + 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: halting"); - session->running = FALSE; + 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); + } + } + + /* + * 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; } @@ -345,29 +429,23 @@ SR_API int sr_session_halt(void) * 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) { - 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->driver) { - if (dev->driver->dev_acquisition_stop) - dev->driver->dev_acquisition_stop(dev->driver_index, dev); - } - } + g_mutex_lock(&session->stop_mutex); + session->abort_session = TRUE; + g_mutex_unlock(&session->stop_mutex); return SR_OK; } @@ -377,45 +455,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).", + logic->length); 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; } } @@ -425,24 +500,26 @@ 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. + * + * @private */ -SR_PRIV int sr_session_send(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_t cb; - if (!dev) { - sr_err("session: %s: dev 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; } @@ -450,13 +527,24 @@ SR_PRIV int sr_session_send(struct sr_dev *dev, if (sr_log_loglevel_get() >= SR_LOG_DBG) datafeed_dump(packet); cb = l->data; - /* TODO: Check for cb != NULL. */ - cb(dev, packet); + cb(sdi, packet); } return SR_OK; } +/** + * Add an event source for a file descriptor. + * + * @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. + * @param poll_object TODO. + * + * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or + * SR_ERR_MALLOC upon memory allocation errors. + */ static int _sr_session_source_add(GPollFD *pollfd, int timeout, sr_receive_data_callback_t cb, void *cb_data, gintptr poll_object) { @@ -464,22 +552,23 @@ static int _sr_session_source_add(GPollFD *pollfd, int timeout, GPollFD *new_pollfds; if (!cb) { - sr_err("session: %s: cb was NULL", __func__); + sr_err("%s: cb was NULL", __func__); return SR_ERR_ARG; } /* Note: cb_data can be NULL, that's not a bug. */ - new_pollfds = g_try_realloc(session->pollfds, sizeof(GPollFD) * (session->num_sources + 1)); + 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)); + (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; } @@ -500,7 +589,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. @@ -525,8 +614,6 @@ SR_API int sr_session_source_add(int fd, int events, int timeout, /** * 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. @@ -545,8 +632,6 @@ SR_API int sr_session_source_add_pollfd(GPollFD *pollfd, int timeout, /** * 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. @@ -562,8 +647,7 @@ SR_API int sr_session_source_add_channel(GIOChannel *channel, int events, GPollFD p; #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; @@ -572,7 +656,17 @@ SR_API int sr_session_source_add_channel(GIOChannel *channel, int events, return _sr_session_source_add(&p, timeout, cb, cb_data, (gintptr)channel); } - +/** + * Remove the source belonging to the specified channel. + * + * @todo Add more error checks and logging. + * + * @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. + */ static int _sr_session_source_remove(gintptr poll_object) { struct source *new_sources; @@ -580,7 +674,7 @@ static int _sr_session_source_remove(gintptr poll_object) 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; } @@ -604,13 +698,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; } @@ -620,11 +714,9 @@ 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 @@ -639,8 +731,6 @@ SR_API int sr_session_source_remove(int 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 @@ -652,11 +742,9 @@ SR_API int sr_session_source_remove_pollfd(GPollFD *pollfd) return _sr_session_source_remove((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 @@ -667,3 +755,5 @@ SR_API int sr_session_source_remove_channel(GIOChannel *channel) { return _sr_session_source_remove((gintptr)channel); } + +/** @} */