src/mesa/shader/prog_parameter.c

   1 /*
   2  * Mesa 3-D graphics library
   3  * Version:  6.5.3
   4  *
   5  * Copyright (C) 1999-2007  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 "glheader.h"
  33 #include "imports.h"
  34 #include "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 (struct gl_program_parameter_list *)
  44       _mesa_calloc(sizeof(struct gl_program_parameter_list));
  45 }
  46
  47
  48 /**
  49  * Free a parameter list and all its parameters
  50  */
  51 void
  52 _mesa_free_parameter_list(struct gl_program_parameter_list *paramList)
  53 {
  54    GLuint i;
  55    for (i = 0; i < paramList->NumParameters; i++) {
  56       if (paramList->Parameters[i].Name)
  57          _mesa_free((void *) paramList->Parameters[i].Name);
  58    }
  59    _mesa_free(paramList->Parameters);
  60    if (paramList->ParameterValues)
  61       _mesa_align_free(paramList->ParameterValues);
  62    _mesa_free(paramList);
  63 }
  64
  65
  66
  67 /**
  68  * Add a new parameter to a parameter list.
  69  * Note that parameter values are usually 4-element GLfloat vectors.
  70  * When size > 4 we'll allocate a sequential block of parameters to
  71  * store all the values (in blocks of 4).
  72  *
  73  * \param paramList  the list to add the parameter to
  74  * \param type  type of parameter, such as
  75  * \param name  the parameter name, will be duplicated/copied!
  76  * \param size  number of elements in 'values' vector (1..4, or more)
  77  * \param values  initial parameter value, up to 4 GLfloats, or NULL
  78  * \param state  state indexes, or NULL
  79  * \return  index of new parameter in the list, or -1 if error (out of mem)
  80  */
  81 GLint
  82 _mesa_add_parameter(struct gl_program_parameter_list *paramList,
  83                     enum register_file type, const char *name,
  84                     GLuint size, const GLfloat *values,
  85                     const gl_state_index state[STATE_LENGTH])
  86 {
  87    const GLuint oldNum = paramList->NumParameters;
  88    const GLuint sz4 = (size + 3) / 4; /* no. of new param slots needed */
  89
  90    assert(size > 0);
  91    assert(size <= 16);  /* XXX anything larger than a matrix??? */
  92
  93    if (oldNum + sz4 > paramList->Size) {
  94       /* Need to grow the parameter list array (alloc some extra) */
  95       paramList->Size = paramList->Size + 4 * sz4;
  96
  97       /* realloc arrays */
  98       paramList->Parameters = (struct gl_program_parameter *)
  99          _mesa_realloc(paramList->Parameters,
 100                        oldNum * sizeof(struct gl_program_parameter),
 101                        paramList->Size * sizeof(struct gl_program_parameter));
 102
 103       paramList->ParameterValues = (GLfloat (*)[4])
 104          _mesa_align_realloc(paramList->ParameterValues,         /* old buf */
 105                              oldNum * 4 * sizeof(GLfloat),      /* old size */
 106                              paramList->Size * 4 *sizeof(GLfloat), /* new sz */
 107                              16);
 108    }
 109
 110    if (!paramList->Parameters ||
 111        !paramList->ParameterValues) {
 112       /* out of memory */
 113       paramList->NumParameters = 0;
 114       paramList->Size = 0;
 115       return -1;
 116    }
 117    else {
 118       GLuint i;
 119
 120       paramList->NumParameters = oldNum + sz4;
 121
 122       _mesa_memset(&paramList->Parameters[oldNum], 0,
 123                    sz4 * sizeof(struct gl_program_parameter));
 124
 125       for (i = 0; i < sz4; i++) {
 126          struct gl_program_parameter *p = paramList->Parameters + oldNum + i;
 127          p->Name = name ? _mesa_strdup(name) : NULL;
 128          p->Type = type;
 129          p->Size = size;
 130          if (values) {
 131             COPY_4V(paramList->ParameterValues[oldNum + i], values);
 132             values += 4;
 133          }
 134          size -= 4;
 135       }
 136
 137       if (state) {
 138          for (i = 0; i < STATE_LENGTH; i++)
 139             paramList->Parameters[oldNum].StateIndexes[i] = state[i];
 140       }
 141
 142       return (GLint) oldNum;
 143    }
 144 }
 145
 146
 147 /**
 148  * Add a new named program parameter (Ex: NV_fragment_program DEFINE statement)
 149  * \return index of the new entry in the parameter list
 150  */
 151 GLint
 152 _mesa_add_named_parameter(struct gl_program_parameter_list *paramList,
 153                           const char *name, const GLfloat values[4])
 154 {
 155    return _mesa_add_parameter(paramList, PROGRAM_NAMED_PARAM, name,
 156                               4, values, NULL);
 157
 158 }
 159
 160
 161 /**
 162  * Add a new named constant to the parameter list.
 163  * This will be used when the program contains something like this:
 164  *    PARAM myVals = { 0, 1, 2, 3 };
 165  *
 166  * \param paramList  the parameter list
 167  * \param name  the name for the constant
 168  * \param values  four float values
 169  * \return index/position of the new parameter in the parameter list
 170  */
 171 GLint
 172 _mesa_add_named_constant(struct gl_program_parameter_list *paramList,
 173                          const char *name, const GLfloat values[4],
 174                          GLuint size)
 175 {
 176 #if 0 /* disable this for now -- we need to save the name! */
 177    GLint pos;
 178    GLuint swizzle;
 179    ASSERT(size == 4); /* XXX future feature */
 180    /* check if we already have this constant */
 181    if (_mesa_lookup_parameter_constant(paramList, values, 4, &pos, &swizzle)) {
 182       return pos;
 183    }
 184 #endif
 185    size = 4; /** XXX fix */
 186    return _mesa_add_parameter(paramList, PROGRAM_CONSTANT, name,
 187                               size, values, NULL);
 188
 189 }
 190
 191
 192 /**
 193  * Add a new unnamed constant to the parameter list.
 194  * This will be used when the program contains something like this:
 195  *    MOV r, { 0, 1, 2, 3 };
 196  *
 197  * \param paramList  the parameter list
 198  * \param values  four float values
 199  * \param swizzleOut  returns swizzle mask for accessing the constant
 200  * \return index/position of the new parameter in the parameter list.
 201  */
 202 GLint
 203 _mesa_add_unnamed_constant(struct gl_program_parameter_list *paramList,
 204                            const GLfloat values[4], GLuint size,
 205                            GLuint *swizzleOut)
 206 {
 207    GLint pos;
 208    GLuint swizzle;
 209    ASSERT(size >= 1);
 210    ASSERT(size <= 4);
 211    size = 4; /* XXX temporary */
 212    /* check if we already have this constant */
 213    if (_mesa_lookup_parameter_constant(paramList, values,
 214                                        size, &pos, &swizzle)) {
 215       return pos;
 216    }
 217    return _mesa_add_parameter(paramList, PROGRAM_CONSTANT, NULL,
 218                               size, values, NULL);
 219
 220 }
 221
 222
 223 GLint
 224 _mesa_add_uniform(struct gl_program_parameter_list *paramList,
 225                   const char *name, GLuint size)
 226 {
 227    GLint i = _mesa_lookup_parameter_index(paramList, -1, name);
 228    if (i >= 0 && paramList->Parameters[i].Type == PROGRAM_UNIFORM) {
 229       /* already in list */
 230       return i;
 231    }
 232    else {
 233       i = _mesa_add_parameter(paramList, PROGRAM_UNIFORM, name,
 234                               size, NULL, NULL);
 235
 236       return i;
 237    }
 238 }
 239
 240
 241 GLint
 242 _mesa_add_sampler(struct gl_program_parameter_list *paramList,
 243                   const char *name)
 244 {
 245    GLint i = _mesa_lookup_parameter_index(paramList, -1, name);
 246    if (i >= 0 && paramList->Parameters[i].Type == PROGRAM_SAMPLER) {
 247       /* already in list */
 248       return i;
 249    }
 250    else {
 251       const GLint size = 1;
 252       i = _mesa_add_parameter(paramList, PROGRAM_SAMPLER, name,
 253                               size, NULL, NULL);
 254       return i;
 255    }
 256 }
 257
 258
 259 /**
 260  * Add parameter representing a varying variable.
 261  */
 262 GLint
 263 _mesa_add_varying(struct gl_program_parameter_list *paramList,
 264                   const char *name, GLuint size)
 265 {
 266    GLint i = _mesa_lookup_parameter_index(paramList, -1, name);
 267    if (i >= 0 && paramList->Parameters[i].Type == PROGRAM_VARYING) {
 268       /* already in list */
 269       return i;
 270    }
 271    else {
 272       assert(size == 4);
 273       i = _mesa_add_parameter(paramList, PROGRAM_VARYING, name,
 274                               size, NULL, NULL);
 275       return i;
 276    }
 277 }
 278
 279
 280 /**
 281  * Add parameter representing a vertex program attribute.
 282  * \param size  size of attribute (in floats), may be -1 if unknown
 283  * \param attrib  the attribute index, or -1 if unknown
 284  */
 285 GLint
 286 _mesa_add_attribute(struct gl_program_parameter_list *paramList,
 287                     const char *name, GLint size, GLint attrib)
 288 {
 289    GLint i = _mesa_lookup_parameter_index(paramList, -1, name);
 290    if (i >= 0) {
 291       /* replace */
 292       ASSERT(paramList->Parameters[i].StateIndexes[0] == STATE_USER_ATTRIB);
 293       if (attrib < 0)
 294          attrib = i;
 295       paramList->Parameters[i].StateIndexes[1] = attrib;
 296    }
 297    else {
 298       /* add */
 299       gl_state_index state[STATE_LENGTH];
 300       state[0] = STATE_USER_ATTRIB;
 301       state[1] = attrib;
 302       i = _mesa_add_parameter(paramList, PROGRAM_INPUT, name,
 303                               size, NULL, state);
 304    }
 305    return i;
 306 }
 307
 308
 309
 310 #if 0 /* not used yet */
 311 /**
 312  * Returns the number of 4-component registers needed to store a piece
 313  * of GL state.  For matrices this may be as many as 4 registers,
 314  * everything else needs
 315  * just 1 register.
 316  */
 317 static GLuint
 318 sizeof_state_reference(const GLint *stateTokens)
 319 {
 320    if (stateTokens[0] == STATE_MATRIX) {
 321       GLuint rows = stateTokens[4] - stateTokens[3] + 1;
 322       assert(rows >= 1);
 323       assert(rows <= 4);
 324       return rows;
 325    }
 326    else {
 327       return 1;
 328    }
 329 }
 330 #endif
 331
 332
 333 /**
 334  * Add a new state reference to the parameter list.
 335  * This will be used when the program contains something like this:
 336  *    PARAM ambient = state.material.front.ambient;
 337  *
 338  * \param paramList  the parameter list
 339  * \param state  an array of 6 (STATE_LENGTH) state tokens
 340  * \return index of the new parameter.
 341  */
 342 GLint
 343 _mesa_add_state_reference(struct gl_program_parameter_list *paramList,
 344                           const GLint stateTokens[STATE_LENGTH])
 345 {
 346    const GLuint size = 4; /* XXX fix */
 347    const char *name;
 348    GLint index;
 349
 350    /* Check if the state reference is already in the list */
 351    for (index = 0; index < paramList->NumParameters; index++) {
 352       GLuint i, match = 0;
 353       for (i = 0; i < 6; i++) {
 354          if (paramList->Parameters[index].StateIndexes[i] == stateTokens[i]) {
 355             match++;
 356          }
 357          else {
 358             break;
 359          }
 360       }
 361       if (match == STATE_LENGTH) {
 362          /* this state reference is already in the parameter list */
 363          return index;
 364       }
 365    }
 366
 367    name = _mesa_program_state_string(stateTokens);
 368    index = _mesa_add_parameter(paramList, PROGRAM_STATE_VAR, name,
 369                                size, NULL, NULL);
 370
 371    if (index >= 0) {
 372       GLuint i;
 373       for (i = 0; i < STATE_LENGTH; i++) {
 374          paramList->Parameters[index].StateIndexes[i]
 375             = (gl_state_index) stateTokens[i];
 376       }
 377       paramList->StateFlags |= _mesa_program_state_flags(stateTokens);
 378    }
 379
 380    /* free name string here since we duplicated it in add_parameter() */
 381    _mesa_free((void *) name);
 382
 383    return index;
 384 }
 385
 386
 387 /**
 388  * Lookup a parameter value by name in the given parameter list.
 389  * \return pointer to the float[4] values.
 390  */
 391 GLfloat *
 392 _mesa_lookup_parameter_value(const struct gl_program_parameter_list *paramList,
 393                              GLsizei nameLen, const char *name)
 394 {
 395    GLuint i = _mesa_lookup_parameter_index(paramList, nameLen, name);
 396    if (i < 0)
 397       return NULL;
 398    else
 399       return paramList->ParameterValues[i];
 400 }
 401
 402
 403 /**
 404  * Given a program parameter name, find its position in the list of parameters.
 405  * \param paramList  the parameter list to search
 406  * \param nameLen  length of name (in chars).
 407  *                 If length is negative, assume that name is null-terminated.
 408  * \param name  the name to search for
 409  * \return index of parameter in the list.
 410  */
 411 GLint
 412 _mesa_lookup_parameter_index(const struct gl_program_parameter_list *paramList,
 413                              GLsizei nameLen, const char *name)
 414 {
 415    GLint i;
 416
 417    if (!paramList)
 418       return -1;
 419
 420    if (nameLen == -1) {
 421       /* name is null-terminated */
 422       for (i = 0; i < (GLint) paramList->NumParameters; i++) {
 423          if (paramList->Parameters[i].Name &&
 424              _mesa_strcmp(paramList->Parameters[i].Name, name) == 0)
 425             return i;
 426       }
 427    }
 428    else {
 429       /* name is not null-terminated, use nameLen */
 430       for (i = 0; i < (GLint) paramList->NumParameters; i++) {
 431          if (paramList->Parameters[i].Name &&
 432              _mesa_strncmp(paramList->Parameters[i].Name, name, nameLen) == 0
 433              && _mesa_strlen(paramList->Parameters[i].Name) == (size_t)nameLen)
 434             return i;
 435       }
 436    }
 437    return -1;
 438 }
 439
 440
 441 /**
 442  * Look for a float vector in the given parameter list.  The float vector
 443  * may be of length 1, 2, 3 or 4.
 444  * \param paramList  the parameter list to search
 445  * \param v  the float vector to search for
 446  * \param size  number of element in v
 447  * \param posOut  returns the position of the constant, if found
 448  * \param swizzleOut  returns a swizzle mask describing location of the
 449  *                    vector elements if found
 450  * \return GL_TRUE if found, GL_FALSE if not found
 451  */
 452 GLboolean
 453 _mesa_lookup_parameter_constant(const struct gl_program_parameter_list *paramList,
 454                                 const GLfloat v[], GLsizei vSize,
 455                                 GLint *posOut, GLuint *swizzleOut)
 456 {
 457    GLuint i;
 458
 459    assert(vSize >= 1);
 460    assert(vSize <= 4);
 461
 462    if (!paramList)
 463       return -1;
 464
 465    for (i = 0; i < paramList->NumParameters; i++) {
 466       if (paramList->Parameters[i].Type == PROGRAM_CONSTANT) {
 467          const GLint maxShift = 4 - vSize;
 468          GLint shift, j;
 469          for (shift = 0; shift <= maxShift; shift++) {
 470             GLint matched = 0;
 471             GLuint swizzle[4];
 472             swizzle[0] = swizzle[1] = swizzle[2] = swizzle[3] = 0;
 473             /* XXX we could do out-of-order swizzle matches too, someday */
 474             for (j = 0; j < vSize; j++) {
 475                assert(shift + j < 4);
 476                if (paramList->ParameterValues[i][shift + j] == v[j]) {
 477                   matched++;
 478                   swizzle[j] = shift + j;
 479                   ASSERT(swizzle[j] >= SWIZZLE_X);
 480                   ASSERT(swizzle[j] <= SWIZZLE_W);
 481                }
 482             }
 483             if (matched == vSize) {
 484                /* found! */
 485                *posOut = i;
 486                *swizzleOut = MAKE_SWIZZLE4(swizzle[0], swizzle[1],
 487                                            swizzle[2], swizzle[3]);
 488                return GL_TRUE;
 489             }
 490          }
 491       }
 492    }
 493
 494    *posOut = -1;
 495    return GL_FALSE;
 496 }
 497
 498
 499 struct gl_program_parameter_list *
 500 _mesa_clone_parameter_list(const struct gl_program_parameter_list *list)
 501 {
 502    struct gl_program_parameter_list *clone;
 503    GLuint i;
 504
 505    clone = _mesa_new_parameter_list();
 506    if (!clone)
 507       return NULL;
 508
 509    /** Not too efficient, but correct */
 510    for (i = 0; i < list->NumParameters; i++) {
 511       struct gl_program_parameter *p = list->Parameters + i;
 512       GLuint size = MIN2(p->Size, 4);
 513       GLint j = _mesa_add_parameter(clone, p->Type, p->Name,
 514                                     size, list->ParameterValues[i], NULL);
 515       ASSERT(j >= 0);
 516       /* copy state indexes */
 517       if (p->Type == PROGRAM_STATE_VAR) {
 518          GLint k;
 519          struct gl_program_parameter *q = clone->Parameters + j;
 520          for (k = 0; k < STATE_LENGTH; k++) {
 521             q->StateIndexes[k] = p->StateIndexes[k];
 522          }
 523       }
 524       else {
 525          clone->Parameters[j].Size = p->Size;
 526       }
 527    }
 528
 529    return clone;
 530 }
 531
 532
 533 /**
 534  * Find longest name of any parameter in list.
 535  */
 536 GLuint
 537 _mesa_parameter_longest_name(const struct gl_program_parameter_list *list)
 538 {
 539    GLuint i, maxLen = 0;
 540    if (!list)
 541       return 0;
 542    for (i = 0; i < list->NumParameters; i++) {
 543       GLuint len = _mesa_strlen(list->Parameters[i].Name);
 544       if (len > maxLen)
 545          maxLen = len;
 546    }
 547    return maxLen;
 548 }
 549