1 // Copyright 2012-2014 The Rust Project Developers. See the COPYRIGHT
2 // file at the top-level directory of this distribution and at
3 // http://rust-lang.org/COPYRIGHT.
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.
11 // Verifies that the types and values of const and static items
12 // are safe. The rules enforced by this module are:
14 // - For each *mutable* static item, it checks that its **type**:
15 // - doesn't have a destructor
16 // - doesn't own a box
18 // - For each *immutable* static item, it checks that its **value**:
19 // - doesn't own a box
20 // - doesn't contain a struct literal or a call to an enum variant / struct constructor where
21 // - the type of the struct/enum has a dtor
23 // Rules Enforced Elsewhere:
24 // - It's not possible to take the address of a static item with unsafe interior. This is enforced
25 // by borrowck::gather_loans
27 use rustc::ty::cast::CastKind;
28 use rustc_const_eval::ConstContext;
29 use rustc::middle::const_val::ConstEvalErr;
30 use rustc::middle::const_val::ErrKind::{IndexOpFeatureGated, UnimplementedConstVal, MiscCatchAll};
31 use rustc::middle::const_val::ErrKind::{ErroneousReferencedConstant, MiscBinaryOp, NonConstPath};
32 use rustc::middle::const_val::ErrKind::{TypeckError, Math};
33 use rustc_const_math::{ConstMathErr, Op};
34 use rustc::hir::def::{Def, CtorKind};
35 use rustc::hir::def_id::DefId;
36 use rustc::hir::map::blocks::FnLikeNode;
37 use rustc::middle::expr_use_visitor as euv;
38 use rustc::middle::mem_categorization as mc;
39 use rustc::middle::mem_categorization::Categorization;
40 use rustc::mir::transform::MirSource;
41 use rustc::ty::{self, Ty, TyCtxt};
42 use rustc::traits::Reveal;
43 use rustc::util::common::ErrorReported;
44 use rustc::util::nodemap::NodeSet;
45 use rustc::lint::builtin::CONST_ERR;
47 use rustc::hir::{self, PatKind, RangeEnd};
50 use rustc::hir::intravisit::{self, Visitor, NestedVisitorMap};
52 use std::collections::hash_map::Entry;
53 use std::cmp::Ordering;
56 struct CheckCrateVisitor<'a, 'tcx: 'a> {
57 tcx: TyCtxt<'a, 'tcx, 'tcx>,
60 mut_rvalue_borrows: NodeSet,
61 param_env: ty::ParameterEnvironment<'tcx>,
62 tables: &'a ty::TypeckTables<'tcx>,
65 impl<'a, 'gcx> CheckCrateVisitor<'a, 'gcx> {
66 fn check_const_eval(&self, expr: &'gcx hir::Expr) {
67 let const_cx = ConstContext::with_tables(self.tcx, self.tables);
68 if let Err(err) = const_cx.eval(expr) {
70 UnimplementedConstVal(_) => {}
71 IndexOpFeatureGated => {}
72 ErroneousReferencedConstant(_) => {}
75 self.tcx.sess.add_lint(CONST_ERR,
78 format!("constant evaluation error: {}. This will \
79 become a HARD ERROR in the future",
80 err.description().into_oneline()))
86 // Adds the worst effect out of all the values of one type.
87 fn add_type(&mut self, ty: Ty<'gcx>) {
88 if ty.type_contents(self.tcx).interior_unsafe() {
89 self.promotable = false;
92 if self.tcx.type_needs_drop_given_env(ty, &self.param_env) {
93 self.promotable = false;
97 fn handle_const_fn_call(&mut self, def_id: DefId, ret_ty: Ty<'gcx>) {
98 self.add_type(ret_ty);
100 self.promotable &= if let Some(fn_id) = self.tcx.hir.as_local_node_id(def_id) {
101 FnLikeNode::from_node(self.tcx.hir.get(fn_id)).map_or(false, |fn_like| {
102 fn_like.constness() == hir::Constness::Const
105 self.tcx.sess.cstore.is_const_fn(def_id)
110 impl<'a, 'tcx> Visitor<'tcx> for CheckCrateVisitor<'a, 'tcx> {
111 fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'tcx> {
112 NestedVisitorMap::None
115 fn visit_nested_body(&mut self, body_id: hir::BodyId) {
116 match self.tcx.rvalue_promotable_to_static.borrow_mut().entry(body_id.node_id) {
117 Entry::Occupied(_) => return,
118 Entry::Vacant(entry) => {
119 // Prevent infinite recursion on re-entry.
124 let item_id = self.tcx.hir.body_owner(body_id);
126 let outer_in_fn = self.in_fn;
127 self.in_fn = match MirSource::from_node(self.tcx, item_id) {
128 MirSource::Fn(_) => true,
132 let outer_tables = self.tables;
133 self.tables = self.tcx.item_tables(self.tcx.hir.local_def_id(item_id));
135 let body = self.tcx.hir.body(body_id);
137 self.check_const_eval(&body.value);
140 let outer_penv = self.tcx.infer_ctxt(body_id, Reveal::UserFacing).enter(|infcx| {
141 let param_env = infcx.parameter_environment.clone();
142 let outer_penv = mem::replace(&mut self.param_env, param_env);
143 euv::ExprUseVisitor::new(self, &infcx).consume_body(body);
147 self.visit_body(body);
149 self.param_env = outer_penv;
150 self.tables = outer_tables;
151 self.in_fn = outer_in_fn;
154 fn visit_pat(&mut self, p: &'tcx hir::Pat) {
156 PatKind::Lit(ref lit) => {
157 self.check_const_eval(lit);
159 PatKind::Range(ref start, ref end, RangeEnd::Excluded) => {
160 let const_cx = ConstContext::with_tables(self.tcx, self.tables);
161 match const_cx.compare_lit_exprs(p.span, start, end) {
162 Ok(Ordering::Less) => {}
163 Ok(Ordering::Equal) |
164 Ok(Ordering::Greater) => {
165 span_err!(self.tcx.sess,
168 "lower range bound must be less than upper");
170 Err(ErrorReported) => {}
173 PatKind::Range(ref start, ref end, RangeEnd::Included) => {
174 let const_cx = ConstContext::with_tables(self.tcx, self.tables);
175 match const_cx.compare_lit_exprs(p.span, start, end) {
177 Ok(Ordering::Equal) => {}
178 Ok(Ordering::Greater) => {
179 struct_span_err!(self.tcx.sess, start.span, E0030,
180 "lower range bound must be less than or equal to upper")
181 .span_label(start.span, &format!("lower bound larger than upper bound"))
184 Err(ErrorReported) => {}
189 intravisit::walk_pat(self, p);
192 fn visit_stmt(&mut self, stmt: &'tcx hir::Stmt) {
194 hir::StmtDecl(ref decl, _) => {
196 hir::DeclLocal(_) => {
197 self.promotable = false;
199 // Item statements are allowed
200 hir::DeclItem(_) => {}
204 hir::StmtSemi(..) => {
205 self.promotable = false;
208 intravisit::walk_stmt(self, stmt);
211 fn visit_expr(&mut self, ex: &'tcx hir::Expr) {
212 let outer = self.promotable;
213 self.promotable = true;
215 let node_ty = self.tables.node_id_to_type(ex.id);
216 check_expr(self, ex, node_ty);
217 check_adjustments(self, ex);
219 if let hir::ExprMatch(ref discr, ref arms, _) = ex.node {
220 // Compute the most demanding borrow from all the arms'
221 // patterns and set that on the discriminator.
222 let mut mut_borrow = false;
223 for pat in arms.iter().flat_map(|arm| &arm.pats) {
224 if self.mut_rvalue_borrows.remove(&pat.id) {
229 self.mut_rvalue_borrows.insert(discr.id);
233 intravisit::walk_expr(self, ex);
235 // Handle borrows on (or inside the autorefs of) this expression.
236 if self.mut_rvalue_borrows.remove(&ex.id) {
237 self.promotable = false;
240 if self.in_fn && self.promotable {
241 let const_cx = ConstContext::with_tables(self.tcx, self.tables);
242 match const_cx.eval(ex) {
244 Err(ConstEvalErr { kind: UnimplementedConstVal(_), .. }) |
245 Err(ConstEvalErr { kind: MiscCatchAll, .. }) |
246 Err(ConstEvalErr { kind: MiscBinaryOp, .. }) |
247 Err(ConstEvalErr { kind: NonConstPath, .. }) |
248 Err(ConstEvalErr { kind: ErroneousReferencedConstant(_), .. }) |
249 Err(ConstEvalErr { kind: Math(ConstMathErr::Overflow(Op::Shr)), .. }) |
250 Err(ConstEvalErr { kind: Math(ConstMathErr::Overflow(Op::Shl)), .. }) |
251 Err(ConstEvalErr { kind: IndexOpFeatureGated, .. }) => {}
252 Err(ConstEvalErr { kind: TypeckError, .. }) => {}
254 self.tcx.sess.add_lint(CONST_ERR,
257 msg.description().into_oneline().into_owned())
262 self.tcx.rvalue_promotable_to_static.borrow_mut().insert(ex.id, self.promotable);
263 self.promotable &= outer;
267 /// This function is used to enforce the constraints on
268 /// const/static items. It walks through the *value*
269 /// of the item walking down the expression and evaluating
270 /// every nested expression. If the expression is not part
271 /// of a const/static item, it is qualified for promotion
272 /// instead of producing errors.
273 fn check_expr<'a, 'tcx>(v: &mut CheckCrateVisitor<'a, 'tcx>, e: &hir::Expr, node_ty: Ty<'tcx>) {
275 ty::TyAdt(def, _) if def.has_dtor(v.tcx) => {
276 v.promotable = false;
281 let method_call = ty::MethodCall::expr(e.id);
284 hir::ExprBinary(..) |
285 hir::ExprIndex(..) if v.tables.method_map.contains_key(&method_call) => {
286 v.promotable = false;
289 v.promotable = false;
291 hir::ExprUnary(op, ref inner) => {
292 match v.tables.node_id_to_type(inner.id).sty {
294 assert!(op == hir::UnDeref);
296 v.promotable = false;
301 hir::ExprBinary(op, ref lhs, _) => {
302 match v.tables.node_id_to_type(lhs.id).sty {
304 assert!(op.node == hir::BiEq || op.node == hir::BiNe ||
305 op.node == hir::BiLe || op.node == hir::BiLt ||
306 op.node == hir::BiGe || op.node == hir::BiGt);
308 v.promotable = false;
313 hir::ExprCast(ref from, _) => {
314 debug!("Checking const cast(id={})", from.id);
315 match v.tables.cast_kinds.get(&from.id) {
316 None => span_bug!(e.span, "no kind for cast"),
317 Some(&CastKind::PtrAddrCast) | Some(&CastKind::FnPtrAddrCast) => {
318 v.promotable = false;
323 hir::ExprPath(ref qpath) => {
324 let def = v.tables.qpath_def(qpath, e.id);
326 Def::VariantCtor(..) | Def::StructCtor(..) |
327 Def::Fn(..) | Def::Method(..) => {}
328 Def::AssociatedConst(_) => v.add_type(node_ty),
330 v.promotable &= if let Some(node_id) = v.tcx.hir.as_local_node_id(did) {
331 match v.tcx.hir.expect_item(node_id).node {
332 hir::ItemConst(_, body) => {
333 v.visit_nested_body(body);
334 v.tcx.rvalue_promotable_to_static.borrow()[&body.node_id]
339 v.tcx.sess.cstore.const_is_rvalue_promotable_to_static(did)
343 v.promotable = false;
347 hir::ExprCall(ref callee, _) => {
348 let mut callee = &**callee;
350 callee = match callee.node {
351 hir::ExprBlock(ref block) => match block.expr {
352 Some(ref tail) => &tail,
358 // The callee is an arbitrary expression, it doesn't necessarily have a definition.
359 let def = if let hir::ExprPath(ref qpath) = callee.node {
360 v.tables.qpath_def(qpath, callee.id)
365 Def::StructCtor(_, CtorKind::Fn) |
366 Def::VariantCtor(_, CtorKind::Fn) => {}
368 v.handle_const_fn_call(did, node_ty)
370 Def::Method(did) => {
371 match v.tcx.associated_item(did).container {
372 ty::ImplContainer(_) => {
373 v.handle_const_fn_call(did, node_ty)
375 ty::TraitContainer(_) => v.promotable = false
378 _ => v.promotable = false
381 hir::ExprMethodCall(..) => {
382 let method = v.tables.method_map[&method_call];
383 match v.tcx.associated_item(method.def_id).container {
384 ty::ImplContainer(_) => v.handle_const_fn_call(method.def_id, node_ty),
385 ty::TraitContainer(_) => v.promotable = false
388 hir::ExprStruct(..) => {
389 if let ty::TyAdt(adt, ..) = v.tables.expr_ty(e).sty {
390 // unsafe_cell_type doesn't necessarily exist with no_core
391 if Some(adt.did) == v.tcx.lang_items.unsafe_cell_type() {
392 v.promotable = false;
398 hir::ExprAddrOf(..) |
399 hir::ExprRepeat(..) => {}
401 hir::ExprClosure(..) => {
402 // Paths in constant contexts cannot refer to local variables,
403 // as there are none, and thus closures can't have upvars there.
404 if v.tcx.with_freevars(e.id, |fv| !fv.is_empty()) {
405 v.promotable = false;
412 hir::ExprTupField(..) |
415 hir::ExprTup(..) => {}
417 // Conditional control flow (possible to implement).
421 // Loops (not very meaningful in constants).
425 // More control flow (also not very meaningful).
430 // Expressions with side-effects.
431 hir::ExprAssign(..) |
432 hir::ExprAssignOp(..) |
433 hir::ExprInlineAsm(..) => {
434 v.promotable = false;
439 /// Check the adjustments of an expression
440 fn check_adjustments<'a, 'tcx>(v: &mut CheckCrateVisitor<'a, 'tcx>, e: &hir::Expr) {
441 use rustc::ty::adjustment::*;
443 match v.tables.adjustments.get(&e.id).map(|adj| adj.kind) {
445 Some(Adjust::NeverToAny) |
446 Some(Adjust::ReifyFnPointer) |
447 Some(Adjust::UnsafeFnPointer) |
448 Some(Adjust::ClosureFnPointer) |
449 Some(Adjust::MutToConstPointer) => {}
451 Some(Adjust::DerefRef { autoderefs, .. }) => {
452 if (0..autoderefs as u32)
453 .any(|autoderef| v.tables.is_overloaded_autoderef(e.id, autoderef)) {
454 v.promotable = false;
460 pub fn check_crate<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>) {
461 tcx.hir.krate().visit_all_item_likes(&mut CheckCrateVisitor {
463 tables: &ty::TypeckTables::empty(),
466 mut_rvalue_borrows: NodeSet(),
467 param_env: tcx.empty_parameter_environment(),
468 }.as_deep_visitor());
469 tcx.sess.abort_if_errors();
472 impl<'a, 'gcx, 'tcx> euv::Delegate<'tcx> for CheckCrateVisitor<'a, 'gcx> {
473 fn consume(&mut self,
474 _consume_id: ast::NodeId,
477 _mode: euv::ConsumeMode) {}
480 borrow_id: ast::NodeId,
483 _loan_region: &'tcx ty::Region,
485 loan_cause: euv::LoanCause) {
486 // Kind of hacky, but we allow Unsafe coercions in constants.
487 // These occur when we convert a &T or *T to a *U, as well as
488 // when making a thin pointer (e.g., `*T`) into a fat pointer
491 euv::LoanCause::AutoUnsafe => {
500 Categorization::Rvalue(..) => {
501 if loan_cause == euv::MatchDiscriminant {
502 // Ignore the dummy immutable borrow created by EUV.
505 if bk.to_mutbl_lossy() == hir::MutMutable {
506 self.mut_rvalue_borrows.insert(borrow_id);
510 Categorization::StaticItem => {
513 Categorization::Deref(ref cmt, ..) |
514 Categorization::Downcast(ref cmt, _) |
515 Categorization::Interior(ref cmt, _) => {
519 Categorization::Upvar(..) |
520 Categorization::Local(..) => break,
525 fn decl_without_init(&mut self, _id: ast::NodeId, _span: Span) {}
527 _assignment_id: ast::NodeId,
528 _assignment_span: Span,
529 _assignee_cmt: mc::cmt,
530 _mode: euv::MutateMode) {
533 fn matched_pat(&mut self, _: &hir::Pat, _: mc::cmt, _: euv::MatchMode) {}
535 fn consume_pat(&mut self, _consume_pat: &hir::Pat, _cmt: mc::cmt, _mode: euv::ConsumeMode) {}