X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=session.c;h=0c21c7caa9fa5f5d5e2c3919d272b221b734f220;hb=1a081ca67d63a0bd933a3d715792d85afd437296;hp=e7d3c7008cf87fae7e2e99208a4dee8abee16e68;hpb=17e1afcb81b8581091fcb660c2e61f05c75e00b5;p=libsigrok.git

diff --git a/session.c b/session.c
index e7d3c700..0c21c7ca 100644
--- a/session.c
+++ b/session.c
@@ -1,7 +1,7 @@
 /*
  * This file is part of the sigrok project.
  *
- * Copyright (C) 2010 Bert Vermeulen <bert@biot.com>
+ * Copyright (C) 2012 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
@@ -21,237 +21,554 @@
 #include <stdlib.h>
 #include <unistd.h>
 #include <string.h>
-#include <zip.h>
-#include <sigrok.h>
+#include <glib.h>
+#include "sigrok.h"
+#include "sigrok-internal.h"
 
-/* There can only be one session at a time. */
-struct session *session;
-
-struct session *session_load(const char *filename)
-{
-	struct session *session;
+/* demo.c */
+extern GIOChannel channels[2];
 
-	/* Avoid compiler warnings. */
-	filename = filename;
+struct source {
+	int fd;
+	int events;
+	int timeout;
+	sr_receive_data_callback cb;
+	void *user_data;
+};
 
-	/* TODO: Implement. */
-	session = NULL;
+/* There can only be one session at a time. */
+/* 'session' is not static, it's used elsewhere (via 'extern'). */
+struct sr_session *session;
+static int num_sources = 0;
 
-	return session;
-}
+static struct source *sources = NULL;
+static int source_timeout = -1;
 
-struct session *session_new(void)
+/**
+ * Create a new session.
+ *
+ * TODO.
+ *
+ * TODO: Should return int?
+ * TODO: Should it use the file-global "session" variable or take an argument?
+ *       The same question applies to all the other session functions.
+ *
+ * @return A pointer to the newly allocated session, or NULL upon errors.
+ */
+SR_API struct sr_session *sr_session_new(void)
 {
-	session = calloc(1, sizeof(struct session));
+	if (!(session = calloc(1, sizeof(struct sr_session)))) {
+		sr_err("session: %s: session malloc failed", __func__);
+		return NULL; /* TODO: SR_ERR_MALLOC? */
+	}
 
 	return session;
 }
 
-void session_destroy(void)
+/**
+ * Destroy the current session.
+ *
+ * This frees up all memory used by the session.
+ *
+ * @return SR_OK upon success, SR_ERR_BUG if no session exists.
+ */
+SR_API int sr_session_destroy(void)
 {
+	if (!session) {
+		sr_warn("session: %s: session was NULL", __func__);
+		return SR_ERR_BUG;
+	}
+
 	g_slist_free(session->devices);
+	session->devices = NULL;
+
+	/* TODO: Error checks needed? */
 
-	/* TODO: Loop over protocols and free them. */
+	/* TODO: Loop over protocol decoders and free them. */
 
 	g_free(session);
+	session = NULL;
+
+	return SR_OK;
 }
 
-void session_device_clear(void)
+/**
+ * Remove all the devices from the current session. TODO?
+ *
+ * The session itself (i.e., the struct sr_session) is not free'd and still
+ * exists after this function returns.
+ *
+ * @return SR_OK upon success, SR_ERR_BUG if no session exists.
+ */
+SR_API int sr_session_device_clear(void)
 {
+	if (!session) {
+		sr_warn("session: %s: session was NULL", __func__);
+		return SR_ERR_BUG;
+	}
+
 	g_slist_free(session->devices);
 	session->devices = NULL;
+
+	return SR_OK;
 }
 
-int session_device_add(struct device *device)
+/**
+ * Add a device to the current session.
+ *
+ * @param device The device to add to the current session. Must not be NULL.
+ *               Also, device->plugin and device->plugin->opendev must not
+ *               be NULL.
+ *
+ * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments.
+ */
+SR_API int sr_session_device_add(struct sr_device *device)
 {
 	int ret;
 
-	ret = device->plugin->open(device->plugin_index);
-	if (ret == SIGROK_OK)
-		session->devices = g_slist_append(session->devices, device);
+	if (!device) {
+		sr_err("session: %s: device was NULL", __func__);
+		return SR_ERR_ARG;
+	}
 
-	return ret;
-}
+	if (!device->plugin) {
+		sr_err("session: %s: device->plugin was NULL", __func__);
+		return SR_ERR_ARG;
+	}
 
-void session_pa_clear(void)
-{
-	/*
-	 * The protocols are pointers to the global set of PA plugins,
-	 * so don't free them.
-	 */
-	g_slist_free(session->analyzers);
-	session->analyzers = NULL;
-}
+	if (!device->plugin->opendev) {
+		sr_err("session: %s: device->plugin->opendev was NULL",
+		       __func__);
+		return SR_ERR_ARG;
+	}
 
-void session_pa_add(struct analyzer *an)
-{
-	session->analyzers = g_slist_append(session->analyzers, an);
+	if (!session) {
+		sr_err("session: %s: session was NULL", __func__);
+		return SR_ERR; /* TODO: SR_ERR_BUG? */
+	}
+
+	if ((ret = device->plugin->opendev(device->plugin_index)) != SR_OK) {
+		sr_err("session: %s: opendev failed (%d)", __func__, ret);
+		return ret;
+	}
+
+	session->devices = g_slist_append(session->devices, device);
+
+	return SR_OK;
 }
 
-void session_datafeed_callback_clear(void)
+/**
+ * Clear all datafeed callbacks in the current session.
+ *
+ * TODO.
+ *
+ * @return SR_OK upon success, SR_ERR_BUG if no session exists.
+ */
+SR_API int sr_session_datafeed_callback_clear(void)
 {
+	if (!session) {
+		sr_err("session: %s: session was NULL", __func__);
+		return SR_ERR_BUG;
+	}
+
 	g_slist_free(session->datafeed_callbacks);
 	session->datafeed_callbacks = NULL;
+
+	return SR_OK;
 }
 
-void session_datafeed_callback_add(datafeed_callback callback)
+/**
+ * Add a datafeed callback to the current session.
+ *
+ * @param callback TODO.
+ * @return SR_OK upon success, SR_ERR_BUG if no session exists.
+ */
+SR_API int sr_session_datafeed_callback_add(sr_datafeed_callback callback)
 {
+	if (!session) {
+		sr_err("session: %s: session was NULL", __func__);
+		return SR_ERR_BUG;
+	}
+
+	/* TODO: Is 'callback' allowed to be NULL? */
+
 	session->datafeed_callbacks =
 	    g_slist_append(session->datafeed_callbacks, callback);
+
+	return SR_OK;
 }
 
-int session_start(void)
+/**
+ * TODO.
+ */
+static int sr_session_run_poll(void)
 {
-	struct device *device;
+	GPollFD *fds, my_gpollfd;
+	int ret, i;
+
+	fds = NULL;
+	while (session->running) {
+		if (fds)
+			free(fds);
+
+		/* Construct g_poll()'s array. */
+		/* TODO: Check malloc return value. */
+		fds = malloc(sizeof(GPollFD) * num_sources);
+		if (!fds) {
+			sr_err("session: %s: fds malloc failed", __func__);
+			return SR_ERR_MALLOC;
+		}
+		for (i = 0; i < num_sources; i++) {
+#ifdef _WIN32
+			g_io_channel_win32_make_pollfd(&channels[0],
+					sources[i].events, &my_gpollfd);
+#else
+			my_gpollfd.fd = sources[i].fd;
+			my_gpollfd.events = sources[i].events;
+			fds[i] = my_gpollfd;
+#endif
+		}
+
+		ret = g_poll(fds, num_sources, source_timeout);
+
+		for (i = 0; i < num_sources; i++) {
+			if (fds[i].revents > 0 || (ret == 0
+				&& source_timeout == sources[i].timeout)) {
+				/*
+				 * Invoke the source's callback on an event,
+				 * or if the poll timeout out and this source
+				 * asked for that timeout.
+				 */
+				if (!sources[i].cb(fds[i].fd, fds[i].revents,
+						  sources[i].user_data))
+					sr_session_source_remove(sources[i].fd);
+			}
+		}
+	}
+	free(fds);
+
+	return SR_OK;
+}
+
+/**
+ * Start a session.
+ *
+ * There can only be one session at a time. TODO
+ *
+ * @return SR_OK upon success, SR_ERR upon errors.
+ */
+SR_API int sr_session_start(void)
+{
+	struct sr_device *device;
 	GSList *l;
 	int ret;
 
-	g_message("starting acquisition");
+	if (!session) {
+		sr_err("session: %s: session was NULL; a session must be "
+		       "created first, before starting it.", __func__);
+		return SR_ERR; /* TODO: SR_ERR_BUG? */
+	}
+
+	if (!session->devices) {
+		/* TODO: Actually the case? */
+		sr_err("session: %s: session->devices was NULL; a session "
+		       "cannot be started without devices.", __func__);
+		return SR_ERR; /* TODO: SR_ERR_BUG? */
+	}
+
+	/* TODO: Check plugin_index validity? */
+
+	sr_info("session: starting");
+
 	for (l = session->devices; l; l = l->next) {
 		device = l->data;
+		/* TODO: Check for device != NULL. */
 		if ((ret = device->plugin->start_acquisition(
-				device->plugin_index, device)) != SIGROK_OK)
+				device->plugin_index, device)) != SR_OK) {
+			sr_err("session: %s: could not start an acquisition "
+			       "(%d)", __func__, ret);
 			break;
+		}
 	}
 
+	/* TODO: What if there are multiple devices? Which return code? */
+
 	return ret;
 }
 
-void session_stop(void)
+/**
+ * Run the session.
+ *
+ * TODO: Various error checks etc.
+ *
+ * @return SR_OK upon success, SR_ERR_BUG upon errors.
+ */
+SR_API int sr_session_run(void)
+{
+	if (!session) {
+		sr_err("session: %s: session was NULL; a session must be "
+		       "created first, before running it.", __func__);
+		return SR_ERR_BUG;
+	}
+
+	if (!session->devices) {
+		/* TODO: Actually the case? */
+		sr_err("session: %s: session->devices was NULL; a session "
+		       "cannot be run without devices.", __func__);
+		return SR_ERR_BUG;
+	}
+
+	sr_info("session: running");
+	session->running = TRUE;
+
+	/* Do we have real sources? */
+	if (num_sources == 1 && sources[0].fd == -1) {
+		/* Dummy source, freewheel over it. */
+		while (session->running)
+			sources[0].cb(-1, 0, sources[0].user_data);
+	} else {
+		/* Real sources, use g_poll() main loop. */
+		sr_session_run_poll();
+	}
+
+	return SR_OK;
+}
+
+/**
+ * Halt the current session.
+ *
+ * TODO.
+ *
+ * @return SR_OK upon success, SR_ERR_BUG if no session exists.
+ */
+SR_API int sr_session_halt(void)
+{
+	if (!session) {
+		sr_err("session: %s: session was NULL", __func__);
+		return SR_ERR_BUG;
+	}
+
+	sr_info("session: halting");
+	session->running = FALSE;
+
+	return SR_OK;
+}
+
+/**
+ * Stop the current session.
+ *
+ * TODO: Difference to halt?
+ *
+ * @return SR_OK upon success, SR_ERR_BUG if no session exists.
+ */
+SR_API int sr_session_stop(void)
 {
-	struct device *device;
+	struct sr_device *device;
 	GSList *l;
 
-	g_message("stopping acquisition");
+	if (!session) {
+		sr_err("session: %s: session was NULL", __func__);
+		return SR_ERR_BUG;
+	}
+
+	sr_info("session: stopping");
+	session->running = FALSE;
+
 	for (l = session->devices; l; l = l->next) {
 		device = l->data;
-		device->plugin->stop_acquisition(device->plugin_index, device);
+		/* Check for device != NULL. */
+		if (device->plugin) {
+			if (device->plugin->stop_acquisition)
+				device->plugin->stop_acquisition(device->plugin_index, device);
+			if (device->plugin->cleanup)
+				device->plugin->cleanup();
+		}
+	}
+
+	return SR_OK;
+}
+
+/**
+ * TODO.
+ *
+ * TODO: Various error checks.
+ *
+ * @param packet TODO.
+ * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments.
+ */
+static int datafeed_dump(struct sr_datafeed_packet *packet)
+{
+	struct sr_datafeed_logic *logic;
+
+	if (!packet) {
+		sr_err("session: %s: packet was NULL", __func__);
+		return SR_ERR_ARG;
 	}
+
+	/* TODO: Validity checks for packet contents. */
+
+	switch (packet->type) {
+	case SR_DF_HEADER:
+		sr_dbg("bus: received SR_DF_HEADER");
+		break;
+	case SR_DF_TRIGGER:
+		sr_dbg("bus: received SR_DF_TRIGGER");
+		break;
+	case SR_DF_LOGIC:
+		logic = packet->payload;
+		/* TODO: Check for logic != NULL. */
+		sr_dbg("bus: received SR_DF_LOGIC %" PRIu64 " bytes", logic->length);
+		break;
+	case SR_DF_END:
+		sr_dbg("bus: received SR_DF_END");
+		break;
+	default:
+		/* TODO: Abort? */
+		sr_err("bus: received unknown packet type %d", packet->type);
+		break;
+	}
+
+	return SR_OK;
 }
 
-void session_bus(struct device *device, struct datafeed_packet *packet)
+/**
+ * TODO.
+ *
+ * @param device TODO.
+ * @param packet TODO.
+ * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments.
+ */
+SR_API int sr_session_bus(struct sr_device *device,
+			  struct sr_datafeed_packet *packet)
 {
 	GSList *l;
-	datafeed_callback cb;
+	sr_datafeed_callback cb;
+
+	if (!device) {
+		sr_err("session: %s: device was NULL", __func__);
+		return SR_ERR_ARG;
+	}
+
+	if (!device->plugin) {
+		sr_err("session: %s: device->plugin was NULL", __func__);
+		return SR_ERR_ARG;
+	}
+
+	if (!packet) {
+		sr_err("session: %s: packet was NULL", __func__);
+		return SR_ERR_ARG;
+	}
 
 	/*
-	 * TODO: Send packet through PA pipe, and send the output of that to
+	 * TODO: Send packet through PD pipe, and send the output of that to
 	 * the callbacks as well.
 	 */
 	for (l = session->datafeed_callbacks; l; l = l->next) {
 		cb = l->data;
+		/* TODO: Check for cb != NULL. */
+		datafeed_dump(packet);
 		cb(device, packet);
 	}
+
+	return SR_OK;
 }
 
-void make_metadata(char *filename)
+/**
+ * TODO.
+ *
+ * TODO: Switch to g_try_malloc0() / g_free().
+ * TODO: More error checks etc.
+ *
+ * @param fd TODO.
+ * @param events TODO.
+ * @param timeout TODO.
+ * @param callback TODO.
+ * @param user_data TODO.
+ * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
+ *         SR_ERR_MALLOC upon memory allocation errors.
+ */
+SR_API int sr_session_source_add(int fd, int events, int timeout,
+		sr_receive_data_callback callback, void *user_data)
 {
-	GSList *l, *p;
-	struct device *device;
-	struct probe *probe;
-	FILE *f;
-	int devcnt;
+	struct source *new_sources, *s;
 
-	f = fopen(filename, "wb");
+	if (!callback) {
+		sr_err("session: %s: callback was NULL", __func__);
+		return SR_ERR_ARG;
+	}
 
-	/* General */
+	/* Note: user_data can be NULL, that's not a bug. */
 
-	/* Devices */
-	devcnt = 1;
-	for (l = session->devices; l; l = l->next) {
-		device = l->data;
-		fprintf(f, "[device]\n");
-		fprintf(f, "driver = %s\n", device->plugin->name);
-
-		if (device->datastore)
-			fprintf(f, "capturefile = raw-%d\n", devcnt);
-
-		for (p = device->probes; p; p = p->next) {
-			probe = p->data;
-			if (probe->enabled) {
-				fprintf(f, "probe %d", probe->index);
-				if (probe->name)
-					fprintf(f, " name \"%s\"", probe->name);
-				if (probe->trigger)
-					fprintf(f, " trigger \"%s\"",
-						probe->trigger);
-				fprintf(f, "\n");
-			}
-		}
-		devcnt++;
+	new_sources = calloc(1, sizeof(struct source) * (num_sources + 1));
+	if (!new_sources) {
+		sr_err("session: %s: new_sources malloc failed", __func__);
+		return SR_ERR_MALLOC;
+	}
+
+	if (sources) {
+		memcpy(new_sources, sources,
+		       sizeof(struct source) * num_sources);
+		free(sources);
 	}
 
-	/* TODO: Protocol analyzers */
+	s = &new_sources[num_sources++];
+	s->fd = fd;
+	s->events = events;
+	s->timeout = timeout;
+	s->cb = callback;
+	s->user_data = user_data;
+	sources = new_sources;
 
-	fclose(f);
+	if (timeout != source_timeout && timeout > 0
+	    && (source_timeout == -1 || timeout < source_timeout))
+		source_timeout = timeout;
+
+	return SR_OK;
 }
 
-int session_save(char *filename)
+/**
+ * Remove the source belonging to the specified file descriptor.
+ *
+ * TODO: More error checks.
+ * TODO: Switch to g_try_malloc0() / g_free().
+ *
+ * @param fd TODO.
+ * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
+ *         SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon
+ *         internal errors.
+ */
+SR_API int sr_session_source_remove(int fd)
 {
-	GSList *l, *d;
-	struct device *device;
-	struct datastore *ds;
-	struct zip *zipfile;
-	struct zip_source *src;
-	int bufcnt, devcnt, tmpfile, ret, error;
-	char version[1], rawname[16], metafile[32], *buf;
-
-	/* Quietly delete it first, libzip wants replace ops otherwise. */
-	unlink(filename);
-
-	if (!(zipfile = zip_open(filename, ZIP_CREATE, &error)))
-		return SIGROK_ERR;
-
-	/* Version */
-	version[0] = '1';
-	if (!(src = zip_source_buffer(zipfile, version, 1, 0)))
-		return SIGROK_ERR;
-	if (zip_add(zipfile, "version", src) == -1) {
-		g_message("error saving version into zipfile: %s",
-			  zip_strerror(zipfile));
-		return SIGROK_ERR;
-	}
-
-	/* Metadata */
-	strcpy(metafile, "sigrok-meta-XXXXXX");
-	if ((tmpfile = g_mkstemp(metafile)) == -1)
-		return SIGROK_ERR;
-	close(tmpfile);
-	make_metadata(metafile);
-	if (!(src = zip_source_file(zipfile, metafile, 0, -1)))
-		return SIGROK_ERR;
-	if (zip_add(zipfile, "metadata", src) == -1)
-		return SIGROK_ERR;
-	unlink(metafile);
-
-	/* Raw */
-	devcnt = 1;
-	for (l = session->devices; l; l = l->next) {
-		device = l->data;
-		ds = device->datastore;
-		if (ds) {
-			buf = malloc(ds->num_units * ds->ds_unitsize +
-				   DATASTORE_CHUNKSIZE);
-			bufcnt = 0;
-			for (d = ds->chunklist; d; d = d->next) {
-				memcpy(buf + bufcnt, d->data,
-				       DATASTORE_CHUNKSIZE);
-				bufcnt += DATASTORE_CHUNKSIZE;
-			}
-			if (!(src = zip_source_buffer(zipfile, buf,
-				       ds->num_units * ds->ds_unitsize, TRUE)))
-				return SIGROK_ERR;
-			snprintf(rawname, 15, "raw-%d", devcnt);
-			if (zip_add(zipfile, rawname, src) == -1)
-				return SIGROK_ERR;
-		}
-		devcnt++;
+	struct source *new_sources;
+	int old, new;
+
+	if (!sources) {
+		sr_err("session: %s: sources was NULL", __func__);
+		return SR_ERR_BUG; /* TODO: Other? */
+	}
+
+	/* TODO: Check if 'fd' valid. */
+
+	new_sources = calloc(1, sizeof(struct source) * num_sources);
+	if (!new_sources) {
+		sr_err("session: %s: new_sources malloc failed", __func__);
+		return SR_ERR_MALLOC;
+	}
+
+	for (old = 0, new = 0; old < num_sources; old++) {
+		if (sources[old].fd != fd)
+			memcpy(&new_sources[new++], &sources[old],
+			       sizeof(struct source));
 	}
 
-	if ((ret = zip_close(zipfile)) == -1) {
-		g_message("error saving zipfile: %s", zip_strerror(zipfile));
-		return SIGROK_ERR;
+	if (old != new) {
+		free(sources);
+		sources = new_sources;
+		num_sources--;
+	} else {
+		/* Target fd was not found. */
+		free(new_sources);
 	}
 
-	return SIGROK_OK;
+	return SR_OK;
 }