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