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_image,
 207    vtn_base_type_sampler,
 208    vtn_base_type_function,
 209 };
 210
 211 struct vtn_type {
 212    enum vtn_base_type base_type;
 213
 214    const struct glsl_type *type;
 215
 216    /* The value that declares this type.  Used for finding decorations */
 217    struct vtn_value *val;
 218
 219    /* Specifies the length of complex types. */
 220    unsigned length;
 221
 222    union {
 223       /* Members for scalar, vector, and array-like types */
 224       struct {
 225          /* for arrays, the vtn_type for the elements of the array */
 226          struct vtn_type *array_element;
 227
 228          /* for arrays and matrices, the array stride */
 229          unsigned stride;
 230
 231          /* for matrices, whether the matrix is stored row-major */
 232          bool row_major:1;
 233
 234          /* Whether this type, or a parent type, has been decorated as a
 235           * builtin
 236           */
 237          bool is_builtin:1;
 238
 239          /* Which built-in to use */
 240          SpvBuiltIn builtin;
 241       };
 242
 243       /* Members for struct types */
 244       struct {
 245          /* for structures, the vtn_type for each member */
 246          struct vtn_type **members;
 247
 248          /* for structs, the offset of each member */
 249          unsigned *offsets;
 250
 251          /* for structs, whether it was decorated as a "non-SSBO-like" block */
 252          bool block:1;
 253
 254          /* for structs, whether it was decorated as an "SSBO-like" block */
 255          bool buffer_block:1;
 256
 257          /* for structs with block == true, whether this is a builtin block
 258           * (i.e. a block that contains only builtins).
 259           */
 260          bool builtin_block:1;
 261       };
 262
 263       /* Members for image types */
 264       struct {
 265          /* For images, indicates whether it's sampled or storage */
 266          bool sampled;
 267
 268          /* Image format for image_load_store type images */
 269          unsigned image_format;
 270
 271          /* Access qualifier for storage images */
 272          SpvAccessQualifier access_qualifier;
 273       };
 274    };
 275 };
 276
 277 struct vtn_variable;
 278
 279 enum vtn_access_mode {
 280    vtn_access_mode_id,
 281    vtn_access_mode_literal,
 282 };
 283
 284 struct vtn_access_link {
 285    enum vtn_access_mode mode;
 286    uint32_t id;
 287 };
 288
 289 struct vtn_access_chain {
 290    uint32_t length;
 291
 292    /** Struct elements and array offsets.
 293     *
 294     * This is an array of 1 so that it can conveniently be created on the
 295     * stack but the real length is given by the length field.
 296     */
 297    struct vtn_access_link link[1];
 298 };
 299
 300 enum vtn_variable_mode {
 301    vtn_variable_mode_local,
 302    vtn_variable_mode_global,
 303    vtn_variable_mode_param,
 304    vtn_variable_mode_ubo,
 305    vtn_variable_mode_ssbo,
 306    vtn_variable_mode_push_constant,
 307    vtn_variable_mode_image,
 308    vtn_variable_mode_sampler,
 309    vtn_variable_mode_workgroup,
 310    vtn_variable_mode_input,
 311    vtn_variable_mode_output,
 312 };
 313
 314 struct vtn_pointer {
 315    /** The variable mode for the referenced data */
 316    enum vtn_variable_mode mode;
 317
 318    /** The dereferenced type of this pointer */
 319    struct vtn_type *type;
 320
 321    /** The referenced variable, if known
 322     *
 323     * This field may be NULL if the pointer uses a (block_index, offset) pair
 324     * instead of an access chain.
 325     */
 326    struct vtn_variable *var;
 327
 328    /** An access chain describing how to get from var to the referenced data
 329     *
 330     * This field may be NULL if the pointer references the entire variable or
 331     * if a (block_index, offset) pair is used instead of an access chain.
 332     */
 333    struct vtn_access_chain *chain;
 334
 335    /** A (block_index, offset) pair representing a UBO or SSBO position. */
 336    struct nir_ssa_def *block_index;
 337    struct nir_ssa_def *offset;
 338 };
 339
 340 struct vtn_variable {
 341    enum vtn_variable_mode mode;
 342
 343    struct vtn_type *type;
 344
 345    unsigned descriptor_set;
 346    unsigned binding;
 347    unsigned input_attachment_index;
 348    bool patch;
 349
 350    nir_variable *var;
 351    nir_variable **members;
 352
 353    /**
 354     * In some early released versions of GLSLang, it implemented all function
 355     * calls by making copies of all parameters into temporary variables and
 356     * passing those variables into the function.  It even did so for samplers
 357     * and images which violates the SPIR-V spec.  Unfortunately, two games
 358     * (Talos Principle and Doom) shipped with this old version of GLSLang and
 359     * also happen to pass samplers into functions.  Talos Principle received
 360     * an update fairly shortly after release with an updated GLSLang.  Doom,
 361     * on the other hand, has never received an update so we need to work
 362     * around this GLSLang issue in SPIR-V -> NIR.  Hopefully, we can drop this
 363     * hack at some point in the future.
 364     */
 365    struct vtn_pointer *copy_prop_sampler;
 366 };
 367
 368 struct vtn_image_pointer {
 369    struct vtn_pointer *image;
 370    nir_ssa_def *coord;
 371    nir_ssa_def *sample;
 372 };
 373
 374 struct vtn_sampled_image {
 375    struct vtn_pointer *image; /* Image or array of images */
 376    struct vtn_pointer *sampler; /* Sampler */
 377 };
 378
 379 struct vtn_value {
 380    enum vtn_value_type value_type;
 381    const char *name;
 382    struct vtn_decoration *decoration;
 383    union {
 384       void *ptr;
 385       char *str;
 386       struct vtn_type *type;
 387       struct {
 388          nir_constant *constant;
 389          const struct glsl_type *const_type;
 390       };
 391       struct vtn_pointer *pointer;
 392       struct vtn_image_pointer *image;
 393       struct vtn_sampled_image *sampled_image;
 394       struct vtn_function *func;
 395       struct vtn_block *block;
 396       struct vtn_ssa_value *ssa;
 397       vtn_instruction_handler ext_handler;
 398    };
 399 };
 400
 401 #define VTN_DEC_DECORATION -1
 402 #define VTN_DEC_EXECUTION_MODE -2
 403 #define VTN_DEC_STRUCT_MEMBER0 0
 404
 405 struct vtn_decoration {
 406    struct vtn_decoration *next;
 407
 408    /* Specifies how to apply this decoration.  Negative values represent a
 409     * decoration or execution mode. (See the VTN_DEC_ #defines above.)
 410     * Non-negative values specify that it applies to a structure member.
 411     */
 412    int scope;
 413
 414    const uint32_t *literals;
 415    struct vtn_value *group;
 416
 417    union {
 418       SpvDecoration decoration;
 419       SpvExecutionMode exec_mode;
 420    };
 421 };
 422
 423 struct vtn_builder {
 424    nir_builder nb;
 425
 426    nir_shader *shader;
 427    nir_function_impl *impl;
 428    const struct nir_spirv_supported_extensions *ext;
 429    struct vtn_block *block;
 430
 431    /* Current file, line, and column.  Useful for debugging.  Set
 432     * automatically by vtn_foreach_instruction.
 433     */
 434    char *file;
 435    int line, col;
 436
 437    /*
 438     * In SPIR-V, constants are global, whereas in NIR, the load_const
 439     * instruction we use is per-function. So while we parse each function, we
 440     * keep a hash table of constants we've resolved to nir_ssa_value's so
 441     * far, and we lazily resolve them when we see them used in a function.
 442     */
 443    struct hash_table *const_table;
 444
 445    /*
 446     * Map from phi instructions (pointer to the start of the instruction)
 447     * to the variable corresponding to it.
 448     */
 449    struct hash_table *phi_table;
 450
 451    unsigned num_specializations;
 452    struct nir_spirv_specialization *specializations;
 453
 454    unsigned value_id_bound;
 455    struct vtn_value *values;
 456
 457    gl_shader_stage entry_point_stage;
 458    const char *entry_point_name;
 459    struct vtn_value *entry_point;
 460    bool origin_upper_left;
 461    bool pixel_center_integer;
 462
 463    struct vtn_function *func;
 464    struct exec_list functions;
 465
 466    /* Current function parameter index */
 467    unsigned func_param_idx;
 468
 469    bool has_loop_continue;
 470 };
 471
 472 static inline struct vtn_value *
 473 vtn_push_value(struct vtn_builder *b, uint32_t value_id,
 474                enum vtn_value_type value_type)
 475 {
 476    assert(value_id < b->value_id_bound);
 477    assert(b->values[value_id].value_type == vtn_value_type_invalid);
 478
 479    b->values[value_id].value_type = value_type;
 480
 481    return &b->values[value_id];
 482 }
 483
 484 static inline struct vtn_value *
 485 vtn_untyped_value(struct vtn_builder *b, uint32_t value_id)
 486 {
 487    assert(value_id < b->value_id_bound);
 488    return &b->values[value_id];
 489 }
 490
 491 static inline struct vtn_value *
 492 vtn_value(struct vtn_builder *b, uint32_t value_id,
 493           enum vtn_value_type value_type)
 494 {
 495    struct vtn_value *val = vtn_untyped_value(b, value_id);
 496    assert(val->value_type == value_type);
 497    return val;
 498 }
 499
 500 void _vtn_warn(const char *file, int line, const char *msg, ...);
 501 #define vtn_warn(...) _vtn_warn(__FILE__, __LINE__, __VA_ARGS__)
 502
 503 struct vtn_ssa_value *vtn_ssa_value(struct vtn_builder *b, uint32_t value_id);
 504
 505 struct vtn_ssa_value *vtn_create_ssa_value(struct vtn_builder *b,
 506                                            const struct glsl_type *type);
 507
 508 struct vtn_ssa_value *vtn_ssa_transpose(struct vtn_builder *b,
 509                                         struct vtn_ssa_value *src);
 510
 511 nir_ssa_def *vtn_vector_extract(struct vtn_builder *b, nir_ssa_def *src,
 512                                 unsigned index);
 513 nir_ssa_def *vtn_vector_extract_dynamic(struct vtn_builder *b, nir_ssa_def *src,
 514                                         nir_ssa_def *index);
 515 nir_ssa_def *vtn_vector_insert(struct vtn_builder *b, nir_ssa_def *src,
 516                                nir_ssa_def *insert, unsigned index);
 517 nir_ssa_def *vtn_vector_insert_dynamic(struct vtn_builder *b, nir_ssa_def *src,
 518                                        nir_ssa_def *insert, nir_ssa_def *index);
 519
 520 nir_deref_var *vtn_nir_deref(struct vtn_builder *b, uint32_t id);
 521
 522 struct vtn_pointer *vtn_pointer_for_variable(struct vtn_builder *b,
 523                                              struct vtn_variable *var);
 524
 525 nir_deref_var *vtn_pointer_to_deref(struct vtn_builder *b,
 526                                     struct vtn_pointer *ptr);
 527 nir_ssa_def *
 528 vtn_pointer_to_offset(struct vtn_builder *b, struct vtn_pointer *ptr,
 529                       nir_ssa_def **index_out, unsigned *end_idx_out);
 530
 531 struct vtn_ssa_value *vtn_local_load(struct vtn_builder *b, nir_deref_var *src);
 532
 533 void vtn_local_store(struct vtn_builder *b, struct vtn_ssa_value *src,
 534                      nir_deref_var *dest);
 535
 536 struct vtn_ssa_value *
 537 vtn_variable_load(struct vtn_builder *b, struct vtn_pointer *src);
 538
 539 void vtn_variable_store(struct vtn_builder *b, struct vtn_ssa_value *src,
 540                         struct vtn_pointer *dest);
 541
 542 void vtn_handle_variables(struct vtn_builder *b, SpvOp opcode,
 543                           const uint32_t *w, unsigned count);
 544
 545
 546 typedef void (*vtn_decoration_foreach_cb)(struct vtn_builder *,
 547                                           struct vtn_value *,
 548                                           int member,
 549                                           const struct vtn_decoration *,
 550                                           void *);
 551
 552 void vtn_foreach_decoration(struct vtn_builder *b, struct vtn_value *value,
 553                             vtn_decoration_foreach_cb cb, void *data);
 554
 555 typedef void (*vtn_execution_mode_foreach_cb)(struct vtn_builder *,
 556                                               struct vtn_value *,
 557                                               const struct vtn_decoration *,
 558                                               void *);
 559
 560 void vtn_foreach_execution_mode(struct vtn_builder *b, struct vtn_value *value,
 561                                 vtn_execution_mode_foreach_cb cb, void *data);
 562
 563 nir_op vtn_nir_alu_op_for_spirv_opcode(SpvOp opcode, bool *swap,
 564                                        nir_alu_type src, nir_alu_type dst);
 565
 566 void vtn_handle_alu(struct vtn_builder *b, SpvOp opcode,
 567                     const uint32_t *w, unsigned count);
 568
 569 bool vtn_handle_glsl450_instruction(struct vtn_builder *b, uint32_t ext_opcode,
 570                                     const uint32_t *words, unsigned count);
 571
 572 static inline uint64_t
 573 vtn_u64_literal(const uint32_t *w)
 574 {
 575    return (uint64_t)w[1] << 32 | w[0];
 576 }
 577
 578 #endif /* _VTN_PRIVATE_H_ */