src/mesa/program/prog_parameter.c

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