c3c1c23465054694cd0b8e0a37dfa4da14e941b5
[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.h"
41 #include "tdm_private.h"
42 #include "tdm_list.h"
43
44 /* CAUTION:
45  * Basically tdm vblank doesn't care about thread things.
46  * However, to use tdm_event_loop_xxx functions, have to use the internal function.
47  * So need to lock/unlock the mutex of private_display. And valid_vblank_list and
48  * valid_wait_list should be protected by valid_list_lock because tdm_vblank can
49  * be used in multi-thread.
50  */
51
52 /* TDM vblank
53  * - aligned by HW vblank
54  * - use a tdm_event_loop_source object only.
55  */
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...)   TDM_INFO("[%p] "fmt, private_vblank, ##arg)
73 #define VDB(fmt, arg...)   TDM_DBG("[%p] "fmt, private_vblank, ##arg)
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 struct _tdm_vblank_wait_info tdm_vblank_wait_info;
83
84 typedef struct _tdm_private_vblank {
85         struct list_head valid_link;
86
87         double stamp;
88         pid_t owner_tid;
89
90         tdm_display *dpy;
91         tdm_output *output;
92         tdm_output_dpms dpms;
93         unsigned int vrefresh;
94
95         unsigned int check_HW_or_SW;
96         char name[TDM_NAME_LEN];
97         unsigned int fps;
98         int offset;
99         unsigned int enable_fake;
100
101         double vblank_gap;
102         unsigned int quotient;
103
104         unsigned int last_seq;
105         double last_time;
106
107         unsigned int add_front;
108         struct wl_resource *resource;
109
110         /* for HW */
111         double HW_vblank_gap;
112         struct list_head HW_wait_list;
113
114         /* for SW */
115         tdm_event_loop_source *SW_timer;
116         struct list_head SW_wait_list;
117 } tdm_private_vblank;
118
119 struct _tdm_vblank_wait_info {
120         struct list_head link;
121         struct list_head valid_link;
122
123         double stamp;
124
125         double req_time;
126         unsigned int interval;
127
128         tdm_vblank_handler func;
129         void *user_data;
130         tdm_private_vblank *private_vblank;
131
132         tdm_vblank_wait_type type;
133
134         double target_time;
135         unsigned int target_seq;
136 };
137
138 /* valid_vblank_list and valid_wait_list should be protected by valid_list_lock because
139  * tdm_vblank can be used in multi-thread.
140  */
141 static pthread_mutex_t valid_list_lock;
142 static struct list_head valid_vblank_list;
143 static struct list_head valid_wait_list;
144 static unsigned int vblank_list_inited;
145 static double stamp = 0;
146
147 static tdm_error _tdm_vblank_cb_vblank_SW(void *user_data);
148 static tdm_error _tdm_vblank_wait_SW(tdm_vblank_wait_info *wait_info);
149
150 #if 0
151 static void
152 _print_list(struct list_head *list)
153 {
154         tdm_vblank_wait_info *w = NULL;
155
156         LIST_FOR_EACH_ENTRY(w, list, link) {
157                 printf(" %d", w->interval);
158         }
159         printf("\n");
160 }
161 #endif
162
163 static void
164 _tdm_vblank_valid_list_add(struct list_head *valid_link, struct list_head *valid_list)
165 {
166         pthread_mutex_lock(&valid_list_lock);
167         LIST_ADDTAIL(valid_link, valid_list);
168         pthread_mutex_unlock(&valid_list_lock);
169 }
170
171 static void
172 _tdm_vblank_valid_list_del(struct list_head *valid_link)
173 {
174         pthread_mutex_lock(&valid_list_lock);
175         LIST_DEL(valid_link);
176         pthread_mutex_unlock(&valid_list_lock);
177 }
178
179 static inline tdm_private_vblank*
180 _tdm_vblank_find(double vblank_stamp)
181 {
182         tdm_private_vblank *v = NULL;
183
184         if (!vblank_stamp)
185                 return 0;
186
187         pthread_mutex_lock(&valid_list_lock);
188         LIST_FOR_EACH_ENTRY(v, &valid_vblank_list, valid_link) {
189                 if (v->stamp == vblank_stamp) {
190                         pthread_mutex_unlock(&valid_list_lock);
191                         return v;
192                 }
193         }
194         pthread_mutex_unlock(&valid_list_lock);
195
196         return 0;
197 }
198
199 static inline unsigned int
200 _tdm_vblank_check_valid_wait(tdm_vblank_wait_info *wait_info)
201 {
202         tdm_vblank_wait_info *w = NULL;
203
204         if (!wait_info)
205                 return 0;
206
207         pthread_mutex_lock(&valid_list_lock);
208         LIST_FOR_EACH_ENTRY(w, &valid_wait_list, valid_link) {
209                 if (w->stamp == wait_info->stamp) {
210                         pthread_mutex_unlock(&valid_list_lock);
211                         return 1;
212                 }
213         }
214         pthread_mutex_unlock(&valid_list_lock);
215
216         return 0;
217 }
218
219 static inline unsigned int
220 _tdm_vblank_find_wait(tdm_vblank_wait_info *wait_info, struct list_head *list)
221 {
222         tdm_vblank_wait_info *w = NULL;
223
224         if (!wait_info)
225                 return 0;
226
227         LIST_FOR_EACH_ENTRY(w, list, link) {
228                 if (w->stamp == wait_info->stamp)
229                         return 1;
230         }
231
232         return 0;
233 }
234
235 static inline void
236 _tdm_vblank_insert_wait(tdm_vblank_wait_info *wait_info, struct list_head *list)
237 {
238         tdm_vblank_wait_info *w = NULL;
239         tdm_vblank_wait_info *found = NULL;
240
241         if (LIST_IS_EMPTY(list)) {
242                 LIST_ADDTAIL(&wait_info->link, list);
243                 return;
244         }
245
246         LIST_FOR_EACH_ENTRY(w, list, link) {
247                 if (wait_info->type == VBLANK_TYPE_SW) {
248                         if (wait_info->target_time == 0)
249                                 TDM_NEVER_GET_HERE();
250                         if (w->target_time <= wait_info->target_time) {
251                                 found = w;
252                                 continue;
253                         }
254                 } else {
255                         if (w->interval <= wait_info->interval) {
256                                 found = w;
257                                 continue;
258                         }
259                 }
260         }
261
262         if (found)
263                 LIST_ADD(&wait_info->link, &found->link);
264         else
265                 LIST_ADDTAIL(&wait_info->link, list->next);
266 }
267
268 static void
269 _tdm_vblank_change_to_SW(tdm_private_vblank *private_vblank)
270 {
271         tdm_vblank_wait_info *w = NULL, *ww = NULL;
272
273         LIST_FOR_EACH_ENTRY_SAFE(w, ww, &private_vblank->HW_wait_list, link) {
274                 LIST_DEL(&w->link);
275                 w->type = VBLANK_TYPE_SW_FAKE;
276                 _tdm_vblank_wait_SW(w);
277         }
278 }
279
280 static void
281 _tdm_vblank_free_HW_wait(tdm_private_vblank *private_vblank, tdm_error error, unsigned int call_cb)
282 {
283         tdm_vblank_wait_info *w = NULL, *ww = NULL;
284
285         LIST_FOR_EACH_ENTRY_SAFE(w, ww, &private_vblank->HW_wait_list, link) {
286                 LIST_DEL(&w->link);
287                 _tdm_vblank_valid_list_del(&w->valid_link);
288
289                 if (call_cb && w->func)
290                         w->func(private_vblank, error, 0, 0, 0, w->user_data);
291
292                 free(w);
293         }
294 }
295
296 static void
297 _tdm_vblank_cb_output_change(tdm_output *output, tdm_output_change_type type,
298                                                          tdm_value value, void *user_data)
299 {
300         tdm_private_vblank *private_vblank = user_data;
301
302         TDM_RETURN_IF_FAIL(private_vblank != NULL);
303
304         switch (type) {
305         case TDM_OUTPUT_CHANGE_DPMS:
306                 if (private_vblank->dpms == value.u32)
307                         break;
308                 VIN("dpms %s", tdm_dpms_str(value.u32));
309                 private_vblank->dpms = value.u32;
310                 private_vblank->check_HW_or_SW = 1;
311                 if (private_vblank->dpms != TDM_OUTPUT_DPMS_ON) {
312                         if (private_vblank->enable_fake)
313                                 _tdm_vblank_change_to_SW(private_vblank);
314                         else
315                                 _tdm_vblank_free_HW_wait(private_vblank, TDM_ERROR_DPMS_OFF, 1);
316                 }
317                 break;
318         case TDM_OUTPUT_CHANGE_CONNECTION:
319                 VIN("output %s", tdm_status_str(value.u32));
320                 if (value.u32 == TDM_OUTPUT_CONN_STATUS_DISCONNECTED)
321                         _tdm_vblank_free_HW_wait(private_vblank, 0, 0);
322                 break;
323         default:
324                 break;
325         }
326 }
327
328 EXTERN tdm_error
329 tdm_vblank_set_client_vblank_fps(unsigned int pid, const char *name, unsigned int fps)
330 {
331         tdm_private_vblank *v;
332
333         TDM_RETURN_VAL_IF_FAIL(pid > 0, TDM_ERROR_INVALID_PARAMETER);
334         TDM_RETURN_VAL_IF_FAIL(fps > 0, TDM_ERROR_INVALID_PARAMETER);
335
336         TDM_INFO("pid: %u, name: %s, fps: %d", pid, name, fps);
337
338         pthread_mutex_lock(&valid_list_lock);
339         LIST_FOR_EACH_ENTRY(v, &valid_vblank_list, valid_link) {
340                 struct wl_client *client;
341                 pid_t client_pid = 0;
342
343                 if (!v->resource)
344                         continue;
345
346                 client = wl_resource_get_client(v->resource);
347                 if (!client)
348                         continue;
349
350                 wl_client_get_credentials(client, &client_pid, NULL, NULL);
351
352                 if (client_pid != pid)
353                         continue;
354
355                 if (name && strncmp(name, TDM_VBLANK_DEFAULT_NAME, TDM_NAME_LEN)) {
356                         if (strncmp(v->name, name, TDM_NAME_LEN))
357                                 continue;
358                 }
359
360                 tdm_vblank_set_fps(v, fps);
361
362                 TDM_INFO("(pid:%u) '%s' fps changed: %d", pid, v->name, fps);
363         }
364         pthread_mutex_unlock(&valid_list_lock);
365
366         return TDM_ERROR_NONE;
367 }
368
369 EXTERN tdm_vblank *
370 tdm_vblank_create(tdm_display *dpy, tdm_output *output, tdm_error *error)
371 {
372         tdm_private_vblank *private_vblank;
373         const tdm_output_mode *mode = NULL;
374         tdm_output_dpms dpms = TDM_OUTPUT_DPMS_ON;
375         tdm_error ret;
376
377         TDM_RETURN_VAL_IF_FAIL_WITH_ERROR(dpy != NULL, TDM_ERROR_INVALID_PARAMETER, NULL);
378         TDM_RETURN_VAL_IF_FAIL_WITH_ERROR(output != NULL, TDM_ERROR_INVALID_PARAMETER, NULL);
379
380         if (error)
381                 *error = TDM_ERROR_NONE;
382
383         if (!vblank_list_inited) {
384                 if (pthread_mutex_init(&valid_list_lock, NULL)) {
385                         TDM_ERR("mutex init failed: %m");
386                         if (error)
387                                 *error = TDM_ERROR_OPERATION_FAILED;
388                         return NULL;
389                 }
390                 LIST_INITHEAD(&valid_vblank_list);
391                 LIST_INITHEAD(&valid_wait_list);
392                 vblank_list_inited = 1;
393         }
394
395         tdm_output_get_mode(output, &mode);
396         if (!mode) {
397                 if (error)
398                         *error = TDM_ERROR_OPERATION_FAILED;
399                 TDM_ERR("no mode");
400                 return NULL;
401         }
402
403         tdm_output_get_dpms(output, &dpms);
404
405         private_vblank = calloc(1, sizeof * private_vblank);
406         if (!private_vblank) {
407                 if (error)
408                         *error = TDM_ERROR_OUT_OF_MEMORY;
409                 VER("alloc failed");
410                 return NULL;
411         }
412
413         tdm_output_add_change_handler(output, _tdm_vblank_cb_output_change, private_vblank);
414
415         private_vblank->stamp = ++stamp;
416         private_vblank->owner_tid = syscall(SYS_gettid);
417         private_vblank->dpy = dpy;
418         private_vblank->output = output;
419         private_vblank->dpms = dpms;
420         private_vblank->vrefresh = mode->vrefresh;
421         private_vblank->HW_vblank_gap = 1.0 / private_vblank->vrefresh;
422
423         private_vblank->check_HW_or_SW = 1;
424         private_vblank->fps = mode->vrefresh;
425
426         strncpy(private_vblank->name, TDM_VBLANK_DEFAULT_NAME, TDM_NAME_LEN - 1);
427         private_vblank->name[TDM_NAME_LEN - 1] = '\0';
428
429         LIST_INITHEAD(&private_vblank->HW_wait_list);
430         LIST_INITHEAD(&private_vblank->SW_wait_list);
431
432         _tdm_vblank_valid_list_add(&private_vblank->valid_link, &valid_vblank_list);
433
434         if (tdm_debug_module & TDM_DEBUG_VBLANK)
435                 VIN("created. vrefresh(%d) dpms(%d)",
436                         private_vblank->vrefresh, private_vblank->dpms);
437
438         return (tdm_vblank *)private_vblank;
439 }
440
441 EXTERN void
442 tdm_vblank_destroy(tdm_vblank *vblank)
443 {
444         tdm_private_vblank *private_vblank = vblank;
445         tdm_vblank_wait_info *w = NULL, *ww = NULL;
446
447         if (!private_vblank)
448                 return;
449
450         _tdm_vblank_valid_list_del(&private_vblank->valid_link);
451
452         if (private_vblank->SW_timer) {
453                 tdm_display_lock(private_vblank->dpy);
454                 tdm_event_loop_source_remove(private_vblank->SW_timer);
455                 tdm_display_unlock(private_vblank->dpy);
456         }
457
458         tdm_output_remove_change_handler(private_vblank->output,
459                                                                          _tdm_vblank_cb_output_change, private_vblank);
460
461         _tdm_vblank_free_HW_wait(private_vblank, 0, 0);
462
463         LIST_FOR_EACH_ENTRY_SAFE(w, ww, &private_vblank->SW_wait_list, link) {
464                 LIST_DEL(&w->link);
465                 _tdm_vblank_valid_list_del(&w->valid_link);
466                 free(w);
467         }
468
469         if (tdm_debug_module & TDM_DEBUG_VBLANK)
470                 VIN("destroyed");
471
472         free(private_vblank);
473 }
474
475 EXTERN tdm_error
476 tdm_vblank_set_name(tdm_vblank *vblank, const char *name)
477 {
478         tdm_private_vblank *private_vblank = vblank;
479
480         TDM_RETURN_VAL_IF_FAIL(private_vblank != NULL, TDM_ERROR_INVALID_PARAMETER);
481
482         if (!name)
483                 name = TDM_VBLANK_DEFAULT_NAME;
484
485         strncpy(private_vblank->name, name, TDM_NAME_LEN - 1);
486         private_vblank->name[TDM_NAME_LEN - 1] = '\0';
487
488         if (tdm_debug_module & TDM_DEBUG_VBLANK)
489                 VIN("name(%s)", name);
490
491         return TDM_ERROR_NONE;
492 }
493
494 EXTERN tdm_error
495 tdm_vblank_get_name(tdm_vblank *vblank, const char **name)
496 {
497         tdm_private_vblank *private_vblank = vblank;
498
499         TDM_RETURN_VAL_IF_FAIL(private_vblank != NULL, TDM_ERROR_INVALID_PARAMETER);
500         TDM_RETURN_VAL_IF_FAIL(name != NULL, TDM_ERROR_INVALID_PARAMETER);
501
502         *name = (const char*)private_vblank->name;
503
504         return TDM_ERROR_NONE;
505 }
506
507 EXTERN tdm_error
508 tdm_vblank_set_fps(tdm_vblank *vblank, unsigned int fps)
509 {
510         tdm_private_vblank *private_vblank = vblank;
511
512         TDM_RETURN_VAL_IF_FAIL(private_vblank != NULL, TDM_ERROR_INVALID_PARAMETER);
513         TDM_RETURN_VAL_IF_FAIL(fps > 0, TDM_ERROR_INVALID_PARAMETER);
514
515         if (private_vblank->fps == fps)
516                 return TDM_ERROR_NONE;
517
518         private_vblank->fps = fps;
519         private_vblank->check_HW_or_SW = 1;
520
521         if (tdm_debug_module & TDM_DEBUG_VBLANK)
522                 VIN("fps(%d)", private_vblank->fps);
523
524         return TDM_ERROR_NONE;
525 }
526
527 EXTERN tdm_error
528 tdm_vblank_get_fps(tdm_vblank *vblank, unsigned int *fps)
529 {
530         tdm_private_vblank *private_vblank = vblank;
531
532         TDM_RETURN_VAL_IF_FAIL(private_vblank != NULL, TDM_ERROR_INVALID_PARAMETER);
533         TDM_RETURN_VAL_IF_FAIL(fps != NULL, TDM_ERROR_INVALID_PARAMETER);
534
535         *fps = private_vblank->fps;
536
537         return TDM_ERROR_NONE;
538 }
539
540 EXTERN tdm_error
541 tdm_vblank_set_offset(tdm_vblank *vblank, int offset)
542 {
543         tdm_private_vblank *private_vblank = vblank;
544
545         TDM_RETURN_VAL_IF_FAIL(private_vblank != NULL, TDM_ERROR_INVALID_PARAMETER);
546
547         if (private_vblank->offset == offset)
548                 return TDM_ERROR_NONE;
549
550         private_vblank->offset = offset;
551         private_vblank->check_HW_or_SW = 1;
552
553         if (tdm_debug_module & TDM_DEBUG_VBLANK)
554                 VIN("offset(%d)", private_vblank->offset);
555
556         return TDM_ERROR_NONE;
557 }
558
559 EXTERN tdm_error
560 tdm_vblank_get_offset(tdm_vblank *vblank, int *offset)
561 {
562         tdm_private_vblank *private_vblank = vblank;
563
564         TDM_RETURN_VAL_IF_FAIL(private_vblank != NULL, TDM_ERROR_INVALID_PARAMETER);
565         TDM_RETURN_VAL_IF_FAIL(offset != NULL, TDM_ERROR_INVALID_PARAMETER);
566
567         *offset = private_vblank->offset;
568
569         return TDM_ERROR_NONE;
570 }
571
572 EXTERN tdm_error
573 tdm_vblank_set_enable_fake(tdm_vblank *vblank, unsigned int enable_fake)
574 {
575         tdm_private_vblank *private_vblank = vblank;
576
577         TDM_RETURN_VAL_IF_FAIL(private_vblank != NULL, TDM_ERROR_INVALID_PARAMETER);
578
579         if (private_vblank->enable_fake == enable_fake)
580                 return TDM_ERROR_NONE;
581
582         private_vblank->enable_fake = enable_fake;
583
584         if (tdm_debug_module & TDM_DEBUG_VBLANK)
585                 VIN("enable_fake(%d)", private_vblank->enable_fake);
586
587         return TDM_ERROR_NONE;
588 }
589
590 EXTERN tdm_error
591 tdm_vblank_get_enable_fake(tdm_vblank *vblank, unsigned int *enable_fake)
592 {
593         tdm_private_vblank *private_vblank = vblank;
594
595         TDM_RETURN_VAL_IF_FAIL(private_vblank != NULL, TDM_ERROR_INVALID_PARAMETER);
596         TDM_RETURN_VAL_IF_FAIL(enable_fake != NULL, TDM_ERROR_INVALID_PARAMETER);
597
598         *enable_fake = private_vblank->enable_fake;
599
600         return TDM_ERROR_NONE;
601 }
602
603 static tdm_error
604 _tdm_vblank_sw_timer_update(tdm_private_vblank *private_vblank)
605 {
606         tdm_vblank_wait_info *first_wait_info = NULL;
607         double curr, target;
608         int ms_delay;
609         tdm_error ret;
610
611         if (LIST_IS_EMPTY(&private_vblank->SW_wait_list)) {
612                 VER("no wait_info");
613                 return TDM_ERROR_OPERATION_FAILED;
614         }
615
616         first_wait_info = container_of(private_vblank->SW_wait_list.next, first_wait_info, link);
617         curr = tdm_helper_get_time();
618         target = first_wait_info->target_time;
619
620         /* ms_delay should be more that 1 */
621         if (target < curr)
622                 ms_delay = 1;
623         else
624                 ms_delay = ceil((target - curr) * 1000.0);
625
626         if (ms_delay < 1)
627                 ms_delay = 1;
628
629         if (ms_delay > 5000)
630                 VER("wait(%p) curr(%.6f) target(%.6f) ms_delay(%d)", first_wait_info, curr, target, ms_delay);
631         else if (tdm_debug_module & TDM_DEBUG_VBLANK)
632                 VIN("wait(%p) curr(%.6f) target(%.6f) ms_delay(%d)", first_wait_info, curr, target, ms_delay);
633
634         tdm_display_lock(private_vblank->dpy);
635
636         if (!private_vblank->SW_timer) {
637                 private_vblank->SW_timer =
638                         tdm_event_loop_add_timer_handler(private_vblank->dpy,
639                                                                                          _tdm_vblank_cb_vblank_SW,
640                                                                                          private_vblank,
641                                                                                          &ret);
642                 if (!private_vblank->SW_timer) {
643                         tdm_display_unlock(private_vblank->dpy);
644                         VER("couldn't add timer");
645                         return ret;
646                 }
647                 VIN("Use SW vblank");
648         }
649
650         ret = tdm_event_loop_source_timer_update(private_vblank->SW_timer, ms_delay);
651         if (ret != TDM_ERROR_NONE) {
652                 tdm_display_unlock(private_vblank->dpy);
653                 VER("couldn't update timer");
654                 return ret;
655         }
656
657         tdm_display_unlock(private_vblank->dpy);
658
659         return TDM_ERROR_NONE;
660 }
661
662 static void
663 _tdm_vblank_cb_vblank_HW(tdm_output *output, unsigned int sequence,
664                                                  unsigned int tv_sec, unsigned int tv_usec,
665                                                  void *user_data)
666 {
667         tdm_vblank_wait_info *wait_info = user_data;
668         tdm_private_vblank *private_vblank;
669
670         if (!_tdm_vblank_check_valid_wait(wait_info)) {
671                 TDM_DBG("can't find wait(%p) from valid_wait_list", wait_info);
672                 return;
673         }
674
675         private_vblank = wait_info->private_vblank;
676         TDM_RETURN_IF_FAIL(private_vblank != NULL);
677
678         if (!_tdm_vblank_find_wait(wait_info, &private_vblank->HW_wait_list)) {
679                 VDB("can't find wait(%p)", wait_info);
680                 return;
681         }
682
683         if (wait_info->type == VBLANK_TYPE_HW_SW) {
684                 tdm_error ret;
685
686                 LIST_DEL(&wait_info->link);
687
688                 /* kernel sends the wrong time of first vblank event. and the time of
689                  * second vblank is correct.
690                  */
691                 wait_info->target_time = TDM_TIME(tv_sec, tv_usec);
692                 wait_info->target_time += (((double)private_vblank->offset) / 1000.0);
693
694                 _tdm_vblank_insert_wait(wait_info, &private_vblank->SW_wait_list);
695
696                 ret = _tdm_vblank_sw_timer_update(private_vblank);
697
698                 /* wait_info will be freed in _tdm_vblank_cb_vblank_SW() */
699                 if (ret == TDM_ERROR_NONE) {
700                         if (tdm_debug_module & TDM_DEBUG_VBLANK)
701                                 VIN("wait(%p) SW timer", wait_info);
702                         return;
703                 }
704
705                 VWR("couldn't update sw timer");
706         }
707
708         /* tv_sec & tv_usec shouldn't be zero. But sometimes they are zero in some hardware.
709          * We need to prohibit that last_time becomes zero because "last_time == 0" means
710          * that a tdm_vblank object is just created and doesn't have the first vblank event.
711          * If last_time becomes 0, it would make issue.
712          */
713         if (tv_sec == 0 && tv_usec == 0) {
714                 double curr = tdm_helper_get_time();
715                 tv_sec = TDM_TIME_SEC(curr);
716                 tv_usec = TDM_TIME_USEC(curr);
717         }
718
719         private_vblank->last_seq = wait_info->target_seq;
720         private_vblank->last_time = TDM_TIME(tv_sec, tv_usec);
721
722         if (tdm_debug_module & TDM_DEBUG_VBLANK)
723                 VIN("wait(%p) last(%.6f) sequence(%u) done", wait_info, private_vblank->last_time, wait_info->target_seq);
724
725         if (wait_info->func)
726                 wait_info->func(private_vblank, TDM_ERROR_NONE, wait_info->target_seq,
727                                                 tv_sec, tv_usec, wait_info->user_data);
728
729         LIST_DEL(&wait_info->link);
730         _tdm_vblank_valid_list_del(&wait_info->valid_link);
731         free(wait_info);
732 }
733
734 static tdm_error
735 _tdm_vblank_wait_HW(tdm_vblank_wait_info *wait_info)
736 {
737         tdm_private_vblank *private_vblank = wait_info->private_vblank;
738         int hw_interval;
739         tdm_error ret;
740
741         _tdm_vblank_insert_wait(wait_info, &private_vblank->HW_wait_list);
742
743         hw_interval = wait_info->interval * private_vblank->quotient;
744
745         if (private_vblank->last_time == 0) {
746                 /* SW vblank starts from now. SW vblank doesn't need to be aligned with HW vblank. */
747                 private_vblank->last_seq = 0;
748                 private_vblank->last_time = tdm_helper_get_time();
749
750                 /* +1 ms to call the handler ASAP at the first. no matter for SW timer. */
751                 wait_info->target_seq = 1;
752                 if (tdm_debug_module & TDM_DEBUG_VBLANK)
753                         VIN("wait(%p) last(%.6f) hw_itvl(%d) targ_seq(%u)",
754                                 wait_info, private_vblank->last_time, hw_interval, wait_info->target_seq);
755         } else {
756                 double last, prev, req, curr, target;
757                 unsigned int skip;
758
759                 last = private_vblank->last_time;
760                 req = wait_info->req_time;
761
762                 skip = (unsigned int)((req - last) / private_vblank->vblank_gap + TDM_TIME_MARGIN);
763                 prev = last + private_vblank->vblank_gap * skip;
764
765                 curr = tdm_helper_get_time();
766                 target = prev;
767                 while (target < curr)
768                         target += private_vblank->vblank_gap;
769
770                 hw_interval = (unsigned int)((target - curr) / private_vblank->HW_vblank_gap + TDM_TIME_MARGIN) + 1;
771
772                 wait_info->target_seq = private_vblank->last_seq;
773                 wait_info->target_seq += (unsigned int)((target - last) / private_vblank->vblank_gap + TDM_TIME_MARGIN);
774
775                 if (hw_interval > 300)
776                         VER("wait(%p) last(%.6f) req(%.6f) prev(%.6f) curr(%.6f) targ(%.6f,%.6f) skip(%u) hw_itvl(%d) targ_seq(%u)",
777                                 wait_info, last, req - last, prev - last, curr - last, target, target - last,
778                                 skip, hw_interval, wait_info->target_seq);
779                 else if (tdm_debug_module & TDM_DEBUG_VBLANK)
780                         VIN("wait(%p) last(%.6f) req(%.6f) prev(%.6f) curr(%.6f) targ(%.6f,%.6f) skip(%u) hw_itvl(%d) targ_seq(%u)",
781                                 wait_info, last, req - last, prev - last, curr - last, target, target - last,
782                                 skip, hw_interval, wait_info->target_seq);
783         }
784
785         if (private_vblank->add_front)
786                 ret = tdm_output_wait_vblank_add_front(private_vblank->output, hw_interval, 0,
787                                                                                            _tdm_vblank_cb_vblank_HW, wait_info);
788         else
789                 ret = tdm_output_wait_vblank(private_vblank->output, hw_interval, 0,
790                                                                          _tdm_vblank_cb_vblank_HW, wait_info);
791
792         if (ret != TDM_ERROR_NONE) {
793                 LIST_DEL(&wait_info->link);
794                 return ret;
795         }
796
797         if (tdm_debug_module & TDM_DEBUG_VBLANK)
798                 VIN("wait(%p) waiting", wait_info);
799
800         return TDM_ERROR_NONE;
801 }
802
803 static tdm_error
804 _tdm_vblank_cb_vblank_SW(void *user_data)
805 {
806         tdm_private_vblank *private_vblank = user_data;
807
808         TDM_RETURN_VAL_IF_FAIL(private_vblank != NULL, TDM_ERROR_OPERATION_FAILED);
809
810         return tdm_vblank_cb_vblank_SW(private_vblank, 0);
811 }
812
813 INTERN tdm_error
814 tdm_vblank_cb_vblank_SW(tdm_vblank *vblank, double vblank_stamp)
815 {
816         tdm_private_vblank *private_vblank;
817         tdm_vblank_wait_info *first_wait_info = NULL, *w = NULL, *ww = NULL;
818
819         TDM_RETURN_VAL_IF_FAIL(vblank || vblank_stamp > 0, TDM_ERROR_INVALID_PARAMETER);
820
821         if (vblank)
822                 private_vblank = vblank;
823         else {
824                 private_vblank = _tdm_vblank_find(vblank_stamp);
825                 if (!private_vblank) {
826                         TDM_DBG("can't find vblank(%.0f) from valid_list", vblank_stamp);
827                         return TDM_ERROR_NONE;
828                 }
829         }
830
831         if (private_vblank->owner_tid != syscall(SYS_gettid)) {
832                 tdm_thread_cb_vblank_sw vblank_sw;
833                 tdm_private_display *private_display = private_vblank->dpy;
834                 tdm_error ret;
835
836                 vblank_sw.base.type = TDM_THREAD_CB_VBLANK_SW;
837                 vblank_sw.base.length = sizeof vblank_sw;
838                 vblank_sw.vblank_stamp = private_vblank->stamp;
839
840                 ret = tdm_thread_send_cb(private_display->private_loop, &vblank_sw.base);
841                 TDM_WARNING_IF_FAIL(ret == TDM_ERROR_NONE);
842
843                 return TDM_ERROR_NONE;
844         }
845
846         if (LIST_IS_EMPTY(&private_vblank->SW_wait_list)) {
847                 VER("no wait_info");
848                 return TDM_ERROR_OPERATION_FAILED;
849         }
850
851         first_wait_info = container_of(private_vblank->SW_wait_list.next, first_wait_info, link);
852         TDM_RETURN_VAL_IF_FAIL(first_wait_info != NULL, TDM_ERROR_OPERATION_FAILED);
853
854         if (private_vblank->last_seq >= first_wait_info->target_seq)
855                 TDM_ERR("last_seq(%u) target_seq(%u)", private_vblank->last_seq, first_wait_info->target_seq);
856
857         private_vblank->last_seq = first_wait_info->target_seq;
858         private_vblank->last_time = first_wait_info->target_time;
859
860         if (tdm_debug_module & TDM_DEBUG_VBLANK)
861                 VIN("wait(%p) last(%.6f) sequence(%u) done", first_wait_info, private_vblank->last_time, first_wait_info->target_seq);
862
863         LIST_FOR_EACH_ENTRY_SAFE(w, ww, &private_vblank->SW_wait_list, link) {
864                 if (w->target_time != first_wait_info->target_time)
865                         break;
866
867                 LIST_DEL(&w->link);
868                 _tdm_vblank_valid_list_del(&w->valid_link);
869
870                 if (w->func) {
871                         tdm_display_unlock(private_vblank->dpy);
872                         w->func(private_vblank, TDM_ERROR_NONE, w->target_seq,
873                                         TDM_TIME_SEC(w->target_time), TDM_TIME_USEC(w->target_time),
874                                         w->user_data);
875                         tdm_display_lock(private_vblank->dpy);
876                 }
877
878                 free(w);
879         }
880
881         return TDM_ERROR_NONE;
882 }
883
884 static tdm_error
885 _tdm_vblank_wait_SW(tdm_vblank_wait_info *wait_info)
886 {
887         tdm_private_vblank *private_vblank = wait_info->private_vblank;
888         tdm_error ret;
889
890         if (private_vblank->last_time == 0) {
891                 /* SW vblank starts from now. SW vblank doesn't need to be aligned with HW vblank. */
892                 private_vblank->last_seq = 0;
893                 private_vblank->last_time = tdm_helper_get_time();
894
895                 /* +1 ms to call the handler ASAP at the first. no matter for SW timer. */
896                 wait_info->target_seq = 1;
897                 wait_info->target_time = private_vblank->last_time + 0.001;
898
899                 if (tdm_debug_module & TDM_DEBUG_VBLANK)
900                         VIN("wait(%p) last(%.6f) target(%.6f) target sequence(%u)",
901                                 wait_info, private_vblank->last_time, wait_info->target_time, wait_info->target_seq);
902         } else {
903                 double last, prev, req, curr, target;
904                 unsigned int skip;
905
906                 last = private_vblank->last_time;
907                 req = wait_info->req_time;
908
909                 skip = (unsigned int)((req - last) / private_vblank->vblank_gap + TDM_TIME_MARGIN);
910                 prev = last + private_vblank->vblank_gap * skip;
911
912                 curr = tdm_helper_get_time();
913                 target = prev + private_vblank->vblank_gap * wait_info->interval;
914
915                 while (target < curr)
916                         target += private_vblank->vblank_gap;
917
918                 wait_info->target_seq = private_vblank->last_seq;
919                 wait_info->target_seq += (unsigned int)((target - last) / private_vblank->vblank_gap + TDM_TIME_MARGIN);
920
921                 wait_info->target_time = target;
922
923                 if (tdm_debug_module & TDM_DEBUG_VBLANK)
924                         VIN("wait(%p) last(%.6f) req(%.6f) prev(%.6f) curr(%.6f) targ(%.6f,%.6f) skip(%u) targ_seq(%u)",
925                                 wait_info, last, req - last, prev - last, curr - last,
926                                 target, target - last, skip, wait_info->target_seq);
927         }
928
929         _tdm_vblank_insert_wait(wait_info, &private_vblank->SW_wait_list);
930
931         ret = _tdm_vblank_sw_timer_update(private_vblank);
932         if (ret != TDM_ERROR_NONE) {
933                 LIST_DEL(&wait_info->link);
934                 VER("couldn't update sw timer");
935                 return ret;
936         }
937
938         return TDM_ERROR_NONE;
939 }
940
941 EXTERN tdm_error
942 tdm_vblank_wait(tdm_vblank *vblank, unsigned int req_sec, unsigned int req_usec,
943                                 unsigned int interval, tdm_vblank_handler func, void *user_data)
944 {
945         tdm_private_vblank *private_vblank = vblank;
946         tdm_vblank_wait_info *wait_info;
947         tdm_error ret;
948
949         TDM_RETURN_VAL_IF_FAIL(private_vblank != NULL, TDM_ERROR_INVALID_PARAMETER);
950         TDM_RETURN_VAL_IF_FAIL(func != NULL, TDM_ERROR_INVALID_PARAMETER);
951
952         if (private_vblank->owner_tid != syscall(SYS_gettid)) {
953                 TDM_ERR("SHOULD be called in the owner thread(%d)", (int)private_vblank->owner_tid);
954                 return TDM_ERROR_BAD_REQUEST;
955         }
956
957         if (private_vblank->dpms != TDM_OUTPUT_DPMS_ON && !private_vblank->enable_fake) {
958                 VIN("can't wait a vblank because of DPMS off");
959                 return TDM_ERROR_DPMS_OFF;
960         }
961
962         wait_info = calloc(1, sizeof * wait_info);
963         if (!wait_info) {
964                 VER("alloc failed");
965                 return TDM_ERROR_OUT_OF_MEMORY;
966         }
967
968         /* set request time to current time if 0. This function seems to be called in server side. */
969         if (req_sec == 0 && req_usec == 0) {
970                 double curr = tdm_helper_get_time();
971                 req_sec = TDM_TIME_SEC(curr);
972                 req_usec = TDM_TIME_USEC(curr);
973         }
974
975         LIST_INITHEAD(&wait_info->link);
976
977         _tdm_vblank_valid_list_add(&wait_info->valid_link, &valid_wait_list);
978
979         wait_info->stamp = ++stamp;
980         wait_info->req_time = TDM_TIME(req_sec, req_usec);
981         wait_info->interval = interval;
982         wait_info->func = func;
983         wait_info->user_data = user_data;
984         wait_info->private_vblank = private_vblank;
985
986         if (private_vblank->check_HW_or_SW) {
987                 private_vblank->check_HW_or_SW = 0;
988                 private_vblank->vblank_gap = 1.0 / private_vblank->fps;
989                 private_vblank->quotient = private_vblank->vrefresh / private_vblank->fps;
990         }
991
992         /* 1) if fps != factor of vrefresh, SW timer
993          * 2) if fps == factor of vrefresh && dpms == off, SW timer (Fake HW vblank)
994          * 2) if fps == factor of vrefresh && dpms == on && offset == 0, HW vblank
995          * 3) if fps == factor of vrefresh && dpms == on && offset != 0, HW vblank + SW timer
996          * In case of 1), we really don't need to align with HW vblank.
997          */
998         if (private_vblank->vrefresh % private_vblank->fps)
999                 wait_info->type = VBLANK_TYPE_SW;
1000         else if (private_vblank->dpms == TDM_OUTPUT_DPMS_OFF)
1001                 wait_info->type = VBLANK_TYPE_SW_FAKE;
1002         else if (private_vblank->offset == 0)
1003                 wait_info->type = VBLANK_TYPE_HW;
1004         else
1005                 wait_info->type = VBLANK_TYPE_HW_SW;
1006
1007         if (wait_info->type == VBLANK_TYPE_SW || wait_info->type == VBLANK_TYPE_SW_FAKE)
1008                 ret = _tdm_vblank_wait_SW(wait_info);
1009         else {
1010                 ret = _tdm_vblank_wait_HW(wait_info);
1011                 if (ret == TDM_ERROR_DPMS_OFF)
1012                         ret = _tdm_vblank_wait_SW(wait_info);
1013         }
1014
1015         if (ret != TDM_ERROR_NONE) {
1016                 LIST_DEL(&wait_info->link);
1017                 _tdm_vblank_valid_list_del(&wait_info->valid_link);
1018                 free(wait_info);
1019                 return ret;
1020         }
1021
1022         return TDM_ERROR_NONE;
1023 }
1024
1025 EXTERN tdm_error
1026 tdm_vblank_wait_seq(tdm_vblank *vblank, unsigned int req_sec, unsigned int req_usec,
1027                                         unsigned int sequence, tdm_vblank_handler func, void *user_data)
1028 {
1029         tdm_private_vblank *private_vblank = vblank;
1030         unsigned int interval;
1031
1032         TDM_RETURN_VAL_IF_FAIL(private_vblank != NULL, TDM_ERROR_INVALID_PARAMETER);
1033         TDM_RETURN_VAL_IF_FAIL(func != NULL, TDM_ERROR_INVALID_PARAMETER);
1034
1035         /* if the sequence of vblank reaches the max value, sequence can be 0. */
1036
1037         if (private_vblank->last_seq == 0) {
1038                 TDM_WRN("can't calculate interval with sequence(%u)", sequence);
1039                 interval = 1;
1040         } else if (sequence > private_vblank->last_seq ||
1041                            TDM_VBLANK_SEQ_REACHED_MAX(sequence, private_vblank->last_seq)) {
1042                 double last, curr, seq_target;
1043
1044                 last = private_vblank->last_time;
1045                 curr = tdm_helper_get_time();
1046                 seq_target = last + private_vblank->vblank_gap * (sequence - private_vblank->last_seq);
1047
1048                 /* If target is old or too close(1ms) to current, we call the handler immediately.
1049                  * 2ms? it seems too much.
1050                  */
1051                 if (seq_target < curr) {
1052                         func(vblank, TDM_ERROR_NONE, sequence,
1053                                  TDM_TIME_SEC(seq_target), TDM_TIME_USEC(seq_target),
1054                                  user_data);
1055                         return TDM_ERROR_NONE;
1056                 } else if ((seq_target - curr) < 0.001) {  /* 1ms */
1057                         func(vblank, TDM_ERROR_NONE, sequence,
1058                                  TDM_TIME_SEC(curr), TDM_TIME_USEC(curr),
1059                                  user_data);
1060                         return TDM_ERROR_NONE;
1061                 }
1062
1063                 interval = (unsigned int)((seq_target - curr) / private_vblank->vblank_gap + TDM_TIME_MARGIN) + 1;
1064         } else {
1065                 /* this seems error. But we handle this like normal to avoid the unexpected error in cliend side */
1066                 TDM_WRN("sequence(%u) should be over the last sequence(%u)", sequence, private_vblank->last_seq);
1067                 func(vblank, TDM_ERROR_NONE, private_vblank->last_seq,
1068                          TDM_TIME_SEC(private_vblank->last_time), TDM_TIME_USEC(private_vblank->last_time),
1069                          user_data);
1070                 return TDM_ERROR_NONE;
1071         }
1072
1073         return tdm_vblank_wait(vblank, req_sec, req_usec, interval, func, user_data);
1074 }
1075
1076 INTERN tdm_error
1077 tdm_vblank_set_add_front(tdm_vblank *vblank, unsigned int add_front)
1078 {
1079         tdm_private_vblank *private_vblank = vblank;
1080
1081         TDM_RETURN_VAL_IF_FAIL(private_vblank != NULL, TDM_ERROR_INVALID_PARAMETER);
1082
1083         TDM_RETURN_VAL_IF_FAIL(TDM_MUTEX_IS_LOCKED(), TDM_ERROR_OPERATION_FAILED);
1084
1085         if (private_vblank->add_front == add_front)
1086                 return TDM_ERROR_NONE;
1087
1088         private_vblank->add_front = add_front;
1089
1090         return TDM_ERROR_NONE;
1091 }
1092
1093 INTERN tdm_error
1094 tdm_vblank_set_resource(tdm_vblank *vblank, struct wl_resource *resource)
1095 {
1096         tdm_private_vblank *private_vblank = vblank;
1097
1098         TDM_RETURN_VAL_IF_FAIL(private_vblank != NULL, TDM_ERROR_INVALID_PARAMETER);
1099         TDM_RETURN_VAL_IF_FAIL(private_vblank->resource == NULL, TDM_ERROR_OPERATION_FAILED);
1100
1101         private_vblank->resource = resource;
1102
1103         return TDM_ERROR_NONE;
1104 }
1105
1106 static void
1107 _tdm_vblank_get_process_name(pid_t pid, char *name, unsigned int size)
1108 {
1109         char proc[TDM_NAME_LEN], pname[TDM_NAME_LEN];
1110         FILE *h;
1111         size_t len;
1112
1113         snprintf(proc, TDM_NAME_LEN, "/proc/%d/cmdline", pid);
1114         h = fopen(proc, "r");
1115         if (!h)
1116                 return;
1117
1118         len = fread(pname, sizeof(char), TDM_NAME_LEN, h);
1119         if (len == 0) {
1120                 char *p = strncpy(pname, "NO NAME", sizeof(pname) - 1);
1121                 len = p - pname;
1122         }
1123         pname[len - 1] = '\0';
1124
1125         strncpy(name, pname, size - 1);
1126         name[size - 1] = '\0';
1127
1128         fclose(h);
1129 }
1130
1131 INTERN void
1132 tdm_vblank_get_vblank_list_information(tdm_display *dpy, char *reply, int *len)
1133 {
1134         tdm_private_vblank *v;
1135
1136         TDM_SNPRINTF(reply, len, "[Client Vblank List]\n");
1137         TDM_SNPRINTF(reply, len, "---------------------------------------------------------------\n");
1138         TDM_SNPRINTF(reply, len, "name         fps offset fake process\n");
1139         TDM_SNPRINTF(reply, len, "---------------------------------------------------------------\n");
1140
1141         pthread_mutex_lock(&valid_list_lock);
1142         LIST_FOR_EACH_ENTRY(v, &valid_vblank_list, valid_link) {
1143                 struct wl_client *client = wl_resource_get_client(v->resource);
1144                 char proc_name[TDM_NAME_LEN];
1145                 pid_t pid = 0;
1146
1147                 snprintf(proc_name, TDM_NAME_LEN, "Unknown");
1148                 if (client) {
1149                         wl_client_get_credentials(client, &pid, NULL, NULL);
1150                         _tdm_vblank_get_process_name(pid, proc_name, TDM_NAME_LEN);
1151                 }
1152
1153                 TDM_SNPRINTF(reply, len, "%-12s %u  %d      %u    %s (pid: %u)\n",
1154                                          v->name, v->fps, v->offset, v->enable_fake, proc_name, pid);
1155         }
1156         pthread_mutex_unlock(&valid_list_lock);
1157
1158         TDM_SNPRINTF(reply, len, "\n");
1159 }
1160