src/tdm_private.h

   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 #ifndef _TDM_PRIVATE_H_
  37 #define _TDM_PRIVATE_H_
  38
  39 #include <stdio.h>
  40 #include <string.h>
  41 #include <strings.h>
  42 #include <stdlib.h>
  43 #include <pthread.h>
  44 #include <errno.h>
  45 #include <unistd.h>
  46 #include <limits.h>
  47 #include <sys/types.h>
  48 #include <sys/stat.h>
  49 #include <fcntl.h>
  50 #include <dlfcn.h>
  51 #include <dirent.h>
  52 #include <poll.h>
  53 #include <sys/syscall.h>
  54 #include <sys/types.h>
  55 #include <math.h>
  56
  57 #include <tbm_bufmgr.h>
  58 #include <tbm_surface_queue.h>
  59
  60 #include "tdm_backend.h"
  61 #include "tdm_log.h"
  62 #include "tdm_list.h"
  63 #include "tdm_macro.h"
  64
  65 #ifdef __cplusplus
  66 extern "C" {
  67 #endif
  68
  69 //#define INIT_BUFMGR
  70
  71 /**
  72  * @file tdm_private.h
  73  * @brief The private header file for a frontend library
  74  */
  75
  76 enum {
  77         TDM_DEBUG_NONE,
  78         TDM_DEBUG_BUFFER    = (1 << 0),
  79         TDM_DEBUG_MUTEX     = (1 << 1),
  80         TDM_DEBUG_THREAD    = (1 << 2),
  81         TDM_DEBUG_SERVER    = (1 << 3),
  82         TDM_DEBUG_VBLANK    = (1 << 4),
  83 };
  84
  85 extern int tdm_debug_module;
  86 extern int tdm_debug_dump;
  87
  88 #ifdef HAVE_TTRACE
  89 #include <ttrace.h>
  90 #define TDM_TRACE_BEGIN(NAME) traceBegin(TTRACE_TAG_GRAPHICS, "TDM:"#NAME)
  91 #define TDM_TRACE_END() traceEnd(TTRACE_TAG_GRAPHICS)
  92 #define TDM_TRACE_COUNT(NAME, COUNT) traceCounter(TTRACE_TAG_GRAPHICS, COUNT, "TDM:"#NAME)
  93 #else
  94 #define TDM_TRACE_BEGIN(NAME)
  95 #define TDM_TRACE_END()
  96 #define TDM_TRACE_COUNT(NAME, COUNT)
  97 #endif
  98
  99 typedef enum {
 100         TDM_CAPTURE_TARGET_OUTPUT,
 101         TDM_CAPTURE_TARGET_LAYER,
 102 } tdm_capture_target;
 103
 104 enum {
 105         TDM_DUMP_FLAG_LAYER   = (1 << 0),
 106         TDM_DUMP_FLAG_PP      = (1 << 1),
 107         TDM_DUMP_FLAG_CAPTURE = (1 << 2),
 108 };
 109
 110 #define TDM_DUMP_DIR    "/tmp"
 111
 112 typedef struct _tdm_private_display tdm_private_display;
 113 typedef struct _tdm_private_output tdm_private_output;
 114 typedef struct _tdm_private_layer tdm_private_layer;
 115 typedef struct _tdm_private_pp tdm_private_pp;
 116 typedef struct _tdm_private_capture tdm_private_capture;
 117 typedef struct _tdm_private_loop tdm_private_loop;
 118 typedef struct _tdm_private_server tdm_private_server;
 119 typedef struct _tdm_private_thread tdm_private_thread;
 120 typedef struct _tdm_private_vblank_handler tdm_private_vblank_handler;
 121 typedef struct _tdm_private_commit_handler tdm_private_commit_handler;
 122 typedef struct _tdm_private_change_handler tdm_private_change_handler;
 123
 124 struct _tdm_private_display {
 125         pthread_mutex_t lock;
 126         unsigned int init_count;
 127
 128         /* backend module info */
 129         void *module;
 130         tdm_backend_module *module_data;
 131         tdm_backend_data *bdata;
 132
 133 #ifdef INIT_BUFMGR
 134         tbm_bufmgr bufmgr;
 135 #endif
 136
 137         /* backend function */
 138         tdm_display_capability capabilities;
 139         tdm_func_display func_display;
 140         tdm_func_output func_output;
 141         tdm_func_layer func_layer;
 142         tdm_func_pp func_pp;
 143         tdm_func_capture func_capture;
 144
 145         /* backend capability */
 146         tdm_caps_display caps_display;
 147         tdm_caps_pp caps_pp;
 148         tdm_caps_capture caps_capture;
 149
 150         /* output, pp list */
 151         struct list_head output_list;
 152         struct list_head pp_list;
 153         struct list_head capture_list;
 154
 155         void **outputs_ptr;
 156
 157         /* for event handling */
 158         tdm_private_loop *private_loop;
 159
 160         /* output order */
 161         tdm_output **outputs;
 162 };
 163
 164 struct _tdm_private_output {
 165         struct list_head link;
 166
 167         int index;
 168         unsigned long stamp;
 169
 170         tdm_private_display *private_display;
 171
 172         tdm_caps_output caps;
 173         tdm_output *output_backend;
 174
 175         unsigned int pipe;
 176         tdm_output_dpms current_dpms_value;
 177         const tdm_output_mode *current_mode;
 178
 179         int regist_vblank_cb;
 180         int regist_commit_cb;
 181         int regist_change_cb;
 182         int regist_dpms_cb;
 183
 184         struct list_head layer_list;
 185         struct list_head capture_list;
 186         struct list_head vblank_handler_list;
 187         struct list_head commit_handler_list;
 188
 189         /* seperate list for multi-thread*/
 190         struct list_head change_handler_list_main;
 191         struct list_head change_handler_list_sub;
 192
 193         void **layers_ptr;
 194
 195         /* TODO: temp solution for handling DPMS things in sub-htread */
 196         tdm_event_loop_source *dpms_changed_timer;
 197 };
 198
 199 struct _tdm_private_layer {
 200         struct list_head link;
 201
 202         int index;
 203
 204         tdm_private_display *private_display;
 205         tdm_private_output *private_output;
 206
 207         tdm_caps_layer caps;
 208         tdm_layer *layer_backend;
 209
 210         tbm_surface_h pending_buffer;
 211         tbm_surface_h waiting_buffer;
 212         tbm_surface_h showing_buffer;
 213         tbm_surface_queue_h buffer_queue;
 214
 215         struct list_head capture_list;
 216
 217         unsigned int usable;
 218 };
 219
 220 struct _tdm_private_pp {
 221         struct list_head link;
 222
 223         unsigned long stamp;
 224
 225         tdm_private_display *private_display;
 226
 227         tdm_pp *pp_backend;
 228
 229         struct list_head pending_buffer_list;
 230         struct list_head buffer_list;
 231
 232         tdm_info_pp info;
 233         pid_t owner_tid;
 234
 235         tdm_pp_done_handler done_func;
 236         void *done_user_data;
 237 };
 238
 239 struct _tdm_private_capture {
 240         struct list_head link;
 241         struct list_head display_link;
 242
 243         unsigned long stamp;
 244
 245         tdm_capture_target target;
 246
 247         tdm_private_display *private_display;
 248         tdm_private_output *private_output;
 249         tdm_private_layer *private_layer;
 250
 251         tdm_capture *capture_backend;
 252
 253         struct list_head pending_buffer_list;
 254         struct list_head buffer_list;
 255
 256         tdm_info_capture info;
 257         pid_t owner_tid;
 258
 259         tdm_capture_done_handler done_func;
 260         void *done_user_data;
 261 };
 262
 263 /* CAUTION:
 264  * Note that we don't need to (un)lock mutex to use this structure. If there is
 265  * no TDM thread, all TDM resources are protected by private_display's mutex.
 266  * If there is a TDM thread, this struct will be used only in a TDM thread.
 267  * So, we don't need to protect this structure by mutex. Not thread-safe.
 268  */
 269 struct _tdm_private_loop {
 270         /* TDM uses wl_event_loop to handle various event sources including the TDM
 271          * backend's fd.
 272          */
 273         struct wl_display *wl_display;
 274         struct wl_event_loop *wl_loop;
 275
 276         int backend_fd;
 277         tdm_event_loop_source *backend_source;
 278
 279         /* In event loop, all resources are accessed by this dpy.
 280          * CAUTION:
 281          * - DO NOT include other private structure in this structure because this
 282          *   struct is not protected by mutex.
 283          */
 284         tdm_display *dpy;
 285
 286         /* for handling TDM client requests */
 287         tdm_private_server *private_server;
 288
 289         /* To have a TDM event thread. If TDM_THREAD enviroment variable is not set
 290          * private_thread is NULL.
 291          */
 292         tdm_private_thread *private_thread;
 293 };
 294
 295 struct _tdm_private_vblank_handler {
 296         struct list_head link;
 297
 298         tdm_private_output *private_output;
 299         tdm_output_vblank_handler func;
 300         void *user_data;
 301
 302         pid_t owner_tid;
 303 };
 304
 305 struct _tdm_private_commit_handler {
 306         struct list_head link;
 307
 308         tdm_private_output *private_output;
 309         tdm_output_commit_handler func;
 310         void *user_data;
 311
 312         pid_t owner_tid;
 313 };
 314
 315 struct _tdm_private_change_handler {
 316         struct list_head link;
 317
 318         tdm_private_output *private_output;
 319         tdm_output_change_handler func;
 320         void *user_data;
 321
 322         pid_t owner_tid;
 323 };
 324
 325 typedef struct _tdm_buffer_info {
 326         tbm_surface_h buffer;
 327
 328         /* ref_count for backend */
 329         int backend_ref_count;
 330
 331         struct list_head release_funcs;
 332         struct list_head destroy_funcs;
 333
 334         struct list_head *list;
 335         struct list_head link;
 336 } tdm_buffer_info;
 337
 338 typedef struct _tdm_pp_private_buffer {
 339         tbm_surface_h src;
 340         tbm_surface_h dst;
 341         struct list_head link;
 342         struct list_head commit_link;
 343 } tdm_pp_private_buffer;
 344
 345 int
 346 tdm_display_check_module_abi(tdm_private_display *private_display, int abimaj, int abimin);
 347
 348 tdm_private_output *
 349 tdm_display_find_output_stamp(tdm_private_display *private_display,
 350                                                           unsigned long stamp);
 351 tdm_private_pp *
 352 tdm_pp_find_stamp(tdm_private_display *private_display, unsigned long stamp);
 353 tdm_private_capture *
 354 tdm_capture_find_stamp(tdm_private_display *private_display, unsigned long stamp);
 355
 356 void
 357 tdm_output_cb_vblank(tdm_output *output_backend, unsigned int sequence,
 358                                          unsigned int tv_sec, unsigned int tv_usec, void *user_data);
 359 void
 360 tdm_output_cb_commit(tdm_output *output_backend, unsigned int sequence,
 361                                          unsigned int tv_sec, unsigned int tv_usec, void *user_data);
 362 void
 363 tdm_output_cb_status(tdm_output *output_backend, tdm_output_conn_status status,
 364                                          void *user_data);
 365 void
 366 tdm_output_cb_dpms(tdm_output *output_backend, tdm_output_dpms dpms,
 367                                    void *user_data);
 368 void
 369 tdm_pp_cb_done(tdm_pp *pp_backend, tbm_surface_h src, tbm_surface_h dst,
 370                            void *user_data);
 371 void
 372 tdm_capture_cb_done(tdm_capture *capture_backend, tbm_surface_h buffer,
 373                                         void *user_data);
 374
 375 void
 376 tdm_output_call_change_handler_internal(tdm_private_output *private_output,
 377                                                                                 struct list_head *change_handler_list,
 378                                                                                 tdm_output_change_type type,
 379                                                                                 tdm_value value,
 380                                                                                 int no_check_thread_id);
 381
 382 tdm_private_pp *
 383 tdm_pp_create_internal(tdm_private_display *private_display, tdm_error *error);
 384 void
 385 tdm_pp_destroy_internal(tdm_private_pp *private_pp);
 386
 387 tdm_private_capture *
 388 tdm_capture_create_output_internal(tdm_private_output *private_output,
 389                                                                    tdm_error *error);
 390 tdm_private_capture *
 391 tdm_capture_create_layer_internal(tdm_private_layer *private_layer,
 392                                                                   tdm_error *error);
 393 void
 394 tdm_capture_destroy_internal(tdm_private_capture *private_capture);
 395
 396 /* utility buffer functions for private */
 397 tdm_buffer_info*
 398 tdm_buffer_get_info(tbm_surface_h buffer);
 399 tbm_surface_h
 400 tdm_buffer_list_get_first_entry(struct list_head *list);
 401 void
 402 tdm_buffer_list_dump(struct list_head *list);
 403
 404 void
 405 tdm_buffer_remove_release_handler_internal(tbm_surface_h buffer);
 406
 407 /* event functions for private */
 408 tdm_error
 409 tdm_event_loop_init(tdm_private_display *private_display);
 410 void
 411 tdm_event_loop_deinit(tdm_private_display *private_display);
 412 void
 413 tdm_event_loop_create_backend_source(tdm_private_display *private_display);
 414 int
 415 tdm_event_loop_get_fd(tdm_private_display *private_display);
 416 tdm_error
 417 tdm_event_loop_dispatch(tdm_private_display *private_display);
 418 void
 419 tdm_event_loop_flush(tdm_private_display *private_display);
 420
 421 typedef enum {
 422         TDM_THREAD_CB_NONE,
 423         TDM_THREAD_CB_OUTPUT_COMMIT,
 424         TDM_THREAD_CB_OUTPUT_VBLANK,
 425         TDM_THREAD_CB_OUTPUT_STATUS,
 426         TDM_THREAD_CB_OUTPUT_DPMS,
 427         TDM_THREAD_CB_PP_DONE,
 428         TDM_THREAD_CB_CAPTURE_DONE,
 429 } tdm_thread_cb_type;
 430
 431 typedef struct _tdm_thread_cb_base tdm_thread_cb_base;
 432 typedef struct _tdm_thread_cb_output_vblank tdm_thread_cb_output_commit;
 433 typedef struct _tdm_thread_cb_output_vblank tdm_thread_cb_output_vblank;
 434 typedef struct _tdm_thread_cb_output_status tdm_thread_cb_output_status;
 435 typedef struct _tdm_thread_cb_output_dpms tdm_thread_cb_output_dpms;
 436 typedef struct _tdm_thread_cb_pp_done tdm_thread_cb_pp_done;
 437 typedef struct _tdm_thread_cb_capture_done tdm_thread_cb_capture_done;
 438
 439 struct _tdm_thread_cb_base {
 440         tdm_thread_cb_type type;
 441         unsigned int length;
 442 };
 443
 444 struct _tdm_thread_cb_output_vblank {
 445         tdm_thread_cb_base base;
 446         unsigned long output_stamp;
 447         unsigned int sequence;
 448         unsigned int tv_sec;
 449         unsigned int tv_usec;
 450         void *user_data;
 451 };
 452
 453 struct _tdm_thread_cb_output_status {
 454         tdm_thread_cb_base base;
 455         unsigned long output_stamp;
 456         tdm_output_conn_status status;
 457         void *user_data;
 458 };
 459
 460 struct _tdm_thread_cb_output_dpms {
 461         tdm_thread_cb_base base;
 462         unsigned long output_stamp;
 463         tdm_output_dpms dpms;
 464         void *user_data;
 465 };
 466
 467 struct _tdm_thread_cb_pp_done {
 468         tdm_thread_cb_base base;
 469         unsigned long pp_stamp;
 470         tbm_surface_h src;
 471         tbm_surface_h dst;
 472         void *user_data;
 473 };
 474
 475 struct _tdm_thread_cb_capture_done {
 476         tdm_thread_cb_base base;
 477         unsigned long capture_stamp;
 478         tbm_surface_h buffer;
 479         void *user_data;
 480 };
 481
 482 tdm_error
 483 tdm_thread_init(tdm_private_loop *private_loop);
 484 void
 485 tdm_thread_deinit(tdm_private_loop *private_loop);
 486 int
 487 tdm_thread_get_fd(tdm_private_loop *private_loop);
 488 tdm_error
 489 tdm_thread_send_cb(tdm_private_loop *private_loop, tdm_thread_cb_base *base);
 490 tdm_error
 491 tdm_thread_handle_cb(tdm_private_loop *private_loop);
 492 int
 493 tdm_thread_in_display_thread(pid_t tid);
 494 int
 495 tdm_thread_is_running(void);
 496
 497 tdm_error
 498 tdm_server_init(tdm_private_loop *private_loop);
 499 void
 500 tdm_server_deinit(tdm_private_loop *private_loop);
 501
 502 char *
 503 tdm_helper_dump_make_directory(const char *path, char *reply, int *len);
 504 void
 505 tdm_helper_dump_buffer_str(tbm_surface_h buffer, char *dir, char *str);
 506 unsigned long
 507 tdm_helper_get_time_in_millis(void);
 508 unsigned long
 509 tdm_helper_get_time_in_micros(void);
 510
 511 extern pthread_mutex_t tdm_mutex_check_lock;
 512 extern int tdm_mutex_locked;
 513 extern int tdm_dump_enable;
 514 extern char *tdm_debug_dump_dir;
 515
 516 #define _pthread_mutex_unlock(l) \
 517         do { \
 518                 if (tdm_debug_module & TDM_DEBUG_MUTEX) \
 519                         TDM_INFO("mutex unlock"); \
 520                 pthread_mutex_lock(&tdm_mutex_check_lock); \
 521                 tdm_mutex_locked = 0; \
 522                 pthread_mutex_unlock(&tdm_mutex_check_lock); \
 523                 pthread_mutex_unlock(l); \
 524         } while (0)
 525 #ifdef TDM_CONFIG_MUTEX_TIMEOUT
 526 #define MUTEX_TIMEOUT_SEC 5
 527 #define _pthread_mutex_lock(l) \
 528         do { \
 529                 if (tdm_debug_module & TDM_DEBUG_MUTEX) \
 530                         TDM_INFO("mutex lock"); \
 531                 struct timespec rtime; \
 532                 clock_gettime(CLOCK_REALTIME, &rtime); \
 533                 rtime.tv_sec += MUTEX_TIMEOUT_SEC; \
 534                 if (pthread_mutex_timedlock(l, &rtime)) { \
 535                         TDM_ERR("Mutex lock failed PID %d", getpid()); \
 536                         _pthread_mutex_unlock(l); \
 537                 } \
 538                 else { \
 539                         pthread_mutex_lock(&tdm_mutex_check_lock); \
 540                         tdm_mutex_locked = 1; \
 541                         pthread_mutex_unlock(&tdm_mutex_check_lock); \
 542                 } \
 543         } while (0)
 544 #else //TDM_CONFIG_MUTEX_TIMEOUT
 545 #define _pthread_mutex_lock(l) \
 546         do { \
 547                 if (tdm_debug_module & TDM_DEBUG_MUTEX) \
 548                         TDM_INFO("mutex lock"); \
 549                 pthread_mutex_lock(l); \
 550                 pthread_mutex_lock(&tdm_mutex_check_lock); \
 551                 tdm_mutex_locked = 1; \
 552                 pthread_mutex_unlock(&tdm_mutex_check_lock); \
 553         } while (0)
 554 #endif //TDM_CONFIG_MUTEX_TIMEOUT
 555 //#define TDM_MUTEX_IS_LOCKED() (tdm_mutex_locked == 1)
 556 static inline int TDM_MUTEX_IS_LOCKED(void)
 557 {
 558         int ret;
 559         /* if thread is not running, we don't need to consider mutex things. */
 560         if (!tdm_thread_is_running())
 561                 return 1;
 562         pthread_mutex_lock(&tdm_mutex_check_lock);
 563         ret = (tdm_mutex_locked == 1);
 564         pthread_mutex_unlock(&tdm_mutex_check_lock);
 565         return ret;
 566 }
 567
 568 #define tdm_display_lock(dpy)   _pthread_mutex_lock(&((tdm_private_display *)dpy)->lock)
 569 #define tdm_display_unlock(dpy)   _pthread_mutex_unlock(&((tdm_private_display *)dpy)->lock)
 570
 571 tdm_error
 572 tdm_display_update_output(tdm_private_display *private_display,
 573                                                   tdm_output *output_backend, int pipe);
 574 tdm_error
 575 tdm_display_enable_debug_module(const char*modules);
 576 tdm_error
 577 tdm_display_enable_dump(tdm_private_display *private_display, const char *dump_str, char *reply, int *len);
 578 tdm_error
 579 tdm_display_enable_path(const char *path);
 580 tdm_error
 581 tdm_display_enable_ttrace_vblank(tdm_display *dpy, tdm_output *output, int enable);
 582
 583 /**
 584  * @brief The tdm vblank object
 585  */
 586 typedef void tdm_vblank;
 587
 588 typedef void (*tdm_vblank_handler)(tdm_vblank *vblank, tdm_error error, unsigned int sequence,
 589                                                                    unsigned int tv_sec, unsigned int tv_usec, void *user_data);
 590
 591 tdm_vblank*
 592 tdm_vblank_create(tdm_display *dpy, tdm_output *output, tdm_error *error);
 593 void
 594 tdm_vblank_destroy(tdm_vblank *vblank);
 595 tdm_error
 596 tdm_vblank_set_fps(tdm_vblank *vblank, unsigned int fps);
 597 tdm_error
 598 tdm_vblank_set_offset(tdm_vblank *vblank, int offset);
 599 tdm_error
 600 tdm_vblank_set_enable_fake(tdm_vblank *vblank, unsigned int enable_fake);
 601 tdm_error
 602 tdm_vblank_wait(tdm_vblank *vblank, unsigned int req_sec, unsigned int req_usec, unsigned int interval, tdm_vblank_handler func, void *user_data);
 603
 604 void
 605 tdm_monitor_server_command(tdm_display *dpy, const char *options, char *reply, int *len);
 606
 607 #ifdef __cplusplus
 608 }
 609 #endif
 610
 611 #endif /* _TDM_PRIVATE_H_ */