[libsigrok.git] / src / 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 */

SR_PRIV struct sr_dev_driver session_driver_info;

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 const uint32_t devopts[] = {
	SR_CONF_CAPTUREFILE | SR_CONF_SET,
	SR_CONF_CAPTURE_UNITSIZE | SR_CONF_GET | SR_CONF_SET,
	SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET,
};

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;
	int ret, got_data;
	char capturefile[16];
	void *buf;

	(void)fd;
	(void)revents;

	sdi = cb_data;
	got_data = FALSE;
	vdev = sdi->priv;
	if (!vdev->finished) {
		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;
					return TRUE;
				}
			}
		}

		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(sdi, &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(sdi, &packet);
		sr_session_source_remove(sdi->session, -1);
	}

	return TRUE;
}

/* driver callbacks */

static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
{
	return std_init(sr_ctx, di, LOG_PREFIX);
}

static int dev_clear(const struct sr_dev_driver *di)
{
	struct drv_context *drvc;
	GSList *l;

	drvc = di->priv;
	for (l = drvc->instances; l; l = l->next)
		sr_dev_inst_free(l->data);
	g_slist_free(drvc->instances);
	drvc->instances = NULL;

	return SR_OK;
}

static int dev_open(struct sr_dev_inst *sdi)
{
	struct sr_dev_driver *di;
	struct drv_context *drvc;
	struct session_vdev *vdev;

	di = sdi->driver;
	drvc = di->priv;
	vdev = g_malloc0(sizeof(struct session_vdev));
	sdi->priv = vdev;
	drvc->instances = g_slist_append(drvc->instances, 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(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
		const struct sr_channel_group *cg)
{
	struct session_vdev *vdev;

	(void)cg;

	if (!sdi)
		return SR_ERR;

	vdev = sdi->priv;

	switch (key) {
	case SR_CONF_SAMPLERATE:
		*data = g_variant_new_uint64(vdev->samplerate);
		break;
	case SR_CONF_CAPTURE_UNITSIZE:
		*data = g_variant_new_uint64(vdev->unitsize);
		break;
	default:
		return SR_ERR_NA;
	}

	return SR_OK;
}

static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
		const struct sr_channel_group *cg)
{
	struct session_vdev *vdev;

	(void)cg;

	vdev = sdi->priv;

	switch (key) {
	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(uint32_t 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_UINT32,
				devopts, ARRAY_SIZE(devopts), sizeof(uint32_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;

	(void)cb_data;

	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(sdi, LOG_PREFIX);

	/* freewheeling source */
	sr_session_source_add(sdi->session, -1, 0, 0, receive_data, (void *)sdi);

	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	SR_PRIV struct sr_dev_driver session_driver_info;
	37
	38	struct session_vdev {
	39	char *sessionfile;
	40	char *capturefile;
	41	struct zip *archive;
	42	struct zip_file *capfile;
	43	int bytes_read;
	44	uint64_t samplerate;
	45	int unitsize;
	46	int num_channels;
	47	int cur_chunk;
	48	gboolean finished;
	49	};
	50
	51	static const uint32_t devopts[] = {
	52	SR_CONF_CAPTUREFILE \| SR_CONF_SET,
	53	SR_CONF_CAPTURE_UNITSIZE \| SR_CONF_GET \| SR_CONF_SET,
	54	SR_CONF_SAMPLERATE \| SR_CONF_GET \| SR_CONF_SET,
	55	};
	56
	57	static int receive_data(int fd, int revents, void *cb_data)
	58	{
	59	struct sr_dev_inst *sdi;
	60	struct session_vdev *vdev;
	61	struct sr_datafeed_packet packet;
	62	struct sr_datafeed_logic logic;
	63	struct zip_stat zs;
	64	int ret, got_data;
	65	char capturefile[16];
	66	void *buf;
	67
	68	(void)fd;
	69	(void)revents;
	70
	71	sdi = cb_data;
	72	got_data = FALSE;
	73	vdev = sdi->priv;
	74	if (!vdev->finished) {
	75	if (!vdev->capfile) {
	76	/* No capture file opened yet, or finished with the last
	77	* chunked one. */
	78	if (vdev->cur_chunk == 0) {
	79	/* capturefile is always the unchunked base name. */
	80	if (zip_stat(vdev->archive, vdev->capturefile, 0, &zs) != -1) {
	81	/* No chunks, just a single capture file. */
	82	vdev->cur_chunk = 0;
	83	if (!(vdev->capfile = zip_fopen(vdev->archive,
	84	vdev->capturefile, 0)))
	85	return FALSE;
	86	sr_dbg("Opened %s.", vdev->capturefile);
	87	} else {
	88	/* Try as first chunk filename. */
	89	snprintf(capturefile, 15, "%s-1", vdev->capturefile);
	90	if (zip_stat(vdev->archive, capturefile, 0, &zs) != -1) {
	91	vdev->cur_chunk = 1;
	92	if (!(vdev->capfile = zip_fopen(vdev->archive,
	93	capturefile, 0)))
	94	return FALSE;
	95	sr_dbg("Opened %s.", capturefile);
	96	} else {
	97	sr_err("No capture file '%s' in " "session file '%s'.",
	98	vdev->capturefile, vdev->sessionfile);
	99	return FALSE;
	100	}
	101	}
	102	} else {
	103	/* Capture data is chunked, advance to the next chunk. */
	104	vdev->cur_chunk++;
	105	snprintf(capturefile, 15, "%s-%d", vdev->capturefile,
	106	vdev->cur_chunk);
	107	if (zip_stat(vdev->archive, capturefile, 0, &zs) != -1) {
	108	if (!(vdev->capfile = zip_fopen(vdev->archive,
	109	capturefile, 0)))
	110	return FALSE;
	111	sr_dbg("Opened %s.", capturefile);
	112	} else {
	113	/* We got all the chunks, finish up. */
	114	vdev->finished = TRUE;
	115	return TRUE;
	116	}
	117	}
	118	}
	119
	120	if (!(buf = g_try_malloc(CHUNKSIZE))) {
	121	sr_err("%s: buf malloc failed", __func__);
	122	return FALSE;
	123	}
	124
	125	ret = zip_fread(vdev->capfile, buf,
	126	CHUNKSIZE / vdev->unitsize * vdev->unitsize);
	127	if (ret > 0) {
	128	if (ret % vdev->unitsize != 0)
	129	sr_warn("Read size %d not a multiple of the"
	130	" unit size %d.", ret, vdev->unitsize);
	131	got_data = TRUE;
	132	packet.type = SR_DF_LOGIC;
	133	packet.payload = &logic;
	134	logic.length = ret;
	135	logic.unitsize = vdev->unitsize;
	136	logic.data = buf;
	137	vdev->bytes_read += ret;
	138	sr_session_send(sdi, &packet);
	139	} else {
	140	/* done with this capture file */
	141	zip_fclose(vdev->capfile);
	142	vdev->capfile = NULL;
	143	if (vdev->cur_chunk == 0) {
	144	/* It was the only file. */
	145	vdev->finished = TRUE;
	146	} else {
	147	/* There might be more chunks, so don't fall through
	148	* to the SR_DF_END here. */
	149	g_free(buf);
	150	return TRUE;
	151	}
	152	}
	153	g_free(buf);
	154	}
	155
	156	if (!got_data) {
	157	packet.type = SR_DF_END;
	158	sr_session_send(sdi, &packet);
	159	sr_session_source_remove(sdi->session, -1);
	160	}
	161
	162	return TRUE;
	163	}
	164
	165	/* driver callbacks */
	166
	167	static int init(struct sr_dev_driver di, struct sr_context sr_ctx)
	168	{
	169	return std_init(sr_ctx, di, LOG_PREFIX);
	170	}
	171
	172	static int dev_clear(const struct sr_dev_driver *di)
	173	{
	174	struct drv_context *drvc;
	175	GSList *l;
	176
	177	drvc = di->priv;
	178	for (l = drvc->instances; l; l = l->next)
	179	sr_dev_inst_free(l->data);
	180	g_slist_free(drvc->instances);
	181	drvc->instances = NULL;
	182
	183	return SR_OK;
	184	}
	185
	186	static int dev_open(struct sr_dev_inst *sdi)
	187	{
	188	struct sr_dev_driver *di;
	189	struct drv_context *drvc;
	190	struct session_vdev *vdev;
	191
	192	di = sdi->driver;
	193	drvc = di->priv;
	194	vdev = g_malloc0(sizeof(struct session_vdev));
	195	sdi->priv = vdev;
	196	drvc->instances = g_slist_append(drvc->instances, 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(uint32_t key, 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	if (!sdi)
	221	return SR_ERR;
	222
	223	vdev = sdi->priv;
	224
	225	switch (key) {
	226	case SR_CONF_SAMPLERATE:
	227	*data = g_variant_new_uint64(vdev->samplerate);
	228	break;
	229	case SR_CONF_CAPTURE_UNITSIZE:
	230	*data = g_variant_new_uint64(vdev->unitsize);
	231	break;
	232	default:
	233	return SR_ERR_NA;
	234	}
	235
	236	return SR_OK;
	237	}
	238
	239	static int config_set(uint32_t key, GVariant data, const struct sr_dev_inst sdi,
	240	const struct sr_channel_group *cg)
	241	{
	242	struct session_vdev *vdev;
	243
	244	(void)cg;
	245
	246	vdev = sdi->priv;
	247
	248	switch (key) {
	249	case SR_CONF_SAMPLERATE:
	250	vdev->samplerate = g_variant_get_uint64(data);
	251	sr_info("Setting samplerate to %" PRIu64 ".", vdev->samplerate);
	252	break;
	253	case SR_CONF_SESSIONFILE:
	254	g_free(vdev->sessionfile);
	255	vdev->sessionfile = g_strdup(g_variant_get_string(data, NULL));
	256	sr_info("Setting sessionfile to '%s'.", vdev->sessionfile);
	257	break;
	258	case SR_CONF_CAPTUREFILE:
	259	g_free(vdev->capturefile);
	260	vdev->capturefile = g_strdup(g_variant_get_string(data, NULL));
	261	sr_info("Setting capturefile to '%s'.", vdev->capturefile);
	262	break;
	263	case SR_CONF_CAPTURE_UNITSIZE:
	264	vdev->unitsize = g_variant_get_uint64(data);
	265	break;
	266	case SR_CONF_NUM_LOGIC_CHANNELS:
	267	vdev->num_channels = g_variant_get_uint64(data);
	268	break;
	269	default:
	270	return SR_ERR_NA;
	271	}
	272
	273	return SR_OK;
	274	}
	275
	276	static int config_list(uint32_t key, GVariant *data, const struct sr_dev_inst sdi,
	277	const struct sr_channel_group *cg)
	278	{
	279	(void)sdi;
	280	(void)cg;
	281
	282	switch (key) {
	283	case SR_CONF_DEVICE_OPTIONS:
	284	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
	285	devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
	286	break;
	287	default:
	288	return SR_ERR_NA;
	289	}
	290
	291	return SR_OK;
	292	}
	293
	294	static int dev_acquisition_start(const struct sr_dev_inst sdi, void cb_data)
	295	{
	296	struct session_vdev *vdev;
	297	int ret;
	298
	299	(void)cb_data;
	300
	301	vdev = sdi->priv;
	302	vdev->bytes_read = 0;
	303	vdev->cur_chunk = 0;
	304	vdev->finished = FALSE;
	305
	306	sr_info("Opening archive %s file %s", vdev->sessionfile,
	307	vdev->capturefile);
	308
	309	if (!(vdev->archive = zip_open(vdev->sessionfile, 0, &ret))) {
	310	sr_err("Failed to open session file '%s': "
	311	"zip error %d.", vdev->sessionfile, ret);
	312	return SR_ERR;
	313	}
	314
	315	/* Send header packet to the session bus. */
	316	std_session_send_df_header(sdi, LOG_PREFIX);
	317
	318	/* freewheeling source */
	319	sr_session_source_add(sdi->session, -1, 0, 0, receive_data, (void *)sdi);
	320
	321	return SR_OK;
	322	}
	323
	324	/** @private */
	325	SR_PRIV struct sr_dev_driver session_driver = {
	326	.name = "virtual-session",
	327	.longname = "Session-emulating driver",
	328	.api_version = 1,
	329	.init = init,
	330	.cleanup = dev_clear,
	331	.scan = NULL,
	332	.dev_list = NULL,
	333	.dev_clear = dev_clear,
	334	.config_get = config_get,
	335	.config_set = config_set,
	336	.config_list = config_list,
	337	.dev_open = dev_open,
	338	.dev_close = dev_close,
	339	.dev_acquisition_start = dev_acquisition_start,
	340	.dev_acquisition_stop = NULL,
	341	.priv = NULL,
	342	};