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