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 =
 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 ? 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 unnamed constant to the parameter list.  This will be used
 194  * when a fragment/vertex program contains something like this:
 195  *    MOV r, { 0, 1, 2, 3 };
 196  * If swizzleOut is non-null we'll search the parameter list for an
 197  * existing instance of the constant which matches with a swizzle.
 198  *
 199  * \param paramList  the parameter list
 200  * \param values  four float values
 201  * \param swizzleOut  returns swizzle mask for accessing the constant
 202  * \return index/position of the new parameter in the parameter list.
 203  */
 204 GLint
 205 _mesa_add_typed_unnamed_constant(struct gl_program_parameter_list *paramList,
 206                            const gl_constant_value values[4], GLuint size,
 207                            GLenum datatype, GLuint *swizzleOut)
 208 {
 209    GLint pos;
 210    assert(size >= 1);
 211    assert(size <= 4);
 212
 213    if (swizzleOut &&
 214        _mesa_lookup_parameter_constant(paramList, values,
 215                                        size, &pos, swizzleOut)) {
 216       return pos;
 217    }
 218
 219    /* Look for empty space in an already unnamed constant parameter
 220     * to add this constant.  This will only work for single-element
 221     * constants because we rely on smearing (i.e. .yyyy or .zzzz).
 222     */
 223    if (size == 1 && swizzleOut) {
 224       for (pos = 0; pos < (GLint) paramList->NumParameters; pos++) {
 225          struct gl_program_parameter *p = paramList->Parameters + pos;
 226          if (p->Type == PROGRAM_CONSTANT && p->Size + size <= 4) {
 227             /* ok, found room */
 228             gl_constant_value *pVal = paramList->ParameterValues[pos];
 229             GLuint swz = p->Size; /* 1, 2 or 3 for Y, Z, W */
 230             pVal[p->Size] = values[0];
 231             p->Size++;
 232             *swizzleOut = MAKE_SWIZZLE4(swz, swz, swz, swz);
 233             return pos;
 234          }
 235       }
 236    }
 237
 238    /* add a new parameter to store this constant */
 239    pos = _mesa_add_parameter(paramList, PROGRAM_CONSTANT, NULL,
 240                              size, datatype, values, NULL);
 241    if (pos >= 0 && swizzleOut) {
 242       if (size == 1)
 243          *swizzleOut = SWIZZLE_XXXX;
 244       else
 245          *swizzleOut = SWIZZLE_NOOP;
 246    }
 247    return pos;
 248 }
 249
 250 /**
 251  * Add a new unnamed constant to the parameter list.  This will be used
 252  * when a fragment/vertex program contains something like this:
 253  *    MOV r, { 0, 1, 2, 3 };
 254  * If swizzleOut is non-null we'll search the parameter list for an
 255  * existing instance of the constant which matches with a swizzle.
 256  *
 257  * \param paramList  the parameter list
 258  * \param values  four float values
 259  * \param swizzleOut  returns swizzle mask for accessing the constant
 260  * \return index/position of the new parameter in the parameter list.
 261  * \sa _mesa_add_typed_unnamed_constant
 262  */
 263 GLint
 264 _mesa_add_unnamed_constant(struct gl_program_parameter_list *paramList,
 265                            const gl_constant_value values[4], GLuint size,
 266                            GLuint *swizzleOut)
 267 {
 268    return _mesa_add_typed_unnamed_constant(paramList, values, size, GL_NONE,
 269                                            swizzleOut);
 270 }
 271
 272
 273 /**
 274  * Add a new state reference to the parameter list.
 275  * This will be used when the program contains something like this:
 276  *    PARAM ambient = state.material.front.ambient;
 277  *
 278  * \param paramList  the parameter list
 279  * \param stateTokens  an array of 5 (STATE_LENGTH) state tokens
 280  * \return index of the new parameter.
 281  */
 282 GLint
 283 _mesa_add_state_reference(struct gl_program_parameter_list *paramList,
 284                           const gl_state_index stateTokens[STATE_LENGTH])
 285 {
 286    const GLuint size = 4; /* XXX fix */
 287    char *name;
 288    GLint index;
 289
 290    /* Check if the state reference is already in the list */
 291    for (index = 0; index < (GLint) paramList->NumParameters; index++) {
 292       if (!memcmp(paramList->Parameters[index].StateIndexes,
 293                   stateTokens, STATE_LENGTH * sizeof(gl_state_index))) {
 294          return index;
 295       }
 296    }
 297
 298    name = _mesa_program_state_string(stateTokens);
 299    index = _mesa_add_parameter(paramList, PROGRAM_STATE_VAR, name,
 300                                size, GL_NONE,
 301                                NULL, (gl_state_index *) stateTokens);
 302    paramList->StateFlags |= _mesa_program_state_flags(stateTokens);
 303
 304    /* free name string here since we duplicated it in add_parameter() */
 305    free(name);
 306
 307    return index;
 308 }
 309
 310
 311 /**
 312  * Given a program parameter name, find its position in the list of parameters.
 313  * \param paramList  the parameter list to search
 314  * \param nameLen  length of name (in chars).
 315  *                 If length is negative, assume that name is null-terminated.
 316  * \param name  the name to search for
 317  * \return index of parameter in the list.
 318  */
 319 GLint
 320 _mesa_lookup_parameter_index(const struct gl_program_parameter_list *paramList,
 321                              GLsizei nameLen, const char *name)
 322 {
 323    GLint i;
 324
 325    if (!paramList)
 326       return -1;
 327
 328    if (nameLen == -1) {
 329       /* name is null-terminated */
 330       for (i = 0; i < (GLint) paramList->NumParameters; i++) {
 331          if (paramList->Parameters[i].Name &&
 332              strcmp(paramList->Parameters[i].Name, name) == 0)
 333             return i;
 334       }
 335    }
 336    else {
 337       /* name is not null-terminated, use nameLen */
 338       for (i = 0; i < (GLint) paramList->NumParameters; i++) {
 339          if (paramList->Parameters[i].Name &&
 340              strncmp(paramList->Parameters[i].Name, name, nameLen) == 0
 341              && strlen(paramList->Parameters[i].Name) == (size_t)nameLen)
 342             return i;
 343       }
 344    }
 345    return -1;
 346 }
 347
 348
 349 /**
 350  * Look for a float vector in the given parameter list.  The float vector
 351  * may be of length 1, 2, 3 or 4.  If swizzleOut is non-null, we'll try
 352  * swizzling to find a match.
 353  * \param list  the parameter list to search
 354  * \param v  the float vector to search for
 355  * \param vSize  number of element in v
 356  * \param posOut  returns the position of the constant, if found
 357  * \param swizzleOut  returns a swizzle mask describing location of the
 358  *                    vector elements if found.
 359  * \return GL_TRUE if found, GL_FALSE if not found
 360  */
 361 GLboolean
 362 _mesa_lookup_parameter_constant(const struct gl_program_parameter_list *list,
 363                                 const gl_constant_value v[], GLuint vSize,
 364                                 GLint *posOut, GLuint *swizzleOut)
 365 {
 366    GLuint i;
 367
 368    assert(vSize >= 1);
 369    assert(vSize <= 4);
 370
 371    if (!list) {
 372       *posOut = -1;
 373       return GL_FALSE;
 374    }
 375
 376    for (i = 0; i < list->NumParameters; i++) {
 377       if (list->Parameters[i].Type == PROGRAM_CONSTANT) {
 378          if (!swizzleOut) {
 379             /* swizzle not allowed */
 380             GLuint j, match = 0;
 381             for (j = 0; j < vSize; j++) {
 382                if (v[j].u == list->ParameterValues[i][j].u)
 383                   match++;
 384             }
 385             if (match == vSize) {
 386                *posOut = i;
 387                return GL_TRUE;
 388             }
 389          }
 390          else {
 391             /* try matching w/ swizzle */
 392              if (vSize == 1) {
 393                 /* look for v[0] anywhere within float[4] value */
 394                 GLuint j;
 395                 for (j = 0; j < list->Parameters[i].Size; j++) {
 396                    if (list->ParameterValues[i][j].u == v[0].u) {
 397                       /* found it */
 398                       *posOut = i;
 399                       *swizzleOut = MAKE_SWIZZLE4(j, j, j, j);
 400                       return GL_TRUE;
 401                    }
 402                 }
 403              }
 404              else if (vSize <= list->Parameters[i].Size) {
 405                 /* see if we can match this constant (with a swizzle) */
 406                 GLuint swz[4];
 407                 GLuint match = 0, j, k;
 408                 for (j = 0; j < vSize; j++) {
 409                    if (v[j].u == list->ParameterValues[i][j].u) {
 410                       swz[j] = j;
 411                       match++;
 412                    }
 413                    else {
 414                       for (k = 0; k < list->Parameters[i].Size; k++) {
 415                          if (v[j].u == list->ParameterValues[i][k].u) {
 416                             swz[j] = k;
 417                             match++;
 418                             break;
 419                          }
 420                       }
 421                    }
 422                 }
 423                 /* smear last value to remaining positions */
 424                 for (; j < 4; j++)
 425                    swz[j] = swz[j-1];
 426
 427                 if (match == vSize) {
 428                    *posOut = i;
 429                    *swizzleOut = MAKE_SWIZZLE4(swz[0], swz[1], swz[2], swz[3]);
 430                    return GL_TRUE;
 431                 }
 432              }
 433          }
 434       }
 435    }
 436
 437    *posOut = -1;
 438    return GL_FALSE;
 439 }
 440
 441
 442 struct gl_program_parameter_list *
 443 _mesa_clone_parameter_list(const struct gl_program_parameter_list *list)
 444 {
 445    struct gl_program_parameter_list *clone;
 446    GLuint i;
 447
 448    clone = _mesa_new_parameter_list();
 449    if (!clone)
 450       return NULL;
 451
 452    /** Not too efficient, but correct */
 453    for (i = 0; i < list->NumParameters; i++) {
 454       struct gl_program_parameter *p = list->Parameters + i;
 455       struct gl_program_parameter *pCopy;
 456       GLuint size = MIN2(p->Size, 4);
 457       GLint j = _mesa_add_parameter(clone, p->Type, p->Name, size, p->DataType,
 458                                     list->ParameterValues[i], NULL);
 459       assert(j >= 0);
 460       pCopy = clone->Parameters + j;
 461       /* copy state indexes */
 462       if (p->Type == PROGRAM_STATE_VAR) {
 463          GLint k;
 464          for (k = 0; k < STATE_LENGTH; k++) {
 465             pCopy->StateIndexes[k] = p->StateIndexes[k];
 466          }
 467       }
 468       else {
 469          clone->Parameters[j].Size = p->Size;
 470       }
 471
 472    }
 473
 474    clone->StateFlags = list->StateFlags;
 475
 476    return clone;
 477 }
 478
 479
 480 /**
 481  * Return a new parameter list which is listA + listB.
 482  */
 483 struct gl_program_parameter_list *
 484 _mesa_combine_parameter_lists(const struct gl_program_parameter_list *listA,
 485                               const struct gl_program_parameter_list *listB)
 486 {
 487    struct gl_program_parameter_list *list;
 488
 489    if (listA) {
 490       list = _mesa_clone_parameter_list(listA);
 491       if (list && listB) {
 492          GLuint i;
 493          for (i = 0; i < listB->NumParameters; i++) {
 494             struct gl_program_parameter *param = listB->Parameters + i;
 495             _mesa_add_parameter(list, param->Type, param->Name, param->Size,
 496                                 param->DataType,
 497                                 listB->ParameterValues[i],
 498                                 param->StateIndexes);
 499          }
 500       }
 501    }
 502    else if (listB) {
 503       list = _mesa_clone_parameter_list(listB);
 504    }
 505    else {
 506       list = NULL;
 507    }
 508    return list;
 509 }