src/librustc/middle/dataflow.rs

   1 // Copyright 2012-2014 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11
  12 //! A module for propagating forward dataflow information. The analysis
  13 //! assumes that the items to be propagated can be represented as bits
  14 //! and thus uses bitvectors. Your job is simply to specify the so-called
  15 //! GEN and KILL bits for each expression.
  16
  17 use middle::cfg;
  18 use middle::cfg::CFGIndex;
  19 use middle::ty;
  20 use std::io;
  21 use std::mem;
  22 use std::usize;
  23 use syntax::ast;
  24 use syntax::ast_util::IdRange;
  25 use syntax::print::pp;
  26 use syntax::print::pprust::PrintState;
  27 use util::nodemap::NodeMap;
  28 use rustc_front::hir;
  29 use rustc_front::intravisit;
  30 use rustc_front::print::pprust;
  31
  32
  33 #[derive(Copy, Clone, Debug)]
  34 pub enum EntryOrExit {
  35     Entry,
  36     Exit,
  37 }
  38
  39 #[derive(Clone)]
  40 pub struct DataFlowContext<'a, 'tcx: 'a, O> {
  41     tcx: &'a ty::ctxt<'tcx>,
  42
  43     /// a name for the analysis using this dataflow instance
  44     analysis_name: &'static str,
  45
  46     /// the data flow operator
  47     oper: O,
  48
  49     /// number of bits to propagate per id
  50     bits_per_id: usize,
  51
  52     /// number of words we will use to store bits_per_id.
  53     /// equal to bits_per_id/usize::BITS rounded up.
  54     words_per_id: usize,
  55
  56     // mapping from node to cfg node index
  57     // FIXME (#6298): Shouldn't this go with CFG?
  58     nodeid_to_index: NodeMap<Vec<CFGIndex>>,
  59
  60     // Bit sets per cfg node.  The following three fields (`gens`, `kills`,
  61     // and `on_entry`) all have the same structure. For each id in
  62     // `id_range`, there is a range of words equal to `words_per_id`.
  63     // So, to access the bits for any given id, you take a slice of
  64     // the full vector (see the method `compute_id_range()`).
  65
  66     /// bits generated as we exit the cfg node. Updated by `add_gen()`.
  67     gens: Vec<usize>,
  68
  69     /// bits killed as we exit the cfg node, or non-locally jump over
  70     /// it. Updated by `add_kill(KillFrom::ScopeEnd)`.
  71     scope_kills: Vec<usize>,
  72
  73     /// bits killed as we exit the cfg node directly; if it is jumped
  74     /// over, e.g. via `break`, the kills are not reflected in the
  75     /// jump's effects. Updated by `add_kill(KillFrom::Execution)`.
  76     action_kills: Vec<usize>,
  77
  78     /// bits that are valid on entry to the cfg node. Updated by
  79     /// `propagate()`.
  80     on_entry: Vec<usize>,
  81 }
  82
  83 pub trait BitwiseOperator {
  84     /// Joins two predecessor bits together, typically either `|` or `&`
  85     fn join(&self, succ: usize, pred: usize) -> usize;
  86 }
  87
  88 /// Parameterization for the precise form of data flow that is used.
  89 pub trait DataFlowOperator : BitwiseOperator {
  90     /// Specifies the initial value for each bit in the `on_entry` set
  91     fn initial_value(&self) -> bool;
  92 }
  93
  94 struct PropagationContext<'a, 'b: 'a, 'tcx: 'b, O: 'a> {
  95     dfcx: &'a mut DataFlowContext<'b, 'tcx, O>,
  96     changed: bool
  97 }
  98
  99 fn get_cfg_indices<'a>(id: ast::NodeId, index: &'a NodeMap<Vec<CFGIndex>>) -> &'a [CFGIndex] {
 100     let opt_indices = index.get(&id);
 101     opt_indices.map(|v| &v[..]).unwrap_or(&[])
 102 }
 103
 104 impl<'a, 'tcx, O:DataFlowOperator> DataFlowContext<'a, 'tcx, O> {
 105     fn has_bitset_for_nodeid(&self, n: ast::NodeId) -> bool {
 106         assert!(n != ast::DUMMY_NODE_ID);
 107         self.nodeid_to_index.contains_key(&n)
 108     }
 109 }
 110
 111 impl<'a, 'tcx, O:DataFlowOperator> pprust::PpAnn for DataFlowContext<'a, 'tcx, O> {
 112     fn pre(&self,
 113            ps: &mut pprust::State,
 114            node: pprust::AnnNode) -> io::Result<()> {
 115         let id = match node {
 116             pprust::NodeName(_) => 0,
 117             pprust::NodeExpr(expr) => expr.id,
 118             pprust::NodeBlock(blk) => blk.id,
 119             pprust::NodeItem(_) | pprust::NodeSubItem(_) => 0,
 120             pprust::NodePat(pat) => pat.id
 121         };
 122
 123         if !self.has_bitset_for_nodeid(id) {
 124             return Ok(());
 125         }
 126
 127         assert!(self.bits_per_id > 0);
 128         let indices = get_cfg_indices(id, &self.nodeid_to_index);
 129         for &cfgidx in indices {
 130             let (start, end) = self.compute_id_range(cfgidx);
 131             let on_entry = &self.on_entry[start.. end];
 132             let entry_str = bits_to_string(on_entry);
 133
 134             let gens = &self.gens[start.. end];
 135             let gens_str = if gens.iter().any(|&u| u != 0) {
 136                 format!(" gen: {}", bits_to_string(gens))
 137             } else {
 138                 "".to_string()
 139             };
 140
 141             let action_kills = &self.action_kills[start .. end];
 142             let action_kills_str = if action_kills.iter().any(|&u| u != 0) {
 143                 format!(" action_kill: {}", bits_to_string(action_kills))
 144             } else {
 145                 "".to_string()
 146             };
 147
 148             let scope_kills = &self.scope_kills[start .. end];
 149             let scope_kills_str = if scope_kills.iter().any(|&u| u != 0) {
 150                 format!(" scope_kill: {}", bits_to_string(scope_kills))
 151             } else {
 152                 "".to_string()
 153             };
 154
 155             try!(ps.synth_comment(
 156                 format!("id {}: {}{}{}{}", id, entry_str,
 157                         gens_str, action_kills_str, scope_kills_str)));
 158             try!(pp::space(&mut ps.s));
 159         }
 160         Ok(())
 161     }
 162 }
 163
 164 fn build_nodeid_to_index(decl: Option<&hir::FnDecl>,
 165                          cfg: &cfg::CFG) -> NodeMap<Vec<CFGIndex>> {
 166     let mut index = NodeMap();
 167
 168     // FIXME (#6298): Would it be better to fold formals from decl
 169     // into cfg itself?  i.e. introduce a fn-based flow-graph in
 170     // addition to the current block-based flow-graph, rather than
 171     // have to put traversals like this here?
 172     match decl {
 173         None => {}
 174         Some(decl) => add_entries_from_fn_decl(&mut index, decl, cfg.entry)
 175     }
 176
 177     cfg.graph.each_node(|node_idx, node| {
 178         if let cfg::CFGNodeData::AST(id) = node.data {
 179             index.entry(id).or_insert(vec![]).push(node_idx);
 180         }
 181         true
 182     });
 183
 184     return index;
 185
 186     fn add_entries_from_fn_decl(index: &mut NodeMap<Vec<CFGIndex>>,
 187                                 decl: &hir::FnDecl,
 188                                 entry: CFGIndex) {
 189         //! add mappings from the ast nodes for the formal bindings to
 190         //! the entry-node in the graph.
 191         struct Formals<'a> {
 192             entry: CFGIndex,
 193             index: &'a mut NodeMap<Vec<CFGIndex>>,
 194         }
 195         let mut formals = Formals { entry: entry, index: index };
 196         intravisit::walk_fn_decl(&mut formals, decl);
 197         impl<'a, 'v> intravisit::Visitor<'v> for Formals<'a> {
 198             fn visit_pat(&mut self, p: &hir::Pat) {
 199                 self.index.entry(p.id).or_insert(vec![]).push(self.entry);
 200                 intravisit::walk_pat(self, p)
 201             }
 202         }
 203     }
 204 }
 205
 206 /// Flag used by `add_kill` to indicate whether the provided kill
 207 /// takes effect only when control flows directly through the node in
 208 /// question, or if the kill's effect is associated with any
 209 /// control-flow directly through or indirectly over the node.
 210 #[derive(Copy, Clone, PartialEq, Debug)]
 211 pub enum KillFrom {
 212     /// A `ScopeEnd` kill is one that takes effect when any control
 213     /// flow goes over the node. A kill associated with the end of the
 214     /// scope of a variable declaration `let x;` is an example of a
 215     /// `ScopeEnd` kill.
 216     ScopeEnd,
 217
 218     /// An `Execution` kill is one that takes effect only when control
 219     /// flow goes through the node to completion. A kill associated
 220     /// with an assignment statement `x = expr;` is an example of an
 221     /// `Execution` kill.
 222     Execution,
 223 }
 224
 225 impl<'a, 'tcx, O:DataFlowOperator> DataFlowContext<'a, 'tcx, O> {
 226     pub fn new(tcx: &'a ty::ctxt<'tcx>,
 227                analysis_name: &'static str,
 228                decl: Option<&hir::FnDecl>,
 229                cfg: &cfg::CFG,
 230                oper: O,
 231                id_range: IdRange,
 232                bits_per_id: usize) -> DataFlowContext<'a, 'tcx, O> {
 233         let usize_bits = mem::size_of::<usize>() * 8;
 234         let words_per_id = (bits_per_id + usize_bits - 1) / usize_bits;
 235         let num_nodes = cfg.graph.all_nodes().len();
 236
 237         debug!("DataFlowContext::new(analysis_name: {}, id_range={:?}, \
 238                                      bits_per_id={}, words_per_id={}) \
 239                                      num_nodes: {}",
 240                analysis_name, id_range, bits_per_id, words_per_id,
 241                num_nodes);
 242
 243         let entry = if oper.initial_value() { usize::MAX } else {0};
 244
 245         let zeroes = vec![0; num_nodes * words_per_id];
 246         let gens = zeroes.clone();
 247         let kills1 = zeroes.clone();
 248         let kills2 = zeroes;
 249         let on_entry = vec![entry; num_nodes * words_per_id];
 250
 251         let nodeid_to_index = build_nodeid_to_index(decl, cfg);
 252
 253         DataFlowContext {
 254             tcx: tcx,
 255             analysis_name: analysis_name,
 256             words_per_id: words_per_id,
 257             nodeid_to_index: nodeid_to_index,
 258             bits_per_id: bits_per_id,
 259             oper: oper,
 260             gens: gens,
 261             action_kills: kills1,
 262             scope_kills: kills2,
 263             on_entry: on_entry
 264         }
 265     }
 266
 267     pub fn add_gen(&mut self, id: ast::NodeId, bit: usize) {
 268         //! Indicates that `id` generates `bit`
 269         debug!("{} add_gen(id={}, bit={})",
 270                self.analysis_name, id, bit);
 271         assert!(self.nodeid_to_index.contains_key(&id));
 272         assert!(self.bits_per_id > 0);
 273
 274         let indices = get_cfg_indices(id, &self.nodeid_to_index);
 275         for &cfgidx in indices {
 276             let (start, end) = self.compute_id_range(cfgidx);
 277             let gens = &mut self.gens[start.. end];
 278             set_bit(gens, bit);
 279         }
 280     }
 281
 282     pub fn add_kill(&mut self, kind: KillFrom, id: ast::NodeId, bit: usize) {
 283         //! Indicates that `id` kills `bit`
 284         debug!("{} add_kill(id={}, bit={})",
 285                self.analysis_name, id, bit);
 286         assert!(self.nodeid_to_index.contains_key(&id));
 287         assert!(self.bits_per_id > 0);
 288
 289         let indices = get_cfg_indices(id, &self.nodeid_to_index);
 290         for &cfgidx in indices {
 291             let (start, end) = self.compute_id_range(cfgidx);
 292             let kills = match kind {
 293                 KillFrom::Execution => &mut self.action_kills[start.. end],
 294                 KillFrom::ScopeEnd =>  &mut self.scope_kills[start.. end],
 295             };
 296             set_bit(kills, bit);
 297         }
 298     }
 299
 300     fn apply_gen_kill(&self, cfgidx: CFGIndex, bits: &mut [usize]) {
 301         //! Applies the gen and kill sets for `cfgidx` to `bits`
 302         debug!("{} apply_gen_kill(cfgidx={:?}, bits={}) [before]",
 303                self.analysis_name, cfgidx, mut_bits_to_string(bits));
 304         assert!(self.bits_per_id > 0);
 305
 306         let (start, end) = self.compute_id_range(cfgidx);
 307         let gens = &self.gens[start.. end];
 308         bitwise(bits, gens, &Union);
 309         let kills = &self.action_kills[start.. end];
 310         bitwise(bits, kills, &Subtract);
 311         let kills = &self.scope_kills[start.. end];
 312         bitwise(bits, kills, &Subtract);
 313
 314         debug!("{} apply_gen_kill(cfgidx={:?}, bits={}) [after]",
 315                self.analysis_name, cfgidx, mut_bits_to_string(bits));
 316     }
 317
 318     fn compute_id_range(&self, cfgidx: CFGIndex) -> (usize, usize) {
 319         let n = cfgidx.node_id();
 320         let start = n * self.words_per_id;
 321         let end = start + self.words_per_id;
 322
 323         assert!(start < self.gens.len());
 324         assert!(end <= self.gens.len());
 325         assert!(self.gens.len() == self.action_kills.len());
 326         assert!(self.gens.len() == self.scope_kills.len());
 327         assert!(self.gens.len() == self.on_entry.len());
 328
 329         (start, end)
 330     }
 331
 332
 333     pub fn each_bit_on_entry<F>(&self, id: ast::NodeId, mut f: F) -> bool where
 334         F: FnMut(usize) -> bool,
 335     {
 336         //! Iterates through each bit that is set on entry to `id`.
 337         //! Only useful after `propagate()` has been called.
 338         if !self.has_bitset_for_nodeid(id) {
 339             return true;
 340         }
 341         let indices = get_cfg_indices(id, &self.nodeid_to_index);
 342         for &cfgidx in indices {
 343             if !self.each_bit_for_node(EntryOrExit::Entry, cfgidx, |i| f(i)) {
 344                 return false;
 345             }
 346         }
 347         return true;
 348     }
 349
 350     pub fn each_bit_for_node<F>(&self, e: EntryOrExit, cfgidx: CFGIndex, f: F) -> bool where
 351         F: FnMut(usize) -> bool,
 352     {
 353         //! Iterates through each bit that is set on entry/exit to `cfgidx`.
 354         //! Only useful after `propagate()` has been called.
 355
 356         if self.bits_per_id == 0 {
 357             // Skip the surprisingly common degenerate case.  (Note
 358             // compute_id_range requires self.words_per_id > 0.)
 359             return true;
 360         }
 361
 362         let (start, end) = self.compute_id_range(cfgidx);
 363         let on_entry = &self.on_entry[start.. end];
 364         let temp_bits;
 365         let slice = match e {
 366             EntryOrExit::Entry => on_entry,
 367             EntryOrExit::Exit => {
 368                 let mut t = on_entry.to_vec();
 369                 self.apply_gen_kill(cfgidx, &mut t);
 370                 temp_bits = t;
 371                 &temp_bits[..]
 372             }
 373         };
 374         debug!("{} each_bit_for_node({:?}, cfgidx={:?}) bits={}",
 375                self.analysis_name, e, cfgidx, bits_to_string(slice));
 376         self.each_bit(slice, f)
 377     }
 378
 379     pub fn each_gen_bit<F>(&self, id: ast::NodeId, mut f: F) -> bool where
 380         F: FnMut(usize) -> bool,
 381     {
 382         //! Iterates through each bit in the gen set for `id`.
 383         if !self.has_bitset_for_nodeid(id) {
 384             return true;
 385         }
 386
 387         if self.bits_per_id == 0 {
 388             // Skip the surprisingly common degenerate case.  (Note
 389             // compute_id_range requires self.words_per_id > 0.)
 390             return true;
 391         }
 392
 393         let indices = get_cfg_indices(id, &self.nodeid_to_index);
 394         for &cfgidx in indices {
 395             let (start, end) = self.compute_id_range(cfgidx);
 396             let gens = &self.gens[start.. end];
 397             debug!("{} each_gen_bit(id={}, gens={})",
 398                    self.analysis_name, id, bits_to_string(gens));
 399             if !self.each_bit(gens, |i| f(i)) {
 400                 return false;
 401             }
 402         }
 403         return true;
 404     }
 405
 406     fn each_bit<F>(&self, words: &[usize], mut f: F) -> bool where
 407         F: FnMut(usize) -> bool,
 408     {
 409         //! Helper for iterating over the bits in a bit set.
 410         //! Returns false on the first call to `f` that returns false;
 411         //! if all calls to `f` return true, then returns true.
 412
 413         let usize_bits = mem::size_of::<usize>() * 8;
 414         for (word_index, &word) in words.iter().enumerate() {
 415             if word != 0 {
 416                 let base_index = word_index * usize_bits;
 417                 for offset in 0..usize_bits {
 418                     let bit = 1 << offset;
 419                     if (word & bit) != 0 {
 420                         // NB: we round up the total number of bits
 421                         // that we store in any given bit set so that
 422                         // it is an even multiple of usize::BITS.  This
 423                         // means that there may be some stray bits at
 424                         // the end that do not correspond to any
 425                         // actual value.  So before we callback, check
 426                         // whether the bit_index is greater than the
 427                         // actual value the user specified and stop
 428                         // iterating if so.
 429                         let bit_index = base_index + offset as usize;
 430                         if bit_index >= self.bits_per_id {
 431                             return true;
 432                         } else if !f(bit_index) {
 433                             return false;
 434                         }
 435                     }
 436                 }
 437             }
 438         }
 439         return true;
 440     }
 441
 442     pub fn add_kills_from_flow_exits(&mut self, cfg: &cfg::CFG) {
 443         //! Whenever you have a `break` or `continue` statement, flow
 444         //! exits through any number of enclosing scopes on its way to
 445         //! the new destination. This function infers the kill bits of
 446         //! those control operators based on the kill bits associated
 447         //! with those scopes.
 448         //!
 449         //! This is usually called (if it is called at all), after
 450         //! all add_gen and add_kill calls, but before propagate.
 451
 452         debug!("{} add_kills_from_flow_exits", self.analysis_name);
 453         if self.bits_per_id == 0 {
 454             // Skip the surprisingly common degenerate case.  (Note
 455             // compute_id_range requires self.words_per_id > 0.)
 456             return;
 457         }
 458         cfg.graph.each_edge(|_edge_index, edge| {
 459             let flow_exit = edge.source();
 460             let (start, end) = self.compute_id_range(flow_exit);
 461             let mut orig_kills = self.scope_kills[start.. end].to_vec();
 462
 463             let mut changed = false;
 464             for &node_id in &edge.data.exiting_scopes {
 465                 let opt_cfg_idx = self.nodeid_to_index.get(&node_id);
 466                 match opt_cfg_idx {
 467                     Some(indices) => {
 468                         for &cfg_idx in indices {
 469                             let (start, end) = self.compute_id_range(cfg_idx);
 470                             let kills = &self.scope_kills[start.. end];
 471                             if bitwise(&mut orig_kills, kills, &Union) {
 472                                 debug!("scope exits: scope id={} \
 473                                         (node={:?} of {:?}) added killset: {}",
 474                                        node_id, cfg_idx, indices,
 475                                        bits_to_string(kills));
 476                                 changed = true;
 477                             }
 478                         }
 479                     }
 480                     None => {
 481                         debug!("{} add_kills_from_flow_exits flow_exit={:?} \
 482                                 no cfg_idx for exiting_scope={}",
 483                                self.analysis_name, flow_exit, node_id);
 484                     }
 485                 }
 486             }
 487
 488             if changed {
 489                 let bits = &mut self.scope_kills[start.. end];
 490                 debug!("{} add_kills_from_flow_exits flow_exit={:?} bits={} [before]",
 491                        self.analysis_name, flow_exit, mut_bits_to_string(bits));
 492                 bits.clone_from_slice(&orig_kills[..]);
 493                 debug!("{} add_kills_from_flow_exits flow_exit={:?} bits={} [after]",
 494                        self.analysis_name, flow_exit, mut_bits_to_string(bits));
 495             }
 496             true
 497         });
 498     }
 499 }
 500
 501 impl<'a, 'tcx, O:DataFlowOperator+Clone+'static> DataFlowContext<'a, 'tcx, O> {
 502 //                                ^^^^^^^^^^^^^ only needed for pretty printing
 503     pub fn propagate(&mut self, cfg: &cfg::CFG, blk: &hir::Block) {
 504         //! Performs the data flow analysis.
 505
 506         if self.bits_per_id == 0 {
 507             // Optimize the surprisingly common degenerate case.
 508             return;
 509         }
 510
 511         {
 512             let words_per_id = self.words_per_id;
 513             let mut propcx = PropagationContext {
 514                 dfcx: &mut *self,
 515                 changed: true
 516             };
 517
 518             let mut temp = vec![0; words_per_id];
 519             while propcx.changed {
 520                 propcx.changed = false;
 521                 propcx.reset(&mut temp);
 522                 propcx.walk_cfg(cfg, &mut temp);
 523             }
 524         }
 525
 526         debug!("Dataflow result for {}:", self.analysis_name);
 527         debug!("{}", {
 528             let mut v = Vec::new();
 529             self.pretty_print_to(box &mut v, blk).unwrap();
 530             println!("{}", String::from_utf8(v).unwrap());
 531             ""
 532         });
 533     }
 534
 535     fn pretty_print_to<'b>(&self, wr: Box<io::Write + 'b>,
 536                            blk: &hir::Block) -> io::Result<()> {
 537         let mut ps = pprust::rust_printer_annotated(wr, self, None);
 538         try!(ps.cbox(pprust::indent_unit));
 539         try!(ps.ibox(0));
 540         try!(ps.print_block(blk));
 541         pp::eof(&mut ps.s)
 542     }
 543 }
 544
 545 impl<'a, 'b, 'tcx, O:DataFlowOperator> PropagationContext<'a, 'b, 'tcx, O> {
 546     fn walk_cfg(&mut self,
 547                 cfg: &cfg::CFG,
 548                 in_out: &mut [usize]) {
 549         debug!("DataFlowContext::walk_cfg(in_out={}) {}",
 550                bits_to_string(in_out), self.dfcx.analysis_name);
 551         assert!(self.dfcx.bits_per_id > 0);
 552
 553         cfg.graph.each_node(|node_index, node| {
 554             debug!("DataFlowContext::walk_cfg idx={:?} id={} begin in_out={}",
 555                    node_index, node.data.id(), bits_to_string(in_out));
 556
 557             let (start, end) = self.dfcx.compute_id_range(node_index);
 558
 559             // Initialize local bitvector with state on-entry.
 560             in_out.clone_from_slice(&self.dfcx.on_entry[start.. end]);
 561
 562             // Compute state on-exit by applying transfer function to
 563             // state on-entry.
 564             self.dfcx.apply_gen_kill(node_index, in_out);
 565
 566             // Propagate state on-exit from node into its successors.
 567             self.propagate_bits_into_graph_successors_of(in_out, cfg, node_index);
 568             true // continue to next node
 569         });
 570     }
 571
 572     fn reset(&mut self, bits: &mut [usize]) {
 573         let e = if self.dfcx.oper.initial_value() {usize::MAX} else {0};
 574         for b in bits {
 575             *b = e;
 576         }
 577     }
 578
 579     fn propagate_bits_into_graph_successors_of(&mut self,
 580                                                pred_bits: &[usize],
 581                                                cfg: &cfg::CFG,
 582                                                cfgidx: CFGIndex) {
 583         for (_, edge) in cfg.graph.outgoing_edges(cfgidx) {
 584             self.propagate_bits_into_entry_set_for(pred_bits, edge);
 585         }
 586     }
 587
 588     fn propagate_bits_into_entry_set_for(&mut self,
 589                                          pred_bits: &[usize],
 590                                          edge: &cfg::CFGEdge) {
 591         let source = edge.source();
 592         let cfgidx = edge.target();
 593         debug!("{} propagate_bits_into_entry_set_for(pred_bits={}, {:?} to {:?})",
 594                self.dfcx.analysis_name, bits_to_string(pred_bits), source, cfgidx);
 595         assert!(self.dfcx.bits_per_id > 0);
 596
 597         let (start, end) = self.dfcx.compute_id_range(cfgidx);
 598         let changed = {
 599             // (scoping mutable borrow of self.dfcx.on_entry)
 600             let on_entry = &mut self.dfcx.on_entry[start.. end];
 601             bitwise(on_entry, pred_bits, &self.dfcx.oper)
 602         };
 603         if changed {
 604             debug!("{} changed entry set for {:?} to {}",
 605                    self.dfcx.analysis_name, cfgidx,
 606                    bits_to_string(&self.dfcx.on_entry[start.. end]));
 607             self.changed = true;
 608         }
 609     }
 610 }
 611
 612 fn mut_bits_to_string(words: &mut [usize]) -> String {
 613     bits_to_string(words)
 614 }
 615
 616 fn bits_to_string(words: &[usize]) -> String {
 617     let mut result = String::new();
 618     let mut sep = '[';
 619
 620     // Note: this is a little endian printout of bytes.
 621
 622     for &word in words {
 623         let mut v = word;
 624         for _ in 0..mem::size_of::<usize>() {
 625             result.push(sep);
 626             result.push_str(&format!("{:02x}", v & 0xFF));
 627             v >>= 8;
 628             sep = '-';
 629         }
 630     }
 631     result.push(']');
 632     return result
 633 }
 634
 635 #[inline]
 636 fn bitwise<Op:BitwiseOperator>(out_vec: &mut [usize],
 637                                in_vec: &[usize],
 638                                op: &Op) -> bool {
 639     assert_eq!(out_vec.len(), in_vec.len());
 640     let mut changed = false;
 641     for (out_elt, in_elt) in out_vec.iter_mut().zip(in_vec) {
 642         let old_val = *out_elt;
 643         let new_val = op.join(old_val, *in_elt);
 644         *out_elt = new_val;
 645         changed |= old_val != new_val;
 646     }
 647     changed
 648 }
 649
 650 fn set_bit(words: &mut [usize], bit: usize) -> bool {
 651     debug!("set_bit: words={} bit={}",
 652            mut_bits_to_string(words), bit_str(bit));
 653     let usize_bits = mem::size_of::<usize>() * 8;
 654     let word = bit / usize_bits;
 655     let bit_in_word = bit % usize_bits;
 656     let bit_mask = 1 << bit_in_word;
 657     debug!("word={} bit_in_word={} bit_mask={}", word, bit_in_word, word);
 658     let oldv = words[word];
 659     let newv = oldv | bit_mask;
 660     words[word] = newv;
 661     oldv != newv
 662 }
 663
 664 fn bit_str(bit: usize) -> String {
 665     let byte = bit >> 8;
 666     let lobits = 1 << (bit & 0xFF);
 667     format!("[{}:{}-{:02x}]", bit, byte, lobits)
 668 }
 669
 670 struct Union;
 671 impl BitwiseOperator for Union {
 672     fn join(&self, a: usize, b: usize) -> usize { a | b }
 673 }
 674 struct Subtract;
 675 impl BitwiseOperator for Subtract {
 676     fn join(&self, a: usize, b: usize) -> usize { a & !b }
 677 }