src/compiler/glsl/linker.h

   1 /* -*- c++ -*- */
   2 /*
   3  * Copyright © 2010 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_LINKER_H
  27 #define GLSL_LINKER_H
  28
  29 extern bool
  30 link_function_calls(gl_shader_program *prog, gl_linked_shader *main,
  31                     gl_shader **shader_list, unsigned num_shaders);
  32
  33 extern void
  34 link_invalidate_variable_locations(exec_list *ir);
  35
  36 extern void
  37 link_assign_uniform_locations(struct gl_shader_program *prog,
  38                               struct gl_context *ctx,
  39                               unsigned int num_explicit_uniform_locs);
  40
  41 extern void
  42 link_set_uniform_initializers(struct gl_shader_program *prog,
  43                               unsigned int boolean_true);
  44
  45 extern int
  46 link_cross_validate_uniform_block(void *mem_ctx,
  47                                   struct gl_uniform_block **linked_blocks,
  48                                   unsigned int *num_linked_blocks,
  49                                   struct gl_uniform_block *new_block);
  50
  51 extern void
  52 link_uniform_blocks(void *mem_ctx,
  53                     struct gl_context *ctx,
  54                     struct gl_shader_program *prog,
  55                     struct gl_linked_shader *shader,
  56                     struct gl_uniform_block **ubo_blocks,
  57                     unsigned *num_ubo_blocks,
  58                     struct gl_uniform_block **ssbo_blocks,
  59                     unsigned *num_ssbo_blocks);
  60
  61 bool
  62 validate_intrastage_arrays(struct gl_shader_program *prog,
  63                            ir_variable *const var,
  64                            ir_variable *const existing);
  65
  66 void
  67 validate_intrastage_interface_blocks(struct gl_shader_program *prog,
  68                                      const gl_shader **shader_list,
  69                                      unsigned num_shaders);
  70
  71 void
  72 validate_interstage_inout_blocks(struct gl_shader_program *prog,
  73                                  const gl_linked_shader *producer,
  74                                  const gl_linked_shader *consumer);
  75
  76 void
  77 validate_interstage_uniform_blocks(struct gl_shader_program *prog,
  78                                    gl_linked_shader **stages);
  79
  80 extern void
  81 link_assign_atomic_counter_resources(struct gl_context *ctx,
  82                                      struct gl_shader_program *prog);
  83
  84 extern void
  85 link_check_atomic_counter_resources(struct gl_context *ctx,
  86                                     struct gl_shader_program *prog);
  87
  88 /**
  89  * Class for processing all of the leaf fields of a variable that corresponds
  90  * to a program resource.
  91  *
  92  * The leaf fields are all the parts of the variable that the application
  93  * could query using \c glGetProgramResourceIndex (or that could be returned
  94  * by \c glGetProgramResourceName).
  95  *
  96  * Classes my derive from this class to implement specific functionality.
  97  * This class only provides the mechanism to iterate over the leaves.  Derived
  98  * classes must implement \c ::visit_field and may override \c ::process.
  99  */
 100 class program_resource_visitor {
 101 public:
 102    /**
 103     * Begin processing a variable
 104     *
 105     * Classes that overload this function should call \c ::process from the
 106     * base class to start the recursive processing of the variable.
 107     *
 108     * \param var  The variable that is to be processed
 109     *
 110     * Calls \c ::visit_field for each leaf of the variable.
 111     *
 112     * \warning
 113     * When processing a uniform block, this entry should only be used in cases
 114     * where the row / column ordering of matrices in the block does not
 115     * matter.  For example, enumerating the names of members of the block, but
 116     * not for determining the offsets of members.
 117     */
 118    void process(ir_variable *var);
 119
 120    /**
 121     * Begin processing a variable of a structured type.
 122     *
 123     * This flavor of \c process should be used to handle structured types
 124     * (i.e., structures, interfaces, or arrays there of) that need special
 125     * name handling.  A common usage is to handle cases where the block name
 126     * (instead of the instance name) is used for an interface block.
 127     *
 128     * \param type  Type that is to be processed, associated with \c name
 129     * \param name  Base name of the structured variable being processed
 130     *
 131     * \note
 132     * \c type must be \c GLSL_TYPE_RECORD, \c GLSL_TYPE_INTERFACE, or an array
 133     * there of.
 134     */
 135    void process(const glsl_type *type, const char *name);
 136
 137 protected:
 138    /**
 139     * Method invoked for each leaf of the variable
 140     *
 141     * \param type  Type of the field.
 142     * \param name  Fully qualified name of the field.
 143     * \param row_major  For a matrix type, is it stored row-major.
 144     * \param record_type  Type of the record containing the field.
 145     * \param last_field   Set if \c name is the last field of the structure
 146     *                     containing it.  This will always be false for items
 147     *                     not contained in a structure or interface block.
 148     *
 149     * The default implementation just calls the other \c visit_field method.
 150     */
 151    virtual void visit_field(const glsl_type *type, const char *name,
 152                             bool row_major, const glsl_type *record_type,
 153                             const enum glsl_interface_packing packing,
 154                             bool last_field);
 155
 156    /**
 157     * Method invoked for each leaf of the variable
 158     *
 159     * \param type  Type of the field.
 160     * \param name  Fully qualified name of the field.
 161     * \param row_major  For a matrix type, is it stored row-major.
 162     */
 163    virtual void visit_field(const glsl_type *type, const char *name,
 164                             bool row_major) = 0;
 165
 166    /**
 167     * Visit a record before visiting its fields
 168     *
 169     * For structures-of-structures or interfaces-of-structures, this visits
 170     * the inner structure before visiting its fields.
 171     *
 172     * The default implementation does nothing.
 173     */
 174    virtual void visit_field(const glsl_struct_field *field);
 175
 176    virtual void enter_record(const glsl_type *type, const char *name,
 177                              bool row_major, const enum glsl_interface_packing packing);
 178
 179    virtual void leave_record(const glsl_type *type, const char *name,
 180                              bool row_major, const enum glsl_interface_packing packing);
 181
 182    virtual void set_buffer_offset(unsigned offset);
 183
 184    virtual void set_record_array_count(unsigned record_array_count);
 185
 186 private:
 187    /**
 188     * \param name_length  Length of the current name \b not including the
 189     *                     terminating \c NUL character.
 190     * \param last_field   Set if \c name is the last field of the structure
 191     *                     containing it.  This will always be false for items
 192     *                     not contained in a structure or interface block.
 193     */
 194    void recursion(const glsl_type *t, char **name, size_t name_length,
 195                   bool row_major, const glsl_type *record_type,
 196                   const enum glsl_interface_packing packing,
 197                   bool last_field, unsigned record_array_count,
 198                   const glsl_struct_field *named_ifc_member);
 199 };
 200
 201 void
 202 linker_error(gl_shader_program *prog, const char *fmt, ...);
 203
 204 void
 205 linker_warning(gl_shader_program *prog, const char *fmt, ...);
 206
 207 /**
 208  * Sometimes there are empty slots left over in UniformRemapTable after we
 209  * allocate slots to explicit locations. This struct represents a single
 210  * continouous block of empty slots in UniformRemapTable.
 211  */
 212 struct empty_uniform_block {
 213    struct exec_node link;
 214    /* The start location of the block */
 215    unsigned start;
 216    /* The number of slots in the block */
 217    unsigned slots;
 218 };
 219
 220 #endif /* GLSL_LINKER_H */