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