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