src/gallium/auxiliary/draw/draw_llvm.h

   1 /**************************************************************************
   2  *
   3  * Copyright 2010 VMware, Inc.
   4  * All Rights Reserved.
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a
   7  * copy of this software and associated documentation files (the
   8  * "Software"), to deal in the Software without restriction, including
   9  * without limitation the rights to use, copy, modify, merge, publish,
  10  * distribute, sub license, and/or sell copies of the Software, and to
  11  * permit persons to whom the Software is furnished to do so, subject to
  12  * the following conditions:
  13  *
  14  * The above copyright notice and this permission notice (including the
  15  * next paragraph) shall be included in all copies or substantial portions
  16  * of the Software.
  17  *
  18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  19  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  20  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
  21  * IN NO EVENT SHALL VMWARE AND/OR ITS SUPPLIERS BE LIABLE FOR
  22  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  23  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  24  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  25  *
  26  **************************************************************************/
  27
  28 #ifndef DRAW_LLVM_H
  29 #define DRAW_LLVM_H
  30
  31 #include "draw/draw_private.h"
  32
  33 #include "draw/draw_vs.h"
  34 #include "draw/draw_gs.h"
  35
  36 #include "gallivm/lp_bld_sample.h"
  37 #include "gallivm/lp_bld_limits.h"
  38
  39 #include "pipe/p_context.h"
  40 #include "util/simple_list.h"
  41
  42
  43 struct draw_llvm;
  44 struct llvm_vertex_shader;
  45 struct llvm_geometry_shader;
  46
  47 struct draw_jit_texture
  48 {
  49    uint32_t width;
  50    uint32_t height;
  51    uint32_t depth;
  52    uint32_t first_level;
  53    uint32_t last_level;
  54    const void *base;
  55    uint32_t row_stride[PIPE_MAX_TEXTURE_LEVELS];
  56    uint32_t img_stride[PIPE_MAX_TEXTURE_LEVELS];
  57    uint32_t mip_offsets[PIPE_MAX_TEXTURE_LEVELS];
  58 };
  59
  60
  61 struct draw_sampler_static_state
  62 {
  63    /*
  64     * These attributes are effectively interleaved for more sane key handling.
  65     * However, there might be lots of null space if the amount of samplers and
  66     * textures isn't the same.
  67     */
  68    struct lp_static_sampler_state sampler_state;
  69    struct lp_static_texture_state texture_state;
  70 };
  71
  72
  73 struct draw_jit_sampler
  74 {
  75    float min_lod;
  76    float max_lod;
  77    float lod_bias;
  78    float border_color[4];
  79 };
  80
  81
  82 enum {
  83    DRAW_JIT_TEXTURE_WIDTH = 0,
  84    DRAW_JIT_TEXTURE_HEIGHT,
  85    DRAW_JIT_TEXTURE_DEPTH,
  86    DRAW_JIT_TEXTURE_FIRST_LEVEL,
  87    DRAW_JIT_TEXTURE_LAST_LEVEL,
  88    DRAW_JIT_TEXTURE_BASE,
  89    DRAW_JIT_TEXTURE_ROW_STRIDE,
  90    DRAW_JIT_TEXTURE_IMG_STRIDE,
  91    DRAW_JIT_TEXTURE_MIP_OFFSETS,
  92    DRAW_JIT_TEXTURE_NUM_FIELDS  /* number of fields above */
  93 };
  94
  95
  96 enum {
  97    DRAW_JIT_SAMPLER_MIN_LOD,
  98    DRAW_JIT_SAMPLER_MAX_LOD,
  99    DRAW_JIT_SAMPLER_LOD_BIAS,
 100    DRAW_JIT_SAMPLER_BORDER_COLOR,
 101    DRAW_JIT_SAMPLER_NUM_FIELDS  /* number of fields above */
 102 };
 103
 104
 105 enum {
 106    DRAW_JIT_VERTEX_VERTEX_ID = 0,
 107    DRAW_JIT_VERTEX_CLIP_POS,
 108    DRAW_JIT_VERTEX_DATA
 109 };
 110
 111 /**
 112  * This structure is passed directly to the generated vertex shader.
 113  *
 114  * It contains the derived state.
 115  *
 116  * Changes here must be reflected in the draw_jit_context_* macros.
 117  * Changes to the ordering should be avoided.
 118  *
 119  * Only use types with a clear size and padding here, in particular prefer the
 120  * stdint.h types to the basic integer types.
 121  */
 122 struct draw_jit_context
 123 {
 124    const float *vs_constants[LP_MAX_TGSI_CONST_BUFFERS];
 125    int num_vs_constants[LP_MAX_TGSI_CONST_BUFFERS];
 126    float (*planes) [DRAW_TOTAL_CLIP_PLANES][4];
 127    struct pipe_viewport_state *viewports;
 128
 129    struct draw_jit_texture textures[PIPE_MAX_SHADER_SAMPLER_VIEWS];
 130    struct draw_jit_sampler samplers[PIPE_MAX_SAMPLERS];
 131 };
 132
 133 enum {
 134    DRAW_JIT_CTX_CONSTANTS            = 0,
 135    DRAW_JIT_CTX_NUM_CONSTANTS        = 1,
 136    DRAW_JIT_CTX_PLANES               = 2,
 137    DRAW_JIT_CTX_VIEWPORT             = 3,
 138    DRAW_JIT_CTX_TEXTURES             = 4,
 139    DRAW_JIT_CTX_SAMPLERS             = 5,
 140    DRAW_JIT_CTX_NUM_FIELDS
 141 };
 142
 143 #define draw_jit_context_vs_constants(_gallivm, _ptr) \
 144    lp_build_struct_get_ptr(_gallivm, _ptr, DRAW_JIT_CTX_CONSTANTS, "vs_constants")
 145
 146 #define draw_jit_context_num_vs_constants(_gallivm, _ptr) \
 147    lp_build_struct_get_ptr(_gallivm, _ptr, DRAW_JIT_CTX_NUM_CONSTANTS, "num_vs_constants")
 148
 149 #define draw_jit_context_planes(_gallivm, _ptr) \
 150    lp_build_struct_get(_gallivm, _ptr, DRAW_JIT_CTX_PLANES, "planes")
 151
 152 #define draw_jit_context_viewports(_gallivm, _ptr) \
 153    lp_build_struct_get(_gallivm, _ptr, DRAW_JIT_CTX_VIEWPORT, "viewports")
 154
 155 #define draw_jit_context_textures(_gallivm, _ptr) \
 156    lp_build_struct_get_ptr(_gallivm, _ptr, DRAW_JIT_CTX_TEXTURES, "textures")
 157
 158 #define draw_jit_context_samplers(_gallivm, _ptr) \
 159    lp_build_struct_get_ptr(_gallivm, _ptr, DRAW_JIT_CTX_SAMPLERS, "samplers")
 160
 161 #define draw_jit_header_id(_gallivm, _ptr)              \
 162    lp_build_struct_get_ptr(_gallivm, _ptr, DRAW_JIT_VERTEX_VERTEX_ID, "id")
 163
 164 #define draw_jit_header_clip_pos(_gallivm, _ptr) \
 165    lp_build_struct_get_ptr(_gallivm, _ptr, DRAW_JIT_VERTEX_CLIP_POS, "clip_pos")
 166
 167 #define draw_jit_header_data(_gallivm, _ptr)            \
 168    lp_build_struct_get_ptr(_gallivm, _ptr, DRAW_JIT_VERTEX_DATA, "data")
 169
 170
 171 #define draw_jit_vbuffer_stride(_gallivm, _ptr)         \
 172    lp_build_struct_get(_gallivm, _ptr, 0, "stride")
 173
 174 #define draw_jit_vbuffer_offset(_gallivm, _ptr)         \
 175    lp_build_struct_get(_gallivm, _ptr, 1, "buffer_offset")
 176
 177 enum {
 178    DRAW_JIT_DVBUFFER_MAP = 0,
 179    DRAW_JIT_DVBUFFER_SIZE,
 180    DRAW_JIT_DVBUFFER_NUM_FIELDS  /* number of fields above */
 181 };
 182
 183 #define draw_jit_dvbuffer_map(_gallivm, _ptr)         \
 184    lp_build_struct_get(_gallivm, _ptr, DRAW_JIT_DVBUFFER_MAP, "map")
 185
 186 #define draw_jit_dvbuffer_size(_gallivm, _ptr)        \
 187    lp_build_struct_get(_gallivm, _ptr, DRAW_JIT_DVBUFFER_SIZE, "size")
 188
 189
 190 /**
 191  * This structure is passed directly to the generated geometry shader.
 192  *
 193  * It contains the derived state.
 194  *
 195  * Changes here must be reflected in the draw_gs_jit_context_* macros.
 196  * Changes to the ordering should be avoided.
 197  *
 198  * Only use types with a clear size and padding here, in particular prefer the
 199  * stdint.h types to the basic integer types.
 200  */
 201 struct draw_gs_jit_context
 202 {
 203    const float *constants[LP_MAX_TGSI_CONST_BUFFERS];
 204    int num_constants[LP_MAX_TGSI_CONST_BUFFERS];
 205    float (*planes) [DRAW_TOTAL_CLIP_PLANES][4];
 206    struct pipe_viewport_state *viewports;
 207
 208    /* There two need to be exactly at DRAW_JIT_CTX_TEXTURES and
 209     * DRAW_JIT_CTX_SAMPLERS positions in the struct */
 210    struct draw_jit_texture textures[PIPE_MAX_SHADER_SAMPLER_VIEWS];
 211    struct draw_jit_sampler samplers[PIPE_MAX_SAMPLERS];
 212
 213    int **prim_lengths;
 214    int *emitted_vertices;
 215    int *emitted_prims;
 216 };
 217
 218 enum {
 219    DRAW_GS_JIT_CTX_CONSTANTS = 0,
 220    DRAW_GS_JIT_CTX_NUM_CONSTANTS = 1,
 221    DRAW_GS_JIT_CTX_PLANES = 2,
 222    DRAW_GS_JIT_CTX_VIEWPORT = 3,
 223    /* Textures and samples are reserved for DRAW_JIT_CTX_TEXTURES
 224     * and DRAW_JIT_CTX_SAMPLERS, because they both need
 225     * to be at exactly the same locations as they are in the
 226     * VS ctx structure for sampling to work. */
 227    DRAW_GS_JIT_CTX_TEXTURES = DRAW_JIT_CTX_TEXTURES,
 228    DRAW_GS_JIT_CTX_SAMPLERS = DRAW_JIT_CTX_SAMPLERS,
 229    DRAW_GS_JIT_CTX_PRIM_LENGTHS = 6,
 230    DRAW_GS_JIT_CTX_EMITTED_VERTICES = 7,
 231    DRAW_GS_JIT_CTX_EMITTED_PRIMS = 8,
 232    DRAW_GS_JIT_CTX_NUM_FIELDS = 9
 233 };
 234
 235 #define draw_gs_jit_context_constants(_gallivm, _ptr) \
 236    lp_build_struct_get_ptr(_gallivm, _ptr, DRAW_GS_JIT_CTX_CONSTANTS, "constants")
 237
 238 #define draw_gs_jit_context_num_constants(_gallivm, _ptr) \
 239    lp_build_struct_get_ptr(_gallivm, _ptr, DRAW_GS_JIT_CTX_NUM_CONSTANTS, "num_constants")
 240
 241 #define draw_gs_jit_context_planes(_gallivm, _ptr) \
 242    lp_build_struct_get(_gallivm, _ptr, DRAW_GS_JIT_CTX_PLANES, "planes")
 243
 244 #define draw_gs_jit_context_viewports(_gallivm, _ptr) \
 245    lp_build_struct_get(_gallivm, _ptr, DRAW_GS_JIT_CTX_VIEWPORT, "viewports")
 246
 247 #define draw_gs_jit_context_textures(_gallivm, _ptr) \
 248    lp_build_struct_get_ptr(_gallivm, _ptr, DRAW_GS_JIT_CTX_TEXTURES, "textures")
 249
 250 #define draw_gs_jit_context_samplers(_gallivm, _ptr) \
 251    lp_build_struct_get_ptr(_gallivm, _ptr, DRAW_GS_JIT_CTX_SAMPLERS, "samplers")
 252
 253 #define draw_gs_jit_prim_lengths(_gallivm, _ptr) \
 254    lp_build_struct_get(_gallivm, _ptr, DRAW_GS_JIT_CTX_PRIM_LENGTHS, "prim_lengths")
 255
 256 #define draw_gs_jit_emitted_vertices(_gallivm, _ptr) \
 257    lp_build_struct_get(_gallivm, _ptr, DRAW_GS_JIT_CTX_EMITTED_VERTICES, "emitted_vertices")
 258
 259 #define draw_gs_jit_emitted_prims(_gallivm, _ptr) \
 260    lp_build_struct_get(_gallivm, _ptr, DRAW_GS_JIT_CTX_EMITTED_PRIMS, "emitted_prims")
 261
 262
 263
 264 typedef int
 265 (*draw_jit_vert_func)(struct draw_jit_context *context,
 266                       struct vertex_header *io,
 267                       const struct draw_vertex_buffer vbuffers[PIPE_MAX_ATTRIBS],
 268                       unsigned start,
 269                       unsigned count,
 270                       unsigned stride,
 271                       struct pipe_vertex_buffer *vertex_buffers,
 272                       unsigned instance_id,
 273                       unsigned vertex_id_offset,
 274                       unsigned start_instance);
 275
 276
 277 typedef int
 278 (*draw_jit_vert_func_elts)(struct draw_jit_context *context,
 279                            struct vertex_header *io,
 280                            const struct draw_vertex_buffer vbuffers[PIPE_MAX_ATTRIBS],
 281                            const unsigned *fetch_elts,
 282                            unsigned fetch_max_elt,
 283                            unsigned fetch_count,
 284                            unsigned stride,
 285                            struct pipe_vertex_buffer *vertex_buffers,
 286                            unsigned instance_id,
 287                            unsigned vertex_id_offset,
 288                            unsigned start_instance);
 289
 290
 291 typedef int
 292 (*draw_gs_jit_func)(struct draw_gs_jit_context *context,
 293                     float inputs[6][PIPE_MAX_SHADER_INPUTS][TGSI_NUM_CHANNELS][TGSI_NUM_CHANNELS],
 294                     struct vertex_header *output,
 295                     unsigned num_prims,
 296                     unsigned instance_id,
 297                     int *prim_ids,
 298                     unsigned invocation_id);
 299
 300 struct draw_llvm_variant_key
 301 {
 302    unsigned nr_vertex_elements:8;
 303    unsigned nr_samplers:8;
 304    unsigned nr_sampler_views:8;
 305    unsigned clamp_vertex_color:1;
 306    unsigned clip_xy:1;
 307    unsigned clip_z:1;
 308    unsigned clip_user:1;
 309    unsigned clip_halfz:1;
 310    unsigned bypass_viewport:1;
 311    unsigned need_edgeflags:1;
 312    unsigned has_gs:1;
 313    unsigned num_outputs:8;
 314    /*
 315     * it is important there are no holes in this struct
 316     * (and all padding gets zeroed).
 317     */
 318    unsigned ucp_enable:PIPE_MAX_CLIP_PLANES;
 319    unsigned pad1:24-PIPE_MAX_CLIP_PLANES;
 320
 321    /* Variable number of vertex elements:
 322     */
 323    struct pipe_vertex_element vertex_element[1];
 324
 325    /* Followed by variable number of samplers:
 326     */
 327 /*   struct draw_sampler_static_state sampler; */
 328 };
 329
 330 struct draw_gs_llvm_variant_key
 331 {
 332    unsigned nr_samplers:8;
 333    unsigned nr_sampler_views:8;
 334    unsigned num_outputs:8;
 335
 336    struct draw_sampler_static_state samplers[1];
 337 };
 338
 339 #define DRAW_LLVM_MAX_VARIANT_KEY_SIZE \
 340    (sizeof(struct draw_llvm_variant_key) +      \
 341     PIPE_MAX_SHADER_SAMPLER_VIEWS * sizeof(struct draw_sampler_static_state) +  \
 342     (PIPE_MAX_ATTRIBS-1) * sizeof(struct pipe_vertex_element))
 343
 344 #define DRAW_GS_LLVM_MAX_VARIANT_KEY_SIZE \
 345    (sizeof(struct draw_gs_llvm_variant_key) +   \
 346     PIPE_MAX_SHADER_SAMPLER_VIEWS * sizeof(struct draw_sampler_static_state))
 347
 348
 349 static inline size_t
 350 draw_llvm_variant_key_size(unsigned nr_vertex_elements,
 351                            unsigned nr_samplers)
 352 {
 353    return (sizeof(struct draw_llvm_variant_key) +
 354            nr_samplers * sizeof(struct draw_sampler_static_state) +
 355            (nr_vertex_elements - 1) * sizeof(struct pipe_vertex_element));
 356 }
 357
 358
 359 static inline size_t
 360 draw_gs_llvm_variant_key_size(unsigned nr_samplers)
 361 {
 362    return (sizeof(struct draw_gs_llvm_variant_key) +
 363            (nr_samplers - 1) * sizeof(struct draw_sampler_static_state));
 364 }
 365
 366
 367 static inline struct draw_sampler_static_state *
 368 draw_llvm_variant_key_samplers(struct draw_llvm_variant_key *key)
 369 {
 370    return (struct draw_sampler_static_state *)
 371       &key->vertex_element[key->nr_vertex_elements];
 372 }
 373
 374
 375 struct draw_llvm_variant_list_item
 376 {
 377    struct draw_llvm_variant *base;
 378    struct draw_llvm_variant_list_item *next, *prev;
 379 };
 380
 381 struct draw_gs_llvm_variant_list_item
 382 {
 383    struct draw_gs_llvm_variant *base;
 384    struct draw_gs_llvm_variant_list_item *next, *prev;
 385 };
 386
 387
 388 struct draw_llvm_variant
 389 {
 390    struct gallivm_state *gallivm;
 391
 392    /* LLVM JIT builder types */
 393    LLVMTypeRef context_ptr_type;
 394    LLVMTypeRef buffer_ptr_type;
 395    LLVMTypeRef vb_ptr_type;
 396    LLVMTypeRef vertex_header_ptr_type;
 397
 398    LLVMValueRef function;
 399    LLVMValueRef function_elts;
 400    draw_jit_vert_func jit_func;
 401    draw_jit_vert_func_elts jit_func_elts;
 402
 403    struct llvm_vertex_shader *shader;
 404
 405    struct draw_llvm *llvm;
 406    struct draw_llvm_variant_list_item list_item_global;
 407    struct draw_llvm_variant_list_item list_item_local;
 408
 409    /* key is variable-sized, must be last */
 410    struct draw_llvm_variant_key key;
 411 };
 412
 413
 414 struct draw_gs_llvm_variant
 415 {
 416    struct gallivm_state *gallivm;
 417
 418    /* LLVM JIT builder types */
 419    LLVMTypeRef context_ptr_type;
 420    LLVMTypeRef vertex_header_ptr_type;
 421    LLVMTypeRef input_array_type;
 422
 423    LLVMValueRef context_ptr;
 424    LLVMValueRef io_ptr;
 425    LLVMValueRef num_prims;
 426    LLVMValueRef function;
 427    draw_gs_jit_func jit_func;
 428
 429    struct llvm_geometry_shader *shader;
 430
 431    struct draw_llvm *llvm;
 432    struct draw_gs_llvm_variant_list_item list_item_global;
 433    struct draw_gs_llvm_variant_list_item list_item_local;
 434
 435    /* key is variable-sized, must be last */
 436    struct draw_gs_llvm_variant_key key;
 437 };
 438
 439 struct llvm_vertex_shader {
 440    struct draw_vertex_shader base;
 441
 442    unsigned variant_key_size;
 443    struct draw_llvm_variant_list_item variants;
 444    unsigned variants_created;
 445    unsigned variants_cached;
 446 };
 447
 448 struct llvm_geometry_shader {
 449    struct draw_geometry_shader base;
 450
 451    unsigned variant_key_size;
 452    struct draw_gs_llvm_variant_list_item variants;
 453    unsigned variants_created;
 454    unsigned variants_cached;
 455 };
 456
 457
 458 struct draw_llvm {
 459    struct draw_context *draw;
 460
 461    LLVMContextRef context;
 462    boolean context_owned;
 463
 464    struct draw_jit_context jit_context;
 465    struct draw_gs_jit_context gs_jit_context;
 466
 467    struct draw_llvm_variant_list_item vs_variants_list;
 468    int nr_variants;
 469
 470    struct draw_gs_llvm_variant_list_item gs_variants_list;
 471    int nr_gs_variants;
 472 };
 473
 474
 475 static inline struct llvm_vertex_shader *
 476 llvm_vertex_shader(struct draw_vertex_shader *vs)
 477 {
 478    return (struct llvm_vertex_shader *)vs;
 479 }
 480
 481 static inline struct llvm_geometry_shader *
 482 llvm_geometry_shader(struct draw_geometry_shader *gs)
 483 {
 484    return (struct llvm_geometry_shader *)gs;
 485 }
 486
 487
 488
 489
 490 struct draw_llvm *
 491 draw_llvm_create(struct draw_context *draw, LLVMContextRef llvm_context);
 492
 493 void
 494 draw_llvm_destroy(struct draw_llvm *llvm);
 495
 496 struct draw_llvm_variant *
 497 draw_llvm_create_variant(struct draw_llvm *llvm,
 498                          unsigned num_vertex_header_attribs,
 499                          const struct draw_llvm_variant_key *key);
 500
 501 void
 502 draw_llvm_destroy_variant(struct draw_llvm_variant *variant);
 503
 504 struct draw_llvm_variant_key *
 505 draw_llvm_make_variant_key(struct draw_llvm *llvm, char *store);
 506
 507 void
 508 draw_llvm_dump_variant_key(struct draw_llvm_variant_key *key);
 509
 510
 511 struct draw_gs_llvm_variant *
 512 draw_gs_llvm_create_variant(struct draw_llvm *llvm,
 513                             unsigned num_vertex_header_attribs,
 514                             const struct draw_gs_llvm_variant_key *key);
 515
 516 void
 517 draw_gs_llvm_destroy_variant(struct draw_gs_llvm_variant *variant);
 518
 519 struct draw_gs_llvm_variant_key *
 520 draw_gs_llvm_make_variant_key(struct draw_llvm *llvm, char *store);
 521
 522 void
 523 draw_gs_llvm_dump_variant_key(struct draw_gs_llvm_variant_key *key);
 524
 525 struct lp_build_sampler_soa *
 526 draw_llvm_sampler_soa_create(const struct draw_sampler_static_state *static_state);
 527
 528 void
 529 draw_llvm_set_sampler_state(struct draw_context *draw, unsigned shader_stage);
 530
 531 void
 532 draw_llvm_set_mapped_texture(struct draw_context *draw,
 533                              unsigned shader_stage,
 534                              unsigned sview_idx,
 535                              uint32_t width, uint32_t height, uint32_t depth,
 536                              uint32_t first_level, uint32_t last_level,
 537                              const void *base_ptr,
 538                              uint32_t row_stride[PIPE_MAX_TEXTURE_LEVELS],
 539                              uint32_t img_stride[PIPE_MAX_TEXTURE_LEVELS],
 540                              uint32_t mip_offsets[PIPE_MAX_TEXTURE_LEVELS]);
 541
 542 #endif