X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=src%2Fsession.c;h=44aa59ed729afb4c101d29957b931ca4b78f8e64;hb=5a7d8dac9042e5db6f2e058f20d7344ad322d17a;hp=158b33cf856a21e8f547982a4742d9cab918b4e2;hpb=ca7dbb56161f9f4b7f842103fca59d41d559c793;p=libsigrok.git

diff --git a/src/session.c b/src/session.c
index 158b33cf..44aa59ed 100644
--- a/src/session.c
+++ b/src/session.c
@@ -17,6 +17,7 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+#include <errno.h>
 #include <stdio.h>
 #include <stdlib.h>
 #include <unistd.h>
@@ -44,7 +45,9 @@
  */
 
 struct source {
-	int timeout;
+	int64_t timeout;	/* microseconds */
+	int64_t due;		/* microseconds */
+
 	sr_receive_data_callback cb;
 	void *cb_data;
 
@@ -52,6 +55,14 @@ struct source {
 	 * being polled and will be used to match the source when removing it again.
 	 */
 	gintptr poll_object;
+
+	/* Number of fds to poll for this source. This will be 0 for timer
+	 * sources, 1 for normal I/O sources, and 1 or more for libusb I/O
+	 * sources on Unix platforms.
+	 */
+	int num_fds;
+
+	gboolean triggered;
 };
 
 struct datafeed_callback {
@@ -83,9 +94,10 @@ SR_API int sr_session_new(struct sr_context *ctx,
 	session = g_malloc0(sizeof(struct sr_session));
 
 	session->ctx = ctx;
-	session->source_timeout = -1;
-	session->running = FALSE;
-	session->abort_session = FALSE;
+
+	session->sources = g_array_new(FALSE, FALSE, sizeof(struct source));
+	session->pollfds = g_array_new(FALSE, FALSE, sizeof(GPollFD));
+
 	g_mutex_init(&session->stop_mutex);
 
 	*new_session = session;
@@ -118,6 +130,9 @@ SR_API int sr_session_destroy(struct sr_session *session)
 
 	g_slist_free_full(session->owned_devs, (GDestroyNotify)sr_dev_inst_free);
 
+	g_array_unref(session->pollfds);
+	g_array_unref(session->sources);
+
 	g_free(session);
 
 	return SR_OK;
@@ -358,80 +373,177 @@ SR_API int sr_session_trigger_set(struct sr_session *session, struct sr_trigger
 	return SR_OK;
 }
 
+static gboolean sr_session_check_aborted(struct sr_session *session)
+{
+	gboolean stop;
+
+	g_mutex_lock(&session->stop_mutex);
+	stop = session->abort_session;
+	if (stop) {
+		sr_session_stop_sync(session);
+		/* But once is enough. */
+		session->abort_session = FALSE;
+	}
+	g_mutex_unlock(&session->stop_mutex);
+
+	return stop;
+}
+
 /**
- * Call every device in the current session's callback.
- *
- * For sessions not driven by select loops such as sr_session_run(),
- * but driven by another scheduler, this can be used to poll the devices
- * from within that scheduler.
+ * Poll the session's event sources.
  *
  * @param session The session to use. Must not be NULL.
- * @param block If TRUE, this call will wait for any of the session's
- *              sources to fire an event on the file descriptors, or
- *              any of their timeouts to activate. In other words, this
- *              can be used as a select loop.
- *              If FALSE, all sources have their callback run, regardless
- *              of file descriptor or timeout status.
- *
  * @retval SR_OK Success.
  * @retval SR_ERR Error occurred.
  */
-static int sr_session_iteration(struct sr_session *session, gboolean block)
+static int sr_session_iteration(struct sr_session *session)
 {
+	int64_t start_time, stop_time, min_due, due;
+	int timeout_ms;
 	unsigned int i;
-	int ret, timeout;
-#ifdef HAVE_LIBUSB_1_0
-	int usb_timeout;
+	int k, fd_index;
+	int ret;
+	int fd;
+	int revents;
+	gboolean triggered, stopped;
+	struct source *source;
+	GPollFD *pollfd;
+	gintptr poll_object;
+#if HAVE_LIBUSB_1_0 && !defined(G_OS_WIN32)
+	int64_t usb_timeout;
+	int64_t usb_due;
 	struct timeval tv;
 #endif
-
-	timeout = block ? session->source_timeout : 0;
-
-#ifdef HAVE_LIBUSB_1_0
+	if (session->sources->len == 0) {
+		sr_session_check_aborted(session);
+		return SR_OK;
+	}
+	start_time = g_get_monotonic_time();
+	min_due = INT64_MAX;
+
+	for (i = 0; i < session->sources->len; ++i) {
+		source = &g_array_index(session->sources, struct source, i);
+		if (source->due < min_due)
+			min_due = source->due;
+		source->triggered = FALSE;
+	}
+#if HAVE_LIBUSB_1_0 && !defined(G_OS_WIN32)
+	usb_due = INT64_MAX;
 	if (session->ctx->usb_source_present) {
-		timeout = block ? 0 : session->source_timeout;
 		ret = libusb_get_next_timeout(session->ctx->libusb_ctx, &tv);
 		if (ret < 0) {
 			sr_err("Error getting libusb timeout: %s",
 				libusb_error_name(ret));
 			return SR_ERR;
 		} else if (ret == 1) {
-			usb_timeout = tv.tv_sec * 1000 + tv.tv_usec / 1000;
-			timeout = MIN(timeout, usb_timeout);
+			usb_timeout = (int64_t)tv.tv_sec * G_USEC_PER_SEC
+					+ tv.tv_usec;
+			usb_due = start_time + usb_timeout;
+			if (usb_due < min_due)
+				min_due = usb_due;
+
+			sr_spew("poll: next USB timeout %g ms",
+				1e-3 * usb_timeout);
 		}
 	}
 #endif
+	if (min_due == INT64_MAX)
+		timeout_ms = -1;
+	else if (min_due > start_time)
+		timeout_ms = MIN((min_due - start_time + 999) / 1000, INT_MAX);
+	else
+		timeout_ms = 0;
+
+	sr_spew("poll enter: %u sources, %u fds, %d ms timeout",
+		session->sources->len, session->pollfds->len, timeout_ms);
+
+	ret = g_poll((GPollFD *)session->pollfds->data,
+			session->pollfds->len, timeout_ms);
+#ifdef G_OS_UNIX
+	if (ret < 0 && errno != EINTR) {
+		sr_err("Error in poll: %s", g_strerror(errno));
+		return SR_ERR;
+	}
+#else
+	if (ret < 0) {
+		sr_err("Error in poll: %d", ret);
+		return SR_ERR;
+	}
+#endif
+	stop_time = g_get_monotonic_time();
 
-	ret = g_poll(session->pollfds, session->num_sources, timeout);
-	for (i = 0; i < session->num_sources; i++) {
-		if (session->pollfds[i].revents > 0 || (ret == 0
-			&& session->source_timeout == session->sources[i].timeout)) {
-			/*
-			 * Invoke the source's callback on an event,
-			 * or if the poll timed out and this source
-			 * asked for that timeout.
-			 */
-			if (!session->sources[i].cb(session->pollfds[i].fd,
-					session->pollfds[i].revents,
-					session->sources[i].cb_data))
-				sr_session_source_remove(session,
-						session->sources[i].poll_object);
+	sr_spew("poll leave: %g ms elapsed, %d events",
+		1e-3 * (stop_time - start_time), ret);
+
+	triggered = FALSE;
+	stopped = FALSE;
+	fd_index = 0;
+
+	for (i = 0; i < session->sources->len; ++i) {
+		source = &g_array_index(session->sources, struct source, i);
+
+		poll_object = source->poll_object;
+		fd = (int)poll_object;
+		revents = 0;
+
+		for (k = 0; k < source->num_fds; ++k) {
+			pollfd = &g_array_index(session->pollfds,
+					GPollFD, fd_index + k);
+			fd = pollfd->fd;
+			revents |= pollfd->revents;
 		}
+		fd_index += source->num_fds;
+
+		if (source->triggered)
+			continue; /* already handled */
+		if (ret > 0 && revents == 0)
+			continue; /* skip timeouts if any I/O event occurred */
+
+		/* Make invalid to avoid confusion in case of multiple FDs. */
+		if (source->num_fds > 1)
+			fd = -1;
+		if (ret <= 0)
+			revents = 0;
+
+		due = source->due;
+#if HAVE_LIBUSB_1_0 && !defined(G_OS_WIN32)
+		if (usb_due < due && poll_object
+				== (gintptr)session->ctx->libusb_ctx)
+			due = usb_due;
+#endif
+		if (revents == 0 && stop_time < due)
+			continue;
+		/*
+		 * The source may be gone after the callback returns,
+		 * so access any data now that needs accessing.
+		 */
+		if (source->timeout >= 0)
+			source->due = stop_time + source->timeout;
+		source->triggered = TRUE;
+		triggered = TRUE;
+		/*
+		 * Invoke the source's callback on an event or timeout.
+		 */
+		if (!source->cb(fd, revents, source->cb_data))
+			sr_session_source_remove_internal(session, poll_object);
 		/*
 		 * We want to take as little time as possible to stop
 		 * the session if we have been told to do so. Therefore,
 		 * we check the flag after processing every source, not
 		 * just once per main event loop.
 		 */
-		g_mutex_lock(&session->stop_mutex);
-		if (session->abort_session) {
-			sr_session_stop_sync(session);
-			/* But once is enough. */
-			session->abort_session = FALSE;
-		}
-		g_mutex_unlock(&session->stop_mutex);
+		if (!stopped)
+			stopped = sr_session_check_aborted(session);
+
+		/* Restart loop as the sources list may have changed. */
+		fd_index = 0;
+		i = 0;
 	}
 
+	/* Check for abort at least once per iteration. */
+	if (!triggered)
+		sr_session_check_aborted(session);
+
 	return SR_OK;
 }
 
@@ -546,11 +658,14 @@ SR_API int sr_session_start(struct sr_session *session)
  *
  * @retval SR_OK Success.
  * @retval SR_ERR_ARG Invalid session passed.
+ * @retval SR_ERR Error during event processing.
  *
  * @since 0.4.0
  */
 SR_API int sr_session_run(struct sr_session *session)
 {
+	int ret;
+
 	if (!session) {
 		sr_err("%s: session was NULL", __func__);
 		return SR_ERR_ARG;
@@ -566,17 +681,12 @@ SR_API int sr_session_run(struct sr_session *session)
 
 	sr_info("Running.");
 
-	/* Do we have real sources? */
-	if (session->num_sources == 1 && session->pollfds[0].fd == -1) {
-		/* Dummy source, freewheel over it. */
-		while (session->num_sources)
-			session->sources[0].cb(-1, 0, session->sources[0].cb_data);
-	} else {
-		/* Real sources, use g_poll() main loop. */
-		while (session->num_sources)
-			sr_session_iteration(session, TRUE);
+	/* Poll event sources until none are left. */
+	while (session->sources->len > 0) {
+		ret = sr_session_iteration(session);
+		if (ret != SR_OK)
+			return ret;
 	}
-
 	return SR_OK;
 }
 
@@ -770,6 +880,7 @@ SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
 			packet_in = packet_out;
 		}
 	}
+	packet = packet_in;
 
 	/*
 	 * If the last transform did output a packet, pass it to all datafeed
@@ -789,46 +900,62 @@ SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
  * Add an event source for a file descriptor.
  *
  * @param session The session to use. Must not be NULL.
- * @param pollfd The GPollFD.
- * @param[in] timeout Max time to wait before the callback is called,
- *              ignored if 0.
+ * @param[in] pollfds The FDs to poll, or NULL if @a num_fds is 0.
+ * @param[in] num_fds Number of FDs in the array.
+ * @param[in] timeout Max time in ms to wait before the callback is called,
+ *                    or -1 to wait indefinitely.
  * @param cb Callback function to add. Must not be NULL.
  * @param cb_data Data for the callback function. Can be NULL.
- * @param poll_object TODO.
+ * @param poll_object Handle by which the source is identified
  *
  * @retval SR_OK Success.
  * @retval SR_ERR_ARG Invalid argument.
+ * @retval SR_ERR An event source for @a poll_object is already installed.
  */
-static int _sr_session_source_add(struct sr_session *session, GPollFD *pollfd,
-		int timeout, sr_receive_data_callback cb, void *cb_data, gintptr poll_object)
+SR_PRIV int sr_session_source_add_internal(struct sr_session *session,
+		const GPollFD *pollfds, int num_fds, int timeout,
+		sr_receive_data_callback cb, void *cb_data,
+		gintptr poll_object)
 {
-	struct source *new_sources, *s;
-	GPollFD *new_pollfds;
+	struct source src;
+	unsigned int i;
 
+	/* Note: cb_data can be NULL, that's not a bug. */
 	if (!cb) {
 		sr_err("%s: cb was NULL", __func__);
 		return SR_ERR_ARG;
 	}
+	if (!pollfds && num_fds != 0) {
+		sr_err("%s: pollfds was NULL", __func__);
+		return SR_ERR_ARG;
+	}
+	/* Make sure that poll_object is unique.
+	 */
+	for (i = 0; i < session->sources->len; ++i) {
+		if (g_array_index(session->sources, struct source, i)
+				.poll_object == poll_object) {
+			sr_err("Event source for object %" G_GINTPTR_FORMAT
+				" already installed.", poll_object);
+			return SR_ERR;
+		}
+	}
+	src.cb = cb;
+	src.cb_data = cb_data;
+	src.poll_object = poll_object;
+	src.num_fds = num_fds;
+	src.triggered = FALSE;
+
+	if (timeout >= 0) {
+		src.timeout = INT64_C(1000) * timeout;
+		src.due = g_get_monotonic_time() + src.timeout;
+	} else {
+		src.timeout = -1;
+		src.due = INT64_MAX;
+	}
+	g_array_append_val(session->sources, src);
 
-	/* Note: cb_data can be NULL, that's not a bug. */
-
-	new_pollfds = g_realloc(session->pollfds,
-			sizeof(GPollFD) * (session->num_sources + 1));
-	new_sources = g_realloc(session->sources, sizeof(struct source) *
-			(session->num_sources + 1));
-
-	new_pollfds[session->num_sources] = *pollfd;
-	s = &new_sources[session->num_sources++];
-	s->timeout = timeout;
-	s->cb = cb;
-	s->cb_data = cb_data;
-	s->poll_object = poll_object;
-	session->pollfds = new_pollfds;
-	session->sources = new_sources;
-
-	if (timeout != session->source_timeout && timeout > 0
-	    && (session->source_timeout == -1 || timeout < session->source_timeout))
-		session->source_timeout = timeout;
+	if (num_fds > 0)
+		g_array_append_vals(session->pollfds, pollfds, num_fds);
 
 	return SR_OK;
 }
@@ -839,7 +966,8 @@ static int _sr_session_source_add(struct sr_session *session, GPollFD *pollfd,
  * @param session The session to use. Must not be NULL.
  * @param fd The file descriptor.
  * @param events Events to check for.
- * @param timeout Max time to wait before the callback is called, ignored if 0.
+ * @param timeout Max time in ms to wait before the callback is called,
+ *                or -1 to wait indefinitely.
  * @param cb Callback function to add. Must not be NULL.
  * @param cb_data Data for the callback function. Can be NULL.
  *
@@ -853,18 +981,25 @@ SR_API int sr_session_source_add(struct sr_session *session, int fd,
 {
 	GPollFD p;
 
+	if (fd < 0 && timeout < 0) {
+		sr_err("Timer source without timeout would block indefinitely");
+		return SR_ERR_ARG;
+	}
 	p.fd = fd;
 	p.events = events;
+	p.revents = 0;
 
-	return _sr_session_source_add(session, &p, timeout, cb, cb_data, (gintptr)fd);
+	return sr_session_source_add_internal(session,
+		&p, (fd < 0) ? 0 : 1, timeout, cb, cb_data, fd);
 }
 
 /**
  * Add an event source for a GPollFD.
  *
  * @param session The session to use. Must not be NULL.
- * @param pollfd The GPollFD.
- * @param timeout Max time to wait before the callback is called, ignored if 0.
+ * @param pollfd The GPollFD. Must not be NULL.
+ * @param timeout Max time in ms to wait before the callback is called,
+ *                or -1 to wait indefinitely.
  * @param cb Callback function to add. Must not be NULL.
  * @param cb_data Data for the callback function. Can be NULL.
  *
@@ -877,8 +1012,12 @@ SR_API int sr_session_source_add_pollfd(struct sr_session *session,
 		GPollFD *pollfd, int timeout, sr_receive_data_callback cb,
 		void *cb_data)
 {
-	return _sr_session_source_add(session, pollfd, timeout, cb,
-			cb_data, (gintptr)pollfd);
+	if (!pollfd) {
+		sr_err("%s: pollfd was NULL", __func__);
+		return SR_ERR_ARG;
+	}
+	return sr_session_source_add_internal(session, pollfd, 1,
+			timeout, cb, cb_data, (gintptr)pollfd);
 }
 
 /**
@@ -887,7 +1026,8 @@ SR_API int sr_session_source_add_pollfd(struct sr_session *session,
  * @param session The session to use. Must not be NULL.
  * @param channel The GIOChannel.
  * @param events Events to poll on.
- * @param timeout Max time to wait before the callback is called, ignored if 0.
+ * @param timeout Max time in ms to wait before the callback is called,
+ *                or -1 to wait indefinitely.
  * @param cb Callback function to add. Must not be NULL.
  * @param cb_data Data for the callback function. Can be NULL.
  *
@@ -902,57 +1042,58 @@ SR_API int sr_session_source_add_channel(struct sr_session *session,
 {
 	GPollFD p;
 
-#ifdef _WIN32
+#ifdef G_OS_WIN32
 	g_io_channel_win32_make_pollfd(channel, events, &p);
 #else
 	p.fd = g_io_channel_unix_get_fd(channel);
 	p.events = events;
+	p.revents = 0;
 #endif
-
-	return _sr_session_source_add(session, &p, timeout, cb, cb_data, (gintptr)channel);
+	return sr_session_source_add_internal(session, &p, 1,
+			timeout, cb, cb_data, (gintptr)channel);
 }
 
 /**
- * Remove the source belonging to the specified channel.
+ * Remove the source identified by the specified poll object.
  *
  * @param session The session to use. Must not be NULL.
  * @param poll_object The channel for which the source should be removed.
  *
  * @retval SR_OK Success
- * @retval SR_ERR_ARG Invalid arguments
- * @retval SR_ERR_BUG Internal error
+ * @retval SR_ERR_BUG No event source for poll_object found.
  */
-static int _sr_session_source_remove(struct sr_session *session, gintptr poll_object)
+SR_PRIV int sr_session_source_remove_internal(struct sr_session *session,
+		gintptr poll_object)
 {
-	unsigned int old;
-
-	if (!session->sources || !session->num_sources) {
-		sr_err("%s: sources was NULL", __func__);
-		return SR_ERR_BUG;
-	}
-
-	for (old = 0; old < session->num_sources; old++) {
-		if (session->sources[old].poll_object == poll_object)
-			break;
-	}
-
-	/* fd not found, nothing to do */
-	if (old == session->num_sources)
-		return SR_OK;
+	struct source *source;
+	unsigned int i;
+	int fd_index = 0;
 
-	session->num_sources--;
+	for (i = 0; i < session->sources->len; ++i) {
+		source = &g_array_index(session->sources, struct source, i);
 
-	if (old != session->num_sources) {
-		memmove(&session->pollfds[old], &session->pollfds[old + 1],
-			(session->num_sources - old) * sizeof(GPollFD));
-		memmove(&session->sources[old], &session->sources[old + 1],
-			(session->num_sources - old) * sizeof(struct source));
+		if (source->poll_object == poll_object) {
+			if (source->num_fds > 0)
+				g_array_remove_range(session->pollfds,
+						fd_index, source->num_fds);
+			g_array_remove_index(session->sources, i);
+			/*
+			 * This is a bit of a hack. To be removed when
+			 * porting over to the GLib main loop.
+			 */
+			if (poll_object == (gintptr)session->ctx->libusb_ctx)
+				session->ctx->usb_source_present = FALSE;
+			return SR_OK;
+		}
+		fd_index += source->num_fds;
 	}
+	/* Trying to remove an already removed event source is problematic
+	 * since the poll_object handle may have been reused in the meantime.
+	 */
+	sr_warn("Cannot remove non-existing event source for object %"
+		G_GINTPTR_FORMAT ".", poll_object);
 
-	session->pollfds = g_realloc(session->pollfds, sizeof(GPollFD) * session->num_sources);
-	session->sources = g_realloc(session->sources, sizeof(struct source) * session->num_sources);
-
-	return SR_OK;
+	return SR_ERR_BUG;
 }
 
 /**
@@ -969,7 +1110,7 @@ static int _sr_session_source_remove(struct sr_session *session, gintptr poll_ob
  */
 SR_API int sr_session_source_remove(struct sr_session *session, int fd)
 {
-	return _sr_session_source_remove(session, (gintptr)fd);
+	return sr_session_source_remove_internal(session, fd);
 }
 
 /**
@@ -977,7 +1118,7 @@ SR_API int sr_session_source_remove(struct sr_session *session, int fd)
  *
  * @param session The session to use. Must not be NULL.
  * @param pollfd The poll descriptor for which the source should be removed.
- *
+ *               Must not be NULL.
  * @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.
@@ -987,7 +1128,11 @@ SR_API int sr_session_source_remove(struct sr_session *session, int fd)
 SR_API int sr_session_source_remove_pollfd(struct sr_session *session,
 		GPollFD *pollfd)
 {
-	return _sr_session_source_remove(session, (gintptr)pollfd);
+	if (!pollfd) {
+		sr_err("%s: pollfd was NULL", __func__);
+		return SR_ERR_ARG;
+	}
+	return sr_session_source_remove_internal(session, (gintptr)pollfd);
 }
 
 /**
@@ -995,7 +1140,7 @@ SR_API int sr_session_source_remove_pollfd(struct sr_session *session,
  *
  * @param session The session to use. Must not be NULL.
  * @param channel The channel for which the source should be removed.
- *
+ *                Must not be NULL.
  * @retval SR_OK Success.
  * @retval SR_ERR_ARG Invalid argument.
  * @return SR_ERR_BUG Internal error.
@@ -1005,7 +1150,11 @@ SR_API int sr_session_source_remove_pollfd(struct sr_session *session,
 SR_API int sr_session_source_remove_channel(struct sr_session *session,
 		GIOChannel *channel)
 {
-	return _sr_session_source_remove(session, (gintptr)channel);
+	if (!channel) {
+		sr_err("%s: channel was NULL", __func__);
+		return SR_ERR_ARG;
+	}
+	return sr_session_source_remove_internal(session, (gintptr)channel);
 }
 
 static void copy_src(struct sr_config *src, struct sr_datafeed_meta *meta_copy)