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