[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 <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)

/**
 * @file
 *
 * Loading and saving libsigrok session files.
 */

/**
 * @addtogroup grp_session
 *
 * @{
 */

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, 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];

	if (!filename) {
		sr_err("%s: filename was NULL", __func__);
		return SR_ERR_ARG;
	}

	if (!(archive = zip_open(filename, 0, &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("Not a sigrok session file.");
		return SR_ERR;
	}
	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("Not a valid sigrok session file.");
		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);
					sdi->driver->config_set(SR_CONF_CAPTUREFILE,
							g_variant_new_string(val), sdi);
					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);
				} 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);
				} 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);
					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.
 *
 * @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,
		unsigned char *buf, int unitsize, int units)
{
	GSList *l;
	GVariant *gvar;
	FILE *meta;
	struct sr_probe *probe;
	struct zip *zipfile;
	struct zip_source *versrc, *metasrc, *logicsrc;
	int tmpfile, ret, probecnt;
	uint64_t samplerate;
	char version[1], rawname[16], 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");
	if (sdi->driver)
		fprintf(meta, "driver = %s\n", sdi->driver->name);

	/* metadata */
	fprintf(meta, "capturefile = logic-1\n");
	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) {
			samplerate = g_variant_get_uint64(gvar);
			s = sr_samplerate_string(samplerate);
			fprintf(meta, "samplerate = %s\n", s);
			g_free(s);
			g_variant_unref(gvar);
		}
	}
	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++;
		}
	}

	if (!(logicsrc = zip_source_buffer(zipfile, buf,
			   units * unitsize, FALSE)))
		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("error saving zipfile: %s", zip_strerror(zipfile));
		return SR_ERR;
	}

	unlink(metafile);

	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 <glib.h>
	25	#include <glib/gstdio.h>
	26	#include "config.h" /* Needed for PACKAGE_VERSION and others. */
	27	#include "libsigrok.h"
	28	#include "libsigrok-internal.h"
	29
	30	/* Message logging helpers with subsystem-specific prefix string. */
	31	#define LOG_PREFIX "session-file: "
	32	#define sr_log(l, s, args...) sr_log(l, LOG_PREFIX s, ## args)
	33	#define sr_spew(s, args...) sr_spew(LOG_PREFIX s, ## args)
	34	#define sr_dbg(s, args...) sr_dbg(LOG_PREFIX s, ## args)
	35	#define sr_info(s, args...) sr_info(LOG_PREFIX s, ## args)
	36	#define sr_warn(s, args...) sr_warn(LOG_PREFIX s, ## args)
	37	#define sr_err(s, args...) sr_err(LOG_PREFIX s, ## args)
	38
	39	/**
	40	* @file
	41	*
	42	* Loading and saving libsigrok session files.
	43	*/
	44
	45	/**
	46	* @addtogroup grp_session
	47	*
	48	* @{
	49	*/
	50
	51	extern struct sr_session *session;
	52	extern SR_PRIV struct sr_dev_driver session_driver;
	53
	54	/**
	55	* Load the session from the specified filename.
	56	*
	57	* @param filename The name of the session file to load. Must not be NULL.
	58	*
	59	* @return SR_OK upon success, SR_ERR_ARG upon invalid arguments,
	60	* SR_ERR_MALLOC upon memory allocation errors, or SR_ERR upon
	61	* other errors.
	62	*/
	63	SR_API int sr_session_load(const char *filename)
	64	{
	65	GKeyFile *kf;
	66	GPtrArray *capturefiles;
	67	struct zip *archive;
	68	struct zip_file *zf;
	69	struct zip_stat zs;
	70	struct sr_dev_inst *sdi;
	71	struct sr_probe *probe;
	72	int ret, probenum, devcnt, version, i, j;
	73	uint64_t tmp_u64, total_probes, enabled_probes, p;
	74	char sections, keys, metafile, val, s[11];
	75	char probename[SR_MAX_PROBENAME_LEN + 1];
	76
	77	if (!filename) {
	78	sr_err("%s: filename was NULL", __func__);
	79	return SR_ERR_ARG;
	80	}
	81
	82	if (!(archive = zip_open(filename, 0, &ret))) {
	83	sr_dbg("Failed to open session file: zip error %d", ret);
	84	return SR_ERR;
	85	}
	86
	87	/* check "version" */
	88	version = 0;
	89	if (!(zf = zip_fopen(archive, "version", 0))) {
	90	sr_dbg("Not a sigrok session file.");
	91	return SR_ERR;
	92	}
	93	if ((ret = zip_fread(zf, s, 10)) == -1) {
	94	sr_dbg("Not a valid sigrok session file.");
	95	return SR_ERR;
	96	}
	97	zip_fclose(zf);
	98	s[ret] = 0;
	99	version = strtoull(s, NULL, 10);
	100	if (version != 1) {
	101	sr_dbg("Not a valid sigrok session file version.");
	102	return SR_ERR;
	103	}
	104
	105	/* read "metadata" */
	106	if (zip_stat(archive, "metadata", 0, &zs) == -1) {
	107	sr_dbg("Not a valid sigrok session file.");
	108	return SR_ERR;
	109	}
	110
	111	if (!(metafile = g_try_malloc(zs.size))) {
	112	sr_err("%s: metafile malloc failed", __func__);
	113	return SR_ERR_MALLOC;
	114	}
	115
	116	zf = zip_fopen_index(archive, zs.index, 0);
	117	zip_fread(zf, metafile, zs.size);
	118	zip_fclose(zf);
	119
	120	kf = g_key_file_new();
	121	if (!g_key_file_load_from_data(kf, metafile, zs.size, 0, NULL)) {
	122	sr_dbg("Failed to parse metadata.");
	123	return SR_ERR;
	124	}
	125
	126	sr_session_new();
	127
	128	devcnt = 0;
	129	capturefiles = g_ptr_array_new_with_free_func(g_free);
	130	sections = g_key_file_get_groups(kf, NULL);
	131	for (i = 0; sections[i]; i++) {
	132	if (!strcmp(sections[i], "global"))
	133	/* nothing really interesting in here yet */
	134	continue;
	135	if (!strncmp(sections[i], "device ", 7)) {
	136	/* device section */
	137	sdi = NULL;
	138	enabled_probes = total_probes = 0;
	139	keys = g_key_file_get_keys(kf, sections[i], NULL, NULL);
	140	for (j = 0; keys[j]; j++) {
	141	val = g_key_file_get_string(kf, sections[i], keys[j], NULL);
	142	if (!strcmp(keys[j], "capturefile")) {
	143	sdi = sr_dev_inst_new(devcnt, SR_ST_ACTIVE, NULL, NULL, NULL);
	144	sdi->driver = &session_driver;
	145	if (devcnt == 0)
	146	/* first device, init the driver */
	147	sdi->driver->init(NULL);
	148	sr_dev_open(sdi);
	149	sr_session_dev_add(sdi);
	150	sdi->driver->config_set(SR_CONF_SESSIONFILE,
	151	g_variant_new_string(filename), sdi);
	152	sdi->driver->config_set(SR_CONF_CAPTUREFILE,
	153	g_variant_new_string(val), sdi);
	154	g_ptr_array_add(capturefiles, val);
	155	} else if (!strcmp(keys[j], "samplerate")) {
	156	sr_parse_sizestring(val, &tmp_u64);
	157	sdi->driver->config_set(SR_CONF_SAMPLERATE,
	158	g_variant_new_uint64(tmp_u64), sdi);
	159	} else if (!strcmp(keys[j], "unitsize")) {
	160	tmp_u64 = strtoull(val, NULL, 10);
	161	sdi->driver->config_set(SR_CONF_CAPTURE_UNITSIZE,
	162	g_variant_new_uint64(tmp_u64), sdi);
	163	} else if (!strcmp(keys[j], "total probes")) {
	164	total_probes = strtoull(val, NULL, 10);
	165	sdi->driver->config_set(SR_CONF_CAPTURE_NUM_PROBES,
	166	g_variant_new_uint64(total_probes), sdi);
	167	for (p = 0; p < total_probes; p++) {
	168	snprintf(probename, SR_MAX_PROBENAME_LEN, "%" PRIu64, p);
	169	if (!(probe = sr_probe_new(p, SR_PROBE_LOGIC, TRUE,
	170	probename)))
	171	return SR_ERR;
	172	sdi->probes = g_slist_append(sdi->probes, probe);
	173	}
	174	} else if (!strncmp(keys[j], "probe", 5)) {
	175	if (!sdi)
	176	continue;
	177	enabled_probes++;
	178	tmp_u64 = strtoul(keys[j]+5, NULL, 10);
	179	/* sr_session_save() */
	180	sr_dev_probe_name_set(sdi, tmp_u64 - 1, val);
	181	} else if (!strncmp(keys[j], "trigger", 7)) {
	182	probenum = strtoul(keys[j]+7, NULL, 10);
	183	sr_dev_trigger_set(sdi, probenum, val);
	184	}
	185	}
	186	g_strfreev(keys);
	187	/* Disable probes not specifically listed. */
	188	if (total_probes)
	189	for (p = enabled_probes; p < total_probes; p++)
	190	sr_dev_probe_enable(sdi, p, FALSE);
	191	}
	192	devcnt++;
	193	}
	194	g_strfreev(sections);
	195	g_key_file_free(kf);
	196
	197	return SR_OK;
	198	}
	199
	200	/**
	201	* Save the current session to the specified file.
	202	*
	203	* @param filename The name of the filename to save the current session as.
	204	* Must not be NULL.
	205	* @param sdi The device instance from which the data was captured.
	206	* @param buf The data to be saved.
	207	* @param unitsize The number of bytes per sample.
	208	* @param units The number of samples.
	209	*
	210	* @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or SR_ERR
	211	* upon other errors.
	212	*/
	213	SR_API int sr_session_save(const char filename, const struct sr_dev_inst sdi,
	214	unsigned char *buf, int unitsize, int units)
	215	{
	216	GSList *l;
	217	GVariant *gvar;
	218	FILE *meta;
	219	struct sr_probe *probe;
	220	struct zip *zipfile;
	221	struct zip_source versrc, metasrc, *logicsrc;
	222	int tmpfile, ret, probecnt;
	223	uint64_t samplerate;
	224	char version[1], rawname[16], metafile[32], *s;
	225
	226	if (!filename) {
	227	sr_err("%s: filename was NULL", __func__);
	228	return SR_ERR_ARG;
	229	}
	230
	231	/* Quietly delete it first, libzip wants replace ops otherwise. */
	232	unlink(filename);
	233	if (!(zipfile = zip_open(filename, ZIP_CREATE, &ret)))
	234	return SR_ERR;
	235
	236	/* "version" */
	237	version[0] = '1';
	238	if (!(versrc = zip_source_buffer(zipfile, version, 1, 0)))
	239	return SR_ERR;
	240	if (zip_add(zipfile, "version", versrc) == -1) {
	241	sr_info("error saving version into zipfile: %s",
	242	zip_strerror(zipfile));
	243	return SR_ERR;
	244	}
	245
	246	/* init "metadata" */
	247	strcpy(metafile, "sigrok-meta-XXXXXX");
	248	if ((tmpfile = g_mkstemp(metafile)) == -1)
	249	return SR_ERR;
	250	close(tmpfile);
	251	meta = g_fopen(metafile, "wb");
	252	fprintf(meta, "[global]\n");
	253	fprintf(meta, "sigrok version = %s\n", PACKAGE_VERSION);
	254
	255	/* metadata */
	256	fprintf(meta, "[device 1]\n");
	257	if (sdi->driver)
	258	fprintf(meta, "driver = %s\n", sdi->driver->name);
	259
	260	/* metadata */
	261	fprintf(meta, "capturefile = logic-1\n");
	262	fprintf(meta, "unitsize = %d\n", unitsize);
	263	fprintf(meta, "total probes = %d\n", g_slist_length(sdi->probes));
	264	if (sr_dev_has_option(sdi, SR_CONF_SAMPLERATE)) {
	265	if (sr_config_get(sdi->driver, SR_CONF_SAMPLERATE,
	266	&gvar, sdi) == SR_OK) {
	267	samplerate = g_variant_get_uint64(gvar);
	268	s = sr_samplerate_string(samplerate);
	269	fprintf(meta, "samplerate = %s\n", s);
	270	g_free(s);
	271	g_variant_unref(gvar);
	272	}
	273	}
	274	probecnt = 1;
	275	for (l = sdi->probes; l; l = l->next) {
	276	probe = l->data;
	277	if (probe->enabled) {
	278	if (probe->name)
	279	fprintf(meta, "probe%d = %s\n", probecnt, probe->name);
	280	if (probe->trigger)
	281	fprintf(meta, " trigger%d = %s\n", probecnt, probe->trigger);
	282	probecnt++;
	283	}
	284	}
	285
	286	if (!(logicsrc = zip_source_buffer(zipfile, buf,
	287	units * unitsize, FALSE)))
	288	return SR_ERR;
	289	snprintf(rawname, 15, "logic-1");
	290	if (zip_add(zipfile, rawname, logicsrc) == -1)
	291	return SR_ERR;
	292	fclose(meta);
	293
	294	if (!(metasrc = zip_source_file(zipfile, metafile, 0, -1)))
	295	return SR_ERR;
	296	if (zip_add(zipfile, "metadata", metasrc) == -1)
	297	return SR_ERR;
	298
	299	if ((ret = zip_close(zipfile)) == -1) {
	300	sr_info("error saving zipfile: %s", zip_strerror(zipfile));
	301	return SR_ERR;
	302	}
	303
	304	unlink(metafile);
	305
	306	return SR_OK;
	307	}
	308
	309	/** @} */