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