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 <stdlib.h>
  42 #include <pthread.h>
  43 #include <errno.h>
  44 #include <unistd.h>
  45 #include <limits.h>
  46 #include <sys/types.h>
  47 #include <sys/stat.h>
  48 #include <fcntl.h>
  49 #include <dlfcn.h>
  50 #include <dirent.h>
  51 #include <poll.h>
  52 #include <sys/syscall.h>
  53 #include <sys/types.h>
  54
  55 #include <tbm_bufmgr.h>
  56 #include <tbm_surface_queue.h>
  57
  58 #include "tdm_backend.h"
  59 #include "tdm_log.h"
  60 #include "tdm_list.h"
  61 #include "tdm_macro.h"
  62
  63 #ifdef __cplusplus
  64 extern "C" {
  65 #endif
  66
  67 //#define INIT_BUFMGR
  68
  69 /**
  70  * @file tdm_private.h
  71  * @brief The private header file for a frontend library
  72  */
  73
  74 extern int tdm_debug_buffer;
  75 extern int tdm_debug_mutex;
  76 extern int tdm_debug_thread;
  77
  78 #ifdef HAVE_TTRACE
  79 #include <ttrace.h>
  80 #define TDM_TRACE_BEGIN(NAME) traceBegin(TTRACE_TAG_GRAPHICS, "TDM:"#NAME)
  81 #define TDM_TRACE_END() traceEnd(TTRACE_TAG_GRAPHICS)
  82 #else
  83 #define TDM_TRACE_BEGIN(NAME)
  84 #define TDM_TRACE_END()
  85 #endif
  86
  87 #define prototype_name_fn(res) const char * res##_str(int type)
  88
  89 prototype_name_fn(dpms);
  90 prototype_name_fn(status);
  91
  92 typedef enum {
  93         TDM_CAPTURE_TARGET_OUTPUT,
  94         TDM_CAPTURE_TARGET_LAYER,
  95 } tdm_capture_target;
  96
  97 typedef struct _tdm_private_display tdm_private_display;
  98 typedef struct _tdm_private_output tdm_private_output;
  99 typedef struct _tdm_private_layer tdm_private_layer;
 100 typedef struct _tdm_private_pp tdm_private_pp;
 101 typedef struct _tdm_private_capture tdm_private_capture;
 102 typedef struct _tdm_private_loop tdm_private_loop;
 103 typedef struct _tdm_private_server tdm_private_server;
 104 typedef struct _tdm_private_thread tdm_private_thread;
 105 typedef struct _tdm_private_vblank_handler tdm_private_vblank_handler;
 106 typedef struct _tdm_private_commit_handler tdm_private_commit_handler;
 107 typedef struct _tdm_private_change_handler tdm_private_change_handler;
 108
 109 struct _tdm_private_display {
 110         pthread_mutex_t lock;
 111         unsigned int init_count;
 112
 113         /* backend module info */
 114         void *module;
 115         tdm_backend_module *module_data;
 116         tdm_backend_data *bdata;
 117
 118 #ifdef INIT_BUFMGR
 119         tbm_bufmgr bufmgr;
 120 #endif
 121
 122         /* backend function */
 123         tdm_display_capability capabilities;
 124         tdm_func_display func_display;
 125         tdm_func_output func_output;
 126         tdm_func_layer func_layer;
 127         tdm_func_pp func_pp;
 128         tdm_func_capture func_capture;
 129
 130         /* backend capability */
 131         tdm_caps_display caps_display;
 132         tdm_caps_pp caps_pp;
 133         tdm_caps_capture caps_capture;
 134
 135         /* output, pp list */
 136         struct list_head output_list;
 137         struct list_head pp_list;
 138         struct list_head capture_list;
 139
 140         void **outputs_ptr;
 141
 142         /* for event handling */
 143         tdm_private_loop *private_loop;
 144
 145         /* output order */
 146         tdm_output **outputs;
 147 };
 148
 149 struct _tdm_private_output {
 150         struct list_head link;
 151
 152         unsigned long stamp;
 153
 154         tdm_private_display *private_display;
 155
 156         tdm_caps_output caps;
 157         tdm_output *output_backend;
 158
 159         unsigned int pipe;
 160         tdm_output_dpms current_dpms_value;
 161
 162         int regist_vblank_cb;
 163         int regist_commit_cb;
 164         int regist_change_cb;
 165
 166         struct list_head layer_list;
 167         struct list_head capture_list;
 168         struct list_head vblank_handler_list;
 169         struct list_head commit_handler_list;
 170
 171         /* seperate list for multi-thread*/
 172         struct list_head change_handler_list_main;
 173         struct list_head change_handler_list_sub;
 174
 175         void **layers_ptr;
 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 const char*
 308 tdm_get_dpms_str(tdm_output_dpms dpms_value);
 309
 310 int
 311 tdm_display_check_module_abi(tdm_private_display *private_display, int abimaj, int abimin);
 312
 313 tdm_private_output *
 314 tdm_display_find_output_stamp(tdm_private_display *private_display,
 315                                                           unsigned long stamp);
 316 tdm_private_pp *
 317 tdm_pp_find_stamp(tdm_private_display *private_display, unsigned long stamp);
 318 tdm_private_capture *
 319 tdm_capture_find_stamp(tdm_private_display *private_display, unsigned long stamp);
 320
 321 void
 322 tdm_output_cb_vblank(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_commit(tdm_output *output_backend, unsigned int sequence,
 326                                          unsigned int tv_sec, unsigned int tv_usec, void *user_data);
 327 void
 328 tdm_output_cb_status(tdm_output *output_backend, tdm_output_conn_status status,
 329                                          void *user_data);
 330 void
 331 tdm_pp_cb_done(tdm_pp *pp_backend, tbm_surface_h src, tbm_surface_h dst,
 332                            void *user_data);
 333 void
 334 tdm_capture_cb_done(tdm_capture *capture_backend, tbm_surface_h buffer,
 335                                         void *user_data);
 336
 337 void
 338 tdm_output_call_change_handler_internal(tdm_private_output *private_output,
 339                                                                                 struct list_head *change_handler_list,
 340                                                                                 tdm_output_change_type type,
 341                                                                                 tdm_value value);
 342
 343 tdm_private_pp *
 344 tdm_pp_create_internal(tdm_private_display *private_display, tdm_error *error);
 345 void
 346 tdm_pp_destroy_internal(tdm_private_pp *private_pp);
 347
 348 tdm_private_capture *
 349 tdm_capture_create_output_internal(tdm_private_output *private_output,
 350                                                                    tdm_error *error);
 351 tdm_private_capture *
 352 tdm_capture_create_layer_internal(tdm_private_layer *private_layer,
 353                                                                   tdm_error *error);
 354 void
 355 tdm_capture_destroy_internal(tdm_private_capture *private_capture);
 356
 357 /* utility buffer functions for private */
 358 tdm_buffer_info*
 359 tdm_buffer_get_info(tbm_surface_h buffer);
 360 tbm_surface_h
 361 tdm_buffer_list_get_first_entry(struct list_head *list);
 362 void
 363 tdm_buffer_list_dump(struct list_head *list);
 364
 365 /* event functions for private */
 366 tdm_error
 367 tdm_event_loop_init(tdm_private_display *private_display);
 368 void
 369 tdm_event_loop_deinit(tdm_private_display *private_display);
 370 void
 371 tdm_event_loop_create_backend_source(tdm_private_display *private_display);
 372 int
 373 tdm_event_loop_get_fd(tdm_private_display *private_display);
 374 tdm_error
 375 tdm_event_loop_dispatch(tdm_private_display *private_display);
 376 void
 377 tdm_event_loop_flush(tdm_private_display *private_display);
 378
 379 typedef enum {
 380         TDM_THREAD_CB_NONE,
 381         TDM_THREAD_CB_OUTPUT_COMMIT,
 382         TDM_THREAD_CB_OUTPUT_VBLANK,
 383         TDM_THREAD_CB_OUTPUT_STATUS,
 384         TDM_THREAD_CB_PP_DONE,
 385         TDM_THREAD_CB_CAPTURE_DONE,
 386 } tdm_thread_cb_type;
 387
 388 typedef struct _tdm_thread_cb_base tdm_thread_cb_base;
 389 typedef struct _tdm_thread_cb_output_vblank tdm_thread_cb_output_commit;
 390 typedef struct _tdm_thread_cb_output_vblank tdm_thread_cb_output_vblank;
 391 typedef struct _tdm_thread_cb_output_status tdm_thread_cb_output_status;
 392 typedef struct _tdm_thread_cb_pp_done tdm_thread_cb_pp_done;
 393 typedef struct _tdm_thread_cb_capture_done tdm_thread_cb_capture_done;
 394
 395 struct _tdm_thread_cb_base {
 396         tdm_thread_cb_type type;
 397         unsigned int length;
 398 };
 399
 400 struct _tdm_thread_cb_output_vblank {
 401         tdm_thread_cb_base base;
 402         unsigned long output_stamp;
 403         unsigned int sequence;
 404         unsigned int tv_sec;
 405         unsigned int tv_usec;
 406         void *user_data;
 407 };
 408
 409 struct _tdm_thread_cb_output_status {
 410         tdm_thread_cb_base base;
 411         unsigned long output_stamp;
 412         tdm_output_conn_status status;
 413         void *user_data;
 414 };
 415
 416 struct _tdm_thread_cb_pp_done {
 417         tdm_thread_cb_base base;
 418         unsigned long pp_stamp;
 419         tbm_surface_h src;
 420         tbm_surface_h dst;
 421         void *user_data;
 422 };
 423
 424 struct _tdm_thread_cb_capture_done {
 425         tdm_thread_cb_base base;
 426         unsigned long capture_stamp;
 427         tbm_surface_h buffer;
 428         void *user_data;
 429 };
 430
 431 tdm_error
 432 tdm_thread_init(tdm_private_loop *private_loop);
 433 void
 434 tdm_thread_deinit(tdm_private_loop *private_loop);
 435 int
 436 tdm_thread_get_fd(tdm_private_loop *private_loop);
 437 tdm_error
 438 tdm_thread_send_cb(tdm_private_loop *private_loop, tdm_thread_cb_base *base);
 439 tdm_error
 440 tdm_thread_handle_cb(tdm_private_loop *private_loop);
 441 int
 442 tdm_thread_in_display_thread(pid_t tid);
 443 int
 444 tdm_thread_is_running(void);
 445
 446 tdm_error
 447 tdm_server_init(tdm_private_loop *private_loop);
 448 void
 449 tdm_server_deinit(tdm_private_loop *private_loop);
 450
 451 unsigned long
 452 tdm_helper_get_time_in_millis(void);
 453 unsigned long
 454 tdm_helper_get_time_in_micros(void);
 455
 456 extern pthread_mutex_t tdm_mutex_check_lock;
 457 extern int tdm_mutex_locked;
 458 extern int tdm_dump_enable;
 459
 460 #define _pthread_mutex_unlock(l) \
 461         do { \
 462                 if (tdm_debug_mutex) \
 463                         TDM_INFO("mutex unlock"); \
 464                 pthread_mutex_lock(&tdm_mutex_check_lock); \
 465                 tdm_mutex_locked = 0; \
 466                 pthread_mutex_unlock(&tdm_mutex_check_lock); \
 467                 pthread_mutex_unlock(l); \
 468         } while (0)
 469 #ifdef TDM_CONFIG_MUTEX_TIMEOUT
 470 #define MUTEX_TIMEOUT_SEC 5
 471 #define _pthread_mutex_lock(l) \
 472         do { \
 473                 if (tdm_debug_mutex) \
 474                         TDM_INFO("mutex lock"); \
 475                 struct timespec rtime; \
 476                 clock_gettime(CLOCK_REALTIME, &rtime); \
 477                 rtime.tv_sec += MUTEX_TIMEOUT_SEC; \
 478                 if (pthread_mutex_timedlock(l, &rtime)) { \
 479                         TDM_ERR("Mutex lock failed PID %d", getpid()); \
 480                         _pthread_mutex_unlock(l); \
 481                 } \
 482                 else { \
 483                         pthread_mutex_lock(&tdm_mutex_check_lock); \
 484                         tdm_mutex_locked = 1; \
 485                         pthread_mutex_unlock(&tdm_mutex_check_lock); \
 486                 } \
 487         } while (0)
 488 #else //TDM_CONFIG_MUTEX_TIMEOUT
 489 #define _pthread_mutex_lock(l) \
 490         do { \
 491                 if (tdm_debug_mutex) \
 492                         TDM_INFO("mutex lock"); \
 493                 pthread_mutex_lock(l); \
 494                 pthread_mutex_lock(&tdm_mutex_check_lock); \
 495                 tdm_mutex_locked = 1; \
 496                 pthread_mutex_unlock(&tdm_mutex_check_lock); \
 497         } while (0)
 498 #endif //TDM_CONFIG_MUTEX_TIMEOUT
 499 //#define TDM_MUTEX_IS_LOCKED() (tdm_mutex_locked == 1)
 500 static inline int TDM_MUTEX_IS_LOCKED(void)
 501 {
 502         int ret;
 503         pthread_mutex_lock(&tdm_mutex_check_lock);
 504         ret = (tdm_mutex_locked == 1);
 505         pthread_mutex_unlock(&tdm_mutex_check_lock);
 506         return ret;
 507 }
 508
 509 tdm_error
 510 _tdm_display_lock(tdm_display *dpy, const char *func);
 511 void
 512 _tdm_display_unlock(tdm_display *dpy, const char *func);
 513
 514 #define tdm_display_lock(dpy)   _tdm_display_lock(dpy, __FUNCTION__)
 515 #define tdm_display_unlock(dpy)   _tdm_display_unlock(dpy, __FUNCTION__)
 516
 517 tdm_error
 518 tdm_display_update_output(tdm_private_display *private_display,
 519                                                   tdm_output *output_backend, int pipe);
 520
 521 #ifdef __cplusplus
 522 }
 523 #endif
 524
 525 #endif /* _TDM_PRIVATE_H_ */