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;
121 unsigned int revents;
124 fsource = (struct fd_source *)source;
125 name = g_source_get_name(source);
126 revents = fsource->pollfd.revents;
129 sr_spew("%s: %s " G_POLLFD_FORMAT ", revents 0x%.2X",
130 __func__, name, fsource->pollfd.fd, revents);
132 sr_spew("%s: %s " G_POLLFD_FORMAT ", timed out",
133 __func__, name, fsource->pollfd.fd);
136 sr_err("Callback not set, cannot dispatch event.");
137 return G_SOURCE_REMOVE;
139 keep = (*(sr_receive_data_callback)callback)
140 (fsource->pollfd.fd, revents, user_data);
142 if (fsource->timeout_us >= 0 && G_LIKELY(keep)
143 && G_LIKELY(!g_source_is_destroyed(source)))
144 fsource->due_us = g_source_get_time(source)
145 + fsource->timeout_us;
149 /** FD event source finalize() method.
151 static void fd_source_finalize(GSource *source)
153 struct fd_source *fsource;
155 fsource = (struct fd_source *)source;
157 sr_dbg("%s: key %p", __func__, fsource->key);
159 sr_session_source_destroyed(fsource->session, fsource->key, source);
162 /** Create an event source for I/O on a file descriptor.
164 * In order to maintain API compatibility, this event source also doubles
165 * as a timer event source.
167 * @param session The session the event source belongs to.
168 * @param key The key used to identify this source.
169 * @param fd The file descriptor or HANDLE.
170 * @param timeout_ms The timeout interval in ms, or -1 to wait indefinitely.
171 * @return A new event source object, or NULL on failure.
173 static GSource *fd_source_new(struct sr_session *session, void *key,
174 gintptr fd, int events, int timeout_ms)
176 static GSourceFuncs fd_source_funcs = {
177 .prepare = &fd_source_prepare,
178 .check = &fd_source_check,
179 .dispatch = &fd_source_dispatch,
180 .finalize = &fd_source_finalize
183 struct fd_source *fsource;
185 source = g_source_new(&fd_source_funcs, sizeof(struct fd_source));
186 fsource = (struct fd_source *)source;
188 g_source_set_name(source, (fd < 0) ? "timer" : "fd");
190 if (timeout_ms >= 0) {
191 fsource->timeout_us = 1000 * (int64_t)timeout_ms;
194 fsource->timeout_us = -1;
195 fsource->due_us = INT64_MAX;
197 fsource->session = session;
200 fsource->pollfd.fd = fd;
201 fsource->pollfd.events = events;
202 fsource->pollfd.revents = 0;
205 g_source_add_poll(source, &fsource->pollfd);
211 * Create a new session.
213 * @param ctx The context in which to create the new session.
214 * @param new_session This will contain a pointer to the newly created
215 * session if the return value is SR_OK, otherwise the value
216 * is undefined and should not be used. Must not be NULL.
218 * @retval SR_OK Success.
219 * @retval SR_ERR_ARG Invalid argument.
223 SR_API int sr_session_new(struct sr_context *ctx,
224 struct sr_session **new_session)
226 struct sr_session *session;
231 session = g_malloc0(sizeof(struct sr_session));
235 g_mutex_init(&session->main_mutex);
237 /* To maintain API compatibility, we need a lookup table
238 * which maps poll_object IDs to GSource* pointers.
240 session->event_sources = g_hash_table_new(NULL, NULL);
242 *new_session = session;
249 * This frees up all memory used by the session.
251 * @param session The session to destroy. Must not be NULL.
253 * @retval SR_OK Success.
254 * @retval SR_ERR_ARG Invalid session passed.
258 SR_API int sr_session_destroy(struct sr_session *session)
261 sr_err("%s: session was NULL", __func__);
265 sr_session_dev_remove_all(session);
266 g_slist_free_full(session->owned_devs, (GDestroyNotify)sr_dev_inst_free);
268 g_hash_table_unref(session->event_sources);
270 g_mutex_clear(&session->main_mutex);
278 * Remove all the devices from a session.
280 * The session itself (i.e., the struct sr_session) is not free'd and still
281 * exists after this function returns.
283 * @param session The session to use. Must not be NULL.
285 * @retval SR_OK Success.
286 * @retval SR_ERR_BUG Invalid session passed.
290 SR_API int sr_session_dev_remove_all(struct sr_session *session)
292 struct sr_dev_inst *sdi;
296 sr_err("%s: session was NULL", __func__);
300 for (l = session->devs; l; l = l->next) {
301 sdi = (struct sr_dev_inst *) l->data;
305 g_slist_free(session->devs);
306 session->devs = NULL;
312 * Add a device instance to a session.
314 * @param session The session to add to. Must not be NULL.
315 * @param sdi The device instance to add to a session. Must not
316 * be NULL. Also, sdi->driver and sdi->driver->dev_open must
319 * @retval SR_OK Success.
320 * @retval SR_ERR_ARG Invalid argument.
324 SR_API int sr_session_dev_add(struct sr_session *session,
325 struct sr_dev_inst *sdi)
330 sr_err("%s: sdi was NULL", __func__);
335 sr_err("%s: session was NULL", __func__);
339 /* If sdi->session is not NULL, the device is already in this or
340 * another session. */
342 sr_err("%s: already assigned to session", __func__);
346 /* If sdi->driver is NULL, this is a virtual device. */
348 /* Just add the device, don't run dev_open(). */
349 session->devs = g_slist_append(session->devs, sdi);
350 sdi->session = session;
354 /* sdi->driver is non-NULL (i.e. we have a real device). */
355 if (!sdi->driver->dev_open) {
356 sr_err("%s: sdi->driver->dev_open was NULL", __func__);
360 session->devs = g_slist_append(session->devs, sdi);
361 sdi->session = session;
363 /* TODO: This is invalid if the session runs in a different thread.
364 * The usage semantics and restrictions need to be documented.
366 if (session->running) {
367 /* Adding a device to a running session. Commit settings
368 * and start acquisition on that device now. */
369 if ((ret = sr_config_commit(sdi)) != SR_OK) {
370 sr_err("Failed to commit device settings before "
371 "starting acquisition in running session (%s)",
375 if ((ret = sdi->driver->dev_acquisition_start(sdi,
377 sr_err("Failed to start acquisition of device in "
378 "running session (%s)", sr_strerror(ret));
387 * List all device instances attached to a session.
389 * @param session The session to use. Must not be NULL.
390 * @param devlist A pointer where the device instance list will be
391 * stored on return. If no devices are in the session,
392 * this will be NULL. Each element in the list points
393 * to a struct sr_dev_inst *.
394 * The list must be freed by the caller, but not the
395 * elements pointed to.
397 * @retval SR_OK Success.
398 * @retval SR_ERR_ARG Invalid argument.
402 SR_API int sr_session_dev_list(struct sr_session *session, GSList **devlist)
410 *devlist = g_slist_copy(session->devs);
416 * Remove all datafeed callbacks in a session.
418 * @param session The session to use. Must not be NULL.
420 * @retval SR_OK Success.
421 * @retval SR_ERR_ARG Invalid session passed.
425 SR_API int sr_session_datafeed_callback_remove_all(struct sr_session *session)
428 sr_err("%s: session was NULL", __func__);
432 g_slist_free_full(session->datafeed_callbacks, g_free);
433 session->datafeed_callbacks = NULL;
439 * Add a datafeed callback to a session.
441 * @param session The session to use. Must not be NULL.
442 * @param cb Function to call when a chunk of data is received.
444 * @param cb_data Opaque pointer passed in by the caller.
446 * @retval SR_OK Success.
447 * @retval SR_ERR_BUG No session exists.
451 SR_API int sr_session_datafeed_callback_add(struct sr_session *session,
452 sr_datafeed_callback cb, void *cb_data)
454 struct datafeed_callback *cb_struct;
457 sr_err("%s: session was NULL", __func__);
462 sr_err("%s: cb was NULL", __func__);
466 cb_struct = g_malloc0(sizeof(struct datafeed_callback));
468 cb_struct->cb_data = cb_data;
470 session->datafeed_callbacks =
471 g_slist_append(session->datafeed_callbacks, cb_struct);
477 * Get the trigger assigned to this session.
479 * @param session The session to use.
481 * @retval NULL Invalid (NULL) session was passed to the function.
482 * @retval other The trigger assigned to this session (can be NULL).
486 SR_API struct sr_trigger *sr_session_trigger_get(struct sr_session *session)
491 return session->trigger;
495 * Set the trigger of this session.
497 * @param session The session to use. Must not be NULL.
498 * @param trig The trigger to assign to this session. Can be NULL.
500 * @retval SR_OK Success.
501 * @retval SR_ERR_ARG Invalid argument.
505 SR_API int sr_session_trigger_set(struct sr_session *session, struct sr_trigger *trig)
510 session->trigger = trig;
515 static int verify_trigger(struct sr_trigger *trigger)
517 struct sr_trigger_stage *stage;
518 struct sr_trigger_match *match;
521 if (!trigger->stages) {
522 sr_err("No trigger stages defined.");
526 sr_spew("Checking trigger:");
527 for (l = trigger->stages; l; l = l->next) {
529 if (!stage->matches) {
530 sr_err("Stage %d has no matches defined.", stage->stage);
533 for (m = stage->matches; m; m = m->next) {
535 if (!match->channel) {
536 sr_err("Stage %d match has no channel.", stage->stage);
540 sr_err("Stage %d match is not defined.", stage->stage);
543 sr_spew("Stage %d match on channel %s, match %d", stage->stage,
544 match->channel->name, match->match);
551 /** Set up the main context the session will be executing in.
553 * Must be called just before the session starts, by the thread which
554 * will execute the session main loop. Once acquired, the main context
555 * pointer is immutable for the duration of the session run.
557 static int set_main_context(struct sr_session *session)
559 GMainContext *def_context;
561 /* May happen if sr_session_start() is called a second time
562 * while the session is still running.
564 if (session->main_context) {
565 sr_err("Main context already set.");
569 g_mutex_lock(&session->main_mutex);
571 def_context = g_main_context_get_thread_default();
574 def_context = g_main_context_default();
576 * Try to use an existing main context if possible, but only if we
577 * can make it owned by the current thread. Otherwise, create our
578 * own main context so that event source callbacks can execute in
579 * the session thread.
581 if (g_main_context_acquire(def_context)) {
582 g_main_context_release(def_context);
584 sr_dbg("Using thread-default main context.");
586 session->main_context = def_context;
587 session->main_context_is_default = TRUE;
589 sr_dbg("Creating our own main context.");
591 session->main_context = g_main_context_new();
592 session->main_context_is_default = FALSE;
594 g_mutex_unlock(&session->main_mutex);
599 /** Unset the main context used for the current session run.
601 * Must be called right after stopping the session. Note that if the
602 * session is stopped asynchronously, the main loop may still be running
603 * after the main context has been unset. This is OK as long as no new
604 * event sources are created -- the main loop holds its own reference
605 * to the main context.
607 static int unset_main_context(struct sr_session *session)
611 g_mutex_lock(&session->main_mutex);
613 if (session->main_context) {
614 if (!session->main_context_is_default)
615 g_main_context_unref(session->main_context);
617 session->main_context = NULL;
620 /* May happen if the set/unset calls are not matched.
622 sr_err("No main context to unset.");
625 g_mutex_unlock(&session->main_mutex);
630 static unsigned int session_source_attach(struct sr_session *session,
635 g_mutex_lock(&session->main_mutex);
637 if (session->main_context)
638 id = g_source_attach(source, session->main_context);
640 sr_err("Cannot add event source without main context.");
642 g_mutex_unlock(&session->main_mutex);
647 /* Idle handler; invoked when the number of registered event sources
648 * for a running session drops to zero.
650 static gboolean delayed_stop_check(void *data)
652 struct sr_session *session;
655 session->stop_check_id = 0;
657 /* Session already ended? */
658 if (!session->running)
659 return G_SOURCE_REMOVE;
661 /* New event sources may have been installed in the meantime. */
662 if (g_hash_table_size(session->event_sources) != 0)
663 return G_SOURCE_REMOVE;
665 session->running = FALSE;
666 unset_main_context(session);
670 /* This indicates a bug in user code, since it is not valid to
671 * restart or destroy a session while it may still be running.
673 if (!session->main_loop && !session->stopped_callback) {
674 sr_err("BUG: Session stop left unhandled.");
675 return G_SOURCE_REMOVE;
677 if (session->main_loop)
678 g_main_loop_quit(session->main_loop);
680 if (session->stopped_callback)
681 (*session->stopped_callback)(session->stopped_cb_data);
683 return G_SOURCE_REMOVE;
686 static int stop_check_later(struct sr_session *session)
689 unsigned int source_id;
691 if (session->stop_check_id != 0)
692 return SR_OK; /* idle handler already installed */
694 source = g_idle_source_new();
695 g_source_set_callback(source, &delayed_stop_check, session, NULL);
697 source_id = session_source_attach(session, source);
698 session->stop_check_id = source_id;
700 g_source_unref(source);
702 return (source_id != 0) ? SR_OK : SR_ERR;
708 * When this function returns with a status code indicating success, the
709 * session is running. Use sr_session_stopped_callback_set() to receive
710 * notification upon completion, or call sr_session_run() to block until
713 * Session events will be processed in the context of the current thread.
714 * If a thread-default GLib main context has been set, and is not owned by
715 * any other thread, it will be used. Otherwise, libsigrok will create its
716 * own main context for the current thread.
718 * @param session The session to use. Must not be NULL.
720 * @retval SR_OK Success.
721 * @retval SR_ERR_ARG Invalid session passed.
722 * @retval SR_ERR Other error.
726 SR_API int sr_session_start(struct sr_session *session)
728 struct sr_dev_inst *sdi;
729 struct sr_channel *ch;
730 GSList *l, *c, *lend;
734 sr_err("%s: session was NULL", __func__);
738 if (!session->devs) {
739 sr_err("%s: session->devs was NULL; a session "
740 "cannot be started without devices.", __func__);
744 if (session->running) {
745 sr_err("Cannot (re-)start session while it is still running.");
749 if (session->trigger) {
750 ret = verify_trigger(session->trigger);
755 /* Check enabled channels and commit settings of all devices. */
756 for (l = session->devs; l; l = l->next) {
758 for (c = sdi->channels; c; c = c->next) {
764 sr_err("%s device %s has no enabled channels.",
765 sdi->driver->name, sdi->connection_id);
769 ret = sr_config_commit(sdi);
771 sr_err("Failed to commit %s device %s settings "
772 "before starting acquisition.",
773 sdi->driver->name, sdi->connection_id);
778 ret = set_main_context(session);
782 sr_info("Starting.");
784 session->running = TRUE;
786 /* Have all devices start acquisition. */
787 for (l = session->devs; l; l = l->next) {
789 ret = sdi->driver->dev_acquisition_start(sdi, sdi);
791 sr_err("Could not start %s device %s acquisition.",
792 sdi->driver->name, sdi->connection_id);
798 /* If there are multiple devices, some of them may already have
799 * started successfully. Stop them now before returning. */
801 for (l = session->devs; l != lend; l = l->next) {
803 if (sdi->driver->dev_acquisition_stop)
804 sdi->driver->dev_acquisition_stop(sdi, sdi);
806 /* TODO: Handle delayed stops. Need to iterate the event
808 session->running = FALSE;
810 unset_main_context(session);
814 if (g_hash_table_size(session->event_sources) == 0)
815 stop_check_later(session);
821 * Block until the running session stops.
823 * This is a convenience function which creates a GLib main loop and runs
824 * it to process session events until the session stops.
826 * Instead of using this function, applications may run their own GLib main
827 * loop, and use sr_session_stopped_callback_set() to receive notification
828 * when the session finished running.
830 * @param session The session to use. Must not be NULL.
832 * @retval SR_OK Success.
833 * @retval SR_ERR_ARG Invalid session passed.
834 * @retval SR_ERR Other error.
838 SR_API int sr_session_run(struct sr_session *session)
841 sr_err("%s: session was NULL", __func__);
844 if (!session->running) {
845 sr_err("No session running.");
848 if (session->main_loop) {
849 sr_err("Main loop already created.");
853 g_mutex_lock(&session->main_mutex);
855 if (!session->main_context) {
856 sr_err("Cannot run without main context.");
857 g_mutex_unlock(&session->main_mutex);
860 session->main_loop = g_main_loop_new(session->main_context, FALSE);
862 g_mutex_unlock(&session->main_mutex);
864 g_main_loop_run(session->main_loop);
866 g_main_loop_unref(session->main_loop);
867 session->main_loop = NULL;
872 static gboolean session_stop_sync(void *user_data)
874 struct sr_session *session;
875 struct sr_dev_inst *sdi;
880 if (!session->running)
881 return G_SOURCE_REMOVE;
883 sr_info("Stopping.");
885 for (node = session->devs; node; node = node->next) {
887 if (sdi->driver && sdi->driver->dev_acquisition_stop)
888 sdi->driver->dev_acquisition_stop(sdi, sdi);
891 return G_SOURCE_REMOVE;
897 * This requests the drivers of each device participating in the session to
898 * abort the acquisition as soon as possible. Even after this function returns,
899 * event processing still continues until all devices have actually stopped.
901 * Use sr_session_stopped_callback_set() to receive notification when the event
902 * processing finished.
904 * This function is reentrant. That is, it may be called from a different
905 * thread than the one executing the session, as long as it can be ensured
906 * that the session object is valid.
908 * If the session is not running, sr_session_stop() silently does nothing.
910 * @param session The session to use. Must not be NULL.
912 * @retval SR_OK Success.
913 * @retval SR_ERR_ARG Invalid session passed.
917 SR_API int sr_session_stop(struct sr_session *session)
919 GMainContext *main_context;
922 sr_err("%s: session was NULL", __func__);
926 g_mutex_lock(&session->main_mutex);
928 main_context = (session->main_context)
929 ? g_main_context_ref(session->main_context)
932 g_mutex_unlock(&session->main_mutex);
935 sr_dbg("No main context set; already stopped?");
936 /* Not an error; as it would be racy. */
939 g_main_context_invoke(main_context, &session_stop_sync, session);
940 g_main_context_unref(main_context);
946 * Return whether the session is currently running.
948 * Note that this function should be called from the same thread
949 * the session was started in.
951 * @param session The session to use. Must not be NULL.
953 * @retval TRUE Session is running.
954 * @retval FALSE Session is not running.
955 * @retval SR_ERR_ARG Invalid session passed.
959 SR_API int sr_session_is_running(struct sr_session *session)
962 sr_err("%s: session was NULL", __func__);
965 return session->running;
969 * Set the callback to be invoked after a session stopped running.
971 * Install a callback to receive notification when a session run stopped.
972 * This can be used to integrate session execution with an existing main
973 * loop, without having to block in sr_session_run().
975 * Note that the callback will be invoked in the context of the thread
976 * that calls sr_session_start().
978 * @param session The session to use. Must not be NULL.
979 * @param cb The callback to invoke on session stop. May be NULL to unset.
980 * @param cb_data User data pointer to be passed to the callback.
982 * @retval SR_OK Success.
983 * @retval SR_ERR_ARG Invalid session passed.
987 SR_API int sr_session_stopped_callback_set(struct sr_session *session,
988 sr_session_stopped_callback cb, void *cb_data)
991 sr_err("%s: session was NULL", __func__);
994 session->stopped_callback = cb;
995 session->stopped_cb_data = cb_data;
1003 * @param packet The packet to show debugging information for.
1005 static void datafeed_dump(const struct sr_datafeed_packet *packet)
1007 const struct sr_datafeed_logic *logic;
1008 const struct sr_datafeed_analog *analog;
1009 const struct sr_datafeed_analog2 *analog2;
1011 /* Please use the same order as in libsigrok.h. */
1012 switch (packet->type) {
1014 sr_dbg("bus: Received SR_DF_HEADER packet.");
1017 sr_dbg("bus: Received SR_DF_END packet.");
1020 sr_dbg("bus: Received SR_DF_META packet.");
1023 sr_dbg("bus: Received SR_DF_TRIGGER packet.");
1026 logic = packet->payload;
1027 sr_dbg("bus: Received SR_DF_LOGIC packet (%" PRIu64 " bytes, "
1028 "unitsize = %d).", logic->length, logic->unitsize);
1031 analog = packet->payload;
1032 sr_dbg("bus: Received SR_DF_ANALOG packet (%d samples).",
1033 analog->num_samples);
1035 case SR_DF_FRAME_BEGIN:
1036 sr_dbg("bus: Received SR_DF_FRAME_BEGIN packet.");
1038 case SR_DF_FRAME_END:
1039 sr_dbg("bus: Received SR_DF_FRAME_END packet.");
1042 analog2 = packet->payload;
1043 sr_dbg("bus: Received SR_DF_ANALOG2 packet (%d samples).",
1044 analog2->num_samples);
1047 sr_dbg("bus: Received unknown packet type: %d.", packet->type);
1053 * Send a packet to whatever is listening on the datafeed bus.
1055 * Hardware drivers use this to send a data packet to the frontend.
1058 * @param packet The datafeed packet to send to the session bus.
1060 * @retval SR_OK Success.
1061 * @retval SR_ERR_ARG Invalid argument.
1065 SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
1066 const struct sr_datafeed_packet *packet)
1069 struct datafeed_callback *cb_struct;
1070 struct sr_datafeed_packet *packet_in, *packet_out;
1071 struct sr_transform *t;
1075 sr_err("%s: sdi was NULL", __func__);
1080 sr_err("%s: packet was NULL", __func__);
1084 if (!sdi->session) {
1085 sr_err("%s: session was NULL", __func__);
1090 * Pass the packet to the first transform module. If that returns
1091 * another packet (instead of NULL), pass that packet to the next
1092 * transform module in the list, and so on.
1094 packet_in = (struct sr_datafeed_packet *)packet;
1095 for (l = sdi->session->transforms; l; l = l->next) {
1097 sr_spew("Running transform module '%s'.", t->module->id);
1098 ret = t->module->receive(t, packet_in, &packet_out);
1100 sr_err("Error while running transform module: %d.", ret);
1105 * If any of the transforms don't return an output
1108 sr_spew("Transform module didn't return a packet, aborting.");
1112 * Use this transform module's output packet as input
1113 * for the next transform module.
1115 packet_in = packet_out;
1121 * If the last transform did output a packet, pass it to all datafeed
1124 for (l = sdi->session->datafeed_callbacks; l; l = l->next) {
1125 if (sr_log_loglevel_get() >= SR_LOG_DBG)
1126 datafeed_dump(packet);
1127 cb_struct = l->data;
1128 cb_struct->cb(sdi, packet, cb_struct->cb_data);
1135 * Add an event source for a file descriptor.
1137 * @param session The session to use. Must not be NULL.
1138 * @param key The key which identifies the event source.
1139 * @param source An event source object. Must not be NULL.
1140 * @retval SR_OK Success.
1141 * @retval SR_ERR_ARG Invalid argument.
1142 * @retval SR_ERR_BUG Event source with @a key already installed.
1143 * @retval SR_ERR Other error.
1145 SR_PRIV int sr_session_source_add_internal(struct sr_session *session,
1146 void *key, GSource *source)
1149 * This must not ever happen, since the source has already been
1150 * created and its finalize() method will remove the key for the
1151 * already installed source. (Well it would, if we did not have
1152 * another sanity check there.)
1154 if (g_hash_table_contains(session->event_sources, key)) {
1155 sr_err("Event source with key %p already exists.", key);
1158 g_hash_table_insert(session->event_sources, key, source);
1160 if (session_source_attach(session, source) == 0)
1166 SR_PRIV int sr_session_fd_source_add(struct sr_session *session,
1167 void *key, gintptr fd, int events, int timeout,
1168 sr_receive_data_callback cb, void *cb_data)
1173 source = fd_source_new(session, key, fd, events, timeout);
1177 g_source_set_callback(source, (GSourceFunc)cb, cb_data, NULL);
1179 ret = sr_session_source_add_internal(session, key, source);
1180 g_source_unref(source);
1186 * Add an event source for a file descriptor.
1188 * @param session The session to use. Must not be NULL.
1189 * @param fd The file descriptor, or a negative value to create a timer source.
1190 * @param events Events to check for.
1191 * @param timeout Max time in ms to wait before the callback is called,
1192 * or -1 to wait indefinitely.
1193 * @param cb Callback function to add. Must not be NULL.
1194 * @param cb_data Data for the callback function. Can be NULL.
1196 * @retval SR_OK Success.
1197 * @retval SR_ERR_ARG Invalid argument.
1201 SR_API int sr_session_source_add(struct sr_session *session, int fd,
1202 int events, int timeout, sr_receive_data_callback cb, void *cb_data)
1204 if (fd < 0 && timeout < 0) {
1205 sr_err("Cannot create timer source without timeout.");
1208 return sr_session_fd_source_add(session, GINT_TO_POINTER(fd),
1209 fd, events, timeout, cb, cb_data);
1213 * Add an event source for a GPollFD.
1215 * @param session The session to use. Must not be NULL.
1216 * @param pollfd The GPollFD. Must not be NULL.
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.
1227 SR_API int sr_session_source_add_pollfd(struct sr_session *session,
1228 GPollFD *pollfd, int timeout, sr_receive_data_callback cb,
1232 sr_err("%s: pollfd was NULL", __func__);
1235 return sr_session_fd_source_add(session, pollfd, pollfd->fd,
1236 pollfd->events, timeout, cb, cb_data);
1240 * Add an event source for a GIOChannel.
1242 * @param session The session to use. Must not be NULL.
1243 * @param channel The GIOChannel.
1244 * @param events Events to poll on.
1245 * @param timeout Max time in ms to wait before the callback is called,
1246 * or -1 to wait indefinitely.
1247 * @param cb Callback function to add. Must not be NULL.
1248 * @param cb_data Data for the callback function. Can be NULL.
1250 * @retval SR_OK Success.
1251 * @retval SR_ERR_ARG Invalid argument.
1255 SR_API int sr_session_source_add_channel(struct sr_session *session,
1256 GIOChannel *channel, int events, int timeout,
1257 sr_receive_data_callback cb, void *cb_data)
1262 sr_err("%s: channel was NULL", __func__);
1265 /* We should be using g_io_create_watch(), but can't without
1266 * changing the driver API, as the callback signature is different.
1269 g_io_channel_win32_make_pollfd(channel, events, &pollfd);
1271 pollfd.fd = g_io_channel_unix_get_fd(channel);
1272 pollfd.events = events;
1274 return sr_session_fd_source_add(session, channel, pollfd.fd,
1275 pollfd.events, timeout, cb, cb_data);
1279 * Remove the source identified by the specified poll object.
1281 * @param session The session to use. Must not be NULL.
1282 * @param key The key by which the source is identified.
1284 * @retval SR_OK Success
1285 * @retval SR_ERR_BUG No event source for poll_object found.
1287 SR_PRIV int sr_session_source_remove_internal(struct sr_session *session,
1292 source = g_hash_table_lookup(session->event_sources, key);
1294 * Trying to remove an already removed event source is problematic
1295 * since the poll_object handle may have been reused in the meantime.
1298 sr_warn("Cannot remove non-existing event source %p.", key);
1301 g_source_destroy(source);
1307 * Remove the source belonging to the specified file descriptor.
1309 * @param session The session to use. Must not be NULL.
1310 * @param fd The file descriptor for which the source should be removed.
1312 * @retval SR_OK Success
1313 * @retval SR_ERR_ARG Invalid argument
1314 * @retval SR_ERR_BUG Internal error.
1318 SR_API int sr_session_source_remove(struct sr_session *session, int fd)
1320 return sr_session_source_remove_internal(session, GINT_TO_POINTER(fd));
1324 * Remove the source belonging to the specified poll descriptor.
1326 * @param session The session to use. Must not be NULL.
1327 * @param pollfd The poll descriptor for which the source should be removed.
1329 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
1330 * SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon
1335 SR_API int sr_session_source_remove_pollfd(struct sr_session *session,
1339 sr_err("%s: pollfd was NULL", __func__);
1342 return sr_session_source_remove_internal(session, pollfd);
1346 * Remove the source belonging to the specified channel.
1348 * @param session The session to use. Must not be NULL.
1349 * @param channel The channel for which the source should be removed.
1351 * @retval SR_OK Success.
1352 * @retval SR_ERR_ARG Invalid argument.
1353 * @return SR_ERR_BUG Internal error.
1357 SR_API int sr_session_source_remove_channel(struct sr_session *session,
1358 GIOChannel *channel)
1361 sr_err("%s: channel was NULL", __func__);
1364 return sr_session_source_remove_internal(session, channel);
1367 /** Unregister an event source that has been destroyed.
1369 * This is intended to be called from a source's finalize() method.
1371 * @param session The session to use. Must not be NULL.
1372 * @param key The key used to identify @a source.
1373 * @param source The source object that was destroyed.
1375 * @retval SR_OK Success.
1376 * @retval SR_ERR_BUG Event source for @a key does not match @a source.
1377 * @retval SR_ERR Other error.
1379 SR_PRIV int sr_session_source_destroyed(struct sr_session *session,
1380 void *key, GSource *source)
1382 GSource *registered_source;
1384 registered_source = g_hash_table_lookup(session->event_sources, key);
1386 * Trying to remove an already removed event source is problematic
1387 * since the poll_object handle may have been reused in the meantime.
1389 if (!registered_source) {
1390 sr_err("No event source for key %p found.", key);
1393 if (registered_source != source) {
1394 sr_err("Event source for key %p does not match"
1395 " destroyed source.", key);
1398 g_hash_table_remove(session->event_sources, key);
1400 if (g_hash_table_size(session->event_sources) > 0)
1403 /* If no event sources are left, consider the acquisition finished.
1404 * This is pretty crude, as it requires all event sources to be
1405 * registered via the libsigrok API.
1407 return stop_check_later(session);
1410 static void copy_src(struct sr_config *src, struct sr_datafeed_meta *meta_copy)
1412 g_variant_ref(src->data);
1413 meta_copy->config = g_slist_append(meta_copy->config,
1414 g_memdup(src, sizeof(struct sr_config)));
1417 SR_PRIV int sr_packet_copy(const struct sr_datafeed_packet *packet,
1418 struct sr_datafeed_packet **copy)
1420 const struct sr_datafeed_meta *meta;
1421 struct sr_datafeed_meta *meta_copy;
1422 const struct sr_datafeed_logic *logic;
1423 struct sr_datafeed_logic *logic_copy;
1424 const struct sr_datafeed_analog *analog;
1425 struct sr_datafeed_analog *analog_copy;
1426 const struct sr_datafeed_analog2 *analog2;
1427 struct sr_datafeed_analog2 *analog2_copy;
1430 *copy = g_malloc0(sizeof(struct sr_datafeed_packet));
1431 (*copy)->type = packet->type;
1433 switch (packet->type) {
1439 payload = g_malloc(sizeof(struct sr_datafeed_header));
1440 memcpy(payload, packet->payload, sizeof(struct sr_datafeed_header));
1441 (*copy)->payload = payload;
1444 meta = packet->payload;
1445 meta_copy = g_malloc0(sizeof(struct sr_datafeed_meta));
1446 g_slist_foreach(meta->config, (GFunc)copy_src, meta_copy->config);
1447 (*copy)->payload = meta_copy;
1450 logic = packet->payload;
1451 logic_copy = g_malloc(sizeof(logic));
1452 logic_copy->length = logic->length;
1453 logic_copy->unitsize = logic->unitsize;
1454 memcpy(logic_copy->data, logic->data, logic->length * logic->unitsize);
1455 (*copy)->payload = logic_copy;
1458 analog = packet->payload;
1459 analog_copy = g_malloc(sizeof(analog));
1460 analog_copy->channels = g_slist_copy(analog->channels);
1461 analog_copy->num_samples = analog->num_samples;
1462 analog_copy->mq = analog->mq;
1463 analog_copy->unit = analog->unit;
1464 analog_copy->mqflags = analog->mqflags;
1465 analog_copy->data = g_malloc(analog->num_samples * sizeof(float));
1466 memcpy(analog_copy->data, analog->data,
1467 analog->num_samples * sizeof(float));
1468 (*copy)->payload = analog_copy;
1471 analog2 = packet->payload;
1472 analog2_copy = g_malloc(sizeof(analog2));
1473 analog2_copy->data = g_malloc(
1474 analog2->encoding->unitsize * analog2->num_samples);
1475 memcpy(analog2_copy->data, analog2->data,
1476 analog2->encoding->unitsize * analog2->num_samples);
1477 analog2_copy->num_samples = analog2->num_samples;
1478 analog2_copy->encoding = g_memdup(analog2->encoding,
1479 sizeof(struct sr_analog_encoding));
1480 analog2_copy->meaning = g_memdup(analog2->meaning,
1481 sizeof(struct sr_analog_meaning));
1482 analog2_copy->meaning->channels = g_slist_copy(
1483 analog2->meaning->channels);
1484 analog2_copy->spec = g_memdup(analog2->spec,
1485 sizeof(struct sr_analog_spec));
1486 (*copy)->payload = analog2_copy;
1489 sr_err("Unknown packet type %d", packet->type);
1496 void sr_packet_free(struct sr_datafeed_packet *packet)
1498 const struct sr_datafeed_meta *meta;
1499 const struct sr_datafeed_logic *logic;
1500 const struct sr_datafeed_analog *analog;
1501 const struct sr_datafeed_analog2 *analog2;
1502 struct sr_config *src;
1505 switch (packet->type) {
1511 /* Payload is a simple struct. */
1512 g_free((void *)packet->payload);
1515 meta = packet->payload;
1516 for (l = meta->config; l; l = l->next) {
1518 g_variant_unref(src->data);
1521 g_slist_free(meta->config);
1522 g_free((void *)packet->payload);
1525 logic = packet->payload;
1526 g_free(logic->data);
1527 g_free((void *)packet->payload);
1530 analog = packet->payload;
1531 g_slist_free(analog->channels);
1532 g_free(analog->data);
1533 g_free((void *)packet->payload);
1536 analog2 = packet->payload;
1537 g_free(analog2->data);
1538 g_free(analog2->encoding);
1539 g_slist_free(analog2->meaning->channels);
1540 g_free(analog2->meaning);
1541 g_free(analog2->spec);
1542 g_free((void *)packet->payload);
1545 sr_err("Unknown packet type %d", packet->type);