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