[libsigrok.git] / session_file.c

/*
 * This file is part of the libsigrok project.
 *
 * 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
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#include <string.h>
#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"

#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.
 *
 * @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;
	}

	zf = zip_fopen_index(archive, zs.index, 0);
	zip_fread(zf, metafile, zs.size);
	zip_fclose(zf);

	kf = g_key_file_new();
	if (!g_key_file_load_from_data(kf, metafile, zs.size, 0, NULL)) {
		sr_dbg("Failed to parse metadata.");
		return SR_ERR;
	}

	sr_session_new();

	devcnt = 0;
	capturefiles = g_ptr_array_new_with_free_func(g_free);
	sections = g_key_file_get_groups(kf, NULL);
	for (i = 0; sections[i]; i++) {
		if (!strcmp(sections[i], "global"))
			/* nothing really interesting in here yet */
			continue;
		if (!strncmp(sections[i], "device ", 7)) {
			/* device section */
			sdi = NULL;
			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);
				if (!strcmp(keys[j], "capturefile")) {
					sdi = sr_dev_inst_new(devcnt, SR_ST_ACTIVE, NULL, NULL, NULL);
					sdi->driver = &session_driver;
					if (devcnt == 0)
						/* first device, init the driver */
						sdi->driver->init(NULL);
					sr_dev_open(sdi);
					sr_session_dev_add(sdi);
					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->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->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->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,
								probename)))
							return SR_ERR;
						sdi->probes = g_slist_append(sdi->probes, probe);
					}
				} else if (!strncmp(keys[j], "probe", 5)) {
					if (!sdi)
						continue;
					enabled_probes++;
					tmp_u64 = strtoul(keys[j]+5, NULL, 10);
					/* sr_session_save() */
					sr_dev_probe_name_set(sdi, tmp_u64 - 1, val);
				} else if (!strncmp(keys[j], "trigger", 7)) {
					probenum = strtoul(keys[j]+7, NULL, 10);
					sr_dev_trigger_set(sdi, probenum, val);
				}
			}
			g_strfreev(keys);
			/* Disable probes not specifically listed. */
			if (total_probes)
				for (p = enabled_probes; p < total_probes; p++)
					sr_dev_probe_enable(sdi, p, FALSE);
		}
		devcnt++;
	}
	g_strfreev(sections);
	g_key_file_free(kf);

	return SR_OK;
}

/**
 * Save the current session to the specified file.
 *
 * @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.
 *
 * @retval SR_OK Success
 * @retval SR_ERR_ARG Invalid arguments
 * @retval SR_ERR Other errors
 */
SR_API int sr_session_save(const char *filename, const struct sr_dev_inst *sdi,
		unsigned char *buf, int unitsize, int units)
{
	struct sr_probe *probe;
	GSList *l;
	GVariant *gvar;
	uint64_t samplerate;
	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("%s: filename was NULL", __func__);
		return SR_ERR_ARG;
	}

	/* Quietly delete it first, libzip wants replace ops otherwise. */
	unlink(filename);
	if (!(zipfile = zip_open(filename, ZIP_CREATE, &ret)))
		return SR_ERR;

	/* "version" */
	version[0] = '1';
	if (!(versrc = zip_source_buffer(zipfile, version, 1, 0)))
		return SR_ERR;
	if (zip_add(zipfile, "version", versrc) == -1) {
		sr_info("error saving version into zipfile: %s",
			zip_strerror(zipfile));
		return SR_ERR;
	}

	/* init "metadata" */
	strcpy(metafile, "sigrok-meta-XXXXXX");
	if ((tmpfile = g_mkstemp(metafile)) == -1)
		return SR_ERR;
	close(tmpfile);
	meta = g_fopen(metafile, "wb");
	fprintf(meta, "[global]\n");
	fprintf(meta, "sigrok version = %s\n", PACKAGE_VERSION);

	/* 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]);

	fclose(meta);

	if (!(metasrc = zip_source_file(zipfile, metafile, 0, -1)))
		return SR_ERR;
	if (zip_add(zipfile, "metadata", metasrc) == -1)
		return SR_ERR;

	if ((ret = zip_close(zipfile)) == -1) {
		sr_info("error saving zipfile: %s", zip_strerror(zipfile));
		return SR_ERR;
	}

	unlink(metafile);

	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;
}

/** @} */
Commit	Line	Data
	1	/*
	2	* This file is part of the libsigrok project.
	3	*
	4	* Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
	5	*
	6	* This program is free software: you can redistribute it and/or modify
	7	* it under the terms of the GNU General Public License as published by
	8	* the Free Software Foundation, either version 3 of the License, or
	9	* (at your option) any later version.
	10	*
	11	* This program is distributed in the hope that it will be useful,
	12	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	* GNU General Public License for more details.
	15	*
	16	* You should have received a copy of the GNU General Public License
	17	* along with this program. If not, see <http://www.gnu.org/licenses/>.
	18	*/
	19
	20	#include <string.h>
	21	#include <stdlib.h>
	22	#include <unistd.h>
	23	#include <zip.h>
	24	#include <sys/types.h>
	25	#include <sys/stat.h>
	26	#include <errno.h>
	27	#include <glib.h>
	28	#include <glib/gstdio.h>
	29	#include "config.h" /* Needed for PACKAGE_VERSION and others. */
	30	#include "libsigrok.h"
	31	#include "libsigrok-internal.h"
	32
	33	#define LOG_PREFIX "session-file"
	34
	35	/**
	36	* @file
	37	*
	38	* Loading and saving libsigrok session files.
	39	*/
	40
	41	/**
	42	* @addtogroup grp_session
	43	*
	44	* @{
	45	*/
	46
	47	extern struct sr_session *session;
	48	extern SR_PRIV struct sr_dev_driver session_driver;
	49
	50	/** @private */
	51	SR_PRIV int sr_sessionfile_check(const char *filename)
	52	{
	53	struct stat st;
	54	struct zip *archive;
	55	struct zip_file *zf;
	56	struct zip_stat zs;
	57	int version, ret;
	58	char s[11];
	59
	60	if (!filename)
	61	return SR_ERR_ARG;
	62
	63	if (stat(filename, &st) == -1) {
	64	sr_err("Couldn't stat %s: %s", filename, strerror(errno));
	65	return SR_ERR;
	66	}
	67
	68	if (!(archive = zip_open(filename, 0, &ret)))
	69	/* No logging: this can be used just to check if it's
	70	* a sigrok session file or not. */
	71	return SR_ERR;
	72
	73	/* check "version" */
	74	version = 0;
	75	if (!(zf = zip_fopen(archive, "version", 0))) {
	76	sr_dbg("Not a sigrok session file: no version found.");
	77	return SR_ERR;
	78	}
	79	if ((ret = zip_fread(zf, s, 10)) == -1)
	80	return SR_ERR;
	81	zip_fclose(zf);
	82	s[ret] = 0;
	83	version = strtoull(s, NULL, 10);
	84	if (version != 1) {
	85	sr_dbg("Cannot handle sigrok session file version %d.", version);
	86	return SR_ERR;
	87	}
	88
	89	/* read "metadata" */
	90	if (zip_stat(archive, "metadata", 0, &zs) == -1) {
	91	sr_dbg("Not a valid sigrok session file.");
	92	return SR_ERR;
	93	}
	94
	95	return SR_OK;
	96	}
	97
	98	/**
	99	* Load the session from the specified filename.
	100	*
	101	* @param filename The name of the session file to load. Must not be NULL.
	102	*
	103	* @return SR_OK upon success, SR_ERR_ARG upon invalid arguments,
	104	* SR_ERR_MALLOC upon memory allocation errors, or SR_ERR upon
	105	* other errors.
	106	*/
	107	SR_API int sr_session_load(const char *filename)
	108	{
	109	GKeyFile *kf;
	110	GPtrArray *capturefiles;
	111	struct zip *archive;
	112	struct zip_file *zf;
	113	struct zip_stat zs;
	114	struct sr_dev_inst *sdi;
	115	struct sr_probe *probe;
	116	int ret, probenum, devcnt, i, j;
	117	uint64_t tmp_u64, total_probes, enabled_probes, p;
	118	char sections, keys, metafile, val;
	119	char probename[SR_MAX_PROBENAME_LEN + 1];
	120
	121	if ((ret = sr_sessionfile_check(filename)) != SR_OK)
	122	return ret;
	123
	124	if (!(archive = zip_open(filename, 0, &ret)))
	125	return SR_ERR;
	126
	127	if (zip_stat(archive, "metadata", 0, &zs) == -1)
	128	return SR_ERR;
	129
	130	if (!(metafile = g_try_malloc(zs.size))) {
	131	sr_err("%s: metafile malloc failed", __func__);
	132	return SR_ERR_MALLOC;
	133	}
	134
	135	zf = zip_fopen_index(archive, zs.index, 0);
	136	zip_fread(zf, metafile, zs.size);
	137	zip_fclose(zf);
	138
	139	kf = g_key_file_new();
	140	if (!g_key_file_load_from_data(kf, metafile, zs.size, 0, NULL)) {
	141	sr_dbg("Failed to parse metadata.");
	142	return SR_ERR;
	143	}
	144
	145	sr_session_new();
	146
	147	devcnt = 0;
	148	capturefiles = g_ptr_array_new_with_free_func(g_free);
	149	sections = g_key_file_get_groups(kf, NULL);
	150	for (i = 0; sections[i]; i++) {
	151	if (!strcmp(sections[i], "global"))
	152	/* nothing really interesting in here yet */
	153	continue;
	154	if (!strncmp(sections[i], "device ", 7)) {
	155	/* device section */
	156	sdi = NULL;
	157	enabled_probes = total_probes = 0;
	158	keys = g_key_file_get_keys(kf, sections[i], NULL, NULL);
	159	for (j = 0; keys[j]; j++) {
	160	val = g_key_file_get_string(kf, sections[i], keys[j], NULL);
	161	if (!strcmp(keys[j], "capturefile")) {
	162	sdi = sr_dev_inst_new(devcnt, SR_ST_ACTIVE, NULL, NULL, NULL);
	163	sdi->driver = &session_driver;
	164	if (devcnt == 0)
	165	/* first device, init the driver */
	166	sdi->driver->init(NULL);
	167	sr_dev_open(sdi);
	168	sr_session_dev_add(sdi);
	169	sdi->driver->config_set(SR_CONF_SESSIONFILE,
	170	g_variant_new_string(filename), sdi, NULL);
	171	sdi->driver->config_set(SR_CONF_CAPTUREFILE,
	172	g_variant_new_string(val), sdi, NULL);
	173	g_ptr_array_add(capturefiles, val);
	174	} else if (!strcmp(keys[j], "samplerate")) {
	175	sr_parse_sizestring(val, &tmp_u64);
	176	sdi->driver->config_set(SR_CONF_SAMPLERATE,
	177	g_variant_new_uint64(tmp_u64), sdi, NULL);
	178	} else if (!strcmp(keys[j], "unitsize")) {
	179	tmp_u64 = strtoull(val, NULL, 10);
	180	sdi->driver->config_set(SR_CONF_CAPTURE_UNITSIZE,
	181	g_variant_new_uint64(tmp_u64), sdi, NULL);
	182	} else if (!strcmp(keys[j], "total probes")) {
	183	total_probes = strtoull(val, NULL, 10);
	184	sdi->driver->config_set(SR_CONF_NUM_LOGIC_PROBES,
	185	g_variant_new_uint64(total_probes), sdi, NULL);
	186	for (p = 0; p < total_probes; p++) {
	187	snprintf(probename, SR_MAX_PROBENAME_LEN, "%" PRIu64, p);
	188	if (!(probe = sr_probe_new(p, SR_PROBE_LOGIC, TRUE,
	189	probename)))
	190	return SR_ERR;
	191	sdi->probes = g_slist_append(sdi->probes, probe);
	192	}
	193	} else if (!strncmp(keys[j], "probe", 5)) {
	194	if (!sdi)
	195	continue;
	196	enabled_probes++;
	197	tmp_u64 = strtoul(keys[j]+5, NULL, 10);
	198	/* sr_session_save() */
	199	sr_dev_probe_name_set(sdi, tmp_u64 - 1, val);
	200	} else if (!strncmp(keys[j], "trigger", 7)) {
	201	probenum = strtoul(keys[j]+7, NULL, 10);
	202	sr_dev_trigger_set(sdi, probenum, val);
	203	}
	204	}
	205	g_strfreev(keys);
	206	/* Disable probes not specifically listed. */
	207	if (total_probes)
	208	for (p = enabled_probes; p < total_probes; p++)
	209	sr_dev_probe_enable(sdi, p, FALSE);
	210	}
	211	devcnt++;
	212	}
	213	g_strfreev(sections);
	214	g_key_file_free(kf);
	215
	216	return SR_OK;
	217	}
	218
	219	/**
	220	* Save the current session to the specified file.
	221	*
	222	* @param filename The name of the filename to save the current session as.
	223	* Must not be NULL.
	224	* @param sdi The device instance from which the data was captured.
	225	* @param buf The data to be saved.
	226	* @param unitsize The number of bytes per sample.
	227	* @param units The number of samples.
	228	*
	229	* @retval SR_OK Success
	230	* @retval SR_ERR_ARG Invalid arguments
	231	* @retval SR_ERR Other errors
	232	*/
	233	SR_API int sr_session_save(const char filename, const struct sr_dev_inst sdi,
	234	unsigned char *buf, int unitsize, int units)
	235	{
	236	struct sr_probe *probe;
	237	GSList *l;
	238	GVariant *gvar;
	239	uint64_t samplerate;
	240	int cnt, ret;
	241	char **probe_names;
	242
	243	samplerate = 0;
	244	if (sr_dev_has_option(sdi, SR_CONF_SAMPLERATE)) {
	245	if (sr_config_get(sdi->driver, sdi, NULL,
	246	SR_CONF_SAMPLERATE, &gvar) == SR_OK) {
	247	samplerate = g_variant_get_uint64(gvar);
	248	g_variant_unref(gvar);
	249	}
	250	}
	251
	252	probe_names = g_malloc0(sizeof(char ) (g_slist_length(sdi->probes) + 1));
	253	cnt = 0;
	254	for (l = sdi->probes; l; l = l->next) {
	255	probe = l->data;
	256	if (probe->enabled) {
	257	if (probe->name)
	258	/* Just borrowing the ptr. */
	259	probe_names[cnt++] = probe->name;
	260	}
	261	}
	262
	263	if ((ret = sr_session_save_init(filename, samplerate, probe_names)) != SR_OK)
	264	return ret;
	265
	266	ret = sr_session_append(filename, buf, unitsize, units);
	267
	268	return ret;
	269	}
	270
	271	/**
	272	* Initialize a saved session file.
	273	*
	274	* @param filename The name of the filename to save the current session as.
	275	* Must not be NULL.
	276	* @param samplerate The samplerate to store for this session.
	277	* @param probes A NULL-terminated array of strings containing the names
	278	* of all the probes active in this session.
	279	*
	280	* @retval SR_OK Success
	281	* @retval SR_ERR_ARG Invalid arguments
	282	* @retval SR_ERR Other errors
	283	*/
	284	SR_API int sr_session_save_init(const char *filename, uint64_t samplerate,
	285	char **probes)
	286	{
	287	FILE *meta;
	288	struct zip *zipfile;
	289	struct zip_source versrc, metasrc;
	290	int tmpfile, cnt, ret, i;
	291	char version[1], metafile[32], *s;
	292
	293	if (!filename) {
	294	sr_err("%s: filename was NULL", __func__);
	295	return SR_ERR_ARG;
	296	}
	297
	298	/* Quietly delete it first, libzip wants replace ops otherwise. */
	299	unlink(filename);
	300	if (!(zipfile = zip_open(filename, ZIP_CREATE, &ret)))
	301	return SR_ERR;
	302
	303	/* "version" */
	304	version[0] = '1';
	305	if (!(versrc = zip_source_buffer(zipfile, version, 1, 0)))
	306	return SR_ERR;
	307	if (zip_add(zipfile, "version", versrc) == -1) {
	308	sr_info("error saving version into zipfile: %s",
	309	zip_strerror(zipfile));
	310	return SR_ERR;
	311	}
	312
	313	/* init "metadata" */
	314	strcpy(metafile, "sigrok-meta-XXXXXX");
	315	if ((tmpfile = g_mkstemp(metafile)) == -1)
	316	return SR_ERR;
	317	close(tmpfile);
	318	meta = g_fopen(metafile, "wb");
	319	fprintf(meta, "[global]\n");
	320	fprintf(meta, "sigrok version = %s\n", PACKAGE_VERSION);
	321
	322	/* metadata */
	323	fprintf(meta, "[device 1]\n");
	324
	325	/* metadata */
	326	fprintf(meta, "capturefile = logic-1\n");
	327	cnt = 0;
	328	for (i = 0; probes[i]; i++)
	329	cnt++;
	330	fprintf(meta, "total probes = %d\n", cnt);
	331	s = sr_samplerate_string(samplerate);
	332	fprintf(meta, "samplerate = %s\n", s);
	333	g_free(s);
	334
	335	for (i = 0; probes[i]; i++)
	336	fprintf(meta, "probe%d = %s\n", i + 1, probes[i]);
	337
	338	fclose(meta);
	339
	340	if (!(metasrc = zip_source_file(zipfile, metafile, 0, -1)))
	341	return SR_ERR;
	342	if (zip_add(zipfile, "metadata", metasrc) == -1)
	343	return SR_ERR;
	344
	345	if ((ret = zip_close(zipfile)) == -1) {
	346	sr_info("error saving zipfile: %s", zip_strerror(zipfile));
	347	return SR_ERR;
	348	}
	349
	350	unlink(metafile);
	351
	352	return SR_OK;
	353	}
	354
	355	/**
	356	* Append data to an existing session file.
	357	*
	358	* The session file must have been created with sr_session_save_init()
	359	* or sr_session_save() beforehand.
	360	*
	361	* @param filename The name of the filename to append to. Must not be NULL.
	362	* @param buf The data to be appended.
	363	* @param unitsize The number of bytes per sample.
	364	* @param units The number of samples.
	365	*
	366	* @retval SR_OK Success
	367	* @retval SR_ERR_ARG Invalid arguments
	368	* @retval SR_ERR Other errors
	369	*/
	370	SR_API int sr_session_append(const char filename, unsigned char buf,
	371	int unitsize, int units)
	372	{
	373	struct zip *archive;
	374	struct zip_source *logicsrc;
	375	zip_int64_t num_files;
	376	struct zip_file *zf;
	377	struct zip_stat zs;
	378	struct zip_source *metasrc;
	379	GKeyFile *kf;
	380	GError *error;
	381	gsize len;
	382	int chunk_num, next_chunk_num, tmpfile, ret, i;
	383	const char *entry_name;
	384	char *metafile, tmpname[32], chunkname[16];
	385
	386	if ((ret = sr_sessionfile_check(filename)) != SR_OK)
	387	return ret;
	388
	389	if (!(archive = zip_open(filename, 0, &ret)))
	390	return SR_ERR;
	391
	392	if (zip_stat(archive, "metadata", 0, &zs) == -1)
	393	return SR_ERR;
	394
	395	metafile = g_malloc(zs.size);
	396	zf = zip_fopen_index(archive, zs.index, 0);
	397	zip_fread(zf, metafile, zs.size);
	398	zip_fclose(zf);
	399
	400	/*
	401	* If the file was only initialized but doesn't yet have any
	402	* data it in, it won't have a unitsize field in metadata yet.
	403	*/
	404	error = NULL;
	405	kf = g_key_file_new();
	406	if (!g_key_file_load_from_data(kf, metafile, zs.size, 0, &error)) {
	407	sr_err("Failed to parse metadata: %s.", error->message);
	408	return SR_ERR;
	409	}
	410	g_free(metafile);
	411	if (!g_key_file_has_key(kf, "device 1", "unitsize", &error)) {
	412	if (error && error->code != G_KEY_FILE_ERROR_KEY_NOT_FOUND) {
	413	sr_err("Failed to check unitsize key: %s", error ? error->message : "?");
	414	return SR_ERR;
	415	}
	416	/* Add unitsize field. */
	417	g_key_file_set_integer(kf, "device 1", "unitsize", unitsize);
	418	metafile = g_key_file_to_data(kf, &len, &error);
	419	strcpy(tmpname, "sigrok-meta-XXXXXX");
	420	if ((tmpfile = g_mkstemp(tmpname)) == -1)
	421	return SR_ERR;
	422	if (write(tmpfile, metafile, len) < 0) {
	423	sr_dbg("Failed to create new metadata: %s", strerror(errno));
	424	return SR_ERR;
	425	}
	426	close(tmpfile);
	427	if (!(metasrc = zip_source_file(archive, tmpname, 0, -1))) {
	428	g_free(metafile);
	429	sr_err("Failed to create zip source for metadata.");
	430	return SR_ERR;
	431	}
	432	if (zip_replace(archive, zs.index, metasrc) == -1) {
	433	sr_err("Failed to replace metadata file.");
	434	return SR_ERR;
	435	}
	436	g_free(metafile);
	437	}
	438	g_key_file_free(kf);
	439
	440	next_chunk_num = 1;
	441	num_files = zip_get_num_entries(archive, 0);
	442	for (i = 0; i < num_files; i++) {
	443	entry_name = zip_get_name(archive, i, 0);
	444	if (strncmp(entry_name, "logic-1", 7))
	445	continue;
	446	if (strlen(entry_name) == 7) {
	447	/* This file has no extra chunks, just a single "logic-1".
	448	* Rename it to "logic-1-1" * and continue with chunk 2. */
	449	if (zip_rename(archive, i, "logic-1-1") == -1) {
	450	sr_err("Failed to rename 'logic-1' to 'logic-1-1'.");
	451	return SR_ERR;
	452	}
	453	next_chunk_num = 2;
	454	break;
	455	} else if (strlen(entry_name) > 8 && entry_name[7] == '-') {
	456	chunk_num = strtoull(entry_name + 8, NULL, 10);
	457	if (chunk_num >= next_chunk_num)
	458	next_chunk_num = chunk_num + 1;
	459	}
	460	}
	461	snprintf(chunkname, 15, "logic-1-%d", next_chunk_num);
	462	if (!(logicsrc = zip_source_buffer(archive, buf, units * unitsize, FALSE)))
	463	return SR_ERR;
	464	if (zip_add(archive, chunkname, logicsrc) == -1)
	465	return SR_ERR;
	466	if ((ret = zip_close(archive)) == -1) {
	467	sr_info("error saving session file: %s", zip_strerror(archive));
	468	return SR_ERR;
	469	}
	470
	471	return SR_OK;
	472	}
	473
	474	/** @} */