src/gallium/drivers/iris/iris_batch.h

   1 /*
   2  * Copyright © 2017 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
  24 #ifndef IRIS_BATCH_DOT_H
  25 #define IRIS_BATCH_DOT_H
  26
  27 #include <stdint.h>
  28 #include <stdbool.h>
  29 #include <string.h>
  30
  31 #include "util/u_dynarray.h"
  32
  33 #include "i915_drm.h"
  34 #include "common/gen_decoder.h"
  35
  36 /* The kernel assumes batchbuffers are smaller than 256kB. */
  37 #define MAX_BATCH_SIZE (256 * 1024)
  38
  39 /* Our target batch size - flush approximately at this point. */
  40 #define BATCH_SZ (20 * 1024)
  41
  42 #define IRIS_BATCH_COUNT 2
  43
  44 struct iris_address {
  45    struct iris_bo *bo;
  46    uint64_t offset;
  47    bool write;
  48 };
  49
  50 struct iris_batch {
  51    struct iris_screen *screen;
  52    struct iris_vtable *vtbl;
  53    struct pipe_debug_callback *dbg;
  54
  55    /** The name of this batch for debug info (e.g. "render") */
  56    const char *name;
  57
  58    /** Current batchbuffer being queued up. */
  59    struct iris_bo *bo;
  60    void *map;
  61    void *map_next;
  62    /** Size of the primary batch if we've moved on to a secondary. */
  63    unsigned primary_batch_size;
  64
  65    /** Last BO submitted to the hardware.  Used for glFinish(). */
  66    struct iris_bo *last_bo;
  67
  68    /** Last Surface State Base Address set in this hardware context. */
  69    uint64_t last_surface_base_address;
  70
  71    uint32_t hw_ctx_id;
  72
  73    /** Which engine this batch targets - a I915_EXEC_RING_MASK value */
  74    uint8_t engine;
  75
  76    /** The validation list */
  77    struct drm_i915_gem_exec_object2 *validation_list;
  78    struct iris_bo **exec_bos;
  79    int exec_count;
  80    int exec_array_size;
  81
  82    /** A list of drm_i915_exec_fences to have execbuf signal or wait on */
  83    struct util_dynarray exec_fences;
  84
  85    /** The amount of aperture space (in bytes) used by all exec_bos */
  86    int aperture_space;
  87
  88    /** List of other batches which we might need to flush to use a BO */
  89    struct iris_batch *other_batches[IRIS_BATCH_COUNT - 1];
  90
  91    struct {
  92       /**
  93        * Set of struct brw_bo * that have been rendered to within this
  94        * batchbuffer and would need flushing before being used from another
  95        * cache domain that isn't coherent with it (i.e. the sampler).
  96        */
  97       struct hash_table *render;
  98
  99       /**
 100        * Set of struct brw_bo * that have been used as a depth buffer within
 101        * this batchbuffer and would need flushing before being used from
 102        * another cache domain that isn't coherent with it (i.e. the sampler).
 103        */
 104       struct set *depth;
 105    } cache;
 106
 107    /** Map from batch offset to iris_alloc_state data (with DEBUG_BATCH) */
 108    // XXX: unused
 109    struct hash_table *state_sizes;
 110    struct gen_batch_decode_ctx decoder;
 111
 112    /** Have we emitted any draw calls to this batch? */
 113    bool contains_draw;
 114 };
 115
 116 void iris_init_batch(struct iris_batch *batch,
 117                      struct iris_screen *screen,
 118                      struct iris_vtable *vtbl,
 119                      struct pipe_debug_callback *dbg,
 120                      struct iris_batch **other_batches,
 121                      const char *name,
 122                      uint8_t ring);
 123 void iris_chain_to_new_batch(struct iris_batch *batch);
 124 void iris_batch_free(struct iris_batch *batch);
 125 void iris_batch_maybe_flush(struct iris_batch *batch, unsigned estimate);
 126
 127 void _iris_batch_flush(struct iris_batch *batch, const char *file, int line);
 128 #define iris_batch_flush(batch) _iris_batch_flush((batch), __FILE__, __LINE__)
 129
 130 bool iris_batch_references(struct iris_batch *batch, struct iris_bo *bo);
 131
 132 #define RELOC_WRITE EXEC_OBJECT_WRITE
 133
 134 void iris_use_pinned_bo(struct iris_batch *batch, struct iris_bo *bo,
 135                         bool writable);
 136
 137 static inline unsigned
 138 iris_batch_bytes_used(struct iris_batch *batch)
 139 {
 140    return batch->map_next - batch->map;
 141 }
 142
 143 /**
 144  * Ensure the current command buffer has \param size bytes of space
 145  * remaining.  If not, this creates a secondary batch buffer and emits
 146  * a jump from the primary batch to the start of the secondary.
 147  *
 148  * Most callers want iris_get_command_space() instead.
 149  */
 150 static inline void
 151 iris_require_command_space(struct iris_batch *batch, unsigned size)
 152 {
 153    const unsigned required_bytes = iris_batch_bytes_used(batch) + size;
 154
 155    if (required_bytes >= BATCH_SZ) {
 156       iris_chain_to_new_batch(batch);
 157    }
 158 }
 159
 160 /**
 161  * Allocate space in the current command buffer, and return a pointer
 162  * to the mapped area so the caller can write commands there.
 163  *
 164  * This should be called whenever emitting commands.
 165  */
 166 static inline void *
 167 iris_get_command_space(struct iris_batch *batch, unsigned bytes)
 168 {
 169    iris_require_command_space(batch, bytes);
 170    void *map = batch->map_next;
 171    batch->map_next += bytes;
 172    return map;
 173 }
 174
 175 /**
 176  * Helper to emit GPU commands - allocates space, copies them there.
 177  */
 178 static inline void
 179 iris_batch_emit(struct iris_batch *batch, const void *data, unsigned size)
 180 {
 181    void *map = iris_get_command_space(batch, size);
 182    memcpy(map, data, size);
 183 }
 184
 185 #endif