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