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

#define LOG_PREFIX "virtual-session"

/* 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;
	gboolean finished;
};

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

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;
		vdev = sdi->priv;
		if (vdev->finished)
			/* Already done with this instance. */
			continue;

		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);
					vdev->finished = TRUE;
					continue;
				}
			}
		}

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

		ret = zip_fread(vdev->capfile, buf,
				CHUNKSIZE / vdev->unitsize * vdev->unitsize);
		if (ret > 0) {
			if (ret % vdev->unitsize != 0)
				sr_warn("Read size %d not a multiple of the"
					" unit size %d.", ret, vdev->unitsize);
			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);
				vdev->finished = TRUE;
			} else {
				/* There might be more chunks, so don't fall through
				 * to the SR_DF_END here. */
				g_free(buf);
				return TRUE;
			}
		}
		g_free(buf);
	}

	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 dev_clear(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)
{
	struct session_vdev *vdev;

	vdev = g_try_malloc0(sizeof(struct session_vdev));
	sdi->priv = vdev;
	dev_insts = g_slist_append(dev_insts, sdi);

	return SR_OK;
}

static int dev_close(struct sr_dev_inst *sdi)
{
	g_free(sdi->priv);
	sdi->priv = NULL;

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