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 events Events.
161 * @param timeout_ms The timeout interval in ms, or -1 to wait indefinitely.
163 * @return A new event source object, or NULL on failure.
165 static GSource *fd_source_new(struct sr_session *session, void *key,
166 gintptr fd, int events, int timeout_ms)
168 static GSourceFuncs fd_source_funcs = {
169 .prepare = &fd_source_prepare,
170 .check = &fd_source_check,
171 .dispatch = &fd_source_dispatch,
172 .finalize = &fd_source_finalize
175 struct fd_source *fsource;
177 source = g_source_new(&fd_source_funcs, sizeof(struct fd_source));
178 fsource = (struct fd_source *)source;
180 g_source_set_name(source, (fd < 0) ? "timer" : "fd");
182 if (timeout_ms >= 0) {
183 fsource->timeout_us = 1000 * (int64_t)timeout_ms;
186 fsource->timeout_us = -1;
187 fsource->due_us = INT64_MAX;
189 fsource->session = session;
192 fsource->pollfd.fd = fd;
193 fsource->pollfd.events = events;
194 fsource->pollfd.revents = 0;
197 g_source_add_poll(source, &fsource->pollfd);
203 * Create a new session.
205 * @param ctx The context in which to create the new session.
206 * @param new_session This will contain a pointer to the newly created
207 * session if the return value is SR_OK, otherwise the value
208 * is undefined and should not be used. Must not be NULL.
210 * @retval SR_OK Success.
211 * @retval SR_ERR_ARG Invalid argument.
215 SR_API int sr_session_new(struct sr_context *ctx,
216 struct sr_session **new_session)
218 struct sr_session *session;
223 session = g_malloc0(sizeof(struct sr_session));
227 g_mutex_init(&session->main_mutex);
229 /* To maintain API compatibility, we need a lookup table
230 * which maps poll_object IDs to GSource* pointers.
232 session->event_sources = g_hash_table_new(NULL, NULL);
234 *new_session = session;
241 * This frees up all memory used by the session.
243 * @param session The session to destroy. Must not be NULL.
245 * @retval SR_OK Success.
246 * @retval SR_ERR_ARG Invalid session passed.
250 SR_API int sr_session_destroy(struct sr_session *session)
253 sr_err("%s: session was NULL", __func__);
257 sr_session_dev_remove_all(session);
258 g_slist_free_full(session->owned_devs, (GDestroyNotify)sr_dev_inst_free);
260 sr_session_datafeed_callback_remove_all(session);
262 g_hash_table_unref(session->event_sources);
264 g_mutex_clear(&session->main_mutex);
272 * Remove all the devices from a session.
274 * The session itself (i.e., the struct sr_session) is not free'd and still
275 * exists after this function returns.
277 * @param session The session to use. Must not be NULL.
279 * @retval SR_OK Success.
280 * @retval SR_ERR_BUG Invalid session passed.
284 SR_API int sr_session_dev_remove_all(struct sr_session *session)
286 struct sr_dev_inst *sdi;
290 sr_err("%s: session was NULL", __func__);
294 for (l = session->devs; l; l = l->next) {
295 sdi = (struct sr_dev_inst *) l->data;
299 g_slist_free(session->devs);
300 session->devs = NULL;
306 * Add a device instance to a session.
308 * @param session The session to add to. Must not be NULL.
309 * @param sdi The device instance to add to a session. Must not
310 * be NULL. Also, sdi->driver and sdi->driver->dev_open must
313 * @retval SR_OK Success.
314 * @retval SR_ERR_ARG Invalid argument.
318 SR_API int sr_session_dev_add(struct sr_session *session,
319 struct sr_dev_inst *sdi)
324 sr_err("%s: sdi was NULL", __func__);
329 sr_err("%s: session was NULL", __func__);
333 /* If sdi->session is not NULL, the device is already in this or
334 * another session. */
336 sr_err("%s: already assigned to session", __func__);
340 /* If sdi->driver is NULL, this is a virtual device. */
342 /* Just add the device, don't run dev_open(). */
343 session->devs = g_slist_append(session->devs, sdi);
344 sdi->session = session;
348 /* sdi->driver is non-NULL (i.e. we have a real device). */
349 if (!sdi->driver->dev_open) {
350 sr_err("%s: sdi->driver->dev_open was NULL", __func__);
354 session->devs = g_slist_append(session->devs, sdi);
355 sdi->session = session;
357 /* TODO: This is invalid if the session runs in a different thread.
358 * The usage semantics and restrictions need to be documented.
360 if (session->running) {
361 /* Adding a device to a running session. Commit settings
362 * and start acquisition on that device now. */
363 if ((ret = sr_config_commit(sdi)) != SR_OK) {
364 sr_err("Failed to commit device settings before "
365 "starting acquisition in running session (%s)",
369 if ((ret = sr_dev_acquisition_start(sdi)) != SR_OK) {
370 sr_err("Failed to start acquisition of device in "
371 "running session (%s)", sr_strerror(ret));
380 * List all device instances attached to a session.
382 * @param session The session to use. Must not be NULL.
383 * @param devlist A pointer where the device instance list will be
384 * stored on return. If no devices are in the session,
385 * this will be NULL. Each element in the list points
386 * to a struct sr_dev_inst *.
387 * The list must be freed by the caller, but not the
388 * elements pointed to.
390 * @retval SR_OK Success.
391 * @retval SR_ERR_ARG Invalid argument.
395 SR_API int sr_session_dev_list(struct sr_session *session, GSList **devlist)
403 *devlist = g_slist_copy(session->devs);
409 * Remove a device instance from a session.
411 * @param session The session to remove from. Must not be NULL.
412 * @param sdi The device instance to remove from a session. Must not
413 * be NULL. Also, sdi->driver and sdi->driver->dev_open must
416 * @retval SR_OK Success.
417 * @retval SR_ERR_ARG Invalid argument.
421 SR_API int sr_session_dev_remove(struct sr_session *session,
422 struct sr_dev_inst *sdi)
425 sr_err("%s: sdi was NULL", __func__);
430 sr_err("%s: session was NULL", __func__);
434 /* If sdi->session is not session, the device is not in this
436 if (sdi->session != session) {
437 sr_err("%s: not assigned to this session", __func__);
441 session->devs = g_slist_remove(session->devs, sdi);
448 * Remove all datafeed callbacks in a session.
450 * @param session The session to use. Must not be NULL.
452 * @retval SR_OK Success.
453 * @retval SR_ERR_ARG Invalid session passed.
457 SR_API int sr_session_datafeed_callback_remove_all(struct sr_session *session)
460 sr_err("%s: session was NULL", __func__);
464 g_slist_free_full(session->datafeed_callbacks, g_free);
465 session->datafeed_callbacks = NULL;
471 * Add a datafeed callback to a session.
473 * @param session The session to use. Must not be NULL.
474 * @param cb Function to call when a chunk of data is received.
476 * @param cb_data Opaque pointer passed in by the caller.
478 * @retval SR_OK Success.
479 * @retval SR_ERR_BUG No session exists.
483 SR_API int sr_session_datafeed_callback_add(struct sr_session *session,
484 sr_datafeed_callback cb, void *cb_data)
486 struct datafeed_callback *cb_struct;
489 sr_err("%s: session was NULL", __func__);
494 sr_err("%s: cb was NULL", __func__);
498 cb_struct = g_malloc0(sizeof(struct datafeed_callback));
500 cb_struct->cb_data = cb_data;
502 session->datafeed_callbacks =
503 g_slist_append(session->datafeed_callbacks, cb_struct);
509 * Get the trigger assigned to this session.
511 * @param session The session to use.
513 * @retval NULL Invalid (NULL) session was passed to the function.
514 * @retval other The trigger assigned to this session (can be NULL).
518 SR_API struct sr_trigger *sr_session_trigger_get(struct sr_session *session)
523 return session->trigger;
527 * Set the trigger of this session.
529 * @param session The session to use. Must not be NULL.
530 * @param trig The trigger to assign to this session. Can be NULL.
532 * @retval SR_OK Success.
533 * @retval SR_ERR_ARG Invalid argument.
537 SR_API int sr_session_trigger_set(struct sr_session *session, struct sr_trigger *trig)
542 session->trigger = trig;
547 static int verify_trigger(struct sr_trigger *trigger)
549 struct sr_trigger_stage *stage;
550 struct sr_trigger_match *match;
553 if (!trigger->stages) {
554 sr_err("No trigger stages defined.");
558 sr_spew("Checking trigger:");
559 for (l = trigger->stages; l; l = l->next) {
561 if (!stage->matches) {
562 sr_err("Stage %d has no matches defined.", stage->stage);
565 for (m = stage->matches; m; m = m->next) {
567 if (!match->channel) {
568 sr_err("Stage %d match has no channel.", stage->stage);
572 sr_err("Stage %d match is not defined.", stage->stage);
575 sr_spew("Stage %d match on channel %s, match %d", stage->stage,
576 match->channel->name, match->match);
583 /** Set up the main context the session will be executing in.
585 * Must be called just before the session starts, by the thread which
586 * will execute the session main loop. Once acquired, the main context
587 * pointer is immutable for the duration of the session run.
589 static int set_main_context(struct sr_session *session)
591 GMainContext *main_context;
593 g_mutex_lock(&session->main_mutex);
595 /* May happen if sr_session_start() is called a second time
596 * while the session is still running.
598 if (session->main_context) {
599 sr_err("Main context already set.");
601 g_mutex_unlock(&session->main_mutex);
604 main_context = g_main_context_ref_thread_default();
606 * Try to use an existing main context if possible, but only if we
607 * can make it owned by the current thread. Otherwise, create our
608 * own main context so that event source callbacks can execute in
609 * the session thread.
611 if (g_main_context_acquire(main_context)) {
612 g_main_context_release(main_context);
614 sr_dbg("Using thread-default main context.");
616 g_main_context_unref(main_context);
618 sr_dbg("Creating our own main context.");
619 main_context = g_main_context_new();
621 session->main_context = main_context;
623 g_mutex_unlock(&session->main_mutex);
628 /** Unset the main context used for the current session run.
630 * Must be called right after stopping the session. Note that if the
631 * session is stopped asynchronously, the main loop may still be running
632 * after the main context has been unset. This is OK as long as no new
633 * event sources are created -- the main loop holds its own reference
634 * to the main context.
636 static int unset_main_context(struct sr_session *session)
640 g_mutex_lock(&session->main_mutex);
642 if (session->main_context) {
643 g_main_context_unref(session->main_context);
644 session->main_context = NULL;
647 /* May happen if the set/unset calls are not matched.
649 sr_err("No main context to unset.");
652 g_mutex_unlock(&session->main_mutex);
657 static unsigned int session_source_attach(struct sr_session *session,
662 g_mutex_lock(&session->main_mutex);
664 if (session->main_context)
665 id = g_source_attach(source, session->main_context);
667 sr_err("Cannot add event source without main context.");
669 g_mutex_unlock(&session->main_mutex);
674 /* Idle handler; invoked when the number of registered event sources
675 * for a running session drops to zero.
677 static gboolean delayed_stop_check(void *data)
679 struct sr_session *session;
682 session->stop_check_id = 0;
684 /* Session already ended? */
685 if (!session->running)
686 return G_SOURCE_REMOVE;
688 /* New event sources may have been installed in the meantime. */
689 if (g_hash_table_size(session->event_sources) != 0)
690 return G_SOURCE_REMOVE;
692 session->running = FALSE;
693 unset_main_context(session);
697 /* This indicates a bug in user code, since it is not valid to
698 * restart or destroy a session while it may still be running.
700 if (!session->main_loop && !session->stopped_callback) {
701 sr_err("BUG: Session stop left unhandled.");
702 return G_SOURCE_REMOVE;
704 if (session->main_loop)
705 g_main_loop_quit(session->main_loop);
707 if (session->stopped_callback)
708 (*session->stopped_callback)(session->stopped_cb_data);
710 return G_SOURCE_REMOVE;
713 static int stop_check_later(struct sr_session *session)
716 unsigned int source_id;
718 if (session->stop_check_id != 0)
719 return SR_OK; /* idle handler already installed */
721 source = g_idle_source_new();
722 g_source_set_callback(source, &delayed_stop_check, session, NULL);
724 source_id = session_source_attach(session, source);
725 session->stop_check_id = source_id;
727 g_source_unref(source);
729 return (source_id != 0) ? SR_OK : SR_ERR;
735 * When this function returns with a status code indicating success, the
736 * session is running. Use sr_session_stopped_callback_set() to receive
737 * notification upon completion, or call sr_session_run() to block until
740 * Session events will be processed in the context of the current thread.
741 * If a thread-default GLib main context has been set, and is not owned by
742 * any other thread, it will be used. Otherwise, libsigrok will create its
743 * own main context for the current thread.
745 * @param session The session to use. Must not be NULL.
747 * @retval SR_OK Success.
748 * @retval SR_ERR_ARG Invalid session passed.
749 * @retval SR_ERR Other error.
753 SR_API int sr_session_start(struct sr_session *session)
755 struct sr_dev_inst *sdi;
756 struct sr_channel *ch;
757 GSList *l, *c, *lend;
761 sr_err("%s: session was NULL", __func__);
765 if (!session->devs) {
766 sr_err("%s: session->devs was NULL; a session "
767 "cannot be started without devices.", __func__);
771 if (session->running) {
772 sr_err("Cannot (re-)start session while it is still running.");
776 if (session->trigger) {
777 ret = verify_trigger(session->trigger);
782 /* Check enabled channels and commit settings of all devices. */
783 for (l = session->devs; l; l = l->next) {
785 for (c = sdi->channels; c; c = c->next) {
791 sr_err("%s device %s has no enabled channels.",
792 sdi->driver->name, sdi->connection_id);
796 ret = sr_config_commit(sdi);
798 sr_err("Failed to commit %s device %s settings "
799 "before starting acquisition.",
800 sdi->driver->name, sdi->connection_id);
805 ret = set_main_context(session);
809 sr_info("Starting.");
811 session->running = TRUE;
813 /* Have all devices start acquisition. */
814 for (l = session->devs; l; l = l->next) {
815 if (!(sdi = l->data)) {
816 sr_err("Device sdi was NULL, can't start session.");
820 ret = sr_dev_acquisition_start(sdi);
822 sr_err("Could not start %s device %s acquisition.",
823 sdi->driver->name, sdi->connection_id);
829 /* If there are multiple devices, some of them may already have
830 * started successfully. Stop them now before returning. */
832 for (l = session->devs; l != lend; l = l->next) {
834 sr_dev_acquisition_stop(sdi);
836 /* TODO: Handle delayed stops. Need to iterate the event
838 session->running = FALSE;
840 unset_main_context(session);
844 if (g_hash_table_size(session->event_sources) == 0)
845 stop_check_later(session);
851 * Block until the running session stops.
853 * This is a convenience function which creates a GLib main loop and runs
854 * it to process session events until the session stops.
856 * Instead of using this function, applications may run their own GLib main
857 * loop, and use sr_session_stopped_callback_set() to receive notification
858 * when the session finished running.
860 * @param session The session to use. Must not be NULL.
862 * @retval SR_OK Success.
863 * @retval SR_ERR_ARG Invalid session passed.
864 * @retval SR_ERR Other error.
868 SR_API int sr_session_run(struct sr_session *session)
871 sr_err("%s: session was NULL", __func__);
874 if (!session->running) {
875 sr_err("No session running.");
878 if (session->main_loop) {
879 sr_err("Main loop already created.");
883 g_mutex_lock(&session->main_mutex);
885 if (!session->main_context) {
886 sr_err("Cannot run without main context.");
887 g_mutex_unlock(&session->main_mutex);
890 session->main_loop = g_main_loop_new(session->main_context, FALSE);
892 g_mutex_unlock(&session->main_mutex);
894 g_main_loop_run(session->main_loop);
896 g_main_loop_unref(session->main_loop);
897 session->main_loop = NULL;
902 static gboolean session_stop_sync(void *user_data)
904 struct sr_session *session;
905 struct sr_dev_inst *sdi;
910 if (!session->running)
911 return G_SOURCE_REMOVE;
913 sr_info("Stopping.");
915 for (node = session->devs; node; node = node->next) {
917 sr_dev_acquisition_stop(sdi);
920 return G_SOURCE_REMOVE;
926 * This requests the drivers of each device participating in the session to
927 * abort the acquisition as soon as possible. Even after this function returns,
928 * event processing still continues until all devices have actually stopped.
930 * Use sr_session_stopped_callback_set() to receive notification when the event
931 * processing finished.
933 * This function is reentrant. That is, it may be called from a different
934 * thread than the one executing the session, as long as it can be ensured
935 * that the session object is valid.
937 * If the session is not running, sr_session_stop() silently does nothing.
939 * @param session The session to use. Must not be NULL.
941 * @retval SR_OK Success.
942 * @retval SR_ERR_ARG Invalid session passed.
946 SR_API int sr_session_stop(struct sr_session *session)
948 GMainContext *main_context;
951 sr_err("%s: session was NULL", __func__);
955 g_mutex_lock(&session->main_mutex);
957 main_context = (session->main_context)
958 ? g_main_context_ref(session->main_context)
961 g_mutex_unlock(&session->main_mutex);
964 sr_dbg("No main context set; already stopped?");
965 /* Not an error; as it would be racy. */
968 g_main_context_invoke(main_context, &session_stop_sync, session);
969 g_main_context_unref(main_context);
975 * Return whether the session is currently running.
977 * Note that this function should be called from the same thread
978 * the session was started in.
980 * @param session The session to use. Must not be NULL.
982 * @retval TRUE Session is running.
983 * @retval FALSE Session is not running.
984 * @retval SR_ERR_ARG Invalid session passed.
988 SR_API int sr_session_is_running(struct sr_session *session)
991 sr_err("%s: session was NULL", __func__);
994 return session->running;
998 * Set the callback to be invoked after a session stopped running.
1000 * Install a callback to receive notification when a session run stopped.
1001 * This can be used to integrate session execution with an existing main
1002 * loop, without having to block in sr_session_run().
1004 * Note that the callback will be invoked in the context of the thread
1005 * that calls sr_session_start().
1007 * @param session The session to use. Must not be NULL.
1008 * @param cb The callback to invoke on session stop. May be NULL to unset.
1009 * @param cb_data User data pointer to be passed to the callback.
1011 * @retval SR_OK Success.
1012 * @retval SR_ERR_ARG Invalid session passed.
1016 SR_API int sr_session_stopped_callback_set(struct sr_session *session,
1017 sr_session_stopped_callback cb, void *cb_data)
1020 sr_err("%s: session was NULL", __func__);
1023 session->stopped_callback = cb;
1024 session->stopped_cb_data = cb_data;
1032 * @param packet The packet to show debugging information for.
1034 static void datafeed_dump(const struct sr_datafeed_packet *packet)
1036 const struct sr_datafeed_logic *logic;
1037 const struct sr_datafeed_analog *analog;
1039 /* Please use the same order as in libsigrok.h. */
1040 switch (packet->type) {
1042 sr_dbg("bus: Received SR_DF_HEADER packet.");
1045 sr_dbg("bus: Received SR_DF_END packet.");
1048 sr_dbg("bus: Received SR_DF_META packet.");
1051 sr_dbg("bus: Received SR_DF_TRIGGER packet.");
1054 logic = packet->payload;
1055 sr_dbg("bus: Received SR_DF_LOGIC packet (%" PRIu64 " bytes, "
1056 "unitsize = %d).", logic->length, logic->unitsize);
1058 case SR_DF_FRAME_BEGIN:
1059 sr_dbg("bus: Received SR_DF_FRAME_BEGIN packet.");
1061 case SR_DF_FRAME_END:
1062 sr_dbg("bus: Received SR_DF_FRAME_END packet.");
1065 analog = packet->payload;
1066 sr_dbg("bus: Received SR_DF_ANALOG packet (%d samples).",
1067 analog->num_samples);
1070 sr_dbg("bus: Received unknown packet type: %d.", packet->type);
1076 * Helper to send a meta datafeed package (SR_DF_META) to the session bus.
1078 * @param sdi The device instance to send the package from. Must not be NULL.
1079 * @param key The config key to send to the session bus.
1080 * @param var The value 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_meta(const struct sr_dev_inst *sdi,
1088 uint32_t key, GVariant *var)
1090 struct sr_config *cfg;
1091 struct sr_datafeed_packet packet;
1092 struct sr_datafeed_meta meta;
1095 cfg = sr_config_new(key, var);
1097 memset(&meta, 0, sizeof(meta));
1099 packet.type = SR_DF_META;
1100 packet.payload = &meta;
1102 meta.config = g_slist_append(NULL, cfg);
1104 ret = sr_session_send(sdi, &packet);
1105 g_slist_free(meta.config);
1106 sr_config_free(cfg);
1112 * Send a packet to whatever is listening on the datafeed bus.
1114 * Hardware drivers use this to send a data packet to the frontend.
1117 * @param packet The datafeed packet to send to the session bus.
1119 * @retval SR_OK Success.
1120 * @retval SR_ERR_ARG Invalid argument.
1124 SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
1125 const struct sr_datafeed_packet *packet)
1128 struct datafeed_callback *cb_struct;
1129 struct sr_datafeed_packet *packet_in, *packet_out;
1130 struct sr_transform *t;
1134 sr_err("%s: sdi was NULL", __func__);
1139 sr_err("%s: packet was NULL", __func__);
1143 if (!sdi->session) {
1144 sr_err("%s: session was NULL", __func__);
1149 * Pass the packet to the first transform module. If that returns
1150 * another packet (instead of NULL), pass that packet to the next
1151 * transform module in the list, and so on.
1153 packet_in = (struct sr_datafeed_packet *)packet;
1154 for (l = sdi->session->transforms; l; l = l->next) {
1156 sr_spew("Running transform module '%s'.", t->module->id);
1157 ret = t->module->receive(t, packet_in, &packet_out);
1159 sr_err("Error while running transform module: %d.", ret);
1164 * If any of the transforms don't return an output
1167 sr_spew("Transform module didn't return a packet, aborting.");
1171 * Use this transform module's output packet as input
1172 * for the next transform module.
1174 packet_in = packet_out;
1180 * If the last transform did output a packet, pass it to all datafeed
1183 for (l = sdi->session->datafeed_callbacks; l; l = l->next) {
1184 if (sr_log_loglevel_get() >= SR_LOG_DBG)
1185 datafeed_dump(packet);
1186 cb_struct = l->data;
1187 cb_struct->cb(sdi, packet, cb_struct->cb_data);
1194 * Add an event source for a file descriptor.
1196 * @param session The session to use. Must not be NULL.
1197 * @param key The key which identifies the event source.
1198 * @param source An event source object. Must not be NULL.
1200 * @retval SR_OK Success.
1201 * @retval SR_ERR_ARG Invalid argument.
1202 * @retval SR_ERR_BUG Event source with @a key already installed.
1203 * @retval SR_ERR Other error.
1207 SR_PRIV int sr_session_source_add_internal(struct sr_session *session,
1208 void *key, GSource *source)
1211 * This must not ever happen, since the source has already been
1212 * created and its finalize() method will remove the key for the
1213 * already installed source. (Well it would, if we did not have
1214 * another sanity check there.)
1216 if (g_hash_table_contains(session->event_sources, key)) {
1217 sr_err("Event source with key %p already exists.", key);
1220 g_hash_table_insert(session->event_sources, key, source);
1222 if (session_source_attach(session, source) == 0)
1229 SR_PRIV int sr_session_fd_source_add(struct sr_session *session,
1230 void *key, gintptr fd, int events, int timeout,
1231 sr_receive_data_callback cb, void *cb_data)
1236 source = fd_source_new(session, key, fd, events, timeout);
1240 g_source_set_callback(source, G_SOURCE_FUNC(cb), cb_data, NULL);
1242 ret = sr_session_source_add_internal(session, key, source);
1243 g_source_unref(source);
1249 * Add an event source for a file descriptor.
1251 * @param session The session to use. Must not be NULL.
1252 * @param fd The file descriptor, or a negative value to create a timer source.
1253 * @param events Events to check for.
1254 * @param timeout Max time in ms to wait before the callback is called,
1255 * or -1 to wait indefinitely.
1256 * @param cb Callback function to add. Must not be NULL.
1257 * @param cb_data Data for the callback function. Can be NULL.
1259 * @retval SR_OK Success.
1260 * @retval SR_ERR_ARG Invalid argument.
1265 SR_PRIV int sr_session_source_add(struct sr_session *session, int fd,
1266 int events, int timeout, sr_receive_data_callback cb, void *cb_data)
1268 if (fd < 0 && timeout < 0) {
1269 sr_err("Cannot create timer source without timeout.");
1272 return sr_session_fd_source_add(session, GINT_TO_POINTER(fd),
1273 fd, events, timeout, cb, cb_data);
1277 * Add an event source for a GPollFD.
1279 * @param session The session to use. Must not be NULL.
1280 * @param pollfd The GPollFD. Must not be NULL.
1281 * @param timeout Max time in ms to wait before the callback is called,
1282 * or -1 to wait indefinitely.
1283 * @param cb Callback function to add. Must not be NULL.
1284 * @param cb_data Data for the callback function. Can be NULL.
1286 * @retval SR_OK Success.
1287 * @retval SR_ERR_ARG Invalid argument.
1292 SR_PRIV int sr_session_source_add_pollfd(struct sr_session *session,
1293 GPollFD *pollfd, int timeout, sr_receive_data_callback cb,
1297 sr_err("%s: pollfd was NULL", __func__);
1300 return sr_session_fd_source_add(session, pollfd, pollfd->fd,
1301 pollfd->events, timeout, cb, cb_data);
1305 * Add an event source for a GIOChannel.
1307 * @param session The session to use. Must not be NULL.
1308 * @param channel The GIOChannel.
1309 * @param events Events to poll on.
1310 * @param timeout Max time in ms to wait before the callback is called,
1311 * or -1 to wait indefinitely.
1312 * @param cb Callback function to add. Must not be NULL.
1313 * @param cb_data Data for the callback function. Can be NULL.
1315 * @retval SR_OK Success.
1316 * @retval SR_ERR_ARG Invalid argument.
1321 SR_PRIV int sr_session_source_add_channel(struct sr_session *session,
1322 GIOChannel *channel, int events, int timeout,
1323 sr_receive_data_callback cb, void *cb_data)
1328 sr_err("%s: channel was NULL", __func__);
1331 /* We should be using g_io_create_watch(), but can't without
1332 * changing the driver API, as the callback signature is different.
1335 g_io_channel_win32_make_pollfd(channel, events, &pollfd);
1337 pollfd.fd = g_io_channel_unix_get_fd(channel);
1338 pollfd.events = events;
1340 return sr_session_fd_source_add(session, channel, pollfd.fd,
1341 pollfd.events, timeout, cb, cb_data);
1345 * Remove the source identified by the specified poll object.
1347 * @param session The session to use. Must not be NULL.
1348 * @param key The key by which the source is identified.
1350 * @retval SR_OK Success
1351 * @retval SR_ERR_BUG No event source for poll_object found.
1355 SR_PRIV int sr_session_source_remove_internal(struct sr_session *session,
1360 source = g_hash_table_lookup(session->event_sources, key);
1362 * Trying to remove an already removed event source is problematic
1363 * since the poll_object handle may have been reused in the meantime.
1366 sr_warn("Cannot remove non-existing event source %p.", key);
1369 g_source_destroy(source);
1375 * Remove the source belonging to the specified file descriptor.
1377 * @param session The session to use. Must not be NULL.
1378 * @param fd The file descriptor for which the source should be removed.
1380 * @retval SR_OK Success
1381 * @retval SR_ERR_ARG Invalid argument
1382 * @retval SR_ERR_BUG Internal error.
1387 SR_PRIV int sr_session_source_remove(struct sr_session *session, int fd)
1389 return sr_session_source_remove_internal(session, GINT_TO_POINTER(fd));
1393 * Remove the source belonging to the specified poll descriptor.
1395 * @param session The session to use. Must not be NULL.
1396 * @param pollfd The poll descriptor for which the source should be removed.
1398 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
1399 * SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon
1405 SR_PRIV int sr_session_source_remove_pollfd(struct sr_session *session,
1409 sr_err("%s: pollfd was NULL", __func__);
1412 return sr_session_source_remove_internal(session, pollfd);
1416 * Remove the source belonging to the specified channel.
1418 * @param session The session to use. Must not be NULL.
1419 * @param channel The channel for which the source should be removed.
1421 * @retval SR_OK Success.
1422 * @retval SR_ERR_ARG Invalid argument.
1423 * @return SR_ERR_BUG Internal error.
1428 SR_PRIV int sr_session_source_remove_channel(struct sr_session *session,
1429 GIOChannel *channel)
1432 sr_err("%s: channel was NULL", __func__);
1435 return sr_session_source_remove_internal(session, channel);
1438 /** Unregister an event source that has been destroyed.
1440 * This is intended to be called from a source's finalize() method.
1442 * @param session The session to use. Must not be NULL.
1443 * @param key The key used to identify @a source.
1444 * @param source The source object that was destroyed.
1446 * @retval SR_OK Success.
1447 * @retval SR_ERR_BUG Event source for @a key does not match @a source.
1448 * @retval SR_ERR Other error.
1452 SR_PRIV int sr_session_source_destroyed(struct sr_session *session,
1453 void *key, GSource *source)
1455 GSource *registered_source;
1457 registered_source = g_hash_table_lookup(session->event_sources, key);
1459 * Trying to remove an already removed event source is problematic
1460 * since the poll_object handle may have been reused in the meantime.
1462 if (!registered_source) {
1463 sr_err("No event source for key %p found.", key);
1466 if (registered_source != source) {
1467 sr_err("Event source for key %p does not match"
1468 " destroyed source.", key);
1471 g_hash_table_remove(session->event_sources, key);
1473 if (g_hash_table_size(session->event_sources) > 0)
1476 /* If no event sources are left, consider the acquisition finished.
1477 * This is pretty crude, as it requires all event sources to be
1478 * registered via the libsigrok API.
1480 return stop_check_later(session);
1483 static void copy_src(struct sr_config *src, struct sr_datafeed_meta *meta_copy)
1485 struct sr_config *item;
1487 #if GLIB_CHECK_VERSION(2, 67, 3)
1488 item = g_memdup2(src, sizeof(*src));
1490 item = g_memdup(src, sizeof(*src));
1493 g_variant_ref(src->data);
1494 meta_copy->config = g_slist_append(meta_copy->config, item);
1497 SR_API int sr_packet_copy(const struct sr_datafeed_packet *packet,
1498 struct sr_datafeed_packet **copy)
1500 const struct sr_datafeed_meta *meta;
1501 struct sr_datafeed_meta *meta_copy;
1502 const struct sr_datafeed_logic *logic;
1503 struct sr_datafeed_logic *logic_copy;
1504 const struct sr_datafeed_analog *analog;
1505 struct sr_datafeed_analog *analog_copy;
1506 struct sr_analog_encoding *encoding_copy;
1507 struct sr_analog_meaning *meaning_copy;
1508 struct sr_analog_spec *spec_copy;
1511 *copy = g_malloc0(sizeof(struct sr_datafeed_packet));
1512 (*copy)->type = packet->type;
1514 switch (packet->type) {
1520 payload = g_malloc(sizeof(struct sr_datafeed_header));
1521 memcpy(payload, packet->payload, sizeof(struct sr_datafeed_header));
1522 (*copy)->payload = payload;
1525 meta = packet->payload;
1526 meta_copy = g_malloc0(sizeof(struct sr_datafeed_meta));
1527 g_slist_foreach(meta->config, (GFunc)copy_src, meta_copy->config);
1528 (*copy)->payload = meta_copy;
1531 logic = packet->payload;
1532 logic_copy = g_malloc(sizeof(*logic_copy));
1535 logic_copy->length = logic->length;
1536 logic_copy->unitsize = logic->unitsize;
1537 logic_copy->data = g_malloc(logic->length * logic->unitsize);
1538 if (!logic_copy->data) {
1542 memcpy(logic_copy->data, logic->data, logic->length * logic->unitsize);
1543 (*copy)->payload = logic_copy;
1546 analog = packet->payload;
1547 analog_copy = g_malloc(sizeof(*analog_copy));
1548 analog_copy->data = g_malloc(
1549 analog->encoding->unitsize * analog->num_samples);
1550 memcpy(analog_copy->data, analog->data,
1551 analog->encoding->unitsize * analog->num_samples);
1552 analog_copy->num_samples = analog->num_samples;
1553 #if GLIB_CHECK_VERSION(2, 67, 3)
1554 encoding_copy = g_memdup2(analog->encoding, sizeof(*analog->encoding));
1555 meaning_copy = g_memdup2(analog->meaning, sizeof(*analog->meaning));
1556 spec_copy = g_memdup2(analog->spec, sizeof(*analog->spec));
1558 encoding_copy = g_memdup(analog->encoding, sizeof(*analog->encoding));
1559 meaning_copy = g_memdup(analog->meaning, sizeof(*analog->meaning));
1560 spec_copy = g_memdup(analog->spec, sizeof(*analog->spec));
1562 analog_copy->encoding = encoding_copy;
1563 analog_copy->meaning = meaning_copy;
1564 analog_copy->meaning->channels = g_slist_copy(
1565 analog->meaning->channels);
1566 analog_copy->spec = spec_copy;
1567 (*copy)->payload = analog_copy;
1570 sr_err("Unknown packet type %d", packet->type);
1577 SR_API void sr_packet_free(struct sr_datafeed_packet *packet)
1579 const struct sr_datafeed_meta *meta;
1580 const struct sr_datafeed_logic *logic;
1581 const struct sr_datafeed_analog *analog;
1582 struct sr_config *src;
1585 switch (packet->type) {
1591 /* Payload is a simple struct. */
1592 g_free((void *)packet->payload);
1595 meta = packet->payload;
1596 for (l = meta->config; l; l = l->next) {
1598 g_variant_unref(src->data);
1601 g_slist_free(meta->config);
1602 g_free((void *)packet->payload);
1605 logic = packet->payload;
1606 g_free(logic->data);
1607 g_free((void *)packet->payload);
1610 analog = packet->payload;
1611 g_free(analog->data);
1612 g_free(analog->encoding);
1613 g_slist_free(analog->meaning->channels);
1614 g_free(analog->meaning);
1615 g_free(analog->spec);
1616 g_free((void *)packet->payload);
1619 sr_err("Unknown packet type %d", packet->type);