2 * This file is part of the libsigrok project.
4 * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
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.
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.
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/>.
26 #include <libsigrok/libsigrok.h>
27 #include "libsigrok-internal.h"
30 #define LOG_PREFIX "session"
36 * Creating, using, or destroying libsigrok sessions.
40 * @defgroup grp_session Session handling
42 * Creating, using, or destroying libsigrok sessions.
48 int64_t timeout; /* microseconds */
49 int64_t due; /* microseconds */
51 sr_receive_data_callback cb;
54 /* This is used to keep track of the object (fd, pollfd or channel) which is
55 * being polled and will be used to match the source when removing it again.
59 /* Number of fds to poll for this source. This will be 0 for timer
60 * sources, 1 for normal I/O sources, and 1 or more for libusb I/O
61 * sources on Unix platforms.
68 struct datafeed_callback {
69 sr_datafeed_callback cb;
74 * Create a new session.
76 * @param ctx The context in which to create the new session.
77 * @param new_session This will contain a pointer to the newly created
78 * session if the return value is SR_OK, otherwise the value
79 * is undefined and should not be used. Must not be NULL.
81 * @retval SR_OK Success.
82 * @retval SR_ERR_ARG Invalid argument.
86 SR_API int sr_session_new(struct sr_context *ctx,
87 struct sr_session **new_session)
89 struct sr_session *session;
94 session = g_malloc0(sizeof(struct sr_session));
98 session->sources = g_array_new(FALSE, FALSE, sizeof(struct source));
99 session->pollfds = g_array_new(FALSE, FALSE, sizeof(GPollFD));
101 g_mutex_init(&session->stop_mutex);
103 *new_session = session;
110 * This frees up all memory used by the session.
112 * @param session The session to destroy. Must not be NULL.
114 * @retval SR_OK Success.
115 * @retval SR_ERR_ARG Invalid session passed.
119 SR_API int sr_session_destroy(struct sr_session *session)
122 sr_err("%s: session was NULL", __func__);
126 sr_session_dev_remove_all(session);
127 g_mutex_clear(&session->stop_mutex);
128 if (session->trigger)
129 sr_trigger_free(session->trigger);
131 g_slist_free_full(session->owned_devs, (GDestroyNotify)sr_dev_inst_free);
133 g_array_unref(session->pollfds);
134 g_array_unref(session->sources);
142 * Remove all the devices from a session.
144 * The session itself (i.e., the struct sr_session) is not free'd and still
145 * exists after this function returns.
147 * @param session The session to use. Must not be NULL.
149 * @retval SR_OK Success.
150 * @retval SR_ERR_BUG Invalid session passed.
154 SR_API int sr_session_dev_remove_all(struct sr_session *session)
156 struct sr_dev_inst *sdi;
160 sr_err("%s: session was NULL", __func__);
164 for (l = session->devs; l; l = l->next) {
165 sdi = (struct sr_dev_inst *) l->data;
169 g_slist_free(session->devs);
170 session->devs = NULL;
176 * Add a device instance to a session.
178 * @param session The session to add to. Must not be NULL.
179 * @param sdi The device instance to add to a session. Must not
180 * be NULL. Also, sdi->driver and sdi->driver->dev_open must
183 * @retval SR_OK Success.
184 * @retval SR_ERR_ARG Invalid argument.
188 SR_API int sr_session_dev_add(struct sr_session *session,
189 struct sr_dev_inst *sdi)
194 sr_err("%s: sdi was NULL", __func__);
199 sr_err("%s: session was NULL", __func__);
203 /* If sdi->session is not NULL, the device is already in this or
204 * another session. */
206 sr_err("%s: already assigned to session", __func__);
210 /* If sdi->driver is NULL, this is a virtual device. */
212 /* Just add the device, don't run dev_open(). */
213 session->devs = g_slist_append(session->devs, (gpointer)sdi);
214 sdi->session = session;
218 /* sdi->driver is non-NULL (i.e. we have a real device). */
219 if (!sdi->driver->dev_open) {
220 sr_err("%s: sdi->driver->dev_open was NULL", __func__);
224 session->devs = g_slist_append(session->devs, (gpointer)sdi);
225 sdi->session = session;
227 if (session->running) {
228 /* Adding a device to a running session. Commit settings
229 * and start acquisition on that device now. */
230 if ((ret = sr_config_commit(sdi)) != SR_OK) {
231 sr_err("Failed to commit device settings before "
232 "starting acquisition in running session (%s)",
236 if ((ret = sdi->driver->dev_acquisition_start(sdi,
237 (void *)sdi)) != SR_OK) {
238 sr_err("Failed to start acquisition of device in "
239 "running session (%s)", sr_strerror(ret));
248 * List all device instances attached to a session.
250 * @param session The session to use. Must not be NULL.
251 * @param devlist A pointer where the device instance list will be
252 * stored on return. If no devices are in the session,
253 * this will be NULL. Each element in the list points
254 * to a struct sr_dev_inst *.
255 * The list must be freed by the caller, but not the
256 * elements pointed to.
258 * @retval SR_OK Success.
259 * @retval SR_ERR_ARG Invalid argument.
263 SR_API int sr_session_dev_list(struct sr_session *session, GSList **devlist)
271 *devlist = g_slist_copy(session->devs);
277 * Remove all datafeed callbacks in a session.
279 * @param session The session to use. Must not be NULL.
281 * @retval SR_OK Success.
282 * @retval SR_ERR_ARG Invalid session passed.
286 SR_API int sr_session_datafeed_callback_remove_all(struct sr_session *session)
289 sr_err("%s: session was NULL", __func__);
293 g_slist_free_full(session->datafeed_callbacks, g_free);
294 session->datafeed_callbacks = NULL;
300 * Add a datafeed callback to a session.
302 * @param session The session to use. Must not be NULL.
303 * @param cb Function to call when a chunk of data is received.
305 * @param cb_data Opaque pointer passed in by the caller.
307 * @retval SR_OK Success.
308 * @retval SR_ERR_BUG No session exists.
312 SR_API int sr_session_datafeed_callback_add(struct sr_session *session,
313 sr_datafeed_callback cb, void *cb_data)
315 struct datafeed_callback *cb_struct;
318 sr_err("%s: session was NULL", __func__);
323 sr_err("%s: cb was NULL", __func__);
327 cb_struct = g_malloc0(sizeof(struct datafeed_callback));
329 cb_struct->cb_data = cb_data;
331 session->datafeed_callbacks =
332 g_slist_append(session->datafeed_callbacks, cb_struct);
338 * Get the trigger assigned to this session.
340 * @param session The session to use.
342 * @retval NULL Invalid (NULL) session was passed to the function.
343 * @retval other The trigger assigned to this session (can be NULL).
347 SR_API struct sr_trigger *sr_session_trigger_get(struct sr_session *session)
352 return session->trigger;
356 * Set the trigger of this session.
358 * @param session The session to use. Must not be NULL.
359 * @param trig The trigger to assign to this session. Can be NULL.
361 * @retval SR_OK Success.
362 * @retval SR_ERR_ARG Invalid argument.
366 SR_API int sr_session_trigger_set(struct sr_session *session, struct sr_trigger *trig)
371 session->trigger = trig;
376 static gboolean sr_session_check_aborted(struct sr_session *session)
380 g_mutex_lock(&session->stop_mutex);
381 stop = session->abort_session;
383 sr_session_stop_sync(session);
384 /* But once is enough. */
385 session->abort_session = FALSE;
387 g_mutex_unlock(&session->stop_mutex);
393 * Poll the session's event sources.
395 * @param session The session to use. Must not be NULL.
396 * @retval SR_OK Success.
397 * @retval SR_ERR Error occurred.
399 static int sr_session_iteration(struct sr_session *session)
401 int64_t start_time, stop_time, min_due, due;
408 gboolean triggered, stopped;
409 struct source *source;
417 if (session->sources->len == 0) {
418 sr_session_check_aborted(session);
421 start_time = g_get_monotonic_time();
424 for (i = 0; i < session->sources->len; ++i) {
425 source = &g_array_index(session->sources, struct source, i);
426 if (source->due < min_due)
427 min_due = source->due;
428 source->triggered = FALSE;
432 if (session->ctx->usb_source_present) {
433 ret = libusb_get_next_timeout(session->ctx->libusb_ctx, &tv);
435 sr_err("Error getting libusb timeout: %s",
436 libusb_error_name(ret));
438 } else if (ret == 1) {
439 usb_timeout = (int64_t)tv.tv_sec * G_USEC_PER_SEC
441 usb_due = start_time + usb_timeout;
442 if (usb_due < min_due)
445 sr_spew("poll: next USB timeout %g ms",
450 if (min_due == INT64_MAX)
452 else if (min_due > start_time)
453 timeout_ms = MIN((min_due - start_time + 999) / 1000, INT_MAX);
457 sr_spew("poll enter: %u sources, %u fds, %d ms timeout",
458 session->sources->len, session->pollfds->len, timeout_ms);
460 ret = g_poll((GPollFD *)session->pollfds->data,
461 session->pollfds->len, timeout_ms);
463 if (ret < 0 && errno != EINTR) {
464 sr_err("Error in poll: %s", g_strerror(errno));
469 sr_err("Error in poll: %d", ret);
473 stop_time = g_get_monotonic_time();
475 sr_spew("poll leave: %g ms elapsed, %d events",
476 1e-3 * (stop_time - start_time), ret);
482 for (i = 0; i < session->sources->len; ++i) {
483 source = &g_array_index(session->sources, struct source, i);
485 poll_object = source->poll_object;
486 fd = (int)poll_object;
489 for (k = 0; k < source->num_fds; ++k) {
490 pollfd = &g_array_index(session->pollfds,
491 GPollFD, fd_index + k);
493 revents |= pollfd->revents;
495 fd_index += source->num_fds;
497 if (source->triggered)
498 continue; /* already handled */
499 if (ret > 0 && revents == 0)
500 continue; /* skip timeouts if any I/O event occurred */
502 /* Make invalid to avoid confusion in case of multiple FDs. */
503 if (source->num_fds > 1)
510 if (usb_due < due && poll_object
511 == (gintptr)session->ctx->libusb_ctx)
514 if (revents == 0 && stop_time < due)
517 * The source may be gone after the callback returns,
518 * so access any data now that needs accessing.
520 if (source->timeout >= 0)
521 source->due = stop_time + source->timeout;
522 source->triggered = TRUE;
525 * Invoke the source's callback on an event or timeout.
527 sr_spew("callback for event source %" G_GINTPTR_FORMAT " with"
528 " event mask 0x%.2X", poll_object, (unsigned)revents);
529 if (!source->cb(fd, revents, source->cb_data)) {
530 /* Hackish, to be cleaned up when porting to
531 * the GLib main loop.
533 if (poll_object == (gintptr)session->ctx->libusb_ctx)
534 usb_source_remove(session, session->ctx);
536 sr_session_source_remove_internal(session,
540 * We want to take as little time as possible to stop
541 * the session if we have been told to do so. Therefore,
542 * we check the flag after processing every source, not
543 * just once per main event loop.
546 stopped = sr_session_check_aborted(session);
548 /* Restart loop as the sources list may have changed. */
553 /* Check for abort at least once per iteration. */
555 sr_session_check_aborted(session);
560 static int verify_trigger(struct sr_trigger *trigger)
562 struct sr_trigger_stage *stage;
563 struct sr_trigger_match *match;
566 if (!trigger->stages) {
567 sr_err("No trigger stages defined.");
571 sr_spew("Checking trigger:");
572 for (l = trigger->stages; l; l = l->next) {
574 if (!stage->matches) {
575 sr_err("Stage %d has no matches defined.", stage->stage);
578 for (m = stage->matches; m; m = m->next) {
580 if (!match->channel) {
581 sr_err("Stage %d match has no channel.", stage->stage);
585 sr_err("Stage %d match is not defined.", stage->stage);
588 sr_spew("Stage %d match on channel %s, match %d", stage->stage,
589 match->channel->name, match->match);
599 * @param session The session to use. Must not be NULL.
601 * @retval SR_OK Success.
602 * @retval SR_ERR_ARG Invalid session passed.
606 SR_API int sr_session_start(struct sr_session *session)
608 struct sr_dev_inst *sdi;
609 struct sr_channel *ch;
611 int enabled_channels, ret;
614 sr_err("%s: session was NULL", __func__);
618 if (!session->devs) {
619 sr_err("%s: session->devs was NULL; a session "
620 "cannot be started without devices.", __func__);
624 if (session->trigger && verify_trigger(session->trigger) != SR_OK)
627 sr_info("Starting.");
630 for (l = session->devs; l; l = l->next) {
632 enabled_channels = 0;
633 for (c = sdi->channels; c; c = c->next) {
640 if (enabled_channels == 0) {
642 sr_err("%s using connection %s has no enabled channels!",
643 sdi->driver->name, sdi->connection_id);
647 if ((ret = sr_config_commit(sdi)) != SR_OK) {
648 sr_err("Failed to commit device settings before "
649 "starting acquisition (%s)", sr_strerror(ret));
652 if ((ret = sdi->driver->dev_acquisition_start(sdi, sdi)) != SR_OK) {
653 sr_err("%s: could not start an acquisition "
654 "(%s)", __func__, sr_strerror(ret));
659 /* TODO: What if there are multiple devices? Which return code? */
667 * @param session The session to use. Must not be NULL.
669 * @retval SR_OK Success.
670 * @retval SR_ERR_ARG Invalid session passed.
671 * @retval SR_ERR Error during event processing.
675 SR_API int sr_session_run(struct sr_session *session)
680 sr_err("%s: session was NULL", __func__);
684 if (!session->devs) {
685 /* TODO: Actually the case? */
686 sr_err("%s: session->devs was NULL; a session "
687 "cannot be run without devices.", __func__);
690 session->running = TRUE;
694 /* Poll event sources until none are left. */
695 while (session->sources->len > 0) {
696 ret = sr_session_iteration(session);
706 * The session is stopped immediately, with all acquisition sessions stopped
707 * and hardware drivers cleaned up.
709 * This must be called from within the session thread, to prevent freeing
710 * resources that the session thread will try to use.
712 * @param session The session to use. Must not be NULL.
714 * @retval SR_OK Success.
715 * @retval SR_ERR_ARG Invalid session passed.
719 SR_PRIV int sr_session_stop_sync(struct sr_session *session)
721 struct sr_dev_inst *sdi;
725 sr_err("%s: session was NULL", __func__);
729 sr_info("Stopping.");
731 for (l = session->devs; l; l = l->next) {
734 if (sdi->driver->dev_acquisition_stop)
735 sdi->driver->dev_acquisition_stop(sdi, sdi);
738 session->running = FALSE;
746 * The session is stopped immediately, with all acquisition sessions being
747 * stopped and hardware drivers cleaned up.
749 * If the session is run in a separate thread, this function will not block
750 * until the session is finished executing. It is the caller's responsibility
751 * to wait for the session thread to return before assuming that the session is
752 * completely decommissioned.
754 * @param session The session to use. Must not be NULL.
756 * @retval SR_OK Success.
757 * @retval SR_ERR_ARG Invalid session passed.
761 SR_API int sr_session_stop(struct sr_session *session)
764 sr_err("%s: session was NULL", __func__);
768 g_mutex_lock(&session->stop_mutex);
769 session->abort_session = TRUE;
770 g_mutex_unlock(&session->stop_mutex);
778 * @param packet The packet to show debugging information for.
780 static void datafeed_dump(const struct sr_datafeed_packet *packet)
782 const struct sr_datafeed_logic *logic;
783 const struct sr_datafeed_analog *analog;
784 const struct sr_datafeed_analog2 *analog2;
786 /* Please use the same order as in libsigrok.h. */
787 switch (packet->type) {
789 sr_dbg("bus: Received SR_DF_HEADER packet.");
792 sr_dbg("bus: Received SR_DF_END packet.");
795 sr_dbg("bus: Received SR_DF_META packet.");
798 sr_dbg("bus: Received SR_DF_TRIGGER packet.");
801 logic = packet->payload;
802 sr_dbg("bus: Received SR_DF_LOGIC packet (%" PRIu64 " bytes, "
803 "unitsize = %d).", logic->length, logic->unitsize);
806 analog = packet->payload;
807 sr_dbg("bus: Received SR_DF_ANALOG packet (%d samples).",
808 analog->num_samples);
810 case SR_DF_FRAME_BEGIN:
811 sr_dbg("bus: Received SR_DF_FRAME_BEGIN packet.");
813 case SR_DF_FRAME_END:
814 sr_dbg("bus: Received SR_DF_FRAME_END packet.");
817 analog2 = packet->payload;
818 sr_dbg("bus: Received SR_DF_ANALOG2 packet (%d samples).",
819 analog2->num_samples);
822 sr_dbg("bus: Received unknown packet type: %d.", packet->type);
828 * Send a packet to whatever is listening on the datafeed bus.
830 * Hardware drivers use this to send a data packet to the frontend.
833 * @param packet The datafeed packet to send to the session bus.
835 * @retval SR_OK Success.
836 * @retval SR_ERR_ARG Invalid argument.
840 SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
841 const struct sr_datafeed_packet *packet)
844 struct datafeed_callback *cb_struct;
845 struct sr_datafeed_packet *packet_in, *packet_out;
846 struct sr_transform *t;
850 sr_err("%s: sdi was NULL", __func__);
855 sr_err("%s: packet was NULL", __func__);
860 sr_err("%s: session was NULL", __func__);
865 * Pass the packet to the first transform module. If that returns
866 * another packet (instead of NULL), pass that packet to the next
867 * transform module in the list, and so on.
869 packet_in = (struct sr_datafeed_packet *)packet;
870 for (l = sdi->session->transforms; l; l = l->next) {
872 sr_spew("Running transform module '%s'.", t->module->id);
873 ret = t->module->receive(t, packet_in, &packet_out);
875 sr_err("Error while running transform module: %d.", ret);
880 * If any of the transforms don't return an output
883 sr_spew("Transform module didn't return a packet, aborting.");
887 * Use this transform module's output packet as input
888 * for the next transform module.
890 packet_in = packet_out;
896 * If the last transform did output a packet, pass it to all datafeed
899 for (l = sdi->session->datafeed_callbacks; l; l = l->next) {
900 if (sr_log_loglevel_get() >= SR_LOG_DBG)
901 datafeed_dump(packet);
903 cb_struct->cb(sdi, packet, cb_struct->cb_data);
910 * Add an event source for a file descriptor.
912 * @param session The session to use. Must not be NULL.
913 * @param[in] timeout Max time in ms to wait before the callback is called,
914 * or -1 to wait indefinitely.
915 * @param cb Callback function to add. Must not be NULL.
916 * @param cb_data Data for the callback function. Can be NULL.
917 * @param poll_object Handle by which the source is identified
919 * @retval SR_OK Success.
920 * @retval SR_ERR_ARG Invalid argument.
921 * @retval SR_ERR An event source for @a poll_object is already installed.
923 SR_PRIV int sr_session_source_add_internal(struct sr_session *session,
924 int timeout, sr_receive_data_callback cb, void *cb_data,
930 /* Note: cb_data can be NULL, that's not a bug. */
932 sr_err("%s: cb was NULL", __func__);
935 /* Make sure that poll_object is unique.
937 for (i = 0; i < session->sources->len; ++i) {
938 if (g_array_index(session->sources, struct source, i)
939 .poll_object == poll_object) {
940 sr_err("Event source %" G_GINTPTR_FORMAT
941 " already installed.", poll_object);
945 sr_dbg("Installing event source %" G_GINTPTR_FORMAT
946 " with %d ms timeout.", poll_object, timeout);
948 src.cb_data = cb_data;
949 src.poll_object = poll_object;
951 src.triggered = FALSE;
954 src.timeout = INT64_C(1000) * timeout;
955 src.due = g_get_monotonic_time() + src.timeout;
960 g_array_append_val(session->sources, src);
965 SR_PRIV int sr_session_source_poll_add(struct sr_session *session,
966 gintptr poll_object, gintptr fd, int events)
968 struct source *source;
976 /* Look up existing event source.
978 for (i = 0; i < session->sources->len; ++i) {
979 source = &g_array_index(session->sources, struct source, i);
980 if (source->poll_object == poll_object)
982 fd_index += source->num_fds;
985 sr_err("Cannot add poll FD %" G_GINTPTR_FORMAT
986 " to non-existing event source %" G_GINTPTR_FORMAT
987 ".", fd, poll_object);
990 /* Make sure the FD is unique.
992 for (k = 0; k < source->num_fds; ++k)
993 if (g_array_index(session->pollfds, GPollFD, fd_index + k)
995 sr_err("Cannot add poll FD %" G_GINTPTR_FORMAT
996 " twice to event source %" G_GINTPTR_FORMAT
997 ".", fd, poll_object);
1002 pollfd.events = events;
1005 g_array_insert_val(session->pollfds,
1006 fd_index + source->num_fds, pollfd);
1009 sr_dbg("Added poll FD %" G_GINTPTR_FORMAT " with event mask 0x%.2X"
1010 " to event source %" G_GINTPTR_FORMAT ".",
1011 fd, (unsigned)events, poll_object);
1017 * Add an event source for a file descriptor.
1019 * @param session The session to use. Must not be NULL.
1020 * @param fd The file descriptor, or a negative value to create a timer source.
1021 * @param events Events to check for.
1022 * @param timeout Max time in ms to wait before the callback is called,
1023 * or -1 to wait indefinitely.
1024 * @param cb Callback function to add. Must not be NULL.
1025 * @param cb_data Data for the callback function. Can be NULL.
1027 * @retval SR_OK Success.
1028 * @retval SR_ERR_ARG Invalid argument.
1032 SR_API int sr_session_source_add(struct sr_session *session, int fd,
1033 int events, int timeout, sr_receive_data_callback cb, void *cb_data)
1037 if (fd < 0 && timeout < 0) {
1038 sr_err("Timer source without timeout would block indefinitely");
1041 ret = sr_session_source_add_internal(session, timeout, cb, cb_data, fd);
1042 if (ret != SR_OK || fd < 0)
1045 return sr_session_source_poll_add(session, fd, fd, events);
1049 * Add an event source for a GPollFD.
1051 * @param session The session to use. Must not be NULL.
1052 * @param pollfd The GPollFD. Must not be NULL.
1053 * @param timeout Max time in ms to wait before the callback is called,
1054 * or -1 to wait indefinitely.
1055 * @param cb Callback function to add. Must not be NULL.
1056 * @param cb_data Data for the callback function. Can be NULL.
1058 * @retval SR_OK Success.
1059 * @retval SR_ERR_ARG Invalid argument.
1063 SR_API int sr_session_source_add_pollfd(struct sr_session *session,
1064 GPollFD *pollfd, int timeout, sr_receive_data_callback cb,
1070 sr_err("%s: pollfd was NULL", __func__);
1073 ret = sr_session_source_add_internal(session,
1074 timeout, cb, cb_data, (gintptr)pollfd);
1078 return sr_session_source_poll_add(session,
1079 (gintptr)pollfd, pollfd->fd, pollfd->events);
1083 * Add an event source for a GIOChannel.
1085 * @param session The session to use. Must not be NULL.
1086 * @param channel The GIOChannel.
1087 * @param events Events to poll on.
1088 * @param timeout Max time in ms to wait before the callback is called,
1089 * or -1 to wait indefinitely.
1090 * @param cb Callback function to add. Must not be NULL.
1091 * @param cb_data Data for the callback function. Can be NULL.
1093 * @retval SR_OK Success.
1094 * @retval SR_ERR_ARG Invalid argument.
1098 SR_API int sr_session_source_add_channel(struct sr_session *session,
1099 GIOChannel *channel, int events, int timeout,
1100 sr_receive_data_callback cb, void *cb_data)
1104 ret = sr_session_source_add_internal(session,
1105 timeout, cb, cb_data, (gintptr)channel);
1110 g_io_channel_win32_make_pollfd(channel, events, &p);
1112 return sr_session_source_poll_add(session,
1113 (gintptr)channel, p.fd, p.events);
1115 return sr_session_source_poll_add(session, (gintptr)channel,
1116 g_io_channel_unix_get_fd(channel), events);
1121 * Remove the source identified by the specified poll object.
1123 * @param session The session to use. Must not be NULL.
1124 * @param poll_object The channel for which the source should be removed.
1126 * @retval SR_OK Success
1127 * @retval SR_ERR_BUG No event source for poll_object found.
1129 SR_PRIV int sr_session_source_remove_internal(struct sr_session *session,
1130 gintptr poll_object)
1132 struct source *source;
1136 for (i = 0; i < session->sources->len; ++i) {
1137 source = &g_array_index(session->sources, struct source, i);
1139 if (source->poll_object == poll_object) {
1140 if (source->num_fds > 0)
1141 g_array_remove_range(session->pollfds,
1142 fd_index, source->num_fds);
1143 g_array_remove_index(session->sources, i);
1145 * This is a bit of a hack. To be removed when
1146 * porting over to the GLib main loop.
1148 if (poll_object == (gintptr)session->ctx->libusb_ctx)
1149 session->ctx->usb_source_present = FALSE;
1151 sr_dbg("Removed event source %" G_GINTPTR_FORMAT ".",
1155 fd_index += source->num_fds;
1157 /* Trying to remove an already removed event source is problematic
1158 * since the poll_object handle may have been reused in the meantime.
1160 sr_warn("Cannot remove non-existing event source %"
1161 G_GINTPTR_FORMAT ".", poll_object);
1166 SR_PRIV int sr_session_source_poll_remove(struct sr_session *session,
1167 gintptr poll_object, gintptr fd)
1169 struct source *source;
1176 /* Look up existing event source.
1178 for (i = 0; i < session->sources->len; ++i) {
1179 source = &g_array_index(session->sources, struct source, i);
1180 if (source->poll_object == poll_object)
1182 fd_index += source->num_fds;
1185 sr_err("Cannot remove poll FD %" G_GINTPTR_FORMAT
1186 " from non-existing event source %" G_GINTPTR_FORMAT
1187 ".", fd, poll_object);
1190 /* Look up the FD in the poll set.
1192 for (k = 0; k < source->num_fds; ++k)
1193 if (g_array_index(session->pollfds, GPollFD, fd_index + k)
1196 g_array_remove_index(session->pollfds, fd_index + k);
1199 sr_dbg("Removed poll FD %" G_GINTPTR_FORMAT
1200 " from event source %" G_GINTPTR_FORMAT ".",
1205 sr_err("Cannot remove non-existing poll FD %" G_GINTPTR_FORMAT
1206 " from event source %" G_GINTPTR_FORMAT ".",
1213 * Remove the source belonging to the specified file descriptor.
1215 * @param session The session to use. Must not be NULL.
1216 * @param fd The file descriptor for which the source should be removed.
1218 * @retval SR_OK Success
1219 * @retval SR_ERR_ARG Invalid argument
1220 * @retval SR_ERR_BUG Internal error.
1224 SR_API int sr_session_source_remove(struct sr_session *session, int fd)
1226 return sr_session_source_remove_internal(session, fd);
1230 * Remove the source belonging to the specified poll descriptor.
1232 * @param session The session to use. Must not be NULL.
1233 * @param pollfd The poll descriptor for which the source should be removed.
1235 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
1236 * SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon
1241 SR_API int sr_session_source_remove_pollfd(struct sr_session *session,
1245 sr_err("%s: pollfd was NULL", __func__);
1248 return sr_session_source_remove_internal(session, (gintptr)pollfd);
1252 * Remove the source belonging to the specified channel.
1254 * @param session The session to use. Must not be NULL.
1255 * @param channel The channel for which the source should be removed.
1257 * @retval SR_OK Success.
1258 * @retval SR_ERR_ARG Invalid argument.
1259 * @return SR_ERR_BUG Internal error.
1263 SR_API int sr_session_source_remove_channel(struct sr_session *session,
1264 GIOChannel *channel)
1267 sr_err("%s: channel was NULL", __func__);
1270 return sr_session_source_remove_internal(session, (gintptr)channel);
1273 static void copy_src(struct sr_config *src, struct sr_datafeed_meta *meta_copy)
1275 g_variant_ref(src->data);
1276 meta_copy->config = g_slist_append(meta_copy->config,
1277 g_memdup(src, sizeof(struct sr_config)));
1280 SR_PRIV int sr_packet_copy(const struct sr_datafeed_packet *packet,
1281 struct sr_datafeed_packet **copy)
1283 const struct sr_datafeed_meta *meta;
1284 struct sr_datafeed_meta *meta_copy;
1285 const struct sr_datafeed_logic *logic;
1286 struct sr_datafeed_logic *logic_copy;
1287 const struct sr_datafeed_analog *analog;
1288 struct sr_datafeed_analog *analog_copy;
1291 *copy = g_malloc0(sizeof(struct sr_datafeed_packet));
1292 (*copy)->type = packet->type;
1294 switch (packet->type) {
1300 payload = g_malloc(sizeof(struct sr_datafeed_header));
1301 memcpy(payload, packet->payload, sizeof(struct sr_datafeed_header));
1302 (*copy)->payload = payload;
1305 meta = packet->payload;
1306 meta_copy = g_malloc0(sizeof(struct sr_datafeed_meta));
1307 g_slist_foreach(meta->config, (GFunc)copy_src, meta_copy->config);
1308 (*copy)->payload = meta_copy;
1311 logic = packet->payload;
1312 logic_copy = g_malloc(sizeof(logic));
1313 logic_copy->length = logic->length;
1314 logic_copy->unitsize = logic->unitsize;
1315 memcpy(logic_copy->data, logic->data, logic->length * logic->unitsize);
1316 (*copy)->payload = logic_copy;
1319 analog = packet->payload;
1320 analog_copy = g_malloc(sizeof(analog));
1321 analog_copy->channels = g_slist_copy(analog->channels);
1322 analog_copy->num_samples = analog->num_samples;
1323 analog_copy->mq = analog->mq;
1324 analog_copy->unit = analog->unit;
1325 analog_copy->mqflags = analog->mqflags;
1326 memcpy(analog_copy->data, analog->data,
1327 analog->num_samples * sizeof(float));
1328 (*copy)->payload = analog_copy;
1331 sr_err("Unknown packet type %d", packet->type);
1338 void sr_packet_free(struct sr_datafeed_packet *packet)
1340 const struct sr_datafeed_meta *meta;
1341 const struct sr_datafeed_logic *logic;
1342 const struct sr_datafeed_analog *analog;
1343 struct sr_config *src;
1346 switch (packet->type) {
1352 /* Payload is a simple struct. */
1353 g_free((void *)packet->payload);
1356 meta = packet->payload;
1357 for (l = meta->config; l; l = l->next) {
1359 g_variant_unref(src->data);
1362 g_slist_free(meta->config);
1363 g_free((void *)packet->payload);
1366 logic = packet->payload;
1367 g_free(logic->data);
1368 g_free((void *)packet->payload);
1371 analog = packet->payload;
1372 g_slist_free(analog->channels);
1373 g_free(analog->data);
1374 g_free((void *)packet->payload);
1377 sr_err("Unknown packet type %d", packet->type);