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