2 * Copyright © 2014 Connor Abbott
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 * Connor Abbott (cwabbott0@gmail.com)
30 #include "util/hash_table.h"
32 #include "GL/gl.h" /* GLenum */
33 #include "util/list.h"
34 #include "util/ralloc.h"
36 #include "util/bitset.h"
37 #include "nir_types.h"
38 #include "shader_enums.h"
41 #include "nir_opcodes.h"
48 struct gl_shader_program
;
51 #define NIR_TRUE (~0u)
53 /** Defines a cast function
55 * This macro defines a cast function from in_type to out_type where
56 * out_type is some structure type that contains a field of type out_type.
58 * Note that you have to be a bit careful as the generated cast function
61 #define NIR_DEFINE_CAST(name, in_type, out_type, field) \
62 static inline out_type * \
63 name(const in_type *parent) \
65 return exec_node_data(out_type, parent, field); \
74 * Description of built-in state associated with a uniform
76 * \sa nir_variable::state_slots
90 nir_var_shader_storage
,
95 * Data stored in an nir_constant
97 union nir_constant_data
{
104 typedef struct nir_constant
{
106 * Value of the constant.
108 * The field used to back the values supplied by the constant is determined
109 * by the type associated with the \c nir_variable. Constants may be
110 * scalars, vectors, or matrices.
112 union nir_constant_data value
;
114 /* we could get this from the var->type but makes clone *much* easier to
115 * not have to care about the type.
117 unsigned num_elements
;
119 /* Array elements / Structure Fields */
120 struct nir_constant
**elements
;
124 * \brief Layout qualifiers for gl_FragDepth.
126 * The AMD/ARB_conservative_depth extensions allow gl_FragDepth to be redeclared
127 * with a layout qualifier.
130 nir_depth_layout_none
, /**< No depth layout is specified. */
131 nir_depth_layout_any
,
132 nir_depth_layout_greater
,
133 nir_depth_layout_less
,
134 nir_depth_layout_unchanged
138 * Either a uniform, global variable, shader input, or shader output. Based on
139 * ir_variable - it should be easy to translate between the two.
143 struct exec_node node
;
146 * Declared type of the variable
148 const struct glsl_type
*type
;
151 * Declared name of the variable
155 struct nir_variable_data
{
158 * Is the variable read-only?
160 * This is set for variables declared as \c const, shader inputs,
163 unsigned read_only
:1;
167 unsigned invariant
:1;
170 * Storage class of the variable.
172 * \sa nir_variable_mode
174 nir_variable_mode mode
:4;
177 * Interpolation mode for shader inputs / outputs
179 * \sa glsl_interp_qualifier
181 unsigned interpolation
:2;
184 * \name ARB_fragment_coord_conventions
187 unsigned origin_upper_left
:1;
188 unsigned pixel_center_integer
:1;
192 * Was the location explicitly set in the shader?
194 * If the location is explicitly set in the shader, it \b cannot be changed
195 * by the linker or by the API (e.g., calls to \c glBindAttribLocation have
198 unsigned explicit_location
:1;
199 unsigned explicit_index
:1;
202 * Was an initial binding explicitly set in the shader?
204 * If so, constant_initializer contains an integer nir_constant
205 * representing the initial binding point.
207 unsigned explicit_binding
:1;
210 * Does this variable have an initializer?
212 * This is used by the linker to cross-validiate initializers of global
215 unsigned has_initializer
:1;
218 * If non-zero, then this variable may be packed along with other variables
219 * into a single varying slot, so this offset should be applied when
220 * accessing components. For example, an offset of 1 means that the x
221 * component of this variable is actually stored in component y of the
222 * location specified by \c location.
224 unsigned location_frac
:2;
227 * Non-zero if this variable was created by lowering a named interface
228 * block which was not an array.
230 * Note that this variable and \c from_named_ifc_block_array will never
233 unsigned from_named_ifc_block_nonarray
:1;
236 * Non-zero if this variable was created by lowering a named interface
237 * block which was an array.
239 * Note that this variable and \c from_named_ifc_block_nonarray will never
242 unsigned from_named_ifc_block_array
:1;
245 * \brief Layout qualifier for gl_FragDepth.
247 * This is not equal to \c ir_depth_layout_none if and only if this
248 * variable is \c gl_FragDepth and a layout qualifier is specified.
250 nir_depth_layout depth_layout
;
253 * Storage location of the base of this variable
255 * The precise meaning of this field depends on the nature of the variable.
257 * - Vertex shader input: one of the values from \c gl_vert_attrib.
258 * - Vertex shader output: one of the values from \c gl_varying_slot.
259 * - Geometry shader input: one of the values from \c gl_varying_slot.
260 * - Geometry shader output: one of the values from \c gl_varying_slot.
261 * - Fragment shader input: one of the values from \c gl_varying_slot.
262 * - Fragment shader output: one of the values from \c gl_frag_result.
263 * - Uniforms: Per-stage uniform slot number for default uniform block.
264 * - Uniforms: Index within the uniform block definition for UBO members.
265 * - Non-UBO Uniforms: uniform slot number.
266 * - Other: This field is not currently used.
268 * If the variable is a uniform, shader input, or shader output, and the
269 * slot has not been assigned, the value will be -1.
274 * The actual location of the variable in the IR. Only valid for inputs
277 unsigned int driver_location
;
280 * output index for dual source blending.
285 * Initial binding point for a sampler or UBO.
287 * For array types, this represents the binding point for the first element.
292 * Location an atomic counter is stored at.
299 * ARB_shader_image_load_store qualifiers.
302 bool read_only
; /**< "readonly" qualifier. */
303 bool write_only
; /**< "writeonly" qualifier. */
308 /** Image internal format if specified explicitly, otherwise GL_NONE. */
313 * Highest element accessed with a constant expression array index
315 * Not used for non-array variables.
317 unsigned max_array_access
;
322 * Built-in state that backs this uniform
324 * Once set at variable creation, \c state_slots must remain invariant.
325 * This is because, ideally, this array would be shared by all clones of
326 * this variable in the IR tree. In other words, we'd really like for it
327 * to be a fly-weight.
329 * If the variable is not a uniform, \c num_state_slots will be zero and
330 * \c state_slots will be \c NULL.
333 unsigned num_state_slots
; /**< Number of state slots used */
334 nir_state_slot
*state_slots
; /**< State descriptors. */
338 * Constant expression assigned in the initializer of the variable
340 nir_constant
*constant_initializer
;
343 * For variables that are in an interface block or are an instance of an
344 * interface block, this is the \c GLSL_TYPE_INTERFACE type for that block.
346 * \sa ir_variable::location
348 const struct glsl_type
*interface_type
;
351 #define nir_foreach_variable(var, var_list) \
352 foreach_list_typed(nir_variable, var, node, var_list)
355 struct exec_node node
;
357 unsigned num_components
; /** < number of vector components */
358 unsigned num_array_elems
; /** < size of array (0 for no array) */
360 /** generic register index. */
363 /** only for debug purposes, can be NULL */
366 /** whether this register is local (per-function) or global (per-shader) */
370 * If this flag is set to true, then accessing channels >= num_components
371 * is well-defined, and simply spills over to the next array element. This
372 * is useful for backends that can do per-component accessing, in
373 * particular scalar backends. By setting this flag and making
374 * num_components equal to 1, structures can be packed tightly into
375 * registers and then registers can be accessed per-component to get to
376 * each structure member, even if it crosses vec4 boundaries.
380 /** set of nir_src's where this register is used (read from) */
381 struct list_head uses
;
383 /** set of nir_dest's where this register is defined (written to) */
384 struct list_head defs
;
386 /** set of nir_if's where this register is used as a condition */
387 struct list_head if_uses
;
394 nir_instr_type_intrinsic
,
395 nir_instr_type_load_const
,
397 nir_instr_type_ssa_undef
,
399 nir_instr_type_parallel_copy
,
402 typedef struct nir_instr
{
403 struct exec_node node
;
405 struct nir_block
*block
;
407 /** generic instruction index. */
410 /* A temporary for optimization and analysis passes to use for storing
411 * flags. For instance, DCE uses this to store the "dead/live" info.
416 static inline nir_instr
*
417 nir_instr_next(nir_instr
*instr
)
419 struct exec_node
*next
= exec_node_get_next(&instr
->node
);
420 if (exec_node_is_tail_sentinel(next
))
423 return exec_node_data(nir_instr
, next
, node
);
426 static inline nir_instr
*
427 nir_instr_prev(nir_instr
*instr
)
429 struct exec_node
*prev
= exec_node_get_prev(&instr
->node
);
430 if (exec_node_is_head_sentinel(prev
))
433 return exec_node_data(nir_instr
, prev
, node
);
437 nir_instr_is_first(nir_instr
*instr
)
439 return exec_node_is_head_sentinel(exec_node_get_prev(&instr
->node
));
443 nir_instr_is_last(nir_instr
*instr
)
445 return exec_node_is_tail_sentinel(exec_node_get_next(&instr
->node
));
449 /** for debugging only, can be NULL */
452 /** generic SSA definition index. */
455 /** Index into the live_in and live_out bitfields */
458 nir_instr
*parent_instr
;
460 /** set of nir_instr's where this register is used (read from) */
461 struct list_head uses
;
463 /** set of nir_if's where this register is used as a condition */
464 struct list_head if_uses
;
466 uint8_t num_components
;
473 struct nir_src
*indirect
; /** < NULL for no indirect offset */
474 unsigned base_offset
;
476 /* TODO use-def chain goes here */
480 nir_instr
*parent_instr
;
481 struct list_head def_link
;
484 struct nir_src
*indirect
; /** < NULL for no indirect offset */
485 unsigned base_offset
;
487 /* TODO def-use chain goes here */
492 typedef struct nir_src
{
494 nir_instr
*parent_instr
;
495 struct nir_if
*parent_if
;
498 struct list_head use_link
;
508 #define NIR_SRC_INIT (nir_src) { { NULL } }
510 #define nir_foreach_use(reg_or_ssa_def, src) \
511 list_for_each_entry(nir_src, src, &(reg_or_ssa_def)->uses, use_link)
513 #define nir_foreach_use_safe(reg_or_ssa_def, src) \
514 list_for_each_entry_safe(nir_src, src, &(reg_or_ssa_def)->uses, use_link)
516 #define nir_foreach_if_use(reg_or_ssa_def, src) \
517 list_for_each_entry(nir_src, src, &(reg_or_ssa_def)->if_uses, use_link)
519 #define nir_foreach_if_use_safe(reg_or_ssa_def, src) \
520 list_for_each_entry_safe(nir_src, src, &(reg_or_ssa_def)->if_uses, use_link)
531 #define NIR_DEST_INIT (nir_dest) { { { NULL } } }
533 #define nir_foreach_def(reg, dest) \
534 list_for_each_entry(nir_dest, dest, &(reg)->defs, reg.def_link)
536 #define nir_foreach_def_safe(reg, dest) \
537 list_for_each_entry_safe(nir_dest, dest, &(reg)->defs, reg.def_link)
539 static inline nir_src
540 nir_src_for_ssa(nir_ssa_def
*def
)
542 nir_src src
= NIR_SRC_INIT
;
550 static inline nir_src
551 nir_src_for_reg(nir_register
*reg
)
553 nir_src src
= NIR_SRC_INIT
;
557 src
.reg
.indirect
= NULL
;
558 src
.reg
.base_offset
= 0;
563 static inline nir_dest
564 nir_dest_for_reg(nir_register
*reg
)
566 nir_dest dest
= NIR_DEST_INIT
;
573 void nir_src_copy(nir_src
*dest
, const nir_src
*src
, void *instr_or_if
);
574 void nir_dest_copy(nir_dest
*dest
, const nir_dest
*src
, nir_instr
*instr
);
580 * \name input modifiers
584 * For inputs interpreted as floating point, flips the sign bit. For
585 * inputs interpreted as integers, performs the two's complement negation.
590 * Clears the sign bit for floating point values, and computes the integer
591 * absolute value for integers. Note that the negate modifier acts after
592 * the absolute value modifier, therefore if both are set then all inputs
593 * will become negative.
599 * For each input component, says which component of the register it is
600 * chosen from. Note that which elements of the swizzle are used and which
601 * are ignored are based on the write mask for most opcodes - for example,
602 * a statement like "foo.xzw = bar.zyx" would have a writemask of 1101b and
603 * a swizzle of {2, x, 1, 0} where x means "don't care."
612 * \name saturate output modifier
614 * Only valid for opcodes that output floating-point numbers. Clamps the
615 * output to between 0.0 and 1.0 inclusive.
620 unsigned write_mask
: 4; /* ignored if dest.is_ssa is true */
624 nir_type_invalid
= 0, /* Not a valid type */
632 NIR_OP_IS_COMMUTATIVE
= (1 << 0),
633 NIR_OP_IS_ASSOCIATIVE
= (1 << 1),
634 } nir_op_algebraic_property
;
642 * The number of components in the output
644 * If non-zero, this is the size of the output and input sizes are
645 * explicitly given; swizzle and writemask are still in effect, but if
646 * the output component is masked out, then the input component may
649 * If zero, the opcode acts in the standard, per-component manner; the
650 * operation is performed on each component (except the ones that are
651 * masked out) with the input being taken from the input swizzle for
654 * The size of some of the inputs may be given (i.e. non-zero) even
655 * though output_size is zero; in that case, the inputs with a zero
656 * size act per-component, while the inputs with non-zero size don't.
658 unsigned output_size
;
661 * The type of vector that the instruction outputs. Note that the
662 * staurate modifier is only allowed on outputs with the float type.
665 nir_alu_type output_type
;
668 * The number of components in each input
670 unsigned input_sizes
[4];
673 * The type of vector that each input takes. Note that negate and
674 * absolute value are only allowed on inputs with int or float type and
675 * behave differently on the two.
677 nir_alu_type input_types
[4];
679 nir_op_algebraic_property algebraic_properties
;
682 extern const nir_op_info nir_op_infos
[nir_num_opcodes
];
684 typedef struct nir_alu_instr
{
691 void nir_alu_src_copy(nir_alu_src
*dest
, const nir_alu_src
*src
,
692 nir_alu_instr
*instr
);
693 void nir_alu_dest_copy(nir_alu_dest
*dest
, const nir_alu_dest
*src
,
694 nir_alu_instr
*instr
);
696 /* is this source channel used? */
698 nir_alu_instr_channel_used(nir_alu_instr
*instr
, unsigned src
, unsigned channel
)
700 if (nir_op_infos
[instr
->op
].input_sizes
[src
] > 0)
701 return channel
< nir_op_infos
[instr
->op
].input_sizes
[src
];
703 return (instr
->dest
.write_mask
>> channel
) & 1;
707 * For instructions whose destinations are SSA, get the number of channels
710 static inline unsigned
711 nir_ssa_alu_instr_src_components(const nir_alu_instr
*instr
, unsigned src
)
713 assert(instr
->dest
.dest
.is_ssa
);
715 if (nir_op_infos
[instr
->op
].input_sizes
[src
] > 0)
716 return nir_op_infos
[instr
->op
].input_sizes
[src
];
718 return instr
->dest
.dest
.ssa
.num_components
;
723 nir_deref_type_array
,
724 nir_deref_type_struct
727 typedef struct nir_deref
{
728 nir_deref_type deref_type
;
729 struct nir_deref
*child
;
730 const struct glsl_type
*type
;
739 /* This enum describes how the array is referenced. If the deref is
740 * direct then the base_offset is used. If the deref is indirect then then
741 * offset is given by base_offset + indirect. If the deref is a wildcard
742 * then the deref refers to all of the elements of the array at the same
743 * time. Wildcard dereferences are only ever allowed in copy_var
744 * intrinsics and the source and destination derefs must have matching
748 nir_deref_array_type_direct
,
749 nir_deref_array_type_indirect
,
750 nir_deref_array_type_wildcard
,
751 } nir_deref_array_type
;
756 nir_deref_array_type deref_array_type
;
757 unsigned base_offset
;
767 NIR_DEFINE_CAST(nir_deref_as_var
, nir_deref
, nir_deref_var
, deref
)
768 NIR_DEFINE_CAST(nir_deref_as_array
, nir_deref
, nir_deref_array
, deref
)
769 NIR_DEFINE_CAST(nir_deref_as_struct
, nir_deref
, nir_deref_struct
, deref
)
771 /* Returns the last deref in the chain. */
772 static inline nir_deref
*
773 nir_deref_tail(nir_deref
*deref
)
776 deref
= deref
->child
;
784 nir_deref_var
**params
;
785 nir_deref_var
*return_deref
;
787 struct nir_function
*callee
;
790 #define INTRINSIC(name, num_srcs, src_components, has_dest, dest_components, \
791 num_variables, num_indices, flags) \
792 nir_intrinsic_##name,
794 #define LAST_INTRINSIC(name) nir_last_intrinsic = nir_intrinsic_##name,
797 #include "nir_intrinsics.h"
798 nir_num_intrinsics
= nir_last_intrinsic
+ 1
802 #undef LAST_INTRINSIC
804 /** Represents an intrinsic
806 * An intrinsic is an instruction type for handling things that are
807 * more-or-less regular operations but don't just consume and produce SSA
808 * values like ALU operations do. Intrinsics are not for things that have
809 * special semantic meaning such as phi nodes and parallel copies.
810 * Examples of intrinsics include variable load/store operations, system
811 * value loads, and the like. Even though texturing more-or-less falls
812 * under this category, texturing is its own instruction type because
813 * trying to represent texturing with intrinsics would lead to a
814 * combinatorial explosion of intrinsic opcodes.
816 * By having a single instruction type for handling a lot of different
817 * cases, optimization passes can look for intrinsics and, for the most
818 * part, completely ignore them. Each intrinsic type also has a few
819 * possible flags that govern whether or not they can be reordered or
820 * eliminated. That way passes like dead code elimination can still work
821 * on intrisics without understanding the meaning of each.
823 * Each intrinsic has some number of constant indices, some number of
824 * variables, and some number of sources. What these sources, variables,
825 * and indices mean depends on the intrinsic and is documented with the
826 * intrinsic declaration in nir_intrinsics.h. Intrinsics and texture
827 * instructions are the only types of instruction that can operate on
833 nir_intrinsic_op intrinsic
;
837 /** number of components if this is a vectorized intrinsic
839 * Similarly to ALU operations, some intrinsics are vectorized.
840 * An intrinsic is vectorized if nir_intrinsic_infos.dest_components == 0.
841 * For vectorized intrinsics, the num_components field specifies the
842 * number of destination components and the number of source components
843 * for all sources with nir_intrinsic_infos.src_components[i] == 0.
845 uint8_t num_components
;
849 nir_deref_var
*variables
[2];
852 } nir_intrinsic_instr
;
855 * \name NIR intrinsics semantic flags
857 * information about what the compiler can do with the intrinsics.
859 * \sa nir_intrinsic_info::flags
863 * whether the intrinsic can be safely eliminated if none of its output
864 * value is not being used.
866 NIR_INTRINSIC_CAN_ELIMINATE
= (1 << 0),
869 * Whether the intrinsic can be reordered with respect to any other
870 * intrinsic, i.e. whether the only reordering dependencies of the
871 * intrinsic are due to the register reads/writes.
873 NIR_INTRINSIC_CAN_REORDER
= (1 << 1),
874 } nir_intrinsic_semantic_flag
;
876 #define NIR_INTRINSIC_MAX_INPUTS 4
881 unsigned num_srcs
; /** < number of register/SSA inputs */
883 /** number of components of each input register
885 * If this value is 0, the number of components is given by the
886 * num_components field of nir_intrinsic_instr.
888 unsigned src_components
[NIR_INTRINSIC_MAX_INPUTS
];
892 /** number of components of the output register
894 * If this value is 0, the number of components is given by the
895 * num_components field of nir_intrinsic_instr.
897 unsigned dest_components
;
899 /** the number of inputs/outputs that are variables */
900 unsigned num_variables
;
902 /** the number of constant indices used by the intrinsic */
903 unsigned num_indices
;
905 /** semantic flags for calls to this intrinsic */
906 nir_intrinsic_semantic_flag flags
;
907 } nir_intrinsic_info
;
909 extern const nir_intrinsic_info nir_intrinsic_infos
[nir_num_intrinsics
];
912 * \group texture information
914 * This gives semantic information about textures which is useful to the
915 * frontend, the backend, and lowering passes, but not the optimizer.
920 nir_tex_src_projector
,
921 nir_tex_src_comparitor
, /* shadow comparitor */
925 nir_tex_src_ms_index
, /* MSAA sample index */
928 nir_tex_src_sampler_offset
, /* < dynamically uniform indirect offset */
929 nir_num_tex_src_types
934 nir_tex_src_type src_type
;
938 nir_texop_tex
, /**< Regular texture look-up */
939 nir_texop_txb
, /**< Texture look-up with LOD bias */
940 nir_texop_txl
, /**< Texture look-up with explicit LOD */
941 nir_texop_txd
, /**< Texture look-up with partial derivatvies */
942 nir_texop_txf
, /**< Texel fetch with explicit LOD */
943 nir_texop_txf_ms
, /**< Multisample texture fetch */
944 nir_texop_txs
, /**< Texture size */
945 nir_texop_lod
, /**< Texture lod query */
946 nir_texop_tg4
, /**< Texture gather */
947 nir_texop_query_levels
, /**< Texture levels query */
948 nir_texop_texture_samples
, /**< Texture samples query */
949 nir_texop_samples_identical
, /**< Query whether all samples are definitely
957 enum glsl_sampler_dim sampler_dim
;
958 nir_alu_type dest_type
;
963 unsigned num_srcs
, coord_components
;
964 bool is_array
, is_shadow
;
967 * If is_shadow is true, whether this is the old-style shadow that outputs 4
968 * components or the new-style shadow that outputs 1 component.
970 bool is_new_style_shadow
;
972 /* constant offset - must be 0 if the offset source is used */
975 /* gather component selector */
976 unsigned component
: 2;
978 /** The sampler index
980 * If this texture instruction has a nir_tex_src_sampler_offset source,
981 * then the sampler index is given by sampler_index + sampler_offset.
983 unsigned sampler_index
;
985 /** The size of the sampler array or 0 if it's not an array */
986 unsigned sampler_array_size
;
988 nir_deref_var
*sampler
; /* if this is NULL, use sampler_index instead */
991 static inline unsigned
992 nir_tex_instr_dest_size(nir_tex_instr
*instr
)
995 case nir_texop_txs
: {
997 switch (instr
->sampler_dim
) {
998 case GLSL_SAMPLER_DIM_1D
:
999 case GLSL_SAMPLER_DIM_BUF
:
1002 case GLSL_SAMPLER_DIM_2D
:
1003 case GLSL_SAMPLER_DIM_CUBE
:
1004 case GLSL_SAMPLER_DIM_MS
:
1005 case GLSL_SAMPLER_DIM_RECT
:
1006 case GLSL_SAMPLER_DIM_EXTERNAL
:
1009 case GLSL_SAMPLER_DIM_3D
:
1013 unreachable("not reached");
1015 if (instr
->is_array
)
1023 case nir_texop_texture_samples
:
1024 case nir_texop_query_levels
:
1025 case nir_texop_samples_identical
:
1029 if (instr
->is_shadow
&& instr
->is_new_style_shadow
)
1036 /* Returns true if this texture operation queries something about the texture
1037 * rather than actually sampling it.
1040 nir_tex_instr_is_query(nir_tex_instr
*instr
)
1042 switch (instr
->op
) {
1045 case nir_texop_texture_samples
:
1046 case nir_texop_query_levels
:
1053 case nir_texop_txf_ms
:
1057 unreachable("Invalid texture opcode");
1061 static inline unsigned
1062 nir_tex_instr_src_size(nir_tex_instr
*instr
, unsigned src
)
1064 if (instr
->src
[src
].src_type
== nir_tex_src_coord
)
1065 return instr
->coord_components
;
1068 if (instr
->src
[src
].src_type
== nir_tex_src_offset
||
1069 instr
->src
[src
].src_type
== nir_tex_src_ddx
||
1070 instr
->src
[src
].src_type
== nir_tex_src_ddy
) {
1071 if (instr
->is_array
)
1072 return instr
->coord_components
- 1;
1074 return instr
->coord_components
;
1081 nir_tex_instr_src_index(nir_tex_instr
*instr
, nir_tex_src_type type
)
1083 for (unsigned i
= 0; i
< instr
->num_srcs
; i
++)
1084 if (instr
->src
[i
].src_type
== type
)
1101 nir_const_value value
;
1104 } nir_load_const_instr
;
1117 /* creates a new SSA variable in an undefined state */
1122 } nir_ssa_undef_instr
;
1125 struct exec_node node
;
1127 /* The predecessor block corresponding to this source */
1128 struct nir_block
*pred
;
1133 #define nir_foreach_phi_src(phi, entry) \
1134 foreach_list_typed(nir_phi_src, entry, node, &(phi)->srcs)
1135 #define nir_foreach_phi_src_safe(phi, entry) \
1136 foreach_list_typed_safe(nir_phi_src, entry, node, &(phi)->srcs)
1141 struct exec_list srcs
; /** < list of nir_phi_src */
1147 struct exec_node node
;
1150 } nir_parallel_copy_entry
;
1152 #define nir_foreach_parallel_copy_entry(pcopy, entry) \
1153 foreach_list_typed(nir_parallel_copy_entry, entry, node, &(pcopy)->entries)
1158 /* A list of nir_parallel_copy_entry's. The sources of all of the
1159 * entries are copied to the corresponding destinations "in parallel".
1160 * In other words, if we have two entries: a -> b and b -> a, the values
1163 struct exec_list entries
;
1164 } nir_parallel_copy_instr
;
1166 NIR_DEFINE_CAST(nir_instr_as_alu
, nir_instr
, nir_alu_instr
, instr
)
1167 NIR_DEFINE_CAST(nir_instr_as_call
, nir_instr
, nir_call_instr
, instr
)
1168 NIR_DEFINE_CAST(nir_instr_as_jump
, nir_instr
, nir_jump_instr
, instr
)
1169 NIR_DEFINE_CAST(nir_instr_as_tex
, nir_instr
, nir_tex_instr
, instr
)
1170 NIR_DEFINE_CAST(nir_instr_as_intrinsic
, nir_instr
, nir_intrinsic_instr
, instr
)
1171 NIR_DEFINE_CAST(nir_instr_as_load_const
, nir_instr
, nir_load_const_instr
, instr
)
1172 NIR_DEFINE_CAST(nir_instr_as_ssa_undef
, nir_instr
, nir_ssa_undef_instr
, instr
)
1173 NIR_DEFINE_CAST(nir_instr_as_phi
, nir_instr
, nir_phi_instr
, instr
)
1174 NIR_DEFINE_CAST(nir_instr_as_parallel_copy
, nir_instr
,
1175 nir_parallel_copy_instr
, instr
)
1180 * Control flow consists of a tree of control flow nodes, which include
1181 * if-statements and loops. The leaves of the tree are basic blocks, lists of
1182 * instructions that always run start-to-finish. Each basic block also keeps
1183 * track of its successors (blocks which may run immediately after the current
1184 * block) and predecessors (blocks which could have run immediately before the
1185 * current block). Each function also has a start block and an end block which
1186 * all return statements point to (which is always empty). Together, all the
1187 * blocks with their predecessors and successors make up the control flow
1188 * graph (CFG) of the function. There are helpers that modify the tree of
1189 * control flow nodes while modifying the CFG appropriately; these should be
1190 * used instead of modifying the tree directly.
1197 nir_cf_node_function
1200 typedef struct nir_cf_node
{
1201 struct exec_node node
;
1202 nir_cf_node_type type
;
1203 struct nir_cf_node
*parent
;
1206 typedef struct nir_block
{
1207 nir_cf_node cf_node
;
1209 struct exec_list instr_list
; /** < list of nir_instr */
1211 /** generic block index; generated by nir_index_blocks */
1215 * Each block can only have up to 2 successors, so we put them in a simple
1216 * array - no need for anything more complicated.
1218 struct nir_block
*successors
[2];
1220 /* Set of nir_block predecessors in the CFG */
1221 struct set
*predecessors
;
1224 * this node's immediate dominator in the dominance tree - set to NULL for
1227 struct nir_block
*imm_dom
;
1229 /* This node's children in the dominance tree */
1230 unsigned num_dom_children
;
1231 struct nir_block
**dom_children
;
1233 /* Set of nir_block's on the dominance frontier of this block */
1234 struct set
*dom_frontier
;
1237 * These two indices have the property that dom_{pre,post}_index for each
1238 * child of this block in the dominance tree will always be between
1239 * dom_pre_index and dom_post_index for this block, which makes testing if
1240 * a given block is dominated by another block an O(1) operation.
1242 unsigned dom_pre_index
, dom_post_index
;
1244 /* live in and out for this block; used for liveness analysis */
1245 BITSET_WORD
*live_in
;
1246 BITSET_WORD
*live_out
;
1249 static inline nir_instr
*
1250 nir_block_first_instr(nir_block
*block
)
1252 struct exec_node
*head
= exec_list_get_head(&block
->instr_list
);
1253 return exec_node_data(nir_instr
, head
, node
);
1256 static inline nir_instr
*
1257 nir_block_last_instr(nir_block
*block
)
1259 struct exec_node
*tail
= exec_list_get_tail(&block
->instr_list
);
1260 return exec_node_data(nir_instr
, tail
, node
);
1263 #define nir_foreach_instr(block, instr) \
1264 foreach_list_typed(nir_instr, instr, node, &(block)->instr_list)
1265 #define nir_foreach_instr_reverse(block, instr) \
1266 foreach_list_typed_reverse(nir_instr, instr, node, &(block)->instr_list)
1267 #define nir_foreach_instr_safe(block, instr) \
1268 foreach_list_typed_safe(nir_instr, instr, node, &(block)->instr_list)
1269 #define nir_foreach_instr_reverse_safe(block, instr) \
1270 foreach_list_typed_reverse_safe(nir_instr, instr, node, &(block)->instr_list)
1272 typedef struct nir_if
{
1273 nir_cf_node cf_node
;
1276 struct exec_list then_list
; /** < list of nir_cf_node */
1277 struct exec_list else_list
; /** < list of nir_cf_node */
1280 static inline nir_cf_node
*
1281 nir_if_first_then_node(nir_if
*if_stmt
)
1283 struct exec_node
*head
= exec_list_get_head(&if_stmt
->then_list
);
1284 return exec_node_data(nir_cf_node
, head
, node
);
1287 static inline nir_cf_node
*
1288 nir_if_last_then_node(nir_if
*if_stmt
)
1290 struct exec_node
*tail
= exec_list_get_tail(&if_stmt
->then_list
);
1291 return exec_node_data(nir_cf_node
, tail
, node
);
1294 static inline nir_cf_node
*
1295 nir_if_first_else_node(nir_if
*if_stmt
)
1297 struct exec_node
*head
= exec_list_get_head(&if_stmt
->else_list
);
1298 return exec_node_data(nir_cf_node
, head
, node
);
1301 static inline nir_cf_node
*
1302 nir_if_last_else_node(nir_if
*if_stmt
)
1304 struct exec_node
*tail
= exec_list_get_tail(&if_stmt
->else_list
);
1305 return exec_node_data(nir_cf_node
, tail
, node
);
1309 nir_cf_node cf_node
;
1311 struct exec_list body
; /** < list of nir_cf_node */
1314 static inline nir_cf_node
*
1315 nir_loop_first_cf_node(nir_loop
*loop
)
1317 return exec_node_data(nir_cf_node
, exec_list_get_head(&loop
->body
), node
);
1320 static inline nir_cf_node
*
1321 nir_loop_last_cf_node(nir_loop
*loop
)
1323 return exec_node_data(nir_cf_node
, exec_list_get_tail(&loop
->body
), node
);
1327 * Various bits of metadata that can may be created or required by
1328 * optimization and analysis passes
1331 nir_metadata_none
= 0x0,
1332 nir_metadata_block_index
= 0x1,
1333 nir_metadata_dominance
= 0x2,
1334 nir_metadata_live_ssa_defs
= 0x4,
1335 nir_metadata_not_properly_reset
= 0x8,
1339 nir_cf_node cf_node
;
1341 /** pointer to the function of which this is an implementation */
1342 struct nir_function
*function
;
1344 struct exec_list body
; /** < list of nir_cf_node */
1346 nir_block
*end_block
;
1348 /** list for all local variables in the function */
1349 struct exec_list locals
;
1351 /** array of variables used as parameters */
1352 unsigned num_params
;
1353 nir_variable
**params
;
1355 /** variable used to hold the result of the function */
1356 nir_variable
*return_var
;
1358 /** list of local registers in the function */
1359 struct exec_list registers
;
1361 /** next available local register index */
1364 /** next available SSA value index */
1367 /* total number of basic blocks, only valid when block_index_dirty = false */
1368 unsigned num_blocks
;
1370 nir_metadata valid_metadata
;
1371 } nir_function_impl
;
1373 static inline nir_block
*
1374 nir_start_block(nir_function_impl
*impl
)
1376 return (nir_block
*) exec_list_get_head(&impl
->body
);
1379 static inline nir_cf_node
*
1380 nir_cf_node_next(nir_cf_node
*node
)
1382 struct exec_node
*next
= exec_node_get_next(&node
->node
);
1383 if (exec_node_is_tail_sentinel(next
))
1386 return exec_node_data(nir_cf_node
, next
, node
);
1389 static inline nir_cf_node
*
1390 nir_cf_node_prev(nir_cf_node
*node
)
1392 struct exec_node
*prev
= exec_node_get_prev(&node
->node
);
1393 if (exec_node_is_head_sentinel(prev
))
1396 return exec_node_data(nir_cf_node
, prev
, node
);
1400 nir_cf_node_is_first(const nir_cf_node
*node
)
1402 return exec_node_is_head_sentinel(node
->node
.prev
);
1406 nir_cf_node_is_last(const nir_cf_node
*node
)
1408 return exec_node_is_tail_sentinel(node
->node
.next
);
1411 NIR_DEFINE_CAST(nir_cf_node_as_block
, nir_cf_node
, nir_block
, cf_node
)
1412 NIR_DEFINE_CAST(nir_cf_node_as_if
, nir_cf_node
, nir_if
, cf_node
)
1413 NIR_DEFINE_CAST(nir_cf_node_as_loop
, nir_cf_node
, nir_loop
, cf_node
)
1414 NIR_DEFINE_CAST(nir_cf_node_as_function
, nir_cf_node
, nir_function_impl
, cf_node
)
1419 nir_parameter_inout
,
1420 } nir_parameter_type
;
1423 nir_parameter_type param_type
;
1424 const struct glsl_type
*type
;
1427 typedef struct nir_function
{
1428 struct exec_node node
;
1431 struct nir_shader
*shader
;
1433 unsigned num_params
;
1434 nir_parameter
*params
;
1435 const struct glsl_type
*return_type
;
1437 /** The implementation of this function.
1439 * If the function is only declared and not implemented, this is NULL.
1441 nir_function_impl
*impl
;
1444 typedef struct nir_shader_compiler_options
{
1450 /** lowers fneg and ineg to fsub and isub. */
1452 /** lowers fsub and isub to fadd+fneg and iadd+ineg. */
1455 /* lower {slt,sge,seq,sne} to {flt,fge,feq,fne} + b2f: */
1458 /* Does the native fdot instruction replicate its result for four
1459 * components? If so, then opt_algebraic_late will turn all fdotN
1460 * instructions into fdot_replicatedN instructions.
1462 bool fdot_replicates
;
1464 /** lowers ffract to fsub+ffloor: */
1468 * Does the driver support real 32-bit integers? (Otherwise, integers
1469 * are simulated by floats.)
1471 bool native_integers
;
1472 } nir_shader_compiler_options
;
1474 typedef struct nir_shader_info
{
1477 /* Descriptive name provided by the client; may be NULL */
1480 /* Number of textures used by this shader */
1481 unsigned num_textures
;
1482 /* Number of uniform buffers used by this shader */
1484 /* Number of atomic buffers used by this shader */
1486 /* Number of shader storage buffers used by this shader */
1488 /* Number of images used by this shader */
1489 unsigned num_images
;
1491 /* Which inputs are actually read */
1492 uint64_t inputs_read
;
1493 /* Which outputs are actually written */
1494 uint64_t outputs_written
;
1495 /* Which system values are actually read */
1496 uint64_t system_values_read
;
1498 /* Which patch inputs are actually read */
1499 uint32_t patch_inputs_read
;
1500 /* Which patch outputs are actually written */
1501 uint32_t patch_outputs_written
;
1503 /* Whether or not this shader ever uses textureGather() */
1504 bool uses_texture_gather
;
1506 /* Whether or not this shader uses the gl_ClipDistance output */
1507 bool uses_clip_distance_out
;
1509 /* Whether or not separate shader objects were used */
1510 bool separate_shader
;
1512 /** Was this shader linked with any transform feedback varyings? */
1513 bool has_transform_feedback_varyings
;
1517 /** The number of vertices recieves per input primitive */
1518 unsigned vertices_in
;
1520 /** The output primitive type (GL enum value) */
1521 unsigned output_primitive
;
1523 /** The maximum number of vertices the geometry shader might write. */
1524 unsigned vertices_out
;
1526 /** 1 .. MAX_GEOMETRY_SHADER_INVOCATIONS */
1527 unsigned invocations
;
1529 /** Whether or not this shader uses EndPrimitive */
1530 bool uses_end_primitive
;
1532 /** Whether or not this shader uses non-zero streams */
1540 * Whether early fragment tests are enabled as defined by
1541 * ARB_shader_image_load_store.
1543 bool early_fragment_tests
;
1545 /** gl_FragDepth layout for ARB_conservative_depth. */
1546 enum gl_frag_depth_layout depth_layout
;
1550 unsigned local_size
[3];
1554 /** The number of vertices in the TCS output patch. */
1555 unsigned vertices_out
;
1560 typedef struct nir_shader
{
1561 /** list of uniforms (nir_variable) */
1562 struct exec_list uniforms
;
1564 /** list of inputs (nir_variable) */
1565 struct exec_list inputs
;
1567 /** list of outputs (nir_variable) */
1568 struct exec_list outputs
;
1570 /** Set of driver-specific options for the shader.
1572 * The memory for the options is expected to be kept in a single static
1573 * copy by the driver.
1575 const struct nir_shader_compiler_options
*options
;
1577 /** Various bits of compile-time information about a given shader */
1578 struct nir_shader_info info
;
1580 /** list of global variables in the shader (nir_variable) */
1581 struct exec_list globals
;
1583 /** list of system value variables in the shader (nir_variable) */
1584 struct exec_list system_values
;
1586 struct exec_list functions
; /** < list of nir_function */
1588 /** list of global register in the shader */
1589 struct exec_list registers
;
1591 /** next available global register index */
1595 * the highest index a load_input_*, load_uniform_*, etc. intrinsic can
1598 unsigned num_inputs
, num_uniforms
, num_outputs
;
1600 /** The shader stage, such as MESA_SHADER_VERTEX. */
1601 gl_shader_stage stage
;
1604 #define nir_foreach_function(shader, func) \
1605 foreach_list_typed(nir_function, func, node, &(shader)->functions)
1607 nir_shader
*nir_shader_create(void *mem_ctx
,
1608 gl_shader_stage stage
,
1609 const nir_shader_compiler_options
*options
);
1611 /** creates a register, including assigning it an index and adding it to the list */
1612 nir_register
*nir_global_reg_create(nir_shader
*shader
);
1614 nir_register
*nir_local_reg_create(nir_function_impl
*impl
);
1616 void nir_reg_remove(nir_register
*reg
);
1618 /** Adds a variable to the appropreate list in nir_shader */
1619 void nir_shader_add_variable(nir_shader
*shader
, nir_variable
*var
);
1622 nir_function_impl_add_variable(nir_function_impl
*impl
, nir_variable
*var
)
1624 assert(var
->data
.mode
== nir_var_local
);
1625 exec_list_push_tail(&impl
->locals
, &var
->node
);
1628 /** creates a variable, sets a few defaults, and adds it to the list */
1629 nir_variable
*nir_variable_create(nir_shader
*shader
,
1630 nir_variable_mode mode
,
1631 const struct glsl_type
*type
,
1633 /** creates a local variable and adds it to the list */
1634 nir_variable
*nir_local_variable_create(nir_function_impl
*impl
,
1635 const struct glsl_type
*type
,
1638 /** creates a function and adds it to the shader's list of functions */
1639 nir_function
*nir_function_create(nir_shader
*shader
, const char *name
);
1641 nir_function_impl
*nir_function_impl_create(nir_function
*func
);
1643 nir_block
*nir_block_create(nir_shader
*shader
);
1644 nir_if
*nir_if_create(nir_shader
*shader
);
1645 nir_loop
*nir_loop_create(nir_shader
*shader
);
1647 nir_function_impl
*nir_cf_node_get_function(nir_cf_node
*node
);
1649 /** requests that the given pieces of metadata be generated */
1650 void nir_metadata_require(nir_function_impl
*impl
, nir_metadata required
);
1651 /** dirties all but the preserved metadata */
1652 void nir_metadata_preserve(nir_function_impl
*impl
, nir_metadata preserved
);
1654 /** creates an instruction with default swizzle/writemask/etc. with NULL registers */
1655 nir_alu_instr
*nir_alu_instr_create(nir_shader
*shader
, nir_op op
);
1657 nir_jump_instr
*nir_jump_instr_create(nir_shader
*shader
, nir_jump_type type
);
1659 nir_load_const_instr
*nir_load_const_instr_create(nir_shader
*shader
,
1660 unsigned num_components
);
1662 nir_intrinsic_instr
*nir_intrinsic_instr_create(nir_shader
*shader
,
1663 nir_intrinsic_op op
);
1665 nir_call_instr
*nir_call_instr_create(nir_shader
*shader
,
1666 nir_function
*callee
);
1668 nir_tex_instr
*nir_tex_instr_create(nir_shader
*shader
, unsigned num_srcs
);
1670 nir_phi_instr
*nir_phi_instr_create(nir_shader
*shader
);
1672 nir_parallel_copy_instr
*nir_parallel_copy_instr_create(nir_shader
*shader
);
1674 nir_ssa_undef_instr
*nir_ssa_undef_instr_create(nir_shader
*shader
,
1675 unsigned num_components
);
1677 nir_deref_var
*nir_deref_var_create(void *mem_ctx
, nir_variable
*var
);
1678 nir_deref_array
*nir_deref_array_create(void *mem_ctx
);
1679 nir_deref_struct
*nir_deref_struct_create(void *mem_ctx
, unsigned field_index
);
1681 nir_deref
*nir_copy_deref(void *mem_ctx
, nir_deref
*deref
);
1683 nir_load_const_instr
*
1684 nir_deref_get_const_initializer_load(nir_shader
*shader
, nir_deref_var
*deref
);
1687 * NIR Cursors and Instruction Insertion API
1690 * A tiny struct representing a point to insert/extract instructions or
1691 * control flow nodes. Helps reduce the combinatorial explosion of possible
1692 * points to insert/extract.
1694 * \sa nir_control_flow.h
1697 nir_cursor_before_block
,
1698 nir_cursor_after_block
,
1699 nir_cursor_before_instr
,
1700 nir_cursor_after_instr
,
1701 } nir_cursor_option
;
1704 nir_cursor_option option
;
1711 static inline nir_cursor
1712 nir_before_block(nir_block
*block
)
1715 cursor
.option
= nir_cursor_before_block
;
1716 cursor
.block
= block
;
1720 static inline nir_cursor
1721 nir_after_block(nir_block
*block
)
1724 cursor
.option
= nir_cursor_after_block
;
1725 cursor
.block
= block
;
1729 static inline nir_cursor
1730 nir_before_instr(nir_instr
*instr
)
1733 cursor
.option
= nir_cursor_before_instr
;
1734 cursor
.instr
= instr
;
1738 static inline nir_cursor
1739 nir_after_instr(nir_instr
*instr
)
1742 cursor
.option
= nir_cursor_after_instr
;
1743 cursor
.instr
= instr
;
1747 static inline nir_cursor
1748 nir_after_block_before_jump(nir_block
*block
)
1750 nir_instr
*last_instr
= nir_block_last_instr(block
);
1751 if (last_instr
&& last_instr
->type
== nir_instr_type_jump
) {
1752 return nir_before_instr(last_instr
);
1754 return nir_after_block(block
);
1758 static inline nir_cursor
1759 nir_before_cf_node(nir_cf_node
*node
)
1761 if (node
->type
== nir_cf_node_block
)
1762 return nir_before_block(nir_cf_node_as_block(node
));
1764 return nir_after_block(nir_cf_node_as_block(nir_cf_node_prev(node
)));
1767 static inline nir_cursor
1768 nir_after_cf_node(nir_cf_node
*node
)
1770 if (node
->type
== nir_cf_node_block
)
1771 return nir_after_block(nir_cf_node_as_block(node
));
1773 return nir_before_block(nir_cf_node_as_block(nir_cf_node_next(node
)));
1776 static inline nir_cursor
1777 nir_before_cf_list(struct exec_list
*cf_list
)
1779 nir_cf_node
*first_node
= exec_node_data(nir_cf_node
,
1780 exec_list_get_head(cf_list
), node
);
1781 return nir_before_cf_node(first_node
);
1784 static inline nir_cursor
1785 nir_after_cf_list(struct exec_list
*cf_list
)
1787 nir_cf_node
*last_node
= exec_node_data(nir_cf_node
,
1788 exec_list_get_tail(cf_list
), node
);
1789 return nir_after_cf_node(last_node
);
1793 * Insert a NIR instruction at the given cursor.
1795 * Note: This does not update the cursor.
1797 void nir_instr_insert(nir_cursor cursor
, nir_instr
*instr
);
1800 nir_instr_insert_before(nir_instr
*instr
, nir_instr
*before
)
1802 nir_instr_insert(nir_before_instr(instr
), before
);
1806 nir_instr_insert_after(nir_instr
*instr
, nir_instr
*after
)
1808 nir_instr_insert(nir_after_instr(instr
), after
);
1812 nir_instr_insert_before_block(nir_block
*block
, nir_instr
*before
)
1814 nir_instr_insert(nir_before_block(block
), before
);
1818 nir_instr_insert_after_block(nir_block
*block
, nir_instr
*after
)
1820 nir_instr_insert(nir_after_block(block
), after
);
1824 nir_instr_insert_before_cf(nir_cf_node
*node
, nir_instr
*before
)
1826 nir_instr_insert(nir_before_cf_node(node
), before
);
1830 nir_instr_insert_after_cf(nir_cf_node
*node
, nir_instr
*after
)
1832 nir_instr_insert(nir_after_cf_node(node
), after
);
1836 nir_instr_insert_before_cf_list(struct exec_list
*list
, nir_instr
*before
)
1838 nir_instr_insert(nir_before_cf_list(list
), before
);
1842 nir_instr_insert_after_cf_list(struct exec_list
*list
, nir_instr
*after
)
1844 nir_instr_insert(nir_after_cf_list(list
), after
);
1847 void nir_instr_remove(nir_instr
*instr
);
1851 typedef bool (*nir_foreach_ssa_def_cb
)(nir_ssa_def
*def
, void *state
);
1852 typedef bool (*nir_foreach_dest_cb
)(nir_dest
*dest
, void *state
);
1853 typedef bool (*nir_foreach_src_cb
)(nir_src
*src
, void *state
);
1854 bool nir_foreach_ssa_def(nir_instr
*instr
, nir_foreach_ssa_def_cb cb
,
1856 bool nir_foreach_dest(nir_instr
*instr
, nir_foreach_dest_cb cb
, void *state
);
1857 bool nir_foreach_src(nir_instr
*instr
, nir_foreach_src_cb cb
, void *state
);
1859 nir_const_value
*nir_src_as_const_value(nir_src src
);
1860 bool nir_src_is_dynamically_uniform(nir_src src
);
1861 bool nir_srcs_equal(nir_src src1
, nir_src src2
);
1862 void nir_instr_rewrite_src(nir_instr
*instr
, nir_src
*src
, nir_src new_src
);
1863 void nir_instr_move_src(nir_instr
*dest_instr
, nir_src
*dest
, nir_src
*src
);
1864 void nir_if_rewrite_condition(nir_if
*if_stmt
, nir_src new_src
);
1865 void nir_instr_rewrite_dest(nir_instr
*instr
, nir_dest
*dest
,
1868 void nir_ssa_dest_init(nir_instr
*instr
, nir_dest
*dest
,
1869 unsigned num_components
, const char *name
);
1870 void nir_ssa_def_init(nir_instr
*instr
, nir_ssa_def
*def
,
1871 unsigned num_components
, const char *name
);
1872 void nir_ssa_def_rewrite_uses(nir_ssa_def
*def
, nir_src new_src
);
1873 void nir_ssa_def_rewrite_uses_after(nir_ssa_def
*def
, nir_src new_src
,
1874 nir_instr
*after_me
);
1876 /* visits basic blocks in source-code order */
1877 typedef bool (*nir_foreach_block_cb
)(nir_block
*block
, void *state
);
1878 bool nir_foreach_block(nir_function_impl
*impl
, nir_foreach_block_cb cb
,
1880 bool nir_foreach_block_reverse(nir_function_impl
*impl
, nir_foreach_block_cb cb
,
1882 bool nir_foreach_block_in_cf_node(nir_cf_node
*node
, nir_foreach_block_cb cb
,
1885 /* If the following CF node is an if, this function returns that if.
1886 * Otherwise, it returns NULL.
1888 nir_if
*nir_block_get_following_if(nir_block
*block
);
1890 nir_loop
*nir_block_get_following_loop(nir_block
*block
);
1892 void nir_index_local_regs(nir_function_impl
*impl
);
1893 void nir_index_global_regs(nir_shader
*shader
);
1894 void nir_index_ssa_defs(nir_function_impl
*impl
);
1895 unsigned nir_index_instrs(nir_function_impl
*impl
);
1897 void nir_index_blocks(nir_function_impl
*impl
);
1899 void nir_print_shader(nir_shader
*shader
, FILE *fp
);
1900 void nir_print_instr(const nir_instr
*instr
, FILE *fp
);
1902 nir_shader
* nir_shader_clone(void *mem_ctx
, const nir_shader
*s
);
1905 void nir_validate_shader(nir_shader
*shader
);
1906 void nir_metadata_set_validation_flag(nir_shader
*shader
);
1907 void nir_metadata_check_validation_flag(nir_shader
*shader
);
1909 static inline void nir_validate_shader(nir_shader
*shader
) { (void) shader
; }
1910 static inline void nir_metadata_set_validation_flag(nir_shader
*shader
) { (void) shader
; }
1911 static inline void nir_metadata_check_validation_flag(nir_shader
*shader
) { (void) shader
; }
1914 void nir_calc_dominance_impl(nir_function_impl
*impl
);
1915 void nir_calc_dominance(nir_shader
*shader
);
1917 nir_block
*nir_dominance_lca(nir_block
*b1
, nir_block
*b2
);
1918 bool nir_block_dominates(nir_block
*parent
, nir_block
*child
);
1920 void nir_dump_dom_tree_impl(nir_function_impl
*impl
, FILE *fp
);
1921 void nir_dump_dom_tree(nir_shader
*shader
, FILE *fp
);
1923 void nir_dump_dom_frontier_impl(nir_function_impl
*impl
, FILE *fp
);
1924 void nir_dump_dom_frontier(nir_shader
*shader
, FILE *fp
);
1926 void nir_dump_cfg_impl(nir_function_impl
*impl
, FILE *fp
);
1927 void nir_dump_cfg(nir_shader
*shader
, FILE *fp
);
1929 int nir_gs_count_vertices(const nir_shader
*shader
);
1931 bool nir_split_var_copies(nir_shader
*shader
);
1933 void nir_lower_var_copy_instr(nir_intrinsic_instr
*copy
, void *mem_ctx
);
1934 void nir_lower_var_copies(nir_shader
*shader
);
1936 bool nir_lower_global_vars_to_local(nir_shader
*shader
);
1938 bool nir_lower_locals_to_regs(nir_shader
*shader
);
1940 void nir_lower_outputs_to_temporaries(nir_shader
*shader
);
1942 void nir_assign_var_locations(struct exec_list
*var_list
,
1944 int (*type_size
)(const struct glsl_type
*));
1946 void nir_lower_io(nir_shader
*shader
,
1947 nir_variable_mode mode
,
1948 int (*type_size
)(const struct glsl_type
*));
1949 nir_src
*nir_get_io_offset_src(nir_intrinsic_instr
*instr
);
1950 nir_src
*nir_get_io_vertex_index_src(nir_intrinsic_instr
*instr
);
1952 void nir_lower_vars_to_ssa(nir_shader
*shader
);
1954 bool nir_remove_dead_variables(nir_shader
*shader
);
1956 void nir_move_vec_src_uses_to_dest(nir_shader
*shader
);
1957 bool nir_lower_vec_to_movs(nir_shader
*shader
);
1958 void nir_lower_alu_to_scalar(nir_shader
*shader
);
1959 void nir_lower_load_const_to_scalar(nir_shader
*shader
);
1961 void nir_lower_phis_to_scalar(nir_shader
*shader
);
1963 void nir_lower_samplers(nir_shader
*shader
,
1964 const struct gl_shader_program
*shader_program
);
1966 bool nir_lower_system_values(nir_shader
*shader
);
1968 typedef struct nir_lower_tex_options
{
1970 * bitmask of (1 << GLSL_SAMPLER_DIM_x) to control for which
1971 * sampler types a texture projector is lowered.
1976 * If true, lower rect textures to 2D, using txs to fetch the
1977 * texture dimensions and dividing the texture coords by the
1978 * texture dims to normalize.
1983 * To emulate certain texture wrap modes, this can be used
1984 * to saturate the specified tex coord to [0.0, 1.0]. The
1985 * bits are according to sampler #, ie. if, for example:
1987 * (conf->saturate_s & (1 << n))
1989 * is true, then the s coord for sampler n is saturated.
1991 * Note that clamping must happen *after* projector lowering
1992 * so any projected texture sample instruction with a clamped
1993 * coordinate gets automatically lowered, regardless of the
1994 * 'lower_txp' setting.
1996 unsigned saturate_s
;
1997 unsigned saturate_t
;
1998 unsigned saturate_r
;
2000 /* Bitmask of samplers that need swizzling.
2002 * If (swizzle_result & (1 << sampler_index)), then the swizzle in
2003 * swizzles[sampler_index] is applied to the result of the texturing
2006 unsigned swizzle_result
;
2008 /* A swizzle for each sampler. Values 0-3 represent x, y, z, or w swizzles
2009 * while 4 and 5 represent 0 and 1 respectively.
2011 uint8_t swizzles
[32][4];
2012 } nir_lower_tex_options
;
2014 bool nir_lower_tex(nir_shader
*shader
,
2015 const nir_lower_tex_options
*options
);
2017 void nir_lower_idiv(nir_shader
*shader
);
2019 void nir_lower_clip_vs(nir_shader
*shader
, unsigned ucp_enables
);
2020 void nir_lower_clip_fs(nir_shader
*shader
, unsigned ucp_enables
);
2022 void nir_lower_two_sided_color(nir_shader
*shader
);
2024 void nir_lower_atomics(nir_shader
*shader
,
2025 const struct gl_shader_program
*shader_program
);
2026 void nir_lower_to_source_mods(nir_shader
*shader
);
2028 bool nir_lower_gs_intrinsics(nir_shader
*shader
);
2030 bool nir_normalize_cubemap_coords(nir_shader
*shader
);
2032 void nir_live_ssa_defs_impl(nir_function_impl
*impl
);
2033 bool nir_ssa_defs_interfere(nir_ssa_def
*a
, nir_ssa_def
*b
);
2035 void nir_convert_to_ssa_impl(nir_function_impl
*impl
);
2036 void nir_convert_to_ssa(nir_shader
*shader
);
2038 /* If phi_webs_only is true, only convert SSA values involved in phi nodes to
2039 * registers. If false, convert all values (even those not involved in a phi
2040 * node) to registers.
2042 void nir_convert_from_ssa(nir_shader
*shader
, bool phi_webs_only
);
2044 bool nir_opt_algebraic(nir_shader
*shader
);
2045 bool nir_opt_algebraic_late(nir_shader
*shader
);
2046 bool nir_opt_constant_folding(nir_shader
*shader
);
2048 bool nir_opt_global_to_local(nir_shader
*shader
);
2050 bool nir_copy_prop(nir_shader
*shader
);
2052 bool nir_opt_cse(nir_shader
*shader
);
2054 bool nir_opt_dce(nir_shader
*shader
);
2056 bool nir_opt_dead_cf(nir_shader
*shader
);
2058 void nir_opt_gcm(nir_shader
*shader
);
2060 bool nir_opt_peephole_select(nir_shader
*shader
);
2062 bool nir_opt_remove_phis(nir_shader
*shader
);
2064 bool nir_opt_undef(nir_shader
*shader
);
2066 void nir_sweep(nir_shader
*shader
);
2068 nir_intrinsic_op
nir_intrinsic_from_system_value(gl_system_value val
);
2069 gl_system_value
nir_system_value_from_intrinsic(nir_intrinsic_op intrin
);