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

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(-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(-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
	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 <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>
	26	#include "libsigrok.h"
	27	#include "libsigrok-internal.h"
	28
	29	#define LOG_PREFIX "virtual-session"
	30
	31	/* size of payloads sent across the session bus */
	32	/** @cond PRIVATE */
	33	#define CHUNKSIZE (512 * 1024)
	34	/** @endcond */
	35
	36	struct session_vdev {
	37	char *sessionfile;
	38	char *capturefile;
	39	struct zip *archive;
	40	struct zip_file *capfile;
	41	int bytes_read;
	42	uint64_t samplerate;
	43	int unitsize;
	44	int num_channels;
	45	int cur_chunk;
	46	gboolean finished;
	47	};
	48
	49	static GSList *dev_insts = NULL;
	50	static const int hwcaps[] = {
	51	SR_CONF_CAPTUREFILE,
	52	SR_CONF_CAPTURE_UNITSIZE,
	53	SR_CONF_SAMPLERATE,
	54	};
	55
	56	static int receive_data(int fd, int revents, void *cb_data)
	57	{
	58	struct sr_dev_inst *sdi;
	59	struct session_vdev *vdev;
	60	struct sr_datafeed_packet packet;
	61	struct sr_datafeed_logic logic;
	62	struct zip_stat zs;
	63	GSList *l;
	64	int ret, got_data;
	65	char capturefile[16];
	66	void *buf;
	67
	68	(void)fd;
	69	(void)revents;
	70
	71	got_data = FALSE;
	72	for (l = dev_insts; l; l = l->next) {
	73	sdi = l->data;
	74	vdev = sdi->priv;
	75	if (vdev->finished)
	76	/* Already done with this instance. */
	77	continue;
	78
	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	vdev->finished = TRUE;
	119	continue;
	120	}
	121	}
	122	}
	123
	124	if (!(buf = g_try_malloc(CHUNKSIZE))) {
	125	sr_err("%s: buf malloc failed", __func__);
	126	return FALSE;
	127	}
	128
	129	ret = zip_fread(vdev->capfile, buf,
	130	CHUNKSIZE / vdev->unitsize * vdev->unitsize);
	131	if (ret > 0) {
	132	if (ret % vdev->unitsize != 0)
	133	sr_warn("Read size %d not a multiple of the"
	134	" unit size %d.", ret, vdev->unitsize);
	135	got_data = TRUE;
	136	packet.type = SR_DF_LOGIC;
	137	packet.payload = &logic;
	138	logic.length = ret;
	139	logic.unitsize = vdev->unitsize;
	140	logic.data = buf;
	141	vdev->bytes_read += ret;
	142	sr_session_send(cb_data, &packet);
	143	} else {
	144	/* done with this capture file */
	145	zip_fclose(vdev->capfile);
	146	vdev->capfile = NULL;
	147	if (vdev->cur_chunk == 0) {
	148	/* It was the only file. */
	149	vdev->finished = TRUE;
	150	} else {
	151	/* There might be more chunks, so don't fall through
	152	* to the SR_DF_END here. */
	153	g_free(buf);
	154	return TRUE;
	155	}
	156	}
	157	g_free(buf);
	158	}
	159
	160	if (!got_data) {
	161	packet.type = SR_DF_END;
	162	sr_session_send(cb_data, &packet);
	163	sr_session_source_remove(-1);
	164	}
	165
	166	return TRUE;
	167	}
	168
	169	/* driver callbacks */
	170
	171	static int init(struct sr_context *sr_ctx)
	172	{
	173	(void)sr_ctx;
	174
	175	return SR_OK;
	176	}
	177
	178	static int dev_clear(void)
	179	{
	180	GSList *l;
	181
	182	for (l = dev_insts; l; l = l->next)
	183	sr_dev_inst_free(l->data);
	184	g_slist_free(dev_insts);
	185	dev_insts = NULL;
	186
	187	return SR_OK;
	188	}
	189
	190	static int dev_open(struct sr_dev_inst *sdi)
	191	{
	192	struct session_vdev *vdev;
	193
	194	vdev = g_try_malloc0(sizeof(struct session_vdev));
	195	sdi->priv = vdev;
	196	dev_insts = g_slist_append(dev_insts, sdi);
	197
	198	return SR_OK;
	199	}
	200
	201	static int dev_close(struct sr_dev_inst *sdi)
	202	{
	203	const struct session_vdev *const vdev = sdi->priv;
	204	g_free(vdev->sessionfile);
	205	g_free(vdev->capturefile);
	206
	207	g_free(sdi->priv);
	208	sdi->priv = NULL;
	209
	210	return SR_OK;
	211	}
	212
	213	static int config_get(int id, GVariant *data, const struct sr_dev_inst sdi,
	214	const struct sr_channel_group *cg)
	215	{
	216	struct session_vdev *vdev;
	217
	218	(void)cg;
	219
	220	switch (id) {
	221	case SR_CONF_SAMPLERATE:
	222	if (sdi) {
	223	vdev = sdi->priv;
	224	*data = g_variant_new_uint64(vdev->samplerate);
	225	} else
	226	return SR_ERR;
	227	break;
	228	default:
	229	return SR_ERR_NA;
	230	}
	231
	232	return SR_OK;
	233	}
	234
	235	static int config_set(int id, GVariant data, const struct sr_dev_inst sdi,
	236	const struct sr_channel_group *cg)
	237	{
	238	struct session_vdev *vdev;
	239
	240	(void)cg;
	241
	242	vdev = sdi->priv;
	243
	244	switch (id) {
	245	case SR_CONF_SAMPLERATE:
	246	vdev->samplerate = g_variant_get_uint64(data);
	247	sr_info("Setting samplerate to %" PRIu64 ".", vdev->samplerate);
	248	break;
	249	case SR_CONF_SESSIONFILE:
	250	g_free(vdev->sessionfile);
	251	vdev->sessionfile = g_strdup(g_variant_get_string(data, NULL));
	252	sr_info("Setting sessionfile to '%s'.", vdev->sessionfile);
	253	break;
	254	case SR_CONF_CAPTUREFILE:
	255	g_free(vdev->capturefile);
	256	vdev->capturefile = g_strdup(g_variant_get_string(data, NULL));
	257	sr_info("Setting capturefile to '%s'.", vdev->capturefile);
	258	break;
	259	case SR_CONF_CAPTURE_UNITSIZE:
	260	vdev->unitsize = g_variant_get_uint64(data);
	261	break;
	262	case SR_CONF_NUM_LOGIC_CHANNELS:
	263	vdev->num_channels = g_variant_get_uint64(data);
	264	break;
	265	default:
	266	return SR_ERR_NA;
	267	}
	268
	269	return SR_OK;
	270	}
	271
	272	static int config_list(int key, GVariant *data, const struct sr_dev_inst sdi,
	273	const struct sr_channel_group *cg)
	274	{
	275	(void)sdi;
	276	(void)cg;
	277
	278	switch (key) {
	279	case SR_CONF_DEVICE_OPTIONS:
	280	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
	281	hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
	282	break;
	283	default:
	284	return SR_ERR_NA;
	285	}
	286
	287	return SR_OK;
	288	}
	289
	290	static int dev_acquisition_start(const struct sr_dev_inst sdi, void cb_data)
	291	{
	292	struct session_vdev *vdev;
	293	int ret;
	294
	295	vdev = sdi->priv;
	296
	297	vdev->bytes_read = 0;
	298	vdev->cur_chunk = 0;
	299	vdev->finished = FALSE;
	300
	301	sr_info("Opening archive %s file %s", vdev->sessionfile,
	302	vdev->capturefile);
	303
	304	if (!(vdev->archive = zip_open(vdev->sessionfile, 0, &ret))) {
	305	sr_err("Failed to open session file '%s': "
	306	"zip error %d.", vdev->sessionfile, ret);
	307	return SR_ERR;
	308	}
	309
	310	/* Send header packet to the session bus. */
	311	std_session_send_df_header(cb_data, LOG_PREFIX);
	312
	313	/* freewheeling source */
	314	sr_session_source_add(-1, 0, 0, receive_data, cb_data);
	315
	316	return SR_OK;
	317	}
	318
	319	/** @private */
	320	SR_PRIV struct sr_dev_driver session_driver = {
	321	.name = "virtual-session",
	322	.longname = "Session-emulating driver",
	323	.api_version = 1,
	324	.init = init,
	325	.cleanup = dev_clear,
	326	.scan = NULL,
	327	.dev_list = NULL,
	328	.dev_clear = dev_clear,
	329	.config_get = config_get,
	330	.config_set = config_set,
	331	.config_list = config_list,
	332	.dev_open = dev_open,
	333	.dev_close = dev_close,
	334	.dev_acquisition_start = dev_acquisition_start,
	335	.dev_acquisition_stop = NULL,
	336	.priv = NULL,
	337	};