2 This file is part of PulseAudio.
4 Copyright 2004-2006 Lennart Poettering
5 Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
7 PulseAudio is free software; you can redistribute it and/or modify
8 it under the terms of the GNU Lesser General Public License as published
9 by the Free Software Foundation; either version 2 of the License,
10 or (at your option) any later version.
12 PulseAudio is distributed in the hope that it will be useful, but
13 WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 General Public License for more details.
17 You should have received a copy of the GNU Lesser General Public License
18 along with PulseAudio; if not, write to the Free Software
19 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
38 #include <pulsecore/poll.h>
42 #include <pulsecore/pipe.h>
45 #include <pulse/timeval.h>
46 #include <pulse/xmalloc.h>
48 #include <pulsecore/core-util.h>
49 #include <pulsecore/llist.h>
50 #include <pulsecore/log.h>
51 #include <pulsecore/core-error.h>
52 #include <pulsecore/winsock.h>
53 #include <pulsecore/macro.h>
58 pa_mainloop
*mainloop
;
62 pa_io_event_flags_t events
;
63 struct pollfd
*pollfd
;
65 pa_io_event_cb_t callback
;
67 pa_io_event_destroy_cb_t destroy_callback
;
69 PA_LLIST_FIELDS(pa_io_event
);
72 struct pa_time_event
{
73 pa_mainloop
*mainloop
;
77 struct timeval timeval
;
79 pa_time_event_cb_t callback
;
81 pa_time_event_destroy_cb_t destroy_callback
;
83 PA_LLIST_FIELDS(pa_time_event
);
86 struct pa_defer_event
{
87 pa_mainloop
*mainloop
;
92 pa_defer_event_cb_t callback
;
94 pa_defer_event_destroy_cb_t destroy_callback
;
96 PA_LLIST_FIELDS(pa_defer_event
);
100 PA_LLIST_HEAD(pa_io_event
, io_events
);
101 PA_LLIST_HEAD(pa_time_event
, time_events
);
102 PA_LLIST_HEAD(pa_defer_event
, defer_events
);
104 int n_enabled_defer_events
, n_enabled_time_events
, n_io_events
;
105 int io_events_please_scan
, time_events_please_scan
, defer_events_please_scan
;
107 struct pollfd
*pollfds
;
108 unsigned max_pollfds
, n_pollfds
;
111 int prepared_timeout
;
112 pa_time_event
*cached_next_time_event
;
118 int wakeup_pipe_type
;
119 int wakeup_requested
;
129 pa_poll_func poll_func
;
130 void *poll_func_userdata
;
134 static short map_flags_to_libc(pa_io_event_flags_t flags
) {
136 (flags
& PA_IO_EVENT_INPUT
? POLLIN
: 0) |
137 (flags
& PA_IO_EVENT_OUTPUT
? POLLOUT
: 0) |
138 (flags
& PA_IO_EVENT_ERROR
? POLLERR
: 0) |
139 (flags
& PA_IO_EVENT_HANGUP
? POLLHUP
: 0);
142 static pa_io_event_flags_t
map_flags_from_libc(short flags
) {
144 (flags
& POLLIN
? PA_IO_EVENT_INPUT
: 0) |
145 (flags
& POLLOUT
? PA_IO_EVENT_OUTPUT
: 0) |
146 (flags
& POLLERR
? PA_IO_EVENT_ERROR
: 0) |
147 (flags
& POLLHUP
? PA_IO_EVENT_HANGUP
: 0);
151 static pa_io_event
* mainloop_io_new(
154 pa_io_event_flags_t events
,
155 pa_io_event_cb_t callback
,
162 pa_assert(a
->userdata
);
167 pa_assert(a
== &m
->api
);
169 e
= pa_xnew(pa_io_event
, 1);
177 e
->callback
= callback
;
178 e
->userdata
= userdata
;
179 e
->destroy_callback
= NULL
;
192 if ((select((SELECT_TYPE_ARG1
) fd
, NULL
, NULL
, SELECT_TYPE_ARG234
&xset
,
193 SELECT_TYPE_ARG5
&tv
) == -1) &&
194 (WSAGetLastError() == WSAENOTSOCK
)) {
195 pa_log_warn("Cannot monitor non-socket file descriptors.");
201 PA_LLIST_PREPEND(pa_io_event
, m
->io_events
, e
);
202 m
->rebuild_pollfds
= 1;
205 pa_mainloop_wakeup(m
);
210 static void mainloop_io_enable(pa_io_event
*e
, pa_io_event_flags_t events
) {
214 if (e
->events
== events
)
220 e
->pollfd
->events
= map_flags_to_libc(events
);
222 e
->mainloop
->rebuild_pollfds
= 1;
224 pa_mainloop_wakeup(e
->mainloop
);
227 static void mainloop_io_free(pa_io_event
*e
) {
232 e
->mainloop
->io_events_please_scan
++;
234 e
->mainloop
->n_io_events
--;
235 e
->mainloop
->rebuild_pollfds
= 1;
237 pa_mainloop_wakeup(e
->mainloop
);
240 static void mainloop_io_set_destroy(pa_io_event
*e
, pa_io_event_destroy_cb_t callback
) {
243 e
->destroy_callback
= callback
;
247 static pa_defer_event
* mainloop_defer_new(
249 pa_defer_event_cb_t callback
,
256 pa_assert(a
->userdata
);
260 pa_assert(a
== &m
->api
);
262 e
= pa_xnew(pa_defer_event
, 1);
267 m
->n_enabled_defer_events
++;
269 e
->callback
= callback
;
270 e
->userdata
= userdata
;
271 e
->destroy_callback
= NULL
;
273 PA_LLIST_PREPEND(pa_defer_event
, m
->defer_events
, e
);
275 pa_mainloop_wakeup(e
->mainloop
);
280 static void mainloop_defer_enable(pa_defer_event
*e
, int b
) {
284 if (e
->enabled
&& !b
) {
285 pa_assert(e
->mainloop
->n_enabled_defer_events
> 0);
286 e
->mainloop
->n_enabled_defer_events
--;
287 } else if (!e
->enabled
&& b
) {
288 e
->mainloop
->n_enabled_defer_events
++;
289 pa_mainloop_wakeup(e
->mainloop
);
295 static void mainloop_defer_free(pa_defer_event
*e
) {
300 e
->mainloop
->defer_events_please_scan
++;
303 pa_assert(e
->mainloop
->n_enabled_defer_events
> 0);
304 e
->mainloop
->n_enabled_defer_events
--;
309 static void mainloop_defer_set_destroy(pa_defer_event
*e
, pa_defer_event_destroy_cb_t callback
) {
313 e
->destroy_callback
= callback
;
317 static pa_time_event
* mainloop_time_new(
319 const struct timeval
*tv
,
320 pa_time_event_cb_t callback
,
327 pa_assert(a
->userdata
);
331 pa_assert(a
== &m
->api
);
333 e
= pa_xnew(pa_time_event
, 1);
337 if ((e
->enabled
= !!tv
)) {
340 m
->n_enabled_time_events
++;
342 if (m
->cached_next_time_event
) {
343 pa_assert(m
->cached_next_time_event
->enabled
);
345 if (pa_timeval_cmp(tv
, &m
->cached_next_time_event
->timeval
) < 0)
346 m
->cached_next_time_event
= e
;
350 e
->callback
= callback
;
351 e
->userdata
= userdata
;
352 e
->destroy_callback
= NULL
;
354 PA_LLIST_PREPEND(pa_time_event
, m
->time_events
, e
);
357 pa_mainloop_wakeup(m
);
362 static void mainloop_time_restart(pa_time_event
*e
, const struct timeval
*tv
) {
366 if (e
->enabled
&& !tv
) {
367 pa_assert(e
->mainloop
->n_enabled_time_events
> 0);
368 e
->mainloop
->n_enabled_time_events
--;
369 } else if (!e
->enabled
&& tv
)
370 e
->mainloop
->n_enabled_time_events
++;
372 if ((e
->enabled
= !!tv
)) {
374 pa_mainloop_wakeup(e
->mainloop
);
377 if (e
->mainloop
->cached_next_time_event
&& e
->enabled
) {
378 pa_assert(e
->mainloop
->cached_next_time_event
->enabled
);
380 if (pa_timeval_cmp(tv
, &e
->mainloop
->cached_next_time_event
->timeval
) < 0)
381 e
->mainloop
->cached_next_time_event
= e
;
382 } else if (e
->mainloop
->cached_next_time_event
== e
)
383 e
->mainloop
->cached_next_time_event
= NULL
;
386 static void mainloop_time_free(pa_time_event
*e
) {
391 e
->mainloop
->time_events_please_scan
++;
394 pa_assert(e
->mainloop
->n_enabled_time_events
> 0);
395 e
->mainloop
->n_enabled_time_events
--;
399 if (e
->mainloop
->cached_next_time_event
== e
)
400 e
->mainloop
->cached_next_time_event
= NULL
;
402 /* no wakeup needed here. Think about it! */
405 static void mainloop_time_set_destroy(pa_time_event
*e
, pa_time_event_destroy_cb_t callback
) {
409 e
->destroy_callback
= callback
;
414 static void mainloop_quit(pa_mainloop_api
*a
, int retval
) {
418 pa_assert(a
->userdata
);
420 pa_assert(a
== &m
->api
);
422 pa_mainloop_quit(m
, retval
);
425 static const pa_mainloop_api vtable
= {
428 .io_new
= mainloop_io_new
,
429 .io_enable
= mainloop_io_enable
,
430 .io_free
= mainloop_io_free
,
431 .io_set_destroy
= mainloop_io_set_destroy
,
433 .time_new
= mainloop_time_new
,
434 .time_restart
= mainloop_time_restart
,
435 .time_free
= mainloop_time_free
,
436 .time_set_destroy
= mainloop_time_set_destroy
,
438 .defer_new
= mainloop_defer_new
,
439 .defer_enable
= mainloop_defer_enable
,
440 .defer_free
= mainloop_defer_free
,
441 .defer_set_destroy
= mainloop_defer_set_destroy
,
443 .quit
= mainloop_quit
,
446 pa_mainloop
*pa_mainloop_new(void) {
449 m
= pa_xnew(pa_mainloop
, 1);
451 m
->wakeup_pipe_type
= 0;
452 if (pipe(m
->wakeup_pipe
) < 0) {
453 pa_log_error("ERROR: cannot create wakeup pipe");
458 pa_make_fd_nonblock(m
->wakeup_pipe
[0]);
459 pa_make_fd_nonblock(m
->wakeup_pipe
[1]);
460 pa_make_fd_cloexec(m
->wakeup_pipe
[0]);
461 pa_make_fd_cloexec(m
->wakeup_pipe
[1]);
462 m
->wakeup_requested
= 0;
464 PA_LLIST_HEAD_INIT(pa_io_event
, m
->io_events
);
465 PA_LLIST_HEAD_INIT(pa_time_event
, m
->time_events
);
466 PA_LLIST_HEAD_INIT(pa_defer_event
, m
->defer_events
);
468 m
->n_enabled_defer_events
= m
->n_enabled_time_events
= m
->n_io_events
= 0;
469 m
->io_events_please_scan
= m
->time_events_please_scan
= m
->defer_events_please_scan
= 0;
471 m
->cached_next_time_event
= NULL
;
472 m
->prepared_timeout
= 0;
475 m
->max_pollfds
= m
->n_pollfds
= 0;
476 m
->rebuild_pollfds
= 1;
478 m
->quit
= m
->retval
= 0;
483 m
->state
= STATE_PASSIVE
;
486 m
->poll_func_userdata
= NULL
;
487 m
->poll_func_ret
= -1;
492 static void cleanup_io_events(pa_mainloop
*m
, int force
) {
497 pa_io_event
*n
= e
->next
;
499 if (!force
&& m
->io_events_please_scan
<= 0)
502 if (force
|| e
->dead
) {
503 PA_LLIST_REMOVE(pa_io_event
, m
->io_events
, e
);
506 pa_assert(m
->io_events_please_scan
> 0);
507 m
->io_events_please_scan
--;
510 if (e
->destroy_callback
)
511 e
->destroy_callback(&m
->api
, e
, e
->userdata
);
515 m
->rebuild_pollfds
= 1;
521 pa_assert(m
->io_events_please_scan
== 0);
524 static void cleanup_time_events(pa_mainloop
*m
, int force
) {
529 pa_time_event
*n
= e
->next
;
531 if (!force
&& m
->time_events_please_scan
<= 0)
534 if (force
|| e
->dead
) {
535 PA_LLIST_REMOVE(pa_time_event
, m
->time_events
, e
);
538 pa_assert(m
->time_events_please_scan
> 0);
539 m
->time_events_please_scan
--;
542 if (!e
->dead
&& e
->enabled
) {
543 pa_assert(m
->n_enabled_time_events
> 0);
544 m
->n_enabled_time_events
--;
548 if (e
->destroy_callback
)
549 e
->destroy_callback(&m
->api
, e
, e
->userdata
);
557 pa_assert(m
->time_events_please_scan
== 0);
560 static void cleanup_defer_events(pa_mainloop
*m
, int force
) {
565 pa_defer_event
*n
= e
->next
;
567 if (!force
&& m
->defer_events_please_scan
<= 0)
570 if (force
|| e
->dead
) {
571 PA_LLIST_REMOVE(pa_defer_event
, m
->defer_events
, e
);
574 pa_assert(m
->defer_events_please_scan
> 0);
575 m
->defer_events_please_scan
--;
578 if (!e
->dead
&& e
->enabled
) {
579 pa_assert(m
->n_enabled_defer_events
> 0);
580 m
->n_enabled_defer_events
--;
584 if (e
->destroy_callback
)
585 e
->destroy_callback(&m
->api
, e
, e
->userdata
);
593 pa_assert(m
->defer_events_please_scan
== 0);
597 void pa_mainloop_free(pa_mainloop
* m
) {
600 cleanup_io_events(m
, 1);
601 cleanup_defer_events(m
, 1);
602 cleanup_time_events(m
, 1);
604 pa_xfree(m
->pollfds
);
606 pa_close_pipe(m
->wakeup_pipe
);
611 static void scan_dead(pa_mainloop
*m
) {
614 if (m
->io_events_please_scan
)
615 cleanup_io_events(m
, 0);
617 if (m
->time_events_please_scan
)
618 cleanup_time_events(m
, 0);
620 if (m
->defer_events_please_scan
)
621 cleanup_defer_events(m
, 0);
624 static void rebuild_pollfds(pa_mainloop
*m
) {
629 l
= m
->n_io_events
+ 1;
630 if (m
->max_pollfds
< l
) {
632 m
->pollfds
= pa_xrealloc(m
->pollfds
, sizeof(struct pollfd
)*l
);
639 if (m
->wakeup_pipe
[0] >= 0) {
640 m
->pollfds
[0].fd
= m
->wakeup_pipe
[0];
641 m
->pollfds
[0].events
= POLLIN
;
642 m
->pollfds
[0].revents
= 0;
647 for (e
= m
->io_events
; e
; e
= e
->next
) {
655 p
->events
= map_flags_to_libc(e
->events
);
662 m
->rebuild_pollfds
= 0;
665 static int dispatch_pollfds(pa_mainloop
*m
) {
669 pa_assert(m
->poll_func_ret
> 0);
671 for (e
= m
->io_events
, k
= m
->poll_func_ret
; e
&& !m
->quit
&& k
> 0; e
= e
->next
) {
672 if (e
->dead
|| !e
->pollfd
|| !e
->pollfd
->revents
)
675 pa_assert(e
->pollfd
->fd
== e
->fd
);
676 pa_assert(e
->callback
);
677 e
->callback(&m
->api
, e
, e
->fd
, map_flags_from_libc(e
->pollfd
->revents
), e
->userdata
);
678 e
->pollfd
->revents
= 0;
687 static int dispatch_defer(pa_mainloop
*m
) {
691 if (m
->n_enabled_defer_events
<= 0)
694 for (e
= m
->defer_events
; e
&& !m
->quit
; e
= e
->next
) {
695 if (e
->dead
|| !e
->enabled
)
698 pa_assert(e
->callback
);
699 e
->callback(&m
->api
, e
, e
->userdata
);
706 static pa_time_event
* find_next_time_event(pa_mainloop
*m
) {
707 pa_time_event
*t
, *n
= NULL
;
710 if (m
->cached_next_time_event
)
711 return m
->cached_next_time_event
;
713 for (t
= m
->time_events
; t
; t
= t
->next
) {
715 if (t
->dead
|| !t
->enabled
)
718 if (!n
|| pa_timeval_cmp(&t
->timeval
, &n
->timeval
) < 0) {
721 /* Shortcut for tv = { 0, 0 } */
722 if (n
->timeval
.tv_sec
<= 0)
727 m
->cached_next_time_event
= n
;
731 static int calc_next_timeout(pa_mainloop
*m
) {
736 if (!m
->n_enabled_time_events
)
739 t
= find_next_time_event(m
);
742 if (t
->timeval
.tv_sec
<= 0)
745 pa_gettimeofday(&now
);
747 if (pa_timeval_cmp(&t
->timeval
, &now
) <= 0)
750 usec
= pa_timeval_diff(&t
->timeval
, &now
);
751 return (int) (usec
/ 1000);
754 static int dispatch_timeout(pa_mainloop
*m
) {
760 if (m
->n_enabled_time_events
<= 0)
763 pa_gettimeofday(&now
);
765 for (e
= m
->time_events
; e
&& !m
->quit
; e
= e
->next
) {
767 if (e
->dead
|| !e
->enabled
)
770 if (pa_timeval_cmp(&e
->timeval
, &now
) <= 0) {
771 pa_assert(e
->callback
);
773 /* Disable time event */
774 mainloop_time_restart(e
, NULL
);
776 e
->callback(&m
->api
, e
, &e
->timeval
, e
->userdata
);
785 void pa_mainloop_wakeup(pa_mainloop
*m
) {
789 if (m
->wakeup_pipe
[1] >= 0 && m
->state
== STATE_POLLING
) {
790 pa_write(m
->wakeup_pipe
[1], &c
, sizeof(c
), &m
->wakeup_pipe_type
);
791 m
->wakeup_requested
++;
795 static void clear_wakeup(pa_mainloop
*m
) {
800 if (m
->wakeup_pipe
[0] < 0)
803 if (m
->wakeup_requested
) {
804 while (pa_read(m
->wakeup_pipe
[0], &c
, sizeof(c
), &m
->wakeup_pipe_type
) == sizeof(c
));
805 m
->wakeup_requested
= 0;
809 int pa_mainloop_prepare(pa_mainloop
*m
, int timeout
) {
811 pa_assert(m
->state
== STATE_PASSIVE
);
819 if (m
->n_enabled_defer_events
<= 0) {
820 if (m
->rebuild_pollfds
)
823 m
->prepared_timeout
= calc_next_timeout(m
);
824 if (timeout
>= 0 && (timeout
< m
->prepared_timeout
|| m
->prepared_timeout
< 0))
825 m
->prepared_timeout
= timeout
;
828 m
->state
= STATE_PREPARED
;
832 m
->state
= STATE_QUIT
;
836 int pa_mainloop_poll(pa_mainloop
*m
) {
838 pa_assert(m
->state
== STATE_PREPARED
);
843 m
->state
= STATE_POLLING
;
845 if (m
->n_enabled_defer_events
)
846 m
->poll_func_ret
= 0;
848 pa_assert(!m
->rebuild_pollfds
);
851 m
->poll_func_ret
= m
->poll_func(m
->pollfds
, m
->n_pollfds
, m
->prepared_timeout
, m
->poll_func_userdata
);
853 m
->poll_func_ret
= poll(m
->pollfds
, m
->n_pollfds
, m
->prepared_timeout
);
855 if (m
->poll_func_ret
< 0) {
857 m
->poll_func_ret
= 0;
859 pa_log("poll(): %s", pa_cstrerror(errno
));
863 m
->state
= m
->poll_func_ret
< 0 ? STATE_PASSIVE
: STATE_POLLED
;
864 return m
->poll_func_ret
;
867 m
->state
= STATE_QUIT
;
871 int pa_mainloop_dispatch(pa_mainloop
*m
) {
875 pa_assert(m
->state
== STATE_POLLED
);
880 if (m
->n_enabled_defer_events
)
881 dispatched
+= dispatch_defer(m
);
883 if (m
->n_enabled_time_events
)
884 dispatched
+= dispatch_timeout(m
);
889 if (m
->poll_func_ret
> 0)
890 dispatched
+= dispatch_pollfds(m
);
896 m
->state
= STATE_PASSIVE
;
901 m
->state
= STATE_QUIT
;
905 int pa_mainloop_get_retval(pa_mainloop
*m
) {
910 int pa_mainloop_iterate(pa_mainloop
*m
, int block
, int *retval
) {
914 if ((r
= pa_mainloop_prepare(m
, block
? -1 : 0)) < 0)
917 if ((r
= pa_mainloop_poll(m
)) < 0)
920 if ((r
= pa_mainloop_dispatch(m
)) < 0)
927 if ((r
== -2) && retval
)
928 *retval
= pa_mainloop_get_retval(m
);
932 int pa_mainloop_run(pa_mainloop
*m
, int *retval
) {
935 while ((r
= pa_mainloop_iterate(m
, 1, retval
)) >= 0);
945 void pa_mainloop_quit(pa_mainloop
*m
, int retval
) {
950 pa_mainloop_wakeup(m
);
953 pa_mainloop_api
* pa_mainloop_get_api(pa_mainloop
*m
) {
958 void pa_mainloop_set_poll_func(pa_mainloop
*m
, pa_poll_func poll_func
, void *userdata
) {
961 m
->poll_func
= poll_func
;
962 m
->poll_func_userdata
= userdata
;