src/tdm_vblank.c

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