libsigrok  0.5.2
sigrok hardware access and backend library
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
session.c
Go to the documentation of this file.
1 /*
2  * This file is part of the libsigrok project.
3  *
4  * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
5  * Copyright (C) 2015 Daniel Elstner <daniel.kitta@gmail.com>
6  *
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.
11  *
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.
16  *
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/>.
19  */
20 
21 #include <config.h>
22 #include <errno.h>
23 #include <stdio.h>
24 #include <stdlib.h>
25 #include <unistd.h>
26 #include <string.h>
27 #include <glib.h>
28 #include <libsigrok/libsigrok.h>
29 #include "libsigrok-internal.h"
30 
31 /** @cond PRIVATE */
32 #define LOG_PREFIX "session"
33 /** @endcond */
34 
35 /**
36  * @file
37  *
38  * Creating, using, or destroying libsigrok sessions.
39  */
40 
41 /**
42  * @defgroup grp_session Session handling
43  *
44  * Creating, using, or destroying libsigrok sessions.
45  *
46  * @{
47  */
48 
49 struct datafeed_callback {
51  void *cb_data;
52 };
53 
54 /** Custom GLib event source for generic descriptor I/O.
55  * @see https://developer.gnome.org/glib/stable/glib-The-Main-Event-Loop.html
56  * @internal
57  */
58 struct fd_source {
59  GSource base;
60 
61  int64_t timeout_us;
62  int64_t due_us;
63 
64  /* Meta-data needed to keep track of installed sources */
65  struct sr_session *session;
66  void *key;
67 
68  GPollFD pollfd;
69 };
70 
71 /** FD event source prepare() method.
72  * This is called immediately before poll().
73  */
74 static gboolean fd_source_prepare(GSource *source, int *timeout)
75 {
76  int64_t now_us;
77  struct fd_source *fsource;
78  int remaining_ms;
79 
80  fsource = (struct fd_source *)source;
81 
82  if (fsource->timeout_us >= 0) {
83  now_us = g_source_get_time(source);
84 
85  if (fsource->due_us == 0) {
86  /* First-time initialization of the expiration time */
87  fsource->due_us = now_us + fsource->timeout_us;
88  }
89  remaining_ms = (MAX(0, fsource->due_us - now_us) + 999) / 1000;
90  } else {
91  remaining_ms = -1;
92  }
93  *timeout = remaining_ms;
94 
95  return (remaining_ms == 0);
96 }
97 
98 /** FD event source check() method.
99  * This is called after poll() returns to check whether an event fired.
100  */
101 static gboolean fd_source_check(GSource *source)
102 {
103  struct fd_source *fsource;
104  unsigned int revents;
105 
106  fsource = (struct fd_source *)source;
107  revents = fsource->pollfd.revents;
108 
109  return (revents != 0 || (fsource->timeout_us >= 0
110  && fsource->due_us <= g_source_get_time(source)));
111 }
112 
113 /** FD event source dispatch() method.
114  * This is called if either prepare() or check() returned TRUE.
115  */
116 static gboolean fd_source_dispatch(GSource *source,
117  GSourceFunc callback, void *user_data)
118 {
119  struct fd_source *fsource;
120  unsigned int revents;
121  gboolean keep;
122 
123  fsource = (struct fd_source *)source;
124  revents = fsource->pollfd.revents;
125 
126  if (!callback) {
127  sr_err("Callback not set, cannot dispatch event.");
128  return G_SOURCE_REMOVE;
129  }
130  keep = (*(sr_receive_data_callback)callback)
131  (fsource->pollfd.fd, revents, user_data);
132 
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;
137  return keep;
138 }
139 
140 /** FD event source finalize() method.
141  */
142 static void fd_source_finalize(GSource *source)
143 {
144  struct fd_source *fsource;
145 
146  fsource = (struct fd_source *)source;
147 
148  sr_dbg("%s: key %p", __func__, fsource->key);
149 
150  sr_session_source_destroyed(fsource->session, fsource->key, source);
151 }
152 
153 /** Create an event source for I/O on a file descriptor.
154  *
155  * In order to maintain API compatibility, this event source also doubles
156  * as a timer event source.
157  *
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.
163  */
164 static GSource *fd_source_new(struct sr_session *session, void *key,
165  gintptr fd, int events, int timeout_ms)
166 {
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
172  };
173  GSource *source;
174  struct fd_source *fsource;
175 
176  source = g_source_new(&fd_source_funcs, sizeof(struct fd_source));
177  fsource = (struct fd_source *)source;
178 
179  g_source_set_name(source, (fd < 0) ? "timer" : "fd");
180 
181  if (timeout_ms >= 0) {
182  fsource->timeout_us = 1000 * (int64_t)timeout_ms;
183  fsource->due_us = 0;
184  } else {
185  fsource->timeout_us = -1;
186  fsource->due_us = INT64_MAX;
187  }
188  fsource->session = session;
189  fsource->key = key;
190 
191  fsource->pollfd.fd = fd;
192  fsource->pollfd.events = events;
193  fsource->pollfd.revents = 0;
194 
195  if (fd >= 0)
196  g_source_add_poll(source, &fsource->pollfd);
197 
198  return source;
199 }
200 
201 /**
202  * Create a new session.
203  *
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.
208  *
209  * @retval SR_OK Success.
210  * @retval SR_ERR_ARG Invalid argument.
211  *
212  * @since 0.4.0
213  */
215  struct sr_session **new_session)
216 {
217  struct sr_session *session;
218 
219  if (!new_session)
220  return SR_ERR_ARG;
221 
222  session = g_malloc0(sizeof(struct sr_session));
223 
224  session->ctx = ctx;
225 
226  g_mutex_init(&session->main_mutex);
227 
228  /* To maintain API compatibility, we need a lookup table
229  * which maps poll_object IDs to GSource* pointers.
230  */
231  session->event_sources = g_hash_table_new(NULL, NULL);
232 
233  *new_session = session;
234 
235  return SR_OK;
236 }
237 
238 /**
239  * Destroy a session.
240  * This frees up all memory used by the session.
241  *
242  * @param session The session to destroy. Must not be NULL.
243  *
244  * @retval SR_OK Success.
245  * @retval SR_ERR_ARG Invalid session passed.
246  *
247  * @since 0.4.0
248  */
250 {
251  if (!session) {
252  sr_err("%s: session was NULL", __func__);
253  return SR_ERR_ARG;
254  }
255 
256  sr_session_dev_remove_all(session);
257  g_slist_free_full(session->owned_devs, (GDestroyNotify)sr_dev_inst_free);
258 
260 
261  g_hash_table_unref(session->event_sources);
262 
263  g_mutex_clear(&session->main_mutex);
264 
265  g_free(session);
266 
267  return SR_OK;
268 }
269 
270 /**
271  * Remove all the devices from a session.
272  *
273  * The session itself (i.e., the struct sr_session) is not free'd and still
274  * exists after this function returns.
275  *
276  * @param session The session to use. Must not be NULL.
277  *
278  * @retval SR_OK Success.
279  * @retval SR_ERR_BUG Invalid session passed.
280  *
281  * @since 0.4.0
282  */
284 {
285  struct sr_dev_inst *sdi;
286  GSList *l;
287 
288  if (!session) {
289  sr_err("%s: session was NULL", __func__);
290  return SR_ERR_ARG;
291  }
292 
293  for (l = session->devs; l; l = l->next) {
294  sdi = (struct sr_dev_inst *) l->data;
295  sdi->session = NULL;
296  }
297 
298  g_slist_free(session->devs);
299  session->devs = NULL;
300 
301  return SR_OK;
302 }
303 
304 /**
305  * Add a device instance to a session.
306  *
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
310  * not be NULL.
311  *
312  * @retval SR_OK Success.
313  * @retval SR_ERR_ARG Invalid argument.
314  *
315  * @since 0.4.0
316  */
318  struct sr_dev_inst *sdi)
319 {
320  int ret;
321 
322  if (!sdi) {
323  sr_err("%s: sdi was NULL", __func__);
324  return SR_ERR_ARG;
325  }
326 
327  if (!session) {
328  sr_err("%s: session was NULL", __func__);
329  return SR_ERR_ARG;
330  }
331 
332  /* If sdi->session is not NULL, the device is already in this or
333  * another session. */
334  if (sdi->session) {
335  sr_err("%s: already assigned to session", __func__);
336  return SR_ERR_ARG;
337  }
338 
339  /* If sdi->driver is NULL, this is a virtual device. */
340  if (!sdi->driver) {
341  /* Just add the device, don't run dev_open(). */
342  session->devs = g_slist_append(session->devs, sdi);
343  sdi->session = session;
344  return SR_OK;
345  }
346 
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__);
350  return SR_ERR_BUG;
351  }
352 
353  session->devs = g_slist_append(session->devs, sdi);
354  sdi->session = session;
355 
356  /* TODO: This is invalid if the session runs in a different thread.
357  * The usage semantics and restrictions need to be documented.
358  */
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)",
365  sr_strerror(ret));
366  return ret;
367  }
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));
371  return ret;
372  }
373  }
374 
375  return SR_OK;
376 }
377 
378 /**
379  * List all device instances attached to a session.
380  *
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.
388  *
389  * @retval SR_OK Success.
390  * @retval SR_ERR_ARG Invalid argument.
391  *
392  * @since 0.4.0
393  */
394 SR_API int sr_session_dev_list(struct sr_session *session, GSList **devlist)
395 {
396  if (!session)
397  return SR_ERR_ARG;
398 
399  if (!devlist)
400  return SR_ERR_ARG;
401 
402  *devlist = g_slist_copy(session->devs);
403 
404  return SR_OK;
405 }
406 
407 /**
408  * Remove a device instance from a session.
409  *
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
413  * not be NULL.
414  *
415  * @retval SR_OK Success.
416  * @retval SR_ERR_ARG Invalid argument.
417  *
418  * @since 0.4.0
419  */
421  struct sr_dev_inst *sdi)
422 {
423  if (!sdi) {
424  sr_err("%s: sdi was NULL", __func__);
425  return SR_ERR_ARG;
426  }
427 
428  if (!session) {
429  sr_err("%s: session was NULL", __func__);
430  return SR_ERR_ARG;
431  }
432 
433  /* If sdi->session is not session, the device is not in this
434  * session. */
435  if (sdi->session != session) {
436  sr_err("%s: not assigned to this session", __func__);
437  return SR_ERR_ARG;
438  }
439 
440  session->devs = g_slist_remove(session->devs, sdi);
441  sdi->session = NULL;
442 
443  return SR_OK;
444 }
445 
446 /**
447  * Remove all datafeed callbacks in a session.
448  *
449  * @param session The session to use. Must not be NULL.
450  *
451  * @retval SR_OK Success.
452  * @retval SR_ERR_ARG Invalid session passed.
453  *
454  * @since 0.4.0
455  */
457 {
458  if (!session) {
459  sr_err("%s: session was NULL", __func__);
460  return SR_ERR_ARG;
461  }
462 
463  g_slist_free_full(session->datafeed_callbacks, g_free);
464  session->datafeed_callbacks = NULL;
465 
466  return SR_OK;
467 }
468 
469 /**
470  * Add a datafeed callback to a session.
471  *
472  * @param session The session to use. Must not be NULL.
473  * @param cb Function to call when a chunk of data is received.
474  * Must not be NULL.
475  * @param cb_data Opaque pointer passed in by the caller.
476  *
477  * @retval SR_OK Success.
478  * @retval SR_ERR_BUG No session exists.
479  *
480  * @since 0.3.0
481  */
483  sr_datafeed_callback cb, void *cb_data)
484 {
485  struct datafeed_callback *cb_struct;
486 
487  if (!session) {
488  sr_err("%s: session was NULL", __func__);
489  return SR_ERR_BUG;
490  }
491 
492  if (!cb) {
493  sr_err("%s: cb was NULL", __func__);
494  return SR_ERR_ARG;
495  }
496 
497  cb_struct = g_malloc0(sizeof(struct datafeed_callback));
498  cb_struct->cb = cb;
499  cb_struct->cb_data = cb_data;
500 
501  session->datafeed_callbacks =
502  g_slist_append(session->datafeed_callbacks, cb_struct);
503 
504  return SR_OK;
505 }
506 
507 /**
508  * Get the trigger assigned to this session.
509  *
510  * @param session The session to use.
511  *
512  * @retval NULL Invalid (NULL) session was passed to the function.
513  * @retval other The trigger assigned to this session (can be NULL).
514  *
515  * @since 0.4.0
516  */
518 {
519  if (!session)
520  return NULL;
521 
522  return session->trigger;
523 }
524 
525 /**
526  * Set the trigger of this session.
527  *
528  * @param session The session to use. Must not be NULL.
529  * @param trig The trigger to assign to this session. Can be NULL.
530  *
531  * @retval SR_OK Success.
532  * @retval SR_ERR_ARG Invalid argument.
533  *
534  * @since 0.4.0
535  */
536 SR_API int sr_session_trigger_set(struct sr_session *session, struct sr_trigger *trig)
537 {
538  if (!session)
539  return SR_ERR_ARG;
540 
541  session->trigger = trig;
542 
543  return SR_OK;
544 }
545 
546 static int verify_trigger(struct sr_trigger *trigger)
547 {
548  struct sr_trigger_stage *stage;
549  struct sr_trigger_match *match;
550  GSList *l, *m;
551 
552  if (!trigger->stages) {
553  sr_err("No trigger stages defined.");
554  return SR_ERR;
555  }
556 
557  sr_spew("Checking trigger:");
558  for (l = trigger->stages; l; l = l->next) {
559  stage = l->data;
560  if (!stage->matches) {
561  sr_err("Stage %d has no matches defined.", stage->stage);
562  return SR_ERR;
563  }
564  for (m = stage->matches; m; m = m->next) {
565  match = m->data;
566  if (!match->channel) {
567  sr_err("Stage %d match has no channel.", stage->stage);
568  return SR_ERR;
569  }
570  if (!match->match) {
571  sr_err("Stage %d match is not defined.", stage->stage);
572  return SR_ERR;
573  }
574  sr_spew("Stage %d match on channel %s, match %d", stage->stage,
575  match->channel->name, match->match);
576  }
577  }
578 
579  return SR_OK;
580 }
581 
582 /** Set up the main context the session will be executing in.
583  *
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.
587  */
588 static int set_main_context(struct sr_session *session)
589 {
590  GMainContext *main_context;
591 
592  g_mutex_lock(&session->main_mutex);
593 
594  /* May happen if sr_session_start() is called a second time
595  * while the session is still running.
596  */
597  if (session->main_context) {
598  sr_err("Main context already set.");
599 
600  g_mutex_unlock(&session->main_mutex);
601  return SR_ERR;
602  }
603  main_context = g_main_context_ref_thread_default();
604  /*
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.
609  */
610  if (g_main_context_acquire(main_context)) {
611  g_main_context_release(main_context);
612 
613  sr_dbg("Using thread-default main context.");
614  } else {
615  g_main_context_unref(main_context);
616 
617  sr_dbg("Creating our own main context.");
618  main_context = g_main_context_new();
619  }
620  session->main_context = main_context;
621 
622  g_mutex_unlock(&session->main_mutex);
623 
624  return SR_OK;
625 }
626 
627 /** Unset the main context used for the current session run.
628  *
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.
634  */
635 static int unset_main_context(struct sr_session *session)
636 {
637  int ret;
638 
639  g_mutex_lock(&session->main_mutex);
640 
641  if (session->main_context) {
642  g_main_context_unref(session->main_context);
643  session->main_context = NULL;
644  ret = SR_OK;
645  } else {
646  /* May happen if the set/unset calls are not matched.
647  */
648  sr_err("No main context to unset.");
649  ret = SR_ERR;
650  }
651  g_mutex_unlock(&session->main_mutex);
652 
653  return ret;
654 }
655 
656 static unsigned int session_source_attach(struct sr_session *session,
657  GSource *source)
658 {
659  unsigned int id = 0;
660 
661  g_mutex_lock(&session->main_mutex);
662 
663  if (session->main_context)
664  id = g_source_attach(source, session->main_context);
665  else
666  sr_err("Cannot add event source without main context.");
667 
668  g_mutex_unlock(&session->main_mutex);
669 
670  return id;
671 }
672 
673 /* Idle handler; invoked when the number of registered event sources
674  * for a running session drops to zero.
675  */
676 static gboolean delayed_stop_check(void *data)
677 {
678  struct sr_session *session;
679 
680  session = data;
681  session->stop_check_id = 0;
682 
683  /* Session already ended? */
684  if (!session->running)
685  return G_SOURCE_REMOVE;
686 
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;
690 
691  session->running = FALSE;
692  unset_main_context(session);
693 
694  sr_info("Stopped.");
695 
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.
698  */
699  if (!session->main_loop && !session->stopped_callback) {
700  sr_err("BUG: Session stop left unhandled.");
701  return G_SOURCE_REMOVE;
702  }
703  if (session->main_loop)
704  g_main_loop_quit(session->main_loop);
705 
706  if (session->stopped_callback)
707  (*session->stopped_callback)(session->stopped_cb_data);
708 
709  return G_SOURCE_REMOVE;
710 }
711 
712 static int stop_check_later(struct sr_session *session)
713 {
714  GSource *source;
715  unsigned int source_id;
716 
717  if (session->stop_check_id != 0)
718  return SR_OK; /* idle handler already installed */
719 
720  source = g_idle_source_new();
721  g_source_set_callback(source, &delayed_stop_check, session, NULL);
722 
723  source_id = session_source_attach(session, source);
724  session->stop_check_id = source_id;
725 
726  g_source_unref(source);
727 
728  return (source_id != 0) ? SR_OK : SR_ERR;
729 }
730 
731 /**
732  * Start a session.
733  *
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
737  * the session stops.
738  *
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.
743  *
744  * @param session The session to use. Must not be NULL.
745  *
746  * @retval SR_OK Success.
747  * @retval SR_ERR_ARG Invalid session passed.
748  * @retval SR_ERR Other error.
749  *
750  * @since 0.4.0
751  */
752 SR_API int sr_session_start(struct sr_session *session)
753 {
754  struct sr_dev_inst *sdi;
755  struct sr_channel *ch;
756  GSList *l, *c, *lend;
757  int ret;
758 
759  if (!session) {
760  sr_err("%s: session was NULL", __func__);
761  return SR_ERR_ARG;
762  }
763 
764  if (!session->devs) {
765  sr_err("%s: session->devs was NULL; a session "
766  "cannot be started without devices.", __func__);
767  return SR_ERR_ARG;
768  }
769 
770  if (session->running) {
771  sr_err("Cannot (re-)start session while it is still running.");
772  return SR_ERR;
773  }
774 
775  if (session->trigger) {
776  ret = verify_trigger(session->trigger);
777  if (ret != SR_OK)
778  return ret;
779  }
780 
781  /* Check enabled channels and commit settings of all devices. */
782  for (l = session->devs; l; l = l->next) {
783  sdi = l->data;
784  for (c = sdi->channels; c; c = c->next) {
785  ch = c->data;
786  if (ch->enabled)
787  break;
788  }
789  if (!c) {
790  sr_err("%s device %s has no enabled channels.",
791  sdi->driver->name, sdi->connection_id);
792  return SR_ERR;
793  }
794 
795  ret = sr_config_commit(sdi);
796  if (ret != SR_OK) {
797  sr_err("Failed to commit %s device %s settings "
798  "before starting acquisition.",
799  sdi->driver->name, sdi->connection_id);
800  return ret;
801  }
802  }
803 
804  ret = set_main_context(session);
805  if (ret != SR_OK)
806  return ret;
807 
808  sr_info("Starting.");
809 
810  session->running = TRUE;
811 
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.");
816  ret = SR_ERR;
817  break;
818  }
819  ret = sr_dev_acquisition_start(sdi);
820  if (ret != SR_OK) {
821  sr_err("Could not start %s device %s acquisition.",
822  sdi->driver->name, sdi->connection_id);
823  break;
824  }
825  }
826 
827  if (ret != SR_OK) {
828  /* If there are multiple devices, some of them may already have
829  * started successfully. Stop them now before returning. */
830  lend = l->next;
831  for (l = session->devs; l != lend; l = l->next) {
832  sdi = l->data;
833  sr_dev_acquisition_stop(sdi);
834  }
835  /* TODO: Handle delayed stops. Need to iterate the event
836  * sources... */
837  session->running = FALSE;
838 
839  unset_main_context(session);
840  return ret;
841  }
842 
843  if (g_hash_table_size(session->event_sources) == 0)
844  stop_check_later(session);
845 
846  return SR_OK;
847 }
848 
849 /**
850  * Block until the running session stops.
851  *
852  * This is a convenience function which creates a GLib main loop and runs
853  * it to process session events until the session stops.
854  *
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.
858  *
859  * @param session The session to use. Must not be NULL.
860  *
861  * @retval SR_OK Success.
862  * @retval SR_ERR_ARG Invalid session passed.
863  * @retval SR_ERR Other error.
864  *
865  * @since 0.4.0
866  */
867 SR_API int sr_session_run(struct sr_session *session)
868 {
869  if (!session) {
870  sr_err("%s: session was NULL", __func__);
871  return SR_ERR_ARG;
872  }
873  if (!session->running) {
874  sr_err("No session running.");
875  return SR_ERR;
876  }
877  if (session->main_loop) {
878  sr_err("Main loop already created.");
879  return SR_ERR;
880  }
881 
882  g_mutex_lock(&session->main_mutex);
883 
884  if (!session->main_context) {
885  sr_err("Cannot run without main context.");
886  g_mutex_unlock(&session->main_mutex);
887  return SR_ERR;
888  }
889  session->main_loop = g_main_loop_new(session->main_context, FALSE);
890 
891  g_mutex_unlock(&session->main_mutex);
892 
893  g_main_loop_run(session->main_loop);
894 
895  g_main_loop_unref(session->main_loop);
896  session->main_loop = NULL;
897 
898  return SR_OK;
899 }
900 
901 static gboolean session_stop_sync(void *user_data)
902 {
903  struct sr_session *session;
904  struct sr_dev_inst *sdi;
905  GSList *node;
906 
907  session = user_data;
908 
909  if (!session->running)
910  return G_SOURCE_REMOVE;
911 
912  sr_info("Stopping.");
913 
914  for (node = session->devs; node; node = node->next) {
915  sdi = node->data;
916  sr_dev_acquisition_stop(sdi);
917  }
918 
919  return G_SOURCE_REMOVE;
920 }
921 
922 /**
923  * Stop a session.
924  *
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.
928  *
929  * Use sr_session_stopped_callback_set() to receive notification when the event
930  * processing finished.
931  *
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.
935  *
936  * If the session is not running, sr_session_stop() silently does nothing.
937  *
938  * @param session The session to use. Must not be NULL.
939  *
940  * @retval SR_OK Success.
941  * @retval SR_ERR_ARG Invalid session passed.
942  *
943  * @since 0.4.0
944  */
945 SR_API int sr_session_stop(struct sr_session *session)
946 {
947  GMainContext *main_context;
948 
949  if (!session) {
950  sr_err("%s: session was NULL", __func__);
951  return SR_ERR_ARG;
952  }
953 
954  g_mutex_lock(&session->main_mutex);
955 
956  main_context = (session->main_context)
957  ? g_main_context_ref(session->main_context)
958  : NULL;
959 
960  g_mutex_unlock(&session->main_mutex);
961 
962  if (!main_context) {
963  sr_dbg("No main context set; already stopped?");
964  /* Not an error; as it would be racy. */
965  return SR_OK;
966  }
967  g_main_context_invoke(main_context, &session_stop_sync, session);
968  g_main_context_unref(main_context);
969 
970  return SR_OK;
971 }
972 
973 /**
974  * Return whether the session is currently running.
975  *
976  * Note that this function should be called from the same thread
977  * the session was started in.
978  *
979  * @param session The session to use. Must not be NULL.
980  *
981  * @retval TRUE Session is running.
982  * @retval FALSE Session is not running.
983  * @retval SR_ERR_ARG Invalid session passed.
984  *
985  * @since 0.4.0
986  */
988 {
989  if (!session) {
990  sr_err("%s: session was NULL", __func__);
991  return SR_ERR_ARG;
992  }
993  return session->running;
994 }
995 
996 /**
997  * Set the callback to be invoked after a session stopped running.
998  *
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().
1002  *
1003  * Note that the callback will be invoked in the context of the thread
1004  * that calls sr_session_start().
1005  *
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.
1009  *
1010  * @retval SR_OK Success.
1011  * @retval SR_ERR_ARG Invalid session passed.
1012  *
1013  * @since 0.4.0
1014  */
1016  sr_session_stopped_callback cb, void *cb_data)
1017 {
1018  if (!session) {
1019  sr_err("%s: session was NULL", __func__);
1020  return SR_ERR_ARG;
1021  }
1022  session->stopped_callback = cb;
1023  session->stopped_cb_data = cb_data;
1024 
1025  return SR_OK;
1026 }
1027 
1028 /**
1029  * Debug helper.
1030  *
1031  * @param packet The packet to show debugging information for.
1032  */
1033 static void datafeed_dump(const struct sr_datafeed_packet *packet)
1034 {
1035  const struct sr_datafeed_logic *logic;
1036  const struct sr_datafeed_analog *analog;
1037 
1038  /* Please use the same order as in libsigrok.h. */
1039  switch (packet->type) {
1040  case SR_DF_HEADER:
1041  sr_dbg("bus: Received SR_DF_HEADER packet.");
1042  break;
1043  case SR_DF_END:
1044  sr_dbg("bus: Received SR_DF_END packet.");
1045  break;
1046  case SR_DF_META:
1047  sr_dbg("bus: Received SR_DF_META packet.");
1048  break;
1049  case SR_DF_TRIGGER:
1050  sr_dbg("bus: Received SR_DF_TRIGGER packet.");
1051  break;
1052  case SR_DF_LOGIC:
1053  logic = packet->payload;
1054  sr_dbg("bus: Received SR_DF_LOGIC packet (%" PRIu64 " bytes, "
1055  "unitsize = %d).", logic->length, logic->unitsize);
1056  break;
1057  case SR_DF_FRAME_BEGIN:
1058  sr_dbg("bus: Received SR_DF_FRAME_BEGIN packet.");
1059  break;
1060  case SR_DF_FRAME_END:
1061  sr_dbg("bus: Received SR_DF_FRAME_END packet.");
1062  break;
1063  case SR_DF_ANALOG:
1064  analog = packet->payload;
1065  sr_dbg("bus: Received SR_DF_ANALOG packet (%d samples).",
1066  analog->num_samples);
1067  break;
1068  default:
1069  sr_dbg("bus: Received unknown packet type: %d.", packet->type);
1070  break;
1071  }
1072 }
1073 
1074 /**
1075  * Helper to send a meta datafeed package (SR_DF_META) to the session bus.
1076  *
1077  * @param sdi The device instance to send the package from. Must not be NULL.
1078  * @param key The config key to send to the session bus.
1079  * @param var The value to send to the session bus.
1080  *
1081  * @retval SR_OK Success.
1082  * @retval SR_ERR_ARG Invalid argument.
1083  *
1084  * @private
1085  */
1086 SR_PRIV int sr_session_send_meta(const struct sr_dev_inst *sdi,
1087  uint32_t key, GVariant *var)
1088 {
1089  struct sr_config *cfg;
1090  struct sr_datafeed_packet packet;
1091  struct sr_datafeed_meta meta;
1092  int ret;
1093 
1094  cfg = sr_config_new(key, var);
1095 
1096  memset(&meta, 0, sizeof(meta));
1097 
1098  packet.type = SR_DF_META;
1099  packet.payload = &meta;
1100 
1101  meta.config = g_slist_append(NULL, cfg);
1102 
1103  ret = sr_session_send(sdi, &packet);
1104  g_slist_free(meta.config);
1105  sr_config_free(cfg);
1106 
1107  return ret;
1108 }
1109 
1110 /**
1111  * Send a packet to whatever is listening on the datafeed bus.
1112  *
1113  * Hardware drivers use this to send a data packet to the frontend.
1114  *
1115  * @param sdi TODO.
1116  * @param packet The datafeed packet to send to the session bus.
1117  *
1118  * @retval SR_OK Success.
1119  * @retval SR_ERR_ARG Invalid argument.
1120  *
1121  * @private
1122  */
1123 SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
1124  const struct sr_datafeed_packet *packet)
1125 {
1126  GSList *l;
1127  struct datafeed_callback *cb_struct;
1128  struct sr_datafeed_packet *packet_in, *packet_out;
1129  struct sr_transform *t;
1130  int ret;
1131 
1132  if (!sdi) {
1133  sr_err("%s: sdi was NULL", __func__);
1134  return SR_ERR_ARG;
1135  }
1136 
1137  if (!packet) {
1138  sr_err("%s: packet was NULL", __func__);
1139  return SR_ERR_ARG;
1140  }
1141 
1142  if (!sdi->session) {
1143  sr_err("%s: session was NULL", __func__);
1144  return SR_ERR_BUG;
1145  }
1146 
1147  /*
1148  * Pass the packet to the first transform module. If that returns
1149  * another packet (instead of NULL), pass that packet to the next
1150  * transform module in the list, and so on.
1151  */
1152  packet_in = (struct sr_datafeed_packet *)packet;
1153  for (l = sdi->session->transforms; l; l = l->next) {
1154  t = l->data;
1155  sr_spew("Running transform module '%s'.", t->module->id);
1156  ret = t->module->receive(t, packet_in, &packet_out);
1157  if (ret < 0) {
1158  sr_err("Error while running transform module: %d.", ret);
1159  return SR_ERR;
1160  }
1161  if (!packet_out) {
1162  /*
1163  * If any of the transforms don't return an output
1164  * packet, abort.
1165  */
1166  sr_spew("Transform module didn't return a packet, aborting.");
1167  return SR_OK;
1168  } else {
1169  /*
1170  * Use this transform module's output packet as input
1171  * for the next transform module.
1172  */
1173  packet_in = packet_out;
1174  }
1175  }
1176  packet = packet_in;
1177 
1178  /*
1179  * If the last transform did output a packet, pass it to all datafeed
1180  * callbacks.
1181  */
1182  for (l = sdi->session->datafeed_callbacks; l; l = l->next) {
1184  datafeed_dump(packet);
1185  cb_struct = l->data;
1186  cb_struct->cb(sdi, packet, cb_struct->cb_data);
1187  }
1188 
1189  return SR_OK;
1190 }
1191 
1192 /**
1193  * Add an event source for a file descriptor.
1194  *
1195  * @param session The session to use. Must not be NULL.
1196  * @param key The key which identifies the event source.
1197  * @param source An event source object. Must not be NULL.
1198  *
1199  * @retval SR_OK Success.
1200  * @retval SR_ERR_ARG Invalid argument.
1201  * @retval SR_ERR_BUG Event source with @a key already installed.
1202  * @retval SR_ERR Other error.
1203  *
1204  * @private
1205  */
1206 SR_PRIV int sr_session_source_add_internal(struct sr_session *session,
1207  void *key, GSource *source)
1208 {
1209  /*
1210  * This must not ever happen, since the source has already been
1211  * created and its finalize() method will remove the key for the
1212  * already installed source. (Well it would, if we did not have
1213  * another sanity check there.)
1214  */
1215  if (g_hash_table_contains(session->event_sources, key)) {
1216  sr_err("Event source with key %p already exists.", key);
1217  return SR_ERR_BUG;
1218  }
1219  g_hash_table_insert(session->event_sources, key, source);
1220 
1221  if (session_source_attach(session, source) == 0)
1222  return SR_ERR;
1223 
1224  return SR_OK;
1225 }
1226 
1227 /** @private */
1228 SR_PRIV int sr_session_fd_source_add(struct sr_session *session,
1229  void *key, gintptr fd, int events, int timeout,
1230  sr_receive_data_callback cb, void *cb_data)
1231 {
1232  GSource *source;
1233  int ret;
1234 
1235  source = fd_source_new(session, key, fd, events, timeout);
1236  if (!source)
1237  return SR_ERR;
1238 
1239  g_source_set_callback(source, (GSourceFunc)cb, cb_data, NULL);
1240 
1241  ret = sr_session_source_add_internal(session, key, source);
1242  g_source_unref(source);
1243 
1244  return ret;
1245 }
1246 
1247 /**
1248  * Add an event source for a file descriptor.
1249  *
1250  * @param session The session to use. Must not be NULL.
1251  * @param fd The file descriptor, or a negative value to create a timer source.
1252  * @param events Events to check for.
1253  * @param timeout Max time in ms to wait before the callback is called,
1254  * or -1 to wait indefinitely.
1255  * @param cb Callback function to add. Must not be NULL.
1256  * @param cb_data Data for the callback function. Can be NULL.
1257  *
1258  * @retval SR_OK Success.
1259  * @retval SR_ERR_ARG Invalid argument.
1260  *
1261  * @since 0.3.0
1262  * @private
1263  */
1264 SR_PRIV int sr_session_source_add(struct sr_session *session, int fd,
1265  int events, int timeout, sr_receive_data_callback cb, void *cb_data)
1266 {
1267  if (fd < 0 && timeout < 0) {
1268  sr_err("Cannot create timer source without timeout.");
1269  return SR_ERR_ARG;
1270  }
1271  return sr_session_fd_source_add(session, GINT_TO_POINTER(fd),
1272  fd, events, timeout, cb, cb_data);
1273 }
1274 
1275 /**
1276  * Add an event source for a GPollFD.
1277  *
1278  * @param session The session to use. Must not be NULL.
1279  * @param pollfd The GPollFD. Must not be NULL.
1280  * @param timeout Max time in ms to wait before the callback is called,
1281  * or -1 to wait indefinitely.
1282  * @param cb Callback function to add. Must not be NULL.
1283  * @param cb_data Data for the callback function. Can be NULL.
1284  *
1285  * @retval SR_OK Success.
1286  * @retval SR_ERR_ARG Invalid argument.
1287  *
1288  * @since 0.3.0
1289  * @private
1290  */
1291 SR_PRIV int sr_session_source_add_pollfd(struct sr_session *session,
1292  GPollFD *pollfd, int timeout, sr_receive_data_callback cb,
1293  void *cb_data)
1294 {
1295  if (!pollfd) {
1296  sr_err("%s: pollfd was NULL", __func__);
1297  return SR_ERR_ARG;
1298  }
1299  return sr_session_fd_source_add(session, pollfd, pollfd->fd,
1300  pollfd->events, timeout, cb, cb_data);
1301 }
1302 
1303 /**
1304  * Add an event source for a GIOChannel.
1305  *
1306  * @param session The session to use. Must not be NULL.
1307  * @param channel The GIOChannel.
1308  * @param events Events to poll on.
1309  * @param timeout Max time in ms to wait before the callback is called,
1310  * or -1 to wait indefinitely.
1311  * @param cb Callback function to add. Must not be NULL.
1312  * @param cb_data Data for the callback function. Can be NULL.
1313  *
1314  * @retval SR_OK Success.
1315  * @retval SR_ERR_ARG Invalid argument.
1316  *
1317  * @since 0.3.0
1318  * @private
1319  */
1320 SR_PRIV int sr_session_source_add_channel(struct sr_session *session,
1321  GIOChannel *channel, int events, int timeout,
1322  sr_receive_data_callback cb, void *cb_data)
1323 {
1324  GPollFD pollfd;
1325 
1326  if (!channel) {
1327  sr_err("%s: channel was NULL", __func__);
1328  return SR_ERR_ARG;
1329  }
1330  /* We should be using g_io_create_watch(), but can't without
1331  * changing the driver API, as the callback signature is different.
1332  */
1333 #ifdef _WIN32
1334  g_io_channel_win32_make_pollfd(channel, events, &pollfd);
1335 #else
1336  pollfd.fd = g_io_channel_unix_get_fd(channel);
1337  pollfd.events = events;
1338 #endif
1339  return sr_session_fd_source_add(session, channel, pollfd.fd,
1340  pollfd.events, timeout, cb, cb_data);
1341 }
1342 
1343 /**
1344  * Remove the source identified by the specified poll object.
1345  *
1346  * @param session The session to use. Must not be NULL.
1347  * @param key The key by which the source is identified.
1348  *
1349  * @retval SR_OK Success
1350  * @retval SR_ERR_BUG No event source for poll_object found.
1351  *
1352  * @private
1353  */
1354 SR_PRIV int sr_session_source_remove_internal(struct sr_session *session,
1355  void *key)
1356 {
1357  GSource *source;
1358 
1359  source = g_hash_table_lookup(session->event_sources, key);
1360  /*
1361  * Trying to remove an already removed event source is problematic
1362  * since the poll_object handle may have been reused in the meantime.
1363  */
1364  if (!source) {
1365  sr_warn("Cannot remove non-existing event source %p.", key);
1366  return SR_ERR_BUG;
1367  }
1368  g_source_destroy(source);
1369 
1370  return SR_OK;
1371 }
1372 
1373 /**
1374  * Remove the source belonging to the specified file descriptor.
1375  *
1376  * @param session The session to use. Must not be NULL.
1377  * @param fd The file descriptor for which the source should be removed.
1378  *
1379  * @retval SR_OK Success
1380  * @retval SR_ERR_ARG Invalid argument
1381  * @retval SR_ERR_BUG Internal error.
1382  *
1383  * @since 0.3.0
1384  * @private
1385  */
1386 SR_PRIV int sr_session_source_remove(struct sr_session *session, int fd)
1387 {
1388  return sr_session_source_remove_internal(session, GINT_TO_POINTER(fd));
1389 }
1390 
1391 /**
1392  * Remove the source belonging to the specified poll descriptor.
1393  *
1394  * @param session The session to use. Must not be NULL.
1395  * @param pollfd The poll descriptor for which the source should be removed.
1396  * Must not be NULL.
1397  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
1398  * SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon
1399  * internal errors.
1400  *
1401  * @since 0.2.0
1402  * @private
1403  */
1404 SR_PRIV int sr_session_source_remove_pollfd(struct sr_session *session,
1405  GPollFD *pollfd)
1406 {
1407  if (!pollfd) {
1408  sr_err("%s: pollfd was NULL", __func__);
1409  return SR_ERR_ARG;
1410  }
1411  return sr_session_source_remove_internal(session, pollfd);
1412 }
1413 
1414 /**
1415  * Remove the source belonging to the specified channel.
1416  *
1417  * @param session The session to use. Must not be NULL.
1418  * @param channel The channel for which the source should be removed.
1419  * Must not be NULL.
1420  * @retval SR_OK Success.
1421  * @retval SR_ERR_ARG Invalid argument.
1422  * @return SR_ERR_BUG Internal error.
1423  *
1424  * @since 0.2.0
1425  * @private
1426  */
1427 SR_PRIV int sr_session_source_remove_channel(struct sr_session *session,
1428  GIOChannel *channel)
1429 {
1430  if (!channel) {
1431  sr_err("%s: channel was NULL", __func__);
1432  return SR_ERR_ARG;
1433  }
1434  return sr_session_source_remove_internal(session, channel);
1435 }
1436 
1437 /** Unregister an event source that has been destroyed.
1438  *
1439  * This is intended to be called from a source's finalize() method.
1440  *
1441  * @param session The session to use. Must not be NULL.
1442  * @param key The key used to identify @a source.
1443  * @param source The source object that was destroyed.
1444  *
1445  * @retval SR_OK Success.
1446  * @retval SR_ERR_BUG Event source for @a key does not match @a source.
1447  * @retval SR_ERR Other error.
1448  *
1449  * @private
1450  */
1451 SR_PRIV int sr_session_source_destroyed(struct sr_session *session,
1452  void *key, GSource *source)
1453 {
1454  GSource *registered_source;
1455 
1456  registered_source = g_hash_table_lookup(session->event_sources, key);
1457  /*
1458  * Trying to remove an already removed event source is problematic
1459  * since the poll_object handle may have been reused in the meantime.
1460  */
1461  if (!registered_source) {
1462  sr_err("No event source for key %p found.", key);
1463  return SR_ERR_BUG;
1464  }
1465  if (registered_source != source) {
1466  sr_err("Event source for key %p does not match"
1467  " destroyed source.", key);
1468  return SR_ERR_BUG;
1469  }
1470  g_hash_table_remove(session->event_sources, key);
1471 
1472  if (g_hash_table_size(session->event_sources) > 0)
1473  return SR_OK;
1474 
1475  /* If no event sources are left, consider the acquisition finished.
1476  * This is pretty crude, as it requires all event sources to be
1477  * registered via the libsigrok API.
1478  */
1479  return stop_check_later(session);
1480 }
1481 
1482 static void copy_src(struct sr_config *src, struct sr_datafeed_meta *meta_copy)
1483 {
1484  g_variant_ref(src->data);
1485  meta_copy->config = g_slist_append(meta_copy->config,
1486  g_memdup(src, sizeof(struct sr_config)));
1487 }
1488 
1489 SR_API int sr_packet_copy(const struct sr_datafeed_packet *packet,
1490  struct sr_datafeed_packet **copy)
1491 {
1492  const struct sr_datafeed_meta *meta;
1493  struct sr_datafeed_meta *meta_copy;
1494  const struct sr_datafeed_logic *logic;
1495  struct sr_datafeed_logic *logic_copy;
1496  const struct sr_datafeed_analog *analog;
1497  struct sr_datafeed_analog *analog_copy;
1498  uint8_t *payload;
1499 
1500  *copy = g_malloc0(sizeof(struct sr_datafeed_packet));
1501  (*copy)->type = packet->type;
1502 
1503  switch (packet->type) {
1504  case SR_DF_TRIGGER:
1505  case SR_DF_END:
1506  /* No payload. */
1507  break;
1508  case SR_DF_HEADER:
1509  payload = g_malloc(sizeof(struct sr_datafeed_header));
1510  memcpy(payload, packet->payload, sizeof(struct sr_datafeed_header));
1511  (*copy)->payload = payload;
1512  break;
1513  case SR_DF_META:
1514  meta = packet->payload;
1515  meta_copy = g_malloc0(sizeof(struct sr_datafeed_meta));
1516  g_slist_foreach(meta->config, (GFunc)copy_src, meta_copy->config);
1517  (*copy)->payload = meta_copy;
1518  break;
1519  case SR_DF_LOGIC:
1520  logic = packet->payload;
1521  logic_copy = g_malloc(sizeof(*logic_copy));
1522  if (!logic_copy)
1523  return SR_ERR;
1524  logic_copy->length = logic->length;
1525  logic_copy->unitsize = logic->unitsize;
1526  logic_copy->data = g_malloc(logic->length * logic->unitsize);
1527  if (!logic_copy->data) {
1528  g_free(logic_copy);
1529  return SR_ERR;
1530  }
1531  memcpy(logic_copy->data, logic->data, logic->length * logic->unitsize);
1532  (*copy)->payload = logic_copy;
1533  break;
1534  case SR_DF_ANALOG:
1535  analog = packet->payload;
1536  analog_copy = g_malloc(sizeof(*analog_copy));
1537  analog_copy->data = g_malloc(
1538  analog->encoding->unitsize * analog->num_samples);
1539  memcpy(analog_copy->data, analog->data,
1540  analog->encoding->unitsize * analog->num_samples);
1541  analog_copy->num_samples = analog->num_samples;
1542  analog_copy->encoding = g_memdup(analog->encoding,
1543  sizeof(struct sr_analog_encoding));
1544  analog_copy->meaning = g_memdup(analog->meaning,
1545  sizeof(struct sr_analog_meaning));
1546  analog_copy->meaning->channels = g_slist_copy(
1547  analog->meaning->channels);
1548  analog_copy->spec = g_memdup(analog->spec,
1549  sizeof(struct sr_analog_spec));
1550  (*copy)->payload = analog_copy;
1551  break;
1552  default:
1553  sr_err("Unknown packet type %d", packet->type);
1554  return SR_ERR;
1555  }
1556 
1557  return SR_OK;
1558 }
1559 
1561 {
1562  const struct sr_datafeed_meta *meta;
1563  const struct sr_datafeed_logic *logic;
1564  const struct sr_datafeed_analog *analog;
1565  struct sr_config *src;
1566  GSList *l;
1567 
1568  switch (packet->type) {
1569  case SR_DF_TRIGGER:
1570  case SR_DF_END:
1571  /* No payload. */
1572  break;
1573  case SR_DF_HEADER:
1574  /* Payload is a simple struct. */
1575  g_free((void *)packet->payload);
1576  break;
1577  case SR_DF_META:
1578  meta = packet->payload;
1579  for (l = meta->config; l; l = l->next) {
1580  src = l->data;
1581  g_variant_unref(src->data);
1582  g_free(src);
1583  }
1584  g_slist_free(meta->config);
1585  g_free((void *)packet->payload);
1586  break;
1587  case SR_DF_LOGIC:
1588  logic = packet->payload;
1589  g_free(logic->data);
1590  g_free((void *)packet->payload);
1591  break;
1592  case SR_DF_ANALOG:
1593  analog = packet->payload;
1594  g_free(analog->data);
1595  g_free(analog->encoding);
1596  g_slist_free(analog->meaning->channels);
1597  g_free(analog->meaning);
1598  g_free(analog->spec);
1599  g_free((void *)packet->payload);
1600  break;
1601  default:
1602  sr_err("Unknown packet type %d", packet->type);
1603  }
1604  g_free(packet);
1605 }
1606 
1607 /** @} */
Generic/unspecified error.
Definition: libsigrok.h:68
struct sr_channel * channel
The channel to trigger on.
Definition: libsigrok.h:426
int sr_session_dev_list(struct sr_session *session, GSList **devlist)
List all device instances attached to a session.
Definition: session.c:394
A trigger stage.
Definition: libsigrok.h:416
End of frame.
Definition: libsigrok.h:168
Logic datafeed payload for type SR_DF_LOGIC.
Definition: libsigrok.h:493
uint16_t unitsize
Definition: libsigrok.h:495
GSList * matches
List of pointers to struct sr_trigger_match.
Definition: libsigrok.h:420
int sr_session_datafeed_callback_remove_all(struct sr_session *session)
Remove all datafeed callbacks in a session.
Definition: session.c:456
int stage
Starts at 0.
Definition: libsigrok.h:418
Payload is struct sr_datafeed_meta.
Definition: libsigrok.h:160
int sr_packet_copy(const struct sr_datafeed_packet *packet, struct sr_datafeed_packet **copy)
Definition: session.c:1489
int sr_session_dev_remove_all(struct sr_session *session)
Remove all the devices from a session.
Definition: session.c:283
int sr_session_new(struct sr_context *ctx, struct sr_session **new_session)
Create a new session.
Definition: session.c:214
Payload is struct sr_datafeed_analog.
Definition: libsigrok.h:170
gboolean enabled
Is this channel enabled?
Definition: libsigrok.h:605
Payload is struct sr_datafeed_logic.
Definition: libsigrok.h:164
No error.
Definition: libsigrok.h:67
int sr_session_trigger_set(struct sr_session *session, struct sr_trigger *trig)
Set the trigger of this session.
Definition: session.c:536
int match
The trigger match to use.
Definition: libsigrok.h:442
GSList * channels
Definition: libsigrok.h:528
int sr_session_stop(struct sr_session *session)
Stop a session.
Definition: session.c:945
The public libsigrok header file to be used by frontends.
int sr_session_destroy(struct sr_session *session)
Destroy a session.
Definition: session.c:249
A channel to match and what to match it on.
Definition: libsigrok.h:424
void sr_packet_free(struct sr_datafeed_packet *packet)
Definition: session.c:1560
uint64_t length
Definition: libsigrok.h:494
int sr_session_dev_remove(struct sr_session *session, struct sr_dev_inst *sdi)
Remove a device instance from a session.
Definition: session.c:420
struct sr_analog_encoding * encoding
Definition: libsigrok.h:503
End of stream (no further data).
Definition: libsigrok.h:158
Used for setting or getting value of a config item.
Definition: libsigrok.h:623
int sr_session_is_running(struct sr_session *session)
Return whether the session is currently running.
Definition: session.c:987
int sr_session_datafeed_callback_add(struct sr_session *session, sr_datafeed_callback cb, void *cb_data)
Add a datafeed callback to a session.
Definition: session.c:482
The trigger matched at this point in the data feed.
Definition: libsigrok.h:162
const void * payload
Definition: libsigrok.h:478
Header of a sigrok data feed.
Definition: libsigrok.h:482
Packet in a sigrok data feed.
Definition: libsigrok.h:476
GVariant * data
Key-specific data.
Definition: libsigrok.h:627
int sr_config_commit(const struct sr_dev_inst *sdi)
Apply configuration settings to the device hardware.
Definition: hwdriver.c:879
GSList * stages
List of pointers to struct sr_trigger_stage.
Definition: libsigrok.h:412
struct sr_analog_meaning * meaning
Definition: libsigrok.h:504
int(* sr_receive_data_callback)(int fd, int revents, void *cb_data)
Type definition for callback function for data reception.
Definition: libsigrok.h:134
#define SR_PRIV
Definition: libsigrok.h:128
The representation of a trigger, consisting of one or more stages containing one or more matches on a...
Definition: libsigrok.h:408
char * name
Name of channel.
Definition: libsigrok.h:607
int sr_session_run(struct sr_session *session)
Block until the running session stops.
Definition: session.c:867
void(* sr_session_stopped_callback)(void *data)
Definition: proto.h:125
struct sr_analog_spec * spec
Definition: libsigrok.h:505
Datafeed payload for type SR_DF_META.
Definition: libsigrok.h:488
Payload is sr_datafeed_header.
Definition: libsigrok.h:156
const char * sr_strerror(int error_code)
Return a human-readable error string for the given libsigrok error code.
Definition: error.c:53
Output debug messages.
Definition: libsigrok.h:99
Analog datafeed payload for type SR_DF_ANALOG.
Definition: libsigrok.h:500
Function argument error.
Definition: libsigrok.h:70
GSList * config
Definition: libsigrok.h:489
int sr_log_loglevel_get(void)
Get the libsigrok loglevel.
Definition: log.c:107
int sr_session_dev_add(struct sr_session *session, struct sr_dev_inst *sdi)
Add a device instance to a session.
Definition: session.c:317
int sr_session_stopped_callback_set(struct sr_session *session, sr_session_stopped_callback cb, void *cb_data)
Set the callback to be invoked after a session stopped running.
Definition: session.c:1015
Information on single channel.
Definition: libsigrok.h:596
uint32_t num_samples
Definition: libsigrok.h:502
Beginning of frame.
Definition: libsigrok.h:166
void(* sr_datafeed_callback)(const struct sr_dev_inst *sdi, const struct sr_datafeed_packet *packet, void *cb_data)
Definition: proto.h:126
Errors hinting at internal bugs.
Definition: libsigrok.h:71
struct sr_trigger * sr_session_trigger_get(struct sr_session *session)
Get the trigger assigned to this session.
Definition: session.c:517
int sr_session_start(struct sr_session *session)
Start a session.
Definition: session.c:752
Opaque structure representing a libsigrok session.
Definition: libsigrok.h:456
Opaque structure representing a libsigrok context.
#define SR_API
Definition: libsigrok.h:121