src/tdm_thread.c

   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 #ifdef HAVE_CONFIG_H
  37 #include "config.h"
  38 #endif
  39
  40 #include <sys/socket.h>
  41
  42 #include "tdm.h"
  43 #include "tdm_private.h"
  44 #include "tdm_list.h"
  45
  46 static tdm_private_thread *keep_private_thread;
  47
  48 struct _tdm_private_thread {
  49         tdm_private_loop *private_loop;
  50
  51         pthread_t event_thread;
  52
  53         pid_t display_tid;
  54         pid_t thread_tid;
  55
  56         /* 0: read, 1: write */
  57         int pipe[2];
  58 };
  59
  60 static void*
  61 _tdm_thread_main(void *data)
  62 {
  63         tdm_private_thread *private_thread = (tdm_private_thread*)data;
  64         tdm_private_loop *private_loop = private_thread->private_loop;
  65         int fd;
  66         struct pollfd fds;
  67         int ret;
  68
  69         /* Not lock/unlock for the private_thread and private_loop structure
  70          * because they won't be destroyed as long as tdm thread is running.
  71          * When they're destroyed, we have already exit the tdm thread.
  72          */
  73         private_thread->thread_tid = syscall(SYS_gettid);
  74
  75         TDM_INFO("display_tid:%d, thread_tid: %d",
  76                          private_thread->display_tid, private_thread->thread_tid);
  77
  78         fd = tdm_event_loop_get_fd(private_loop->dpy);
  79         if (fd < 0) {
  80                 TDM_ERR("couldn't get fd");
  81                 goto exit_thread;
  82         }
  83
  84         fds.events = POLLIN;
  85         fds.fd = fd;
  86         fds.revents = 0;
  87
  88         while (1) {
  89                 if (tdm_debug_module & TDM_DEBUG_THREAD)
  90                         TDM_INFO("server flush");
  91                 tdm_event_loop_flush(private_loop->dpy);
  92
  93                 if (tdm_debug_module & TDM_DEBUG_THREAD)
  94                         TDM_INFO("fd(%d) polling in", fd);
  95
  96                 ret = poll(&fds, 1, -1);
  97
  98                 if (tdm_debug_module & TDM_DEBUG_THREAD)
  99                         TDM_INFO("fd(%d) polling out", fd);
 100
 101                 if (ret < 0) {
 102                         if (errno == EINTR || errno == EAGAIN)  /* normal case */
 103                                 continue;
 104                         else {
 105                                 TDM_ERR("poll failed: %m");
 106                                 goto exit_thread;
 107                         }
 108                 }
 109
 110                 if (tdm_debug_module & TDM_DEBUG_THREAD)
 111                         TDM_INFO("thread got events");
 112
 113                 if (tdm_event_loop_dispatch(private_loop->dpy) < 0)
 114                         TDM_ERR("dispatch error");
 115         }
 116
 117 exit_thread:
 118         pthread_exit(NULL);
 119 }
 120
 121 /* NOTE: tdm thread doesn't care about multi-thread. */
 122 INTERN tdm_error
 123 tdm_thread_init(tdm_private_loop *private_loop)
 124 {
 125         tdm_private_display *private_display;
 126         tdm_private_thread *private_thread;
 127         const char *thread;
 128
 129         TDM_RETURN_VAL_IF_FAIL(TDM_MUTEX_IS_LOCKED(), TDM_ERROR_OPERATION_FAILED);
 130         TDM_RETURN_VAL_IF_FAIL(private_loop->dpy, TDM_ERROR_OPERATION_FAILED);
 131
 132         private_display = private_loop->dpy;
 133         TDM_RETURN_VAL_IF_FAIL(private_display->private_loop, TDM_ERROR_OPERATION_FAILED);
 134
 135         if (private_loop->private_thread)
 136                 return TDM_ERROR_NONE;
 137
 138         /* enable as default */
 139         thread = getenv("TDM_THREAD");
 140         if (!thread || strncmp(thread, "1", 1)) {
 141                 TDM_INFO("not using a TDM event thread: %s", (thread) ? thread : "none");
 142                 return TDM_ERROR_NONE;
 143         }
 144
 145         private_thread = calloc(1, sizeof * private_thread);
 146         if (!private_thread) {
 147                 TDM_ERR("alloc failed");
 148                 return TDM_ERROR_OUT_OF_MEMORY;
 149         }
 150
 151         if (pipe(private_thread->pipe) != 0) {
 152                 TDM_ERR("socketpair failed: %m");
 153                 free(private_thread);
 154                 return TDM_ERROR_OPERATION_FAILED;
 155         }
 156
 157         private_thread->private_loop = private_loop;
 158         private_loop->private_thread = private_thread;
 159
 160         private_thread->display_tid = syscall(SYS_gettid);
 161
 162         pthread_create(&private_thread->event_thread, NULL, _tdm_thread_main,
 163                                    private_thread);
 164
 165         keep_private_thread = private_thread;
 166
 167         TDM_INFO("using a TDM event thread. pipe(%d,%d)",
 168                          private_thread->pipe[0], private_thread->pipe[1]);
 169
 170         return TDM_ERROR_NONE;
 171 }
 172
 173 INTERN void
 174 tdm_thread_deinit(tdm_private_loop *private_loop)
 175 {
 176         tdm_private_display *private_display;
 177
 178         TDM_RETURN_IF_FAIL(TDM_MUTEX_IS_LOCKED());
 179
 180         if (!private_loop->private_thread)
 181                 return;
 182
 183         pthread_cancel(private_loop->private_thread->event_thread);
 184
 185         private_display = private_loop->dpy;
 186
 187         /* before falling into the block of pthread_join, we have to unlock the mutex
 188          * for subthread to use the mutex.
 189          */
 190         _pthread_mutex_unlock(&private_display->lock);
 191         pthread_join(private_loop->private_thread->event_thread, NULL);
 192
 193         if (private_loop->private_thread->pipe[0] >= 0)
 194                 close(private_loop->private_thread->pipe[0]);
 195         if (private_loop->private_thread->pipe[1] >= 0)
 196                 close(private_loop->private_thread->pipe[1]);
 197
 198         free(private_loop->private_thread);
 199         private_loop->private_thread = NULL;
 200         keep_private_thread = NULL;
 201
 202         TDM_INFO("Finish a TDM event thread");
 203 }
 204
 205 INTERN int
 206 tdm_thread_get_fd(tdm_private_loop *private_loop)
 207 {
 208         tdm_private_thread *private_thread;
 209
 210         TDM_RETURN_VAL_IF_FAIL(TDM_MUTEX_IS_LOCKED(), TDM_ERROR_OPERATION_FAILED);
 211         TDM_RETURN_VAL_IF_FAIL(private_loop, -1);
 212         TDM_RETURN_VAL_IF_FAIL(private_loop->private_thread, -1);
 213
 214         private_thread = private_loop->private_thread;
 215
 216         return private_thread->pipe[0];
 217 }
 218
 219 INTERN tdm_error
 220 tdm_thread_send_cb(tdm_private_loop *private_loop, tdm_thread_cb_base *base)
 221 {
 222         tdm_private_thread *private_thread;
 223         ssize_t len;
 224
 225         TDM_RETURN_VAL_IF_FAIL(TDM_MUTEX_IS_LOCKED(), TDM_ERROR_OPERATION_FAILED);
 226         TDM_RETURN_VAL_IF_FAIL(base, TDM_ERROR_INVALID_PARAMETER);
 227         TDM_RETURN_VAL_IF_FAIL(private_loop, TDM_ERROR_INVALID_PARAMETER);
 228         TDM_RETURN_VAL_IF_FAIL(private_loop->private_thread, TDM_ERROR_INVALID_PARAMETER);
 229
 230         private_thread = private_loop->private_thread;
 231
 232         if (tdm_debug_module & TDM_DEBUG_THREAD)
 233                 TDM_INFO("fd(%d) type(%d), length(%d)",
 234                                  private_thread->pipe[1], base->type, base->length);
 235
 236         len = write(private_thread->pipe[1], base, base->length);
 237         if (len != base->length) {
 238                 TDM_ERR("write failed (%d != %d): %m", (int)len, base->length);
 239                 return TDM_ERROR_OPERATION_FAILED;
 240         }
 241
 242         return TDM_ERROR_NONE;
 243 }
 244
 245 INTERN tdm_error
 246 tdm_thread_handle_cb(tdm_private_loop *private_loop)
 247 {
 248         tdm_private_display *private_display;
 249         tdm_private_thread *private_thread;
 250         tdm_thread_cb_base *base;
 251         char buffer[1024];
 252         unsigned int len, i;
 253
 254         /* DON'T check TDM_MUTEX_IS_LOCKED here */
 255
 256         TDM_RETURN_VAL_IF_FAIL(private_loop, TDM_ERROR_INVALID_PARAMETER);
 257         TDM_RETURN_VAL_IF_FAIL(private_loop->private_thread, TDM_ERROR_INVALID_PARAMETER);
 258
 259         private_thread = private_loop->private_thread;
 260         private_display = private_loop->dpy;
 261
 262         len = read(private_thread->pipe[0], buffer, sizeof buffer);
 263
 264         if (tdm_debug_module & TDM_DEBUG_THREAD)
 265                 TDM_INFO("fd(%d) read length(%d)", private_thread->pipe[0], len);
 266
 267         if (len == 0)
 268                 return TDM_ERROR_NONE;
 269
 270         if (len < sizeof * base) {
 271                 TDM_NEVER_GET_HERE();
 272                 return TDM_ERROR_OPERATION_FAILED;
 273         }
 274
 275         _pthread_mutex_lock(&private_display->lock);
 276
 277         i = 0;
 278         while (i < len) {
 279                 base = (tdm_thread_cb_base*)&buffer[i];
 280                 if (tdm_debug_module & TDM_DEBUG_THREAD)
 281                         TDM_INFO("type(%d), length(%d)", base->type, base->length);
 282                 switch (base->type) {
 283                 case TDM_THREAD_CB_OUTPUT_COMMIT: {
 284                         tdm_thread_cb_output_commit *output_commit = (tdm_thread_cb_output_commit*)base;
 285                         tdm_output *output_backend =
 286                                 tdm_display_find_output_stamp(private_loop->dpy, output_commit->output_stamp);
 287                         if (!output_backend) {
 288                                 TDM_WRN("no output(%f)", output_commit->output_stamp);
 289                                 break;
 290                         }
 291                         tdm_output_cb_commit(output_backend, output_commit->sequence,
 292                                                                  output_commit->tv_sec, output_commit->tv_usec,
 293                                                                  output_commit->user_data);
 294                         break;
 295                 }
 296                 case TDM_THREAD_CB_OUTPUT_VBLANK: {
 297                         tdm_thread_cb_output_vblank *output_vblank = (tdm_thread_cb_output_vblank*)base;
 298                         tdm_output *output_backend =
 299                                 tdm_display_find_output_stamp(private_loop->dpy, output_vblank->output_stamp);
 300                         if (!output_backend) {
 301                                 TDM_WRN("no output(%f)", output_vblank->output_stamp);
 302                                 break;
 303                         }
 304                         tdm_output_cb_vblank(output_backend, output_vblank->sequence,
 305                                                                  output_vblank->tv_sec, output_vblank->tv_usec,
 306                                                                  output_vblank->user_data);
 307                         break;
 308                 }
 309                 case TDM_THREAD_CB_OUTPUT_STATUS: {
 310                         /* LCOV_EXCL_START */
 311                         tdm_thread_cb_output_status *output_status = (tdm_thread_cb_output_status*)base;
 312                         tdm_output *output_backend =
 313                                 tdm_display_find_output_stamp(private_loop->dpy, output_status->output_stamp);
 314                         if (!output_backend) {
 315                                 TDM_WRN("no output(%f)", output_status->output_stamp);
 316                                 break;
 317                         }
 318                         tdm_output_cb_status(output_backend, output_status->status,
 319                                                                  output_status->user_data);
 320                         break;
 321                         /* LCOV_EXCL_STOP */
 322                 }
 323                 case TDM_THREAD_CB_OUTPUT_DPMS: {
 324                         /* LCOV_EXCL_START */
 325                         tdm_thread_cb_output_dpms *output_dpms = (tdm_thread_cb_output_dpms*)base;
 326                         tdm_output *output_backend =
 327                                 tdm_display_find_output_stamp(private_loop->dpy, output_dpms->output_stamp);
 328                         if (!output_backend) {
 329                                 TDM_WRN("no output(%f)", output_dpms->output_stamp);
 330                                 break;
 331                         }
 332                         tdm_output_cb_dpms(output_backend, output_dpms->dpms, output_dpms->user_data);
 333                         break;
 334                         /* LCOV_EXCL_STOP */
 335                 }
 336                 case TDM_THREAD_CB_PP_DONE: {
 337                         tdm_thread_cb_pp_done *pp_done = (tdm_thread_cb_pp_done*)base;
 338                         tdm_pp *pp_backend =
 339                                 tdm_pp_find_stamp(private_loop->dpy, pp_done->pp_stamp);
 340                         if (!pp_backend) {
 341                                 TDM_WRN("no pp(%f)", pp_done->pp_stamp);
 342                                 break;
 343                         }
 344                         tdm_pp_cb_done(pp_backend, pp_done->src, pp_done->dst, pp_done->user_data);
 345                         break;
 346                 }
 347                 case TDM_THREAD_CB_CAPTURE_DONE: {
 348                         tdm_thread_cb_capture_done *capture_done = (tdm_thread_cb_capture_done*)base;
 349                         tdm_capture *capture_backend =
 350                                 tdm_capture_find_stamp(private_loop->dpy, capture_done->capture_stamp);
 351                         if (!capture_backend) {
 352                                 TDM_WRN("no capture(%f)", capture_done->capture_stamp);
 353                                 break;
 354                         }
 355                         tdm_capture_cb_done(capture_backend, capture_done->buffer, capture_done->user_data);
 356                         break;
 357                 }
 358                 case TDM_THREAD_CB_VBLANK_SW: {
 359                         tdm_thread_cb_vblank_sw *vblank_sw = (tdm_thread_cb_vblank_sw*)base;
 360                         tdm_vblank_cb_vblank_SW(NULL, vblank_sw->vblank_stamp);
 361                         break;
 362                 }
 363                 case TDM_THREAD_CB_NEED_VALIDATE: {
 364                         tdm_thread_cb_need_validate *ev = (tdm_thread_cb_need_validate*)base;
 365                         tdm_output_cb_need_validate(ev->o);
 366                         break;
 367                 }
 368                 default:
 369                         break;
 370                 }
 371                 i += base->length;
 372         }
 373
 374         _pthread_mutex_unlock(&private_display->lock);
 375
 376         return TDM_ERROR_NONE;
 377 }
 378
 379 INTERN int
 380 tdm_thread_in_display_thread(pid_t tid)
 381 {
 382         if (!keep_private_thread)
 383                 return 1;
 384
 385         /* DON'T check TDM_MUTEX_IS_LOCKED here */
 386
 387         return (keep_private_thread->display_tid == tid) ? 1 : 0;
 388 }
 389
 390 INTERN int
 391 tdm_thread_is_running(void)
 392 {
 393         /* DON'T check TDM_MUTEX_IS_LOCKED here */
 394
 395         return (keep_private_thread) ? 1 : 0;
 396 }