[libsigrok.git] / session_driver.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 <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <unistd.h>
#include <sys/time.h>
#include <zip.h>
#include "libsigrok.h"
#include "libsigrok-internal.h"

/* Message logging helpers with subsystem-specific prefix string. */
#define LOG_PREFIX "virtual-session: "
#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)

/* size of payloads sent across the session bus */
/** @cond PRIVATE */
#define CHUNKSIZE (512 * 1024)
/** @endcond */

struct session_vdev {
	char *sessionfile;
	char *capturefile;
	struct zip *archive;
	struct zip_file *capfile;
	int bytes_read;
	uint64_t samplerate;
	int unitsize;
	int num_probes;
	int cur_chunk;
};

static GSList *dev_insts = NULL;
static const int hwcaps[] = {
	SR_CONF_CAPTUREFILE,
	SR_CONF_CAPTURE_UNITSIZE,
	0,
};

static int receive_data(int fd, int revents, void *cb_data)
{
	struct sr_dev_inst *sdi;
	struct session_vdev *vdev;
	struct sr_datafeed_packet packet;
	struct sr_datafeed_logic logic;
	struct zip_stat zs;
	GSList *l;
	int ret, got_data;
	char capturefile[16];
	void *buf;

	(void)fd;
	(void)revents;

	got_data = FALSE;
	for (l = dev_insts; l; l = l->next) {
		sdi = l->data;
		if (!(vdev = sdi->priv))
			/* Already done with this instance. */
			continue;

		if (!(buf = g_try_malloc(CHUNKSIZE))) {
			sr_err("%s: buf malloc failed", __func__);
			return FALSE;
		}

		if (!vdev->capfile) {
			/* No capture file opened yet, or finished with the last
			 * chunked one. */
			if (vdev->cur_chunk == 0) {
				/* capturefile is always the unchunked base name. */
				if (zip_stat(vdev->archive, vdev->capturefile, 0, &zs) != -1) {
					/* No chunks, just a single capture file. */
					vdev->cur_chunk = 0;
					if (!(vdev->capfile = zip_fopen(vdev->archive,
							vdev->capturefile, 0)))
						return FALSE;
						sr_dbg("Opened %s.", vdev->capturefile);
				} else {
					/* Try as first chunk filename. */
					snprintf(capturefile, 15, "%s-1", vdev->capturefile);
					if (zip_stat(vdev->archive, capturefile, 0, &zs) != -1) {
						vdev->cur_chunk = 1;
						if (!(vdev->capfile = zip_fopen(vdev->archive,
								capturefile, 0)))
							return FALSE;
						sr_dbg("Opened %s.", capturefile);
					} else {
						sr_err("No capture file '%s' in " "session file '%s'.",
								vdev->capturefile, vdev->sessionfile);
						return FALSE;
					}
				}
			} else {
				/* Capture data is chunked, advance to the next chunk. */
				vdev->cur_chunk++;
				snprintf(capturefile, 15, "%s-%d", vdev->capturefile,
						vdev->cur_chunk);
				if (zip_stat(vdev->archive, capturefile, 0, &zs) != -1) {
					if (!(vdev->capfile = zip_fopen(vdev->archive,
							capturefile, 0)))
						return FALSE;
					sr_dbg("Opened %s.", capturefile);
				} else {
					/* We got all the chunks, finish up. */
					g_free(vdev->capturefile);
					g_free(vdev);
					sdi->priv = NULL;
					continue;
				}
			}
		}

		ret = zip_fread(vdev->capfile, buf, CHUNKSIZE);
		if (ret > 0) {
			got_data = TRUE;
			packet.type = SR_DF_LOGIC;
			packet.payload = &logic;
			logic.length = ret;
			logic.unitsize = vdev->unitsize;
			logic.data = buf;
			vdev->bytes_read += ret;
			sr_session_send(cb_data, &packet);
		} else {
			/* done with this capture file */
			zip_fclose(vdev->capfile);
			vdev->capfile = NULL;
			if (vdev->cur_chunk == 0) {
				/* It was the only file. */
				g_free(vdev->capturefile);
				g_free(vdev);
				sdi->priv = NULL;
			} else {
				/* There might be more chunks, so don't fall through
				 * to the SR_DF_END here. */
				return TRUE;
			}
		}
	}

	if (!got_data) {
		packet.type = SR_DF_END;
		sr_session_send(cb_data, &packet);
		sr_session_source_remove(-1);
	}

	return TRUE;
}

/* driver callbacks */

static int init(struct sr_context *sr_ctx)
{
	(void)sr_ctx;

	return SR_OK;
}

static int cleanup(void)
{
	GSList *l;

	for (l = dev_insts; l; l = l->next)
		sr_dev_inst_free(l->data);
	g_slist_free(dev_insts);
	dev_insts = NULL;

	return SR_OK;
}

static int dev_open(struct sr_dev_inst *sdi)
{
	if (!(sdi->priv = g_try_malloc0(sizeof(struct session_vdev)))) {
		sr_err("Device context malloc failed.");
		return SR_ERR_MALLOC;
	}

	dev_insts = g_slist_append(dev_insts, sdi);

	return SR_OK;
}

static int config_get(int id, GVariant **data, const struct sr_dev_inst *sdi,
		const struct sr_probe_group *probe_group)
{
	struct session_vdev *vdev;

	(void)probe_group;

	switch (id) {
	case SR_CONF_SAMPLERATE:
		if (sdi) {
			vdev = sdi->priv;
			*data = g_variant_new_uint64(vdev->samplerate);
		} else
			return SR_ERR;
		break;
	default:
		return SR_ERR_NA;
	}

	return SR_OK;
}

static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi,
		const struct sr_probe_group *probe_group)
{
	struct session_vdev *vdev;

	(void)probe_group;

	vdev = sdi->priv;

	switch (id) {
	case SR_CONF_SAMPLERATE:
		vdev->samplerate = g_variant_get_uint64(data);
		sr_info("Setting samplerate to %" PRIu64 ".", vdev->samplerate);
		break;
	case SR_CONF_SESSIONFILE:
		vdev->sessionfile = g_strdup(g_variant_get_string(data, NULL));
		sr_info("Setting sessionfile to '%s'.", vdev->sessionfile);
		break;
	case SR_CONF_CAPTUREFILE:
		vdev->capturefile = g_strdup(g_variant_get_string(data, NULL));
		sr_info("Setting capturefile to '%s'.", vdev->capturefile);
		break;
	case SR_CONF_CAPTURE_UNITSIZE:
		vdev->unitsize = g_variant_get_uint64(data);
		break;
	case SR_CONF_CAPTURE_NUM_PROBES:
		vdev->num_probes = g_variant_get_uint64(data);
		break;
	default:
		return SR_ERR_NA;
	}

	return SR_OK;
}

static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi,
		const struct sr_probe_group *probe_group)
{
	(void)sdi;
	(void)probe_group;

	switch (key) {
	case SR_CONF_DEVICE_OPTIONS:
		*data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
				hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
		break;
	default:
		return SR_ERR_NA;
	}

	return SR_OK;
}

static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
{
	struct session_vdev *vdev;
	int ret;

	vdev = sdi->priv;

	sr_info("Opening archive %s file %s", vdev->sessionfile,
		vdev->capturefile);

	if (!(vdev->archive = zip_open(vdev->sessionfile, 0, &ret))) {
		sr_err("Failed to open session file '%s': "
		       "zip error %d\n", vdev->sessionfile, ret);
		return SR_ERR;
	}

	/* Send header packet to the session bus. */
	std_session_send_df_header(cb_data, LOG_PREFIX);

	/* freewheeling source */
	sr_session_source_add(-1, 0, 0, receive_data, cb_data);

	return SR_OK;
}

/** @private */
SR_PRIV struct sr_dev_driver session_driver = {
	.name = "virtual-session",
	.longname = "Session-emulating driver",
	.api_version = 1,
	.init = init,
	.cleanup = cleanup,
	.scan = NULL,
	.dev_list = NULL,
	.dev_clear = NULL,
	.config_get = config_get,
	.config_set = config_set,
	.config_list = config_list,
	.dev_open = dev_open,
	.dev_close = NULL,
	.dev_acquisition_start = dev_acquisition_start,
	.dev_acquisition_stop = NULL,
	.priv = NULL,
};
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
	20	#include <sys/types.h>
	21	#include <sys/stat.h>
	22	#include <fcntl.h>
	23	#include <unistd.h>
	24	#include <sys/time.h>
	25	#include <zip.h>
45c59c8b BV	26	#include "libsigrok.h"
45c59c8b BV	27	#include "libsigrok-internal.h"
7d658874	28
29a27196 UH	29	/* Message logging helpers with subsystem-specific prefix string. */
	30	#define LOG_PREFIX "virtual-session: "
	31	#define sr_log(l, s, args...) sr_log(l, LOG_PREFIX s, ## args)
	32	#define sr_spew(s, args...) sr_spew(LOG_PREFIX s, ## args)
	33	#define sr_dbg(s, args...) sr_dbg(LOG_PREFIX s, ## args)
	34	#define sr_info(s, args...) sr_info(LOG_PREFIX s, ## args)
	35	#define sr_warn(s, args...) sr_warn(LOG_PREFIX s, ## args)
	36	#define sr_err(s, args...) sr_err(LOG_PREFIX s, ## args)
a885ce3e	37
7d658874	38	/* size of payloads sent across the session bus */
b4bd7088	39	/** @cond PRIVATE */
8ff6afc9	40	#define CHUNKSIZE (512 * 1024)
b4bd7088	41	/** @endcond */
7d658874	42
bb7ef793	43	struct session_vdev {
40dda2c3	44	char *sessionfile;
7d658874 BV	45	char *capturefile;
	46	struct zip *archive;
	47	struct zip_file *capfile;
cb1e389c	48	int bytes_read;
7d658874 BV	49	uint64_t samplerate;
	50	int unitsize;
	51	int num_probes;
f438e0c9	52	int cur_chunk;
7d658874 BV	53	};
7d658874 BV	54
d68e2d1a	55	static GSList *dev_insts = NULL;
915f7cc8	56	static const int hwcaps[] = {
1953564a BV	57	SR_CONF_CAPTUREFILE,
1953564a BV	58	SR_CONF_CAPTURE_UNITSIZE,
7d658874 BV	59	0,
	60	};
	61
9289e273	62	static int receive_data(int fd, int revents, void *cb_data)
7d658874	63	{
d68e2d1a	64	struct sr_dev_inst *sdi;
bb7ef793	65	struct session_vdev *vdev;
7d658874	66	struct sr_datafeed_packet packet;
9c939c51	67	struct sr_datafeed_logic logic;
f438e0c9	68	struct zip_stat zs;
7d658874	69	GSList *l;
7d658874	70	int ret, got_data;
f438e0c9 BV	71	char capturefile[16];
f438e0c9 BV	72	void *buf;
7d658874	73
cb93f8a9 UH	74	(void)fd;
cb93f8a9 UH	75	(void)revents;
7d658874	76
7d658874	77	got_data = FALSE;
d68e2d1a	78	for (l = dev_insts; l; l = l->next) {
7d658874	79	sdi = l->data;
f438e0c9 BV	80	if (!(vdev = sdi->priv))
f438e0c9 BV	81	/* Already done with this instance. */
7d658874 BV	82	continue;
7d658874 BV	83
b53738ba	84	if (!(buf = g_try_malloc(CHUNKSIZE))) {
a885ce3e	85	sr_err("%s: buf malloc failed", __func__);
a2e46460	86	return FALSE;
b53738ba UH	87	}
b53738ba UH	88
f438e0c9 BV	89	if (!vdev->capfile) {
	90	/* No capture file opened yet, or finished with the last
	91	* chunked one. */
	92	if (vdev->cur_chunk == 0) {
	93	/* capturefile is always the unchunked base name. */
	94	if (zip_stat(vdev->archive, vdev->capturefile, 0, &zs) != -1) {
	95	/* No chunks, just a single capture file. */
	96	vdev->cur_chunk = 0;
	97	if (!(vdev->capfile = zip_fopen(vdev->archive,
	98	vdev->capturefile, 0)))
	99	return FALSE;
	100	sr_dbg("Opened %s.", vdev->capturefile);
	101	} else {
	102	/* Try as first chunk filename. */
	103	snprintf(capturefile, 15, "%s-1", vdev->capturefile);
	104	if (zip_stat(vdev->archive, capturefile, 0, &zs) != -1) {
	105	vdev->cur_chunk = 1;
	106	if (!(vdev->capfile = zip_fopen(vdev->archive,
	107	capturefile, 0)))
	108	return FALSE;
	109	sr_dbg("Opened %s.", capturefile);
	110	} else {
	111	sr_err("No capture file '%s' in " "session file '%s'.",
	112	vdev->capturefile, vdev->sessionfile);
	113	return FALSE;
	114	}
	115	}
	116	} else {
	117	/* Capture data is chunked, advance to the next chunk. */
	118	vdev->cur_chunk++;
	119	snprintf(capturefile, 15, "%s-%d", vdev->capturefile,
	120	vdev->cur_chunk);
	121	if (zip_stat(vdev->archive, capturefile, 0, &zs) != -1) {
	122	if (!(vdev->capfile = zip_fopen(vdev->archive,
	123	capturefile, 0)))
	124	return FALSE;
	125	sr_dbg("Opened %s.", capturefile);
	126	} else {
	127	/* We got all the chunks, finish up. */
	128	g_free(vdev->capturefile);
	129	g_free(vdev);
	130	sdi->priv = NULL;
	131	continue;
	132	}
	133	}
	134	}
	135
bb7ef793	136	ret = zip_fread(vdev->capfile, buf, CHUNKSIZE);
7d658874 BV	137	if (ret > 0) {
	138	got_data = TRUE;
	139	packet.type = SR_DF_LOGIC;
9c939c51 BV	140	packet.payload = &logic;
9c939c51 BV	141	logic.length = ret;
bb7ef793	142	logic.unitsize = vdev->unitsize;
9c939c51	143	logic.data = buf;
bb7ef793	144	vdev->bytes_read += ret;
9289e273	145	sr_session_send(cb_data, &packet);
7d658874 BV	146	} else {
7d658874 BV	147	/* done with this capture file */
bb7ef793	148	zip_fclose(vdev->capfile);
f438e0c9 BV	149	vdev->capfile = NULL;
	150	if (vdev->cur_chunk == 0) {
	151	/* It was the only file. */
	152	g_free(vdev->capturefile);
	153	g_free(vdev);
	154	sdi->priv = NULL;
	155	} else {
	156	/* There might be more chunks, so don't fall through
	157	* to the SR_DF_END here. */
	158	return TRUE;
	159	}
7d658874 BV	160	}
	161	}
	162
	163	if (!got_data) {
	164	packet.type = SR_DF_END;
9289e273	165	sr_session_send(cb_data, &packet);
b863fb1b	166	sr_session_source_remove(-1);
7d658874 BV	167	}
	168
	169	return TRUE;
	170	}
	171
	172	/* driver callbacks */
	173
6078d2c9	174	static int init(struct sr_context *sr_ctx)
7d658874	175	{
34f06b90 PS	176	(void)sr_ctx;
34f06b90 PS	177
61136ea6	178	return SR_OK;
7d658874 BV	179	}
7d658874 BV	180
6078d2c9	181	static int cleanup(void)
7d658874 BV	182	{
	183	GSList *l;
	184
d68e2d1a	185	for (l = dev_insts; l; l = l->next)
d3683c42	186	sr_dev_inst_free(l->data);
d68e2d1a UH	187	g_slist_free(dev_insts);
d68e2d1a UH	188	dev_insts = NULL;
805e9640	189
57ab7d9f	190	return SR_OK;
7d658874 BV	191	}
7d658874 BV	192
6078d2c9	193	static int dev_open(struct sr_dev_inst *sdi)
7d658874	194	{
bb7ef793	195	if (!(sdi->priv = g_try_malloc0(sizeof(struct session_vdev)))) {
96ea73db	196	sr_err("Device context malloc failed.");
b53738ba UH	197	return SR_ERR_MALLOC;
	198	}
	199
d68e2d1a	200	dev_insts = g_slist_append(dev_insts, sdi);
7d658874 BV	201
	202	return SR_OK;
	203	}
	204
8f996b89 ML	205	static int config_get(int id, GVariant *data, const struct sr_dev_inst sdi,
8f996b89 ML	206	const struct sr_probe_group *probe_group)
7d658874	207	{
bb7ef793	208	struct session_vdev *vdev;
7d658874	209
8f996b89 ML	210	(void)probe_group;
8f996b89 ML	211
035a1078	212	switch (id) {
123e1313	213	case SR_CONF_SAMPLERATE:
387014de BV	214	if (sdi) {
387014de BV	215	vdev = sdi->priv;
003595ac	216	*data = g_variant_new_uint64(vdev->samplerate);
387014de BV	217	} else
	218	return SR_ERR;
	219	break;
	220	default:
96ea73db	221	return SR_ERR_NA;
387014de	222	}
7d658874	223
387014de	224	return SR_OK;
7d658874 BV	225	}
7d658874 BV	226
8f996b89 ML	227	static int config_set(int id, GVariant data, const struct sr_dev_inst sdi,
8f996b89 ML	228	const struct sr_probe_group *probe_group)
7d658874	229	{
bb7ef793	230	struct session_vdev *vdev;
7d658874	231
8f996b89 ML	232	(void)probe_group;
8f996b89 ML	233
6f4b1868	234	vdev = sdi->priv;
7d658874	235
035a1078	236	switch (id) {
1953564a	237	case SR_CONF_SAMPLERATE:
003595ac	238	vdev->samplerate = g_variant_get_uint64(data);
a885ce3e	239	sr_info("Setting samplerate to %" PRIu64 ".", vdev->samplerate);
7d658874	240	break;
1953564a	241	case SR_CONF_SESSIONFILE:
003595ac	242	vdev->sessionfile = g_strdup(g_variant_get_string(data, NULL));
a885ce3e	243	sr_info("Setting sessionfile to '%s'.", vdev->sessionfile);
40dda2c3	244	break;
1953564a	245	case SR_CONF_CAPTUREFILE:
003595ac	246	vdev->capturefile = g_strdup(g_variant_get_string(data, NULL));
a885ce3e	247	sr_info("Setting capturefile to '%s'.", vdev->capturefile);
7d658874	248	break;
1953564a	249	case SR_CONF_CAPTURE_UNITSIZE:
003595ac	250	vdev->unitsize = g_variant_get_uint64(data);
7d658874	251	break;
1953564a	252	case SR_CONF_CAPTURE_NUM_PROBES:
003595ac	253	vdev->num_probes = g_variant_get_uint64(data);
7d658874 BV	254	break;
7d658874 BV	255	default:
96ea73db	256	return SR_ERR_NA;
7d658874 BV	257	}
	258
	259	return SR_OK;
	260	}
	261
8f996b89 ML	262	static int config_list(int key, GVariant *data, const struct sr_dev_inst sdi,
8f996b89 ML	263	const struct sr_probe_group *probe_group)
9a6517d1	264	{
9a6517d1	265	(void)sdi;
8f996b89	266	(void)probe_group;
9a6517d1 BV	267
	268	switch (key) {
	269	case SR_CONF_DEVICE_OPTIONS:
003595ac BV	270	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
003595ac BV	271	hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
9a6517d1 BV	272	break;
9a6517d1 BV	273	default:
96ea73db	274	return SR_ERR_NA;
9a6517d1 BV	275	}
	276
	277	return SR_OK;
	278	}
	279
6078d2c9	280	static int dev_acquisition_start(const struct sr_dev_inst sdi, void cb_data)
7d658874	281	{
bb7ef793	282	struct session_vdev *vdev;
ebc34738	283	int ret;
7d658874	284
4d684427	285	vdev = sdi->priv;
7d658874	286
a885ce3e	287	sr_info("Opening archive %s file %s", vdev->sessionfile,
bb7ef793	288	vdev->capturefile);
7d658874	289
40dda2c3	290	if (!(vdev->archive = zip_open(vdev->sessionfile, 0, &ret))) {
a885ce3e	291	sr_err("Failed to open session file '%s': "
40dda2c3	292	"zip error %d\n", vdev->sessionfile, ret);
7d658874 BV	293	return SR_ERR;
	294	}
	295
4afdfd46	296	/* Send header packet to the session bus. */
29a27196	297	std_session_send_df_header(cb_data, LOG_PREFIX);
4afdfd46	298
7d658874	299	/* freewheeling source */
9289e273	300	sr_session_source_add(-1, 0, 0, receive_data, cb_data);
7d658874	301
7d658874 BV	302	return SR_OK;
	303	}
	304
b4bd7088	305	/** @private */
c09f0b57	306	SR_PRIV struct sr_dev_driver session_driver = {
a885ce3e	307	.name = "virtual-session",
5097b0d0 UH	308	.longname = "Session-emulating driver",
5097b0d0 UH	309	.api_version = 1,
6078d2c9 UH	310	.init = init,
6078d2c9 UH	311	.cleanup = cleanup,
96ea73db UH	312	.scan = NULL,
	313	.dev_list = NULL,
	314	.dev_clear = NULL,
035a1078 BV	315	.config_get = config_get,
035a1078 BV	316	.config_set = config_set,
9a6517d1	317	.config_list = config_list,
6078d2c9	318	.dev_open = dev_open,
e7eb703f	319	.dev_close = NULL,
6078d2c9	320	.dev_acquisition_start = dev_acquisition_start,
69040b7c	321	.dev_acquisition_stop = NULL,
96ea73db	322	.priv = NULL,
7d658874	323	};