src/session.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
   5  *
   6  * This program is free software: you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation, either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #include <errno.h>
  21 #include <stdio.h>
  22 #include <stdlib.h>
  23 #include <unistd.h>
  24 #include <string.h>
  25 #include <glib.h>
  26 #include <libsigrok/libsigrok.h>
  27 #include "libsigrok-internal.h"
  28
  29 /** @cond PRIVATE */
  30 #define LOG_PREFIX "session"
  31 /** @endcond */
  32
  33 /**
  34  * @file
  35  *
  36  * Creating, using, or destroying libsigrok sessions.
  37  */
  38
  39 /**
  40  * @defgroup grp_session Session handling
  41  *
  42  * Creating, using, or destroying libsigrok sessions.
  43  *
  44  * @{
  45  */
  46
  47 struct source {
  48         int64_t timeout;        /* microseconds */
  49         int64_t due;            /* microseconds */
  50         sr_receive_data_callback cb;
  51         void *cb_data;
  52
  53         /* This is used to keep track of the object (fd, pollfd or channel) which is
  54          * being polled and will be used to match the source when removing it again.
  55          */
  56         gintptr poll_object;
  57
  58         gboolean is_usb;
  59         gboolean triggered;
  60 };
  61
  62 struct datafeed_callback {
  63         sr_datafeed_callback cb;
  64         void *cb_data;
  65 };
  66
  67 /**
  68  * Create a new session.
  69  *
  70  * @param ctx         The context in which to create the new session.
  71  * @param new_session This will contain a pointer to the newly created
  72  *                    session if the return value is SR_OK, otherwise the value
  73  *                    is undefined and should not be used. Must not be NULL.
  74  *
  75  * @retval SR_OK Success.
  76  * @retval SR_ERR_ARG Invalid argument.
  77  *
  78  * @since 0.4.0
  79  */
  80 SR_API int sr_session_new(struct sr_context *ctx,
  81                 struct sr_session **new_session)
  82 {
  83         struct sr_session *session;
  84
  85         if (!new_session)
  86                 return SR_ERR_ARG;
  87
  88         session = g_malloc0(sizeof(struct sr_session));
  89
  90         session->ctx = ctx;
  91
  92         session->sources = g_array_new(FALSE, FALSE, sizeof(struct source));
  93         session->pollfds = g_array_new(FALSE, FALSE, sizeof(GPollFD));
  94
  95         g_mutex_init(&session->stop_mutex);
  96
  97         *new_session = session;
  98
  99         return SR_OK;
 100 }
 101
 102 /**
 103  * Destroy a session.
 104  * This frees up all memory used by the session.
 105  *
 106  * @param session The session to destroy. Must not be NULL.
 107  *
 108  * @retval SR_OK Success.
 109  * @retval SR_ERR_ARG Invalid session passed.
 110  *
 111  * @since 0.4.0
 112  */
 113 SR_API int sr_session_destroy(struct sr_session *session)
 114 {
 115         if (!session) {
 116                 sr_err("%s: session was NULL", __func__);
 117                 return SR_ERR_ARG;
 118         }
 119
 120         sr_session_dev_remove_all(session);
 121         g_mutex_clear(&session->stop_mutex);
 122         if (session->trigger)
 123                 sr_trigger_free(session->trigger);
 124
 125         g_slist_free_full(session->owned_devs, (GDestroyNotify)sr_dev_inst_free);
 126
 127         g_array_unref(session->pollfds);
 128         g_array_unref(session->sources);
 129
 130         g_free(session);
 131
 132         return SR_OK;
 133 }
 134
 135 /**
 136  * Remove all the devices from a session.
 137  *
 138  * The session itself (i.e., the struct sr_session) is not free'd and still
 139  * exists after this function returns.
 140  *
 141  * @param session The session to use. Must not be NULL.
 142  *
 143  * @retval SR_OK Success.
 144  * @retval SR_ERR_BUG Invalid session passed.
 145  *
 146  * @since 0.4.0
 147  */
 148 SR_API int sr_session_dev_remove_all(struct sr_session *session)
 149 {
 150         struct sr_dev_inst *sdi;
 151         GSList *l;
 152
 153         if (!session) {
 154                 sr_err("%s: session was NULL", __func__);
 155                 return SR_ERR_ARG;
 156         }
 157
 158         for (l = session->devs; l; l = l->next) {
 159                 sdi = (struct sr_dev_inst *) l->data;
 160                 sdi->session = NULL;
 161         }
 162
 163         g_slist_free(session->devs);
 164         session->devs = NULL;
 165
 166         return SR_OK;
 167 }
 168
 169 /**
 170  * Add a device instance to a session.
 171  *
 172  * @param session The session to add to. Must not be NULL.
 173  * @param sdi The device instance to add to a session. Must not
 174  *            be NULL. Also, sdi->driver and sdi->driver->dev_open must
 175  *            not be NULL.
 176  *
 177  * @retval SR_OK Success.
 178  * @retval SR_ERR_ARG Invalid argument.
 179  *
 180  * @since 0.4.0
 181  */
 182 SR_API int sr_session_dev_add(struct sr_session *session,
 183                 struct sr_dev_inst *sdi)
 184 {
 185         int ret;
 186
 187         if (!sdi) {
 188                 sr_err("%s: sdi was NULL", __func__);
 189                 return SR_ERR_ARG;
 190         }
 191
 192         if (!session) {
 193                 sr_err("%s: session was NULL", __func__);
 194                 return SR_ERR_ARG;
 195         }
 196
 197         /* If sdi->session is not NULL, the device is already in this or
 198          * another session. */
 199         if (sdi->session) {
 200                 sr_err("%s: already assigned to session", __func__);
 201                 return SR_ERR_ARG;
 202         }
 203
 204         /* If sdi->driver is NULL, this is a virtual device. */
 205         if (!sdi->driver) {
 206                 /* Just add the device, don't run dev_open(). */
 207                 session->devs = g_slist_append(session->devs, (gpointer)sdi);
 208                 sdi->session = session;
 209                 return SR_OK;
 210         }
 211
 212         /* sdi->driver is non-NULL (i.e. we have a real device). */
 213         if (!sdi->driver->dev_open) {
 214                 sr_err("%s: sdi->driver->dev_open was NULL", __func__);
 215                 return SR_ERR_BUG;
 216         }
 217
 218         session->devs = g_slist_append(session->devs, (gpointer)sdi);
 219         sdi->session = session;
 220
 221         if (session->running) {
 222                 /* Adding a device to a running session. Commit settings
 223                  * and start acquisition on that device now. */
 224                 if ((ret = sr_config_commit(sdi)) != SR_OK) {
 225                         sr_err("Failed to commit device settings before "
 226                                "starting acquisition in running session (%s)",
 227                                sr_strerror(ret));
 228                         return ret;
 229                 }
 230                 if ((ret = sdi->driver->dev_acquisition_start(sdi,
 231                                                 (void *)sdi)) != SR_OK) {
 232                         sr_err("Failed to start acquisition of device in "
 233                                "running session (%s)", sr_strerror(ret));
 234                         return ret;
 235                 }
 236         }
 237
 238         return SR_OK;
 239 }
 240
 241 /**
 242  * List all device instances attached to a session.
 243  *
 244  * @param session The session to use. Must not be NULL.
 245  * @param devlist A pointer where the device instance list will be
 246  *                stored on return. If no devices are in the session,
 247  *                this will be NULL. Each element in the list points
 248  *                to a struct sr_dev_inst *.
 249  *                The list must be freed by the caller, but not the
 250  *                elements pointed to.
 251  *
 252  * @retval SR_OK Success.
 253  * @retval SR_ERR_ARG Invalid argument.
 254  *
 255  * @since 0.4.0
 256  */
 257 SR_API int sr_session_dev_list(struct sr_session *session, GSList **devlist)
 258 {
 259         if (!session)
 260                 return SR_ERR_ARG;
 261
 262         if (!devlist)
 263                 return SR_ERR_ARG;
 264
 265         *devlist = g_slist_copy(session->devs);
 266
 267         return SR_OK;
 268 }
 269
 270 /**
 271  * Remove all datafeed callbacks in a session.
 272  *
 273  * @param session The session to use. Must not be NULL.
 274  *
 275  * @retval SR_OK Success.
 276  * @retval SR_ERR_ARG Invalid session passed.
 277  *
 278  * @since 0.4.0
 279  */
 280 SR_API int sr_session_datafeed_callback_remove_all(struct sr_session *session)
 281 {
 282         if (!session) {
 283                 sr_err("%s: session was NULL", __func__);
 284                 return SR_ERR_ARG;
 285         }
 286
 287         g_slist_free_full(session->datafeed_callbacks, g_free);
 288         session->datafeed_callbacks = NULL;
 289
 290         return SR_OK;
 291 }
 292
 293 /**
 294  * Add a datafeed callback to a session.
 295  *
 296  * @param session The session to use. Must not be NULL.
 297  * @param cb Function to call when a chunk of data is received.
 298  *           Must not be NULL.
 299  * @param cb_data Opaque pointer passed in by the caller.
 300  *
 301  * @retval SR_OK Success.
 302  * @retval SR_ERR_BUG No session exists.
 303  *
 304  * @since 0.3.0
 305  */
 306 SR_API int sr_session_datafeed_callback_add(struct sr_session *session,
 307                 sr_datafeed_callback cb, void *cb_data)
 308 {
 309         struct datafeed_callback *cb_struct;
 310
 311         if (!session) {
 312                 sr_err("%s: session was NULL", __func__);
 313                 return SR_ERR_BUG;
 314         }
 315
 316         if (!cb) {
 317                 sr_err("%s: cb was NULL", __func__);
 318                 return SR_ERR_ARG;
 319         }
 320
 321         cb_struct = g_malloc0(sizeof(struct datafeed_callback));
 322         cb_struct->cb = cb;
 323         cb_struct->cb_data = cb_data;
 324
 325         session->datafeed_callbacks =
 326             g_slist_append(session->datafeed_callbacks, cb_struct);
 327
 328         return SR_OK;
 329 }
 330
 331 /**
 332  * Get the trigger assigned to this session.
 333  *
 334  * @param session The session to use.
 335  *
 336  * @retval NULL Invalid (NULL) session was passed to the function.
 337  * @retval other The trigger assigned to this session (can be NULL).
 338  *
 339  * @since 0.4.0
 340  */
 341 SR_API struct sr_trigger *sr_session_trigger_get(struct sr_session *session)
 342 {
 343         if (!session)
 344                 return NULL;
 345
 346         return session->trigger;
 347 }
 348
 349 /**
 350  * Set the trigger of this session.
 351  *
 352  * @param session The session to use. Must not be NULL.
 353  * @param trig The trigger to assign to this session. Can be NULL.
 354  *
 355  * @retval SR_OK Success.
 356  * @retval SR_ERR_ARG Invalid argument.
 357  *
 358  * @since 0.4.0
 359  */
 360 SR_API int sr_session_trigger_set(struct sr_session *session, struct sr_trigger *trig)
 361 {
 362         if (!session)
 363                 return SR_ERR_ARG;
 364
 365         session->trigger = trig;
 366
 367         return SR_OK;
 368 }
 369
 370 static gboolean sr_session_check_aborted(struct sr_session *session)
 371 {
 372         gboolean stop;
 373
 374         g_mutex_lock(&session->stop_mutex);
 375         stop = session->abort_session;
 376         if (stop) {
 377                 sr_session_stop_sync(session);
 378                 /* But once is enough. */
 379                 session->abort_session = FALSE;
 380         }
 381         g_mutex_unlock(&session->stop_mutex);
 382
 383         return stop;
 384 }
 385
 386 static int _sr_session_source_remove(struct sr_session *session, gintptr poll_object);
 387
 388 /**
 389  * Poll the session's event sources.
 390  *
 391  * @param session The session to use. Must not be NULL.
 392  * @retval SR_OK Success.
 393  * @retval SR_ERR Error occurred.
 394  */
 395 static int sr_session_iteration(struct sr_session *session)
 396 {
 397         int64_t start_time, stop_time, min_due, due;
 398         int timeout_ms;
 399         unsigned int i;
 400         int ret;
 401         int fd;
 402         int revents;
 403         gboolean triggered, stopped;
 404         struct source *source;
 405         GPollFD *pollfd;
 406         gintptr poll_object;
 407 #ifdef HAVE_LIBUSB_1_0
 408         int64_t usb_due;
 409         struct timeval tv;
 410 #endif
 411         if (session->sources->len == 0) {
 412                 sr_session_check_aborted(session);
 413                 return SR_OK;
 414         }
 415         start_time = g_get_monotonic_time();
 416         min_due = INT64_MAX;
 417
 418         for (i = 0; i < session->sources->len; ++i) {
 419                 source = &g_array_index(session->sources, struct source, i);
 420                 if (source->due < min_due)
 421                         min_due = source->due;
 422                 source->triggered = FALSE;
 423         }
 424 #ifdef HAVE_LIBUSB_1_0
 425         usb_due = INT64_MAX;
 426         if (session->ctx->usb_source_present) {
 427                 ret = libusb_get_next_timeout(session->ctx->libusb_ctx, &tv);
 428                 if (ret < 0) {
 429                         sr_err("Error getting libusb timeout: %s",
 430                                 libusb_error_name(ret));
 431                         return SR_ERR;
 432                 } else if (ret == 1) {
 433                         usb_due = start_time + tv.tv_usec
 434                                 + (int64_t)tv.tv_sec * G_USEC_PER_SEC;
 435                         if (usb_due < min_due)
 436                                 min_due = usb_due;
 437                 }
 438         }
 439 #endif
 440         if (min_due == INT64_MAX)
 441                 timeout_ms = -1;
 442         else if (min_due > start_time)
 443                 timeout_ms = MIN((min_due - start_time + 999) / 1000, INT_MAX);
 444         else
 445                 timeout_ms = 0;
 446
 447         ret = g_poll((GPollFD *)session->pollfds->data,
 448                         session->pollfds->len, timeout_ms);
 449 #ifdef G_OS_UNIX
 450         if (ret < 0 && errno != EINTR) {
 451                 sr_err("Error in poll: %s", g_strerror(errno));
 452                 return SR_ERR;
 453         }
 454 #else
 455         if (ret < 0) {
 456                 sr_err("Error in poll: %d", ret);
 457                 return SR_ERR;
 458         }
 459 #endif
 460         stop_time = g_get_monotonic_time();
 461         triggered = FALSE;
 462         stopped = FALSE;
 463
 464         for (i = 0; i < session->sources->len; ++i) {
 465                 source = &g_array_index(session->sources, struct source, i);
 466                 if (source->triggered)
 467                         continue; /* already handled */
 468
 469                 poll_object = source->poll_object;
 470                 fd = (int)poll_object;
 471                 revents = 0;
 472
 473                 if (i < session->pollfds->len) {
 474                         pollfd = &g_array_index(session->pollfds, GPollFD, i);
 475                         fd = pollfd->fd;
 476                         if (ret > 0)
 477                                 revents = pollfd->revents;
 478                 }
 479                 if (ret > 0 && revents == 0)
 480                         continue; /* skip timeouts if any I/O event occurred */
 481
 482                 due = source->due;
 483 #ifdef HAVE_LIBUSB_1_0
 484                 if (source->is_usb && usb_due < due)
 485                         due = usb_due;
 486 #endif
 487                 if (revents == 0 && stop_time < due)
 488                         continue;
 489                 /*
 490                  * The source may be gone after the callback returns,
 491                  * so access any data now that needs accessing.
 492                  */
 493                 if (source->timeout >= 0)
 494                         source->due = stop_time + source->timeout;
 495                 source->triggered = TRUE;
 496                 triggered = TRUE;
 497                 /*
 498                  * Invoke the source's callback on an event or timeout.
 499                  */
 500                 if (!source->cb(fd, revents, source->cb_data))
 501                         _sr_session_source_remove(session, poll_object);
 502                 /*
 503                  * We want to take as little time as possible to stop
 504                  * the session if we have been told to do so. Therefore,
 505                  * we check the flag after processing every source, not
 506                  * just once per main event loop.
 507                  */
 508                 if (!stopped)
 509                         stopped = sr_session_check_aborted(session);
 510
 511                 /* Restart loop as the sources list may have changed. */
 512                 i = 0;
 513         }
 514
 515         /* Check for abort at least once per iteration. */
 516         if (!triggered)
 517                 sr_session_check_aborted(session);
 518
 519         return SR_OK;
 520 }
 521
 522 static int verify_trigger(struct sr_trigger *trigger)
 523 {
 524         struct sr_trigger_stage *stage;
 525         struct sr_trigger_match *match;
 526         GSList *l, *m;
 527
 528         if (!trigger->stages) {
 529                 sr_err("No trigger stages defined.");
 530                 return SR_ERR;
 531         }
 532
 533         sr_spew("Checking trigger:");
 534         for (l = trigger->stages; l; l = l->next) {
 535                 stage = l->data;
 536                 if (!stage->matches) {
 537                         sr_err("Stage %d has no matches defined.", stage->stage);
 538                         return SR_ERR;
 539                 }
 540                 for (m = stage->matches; m; m = m->next) {
 541                         match = m->data;
 542                         if (!match->channel) {
 543                                 sr_err("Stage %d match has no channel.", stage->stage);
 544                                 return SR_ERR;
 545                         }
 546                         if (!match->match) {
 547                                 sr_err("Stage %d match is not defined.", stage->stage);
 548                                 return SR_ERR;
 549                         }
 550                         sr_spew("Stage %d match on channel %s, match %d", stage->stage,
 551                                         match->channel->name, match->match);
 552                 }
 553         }
 554
 555         return SR_OK;
 556 }
 557
 558 /**
 559  * Start a session.
 560  *
 561  * @param session The session to use. Must not be NULL.
 562  *
 563  * @retval SR_OK Success.
 564  * @retval SR_ERR_ARG Invalid session passed.
 565  *
 566  * @since 0.4.0
 567  */
 568 SR_API int sr_session_start(struct sr_session *session)
 569 {
 570         struct sr_dev_inst *sdi;
 571         struct sr_channel *ch;
 572         GSList *l, *c;
 573         int enabled_channels, ret;
 574
 575         if (!session) {
 576                 sr_err("%s: session was NULL", __func__);
 577                 return SR_ERR_ARG;
 578         }
 579
 580         if (!session->devs) {
 581                 sr_err("%s: session->devs was NULL; a session "
 582                        "cannot be started without devices.", __func__);
 583                 return SR_ERR_ARG;
 584         }
 585
 586         if (session->trigger && verify_trigger(session->trigger) != SR_OK)
 587                 return SR_ERR;
 588
 589         sr_info("Starting.");
 590
 591         ret = SR_OK;
 592         for (l = session->devs; l; l = l->next) {
 593                 sdi = l->data;
 594                 enabled_channels = 0;
 595                 for (c = sdi->channels; c; c = c->next) {
 596                         ch = c->data;
 597                         if (ch->enabled) {
 598                                 enabled_channels++;
 599                                 break;
 600                         }
 601                 }
 602                 if (enabled_channels == 0) {
 603                         ret = SR_ERR;
 604                         sr_err("%s using connection %s has no enabled channels!",
 605                                         sdi->driver->name, sdi->connection_id);
 606                         break;
 607                 }
 608
 609                 if ((ret = sr_config_commit(sdi)) != SR_OK) {
 610                         sr_err("Failed to commit device settings before "
 611                                "starting acquisition (%s)", sr_strerror(ret));
 612                         break;
 613                 }
 614                 if ((ret = sdi->driver->dev_acquisition_start(sdi, sdi)) != SR_OK) {
 615                         sr_err("%s: could not start an acquisition "
 616                                "(%s)", __func__, sr_strerror(ret));
 617                         break;
 618                 }
 619         }
 620
 621         /* TODO: What if there are multiple devices? Which return code? */
 622
 623         return ret;
 624 }
 625
 626 /**
 627  * Run a session.
 628  *
 629  * @param session The session to use. Must not be NULL.
 630  *
 631  * @retval SR_OK Success.
 632  * @retval SR_ERR_ARG Invalid session passed.
 633  * @retval SR_ERR Error during event processing.
 634  *
 635  * @since 0.4.0
 636  */
 637 SR_API int sr_session_run(struct sr_session *session)
 638 {
 639         int ret;
 640
 641         if (!session) {
 642                 sr_err("%s: session was NULL", __func__);
 643                 return SR_ERR_ARG;
 644         }
 645
 646         if (!session->devs) {
 647                 /* TODO: Actually the case? */
 648                 sr_err("%s: session->devs was NULL; a session "
 649                        "cannot be run without devices.", __func__);
 650                 return SR_ERR_ARG;
 651         }
 652         session->running = TRUE;
 653
 654         sr_info("Running.");
 655
 656         /* Poll event sources until none are left. */
 657         while (session->sources->len > 0) {
 658                 ret = sr_session_iteration(session);
 659                 if (ret != SR_OK)
 660                         return ret;
 661         }
 662         return SR_OK;
 663 }
 664
 665 /**
 666  * Stop a session.
 667  *
 668  * The session is stopped immediately, with all acquisition sessions stopped
 669  * and hardware drivers cleaned up.
 670  *
 671  * This must be called from within the session thread, to prevent freeing
 672  * resources that the session thread will try to use.
 673  *
 674  * @param session The session to use. Must not be NULL.
 675  *
 676  * @retval SR_OK Success.
 677  * @retval SR_ERR_ARG Invalid session passed.
 678  *
 679  * @private
 680  */
 681 SR_PRIV int sr_session_stop_sync(struct sr_session *session)
 682 {
 683         struct sr_dev_inst *sdi;
 684         GSList *l;
 685
 686         if (!session) {
 687                 sr_err("%s: session was NULL", __func__);
 688                 return SR_ERR_ARG;
 689         }
 690
 691         sr_info("Stopping.");
 692
 693         for (l = session->devs; l; l = l->next) {
 694                 sdi = l->data;
 695                 if (sdi->driver) {
 696                         if (sdi->driver->dev_acquisition_stop)
 697                                 sdi->driver->dev_acquisition_stop(sdi, sdi);
 698                 }
 699         }
 700         session->running = FALSE;
 701
 702         return SR_OK;
 703 }
 704
 705 /**
 706  * Stop a session.
 707  *
 708  * The session is stopped immediately, with all acquisition sessions being
 709  * stopped and hardware drivers cleaned up.
 710  *
 711  * If the session is run in a separate thread, this function will not block
 712  * until the session is finished executing. It is the caller's responsibility
 713  * to wait for the session thread to return before assuming that the session is
 714  * completely decommissioned.
 715  *
 716  * @param session The session to use. Must not be NULL.
 717  *
 718  * @retval SR_OK Success.
 719  * @retval SR_ERR_ARG Invalid session passed.
 720  *
 721  * @since 0.4.0
 722  */
 723 SR_API int sr_session_stop(struct sr_session *session)
 724 {
 725         if (!session) {
 726                 sr_err("%s: session was NULL", __func__);
 727                 return SR_ERR_BUG;
 728         }
 729
 730         g_mutex_lock(&session->stop_mutex);
 731         session->abort_session = TRUE;
 732         g_mutex_unlock(&session->stop_mutex);
 733
 734         return SR_OK;
 735 }
 736
 737 /**
 738  * Debug helper.
 739  *
 740  * @param packet The packet to show debugging information for.
 741  */
 742 static void datafeed_dump(const struct sr_datafeed_packet *packet)
 743 {
 744         const struct sr_datafeed_logic *logic;
 745         const struct sr_datafeed_analog *analog;
 746         const struct sr_datafeed_analog2 *analog2;
 747
 748         /* Please use the same order as in libsigrok.h. */
 749         switch (packet->type) {
 750         case SR_DF_HEADER:
 751                 sr_dbg("bus: Received SR_DF_HEADER packet.");
 752                 break;
 753         case SR_DF_END:
 754                 sr_dbg("bus: Received SR_DF_END packet.");
 755                 break;
 756         case SR_DF_META:
 757                 sr_dbg("bus: Received SR_DF_META packet.");
 758                 break;
 759         case SR_DF_TRIGGER:
 760                 sr_dbg("bus: Received SR_DF_TRIGGER packet.");
 761                 break;
 762         case SR_DF_LOGIC:
 763                 logic = packet->payload;
 764                 sr_dbg("bus: Received SR_DF_LOGIC packet (%" PRIu64 " bytes, "
 765                        "unitsize = %d).", logic->length, logic->unitsize);
 766                 break;
 767         case SR_DF_ANALOG:
 768                 analog = packet->payload;
 769                 sr_dbg("bus: Received SR_DF_ANALOG packet (%d samples).",
 770                        analog->num_samples);
 771                 break;
 772         case SR_DF_FRAME_BEGIN:
 773                 sr_dbg("bus: Received SR_DF_FRAME_BEGIN packet.");
 774                 break;
 775         case SR_DF_FRAME_END:
 776                 sr_dbg("bus: Received SR_DF_FRAME_END packet.");
 777                 break;
 778         case SR_DF_ANALOG2:
 779                 analog2 = packet->payload;
 780                 sr_dbg("bus: Received SR_DF_ANALOG2 packet (%d samples).",
 781                        analog2->num_samples);
 782                 break;
 783         default:
 784                 sr_dbg("bus: Received unknown packet type: %d.", packet->type);
 785                 break;
 786         }
 787 }
 788
 789 /**
 790  * Send a packet to whatever is listening on the datafeed bus.
 791  *
 792  * Hardware drivers use this to send a data packet to the frontend.
 793  *
 794  * @param sdi TODO.
 795  * @param packet The datafeed packet to send to the session bus.
 796  *
 797  * @retval SR_OK Success.
 798  * @retval SR_ERR_ARG Invalid argument.
 799  *
 800  * @private
 801  */
 802 SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
 803                 const struct sr_datafeed_packet *packet)
 804 {
 805         GSList *l;
 806         struct datafeed_callback *cb_struct;
 807         struct sr_datafeed_packet *packet_in, *packet_out;
 808         struct sr_transform *t;
 809         int ret;
 810
 811         if (!sdi) {
 812                 sr_err("%s: sdi was NULL", __func__);
 813                 return SR_ERR_ARG;
 814         }
 815
 816         if (!packet) {
 817                 sr_err("%s: packet was NULL", __func__);
 818                 return SR_ERR_ARG;
 819         }
 820
 821         if (!sdi->session) {
 822                 sr_err("%s: session was NULL", __func__);
 823                 return SR_ERR_BUG;
 824         }
 825
 826         /*
 827          * Pass the packet to the first transform module. If that returns
 828          * another packet (instead of NULL), pass that packet to the next
 829          * transform module in the list, and so on.
 830          */
 831         packet_in = (struct sr_datafeed_packet *)packet;
 832         for (l = sdi->session->transforms; l; l = l->next) {
 833                 t = l->data;
 834                 sr_spew("Running transform module '%s'.", t->module->id);
 835                 ret = t->module->receive(t, packet_in, &packet_out);
 836                 if (ret < 0) {
 837                         sr_err("Error while running transform module: %d.", ret);
 838                         return SR_ERR;
 839                 }
 840                 if (!packet_out) {
 841                         /*
 842                          * If any of the transforms don't return an output
 843                          * packet, abort.
 844                          */
 845                         sr_spew("Transform module didn't return a packet, aborting.");
 846                         return SR_OK;
 847                 } else {
 848                         /*
 849                          * Use this transform module's output packet as input
 850                          * for the next transform module.
 851                          */
 852                         packet_in = packet_out;
 853                 }
 854         }
 855         packet = packet_in;
 856
 857         /*
 858          * If the last transform did output a packet, pass it to all datafeed
 859          * callbacks.
 860          */
 861         for (l = sdi->session->datafeed_callbacks; l; l = l->next) {
 862                 if (sr_log_loglevel_get() >= SR_LOG_DBG)
 863                         datafeed_dump(packet);
 864                 cb_struct = l->data;
 865                 cb_struct->cb(sdi, packet, cb_struct->cb_data);
 866         }
 867
 868         return SR_OK;
 869 }
 870
 871 /**
 872  * Add an event source for a file descriptor.
 873  *
 874  * @param session The session to use. Must not be NULL.
 875  * @param pollfd The GPollFD.
 876  * @param[in] timeout Max time in ms to wait before the callback is called,
 877  *                    or -1 to wait indefinitely.
 878  * @param cb Callback function to add. Must not be NULL.
 879  * @param cb_data Data for the callback function. Can be NULL.
 880  * @param poll_object Handle by which the source is identified
 881  * @param is_usb TRUE for a libusb polling source
 882  *
 883  * @retval SR_OK Success.
 884  * @retval SR_ERR_ARG Invalid argument.
 885  */
 886 SR_PRIV int sr_session_source_add_internal(struct sr_session *session,
 887                 GPollFD *pollfd, int timeout, sr_receive_data_callback cb,
 888                 void *cb_data, gintptr poll_object, gboolean is_usb)
 889 {
 890         struct source src;
 891
 892         if (!cb) {
 893                 sr_err("%s: cb was NULL", __func__);
 894                 return SR_ERR_ARG;
 895         }
 896         /* Note: cb_data can be NULL, that's not a bug. */
 897
 898         src.cb = cb;
 899         src.cb_data = cb_data;
 900         src.poll_object = poll_object;
 901         src.is_usb = is_usb;
 902         src.triggered = FALSE;
 903
 904         if (timeout >= 0) {
 905                 src.timeout = INT64_C(1000) * timeout;
 906                 src.due = g_get_monotonic_time() + src.timeout;
 907         } else {
 908                 src.timeout = -1;
 909                 src.due = INT64_MAX;
 910         }
 911
 912         if (pollfd) {
 913                 /* I/O source */
 914                 g_array_insert_val(session->sources, session->pollfds->len, src);
 915                 g_array_append_vals(session->pollfds, pollfd, 1);
 916         } else {
 917                 /* Timer source */
 918                 g_array_append_val(session->sources, src);
 919         }
 920
 921         return SR_OK;
 922 }
 923
 924 /**
 925  * Add an event source for a file descriptor.
 926  *
 927  * @param session The session to use. Must not be NULL.
 928  * @param fd The file descriptor.
 929  * @param events Events to check for.
 930  * @param timeout Max time in ms to wait before the callback is called,
 931  *                or -1 to wait indefinitely.
 932  * @param cb Callback function to add. Must not be NULL.
 933  * @param cb_data Data for the callback function. Can be NULL.
 934  *
 935  * @retval SR_OK Success.
 936  * @retval SR_ERR_ARG Invalid argument.
 937  *
 938  * @since 0.3.0
 939  */
 940 SR_API int sr_session_source_add(struct sr_session *session, int fd,
 941                 int events, int timeout, sr_receive_data_callback cb, void *cb_data)
 942 {
 943         GPollFD p;
 944
 945         if (fd < 0 && timeout < 0) {
 946                 sr_err("Timer source without timeout would block indefinitely");
 947                 return SR_ERR_ARG;
 948         }
 949         p.fd = fd;
 950         p.events = events;
 951         p.revents = 0;
 952
 953         return sr_session_source_add_internal(session,
 954                 (fd < 0) ? NULL : &p, timeout, cb, cb_data, fd, FALSE);
 955 }
 956
 957 /**
 958  * Add an event source for a GPollFD.
 959  *
 960  * @param session The session to use. Must not be NULL.
 961  * @param pollfd The GPollFD. Must not be NULL.
 962  * @param timeout Max time in ms to wait before the callback is called,
 963  *                or -1 to wait indefinitely.
 964  * @param cb Callback function to add. Must not be NULL.
 965  * @param cb_data Data for the callback function. Can be NULL.
 966  *
 967  * @retval SR_OK Success.
 968  * @retval SR_ERR_ARG Invalid argument.
 969  *
 970  * @since 0.3.0
 971  */
 972 SR_API int sr_session_source_add_pollfd(struct sr_session *session,
 973                 GPollFD *pollfd, int timeout, sr_receive_data_callback cb,
 974                 void *cb_data)
 975 {
 976         if (!pollfd) {
 977                 sr_err("%s: pollfd was NULL", __func__);
 978                 return SR_ERR_ARG;
 979         }
 980         return sr_session_source_add_internal(session, pollfd, timeout,
 981                         cb, cb_data, (gintptr)pollfd, FALSE);
 982 }
 983
 984 /**
 985  * Add an event source for a GIOChannel.
 986  *
 987  * @param session The session to use. Must not be NULL.
 988  * @param channel The GIOChannel.
 989  * @param events Events to poll on.
 990  * @param timeout Max time in ms to wait before the callback is called,
 991  *                or -1 to wait indefinitely.
 992  * @param cb Callback function to add. Must not be NULL.
 993  * @param cb_data Data for the callback function. Can be NULL.
 994  *
 995  * @retval SR_OK Success.
 996  * @retval SR_ERR_ARG Invalid argument.
 997  *
 998  * @since 0.3.0
 999  */
1000 SR_API int sr_session_source_add_channel(struct sr_session *session,
1001                 GIOChannel *channel, int events, int timeout,
1002                 sr_receive_data_callback cb, void *cb_data)
1003 {
1004         GPollFD p;
1005
1006 #ifdef G_OS_WIN32
1007         g_io_channel_win32_make_pollfd(channel, events, &p);
1008 #else
1009         p.fd = g_io_channel_unix_get_fd(channel);
1010         p.events = events;
1011         p.revents = 0;
1012 #endif
1013         return sr_session_source_add_internal(session, &p, timeout, cb,
1014                         cb_data, (gintptr)channel, FALSE);
1015 }
1016
1017 /**
1018  * Remove the source belonging to the specified channel.
1019  *
1020  * @param session The session to use. Must not be NULL.
1021  * @param poll_object The channel for which the source should be removed.
1022  *
1023  * @retval SR_OK Success
1024  * @retval SR_ERR_ARG Invalid arguments
1025  * @retval SR_ERR_BUG Internal error
1026  */
1027 static int _sr_session_source_remove(struct sr_session *session, gintptr poll_object)
1028 {
1029         unsigned int i;
1030
1031         for (i = 0; i < session->sources->len; ++i) {
1032                 if (g_array_index(session->sources, struct source, i)
1033                                         .poll_object == poll_object) {
1034
1035                         g_array_remove_index(session->sources, i);
1036                         if (i < session->pollfds->len)
1037                                 g_array_remove_index(session->pollfds, i);
1038                         break;
1039                 }
1040         }
1041         return SR_OK;
1042 }
1043
1044 /**
1045  * Remove the source belonging to the specified file descriptor.
1046  *
1047  * @param session The session to use. Must not be NULL.
1048  * @param fd The file descriptor for which the source should be removed.
1049  *
1050  * @retval SR_OK Success
1051  * @retval SR_ERR_ARG Invalid argument
1052  * @retval SR_ERR_BUG Internal error.
1053  *
1054  * @since 0.3.0
1055  */
1056 SR_API int sr_session_source_remove(struct sr_session *session, int fd)
1057 {
1058         return _sr_session_source_remove(session, fd);
1059 }
1060
1061 /**
1062  * Remove the source belonging to the specified poll descriptor.
1063  *
1064  * @param session The session to use. Must not be NULL.
1065  * @param pollfd The poll descriptor for which the source should be removed.
1066  *               Must not be NULL.
1067  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
1068  *         SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon
1069  *         internal errors.
1070  *
1071  * @since 0.2.0
1072  */
1073 SR_API int sr_session_source_remove_pollfd(struct sr_session *session,
1074                 GPollFD *pollfd)
1075 {
1076         if (!pollfd) {
1077                 sr_err("%s: pollfd was NULL", __func__);
1078                 return SR_ERR_ARG;
1079         }
1080         return _sr_session_source_remove(session, (gintptr)pollfd);
1081 }
1082
1083 /**
1084  * Remove the source belonging to the specified channel.
1085  *
1086  * @param session The session to use. Must not be NULL.
1087  * @param channel The channel for which the source should be removed.
1088  *                Must not be NULL.
1089  * @retval SR_OK Success.
1090  * @retval SR_ERR_ARG Invalid argument.
1091  * @return SR_ERR_BUG Internal error.
1092  *
1093  * @since 0.2.0
1094  */
1095 SR_API int sr_session_source_remove_channel(struct sr_session *session,
1096                 GIOChannel *channel)
1097 {
1098         if (!channel) {
1099                 sr_err("%s: channel was NULL", __func__);
1100                 return SR_ERR_ARG;
1101         }
1102         return _sr_session_source_remove(session, (gintptr)channel);
1103 }
1104
1105 static void copy_src(struct sr_config *src, struct sr_datafeed_meta *meta_copy)
1106 {
1107         g_variant_ref(src->data);
1108         meta_copy->config = g_slist_append(meta_copy->config,
1109                                            g_memdup(src, sizeof(struct sr_config)));
1110 }
1111
1112 SR_PRIV int sr_packet_copy(const struct sr_datafeed_packet *packet,
1113                 struct sr_datafeed_packet **copy)
1114 {
1115         const struct sr_datafeed_meta *meta;
1116         struct sr_datafeed_meta *meta_copy;
1117         const struct sr_datafeed_logic *logic;
1118         struct sr_datafeed_logic *logic_copy;
1119         const struct sr_datafeed_analog *analog;
1120         struct sr_datafeed_analog *analog_copy;
1121         uint8_t *payload;
1122
1123         *copy = g_malloc0(sizeof(struct sr_datafeed_packet));
1124         (*copy)->type = packet->type;
1125
1126         switch (packet->type) {
1127         case SR_DF_TRIGGER:
1128         case SR_DF_END:
1129                 /* No payload. */
1130                 break;
1131         case SR_DF_HEADER:
1132                 payload = g_malloc(sizeof(struct sr_datafeed_header));
1133                 memcpy(payload, packet->payload, sizeof(struct sr_datafeed_header));
1134                 (*copy)->payload = payload;
1135                 break;
1136         case SR_DF_META:
1137                 meta = packet->payload;
1138                 meta_copy = g_malloc0(sizeof(struct sr_datafeed_meta));
1139                 g_slist_foreach(meta->config, (GFunc)copy_src, meta_copy->config);
1140                 (*copy)->payload = meta_copy;
1141                 break;
1142         case SR_DF_LOGIC:
1143                 logic = packet->payload;
1144                 logic_copy = g_malloc(sizeof(logic));
1145                 logic_copy->length = logic->length;
1146                 logic_copy->unitsize = logic->unitsize;
1147                 memcpy(logic_copy->data, logic->data, logic->length * logic->unitsize);
1148                 (*copy)->payload = logic_copy;
1149                 break;
1150         case SR_DF_ANALOG:
1151                 analog = packet->payload;
1152                 analog_copy = g_malloc(sizeof(analog));
1153                 analog_copy->channels = g_slist_copy(analog->channels);
1154                 analog_copy->num_samples = analog->num_samples;
1155                 analog_copy->mq = analog->mq;
1156                 analog_copy->unit = analog->unit;
1157                 analog_copy->mqflags = analog->mqflags;
1158                 memcpy(analog_copy->data, analog->data,
1159                                 analog->num_samples * sizeof(float));
1160                 (*copy)->payload = analog_copy;
1161                 break;
1162         default:
1163                 sr_err("Unknown packet type %d", packet->type);
1164                 return SR_ERR;
1165         }
1166
1167         return SR_OK;
1168 }
1169
1170 void sr_packet_free(struct sr_datafeed_packet *packet)
1171 {
1172         const struct sr_datafeed_meta *meta;
1173         const struct sr_datafeed_logic *logic;
1174         const struct sr_datafeed_analog *analog;
1175         struct sr_config *src;
1176         GSList *l;
1177
1178         switch (packet->type) {
1179         case SR_DF_TRIGGER:
1180         case SR_DF_END:
1181                 /* No payload. */
1182                 break;
1183         case SR_DF_HEADER:
1184                 /* Payload is a simple struct. */
1185                 g_free((void *)packet->payload);
1186                 break;
1187         case SR_DF_META:
1188                 meta = packet->payload;
1189                 for (l = meta->config; l; l = l->next) {
1190                         src = l->data;
1191                         g_variant_unref(src->data);
1192                         g_free(src);
1193                 }
1194                 g_slist_free(meta->config);
1195                 g_free((void *)packet->payload);
1196                 break;
1197         case SR_DF_LOGIC:
1198                 logic = packet->payload;
1199                 g_free(logic->data);
1200                 g_free((void *)packet->payload);
1201                 break;
1202         case SR_DF_ANALOG:
1203                 analog = packet->payload;
1204                 g_slist_free(analog->channels);
1205                 g_free(analog->data);
1206                 g_free((void *)packet->payload);
1207                 break;
1208         default:
1209                 sr_err("Unknown packet type %d", packet->type);
1210         }
1211         g_free(packet);
1212
1213 }
1214
1215 /** @} */