src/compiler/glsl/standalone.cpp

   1 /*
   2  * Copyright © 2008, 2009 Intel Corporation
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a
   5  * copy of this software and associated documentation files (the "Software"),
   6  * to deal in the Software without restriction, including without limitation
   7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   8  * and/or sell copies of the Software, and to permit persons to whom the
   9  * Software is furnished to do so, subject to the following conditions:
  10  *
  11  * The above copyright notice and this permission notice (including the next
  12  * paragraph) shall be included in all copies or substantial portions of the
  13  * Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  18  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  21  * DEALINGS IN THE SOFTWARE.
  22  */
  23 #include <getopt.h>
  24
  25 /** @file standalone.cpp
  26  *
  27  * Standalone compiler helper lib.  Used by standalone glsl_compiler and
  28  * also available to drivers to implement their own standalone compiler
  29  * with driver backend.
  30  */
  31
  32 #include "ast.h"
  33 #include "glsl_parser_extras.h"
  34 #include "ir_optimization.h"
  35 #include "program.h"
  36 #include "program/hash_table.h"
  37 #include "loop_analysis.h"
  38 #include "standalone_scaffolding.h"
  39 #include "standalone.h"
  40
  41 static const struct standalone_options *options;
  42
  43 static void
  44 initialize_context(struct gl_context *ctx, gl_api api)
  45 {
  46    initialize_context_to_defaults(ctx, api);
  47
  48    /* The standalone compiler needs to claim support for almost
  49     * everything in order to compile the built-in functions.
  50     */
  51    ctx->Const.GLSLVersion = options->glsl_version;
  52    ctx->Extensions.ARB_ES3_compatibility = true;
  53    ctx->Const.MaxComputeWorkGroupCount[0] = 65535;
  54    ctx->Const.MaxComputeWorkGroupCount[1] = 65535;
  55    ctx->Const.MaxComputeWorkGroupCount[2] = 65535;
  56    ctx->Const.MaxComputeWorkGroupSize[0] = 1024;
  57    ctx->Const.MaxComputeWorkGroupSize[1] = 1024;
  58    ctx->Const.MaxComputeWorkGroupSize[2] = 64;
  59    ctx->Const.MaxComputeWorkGroupInvocations = 1024;
  60    ctx->Const.MaxComputeSharedMemorySize = 32768;
  61    ctx->Const.Program[MESA_SHADER_COMPUTE].MaxTextureImageUnits = 16;
  62    ctx->Const.Program[MESA_SHADER_COMPUTE].MaxUniformComponents = 1024;
  63    ctx->Const.Program[MESA_SHADER_COMPUTE].MaxCombinedUniformComponents = 1024;
  64    ctx->Const.Program[MESA_SHADER_COMPUTE].MaxInputComponents = 0; /* not used */
  65    ctx->Const.Program[MESA_SHADER_COMPUTE].MaxOutputComponents = 0; /* not used */
  66    ctx->Const.Program[MESA_SHADER_COMPUTE].MaxAtomicBuffers = 8;
  67    ctx->Const.Program[MESA_SHADER_COMPUTE].MaxAtomicCounters = 8;
  68    ctx->Const.Program[MESA_SHADER_COMPUTE].MaxImageUniforms = 8;
  69    ctx->Const.Program[MESA_SHADER_COMPUTE].MaxUniformBlocks = 12;
  70
  71    switch (ctx->Const.GLSLVersion) {
  72    case 100:
  73       ctx->Const.MaxClipPlanes = 0;
  74       ctx->Const.MaxCombinedTextureImageUnits = 8;
  75       ctx->Const.MaxDrawBuffers = 2;
  76       ctx->Const.MinProgramTexelOffset = 0;
  77       ctx->Const.MaxProgramTexelOffset = 0;
  78       ctx->Const.MaxLights = 0;
  79       ctx->Const.MaxTextureCoordUnits = 0;
  80       ctx->Const.MaxTextureUnits = 8;
  81
  82       ctx->Const.Program[MESA_SHADER_VERTEX].MaxAttribs = 8;
  83       ctx->Const.Program[MESA_SHADER_VERTEX].MaxTextureImageUnits = 0;
  84       ctx->Const.Program[MESA_SHADER_VERTEX].MaxUniformComponents = 128 * 4;
  85       ctx->Const.Program[MESA_SHADER_VERTEX].MaxCombinedUniformComponents = 128 * 4;
  86       ctx->Const.Program[MESA_SHADER_VERTEX].MaxInputComponents = 0; /* not used */
  87       ctx->Const.Program[MESA_SHADER_VERTEX].MaxOutputComponents = 32;
  88
  89       ctx->Const.Program[MESA_SHADER_FRAGMENT].MaxTextureImageUnits =
  90          ctx->Const.MaxCombinedTextureImageUnits;
  91       ctx->Const.Program[MESA_SHADER_FRAGMENT].MaxUniformComponents = 16 * 4;
  92       ctx->Const.Program[MESA_SHADER_FRAGMENT].MaxCombinedUniformComponents = 16 * 4;
  93       ctx->Const.Program[MESA_SHADER_FRAGMENT].MaxInputComponents =
  94          ctx->Const.Program[MESA_SHADER_VERTEX].MaxOutputComponents;
  95       ctx->Const.Program[MESA_SHADER_FRAGMENT].MaxOutputComponents = 0; /* not used */
  96
  97       ctx->Const.MaxVarying = ctx->Const.Program[MESA_SHADER_VERTEX].MaxOutputComponents / 4;
  98       break;
  99    case 110:
 100    case 120:
 101       ctx->Const.MaxClipPlanes = 6;
 102       ctx->Const.MaxCombinedTextureImageUnits = 2;
 103       ctx->Const.MaxDrawBuffers = 1;
 104       ctx->Const.MinProgramTexelOffset = 0;
 105       ctx->Const.MaxProgramTexelOffset = 0;
 106       ctx->Const.MaxLights = 8;
 107       ctx->Const.MaxTextureCoordUnits = 2;
 108       ctx->Const.MaxTextureUnits = 2;
 109
 110       ctx->Const.Program[MESA_SHADER_VERTEX].MaxAttribs = 16;
 111       ctx->Const.Program[MESA_SHADER_VERTEX].MaxTextureImageUnits = 0;
 112       ctx->Const.Program[MESA_SHADER_VERTEX].MaxUniformComponents = 512;
 113       ctx->Const.Program[MESA_SHADER_VERTEX].MaxCombinedUniformComponents = 512;
 114       ctx->Const.Program[MESA_SHADER_VERTEX].MaxInputComponents = 0; /* not used */
 115       ctx->Const.Program[MESA_SHADER_VERTEX].MaxOutputComponents = 32;
 116
 117       ctx->Const.Program[MESA_SHADER_FRAGMENT].MaxTextureImageUnits =
 118          ctx->Const.MaxCombinedTextureImageUnits;
 119       ctx->Const.Program[MESA_SHADER_FRAGMENT].MaxUniformComponents = 64;
 120       ctx->Const.Program[MESA_SHADER_FRAGMENT].MaxCombinedUniformComponents = 64;
 121       ctx->Const.Program[MESA_SHADER_FRAGMENT].MaxInputComponents =
 122          ctx->Const.Program[MESA_SHADER_VERTEX].MaxOutputComponents;
 123       ctx->Const.Program[MESA_SHADER_FRAGMENT].MaxOutputComponents = 0; /* not used */
 124
 125       ctx->Const.MaxVarying = ctx->Const.Program[MESA_SHADER_VERTEX].MaxOutputComponents / 4;
 126       break;
 127    case 130:
 128    case 140:
 129       ctx->Const.MaxClipPlanes = 8;
 130       ctx->Const.MaxCombinedTextureImageUnits = 16;
 131       ctx->Const.MaxDrawBuffers = 8;
 132       ctx->Const.MinProgramTexelOffset = -8;
 133       ctx->Const.MaxProgramTexelOffset = 7;
 134       ctx->Const.MaxLights = 8;
 135       ctx->Const.MaxTextureCoordUnits = 8;
 136       ctx->Const.MaxTextureUnits = 2;
 137
 138       ctx->Const.Program[MESA_SHADER_VERTEX].MaxAttribs = 16;
 139       ctx->Const.Program[MESA_SHADER_VERTEX].MaxTextureImageUnits = 16;
 140       ctx->Const.Program[MESA_SHADER_VERTEX].MaxUniformComponents = 1024;
 141       ctx->Const.Program[MESA_SHADER_VERTEX].MaxCombinedUniformComponents = 1024;
 142       ctx->Const.Program[MESA_SHADER_VERTEX].MaxInputComponents = 0; /* not used */
 143       ctx->Const.Program[MESA_SHADER_VERTEX].MaxOutputComponents = 64;
 144
 145       ctx->Const.Program[MESA_SHADER_FRAGMENT].MaxTextureImageUnits = 16;
 146       ctx->Const.Program[MESA_SHADER_FRAGMENT].MaxUniformComponents = 1024;
 147       ctx->Const.Program[MESA_SHADER_FRAGMENT].MaxCombinedUniformComponents = 1024;
 148       ctx->Const.Program[MESA_SHADER_FRAGMENT].MaxInputComponents =
 149          ctx->Const.Program[MESA_SHADER_VERTEX].MaxOutputComponents;
 150       ctx->Const.Program[MESA_SHADER_FRAGMENT].MaxOutputComponents = 0; /* not used */
 151
 152       ctx->Const.MaxVarying = ctx->Const.Program[MESA_SHADER_VERTEX].MaxOutputComponents / 4;
 153       break;
 154    case 150:
 155    case 330:
 156       ctx->Const.MaxClipPlanes = 8;
 157       ctx->Const.MaxDrawBuffers = 8;
 158       ctx->Const.MinProgramTexelOffset = -8;
 159       ctx->Const.MaxProgramTexelOffset = 7;
 160       ctx->Const.MaxLights = 8;
 161       ctx->Const.MaxTextureCoordUnits = 8;
 162       ctx->Const.MaxTextureUnits = 2;
 163
 164       ctx->Const.Program[MESA_SHADER_VERTEX].MaxAttribs = 16;
 165       ctx->Const.Program[MESA_SHADER_VERTEX].MaxTextureImageUnits = 16;
 166       ctx->Const.Program[MESA_SHADER_VERTEX].MaxUniformComponents = 1024;
 167       ctx->Const.Program[MESA_SHADER_VERTEX].MaxCombinedUniformComponents = 1024;
 168       ctx->Const.Program[MESA_SHADER_VERTEX].MaxInputComponents = 0; /* not used */
 169       ctx->Const.Program[MESA_SHADER_VERTEX].MaxOutputComponents = 64;
 170
 171       ctx->Const.Program[MESA_SHADER_GEOMETRY].MaxTextureImageUnits = 16;
 172       ctx->Const.Program[MESA_SHADER_GEOMETRY].MaxUniformComponents = 1024;
 173       ctx->Const.Program[MESA_SHADER_GEOMETRY].MaxCombinedUniformComponents = 1024;
 174       ctx->Const.Program[MESA_SHADER_GEOMETRY].MaxInputComponents =
 175          ctx->Const.Program[MESA_SHADER_VERTEX].MaxOutputComponents;
 176       ctx->Const.Program[MESA_SHADER_GEOMETRY].MaxOutputComponents = 128;
 177
 178       ctx->Const.Program[MESA_SHADER_FRAGMENT].MaxTextureImageUnits = 16;
 179       ctx->Const.Program[MESA_SHADER_FRAGMENT].MaxUniformComponents = 1024;
 180       ctx->Const.Program[MESA_SHADER_FRAGMENT].MaxCombinedUniformComponents = 1024;
 181       ctx->Const.Program[MESA_SHADER_FRAGMENT].MaxInputComponents =
 182          ctx->Const.Program[MESA_SHADER_GEOMETRY].MaxOutputComponents;
 183       ctx->Const.Program[MESA_SHADER_FRAGMENT].MaxOutputComponents = 0; /* not used */
 184
 185       ctx->Const.MaxCombinedTextureImageUnits =
 186          ctx->Const.Program[MESA_SHADER_VERTEX].MaxTextureImageUnits
 187          + ctx->Const.Program[MESA_SHADER_GEOMETRY].MaxTextureImageUnits
 188          + ctx->Const.Program[MESA_SHADER_FRAGMENT].MaxTextureImageUnits;
 189
 190       ctx->Const.MaxGeometryOutputVertices = 256;
 191       ctx->Const.MaxGeometryTotalOutputComponents = 1024;
 192
 193       ctx->Const.MaxVarying = 60 / 4;
 194       break;
 195    case 300:
 196       ctx->Const.MaxClipPlanes = 8;
 197       ctx->Const.MaxCombinedTextureImageUnits = 32;
 198       ctx->Const.MaxDrawBuffers = 4;
 199       ctx->Const.MinProgramTexelOffset = -8;
 200       ctx->Const.MaxProgramTexelOffset = 7;
 201       ctx->Const.MaxLights = 0;
 202       ctx->Const.MaxTextureCoordUnits = 0;
 203       ctx->Const.MaxTextureUnits = 0;
 204
 205       ctx->Const.Program[MESA_SHADER_VERTEX].MaxAttribs = 16;
 206       ctx->Const.Program[MESA_SHADER_VERTEX].MaxTextureImageUnits = 16;
 207       ctx->Const.Program[MESA_SHADER_VERTEX].MaxUniformComponents = 1024;
 208       ctx->Const.Program[MESA_SHADER_VERTEX].MaxCombinedUniformComponents = 1024;
 209       ctx->Const.Program[MESA_SHADER_VERTEX].MaxInputComponents = 0; /* not used */
 210       ctx->Const.Program[MESA_SHADER_VERTEX].MaxOutputComponents = 16 * 4;
 211
 212       ctx->Const.Program[MESA_SHADER_FRAGMENT].MaxTextureImageUnits = 16;
 213       ctx->Const.Program[MESA_SHADER_FRAGMENT].MaxUniformComponents = 224;
 214       ctx->Const.Program[MESA_SHADER_FRAGMENT].MaxCombinedUniformComponents = 224;
 215       ctx->Const.Program[MESA_SHADER_FRAGMENT].MaxInputComponents = 15 * 4;
 216       ctx->Const.Program[MESA_SHADER_FRAGMENT].MaxOutputComponents = 0; /* not used */
 217
 218       ctx->Const.MaxVarying = ctx->Const.Program[MESA_SHADER_FRAGMENT].MaxInputComponents / 4;
 219       break;
 220    }
 221
 222    ctx->Const.GenerateTemporaryNames = true;
 223    ctx->Const.MaxPatchVertices = 32;
 224
 225    /* GL_ARB_explicit_uniform_location, GL_MAX_UNIFORM_LOCATIONS */
 226    ctx->Const.MaxUserAssignableUniformLocations =
 227       4 * MESA_SHADER_STAGES * MAX_UNIFORMS;
 228
 229    ctx->Driver.NewShader = _mesa_new_linked_shader;
 230 }
 231
 232 /* Returned string will have 'ctx' as its ralloc owner. */
 233 static char *
 234 load_text_file(void *ctx, const char *file_name)
 235 {
 236    char *text = NULL;
 237    size_t size;
 238    size_t total_read = 0;
 239    FILE *fp = fopen(file_name, "rb");
 240
 241    if (!fp) {
 242       return NULL;
 243    }
 244
 245    fseek(fp, 0L, SEEK_END);
 246    size = ftell(fp);
 247    fseek(fp, 0L, SEEK_SET);
 248
 249    text = (char *) ralloc_size(ctx, size + 1);
 250    if (text != NULL) {
 251       do {
 252          size_t bytes = fread(text + total_read,
 253                1, size - total_read, fp);
 254          if (bytes < size - total_read) {
 255             free(text);
 256             text = NULL;
 257             goto error;
 258          }
 259
 260          if (bytes == 0) {
 261             break;
 262          }
 263
 264          total_read += bytes;
 265       } while (total_read < size);
 266
 267       text[total_read] = '\0';
 268       error:;
 269    }
 270
 271    fclose(fp);
 272
 273    return text;
 274 }
 275
 276 void
 277 compile_shader(struct gl_context *ctx, struct gl_shader *shader)
 278 {
 279    struct _mesa_glsl_parse_state *state =
 280       new(shader) _mesa_glsl_parse_state(ctx, shader->Stage, shader);
 281
 282    _mesa_glsl_compile_shader(ctx, shader, options->dump_ast, options->dump_hir);
 283
 284    /* Print out the resulting IR */
 285    if (!state->error && options->dump_lir) {
 286       _mesa_print_ir(stdout, shader->ir, state);
 287    }
 288
 289    return;
 290 }
 291
 292 void
 293 init_gl_program(struct gl_program *prog, GLenum target)
 294 {
 295    mtx_init(&prog->Mutex, mtx_plain);
 296
 297    prog->RefCount = 1;
 298    prog->Format = GL_PROGRAM_FORMAT_ASCII_ARB;
 299
 300    /* default mapping from samplers to texture units */
 301    for (int i = 0; i < MAX_SAMPLERS; i++)
 302       prog->SamplerUnits[i] = i;
 303 }
 304
 305 extern "C" struct gl_shader_program *
 306 standalone_compile_shader(const struct standalone_options *_options,
 307       unsigned num_files, char* const* files)
 308 {
 309    int status = EXIT_SUCCESS;
 310    static struct gl_context local_ctx;
 311    struct gl_context *ctx = &local_ctx;
 312    bool glsl_es = false;
 313
 314    options = _options;
 315
 316    switch (options->glsl_version) {
 317    case 100:
 318    case 300:
 319       glsl_es = true;
 320       break;
 321    case 110:
 322    case 120:
 323    case 130:
 324    case 140:
 325    case 150:
 326    case 330:
 327       glsl_es = false;
 328       break;
 329    default:
 330       fprintf(stderr, "Unrecognized GLSL version `%d'\n", options->glsl_version);
 331       return NULL;
 332    }
 333
 334    initialize_context(ctx, (glsl_es) ? API_OPENGLES2 : API_OPENGL_COMPAT);
 335
 336    struct gl_shader_program *whole_program;
 337
 338    whole_program = rzalloc (NULL, struct gl_shader_program);
 339    assert(whole_program != NULL);
 340    whole_program->InfoLog = ralloc_strdup(whole_program, "");
 341
 342    /* Created just to avoid segmentation faults */
 343    whole_program->AttributeBindings = new string_to_uint_map;
 344    whole_program->FragDataBindings = new string_to_uint_map;
 345    whole_program->FragDataIndexBindings = new string_to_uint_map;
 346
 347    for (unsigned i = 0; i < num_files; i++) {
 348       whole_program->Shaders =
 349             reralloc(whole_program, whole_program->Shaders,
 350                   struct gl_shader *, whole_program->NumShaders + 1);
 351       assert(whole_program->Shaders != NULL);
 352
 353       struct gl_shader *shader = rzalloc(whole_program, gl_shader);
 354
 355       whole_program->Shaders[whole_program->NumShaders] = shader;
 356       whole_program->NumShaders++;
 357
 358       const unsigned len = strlen(files[i]);
 359       if (len < 6)
 360          goto fail;
 361
 362       const char *const ext = & files[i][len - 5];
 363       /* TODO add support to read a .shader_test */
 364       if (strncmp(".vert", ext, 5) == 0 || strncmp(".glsl", ext, 5) == 0)
 365          shader->Type = GL_VERTEX_SHADER;
 366       else if (strncmp(".tesc", ext, 5) == 0)
 367          shader->Type = GL_TESS_CONTROL_SHADER;
 368       else if (strncmp(".tese", ext, 5) == 0)
 369          shader->Type = GL_TESS_EVALUATION_SHADER;
 370       else if (strncmp(".geom", ext, 5) == 0)
 371          shader->Type = GL_GEOMETRY_SHADER;
 372       else if (strncmp(".frag", ext, 5) == 0)
 373          shader->Type = GL_FRAGMENT_SHADER;
 374       else if (strncmp(".comp", ext, 5) == 0)
 375          shader->Type = GL_COMPUTE_SHADER;
 376       else
 377          goto fail;
 378       shader->Stage = _mesa_shader_enum_to_shader_stage(shader->Type);
 379
 380       shader->Source = load_text_file(whole_program, files[i]);
 381       if (shader->Source == NULL) {
 382          printf("File \"%s\" does not exist.\n", files[i]);
 383          exit(EXIT_FAILURE);
 384       }
 385
 386       compile_shader(ctx, shader);
 387
 388       if (strlen(shader->InfoLog) > 0) {
 389          if (!options->just_log)
 390             printf("Info log for %s:\n", files[i]);
 391
 392          printf("%s", shader->InfoLog);
 393          if (!options->just_log)
 394             printf("\n");
 395       }
 396
 397       if (!shader->CompileStatus) {
 398          status = EXIT_FAILURE;
 399          break;
 400       }
 401    }
 402
 403    if ((status == EXIT_SUCCESS) && options->do_link)  {
 404       _mesa_clear_shader_program_data(whole_program);
 405
 406       link_shaders(ctx, whole_program);
 407       status = (whole_program->LinkStatus) ? EXIT_SUCCESS : EXIT_FAILURE;
 408
 409       if (strlen(whole_program->InfoLog) > 0) {
 410          printf("\n");
 411          if (!options->just_log)
 412             printf("Info log for linking:\n");
 413          printf("%s", whole_program->InfoLog);
 414          if (!options->just_log)
 415             printf("\n");
 416       }
 417
 418       for (unsigned i = 0; i < MESA_SHADER_STAGES; i++) {
 419          struct gl_linked_shader *shader = whole_program->_LinkedShaders[i];
 420
 421          if (!shader)
 422             continue;
 423
 424          shader->Program = rzalloc(shader, gl_program);
 425          init_gl_program(shader->Program, shader->Stage);
 426       }
 427    }
 428
 429    return whole_program;
 430
 431 fail:
 432    ralloc_free(whole_program);
 433    return NULL;
 434 }
 435
 436 extern "C" void
 437 standalone_compiler_cleanup(struct gl_shader_program *whole_program)
 438 {
 439    for (unsigned i = 0; i < MESA_SHADER_STAGES; i++)
 440       ralloc_free(whole_program->_LinkedShaders[i]);
 441
 442    delete whole_program->AttributeBindings;
 443    delete whole_program->FragDataBindings;
 444    delete whole_program->FragDataIndexBindings;
 445
 446    ralloc_free(whole_program);
 447    _mesa_glsl_release_types();
 448    _mesa_glsl_release_builtin_functions();
 449 }