src/gallium/drivers/vc4/vc4_simulator_validate.h

   1 /*
   2  * Copyright © 2014 Broadcom
   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 VC4_SIMULATOR_VALIDATE_H
  25 #define VC4_SIMULATOR_VALIDATE_H
  26
  27 #include <stdbool.h>
  28 #include <string.h>
  29 #include <stdlib.h>
  30 #include <stdint.h>
  31 #include <stdio.h>
  32 #include <errno.h>
  33
  34 #include "vc4_context.h"
  35 #include "vc4_qpu_defines.h"
  36
  37 #define DRM_INFO(...) fprintf(stderr, __VA_ARGS__)
  38 #define DRM_ERROR(...) fprintf(stderr, __VA_ARGS__)
  39 #define kmalloc(size, arg) malloc(size)
  40 #define kcalloc(size, count, arg) calloc(size, count)
  41 #define kfree(ptr) free(ptr)
  42 #define krealloc(ptr, size, args) realloc(ptr, size)
  43 #define roundup(x, y) align(x, y)
  44 #define BUG_ON(condition) assert(!(condition))
  45
  46 static inline int
  47 copy_from_user(void *dst, void *src, size_t size)
  48 {
  49         memcpy(dst, src, size);
  50         return 0;
  51 }
  52
  53 typedef uint8_t u8;
  54 typedef uint16_t u16;
  55 typedef uint32_t u32;
  56
  57 struct drm_device {
  58         struct vc4_context *vc4;
  59         uint32_t simulator_mem_next;
  60 };
  61
  62 struct drm_gem_cma_object {
  63         struct vc4_bo *bo;
  64
  65         struct {
  66                 uint32_t size;
  67         } base;
  68         uint32_t paddr;
  69         void *vaddr;
  70 };
  71
  72 enum vc4_bo_mode {
  73         VC4_MODE_UNDECIDED,
  74         VC4_MODE_TILE_ALLOC,
  75         VC4_MODE_TSDA,
  76         VC4_MODE_RENDER,
  77         VC4_MODE_SHADER,
  78 };
  79
  80 struct vc4_bo_exec_state {
  81         struct drm_gem_cma_object *bo;
  82         enum vc4_bo_mode mode;
  83 };
  84
  85 struct exec_info {
  86         /* Kernel-space copy of the ioctl arguments */
  87         struct drm_vc4_submit_cl *args;
  88
  89         /* This is the array of BOs that were looked up at the start of exec.
  90          * Command validation will use indices into this array.
  91          */
  92         struct vc4_bo_exec_state *bo;
  93         uint32_t bo_count;
  94
  95         /* Current unvalidated indices into @bo loaded by the non-hardware
  96          * VC4_PACKET_GEM_HANDLES.
  97          */
  98         uint32_t bo_index[2];
  99         uint32_t max_width, max_height;
 100
 101         /* This is the BO where we store the validated command lists, shader
 102          * records, and uniforms.
 103          */
 104         struct drm_gem_cma_object *exec_bo;
 105
 106         /**
 107          * This tracks the per-shader-record state (packet 64) that
 108          * determines the length of the shader record and the offset
 109          * it's expected to be found at.  It gets read in from the
 110          * command lists.
 111          */
 112         struct vc4_shader_state {
 113                 uint8_t packet;
 114                 uint32_t addr;
 115         } *shader_state;
 116
 117         /** How many shader states the user declared they were using. */
 118         uint32_t shader_state_size;
 119         /** How many shader state records the validator has seen. */
 120         uint32_t shader_state_count;
 121
 122         /**
 123          * Computed addresses pointing into exec_bo where we start the
 124          * bin thread (ct0) and render thread (ct1).
 125          */
 126         uint32_t ct0ca, ct0ea;
 127         uint32_t ct1ca, ct1ea;
 128
 129         /* Pointers to the shader recs.  These paddr gets incremented as CL
 130          * packets are relocated in validate_gl_shader_state, and the vaddrs
 131          * (u and v) get incremented and size decremented as the shader recs
 132          * themselves are validated.
 133          */
 134         void *shader_rec_u;
 135         void *shader_rec_v;
 136         uint32_t shader_rec_p;
 137         uint32_t shader_rec_size;
 138
 139         /* Pointers to the uniform data.  These pointers are incremented, and
 140          * size decremented, as each batch of uniforms is uploaded.
 141          */
 142         void *uniforms_u;
 143         void *uniforms_v;
 144         uint32_t uniforms_p;
 145         uint32_t uniforms_size;
 146 };
 147
 148 /**
 149  * struct vc4_texture_sample_info - saves the offsets into the UBO for texture
 150  * setup parameters.
 151  *
 152  * This will be used at draw time to relocate the reference to the texture
 153  * contents in p0, and validate that the offset combined with
 154  * width/height/stride/etc. from p1 and p2/p3 doesn't sample outside the BO.
 155  * Note that the hardware treats unprovided config parameters as 0, so not all
 156  * of them need to be set up for every texure sample, and we'll store ~0 as
 157  * the offset to mark the unused ones.
 158  *
 159  * See the VC4 3D architecture guide page 41 ("Texture and Memory Lookup Unit
 160  * Setup") for definitions of the texture parameters.
 161  */
 162 struct vc4_texture_sample_info {
 163         uint32_t p_offset[4];
 164 };
 165
 166 /**
 167  * struct vc4_validated_shader_info - information about validated shaders that
 168  * needs to be used from command list validation.
 169  *
 170  * For a given shader, each time a shader state record references it, we need
 171  * to verify that the shader doesn't read more uniforms than the shader state
 172  * record's uniform BO pointer can provide, and we need to apply relocations
 173  * and validate the shader state record's uniforms that define the texture
 174  * samples.
 175  */
 176 struct vc4_validated_shader_info
 177 {
 178         uint32_t uniforms_size;
 179         uint32_t uniforms_src_size;
 180         uint32_t num_texture_samples;
 181         struct vc4_texture_sample_info *texture_samples;
 182 };
 183
 184 int vc4_validate_cl(struct drm_device *dev,
 185                     void *validated,
 186                     void *unvalidated,
 187                     uint32_t len,
 188                     bool is_bin,
 189                     struct exec_info *exec);
 190
 191 int vc4_validate_shader_recs(struct drm_device *dev, struct exec_info *exec);
 192
 193 struct vc4_validated_shader_info *
 194 vc4_validate_shader(struct drm_gem_cma_object *shader_obj,
 195                     uint32_t start_offset);
 196
 197 #endif /* VC4_SIMULATOR_VALIDATE_H */