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