src/mesa/shader/program_parser.h

   1 /*
   2  * Copyright © 2009 Intel Corporation
   3  *
   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:
  10  *
  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
  13  * Software.
  14  *
  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
  20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  21  * DEALINGS IN THE SOFTWARE.
  22  */
  23 #pragma once
  24
  25 #include "main/config.h"
  26
  27 #ifndef MTYPES_H
  28 struct __GLcontextRec;
  29 typedef struct __GLcontextRec GLcontext;
  30 #endif
  31
  32 enum asm_type {
  33    at_none,
  34    at_address,
  35    at_attrib,
  36    at_param,
  37    at_temp,
  38    at_output
  39 };
  40
  41 struct asm_symbol {
  42    struct asm_symbol *next;    /**< List linkage for freeing. */
  43    const char *name;
  44    enum asm_type type;
  45    unsigned attrib_binding;
  46    unsigned output_binding;   /**< Output / result register number. */
  47
  48    /**
  49     * One of PROGRAM_STATE_VAR, PROGRAM_LOCAL_PARAM, or PROGRAM_ENV_PARAM.
  50     */
  51    unsigned param_binding_type;
  52
  53    /**
  54     * Offset into the program_parameter_list where the tokens representing our
  55     * bound state (or constants) start.
  56     */
  57    unsigned param_binding_begin;
  58
  59    /**
  60     * Constants put into the parameter list may be swizzled.  This
  61     * field contain's the symbol's swizzle. (SWIZZLE_X/Y/Z/W)
  62     */
  63    unsigned param_binding_swizzle;
  64
  65    /* This is how many entries in the the program_parameter_list we take up
  66     * with our state tokens or constants. Note that this is _not_ the same as
  67     * the number of param registers we eventually use.
  68     */
  69    unsigned param_binding_length;
  70
  71    /**
  72     * Index of the temp register assigned to this variable.
  73     */
  74    unsigned temp_binding;
  75
  76    /**
  77     * Flag whether or not a PARAM is an array
  78     */
  79    unsigned param_is_array:1;
  80
  81
  82    /**
  83     * Flag whether or not a PARAM array is accessed indirectly
  84     */
  85    unsigned param_accessed_indirectly:1;
  86
  87
  88    /**
  89     * \brief Is first pass of parameter layout done with this variable?
  90     *
  91     * The parameter layout routine operates in two passes.  This flag tracks
  92     * whether or not the first pass has handled this variable.
  93     *
  94     * \sa _mesa_layout_parameters
  95     */
  96    unsigned pass1_done:1;
  97 };
  98
  99
 100 struct asm_vector {
 101    unsigned count;
 102    float    data[4];
 103 };
 104
 105
 106 struct asm_swizzle_mask {
 107    unsigned swizzle:12;
 108    unsigned mask:4;
 109 };
 110
 111
 112 struct asm_src_register {
 113    struct prog_src_register Base;
 114
 115    /**
 116     * Symbol associated with indirect access to parameter arrays.
 117     *
 118     * If \c Base::RelAddr is 1, this will point to the symbol for the parameter
 119     * that is being dereferenced.  Further, \c Base::Index will be the offset
 120     * from the address register being used.
 121     */
 122    struct asm_symbol *Symbol;
 123 };
 124
 125
 126 struct asm_instruction {
 127    struct prog_instruction Base;
 128    struct asm_instruction *next;
 129    struct asm_src_register SrcReg[3];
 130 };
 131
 132
 133 struct asm_parser_state {
 134    GLcontext *ctx;
 135    struct gl_program *prog;
 136
 137    /**
 138     * Per-program target limits
 139     */
 140    struct gl_program_constants *limits;
 141
 142    struct _mesa_symbol_table *st;
 143
 144    /**
 145     * Linked list of symbols
 146     *
 147     * This list is \b only used when cleaning up compiler state and freeing
 148     * memory.
 149     */
 150    struct asm_symbol *sym;
 151
 152    /**
 153     * State for the lexer.
 154     */
 155    void *scanner;
 156
 157    /**
 158     * Linked list of instructions generated during parsing.
 159     */
 160    /*@{*/
 161    struct asm_instruction *inst_head;
 162    struct asm_instruction *inst_tail;
 163    /*@}*/
 164
 165
 166    /**
 167     * Selected limits copied from gl_constants
 168     *
 169     * These are limits from the GL context, but various bits in the program
 170     * must be validated against these values.
 171     */
 172    /*@{*/
 173    unsigned MaxTextureCoordUnits;
 174    unsigned MaxTextureImageUnits;
 175    unsigned MaxTextureUnits;
 176    unsigned MaxClipPlanes;
 177    unsigned MaxLights;
 178    unsigned MaxProgramMatrices;
 179    /*@}*/
 180
 181    /**
 182     * Value to use in state vector accessors for environment and local
 183     * parameters
 184     */
 185    unsigned state_param_enum;
 186
 187
 188    /**
 189     * Input attributes bound to specific names
 190     *
 191     * This is only needed so that errors can be properly produced when
 192     * multiple ATTRIB statements bind illegal combinations of vertex
 193     * attributes.
 194     */
 195    unsigned InputsBound;
 196
 197    enum {
 198       invalid_mode = 0,
 199       ARB_vertex,
 200       ARB_fragment
 201    } mode;
 202
 203    struct {
 204       unsigned PositionInvariant:1;
 205       unsigned Fog:2;
 206       unsigned PrecisionHint:2;
 207       unsigned DrawBuffers:1;
 208       unsigned Shadow:1;
 209       unsigned TexRect:1;
 210       unsigned TexArray:1;
 211       unsigned NV_fragment:1;
 212       unsigned OriginUpperLeft:1;
 213       unsigned PixelCenterInteger:1;
 214    } option;
 215
 216    struct {
 217       unsigned UsesKill:1;
 218    } fragment;
 219 };
 220
 221 #define OPTION_NONE        0
 222 #define OPTION_FOG_EXP     1
 223 #define OPTION_FOG_EXP2    2
 224 #define OPTION_FOG_LINEAR  3
 225 #define OPTION_NICEST      1
 226 #define OPTION_FASTEST     2
 227
 228 typedef struct YYLTYPE {
 229    int first_line;
 230    int first_column;
 231    int last_line;
 232    int last_column;
 233    int position;
 234 } YYLTYPE;
 235
 236 #define YYLTYPE_IS_DECLARED 1
 237 #define YYLTYPE_IS_TRIVIAL 1
 238
 239
 240 extern GLboolean _mesa_parse_arb_program(GLcontext *ctx, GLenum target,
 241     const GLubyte *str, GLsizei len, struct asm_parser_state *state);
 242
 243
 244
 245 /* From program_lexer.l. */
 246 extern void _mesa_program_lexer_dtor(void *scanner);
 247
 248 extern void _mesa_program_lexer_ctor(void **scanner,
 249     struct asm_parser_state *state, const char *string, size_t len);
 250
 251
 252 /**
 253  *\name From program_parse_extra.c
 254  */
 255 /*@{*/
 256
 257 /**
 258  * Parses and processes an option string to an ARB vertex program
 259  *
 260  * \return
 261  * Non-zero on success, zero on failure.
 262  */
 263 extern int _mesa_ARBvp_parse_option(struct asm_parser_state *state,
 264     const char *option);
 265
 266 /**
 267  * Parses and processes an option string to an ARB fragment program
 268  *
 269  * \return
 270  * Non-zero on success, zero on failure.
 271  */
 272 extern int _mesa_ARBfp_parse_option(struct asm_parser_state *state,
 273     const char *option);
 274
 275 /**
 276  * Parses and processes instruction suffixes
 277  *
 278  * Instruction suffixes, such as \c _SAT, are processed.  The relevant bits
 279  * are set in \c inst.  If suffixes are encountered that are either not known
 280  * or not supported by the modes and options set in \c state, zero will be
 281  * returned.
 282  *
 283  * \return
 284  * Non-zero on success, zero on failure.
 285  */
 286 extern int _mesa_parse_instruction_suffix(const struct asm_parser_state *state,
 287     const char *suffix, struct prog_instruction *inst);
 288
 289 /**
 290  * Parses a condition code name
 291  *
 292  * The condition code names (e.g., \c LT, \c GT, \c NE) were added to assembly
 293  * shaders with the \c GL_NV_fragment_program_option extension.  This function
 294  * converts a string representation into one of the \c COND_ macros.
 295  *
 296  * \return
 297  * One of the \c COND_ macros defined in prog_instruction.h on success or zero
 298  * on failure.
 299  */
 300 extern int _mesa_parse_cc(const char *s);
 301
 302 /*@}*/