src/tdm_vblank.c

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