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
64 /* Meta-data needed to keep track of installed sources */
65 struct sr_session *session;
71 /** FD event source prepare() method.
72 * This is called immediately before poll().
74 static gboolean fd_source_prepare(GSource *source, int *timeout)
77 struct fd_source *fsource;
80 fsource = (struct fd_source *)source;
82 if (fsource->timeout_us >= 0) {
83 now_us = g_source_get_time(source);
85 if (fsource->due_us == 0) {
86 /* First-time initialization of the expiration time */
87 fsource->due_us = now_us + fsource->timeout_us;
89 remaining_ms = (MAX(0, fsource->due_us - now_us) + 999) / 1000;
93 *timeout = remaining_ms;
95 return (remaining_ms == 0);
98 /** FD event source check() method.
99 * This is called after poll() returns to check whether an event fired.
101 static gboolean fd_source_check(GSource *source)
103 struct fd_source *fsource;
104 unsigned int revents;
106 fsource = (struct fd_source *)source;
107 revents = fsource->pollfd.revents;
109 return (revents != 0 || (fsource->timeout_us >= 0
110 && fsource->due_us <= g_source_get_time(source)));
113 /** FD event source dispatch() method.
114 * This is called if either prepare() or check() returned TRUE.
116 static gboolean fd_source_dispatch(GSource *source,
117 GSourceFunc callback, void *user_data)
119 struct fd_source *fsource;
120 unsigned int revents;
123 fsource = (struct fd_source *)source;
124 revents = fsource->pollfd.revents;
127 sr_err("Callback not set, cannot dispatch event.");
128 return G_SOURCE_REMOVE;
130 keep = (*(sr_receive_data_callback)callback)
131 (fsource->pollfd.fd, revents, user_data);
133 if (fsource->timeout_us >= 0 && G_LIKELY(keep)
134 && G_LIKELY(!g_source_is_destroyed(source)))
135 fsource->due_us = g_source_get_time(source)
136 + fsource->timeout_us;
140 /** FD event source finalize() method.
142 static void fd_source_finalize(GSource *source)
144 struct fd_source *fsource;
146 fsource = (struct fd_source *)source;
148 sr_dbg("%s: key %p", __func__, fsource->key);
150 sr_session_source_destroyed(fsource->session, fsource->key, source);
153 /** Create an event source for I/O on a file descriptor.
155 * In order to maintain API compatibility, this event source also doubles
156 * as a timer event source.
158 * @param session The session the event source belongs to.
159 * @param key The key used to identify this source.
160 * @param fd The file descriptor or HANDLE.
161 * @param timeout_ms The timeout interval in ms, or -1 to wait indefinitely.
162 * @return A new event source object, or NULL on failure.
164 static GSource *fd_source_new(struct sr_session *session, void *key,
165 gintptr fd, int events, int timeout_ms)
167 static GSourceFuncs fd_source_funcs = {
168 .prepare = &fd_source_prepare,
169 .check = &fd_source_check,
170 .dispatch = &fd_source_dispatch,
171 .finalize = &fd_source_finalize
174 struct fd_source *fsource;
176 source = g_source_new(&fd_source_funcs, sizeof(struct fd_source));
177 fsource = (struct fd_source *)source;
179 g_source_set_name(source, (fd < 0) ? "timer" : "fd");
181 if (timeout_ms >= 0) {
182 fsource->timeout_us = 1000 * (int64_t)timeout_ms;
185 fsource->timeout_us = -1;
186 fsource->due_us = INT64_MAX;
188 fsource->session = session;
191 fsource->pollfd.fd = fd;
192 fsource->pollfd.events = events;
193 fsource->pollfd.revents = 0;
196 g_source_add_poll(source, &fsource->pollfd);
202 * Create a new session.
204 * @param ctx The context in which to create the new session.
205 * @param new_session This will contain a pointer to the newly created
206 * session if the return value is SR_OK, otherwise the value
207 * is undefined and should not be used. Must not be NULL.
209 * @retval SR_OK Success.
210 * @retval SR_ERR_ARG Invalid argument.
214 SR_API int sr_session_new(struct sr_context *ctx,
215 struct sr_session **new_session)
217 struct sr_session *session;
222 session = g_malloc0(sizeof(struct sr_session));
226 g_mutex_init(&session->main_mutex);
228 /* To maintain API compatibility, we need a lookup table
229 * which maps poll_object IDs to GSource* pointers.
231 session->event_sources = g_hash_table_new(NULL, NULL);
233 *new_session = session;
240 * This frees up all memory used by the session.
242 * @param session The session to destroy. Must not be NULL.
244 * @retval SR_OK Success.
245 * @retval SR_ERR_ARG Invalid session passed.
249 SR_API int sr_session_destroy(struct sr_session *session)
252 sr_err("%s: session was NULL", __func__);
256 sr_session_dev_remove_all(session);
257 g_slist_free_full(session->owned_devs, (GDestroyNotify)sr_dev_inst_free);
259 sr_session_datafeed_callback_remove_all(session);
261 g_hash_table_unref(session->event_sources);
263 g_mutex_clear(&session->main_mutex);
271 * Remove all the devices from a session.
273 * The session itself (i.e., the struct sr_session) is not free'd and still
274 * exists after this function returns.
276 * @param session The session to use. Must not be NULL.
278 * @retval SR_OK Success.
279 * @retval SR_ERR_BUG Invalid session passed.
283 SR_API int sr_session_dev_remove_all(struct sr_session *session)
285 struct sr_dev_inst *sdi;
289 sr_err("%s: session was NULL", __func__);
293 for (l = session->devs; l; l = l->next) {
294 sdi = (struct sr_dev_inst *) l->data;
298 g_slist_free(session->devs);
299 session->devs = NULL;
305 * Add a device instance to a session.
307 * @param session The session to add to. Must not be NULL.
308 * @param sdi The device instance to add to a session. Must not
309 * be NULL. Also, sdi->driver and sdi->driver->dev_open must
312 * @retval SR_OK Success.
313 * @retval SR_ERR_ARG Invalid argument.
317 SR_API int sr_session_dev_add(struct sr_session *session,
318 struct sr_dev_inst *sdi)
323 sr_err("%s: sdi was NULL", __func__);
328 sr_err("%s: session was NULL", __func__);
332 /* If sdi->session is not NULL, the device is already in this or
333 * another session. */
335 sr_err("%s: already assigned to session", __func__);
339 /* If sdi->driver is NULL, this is a virtual device. */
341 /* Just add the device, don't run dev_open(). */
342 session->devs = g_slist_append(session->devs, sdi);
343 sdi->session = session;
347 /* sdi->driver is non-NULL (i.e. we have a real device). */
348 if (!sdi->driver->dev_open) {
349 sr_err("%s: sdi->driver->dev_open was NULL", __func__);
353 session->devs = g_slist_append(session->devs, sdi);
354 sdi->session = session;
356 /* TODO: This is invalid if the session runs in a different thread.
357 * The usage semantics and restrictions need to be documented.
359 if (session->running) {
360 /* Adding a device to a running session. Commit settings
361 * and start acquisition on that device now. */
362 if ((ret = sr_config_commit(sdi)) != SR_OK) {
363 sr_err("Failed to commit device settings before "
364 "starting acquisition in running session (%s)",
368 if ((ret = sr_dev_acquisition_start(sdi)) != SR_OK) {
369 sr_err("Failed to start acquisition of device in "
370 "running session (%s)", sr_strerror(ret));
379 * List all device instances attached to a session.
381 * @param session The session to use. Must not be NULL.
382 * @param devlist A pointer where the device instance list will be
383 * stored on return. If no devices are in the session,
384 * this will be NULL. Each element in the list points
385 * to a struct sr_dev_inst *.
386 * The list must be freed by the caller, but not the
387 * elements pointed to.
389 * @retval SR_OK Success.
390 * @retval SR_ERR_ARG Invalid argument.
394 SR_API int sr_session_dev_list(struct sr_session *session, GSList **devlist)
402 *devlist = g_slist_copy(session->devs);
408 * Remove a device instance from a session.
410 * @param session The session to remove from. Must not be NULL.
411 * @param sdi The device instance to remove from a session. Must not
412 * be NULL. Also, sdi->driver and sdi->driver->dev_open must
415 * @retval SR_OK Success.
416 * @retval SR_ERR_ARG Invalid argument.
420 SR_API int sr_session_dev_remove(struct sr_session *session,
421 struct sr_dev_inst *sdi)
424 sr_err("%s: sdi was NULL", __func__);
429 sr_err("%s: session was NULL", __func__);
433 /* If sdi->session is not session, the device is not in this
435 if (sdi->session != session) {
436 sr_err("%s: not assigned to this session", __func__);
440 session->devs = g_slist_remove(session->devs, sdi);
447 * Remove all datafeed callbacks in a session.
449 * @param session The session to use. Must not be NULL.
451 * @retval SR_OK Success.
452 * @retval SR_ERR_ARG Invalid session passed.
456 SR_API int sr_session_datafeed_callback_remove_all(struct sr_session *session)
459 sr_err("%s: session was NULL", __func__);
463 g_slist_free_full(session->datafeed_callbacks, g_free);
464 session->datafeed_callbacks = NULL;
470 * Add a datafeed callback to a session.
472 * @param session The session to use. Must not be NULL.
473 * @param cb Function to call when a chunk of data is received.
475 * @param cb_data Opaque pointer passed in by the caller.
477 * @retval SR_OK Success.
478 * @retval SR_ERR_BUG No session exists.
482 SR_API int sr_session_datafeed_callback_add(struct sr_session *session,
483 sr_datafeed_callback cb, void *cb_data)
485 struct datafeed_callback *cb_struct;
488 sr_err("%s: session was NULL", __func__);
493 sr_err("%s: cb was NULL", __func__);
497 cb_struct = g_malloc0(sizeof(struct datafeed_callback));
499 cb_struct->cb_data = cb_data;
501 session->datafeed_callbacks =
502 g_slist_append(session->datafeed_callbacks, cb_struct);
508 * Get the trigger assigned to this session.
510 * @param session The session to use.
512 * @retval NULL Invalid (NULL) session was passed to the function.
513 * @retval other The trigger assigned to this session (can be NULL).
517 SR_API struct sr_trigger *sr_session_trigger_get(struct sr_session *session)
522 return session->trigger;
526 * Set the trigger of this session.
528 * @param session The session to use. Must not be NULL.
529 * @param trig The trigger to assign to this session. Can be NULL.
531 * @retval SR_OK Success.
532 * @retval SR_ERR_ARG Invalid argument.
536 SR_API int sr_session_trigger_set(struct sr_session *session, struct sr_trigger *trig)
541 session->trigger = trig;
546 static int verify_trigger(struct sr_trigger *trigger)
548 struct sr_trigger_stage *stage;
549 struct sr_trigger_match *match;
552 if (!trigger->stages) {
553 sr_err("No trigger stages defined.");
557 sr_spew("Checking trigger:");
558 for (l = trigger->stages; l; l = l->next) {
560 if (!stage->matches) {
561 sr_err("Stage %d has no matches defined.", stage->stage);
564 for (m = stage->matches; m; m = m->next) {
566 if (!match->channel) {
567 sr_err("Stage %d match has no channel.", stage->stage);
571 sr_err("Stage %d match is not defined.", stage->stage);
574 sr_spew("Stage %d match on channel %s, match %d", stage->stage,
575 match->channel->name, match->match);
582 /** Set up the main context the session will be executing in.
584 * Must be called just before the session starts, by the thread which
585 * will execute the session main loop. Once acquired, the main context
586 * pointer is immutable for the duration of the session run.
588 static int set_main_context(struct sr_session *session)
590 GMainContext *main_context;
592 g_mutex_lock(&session->main_mutex);
594 /* May happen if sr_session_start() is called a second time
595 * while the session is still running.
597 if (session->main_context) {
598 sr_err("Main context already set.");
600 g_mutex_unlock(&session->main_mutex);
603 main_context = g_main_context_ref_thread_default();
605 * Try to use an existing main context if possible, but only if we
606 * can make it owned by the current thread. Otherwise, create our
607 * own main context so that event source callbacks can execute in
608 * the session thread.
610 if (g_main_context_acquire(main_context)) {
611 g_main_context_release(main_context);
613 sr_dbg("Using thread-default main context.");
615 g_main_context_unref(main_context);
617 sr_dbg("Creating our own main context.");
618 main_context = g_main_context_new();
620 session->main_context = main_context;
622 g_mutex_unlock(&session->main_mutex);
627 /** Unset the main context used for the current session run.
629 * Must be called right after stopping the session. Note that if the
630 * session is stopped asynchronously, the main loop may still be running
631 * after the main context has been unset. This is OK as long as no new
632 * event sources are created -- the main loop holds its own reference
633 * to the main context.
635 static int unset_main_context(struct sr_session *session)
639 g_mutex_lock(&session->main_mutex);
641 if (session->main_context) {
642 g_main_context_unref(session->main_context);
643 session->main_context = NULL;
646 /* May happen if the set/unset calls are not matched.
648 sr_err("No main context to unset.");
651 g_mutex_unlock(&session->main_mutex);
656 static unsigned int session_source_attach(struct sr_session *session,
661 g_mutex_lock(&session->main_mutex);
663 if (session->main_context)
664 id = g_source_attach(source, session->main_context);
666 sr_err("Cannot add event source without main context.");
668 g_mutex_unlock(&session->main_mutex);
673 /* Idle handler; invoked when the number of registered event sources
674 * for a running session drops to zero.
676 static gboolean delayed_stop_check(void *data)
678 struct sr_session *session;
681 session->stop_check_id = 0;
683 /* Session already ended? */
684 if (!session->running)
685 return G_SOURCE_REMOVE;
687 /* New event sources may have been installed in the meantime. */
688 if (g_hash_table_size(session->event_sources) != 0)
689 return G_SOURCE_REMOVE;
691 session->running = FALSE;
692 unset_main_context(session);
696 /* This indicates a bug in user code, since it is not valid to
697 * restart or destroy a session while it may still be running.
699 if (!session->main_loop && !session->stopped_callback) {
700 sr_err("BUG: Session stop left unhandled.");
701 return G_SOURCE_REMOVE;
703 if (session->main_loop)
704 g_main_loop_quit(session->main_loop);
706 if (session->stopped_callback)
707 (*session->stopped_callback)(session->stopped_cb_data);
709 return G_SOURCE_REMOVE;
712 static int stop_check_later(struct sr_session *session)
715 unsigned int source_id;
717 if (session->stop_check_id != 0)
718 return SR_OK; /* idle handler already installed */
720 source = g_idle_source_new();
721 g_source_set_callback(source, &delayed_stop_check, session, NULL);
723 source_id = session_source_attach(session, source);
724 session->stop_check_id = source_id;
726 g_source_unref(source);
728 return (source_id != 0) ? SR_OK : SR_ERR;
734 * When this function returns with a status code indicating success, the
735 * session is running. Use sr_session_stopped_callback_set() to receive
736 * notification upon completion, or call sr_session_run() to block until
739 * Session events will be processed in the context of the current thread.
740 * If a thread-default GLib main context has been set, and is not owned by
741 * any other thread, it will be used. Otherwise, libsigrok will create its
742 * own main context for the current thread.
744 * @param session The session to use. Must not be NULL.
746 * @retval SR_OK Success.
747 * @retval SR_ERR_ARG Invalid session passed.
748 * @retval SR_ERR Other error.
752 SR_API int sr_session_start(struct sr_session *session)
754 struct sr_dev_inst *sdi;
755 struct sr_channel *ch;
756 GSList *l, *c, *lend;
760 sr_err("%s: session was NULL", __func__);
764 if (!session->devs) {
765 sr_err("%s: session->devs was NULL; a session "
766 "cannot be started without devices.", __func__);
770 if (session->running) {
771 sr_err("Cannot (re-)start session while it is still running.");
775 if (session->trigger) {
776 ret = verify_trigger(session->trigger);
781 /* Check enabled channels and commit settings of all devices. */
782 for (l = session->devs; l; l = l->next) {
784 for (c = sdi->channels; c; c = c->next) {
790 sr_err("%s device %s has no enabled channels.",
791 sdi->driver->name, sdi->connection_id);
795 ret = sr_config_commit(sdi);
797 sr_err("Failed to commit %s device %s settings "
798 "before starting acquisition.",
799 sdi->driver->name, sdi->connection_id);
804 ret = set_main_context(session);
808 sr_info("Starting.");
810 session->running = TRUE;
812 /* Have all devices start acquisition. */
813 for (l = session->devs; l; l = l->next) {
814 if (!(sdi = l->data)) {
815 sr_err("Device sdi was NULL, can't start session.");
819 ret = sr_dev_acquisition_start(sdi);
821 sr_err("Could not start %s device %s acquisition.",
822 sdi->driver->name, sdi->connection_id);
828 /* If there are multiple devices, some of them may already have
829 * started successfully. Stop them now before returning. */
831 for (l = session->devs; l != lend; l = l->next) {
833 sr_dev_acquisition_stop(sdi);
835 /* TODO: Handle delayed stops. Need to iterate the event
837 session->running = FALSE;
839 unset_main_context(session);
843 if (g_hash_table_size(session->event_sources) == 0)
844 stop_check_later(session);
850 * Block until the running session stops.
852 * This is a convenience function which creates a GLib main loop and runs
853 * it to process session events until the session stops.
855 * Instead of using this function, applications may run their own GLib main
856 * loop, and use sr_session_stopped_callback_set() to receive notification
857 * when the session finished running.
859 * @param session The session to use. Must not be NULL.
861 * @retval SR_OK Success.
862 * @retval SR_ERR_ARG Invalid session passed.
863 * @retval SR_ERR Other error.
867 SR_API int sr_session_run(struct sr_session *session)
870 sr_err("%s: session was NULL", __func__);
873 if (!session->running) {
874 sr_err("No session running.");
877 if (session->main_loop) {
878 sr_err("Main loop already created.");
882 g_mutex_lock(&session->main_mutex);
884 if (!session->main_context) {
885 sr_err("Cannot run without main context.");
886 g_mutex_unlock(&session->main_mutex);
889 session->main_loop = g_main_loop_new(session->main_context, FALSE);
891 g_mutex_unlock(&session->main_mutex);
893 g_main_loop_run(session->main_loop);
895 g_main_loop_unref(session->main_loop);
896 session->main_loop = NULL;
901 static gboolean session_stop_sync(void *user_data)
903 struct sr_session *session;
904 struct sr_dev_inst *sdi;
909 if (!session->running)
910 return G_SOURCE_REMOVE;
912 sr_info("Stopping.");
914 for (node = session->devs; node; node = node->next) {
916 sr_dev_acquisition_stop(sdi);
919 return G_SOURCE_REMOVE;
925 * This requests the drivers of each device participating in the session to
926 * abort the acquisition as soon as possible. Even after this function returns,
927 * event processing still continues until all devices have actually stopped.
929 * Use sr_session_stopped_callback_set() to receive notification when the event
930 * processing finished.
932 * This function is reentrant. That is, it may be called from a different
933 * thread than the one executing the session, as long as it can be ensured
934 * that the session object is valid.
936 * If the session is not running, sr_session_stop() silently does nothing.
938 * @param session The session to use. Must not be NULL.
940 * @retval SR_OK Success.
941 * @retval SR_ERR_ARG Invalid session passed.
945 SR_API int sr_session_stop(struct sr_session *session)
947 GMainContext *main_context;
950 sr_err("%s: session was NULL", __func__);
954 g_mutex_lock(&session->main_mutex);
956 main_context = (session->main_context)
957 ? g_main_context_ref(session->main_context)
960 g_mutex_unlock(&session->main_mutex);
963 sr_dbg("No main context set; already stopped?");
964 /* Not an error; as it would be racy. */
967 g_main_context_invoke(main_context, &session_stop_sync, session);
968 g_main_context_unref(main_context);
974 * Return whether the session is currently running.
976 * Note that this function should be called from the same thread
977 * the session was started in.
979 * @param session The session to use. Must not be NULL.
981 * @retval TRUE Session is running.
982 * @retval FALSE Session is not running.
983 * @retval SR_ERR_ARG Invalid session passed.
987 SR_API int sr_session_is_running(struct sr_session *session)
990 sr_err("%s: session was NULL", __func__);
993 return session->running;
997 * Set the callback to be invoked after a session stopped running.
999 * Install a callback to receive notification when a session run stopped.
1000 * This can be used to integrate session execution with an existing main
1001 * loop, without having to block in sr_session_run().
1003 * Note that the callback will be invoked in the context of the thread
1004 * that calls sr_session_start().
1006 * @param session The session to use. Must not be NULL.
1007 * @param cb The callback to invoke on session stop. May be NULL to unset.
1008 * @param cb_data User data pointer to be passed to the callback.
1010 * @retval SR_OK Success.
1011 * @retval SR_ERR_ARG Invalid session passed.
1015 SR_API int sr_session_stopped_callback_set(struct sr_session *session,
1016 sr_session_stopped_callback cb, void *cb_data)
1019 sr_err("%s: session was NULL", __func__);
1022 session->stopped_callback = cb;
1023 session->stopped_cb_data = cb_data;
1031 * @param packet The packet to show debugging information for.
1033 static void datafeed_dump(const struct sr_datafeed_packet *packet)
1035 const struct sr_datafeed_logic *logic;
1036 const struct sr_datafeed_analog *analog;
1038 /* Please use the same order as in libsigrok.h. */
1039 switch (packet->type) {
1041 sr_dbg("bus: Received SR_DF_HEADER packet.");
1044 sr_dbg("bus: Received SR_DF_END packet.");
1047 sr_dbg("bus: Received SR_DF_META packet.");
1050 sr_dbg("bus: Received SR_DF_TRIGGER packet.");
1053 logic = packet->payload;
1054 sr_dbg("bus: Received SR_DF_LOGIC packet (%" PRIu64 " bytes, "
1055 "unitsize = %d).", logic->length, logic->unitsize);
1057 case SR_DF_FRAME_BEGIN:
1058 sr_dbg("bus: Received SR_DF_FRAME_BEGIN packet.");
1060 case SR_DF_FRAME_END:
1061 sr_dbg("bus: Received SR_DF_FRAME_END packet.");
1064 analog = packet->payload;
1065 sr_dbg("bus: Received SR_DF_ANALOG packet (%d samples).",
1066 analog->num_samples);
1069 sr_dbg("bus: Received unknown packet type: %d.", packet->type);
1075 * Send a packet to whatever is listening on the datafeed bus.
1077 * Hardware drivers use this to send a data packet to the frontend.
1080 * @param packet The datafeed packet to send to the session bus.
1082 * @retval SR_OK Success.
1083 * @retval SR_ERR_ARG Invalid argument.
1087 SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
1088 const struct sr_datafeed_packet *packet)
1091 struct datafeed_callback *cb_struct;
1092 struct sr_datafeed_packet *packet_in, *packet_out;
1093 struct sr_transform *t;
1097 sr_err("%s: sdi was NULL", __func__);
1102 sr_err("%s: packet was NULL", __func__);
1106 if (!sdi->session) {
1107 sr_err("%s: session was NULL", __func__);
1112 * Pass the packet to the first transform module. If that returns
1113 * another packet (instead of NULL), pass that packet to the next
1114 * transform module in the list, and so on.
1116 packet_in = (struct sr_datafeed_packet *)packet;
1117 for (l = sdi->session->transforms; l; l = l->next) {
1119 sr_spew("Running transform module '%s'.", t->module->id);
1120 ret = t->module->receive(t, packet_in, &packet_out);
1122 sr_err("Error while running transform module: %d.", ret);
1127 * If any of the transforms don't return an output
1130 sr_spew("Transform module didn't return a packet, aborting.");
1134 * Use this transform module's output packet as input
1135 * for the next transform module.
1137 packet_in = packet_out;
1143 * If the last transform did output a packet, pass it to all datafeed
1146 for (l = sdi->session->datafeed_callbacks; l; l = l->next) {
1147 if (sr_log_loglevel_get() >= SR_LOG_DBG)
1148 datafeed_dump(packet);
1149 cb_struct = l->data;
1150 cb_struct->cb(sdi, packet, cb_struct->cb_data);
1157 * Add an event source for a file descriptor.
1159 * @param session The session to use. Must not be NULL.
1160 * @param key The key which identifies the event source.
1161 * @param source An event source object. Must not be NULL.
1163 * @retval SR_OK Success.
1164 * @retval SR_ERR_ARG Invalid argument.
1165 * @retval SR_ERR_BUG Event source with @a key already installed.
1166 * @retval SR_ERR Other error.
1170 SR_PRIV int sr_session_source_add_internal(struct sr_session *session,
1171 void *key, GSource *source)
1174 * This must not ever happen, since the source has already been
1175 * created and its finalize() method will remove the key for the
1176 * already installed source. (Well it would, if we did not have
1177 * another sanity check there.)
1179 if (g_hash_table_contains(session->event_sources, key)) {
1180 sr_err("Event source with key %p already exists.", key);
1183 g_hash_table_insert(session->event_sources, key, source);
1185 if (session_source_attach(session, source) == 0)
1192 SR_PRIV int sr_session_fd_source_add(struct sr_session *session,
1193 void *key, gintptr fd, int events, int timeout,
1194 sr_receive_data_callback cb, void *cb_data)
1199 source = fd_source_new(session, key, fd, events, timeout);
1203 g_source_set_callback(source, (GSourceFunc)cb, cb_data, NULL);
1205 ret = sr_session_source_add_internal(session, key, source);
1206 g_source_unref(source);
1212 * Add an event source for a file descriptor.
1214 * @param session The session to use. Must not be NULL.
1215 * @param fd The file descriptor, or a negative value to create a timer source.
1216 * @param events Events to check for.
1217 * @param timeout Max time in ms to wait before the callback is called,
1218 * or -1 to wait indefinitely.
1219 * @param cb Callback function to add. Must not be NULL.
1220 * @param cb_data Data for the callback function. Can be NULL.
1222 * @retval SR_OK Success.
1223 * @retval SR_ERR_ARG Invalid argument.
1228 SR_PRIV int sr_session_source_add(struct sr_session *session, int fd,
1229 int events, int timeout, sr_receive_data_callback cb, void *cb_data)
1231 if (fd < 0 && timeout < 0) {
1232 sr_err("Cannot create timer source without timeout.");
1235 return sr_session_fd_source_add(session, GINT_TO_POINTER(fd),
1236 fd, events, timeout, cb, cb_data);
1240 * Add an event source for a GPollFD.
1242 * @param session The session to use. Must not be NULL.
1243 * @param pollfd The GPollFD. Must not be NULL.
1244 * @param timeout Max time in ms to wait before the callback is called,
1245 * or -1 to wait indefinitely.
1246 * @param cb Callback function to add. Must not be NULL.
1247 * @param cb_data Data for the callback function. Can be NULL.
1249 * @retval SR_OK Success.
1250 * @retval SR_ERR_ARG Invalid argument.
1255 SR_PRIV int sr_session_source_add_pollfd(struct sr_session *session,
1256 GPollFD *pollfd, int timeout, sr_receive_data_callback cb,
1260 sr_err("%s: pollfd was NULL", __func__);
1263 return sr_session_fd_source_add(session, pollfd, pollfd->fd,
1264 pollfd->events, timeout, cb, cb_data);
1268 * Add an event source for a GIOChannel.
1270 * @param session The session to use. Must not be NULL.
1271 * @param channel The GIOChannel.
1272 * @param events Events to poll on.
1273 * @param timeout Max time in ms to wait before the callback is called,
1274 * or -1 to wait indefinitely.
1275 * @param cb Callback function to add. Must not be NULL.
1276 * @param cb_data Data for the callback function. Can be NULL.
1278 * @retval SR_OK Success.
1279 * @retval SR_ERR_ARG Invalid argument.
1284 SR_PRIV int sr_session_source_add_channel(struct sr_session *session,
1285 GIOChannel *channel, int events, int timeout,
1286 sr_receive_data_callback cb, void *cb_data)
1291 sr_err("%s: channel was NULL", __func__);
1294 /* We should be using g_io_create_watch(), but can't without
1295 * changing the driver API, as the callback signature is different.
1298 g_io_channel_win32_make_pollfd(channel, events, &pollfd);
1300 pollfd.fd = g_io_channel_unix_get_fd(channel);
1301 pollfd.events = events;
1303 return sr_session_fd_source_add(session, channel, pollfd.fd,
1304 pollfd.events, timeout, cb, cb_data);
1308 * Remove the source identified by the specified poll object.
1310 * @param session The session to use. Must not be NULL.
1311 * @param key The key by which the source is identified.
1313 * @retval SR_OK Success
1314 * @retval SR_ERR_BUG No event source for poll_object found.
1318 SR_PRIV int sr_session_source_remove_internal(struct sr_session *session,
1323 source = g_hash_table_lookup(session->event_sources, key);
1325 * Trying to remove an already removed event source is problematic
1326 * since the poll_object handle may have been reused in the meantime.
1329 sr_warn("Cannot remove non-existing event source %p.", key);
1332 g_source_destroy(source);
1338 * Remove the source belonging to the specified file descriptor.
1340 * @param session The session to use. Must not be NULL.
1341 * @param fd The file descriptor for which the source should be removed.
1343 * @retval SR_OK Success
1344 * @retval SR_ERR_ARG Invalid argument
1345 * @retval SR_ERR_BUG Internal error.
1350 SR_PRIV int sr_session_source_remove(struct sr_session *session, int fd)
1352 return sr_session_source_remove_internal(session, GINT_TO_POINTER(fd));
1356 * Remove the source belonging to the specified poll descriptor.
1358 * @param session The session to use. Must not be NULL.
1359 * @param pollfd The poll descriptor for which the source should be removed.
1361 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
1362 * SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon
1368 SR_PRIV int sr_session_source_remove_pollfd(struct sr_session *session,
1372 sr_err("%s: pollfd was NULL", __func__);
1375 return sr_session_source_remove_internal(session, pollfd);
1379 * Remove the source belonging to the specified channel.
1381 * @param session The session to use. Must not be NULL.
1382 * @param channel The channel for which the source should be removed.
1384 * @retval SR_OK Success.
1385 * @retval SR_ERR_ARG Invalid argument.
1386 * @return SR_ERR_BUG Internal error.
1391 SR_PRIV int sr_session_source_remove_channel(struct sr_session *session,
1392 GIOChannel *channel)
1395 sr_err("%s: channel was NULL", __func__);
1398 return sr_session_source_remove_internal(session, channel);
1401 /** Unregister an event source that has been destroyed.
1403 * This is intended to be called from a source's finalize() method.
1405 * @param session The session to use. Must not be NULL.
1406 * @param key The key used to identify @a source.
1407 * @param source The source object that was destroyed.
1409 * @retval SR_OK Success.
1410 * @retval SR_ERR_BUG Event source for @a key does not match @a source.
1411 * @retval SR_ERR Other error.
1415 SR_PRIV int sr_session_source_destroyed(struct sr_session *session,
1416 void *key, GSource *source)
1418 GSource *registered_source;
1420 registered_source = g_hash_table_lookup(session->event_sources, key);
1422 * Trying to remove an already removed event source is problematic
1423 * since the poll_object handle may have been reused in the meantime.
1425 if (!registered_source) {
1426 sr_err("No event source for key %p found.", key);
1429 if (registered_source != source) {
1430 sr_err("Event source for key %p does not match"
1431 " destroyed source.", key);
1434 g_hash_table_remove(session->event_sources, key);
1436 if (g_hash_table_size(session->event_sources) > 0)
1439 /* If no event sources are left, consider the acquisition finished.
1440 * This is pretty crude, as it requires all event sources to be
1441 * registered via the libsigrok API.
1443 return stop_check_later(session);
1446 static void copy_src(struct sr_config *src, struct sr_datafeed_meta *meta_copy)
1448 g_variant_ref(src->data);
1449 meta_copy->config = g_slist_append(meta_copy->config,
1450 g_memdup(src, sizeof(struct sr_config)));
1454 SR_PRIV int sr_packet_copy(const struct sr_datafeed_packet *packet,
1455 struct sr_datafeed_packet **copy)
1457 const struct sr_datafeed_meta *meta;
1458 struct sr_datafeed_meta *meta_copy;
1459 const struct sr_datafeed_logic *logic;
1460 struct sr_datafeed_logic *logic_copy;
1461 const struct sr_datafeed_analog *analog;
1462 struct sr_datafeed_analog *analog_copy;
1465 *copy = g_malloc0(sizeof(struct sr_datafeed_packet));
1466 (*copy)->type = packet->type;
1468 switch (packet->type) {
1474 payload = g_malloc(sizeof(struct sr_datafeed_header));
1475 memcpy(payload, packet->payload, sizeof(struct sr_datafeed_header));
1476 (*copy)->payload = payload;
1479 meta = packet->payload;
1480 meta_copy = g_malloc0(sizeof(struct sr_datafeed_meta));
1481 g_slist_foreach(meta->config, (GFunc)copy_src, meta_copy->config);
1482 (*copy)->payload = meta_copy;
1485 logic = packet->payload;
1486 logic_copy = g_malloc(sizeof(*logic_copy));
1489 logic_copy->length = logic->length;
1490 logic_copy->unitsize = logic->unitsize;
1491 logic_copy->data = g_malloc(logic->length * logic->unitsize);
1492 if (!logic_copy->data)
1494 memcpy(logic_copy->data, logic->data, logic->length * logic->unitsize);
1495 (*copy)->payload = logic_copy;
1498 analog = packet->payload;
1499 analog_copy = g_malloc(sizeof(*analog_copy));
1500 analog_copy->data = g_malloc(
1501 analog->encoding->unitsize * analog->num_samples);
1502 memcpy(analog_copy->data, analog->data,
1503 analog->encoding->unitsize * analog->num_samples);
1504 analog_copy->num_samples = analog->num_samples;
1505 analog_copy->encoding = g_memdup(analog->encoding,
1506 sizeof(struct sr_analog_encoding));
1507 analog_copy->meaning = g_memdup(analog->meaning,
1508 sizeof(struct sr_analog_meaning));
1509 analog_copy->meaning->channels = g_slist_copy(
1510 analog->meaning->channels);
1511 analog_copy->spec = g_memdup(analog->spec,
1512 sizeof(struct sr_analog_spec));
1513 (*copy)->payload = analog_copy;
1516 sr_err("Unknown packet type %d", packet->type);
1523 void sr_packet_free(struct sr_datafeed_packet *packet)
1525 const struct sr_datafeed_meta *meta;
1526 const struct sr_datafeed_logic *logic;
1527 const struct sr_datafeed_analog *analog;
1528 struct sr_config *src;
1531 switch (packet->type) {
1537 /* Payload is a simple struct. */
1538 g_free((void *)packet->payload);
1541 meta = packet->payload;
1542 for (l = meta->config; l; l = l->next) {
1544 g_variant_unref(src->data);
1547 g_slist_free(meta->config);
1548 g_free((void *)packet->payload);
1551 logic = packet->payload;
1552 g_free(logic->data);
1553 g_free((void *)packet->payload);
1556 analog = packet->payload;
1557 g_free(analog->data);
1558 g_free(analog->encoding);
1559 g_slist_free(analog->meaning->channels);
1560 g_free(analog->meaning);
1561 g_free(analog->spec);
1562 g_free((void *)packet->payload);
1565 sr_err("Unknown packet type %d", packet->type);