src/mesa/program/program.c

   1 /*
   2  * Mesa 3-D graphics library
   3  *
   4  * Copyright (C) 1999-2007  Brian Paul   All Rights Reserved.
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a
   7  * copy of this software and associated documentation files (the "Software"),
   8  * to deal in the Software without restriction, including without limitation
   9  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  10  * and/or sell copies of the Software, and to permit persons to whom the
  11  * Software is furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included
  14  * in all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  17  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  19  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
  20  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  21  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  22  * OTHER DEALINGS IN THE SOFTWARE.
  23  */
  24
  25 /**
  26  * \file program.c
  27  * Vertex and fragment program support functions.
  28  * \author Brian Paul
  29  */
  30
  31
  32 #include "main/glheader.h"
  33 #include "main/context.h"
  34 #include "main/framebuffer.h"
  35 #include "main/hash.h"
  36 #include "main/macros.h"
  37 #include "program.h"
  38 #include "prog_cache.h"
  39 #include "prog_parameter.h"
  40 #include "prog_instruction.h"
  41 #include "util/ralloc.h"
  42
  43
  44 /**
  45  * A pointer to this dummy program is put into the hash table when
  46  * glGenPrograms is called.
  47  */
  48 struct gl_program _mesa_DummyProgram;
  49
  50
  51 /**
  52  * Init context's vertex/fragment program state
  53  */
  54 void
  55 _mesa_init_program(struct gl_context *ctx)
  56 {
  57    /*
  58     * If this assertion fails, we need to increase the field
  59     * size for register indexes (see INST_INDEX_BITS).
  60     */
  61    assert(ctx->Const.Program[MESA_SHADER_VERTEX].MaxUniformComponents / 4
  62           <= (1 << INST_INDEX_BITS));
  63    assert(ctx->Const.Program[MESA_SHADER_FRAGMENT].MaxUniformComponents / 4
  64           <= (1 << INST_INDEX_BITS));
  65
  66    assert(ctx->Const.Program[MESA_SHADER_VERTEX].MaxTemps <= (1 << INST_INDEX_BITS));
  67    assert(ctx->Const.Program[MESA_SHADER_VERTEX].MaxLocalParams <= (1 << INST_INDEX_BITS));
  68    assert(ctx->Const.Program[MESA_SHADER_FRAGMENT].MaxTemps <= (1 << INST_INDEX_BITS));
  69    assert(ctx->Const.Program[MESA_SHADER_FRAGMENT].MaxLocalParams <= (1 << INST_INDEX_BITS));
  70
  71    assert(ctx->Const.Program[MESA_SHADER_VERTEX].MaxUniformComponents <= 4 * MAX_UNIFORMS);
  72    assert(ctx->Const.Program[MESA_SHADER_FRAGMENT].MaxUniformComponents <= 4 * MAX_UNIFORMS);
  73
  74    assert(ctx->Const.Program[MESA_SHADER_VERTEX].MaxAddressOffset <= (1 << INST_INDEX_BITS));
  75    assert(ctx->Const.Program[MESA_SHADER_FRAGMENT].MaxAddressOffset <= (1 << INST_INDEX_BITS));
  76
  77    /* If this fails, increase prog_instruction::TexSrcUnit size */
  78    STATIC_ASSERT(MAX_TEXTURE_UNITS <= (1 << 5));
  79
  80    /* If this fails, increase prog_instruction::TexSrcTarget size */
  81    STATIC_ASSERT(NUM_TEXTURE_TARGETS <= (1 << 4));
  82
  83    ctx->Program.ErrorPos = -1;
  84    ctx->Program.ErrorString = strdup("");
  85
  86    ctx->VertexProgram.Enabled = GL_FALSE;
  87    ctx->VertexProgram.PointSizeEnabled =
  88       (ctx->API == API_OPENGLES2) ? GL_TRUE : GL_FALSE;
  89    ctx->VertexProgram.TwoSideEnabled = GL_FALSE;
  90    _mesa_reference_program(ctx, &ctx->VertexProgram.Current,
  91                            ctx->Shared->DefaultVertexProgram);
  92    assert(ctx->VertexProgram.Current);
  93    ctx->VertexProgram.Cache = _mesa_new_program_cache();
  94
  95    ctx->FragmentProgram.Enabled = GL_FALSE;
  96    _mesa_reference_program(ctx, &ctx->FragmentProgram.Current,
  97                            ctx->Shared->DefaultFragmentProgram);
  98    assert(ctx->FragmentProgram.Current);
  99    ctx->FragmentProgram.Cache = _mesa_new_program_cache();
 100
 101    /* XXX probably move this stuff */
 102    ctx->ATIFragmentShader.Enabled = GL_FALSE;
 103    ctx->ATIFragmentShader.Current = ctx->Shared->DefaultFragmentShader;
 104    assert(ctx->ATIFragmentShader.Current);
 105    ctx->ATIFragmentShader.Current->RefCount++;
 106 }
 107
 108
 109 /**
 110  * Free a context's vertex/fragment program state
 111  */
 112 void
 113 _mesa_free_program_data(struct gl_context *ctx)
 114 {
 115    _mesa_reference_program(ctx, &ctx->VertexProgram.Current, NULL);
 116    _mesa_delete_program_cache(ctx, ctx->VertexProgram.Cache);
 117    _mesa_reference_program(ctx, &ctx->FragmentProgram.Current, NULL);
 118    _mesa_delete_shader_cache(ctx, ctx->FragmentProgram.Cache);
 119
 120    /* XXX probably move this stuff */
 121    if (ctx->ATIFragmentShader.Current) {
 122       ctx->ATIFragmentShader.Current->RefCount--;
 123       if (ctx->ATIFragmentShader.Current->RefCount <= 0) {
 124          free(ctx->ATIFragmentShader.Current);
 125       }
 126    }
 127
 128    free((void *) ctx->Program.ErrorString);
 129 }
 130
 131
 132 /**
 133  * Update the default program objects in the given context to reference those
 134  * specified in the shared state and release those referencing the old
 135  * shared state.
 136  */
 137 void
 138 _mesa_update_default_objects_program(struct gl_context *ctx)
 139 {
 140    _mesa_reference_program(ctx, &ctx->VertexProgram.Current,
 141                            ctx->Shared->DefaultVertexProgram);
 142    assert(ctx->VertexProgram.Current);
 143
 144    _mesa_reference_program(ctx, &ctx->FragmentProgram.Current,
 145                             ctx->Shared->DefaultFragmentProgram);
 146    assert(ctx->FragmentProgram.Current);
 147
 148    /* XXX probably move this stuff */
 149    if (ctx->ATIFragmentShader.Current) {
 150       ctx->ATIFragmentShader.Current->RefCount--;
 151       if (ctx->ATIFragmentShader.Current->RefCount <= 0) {
 152          free(ctx->ATIFragmentShader.Current);
 153       }
 154    }
 155    ctx->ATIFragmentShader.Current = (struct ati_fragment_shader *) ctx->Shared->DefaultFragmentShader;
 156    assert(ctx->ATIFragmentShader.Current);
 157    ctx->ATIFragmentShader.Current->RefCount++;
 158 }
 159
 160
 161 /**
 162  * Set the vertex/fragment program error state (position and error string).
 163  * This is generally called from within the parsers.
 164  */
 165 void
 166 _mesa_set_program_error(struct gl_context *ctx, GLint pos, const char *string)
 167 {
 168    ctx->Program.ErrorPos = pos;
 169    free((void *) ctx->Program.ErrorString);
 170    if (!string)
 171       string = "";
 172    ctx->Program.ErrorString = strdup(string);
 173 }
 174
 175
 176 /**
 177  * Initialize a new gl_program object.
 178  */
 179 struct gl_program *
 180 _mesa_init_gl_program(struct gl_program *prog, GLenum target, GLuint id)
 181 {
 182    GLuint i;
 183
 184    if (!prog)
 185       return NULL;
 186
 187    memset(prog, 0, sizeof(*prog));
 188    mtx_init(&prog->Mutex, mtx_plain);
 189    prog->Id = id;
 190    prog->Target = target;
 191    prog->RefCount = 1;
 192    prog->Format = GL_PROGRAM_FORMAT_ASCII_ARB;
 193
 194    /* default mapping from samplers to texture units */
 195    for (i = 0; i < MAX_SAMPLERS; i++)
 196       prog->SamplerUnits[i] = i;
 197
 198    return prog;
 199 }
 200
 201
 202 /**
 203  * Allocate and initialize a new fragment/vertex program object but
 204  * don't put it into the program hash table.  Called via
 205  * ctx->Driver.NewProgram.  May be overridden (ie. replaced) by a
 206  * device driver function to implement OO deriviation with additional
 207  * types not understood by this function.
 208  *
 209  * \param ctx  context
 210  * \param id   program id/number
 211  * \param target  program target/type
 212  * \return  pointer to new program object
 213  */
 214 struct gl_program *
 215 _mesa_new_program(struct gl_context *ctx, GLenum target, GLuint id)
 216 {
 217    switch (target) {
 218    case GL_VERTEX_PROGRAM_ARB: /* == GL_VERTEX_PROGRAM_NV */
 219    case GL_GEOMETRY_PROGRAM_NV:
 220    case GL_TESS_CONTROL_PROGRAM_NV:
 221    case GL_TESS_EVALUATION_PROGRAM_NV:
 222    case GL_FRAGMENT_PROGRAM_ARB:
 223    case GL_COMPUTE_PROGRAM_NV: {
 224       struct gl_program *prog = CALLOC_STRUCT(gl_program);
 225       return _mesa_init_gl_program(prog, target, id);
 226    }
 227    default:
 228       _mesa_problem(ctx, "bad target in _mesa_new_program");
 229       return NULL;
 230    }
 231 }
 232
 233
 234 /**
 235  * Delete a program and remove it from the hash table, ignoring the
 236  * reference count.
 237  * Called via ctx->Driver.DeleteProgram.  May be wrapped (OO deriviation)
 238  * by a device driver function.
 239  */
 240 void
 241 _mesa_delete_program(struct gl_context *ctx, struct gl_program *prog)
 242 {
 243    (void) ctx;
 244    assert(prog);
 245    assert(prog->RefCount==0);
 246
 247    if (prog == &_mesa_DummyProgram)
 248       return;
 249
 250    free(prog->String);
 251    free(prog->LocalParams);
 252
 253    if (prog->Instructions) {
 254       _mesa_free_instructions(prog->Instructions, prog->NumInstructions);
 255    }
 256    if (prog->Parameters) {
 257       _mesa_free_parameter_list(prog->Parameters);
 258    }
 259
 260    if (prog->nir) {
 261       ralloc_free(prog->nir);
 262    }
 263
 264    mtx_destroy(&prog->Mutex);
 265    free(prog);
 266 }
 267
 268
 269 /**
 270  * Return the gl_program object for a given ID.
 271  * Basically just a wrapper for _mesa_HashLookup() to avoid a lot of
 272  * casts elsewhere.
 273  */
 274 struct gl_program *
 275 _mesa_lookup_program(struct gl_context *ctx, GLuint id)
 276 {
 277    if (id)
 278       return (struct gl_program *) _mesa_HashLookup(ctx->Shared->Programs, id);
 279    else
 280       return NULL;
 281 }
 282
 283
 284 /**
 285  * Reference counting for vertex/fragment programs
 286  * This is normally only called from the _mesa_reference_program() macro
 287  * when there's a real pointer change.
 288  */
 289 void
 290 _mesa_reference_program_(struct gl_context *ctx,
 291                          struct gl_program **ptr,
 292                          struct gl_program *prog)
 293 {
 294 #ifndef NDEBUG
 295    assert(ptr);
 296    if (*ptr && prog) {
 297       /* sanity check */
 298       if ((*ptr)->Target == GL_VERTEX_PROGRAM_ARB)
 299          assert(prog->Target == GL_VERTEX_PROGRAM_ARB);
 300       else if ((*ptr)->Target == GL_FRAGMENT_PROGRAM_ARB)
 301          assert(prog->Target == GL_FRAGMENT_PROGRAM_ARB ||
 302                 prog->Target == GL_FRAGMENT_PROGRAM_NV);
 303       else if ((*ptr)->Target == GL_GEOMETRY_PROGRAM_NV)
 304          assert(prog->Target == GL_GEOMETRY_PROGRAM_NV);
 305    }
 306 #endif
 307
 308    if (*ptr) {
 309       GLboolean deleteFlag;
 310       struct gl_program *oldProg = *ptr;
 311
 312       mtx_lock(&oldProg->Mutex);
 313       assert(oldProg->RefCount > 0);
 314       oldProg->RefCount--;
 315
 316       deleteFlag = (oldProg->RefCount == 0);
 317       mtx_unlock(&oldProg->Mutex);
 318
 319       if (deleteFlag) {
 320          assert(ctx);
 321          ctx->Driver.DeleteProgram(ctx, oldProg);
 322       }
 323
 324       *ptr = NULL;
 325    }
 326
 327    assert(!*ptr);
 328    if (prog) {
 329       mtx_lock(&prog->Mutex);
 330       prog->RefCount++;
 331       mtx_unlock(&prog->Mutex);
 332    }
 333
 334    *ptr = prog;
 335 }
 336
 337
 338 /**
 339  * Insert 'count' NOP instructions at 'start' in the given program.
 340  * Adjust branch targets accordingly.
 341  */
 342 GLboolean
 343 _mesa_insert_instructions(struct gl_program *prog, GLuint start, GLuint count)
 344 {
 345    const GLuint origLen = prog->NumInstructions;
 346    const GLuint newLen = origLen + count;
 347    struct prog_instruction *newInst;
 348    GLuint i;
 349
 350    /* adjust branches */
 351    for (i = 0; i < prog->NumInstructions; i++) {
 352       struct prog_instruction *inst = prog->Instructions + i;
 353       if (inst->BranchTarget > 0) {
 354          if ((GLuint)inst->BranchTarget >= start) {
 355             inst->BranchTarget += count;
 356          }
 357       }
 358    }
 359
 360    /* Alloc storage for new instructions */
 361    newInst = _mesa_alloc_instructions(newLen);
 362    if (!newInst) {
 363       return GL_FALSE;
 364    }
 365
 366    /* Copy 'start' instructions into new instruction buffer */
 367    _mesa_copy_instructions(newInst, prog->Instructions, start);
 368
 369    /* init the new instructions */
 370    _mesa_init_instructions(newInst + start, count);
 371
 372    /* Copy the remaining/tail instructions to new inst buffer */
 373    _mesa_copy_instructions(newInst + start + count,
 374                            prog->Instructions + start,
 375                            origLen - start);
 376
 377    /* free old instructions */
 378    _mesa_free_instructions(prog->Instructions, origLen);
 379
 380    /* install new instructions */
 381    prog->Instructions = newInst;
 382    prog->NumInstructions = newLen;
 383
 384    return GL_TRUE;
 385 }
 386
 387 /**
 388  * Delete 'count' instructions at 'start' in the given program.
 389  * Adjust branch targets accordingly.
 390  */
 391 GLboolean
 392 _mesa_delete_instructions(struct gl_program *prog, GLuint start, GLuint count)
 393 {
 394    const GLuint origLen = prog->NumInstructions;
 395    const GLuint newLen = origLen - count;
 396    struct prog_instruction *newInst;
 397    GLuint i;
 398
 399    /* adjust branches */
 400    for (i = 0; i < prog->NumInstructions; i++) {
 401       struct prog_instruction *inst = prog->Instructions + i;
 402       if (inst->BranchTarget > 0) {
 403          if (inst->BranchTarget > (GLint) start) {
 404             inst->BranchTarget -= count;
 405          }
 406       }
 407    }
 408
 409    /* Alloc storage for new instructions */
 410    newInst = _mesa_alloc_instructions(newLen);
 411    if (!newInst) {
 412       return GL_FALSE;
 413    }
 414
 415    /* Copy 'start' instructions into new instruction buffer */
 416    _mesa_copy_instructions(newInst, prog->Instructions, start);
 417
 418    /* Copy the remaining/tail instructions to new inst buffer */
 419    _mesa_copy_instructions(newInst + start,
 420                            prog->Instructions + start + count,
 421                            newLen - start);
 422
 423    /* free old instructions */
 424    _mesa_free_instructions(prog->Instructions, origLen);
 425
 426    /* install new instructions */
 427    prog->Instructions = newInst;
 428    prog->NumInstructions = newLen;
 429
 430    return GL_TRUE;
 431 }
 432
 433
 434 /**
 435  * Populate the 'used' array with flags indicating which registers (TEMPs,
 436  * INPUTs, OUTPUTs, etc, are used by the given program.
 437  * \param file  type of register to scan for
 438  * \param used  returns true/false flags for in use / free
 439  * \param usedSize  size of the 'used' array
 440  */
 441 void
 442 _mesa_find_used_registers(const struct gl_program *prog,
 443                           gl_register_file file,
 444                           GLboolean used[], GLuint usedSize)
 445 {
 446    GLuint i, j;
 447
 448    memset(used, 0, usedSize);
 449
 450    for (i = 0; i < prog->NumInstructions; i++) {
 451       const struct prog_instruction *inst = prog->Instructions + i;
 452       const GLuint n = _mesa_num_inst_src_regs(inst->Opcode);
 453
 454       if (inst->DstReg.File == file) {
 455          assert(inst->DstReg.Index < usedSize);
 456          if(inst->DstReg.Index < usedSize)
 457             used[inst->DstReg.Index] = GL_TRUE;
 458       }
 459
 460       for (j = 0; j < n; j++) {
 461          if (inst->SrcReg[j].File == file) {
 462             assert(inst->SrcReg[j].Index < (GLint) usedSize);
 463             if (inst->SrcReg[j].Index < (GLint) usedSize)
 464                used[inst->SrcReg[j].Index] = GL_TRUE;
 465          }
 466       }
 467    }
 468 }
 469
 470
 471 /**
 472  * Scan the given 'used' register flag array for the first entry
 473  * that's >= firstReg.
 474  * \param used  vector of flags indicating registers in use (as returned
 475  *              by _mesa_find_used_registers())
 476  * \param usedSize  size of the 'used' array
 477  * \param firstReg  first register to start searching at
 478  * \return index of unused register, or -1 if none.
 479  */
 480 GLint
 481 _mesa_find_free_register(const GLboolean used[],
 482                          GLuint usedSize, GLuint firstReg)
 483 {
 484    GLuint i;
 485
 486    assert(firstReg < usedSize);
 487
 488    for (i = firstReg; i < usedSize; i++)
 489       if (!used[i])
 490          return i;
 491
 492    return -1;
 493 }
 494
 495
 496 /* Gets the minimum number of shader invocations per fragment.
 497  * This function is useful to determine if we need to do per
 498  * sample shading or per fragment shading.
 499  */
 500 GLint
 501 _mesa_get_min_invocations_per_fragment(struct gl_context *ctx,
 502                                        const struct gl_program *prog,
 503                                        bool ignore_sample_qualifier)
 504 {
 505    /* From ARB_sample_shading specification:
 506     * "Using gl_SampleID in a fragment shader causes the entire shader
 507     *  to be evaluated per-sample."
 508     *
 509     * "Using gl_SamplePosition in a fragment shader causes the entire
 510     *  shader to be evaluated per-sample."
 511     *
 512     * "If MULTISAMPLE or SAMPLE_SHADING_ARB is disabled, sample shading
 513     *  has no effect."
 514     */
 515    if (ctx->Multisample.Enabled) {
 516       /* The ARB_gpu_shader5 specification says:
 517        *
 518        * "Use of the "sample" qualifier on a fragment shader input
 519        *  forces per-sample shading"
 520        */
 521       if (prog->info.fs.uses_sample_qualifier && !ignore_sample_qualifier)
 522          return MAX2(_mesa_geometric_samples(ctx->DrawBuffer), 1);
 523
 524       if (prog->info.system_values_read & (SYSTEM_BIT_SAMPLE_ID |
 525                                            SYSTEM_BIT_SAMPLE_POS))
 526          return MAX2(_mesa_geometric_samples(ctx->DrawBuffer), 1);
 527       else if (ctx->Multisample.SampleShading)
 528          return MAX2(ceil(ctx->Multisample.MinSampleShadingValue *
 529                           _mesa_geometric_samples(ctx->DrawBuffer)), 1);
 530       else
 531          return 1;
 532    }
 533    return 1;
 534 }