X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=session.c;h=81e09b114dc59c44a2300dd85ad927329a7714ba;hb=162b735218b906d5a41e8da69ea15b76d267f1fd;hp=43e97dbc63bbd1aff654d5fa0c9075744cefa637;hpb=249ae2be8f0e5132d601ab431ac8783b5b1c7439;p=libsigrok.git diff --git a/session.c b/session.c index 43e97dbc..81e09b11 100644 --- a/session.c +++ b/session.c @@ -25,6 +25,20 @@ #include "libsigrok.h" #include "libsigrok-internal.h" +/** + * @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; @@ -39,21 +53,11 @@ struct source { /* 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; - -/* Both "sources" and "pollfds" are of the same size and contain pairs of - * descriptor and callback function. We can not embed the GPollFD into the - * source struct since we want to be able to pass the array of all poll - * descriptors to g_poll. - */ -static struct source *sources = NULL; -static GPollFD *pollfds; -static int source_timeout = -1; /** * 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. @@ -65,6 +69,8 @@ SR_API struct sr_session *sr_session_new(void) return NULL; /* TODO: SR_ERR_MALLOC? */ } + session->source_timeout = -1; + return session; } @@ -82,21 +88,24 @@ SR_API int sr_session_destroy(void) return SR_ERR_BUG; } - g_slist_free(session->devs); - session->devs = NULL; + sr_session_dev_remove_all(); /* TODO: Error checks needed? */ - /* TODO: Loop over protocol decoders and free them. */ - 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 the current session. * * The session itself (i.e., the struct sr_session) is not free'd and still * exists after this function returns. @@ -110,26 +119,27 @@ SR_API int sr_session_dev_remove_all(void) return SR_ERR_BUG; } - g_slist_free(session->devs); + g_slist_free_full(session->devs, (GDestroyNotify)sr_dev_close); session->devs = NULL; return SR_OK; } /** - * 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("session: %s: sdi was NULL", __func__); return SR_ERR_ARG; } @@ -138,28 +148,27 @@ SR_API int sr_session_dev_add(struct sr_dev *dev) 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("session: %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("session: %s: sdi->driver->dev_open was NULL", __func__); return SR_ERR_BUG; } - if ((ret = dev->driver->dev_open(dev->driver_index)) != SR_OK) { + 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, dev); + session->devs = g_slist_append(session->devs, (gpointer)sdi); return SR_OK; } @@ -208,27 +217,26 @@ SR_API int sr_session_datafeed_callback_add(sr_datafeed_callback_t cb) return SR_OK; } -/** - * TODO. - */ static int sr_session_run_poll(void) { - int ret, i; - - while (session->running) { - ret = g_poll(pollfds, num_sources, source_timeout); + unsigned int i; + int ret; - for (i = 0; i < num_sources; i++) { - if (pollfds[i].revents > 0 || (ret == 0 - && source_timeout == sources[i].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 (!sources[i].cb(pollfds[i].fd, pollfds[i].revents, - sources[i].cb_data)) - sr_session_source_remove(pollfds[i].fd); + 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); } } } @@ -245,32 +253,27 @@ 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__); + "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 " "cannot be started without devices.", __func__); return SR_ERR_BUG; } - /* TODO: Check driver_index validity? */ - sr_info("session: starting"); 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) { + sdi = l->data; + if ((ret = sdi->driver->dev_acquisition_start(sdi, sdi)) != SR_OK) { sr_err("session: %s: could not start an acquisition " "(%d)", __func__, ret); break; @@ -285,8 +288,6 @@ 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) @@ -305,13 +306,12 @@ SR_API int sr_session_run(void) } sr_info("session: running"); - session->running = TRUE; /* Do we have real sources? */ - if (num_sources == 1 && pollfds[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].cb_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(); @@ -323,22 +323,15 @@ SR_API int sr_session_run(void) /** * Halt the current session. * - * This requests the current session be stopped as soon as possible, for - * example on receiving an SR_DF_END packet. + * 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) { - if (!session) { - sr_err("session: %s: session was NULL", __func__); - return SR_ERR_BUG; - } - - sr_info("session: halting"); - session->running = FALSE; - - return SR_OK; + return sr_session_stop(); } /** @@ -351,7 +344,7 @@ SR_API int sr_session_halt(void) */ SR_API int sr_session_stop(void) { - struct sr_dev *dev; + struct sr_dev_inst *sdi; GSList *l; if (!session) { @@ -360,16 +353,12 @@ SR_API int sr_session_stop(void) } 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); - if (dev->driver->cleanup) - dev->driver->cleanup(); + sdi = l->data; + if (sdi->driver) { + if (sdi->driver->dev_acquisition_stop) + sdi->driver->dev_acquisition_stop(sdi, sdi); } } @@ -402,7 +391,7 @@ static void datafeed_dump(struct sr_datafeed_packet *packet) 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_META_ANALOG"); break; case SR_DF_ANALOG: analog = packet->payload; @@ -429,19 +418,21 @@ 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, +SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi, 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("session: %s: sdi was NULL", __func__); return SR_ERR_ARG; } @@ -454,15 +445,26 @@ 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) + sr_receive_data_callback_t cb, void *cb_data, gintptr poll_object) { struct source *new_sources, *s; GPollFD *new_pollfds; @@ -474,36 +476,38 @@ static int _sr_session_source_add(GPollFD *pollfd, int timeout, /* Note: cb_data can be NULL, that's not a bug. */ - new_pollfds = g_try_realloc(pollfds, sizeof(GPollFD) * (num_sources + 1)); + new_pollfds = g_try_realloc(session->pollfds, + sizeof(GPollFD) * (session->num_sources + 1)); if (!new_pollfds) { - sr_err("session: %s: new_sources malloc failed", __func__); + sr_err("session: %s: new_pollfds malloc failed", __func__); return SR_ERR_MALLOC; } - new_sources = g_try_realloc(sources, sizeof(struct source) * (num_sources + 1)); + 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__); return SR_ERR_MALLOC; } - new_pollfds[num_sources] = *pollfd; - s = &new_sources[num_sources++]; + new_pollfds[session->num_sources] = *pollfd; + s = &new_sources[session->num_sources++]; s->timeout = timeout; s->cb = cb; s->cb_data = cb_data; s->poll_object = poll_object; - pollfds = new_pollfds; - sources = new_sources; + 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; } /** - * 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. @@ -526,9 +530,7 @@ SR_API int sr_session_source_add(int fd, int events, int timeout, } /** - * Add a event source for a GPollFD - * - * TODO: More error checks etc. + * 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. @@ -541,13 +543,12 @@ SR_API int sr_session_source_add(int fd, int events, int timeout, SR_API int sr_session_source_add_pollfd(GPollFD *pollfd, int timeout, sr_receive_data_callback_t cb, void *cb_data) { - return _sr_session_source_add(pollfd, timeout, cb, cb_data, (gintptr)pollfd); + return _sr_session_source_add(pollfd, timeout, cb, + cb_data, (gintptr)pollfd); } /** - * Add a event source for a GIOChannel - * - * TODO: More error checks etc. + * Add an event source for a GIOChannel. * * @param channel The GIOChannel. * @param events Events to poll on. @@ -558,14 +559,13 @@ SR_API int sr_session_source_add_pollfd(GPollFD *pollfd, int timeout, * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or * SR_ERR_MALLOC upon memory allocation errors. */ -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(GIOChannel *channel, int events, + int timeout, sr_receive_data_callback_t cb, void *cb_data) { 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; @@ -574,60 +574,68 @@ SR_API int sr_session_source_add_channel(GIOChannel *channel, int events, int ti 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; GPollFD *new_pollfds; - int old; + unsigned int old; - if (!sources) { + if (!session->sources || !session->num_sources) { sr_err("session: %s: sources was NULL", __func__); return SR_ERR_BUG; } - for (old = 0; old < num_sources; old++) { - if (sources[old].poll_object == poll_object) + for (old = 0; old < session->num_sources; old++) { + if (session->sources[old].poll_object == poll_object) break; } /* fd not found, nothing to do */ - if (old == num_sources) + if (old == session->num_sources) return SR_OK; - num_sources -= 1; + session->num_sources -= 1; - if (old != num_sources) { - memmove(&pollfds[old], &pollfds[old+1], - (num_sources - old) * sizeof(GPollFD)); - memmove(&sources[old], &sources[old+1], - (num_sources - old) * sizeof(struct source)); + 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)); } - new_pollfds = g_try_realloc(sources, sizeof(GPollFD) * num_sources); - if (!new_pollfds && num_sources > 0) { - sr_err("session: %s: new_sources malloc failed", __func__); + 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__); return SR_ERR_MALLOC; } - new_sources = g_try_realloc(sources, sizeof(struct source) * num_sources); - if (!new_sources && num_sources > 0) { + 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__); return SR_ERR_MALLOC; } - pollfds = new_pollfds; - sources = new_sources; + session->pollfds = new_pollfds; + session->sources = new_sources; 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. + * @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 @@ -641,8 +649,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 @@ -654,12 +660,10 @@ 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. - * - * @parama channel: The channel for which the source should be removed. + * @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 @@ -669,3 +673,5 @@ SR_API int sr_session_source_remove_channel(GIOChannel *channel) { return _sr_session_source_remove((gintptr)channel); } + +/** @} */