support the commit-per-vblank
[platform/core/uifw/libtdm.git] / src / tdm_private.h
1 /**************************************************************************
2  *
3  * libtdm
4  *
5  * Copyright 2015 Samsung Electronics co., Ltd. All Rights Reserved.
6  *
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 <sc1.lim@samsung.com>
13  *
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:
21  *
22  * The above copyright notice and this permission notice (including the
23  * next paragraph) shall be included in all copies or substantial portions
24  * of the Software.
25  *
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.
33  *
34 **************************************************************************/
35
36 #ifndef _TDM_PRIVATE_H_
37 #define _TDM_PRIVATE_H_
38
39 #include <stdio.h>
40 #include <string.h>
41 #include <strings.h>
42 #include <stdlib.h>
43 #include <pthread.h>
44 #include <errno.h>
45 #include <unistd.h>
46 #include <limits.h>
47 #include <sys/types.h>
48 #include <sys/stat.h>
49 #include <fcntl.h>
50 #include <dlfcn.h>
51 #include <dirent.h>
52 #include <poll.h>
53 #include <sys/syscall.h>
54 #include <sys/types.h>
55 #include <math.h>
56
57 #include <tbm_bufmgr.h>
58 #include <tbm_surface_queue.h>
59
60 #include "tdm_backend.h"
61 #include "tdm_log.h"
62 #include "tdm_list.h"
63 #include "tdm_macro.h"
64
65 #ifdef __cplusplus
66 extern "C" {
67 #endif
68
69 //#define INIT_BUFMGR
70
71 /**
72  * @file tdm_private.h
73  * @brief The private header file for a frontend library
74  */
75
76 enum {
77         TDM_DEBUG_NONE,
78         TDM_DEBUG_BUFFER    = (1 << 0),
79         TDM_DEBUG_MUTEX     = (1 << 1),
80         TDM_DEBUG_THREAD    = (1 << 2),
81         TDM_DEBUG_SERVER    = (1 << 3),
82         TDM_DEBUG_VBLANK    = (1 << 4),
83         TDM_DEBUG_COMMIT    = (1 << 5),
84 };
85
86 extern int tdm_debug_module;
87 extern int tdm_debug_dump;
88
89 #ifdef HAVE_TTRACE
90 #include <ttrace.h>
91 #define TDM_TRACE_BEGIN(NAME) traceBegin(TTRACE_TAG_GRAPHICS, "TDM:"#NAME)
92 #define TDM_TRACE_END() traceEnd(TTRACE_TAG_GRAPHICS)
93 #define TDM_TRACE_COUNT(NAME, COUNT) traceCounter(TTRACE_TAG_GRAPHICS, COUNT, "TDM:"#NAME)
94 #define TDM_TRACE_MARK(NAME) traceMark(TTRACE_TAG_GRAPHICS, "TDM:"#NAME)
95 #else
96 #define TDM_TRACE_BEGIN(NAME)
97 #define TDM_TRACE_END()
98 #define TDM_TRACE_COUNT(NAME, COUNT)
99 #define TDM_TRACE_MARK(NAME)
100 #endif
101
102 typedef enum {
103         TDM_CAPTURE_TARGET_OUTPUT,
104         TDM_CAPTURE_TARGET_LAYER,
105 } tdm_capture_target;
106
107 enum {
108         TDM_DUMP_FLAG_LAYER   = (1 << 0),
109         TDM_DUMP_FLAG_PP      = (1 << 1),
110         TDM_DUMP_FLAG_CAPTURE = (1 << 2),
111 };
112
113 #define TDM_DUMP_DIR    "/tmp"
114
115 typedef enum {
116         TDM_COMMIT_TYPE_NONE,
117         TDM_COMMIT_TYPE_OUTPUT,
118         TDM_COMMIT_TYPE_LAYER,
119 } tdm_commit_type;
120
121 typedef struct _tdm_private_display tdm_private_display;
122 typedef struct _tdm_private_output tdm_private_output;
123 typedef struct _tdm_private_layer tdm_private_layer;
124 typedef struct _tdm_private_pp tdm_private_pp;
125 typedef struct _tdm_private_capture tdm_private_capture;
126 typedef struct _tdm_private_loop tdm_private_loop;
127 typedef struct _tdm_private_server tdm_private_server;
128 typedef struct _tdm_private_thread tdm_private_thread;
129 typedef struct _tdm_private_vblank_handler tdm_private_vblank_handler;
130 typedef struct _tdm_private_output_commit_handler tdm_private_output_commit_handler;
131 typedef struct _tdm_private_layer_commit_handler tdm_private_layer_commit_handler;
132 typedef struct _tdm_private_change_handler tdm_private_change_handler;
133
134 struct _tdm_private_display {
135         pthread_mutex_t lock;
136         unsigned int init_count;
137
138         /* backend module info */
139         void *module;
140         tdm_backend_module *module_data;
141         tdm_backend_data *bdata;
142
143 #ifdef INIT_BUFMGR
144         tbm_bufmgr bufmgr;
145 #endif
146
147         /* backend function */
148         tdm_display_capability capabilities;
149         tdm_func_display func_display;
150         tdm_func_output func_output;
151         tdm_func_layer func_layer;
152         tdm_func_pp func_pp;
153         tdm_func_capture func_capture;
154
155         /* backend capability */
156         tdm_caps_display caps_display;
157         tdm_caps_pp caps_pp;
158         tdm_caps_capture caps_capture;
159
160         /* output, pp list */
161         struct list_head output_list;
162         struct list_head pp_list;
163         struct list_head capture_list;
164
165         void **outputs_ptr;
166
167         /* for event handling */
168         tdm_private_loop *private_loop;
169
170         /* output order */
171         tdm_output **outputs;
172
173         /* calling a output commit per a vblank */
174         int commit_per_vblank;
175         tdm_commit_type commit_type;
176
177         int print_fps;
178 };
179
180 struct _tdm_private_output {
181         struct list_head link;
182
183         int index;
184         double stamp;
185
186         tdm_private_display *private_display;
187
188         tdm_caps_output caps;
189         tdm_output *output_backend;
190
191         unsigned int pipe;
192         tdm_output_dpms current_dpms_value;
193         const tdm_output_mode *current_mode;
194
195         int regist_vblank_cb;
196         int regist_commit_cb;
197         int regist_change_cb;
198         int regist_dpms_cb;
199
200         struct list_head layer_list;
201         struct list_head capture_list;
202         struct list_head vblank_handler_list;
203         struct list_head output_commit_handler_list;
204
205         /* for layer commit */
206         struct list_head layer_commit_handler_list;
207         struct list_head pending_commit_handler_list;
208         tdm_vblank *vblank;
209         int waiting_vblank;
210
211         /* seperate list for multi-thread*/
212         struct list_head change_handler_list_main;
213         struct list_head change_handler_list_sub;
214
215         void **layers_ptr;
216
217         /* TODO: temp solution for handling DPMS things in sub-htread */
218         tdm_event_loop_source *dpms_changed_timer;
219 };
220
221 struct _tdm_private_layer {
222         struct list_head link;
223
224         int index;
225
226         tdm_private_display *private_display;
227         tdm_private_output *private_output;
228
229         tdm_caps_layer caps;
230         tdm_layer *layer_backend;
231
232         tbm_surface_h pending_buffer;
233         tbm_surface_h waiting_buffer;
234         tbm_surface_h showing_buffer;
235         tbm_surface_queue_h buffer_queue;
236
237         struct list_head capture_list;
238
239         unsigned int usable;
240         unsigned int committing;
241
242         double fps_stamp;
243         unsigned int fps_count;
244 };
245
246 struct _tdm_private_pp {
247         struct list_head link;
248
249         double stamp;
250
251         tdm_private_display *private_display;
252
253         tdm_pp *pp_backend;
254
255         struct list_head pending_buffer_list;
256         struct list_head buffer_list;
257
258         tdm_info_pp info;
259         pid_t owner_tid;
260
261         tdm_pp_done_handler done_func;
262         void *done_user_data;
263 };
264
265 struct _tdm_private_capture {
266         struct list_head link;
267         struct list_head display_link;
268
269         double stamp;
270
271         tdm_capture_target target;
272
273         tdm_private_display *private_display;
274         tdm_private_output *private_output;
275         tdm_private_layer *private_layer;
276
277         tdm_capture *capture_backend;
278
279         struct list_head pending_buffer_list;
280         struct list_head buffer_list;
281
282         tdm_info_capture info;
283         pid_t owner_tid;
284
285         tdm_capture_done_handler done_func;
286         void *done_user_data;
287 };
288
289 /* CAUTION:
290  * Note that we don't need to (un)lock mutex to use this structure. If there is
291  * no TDM thread, all TDM resources are protected by private_display's mutex.
292  * If there is a TDM thread, this struct will be used only in a TDM thread.
293  * So, we don't need to protect this structure by mutex. Not thread-safe.
294  */
295 struct _tdm_private_loop {
296         /* TDM uses wl_event_loop to handle various event sources including the TDM
297          * backend's fd.
298          */
299         struct wl_display *wl_display;
300         struct wl_event_loop *wl_loop;
301
302         int backend_fd;
303         tdm_event_loop_source *backend_source;
304
305         /* In event loop, all resources are accessed by this dpy.
306          * CAUTION:
307          * - DO NOT include other private structure in this structure because this
308          *   struct is not protected by mutex.
309          */
310         tdm_display *dpy;
311
312         /* for handling TDM client requests */
313         tdm_private_server *private_server;
314
315         /* To have a TDM event thread. If TDM_THREAD enviroment variable is not set
316          * private_thread is NULL.
317          */
318         tdm_private_thread *private_thread;
319 };
320
321 struct _tdm_private_vblank_handler {
322         struct list_head link;
323
324         tdm_private_output *private_output;
325         int interval;
326         int sync;
327         tdm_output_vblank_handler func;
328         void *user_data;
329
330         pid_t owner_tid;
331 };
332
333 struct _tdm_private_output_commit_handler {
334         struct list_head link;
335
336         tdm_private_output *private_output;
337         tdm_output_commit_handler func;
338         void *user_data;
339
340         pid_t owner_tid;
341 };
342
343 struct _tdm_private_layer_commit_handler {
344         struct list_head link;
345
346         tdm_private_layer *private_layer;
347         tdm_layer_commit_handler func;
348         void *user_data;
349 };
350
351 struct _tdm_private_change_handler {
352         struct list_head link;
353
354         tdm_private_output *private_output;
355         tdm_output_change_handler func;
356         void *user_data;
357
358         pid_t owner_tid;
359 };
360
361 typedef struct _tdm_buffer_info {
362         tbm_surface_h buffer;
363
364         /* ref_count for backend */
365         int backend_ref_count;
366
367         struct list_head release_funcs;
368         struct list_head destroy_funcs;
369
370         struct list_head *list;
371         struct list_head link;
372 } tdm_buffer_info;
373
374 typedef struct _tdm_pp_private_buffer {
375         tbm_surface_h src;
376         tbm_surface_h dst;
377         struct list_head link;
378         struct list_head commit_link;
379 } tdm_pp_private_buffer;
380
381 typedef struct _tdm_capture_private_buffer {
382         tbm_surface_h buffer;
383         struct list_head link;
384         struct list_head commit_link;
385 } tdm_capture_private_buffer;
386
387 int
388 tdm_display_check_module_abi(tdm_private_display *private_display, int abimaj, int abimin);
389
390 tdm_private_output *
391 tdm_display_find_output_stamp(tdm_private_display *private_display, double stamp);
392 tdm_private_pp *
393 tdm_pp_find_stamp(tdm_private_display *private_display, double stamp);
394 tdm_private_capture *
395 tdm_capture_find_stamp(tdm_private_display *private_display, double stamp);
396
397 void
398 tdm_output_cb_vblank(tdm_output *output_backend, unsigned int sequence,
399                                          unsigned int tv_sec, unsigned int tv_usec, void *user_data);
400 void
401 tdm_output_cb_commit(tdm_output *output_backend, unsigned int sequence,
402                                          unsigned int tv_sec, unsigned int tv_usec, void *user_data);
403 void
404 tdm_output_cb_status(tdm_output *output_backend, tdm_output_conn_status status,
405                                          void *user_data);
406 void
407 tdm_output_cb_dpms(tdm_output *output_backend, tdm_output_dpms dpms,
408                                    void *user_data);
409 void
410 tdm_pp_cb_done(tdm_pp *pp_backend, tbm_surface_h src, tbm_surface_h dst,
411                            void *user_data);
412 void
413 tdm_capture_cb_done(tdm_capture *capture_backend, tbm_surface_h buffer,
414                                         void *user_data);
415 tdm_error
416 tdm_vblank_cb_vblank_SW(tdm_vblank *vblank, double vblank_stamp);
417
418 void
419 tdm_output_call_change_handler_internal(tdm_private_output *private_output,
420                                                                                 struct list_head *change_handler_list,
421                                                                                 tdm_output_change_type type,
422                                                                                 tdm_value value,
423                                                                                 int no_check_thread_id);
424
425 tdm_private_pp *
426 tdm_pp_create_internal(tdm_private_display *private_display, tdm_error *error);
427 void
428 tdm_pp_destroy_internal(tdm_private_pp *private_pp);
429
430 tdm_private_capture *
431 tdm_capture_create_output_internal(tdm_private_output *private_output,
432                                                                    tdm_error *error);
433 tdm_private_capture *
434 tdm_capture_create_layer_internal(tdm_private_layer *private_layer,
435                                                                   tdm_error *error);
436 void
437 tdm_capture_destroy_internal(tdm_private_capture *private_capture);
438
439 /* utility buffer functions for private */
440 tdm_buffer_info*
441 tdm_buffer_get_info(tbm_surface_h buffer);
442 tbm_surface_h
443 tdm_buffer_list_get_first_entry(struct list_head *list);
444 void
445 tdm_buffer_list_dump(struct list_head *list);
446
447 void
448 tdm_buffer_remove_release_handler_internal(tbm_surface_h buffer);
449
450 /* event functions for private */
451 tdm_error
452 tdm_event_loop_init(tdm_private_display *private_display);
453 void
454 tdm_event_loop_deinit(tdm_private_display *private_display);
455 void
456 tdm_event_loop_create_backend_source(tdm_private_display *private_display);
457 int
458 tdm_event_loop_get_fd(tdm_private_display *private_display);
459 tdm_error
460 tdm_event_loop_dispatch(tdm_private_display *private_display);
461 void
462 tdm_event_loop_flush(tdm_private_display *private_display);
463
464 typedef enum {
465         TDM_THREAD_CB_NONE,
466         TDM_THREAD_CB_OUTPUT_COMMIT,
467         TDM_THREAD_CB_OUTPUT_VBLANK,
468         TDM_THREAD_CB_OUTPUT_STATUS,
469         TDM_THREAD_CB_OUTPUT_DPMS,
470         TDM_THREAD_CB_PP_DONE,
471         TDM_THREAD_CB_CAPTURE_DONE,
472         TDM_THREAD_CB_VBLANK_SW,
473 } tdm_thread_cb_type;
474
475 typedef struct _tdm_thread_cb_base tdm_thread_cb_base;
476 typedef struct _tdm_thread_cb_output_vblank tdm_thread_cb_output_commit;
477 typedef struct _tdm_thread_cb_output_vblank tdm_thread_cb_output_vblank;
478 typedef struct _tdm_thread_cb_output_status tdm_thread_cb_output_status;
479 typedef struct _tdm_thread_cb_output_dpms tdm_thread_cb_output_dpms;
480 typedef struct _tdm_thread_cb_pp_done tdm_thread_cb_pp_done;
481 typedef struct _tdm_thread_cb_capture_done tdm_thread_cb_capture_done;
482 typedef struct _tdm_thread_cb_vblank_sw tdm_thread_cb_vblank_sw;
483
484 struct _tdm_thread_cb_base {
485         tdm_thread_cb_type type;
486         unsigned int length;
487 };
488
489 struct _tdm_thread_cb_output_vblank {
490         tdm_thread_cb_base base;
491         double output_stamp;
492         unsigned int sequence;
493         unsigned int tv_sec;
494         unsigned int tv_usec;
495         void *user_data;
496 };
497
498 struct _tdm_thread_cb_output_status {
499         tdm_thread_cb_base base;
500         double output_stamp;
501         tdm_output_conn_status status;
502         void *user_data;
503 };
504
505 struct _tdm_thread_cb_output_dpms {
506         tdm_thread_cb_base base;
507         double output_stamp;
508         tdm_output_dpms dpms;
509         void *user_data;
510 };
511
512 struct _tdm_thread_cb_pp_done {
513         tdm_thread_cb_base base;
514         double pp_stamp;
515         tbm_surface_h src;
516         tbm_surface_h dst;
517         void *user_data;
518 };
519
520 struct _tdm_thread_cb_capture_done {
521         tdm_thread_cb_base base;
522         double capture_stamp;
523         tbm_surface_h buffer;
524         void *user_data;
525 };
526
527 struct _tdm_thread_cb_vblank_sw {
528         tdm_thread_cb_base base;
529         double vblank_stamp;
530 };
531
532 tdm_error
533 tdm_thread_init(tdm_private_loop *private_loop);
534 void
535 tdm_thread_deinit(tdm_private_loop *private_loop);
536 int
537 tdm_thread_get_fd(tdm_private_loop *private_loop);
538 tdm_error
539 tdm_thread_send_cb(tdm_private_loop *private_loop, tdm_thread_cb_base *base);
540 tdm_error
541 tdm_thread_handle_cb(tdm_private_loop *private_loop);
542 int
543 tdm_thread_in_display_thread(pid_t tid);
544 int
545 tdm_thread_is_running(void);
546
547 tdm_error
548 tdm_server_init(tdm_private_loop *private_loop);
549 void
550 tdm_server_deinit(tdm_private_loop *private_loop);
551
552 char *
553 tdm_helper_dump_make_directory(const char *path, char *reply, int *len);
554 void
555 tdm_helper_dump_buffer_str(tbm_surface_h buffer, char *dir, char *str);
556 double
557 tdm_helper_get_time(void);
558
559 extern pthread_mutex_t tdm_mutex_check_lock;
560 extern int tdm_mutex_locked;
561 extern int tdm_dump_enable;
562 extern char *tdm_debug_dump_dir;
563
564 #define _pthread_mutex_unlock(l) \
565         do { \
566                 if (tdm_debug_module & TDM_DEBUG_MUTEX) \
567                         TDM_INFO("mutex unlock"); \
568                 pthread_mutex_lock(&tdm_mutex_check_lock); \
569                 tdm_mutex_locked = 0; \
570                 pthread_mutex_unlock(&tdm_mutex_check_lock); \
571                 pthread_mutex_unlock(l); \
572         } while (0)
573 #ifdef TDM_CONFIG_MUTEX_TIMEOUT
574 #define MUTEX_TIMEOUT_SEC 5
575 #define _pthread_mutex_lock(l) \
576         do { \
577                 if (tdm_debug_module & TDM_DEBUG_MUTEX) \
578                         TDM_INFO("mutex lock"); \
579                 struct timespec rtime; \
580                 clock_gettime(CLOCK_REALTIME, &rtime); \
581                 rtime.tv_sec += MUTEX_TIMEOUT_SEC; \
582                 if (pthread_mutex_timedlock(l, &rtime)) { \
583                         TDM_ERR("Mutex lock failed PID %d", getpid()); \
584                         _pthread_mutex_unlock(l); \
585                 } \
586                 else { \
587                         pthread_mutex_lock(&tdm_mutex_check_lock); \
588                         tdm_mutex_locked = 1; \
589                         pthread_mutex_unlock(&tdm_mutex_check_lock); \
590                 } \
591         } while (0)
592 #else //TDM_CONFIG_MUTEX_TIMEOUT
593 #define _pthread_mutex_lock(l) \
594         do { \
595                 if (tdm_debug_module & TDM_DEBUG_MUTEX) \
596                         TDM_INFO("mutex lock"); \
597                 pthread_mutex_lock(l); \
598                 pthread_mutex_lock(&tdm_mutex_check_lock); \
599                 tdm_mutex_locked = 1; \
600                 pthread_mutex_unlock(&tdm_mutex_check_lock); \
601         } while (0)
602 #endif //TDM_CONFIG_MUTEX_TIMEOUT
603 //#define TDM_MUTEX_IS_LOCKED() (tdm_mutex_locked == 1)
604 static inline int TDM_MUTEX_IS_LOCKED(void)
605 {
606         int ret;
607         /* if thread is not running, we don't need to consider mutex things. */
608         if (!tdm_thread_is_running())
609                 return 1;
610         pthread_mutex_lock(&tdm_mutex_check_lock);
611         ret = (tdm_mutex_locked == 1);
612         pthread_mutex_unlock(&tdm_mutex_check_lock);
613         return ret;
614 }
615
616 #define tdm_display_lock(dpy)   _pthread_mutex_lock(&((tdm_private_display *)dpy)->lock)
617 #define tdm_display_unlock(dpy)   _pthread_mutex_unlock(&((tdm_private_display *)dpy)->lock)
618
619 tdm_error
620 tdm_display_update_output(tdm_private_display *private_display,
621                                                   tdm_output *output_backend, int pipe);
622 tdm_error
623 tdm_display_enable_debug_module(const char*modules);
624 tdm_error
625 tdm_display_enable_dump(tdm_private_display *private_display, const char *dump_str, char *reply, int *len);
626 tdm_error
627 tdm_display_enable_path(const char *path);
628 tdm_error
629 tdm_display_enable_ttrace_vblank(tdm_display *dpy, tdm_output *output, int enable);
630 tdm_error
631 tdm_display_enable_commit_per_vblank(tdm_private_display *private_display, int enable);
632 tdm_error
633 tdm_display_enable_fps(tdm_private_display *private_display, int enable);
634
635 void
636 tdm_monitor_server_command(tdm_display *dpy, const char *options, char *reply, int *len);
637
638 #ifdef __cplusplus
639 }
640 #endif
641
642 #endif /* _TDM_PRIVATE_H_ */