1 /* -*- mode: C; c-file-style: "k&r"; tab-width 4; indent-tabs-mode: t; -*- */ 2 3 /* 4 * Copyright (C) 2012 Rob Clark <robclark (at) 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 (at) freedesktop.org> 27 */ 28 29 #ifndef FREEDRENO_PRIV_H_ 30 #define FREEDRENO_PRIV_H_ 31 32 #include <stdlib.h> 33 #include <errno.h> 34 #include <string.h> 35 #include <unistd.h> 36 #include <errno.h> 37 #include <fcntl.h> 38 #include <sys/ioctl.h> 39 #include <pthread.h> 40 #include <stdio.h> 41 #include <assert.h> 42 43 #include "libdrm_macros.h" 44 #include "xf86drm.h" 45 #include "xf86atomic.h" 46 47 #include "util_double_list.h" 48 #include "util_math.h" 49 50 #include "freedreno_drmif.h" 51 #include "freedreno_ringbuffer.h" 52 #include "drm.h" 53 54 #ifndef TRUE 55 # define TRUE 1 56 #endif 57 #ifndef FALSE 58 # define FALSE 0 59 #endif 60 61 struct fd_device_funcs { 62 int (*bo_new_handle)(struct fd_device *dev, uint32_t size, 63 uint32_t flags, uint32_t *handle); 64 struct fd_bo * (*bo_from_handle)(struct fd_device *dev, 65 uint32_t size, uint32_t handle); 66 struct fd_pipe * (*pipe_new)(struct fd_device *dev, enum fd_pipe_id id, 67 unsigned prio); 68 void (*destroy)(struct fd_device *dev); 69 }; 70 71 struct fd_bo_bucket { 72 uint32_t size; 73 struct list_head list; 74 }; 75 76 struct fd_bo_cache { 77 struct fd_bo_bucket cache_bucket[14 * 4]; 78 int num_buckets; 79 time_t time; 80 }; 81 82 struct fd_device { 83 int fd; 84 enum fd_version version; 85 atomic_t refcnt; 86 87 /* tables to keep track of bo's, to avoid "evil-twin" fd_bo objects: 88 * 89 * handle_table: maps handle to fd_bo 90 * name_table: maps flink name to fd_bo 91 * 92 * We end up needing two tables, because DRM_IOCTL_GEM_OPEN always 93 * returns a new handle. So we need to figure out if the bo is already 94 * open in the process first, before calling gem-open. 95 */ 96 void *handle_table, *name_table; 97 98 const struct fd_device_funcs *funcs; 99 100 struct fd_bo_cache bo_cache; 101 102 int closefd; /* call close(fd) upon destruction */ 103 104 /* just for valgrind: */ 105 int bo_size; 106 }; 107 108 drm_private void fd_bo_cache_init(struct fd_bo_cache *cache, int coarse); 109 drm_private void fd_bo_cache_cleanup(struct fd_bo_cache *cache, time_t time); 110 drm_private struct fd_bo * fd_bo_cache_alloc(struct fd_bo_cache *cache, 111 uint32_t *size, uint32_t flags); 112 drm_private int fd_bo_cache_free(struct fd_bo_cache *cache, struct fd_bo *bo); 113 114 /* for where @table_lock is already held: */ 115 drm_private void fd_device_del_locked(struct fd_device *dev); 116 117 struct fd_pipe_funcs { 118 struct fd_ringbuffer * (*ringbuffer_new)(struct fd_pipe *pipe, uint32_t size); 119 int (*get_param)(struct fd_pipe *pipe, enum fd_param_id param, uint64_t *value); 120 int (*wait)(struct fd_pipe *pipe, uint32_t timestamp, uint64_t timeout); 121 void (*destroy)(struct fd_pipe *pipe); 122 }; 123 124 struct fd_pipe { 125 struct fd_device *dev; 126 enum fd_pipe_id id; 127 uint32_t gpu_id; 128 const struct fd_pipe_funcs *funcs; 129 }; 130 131 struct fd_ringmarker { 132 struct fd_ringbuffer *ring; 133 uint32_t *cur; 134 }; 135 136 struct fd_ringbuffer_funcs { 137 void * (*hostptr)(struct fd_ringbuffer *ring); 138 int (*flush)(struct fd_ringbuffer *ring, uint32_t *last_start, 139 int in_fence_fd, int *out_fence_fd); 140 void (*grow)(struct fd_ringbuffer *ring, uint32_t size); 141 void (*reset)(struct fd_ringbuffer *ring); 142 void (*emit_reloc)(struct fd_ringbuffer *ring, 143 const struct fd_reloc *reloc); 144 uint32_t (*emit_reloc_ring)(struct fd_ringbuffer *ring, 145 struct fd_ringbuffer *target, uint32_t cmd_idx, 146 uint32_t submit_offset, uint32_t size); 147 uint32_t (*cmd_count)(struct fd_ringbuffer *ring); 148 void (*destroy)(struct fd_ringbuffer *ring); 149 }; 150 151 struct fd_bo_funcs { 152 int (*offset)(struct fd_bo *bo, uint64_t *offset); 153 int (*cpu_prep)(struct fd_bo *bo, struct fd_pipe *pipe, uint32_t op); 154 void (*cpu_fini)(struct fd_bo *bo); 155 int (*madvise)(struct fd_bo *bo, int willneed); 156 uint64_t (*iova)(struct fd_bo *bo); 157 void (*destroy)(struct fd_bo *bo); 158 }; 159 160 struct fd_bo { 161 struct fd_device *dev; 162 uint32_t size; 163 uint32_t handle; 164 uint32_t name; 165 void *map; 166 atomic_t refcnt; 167 const struct fd_bo_funcs *funcs; 168 169 int bo_reuse; 170 struct list_head list; /* bucket-list entry */ 171 time_t free_time; /* time when added to bucket-list */ 172 }; 173 174 #define ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0])) 175 176 #define enable_debug 0 /* TODO make dynamic */ 177 178 #define INFO_MSG(fmt, ...) \ 179 do { drmMsg("[I] "fmt " (%s:%d)\n", \ 180 ##__VA_ARGS__, __FUNCTION__, __LINE__); } while (0) 181 #define DEBUG_MSG(fmt, ...) \ 182 do if (enable_debug) { drmMsg("[D] "fmt " (%s:%d)\n", \ 183 ##__VA_ARGS__, __FUNCTION__, __LINE__); } while (0) 184 #define WARN_MSG(fmt, ...) \ 185 do { drmMsg("[W] "fmt " (%s:%d)\n", \ 186 ##__VA_ARGS__, __FUNCTION__, __LINE__); } while (0) 187 #define ERROR_MSG(fmt, ...) \ 188 do { drmMsg("[E] " fmt " (%s:%d)\n", \ 189 ##__VA_ARGS__, __FUNCTION__, __LINE__); } while (0) 190 191 #define U642VOID(x) ((void *)(unsigned long)(x)) 192 #define VOID2U64(x) ((uint64_t)(unsigned long)(x)) 193 194 static inline uint32_t 195 offset_bytes(void *end, void *start) 196 { 197 return ((char *)end) - ((char *)start); 198 } 199 200 #if HAVE_VALGRIND 201 # include <memcheck.h> 202 203 /* 204 * For tracking the backing memory (if valgrind enabled, we force a mmap 205 * for the purposes of tracking) 206 */ 207 static inline void VG_BO_ALLOC(struct fd_bo *bo) 208 { 209 if (bo && RUNNING_ON_VALGRIND) { 210 VALGRIND_MALLOCLIKE_BLOCK(fd_bo_map(bo), bo->size, 0, 1); 211 } 212 } 213 214 static inline void VG_BO_FREE(struct fd_bo *bo) 215 { 216 VALGRIND_FREELIKE_BLOCK(bo->map, 0); 217 } 218 219 /* 220 * For tracking bo structs that are in the buffer-cache, so that valgrind 221 * doesn't attribute ownership to the first one to allocate the recycled 222 * bo. 223 * 224 * Note that the list_head in fd_bo is used to track the buffers in cache 225 * so disable error reporting on the range while they are in cache so 226 * valgrind doesn't squawk about list traversal. 227 * 228 */ 229 static inline void VG_BO_RELEASE(struct fd_bo *bo) 230 { 231 if (RUNNING_ON_VALGRIND) { 232 VALGRIND_DISABLE_ADDR_ERROR_REPORTING_IN_RANGE(bo, bo->dev->bo_size); 233 VALGRIND_MAKE_MEM_NOACCESS(bo, bo->dev->bo_size); 234 VALGRIND_FREELIKE_BLOCK(bo->map, 0); 235 } 236 } 237 static inline void VG_BO_OBTAIN(struct fd_bo *bo) 238 { 239 if (RUNNING_ON_VALGRIND) { 240 VALGRIND_MAKE_MEM_DEFINED(bo, bo->dev->bo_size); 241 VALGRIND_ENABLE_ADDR_ERROR_REPORTING_IN_RANGE(bo, bo->dev->bo_size); 242 VALGRIND_MALLOCLIKE_BLOCK(bo->map, bo->size, 0, 1); 243 } 244 } 245 #else 246 static inline void VG_BO_ALLOC(struct fd_bo *bo) {} 247 static inline void VG_BO_FREE(struct fd_bo *bo) {} 248 static inline void VG_BO_RELEASE(struct fd_bo *bo) {} 249 static inline void VG_BO_OBTAIN(struct fd_bo *bo) {} 250 #endif 251 252 253 #endif /* FREEDRENO_PRIV_H_ */ 254