src/librustc_mir/transform/qualify_consts.rs

   1 // Copyright 2016 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 //! A pass that qualifies constness of temporaries in constants,
  12 //! static initializers and functions and also drives promotion.
  13 //!
  14 //! The Qualif flags below can be used to also provide better
  15 //! diagnostics as to why a constant rvalue wasn't promoted.
  16
  17 use rustc_data_structures::bitvec::BitArray;
  18 use rustc_data_structures::indexed_set::IdxSetBuf;
  19 use rustc_data_structures::indexed_vec::{IndexVec, Idx};
  20 use rustc_data_structures::fx::FxHashSet;
  21 use rustc::hir;
  22 use rustc::hir::def_id::DefId;
  23 use rustc::mir::interpret::ConstValue;
  24 use rustc::traits::{self, TraitEngine};
  25 use rustc::ty::{self, TyCtxt, Ty, TypeFoldable};
  26 use rustc::ty::cast::CastTy;
  27 use rustc::ty::query::Providers;
  28 use rustc::mir::*;
  29 use rustc::mir::traversal::ReversePostorder;
  30 use rustc::mir::visit::{PlaceContext, Visitor};
  31 use rustc::middle::lang_items;
  32 use rustc_target::spec::abi::Abi;
  33 use syntax::attr;
  34 use syntax::ast::LitKind;
  35 use syntax::feature_gate::{UnstableFeatures, feature_err, emit_feature_err, GateIssue};
  36 use syntax_pos::{Span, DUMMY_SP};
  37
  38 use std::fmt;
  39 use rustc_data_structures::sync::Lrc;
  40 use std::usize;
  41
  42 use transform::{MirPass, MirSource};
  43 use super::promote_consts::{self, Candidate, TempState};
  44
  45 bitflags! {
  46     // Borrows of temporaries can be promoted only if
  47     // they have none of these qualifications, with
  48     // the exception of `STATIC_REF` (in statics only).
  49     struct Qualif: u8 {
  50         // Constant containing interior mutability (UnsafeCell).
  51         const MUTABLE_INTERIOR  = 1 << 0;
  52
  53         // Constant containing an ADT that implements Drop.
  54         const NEEDS_DROP        = 1 << 1;
  55
  56         // Function argument.
  57         const FN_ARGUMENT       = 1 << 2;
  58
  59         // Not constant at all - non-`const fn` calls, asm!,
  60         // pointer comparisons, ptr-to-int casts, etc.
  61         const NOT_CONST         = 1 << 3;
  62
  63         // Refers to temporaries which cannot be promoted as
  64         // promote_consts decided they weren't simple enough.
  65         const NOT_PROMOTABLE    = 1 << 4;
  66
  67         // Const items can only have MUTABLE_INTERIOR
  68         // and NOT_PROMOTABLE without producing an error.
  69         const CONST_ERROR       = !Qualif::MUTABLE_INTERIOR.bits &
  70                                   !Qualif::NOT_PROMOTABLE.bits;
  71     }
  72 }
  73
  74 impl<'a, 'tcx> Qualif {
  75     /// Remove flags which are impossible for the given type.
  76     fn restrict(&mut self, ty: Ty<'tcx>,
  77                 tcx: TyCtxt<'a, 'tcx, 'tcx>,
  78                 param_env: ty::ParamEnv<'tcx>) {
  79         if ty.is_freeze(tcx, param_env, DUMMY_SP) {
  80             *self = *self - Qualif::MUTABLE_INTERIOR;
  81         }
  82         if !ty.needs_drop(tcx, param_env) {
  83             *self = *self - Qualif::NEEDS_DROP;
  84         }
  85     }
  86 }
  87
  88 /// What kind of item we are in.
  89 #[derive(Copy, Clone, PartialEq, Eq)]
  90 enum Mode {
  91     Const,
  92     Static,
  93     StaticMut,
  94     ConstFn,
  95     Fn
  96 }
  97
  98 impl fmt::Display for Mode {
  99     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
 100         match *self {
 101             Mode::Const => write!(f, "constant"),
 102             Mode::Static | Mode::StaticMut => write!(f, "static"),
 103             Mode::ConstFn => write!(f, "constant function"),
 104             Mode::Fn => write!(f, "function")
 105         }
 106     }
 107 }
 108
 109 struct Qualifier<'a, 'gcx: 'a+'tcx, 'tcx: 'a> {
 110     mode: Mode,
 111     span: Span,
 112     def_id: DefId,
 113     mir: &'a Mir<'tcx>,
 114     rpo: ReversePostorder<'a, 'tcx>,
 115     tcx: TyCtxt<'a, 'gcx, 'tcx>,
 116     param_env: ty::ParamEnv<'tcx>,
 117     local_qualif: IndexVec<Local, Option<Qualif>>,
 118     qualif: Qualif,
 119     const_fn_arg_vars: BitArray<Local>,
 120     temp_promotion_state: IndexVec<Local, TempState>,
 121     promotion_candidates: Vec<Candidate>
 122 }
 123
 124 impl<'a, 'tcx> Qualifier<'a, 'tcx, 'tcx> {
 125     fn new(tcx: TyCtxt<'a, 'tcx, 'tcx>,
 126            def_id: DefId,
 127            mir: &'a Mir<'tcx>,
 128            mode: Mode)
 129            -> Qualifier<'a, 'tcx, 'tcx> {
 130         let mut rpo = traversal::reverse_postorder(mir);
 131         let temps = promote_consts::collect_temps(mir, &mut rpo);
 132         rpo.reset();
 133
 134         let param_env = tcx.param_env(def_id);
 135
 136         let mut local_qualif = IndexVec::from_elem(None, &mir.local_decls);
 137         for arg in mir.args_iter() {
 138             let mut qualif = Qualif::NEEDS_DROP;
 139             qualif.restrict(mir.local_decls[arg].ty, tcx, param_env);
 140             local_qualif[arg] = Some(qualif);
 141         }
 142
 143         Qualifier {
 144             mode,
 145             span: mir.span,
 146             def_id,
 147             mir,
 148             rpo,
 149             tcx,
 150             param_env,
 151             local_qualif,
 152             qualif: Qualif::empty(),
 153             const_fn_arg_vars: BitArray::new(mir.local_decls.len()),
 154             temp_promotion_state: temps,
 155             promotion_candidates: vec![]
 156         }
 157     }
 158
 159     // FIXME(eddyb) we could split the errors into meaningful
 160     // categories, but enabling full miri would make that
 161     // slightly pointless (even with feature-gating).
 162     fn not_const(&mut self) {
 163         self.add(Qualif::NOT_CONST);
 164         if self.mode != Mode::Fn {
 165             let mut err = struct_span_err!(
 166                 self.tcx.sess,
 167                 self.span,
 168                 E0019,
 169                 "{} contains unimplemented expression type",
 170                 self.mode
 171             );
 172             if self.tcx.sess.teach(&err.get_code().unwrap()) {
 173                 err.note("A function call isn't allowed in the const's initialization expression \
 174                           because the expression's value must be known at compile-time.");
 175                 err.note("Remember: you can't use a function call inside a const's initialization \
 176                           expression! However, you can use it anywhere else.");
 177             }
 178             err.emit();
 179         }
 180     }
 181
 182     /// Error about extra statements in a constant.
 183     fn statement_like(&mut self) {
 184         self.add(Qualif::NOT_CONST);
 185         if self.mode != Mode::Fn {
 186             let mut err = feature_err(
 187                 &self.tcx.sess.parse_sess,
 188                 "const_let",
 189                 self.span,
 190                 GateIssue::Language,
 191                 &format!("statements in {}s are unstable", self.mode),
 192             );
 193             if self.tcx.sess.teach(&err.get_code().unwrap()) {
 194                 err.note("Blocks in constants may only contain items (such as constant, function \
 195                           definition, etc...) and a tail expression.");
 196                 err.help("To avoid it, you have to replace the non-item object.");
 197             }
 198             err.emit();
 199         }
 200     }
 201
 202     /// Add the given qualification to self.qualif.
 203     fn add(&mut self, qualif: Qualif) {
 204         self.qualif = self.qualif | qualif;
 205     }
 206
 207     /// Add the given type's qualification to self.qualif.
 208     fn add_type(&mut self, ty: Ty<'tcx>) {
 209         self.add(Qualif::MUTABLE_INTERIOR | Qualif::NEEDS_DROP);
 210         self.qualif.restrict(ty, self.tcx, self.param_env);
 211     }
 212
 213     /// Within the provided closure, self.qualif will start
 214     /// out empty, and its value after the closure returns will
 215     /// be combined with the value before the call to nest.
 216     fn nest<F: FnOnce(&mut Self)>(&mut self, f: F) {
 217         let original = self.qualif;
 218         self.qualif = Qualif::empty();
 219         f(self);
 220         self.add(original);
 221     }
 222
 223     /// Assign the current qualification to the given destination.
 224     fn assign(&mut self, dest: &Place<'tcx>, location: Location) {
 225         trace!("assign: {:?}", dest);
 226         let qualif = self.qualif;
 227         let span = self.span;
 228         let store = |slot: &mut Option<Qualif>| {
 229             if slot.is_some() {
 230                 span_bug!(span, "multiple assignments to {:?}", dest);
 231             }
 232             *slot = Some(qualif);
 233         };
 234
 235         // Only handle promotable temps in non-const functions.
 236         if self.mode == Mode::Fn {
 237             if let Place::Local(index) = *dest {
 238                 if self.mir.local_kind(index) == LocalKind::Temp
 239                 && self.temp_promotion_state[index].is_promotable() {
 240                     debug!("store to promotable temp {:?} ({:?})", index, qualif);
 241                     store(&mut self.local_qualif[index]);
 242                 }
 243             }
 244             return;
 245         }
 246
 247         match *dest {
 248             Place::Local(index) if (self.mir.local_kind(index) == LocalKind::Var ||
 249                                    self.mir.local_kind(index) == LocalKind::Arg) &&
 250                                    self.tcx.sess.features_untracked().const_let => {
 251                 debug!("store to var {:?}", index);
 252                 self.local_qualif[index] = Some(self.qualif);
 253             }
 254             Place::Local(index) if self.mir.local_kind(index) == LocalKind::Temp ||
 255                                    self.mir.local_kind(index) == LocalKind::ReturnPointer => {
 256                 debug!("store to {:?} (temp or return pointer)", index);
 257                 store(&mut self.local_qualif[index])
 258             }
 259
 260             Place::Projection(box Projection {
 261                 base: Place::Local(index),
 262                 elem: ProjectionElem::Deref
 263             }) if self.mir.local_kind(index) == LocalKind::Temp
 264                && self.mir.local_decls[index].ty.is_box()
 265                && self.local_qualif[index].map_or(false, |qualif| {
 266                     qualif.contains(Qualif::NOT_CONST)
 267                }) => {
 268                 // Part of `box expr`, we should've errored
 269                 // already for the Box allocation Rvalue.
 270             }
 271
 272             // This must be an explicit assignment.
 273             _ => {
 274                 // Catch more errors in the destination.
 275                 self.visit_place(dest, PlaceContext::Store, location);
 276                 self.statement_like();
 277             }
 278         }
 279     }
 280
 281     /// Qualify a whole const, static initializer or const fn.
 282     fn qualify_const(&mut self) -> (Qualif, Lrc<IdxSetBuf<Local>>) {
 283         debug!("qualifying {} {:?}", self.mode, self.def_id);
 284
 285         let mir = self.mir;
 286
 287         let mut seen_blocks = BitArray::new(mir.basic_blocks().len());
 288         let mut bb = START_BLOCK;
 289         loop {
 290             seen_blocks.insert(bb.index());
 291
 292             self.visit_basic_block_data(bb, &mir[bb]);
 293
 294             let target = match mir[bb].terminator().kind {
 295                 TerminatorKind::Goto { target } |
 296                 TerminatorKind::Drop { target, .. } |
 297                 TerminatorKind::Assert { target, .. } |
 298                 TerminatorKind::Call { destination: Some((_, target)), .. } => {
 299                     Some(target)
 300                 }
 301
 302                 // Non-terminating calls cannot produce any value.
 303                 TerminatorKind::Call { destination: None, .. } => {
 304                     break;
 305                 }
 306
 307                 TerminatorKind::SwitchInt {..} |
 308                 TerminatorKind::DropAndReplace { .. } |
 309                 TerminatorKind::Resume |
 310                 TerminatorKind::Abort |
 311                 TerminatorKind::GeneratorDrop |
 312                 TerminatorKind::Yield { .. } |
 313                 TerminatorKind::Unreachable |
 314                 TerminatorKind::FalseEdges { .. } |
 315                 TerminatorKind::FalseUnwind { .. } => None,
 316
 317                 TerminatorKind::Return => {
 318                     if !self.tcx.sess.features_untracked().const_let {
 319                         // Check for unused values. This usually means
 320                         // there are extra statements in the AST.
 321                         for temp in mir.temps_iter() {
 322                             if self.local_qualif[temp].is_none() {
 323                                 continue;
 324                             }
 325
 326                             let state = self.temp_promotion_state[temp];
 327                             if let TempState::Defined { location, uses: 0 } = state {
 328                                 let data = &mir[location.block];
 329                                 let stmt_idx = location.statement_index;
 330
 331                                 // Get the span for the initialization.
 332                                 let source_info = if stmt_idx < data.statements.len() {
 333                                     data.statements[stmt_idx].source_info
 334                                 } else {
 335                                     data.terminator().source_info
 336                                 };
 337                                 self.span = source_info.span;
 338
 339                                 // Treat this as a statement in the AST.
 340                                 self.statement_like();
 341                             }
 342                         }
 343
 344                         // Make sure there are no extra unassigned variables.
 345                         self.qualif = Qualif::NOT_CONST;
 346                         for index in mir.vars_iter() {
 347                             if !self.const_fn_arg_vars.contains(index) {
 348                                 debug!("unassigned variable {:?}", index);
 349                                 self.assign(&Place::Local(index), Location {
 350                                     block: bb,
 351                                     statement_index: usize::MAX,
 352                                 });
 353                             }
 354                         }
 355                     }
 356
 357                     break;
 358                 }
 359             };
 360
 361             match target {
 362                 // No loops allowed.
 363                 Some(target) if !seen_blocks.contains(target.index()) => {
 364                     bb = target;
 365                 }
 366                 _ => {
 367                     self.not_const();
 368                     break;
 369                 }
 370             }
 371         }
 372
 373         self.qualif = self.local_qualif[RETURN_PLACE].unwrap_or(Qualif::NOT_CONST);
 374
 375         // Account for errors in consts by using the
 376         // conservative type qualification instead.
 377         if self.qualif.intersects(Qualif::CONST_ERROR) {
 378             self.qualif = Qualif::empty();
 379             let return_ty = mir.return_ty();
 380             self.add_type(return_ty);
 381         }
 382
 383
 384         // Collect all the temps we need to promote.
 385         let mut promoted_temps = IdxSetBuf::new_empty(self.temp_promotion_state.len());
 386
 387         for candidate in &self.promotion_candidates {
 388             match *candidate {
 389                 Candidate::Ref(Location { block: bb, statement_index: stmt_idx }) => {
 390                     match self.mir[bb].statements[stmt_idx].kind {
 391                         StatementKind::Assign(_, Rvalue::Ref(_, _, Place::Local(index))) => {
 392                             promoted_temps.add(&index);
 393                         }
 394                         _ => {}
 395                     }
 396                 }
 397                 Candidate::Argument { .. } => {}
 398             }
 399         }
 400
 401         (self.qualif, Lrc::new(promoted_temps))
 402     }
 403 }
 404
 405 /// Accumulates an Rvalue or Call's effects in self.qualif.
 406 /// For functions (constant or not), it also records
 407 /// candidates for promotion in promotion_candidates.
 408 impl<'a, 'tcx> Visitor<'tcx> for Qualifier<'a, 'tcx, 'tcx> {
 409     fn visit_local(&mut self,
 410                    &local: &Local,
 411                    _: PlaceContext<'tcx>,
 412                    _: Location) {
 413         let kind = self.mir.local_kind(local);
 414         match kind {
 415             LocalKind::ReturnPointer => {
 416                 self.not_const();
 417             }
 418             LocalKind::Var if !self.tcx.sess.features_untracked().const_let => {
 419                 if self.mode != Mode::Fn {
 420                     emit_feature_err(&self.tcx.sess.parse_sess, "const_let",
 421                                     self.span, GateIssue::Language,
 422                                     &format!("let bindings in {}s are unstable",self.mode));
 423                 }
 424                 self.add(Qualif::NOT_CONST);
 425             }
 426             LocalKind::Var |
 427             LocalKind::Arg |
 428             LocalKind::Temp => {
 429                 if let LocalKind::Arg = kind {
 430                     self.add(Qualif::FN_ARGUMENT);
 431                 }
 432
 433                 if !self.temp_promotion_state[local].is_promotable() {
 434                     self.add(Qualif::NOT_PROMOTABLE);
 435                 }
 436
 437                 if let Some(qualif) = self.local_qualif[local] {
 438                     self.add(qualif);
 439                 } else {
 440                     self.not_const();
 441                 }
 442             }
 443         }
 444     }
 445
 446     fn visit_place(&mut self,
 447                     place: &Place<'tcx>,
 448                     context: PlaceContext<'tcx>,
 449                     location: Location) {
 450         match *place {
 451             Place::Local(ref local) => self.visit_local(local, context, location),
 452             Place::Promoted(_) => bug!("promoting already promoted MIR"),
 453             Place::Static(ref global) => {
 454                 if self.tcx
 455                        .get_attrs(global.def_id)
 456                        .iter()
 457                        .any(|attr| attr.check_name("thread_local")) {
 458                     if self.mode != Mode::Fn {
 459                         span_err!(self.tcx.sess, self.span, E0625,
 460                                   "thread-local statics cannot be \
 461                                    accessed at compile-time");
 462                     }
 463                     self.add(Qualif::NOT_CONST);
 464                     return;
 465                 }
 466
 467                 // Only allow statics (not consts) to refer to other statics.
 468                 if self.mode == Mode::Static || self.mode == Mode::StaticMut {
 469                     return;
 470                 }
 471                 self.add(Qualif::NOT_CONST);
 472
 473                 if self.mode != Mode::Fn {
 474                     let mut err = struct_span_err!(self.tcx.sess, self.span, E0013,
 475                                                    "{}s cannot refer to statics, use \
 476                                                     a constant instead", self.mode);
 477                     if self.tcx.sess.teach(&err.get_code().unwrap()) {
 478                         err.note(
 479                             "Static and const variables can refer to other const variables. But a \
 480                              const variable cannot refer to a static variable."
 481                         );
 482                         err.help(
 483                             "To fix this, the value can be extracted as a const and then used."
 484                         );
 485                     }
 486                     err.emit()
 487                 }
 488             }
 489             Place::Projection(ref proj) => {
 490                 self.nest(|this| {
 491                     this.super_place(place, context, location);
 492                     match proj.elem {
 493                         ProjectionElem::Deref => {
 494                             this.add(Qualif::NOT_CONST);
 495
 496                             let base_ty = proj.base.ty(this.mir, this.tcx).to_ty(this.tcx);
 497                             if let ty::TyRawPtr(_) = base_ty.sty {
 498                                 if this.mode != Mode::Fn &&
 499                                    !this.tcx.sess.features_untracked().const_raw_ptr_deref {
 500                                     emit_feature_err(
 501                                         &this.tcx.sess.parse_sess, "const_raw_ptr_deref",
 502                                         this.span, GateIssue::Language,
 503                                         &format!(
 504                                             "dereferencing raw pointers in {}s is unstable",
 505                                             this.mode,
 506                                         ),
 507                                     );
 508                                 }
 509                             }
 510                         }
 511
 512                         ProjectionElem::Field(..) |
 513                         ProjectionElem::Index(_) => {
 514                             let base_ty = proj.base.ty(this.mir, this.tcx).to_ty(this.tcx);
 515                             if let Some(def) = base_ty.ty_adt_def() {
 516                                 if def.is_union() {
 517                                     match this.mode {
 518                                         Mode::Fn => this.not_const(),
 519                                         Mode::ConstFn => {
 520                                             if !this.tcx.sess.features_untracked().const_fn_union {
 521                                                 emit_feature_err(
 522                                                     &this.tcx.sess.parse_sess, "const_fn_union",
 523                                                     this.span, GateIssue::Language,
 524                                                     "unions in const fn are unstable",
 525                                                 );
 526                                             }
 527                                         },
 528
 529                                         | Mode::Static
 530                                         | Mode::StaticMut
 531                                         | Mode::Const
 532                                         => {},
 533                                     }
 534                                 }
 535                             }
 536
 537                             let ty = place.ty(this.mir, this.tcx).to_ty(this.tcx);
 538                             this.qualif.restrict(ty, this.tcx, this.param_env);
 539                         }
 540
 541                         ProjectionElem::ConstantIndex {..} |
 542                         ProjectionElem::Subslice {..} |
 543                         ProjectionElem::Downcast(..) => {
 544                             this.not_const()
 545                         }
 546                     }
 547                 });
 548             }
 549         }
 550     }
 551
 552     fn visit_operand(&mut self, operand: &Operand<'tcx>, location: Location) {
 553         self.super_operand(operand, location);
 554
 555         match *operand {
 556             Operand::Copy(_) |
 557             Operand::Move(_) => {
 558                 // Mark the consumed locals to indicate later drops are noops.
 559                 if let Operand::Move(Place::Local(local)) = *operand {
 560                     self.local_qualif[local] = self.local_qualif[local].map(|q|
 561                         q - Qualif::NEEDS_DROP
 562                     );
 563                 }
 564             }
 565             Operand::Constant(ref constant) => {
 566                 if let ConstValue::Unevaluated(def_id, _) = constant.literal.val {
 567                     // Don't peek inside trait associated constants.
 568                     if self.tcx.trait_of_item(def_id).is_some() {
 569                         self.add_type(constant.literal.ty);
 570                     } else {
 571                         let (bits, _) = self.tcx.at(constant.span).mir_const_qualif(def_id);
 572
 573                         let qualif = Qualif::from_bits(bits).expect("invalid mir_const_qualif");
 574                         self.add(qualif);
 575
 576                         // Just in case the type is more specific than
 577                         // the definition, e.g. impl associated const
 578                         // with type parameters, take it into account.
 579                         self.qualif.restrict(constant.literal.ty, self.tcx, self.param_env);
 580                     }
 581                 }
 582             }
 583         }
 584     }
 585
 586     fn visit_rvalue(&mut self, rvalue: &Rvalue<'tcx>, location: Location) {
 587         // Recurse through operands and places.
 588         if let Rvalue::Ref(region, kind, ref place) = *rvalue {
 589             let mut is_reborrow = false;
 590             if let Place::Projection(ref proj) = *place {
 591                 if let ProjectionElem::Deref = proj.elem {
 592                     let base_ty = proj.base.ty(self.mir, self.tcx).to_ty(self.tcx);
 593                     if let ty::TyRef(..) = base_ty.sty {
 594                         is_reborrow = true;
 595                     }
 596                 }
 597             }
 598
 599             if is_reborrow {
 600                 self.super_place(place, PlaceContext::Borrow {
 601                     region,
 602                     kind
 603                 }, location);
 604             } else {
 605                 self.super_rvalue(rvalue, location);
 606             }
 607         } else {
 608             self.super_rvalue(rvalue, location);
 609         }
 610
 611         match *rvalue {
 612             Rvalue::Use(_) |
 613             Rvalue::Repeat(..) |
 614             Rvalue::UnaryOp(UnOp::Neg, _) |
 615             Rvalue::UnaryOp(UnOp::Not, _) |
 616             Rvalue::NullaryOp(NullOp::SizeOf, _) |
 617             Rvalue::CheckedBinaryOp(..) |
 618             Rvalue::Cast(CastKind::ReifyFnPointer, ..) |
 619             Rvalue::Cast(CastKind::UnsafeFnPointer, ..) |
 620             Rvalue::Cast(CastKind::ClosureFnPointer, ..) |
 621             Rvalue::Cast(CastKind::Unsize, ..) |
 622             Rvalue::Discriminant(..) |
 623             Rvalue::Len(_) => {}
 624
 625             Rvalue::Ref(_, kind, ref place) => {
 626                 let ty = place.ty(self.mir, self.tcx).to_ty(self.tcx);
 627
 628                 // Default to forbidding the borrow and/or its promotion,
 629                 // due to the potential for direct or interior mutability,
 630                 // and only proceed by setting `forbidden_mut` to `false`.
 631                 let mut forbidden_mut = true;
 632
 633                 if let BorrowKind::Mut { .. } = kind {
 634                     // In theory, any zero-sized value could be borrowed
 635                     // mutably without consequences. However, only &mut []
 636                     // is allowed right now, and only in functions.
 637                     if self.mode == Mode::StaticMut {
 638                         // Inside a `static mut`, &mut [...] is also allowed.
 639                         match ty.sty {
 640                             ty::TyArray(..) | ty::TySlice(_) => forbidden_mut = false,
 641                             _ => {}
 642                         }
 643                     } else if let ty::TyArray(_, len) = ty.sty {
 644                         // FIXME(eddyb) the `self.mode == Mode::Fn` condition
 645                         // seems unnecessary, given that this is merely a ZST.
 646                         if len.unwrap_usize(self.tcx) == 0 && self.mode == Mode::Fn {
 647                             forbidden_mut = false;
 648                         }
 649                     }
 650
 651                     if forbidden_mut {
 652                         self.add(Qualif::NOT_CONST);
 653                         if self.mode != Mode::Fn {
 654                             let mut err = struct_span_err!(self.tcx.sess,  self.span, E0017,
 655                                                            "references in {}s may only refer \
 656                                                             to immutable values", self.mode);
 657                             err.span_label(self.span, format!("{}s require immutable values",
 658                                                                 self.mode));
 659                             if self.tcx.sess.teach(&err.get_code().unwrap()) {
 660                                 err.note("References in statics and constants may only refer to \
 661                                           immutable values.\n\n\
 662                                           Statics are shared everywhere, and if they refer to \
 663                                           mutable data one might violate memory safety since \
 664                                           holding multiple mutable references to shared data is \
 665                                           not allowed.\n\n\
 666                                           If you really want global mutable state, try using \
 667                                           static mut or a global UnsafeCell.");
 668                             }
 669                             err.emit();
 670                         }
 671                     }
 672                 } else {
 673                     // Constants cannot be borrowed if they contain interior mutability as
 674                     // it means that our "silent insertion of statics" could change
 675                     // initializer values (very bad).
 676                     if self.qualif.contains(Qualif::MUTABLE_INTERIOR) {
 677                         // A reference of a MUTABLE_INTERIOR place is instead
 678                         // NOT_CONST (see `if forbidden_mut` below), to avoid
 679                         // duplicate errors (from reborrowing, for example).
 680                         self.qualif = self.qualif - Qualif::MUTABLE_INTERIOR;
 681                         if self.mode != Mode::Fn {
 682                             span_err!(self.tcx.sess, self.span, E0492,
 683                                       "cannot borrow a constant which may contain \
 684                                        interior mutability, create a static instead");
 685                         }
 686                     } else {
 687                         // We allow immutable borrows of frozen data.
 688                         forbidden_mut = false;
 689                     }
 690                 }
 691
 692                 if forbidden_mut {
 693                     self.add(Qualif::NOT_CONST);
 694                 } else {
 695                     // We might have a candidate for promotion.
 696                     let candidate = Candidate::Ref(location);
 697                     // We can only promote interior borrows of promotable temps.
 698                     let mut place = place;
 699                     while let Place::Projection(ref proj) = *place {
 700                         if proj.elem == ProjectionElem::Deref {
 701                             break;
 702                         }
 703                         place = &proj.base;
 704                     }
 705                     if let Place::Local(local) = *place {
 706                         if self.mir.local_kind(local) == LocalKind::Temp {
 707                             if let Some(qualif) = self.local_qualif[local] {
 708                                 // `forbidden_mut` is false, so we can safely ignore
 709                                 // `MUTABLE_INTERIOR` from the local's qualifications.
 710                                 // This allows borrowing fields which don't have
 711                                 // `MUTABLE_INTERIOR`, from a type that does, e.g.:
 712                                 // `let _: &'static _ = &(Cell::new(1), 2).1;`
 713                                 if (qualif - Qualif::MUTABLE_INTERIOR).is_empty() {
 714                                     self.promotion_candidates.push(candidate);
 715                                 }
 716                             }
 717                         }
 718                     }
 719                 }
 720             }
 721
 722             Rvalue::Cast(CastKind::Misc, ref operand, cast_ty) => {
 723                 let operand_ty = operand.ty(self.mir, self.tcx);
 724                 let cast_in = CastTy::from_ty(operand_ty).expect("bad input type for cast");
 725                 let cast_out = CastTy::from_ty(cast_ty).expect("bad output type for cast");
 726                 match (cast_in, cast_out) {
 727                     (CastTy::Ptr(_), CastTy::Int(_)) |
 728                     (CastTy::FnPtr, CastTy::Int(_)) => {
 729                         self.add(Qualif::NOT_CONST);
 730                         if self.mode != Mode::Fn &&
 731                            !self.tcx.sess.features_untracked().const_raw_ptr_to_usize_cast {
 732                             emit_feature_err(
 733                                 &self.tcx.sess.parse_sess, "const_raw_ptr_to_usize_cast",
 734                                 self.span, GateIssue::Language,
 735                                 &format!(
 736                                     "casting pointers to integers in {}s is unstable",
 737                                     self.mode,
 738                                 ),
 739                             );
 740                         }
 741                     }
 742                     _ => {}
 743                 }
 744             }
 745
 746             Rvalue::BinaryOp(op, ref lhs, _) => {
 747                 if let ty::TyRawPtr(_) = lhs.ty(self.mir, self.tcx).sty {
 748                     assert!(op == BinOp::Eq || op == BinOp::Ne ||
 749                             op == BinOp::Le || op == BinOp::Lt ||
 750                             op == BinOp::Ge || op == BinOp::Gt ||
 751                             op == BinOp::Offset);
 752
 753                     self.add(Qualif::NOT_CONST);
 754                     if self.mode != Mode::Fn {
 755                         emit_feature_err(
 756                             &self.tcx.sess.parse_sess,
 757                             "const_compare_raw_pointers",
 758                             self.span,
 759                             GateIssue::Language,
 760                             &format!("comparing raw pointers inside {}", self.mode),
 761                         );
 762                     }
 763                 }
 764             }
 765
 766             Rvalue::NullaryOp(NullOp::Box, _) => {
 767                 self.add(Qualif::NOT_CONST);
 768                 if self.mode != Mode::Fn {
 769                     let mut err = struct_span_err!(self.tcx.sess, self.span, E0010,
 770                                                    "allocations are not allowed in {}s", self.mode);
 771                     err.span_label(self.span, format!("allocation not allowed in {}s", self.mode));
 772                     if self.tcx.sess.teach(&err.get_code().unwrap()) {
 773                         err.note(
 774                             "The value of statics and constants must be known at compile time, \
 775                              and they live for the entire lifetime of a program. Creating a boxed \
 776                              value allocates memory on the heap at runtime, and therefore cannot \
 777                              be done at compile time."
 778                         );
 779                     }
 780                     err.emit();
 781                 }
 782             }
 783
 784             Rvalue::Aggregate(ref kind, _) => {
 785                 if let AggregateKind::Adt(def, ..) = **kind {
 786                     if def.has_dtor(self.tcx) {
 787                         self.add(Qualif::NEEDS_DROP);
 788                     }
 789
 790                     if Some(def.did) == self.tcx.lang_items().unsafe_cell_type() {
 791                         let ty = rvalue.ty(self.mir, self.tcx);
 792                         self.add_type(ty);
 793                         assert!(self.qualif.contains(Qualif::MUTABLE_INTERIOR));
 794                     }
 795                 }
 796             }
 797         }
 798     }
 799
 800     fn visit_terminator_kind(&mut self,
 801                              bb: BasicBlock,
 802                              kind: &TerminatorKind<'tcx>,
 803                              location: Location) {
 804         if let TerminatorKind::Call { ref func, ref args, ref destination, .. } = *kind {
 805             self.visit_operand(func, location);
 806
 807             let fn_ty = func.ty(self.mir, self.tcx);
 808             let mut callee_def_id = None;
 809             let (mut is_shuffle, mut is_const_fn) = (false, None);
 810             if let ty::TyFnDef(def_id, _) = fn_ty.sty {
 811                 callee_def_id = Some(def_id);
 812                 match self.tcx.fn_sig(def_id).abi() {
 813                     Abi::RustIntrinsic |
 814                     Abi::PlatformIntrinsic => {
 815                         assert!(!self.tcx.is_const_fn(def_id));
 816                         match &self.tcx.item_name(def_id).as_str()[..] {
 817                             | "size_of"
 818                             | "min_align_of"
 819                             | "type_id"
 820                             | "bswap"
 821                             | "ctpop"
 822                             | "cttz"
 823                             | "cttz_nonzero"
 824                             | "ctlz"
 825                             | "ctlz_nonzero" => is_const_fn = Some(def_id),
 826
 827                             name if name.starts_with("simd_shuffle") => {
 828                                 is_shuffle = true;
 829                             }
 830
 831                             _ => {}
 832                         }
 833                     }
 834                     _ => {
 835                         if self.tcx.is_const_fn(def_id) {
 836                             is_const_fn = Some(def_id);
 837                         }
 838                     }
 839                 }
 840             }
 841
 842             let constant_arguments = callee_def_id.and_then(|id| {
 843                 args_required_const(self.tcx, id)
 844             });
 845             for (i, arg) in args.iter().enumerate() {
 846                 self.nest(|this| {
 847                     this.visit_operand(arg, location);
 848                     if this.mode != Mode::Fn {
 849                         return
 850                     }
 851                     let candidate = Candidate::Argument { bb, index: i };
 852                     if is_shuffle && i == 2 {
 853                         if this.qualif.is_empty() {
 854                             this.promotion_candidates.push(candidate);
 855                         } else {
 856                             span_err!(this.tcx.sess, this.span, E0526,
 857                                       "shuffle indices are not constant");
 858                         }
 859                         return
 860                     }
 861
 862                     let constant_arguments = match constant_arguments.as_ref() {
 863                         Some(s) => s,
 864                         None => return,
 865                     };
 866                     if !constant_arguments.contains(&i) {
 867                         return
 868                     }
 869                     if this.qualif.is_empty() {
 870                         this.promotion_candidates.push(candidate);
 871                     } else {
 872                         this.tcx.sess.span_err(this.span,
 873                             &format!("argument {} is required to be a constant",
 874                                      i + 1));
 875                     }
 876                 });
 877             }
 878
 879             // Const fn calls.
 880             if let Some(def_id) = is_const_fn {
 881                 // find corresponding rustc_const_unstable feature
 882                 if let Some(&attr::Stability {
 883                     rustc_const_unstable: Some(attr::RustcConstUnstable {
 884                         feature: ref feature_name
 885                     }),
 886                 .. }) = self.tcx.lookup_stability(def_id) {
 887                     if
 888                         // feature-gate is not enabled,
 889                         !self.tcx.features()
 890                             .declared_lib_features
 891                             .iter()
 892                             .any(|&(ref sym, _)| sym == feature_name) &&
 893
 894                         // this doesn't come from a crate with the feature-gate enabled,
 895                         self.def_id.is_local() &&
 896
 897                         // this doesn't come from a macro that has #[allow_internal_unstable]
 898                         !self.span.allows_unstable()
 899                     {
 900                         self.qualif = Qualif::NOT_CONST;
 901                         if self.mode != Mode::Fn {
 902                             // inside a constant environment, not having the feature gate is
 903                             // an error
 904                             let mut err = self.tcx.sess.struct_span_err(self.span,
 905                                 &format!("`{}` is not yet stable as a const fn",
 906                                         self.tcx.item_path_str(def_id)));
 907                             help!(&mut err,
 908                                 "in Nightly builds, add `#![feature({})]` \
 909                                 to the crate attributes to enable",
 910                                 feature_name);
 911                             err.emit();
 912                         }
 913                     }
 914                 }
 915             } else {
 916                 self.qualif = Qualif::NOT_CONST;
 917                 if self.mode != Mode::Fn {
 918                     // FIXME(#24111) Remove this check when const fn stabilizes
 919                     let (msg, note) = if let UnstableFeatures::Disallow =
 920                             self.tcx.sess.opts.unstable_features {
 921                         (format!("calls in {}s are limited to \
 922                                   tuple structs and tuple variants",
 923                                  self.mode),
 924                          Some("a limited form of compile-time function \
 925                                evaluation is available on a nightly \
 926                                compiler via `const fn`"))
 927                     } else {
 928                         (format!("calls in {}s are limited \
 929                                   to constant functions, \
 930                                   tuple structs and tuple variants",
 931                                  self.mode),
 932                          None)
 933                     };
 934                     let mut err = struct_span_err!(self.tcx.sess, self.span, E0015, "{}", msg);
 935                     if let Some(note) = note {
 936                         err.span_note(self.span, note);
 937                     }
 938                     err.emit();
 939                 }
 940             }
 941
 942             if let Some((ref dest, _)) = *destination {
 943                 // Avoid propagating irrelevant callee/argument qualifications.
 944                 if self.qualif.intersects(Qualif::CONST_ERROR) {
 945                     self.qualif = Qualif::NOT_CONST;
 946                 } else {
 947                     // Be conservative about the returned value of a const fn.
 948                     let tcx = self.tcx;
 949                     let ty = dest.ty(self.mir, tcx).to_ty(tcx);
 950                     self.qualif = Qualif::empty();
 951                     self.add_type(ty);
 952                 }
 953                 self.assign(dest, location);
 954             }
 955         } else if let TerminatorKind::Drop { location: ref place, .. } = *kind {
 956             self.super_terminator_kind(bb, kind, location);
 957
 958             // Deny *any* live drops anywhere other than functions.
 959             if self.mode != Mode::Fn {
 960                 // HACK(eddyb) Emulate a bit of dataflow analysis,
 961                 // conservatively, that drop elaboration will do.
 962                 let needs_drop = if let Place::Local(local) = *place {
 963                     if self.local_qualif[local].map_or(true, |q| q.contains(Qualif::NEEDS_DROP)) {
 964                         Some(self.mir.local_decls[local].source_info.span)
 965                     } else {
 966                         None
 967                     }
 968                 } else {
 969                     Some(self.span)
 970                 };
 971
 972                 if let Some(span) = needs_drop {
 973                     // Double-check the type being dropped, to minimize false positives.
 974                     let ty = place.ty(self.mir, self.tcx).to_ty(self.tcx);
 975                     if ty.needs_drop(self.tcx, self.param_env) {
 976                         struct_span_err!(self.tcx.sess, span, E0493,
 977                                          "destructors cannot be evaluated at compile-time")
 978                             .span_label(span, format!("{}s cannot evaluate destructors",
 979                                                       self.mode))
 980                             .emit();
 981                     }
 982                 }
 983             }
 984         } else {
 985             // Qualify any operands inside other terminators.
 986             self.super_terminator_kind(bb, kind, location);
 987         }
 988     }
 989
 990     fn visit_assign(&mut self,
 991                     _: BasicBlock,
 992                     dest: &Place<'tcx>,
 993                     rvalue: &Rvalue<'tcx>,
 994                     location: Location) {
 995         self.visit_rvalue(rvalue, location);
 996
 997         // Check the allowed const fn argument forms.
 998         if let (Mode::ConstFn, &Place::Local(index)) = (self.mode, dest) {
 999             if self.mir.local_kind(index) == LocalKind::Var &&
1000                self.const_fn_arg_vars.insert(index) &&
1001                !self.tcx.sess.features_untracked().const_let {
1002
1003                 // Direct use of an argument is permitted.
1004                 match *rvalue {
1005                     Rvalue::Use(Operand::Copy(Place::Local(local))) |
1006                     Rvalue::Use(Operand::Move(Place::Local(local))) => {
1007                         if self.mir.local_kind(local) == LocalKind::Arg {
1008                             return;
1009                         }
1010                     }
1011                     _ => {}
1012                 }
1013
1014                 // Avoid a generic error for other uses of arguments.
1015                 if self.qualif.contains(Qualif::FN_ARGUMENT) {
1016                     let decl = &self.mir.local_decls[index];
1017                     let mut err = feature_err(
1018                         &self.tcx.sess.parse_sess,
1019                         "const_let",
1020                         decl.source_info.span,
1021                         GateIssue::Language,
1022                         "arguments of constant functions can only be immutable by-value bindings"
1023                     );
1024                     if self.tcx.sess.teach(&err.get_code().unwrap()) {
1025                         err.note("Constant functions are not allowed to mutate anything. Thus, \
1026                                   binding to an argument with a mutable pattern is not allowed.");
1027                         err.note("Remove any mutable bindings from the argument list to fix this \
1028                                   error. In case you need to mutate the argument, try lazily \
1029                                   initializing a global variable instead of using a const fn, or \
1030                                   refactoring the code to a functional style to avoid mutation if \
1031                                   possible.");
1032                     }
1033                     err.emit();
1034                     return;
1035                 }
1036             }
1037         }
1038
1039         self.assign(dest, location);
1040     }
1041
1042     fn visit_source_info(&mut self, source_info: &SourceInfo) {
1043         self.span = source_info.span;
1044     }
1045
1046     fn visit_statement(&mut self, bb: BasicBlock, statement: &Statement<'tcx>, location: Location) {
1047         self.nest(|this| {
1048             this.visit_source_info(&statement.source_info);
1049             match statement.kind {
1050                 StatementKind::Assign(ref place, ref rvalue) => {
1051                     this.visit_assign(bb, place, rvalue, location);
1052                 }
1053                 StatementKind::ReadForMatch(..) |
1054                 StatementKind::SetDiscriminant { .. } |
1055                 StatementKind::StorageLive(_) |
1056                 StatementKind::StorageDead(_) |
1057                 StatementKind::InlineAsm {..} |
1058                 StatementKind::EndRegion(_) |
1059                 StatementKind::Validate(..) |
1060                 StatementKind::UserAssertTy(..) |
1061                 StatementKind::Nop => {}
1062             }
1063         });
1064     }
1065
1066     fn visit_terminator(&mut self,
1067                         bb: BasicBlock,
1068                         terminator: &Terminator<'tcx>,
1069                         location: Location) {
1070         self.nest(|this| this.super_terminator(bb, terminator, location));
1071     }
1072 }
1073
1074 pub fn provide(providers: &mut Providers) {
1075     *providers = Providers {
1076         mir_const_qualif,
1077         ..*providers
1078     };
1079 }
1080
1081 fn mir_const_qualif<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
1082                               def_id: DefId)
1083                               -> (u8, Lrc<IdxSetBuf<Local>>) {
1084     // NB: This `borrow()` is guaranteed to be valid (i.e., the value
1085     // cannot yet be stolen), because `mir_validated()`, which steals
1086     // from `mir_const(), forces this query to execute before
1087     // performing the steal.
1088     let mir = &tcx.mir_const(def_id).borrow();
1089
1090     if mir.return_ty().references_error() {
1091         tcx.sess.delay_span_bug(mir.span, "mir_const_qualif: Mir had errors");
1092         return (Qualif::NOT_CONST.bits(), Lrc::new(IdxSetBuf::new_empty(0)));
1093     }
1094
1095     let mut qualifier = Qualifier::new(tcx, def_id, mir, Mode::Const);
1096     let (qualif, promoted_temps) = qualifier.qualify_const();
1097     (qualif.bits(), promoted_temps)
1098 }
1099
1100 pub struct QualifyAndPromoteConstants;
1101
1102 impl MirPass for QualifyAndPromoteConstants {
1103     fn run_pass<'a, 'tcx>(&self,
1104                           tcx: TyCtxt<'a, 'tcx, 'tcx>,
1105                           src: MirSource,
1106                           mir: &mut Mir<'tcx>) {
1107         // There's not really any point in promoting errorful MIR.
1108         if mir.return_ty().references_error() {
1109             tcx.sess.delay_span_bug(mir.span, "QualifyAndPromoteConstants: Mir had errors");
1110             return;
1111         }
1112
1113         if src.promoted.is_some() {
1114             return;
1115         }
1116
1117         let def_id = src.def_id;
1118         let id = tcx.hir.as_local_node_id(def_id).unwrap();
1119         let mut const_promoted_temps = None;
1120         let mode = match tcx.hir.body_owner_kind(id) {
1121             hir::BodyOwnerKind::Fn => {
1122                 if tcx.is_const_fn(def_id) {
1123                     Mode::ConstFn
1124                 } else {
1125                     Mode::Fn
1126                 }
1127             }
1128             hir::BodyOwnerKind::Const => {
1129                 const_promoted_temps = Some(tcx.mir_const_qualif(def_id).1);
1130                 Mode::Const
1131             }
1132             hir::BodyOwnerKind::Static(hir::MutImmutable) => Mode::Static,
1133             hir::BodyOwnerKind::Static(hir::MutMutable) => Mode::StaticMut,
1134         };
1135
1136         if mode == Mode::Fn || mode == Mode::ConstFn {
1137             // This is ugly because Qualifier holds onto mir,
1138             // which can't be mutated until its scope ends.
1139             let (temps, candidates) = {
1140                 let mut qualifier = Qualifier::new(tcx, def_id, mir, mode);
1141                 if mode == Mode::ConstFn {
1142                     // Enforce a constant-like CFG for `const fn`.
1143                     qualifier.qualify_const();
1144                 } else {
1145                     while let Some((bb, data)) = qualifier.rpo.next() {
1146                         qualifier.visit_basic_block_data(bb, data);
1147                     }
1148                 }
1149
1150                 (qualifier.temp_promotion_state, qualifier.promotion_candidates)
1151             };
1152
1153             // Do the actual promotion, now that we know what's viable.
1154             promote_consts::promote_candidates(mir, tcx, temps, candidates);
1155         } else {
1156             let promoted_temps = if mode == Mode::Const {
1157                 // Already computed by `mir_const_qualif`.
1158                 const_promoted_temps.unwrap()
1159             } else {
1160                 Qualifier::new(tcx, def_id, mir, mode).qualify_const().1
1161             };
1162
1163             // In `const` and `static` everything without `StorageDead`
1164             // is `'static`, we don't have to create promoted MIR fragments,
1165             // just remove `Drop` and `StorageDead` on "promoted" locals.
1166             for block in mir.basic_blocks_mut() {
1167                 block.statements.retain(|statement| {
1168                     match statement.kind {
1169                         StatementKind::StorageDead(index) => {
1170                             !promoted_temps.contains(&index)
1171                         }
1172                         _ => true
1173                     }
1174                 });
1175                 let terminator = block.terminator_mut();
1176                 match terminator.kind {
1177                     TerminatorKind::Drop { location: Place::Local(index), target, .. } => {
1178                         if promoted_temps.contains(&index) {
1179                             terminator.kind = TerminatorKind::Goto {
1180                                 target,
1181                             };
1182                         }
1183                     }
1184                     _ => {}
1185                 }
1186             }
1187         }
1188
1189         // Statics must be Sync.
1190         if mode == Mode::Static {
1191             // `#[thread_local]` statics don't have to be `Sync`.
1192             for attr in &tcx.get_attrs(def_id)[..] {
1193                 if attr.check_name("thread_local") {
1194                     return;
1195                 }
1196             }
1197             let ty = mir.return_ty();
1198             tcx.infer_ctxt().enter(|infcx| {
1199                 let param_env = ty::ParamEnv::empty();
1200                 let cause = traits::ObligationCause::new(mir.span, id, traits::SharedStatic);
1201                 let mut fulfillment_cx = traits::FulfillmentContext::new();
1202                 fulfillment_cx.register_bound(&infcx,
1203                                               param_env,
1204                                               ty,
1205                                               tcx.require_lang_item(lang_items::SyncTraitLangItem),
1206                                               cause);
1207                 if let Err(err) = fulfillment_cx.select_all_or_error(&infcx) {
1208                     infcx.report_fulfillment_errors(&err, None, false);
1209                 }
1210             });
1211         }
1212     }
1213 }
1214
1215 fn args_required_const(tcx: TyCtxt, def_id: DefId) -> Option<FxHashSet<usize>> {
1216     let attrs = tcx.get_attrs(def_id);
1217     let attr = attrs.iter().find(|a| a.check_name("rustc_args_required_const"))?;
1218     let mut ret = FxHashSet();
1219     for meta in attr.meta_item_list()? {
1220         match meta.literal()?.node {
1221             LitKind::Int(a, _) => { ret.insert(a as usize); }
1222             _ => return None,
1223         }
1224     }
1225     Some(ret)
1226 }