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