[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_channels;
	int cur_chunk;
	gboolean finished;
};

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

extern struct sr_session *sr_current_session;

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. */
					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. */
				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(sr_current_session, -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)
{
	const struct session_vdev *const vdev = sdi->priv;
	g_free(vdev->sessionfile);
	g_free(vdev->capturefile);

	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_channel_group *cg)
{
	struct session_vdev *vdev;

	(void)cg;

	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_channel_group *cg)
{
	struct session_vdev *vdev;

	(void)cg;

	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:
		g_free(vdev->sessionfile);
		vdev->sessionfile = g_strdup(g_variant_get_string(data, NULL));
		sr_info("Setting sessionfile to '%s'.", vdev->sessionfile);
		break;
	case SR_CONF_CAPTUREFILE:
		g_free(vdev->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_CHANNELS:
		vdev->num_channels = 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_channel_group *cg)
{
	(void)sdi;
	(void)cg;

	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;

	vdev->bytes_read = 0;
	vdev->cur_chunk = 0;
	vdev->finished = FALSE;

	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(sr_current_session, -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;
7d658874 BV	43	int unitsize;
fca75cbb	44	int num_channels;
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
0812c40e ML	56	extern struct sr_session *sr_current_session;
0812c40e ML	57
9289e273	58	static int receive_data(int fd, int revents, void *cb_data)
7d658874	59	{
d68e2d1a	60	struct sr_dev_inst *sdi;
bb7ef793	61	struct session_vdev *vdev;
7d658874	62	struct sr_datafeed_packet packet;
9c939c51	63	struct sr_datafeed_logic logic;
f438e0c9	64	struct zip_stat zs;
7d658874	65	GSList *l;
7d658874	66	int ret, got_data;
f438e0c9 BV	67	char capturefile[16];
f438e0c9 BV	68	void *buf;
7d658874	69
cb93f8a9 UH	70	(void)fd;
cb93f8a9 UH	71	(void)revents;
7d658874	72
7d658874	73	got_data = FALSE;
d68e2d1a	74	for (l = dev_insts; l; l = l->next) {
7d658874	75	sdi = l->data;
aa48adf9 BV	76	vdev = sdi->priv;
aa48adf9 BV	77	if (vdev->finished)
f438e0c9	78	/* Already done with this instance. */
7d658874 BV	79	continue;
7d658874 BV	80
f438e0c9 BV	81	if (!vdev->capfile) {
	82	/* No capture file opened yet, or finished with the last
	83	* chunked one. */
	84	if (vdev->cur_chunk == 0) {
	85	/* capturefile is always the unchunked base name. */
	86	if (zip_stat(vdev->archive, vdev->capturefile, 0, &zs) != -1) {
	87	/* No chunks, just a single capture file. */
	88	vdev->cur_chunk = 0;
	89	if (!(vdev->capfile = zip_fopen(vdev->archive,
	90	vdev->capturefile, 0)))
	91	return FALSE;
	92	sr_dbg("Opened %s.", vdev->capturefile);
	93	} else {
	94	/* Try as first chunk filename. */
	95	snprintf(capturefile, 15, "%s-1", vdev->capturefile);
	96	if (zip_stat(vdev->archive, capturefile, 0, &zs) != -1) {
	97	vdev->cur_chunk = 1;
	98	if (!(vdev->capfile = zip_fopen(vdev->archive,
	99	capturefile, 0)))
	100	return FALSE;
	101	sr_dbg("Opened %s.", capturefile);
	102	} else {
	103	sr_err("No capture file '%s' in " "session file '%s'.",
	104	vdev->capturefile, vdev->sessionfile);
	105	return FALSE;
	106	}
	107	}
	108	} else {
	109	/* Capture data is chunked, advance to the next chunk. */
	110	vdev->cur_chunk++;
	111	snprintf(capturefile, 15, "%s-%d", vdev->capturefile,
	112	vdev->cur_chunk);
	113	if (zip_stat(vdev->archive, capturefile, 0, &zs) != -1) {
	114	if (!(vdev->capfile = zip_fopen(vdev->archive,
	115	capturefile, 0)))
	116	return FALSE;
	117	sr_dbg("Opened %s.", capturefile);
	118	} else {
	119	/* We got all the chunks, finish up. */
aa48adf9	120	vdev->finished = TRUE;
f438e0c9 BV	121	continue;
	122	}
	123	}
	124	}
	125
016f2e00 BV	126	if (!(buf = g_try_malloc(CHUNKSIZE))) {
	127	sr_err("%s: buf malloc failed", __func__);
	128	return FALSE;
	129	}
	130
8bbdd364 DE	131	ret = zip_fread(vdev->capfile, buf,
8bbdd364 DE	132	CHUNKSIZE / vdev->unitsize * vdev->unitsize);
7d658874	133	if (ret > 0) {
8bbdd364 DE	134	if (ret % vdev->unitsize != 0)
	135	sr_warn("Read size %d not a multiple of the"
	136	" unit size %d.", ret, vdev->unitsize);
7d658874 BV	137	got_data = TRUE;
7d658874 BV	138	packet.type = SR_DF_LOGIC;
9c939c51 BV	139	packet.payload = &logic;
9c939c51 BV	140	logic.length = ret;
bb7ef793	141	logic.unitsize = vdev->unitsize;
9c939c51	142	logic.data = buf;
bb7ef793	143	vdev->bytes_read += ret;
9289e273	144	sr_session_send(cb_data, &packet);
7d658874 BV	145	} else {
7d658874 BV	146	/* done with this capture file */
bb7ef793	147	zip_fclose(vdev->capfile);
f438e0c9 BV	148	vdev->capfile = NULL;
	149	if (vdev->cur_chunk == 0) {
	150	/* It was the only file. */
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);
0812c40e	165	sr_session_source_remove(sr_current_session, -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)
aa48adf9 BV	204	{
8c9d4d67 JH	205	const struct session_vdev *const vdev = sdi->priv;
	206	g_free(vdev->sessionfile);
	207	g_free(vdev->capturefile);
	208
aa48adf9 BV	209	g_free(sdi->priv);
	210	sdi->priv = NULL;
	211
	212	return SR_OK;
	213	}
	214
8f996b89	215	static int config_get(int id, GVariant *data, const struct sr_dev_inst sdi,
53b4680f	216	const struct sr_channel_group *cg)
7d658874	217	{
bb7ef793	218	struct session_vdev *vdev;
7d658874	219
53b4680f	220	(void)cg;
8f996b89	221
035a1078	222	switch (id) {
123e1313	223	case SR_CONF_SAMPLERATE:
387014de BV	224	if (sdi) {
387014de BV	225	vdev = sdi->priv;
003595ac	226	*data = g_variant_new_uint64(vdev->samplerate);
387014de BV	227	} else
	228	return SR_ERR;
	229	break;
	230	default:
96ea73db	231	return SR_ERR_NA;
387014de	232	}
7d658874	233
387014de	234	return SR_OK;
7d658874 BV	235	}
7d658874 BV	236
8f996b89	237	static int config_set(int id, GVariant data, const struct sr_dev_inst sdi,
53b4680f	238	const struct sr_channel_group *cg)
7d658874	239	{
bb7ef793	240	struct session_vdev *vdev;
7d658874	241
53b4680f	242	(void)cg;
8f996b89	243
6f4b1868	244	vdev = sdi->priv;
7d658874	245
035a1078	246	switch (id) {
1953564a	247	case SR_CONF_SAMPLERATE:
003595ac	248	vdev->samplerate = g_variant_get_uint64(data);
a885ce3e	249	sr_info("Setting samplerate to %" PRIu64 ".", vdev->samplerate);
7d658874	250	break;
1953564a	251	case SR_CONF_SESSIONFILE:
8c9d4d67	252	g_free(vdev->sessionfile);
003595ac	253	vdev->sessionfile = g_strdup(g_variant_get_string(data, NULL));
a885ce3e	254	sr_info("Setting sessionfile to '%s'.", vdev->sessionfile);
40dda2c3	255	break;
1953564a	256	case SR_CONF_CAPTUREFILE:
8c9d4d67	257	g_free(vdev->capturefile);
003595ac	258	vdev->capturefile = g_strdup(g_variant_get_string(data, NULL));
a885ce3e	259	sr_info("Setting capturefile to '%s'.", vdev->capturefile);
7d658874	260	break;
1953564a	261	case SR_CONF_CAPTURE_UNITSIZE:
003595ac	262	vdev->unitsize = g_variant_get_uint64(data);
7d658874	263	break;
3f239f08	264	case SR_CONF_NUM_LOGIC_CHANNELS:
fca75cbb	265	vdev->num_channels = g_variant_get_uint64(data);
7d658874 BV	266	break;
7d658874 BV	267	default:
96ea73db	268	return SR_ERR_NA;
7d658874 BV	269	}
	270
	271	return SR_OK;
	272	}
	273
8f996b89	274	static int config_list(int key, GVariant *data, const struct sr_dev_inst sdi,
53b4680f	275	const struct sr_channel_group *cg)
9a6517d1	276	{
9a6517d1	277	(void)sdi;
53b4680f	278	(void)cg;
9a6517d1 BV	279
	280	switch (key) {
	281	case SR_CONF_DEVICE_OPTIONS:
003595ac BV	282	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
003595ac BV	283	hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
9a6517d1 BV	284	break;
9a6517d1 BV	285	default:
96ea73db	286	return SR_ERR_NA;
9a6517d1 BV	287	}
	288
	289	return SR_OK;
	290	}
	291
6078d2c9	292	static int dev_acquisition_start(const struct sr_dev_inst sdi, void cb_data)
7d658874	293	{
bb7ef793	294	struct session_vdev *vdev;
ebc34738	295	int ret;
7d658874	296
4d684427	297	vdev = sdi->priv;
7d658874	298
8c9d4d67 JH	299	vdev->bytes_read = 0;
	300	vdev->cur_chunk = 0;
	301	vdev->finished = FALSE;
	302
a885ce3e	303	sr_info("Opening archive %s file %s", vdev->sessionfile,
bb7ef793	304	vdev->capturefile);
7d658874	305
40dda2c3	306	if (!(vdev->archive = zip_open(vdev->sessionfile, 0, &ret))) {
a885ce3e	307	sr_err("Failed to open session file '%s': "
9d122af8	308	"zip error %d.", vdev->sessionfile, ret);
7d658874 BV	309	return SR_ERR;
	310	}
	311
4afdfd46	312	/* Send header packet to the session bus. */
29a27196	313	std_session_send_df_header(cb_data, LOG_PREFIX);
4afdfd46	314
7d658874	315	/* freewheeling source */
0812c40e	316	sr_session_source_add(sr_current_session, -1, 0, 0, receive_data, cb_data);
7d658874	317
7d658874 BV	318	return SR_OK;
	319	}
	320
b4bd7088	321	/** @private */
c09f0b57	322	SR_PRIV struct sr_dev_driver session_driver = {
a885ce3e	323	.name = "virtual-session",
5097b0d0 UH	324	.longname = "Session-emulating driver",
5097b0d0 UH	325	.api_version = 1,
6078d2c9	326	.init = init,
824fba03	327	.cleanup = dev_clear,
96ea73db UH	328	.scan = NULL,
96ea73db UH	329	.dev_list = NULL,
824fba03	330	.dev_clear = dev_clear,
035a1078 BV	331	.config_get = config_get,
035a1078 BV	332	.config_set = config_set,
9a6517d1	333	.config_list = config_list,
6078d2c9	334	.dev_open = dev_open,
aa48adf9	335	.dev_close = dev_close,
6078d2c9	336	.dev_acquisition_start = dev_acquisition_start,
69040b7c	337	.dev_acquisition_stop = NULL,
96ea73db	338	.priv = NULL,
7d658874	339	};