2 * Copyright © 2016 Intel Corporation
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:
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
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.
25 * \file ir_array_refcount.h
27 * Provides a visitor which produces a list of variables referenced.
31 #include "ir_visitor.h"
32 #include "compiler/glsl_types.h"
33 #include "util/bitset.h"
36 * Describes an access of an array element or an access of the whole array
38 struct array_deref_range
{
40 * Index that was accessed.
42 * All valid array indices are less than the size of the array. If index
43 * is equal to the size of the array, this means the entire array has been
44 * accessed (e.g., due to use of a non-constant index).
48 /** Size of the array. Used for offset calculations. */
52 class ir_array_refcount_entry
55 ir_array_refcount_entry(ir_variable
*var
);
56 ~ir_array_refcount_entry();
58 ir_variable
*var
; /* The key: the variable's pointer. */
60 /** Has the variable been referenced? */
64 * Mark a set of array elements as accessed.
66 * If every \c array_deref_range is for a single index, only a single
67 * element will be marked. If any \c array_deref_range is for an entire
68 * array-of-, then multiple elements will be marked.
70 * Items in the \c array_deref_range list appear in least- to
71 * most-significant order. This is the \b opposite order the indices
72 * appear in the GLSL shader text. An array access like
78 * { { 3, n }, { m, m }, { 1, p } }
80 * where n, m, and p are the sizes of the arrays-of-arrays.
82 * The set of marked array elements can later be queried by
83 * \c ::is_linearized_index_referenced.
85 * \param dr List of array_deref_range elements to be processed.
86 * \param count Number of array_deref_range elements to be processed.
88 void mark_array_elements_referenced(const array_deref_range
*dr
,
91 /** Has a linearized array index been referenced? */
92 bool is_linearized_index_referenced(unsigned linearized_index
) const
95 assert(linearized_index
<= num_bits
);
97 return BITSET_TEST(bits
, linearized_index
);
101 /** Set of bit-flags to note which array elements have been accessed. */
105 * Total number of bits referenced by \c bits.
107 * Also the total number of array(s-of-arrays) elements of \c var.
111 /** Count of nested arrays in the type. */
112 unsigned array_depth
;
115 * Recursive part of the public mark_array_elements_referenced method.
117 * The recursion occurs when an entire array-of- is accessed. See the
118 * implementation for more details.
120 * \param dr List of array_deref_range elements to be
122 * \param count Number of array_deref_range elements to be
124 * \param scale Current offset scale.
125 * \param linearized_index Current accumulated linearized array index.
127 void mark_array_elements_referenced(const array_deref_range
*dr
,
130 unsigned linearized_index
);
132 friend class array_refcount_test
;
135 class ir_array_refcount_visitor
: public ir_hierarchical_visitor
{
137 ir_array_refcount_visitor(void);
138 ~ir_array_refcount_visitor(void);
140 virtual ir_visitor_status
visit(ir_dereference_variable
*);
142 virtual ir_visitor_status
visit_enter(ir_function_signature
*);
145 * Find variable in the hash table, and insert it if not present
147 ir_array_refcount_entry
*get_variable_entry(ir_variable
*var
);
150 * Hash table mapping ir_variable to ir_array_refcount_entry.
152 struct hash_table
*ht
;
157 /** Get an array_deref_range element from private tracking. */
158 array_deref_range
*get_array_deref();
161 * \name array_deref_range tracking
164 /** Currently allocated block of derefs. */
165 array_deref_range
*derefs
;
167 /** Number of derefs used in current processing. */
170 /** Size of the derefs buffer in bytes. */
171 unsigned derefs_size
;