Home | History | Annotate | Download | only in nir
      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 (at) jlekstrand.net)
     25  */
     26 
     27 #include "nir.h"
     28 
     29 /*
     30  * Handles management of the metadata.
     31  */
     32 
     33 void
     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_dominance))
     41       nir_calc_dominance_impl(impl);
     42    if (NEEDS_UPDATE(nir_metadata_live_ssa_defs))
     43       nir_live_ssa_defs_impl(impl);
     44    if (NEEDS_UPDATE(nir_metadata_loop_analysis)) {
     45       va_list ap;
     46       va_start(ap, required);
     47       nir_loop_analyze_impl(impl, va_arg(ap, nir_variable_mode));
     48       va_end(ap);
     49    }
     50 
     51 #undef NEEDS_UPDATE
     52 
     53    impl->valid_metadata |= required;
     54 }
     55 
     56 void
     57 nir_metadata_preserve(nir_function_impl *impl, nir_metadata preserved)
     58 {
     59    impl->valid_metadata &= preserved;
     60 }
     61 
     62 #ifdef DEBUG
     63 /**
     64  * Make sure passes properly invalidate metadata (part 1).
     65  *
     66  * Call this before running a pass to set a bogus metadata flag, which will
     67  * only be preserved if the pass forgets to call nir_metadata_preserve().
     68  */
     69 void
     70 nir_metadata_set_validation_flag(nir_shader *shader)
     71 {
     72    nir_foreach_function(function, shader) {
     73       if (function->impl) {
     74          function->impl->valid_metadata |= nir_metadata_not_properly_reset;
     75       }
     76    }
     77 }
     78 
     79 /**
     80  * Make sure passes properly invalidate metadata (part 2).
     81  *
     82  * Call this after a pass makes progress to verify that the bogus metadata set by
     83  * the earlier function was properly thrown away.  Note that passes may not call
     84  * nir_metadata_preserve() if they don't actually make any changes at all.
     85  */
     86 void
     87 nir_metadata_check_validation_flag(nir_shader *shader)
     88 {
     89    nir_foreach_function(function, shader) {
     90       if (function->impl) {
     91          assert(!(function->impl->valid_metadata &
     92                   nir_metadata_not_properly_reset));
     93       }
     94    }
     95 }
     96 #endif
     97