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