src/compiler/spirv/vtn_private.h

   1 /*
   2  * Copyright © 2015 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  *    Jason Ekstrand (jason@jlekstrand.net)
  25  *
  26  */
  27
  28 #ifndef _VTN_PRIVATE_H_
  29 #define _VTN_PRIVATE_H_
  30
  31 #include "nir/nir.h"
  32 #include "nir/nir_builder.h"
  33 #include "util/u_dynarray.h"
  34 #include "nir_spirv.h"
  35 #include "spirv.h"
  36
  37 struct vtn_builder;
  38 struct vtn_decoration;
  39
  40 enum vtn_value_type {
  41    vtn_value_type_invalid = 0,
  42    vtn_value_type_undef,
  43    vtn_value_type_string,
  44    vtn_value_type_decoration_group,
  45    vtn_value_type_type,
  46    vtn_value_type_constant,
  47    vtn_value_type_pointer,
  48    vtn_value_type_function,
  49    vtn_value_type_block,
  50    vtn_value_type_ssa,
  51    vtn_value_type_extension,
  52    vtn_value_type_image_pointer,
  53    vtn_value_type_sampled_image,
  54 };
  55
  56 enum vtn_branch_type {
  57    vtn_branch_type_none,
  58    vtn_branch_type_switch_break,
  59    vtn_branch_type_switch_fallthrough,
  60    vtn_branch_type_loop_break,
  61    vtn_branch_type_loop_continue,
  62    vtn_branch_type_discard,
  63    vtn_branch_type_return,
  64 };
  65
  66 enum vtn_cf_node_type {
  67    vtn_cf_node_type_block,
  68    vtn_cf_node_type_if,
  69    vtn_cf_node_type_loop,
  70    vtn_cf_node_type_switch,
  71 };
  72
  73 struct vtn_cf_node {
  74    struct list_head link;
  75    enum vtn_cf_node_type type;
  76 };
  77
  78 struct vtn_loop {
  79    struct vtn_cf_node node;
  80
  81    /* The main body of the loop */
  82    struct list_head body;
  83
  84    /* The "continue" part of the loop.  This gets executed after the body
  85     * and is where you go when you hit a continue.
  86     */
  87    struct list_head cont_body;
  88
  89    SpvLoopControlMask control;
  90 };
  91
  92 struct vtn_if {
  93    struct vtn_cf_node node;
  94
  95    uint32_t condition;
  96
  97    enum vtn_branch_type then_type;
  98    struct list_head then_body;
  99
 100    enum vtn_branch_type else_type;
 101    struct list_head else_body;
 102
 103    SpvSelectionControlMask control;
 104 };
 105
 106 struct vtn_case {
 107    struct list_head link;
 108
 109    struct list_head body;
 110
 111    /* The block that starts this case */
 112    struct vtn_block *start_block;
 113
 114    /* The fallthrough case, if any */
 115    struct vtn_case *fallthrough;
 116
 117    /* The uint32_t values that map to this case */
 118    struct util_dynarray values;
 119
 120    /* True if this is the default case */
 121    bool is_default;
 122
 123    /* Initialized to false; used when sorting the list of cases */
 124    bool visited;
 125 };
 126
 127 struct vtn_switch {
 128    struct vtn_cf_node node;
 129
 130    uint32_t selector;
 131
 132    struct list_head cases;
 133 };
 134
 135 struct vtn_block {
 136    struct vtn_cf_node node;
 137
 138    /** A pointer to the label instruction */
 139    const uint32_t *label;
 140
 141    /** A pointer to the merge instruction (or NULL if non exists) */
 142    const uint32_t *merge;
 143
 144    /** A pointer to the branch instruction that ends this block */
 145    const uint32_t *branch;
 146
 147    enum vtn_branch_type branch_type;
 148
 149    /** Points to the loop that this block starts (if it starts a loop) */
 150    struct vtn_loop *loop;
 151
 152    /** Points to the switch case started by this block (if any) */
 153    struct vtn_case *switch_case;
 154
 155    /** Every block ends in a nop intrinsic so that we can find it again */
 156    nir_intrinsic_instr *end_nop;
 157 };
 158
 159 struct vtn_function {
 160    struct exec_node node;
 161
 162    nir_function_impl *impl;
 163    struct vtn_block *start_block;
 164
 165    struct list_head body;
 166
 167    const uint32_t *end;
 168
 169    SpvFunctionControlMask control;
 170 };
 171
 172 typedef bool (*vtn_instruction_handler)(struct vtn_builder *, uint32_t,
 173                                         const uint32_t *, unsigned);
 174
 175 void vtn_build_cfg(struct vtn_builder *b, const uint32_t *words,
 176                    const uint32_t *end);
 177 void vtn_function_emit(struct vtn_builder *b, struct vtn_function *func,
 178                        vtn_instruction_handler instruction_handler);
 179
 180 const uint32_t *
 181 vtn_foreach_instruction(struct vtn_builder *b, const uint32_t *start,
 182                         const uint32_t *end, vtn_instruction_handler handler);
 183
 184 struct vtn_ssa_value {
 185    union {
 186       nir_ssa_def *def;
 187       struct vtn_ssa_value **elems;
 188    };
 189
 190    /* For matrices, if this is non-NULL, then this value is actually the
 191     * transpose of some other value.  The value that `transposed` points to
 192     * always dominates this value.
 193     */
 194    struct vtn_ssa_value *transposed;
 195
 196    const struct glsl_type *type;
 197 };
 198
 199 enum vtn_base_type {
 200    vtn_base_type_void,
 201    vtn_base_type_scalar,
 202    vtn_base_type_vector,
 203    vtn_base_type_matrix,
 204    vtn_base_type_array,
 205    vtn_base_type_struct,
 206    vtn_base_type_pointer,
 207    vtn_base_type_image,
 208    vtn_base_type_sampler,
 209    vtn_base_type_function,
 210 };
 211
 212 struct vtn_type {
 213    enum vtn_base_type base_type;
 214
 215    const struct glsl_type *type;
 216
 217    /* The value that declares this type.  Used for finding decorations */
 218    struct vtn_value *val;
 219
 220    /* Specifies the length of complex types. */
 221    unsigned length;
 222
 223    /* for arrays, matrices and pointers, the array stride */
 224    unsigned stride;
 225
 226    union {
 227       /* Members for scalar, vector, and array-like types */
 228       struct {
 229          /* for arrays, the vtn_type for the elements of the array */
 230          struct vtn_type *array_element;
 231
 232          /* for matrices, whether the matrix is stored row-major */
 233          bool row_major:1;
 234
 235          /* Whether this type, or a parent type, has been decorated as a
 236           * builtin
 237           */
 238          bool is_builtin:1;
 239
 240          /* Which built-in to use */
 241          SpvBuiltIn builtin;
 242       };
 243
 244       /* Members for struct types */
 245       struct {
 246          /* for structures, the vtn_type for each member */
 247          struct vtn_type **members;
 248
 249          /* for structs, the offset of each member */
 250          unsigned *offsets;
 251
 252          /* for structs, whether it was decorated as a "non-SSBO-like" block */
 253          bool block:1;
 254
 255          /* for structs, whether it was decorated as an "SSBO-like" block */
 256          bool buffer_block:1;
 257
 258          /* for structs with block == true, whether this is a builtin block
 259           * (i.e. a block that contains only builtins).
 260           */
 261          bool builtin_block:1;
 262       };
 263
 264       /* Members for pointer types */
 265       struct {
 266          /* For pointers, the vtn_type for dereferenced type */
 267          struct vtn_type *deref;
 268
 269          /* Storage class for pointers */
 270          SpvStorageClass storage_class;
 271       };
 272
 273       /* Members for image types */
 274       struct {
 275          /* For images, indicates whether it's sampled or storage */
 276          bool sampled;
 277
 278          /* Image format for image_load_store type images */
 279          unsigned image_format;
 280
 281          /* Access qualifier for storage images */
 282          SpvAccessQualifier access_qualifier;
 283       };
 284
 285       /* Members for function types */
 286       struct {
 287          /* For functions, the vtn_type for each parameter */
 288          struct vtn_type **params;
 289
 290          /* Return type for functions */
 291          struct vtn_type *return_type;
 292       };
 293    };
 294 };
 295
 296 struct vtn_variable;
 297
 298 enum vtn_access_mode {
 299    vtn_access_mode_id,
 300    vtn_access_mode_literal,
 301 };
 302
 303 struct vtn_access_link {
 304    enum vtn_access_mode mode;
 305    uint32_t id;
 306 };
 307
 308 struct vtn_access_chain {
 309    uint32_t length;
 310
 311    /** Whether or not to treat the base pointer as an array.  This is only
 312     * true if this access chain came from an OpPtrAccessChain.
 313     */
 314    bool ptr_as_array;
 315
 316    /** Struct elements and array offsets.
 317     *
 318     * This is an array of 1 so that it can conveniently be created on the
 319     * stack but the real length is given by the length field.
 320     */
 321    struct vtn_access_link link[1];
 322 };
 323
 324 enum vtn_variable_mode {
 325    vtn_variable_mode_local,
 326    vtn_variable_mode_global,
 327    vtn_variable_mode_param,
 328    vtn_variable_mode_ubo,
 329    vtn_variable_mode_ssbo,
 330    vtn_variable_mode_push_constant,
 331    vtn_variable_mode_image,
 332    vtn_variable_mode_sampler,
 333    vtn_variable_mode_workgroup,
 334    vtn_variable_mode_input,
 335    vtn_variable_mode_output,
 336 };
 337
 338 struct vtn_pointer {
 339    /** The variable mode for the referenced data */
 340    enum vtn_variable_mode mode;
 341
 342    /** The dereferenced type of this pointer */
 343    struct vtn_type *type;
 344
 345    /** The pointer type of this pointer
 346     *
 347     * This may be NULL for some temporary pointers constructed as part of a
 348     * large load, store, or copy.  It MUST be valid for all pointers which are
 349     * stored as SPIR-V SSA values.
 350     */
 351    struct vtn_type *ptr_type;
 352
 353    /** The referenced variable, if known
 354     *
 355     * This field may be NULL if the pointer uses a (block_index, offset) pair
 356     * instead of an access chain.
 357     */
 358    struct vtn_variable *var;
 359
 360    /** An access chain describing how to get from var to the referenced data
 361     *
 362     * This field may be NULL if the pointer references the entire variable or
 363     * if a (block_index, offset) pair is used instead of an access chain.
 364     */
 365    struct vtn_access_chain *chain;
 366
 367    /** A (block_index, offset) pair representing a UBO or SSBO position. */
 368    struct nir_ssa_def *block_index;
 369    struct nir_ssa_def *offset;
 370 };
 371
 372 static inline bool
 373 vtn_pointer_uses_ssa_offset(struct vtn_pointer *ptr)
 374 {
 375    return ptr->mode == vtn_variable_mode_ubo ||
 376           ptr->mode == vtn_variable_mode_ssbo;
 377 }
 378
 379 struct vtn_variable {
 380    enum vtn_variable_mode mode;
 381
 382    struct vtn_type *type;
 383
 384    unsigned descriptor_set;
 385    unsigned binding;
 386    unsigned input_attachment_index;
 387    bool patch;
 388
 389    nir_variable *var;
 390    nir_variable **members;
 391
 392    /**
 393     * In some early released versions of GLSLang, it implemented all function
 394     * calls by making copies of all parameters into temporary variables and
 395     * passing those variables into the function.  It even did so for samplers
 396     * and images which violates the SPIR-V spec.  Unfortunately, two games
 397     * (Talos Principle and Doom) shipped with this old version of GLSLang and
 398     * also happen to pass samplers into functions.  Talos Principle received
 399     * an update fairly shortly after release with an updated GLSLang.  Doom,
 400     * on the other hand, has never received an update so we need to work
 401     * around this GLSLang issue in SPIR-V -> NIR.  Hopefully, we can drop this
 402     * hack at some point in the future.
 403     */
 404    struct vtn_pointer *copy_prop_sampler;
 405 };
 406
 407 struct vtn_image_pointer {
 408    struct vtn_pointer *image;
 409    nir_ssa_def *coord;
 410    nir_ssa_def *sample;
 411 };
 412
 413 struct vtn_sampled_image {
 414    struct vtn_type *type;
 415    struct vtn_pointer *image; /* Image or array of images */
 416    struct vtn_pointer *sampler; /* Sampler */
 417 };
 418
 419 struct vtn_value {
 420    enum vtn_value_type value_type;
 421    const char *name;
 422    struct vtn_decoration *decoration;
 423    union {
 424       void *ptr;
 425       char *str;
 426       struct vtn_type *type;
 427       struct {
 428          nir_constant *constant;
 429          const struct glsl_type *const_type;
 430       };
 431       struct vtn_pointer *pointer;
 432       struct vtn_image_pointer *image;
 433       struct vtn_sampled_image *sampled_image;
 434       struct vtn_function *func;
 435       struct vtn_block *block;
 436       struct vtn_ssa_value *ssa;
 437       vtn_instruction_handler ext_handler;
 438    };
 439 };
 440
 441 #define VTN_DEC_DECORATION -1
 442 #define VTN_DEC_EXECUTION_MODE -2
 443 #define VTN_DEC_STRUCT_MEMBER0 0
 444
 445 struct vtn_decoration {
 446    struct vtn_decoration *next;
 447
 448    /* Specifies how to apply this decoration.  Negative values represent a
 449     * decoration or execution mode. (See the VTN_DEC_ #defines above.)
 450     * Non-negative values specify that it applies to a structure member.
 451     */
 452    int scope;
 453
 454    const uint32_t *literals;
 455    struct vtn_value *group;
 456
 457    union {
 458       SpvDecoration decoration;
 459       SpvExecutionMode exec_mode;
 460    };
 461 };
 462
 463 struct vtn_builder {
 464    nir_builder nb;
 465
 466    nir_shader *shader;
 467    nir_function_impl *impl;
 468    const struct nir_spirv_supported_extensions *ext;
 469    struct vtn_block *block;
 470
 471    /* Current file, line, and column.  Useful for debugging.  Set
 472     * automatically by vtn_foreach_instruction.
 473     */
 474    char *file;
 475    int line, col;
 476
 477    /*
 478     * In SPIR-V, constants are global, whereas in NIR, the load_const
 479     * instruction we use is per-function. So while we parse each function, we
 480     * keep a hash table of constants we've resolved to nir_ssa_value's so
 481     * far, and we lazily resolve them when we see them used in a function.
 482     */
 483    struct hash_table *const_table;
 484
 485    /*
 486     * Map from phi instructions (pointer to the start of the instruction)
 487     * to the variable corresponding to it.
 488     */
 489    struct hash_table *phi_table;
 490
 491    unsigned num_specializations;
 492    struct nir_spirv_specialization *specializations;
 493
 494    unsigned value_id_bound;
 495    struct vtn_value *values;
 496
 497    gl_shader_stage entry_point_stage;
 498    const char *entry_point_name;
 499    struct vtn_value *entry_point;
 500    bool origin_upper_left;
 501    bool pixel_center_integer;
 502
 503    struct vtn_function *func;
 504    struct exec_list functions;
 505
 506    /* Current function parameter index */
 507    unsigned func_param_idx;
 508
 509    bool has_loop_continue;
 510 };
 511
 512 nir_ssa_def *
 513 vtn_pointer_to_ssa(struct vtn_builder *b, struct vtn_pointer *ptr);
 514 struct vtn_pointer *
 515 vtn_pointer_from_ssa(struct vtn_builder *b, nir_ssa_def *ssa,
 516                      struct vtn_type *ptr_type);
 517
 518 static inline struct vtn_value *
 519 vtn_push_value(struct vtn_builder *b, uint32_t value_id,
 520                enum vtn_value_type value_type)
 521 {
 522    assert(value_id < b->value_id_bound);
 523    assert(b->values[value_id].value_type == vtn_value_type_invalid);
 524
 525    b->values[value_id].value_type = value_type;
 526
 527    return &b->values[value_id];
 528 }
 529
 530 static inline struct vtn_value *
 531 vtn_push_ssa(struct vtn_builder *b, uint32_t value_id,
 532              struct vtn_type *type, struct vtn_ssa_value *ssa)
 533 {
 534    struct vtn_value *val;
 535    if (type->base_type == vtn_base_type_pointer) {
 536       val = vtn_push_value(b, value_id, vtn_value_type_pointer);
 537       val->pointer = vtn_pointer_from_ssa(b, ssa->def, type);
 538    } else {
 539       val = vtn_push_value(b, value_id, vtn_value_type_ssa);
 540       val->ssa = ssa;
 541    }
 542    return val;
 543 }
 544
 545 static inline struct vtn_value *
 546 vtn_untyped_value(struct vtn_builder *b, uint32_t value_id)
 547 {
 548    assert(value_id < b->value_id_bound);
 549    return &b->values[value_id];
 550 }
 551
 552 static inline struct vtn_value *
 553 vtn_value(struct vtn_builder *b, uint32_t value_id,
 554           enum vtn_value_type value_type)
 555 {
 556    struct vtn_value *val = vtn_untyped_value(b, value_id);
 557    assert(val->value_type == value_type);
 558    return val;
 559 }
 560
 561 void _vtn_warn(const char *file, int line, const char *msg, ...);
 562 #define vtn_warn(...) _vtn_warn(__FILE__, __LINE__, __VA_ARGS__)
 563
 564 struct vtn_ssa_value *vtn_ssa_value(struct vtn_builder *b, uint32_t value_id);
 565
 566 struct vtn_ssa_value *vtn_create_ssa_value(struct vtn_builder *b,
 567                                            const struct glsl_type *type);
 568
 569 struct vtn_ssa_value *vtn_ssa_transpose(struct vtn_builder *b,
 570                                         struct vtn_ssa_value *src);
 571
 572 nir_ssa_def *vtn_vector_extract(struct vtn_builder *b, nir_ssa_def *src,
 573                                 unsigned index);
 574 nir_ssa_def *vtn_vector_extract_dynamic(struct vtn_builder *b, nir_ssa_def *src,
 575                                         nir_ssa_def *index);
 576 nir_ssa_def *vtn_vector_insert(struct vtn_builder *b, nir_ssa_def *src,
 577                                nir_ssa_def *insert, unsigned index);
 578 nir_ssa_def *vtn_vector_insert_dynamic(struct vtn_builder *b, nir_ssa_def *src,
 579                                        nir_ssa_def *insert, nir_ssa_def *index);
 580
 581 nir_deref_var *vtn_nir_deref(struct vtn_builder *b, uint32_t id);
 582
 583 struct vtn_pointer *vtn_pointer_for_variable(struct vtn_builder *b,
 584                                              struct vtn_variable *var,
 585                                              struct vtn_type *ptr_type);
 586
 587 nir_deref_var *vtn_pointer_to_deref(struct vtn_builder *b,
 588                                     struct vtn_pointer *ptr);
 589 nir_ssa_def *
 590 vtn_pointer_to_offset(struct vtn_builder *b, struct vtn_pointer *ptr,
 591                       nir_ssa_def **index_out, unsigned *end_idx_out);
 592
 593 struct vtn_ssa_value *vtn_local_load(struct vtn_builder *b, nir_deref_var *src);
 594
 595 void vtn_local_store(struct vtn_builder *b, struct vtn_ssa_value *src,
 596                      nir_deref_var *dest);
 597
 598 struct vtn_ssa_value *
 599 vtn_variable_load(struct vtn_builder *b, struct vtn_pointer *src);
 600
 601 void vtn_variable_store(struct vtn_builder *b, struct vtn_ssa_value *src,
 602                         struct vtn_pointer *dest);
 603
 604 void vtn_handle_variables(struct vtn_builder *b, SpvOp opcode,
 605                           const uint32_t *w, unsigned count);
 606
 607
 608 typedef void (*vtn_decoration_foreach_cb)(struct vtn_builder *,
 609                                           struct vtn_value *,
 610                                           int member,
 611                                           const struct vtn_decoration *,
 612                                           void *);
 613
 614 void vtn_foreach_decoration(struct vtn_builder *b, struct vtn_value *value,
 615                             vtn_decoration_foreach_cb cb, void *data);
 616
 617 typedef void (*vtn_execution_mode_foreach_cb)(struct vtn_builder *,
 618                                               struct vtn_value *,
 619                                               const struct vtn_decoration *,
 620                                               void *);
 621
 622 void vtn_foreach_execution_mode(struct vtn_builder *b, struct vtn_value *value,
 623                                 vtn_execution_mode_foreach_cb cb, void *data);
 624
 625 nir_op vtn_nir_alu_op_for_spirv_opcode(SpvOp opcode, bool *swap,
 626                                        nir_alu_type src, nir_alu_type dst);
 627
 628 void vtn_handle_alu(struct vtn_builder *b, SpvOp opcode,
 629                     const uint32_t *w, unsigned count);
 630
 631 bool vtn_handle_glsl450_instruction(struct vtn_builder *b, uint32_t ext_opcode,
 632                                     const uint32_t *words, unsigned count);
 633
 634 static inline uint64_t
 635 vtn_u64_literal(const uint32_t *w)
 636 {
 637    return (uint64_t)w[1] << 32 | w[0];
 638 }
 639
 640 #endif /* _VTN_PRIVATE_H_ */