src/compiler/glsl/link_uniform_initializers.cpp

   1 /*
   2  * Copyright © 2012 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 "main/core.h"
  25 #include "ir.h"
  26 #include "linker.h"
  27 #include "ir_uniform.h"
  28
  29 /* These functions are put in a "private" namespace instead of being marked
  30  * static so that the unit tests can access them.  See
  31  * http://code.google.com/p/googletest/wiki/AdvancedGuide#Testing_Private_Code
  32  */
  33 namespace linker {
  34
  35 gl_uniform_storage *
  36 get_storage(gl_uniform_storage *storage, unsigned num_storage,
  37             const char *name)
  38 {
  39    for (unsigned int i = 0; i < num_storage; i++) {
  40       if (strcmp(name, storage[i].name) == 0)
  41          return &storage[i];
  42    }
  43
  44    return NULL;
  45 }
  46
  47 void
  48 copy_constant_to_storage(union gl_constant_value *storage,
  49                          const ir_constant *val,
  50                          const enum glsl_base_type base_type,
  51                          const unsigned int elements,
  52                          unsigned int boolean_true)
  53 {
  54    for (unsigned int i = 0; i < elements; i++) {
  55       switch (base_type) {
  56       case GLSL_TYPE_UINT:
  57          storage[i].u = val->value.u[i];
  58          break;
  59       case GLSL_TYPE_INT:
  60       case GLSL_TYPE_SAMPLER:
  61          storage[i].i = val->value.i[i];
  62          break;
  63       case GLSL_TYPE_FLOAT:
  64          storage[i].f = val->value.f[i];
  65          break;
  66       case GLSL_TYPE_DOUBLE:
  67          /* XXX need to check on big-endian */
  68          memcpy(&storage[i * 2].u, &val->value.d[i], sizeof(double));
  69          break;
  70       case GLSL_TYPE_BOOL:
  71          storage[i].b = val->value.b[i] ? boolean_true : 0;
  72          break;
  73       case GLSL_TYPE_ARRAY:
  74       case GLSL_TYPE_STRUCT:
  75       case GLSL_TYPE_IMAGE:
  76       case GLSL_TYPE_ATOMIC_UINT:
  77       case GLSL_TYPE_INTERFACE:
  78       case GLSL_TYPE_VOID:
  79       case GLSL_TYPE_SUBROUTINE:
  80       case GLSL_TYPE_FUNCTION:
  81       case GLSL_TYPE_ERROR:
  82          /* All other types should have already been filtered by other
  83           * paths in the caller.
  84           */
  85          assert(!"Should not get here.");
  86          break;
  87       }
  88    }
  89 }
  90
  91 /**
  92  * Initialize an opaque uniform from the value of an explicit binding
  93  * qualifier specified in the shader.  Atomic counters are different because
  94  * they have no storage and should be handled elsewhere.
  95  */
  96 void
  97 set_opaque_binding(void *mem_ctx, gl_shader_program *prog,
  98                    const glsl_type *type, const char *name, int *binding)
  99 {
 100
 101    if (type->is_array() && type->fields.array->is_array()) {
 102       const glsl_type *const element_type = type->fields.array;
 103
 104       for (unsigned int i = 0; i < type->length; i++) {
 105          const char *element_name = ralloc_asprintf(mem_ctx, "%s[%d]", name, i);
 106
 107          set_opaque_binding(mem_ctx, prog, element_type,
 108                             element_name, binding);
 109       }
 110    } else {
 111       struct gl_uniform_storage *const storage =
 112          get_storage(prog->UniformStorage, prog->NumUniformStorage, name);
 113
 114       if (storage == NULL) {
 115          assert(storage != NULL);
 116          return;
 117       }
 118
 119       const unsigned elements = MAX2(storage->array_elements, 1);
 120
 121       /* Section 4.4.4 (Opaque-Uniform Layout Qualifiers) of the GLSL 4.20 spec
 122        * says:
 123        *
 124        *     "If the binding identifier is used with an array, the first element
 125        *     of the array takes the specified unit and each subsequent element
 126        *     takes the next consecutive unit."
 127        */
 128       for (unsigned int i = 0; i < elements; i++) {
 129          storage->storage[i].i = (*binding)++;
 130       }
 131
 132       for (int sh = 0; sh < MESA_SHADER_STAGES; sh++) {
 133         gl_linked_shader *shader = prog->_LinkedShaders[sh];
 134
 135          if (shader) {
 136             if (storage->type->base_type == GLSL_TYPE_SAMPLER &&
 137                 storage->opaque[sh].active) {
 138                for (unsigned i = 0; i < elements; i++) {
 139                   const unsigned index = storage->opaque[sh].index + i;
 140                   shader->SamplerUnits[index] = storage->storage[i].i;
 141                }
 142
 143             } else if (storage->type->base_type == GLSL_TYPE_IMAGE &&
 144                     storage->opaque[sh].active) {
 145                for (unsigned i = 0; i < elements; i++) {
 146                   const unsigned index = storage->opaque[sh].index + i;
 147                   if (index >= ARRAY_SIZE(shader->ImageUnits))
 148                      break;
 149                   shader->ImageUnits[index] = storage->storage[i].i;
 150                }
 151             }
 152          }
 153       }
 154    }
 155 }
 156
 157 void
 158 set_block_binding(gl_shader_program *prog, const char *block_name,
 159                   unsigned mode, int binding)
 160 {
 161    unsigned num_blocks = mode == ir_var_uniform ? prog->NumUniformBlocks :
 162       prog->NumShaderStorageBlocks;
 163    struct gl_uniform_block *blks = mode == ir_var_uniform ?
 164       prog->UniformBlocks : prog->ShaderStorageBlocks;
 165
 166    for (unsigned i = 0; i < num_blocks; i++) {
 167       if (!strcmp(blks[i].Name, block_name)) {
 168          blks[i].Binding = binding;
 169          return;
 170       }
 171    }
 172
 173    unreachable("Failed to initialize block binding");
 174 }
 175
 176 void
 177 set_uniform_initializer(void *mem_ctx, gl_shader_program *prog,
 178                         const char *name, const glsl_type *type,
 179                         ir_constant *val, unsigned int boolean_true)
 180 {
 181    const glsl_type *t_without_array = type->without_array();
 182    if (type->is_record()) {
 183       ir_constant *field_constant;
 184
 185       field_constant = (ir_constant *)val->components.get_head();
 186
 187       for (unsigned int i = 0; i < type->length; i++) {
 188          const glsl_type *field_type = type->fields.structure[i].type;
 189          const char *field_name = ralloc_asprintf(mem_ctx, "%s.%s", name,
 190                                             type->fields.structure[i].name);
 191          set_uniform_initializer(mem_ctx, prog, field_name,
 192                                  field_type, field_constant, boolean_true);
 193          field_constant = (ir_constant *)field_constant->next;
 194       }
 195       return;
 196    } else if (t_without_array->is_record() ||
 197               (type->is_array() && type->fields.array->is_array())) {
 198       const glsl_type *const element_type = type->fields.array;
 199
 200       for (unsigned int i = 0; i < type->length; i++) {
 201          const char *element_name = ralloc_asprintf(mem_ctx, "%s[%d]", name, i);
 202
 203          set_uniform_initializer(mem_ctx, prog, element_name,
 204                                  element_type, val->array_elements[i],
 205                                  boolean_true);
 206       }
 207       return;
 208    }
 209
 210    struct gl_uniform_storage *const storage =
 211       get_storage(prog->UniformStorage,
 212                   prog->NumUniformStorage,
 213                   name);
 214    if (storage == NULL) {
 215       assert(storage != NULL);
 216       return;
 217    }
 218
 219    if (val->type->is_array()) {
 220       const enum glsl_base_type base_type =
 221          val->array_elements[0]->type->base_type;
 222       const unsigned int elements = val->array_elements[0]->type->components();
 223       unsigned int idx = 0;
 224       unsigned dmul = glsl_base_type_is_64bit(base_type) ? 2 : 1;
 225
 226       assert(val->type->length >= storage->array_elements);
 227       for (unsigned int i = 0; i < storage->array_elements; i++) {
 228          copy_constant_to_storage(& storage->storage[idx],
 229                                   val->array_elements[i],
 230                                   base_type,
 231                                   elements,
 232                                   boolean_true);
 233
 234          idx += elements * dmul;
 235       }
 236    } else {
 237       copy_constant_to_storage(storage->storage,
 238                                val,
 239                                val->type->base_type,
 240                                val->type->components(),
 241                                boolean_true);
 242
 243       if (storage->type->is_sampler()) {
 244          for (int sh = 0; sh < MESA_SHADER_STAGES; sh++) {
 245             gl_linked_shader *shader = prog->_LinkedShaders[sh];
 246
 247             if (shader && storage->opaque[sh].active) {
 248                unsigned index = storage->opaque[sh].index;
 249
 250                shader->SamplerUnits[index] = storage->storage[0].i;
 251             }
 252          }
 253       }
 254    }
 255 }
 256 }
 257
 258 void
 259 link_set_uniform_initializers(struct gl_shader_program *prog,
 260                               unsigned int boolean_true)
 261 {
 262    void *mem_ctx = NULL;
 263
 264    for (unsigned int i = 0; i < MESA_SHADER_STAGES; i++) {
 265       struct gl_linked_shader *shader = prog->_LinkedShaders[i];
 266
 267       if (shader == NULL)
 268          continue;
 269
 270       foreach_in_list(ir_instruction, node, shader->ir) {
 271          ir_variable *const var = node->as_variable();
 272
 273          if (!var || (var->data.mode != ir_var_uniform &&
 274              var->data.mode != ir_var_shader_storage))
 275             continue;
 276
 277          if (!mem_ctx)
 278             mem_ctx = ralloc_context(NULL);
 279
 280          if (var->data.explicit_binding) {
 281             const glsl_type *const type = var->type;
 282
 283             if (type->without_array()->is_sampler() ||
 284                 type->without_array()->is_image()) {
 285                int binding = var->data.binding;
 286                linker::set_opaque_binding(mem_ctx, prog, var->type,
 287                                           var->name, &binding);
 288             } else if (var->is_in_buffer_block()) {
 289                const glsl_type *const iface_type = var->get_interface_type();
 290
 291                /* If the variable is an array and it is an interface instance,
 292                 * we need to set the binding for each array element.  Just
 293                 * checking that the variable is an array is not sufficient.
 294                 * The variable could be an array element of a uniform block
 295                 * that lacks an instance name.  For example:
 296                 *
 297                 *     uniform U {
 298                 *         float f[4];
 299                 *     };
 300                 *
 301                 * In this case "f" would pass is_in_buffer_block (above) and
 302                 * type->is_array(), but it will fail is_interface_instance().
 303                 */
 304                if (var->is_interface_instance() && var->type->is_array()) {
 305                   for (unsigned i = 0; i < var->type->length; i++) {
 306                      const char *name =
 307                         ralloc_asprintf(mem_ctx, "%s[%u]", iface_type->name, i);
 308
 309                      /* Section 4.4.3 (Uniform Block Layout Qualifiers) of the
 310                       * GLSL 4.20 spec says:
 311                       *
 312                       *     "If the binding identifier is used with a uniform
 313                       *     block instanced as an array then the first element
 314                       *     of the array takes the specified block binding and
 315                       *     each subsequent element takes the next consecutive
 316                       *     uniform block binding point."
 317                       */
 318                      linker::set_block_binding(prog, name, var->data.mode,
 319                                                var->data.binding + i);
 320                   }
 321                } else {
 322                   linker::set_block_binding(prog, iface_type->name,
 323                                             var->data.mode,
 324                                             var->data.binding);
 325                }
 326             } else if (type->contains_atomic()) {
 327                /* we don't actually need to do anything. */
 328             } else {
 329                assert(!"Explicit binding not on a sampler, UBO or atomic.");
 330             }
 331          } else if (var->constant_initializer) {
 332             linker::set_uniform_initializer(mem_ctx, prog, var->name,
 333                                             var->type, var->constant_initializer,
 334                                             boolean_true);
 335          }
 336       }
 337    }
 338
 339    ralloc_free(mem_ctx);
 340 }