Improve compatibility with various kinds of VCD files.

[libsigrok.git] / session_file.c

diff --git a/session_file.c b/session_file.c
index 33364a29a4540eea957051be8170ab8f341bfe6d..12c0bf863832d4d5afbeb56dec2f0d55aeb07459 100644 (file)
--- a/session_file.c
+++ b/session_file.c
@@ -23,10 +23,31 @@
 #include <zip.h>
 #include <glib.h>
 #include <glib/gstdio.h>
-#include "config.h"
+#include "config.h" /* Needed for PACKAGE_VERSION and others. */
 #include "libsigrok.h"
 #include "libsigrok-internal.h"
 
+/* Message logging helpers with driver-specific prefix string. */
+#define DRIVER_LOG_DOMAIN "session-file: "
+#define sr_log(l, s, args...) sr_log(l, DRIVER_LOG_DOMAIN s, ## args)
+#define sr_spew(s, args...) sr_spew(DRIVER_LOG_DOMAIN s, ## args)
+#define sr_dbg(s, args...) sr_dbg(DRIVER_LOG_DOMAIN s, ## args)
+#define sr_info(s, args...) sr_info(DRIVER_LOG_DOMAIN s, ## args)
+#define sr_warn(s, args...) sr_warn(DRIVER_LOG_DOMAIN s, ## args)
+#define sr_err(s, args...) sr_err(DRIVER_LOG_DOMAIN s, ## args)
+
+/**
+ * @file
+ *
+ * Loading and saving libsigrok session files.
+ */
+
+/**
+ * @addtogroup grp_session
+ *
+ * @{
+ */
+
 extern struct sr_session *session;
 extern SR_PRIV struct sr_dev_driver session_driver;
 
@@ -48,42 +69,47 @@ SR_API int sr_session_load(const char *filename)
        struct zip_stat zs;
        struct sr_dev_inst *sdi;
        struct sr_probe *probe;
-       int ret, probenum, devcnt, i, j;
+       int ret, probenum, devcnt, version, i, j;
        uint64_t tmp_u64, total_probes, enabled_probes, p;
-       char **sections, **keys, *metafile, *val, c;
+       char **sections, **keys, *metafile, *val, s[11];
        char probename[SR_MAX_PROBENAME_LEN + 1];
 
        if (!filename) {
-               sr_err("session file: %s: filename was NULL", __func__);
+               sr_err("%s: filename was NULL", __func__);
                return SR_ERR_ARG;
        }
 
        if (!(archive = zip_open(filename, 0, &ret))) {
-               sr_dbg("session file: Failed to open session file: zip "
-                      "error %d", ret);
+               sr_dbg("Failed to open session file: zip error %d", ret);
                return SR_ERR;
        }
 
        /* check "version" */
+       version = 0;
        if (!(zf = zip_fopen(archive, "version", 0))) {
-               sr_dbg("session file: Not a sigrok session file.");
+               sr_dbg("Not a sigrok session file.");
                return SR_ERR;
        }
-       ret = zip_fread(zf, &c, 1);
-       if (ret != 1 || c != '1') {
-               sr_dbg("session file: Not a valid sigrok session file.");
+       if ((ret = zip_fread(zf, s, 10)) == -1) {
+               sr_dbg("Not a valid sigrok session file.");
                return SR_ERR;
        }
        zip_fclose(zf);
+       s[ret] = 0;
+       version = strtoull(s, NULL, 10);
+       if (version != 1) {
+               sr_dbg("Not a valid sigrok session file version.");
+               return SR_ERR;
+       }
 
        /* read "metadata" */
        if (zip_stat(archive, "metadata", 0, &zs) == -1) {
-               sr_dbg("session file: Not a valid sigrok session file.");
+               sr_dbg("Not a valid sigrok session file.");
                return SR_ERR;
        }
 
        if (!(metafile = g_try_malloc(zs.size))) {
-               sr_err("session file: %s: metafile malloc failed", __func__);
+               sr_err("%s: metafile malloc failed", __func__);
                return SR_ERR_MALLOC;
        }
 
@@ -93,7 +119,7 @@ SR_API int sr_session_load(const char *filename)
 
        kf = g_key_file_new();
        if (!g_key_file_load_from_data(kf, metafile, zs.size, 0, NULL)) {
-               sr_dbg("session file: Failed to parse metadata.");
+               sr_dbg("Failed to parse metadata.");
                return SR_ERR;
        }
 
@@ -188,7 +214,7 @@ SR_API int sr_session_save(const char *filename,
        char version[1], rawname[16], metafile[32], *buf, *s;
 
        if (!filename) {
-               sr_err("session file: %s: filename was NULL", __func__);
+               sr_err("%s: filename was NULL", __func__);
                return SR_ERR_ARG;
        }
 
@@ -202,7 +228,7 @@ SR_API int sr_session_save(const char *filename,
        if (!(versrc = zip_source_buffer(zipfile, version, 1, 0)))
                return SR_ERR;
        if (zip_add(zipfile, "version", versrc) == -1) {
-               sr_info("session file: error saving version into zipfile: %s",
+               sr_info("error saving version into zipfile: %s",
                        zip_strerror(zipfile));
                return SR_ERR;
        }
@@ -249,8 +275,7 @@ SR_API int sr_session_save(const char *filename,
        buf = g_try_malloc(ds->num_units * ds->ds_unitsize +
                   DATASTORE_CHUNKSIZE);
        if (!buf) {
-               sr_err("session file: %s: buf malloc failed",
-                          __func__);
+               sr_err("%s: buf malloc failed", __func__);
                return SR_ERR_MALLOC;
        }
 
@@ -274,8 +299,7 @@ SR_API int sr_session_save(const char *filename,
                return SR_ERR;
 
        if ((ret = zip_close(zipfile)) == -1) {
-               sr_info("session file: error saving zipfile: %s",
-                       zip_strerror(zipfile));
+               sr_info("error saving zipfile: %s", zip_strerror(zipfile));
                return SR_ERR;
        }
 
@@ -283,3 +307,5 @@ SR_API int sr_session_save(const char *filename,
 
        return SR_OK;
 }
+
+/** @} */