src/compiler/glsl/main.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 main.cpp
  26  *
  27  * This file is the main() routine and scaffolding for producing
  28  * builtin_compiler (which doesn't include builtins itself and is used
  29  * to generate the profile information for builtin_function.cpp), and
  30  * for glsl_compiler (which does include builtins and can be used to
  31  * offline compile GLSL code and examine the resulting GLSL IR.
  32  */
  33
  34 #include "ast.h"
  35 #include "glsl_parser_extras.h"
  36 #include "ir_optimization.h"
  37 #include "program.h"
  38 #include "program/hash_table.h"
  39 #include "loop_analysis.h"
  40 #include "standalone_scaffolding.h"
  41
  42 static int glsl_version = 330;
  43
  44 static void
  45 initialize_context(struct gl_context *ctx, gl_api api)
  46 {
  47    initialize_context_to_defaults(ctx, api);
  48
  49    /* The standalone compiler needs to claim support for almost
  50     * everything in order to compile the built-in functions.
  51     */
  52    ctx->Const.GLSLVersion = glsl_version;
  53    ctx->Extensions.ARB_ES3_compatibility = true;
  54    ctx->Const.MaxComputeWorkGroupCount[0] = 65535;
  55    ctx->Const.MaxComputeWorkGroupCount[1] = 65535;
  56    ctx->Const.MaxComputeWorkGroupCount[2] = 65535;
  57    ctx->Const.MaxComputeWorkGroupSize[0] = 1024;
  58    ctx->Const.MaxComputeWorkGroupSize[1] = 1024;
  59    ctx->Const.MaxComputeWorkGroupSize[2] = 64;
  60    ctx->Const.MaxComputeWorkGroupInvocations = 1024;
  61    ctx->Const.MaxComputeSharedMemorySize = 32768;
  62    ctx->Const.Program[MESA_SHADER_COMPUTE].MaxTextureImageUnits = 16;
  63    ctx->Const.Program[MESA_SHADER_COMPUTE].MaxUniformComponents = 1024;
  64    ctx->Const.Program[MESA_SHADER_COMPUTE].MaxCombinedUniformComponents = 1024;
  65    ctx->Const.Program[MESA_SHADER_COMPUTE].MaxInputComponents = 0; /* not used */
  66    ctx->Const.Program[MESA_SHADER_COMPUTE].MaxOutputComponents = 0; /* not used */
  67    ctx->Const.Program[MESA_SHADER_COMPUTE].MaxAtomicBuffers = 8;
  68    ctx->Const.Program[MESA_SHADER_COMPUTE].MaxAtomicCounters = 8;
  69    ctx->Const.Program[MESA_SHADER_COMPUTE].MaxImageUniforms = 8;
  70    ctx->Const.Program[MESA_SHADER_COMPUTE].MaxUniformBlocks = 12;
  71
  72    switch (ctx->Const.GLSLVersion) {
  73    case 100:
  74       ctx->Const.MaxClipPlanes = 0;
  75       ctx->Const.MaxCombinedTextureImageUnits = 8;
  76       ctx->Const.MaxDrawBuffers = 2;
  77       ctx->Const.MinProgramTexelOffset = 0;
  78       ctx->Const.MaxProgramTexelOffset = 0;
  79       ctx->Const.MaxLights = 0;
  80       ctx->Const.MaxTextureCoordUnits = 0;
  81       ctx->Const.MaxTextureUnits = 8;
  82
  83       ctx->Const.Program[MESA_SHADER_VERTEX].MaxAttribs = 8;
  84       ctx->Const.Program[MESA_SHADER_VERTEX].MaxTextureImageUnits = 0;
  85       ctx->Const.Program[MESA_SHADER_VERTEX].MaxUniformComponents = 128 * 4;
  86       ctx->Const.Program[MESA_SHADER_VERTEX].MaxCombinedUniformComponents = 128 * 4;
  87       ctx->Const.Program[MESA_SHADER_VERTEX].MaxInputComponents = 0; /* not used */
  88       ctx->Const.Program[MESA_SHADER_VERTEX].MaxOutputComponents = 32;
  89
  90       ctx->Const.Program[MESA_SHADER_FRAGMENT].MaxTextureImageUnits =
  91          ctx->Const.MaxCombinedTextureImageUnits;
  92       ctx->Const.Program[MESA_SHADER_FRAGMENT].MaxUniformComponents = 16 * 4;
  93       ctx->Const.Program[MESA_SHADER_FRAGMENT].MaxCombinedUniformComponents = 16 * 4;
  94       ctx->Const.Program[MESA_SHADER_FRAGMENT].MaxInputComponents =
  95          ctx->Const.Program[MESA_SHADER_VERTEX].MaxOutputComponents;
  96       ctx->Const.Program[MESA_SHADER_FRAGMENT].MaxOutputComponents = 0; /* not used */
  97
  98       ctx->Const.MaxVarying = ctx->Const.Program[MESA_SHADER_VERTEX].MaxOutputComponents / 4;
  99       break;
 100    case 110:
 101    case 120:
 102       ctx->Const.MaxClipPlanes = 6;
 103       ctx->Const.MaxCombinedTextureImageUnits = 2;
 104       ctx->Const.MaxDrawBuffers = 1;
 105       ctx->Const.MinProgramTexelOffset = 0;
 106       ctx->Const.MaxProgramTexelOffset = 0;
 107       ctx->Const.MaxLights = 8;
 108       ctx->Const.MaxTextureCoordUnits = 2;
 109       ctx->Const.MaxTextureUnits = 2;
 110
 111       ctx->Const.Program[MESA_SHADER_VERTEX].MaxAttribs = 16;
 112       ctx->Const.Program[MESA_SHADER_VERTEX].MaxTextureImageUnits = 0;
 113       ctx->Const.Program[MESA_SHADER_VERTEX].MaxUniformComponents = 512;
 114       ctx->Const.Program[MESA_SHADER_VERTEX].MaxCombinedUniformComponents = 512;
 115       ctx->Const.Program[MESA_SHADER_VERTEX].MaxInputComponents = 0; /* not used */
 116       ctx->Const.Program[MESA_SHADER_VERTEX].MaxOutputComponents = 32;
 117
 118       ctx->Const.Program[MESA_SHADER_FRAGMENT].MaxTextureImageUnits =
 119          ctx->Const.MaxCombinedTextureImageUnits;
 120       ctx->Const.Program[MESA_SHADER_FRAGMENT].MaxUniformComponents = 64;
 121       ctx->Const.Program[MESA_SHADER_FRAGMENT].MaxCombinedUniformComponents = 64;
 122       ctx->Const.Program[MESA_SHADER_FRAGMENT].MaxInputComponents =
 123          ctx->Const.Program[MESA_SHADER_VERTEX].MaxOutputComponents;
 124       ctx->Const.Program[MESA_SHADER_FRAGMENT].MaxOutputComponents = 0; /* not used */
 125
 126       ctx->Const.MaxVarying = ctx->Const.Program[MESA_SHADER_VERTEX].MaxOutputComponents / 4;
 127       break;
 128    case 130:
 129    case 140:
 130       ctx->Const.MaxClipPlanes = 8;
 131       ctx->Const.MaxCombinedTextureImageUnits = 16;
 132       ctx->Const.MaxDrawBuffers = 8;
 133       ctx->Const.MinProgramTexelOffset = -8;
 134       ctx->Const.MaxProgramTexelOffset = 7;
 135       ctx->Const.MaxLights = 8;
 136       ctx->Const.MaxTextureCoordUnits = 8;
 137       ctx->Const.MaxTextureUnits = 2;
 138
 139       ctx->Const.Program[MESA_SHADER_VERTEX].MaxAttribs = 16;
 140       ctx->Const.Program[MESA_SHADER_VERTEX].MaxTextureImageUnits = 16;
 141       ctx->Const.Program[MESA_SHADER_VERTEX].MaxUniformComponents = 1024;
 142       ctx->Const.Program[MESA_SHADER_VERTEX].MaxCombinedUniformComponents = 1024;
 143       ctx->Const.Program[MESA_SHADER_VERTEX].MaxInputComponents = 0; /* not used */
 144       ctx->Const.Program[MESA_SHADER_VERTEX].MaxOutputComponents = 64;
 145
 146       ctx->Const.Program[MESA_SHADER_FRAGMENT].MaxTextureImageUnits = 16;
 147       ctx->Const.Program[MESA_SHADER_FRAGMENT].MaxUniformComponents = 1024;
 148       ctx->Const.Program[MESA_SHADER_FRAGMENT].MaxCombinedUniformComponents = 1024;
 149       ctx->Const.Program[MESA_SHADER_FRAGMENT].MaxInputComponents =
 150          ctx->Const.Program[MESA_SHADER_VERTEX].MaxOutputComponents;
 151       ctx->Const.Program[MESA_SHADER_FRAGMENT].MaxOutputComponents = 0; /* not used */
 152
 153       ctx->Const.MaxVarying = ctx->Const.Program[MESA_SHADER_VERTEX].MaxOutputComponents / 4;
 154       break;
 155    case 150:
 156    case 330:
 157       ctx->Const.MaxClipPlanes = 8;
 158       ctx->Const.MaxDrawBuffers = 8;
 159       ctx->Const.MinProgramTexelOffset = -8;
 160       ctx->Const.MaxProgramTexelOffset = 7;
 161       ctx->Const.MaxLights = 8;
 162       ctx->Const.MaxTextureCoordUnits = 8;
 163       ctx->Const.MaxTextureUnits = 2;
 164
 165       ctx->Const.Program[MESA_SHADER_VERTEX].MaxAttribs = 16;
 166       ctx->Const.Program[MESA_SHADER_VERTEX].MaxTextureImageUnits = 16;
 167       ctx->Const.Program[MESA_SHADER_VERTEX].MaxUniformComponents = 1024;
 168       ctx->Const.Program[MESA_SHADER_VERTEX].MaxCombinedUniformComponents = 1024;
 169       ctx->Const.Program[MESA_SHADER_VERTEX].MaxInputComponents = 0; /* not used */
 170       ctx->Const.Program[MESA_SHADER_VERTEX].MaxOutputComponents = 64;
 171
 172       ctx->Const.Program[MESA_SHADER_GEOMETRY].MaxTextureImageUnits = 16;
 173       ctx->Const.Program[MESA_SHADER_GEOMETRY].MaxUniformComponents = 1024;
 174       ctx->Const.Program[MESA_SHADER_GEOMETRY].MaxCombinedUniformComponents = 1024;
 175       ctx->Const.Program[MESA_SHADER_GEOMETRY].MaxInputComponents =
 176          ctx->Const.Program[MESA_SHADER_VERTEX].MaxOutputComponents;
 177       ctx->Const.Program[MESA_SHADER_GEOMETRY].MaxOutputComponents = 128;
 178
 179       ctx->Const.Program[MESA_SHADER_FRAGMENT].MaxTextureImageUnits = 16;
 180       ctx->Const.Program[MESA_SHADER_FRAGMENT].MaxUniformComponents = 1024;
 181       ctx->Const.Program[MESA_SHADER_FRAGMENT].MaxCombinedUniformComponents = 1024;
 182       ctx->Const.Program[MESA_SHADER_FRAGMENT].MaxInputComponents =
 183          ctx->Const.Program[MESA_SHADER_GEOMETRY].MaxOutputComponents;
 184       ctx->Const.Program[MESA_SHADER_FRAGMENT].MaxOutputComponents = 0; /* not used */
 185
 186       ctx->Const.MaxCombinedTextureImageUnits =
 187          ctx->Const.Program[MESA_SHADER_VERTEX].MaxTextureImageUnits
 188          + ctx->Const.Program[MESA_SHADER_GEOMETRY].MaxTextureImageUnits
 189          + ctx->Const.Program[MESA_SHADER_FRAGMENT].MaxTextureImageUnits;
 190
 191       ctx->Const.MaxGeometryOutputVertices = 256;
 192       ctx->Const.MaxGeometryTotalOutputComponents = 1024;
 193
 194       ctx->Const.MaxVarying = 60 / 4;
 195       break;
 196    case 300:
 197       ctx->Const.MaxClipPlanes = 8;
 198       ctx->Const.MaxCombinedTextureImageUnits = 32;
 199       ctx->Const.MaxDrawBuffers = 4;
 200       ctx->Const.MinProgramTexelOffset = -8;
 201       ctx->Const.MaxProgramTexelOffset = 7;
 202       ctx->Const.MaxLights = 0;
 203       ctx->Const.MaxTextureCoordUnits = 0;
 204       ctx->Const.MaxTextureUnits = 0;
 205
 206       ctx->Const.Program[MESA_SHADER_VERTEX].MaxAttribs = 16;
 207       ctx->Const.Program[MESA_SHADER_VERTEX].MaxTextureImageUnits = 16;
 208       ctx->Const.Program[MESA_SHADER_VERTEX].MaxUniformComponents = 1024;
 209       ctx->Const.Program[MESA_SHADER_VERTEX].MaxCombinedUniformComponents = 1024;
 210       ctx->Const.Program[MESA_SHADER_VERTEX].MaxInputComponents = 0; /* not used */
 211       ctx->Const.Program[MESA_SHADER_VERTEX].MaxOutputComponents = 16 * 4;
 212
 213       ctx->Const.Program[MESA_SHADER_FRAGMENT].MaxTextureImageUnits = 16;
 214       ctx->Const.Program[MESA_SHADER_FRAGMENT].MaxUniformComponents = 224;
 215       ctx->Const.Program[MESA_SHADER_FRAGMENT].MaxCombinedUniformComponents = 224;
 216       ctx->Const.Program[MESA_SHADER_FRAGMENT].MaxInputComponents = 15 * 4;
 217       ctx->Const.Program[MESA_SHADER_FRAGMENT].MaxOutputComponents = 0; /* not used */
 218
 219       ctx->Const.MaxVarying = ctx->Const.Program[MESA_SHADER_FRAGMENT].MaxInputComponents / 4;
 220       break;
 221    }
 222
 223    ctx->Const.GenerateTemporaryNames = true;
 224    ctx->Const.MaxPatchVertices = 32;
 225
 226    ctx->Driver.NewShader = _mesa_new_shader;
 227 }
 228
 229 /* Returned string will have 'ctx' as its ralloc owner. */
 230 static char *
 231 load_text_file(void *ctx, const char *file_name)
 232 {
 233         char *text = NULL;
 234         size_t size;
 235         size_t total_read = 0;
 236         FILE *fp = fopen(file_name, "rb");
 237
 238         if (!fp) {
 239                 return NULL;
 240         }
 241
 242         fseek(fp, 0L, SEEK_END);
 243         size = ftell(fp);
 244         fseek(fp, 0L, SEEK_SET);
 245
 246         text = (char *) ralloc_size(ctx, size + 1);
 247         if (text != NULL) {
 248                 do {
 249                         size_t bytes = fread(text + total_read,
 250                                              1, size - total_read, fp);
 251                         if (bytes < size - total_read) {
 252                                 free(text);
 253                                 text = NULL;
 254                                 goto error;
 255                         }
 256
 257                         if (bytes == 0) {
 258                                 break;
 259                         }
 260
 261                         total_read += bytes;
 262                 } while (total_read < size);
 263
 264                 text[total_read] = '\0';
 265 error:;
 266         }
 267
 268         fclose(fp);
 269
 270         return text;
 271 }
 272
 273 int dump_ast = 0;
 274 int dump_hir = 0;
 275 int dump_lir = 0;
 276 int do_link = 0;
 277
 278 const struct option compiler_opts[] = {
 279    { "dump-ast", no_argument, &dump_ast, 1 },
 280    { "dump-hir", no_argument, &dump_hir, 1 },
 281    { "dump-lir", no_argument, &dump_lir, 1 },
 282    { "link",     no_argument, &do_link,  1 },
 283    { "version",  required_argument, NULL, 'v' },
 284    { NULL, 0, NULL, 0 }
 285 };
 286
 287 /**
 288  * \brief Print proper usage and exit with failure.
 289  */
 290 void
 291 usage_fail(const char *name)
 292 {
 293
 294    const char *header =
 295       "usage: %s [options] <file.vert | file.tesc | file.tese | file.geom | file.frag | file.comp>\n"
 296       "\n"
 297       "Possible options are:\n";
 298    printf(header, name);
 299    for (const struct option *o = compiler_opts; o->name != 0; ++o) {
 300       printf("    --%s\n", o->name);
 301    }
 302    exit(EXIT_FAILURE);
 303 }
 304
 305
 306 void
 307 compile_shader(struct gl_context *ctx, struct gl_shader *shader)
 308 {
 309    struct _mesa_glsl_parse_state *state =
 310       new(shader) _mesa_glsl_parse_state(ctx, shader->Stage, shader);
 311
 312    _mesa_glsl_compile_shader(ctx, shader, dump_ast, dump_hir);
 313
 314    /* Print out the resulting IR */
 315    if (!state->error && dump_lir) {
 316       _mesa_print_ir(stdout, shader->ir, state);
 317    }
 318
 319    return;
 320 }
 321
 322 int
 323 main(int argc, char **argv)
 324 {
 325    int status = EXIT_SUCCESS;
 326    struct gl_context local_ctx;
 327    struct gl_context *ctx = &local_ctx;
 328    bool glsl_es = false;
 329
 330    int c;
 331    int idx = 0;
 332    while ((c = getopt_long(argc, argv, "", compiler_opts, &idx)) != -1) {
 333       switch (c) {
 334       case 'v':
 335          glsl_version = strtol(optarg, NULL, 10);
 336          switch (glsl_version) {
 337          case 100:
 338          case 300:
 339             glsl_es = true;
 340             break;
 341          case 110:
 342          case 120:
 343          case 130:
 344          case 140:
 345          case 150:
 346          case 330:
 347             glsl_es = false;
 348             break;
 349          default:
 350             fprintf(stderr, "Unrecognized GLSL version `%s'\n", optarg);
 351             usage_fail(argv[0]);
 352             break;
 353          }
 354          break;
 355       default:
 356          break;
 357       }
 358    }
 359
 360
 361    if (argc <= optind)
 362       usage_fail(argv[0]);
 363
 364    initialize_context(ctx, (glsl_es) ? API_OPENGLES2 : API_OPENGL_COMPAT);
 365
 366    struct gl_shader_program *whole_program;
 367
 368    whole_program = rzalloc (NULL, struct gl_shader_program);
 369    assert(whole_program != NULL);
 370    whole_program->InfoLog = ralloc_strdup(whole_program, "");
 371
 372    /* Created just to avoid segmentation faults */
 373    whole_program->AttributeBindings = new string_to_uint_map;
 374    whole_program->FragDataBindings = new string_to_uint_map;
 375    whole_program->FragDataIndexBindings = new string_to_uint_map;
 376
 377    for (/* empty */; argc > optind; optind++) {
 378       whole_program->Shaders =
 379          reralloc(whole_program, whole_program->Shaders,
 380                   struct gl_shader *, whole_program->NumShaders + 1);
 381       assert(whole_program->Shaders != NULL);
 382
 383       struct gl_shader *shader = rzalloc(whole_program, gl_shader);
 384
 385       whole_program->Shaders[whole_program->NumShaders] = shader;
 386       whole_program->NumShaders++;
 387
 388       const unsigned len = strlen(argv[optind]);
 389       if (len < 6)
 390          usage_fail(argv[0]);
 391
 392       const char *const ext = & argv[optind][len - 5];
 393       if (strncmp(".vert", ext, 5) == 0 || strncmp(".glsl", ext, 5) == 0)
 394          shader->Type = GL_VERTEX_SHADER;
 395       else if (strncmp(".tesc", ext, 5) == 0)
 396          shader->Type = GL_TESS_CONTROL_SHADER;
 397       else if (strncmp(".tese", ext, 5) == 0)
 398          shader->Type = GL_TESS_EVALUATION_SHADER;
 399       else if (strncmp(".geom", ext, 5) == 0)
 400          shader->Type = GL_GEOMETRY_SHADER;
 401       else if (strncmp(".frag", ext, 5) == 0)
 402          shader->Type = GL_FRAGMENT_SHADER;
 403       else if (strncmp(".comp", ext, 5) == 0)
 404          shader->Type = GL_COMPUTE_SHADER;
 405       else
 406          usage_fail(argv[0]);
 407       shader->Stage = _mesa_shader_enum_to_shader_stage(shader->Type);
 408
 409       shader->Source = load_text_file(whole_program, argv[optind]);
 410       if (shader->Source == NULL) {
 411          printf("File \"%s\" does not exist.\n", argv[optind]);
 412          exit(EXIT_FAILURE);
 413       }
 414
 415       compile_shader(ctx, shader);
 416
 417       if (strlen(shader->InfoLog) > 0)
 418          printf("Info log for %s:\n%s\n", argv[optind], shader->InfoLog);
 419
 420       if (!shader->CompileStatus) {
 421          status = EXIT_FAILURE;
 422          break;
 423       }
 424    }
 425
 426    if ((status == EXIT_SUCCESS) && do_link)  {
 427       _mesa_clear_shader_program_data(whole_program);
 428
 429       link_shaders(ctx, whole_program);
 430       status = (whole_program->LinkStatus) ? EXIT_SUCCESS : EXIT_FAILURE;
 431
 432       if (strlen(whole_program->InfoLog) > 0)
 433          printf("Info log for linking:\n%s\n", whole_program->InfoLog);
 434    }
 435
 436    for (unsigned i = 0; i < MESA_SHADER_STAGES; i++)
 437       ralloc_free(whole_program->_LinkedShaders[i]);
 438
 439    delete whole_program->AttributeBindings;
 440    delete whole_program->FragDataBindings;
 441    delete whole_program->FragDataIndexBindings;
 442
 443    ralloc_free(whole_program);
 444    _mesa_glsl_release_types();
 445    _mesa_glsl_release_builtin_functions();
 446
 447    return status;
 448 }