2 * Mesa 3-D graphics library
4 * Copyright (C) 1999-2007 Brian Paul All Rights Reserved.
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the "Software"),
8 * to deal in the Software without restriction, including without limitation
9 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10 * and/or sell copies of the Software, and to permit persons to whom the
11 * Software is furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included
14 * in all copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
17 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
20 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
22 * OTHER DEALINGS IN THE SOFTWARE.
27 * Vertex and fragment program support functions.
32 #include "main/glheader.h"
33 #include "main/context.h"
34 #include "main/framebuffer.h"
35 #include "main/hash.h"
36 #include "main/macros.h"
37 #include "main/shaderobj.h"
39 #include "prog_cache.h"
40 #include "prog_parameter.h"
41 #include "prog_instruction.h"
42 #include "util/ralloc.h"
43 #include "util/u_atomic.h"
47 * A pointer to this dummy program is put into the hash table when
48 * glGenPrograms is called.
50 struct gl_program _mesa_DummyProgram
;
54 * Init context's vertex/fragment program state
57 _mesa_init_program(struct gl_context
*ctx
)
60 * If this assertion fails, we need to increase the field
61 * size for register indexes (see INST_INDEX_BITS).
63 assert(ctx
->Const
.Program
[MESA_SHADER_VERTEX
].MaxUniformComponents
/ 4
64 <= (1 << INST_INDEX_BITS
));
65 assert(ctx
->Const
.Program
[MESA_SHADER_FRAGMENT
].MaxUniformComponents
/ 4
66 <= (1 << INST_INDEX_BITS
));
68 assert(ctx
->Const
.Program
[MESA_SHADER_VERTEX
].MaxTemps
<= (1 << INST_INDEX_BITS
));
69 assert(ctx
->Const
.Program
[MESA_SHADER_VERTEX
].MaxLocalParams
<= (1 << INST_INDEX_BITS
));
70 assert(ctx
->Const
.Program
[MESA_SHADER_FRAGMENT
].MaxTemps
<= (1 << INST_INDEX_BITS
));
71 assert(ctx
->Const
.Program
[MESA_SHADER_FRAGMENT
].MaxLocalParams
<= (1 << INST_INDEX_BITS
));
73 assert(ctx
->Const
.Program
[MESA_SHADER_VERTEX
].MaxUniformComponents
<= 4 * MAX_UNIFORMS
);
74 assert(ctx
->Const
.Program
[MESA_SHADER_FRAGMENT
].MaxUniformComponents
<= 4 * MAX_UNIFORMS
);
76 assert(ctx
->Const
.Program
[MESA_SHADER_VERTEX
].MaxAddressOffset
<= (1 << INST_INDEX_BITS
));
77 assert(ctx
->Const
.Program
[MESA_SHADER_FRAGMENT
].MaxAddressOffset
<= (1 << INST_INDEX_BITS
));
79 /* If this fails, increase prog_instruction::TexSrcUnit size */
80 STATIC_ASSERT(MAX_TEXTURE_UNITS
<= (1 << 5));
82 /* If this fails, increase prog_instruction::TexSrcTarget size */
83 STATIC_ASSERT(NUM_TEXTURE_TARGETS
<= (1 << 4));
85 ctx
->Program
.ErrorPos
= -1;
86 ctx
->Program
.ErrorString
= strdup("");
88 ctx
->VertexProgram
.Enabled
= GL_FALSE
;
89 ctx
->VertexProgram
.PointSizeEnabled
=
90 (ctx
->API
== API_OPENGLES2
) ? GL_TRUE
: GL_FALSE
;
91 ctx
->VertexProgram
.TwoSideEnabled
= GL_FALSE
;
92 _mesa_reference_program(ctx
, &ctx
->VertexProgram
.Current
,
93 ctx
->Shared
->DefaultVertexProgram
);
94 assert(ctx
->VertexProgram
.Current
);
95 ctx
->VertexProgram
.Cache
= _mesa_new_program_cache();
97 ctx
->FragmentProgram
.Enabled
= GL_FALSE
;
98 _mesa_reference_program(ctx
, &ctx
->FragmentProgram
.Current
,
99 ctx
->Shared
->DefaultFragmentProgram
);
100 assert(ctx
->FragmentProgram
.Current
);
101 ctx
->FragmentProgram
.Cache
= _mesa_new_program_cache();
103 /* XXX probably move this stuff */
104 ctx
->ATIFragmentShader
.Enabled
= GL_FALSE
;
105 ctx
->ATIFragmentShader
.Current
= ctx
->Shared
->DefaultFragmentShader
;
106 assert(ctx
->ATIFragmentShader
.Current
);
107 ctx
->ATIFragmentShader
.Current
->RefCount
++;
112 * Free a context's vertex/fragment program state
115 _mesa_free_program_data(struct gl_context
*ctx
)
117 _mesa_reference_program(ctx
, &ctx
->VertexProgram
.Current
, NULL
);
118 _mesa_delete_program_cache(ctx
, ctx
->VertexProgram
.Cache
);
119 _mesa_reference_program(ctx
, &ctx
->FragmentProgram
.Current
, NULL
);
120 _mesa_delete_shader_cache(ctx
, ctx
->FragmentProgram
.Cache
);
122 /* XXX probably move this stuff */
123 if (ctx
->ATIFragmentShader
.Current
) {
124 ctx
->ATIFragmentShader
.Current
->RefCount
--;
125 if (ctx
->ATIFragmentShader
.Current
->RefCount
<= 0) {
126 free(ctx
->ATIFragmentShader
.Current
);
130 free((void *) ctx
->Program
.ErrorString
);
135 * Update the default program objects in the given context to reference those
136 * specified in the shared state and release those referencing the old
140 _mesa_update_default_objects_program(struct gl_context
*ctx
)
142 _mesa_reference_program(ctx
, &ctx
->VertexProgram
.Current
,
143 ctx
->Shared
->DefaultVertexProgram
);
144 assert(ctx
->VertexProgram
.Current
);
146 _mesa_reference_program(ctx
, &ctx
->FragmentProgram
.Current
,
147 ctx
->Shared
->DefaultFragmentProgram
);
148 assert(ctx
->FragmentProgram
.Current
);
150 /* XXX probably move this stuff */
151 if (ctx
->ATIFragmentShader
.Current
) {
152 ctx
->ATIFragmentShader
.Current
->RefCount
--;
153 if (ctx
->ATIFragmentShader
.Current
->RefCount
<= 0) {
154 free(ctx
->ATIFragmentShader
.Current
);
157 ctx
->ATIFragmentShader
.Current
= (struct ati_fragment_shader
*) ctx
->Shared
->DefaultFragmentShader
;
158 assert(ctx
->ATIFragmentShader
.Current
);
159 ctx
->ATIFragmentShader
.Current
->RefCount
++;
164 * Set the vertex/fragment program error state (position and error string).
165 * This is generally called from within the parsers.
168 _mesa_set_program_error(struct gl_context
*ctx
, GLint pos
, const char *string
)
170 ctx
->Program
.ErrorPos
= pos
;
171 free((void *) ctx
->Program
.ErrorString
);
174 ctx
->Program
.ErrorString
= strdup(string
);
179 * Initialize a new gl_program object.
182 _mesa_init_gl_program(struct gl_program
*prog
, GLenum target
, GLuint id
,
188 memset(prog
, 0, sizeof(*prog
));
190 prog
->Target
= target
;
192 prog
->Format
= GL_PROGRAM_FORMAT_ASCII_ARB
;
193 prog
->info
.stage
= _mesa_program_enum_to_shader_stage(target
);
194 prog
->is_arb_asm
= is_arb_asm
;
196 /* Uniforms that lack an initializer in the shader code have an initial
197 * value of zero. This includes sampler uniforms.
199 * Page 24 (page 30 of the PDF) of the GLSL 1.20 spec says:
201 * "The link time initial value is either the value of the variable's
202 * initializer, if present, or 0 if no initializer is present. Sampler
203 * types cannot have initializers."
205 * So we only initialise ARB assembly style programs.
208 /* default mapping from samplers to texture units */
209 for (unsigned i
= 0; i
< MAX_SAMPLERS
; i
++)
210 prog
->SamplerUnits
[i
] = i
;
218 * Allocate and initialize a new fragment/vertex program object but
219 * don't put it into the program hash table. Called via
220 * ctx->Driver.NewProgram. May be overridden (ie. replaced) by a
221 * device driver function to implement OO deriviation with additional
222 * types not understood by this function.
225 * \param id program id/number
226 * \param target program target/type
227 * \return pointer to new program object
230 _mesa_new_program(struct gl_context
*ctx
, GLenum target
, GLuint id
,
234 case GL_VERTEX_PROGRAM_ARB
: /* == GL_VERTEX_PROGRAM_NV */
235 case GL_GEOMETRY_PROGRAM_NV
:
236 case GL_TESS_CONTROL_PROGRAM_NV
:
237 case GL_TESS_EVALUATION_PROGRAM_NV
:
238 case GL_FRAGMENT_PROGRAM_ARB
:
239 case GL_COMPUTE_PROGRAM_NV
: {
240 struct gl_program
*prog
= rzalloc(NULL
, struct gl_program
);
241 return _mesa_init_gl_program(prog
, target
, id
, is_arb_asm
);
244 _mesa_problem(ctx
, "bad target in _mesa_new_program");
251 * Delete a program and remove it from the hash table, ignoring the
253 * Called via ctx->Driver.DeleteProgram. May be wrapped (OO deriviation)
254 * by a device driver function.
257 _mesa_delete_program(struct gl_context
*ctx
, struct gl_program
*prog
)
261 assert(prog
->RefCount
==0);
263 if (prog
== &_mesa_DummyProgram
)
266 if (prog
->Parameters
) {
267 _mesa_free_parameter_list(prog
->Parameters
);
271 ralloc_free(prog
->nir
);
274 if (prog
->sh
.BindlessSamplers
) {
275 ralloc_free(prog
->sh
.BindlessSamplers
);
278 if (prog
->sh
.BindlessImages
) {
279 ralloc_free(prog
->sh
.BindlessImages
);
287 * Return the gl_program object for a given ID.
288 * Basically just a wrapper for _mesa_HashLookup() to avoid a lot of
292 _mesa_lookup_program(struct gl_context
*ctx
, GLuint id
)
295 return (struct gl_program
*) _mesa_HashLookup(ctx
->Shared
->Programs
, id
);
302 * Reference counting for vertex/fragment programs
303 * This is normally only called from the _mesa_reference_program() macro
304 * when there's a real pointer change.
307 _mesa_reference_program_(struct gl_context
*ctx
,
308 struct gl_program
**ptr
,
309 struct gl_program
*prog
)
315 if ((*ptr
)->Target
== GL_VERTEX_PROGRAM_ARB
)
316 assert(prog
->Target
== GL_VERTEX_PROGRAM_ARB
);
317 else if ((*ptr
)->Target
== GL_FRAGMENT_PROGRAM_ARB
)
318 assert(prog
->Target
== GL_FRAGMENT_PROGRAM_ARB
||
319 prog
->Target
== GL_FRAGMENT_PROGRAM_NV
);
320 else if ((*ptr
)->Target
== GL_GEOMETRY_PROGRAM_NV
)
321 assert(prog
->Target
== GL_GEOMETRY_PROGRAM_NV
);
326 struct gl_program
*oldProg
= *ptr
;
328 assert(oldProg
->RefCount
> 0);
330 if (p_atomic_dec_zero(&oldProg
->RefCount
)) {
332 _mesa_reference_shader_program_data(ctx
, &oldProg
->sh
.data
, NULL
);
333 ctx
->Driver
.DeleteProgram(ctx
, oldProg
);
341 p_atomic_inc(&prog
->RefCount
);
349 * Insert 'count' NOP instructions at 'start' in the given program.
350 * Adjust branch targets accordingly.
353 _mesa_insert_instructions(struct gl_program
*prog
, GLuint start
, GLuint count
)
355 const GLuint origLen
= prog
->arb
.NumInstructions
;
356 const GLuint newLen
= origLen
+ count
;
357 struct prog_instruction
*newInst
;
360 /* adjust branches */
361 for (i
= 0; i
< prog
->arb
.NumInstructions
; i
++) {
362 struct prog_instruction
*inst
= prog
->arb
.Instructions
+ i
;
363 if (inst
->BranchTarget
> 0) {
364 if ((GLuint
)inst
->BranchTarget
>= start
) {
365 inst
->BranchTarget
+= count
;
370 /* Alloc storage for new instructions */
371 newInst
= rzalloc_array(prog
, struct prog_instruction
, newLen
);
376 /* Copy 'start' instructions into new instruction buffer */
377 _mesa_copy_instructions(newInst
, prog
->arb
.Instructions
, start
);
379 /* init the new instructions */
380 _mesa_init_instructions(newInst
+ start
, count
);
382 /* Copy the remaining/tail instructions to new inst buffer */
383 _mesa_copy_instructions(newInst
+ start
+ count
,
384 prog
->arb
.Instructions
+ start
,
387 /* free old instructions */
388 ralloc_free(prog
->arb
.Instructions
);
390 /* install new instructions */
391 prog
->arb
.Instructions
= newInst
;
392 prog
->arb
.NumInstructions
= newLen
;
398 * Delete 'count' instructions at 'start' in the given program.
399 * Adjust branch targets accordingly.
402 _mesa_delete_instructions(struct gl_program
*prog
, GLuint start
, GLuint count
,
405 const GLuint origLen
= prog
->arb
.NumInstructions
;
406 const GLuint newLen
= origLen
- count
;
407 struct prog_instruction
*newInst
;
410 /* adjust branches */
411 for (i
= 0; i
< prog
->arb
.NumInstructions
; i
++) {
412 struct prog_instruction
*inst
= prog
->arb
.Instructions
+ i
;
413 if (inst
->BranchTarget
> 0) {
414 if (inst
->BranchTarget
> (GLint
) start
) {
415 inst
->BranchTarget
-= count
;
420 /* Alloc storage for new instructions */
421 newInst
= rzalloc_array(mem_ctx
, struct prog_instruction
, newLen
);
426 /* Copy 'start' instructions into new instruction buffer */
427 _mesa_copy_instructions(newInst
, prog
->arb
.Instructions
, start
);
429 /* Copy the remaining/tail instructions to new inst buffer */
430 _mesa_copy_instructions(newInst
+ start
,
431 prog
->arb
.Instructions
+ start
+ count
,
434 /* free old instructions */
435 ralloc_free(prog
->arb
.Instructions
);
437 /* install new instructions */
438 prog
->arb
.Instructions
= newInst
;
439 prog
->arb
.NumInstructions
= newLen
;
446 * Populate the 'used' array with flags indicating which registers (TEMPs,
447 * INPUTs, OUTPUTs, etc, are used by the given program.
448 * \param file type of register to scan for
449 * \param used returns true/false flags for in use / free
450 * \param usedSize size of the 'used' array
453 _mesa_find_used_registers(const struct gl_program
*prog
,
454 gl_register_file file
,
455 GLboolean used
[], GLuint usedSize
)
459 memset(used
, 0, usedSize
);
461 for (i
= 0; i
< prog
->arb
.NumInstructions
; i
++) {
462 const struct prog_instruction
*inst
= prog
->arb
.Instructions
+ i
;
463 const GLuint n
= _mesa_num_inst_src_regs(inst
->Opcode
);
465 if (inst
->DstReg
.File
== file
) {
466 assert(inst
->DstReg
.Index
< usedSize
);
467 if(inst
->DstReg
.Index
< usedSize
)
468 used
[inst
->DstReg
.Index
] = GL_TRUE
;
471 for (j
= 0; j
< n
; j
++) {
472 if (inst
->SrcReg
[j
].File
== file
) {
473 assert(inst
->SrcReg
[j
].Index
< (GLint
) usedSize
);
474 if (inst
->SrcReg
[j
].Index
< (GLint
) usedSize
)
475 used
[inst
->SrcReg
[j
].Index
] = GL_TRUE
;
483 * Scan the given 'used' register flag array for the first entry
484 * that's >= firstReg.
485 * \param used vector of flags indicating registers in use (as returned
486 * by _mesa_find_used_registers())
487 * \param usedSize size of the 'used' array
488 * \param firstReg first register to start searching at
489 * \return index of unused register, or -1 if none.
492 _mesa_find_free_register(const GLboolean used
[],
493 GLuint usedSize
, GLuint firstReg
)
497 assert(firstReg
< usedSize
);
499 for (i
= firstReg
; i
< usedSize
; i
++)
507 /* Gets the minimum number of shader invocations per fragment.
508 * This function is useful to determine if we need to do per
509 * sample shading or per fragment shading.
512 _mesa_get_min_invocations_per_fragment(struct gl_context
*ctx
,
513 const struct gl_program
*prog
,
514 bool ignore_sample_qualifier
)
516 /* From ARB_sample_shading specification:
517 * "Using gl_SampleID in a fragment shader causes the entire shader
518 * to be evaluated per-sample."
520 * "Using gl_SamplePosition in a fragment shader causes the entire
521 * shader to be evaluated per-sample."
523 * "If MULTISAMPLE or SAMPLE_SHADING_ARB is disabled, sample shading
526 if (ctx
->Multisample
.Enabled
) {
527 /* The ARB_gpu_shader5 specification says:
529 * "Use of the "sample" qualifier on a fragment shader input
530 * forces per-sample shading"
532 if (prog
->info
.fs
.uses_sample_qualifier
&& !ignore_sample_qualifier
)
533 return MAX2(_mesa_geometric_samples(ctx
->DrawBuffer
), 1);
535 if (prog
->info
.system_values_read
& (SYSTEM_BIT_SAMPLE_ID
|
536 SYSTEM_BIT_SAMPLE_POS
))
537 return MAX2(_mesa_geometric_samples(ctx
->DrawBuffer
), 1);
538 else if (ctx
->Multisample
.SampleShading
)
539 return MAX2(ceil(ctx
->Multisample
.MinSampleShadingValue
*
540 _mesa_geometric_samples(ctx
->DrawBuffer
)), 1);