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