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