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 drm_clip_rect;
  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          * Deprecated field containing (possibly the low 32-bits of) the last
  69          * seen virtual card address.  Use offset64 instead.
  70          */
  71         unsigned long offset;
  72
  73         /**
  74          * Virtual address for accessing the buffer data.  Only valid while
  75          * mapped.
  76          */
  77 #ifdef __cplusplus
  78         void *virt;
  79 #else
  80         void *virtual;
  81 #endif
  82
  83         /** Buffer manager context associated with this buffer object */
  84         drm_bacon_bufmgr *bufmgr;
  85
  86         /**
  87          * MM-specific handle for accessing object
  88          */
  89         int handle;
  90
  91         /**
  92          * Last seen card virtual address (offset from the beginning of the
  93          * aperture) for the object.  This should be used to fill relocation
  94          * entries when calling drm_bacon_bo_emit_reloc()
  95          */
  96         uint64_t offset64;
  97 };
  98
  99 #define BO_ALLOC_FOR_RENDER (1<<0)
 100
 101 /**
 102  * Allocate a buffer object.
 103  *
 104  * Buffer objects are not necessarily initially mapped into CPU virtual
 105  * address space or graphics device aperture.  They must be mapped
 106  * using bo_map() or drm_bacon_gem_bo_map_gtt() to be used by the CPU.
 107  */
 108 drm_bacon_bo *drm_bacon_bo_alloc(drm_bacon_bufmgr *bufmgr, const char *name,
 109                                  unsigned long size, unsigned int alignment);
 110 /**
 111  * Allocate a buffer object, hinting that it will be used as a
 112  * render target.
 113  *
 114  * This is otherwise the same as bo_alloc.
 115  */
 116 drm_bacon_bo *drm_bacon_bo_alloc_for_render(drm_bacon_bufmgr *bufmgr,
 117                                             const char *name,
 118                                             unsigned long size,
 119                                             unsigned int alignment);
 120
 121 bool drm_bacon_has_userptr(drm_bacon_bufmgr *bufmgr);
 122
 123 /**
 124  * Allocate a buffer object from an existing user accessible
 125  * address malloc'd with the provided size.
 126  * Alignment is used when mapping to the gtt.
 127  * Flags may be I915_VMAP_READ_ONLY or I915_USERPTR_UNSYNCHRONIZED
 128  */
 129 drm_bacon_bo *drm_bacon_bo_alloc_userptr(drm_bacon_bufmgr *bufmgr,
 130                                         const char *name,
 131                                         void *addr, uint32_t tiling_mode,
 132                                         uint32_t stride, unsigned long size,
 133                                         unsigned long flags);
 134 /**
 135  * Allocate a tiled buffer object.
 136  *
 137  * Alignment for tiled objects is set automatically; the 'flags'
 138  * argument provides a hint about how the object will be used initially.
 139  *
 140  * Valid tiling formats are:
 141  *  I915_TILING_NONE
 142  *  I915_TILING_X
 143  *  I915_TILING_Y
 144  *
 145  * Note the tiling format may be rejected; callers should check the
 146  * 'tiling_mode' field on return, as well as the pitch value, which
 147  * may have been rounded up to accommodate for tiling restrictions.
 148  */
 149 drm_bacon_bo *drm_bacon_bo_alloc_tiled(drm_bacon_bufmgr *bufmgr,
 150                                        const char *name,
 151                                        int x, int y, int cpp,
 152                                        uint32_t *tiling_mode,
 153                                        unsigned long *pitch,
 154                                        unsigned long flags);
 155
 156 /** Takes a reference on a buffer object */
 157 void drm_bacon_bo_reference(drm_bacon_bo *bo);
 158
 159 /**
 160  * Releases a reference on a buffer object, freeing the data if
 161  * no references remain.
 162  */
 163 void drm_bacon_bo_unreference(drm_bacon_bo *bo);
 164
 165 /**
 166  * Maps the buffer into userspace.
 167  *
 168  * This function will block waiting for any existing execution on the
 169  * buffer to complete, first.  The resulting mapping is available at
 170  * buf->virtual.
 171  */
 172 int drm_bacon_bo_map(drm_bacon_bo *bo, int write_enable);
 173
 174 /**
 175  * Reduces the refcount on the userspace mapping of the buffer
 176  * object.
 177  */
 178 int drm_bacon_bo_unmap(drm_bacon_bo *bo);
 179
 180 /** Write data into an object. */
 181 int drm_bacon_bo_subdata(drm_bacon_bo *bo, unsigned long offset,
 182                          unsigned long size, const void *data);
 183 /** Read data from an object. */
 184 int drm_bacon_bo_get_subdata(drm_bacon_bo *bo, unsigned long offset,
 185                              unsigned long size, void *data);
 186 /**
 187  * Waits for rendering to an object by the GPU to have completed.
 188  *
 189  * This is not required for any access to the BO by bo_map,
 190  * bo_subdata, etc.  It is merely a way for the driver to implement
 191  * glFinish.
 192  */
 193 void drm_bacon_bo_wait_rendering(drm_bacon_bo *bo);
 194
 195 /**
 196  * Tears down the buffer manager instance.
 197  */
 198 void drm_bacon_bufmgr_destroy(drm_bacon_bufmgr *bufmgr);
 199
 200 /** Executes the command buffer pointed to by bo. */
 201 int drm_bacon_bo_exec(drm_bacon_bo *bo, int used,
 202                       struct drm_clip_rect *cliprects, int num_cliprects, int DR4);
 203
 204 /** Executes the command buffer pointed to by bo on the selected ring buffer */
 205 int drm_bacon_bo_mrb_exec(drm_bacon_bo *bo, int used,
 206                         struct drm_clip_rect *cliprects, int num_cliprects, int DR4,
 207                         unsigned int flags);
 208 int drm_bacon_bufmgr_check_aperture_space(drm_bacon_bo ** bo_array, int count);
 209
 210 /**
 211  * Add relocation entry in reloc_buf, which will be updated with the
 212  * target buffer's real offset on on command submission.
 213  *
 214  * Relocations remain in place for the lifetime of the buffer object.
 215  *
 216  * \param bo Buffer to write the relocation into.
 217  * \param offset Byte offset within reloc_bo of the pointer to
 218  *                      target_bo.
 219  * \param target_bo Buffer whose offset should be written into the
 220  *                  relocation entry.
 221  * \param target_offset Constant value to be added to target_bo's
 222  *                      offset in relocation entry.
 223  * \param read_domains GEM read domains which the buffer will be
 224  *                      read into by the command that this relocation
 225  *                      is part of.
 226  * \param write_domains GEM read domains which the buffer will be
 227  *                      dirtied in by the command that this
 228  *                      relocation is part of.
 229  */
 230 int drm_bacon_bo_emit_reloc(drm_bacon_bo *bo, uint32_t offset,
 231                             drm_bacon_bo *target_bo, uint32_t target_offset,
 232                             uint32_t read_domains, uint32_t write_domain);
 233
 234 /**
 235  * Ask that the buffer be placed in tiling mode
 236  *
 237  * \param buf Buffer to set tiling mode for
 238  * \param tiling_mode desired, and returned tiling mode
 239  */
 240 int drm_bacon_bo_set_tiling(drm_bacon_bo *bo, uint32_t * tiling_mode,
 241                             uint32_t stride);
 242 /**
 243  * Get the current tiling (and resulting swizzling) mode for the bo.
 244  *
 245  * \param buf Buffer to get tiling mode for
 246  * \param tiling_mode returned tiling mode
 247  * \param swizzle_mode returned swizzling mode
 248  */
 249 int drm_bacon_bo_get_tiling(drm_bacon_bo *bo, uint32_t * tiling_mode,
 250                             uint32_t * swizzle_mode);
 251
 252 /**
 253  * Create a visible name for a buffer which can be used by other apps
 254  *
 255  * \param buf Buffer to create a name for
 256  * \param name Returned name
 257  */
 258 int drm_bacon_bo_flink(drm_bacon_bo *bo, uint32_t * name);
 259
 260 /**
 261  * Returns 1 if mapping the buffer for write could cause the process
 262  * to block, due to the object being active in the GPU.
 263  */
 264 int drm_bacon_bo_busy(drm_bacon_bo *bo);
 265
 266 /**
 267  * Specify the volatility of the buffer.
 268  * \param bo Buffer to create a name for
 269  * \param madv The purgeable status
 270  *
 271  * Use I915_MADV_DONTNEED to mark the buffer as purgeable, and it will be
 272  * reclaimed under memory pressure. If you subsequently require the buffer,
 273  * then you must pass I915_MADV_WILLNEED to mark the buffer as required.
 274  *
 275  * Returns 1 if the buffer was retained, or 0 if it was discarded whilst
 276  * marked as I915_MADV_DONTNEED.
 277  */
 278 int drm_bacon_bo_madvise(drm_bacon_bo *bo, int madv);
 279
 280 /**
 281  * Set the offset at which this buffer will be softpinned
 282  * \param bo Buffer to set the softpin offset for
 283  * \param offset Softpin offset
 284  */
 285 int drm_bacon_bo_set_softpin_offset(drm_bacon_bo *bo, uint64_t offset);
 286
 287 /**
 288  * Disable buffer reuse for buffers which will be shared in some way,
 289  * as with scanout buffers. When the buffer reference count goes to
 290  * zero, it will be freed and not placed in the reuse list.
 291  *
 292  * \param bo Buffer to disable reuse for
 293  */
 294 int drm_bacon_bo_disable_reuse(drm_bacon_bo *bo);
 295
 296 /**
 297  * Query whether a buffer is reusable.
 298  *
 299  * \param bo Buffer to query
 300  */
 301 int drm_bacon_bo_is_reusable(drm_bacon_bo *bo);
 302
 303 /** Returns true if target_bo is in the relocation tree rooted at bo. */
 304 int drm_bacon_bo_references(drm_bacon_bo *bo, drm_bacon_bo *target_bo);
 305
 306 /* drm_bacon_bufmgr_gem.c */
 307 drm_bacon_bufmgr *drm_bacon_bufmgr_gem_init(int fd, int batch_size);
 308 drm_bacon_bo *drm_bacon_bo_gem_create_from_name(drm_bacon_bufmgr *bufmgr,
 309                                                 const char *name,
 310                                                 unsigned int handle);
 311 void drm_bacon_bufmgr_gem_enable_reuse(drm_bacon_bufmgr *bufmgr);
 312 void drm_bacon_bufmgr_gem_set_vma_cache_size(drm_bacon_bufmgr *bufmgr,
 313                                              int limit);
 314 int drm_bacon_gem_bo_map_unsynchronized(drm_bacon_bo *bo);
 315 int drm_bacon_gem_bo_map_gtt(drm_bacon_bo *bo);
 316
 317 #define HAVE_DRM_INTEL_GEM_BO_DISABLE_IMPLICIT_SYNC 1
 318 int drm_bacon_bufmgr_gem_can_disable_implicit_sync(drm_bacon_bufmgr *bufmgr);
 319 void drm_bacon_gem_bo_disable_implicit_sync(drm_bacon_bo *bo);
 320 void drm_bacon_gem_bo_enable_implicit_sync(drm_bacon_bo *bo);
 321
 322 void *drm_bacon_gem_bo_map__cpu(drm_bacon_bo *bo);
 323 void *drm_bacon_gem_bo_map__gtt(drm_bacon_bo *bo);
 324 void *drm_bacon_gem_bo_map__wc(drm_bacon_bo *bo);
 325
 326 int drm_bacon_gem_bo_get_reloc_count(drm_bacon_bo *bo);
 327 void drm_bacon_gem_bo_clear_relocs(drm_bacon_bo *bo, int start);
 328 void drm_bacon_gem_bo_start_gtt_access(drm_bacon_bo *bo, int write_enable);
 329
 330 int drm_bacon_bufmgr_gem_get_devid(drm_bacon_bufmgr *bufmgr);
 331 int drm_bacon_gem_bo_wait(drm_bacon_bo *bo, int64_t timeout_ns);
 332
 333 drm_bacon_context *drm_bacon_gem_context_create(drm_bacon_bufmgr *bufmgr);
 334 int drm_bacon_gem_context_get_id(drm_bacon_context *ctx,
 335                                  uint32_t *ctx_id);
 336 void drm_bacon_gem_context_destroy(drm_bacon_context *ctx);
 337 int drm_bacon_gem_bo_context_exec(drm_bacon_bo *bo, drm_bacon_context *ctx,
 338                                   int used, unsigned int flags);
 339 int drm_bacon_gem_bo_fence_exec(drm_bacon_bo *bo,
 340                                 drm_bacon_context *ctx,
 341                                 int used,
 342                                 int in_fence,
 343                                 int *out_fence,
 344                                 unsigned int flags);
 345
 346 int drm_bacon_bo_gem_export_to_prime(drm_bacon_bo *bo, int *prime_fd);
 347 drm_bacon_bo *drm_bacon_bo_gem_create_from_prime(drm_bacon_bufmgr *bufmgr,
 348                                                 int prime_fd, int size);
 349
 350 int drm_bacon_reg_read(drm_bacon_bufmgr *bufmgr,
 351                        uint32_t offset,
 352                        uint64_t *result);
 353
 354 int drm_bacon_get_reset_stats(drm_bacon_context *ctx,
 355                               uint32_t *reset_count,
 356                               uint32_t *active,
 357                               uint32_t *pending);
 358
 359 /** @{ */
 360
 361 #if defined(__cplusplus)
 362 }
 363 #endif
 364
 365 #endif /* INTEL_BUFMGR_H */