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