src/tbm_sync.c

   1 /**************************************************************************
   2
   3 libtbm
   4
   5 Copyright 2012 - 2016 Samsung Electronics co., Ltd. All Rights Reserved.
   6
   7 Contact: SooChan Lim <sc1.lim@samsung.com>,
   8                  Changyeon Lee <cyeon.lee@samsung.com>,
   9                  Boram Park <boram1288.park@samsung.com>,
  10                  Sangjin Lee <lsj119@samsung.com>
  11
  12 Permission is hereby granted, free of charge, to any person obtaining a
  13 copy of this software and associated documentation files (the
  14 "Software"), to deal in the Software without restriction, including
  15 without limitation the rights to use, copy, modify, merge, publish,
  16 distribute, sub license, and/or sell copies of the Software, and to
  17 permit persons to whom the Software is furnished to do so, subject to
  18 the following conditions:
  19
  20 The above copyright notice and this permission notice (including the
  21 next paragraph) shall be included in all copies or substantial portions
  22 of the Software.
  23
  24 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  25 OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  26 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
  27 IN NO EVENT SHALL PRECISION INSIGHT AND/OR ITS SUPPLIERS BE LIABLE FOR
  28 ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  29 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  30 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  31
  32 **************************************************************************/
  33
  34 #include "config.h"
  35
  36 #include "tbm_bufmgr_int.h"
  37 #include "tbm_sync.h"
  38
  39 #include <string.h>
  40 #include <errno.h>
  41 #include <sys/ioctl.h>
  42 #include <linux/types.h>
  43
  44 /* IOCTLs for timeline file object. */
  45 #define TIMELINE_IOC_MAGIC                      'W'
  46 #define TIMELINE_IOC_CREATE_FENCE       _IOWR(TIMELINE_IOC_MAGIC, 0, struct create_fence_data)
  47 #define TIMELINE_IOC_INC                        _IOW(TIMELINE_IOC_MAGIC, 1, __u32)
  48
  49 /* IOCTLs for fence file object. */
  50 #define FENCE_IOC_MAGIC         '>'
  51 #define FENCE_IOC_WAIT          _IOW(FENCE_IOC_MAGIC, 0, __s32)
  52 #define FENCE_IOC_MERGE         _IOWR(FENCE_IOC_MAGIC, 1, struct sync_merge_data)
  53
  54 /* Path to the sync device file. */
  55 #define SYNC_DEVICE_PATH        "/dev/sw_sync"
  56
  57 /* Argument data structure for the timeline.create_fence ioctl. */
  58 struct create_fence_data {
  59         __u32   value;          /* Pt value on the timeline for the fence (IN) */
  60         char    name[32];       /* Name of the fence object (IN) */
  61         __s32   fence;          /* File descriptor for the created fence (OUT) */
  62 };
  63
  64 /* Argument data structure for the fence.merge ioctl. */
  65 struct sync_merge_data {
  66         __s32   fd2;            /* fence to merged with the fence (IN) */
  67         char    name[32];       /* Name of the new fence object (IN) */
  68         __s32   fence;          /* File descriptor for the new fence (OUT) */
  69 };
  70
  71 #define ERRNO_BUF_SIZE  256
  72
  73 /* LCOV_EXCL_START */
  74 static inline void
  75 _log_errno()
  76 {
  77         /* calling strerror_r() might overwrite errno, so save it. */
  78         int             errnum = errno;
  79         char    buf[ERRNO_BUF_SIZE];
  80
  81         if (strerror_r(errnum, buf, ERRNO_BUF_SIZE) == 0) {
  82                 TBM_ERR("errno : %d(%s)\n", errnum, buf);
  83                 return;
  84         } else {
  85                 TBM_ERR("errno : %d()\n", errnum);
  86                 return;
  87         }
  88 }
  89
  90 static inline void
  91 _copy_string(char *dst, const char *src, size_t size)
  92 {
  93         if (size == 0)
  94                 return;
  95
  96         if (src == NULL || size == 1) {
  97                 *dst = '\0';
  98                 return;
  99         }
 100
 101         while (size-- != 1) {
 102                 if ((*dst++ = *src++) == '\0')
 103                         return;
 104         }
 105
 106         *dst = '\0';
 107 }
 108
 109 tbm_fd
 110 tbm_sync_timeline_create(void)
 111 {
 112         tbm_fd timeline = open(SYNC_DEVICE_PATH, O_RDWR | O_CLOEXEC);
 113
 114         if (timeline == -1)
 115                 _log_errno();
 116
 117         return timeline;
 118 }
 119
 120 int
 121 tbm_sync_timeline_inc(tbm_fd timeline, unsigned int count)
 122 {
 123         __u32 arg = count;
 124
 125         if (ioctl(timeline, TIMELINE_IOC_INC, &arg) == -1) {
 126                 _log_errno();
 127                 return 0;
 128         }
 129
 130         return 1;
 131 }
 132
 133 tbm_fd
 134 tbm_sync_fence_create(tbm_fd timeline, const char *name, unsigned int value)
 135 {
 136         struct create_fence_data data = { .value = value };
 137
 138         _copy_string(data.name, name, 32);
 139
 140         if (ioctl(timeline, TIMELINE_IOC_CREATE_FENCE, &data) == -1) {
 141                 _log_errno();
 142                 return -1;
 143         }
 144
 145         return data.fence;
 146 }
 147
 148 int
 149 tbm_sync_fence_wait(tbm_fd fence, int timeout)
 150 {
 151         __s32   arg = timeout;
 152         int             ret;
 153
 154         /* Retry while ioctl() ended up with interrupt. */
 155         do {
 156                 ret = ioctl(fence, FENCE_IOC_WAIT, &arg);
 157         } while (ret == -1 && errno == EINTR);
 158
 159         /* ioctl() was successful. */
 160         if (ret == 0)
 161                 return 1;
 162
 163         /* ioctl() ended up with timeout. */
 164         if (errno == ETIME)
 165                 return -1;
 166
 167         /* ioctl() failed for some reason. */
 168         _log_errno();
 169         return 0;
 170 }
 171
 172 tbm_fd
 173 tbm_sync_fence_merge(const char *name, tbm_fd fence1, tbm_fd fence2)
 174 {
 175         struct sync_merge_data data = { .fd2 = fence2 };
 176
 177         _copy_string(data.name, name, 32);
 178
 179         if (ioctl(fence1, FENCE_IOC_MERGE, &data) == -1) {
 180                 _log_errno();
 181                 return -1;
 182         }
 183
 184         return data.fence;
 185 }
 186 /* LCOV_EXCL_STOP */