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