src/session.c

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