1/*
2 * Mesa 3-D graphics library
3 * Version:  7.1
4 *
5 * Copyright (C) 1999-2008  Brian Paul   All Rights Reserved.
6 *
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:
13 *
14 * The above copyright notice and this permission notice shall be included
15 * in all copies or substantial portions of the Software.
16 *
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.
23 */
24
25#define DEBUG_PARSING 0
26
27/**
28 * \file arbprogparse.c
29 * ARB_*_program parser core
30 * \author Karl Rasche
31 */
32
33/**
34Notes on program parameters, etc.
35
36The instructions we emit will use six kinds of source registers:
37
38  PROGRAM_INPUT      - input registers
39  PROGRAM_TEMPORARY  - temp registers
40  PROGRAM_ADDRESS    - address/indirect register
41  PROGRAM_SAMPLER    - texture sampler
42  PROGRAM_CONSTANT   - indexes into program->Parameters, a known constant/literal
43  PROGRAM_STATE_VAR  - indexes into program->Parameters, and may actually be:
44                       + a state variable, like "state.fog.color", or
45                       + a pointer to a "program.local[k]" parameter, or
46                       + a pointer to a "program.env[k]" parameter
47
48Basically, all the program.local[] and program.env[] values will get mapped
49into the unified gl_program->Parameters array.  This solves the problem of
50having three separate program parameter arrays.
51*/
52
53
54#include "main/glheader.h"
55#include "main/imports.h"
56#include "main/context.h"
57#include "main/mtypes.h"
58#include "arbprogparse.h"
59#include "programopt.h"
60#include "prog_parameter.h"
61#include "prog_statevars.h"
62#include "prog_instruction.h"
63#include "program_parser.h"
64
65
66void
67_mesa_parse_arb_fragment_program(struct gl_context* ctx, GLenum target,
68                                 const GLvoid *str, GLsizei len,
69                                 struct gl_fragment_program *program)
70{
71   struct gl_program prog;
72   struct asm_parser_state state;
73   GLuint i;
74
75   ASSERT(target == GL_FRAGMENT_PROGRAM_ARB);
76
77   memset(&prog, 0, sizeof(prog));
78   memset(&state, 0, sizeof(state));
79   state.prog = &prog;
80
81   if (!_mesa_parse_arb_program(ctx, target, (const GLubyte*) str, len,
82				&state)) {
83      /* Error in the program. Just return. */
84      return;
85   }
86
87   if (program->Base.String != NULL)
88      free(program->Base.String);
89
90   /* Copy the relevant contents of the arb_program struct into the
91    * fragment_program struct.
92    */
93   program->Base.String          = prog.String;
94   program->Base.NumInstructions = prog.NumInstructions;
95   program->Base.NumTemporaries  = prog.NumTemporaries;
96   program->Base.NumParameters   = prog.NumParameters;
97   program->Base.NumAttributes   = prog.NumAttributes;
98   program->Base.NumAddressRegs  = prog.NumAddressRegs;
99   program->Base.NumNativeInstructions = prog.NumNativeInstructions;
100   program->Base.NumNativeTemporaries = prog.NumNativeTemporaries;
101   program->Base.NumNativeParameters = prog.NumNativeParameters;
102   program->Base.NumNativeAttributes = prog.NumNativeAttributes;
103   program->Base.NumNativeAddressRegs = prog.NumNativeAddressRegs;
104   program->Base.NumAluInstructions   = prog.NumAluInstructions;
105   program->Base.NumTexInstructions   = prog.NumTexInstructions;
106   program->Base.NumTexIndirections   = prog.NumTexIndirections;
107   program->Base.NumNativeAluInstructions = prog.NumAluInstructions;
108   program->Base.NumNativeTexInstructions = prog.NumTexInstructions;
109   program->Base.NumNativeTexIndirections = prog.NumTexIndirections;
110   program->Base.InputsRead      = prog.InputsRead;
111   program->Base.OutputsWritten  = prog.OutputsWritten;
112   program->Base.IndirectRegisterFiles = prog.IndirectRegisterFiles;
113   for (i = 0; i < MAX_TEXTURE_IMAGE_UNITS; i++) {
114      program->Base.TexturesUsed[i] = prog.TexturesUsed[i];
115      if (prog.TexturesUsed[i])
116         program->Base.SamplersUsed |= (1 << i);
117   }
118   program->Base.ShadowSamplers = prog.ShadowSamplers;
119   program->OriginUpperLeft = state.option.OriginUpperLeft;
120   program->PixelCenterInteger = state.option.PixelCenterInteger;
121
122   program->UsesKill            = state.fragment.UsesKill;
123   program->UsesDFdy            = state.fragment.UsesDFdy;
124
125   if (program->Base.Instructions)
126      free(program->Base.Instructions);
127   program->Base.Instructions = prog.Instructions;
128
129   if (program->Base.Parameters)
130      _mesa_free_parameter_list(program->Base.Parameters);
131   program->Base.Parameters    = prog.Parameters;
132
133   /* Append fog instructions now if the program has "OPTION ARB_fog_exp"
134    * or similar.  We used to leave this up to drivers, but it appears
135    * there's no hardware that wants to do fog in a discrete stage separate
136    * from the fragment shader.
137    */
138   if (state.option.Fog != OPTION_NONE) {
139      static const GLenum fog_modes[4] = {
140	 GL_NONE, GL_EXP, GL_EXP2, GL_LINEAR
141      };
142
143      /* XXX: we should somehow recompile this to remove clamping if disabled
144       * On the ATI driver, this is unclampled if fragment clamping is disabled
145       */
146      _mesa_append_fog_code(ctx, program, fog_modes[state.option.Fog], GL_TRUE);
147   }
148
149#if DEBUG_FP
150   printf("____________Fragment program %u ________\n", program->Base.Id);
151   _mesa_print_program(&program->Base);
152#endif
153}
154
155
156
157/**
158 * Parse the vertex program string.  If success, update the given
159 * vertex_program object with the new program.  Else, leave the vertex_program
160 * object unchanged.
161 */
162void
163_mesa_parse_arb_vertex_program(struct gl_context *ctx, GLenum target,
164			       const GLvoid *str, GLsizei len,
165			       struct gl_vertex_program *program)
166{
167   struct gl_program prog;
168   struct asm_parser_state state;
169
170   ASSERT(target == GL_VERTEX_PROGRAM_ARB);
171
172   memset(&prog, 0, sizeof(prog));
173   memset(&state, 0, sizeof(state));
174   state.prog = &prog;
175
176   if (!_mesa_parse_arb_program(ctx, target, (const GLubyte*) str, len,
177				&state)) {
178      _mesa_error(ctx, GL_INVALID_OPERATION, "glProgramString(bad program)");
179      return;
180   }
181
182   if (program->Base.String != NULL)
183      free(program->Base.String);
184
185   /* Copy the relevant contents of the arb_program struct into the
186    * vertex_program struct.
187    */
188   program->Base.String          = prog.String;
189   program->Base.NumInstructions = prog.NumInstructions;
190   program->Base.NumTemporaries  = prog.NumTemporaries;
191   program->Base.NumParameters   = prog.NumParameters;
192   program->Base.NumAttributes   = prog.NumAttributes;
193   program->Base.NumAddressRegs  = prog.NumAddressRegs;
194   program->Base.NumNativeInstructions = prog.NumNativeInstructions;
195   program->Base.NumNativeTemporaries = prog.NumNativeTemporaries;
196   program->Base.NumNativeParameters = prog.NumNativeParameters;
197   program->Base.NumNativeAttributes = prog.NumNativeAttributes;
198   program->Base.NumNativeAddressRegs = prog.NumNativeAddressRegs;
199   program->Base.InputsRead     = prog.InputsRead;
200   program->Base.OutputsWritten = prog.OutputsWritten;
201   program->Base.IndirectRegisterFiles = prog.IndirectRegisterFiles;
202   program->IsPositionInvariant = (state.option.PositionInvariant)
203      ? GL_TRUE : GL_FALSE;
204
205   if (program->Base.Instructions)
206      free(program->Base.Instructions);
207   program->Base.Instructions = prog.Instructions;
208
209   if (program->Base.Parameters)
210      _mesa_free_parameter_list(program->Base.Parameters);
211   program->Base.Parameters = prog.Parameters;
212
213#if DEBUG_VP
214   printf("____________Vertex program %u __________\n", program->Base.Id);
215   _mesa_print_program(&program->Base);
216#endif
217}
218