src/mesa/shader/prog_parameter.c

   1 /*
   2  * Mesa 3-D graphics library
   3  * Version:  6.5.3
   4  *
   5  * Copyright (C) 1999-2007  Brian Paul   All Rights Reserved.
   6  *
   7  * Permission is hereby granted, free of charge, to any person obtaining a
   8  * copy of this software and associated documentation files (the "Software"),
   9  * to deal in the Software without restriction, including without limitation
  10  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  11  * and/or sell copies of the Software, and to permit persons to whom the
  12  * Software is furnished to do so, subject to the following conditions:
  13  *
  14  * The above copyright notice and this permission notice shall be included
  15  * in all copies or substantial portions of the Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  18  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  20  * BRIAN PAUL BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
  21  * AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  22  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  23  */
  24
  25 /**
  26  * \file prog_parameter.c
  27  * Program parameter lists and functions.
  28  * \author Brian Paul
  29  */
  30
  31
  32 #include "glheader.h"
  33 #include "imports.h"
  34 #include "macros.h"
  35 #include "prog_instruction.h"
  36 #include "prog_parameter.h"
  37 #include "prog_statevars.h"
  38
  39
  40 struct gl_program_parameter_list *
  41 _mesa_new_parameter_list(void)
  42 {
  43    return (struct gl_program_parameter_list *)
  44       _mesa_calloc(sizeof(struct gl_program_parameter_list));
  45 }
  46
  47
  48 /**
  49  * Free a parameter list and all its parameters
  50  */
  51 void
  52 _mesa_free_parameter_list(struct gl_program_parameter_list *paramList)
  53 {
  54    GLuint i;
  55    for (i = 0; i < paramList->NumParameters; i++) {
  56       if (paramList->Parameters[i].Name)
  57          _mesa_free((void *) paramList->Parameters[i].Name);
  58    }
  59    _mesa_free(paramList->Parameters);
  60    if (paramList->ParameterValues)
  61       _mesa_align_free(paramList->ParameterValues);
  62    _mesa_free(paramList);
  63 }
  64
  65
  66
  67 /**
  68  * Add a new parameter to a parameter list.
  69  * Note that parameter values are usually 4-element GLfloat vectors.
  70  * When size > 4 we'll allocate a sequential block of parameters to
  71  * store all the values (in blocks of 4).
  72  *
  73  * \param paramList  the list to add the parameter to
  74  * \param type  type of parameter, such as
  75  * \param name  the parameter name, will be duplicated/copied!
  76  * \param size  number of elements in 'values' vector (1..4, or more)
  77  * \param values  initial parameter value, up to 4 GLfloats, or NULL
  78  * \param state  state indexes, or NULL
  79  * \return  index of new parameter in the list, or -1 if error (out of mem)
  80  */
  81 GLint
  82 _mesa_add_parameter(struct gl_program_parameter_list *paramList,
  83                     enum register_file type, const char *name,
  84                     GLuint size, GLenum datatype, const GLfloat *values,
  85                     const gl_state_index state[STATE_LENGTH])
  86 {
  87    const GLuint oldNum = paramList->NumParameters;
  88    const GLuint sz4 = (size + 3) / 4; /* no. of new param slots needed */
  89
  90    assert(size > 0);
  91
  92    if (oldNum + sz4 > paramList->Size) {
  93       /* Need to grow the parameter list array (alloc some extra) */
  94       paramList->Size = paramList->Size + 4 * sz4;
  95
  96       /* realloc arrays */
  97       paramList->Parameters = (struct gl_program_parameter *)
  98          _mesa_realloc(paramList->Parameters,
  99                        oldNum * sizeof(struct gl_program_parameter),
 100                        paramList->Size * sizeof(struct gl_program_parameter));
 101
 102       paramList->ParameterValues = (GLfloat (*)[4])
 103          _mesa_align_realloc(paramList->ParameterValues,         /* old buf */
 104                              oldNum * 4 * sizeof(GLfloat),      /* old size */
 105                              paramList->Size * 4 *sizeof(GLfloat), /* new sz */
 106                              16);
 107    }
 108
 109    if (!paramList->Parameters ||
 110        !paramList->ParameterValues) {
 111       /* out of memory */
 112       paramList->NumParameters = 0;
 113       paramList->Size = 0;
 114       return -1;
 115    }
 116    else {
 117       GLuint i;
 118
 119       paramList->NumParameters = oldNum + sz4;
 120
 121       _mesa_memset(&paramList->Parameters[oldNum], 0,
 122                    sz4 * sizeof(struct gl_program_parameter));
 123
 124       for (i = 0; i < sz4; i++) {
 125          struct gl_program_parameter *p = paramList->Parameters + oldNum + i;
 126          p->Name = name ? _mesa_strdup(name) : NULL;
 127          p->Type = type;
 128          p->Size = size;
 129          p->DataType = datatype;
 130          if (values) {
 131             COPY_4V(paramList->ParameterValues[oldNum + i], values);
 132             values += 4;
 133          }
 134          else {
 135             /* silence valgrind */
 136             ASSIGN_4V(paramList->ParameterValues[oldNum + i], 0, 0, 0, 0);
 137          }
 138          size -= 4;
 139       }
 140
 141       if (state) {
 142          for (i = 0; i < STATE_LENGTH; i++)
 143             paramList->Parameters[oldNum].StateIndexes[i] = state[i];
 144       }
 145
 146       return (GLint) oldNum;
 147    }
 148 }
 149
 150
 151 /**
 152  * Add a new named program parameter (Ex: NV_fragment_program DEFINE statement)
 153  * \return index of the new entry in the parameter list
 154  */
 155 GLint
 156 _mesa_add_named_parameter(struct gl_program_parameter_list *paramList,
 157                           const char *name, const GLfloat values[4])
 158 {
 159    return _mesa_add_parameter(paramList, PROGRAM_NAMED_PARAM, name,
 160                               4, GL_NONE, values, NULL);
 161
 162 }
 163
 164
 165 /**
 166  * Add a new named constant to the parameter list.
 167  * This will be used when the program contains something like this:
 168  *    PARAM myVals = { 0, 1, 2, 3 };
 169  *
 170  * \param paramList  the parameter list
 171  * \param name  the name for the constant
 172  * \param values  four float values
 173  * \return index/position of the new parameter in the parameter list
 174  */
 175 GLint
 176 _mesa_add_named_constant(struct gl_program_parameter_list *paramList,
 177                          const char *name, const GLfloat values[4],
 178                          GLuint size)
 179 {
 180 #if 0 /* disable this for now -- we need to save the name! */
 181    GLint pos;
 182    GLuint swizzle;
 183    ASSERT(size == 4); /* XXX future feature */
 184    /* check if we already have this constant */
 185    if (_mesa_lookup_parameter_constant(paramList, values, 4, &pos, &swizzle)) {
 186       return pos;
 187    }
 188 #endif
 189    size = 4; /** XXX fix */
 190    return _mesa_add_parameter(paramList, PROGRAM_CONSTANT, name,
 191                               size, GL_NONE, values, NULL);
 192 }
 193
 194
 195 /**
 196  * Add a new unnamed constant to the parameter list.  This will be used
 197  * when a fragment/vertex program contains something like this:
 198  *    MOV r, { 0, 1, 2, 3 };
 199  * We'll search the parameter list for an existing instance of the
 200  * constant.  If swizzleOut is non-null, we'll try swizzling when
 201  * looking for a match.
 202  *
 203  * \param paramList  the parameter list
 204  * \param values  four float values
 205  * \param swizzleOut  returns swizzle mask for accessing the constant
 206  * \return index/position of the new parameter in the parameter list.
 207  */
 208 GLint
 209 _mesa_add_unnamed_constant(struct gl_program_parameter_list *paramList,
 210                            const GLfloat values[4], GLuint size,
 211                            GLuint *swizzleOut)
 212 {
 213    GLint pos;
 214    ASSERT(size >= 1);
 215    ASSERT(size <= 4);
 216
 217    if (_mesa_lookup_parameter_constant(paramList, values,
 218                                        size, &pos, swizzleOut)) {
 219       return pos;
 220    }
 221
 222    /* Look for empty space in an already unnamed constant parameter
 223     * to add this constant.  This will only work for single-element
 224     * constants because we rely on smearing (i.e. .yyyy or .zzzz).
 225     */
 226    if (size == 1 && swizzleOut) {
 227       for (pos = 0; pos < (GLint) paramList->NumParameters; pos++) {
 228          struct gl_program_parameter *p = paramList->Parameters + pos;
 229          if (p->Type == PROGRAM_CONSTANT && p->Size + size <= 4) {
 230             /* ok, found room */
 231             GLfloat *pVal = paramList->ParameterValues[pos];
 232             GLuint swz = p->Size; /* 1, 2 or 3 for Y, Z, W */
 233             pVal[p->Size] = values[0];
 234             p->Size++;
 235             *swizzleOut = MAKE_SWIZZLE4(swz, swz, swz, swz);
 236             return pos;
 237          }
 238       }
 239    }
 240
 241    /* add a new parameter to store this constant */
 242    pos = _mesa_add_parameter(paramList, PROGRAM_CONSTANT, NULL,
 243                              size, GL_NONE, values, NULL);
 244    if (pos >= 0 && swizzleOut) {
 245       if (size == 1)
 246          *swizzleOut = SWIZZLE_XXXX;
 247       else
 248          *swizzleOut = SWIZZLE_NOOP;
 249    }
 250    return pos;
 251 }
 252
 253
 254 /**
 255  * Add a uniform to the parameter list.
 256  * Note that if the uniform is an array, size may be greater than
 257  * what's implied by the datatype.
 258  * \param name  uniform's name
 259  * \param size  number of floats to allocate
 260  * \param datatype  GL_FLOAT_VEC3, GL_FLOAT_MAT4, etc.
 261  */
 262 GLint
 263 _mesa_add_uniform(struct gl_program_parameter_list *paramList,
 264                   const char *name, GLuint size, GLenum datatype)
 265 {
 266    GLint i = _mesa_lookup_parameter_index(paramList, -1, name);
 267    ASSERT(datatype != GL_NONE);
 268    if (i >= 0 && paramList->Parameters[i].Type == PROGRAM_UNIFORM) {
 269       ASSERT(paramList->Parameters[i].Size == size);
 270       ASSERT(paramList->Parameters[i].DataType == datatype);
 271       /* already in list */
 272       return i;
 273    }
 274    else {
 275       i = _mesa_add_parameter(paramList, PROGRAM_UNIFORM, name,
 276                               size, datatype, NULL, NULL);
 277       return i;
 278    }
 279 }
 280
 281
 282 /**
 283  * Add a sampler to the parameter list.
 284  * \param name  uniform's name
 285  * \param datatype  GL_SAMPLER_2D, GL_SAMPLER_2D_RECT_ARB, etc.
 286  * \param index  the sampler number (as seen in TEX instructions)
 287  */
 288 GLint
 289 _mesa_add_sampler(struct gl_program_parameter_list *paramList,
 290                   const char *name, GLenum datatype, GLuint index)
 291 {
 292    GLint i = _mesa_lookup_parameter_index(paramList, -1, name);
 293    if (i >= 0 && paramList->Parameters[i].Type == PROGRAM_SAMPLER) {
 294       ASSERT(paramList->Parameters[i].Size == 1);
 295       ASSERT(paramList->Parameters[i].DataType == datatype);
 296       ASSERT(paramList->ParameterValues[i][0] == index);
 297       /* already in list */
 298       return i;
 299    }
 300    else {
 301       GLfloat indexf = index;
 302       const GLint size = 1; /* a sampler is basically a texture unit number */
 303       i = _mesa_add_parameter(paramList, PROGRAM_SAMPLER, name,
 304                               size, datatype, &indexf, NULL);
 305       return i;
 306    }
 307 }
 308
 309
 310 /**
 311  * Add parameter representing a varying variable.
 312  */
 313 GLint
 314 _mesa_add_varying(struct gl_program_parameter_list *paramList,
 315                   const char *name, GLuint size)
 316 {
 317    GLint i = _mesa_lookup_parameter_index(paramList, -1, name);
 318    if (i >= 0 && paramList->Parameters[i].Type == PROGRAM_VARYING) {
 319       /* already in list */
 320       return i;
 321    }
 322    else {
 323       assert(size == 4);
 324       i = _mesa_add_parameter(paramList, PROGRAM_VARYING, name,
 325                               size, GL_NONE, NULL, NULL);
 326       return i;
 327    }
 328 }
 329
 330
 331 /**
 332  * Add parameter representing a vertex program attribute.
 333  * \param size  size of attribute (in floats), may be -1 if unknown
 334  * \param attrib  the attribute index, or -1 if unknown
 335  */
 336 GLint
 337 _mesa_add_attribute(struct gl_program_parameter_list *paramList,
 338                     const char *name, GLint size, GLint attrib)
 339 {
 340    GLint i = _mesa_lookup_parameter_index(paramList, -1, name);
 341    if (i >= 0) {
 342       /* replace */
 343       if (attrib < 0)
 344          attrib = i;
 345       paramList->Parameters[i].StateIndexes[0] = attrib;
 346    }
 347    else {
 348       /* add */
 349       gl_state_index state[STATE_LENGTH];
 350       state[0] = (gl_state_index) attrib;
 351       if (size < 0)
 352          size = 4;
 353       i = _mesa_add_parameter(paramList, PROGRAM_INPUT, name,
 354                               size, GL_NONE, NULL, state);
 355    }
 356    return i;
 357 }
 358
 359
 360
 361 #if 0 /* not used yet */
 362 /**
 363  * Returns the number of 4-component registers needed to store a piece
 364  * of GL state.  For matrices this may be as many as 4 registers,
 365  * everything else needs
 366  * just 1 register.
 367  */
 368 static GLuint
 369 sizeof_state_reference(const GLint *stateTokens)
 370 {
 371    if (stateTokens[0] == STATE_MATRIX) {
 372       GLuint rows = stateTokens[4] - stateTokens[3] + 1;
 373       assert(rows >= 1);
 374       assert(rows <= 4);
 375       return rows;
 376    }
 377    else {
 378       return 1;
 379    }
 380 }
 381 #endif
 382
 383
 384 /**
 385  * Add a new state reference to the parameter list.
 386  * This will be used when the program contains something like this:
 387  *    PARAM ambient = state.material.front.ambient;
 388  *
 389  * \param paramList  the parameter list
 390  * \param stateTokens  an array of 5 (STATE_LENGTH) state tokens
 391  * \return index of the new parameter.
 392  */
 393 GLint
 394 _mesa_add_state_reference(struct gl_program_parameter_list *paramList,
 395                           const gl_state_index stateTokens[STATE_LENGTH])
 396 {
 397    const GLuint size = 4; /* XXX fix */
 398    const char *name;
 399    GLint index;
 400
 401    /* Check if the state reference is already in the list */
 402    for (index = 0; index < (GLint) paramList->NumParameters; index++) {
 403       GLuint i, match = 0;
 404       for (i = 0; i < STATE_LENGTH; i++) {
 405          if (paramList->Parameters[index].StateIndexes[i] == stateTokens[i]) {
 406             match++;
 407          }
 408          else {
 409             break;
 410          }
 411       }
 412       if (match == STATE_LENGTH) {
 413          /* this state reference is already in the parameter list */
 414          return index;
 415       }
 416    }
 417
 418    name = _mesa_program_state_string(stateTokens);
 419    index = _mesa_add_parameter(paramList, PROGRAM_STATE_VAR, name,
 420                                size, GL_NONE,
 421                                NULL, (gl_state_index *) stateTokens);
 422    paramList->StateFlags |= _mesa_program_state_flags(stateTokens);
 423
 424    /* free name string here since we duplicated it in add_parameter() */
 425    _mesa_free((void *) name);
 426
 427    return index;
 428 }
 429
 430
 431 /**
 432  * Lookup a parameter value by name in the given parameter list.
 433  * \return pointer to the float[4] values.
 434  */
 435 GLfloat *
 436 _mesa_lookup_parameter_value(const struct gl_program_parameter_list *paramList,
 437                              GLsizei nameLen, const char *name)
 438 {
 439    GLuint i = _mesa_lookup_parameter_index(paramList, nameLen, name);
 440    if (i < 0)
 441       return NULL;
 442    else
 443       return paramList->ParameterValues[i];
 444 }
 445
 446
 447 /**
 448  * Given a program parameter name, find its position in the list of parameters.
 449  * \param paramList  the parameter list to search
 450  * \param nameLen  length of name (in chars).
 451  *                 If length is negative, assume that name is null-terminated.
 452  * \param name  the name to search for
 453  * \return index of parameter in the list.
 454  */
 455 GLint
 456 _mesa_lookup_parameter_index(const struct gl_program_parameter_list *paramList,
 457                              GLsizei nameLen, const char *name)
 458 {
 459    GLint i;
 460
 461    if (!paramList)
 462       return -1;
 463
 464    if (nameLen == -1) {
 465       /* name is null-terminated */
 466       for (i = 0; i < (GLint) paramList->NumParameters; i++) {
 467          if (paramList->Parameters[i].Name &&
 468              _mesa_strcmp(paramList->Parameters[i].Name, name) == 0)
 469             return i;
 470       }
 471    }
 472    else {
 473       /* name is not null-terminated, use nameLen */
 474       for (i = 0; i < (GLint) paramList->NumParameters; i++) {
 475          if (paramList->Parameters[i].Name &&
 476              _mesa_strncmp(paramList->Parameters[i].Name, name, nameLen) == 0
 477              && _mesa_strlen(paramList->Parameters[i].Name) == (size_t)nameLen)
 478             return i;
 479       }
 480    }
 481    return -1;
 482 }
 483
 484
 485 /**
 486  * Look for a float vector in the given parameter list.  The float vector
 487  * may be of length 1, 2, 3 or 4.  If swizzleOut is non-null, we'll try
 488  * swizzling to find a match.
 489  * \param list  the parameter list to search
 490  * \param v  the float vector to search for
 491  * \param size  number of element in v
 492  * \param posOut  returns the position of the constant, if found
 493  * \param swizzleOut  returns a swizzle mask describing location of the
 494  *                    vector elements if found.
 495  * \return GL_TRUE if found, GL_FALSE if not found
 496  */
 497 GLboolean
 498 _mesa_lookup_parameter_constant(const struct gl_program_parameter_list *list,
 499                                 const GLfloat v[], GLuint vSize,
 500                                 GLint *posOut, GLuint *swizzleOut)
 501 {
 502    GLuint i;
 503
 504    assert(vSize >= 1);
 505    assert(vSize <= 4);
 506
 507    if (!list)
 508       return -1;
 509
 510    for (i = 0; i < list->NumParameters; i++) {
 511       if (list->Parameters[i].Type == PROGRAM_CONSTANT) {
 512          if (!swizzleOut) {
 513             /* swizzle not allowed */
 514             GLuint j, match = 0;
 515             for (j = 0; j < vSize; j++) {
 516                if (v[j] == list->ParameterValues[i][j])
 517                   match++;
 518             }
 519             if (match == vSize) {
 520                *posOut = i;
 521                return GL_TRUE;
 522             }
 523          }
 524          else {
 525             /* try matching w/ swizzle */
 526              if (vSize == 1) {
 527                 /* look for v[0] anywhere within float[4] value */
 528                 GLuint j;
 529                 for (j = 0; j < 4; j++) {
 530                    if (list->ParameterValues[i][j] == v[0]) {
 531                       /* found it */
 532                       *posOut = i;
 533                       *swizzleOut = MAKE_SWIZZLE4(j, j, j, j);
 534                       return GL_TRUE;
 535                    }
 536                 }
 537              }
 538              else if (vSize <= list->Parameters[i].Size) {
 539                 /* see if we can match this constant (with a swizzle) */
 540                 GLuint swz[4];
 541                 GLuint match = 0, j, k;
 542                 for (j = 0; j < vSize; j++) {
 543                    if (v[j] == list->ParameterValues[i][j]) {
 544                       swz[j] = j;
 545                       match++;
 546                    }
 547                    else {
 548                       for (k = 0; k < list->Parameters[i].Size; k++) {
 549                          if (v[j] == list->ParameterValues[i][k]) {
 550                             swz[j] = k;
 551                             match++;
 552                             break;
 553                          }
 554                       }
 555                    }
 556                 }
 557                 /* smear last value to remaining positions */
 558                 for (; j < 4; j++)
 559                    swz[j] = swz[j-1];
 560
 561                 if (match == vSize) {
 562                    *posOut = i;
 563                    *swizzleOut = MAKE_SWIZZLE4(swz[0], swz[1], swz[2], swz[3]);
 564                    return GL_TRUE;
 565                 }
 566              }
 567          }
 568       }
 569    }
 570
 571    *posOut = -1;
 572    return GL_FALSE;
 573 }
 574
 575
 576 struct gl_program_parameter_list *
 577 _mesa_clone_parameter_list(const struct gl_program_parameter_list *list)
 578 {
 579    struct gl_program_parameter_list *clone;
 580    GLuint i;
 581
 582    clone = _mesa_new_parameter_list();
 583    if (!clone)
 584       return NULL;
 585
 586    /** Not too efficient, but correct */
 587    for (i = 0; i < list->NumParameters; i++) {
 588       struct gl_program_parameter *p = list->Parameters + i;
 589       GLuint size = MIN2(p->Size, 4);
 590       GLint j = _mesa_add_parameter(clone, p->Type, p->Name, size, p->DataType,
 591                                     list->ParameterValues[i], NULL);
 592       ASSERT(j >= 0);
 593       /* copy state indexes */
 594       if (p->Type == PROGRAM_STATE_VAR) {
 595          GLint k;
 596          struct gl_program_parameter *q = clone->Parameters + j;
 597          for (k = 0; k < STATE_LENGTH; k++) {
 598             q->StateIndexes[k] = p->StateIndexes[k];
 599          }
 600       }
 601       else {
 602          clone->Parameters[j].Size = p->Size;
 603       }
 604    }
 605
 606    return clone;
 607 }
 608
 609
 610 /**
 611  * Return a new parameter list which is listA + listB.
 612  */
 613 struct gl_program_parameter_list *
 614 _mesa_combine_parameter_lists(const struct gl_program_parameter_list *listA,
 615                               const struct gl_program_parameter_list *listB)
 616 {
 617    struct gl_program_parameter_list *list;
 618
 619    if (listA) {
 620       list = _mesa_clone_parameter_list(listA);
 621       if (list && listB) {
 622          GLuint i;
 623          for (i = 0; i < listB->NumParameters; i++) {
 624             struct gl_program_parameter *param = listB->Parameters + i;
 625             _mesa_add_parameter(list, param->Type, param->Name, param->Size,
 626                                 param->DataType,
 627                                 listB->ParameterValues[i],
 628                                 param->StateIndexes);
 629          }
 630       }
 631    }
 632    else if (listB) {
 633       list = _mesa_clone_parameter_list(listB);
 634    }
 635    else {
 636       list = NULL;
 637    }
 638    return list;
 639 }
 640
 641
 642
 643 /**
 644  * Find longest name of all uniform parameters in list.
 645  */
 646 GLuint
 647 _mesa_longest_parameter_name(const struct gl_program_parameter_list *list,
 648                              enum register_file type)
 649 {
 650    GLuint i, maxLen = 0;
 651    if (!list)
 652       return 0;
 653    for (i = 0; i < list->NumParameters; i++) {
 654       if (list->Parameters[i].Type == type) {
 655          GLuint len = _mesa_strlen(list->Parameters[i].Name);
 656          if (len > maxLen)
 657             maxLen = len;
 658       }
 659    }
 660    return maxLen;
 661 }
 662
 663
 664 /**
 665  * Count the number of parameters in the last that match the given type.
 666  */
 667 GLuint
 668 _mesa_num_parameters_of_type(const struct gl_program_parameter_list *list,
 669                              enum register_file type)
 670 {
 671    GLuint i, count = 0;
 672    if (list) {
 673       for (i = 0; i < list->NumParameters; i++) {
 674          if (list->Parameters[i].Type == type)
 675             count++;
 676       }
 677    }
 678    return count;
 679 }