]> sigrok.org Git - libsigrok.git/blobdiff - session.c
sr: session/demo: Remove Windows specific hack
[libsigrok.git] / session.c
index ffa7e0721f2e726143a29a4dac801dd22bc44f4a..43e97dbc63bbd1aff654d5fa0c9075744cefa637 100644 (file)
--- a/session.c
+++ b/session.c
 #include <unistd.h>
 #include <string.h>
 #include <glib.h>
-#include "sigrok.h"
-#include "sigrok-internal.h"
-
-/* demo.c. TODO: Should not be global! */
-extern SR_PRIV GIOChannel channels[2];
+#include "libsigrok.h"
+#include "libsigrok-internal.h"
 
 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. */
@@ -41,7 +41,13 @@ struct source {
 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;
 
 /**
@@ -97,7 +103,7 @@ SR_API int sr_session_destroy(void)
  *
  * @return SR_OK upon success, SR_ERR_BUG if no session exists.
  */
-SR_API int sr_session_dev_clear(void)
+SR_API int sr_session_dev_remove_all(void)
 {
        if (!session) {
                sr_err("session: %s: session was NULL", __func__);
@@ -145,7 +151,7 @@ SR_API int sr_session_dev_add(struct sr_dev *dev)
        if (!dev->driver->dev_open) {
                sr_err("session: %s: dev->driver->dev_open was NULL",
                       __func__);
-               return SR_ERR_ARG;
+               return SR_ERR_BUG;
        }
 
        if ((ret = dev->driver->dev_open(dev->driver_index)) != SR_OK) {
@@ -159,11 +165,11 @@ SR_API int sr_session_dev_add(struct sr_dev *dev)
 }
 
 /**
- * Clear all datafeed callbacks in the current session.
+ * Remove all datafeed callbacks in the current session.
  *
  * @return SR_OK upon success, SR_ERR_BUG if no session exists.
  */
-SR_API int sr_session_datafeed_callback_clear(void)
+SR_API int sr_session_datafeed_callback_remove_all(void)
 {
        if (!session) {
                sr_err("session: %s: session was NULL", __func__);
@@ -207,47 +213,25 @@ SR_API int sr_session_datafeed_callback_add(sr_datafeed_callback_t cb)
  */
 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);
+               ret = g_poll(pollfds, num_sources, source_timeout);
 
-               /* 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);
-
-               for (i = 0; i < num_sources; i++) {
-                       if (fds[i].revents > 0 || (ret == 0
+                       if (pollfds[i].revents > 0 || (ret == 0
                                && source_timeout == sources[i].timeout)) {
                                /*
                                 * Invoke the source's callback on an event,
                                 * or if the poll timeout out and this source
                                 * asked for that timeout.
                                 */
-                               if (!sources[i].cb(fds[i].fd, fds[i].revents,
+                               if (!sources[i].cb(pollfds[i].fd, pollfds[i].revents,
                                                  sources[i].cb_data))
-                                       sr_session_source_remove(sources[i].fd);
+                                       sr_session_source_remove(pollfds[i].fd);
                        }
                }
        }
-       g_free(fds);
 
        return SR_OK;
 }
@@ -324,7 +308,7 @@ SR_API int sr_session_run(void)
        session->running = TRUE;
 
        /* Do we have real sources? */
-       if (num_sources == 1 && sources[0].fd == -1) {
+       if (num_sources == 1 && pollfds[0].fd == -1) {
                /* Dummy source, freewheel over it. */
                while (session->running)
                        sources[0].cb(-1, 0, sources[0].cb_data);
@@ -400,6 +384,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 +393,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_LOGIC");
+               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;
@@ -459,24 +461,11 @@ SR_PRIV int sr_session_send(struct sr_dev *dev,
        return SR_OK;
 }
 
-/**
- * TODO.
- *
- * TODO: More error checks etc.
- *
- * @param fd TODO.
- * @param events TODO.
- * @param timeout TODO.
- * @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)
+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,24 +474,25 @@ 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) {
+       new_pollfds = g_try_realloc(pollfds, sizeof(GPollFD) * (num_sources + 1));
+       if (!new_pollfds) {
                sr_err("session: %s: new_sources 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(sources, sizeof(struct source) * (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++];
-       s->fd = fd;
-       s->events = events;
        s->timeout = timeout;
        s->cb = cb;
        s->cb_data = cb_data;
+       s->poll_object = poll_object;
+       pollfds = new_pollfds;
        sources = new_sources;
 
        if (timeout != source_timeout && timeout > 0
@@ -513,48 +503,169 @@ SR_API int sr_session_source_add(int fd, int events, int timeout,
 }
 
 /**
- * Remove the source belonging to the specified file descriptor.
+ * Add a event source for a file descriptor.
  *
- * TODO: More error checks.
+ * @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.
  *
- * @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(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 a 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.
+ * @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_ERR_BUG upon
- *         internal errors.
+ *         SR_ERR_MALLOC upon memory allocation errors.
  */
-SR_API int sr_session_source_remove(int fd)
+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 a 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.
+ * @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_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);
+}
+
+
+static int _sr_session_source_remove(gintptr poll_object)
 {
        struct source *new_sources;
-       int old, new;
+       GPollFD *new_pollfds;
+       int old;
 
        if (!sources) {
                sr_err("session: %s: sources was NULL", __func__);
                return SR_ERR_BUG;
        }
 
-       /* TODO: Check if 'fd' valid. */
+       for (old = 0; old < num_sources; old++) {
+               if (sources[old].poll_object == poll_object)
+                       break;
+       }
+
+       /* fd not found, nothing to do */
+       if (old == num_sources)
+               return SR_OK;
 
-       new_sources = g_try_malloc0(sizeof(struct source) * num_sources);
-       if (!new_sources) {
+       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));
+       }
+
+       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__);
                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));
+       new_sources = g_try_realloc(sources, sizeof(struct source) * num_sources);
+       if (!new_sources && num_sources > 0) {
+               sr_err("session: %s: new_sources 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);
-       }
+       pollfds = new_pollfds;
+       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.
+ *
+ * @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.
+ *
+ * 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
+ *         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.
+ *
+ * TODO: More error checks.
+ *
+ * @parama 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);
+}