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