src/glsl/glsl_types.h

   1 /* -*- c++ -*- */
   2 /*
   3  * Copyright © 2009 Intel Corporation
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining a
   6  * copy of this software and associated documentation files (the "Software"),
   7  * to deal in the Software without restriction, including without limitation
   8  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   9  * and/or sell copies of the Software, and to permit persons to whom the
  10  * Software is furnished to do so, subject to the following conditions:
  11  *
  12  * The above copyright notice and this permission notice (including the next
  13  * paragraph) shall be included in all copies or substantial portions of the
  14  * Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * 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 OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  21  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  22  * DEALINGS IN THE SOFTWARE.
  23  */
  24
  25 #pragma once
  26 #ifndef GLSL_TYPES_H
  27 #define GLSL_TYPES_H
  28
  29 #include <string.h>
  30 #include <assert.h>
  31 #include "main/mtypes.h" /* for gl_texture_index, C++'s enum rules are broken */
  32
  33 #ifdef __cplusplus
  34 extern "C" {
  35 #endif
  36
  37 struct _mesa_glsl_parse_state;
  38 struct glsl_symbol_table;
  39
  40 extern void
  41 _mesa_glsl_initialize_types(struct _mesa_glsl_parse_state *state);
  42
  43 extern void
  44 _mesa_glsl_release_types(void);
  45
  46 #ifdef __cplusplus
  47 }
  48 #endif
  49
  50 enum glsl_base_type {
  51    GLSL_TYPE_UINT = 0,
  52    GLSL_TYPE_INT,
  53    GLSL_TYPE_FLOAT,
  54    GLSL_TYPE_BOOL,
  55    GLSL_TYPE_SAMPLER,
  56    GLSL_TYPE_STRUCT,
  57    GLSL_TYPE_INTERFACE,
  58    GLSL_TYPE_ARRAY,
  59    GLSL_TYPE_VOID,
  60    GLSL_TYPE_ERROR
  61 };
  62
  63 enum glsl_sampler_dim {
  64    GLSL_SAMPLER_DIM_1D = 0,
  65    GLSL_SAMPLER_DIM_2D,
  66    GLSL_SAMPLER_DIM_3D,
  67    GLSL_SAMPLER_DIM_CUBE,
  68    GLSL_SAMPLER_DIM_RECT,
  69    GLSL_SAMPLER_DIM_BUF,
  70    GLSL_SAMPLER_DIM_EXTERNAL,
  71    GLSL_SAMPLER_DIM_MS
  72 };
  73
  74 enum glsl_interface_packing {
  75    GLSL_INTERFACE_PACKING_STD140,
  76    GLSL_INTERFACE_PACKING_SHARED,
  77    GLSL_INTERFACE_PACKING_PACKED
  78 };
  79
  80 #ifdef __cplusplus
  81 #include "GL/gl.h"
  82 #include "ralloc.h"
  83
  84 struct glsl_type {
  85    GLenum gl_type;
  86    glsl_base_type base_type;
  87
  88    unsigned sampler_dimensionality:3; /**< \see glsl_sampler_dim */
  89    unsigned sampler_shadow:1;
  90    unsigned sampler_array:1;
  91    unsigned sampler_type:2;    /**< Type of data returned using this sampler.
  92                                 * only \c GLSL_TYPE_FLOAT, \c GLSL_TYPE_INT,
  93                                 * and \c GLSL_TYPE_UINT are valid.
  94                                 */
  95    unsigned interface_packing:2;
  96
  97    /* Callers of this ralloc-based new need not call delete. It's
  98     * easier to just ralloc_free 'mem_ctx' (or any of its ancestors). */
  99    static void* operator new(size_t size)
 100    {
 101       if (glsl_type::mem_ctx == NULL) {
 102          glsl_type::mem_ctx = ralloc_context(NULL);
 103          assert(glsl_type::mem_ctx != NULL);
 104       }
 105
 106       void *type;
 107
 108       type = ralloc_size(glsl_type::mem_ctx, size);
 109       assert(type != NULL);
 110
 111       return type;
 112    }
 113
 114    /* If the user *does* call delete, that's OK, we will just
 115     * ralloc_free in that case. */
 116    static void operator delete(void *type)
 117    {
 118       ralloc_free(type);
 119    }
 120
 121    /**
 122     * \name Vector and matrix element counts
 123     *
 124     * For scalars, each of these values will be 1.  For non-numeric types
 125     * these will be 0.
 126     */
 127    /*@{*/
 128    unsigned vector_elements:3; /**< 1, 2, 3, or 4 vector elements. */
 129    unsigned matrix_columns:3;  /**< 1, 2, 3, or 4 matrix columns. */
 130    /*@}*/
 131
 132    /**
 133     * Name of the data type
 134     *
 135     * Will never be \c NULL.
 136     */
 137    const char *name;
 138
 139    /**
 140     * For \c GLSL_TYPE_ARRAY, this is the length of the array.  For
 141     * \c GLSL_TYPE_STRUCT or \c GLSL_TYPE_INTERFACE, it is the number of
 142     * elements in the structure and the number of values pointed to by
 143     * \c fields.structure (below).
 144     */
 145    unsigned length;
 146
 147    /**
 148     * Subtype of composite data types.
 149     */
 150    union {
 151       const struct glsl_type *array;            /**< Type of array elements. */
 152       const struct glsl_type *parameters;       /**< Parameters to function. */
 153       struct glsl_struct_field *structure;      /**< List of struct fields. */
 154    } fields;
 155
 156    /**
 157     * \name Pointers to various public type singletons
 158     */
 159    /*@{*/
 160 #undef  DECL_TYPE
 161 #define DECL_TYPE(NAME, ...) \
 162    static const glsl_type *const NAME##_type;
 163 #undef  STRUCT_TYPE
 164 #define STRUCT_TYPE(NAME) \
 165    static const glsl_type *const struct_##NAME##_type;
 166 #include "builtin_type_macros.h"
 167    /*@}*/
 168
 169    /**
 170     * Convenience accessors for vector types (shorter than get_instance()).
 171     * @{
 172     */
 173    static const glsl_type *vec(unsigned components);
 174    static const glsl_type *ivec(unsigned components);
 175    static const glsl_type *uvec(unsigned components);
 176    static const glsl_type *bvec(unsigned components);
 177    /**@}*/
 178
 179    /**
 180     * For numeric and boolean derrived types returns the basic scalar type
 181     *
 182     * If the type is a numeric or boolean scalar, vector, or matrix type,
 183     * this function gets the scalar type of the individual components.  For
 184     * all other types, including arrays of numeric or boolean types, the
 185     * error type is returned.
 186     */
 187    const glsl_type *get_base_type() const;
 188
 189    /**
 190     * Get the basic scalar type which this type aggregates.
 191     *
 192     * If the type is a numeric or boolean scalar, vector, or matrix, or an
 193     * array of any of those, this function gets the scalar type of the
 194     * individual components.  For structs and arrays of structs, this function
 195     * returns the struct type.  For samplers and arrays of samplers, this
 196     * function returns the sampler type.
 197     */
 198    const glsl_type *get_scalar_type() const;
 199
 200    /**
 201     * Query the type of elements in an array
 202     *
 203     * \return
 204     * Pointer to the type of elements in the array for array types, or \c NULL
 205     * for non-array types.
 206     */
 207    const glsl_type *element_type() const
 208    {
 209       return is_array() ? fields.array : NULL;
 210    }
 211
 212    /**
 213     * Get the instance of a built-in scalar, vector, or matrix type
 214     */
 215    static const glsl_type *get_instance(unsigned base_type, unsigned rows,
 216                                         unsigned columns);
 217
 218    /**
 219     * Get the instance of an array type
 220     */
 221    static const glsl_type *get_array_instance(const glsl_type *base,
 222                                               unsigned elements);
 223
 224    /**
 225     * Get the instance of a record type
 226     */
 227    static const glsl_type *get_record_instance(const glsl_struct_field *fields,
 228                                                unsigned num_fields,
 229                                                const char *name);
 230
 231    /**
 232     * Get the instance of an interface block type
 233     */
 234    static const glsl_type *get_interface_instance(const glsl_struct_field *fields,
 235                                                   unsigned num_fields,
 236                                                   enum glsl_interface_packing packing,
 237                                                   const char *name);
 238
 239    /**
 240     * Query the total number of scalars that make up a scalar, vector or matrix
 241     */
 242    unsigned components() const
 243    {
 244       return vector_elements * matrix_columns;
 245    }
 246
 247    /**
 248     * Calculate the number of components slots required to hold this type
 249     *
 250     * This is used to determine how many uniform or varying locations a type
 251     * might occupy.
 252     */
 253    unsigned component_slots() const;
 254
 255    /**
 256     * Calculate the number of attribute slots required to hold this type
 257     *
 258     * This implements the language rules of GLSL 1.50 for counting the number
 259     * of slots used by a vertex attribute.  It also determines the number of
 260     * varying slots the type will use up in the absence of varying packing
 261     * (and thus, it can be used to measure the number of varying slots used by
 262     * the varyings that are generated by lower_packed_varyings).
 263     */
 264    unsigned count_attribute_slots() const;
 265
 266
 267    /**
 268     * Alignment in bytes of the start of this type in a std140 uniform
 269     * block.
 270     */
 271    unsigned std140_base_alignment(bool row_major) const;
 272
 273    /** Size in bytes of this type in a std140 uniform block.
 274     *
 275     * Note that this is not GL_UNIFORM_SIZE (which is the number of
 276     * elements in the array)
 277     */
 278    unsigned std140_size(bool row_major) const;
 279
 280    /**
 281     * \brief Can this type be implicitly converted to another?
 282     *
 283     * \return True if the types are identical or if this type can be converted
 284     *         to \c desired according to Section 4.1.10 of the GLSL spec.
 285     *
 286     * \verbatim
 287     * From page 25 (31 of the pdf) of the GLSL 1.50 spec, Section 4.1.10
 288     * Implicit Conversions:
 289     *
 290     *     In some situations, an expression and its type will be implicitly
 291     *     converted to a different type. The following table shows all allowed
 292     *     implicit conversions:
 293     *
 294     *     Type of expression | Can be implicitly converted to
 295     *     --------------------------------------------------
 296     *     int                  float
 297     *     uint
 298     *
 299     *     ivec2                vec2
 300     *     uvec2
 301     *
 302     *     ivec3                vec3
 303     *     uvec3
 304     *
 305     *     ivec4                vec4
 306     *     uvec4
 307     *
 308     *     There are no implicit array or structure conversions. For example,
 309     *     an array of int cannot be implicitly converted to an array of float.
 310     *     There are no implicit conversions between signed and unsigned
 311     *     integers.
 312     * \endverbatim
 313     */
 314    bool can_implicitly_convert_to(const glsl_type *desired) const;
 315
 316    /**
 317     * Query whether or not a type is a scalar (non-vector and non-matrix).
 318     */
 319    bool is_scalar() const
 320    {
 321       return (vector_elements == 1)
 322          && (base_type >= GLSL_TYPE_UINT)
 323          && (base_type <= GLSL_TYPE_BOOL);
 324    }
 325
 326    /**
 327     * Query whether or not a type is a vector
 328     */
 329    bool is_vector() const
 330    {
 331       return (vector_elements > 1)
 332          && (matrix_columns == 1)
 333          && (base_type >= GLSL_TYPE_UINT)
 334          && (base_type <= GLSL_TYPE_BOOL);
 335    }
 336
 337    /**
 338     * Query whether or not a type is a matrix
 339     */
 340    bool is_matrix() const
 341    {
 342       /* GLSL only has float matrices. */
 343       return (matrix_columns > 1) && (base_type == GLSL_TYPE_FLOAT);
 344    }
 345
 346    /**
 347     * Query whether or not a type is a non-array numeric type
 348     */
 349    bool is_numeric() const
 350    {
 351       return (base_type >= GLSL_TYPE_UINT) && (base_type <= GLSL_TYPE_FLOAT);
 352    }
 353
 354    /**
 355     * Query whether or not a type is an integral type
 356     */
 357    bool is_integer() const
 358    {
 359       return (base_type == GLSL_TYPE_UINT) || (base_type == GLSL_TYPE_INT);
 360    }
 361
 362    /**
 363     * Query whether or not type is an integral type, or for struct and array
 364     * types, contains an integral type.
 365     */
 366    bool contains_integer() const;
 367
 368    /**
 369     * Query whether or not a type is a float type
 370     */
 371    bool is_float() const
 372    {
 373       return base_type == GLSL_TYPE_FLOAT;
 374    }
 375
 376    /**
 377     * Query whether or not a type is a non-array boolean type
 378     */
 379    bool is_boolean() const
 380    {
 381       return base_type == GLSL_TYPE_BOOL;
 382    }
 383
 384    /**
 385     * Query whether or not a type is a sampler
 386     */
 387    bool is_sampler() const
 388    {
 389       return base_type == GLSL_TYPE_SAMPLER;
 390    }
 391
 392    /**
 393     * Query whether or not type is a sampler, or for struct and array
 394     * types, contains a sampler.
 395     */
 396    bool contains_sampler() const;
 397
 398    /**
 399     * Get the Mesa texture target index for a sampler type.
 400     */
 401    gl_texture_index sampler_index() const;
 402
 403    /**
 404     * Query whether or not a type is an array
 405     */
 406    bool is_array() const
 407    {
 408       return base_type == GLSL_TYPE_ARRAY;
 409    }
 410
 411    /**
 412     * Query whether or not a type is a record
 413     */
 414    bool is_record() const
 415    {
 416       return base_type == GLSL_TYPE_STRUCT;
 417    }
 418
 419    /**
 420     * Query whether or not a type is an interface
 421     */
 422    bool is_interface() const
 423    {
 424       return base_type == GLSL_TYPE_INTERFACE;
 425    }
 426
 427    /**
 428     * Query whether or not a type is the void type singleton.
 429     */
 430    bool is_void() const
 431    {
 432       return base_type == GLSL_TYPE_VOID;
 433    }
 434
 435    /**
 436     * Query whether or not a type is the error type singleton.
 437     */
 438    bool is_error() const
 439    {
 440       return base_type == GLSL_TYPE_ERROR;
 441    }
 442
 443    /**
 444     * Query the full type of a matrix row
 445     *
 446     * \return
 447     * If the type is not a matrix, \c glsl_type::error_type is returned.
 448     * Otherwise a type matching the rows of the matrix is returned.
 449     */
 450    const glsl_type *row_type() const
 451    {
 452       return is_matrix()
 453          ? get_instance(base_type, matrix_columns, 1)
 454          : error_type;
 455    }
 456
 457    /**
 458     * Query the full type of a matrix column
 459     *
 460     * \return
 461     * If the type is not a matrix, \c glsl_type::error_type is returned.
 462     * Otherwise a type matching the columns of the matrix is returned.
 463     */
 464    const glsl_type *column_type() const
 465    {
 466       return is_matrix()
 467          ? get_instance(base_type, vector_elements, 1)
 468          : error_type;
 469    }
 470
 471
 472    /**
 473     * Get the type of a structure field
 474     *
 475     * \return
 476     * Pointer to the type of the named field.  If the type is not a structure
 477     * or the named field does not exist, \c glsl_type::error_type is returned.
 478     */
 479    const glsl_type *field_type(const char *name) const;
 480
 481
 482    /**
 483     * Get the location of a filed within a record type
 484     */
 485    int field_index(const char *name) const;
 486
 487
 488    /**
 489     * Query the number of elements in an array type
 490     *
 491     * \return
 492     * The number of elements in the array for array types or -1 for non-array
 493     * types.  If the number of elements in the array has not yet been declared,
 494     * zero is returned.
 495     */
 496    int array_size() const
 497    {
 498       return is_array() ? length : -1;
 499    }
 500
 501    /**
 502     * Return the number of coordinate components needed for this sampler type.
 503     *
 504     * This is based purely on the sampler's dimensionality.  For example, this
 505     * returns 1 for sampler1D, and 3 for sampler2DArray.
 506     *
 507     * Note that this is often different than actual coordinate type used in
 508     * a texturing built-in function, since those pack additional values (such
 509     * as the shadow comparitor or projector) into the coordinate type.
 510     */
 511    int sampler_coordinate_components() const;
 512
 513 private:
 514    /**
 515     * ralloc context for all glsl_type allocations
 516     *
 517     * Set on the first call to \c glsl_type::new.
 518     */
 519    static void *mem_ctx;
 520
 521    void init_ralloc_type_ctx(void);
 522
 523    /** Constructor for vector and matrix types */
 524    glsl_type(GLenum gl_type,
 525              glsl_base_type base_type, unsigned vector_elements,
 526              unsigned matrix_columns, const char *name);
 527
 528    /** Constructor for sampler types */
 529    glsl_type(GLenum gl_type,
 530              enum glsl_sampler_dim dim, bool shadow, bool array,
 531              unsigned type, const char *name);
 532
 533    /** Constructor for record types */
 534    glsl_type(const glsl_struct_field *fields, unsigned num_fields,
 535              const char *name);
 536
 537    /** Constructor for interface types */
 538    glsl_type(const glsl_struct_field *fields, unsigned num_fields,
 539              enum glsl_interface_packing packing, const char *name);
 540
 541    /** Constructor for array types */
 542    glsl_type(const glsl_type *array, unsigned length);
 543
 544    /** Hash table containing the known array types. */
 545    static struct hash_table *array_types;
 546
 547    /** Hash table containing the known record types. */
 548    static struct hash_table *record_types;
 549
 550    /** Hash table containing the known interface types. */
 551    static struct hash_table *interface_types;
 552
 553    static int record_key_compare(const void *a, const void *b);
 554    static unsigned record_key_hash(const void *key);
 555
 556    /**
 557     * \name Built-in type flyweights
 558     */
 559    /*@{*/
 560 #undef  DECL_TYPE
 561 #define DECL_TYPE(NAME, ...) static const glsl_type _##NAME##_type;
 562 #undef  STRUCT_TYPE
 563 #define STRUCT_TYPE(NAME)        static const glsl_type _struct_##NAME##_type;
 564 #include "builtin_type_macros.h"
 565    /*@}*/
 566
 567    /**
 568     * \name Friend functions.
 569     *
 570     * These functions are friends because they must have C linkage and the
 571     * need to call various private methods or access various private static
 572     * data.
 573     */
 574    /*@{*/
 575    friend void _mesa_glsl_initialize_types(struct _mesa_glsl_parse_state *);
 576    friend void _mesa_glsl_release_types(void);
 577    /*@}*/
 578 };
 579
 580 struct glsl_struct_field {
 581    const struct glsl_type *type;
 582    const char *name;
 583    bool row_major;
 584
 585    /**
 586     * For interface blocks, gl_varying_slot corresponding to the input/output
 587     * if this is a built-in input/output (i.e. a member of the built-in
 588     * gl_PerVertex interface block); -1 otherwise.
 589     *
 590     * Ignored for structs.
 591     */
 592    int location;
 593 };
 594
 595 static inline unsigned int
 596 glsl_align(unsigned int a, unsigned int align)
 597 {
 598    return (a + align - 1) / align * align;
 599 }
 600
 601 #undef DECL_TYPE
 602 #undef STRUCT_TYPE
 603 #endif /* __cplusplus */
 604
 605 #endif /* GLSL_TYPES_H */