change vblank sw hw changing condition
[platform/core/uifw/libtdm.git] / src / tdm_vblank.c
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 #ifdef HAVE_CONFIG_H
37 #include "config.h"
38 #endif
39
40 #include "tdm_private.h"
41
42 /* CAUTION:
43  * Basically tdm vblank doesn't care about thread things.
44  * However, to use tdm_event_loop_xxx functions, have to use the internal function.
45  * So need to lock/unlock the mutex of private_display. And valid_vblank_list and
46  * valid_wait_list should be protected by valid_list_lock because tdm_vblank can
47  * be used in multi-thread.
48  */
49
50 /* TDM vblank
51  * - aligned by HW vblank
52  * - use a tdm_event_loop_source object only.
53  */
54
55 #define TDM_VBLANK_DEFAULT_VREFRESH    30
56
57 /* We expact "(unsigned int)(0.0016667 / 0.0016667) = 1". But it becomes 0. */
58 #define TDM_TIME_MARGIN     0.0000001
59
60 #define TDM_VBLANK_UINT_MAX 4294967295U
61 #define TDM_VBLANK_UINT_1Q  1073741823U     /* UINT_MAX / 4 */
62 #define TDM_VBLANK_UINT_3Q  3221225471U     /* UINT_MAX / 4 * 3 */
63
64 /* (seq < TDM_VBLANK_UINT_1Q && TDM_VBLANK_UINT_3Q < last_seq) means
65  * that the sequence value has reached the max value and started from 0 again.
66  */
67 #define TDM_VBLANK_SEQ_REACHED_MAX(seq, last_seq) \
68         ((seq) < TDM_VBLANK_UINT_1Q && TDM_VBLANK_UINT_3Q < (last_seq))
69
70 #define VER(fmt, arg...)   TDM_ERR("[%p] "fmt, private_vblank, ##arg)
71 #define VWR(fmt, arg...)   TDM_WRN("[%p] "fmt, private_vblank, ##arg)
72 #define VIN(fmt, arg...)   do { if (tdm_debug_module & TDM_DEBUG_VBLANK) TDM_INFO("[%p] "fmt, private_vblank, ##arg); } while (0)
73 #define VDB(fmt, arg...)   do { if (tdm_debug_module & TDM_DEBUG_VBLANK) TDM_DBG("[%p] "fmt, private_vblank, ##arg); } while (0)
74
75 typedef enum {
76         VBLANK_TYPE_SW,
77         VBLANK_TYPE_SW_FAKE,
78         VBLANK_TYPE_HW,
79         VBLANK_TYPE_HW_SW,
80 } tdm_vblank_wait_type;
81
82 typedef enum {
83         VBLANK_EVENT_TYPE_NONE,
84         VBLANK_EVENT_TYPE_SW,
85         VBLANK_EVENT_TYPE_HW,
86 } tdm_vblank_event_type;
87
88 typedef struct _tdm_vblank_wait_info tdm_vblank_wait_info;
89
90 typedef struct _tdm_private_vblank {
91         struct list_head valid_link;
92
93         double stamp;
94         pid_t owner_tid;
95
96         tdm_display *dpy;
97         tdm_output *output;
98         tdm_output_conn_status connection;
99         unsigned int vrefresh;
100
101         tdm_vblank_event_type last_type;
102         unsigned int check_HW_or_SW;
103         char name[TDM_NAME_LEN];
104         unsigned int fps;
105         unsigned int fps_changeable;
106         unsigned int fps_fixed;
107         int offset;
108         unsigned int enable_fake;
109         unsigned int ignore_global_fps;
110         unsigned int in_create_handler;
111
112         double vblank_gap;
113         unsigned int quotient;
114
115         int last_interval;
116         unsigned int last_seq;
117         double last_time;
118
119         unsigned int add_front;
120         struct wl_resource *resource;
121
122         /* for HW */
123         double HW_vblank_gap;
124         struct list_head HW_wait_list;
125
126         /* for SW */
127         tdm_event_loop_source *SW_timer;
128         struct list_head SW_wait_list;
129
130         /* for timeout */
131         tdm_event_loop_source *timeout_timer;
132 } tdm_private_vblank;
133
134 struct _tdm_vblank_wait_info {
135         struct list_head link;
136         struct list_head valid_link;
137
138         double stamp;
139
140         double req_time;
141         unsigned int interval;
142         int hw_interval;
143
144         tdm_vblank_handler func;
145         void *user_data;
146         tdm_private_vblank *private_vblank;
147
148         tdm_vblank_wait_type type;
149
150         double target_time;
151         unsigned int target_seq;
152 };
153
154 typedef struct _tdm_vblank_create_handler_info {
155         struct list_head link;
156
157         tdm_vblank_create_handler func;
158         void *user_data;
159 } tdm_vblank_create_handler_info;
160
161 /* valid_vblank_list and valid_wait_list should be protected by valid_list_lock because
162  * tdm_vblank can be used in multi-thread.
163  */
164 static pthread_mutex_t valid_list_lock;
165 static struct list_head valid_vblank_list;
166 static struct list_head valid_wait_list;
167 static struct list_head create_handler_list;
168 static unsigned int vblank_list_inited;
169 static unsigned int vblank_global_fps;
170 static double stamp = 0;
171
172 static tdm_error _tdm_vblank_cb_vblank_SW(void *user_data);
173 static tdm_error _tdm_vblank_wait_SW(tdm_vblank_wait_info *wait_info);
174 static void _tdm_vblank_cb_vblank_HW(tdm_output *output, unsigned int sequence,
175                                                                          unsigned int tv_sec, unsigned int tv_usec,
176                                                                          void *user_data);
177 static void _tdm_vblank_timeout_timer_update(tdm_private_vblank *private_vblank, int ms_delay);
178 static void _tdm_vblank_get_client_information(tdm_private_vblank *private_vblank,
179                                                                                            pid_t *pid, const char **name);
180
181 #if 0
182 static void
183 _print_list(struct list_head *list)
184 {
185         tdm_vblank_wait_info *w = NULL;
186
187         LIST_FOR_EACH_ENTRY(w, list, link) {
188                 printf(" %d", w->interval);
189         }
190         printf("\n");
191 }
192 #endif
193
194 static int
195 tdm_vblank_is_valid(tdm_vblank *vblank)
196 {
197         tdm_private_vblank *v = NULL;
198
199         if (vblank && vblank_list_inited) {
200                 pthread_mutex_lock(&valid_list_lock);
201                 LIST_FOR_EACH_ENTRY(v, &valid_vblank_list, valid_link) {
202                         if (v == (tdm_private_vblank *)vblank) {
203                                 pthread_mutex_unlock(&valid_list_lock);
204                                 return 1;
205                         }
206                 }
207                 pthread_mutex_unlock(&valid_list_lock);
208
209         }
210         return 0;
211 }
212
213 static void
214 _tdm_vblank_valid_list_add(struct list_head *valid_link, struct list_head *valid_list)
215 {
216         pthread_mutex_lock(&valid_list_lock);
217         LIST_ADDTAIL(valid_link, valid_list);
218         pthread_mutex_unlock(&valid_list_lock);
219 }
220
221 static void
222 _tdm_vblank_valid_list_del(struct list_head *valid_link)
223 {
224         pthread_mutex_lock(&valid_list_lock);
225         LIST_DEL(valid_link);
226         pthread_mutex_unlock(&valid_list_lock);
227 }
228
229 static inline tdm_private_vblank*
230 _tdm_vblank_find(double vblank_stamp)
231 {
232         tdm_private_vblank *v = NULL;
233
234         if (!vblank_stamp)
235                 return 0;
236
237         pthread_mutex_lock(&valid_list_lock);
238         LIST_FOR_EACH_ENTRY(v, &valid_vblank_list, valid_link) {
239                 if (v->stamp == vblank_stamp) {
240                         pthread_mutex_unlock(&valid_list_lock);
241                         return v;
242                 }
243         }
244         pthread_mutex_unlock(&valid_list_lock);
245
246         return 0;
247 }
248
249 static inline unsigned int
250 _tdm_vblank_check_valid_wait(tdm_vblank_wait_info *wait_info)
251 {
252         tdm_vblank_wait_info *w = NULL;
253
254         if (!wait_info)
255                 return 0;
256
257         pthread_mutex_lock(&valid_list_lock);
258         LIST_FOR_EACH_ENTRY(w, &valid_wait_list, valid_link) {
259                 if (w == wait_info) {
260                         pthread_mutex_unlock(&valid_list_lock);
261                         return 1;
262                 }
263         }
264         pthread_mutex_unlock(&valid_list_lock);
265
266         return 0;
267 }
268
269 static inline unsigned int
270 _tdm_vblank_find_wait(tdm_vblank_wait_info *wait_info, struct list_head *list)
271 {
272         tdm_vblank_wait_info *w = NULL;
273
274         if (!wait_info)
275                 return 0;
276
277         LIST_FOR_EACH_ENTRY(w, list, link) {
278                 if (w->stamp == wait_info->stamp)
279                         return 1;
280         }
281
282         return 0;
283 }
284
285 static inline void
286 _tdm_vblank_insert_wait(tdm_vblank_wait_info *wait_info, struct list_head *list)
287 {
288         tdm_vblank_wait_info *w = NULL;
289         tdm_vblank_wait_info *found = NULL;
290
291         if (LIST_IS_EMPTY(list)) {
292                 LIST_ADDTAIL(&wait_info->link, list);
293                 return;
294         }
295
296         LIST_FOR_EACH_ENTRY(w, list, link) {
297                 if (wait_info->type == VBLANK_TYPE_SW) {
298                         if (wait_info->target_time == 0)
299                                 TDM_NEVER_GET_HERE();
300                         if (w->target_time <= wait_info->target_time) {
301                                 found = w;
302                                 continue;
303                         }
304                 } else {
305                         if (w->interval <= wait_info->interval) {
306                                 found = w;
307                                 continue;
308                         }
309                 }
310         }
311
312         if (found)
313                 LIST_ADD(&wait_info->link, &found->link);
314         else
315                 LIST_ADDTAIL(&wait_info->link, list->next);
316 }
317
318 static void
319 _tdm_vblank_change_to_SW(tdm_private_vblank *private_vblank)
320 {
321         tdm_vblank_wait_info *w = NULL, *ww = NULL;
322
323         LIST_FOR_EACH_ENTRY_SAFE(w, ww, &private_vblank->HW_wait_list, link) {
324                 LIST_DEL(&w->link);
325
326                 tdm_display_lock(private_vblank->dpy);
327                 tdm_output_remove_vblank_handler_internal(private_vblank->output, _tdm_vblank_cb_vblank_HW, w);
328                 tdm_display_unlock(private_vblank->dpy);
329
330                 w->type = VBLANK_TYPE_SW_FAKE;
331                 _tdm_vblank_wait_SW(w);
332         }
333 }
334
335 static void
336 _tdm_vblank_free_HW_wait(tdm_private_vblank *private_vblank, tdm_error error, unsigned int call_cb)
337 {
338         tdm_vblank_wait_info *w = NULL, *ww = NULL;
339
340         if (!LIST_IS_EMPTY(&private_vblank->HW_wait_list)) {
341                 pid_t pid;
342                 const char *proc_name;
343                 _tdm_vblank_get_client_information(private_vblank, &pid, &proc_name);
344                 VER("TDM HW vblank destroyed forcely!! (pid: %u, name: %s)", pid, proc_name);
345         }
346
347         LIST_FOR_EACH_ENTRY_SAFE(w, ww, &private_vblank->HW_wait_list, link) {
348                 LIST_DEL(&w->link);
349                 _tdm_vblank_valid_list_del(&w->valid_link);
350
351                 tdm_display_lock(private_vblank->dpy);
352                 tdm_output_remove_vblank_handler_internal(private_vblank->output, _tdm_vblank_cb_vblank_HW, w);
353                 tdm_display_unlock(private_vblank->dpy);
354
355                 VDB("wait(%p) last(%.6f) sequence(%u) done (error:%d, call_cb:%u)",
356                         w, 0, w->target_seq, error, call_cb);
357
358                 if (call_cb && w->func)
359                         w->func(private_vblank, error, 0, 0, 0, w->user_data);
360
361                 free(w);
362         }
363 }
364
365 static void
366 _tdm_vblank_update_output_info(tdm_private_vblank *private_vblank)
367 {
368         tdm_output *output = private_vblank->output;
369         tdm_output_conn_status connection = TDM_OUTPUT_CONN_STATUS_DISCONNECTED;
370         unsigned int vrefresh = TDM_VBLANK_DEFAULT_VREFRESH;
371         tdm_error ret;
372
373         ret = tdm_output_get_conn_status(output, &connection);
374         TDM_WARNING_IF_FAIL(ret == TDM_ERROR_NONE);
375
376         if (connection == TDM_OUTPUT_CONN_STATUS_MODE_SETTED) {
377                 const tdm_output_mode *mode = NULL;
378                 tdm_output_get_mode(output, &mode);
379                 if (mode)
380                         vrefresh = mode->vrefresh;
381                 else
382                         VWR("mode not setted!!!");
383         }
384
385         private_vblank->connection = connection;
386         private_vblank->vrefresh = vrefresh;
387         private_vblank->HW_vblank_gap = 1.0 / private_vblank->vrefresh;
388
389         if (private_vblank->fps_changeable)
390                 private_vblank->fps = vrefresh;
391
392         VIN("connection(%d) vrefresh(%d) fps(%d) fps_changeable(%d)",
393                 private_vblank->connection,
394                 private_vblank->vrefresh, private_vblank->fps, private_vblank->fps_changeable);
395 }
396
397 /* LCOV_EXCL_START */
398 static void
399 _tdm_vblank_cb_output_change(tdm_output *output, tdm_output_change_type type,
400                                                          tdm_value value, void *user_data)
401 {
402         tdm_private_vblank *private_vblank = user_data;
403
404         TDM_RETURN_IF_FAIL(tdm_vblank_is_valid(private_vblank));
405
406         switch (type) {
407         case TDM_OUTPUT_CHANGE_DPMS:
408                 VIN("dpms %s", tdm_dpms_str(value.u32));
409                 private_vblank->check_HW_or_SW = 1;
410                 if (TDM_OUTPUT_DPMS_VSYNC_IS_OFF(value.u32)) {
411                         if (private_vblank->enable_fake)
412                                 _tdm_vblank_change_to_SW(private_vblank);
413                         else {
414                                 tdm_display_lock(private_vblank->dpy);
415                                 _tdm_vblank_timeout_timer_update(private_vblank, 0);
416                                 tdm_display_unlock(private_vblank->dpy);
417
418                                 _tdm_vblank_free_HW_wait(private_vblank, TDM_ERROR_DPMS_OFF, 1);
419                         }
420                 }
421                 break;
422         case TDM_OUTPUT_CHANGE_CONNECTION:
423                 if (private_vblank->connection == value.u32)
424                         break;
425                 VIN("output %s", tdm_status_str(value.u32));
426                 _tdm_vblank_update_output_info(private_vblank);
427                 private_vblank->check_HW_or_SW = 1;
428                 if (private_vblank->connection == TDM_OUTPUT_CONN_STATUS_DISCONNECTED) {
429                         if (private_vblank->enable_fake)
430                                 _tdm_vblank_change_to_SW(private_vblank);
431                         else {
432                                 tdm_display_lock(private_vblank->dpy);
433                                 _tdm_vblank_timeout_timer_update(private_vblank, 0);
434                                 tdm_display_unlock(private_vblank->dpy);
435
436                                 _tdm_vblank_free_HW_wait(private_vblank, TDM_ERROR_OUTPUT_DISCONNECTED, 1);
437                         }
438                 }
439                 break;
440         default:
441                 break;
442         }
443 }
444 /* LCOV_EXCL_STOP */
445
446 EXTERN tdm_error
447 tdm_vblank_set_client_vblank_fps(unsigned int pid, const char *name, unsigned int fps)
448 {
449         tdm_private_vblank *v = NULL;
450
451         TDM_RETURN_VAL_IF_FAIL(pid > 0, TDM_ERROR_INVALID_PARAMETER);
452         TDM_RETURN_VAL_IF_FAIL(fps > 0, TDM_ERROR_INVALID_PARAMETER);
453
454         TDM_INFO("pid: %u, name: %s, fps: %d", pid, name, fps);
455
456         pthread_mutex_lock(&valid_list_lock);
457         LIST_FOR_EACH_ENTRY(v, &valid_vblank_list, valid_link) {
458                 struct wl_client *client;
459                 pid_t client_pid = 0;
460
461                 if (!v->resource)
462                         continue;
463
464                 client = wl_resource_get_client(v->resource);
465                 if (!client)
466                         continue;
467
468                 wl_client_get_credentials(client, &client_pid, NULL, NULL);
469
470                 if (client_pid != pid)
471                         continue;
472
473                 if (name && strncmp(name, TDM_VBLANK_DEFAULT_NAME, TDM_NAME_LEN)) {
474                         if (strncmp(v->name, name, TDM_NAME_LEN))
475                                 continue;
476                 }
477
478                 tdm_vblank_set_fps(v, fps);
479
480                 TDM_INFO("(pid:%u) '%s' fps changed: %d", pid, v->name, fps);
481         }
482         pthread_mutex_unlock(&valid_list_lock);
483
484         return TDM_ERROR_NONE;
485 }
486
487 EXTERN tdm_error
488 tdm_vblank_set_client_ignore_global_fps(unsigned int pid, const char *name, unsigned int ignore)
489 {
490         tdm_private_vblank *v = NULL;
491
492         TDM_RETURN_VAL_IF_FAIL(pid > 0, TDM_ERROR_INVALID_PARAMETER);
493
494         TDM_INFO("pid: %u, name: %s, ignore: %u", pid, name, ignore);
495
496         pthread_mutex_lock(&valid_list_lock);
497         LIST_FOR_EACH_ENTRY(v, &valid_vblank_list, valid_link) {
498                 struct wl_client *client;
499                 pid_t client_pid = 0;
500
501                 if (!v->resource)
502                         continue;
503
504                 client = wl_resource_get_client(v->resource);
505                 if (!client)
506                         continue;
507
508                 wl_client_get_credentials(client, &client_pid, NULL, NULL);
509
510                 if (client_pid != pid)
511                         continue;
512
513                 if (name && strncmp(name, TDM_VBLANK_DEFAULT_NAME, TDM_NAME_LEN)) {
514                         if (strncmp(v->name, name, TDM_NAME_LEN))
515                                 continue;
516                 }
517
518                 tdm_vblank_ignore_global_fps(v, ignore);
519
520                 TDM_INFO("(pid:%u) '%s' ignore changed: %u", pid, v->name, ignore);
521         }
522         pthread_mutex_unlock(&valid_list_lock);
523
524         return TDM_ERROR_NONE;
525 }
526
527 EXTERN tdm_error
528 tdm_vblank_enable_global_fps(unsigned int enable, unsigned int fps)
529 {
530         tdm_private_vblank *v = NULL;
531
532         if (enable)
533                 TDM_RETURN_VAL_IF_FAIL(fps > 0, TDM_ERROR_INVALID_PARAMETER);
534
535         TDM_INFO("global fps: %s fps(%d)", (enable) ? "enabled" : "disabled", fps);
536
537         pthread_mutex_lock(&valid_list_lock);
538
539         vblank_global_fps = (enable) ? fps : 0;
540
541         LIST_FOR_EACH_ENTRY(v, &valid_vblank_list, valid_link) {
542                 /* skip if vblank is created in server side */
543                 if (!v->resource)
544                         continue;
545
546                 v->check_HW_or_SW = 1;
547         }
548         pthread_mutex_unlock(&valid_list_lock);
549
550         return TDM_ERROR_NONE;
551 }
552
553 INTERN tdm_error
554 tdm_vblank_cb_vblank_create(tdm_vblank *vblank, double vblank_stamp)
555 {
556         tdm_private_vblank *private_vblank;
557         tdm_vblank_create_handler_info *ch_info = NULL, *hh = NULL;
558
559         TDM_RETURN_VAL_IF_FAIL(vblank || vblank_stamp > 0, TDM_ERROR_INVALID_PARAMETER);
560
561         if (vblank)
562                 private_vblank = vblank;
563         else {
564                 private_vblank = _tdm_vblank_find(vblank_stamp);
565                 if (!private_vblank) {
566                         TDM_DBG("can't find vblank(%.0f) from valid_list", vblank_stamp);
567                         return TDM_ERROR_NONE;
568                 }
569         }
570
571         if (!tdm_thread_in_display_thread(syscall(SYS_gettid))) {
572                 tdm_thread_cb_vblank_create vblank_create;
573                 tdm_private_display *private_display = private_vblank->dpy;
574                 tdm_error ret;
575
576                 vblank_create.base.type = TDM_THREAD_CB_VBLANK_CREATE;
577                 vblank_create.base.length = sizeof vblank_create;
578                 vblank_create.vblank_stamp = private_vblank->stamp;
579
580                 ret = tdm_thread_send_cb(private_display->private_loop, &vblank_create.base);
581                 TDM_WARNING_IF_FAIL(ret == TDM_ERROR_NONE);
582
583                 return TDM_ERROR_NONE;
584         }
585
586         LIST_FOR_EACH_ENTRY_SAFE(ch_info, hh, &create_handler_list, link) {
587                 private_vblank->in_create_handler = 1;
588                 ch_info->func(private_vblank, ch_info->user_data);
589                 private_vblank->in_create_handler = 0;
590         }
591
592         return TDM_ERROR_NONE;
593 }
594
595 EXTERN tdm_error
596 tdm_vblank_add_create_handler(tdm_display *dpy, tdm_vblank_create_handler func, void *user_data)
597 {
598         tdm_vblank_create_handler_info *ch_info;
599
600         TDM_RETURN_VAL_IF_FAIL(func != NULL, TDM_ERROR_INVALID_PARAMETER);
601
602         /* we don't allow adding a create handler in sub-thread because tdm_vblank_create()
603          * can be called in both threads and tdm_thread_send_cb supports only one-way
604          * communication now.
605          */
606         if (!tdm_thread_in_display_thread(syscall(SYS_gettid))) {
607                 TDM_ERR("add_create_handler should be called in main thread");
608                 return TDM_ERROR_BAD_REQUEST;
609         }
610
611         ch_info = calloc(1, sizeof *ch_info);
612         TDM_RETURN_VAL_IF_FAIL(ch_info != NULL, TDM_ERROR_OUT_OF_MEMORY);
613
614         ch_info->func = func;
615         ch_info->user_data = user_data;
616
617         LIST_ADDTAIL(&ch_info->link, &create_handler_list);
618
619         return TDM_ERROR_NONE;
620 }
621
622 EXTERN void
623 tdm_vblank_remove_create_handler(tdm_display *dpy, tdm_vblank_create_handler func, void *user_data)
624 {
625         tdm_vblank_create_handler_info *ch_info = NULL, *hh = NULL;
626
627         /* we don't allow adding a create handler in sub-thread because tdm_vblank_create()
628          * can be called in both threads and tdm_thread_send_cb supports only one-way
629          * communication now.
630          */
631         if (!tdm_thread_in_display_thread(syscall(SYS_gettid))) {
632                 TDM_ERR("remove_create_handler should be called in main thread");
633                 return;
634         }
635
636         LIST_FOR_EACH_ENTRY_SAFE(ch_info, hh, &create_handler_list, link) {
637                 if (ch_info->func != func && ch_info->user_data != user_data)
638                         continue;
639
640                 LIST_DEL(&ch_info->link);
641                 free(ch_info);
642                 return;
643         }
644 }
645
646 INTERN tdm_error
647 tdm_vblank_init(tdm_display *dpy)
648 {
649         if (vblank_list_inited)
650                 return TDM_ERROR_NONE;
651
652         if (pthread_mutex_init(&valid_list_lock, NULL)) {
653                 TDM_ERR("mutex init failed: %m");
654                 return TDM_ERROR_OUT_OF_MEMORY;
655         }
656
657         LIST_INITHEAD(&valid_vblank_list);
658         LIST_INITHEAD(&valid_wait_list);
659         LIST_INITHEAD(&create_handler_list);
660
661         vblank_list_inited = 1;
662
663         return TDM_ERROR_NONE;
664 }
665
666 INTERN void
667 tdm_vblank_deinit(tdm_display *dpy)
668 {
669         tdm_vblank_create_handler_info *ch_info = NULL, *hh = NULL;
670
671         if (!vblank_list_inited)
672                 return;
673
674         if (!LIST_IS_EMPTY(&valid_vblank_list))
675                 TDM_NEVER_GET_HERE();
676
677         if (!LIST_IS_EMPTY(&valid_wait_list))
678                 TDM_NEVER_GET_HERE();
679
680         LIST_FOR_EACH_ENTRY_SAFE(ch_info, hh, &create_handler_list, link) {
681                 LIST_DEL(&ch_info->link);
682                 free(ch_info);
683         }
684
685         pthread_mutex_destroy(&valid_list_lock);
686
687         vblank_list_inited = 0;
688 }
689
690 EXTERN tdm_vblank *
691 tdm_vblank_create(tdm_display *dpy, tdm_output *output, tdm_error *error)
692 {
693         tdm_private_vblank *private_vblank;
694         tdm_error ret;
695
696         TDM_RETURN_VAL_IF_FAIL_WITH_ERROR(tdm_display_is_valid(dpy), TDM_ERROR_INVALID_PARAMETER, NULL);
697         TDM_RETURN_VAL_IF_FAIL_WITH_ERROR(tdm_output_is_valid(output), TDM_ERROR_INVALID_PARAMETER, NULL);
698
699         if (error)
700                 *error = TDM_ERROR_NONE;
701
702         private_vblank = calloc(1, sizeof * private_vblank);
703         if (!private_vblank) {
704                 /* LCOV_EXCL_START */
705                 if (error)
706                         *error = TDM_ERROR_OUT_OF_MEMORY;
707                 TDM_ERR("alloc failed");
708                 return NULL;
709                 /* LCOV_EXCL_STOP */
710         }
711
712         tdm_output_add_change_handler(output, _tdm_vblank_cb_output_change, private_vblank);
713
714         private_vblank->stamp = ++stamp;
715         private_vblank->owner_tid = syscall(SYS_gettid);
716         private_vblank->dpy = dpy;
717         private_vblank->output = output;
718         private_vblank->check_HW_or_SW = 1;
719         private_vblank->fps_changeable = 1;
720         private_vblank->last_interval = -1;
721
722         _tdm_vblank_update_output_info(private_vblank);
723
724         strncpy(private_vblank->name, TDM_VBLANK_DEFAULT_NAME, TDM_NAME_LEN - 1);
725         private_vblank->name[TDM_NAME_LEN - 1] = '\0';
726
727         LIST_INITHEAD(&private_vblank->HW_wait_list);
728         LIST_INITHEAD(&private_vblank->SW_wait_list);
729
730         _tdm_vblank_valid_list_add(&private_vblank->valid_link, &valid_vblank_list);
731
732         VIN("created. vrefresh(%d) connection(%d)",
733                 private_vblank->vrefresh, private_vblank->connection);
734
735         tdm_display_lock(private_vblank->dpy);
736         tdm_vblank_cb_vblank_create(NULL, private_vblank->stamp);
737         tdm_display_unlock(private_vblank->dpy);
738
739         return (tdm_vblank *)private_vblank;
740 }
741
742 EXTERN void
743 tdm_vblank_destroy(tdm_vblank *vblank)
744 {
745         tdm_private_vblank *private_vblank = vblank;
746         tdm_vblank_wait_info *w = NULL, *ww = NULL;
747
748         TDM_RETURN_IF_FAIL(tdm_vblank_is_valid(vblank));
749
750         if (private_vblank->in_create_handler) {
751                 TDM_ERR("NOT allowed to be called in a create handler");
752                 return;
753         }
754
755         _tdm_vblank_valid_list_del(&private_vblank->valid_link);
756
757         if (private_vblank->SW_timer) {
758                 tdm_display_lock(private_vblank->dpy);
759                 tdm_event_loop_source_remove(private_vblank->SW_timer);
760                 tdm_display_unlock(private_vblank->dpy);
761         }
762
763         tdm_output_remove_change_handler(private_vblank->output,
764                                                                          _tdm_vblank_cb_output_change, private_vblank);
765
766         _tdm_vblank_free_HW_wait(private_vblank, 0, 0);
767
768         if (!LIST_IS_EMPTY(&private_vblank->SW_wait_list)) {
769                 pid_t pid;
770                 const char *proc_name;
771                 _tdm_vblank_get_client_information(private_vblank, &pid, &proc_name);
772                 VER("TDM SW vblank destroyed forcely!! (pid: %u, name: %s)", pid, proc_name);
773         }
774
775         LIST_FOR_EACH_ENTRY_SAFE(w, ww, &private_vblank->SW_wait_list, link) {
776                 LIST_DEL(&w->link);
777                 _tdm_vblank_valid_list_del(&w->valid_link);
778                 free(w);
779         }
780
781         if (private_vblank->timeout_timer) {
782                 tdm_display_lock(private_vblank->dpy);
783                 tdm_event_loop_source_remove(private_vblank->timeout_timer);
784                 tdm_display_unlock(private_vblank->dpy);
785         }
786
787         VIN("destroyed");
788
789         free(private_vblank);
790 }
791
792 EXTERN tdm_error
793 tdm_vblank_get_client_pid(tdm_vblank *vblank, pid_t *pid)
794 {
795         tdm_private_vblank *private_vblank = vblank;
796         struct wl_client *client;
797
798         TDM_RETURN_VAL_IF_FAIL(tdm_vblank_is_valid(vblank), TDM_ERROR_INVALID_PARAMETER);
799         TDM_RETURN_VAL_IF_FAIL(pid != NULL, TDM_ERROR_INVALID_PARAMETER);
800
801         if (!private_vblank->resource) {
802                 *pid = 0;
803                 return TDM_ERROR_NONE;
804         }
805
806         client = wl_resource_get_client(private_vblank->resource);
807         if (!client) {
808                 *pid = 0;
809                 return TDM_ERROR_NONE;
810         }
811
812         wl_client_get_credentials(client, pid, NULL, NULL);
813
814         return TDM_ERROR_NONE;
815 }
816
817 EXTERN tdm_error
818 tdm_vblank_set_name(tdm_vblank *vblank, const char *name)
819 {
820         tdm_private_vblank *private_vblank = vblank;
821
822         TDM_RETURN_VAL_IF_FAIL(tdm_vblank_is_valid(vblank), TDM_ERROR_INVALID_PARAMETER);
823
824         if (!name)
825                 name = TDM_VBLANK_DEFAULT_NAME;
826
827         strncpy(private_vblank->name, name, TDM_NAME_LEN - 1);
828         private_vblank->name[TDM_NAME_LEN - 1] = '\0';
829
830         VIN("name(%s)", name);
831
832         return TDM_ERROR_NONE;
833 }
834
835 EXTERN tdm_error
836 tdm_vblank_get_name(tdm_vblank *vblank, const char **name)
837 {
838         tdm_private_vblank *private_vblank = vblank;
839
840         TDM_RETURN_VAL_IF_FAIL(tdm_vblank_is_valid(vblank), TDM_ERROR_INVALID_PARAMETER);
841         TDM_RETURN_VAL_IF_FAIL(name != NULL, TDM_ERROR_INVALID_PARAMETER);
842
843         *name = (const char*)private_vblank->name;
844
845         return TDM_ERROR_NONE;
846 }
847
848 EXTERN tdm_error
849 tdm_vblank_set_fps(tdm_vblank *vblank, unsigned int fps)
850 {
851         tdm_private_vblank *private_vblank = vblank;
852
853         TDM_RETURN_VAL_IF_FAIL(tdm_vblank_is_valid(vblank), TDM_ERROR_INVALID_PARAMETER);
854         TDM_RETURN_VAL_IF_FAIL(fps > 0, TDM_ERROR_INVALID_PARAMETER);
855
856         if (private_vblank->fps_fixed) {
857                 VIN("fps(%d) can't be changed", private_vblank->fps);
858                 return TDM_ERROR_NONE;
859         }
860
861         private_vblank->fps_changeable = 0;
862
863         if (private_vblank->fps == fps)
864                 return TDM_ERROR_NONE;
865
866         private_vblank->fps = fps;
867         private_vblank->check_HW_or_SW = 1;
868
869         VIN("fps(%d) changed", fps);
870
871         return TDM_ERROR_NONE;
872 }
873
874 EXTERN tdm_error
875 tdm_vblank_get_fps(tdm_vblank *vblank, unsigned int *fps)
876 {
877         tdm_private_vblank *private_vblank = vblank;
878
879         TDM_RETURN_VAL_IF_FAIL(tdm_vblank_is_valid(vblank), TDM_ERROR_INVALID_PARAMETER);
880         TDM_RETURN_VAL_IF_FAIL(fps != NULL, TDM_ERROR_INVALID_PARAMETER);
881
882         *fps = private_vblank->fps;
883
884         return TDM_ERROR_NONE;
885 }
886
887 EXTERN tdm_error
888 tdm_vblank_set_fixed_fps(tdm_vblank *vblank, unsigned int fps)
889 {
890         tdm_private_vblank *private_vblank = vblank;
891
892         TDM_RETURN_VAL_IF_FAIL(tdm_vblank_is_valid(vblank), TDM_ERROR_INVALID_PARAMETER);
893         TDM_RETURN_VAL_IF_FAIL(fps > 0, TDM_ERROR_INVALID_PARAMETER);
894
895         private_vblank->fps_changeable = 0;
896         private_vblank->fps_fixed = 1;
897
898         if (private_vblank->fps == fps)
899                 return TDM_ERROR_NONE;
900
901         private_vblank->fps = fps;
902         private_vblank->check_HW_or_SW = 1;
903
904         VIN("fps(%d) fixed", fps);
905
906         return TDM_ERROR_NONE;
907 }
908
909 EXTERN tdm_error
910 tdm_vblank_ignore_global_fps(tdm_vblank *vblank, unsigned int ignore)
911 {
912         tdm_private_vblank *private_vblank = vblank;
913
914         TDM_RETURN_VAL_IF_FAIL(tdm_vblank_is_valid(vblank), TDM_ERROR_INVALID_PARAMETER);
915
916         if (private_vblank->ignore_global_fps == ignore)
917                 return TDM_ERROR_NONE;
918
919         private_vblank->ignore_global_fps = ignore;
920         private_vblank->check_HW_or_SW = 1;
921
922         VIN("ignore_global_fps(%d)", private_vblank->ignore_global_fps);
923
924         return TDM_ERROR_NONE;
925 }
926
927 EXTERN tdm_error
928 tdm_vblank_set_offset(tdm_vblank *vblank, int offset)
929 {
930         tdm_private_vblank *private_vblank = vblank;
931
932         TDM_RETURN_VAL_IF_FAIL(tdm_vblank_is_valid(vblank), TDM_ERROR_INVALID_PARAMETER);
933
934         if (private_vblank->offset == offset)
935                 return TDM_ERROR_NONE;
936
937         private_vblank->offset = offset;
938         private_vblank->check_HW_or_SW = 1;
939
940         VIN("offset(%d)", private_vblank->offset);
941
942         return TDM_ERROR_NONE;
943 }
944
945 EXTERN tdm_error
946 tdm_vblank_get_offset(tdm_vblank *vblank, int *offset)
947 {
948         tdm_private_vblank *private_vblank = vblank;
949
950         TDM_RETURN_VAL_IF_FAIL(tdm_vblank_is_valid(vblank), TDM_ERROR_INVALID_PARAMETER);
951         TDM_RETURN_VAL_IF_FAIL(offset != NULL, TDM_ERROR_INVALID_PARAMETER);
952
953         *offset = private_vblank->offset;
954
955         return TDM_ERROR_NONE;
956 }
957
958 EXTERN tdm_error
959 tdm_vblank_set_enable_fake(tdm_vblank *vblank, unsigned int enable_fake)
960 {
961         tdm_private_vblank *private_vblank = vblank;
962
963         TDM_RETURN_VAL_IF_FAIL(tdm_vblank_is_valid(vblank), TDM_ERROR_INVALID_PARAMETER);
964
965         if (private_vblank->enable_fake == enable_fake)
966                 return TDM_ERROR_NONE;
967
968         private_vblank->enable_fake = enable_fake;
969
970         VIN("enable_fake(%d)", private_vblank->enable_fake);
971
972         return TDM_ERROR_NONE;
973 }
974
975 EXTERN tdm_error
976 tdm_vblank_get_enable_fake(tdm_vblank *vblank, unsigned int *enable_fake)
977 {
978         tdm_private_vblank *private_vblank = vblank;
979
980         TDM_RETURN_VAL_IF_FAIL(tdm_vblank_is_valid(vblank), TDM_ERROR_INVALID_PARAMETER);
981         TDM_RETURN_VAL_IF_FAIL(enable_fake != NULL, TDM_ERROR_INVALID_PARAMETER);
982
983         *enable_fake = private_vblank->enable_fake;
984
985         return TDM_ERROR_NONE;
986 }
987
988 static tdm_error
989 _tdm_vblank_timeout_timer_cb(void *user_data)
990 {
991         tdm_private_vblank *private_vblank = user_data;
992         tdm_vblank_wait_info *w = NULL;
993         pid_t pid;
994         const char *proc_name;
995
996         TDM_RETURN_VAL_IF_FAIL(private_vblank != NULL, TDM_ERROR_OPERATION_FAILED);
997
998         _tdm_vblank_get_client_information(private_vblank, &pid, &proc_name);
999
1000         VER("TDM vblank TIMEOUT!! (pid: %u, name: %s)", pid, proc_name);
1001         VER("quotient(%u) last_seq(%u) last_time(%.6f)", private_vblank->quotient, private_vblank->last_seq, private_vblank->last_time);
1002
1003         LIST_FOR_EACH_ENTRY(w, &private_vblank->HW_wait_list, link) {
1004                 VER("wait_info(%p) req_time(%.6f) target_seq(%u) interval(%u) hw_interval(%d)",
1005                         w, w->req_time, w->target_seq, w->interval, w->hw_interval);
1006                 tdm_output_vblank_print_wait_information(private_vblank->output, w);
1007         }
1008
1009         LIST_FOR_EACH_ENTRY(w, &private_vblank->SW_wait_list, link) {
1010                 VER("wait_info(%p) req_time(%.6f) target_time(%.6f) target_seq(%u) interval(%u)",
1011                         w, w->req_time, w->target_time, w->target_seq, w->interval);
1012         }
1013
1014         return TDM_ERROR_NONE;
1015 }
1016
1017 static void
1018 _tdm_vblank_timeout_timer_update(tdm_private_vblank *private_vblank, int ms_delay)
1019 {
1020         tdm_error ret;
1021
1022         if (!private_vblank->timeout_timer) {
1023                 private_vblank->timeout_timer =
1024                         tdm_event_loop_add_timer_handler(private_vblank->dpy,
1025                                                                                          _tdm_vblank_timeout_timer_cb,
1026                                                                                          private_vblank,
1027                                                                                          &ret);
1028                 if (!private_vblank->timeout_timer) {
1029                         VER("couldn't add timer");
1030                         return;
1031                 }
1032                 VIN("Create Timeout timer");
1033         }
1034
1035         ret = tdm_event_loop_source_timer_update(private_vblank->timeout_timer, ms_delay);
1036         if (ret != TDM_ERROR_NONE) {
1037                 VER("couldn't update timer");
1038                 return;
1039         }
1040
1041         if (ms_delay != 0)
1042                 VDB("timeout timer updated");
1043         else
1044                 VDB("timeout timer disabled");
1045 }
1046
1047 static tdm_error
1048 _tdm_vblank_sw_timer_update(tdm_private_vblank *private_vblank)
1049 {
1050         tdm_vblank_wait_info *first_wait_info = NULL;
1051         double curr, target;
1052         int ms_delay;
1053         tdm_error ret;
1054
1055         if (LIST_IS_EMPTY(&private_vblank->SW_wait_list)) {
1056                 VER("no wait_info");
1057                 return TDM_ERROR_OPERATION_FAILED;
1058         }
1059
1060         first_wait_info = container_of(private_vblank->SW_wait_list.next, first_wait_info, link);
1061         curr = tdm_helper_get_time();
1062         target = first_wait_info->target_time;
1063
1064         /* ms_delay should be more that 1 */
1065         if (target < curr)
1066                 ms_delay = 1;
1067         else
1068                 ms_delay = ceil((target - curr) * 1000.0);
1069
1070         if (ms_delay < 1)
1071                 ms_delay = 1;
1072
1073         if (ms_delay > 5000)
1074                 VER("wait(%p) curr(%.6f) target(%.6f) ms_delay(%d)", first_wait_info, curr, target, ms_delay);
1075         else
1076                 VDB("wait(%p) curr(%.6f) target(%.6f) ms_delay(%d)", first_wait_info, curr, target, ms_delay);
1077
1078         tdm_display_lock(private_vblank->dpy);
1079
1080         if (!private_vblank->SW_timer) {
1081                 private_vblank->SW_timer =
1082                         tdm_event_loop_add_timer_handler(private_vblank->dpy,
1083                                                                                          _tdm_vblank_cb_vblank_SW,
1084                                                                                          private_vblank,
1085                                                                                          &ret);
1086                 if (!private_vblank->SW_timer) {
1087                         tdm_display_unlock(private_vblank->dpy);
1088                         VER("couldn't add timer");
1089                         return ret;
1090                 }
1091                 VIN("Create SW timer");
1092         }
1093
1094         private_vblank->last_interval = ms_delay;
1095
1096         ret = tdm_event_loop_source_timer_update(private_vblank->SW_timer, ms_delay);
1097         if (ret != TDM_ERROR_NONE) {
1098                 /* LCOV_EXCL_START */
1099                 tdm_display_unlock(private_vblank->dpy);
1100                 VER("couldn't update timer");
1101                 return ret;
1102                 /* LCOV_EXCL_STOP */
1103         }
1104
1105         tdm_display_unlock(private_vblank->dpy);
1106
1107         return TDM_ERROR_NONE;
1108 }
1109
1110 static void
1111 _tdm_vblank_cb_vblank_HW(tdm_output *output, unsigned int sequence,
1112                                                  unsigned int tv_sec, unsigned int tv_usec,
1113                                                  void *user_data)
1114 {
1115         tdm_vblank_wait_info *wait_info = user_data;
1116         tdm_private_vblank *private_vblank;
1117
1118         if (!_tdm_vblank_check_valid_wait(wait_info)) {
1119                 TDM_ERR("can't find wait(%p) from valid_wait_list", wait_info);
1120                 return;
1121         }
1122
1123         private_vblank = wait_info->private_vblank;
1124         TDM_RETURN_IF_FAIL(tdm_vblank_is_valid(private_vblank));
1125
1126         if (!_tdm_vblank_find_wait(wait_info, &private_vblank->HW_wait_list)) {
1127                 VER("can't find wait(%p)", wait_info);
1128                 return;
1129         }
1130
1131         if (wait_info->type == VBLANK_TYPE_HW_SW) {
1132                 tdm_error ret;
1133
1134                 LIST_DEL(&wait_info->link);
1135
1136                 /* kernel sends the wrong time of first vblank event. and the time of
1137                  * second vblank is correct.
1138                  */
1139                 wait_info->target_time = TDM_TIME(tv_sec, tv_usec);
1140                 wait_info->target_time += (((double)private_vblank->offset) / 1000.0);
1141
1142                 _tdm_vblank_insert_wait(wait_info, &private_vblank->SW_wait_list);
1143
1144                 ret = _tdm_vblank_sw_timer_update(private_vblank);
1145
1146                 /* wait_info will be freed in _tdm_vblank_cb_vblank_SW() */
1147                 if (ret == TDM_ERROR_NONE) {
1148                         VIN("wait(%p) SW timer", wait_info);
1149                         return;
1150                 }
1151
1152                 VER("couldn't update sw timer");
1153         }
1154
1155         tdm_display_lock(private_vblank->dpy);
1156         _tdm_vblank_timeout_timer_update(private_vblank, 0);
1157         tdm_display_unlock(private_vblank->dpy);
1158
1159         LIST_DEL(&wait_info->link);
1160         _tdm_vblank_valid_list_del(&wait_info->valid_link);
1161
1162         /* tv_sec & tv_usec shouldn't be zero. But sometimes they are zero in some hardware.
1163          * We need to prohibit that last_time becomes zero because "last_time == 0" means
1164          * that a tdm_vblank object is just created and doesn't have the first vblank event.
1165          * If last_time becomes 0, it would make issue.
1166          */
1167         if (tv_sec == 0 && tv_usec == 0) {
1168                 double curr = tdm_helper_get_time();
1169                 tv_sec = TDM_TIME_SEC(curr);
1170                 tv_usec = TDM_TIME_USEC(curr);
1171         }
1172
1173         private_vblank->last_seq = wait_info->target_seq;
1174         private_vblank->last_time = TDM_TIME(tv_sec, tv_usec);
1175
1176         VDB("wait(%p) last(%.6f) sequence(%u) done", wait_info, private_vblank->last_time, wait_info->target_seq);
1177
1178         if (tdm_ttrace_module & TDM_TTRACE_VBLANK)
1179                 TDM_TRACE_ASYNC_END((int)wait_info->req_time, "TDM_Vblank:%u", (unsigned int)private_vblank->stamp);
1180
1181         if (wait_info->func)
1182                 wait_info->func(private_vblank, TDM_ERROR_NONE, wait_info->target_seq,
1183                                                 tv_sec, tv_usec, wait_info->user_data);
1184
1185         free(wait_info);
1186 }
1187
1188 static tdm_error
1189 _tdm_vblank_wait_HW(tdm_vblank_wait_info *wait_info)
1190 {
1191         tdm_private_vblank *private_vblank = wait_info->private_vblank;
1192         int hw_interval;
1193         tdm_error ret;
1194
1195         if (private_vblank->last_type != VBLANK_EVENT_TYPE_HW) {
1196                 VIN("Use HW vblank");
1197                 private_vblank->last_type = VBLANK_EVENT_TYPE_HW;
1198         }
1199
1200         _tdm_vblank_insert_wait(wait_info, &private_vblank->HW_wait_list);
1201
1202         if (private_vblank->last_time == 0) {
1203                 hw_interval = wait_info->interval * private_vblank->quotient;
1204
1205                 /* SW vblank starts from now. SW vblank doesn't need to be aligned with HW vblank. */
1206                 private_vblank->last_seq = 0;
1207                 private_vblank->last_time = tdm_helper_get_time();
1208
1209                 /* +1 ms to call the handler ASAP at the first. no matter for SW timer. */
1210                 wait_info->target_seq = 1;
1211
1212                 VDB("wait(%p) last(%.6f) hw_itvl(%d) targ_seq(%u)",
1213                         wait_info, private_vblank->last_time, hw_interval, wait_info->target_seq);
1214         } else {
1215                 double last, prev, req, curr, target;
1216                 unsigned int skip;
1217
1218                 last = private_vblank->last_time;
1219                 req = wait_info->req_time;
1220
1221                 /* make sure that req time is bigger than last. */
1222                 if (req < last)
1223                         req = last;
1224
1225                 skip = (unsigned int)((req - last) / private_vblank->vblank_gap + TDM_TIME_MARGIN);
1226                 prev = last + private_vblank->vblank_gap * skip;
1227
1228                 curr = tdm_helper_get_time();
1229                 target = last;
1230                 while (target < curr)
1231                         target += (private_vblank->vblank_gap * wait_info->interval);
1232
1233                 hw_interval = (unsigned int)((target - curr) / private_vblank->HW_vblank_gap + TDM_TIME_MARGIN) + 1;
1234
1235                 wait_info->target_seq = private_vblank->last_seq;
1236                 wait_info->target_seq += (unsigned int)((target - last) / private_vblank->vblank_gap + TDM_TIME_MARGIN);
1237
1238                 if (hw_interval > 300)
1239                         VER("wait(%p) last(%.6f) req(%.6f) prev(%.6f) curr(%.6f) targ(%.6f,%.6f) skip(%u) hw_itvl(%d) targ_seq(%u)",
1240                                 wait_info, last, req - last, prev - last, curr - last, target, target - last,
1241                                 skip, hw_interval, wait_info->target_seq);
1242                 else
1243                         VDB("wait(%p) last(%.6f) req(%.6f) prev(%.6f) curr(%.6f) targ(%.6f,%.6f) skip(%u) hw_itvl(%d) targ_seq(%u)",
1244                                 wait_info, last, req - last, prev - last, curr - last, target, target - last,
1245                                 skip, hw_interval, wait_info->target_seq);
1246         }
1247
1248         private_vblank->last_interval = hw_interval;
1249         wait_info->hw_interval = hw_interval;
1250
1251         if (tdm_ttrace_module & TDM_TTRACE_VBLANK)
1252                 TDM_TRACE_ASYNC_BEGIN((int)wait_info->req_time, "TDM_Vblank:%u", (unsigned int)private_vblank->stamp);
1253
1254         if (private_vblank->add_front)
1255                 ret = tdm_output_wait_vblank_add_front(private_vblank->output, hw_interval, 0,
1256                                                                                            _tdm_vblank_cb_vblank_HW, wait_info);
1257         else
1258                 ret = tdm_output_wait_vblank(private_vblank->output, hw_interval, 0,
1259                                                                          _tdm_vblank_cb_vblank_HW, wait_info);
1260
1261         if (ret != TDM_ERROR_NONE) {
1262                 LIST_DEL(&wait_info->link);
1263                 return ret;
1264         }
1265
1266         VDB("wait(%p) waiting", wait_info);
1267
1268         return TDM_ERROR_NONE;
1269 }
1270
1271 static tdm_error
1272 _tdm_vblank_cb_vblank_SW(void *user_data)
1273 {
1274         tdm_private_vblank *private_vblank = user_data;
1275
1276         TDM_RETURN_VAL_IF_FAIL(tdm_vblank_is_valid(private_vblank), TDM_ERROR_OPERATION_FAILED);
1277
1278         return tdm_vblank_cb_vblank_SW(private_vblank, 0);
1279 }
1280
1281 INTERN tdm_error
1282 tdm_vblank_cb_vblank_SW(tdm_vblank *vblank, double vblank_stamp)
1283 {
1284         tdm_private_vblank *private_vblank;
1285         tdm_vblank_wait_info *first_wait_info = NULL, *w = NULL, *ww = NULL;
1286
1287         TDM_RETURN_VAL_IF_FAIL(vblank || vblank_stamp > 0, TDM_ERROR_INVALID_PARAMETER);
1288
1289         if (vblank)
1290                 private_vblank = vblank;
1291         else {
1292                 private_vblank = _tdm_vblank_find(vblank_stamp);
1293                 if (!private_vblank) {
1294                         TDM_ERR("can't find vblank(%.0f) from valid_list", vblank_stamp);
1295                         return TDM_ERROR_NONE;
1296                 }
1297         }
1298
1299         if (private_vblank->owner_tid != syscall(SYS_gettid)) {
1300                 tdm_thread_cb_vblank_sw vblank_sw;
1301                 tdm_private_display *private_display = private_vblank->dpy;
1302                 tdm_error ret;
1303
1304                 vblank_sw.base.type = TDM_THREAD_CB_VBLANK_SW;
1305                 vblank_sw.base.length = sizeof vblank_sw;
1306                 vblank_sw.vblank_stamp = private_vblank->stamp;
1307
1308                 ret = tdm_thread_send_cb(private_display->private_loop, &vblank_sw.base);
1309                 TDM_WARNING_IF_FAIL(ret == TDM_ERROR_NONE);
1310
1311                 return TDM_ERROR_NONE;
1312         }
1313
1314         if (LIST_IS_EMPTY(&private_vblank->SW_wait_list)) {
1315                 VER("no wait_info");
1316                 return TDM_ERROR_OPERATION_FAILED;
1317         }
1318
1319         if (!LIST_IS_EMPTY(&private_vblank->HW_wait_list))
1320                 TDM_NEVER_GET_HERE();
1321
1322         first_wait_info = container_of(private_vblank->SW_wait_list.next, first_wait_info, link);
1323         TDM_RETURN_VAL_IF_FAIL(first_wait_info != NULL, TDM_ERROR_OPERATION_FAILED);
1324
1325         _tdm_vblank_timeout_timer_update(private_vblank, 0);
1326
1327         if (private_vblank->last_seq >= first_wait_info->target_seq)
1328                 TDM_ERR("last_seq(%u) target_seq(%u)", private_vblank->last_seq, first_wait_info->target_seq);
1329
1330         private_vblank->last_seq = first_wait_info->target_seq;
1331         private_vblank->last_time = first_wait_info->target_time;
1332
1333         VDB("wait(%p) last(%.6f) sequence(%u) done", first_wait_info, private_vblank->last_time, first_wait_info->target_seq);
1334
1335         LIST_FOR_EACH_ENTRY_SAFE(w, ww, &private_vblank->SW_wait_list, link) {
1336                 if (w->target_time != first_wait_info->target_time)
1337                         break;
1338
1339                 LIST_DEL(&w->link);
1340                 _tdm_vblank_valid_list_del(&w->valid_link);
1341
1342                 if (w->func) {
1343                         tdm_display_unlock(private_vblank->dpy);
1344                         w->func(private_vblank, TDM_ERROR_NONE, w->target_seq,
1345                                         TDM_TIME_SEC(w->target_time), TDM_TIME_USEC(w->target_time),
1346                                         w->user_data);
1347                         tdm_display_lock(private_vblank->dpy);
1348                 }
1349
1350                 free(w);
1351         }
1352
1353         return TDM_ERROR_NONE;
1354 }
1355
1356 static tdm_error
1357 _tdm_vblank_wait_SW(tdm_vblank_wait_info *wait_info)
1358 {
1359         tdm_private_vblank *private_vblank = wait_info->private_vblank;
1360         tdm_error ret;
1361
1362         if (private_vblank->last_type != VBLANK_EVENT_TYPE_SW) {
1363                 VIN("Use SW vblank");
1364                 private_vblank->last_type = VBLANK_EVENT_TYPE_SW;
1365         }
1366
1367         if (private_vblank->last_time == 0) {
1368                 /* SW vblank starts from now. SW vblank doesn't need to be aligned with HW vblank. */
1369                 private_vblank->last_seq = 0;
1370                 private_vblank->last_time = tdm_helper_get_time();
1371
1372                 /* +1 ms to call the handler ASAP at the first. no matter for SW timer. */
1373                 wait_info->target_seq = 1;
1374                 wait_info->target_time = private_vblank->last_time + 0.001;
1375
1376                 VDB("wait(%p) last(%.6f) target(%.6f) target sequence(%u)",
1377                         wait_info, private_vblank->last_time, wait_info->target_time, wait_info->target_seq);
1378         } else {
1379                 double last, prev, req, curr, target;
1380                 unsigned int skip;
1381
1382                 last = private_vblank->last_time;
1383                 req = wait_info->req_time;
1384
1385                 /* make sure that req time is bigger than last. */
1386                 if (req < last)
1387                         req = last;
1388
1389                 skip = (unsigned int)((req - last) / private_vblank->vblank_gap + TDM_TIME_MARGIN);
1390                 prev = last + private_vblank->vblank_gap * skip;
1391
1392                 curr = tdm_helper_get_time();
1393                 target = prev + private_vblank->vblank_gap * wait_info->interval;
1394
1395                 while (target < curr)
1396                         target += private_vblank->vblank_gap;
1397
1398                 wait_info->target_seq = private_vblank->last_seq;
1399                 wait_info->target_seq += (unsigned int)((target - last) / private_vblank->vblank_gap + TDM_TIME_MARGIN);
1400
1401                 wait_info->target_time = target;
1402
1403                 VDB("wait(%p) last(%.6f) req(%.6f) prev(%.6f) curr(%.6f) targ(%.6f,%.6f) skip(%u) targ_seq(%u)",
1404                         wait_info, last, req - last, prev - last, curr - last,
1405                         target, target - last, skip, wait_info->target_seq);
1406         }
1407
1408         _tdm_vblank_insert_wait(wait_info, &private_vblank->SW_wait_list);
1409
1410         ret = _tdm_vblank_sw_timer_update(private_vblank);
1411         if (ret != TDM_ERROR_NONE) {
1412                 /* LCOV_EXCL_START */
1413                 LIST_DEL(&wait_info->link);
1414                 VER("couldn't update sw timer");
1415                 return ret;
1416                 /* LCOV_EXCL_STOP */
1417         }
1418
1419         return TDM_ERROR_NONE;
1420 }
1421
1422 EXTERN tdm_error
1423 tdm_vblank_wait(tdm_vblank *vblank, unsigned int req_sec, unsigned int req_usec,
1424                                 unsigned int interval, tdm_vblank_handler func, void *user_data)
1425 {
1426         tdm_private_vblank *private_vblank = vblank;
1427         tdm_vblank_wait_info *wait_info;
1428         tdm_output_dpms dpms = TDM_OUTPUT_DPMS_OFF;
1429         unsigned int fps;
1430         tdm_error ret;
1431
1432         TDM_RETURN_VAL_IF_FAIL(tdm_vblank_is_valid(vblank), TDM_ERROR_INVALID_PARAMETER);
1433         TDM_RETURN_VAL_IF_FAIL(func != NULL, TDM_ERROR_INVALID_PARAMETER);
1434
1435         if (private_vblank->in_create_handler) {
1436                 TDM_ERR("NOT allowed to be called in a create handler");
1437                 return TDM_ERROR_BAD_REQUEST;
1438         }
1439
1440         if (private_vblank->owner_tid != syscall(SYS_gettid)) {
1441                 TDM_ERR("SHOULD be called in the owner thread(%d)", (int)private_vblank->owner_tid);
1442                 return TDM_ERROR_BAD_REQUEST;
1443         }
1444
1445         tdm_output_get_dpms(private_vblank->output, &dpms);
1446
1447         if (!private_vblank->enable_fake) {
1448                 if (private_vblank->connection == TDM_OUTPUT_CONN_STATUS_DISCONNECTED) {
1449                         VER("can't wait a vblank: output disconnected");
1450                         return TDM_ERROR_OUTPUT_DISCONNECTED;
1451                 }
1452                 if (TDM_OUTPUT_DPMS_VSYNC_IS_OFF(dpms)) {
1453                         VER("can't wait a vblank: DPMS %s", tdm_dpms_str(dpms));
1454                         return TDM_ERROR_DPMS_OFF;
1455                 }
1456         }
1457
1458         wait_info = calloc(1, sizeof * wait_info);
1459         if (!wait_info) {
1460                 /* LCOV_EXCL_START */
1461                 VER("alloc failed");
1462                 return TDM_ERROR_OUT_OF_MEMORY;
1463                 /* LCOV_EXCL_STOP */
1464         }
1465         _tdm_vblank_update_output_info(private_vblank);
1466
1467         /* set request time to current time if 0. This function seems to be called in server side. */
1468         if (req_sec == 0 && req_usec == 0) {
1469                 double curr = tdm_helper_get_time();
1470                 req_sec = TDM_TIME_SEC(curr);
1471                 req_usec = TDM_TIME_USEC(curr);
1472         }
1473
1474         LIST_INITHEAD(&wait_info->link);
1475
1476         _tdm_vblank_valid_list_add(&wait_info->valid_link, &valid_wait_list);
1477
1478         wait_info->stamp = ++stamp;
1479         wait_info->req_time = TDM_TIME(req_sec, req_usec);
1480         wait_info->interval = interval;
1481         wait_info->func = func;
1482         wait_info->user_data = user_data;
1483         wait_info->private_vblank = private_vblank;
1484
1485         if (private_vblank->ignore_global_fps ||
1486                 vblank_global_fps == 0 ||
1487                 private_vblank->fps < vblank_global_fps)
1488                 fps = private_vblank->fps;
1489         else
1490                 fps = vblank_global_fps;
1491
1492         if (private_vblank->check_HW_or_SW) {
1493                 private_vblank->check_HW_or_SW = 0;
1494                 private_vblank->vblank_gap = 1.0 / fps;
1495                 private_vblank->quotient = private_vblank->vrefresh / fps;
1496         }
1497
1498         /* 1) if fps != factor of vrefresh, SW timer
1499          * 2) if fps == factor of vrefresh && dpms == off, SW timer (Fake HW vblank)
1500          * 2) if fps == factor of vrefresh && dpms == on && offset == 0, HW vblank
1501          * 3) if fps == factor of vrefresh && dpms == on && offset != 0, HW vblank + SW timer
1502          * In case of 1), we really don't need to align with HW vblank.
1503          */
1504         if (private_vblank->vrefresh % fps)
1505                 wait_info->type = VBLANK_TYPE_SW;
1506         else if (TDM_OUTPUT_DPMS_VSYNC_IS_OFF(dpms) ||
1507                          private_vblank->connection != TDM_OUTPUT_CONN_STATUS_MODE_SETTED)
1508                 wait_info->type = VBLANK_TYPE_SW_FAKE;
1509         else if (private_vblank->offset == 0)
1510                 wait_info->type = VBLANK_TYPE_HW;
1511         else
1512                 wait_info->type = VBLANK_TYPE_HW_SW;
1513
1514         if (wait_info->type == VBLANK_TYPE_SW || wait_info->type == VBLANK_TYPE_SW_FAKE) {
1515                 ret = _tdm_vblank_wait_SW(wait_info);
1516                 if (ret != TDM_ERROR_NONE)
1517                         TDM_ERR("_tdm_vblank_wait_SW failed: ret(%d)", ret);
1518         } else {
1519                 ret = _tdm_vblank_wait_HW(wait_info);
1520                 if (ret != TDM_ERROR_NONE)
1521                         TDM_ERR("_tdm_vblank_wait_HW failed: ret(%d)", ret);
1522
1523                 if (ret == TDM_ERROR_OUTPUT_DISCONNECTED || ret == TDM_ERROR_DPMS_OFF) {
1524                         ret = _tdm_vblank_wait_SW(wait_info);
1525                         if (ret != TDM_ERROR_NONE)
1526                                 TDM_ERR("_tdm_vblank_wait_SW failed: ret(%d)", ret);
1527                 }
1528         }
1529
1530         if (ret != TDM_ERROR_NONE) {
1531                 /* LCOV_EXCL_START */
1532                 LIST_DEL(&wait_info->link);
1533                 _tdm_vblank_valid_list_del(&wait_info->valid_link);
1534
1535                 tdm_display_lock(private_vblank->dpy);
1536                 tdm_output_remove_vblank_handler_internal(private_vblank->output, _tdm_vblank_cb_vblank_HW, wait_info);
1537                 tdm_display_unlock(private_vblank->dpy);
1538
1539                 free(wait_info);
1540                 return ret;
1541                 /* LCOV_EXCL_STOP */
1542         }
1543
1544         tdm_display_lock(private_vblank->dpy);
1545         _tdm_vblank_timeout_timer_update(private_vblank, 1000);
1546         tdm_display_unlock(private_vblank->dpy);
1547
1548         return TDM_ERROR_NONE;
1549 }
1550
1551 EXTERN tdm_error
1552 tdm_vblank_wait_seq(tdm_vblank *vblank, unsigned int req_sec, unsigned int req_usec,
1553                                         unsigned int sequence, tdm_vblank_handler func, void *user_data)
1554 {
1555         tdm_private_vblank *private_vblank = vblank;
1556         unsigned int interval;
1557
1558         TDM_RETURN_VAL_IF_FAIL(tdm_vblank_is_valid(vblank), TDM_ERROR_INVALID_PARAMETER);
1559         TDM_RETURN_VAL_IF_FAIL(func != NULL, TDM_ERROR_INVALID_PARAMETER);
1560
1561         /* if the sequence of vblank reaches the max value, sequence can be 0. */
1562
1563         if (private_vblank->last_seq == 0) {
1564                 VWR("can't calculate interval with sequence(%u)", sequence);
1565                 interval = 1;
1566         } else if (sequence > private_vblank->last_seq ||
1567                            TDM_VBLANK_SEQ_REACHED_MAX(sequence, private_vblank->last_seq)) {
1568                 double last, curr, seq_target;
1569
1570                 last = private_vblank->last_time;
1571                 curr = tdm_helper_get_time();
1572                 seq_target = last + private_vblank->vblank_gap * (sequence - private_vblank->last_seq);
1573
1574                 /* If target is old or too close(1ms) to current, we call the handler immediately.
1575                  * 2ms? it seems too much.
1576                  */
1577                 if (seq_target < curr) {
1578                         func(vblank, TDM_ERROR_NONE, sequence,
1579                                  TDM_TIME_SEC(seq_target), TDM_TIME_USEC(seq_target),
1580                                  user_data);
1581                         return TDM_ERROR_NONE;
1582                 } else if ((seq_target - curr) < 0.001) {  /* 1ms */
1583                         func(vblank, TDM_ERROR_NONE, sequence,
1584                                  TDM_TIME_SEC(curr), TDM_TIME_USEC(curr),
1585                                  user_data);
1586                         return TDM_ERROR_NONE;
1587                 }
1588
1589                 interval = (unsigned int)((seq_target - curr) / private_vblank->vblank_gap + TDM_TIME_MARGIN) + 1;
1590         } else {
1591                 /* this seems error. But we handle this like normal to avoid the unexpected error in cliend side */
1592                 VER("sequence(%u) should be over the last sequence(%u)", sequence, private_vblank->last_seq);
1593                 func(vblank, TDM_ERROR_NONE, private_vblank->last_seq,
1594                          TDM_TIME_SEC(private_vblank->last_time), TDM_TIME_USEC(private_vblank->last_time),
1595                          user_data);
1596                 return TDM_ERROR_NONE;
1597         }
1598
1599         return tdm_vblank_wait(vblank, req_sec, req_usec, interval, func, user_data);
1600 }
1601
1602 /* LCOV_EXCL_START */
1603 INTERN tdm_error
1604 tdm_vblank_set_add_front(tdm_vblank *vblank, unsigned int add_front)
1605 {
1606         tdm_private_vblank *private_vblank = vblank;
1607
1608         TDM_RETURN_VAL_IF_FAIL(tdm_vblank_is_valid(vblank), TDM_ERROR_INVALID_PARAMETER);
1609
1610         TDM_RETURN_VAL_IF_FAIL(TDM_MUTEX_IS_LOCKED(), TDM_ERROR_OPERATION_FAILED);
1611
1612         if (private_vblank->add_front == add_front)
1613                 return TDM_ERROR_NONE;
1614
1615         private_vblank->add_front = add_front;
1616
1617         return TDM_ERROR_NONE;
1618 }
1619 /* LCOV_EXCL_STOP */
1620
1621 INTERN tdm_error
1622 tdm_vblank_set_resource(tdm_vblank *vblank, struct wl_resource *resource)
1623 {
1624         tdm_private_vblank *private_vblank = vblank;
1625
1626         TDM_RETURN_VAL_IF_FAIL(tdm_vblank_is_valid(vblank), TDM_ERROR_INVALID_PARAMETER);
1627         TDM_RETURN_VAL_IF_FAIL(private_vblank->resource == NULL, TDM_ERROR_OPERATION_FAILED);
1628
1629         private_vblank->resource = resource;
1630
1631         return TDM_ERROR_NONE;
1632 }
1633
1634 INTERN double
1635 tdm_vblank_get_stamp(tdm_vblank *vblank)
1636 {
1637         tdm_private_vblank *private_vblank = vblank;
1638
1639         TDM_RETURN_VAL_IF_FAIL(tdm_vblank_is_valid(vblank), TDM_ERROR_INVALID_PARAMETER);
1640
1641         return private_vblank->stamp;
1642 }
1643
1644 static unsigned int
1645 _tdm_vblank_get_waiting_count(tdm_private_vblank *private_vblank)
1646 {
1647         tdm_vblank_wait_info *wait_info = NULL;
1648         unsigned int count = 0;
1649
1650         LIST_FOR_EACH_ENTRY(wait_info, &private_vblank->HW_wait_list, link) {
1651                 count++;
1652         }
1653
1654         LIST_FOR_EACH_ENTRY(wait_info, &private_vblank->SW_wait_list, link) {
1655                 count++;
1656         }
1657
1658         return count;
1659 }
1660
1661 static void
1662 _tdm_vblank_get_client_information(tdm_private_vblank *private_vblank, pid_t *pid, const char **name)
1663 {
1664         struct wl_client *client;
1665
1666         if (!private_vblank->resource)
1667                 goto no_client;
1668
1669         client = wl_resource_get_client(private_vblank->resource);
1670         if (!client)
1671                 goto no_client;
1672
1673         wl_client_get_credentials(client, pid, NULL, NULL);
1674         *name = tdm_server_get_client_name(*pid);
1675
1676         return;
1677
1678 no_client:
1679         *pid = 0;
1680         *name = NULL;
1681         return;
1682 }
1683
1684 /* LCOV_EXCL_START */
1685 INTERN void
1686 tdm_vblank_get_vblank_list_information(tdm_display *dpy, char *reply, int *len)
1687 {
1688         tdm_private_vblank *v = NULL;
1689         tdm_output_dpms dpms = TDM_OUTPUT_DPMS_OFF;
1690         tdm_output *output = tdm_display_get_output(dpy, 0, NULL);
1691
1692         if (output)
1693                 tdm_output_get_dpms(output, &dpms);
1694
1695         TDM_SNPRINTF(reply, len, "[Client Vblank List]\n");
1696         TDM_SNPRINTF(reply, len, "* DPMS: %s\n", tdm_dpms_str(dpms));
1697         TDM_SNPRINTF(reply, len, "* global fps: %u\n", vblank_global_fps);
1698         TDM_SNPRINTF(reply, len, "----------------------------------------------------------------------------------\n");
1699         TDM_SNPRINTF(reply, len, "Name                 Type Wait Interval Sequence Fps Ignore Offset Fake Process\n");
1700         TDM_SNPRINTF(reply, len, "----------------------------------------------------------------------------------\n");
1701
1702         pthread_mutex_lock(&valid_list_lock);
1703         LIST_FOR_EACH_ENTRY(v, &valid_vblank_list, valid_link) {
1704                 const char *proc_name = NULL;
1705                 pid_t pid = 0;
1706                 unsigned int count;
1707
1708                 _tdm_vblank_get_client_information(v, &pid, &proc_name);
1709
1710                 count = _tdm_vblank_get_waiting_count(v);
1711
1712                 TDM_SNPRINTF(reply, len, "%-8s(%p) ", v->name, v);
1713                 TDM_SNPRINTF(reply, len, "%-4s ", (v->last_type == VBLANK_EVENT_TYPE_HW) ? "HW" : "SW");
1714                 TDM_SNPRINTF(reply, len, "%-4s ", (count > 0) ? "O" : " ");
1715                 TDM_SNPRINTF(reply, len, "%-8d ", v->last_interval);
1716                 TDM_SNPRINTF(reply, len, "%-8u ", v->last_seq);
1717                 TDM_SNPRINTF(reply, len, "%-3u ", v->fps);
1718                 TDM_SNPRINTF(reply, len, "%-6u ", v->ignore_global_fps);
1719                 TDM_SNPRINTF(reply, len, "%-6d ", v->offset);
1720                 TDM_SNPRINTF(reply, len, "%-4u ", v->enable_fake);
1721                 TDM_SNPRINTF(reply, len, "%s(pid:%d)\n", (proc_name) ? proc_name : "Unknown", pid);
1722         }
1723         pthread_mutex_unlock(&valid_list_lock);
1724
1725         TDM_SNPRINTF(reply, len, "\n");
1726 }
1727 /* LCOV_EXCL_STOP */
1728