X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=session.c;h=0c21c7caa9fa5f5d5e2c3919d272b221b734f220;hb=1a081ca67d63a0bd933a3d715792d85afd437296;hp=8f8edcce0eddd1c91f178b46f42e2ec7b63c9948;hpb=a0ecd83bc6e07ea412db5cd0108d50d89e36df8f;p=libsigrok.git diff --git a/session.c b/session.c index 8f8edcce..0c21c7ca 100644 --- a/session.c +++ b/session.c @@ -1,7 +1,7 @@ /* * This file is part of the sigrok project. * - * Copyright (C) 2010 Bert Vermeulen + * Copyright (C) 2012 Bert Vermeulen * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -17,14 +17,13 @@ * along with this program. If not, see . */ -#include "config.h" #include #include #include #include #include -#include -#include +#include "sigrok.h" +#include "sigrok-internal.h" /* demo.c */ extern GIOChannel channels[2]; @@ -45,36 +44,112 @@ static int num_sources = 0; static struct source *sources = NULL; static int source_timeout = -1; -struct sr_session *sr_session_new(void) +/** + * Create a new session. + * + * TODO. + * + * TODO: Should return int? + * 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. + */ +SR_API struct sr_session *sr_session_new(void) { - session = calloc(1, sizeof(struct sr_session)); + if (!(session = calloc(1, sizeof(struct sr_session)))) { + sr_err("session: %s: session malloc failed", __func__); + return NULL; /* TODO: SR_ERR_MALLOC? */ + } return session; } -void sr_session_destroy(void) +/** + * Destroy the current session. + * + * This frees up all memory used by the session. + * + * @return SR_OK upon success, SR_ERR_BUG if no session exists. + */ +SR_API int sr_session_destroy(void) { + if (!session) { + sr_warn("session: %s: session was NULL", __func__); + return SR_ERR_BUG; + } + g_slist_free(session->devices); + session->devices = NULL; + + /* TODO: Error checks needed? */ /* TODO: Loop over protocol decoders and free them. */ g_free(session); + session = NULL; + + return SR_OK; } -void sr_session_device_clear(void) +/** + * Remove all the devices from the current session. TODO? + * + * 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. + */ +SR_API int sr_session_device_clear(void) { + if (!session) { + sr_warn("session: %s: session was NULL", __func__); + return SR_ERR_BUG; + } + g_slist_free(session->devices); session->devices = NULL; + + return SR_OK; } -int sr_session_device_add(struct sr_device *device) +/** + * Add a device to the current session. + * + * @param device The device to add to the current session. Must not be NULL. + * Also, device->plugin and device->plugin->opendev must not + * be NULL. + * + * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments. + */ +SR_API int sr_session_device_add(struct sr_device *device) { int ret; - if (device->plugin && device->plugin->opendev) { - ret = device->plugin->opendev(device->plugin_index); - if (ret != SR_OK) - return ret; + if (!device) { + sr_err("session: %s: device was NULL", __func__); + return SR_ERR_ARG; + } + + if (!device->plugin) { + sr_err("session: %s: device->plugin was NULL", __func__); + return SR_ERR_ARG; + } + + if (!device->plugin->opendev) { + sr_err("session: %s: device->plugin->opendev was NULL", + __func__); + return SR_ERR_ARG; + } + + if (!session) { + sr_err("session: %s: session was NULL", __func__); + return SR_ERR; /* TODO: SR_ERR_BUG? */ + } + + if ((ret = device->plugin->opendev(device->plugin_index)) != SR_OK) { + sr_err("session: %s: opendev failed (%d)", __func__, ret); + return ret; } session->devices = g_slist_append(session->devices, device); @@ -82,36 +157,51 @@ int sr_session_device_add(struct sr_device *device) return SR_OK; } -#if 0 -void sr_session_pa_clear(void) -{ - /* - * The protocols are pointers to the global set of PA plugins, - * so don't free them. - */ - g_slist_free(session->analyzers); - session->analyzers = NULL; -} - -void sr_session_pa_add(struct sr_analyzer *an) +/** + * Clear all datafeed callbacks in the current session. + * + * TODO. + * + * @return SR_OK upon success, SR_ERR_BUG if no session exists. + */ +SR_API int sr_session_datafeed_callback_clear(void) { - session->analyzers = g_slist_append(session->analyzers, an); -} -#endif + if (!session) { + sr_err("session: %s: session was NULL", __func__); + return SR_ERR_BUG; + } -void sr_session_datafeed_callback_clear(void) -{ g_slist_free(session->datafeed_callbacks); session->datafeed_callbacks = NULL; + + return SR_OK; } -void sr_session_datafeed_callback_add(sr_datafeed_callback callback) +/** + * Add a datafeed callback to the current session. + * + * @param callback TODO. + * @return SR_OK upon success, SR_ERR_BUG if no session exists. + */ +SR_API int sr_session_datafeed_callback_add(sr_datafeed_callback callback) { + if (!session) { + sr_err("session: %s: session was NULL", __func__); + return SR_ERR_BUG; + } + + /* TODO: Is 'callback' allowed to be NULL? */ + session->datafeed_callbacks = g_slist_append(session->datafeed_callbacks, callback); + + return SR_OK; } -static void sr_session_run_poll() +/** + * TODO. + */ +static int sr_session_run_poll(void) { GPollFD *fds, my_gpollfd; int ret, i; @@ -122,7 +212,12 @@ static void sr_session_run_poll() free(fds); /* Construct g_poll()'s array. */ + /* TODO: Check malloc return value. */ fds = malloc(sizeof(GPollFD) * num_sources); + if (!fds) { + 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], @@ -151,108 +246,264 @@ static void sr_session_run_poll() } } free(fds); + + return SR_OK; } -int sr_session_start(void) +/** + * Start a session. + * + * There can only be one session at a time. TODO + * + * @return SR_OK upon success, SR_ERR upon errors. + */ +SR_API int sr_session_start(void) { struct sr_device *device; GSList *l; int ret; + if (!session) { + sr_err("session: %s: session was NULL; a session must be " + "created first, before starting it.", __func__); + return SR_ERR; /* TODO: SR_ERR_BUG? */ + } + + if (!session->devices) { + /* TODO: Actually the case? */ + sr_err("session: %s: session->devices was NULL; a session " + "cannot be started without devices.", __func__); + return SR_ERR; /* TODO: SR_ERR_BUG? */ + } + + /* TODO: Check plugin_index validity? */ + sr_info("session: starting"); + for (l = session->devices; l; l = l->next) { device = l->data; + /* TODO: Check for device != NULL. */ if ((ret = device->plugin->start_acquisition( - device->plugin_index, device)) != SR_OK) + device->plugin_index, device)) != SR_OK) { + sr_err("session: %s: could not start an acquisition " + "(%d)", __func__, ret); break; + } } + /* TODO: What if there are multiple devices? Which return code? */ + return ret; } -void sr_session_run(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 " + "created first, before running it.", __func__); + return SR_ERR_BUG; + } + + if (!session->devices) { + /* TODO: Actually the case? */ + sr_err("session: %s: session->devices was NULL; a session " + "cannot be run without devices.", __func__); + return SR_ERR_BUG; + } + sr_info("session: running"); session->running = TRUE; - /* do we have real sources? */ - if (num_sources == 1 && sources[0].fd == -1) - /* dummy source, freewheel over it */ + /* Do we have real sources? */ + if (num_sources == 1 && sources[0].fd == -1) { + /* Dummy source, freewheel over it. */ while (session->running) sources[0].cb(-1, 0, sources[0].user_data); - else - /* real sources, use g_poll() main loop */ + } else { + /* Real sources, use g_poll() main loop. */ sr_session_run_poll(); + } + + return SR_OK; } -void sr_session_halt(void) +/** + * Halt the current session. + * + * TODO. + * + * @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; } -void sr_session_stop(void) +/** + * Stop the current session. + * + * TODO: Difference to halt? + * + * @return SR_OK upon success, SR_ERR_BUG if no session exists. + */ +SR_API int sr_session_stop(void) { struct sr_device *device; GSList *l; + if (!session) { + sr_err("session: %s: session was NULL", __func__); + return SR_ERR_BUG; + } + sr_info("session: stopping"); session->running = FALSE; + for (l = session->devices; l; l = l->next) { device = l->data; - if (device->plugin && device->plugin->stop_acquisition) - device->plugin->stop_acquisition(device->plugin_index, device); + /* Check for device != NULL. */ + if (device->plugin) { + if (device->plugin->stop_acquisition) + device->plugin->stop_acquisition(device->plugin_index, device); + if (device->plugin->cleanup) + device->plugin->cleanup(); + } } + + return SR_OK; } -static void datafeed_dump(struct sr_datafeed_packet *packet) +/** + * TODO. + * + * TODO: Various error checks. + * + * @param packet TODO. + * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments. + */ +static int datafeed_dump(struct sr_datafeed_packet *packet) { struct sr_datafeed_logic *logic; + if (!packet) { + sr_err("session: %s: packet was NULL", __func__); + return SR_ERR_ARG; + } + + /* TODO: Validity checks for packet contents. */ + switch (packet->type) { case SR_DF_HEADER: sr_dbg("bus: received SR_DF_HEADER"); break; case SR_DF_TRIGGER: - sr_dbg("bus: received SR_DF_TRIGGER at %lu ms", - packet->timeoffset / 1000000); + sr_dbg("bus: received SR_DF_TRIGGER"); break; case SR_DF_LOGIC: logic = packet->payload; - sr_dbg("bus: received SR_DF_LOGIC at %f ms duration %f ms, %"PRIu64" bytes", - packet->timeoffset / 1000000.0, packet->duration / 1000000.0, - logic->length); + /* TODO: Check for logic != NULL. */ + sr_dbg("bus: received SR_DF_LOGIC %" PRIu64 " bytes", logic->length); break; case SR_DF_END: sr_dbg("bus: received SR_DF_END"); break; default: - sr_dbg("bus: received unknown packet type %d", packet->type); + /* TODO: Abort? */ + sr_err("bus: received unknown packet type %d", packet->type); + break; } + + return SR_OK; } -void sr_session_bus(struct sr_device *device, struct sr_datafeed_packet *packet) +/** + * TODO. + * + * @param device TODO. + * @param packet TODO. + * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments. + */ +SR_API int sr_session_bus(struct sr_device *device, + struct sr_datafeed_packet *packet) { GSList *l; sr_datafeed_callback cb; + if (!device) { + sr_err("session: %s: device was NULL", __func__); + return SR_ERR_ARG; + } + + if (!device->plugin) { + sr_err("session: %s: device->plugin was NULL", __func__); + return SR_ERR_ARG; + } + + if (!packet) { + sr_err("session: %s: packet was NULL", __func__); + return SR_ERR_ARG; + } + /* * TODO: Send packet through PD pipe, and send the output of that to * the callbacks as well. */ for (l = session->datafeed_callbacks; l; l = l->next) { cb = l->data; + /* TODO: Check for cb != NULL. */ datafeed_dump(packet); cb(device, packet); } + + return SR_OK; } -void sr_session_source_add(int fd, int events, int timeout, - sr_receive_data_callback callback, void *user_data) +/** + * TODO. + * + * TODO: Switch to g_try_malloc0() / g_free(). + * TODO: More error checks etc. + * + * @param fd TODO. + * @param events TODO. + * @param timeout TODO. + * @param callback TODO. + * @param user_data 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 callback, void *user_data) { struct source *new_sources, *s; + if (!callback) { + sr_err("session: %s: callback was NULL", __func__); + return SR_ERR_ARG; + } + + /* Note: user_data can be NULL, that's not a bug. */ + new_sources = calloc(1, sizeof(struct source) * (num_sources + 1)); + if (!new_sources) { + sr_err("session: %s: new_sources malloc failed", __func__); + return SR_ERR_MALLOC; + } if (sources) { memcpy(new_sources, sources, @@ -271,21 +522,44 @@ void sr_session_source_add(int fd, int events, int timeout, if (timeout != source_timeout && timeout > 0 && (source_timeout == -1 || timeout < source_timeout)) source_timeout = timeout; + + return SR_OK; } -void sr_session_source_remove(int fd) +/** + * Remove the source belonging to the specified file descriptor. + * + * TODO: More error checks. + * TODO: Switch to g_try_malloc0() / g_free(). + * + * @param fd TODO. + * @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) { struct source *new_sources; int old, new; - if (!sources) - return; + if (!sources) { + sr_err("session: %s: sources was NULL", __func__); + return SR_ERR_BUG; /* TODO: Other? */ + } + + /* TODO: Check if 'fd' valid. */ new_sources = calloc(1, sizeof(struct source) * num_sources); - for (old = 0, new = 0; old < num_sources; old++) + if (!new_sources) { + sr_err("session: %s: new_sources malloc failed", __func__); + return SR_ERR_MALLOC; + } + + for (old = 0, new = 0; old < num_sources; old++) { if (sources[old].fd != fd) memcpy(&new_sources[new++], &sources[old], sizeof(struct source)); + } if (old != new) { free(sources); @@ -295,4 +569,6 @@ void sr_session_source_remove(int fd) /* Target fd was not found. */ free(new_sources); } + + return SR_OK; }