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     * This may be \c NULL for anonymous structures, for arrays, or for
 136     * function types.
 137     */
 138    const char *name;
 139
 140    /**
 141     * For \c GLSL_TYPE_ARRAY, this is the length of the array.  For
 142     * \c GLSL_TYPE_STRUCT or \c GLSL_TYPE_INTERFACE, it is the number of
 143     * elements in the structure and the number of values pointed to by
 144     * \c fields.structure (below).
 145     */
 146    unsigned length;
 147
 148    /**
 149     * Subtype of composite data types.
 150     */
 151    union {
 152       const struct glsl_type *array;            /**< Type of array elements. */
 153       const struct glsl_type *parameters;       /**< Parameters to function. */
 154       struct glsl_struct_field *structure;      /**< List of struct fields. */
 155    } fields;
 156
 157
 158    /**
 159     * \name Pointers to various public type singletons
 160     */
 161    /*@{*/
 162    static const glsl_type *const error_type;
 163    static const glsl_type *const void_type;
 164    static const glsl_type *const int_type;
 165    static const glsl_type *const ivec2_type;
 166    static const glsl_type *const ivec3_type;
 167    static const glsl_type *const ivec4_type;
 168    static const glsl_type *const uint_type;
 169    static const glsl_type *const uvec2_type;
 170    static const glsl_type *const uvec3_type;
 171    static const glsl_type *const uvec4_type;
 172    static const glsl_type *const float_type;
 173    static const glsl_type *const vec2_type;
 174    static const glsl_type *const vec3_type;
 175    static const glsl_type *const vec4_type;
 176    static const glsl_type *const bool_type;
 177    static const glsl_type *const bvec2_type;
 178    static const glsl_type *const bvec3_type;
 179    static const glsl_type *const bvec4_type;
 180    static const glsl_type *const mat2_type;
 181    static const glsl_type *const mat2x3_type;
 182    static const glsl_type *const mat2x4_type;
 183    static const glsl_type *const mat3x2_type;
 184    static const glsl_type *const mat3_type;
 185    static const glsl_type *const mat3x4_type;
 186    static const glsl_type *const mat4x2_type;
 187    static const glsl_type *const mat4x3_type;
 188    static const glsl_type *const mat4_type;
 189    /*@}*/
 190
 191
 192    /**
 193     * For numeric and boolean derrived types returns the basic scalar type
 194     *
 195     * If the type is a numeric or boolean scalar, vector, or matrix type,
 196     * this function gets the scalar type of the individual components.  For
 197     * all other types, including arrays of numeric or boolean types, the
 198     * error type is returned.
 199     */
 200    const glsl_type *get_base_type() const;
 201
 202    /**
 203     * Get the basic scalar type which this type aggregates.
 204     *
 205     * If the type is a numeric or boolean scalar, vector, or matrix, or an
 206     * array of any of those, this function gets the scalar type of the
 207     * individual components.  For structs and arrays of structs, this function
 208     * returns the struct type.  For samplers and arrays of samplers, this
 209     * function returns the sampler type.
 210     */
 211    const glsl_type *get_scalar_type() const;
 212
 213    /**
 214     * Query the type of elements in an array
 215     *
 216     * \return
 217     * Pointer to the type of elements in the array for array types, or \c NULL
 218     * for non-array types.
 219     */
 220    const glsl_type *element_type() const
 221    {
 222       return is_array() ? fields.array : NULL;
 223    }
 224
 225    /**
 226     * Get the instance of a built-in scalar, vector, or matrix type
 227     */
 228    static const glsl_type *get_instance(unsigned base_type, unsigned rows,
 229                                         unsigned columns);
 230
 231    /**
 232     * Get the instance of an array type
 233     */
 234    static const glsl_type *get_array_instance(const glsl_type *base,
 235                                               unsigned elements);
 236
 237    /**
 238     * Get the instance of a record type
 239     */
 240    static const glsl_type *get_record_instance(const glsl_struct_field *fields,
 241                                                unsigned num_fields,
 242                                                const char *name);
 243
 244    /**
 245     * Get the instance of an interface block type
 246     */
 247    static const glsl_type *get_interface_instance(const glsl_struct_field *fields,
 248                                                   unsigned num_fields,
 249                                                   enum glsl_interface_packing packing,
 250                                                   const char *name);
 251
 252    /**
 253     * Query the total number of scalars that make up a scalar, vector or matrix
 254     */
 255    unsigned components() const
 256    {
 257       return vector_elements * matrix_columns;
 258    }
 259
 260    /**
 261     * Calculate the number of components slots required to hold this type
 262     *
 263     * This is used to determine how many uniform or varying locations a type
 264     * might occupy.
 265     */
 266    unsigned component_slots() const;
 267
 268    /**
 269     * Alignment in bytes of the start of this type in a std140 uniform
 270     * block.
 271     */
 272    unsigned std140_base_alignment(bool row_major) const;
 273
 274    /** Size in bytes of this type in a std140 uniform block.
 275     *
 276     * Note that this is not GL_UNIFORM_SIZE (which is the number of
 277     * elements in the array)
 278     */
 279    unsigned std140_size(bool row_major) const;
 280
 281    /**
 282     * \brief Can this type be implicitly converted to another?
 283     *
 284     * \return True if the types are identical or if this type can be converted
 285     *         to \c desired according to Section 4.1.10 of the GLSL spec.
 286     *
 287     * \verbatim
 288     * From page 25 (31 of the pdf) of the GLSL 1.50 spec, Section 4.1.10
 289     * Implicit Conversions:
 290     *
 291     *     In some situations, an expression and its type will be implicitly
 292     *     converted to a different type. The following table shows all allowed
 293     *     implicit conversions:
 294     *
 295     *     Type of expression | Can be implicitly converted to
 296     *     --------------------------------------------------
 297     *     int                  float
 298     *     uint
 299     *
 300     *     ivec2                vec2
 301     *     uvec2
 302     *
 303     *     ivec3                vec3
 304     *     uvec3
 305     *
 306     *     ivec4                vec4
 307     *     uvec4
 308     *
 309     *     There are no implicit array or structure conversions. For example,
 310     *     an array of int cannot be implicitly converted to an array of float.
 311     *     There are no implicit conversions between signed and unsigned
 312     *     integers.
 313     * \endverbatim
 314     */
 315    bool can_implicitly_convert_to(const glsl_type *desired) const;
 316
 317    /**
 318     * Query whether or not a type is a scalar (non-vector and non-matrix).
 319     */
 320    bool is_scalar() const
 321    {
 322       return (vector_elements == 1)
 323          && (base_type >= GLSL_TYPE_UINT)
 324          && (base_type <= GLSL_TYPE_BOOL);
 325    }
 326
 327    /**
 328     * Query whether or not a type is a vector
 329     */
 330    bool is_vector() const
 331    {
 332       return (vector_elements > 1)
 333          && (matrix_columns == 1)
 334          && (base_type >= GLSL_TYPE_UINT)
 335          && (base_type <= GLSL_TYPE_BOOL);
 336    }
 337
 338    /**
 339     * Query whether or not a type is a matrix
 340     */
 341    bool is_matrix() const
 342    {
 343       /* GLSL only has float matrices. */
 344       return (matrix_columns > 1) && (base_type == GLSL_TYPE_FLOAT);
 345    }
 346
 347    /**
 348     * Query whether or not a type is a non-array numeric type
 349     */
 350    bool is_numeric() const
 351    {
 352       return (base_type >= GLSL_TYPE_UINT) && (base_type <= GLSL_TYPE_FLOAT);
 353    }
 354
 355    /**
 356     * Query whether or not a type is an integral type
 357     */
 358    bool is_integer() const
 359    {
 360       return (base_type == GLSL_TYPE_UINT) || (base_type == GLSL_TYPE_INT);
 361    }
 362
 363    /**
 364     * Query whether or not type is an integral type, or for struct and array
 365     * types, contains an integral type.
 366     */
 367    bool contains_integer() const;
 368
 369    /**
 370     * Query whether or not a type is a float type
 371     */
 372    bool is_float() const
 373    {
 374       return base_type == GLSL_TYPE_FLOAT;
 375    }
 376
 377    /**
 378     * Query whether or not a type is a non-array boolean type
 379     */
 380    bool is_boolean() const
 381    {
 382       return base_type == GLSL_TYPE_BOOL;
 383    }
 384
 385    /**
 386     * Query whether or not a type is a sampler
 387     */
 388    bool is_sampler() const
 389    {
 390       return base_type == GLSL_TYPE_SAMPLER;
 391    }
 392
 393    /**
 394     * Query whether or not type is a sampler, or for struct and array
 395     * types, contains a sampler.
 396     */
 397    bool contains_sampler() const;
 398
 399    /**
 400     * Get the Mesa texture target index for a sampler type.
 401     */
 402    gl_texture_index sampler_index() const;
 403
 404    /**
 405     * Query whether or not a type is an array
 406     */
 407    bool is_array() const
 408    {
 409       return base_type == GLSL_TYPE_ARRAY;
 410    }
 411
 412    /**
 413     * Query whether or not a type is a record
 414     */
 415    bool is_record() const
 416    {
 417       return base_type == GLSL_TYPE_STRUCT;
 418    }
 419
 420    /**
 421     * Query whether or not a type is an interface
 422     */
 423    bool is_interface() const
 424    {
 425       return base_type == GLSL_TYPE_INTERFACE;
 426    }
 427
 428    /**
 429     * Query whether or not a type is the void type singleton.
 430     */
 431    bool is_void() const
 432    {
 433       return base_type == GLSL_TYPE_VOID;
 434    }
 435
 436    /**
 437     * Query whether or not a type is the error type singleton.
 438     */
 439    bool is_error() const
 440    {
 441       return base_type == GLSL_TYPE_ERROR;
 442    }
 443
 444    /**
 445     * Query the full type of a matrix row
 446     *
 447     * \return
 448     * If the type is not a matrix, \c glsl_type::error_type is returned.
 449     * Otherwise a type matching the rows of the matrix is returned.
 450     */
 451    const glsl_type *row_type() const
 452    {
 453       return is_matrix()
 454          ? get_instance(base_type, matrix_columns, 1)
 455          : error_type;
 456    }
 457
 458    /**
 459     * Query the full type of a matrix column
 460     *
 461     * \return
 462     * If the type is not a matrix, \c glsl_type::error_type is returned.
 463     * Otherwise a type matching the columns of the matrix is returned.
 464     */
 465    const glsl_type *column_type() const
 466    {
 467       return is_matrix()
 468          ? get_instance(base_type, vector_elements, 1)
 469          : error_type;
 470    }
 471
 472
 473    /**
 474     * Get the type of a structure field
 475     *
 476     * \return
 477     * Pointer to the type of the named field.  If the type is not a structure
 478     * or the named field does not exist, \c glsl_type::error_type is returned.
 479     */
 480    const glsl_type *field_type(const char *name) const;
 481
 482
 483    /**
 484     * Get the location of a filed within a record type
 485     */
 486    int field_index(const char *name) const;
 487
 488
 489    /**
 490     * Query the number of elements in an array type
 491     *
 492     * \return
 493     * The number of elements in the array for array types or -1 for non-array
 494     * types.  If the number of elements in the array has not yet been declared,
 495     * zero is returned.
 496     */
 497    int array_size() const
 498    {
 499       return is_array() ? length : -1;
 500    }
 501
 502 private:
 503    /**
 504     * ralloc context for all glsl_type allocations
 505     *
 506     * Set on the first call to \c glsl_type::new.
 507     */
 508    static void *mem_ctx;
 509
 510    void init_ralloc_type_ctx(void);
 511
 512    /** Constructor for vector and matrix types */
 513    glsl_type(GLenum gl_type,
 514              glsl_base_type base_type, unsigned vector_elements,
 515              unsigned matrix_columns, const char *name);
 516
 517    /** Constructor for sampler types */
 518    glsl_type(GLenum gl_type,
 519              enum glsl_sampler_dim dim, bool shadow, bool array,
 520              unsigned type, const char *name);
 521
 522    /** Constructor for record types */
 523    glsl_type(const glsl_struct_field *fields, unsigned num_fields,
 524              const char *name);
 525
 526    /** Constructor for interface types */
 527    glsl_type(const glsl_struct_field *fields, unsigned num_fields,
 528              enum glsl_interface_packing packing, const char *name);
 529
 530    /** Constructor for array types */
 531    glsl_type(const glsl_type *array, unsigned length);
 532
 533    /** Hash table containing the known array types. */
 534    static struct hash_table *array_types;
 535
 536    /** Hash table containing the known record types. */
 537    static struct hash_table *record_types;
 538
 539    /** Hash table containing the known interface types. */
 540    static struct hash_table *interface_types;
 541
 542    static int record_key_compare(const void *a, const void *b);
 543    static unsigned record_key_hash(const void *key);
 544
 545    /**
 546     * \name Pointers to various type singletons
 547     */
 548    /*@{*/
 549    static const glsl_type _error_type;
 550    static const glsl_type _void_type;
 551    static const glsl_type _sampler3D_type;
 552    static const glsl_type _samplerCubeShadow_type;
 553    static const glsl_type builtin_core_types[];
 554    static const glsl_type builtin_structure_types[];
 555    static const glsl_type builtin_110_deprecated_structure_types[];
 556    static const glsl_type builtin_110_types[];
 557    static const glsl_type builtin_120_types[];
 558    static const glsl_type builtin_130_types[];
 559    static const glsl_type builtin_140_types[];
 560    static const glsl_type builtin_ARB_texture_rectangle_types[];
 561    static const glsl_type builtin_EXT_texture_array_types[];
 562    static const glsl_type builtin_EXT_texture_buffer_object_types[];
 563    static const glsl_type builtin_OES_EGL_image_external_types[];
 564    static const glsl_type builtin_ARB_texture_cube_map_array_types[];
 565    static const glsl_type builtin_ARB_texture_multisample_types[];
 566    /*@}*/
 567
 568    /**
 569     * \name Methods to populate a symbol table with built-in types.
 570     *
 571     * \internal
 572     * This is one of the truely annoying things about C++.  Methods that are
 573     * completely internal and private to a type still have to be advertised to
 574     * the world in a public header file.
 575     */
 576    /*@{*/
 577    static void generate_100ES_types(glsl_symbol_table *);
 578    static void generate_300ES_types(glsl_symbol_table *);
 579    static void generate_110_types(glsl_symbol_table *, bool add_deprecated,
 580                                   bool skip_1d);
 581    static void generate_120_types(glsl_symbol_table *, bool add_deprecated,
 582                                   bool skip_1d);
 583    static void generate_130_types(glsl_symbol_table *, bool add_deprecated,
 584                                   bool skip_1d);
 585    static void generate_140_types(glsl_symbol_table *);
 586    static void generate_150_types(glsl_symbol_table *);
 587    static void generate_ARB_texture_rectangle_types(glsl_symbol_table *, bool);
 588    static void generate_EXT_texture_array_types(glsl_symbol_table *, bool);
 589    static void generate_OES_texture_3D_types(glsl_symbol_table *, bool);
 590    static void generate_OES_EGL_image_external_types(glsl_symbol_table *, bool);
 591    static void generate_ARB_texture_cube_map_array_types(glsl_symbol_table *, bool);
 592    static void generate_ARB_texture_multisample_types(glsl_symbol_table *, bool);
 593    /*@}*/
 594
 595    /**
 596     * \name Friend functions.
 597     *
 598     * These functions are friends because they must have C linkage and the
 599     * need to call various private methods or access various private static
 600     * data.
 601     */
 602    /*@{*/
 603    friend void _mesa_glsl_initialize_types(struct _mesa_glsl_parse_state *);
 604    friend void _mesa_glsl_release_types(void);
 605    /*@}*/
 606 };
 607
 608 struct glsl_struct_field {
 609    const struct glsl_type *type;
 610    const char *name;
 611    bool row_major;
 612 };
 613
 614 static inline unsigned int
 615 glsl_align(unsigned int a, unsigned int align)
 616 {
 617    return (a + align - 1) / align * align;
 618 }
 619
 620 #endif /* __cplusplus */
 621
 622 #endif /* GLSL_TYPES_H */