2 * Copyright © 2015 Intel Corporation
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:
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
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
24 * Jason Ekstrand (jason@jlekstrand.net)
28 #ifndef _VTN_PRIVATE_H_
29 #define _VTN_PRIVATE_H_
32 #include "nir/nir_builder.h"
33 #include "util/u_dynarray.h"
34 #include "nir_spirv.h"
38 struct vtn_decoration
;
41 vtn_value_type_invalid
= 0,
43 vtn_value_type_string
,
44 vtn_value_type_decoration_group
,
46 vtn_value_type_constant
,
47 vtn_value_type_pointer
,
48 vtn_value_type_function
,
51 vtn_value_type_extension
,
52 vtn_value_type_image_pointer
,
53 vtn_value_type_sampled_image
,
56 enum vtn_branch_type
{
58 vtn_branch_type_switch_break
,
59 vtn_branch_type_switch_fallthrough
,
60 vtn_branch_type_loop_break
,
61 vtn_branch_type_loop_continue
,
62 vtn_branch_type_discard
,
63 vtn_branch_type_return
,
66 enum vtn_cf_node_type
{
67 vtn_cf_node_type_block
,
69 vtn_cf_node_type_loop
,
70 vtn_cf_node_type_switch
,
74 struct list_head link
;
75 enum vtn_cf_node_type type
;
79 struct vtn_cf_node node
;
81 /* The main body of the loop */
82 struct list_head body
;
84 /* The "continue" part of the loop. This gets executed after the body
85 * and is where you go when you hit a continue.
87 struct list_head cont_body
;
89 SpvLoopControlMask control
;
93 struct vtn_cf_node node
;
97 enum vtn_branch_type then_type
;
98 struct list_head then_body
;
100 enum vtn_branch_type else_type
;
101 struct list_head else_body
;
103 SpvSelectionControlMask control
;
107 struct list_head link
;
109 struct list_head body
;
111 /* The block that starts this case */
112 struct vtn_block
*start_block
;
114 /* The fallthrough case, if any */
115 struct vtn_case
*fallthrough
;
117 /* The uint32_t values that map to this case */
118 struct util_dynarray values
;
120 /* True if this is the default case */
123 /* Initialized to false; used when sorting the list of cases */
128 struct vtn_cf_node node
;
132 struct list_head cases
;
136 struct vtn_cf_node node
;
138 /** A pointer to the label instruction */
139 const uint32_t *label
;
141 /** A pointer to the merge instruction (or NULL if non exists) */
142 const uint32_t *merge
;
144 /** A pointer to the branch instruction that ends this block */
145 const uint32_t *branch
;
147 enum vtn_branch_type branch_type
;
149 /** Points to the loop that this block starts (if it starts a loop) */
150 struct vtn_loop
*loop
;
152 /** Points to the switch case started by this block (if any) */
153 struct vtn_case
*switch_case
;
155 /** Every block ends in a nop intrinsic so that we can find it again */
156 nir_intrinsic_instr
*end_nop
;
159 struct vtn_function
{
160 struct exec_node node
;
162 nir_function_impl
*impl
;
163 struct vtn_block
*start_block
;
165 struct list_head body
;
169 SpvFunctionControlMask control
;
172 typedef bool (*vtn_instruction_handler
)(struct vtn_builder
*, uint32_t,
173 const uint32_t *, unsigned);
175 void vtn_build_cfg(struct vtn_builder
*b
, const uint32_t *words
,
176 const uint32_t *end
);
177 void vtn_function_emit(struct vtn_builder
*b
, struct vtn_function
*func
,
178 vtn_instruction_handler instruction_handler
);
181 vtn_foreach_instruction(struct vtn_builder
*b
, const uint32_t *start
,
182 const uint32_t *end
, vtn_instruction_handler handler
);
184 struct vtn_ssa_value
{
187 struct vtn_ssa_value
**elems
;
190 /* For matrices, if this is non-NULL, then this value is actually the
191 * transpose of some other value. The value that `transposed` points to
192 * always dominates this value.
194 struct vtn_ssa_value
*transposed
;
196 const struct glsl_type
*type
;
201 vtn_base_type_scalar
,
202 vtn_base_type_vector
,
203 vtn_base_type_matrix
,
205 vtn_base_type_struct
,
206 vtn_base_type_pointer
,
208 vtn_base_type_sampler
,
209 vtn_base_type_function
,
213 enum vtn_base_type base_type
;
215 const struct glsl_type
*type
;
217 /* The value that declares this type. Used for finding decorations */
218 struct vtn_value
*val
;
220 /* Specifies the length of complex types. */
223 /* for arrays, matrices and pointers, the array stride */
227 /* Members for scalar, vector, and array-like types */
229 /* for arrays, the vtn_type for the elements of the array */
230 struct vtn_type
*array_element
;
232 /* for matrices, whether the matrix is stored row-major */
235 /* Whether this type, or a parent type, has been decorated as a
240 /* Which built-in to use */
244 /* Members for struct types */
246 /* for structures, the vtn_type for each member */
247 struct vtn_type
**members
;
249 /* for structs, the offset of each member */
252 /* for structs, whether it was decorated as a "non-SSBO-like" block */
255 /* for structs, whether it was decorated as an "SSBO-like" block */
258 /* for structs with block == true, whether this is a builtin block
259 * (i.e. a block that contains only builtins).
261 bool builtin_block
:1;
264 /* Members for pointer types */
266 /* For pointers, the vtn_type for dereferenced type */
267 struct vtn_type
*deref
;
269 /* Storage class for pointers */
270 SpvStorageClass storage_class
;
273 /* Members for image types */
275 /* For images, indicates whether it's sampled or storage */
278 /* Image format for image_load_store type images */
279 unsigned image_format
;
281 /* Access qualifier for storage images */
282 SpvAccessQualifier access_qualifier
;
285 /* Members for function types */
287 /* For functions, the vtn_type for each parameter */
288 struct vtn_type
**params
;
290 /* Return type for functions */
291 struct vtn_type
*return_type
;
298 enum vtn_access_mode
{
300 vtn_access_mode_literal
,
303 struct vtn_access_link
{
304 enum vtn_access_mode mode
;
308 struct vtn_access_chain
{
311 /** Whether or not to treat the base pointer as an array. This is only
312 * true if this access chain came from an OpPtrAccessChain.
316 /** Struct elements and array offsets.
318 * This is an array of 1 so that it can conveniently be created on the
319 * stack but the real length is given by the length field.
321 struct vtn_access_link link
[1];
324 enum vtn_variable_mode
{
325 vtn_variable_mode_local
,
326 vtn_variable_mode_global
,
327 vtn_variable_mode_param
,
328 vtn_variable_mode_ubo
,
329 vtn_variable_mode_ssbo
,
330 vtn_variable_mode_push_constant
,
331 vtn_variable_mode_image
,
332 vtn_variable_mode_sampler
,
333 vtn_variable_mode_workgroup
,
334 vtn_variable_mode_input
,
335 vtn_variable_mode_output
,
339 /** The variable mode for the referenced data */
340 enum vtn_variable_mode mode
;
342 /** The dereferenced type of this pointer */
343 struct vtn_type
*type
;
345 /** The pointer type of this pointer
347 * This may be NULL for some temporary pointers constructed as part of a
348 * large load, store, or copy. It MUST be valid for all pointers which are
349 * stored as SPIR-V SSA values.
351 struct vtn_type
*ptr_type
;
353 /** The referenced variable, if known
355 * This field may be NULL if the pointer uses a (block_index, offset) pair
356 * instead of an access chain.
358 struct vtn_variable
*var
;
360 /** An access chain describing how to get from var to the referenced data
362 * This field may be NULL if the pointer references the entire variable or
363 * if a (block_index, offset) pair is used instead of an access chain.
365 struct vtn_access_chain
*chain
;
367 /** A (block_index, offset) pair representing a UBO or SSBO position. */
368 struct nir_ssa_def
*block_index
;
369 struct nir_ssa_def
*offset
;
373 vtn_pointer_uses_ssa_offset(struct vtn_pointer
*ptr
)
375 return ptr
->mode
== vtn_variable_mode_ubo
||
376 ptr
->mode
== vtn_variable_mode_ssbo
;
379 struct vtn_variable
{
380 enum vtn_variable_mode mode
;
382 struct vtn_type
*type
;
384 unsigned descriptor_set
;
386 unsigned input_attachment_index
;
390 nir_variable
**members
;
393 * In some early released versions of GLSLang, it implemented all function
394 * calls by making copies of all parameters into temporary variables and
395 * passing those variables into the function. It even did so for samplers
396 * and images which violates the SPIR-V spec. Unfortunately, two games
397 * (Talos Principle and Doom) shipped with this old version of GLSLang and
398 * also happen to pass samplers into functions. Talos Principle received
399 * an update fairly shortly after release with an updated GLSLang. Doom,
400 * on the other hand, has never received an update so we need to work
401 * around this GLSLang issue in SPIR-V -> NIR. Hopefully, we can drop this
402 * hack at some point in the future.
404 struct vtn_pointer
*copy_prop_sampler
;
407 struct vtn_image_pointer
{
408 struct vtn_pointer
*image
;
413 struct vtn_sampled_image
{
414 struct vtn_pointer
*image
; /* Image or array of images */
415 struct vtn_pointer
*sampler
; /* Sampler */
419 enum vtn_value_type value_type
;
421 struct vtn_decoration
*decoration
;
425 struct vtn_type
*type
;
427 nir_constant
*constant
;
428 const struct glsl_type
*const_type
;
430 struct vtn_pointer
*pointer
;
431 struct vtn_image_pointer
*image
;
432 struct vtn_sampled_image
*sampled_image
;
433 struct vtn_function
*func
;
434 struct vtn_block
*block
;
435 struct vtn_ssa_value
*ssa
;
436 vtn_instruction_handler ext_handler
;
440 #define VTN_DEC_DECORATION -1
441 #define VTN_DEC_EXECUTION_MODE -2
442 #define VTN_DEC_STRUCT_MEMBER0 0
444 struct vtn_decoration
{
445 struct vtn_decoration
*next
;
447 /* Specifies how to apply this decoration. Negative values represent a
448 * decoration or execution mode. (See the VTN_DEC_ #defines above.)
449 * Non-negative values specify that it applies to a structure member.
453 const uint32_t *literals
;
454 struct vtn_value
*group
;
457 SpvDecoration decoration
;
458 SpvExecutionMode exec_mode
;
466 nir_function_impl
*impl
;
467 const struct nir_spirv_supported_extensions
*ext
;
468 struct vtn_block
*block
;
470 /* Current file, line, and column. Useful for debugging. Set
471 * automatically by vtn_foreach_instruction.
477 * In SPIR-V, constants are global, whereas in NIR, the load_const
478 * instruction we use is per-function. So while we parse each function, we
479 * keep a hash table of constants we've resolved to nir_ssa_value's so
480 * far, and we lazily resolve them when we see them used in a function.
482 struct hash_table
*const_table
;
485 * Map from phi instructions (pointer to the start of the instruction)
486 * to the variable corresponding to it.
488 struct hash_table
*phi_table
;
490 unsigned num_specializations
;
491 struct nir_spirv_specialization
*specializations
;
493 unsigned value_id_bound
;
494 struct vtn_value
*values
;
496 gl_shader_stage entry_point_stage
;
497 const char *entry_point_name
;
498 struct vtn_value
*entry_point
;
499 bool origin_upper_left
;
500 bool pixel_center_integer
;
502 struct vtn_function
*func
;
503 struct exec_list functions
;
505 /* Current function parameter index */
506 unsigned func_param_idx
;
508 bool has_loop_continue
;
512 vtn_pointer_to_ssa(struct vtn_builder
*b
, struct vtn_pointer
*ptr
);
514 vtn_pointer_from_ssa(struct vtn_builder
*b
, nir_ssa_def
*ssa
,
515 struct vtn_type
*ptr_type
);
517 static inline struct vtn_value
*
518 vtn_push_value(struct vtn_builder
*b
, uint32_t value_id
,
519 enum vtn_value_type value_type
)
521 assert(value_id
< b
->value_id_bound
);
522 assert(b
->values
[value_id
].value_type
== vtn_value_type_invalid
);
524 b
->values
[value_id
].value_type
= value_type
;
526 return &b
->values
[value_id
];
529 static inline struct vtn_value
*
530 vtn_push_ssa(struct vtn_builder
*b
, uint32_t value_id
,
531 struct vtn_type
*type
, struct vtn_ssa_value
*ssa
)
533 struct vtn_value
*val
;
534 if (type
->base_type
== vtn_base_type_pointer
) {
535 val
= vtn_push_value(b
, value_id
, vtn_value_type_pointer
);
536 val
->pointer
= vtn_pointer_from_ssa(b
, ssa
->def
, type
);
538 val
= vtn_push_value(b
, value_id
, vtn_value_type_ssa
);
544 static inline struct vtn_value
*
545 vtn_untyped_value(struct vtn_builder
*b
, uint32_t value_id
)
547 assert(value_id
< b
->value_id_bound
);
548 return &b
->values
[value_id
];
551 static inline struct vtn_value
*
552 vtn_value(struct vtn_builder
*b
, uint32_t value_id
,
553 enum vtn_value_type value_type
)
555 struct vtn_value
*val
= vtn_untyped_value(b
, value_id
);
556 assert(val
->value_type
== value_type
);
560 void _vtn_warn(const char *file
, int line
, const char *msg
, ...);
561 #define vtn_warn(...) _vtn_warn(__FILE__, __LINE__, __VA_ARGS__)
563 struct vtn_ssa_value
*vtn_ssa_value(struct vtn_builder
*b
, uint32_t value_id
);
565 struct vtn_ssa_value
*vtn_create_ssa_value(struct vtn_builder
*b
,
566 const struct glsl_type
*type
);
568 struct vtn_ssa_value
*vtn_ssa_transpose(struct vtn_builder
*b
,
569 struct vtn_ssa_value
*src
);
571 nir_ssa_def
*vtn_vector_extract(struct vtn_builder
*b
, nir_ssa_def
*src
,
573 nir_ssa_def
*vtn_vector_extract_dynamic(struct vtn_builder
*b
, nir_ssa_def
*src
,
575 nir_ssa_def
*vtn_vector_insert(struct vtn_builder
*b
, nir_ssa_def
*src
,
576 nir_ssa_def
*insert
, unsigned index
);
577 nir_ssa_def
*vtn_vector_insert_dynamic(struct vtn_builder
*b
, nir_ssa_def
*src
,
578 nir_ssa_def
*insert
, nir_ssa_def
*index
);
580 nir_deref_var
*vtn_nir_deref(struct vtn_builder
*b
, uint32_t id
);
582 struct vtn_pointer
*vtn_pointer_for_variable(struct vtn_builder
*b
,
583 struct vtn_variable
*var
,
584 struct vtn_type
*ptr_type
);
586 nir_deref_var
*vtn_pointer_to_deref(struct vtn_builder
*b
,
587 struct vtn_pointer
*ptr
);
589 vtn_pointer_to_offset(struct vtn_builder
*b
, struct vtn_pointer
*ptr
,
590 nir_ssa_def
**index_out
, unsigned *end_idx_out
);
592 struct vtn_ssa_value
*vtn_local_load(struct vtn_builder
*b
, nir_deref_var
*src
);
594 void vtn_local_store(struct vtn_builder
*b
, struct vtn_ssa_value
*src
,
595 nir_deref_var
*dest
);
597 struct vtn_ssa_value
*
598 vtn_variable_load(struct vtn_builder
*b
, struct vtn_pointer
*src
);
600 void vtn_variable_store(struct vtn_builder
*b
, struct vtn_ssa_value
*src
,
601 struct vtn_pointer
*dest
);
603 void vtn_handle_variables(struct vtn_builder
*b
, SpvOp opcode
,
604 const uint32_t *w
, unsigned count
);
607 typedef void (*vtn_decoration_foreach_cb
)(struct vtn_builder
*,
610 const struct vtn_decoration
*,
613 void vtn_foreach_decoration(struct vtn_builder
*b
, struct vtn_value
*value
,
614 vtn_decoration_foreach_cb cb
, void *data
);
616 typedef void (*vtn_execution_mode_foreach_cb
)(struct vtn_builder
*,
618 const struct vtn_decoration
*,
621 void vtn_foreach_execution_mode(struct vtn_builder
*b
, struct vtn_value
*value
,
622 vtn_execution_mode_foreach_cb cb
, void *data
);
624 nir_op
vtn_nir_alu_op_for_spirv_opcode(SpvOp opcode
, bool *swap
,
625 nir_alu_type src
, nir_alu_type dst
);
627 void vtn_handle_alu(struct vtn_builder
*b
, SpvOp opcode
,
628 const uint32_t *w
, unsigned count
);
630 bool vtn_handle_glsl450_instruction(struct vtn_builder
*b
, uint32_t ext_opcode
,
631 const uint32_t *words
, unsigned count
);
633 static inline uint64_t
634 vtn_u64_literal(const uint32_t *w
)
636 return (uint64_t)w
[1] << 32 | w
[0];
639 #endif /* _VTN_PRIVATE_H_ */