1 /*
2 * Copyright © 2014 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 DEALINGS
21 * IN THE SOFTWARE.
22 */
23
24 #include "nir.h"
25
26 /*
27 * Handles management of the metadata.
28 */
29
30 void
nir_metadata_require(nir_function_impl * impl,nir_metadata required,...)31 nir_metadata_require(nir_function_impl *impl, nir_metadata required, ...)
32 {
33 #define NEEDS_UPDATE(X) ((required & ~impl->valid_metadata) & (X))
34
35 if (NEEDS_UPDATE(nir_metadata_block_index))
36 nir_index_blocks(impl);
37 if (NEEDS_UPDATE(nir_metadata_instr_index))
38 nir_index_instrs(impl);
39 if (NEEDS_UPDATE(nir_metadata_dominance))
40 nir_calc_dominance_impl(impl);
41 if (NEEDS_UPDATE(nir_metadata_live_defs))
42 nir_live_defs_impl(impl);
43 if (required & nir_metadata_loop_analysis) {
44 va_list ap;
45 va_start(ap, required);
46 /* !! Warning !! Do not move these va_arg() call directly to
47 * nir_loop_analyze_impl() as parameters because the execution order will
48 * become undefined.
49 */
50 nir_variable_mode indirect_mask = va_arg(ap, nir_variable_mode);
51 int force_unroll_sampler_indirect = va_arg(ap, int);
52 va_end(ap);
53
54 if (NEEDS_UPDATE(nir_metadata_loop_analysis) ||
55 indirect_mask != impl->loop_analysis_indirect_mask ||
56 force_unroll_sampler_indirect != impl->loop_analysis_force_unroll_sampler_indirect) {
57 nir_loop_analyze_impl(impl, indirect_mask, force_unroll_sampler_indirect);
58 }
59 }
60
61 #undef NEEDS_UPDATE
62
63 impl->valid_metadata |= required;
64 }
65
66 void
nir_metadata_preserve(nir_function_impl * impl,nir_metadata preserved)67 nir_metadata_preserve(nir_function_impl *impl, nir_metadata preserved)
68 {
69 /* If we discard valid liveness information, immediately free the
70 * liveness information for each block. For large shaders, it can
71 * consume a huge amount of memory, and it's usually not immediately
72 * needed after dirtying.
73 */
74 if ((impl->valid_metadata & ~preserved) & nir_metadata_live_defs) {
75 nir_foreach_block(block, impl) {
76 ralloc_free(block->live_in);
77 ralloc_free(block->live_out);
78 block->live_in = block->live_out = NULL;
79 }
80 }
81
82 impl->valid_metadata &= preserved;
83 }
84
85 void
nir_shader_preserve_all_metadata(nir_shader * shader)86 nir_shader_preserve_all_metadata(nir_shader *shader)
87 {
88 nir_foreach_function_impl(impl, shader) {
89 nir_metadata_preserve(impl, nir_metadata_all);
90 }
91 }
92
93 #ifndef NDEBUG
94 /**
95 * Make sure passes properly invalidate metadata (part 1).
96 *
97 * Call this before running a pass to set a bogus metadata flag, which will
98 * only be preserved if the pass forgets to call nir_metadata_preserve().
99 */
100 void
nir_metadata_set_validation_flag(nir_shader * shader)101 nir_metadata_set_validation_flag(nir_shader *shader)
102 {
103 nir_foreach_function_impl(impl, shader) {
104 impl->valid_metadata |= nir_metadata_not_properly_reset;
105 }
106 }
107
108 /**
109 * Make sure passes properly invalidate metadata (part 2).
110 *
111 * Call this after a pass makes progress to verify that the bogus metadata set by
112 * the earlier function was properly thrown away. Note that passes may not call
113 * nir_metadata_preserve() if they don't actually make any changes at all.
114 */
115 void
nir_metadata_check_validation_flag(nir_shader * shader)116 nir_metadata_check_validation_flag(nir_shader *shader)
117 {
118 nir_foreach_function_impl(impl, shader) {
119 assert(!(impl->valid_metadata & nir_metadata_not_properly_reset));
120 }
121 }
122 #endif
123