vblank: add description
[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                 /* use in_create_handler instead of mutext unlock/lock */
588                 private_vblank->in_create_handler = 1;
589                 //_pthread_mutex_unlock(&private_display->lock);
590                 ch_info->func(private_vblank, ch_info->user_data);
591                 //_pthread_mutex_lock(&private_display->lock);
592                 private_vblank->in_create_handler = 0;
593         }
594
595         return TDM_ERROR_NONE;
596 }
597
598 EXTERN tdm_error
599 tdm_vblank_add_create_handler(tdm_display *dpy, tdm_vblank_create_handler func, void *user_data)
600 {
601         tdm_vblank_create_handler_info *ch_info;
602
603         TDM_RETURN_VAL_IF_FAIL(func != NULL, TDM_ERROR_INVALID_PARAMETER);
604
605         /* we don't allow adding a create handler in sub-thread because tdm_vblank_create()
606          * can be called in both threads and tdm_thread_send_cb supports only one-way
607          * communication now.
608          */
609         if (!tdm_thread_in_display_thread(syscall(SYS_gettid))) {
610                 TDM_ERR("add_create_handler should be called in main thread");
611                 return TDM_ERROR_BAD_REQUEST;
612         }
613
614         ch_info = calloc(1, sizeof *ch_info);
615         TDM_RETURN_VAL_IF_FAIL(ch_info != NULL, TDM_ERROR_OUT_OF_MEMORY);
616
617         ch_info->func = func;
618         ch_info->user_data = user_data;
619
620         LIST_ADDTAIL(&ch_info->link, &create_handler_list);
621
622         return TDM_ERROR_NONE;
623 }
624
625 EXTERN void
626 tdm_vblank_remove_create_handler(tdm_display *dpy, tdm_vblank_create_handler func, void *user_data)
627 {
628         tdm_vblank_create_handler_info *ch_info = NULL, *hh = NULL;
629
630         /* we don't allow adding a create handler in sub-thread because tdm_vblank_create()
631          * can be called in both threads and tdm_thread_send_cb supports only one-way
632          * communication now.
633          */
634         if (!tdm_thread_in_display_thread(syscall(SYS_gettid))) {
635                 TDM_ERR("remove_create_handler should be called in main thread");
636                 return;
637         }
638
639         LIST_FOR_EACH_ENTRY_SAFE(ch_info, hh, &create_handler_list, link) {
640                 if (ch_info->func != func && ch_info->user_data != user_data)
641                         continue;
642
643                 LIST_DEL(&ch_info->link);
644                 free(ch_info);
645                 return;
646         }
647 }
648
649 INTERN tdm_error
650 tdm_vblank_init(tdm_display *dpy)
651 {
652         if (vblank_list_inited)
653                 return TDM_ERROR_NONE;
654
655         if (pthread_mutex_init(&valid_list_lock, NULL)) {
656                 TDM_ERR("mutex init failed: %m");
657                 return TDM_ERROR_OUT_OF_MEMORY;
658         }
659
660         LIST_INITHEAD(&valid_vblank_list);
661         LIST_INITHEAD(&valid_wait_list);
662         LIST_INITHEAD(&create_handler_list);
663
664         vblank_list_inited = 1;
665
666         return TDM_ERROR_NONE;
667 }
668
669 INTERN void
670 tdm_vblank_deinit(tdm_display *dpy)
671 {
672         tdm_vblank_create_handler_info *ch_info = NULL, *hh = NULL;
673
674         if (!vblank_list_inited)
675                 return;
676
677         if (!LIST_IS_EMPTY(&valid_vblank_list))
678                 TDM_NEVER_GET_HERE();
679
680         if (!LIST_IS_EMPTY(&valid_wait_list))
681                 TDM_NEVER_GET_HERE();
682
683         LIST_FOR_EACH_ENTRY_SAFE(ch_info, hh, &create_handler_list, link) {
684                 LIST_DEL(&ch_info->link);
685                 free(ch_info);
686         }
687
688         pthread_mutex_destroy(&valid_list_lock);
689
690         vblank_list_inited = 0;
691 }
692
693 EXTERN tdm_vblank *
694 tdm_vblank_create(tdm_display *dpy, tdm_output *output, tdm_error *error)
695 {
696         tdm_private_vblank *private_vblank;
697         tdm_error ret;
698
699         TDM_RETURN_VAL_IF_FAIL_WITH_ERROR(tdm_display_is_valid(dpy), TDM_ERROR_INVALID_PARAMETER, NULL);
700         TDM_RETURN_VAL_IF_FAIL_WITH_ERROR(tdm_output_is_valid(output), TDM_ERROR_INVALID_PARAMETER, NULL);
701
702         if (error)
703                 *error = TDM_ERROR_NONE;
704
705         private_vblank = calloc(1, sizeof * private_vblank);
706         if (!private_vblank) {
707                 /* LCOV_EXCL_START */
708                 if (error)
709                         *error = TDM_ERROR_OUT_OF_MEMORY;
710                 TDM_ERR("alloc failed");
711                 return NULL;
712                 /* LCOV_EXCL_STOP */
713         }
714
715         tdm_output_add_change_handler(output, _tdm_vblank_cb_output_change, private_vblank);
716
717         private_vblank->stamp = ++stamp;
718         private_vblank->owner_tid = syscall(SYS_gettid);
719         private_vblank->dpy = dpy;
720         private_vblank->output = output;
721         private_vblank->check_HW_or_SW = 1;
722         private_vblank->fps_changeable = 1;
723         private_vblank->last_interval = -1;
724
725         _tdm_vblank_update_output_info(private_vblank);
726
727         strncpy(private_vblank->name, TDM_VBLANK_DEFAULT_NAME, TDM_NAME_LEN - 1);
728         private_vblank->name[TDM_NAME_LEN - 1] = '\0';
729
730         LIST_INITHEAD(&private_vblank->HW_wait_list);
731         LIST_INITHEAD(&private_vblank->SW_wait_list);
732
733         _tdm_vblank_valid_list_add(&private_vblank->valid_link, &valid_vblank_list);
734
735         VIN("created. vrefresh(%d) connection(%d)",
736                 private_vblank->vrefresh, private_vblank->connection);
737
738         tdm_display_lock(private_vblank->dpy);
739         tdm_vblank_cb_vblank_create(NULL, private_vblank->stamp);
740         tdm_display_unlock(private_vblank->dpy);
741
742         return (tdm_vblank *)private_vblank;
743 }
744
745 EXTERN void
746 tdm_vblank_destroy(tdm_vblank *vblank)
747 {
748         tdm_private_vblank *private_vblank = vblank;
749         tdm_vblank_wait_info *w = NULL, *ww = NULL;
750
751         TDM_RETURN_IF_FAIL(tdm_vblank_is_valid(vblank));
752
753         if (private_vblank->in_create_handler) {
754                 TDM_ERR("NOT allowed to be called in a create handler");
755                 return;
756         }
757
758         _tdm_vblank_valid_list_del(&private_vblank->valid_link);
759
760         if (private_vblank->SW_timer) {
761                 tdm_display_lock(private_vblank->dpy);
762                 tdm_event_loop_source_remove(private_vblank->SW_timer);
763                 tdm_display_unlock(private_vblank->dpy);
764         }
765
766         tdm_output_remove_change_handler(private_vblank->output,
767                                                                          _tdm_vblank_cb_output_change, private_vblank);
768
769         _tdm_vblank_free_HW_wait(private_vblank, 0, 0);
770
771         if (!LIST_IS_EMPTY(&private_vblank->SW_wait_list)) {
772                 pid_t pid;
773                 const char *proc_name;
774                 _tdm_vblank_get_client_information(private_vblank, &pid, &proc_name);
775                 VER("TDM SW vblank destroyed forcely!! (pid: %u, name: %s)", pid, proc_name);
776         }
777
778         LIST_FOR_EACH_ENTRY_SAFE(w, ww, &private_vblank->SW_wait_list, link) {
779                 LIST_DEL(&w->link);
780                 _tdm_vblank_valid_list_del(&w->valid_link);
781                 free(w);
782         }
783
784         if (private_vblank->timeout_timer) {
785                 tdm_display_lock(private_vblank->dpy);
786                 tdm_event_loop_source_remove(private_vblank->timeout_timer);
787                 tdm_display_unlock(private_vblank->dpy);
788         }
789
790         VIN("destroyed");
791
792         free(private_vblank);
793 }
794
795 EXTERN tdm_error
796 tdm_vblank_get_client_pid(tdm_vblank *vblank, pid_t *pid)
797 {
798         tdm_private_vblank *private_vblank = vblank;
799         struct wl_client *client;
800
801         TDM_RETURN_VAL_IF_FAIL(tdm_vblank_is_valid(vblank), TDM_ERROR_INVALID_PARAMETER);
802         TDM_RETURN_VAL_IF_FAIL(pid != NULL, TDM_ERROR_INVALID_PARAMETER);
803
804         if (!private_vblank->resource) {
805                 *pid = 0;
806                 return TDM_ERROR_NONE;
807         }
808
809         client = wl_resource_get_client(private_vblank->resource);
810         if (!client) {
811                 *pid = 0;
812                 return TDM_ERROR_NONE;
813         }
814
815         wl_client_get_credentials(client, pid, NULL, NULL);
816
817         return TDM_ERROR_NONE;
818 }
819
820 EXTERN tdm_error
821 tdm_vblank_set_name(tdm_vblank *vblank, const char *name)
822 {
823         tdm_private_vblank *private_vblank = vblank;
824
825         TDM_RETURN_VAL_IF_FAIL(tdm_vblank_is_valid(vblank), TDM_ERROR_INVALID_PARAMETER);
826
827         if (!name)
828                 name = TDM_VBLANK_DEFAULT_NAME;
829
830         strncpy(private_vblank->name, name, TDM_NAME_LEN - 1);
831         private_vblank->name[TDM_NAME_LEN - 1] = '\0';
832
833         VIN("name(%s)", name);
834
835         return TDM_ERROR_NONE;
836 }
837
838 EXTERN tdm_error
839 tdm_vblank_get_name(tdm_vblank *vblank, const char **name)
840 {
841         tdm_private_vblank *private_vblank = vblank;
842
843         TDM_RETURN_VAL_IF_FAIL(tdm_vblank_is_valid(vblank), TDM_ERROR_INVALID_PARAMETER);
844         TDM_RETURN_VAL_IF_FAIL(name != NULL, TDM_ERROR_INVALID_PARAMETER);
845
846         *name = (const char*)private_vblank->name;
847
848         return TDM_ERROR_NONE;
849 }
850
851 EXTERN tdm_error
852 tdm_vblank_set_fps(tdm_vblank *vblank, unsigned int fps)
853 {
854         tdm_private_vblank *private_vblank = vblank;
855
856         TDM_RETURN_VAL_IF_FAIL(tdm_vblank_is_valid(vblank), TDM_ERROR_INVALID_PARAMETER);
857         TDM_RETURN_VAL_IF_FAIL(fps > 0, TDM_ERROR_INVALID_PARAMETER);
858
859         if (private_vblank->fps_fixed) {
860                 VIN("fps(%d) can't be changed", private_vblank->fps);
861                 return TDM_ERROR_NONE;
862         }
863
864         private_vblank->fps_changeable = 0;
865
866         if (private_vblank->fps == fps)
867                 return TDM_ERROR_NONE;
868
869         private_vblank->fps = fps;
870         private_vblank->check_HW_or_SW = 1;
871
872         VIN("fps(%d) changed", fps);
873
874         return TDM_ERROR_NONE;
875 }
876
877 EXTERN tdm_error
878 tdm_vblank_get_fps(tdm_vblank *vblank, unsigned int *fps)
879 {
880         tdm_private_vblank *private_vblank = vblank;
881
882         TDM_RETURN_VAL_IF_FAIL(tdm_vblank_is_valid(vblank), TDM_ERROR_INVALID_PARAMETER);
883         TDM_RETURN_VAL_IF_FAIL(fps != NULL, TDM_ERROR_INVALID_PARAMETER);
884
885         *fps = private_vblank->fps;
886
887         return TDM_ERROR_NONE;
888 }
889
890 EXTERN tdm_error
891 tdm_vblank_set_fixed_fps(tdm_vblank *vblank, unsigned int fps)
892 {
893         tdm_private_vblank *private_vblank = vblank;
894
895         TDM_RETURN_VAL_IF_FAIL(tdm_vblank_is_valid(vblank), TDM_ERROR_INVALID_PARAMETER);
896         TDM_RETURN_VAL_IF_FAIL(fps > 0, TDM_ERROR_INVALID_PARAMETER);
897
898         private_vblank->fps_changeable = 0;
899         private_vblank->fps_fixed = 1;
900
901         if (private_vblank->fps == fps)
902                 return TDM_ERROR_NONE;
903
904         private_vblank->fps = fps;
905         private_vblank->check_HW_or_SW = 1;
906
907         VIN("fps(%d) fixed", fps);
908
909         return TDM_ERROR_NONE;
910 }
911
912 EXTERN tdm_error
913 tdm_vblank_ignore_global_fps(tdm_vblank *vblank, unsigned int ignore)
914 {
915         tdm_private_vblank *private_vblank = vblank;
916
917         TDM_RETURN_VAL_IF_FAIL(tdm_vblank_is_valid(vblank), TDM_ERROR_INVALID_PARAMETER);
918
919         if (private_vblank->ignore_global_fps == ignore)
920                 return TDM_ERROR_NONE;
921
922         private_vblank->ignore_global_fps = ignore;
923         private_vblank->check_HW_or_SW = 1;
924
925         VIN("ignore_global_fps(%d)", private_vblank->ignore_global_fps);
926
927         return TDM_ERROR_NONE;
928 }
929
930 EXTERN tdm_error
931 tdm_vblank_set_offset(tdm_vblank *vblank, int offset)
932 {
933         tdm_private_vblank *private_vblank = vblank;
934
935         TDM_RETURN_VAL_IF_FAIL(tdm_vblank_is_valid(vblank), TDM_ERROR_INVALID_PARAMETER);
936
937         if (private_vblank->offset == offset)
938                 return TDM_ERROR_NONE;
939
940         private_vblank->offset = offset;
941         private_vblank->check_HW_or_SW = 1;
942
943         VIN("offset(%d)", private_vblank->offset);
944
945         return TDM_ERROR_NONE;
946 }
947
948 EXTERN tdm_error
949 tdm_vblank_get_offset(tdm_vblank *vblank, int *offset)
950 {
951         tdm_private_vblank *private_vblank = vblank;
952
953         TDM_RETURN_VAL_IF_FAIL(tdm_vblank_is_valid(vblank), TDM_ERROR_INVALID_PARAMETER);
954         TDM_RETURN_VAL_IF_FAIL(offset != NULL, TDM_ERROR_INVALID_PARAMETER);
955
956         *offset = private_vblank->offset;
957
958         return TDM_ERROR_NONE;
959 }
960
961 EXTERN tdm_error
962 tdm_vblank_set_enable_fake(tdm_vblank *vblank, unsigned int enable_fake)
963 {
964         tdm_private_vblank *private_vblank = vblank;
965
966         TDM_RETURN_VAL_IF_FAIL(tdm_vblank_is_valid(vblank), TDM_ERROR_INVALID_PARAMETER);
967
968         if (private_vblank->enable_fake == enable_fake)
969                 return TDM_ERROR_NONE;
970
971         private_vblank->enable_fake = enable_fake;
972
973         VIN("enable_fake(%d)", private_vblank->enable_fake);
974
975         return TDM_ERROR_NONE;
976 }
977
978 EXTERN tdm_error
979 tdm_vblank_get_enable_fake(tdm_vblank *vblank, unsigned int *enable_fake)
980 {
981         tdm_private_vblank *private_vblank = vblank;
982
983         TDM_RETURN_VAL_IF_FAIL(tdm_vblank_is_valid(vblank), TDM_ERROR_INVALID_PARAMETER);
984         TDM_RETURN_VAL_IF_FAIL(enable_fake != NULL, TDM_ERROR_INVALID_PARAMETER);
985
986         *enable_fake = private_vblank->enable_fake;
987
988         return TDM_ERROR_NONE;
989 }
990
991 static tdm_error
992 _tdm_vblank_timeout_timer_cb(void *user_data)
993 {
994         tdm_private_vblank *private_vblank = user_data;
995         tdm_vblank_wait_info *w = NULL;
996         pid_t pid;
997         const char *proc_name;
998
999         TDM_RETURN_VAL_IF_FAIL(private_vblank != NULL, TDM_ERROR_OPERATION_FAILED);
1000
1001         _tdm_vblank_get_client_information(private_vblank, &pid, &proc_name);
1002
1003         VER("TDM vblank TIMEOUT!! (pid: %u, name: %s)", pid, proc_name);
1004         VER("quotient(%u) last_seq(%u) last_time(%.6f)", private_vblank->quotient, private_vblank->last_seq, private_vblank->last_time);
1005
1006         LIST_FOR_EACH_ENTRY(w, &private_vblank->HW_wait_list, link) {
1007                 VER("wait_info(%p) req_time(%.6f) target_seq(%u) interval(%u) hw_interval(%d)",
1008                         w, w->req_time, w->target_seq, w->interval, w->hw_interval);
1009                 tdm_output_vblank_print_wait_information(private_vblank->output, w);
1010         }
1011
1012         LIST_FOR_EACH_ENTRY(w, &private_vblank->SW_wait_list, link) {
1013                 VER("wait_info(%p) req_time(%.6f) target_time(%.6f) target_seq(%u) interval(%u)",
1014                         w, w->req_time, w->target_time, w->target_seq, w->interval);
1015         }
1016
1017         return TDM_ERROR_NONE;
1018 }
1019
1020 static void
1021 _tdm_vblank_timeout_timer_update(tdm_private_vblank *private_vblank, int ms_delay)
1022 {
1023         tdm_error ret;
1024
1025         if (!private_vblank->timeout_timer) {
1026                 private_vblank->timeout_timer =
1027                         tdm_event_loop_add_timer_handler(private_vblank->dpy,
1028                                                                                          _tdm_vblank_timeout_timer_cb,
1029                                                                                          private_vblank,
1030                                                                                          &ret);
1031                 if (!private_vblank->timeout_timer) {
1032                         VER("couldn't add timer");
1033                         return;
1034                 }
1035                 VIN("Create Timeout timer");
1036         }
1037
1038         ret = tdm_event_loop_source_timer_update(private_vblank->timeout_timer, ms_delay);
1039         if (ret != TDM_ERROR_NONE) {
1040                 VER("couldn't update timer");
1041                 return;
1042         }
1043
1044         if (ms_delay != 0)
1045                 VDB("timeout timer updated");
1046         else
1047                 VDB("timeout timer disabled");
1048 }
1049
1050 static tdm_error
1051 _tdm_vblank_sw_timer_update(tdm_private_vblank *private_vblank)
1052 {
1053         tdm_vblank_wait_info *first_wait_info = NULL;
1054         double curr, target;
1055         int ms_delay;
1056         tdm_error ret;
1057
1058         if (LIST_IS_EMPTY(&private_vblank->SW_wait_list)) {
1059                 VER("no wait_info");
1060                 return TDM_ERROR_OPERATION_FAILED;
1061         }
1062
1063         first_wait_info = container_of(private_vblank->SW_wait_list.next, first_wait_info, link);
1064         curr = tdm_helper_get_time();
1065         target = first_wait_info->target_time;
1066
1067         /* ms_delay should be more that 1 */
1068         if (target < curr)
1069                 ms_delay = 1;
1070         else
1071                 ms_delay = ceil((target - curr) * 1000.0);
1072
1073         if (ms_delay < 1)
1074                 ms_delay = 1;
1075
1076         if (ms_delay > 5000)
1077                 VER("wait(%p) curr(%.6f) target(%.6f) ms_delay(%d)", first_wait_info, curr, target, ms_delay);
1078         else
1079                 VDB("wait(%p) curr(%.6f) target(%.6f) ms_delay(%d)", first_wait_info, curr, target, ms_delay);
1080
1081         tdm_display_lock(private_vblank->dpy);
1082
1083         if (!private_vblank->SW_timer) {
1084                 private_vblank->SW_timer =
1085                         tdm_event_loop_add_timer_handler(private_vblank->dpy,
1086                                                                                          _tdm_vblank_cb_vblank_SW,
1087                                                                                          private_vblank,
1088                                                                                          &ret);
1089                 if (!private_vblank->SW_timer) {
1090                         tdm_display_unlock(private_vblank->dpy);
1091                         VER("couldn't add timer");
1092                         return ret;
1093                 }
1094                 VIN("Create SW timer");
1095         }
1096
1097         private_vblank->last_interval = ms_delay;
1098
1099         ret = tdm_event_loop_source_timer_update(private_vblank->SW_timer, ms_delay);
1100         if (ret != TDM_ERROR_NONE) {
1101                 /* LCOV_EXCL_START */
1102                 tdm_display_unlock(private_vblank->dpy);
1103                 VER("couldn't update timer");
1104                 return ret;
1105                 /* LCOV_EXCL_STOP */
1106         }
1107
1108         tdm_display_unlock(private_vblank->dpy);
1109
1110         return TDM_ERROR_NONE;
1111 }
1112
1113 static void
1114 _tdm_vblank_cb_vblank_HW(tdm_output *output, unsigned int sequence,
1115                                                  unsigned int tv_sec, unsigned int tv_usec,
1116                                                  void *user_data)
1117 {
1118         tdm_vblank_wait_info *wait_info = user_data;
1119         tdm_private_vblank *private_vblank;
1120
1121         if (!_tdm_vblank_check_valid_wait(wait_info)) {
1122                 TDM_ERR("can't find wait(%p) from valid_wait_list", wait_info);
1123                 return;
1124         }
1125
1126         private_vblank = wait_info->private_vblank;
1127         TDM_RETURN_IF_FAIL(tdm_vblank_is_valid(private_vblank));
1128
1129         if (!_tdm_vblank_find_wait(wait_info, &private_vblank->HW_wait_list)) {
1130                 VER("can't find wait(%p)", wait_info);
1131                 return;
1132         }
1133
1134         if (wait_info->type == VBLANK_TYPE_HW_SW) {
1135                 tdm_error ret;
1136
1137                 LIST_DEL(&wait_info->link);
1138
1139                 /* kernel sends the wrong time of first vblank event. and the time of
1140                  * second vblank is correct.
1141                  */
1142                 wait_info->target_time = TDM_TIME(tv_sec, tv_usec);
1143                 wait_info->target_time += (((double)private_vblank->offset) / 1000.0);
1144
1145                 _tdm_vblank_insert_wait(wait_info, &private_vblank->SW_wait_list);
1146
1147                 ret = _tdm_vblank_sw_timer_update(private_vblank);
1148
1149                 /* wait_info will be freed in _tdm_vblank_cb_vblank_SW() */
1150                 if (ret == TDM_ERROR_NONE) {
1151                         VIN("wait(%p) SW timer", wait_info);
1152                         return;
1153                 }
1154
1155                 VER("couldn't update sw timer");
1156         }
1157
1158         tdm_display_lock(private_vblank->dpy);
1159         _tdm_vblank_timeout_timer_update(private_vblank, 0);
1160         tdm_display_unlock(private_vblank->dpy);
1161
1162         LIST_DEL(&wait_info->link);
1163         _tdm_vblank_valid_list_del(&wait_info->valid_link);
1164
1165         /* tv_sec & tv_usec shouldn't be zero. But sometimes they are zero in some hardware.
1166          * We need to prohibit that last_time becomes zero because "last_time == 0" means
1167          * that a tdm_vblank object is just created and doesn't have the first vblank event.
1168          * If last_time becomes 0, it would make issue.
1169          */
1170         if (tv_sec == 0 && tv_usec == 0) {
1171                 double curr = tdm_helper_get_time();
1172                 tv_sec = TDM_TIME_SEC(curr);
1173                 tv_usec = TDM_TIME_USEC(curr);
1174         }
1175
1176         private_vblank->last_seq = wait_info->target_seq;
1177         private_vblank->last_time = TDM_TIME(tv_sec, tv_usec);
1178
1179         VDB("wait(%p) last(%.6f) sequence(%u) done", wait_info, private_vblank->last_time, wait_info->target_seq);
1180
1181         if (tdm_ttrace_module & TDM_TTRACE_VBLANK)
1182                 TDM_TRACE_ASYNC_END((int)wait_info->req_time, "TDM_Vblank:%u", (unsigned int)private_vblank->stamp);
1183
1184         if (wait_info->func)
1185                 wait_info->func(private_vblank, TDM_ERROR_NONE, wait_info->target_seq,
1186                                                 tv_sec, tv_usec, wait_info->user_data);
1187
1188         free(wait_info);
1189 }
1190
1191 static tdm_error
1192 _tdm_vblank_wait_HW(tdm_vblank_wait_info *wait_info)
1193 {
1194         tdm_private_vblank *private_vblank = wait_info->private_vblank;
1195         int hw_interval;
1196         tdm_error ret;
1197
1198         if (private_vblank->last_type != VBLANK_EVENT_TYPE_HW) {
1199                 VIN("Use HW vblank");
1200                 private_vblank->last_type = VBLANK_EVENT_TYPE_HW;
1201         }
1202
1203         _tdm_vblank_insert_wait(wait_info, &private_vblank->HW_wait_list);
1204
1205         if (private_vblank->last_time == 0) {
1206                 hw_interval = wait_info->interval * private_vblank->quotient;
1207
1208                 /* SW vblank starts from now. SW vblank doesn't need to be aligned with HW vblank. */
1209                 private_vblank->last_seq = 0;
1210                 private_vblank->last_time = tdm_helper_get_time();
1211
1212                 /* +1 ms to call the handler ASAP at the first. no matter for SW timer. */
1213                 wait_info->target_seq = 1;
1214
1215                 VDB("wait(%p) last(%.6f) hw_itvl(%d) targ_seq(%u)",
1216                         wait_info, private_vblank->last_time, hw_interval, wait_info->target_seq);
1217         } else {
1218                 double last, prev, req, curr, target;
1219                 unsigned int skip;
1220
1221                 last = private_vblank->last_time;
1222                 req = wait_info->req_time;
1223
1224                 /* make sure that req time is bigger than last. */
1225                 if (req < last)
1226                         req = last;
1227
1228                 skip = (unsigned int)((req - last) / private_vblank->vblank_gap + TDM_TIME_MARGIN);
1229                 prev = last + private_vblank->vblank_gap * skip;
1230
1231                 curr = tdm_helper_get_time();
1232                 target = last;
1233                 while (target < curr)
1234                         target += (private_vblank->vblank_gap * wait_info->interval);
1235
1236                 hw_interval = (unsigned int)((target - curr) / private_vblank->HW_vblank_gap + TDM_TIME_MARGIN) + 1;
1237
1238                 wait_info->target_seq = private_vblank->last_seq;
1239                 wait_info->target_seq += (unsigned int)((target - last) / private_vblank->vblank_gap + TDM_TIME_MARGIN);
1240
1241                 if (hw_interval > 300)
1242                         VER("wait(%p) last(%.6f) req(%.6f) prev(%.6f) curr(%.6f) targ(%.6f,%.6f) skip(%u) hw_itvl(%d) targ_seq(%u)",
1243                                 wait_info, last, req - last, prev - last, curr - last, target, target - last,
1244                                 skip, hw_interval, wait_info->target_seq);
1245                 else
1246                         VDB("wait(%p) last(%.6f) req(%.6f) prev(%.6f) curr(%.6f) targ(%.6f,%.6f) skip(%u) hw_itvl(%d) targ_seq(%u)",
1247                                 wait_info, last, req - last, prev - last, curr - last, target, target - last,
1248                                 skip, hw_interval, wait_info->target_seq);
1249         }
1250
1251         private_vblank->last_interval = hw_interval;
1252         wait_info->hw_interval = hw_interval;
1253
1254         if (tdm_ttrace_module & TDM_TTRACE_VBLANK)
1255                 TDM_TRACE_ASYNC_BEGIN((int)wait_info->req_time, "TDM_Vblank:%u", (unsigned int)private_vblank->stamp);
1256
1257         if (private_vblank->add_front)
1258                 ret = tdm_output_wait_vblank_add_front(private_vblank->output, hw_interval, 0,
1259                                                                                            _tdm_vblank_cb_vblank_HW, wait_info);
1260         else
1261                 ret = tdm_output_wait_vblank(private_vblank->output, hw_interval, 0,
1262                                                                          _tdm_vblank_cb_vblank_HW, wait_info);
1263
1264         if (ret != TDM_ERROR_NONE) {
1265                 LIST_DEL(&wait_info->link);
1266                 return ret;
1267         }
1268
1269         VDB("wait(%p) waiting", wait_info);
1270
1271         return TDM_ERROR_NONE;
1272 }
1273
1274 static tdm_error
1275 _tdm_vblank_cb_vblank_SW(void *user_data)
1276 {
1277         tdm_private_vblank *private_vblank = user_data;
1278
1279         TDM_RETURN_VAL_IF_FAIL(tdm_vblank_is_valid(private_vblank), TDM_ERROR_OPERATION_FAILED);
1280
1281         return tdm_vblank_cb_vblank_SW(private_vblank, 0);
1282 }
1283
1284 INTERN tdm_error
1285 tdm_vblank_cb_vblank_SW(tdm_vblank *vblank, double vblank_stamp)
1286 {
1287         tdm_private_vblank *private_vblank;
1288         tdm_vblank_wait_info *first_wait_info = NULL, *w = NULL, *ww = NULL;
1289
1290         TDM_RETURN_VAL_IF_FAIL(vblank || vblank_stamp > 0, TDM_ERROR_INVALID_PARAMETER);
1291
1292         if (vblank)
1293                 private_vblank = vblank;
1294         else {
1295                 private_vblank = _tdm_vblank_find(vblank_stamp);
1296                 if (!private_vblank) {
1297                         TDM_ERR("can't find vblank(%.0f) from valid_list", vblank_stamp);
1298                         return TDM_ERROR_NONE;
1299                 }
1300         }
1301
1302         if (private_vblank->owner_tid != syscall(SYS_gettid)) {
1303                 tdm_thread_cb_vblank_sw vblank_sw;
1304                 tdm_private_display *private_display = private_vblank->dpy;
1305                 tdm_error ret;
1306
1307                 vblank_sw.base.type = TDM_THREAD_CB_VBLANK_SW;
1308                 vblank_sw.base.length = sizeof vblank_sw;
1309                 vblank_sw.vblank_stamp = private_vblank->stamp;
1310
1311                 ret = tdm_thread_send_cb(private_display->private_loop, &vblank_sw.base);
1312                 TDM_WARNING_IF_FAIL(ret == TDM_ERROR_NONE);
1313
1314                 return TDM_ERROR_NONE;
1315         }
1316
1317         if (LIST_IS_EMPTY(&private_vblank->SW_wait_list)) {
1318                 VER("no wait_info");
1319                 return TDM_ERROR_OPERATION_FAILED;
1320         }
1321
1322         if (!LIST_IS_EMPTY(&private_vblank->HW_wait_list))
1323                 TDM_NEVER_GET_HERE();
1324
1325         first_wait_info = container_of(private_vblank->SW_wait_list.next, first_wait_info, link);
1326         TDM_RETURN_VAL_IF_FAIL(first_wait_info != NULL, TDM_ERROR_OPERATION_FAILED);
1327
1328         _tdm_vblank_timeout_timer_update(private_vblank, 0);
1329
1330         if (private_vblank->last_seq >= first_wait_info->target_seq)
1331                 TDM_ERR("last_seq(%u) target_seq(%u)", private_vblank->last_seq, first_wait_info->target_seq);
1332
1333         private_vblank->last_seq = first_wait_info->target_seq;
1334         private_vblank->last_time = first_wait_info->target_time;
1335
1336         VDB("wait(%p) last(%.6f) sequence(%u) done", first_wait_info, private_vblank->last_time, first_wait_info->target_seq);
1337
1338         LIST_FOR_EACH_ENTRY_SAFE(w, ww, &private_vblank->SW_wait_list, link) {
1339                 if (w->target_time != first_wait_info->target_time)
1340                         break;
1341
1342                 LIST_DEL(&w->link);
1343                 _tdm_vblank_valid_list_del(&w->valid_link);
1344
1345                 if (w->func) {
1346                         tdm_display_unlock(private_vblank->dpy);
1347                         w->func(private_vblank, TDM_ERROR_NONE, w->target_seq,
1348                                         TDM_TIME_SEC(w->target_time), TDM_TIME_USEC(w->target_time),
1349                                         w->user_data);
1350                         tdm_display_lock(private_vblank->dpy);
1351                 }
1352
1353                 free(w);
1354         }
1355
1356         return TDM_ERROR_NONE;
1357 }
1358
1359 static tdm_error
1360 _tdm_vblank_wait_SW(tdm_vblank_wait_info *wait_info)
1361 {
1362         tdm_private_vblank *private_vblank = wait_info->private_vblank;
1363         tdm_error ret;
1364
1365         if (private_vblank->last_type != VBLANK_EVENT_TYPE_SW) {
1366                 VIN("Use SW vblank");
1367                 private_vblank->last_type = VBLANK_EVENT_TYPE_SW;
1368         }
1369
1370         if (private_vblank->last_time == 0) {
1371                 /* SW vblank starts from now. SW vblank doesn't need to be aligned with HW vblank. */
1372                 private_vblank->last_seq = 0;
1373                 private_vblank->last_time = tdm_helper_get_time();
1374
1375                 /* +1 ms to call the handler ASAP at the first. no matter for SW timer. */
1376                 wait_info->target_seq = 1;
1377                 wait_info->target_time = private_vblank->last_time + 0.001;
1378
1379                 VDB("wait(%p) last(%.6f) target(%.6f) target sequence(%u)",
1380                         wait_info, private_vblank->last_time, wait_info->target_time, wait_info->target_seq);
1381         } else {
1382                 double last, prev, req, curr, target;
1383                 unsigned int skip;
1384
1385                 last = private_vblank->last_time;
1386                 req = wait_info->req_time;
1387
1388                 /* make sure that req time is bigger than last. */
1389                 if (req < last)
1390                         req = last;
1391
1392                 skip = (unsigned int)((req - last) / private_vblank->vblank_gap + TDM_TIME_MARGIN);
1393                 prev = last + private_vblank->vblank_gap * skip;
1394
1395                 curr = tdm_helper_get_time();
1396                 target = prev + private_vblank->vblank_gap * wait_info->interval;
1397
1398                 while (target < curr)
1399                         target += private_vblank->vblank_gap;
1400
1401                 wait_info->target_seq = private_vblank->last_seq;
1402                 wait_info->target_seq += (unsigned int)((target - last) / private_vblank->vblank_gap + TDM_TIME_MARGIN);
1403
1404                 wait_info->target_time = target;
1405
1406                 VDB("wait(%p) last(%.6f) req(%.6f) prev(%.6f) curr(%.6f) targ(%.6f,%.6f) skip(%u) targ_seq(%u)",
1407                         wait_info, last, req - last, prev - last, curr - last,
1408                         target, target - last, skip, wait_info->target_seq);
1409         }
1410
1411         _tdm_vblank_insert_wait(wait_info, &private_vblank->SW_wait_list);
1412
1413         ret = _tdm_vblank_sw_timer_update(private_vblank);
1414         if (ret != TDM_ERROR_NONE) {
1415                 /* LCOV_EXCL_START */
1416                 LIST_DEL(&wait_info->link);
1417                 VER("couldn't update sw timer");
1418                 return ret;
1419                 /* LCOV_EXCL_STOP */
1420         }
1421
1422         return TDM_ERROR_NONE;
1423 }
1424
1425 EXTERN tdm_error
1426 tdm_vblank_wait(tdm_vblank *vblank, unsigned int req_sec, unsigned int req_usec,
1427                                 unsigned int interval, tdm_vblank_handler func, void *user_data)
1428 {
1429         tdm_private_vblank *private_vblank = vblank;
1430         tdm_vblank_wait_info *wait_info;
1431         tdm_output_dpms dpms = TDM_OUTPUT_DPMS_OFF;
1432         unsigned int fps;
1433         tdm_error ret;
1434
1435         TDM_RETURN_VAL_IF_FAIL(tdm_vblank_is_valid(vblank), TDM_ERROR_INVALID_PARAMETER);
1436         TDM_RETURN_VAL_IF_FAIL(func != NULL, TDM_ERROR_INVALID_PARAMETER);
1437
1438         if (private_vblank->in_create_handler) {
1439                 TDM_ERR("NOT allowed to be called in a create handler");
1440                 return TDM_ERROR_BAD_REQUEST;
1441         }
1442
1443         if (private_vblank->owner_tid != syscall(SYS_gettid)) {
1444                 TDM_ERR("SHOULD be called in the owner thread(%d)", (int)private_vblank->owner_tid);
1445                 return TDM_ERROR_BAD_REQUEST;
1446         }
1447
1448         tdm_output_get_dpms(private_vblank->output, &dpms);
1449
1450         if (!private_vblank->enable_fake) {
1451                 if (private_vblank->connection == TDM_OUTPUT_CONN_STATUS_DISCONNECTED) {
1452                         VER("can't wait a vblank: output disconnected");
1453                         return TDM_ERROR_OUTPUT_DISCONNECTED;
1454                 }
1455                 if (TDM_OUTPUT_DPMS_VSYNC_IS_OFF(dpms)) {
1456                         VER("can't wait a vblank: DPMS %s", tdm_dpms_str(dpms));
1457                         return TDM_ERROR_DPMS_OFF;
1458                 }
1459         }
1460
1461         wait_info = calloc(1, sizeof * wait_info);
1462         if (!wait_info) {
1463                 /* LCOV_EXCL_START */
1464                 VER("alloc failed");
1465                 return TDM_ERROR_OUT_OF_MEMORY;
1466                 /* LCOV_EXCL_STOP */
1467         }
1468         _tdm_vblank_update_output_info(private_vblank);
1469
1470         /* set request time to current time if 0. This function seems to be called in server side. */
1471         if (req_sec == 0 && req_usec == 0) {
1472                 double curr = tdm_helper_get_time();
1473                 req_sec = TDM_TIME_SEC(curr);
1474                 req_usec = TDM_TIME_USEC(curr);
1475         }
1476
1477         LIST_INITHEAD(&wait_info->link);
1478
1479         _tdm_vblank_valid_list_add(&wait_info->valid_link, &valid_wait_list);
1480
1481         wait_info->stamp = ++stamp;
1482         wait_info->req_time = TDM_TIME(req_sec, req_usec);
1483         wait_info->interval = interval;
1484         wait_info->func = func;
1485         wait_info->user_data = user_data;
1486         wait_info->private_vblank = private_vblank;
1487
1488         if (private_vblank->ignore_global_fps ||
1489                 vblank_global_fps == 0 ||
1490                 private_vblank->fps < vblank_global_fps)
1491                 fps = private_vblank->fps;
1492         else
1493                 fps = vblank_global_fps;
1494
1495         if (private_vblank->check_HW_or_SW) {
1496                 private_vblank->check_HW_or_SW = 0;
1497                 private_vblank->vblank_gap = 1.0 / fps;
1498                 private_vblank->quotient = private_vblank->vrefresh / fps;
1499         }
1500
1501         /* 1) if fps != factor of vrefresh, SW timer
1502          * 2) if fps == factor of vrefresh && dpms == off, SW timer (Fake HW vblank)
1503          * 2) if fps == factor of vrefresh && dpms == on && offset == 0, HW vblank
1504          * 3) if fps == factor of vrefresh && dpms == on && offset != 0, HW vblank + SW timer
1505          * In case of 1), we really don't need to align with HW vblank.
1506          */
1507         if (private_vblank->vrefresh % fps)
1508                 wait_info->type = VBLANK_TYPE_SW;
1509         else if (TDM_OUTPUT_DPMS_VSYNC_IS_OFF(dpms) ||
1510                          private_vblank->connection != TDM_OUTPUT_CONN_STATUS_MODE_SETTED)
1511                 wait_info->type = VBLANK_TYPE_SW_FAKE;
1512         else if (private_vblank->offset == 0)
1513                 wait_info->type = VBLANK_TYPE_HW;
1514         else
1515                 wait_info->type = VBLANK_TYPE_HW_SW;
1516
1517         if (wait_info->type == VBLANK_TYPE_SW || wait_info->type == VBLANK_TYPE_SW_FAKE) {
1518                 ret = _tdm_vblank_wait_SW(wait_info);
1519                 if (ret != TDM_ERROR_NONE)
1520                         TDM_ERR("_tdm_vblank_wait_SW failed: ret(%d)", ret);
1521         } else {
1522                 ret = _tdm_vblank_wait_HW(wait_info);
1523                 if (ret != TDM_ERROR_NONE)
1524                         TDM_ERR("_tdm_vblank_wait_HW failed: ret(%d)", ret);
1525
1526                 if (ret == TDM_ERROR_OUTPUT_DISCONNECTED || ret == TDM_ERROR_DPMS_OFF) {
1527                         ret = _tdm_vblank_wait_SW(wait_info);
1528                         if (ret != TDM_ERROR_NONE)
1529                                 TDM_ERR("_tdm_vblank_wait_SW failed: ret(%d)", ret);
1530                 }
1531         }
1532
1533         if (ret != TDM_ERROR_NONE) {
1534                 /* LCOV_EXCL_START */
1535                 LIST_DEL(&wait_info->link);
1536                 _tdm_vblank_valid_list_del(&wait_info->valid_link);
1537
1538                 tdm_display_lock(private_vblank->dpy);
1539                 tdm_output_remove_vblank_handler_internal(private_vblank->output, _tdm_vblank_cb_vblank_HW, wait_info);
1540                 tdm_display_unlock(private_vblank->dpy);
1541
1542                 free(wait_info);
1543                 return ret;
1544                 /* LCOV_EXCL_STOP */
1545         }
1546
1547         tdm_display_lock(private_vblank->dpy);
1548         _tdm_vblank_timeout_timer_update(private_vblank, 1000);
1549         tdm_display_unlock(private_vblank->dpy);
1550
1551         return TDM_ERROR_NONE;
1552 }
1553
1554 EXTERN tdm_error
1555 tdm_vblank_wait_seq(tdm_vblank *vblank, unsigned int req_sec, unsigned int req_usec,
1556                                         unsigned int sequence, tdm_vblank_handler func, void *user_data)
1557 {
1558         tdm_private_vblank *private_vblank = vblank;
1559         unsigned int interval;
1560
1561         TDM_RETURN_VAL_IF_FAIL(tdm_vblank_is_valid(vblank), TDM_ERROR_INVALID_PARAMETER);
1562         TDM_RETURN_VAL_IF_FAIL(func != NULL, TDM_ERROR_INVALID_PARAMETER);
1563
1564         /* if the sequence of vblank reaches the max value, sequence can be 0. */
1565
1566         if (private_vblank->last_seq == 0) {
1567                 VWR("can't calculate interval with sequence(%u)", sequence);
1568                 interval = 1;
1569         } else if (sequence > private_vblank->last_seq ||
1570                            TDM_VBLANK_SEQ_REACHED_MAX(sequence, private_vblank->last_seq)) {
1571                 double last, curr, seq_target;
1572
1573                 last = private_vblank->last_time;
1574                 curr = tdm_helper_get_time();
1575                 seq_target = last + private_vblank->vblank_gap * (sequence - private_vblank->last_seq);
1576
1577                 /* If target is old or too close(1ms) to current, we call the handler immediately.
1578                  * 2ms? it seems too much.
1579                  */
1580                 if (seq_target < curr) {
1581                         func(vblank, TDM_ERROR_NONE, sequence,
1582                                  TDM_TIME_SEC(seq_target), TDM_TIME_USEC(seq_target),
1583                                  user_data);
1584                         return TDM_ERROR_NONE;
1585                 } else if ((seq_target - curr) < 0.001) {  /* 1ms */
1586                         func(vblank, TDM_ERROR_NONE, sequence,
1587                                  TDM_TIME_SEC(curr), TDM_TIME_USEC(curr),
1588                                  user_data);
1589                         return TDM_ERROR_NONE;
1590                 }
1591
1592                 interval = (unsigned int)((seq_target - curr) / private_vblank->vblank_gap + TDM_TIME_MARGIN) + 1;
1593         } else {
1594                 /* this seems error. But we handle this like normal to avoid the unexpected error in cliend side */
1595                 VER("sequence(%u) should be over the last sequence(%u)", sequence, private_vblank->last_seq);
1596                 func(vblank, TDM_ERROR_NONE, private_vblank->last_seq,
1597                          TDM_TIME_SEC(private_vblank->last_time), TDM_TIME_USEC(private_vblank->last_time),
1598                          user_data);
1599                 return TDM_ERROR_NONE;
1600         }
1601
1602         return tdm_vblank_wait(vblank, req_sec, req_usec, interval, func, user_data);
1603 }
1604
1605 /* LCOV_EXCL_START */
1606 INTERN tdm_error
1607 tdm_vblank_set_add_front(tdm_vblank *vblank, unsigned int add_front)
1608 {
1609         tdm_private_vblank *private_vblank = vblank;
1610
1611         TDM_RETURN_VAL_IF_FAIL(tdm_vblank_is_valid(vblank), TDM_ERROR_INVALID_PARAMETER);
1612
1613         TDM_RETURN_VAL_IF_FAIL(TDM_MUTEX_IS_LOCKED(), TDM_ERROR_OPERATION_FAILED);
1614
1615         if (private_vblank->add_front == add_front)
1616                 return TDM_ERROR_NONE;
1617
1618         private_vblank->add_front = add_front;
1619
1620         return TDM_ERROR_NONE;
1621 }
1622 /* LCOV_EXCL_STOP */
1623
1624 INTERN tdm_error
1625 tdm_vblank_set_resource(tdm_vblank *vblank, struct wl_resource *resource)
1626 {
1627         tdm_private_vblank *private_vblank = vblank;
1628
1629         TDM_RETURN_VAL_IF_FAIL(tdm_vblank_is_valid(vblank), TDM_ERROR_INVALID_PARAMETER);
1630         TDM_RETURN_VAL_IF_FAIL(private_vblank->resource == NULL, TDM_ERROR_OPERATION_FAILED);
1631
1632         private_vblank->resource = resource;
1633
1634         return TDM_ERROR_NONE;
1635 }
1636
1637 INTERN double
1638 tdm_vblank_get_stamp(tdm_vblank *vblank)
1639 {
1640         tdm_private_vblank *private_vblank = vblank;
1641
1642         TDM_RETURN_VAL_IF_FAIL(tdm_vblank_is_valid(vblank), TDM_ERROR_INVALID_PARAMETER);
1643
1644         return private_vblank->stamp;
1645 }
1646
1647 static unsigned int
1648 _tdm_vblank_get_waiting_count(tdm_private_vblank *private_vblank)
1649 {
1650         tdm_vblank_wait_info *wait_info = NULL;
1651         unsigned int count = 0;
1652
1653         LIST_FOR_EACH_ENTRY(wait_info, &private_vblank->HW_wait_list, link) {
1654                 count++;
1655         }
1656
1657         LIST_FOR_EACH_ENTRY(wait_info, &private_vblank->SW_wait_list, link) {
1658                 count++;
1659         }
1660
1661         return count;
1662 }
1663
1664 static void
1665 _tdm_vblank_get_client_information(tdm_private_vblank *private_vblank, pid_t *pid, const char **name)
1666 {
1667         struct wl_client *client;
1668
1669         if (!private_vblank->resource)
1670                 goto no_client;
1671
1672         client = wl_resource_get_client(private_vblank->resource);
1673         if (!client)
1674                 goto no_client;
1675
1676         wl_client_get_credentials(client, pid, NULL, NULL);
1677         *name = tdm_server_get_client_name(*pid);
1678
1679         return;
1680
1681 no_client:
1682         *pid = 0;
1683         *name = NULL;
1684         return;
1685 }
1686
1687 /* LCOV_EXCL_START */
1688 INTERN void
1689 tdm_vblank_get_vblank_list_information(tdm_display *dpy, char *reply, int *len)
1690 {
1691         tdm_private_vblank *v = NULL;
1692         tdm_output_dpms dpms = TDM_OUTPUT_DPMS_OFF;
1693         tdm_output *output = tdm_display_get_output(dpy, 0, NULL);
1694
1695         if (output)
1696                 tdm_output_get_dpms(output, &dpms);
1697
1698         TDM_SNPRINTF(reply, len, "[Client Vblank List]\n");
1699         TDM_SNPRINTF(reply, len, "* DPMS: %s\n", tdm_dpms_str(dpms));
1700         TDM_SNPRINTF(reply, len, "* global fps: %u\n", vblank_global_fps);
1701         TDM_SNPRINTF(reply, len, "----------------------------------------------------------------------------------\n");
1702         TDM_SNPRINTF(reply, len, "Name                 Type Wait Interval Sequence Fps Ignore Offset Fake Process\n");
1703         TDM_SNPRINTF(reply, len, "----------------------------------------------------------------------------------\n");
1704
1705         pthread_mutex_lock(&valid_list_lock);
1706         LIST_FOR_EACH_ENTRY(v, &valid_vblank_list, valid_link) {
1707                 const char *proc_name = NULL;
1708                 pid_t pid = 0;
1709                 unsigned int count;
1710
1711                 _tdm_vblank_get_client_information(v, &pid, &proc_name);
1712
1713                 count = _tdm_vblank_get_waiting_count(v);
1714
1715                 TDM_SNPRINTF(reply, len, "%-8s(%p) ", v->name, v);
1716                 TDM_SNPRINTF(reply, len, "%-4s ", (v->last_type == VBLANK_EVENT_TYPE_HW) ? "HW" : "SW");
1717                 TDM_SNPRINTF(reply, len, "%-4s ", (count > 0) ? "O" : " ");
1718                 TDM_SNPRINTF(reply, len, "%-8d ", v->last_interval);
1719                 TDM_SNPRINTF(reply, len, "%-8u ", v->last_seq);
1720                 TDM_SNPRINTF(reply, len, "%-3u ", v->fps);
1721                 TDM_SNPRINTF(reply, len, "%-6u ", v->ignore_global_fps);
1722                 TDM_SNPRINTF(reply, len, "%-6d ", v->offset);
1723                 TDM_SNPRINTF(reply, len, "%-4u ", v->enable_fake);
1724                 TDM_SNPRINTF(reply, len, "%s(pid:%d)\n", (proc_name) ? proc_name : "Unknown", pid);
1725         }
1726         pthread_mutex_unlock(&valid_list_lock);
1727
1728         TDM_SNPRINTF(reply, len, "\n");
1729 }
1730 /* LCOV_EXCL_STOP */
1731