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 * Authors:
24 * Jason Ekstrand (jason@jlekstrand.net)
25 */
26
27 #include "nir.h"
28
29 /*
30 * Handles management of the metadata.
31 */
32
33 void
nir_metadata_require(nir_function_impl * impl,nir_metadata required,...)34 nir_metadata_require(nir_function_impl *impl, nir_metadata required, ...)
35 {
36 #define NEEDS_UPDATE(X) ((required & ~impl->valid_metadata) & (X))
37
38 if (NEEDS_UPDATE(nir_metadata_block_index))
39 nir_index_blocks(impl);
40 if (NEEDS_UPDATE(nir_metadata_instr_index))
41 nir_index_instrs(impl);
42 if (NEEDS_UPDATE(nir_metadata_dominance))
43 nir_calc_dominance_impl(impl);
44 if (NEEDS_UPDATE(nir_metadata_live_ssa_defs))
45 nir_live_ssa_defs_impl(impl);
46 if (NEEDS_UPDATE(nir_metadata_loop_analysis)) {
47 va_list ap;
48 va_start(ap, required);
49 nir_loop_analyze_impl(impl, va_arg(ap, nir_variable_mode));
50 va_end(ap);
51 }
52
53 #undef NEEDS_UPDATE
54
55 impl->valid_metadata |= required;
56 }
57
58 void
nir_metadata_preserve(nir_function_impl * impl,nir_metadata preserved)59 nir_metadata_preserve(nir_function_impl *impl, nir_metadata preserved)
60 {
61 impl->valid_metadata &= preserved;
62 }
63
64 void
nir_shader_preserve_all_metadata(nir_shader * shader)65 nir_shader_preserve_all_metadata(nir_shader *shader)
66 {
67 nir_foreach_function(function, shader) {
68 if (function->impl)
69 nir_metadata_preserve(function->impl, nir_metadata_all);
70 }
71 }
72
73 #ifndef NDEBUG
74 /**
75 * Make sure passes properly invalidate metadata (part 1).
76 *
77 * Call this before running a pass to set a bogus metadata flag, which will
78 * only be preserved if the pass forgets to call nir_metadata_preserve().
79 */
80 void
nir_metadata_set_validation_flag(nir_shader * shader)81 nir_metadata_set_validation_flag(nir_shader *shader)
82 {
83 nir_foreach_function(function, shader) {
84 if (function->impl) {
85 function->impl->valid_metadata |= nir_metadata_not_properly_reset;
86 }
87 }
88 }
89
90 /**
91 * Make sure passes properly invalidate metadata (part 2).
92 *
93 * Call this after a pass makes progress to verify that the bogus metadata set by
94 * the earlier function was properly thrown away. Note that passes may not call
95 * nir_metadata_preserve() if they don't actually make any changes at all.
96 */
97 void
nir_metadata_check_validation_flag(nir_shader * shader)98 nir_metadata_check_validation_flag(nir_shader *shader)
99 {
100 nir_foreach_function(function, shader) {
101 if (function->impl) {
102 assert(!(function->impl->valid_metadata &
103 nir_metadata_not_properly_reset));
104 }
105 }
106 }
107 #endif
108