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         /**
  81          * MM-specific handle for accessing object
  82          */
  83         int handle;
  84
  85         /**
  86          * Last seen card virtual address (offset from the beginning of the
  87          * aperture) for the object.  This should be used to fill relocation
  88          * entries when calling drm_bacon_bo_emit_reloc()
  89          */
  90         uint64_t offset64;
  91
  92         /**
  93          * Boolean of whether the GPU is definitely not accessing the buffer.
  94          *
  95          * This is only valid when reusable, since non-reusable
  96          * buffers are those that have been shared with other
  97          * processes, so we don't know their state.
  98          */
  99         bool idle;
 100 };
 101
 102 #define BO_ALLOC_FOR_RENDER (1<<0)
 103
 104 /**
 105  * Allocate a buffer object.
 106  *
 107  * Buffer objects are not necessarily initially mapped into CPU virtual
 108  * address space or graphics device aperture.  They must be mapped
 109  * using bo_map() or drm_bacon_gem_bo_map_gtt() to be used by the CPU.
 110  */
 111 drm_bacon_bo *drm_bacon_bo_alloc(drm_bacon_bufmgr *bufmgr, const char *name,
 112                                  unsigned long size, unsigned int alignment);
 113 /**
 114  * Allocate a buffer object, hinting that it will be used as a
 115  * render target.
 116  *
 117  * This is otherwise the same as bo_alloc.
 118  */
 119 drm_bacon_bo *drm_bacon_bo_alloc_for_render(drm_bacon_bufmgr *bufmgr,
 120                                             const char *name,
 121                                             unsigned long size,
 122                                             unsigned int alignment);
 123
 124 /**
 125  * Allocate a tiled buffer object.
 126  *
 127  * Alignment for tiled objects is set automatically; the 'flags'
 128  * argument provides a hint about how the object will be used initially.
 129  *
 130  * Valid tiling formats are:
 131  *  I915_TILING_NONE
 132  *  I915_TILING_X
 133  *  I915_TILING_Y
 134  *
 135  * Note the tiling format may be rejected; callers should check the
 136  * 'tiling_mode' field on return, as well as the pitch value, which
 137  * may have been rounded up to accommodate for tiling restrictions.
 138  */
 139 drm_bacon_bo *drm_bacon_bo_alloc_tiled(drm_bacon_bufmgr *bufmgr,
 140                                        const char *name,
 141                                        int x, int y, int cpp,
 142                                        uint32_t *tiling_mode,
 143                                        unsigned long *pitch,
 144                                        unsigned long flags);
 145
 146 /** Takes a reference on a buffer object */
 147 void drm_bacon_bo_reference(drm_bacon_bo *bo);
 148
 149 /**
 150  * Releases a reference on a buffer object, freeing the data if
 151  * no references remain.
 152  */
 153 void drm_bacon_bo_unreference(drm_bacon_bo *bo);
 154
 155 /**
 156  * Maps the buffer into userspace.
 157  *
 158  * This function will block waiting for any existing execution on the
 159  * buffer to complete, first.  The resulting mapping is available at
 160  * buf->virtual.
 161  */
 162 int drm_bacon_bo_map(drm_bacon_bo *bo, int write_enable);
 163
 164 /**
 165  * Reduces the refcount on the userspace mapping of the buffer
 166  * object.
 167  */
 168 int drm_bacon_bo_unmap(drm_bacon_bo *bo);
 169
 170 /** Write data into an object. */
 171 int drm_bacon_bo_subdata(drm_bacon_bo *bo, unsigned long offset,
 172                          unsigned long size, const void *data);
 173 /** Read data from an object. */
 174 int drm_bacon_bo_get_subdata(drm_bacon_bo *bo, unsigned long offset,
 175                              unsigned long size, void *data);
 176 /**
 177  * Waits for rendering to an object by the GPU to have completed.
 178  *
 179  * This is not required for any access to the BO by bo_map,
 180  * bo_subdata, etc.  It is merely a way for the driver to implement
 181  * glFinish.
 182  */
 183 void drm_bacon_bo_wait_rendering(drm_bacon_bo *bo);
 184
 185 /**
 186  * Tears down the buffer manager instance.
 187  */
 188 void drm_bacon_bufmgr_destroy(drm_bacon_bufmgr *bufmgr);
 189
 190 /**
 191  * Ask that the buffer be placed in tiling mode
 192  *
 193  * \param buf Buffer to set tiling mode for
 194  * \param tiling_mode desired, and returned tiling mode
 195  */
 196 int drm_bacon_bo_set_tiling(drm_bacon_bo *bo, uint32_t * tiling_mode,
 197                             uint32_t stride);
 198 /**
 199  * Get the current tiling (and resulting swizzling) mode for the bo.
 200  *
 201  * \param buf Buffer to get tiling mode for
 202  * \param tiling_mode returned tiling mode
 203  * \param swizzle_mode returned swizzling mode
 204  */
 205 int drm_bacon_bo_get_tiling(drm_bacon_bo *bo, uint32_t * tiling_mode,
 206                             uint32_t * swizzle_mode);
 207
 208 /**
 209  * Create a visible name for a buffer which can be used by other apps
 210  *
 211  * \param buf Buffer to create a name for
 212  * \param name Returned name
 213  */
 214 int drm_bacon_bo_flink(drm_bacon_bo *bo, uint32_t * name);
 215
 216 /**
 217  * Returns 1 if mapping the buffer for write could cause the process
 218  * to block, due to the object being active in the GPU.
 219  */
 220 int drm_bacon_bo_busy(drm_bacon_bo *bo);
 221
 222 /**
 223  * Specify the volatility of the buffer.
 224  * \param bo Buffer to create a name for
 225  * \param madv The purgeable status
 226  *
 227  * Use I915_MADV_DONTNEED to mark the buffer as purgeable, and it will be
 228  * reclaimed under memory pressure. If you subsequently require the buffer,
 229  * then you must pass I915_MADV_WILLNEED to mark the buffer as required.
 230  *
 231  * Returns 1 if the buffer was retained, or 0 if it was discarded whilst
 232  * marked as I915_MADV_DONTNEED.
 233  */
 234 int drm_bacon_bo_madvise(drm_bacon_bo *bo, int madv);
 235
 236 /**
 237  * Disable buffer reuse for buffers which will be shared in some way,
 238  * as with scanout buffers. When the buffer reference count goes to
 239  * zero, it will be freed and not placed in the reuse list.
 240  *
 241  * \param bo Buffer to disable reuse for
 242  */
 243 int drm_bacon_bo_disable_reuse(drm_bacon_bo *bo);
 244
 245 /**
 246  * Query whether a buffer is reusable.
 247  *
 248  * \param bo Buffer to query
 249  */
 250 int drm_bacon_bo_is_reusable(drm_bacon_bo *bo);
 251
 252 /* drm_bacon_bufmgr_gem.c */
 253 drm_bacon_bufmgr *drm_bacon_bufmgr_gem_init(struct gen_device_info *devinfo,
 254                                             int fd, int batch_size);
 255 drm_bacon_bo *drm_bacon_bo_gem_create_from_name(drm_bacon_bufmgr *bufmgr,
 256                                                 const char *name,
 257                                                 unsigned int handle);
 258 void drm_bacon_bufmgr_gem_enable_reuse(drm_bacon_bufmgr *bufmgr);
 259 void drm_bacon_bufmgr_gem_set_vma_cache_size(drm_bacon_bufmgr *bufmgr,
 260                                              int limit);
 261 int drm_bacon_gem_bo_map_unsynchronized(drm_bacon_bo *bo);
 262 int drm_bacon_gem_bo_map_gtt(drm_bacon_bo *bo);
 263
 264 void *drm_bacon_gem_bo_map__cpu(drm_bacon_bo *bo);
 265 void *drm_bacon_gem_bo_map__gtt(drm_bacon_bo *bo);
 266 void *drm_bacon_gem_bo_map__wc(drm_bacon_bo *bo);
 267
 268 void drm_bacon_gem_bo_start_gtt_access(drm_bacon_bo *bo, int write_enable);
 269
 270 int drm_bacon_gem_bo_wait(drm_bacon_bo *bo, int64_t timeout_ns);
 271
 272 drm_bacon_context *drm_bacon_gem_context_create(drm_bacon_bufmgr *bufmgr);
 273 int drm_bacon_gem_context_get_id(drm_bacon_context *ctx,
 274                                  uint32_t *ctx_id);
 275 void drm_bacon_gem_context_destroy(drm_bacon_context *ctx);
 276
 277 int drm_bacon_bo_gem_export_to_prime(drm_bacon_bo *bo, int *prime_fd);
 278 drm_bacon_bo *drm_bacon_bo_gem_create_from_prime(drm_bacon_bufmgr *bufmgr,
 279                                                 int prime_fd, int size);
 280
 281 int drm_bacon_reg_read(drm_bacon_bufmgr *bufmgr,
 282                        uint32_t offset,
 283                        uint64_t *result);
 284
 285 int drm_bacon_get_reset_stats(drm_bacon_context *ctx,
 286                               uint32_t *reset_count,
 287                               uint32_t *active,
 288                               uint32_t *pending);
 289
 290 /** @{ */
 291
 292 #if defined(__cplusplus)
 293 }
 294 #endif
 295
 296 #endif /* INTEL_BUFMGR_H */