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