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

#if !HAVE_ZIP_DISCARD
/* Replacement for zip_discard() if it isn't available.
 */
SR_PRIV void sr_zip_discard(struct zip *archive)
{
	if (zip_unchange_all(archive) < 0 || zip_close(archive) < 0)
		sr_err("Failed to discard ZIP archive: %s", zip_strerror(archive));
}
#endif

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