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  * Remove all datafeed callbacks in the current session.
 184  *
 185  * @return SR_OK upon success, SR_ERR_BUG if no session exists.
 186  */
 187 SR_API int sr_session_datafeed_callback_remove_all(void)
 188 {
 189         if (!session) {
 190                 sr_err("%s: session was NULL", __func__);
 191                 return SR_ERR_BUG;
 192         }
 193
 194         g_slist_free_full(session->datafeed_callbacks, g_free);
 195         session->datafeed_callbacks = NULL;
 196
 197         return SR_OK;
 198 }
 199
 200 /**
 201  * Add a datafeed callback to the current session.
 202  *
 203  * @param cb Function to call when a chunk of data is received.
 204  *           Must not be NULL.
 205  * @param cb_data Opaque pointer passed in by the caller.
 206  *
 207  * @return SR_OK upon success, SR_ERR_BUG if no session exists.
 208  */
 209 SR_API int sr_session_datafeed_callback_add(sr_datafeed_callback_t cb, void *cb_data)
 210 {
 211         struct datafeed_callback *cb_struct;
 212
 213         if (!session) {
 214                 sr_err("%s: session was NULL", __func__);
 215                 return SR_ERR_BUG;
 216         }
 217
 218         if (!cb) {
 219                 sr_err("%s: cb was NULL", __func__);
 220                 return SR_ERR_ARG;
 221         }
 222
 223         if (!(cb_struct = g_try_malloc0(sizeof(struct datafeed_callback))))
 224                 return SR_ERR_MALLOC;
 225
 226         cb_struct->cb = cb;
 227         cb_struct->cb_data = cb_data;
 228
 229         session->datafeed_callbacks =
 230             g_slist_append(session->datafeed_callbacks, cb_struct);
 231
 232         return SR_OK;
 233 }
 234
 235 /**
 236  * Call every device in the session's callback.
 237  *
 238  * For sessions not driven by select loops such as sr_session_run(),
 239  * but driven by another scheduler, this can be used to poll the devices
 240  * from within that scheduler.
 241  *
 242  * @param block If TRUE, this call will wait for any of the session's
 243  *              sources to fire an event on the file descriptors, or
 244  *              any of their timeouts to activate. In other words, this
 245  *              can be used as a select loop.
 246  *              If FALSE, all sources have their callback run, regardless
 247  *              of file descriptor or timeout status.
 248  *
 249  * @return SR_OK upon success, SR_ERR on errors.
 250  */
 251 SR_PRIV int sr_session_iteration(gboolean block)
 252 {
 253         unsigned int i;
 254         int ret;
 255
 256         ret = g_poll(session->pollfds, session->num_sources,
 257                         block ? session->source_timeout : 0);
 258         for (i = 0; i < session->num_sources; i++) {
 259                 if (session->pollfds[i].revents > 0 || (ret == 0
 260                         && session->source_timeout == session->sources[i].timeout)) {
 261                         /*
 262                          * Invoke the source's callback on an event,
 263                          * or if the poll timed out and this source
 264                          * asked for that timeout.
 265                          */
 266                         if (!session->sources[i].cb(session->pollfds[i].fd,
 267                                         session->pollfds[i].revents,
 268                                         session->sources[i].cb_data))
 269                                 sr_session_source_remove(session->sources[i].poll_object);
 270                 }
 271                 /*
 272                  * We want to take as little time as possible to stop
 273                  * the session if we have been told to do so. Therefore,
 274                  * we check the flag after processing every source, not
 275                  * just once per main event loop.
 276                  */
 277                 g_mutex_lock(&session->stop_mutex);
 278                 if (session->abort_session) {
 279                         sr_session_stop_sync();
 280                         /* But once is enough. */
 281                         session->abort_session = FALSE;
 282                 }
 283                 g_mutex_unlock(&session->stop_mutex);
 284         }
 285
 286         return SR_OK;
 287 }
 288
 289 /**
 290  * Start a session.
 291  *
 292  * There can only be one session at a time.
 293  *
 294  * @return SR_OK upon success, SR_ERR upon errors.
 295  */
 296 SR_API int sr_session_start(void)
 297 {
 298         struct sr_dev_inst *sdi;
 299         GSList *l;
 300         int ret;
 301
 302         if (!session) {
 303                 sr_err("%s: session was NULL; a session must be "
 304                        "created before starting it.", __func__);
 305                 return SR_ERR_BUG;
 306         }
 307
 308         if (!session->devs) {
 309                 sr_err("%s: session->devs was NULL; a session "
 310                        "cannot be started without devices.", __func__);
 311                 return SR_ERR_BUG;
 312         }
 313
 314         sr_info("Starting.");
 315
 316         ret = SR_OK;
 317         for (l = session->devs; l; l = l->next) {
 318                 sdi = l->data;
 319                 if ((ret = sdi->driver->dev_acquisition_start(sdi, sdi)) != SR_OK) {
 320                         sr_err("%s: could not start an acquisition "
 321                                "(%d)", __func__, ret);
 322                         break;
 323                 }
 324         }
 325
 326         /* TODO: What if there are multiple devices? Which return code? */
 327
 328         return ret;
 329 }
 330
 331 /**
 332  * Run the session.
 333  *
 334  * @return SR_OK upon success, SR_ERR_BUG upon errors.
 335  */
 336 SR_API int sr_session_run(void)
 337 {
 338         if (!session) {
 339                 sr_err("%s: session was NULL; a session must be "
 340                        "created first, before running it.", __func__);
 341                 return SR_ERR_BUG;
 342         }
 343
 344         if (!session->devs) {
 345                 /* TODO: Actually the case? */
 346                 sr_err("%s: session->devs was NULL; a session "
 347                        "cannot be run without devices.", __func__);
 348                 return SR_ERR_BUG;
 349         }
 350
 351         sr_info("Running.");
 352
 353         /* Do we have real sources? */
 354         if (session->num_sources == 1 && session->pollfds[0].fd == -1) {
 355                 /* Dummy source, freewheel over it. */
 356                 while (session->num_sources)
 357                         session->sources[0].cb(-1, 0, session->sources[0].cb_data);
 358         } else {
 359                 /* Real sources, use g_poll() main loop. */
 360                 while (session->num_sources)
 361                         sr_session_iteration(TRUE);
 362         }
 363
 364         return SR_OK;
 365 }
 366
 367 /**
 368  * Stop the current session.
 369  *
 370  * The current session is stopped immediately, with all acquisition sessions
 371  * being stopped and hardware drivers cleaned up.
 372  *
 373  * This must be called from within the session thread, to prevent freeing
 374  * resources that the session thread will try to use.
 375  *
 376  * @return SR_OK upon success, SR_ERR_BUG if no session exists.
 377  */
 378 SR_PRIV int sr_session_stop_sync(void)
 379 {
 380         struct sr_dev_inst *sdi;
 381         GSList *l;
 382
 383         if (!session) {
 384                 sr_err("%s: session was NULL", __func__);
 385                 return SR_ERR_BUG;
 386         }
 387
 388         sr_info("Stopping.");
 389
 390         for (l = session->devs; l; l = l->next) {
 391                 sdi = l->data;
 392                 if (sdi->driver) {
 393                         if (sdi->driver->dev_acquisition_stop)
 394                                 sdi->driver->dev_acquisition_stop(sdi, sdi);
 395                 }
 396         }
 397
 398         return SR_OK;
 399 }
 400
 401 /**
 402  * Stop the current session.
 403  *
 404  * The current session is stopped immediately, with all acquisition sessions
 405  * being stopped and hardware drivers cleaned up.
 406  *
 407  * If the session is run in a separate thread, this function will not block
 408  * until the session is finished executing. It is the caller's responsibility
 409  * to wait for the session thread to return before assuming that the session is
 410  * completely decommissioned.
 411  *
 412  * @return SR_OK upon success, SR_ERR_BUG if no session exists.
 413  */
 414 SR_API int sr_session_stop(void)
 415 {
 416         if (!session) {
 417                 sr_err("%s: session was NULL", __func__);
 418                 return SR_ERR_BUG;
 419         }
 420
 421         g_mutex_lock(&session->stop_mutex);
 422         session->abort_session = TRUE;
 423         g_mutex_unlock(&session->stop_mutex);
 424
 425         return SR_OK;
 426 }
 427
 428 /**
 429  * Debug helper.
 430  *
 431  * @param packet The packet to show debugging information for.
 432  */
 433 static void datafeed_dump(const struct sr_datafeed_packet *packet)
 434 {
 435         const struct sr_datafeed_logic *logic;
 436         const struct sr_datafeed_analog *analog;
 437
 438         switch (packet->type) {
 439         case SR_DF_HEADER:
 440                 sr_dbg("bus: Received SR_DF_HEADER packet.");
 441                 break;
 442         case SR_DF_TRIGGER:
 443                 sr_dbg("bus: Received SR_DF_TRIGGER packet.");
 444                 break;
 445         case SR_DF_META:
 446                 sr_dbg("bus: Received SR_DF_META packet.");
 447                 break;
 448         case SR_DF_LOGIC:
 449                 logic = packet->payload;
 450                 sr_dbg("bus: Received SR_DF_LOGIC packet (%" PRIu64 " bytes).",
 451                        logic->length);
 452                 break;
 453         case SR_DF_ANALOG:
 454                 analog = packet->payload;
 455                 sr_dbg("bus: Received SR_DF_ANALOG packet (%d samples).",
 456                        analog->num_samples);
 457                 break;
 458         case SR_DF_END:
 459                 sr_dbg("bus: Received SR_DF_END packet.");
 460                 break;
 461         case SR_DF_FRAME_BEGIN:
 462                 sr_dbg("bus: Received SR_DF_FRAME_BEGIN packet.");
 463                 break;
 464         case SR_DF_FRAME_END:
 465                 sr_dbg("bus: Received SR_DF_FRAME_END packet.");
 466                 break;
 467         default:
 468                 sr_dbg("bus: Received unknown packet type: %d.", packet->type);
 469                 break;
 470         }
 471 }
 472
 473 /**
 474  * Send a packet to whatever is listening on the datafeed bus.
 475  *
 476  * Hardware drivers use this to send a data packet to the frontend.
 477  *
 478  * @param sdi TODO.
 479  * @param packet The datafeed packet to send to the session bus.
 480  *
 481  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments.
 482  *
 483  * @private
 484  */
 485 SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
 486                             const struct sr_datafeed_packet *packet)
 487 {
 488         GSList *l;
 489         struct datafeed_callback *cb_struct;
 490
 491         if (!sdi) {
 492                 sr_err("%s: sdi was NULL", __func__);
 493                 return SR_ERR_ARG;
 494         }
 495
 496         if (!packet) {
 497                 sr_err("%s: packet was NULL", __func__);
 498                 return SR_ERR_ARG;
 499         }
 500
 501         for (l = session->datafeed_callbacks; l; l = l->next) {
 502                 if (sr_log_loglevel_get() >= SR_LOG_DBG)
 503                         datafeed_dump(packet);
 504                 cb_struct = l->data;
 505                 cb_struct->cb(sdi, packet, cb_struct->cb_data);
 506         }
 507
 508         return SR_OK;
 509 }
 510
 511 /**
 512  * Add an event source for a file descriptor.
 513  *
 514  * @param pollfd The GPollFD.
 515  * @param timeout Max time to wait before the callback is called, ignored if 0.
 516  * @param cb Callback function to add. Must not be NULL.
 517  * @param cb_data Data for the callback function. Can be NULL.
 518  * @param poll_object TODO.
 519  *
 520  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
 521  *         SR_ERR_MALLOC upon memory allocation errors.
 522  */
 523 static int _sr_session_source_add(GPollFD *pollfd, int timeout,
 524         sr_receive_data_callback_t cb, void *cb_data, gintptr poll_object)
 525 {
 526         struct source *new_sources, *s;
 527         GPollFD *new_pollfds;
 528
 529         if (!cb) {
 530                 sr_err("%s: cb was NULL", __func__);
 531                 return SR_ERR_ARG;
 532         }
 533
 534         /* Note: cb_data can be NULL, that's not a bug. */
 535
 536         new_pollfds = g_try_realloc(session->pollfds,
 537                         sizeof(GPollFD) * (session->num_sources + 1));
 538         if (!new_pollfds) {
 539                 sr_err("%s: new_pollfds malloc failed", __func__);
 540                 return SR_ERR_MALLOC;
 541         }
 542
 543         new_sources = g_try_realloc(session->sources, sizeof(struct source) *
 544                         (session->num_sources + 1));
 545         if (!new_sources) {
 546                 sr_err("%s: new_sources malloc failed", __func__);
 547                 return SR_ERR_MALLOC;
 548         }
 549
 550         new_pollfds[session->num_sources] = *pollfd;
 551         s = &new_sources[session->num_sources++];
 552         s->timeout = timeout;
 553         s->cb = cb;
 554         s->cb_data = cb_data;
 555         s->poll_object = poll_object;
 556         session->pollfds = new_pollfds;
 557         session->sources = new_sources;
 558
 559         if (timeout != session->source_timeout && timeout > 0
 560             && (session->source_timeout == -1 || timeout < session->source_timeout))
 561                 session->source_timeout = timeout;
 562
 563         return SR_OK;
 564 }
 565
 566 /**
 567  * Add an event source for a file descriptor.
 568  *
 569  * @param fd The file descriptor.
 570  * @param events Events to check for.
 571  * @param timeout Max time to wait before the callback is called, ignored if 0.
 572  * @param cb Callback function to add. Must not be NULL.
 573  * @param cb_data Data for the callback function. Can be NULL.
 574  *
 575  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
 576  *         SR_ERR_MALLOC upon memory allocation errors.
 577  */
 578 SR_API int sr_session_source_add(int fd, int events, int timeout,
 579                 sr_receive_data_callback_t cb, void *cb_data)
 580 {
 581         GPollFD p;
 582
 583         p.fd = fd;
 584         p.events = events;
 585
 586         return _sr_session_source_add(&p, timeout, cb, cb_data, (gintptr)fd);
 587 }
 588
 589 /**
 590  * Add an event source for a GPollFD.
 591  *
 592  * @param pollfd The GPollFD.
 593  * @param timeout Max time to wait before the callback is called, ignored if 0.
 594  * @param cb Callback function to add. Must not be NULL.
 595  * @param cb_data Data for the callback function. Can be NULL.
 596  *
 597  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
 598  *         SR_ERR_MALLOC upon memory allocation errors.
 599  */
 600 SR_API int sr_session_source_add_pollfd(GPollFD *pollfd, int timeout,
 601                 sr_receive_data_callback_t cb, void *cb_data)
 602 {
 603         return _sr_session_source_add(pollfd, timeout, cb,
 604                                       cb_data, (gintptr)pollfd);
 605 }
 606
 607 /**
 608  * Add an event source for a GIOChannel.
 609  *
 610  * @param channel The GIOChannel.
 611  * @param events Events to poll on.
 612  * @param timeout Max time to wait before the callback is called, ignored if 0.
 613  * @param cb Callback function to add. Must not be NULL.
 614  * @param cb_data Data for the callback function. Can be NULL.
 615  *
 616  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
 617  *         SR_ERR_MALLOC upon memory allocation errors.
 618  */
 619 SR_API int sr_session_source_add_channel(GIOChannel *channel, int events,
 620                 int timeout, sr_receive_data_callback_t cb, void *cb_data)
 621 {
 622         GPollFD p;
 623
 624 #ifdef _WIN32
 625         g_io_channel_win32_make_pollfd(channel, events, &p);
 626 #else
 627         p.fd = g_io_channel_unix_get_fd(channel);
 628         p.events = events;
 629 #endif
 630
 631         return _sr_session_source_add(&p, timeout, cb, cb_data, (gintptr)channel);
 632 }
 633
 634 /**
 635  * Remove the source belonging to the specified channel.
 636  *
 637  * @todo Add more error checks and logging.
 638  *
 639  * @param channel The channel for which the source should be removed.
 640  *
 641  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
 642  *         SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon
 643  *         internal errors.
 644  */
 645 static int _sr_session_source_remove(gintptr poll_object)
 646 {
 647         struct source *new_sources;
 648         GPollFD *new_pollfds;
 649         unsigned int old;
 650
 651         if (!session->sources || !session->num_sources) {
 652                 sr_err("%s: sources was NULL", __func__);
 653                 return SR_ERR_BUG;
 654         }
 655
 656         for (old = 0; old < session->num_sources; old++) {
 657                 if (session->sources[old].poll_object == poll_object)
 658                         break;
 659         }
 660
 661         /* fd not found, nothing to do */
 662         if (old == session->num_sources)
 663                 return SR_OK;
 664
 665         session->num_sources -= 1;
 666
 667         if (old != session->num_sources) {
 668                 memmove(&session->pollfds[old], &session->pollfds[old+1],
 669                         (session->num_sources - old) * sizeof(GPollFD));
 670                 memmove(&session->sources[old], &session->sources[old+1],
 671                         (session->num_sources - old) * sizeof(struct source));
 672         }
 673
 674         new_pollfds = g_try_realloc(session->pollfds, sizeof(GPollFD) * session->num_sources);
 675         if (!new_pollfds && session->num_sources > 0) {
 676                 sr_err("%s: new_pollfds malloc failed", __func__);
 677                 return SR_ERR_MALLOC;
 678         }
 679
 680         new_sources = g_try_realloc(session->sources, sizeof(struct source) * session->num_sources);
 681         if (!new_sources && session->num_sources > 0) {
 682                 sr_err("%s: new_sources malloc failed", __func__);
 683                 return SR_ERR_MALLOC;
 684         }
 685
 686         session->pollfds = new_pollfds;
 687         session->sources = new_sources;
 688
 689         return SR_OK;
 690 }
 691
 692 /**
 693  * Remove the source belonging to the specified file descriptor.
 694  *
 695  * @param fd The file descriptor for which the source should be removed.
 696  *
 697  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
 698  *         SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon
 699  *         internal errors.
 700  */
 701 SR_API int sr_session_source_remove(int fd)
 702 {
 703         return _sr_session_source_remove((gintptr)fd);
 704 }
 705
 706 /**
 707  * Remove the source belonging to the specified poll descriptor.
 708  *
 709  * @param pollfd The poll descriptor for which the source should be removed.
 710  *
 711  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
 712  *         SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon
 713  *         internal errors.
 714  */
 715 SR_API int sr_session_source_remove_pollfd(GPollFD *pollfd)
 716 {
 717         return _sr_session_source_remove((gintptr)pollfd);
 718 }
 719
 720 /**
 721  * Remove the source belonging to the specified channel.
 722  *
 723  * @param channel The channel for which the source should be removed.
 724  *
 725  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
 726  *         SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon
 727  *         internal errors.
 728  */
 729 SR_API int sr_session_source_remove_channel(GIOChannel *channel)
 730 {
 731         return _sr_session_source_remove((gintptr)channel);
 732 }
 733
 734 /** @} */