1/*
2 * Copyright © 2018 Intel Corporation
3 *
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the "Software"),
6 * to deal in the Software without restriction, including without limitation
7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 * and/or sell copies of the Software, and to permit persons to whom the
9 * Software is furnished to do so, subject to the following conditions:
10 *
11 * The above copyright notice and this permission notice (including the next
12 * paragraph) shall be included in all copies or substantial portions of the
13 * Software.
14 *
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
18 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21 * DEALINGS IN THE SOFTWARE.
22 */
23
24#ifndef GLSL_LINKER_UTIL_H
25#define GLSL_LINKER_UTIL_H
26
27#include "util/bitset.h"
28
29struct gl_context;
30struct gl_shader_program;
31struct gl_uniform_storage;
32
33#ifdef __cplusplus
34extern "C" {
35#endif
36
37/**
38 * Sometimes there are empty slots left over in UniformRemapTable after we
39 * allocate slots to explicit locations. This struct represents a single
40 * continouous block of empty slots in UniformRemapTable.
41 */
42struct empty_uniform_block {
43   struct exec_node link;
44   /* The start location of the block */
45   unsigned start;
46   /* The number of slots in the block */
47   unsigned slots;
48};
49
50/**
51 * Describes an access of an array element or an access of the whole array
52 */
53struct array_deref_range {
54   /**
55    * Index that was accessed.
56    *
57    * All valid array indices are less than the size of the array.  If index
58    * is equal to the size of the array, this means the entire array has been
59    * accessed (e.g., due to use of a non-constant index).
60    */
61   unsigned index;
62
63   /** Size of the array.  Used for offset calculations. */
64   unsigned size;
65};
66
67void
68linker_error(struct gl_shader_program *prog, const char *fmt, ...);
69
70void
71linker_warning(struct gl_shader_program *prog, const char *fmt, ...);
72
73bool
74link_util_should_add_buffer_variable(struct gl_shader_program *prog,
75                                     struct gl_uniform_storage *uniform,
76                                     int top_level_array_base_offset,
77                                     int top_level_array_size_in_bytes,
78                                     int second_element_offset,
79                                     int block_index);
80
81bool
82link_util_add_program_resource(struct gl_shader_program *prog,
83                               struct set *resource_set,
84                               GLenum type, const void *data, uint8_t stages);
85
86int
87link_util_find_empty_block(struct gl_shader_program *prog,
88                           struct gl_uniform_storage *uniform);
89
90void
91link_util_update_empty_uniform_locations(struct gl_shader_program *prog);
92
93void
94link_util_check_subroutine_resources(struct gl_shader_program *prog);
95
96void
97link_util_check_uniform_resources(struct gl_context *ctx,
98                                  struct gl_shader_program *prog);
99
100void
101link_util_calculate_subroutine_compat(struct gl_shader_program *prog);
102
103void
104link_util_mark_array_elements_referenced(const struct array_deref_range *dr,
105                                         unsigned count, unsigned array_depth,
106                                         BITSET_WORD *bits);
107
108#ifdef __cplusplus
109}
110#endif
111
112#endif /* GLSL_LINKER_UTIL_H */
113