X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=session_file.c;h=4e3d05bb395331b5936a8f530d92cc8fc198246a;hb=17794067f96fd2b6f55b49bfcc2ce08e6edf57e5;hp=90f671e91feb53c9efc103352ee229498e6082d6;hpb=fb381e4d713fcd3fdec99b4deff3a75e809df825;p=libsigrok.git

diff --git a/session_file.c b/session_file.c
index 90f671e9..4e3d05bb 100644
--- a/session_file.c
+++ b/session_file.c
@@ -1,7 +1,7 @@
 /*
- * This file is part of the sigrok project.
+ * This file is part of the libsigrok project.
  *
- * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
+ * Copyright (C) 2013 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
@@ -21,15 +21,80 @@
 #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"
+#include "config.h" /* Needed for PACKAGE_VERSION and others. */
 #include "libsigrok.h"
 #include "libsigrok-internal.h"
 
+#define LOG_PREFIX "session-file"
+
+/**
+ * @file
+ *
+ * Loading and saving libsigrok session files.
+ */
+
+/**
+ * @addtogroup grp_session
+ *
+ * @{
+ */
+
 extern struct sr_session *session;
 extern SR_PRIV struct sr_dev_driver session_driver;
 
+/** @private */
+SR_PRIV int sr_sessionfile_check(const char *filename)
+{
+	struct stat st;
+	struct zip *archive;
+	struct zip_file *zf;
+	struct zip_stat zs;
+	int version, ret;
+	char s[11];
+
+	if (!filename)
+		return SR_ERR_ARG;
+
+	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: no version found.");
+		return SR_ERR;
+	}
+	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("Cannot handle sigrok session file version %d.", version);
+		return SR_ERR;
+	}
+
+	/* read "metadata" */
+	if (zip_stat(archive, "metadata", 0, &zs) == -1) {
+		sr_dbg("Not a valid sigrok session file.");
+		return SR_ERR;
+	}
+
+	return SR_OK;
+}
+
 /**
  * Load the session from the specified filename.
  *
@@ -50,40 +115,20 @@ SR_API int sr_session_load(const char *filename)
 	struct sr_probe *probe;
 	int ret, probenum, devcnt, i, j;
 	uint64_t tmp_u64, total_probes, enabled_probes, p;
-	char **sections, **keys, *metafile, *val, c;
+	char **sections, **keys, *metafile, *val;
 	char probename[SR_MAX_PROBENAME_LEN + 1];
 
-	if (!filename) {
-		sr_err("session file: %s: filename was NULL", __func__);
-		return SR_ERR_ARG;
-	}
+	if ((ret = sr_sessionfile_check(filename)) != SR_OK)
+		return ret;
 
-	if (!(archive = zip_open(filename, 0, &ret))) {
-		sr_dbg("session file: Failed to open session file: zip "
-		       "error %d", ret);
+	if (!(archive = zip_open(filename, 0, &ret)))
 		return SR_ERR;
-	}
 
-	/* check "version" */
-	if (!(zf = zip_fopen(archive, "version", 0))) {
-		sr_dbg("session file: 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 (zip_stat(archive, "metadata", 0, &zs) == -1)
 		return SR_ERR;
-	}
-	zip_fclose(zf);
-
-	/* read "metadata" */
-	if (zip_stat(archive, "metadata", 0, &zs) == -1) {
-		sr_dbg("session file: 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 +138,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;
 	}
 
@@ -109,7 +154,7 @@ SR_API int sr_session_load(const char *filename)
 		if (!strncmp(sections[i], "device ", 7)) {
 			/* device section */
 			sdi = NULL;
-			enabled_probes = 0;
+			enabled_probes = total_probes = 0;
 			keys = g_key_file_get_keys(kf, sections[i], NULL, NULL);
 			for (j = 0; keys[j]; j++) {
 				val = g_key_file_get_string(kf, sections[i], keys[j], NULL);
@@ -118,20 +163,26 @@ SR_API int sr_session_load(const char *filename)
 					sdi->driver = &session_driver;
 					if (devcnt == 0)
 						/* first device, init the driver */
-						sdi->driver->init();
+						sdi->driver->init(NULL);
+					sr_dev_open(sdi);
 					sr_session_dev_add(sdi);
-					sdi->driver->dev_config_set(sdi, SR_HWCAP_SESSIONFILE, filename);
-					sdi->driver->dev_config_set(sdi, SR_HWCAP_CAPTUREFILE, val);
+					sdi->driver->config_set(SR_CONF_SESSIONFILE,
+							g_variant_new_string(filename), sdi, NULL);
+					sdi->driver->config_set(SR_CONF_CAPTUREFILE,
+							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->dev_config_set(sdi, SR_HWCAP_SAMPLERATE, &tmp_u64);
+					sdi->driver->config_set(SR_CONF_SAMPLERATE,
+							g_variant_new_uint64(tmp_u64), sdi, NULL);
 				} else if (!strcmp(keys[j], "unitsize")) {
 					tmp_u64 = strtoull(val, NULL, 10);
-					sdi->driver->dev_config_set(sdi, SR_HWCAP_CAPTURE_UNITSIZE, &tmp_u64);
+					sdi->driver->config_set(SR_CONF_CAPTURE_UNITSIZE,
+							g_variant_new_uint64(tmp_u64), sdi, NULL);
 				} else if (!strcmp(keys[j], "total probes")) {
 					total_probes = strtoull(val, NULL, 10);
-					sdi->driver->dev_config_set(sdi, SR_HWCAP_CAPTURE_NUM_PROBES, &total_probes);
+					sdi->driver->config_set(SR_CONF_NUM_LOGIC_PROBES,
+							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,
@@ -153,8 +204,9 @@ SR_API int sr_session_load(const char *filename)
 			}
 			g_strfreev(keys);
 			/* Disable probes not specifically listed. */
-			for (p = enabled_probes; p < total_probes; p++)
-				sr_dev_probe_enable(sdi, p, FALSE);
+			if (total_probes)
+				for (p = enabled_probes; p < total_probes; p++)
+					sr_dev_probe_enable(sdi, p, FALSE);
 		}
 		devcnt++;
 	}
@@ -167,27 +219,79 @@ SR_API int sr_session_load(const char *filename)
 /**
  * Save the current session to the specified file.
  *
- * @param filename The name of the file where to save the current session.
+ * @param filename The name of the filename to save the current session as.
  *                 Must not be NULL.
+ * @param sdi The device instance from which the data was captured.
+ * @param buf The data to be saved.
+ * @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.
+ * @retval SR_OK Success
+ * @retval SR_ERR_ARG Invalid arguments
+ * @retval SR_ERR Other errors
  */
-int sr_session_save(const char *filename)
+SR_API int sr_session_save(const char *filename, const struct sr_dev_inst *sdi,
+		unsigned char *buf, int unitsize, int units)
 {
-	GSList *l, *p, *d;
-	FILE *meta;
-	struct sr_dev_inst *sdi;
 	struct sr_probe *probe;
-	struct sr_datastore *ds;
-	struct zip *zipfile;
-	struct zip_source *versrc, *metasrc, *logicsrc;
-	int bufcnt, devcnt, tmpfile, ret, probecnt;
+	GSList *l;
+	GVariant *gvar;
 	uint64_t samplerate;
-	char version[1], rawname[16], metafile[32], *buf, *s;
+	int cnt, ret;
+	char **probe_names;
+
+	samplerate = 0;
+	if (sr_dev_has_option(sdi, SR_CONF_SAMPLERATE)) {
+		if (sr_config_get(sdi->driver, sdi, NULL,
+					SR_CONF_SAMPLERATE, &gvar) == SR_OK) {
+			samplerate = g_variant_get_uint64(gvar);
+			g_variant_unref(gvar);
+		}
+	}
+
+	probe_names = g_malloc0(sizeof(char *) * (g_slist_length(sdi->probes) + 1));
+	cnt = 0;
+	for (l = sdi->probes; l; l = l->next) {
+		probe = l->data;
+		if (probe->enabled) {
+			if (probe->name)
+				/* Just borrowing the ptr. */
+				probe_names[cnt++] = probe->name;
+		}
+	}
+
+	if ((ret = sr_session_save_init(filename, samplerate, probe_names)) != SR_OK)
+		return ret;
+
+	ret = sr_session_append(filename, buf, unitsize, units);
+
+	return ret;
+}
+
+/**
+ * Initialize a saved session file.
+ *
+ * @param filename The name of the filename to save the current session as.
+ *                 Must not be NULL.
+ * @param samplerate The samplerate to store for this session.
+ * @param probes A NULL-terminated array of strings containing the names
+ * of all the probes active in this session.
+ *
+ * @retval SR_OK Success
+ * @retval SR_ERR_ARG Invalid arguments
+ * @retval SR_ERR Other errors
+ */
+SR_API int sr_session_save_init(const char *filename, uint64_t samplerate,
+		char **probes)
+{
+	FILE *meta;
+	struct zip *zipfile;
+	struct zip_source *versrc, *metasrc;
+	int tmpfile, cnt, ret, i;
+	char version[1], metafile[32], *s;
 
 	if (!filename) {
-		sr_err("session file: %s: filename was NULL", __func__);
+		sr_err("%s: filename was NULL", __func__);
 		return SR_ERR_ARG;
 	}
 
@@ -201,7 +305,7 @@ 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;
 	}
@@ -214,66 +318,23 @@ int sr_session_save(const char *filename)
 	meta = g_fopen(metafile, "wb");
 	fprintf(meta, "[global]\n");
 	fprintf(meta, "sigrok version = %s\n", PACKAGE_VERSION);
-	/* TODO: save protocol decoders used */
-
-	/* all datastores in all devices */
-	devcnt = 1;
-	for (l = session->devs; l; l = l->next) {
-		dev = l->data;
-		/* metadata */
-		fprintf(meta, "[device %d]\n", devcnt);
-		if (dev->driver)
-			fprintf(meta, "driver = %s\n", dev->driver->name);
-
-		ds = dev->datastore;
-		if (ds) {
-			/* metadata */
-			fprintf(meta, "capturefile = logic-%d\n", devcnt);
-			fprintf(meta, "unitsize = %d\n", ds->ds_unitsize);
-			fprintf(meta, "total probes = %d\n", g_slist_length(dev->probes));
-			if (sr_dev_has_hwcap(dev, SR_HWCAP_SAMPLERATE)) {
-				samplerate = *((uint64_t *) dev->driver->dev_info_get(
-						dev->driver_index, SR_DI_CUR_SAMPLERATE));
-				s = sr_samplerate_string(samplerate);
-				fprintf(meta, "samplerate = %s\n", s);
-				g_free(s);
-			}
-			probecnt = 1;
-			for (p = dev->probes; p; p = p->next) {
-				probe = p->data;
-				if (probe->enabled) {
-					if (probe->name)
-						fprintf(meta, "probe%d = %s\n", probecnt, probe->name);
-					if (probe->trigger)
-						fprintf(meta, " trigger%d = %s\n", probecnt, probe->trigger);
-					probecnt++;
-				}
-			}
 
-			/* dump datastore into logic-n */
-			buf = g_try_malloc(ds->num_units * ds->ds_unitsize +
-				   DATASTORE_CHUNKSIZE);
-			if (!buf) {
-				sr_err("session file: %s: buf malloc failed",
-				       __func__);
-				return SR_ERR_MALLOC;
-			}
+	/* metadata */
+	fprintf(meta, "[device 1]\n");
+
+	/* metadata */
+	fprintf(meta, "capturefile = logic-1\n");
+	cnt = 0;
+	for (i = 0; probes[i]; i++)
+		cnt++;
+	fprintf(meta, "total probes = %d\n", cnt);
+	s = sr_samplerate_string(samplerate);
+	fprintf(meta, "samplerate = %s\n", s);
+	g_free(s);
+
+	for (i = 0; probes[i]; i++)
+		fprintf(meta, "probe%d = %s\n", i + 1, probes[i]);
 
-			bufcnt = 0;
-			for (d = ds->chunklist; d; d = d->next) {
-				memcpy(buf + bufcnt, d->data,
-				       DATASTORE_CHUNKSIZE);
-				bufcnt += DATASTORE_CHUNKSIZE;
-			}
-			if (!(logicsrc = zip_source_buffer(zipfile, buf,
-				       ds->num_units * ds->ds_unitsize, TRUE)))
-				return SR_ERR;
-			snprintf(rawname, 15, "logic-%d", devcnt);
-			if (zip_add(zipfile, rawname, logicsrc) == -1)
-				return SR_ERR;
-		}
-		devcnt++;
-	}
 	fclose(meta);
 
 	if (!(metasrc = zip_source_file(zipfile, metafile, 0, -1)))
@@ -282,8 +343,7 @@ 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;
 	}
 
@@ -291,3 +351,124 @@ int sr_session_save(const char *filename)
 
 	return SR_OK;
 }
+
+/**
+ * Append data to an existing session file.
+ *
+ * The session file must have been created with sr_session_save_init()
+ * or sr_session_save() beforehand.
+ *
+ * @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.
+ *
+ * @retval SR_OK Success
+ * @retval SR_ERR_ARG Invalid arguments
+ * @retval SR_ERR 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;
+	struct zip_file *zf;
+	struct zip_stat zs;
+	struct zip_source *metasrc;
+	GKeyFile *kf;
+	GError *error;
+	gsize len;
+	int chunk_num, next_chunk_num, tmpfile, ret, i;
+	const char *entry_name;
+	char *metafile, tmpname[32], chunkname[16];
+
+	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;
+
+	metafile = g_malloc(zs.size);
+	zf = zip_fopen_index(archive, zs.index, 0);
+	zip_fread(zf, metafile, zs.size);
+	zip_fclose(zf);
+
+	/*
+	 * If the file was only initialized but doesn't yet have any
+	 * data it in, it won't have a unitsize field in metadata yet.
+	 */
+	error = NULL;
+	kf = g_key_file_new();
+	if (!g_key_file_load_from_data(kf, metafile, zs.size, 0, &error)) {
+		sr_err("Failed to parse metadata: %s.", error->message);
+		return SR_ERR;
+	}
+	g_free(metafile);
+	if (!g_key_file_has_key(kf, "device 1", "unitsize", &error)) {
+		if (error && error->code != G_KEY_FILE_ERROR_KEY_NOT_FOUND) {
+			sr_err("Failed to check unitsize key: %s", error ? error->message : "?");
+			return SR_ERR;
+		}
+		/* Add unitsize field. */
+		g_key_file_set_integer(kf, "device 1", "unitsize", unitsize);
+		metafile = g_key_file_to_data(kf, &len, &error);
+		strcpy(tmpname, "sigrok-meta-XXXXXX");
+		if ((tmpfile = g_mkstemp(tmpname)) == -1)
+			return SR_ERR;
+		if (write(tmpfile, metafile, len) < 0) {
+			sr_dbg("Failed to create new metadata: %s", strerror(errno));
+			return SR_ERR;
+		}
+		close(tmpfile);
+		if (!(metasrc = zip_source_file(archive, tmpname, 0, -1))) {
+			g_free(metafile);
+			sr_err("Failed to create zip source for metadata.");
+			return SR_ERR;
+		}
+		if (zip_replace(archive, zs.index, metasrc) == -1) {
+			sr_err("Failed to replace metadata file.");
+			return SR_ERR;
+		}
+		g_free(metafile);
+	}
+	g_key_file_free(kf);
+
+	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;
+}
+
+/** @} */