[libsigrok.git] / session_file.c

/*
 * This file is part of the sigrok project.
 *
 * Copyright (C) 2010-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
 * 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 <glib.h>
#include <glib/gstdio.h>
#include "config.h"
#include "libsigrok.h"
#include "libsigrok-internal.h"

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)
{
	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, c;
	char probename[SR_MAX_PROBENAME_LEN + 1];

	if (!filename) {
		sr_err("session file: %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);
		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.");
		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__);
		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("session file: 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 = 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();
					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);
					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);
				} else if (!strcmp(keys[j], "unitsize")) {
					tmp_u64 = strtoull(val, NULL, 10);
					sdi->driver->dev_config_set(sdi, SR_HWCAP_CAPTURE_UNITSIZE, &tmp_u64);
				} 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);
					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. */
			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 file where to save the current session.
 *                 Must not be NULL.
 * @param sdi The device instance from which the data was captured.
 * @param ds The datastore where the session's captured data was stored.
 *
 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or SR_ERR
 *         upon other errors.
 */
SR_API int sr_session_save(const char *filename,
		const struct sr_dev_inst *sdi, struct sr_datastore *ds)
{
	GSList *l, *d;
	FILE *meta;
	struct sr_probe *probe;
	struct zip *zipfile;
	struct zip_source *versrc, *metasrc, *logicsrc;
	int bufcnt, tmpfile, ret, probecnt;
	uint64_t *samplerate;
	char version[1], rawname[16], metafile[32], *buf, *s;

	if (!filename) {
		sr_err("session file: %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("session file: 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");
	if (sdi->driver)
		fprintf(meta, "driver = %s\n", sdi->driver->name);

	/* metadata */
	fprintf(meta, "capturefile = logic-1\n");
	fprintf(meta, "unitsize = %d\n", ds->ds_unitsize);
	fprintf(meta, "total probes = %d\n", g_slist_length(sdi->probes));
	if (sr_dev_has_hwcap(sdi, SR_HWCAP_SAMPLERATE)) {
		if (sr_info_get(sdi->driver, SR_DI_CUR_SAMPLERATE,
				(const void **)&samplerate, sdi) == SR_OK) {
			s = sr_samplerate_string(*samplerate);
			fprintf(meta, "samplerate = %s\n", s);
			g_free(s);
		}
	}
	probecnt = 1;
	for (l = sdi->probes; l; l = l->next) {
		probe = l->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;
	}

	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-1");
	if (zip_add(zipfile, rawname, logicsrc) == -1)
		return SR_ERR;
	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("session file: error saving zipfile: %s",
			zip_strerror(zipfile));
		return SR_ERR;
	}

	unlink(metafile);

	return SR_OK;
}
Commit	Line	Data
7d658874 BV	1	/*
	2	* This file is part of the sigrok project.
	3	*
c73d2ea4	4	* Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
7d658874 BV	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 <glib.h>
3bbd9849	25	#include <glib/gstdio.h>
1a081ca6	26	#include "config.h"
45c59c8b BV	27	#include "libsigrok.h"
45c59c8b BV	28	#include "libsigrok-internal.h"
7d658874	29
2872d21e	30	extern struct sr_session *session;
c09f0b57	31	extern SR_PRIV struct sr_dev_driver session_driver;
7d658874	32
9f45fb3a UH	33	/**
	34	* Load the session from the specified filename.
	35	*
	36	* @param filename The name of the session file to load. Must not be NULL.
	37	*
	38	* @return SR_OK upon success, SR_ERR_ARG upon invalid arguments,
	39	* SR_ERR_MALLOC upon memory allocation errors, or SR_ERR upon
	40	* other errors.
	41	*/
1a081ca6	42	SR_API int sr_session_load(const char *filename)
7d658874 BV	43	{
	44	GKeyFile *kf;
	45	GPtrArray *capturefiles;
	46	struct zip *archive;
	47	struct zip_file *zf;
	48	struct zip_stat zs;
4d684427	49	struct sr_dev_inst *sdi;
1afe8989	50	struct sr_probe *probe;
ebc34738	51	int ret, probenum, devcnt, i, j;
7d658874 BV	52	uint64_t tmp_u64, total_probes, enabled_probes, p;
7d658874 BV	53	char sections, keys, metafile, val, c;
c37d2b1b	54	char probename[SR_MAX_PROBENAME_LEN + 1];
7d658874	55
9f45fb3a UH	56	if (!filename) {
	57	sr_err("session file: %s: filename was NULL", __func__);
	58	return SR_ERR_ARG;
	59	}
	60
ebc34738	61	if (!(archive = zip_open(filename, 0, &ret))) {
7b48d6e1	62	sr_dbg("session file: Failed to open session file: zip "
ebc34738	63	"error %d", ret);
7d658874 BV	64	return SR_ERR;
	65	}
	66
	67	/* check "version" */
	68	if (!(zf = zip_fopen(archive, "version", 0))) {
7b48d6e1	69	sr_dbg("session file: Not a sigrok session file.");
7d658874 BV	70	return SR_ERR;
	71	}
	72	ret = zip_fread(zf, &c, 1);
	73	if (ret != 1 \|\| c != '1') {
7b48d6e1	74	sr_dbg("session file: Not a valid sigrok session file.");
7d658874 BV	75	return SR_ERR;
	76	}
	77	zip_fclose(zf);
	78
	79	/* read "metadata" */
	80	if (zip_stat(archive, "metadata", 0, &zs) == -1) {
7b48d6e1	81	sr_dbg("session file: Not a valid sigrok session file.");
7d658874 BV	82	return SR_ERR;
7d658874 BV	83	}
b53738ba UH	84
	85	if (!(metafile = g_try_malloc(zs.size))) {
	86	sr_err("session file: %s: metafile malloc failed", __func__);
	87	return SR_ERR_MALLOC;
	88	}
	89
7d658874 BV	90	zf = zip_fopen_index(archive, zs.index, 0);
	91	zip_fread(zf, metafile, zs.size);
	92	zip_fclose(zf);
	93
	94	kf = g_key_file_new();
	95	if (!g_key_file_load_from_data(kf, metafile, zs.size, 0, NULL)) {
7b48d6e1	96	sr_dbg("session file: Failed to parse metadata.");
7d658874 BV	97	return SR_ERR;
	98	}
	99
2285cf9b	100	sr_session_new();
7d658874 BV	101
	102	devcnt = 0;
	103	capturefiles = g_ptr_array_new_with_free_func(g_free);
	104	sections = g_key_file_get_groups(kf, NULL);
	105	for (i = 0; sections[i]; i++) {
	106	if (!strcmp(sections[i], "global"))
	107	/* nothing really interesting in here yet */
	108	continue;
	109	if (!strncmp(sections[i], "device ", 7)) {
	110	/* device section */
4d684427	111	sdi = NULL;
7d658874 BV	112	enabled_probes = 0;
	113	keys = g_key_file_get_keys(kf, sections[i], NULL, NULL);
	114	for (j = 0; keys[j]; j++) {
	115	val = g_key_file_get_string(kf, sections[i], keys[j], NULL);
	116	if (!strcmp(keys[j], "capturefile")) {
4d684427 BV	117	sdi = sr_dev_inst_new(devcnt, SR_ST_ACTIVE, NULL, NULL, NULL);
4d684427 BV	118	sdi->driver = &session_driver;
7d658874	119	if (devcnt == 0)
c09f0b57	120	/* first device, init the driver */
4d684427 BV	121	sdi->driver->init();
	122	sr_session_dev_add(sdi);
	123	sdi->driver->dev_config_set(sdi, SR_HWCAP_SESSIONFILE, filename);
	124	sdi->driver->dev_config_set(sdi, SR_HWCAP_CAPTUREFILE, val);
7d658874 BV	125	g_ptr_array_add(capturefiles, val);
7d658874 BV	126	} else if (!strcmp(keys[j], "samplerate")) {
f64c1414	127	sr_parse_sizestring(val, &tmp_u64);
4d684427	128	sdi->driver->dev_config_set(sdi, SR_HWCAP_SAMPLERATE, &tmp_u64);
7d658874 BV	129	} else if (!strcmp(keys[j], "unitsize")) {
7d658874 BV	130	tmp_u64 = strtoull(val, NULL, 10);
4d684427	131	sdi->driver->dev_config_set(sdi, SR_HWCAP_CAPTURE_UNITSIZE, &tmp_u64);
7d658874 BV	132	} else if (!strcmp(keys[j], "total probes")) {
7d658874 BV	133	total_probes = strtoull(val, NULL, 10);
4d684427	134	sdi->driver->dev_config_set(sdi, SR_HWCAP_CAPTURE_NUM_PROBES, &total_probes);
464d12c7 KS	135	for (p = 0; p < total_probes; p++) {
464d12c7 KS	136	snprintf(probename, SR_MAX_PROBENAME_LEN, "%" PRIu64, p);
fb381e4d	137	if (!(probe = sr_probe_new(p, SR_PROBE_LOGIC, TRUE,
4d684427 BV	138	probename)))
	139	return SR_ERR;
	140	sdi->probes = g_slist_append(sdi->probes, probe);
464d12c7	141	}
7d658874	142	} else if (!strncmp(keys[j], "probe", 5)) {
4d684427	143	if (!sdi)
7d658874 BV	144	continue;
	145	enabled_probes++;
	146	tmp_u64 = strtoul(keys[j]+5, NULL, 10);
fb381e4d BV	147	/* sr_session_save() */
fb381e4d BV	148	sr_dev_probe_name_set(sdi, tmp_u64 - 1, val);
7d658874 BV	149	} else if (!strncmp(keys[j], "trigger", 7)) {
7d658874 BV	150	probenum = strtoul(keys[j]+7, NULL, 10);
4d684427	151	sr_dev_trigger_set(sdi, probenum, val);
7d658874 BV	152	}
	153	}
	154	g_strfreev(keys);
fb381e4d	155	/* Disable probes not specifically listed. */
be5bf44d BV	156	for (p = enabled_probes; p < total_probes; p++)
be5bf44d BV	157	sr_dev_probe_enable(sdi, p, FALSE);
7d658874	158	}
4d684427	159	devcnt++;
7d658874 BV	160	}
	161	g_strfreev(sections);
	162	g_key_file_free(kf);
	163
	164	return SR_OK;
	165	}
	166
9f45fb3a UH	167	/**
	168	* Save the current session to the specified file.
	169	*
	170	* @param filename The name of the file where to save the current session.
	171	* Must not be NULL.
056be071 BV	172	* @param sdi The device instance from which the data was captured.
056be071 BV	173	* @param ds The datastore where the session's captured data was stored.
9f45fb3a UH	174	*
	175	* @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or SR_ERR
	176	* upon other errors.
	177	*/
056be071 BV	178	SR_API int sr_session_save(const char *filename,
056be071 BV	179	const struct sr_dev_inst sdi, struct sr_datastore ds)
7d658874	180	{
056be071	181	GSList l, d;
7d658874	182	FILE *meta;
1afe8989	183	struct sr_probe *probe;
7d658874 BV	184	struct zip *zipfile;
7d658874 BV	185	struct zip_source versrc, metasrc, *logicsrc;
056be071 BV	186	int bufcnt, tmpfile, ret, probecnt;
056be071 BV	187	uint64_t *samplerate;
4a1b18f8	188	char version[1], rawname[16], metafile[32], buf, s;
7d658874	189
9f45fb3a UH	190	if (!filename) {
	191	sr_err("session file: %s: filename was NULL", __func__);
	192	return SR_ERR_ARG;
	193	}
	194
7d658874	195	/* Quietly delete it first, libzip wants replace ops otherwise. */
4a1b18f8	196	unlink(filename);
ebc34738	197	if (!(zipfile = zip_open(filename, ZIP_CREATE, &ret)))
7d658874	198	return SR_ERR;
7d658874 BV	199
	200	/* "version" */
	201	version[0] = '1';
	202	if (!(versrc = zip_source_buffer(zipfile, version, 1, 0)))
	203	return SR_ERR;
	204	if (zip_add(zipfile, "version", versrc) == -1) {
7b48d6e1	205	sr_info("session file: error saving version into zipfile: %s",
b08024a8	206	zip_strerror(zipfile));
7d658874 BV	207	return SR_ERR;
	208	}
	209
	210	/* init "metadata" */
	211	strcpy(metafile, "sigrok-meta-XXXXXX");
	212	if ((tmpfile = g_mkstemp(metafile)) == -1)
	213	return SR_ERR;
	214	close(tmpfile);
868d8cef	215	meta = g_fopen(metafile, "wb");
7d658874 BV	216	fprintf(meta, "[global]\n");
7d658874 BV	217	fprintf(meta, "sigrok version = %s\n", PACKAGE_VERSION);
7d658874	218
056be071 BV	219	/* metadata */
	220	fprintf(meta, "[device 1]\n");
	221	if (sdi->driver)
	222	fprintf(meta, "driver = %s\n", sdi->driver->name);
7d658874	223
056be071 BV	224	/* metadata */
	225	fprintf(meta, "capturefile = logic-1\n");
	226	fprintf(meta, "unitsize = %d\n", ds->ds_unitsize);
	227	fprintf(meta, "total probes = %d\n", g_slist_length(sdi->probes));
	228	if (sr_dev_has_hwcap(sdi, SR_HWCAP_SAMPLERATE)) {
	229	if (sr_info_get(sdi->driver, SR_DI_CUR_SAMPLERATE,
	230	(const void **)&samplerate, sdi) == SR_OK) {
	231	s = sr_samplerate_string(*samplerate);
	232	fprintf(meta, "samplerate = %s\n", s);
	233	g_free(s);
	234	}
	235	}
	236	probecnt = 1;
	237	for (l = sdi->probes; l; l = l->next) {
	238	probe = l->data;
	239	if (probe->enabled) {
	240	if (probe->name)
	241	fprintf(meta, "probe%d = %s\n", probecnt, probe->name);
	242	if (probe->trigger)
	243	fprintf(meta, " trigger%d = %s\n", probecnt, probe->trigger);
	244	probecnt++;
	245	}
	246	}
7d658874	247
056be071 BV	248	/* dump datastore into logic-n */
	249	buf = g_try_malloc(ds->num_units * ds->ds_unitsize +
	250	DATASTORE_CHUNKSIZE);
	251	if (!buf) {
	252	sr_err("session file: %s: buf malloc failed",
	253	__func__);
	254	return SR_ERR_MALLOC;
	255	}
133a37bf	256
056be071 BV	257	bufcnt = 0;
	258	for (d = ds->chunklist; d; d = d->next) {
	259	memcpy(buf + bufcnt, d->data,
	260	DATASTORE_CHUNKSIZE);
	261	bufcnt += DATASTORE_CHUNKSIZE;
7d658874	262	}
056be071 BV	263	if (!(logicsrc = zip_source_buffer(zipfile, buf,
	264	ds->num_units * ds->ds_unitsize, TRUE)))
	265	return SR_ERR;
	266	snprintf(rawname, 15, "logic-1");
	267	if (zip_add(zipfile, rawname, logicsrc) == -1)
	268	return SR_ERR;
7d658874 BV	269	fclose(meta);
	270
	271	if (!(metasrc = zip_source_file(zipfile, metafile, 0, -1)))
	272	return SR_ERR;
	273	if (zip_add(zipfile, "metadata", metasrc) == -1)
	274	return SR_ERR;
	275
	276	if ((ret = zip_close(zipfile)) == -1) {
7b48d6e1 UH	277	sr_info("session file: error saving zipfile: %s",
7b48d6e1 UH	278	zip_strerror(zipfile));
7d658874 BV	279	return SR_ERR;
	280	}
	281
	282	unlink(metafile);
	283
	284	return SR_OK;
	285	}