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