4 This file is part of PulseAudio.
6 Copyright 2004-2006 Lennart Poettering
7 Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
9 PulseAudio is free software; you can redistribute it and/or modify
10 it under the terms of the GNU Lesser General Public License as published
11 by the Free Software Foundation; either version 2 of the License,
12 or (at your option) any later version.
14 PulseAudio is distributed in the hope that it will be useful, but
15 WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 General Public License for more details.
19 You should have received a copy of the GNU Lesser General Public License
20 along with PulseAudio; if not, write to the Free Software
21 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
38 #ifdef HAVE_SYS_POLL_H
41 #include "../pulsecore/poll.h"
44 #include "../pulsecore/winsock.h"
47 #include "../pulsecore/pipe.h"
50 #include <pulsecore/core-error.h>
51 #include <pulse/timeval.h>
52 #include <pulse/xmalloc.h>
54 #include <pulsecore/core-util.h>
55 #include <pulsecore/llist.h>
56 #include <pulsecore/log.h>
61 pa_mainloop
*mainloop
;
65 pa_io_event_flags_t events
;
66 struct pollfd
*pollfd
;
68 pa_io_event_cb_t callback
;
70 pa_io_event_destroy_cb_t destroy_callback
;
72 PA_LLIST_FIELDS(pa_io_event
);
75 struct pa_time_event
{
76 pa_mainloop
*mainloop
;
80 struct timeval timeval
;
82 pa_time_event_cb_t callback
;
84 pa_time_event_destroy_cb_t destroy_callback
;
86 PA_LLIST_FIELDS(pa_time_event
);
89 struct pa_defer_event
{
90 pa_mainloop
*mainloop
;
95 pa_defer_event_cb_t callback
;
97 pa_defer_event_destroy_cb_t destroy_callback
;
99 PA_LLIST_FIELDS(pa_defer_event
);
103 PA_LLIST_HEAD(pa_io_event
, io_events
);
104 PA_LLIST_HEAD(pa_time_event
, time_events
);
105 PA_LLIST_HEAD(pa_defer_event
, defer_events
);
107 int n_enabled_defer_events
, n_enabled_time_events
, n_io_events
;
108 int io_events_please_scan
, time_events_please_scan
, defer_events_please_scan
;
110 struct pollfd
*pollfds
;
111 unsigned max_pollfds
, n_pollfds
;
114 int prepared_timeout
;
115 pa_time_event
*cached_next_time_event
;
121 int wakeup_pipe_type
;
122 int wakeup_requested
;
132 pa_poll_func poll_func
;
133 void *poll_func_userdata
;
137 static short map_flags_to_libc(pa_io_event_flags_t flags
) {
139 (flags
& PA_IO_EVENT_INPUT
? POLLIN
: 0) |
140 (flags
& PA_IO_EVENT_OUTPUT
? POLLOUT
: 0) |
141 (flags
& PA_IO_EVENT_ERROR
? POLLERR
: 0) |
142 (flags
& PA_IO_EVENT_HANGUP
? POLLHUP
: 0);
145 static pa_io_event_flags_t
map_flags_from_libc(short flags
) {
147 (flags
& POLLIN
? PA_IO_EVENT_INPUT
: 0) |
148 (flags
& POLLOUT
? PA_IO_EVENT_OUTPUT
: 0) |
149 (flags
& POLLERR
? PA_IO_EVENT_ERROR
: 0) |
150 (flags
& POLLHUP
? PA_IO_EVENT_HANGUP
: 0);
154 static pa_io_event
* mainloop_io_new(
157 pa_io_event_flags_t events
,
158 pa_io_event_cb_t callback
,
170 assert(a
== &m
->api
);
172 e
= pa_xnew(pa_io_event
, 1);
180 e
->callback
= callback
;
181 e
->userdata
= userdata
;
182 e
->destroy_callback
= NULL
;
195 if ((select((SELECT_TYPE_ARG1
) fd
, NULL
, NULL
, SELECT_TYPE_ARG234
&xset
,
196 SELECT_TYPE_ARG5
&tv
) == -1) &&
197 (WSAGetLastError() == WSAENOTSOCK
)) {
198 pa_log_warn("WARNING: cannot monitor non-socket file descriptors.");
204 PA_LLIST_PREPEND(pa_io_event
, m
->io_events
, e
);
205 m
->rebuild_pollfds
= 1;
208 pa_mainloop_wakeup(m
);
213 static void mainloop_io_enable(pa_io_event
*e
, pa_io_event_flags_t events
) {
217 if (e
->events
== events
)
223 e
->pollfd
->events
= map_flags_to_libc(events
);
225 e
->mainloop
->rebuild_pollfds
= 1;
227 pa_mainloop_wakeup(e
->mainloop
);
230 static void mainloop_io_free(pa_io_event
*e
) {
235 e
->mainloop
->io_events_please_scan
++;
237 e
->mainloop
->n_io_events
--;
238 e
->mainloop
->rebuild_pollfds
= 1;
240 pa_mainloop_wakeup(e
->mainloop
);
243 static void mainloop_io_set_destroy(pa_io_event
*e
, pa_io_event_destroy_cb_t callback
) {
246 e
->destroy_callback
= callback
;
250 static pa_defer_event
* mainloop_defer_new(
252 pa_defer_event_cb_t callback
,
263 assert(a
== &m
->api
);
265 e
= pa_xnew(pa_defer_event
, 1);
270 m
->n_enabled_defer_events
++;
272 e
->callback
= callback
;
273 e
->userdata
= userdata
;
274 e
->destroy_callback
= NULL
;
276 PA_LLIST_PREPEND(pa_defer_event
, m
->defer_events
, e
);
278 pa_mainloop_wakeup(e
->mainloop
);
283 static void mainloop_defer_enable(pa_defer_event
*e
, int b
) {
287 if (e
->enabled
&& !b
) {
288 assert(e
->mainloop
->n_enabled_defer_events
> 0);
289 e
->mainloop
->n_enabled_defer_events
--;
290 } else if (!e
->enabled
&& b
) {
291 e
->mainloop
->n_enabled_defer_events
++;
292 pa_mainloop_wakeup(e
->mainloop
);
298 static void mainloop_defer_free(pa_defer_event
*e
) {
303 e
->mainloop
->defer_events_please_scan
++;
306 assert(e
->mainloop
->n_enabled_defer_events
> 0);
307 e
->mainloop
->n_enabled_defer_events
--;
312 static void mainloop_defer_set_destroy(pa_defer_event
*e
, pa_defer_event_destroy_cb_t callback
) {
316 e
->destroy_callback
= callback
;
320 static pa_time_event
* mainloop_time_new(
322 const struct timeval
*tv
,
323 pa_time_event_cb_t callback
,
334 assert(a
== &m
->api
);
336 e
= pa_xnew(pa_time_event
, 1);
340 if ((e
->enabled
= !!tv
)) {
343 m
->n_enabled_time_events
++;
345 if (m
->cached_next_time_event
) {
346 assert(m
->cached_next_time_event
->enabled
);
348 if (pa_timeval_cmp(tv
, &m
->cached_next_time_event
->timeval
) < 0)
349 m
->cached_next_time_event
= e
;
353 e
->callback
= callback
;
354 e
->userdata
= userdata
;
355 e
->destroy_callback
= NULL
;
357 PA_LLIST_PREPEND(pa_time_event
, m
->time_events
, e
);
360 pa_mainloop_wakeup(m
);
365 static void mainloop_time_restart(pa_time_event
*e
, const struct timeval
*tv
) {
369 if (e
->enabled
&& !tv
) {
370 assert(e
->mainloop
->n_enabled_time_events
> 0);
371 e
->mainloop
->n_enabled_time_events
--;
372 } else if (!e
->enabled
&& tv
)
373 e
->mainloop
->n_enabled_time_events
++;
375 if ((e
->enabled
= !!tv
)) {
377 pa_mainloop_wakeup(e
->mainloop
);
380 if (e
->mainloop
->cached_next_time_event
&& e
->enabled
) {
381 assert(e
->mainloop
->cached_next_time_event
->enabled
);
383 if (pa_timeval_cmp(tv
, &e
->mainloop
->cached_next_time_event
->timeval
) < 0)
384 e
->mainloop
->cached_next_time_event
= e
;
385 } else if (e
->mainloop
->cached_next_time_event
== e
)
386 e
->mainloop
->cached_next_time_event
= NULL
;
389 static void mainloop_time_free(pa_time_event
*e
) {
394 e
->mainloop
->time_events_please_scan
++;
397 assert(e
->mainloop
->n_enabled_time_events
> 0);
398 e
->mainloop
->n_enabled_time_events
--;
402 if (e
->mainloop
->cached_next_time_event
== e
)
403 e
->mainloop
->cached_next_time_event
= NULL
;
405 /* no wakeup needed here. Think about it! */
408 static void mainloop_time_set_destroy(pa_time_event
*e
, pa_time_event_destroy_cb_t callback
) {
412 e
->destroy_callback
= callback
;
417 static void mainloop_quit(pa_mainloop_api
*a
, int retval
) {
423 assert(a
== &m
->api
);
425 pa_mainloop_quit(m
, retval
);
428 static const pa_mainloop_api vtable
= {
431 .io_new
= mainloop_io_new
,
432 .io_enable
= mainloop_io_enable
,
433 .io_free
= mainloop_io_free
,
434 .io_set_destroy
= mainloop_io_set_destroy
,
436 .time_new
= mainloop_time_new
,
437 .time_restart
= mainloop_time_restart
,
438 .time_free
= mainloop_time_free
,
439 .time_set_destroy
= mainloop_time_set_destroy
,
441 .defer_new
= mainloop_defer_new
,
442 .defer_enable
= mainloop_defer_enable
,
443 .defer_free
= mainloop_defer_free
,
444 .defer_set_destroy
= mainloop_defer_set_destroy
,
446 .quit
= mainloop_quit
,
449 pa_mainloop
*pa_mainloop_new(void) {
452 m
= pa_xnew(pa_mainloop
, 1);
454 m
->wakeup_pipe_type
= 0;
455 if (pipe(m
->wakeup_pipe
) < 0) {
456 pa_log_error("ERROR: cannot create wakeup pipe");
461 pa_make_nonblock_fd(m
->wakeup_pipe
[0]);
462 pa_make_nonblock_fd(m
->wakeup_pipe
[1]);
463 m
->wakeup_requested
= 0;
465 PA_LLIST_HEAD_INIT(pa_io_event
, m
->io_events
);
466 PA_LLIST_HEAD_INIT(pa_time_event
, m
->time_events
);
467 PA_LLIST_HEAD_INIT(pa_defer_event
, m
->defer_events
);
469 m
->n_enabled_defer_events
= m
->n_enabled_time_events
= m
->n_io_events
= 0;
470 m
->io_events_please_scan
= m
->time_events_please_scan
= m
->defer_events_please_scan
= 0;
472 m
->cached_next_time_event
= NULL
;
473 m
->prepared_timeout
= 0;
476 m
->max_pollfds
= m
->n_pollfds
= 0;
477 m
->rebuild_pollfds
= 1;
479 m
->quit
= m
->retval
= 0;
484 m
->state
= STATE_PASSIVE
;
487 m
->poll_func_userdata
= NULL
;
488 m
->poll_func_ret
= -1;
493 static void cleanup_io_events(pa_mainloop
*m
, int force
) {
498 pa_io_event
*n
= e
->next
;
500 if (!force
&& m
->io_events_please_scan
<= 0)
503 if (force
|| e
->dead
) {
504 PA_LLIST_REMOVE(pa_io_event
, m
->io_events
, e
);
507 assert(m
->io_events_please_scan
> 0);
508 m
->io_events_please_scan
--;
511 if (e
->destroy_callback
)
512 e
->destroy_callback(&m
->api
, e
, e
->userdata
);
516 m
->rebuild_pollfds
= 1;
522 assert(m
->io_events_please_scan
== 0);
525 static void cleanup_time_events(pa_mainloop
*m
, int force
) {
530 pa_time_event
*n
= e
->next
;
532 if (!force
&& m
->time_events_please_scan
<= 0)
535 if (force
|| e
->dead
) {
536 PA_LLIST_REMOVE(pa_time_event
, m
->time_events
, e
);
539 assert(m
->time_events_please_scan
> 0);
540 m
->time_events_please_scan
--;
543 if (!e
->dead
&& e
->enabled
) {
544 assert(m
->n_enabled_time_events
> 0);
545 m
->n_enabled_time_events
--;
549 if (e
->destroy_callback
)
550 e
->destroy_callback(&m
->api
, e
, e
->userdata
);
558 assert(m
->time_events_please_scan
== 0);
561 static void cleanup_defer_events(pa_mainloop
*m
, int force
) {
566 pa_defer_event
*n
= e
->next
;
568 if (!force
&& m
->defer_events_please_scan
<= 0)
571 if (force
|| e
->dead
) {
572 PA_LLIST_REMOVE(pa_defer_event
, m
->defer_events
, e
);
575 assert(m
->defer_events_please_scan
> 0);
576 m
->defer_events_please_scan
--;
579 if (!e
->dead
&& e
->enabled
) {
580 assert(m
->n_enabled_defer_events
> 0);
581 m
->n_enabled_defer_events
--;
585 if (e
->destroy_callback
)
586 e
->destroy_callback(&m
->api
, e
, e
->userdata
);
594 assert(m
->defer_events_please_scan
== 0);
598 void pa_mainloop_free(pa_mainloop
* m
) {
601 cleanup_io_events(m
, 1);
602 cleanup_defer_events(m
, 1);
603 cleanup_time_events(m
, 1);
605 pa_xfree(m
->pollfds
);
607 if (m
->wakeup_pipe
[0] >= 0)
608 close(m
->wakeup_pipe
[0]);
609 if (m
->wakeup_pipe
[1] >= 0)
610 close(m
->wakeup_pipe
[1]);
615 static void scan_dead(pa_mainloop
*m
) {
618 if (m
->io_events_please_scan
)
619 cleanup_io_events(m
, 0);
621 if (m
->time_events_please_scan
)
622 cleanup_time_events(m
, 0);
624 if (m
->defer_events_please_scan
)
625 cleanup_defer_events(m
, 0);
628 static void rebuild_pollfds(pa_mainloop
*m
) {
633 l
= m
->n_io_events
+ 1;
634 if (m
->max_pollfds
< l
) {
636 m
->pollfds
= pa_xrealloc(m
->pollfds
, sizeof(struct pollfd
)*l
);
643 if (m
->wakeup_pipe
[0] >= 0) {
644 m
->pollfds
[0].fd
= m
->wakeup_pipe
[0];
645 m
->pollfds
[0].events
= POLLIN
;
646 m
->pollfds
[0].revents
= 0;
651 for (e
= m
->io_events
; e
; e
= e
->next
) {
659 p
->events
= map_flags_to_libc(e
->events
);
666 m
->rebuild_pollfds
= 0;
669 static int dispatch_pollfds(pa_mainloop
*m
) {
673 assert(m
->poll_func_ret
> 0);
675 for (e
= m
->io_events
, k
= m
->poll_func_ret
; e
&& !m
->quit
&& k
> 0; e
= e
->next
) {
676 if (e
->dead
|| !e
->pollfd
|| !e
->pollfd
->revents
)
679 assert(e
->pollfd
->fd
== e
->fd
&& e
->callback
);
680 e
->callback(&m
->api
, e
, e
->fd
, map_flags_from_libc(e
->pollfd
->revents
), e
->userdata
);
681 e
->pollfd
->revents
= 0;
690 static int dispatch_defer(pa_mainloop
*m
) {
694 if (m
->n_enabled_defer_events
<= 0)
697 for (e
= m
->defer_events
; e
&& !m
->quit
; e
= e
->next
) {
698 if (e
->dead
|| !e
->enabled
)
702 e
->callback(&m
->api
, e
, e
->userdata
);
709 static pa_time_event
* find_next_time_event(pa_mainloop
*m
) {
710 pa_time_event
*t
, *n
= NULL
;
713 if (m
->cached_next_time_event
)
714 return m
->cached_next_time_event
;
716 for (t
= m
->time_events
; t
; t
= t
->next
) {
718 if (t
->dead
|| !t
->enabled
)
721 if (!n
|| pa_timeval_cmp(&t
->timeval
, &n
->timeval
) < 0) {
724 /* Shortcut for tv = { 0, 0 } */
725 if (n
->timeval
.tv_sec
<= 0)
730 m
->cached_next_time_event
= n
;
734 static int calc_next_timeout(pa_mainloop
*m
) {
739 if (!m
->n_enabled_time_events
)
742 t
= find_next_time_event(m
);
745 if (t
->timeval
.tv_sec
<= 0)
748 pa_gettimeofday(&now
);
750 if (pa_timeval_cmp(&t
->timeval
, &now
) <= 0)
753 usec
= pa_timeval_diff(&t
->timeval
, &now
);
754 return (int) (usec
/ 1000);
757 static int dispatch_timeout(pa_mainloop
*m
) {
763 if (m
->n_enabled_time_events
<= 0)
766 pa_gettimeofday(&now
);
768 for (e
= m
->time_events
; e
&& !m
->quit
; e
= e
->next
) {
770 if (e
->dead
|| !e
->enabled
)
773 if (pa_timeval_cmp(&e
->timeval
, &now
) <= 0) {
776 /* Disable time event */
777 mainloop_time_restart(e
, NULL
);
779 e
->callback(&m
->api
, e
, &e
->timeval
, e
->userdata
);
788 void pa_mainloop_wakeup(pa_mainloop
*m
) {
792 if (m
->wakeup_pipe
[1] >= 0 && m
->state
== STATE_POLLING
) {
793 pa_write(m
->wakeup_pipe
[1], &c
, sizeof(c
), &m
->wakeup_pipe_type
);
794 m
->wakeup_requested
++;
798 static void clear_wakeup(pa_mainloop
*m
) {
803 if (m
->wakeup_pipe
[0] < 0)
806 if (m
->wakeup_requested
) {
807 while (pa_read(m
->wakeup_pipe
[0], &c
, sizeof(c
), &m
->wakeup_pipe_type
) == sizeof(c
));
808 m
->wakeup_requested
= 0;
812 int pa_mainloop_prepare(pa_mainloop
*m
, int timeout
) {
814 assert(m
->state
== STATE_PASSIVE
);
822 if (m
->n_enabled_defer_events
<= 0) {
823 if (m
->rebuild_pollfds
)
826 m
->prepared_timeout
= calc_next_timeout(m
);
827 if (timeout
>= 0 && (timeout
< m
->prepared_timeout
|| m
->prepared_timeout
< 0))
828 m
->prepared_timeout
= timeout
;
831 m
->state
= STATE_PREPARED
;
835 m
->state
= STATE_QUIT
;
839 int pa_mainloop_poll(pa_mainloop
*m
) {
841 assert(m
->state
== STATE_PREPARED
);
846 m
->state
= STATE_POLLING
;
848 if (m
->n_enabled_defer_events
)
849 m
->poll_func_ret
= 0;
851 assert(!m
->rebuild_pollfds
);
854 m
->poll_func_ret
= m
->poll_func(m
->pollfds
, m
->n_pollfds
, m
->prepared_timeout
, m
->poll_func_userdata
);
856 m
->poll_func_ret
= poll(m
->pollfds
, m
->n_pollfds
, m
->prepared_timeout
);
858 if (m
->poll_func_ret
< 0) {
860 m
->poll_func_ret
= 0;
862 pa_log("poll(): %s", pa_cstrerror(errno
));
866 m
->state
= m
->poll_func_ret
< 0 ? STATE_PASSIVE
: STATE_POLLED
;
867 return m
->poll_func_ret
;
870 m
->state
= STATE_QUIT
;
874 int pa_mainloop_dispatch(pa_mainloop
*m
) {
878 assert(m
->state
== STATE_POLLED
);
883 if (m
->n_enabled_defer_events
)
884 dispatched
+= dispatch_defer(m
);
886 if (m
->n_enabled_time_events
)
887 dispatched
+= dispatch_timeout(m
);
892 if (m
->poll_func_ret
> 0)
893 dispatched
+= dispatch_pollfds(m
);
899 m
->state
= STATE_PASSIVE
;
904 m
->state
= STATE_QUIT
;
908 int pa_mainloop_get_retval(pa_mainloop
*m
) {
913 int pa_mainloop_iterate(pa_mainloop
*m
, int block
, int *retval
) {
917 if ((r
= pa_mainloop_prepare(m
, block
? -1 : 0)) < 0)
920 if ((r
= pa_mainloop_poll(m
)) < 0)
923 if ((r
= pa_mainloop_dispatch(m
)) < 0)
930 if ((r
== -2) && retval
)
931 *retval
= pa_mainloop_get_retval(m
);
935 int pa_mainloop_run(pa_mainloop
*m
, int *retval
) {
938 while ((r
= pa_mainloop_iterate(m
, 1, retval
)) >= 0);
948 void pa_mainloop_quit(pa_mainloop
*m
, int retval
) {
953 pa_mainloop_wakeup(m
);
956 pa_mainloop_api
* pa_mainloop_get_api(pa_mainloop
*m
) {
961 void pa_mainloop_set_poll_func(pa_mainloop
*m
, pa_poll_func poll_func
, void *userdata
) {
964 m
->poll_func
= poll_func
;
965 m
->poll_func_userdata
= userdata
;