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 constant to the parameter list.
 184  * This will be used when the program contains something like this:
 185  *    PARAM myVals = { 0, 1, 2, 3 };
 186  *
 187  * \param paramList  the parameter list
 188  * \param name  the name for the constant
 189  * \param values  four float values
 190  * \return index/position of the new parameter in the parameter list
 191  */
 192 GLint
 193 _mesa_add_named_constant(struct gl_program_parameter_list *paramList,
 194                          const char *name, const gl_constant_value values[4],
 195                          GLuint size)
 196 {
 197    /* first check if this is a duplicate constant */
 198    GLint pos;
 199    for (pos = 0; pos < (GLint)paramList->NumParameters; pos++) {
 200       const gl_constant_value *pvals = paramList->ParameterValues[pos];
 201       if (pvals[0].u == values[0].u &&
 202           pvals[1].u == values[1].u &&
 203           pvals[2].u == values[2].u &&
 204           pvals[3].u == values[3].u &&
 205           strcmp(paramList->Parameters[pos].Name, name) == 0) {
 206          /* Same name and value is already in the param list - reuse it */
 207          return pos;
 208       }
 209    }
 210    /* not found, add new parameter */
 211    return _mesa_add_parameter(paramList, PROGRAM_CONSTANT, name,
 212                               size, GL_NONE, values, NULL, 0x0);
 213 }
 214
 215
 216 /**
 217  * Add a new unnamed constant to the parameter list.  This will be used
 218  * when a fragment/vertex program contains something like this:
 219  *    MOV r, { 0, 1, 2, 3 };
 220  * If swizzleOut is non-null we'll search the parameter list for an
 221  * existing instance of the constant which matches with a swizzle.
 222  *
 223  * \param paramList  the parameter list
 224  * \param values  four float values
 225  * \param swizzleOut  returns swizzle mask for accessing the constant
 226  * \return index/position of the new parameter in the parameter list.
 227  */
 228 GLint
 229 _mesa_add_typed_unnamed_constant(struct gl_program_parameter_list *paramList,
 230                            const gl_constant_value values[4], GLuint size,
 231                            GLenum datatype, GLuint *swizzleOut)
 232 {
 233    GLint pos;
 234    ASSERT(size >= 1);
 235    ASSERT(size <= 4);
 236
 237    if (swizzleOut &&
 238        _mesa_lookup_parameter_constant(paramList, values,
 239                                        size, &pos, swizzleOut)) {
 240       return pos;
 241    }
 242
 243    /* Look for empty space in an already unnamed constant parameter
 244     * to add this constant.  This will only work for single-element
 245     * constants because we rely on smearing (i.e. .yyyy or .zzzz).
 246     */
 247    if (size == 1 && swizzleOut) {
 248       for (pos = 0; pos < (GLint) paramList->NumParameters; pos++) {
 249          struct gl_program_parameter *p = paramList->Parameters + pos;
 250          if (p->Type == PROGRAM_CONSTANT && p->Size + size <= 4) {
 251             /* ok, found room */
 252             gl_constant_value *pVal = paramList->ParameterValues[pos];
 253             GLuint swz = p->Size; /* 1, 2 or 3 for Y, Z, W */
 254             pVal[p->Size] = values[0];
 255             p->Size++;
 256             *swizzleOut = MAKE_SWIZZLE4(swz, swz, swz, swz);
 257             return pos;
 258          }
 259       }
 260    }
 261
 262    /* add a new parameter to store this constant */
 263    pos = _mesa_add_parameter(paramList, PROGRAM_CONSTANT, NULL,
 264                              size, datatype, values, NULL, 0x0);
 265    if (pos >= 0 && swizzleOut) {
 266       if (size == 1)
 267          *swizzleOut = SWIZZLE_XXXX;
 268       else
 269          *swizzleOut = SWIZZLE_NOOP;
 270    }
 271    return pos;
 272 }
 273
 274 /**
 275  * Add a new unnamed constant to the parameter list.  This will be used
 276  * when a fragment/vertex program contains something like this:
 277  *    MOV r, { 0, 1, 2, 3 };
 278  * If swizzleOut is non-null we'll search the parameter list for an
 279  * existing instance of the constant which matches with a swizzle.
 280  *
 281  * \param paramList  the parameter list
 282  * \param values  four float values
 283  * \param swizzleOut  returns swizzle mask for accessing the constant
 284  * \return index/position of the new parameter in the parameter list.
 285  * \sa _mesa_add_typed_unnamed_constant
 286  */
 287 GLint
 288 _mesa_add_unnamed_constant(struct gl_program_parameter_list *paramList,
 289                            const gl_constant_value values[4], GLuint size,
 290                            GLuint *swizzleOut)
 291 {
 292    return _mesa_add_typed_unnamed_constant(paramList, values, size, GL_NONE,
 293                                            swizzleOut);
 294 }
 295
 296 /**
 297  * Add parameter representing a varying variable.
 298  */
 299 GLint
 300 _mesa_add_varying(struct gl_program_parameter_list *paramList,
 301                   const char *name, GLuint size, GLenum datatype,
 302                   GLbitfield flags)
 303 {
 304    GLint i = _mesa_lookup_parameter_index(paramList, -1, name);
 305    if (i >= 0 && paramList->Parameters[i].Type == PROGRAM_VARYING) {
 306       /* already in list */
 307       return i;
 308    }
 309    else {
 310       /*assert(size == 4);*/
 311       i = _mesa_add_parameter(paramList, PROGRAM_VARYING, name,
 312                               size, datatype, NULL, NULL, flags);
 313       return i;
 314    }
 315 }
 316
 317
 318 /**
 319  * Add parameter representing a vertex program attribute.
 320  * \param size  size of attribute (in floats), may be -1 if unknown
 321  * \param attrib  the attribute index, or -1 if unknown
 322  */
 323 GLint
 324 _mesa_add_attribute(struct gl_program_parameter_list *paramList,
 325                     const char *name, GLint size, GLenum datatype, GLint attrib)
 326 {
 327    GLint i = _mesa_lookup_parameter_index(paramList, -1, name);
 328    if (i >= 0) {
 329       /* replace */
 330       if (attrib < 0)
 331          attrib = i;
 332       paramList->Parameters[i].StateIndexes[0] = attrib;
 333    }
 334    else {
 335       /* add */
 336       gl_state_index state[STATE_LENGTH];
 337       state[0] = (gl_state_index) attrib;
 338       if (size < 0)
 339          size = 4;
 340       i = _mesa_add_parameter(paramList, PROGRAM_INPUT, name,
 341                               size, datatype, NULL, state, 0x0);
 342    }
 343    return i;
 344 }
 345
 346
 347
 348 #if 0 /* not used yet */
 349 /**
 350  * Returns the number of 4-component registers needed to store a piece
 351  * of GL state.  For matrices this may be as many as 4 registers,
 352  * everything else needs
 353  * just 1 register.
 354  */
 355 static GLuint
 356 sizeof_state_reference(const GLint *stateTokens)
 357 {
 358    if (stateTokens[0] == STATE_MATRIX) {
 359       GLuint rows = stateTokens[4] - stateTokens[3] + 1;
 360       assert(rows >= 1);
 361       assert(rows <= 4);
 362       return rows;
 363    }
 364    else {
 365       return 1;
 366    }
 367 }
 368 #endif
 369
 370
 371 /**
 372  * Add a new state reference to the parameter list.
 373  * This will be used when the program contains something like this:
 374  *    PARAM ambient = state.material.front.ambient;
 375  *
 376  * \param paramList  the parameter list
 377  * \param stateTokens  an array of 5 (STATE_LENGTH) state tokens
 378  * \return index of the new parameter.
 379  */
 380 GLint
 381 _mesa_add_state_reference(struct gl_program_parameter_list *paramList,
 382                           const gl_state_index stateTokens[STATE_LENGTH])
 383 {
 384    const GLuint size = 4; /* XXX fix */
 385    char *name;
 386    GLint index;
 387
 388    /* Check if the state reference is already in the list */
 389    for (index = 0; index < (GLint) paramList->NumParameters; index++) {
 390       if (!memcmp(paramList->Parameters[index].StateIndexes,
 391                   stateTokens, STATE_LENGTH * sizeof(gl_state_index))) {
 392          return index;
 393       }
 394    }
 395
 396    name = _mesa_program_state_string(stateTokens);
 397    index = _mesa_add_parameter(paramList, PROGRAM_STATE_VAR, name,
 398                                size, GL_NONE,
 399                                NULL, (gl_state_index *) stateTokens, 0x0);
 400    paramList->StateFlags |= _mesa_program_state_flags(stateTokens);
 401
 402    /* free name string here since we duplicated it in add_parameter() */
 403    free(name);
 404
 405    return index;
 406 }
 407
 408
 409 /**
 410  * Lookup a parameter value by name in the given parameter list.
 411  * \return pointer to the float[4] values.
 412  */
 413 gl_constant_value *
 414 _mesa_lookup_parameter_value(const struct gl_program_parameter_list *paramList,
 415                              GLsizei nameLen, const char *name)
 416 {
 417    GLint i = _mesa_lookup_parameter_index(paramList, nameLen, name);
 418    if (i < 0)
 419       return NULL;
 420    else
 421       return paramList->ParameterValues[i];
 422 }
 423
 424
 425 /**
 426  * Given a program parameter name, find its position in the list of parameters.
 427  * \param paramList  the parameter list to search
 428  * \param nameLen  length of name (in chars).
 429  *                 If length is negative, assume that name is null-terminated.
 430  * \param name  the name to search for
 431  * \return index of parameter in the list.
 432  */
 433 GLint
 434 _mesa_lookup_parameter_index(const struct gl_program_parameter_list *paramList,
 435                              GLsizei nameLen, const char *name)
 436 {
 437    GLint i;
 438
 439    if (!paramList)
 440       return -1;
 441
 442    if (nameLen == -1) {
 443       /* name is null-terminated */
 444       for (i = 0; i < (GLint) paramList->NumParameters; i++) {
 445          if (paramList->Parameters[i].Name &&
 446              strcmp(paramList->Parameters[i].Name, name) == 0)
 447             return i;
 448       }
 449    }
 450    else {
 451       /* name is not null-terminated, use nameLen */
 452       for (i = 0; i < (GLint) paramList->NumParameters; i++) {
 453          if (paramList->Parameters[i].Name &&
 454              strncmp(paramList->Parameters[i].Name, name, nameLen) == 0
 455              && strlen(paramList->Parameters[i].Name) == (size_t)nameLen)
 456             return i;
 457       }
 458    }
 459    return -1;
 460 }
 461
 462
 463 /**
 464  * Look for a float vector in the given parameter list.  The float vector
 465  * may be of length 1, 2, 3 or 4.  If swizzleOut is non-null, we'll try
 466  * swizzling to find a match.
 467  * \param list  the parameter list to search
 468  * \param v  the float vector to search for
 469  * \param vSize  number of element in v
 470  * \param posOut  returns the position of the constant, if found
 471  * \param swizzleOut  returns a swizzle mask describing location of the
 472  *                    vector elements if found.
 473  * \return GL_TRUE if found, GL_FALSE if not found
 474  */
 475 GLboolean
 476 _mesa_lookup_parameter_constant(const struct gl_program_parameter_list *list,
 477                                 const gl_constant_value v[], GLuint vSize,
 478                                 GLint *posOut, GLuint *swizzleOut)
 479 {
 480    GLuint i;
 481
 482    assert(vSize >= 1);
 483    assert(vSize <= 4);
 484
 485    if (!list) {
 486       *posOut = -1;
 487       return GL_FALSE;
 488    }
 489
 490    for (i = 0; i < list->NumParameters; i++) {
 491       if (list->Parameters[i].Type == PROGRAM_CONSTANT) {
 492          if (!swizzleOut) {
 493             /* swizzle not allowed */
 494             GLuint j, match = 0;
 495             for (j = 0; j < vSize; j++) {
 496                if (v[j].u == list->ParameterValues[i][j].u)
 497                   match++;
 498             }
 499             if (match == vSize) {
 500                *posOut = i;
 501                return GL_TRUE;
 502             }
 503          }
 504          else {
 505             /* try matching w/ swizzle */
 506              if (vSize == 1) {
 507                 /* look for v[0] anywhere within float[4] value */
 508                 GLuint j;
 509                 for (j = 0; j < list->Parameters[i].Size; j++) {
 510                    if (list->ParameterValues[i][j].u == v[0].u) {
 511                       /* found it */
 512                       *posOut = i;
 513                       *swizzleOut = MAKE_SWIZZLE4(j, j, j, j);
 514                       return GL_TRUE;
 515                    }
 516                 }
 517              }
 518              else if (vSize <= list->Parameters[i].Size) {
 519                 /* see if we can match this constant (with a swizzle) */
 520                 GLuint swz[4];
 521                 GLuint match = 0, j, k;
 522                 for (j = 0; j < vSize; j++) {
 523                    if (v[j].u == list->ParameterValues[i][j].u) {
 524                       swz[j] = j;
 525                       match++;
 526                    }
 527                    else {
 528                       for (k = 0; k < list->Parameters[i].Size; k++) {
 529                          if (v[j].u == list->ParameterValues[i][k].u) {
 530                             swz[j] = k;
 531                             match++;
 532                             break;
 533                          }
 534                       }
 535                    }
 536                 }
 537                 /* smear last value to remaining positions */
 538                 for (; j < 4; j++)
 539                    swz[j] = swz[j-1];
 540
 541                 if (match == vSize) {
 542                    *posOut = i;
 543                    *swizzleOut = MAKE_SWIZZLE4(swz[0], swz[1], swz[2], swz[3]);
 544                    return GL_TRUE;
 545                 }
 546              }
 547          }
 548       }
 549    }
 550
 551    *posOut = -1;
 552    return GL_FALSE;
 553 }
 554
 555
 556 struct gl_program_parameter_list *
 557 _mesa_clone_parameter_list(const struct gl_program_parameter_list *list)
 558 {
 559    struct gl_program_parameter_list *clone;
 560    GLuint i;
 561
 562    clone = _mesa_new_parameter_list();
 563    if (!clone)
 564       return NULL;
 565
 566    /** Not too efficient, but correct */
 567    for (i = 0; i < list->NumParameters; i++) {
 568       struct gl_program_parameter *p = list->Parameters + i;
 569       struct gl_program_parameter *pCopy;
 570       GLuint size = MIN2(p->Size, 4);
 571       GLint j = _mesa_add_parameter(clone, p->Type, p->Name, size, p->DataType,
 572                                     list->ParameterValues[i], NULL, 0x0);
 573       ASSERT(j >= 0);
 574       pCopy = clone->Parameters + j;
 575       pCopy->Flags = p->Flags;
 576       /* copy state indexes */
 577       if (p->Type == PROGRAM_STATE_VAR) {
 578          GLint k;
 579          for (k = 0; k < STATE_LENGTH; k++) {
 580             pCopy->StateIndexes[k] = p->StateIndexes[k];
 581          }
 582       }
 583       else {
 584          clone->Parameters[j].Size = p->Size;
 585       }
 586
 587    }
 588
 589    clone->StateFlags = list->StateFlags;
 590
 591    return clone;
 592 }
 593
 594
 595 /**
 596  * Return a new parameter list which is listA + listB.
 597  */
 598 struct gl_program_parameter_list *
 599 _mesa_combine_parameter_lists(const struct gl_program_parameter_list *listA,
 600                               const struct gl_program_parameter_list *listB)
 601 {
 602    struct gl_program_parameter_list *list;
 603
 604    if (listA) {
 605       list = _mesa_clone_parameter_list(listA);
 606       if (list && listB) {
 607          GLuint i;
 608          for (i = 0; i < listB->NumParameters; i++) {
 609             struct gl_program_parameter *param = listB->Parameters + i;
 610             _mesa_add_parameter(list, param->Type, param->Name, param->Size,
 611                                 param->DataType,
 612                                 listB->ParameterValues[i],
 613                                 param->StateIndexes,
 614                                 param->Flags);
 615          }
 616       }
 617    }
 618    else if (listB) {
 619       list = _mesa_clone_parameter_list(listB);
 620    }
 621    else {
 622       list = NULL;
 623    }
 624    return list;
 625 }
 626
 627
 628 /**
 629  * Count the number of parameters in the last that match the given type.
 630  */
 631 GLuint
 632 _mesa_num_parameters_of_type(const struct gl_program_parameter_list *list,
 633                              gl_register_file type)
 634 {
 635    GLuint i, count = 0;
 636    if (list) {
 637       for (i = 0; i < list->NumParameters; i++) {
 638          if (list->Parameters[i].Type == type)
 639             count++;
 640       }
 641    }
 642    return count;
 643 }