[libsigrok.git] / src / 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 <config.h>
#include <string.h>
#include <stdlib.h>
#include <zip.h>
#include <errno.h>
#include <glib.h>
#include <glib/gstdio.h>
#include <libsigrok/libsigrok.h>
#include "libsigrok-internal.h"

/** @cond PRIVATE */
#define LOG_PREFIX "session-file"
/** @endcond */

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

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

extern SR_PRIV struct sr_dev_driver session_driver;
static int session_driver_initialized = 0;

/** Read metadata entries from a session archive.
 * @param[in] archive An open ZIP archive.
 * @param[in] entry Stat buffer filled in for the metadata archive member.
 * @return A new key/value store containing the session metadata.
 */
SR_PRIV GKeyFile *sr_sessionfile_read_metadata(struct zip *archive,
			const struct zip_stat *entry)
{
	GKeyFile *keyfile;
	GError *error;
	struct zip_file *zf;
	char *metabuf;
	int metalen;

	if (entry->size > G_MAXINT || !(metabuf = g_try_malloc(entry->size))) {
		sr_err("Metadata buffer allocation failed.");
		return NULL;
	}
	zf = zip_fopen_index(archive, entry->index, 0);
	if (!zf) {
		sr_err("Failed to open metadata: %s", zip_strerror(archive));
		g_free(metabuf);
		return NULL;
	}
	metalen = zip_fread(zf, metabuf, entry->size);
	if (metalen < 0) {
		sr_err("Failed to read metadata: %s", zip_file_strerror(zf));
		zip_fclose(zf);
		g_free(metabuf);
		return NULL;
	}
	zip_fclose(zf);

	keyfile = g_key_file_new();
	error = NULL;
	g_key_file_load_from_data(keyfile, metabuf, metalen,
			G_KEY_FILE_NONE, &error);
	g_free(metabuf);

	if (error) {
		sr_err("Failed to parse metadata: %s", error->message);
		g_error_free(error);
		g_key_file_free(keyfile);
		return NULL;
	}
	return keyfile;
}

/** @private */
SR_PRIV int sr_sessionfile_check(const char *filename)
{
	struct zip *archive;
	struct zip_file *zf;
	struct zip_stat zs;
	uint64_t version;
	int ret;
	char s[11];

	if (!filename)
		return SR_ERR_ARG;

	if (!g_file_test(filename, G_FILE_TEST_IS_REGULAR)) {
		sr_err("Not a regular file: %s.", filename);
		return SR_ERR;
	}

	if (!(archive = zip_open(filename, 0, NULL)))
		/* No logging: this can be used just to check if it's
		 * a sigrok session file or not. */
		return SR_ERR;

	/* check "version" */
	if (!(zf = zip_fopen(archive, "version", 0))) {
		sr_dbg("Not a sigrok session file: no version found.");
		zip_discard(archive);
		return SR_ERR;
	}
	ret = zip_fread(zf, s, sizeof(s) - 1);
	if (ret < 0) {
		sr_err("Failed to read version file: %s",
			zip_file_strerror(zf));
		zip_fclose(zf);
		zip_discard(archive);
		return SR_ERR;
	}
	zip_fclose(zf);
	s[ret] = '\0';
	version = g_ascii_strtoull(s, NULL, 10);
	if (version == 0 || version > 2) {
		sr_dbg("Cannot handle sigrok session file version %" PRIu64 ".",
			version);
		zip_discard(archive);
		return SR_ERR;
	}
	sr_spew("Detected sigrok session file version %" PRIu64 ".", version);

	/* read "metadata" */
	if (zip_stat(archive, "metadata", 0, &zs) < 0) {
		sr_dbg("Not a valid sigrok session file.");
		zip_discard(archive);
		return SR_ERR;
	}
	zip_discard(archive);

	return SR_OK;
}

/**
 * Load the session from the specified filename.
 *
 * @param ctx The context in which to load the session.
 * @param filename The name of the session file to load.
 * @param session The session to load the file into.
 *
 * @retval SR_OK Success
 * @retval SR_ERR_MALLOC Memory allocation error
 * @retval SR_ERR_DATA Malformed session file
 * @retval SR_ERR This is not a session file
 */
SR_API int sr_session_load(struct sr_context *ctx, const char *filename,
		struct sr_session **session)
{
	GKeyFile *kf;
	GError *error;
	struct zip *archive;
	struct zip_stat zs;
	struct sr_dev_inst *sdi;
	struct sr_channel *ch;
	int ret, i, j;
	uint64_t tmp_u64;
	int total_channels, k;
	int unitsize;
	char **sections, **keys, *val;
	char channelname[SR_MAX_CHANNELNAME_LEN + 1];

	if ((ret = sr_sessionfile_check(filename)) != SR_OK)
		return ret;

	if (!(archive = zip_open(filename, 0, NULL)))
		return SR_ERR;

	if (zip_stat(archive, "metadata", 0, &zs) < 0) {
		zip_discard(archive);
		return SR_ERR;
	}
	kf = sr_sessionfile_read_metadata(archive, &zs);
	zip_discard(archive);
	if (!kf)
		return SR_ERR_DATA;

	if ((ret = sr_session_new(ctx, session)) != SR_OK) {
		g_key_file_free(kf);
		return ret;
	}

	error = NULL;
	ret = SR_OK;
	sections = g_key_file_get_groups(kf, NULL);
	for (i = 0; sections[i] && ret == SR_OK; i++) {
		if (!strcmp(sections[i], "global"))
			/* nothing really interesting in here yet */
			continue;
		if (!strncmp(sections[i], "device ", 7)) {
			/* device section */
			sdi = NULL;
			keys = g_key_file_get_keys(kf, sections[i], NULL, NULL);
			for (j = 0; keys[j]; j++) {
				if (!strcmp(keys[j], "capturefile")) {
					val = g_key_file_get_string(kf, sections[i],
							keys[j], &error);
					if (!val) {
						ret = SR_ERR_DATA;
						break;
					}
					sdi = g_malloc0(sizeof(struct sr_dev_inst));
					sdi->driver = &session_driver;
					sdi->status = SR_ST_ACTIVE;
					if (!session_driver_initialized) {
						/* first device, init the driver */
						session_driver_initialized = 1;
						sdi->driver->init(sdi->driver, NULL);
					}
					sr_dev_open(sdi);
					sr_session_dev_add(*session, sdi);
					(*session)->owned_devs = g_slist_append(
							(*session)->owned_devs, sdi);
					sr_config_set(sdi, NULL, SR_CONF_SESSIONFILE,
							g_variant_new_string(filename));
					sr_config_set(sdi, NULL, SR_CONF_CAPTUREFILE,
							g_variant_new_string(val));
					g_free(val);
				} else if (!strcmp(keys[j], "samplerate")) {
					val = g_key_file_get_string(kf, sections[i],
							keys[j], &error);
					if (!sdi || !val || sr_parse_sizestring(val,
								&tmp_u64) != SR_OK) {
						g_free(val);
						ret = SR_ERR_DATA;
						break;
					}
					g_free(val);
					sr_config_set(sdi, NULL, SR_CONF_SAMPLERATE,
							g_variant_new_uint64(tmp_u64));
				} else if (!strcmp(keys[j], "unitsize")) {
					unitsize = g_key_file_get_integer(kf, sections[i],
							keys[j], &error);
					if (!sdi || unitsize <= 0 || error) {
						ret = SR_ERR_DATA;
						break;
					}
					sr_config_set(sdi, NULL, SR_CONF_CAPTURE_UNITSIZE,
							g_variant_new_uint64(unitsize));
				} else if (!strcmp(keys[j], "total probes")) {
					total_channels = g_key_file_get_integer(kf,
							sections[i], keys[j], &error);
					if (!sdi || total_channels < 0 || error) {
						ret = SR_ERR_DATA;
						break;
					}
					sr_config_set(sdi, NULL, SR_CONF_NUM_LOGIC_CHANNELS,
							g_variant_new_uint64(total_channels));
					for (k = 0; k < total_channels; k++) {
						g_snprintf(channelname, sizeof channelname,
								"%d", k);
						sr_channel_new(sdi, k, SR_CHANNEL_LOGIC,
								FALSE, channelname);
					}
				} else if (!strncmp(keys[j], "probe", 5)) {
					tmp_u64 = g_ascii_strtoull(keys[j]+5, NULL, 10);
					if (!sdi || tmp_u64 == 0 || tmp_u64 > G_MAXINT) {
						ret = SR_ERR_DATA;
						break;
					}
					ch = g_slist_nth_data(sdi->channels, tmp_u64 - 1);
					if (!ch) {
						ret = SR_ERR_DATA;
						break;
					}
					val = g_key_file_get_string(kf, sections[i],
							keys[j], &error);
					if (!val) {
						ret = SR_ERR_DATA;
						break;
					}
					/* sr_session_save() */
					sr_dev_channel_name_set(ch, val);
					g_free(val);
					sr_dev_channel_enable(ch, TRUE);
				}
			}
			g_strfreev(keys);
		}
	}
	g_strfreev(sections);
	g_key_file_free(kf);

	if (error) {
		sr_err("Failed to parse metadata: %s", error->message);
		g_error_free(error);
	}
	return ret;
}

/** @} */
Commit	Line	Data
7d658874	1	/*
50985c20	2	* This file is part of the libsigrok project.
7d658874	3	*
13d8e03c	4	* Copyright (C) 2013 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
6ec6c43b	20	#include <config.h>
7d658874 BV	21	#include <string.h>
7d658874 BV	22	#include <stdlib.h>
7d658874	23	#include <zip.h>
5f9c4c8a	24	#include <errno.h>
7d658874	25	#include <glib.h>
3bbd9849	26	#include <glib/gstdio.h>
c1aae900	27	#include <libsigrok/libsigrok.h>
45c59c8b	28	#include "libsigrok-internal.h"
7d658874	29
2ad1deb8	30	/** @cond PRIVATE */
3544f848	31	#define LOG_PREFIX "session-file"
2ad1deb8	32	/** @endcond */
a885ce3e	33
393fb9cb UH	34	/**
	35	* @file
	36	*
	37	* Loading and saving libsigrok session files.
	38	*/
	39
7b870c38	40	/**
777e2035	41	* @addtogroup grp_session
7b870c38 UH	42	*
	43	* @{
	44	*/
	45
c09f0b57	46	extern SR_PRIV struct sr_dev_driver session_driver;
c6805a02 SA	47	static int session_driver_initialized = 0;
c6805a02 SA	48
5e1fb334 DE	49	/** Read metadata entries from a session archive.
	50	* @param[in] archive An open ZIP archive.
	51	* @param[in] entry Stat buffer filled in for the metadata archive member.
	52	* @return A new key/value store containing the session metadata.
	53	*/
	54	SR_PRIV GKeyFile sr_sessionfile_read_metadata(struct zip archive,
	55	const struct zip_stat *entry)
	56	{
	57	GKeyFile *keyfile;
	58	GError *error;
	59	struct zip_file *zf;
	60	char *metabuf;
	61	int metalen;
	62
	63	if (entry->size > G_MAXINT \|\| !(metabuf = g_try_malloc(entry->size))) {
	64	sr_err("Metadata buffer allocation failed.");
	65	return NULL;
	66	}
	67	zf = zip_fopen_index(archive, entry->index, 0);
	68	if (!zf) {
	69	sr_err("Failed to open metadata: %s", zip_strerror(archive));
	70	g_free(metabuf);
	71	return NULL;
	72	}
	73	metalen = zip_fread(zf, metabuf, entry->size);
	74	if (metalen < 0) {
	75	sr_err("Failed to read metadata: %s", zip_file_strerror(zf));
	76	zip_fclose(zf);
	77	g_free(metabuf);
	78	return NULL;
	79	}
	80	zip_fclose(zf);
	81
	82	keyfile = g_key_file_new();
	83	error = NULL;
	84	g_key_file_load_from_data(keyfile, metabuf, metalen,
	85	G_KEY_FILE_NONE, &error);
	86	g_free(metabuf);
	87
	88	if (error) {
	89	sr_err("Failed to parse metadata: %s", error->message);
	90	g_error_free(error);
	91	g_key_file_free(keyfile);
	92	return NULL;
	93	}
	94	return keyfile;
	95	}
	96
72a08bcc	97	/** @private */
f438e0c9	98	SR_PRIV int sr_sessionfile_check(const char *filename)
7d658874	99	{
7d658874 BV	100	struct zip *archive;
	101	struct zip_file *zf;
	102	struct zip_stat zs;
5e1fb334 DE	103	uint64_t version;
5e1fb334 DE	104	int ret;
f438e0c9	105	char s[11];
7d658874	106
f438e0c9	107	if (!filename)
9f45fb3a	108	return SR_ERR_ARG;
9f45fb3a	109
5e1fb334 DE	110	if (!g_file_test(filename, G_FILE_TEST_IS_REGULAR)) {
5e1fb334 DE	111	sr_err("Not a regular file: %s.", filename);
5f9c4c8a BV	112	return SR_ERR;
	113	}
	114
5e1fb334	115	if (!(archive = zip_open(filename, 0, NULL)))
f438e0c9 BV	116	/* No logging: this can be used just to check if it's
f438e0c9 BV	117	* a sigrok session file or not. */
7d658874	118	return SR_ERR;
7d658874 BV	119
	120	/* check "version" */
	121	if (!(zf = zip_fopen(archive, "version", 0))) {
f438e0c9	122	sr_dbg("Not a sigrok session file: no version found.");
5e1fb334	123	zip_discard(archive);
7d658874 BV	124	return SR_ERR;
7d658874 BV	125	}
5e1fb334 DE	126	ret = zip_fread(zf, s, sizeof(s) - 1);
	127	if (ret < 0) {
	128	sr_err("Failed to read version file: %s",
	129	zip_file_strerror(zf));
	130	zip_fclose(zf);
	131	zip_discard(archive);
7d658874	132	return SR_ERR;
5e1fb334	133	}
7d658874	134	zip_fclose(zf);
5e1fb334 DE	135	s[ret] = '\0';
	136	version = g_ascii_strtoull(s, NULL, 10);
	137	if (version == 0 \|\| version > 2) {
	138	sr_dbg("Cannot handle sigrok session file version %" PRIu64 ".",
	139	version);
	140	zip_discard(archive);
c1864d55 BV	141	return SR_ERR;
c1864d55 BV	142	}
5e1fb334	143	sr_spew("Detected sigrok session file version %" PRIu64 ".", version);
7d658874 BV	144
7d658874 BV	145	/* read "metadata" */
5e1fb334	146	if (zip_stat(archive, "metadata", 0, &zs) < 0) {
a885ce3e	147	sr_dbg("Not a valid sigrok session file.");
5e1fb334	148	zip_discard(archive);
7d658874 BV	149	return SR_ERR;
7d658874 BV	150	}
5e1fb334	151	zip_discard(archive);
aba57f35	152
f438e0c9 BV	153	return SR_OK;
	154	}
	155
	156	/**
	157	* Load the session from the specified filename.
	158	*
61e6e2da	159	* @param ctx The context in which to load the session.
d386a52f BV	160	* @param filename The name of the session file to load.
d386a52f BV	161	* @param session The session to load the file into.
f438e0c9	162	*
d386a52f BV	163	* @retval SR_OK Success
	164	* @retval SR_ERR_MALLOC Memory allocation error
	165	* @retval SR_ERR_DATA Malformed session file
	166	* @retval SR_ERR This is not a session file
f438e0c9	167	*/
61e6e2da ML	168	SR_API int sr_session_load(struct sr_context ctx, const char filename,
61e6e2da ML	169	struct sr_session **session)
f438e0c9 BV	170	{
f438e0c9 BV	171	GKeyFile *kf;
5e1fb334	172	GError *error;
f438e0c9	173	struct zip *archive;
f438e0c9 BV	174	struct zip_stat zs;
f438e0c9 BV	175	struct sr_dev_inst *sdi;
6f1346fb	176	struct sr_channel *ch;
c6805a02	177	int ret, i, j;
5e1fb334 DE	178	uint64_t tmp_u64;
	179	int total_channels, k;
	180	int unitsize;
	181	char sections, keys, *val;
3f239f08	182	char channelname[SR_MAX_CHANNELNAME_LEN + 1];
f438e0c9 BV	183
	184	if ((ret = sr_sessionfile_check(filename)) != SR_OK)
	185	return ret;
	186
5e1fb334	187	if (!(archive = zip_open(filename, 0, NULL)))
f438e0c9 BV	188	return SR_ERR;
f438e0c9 BV	189
5e1fb334 DE	190	if (zip_stat(archive, "metadata", 0, &zs) < 0) {
5e1fb334 DE	191	zip_discard(archive);
f438e0c9	192	return SR_ERR;
b53738ba	193	}
5e1fb334 DE	194	kf = sr_sessionfile_read_metadata(archive, &zs);
	195	zip_discard(archive);
	196	if (!kf)
	197	return SR_ERR_DATA;
b53738ba	198
5e1fb334 DE	199	if ((ret = sr_session_new(ctx, session)) != SR_OK) {
5e1fb334 DE	200	g_key_file_free(kf);
0812c40e	201	return ret;
5e1fb334	202	}
7d658874	203
5e1fb334	204	error = NULL;
d386a52f	205	ret = SR_OK;
7d658874	206	sections = g_key_file_get_groups(kf, NULL);
d386a52f	207	for (i = 0; sections[i] && ret == SR_OK; i++) {
7d658874 BV	208	if (!strcmp(sections[i], "global"))
	209	/* nothing really interesting in here yet */
	210	continue;
	211	if (!strncmp(sections[i], "device ", 7)) {
	212	/* device section */
4d684427	213	sdi = NULL;
7d658874 BV	214	keys = g_key_file_get_keys(kf, sections[i], NULL, NULL);
7d658874 BV	215	for (j = 0; keys[j]; j++) {
7d658874	216	if (!strcmp(keys[j], "capturefile")) {
5e1fb334 DE	217	val = g_key_file_get_string(kf, sections[i],
	218	keys[j], &error);
	219	if (!val) {
	220	ret = SR_ERR_DATA;
	221	break;
	222	}
aac29cc1	223	sdi = g_malloc0(sizeof(struct sr_dev_inst));
4d684427	224	sdi->driver = &session_driver;
0af636be	225	sdi->status = SR_ST_ACTIVE;
c6805a02	226	if (!session_driver_initialized) {
c09f0b57	227	/* first device, init the driver */
c6805a02	228	session_driver_initialized = 1;
4f840ce9	229	sdi->driver->init(sdi->driver, NULL);
c6805a02	230	}
bd7bfe8c	231	sr_dev_open(sdi);
0812c40e	232	sr_session_dev_add(*session, sdi);
1de3cced ML	233	(*session)->owned_devs = g_slist_append(
1de3cced ML	234	(*session)->owned_devs, sdi);
5e1fb334 DE	235	sr_config_set(sdi, NULL, SR_CONF_SESSIONFILE,
	236	g_variant_new_string(filename));
	237	sr_config_set(sdi, NULL, SR_CONF_CAPTUREFILE,
	238	g_variant_new_string(val));
	239	g_free(val);
7d658874	240	} else if (!strcmp(keys[j], "samplerate")) {
5e1fb334 DE	241	val = g_key_file_get_string(kf, sections[i],
	242	keys[j], &error);
	243	if (!sdi \|\| !val \|\| sr_parse_sizestring(val,
	244	&tmp_u64) != SR_OK) {
	245	g_free(val);
d386a52f BV	246	ret = SR_ERR_DATA;
	247	break;
	248	}
5e1fb334 DE	249	g_free(val);
	250	sr_config_set(sdi, NULL, SR_CONF_SAMPLERATE,
	251	g_variant_new_uint64(tmp_u64));
7d658874	252	} else if (!strcmp(keys[j], "unitsize")) {
5e1fb334 DE	253	unitsize = g_key_file_get_integer(kf, sections[i],
	254	keys[j], &error);
	255	if (!sdi \|\| unitsize <= 0 \|\| error) {
d386a52f BV	256	ret = SR_ERR_DATA;
	257	break;
	258	}
5e1fb334 DE	259	sr_config_set(sdi, NULL, SR_CONF_CAPTURE_UNITSIZE,
5e1fb334 DE	260	g_variant_new_uint64(unitsize));
7d658874	261	} else if (!strcmp(keys[j], "total probes")) {
5e1fb334 DE	262	total_channels = g_key_file_get_integer(kf,
	263	sections[i], keys[j], &error);
	264	if (!sdi \|\| total_channels < 0 \|\| error) {
d386a52f BV	265	ret = SR_ERR_DATA;
	266	break;
	267	}
5e1fb334 DE	268	sr_config_set(sdi, NULL, SR_CONF_NUM_LOGIC_CHANNELS,
	269	g_variant_new_uint64(total_channels));
	270	for (k = 0; k < total_channels; k++) {
	271	g_snprintf(channelname, sizeof channelname,
	272	"%d", k);
	273	sr_channel_new(sdi, k, SR_CHANNEL_LOGIC,
	274	FALSE, channelname);
464d12c7	275	}
7d658874	276	} else if (!strncmp(keys[j], "probe", 5)) {
5e1fb334 DE	277	tmp_u64 = g_ascii_strtoull(keys[j]+5, NULL, 10);
	278	if (!sdi \|\| tmp_u64 == 0 \|\| tmp_u64 > G_MAXINT) {
	279	ret = SR_ERR_DATA;
	280	break;
	281	}
	282	ch = g_slist_nth_data(sdi->channels, tmp_u64 - 1);
	283	if (!ch) {
	284	ret = SR_ERR_DATA;
	285	break;
	286	}
	287	val = g_key_file_get_string(kf, sections[i],
	288	keys[j], &error);
	289	if (!val) {
d386a52f BV	290	ret = SR_ERR_DATA;
	291	break;
	292	}
fb381e4d	293	/* sr_session_save() */
6f1346fb	294	sr_dev_channel_name_set(ch, val);
5e1fb334	295	g_free(val);
6f1346fb	296	sr_dev_channel_enable(ch, TRUE);
7d658874 BV	297	}
	298	}
	299	g_strfreev(keys);
7d658874 BV	300	}
	301	}
	302	g_strfreev(sections);
	303	g_key_file_free(kf);
	304
5e1fb334 DE	305	if (error) {
	306	sr_err("Failed to parse metadata: %s", error->message);
	307	g_error_free(error);
a769b9f3	308	}
a769b9f3 BV	309	return ret;
	310	}
	311
7b870c38	312	/** @} */