src/librustc_borrowck/graphviz.rs

   1 //! This module provides linkage between rustc::middle::graph and
   2 //! libgraphviz traits, specialized to attaching borrowck analysis
   3 //! data to rendered labels.
   4
   5 pub use Variant::*;
   6
   7 pub use rustc::cfg::graphviz::{Node, Edge};
   8 use rustc::cfg::graphviz as cfg_dot;
   9
  10 use crate::borrowck::{self, BorrowckCtxt, LoanPath};
  11 use crate::dataflow::{DataFlowOperator, DataFlowContext, EntryOrExit};
  12 use log::debug;
  13 use rustc::cfg::CFGIndex;
  14 use std::rc::Rc;
  15
  16 #[derive(Debug, Copy, Clone)]
  17 pub enum Variant {
  18     Loans,
  19     Moves,
  20     Assigns,
  21 }
  22
  23 impl Variant {
  24     pub fn short_name(&self) -> &'static str {
  25         match *self {
  26             Loans   => "loans",
  27             Moves   => "moves",
  28             Assigns => "assigns",
  29         }
  30     }
  31 }
  32
  33 pub struct DataflowLabeller<'a, 'tcx: 'a> {
  34     pub inner: cfg_dot::LabelledCFG<'a, 'tcx>,
  35     pub variants: Vec<Variant>,
  36     pub borrowck_ctxt: &'a BorrowckCtxt<'a, 'tcx>,
  37     pub analysis_data: &'a borrowck::AnalysisData<'tcx>,
  38 }
  39
  40 impl<'a, 'tcx> DataflowLabeller<'a, 'tcx> {
  41     fn dataflow_for(&self, e: EntryOrExit, n: &Node<'a>) -> String {
  42         let id = n.1.data.id();
  43         debug!("dataflow_for({:?}, id={:?}) {:?}", e, id, self.variants);
  44         let mut sets = String::new();
  45         let mut seen_one = false;
  46         for &variant in &self.variants {
  47             if seen_one { sets.push_str(" "); } else { seen_one = true; }
  48             sets.push_str(variant.short_name());
  49             sets.push_str(": ");
  50             sets.push_str(&self.dataflow_for_variant(e, n, variant));
  51         }
  52         sets
  53     }
  54
  55     fn dataflow_for_variant(&self, e: EntryOrExit, n: &Node<'_>, v: Variant) -> String {
  56         let cfgidx = n.0;
  57         match v {
  58             Loans   => self.dataflow_loans_for(e, cfgidx),
  59             Moves   => self.dataflow_moves_for(e, cfgidx),
  60             Assigns => self.dataflow_assigns_for(e, cfgidx),
  61         }
  62     }
  63
  64     fn build_set<O:DataFlowOperator, F>(&self,
  65                                         e: EntryOrExit,
  66                                         cfgidx: CFGIndex,
  67                                         dfcx: &DataFlowContext<'tcx, O>,
  68                                         mut to_lp: F) -> String where
  69         F: FnMut(usize) -> Rc<LoanPath<'tcx>>,
  70     {
  71         let mut saw_some = false;
  72         let mut set = "{".to_string();
  73         dfcx.each_bit_for_node(e, cfgidx, |index| {
  74             let lp = to_lp(index);
  75             if saw_some {
  76                 set.push_str(", ");
  77             }
  78             let loan_str = self.borrowck_ctxt.loan_path_to_string(&lp);
  79             set.push_str(&loan_str);
  80             saw_some = true;
  81             true
  82         });
  83         set.push_str("}");
  84         set
  85     }
  86
  87     fn dataflow_loans_for(&self, e: EntryOrExit, cfgidx: CFGIndex) -> String {
  88         let dfcx = &self.analysis_data.loans;
  89         let loan_index_to_path = |loan_index| {
  90             let all_loans = &self.analysis_data.all_loans;
  91             let l: &borrowck::Loan<'_> = &all_loans[loan_index];
  92             l.loan_path()
  93         };
  94         self.build_set(e, cfgidx, dfcx, loan_index_to_path)
  95     }
  96
  97     fn dataflow_moves_for(&self, e: EntryOrExit, cfgidx: CFGIndex) -> String {
  98         let dfcx = &self.analysis_data.move_data.dfcx_moves;
  99         let move_index_to_path = |move_index| {
 100             let move_data = &self.analysis_data.move_data.move_data;
 101             let moves = move_data.moves.borrow();
 102             let the_move: &borrowck::move_data::Move = &(*moves)[move_index];
 103             move_data.path_loan_path(the_move.path)
 104         };
 105         self.build_set(e, cfgidx, dfcx, move_index_to_path)
 106     }
 107
 108     fn dataflow_assigns_for(&self, e: EntryOrExit, cfgidx: CFGIndex) -> String {
 109         let dfcx = &self.analysis_data.move_data.dfcx_assign;
 110         let assign_index_to_path = |assign_index| {
 111             let move_data = &self.analysis_data.move_data.move_data;
 112             let assignments = move_data.var_assignments.borrow();
 113             let assignment: &borrowck::move_data::Assignment = &(*assignments)[assign_index];
 114             move_data.path_loan_path(assignment.path)
 115         };
 116         self.build_set(e, cfgidx, dfcx, assign_index_to_path)
 117     }
 118 }
 119
 120 impl<'a, 'tcx> dot::Labeller<'a> for DataflowLabeller<'a, 'tcx> {
 121     type Node = Node<'a>;
 122     type Edge = Edge<'a>;
 123     fn graph_id(&'a self) -> dot::Id<'a> { self.inner.graph_id() }
 124     fn node_id(&'a self, n: &Node<'a>) -> dot::Id<'a> { self.inner.node_id(n) }
 125     fn node_label(&'a self, n: &Node<'a>) -> dot::LabelText<'a> {
 126         let prefix = self.dataflow_for(EntryOrExit::Entry, n);
 127         let suffix = self.dataflow_for(EntryOrExit::Exit, n);
 128         let inner_label = self.inner.node_label(n);
 129         inner_label
 130             .prefix_line(dot::LabelText::LabelStr(prefix.into()))
 131             .suffix_line(dot::LabelText::LabelStr(suffix.into()))
 132     }
 133     fn edge_label(&'a self, e: &Edge<'a>) -> dot::LabelText<'a> { self.inner.edge_label(e) }
 134 }
 135
 136 impl<'a, 'tcx> dot::GraphWalk<'a> for DataflowLabeller<'a, 'tcx> {
 137     type Node = Node<'a>;
 138     type Edge = Edge<'a>;
 139     fn nodes(&'a self) -> dot::Nodes<'a, Node<'a>> { self.inner.nodes() }
 140     fn edges(&'a self) -> dot::Edges<'a, Edge<'a>> { self.inner.edges() }
 141     fn source(&'a self, edge: &Edge<'a>) -> Node<'a> { self.inner.source(edge) }
 142     fn target(&'a self, edge: &Edge<'a>) -> Node<'a> { self.inner.target(edge) }
 143 }