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 <setjmp.h>
  32
  33 #include "nir/nir.h"
  34 #include "nir/nir_builder.h"
  35 #include "util/u_dynarray.h"
  36 #include "nir_spirv.h"
  37 #include "spirv.h"
  38
  39 struct vtn_builder;
  40 struct vtn_decoration;
  41
  42 void vtn_log(struct vtn_builder *b, enum nir_spirv_debug_level level,
  43              size_t spirv_offset, const char *message);
  44
  45 void vtn_logf(struct vtn_builder *b, enum nir_spirv_debug_level level,
  46               size_t spirv_offset, const char *fmt, ...) PRINTFLIKE(4, 5);
  47
  48 #define vtn_info(...) vtn_logf(b, NIR_SPIRV_DEBUG_LEVEL_INFO, 0, __VA_ARGS__)
  49
  50 void _vtn_warn(struct vtn_builder *b, const char *file, unsigned line,
  51                const char *fmt, ...) PRINTFLIKE(4, 5);
  52 #define vtn_warn(...) _vtn_warn(b, __FILE__, __LINE__, __VA_ARGS__)
  53
  54 void _vtn_err(struct vtn_builder *b, const char *file, unsigned line,
  55                const char *fmt, ...) PRINTFLIKE(4, 5);
  56 #define vtn_err(...) _vtn_err(b, __FILE__, __LINE__, __VA_ARGS__)
  57
  58 /** Fail SPIR-V parsing
  59  *
  60  * This function logs an error and then bails out of the shader compile using
  61  * longjmp.  This being safe relies on two things:
  62  *
  63  *  1) We must guarantee that setjmp is called after allocating the builder
  64  *     and setting up b->debug (so that logging works) but before before any
  65  *     errors have a chance to occur.
  66  *
  67  *  2) While doing the SPIR-V -> NIR conversion, we need to be careful to
  68  *     ensure that all heap allocations happen through ralloc and are parented
  69  *     to the builder.  This way they will get properly cleaned up on error.
  70  *
  71  *  3) We must ensure that _vtn_fail is never called while a mutex lock or a
  72  *     reference to any other resource is held with the exception of ralloc
  73  *     objects which are parented to the builder.
  74  *
  75  * So long as these two things continue to hold, we can easily longjmp back to
  76  * spirv_to_nir(), clean up the builder, and return NULL.
  77  */
  78 NORETURN void
  79 _vtn_fail(struct vtn_builder *b, const char *file, unsigned line,
  80              const char *fmt, ...) PRINTFLIKE(4, 5);
  81
  82 #define vtn_fail(...) _vtn_fail(b, __FILE__, __LINE__, __VA_ARGS__)
  83
  84 /** Fail if the given expression evaluates to true */
  85 #define vtn_fail_if(expr, ...) \
  86    do { \
  87       if (unlikely(expr)) \
  88          vtn_fail(__VA_ARGS__); \
  89    } while (0)
  90
  91 #define _vtn_fail_with(t, msg, v) \
  92    vtn_fail("%s: %s (%u)\n", msg, spirv_ ## t ## _to_string(v), v)
  93
  94 #define vtn_fail_with_decoration(msg, v) _vtn_fail_with(decoration, msg, v)
  95 #define vtn_fail_with_opcode(msg, v)     _vtn_fail_with(op, msg, v)
  96
  97 /** Assert that a condition is true and, if it isn't, vtn_fail
  98  *
  99  * This macro is transitional only and should not be used in new code.  Use
 100  * vtn_fail_if and provide a real message instead.
 101  */
 102 #define vtn_assert(expr) \
 103    do { \
 104       if (!likely(expr)) \
 105          vtn_fail("%s", #expr); \
 106    } while (0)
 107
 108 enum vtn_value_type {
 109    vtn_value_type_invalid = 0,
 110    vtn_value_type_undef,
 111    vtn_value_type_string,
 112    vtn_value_type_decoration_group,
 113    vtn_value_type_type,
 114    vtn_value_type_constant,
 115    vtn_value_type_pointer,
 116    vtn_value_type_function,
 117    vtn_value_type_block,
 118    vtn_value_type_ssa,
 119    vtn_value_type_extension,
 120    vtn_value_type_image_pointer,
 121    vtn_value_type_sampled_image,
 122 };
 123
 124 enum vtn_branch_type {
 125    vtn_branch_type_none,
 126    vtn_branch_type_switch_break,
 127    vtn_branch_type_switch_fallthrough,
 128    vtn_branch_type_loop_break,
 129    vtn_branch_type_loop_continue,
 130    vtn_branch_type_discard,
 131    vtn_branch_type_return,
 132 };
 133
 134 enum vtn_cf_node_type {
 135    vtn_cf_node_type_block,
 136    vtn_cf_node_type_if,
 137    vtn_cf_node_type_loop,
 138    vtn_cf_node_type_case,
 139    vtn_cf_node_type_switch,
 140    vtn_cf_node_type_function,
 141 };
 142
 143 struct vtn_cf_node {
 144    struct list_head link;
 145    struct vtn_cf_node *parent;
 146    enum vtn_cf_node_type type;
 147 };
 148
 149 struct vtn_loop {
 150    struct vtn_cf_node node;
 151
 152    /* The main body of the loop */
 153    struct list_head body;
 154
 155    /* The "continue" part of the loop.  This gets executed after the body
 156     * and is where you go when you hit a continue.
 157     */
 158    struct list_head cont_body;
 159
 160    SpvLoopControlMask control;
 161 };
 162
 163 struct vtn_if {
 164    struct vtn_cf_node node;
 165
 166    uint32_t condition;
 167
 168    enum vtn_branch_type then_type;
 169    struct list_head then_body;
 170
 171    enum vtn_branch_type else_type;
 172    struct list_head else_body;
 173
 174    SpvSelectionControlMask control;
 175 };
 176
 177 struct vtn_case {
 178    struct vtn_cf_node node;
 179
 180    struct list_head body;
 181
 182    /* The block that starts this case */
 183    struct vtn_block *start_block;
 184
 185    /* The fallthrough case, if any */
 186    struct vtn_case *fallthrough;
 187
 188    /* The uint32_t values that map to this case */
 189    struct util_dynarray values;
 190
 191    /* True if this is the default case */
 192    bool is_default;
 193
 194    /* Initialized to false; used when sorting the list of cases */
 195    bool visited;
 196 };
 197
 198 struct vtn_switch {
 199    struct vtn_cf_node node;
 200
 201    uint32_t selector;
 202
 203    struct list_head cases;
 204 };
 205
 206 struct vtn_block {
 207    struct vtn_cf_node node;
 208
 209    /** A pointer to the label instruction */
 210    const uint32_t *label;
 211
 212    /** A pointer to the merge instruction (or NULL if non exists) */
 213    const uint32_t *merge;
 214
 215    /** A pointer to the branch instruction that ends this block */
 216    const uint32_t *branch;
 217
 218    enum vtn_branch_type branch_type;
 219
 220    /** Points to the loop that this block starts (if it starts a loop) */
 221    struct vtn_loop *loop;
 222
 223    /** Points to the switch case started by this block (if any) */
 224    struct vtn_case *switch_case;
 225
 226    /** Every block ends in a nop intrinsic so that we can find it again */
 227    nir_intrinsic_instr *end_nop;
 228 };
 229
 230 struct vtn_function {
 231    struct vtn_cf_node node;
 232
 233    struct vtn_type *type;
 234
 235    bool referenced;
 236    bool emitted;
 237
 238    nir_function_impl *impl;
 239    struct vtn_block *start_block;
 240
 241    struct list_head body;
 242
 243    const uint32_t *end;
 244
 245    SpvFunctionControlMask control;
 246 };
 247
 248 #define VTN_DECL_CF_NODE_CAST(_type)               \
 249 static inline struct vtn_##_type *                 \
 250 vtn_cf_node_as_##_type(struct vtn_cf_node *node)   \
 251 {                                                  \
 252    assert(node->type == vtn_cf_node_type_##_type); \
 253    return (struct vtn_##_type *)node;              \
 254 }
 255
 256 VTN_DECL_CF_NODE_CAST(block)
 257 VTN_DECL_CF_NODE_CAST(loop)
 258 VTN_DECL_CF_NODE_CAST(if)
 259 VTN_DECL_CF_NODE_CAST(case)
 260 VTN_DECL_CF_NODE_CAST(switch)
 261 VTN_DECL_CF_NODE_CAST(function)
 262
 263 #define vtn_foreach_cf_node(node, cf_list) \
 264    list_for_each_entry(struct vtn_cf_node, node, cf_list, link)
 265
 266 typedef bool (*vtn_instruction_handler)(struct vtn_builder *, SpvOp,
 267                                         const uint32_t *, unsigned);
 268
 269 void vtn_build_cfg(struct vtn_builder *b, const uint32_t *words,
 270                    const uint32_t *end);
 271 void vtn_function_emit(struct vtn_builder *b, struct vtn_function *func,
 272                        vtn_instruction_handler instruction_handler);
 273 void vtn_handle_function_call(struct vtn_builder *b, SpvOp opcode,
 274                               const uint32_t *w, unsigned count);
 275
 276 const uint32_t *
 277 vtn_foreach_instruction(struct vtn_builder *b, const uint32_t *start,
 278                         const uint32_t *end, vtn_instruction_handler handler);
 279
 280 struct vtn_ssa_value {
 281    union {
 282       nir_ssa_def *def;
 283       struct vtn_ssa_value **elems;
 284    };
 285
 286    /* For matrices, if this is non-NULL, then this value is actually the
 287     * transpose of some other value.  The value that `transposed` points to
 288     * always dominates this value.
 289     */
 290    struct vtn_ssa_value *transposed;
 291
 292    const struct glsl_type *type;
 293
 294    /* Access qualifiers */
 295    enum gl_access_qualifier access;
 296 };
 297
 298 enum vtn_base_type {
 299    vtn_base_type_void,
 300    vtn_base_type_scalar,
 301    vtn_base_type_vector,
 302    vtn_base_type_matrix,
 303    vtn_base_type_array,
 304    vtn_base_type_struct,
 305    vtn_base_type_pointer,
 306    vtn_base_type_image,
 307    vtn_base_type_sampler,
 308    vtn_base_type_sampled_image,
 309    vtn_base_type_function,
 310 };
 311
 312 struct vtn_type {
 313    enum vtn_base_type base_type;
 314
 315    const struct glsl_type *type;
 316
 317    /* The SPIR-V id of the given type. */
 318    uint32_t id;
 319
 320    /* Specifies the length of complex types.
 321     *
 322     * For Workgroup pointers, this is the size of the referenced type.
 323     */
 324    unsigned length;
 325
 326    /* for arrays, matrices and pointers, the array stride */
 327    unsigned stride;
 328
 329    /* Access qualifiers */
 330    enum gl_access_qualifier access;
 331
 332    union {
 333       /* Members for scalar, vector, and array-like types */
 334       struct {
 335          /* for arrays, the vtn_type for the elements of the array */
 336          struct vtn_type *array_element;
 337
 338          /* for matrices, whether the matrix is stored row-major */
 339          bool row_major:1;
 340
 341          /* Whether this type, or a parent type, has been decorated as a
 342           * builtin
 343           */
 344          bool is_builtin:1;
 345
 346          /* Which built-in to use */
 347          SpvBuiltIn builtin;
 348       };
 349
 350       /* Members for struct types */
 351       struct {
 352          /* for structures, the vtn_type for each member */
 353          struct vtn_type **members;
 354
 355          /* for structs, the offset of each member */
 356          unsigned *offsets;
 357
 358          /* for structs, whether it was decorated as a "non-SSBO-like" block */
 359          bool block:1;
 360
 361          /* for structs, whether it was decorated as an "SSBO-like" block */
 362          bool buffer_block:1;
 363
 364          /* for structs with block == true, whether this is a builtin block
 365           * (i.e. a block that contains only builtins).
 366           */
 367          bool builtin_block:1;
 368
 369          /* for structs and unions it specifies the minimum alignment of the
 370           * members. 0 means packed.
 371           *
 372           * Set by CPacked and Alignment Decorations in kernels.
 373           */
 374          bool packed:1;
 375       };
 376
 377       /* Members for pointer types */
 378       struct {
 379          /* For pointers, the vtn_type for dereferenced type */
 380          struct vtn_type *deref;
 381
 382          /* Storage class for pointers */
 383          SpvStorageClass storage_class;
 384
 385          /* Required alignment for pointers */
 386          uint32_t align;
 387       };
 388
 389       /* Members for image types */
 390       struct {
 391          /* For images, indicates whether it's sampled or storage */
 392          bool sampled;
 393
 394          /* Image format for image_load_store type images */
 395          unsigned image_format;
 396
 397          /* Access qualifier for storage images */
 398          SpvAccessQualifier access_qualifier;
 399       };
 400
 401       /* Members for sampled image types */
 402       struct {
 403          /* For sampled images, the image type */
 404          struct vtn_type *image;
 405       };
 406
 407       /* Members for function types */
 408       struct {
 409          /* For functions, the vtn_type for each parameter */
 410          struct vtn_type **params;
 411
 412          /* Return type for functions */
 413          struct vtn_type *return_type;
 414       };
 415    };
 416 };
 417
 418 bool vtn_type_contains_block(struct vtn_builder *b, struct vtn_type *type);
 419
 420 bool vtn_types_compatible(struct vtn_builder *b,
 421                           struct vtn_type *t1, struct vtn_type *t2);
 422
 423 struct vtn_type *vtn_type_without_array(struct vtn_type *type);
 424
 425 struct vtn_variable;
 426
 427 enum vtn_access_mode {
 428    vtn_access_mode_id,
 429    vtn_access_mode_literal,
 430 };
 431
 432 struct vtn_access_link {
 433    enum vtn_access_mode mode;
 434    int64_t id;
 435 };
 436
 437 struct vtn_access_chain {
 438    uint32_t length;
 439
 440    /** Whether or not to treat the base pointer as an array.  This is only
 441     * true if this access chain came from an OpPtrAccessChain.
 442     */
 443    bool ptr_as_array;
 444
 445    /* Access qualifiers */
 446    enum gl_access_qualifier access;
 447
 448    /** Struct elements and array offsets.
 449     *
 450     * This is an array of 1 so that it can conveniently be created on the
 451     * stack but the real length is given by the length field.
 452     */
 453    struct vtn_access_link link[1];
 454 };
 455
 456 enum vtn_variable_mode {
 457    vtn_variable_mode_function,
 458    vtn_variable_mode_private,
 459    vtn_variable_mode_uniform,
 460    vtn_variable_mode_ubo,
 461    vtn_variable_mode_ssbo,
 462    vtn_variable_mode_phys_ssbo,
 463    vtn_variable_mode_push_constant,
 464    vtn_variable_mode_workgroup,
 465    vtn_variable_mode_cross_workgroup,
 466    vtn_variable_mode_input,
 467    vtn_variable_mode_output,
 468    vtn_variable_mode_image,
 469 };
 470
 471 struct vtn_pointer {
 472    /** The variable mode for the referenced data */
 473    enum vtn_variable_mode mode;
 474
 475    /** The dereferenced type of this pointer */
 476    struct vtn_type *type;
 477
 478    /** The pointer type of this pointer
 479     *
 480     * This may be NULL for some temporary pointers constructed as part of a
 481     * large load, store, or copy.  It MUST be valid for all pointers which are
 482     * stored as SPIR-V SSA values.
 483     */
 484    struct vtn_type *ptr_type;
 485
 486    /** The referenced variable, if known
 487     *
 488     * This field may be NULL if the pointer uses a (block_index, offset) pair
 489     * instead of an access chain or if the access chain starts at a deref.
 490     */
 491    struct vtn_variable *var;
 492
 493    /** The NIR deref corresponding to this pointer */
 494    nir_deref_instr *deref;
 495
 496    /** A (block_index, offset) pair representing a UBO or SSBO position. */
 497    struct nir_ssa_def *block_index;
 498    struct nir_ssa_def *offset;
 499
 500    /* Access qualifiers */
 501    enum gl_access_qualifier access;
 502 };
 503
 504 bool vtn_mode_uses_ssa_offset(struct vtn_builder *b,
 505                               enum vtn_variable_mode mode);
 506
 507 static inline bool vtn_pointer_uses_ssa_offset(struct vtn_builder *b,
 508                                                struct vtn_pointer *ptr)
 509 {
 510    return vtn_mode_uses_ssa_offset(b, ptr->mode);
 511 }
 512
 513
 514 struct vtn_variable {
 515    enum vtn_variable_mode mode;
 516
 517    struct vtn_type *type;
 518
 519    unsigned descriptor_set;
 520    unsigned binding;
 521    bool explicit_binding;
 522    unsigned offset;
 523    unsigned input_attachment_index;
 524    bool patch;
 525
 526    nir_variable *var;
 527
 528    /* If the variable is a struct with a location set on it then this will be
 529     * stored here. This will be used to calculate locations for members that
 530     * don’t have their own explicit location.
 531     */
 532    int base_location;
 533
 534    int shared_location;
 535
 536    /**
 537     * In some early released versions of GLSLang, it implemented all function
 538     * calls by making copies of all parameters into temporary variables and
 539     * passing those variables into the function.  It even did so for samplers
 540     * and images which violates the SPIR-V spec.  Unfortunately, two games
 541     * (Talos Principle and Doom) shipped with this old version of GLSLang and
 542     * also happen to pass samplers into functions.  Talos Principle received
 543     * an update fairly shortly after release with an updated GLSLang.  Doom,
 544     * on the other hand, has never received an update so we need to work
 545     * around this GLSLang issue in SPIR-V -> NIR.  Hopefully, we can drop this
 546     * hack at some point in the future.
 547     */
 548    struct vtn_pointer *copy_prop_sampler;
 549
 550    /* Access qualifiers. */
 551    enum gl_access_qualifier access;
 552 };
 553
 554 struct vtn_image_pointer {
 555    struct vtn_pointer *image;
 556    nir_ssa_def *coord;
 557    nir_ssa_def *sample;
 558    nir_ssa_def *lod;
 559 };
 560
 561 struct vtn_sampled_image {
 562    struct vtn_pointer *image; /* Image or array of images */
 563    struct vtn_pointer *sampler; /* Sampler */
 564 };
 565
 566 struct vtn_value {
 567    enum vtn_value_type value_type;
 568    const char *name;
 569    struct vtn_decoration *decoration;
 570    struct vtn_type *type;
 571    union {
 572       void *ptr;
 573       char *str;
 574       nir_constant *constant;
 575       struct vtn_pointer *pointer;
 576       struct vtn_image_pointer *image;
 577       struct vtn_sampled_image *sampled_image;
 578       struct vtn_function *func;
 579       struct vtn_block *block;
 580       struct vtn_ssa_value *ssa;
 581       vtn_instruction_handler ext_handler;
 582    };
 583 };
 584
 585 #define VTN_DEC_DECORATION -1
 586 #define VTN_DEC_EXECUTION_MODE -2
 587 #define VTN_DEC_STRUCT_MEMBER0 0
 588
 589 struct vtn_decoration {
 590    struct vtn_decoration *next;
 591
 592    /* Specifies how to apply this decoration.  Negative values represent a
 593     * decoration or execution mode. (See the VTN_DEC_ #defines above.)
 594     * Non-negative values specify that it applies to a structure member.
 595     */
 596    int scope;
 597
 598    const uint32_t *operands;
 599    struct vtn_value *group;
 600
 601    union {
 602       SpvDecoration decoration;
 603       SpvExecutionMode exec_mode;
 604    };
 605 };
 606
 607 struct vtn_builder {
 608    nir_builder nb;
 609
 610    /* Used by vtn_fail to jump back to the beginning of SPIR-V compilation */
 611    jmp_buf fail_jump;
 612
 613    const uint32_t *spirv;
 614    size_t spirv_word_count;
 615
 616    nir_shader *shader;
 617    struct spirv_to_nir_options *options;
 618    struct vtn_block *block;
 619
 620    /* Current offset, file, line, and column.  Useful for debugging.  Set
 621     * automatically by vtn_foreach_instruction.
 622     */
 623    size_t spirv_offset;
 624    char *file;
 625    int line, col;
 626
 627    /*
 628     * In SPIR-V, constants are global, whereas in NIR, the load_const
 629     * instruction we use is per-function. So while we parse each function, we
 630     * keep a hash table of constants we've resolved to nir_ssa_value's so
 631     * far, and we lazily resolve them when we see them used in a function.
 632     */
 633    struct hash_table *const_table;
 634
 635    /*
 636     * Map from phi instructions (pointer to the start of the instruction)
 637     * to the variable corresponding to it.
 638     */
 639    struct hash_table *phi_table;
 640
 641    unsigned num_specializations;
 642    struct nir_spirv_specialization *specializations;
 643
 644    unsigned value_id_bound;
 645    struct vtn_value *values;
 646
 647    /* True if we should watch out for GLSLang issue #179 */
 648    bool wa_glslang_179;
 649
 650    /* True if we need to fix up CS OpControlBarrier */
 651    bool wa_glslang_cs_barrier;
 652
 653    gl_shader_stage entry_point_stage;
 654    const char *entry_point_name;
 655    struct vtn_value *entry_point;
 656    struct vtn_value *workgroup_size_builtin;
 657    bool variable_pointers;
 658
 659    struct vtn_function *func;
 660    struct list_head functions;
 661
 662    /* Current function parameter index */
 663    unsigned func_param_idx;
 664
 665    bool has_loop_continue;
 666
 667    /* false by default, set to true by the ContractionOff execution mode */
 668    bool exact;
 669
 670    /* when a physical memory model is choosen */
 671    bool physical_ptrs;
 672 };
 673
 674 nir_ssa_def *
 675 vtn_pointer_to_ssa(struct vtn_builder *b, struct vtn_pointer *ptr);
 676 struct vtn_pointer *
 677 vtn_pointer_from_ssa(struct vtn_builder *b, nir_ssa_def *ssa,
 678                      struct vtn_type *ptr_type);
 679
 680 static inline struct vtn_value *
 681 vtn_untyped_value(struct vtn_builder *b, uint32_t value_id)
 682 {
 683    vtn_fail_if(value_id >= b->value_id_bound,
 684                "SPIR-V id %u is out-of-bounds", value_id);
 685    return &b->values[value_id];
 686 }
 687
 688 /* Consider not using this function directly and instead use
 689  * vtn_push_ssa/vtn_push_value_pointer so that appropriate applying of
 690  * decorations is handled by common code.
 691  */
 692 static inline struct vtn_value *
 693 vtn_push_value(struct vtn_builder *b, uint32_t value_id,
 694                enum vtn_value_type value_type)
 695 {
 696    struct vtn_value *val = vtn_untyped_value(b, value_id);
 697
 698    vtn_fail_if(val->value_type != vtn_value_type_invalid,
 699                "SPIR-V id %u has already been written by another instruction",
 700                value_id);
 701
 702    val->value_type = value_type;
 703
 704    return &b->values[value_id];
 705 }
 706
 707 static inline struct vtn_value *
 708 vtn_value(struct vtn_builder *b, uint32_t value_id,
 709           enum vtn_value_type value_type)
 710 {
 711    struct vtn_value *val = vtn_untyped_value(b, value_id);
 712    vtn_fail_if(val->value_type != value_type,
 713                "SPIR-V id %u is the wrong kind of value", value_id);
 714    return val;
 715 }
 716
 717 bool
 718 vtn_set_instruction_result_type(struct vtn_builder *b, SpvOp opcode,
 719                                 const uint32_t *w, unsigned count);
 720
 721 static inline uint64_t
 722 vtn_constant_uint(struct vtn_builder *b, uint32_t value_id)
 723 {
 724    struct vtn_value *val = vtn_value(b, value_id, vtn_value_type_constant);
 725
 726    vtn_fail_if(val->type->base_type != vtn_base_type_scalar ||
 727                !glsl_type_is_integer(val->type->type),
 728                "Expected id %u to be an integer constant", value_id);
 729
 730    switch (glsl_get_bit_size(val->type->type)) {
 731    case 8:  return val->constant->values[0].u8;
 732    case 16: return val->constant->values[0].u16;
 733    case 32: return val->constant->values[0].u32;
 734    case 64: return val->constant->values[0].u64;
 735    default: unreachable("Invalid bit size");
 736    }
 737 }
 738
 739 static inline int64_t
 740 vtn_constant_int(struct vtn_builder *b, uint32_t value_id)
 741 {
 742    struct vtn_value *val = vtn_value(b, value_id, vtn_value_type_constant);
 743
 744    vtn_fail_if(val->type->base_type != vtn_base_type_scalar ||
 745                !glsl_type_is_integer(val->type->type),
 746                "Expected id %u to be an integer constant", value_id);
 747
 748    switch (glsl_get_bit_size(val->type->type)) {
 749    case 8:  return val->constant->values[0].i8;
 750    case 16: return val->constant->values[0].i16;
 751    case 32: return val->constant->values[0].i32;
 752    case 64: return val->constant->values[0].i64;
 753    default: unreachable("Invalid bit size");
 754    }
 755 }
 756
 757 static inline enum gl_access_qualifier vtn_value_access(struct vtn_value *value)
 758 {
 759    switch (value->value_type) {
 760    case vtn_value_type_invalid:
 761    case vtn_value_type_undef:
 762    case vtn_value_type_string:
 763    case vtn_value_type_decoration_group:
 764    case vtn_value_type_constant:
 765    case vtn_value_type_function:
 766    case vtn_value_type_block:
 767    case vtn_value_type_extension:
 768       return 0;
 769    case vtn_value_type_type:
 770       return value->type->access;
 771    case vtn_value_type_pointer:
 772       return value->pointer->access;
 773    case vtn_value_type_ssa:
 774       return value->ssa->access;
 775    case vtn_value_type_image_pointer:
 776       return value->image->image->access;
 777    case vtn_value_type_sampled_image:
 778       return value->sampled_image->image->access |
 779          value->sampled_image->sampler->access;
 780    }
 781
 782    unreachable("invalid type");
 783 }
 784
 785 struct vtn_ssa_value *vtn_ssa_value(struct vtn_builder *b, uint32_t value_id);
 786
 787 struct vtn_value *vtn_push_value_pointer(struct vtn_builder *b,
 788                                          uint32_t value_id,
 789                                          struct vtn_pointer *ptr);
 790
 791 struct vtn_value *vtn_push_ssa(struct vtn_builder *b, uint32_t value_id,
 792                                struct vtn_type *type, struct vtn_ssa_value *ssa);
 793
 794 struct vtn_ssa_value *vtn_create_ssa_value(struct vtn_builder *b,
 795                                            const struct glsl_type *type);
 796
 797 struct vtn_ssa_value *vtn_ssa_transpose(struct vtn_builder *b,
 798                                         struct vtn_ssa_value *src);
 799
 800 nir_ssa_def *vtn_vector_extract(struct vtn_builder *b, nir_ssa_def *src,
 801                                 unsigned index);
 802 nir_ssa_def *vtn_vector_extract_dynamic(struct vtn_builder *b, nir_ssa_def *src,
 803                                         nir_ssa_def *index);
 804 nir_ssa_def *vtn_vector_insert(struct vtn_builder *b, nir_ssa_def *src,
 805                                nir_ssa_def *insert, unsigned index);
 806 nir_ssa_def *vtn_vector_insert_dynamic(struct vtn_builder *b, nir_ssa_def *src,
 807                                        nir_ssa_def *insert, nir_ssa_def *index);
 808
 809 nir_deref_instr *vtn_nir_deref(struct vtn_builder *b, uint32_t id);
 810
 811 struct vtn_pointer *vtn_pointer_for_variable(struct vtn_builder *b,
 812                                              struct vtn_variable *var,
 813                                              struct vtn_type *ptr_type);
 814
 815 nir_deref_instr *vtn_pointer_to_deref(struct vtn_builder *b,
 816                                       struct vtn_pointer *ptr);
 817 nir_ssa_def *
 818 vtn_pointer_to_offset(struct vtn_builder *b, struct vtn_pointer *ptr,
 819                       nir_ssa_def **index_out);
 820
 821 struct vtn_ssa_value *
 822 vtn_local_load(struct vtn_builder *b, nir_deref_instr *src,
 823                enum gl_access_qualifier access);
 824
 825 void vtn_local_store(struct vtn_builder *b, struct vtn_ssa_value *src,
 826                      nir_deref_instr *dest,
 827                      enum gl_access_qualifier access);
 828
 829 struct vtn_ssa_value *
 830 vtn_variable_load(struct vtn_builder *b, struct vtn_pointer *src);
 831
 832 void vtn_variable_store(struct vtn_builder *b, struct vtn_ssa_value *src,
 833                         struct vtn_pointer *dest);
 834
 835 void vtn_handle_variables(struct vtn_builder *b, SpvOp opcode,
 836                           const uint32_t *w, unsigned count);
 837
 838
 839 typedef void (*vtn_decoration_foreach_cb)(struct vtn_builder *,
 840                                           struct vtn_value *,
 841                                           int member,
 842                                           const struct vtn_decoration *,
 843                                           void *);
 844
 845 void vtn_foreach_decoration(struct vtn_builder *b, struct vtn_value *value,
 846                             vtn_decoration_foreach_cb cb, void *data);
 847
 848 typedef void (*vtn_execution_mode_foreach_cb)(struct vtn_builder *,
 849                                               struct vtn_value *,
 850                                               const struct vtn_decoration *,
 851                                               void *);
 852
 853 void vtn_foreach_execution_mode(struct vtn_builder *b, struct vtn_value *value,
 854                                 vtn_execution_mode_foreach_cb cb, void *data);
 855
 856 nir_op vtn_nir_alu_op_for_spirv_opcode(struct vtn_builder *b,
 857                                        SpvOp opcode, bool *swap,
 858                                        unsigned src_bit_size, unsigned dst_bit_size);
 859
 860 void vtn_handle_alu(struct vtn_builder *b, SpvOp opcode,
 861                     const uint32_t *w, unsigned count);
 862
 863 void vtn_handle_bitcast(struct vtn_builder *b, const uint32_t *w,
 864                         unsigned count);
 865
 866 void vtn_handle_subgroup(struct vtn_builder *b, SpvOp opcode,
 867                          const uint32_t *w, unsigned count);
 868
 869 bool vtn_handle_glsl450_instruction(struct vtn_builder *b, SpvOp ext_opcode,
 870                                     const uint32_t *words, unsigned count);
 871
 872 bool vtn_handle_opencl_instruction(struct vtn_builder *b, SpvOp ext_opcode,
 873                                    const uint32_t *words, unsigned count);
 874
 875 struct vtn_builder* vtn_create_builder(const uint32_t *words, size_t word_count,
 876                                        gl_shader_stage stage, const char *entry_point_name,
 877                                        const struct spirv_to_nir_options *options);
 878
 879 void vtn_handle_entry_point(struct vtn_builder *b, const uint32_t *w,
 880                             unsigned count);
 881
 882 void vtn_handle_decoration(struct vtn_builder *b, SpvOp opcode,
 883                            const uint32_t *w, unsigned count);
 884
 885 enum vtn_variable_mode vtn_storage_class_to_mode(struct vtn_builder *b,
 886                                                  SpvStorageClass class,
 887                                                  struct vtn_type *interface_type,
 888                                                  nir_variable_mode *nir_mode_out);
 889
 890 nir_address_format vtn_mode_to_address_format(struct vtn_builder *b,
 891                                               enum vtn_variable_mode);
 892
 893 static inline uint32_t
 894 vtn_align_u32(uint32_t v, uint32_t a)
 895 {
 896    assert(a != 0 && a == (a & -((int32_t) a)));
 897    return (v + a - 1) & ~(a - 1);
 898 }
 899
 900 static inline uint64_t
 901 vtn_u64_literal(const uint32_t *w)
 902 {
 903    return (uint64_t)w[1] << 32 | w[0];
 904 }
 905
 906 bool vtn_handle_amd_gcn_shader_instruction(struct vtn_builder *b, SpvOp ext_opcode,
 907                                            const uint32_t *words, unsigned count);
 908
 909 bool vtn_handle_amd_shader_ballot_instruction(struct vtn_builder *b, SpvOp ext_opcode,
 910                                               const uint32_t *w, unsigned count);
 911
 912 bool vtn_handle_amd_shader_trinary_minmax_instruction(struct vtn_builder *b, SpvOp ext_opcode,
 913                                                       const uint32_t *words, unsigned count);
 914
 915 bool vtn_handle_amd_shader_explicit_vertex_parameter_instruction(struct vtn_builder *b,
 916                                                                  SpvOp ext_opcode,
 917                                                                  const uint32_t *words,
 918                                                                  unsigned count);
 919
 920 SpvMemorySemanticsMask vtn_storage_class_to_memory_semantics(SpvStorageClass sc);
 921
 922 void vtn_emit_memory_barrier(struct vtn_builder *b, SpvScope scope,
 923                              SpvMemorySemanticsMask semantics);
 924
 925 #endif /* _VTN_PRIVATE_H_ */