2 * This file is part of the libsigrok project.
4 * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
5 * Copyright (C) 2015 Daniel Elstner <daniel.kitta@gmail.com>
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
28 #include <libsigrok/libsigrok.h>
29 #include "libsigrok-internal.h"
32 #define LOG_PREFIX "session"
38 * Creating, using, or destroying libsigrok sessions.
42 * @defgroup grp_session Session handling
44 * Creating, using, or destroying libsigrok sessions.
49 struct datafeed_callback {
50 sr_datafeed_callback cb;
54 /** Custom GLib event source for generic descriptor I/O.
55 * @see https://developer.gnome.org/glib/stable/glib-The-Main-Event-Loop.html
63 /* Meta-data needed to keep track of installed sources */
64 struct sr_session *session;
70 /** FD event source prepare() method.
71 * This is called immediately before poll().
73 static gboolean fd_source_prepare(GSource *source, int *timeout)
76 struct fd_source *fsource;
79 fsource = (struct fd_source *)source;
81 if (fsource->timeout_us >= 0) {
82 now_us = g_source_get_time(source);
84 if (fsource->due_us == 0) {
85 /* First-time initialization of the expiration time */
86 fsource->due_us = now_us + fsource->timeout_us;
88 remaining_ms = (MAX(0, fsource->due_us - now_us) + 999) / 1000;
92 *timeout = remaining_ms;
94 return (remaining_ms == 0);
97 /** FD event source check() method.
98 * This is called after poll() returns to check whether an event fired.
100 static gboolean fd_source_check(GSource *source)
102 struct fd_source *fsource;
103 unsigned int revents;
105 fsource = (struct fd_source *)source;
106 revents = fsource->pollfd.revents;
108 return (revents != 0 || (fsource->timeout_us >= 0
109 && fsource->due_us <= g_source_get_time(source)));
112 /** FD event source dispatch() method.
113 * This is called if either prepare() or check() returned TRUE.
115 static gboolean fd_source_dispatch(GSource *source,
116 GSourceFunc callback, void *user_data)
118 struct fd_source *fsource;
119 unsigned int revents;
122 fsource = (struct fd_source *)source;
123 revents = fsource->pollfd.revents;
126 sr_err("Callback not set, cannot dispatch event.");
127 return G_SOURCE_REMOVE;
129 keep = (*(sr_receive_data_callback)callback)
130 (fsource->pollfd.fd, revents, user_data);
132 if (fsource->timeout_us >= 0 && G_LIKELY(keep)
133 && G_LIKELY(!g_source_is_destroyed(source)))
134 fsource->due_us = g_source_get_time(source)
135 + fsource->timeout_us;
139 /** FD event source finalize() method.
141 static void fd_source_finalize(GSource *source)
143 struct fd_source *fsource;
145 fsource = (struct fd_source *)source;
147 sr_dbg("%s: key %p", __func__, fsource->key);
149 sr_session_source_destroyed(fsource->session, fsource->key, source);
152 /** Create an event source for I/O on a file descriptor.
154 * In order to maintain API compatibility, this event source also doubles
155 * as a timer event source.
157 * @param session The session the event source belongs to.
158 * @param key The key used to identify this source.
159 * @param fd The file descriptor or HANDLE.
160 * @param timeout_ms The timeout interval in ms, or -1 to wait indefinitely.
161 * @return A new event source object, or NULL on failure.
163 static GSource *fd_source_new(struct sr_session *session, void *key,
164 gintptr fd, int events, int timeout_ms)
166 static GSourceFuncs fd_source_funcs = {
167 .prepare = &fd_source_prepare,
168 .check = &fd_source_check,
169 .dispatch = &fd_source_dispatch,
170 .finalize = &fd_source_finalize
173 struct fd_source *fsource;
175 source = g_source_new(&fd_source_funcs, sizeof(struct fd_source));
176 fsource = (struct fd_source *)source;
178 g_source_set_name(source, (fd < 0) ? "timer" : "fd");
180 if (timeout_ms >= 0) {
181 fsource->timeout_us = 1000 * (int64_t)timeout_ms;
184 fsource->timeout_us = -1;
185 fsource->due_us = INT64_MAX;
187 fsource->session = session;
190 fsource->pollfd.fd = fd;
191 fsource->pollfd.events = events;
192 fsource->pollfd.revents = 0;
195 g_source_add_poll(source, &fsource->pollfd);
201 * Create a new session.
203 * @param ctx The context in which to create the new session.
204 * @param new_session This will contain a pointer to the newly created
205 * session if the return value is SR_OK, otherwise the value
206 * is undefined and should not be used. Must not be NULL.
208 * @retval SR_OK Success.
209 * @retval SR_ERR_ARG Invalid argument.
213 SR_API int sr_session_new(struct sr_context *ctx,
214 struct sr_session **new_session)
216 struct sr_session *session;
221 session = g_malloc0(sizeof(struct sr_session));
225 g_mutex_init(&session->main_mutex);
227 /* To maintain API compatibility, we need a lookup table
228 * which maps poll_object IDs to GSource* pointers.
230 session->event_sources = g_hash_table_new(NULL, NULL);
232 *new_session = session;
239 * This frees up all memory used by the session.
241 * @param session The session to destroy. Must not be NULL.
243 * @retval SR_OK Success.
244 * @retval SR_ERR_ARG Invalid session passed.
248 SR_API int sr_session_destroy(struct sr_session *session)
251 sr_err("%s: session was NULL", __func__);
255 sr_session_dev_remove_all(session);
256 g_slist_free_full(session->owned_devs, (GDestroyNotify)sr_dev_inst_free);
258 sr_session_datafeed_callback_remove_all(session);
260 g_hash_table_unref(session->event_sources);
262 g_mutex_clear(&session->main_mutex);
270 * Remove all the devices from a session.
272 * The session itself (i.e., the struct sr_session) is not free'd and still
273 * exists after this function returns.
275 * @param session The session to use. Must not be NULL.
277 * @retval SR_OK Success.
278 * @retval SR_ERR_BUG Invalid session passed.
282 SR_API int sr_session_dev_remove_all(struct sr_session *session)
284 struct sr_dev_inst *sdi;
288 sr_err("%s: session was NULL", __func__);
292 for (l = session->devs; l; l = l->next) {
293 sdi = (struct sr_dev_inst *) l->data;
297 g_slist_free(session->devs);
298 session->devs = NULL;
304 * Add a device instance to a session.
306 * @param session The session to add to. Must not be NULL.
307 * @param sdi The device instance to add to a session. Must not
308 * be NULL. Also, sdi->driver and sdi->driver->dev_open must
311 * @retval SR_OK Success.
312 * @retval SR_ERR_ARG Invalid argument.
316 SR_API int sr_session_dev_add(struct sr_session *session,
317 struct sr_dev_inst *sdi)
322 sr_err("%s: sdi was NULL", __func__);
327 sr_err("%s: session was NULL", __func__);
331 /* If sdi->session is not NULL, the device is already in this or
332 * another session. */
334 sr_err("%s: already assigned to session", __func__);
338 /* If sdi->driver is NULL, this is a virtual device. */
340 /* Just add the device, don't run dev_open(). */
341 session->devs = g_slist_append(session->devs, sdi);
342 sdi->session = session;
346 /* sdi->driver is non-NULL (i.e. we have a real device). */
347 if (!sdi->driver->dev_open) {
348 sr_err("%s: sdi->driver->dev_open was NULL", __func__);
352 session->devs = g_slist_append(session->devs, sdi);
353 sdi->session = session;
355 /* TODO: This is invalid if the session runs in a different thread.
356 * The usage semantics and restrictions need to be documented.
358 if (session->running) {
359 /* Adding a device to a running session. Commit settings
360 * and start acquisition on that device now. */
361 if ((ret = sr_config_commit(sdi)) != SR_OK) {
362 sr_err("Failed to commit device settings before "
363 "starting acquisition in running session (%s)",
367 if ((ret = sr_dev_acquisition_start(sdi)) != SR_OK) {
368 sr_err("Failed to start acquisition of device in "
369 "running session (%s)", sr_strerror(ret));
378 * List all device instances attached to a session.
380 * @param session The session to use. Must not be NULL.
381 * @param devlist A pointer where the device instance list will be
382 * stored on return. If no devices are in the session,
383 * this will be NULL. Each element in the list points
384 * to a struct sr_dev_inst *.
385 * The list must be freed by the caller, but not the
386 * elements pointed to.
388 * @retval SR_OK Success.
389 * @retval SR_ERR_ARG Invalid argument.
393 SR_API int sr_session_dev_list(struct sr_session *session, GSList **devlist)
401 *devlist = g_slist_copy(session->devs);
407 * Remove a device instance from a session.
409 * @param session The session to remove from. Must not be NULL.
410 * @param sdi The device instance to remove from a session. Must not
411 * be NULL. Also, sdi->driver and sdi->driver->dev_open must
414 * @retval SR_OK Success.
415 * @retval SR_ERR_ARG Invalid argument.
419 SR_API int sr_session_dev_remove(struct sr_session *session,
420 struct sr_dev_inst *sdi)
423 sr_err("%s: sdi was NULL", __func__);
428 sr_err("%s: session was NULL", __func__);
432 /* If sdi->session is not session, the device is not in this
434 if (sdi->session != session) {
435 sr_err("%s: not assigned to this session", __func__);
439 session->devs = g_slist_remove(session->devs, sdi);
446 * Remove all datafeed callbacks in a session.
448 * @param session The session to use. Must not be NULL.
450 * @retval SR_OK Success.
451 * @retval SR_ERR_ARG Invalid session passed.
455 SR_API int sr_session_datafeed_callback_remove_all(struct sr_session *session)
458 sr_err("%s: session was NULL", __func__);
462 g_slist_free_full(session->datafeed_callbacks, g_free);
463 session->datafeed_callbacks = NULL;
469 * Add a datafeed callback to a session.
471 * @param session The session to use. Must not be NULL.
472 * @param cb Function to call when a chunk of data is received.
474 * @param cb_data Opaque pointer passed in by the caller.
476 * @retval SR_OK Success.
477 * @retval SR_ERR_BUG No session exists.
481 SR_API int sr_session_datafeed_callback_add(struct sr_session *session,
482 sr_datafeed_callback cb, void *cb_data)
484 struct datafeed_callback *cb_struct;
487 sr_err("%s: session was NULL", __func__);
492 sr_err("%s: cb was NULL", __func__);
496 cb_struct = g_malloc0(sizeof(struct datafeed_callback));
498 cb_struct->cb_data = cb_data;
500 session->datafeed_callbacks =
501 g_slist_append(session->datafeed_callbacks, cb_struct);
507 * Get the trigger assigned to this session.
509 * @param session The session to use.
511 * @retval NULL Invalid (NULL) session was passed to the function.
512 * @retval other The trigger assigned to this session (can be NULL).
516 SR_API struct sr_trigger *sr_session_trigger_get(struct sr_session *session)
521 return session->trigger;
525 * Set the trigger of this session.
527 * @param session The session to use. Must not be NULL.
528 * @param trig The trigger to assign to this session. Can be NULL.
530 * @retval SR_OK Success.
531 * @retval SR_ERR_ARG Invalid argument.
535 SR_API int sr_session_trigger_set(struct sr_session *session, struct sr_trigger *trig)
540 session->trigger = trig;
545 static int verify_trigger(struct sr_trigger *trigger)
547 struct sr_trigger_stage *stage;
548 struct sr_trigger_match *match;
551 if (!trigger->stages) {
552 sr_err("No trigger stages defined.");
556 sr_spew("Checking trigger:");
557 for (l = trigger->stages; l; l = l->next) {
559 if (!stage->matches) {
560 sr_err("Stage %d has no matches defined.", stage->stage);
563 for (m = stage->matches; m; m = m->next) {
565 if (!match->channel) {
566 sr_err("Stage %d match has no channel.", stage->stage);
570 sr_err("Stage %d match is not defined.", stage->stage);
573 sr_spew("Stage %d match on channel %s, match %d", stage->stage,
574 match->channel->name, match->match);
581 /** Set up the main context the session will be executing in.
583 * Must be called just before the session starts, by the thread which
584 * will execute the session main loop. Once acquired, the main context
585 * pointer is immutable for the duration of the session run.
587 static int set_main_context(struct sr_session *session)
589 GMainContext *main_context;
591 g_mutex_lock(&session->main_mutex);
593 /* May happen if sr_session_start() is called a second time
594 * while the session is still running.
596 if (session->main_context) {
597 sr_err("Main context already set.");
599 g_mutex_unlock(&session->main_mutex);
602 main_context = g_main_context_ref_thread_default();
604 * Try to use an existing main context if possible, but only if we
605 * can make it owned by the current thread. Otherwise, create our
606 * own main context so that event source callbacks can execute in
607 * the session thread.
609 if (g_main_context_acquire(main_context)) {
610 g_main_context_release(main_context);
612 sr_dbg("Using thread-default main context.");
614 g_main_context_unref(main_context);
616 sr_dbg("Creating our own main context.");
617 main_context = g_main_context_new();
619 session->main_context = main_context;
621 g_mutex_unlock(&session->main_mutex);
626 /** Unset the main context used for the current session run.
628 * Must be called right after stopping the session. Note that if the
629 * session is stopped asynchronously, the main loop may still be running
630 * after the main context has been unset. This is OK as long as no new
631 * event sources are created -- the main loop holds its own reference
632 * to the main context.
634 static int unset_main_context(struct sr_session *session)
638 g_mutex_lock(&session->main_mutex);
640 if (session->main_context) {
641 g_main_context_unref(session->main_context);
642 session->main_context = NULL;
645 /* May happen if the set/unset calls are not matched.
647 sr_err("No main context to unset.");
650 g_mutex_unlock(&session->main_mutex);
655 static unsigned int session_source_attach(struct sr_session *session,
660 g_mutex_lock(&session->main_mutex);
662 if (session->main_context)
663 id = g_source_attach(source, session->main_context);
665 sr_err("Cannot add event source without main context.");
667 g_mutex_unlock(&session->main_mutex);
672 /* Idle handler; invoked when the number of registered event sources
673 * for a running session drops to zero.
675 static gboolean delayed_stop_check(void *data)
677 struct sr_session *session;
680 session->stop_check_id = 0;
682 /* Session already ended? */
683 if (!session->running)
684 return G_SOURCE_REMOVE;
686 /* New event sources may have been installed in the meantime. */
687 if (g_hash_table_size(session->event_sources) != 0)
688 return G_SOURCE_REMOVE;
690 session->running = FALSE;
691 unset_main_context(session);
695 /* This indicates a bug in user code, since it is not valid to
696 * restart or destroy a session while it may still be running.
698 if (!session->main_loop && !session->stopped_callback) {
699 sr_err("BUG: Session stop left unhandled.");
700 return G_SOURCE_REMOVE;
702 if (session->main_loop)
703 g_main_loop_quit(session->main_loop);
705 if (session->stopped_callback)
706 (*session->stopped_callback)(session->stopped_cb_data);
708 return G_SOURCE_REMOVE;
711 static int stop_check_later(struct sr_session *session)
714 unsigned int source_id;
716 if (session->stop_check_id != 0)
717 return SR_OK; /* idle handler already installed */
719 source = g_idle_source_new();
720 g_source_set_callback(source, &delayed_stop_check, session, NULL);
722 source_id = session_source_attach(session, source);
723 session->stop_check_id = source_id;
725 g_source_unref(source);
727 return (source_id != 0) ? SR_OK : SR_ERR;
733 * When this function returns with a status code indicating success, the
734 * session is running. Use sr_session_stopped_callback_set() to receive
735 * notification upon completion, or call sr_session_run() to block until
738 * Session events will be processed in the context of the current thread.
739 * If a thread-default GLib main context has been set, and is not owned by
740 * any other thread, it will be used. Otherwise, libsigrok will create its
741 * own main context for the current thread.
743 * @param session The session to use. Must not be NULL.
745 * @retval SR_OK Success.
746 * @retval SR_ERR_ARG Invalid session passed.
747 * @retval SR_ERR Other error.
751 SR_API int sr_session_start(struct sr_session *session)
753 struct sr_dev_inst *sdi;
754 struct sr_channel *ch;
755 GSList *l, *c, *lend;
759 sr_err("%s: session was NULL", __func__);
763 if (!session->devs) {
764 sr_err("%s: session->devs was NULL; a session "
765 "cannot be started without devices.", __func__);
769 if (session->running) {
770 sr_err("Cannot (re-)start session while it is still running.");
774 if (session->trigger) {
775 ret = verify_trigger(session->trigger);
780 /* Check enabled channels and commit settings of all devices. */
781 for (l = session->devs; l; l = l->next) {
783 for (c = sdi->channels; c; c = c->next) {
789 sr_err("%s device %s has no enabled channels.",
790 sdi->driver->name, sdi->connection_id);
794 ret = sr_config_commit(sdi);
796 sr_err("Failed to commit %s device %s settings "
797 "before starting acquisition.",
798 sdi->driver->name, sdi->connection_id);
803 ret = set_main_context(session);
807 sr_info("Starting.");
809 session->running = TRUE;
811 /* Have all devices start acquisition. */
812 for (l = session->devs; l; l = l->next) {
813 if (!(sdi = l->data)) {
814 sr_err("Device sdi was NULL, can't start session.");
818 ret = sr_dev_acquisition_start(sdi);
820 sr_err("Could not start %s device %s acquisition.",
821 sdi->driver->name, sdi->connection_id);
827 /* If there are multiple devices, some of them may already have
828 * started successfully. Stop them now before returning. */
830 for (l = session->devs; l != lend; l = l->next) {
832 sr_dev_acquisition_stop(sdi);
834 /* TODO: Handle delayed stops. Need to iterate the event
836 session->running = FALSE;
838 unset_main_context(session);
842 if (g_hash_table_size(session->event_sources) == 0)
843 stop_check_later(session);
849 * Block until the running session stops.
851 * This is a convenience function which creates a GLib main loop and runs
852 * it to process session events until the session stops.
854 * Instead of using this function, applications may run their own GLib main
855 * loop, and use sr_session_stopped_callback_set() to receive notification
856 * when the session finished running.
858 * @param session The session to use. Must not be NULL.
860 * @retval SR_OK Success.
861 * @retval SR_ERR_ARG Invalid session passed.
862 * @retval SR_ERR Other error.
866 SR_API int sr_session_run(struct sr_session *session)
869 sr_err("%s: session was NULL", __func__);
872 if (!session->running) {
873 sr_err("No session running.");
876 if (session->main_loop) {
877 sr_err("Main loop already created.");
881 g_mutex_lock(&session->main_mutex);
883 if (!session->main_context) {
884 sr_err("Cannot run without main context.");
885 g_mutex_unlock(&session->main_mutex);
888 session->main_loop = g_main_loop_new(session->main_context, FALSE);
890 g_mutex_unlock(&session->main_mutex);
892 g_main_loop_run(session->main_loop);
894 g_main_loop_unref(session->main_loop);
895 session->main_loop = NULL;
900 static gboolean session_stop_sync(void *user_data)
902 struct sr_session *session;
903 struct sr_dev_inst *sdi;
908 if (!session->running)
909 return G_SOURCE_REMOVE;
911 sr_info("Stopping.");
913 for (node = session->devs; node; node = node->next) {
915 sr_dev_acquisition_stop(sdi);
918 return G_SOURCE_REMOVE;
924 * This requests the drivers of each device participating in the session to
925 * abort the acquisition as soon as possible. Even after this function returns,
926 * event processing still continues until all devices have actually stopped.
928 * Use sr_session_stopped_callback_set() to receive notification when the event
929 * processing finished.
931 * This function is reentrant. That is, it may be called from a different
932 * thread than the one executing the session, as long as it can be ensured
933 * that the session object is valid.
935 * If the session is not running, sr_session_stop() silently does nothing.
937 * @param session The session to use. Must not be NULL.
939 * @retval SR_OK Success.
940 * @retval SR_ERR_ARG Invalid session passed.
944 SR_API int sr_session_stop(struct sr_session *session)
946 GMainContext *main_context;
949 sr_err("%s: session was NULL", __func__);
953 g_mutex_lock(&session->main_mutex);
955 main_context = (session->main_context)
956 ? g_main_context_ref(session->main_context)
959 g_mutex_unlock(&session->main_mutex);
962 sr_dbg("No main context set; already stopped?");
963 /* Not an error; as it would be racy. */
966 g_main_context_invoke(main_context, &session_stop_sync, session);
967 g_main_context_unref(main_context);
973 * Return whether the session is currently running.
975 * Note that this function should be called from the same thread
976 * the session was started in.
978 * @param session The session to use. Must not be NULL.
980 * @retval TRUE Session is running.
981 * @retval FALSE Session is not running.
982 * @retval SR_ERR_ARG Invalid session passed.
986 SR_API int sr_session_is_running(struct sr_session *session)
989 sr_err("%s: session was NULL", __func__);
992 return session->running;
996 * Set the callback to be invoked after a session stopped running.
998 * Install a callback to receive notification when a session run stopped.
999 * This can be used to integrate session execution with an existing main
1000 * loop, without having to block in sr_session_run().
1002 * Note that the callback will be invoked in the context of the thread
1003 * that calls sr_session_start().
1005 * @param session The session to use. Must not be NULL.
1006 * @param cb The callback to invoke on session stop. May be NULL to unset.
1007 * @param cb_data User data pointer to be passed to the callback.
1009 * @retval SR_OK Success.
1010 * @retval SR_ERR_ARG Invalid session passed.
1014 SR_API int sr_session_stopped_callback_set(struct sr_session *session,
1015 sr_session_stopped_callback cb, void *cb_data)
1018 sr_err("%s: session was NULL", __func__);
1021 session->stopped_callback = cb;
1022 session->stopped_cb_data = cb_data;
1030 * @param packet The packet to show debugging information for.
1032 static void datafeed_dump(const struct sr_datafeed_packet *packet)
1034 const struct sr_datafeed_logic *logic;
1035 const struct sr_datafeed_analog *analog;
1037 /* Please use the same order as in libsigrok.h. */
1038 switch (packet->type) {
1040 sr_dbg("bus: Received SR_DF_HEADER packet.");
1043 sr_dbg("bus: Received SR_DF_END packet.");
1046 sr_dbg("bus: Received SR_DF_META packet.");
1049 sr_dbg("bus: Received SR_DF_TRIGGER packet.");
1052 logic = packet->payload;
1053 sr_dbg("bus: Received SR_DF_LOGIC packet (%" PRIu64 " bytes, "
1054 "unitsize = %d).", logic->length, logic->unitsize);
1056 case SR_DF_FRAME_BEGIN:
1057 sr_dbg("bus: Received SR_DF_FRAME_BEGIN packet.");
1059 case SR_DF_FRAME_END:
1060 sr_dbg("bus: Received SR_DF_FRAME_END packet.");
1063 analog = packet->payload;
1064 sr_dbg("bus: Received SR_DF_ANALOG packet (%d samples).",
1065 analog->num_samples);
1068 sr_dbg("bus: Received unknown packet type: %d.", packet->type);
1074 * Helper to send a meta datafeed package (SR_DF_META) to the session bus.
1076 * @param sdi The device instance to send the package from. Must not be NULL.
1077 * @param key The config key to send to the session bus.
1078 * @param var The value to send to the session bus.
1080 * @retval SR_OK Success.
1081 * @retval SR_ERR_ARG Invalid argument.
1085 SR_PRIV int sr_session_send_meta(const struct sr_dev_inst *sdi,
1086 uint32_t key, GVariant *var)
1088 struct sr_config *cfg;
1089 struct sr_datafeed_packet packet;
1090 struct sr_datafeed_meta meta;
1093 cfg = sr_config_new(key, var);
1095 memset(&meta, 0, sizeof(meta));
1097 packet.type = SR_DF_META;
1098 packet.payload = &meta;
1100 meta.config = g_slist_append(NULL, cfg);
1102 ret = sr_session_send(sdi, &packet);
1103 g_slist_free(meta.config);
1104 sr_config_free(cfg);
1110 * Send a packet to whatever is listening on the datafeed bus.
1112 * Hardware drivers use this to send a data packet to the frontend.
1115 * @param packet The datafeed packet to send to the session bus.
1117 * @retval SR_OK Success.
1118 * @retval SR_ERR_ARG Invalid argument.
1122 SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
1123 const struct sr_datafeed_packet *packet)
1126 struct datafeed_callback *cb_struct;
1127 struct sr_datafeed_packet *packet_in, *packet_out;
1128 struct sr_transform *t;
1132 sr_err("%s: sdi was NULL", __func__);
1137 sr_err("%s: packet was NULL", __func__);
1141 if (!sdi->session) {
1142 sr_err("%s: session was NULL", __func__);
1147 * Pass the packet to the first transform module. If that returns
1148 * another packet (instead of NULL), pass that packet to the next
1149 * transform module in the list, and so on.
1151 packet_in = (struct sr_datafeed_packet *)packet;
1152 for (l = sdi->session->transforms; l; l = l->next) {
1154 sr_spew("Running transform module '%s'.", t->module->id);
1155 ret = t->module->receive(t, packet_in, &packet_out);
1157 sr_err("Error while running transform module: %d.", ret);
1162 * If any of the transforms don't return an output
1165 sr_spew("Transform module didn't return a packet, aborting.");
1169 * Use this transform module's output packet as input
1170 * for the next transform module.
1172 packet_in = packet_out;
1178 * If the last transform did output a packet, pass it to all datafeed
1181 for (l = sdi->session->datafeed_callbacks; l; l = l->next) {
1182 if (sr_log_loglevel_get() >= SR_LOG_DBG)
1183 datafeed_dump(packet);
1184 cb_struct = l->data;
1185 cb_struct->cb(sdi, packet, cb_struct->cb_data);
1192 * Add an event source for a file descriptor.
1194 * @param session The session to use. Must not be NULL.
1195 * @param key The key which identifies the event source.
1196 * @param source An event source object. Must not be NULL.
1198 * @retval SR_OK Success.
1199 * @retval SR_ERR_ARG Invalid argument.
1200 * @retval SR_ERR_BUG Event source with @a key already installed.
1201 * @retval SR_ERR Other error.
1205 SR_PRIV int sr_session_source_add_internal(struct sr_session *session,
1206 void *key, GSource *source)
1209 * This must not ever happen, since the source has already been
1210 * created and its finalize() method will remove the key for the
1211 * already installed source. (Well it would, if we did not have
1212 * another sanity check there.)
1214 if (g_hash_table_contains(session->event_sources, key)) {
1215 sr_err("Event source with key %p already exists.", key);
1218 g_hash_table_insert(session->event_sources, key, source);
1220 if (session_source_attach(session, source) == 0)
1227 SR_PRIV int sr_session_fd_source_add(struct sr_session *session,
1228 void *key, gintptr fd, int events, int timeout,
1229 sr_receive_data_callback cb, void *cb_data)
1234 source = fd_source_new(session, key, fd, events, timeout);
1238 g_source_set_callback(source, (GSourceFunc)cb, cb_data, NULL);
1240 ret = sr_session_source_add_internal(session, key, source);
1241 g_source_unref(source);
1247 * Add an event source for a file descriptor.
1249 * @param session The session to use. Must not be NULL.
1250 * @param fd The file descriptor, or a negative value to create a timer source.
1251 * @param events Events to check for.
1252 * @param timeout Max time in ms to wait before the callback is called,
1253 * or -1 to wait indefinitely.
1254 * @param cb Callback function to add. Must not be NULL.
1255 * @param cb_data Data for the callback function. Can be NULL.
1257 * @retval SR_OK Success.
1258 * @retval SR_ERR_ARG Invalid argument.
1263 SR_PRIV int sr_session_source_add(struct sr_session *session, int fd,
1264 int events, int timeout, sr_receive_data_callback cb, void *cb_data)
1266 if (fd < 0 && timeout < 0) {
1267 sr_err("Cannot create timer source without timeout.");
1270 return sr_session_fd_source_add(session, GINT_TO_POINTER(fd),
1271 fd, events, timeout, cb, cb_data);
1275 * Add an event source for a GPollFD.
1277 * @param session The session to use. Must not be NULL.
1278 * @param pollfd The GPollFD. Must not be NULL.
1279 * @param timeout Max time in ms to wait before the callback is called,
1280 * or -1 to wait indefinitely.
1281 * @param cb Callback function to add. Must not be NULL.
1282 * @param cb_data Data for the callback function. Can be NULL.
1284 * @retval SR_OK Success.
1285 * @retval SR_ERR_ARG Invalid argument.
1290 SR_PRIV int sr_session_source_add_pollfd(struct sr_session *session,
1291 GPollFD *pollfd, int timeout, sr_receive_data_callback cb,
1295 sr_err("%s: pollfd was NULL", __func__);
1298 return sr_session_fd_source_add(session, pollfd, pollfd->fd,
1299 pollfd->events, timeout, cb, cb_data);
1303 * Add an event source for a GIOChannel.
1305 * @param session The session to use. Must not be NULL.
1306 * @param channel The GIOChannel.
1307 * @param events Events to poll on.
1308 * @param timeout Max time in ms to wait before the callback is called,
1309 * or -1 to wait indefinitely.
1310 * @param cb Callback function to add. Must not be NULL.
1311 * @param cb_data Data for the callback function. Can be NULL.
1313 * @retval SR_OK Success.
1314 * @retval SR_ERR_ARG Invalid argument.
1319 SR_PRIV int sr_session_source_add_channel(struct sr_session *session,
1320 GIOChannel *channel, int events, int timeout,
1321 sr_receive_data_callback cb, void *cb_data)
1326 sr_err("%s: channel was NULL", __func__);
1329 /* We should be using g_io_create_watch(), but can't without
1330 * changing the driver API, as the callback signature is different.
1333 g_io_channel_win32_make_pollfd(channel, events, &pollfd);
1335 pollfd.fd = g_io_channel_unix_get_fd(channel);
1336 pollfd.events = events;
1338 return sr_session_fd_source_add(session, channel, pollfd.fd,
1339 pollfd.events, timeout, cb, cb_data);
1343 * Remove the source identified by the specified poll object.
1345 * @param session The session to use. Must not be NULL.
1346 * @param key The key by which the source is identified.
1348 * @retval SR_OK Success
1349 * @retval SR_ERR_BUG No event source for poll_object found.
1353 SR_PRIV int sr_session_source_remove_internal(struct sr_session *session,
1358 source = g_hash_table_lookup(session->event_sources, key);
1360 * Trying to remove an already removed event source is problematic
1361 * since the poll_object handle may have been reused in the meantime.
1364 sr_warn("Cannot remove non-existing event source %p.", key);
1367 g_source_destroy(source);
1373 * Remove the source belonging to the specified file descriptor.
1375 * @param session The session to use. Must not be NULL.
1376 * @param fd The file descriptor for which the source should be removed.
1378 * @retval SR_OK Success
1379 * @retval SR_ERR_ARG Invalid argument
1380 * @retval SR_ERR_BUG Internal error.
1385 SR_PRIV int sr_session_source_remove(struct sr_session *session, int fd)
1387 return sr_session_source_remove_internal(session, GINT_TO_POINTER(fd));
1391 * Remove the source belonging to the specified poll descriptor.
1393 * @param session The session to use. Must not be NULL.
1394 * @param pollfd The poll descriptor for which the source should be removed.
1396 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
1397 * SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon
1403 SR_PRIV int sr_session_source_remove_pollfd(struct sr_session *session,
1407 sr_err("%s: pollfd was NULL", __func__);
1410 return sr_session_source_remove_internal(session, pollfd);
1414 * Remove the source belonging to the specified channel.
1416 * @param session The session to use. Must not be NULL.
1417 * @param channel The channel for which the source should be removed.
1419 * @retval SR_OK Success.
1420 * @retval SR_ERR_ARG Invalid argument.
1421 * @return SR_ERR_BUG Internal error.
1426 SR_PRIV int sr_session_source_remove_channel(struct sr_session *session,
1427 GIOChannel *channel)
1430 sr_err("%s: channel was NULL", __func__);
1433 return sr_session_source_remove_internal(session, channel);
1436 /** Unregister an event source that has been destroyed.
1438 * This is intended to be called from a source's finalize() method.
1440 * @param session The session to use. Must not be NULL.
1441 * @param key The key used to identify @a source.
1442 * @param source The source object that was destroyed.
1444 * @retval SR_OK Success.
1445 * @retval SR_ERR_BUG Event source for @a key does not match @a source.
1446 * @retval SR_ERR Other error.
1450 SR_PRIV int sr_session_source_destroyed(struct sr_session *session,
1451 void *key, GSource *source)
1453 GSource *registered_source;
1455 registered_source = g_hash_table_lookup(session->event_sources, key);
1457 * Trying to remove an already removed event source is problematic
1458 * since the poll_object handle may have been reused in the meantime.
1460 if (!registered_source) {
1461 sr_err("No event source for key %p found.", key);
1464 if (registered_source != source) {
1465 sr_err("Event source for key %p does not match"
1466 " destroyed source.", key);
1469 g_hash_table_remove(session->event_sources, key);
1471 if (g_hash_table_size(session->event_sources) > 0)
1474 /* If no event sources are left, consider the acquisition finished.
1475 * This is pretty crude, as it requires all event sources to be
1476 * registered via the libsigrok API.
1478 return stop_check_later(session);
1481 static void copy_src(struct sr_config *src, struct sr_datafeed_meta *meta_copy)
1483 g_variant_ref(src->data);
1484 meta_copy->config = g_slist_append(meta_copy->config,
1485 g_memdup(src, sizeof(struct sr_config)));
1488 SR_API int sr_packet_copy(const struct sr_datafeed_packet *packet,
1489 struct sr_datafeed_packet **copy)
1491 const struct sr_datafeed_meta *meta;
1492 struct sr_datafeed_meta *meta_copy;
1493 const struct sr_datafeed_logic *logic;
1494 struct sr_datafeed_logic *logic_copy;
1495 const struct sr_datafeed_analog *analog;
1496 struct sr_datafeed_analog *analog_copy;
1499 *copy = g_malloc0(sizeof(struct sr_datafeed_packet));
1500 (*copy)->type = packet->type;
1502 switch (packet->type) {
1508 payload = g_malloc(sizeof(struct sr_datafeed_header));
1509 memcpy(payload, packet->payload, sizeof(struct sr_datafeed_header));
1510 (*copy)->payload = payload;
1513 meta = packet->payload;
1514 meta_copy = g_malloc0(sizeof(struct sr_datafeed_meta));
1515 g_slist_foreach(meta->config, (GFunc)copy_src, meta_copy->config);
1516 (*copy)->payload = meta_copy;
1519 logic = packet->payload;
1520 logic_copy = g_malloc(sizeof(*logic_copy));
1523 logic_copy->length = logic->length;
1524 logic_copy->unitsize = logic->unitsize;
1525 logic_copy->data = g_malloc(logic->length * logic->unitsize);
1526 if (!logic_copy->data) {
1530 memcpy(logic_copy->data, logic->data, logic->length * logic->unitsize);
1531 (*copy)->payload = logic_copy;
1534 analog = packet->payload;
1535 analog_copy = g_malloc(sizeof(*analog_copy));
1536 analog_copy->data = g_malloc(
1537 analog->encoding->unitsize * analog->num_samples);
1538 memcpy(analog_copy->data, analog->data,
1539 analog->encoding->unitsize * analog->num_samples);
1540 analog_copy->num_samples = analog->num_samples;
1541 analog_copy->encoding = g_memdup(analog->encoding,
1542 sizeof(struct sr_analog_encoding));
1543 analog_copy->meaning = g_memdup(analog->meaning,
1544 sizeof(struct sr_analog_meaning));
1545 analog_copy->meaning->channels = g_slist_copy(
1546 analog->meaning->channels);
1547 analog_copy->spec = g_memdup(analog->spec,
1548 sizeof(struct sr_analog_spec));
1549 (*copy)->payload = analog_copy;
1552 sr_err("Unknown packet type %d", packet->type);
1559 SR_API void sr_packet_free(struct sr_datafeed_packet *packet)
1561 const struct sr_datafeed_meta *meta;
1562 const struct sr_datafeed_logic *logic;
1563 const struct sr_datafeed_analog *analog;
1564 struct sr_config *src;
1567 switch (packet->type) {
1573 /* Payload is a simple struct. */
1574 g_free((void *)packet->payload);
1577 meta = packet->payload;
1578 for (l = meta->config; l; l = l->next) {
1580 g_variant_unref(src->data);
1583 g_slist_free(meta->config);
1584 g_free((void *)packet->payload);
1587 logic = packet->payload;
1588 g_free(logic->data);
1589 g_free((void *)packet->payload);
1592 analog = packet->payload;
1593 g_free(analog->data);
1594 g_free(analog->encoding);
1595 g_slist_free(analog->meaning->channels);
1596 g_free(analog->meaning);
1597 g_free(analog->spec);
1598 g_free((void *)packet->payload);
1601 sr_err("Unknown packet type %d", packet->type);