X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=session.c;h=81e09b114dc59c44a2300dd85ad927329a7714ba;hb=8be8746951e5538147370d9871a4c1ed0268db52;hp=f1a8370bf48784641973a978ae5ba45a28f110bb;hpb=01c3e9dbd5bd583012fc1f46237bf4fde784d209;p=libsigrok.git diff --git a/session.c b/session.c index f1a8370b..81e09b11 100644 --- a/session.c +++ b/session.c @@ -22,32 +22,42 @@ #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]; +/** + * @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_t cb; void *cb_data; + + /* 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; }; /* 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; - -static struct source *sources = NULL; -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. @@ -59,6 +69,8 @@ SR_API struct sr_session *sr_session_new(void) return NULL; /* TODO: SR_ERR_MALLOC? */ } + session->source_timeout = -1; + return session; } @@ -76,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. @@ -104,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; } @@ -132,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; } @@ -202,52 +217,29 @@ SR_API int sr_session_datafeed_callback_add(sr_datafeed_callback_t cb) return SR_OK; } -/** - * TODO. - */ static int sr_session_run_poll(void) { - 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; - } - 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 - } - - ret = g_poll(fds, num_sources, source_timeout); + unsigned int i; + int ret; - for (i = 0; i < num_sources; i++) { - if (fds[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(fds[i].fd, fds[i].revents, - sources[i].cb_data)) - sr_session_source_remove(sources[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); } } } - g_free(fds); return SR_OK; } @@ -261,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; @@ -301,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) @@ -321,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 && 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].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(); @@ -339,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(); } /** @@ -367,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) { @@ -376,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); } } @@ -400,6 +373,7 @@ SR_API int sr_session_stop(void) static void datafeed_dump(struct sr_datafeed_packet *packet) { struct sr_datafeed_logic *logic; + struct sr_datafeed_analog *analog; switch (packet->type) { case SR_DF_HEADER: @@ -408,14 +382,31 @@ static void datafeed_dump(struct sr_datafeed_packet *packet) case SR_DF_TRIGGER: sr_dbg("bus: received SR_DF_TRIGGER"); break; + case SR_DF_META_LOGIC: + sr_dbg("bus: received SR_DF_META_LOGIC"); + 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_ANALOG"); + 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); + break; case SR_DF_END: sr_dbg("bus: received SR_DF_END"); break; + case SR_DF_FRAME_BEGIN: + sr_dbg("bus: received SR_DF_FRAME_BEGIN"); + break; + case SR_DF_FRAME_END: + sr_dbg("bus: received SR_DF_FRAME_END"); + break; default: sr_dbg("bus: received unknown packet type %d", packet->type); break; @@ -427,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; } @@ -452,31 +445,29 @@ 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; } /** - * TODO. - * - * TODO: More error checks etc. + * Add an event source for a file descriptor. * - * @param fd TODO. - * @param events TODO. - * @param timeout TODO. + * @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. */ -SR_API int sr_session_source_add(int fd, int events, int timeout, - sr_receive_data_callback_t cb, void *cb_data) +static int _sr_session_source_add(GPollFD *pollfd, int timeout, + sr_receive_data_callback_t 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__); @@ -485,76 +476,202 @@ SR_API int sr_session_source_add(int fd, int events, int timeout, /* 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("session: %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("session: %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 = cb; s->cb_data = cb_data; - sources = new_sources; + 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. + * + * @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. + * + * @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(int fd, int events, int timeout, + sr_receive_data_callback_t cb, void *cb_data) +{ + GPollFD p; + + p.fd = fd; + p.events = events; + + return _sr_session_source_add(&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. + * + * @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_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); +} + +/** + * Add an event source for a GIOChannel. * - * TODO: More error checks. + * @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. * - * @param fd TODO. + * @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) +{ + GPollFD p; + +#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(&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. */ -SR_API int sr_session_source_remove(int fd) +static int _sr_session_source_remove(gintptr poll_object) { struct source *new_sources; - int old, new; + GPollFD *new_pollfds; + unsigned int old; - if (!sources) { + if (!session->sources || !session->num_sources) { sr_err("session: %s: sources was NULL", __func__); return SR_ERR_BUG; } - /* TODO: Check if 'fd' valid. */ + for (old = 0; old < session->num_sources; old++) { + if (session->sources[old].poll_object == poll_object) + break; + } - 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; + /* fd not found, nothing to do */ + if (old == session->num_sources) + return SR_OK; + + 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("session: %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("session: %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. + * + * @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. + */ +SR_API int sr_session_source_remove(int fd) +{ + return _sr_session_source_remove((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. + */ +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. + * + * @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. + */ +SR_API int sr_session_source_remove_channel(GIOChannel *channel) +{ + return _sr_session_source_remove((gintptr)channel); +} + +/** @} */