1 /**************************************************************************
5 * Copyright 2015 Samsung Electronics co., Ltd. All Rights Reserved.
7 * Contact: Eunchul Kim <chulspro.kim@samsung.com>,
8 * JinYoung Jeon <jy0.jeon@samsung.com>,
9 * Taeheon Kim <th908.kim@samsung.com>,
10 * YoungJun Cho <yj44.cho@samsung.com>,
11 * SooChan Lim <sc1.lim@samsung.com>,
12 * Boram Park <boram1288.park@samsung.com>
14 * Permission is hereby granted, free of charge, to any person obtaining a
15 * copy of this software and associated documentation files (the
16 * "Software"), to deal in the Software without restriction, including
17 * without limitation the rights to use, copy, modify, merge, publish,
18 * distribute, sub license, and/or sell copies of the Software, and to
19 * permit persons to whom the Software is furnished to do so, subject to
20 * the following conditions:
22 * The above copyright notice and this permission notice (including the
23 * next paragraph) shall be included in all copies or substantial portions
26 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
27 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
28 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
29 * IN NO EVENT SHALL PRECISION INSIGHT AND/OR ITS SUPPLIERS BE LIABLE FOR
30 * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
31 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
32 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
34 **************************************************************************/
40 #include "tdm_private.h"
42 typedef struct _tdm_event_loop_source_base {
43 struct list_head link;
44 tdm_private_display *private_display;
45 struct wl_event_source *wl_source;
46 } tdm_event_loop_source_base;
48 typedef struct _tdm_event_loop_source_fd {
49 tdm_event_loop_source_base base;
50 tdm_event_loop_fd_handler func;
52 } tdm_event_loop_source_fd;
54 typedef struct _tdm_event_loop_source_timer {
55 tdm_event_loop_source_base base;
56 tdm_event_loop_timer_handler func;
58 } tdm_event_loop_source_timer;
60 static tdm_private_loop *keep_private_loop;
63 _tdm_event_loop_main_fd_handler(int fd, tdm_event_loop_mask mask, void *user_data)
65 tdm_private_module *private_module = (tdm_private_module*)user_data;
66 tdm_func_display *func_display;
69 TDM_RETURN_VAL_IF_FAIL(TDM_MUTEX_IS_LOCKED(), TDM_ERROR_OPERATION_FAILED);
70 TDM_RETURN_VAL_IF_FAIL(private_module != NULL, TDM_ERROR_OPERATION_FAILED);
72 if (tdm_debug_module & TDM_DEBUG_EVENT)
73 TDM_INFO("backend fd(%d) event happens", private_module->fd);
75 func_display = &private_module->func_display;
76 if (!func_display->display_handle_events)
77 return TDM_ERROR_NONE;
79 ret = func_display->display_handle_events(private_module->bdata);
85 tdm_event_loop_init(tdm_private_display *private_display)
87 tdm_private_loop *private_loop;
90 TDM_RETURN_VAL_IF_FAIL(TDM_MUTEX_IS_LOCKED(), TDM_ERROR_OPERATION_FAILED);
92 if (private_display->private_loop)
93 return TDM_ERROR_NONE;
95 private_loop = calloc(1, sizeof * private_loop);
97 TDM_ERR("alloc failed");
98 return TDM_ERROR_OUT_OF_MEMORY;
101 private_loop->wl_display = wl_display_create();
102 if (!private_loop->wl_display) {
103 TDM_ERR("creating a wayland display failed");
105 return TDM_ERROR_OUT_OF_MEMORY;
107 private_loop->wl_loop = wl_display_get_event_loop(private_loop->wl_display);
109 ret = tdm_server_init(private_loop);
110 if (ret != TDM_ERROR_NONE) {
111 TDM_ERR("server init failed");
112 wl_display_destroy(private_loop->wl_display);
114 return TDM_ERROR_OPERATION_FAILED;
117 LIST_INITHEAD(&private_loop->source_list);
119 private_loop->dpy = private_display;
120 private_display->private_loop = private_loop;
122 ret = tdm_thread_init(private_loop);
123 if (ret != TDM_ERROR_NONE) {
124 TDM_ERR("thread init failed");
125 tdm_server_deinit(private_loop);
126 wl_display_destroy(private_loop->wl_display);
128 return TDM_ERROR_OPERATION_FAILED;
131 keep_private_loop = private_loop;
133 TDM_INFO("event loop fd(%d)", wl_event_loop_get_fd(private_loop->wl_loop));
135 return TDM_ERROR_NONE;
139 tdm_event_loop_deinit(tdm_private_display *private_display)
141 tdm_private_module *private_module = NULL;
142 tdm_event_loop_source_base *source = NULL, *ss = NULL;
144 TDM_RETURN_IF_FAIL(TDM_MUTEX_IS_LOCKED());
146 if (!private_display->private_loop)
149 if (tdm_thread_is_running())
150 TDM_ERR("thread is still running. tdm_event_loop_stop SHOULD be called");
152 tdm_server_deinit(private_display->private_loop);
154 LIST_FOR_EACH_ENTRY(private_module, &private_display->module_list, link) {
155 if (private_module->event_source)
156 tdm_event_loop_source_remove(private_module->event_source);
157 private_module->event_source = NULL;
158 private_module->fd = -1;
161 LIST_FOR_EACH_ENTRY_SAFE(source, ss, &private_display->private_loop->source_list, link) {
162 tdm_event_loop_source_remove(source);
165 #if WAYLAND_VERSION_MAJOR >= 1 && WAYLAND_VERSION_MINOR >= 15
166 wl_display_destroy_clients(private_display->private_loop->wl_display);
169 wl_display_destroy(private_display->private_loop->wl_display);
171 free(private_display->private_loop);
172 private_display->private_loop = NULL;
173 keep_private_loop = NULL;
175 TDM_INFO("event loop deinit done");
179 tdm_event_loop_stop(tdm_private_display *private_display)
181 TDM_RETURN_IF_FAIL(TDM_MUTEX_IS_LOCKED());
183 /* after tdm_thread_deinit, we don't worry about thread things because it's finalized */
184 tdm_thread_deinit(private_display->private_loop);
188 tdm_event_loop_create_backend_source(tdm_private_display *private_display)
190 tdm_private_loop *private_loop = private_display->private_loop;
191 tdm_private_module *private_module = NULL;
195 TDM_RETURN_IF_FAIL(TDM_MUTEX_IS_LOCKED());
196 TDM_RETURN_IF_FAIL(private_loop != NULL);
198 LIST_FOR_EACH_ENTRY(private_module, &private_display->module_list, link) {
199 tdm_func_display *func_display = &private_module->func_display;
201 if (!func_display->display_get_fd) {
202 TDM_INFO("TDM backend module won't offer a display fd");
203 private_module->event_source = NULL;
204 private_module->fd = -1;
208 ret = func_display->display_get_fd(private_module->bdata, &fd);
210 assert(ret == TDM_ERROR_NONE && fd >= 0);
211 assert(func_display->display_handle_events);
213 private_module->event_source =
214 tdm_event_loop_add_fd_handler(private_display, fd,
215 TDM_EVENT_LOOP_READABLE,
216 _tdm_event_loop_main_fd_handler,
217 private_module, &ret);
218 if (!private_module->event_source) {
219 TDM_ERR("no backend fd(%d) source", fd);
223 private_module->fd = fd;
225 TDM_INFO("backend fd(%d) source created", private_module->fd);
230 tdm_event_loop_get_fd(tdm_private_display *private_display)
232 tdm_private_loop *private_loop = private_display->private_loop;
234 /* DON'T check TDM_MUTEX_IS_LOCKED here */
236 TDM_RETURN_VAL_IF_FAIL(private_loop->wl_loop != NULL, -1);
238 return wl_event_loop_get_fd(private_loop->wl_loop);
242 tdm_event_loop_dispatch(tdm_private_display *private_display)
244 tdm_private_loop *private_loop = private_display->private_loop;
246 /* DON'T check TDM_MUTEX_IS_LOCKED here */
248 TDM_RETURN_VAL_IF_FAIL(private_loop->wl_loop != NULL, TDM_ERROR_OPERATION_FAILED);
250 if (tdm_debug_module & TDM_DEBUG_EVENT)
251 TDM_INFO("dispatch");
253 if (tdm_thread_is_running() &&
254 tdm_thread_in_display_thread(syscall(SYS_gettid))) {
255 TDM_NEVER_GET_HERE();
256 return TDM_ERROR_OPERATION_FAILED;
259 /* Don't set timeout to -1. It can make deadblock by two mutex locks.
260 * If need to set -1, use poll() and call tdm_event_loop_dispatch() after
263 if (wl_event_loop_dispatch(private_loop->wl_loop, 0) < 0)
264 TDM_ERR("dispatch failed");
266 wl_display_flush_clients(private_loop->wl_display);
268 return TDM_ERROR_NONE;
273 tdm_event_loop_flush(tdm_private_display *private_display)
275 tdm_private_loop *private_loop = private_display->private_loop;
277 /* DON'T check TDM_MUTEX_IS_LOCKED here */
279 TDM_RETURN_IF_FAIL(private_loop->wl_display != NULL);
281 if (tdm_thread_is_running() &&
282 tdm_thread_in_display_thread(syscall(SYS_gettid))) {
283 TDM_NEVER_GET_HERE();
287 wl_display_flush_clients(private_loop->wl_display);
291 _tdm_event_loop_fd_func(int fd, uint32_t wl_mask, void *data)
293 tdm_event_loop_source_fd *fd_source = (tdm_event_loop_source_fd*)data;
294 tdm_private_display *private_display;
295 tdm_event_loop_mask mask = 0;
297 /* DON'T check TDM_MUTEX_IS_LOCKED here */
299 TDM_RETURN_VAL_IF_FAIL(fd_source, 1);
300 TDM_RETURN_VAL_IF_FAIL(fd_source->func, 1);
302 private_display = fd_source->base.private_display;
304 if (wl_mask & WL_EVENT_READABLE)
305 mask |= TDM_EVENT_LOOP_READABLE;
306 if (wl_mask & WL_EVENT_WRITABLE)
307 mask |= TDM_EVENT_LOOP_WRITABLE;
308 if (wl_mask & WL_EVENT_HANGUP)
309 mask |= TDM_EVENT_LOOP_HANGUP;
310 if (wl_mask & WL_EVENT_ERROR)
311 mask |= TDM_EVENT_LOOP_ERROR;
313 _pthread_mutex_lock(&private_display->lock);
314 fd_source->func(fd, mask, fd_source->user_data);
315 _pthread_mutex_unlock(&private_display->lock);
320 EXTERN tdm_event_loop_source *
321 tdm_event_loop_add_fd_handler(tdm_display *dpy, int fd, tdm_event_loop_mask mask,
322 tdm_event_loop_fd_handler func, void *user_data,
325 tdm_private_display *private_display;
326 tdm_private_loop *private_loop;
327 tdm_event_loop_source_fd *fd_source;
328 uint32_t wl_mask = 0;
331 TDM_RETURN_VAL_IF_FAIL_WITH_ERROR(TDM_MUTEX_IS_LOCKED(), TDM_ERROR_OPERATION_FAILED, NULL);
332 TDM_RETURN_VAL_IF_FAIL_WITH_ERROR(dpy, TDM_ERROR_INVALID_PARAMETER, NULL);
333 TDM_RETURN_VAL_IF_FAIL_WITH_ERROR(fd >= 0, TDM_ERROR_INVALID_PARAMETER, NULL);
334 TDM_RETURN_VAL_IF_FAIL_WITH_ERROR(func, TDM_ERROR_INVALID_PARAMETER, NULL);
336 private_display = (tdm_private_display*)dpy;
337 private_loop = private_display->private_loop;
338 TDM_RETURN_VAL_IF_FAIL_WITH_ERROR(private_loop, TDM_ERROR_INVALID_PARAMETER, NULL);
339 TDM_RETURN_VAL_IF_FAIL_WITH_ERROR(private_loop->wl_loop, TDM_ERROR_INVALID_PARAMETER, NULL);
341 fd_source = calloc(1, sizeof(tdm_event_loop_source_fd));
342 TDM_RETURN_VAL_IF_FAIL_WITH_ERROR(fd_source, TDM_ERROR_OUT_OF_MEMORY, NULL);
344 if (mask & TDM_EVENT_LOOP_READABLE)
345 wl_mask |= WL_EVENT_READABLE;
346 if (mask & TDM_EVENT_LOOP_WRITABLE)
347 wl_mask |= WL_EVENT_WRITABLE;
349 fd_source->func = func;
350 fd_source->user_data = user_data;
352 fd_source->base.private_display = private_display;
353 fd_source->base.wl_source =
354 wl_event_loop_add_fd(private_loop->wl_loop,
355 fd, wl_mask, _tdm_event_loop_fd_func, fd_source);
356 if (!fd_source->base.wl_source) {
358 *error = TDM_ERROR_OUT_OF_MEMORY;
363 LIST_ADDTAIL(&fd_source->base.link, &private_loop->source_list);
366 *error = TDM_ERROR_NONE;
368 return (tdm_event_loop_source *)fd_source;
372 tdm_event_loop_source_fd_update(tdm_event_loop_source *source, tdm_event_loop_mask mask)
374 tdm_event_loop_source_fd *fd_source = source;
375 uint32_t wl_mask = 0;
377 TDM_RETURN_VAL_IF_FAIL(TDM_MUTEX_IS_LOCKED(), TDM_ERROR_OPERATION_FAILED);
378 TDM_RETURN_VAL_IF_FAIL(fd_source, TDM_ERROR_INVALID_PARAMETER);
380 if (mask & TDM_EVENT_LOOP_READABLE)
381 wl_mask |= WL_EVENT_READABLE;
382 if (mask & TDM_EVENT_LOOP_WRITABLE)
383 wl_mask |= WL_EVENT_WRITABLE;
385 if (wl_event_source_fd_update(fd_source->base.wl_source, wl_mask) < 0) {
386 TDM_ERR("source update failed: %m");
387 return TDM_ERROR_OPERATION_FAILED;
390 return TDM_ERROR_NONE;
394 _tdm_event_loop_timer_func(void *data)
396 tdm_event_loop_source_timer *timer_source = (tdm_event_loop_source_timer*)data;
397 tdm_private_display *private_display;
399 /* DON'T check TDM_MUTEX_IS_LOCKED here */
401 TDM_RETURN_VAL_IF_FAIL(timer_source, 1);
402 TDM_RETURN_VAL_IF_FAIL(timer_source->func, 1);
404 private_display = timer_source->base.private_display;
406 /* TDM event_loop function is actually for TDM backend module. When we call the
407 * backend's functions, we have to lock the mutex. TDM backend shouldn't consider
410 _pthread_mutex_lock(&private_display->lock);
411 timer_source->func(timer_source->user_data);
412 _pthread_mutex_unlock(&private_display->lock);
417 EXTERN tdm_event_loop_source *
418 tdm_event_loop_add_timer_handler(tdm_display *dpy, tdm_event_loop_timer_handler func,
419 void *user_data, tdm_error *error)
421 tdm_private_display *private_display;
422 tdm_private_loop *private_loop;
423 tdm_event_loop_source_timer *timer_source;
426 TDM_RETURN_VAL_IF_FAIL_WITH_ERROR(TDM_MUTEX_IS_LOCKED(), TDM_ERROR_OPERATION_FAILED, NULL);
427 TDM_RETURN_VAL_IF_FAIL_WITH_ERROR(dpy, TDM_ERROR_INVALID_PARAMETER, NULL);
428 TDM_RETURN_VAL_IF_FAIL_WITH_ERROR(func, TDM_ERROR_INVALID_PARAMETER, NULL);
430 private_display = (tdm_private_display*)dpy;
431 private_loop = private_display->private_loop;
432 TDM_RETURN_VAL_IF_FAIL_WITH_ERROR(private_loop, TDM_ERROR_INVALID_PARAMETER, NULL);
433 TDM_RETURN_VAL_IF_FAIL_WITH_ERROR(private_loop->wl_loop, TDM_ERROR_INVALID_PARAMETER, NULL);
435 timer_source = calloc(1, sizeof(tdm_event_loop_source_timer));
436 TDM_RETURN_VAL_IF_FAIL_WITH_ERROR(timer_source, TDM_ERROR_OUT_OF_MEMORY, NULL);
438 timer_source->func = func;
439 timer_source->user_data = user_data;
441 timer_source->base.private_display = private_display;
442 timer_source->base.wl_source =
443 wl_event_loop_add_timer(private_loop->wl_loop,
444 _tdm_event_loop_timer_func, timer_source);
445 if (!timer_source->base.wl_source) {
447 *error = TDM_ERROR_OUT_OF_MEMORY;
452 LIST_ADDTAIL(&timer_source->base.link, &private_loop->source_list);
455 *error = TDM_ERROR_NONE;
457 return (tdm_event_loop_source *)timer_source;
461 tdm_event_loop_source_timer_update(tdm_event_loop_source *source, unsigned int ms_delay)
463 tdm_event_loop_source_timer *timer_source = source;
465 TDM_RETURN_VAL_IF_FAIL(TDM_MUTEX_IS_LOCKED(), TDM_ERROR_OPERATION_FAILED);
466 TDM_RETURN_VAL_IF_FAIL(timer_source, TDM_ERROR_INVALID_PARAMETER);
468 if (wl_event_source_timer_update(timer_source->base.wl_source, ms_delay) < 0) {
469 TDM_ERR("source update failed: %m");
470 return TDM_ERROR_OPERATION_FAILED;
473 return TDM_ERROR_NONE;
477 tdm_event_loop_source_remove(tdm_event_loop_source *source)
479 tdm_event_loop_source_base *base = (tdm_event_loop_source_base*)source;
481 TDM_RETURN_IF_FAIL(TDM_MUTEX_IS_LOCKED());
483 if (!base || !keep_private_loop)
486 LIST_DEL(&base->link);
488 wl_event_source_remove(base->wl_source);
493 /* LCOV_EXCL_START */
495 _trace_cb_client_destroy(struct wl_listener *listener, void *data)
497 struct wl_client *client = (struct wl_client *) data;
501 const char *proc_name;
502 char temp[512] = { 0, }, *p = temp;
503 int len = sizeof(temp), *l = &len;
505 wl_client_get_credentials(client, &pid, NULL, NULL);
506 proc_name = tdm_server_get_client_name(pid);
508 clock_gettime(CLOCK_MONOTONIC, &tp);
509 time = (tp.tv_sec * 1000000L) + (tp.tv_nsec / 1000);
511 TDM_SNPRINTF(p, l, "[%10.3f] Server [PID:%d] client destroying", time / 1000.0, pid);
512 TDM_SNPRINTF(p, l, ", cmd: %s", proc_name ? proc_name : "Unknown");
514 TDM_INFO("%s", temp);
516 wl_list_remove(&listener->link);
521 _trace_reg_client_destroy_listener(struct wl_client *client)
523 struct wl_listener *listener;
525 listener = wl_client_get_destroy_listener(client, _trace_cb_client_destroy);
529 listener = calloc(1, sizeof(struct wl_listener));
530 TDM_RETURN_IF_FAIL(listener != NULL);
532 listener->notify = _trace_cb_client_destroy;
533 wl_client_add_destroy_listener(client, listener);
537 _trace_get_next_argument(const char *signature,
538 struct argument_details *details)
540 details->nullable = 0;
541 for (; *signature; ++signature) {
542 switch (*signature) {
551 details->type = *signature;
552 return signature + 1;
554 details->nullable = 1;
560 details->type = '\0';
564 static struct wl_protocol_logger *_trace_protocol_logger;
567 _trace_protocol_logger_cb(void *user_data,
568 enum wl_protocol_logger_type direction,
569 const struct wl_protocol_logger_message *message)
572 struct argument_details arg;
573 struct wl_client *client = wl_resource_get_client(message->resource);
574 const char *signature = message->message->signature;
578 const char *proc_name;
579 char temp[512] = { 0, }, *p = temp;
580 int len = sizeof(temp), *l = &len;
584 _trace_reg_client_destroy_listener(client);
585 wl_client_get_credentials(client, &pid, NULL, NULL);
588 proc_name = tdm_server_get_client_name(pid);
590 clock_gettime(CLOCK_MONOTONIC, &tp);
591 time = (tp.tv_sec * 1000000L) + (tp.tv_nsec / 1000);
593 send = (direction == WL_PROTOCOL_LOGGER_EVENT) ? 1 : 0;
595 TDM_SNPRINTF(p, l, "[%10.3f] %s%d%s%s@%u.%s(",
597 send ? "Server -> Client [PID:" : "Server <- Client [PID:",
599 wl_resource_get_class(message->resource),
600 wl_resource_get_id(message->resource),
601 message->message->name);
603 for (i = 0; i < message->arguments_count; i++) {
604 signature = _trace_get_next_argument(signature, &arg);
605 TDM_RETURN_IF_FAIL(signature != NULL);
608 TDM_SNPRINTF(p, l, ", ");
612 TDM_SNPRINTF(p, l, "%u", message->arguments[i].u);
615 TDM_SNPRINTF(p, l, "%d", message->arguments[i].i);
618 TDM_SNPRINTF(p, l, "%f",
619 wl_fixed_to_double(message->arguments[i].f));
622 TDM_SNPRINTF(p, l, "\"%s\"", message->arguments[i].s);
625 if (message->arguments[i].o)
626 TDM_SNPRINTF(p, l, "%s@%u",
627 wl_resource_get_class((struct wl_resource *) message->arguments[i].o),
628 wl_resource_get_id((struct wl_resource *) message->arguments[i].o));
630 TDM_SNPRINTF(p, l, "nil");
633 TDM_SNPRINTF(p, l, "new id %s@",
634 (message->message->types[i]) ? message->message->types[i]->name : "[unknown]");
635 if (message->arguments[i].n != 0)
636 TDM_SNPRINTF(p, l, "%u", message->arguments[i].n);
638 TDM_SNPRINTF(p, l, "nil");
641 TDM_SNPRINTF(p, l, "array");
644 TDM_SNPRINTF(p, l, "fd %d", message->arguments[i].h);
651 TDM_SNPRINTF(p, l, "), cmd: %s", proc_name ? proc_name : "Unknown");
653 TDM_INFO("%s", temp);
657 tdm_event_loop_trace_enable(tdm_private_display * private_display,
660 tdm_private_loop *private_loop = private_display->private_loop;
662 TDM_RETURN_VAL_IF_FAIL(private_loop->wl_display != NULL, TDM_ERROR_NONE);
665 if (_trace_protocol_logger) {
666 wl_protocol_logger_destroy(_trace_protocol_logger);
667 _trace_protocol_logger = NULL;
669 return TDM_ERROR_NONE;
672 if (_trace_protocol_logger)
673 wl_protocol_logger_destroy(_trace_protocol_logger);
675 _trace_protocol_logger =
676 wl_display_add_protocol_logger(private_loop->wl_display, _trace_protocol_logger_cb, NULL);
678 return TDM_ERROR_NONE;