src/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_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
  39 extern void
  40 link_set_uniform_initializers(struct gl_shader_program *prog);
  41
  42 extern int
  43 link_cross_validate_uniform_block(void *mem_ctx,
  44                                   struct gl_uniform_block **linked_blocks,
  45                                   unsigned int *num_linked_blocks,
  46                                   struct gl_uniform_block *new_block);
  47
  48 void
  49 link_assign_uniform_block_offsets(struct gl_shader *shader);
  50
  51 extern bool
  52 link_uniform_blocks_are_compatible(const gl_uniform_block *a,
  53                                    const gl_uniform_block *b);
  54
  55 extern unsigned
  56 link_uniform_blocks(void *mem_ctx,
  57                     struct gl_shader_program *prog,
  58                     struct gl_shader **shader_list,
  59                     unsigned num_shaders,
  60                     struct gl_uniform_block **blocks_ret);
  61
  62 void
  63 validate_intrastage_interface_blocks(struct gl_shader_program *prog,
  64                                      const gl_shader **shader_list,
  65                                      unsigned num_shaders);
  66
  67 void
  68 validate_interstage_inout_blocks(struct gl_shader_program *prog,
  69                                  const gl_shader *producer,
  70                                  const gl_shader *consumer);
  71
  72 void
  73 validate_interstage_uniform_blocks(struct gl_shader_program *prog,
  74                                    gl_shader **stages, int num_stages);
  75
  76 extern void
  77 link_assign_atomic_counter_resources(struct gl_context *ctx,
  78                                      struct gl_shader_program *prog);
  79
  80 extern void
  81 link_check_atomic_counter_resources(struct gl_context *ctx,
  82                                     struct gl_shader_program *prog);
  83
  84 /**
  85  * Class for processing all of the leaf fields of a variable that corresponds
  86  * to a program resource.
  87  *
  88  * The leaf fields are all the parts of the variable that the application
  89  * could query using \c glGetProgramResourceIndex (or that could be returned
  90  * by \c glGetProgramResourceName).
  91  *
  92  * Classes my derive from this class to implement specific functionality.
  93  * This class only provides the mechanism to iterate over the leaves.  Derived
  94  * classes must implement \c ::visit_field and may override \c ::process.
  95  */
  96 class program_resource_visitor {
  97 public:
  98    /**
  99     * Begin processing a variable
 100     *
 101     * Classes that overload this function should call \c ::process from the
 102     * base class to start the recursive processing of the variable.
 103     *
 104     * \param var  The variable that is to be processed
 105     *
 106     * Calls \c ::visit_field for each leaf of the variable.
 107     *
 108     * \warning
 109     * When processing a uniform block, this entry should only be used in cases
 110     * where the row / column ordering of matrices in the block does not
 111     * matter.  For example, enumerating the names of members of the block, but
 112     * not for determining the offsets of members.
 113     */
 114    void process(ir_variable *var);
 115
 116    /**
 117     * Begin processing a variable of a structured type.
 118     *
 119     * This flavor of \c process should be used to handle structured types
 120     * (i.e., structures, interfaces, or arrays there of) that need special
 121     * name handling.  A common usage is to handle cases where the block name
 122     * (instead of the instance name) is used for an interface block.
 123     *
 124     * \param type  Type that is to be processed, associated with \c name
 125     * \param name  Base name of the structured variable being processed
 126     *
 127     * \note
 128     * \c type must be \c GLSL_TYPE_RECORD, \c GLSL_TYPE_INTERFACE, or an array
 129     * there of.
 130     */
 131    void process(const glsl_type *type, const char *name);
 132
 133 protected:
 134    /**
 135     * Method invoked for each leaf of the variable
 136     *
 137     * \param type  Type of the field.
 138     * \param name  Fully qualified name of the field.
 139     * \param row_major  For a matrix type, is it stored row-major.
 140     * \param record_type  Type of the record containing the field.
 141     *
 142     * The default implementation just calls the other \c visit_field method.
 143     */
 144    virtual void visit_field(const glsl_type *type, const char *name,
 145                             bool row_major, const glsl_type *record_type);
 146
 147    /**
 148     * Method invoked for each leaf of the variable
 149     *
 150     * \param type  Type of the field.
 151     * \param name  Fully qualified name of the field.
 152     * \param row_major  For a matrix type, is it stored row-major.
 153     */
 154    virtual void visit_field(const glsl_type *type, const char *name,
 155                             bool row_major) = 0;
 156
 157    /**
 158     * Visit a record before visiting its fields
 159     *
 160     * For structures-of-structures or interfaces-of-structures, this visits
 161     * the inner structure before visiting its fields.
 162     *
 163     * The default implementation does nothing.
 164     */
 165    virtual void visit_field(const glsl_struct_field *field);
 166
 167 private:
 168    /**
 169     * \param name_length  Length of the current name \b not including the
 170     *                     terminating \c NUL character.
 171     */
 172    void recursion(const glsl_type *t, char **name, size_t name_length,
 173                   bool row_major, const glsl_type *record_type);
 174 };
 175
 176 void
 177 linker_error(gl_shader_program *prog, const char *fmt, ...);
 178
 179 void
 180 linker_warning(gl_shader_program *prog, const char *fmt, ...);
 181
 182 #endif /* GLSL_LINKER_H */