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.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;
 383
 384         ret = g_poll(session->pollfds, session->num_sources,
 385                         block ? session->source_timeout : 0);
 386         for (i = 0; i < session->num_sources; i++) {
 387                 if (session->pollfds[i].revents > 0 || (ret == 0
 388                         && session->source_timeout == session->sources[i].timeout)) {
 389                         /*
 390                          * Invoke the source's callback on an event,
 391                          * or if the poll timed out and this source
 392                          * asked for that timeout.
 393                          */
 394                         if (!session->sources[i].cb(session->pollfds[i].fd,
 395                                         session->pollfds[i].revents,
 396                                         session->sources[i].cb_data))
 397                                 sr_session_source_remove(session,
 398                                                 session->sources[i].poll_object);
 399                 }
 400                 /*
 401                  * We want to take as little time as possible to stop
 402                  * the session if we have been told to do so. Therefore,
 403                  * we check the flag after processing every source, not
 404                  * just once per main event loop.
 405                  */
 406                 g_mutex_lock(&session->stop_mutex);
 407                 if (session->abort_session) {
 408                         sr_session_stop_sync(session);
 409                         /* But once is enough. */
 410                         session->abort_session = FALSE;
 411                 }
 412                 g_mutex_unlock(&session->stop_mutex);
 413         }
 414
 415         return SR_OK;
 416 }
 417
 418 static int verify_trigger(struct sr_trigger *trigger)
 419 {
 420         struct sr_trigger_stage *stage;
 421         struct sr_trigger_match *match;
 422         GSList *l, *m;
 423
 424         if (!trigger->stages) {
 425                 sr_err("No trigger stages defined.");
 426                 return SR_ERR;
 427         }
 428
 429         sr_spew("Checking trigger:");
 430         for (l = trigger->stages; l; l = l->next) {
 431                 stage = l->data;
 432                 if (!stage->matches) {
 433                         sr_err("Stage %d has no matches defined.", stage->stage);
 434                         return SR_ERR;
 435                 }
 436                 for (m = stage->matches; m; m = m->next) {
 437                         match = m->data;
 438                         if (!match->channel) {
 439                                 sr_err("Stage %d match has no channel.", stage->stage);
 440                                 return SR_ERR;
 441                         }
 442                         if (!match->match) {
 443                                 sr_err("Stage %d match is not defined.", stage->stage);
 444                                 return SR_ERR;
 445                         }
 446                         sr_spew("Stage %d match on channel %s, match %d", stage->stage,
 447                                         match->channel->name, match->match);
 448                 }
 449         }
 450
 451         return SR_OK;
 452 }
 453
 454 /**
 455  * Start a session.
 456  *
 457  * @param session The session to use. Must not be NULL.
 458  *
 459  * @retval SR_OK Success.
 460  * @retval SR_ERR_ARG Invalid session passed.
 461  *
 462  * @since 0.4.0
 463  */
 464 SR_API int sr_session_start(struct sr_session *session)
 465 {
 466         struct sr_dev_inst *sdi;
 467         struct sr_channel *ch;
 468         GSList *l, *c;
 469         int enabled_channels, ret;
 470
 471         if (!session) {
 472                 sr_err("%s: session was NULL", __func__);
 473                 return SR_ERR_ARG;
 474         }
 475
 476         if (!session->devs) {
 477                 sr_err("%s: session->devs was NULL; a session "
 478                        "cannot be started without devices.", __func__);
 479                 return SR_ERR_ARG;
 480         }
 481
 482         if (session->trigger && verify_trigger(session->trigger) != SR_OK)
 483                 return SR_ERR;
 484
 485         sr_info("Starting.");
 486
 487         ret = SR_OK;
 488         for (l = session->devs; l; l = l->next) {
 489                 sdi = l->data;
 490                 enabled_channels = 0;
 491                 for (c = sdi->channels; c; c = c->next) {
 492                         ch = c->data;
 493                         if (ch->enabled) {
 494                                 enabled_channels++;
 495                                 break;
 496                         }
 497                 }
 498                 if (enabled_channels == 0) {
 499                         ret = SR_ERR;
 500                         sr_err("%s using connection %s has no enabled channels!",
 501                                         sdi->driver->name, sdi->connection_id);
 502                         break;
 503                 }
 504
 505                 if ((ret = sr_config_commit(sdi)) != SR_OK) {
 506                         sr_err("Failed to commit device settings before "
 507                                "starting acquisition (%s)", sr_strerror(ret));
 508                         break;
 509                 }
 510                 if ((ret = sdi->driver->dev_acquisition_start(sdi, sdi)) != SR_OK) {
 511                         sr_err("%s: could not start an acquisition "
 512                                "(%s)", __func__, sr_strerror(ret));
 513                         break;
 514                 }
 515         }
 516
 517         /* TODO: What if there are multiple devices? Which return code? */
 518
 519         return ret;
 520 }
 521
 522 /**
 523  * Run a session.
 524  *
 525  * @param session The session to use. Must not be NULL.
 526  *
 527  * @retval SR_OK Success.
 528  * @retval SR_ERR_ARG Invalid session passed.
 529  *
 530  * @since 0.4.0
 531  */
 532 SR_API int sr_session_run(struct sr_session *session)
 533 {
 534         if (!session) {
 535                 sr_err("%s: session was NULL", __func__);
 536                 return SR_ERR_ARG;
 537         }
 538
 539         if (!session->devs) {
 540                 /* TODO: Actually the case? */
 541                 sr_err("%s: session->devs was NULL; a session "
 542                        "cannot be run without devices.", __func__);
 543                 return SR_ERR_ARG;
 544         }
 545         session->running = TRUE;
 546
 547         sr_info("Running.");
 548
 549         /* Do we have real sources? */
 550         if (session->num_sources == 1 && session->pollfds[0].fd == -1) {
 551                 /* Dummy source, freewheel over it. */
 552                 while (session->num_sources)
 553                         session->sources[0].cb(-1, 0, session->sources[0].cb_data);
 554         } else {
 555                 /* Real sources, use g_poll() main loop. */
 556                 while (session->num_sources)
 557                         sr_session_iteration(session, TRUE);
 558         }
 559
 560         return SR_OK;
 561 }
 562
 563 /**
 564  * Stop a session.
 565  *
 566  * The session is stopped immediately, with all acquisition sessions stopped
 567  * and hardware drivers cleaned up.
 568  *
 569  * This must be called from within the session thread, to prevent freeing
 570  * resources that the session thread will try to use.
 571  *
 572  * @param session The session to use. Must not be NULL.
 573  *
 574  * @retval SR_OK Success.
 575  * @retval SR_ERR_ARG Invalid session passed.
 576  *
 577  * @private
 578  */
 579 SR_PRIV int sr_session_stop_sync(struct sr_session *session)
 580 {
 581         struct sr_dev_inst *sdi;
 582         GSList *l;
 583
 584         if (!session) {
 585                 sr_err("%s: session was NULL", __func__);
 586                 return SR_ERR_ARG;
 587         }
 588
 589         sr_info("Stopping.");
 590
 591         for (l = session->devs; l; l = l->next) {
 592                 sdi = l->data;
 593                 if (sdi->driver) {
 594                         if (sdi->driver->dev_acquisition_stop)
 595                                 sdi->driver->dev_acquisition_stop(sdi, sdi);
 596                 }
 597         }
 598         session->running = FALSE;
 599
 600         return SR_OK;
 601 }
 602
 603 /**
 604  * Stop a session.
 605  *
 606  * The session is stopped immediately, with all acquisition sessions being
 607  * stopped and hardware drivers cleaned up.
 608  *
 609  * If the session is run in a separate thread, this function will not block
 610  * until the session is finished executing. It is the caller's responsibility
 611  * to wait for the session thread to return before assuming that the session is
 612  * completely decommissioned.
 613  *
 614  * @param session The session to use. Must not be NULL.
 615  *
 616  * @retval SR_OK Success.
 617  * @retval SR_ERR_ARG Invalid session passed.
 618  *
 619  * @since 0.4.0
 620  */
 621 SR_API int sr_session_stop(struct sr_session *session)
 622 {
 623         if (!session) {
 624                 sr_err("%s: session was NULL", __func__);
 625                 return SR_ERR_BUG;
 626         }
 627
 628         g_mutex_lock(&session->stop_mutex);
 629         session->abort_session = TRUE;
 630         g_mutex_unlock(&session->stop_mutex);
 631
 632         return SR_OK;
 633 }
 634
 635 /**
 636  * Debug helper.
 637  *
 638  * @param packet The packet to show debugging information for.
 639  */
 640 static void datafeed_dump(const struct sr_datafeed_packet *packet)
 641 {
 642         const struct sr_datafeed_logic *logic;
 643         const struct sr_datafeed_analog *analog;
 644         const struct sr_datafeed_analog2 *analog2;
 645
 646         switch (packet->type) {
 647         case SR_DF_HEADER:
 648                 sr_dbg("bus: Received SR_DF_HEADER packet.");
 649                 break;
 650         case SR_DF_TRIGGER:
 651                 sr_dbg("bus: Received SR_DF_TRIGGER packet.");
 652                 break;
 653         case SR_DF_META:
 654                 sr_dbg("bus: Received SR_DF_META packet.");
 655                 break;
 656         case SR_DF_LOGIC:
 657                 logic = packet->payload;
 658                 sr_dbg("bus: Received SR_DF_LOGIC packet (%" PRIu64 " bytes, "
 659                        "unitsize = %d).", logic->length, logic->unitsize);
 660                 break;
 661         case SR_DF_ANALOG:
 662                 analog = packet->payload;
 663                 sr_dbg("bus: Received SR_DF_ANALOG packet (%d samples).",
 664                        analog->num_samples);
 665                 break;
 666         case SR_DF_ANALOG2:
 667                 analog2 = packet->payload;
 668                 sr_dbg("bus: Received SR_DF_ANALOG2 packet (%d samples).",
 669                        analog2->num_samples);
 670                 break;
 671         case SR_DF_END:
 672                 sr_dbg("bus: Received SR_DF_END packet.");
 673                 break;
 674         case SR_DF_FRAME_BEGIN:
 675                 sr_dbg("bus: Received SR_DF_FRAME_BEGIN packet.");
 676                 break;
 677         case SR_DF_FRAME_END:
 678                 sr_dbg("bus: Received SR_DF_FRAME_END packet.");
 679                 break;
 680         default:
 681                 sr_dbg("bus: Received unknown packet type: %d.", packet->type);
 682                 break;
 683         }
 684 }
 685
 686 /**
 687  * Send a packet to whatever is listening on the datafeed bus.
 688  *
 689  * Hardware drivers use this to send a data packet to the frontend.
 690  *
 691  * @param sdi TODO.
 692  * @param packet The datafeed packet to send to the session bus.
 693  *
 694  * @retval SR_OK Success.
 695  * @retval SR_ERR_ARG Invalid argument.
 696  *
 697  * @private
 698  */
 699 SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
 700                 const struct sr_datafeed_packet *packet)
 701 {
 702         GSList *l;
 703         struct datafeed_callback *cb_struct;
 704         struct sr_datafeed_packet *packet_in, *packet_out;
 705         struct sr_transform *t;
 706         int ret;
 707
 708         if (!sdi) {
 709                 sr_err("%s: sdi was NULL", __func__);
 710                 return SR_ERR_ARG;
 711         }
 712
 713         if (!packet) {
 714                 sr_err("%s: packet was NULL", __func__);
 715                 return SR_ERR_ARG;
 716         }
 717
 718         if (!sdi->session) {
 719                 sr_err("%s: session was NULL", __func__);
 720                 return SR_ERR_BUG;
 721         }
 722
 723         /*
 724          * Pass the packet to the first transform module. If that returns
 725          * another packet (instead of NULL), pass that packet to the next
 726          * transform module in the list, and so on.
 727          */
 728         packet_in = (struct sr_datafeed_packet *)packet;
 729         for (l = sdi->session->transforms; l; l = l->next) {
 730                 t = l->data;
 731                 sr_spew("Running transform module '%s'.", t->module->id);
 732                 ret = t->module->receive(t, packet_in, &packet_out);
 733                 if (ret < 0) {
 734                         sr_err("Error while running transform module: %d.", ret);
 735                         return SR_ERR;
 736                 }
 737                 if (!packet_out) {
 738                         /*
 739                          * If any of the transforms don't return an output
 740                          * packet, abort.
 741                          */
 742                         sr_spew("Transform module didn't return a packet, aborting.");
 743                         return SR_OK;
 744                 } else {
 745                         /*
 746                          * Use this transform module's output packet as input
 747                          * for the next transform module.
 748                          */
 749                         packet_in = packet_out;
 750                 }
 751         }
 752
 753         /*
 754          * If the last transform did output a packet, pass it to all datafeed
 755          * callbacks.
 756          */
 757         for (l = sdi->session->datafeed_callbacks; l; l = l->next) {
 758                 if (sr_log_loglevel_get() >= SR_LOG_DBG)
 759                         datafeed_dump(packet);
 760                 cb_struct = l->data;
 761                 cb_struct->cb(sdi, packet, cb_struct->cb_data);
 762         }
 763
 764         return SR_OK;
 765 }
 766
 767 /**
 768  * Add an event source for a file descriptor.
 769  *
 770  * @param session The session to use. Must not be NULL.
 771  * @param pollfd The GPollFD.
 772  * @param[in] timeout Max time to wait before the callback is called,
 773  *              ignored if 0.
 774  * @param cb Callback function to add. Must not be NULL.
 775  * @param cb_data Data for the callback function. Can be NULL.
 776  * @param poll_object TODO.
 777  *
 778  * @retval SR_OK Success.
 779  * @retval SR_ERR_ARG Invalid argument.
 780  */
 781 static int _sr_session_source_add(struct sr_session *session, GPollFD *pollfd,
 782                 int timeout, sr_receive_data_callback cb, void *cb_data, gintptr poll_object)
 783 {
 784         struct source *new_sources, *s;
 785         GPollFD *new_pollfds;
 786
 787         if (!cb) {
 788                 sr_err("%s: cb was NULL", __func__);
 789                 return SR_ERR_ARG;
 790         }
 791
 792         /* Note: cb_data can be NULL, that's not a bug. */
 793
 794         new_pollfds = g_realloc(session->pollfds,
 795                         sizeof(GPollFD) * (session->num_sources + 1));
 796         new_sources = g_realloc(session->sources, sizeof(struct source) *
 797                         (session->num_sources + 1));
 798
 799         new_pollfds[session->num_sources] = *pollfd;
 800         s = &new_sources[session->num_sources++];
 801         s->timeout = timeout;
 802         s->cb = cb;
 803         s->cb_data = cb_data;
 804         s->poll_object = poll_object;
 805         session->pollfds = new_pollfds;
 806         session->sources = new_sources;
 807
 808         if (timeout != session->source_timeout && timeout > 0
 809             && (session->source_timeout == -1 || timeout < session->source_timeout))
 810                 session->source_timeout = timeout;
 811
 812         return SR_OK;
 813 }
 814
 815 /**
 816  * Add an event source for a file descriptor.
 817  *
 818  * @param session The session to use. Must not be NULL.
 819  * @param fd The file descriptor.
 820  * @param events Events to check for.
 821  * @param timeout Max time to wait before the callback is called, ignored if 0.
 822  * @param cb Callback function to add. Must not be NULL.
 823  * @param cb_data Data for the callback function. Can be NULL.
 824  *
 825  * @retval SR_OK Success.
 826  * @retval SR_ERR_ARG Invalid argument.
 827  *
 828  * @since 0.3.0
 829  */
 830 SR_API int sr_session_source_add(struct sr_session *session, int fd,
 831                 int events, int timeout, sr_receive_data_callback cb, void *cb_data)
 832 {
 833         GPollFD p;
 834
 835         p.fd = fd;
 836         p.events = events;
 837
 838         return _sr_session_source_add(session, &p, timeout, cb, cb_data, (gintptr)fd);
 839 }
 840
 841 /**
 842  * Add an event source for a GPollFD.
 843  *
 844  * @param session The session to use. Must not be NULL.
 845  * @param pollfd The GPollFD.
 846  * @param timeout Max time to wait before the callback is called, ignored if 0.
 847  * @param cb Callback function to add. Must not be NULL.
 848  * @param cb_data Data for the callback function. Can be NULL.
 849  *
 850  * @retval SR_OK Success.
 851  * @retval SR_ERR_ARG Invalid argument.
 852  *
 853  * @since 0.3.0
 854  */
 855 SR_API int sr_session_source_add_pollfd(struct sr_session *session,
 856                 GPollFD *pollfd, int timeout, sr_receive_data_callback cb,
 857                 void *cb_data)
 858 {
 859         return _sr_session_source_add(session, pollfd, timeout, cb,
 860                         cb_data, (gintptr)pollfd);
 861 }
 862
 863 /**
 864  * Add an event source for a GIOChannel.
 865  *
 866  * @param session The session to use. Must not be NULL.
 867  * @param channel The GIOChannel.
 868  * @param events Events to poll on.
 869  * @param timeout Max time to wait before the callback is called, ignored if 0.
 870  * @param cb Callback function to add. Must not be NULL.
 871  * @param cb_data Data for the callback function. Can be NULL.
 872  *
 873  * @retval SR_OK Success.
 874  * @retval SR_ERR_ARG Invalid argument.
 875  *
 876  * @since 0.3.0
 877  */
 878 SR_API int sr_session_source_add_channel(struct sr_session *session,
 879                 GIOChannel *channel, int events, int timeout,
 880                 sr_receive_data_callback cb, void *cb_data)
 881 {
 882         GPollFD p;
 883
 884 #ifdef _WIN32
 885         g_io_channel_win32_make_pollfd(channel, events, &p);
 886 #else
 887         p.fd = g_io_channel_unix_get_fd(channel);
 888         p.events = events;
 889 #endif
 890
 891         return _sr_session_source_add(session, &p, timeout, cb, cb_data, (gintptr)channel);
 892 }
 893
 894 /**
 895  * Remove the source belonging to the specified channel.
 896  *
 897  * @param session The session to use. Must not be NULL.
 898  * @param poll_object The channel for which the source should be removed.
 899  *
 900  * @retval SR_OK Success
 901  * @retval SR_ERR_ARG Invalid arguments
 902  * @retval SR_ERR_BUG Internal error
 903  */
 904 static int _sr_session_source_remove(struct sr_session *session, gintptr poll_object)
 905 {
 906         unsigned int old;
 907
 908         if (!session->sources || !session->num_sources) {
 909                 sr_err("%s: sources was NULL", __func__);
 910                 return SR_ERR_BUG;
 911         }
 912
 913         for (old = 0; old < session->num_sources; old++) {
 914                 if (session->sources[old].poll_object == poll_object)
 915                         break;
 916         }
 917
 918         /* fd not found, nothing to do */
 919         if (old == session->num_sources)
 920                 return SR_OK;
 921
 922         session->num_sources--;
 923
 924         if (old != session->num_sources) {
 925                 memmove(&session->pollfds[old], &session->pollfds[old + 1],
 926                         (session->num_sources - old) * sizeof(GPollFD));
 927                 memmove(&session->sources[old], &session->sources[old + 1],
 928                         (session->num_sources - old) * sizeof(struct source));
 929         }
 930
 931         session->pollfds = g_realloc(session->pollfds, sizeof(GPollFD) * session->num_sources);
 932         session->sources = g_realloc(session->sources, sizeof(struct source) * session->num_sources);
 933
 934         return SR_OK;
 935 }
 936
 937 /**
 938  * Remove the source belonging to the specified file descriptor.
 939  *
 940  * @param session The session to use. Must not be NULL.
 941  * @param fd The file descriptor for which the source should be removed.
 942  *
 943  * @retval SR_OK Success
 944  * @retval SR_ERR_ARG Invalid argument
 945  * @retval SR_ERR_BUG Internal error.
 946  *
 947  * @since 0.3.0
 948  */
 949 SR_API int sr_session_source_remove(struct sr_session *session, int fd)
 950 {
 951         return _sr_session_source_remove(session, (gintptr)fd);
 952 }
 953
 954 /**
 955  * Remove the source belonging to the specified poll descriptor.
 956  *
 957  * @param session The session to use. Must not be NULL.
 958  * @param pollfd The poll descriptor for which the source should be removed.
 959  *
 960  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
 961  *         SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon
 962  *         internal errors.
 963  *
 964  * @since 0.2.0
 965  */
 966 SR_API int sr_session_source_remove_pollfd(struct sr_session *session,
 967                 GPollFD *pollfd)
 968 {
 969         return _sr_session_source_remove(session, (gintptr)pollfd);
 970 }
 971
 972 /**
 973  * Remove the source belonging to the specified channel.
 974  *
 975  * @param session The session to use. Must not be NULL.
 976  * @param channel The channel for which the source should be removed.
 977  *
 978  * @retval SR_OK Success.
 979  * @retval SR_ERR_ARG Invalid argument.
 980  * @return SR_ERR_BUG Internal error.
 981  *
 982  * @since 0.2.0
 983  */
 984 SR_API int sr_session_source_remove_channel(struct sr_session *session,
 985                 GIOChannel *channel)
 986 {
 987         return _sr_session_source_remove(session, (gintptr)channel);
 988 }
 989
 990 static void copy_src(struct sr_config *src, struct sr_datafeed_meta *meta_copy)
 991 {
 992         g_variant_ref(src->data);
 993         meta_copy->config = g_slist_append(meta_copy->config,
 994                                            g_memdup(src, sizeof(struct sr_config)));
 995 }
 996
 997 SR_PRIV int sr_packet_copy(const struct sr_datafeed_packet *packet,
 998                 struct sr_datafeed_packet **copy)
 999 {
1000         const struct sr_datafeed_meta *meta;
1001         struct sr_datafeed_meta *meta_copy;
1002         const struct sr_datafeed_logic *logic;
1003         struct sr_datafeed_logic *logic_copy;
1004         const struct sr_datafeed_analog *analog;
1005         struct sr_datafeed_analog *analog_copy;
1006         uint8_t *payload;
1007
1008         *copy = g_malloc0(sizeof(struct sr_datafeed_packet));
1009         (*copy)->type = packet->type;
1010
1011         switch (packet->type) {
1012         case SR_DF_TRIGGER:
1013         case SR_DF_END:
1014                 /* No payload. */
1015                 break;
1016         case SR_DF_HEADER:
1017                 payload = g_malloc(sizeof(struct sr_datafeed_header));
1018                 memcpy(payload, packet->payload, sizeof(struct sr_datafeed_header));
1019                 (*copy)->payload = payload;
1020                 break;
1021         case SR_DF_META:
1022                 meta = packet->payload;
1023                 meta_copy = g_malloc0(sizeof(struct sr_datafeed_meta));
1024                 g_slist_foreach(meta->config, (GFunc)copy_src, meta_copy->config);
1025                 (*copy)->payload = meta_copy;
1026                 break;
1027         case SR_DF_LOGIC:
1028                 logic = packet->payload;
1029                 logic_copy = g_malloc(sizeof(logic));
1030                 logic_copy->length = logic->length;
1031                 logic_copy->unitsize = logic->unitsize;
1032                 memcpy(logic_copy->data, logic->data, logic->length * logic->unitsize);
1033                 (*copy)->payload = logic_copy;
1034                 break;
1035         case SR_DF_ANALOG:
1036                 analog = packet->payload;
1037                 analog_copy = g_malloc(sizeof(analog));
1038                 analog_copy->channels = g_slist_copy(analog->channels);
1039                 analog_copy->num_samples = analog->num_samples;
1040                 analog_copy->mq = analog->mq;
1041                 analog_copy->unit = analog->unit;
1042                 analog_copy->mqflags = analog->mqflags;
1043                 memcpy(analog_copy->data, analog->data,
1044                                 analog->num_samples * sizeof(float));
1045                 (*copy)->payload = analog_copy;
1046                 break;
1047         default:
1048                 sr_err("Unknown packet type %d", packet->type);
1049                 return SR_ERR;
1050         }
1051
1052         return SR_OK;
1053 }
1054
1055 void sr_packet_free(struct sr_datafeed_packet *packet)
1056 {
1057         const struct sr_datafeed_meta *meta;
1058         const struct sr_datafeed_logic *logic;
1059         const struct sr_datafeed_analog *analog;
1060         struct sr_config *src;
1061         GSList *l;
1062
1063         switch (packet->type) {
1064         case SR_DF_TRIGGER:
1065         case SR_DF_END:
1066                 /* No payload. */
1067                 break;
1068         case SR_DF_HEADER:
1069                 /* Payload is a simple struct. */
1070                 g_free((void *)packet->payload);
1071                 break;
1072         case SR_DF_META:
1073                 meta = packet->payload;
1074                 for (l = meta->config; l; l = l->next) {
1075                         src = l->data;
1076                         g_variant_unref(src->data);
1077                         g_free(src);
1078                 }
1079                 g_slist_free(meta->config);
1080                 g_free((void *)packet->payload);
1081                 break;
1082         case SR_DF_LOGIC:
1083                 logic = packet->payload;
1084                 g_free(logic->data);
1085                 g_free((void *)packet->payload);
1086                 break;
1087         case SR_DF_ANALOG:
1088                 analog = packet->payload;
1089                 g_slist_free(analog->channels);
1090                 g_free(analog->data);
1091                 g_free((void *)packet->payload);
1092                 break;
1093         default:
1094                 sr_err("Unknown packet type %d", packet->type);
1095         }
1096         g_free(packet);
1097
1098 }
1099
1100 /** @} */