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