src/mesa/drivers/dri/i965/brw_bufmgr.h

   1 /*
   2  * Copyright © 2008-2012 Intel Corporation
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a
   5  * copy of this software and associated documentation files (the "Software"),
   6  * to deal in the Software without restriction, including without limitation
   7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   8  * and/or sell copies of the Software, and to permit persons to whom the
   9  * Software is furnished to do so, subject to the following conditions:
  10  *
  11  * The above copyright notice and this permission notice (including the next
  12  * paragraph) shall be included in all copies or substantial portions of the
  13  * Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  18  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  21  * IN THE SOFTWARE.
  22  *
  23  * Authors:
  24  *    Eric Anholt <eric@anholt.net>
  25  *
  26  */
  27
  28 /**
  29  * @file brw_bufmgr.h
  30  *
  31  * Public definitions of Intel-specific bufmgr functions.
  32  */
  33
  34 #ifndef INTEL_BUFMGR_H
  35 #define INTEL_BUFMGR_H
  36
  37 #include <stdbool.h>
  38 #include <stdint.h>
  39 #include <stdio.h>
  40
  41 #if defined(__cplusplus)
  42 extern "C" {
  43 #endif
  44
  45 struct gen_device_info;
  46
  47 typedef struct _drm_bacon_bufmgr drm_bacon_bufmgr;
  48 typedef struct _drm_bacon_context drm_bacon_context;
  49 typedef struct _drm_bacon_bo drm_bacon_bo;
  50
  51 struct _drm_bacon_bo {
  52         /**
  53          * Size in bytes of the buffer object.
  54          *
  55          * The size may be larger than the size originally requested for the
  56          * allocation, such as being aligned to page size.
  57          */
  58         unsigned long size;
  59
  60         /**
  61          * Alignment requirement for object
  62          *
  63          * Used for GTT mapping & pinning the object.
  64          */
  65         unsigned long align;
  66
  67         /**
  68          * Virtual address for accessing the buffer data.  Only valid while
  69          * mapped.
  70          */
  71 #ifdef __cplusplus
  72         void *virt;
  73 #else
  74         void *virtual;
  75 #endif
  76
  77         /** Buffer manager context associated with this buffer object */
  78         drm_bacon_bufmgr *bufmgr;
  79
  80         /** The GEM handle for this buffer object. */
  81         uint32_t gem_handle;
  82
  83         /**
  84          * Last seen card virtual address (offset from the beginning of the
  85          * aperture) for the object.  This should be used to fill relocation
  86          * entries when calling drm_bacon_bo_emit_reloc()
  87          */
  88         uint64_t offset64;
  89
  90         /**
  91          * Boolean of whether the GPU is definitely not accessing the buffer.
  92          *
  93          * This is only valid when reusable, since non-reusable
  94          * buffers are those that have been shared with other
  95          * processes, so we don't know their state.
  96          */
  97         bool idle;
  98 };
  99
 100 #define BO_ALLOC_FOR_RENDER (1<<0)
 101
 102 /**
 103  * Allocate a buffer object.
 104  *
 105  * Buffer objects are not necessarily initially mapped into CPU virtual
 106  * address space or graphics device aperture.  They must be mapped
 107  * using bo_map() or drm_bacon_gem_bo_map_gtt() to be used by the CPU.
 108  */
 109 drm_bacon_bo *drm_bacon_bo_alloc(drm_bacon_bufmgr *bufmgr, const char *name,
 110                                  unsigned long size, unsigned int alignment);
 111 /**
 112  * Allocate a buffer object, hinting that it will be used as a
 113  * render target.
 114  *
 115  * This is otherwise the same as bo_alloc.
 116  */
 117 drm_bacon_bo *drm_bacon_bo_alloc_for_render(drm_bacon_bufmgr *bufmgr,
 118                                             const char *name,
 119                                             unsigned long size,
 120                                             unsigned int alignment);
 121
 122 /**
 123  * Allocate a tiled buffer object.
 124  *
 125  * Alignment for tiled objects is set automatically; the 'flags'
 126  * argument provides a hint about how the object will be used initially.
 127  *
 128  * Valid tiling formats are:
 129  *  I915_TILING_NONE
 130  *  I915_TILING_X
 131  *  I915_TILING_Y
 132  *
 133  * Note the tiling format may be rejected; callers should check the
 134  * 'tiling_mode' field on return, as well as the pitch value, which
 135  * may have been rounded up to accommodate for tiling restrictions.
 136  */
 137 drm_bacon_bo *drm_bacon_bo_alloc_tiled(drm_bacon_bufmgr *bufmgr,
 138                                        const char *name,
 139                                        int x, int y, int cpp,
 140                                        uint32_t *tiling_mode,
 141                                        unsigned long *pitch,
 142                                        unsigned long flags);
 143
 144 /** Takes a reference on a buffer object */
 145 void drm_bacon_bo_reference(drm_bacon_bo *bo);
 146
 147 /**
 148  * Releases a reference on a buffer object, freeing the data if
 149  * no references remain.
 150  */
 151 void drm_bacon_bo_unreference(drm_bacon_bo *bo);
 152
 153 /**
 154  * Maps the buffer into userspace.
 155  *
 156  * This function will block waiting for any existing execution on the
 157  * buffer to complete, first.  The resulting mapping is available at
 158  * buf->virtual.
 159  */
 160 int drm_bacon_bo_map(drm_bacon_bo *bo, int write_enable);
 161
 162 /**
 163  * Reduces the refcount on the userspace mapping of the buffer
 164  * object.
 165  */
 166 int drm_bacon_bo_unmap(drm_bacon_bo *bo);
 167
 168 /** Write data into an object. */
 169 int drm_bacon_bo_subdata(drm_bacon_bo *bo, unsigned long offset,
 170                          unsigned long size, const void *data);
 171 /** Read data from an object. */
 172 int drm_bacon_bo_get_subdata(drm_bacon_bo *bo, unsigned long offset,
 173                              unsigned long size, void *data);
 174 /**
 175  * Waits for rendering to an object by the GPU to have completed.
 176  *
 177  * This is not required for any access to the BO by bo_map,
 178  * bo_subdata, etc.  It is merely a way for the driver to implement
 179  * glFinish.
 180  */
 181 void drm_bacon_bo_wait_rendering(drm_bacon_bo *bo);
 182
 183 /**
 184  * Tears down the buffer manager instance.
 185  */
 186 void drm_bacon_bufmgr_destroy(drm_bacon_bufmgr *bufmgr);
 187
 188 /**
 189  * Ask that the buffer be placed in tiling mode
 190  *
 191  * \param buf Buffer to set tiling mode for
 192  * \param tiling_mode desired, and returned tiling mode
 193  */
 194 int drm_bacon_bo_set_tiling(drm_bacon_bo *bo, uint32_t * tiling_mode,
 195                             uint32_t stride);
 196 /**
 197  * Get the current tiling (and resulting swizzling) mode for the bo.
 198  *
 199  * \param buf Buffer to get tiling mode for
 200  * \param tiling_mode returned tiling mode
 201  * \param swizzle_mode returned swizzling mode
 202  */
 203 int drm_bacon_bo_get_tiling(drm_bacon_bo *bo, uint32_t * tiling_mode,
 204                             uint32_t * swizzle_mode);
 205
 206 /**
 207  * Create a visible name for a buffer which can be used by other apps
 208  *
 209  * \param buf Buffer to create a name for
 210  * \param name Returned name
 211  */
 212 int drm_bacon_bo_flink(drm_bacon_bo *bo, uint32_t * name);
 213
 214 /**
 215  * Returns 1 if mapping the buffer for write could cause the process
 216  * to block, due to the object being active in the GPU.
 217  */
 218 int drm_bacon_bo_busy(drm_bacon_bo *bo);
 219
 220 /**
 221  * Specify the volatility of the buffer.
 222  * \param bo Buffer to create a name for
 223  * \param madv The purgeable status
 224  *
 225  * Use I915_MADV_DONTNEED to mark the buffer as purgeable, and it will be
 226  * reclaimed under memory pressure. If you subsequently require the buffer,
 227  * then you must pass I915_MADV_WILLNEED to mark the buffer as required.
 228  *
 229  * Returns 1 if the buffer was retained, or 0 if it was discarded whilst
 230  * marked as I915_MADV_DONTNEED.
 231  */
 232 int drm_bacon_bo_madvise(drm_bacon_bo *bo, int madv);
 233
 234 /**
 235  * Disable buffer reuse for buffers which will be shared in some way,
 236  * as with scanout buffers. When the buffer reference count goes to
 237  * zero, it will be freed and not placed in the reuse list.
 238  *
 239  * \param bo Buffer to disable reuse for
 240  */
 241 int drm_bacon_bo_disable_reuse(drm_bacon_bo *bo);
 242
 243 /**
 244  * Query whether a buffer is reusable.
 245  *
 246  * \param bo Buffer to query
 247  */
 248 int drm_bacon_bo_is_reusable(drm_bacon_bo *bo);
 249
 250 /* drm_bacon_bufmgr_gem.c */
 251 drm_bacon_bufmgr *drm_bacon_bufmgr_gem_init(struct gen_device_info *devinfo,
 252                                             int fd, int batch_size);
 253 drm_bacon_bo *drm_bacon_bo_gem_create_from_name(drm_bacon_bufmgr *bufmgr,
 254                                                 const char *name,
 255                                                 unsigned int handle);
 256 void drm_bacon_bufmgr_gem_enable_reuse(drm_bacon_bufmgr *bufmgr);
 257 void drm_bacon_bufmgr_gem_set_vma_cache_size(drm_bacon_bufmgr *bufmgr,
 258                                              int limit);
 259 int drm_bacon_gem_bo_map_unsynchronized(drm_bacon_bo *bo);
 260 int drm_bacon_gem_bo_map_gtt(drm_bacon_bo *bo);
 261
 262 void *drm_bacon_gem_bo_map__cpu(drm_bacon_bo *bo);
 263 void *drm_bacon_gem_bo_map__gtt(drm_bacon_bo *bo);
 264 void *drm_bacon_gem_bo_map__wc(drm_bacon_bo *bo);
 265
 266 void drm_bacon_gem_bo_start_gtt_access(drm_bacon_bo *bo, int write_enable);
 267
 268 int drm_bacon_gem_bo_wait(drm_bacon_bo *bo, int64_t timeout_ns);
 269
 270 drm_bacon_context *drm_bacon_gem_context_create(drm_bacon_bufmgr *bufmgr);
 271 int drm_bacon_gem_context_get_id(drm_bacon_context *ctx,
 272                                  uint32_t *ctx_id);
 273 void drm_bacon_gem_context_destroy(drm_bacon_context *ctx);
 274
 275 int drm_bacon_bo_gem_export_to_prime(drm_bacon_bo *bo, int *prime_fd);
 276 drm_bacon_bo *drm_bacon_bo_gem_create_from_prime(drm_bacon_bufmgr *bufmgr,
 277                                                 int prime_fd, int size);
 278
 279 int drm_bacon_reg_read(drm_bacon_bufmgr *bufmgr,
 280                        uint32_t offset,
 281                        uint64_t *result);
 282
 283 int drm_bacon_get_reset_stats(drm_bacon_context *ctx,
 284                               uint32_t *reset_count,
 285                               uint32_t *active,
 286                               uint32_t *pending);
 287
 288 /** @{ */
 289
 290 #if defined(__cplusplus)
 291 }
 292 #endif
 293
 294 #endif /* INTEL_BUFMGR_H */