mesa/src/compiler/nir
Jason Ekstrand 5e1c42d85f nir: Call nir_metadata_preserve on !progress
Reviewed-by: Alyssa Rosenzweig <alyssa.rosenzweig@collabora.com>
Reviewed-by: Kenneth Graunke <kenneth@whitecape.org>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/5171>
2020-06-11 05:08:12 +00:00
..
tests compiler: delete leftover autotools test wrapper 2020-05-20 22:19:30 +00:00
README
meson.build meson: use gnu_symbol_visibility argument 2020-06-01 18:59:18 +00:00
nir.c nir: Call nir_metadata_preserve on !progress 2020-06-11 05:08:12 +00:00
nir.h nir: Add a nir_shader_preserve_all_metadata helper 2020-06-11 05:08:12 +00:00
nir_algebraic.py nir/algebraic: Detect some kinds of malformed variable names 2020-04-27 09:08:34 -07:00
nir_builder.h nir/builder: add bitsize conversion helpers 2020-06-03 21:24:13 +00:00
nir_builder_opcodes_h.py nir+vtn: vec8+vec16 support 2019-12-21 11:00:17 +00:00
nir_builtin_builder.c nir/builder: Return an integer from nir_get_texture_size 2020-02-21 18:48:03 +00:00
nir_builtin_builder.h compiler/nir: move tan-calculation to helper 2020-05-04 11:31:29 +00:00
nir_clone.c nir/clone: Re-use clone_alu for nir_alu_instr_clone 2020-05-19 19:31:26 +00:00
nir_constant_expressions.h nir: add support for flushing to zero denorm constants 2019-09-17 23:39:18 +03:00
nir_constant_expressions.py nir: Delete the fnoise opcodes 2020-04-21 06:16:13 +00:00
nir_control_flow.c nir: Use a switch statement in nir_handle_add_jump 2020-05-19 17:21:23 +00:00
nir_control_flow.h
nir_control_flow_private.h
nir_convert_ycbcr.c nir: convert_ycbcr: preserve alpha channel 2020-04-20 22:01:43 +00:00
nir_deref.c nir: Call nir_metadata_preserve on !progress 2020-06-11 05:08:12 +00:00
nir_deref.h
nir_divergence_analysis.c nir: reset ssa-defs as non-divergent during divergence analysis instead of upfront 2020-05-13 18:49:22 +00:00
nir_dominance.c nir/dominance: Better handle unreachable blocks 2020-04-20 03:46:29 +00:00
nir_format_convert.h nir: Allow nir_format conversions to work on 32-bit values 2020-02-28 11:52:40 +00:00
nir_from_ssa.c nir: Add a store_reg helper and use the builder in phis_to_regs 2020-05-19 19:31:26 +00:00
nir_gather_info.c nir: gather which images are MSAA 2020-06-02 20:47:49 +00:00
nir_gather_ssa_types.c nir: Handle vec8/16 in gather_ssa_types 2020-03-31 00:18:05 +00:00
nir_gather_xfb_info.c nir: fix wrong assignment to buffer in xfb_varyings_info 2020-04-06 08:55:05 +00:00
nir_gs_count_vertices.c
nir_inline_functions.c nir: Call nir_metadata_preserve on !progress 2020-06-11 05:08:12 +00:00
nir_instr_set.c nir: replace fnv1a hash function with xxhash 2020-05-25 19:41:09 +00:00
nir_instr_set.h
nir_intrinsics.py nir: Replace the zs_output_pan intrinsic with combined_output_pan 2020-06-10 13:54:03 +00:00
nir_intrinsics_c.py
nir_intrinsics_h.py
nir_linking_helpers.c nir: Add new linking helper to set linked driver locations. 2020-04-29 11:51:04 +00:00
nir_liveness.c nir: Remove a bunch of large stack arrays 2019-07-22 16:17:18 -05:00
nir_loop_analyze.c nir: Delete unused is_var_constant() helper 2020-02-04 06:03:52 +00:00
nir_loop_analyze.h
nir_lower_alpha_test.c Revert "nir: drop support for using load_alpha_ref_float" 2019-10-23 13:03:52 +02:00
nir_lower_alu.c
nir_lower_alu_to_scalar.c nir: fix unpack_64_4x16 in lower_alu_to_scalar() 2020-04-03 23:13:15 +01:00
nir_lower_amul.c nir/lower_amul: fix slot calculation 2020-04-06 18:00:17 +00:00
nir_lower_array_deref_of_vec.c nir: Call nir_metadata_preserve on !progress 2020-06-11 05:08:12 +00:00
nir_lower_atomics_to_ssbo.c nir: Drop the ssbo_offset to atomic lowering. 2020-01-21 10:06:23 -08:00
nir_lower_bit_size.c nir: Call nir_metadata_preserve on !progress 2020-06-11 05:08:12 +00:00
nir_lower_bitmap.c
nir_lower_bool_to_bitsize.c nir: Handle vec8/16 in bool_to_bitsize 2020-03-31 00:18:05 +00:00
nir_lower_bool_to_float.c nir: Add b2b opcodes 2020-03-30 15:46:19 +00:00
nir_lower_bool_to_int32.c nir: Call nir_metadata_preserve on !progress 2020-06-11 05:08:12 +00:00
nir_lower_clamp_color_outputs.c nir: add tess support to nir_lower_clamp_color_outputs() 2019-06-26 00:36:48 +00:00
nir_lower_clip.c nir/lower_clip: Fix picking of unused driver locations. 2020-04-23 18:52:46 +00:00
nir_lower_clip_cull_distance_arrays.c nir: fix clip/cull_distance_array_size in nir_lower_clip_cull_distance_arrays 2020-03-19 01:47:28 -04:00
nir_lower_clip_halfz.c nir/zink: move clip_halfz-lowering to common code 2020-01-03 22:48:19 +00:00
nir_lower_discard_to_demote.c nir: update uses_demote flag in discard_to_demote pass 2020-03-25 08:19:33 +01:00
nir_lower_double_ops.c nir: Call nir_metadata_preserve on !progress 2020-06-11 05:08:12 +00:00
nir_lower_drawpixels.c nir/drawpixels: fix what appears to be a copy-paste bug in get_texcoord_const 2019-10-10 15:49:18 -04:00
nir_lower_fb_read.c
nir_lower_flatshade.c nir: add a pass to lower flat shading. 2019-10-17 10:41:36 +02:00
nir_lower_flrp.c nir/compiler: keep same bit size when lowering with flrp 2019-07-12 16:15:20 +00:00
nir_lower_fragcoord_wtrans.c
nir_lower_frexp.c
nir_lower_global_vars_to_local.c nir: Call nir_metadata_preserve on !progress 2020-06-11 05:08:12 +00:00
nir_lower_gs_intrinsics.c nir/lower_gs_intrinsics: add option for per-stream counts 2020-01-14 12:11:14 +00:00
nir_lower_idiv.c nir/lower_idiv: add new llvm-based path 2019-10-21 18:49:46 +00:00
nir_lower_indirect_derefs.c nir: Call nir_metadata_preserve on !progress 2020-06-11 05:08:12 +00:00
nir_lower_input_attachments.c nir/lower_input_attachments: remove bogus assert in try_lower_input_texop() 2020-03-06 09:13:40 +00:00
nir_lower_int64.c nir/lower_int64: lower imin3/imax3/umin3/umax3/imed3/umed3 2020-04-20 06:59:47 +00:00
nir_lower_int_to_float.c tree-wide: replace MAYBE_UNUSED with ASSERTED 2019-07-31 09:41:05 +01:00
nir_lower_interpolation.c nir: add pass to lower load_interpolated_input 2019-07-02 16:15:25 +00:00
nir_lower_io.c nir/lower_explicit_io: fix NON_UNIFORM access for UBO loads 2020-06-08 07:35:43 +00:00
nir_lower_io_arrays_to_elements.c nir: Add per_view attribute to nir_variable 2020-04-07 17:16:09 +00:00
nir_lower_io_to_scalar.c nir: add nir_intrinsic_interp_deref_at_vertex 2020-01-29 09:49:50 +00:00
nir_lower_io_to_temporaries.c compiler/nir: Add support for variable initialization from a pointer 2020-02-12 15:41:49 +00:00
nir_lower_io_to_vector.c nir: Add per_view attribute to nir_variable 2020-04-07 17:16:09 +00:00
nir_lower_load_const_to_scalar.c nir: Call nir_metadata_preserve on !progress 2020-06-11 05:08:12 +00:00
nir_lower_locals_to_regs.c nir: replace fnv1a hash function with xxhash 2020-05-25 19:41:09 +00:00
nir_lower_mediump_outputs.c nir: lower int16 and uint16 in nir_lower_mediump_outputs 2020-06-02 20:01:18 +00:00
nir_lower_non_uniform_access.c nir/lower_non_uniform: lower image/texture instructions taking derefs 2019-10-11 14:26:58 +00:00
nir_lower_packing.c nir: Call nir_metadata_preserve on !progress 2020-06-11 05:08:12 +00:00
nir_lower_passthrough_edgeflags.c st/mesa: assign driver locations for VS inputs for NIR before caching 2019-10-23 21:12:52 -04:00
nir_lower_patch_vertices.c
nir_lower_phis_to_scalar.c nir: Handle vec8/16 in lower_phis_to_scalar 2020-03-31 00:18:05 +00:00
nir_lower_point_size.c nir/lower_point_size: assume scalar PSIZ 2019-09-12 06:40:04 +00:00
nir_lower_point_size_mov.c nir: reuse existing psiz-variable 2020-06-04 09:12:54 +00:00
nir_lower_regs_to_ssa.c nir: Add a new helper for iterating phi sources leaving a block 2020-05-19 19:31:26 +00:00
nir_lower_returns.c nir: Call nir_metadata_preserve on !progress 2020-06-11 05:08:12 +00:00
nir_lower_samplers.c nir: Drop nir_tex_instr::texture_array_size 2020-02-26 18:29:49 +00:00
nir_lower_scratch.c nir: Call nir_metadata_preserve on !progress 2020-06-11 05:08:12 +00:00
nir_lower_ssbo.c nir/lower_ssbo: handle atomics 2020-02-21 13:06:22 +00:00
nir_lower_subgroups.c nir/lower_subgroups: Mask off unused bits in ballot ops 2020-04-24 11:37:03 +00:00
nir_lower_system_values.c nir: lower SYSTEM_VALUE_BARYCENTRIC_* to nir_load_barycentric() 2020-01-29 09:49:50 +00:00
nir_lower_tex.c nir/lower_tex: fixes for fp16 yuv lowering 2020-06-03 21:24:13 +00:00
nir_lower_to_source_mods.c util: rename list_empty() to list_is_empty() 2019-10-28 11:24:38 +00:00
nir_lower_two_sided_color.c nir/lower_two_sided_color: Fix picking of new driver location. 2020-04-23 18:52:46 +00:00
nir_lower_uniforms_to_ubo.c nir: Fix count when we didn't lower load_uniforms but did shift load_ubos. 2020-05-12 17:01:55 +00:00
nir_lower_var_copies.c nir: Call nir_metadata_preserve on !progress 2020-06-11 05:08:12 +00:00
nir_lower_variable_initializers.c nir: Call nir_metadata_preserve on !progress 2020-06-11 05:08:12 +00:00
nir_lower_vars_to_ssa.c nir: Call nir_metadata_preserve on !progress 2020-06-11 05:08:12 +00:00
nir_lower_vec_to_movs.c nir: Call nir_metadata_preserve on !progress 2020-06-11 05:08:12 +00:00
nir_lower_viewport_transform.c nir/lower_viewport: Check variable mode first 2019-07-18 14:21:41 +02:00
nir_lower_wpos_center.c intel: Use a system value for gl_FragCoord 2019-07-29 23:30:26 +00:00
nir_lower_wpos_ytransform.c nir: fix lower_wpos for 16-bit fddy 2020-06-02 20:01:18 +00:00
nir_lower_wrmasks.c nir: add pass to lower disjoint wrmask's 2020-05-13 20:24:49 -07:00
nir_metadata.c nir: Add a nir_shader_preserve_all_metadata helper 2020-06-11 05:08:12 +00:00
nir_move_vec_src_uses_to_dest.c
nir_normalize_cubemap_coords.c
nir_opcodes.py nir: add i2imp and u2ump opcodes for conversions to mediump 2020-06-02 20:01:18 +00:00
nir_opcodes_c.py nir: Drop imov/fmov in favor of one mov instruction 2019-05-24 08:38:11 -05:00
nir_opcodes_h.py
nir_opt_access.c nir: Replace the scoped_memory barrier by a scoped_barrier 2020-06-03 07:39:52 +00:00
nir_opt_algebraic.py nir: add i2imp and u2ump opcodes for conversions to mediump 2020-06-02 20:01:18 +00:00
nir_opt_barriers.c nir: Call nir_metadata_preserve on !progress 2020-06-11 05:08:12 +00:00
nir_opt_combine_stores.c nir: Call nir_metadata_preserve on !progress 2020-06-11 05:08:12 +00:00
nir_opt_comparison_pre.c nir: Call nir_metadata_preserve on !progress 2020-06-11 05:08:12 +00:00
nir_opt_conditional_discard.c nir,intel: lower if (cond) demote() to new intrinsic demote_if(cond) 2019-07-24 13:02:18 -05:00
nir_opt_constant_folding.c nir: Call nir_metadata_preserve on !progress 2020-06-11 05:08:12 +00:00
nir_opt_copy_prop_vars.c nir: Call nir_metadata_preserve on !progress 2020-06-11 05:08:12 +00:00
nir_opt_copy_propagate.c nir: Call nir_metadata_preserve on !progress 2020-06-11 05:08:12 +00:00
nir_opt_cse.c nir: Call nir_metadata_preserve on !progress 2020-06-11 05:08:12 +00:00
nir_opt_dce.c nir: Call nir_metadata_preserve on !progress 2020-06-11 05:08:12 +00:00
nir_opt_dead_cf.c nir: Call nir_metadata_preserve on !progress 2020-06-11 05:08:12 +00:00
nir_opt_dead_write_vars.c nir: Call nir_metadata_preserve on !progress 2020-06-11 05:08:12 +00:00
nir_opt_find_array_copies.c nir: Call nir_metadata_preserve on !progress 2020-06-11 05:08:12 +00:00
nir_opt_gcm.c nir/gcm: dont move movs unless we can replace them later with their src 2020-04-20 03:46:29 +00:00
nir_opt_idiv_const.c nir: Call nir_metadata_preserve on !progress 2020-06-11 05:08:12 +00:00
nir_opt_if.c nir: Call nir_metadata_preserve on !progress 2020-06-11 05:08:12 +00:00
nir_opt_intrinsics.c nir: Call nir_metadata_preserve on !progress 2020-06-11 05:08:12 +00:00
nir_opt_large_constants.c nir: Add some sanity assertions in opt_large_constants 2020-04-16 17:00:13 +00:00
nir_opt_load_store_vectorize.c nir: Replace the scoped_memory barrier by a scoped_barrier 2020-06-03 07:39:52 +00:00
nir_opt_loop_unroll.c nir/opt_loop_unroll: Fix has_nested_loop handling 2020-03-30 22:20:47 +00:00
nir_opt_move.c nir: Call nir_metadata_preserve on !progress 2020-06-11 05:08:12 +00:00
nir_opt_peephole_select.c nir: Call nir_metadata_preserve on !progress 2020-06-11 05:08:12 +00:00
nir_opt_rematerialize_compares.c nir: Call nir_metadata_preserve on !progress 2020-06-11 05:08:12 +00:00
nir_opt_remove_phis.c nir: Call nir_metadata_preserve on !progress 2020-06-11 05:08:12 +00:00
nir_opt_shrink_load.c
nir_opt_sink.c nir/sink,nir/move: move/sink nir_op_mov 2020-01-14 13:56:45 +00:00
nir_opt_trivial_continues.c nir: Call nir_metadata_preserve on !progress 2020-06-11 05:08:12 +00:00
nir_opt_undef.c nir: Call nir_metadata_preserve on !progress 2020-06-11 05:08:12 +00:00
nir_opt_vectorize.c nir: add options::vectorize_vec2_16bit to limit vectorization to vec2 16 2020-06-02 20:01:18 +00:00
nir_phi_builder.c util: Remove tmp argument from BITSET_FOREACH_SET macro 2020-01-23 01:52:43 +00:00
nir_phi_builder.h
nir_print.c nir: Fix printing execution scope of a scoped barrier 2020-06-08 15:49:24 +00:00
nir_propagate_invariant.c nir/propagate_invariant: Don't add NULL vars to the hash table 2019-06-06 00:27:53 +00:00
nir_range_analysis.c nir: replace GCC unroll with an option that works on GCC < 8.0 2020-02-27 22:53:12 -05:00
nir_range_analysis.h nir: Keep the range analysis HT around intra-pass until we make a change. 2019-10-04 19:15:01 +00:00
nir_remove_dead_variables.c nir: add callback to nir_remove_dead_variables() 2020-06-03 02:22:23 +00:00
nir_repair_ssa.c nir/repair_ssa: Replace the unreachable check with the phi builder 2019-09-23 16:19:24 +00:00
nir_schedule.c nir: Rename nir_intrinsic_barrier to control_barrier 2020-01-13 17:23:47 +00:00
nir_search.c nir: Call nir_metadata_preserve on !progress 2020-06-11 05:08:12 +00:00
nir_search.h nir: Make algebraic backtrack and reprocess after a replacement. 2019-11-26 10:13:46 -08:00
nir_search_helpers.h nir/algebraic: add patterns for a >> #b << #b 2020-01-29 14:30:33 +00:00
nir_serialize.c nir: Use 8-bit types for most info fields 2020-05-15 03:49:18 +00:00
nir_serialize.h nir: add a strip parameter to nir_serialize 2019-10-10 15:47:07 -04:00
nir_split_per_member_structs.c compiler/nir: Add support for variable initialization from a pointer 2020-02-12 15:41:49 +00:00
nir_split_var_copies.c nir: Call nir_metadata_preserve on !progress 2020-06-11 05:08:12 +00:00
nir_split_vars.c nir: Call nir_metadata_preserve on !progress 2020-06-11 05:08:12 +00:00
nir_sweep.c
nir_to_lcssa.c nir: Call nir_metadata_preserve on !progress 2020-06-11 05:08:12 +00:00
nir_validate.c nir: Validate jump instructions as an instruction type 2020-05-19 17:21:23 +00:00
nir_vla.h
nir_vulkan.h nir: add common convert_ycbcr for vulkan csc 2020-04-20 22:01:43 +00:00
nir_worklist.c
nir_worklist.h util: rename list_empty() to list_is_empty() 2019-10-28 11:24:38 +00:00
nir_xfb_info.h

README

New IR, or NIR, is an IR for Mesa intended to sit below GLSL IR and Mesa IR.
Its design inherits from the various IRs that Mesa has used in the past, as
well as Direct3D assembly, and it includes a few new ideas as well. It is a
flat (in terms of using instructions instead of expressions), typeless IR,
similar to TGSI and Mesa IR.  It also supports SSA (although it doesn't require
it).

Variables
=========

NIR includes support for source-level GLSL variables through a structure mostly
copied from GLSL IR. These will be used for linking and conversion from GLSL IR
(and later, from an AST), but for the most part, they will be lowered to
registers (see below) and loads/stores.

Registers
=========

Registers are light-weight; they consist of a structure that only contains its
size, its index for liveness analysis, and an optional name for debugging. In
addition, registers can be local to a function or global to the entire shader;
the latter will be used in ARB_shader_subroutine for passing parameters and
getting return values from subroutines. Registers can also be an array, in which
case they can be accessed indirectly. Each ALU instruction (add, subtract, etc.)
works directly with registers or SSA values (see below).

SSA
========

Everywhere a register can be loaded/stored, an SSA value can be used instead.
The only exception is that arrays/indirect addressing are not supported with
SSA; although research has been done on extensions of SSA to arrays before, it's
usually for the purpose of parallelization (which we're not interested in), and
adds some overhead in the form of adding copies or extra arrays (which is much
more expensive than introducing copies between non-array registers). SSA uses
point directly to their corresponding definition, which in turn points to the
instruction it is part of. This creates an implicit use-def chain and avoids the
need for an external structure for each SSA register.

Functions
=========

Support for function calls is mostly similar to GLSL IR. Each shader contains a
list of functions, and each function has a list of overloads. Each overload
contains a list of parameters, and may contain an implementation which specifies
the variables that correspond to the parameters and return value. Inlining a
function, assuming it has a single return point, is as simple as copying its
instructions, registers, and local variables into the target function and then
inserting copies to and from the new parameters as appropriate. After functions
are inlined and any non-subroutine functions are deleted, parameters and return
variables will be converted to global variables and then global registers. We
don't do this lowering earlier (i.e. the fortranizer idea) for a few reasons:

- If we want to do optimizations before link time, we need to have the function
signature available during link-time.

- If we do any inlining before link time, then we might wind up with the
inlined function and the non-inlined function using the same global
variables/registers which would preclude optimization.

Intrinsics
=========

Any operation (other than function calls and textures) which touches a variable
or is not referentially transparent is represented by an intrinsic. Intrinsics
are similar to the idea of a "builtin function," i.e. a function declaration
whose implementation is provided by the backend, except they are more powerful
in the following ways:

- They can also load and store registers when appropriate, which limits the
number of variables needed in later stages of the IR while obviating the need
for a separate load/store variable instruction.

- Intrinsics can be marked as side-effect free, which permits them to be
treated like any other instruction when it comes to optimizations. This allows
load intrinsics to be represented as intrinsics while still being optimized
away by dead code elimination, common subexpression elimination, etc.

Intrinsics are used for:

- Atomic operations
- Memory barriers
- Subroutine calls
- Geometry shader emitVertex and endPrimitive
- Loading and storing variables (before lowering)
- Loading and storing uniforms, shader inputs and outputs, etc (after lowering)
- Copying variables (cases where in GLSL the destination is a structure or
array)
- The kitchen sink
- ...

Textures
=========

Unfortunately, there are far too many texture operations to represent each one
of them with an intrinsic, so there's a special texture instruction similar to
the GLSL IR one. The biggest difference is that, while the texture instruction
has a sampler dereference field used just like in GLSL IR, this gets lowered to
a texture unit index (with a possible indirect offset) while the type
information of the original sampler is kept around for backends. Also, all the
non-constant sources are stored in a single array to make it easier for
optimization passes to iterate over all the sources.

Control Flow
=========

Like in GLSL IR, control flow consists of a tree of "control flow nodes", which
include if statements and loops, and jump instructions (break, continue, and
return). Unlike GLSL IR, though, the leaves of the tree aren't statements but
basic blocks. Each basic block also keeps track of its successors and
predecessors, and function implementations keep track of the beginning basic
block (the first basic block of the function) and the ending basic block (a fake
basic block that every return statement points to). Together, these elements
make up the control flow graph, in this case a redundant piece of information on
top of the control flow tree that will be used by almost all the optimizations.
There are helper functions to add and remove control flow nodes that also update
the control flow graph, and so usually it doesn't need to be touched by passes
that modify control flow nodes.