/* Spa * * Copyright © 2018 Wim Taymans * * Permission is hereby granted, free of charge, to any person obtaining a * copy of this software and associated documentation files (the "Software"), * to deal in the Software without restriction, including without limitation * the rights to use, copy, modify, merge, publish, distribute, sublicense, * and/or sell copies of the Software, and to permit persons to whom the * Software is furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice (including the next * paragraph) shall be included in all copies or substantial portions of the * Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER * DEALINGS IN THE SOFTWARE. */ #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #define NAME "loop" #define DATAS_SIZE (4096 * 8) /** \cond */ struct invoke_item { size_t item_size; spa_invoke_func_t func; uint32_t seq; void *data; size_t size; bool block; void *user_data; int res; }; static void loop_signal_event(void *object, struct spa_source *source); struct impl { struct spa_handle handle; struct spa_loop loop; struct spa_loop_control control; struct spa_loop_utils utils; struct spa_log *log; struct spa_system *system; struct spa_list source_list; struct spa_list destroy_list; struct spa_hook_list hooks_list; int poll_fd; pthread_t thread; struct spa_source *wakeup; int ack_fd; struct spa_ringbuffer buffer; uint8_t buffer_data[DATAS_SIZE]; }; struct source_impl { struct spa_source source; struct impl *impl; struct spa_list link; bool close; union { spa_source_io_func_t io; spa_source_idle_func_t idle; spa_source_event_func_t event; spa_source_timer_func_t timer; spa_source_signal_func_t signal; } func; bool enabled; }; /** \endcond */ static int loop_add_source(void *object, struct spa_source *source) { struct impl *impl = object; source->loop = &impl->loop; if (SPA_UNLIKELY(source->fd == -1)) return 0; return spa_system_pollfd_add(impl->system, impl->poll_fd, source->fd, source->mask, source); } static int loop_update_source(void *object, struct spa_source *source) { struct impl *impl = object; if (SPA_UNLIKELY(source->fd == -1)) return 0; return spa_system_pollfd_mod(impl->system, impl->poll_fd, source->fd, source->mask, source); } static int loop_remove_source(void *object, struct spa_source *source) { struct impl *impl = object; source->loop = NULL; if (SPA_UNLIKELY(source->fd == -1)) return 0; return spa_system_pollfd_del(impl->system, impl->poll_fd, source->fd); } static int loop_invoke(void *object, spa_invoke_func_t func, uint32_t seq, const void *data, size_t size, bool block, void *user_data) { struct impl *impl = object; bool in_thread = pthread_equal(impl->thread, pthread_self()); struct invoke_item *item; int res; if (in_thread) { res = func(object, false, seq, data, size, user_data); } else { int32_t filled; uint32_t avail, idx, offset, l0; filled = spa_ringbuffer_get_write_index(&impl->buffer, &idx); if (filled < 0 || filled > DATAS_SIZE) { spa_log_warn(impl->log, NAME " %p: queue xrun %d", impl, filled); return -EPIPE; } avail = DATAS_SIZE - filled; if (avail < sizeof(struct invoke_item)) { spa_log_warn(impl->log, NAME " %p: queue full %d", impl, avail); return -EPIPE; } offset = idx & (DATAS_SIZE - 1); l0 = DATAS_SIZE - offset; item = SPA_MEMBER(impl->buffer_data, offset, struct invoke_item); item->func = func; item->seq = seq; item->size = size; item->block = block; item->user_data = user_data; if (l0 > sizeof(struct invoke_item) + size) { item->data = SPA_MEMBER(item, sizeof(struct invoke_item), void); item->item_size = sizeof(struct invoke_item) + size; if (l0 < sizeof(struct invoke_item) + item->item_size) item->item_size = l0; } else { item->data = impl->buffer_data; item->item_size = l0 + size; } memcpy(item->data, data, size); spa_ringbuffer_write_update(&impl->buffer, idx + item->item_size); loop_signal_event(impl, impl->wakeup); if (block) { uint64_t count = 1; spa_loop_control_hook_before(&impl->hooks_list); if ((res = spa_system_eventfd_read(impl->system, impl->ack_fd, &count)) < 0) spa_log_warn(impl->log, NAME " %p: failed to read event fd: %s", impl, spa_strerror(res)); spa_loop_control_hook_after(&impl->hooks_list); res = item->res; } else { if (seq != SPA_ID_INVALID) res = SPA_RESULT_RETURN_ASYNC(seq); else res = 0; } } return res; } static void wakeup_func(void *data, uint64_t count) { struct impl *impl = data; uint32_t index; int res; while (spa_ringbuffer_get_read_index(&impl->buffer, &index) > 0) { struct invoke_item *item; bool block; item = SPA_MEMBER(impl->buffer_data, index & (DATAS_SIZE - 1), struct invoke_item); block = item->block; item->res = item->func(&impl->loop, true, item->seq, item->data, item->size, item->user_data); spa_ringbuffer_read_update(&impl->buffer, index + item->item_size); if (block) { if ((res = spa_system_eventfd_write(impl->system, impl->ack_fd, 1)) < 0) spa_log_warn(impl->log, NAME " %p: failed to write event fd: %s", impl, spa_strerror(res)); } } } static int loop_get_fd(void *object) { struct impl *impl = object; return impl->poll_fd; } static void loop_add_hook(void *object, struct spa_hook *hook, const struct spa_loop_control_hooks *hooks, void *data) { struct impl *impl = object; spa_hook_list_append(&impl->hooks_list, hook, hooks, data); } static void loop_enter(void *object) { struct impl *impl = object; impl->thread = pthread_self(); } static void loop_leave(void *object) { struct impl *impl = object; impl->thread = 0; } static inline void process_destroy(struct impl *impl) { struct source_impl *source, *tmp; spa_list_for_each_safe(source, tmp, &impl->destroy_list, link) free(source); spa_list_init(&impl->destroy_list); } static int loop_iterate(void *object, int timeout) { struct impl *impl = object; struct spa_loop *loop = &impl->loop; struct spa_poll_event ep[32]; int i, nfds, save_errno = 0; spa_loop_control_hook_before(&impl->hooks_list); nfds = spa_system_pollfd_wait(impl->system, impl->poll_fd, ep, SPA_N_ELEMENTS(ep), timeout); if (SPA_UNLIKELY(nfds < 0)) save_errno = errno; spa_loop_control_hook_after(&impl->hooks_list); if (SPA_UNLIKELY(nfds < 0)) return save_errno; /* first we set all the rmasks, then call the callbacks. The reason is that * some callback might also want to look at other sources it manages and * can then reset the rmask to suppress the callback */ for (i = 0; i < nfds; i++) { struct spa_source *s = ep[i].data; s->rmask = ep[i].events; } for (i = 0; i < nfds; i++) { struct spa_source *s = ep[i].data; if (s->rmask && s->fd != -1 && s->loop == loop) s->func(s); } process_destroy(impl); return nfds; } static void source_io_func(struct spa_source *source) { struct source_impl *impl = SPA_CONTAINER_OF(source, struct source_impl, source); impl->func.io(source->data, source->fd, source->rmask); } static struct spa_source *loop_add_io(void *object, int fd, uint32_t mask, bool close, spa_source_io_func_t func, void *data) { struct impl *impl = object; struct source_impl *source; source = calloc(1, sizeof(struct source_impl)); if (source == NULL) return NULL; source->source.loop = &impl->loop; source->source.func = source_io_func; source->source.data = data; source->source.fd = fd; source->source.mask = mask; source->impl = impl; source->close = close; source->func.io = func; loop_add_source(impl, &source->source); spa_list_insert(&impl->source_list, &source->link); return &source->source; } static int loop_update_io(void *object, struct spa_source *source, uint32_t mask) { source->mask = mask; return loop_update_source(object, source); } static void source_idle_func(struct spa_source *source) { struct source_impl *impl = SPA_CONTAINER_OF(source, struct source_impl, source); impl->func.idle(source->data); } static void loop_enable_idle(void *object, struct spa_source *source, bool enabled) { struct source_impl *impl = SPA_CONTAINER_OF(source, struct source_impl, source); int res; if (enabled && !impl->enabled) { if ((res = spa_system_eventfd_write(impl->impl->system, source->fd, 1)) < 0) spa_log_warn(impl->impl->log, NAME " %p: failed to write idle fd %d: %s", source, source->fd, spa_strerror(res)); } else if (!enabled && impl->enabled) { uint64_t count; if ((res = spa_system_eventfd_read(impl->impl->system, source->fd, &count)) < 0) spa_log_warn(impl->impl->log, NAME " %p: failed to read idle fd %d: %s", source, source->fd, spa_strerror(res)); } impl->enabled = enabled; } static struct spa_source *loop_add_idle(void *object, bool enabled, spa_source_idle_func_t func, void *data) { struct impl *impl = object; struct source_impl *source; source = calloc(1, sizeof(struct source_impl)); if (source == NULL) return NULL; source->source.loop = &impl->loop; source->source.func = source_idle_func; source->source.data = data; source->source.fd = spa_system_eventfd_create(impl->system, SPA_FD_CLOEXEC | SPA_FD_NONBLOCK); source->impl = impl; source->close = true; source->source.mask = SPA_IO_IN; source->func.idle = func; loop_add_source(impl, &source->source); spa_list_insert(&impl->source_list, &source->link); if (enabled) loop_enable_idle(impl, &source->source, true); return &source->source; } static void source_event_func(struct spa_source *source) { struct source_impl *impl = SPA_CONTAINER_OF(source, struct source_impl, source); uint64_t count; int res; if ((res = spa_system_eventfd_read(impl->impl->system, source->fd, &count)) < 0) spa_log_warn(impl->impl->log, NAME " %p: failed to read event fd %d: %s", source, source->fd, spa_strerror(res)); impl->func.event(source->data, count); } static struct spa_source *loop_add_event(void *object, spa_source_event_func_t func, void *data) { struct impl *impl = object; struct source_impl *source; source = calloc(1, sizeof(struct source_impl)); if (source == NULL) return NULL; source->source.loop = &impl->loop; source->source.func = source_event_func; source->source.data = data; source->source.fd = spa_system_eventfd_create(impl->system, SPA_FD_CLOEXEC | SPA_FD_NONBLOCK); source->source.mask = SPA_IO_IN; source->impl = impl; source->close = true; source->func.event = func; loop_add_source(impl, &source->source); spa_list_insert(&impl->source_list, &source->link); return &source->source; } static void loop_signal_event(void *object, struct spa_source *source) { struct source_impl *impl = SPA_CONTAINER_OF(source, struct source_impl, source); int res; if ((res = spa_system_eventfd_write(impl->impl->system, source->fd, 1)) < 0) spa_log_warn(impl->impl->log, NAME " %p: failed to write event fd %d: %s", source, source->fd, spa_strerror(res)); } static void source_timer_func(struct spa_source *source) { struct source_impl *impl = SPA_CONTAINER_OF(source, struct source_impl, source); uint64_t expirations; int res; if ((res = spa_system_timerfd_read(impl->impl->system, source->fd, &expirations)) < 0) spa_log_warn(impl->impl->log, NAME " %p: failed to read timer fd %d: %s", source, source->fd, spa_strerror(res)); impl->func.timer(source->data, expirations); } static struct spa_source *loop_add_timer(void *object, spa_source_timer_func_t func, void *data) { struct impl *impl = object; struct source_impl *source; source = calloc(1, sizeof(struct source_impl)); if (source == NULL) return NULL; source->source.loop = &impl->loop; source->source.func = source_timer_func; source->source.data = data; source->source.fd = spa_system_timerfd_create(impl->system, CLOCK_MONOTONIC, SPA_FD_CLOEXEC | SPA_FD_NONBLOCK); source->source.mask = SPA_IO_IN; source->impl = impl; source->close = true; source->func.timer = func; loop_add_source(impl, &source->source); spa_list_insert(&impl->source_list, &source->link); return &source->source; } static int loop_update_timer(void *object, struct spa_source *source, struct timespec *value, struct timespec *interval, bool absolute) { struct impl *impl = object; struct itimerspec its; int flags = 0; spa_zero(its); if (value) { its.it_value = *value; } else if (interval) { its.it_value = *interval; absolute = true; } if (interval) its.it_interval = *interval; if (absolute) flags |= SPA_FD_TIMER_ABSTIME; if (spa_system_timerfd_settime(impl->system, source->fd, flags, &its, NULL) < 0) return errno; return 0; } static void source_signal_func(struct spa_source *source) { struct source_impl *impl = SPA_CONTAINER_OF(source, struct source_impl, source); int res, signal_number; if ((res = spa_system_signalfd_read(impl->impl->system, source->fd, &signal_number)) < 0) spa_log_warn(impl->impl->log, NAME " %p: failed to read signal fd %d: %s", source, source->fd, spa_strerror(res)); impl->func.signal(source->data, signal_number); } static struct spa_source *loop_add_signal(void *object, int signal_number, spa_source_signal_func_t func, void *data) { struct impl *impl = object; struct source_impl *source; source = calloc(1, sizeof(struct source_impl)); if (source == NULL) return NULL; source->source.loop = &impl->loop; source->source.func = source_signal_func; source->source.data = data; source->source.fd = spa_system_signalfd_create(impl->system, signal_number, SPA_FD_CLOEXEC | SPA_FD_NONBLOCK); source->source.mask = SPA_IO_IN; source->impl = impl; source->close = true; source->func.signal = func; loop_add_source(impl, &source->source); spa_list_insert(&impl->source_list, &source->link); return &source->source; } static void loop_destroy_source(void *object, struct spa_source *source) { struct source_impl *impl = SPA_CONTAINER_OF(source, struct source_impl, source); spa_list_remove(&impl->link); if (source->loop) loop_remove_source(impl->impl, source); if (source->fd != -1 && impl->close) { close(source->fd); source->fd = -1; } spa_list_insert(&impl->impl->destroy_list, &impl->link); } static const struct spa_loop_methods impl_loop = { SPA_VERSION_LOOP_METHODS, .add_source = loop_add_source, .update_source = loop_update_source, .remove_source = loop_remove_source, .invoke = loop_invoke, }; static const struct spa_loop_control_methods impl_loop_control = { SPA_VERSION_LOOP_CONTROL_METHODS, .get_fd = loop_get_fd, .add_hook = loop_add_hook, .enter = loop_enter, .leave = loop_leave, .iterate = loop_iterate, }; static const struct spa_loop_utils_methods impl_loop_utils = { SPA_VERSION_LOOP_UTILS_METHODS, .add_io = loop_add_io, .update_io = loop_update_io, .add_idle = loop_add_idle, .enable_idle = loop_enable_idle, .add_event = loop_add_event, .signal_event = loop_signal_event, .add_timer = loop_add_timer, .update_timer = loop_update_timer, .add_signal = loop_add_signal, .destroy_source = loop_destroy_source, }; static int impl_get_interface(struct spa_handle *handle, uint32_t type, void **interface) { struct impl *impl; spa_return_val_if_fail(handle != NULL, -EINVAL); spa_return_val_if_fail(interface != NULL, -EINVAL); impl = (struct impl *) handle; switch (type) { case SPA_TYPE_INTERFACE_Loop: *interface = &impl->loop; break; case SPA_TYPE_INTERFACE_LoopControl: *interface = &impl->control; break; case SPA_TYPE_INTERFACE_LoopUtils: *interface = &impl->utils; break; default: return -ENOENT; } return 0; } static int impl_clear(struct spa_handle *handle) { struct impl *impl; struct source_impl *source; spa_return_val_if_fail(handle != NULL, -EINVAL); impl = (struct impl *) handle; spa_list_consume(source, &impl->source_list, link) loop_destroy_source(impl, &source->source); process_destroy(impl); spa_system_close(impl->system, impl->ack_fd); spa_system_close(impl->system, impl->poll_fd); return 0; } static size_t impl_get_size(const struct spa_handle_factory *factory, const struct spa_dict *params) { return sizeof(struct impl); } static int impl_init(const struct spa_handle_factory *factory, struct spa_handle *handle, const struct spa_dict *info, const struct spa_support *support, uint32_t n_support) { struct impl *impl; uint32_t i; spa_return_val_if_fail(factory != NULL, -EINVAL); spa_return_val_if_fail(handle != NULL, -EINVAL); handle->get_interface = impl_get_interface; handle->clear = impl_clear; impl = (struct impl *) handle; impl->loop.iface = SPA_INTERFACE_INIT( SPA_TYPE_INTERFACE_Loop, SPA_VERSION_LOOP, &impl_loop, impl); impl->control.iface = SPA_INTERFACE_INIT( SPA_TYPE_INTERFACE_LoopControl, SPA_VERSION_LOOP_CONTROL, &impl_loop_control, impl); impl->utils.iface = SPA_INTERFACE_INIT( SPA_TYPE_INTERFACE_LoopUtils, SPA_VERSION_LOOP_UTILS, &impl_loop_utils, impl); for (i = 0; i < n_support; i++) { switch (support[i].type) { case SPA_TYPE_INTERFACE_Log: impl->log = support[i].data; break; case SPA_TYPE_INTERFACE_System: impl->system = support[i].data; break; } } if (impl->system == NULL) { spa_log_error(impl->log, NAME " %p: a System is needed", impl); return -EINVAL; } impl->poll_fd = spa_system_pollfd_create(impl->system, SPA_FD_CLOEXEC); if (impl->poll_fd < 0) return errno; spa_list_init(&impl->source_list); spa_list_init(&impl->destroy_list); spa_hook_list_init(&impl->hooks_list); spa_ringbuffer_init(&impl->buffer); impl->wakeup = loop_add_event(impl, wakeup_func, impl); impl->ack_fd = spa_system_eventfd_create(impl->system, SPA_FD_EVENT_SEMAPHORE | SPA_FD_CLOEXEC); spa_log_debug(impl->log, NAME " %p: initialized", impl); return 0; } static const struct spa_interface_info impl_interfaces[] = { {SPA_TYPE_INTERFACE_Loop,}, {SPA_TYPE_INTERFACE_LoopControl,}, {SPA_TYPE_INTERFACE_LoopUtils,}, }; static int impl_enum_interface_info(const struct spa_handle_factory *factory, const struct spa_interface_info **info, uint32_t *index) { spa_return_val_if_fail(factory != NULL, -EINVAL); spa_return_val_if_fail(info != NULL, -EINVAL); spa_return_val_if_fail(index != NULL, -EINVAL); if (*index >= SPA_N_ELEMENTS(impl_interfaces)) return 0; *info = &impl_interfaces[(*index)++]; return 1; } const struct spa_handle_factory spa_support_loop_factory = { SPA_VERSION_HANDLE_FACTORY, NAME, NULL, impl_get_size, impl_init, impl_enum_interface_info };