src/tdm_vblank.c

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