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_fragprog(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_fragprog(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_fragprog(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_FRAGMENT_PROGRAM_ARB: {
 219       struct gl_fragment_program *prog = CALLOC_STRUCT(gl_fragment_program);
 220       return _mesa_init_gl_program(&prog->Base, target, id);
 221    }
 222    case GL_VERTEX_PROGRAM_ARB: /* == GL_VERTEX_PROGRAM_NV */
 223    case GL_GEOMETRY_PROGRAM_NV:
 224    case GL_TESS_CONTROL_PROGRAM_NV:
 225    case GL_TESS_EVALUATION_PROGRAM_NV: {
 226       struct gl_program *prog = CALLOC_STRUCT(gl_program);
 227       return _mesa_init_gl_program(prog, target, id);
 228    }
 229    case GL_COMPUTE_PROGRAM_NV: {
 230       struct gl_compute_program *prog = CALLOC_STRUCT(gl_compute_program);
 231       return _mesa_init_gl_program(&prog->Base, target, id);
 232    }
 233    default:
 234       _mesa_problem(ctx, "bad target in _mesa_new_program");
 235       return NULL;
 236    }
 237 }
 238
 239
 240 /**
 241  * Delete a program and remove it from the hash table, ignoring the
 242  * reference count.
 243  * Called via ctx->Driver.DeleteProgram.  May be wrapped (OO deriviation)
 244  * by a device driver function.
 245  */
 246 void
 247 _mesa_delete_program(struct gl_context *ctx, struct gl_program *prog)
 248 {
 249    (void) ctx;
 250    assert(prog);
 251    assert(prog->RefCount==0);
 252
 253    if (prog == &_mesa_DummyProgram)
 254       return;
 255
 256    free(prog->String);
 257    free(prog->LocalParams);
 258
 259    if (prog->Instructions) {
 260       _mesa_free_instructions(prog->Instructions, prog->NumInstructions);
 261    }
 262    if (prog->Parameters) {
 263       _mesa_free_parameter_list(prog->Parameters);
 264    }
 265
 266    if (prog->nir) {
 267       ralloc_free(prog->nir);
 268    }
 269
 270    mtx_destroy(&prog->Mutex);
 271    free(prog);
 272 }
 273
 274
 275 /**
 276  * Return the gl_program object for a given ID.
 277  * Basically just a wrapper for _mesa_HashLookup() to avoid a lot of
 278  * casts elsewhere.
 279  */
 280 struct gl_program *
 281 _mesa_lookup_program(struct gl_context *ctx, GLuint id)
 282 {
 283    if (id)
 284       return (struct gl_program *) _mesa_HashLookup(ctx->Shared->Programs, id);
 285    else
 286       return NULL;
 287 }
 288
 289
 290 /**
 291  * Reference counting for vertex/fragment programs
 292  * This is normally only called from the _mesa_reference_program() macro
 293  * when there's a real pointer change.
 294  */
 295 void
 296 _mesa_reference_program_(struct gl_context *ctx,
 297                          struct gl_program **ptr,
 298                          struct gl_program *prog)
 299 {
 300 #ifndef NDEBUG
 301    assert(ptr);
 302    if (*ptr && prog) {
 303       /* sanity check */
 304       if ((*ptr)->Target == GL_VERTEX_PROGRAM_ARB)
 305          assert(prog->Target == GL_VERTEX_PROGRAM_ARB);
 306       else if ((*ptr)->Target == GL_FRAGMENT_PROGRAM_ARB)
 307          assert(prog->Target == GL_FRAGMENT_PROGRAM_ARB ||
 308                 prog->Target == GL_FRAGMENT_PROGRAM_NV);
 309       else if ((*ptr)->Target == GL_GEOMETRY_PROGRAM_NV)
 310          assert(prog->Target == GL_GEOMETRY_PROGRAM_NV);
 311    }
 312 #endif
 313
 314    if (*ptr) {
 315       GLboolean deleteFlag;
 316       struct gl_program *oldProg = *ptr;
 317
 318       mtx_lock(&oldProg->Mutex);
 319       assert(oldProg->RefCount > 0);
 320       oldProg->RefCount--;
 321
 322       deleteFlag = (oldProg->RefCount == 0);
 323       mtx_unlock(&oldProg->Mutex);
 324
 325       if (deleteFlag) {
 326          assert(ctx);
 327          ctx->Driver.DeleteProgram(ctx, oldProg);
 328       }
 329
 330       *ptr = NULL;
 331    }
 332
 333    assert(!*ptr);
 334    if (prog) {
 335       mtx_lock(&prog->Mutex);
 336       prog->RefCount++;
 337       mtx_unlock(&prog->Mutex);
 338    }
 339
 340    *ptr = prog;
 341 }
 342
 343
 344 /**
 345  * Insert 'count' NOP instructions at 'start' in the given program.
 346  * Adjust branch targets accordingly.
 347  */
 348 GLboolean
 349 _mesa_insert_instructions(struct gl_program *prog, GLuint start, GLuint count)
 350 {
 351    const GLuint origLen = prog->NumInstructions;
 352    const GLuint newLen = origLen + count;
 353    struct prog_instruction *newInst;
 354    GLuint i;
 355
 356    /* adjust branches */
 357    for (i = 0; i < prog->NumInstructions; i++) {
 358       struct prog_instruction *inst = prog->Instructions + i;
 359       if (inst->BranchTarget > 0) {
 360          if ((GLuint)inst->BranchTarget >= start) {
 361             inst->BranchTarget += count;
 362          }
 363       }
 364    }
 365
 366    /* Alloc storage for new instructions */
 367    newInst = _mesa_alloc_instructions(newLen);
 368    if (!newInst) {
 369       return GL_FALSE;
 370    }
 371
 372    /* Copy 'start' instructions into new instruction buffer */
 373    _mesa_copy_instructions(newInst, prog->Instructions, start);
 374
 375    /* init the new instructions */
 376    _mesa_init_instructions(newInst + start, count);
 377
 378    /* Copy the remaining/tail instructions to new inst buffer */
 379    _mesa_copy_instructions(newInst + start + count,
 380                            prog->Instructions + start,
 381                            origLen - start);
 382
 383    /* free old instructions */
 384    _mesa_free_instructions(prog->Instructions, origLen);
 385
 386    /* install new instructions */
 387    prog->Instructions = newInst;
 388    prog->NumInstructions = newLen;
 389
 390    return GL_TRUE;
 391 }
 392
 393 /**
 394  * Delete 'count' instructions at 'start' in the given program.
 395  * Adjust branch targets accordingly.
 396  */
 397 GLboolean
 398 _mesa_delete_instructions(struct gl_program *prog, GLuint start, GLuint count)
 399 {
 400    const GLuint origLen = prog->NumInstructions;
 401    const GLuint newLen = origLen - count;
 402    struct prog_instruction *newInst;
 403    GLuint i;
 404
 405    /* adjust branches */
 406    for (i = 0; i < prog->NumInstructions; i++) {
 407       struct prog_instruction *inst = prog->Instructions + i;
 408       if (inst->BranchTarget > 0) {
 409          if (inst->BranchTarget > (GLint) start) {
 410             inst->BranchTarget -= count;
 411          }
 412       }
 413    }
 414
 415    /* Alloc storage for new instructions */
 416    newInst = _mesa_alloc_instructions(newLen);
 417    if (!newInst) {
 418       return GL_FALSE;
 419    }
 420
 421    /* Copy 'start' instructions into new instruction buffer */
 422    _mesa_copy_instructions(newInst, prog->Instructions, start);
 423
 424    /* Copy the remaining/tail instructions to new inst buffer */
 425    _mesa_copy_instructions(newInst + start,
 426                            prog->Instructions + start + count,
 427                            newLen - start);
 428
 429    /* free old instructions */
 430    _mesa_free_instructions(prog->Instructions, origLen);
 431
 432    /* install new instructions */
 433    prog->Instructions = newInst;
 434    prog->NumInstructions = newLen;
 435
 436    return GL_TRUE;
 437 }
 438
 439
 440 /**
 441  * Populate the 'used' array with flags indicating which registers (TEMPs,
 442  * INPUTs, OUTPUTs, etc, are used by the given program.
 443  * \param file  type of register to scan for
 444  * \param used  returns true/false flags for in use / free
 445  * \param usedSize  size of the 'used' array
 446  */
 447 void
 448 _mesa_find_used_registers(const struct gl_program *prog,
 449                           gl_register_file file,
 450                           GLboolean used[], GLuint usedSize)
 451 {
 452    GLuint i, j;
 453
 454    memset(used, 0, usedSize);
 455
 456    for (i = 0; i < prog->NumInstructions; i++) {
 457       const struct prog_instruction *inst = prog->Instructions + i;
 458       const GLuint n = _mesa_num_inst_src_regs(inst->Opcode);
 459
 460       if (inst->DstReg.File == file) {
 461          assert(inst->DstReg.Index < usedSize);
 462          if(inst->DstReg.Index < usedSize)
 463             used[inst->DstReg.Index] = GL_TRUE;
 464       }
 465
 466       for (j = 0; j < n; j++) {
 467          if (inst->SrcReg[j].File == file) {
 468             assert(inst->SrcReg[j].Index < (GLint) usedSize);
 469             if (inst->SrcReg[j].Index < (GLint) usedSize)
 470                used[inst->SrcReg[j].Index] = GL_TRUE;
 471          }
 472       }
 473    }
 474 }
 475
 476
 477 /**
 478  * Scan the given 'used' register flag array for the first entry
 479  * that's >= firstReg.
 480  * \param used  vector of flags indicating registers in use (as returned
 481  *              by _mesa_find_used_registers())
 482  * \param usedSize  size of the 'used' array
 483  * \param firstReg  first register to start searching at
 484  * \return index of unused register, or -1 if none.
 485  */
 486 GLint
 487 _mesa_find_free_register(const GLboolean used[],
 488                          GLuint usedSize, GLuint firstReg)
 489 {
 490    GLuint i;
 491
 492    assert(firstReg < usedSize);
 493
 494    for (i = firstReg; i < usedSize; i++)
 495       if (!used[i])
 496          return i;
 497
 498    return -1;
 499 }
 500
 501
 502 /* Gets the minimum number of shader invocations per fragment.
 503  * This function is useful to determine if we need to do per
 504  * sample shading or per fragment shading.
 505  */
 506 GLint
 507 _mesa_get_min_invocations_per_fragment(struct gl_context *ctx,
 508                                        const struct gl_fragment_program *prog,
 509                                        bool ignore_sample_qualifier)
 510 {
 511    /* From ARB_sample_shading specification:
 512     * "Using gl_SampleID in a fragment shader causes the entire shader
 513     *  to be evaluated per-sample."
 514     *
 515     * "Using gl_SamplePosition in a fragment shader causes the entire
 516     *  shader to be evaluated per-sample."
 517     *
 518     * "If MULTISAMPLE or SAMPLE_SHADING_ARB is disabled, sample shading
 519     *  has no effect."
 520     */
 521    if (ctx->Multisample.Enabled) {
 522       /* The ARB_gpu_shader5 specification says:
 523        *
 524        * "Use of the "sample" qualifier on a fragment shader input
 525        *  forces per-sample shading"
 526        */
 527       if (prog->IsSample && !ignore_sample_qualifier)
 528          return MAX2(_mesa_geometric_samples(ctx->DrawBuffer), 1);
 529
 530       if (prog->Base.SystemValuesRead & (SYSTEM_BIT_SAMPLE_ID |
 531                                          SYSTEM_BIT_SAMPLE_POS))
 532          return MAX2(_mesa_geometric_samples(ctx->DrawBuffer), 1);
 533       else if (ctx->Multisample.SampleShading)
 534          return MAX2(ceil(ctx->Multisample.MinSampleShadingValue *
 535                           _mesa_geometric_samples(ctx->DrawBuffer)), 1);
 536       else
 537          return 1;
 538    }
 539    return 1;
 540 }