]> sigrok.org Git - libsigrok.git/blobdiff - session_file.c
Centralise duplicated logging helper defines.
[libsigrok.git] / session_file.c
index 4838a6be00566b2f0fc7fb140697bc7f4b653b2c..27e540955ba5d499a5a7d5ee0fd5ef7ec42fe5ce 100644 (file)
 #include <stdlib.h>
 #include <unistd.h>
 #include <zip.h>
+#include <sys/types.h>
+#include <sys/stat.h>
+#include <errno.h>
 #include <glib.h>
 #include <glib/gstdio.h>
 #include "config.h" /* Needed for PACKAGE_VERSION and others. */
 #include "libsigrok.h"
 #include "libsigrok-internal.h"
 
-/* Message logging helpers with subsystem-specific prefix string. */
-#define LOG_PREFIX "session-file: "
-#define sr_log(l, s, args...) sr_log(l, LOG_PREFIX s, ## args)
-#define sr_spew(s, args...) sr_spew(LOG_PREFIX s, ## args)
-#define sr_dbg(s, args...) sr_dbg(LOG_PREFIX s, ## args)
-#define sr_info(s, args...) sr_info(LOG_PREFIX s, ## args)
-#define sr_warn(s, args...) sr_warn(LOG_PREFIX s, ## args)
-#define sr_err(s, args...) sr_err(LOG_PREFIX s, ## args)
+#define LOG_PREFIX "session-file"
 
 /**
  * @file
 extern struct sr_session *session;
 extern SR_PRIV struct sr_dev_driver session_driver;
 
-/**
- * Load the session from the specified filename.
- *
- * @param filename The name of the session file to load. Must not be NULL.
- *
- * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments,
- *         SR_ERR_MALLOC upon memory allocation errors, or SR_ERR upon
- *         other errors.
- */
-SR_API int sr_session_load(const char *filename)
+/** @private */
+SR_PRIV int sr_sessionfile_check(const char *filename)
 {
-       GKeyFile *kf;
-       GPtrArray *capturefiles;
+       struct stat st;
        struct zip *archive;
        struct zip_file *zf;
        struct zip_stat zs;
-       struct sr_dev_inst *sdi;
-       struct sr_probe *probe;
-       int ret, probenum, devcnt, version, i, j;
-       uint64_t tmp_u64, total_probes, enabled_probes, p;
-       char **sections, **keys, *metafile, *val, s[11];
-       char probename[SR_MAX_PROBENAME_LEN + 1];
+       int version, ret;
+       char s[11];
 
-       if (!filename) {
-               sr_err("%s: filename was NULL", __func__);
+       if (!filename)
                return SR_ERR_ARG;
-       }
 
-       if (!(archive = zip_open(filename, 0, &ret))) {
-               sr_dbg("Failed to open session file: zip error %d", ret);
+       if (stat(filename, &st) == -1) {
+               sr_err("Couldn't stat %s: %s", filename, strerror(errno));
                return SR_ERR;
        }
 
+       if (!(archive = zip_open(filename, 0, &ret)))
+               /* No logging: this can be used just to check if it's
+                * a sigrok session file or not. */
+               return SR_ERR;
+
        /* check "version" */
        version = 0;
        if (!(zf = zip_fopen(archive, "version", 0))) {
-               sr_dbg("Not a sigrok session file.");
+               sr_dbg("Not a sigrok session file: no version found.");
                return SR_ERR;
        }
-       if ((ret = zip_fread(zf, s, 10)) == -1) {
-               sr_dbg("Not a valid sigrok session file.");
+       if ((ret = zip_fread(zf, s, 10)) == -1)
                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.");
+               sr_dbg("Cannot handle sigrok session file version %d.", version);
                return SR_ERR;
        }
 
@@ -108,6 +92,41 @@ SR_API int sr_session_load(const char *filename)
                return SR_ERR;
        }
 
+       return SR_OK;
+}
+
+/**
+ * Load the session from the specified filename.
+ *
+ * @param filename The name of the session file to load. Must not be NULL.
+ *
+ * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments,
+ *         SR_ERR_MALLOC upon memory allocation errors, or SR_ERR upon
+ *         other errors.
+ */
+SR_API int sr_session_load(const char *filename)
+{
+       GKeyFile *kf;
+       GPtrArray *capturefiles;
+       struct zip *archive;
+       struct zip_file *zf;
+       struct zip_stat zs;
+       struct sr_dev_inst *sdi;
+       struct sr_probe *probe;
+       int ret, probenum, devcnt, i, j;
+       uint64_t tmp_u64, total_probes, enabled_probes, p;
+       char **sections, **keys, *metafile, *val;
+       char probename[SR_MAX_PROBENAME_LEN + 1];
+
+       if ((ret = sr_sessionfile_check(filename)) != SR_OK)
+               return ret;
+
+       if (!(archive = zip_open(filename, 0, &ret)))
+               return SR_ERR;
+
+       if (zip_stat(archive, "metadata", 0, &zs) == -1)
+               return SR_ERR;
+
        if (!(metafile = g_try_malloc(zs.size))) {
                sr_err("%s: metafile malloc failed", __func__);
                return SR_ERR_MALLOC;
@@ -148,22 +167,22 @@ SR_API int sr_session_load(const char *filename)
                                        sr_dev_open(sdi);
                                        sr_session_dev_add(sdi);
                                        sdi->driver->config_set(SR_CONF_SESSIONFILE,
-                                                       g_variant_new_string(filename), sdi);
+                                                       g_variant_new_string(filename), sdi, NULL);
                                        sdi->driver->config_set(SR_CONF_CAPTUREFILE,
-                                                       g_variant_new_string(val), sdi);
+                                                       g_variant_new_string(val), sdi, NULL);
                                        g_ptr_array_add(capturefiles, val);
                                } else if (!strcmp(keys[j], "samplerate")) {
                                        sr_parse_sizestring(val, &tmp_u64);
                                        sdi->driver->config_set(SR_CONF_SAMPLERATE,
-                                                       g_variant_new_uint64(tmp_u64), sdi);
+                                                       g_variant_new_uint64(tmp_u64), sdi, NULL);
                                } else if (!strcmp(keys[j], "unitsize")) {
                                        tmp_u64 = strtoull(val, NULL, 10);
                                        sdi->driver->config_set(SR_CONF_CAPTURE_UNITSIZE,
-                                                       g_variant_new_uint64(tmp_u64), sdi);
+                                                       g_variant_new_uint64(tmp_u64), sdi, NULL);
                                } else if (!strcmp(keys[j], "total probes")) {
                                        total_probes = strtoull(val, NULL, 10);
                                        sdi->driver->config_set(SR_CONF_CAPTURE_NUM_PROBES,
-                                                       g_variant_new_uint64(total_probes), sdi);
+                                                       g_variant_new_uint64(total_probes), sdi, NULL);
                                        for (p = 0; p < total_probes; p++) {
                                                snprintf(probename, SR_MAX_PROBENAME_LEN, "%" PRIu64, p);
                                                if (!(probe = sr_probe_new(p, SR_PROBE_LOGIC, TRUE,
@@ -262,8 +281,8 @@ SR_API int sr_session_save(const char *filename, const struct sr_dev_inst *sdi,
        fprintf(meta, "unitsize = %d\n", unitsize);
        fprintf(meta, "total probes = %d\n", g_slist_length(sdi->probes));
        if (sr_dev_has_option(sdi, SR_CONF_SAMPLERATE)) {
-               if (sr_config_get(sdi->driver, SR_CONF_SAMPLERATE,
-                               &gvar, sdi) == SR_OK) {
+               if (sr_config_get(sdi->driver, sdi, NULL,
+                                       SR_CONF_SAMPLERATE, &gvar) == SR_OK) {
                        samplerate = g_variant_get_uint64(gvar);
                        s = sr_samplerate_string(samplerate);
                        fprintf(meta, "samplerate = %s\n", s);
@@ -306,4 +325,65 @@ SR_API int sr_session_save(const char *filename, const struct sr_dev_inst *sdi,
        return SR_OK;
 }
 
+/**
+ * Append data to an existing session file.
+ *
+ * @param filename The name of the filename to append to. Must not be NULL.
+ * @param buf The data to be appended.
+ * @param unitsize The number of bytes per sample.
+ * @param units The number of samples.
+ *
+ * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or SR_ERR
+ *         upon other errors.
+ */
+SR_API int sr_session_append(const char *filename, unsigned char *buf,
+               int unitsize, int units)
+{
+       struct zip *archive;
+       struct zip_source *logicsrc;
+       zip_int64_t num_files;
+       int chunk_num, next_chunk_num, ret, i;
+       const char *entry_name;
+       char chunkname[16];
+
+       if ((ret = sr_sessionfile_check(filename)) != SR_OK)
+               return ret;
+
+       if (!(archive = zip_open(filename, 0, &ret)))
+               return SR_ERR;
+
+       next_chunk_num = 1;
+       num_files = zip_get_num_entries(archive, 0);
+       for (i = 0; i < num_files; i++) {
+               entry_name = zip_get_name(archive, i, 0);
+               if (strncmp(entry_name, "logic-1", 7))
+                       continue;
+               if (strlen(entry_name) == 7) {
+                       /* This file has no extra chunks, just a single "logic-1".
+                        * Rename it to "logic-1-1" * and continue with chunk 2. */
+                       if (zip_rename(archive, i, "logic-1-1") == -1) {
+                               sr_err("Failed to rename 'logic-1' to 'logic-1-1'.");
+                               return SR_ERR;
+                       }
+                       next_chunk_num = 2;
+                       break;
+               } else if (strlen(entry_name) > 8 && entry_name[7] == '-') {
+                       chunk_num = strtoull(entry_name + 8, NULL, 10);
+                       if (chunk_num >= next_chunk_num)
+                               next_chunk_num = chunk_num + 1;
+               }
+       }
+       snprintf(chunkname, 15, "logic-1-%d", next_chunk_num);
+       if (!(logicsrc = zip_source_buffer(archive, buf, units * unitsize, FALSE)))
+               return SR_ERR;
+       if (zip_add(archive, chunkname, logicsrc) == -1)
+               return SR_ERR;
+       if ((ret = zip_close(archive)) == -1) {
+               sr_info("error saving session file: %s", zip_strerror(archive));
+               return SR_ERR;
+       }
+
+       return SR_OK;
+}
+
 /** @} */