src/glsl/builtin_variables.cpp

   1 /*
   2  * Copyright © 2010 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
  24 #include "ir.h"
  25 #include "glsl_parser_extras.h"
  26 #include "glsl_symbol_table.h"
  27 #include "main/core.h"
  28 #include "main/uniforms.h"
  29 #include "program/prog_statevars.h"
  30 #include "program/prog_instruction.h"
  31
  32 static const struct gl_builtin_uniform_element gl_NumSamples_elements[] = {
  33    {NULL, {STATE_NUM_SAMPLES, 0, 0}, SWIZZLE_XXXX}
  34 };
  35
  36 static const struct gl_builtin_uniform_element gl_DepthRange_elements[] = {
  37    {"near", {STATE_DEPTH_RANGE, 0, 0}, SWIZZLE_XXXX},
  38    {"far", {STATE_DEPTH_RANGE, 0, 0}, SWIZZLE_YYYY},
  39    {"diff", {STATE_DEPTH_RANGE, 0, 0}, SWIZZLE_ZZZZ},
  40 };
  41
  42 static const struct gl_builtin_uniform_element gl_ClipPlane_elements[] = {
  43    {NULL, {STATE_CLIPPLANE, 0, 0}, SWIZZLE_XYZW}
  44 };
  45
  46 static const struct gl_builtin_uniform_element gl_Point_elements[] = {
  47    {"size", {STATE_POINT_SIZE}, SWIZZLE_XXXX},
  48    {"sizeMin", {STATE_POINT_SIZE}, SWIZZLE_YYYY},
  49    {"sizeMax", {STATE_POINT_SIZE}, SWIZZLE_ZZZZ},
  50    {"fadeThresholdSize", {STATE_POINT_SIZE}, SWIZZLE_WWWW},
  51    {"distanceConstantAttenuation", {STATE_POINT_ATTENUATION}, SWIZZLE_XXXX},
  52    {"distanceLinearAttenuation", {STATE_POINT_ATTENUATION}, SWIZZLE_YYYY},
  53    {"distanceQuadraticAttenuation", {STATE_POINT_ATTENUATION}, SWIZZLE_ZZZZ},
  54 };
  55
  56 static const struct gl_builtin_uniform_element gl_FrontMaterial_elements[] = {
  57    {"emission", {STATE_MATERIAL, 0, STATE_EMISSION}, SWIZZLE_XYZW},
  58    {"ambient", {STATE_MATERIAL, 0, STATE_AMBIENT}, SWIZZLE_XYZW},
  59    {"diffuse", {STATE_MATERIAL, 0, STATE_DIFFUSE}, SWIZZLE_XYZW},
  60    {"specular", {STATE_MATERIAL, 0, STATE_SPECULAR}, SWIZZLE_XYZW},
  61    {"shininess", {STATE_MATERIAL, 0, STATE_SHININESS}, SWIZZLE_XXXX},
  62 };
  63
  64 static const struct gl_builtin_uniform_element gl_BackMaterial_elements[] = {
  65    {"emission", {STATE_MATERIAL, 1, STATE_EMISSION}, SWIZZLE_XYZW},
  66    {"ambient", {STATE_MATERIAL, 1, STATE_AMBIENT}, SWIZZLE_XYZW},
  67    {"diffuse", {STATE_MATERIAL, 1, STATE_DIFFUSE}, SWIZZLE_XYZW},
  68    {"specular", {STATE_MATERIAL, 1, STATE_SPECULAR}, SWIZZLE_XYZW},
  69    {"shininess", {STATE_MATERIAL, 1, STATE_SHININESS}, SWIZZLE_XXXX},
  70 };
  71
  72 static const struct gl_builtin_uniform_element gl_LightSource_elements[] = {
  73    {"ambient", {STATE_LIGHT, 0, STATE_AMBIENT}, SWIZZLE_XYZW},
  74    {"diffuse", {STATE_LIGHT, 0, STATE_DIFFUSE}, SWIZZLE_XYZW},
  75    {"specular", {STATE_LIGHT, 0, STATE_SPECULAR}, SWIZZLE_XYZW},
  76    {"position", {STATE_LIGHT, 0, STATE_POSITION}, SWIZZLE_XYZW},
  77    {"halfVector", {STATE_LIGHT, 0, STATE_HALF_VECTOR}, SWIZZLE_XYZW},
  78    {"spotDirection", {STATE_LIGHT, 0, STATE_SPOT_DIRECTION},
  79     MAKE_SWIZZLE4(SWIZZLE_X,
  80                   SWIZZLE_Y,
  81                   SWIZZLE_Z,
  82                   SWIZZLE_Z)},
  83    {"spotCosCutoff", {STATE_LIGHT, 0, STATE_SPOT_DIRECTION}, SWIZZLE_WWWW},
  84    {"spotCutoff", {STATE_LIGHT, 0, STATE_SPOT_CUTOFF}, SWIZZLE_XXXX},
  85    {"spotExponent", {STATE_LIGHT, 0, STATE_ATTENUATION}, SWIZZLE_WWWW},
  86    {"constantAttenuation", {STATE_LIGHT, 0, STATE_ATTENUATION}, SWIZZLE_XXXX},
  87    {"linearAttenuation", {STATE_LIGHT, 0, STATE_ATTENUATION}, SWIZZLE_YYYY},
  88    {"quadraticAttenuation", {STATE_LIGHT, 0, STATE_ATTENUATION}, SWIZZLE_ZZZZ},
  89 };
  90
  91 static const struct gl_builtin_uniform_element gl_LightModel_elements[] = {
  92    {"ambient", {STATE_LIGHTMODEL_AMBIENT, 0}, SWIZZLE_XYZW},
  93 };
  94
  95 static const struct gl_builtin_uniform_element gl_FrontLightModelProduct_elements[] = {
  96    {"sceneColor", {STATE_LIGHTMODEL_SCENECOLOR, 0}, SWIZZLE_XYZW},
  97 };
  98
  99 static const struct gl_builtin_uniform_element gl_BackLightModelProduct_elements[] = {
 100    {"sceneColor", {STATE_LIGHTMODEL_SCENECOLOR, 1}, SWIZZLE_XYZW},
 101 };
 102
 103 static const struct gl_builtin_uniform_element gl_FrontLightProduct_elements[] = {
 104    {"ambient", {STATE_LIGHTPROD, 0, 0, STATE_AMBIENT}, SWIZZLE_XYZW},
 105    {"diffuse", {STATE_LIGHTPROD, 0, 0, STATE_DIFFUSE}, SWIZZLE_XYZW},
 106    {"specular", {STATE_LIGHTPROD, 0, 0, STATE_SPECULAR}, SWIZZLE_XYZW},
 107 };
 108
 109 static const struct gl_builtin_uniform_element gl_BackLightProduct_elements[] = {
 110    {"ambient", {STATE_LIGHTPROD, 0, 1, STATE_AMBIENT}, SWIZZLE_XYZW},
 111    {"diffuse", {STATE_LIGHTPROD, 0, 1, STATE_DIFFUSE}, SWIZZLE_XYZW},
 112    {"specular", {STATE_LIGHTPROD, 0, 1, STATE_SPECULAR}, SWIZZLE_XYZW},
 113 };
 114
 115 static const struct gl_builtin_uniform_element gl_TextureEnvColor_elements[] = {
 116    {NULL, {STATE_TEXENV_COLOR, 0}, SWIZZLE_XYZW},
 117 };
 118
 119 static const struct gl_builtin_uniform_element gl_EyePlaneS_elements[] = {
 120    {NULL, {STATE_TEXGEN, 0, STATE_TEXGEN_EYE_S}, SWIZZLE_XYZW},
 121 };
 122
 123 static const struct gl_builtin_uniform_element gl_EyePlaneT_elements[] = {
 124    {NULL, {STATE_TEXGEN, 0, STATE_TEXGEN_EYE_T}, SWIZZLE_XYZW},
 125 };
 126
 127 static const struct gl_builtin_uniform_element gl_EyePlaneR_elements[] = {
 128    {NULL, {STATE_TEXGEN, 0, STATE_TEXGEN_EYE_R}, SWIZZLE_XYZW},
 129 };
 130
 131 static const struct gl_builtin_uniform_element gl_EyePlaneQ_elements[] = {
 132    {NULL, {STATE_TEXGEN, 0, STATE_TEXGEN_EYE_Q}, SWIZZLE_XYZW},
 133 };
 134
 135 static const struct gl_builtin_uniform_element gl_ObjectPlaneS_elements[] = {
 136    {NULL, {STATE_TEXGEN, 0, STATE_TEXGEN_OBJECT_S}, SWIZZLE_XYZW},
 137 };
 138
 139 static const struct gl_builtin_uniform_element gl_ObjectPlaneT_elements[] = {
 140    {NULL, {STATE_TEXGEN, 0, STATE_TEXGEN_OBJECT_T}, SWIZZLE_XYZW},
 141 };
 142
 143 static const struct gl_builtin_uniform_element gl_ObjectPlaneR_elements[] = {
 144    {NULL, {STATE_TEXGEN, 0, STATE_TEXGEN_OBJECT_R}, SWIZZLE_XYZW},
 145 };
 146
 147 static const struct gl_builtin_uniform_element gl_ObjectPlaneQ_elements[] = {
 148    {NULL, {STATE_TEXGEN, 0, STATE_TEXGEN_OBJECT_Q}, SWIZZLE_XYZW},
 149 };
 150
 151 static const struct gl_builtin_uniform_element gl_Fog_elements[] = {
 152    {"color", {STATE_FOG_COLOR}, SWIZZLE_XYZW},
 153    {"density", {STATE_FOG_PARAMS}, SWIZZLE_XXXX},
 154    {"start", {STATE_FOG_PARAMS}, SWIZZLE_YYYY},
 155    {"end", {STATE_FOG_PARAMS}, SWIZZLE_ZZZZ},
 156    {"scale", {STATE_FOG_PARAMS}, SWIZZLE_WWWW},
 157 };
 158
 159 static const struct gl_builtin_uniform_element gl_NormalScale_elements[] = {
 160    {NULL, {STATE_NORMAL_SCALE}, SWIZZLE_XXXX},
 161 };
 162
 163 static const struct gl_builtin_uniform_element gl_FogParamsOptimizedMESA_elements[] = {
 164    {NULL, {STATE_INTERNAL, STATE_FOG_PARAMS_OPTIMIZED}, SWIZZLE_XYZW},
 165 };
 166
 167 static const struct gl_builtin_uniform_element gl_CurrentAttribVertMESA_elements[] = {
 168    {NULL, {STATE_INTERNAL, STATE_CURRENT_ATTRIB, 0}, SWIZZLE_XYZW},
 169 };
 170
 171 static const struct gl_builtin_uniform_element gl_CurrentAttribFragMESA_elements[] = {
 172    {NULL, {STATE_INTERNAL, STATE_CURRENT_ATTRIB_MAYBE_VP_CLAMPED, 0}, SWIZZLE_XYZW},
 173 };
 174
 175 #define MATRIX(name, statevar, modifier)                                \
 176    static const struct gl_builtin_uniform_element name ## _elements[] = { \
 177       { NULL, { statevar, 0, 0, 0, modifier}, SWIZZLE_XYZW },           \
 178       { NULL, { statevar, 0, 1, 1, modifier}, SWIZZLE_XYZW },           \
 179       { NULL, { statevar, 0, 2, 2, modifier}, SWIZZLE_XYZW },           \
 180       { NULL, { statevar, 0, 3, 3, modifier}, SWIZZLE_XYZW },           \
 181    }
 182
 183 MATRIX(gl_ModelViewMatrix,
 184        STATE_MODELVIEW_MATRIX, STATE_MATRIX_TRANSPOSE);
 185 MATRIX(gl_ModelViewMatrixInverse,
 186        STATE_MODELVIEW_MATRIX, STATE_MATRIX_INVTRANS);
 187 MATRIX(gl_ModelViewMatrixTranspose,
 188        STATE_MODELVIEW_MATRIX, 0);
 189 MATRIX(gl_ModelViewMatrixInverseTranspose,
 190        STATE_MODELVIEW_MATRIX, STATE_MATRIX_INVERSE);
 191
 192 MATRIX(gl_ProjectionMatrix,
 193        STATE_PROJECTION_MATRIX, STATE_MATRIX_TRANSPOSE);
 194 MATRIX(gl_ProjectionMatrixInverse,
 195        STATE_PROJECTION_MATRIX, STATE_MATRIX_INVTRANS);
 196 MATRIX(gl_ProjectionMatrixTranspose,
 197        STATE_PROJECTION_MATRIX, 0);
 198 MATRIX(gl_ProjectionMatrixInverseTranspose,
 199        STATE_PROJECTION_MATRIX, STATE_MATRIX_INVERSE);
 200
 201 MATRIX(gl_ModelViewProjectionMatrix,
 202        STATE_MVP_MATRIX, STATE_MATRIX_TRANSPOSE);
 203 MATRIX(gl_ModelViewProjectionMatrixInverse,
 204        STATE_MVP_MATRIX, STATE_MATRIX_INVTRANS);
 205 MATRIX(gl_ModelViewProjectionMatrixTranspose,
 206        STATE_MVP_MATRIX, 0);
 207 MATRIX(gl_ModelViewProjectionMatrixInverseTranspose,
 208        STATE_MVP_MATRIX, STATE_MATRIX_INVERSE);
 209
 210 MATRIX(gl_TextureMatrix,
 211        STATE_TEXTURE_MATRIX, STATE_MATRIX_TRANSPOSE);
 212 MATRIX(gl_TextureMatrixInverse,
 213        STATE_TEXTURE_MATRIX, STATE_MATRIX_INVTRANS);
 214 MATRIX(gl_TextureMatrixTranspose,
 215        STATE_TEXTURE_MATRIX, 0);
 216 MATRIX(gl_TextureMatrixInverseTranspose,
 217        STATE_TEXTURE_MATRIX, STATE_MATRIX_INVERSE);
 218
 219 static const struct gl_builtin_uniform_element gl_NormalMatrix_elements[] = {
 220    { NULL, { STATE_MODELVIEW_MATRIX, 0, 0, 0, STATE_MATRIX_INVERSE},
 221      MAKE_SWIZZLE4(SWIZZLE_X, SWIZZLE_Y, SWIZZLE_Z, SWIZZLE_Z) },
 222    { NULL, { STATE_MODELVIEW_MATRIX, 0, 1, 1, STATE_MATRIX_INVERSE},
 223      MAKE_SWIZZLE4(SWIZZLE_X, SWIZZLE_Y, SWIZZLE_Z, SWIZZLE_Z) },
 224    { NULL, { STATE_MODELVIEW_MATRIX, 0, 2, 2, STATE_MATRIX_INVERSE},
 225      MAKE_SWIZZLE4(SWIZZLE_X, SWIZZLE_Y, SWIZZLE_Z, SWIZZLE_Z) },
 226 };
 227
 228 #undef MATRIX
 229
 230 #define STATEVAR(name) {#name, name ## _elements, ARRAY_SIZE(name ## _elements)}
 231
 232 static const struct gl_builtin_uniform_desc _mesa_builtin_uniform_desc[] = {
 233    STATEVAR(gl_NumSamples),
 234    STATEVAR(gl_DepthRange),
 235    STATEVAR(gl_ClipPlane),
 236    STATEVAR(gl_Point),
 237    STATEVAR(gl_FrontMaterial),
 238    STATEVAR(gl_BackMaterial),
 239    STATEVAR(gl_LightSource),
 240    STATEVAR(gl_LightModel),
 241    STATEVAR(gl_FrontLightModelProduct),
 242    STATEVAR(gl_BackLightModelProduct),
 243    STATEVAR(gl_FrontLightProduct),
 244    STATEVAR(gl_BackLightProduct),
 245    STATEVAR(gl_TextureEnvColor),
 246    STATEVAR(gl_EyePlaneS),
 247    STATEVAR(gl_EyePlaneT),
 248    STATEVAR(gl_EyePlaneR),
 249    STATEVAR(gl_EyePlaneQ),
 250    STATEVAR(gl_ObjectPlaneS),
 251    STATEVAR(gl_ObjectPlaneT),
 252    STATEVAR(gl_ObjectPlaneR),
 253    STATEVAR(gl_ObjectPlaneQ),
 254    STATEVAR(gl_Fog),
 255
 256    STATEVAR(gl_ModelViewMatrix),
 257    STATEVAR(gl_ModelViewMatrixInverse),
 258    STATEVAR(gl_ModelViewMatrixTranspose),
 259    STATEVAR(gl_ModelViewMatrixInverseTranspose),
 260
 261    STATEVAR(gl_ProjectionMatrix),
 262    STATEVAR(gl_ProjectionMatrixInverse),
 263    STATEVAR(gl_ProjectionMatrixTranspose),
 264    STATEVAR(gl_ProjectionMatrixInverseTranspose),
 265
 266    STATEVAR(gl_ModelViewProjectionMatrix),
 267    STATEVAR(gl_ModelViewProjectionMatrixInverse),
 268    STATEVAR(gl_ModelViewProjectionMatrixTranspose),
 269    STATEVAR(gl_ModelViewProjectionMatrixInverseTranspose),
 270
 271    STATEVAR(gl_TextureMatrix),
 272    STATEVAR(gl_TextureMatrixInverse),
 273    STATEVAR(gl_TextureMatrixTranspose),
 274    STATEVAR(gl_TextureMatrixInverseTranspose),
 275
 276    STATEVAR(gl_NormalMatrix),
 277    STATEVAR(gl_NormalScale),
 278
 279    STATEVAR(gl_FogParamsOptimizedMESA),
 280    STATEVAR(gl_CurrentAttribVertMESA),
 281    STATEVAR(gl_CurrentAttribFragMESA),
 282
 283    {NULL, NULL, 0}
 284 };
 285
 286
 287 namespace {
 288
 289 /**
 290  * Data structure that accumulates fields for the gl_PerVertex interface
 291  * block.
 292  */
 293 class per_vertex_accumulator
 294 {
 295 public:
 296    per_vertex_accumulator();
 297    void add_field(int slot, const glsl_type *type, const char *name);
 298    const glsl_type *construct_interface_instance() const;
 299
 300 private:
 301    glsl_struct_field fields[10];
 302    unsigned num_fields;
 303 };
 304
 305
 306 per_vertex_accumulator::per_vertex_accumulator()
 307    : fields(),
 308      num_fields(0)
 309 {
 310 }
 311
 312
 313 void
 314 per_vertex_accumulator::add_field(int slot, const glsl_type *type,
 315                                   const char *name)
 316 {
 317    assert(this->num_fields < ARRAY_SIZE(this->fields));
 318    this->fields[this->num_fields].type = type;
 319    this->fields[this->num_fields].name = name;
 320    this->fields[this->num_fields].matrix_layout = GLSL_MATRIX_LAYOUT_INHERITED;
 321    this->fields[this->num_fields].location = slot;
 322    this->fields[this->num_fields].interpolation = INTERP_QUALIFIER_NONE;
 323    this->fields[this->num_fields].centroid = 0;
 324    this->fields[this->num_fields].sample = 0;
 325    this->fields[this->num_fields].patch = 0;
 326    this->num_fields++;
 327 }
 328
 329
 330 const glsl_type *
 331 per_vertex_accumulator::construct_interface_instance() const
 332 {
 333    return glsl_type::get_interface_instance(this->fields, this->num_fields,
 334                                             GLSL_INTERFACE_PACKING_STD140,
 335                                             "gl_PerVertex");
 336 }
 337
 338
 339 class builtin_variable_generator
 340 {
 341 public:
 342    builtin_variable_generator(exec_list *instructions,
 343                               struct _mesa_glsl_parse_state *state);
 344    void generate_constants();
 345    void generate_uniforms();
 346    void generate_vs_special_vars();
 347    void generate_tcs_special_vars();
 348    void generate_tes_special_vars();
 349    void generate_gs_special_vars();
 350    void generate_fs_special_vars();
 351    void generate_cs_special_vars();
 352    void generate_varyings();
 353
 354 private:
 355    const glsl_type *array(const glsl_type *base, unsigned elements)
 356    {
 357       return glsl_type::get_array_instance(base, elements);
 358    }
 359
 360    const glsl_type *type(const char *name)
 361    {
 362       return symtab->get_type(name);
 363    }
 364
 365    ir_variable *add_input(int slot, const glsl_type *type, const char *name)
 366    {
 367       return add_variable(name, type, ir_var_shader_in, slot);
 368    }
 369
 370    ir_variable *add_output(int slot, const glsl_type *type, const char *name)
 371    {
 372       return add_variable(name, type, ir_var_shader_out, slot);
 373    }
 374
 375    ir_variable *add_system_value(int slot, const glsl_type *type,
 376                                  const char *name)
 377    {
 378       return add_variable(name, type, ir_var_system_value, slot);
 379    }
 380
 381    ir_variable *add_variable(const char *name, const glsl_type *type,
 382                              enum ir_variable_mode mode, int slot);
 383    ir_variable *add_uniform(const glsl_type *type, const char *name);
 384    ir_variable *add_const(const char *name, int value);
 385    ir_variable *add_const_ivec3(const char *name, int x, int y, int z);
 386    void add_varying(int slot, const glsl_type *type, const char *name);
 387
 388    exec_list * const instructions;
 389    struct _mesa_glsl_parse_state * const state;
 390    glsl_symbol_table * const symtab;
 391
 392    /**
 393     * True if compatibility-profile-only variables should be included.  (In
 394     * desktop GL, these are always included when the GLSL version is 1.30 and
 395     * or below).
 396     */
 397    const bool compatibility;
 398
 399    const glsl_type * const bool_t;
 400    const glsl_type * const int_t;
 401    const glsl_type * const float_t;
 402    const glsl_type * const vec2_t;
 403    const glsl_type * const vec3_t;
 404    const glsl_type * const vec4_t;
 405    const glsl_type * const mat3_t;
 406    const glsl_type * const mat4_t;
 407
 408    per_vertex_accumulator per_vertex_in;
 409    per_vertex_accumulator per_vertex_out;
 410 };
 411
 412
 413 builtin_variable_generator::builtin_variable_generator(
 414    exec_list *instructions, struct _mesa_glsl_parse_state *state)
 415    : instructions(instructions), state(state), symtab(state->symbols),
 416      compatibility(!state->is_version(140, 100)),
 417      bool_t(glsl_type::bool_type), int_t(glsl_type::int_type),
 418      float_t(glsl_type::float_type), vec2_t(glsl_type::vec2_type),
 419      vec3_t(glsl_type::vec3_type), vec4_t(glsl_type::vec4_type),
 420      mat3_t(glsl_type::mat3_type), mat4_t(glsl_type::mat4_type)
 421 {
 422 }
 423
 424
 425 ir_variable *
 426 builtin_variable_generator::add_variable(const char *name,
 427                                          const glsl_type *type,
 428                                          enum ir_variable_mode mode, int slot)
 429 {
 430    ir_variable *var = new(symtab) ir_variable(type, name, mode);
 431    var->data.how_declared = ir_var_declared_implicitly;
 432
 433    switch (var->data.mode) {
 434    case ir_var_auto:
 435    case ir_var_shader_in:
 436    case ir_var_uniform:
 437    case ir_var_system_value:
 438       var->data.read_only = true;
 439       break;
 440    case ir_var_shader_out:
 441    case ir_var_shader_storage:
 442       break;
 443    default:
 444       /* The only variables that are added using this function should be
 445        * uniforms, shader storage, shader inputs, and shader outputs, constants
 446        * (which use ir_var_auto), and system values.
 447        */
 448       assert(0);
 449       break;
 450    }
 451
 452    var->data.location = slot;
 453    var->data.explicit_location = (slot >= 0);
 454    var->data.explicit_index = 0;
 455
 456    /* Once the variable is created an initialized, add it to the symbol table
 457     * and add the declaration to the IR stream.
 458     */
 459    instructions->push_tail(var);
 460
 461    symtab->add_variable(var);
 462    return var;
 463 }
 464
 465
 466 ir_variable *
 467 builtin_variable_generator::add_uniform(const glsl_type *type,
 468                                         const char *name)
 469 {
 470    ir_variable *const uni = add_variable(name, type, ir_var_uniform, -1);
 471
 472    unsigned i;
 473    for (i = 0; _mesa_builtin_uniform_desc[i].name != NULL; i++) {
 474       if (strcmp(_mesa_builtin_uniform_desc[i].name, name) == 0) {
 475          break;
 476       }
 477    }
 478
 479    assert(_mesa_builtin_uniform_desc[i].name != NULL);
 480    const struct gl_builtin_uniform_desc* const statevar =
 481       &_mesa_builtin_uniform_desc[i];
 482
 483    const unsigned array_count = type->is_array() ? type->length : 1;
 484
 485    ir_state_slot *slots =
 486       uni->allocate_state_slots(array_count * statevar->num_elements);
 487
 488    for (unsigned a = 0; a < array_count; a++) {
 489       for (unsigned j = 0; j < statevar->num_elements; j++) {
 490          const struct gl_builtin_uniform_element *element =
 491             &statevar->elements[j];
 492
 493          memcpy(slots->tokens, element->tokens, sizeof(element->tokens));
 494          if (type->is_array()) {
 495             if (strcmp(name, "gl_CurrentAttribVertMESA") == 0 ||
 496                 strcmp(name, "gl_CurrentAttribFragMESA") == 0) {
 497                slots->tokens[2] = a;
 498             } else {
 499                slots->tokens[1] = a;
 500             }
 501          }
 502
 503          slots->swizzle = element->swizzle;
 504          slots++;
 505       }
 506    }
 507
 508    return uni;
 509 }
 510
 511
 512 ir_variable *
 513 builtin_variable_generator::add_const(const char *name, int value)
 514 {
 515    ir_variable *const var = add_variable(name, glsl_type::int_type,
 516                                          ir_var_auto, -1);
 517    var->constant_value = new(var) ir_constant(value);
 518    var->constant_initializer = new(var) ir_constant(value);
 519    var->data.has_initializer = true;
 520    return var;
 521 }
 522
 523
 524 ir_variable *
 525 builtin_variable_generator::add_const_ivec3(const char *name, int x, int y,
 526                                             int z)
 527 {
 528    ir_variable *const var = add_variable(name, glsl_type::ivec3_type,
 529                                          ir_var_auto, -1);
 530    ir_constant_data data;
 531    memset(&data, 0, sizeof(data));
 532    data.i[0] = x;
 533    data.i[1] = y;
 534    data.i[2] = z;
 535    var->constant_value = new(var) ir_constant(glsl_type::ivec3_type, &data);
 536    var->constant_initializer =
 537       new(var) ir_constant(glsl_type::ivec3_type, &data);
 538    var->data.has_initializer = true;
 539    return var;
 540 }
 541
 542
 543 void
 544 builtin_variable_generator::generate_constants()
 545 {
 546    add_const("gl_MaxVertexAttribs", state->Const.MaxVertexAttribs);
 547    add_const("gl_MaxVertexTextureImageUnits",
 548              state->Const.MaxVertexTextureImageUnits);
 549    add_const("gl_MaxCombinedTextureImageUnits",
 550              state->Const.MaxCombinedTextureImageUnits);
 551    add_const("gl_MaxTextureImageUnits", state->Const.MaxTextureImageUnits);
 552    add_const("gl_MaxDrawBuffers", state->Const.MaxDrawBuffers);
 553
 554    /* Max uniforms/varyings: GLSL ES counts these in units of vectors; desktop
 555     * GL counts them in units of "components" or "floats".
 556     */
 557    if (state->es_shader) {
 558       add_const("gl_MaxVertexUniformVectors",
 559                 state->Const.MaxVertexUniformComponents / 4);
 560       add_const("gl_MaxFragmentUniformVectors",
 561                 state->Const.MaxFragmentUniformComponents / 4);
 562
 563       /* In GLSL ES 3.00, gl_MaxVaryingVectors was split out to separate
 564        * vertex and fragment shader constants.
 565        */
 566       if (state->is_version(0, 300)) {
 567          add_const("gl_MaxVertexOutputVectors",
 568                    state->ctx->Const.Program[MESA_SHADER_VERTEX].MaxOutputComponents / 4);
 569          add_const("gl_MaxFragmentInputVectors",
 570                    state->ctx->Const.Program[MESA_SHADER_FRAGMENT].MaxInputComponents / 4);
 571       } else {
 572          add_const("gl_MaxVaryingVectors",
 573                    state->ctx->Const.MaxVarying);
 574       }
 575    } else {
 576       add_const("gl_MaxVertexUniformComponents",
 577                 state->Const.MaxVertexUniformComponents);
 578
 579       /* Note: gl_MaxVaryingFloats was deprecated in GLSL 1.30+, but not
 580        * removed
 581        */
 582       add_const("gl_MaxVaryingFloats", state->ctx->Const.MaxVarying * 4);
 583
 584       add_const("gl_MaxFragmentUniformComponents",
 585                 state->Const.MaxFragmentUniformComponents);
 586    }
 587
 588    /* Texel offsets were introduced in ARB_shading_language_420pack (which
 589     * requires desktop GLSL version 130), and adopted into desktop GLSL
 590     * version 4.20 and GLSL ES version 3.00.
 591     */
 592    if ((state->is_version(130, 0) &&
 593         state->ARB_shading_language_420pack_enable) ||
 594       state->is_version(420, 300)) {
 595       add_const("gl_MinProgramTexelOffset",
 596                 state->Const.MinProgramTexelOffset);
 597       add_const("gl_MaxProgramTexelOffset",
 598                 state->Const.MaxProgramTexelOffset);
 599    }
 600
 601    if (state->is_version(130, 0)) {
 602       add_const("gl_MaxClipDistances", state->Const.MaxClipPlanes);
 603       add_const("gl_MaxVaryingComponents", state->ctx->Const.MaxVarying * 4);
 604    }
 605
 606    if (state->is_version(150, 0)) {
 607       add_const("gl_MaxVertexOutputComponents",
 608                 state->Const.MaxVertexOutputComponents);
 609       add_const("gl_MaxGeometryInputComponents",
 610                 state->Const.MaxGeometryInputComponents);
 611       add_const("gl_MaxGeometryOutputComponents",
 612                 state->Const.MaxGeometryOutputComponents);
 613       add_const("gl_MaxFragmentInputComponents",
 614                 state->Const.MaxFragmentInputComponents);
 615       add_const("gl_MaxGeometryTextureImageUnits",
 616                 state->Const.MaxGeometryTextureImageUnits);
 617       add_const("gl_MaxGeometryOutputVertices",
 618                 state->Const.MaxGeometryOutputVertices);
 619       add_const("gl_MaxGeometryTotalOutputComponents",
 620                 state->Const.MaxGeometryTotalOutputComponents);
 621       add_const("gl_MaxGeometryUniformComponents",
 622                 state->Const.MaxGeometryUniformComponents);
 623
 624       /* Note: the GLSL 1.50-4.40 specs require
 625        * gl_MaxGeometryVaryingComponents to be present, and to be at least 64.
 626        * But they do not define what it means (and there does not appear to be
 627        * any corresponding constant in the GL specs).  However,
 628        * ARB_geometry_shader4 defines MAX_GEOMETRY_VARYING_COMPONENTS_ARB to
 629        * be the maximum number of components available for use as geometry
 630        * outputs.  So we assume this is a synonym for
 631        * gl_MaxGeometryOutputComponents.
 632        */
 633       add_const("gl_MaxGeometryVaryingComponents",
 634                 state->Const.MaxGeometryOutputComponents);
 635    }
 636
 637    if (compatibility) {
 638       /* Note: gl_MaxLights stopped being listed as an explicit constant in
 639        * GLSL 1.30, however it continues to be referred to (as a minimum size
 640        * for compatibility-mode uniforms) all the way up through GLSL 4.30, so
 641        * this seems like it was probably an oversight.
 642        */
 643       add_const("gl_MaxLights", state->Const.MaxLights);
 644
 645       add_const("gl_MaxClipPlanes", state->Const.MaxClipPlanes);
 646
 647       /* Note: gl_MaxTextureUnits wasn't made compatibility-only until GLSL
 648        * 1.50, however this seems like it was probably an oversight.
 649        */
 650       add_const("gl_MaxTextureUnits", state->Const.MaxTextureUnits);
 651
 652       /* Note: gl_MaxTextureCoords was left out of GLSL 1.40, but it was
 653        * re-introduced in GLSL 1.50, so this seems like it was probably an
 654        * oversight.
 655        */
 656       add_const("gl_MaxTextureCoords", state->Const.MaxTextureCoords);
 657    }
 658
 659    if (state->has_atomic_counters()) {
 660       add_const("gl_MaxVertexAtomicCounters",
 661                 state->Const.MaxVertexAtomicCounters);
 662       add_const("gl_MaxFragmentAtomicCounters",
 663                 state->Const.MaxFragmentAtomicCounters);
 664       add_const("gl_MaxCombinedAtomicCounters",
 665                 state->Const.MaxCombinedAtomicCounters);
 666       add_const("gl_MaxAtomicCounterBindings",
 667                 state->Const.MaxAtomicBufferBindings);
 668
 669       /* When Mesa adds support for GL_OES_geometry_shader and
 670        * GL_OES_tessellation_shader, this will need to change.
 671        */
 672       if (!state->es_shader) {
 673          add_const("gl_MaxGeometryAtomicCounters",
 674                    state->Const.MaxGeometryAtomicCounters);
 675
 676          if (state->is_version(400, 0) ||
 677              state->ARB_tessellation_shader_enable) {
 678                  add_const("gl_MaxTessControlAtomicCounters",
 679                            state->Const.MaxTessControlAtomicCounters);
 680                  add_const("gl_MaxTessEvaluationAtomicCounters",
 681                            state->Const.MaxTessEvaluationAtomicCounters);
 682          }
 683       }
 684    }
 685
 686    if (state->is_version(420, 310)) {
 687       add_const("gl_MaxVertexAtomicCounterBuffers",
 688                 state->Const.MaxVertexAtomicCounterBuffers);
 689       add_const("gl_MaxFragmentAtomicCounterBuffers",
 690                 state->Const.MaxFragmentAtomicCounterBuffers);
 691       add_const("gl_MaxCombinedAtomicCounterBuffers",
 692                 state->Const.MaxCombinedAtomicCounterBuffers);
 693       add_const("gl_MaxAtomicCounterBufferSize",
 694                 state->Const.MaxAtomicCounterBufferSize);
 695
 696       /* When Mesa adds support for GL_OES_geometry_shader and
 697        * GL_OES_tessellation_shader, this will need to change.
 698        */
 699       if (!state->es_shader) {
 700          add_const("gl_MaxGeometryAtomicCounterBuffers",
 701                    state->Const.MaxGeometryAtomicCounterBuffers);
 702          add_const("gl_MaxTessControlAtomicCounterBuffers",
 703                    state->Const.MaxTessControlAtomicCounterBuffers);
 704          add_const("gl_MaxTessEvaluationAtomicCounterBuffers",
 705                    state->Const.MaxTessEvaluationAtomicCounterBuffers);
 706       }
 707    }
 708
 709    if (state->is_version(430, 0) || state->ARB_compute_shader_enable) {
 710       add_const("gl_MaxComputeAtomicCounterBuffers", MAX_COMPUTE_ATOMIC_COUNTER_BUFFERS);
 711       add_const("gl_MaxComputeAtomicCounters", MAX_COMPUTE_ATOMIC_COUNTERS);
 712       add_const("gl_MaxComputeImageUniforms", MAX_COMPUTE_IMAGE_UNIFORMS);
 713       add_const("gl_MaxComputeTextureImageUnits", MAX_COMPUTE_TEXTURE_IMAGE_UNITS);
 714       add_const("gl_MaxComputeUniformComponents", MAX_COMPUTE_UNIFORM_COMPONENTS);
 715
 716       add_const_ivec3("gl_MaxComputeWorkGroupCount",
 717                       state->Const.MaxComputeWorkGroupCount[0],
 718                       state->Const.MaxComputeWorkGroupCount[1],
 719                       state->Const.MaxComputeWorkGroupCount[2]);
 720       add_const_ivec3("gl_MaxComputeWorkGroupSize",
 721                       state->Const.MaxComputeWorkGroupSize[0],
 722                       state->Const.MaxComputeWorkGroupSize[1],
 723                       state->Const.MaxComputeWorkGroupSize[2]);
 724
 725       /* From the GLSL 4.40 spec, section 7.1 (Built-In Language Variables):
 726        *
 727        *     The built-in constant gl_WorkGroupSize is a compute-shader
 728        *     constant containing the local work-group size of the shader.  The
 729        *     size of the work group in the X, Y, and Z dimensions is stored in
 730        *     the x, y, and z components.  The constants values in
 731        *     gl_WorkGroupSize will match those specified in the required
 732        *     local_size_x, local_size_y, and local_size_z layout qualifiers
 733        *     for the current shader.  This is a constant so that it can be
 734        *     used to size arrays of memory that can be shared within the local
 735        *     work group.  It is a compile-time error to use gl_WorkGroupSize
 736        *     in a shader that does not declare a fixed local group size, or
 737        *     before that shader has declared a fixed local group size, using
 738        *     local_size_x, local_size_y, and local_size_z.
 739        *
 740        * To prevent the shader from trying to refer to gl_WorkGroupSize before
 741        * the layout declaration, we don't define it here.  Intead we define it
 742        * in ast_cs_input_layout::hir().
 743        */
 744    }
 745
 746    if (state->is_version(420, 310) ||
 747        state->ARB_shader_image_load_store_enable) {
 748       add_const("gl_MaxImageUnits",
 749                 state->Const.MaxImageUnits);
 750       add_const("gl_MaxVertexImageUniforms",
 751                 state->Const.MaxVertexImageUniforms);
 752       add_const("gl_MaxFragmentImageUniforms",
 753                 state->Const.MaxFragmentImageUniforms);
 754       add_const("gl_MaxCombinedImageUniforms",
 755                 state->Const.MaxCombinedImageUniforms);
 756
 757       if (!state->es_shader) {
 758          add_const("gl_MaxCombinedImageUnitsAndFragmentOutputs",
 759                    state->Const.MaxCombinedShaderOutputResources);
 760          add_const("gl_MaxImageSamples",
 761                    state->Const.MaxImageSamples);
 762          add_const("gl_MaxGeometryImageUniforms",
 763                    state->Const.MaxGeometryImageUniforms);
 764       }
 765
 766       if (state->is_version(450, 310)) {
 767          add_const("gl_MaxCombinedShaderOutputResources",
 768                    state->Const.MaxCombinedShaderOutputResources);
 769       }
 770
 771       if (state->is_version(400, 0) ||
 772           state->ARB_tessellation_shader_enable) {
 773          add_const("gl_MaxTessControlImageUniforms",
 774                    state->Const.MaxTessControlImageUniforms);
 775          add_const("gl_MaxTessEvaluationImageUniforms",
 776                    state->Const.MaxTessEvaluationImageUniforms);
 777       }
 778    }
 779
 780    if (state->is_version(410, 0) ||
 781        state->ARB_viewport_array_enable)
 782       add_const("gl_MaxViewports", state->Const.MaxViewports);
 783
 784    if (state->is_version(400, 0) ||
 785        state->ARB_tessellation_shader_enable) {
 786       add_const("gl_MaxPatchVertices", state->Const.MaxPatchVertices);
 787       add_const("gl_MaxTessGenLevel", state->Const.MaxTessGenLevel);
 788       add_const("gl_MaxTessControlInputComponents", state->Const.MaxTessControlInputComponents);
 789       add_const("gl_MaxTessControlOutputComponents", state->Const.MaxTessControlOutputComponents);
 790       add_const("gl_MaxTessControlTextureImageUnits", state->Const.MaxTessControlTextureImageUnits);
 791       add_const("gl_MaxTessEvaluationInputComponents", state->Const.MaxTessEvaluationInputComponents);
 792       add_const("gl_MaxTessEvaluationOutputComponents", state->Const.MaxTessEvaluationOutputComponents);
 793       add_const("gl_MaxTessEvaluationTextureImageUnits", state->Const.MaxTessEvaluationTextureImageUnits);
 794       add_const("gl_MaxTessPatchComponents", state->Const.MaxTessPatchComponents);
 795       add_const("gl_MaxTessControlTotalOutputComponents", state->Const.MaxTessControlTotalOutputComponents);
 796       add_const("gl_MaxTessControlUniformComponents", state->Const.MaxTessControlUniformComponents);
 797       add_const("gl_MaxTessEvaluationUniformComponents", state->Const.MaxTessEvaluationUniformComponents);
 798    }
 799 }
 800
 801
 802 /**
 803  * Generate uniform variables (which exist in all types of shaders).
 804  */
 805 void
 806 builtin_variable_generator::generate_uniforms()
 807 {
 808    if (state->is_version(400, 0) || state->ARB_sample_shading_enable)
 809       add_uniform(int_t, "gl_NumSamples");
 810    add_uniform(type("gl_DepthRangeParameters"), "gl_DepthRange");
 811    add_uniform(array(vec4_t, VERT_ATTRIB_MAX), "gl_CurrentAttribVertMESA");
 812    add_uniform(array(vec4_t, VARYING_SLOT_MAX), "gl_CurrentAttribFragMESA");
 813
 814    if (compatibility) {
 815       add_uniform(mat4_t, "gl_ModelViewMatrix");
 816       add_uniform(mat4_t, "gl_ProjectionMatrix");
 817       add_uniform(mat4_t, "gl_ModelViewProjectionMatrix");
 818       add_uniform(mat3_t, "gl_NormalMatrix");
 819       add_uniform(mat4_t, "gl_ModelViewMatrixInverse");
 820       add_uniform(mat4_t, "gl_ProjectionMatrixInverse");
 821       add_uniform(mat4_t, "gl_ModelViewProjectionMatrixInverse");
 822       add_uniform(mat4_t, "gl_ModelViewMatrixTranspose");
 823       add_uniform(mat4_t, "gl_ProjectionMatrixTranspose");
 824       add_uniform(mat4_t, "gl_ModelViewProjectionMatrixTranspose");
 825       add_uniform(mat4_t, "gl_ModelViewMatrixInverseTranspose");
 826       add_uniform(mat4_t, "gl_ProjectionMatrixInverseTranspose");
 827       add_uniform(mat4_t, "gl_ModelViewProjectionMatrixInverseTranspose");
 828       add_uniform(float_t, "gl_NormalScale");
 829       add_uniform(type("gl_LightModelParameters"), "gl_LightModel");
 830       add_uniform(vec4_t, "gl_FogParamsOptimizedMESA");
 831
 832       const glsl_type *const mat4_array_type =
 833          array(mat4_t, state->Const.MaxTextureCoords);
 834       add_uniform(mat4_array_type, "gl_TextureMatrix");
 835       add_uniform(mat4_array_type, "gl_TextureMatrixInverse");
 836       add_uniform(mat4_array_type, "gl_TextureMatrixTranspose");
 837       add_uniform(mat4_array_type, "gl_TextureMatrixInverseTranspose");
 838
 839       add_uniform(array(vec4_t, state->Const.MaxClipPlanes), "gl_ClipPlane");
 840       add_uniform(type("gl_PointParameters"), "gl_Point");
 841
 842       const glsl_type *const material_parameters_type =
 843          type("gl_MaterialParameters");
 844       add_uniform(material_parameters_type, "gl_FrontMaterial");
 845       add_uniform(material_parameters_type, "gl_BackMaterial");
 846
 847       add_uniform(array(type("gl_LightSourceParameters"),
 848                         state->Const.MaxLights),
 849                   "gl_LightSource");
 850
 851       const glsl_type *const light_model_products_type =
 852          type("gl_LightModelProducts");
 853       add_uniform(light_model_products_type, "gl_FrontLightModelProduct");
 854       add_uniform(light_model_products_type, "gl_BackLightModelProduct");
 855
 856       const glsl_type *const light_products_type =
 857          array(type("gl_LightProducts"), state->Const.MaxLights);
 858       add_uniform(light_products_type, "gl_FrontLightProduct");
 859       add_uniform(light_products_type, "gl_BackLightProduct");
 860
 861       add_uniform(array(vec4_t, state->Const.MaxTextureUnits),
 862                   "gl_TextureEnvColor");
 863
 864       const glsl_type *const texcoords_vec4 =
 865          array(vec4_t, state->Const.MaxTextureCoords);
 866       add_uniform(texcoords_vec4, "gl_EyePlaneS");
 867       add_uniform(texcoords_vec4, "gl_EyePlaneT");
 868       add_uniform(texcoords_vec4, "gl_EyePlaneR");
 869       add_uniform(texcoords_vec4, "gl_EyePlaneQ");
 870       add_uniform(texcoords_vec4, "gl_ObjectPlaneS");
 871       add_uniform(texcoords_vec4, "gl_ObjectPlaneT");
 872       add_uniform(texcoords_vec4, "gl_ObjectPlaneR");
 873       add_uniform(texcoords_vec4, "gl_ObjectPlaneQ");
 874
 875       add_uniform(type("gl_FogParameters"), "gl_Fog");
 876    }
 877 }
 878
 879
 880 /**
 881  * Generate variables which only exist in vertex shaders.
 882  */
 883 void
 884 builtin_variable_generator::generate_vs_special_vars()
 885 {
 886    if (state->is_version(130, 300))
 887       add_system_value(SYSTEM_VALUE_VERTEX_ID, int_t, "gl_VertexID");
 888    if (state->ARB_draw_instanced_enable)
 889       add_system_value(SYSTEM_VALUE_INSTANCE_ID, int_t, "gl_InstanceIDARB");
 890    if (state->ARB_draw_instanced_enable || state->is_version(140, 300))
 891       add_system_value(SYSTEM_VALUE_INSTANCE_ID, int_t, "gl_InstanceID");
 892    if (state->AMD_vertex_shader_layer_enable)
 893       add_output(VARYING_SLOT_LAYER, int_t, "gl_Layer");
 894    if (state->AMD_vertex_shader_viewport_index_enable)
 895       add_output(VARYING_SLOT_VIEWPORT, int_t, "gl_ViewportIndex");
 896    if (compatibility) {
 897       add_input(VERT_ATTRIB_POS, vec4_t, "gl_Vertex");
 898       add_input(VERT_ATTRIB_NORMAL, vec3_t, "gl_Normal");
 899       add_input(VERT_ATTRIB_COLOR0, vec4_t, "gl_Color");
 900       add_input(VERT_ATTRIB_COLOR1, vec4_t, "gl_SecondaryColor");
 901       add_input(VERT_ATTRIB_TEX0, vec4_t, "gl_MultiTexCoord0");
 902       add_input(VERT_ATTRIB_TEX1, vec4_t, "gl_MultiTexCoord1");
 903       add_input(VERT_ATTRIB_TEX2, vec4_t, "gl_MultiTexCoord2");
 904       add_input(VERT_ATTRIB_TEX3, vec4_t, "gl_MultiTexCoord3");
 905       add_input(VERT_ATTRIB_TEX4, vec4_t, "gl_MultiTexCoord4");
 906       add_input(VERT_ATTRIB_TEX5, vec4_t, "gl_MultiTexCoord5");
 907       add_input(VERT_ATTRIB_TEX6, vec4_t, "gl_MultiTexCoord6");
 908       add_input(VERT_ATTRIB_TEX7, vec4_t, "gl_MultiTexCoord7");
 909       add_input(VERT_ATTRIB_FOG, float_t, "gl_FogCoord");
 910    }
 911 }
 912
 913
 914 /**
 915  * Generate variables which only exist in tessellation control shaders.
 916  */
 917 void
 918 builtin_variable_generator::generate_tcs_special_vars()
 919 {
 920    add_system_value(SYSTEM_VALUE_PRIMITIVE_ID, int_t, "gl_PrimitiveID");
 921    add_system_value(SYSTEM_VALUE_VERTICES_IN, int_t, "gl_PatchVerticesIn");
 922    add_system_value(SYSTEM_VALUE_INVOCATION_ID, int_t, "gl_InvocationID");
 923
 924    add_output(VARYING_SLOT_TESS_LEVEL_OUTER, array(float_t, 4),
 925               "gl_TessLevelOuter")->data.patch = 1;
 926    add_output(VARYING_SLOT_TESS_LEVEL_INNER, array(float_t, 2),
 927               "gl_TessLevelInner")->data.patch = 1;
 928 }
 929
 930
 931 /**
 932  * Generate variables which only exist in tessellation evaluation shaders.
 933  */
 934 void
 935 builtin_variable_generator::generate_tes_special_vars()
 936 {
 937    add_system_value(SYSTEM_VALUE_PRIMITIVE_ID, int_t, "gl_PrimitiveID");
 938    add_system_value(SYSTEM_VALUE_VERTICES_IN, int_t, "gl_PatchVerticesIn");
 939    add_system_value(SYSTEM_VALUE_TESS_COORD, vec3_t, "gl_TessCoord");
 940    add_system_value(SYSTEM_VALUE_TESS_LEVEL_OUTER, array(float_t, 4),
 941                     "gl_TessLevelOuter");
 942    add_system_value(SYSTEM_VALUE_TESS_LEVEL_INNER, array(float_t, 2),
 943                     "gl_TessLevelInner");
 944 }
 945
 946
 947 /**
 948  * Generate variables which only exist in geometry shaders.
 949  */
 950 void
 951 builtin_variable_generator::generate_gs_special_vars()
 952 {
 953    add_output(VARYING_SLOT_LAYER, int_t, "gl_Layer");
 954    if (state->is_version(410, 0) || state->ARB_viewport_array_enable)
 955       add_output(VARYING_SLOT_VIEWPORT, int_t, "gl_ViewportIndex");
 956    if (state->is_version(400, 0) || state->ARB_gpu_shader5_enable)
 957       add_system_value(SYSTEM_VALUE_INVOCATION_ID, int_t, "gl_InvocationID");
 958
 959    /* Although gl_PrimitiveID appears in tessellation control and tessellation
 960     * evaluation shaders, it has a different function there than it has in
 961     * geometry shaders, so we treat it (and its counterpart gl_PrimitiveIDIn)
 962     * as special geometry shader variables.
 963     *
 964     * Note that although the general convention of suffixing geometry shader
 965     * input varyings with "In" was not adopted into GLSL 1.50, it is used in
 966     * the specific case of gl_PrimitiveIDIn.  So we don't need to treat
 967     * gl_PrimitiveIDIn as an {ARB,EXT}_geometry_shader4-only variable.
 968     */
 969    ir_variable *var;
 970    var = add_input(VARYING_SLOT_PRIMITIVE_ID, int_t, "gl_PrimitiveIDIn");
 971    var->data.interpolation = INTERP_QUALIFIER_FLAT;
 972    var = add_output(VARYING_SLOT_PRIMITIVE_ID, int_t, "gl_PrimitiveID");
 973    var->data.interpolation = INTERP_QUALIFIER_FLAT;
 974 }
 975
 976
 977 /**
 978  * Generate variables which only exist in fragment shaders.
 979  */
 980 void
 981 builtin_variable_generator::generate_fs_special_vars()
 982 {
 983    add_input(VARYING_SLOT_POS, vec4_t, "gl_FragCoord");
 984    add_input(VARYING_SLOT_FACE, bool_t, "gl_FrontFacing");
 985    if (state->is_version(120, 100))
 986       add_input(VARYING_SLOT_PNTC, vec2_t, "gl_PointCoord");
 987
 988    if (state->is_version(150, 0)) {
 989       ir_variable *var =
 990          add_input(VARYING_SLOT_PRIMITIVE_ID, int_t, "gl_PrimitiveID");
 991       var->data.interpolation = INTERP_QUALIFIER_FLAT;
 992    }
 993
 994    /* gl_FragColor and gl_FragData were deprecated starting in desktop GLSL
 995     * 1.30, and were relegated to the compatibility profile in GLSL 4.20.
 996     * They were removed from GLSL ES 3.00.
 997     */
 998    if (compatibility || !state->is_version(420, 300)) {
 999       add_output(FRAG_RESULT_COLOR, vec4_t, "gl_FragColor");
1000       add_output(FRAG_RESULT_DATA0,
1001                  array(vec4_t, state->Const.MaxDrawBuffers), "gl_FragData");
1002    }
1003
1004    /* gl_FragDepth has always been in desktop GLSL, but did not appear in GLSL
1005     * ES 1.00.
1006     */
1007    if (state->is_version(110, 300))
1008       add_output(FRAG_RESULT_DEPTH, float_t, "gl_FragDepth");
1009
1010    if (state->ARB_shader_stencil_export_enable) {
1011       ir_variable *const var =
1012          add_output(FRAG_RESULT_STENCIL, int_t, "gl_FragStencilRefARB");
1013       if (state->ARB_shader_stencil_export_warn)
1014          var->enable_extension_warning("GL_ARB_shader_stencil_export");
1015    }
1016
1017    if (state->AMD_shader_stencil_export_enable) {
1018       ir_variable *const var =
1019          add_output(FRAG_RESULT_STENCIL, int_t, "gl_FragStencilRefAMD");
1020       if (state->AMD_shader_stencil_export_warn)
1021          var->enable_extension_warning("GL_AMD_shader_stencil_export");
1022    }
1023
1024    if (state->is_version(400, 0) || state->ARB_sample_shading_enable) {
1025       add_system_value(SYSTEM_VALUE_SAMPLE_ID, int_t, "gl_SampleID");
1026       add_system_value(SYSTEM_VALUE_SAMPLE_POS, vec2_t, "gl_SamplePosition");
1027       /* From the ARB_sample_shading specification:
1028        *    "The number of elements in the array is ceil(<s>/32), where
1029        *    <s> is the maximum number of color samples supported by the
1030        *    implementation."
1031        * Since no drivers expose more than 32x MSAA, we can simply set
1032        * the array size to 1 rather than computing it.
1033        */
1034       add_output(FRAG_RESULT_SAMPLE_MASK, array(int_t, 1), "gl_SampleMask");
1035    }
1036
1037    if (state->is_version(400, 0) || state->ARB_gpu_shader5_enable) {
1038       add_system_value(SYSTEM_VALUE_SAMPLE_MASK_IN, array(int_t, 1), "gl_SampleMaskIn");
1039    }
1040
1041    if (state->is_version(430, 0) || state->ARB_fragment_layer_viewport_enable) {
1042       add_input(VARYING_SLOT_LAYER, int_t, "gl_Layer");
1043       add_input(VARYING_SLOT_VIEWPORT, int_t, "gl_ViewportIndex");
1044    }
1045 }
1046
1047
1048 /**
1049  * Generate variables which only exist in compute shaders.
1050  */
1051 void
1052 builtin_variable_generator::generate_cs_special_vars()
1053 {
1054    /* TODO: finish this. */
1055 }
1056
1057
1058 /**
1059  * Add a single "varying" variable.  The variable's type and direction (input
1060  * or output) are adjusted as appropriate for the type of shader being
1061  * compiled.
1062  */
1063 void
1064 builtin_variable_generator::add_varying(int slot, const glsl_type *type,
1065                                         const char *name)
1066 {
1067    switch (state->stage) {
1068    case MESA_SHADER_TESS_CTRL:
1069    case MESA_SHADER_TESS_EVAL:
1070    case MESA_SHADER_GEOMETRY:
1071       this->per_vertex_in.add_field(slot, type, name);
1072       /* FALLTHROUGH */
1073    case MESA_SHADER_VERTEX:
1074       this->per_vertex_out.add_field(slot, type, name);
1075       break;
1076    case MESA_SHADER_FRAGMENT:
1077       add_input(slot, type, name);
1078       break;
1079    case MESA_SHADER_COMPUTE:
1080       /* Compute shaders don't have varyings. */
1081       break;
1082    }
1083 }
1084
1085
1086 /**
1087  * Generate variables that are used to communicate data from one shader stage
1088  * to the next ("varyings").
1089  */
1090 void
1091 builtin_variable_generator::generate_varyings()
1092 {
1093    /* gl_Position and gl_PointSize are not visible from fragment shaders. */
1094    if (state->stage != MESA_SHADER_FRAGMENT) {
1095       add_varying(VARYING_SLOT_POS, vec4_t, "gl_Position");
1096       add_varying(VARYING_SLOT_PSIZ, float_t, "gl_PointSize");
1097    }
1098
1099    if (state->is_version(130, 0)) {
1100        add_varying(VARYING_SLOT_CLIP_DIST0, array(float_t, 0),
1101                    "gl_ClipDistance");
1102    }
1103
1104    if (compatibility) {
1105       add_varying(VARYING_SLOT_TEX0, array(vec4_t, 0), "gl_TexCoord");
1106       add_varying(VARYING_SLOT_FOGC, float_t, "gl_FogFragCoord");
1107       if (state->stage == MESA_SHADER_FRAGMENT) {
1108          add_varying(VARYING_SLOT_COL0, vec4_t, "gl_Color");
1109          add_varying(VARYING_SLOT_COL1, vec4_t, "gl_SecondaryColor");
1110       } else {
1111          add_varying(VARYING_SLOT_CLIP_VERTEX, vec4_t, "gl_ClipVertex");
1112          add_varying(VARYING_SLOT_COL0, vec4_t, "gl_FrontColor");
1113          add_varying(VARYING_SLOT_BFC0, vec4_t, "gl_BackColor");
1114          add_varying(VARYING_SLOT_COL1, vec4_t, "gl_FrontSecondaryColor");
1115          add_varying(VARYING_SLOT_BFC1, vec4_t, "gl_BackSecondaryColor");
1116       }
1117    }
1118
1119    /* Section 7.1 (Built-In Language Variables) of the GLSL 4.00 spec
1120     * says:
1121     *
1122     *    "In the tessellation control language, built-in variables are
1123     *    intrinsically declared as:
1124     *
1125     *        in gl_PerVertex {
1126     *            vec4 gl_Position;
1127     *            float gl_PointSize;
1128     *            float gl_ClipDistance[];
1129     *        } gl_in[gl_MaxPatchVertices];"
1130     */
1131    if (state->stage == MESA_SHADER_TESS_CTRL ||
1132        state->stage == MESA_SHADER_TESS_EVAL) {
1133       const glsl_type *per_vertex_in_type =
1134          this->per_vertex_in.construct_interface_instance();
1135       add_variable("gl_in", array(per_vertex_in_type, state->Const.MaxPatchVertices),
1136                    ir_var_shader_in, -1);
1137    }
1138    if (state->stage == MESA_SHADER_GEOMETRY) {
1139       const glsl_type *per_vertex_in_type =
1140          this->per_vertex_in.construct_interface_instance();
1141       add_variable("gl_in", array(per_vertex_in_type, 0),
1142                    ir_var_shader_in, -1);
1143    }
1144    if (state->stage == MESA_SHADER_TESS_CTRL) {
1145       const glsl_type *per_vertex_out_type =
1146          this->per_vertex_out.construct_interface_instance();
1147       add_variable("gl_out", array(per_vertex_out_type, 0),
1148                    ir_var_shader_out, -1);
1149    }
1150    if (state->stage == MESA_SHADER_VERTEX ||
1151        state->stage == MESA_SHADER_TESS_EVAL ||
1152        state->stage == MESA_SHADER_GEOMETRY) {
1153       const glsl_type *per_vertex_out_type =
1154          this->per_vertex_out.construct_interface_instance();
1155       const glsl_struct_field *fields = per_vertex_out_type->fields.structure;
1156       for (unsigned i = 0; i < per_vertex_out_type->length; i++) {
1157          ir_variable *var =
1158             add_variable(fields[i].name, fields[i].type, ir_var_shader_out,
1159                          fields[i].location);
1160          var->data.interpolation = fields[i].interpolation;
1161          var->data.centroid = fields[i].centroid;
1162          var->data.sample = fields[i].sample;
1163          var->data.patch = fields[i].patch;
1164          var->init_interface_type(per_vertex_out_type);
1165       }
1166    }
1167 }
1168
1169
1170 }; /* Anonymous namespace */
1171
1172
1173 void
1174 _mesa_glsl_initialize_variables(exec_list *instructions,
1175                                 struct _mesa_glsl_parse_state *state)
1176 {
1177    builtin_variable_generator gen(instructions, state);
1178
1179    gen.generate_constants();
1180    gen.generate_uniforms();
1181
1182    gen.generate_varyings();
1183
1184    switch (state->stage) {
1185    case MESA_SHADER_VERTEX:
1186       gen.generate_vs_special_vars();
1187       break;
1188    case MESA_SHADER_TESS_CTRL:
1189       gen.generate_tcs_special_vars();
1190       break;
1191    case MESA_SHADER_TESS_EVAL:
1192       gen.generate_tes_special_vars();
1193       break;
1194    case MESA_SHADER_GEOMETRY:
1195       gen.generate_gs_special_vars();
1196       break;
1197    case MESA_SHADER_FRAGMENT:
1198       gen.generate_fs_special_vars();
1199       break;
1200    case MESA_SHADER_COMPUTE:
1201       gen.generate_cs_special_vars();
1202       break;
1203    }
1204 }