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
 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
 175 struct _tdm_private_layer {
 176         struct list_head link;
 177
 178         tdm_private_display *private_display;
 179         tdm_private_output *private_output;
 180
 181         tdm_caps_layer caps;
 182         tdm_layer *layer_backend;
 183
 184         tbm_surface_h pending_buffer;
 185         tbm_surface_h waiting_buffer;
 186         tbm_surface_h showing_buffer;
 187         tbm_surface_queue_h buffer_queue;
 188
 189         struct list_head capture_list;
 190
 191         unsigned int usable;
 192 };
 193
 194 struct _tdm_private_pp {
 195         struct list_head link;
 196
 197         unsigned long stamp;
 198
 199         tdm_private_display *private_display;
 200
 201         tdm_pp *pp_backend;
 202
 203         struct list_head src_pending_buffer_list;
 204         struct list_head dst_pending_buffer_list;
 205         struct list_head src_buffer_list;
 206         struct list_head dst_buffer_list;
 207
 208         pid_t owner_tid;
 209 };
 210
 211 struct _tdm_private_capture {
 212         struct list_head link;
 213         struct list_head display_link;
 214
 215         unsigned long stamp;
 216
 217         tdm_capture_target target;
 218
 219         tdm_private_display *private_display;
 220         tdm_private_output *private_output;
 221         tdm_private_layer *private_layer;
 222
 223         tdm_capture *capture_backend;
 224
 225         struct list_head pending_buffer_list;
 226         struct list_head buffer_list;
 227
 228         pid_t owner_tid;
 229 };
 230
 231 /* CAUTION:
 232  * Note that this structure is not thread-safe. If there is no TDM thread, all
 233  * TDM resources are protected by private_display's lock. If there is a TDM
 234  * thread, this struct will be used only in a TDM thread. So, we don't need to
 235  * protect this structure.
 236  */
 237 struct _tdm_private_loop {
 238         /* TDM uses wl_event_loop to handle various event sources including the TDM
 239          * backend's fd.
 240          */
 241         struct wl_display *wl_display;
 242         struct wl_event_loop *wl_loop;
 243
 244         int backend_fd;
 245         tdm_event_loop_source *backend_source;
 246
 247         /* In event loop, all resources are accessed by this dpy.
 248          * CAUTION:
 249          * - DO NOT include other private structure in this structure because this
 250          *   struct is not thread-safe.
 251          */
 252         tdm_display *dpy;
 253
 254         /* for handling TDM client requests */
 255         tdm_private_server *private_server;
 256
 257         /* To have a TDM event thread. If TDM_THREAD enviroment variable is not set
 258          * private_thread is NULL.
 259          */
 260         tdm_private_thread *private_thread;
 261 };
 262
 263 struct _tdm_private_vblank_handler {
 264         struct list_head link;
 265
 266         tdm_private_output *private_output;
 267         tdm_output_vblank_handler func;
 268         void *user_data;
 269
 270         pid_t owner_tid;
 271 };
 272
 273 struct _tdm_private_commit_handler {
 274         struct list_head link;
 275
 276         tdm_private_output *private_output;
 277         tdm_output_commit_handler func;
 278         void *user_data;
 279
 280         pid_t owner_tid;
 281 };
 282
 283 struct _tdm_private_change_handler {
 284         struct list_head link;
 285
 286         tdm_private_output *private_output;
 287         tdm_output_change_handler func;
 288         void *user_data;
 289
 290         pid_t owner_tid;
 291 };
 292
 293 typedef struct _tdm_buffer_info {
 294         tbm_surface_h buffer;
 295
 296         /* ref_count for backend */
 297         int backend_ref_count;
 298
 299         struct list_head release_funcs;
 300         struct list_head destroy_funcs;
 301
 302         struct list_head *list;
 303         struct list_head link;
 304 } tdm_buffer_info;
 305
 306 tdm_private_output *
 307 tdm_display_find_output_stamp(tdm_private_display *private_display,
 308                               unsigned long stamp);
 309 tdm_private_pp *
 310 tdm_pp_find_stamp(tdm_private_display *private_display, unsigned long stamp);
 311 tdm_private_capture *
 312 tdm_capture_find_stamp(tdm_private_display *private_display, unsigned long stamp);
 313
 314 void
 315 tdm_output_cb_vblank(tdm_output *output_backend, unsigned int sequence,
 316                      unsigned int tv_sec, unsigned int tv_usec, void *user_data);
 317 void
 318 tdm_output_cb_commit(tdm_output *output_backend, unsigned int sequence,
 319                      unsigned int tv_sec, unsigned int tv_usec, void *user_data);
 320 void
 321 tdm_output_cb_status(tdm_output *output_backend, tdm_output_conn_status status,
 322                      void *user_data);
 323 void
 324 tdm_pp_cb_done(tdm_pp *pp_backend, tbm_surface_h src, tbm_surface_h dst,
 325                void *user_data);
 326 void
 327 tdm_capture_cb_done(tdm_capture *capture_backend, tbm_surface_h buffer,
 328                     void *user_data);
 329
 330 void
 331 tdm_output_call_change_handler_internal(tdm_private_output *private_output,
 332                                         struct list_head *change_handler_list,
 333                                         tdm_output_change_type type,
 334                                         tdm_value value);
 335
 336 tdm_private_pp *
 337 tdm_pp_create_internal(tdm_private_display *private_display, tdm_error *error);
 338 void
 339 tdm_pp_destroy_internal(tdm_private_pp *private_pp);
 340
 341 tdm_private_capture *
 342 tdm_capture_create_output_internal(tdm_private_output *private_output,
 343                                    tdm_error *error);
 344 tdm_private_capture *
 345 tdm_capture_create_layer_internal(tdm_private_layer *private_layer,
 346                                   tdm_error *error);
 347 void
 348 tdm_capture_destroy_internal(tdm_private_capture *private_capture);
 349
 350 /* utility buffer functions for private */
 351 tdm_buffer_info*
 352 tdm_buffer_get_info(tbm_surface_h buffer);
 353 tbm_surface_h
 354 tdm_buffer_list_get_first_entry(struct list_head *list);
 355 void
 356 tdm_buffer_list_dump(struct list_head *list);
 357
 358 /* event functions for private */
 359 tdm_error
 360 tdm_event_loop_init(tdm_private_display *private_display);
 361 void
 362 tdm_event_loop_deinit(tdm_private_display *private_display);
 363 void
 364 tdm_event_loop_create_backend_source(tdm_private_display *private_display);
 365 int
 366 tdm_event_loop_get_fd(tdm_private_display *private_display);
 367 tdm_error
 368 tdm_event_loop_dispatch(tdm_private_display *private_display);
 369 void
 370 tdm_event_loop_flush(tdm_private_display *private_display);
 371
 372 typedef enum {
 373         TDM_THREAD_CB_NONE,
 374         TDM_THREAD_CB_OUTPUT_COMMIT,
 375         TDM_THREAD_CB_OUTPUT_VBLANK,
 376         TDM_THREAD_CB_OUTPUT_STATUS,
 377         TDM_THREAD_CB_PP_DONE,
 378         TDM_THREAD_CB_CAPTURE_DONE,
 379 } tdm_thread_cb_type;
 380
 381 typedef struct _tdm_thread_cb_base tdm_thread_cb_base;
 382 typedef struct _tdm_thread_cb_output_vblank tdm_thread_cb_output_commit;
 383 typedef struct _tdm_thread_cb_output_vblank tdm_thread_cb_output_vblank;
 384 typedef struct _tdm_thread_cb_output_status tdm_thread_cb_output_status;
 385 typedef struct _tdm_thread_cb_pp_done tdm_thread_cb_pp_done;
 386 typedef struct _tdm_thread_cb_capture_done tdm_thread_cb_capture_done;
 387
 388 struct _tdm_thread_cb_base {
 389         tdm_thread_cb_type type;
 390         unsigned int length;
 391 };
 392
 393 struct _tdm_thread_cb_output_vblank {
 394         tdm_thread_cb_base base;
 395         unsigned long output_stamp;
 396         unsigned int sequence;
 397         unsigned int tv_sec;
 398         unsigned int tv_usec;
 399         void *user_data;
 400 };
 401
 402 struct _tdm_thread_cb_output_status {
 403         tdm_thread_cb_base base;
 404         unsigned long output_stamp;
 405         tdm_output_conn_status status;
 406         void *user_data;
 407 };
 408
 409 struct _tdm_thread_cb_pp_done {
 410         tdm_thread_cb_base base;
 411         unsigned long pp_stamp;
 412         tbm_surface_h src;
 413         tbm_surface_h dst;
 414         void *user_data;
 415 };
 416
 417 struct _tdm_thread_cb_capture_done {
 418         tdm_thread_cb_base base;
 419         unsigned long capture_stamp;
 420         tbm_surface_h buffer;
 421         void *user_data;
 422 };
 423
 424 tdm_error
 425 tdm_thread_init(tdm_private_loop *private_loop);
 426 void
 427 tdm_thread_deinit(tdm_private_loop *private_loop);
 428 int
 429 tdm_thread_get_fd(tdm_private_loop *private_loop);
 430 tdm_error
 431 tdm_thread_send_cb(tdm_private_loop *private_loop, tdm_thread_cb_base *base);
 432 tdm_error
 433 tdm_thread_handle_cb(tdm_private_loop *private_loop);
 434 int
 435 tdm_thread_in_display_thread(tdm_private_loop *private_loop, pid_t tid);
 436
 437 tdm_error
 438 tdm_server_init(tdm_private_loop *private_loop);
 439 void
 440 tdm_server_deinit(tdm_private_loop *private_loop);
 441
 442 unsigned long
 443 tdm_helper_get_time_in_millis(void);
 444 int
 445 tdm_helper_unlock_in_cb(tdm_private_display *private_display);
 446 void
 447 tdm_helper_lock_in_cb(tdm_private_display *private_display, int need_lock);
 448
 449 int
 450 tdm_helper_get_dump_count(void);
 451 char *
 452 tdm_helper_get_dump_path(void);
 453
 454 #define _pthread_mutex_lock(l) \
 455     do {if (tdm_debug_mutex) TDM_INFO("mutex lock"); pthread_mutex_lock(l);} while (0)
 456 #define _pthread_mutex_unlock(l) \
 457     do {if (tdm_debug_mutex) TDM_INFO("mutex unlock"); pthread_mutex_unlock(l);} while (0)
 458
 459 #ifdef __cplusplus
 460 }
 461 #endif
 462
 463 #endif /* _TDM_PRIVATE_H_ */