src/gallium/auxiliary/driver_ddebug/dd_pipe.h

   1 /**************************************************************************
   2  *
   3  * Copyright 2015 Advanced Micro Devices, Inc.
   4  * Copyright 2008 VMware, Inc.
   5  * All Rights Reserved.
   6  *
   7  * Permission is hereby granted, free of charge, to any person obtaining a
   8  * copy of this software and associated documentation files (the "Software"),
   9  * to deal in the Software without restriction, including without limitation
  10  * on the rights to use, copy, modify, merge, publish, distribute, sub
  11  * license, and/or sell copies of the Software, and to permit persons to whom
  12  * the Software is furnished to do so, subject to the following conditions:
  13  *
  14  * The above copyright notice and this permission notice (including the next
  15  * paragraph) shall be included in all copies or substantial portions of the
  16  * Software.
  17  *
  18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  19  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20  * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
  21  * THE AUTHOR(S) AND/OR THEIR SUPPLIERS BE LIABLE FOR ANY CLAIM,
  22  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
  23  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
  24  * USE OR OTHER DEALINGS IN THE SOFTWARE.
  25  *
  26  **************************************************************************/
  27
  28 #ifndef DD_H_
  29 #define DD_H_
  30
  31 #include "pipe/p_context.h"
  32 #include "pipe/p_state.h"
  33 #include "pipe/p_screen.h"
  34 #include "dd_util.h"
  35 #include "os/os_thread.h"
  36 #include "util/list.h"
  37 #include "util/u_log.h"
  38 #include "util/u_queue.h"
  39
  40 struct dd_context;
  41
  42 enum dd_dump_mode {
  43    DD_DUMP_ONLY_HANGS,
  44    DD_DUMP_ALL_CALLS,
  45    DD_DUMP_APITRACE_CALL,
  46 };
  47
  48 struct dd_screen
  49 {
  50    struct pipe_screen base;
  51    struct pipe_screen *screen;
  52    unsigned timeout_ms;
  53    enum dd_dump_mode dump_mode;
  54    bool flush_always;
  55    bool transfers;
  56    bool verbose;
  57    unsigned skip_count;
  58    unsigned apitrace_dump_call;
  59 };
  60
  61 enum call_type
  62 {
  63    CALL_FLUSH,
  64    CALL_DRAW_VBO,
  65    CALL_LAUNCH_GRID,
  66    CALL_RESOURCE_COPY_REGION,
  67    CALL_BLIT,
  68    CALL_FLUSH_RESOURCE,
  69    CALL_CLEAR,
  70    CALL_CLEAR_BUFFER,
  71    CALL_CLEAR_TEXTURE,
  72    CALL_CLEAR_RENDER_TARGET,
  73    CALL_CLEAR_DEPTH_STENCIL,
  74    CALL_GENERATE_MIPMAP,
  75    CALL_GET_QUERY_RESULT_RESOURCE,
  76    CALL_TRANSFER_MAP,
  77    CALL_TRANSFER_FLUSH_REGION,
  78    CALL_TRANSFER_UNMAP,
  79    CALL_BUFFER_SUBDATA,
  80    CALL_TEXTURE_SUBDATA,
  81 };
  82
  83 struct call_resource_copy_region
  84 {
  85    struct pipe_resource *dst;
  86    unsigned dst_level;
  87    unsigned dstx, dsty, dstz;
  88    struct pipe_resource *src;
  89    unsigned src_level;
  90    struct pipe_box src_box;
  91 };
  92
  93 struct call_clear
  94 {
  95    unsigned buffers;
  96    union pipe_color_union color;
  97    double depth;
  98    unsigned stencil;
  99 };
 100
 101 struct call_clear_buffer
 102 {
 103    struct pipe_resource *res;
 104    unsigned offset;
 105    unsigned size;
 106    const void *clear_value;
 107    int clear_value_size;
 108 };
 109
 110 struct call_generate_mipmap {
 111    struct pipe_resource *res;
 112    enum pipe_format format;
 113    unsigned base_level;
 114    unsigned last_level;
 115    unsigned first_layer;
 116    unsigned last_layer;
 117 };
 118
 119 struct call_flush {
 120    unsigned flags;
 121 };
 122
 123 struct call_draw_info {
 124    struct pipe_draw_info draw;
 125    struct pipe_draw_indirect_info indirect;
 126 };
 127
 128 struct call_get_query_result_resource {
 129    struct pipe_query *query;
 130    enum pipe_query_type query_type;
 131    bool wait;
 132    enum pipe_query_value_type result_type;
 133    int index;
 134    struct pipe_resource *resource;
 135    unsigned offset;
 136 };
 137
 138 struct call_transfer_map {
 139    struct pipe_transfer *transfer_ptr;
 140    struct pipe_transfer transfer;
 141    void *ptr;
 142 };
 143
 144 struct call_transfer_flush_region {
 145    struct pipe_transfer *transfer_ptr;
 146    struct pipe_transfer transfer;
 147    struct pipe_box box;
 148 };
 149
 150 struct call_transfer_unmap {
 151    struct pipe_transfer *transfer_ptr;
 152    struct pipe_transfer transfer;
 153 };
 154
 155 struct call_buffer_subdata {
 156    struct pipe_resource *resource;
 157    unsigned usage;
 158    unsigned offset;
 159    unsigned size;
 160    const void *data;
 161 };
 162
 163 struct call_texture_subdata {
 164    struct pipe_resource *resource;
 165    unsigned level;
 166    unsigned usage;
 167    struct pipe_box box;
 168    const void *data;
 169    unsigned stride;
 170    unsigned layer_stride;
 171 };
 172
 173 struct dd_call
 174 {
 175    enum call_type type;
 176
 177    union {
 178       struct call_flush flush;
 179       struct call_draw_info draw_vbo;
 180       struct pipe_grid_info launch_grid;
 181       struct call_resource_copy_region resource_copy_region;
 182       struct pipe_blit_info blit;
 183       struct pipe_resource *flush_resource;
 184       struct call_clear clear;
 185       struct call_clear_buffer clear_buffer;
 186       struct call_generate_mipmap generate_mipmap;
 187       struct call_get_query_result_resource get_query_result_resource;
 188       struct call_transfer_map transfer_map;
 189       struct call_transfer_flush_region transfer_flush_region;
 190       struct call_transfer_unmap transfer_unmap;
 191       struct call_buffer_subdata buffer_subdata;
 192       struct call_texture_subdata texture_subdata;
 193    } info;
 194 };
 195
 196 struct dd_query
 197 {
 198    unsigned type;
 199    struct pipe_query *query;
 200 };
 201
 202 struct dd_state
 203 {
 204    void *cso;
 205
 206    union {
 207       struct pipe_blend_state blend;
 208       struct pipe_depth_stencil_alpha_state dsa;
 209       struct pipe_rasterizer_state rs;
 210       struct pipe_sampler_state sampler;
 211       struct {
 212          struct pipe_vertex_element velems[PIPE_MAX_ATTRIBS];
 213          unsigned count;
 214       } velems;
 215       struct pipe_shader_state shader;
 216    } state;
 217 };
 218
 219 struct dd_draw_state
 220 {
 221    struct {
 222       struct dd_query *query;
 223       bool condition;
 224       unsigned mode;
 225    } render_cond;
 226
 227    struct pipe_vertex_buffer vertex_buffers[PIPE_MAX_ATTRIBS];
 228
 229    unsigned num_so_targets;
 230    struct pipe_stream_output_target *so_targets[PIPE_MAX_SO_BUFFERS];
 231    unsigned so_offsets[PIPE_MAX_SO_BUFFERS];
 232
 233    struct dd_state *shaders[PIPE_SHADER_TYPES];
 234    struct pipe_constant_buffer constant_buffers[PIPE_SHADER_TYPES][PIPE_MAX_CONSTANT_BUFFERS];
 235    struct pipe_sampler_view *sampler_views[PIPE_SHADER_TYPES][PIPE_MAX_SAMPLERS];
 236    struct dd_state *sampler_states[PIPE_SHADER_TYPES][PIPE_MAX_SAMPLERS];
 237    struct pipe_image_view shader_images[PIPE_SHADER_TYPES][PIPE_MAX_SHADER_IMAGES];
 238    struct pipe_shader_buffer shader_buffers[PIPE_SHADER_TYPES][PIPE_MAX_SHADER_BUFFERS];
 239
 240    struct dd_state *velems;
 241    struct dd_state *rs;
 242    struct dd_state *dsa;
 243    struct dd_state *blend;
 244
 245    struct pipe_blend_color blend_color;
 246    struct pipe_stencil_ref stencil_ref;
 247    unsigned sample_mask;
 248    unsigned min_samples;
 249    struct pipe_clip_state clip_state;
 250    struct pipe_framebuffer_state framebuffer_state;
 251    struct pipe_poly_stipple polygon_stipple;
 252    struct pipe_scissor_state scissors[PIPE_MAX_VIEWPORTS];
 253    struct pipe_viewport_state viewports[PIPE_MAX_VIEWPORTS];
 254    float tess_default_levels[6];
 255
 256    unsigned apitrace_call_number;
 257 };
 258
 259 struct dd_draw_state_copy
 260 {
 261    struct dd_draw_state base;
 262
 263    /* dd_draw_state_copy does not reference real CSOs. Instead, it points to
 264     * these variables, which serve as storage.
 265     */
 266    struct dd_query render_cond;
 267    struct dd_state shaders[PIPE_SHADER_TYPES];
 268    struct dd_state sampler_states[PIPE_SHADER_TYPES][PIPE_MAX_SAMPLERS];
 269    struct dd_state velems;
 270    struct dd_state rs;
 271    struct dd_state dsa;
 272    struct dd_state blend;
 273 };
 274
 275 struct dd_draw_record {
 276    struct list_head list;
 277    struct dd_context *dctx;
 278
 279    int64_t time_before;
 280    int64_t time_after;
 281    unsigned draw_call;
 282
 283    /* The fence pointers are guaranteed to be valid once driver_finished is signalled */
 284    struct pipe_fence_handle *prev_bottom_of_pipe;
 285    struct pipe_fence_handle *top_of_pipe;
 286    struct pipe_fence_handle *bottom_of_pipe;
 287
 288    struct dd_call call;
 289    struct dd_draw_state_copy draw_state;
 290
 291    struct util_queue_fence driver_finished;
 292    struct u_log_page *log_page;
 293 };
 294
 295 struct dd_context
 296 {
 297    struct pipe_context base;
 298    struct pipe_context *pipe;
 299
 300    struct dd_draw_state draw_state;
 301    unsigned num_draw_calls;
 302
 303    struct u_log_context log;
 304
 305    /* Pipelined hang detection.
 306     *
 307     * Before each draw call, a new dd_draw_record is created that contains
 308     * a copy of all states. After each draw call, the driver's log is added
 309     * to this record. Additionally, deferred fences are associated to each
 310     * record both before and after the draw.
 311     *
 312     * The records are handed off to a separate thread which waits on the
 313     * records' fences. Records with signalled fences are freed. When a timeout
 314     * is detected, the thread dumps the records of in-flight draws.
 315     */
 316    thrd_t thread;
 317    mtx_t mutex;
 318    cnd_t cond;
 319    struct list_head records; /* oldest record first */
 320    unsigned num_records;
 321    bool kill_thread;
 322    bool api_stalled;
 323 };
 324
 325
 326 struct pipe_context *
 327 dd_context_create(struct dd_screen *dscreen, struct pipe_context *pipe);
 328
 329 void
 330 dd_init_draw_functions(struct dd_context *dctx);
 331
 332 void
 333 dd_thread_join(struct dd_context *dctx);
 334 int
 335 dd_thread_main(void *input);
 336
 337 FILE *
 338 dd_get_file_stream(struct dd_screen *dscreen, unsigned apitrace_call_number);
 339
 340 static inline struct dd_context *
 341 dd_context(struct pipe_context *pipe)
 342 {
 343    return (struct dd_context *)pipe;
 344 }
 345
 346 static inline struct dd_screen *
 347 dd_screen(struct pipe_screen *screen)
 348 {
 349    return (struct dd_screen*)screen;
 350 }
 351
 352 static inline struct dd_query *
 353 dd_query(struct pipe_query *query)
 354 {
 355    return (struct dd_query *)query;
 356 }
 357
 358 static inline struct pipe_query *
 359 dd_query_unwrap(struct pipe_query *query)
 360 {
 361    if (query) {
 362       return dd_query(query)->query;
 363    } else {
 364       return NULL;
 365    }
 366 }
 367
 368
 369 #define CTX_INIT(_member) \
 370    dctx->base._member = dctx->pipe->_member ? dd_context_##_member : NULL
 371
 372 #endif /* DD_H_ */