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