1 //! Propagates constants for early reporting of statically known
6 use rustc::hir::def::DefKind;
8 AggregateKind, Constant, Location, Place, PlaceBase, Body, Operand, Rvalue,
9 Local, NullOp, UnOp, StatementKind, Statement, LocalKind,
10 TerminatorKind, Terminator, ClearCrossCrate, SourceInfo, BinOp,
11 SourceScope, SourceScopeLocalData, LocalDecl,
13 use rustc::mir::visit::{
14 Visitor, PlaceContext, MutatingUseContext, MutVisitor, NonMutatingUseContext,
16 use rustc::mir::interpret::{Scalar, 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,
25 use crate::interpret::{
26 self, InterpCx, ScalarMaybeUndef, Immediate, OpTy,
27 ImmTy, StackPopCleanup, LocalValue, LocalState,
29 use crate::const_eval::{
30 CompileTimeInterpreter, error_to_const_error, mk_eval_cx,
32 use crate::transform::{MirPass, MirSource};
36 impl<'tcx> MirPass<'tcx> for ConstProp {
37 fn run_pass(&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() {
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");
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,
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());
60 trace!("ConstProp starting for {:?}", source.def_id());
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
70 body.basic_blocks().clone(),
72 ClearCrossCrate::Clear,
74 body.local_decls.clone(),
78 tcx.def_span(source.def_id()),
82 // FIXME(oli-obk, eddyb) Optimize locals (or even local paths) to hold
83 // constants, instead of just checking for const-folding succeeding.
84 // That would require an uniform one-def no-mutation analysis
85 // and RPO (or recursing when needing the value of a local).
86 let mut optimization_finder = ConstPropagator::new(
89 source_scope_local_data,
93 optimization_finder.visit_body(body);
95 // put back the data we stole from `mir`
96 let source_scope_local_data = optimization_finder.release_stolen_data();
98 &mut body.source_scope_local_data,
99 source_scope_local_data
102 trace!("ConstProp done for {:?}", source.def_id());
106 type Const<'tcx> = OpTy<'tcx>;
108 /// Finds optimization opportunities on the MIR.
109 struct ConstPropagator<'mir, 'tcx> {
110 ecx: InterpCx<'mir, 'tcx, CompileTimeInterpreter<'mir, 'tcx>>,
112 source: MirSource<'tcx>,
113 can_const_prop: IndexVec<Local, bool>,
114 param_env: ParamEnv<'tcx>,
115 source_scope_local_data: ClearCrossCrate<IndexVec<SourceScope, SourceScopeLocalData>>,
116 local_decls: IndexVec<Local, LocalDecl<'tcx>>,
119 impl<'mir, 'tcx> LayoutOf for ConstPropagator<'mir, 'tcx> {
121 type TyLayout = Result<TyLayout<'tcx>, LayoutError<'tcx>>;
123 fn layout_of(&self, ty: Ty<'tcx>) -> Self::TyLayout {
124 self.tcx.layout_of(self.param_env.and(ty))
128 impl<'mir, 'tcx> HasDataLayout for ConstPropagator<'mir, 'tcx> {
130 fn data_layout(&self) -> &TargetDataLayout {
131 &self.tcx.data_layout
135 impl<'mir, 'tcx> HasTyCtxt<'tcx> for ConstPropagator<'mir, 'tcx> {
137 fn tcx(&self) -> TyCtxt<'tcx> {
142 impl<'mir, 'tcx> ConstPropagator<'mir, 'tcx> {
145 dummy_body: &'mir Body<'tcx>,
146 source_scope_local_data: ClearCrossCrate<IndexVec<SourceScope, SourceScopeLocalData>>,
148 source: MirSource<'tcx>,
149 ) -> ConstPropagator<'mir, 'tcx> {
150 let def_id = source.def_id();
151 let param_env = tcx.param_env(def_id);
152 let span = tcx.def_span(def_id);
153 let mut ecx = mk_eval_cx(tcx, span, param_env);
154 let can_const_prop = CanConstProp::check(body);
156 ecx.push_stack_frame(
157 Instance::new(def_id, &InternalSubsts::identity_for_item(tcx, def_id)),
161 StackPopCleanup::None {
164 ).expect("failed to push initial stack frame");
172 source_scope_local_data,
173 //FIXME(wesleywiser) we can't steal this because `Visitor::super_visit_body()` needs it
174 local_decls: body.local_decls.clone(),
178 fn release_stolen_data(self) -> ClearCrossCrate<IndexVec<SourceScope, SourceScopeLocalData>> {
179 self.source_scope_local_data
182 fn get_const(&self, local: Local) -> Option<Const<'tcx>> {
183 let l = &self.ecx.frame().locals[local];
185 // If the local is `Unitialized` or `Dead` then we haven't propagated a value into it.
187 // `InterpCx::access_local()` mostly takes care of this for us however, for ZSTs,
188 // it will synthesize a value for us. In doing so, that will cause the
189 // `get_const(l).is_empty()` assert right before we call `set_const()` in `visit_statement`
191 if let LocalValue::Uninitialized | LocalValue::Dead = l.value {
195 self.ecx.access_local(self.ecx.frame(), local, None).ok()
198 fn set_const(&mut self, local: Local, c: Const<'tcx>) {
199 let frame = self.ecx.frame_mut();
201 if let Some(layout) = frame.locals[local].layout.get() {
202 debug_assert_eq!(c.layout, layout);
205 frame.locals[local] = LocalState {
206 value: LocalValue::Live(*c),
207 layout: Cell::new(Some(c.layout)),
211 fn remove_const(&mut self, local: Local) {
212 self.ecx.frame_mut().locals[local] = LocalState {
213 value: LocalValue::Uninitialized,
214 layout: Cell::new(None),
220 source_info: SourceInfo,
224 F: FnOnce(&mut Self) -> InterpResult<'tcx, T>,
226 self.ecx.tcx.span = source_info.span;
227 let lint_root = match self.source_scope_local_data {
228 ClearCrossCrate::Set(ref ivs) => {
229 //FIXME(#51314): remove this check
230 if source_info.scope.index() >= ivs.len() {
233 ivs[source_info.scope].lint_root
235 ClearCrossCrate::Clear => return None,
237 let r = match f(self) {
238 Ok(val) => Some(val),
240 use rustc::mir::interpret::InterpError::*;
242 Exit(_) => bug!("the CTFE program cannot exit"),
244 | UndefinedBehavior(_)
246 | ResourceExhaustion(_) => {
247 // Ignore these errors.
250 let diagnostic = error_to_const_error(&self.ecx, error);
251 diagnostic.report_as_lint(
253 "this expression will panic at runtime",
262 self.ecx.tcx.span = DUMMY_SP;
269 ) -> Option<Const<'tcx>> {
270 self.ecx.tcx.span = c.span;
271 match self.ecx.eval_const_to_op(c.literal, None) {
276 let err = error_to_const_error(&self.ecx, error);
277 err.report_as_error(self.ecx.tcx, "erroneous constant used");
283 fn eval_place(&mut self, place: &Place<'tcx>, source_info: SourceInfo) -> Option<Const<'tcx>> {
284 trace!("eval_place(place={:?})", place);
285 self.use_ecx(source_info, |this| {
286 this.ecx.eval_place_to_op(place, None)
290 fn eval_operand(&mut self, op: &Operand<'tcx>, source_info: SourceInfo) -> Option<Const<'tcx>> {
292 Operand::Constant(ref c) => self.eval_constant(c),
293 | Operand::Move(ref place)
294 | Operand::Copy(ref place) => self.eval_place(place, source_info),
300 rvalue: &Rvalue<'tcx>,
301 place_layout: TyLayout<'tcx>,
302 source_info: SourceInfo,
304 ) -> Option<Const<'tcx>> {
305 let span = source_info.span;
309 Rvalue::Cast(..) => {
310 self.use_ecx(source_info, |this| {
311 this.ecx.eval_rvalue_into_place(rvalue, place)?;
312 this.ecx.eval_place_to_op(place, Some(place_layout))
315 Rvalue::Ref(_, _, ref place) => {
316 let src = self.eval_place(place, source_info)?;
317 let mplace = src.try_as_mplace().ok()?;
318 Some(ImmTy::from_scalar(mplace.ptr.into(), place_layout).into())
321 Rvalue::Aggregate(..) |
322 Rvalue::NullaryOp(NullOp::Box, _) |
323 Rvalue::Discriminant(..) => None,
325 Rvalue::NullaryOp(NullOp::SizeOf, ty) => {
326 type_size_of(self.tcx, self.param_env, ty).and_then(|n| Some(
329 self.tcx.layout_of(self.param_env.and(self.tcx.types.usize)).ok()?,
333 Rvalue::UnaryOp(op, ref arg) => {
334 let def_id = if self.tcx.is_closure(self.source.def_id()) {
335 self.tcx.closure_base_def_id(self.source.def_id())
339 let generics = self.tcx.generics_of(def_id);
340 if generics.requires_monomorphization(self.tcx) {
341 // FIXME: can't handle code with generics
345 let arg = self.eval_operand(arg, source_info)?;
346 let oflo_check = self.tcx.sess.overflow_checks();
347 let val = self.use_ecx(source_info, |this| {
348 let prim = this.ecx.read_immediate(arg)?;
351 // We check overflow in debug mode already
352 // so should only check in release mode.
354 && prim.layout.ty.is_signed()
355 && prim.to_bits()? == (1 << (prim.layout.size.bits() - 1)) {
356 throw_panic!(OverflowNeg)
363 // Now run the actual operation.
364 this.ecx.unary_op(op, prim)
368 Rvalue::CheckedBinaryOp(op, ref left, ref right) |
369 Rvalue::BinaryOp(op, ref left, ref right) => {
370 trace!("rvalue binop {:?} for {:?} and {:?}", op, left, right);
371 let right = self.eval_operand(right, source_info)?;
372 let def_id = if self.tcx.is_closure(self.source.def_id()) {
373 self.tcx.closure_base_def_id(self.source.def_id())
377 let generics = self.tcx.generics_of(def_id);
378 if generics.requires_monomorphization(self.tcx) {
379 // FIXME: can't handle code with generics
383 let r = self.use_ecx(source_info, |this| {
384 this.ecx.read_immediate(right)
386 if op == BinOp::Shr || op == BinOp::Shl {
387 let left_ty = left.ty(&self.local_decls, self.tcx);
390 .layout_of(self.param_env.and(left_ty))
394 let right_size = right.layout.size;
395 let r_bits = r.to_scalar().and_then(|r| r.to_bits(right_size));
396 if r_bits.ok().map_or(false, |b| b >= left_bits as u128) {
397 let source_scope_local_data = match self.source_scope_local_data {
398 ClearCrossCrate::Set(ref data) => data,
399 ClearCrossCrate::Clear => return None,
401 let dir = if op == BinOp::Shr {
406 let hir_id = source_scope_local_data[source_info.scope].lint_root;
408 ::rustc::lint::builtin::EXCEEDING_BITSHIFTS,
411 &format!("attempt to shift {} with overflow", dir));
415 let left = self.eval_operand(left, source_info)?;
416 let l = self.use_ecx(source_info, |this| {
417 this.ecx.read_immediate(left)
419 trace!("const evaluating {:?} for {:?} and {:?}", op, left, right);
420 let (val, overflow, _ty) = self.use_ecx(source_info, |this| {
421 this.ecx.overflowing_binary_op(op, l, r)
423 let val = if let Rvalue::CheckedBinaryOp(..) = *rvalue {
424 Immediate::ScalarPair(
426 Scalar::from_bool(overflow).into(),
429 // We check overflow in debug mode already
430 // so should only check in release mode.
431 if !self.tcx.sess.overflow_checks() && overflow {
432 let err = err_panic!(Overflow(op)).into();
433 let _: Option<()> = self.use_ecx(source_info, |_| Err(err));
436 Immediate::Scalar(val.into())
440 layout: place_layout,
447 fn operand_from_scalar(&self, scalar: Scalar, ty: Ty<'tcx>, span: Span) -> Operand<'tcx> {
448 Operand::Constant(Box::new(
452 literal: self.tcx.mk_const(*ty::Const::from_scalar(
461 fn replace_with_const(
463 rval: &mut Rvalue<'tcx>,
465 source_info: SourceInfo,
467 trace!("attepting to replace {:?} with {:?}", rval, value);
468 if let Err(e) = self.ecx.validate_operand(
471 // FIXME: is ref tracking too expensive?
472 Some(&mut interpret::RefTracking::empty()),
474 trace!("validation error, attempt failed: {:?}", e);
478 // FIXME> figure out what tho do when try_read_immediate fails
479 let imm = self.use_ecx(source_info, |this| {
480 this.ecx.try_read_immediate(value)
483 if let Some(Ok(imm)) = imm {
485 interpret::Immediate::Scalar(ScalarMaybeUndef::Scalar(scalar)) => {
487 self.operand_from_scalar(scalar, value.layout.ty, source_info.span));
489 Immediate::ScalarPair(
490 ScalarMaybeUndef::Scalar(one),
491 ScalarMaybeUndef::Scalar(two)
493 let ty = &value.layout.ty.kind;
494 if let ty::Tuple(substs) = ty {
495 *rval = Rvalue::Aggregate(
496 Box::new(AggregateKind::Tuple),
498 self.operand_from_scalar(
499 one, substs[0].expect_ty(), source_info.span
501 self.operand_from_scalar(
502 two, substs[1].expect_ty(), source_info.span
513 fn should_const_prop(&self) -> bool {
514 self.tcx.sess.opts.debugging_opts.mir_opt_level >= 2
518 fn type_size_of<'tcx>(
520 param_env: ty::ParamEnv<'tcx>,
523 tcx.layout_of(param_env.and(ty)).ok().map(|layout| layout.size.bytes())
526 struct CanConstProp {
527 can_const_prop: IndexVec<Local, bool>,
528 // false at the beginning, once set, there are not allowed to be any more assignments
529 found_assignment: IndexVec<Local, bool>,
533 /// returns true if `local` can be propagated
534 fn check(body: &Body<'_>) -> IndexVec<Local, bool> {
535 let mut cpv = CanConstProp {
536 can_const_prop: IndexVec::from_elem(true, &body.local_decls),
537 found_assignment: IndexVec::from_elem(false, &body.local_decls),
539 for (local, val) in cpv.can_const_prop.iter_enumerated_mut() {
540 // cannot use args at all
541 // cannot use locals because if x < y { y - x } else { x - y } would
543 // FIXME(oli-obk): lint variables until they are used in a condition
544 // FIXME(oli-obk): lint if return value is constant
545 *val = body.local_kind(local) == LocalKind::Temp;
548 trace!("local {:?} can't be propagated because it's not a temporary", local);
551 cpv.visit_body(body);
556 impl<'tcx> Visitor<'tcx> for CanConstProp {
560 context: PlaceContext,
563 use rustc::mir::visit::PlaceContext::*;
565 // Constants must have at most one write
566 // FIXME(oli-obk): we could be more powerful here, if the multiple writes
567 // only occur in independent execution paths
568 MutatingUse(MutatingUseContext::Store) => if self.found_assignment[local] {
569 trace!("local {:?} can't be propagated because of multiple assignments", local);
570 self.can_const_prop[local] = false;
572 self.found_assignment[local] = true
574 // Reading constants is allowed an arbitrary number of times
575 NonMutatingUse(NonMutatingUseContext::Copy) |
576 NonMutatingUse(NonMutatingUseContext::Move) |
577 NonMutatingUse(NonMutatingUseContext::Inspect) |
578 NonMutatingUse(NonMutatingUseContext::Projection) |
579 MutatingUse(MutatingUseContext::Projection) |
582 trace!("local {:?} can't be propagaged because it's used: {:?}", local, context);
583 self.can_const_prop[local] = false;
589 impl<'mir, 'tcx> MutVisitor<'tcx> for ConstPropagator<'mir, 'tcx> {
592 constant: &mut Constant<'tcx>,
595 trace!("visit_constant: {:?}", constant);
596 self.super_constant(constant, location);
597 self.eval_constant(constant);
602 statement: &mut Statement<'tcx>,
605 trace!("visit_statement: {:?}", statement);
606 if let StatementKind::Assign(box(ref place, ref mut rval)) = statement.kind {
607 let place_ty: Ty<'tcx> = place
608 .ty(&self.local_decls, self.tcx)
610 if let Ok(place_layout) = self.tcx.layout_of(self.param_env.and(place_ty)) {
612 base: PlaceBase::Local(local),
615 if let Some(value) = self.const_prop(rval, place_layout, statement.source_info, place) {
616 trace!("checking whether {:?} can be stored to {:?}", value, local);
617 if self.can_const_prop[local] {
618 trace!("storing {:?} to {:?}", value, local);
619 assert!(self.get_const(local).is_none() || self.get_const(local) == Some(value));
620 self.set_const(local, value);
622 if self.should_const_prop() {
623 self.replace_with_const(
626 statement.source_info,
633 } else if let StatementKind::StorageLive(local) = statement.kind {
634 if self.can_const_prop[local] {
635 let frame = self.ecx.frame_mut();
637 frame.locals[local].value = LocalValue::Uninitialized;
639 } else if let StatementKind::StorageDead(local) = statement.kind {
640 if self.can_const_prop[local] {
641 let frame = self.ecx.frame_mut();
643 frame.locals[local].value = LocalValue::Dead;
646 self.super_statement(statement, location);
651 terminator: &mut Terminator<'tcx>,
654 self.super_terminator(terminator, location);
655 let source_info = terminator.source_info;
656 match &mut terminator.kind {
657 TerminatorKind::Assert { expected, ref msg, ref mut cond, .. } => {
658 if let Some(value) = self.eval_operand(&cond, source_info) {
659 trace!("assertion on {:?} should be {:?}", value, expected);
660 let expected = ScalarMaybeUndef::from(Scalar::from_bool(*expected));
661 let value_const = self.ecx.read_scalar(value).unwrap();
662 if expected != value_const {
663 // poison all places this operand references so that further code
664 // doesn't use the invalid value
666 Operand::Move(ref place) | Operand::Copy(ref place) => {
667 if let PlaceBase::Local(local) = place.base {
668 self.remove_const(local);
671 Operand::Constant(_) => {}
673 let span = terminator.source_info.span;
677 .as_local_hir_id(self.source.def_id())
678 .expect("some part of a failing const eval must be local");
679 let msg = match msg {
680 PanicInfo::Overflow(_) |
681 PanicInfo::OverflowNeg |
682 PanicInfo::DivisionByZero |
683 PanicInfo::RemainderByZero =>
684 msg.description().to_owned(),
685 PanicInfo::BoundsCheck { ref len, ref index } => {
687 .eval_operand(len, source_info)
688 .expect("len must be const");
689 let len = match self.ecx.read_scalar(len) {
690 Ok(ScalarMaybeUndef::Scalar(Scalar::Raw {
693 other => bug!("const len not primitive: {:?}", other),
696 .eval_operand(index, source_info)
697 .expect("index must be const");
698 let index = match self.ecx.read_scalar(index) {
699 Ok(ScalarMaybeUndef::Scalar(Scalar::Raw {
702 other => bug!("const index not primitive: {:?}", other),
705 "index out of bounds: \
706 the len is {} but the index is {}",
711 // Need proper const propagator for these
715 ::rustc::lint::builtin::CONST_ERR,
721 if self.should_const_prop() {
722 if let ScalarMaybeUndef::Scalar(scalar) = value_const {
723 *cond = self.operand_from_scalar(
733 TerminatorKind::SwitchInt { ref mut discr, switch_ty, .. } => {
734 if self.should_const_prop() {
735 if let Some(value) = self.eval_operand(&discr, source_info) {
736 if let ScalarMaybeUndef::Scalar(scalar) =
737 self.ecx.read_scalar(value).unwrap() {
738 *discr = self.operand_from_scalar(scalar, switch_ty, source_info.span);
743 //none of these have Operands to const-propagate
744 TerminatorKind::Goto { .. } |
745 TerminatorKind::Resume |
746 TerminatorKind::Abort |
747 TerminatorKind::Return |
748 TerminatorKind::Unreachable |
749 TerminatorKind::Drop { .. } |
750 TerminatorKind::DropAndReplace { .. } |
751 TerminatorKind::Yield { .. } |
752 TerminatorKind::GeneratorDrop |
753 TerminatorKind::FalseEdges { .. } |
754 TerminatorKind::FalseUnwind { .. } => { }
755 //FIXME(wesleywiser) Call does have Operands that could be const-propagated
756 TerminatorKind::Call { .. } => { }