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