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