src/librustc_mir/transform/const_prop.rs

   1 //! Propagates constants for early reporting of statically known
   2 //! assertion failures
   3
   4 use std::cell::Cell;
   5
   6 use rustc::hir::def::DefKind;
   7 use rustc::mir::{
   8     AggregateKind, Constant, Location, Place, PlaceBase, Body, Operand, Rvalue,
   9     Local, NullOp, UnOp, StatementKind, Statement, LocalKind, Static, StaticKind,
  10     TerminatorKind, Terminator,  ClearCrossCrate, SourceInfo, BinOp, ProjectionElem,
  11     SourceScope, SourceScopeLocalData, LocalDecl, Promoted,
  12 };
  13 use rustc::mir::visit::{
  14     Visitor, PlaceContext, MutatingUseContext, MutVisitor, NonMutatingUseContext,
  15 };
  16 use rustc::mir::interpret::{Scalar, GlobalId, InterpResult, PanicInfo};
  17 use rustc::ty::{self, Instance, ParamEnv, Ty, TyCtxt};
  18 use syntax_pos::{Span, DUMMY_SP};
  19 use rustc::ty::subst::InternalSubsts;
  20 use rustc_data_structures::indexed_vec::IndexVec;
  21 use rustc::ty::layout::{
  22     LayoutOf, TyLayout, LayoutError, HasTyCtxt, TargetDataLayout, HasDataLayout, Size,
  23 };
  24
  25 use crate::interpret::{
  26     self, InterpCx, ScalarMaybeUndef, Immediate, OpTy,
  27     ImmTy, MemoryKind, StackPopCleanup, LocalValue, LocalState,
  28 };
  29 use crate::const_eval::{
  30     CompileTimeInterpreter, error_to_const_error, eval_promoted, mk_eval_cx,
  31 };
  32 use crate::transform::{MirPass, MirSource};
  33
  34 pub struct ConstProp;
  35
  36 impl MirPass for ConstProp {
  37     fn run_pass<'tcx>(&self, tcx: TyCtxt<'tcx>, source: MirSource<'tcx>, body: &mut Body<'tcx>) {
  38         // will be evaluated by miri and produce its errors there
  39         if source.promoted.is_some() {
  40             return;
  41         }
  42
  43         use rustc::hir::map::blocks::FnLikeNode;
  44         let hir_id = tcx.hir().as_local_hir_id(source.def_id())
  45                               .expect("Non-local call to local provider is_const_fn");
  46
  47         let is_fn_like = FnLikeNode::from_node(tcx.hir().get(hir_id)).is_some();
  48         let is_assoc_const = match tcx.def_kind(source.def_id()) {
  49             Some(DefKind::AssocConst) => true,
  50             _ => false,
  51         };
  52
  53         // Only run const prop on functions, methods, closures and associated constants
  54         if !is_fn_like && !is_assoc_const  {
  55             // skip anon_const/statics/consts because they'll be evaluated by miri anyway
  56             trace!("ConstProp skipped for {:?}", source.def_id());
  57             return
  58         }
  59
  60         trace!("ConstProp starting for {:?}", source.def_id());
  61
  62         // Steal some data we need from `body`.
  63         let source_scope_local_data = std::mem::replace(
  64             &mut body.source_scope_local_data,
  65             ClearCrossCrate::Clear
  66         );
  67         let promoted = std::mem::replace(
  68             &mut body.promoted,
  69             IndexVec::new()
  70         );
  71
  72         let dummy_body =
  73             &Body::new(
  74                 body.basic_blocks().clone(),
  75                 Default::default(),
  76                 ClearCrossCrate::Clear,
  77                 Default::default(),
  78                 None,
  79                 body.local_decls.clone(),
  80                 Default::default(),
  81                 body.arg_count,
  82                 Default::default(),
  83                 tcx.def_span(source.def_id()),
  84                 Default::default(),
  85             );
  86
  87         // FIXME(oli-obk, eddyb) Optimize locals (or even local paths) to hold
  88         // constants, instead of just checking for const-folding succeeding.
  89         // That would require an uniform one-def no-mutation analysis
  90         // and RPO (or recursing when needing the value of a local).
  91         let mut optimization_finder = ConstPropagator::new(
  92             body,
  93             dummy_body,
  94             source_scope_local_data,
  95             promoted,
  96             tcx,
  97             source
  98         );
  99         optimization_finder.visit_body(body);
 100
 101         // put back the data we stole from `mir`
 102         let (source_scope_local_data, promoted) = optimization_finder.release_stolen_data();
 103         std::mem::replace(
 104             &mut body.source_scope_local_data,
 105             source_scope_local_data
 106         );
 107         std::mem::replace(
 108             &mut body.promoted,
 109             promoted
 110         );
 111
 112         trace!("ConstProp done for {:?}", source.def_id());
 113     }
 114 }
 115
 116 type Const<'tcx> = OpTy<'tcx>;
 117
 118 /// Finds optimization opportunities on the MIR.
 119 struct ConstPropagator<'mir, 'tcx> {
 120     ecx: InterpCx<'mir, 'tcx, CompileTimeInterpreter<'mir, 'tcx>>,
 121     tcx: TyCtxt<'tcx>,
 122     source: MirSource<'tcx>,
 123     can_const_prop: IndexVec<Local, bool>,
 124     param_env: ParamEnv<'tcx>,
 125     source_scope_local_data: ClearCrossCrate<IndexVec<SourceScope, SourceScopeLocalData>>,
 126     local_decls: IndexVec<Local, LocalDecl<'tcx>>,
 127     promoted: IndexVec<Promoted, Body<'tcx>>,
 128 }
 129
 130 impl<'mir, 'tcx> LayoutOf for ConstPropagator<'mir, 'tcx> {
 131     type Ty = Ty<'tcx>;
 132     type TyLayout = Result<TyLayout<'tcx>, LayoutError<'tcx>>;
 133
 134     fn layout_of(&self, ty: Ty<'tcx>) -> Self::TyLayout {
 135         self.tcx.layout_of(self.param_env.and(ty))
 136     }
 137 }
 138
 139 impl<'mir, 'tcx> HasDataLayout for ConstPropagator<'mir, 'tcx> {
 140     #[inline]
 141     fn data_layout(&self) -> &TargetDataLayout {
 142         &self.tcx.data_layout
 143     }
 144 }
 145
 146 impl<'mir, 'tcx> HasTyCtxt<'tcx> for ConstPropagator<'mir, 'tcx> {
 147     #[inline]
 148     fn tcx(&self) -> TyCtxt<'tcx> {
 149         self.tcx
 150     }
 151 }
 152
 153 impl<'mir, 'tcx> ConstPropagator<'mir, 'tcx> {
 154     fn new(
 155         body: &Body<'tcx>,
 156         dummy_body: &'mir Body<'tcx>,
 157         source_scope_local_data: ClearCrossCrate<IndexVec<SourceScope, SourceScopeLocalData>>,
 158         promoted: IndexVec<Promoted, Body<'tcx>>,
 159         tcx: TyCtxt<'tcx>,
 160         source: MirSource<'tcx>,
 161     ) -> ConstPropagator<'mir, 'tcx> {
 162         let def_id = source.def_id();
 163         let param_env = tcx.param_env(def_id);
 164         let span = tcx.def_span(def_id);
 165         let mut ecx = mk_eval_cx(tcx, span, param_env);
 166         let can_const_prop = CanConstProp::check(body);
 167
 168         ecx.push_stack_frame(
 169             Instance::new(def_id, &InternalSubsts::identity_for_item(tcx, def_id)),
 170             span,
 171             dummy_body,
 172             None,
 173             StackPopCleanup::None {
 174                 cleanup: false,
 175             },
 176         ).expect("failed to push initial stack frame");
 177
 178         ConstPropagator {
 179             ecx,
 180             tcx,
 181             source,
 182             param_env,
 183             can_const_prop,
 184             source_scope_local_data,
 185             //FIXME(wesleywiser) we can't steal this because `Visitor::super_visit_body()` needs it
 186             local_decls: body.local_decls.clone(),
 187             promoted,
 188         }
 189     }
 190
 191     fn release_stolen_data(
 192         self,
 193     ) -> (
 194         ClearCrossCrate<IndexVec<SourceScope, SourceScopeLocalData>>,
 195         IndexVec<Promoted, Body<'tcx>>,
 196     ) {
 197         (self.source_scope_local_data, self.promoted)
 198     }
 199
 200     fn get_const(&self, local: Local) -> Option<Const<'tcx>> {
 201         let l = &self.ecx.frame().locals[local];
 202
 203         // If the local is `Unitialized` or `Dead` then we haven't propagated a value into it.
 204         //
 205         // `InterpCx::access_local()` mostly takes care of this for us however, for ZSTs,
 206         // it will synthesize a value for us. In doing so, that will cause the
 207         // `get_const(l).is_empty()` assert right before we call `set_const()` in `visit_statement`
 208         // to fail.
 209         if let LocalValue::Uninitialized | LocalValue::Dead = l.value {
 210             return None;
 211         }
 212
 213         self.ecx.access_local(self.ecx.frame(), local, None).ok()
 214     }
 215
 216     fn set_const(&mut self, local: Local, c: Const<'tcx>) {
 217         let frame = self.ecx.frame_mut();
 218
 219         if let Some(layout) = frame.locals[local].layout.get() {
 220             debug_assert_eq!(c.layout, layout);
 221         }
 222
 223         frame.locals[local] = LocalState {
 224             value: LocalValue::Live(*c),
 225             layout: Cell::new(Some(c.layout)),
 226         };
 227     }
 228
 229     fn remove_const(&mut self, local: Local) {
 230         self.ecx.frame_mut().locals[local] = LocalState {
 231             value: LocalValue::Uninitialized,
 232             layout: Cell::new(None),
 233         };
 234     }
 235
 236     fn use_ecx<F, T>(
 237         &mut self,
 238         source_info: SourceInfo,
 239         f: F
 240     ) -> Option<T>
 241     where
 242         F: FnOnce(&mut Self) -> InterpResult<'tcx, T>,
 243     {
 244         self.ecx.tcx.span = source_info.span;
 245         let lint_root = match self.source_scope_local_data {
 246             ClearCrossCrate::Set(ref ivs) => {
 247                 //FIXME(#51314): remove this check
 248                 if source_info.scope.index() >= ivs.len() {
 249                     return None;
 250                 }
 251                 ivs[source_info.scope].lint_root
 252             },
 253             ClearCrossCrate::Clear => return None,
 254         };
 255         let r = match f(self) {
 256             Ok(val) => Some(val),
 257             Err(error) => {
 258                 let diagnostic = error_to_const_error(&self.ecx, error);
 259                 use rustc::mir::interpret::InterpError::*;
 260                 match diagnostic.error {
 261                     Exit(_) => bug!("the CTFE program cannot exit"),
 262                     Panic(_) => {
 263                         diagnostic.report_as_lint(
 264                             self.ecx.tcx,
 265                             "this expression will panic at runtime",
 266                             lint_root,
 267                             None,
 268                         );
 269                     }
 270                     _ => {},
 271                 }
 272                 None
 273             },
 274         };
 275         self.ecx.tcx.span = DUMMY_SP;
 276         r
 277     }
 278
 279     fn eval_constant(
 280         &mut self,
 281         c: &Constant<'tcx>,
 282     ) -> Option<Const<'tcx>> {
 283         self.ecx.tcx.span = c.span;
 284         match self.ecx.eval_const_to_op(c.literal, None) {
 285             Ok(op) => {
 286                 Some(op)
 287             },
 288             Err(error) => {
 289                 let err = error_to_const_error(&self.ecx, error);
 290                 err.report_as_error(self.ecx.tcx, "erroneous constant used");
 291                 None
 292             },
 293         }
 294     }
 295
 296     fn eval_place(&mut self, place: &Place<'tcx>, source_info: SourceInfo) -> Option<Const<'tcx>> {
 297         trace!("eval_place(place={:?})", place);
 298         place.iterate(|place_base, place_projection| {
 299             let mut eval = match place_base {
 300                 PlaceBase::Local(loc) => self.get_const(*loc).clone()?,
 301                 PlaceBase::Static(box Static {kind: StaticKind::Promoted(promoted), ..}) => {
 302                     let generics = self.tcx.generics_of(self.source.def_id());
 303                     if generics.requires_monomorphization(self.tcx) {
 304                         // FIXME: can't handle code with generics
 305                         return None;
 306                     }
 307                     let substs = InternalSubsts::identity_for_item(self.tcx, self.source.def_id());
 308                     let instance = Instance::new(self.source.def_id(), substs);
 309                     let cid = GlobalId {
 310                         instance,
 311                         promoted: Some(*promoted),
 312                     };
 313                     // cannot use `const_eval` here, because that would require having the MIR
 314                     // for the current function available, but we're producing said MIR right now
 315                     let res = self.use_ecx(source_info, |this| {
 316                         let body = &this.promoted[*promoted];
 317                         eval_promoted(this.tcx, cid, body, this.param_env)
 318                     })?;
 319                     trace!("evaluated promoted {:?} to {:?}", promoted, res);
 320                     res.into()
 321                 }
 322                 _ => return None,
 323             };
 324
 325             for proj in place_projection {
 326                 match proj.elem {
 327                     ProjectionElem::Field(field, _) => {
 328                         trace!("field proj on {:?}", proj.base);
 329                         eval = self.use_ecx(source_info, |this| {
 330                             this.ecx.operand_field(eval, field.index() as u64)
 331                         })?;
 332                     },
 333                     ProjectionElem::Deref => {
 334                         trace!("processing deref");
 335                         eval = self.use_ecx(source_info, |this| {
 336                             this.ecx.deref_operand(eval)
 337                         })?.into();
 338                     }
 339                     // We could get more projections by using e.g., `operand_projection`,
 340                     // but we do not even have the stack frame set up properly so
 341                     // an `Index` projection would throw us off-track.
 342                     _ => return None,
 343                 }
 344             }
 345
 346             Some(eval)
 347         })
 348     }
 349
 350     fn eval_operand(&mut self, op: &Operand<'tcx>, source_info: SourceInfo) -> Option<Const<'tcx>> {
 351         match *op {
 352             Operand::Constant(ref c) => self.eval_constant(c),
 353             | Operand::Move(ref place)
 354             | Operand::Copy(ref place) => self.eval_place(place, source_info),
 355         }
 356     }
 357
 358     fn const_prop(
 359         &mut self,
 360         rvalue: &Rvalue<'tcx>,
 361         place_layout: TyLayout<'tcx>,
 362         source_info: SourceInfo,
 363     ) -> Option<Const<'tcx>> {
 364         let span = source_info.span;
 365         match *rvalue {
 366             Rvalue::Use(ref op) => {
 367                 self.eval_operand(op, source_info)
 368             },
 369             Rvalue::Ref(_, _, ref place) => {
 370                 let src = self.eval_place(place, source_info)?;
 371                 let mplace = src.try_as_mplace().ok()?;
 372                 Some(ImmTy::from_scalar(mplace.ptr.into(), place_layout).into())
 373             },
 374             Rvalue::Repeat(..) |
 375             Rvalue::Aggregate(..) |
 376             Rvalue::NullaryOp(NullOp::Box, _) |
 377             Rvalue::Discriminant(..) => None,
 378
 379             Rvalue::Cast(kind, ref operand, _) => {
 380                 let op = self.eval_operand(operand, source_info)?;
 381                 self.use_ecx(source_info, |this| {
 382                     let dest = this.ecx.allocate(place_layout, MemoryKind::Stack);
 383                     this.ecx.cast(op, kind, dest.into())?;
 384                     Ok(dest.into())
 385                 })
 386             },
 387             Rvalue::Len(ref place) => {
 388                 let place = self.eval_place(&place, source_info)?;
 389                 let mplace = place.try_as_mplace().ok()?;
 390
 391                 if let ty::Slice(_) = mplace.layout.ty.sty {
 392                     let len = mplace.meta.unwrap().to_usize(&self.ecx).unwrap();
 393
 394                     Some(ImmTy {
 395                         imm: Immediate::Scalar(
 396                             Scalar::from_uint(
 397                                 len,
 398                                 Size::from_bits(
 399                                     self.tcx.sess.target.usize_ty.bit_width().unwrap() as u64
 400                                 )
 401                             ).into(),
 402                         ),
 403                         layout: self.tcx.layout_of(self.param_env.and(self.tcx.types.usize)).ok()?,
 404                     }.into())
 405                 } else {
 406                     trace!("not slice: {:?}", mplace.layout.ty.sty);
 407                     None
 408                 }
 409             },
 410             Rvalue::NullaryOp(NullOp::SizeOf, ty) => {
 411                 type_size_of(self.tcx, self.param_env, ty).and_then(|n| Some(
 412                     ImmTy {
 413                         imm: Immediate::Scalar(
 414                             Scalar::from_uint(n, self.tcx.data_layout.pointer_size).into()
 415                         ),
 416                         layout: self.tcx.layout_of(self.param_env.and(self.tcx.types.usize)).ok()?,
 417                     }.into()
 418                 ))
 419             }
 420             Rvalue::UnaryOp(op, ref arg) => {
 421                 let def_id = if self.tcx.is_closure(self.source.def_id()) {
 422                     self.tcx.closure_base_def_id(self.source.def_id())
 423                 } else {
 424                     self.source.def_id()
 425                 };
 426                 let generics = self.tcx.generics_of(def_id);
 427                 if generics.requires_monomorphization(self.tcx) {
 428                     // FIXME: can't handle code with generics
 429                     return None;
 430                 }
 431
 432                 let arg = self.eval_operand(arg, source_info)?;
 433                 let val = self.use_ecx(source_info, |this| {
 434                     let prim = this.ecx.read_immediate(arg)?;
 435                     match op {
 436                         UnOp::Neg => {
 437                             // Need to do overflow check here: For actual CTFE, MIR
 438                             // generation emits code that does this before calling the op.
 439                             if prim.to_bits()? == (1 << (prim.layout.size.bits() - 1)) {
 440                                 throw_panic!(OverflowNeg)
 441                             }
 442                         }
 443                         UnOp::Not => {
 444                             // Cannot overflow
 445                         }
 446                     }
 447                     // Now run the actual operation.
 448                     this.ecx.unary_op(op, prim)
 449                 })?;
 450                 let res = ImmTy {
 451                     imm: Immediate::Scalar(val.into()),
 452                     layout: place_layout,
 453                 };
 454                 Some(res.into())
 455             }
 456             Rvalue::CheckedBinaryOp(op, ref left, ref right) |
 457             Rvalue::BinaryOp(op, ref left, ref right) => {
 458                 trace!("rvalue binop {:?} for {:?} and {:?}", op, left, right);
 459                 let right = self.eval_operand(right, source_info)?;
 460                 let def_id = if self.tcx.is_closure(self.source.def_id()) {
 461                     self.tcx.closure_base_def_id(self.source.def_id())
 462                 } else {
 463                     self.source.def_id()
 464                 };
 465                 let generics = self.tcx.generics_of(def_id);
 466                 if generics.requires_monomorphization(self.tcx) {
 467                     // FIXME: can't handle code with generics
 468                     return None;
 469                 }
 470
 471                 let r = self.use_ecx(source_info, |this| {
 472                     this.ecx.read_immediate(right)
 473                 })?;
 474                 if op == BinOp::Shr || op == BinOp::Shl {
 475                     let left_ty = left.ty(&self.local_decls, self.tcx);
 476                     let left_bits = self
 477                         .tcx
 478                         .layout_of(self.param_env.and(left_ty))
 479                         .unwrap()
 480                         .size
 481                         .bits();
 482                     let right_size = right.layout.size;
 483                     let r_bits = r.to_scalar().and_then(|r| r.to_bits(right_size));
 484                     if r_bits.ok().map_or(false, |b| b >= left_bits as u128) {
 485                         let source_scope_local_data = match self.source_scope_local_data {
 486                             ClearCrossCrate::Set(ref data) => data,
 487                             ClearCrossCrate::Clear => return None,
 488                         };
 489                         let dir = if op == BinOp::Shr {
 490                             "right"
 491                         } else {
 492                             "left"
 493                         };
 494                         let hir_id = source_scope_local_data[source_info.scope].lint_root;
 495                         self.tcx.lint_hir(
 496                             ::rustc::lint::builtin::EXCEEDING_BITSHIFTS,
 497                             hir_id,
 498                             span,
 499                             &format!("attempt to shift {} with overflow", dir));
 500                         return None;
 501                     }
 502                 }
 503                 let left = self.eval_operand(left, source_info)?;
 504                 let l = self.use_ecx(source_info, |this| {
 505                     this.ecx.read_immediate(left)
 506                 })?;
 507                 trace!("const evaluating {:?} for {:?} and {:?}", op, left, right);
 508                 let (val, overflow) = self.use_ecx(source_info, |this| {
 509                     this.ecx.binary_op(op, l, r)
 510                 })?;
 511                 let val = if let Rvalue::CheckedBinaryOp(..) = *rvalue {
 512                     Immediate::ScalarPair(
 513                         val.into(),
 514                         Scalar::from_bool(overflow).into(),
 515                     )
 516                 } else {
 517                     if overflow {
 518                         let err = err_panic!(Overflow(op)).into();
 519                         let _: Option<()> = self.use_ecx(source_info, |_| Err(err));
 520                         return None;
 521                     }
 522                     Immediate::Scalar(val.into())
 523                 };
 524                 let res = ImmTy {
 525                     imm: val,
 526                     layout: place_layout,
 527                 };
 528                 Some(res.into())
 529             },
 530         }
 531     }
 532
 533     fn operand_from_scalar(&self, scalar: Scalar, ty: Ty<'tcx>, span: Span) -> Operand<'tcx> {
 534         Operand::Constant(Box::new(
 535             Constant {
 536                 span,
 537                 ty,
 538                 user_ty: None,
 539                 literal: self.tcx.mk_const(*ty::Const::from_scalar(
 540                     self.tcx,
 541                     scalar,
 542                     ty,
 543                 ))
 544             }
 545         ))
 546     }
 547
 548     fn replace_with_const(
 549         &mut self,
 550         rval: &mut Rvalue<'tcx>,
 551         value: Const<'tcx>,
 552         source_info: SourceInfo,
 553     ) {
 554         trace!("attepting to replace {:?} with {:?}", rval, value);
 555         if let Err(e) = self.ecx.validate_operand(
 556             value,
 557             vec![],
 558             // FIXME: is ref tracking too expensive?
 559             Some(&mut interpret::RefTracking::empty()),
 560         ) {
 561             trace!("validation error, attempt failed: {:?}", e);
 562             return;
 563         }
 564
 565         // FIXME> figure out what tho do when try_read_immediate fails
 566         let imm = self.use_ecx(source_info, |this| {
 567             this.ecx.try_read_immediate(value)
 568         });
 569
 570         if let Some(Ok(imm)) = imm {
 571             match *imm {
 572                 interpret::Immediate::Scalar(ScalarMaybeUndef::Scalar(scalar)) => {
 573                     *rval = Rvalue::Use(
 574                         self.operand_from_scalar(scalar, value.layout.ty, source_info.span));
 575                 },
 576                 Immediate::ScalarPair(
 577                     ScalarMaybeUndef::Scalar(one),
 578                     ScalarMaybeUndef::Scalar(two)
 579                 ) => {
 580                     let ty = &value.layout.ty.sty;
 581                     if let ty::Tuple(substs) = ty {
 582                         *rval = Rvalue::Aggregate(
 583                             Box::new(AggregateKind::Tuple),
 584                             vec![
 585                                 self.operand_from_scalar(
 586                                     one, substs[0].expect_ty(), source_info.span
 587                                 ),
 588                                 self.operand_from_scalar(
 589                                     two, substs[1].expect_ty(), source_info.span
 590                                 ),
 591                             ],
 592                         );
 593                     }
 594                 },
 595                 _ => { }
 596             }
 597         }
 598     }
 599
 600     fn should_const_prop(&self) -> bool {
 601         self.tcx.sess.opts.debugging_opts.mir_opt_level >= 2
 602     }
 603 }
 604
 605 fn type_size_of<'tcx>(
 606     tcx: TyCtxt<'tcx>,
 607     param_env: ty::ParamEnv<'tcx>,
 608     ty: Ty<'tcx>,
 609 ) -> Option<u64> {
 610     tcx.layout_of(param_env.and(ty)).ok().map(|layout| layout.size.bytes())
 611 }
 612
 613 struct CanConstProp {
 614     can_const_prop: IndexVec<Local, bool>,
 615     // false at the beginning, once set, there are not allowed to be any more assignments
 616     found_assignment: IndexVec<Local, bool>,
 617 }
 618
 619 impl CanConstProp {
 620     /// returns true if `local` can be propagated
 621     fn check(body: &Body<'_>) -> IndexVec<Local, bool> {
 622         let mut cpv = CanConstProp {
 623             can_const_prop: IndexVec::from_elem(true, &body.local_decls),
 624             found_assignment: IndexVec::from_elem(false, &body.local_decls),
 625         };
 626         for (local, val) in cpv.can_const_prop.iter_enumerated_mut() {
 627             // cannot use args at all
 628             // cannot use locals because if x < y { y - x } else { x - y } would
 629             //        lint for x != y
 630             // FIXME(oli-obk): lint variables until they are used in a condition
 631             // FIXME(oli-obk): lint if return value is constant
 632             *val = body.local_kind(local) == LocalKind::Temp;
 633
 634             if !*val {
 635                 trace!("local {:?} can't be propagated because it's not a temporary", local);
 636             }
 637         }
 638         cpv.visit_body(body);
 639         cpv.can_const_prop
 640     }
 641 }
 642
 643 impl<'tcx> Visitor<'tcx> for CanConstProp {
 644     fn visit_local(
 645         &mut self,
 646         &local: &Local,
 647         context: PlaceContext,
 648         _: Location,
 649     ) {
 650         use rustc::mir::visit::PlaceContext::*;
 651         match context {
 652             // Constants must have at most one write
 653             // FIXME(oli-obk): we could be more powerful here, if the multiple writes
 654             // only occur in independent execution paths
 655             MutatingUse(MutatingUseContext::Store) => if self.found_assignment[local] {
 656                 trace!("local {:?} can't be propagated because of multiple assignments", local);
 657                 self.can_const_prop[local] = false;
 658             } else {
 659                 self.found_assignment[local] = true
 660             },
 661             // Reading constants is allowed an arbitrary number of times
 662             NonMutatingUse(NonMutatingUseContext::Copy) |
 663             NonMutatingUse(NonMutatingUseContext::Move) |
 664             NonMutatingUse(NonMutatingUseContext::Inspect) |
 665             NonMutatingUse(NonMutatingUseContext::Projection) |
 666             MutatingUse(MutatingUseContext::Projection) |
 667             NonUse(_) => {},
 668             _ => {
 669                 trace!("local {:?} can't be propagaged because it's used: {:?}", local, context);
 670                 self.can_const_prop[local] = false;
 671             },
 672         }
 673     }
 674 }
 675
 676 impl<'mir, 'tcx> MutVisitor<'tcx> for ConstPropagator<'mir, 'tcx> {
 677     fn visit_constant(
 678         &mut self,
 679         constant: &mut Constant<'tcx>,
 680         location: Location,
 681     ) {
 682         trace!("visit_constant: {:?}", constant);
 683         self.super_constant(constant, location);
 684         self.eval_constant(constant);
 685     }
 686
 687     fn visit_statement(
 688         &mut self,
 689         statement: &mut Statement<'tcx>,
 690         location: Location,
 691     ) {
 692         trace!("visit_statement: {:?}", statement);
 693         if let StatementKind::Assign(ref place, ref mut rval) = statement.kind {
 694             let place_ty: Ty<'tcx> = place
 695                 .ty(&self.local_decls, self.tcx)
 696                 .ty;
 697             if let Ok(place_layout) = self.tcx.layout_of(self.param_env.and(place_ty)) {
 698                 if let Some(value) = self.const_prop(rval, place_layout, statement.source_info) {
 699                     if let Place {
 700                         base: PlaceBase::Local(local),
 701                         projection: None,
 702                     } = *place {
 703                         trace!("checking whether {:?} can be stored to {:?}", value, local);
 704                         if self.can_const_prop[local] {
 705                             trace!("storing {:?} to {:?}", value, local);
 706                             assert!(self.get_const(local).is_none());
 707                             self.set_const(local, value);
 708
 709                             if self.should_const_prop() {
 710                                 self.replace_with_const(
 711                                     rval,
 712                                     value,
 713                                     statement.source_info,
 714                                 );
 715                             }
 716                         }
 717                     }
 718                 }
 719             }
 720         }
 721         self.super_statement(statement, location);
 722     }
 723
 724     fn visit_terminator(
 725         &mut self,
 726         terminator: &mut Terminator<'tcx>,
 727         location: Location,
 728     ) {
 729         self.super_terminator(terminator, location);
 730         let source_info = terminator.source_info;
 731         match &mut terminator.kind {
 732             TerminatorKind::Assert { expected, ref msg, ref mut cond, .. } => {
 733                 if let Some(value) = self.eval_operand(&cond, source_info) {
 734                     trace!("assertion on {:?} should be {:?}", value, expected);
 735                     let expected = ScalarMaybeUndef::from(Scalar::from_bool(*expected));
 736                     let value_const = self.ecx.read_scalar(value).unwrap();
 737                     if expected != value_const {
 738                         // poison all places this operand references so that further code
 739                         // doesn't use the invalid value
 740                         match cond {
 741                             Operand::Move(ref place) | Operand::Copy(ref place) => {
 742                                 if let PlaceBase::Local(local) = place.base {
 743                                     self.remove_const(local);
 744                                 }
 745                             },
 746                             Operand::Constant(_) => {}
 747                         }
 748                         let span = terminator.source_info.span;
 749                         let hir_id = self
 750                             .tcx
 751                             .hir()
 752                             .as_local_hir_id(self.source.def_id())
 753                             .expect("some part of a failing const eval must be local");
 754                         let msg = match msg {
 755                             PanicInfo::Overflow(_) |
 756                             PanicInfo::OverflowNeg |
 757                             PanicInfo::DivisionByZero |
 758                             PanicInfo::RemainderByZero =>
 759                                 msg.description().to_owned(),
 760                             PanicInfo::BoundsCheck { ref len, ref index } => {
 761                                 let len = self
 762                                     .eval_operand(len, source_info)
 763                                     .expect("len must be const");
 764                                 let len = match self.ecx.read_scalar(len) {
 765                                     Ok(ScalarMaybeUndef::Scalar(Scalar::Raw {
 766                                         data, ..
 767                                     })) => data,
 768                                     other => bug!("const len not primitive: {:?}", other),
 769                                 };
 770                                 let index = self
 771                                     .eval_operand(index, source_info)
 772                                     .expect("index must be const");
 773                                 let index = match self.ecx.read_scalar(index) {
 774                                     Ok(ScalarMaybeUndef::Scalar(Scalar::Raw {
 775                                         data, ..
 776                                     })) => data,
 777                                     other => bug!("const index not primitive: {:?}", other),
 778                                 };
 779                                 format!(
 780                                     "index out of bounds: \
 781                                     the len is {} but the index is {}",
 782                                     len,
 783                                     index,
 784                                 )
 785                             },
 786                             // Need proper const propagator for these
 787                             _ => return,
 788                         };
 789                         self.tcx.lint_hir(
 790                             ::rustc::lint::builtin::CONST_ERR,
 791                             hir_id,
 792                             span,
 793                             &msg,
 794                         );
 795                     } else {
 796                         if self.should_const_prop() {
 797                             if let ScalarMaybeUndef::Scalar(scalar) = value_const {
 798                                 *cond = self.operand_from_scalar(
 799                                     scalar,
 800                                     self.tcx.types.bool,
 801                                     source_info.span,
 802                                 );
 803                             }
 804                         }
 805                     }
 806                 }
 807             },
 808             TerminatorKind::SwitchInt { ref mut discr, switch_ty, .. } => {
 809                 if self.should_const_prop() {
 810                     if let Some(value) = self.eval_operand(&discr, source_info) {
 811                         if let ScalarMaybeUndef::Scalar(scalar) =
 812                                 self.ecx.read_scalar(value).unwrap() {
 813                             *discr = self.operand_from_scalar(scalar, switch_ty, source_info.span);
 814                         }
 815                     }
 816                 }
 817             },
 818             //none of these have Operands to const-propagate
 819             TerminatorKind::Goto { .. } |
 820             TerminatorKind::Resume |
 821             TerminatorKind::Abort |
 822             TerminatorKind::Return |
 823             TerminatorKind::Unreachable |
 824             TerminatorKind::Drop { .. } |
 825             TerminatorKind::DropAndReplace { .. } |
 826             TerminatorKind::Yield { .. } |
 827             TerminatorKind::GeneratorDrop |
 828             TerminatorKind::FalseEdges { .. } |
 829             TerminatorKind::FalseUnwind { .. } => { }
 830             //FIXME(wesleywiser) Call does have Operands that could be const-propagated
 831             TerminatorKind::Call { .. } => { }
 832         }
 833     }
 834 }