2 * Mesa 3-D graphics library
5 * Copyright (C) 1999-2007 Brian Paul All Rights Reserved.
7 * Permission is hereby granted, free of charge, to any person obtaining a
8 * copy of this software and associated documentation files (the "Software"),
9 * to deal in the Software without restriction, including without limitation
10 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
11 * and/or sell copies of the Software, and to permit persons to whom the
12 * Software is furnished to do so, subject to the following conditions:
14 * The above copyright notice and this permission notice shall be included
15 * in all copies or substantial portions of the Software.
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
18 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
20 * BRIAN PAUL BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
21 * AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
22 * CONNECTION WITH THE SOFTWARE OR THE USE OR 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/hash.h"
36 #include "prog_cache.h"
37 #include "prog_parameter.h"
38 #include "prog_instruction.h"
42 * A pointer to this dummy program is put into the hash table when
43 * glGenPrograms is called.
45 struct gl_program _mesa_DummyProgram
;
49 * Init context's vertex/fragment program state
52 _mesa_init_program(GLcontext
*ctx
)
56 ctx
->Program
.ErrorPos
= -1;
57 ctx
->Program
.ErrorString
= _mesa_strdup("");
59 #if FEATURE_NV_vertex_program || FEATURE_ARB_vertex_program
60 ctx
->VertexProgram
.Enabled
= GL_FALSE
;
62 ctx
->VertexProgram
.PointSizeEnabled
= GL_TRUE
;
64 ctx
->VertexProgram
.PointSizeEnabled
= GL_FALSE
;
66 ctx
->VertexProgram
.TwoSideEnabled
= GL_FALSE
;
67 _mesa_reference_vertprog(ctx
, &ctx
->VertexProgram
.Current
,
68 ctx
->Shared
->DefaultVertexProgram
);
69 assert(ctx
->VertexProgram
.Current
);
70 for (i
= 0; i
< MAX_NV_VERTEX_PROGRAM_PARAMS
/ 4; i
++) {
71 ctx
->VertexProgram
.TrackMatrix
[i
] = GL_NONE
;
72 ctx
->VertexProgram
.TrackMatrixTransform
[i
] = GL_IDENTITY_NV
;
74 ctx
->VertexProgram
.Cache
= _mesa_new_program_cache();
77 #if FEATURE_NV_fragment_program || FEATURE_ARB_fragment_program
78 ctx
->FragmentProgram
.Enabled
= GL_FALSE
;
79 _mesa_reference_fragprog(ctx
, &ctx
->FragmentProgram
.Current
,
80 ctx
->Shared
->DefaultFragmentProgram
);
81 assert(ctx
->FragmentProgram
.Current
);
82 ctx
->FragmentProgram
.Cache
= _mesa_new_program_cache();
86 /* XXX probably move this stuff */
87 #if FEATURE_ATI_fragment_shader
88 ctx
->ATIFragmentShader
.Enabled
= GL_FALSE
;
89 ctx
->ATIFragmentShader
.Current
= ctx
->Shared
->DefaultFragmentShader
;
90 assert(ctx
->ATIFragmentShader
.Current
);
91 ctx
->ATIFragmentShader
.Current
->RefCount
++;
97 * Free a context's vertex/fragment program state
100 _mesa_free_program_data(GLcontext
*ctx
)
102 #if FEATURE_NV_vertex_program || FEATURE_ARB_vertex_program
103 _mesa_reference_vertprog(ctx
, &ctx
->VertexProgram
.Current
, NULL
);
104 _mesa_delete_program_cache(ctx
, ctx
->VertexProgram
.Cache
);
106 #if FEATURE_NV_fragment_program || FEATURE_ARB_fragment_program
107 _mesa_reference_fragprog(ctx
, &ctx
->FragmentProgram
.Current
, NULL
);
108 _mesa_delete_program_cache(ctx
, ctx
->FragmentProgram
.Cache
);
110 /* XXX probably move this stuff */
111 #if FEATURE_ATI_fragment_shader
112 if (ctx
->ATIFragmentShader
.Current
) {
113 ctx
->ATIFragmentShader
.Current
->RefCount
--;
114 if (ctx
->ATIFragmentShader
.Current
->RefCount
<= 0) {
115 _mesa_free(ctx
->ATIFragmentShader
.Current
);
119 _mesa_free((void *) ctx
->Program
.ErrorString
);
124 * Set the vertex/fragment program error state (position and error string).
125 * This is generally called from within the parsers.
128 _mesa_set_program_error(GLcontext
*ctx
, GLint pos
, const char *string
)
130 ctx
->Program
.ErrorPos
= pos
;
131 _mesa_free((void *) ctx
->Program
.ErrorString
);
134 ctx
->Program
.ErrorString
= _mesa_strdup(string
);
139 * Find the line number and column for 'pos' within 'string'.
140 * Return a copy of the line which contains 'pos'. Free the line with
142 * \param string the program string
143 * \param pos the position within the string
144 * \param line returns the line number corresponding to 'pos'.
145 * \param col returns the column number corresponding to 'pos'.
146 * \return copy of the line containing 'pos'.
149 _mesa_find_line_column(const GLubyte
*string
, const GLubyte
*pos
,
150 GLint
*line
, GLint
*col
)
152 const GLubyte
*lineStart
= string
;
153 const GLubyte
*p
= string
;
160 if (*p
== (GLubyte
) '\n') {
167 *col
= (pos
- lineStart
) + 1;
169 /* return copy of this line */
170 while (*p
!= 0 && *p
!= '\n')
173 s
= (GLubyte
*) _mesa_malloc(len
+ 1);
174 _mesa_memcpy(s
, lineStart
, len
);
182 * Initialize a new vertex/fragment program object.
184 static struct gl_program
*
185 _mesa_init_program_struct( GLcontext
*ctx
, struct gl_program
*prog
,
186 GLenum target
, GLuint id
)
191 _mesa_bzero(prog
, sizeof(*prog
));
193 prog
->Target
= target
;
194 prog
->Resident
= GL_TRUE
;
196 prog
->Format
= GL_PROGRAM_FORMAT_ASCII_ARB
;
198 /* default mapping from samplers to texture units */
199 for (i
= 0; i
< MAX_SAMPLERS
; i
++)
200 prog
->SamplerUnits
[i
] = i
;
208 * Initialize a new fragment program object.
211 _mesa_init_fragment_program( GLcontext
*ctx
, struct gl_fragment_program
*prog
,
212 GLenum target
, GLuint id
)
215 return _mesa_init_program_struct( ctx
, &prog
->Base
, target
, id
);
222 * Initialize a new vertex program object.
225 _mesa_init_vertex_program( GLcontext
*ctx
, struct gl_vertex_program
*prog
,
226 GLenum target
, GLuint id
)
229 return _mesa_init_program_struct( ctx
, &prog
->Base
, target
, id
);
236 * Allocate and initialize a new fragment/vertex program object but
237 * don't put it into the program hash table. Called via
238 * ctx->Driver.NewProgram. May be overridden (ie. replaced) by a
239 * device driver function to implement OO deriviation with additional
240 * types not understood by this function.
243 * \param id program id/number
244 * \param target program target/type
245 * \return pointer to new program object
248 _mesa_new_program(GLcontext
*ctx
, GLenum target
, GLuint id
)
251 case GL_VERTEX_PROGRAM_ARB
: /* == GL_VERTEX_PROGRAM_NV */
252 return _mesa_init_vertex_program(ctx
, CALLOC_STRUCT(gl_vertex_program
),
254 case GL_FRAGMENT_PROGRAM_NV
:
255 case GL_FRAGMENT_PROGRAM_ARB
:
256 return _mesa_init_fragment_program(ctx
,
257 CALLOC_STRUCT(gl_fragment_program
),
260 _mesa_problem(ctx
, "bad target in _mesa_new_program");
267 * Delete a program and remove it from the hash table, ignoring the
269 * Called via ctx->Driver.DeleteProgram. May be wrapped (OO deriviation)
270 * by a device driver function.
273 _mesa_delete_program(GLcontext
*ctx
, struct gl_program
*prog
)
277 ASSERT(prog
->RefCount
==0);
279 if (prog
== &_mesa_DummyProgram
)
283 _mesa_free(prog
->String
);
285 _mesa_free_instructions(prog
->Instructions
, prog
->NumInstructions
);
287 if (prog
->Parameters
) {
288 _mesa_free_parameter_list(prog
->Parameters
);
291 _mesa_free_parameter_list(prog
->Varying
);
293 if (prog
->Attributes
) {
294 _mesa_free_parameter_list(prog
->Attributes
);
297 /* XXX this is a little ugly */
298 if (prog
->Target
== GL_VERTEX_PROGRAM_ARB
) {
299 struct gl_vertex_program
*vprog
= (struct gl_vertex_program
*) prog
;
301 _mesa_free(vprog
->TnlData
);
309 * Return the gl_program object for a given ID.
310 * Basically just a wrapper for _mesa_HashLookup() to avoid a lot of
314 _mesa_lookup_program(GLcontext
*ctx
, GLuint id
)
317 return (struct gl_program
*) _mesa_HashLookup(ctx
->Shared
->Programs
, id
);
324 * Reference counting for vertex/fragment programs
327 _mesa_reference_program(GLcontext
*ctx
,
328 struct gl_program
**ptr
,
329 struct gl_program
*prog
)
334 ASSERT((*ptr
)->Target
== prog
->Target
);
337 return; /* no change */
340 GLboolean deleteFlag
;
342 /*_glthread_LOCK_MUTEX((*ptr)->Mutex);*/
344 printf("Program %p %u 0x%x Refcount-- to %d\n",
345 *ptr
, (*ptr
)->Id
, (*ptr
)->Target
, (*ptr
)->RefCount
- 1);
347 ASSERT((*ptr
)->RefCount
> 0);
350 deleteFlag
= ((*ptr
)->RefCount
== 0);
351 /*_glthread_UNLOCK_MUTEX((*ptr)->Mutex);*/
355 ctx
->Driver
.DeleteProgram(ctx
, *ptr
);
363 /*_glthread_LOCK_MUTEX(prog->Mutex);*/
366 printf("Program %p %u 0x%x Refcount++ to %d\n",
367 prog
, prog
->Id
, prog
->Target
, prog
->RefCount
);
369 /*_glthread_UNLOCK_MUTEX(prog->Mutex);*/
377 * Return a copy of a program.
378 * XXX Problem here if the program object is actually OO-derivation
379 * made by a device driver.
382 _mesa_clone_program(GLcontext
*ctx
, const struct gl_program
*prog
)
384 struct gl_program
*clone
;
386 clone
= ctx
->Driver
.NewProgram(ctx
, prog
->Target
, prog
->Id
);
390 assert(clone
->Target
== prog
->Target
);
391 assert(clone
->RefCount
== 1);
393 clone
->String
= (GLubyte
*) _mesa_strdup((char *) prog
->String
);
394 clone
->Format
= prog
->Format
;
395 clone
->Instructions
= _mesa_alloc_instructions(prog
->NumInstructions
);
396 if (!clone
->Instructions
) {
397 _mesa_reference_program(ctx
, &clone
, NULL
);
400 _mesa_copy_instructions(clone
->Instructions
, prog
->Instructions
,
401 prog
->NumInstructions
);
402 clone
->InputsRead
= prog
->InputsRead
;
403 clone
->OutputsWritten
= prog
->OutputsWritten
;
404 clone
->SamplersUsed
= prog
->SamplersUsed
;
405 memcpy(clone
->TexturesUsed
, prog
->TexturesUsed
, sizeof(prog
->TexturesUsed
));
407 if (prog
->Parameters
)
408 clone
->Parameters
= _mesa_clone_parameter_list(prog
->Parameters
);
409 memcpy(clone
->LocalParams
, prog
->LocalParams
, sizeof(clone
->LocalParams
));
411 clone
->Varying
= _mesa_clone_parameter_list(prog
->Varying
);
412 if (prog
->Attributes
)
413 clone
->Attributes
= _mesa_clone_parameter_list(prog
->Attributes
);
414 memcpy(clone
->LocalParams
, prog
->LocalParams
, sizeof(clone
->LocalParams
));
415 clone
->NumInstructions
= prog
->NumInstructions
;
416 clone
->NumTemporaries
= prog
->NumTemporaries
;
417 clone
->NumParameters
= prog
->NumParameters
;
418 clone
->NumAttributes
= prog
->NumAttributes
;
419 clone
->NumAddressRegs
= prog
->NumAddressRegs
;
420 clone
->NumNativeInstructions
= prog
->NumNativeInstructions
;
421 clone
->NumNativeTemporaries
= prog
->NumNativeTemporaries
;
422 clone
->NumNativeParameters
= prog
->NumNativeParameters
;
423 clone
->NumNativeAttributes
= prog
->NumNativeAttributes
;
424 clone
->NumNativeAddressRegs
= prog
->NumNativeAddressRegs
;
425 clone
->NumAluInstructions
= prog
->NumAluInstructions
;
426 clone
->NumTexInstructions
= prog
->NumTexInstructions
;
427 clone
->NumTexIndirections
= prog
->NumTexIndirections
;
428 clone
->NumNativeAluInstructions
= prog
->NumNativeAluInstructions
;
429 clone
->NumNativeTexInstructions
= prog
->NumNativeTexInstructions
;
430 clone
->NumNativeTexIndirections
= prog
->NumNativeTexIndirections
;
432 switch (prog
->Target
) {
433 case GL_VERTEX_PROGRAM_ARB
:
435 const struct gl_vertex_program
*vp
436 = (const struct gl_vertex_program
*) prog
;
437 struct gl_vertex_program
*vpc
= (struct gl_vertex_program
*) clone
;
438 vpc
->IsPositionInvariant
= vp
->IsPositionInvariant
;
441 case GL_FRAGMENT_PROGRAM_ARB
:
443 const struct gl_fragment_program
*fp
444 = (const struct gl_fragment_program
*) prog
;
445 struct gl_fragment_program
*fpc
= (struct gl_fragment_program
*) clone
;
446 fpc
->FogOption
= fp
->FogOption
;
447 fpc
->UsesKill
= fp
->UsesKill
;
451 _mesa_problem(NULL
, "Unexpected target in _mesa_clone_program");
459 * Insert 'count' NOP instructions at 'start' in the given program.
460 * Adjust branch targets accordingly.
463 _mesa_insert_instructions(struct gl_program
*prog
, GLuint start
, GLuint count
)
465 const GLuint origLen
= prog
->NumInstructions
;
466 const GLuint newLen
= origLen
+ count
;
467 struct prog_instruction
*newInst
;
470 /* adjust branches */
471 for (i
= 0; i
< prog
->NumInstructions
; i
++) {
472 struct prog_instruction
*inst
= prog
->Instructions
+ i
;
473 if (inst
->BranchTarget
> 0) {
474 if ((GLuint
)inst
->BranchTarget
>= start
) {
475 inst
->BranchTarget
+= count
;
480 /* Alloc storage for new instructions */
481 newInst
= _mesa_alloc_instructions(newLen
);
486 /* Copy 'start' instructions into new instruction buffer */
487 _mesa_copy_instructions(newInst
, prog
->Instructions
, start
);
489 /* init the new instructions */
490 _mesa_init_instructions(newInst
+ start
, count
);
492 /* Copy the remaining/tail instructions to new inst buffer */
493 _mesa_copy_instructions(newInst
+ start
+ count
,
494 prog
->Instructions
+ start
,
497 /* free old instructions */
498 _mesa_free_instructions(prog
->Instructions
, origLen
);
500 /* install new instructions */
501 prog
->Instructions
= newInst
;
502 prog
->NumInstructions
= newLen
;
509 * Search instructions for registers that match (oldFile, oldIndex),
510 * replacing them with (newFile, newIndex).
513 replace_registers(struct prog_instruction
*inst
, GLuint numInst
,
514 GLuint oldFile
, GLuint oldIndex
,
515 GLuint newFile
, GLuint newIndex
)
518 for (i
= 0; i
< numInst
; i
++) {
520 for (j
= 0; j
< _mesa_num_inst_src_regs(inst
->Opcode
); j
++) {
521 if (inst
[i
].SrcReg
[j
].File
== oldFile
&&
522 inst
[i
].SrcReg
[j
].Index
== oldIndex
) {
523 inst
[i
].SrcReg
[j
].File
= newFile
;
524 inst
[i
].SrcReg
[j
].Index
= newIndex
;
528 if (inst
[i
].DstReg
.File
== oldFile
&& inst
[i
].DstReg
.Index
== oldIndex
) {
529 inst
[i
].DstReg
.File
= newFile
;
530 inst
[i
].DstReg
.Index
= newIndex
;
537 * Search instructions for references to program parameters. When found,
538 * increment the parameter index by 'offset'.
539 * Used when combining programs.
542 adjust_param_indexes(struct prog_instruction
*inst
, GLuint numInst
,
546 for (i
= 0; i
< numInst
; i
++) {
547 for (j
= 0; j
< _mesa_num_inst_src_regs(inst
->Opcode
); j
++) {
548 GLuint f
= inst
[i
].SrcReg
[j
].File
;
549 if (f
== PROGRAM_CONSTANT
||
550 f
== PROGRAM_UNIFORM
||
551 f
== PROGRAM_STATE_VAR
) {
552 inst
[i
].SrcReg
[j
].Index
+= offset
;
560 * Combine two programs into one. Fix instructions so the outputs of
561 * the first program go to the inputs of the second program.
564 _mesa_combine_programs(GLcontext
*ctx
,
565 const struct gl_program
*progA
,
566 const struct gl_program
*progB
)
568 struct prog_instruction
*newInst
;
569 struct gl_program
*newProg
;
570 const GLuint lenA
= progA
->NumInstructions
- 1; /* omit END instr */
571 const GLuint lenB
= progB
->NumInstructions
;
572 const GLuint numParamsA
= _mesa_num_parameters(progA
->Parameters
);
573 const GLuint newLength
= lenA
+ lenB
;
577 ASSERT(progA
->Target
== progB
->Target
);
579 newInst
= _mesa_alloc_instructions(newLength
);
583 _mesa_copy_instructions(newInst
, progA
->Instructions
, lenA
);
584 _mesa_copy_instructions(newInst
+ lenA
, progB
->Instructions
, lenB
);
586 /* adjust branch / instruction addresses for B's instructions */
587 for (i
= 0; i
< lenB
; i
++) {
588 newInst
[lenA
+ i
].BranchTarget
+= lenA
;
591 newProg
= ctx
->Driver
.NewProgram(ctx
, progA
->Target
, 0);
592 newProg
->Instructions
= newInst
;
593 newProg
->NumInstructions
= newLength
;
595 if (newProg
->Target
== GL_FRAGMENT_PROGRAM_ARB
) {
596 struct gl_fragment_program
*fprogA
, *fprogB
, *newFprog
;
597 GLbitfield progB_inputsRead
= progB
->InputsRead
;
598 GLint progB_colorFile
, progB_colorIndex
;
600 fprogA
= (struct gl_fragment_program
*) progA
;
601 fprogB
= (struct gl_fragment_program
*) progB
;
602 newFprog
= (struct gl_fragment_program
*) newProg
;
604 newFprog
->UsesKill
= fprogA
->UsesKill
|| fprogB
->UsesKill
;
606 /* We'll do a search and replace for instances
607 * of progB_colorFile/progB_colorIndex below...
609 progB_colorFile
= PROGRAM_INPUT
;
610 progB_colorIndex
= FRAG_ATTRIB_COL0
;
613 * The fragment program may get color from a state var rather than
614 * a fragment input (vertex output) if it's constant.
615 * See the texenvprogram.c code.
616 * So, search the program's parameter list now to see if the program
617 * gets color from a state var instead of a conventional fragment
620 for (i
= 0; i
< progB
->Parameters
->NumParameters
; i
++) {
621 struct gl_program_parameter
*p
= &progB
->Parameters
->Parameters
[i
];
622 if (p
->Type
== PROGRAM_STATE_VAR
&&
623 p
->StateIndexes
[0] == STATE_INTERNAL
&&
624 p
->StateIndexes
[1] == STATE_CURRENT_ATTRIB
&&
625 p
->StateIndexes
[2] == VERT_ATTRIB_COLOR0
) {
626 progB_inputsRead
|= FRAG_BIT_COL0
;
627 progB_colorFile
= PROGRAM_STATE_VAR
;
628 progB_colorIndex
= i
;
633 /* Connect color outputs of fprogA to color inputs of fprogB, via a
634 * new temporary register.
636 if ((progA
->OutputsWritten
& (1 << FRAG_RESULT_COLR
)) &&
637 (progB_inputsRead
& FRAG_BIT_COL0
)) {
638 GLint tempReg
= _mesa_find_free_register(newProg
, PROGRAM_TEMPORARY
);
640 _mesa_problem(ctx
, "No free temp regs found in "
641 "_mesa_combine_programs(), using 31");
644 /* replace writes to result.color[0] with tempReg */
645 replace_registers(newInst
, lenA
,
646 PROGRAM_OUTPUT
, FRAG_RESULT_COLR
,
647 PROGRAM_TEMPORARY
, tempReg
);
648 /* replace reads from the input color with tempReg */
649 replace_registers(newInst
+ lenA
, lenB
,
650 progB_colorFile
, progB_colorIndex
, /* search for */
651 PROGRAM_TEMPORARY
, tempReg
/* replace with */ );
654 /* compute combined program's InputsRead */
655 inputsB
= progB_inputsRead
;
656 if (progA
->OutputsWritten
& (1 << FRAG_RESULT_COLR
)) {
657 inputsB
&= ~(1 << FRAG_ATTRIB_COL0
);
659 newProg
->InputsRead
= progA
->InputsRead
| inputsB
;
660 newProg
->OutputsWritten
= progB
->OutputsWritten
;
661 newProg
->SamplersUsed
= progA
->SamplersUsed
| progB
->SamplersUsed
;
665 assert(0); /* XXX todo */
669 * Merge parameters (uniforms, constants, etc)
671 newProg
->Parameters
= _mesa_combine_parameter_lists(progA
->Parameters
,
674 adjust_param_indexes(newInst
+ lenA
, lenB
, numParamsA
);
684 * Scan the given program to find a free register of the given type.
685 * \param regFile - PROGRAM_INPUT, PROGRAM_OUTPUT or PROGRAM_TEMPORARY
688 _mesa_find_free_register(const struct gl_program
*prog
, GLuint regFile
)
690 GLboolean used
[MAX_PROGRAM_TEMPS
];
693 assert(regFile
== PROGRAM_INPUT
||
694 regFile
== PROGRAM_OUTPUT
||
695 regFile
== PROGRAM_TEMPORARY
);
697 _mesa_memset(used
, 0, sizeof(used
));
699 for (i
= 0; i
< prog
->NumInstructions
; i
++) {
700 const struct prog_instruction
*inst
= prog
->Instructions
+ i
;
701 const GLuint n
= _mesa_num_inst_src_regs(inst
->Opcode
);
703 for (k
= 0; k
< n
; k
++) {
704 if (inst
->SrcReg
[k
].File
== regFile
) {
705 used
[inst
->SrcReg
[k
].Index
] = GL_TRUE
;
710 for (i
= 0; i
< MAX_PROGRAM_TEMPS
; i
++) {