mesa/src/compiler/nir
Kenneth Graunke 2d8a3fa7ea nir: Report progress from nir_lower_phis_to_scalar.
Signed-off-by: Kenneth Graunke <kenneth@whitecape.org>
Reviewed-by: Eric Anholt <eric@anholt.net>
2016-09-14 12:01:51 -07:00
..
tests nir/tests: Update the CF tests to not assume fake edges 2016-09-04 20:44:59 -07:00
.gitignore
README
nir.c nir: move tex_instr_remove_src 2016-09-14 13:45:32 -04:00
nir.h nir: Report progress from nir_lower_phis_to_scalar. 2016-09-14 12:01:51 -07:00
nir_algebraic.py nir/algebraic: support for power-of-two optimizations 2016-06-03 16:05:03 -04:00
nir_array.h
nir_builder.h nir: Add nir_builder support for individual system value loads. 2016-08-19 13:11:36 -07:00
nir_builder_opcodes_h.py nir/builder: Generate the alu helpers directly in python 2016-05-14 13:34:38 -07:00
nir_clone.c nir: Switch the arguments to nir_foreach_function 2016-04-28 15:54:48 -07:00
nir_constant_expressions.h nir: update opcode definitions for different bit sizes 2016-03-17 11:16:33 +01:00
nir_constant_expressions.py nir: Make nir_const_value a union 2016-05-26 16:03:44 -07:00
nir_control_flow.c nir: remove unused variable 2016-09-03 20:30:19 +10:00
nir_control_flow.h
nir_control_flow_private.h
nir_dominance.c nir: Switch the arguments to nir_foreach_function 2016-04-28 15:54:48 -07:00
nir_from_ssa.c nir: Switch the arguments to nir_foreach_function 2016-04-28 15:54:48 -07:00
nir_gather_info.c nir/info: Get rid of uses_interp_var_at_offset 2016-06-03 19:29:28 -07:00
nir_gs_count_vertices.c nir: Switch the arguments to nir_foreach_function 2016-04-28 15:54:48 -07:00
nir_inline_functions.c nir/inline: Constant-initialize local variables in the callee if needed 2016-07-20 15:29:55 -07:00
nir_instr_set.c nir: Make nir_alu_srcs_equal non-static. 2016-08-04 00:41:07 -07:00
nir_instr_set.h
nir_intrinsics.c nir: const_index helpers 2016-02-09 17:30:33 -05:00
nir_intrinsics.h nir: Define system values for vc4's blending-lowering arguments. 2016-08-22 11:52:26 -07:00
nir_liveness.c nir: Switch the arguments to nir_foreach_phi_src 2016-04-28 15:54:48 -07:00
nir_lower_alu_to_scalar.c nir: Report progress from nir_lower_alu_to_scalar. 2016-09-14 12:01:49 -07:00
nir_lower_atomics.c nir: Switch the arguments to nir_foreach_function 2016-04-28 15:54:48 -07:00
nir_lower_bitmap.c nir: Update shader info when adding discards 2016-08-29 10:56:59 -07:00
nir_lower_clamp_color_outputs.c nir: Strengthen assertion that 'out' is nonnull. 2016-05-25 12:44:34 -07:00
nir_lower_clip.c nir: Update shader info when adding discards 2016-08-29 10:56:59 -07:00
nir_lower_double_ops.c nir/lower_double_ops: fixup for new nir_foreach_block() 2016-05-05 16:19:41 -07:00
nir_lower_double_packing.c nir: Remove spurious return from void function. 2016-05-06 12:03:34 +01:00
nir_lower_drawpixels.c nir: Fix crash in nir_lower_drawpixels. 2016-08-22 11:52:27 -07:00
nir_lower_global_vars_to_local.c nir: Switch the arguments to nir_foreach_function 2016-04-28 15:54:48 -07:00
nir_lower_gs_intrinsics.c nir: Switch the arguments to nir_foreach_function 2016-04-28 15:54:48 -07:00
nir_lower_idiv.c nir: return progress from lower_idiv 2016-05-15 17:25:48 -04:00
nir_lower_indirect_derefs.c nir/lower_indirect_derefs: Use the direct array deref for recursion 2016-06-03 19:29:28 -07:00
nir_lower_io.c nir: Lower interp_var_at_* like a normal load_var for flat inputs. 2016-07-22 20:31:20 -07:00
nir_lower_io_to_scalar.c nir: Add an IO scalarizing pass using the intrinsic's first_component. 2016-08-19 13:11:36 -07:00
nir_lower_io_to_temporaries.c nir: Change nir_shader_get_entrypoint to return an impl. 2016-08-25 19:18:24 -07:00
nir_lower_io_types.c nir: lower-io-types pass 2016-05-11 12:20:11 -04:00
nir_lower_load_const_to_scalar.c nir: Switch the arguments to nir_foreach_function 2016-04-28 15:54:48 -07:00
nir_lower_locals_to_regs.c nir: glsl_get_bit_size() should take glsl_type 2016-05-12 13:39:40 -04:00
nir_lower_passthrough_edgeflags.c nir: Change nir_shader_get_entrypoint to return an impl. 2016-08-25 19:18:24 -07:00
nir_lower_phis_to_scalar.c nir: Report progress from nir_lower_phis_to_scalar. 2016-09-14 12:01:51 -07:00
nir_lower_returns.c nir: Switch the arguments to nir_foreach_function 2016-04-28 15:54:48 -07:00
nir_lower_samplers.c nir: Drop an unused program/hash_table.h include. 2016-08-10 12:27:22 -07:00
nir_lower_system_values.c nir: Add nir_builder support for individual system value loads. 2016-08-19 13:11:36 -07:00
nir_lower_tex.c nir/lower_tex: fix typo with sample_dim 2016-09-14 13:45:32 -04:00
nir_lower_to_source_mods.c nir: Switch the arguments to nir_foreach_use and friends 2016-04-28 15:54:48 -07:00
nir_lower_two_sided_color.c nir: Add nir_builder support for individual system value loads. 2016-08-19 13:11:36 -07:00
nir_lower_var_copies.c nir: glsl_get_bit_size() should take glsl_type 2016-05-12 13:39:40 -04:00
nir_lower_vars_to_ssa.c nir: Walk blocks in source code order in lower_vars_to_ssa. 2016-08-25 13:45:39 -07:00
nir_lower_vec_to_movs.c nir: Silence unused parameter warnings 2016-05-12 16:46:41 -07:00
nir_lower_wpos_center.c nir: Fix crash in nir_lower_wpos_center(). 2016-05-20 16:33:24 -07:00
nir_lower_wpos_ytransform.c Remove wrongly repeated words in comments 2016-06-23 13:55:03 -07:00
nir_metadata.c nir: Switch the arguments to nir_foreach_function 2016-04-28 15:54:48 -07:00
nir_move_vec_src_uses_to_dest.c nir: Switch the arguments to nir_foreach_use and friends 2016-04-28 15:54:48 -07:00
nir_normalize_cubemap_coords.c nir: Switch the arguments to nir_foreach_function 2016-04-28 15:54:48 -07:00
nir_opcodes.py nir: fix definition of pack_uvec2_to_uint 2016-09-06 22:45:44 -04:00
nir_opcodes_c.py
nir_opcodes_h.py
nir_opt_algebraic.py nir: Rely on the fact that bcsel takes a well formed boolean. 2016-08-19 02:05:23 -07:00
nir_opt_constant_folding.c nir: Switch the arguments to nir_foreach_function 2016-04-28 15:54:48 -07:00
nir_opt_copy_propagate.c nir: Fix copy_prop_src when src is an indirect access on a reg. 2016-06-26 15:38:09 -07:00
nir_opt_cse.c nir: Switch the arguments to nir_foreach_function 2016-04-28 15:54:48 -07:00
nir_opt_dce.c nir: Switch the arguments to nir_foreach_function 2016-04-28 15:54:48 -07:00
nir_opt_dead_cf.c nir/dead_cf: Don't crash on unreachable after-loop blocks 2016-09-02 11:24:09 -07:00
nir_opt_gcm.c nir/gcm: Add global value numbering support 2016-09-08 20:53:01 -07:00
nir_opt_global_to_local.c nir: Switch the arguments to nir_foreach_def 2016-04-28 15:54:48 -07:00
nir_opt_peephole_select.c nir: Allow opt_peephole_select to work on empty blocks. 2016-08-03 10:25:08 -07:00
nir_opt_remove_phis.c nir: fix bug with moves in nir_opt_remove_phis() 2016-09-03 00:37:48 -04:00
nir_opt_undef.c nir: Turn imov/fmov of undef into undef. 2016-08-04 00:40:59 -07:00
nir_phi_builder.c nir/phi_builder: Don't recurse in value_get_block_def 2016-08-25 14:08:07 -07:00
nir_phi_builder.h nir: Walk blocks in source code order in lower_vars_to_ssa. 2016-08-25 13:45:39 -07:00
nir_print.c nir: Always print non-identity swizzles. 2016-08-08 17:52:35 -07:00
nir_propagate_invariant.c nir: Add a pass for propagating invariant decorations 2016-06-20 12:02:45 -07:00
nir_remove_dead_variables.c nir: Switch the arguments to nir_foreach_function 2016-04-28 15:54:48 -07:00
nir_repair_ssa.c nir: Switch the arguments to nir_foreach_use and friends 2016-04-28 15:54:48 -07:00
nir_search.c nir/search: Extend 'a@bool' to handle a couple of system values. 2016-08-18 01:27:27 -07:00
nir_search.h nir/algebraic: support for power-of-two optimizations 2016-06-03 16:05:03 -04:00
nir_search_helpers.h nir/algebraic: support for power-of-two optimizations 2016-06-03 16:05:03 -04:00
nir_split_var_copies.c nir: Switch the arguments to nir_foreach_function 2016-04-28 15:54:48 -07:00
nir_sweep.c nir: Switch the arguments to nir_foreach_instr 2016-04-28 15:54:48 -07:00
nir_to_ssa.c nir: Switch the arguments to nir_foreach_def 2016-04-28 15:54:48 -07:00
nir_validate.c nir: avoid segfault when ssa src not found 2016-08-23 09:06:29 +10:00
nir_vla.h
nir_worklist.c nir/nir_worklist: fixup for new foreach_block() 2016-04-28 15:52:17 -07:00
nir_worklist.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 IR's 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.