src/mesa/program/prog_parameter.c

   1 /*
   2  * Mesa 3-D graphics library
   3  *
   4  * Copyright (C) 1999-2008  Brian Paul   All Rights Reserved.
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a
   7  * copy of this software and associated documentation files (the "Software"),
   8  * to deal in the Software without restriction, including without limitation
   9  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  10  * and/or sell copies of the Software, and to permit persons to whom the
  11  * Software is furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included
  14  * in all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  17  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  19  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
  20  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  21  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  22  * OTHER DEALINGS IN THE SOFTWARE.
  23  */
  24
  25 /**
  26  * \file 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(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    _mesa_align_free(paramList->ParameterValues);
  87    free(paramList);
  88 }
  89
  90
  91 /**
  92  * Add a new parameter to a parameter list.
  93  * Note that parameter values are usually 4-element GLfloat vectors.
  94  * When size > 4 we'll allocate a sequential block of parameters to
  95  * store all the values (in blocks of 4).
  96  *
  97  * \param paramList  the list to add the parameter to
  98  * \param type  type of parameter, such as
  99  * \param name  the parameter name, will be duplicated/copied!
 100  * \param size  number of elements in 'values' vector (1..4, or more)
 101  * \param datatype  GL_FLOAT, GL_FLOAT_VECx, GL_INT, GL_INT_VECx or GL_NONE.
 102  * \param values  initial parameter value, up to 4 gl_constant_values, or NULL
 103  * \param state  state indexes, or NULL
 104  * \return  index of new parameter in the list, or -1 if error (out of mem)
 105  */
 106 GLint
 107 _mesa_add_parameter(struct gl_program_parameter_list *paramList,
 108                     gl_register_file type, const char *name,
 109                     GLuint size, GLenum datatype,
 110                     const gl_constant_value *values,
 111                     const gl_state_index state[STATE_LENGTH])
 112 {
 113    const GLuint oldNum = paramList->NumParameters;
 114    const GLuint sz4 = (size + 3) / 4; /* no. of new param slots needed */
 115
 116    assert(size > 0);
 117
 118    if (oldNum + sz4 > paramList->Size) {
 119       /* Need to grow the parameter list array (alloc some extra) */
 120       paramList->Size = paramList->Size + 4 * sz4;
 121
 122       /* realloc arrays */
 123       paramList->Parameters = (struct gl_program_parameter *)
 124          realloc(paramList->Parameters,
 125                  paramList->Size * sizeof(struct gl_program_parameter));
 126
 127       paramList->ParameterValues = (gl_constant_value (*)[4])
 128          _mesa_align_realloc(paramList->ParameterValues,         /* old buf */
 129                              oldNum * 4 * sizeof(gl_constant_value),/* old sz */
 130                              paramList->Size*4*sizeof(gl_constant_value),/*new*/
 131                              16);
 132    }
 133
 134    if (!paramList->Parameters ||
 135        !paramList->ParameterValues) {
 136       /* out of memory */
 137       paramList->NumParameters = 0;
 138       paramList->Size = 0;
 139       return -1;
 140    }
 141    else {
 142       GLuint i, j;
 143
 144       paramList->NumParameters = oldNum + sz4;
 145
 146       memset(&paramList->Parameters[oldNum], 0,
 147              sz4 * sizeof(struct gl_program_parameter));
 148
 149       for (i = 0; i < sz4; i++) {
 150          struct gl_program_parameter *p = paramList->Parameters + oldNum + i;
 151          p->Name = name ? _mesa_strdup(name) : NULL;
 152          p->Type = type;
 153          p->Size = size;
 154          p->DataType = datatype;
 155          if (values) {
 156             if (size >= 4) {
 157                COPY_4V(paramList->ParameterValues[oldNum + i], values);
 158             }
 159             else {
 160                /* copy 1, 2 or 3 values */
 161                GLuint remaining = size % 4;
 162                assert(remaining < 4);
 163                for (j = 0; j < remaining; j++) {
 164                   paramList->ParameterValues[oldNum + i][j].f = values[j].f;
 165                }
 166                /* fill in remaining positions with zeros */
 167                for (; j < 4; j++) {
 168                   paramList->ParameterValues[oldNum + i][j].f = 0.0f;
 169                }
 170             }
 171             values += 4;
 172             p->Initialized = GL_TRUE;
 173          }
 174          else {
 175             /* silence valgrind */
 176             for (j = 0; j < 4; j++)
 177                 paramList->ParameterValues[oldNum + i][j].f = 0;
 178          }
 179          size -= 4;
 180       }
 181
 182       if (state) {
 183          for (i = 0; i < STATE_LENGTH; i++)
 184             paramList->Parameters[oldNum].StateIndexes[i] = state[i];
 185       }
 186
 187       return (GLint) oldNum;
 188    }
 189 }
 190
 191
 192 /**
 193  * Add a new named constant to the parameter list.
 194  * This will be used when the program contains something like this:
 195  *    PARAM myVals = { 0, 1, 2, 3 };
 196  *
 197  * \param paramList  the parameter list
 198  * \param name  the name for the constant
 199  * \param values  four float values
 200  * \return index/position of the new parameter in the parameter list
 201  */
 202 GLint
 203 _mesa_add_named_constant(struct gl_program_parameter_list *paramList,
 204                          const char *name, const gl_constant_value values[4],
 205                          GLuint size)
 206 {
 207    /* first check if this is a duplicate constant */
 208    GLint pos;
 209    for (pos = 0; pos < (GLint)paramList->NumParameters; pos++) {
 210       const gl_constant_value *pvals = paramList->ParameterValues[pos];
 211       if (pvals[0].u == values[0].u &&
 212           pvals[1].u == values[1].u &&
 213           pvals[2].u == values[2].u &&
 214           pvals[3].u == values[3].u &&
 215           strcmp(paramList->Parameters[pos].Name, name) == 0) {
 216          /* Same name and value is already in the param list - reuse it */
 217          return pos;
 218       }
 219    }
 220    /* not found, add new parameter */
 221    return _mesa_add_parameter(paramList, PROGRAM_CONSTANT, name,
 222                               size, GL_NONE, values, NULL);
 223 }
 224
 225
 226 /**
 227  * Add a new unnamed constant to the parameter list.  This will be used
 228  * when a fragment/vertex program contains something like this:
 229  *    MOV r, { 0, 1, 2, 3 };
 230  * If swizzleOut is non-null we'll search the parameter list for an
 231  * existing instance of the constant which matches with a swizzle.
 232  *
 233  * \param paramList  the parameter list
 234  * \param values  four float values
 235  * \param swizzleOut  returns swizzle mask for accessing the constant
 236  * \return index/position of the new parameter in the parameter list.
 237  */
 238 GLint
 239 _mesa_add_typed_unnamed_constant(struct gl_program_parameter_list *paramList,
 240                            const gl_constant_value values[4], GLuint size,
 241                            GLenum datatype, GLuint *swizzleOut)
 242 {
 243    GLint pos;
 244    ASSERT(size >= 1);
 245    ASSERT(size <= 4);
 246
 247    if (swizzleOut &&
 248        _mesa_lookup_parameter_constant(paramList, values,
 249                                        size, &pos, swizzleOut)) {
 250       return pos;
 251    }
 252
 253    /* Look for empty space in an already unnamed constant parameter
 254     * to add this constant.  This will only work for single-element
 255     * constants because we rely on smearing (i.e. .yyyy or .zzzz).
 256     */
 257    if (size == 1 && swizzleOut) {
 258       for (pos = 0; pos < (GLint) paramList->NumParameters; pos++) {
 259          struct gl_program_parameter *p = paramList->Parameters + pos;
 260          if (p->Type == PROGRAM_CONSTANT && p->Size + size <= 4) {
 261             /* ok, found room */
 262             gl_constant_value *pVal = paramList->ParameterValues[pos];
 263             GLuint swz = p->Size; /* 1, 2 or 3 for Y, Z, W */
 264             pVal[p->Size] = values[0];
 265             p->Size++;
 266             *swizzleOut = MAKE_SWIZZLE4(swz, swz, swz, swz);
 267             return pos;
 268          }
 269       }
 270    }
 271
 272    /* add a new parameter to store this constant */
 273    pos = _mesa_add_parameter(paramList, PROGRAM_CONSTANT, NULL,
 274                              size, datatype, values, NULL);
 275    if (pos >= 0 && swizzleOut) {
 276       if (size == 1)
 277          *swizzleOut = SWIZZLE_XXXX;
 278       else
 279          *swizzleOut = SWIZZLE_NOOP;
 280    }
 281    return pos;
 282 }
 283
 284 /**
 285  * Add a new unnamed constant to the parameter list.  This will be used
 286  * when a fragment/vertex program contains something like this:
 287  *    MOV r, { 0, 1, 2, 3 };
 288  * If swizzleOut is non-null we'll search the parameter list for an
 289  * existing instance of the constant which matches with a swizzle.
 290  *
 291  * \param paramList  the parameter list
 292  * \param values  four float values
 293  * \param swizzleOut  returns swizzle mask for accessing the constant
 294  * \return index/position of the new parameter in the parameter list.
 295  * \sa _mesa_add_typed_unnamed_constant
 296  */
 297 GLint
 298 _mesa_add_unnamed_constant(struct gl_program_parameter_list *paramList,
 299                            const gl_constant_value values[4], GLuint size,
 300                            GLuint *swizzleOut)
 301 {
 302    return _mesa_add_typed_unnamed_constant(paramList, values, size, GL_NONE,
 303                                            swizzleOut);
 304 }
 305
 306 #if 0 /* not used yet */
 307 /**
 308  * Returns the number of 4-component registers needed to store a piece
 309  * of GL state.  For matrices this may be as many as 4 registers,
 310  * everything else needs
 311  * just 1 register.
 312  */
 313 static GLuint
 314 sizeof_state_reference(const GLint *stateTokens)
 315 {
 316    if (stateTokens[0] == STATE_MATRIX) {
 317       GLuint rows = stateTokens[4] - stateTokens[3] + 1;
 318       assert(rows >= 1);
 319       assert(rows <= 4);
 320       return rows;
 321    }
 322    else {
 323       return 1;
 324    }
 325 }
 326 #endif
 327
 328
 329 /**
 330  * Add a new state reference to the parameter list.
 331  * This will be used when the program contains something like this:
 332  *    PARAM ambient = state.material.front.ambient;
 333  *
 334  * \param paramList  the parameter list
 335  * \param stateTokens  an array of 5 (STATE_LENGTH) state tokens
 336  * \return index of the new parameter.
 337  */
 338 GLint
 339 _mesa_add_state_reference(struct gl_program_parameter_list *paramList,
 340                           const gl_state_index stateTokens[STATE_LENGTH])
 341 {
 342    const GLuint size = 4; /* XXX fix */
 343    char *name;
 344    GLint index;
 345
 346    /* Check if the state reference is already in the list */
 347    for (index = 0; index < (GLint) paramList->NumParameters; index++) {
 348       if (!memcmp(paramList->Parameters[index].StateIndexes,
 349                   stateTokens, STATE_LENGTH * sizeof(gl_state_index))) {
 350          return index;
 351       }
 352    }
 353
 354    name = _mesa_program_state_string(stateTokens);
 355    index = _mesa_add_parameter(paramList, PROGRAM_STATE_VAR, name,
 356                                size, GL_NONE,
 357                                NULL, (gl_state_index *) stateTokens);
 358    paramList->StateFlags |= _mesa_program_state_flags(stateTokens);
 359
 360    /* free name string here since we duplicated it in add_parameter() */
 361    free(name);
 362
 363    return index;
 364 }
 365
 366
 367 /**
 368  * Lookup a parameter value by name in the given parameter list.
 369  * \return pointer to the float[4] values.
 370  */
 371 gl_constant_value *
 372 _mesa_lookup_parameter_value(const struct gl_program_parameter_list *paramList,
 373                              GLsizei nameLen, const char *name)
 374 {
 375    GLint i = _mesa_lookup_parameter_index(paramList, nameLen, name);
 376    if (i < 0)
 377       return NULL;
 378    else
 379       return paramList->ParameterValues[i];
 380 }
 381
 382
 383 /**
 384  * Given a program parameter name, find its position in the list of parameters.
 385  * \param paramList  the parameter list to search
 386  * \param nameLen  length of name (in chars).
 387  *                 If length is negative, assume that name is null-terminated.
 388  * \param name  the name to search for
 389  * \return index of parameter in the list.
 390  */
 391 GLint
 392 _mesa_lookup_parameter_index(const struct gl_program_parameter_list *paramList,
 393                              GLsizei nameLen, const char *name)
 394 {
 395    GLint i;
 396
 397    if (!paramList)
 398       return -1;
 399
 400    if (nameLen == -1) {
 401       /* name is null-terminated */
 402       for (i = 0; i < (GLint) paramList->NumParameters; i++) {
 403          if (paramList->Parameters[i].Name &&
 404              strcmp(paramList->Parameters[i].Name, name) == 0)
 405             return i;
 406       }
 407    }
 408    else {
 409       /* name is not null-terminated, use nameLen */
 410       for (i = 0; i < (GLint) paramList->NumParameters; i++) {
 411          if (paramList->Parameters[i].Name &&
 412              strncmp(paramList->Parameters[i].Name, name, nameLen) == 0
 413              && strlen(paramList->Parameters[i].Name) == (size_t)nameLen)
 414             return i;
 415       }
 416    }
 417    return -1;
 418 }
 419
 420
 421 /**
 422  * Look for a float vector in the given parameter list.  The float vector
 423  * may be of length 1, 2, 3 or 4.  If swizzleOut is non-null, we'll try
 424  * swizzling to find a match.
 425  * \param list  the parameter list to search
 426  * \param v  the float vector to search for
 427  * \param vSize  number of element in v
 428  * \param posOut  returns the position of the constant, if found
 429  * \param swizzleOut  returns a swizzle mask describing location of the
 430  *                    vector elements if found.
 431  * \return GL_TRUE if found, GL_FALSE if not found
 432  */
 433 GLboolean
 434 _mesa_lookup_parameter_constant(const struct gl_program_parameter_list *list,
 435                                 const gl_constant_value v[], GLuint vSize,
 436                                 GLint *posOut, GLuint *swizzleOut)
 437 {
 438    GLuint i;
 439
 440    assert(vSize >= 1);
 441    assert(vSize <= 4);
 442
 443    if (!list) {
 444       *posOut = -1;
 445       return GL_FALSE;
 446    }
 447
 448    for (i = 0; i < list->NumParameters; i++) {
 449       if (list->Parameters[i].Type == PROGRAM_CONSTANT) {
 450          if (!swizzleOut) {
 451             /* swizzle not allowed */
 452             GLuint j, match = 0;
 453             for (j = 0; j < vSize; j++) {
 454                if (v[j].u == list->ParameterValues[i][j].u)
 455                   match++;
 456             }
 457             if (match == vSize) {
 458                *posOut = i;
 459                return GL_TRUE;
 460             }
 461          }
 462          else {
 463             /* try matching w/ swizzle */
 464              if (vSize == 1) {
 465                 /* look for v[0] anywhere within float[4] value */
 466                 GLuint j;
 467                 for (j = 0; j < list->Parameters[i].Size; j++) {
 468                    if (list->ParameterValues[i][j].u == v[0].u) {
 469                       /* found it */
 470                       *posOut = i;
 471                       *swizzleOut = MAKE_SWIZZLE4(j, j, j, j);
 472                       return GL_TRUE;
 473                    }
 474                 }
 475              }
 476              else if (vSize <= list->Parameters[i].Size) {
 477                 /* see if we can match this constant (with a swizzle) */
 478                 GLuint swz[4];
 479                 GLuint match = 0, j, k;
 480                 for (j = 0; j < vSize; j++) {
 481                    if (v[j].u == list->ParameterValues[i][j].u) {
 482                       swz[j] = j;
 483                       match++;
 484                    }
 485                    else {
 486                       for (k = 0; k < list->Parameters[i].Size; k++) {
 487                          if (v[j].u == list->ParameterValues[i][k].u) {
 488                             swz[j] = k;
 489                             match++;
 490                             break;
 491                          }
 492                       }
 493                    }
 494                 }
 495                 /* smear last value to remaining positions */
 496                 for (; j < 4; j++)
 497                    swz[j] = swz[j-1];
 498
 499                 if (match == vSize) {
 500                    *posOut = i;
 501                    *swizzleOut = MAKE_SWIZZLE4(swz[0], swz[1], swz[2], swz[3]);
 502                    return GL_TRUE;
 503                 }
 504              }
 505          }
 506       }
 507    }
 508
 509    *posOut = -1;
 510    return GL_FALSE;
 511 }
 512
 513
 514 struct gl_program_parameter_list *
 515 _mesa_clone_parameter_list(const struct gl_program_parameter_list *list)
 516 {
 517    struct gl_program_parameter_list *clone;
 518    GLuint i;
 519
 520    clone = _mesa_new_parameter_list();
 521    if (!clone)
 522       return NULL;
 523
 524    /** Not too efficient, but correct */
 525    for (i = 0; i < list->NumParameters; i++) {
 526       struct gl_program_parameter *p = list->Parameters + i;
 527       struct gl_program_parameter *pCopy;
 528       GLuint size = MIN2(p->Size, 4);
 529       GLint j = _mesa_add_parameter(clone, p->Type, p->Name, size, p->DataType,
 530                                     list->ParameterValues[i], NULL);
 531       ASSERT(j >= 0);
 532       pCopy = clone->Parameters + j;
 533       /* copy state indexes */
 534       if (p->Type == PROGRAM_STATE_VAR) {
 535          GLint k;
 536          for (k = 0; k < STATE_LENGTH; k++) {
 537             pCopy->StateIndexes[k] = p->StateIndexes[k];
 538          }
 539       }
 540       else {
 541          clone->Parameters[j].Size = p->Size;
 542       }
 543
 544    }
 545
 546    clone->StateFlags = list->StateFlags;
 547
 548    return clone;
 549 }
 550
 551
 552 /**
 553  * Return a new parameter list which is listA + listB.
 554  */
 555 struct gl_program_parameter_list *
 556 _mesa_combine_parameter_lists(const struct gl_program_parameter_list *listA,
 557                               const struct gl_program_parameter_list *listB)
 558 {
 559    struct gl_program_parameter_list *list;
 560
 561    if (listA) {
 562       list = _mesa_clone_parameter_list(listA);
 563       if (list && listB) {
 564          GLuint i;
 565          for (i = 0; i < listB->NumParameters; i++) {
 566             struct gl_program_parameter *param = listB->Parameters + i;
 567             _mesa_add_parameter(list, param->Type, param->Name, param->Size,
 568                                 param->DataType,
 569                                 listB->ParameterValues[i],
 570                                 param->StateIndexes);
 571          }
 572       }
 573    }
 574    else if (listB) {
 575       list = _mesa_clone_parameter_list(listB);
 576    }
 577    else {
 578       list = NULL;
 579    }
 580    return list;
 581 }