]> sigrok.org Git - libsigrok.git/blobdiff - session.c
sr: clean up public/private split in headers
[libsigrok.git] / session.c
index ab28c72c2d30d3a091a2887261bac65fba4d496e..b33baa5c57f32a990d62dba28ce3e0816dc87d2d 100644 (file)
--- a/session.c
+++ b/session.c
@@ -1,7 +1,7 @@
 /*
  * This file is part of the sigrok project.
  *
- * Copyright (C) 2010 Bert Vermeulen <bert@biot.com>
+ * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
  *
  * 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,7 +17,6 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-#include "config.h"
 #include <stdio.h>
 #include <stdlib.h>
 #include <unistd.h>
@@ -26,8 +25,8 @@
 #include "sigrok.h"
 #include "sigrok-internal.h"
 
-/* demo.c */
-extern GIOChannel channels[2];
+/* demo.c. TODO: Should not be global! */
+extern SR_PRIV GIOChannel channels[2];
 
 struct source {
        int fd;
@@ -56,9 +55,9 @@ static int source_timeout = -1;
  *
  * @return A pointer to the newly allocated session, or NULL upon errors.
  */
-struct sr_session *sr_session_new(void)
+SR_API struct sr_session *sr_session_new(void)
 {
-       if (!(session = calloc(1, sizeof(struct sr_session)))) {
+       if (!(session = g_try_malloc0(sizeof(struct sr_session)))) {
                sr_err("session: %s: session malloc failed", __func__);
                return NULL; /* TODO: SR_ERR_MALLOC? */
        }
@@ -73,10 +72,10 @@ struct sr_session *sr_session_new(void)
  *
  * @return SR_OK upon success, SR_ERR_BUG if no session exists.
  */
-int sr_session_destroy(void)
+SR_API int sr_session_destroy(void)
 {
        if (!session) {
-               sr_warn("session: %s: session was NULL", __func__);
+               sr_err("session: %s: session was NULL", __func__);
                return SR_ERR_BUG;
        }
 
@@ -101,10 +100,10 @@ int sr_session_destroy(void)
  *
  * @return SR_OK upon success, SR_ERR_BUG if no session exists.
  */
-int sr_session_device_clear(void)
+SR_API int sr_session_device_clear(void)
 {
        if (!session) {
-               sr_warn("session: %s: session was NULL", __func__);
+               sr_err("session: %s: session was NULL", __func__);
                return SR_ERR_BUG;
        }
 
@@ -123,7 +122,7 @@ int sr_session_device_clear(void)
  *
  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments.
  */
-int sr_session_device_add(struct sr_device *device)
+SR_API int sr_session_device_add(struct sr_device *device)
 {
        int ret;
 
@@ -165,7 +164,7 @@ int sr_session_device_add(struct sr_device *device)
  *
  * @return SR_OK upon success, SR_ERR_BUG if no session exists.
  */
-int sr_session_datafeed_callback_clear(void)
+SR_API int sr_session_datafeed_callback_clear(void)
 {
        if (!session) {
                sr_err("session: %s: session was NULL", __func__);
@@ -184,7 +183,7 @@ int sr_session_datafeed_callback_clear(void)
  * @param callback TODO.
  * @return SR_OK upon success, SR_ERR_BUG if no session exists.
  */
-int sr_session_datafeed_callback_add(sr_datafeed_callback callback)
+SR_API int sr_session_datafeed_callback_add(sr_datafeed_callback callback)
 {
        if (!session) {
                sr_err("session: %s: session was NULL", __func__);
@@ -209,13 +208,11 @@ static int sr_session_run_poll(void)
 
        fds = NULL;
        while (session->running) {
-               if (fds)
-                       free(fds);
+               /* TODO: Add comment. */
+               g_free(fds);
 
                /* Construct g_poll()'s array. */
-               /* TODO: Check malloc return value. */
-               fds = malloc(sizeof(GPollFD) * num_sources);
-               if (!fds) {
+               if (!(fds = g_try_malloc(sizeof(GPollFD) * num_sources))) {
                        sr_err("session: %s: fds malloc failed", __func__);
                        return SR_ERR_MALLOC;
                }
@@ -246,7 +243,7 @@ static int sr_session_run_poll(void)
                        }
                }
        }
-       free(fds);
+       g_free(fds);
 
        return SR_OK;
 }
@@ -258,7 +255,7 @@ static int sr_session_run_poll(void)
  *
  * @return SR_OK upon success, SR_ERR upon errors.
  */
-int sr_session_start(void)
+SR_API int sr_session_start(void)
 {
        struct sr_device *device;
        GSList *l;
@@ -304,7 +301,7 @@ int sr_session_start(void)
  *
  * @return SR_OK upon success, SR_ERR_BUG upon errors.
  */
-int sr_session_run(void)
+SR_API int sr_session_run(void)
 {
        if (!session) {
                sr_err("session: %s: session was NULL; a session must be "
@@ -342,7 +339,7 @@ int sr_session_run(void)
  *
  * @return SR_OK upon success, SR_ERR_BUG if no session exists.
  */
-int sr_session_halt(void)
+SR_API int sr_session_halt(void)
 {
        if (!session) {
                sr_err("session: %s: session was NULL", __func__);
@@ -362,7 +359,7 @@ int sr_session_halt(void)
  *
  * @return SR_OK upon success, SR_ERR_BUG if no session exists.
  */
-int sr_session_stop(void)
+SR_API int sr_session_stop(void)
 {
        struct sr_device *device;
        GSList *l;
@@ -390,49 +387,35 @@ int sr_session_stop(void)
 }
 
 /**
- * TODO.
+ * @brief debug helper
  *
- * TODO: Various error checks.
+ * @param packet The packet to show debugging information for.
  *
- * @param packet TODO.
- * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments.
  */
-static int datafeed_dump(struct sr_datafeed_packet *packet)
+static void 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;
                /* TODO: Check for logic != NULL. */
-               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);
+               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:
-               /* TODO: Abort? */
-               sr_err("bus: received unknown packet type %d", packet->type);
+               sr_dbg("bus: received unknown packet type %d", packet->type);
                break;
        }
 
-       return SR_OK;
 }
 
 /**
@@ -442,7 +425,8 @@ static int datafeed_dump(struct sr_datafeed_packet *packet)
  * @param packet TODO.
  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments.
  */
-int sr_session_bus(struct sr_device *device, struct sr_datafeed_packet *packet)
+SR_API int sr_session_bus(struct sr_device *device,
+                         struct sr_datafeed_packet *packet)
 {
        GSList *l;
        sr_datafeed_callback cb;
@@ -467,9 +451,10 @@ int sr_session_bus(struct sr_device *device, struct sr_datafeed_packet *packet)
         * the callbacks as well.
         */
        for (l = session->datafeed_callbacks; l; l = l->next) {
+               if (sr_log_loglevel_get() >= SR_LOG_DBG)
+                       datafeed_dump(packet);
                cb = l->data;
                /* TODO: Check for cb != NULL. */
-               datafeed_dump(packet);
                cb(device, packet);
        }
 
@@ -479,7 +464,6 @@ int sr_session_bus(struct sr_device *device, struct sr_datafeed_packet *packet)
 /**
  * TODO.
  *
- * TODO: Switch to g_try_malloc0() / g_free().
  * TODO: More error checks etc.
  *
  * @param fd TODO.
@@ -490,8 +474,8 @@ int sr_session_bus(struct sr_device *device, struct sr_datafeed_packet *packet)
  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
  *         SR_ERR_MALLOC upon memory allocation errors.
  */
-int sr_session_source_add(int fd, int events, int timeout,
-               sr_receive_data_callback callback, void *user_data)
+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;
 
@@ -502,7 +486,7 @@ int sr_session_source_add(int fd, int events, int timeout,
 
        /* Note: user_data can be NULL, that's not a bug. */
 
-       new_sources = calloc(1, sizeof(struct source) * (num_sources + 1));
+       new_sources = g_try_malloc0(sizeof(struct source) * (num_sources + 1));
        if (!new_sources) {
                sr_err("session: %s: new_sources malloc failed", __func__);
                return SR_ERR_MALLOC;
@@ -511,7 +495,7 @@ int sr_session_source_add(int fd, int events, int timeout,
        if (sources) {
                memcpy(new_sources, sources,
                       sizeof(struct source) * num_sources);
-               free(sources);
+               g_free(sources);
        }
 
        s = &new_sources[num_sources++];
@@ -533,14 +517,13 @@ int sr_session_source_add(int fd, int events, int timeout,
  * 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.
  */
-int sr_session_source_remove(int fd)
+SR_API int sr_session_source_remove(int fd)
 {
        struct source *new_sources;
        int old, new;
@@ -552,7 +535,7 @@ int sr_session_source_remove(int fd)
 
        /* TODO: Check if 'fd' valid. */
 
-       new_sources = calloc(1, sizeof(struct source) * num_sources);
+       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;
@@ -565,12 +548,12 @@ int sr_session_source_remove(int fd)
        }
 
        if (old != new) {
-               free(sources);
+               g_free(sources);
                sources = new_sources;
                num_sources--;
        } else {
                /* Target fd was not found. */
-               free(new_sources);
+               g_free(new_sources);
        }
 
        return SR_OK;