src/tdm_vblank.c

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