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