2 * Copyright © 2015 Red Hat
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 FROM,
20 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
26 #include "pipe/p_defines.h"
27 #include "pipe/p_screen.h"
28 #include "pipe/p_context.h"
30 #include "program/program.h"
31 #include "program/prog_statevars.h"
32 #include "program/prog_parameter.h"
33 #include "program/ir_to_mesa.h"
34 #include "main/mtypes.h"
35 #include "main/errors.h"
36 #include "main/shaderapi.h"
37 #include "main/uniforms.h"
38 #include "util/string_to_uint_map.h"
40 #include "st_context.h"
41 #include "st_program.h"
42 #include "st_glsl_types.h"
44 #include "compiler/nir/nir.h"
45 #include "compiler/glsl_types.h"
46 #include "compiler/glsl/glsl_to_nir.h"
47 #include "compiler/glsl/ir.h"
50 /* Depending on PIPE_CAP_TGSI_TEXCOORD (st->needs_texcoord_semantic) we
51 * may need to fix up varying slots so the glsl->nir path is aligned
52 * with the anything->tgsi->nir path.
55 st_nir_fixup_varying_slots(struct st_context
*st
, struct exec_list
*var_list
)
57 if (st
->needs_texcoord_semantic
)
60 nir_foreach_variable(var
, var_list
) {
61 if (var
->data
.location
>= VARYING_SLOT_VAR0
) {
62 var
->data
.location
+= 9;
63 } else if ((var
->data
.location
>= VARYING_SLOT_TEX0
) &&
64 (var
->data
.location
<= VARYING_SLOT_TEX7
)) {
65 var
->data
.location
+= VARYING_SLOT_VAR0
- VARYING_SLOT_TEX0
;
70 /* input location assignment for VS inputs must be handled specially, so
71 * that it is aligned w/ st's vbo state.
72 * (This isn't the case with, for ex, FS inputs, which only need to agree
73 * on varying-slot w/ the VS outputs)
76 st_nir_assign_vs_in_locations(struct gl_program
*prog
, nir_shader
*nir
)
78 unsigned attr
, num_inputs
= 0;
79 unsigned input_to_index
[VERT_ATTRIB_MAX
] = {0};
81 /* TODO de-duplicate w/ similar code in st_translate_vertex_program()? */
82 for (attr
= 0; attr
< VERT_ATTRIB_MAX
; attr
++) {
83 if ((prog
->InputsRead
& BITFIELD64_BIT(attr
)) != 0) {
84 input_to_index
[attr
] = num_inputs
;
86 if ((prog
->DoubleInputsRead
& BITFIELD64_BIT(attr
)) != 0) {
87 /* add placeholder for second part of a double attribute */
91 input_to_index
[attr
] = ~0;
96 nir_foreach_variable_safe(var
, &nir
->inputs
) {
97 attr
= var
->data
.location
;
98 assert(attr
< ARRAY_SIZE(input_to_index
));
100 if (input_to_index
[attr
] != ~0u) {
101 var
->data
.driver_location
= input_to_index
[attr
];
104 /* Move unused input variables to the globals list (with no
105 * initialization), to avoid confusing drivers looking through the
106 * inputs array and expecting to find inputs with a driver_location
109 exec_node_remove(&var
->node
);
110 var
->data
.mode
= nir_var_global
;
111 exec_list_push_tail(&nir
->globals
, &var
->node
);
117 st_nir_lookup_parameter_index(const struct gl_program_parameter_list
*params
,
120 int loc
= _mesa_lookup_parameter_index(params
, name
);
122 /* is there a better way to do this? If we have something like:
130 * Then what we get in prog->Parameters looks like:
132 * 0: Name=color.f, Type=6, DataType=1406, Size=1
133 * 1: Name=color.v, Type=6, DataType=8b52, Size=4
135 * So the name doesn't match up and _mesa_lookup_parameter_index()
136 * fails. In this case just find the first matching "color.*"..
138 * Note for arrays you could end up w/ color[n].f, for example.
140 * glsl_to_tgsi works slightly differently in this regard. It is
141 * emitting something more low level, so it just translates the
142 * params list 1:1 to CONST[] regs. Going from GLSL IR to TGSI,
143 * it just calculates the additional offset of struct field members
144 * in glsl_to_tgsi_visitor::visit(ir_dereference_record *ir) or
145 * glsl_to_tgsi_visitor::visit(ir_dereference_array *ir). It never
146 * needs to work backwards to get base var loc from the param-list
147 * which already has them separated out.
150 int namelen
= strlen(name
);
151 for (unsigned i
= 0; i
< params
->NumParameters
; i
++) {
152 struct gl_program_parameter
*p
= ¶ms
->Parameters
[i
];
153 if ((strncmp(p
->Name
, name
, namelen
) == 0) &&
154 ((p
->Name
[namelen
] == '.') || (p
->Name
[namelen
] == '['))) {
165 st_nir_assign_uniform_locations(struct gl_program
*prog
,
166 struct gl_shader_program
*shader_program
,
167 struct exec_list
*uniform_list
, unsigned *size
)
172 nir_foreach_variable(uniform
, uniform_list
) {
176 * UBO's have their own address spaces, so don't count them towards the
177 * number of global uniforms
179 if ((uniform
->data
.mode
== nir_var_uniform
|| uniform
->data
.mode
== nir_var_shader_storage
) &&
180 uniform
->interface_type
!= NULL
)
183 if (uniform
->type
->is_sampler()) {
185 bool found
= shader_program
->UniformHash
->get(val
, uniform
->name
);
188 /* this ensure that nir_lower_samplers looks at the correct
189 * shader_program->UniformStorage[location]:
191 uniform
->data
.location
= val
;
192 } else if (strncmp(uniform
->name
, "gl_", 3) == 0) {
193 const gl_state_index
*const stateTokens
= (gl_state_index
*)uniform
->state_slots
[0].tokens
;
194 /* This state reference has already been setup by ir_to_mesa, but we'll
195 * get the same index back here.
197 loc
= _mesa_add_state_reference(prog
->Parameters
, stateTokens
);
199 loc
= st_nir_lookup_parameter_index(prog
->Parameters
, uniform
->name
);
202 uniform
->data
.driver_location
= loc
;
204 max
= MAX2(max
, loc
+ st_glsl_type_size(uniform
->type
));
211 /* First half of converting glsl_to_nir.. this leaves things in a pre-
212 * nir_lower_io state, so that shader variants can more easily insert/
213 * replace variables, etc.
216 st_glsl_to_nir(struct st_context
*st
, struct gl_program
*prog
,
217 struct gl_shader_program
*shader_program
,
218 gl_shader_stage stage
)
220 struct pipe_screen
*pscreen
= st
->pipe
->screen
;
221 enum pipe_shader_type ptarget
= st_shader_stage_to_ptarget(stage
);
222 const nir_shader_compiler_options
*options
;
225 assert(pscreen
->get_compiler_options
); /* drivers using NIR must implement this */
227 options
= (const nir_shader_compiler_options
*)
228 pscreen
->get_compiler_options(pscreen
, PIPE_SHADER_IR_NIR
, ptarget
);
234 nir
= glsl_to_nir(shader_program
, stage
, options
);
237 NIR_PASS_V(nir
, nir_lower_io_to_temporaries
,
238 nir_shader_get_entrypoint(nir
),
240 NIR_PASS_V(nir
, nir_lower_global_vars_to_local
);
241 NIR_PASS_V(nir
, nir_split_var_copies
);
242 NIR_PASS_V(nir
, nir_lower_var_copies
);
243 NIR_PASS_V(nir
, st_nir_lower_builtin
);
245 /* fragment shaders may need : */
246 if (stage
== MESA_SHADER_FRAGMENT
) {
247 static const gl_state_index wposTransformState
[STATE_LENGTH
] = {
248 STATE_INTERNAL
, STATE_FB_WPOS_Y_TRANSFORM
250 nir_lower_wpos_ytransform_options wpos_options
= {0};
251 struct pipe_screen
*pscreen
= st
->pipe
->screen
;
253 memcpy(wpos_options
.state_tokens
, wposTransformState
,
254 sizeof(wpos_options
.state_tokens
));
255 wpos_options
.fs_coord_origin_upper_left
=
256 pscreen
->get_param(pscreen
, PIPE_CAP_TGSI_FS_COORD_ORIGIN_UPPER_LEFT
);
257 wpos_options
.fs_coord_origin_lower_left
=
258 pscreen
->get_param(pscreen
, PIPE_CAP_TGSI_FS_COORD_ORIGIN_LOWER_LEFT
);
259 wpos_options
.fs_coord_pixel_center_integer
=
260 pscreen
->get_param(pscreen
, PIPE_CAP_TGSI_FS_COORD_PIXEL_CENTER_INTEGER
);
261 wpos_options
.fs_coord_pixel_center_half_integer
=
262 pscreen
->get_param(pscreen
, PIPE_CAP_TGSI_FS_COORD_PIXEL_CENTER_HALF_INTEGER
);
264 if (nir_lower_wpos_ytransform(nir
, &wpos_options
)) {
265 nir_validate_shader(nir
);
266 _mesa_add_state_reference(prog
->Parameters
, wposTransformState
);
270 if (st
->ctx
->_Shader
->Flags
& GLSL_DUMP
) {
272 _mesa_log("NIR IR for linked %s program %d:\n",
273 _mesa_shader_stage_to_string(stage
),
274 shader_program
->Name
);
275 nir_print_shader(nir
, _mesa_get_log_file());
282 /* TODO any better helper somewhere to sort a list? */
285 insert_sorted(struct exec_list
*var_list
, nir_variable
*new_var
)
287 nir_foreach_variable(var
, var_list
) {
288 if (var
->data
.location
> new_var
->data
.location
) {
289 exec_node_insert_node_before(&var
->node
, &new_var
->node
);
293 exec_list_push_tail(var_list
, &new_var
->node
);
297 sort_varyings(struct exec_list
*var_list
)
299 struct exec_list new_list
;
300 exec_list_make_empty(&new_list
);
301 nir_foreach_variable_safe(var
, var_list
) {
302 exec_node_remove(&var
->node
);
303 insert_sorted(&new_list
, var
);
305 exec_list_move_nodes_to(&new_list
, var_list
);
308 /* Second half of preparing nir from glsl, which happens after shader
312 st_finalize_nir(struct st_context
*st
, struct gl_program
*prog
, nir_shader
*nir
)
314 NIR_PASS_V(nir
, nir_split_var_copies
);
315 NIR_PASS_V(nir
, nir_lower_var_copies
);
316 NIR_PASS_V(nir
, nir_lower_io_types
);
318 if (nir
->stage
== MESA_SHADER_VERTEX
) {
319 /* Needs special handling so drvloc matches the vbo state: */
320 st_nir_assign_vs_in_locations(prog
, nir
);
321 /* Re-lower global vars, to deal with any dead VS inputs. */
322 NIR_PASS_V(nir
, nir_lower_global_vars_to_local
);
324 sort_varyings(&nir
->outputs
);
325 nir_assign_var_locations(&nir
->outputs
,
329 st_nir_fixup_varying_slots(st
, &nir
->outputs
);
330 } else if (nir
->stage
== MESA_SHADER_FRAGMENT
) {
331 sort_varyings(&nir
->inputs
);
332 nir_assign_var_locations(&nir
->inputs
,
336 st_nir_fixup_varying_slots(st
, &nir
->inputs
);
337 nir_assign_var_locations(&nir
->outputs
,
342 unreachable("invalid shader type for tgsi bypass\n");
345 struct gl_shader_program
*shader_program
;
346 switch (nir
->stage
) {
347 case MESA_SHADER_VERTEX
:
348 shader_program
= ((struct st_vertex_program
*)prog
)->shader_program
;
350 case MESA_SHADER_FRAGMENT
:
351 shader_program
= ((struct st_fragment_program
*)prog
)->shader_program
;
354 assert(!"should not be reached");
358 st_nir_assign_uniform_locations(prog
, shader_program
,
359 &nir
->uniforms
, &nir
->num_uniforms
);
361 NIR_PASS_V(nir
, nir_lower_system_values
);
362 NIR_PASS_V(nir
, nir_lower_io
, nir_var_all
, st_glsl_type_size
,
363 (nir_lower_io_options
)0);
364 NIR_PASS_V(nir
, nir_lower_samplers
, shader_program
);
368 st_nir_get_mesa_program(struct gl_context
*ctx
,
369 struct gl_shader_program
*shader_program
,
370 struct gl_linked_shader
*shader
)
372 struct gl_program
*prog
;
373 GLenum target
= _mesa_shader_stage_to_program(shader
->Stage
);
375 validate_ir_tree(shader
->ir
);
377 prog
= ctx
->Driver
.NewProgram(ctx
, target
, shader_program
->Name
);
381 _mesa_reference_program(ctx
, &shader
->Program
, prog
);
383 prog
->Parameters
= _mesa_new_parameter_list();
385 _mesa_copy_linked_program_data(shader_program
, shader
);
386 _mesa_generate_parameters_list_for_uniforms(shader_program
, shader
,
389 /* Make a pass over the IR to add state references for any built-in
390 * uniforms that are used. This has to be done now (during linking).
391 * Code generation doesn't happen until the first time this shader is
392 * used for rendering. Waiting until then to generate the parameters is
393 * too late. At that point, the values for the built-in uniforms won't
394 * get sent to the shader.
396 foreach_in_list(ir_instruction
, node
, shader
->ir
) {
397 ir_variable
*var
= node
->as_variable();
399 if ((var
== NULL
) || (var
->data
.mode
!= ir_var_uniform
) ||
400 (strncmp(var
->name
, "gl_", 3) != 0))
403 const ir_state_slot
*const slots
= var
->get_state_slots();
404 assert(slots
!= NULL
);
406 for (unsigned int i
= 0; i
< var
->get_num_state_slots(); i
++) {
407 _mesa_add_state_reference(prog
->Parameters
,
408 (gl_state_index
*) slots
[i
].tokens
);
412 if (ctx
->_Shader
->Flags
& GLSL_DUMP
) {
414 _mesa_log("GLSL IR for linked %s program %d:\n",
415 _mesa_shader_stage_to_string(shader
->Stage
),
416 shader_program
->Name
);
417 _mesa_print_ir(_mesa_get_log_file(), shader
->ir
, NULL
);
421 prog
->Instructions
= NULL
;
422 prog
->NumInstructions
= 0;
424 do_set_program_inouts(shader
->ir
, prog
, shader
->Stage
);
426 prog
->SamplersUsed
= shader
->active_samplers
;
427 prog
->ShadowSamplers
= shader
->shadow_samplers
;
428 prog
->ExternalSamplersUsed
= gl_external_samplers(shader
);
429 _mesa_update_shader_textures_used(shader_program
, prog
);
431 /* Avoid reallocation of the program parameter list, because the uniform
432 * storage is only associated with the original parameter list.
433 * This should be enough for Bitmap and DrawPixels constants.
435 _mesa_reserve_parameter_storage(prog
->Parameters
, 8);
437 /* This has to be done last. Any operation the can cause
438 * prog->ParameterValues to get reallocated (e.g., anything that adds a
439 * program constant) has to happen before creating this linkage.
441 _mesa_associate_uniform_storage(ctx
, shader_program
, prog
->Parameters
);
443 struct st_vertex_program
*stvp
;
444 struct st_fragment_program
*stfp
;
446 switch (shader
->Stage
) {
447 case MESA_SHADER_VERTEX
:
448 stvp
= (struct st_vertex_program
*)prog
;
449 stvp
->shader_program
= shader_program
;
451 case MESA_SHADER_FRAGMENT
:
452 stfp
= (struct st_fragment_program
*)prog
;
453 stfp
->shader_program
= shader_program
;
456 assert(!"should not be reached");