freedreno/freedreno_priv.h

   1 /* -*- mode: C; c-file-style: "k&r"; tab-width 4; indent-tabs-mode: t; -*- */
   2
   3 /*
   4  * Copyright (C) 2012 Rob Clark <robclark@freedesktop.org>
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a
   7  * copy of this software and associated documentation files (the "Software"),
   8  * to deal in the Software without restriction, including without limitation
   9  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  10  * and/or sell copies of the Software, and to permit persons to whom the
  11  * Software is furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice (including the next
  14  * paragraph) shall be included in all copies or substantial portions of the
  15  * Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  20  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  21  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  22  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  23  * SOFTWARE.
  24  *
  25  * Authors:
  26  *    Rob Clark <robclark@freedesktop.org>
  27  */
  28
  29 #ifndef FREEDRENO_PRIV_H_
  30 #define FREEDRENO_PRIV_H_
  31
  32 #ifdef HAVE_CONFIG_H
  33 #include "config.h"
  34 #endif
  35
  36 #include <stdlib.h>
  37 #include <errno.h>
  38 #include <string.h>
  39 #include <unistd.h>
  40 #include <errno.h>
  41 #include <fcntl.h>
  42 #include <sys/ioctl.h>
  43 #include <pthread.h>
  44 #include <stdio.h>
  45 #include <assert.h>
  46
  47 #include "libdrm_macros.h"
  48 #include "xf86drm.h"
  49 #include "xf86atomic.h"
  50
  51 #include "util_double_list.h"
  52
  53 #include "freedreno_drmif.h"
  54 #include "freedreno_ringbuffer.h"
  55 #include "drm.h"
  56
  57 #ifndef TRUE
  58 #  define TRUE 1
  59 #endif
  60 #ifndef FALSE
  61 #  define FALSE 0
  62 #endif
  63
  64 struct fd_device_funcs {
  65         int (*bo_new_handle)(struct fd_device *dev, uint32_t size,
  66                         uint32_t flags, uint32_t *handle);
  67         struct fd_bo * (*bo_from_handle)(struct fd_device *dev,
  68                         uint32_t size, uint32_t handle);
  69         struct fd_pipe * (*pipe_new)(struct fd_device *dev, enum fd_pipe_id id,
  70                         unsigned prio);
  71         void (*destroy)(struct fd_device *dev);
  72 };
  73
  74 struct fd_bo_bucket {
  75         uint32_t size;
  76         struct list_head list;
  77 };
  78
  79 struct fd_bo_cache {
  80         struct fd_bo_bucket cache_bucket[14 * 4];
  81         int num_buckets;
  82         time_t time;
  83 };
  84
  85 struct fd_device {
  86         int fd;
  87         enum fd_version version;
  88         atomic_t refcnt;
  89
  90         /* tables to keep track of bo's, to avoid "evil-twin" fd_bo objects:
  91          *
  92          *   handle_table: maps handle to fd_bo
  93          *   name_table: maps flink name to fd_bo
  94          *
  95          * We end up needing two tables, because DRM_IOCTL_GEM_OPEN always
  96          * returns a new handle.  So we need to figure out if the bo is already
  97          * open in the process first, before calling gem-open.
  98          */
  99         void *handle_table, *name_table;
 100
 101         const struct fd_device_funcs *funcs;
 102
 103         struct fd_bo_cache bo_cache;
 104
 105         int closefd;        /* call close(fd) upon destruction */
 106
 107         /* just for valgrind: */
 108         int bo_size;
 109 };
 110
 111 drm_private void fd_bo_cache_init(struct fd_bo_cache *cache, int coarse);
 112 drm_private void fd_bo_cache_cleanup(struct fd_bo_cache *cache, time_t time);
 113 drm_private struct fd_bo * fd_bo_cache_alloc(struct fd_bo_cache *cache,
 114                 uint32_t *size, uint32_t flags);
 115 drm_private int fd_bo_cache_free(struct fd_bo_cache *cache, struct fd_bo *bo);
 116
 117 /* for where @table_lock is already held: */
 118 drm_private void fd_device_del_locked(struct fd_device *dev);
 119
 120 struct fd_pipe_funcs {
 121         struct fd_ringbuffer * (*ringbuffer_new)(struct fd_pipe *pipe, uint32_t size);
 122         int (*get_param)(struct fd_pipe *pipe, enum fd_param_id param, uint64_t *value);
 123         int (*wait)(struct fd_pipe *pipe, uint32_t timestamp, uint64_t timeout);
 124         void (*destroy)(struct fd_pipe *pipe);
 125 };
 126
 127 struct fd_pipe {
 128         struct fd_device *dev;
 129         enum fd_pipe_id id;
 130         uint32_t gpu_id;
 131         const struct fd_pipe_funcs *funcs;
 132 };
 133
 134 struct fd_ringmarker {
 135         struct fd_ringbuffer *ring;
 136         uint32_t *cur;
 137 };
 138
 139 struct fd_ringbuffer_funcs {
 140         void * (*hostptr)(struct fd_ringbuffer *ring);
 141         int (*flush)(struct fd_ringbuffer *ring, uint32_t *last_start,
 142                         int in_fence_fd, int *out_fence_fd);
 143         void (*grow)(struct fd_ringbuffer *ring, uint32_t size);
 144         void (*reset)(struct fd_ringbuffer *ring);
 145         void (*emit_reloc)(struct fd_ringbuffer *ring,
 146                         const struct fd_reloc *reloc);
 147         uint32_t (*emit_reloc_ring)(struct fd_ringbuffer *ring,
 148                         struct fd_ringbuffer *target, uint32_t cmd_idx,
 149                         uint32_t submit_offset, uint32_t size);
 150         uint32_t (*cmd_count)(struct fd_ringbuffer *ring);
 151         void (*destroy)(struct fd_ringbuffer *ring);
 152 };
 153
 154 struct fd_bo_funcs {
 155         int (*offset)(struct fd_bo *bo, uint64_t *offset);
 156         int (*cpu_prep)(struct fd_bo *bo, struct fd_pipe *pipe, uint32_t op);
 157         void (*cpu_fini)(struct fd_bo *bo);
 158         int (*madvise)(struct fd_bo *bo, int willneed);
 159         void (*destroy)(struct fd_bo *bo);
 160 };
 161
 162 struct fd_bo {
 163         struct fd_device *dev;
 164         uint32_t size;
 165         uint32_t handle;
 166         uint32_t name;
 167         void *map;
 168         atomic_t refcnt;
 169         const struct fd_bo_funcs *funcs;
 170
 171         int bo_reuse;
 172         struct list_head list;   /* bucket-list entry */
 173         time_t free_time;        /* time when added to bucket-list */
 174 };
 175
 176 #define ALIGN(v,a) (((v) + (a) - 1) & ~((a) - 1))
 177 #define ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]))
 178
 179 #define enable_debug 0  /* TODO make dynamic */
 180
 181 #define INFO_MSG(fmt, ...) \
 182                 do { drmMsg("[I] "fmt " (%s:%d)\n", \
 183                                 ##__VA_ARGS__, __FUNCTION__, __LINE__); } while (0)
 184 #define DEBUG_MSG(fmt, ...) \
 185                 do if (enable_debug) { drmMsg("[D] "fmt " (%s:%d)\n", \
 186                                 ##__VA_ARGS__, __FUNCTION__, __LINE__); } while (0)
 187 #define WARN_MSG(fmt, ...) \
 188                 do { drmMsg("[W] "fmt " (%s:%d)\n", \
 189                                 ##__VA_ARGS__, __FUNCTION__, __LINE__); } while (0)
 190 #define ERROR_MSG(fmt, ...) \
 191                 do { drmMsg("[E] " fmt " (%s:%d)\n", \
 192                                 ##__VA_ARGS__, __FUNCTION__, __LINE__); } while (0)
 193
 194 #define U642VOID(x) ((void *)(unsigned long)(x))
 195 #define VOID2U64(x) ((uint64_t)(unsigned long)(x))
 196
 197 static inline uint32_t
 198 offset_bytes(void *end, void *start)
 199 {
 200         return ((char *)end) - ((char *)start);
 201 }
 202
 203 #ifdef HAVE_VALGRIND
 204 #  include <memcheck.h>
 205
 206 /*
 207  * For tracking the backing memory (if valgrind enabled, we force a mmap
 208  * for the purposes of tracking)
 209  */
 210 static inline void VG_BO_ALLOC(struct fd_bo *bo)
 211 {
 212         if (bo && RUNNING_ON_VALGRIND) {
 213                 VALGRIND_MALLOCLIKE_BLOCK(fd_bo_map(bo), bo->size, 0, 1);
 214         }
 215 }
 216
 217 static inline void VG_BO_FREE(struct fd_bo *bo)
 218 {
 219         VALGRIND_FREELIKE_BLOCK(bo->map, 0);
 220 }
 221
 222 /*
 223  * For tracking bo structs that are in the buffer-cache, so that valgrind
 224  * doesn't attribute ownership to the first one to allocate the recycled
 225  * bo.
 226  *
 227  * Note that the list_head in fd_bo is used to track the buffers in cache
 228  * so disable error reporting on the range while they are in cache so
 229  * valgrind doesn't squawk about list traversal.
 230  *
 231  */
 232 static inline void VG_BO_RELEASE(struct fd_bo *bo)
 233 {
 234         if (RUNNING_ON_VALGRIND) {
 235                 VALGRIND_DISABLE_ADDR_ERROR_REPORTING_IN_RANGE(bo, bo->dev->bo_size);
 236                 VALGRIND_MAKE_MEM_NOACCESS(bo, bo->dev->bo_size);
 237                 VALGRIND_FREELIKE_BLOCK(bo->map, 0);
 238         }
 239 }
 240 static inline void VG_BO_OBTAIN(struct fd_bo *bo)
 241 {
 242         if (RUNNING_ON_VALGRIND) {
 243                 VALGRIND_MAKE_MEM_DEFINED(bo, bo->dev->bo_size);
 244                 VALGRIND_ENABLE_ADDR_ERROR_REPORTING_IN_RANGE(bo, bo->dev->bo_size);
 245                 VALGRIND_MALLOCLIKE_BLOCK(bo->map, bo->size, 0, 1);
 246         }
 247 }
 248 #else
 249 static inline void VG_BO_ALLOC(struct fd_bo *bo)   {}
 250 static inline void VG_BO_FREE(struct fd_bo *bo)    {}
 251 static inline void VG_BO_RELEASE(struct fd_bo *bo) {}
 252 static inline void VG_BO_OBTAIN(struct fd_bo *bo)  {}
 253 #endif
 254
 255
 256 #endif /* FREEDRENO_PRIV_H_ */