src/librustc_mir/transform/rustc_peek.rs

   1 use rustc_target::spec::abi::{Abi};
   2 use syntax::ast;
   3 use syntax::symbol::sym;
   4 use syntax_pos::Span;
   5
   6 use rustc::ty::{self, TyCtxt};
   7 use rustc::hir::def_id::DefId;
   8 use rustc::mir::{self, Body, Location};
   9 use rustc_data_structures::bit_set::BitSet;
  10 use crate::transform::{MirPass, MirSource};
  11
  12 use crate::dataflow::{do_dataflow, DebugFormatted};
  13 use crate::dataflow::MoveDataParamEnv;
  14 use crate::dataflow::BitDenotation;
  15 use crate::dataflow::DataflowResults;
  16 use crate::dataflow::{
  17     DefinitelyInitializedPlaces, MaybeInitializedPlaces, MaybeUninitializedPlaces
  18 };
  19 use crate::dataflow::move_paths::{MovePathIndex, LookupResult};
  20 use crate::dataflow::move_paths::{HasMoveData, MoveData};
  21 use crate::dataflow;
  22
  23 use crate::dataflow::has_rustc_mir_with;
  24
  25 pub struct SanityCheck;
  26
  27 impl MirPass for SanityCheck {
  28     fn run_pass<'tcx>(&self, tcx: TyCtxt<'tcx, 'tcx>, src: MirSource<'tcx>, body: &mut Body<'tcx>) {
  29         let def_id = src.def_id();
  30         if !tcx.has_attr(def_id, sym::rustc_mir) {
  31             debug!("skipping rustc_peek::SanityCheck on {}", tcx.def_path_str(def_id));
  32             return;
  33         } else {
  34             debug!("running rustc_peek::SanityCheck on {}", tcx.def_path_str(def_id));
  35         }
  36
  37         let attributes = tcx.get_attrs(def_id);
  38         let param_env = tcx.param_env(def_id);
  39         let move_data = MoveData::gather_moves(body, tcx).unwrap();
  40         let mdpe = MoveDataParamEnv { move_data: move_data, param_env: param_env };
  41         let dead_unwinds = BitSet::new_empty(body.basic_blocks().len());
  42         let flow_inits =
  43             do_dataflow(tcx, body, def_id, &attributes, &dead_unwinds,
  44                         MaybeInitializedPlaces::new(tcx, body, &mdpe),
  45                         |bd, i| DebugFormatted::new(&bd.move_data().move_paths[i]));
  46         let flow_uninits =
  47             do_dataflow(tcx, body, def_id, &attributes, &dead_unwinds,
  48                         MaybeUninitializedPlaces::new(tcx, body, &mdpe),
  49                         |bd, i| DebugFormatted::new(&bd.move_data().move_paths[i]));
  50         let flow_def_inits =
  51             do_dataflow(tcx, body, def_id, &attributes, &dead_unwinds,
  52                         DefinitelyInitializedPlaces::new(tcx, body, &mdpe),
  53                         |bd, i| DebugFormatted::new(&bd.move_data().move_paths[i]));
  54
  55         if has_rustc_mir_with(&attributes, sym::rustc_peek_maybe_init).is_some() {
  56             sanity_check_via_rustc_peek(tcx, body, def_id, &attributes, &flow_inits);
  57         }
  58         if has_rustc_mir_with(&attributes, sym::rustc_peek_maybe_uninit).is_some() {
  59             sanity_check_via_rustc_peek(tcx, body, def_id, &attributes, &flow_uninits);
  60         }
  61         if has_rustc_mir_with(&attributes, sym::rustc_peek_definite_init).is_some() {
  62             sanity_check_via_rustc_peek(tcx, body, def_id, &attributes, &flow_def_inits);
  63         }
  64         if has_rustc_mir_with(&attributes, sym::stop_after_dataflow).is_some() {
  65             tcx.sess.fatal("stop_after_dataflow ended compilation");
  66         }
  67     }
  68 }
  69
  70 /// This function scans `mir` for all calls to the intrinsic
  71 /// `rustc_peek` that have the expression form `rustc_peek(&expr)`.
  72 ///
  73 /// For each such call, determines what the dataflow bit-state is for
  74 /// the L-value corresponding to `expr`; if the bit-state is a 1, then
  75 /// that call to `rustc_peek` is ignored by the sanity check. If the
  76 /// bit-state is a 0, then this pass emits a error message saying
  77 /// "rustc_peek: bit not set".
  78 ///
  79 /// The intention is that one can write unit tests for dataflow by
  80 /// putting code into a compile-fail test and using `rustc_peek` to
  81 /// make observations about the results of dataflow static analyses.
  82 ///
  83 /// (If there are any calls to `rustc_peek` that do not match the
  84 /// expression form above, then that emits an error as well, but those
  85 /// errors are not intended to be used for unit tests.)
  86 pub fn sanity_check_via_rustc_peek<'tcx, O>(
  87     tcx: TyCtxt<'tcx, 'tcx>,
  88     body: &Body<'tcx>,
  89     def_id: DefId,
  90     _attributes: &[ast::Attribute],
  91     results: &DataflowResults<'tcx, O>,
  92 ) where
  93     O: BitDenotation<'tcx, Idx = MovePathIndex> + HasMoveData<'tcx>,
  94 {
  95     debug!("sanity_check_via_rustc_peek def_id: {:?}", def_id);
  96     // FIXME: this is not DRY. Figure out way to abstract this and
  97     // `dataflow::build_sets`. (But note it is doing non-standard
  98     // stuff, so such generalization may not be realistic.)
  99
 100     for bb in body.basic_blocks().indices() {
 101         each_block(tcx, body, results, bb);
 102     }
 103 }
 104
 105 fn each_block<'tcx, O>(
 106     tcx: TyCtxt<'tcx, 'tcx>,
 107     body: &Body<'tcx>,
 108     results: &DataflowResults<'tcx, O>,
 109     bb: mir::BasicBlock,
 110 ) where
 111     O: BitDenotation<'tcx, Idx = MovePathIndex> + HasMoveData<'tcx>,
 112 {
 113     let move_data = results.0.operator.move_data();
 114     let mir::BasicBlockData { ref statements, ref terminator, is_cleanup: _ } = body[bb];
 115
 116     let (args, span) = match is_rustc_peek(tcx, terminator) {
 117         Some(args_and_span) => args_and_span,
 118         None => return,
 119     };
 120     assert!(args.len() == 1);
 121     let peek_arg_place = match args[0] {
 122         mir::Operand::Copy(ref place @ mir::Place::Base(mir::PlaceBase::Local(_))) |
 123         mir::Operand::Move(ref place @ mir::Place::Base(mir::PlaceBase::Local(_))) => Some(place),
 124         _ => None,
 125     };
 126
 127     let peek_arg_place = match peek_arg_place {
 128         Some(arg) => arg,
 129         None => {
 130             tcx.sess.diagnostic().span_err(
 131                 span, "dataflow::sanity_check cannot feed a non-temp to rustc_peek.");
 132             return;
 133         }
 134     };
 135
 136     let mut on_entry = results.0.sets.on_entry_set_for(bb.index()).to_owned();
 137     let mut gen_set = results.0.sets.gen_set_for(bb.index()).clone();
 138     let mut kill_set = results.0.sets.kill_set_for(bb.index()).clone();
 139
 140     // Emulate effect of all statements in the block up to (but not
 141     // including) the borrow within `peek_arg_place`. Do *not* include
 142     // call to `peek_arg_place` itself (since we are peeking the state
 143     // of the argument at time immediate preceding Call to
 144     // `rustc_peek`).
 145
 146     let mut sets = dataflow::BlockSets { on_entry: &mut on_entry,
 147                                          gen_set: &mut gen_set,
 148                                          kill_set: &mut kill_set };
 149
 150     for (j, stmt) in statements.iter().enumerate() {
 151         debug!("rustc_peek: ({:?},{}) {:?}", bb, j, stmt);
 152         let (place, rvalue) = match stmt.kind {
 153             mir::StatementKind::Assign(ref place, ref rvalue) => {
 154                 (place, rvalue)
 155             }
 156             mir::StatementKind::FakeRead(..) |
 157             mir::StatementKind::StorageLive(_) |
 158             mir::StatementKind::StorageDead(_) |
 159             mir::StatementKind::InlineAsm { .. } |
 160             mir::StatementKind::Retag { .. } |
 161             mir::StatementKind::AscribeUserType(..) |
 162             mir::StatementKind::Nop => continue,
 163             mir::StatementKind::SetDiscriminant{ .. } =>
 164                 span_bug!(stmt.source_info.span,
 165                           "sanity_check should run before Deaggregator inserts SetDiscriminant"),
 166         };
 167
 168         if place == peek_arg_place {
 169             if let mir::Rvalue::Ref(_, mir::BorrowKind::Shared, ref peeking_at_place) = **rvalue {
 170                 // Okay, our search is over.
 171                 match move_data.rev_lookup.find(peeking_at_place) {
 172                     LookupResult::Exact(peek_mpi) => {
 173                         let bit_state = sets.on_entry.contains(peek_mpi);
 174                         debug!("rustc_peek({:?} = &{:?}) bit_state: {}",
 175                                place, peeking_at_place, bit_state);
 176                         if !bit_state {
 177                             tcx.sess.span_err(span, "rustc_peek: bit not set");
 178                         }
 179                     }
 180                     LookupResult::Parent(..) => {
 181                         tcx.sess.span_err(span, "rustc_peek: argument untracked");
 182                     }
 183                 }
 184                 return;
 185             } else {
 186                 // Our search should have been over, but the input
 187                 // does not match expectations of `rustc_peek` for
 188                 // this sanity_check.
 189                 let msg = "rustc_peek: argument expression \
 190                            must be immediate borrow of form `&expr`";
 191                 tcx.sess.span_err(span, msg);
 192             }
 193         }
 194
 195         let lhs_mpi = move_data.rev_lookup.find(place);
 196
 197         debug!("rustc_peek: computing effect on place: {:?} ({:?}) in stmt: {:?}",
 198                place, lhs_mpi, stmt);
 199         // reset GEN and KILL sets before emulating their effect.
 200         sets.gen_set.clear();
 201         sets.kill_set.clear();
 202         results.0.operator.before_statement_effect(
 203             &mut sets, Location { block: bb, statement_index: j });
 204         results.0.operator.statement_effect(
 205             &mut sets, Location { block: bb, statement_index: j });
 206         sets.on_entry.union(sets.gen_set);
 207         sets.on_entry.subtract(sets.kill_set);
 208     }
 209
 210     results.0.operator.before_terminator_effect(
 211         &mut sets,
 212         Location { block: bb, statement_index: statements.len() });
 213
 214     tcx.sess.span_err(span, &format!("rustc_peek: MIR did not match \
 215                                       anticipated pattern; note that \
 216                                       rustc_peek expects input of \
 217                                       form `&expr`"));
 218 }
 219
 220 fn is_rustc_peek<'a, 'tcx>(
 221     tcx: TyCtxt<'tcx, 'tcx>,
 222     terminator: &'a Option<mir::Terminator<'tcx>>,
 223 ) -> Option<(&'a [mir::Operand<'tcx>], Span)> {
 224     if let Some(mir::Terminator { ref kind, source_info, .. }) = *terminator {
 225         if let mir::TerminatorKind::Call { func: ref oper, ref args, .. } = *kind {
 226             if let mir::Operand::Constant(ref func) = *oper {
 227                 if let ty::FnDef(def_id, _) = func.ty.sty {
 228                     let abi = tcx.fn_sig(def_id).abi();
 229                     let name = tcx.item_name(def_id);
 230                     if abi == Abi::RustIntrinsic && name == sym::rustc_peek {
 231                         return Some((args, source_info.span));
 232                     }
 233                 }
 234             }
 235         }
 236     }
 237     return None;
 238 }