src/mesa/shader/slang/slang_storage.h

   1 /*
   2  * Mesa 3-D graphics library
   3  * Version:  6.5
   4  *
   5  * Copyright (C) 2005-2006  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 #ifndef SLANG_STORAGE_H
  26 #define SLANG_STORAGE_H
  27
  28 #include "slang_compile.h"
  29 #include "slang_typeinfo.h"
  30
  31
  32 /*
  33  * Program variable data storage is kept completely transparent to the
  34  * front-end compiler. It is up to the back-end how the data is
  35  * actually allocated. The slang_storage_type enum provides the basic
  36  * information about how the memory is interpreted. This abstract
  37  * piece of memory is called a data slot. A data slot of a particular
  38  * type has a fixed size.
  39  *
  40  * For now, only the three basic types are supported, that is bool,
  41  * int and float. Other built-in types like vector or matrix can
  42  * easily be decomposed into a series of basic types.
  43  *
  44  * If the vec4 module is enabled, 4-component vectors of floats are
  45  * used when possible. 4x4 matrices are constructed of 4 vec4 slots.
  46  */
  47 typedef enum slang_storage_type_
  48 {
  49    /* core */
  50    SLANG_STORE_AGGREGATE,
  51    SLANG_STORE_BOOL,
  52    SLANG_STORE_INT,
  53    SLANG_STORE_FLOAT,
  54    /* vec4 */
  55    SLANG_STORE_VEC4
  56 } slang_storage_type;
  57
  58
  59 /**
  60  * The slang_storage_array structure groups data slots of the same
  61  * type into an array. This array has a fixed length. Arrays are
  62  * required to have a size equal to the sum of sizes of its
  63  * elements. They are also required to support indirect
  64  * addressing. That is, if B references first data slot in the array,
  65  * S is the size of the data slot and I is the integral index that is
  66  * not known at compile time, B+I*S references I-th data slot.
  67  *
  68  * This structure is also used to break down built-in data types that
  69  * are not supported directly.  Vectors, like vec3, are constructed
  70  * from arrays of their basic types. Matrices are formed of an array
  71  * of column vectors, which are in turn processed as other vectors.
  72  */
  73 typedef struct slang_storage_array_
  74 {
  75    slang_storage_type type;
  76    struct slang_storage_aggregate_ *aggregate;
  77    GLuint length;
  78 } slang_storage_array;
  79
  80 GLboolean slang_storage_array_construct (slang_storage_array *);
  81 GLvoid slang_storage_array_destruct (slang_storage_array *);
  82
  83
  84 /**
  85  * The slang_storage_aggregate structure relaxes the indirect
  86  * addressing requirement for slang_storage_array
  87  * structure. Aggregates are always accessed statically - its member
  88  * addresses are well-known at compile time. For example, user-defined
  89  * types are implemented as aggregates. Aggregates can collect data of
  90  * a different type.
  91  */
  92 typedef struct slang_storage_aggregate_
  93 {
  94    slang_storage_array *arrays;
  95    GLuint count;
  96 } slang_storage_aggregate;
  97
  98 GLboolean slang_storage_aggregate_construct (slang_storage_aggregate *);
  99 GLvoid slang_storage_aggregate_destruct (slang_storage_aggregate *);
 100
 101
 102 extern GLboolean
 103 _slang_aggregate_variable(slang_storage_aggregate *agg,
 104                           slang_type_specifier *spec,
 105                           GLuint array_len,
 106                           slang_function_scope *funcs,
 107                           slang_struct_scope *structs,
 108                           slang_variable_scope *vars,
 109                           slang_atom_pool *atoms);
 110
 111 /*
 112  * Returns the size (in machine units) of the given storage type.
 113  * It is an error to pass-in SLANG_STORE_AGGREGATE.
 114  * Returns 0 on error.
 115  */
 116 extern GLuint
 117 _slang_sizeof_type (slang_storage_type);
 118
 119
 120 /**
 121  * Returns total size (in machine units) of the given aggregate.
 122  * Returns 0 on error.
 123  */
 124 extern GLuint
 125 _slang_sizeof_aggregate (const slang_storage_aggregate *);
 126
 127
 128 #if 0
 129 /**
 130  * Converts structured aggregate to a flat one, with arrays of generic
 131  * type being one-element long.  Returns GL_TRUE on success.  Returns
 132  * GL_FALSE otherwise.
 133  */
 134 extern GLboolean
 135 _slang_flatten_aggregate (slang_storage_aggregate *,
 136                           const slang_storage_aggregate *);
 137
 138 #endif
 139
 140 #endif /* SLANG_STORAGE_H */