[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;
static struct sr_dev_driver *di = &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_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;
	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_context *sr_ctx)
{
	return std_init(sr_ctx, di, LOG_PREFIX);
}

static int dev_clear(void)
{
	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 drv_context *drvc;
	struct session_vdev *vdev;

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