1 // Copyright 2017 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 use rustc_data_structures::fx::FxHashSet;
12 use rustc_data_structures::indexed_vec::IndexVec;
13 use rustc_data_structures::sync::Lrc;
15 use rustc::ty::query::Providers;
16 use rustc::ty::{self, TyCtxt};
19 use rustc::hir::def_id::DefId;
20 use rustc::lint::builtin::{SAFE_EXTERN_STATICS, SAFE_PACKED_BORROWS, UNUSED_UNSAFE};
22 use rustc::mir::visit::{PlaceContext, Visitor, MutatingUseContext};
25 use syntax::symbol::Symbol;
31 pub struct UnsafetyChecker<'a, 'tcx: 'a> {
34 source_scope_local_data: &'a IndexVec<SourceScope, SourceScopeLocalData>,
35 violations: Vec<UnsafetyViolation>,
36 source_info: SourceInfo,
37 tcx: TyCtxt<'a, 'tcx, 'tcx>,
38 param_env: ty::ParamEnv<'tcx>,
39 /// mark an `unsafe` block as used, so we don't lint it
40 used_unsafe: FxHashSet<ast::NodeId>,
41 inherited_blocks: Vec<(ast::NodeId, bool)>,
44 impl<'a, 'gcx, 'tcx> UnsafetyChecker<'a, 'tcx> {
48 source_scope_local_data: &'a IndexVec<SourceScope, SourceScopeLocalData>,
49 tcx: TyCtxt<'a, 'tcx, 'tcx>,
50 param_env: ty::ParamEnv<'tcx>,
55 source_scope_local_data,
57 source_info: SourceInfo {
59 scope: OUTERMOST_SOURCE_SCOPE
63 used_unsafe: Default::default(),
64 inherited_blocks: vec![],
69 impl<'a, 'tcx> Visitor<'tcx> for UnsafetyChecker<'a, 'tcx> {
70 fn visit_terminator(&mut self,
72 terminator: &Terminator<'tcx>,
75 self.source_info = terminator.source_info;
76 match terminator.kind {
77 TerminatorKind::Goto { .. } |
78 TerminatorKind::SwitchInt { .. } |
79 TerminatorKind::Drop { .. } |
80 TerminatorKind::Yield { .. } |
81 TerminatorKind::Assert { .. } |
82 TerminatorKind::DropAndReplace { .. } |
83 TerminatorKind::GeneratorDrop |
84 TerminatorKind::Resume |
85 TerminatorKind::Abort |
86 TerminatorKind::Return |
87 TerminatorKind::Unreachable |
88 TerminatorKind::FalseEdges { .. } |
89 TerminatorKind::FalseUnwind { .. } => {
90 // safe (at least as emitted during MIR construction)
93 TerminatorKind::Call { ref func, .. } => {
94 let func_ty = func.ty(self.mir, self.tcx);
95 let sig = func_ty.fn_sig(self.tcx);
96 if let hir::Unsafety::Unsafe = sig.unsafety() {
97 self.require_unsafe("call to unsafe function",
98 "consult the function's documentation for information on how to avoid \
99 undefined behavior", UnsafetyViolationKind::MinConstFn)
103 self.super_terminator(block, terminator, location);
106 fn visit_statement(&mut self,
108 statement: &Statement<'tcx>,
111 self.source_info = statement.source_info;
112 match statement.kind {
113 StatementKind::Assign(..) |
114 StatementKind::FakeRead(..) |
115 StatementKind::SetDiscriminant { .. } |
116 StatementKind::StorageLive(..) |
117 StatementKind::StorageDead(..) |
118 StatementKind::Retag { .. } |
119 StatementKind::EscapeToRaw { .. } |
120 StatementKind::AscribeUserType(..) |
121 StatementKind::Nop => {
122 // safe (at least as emitted during MIR construction)
125 StatementKind::InlineAsm { .. } => {
126 self.require_unsafe("use of inline assembly",
127 "inline assembly is entirely unchecked and can cause undefined behavior",
128 UnsafetyViolationKind::General)
131 self.super_statement(block, statement, location);
134 fn visit_rvalue(&mut self,
135 rvalue: &Rvalue<'tcx>,
138 if let &Rvalue::Aggregate(box ref aggregate, _) = rvalue {
140 &AggregateKind::Array(..) |
141 &AggregateKind::Tuple => {}
142 &AggregateKind::Adt(ref def, ..) => {
143 match self.tcx.layout_scalar_valid_range(def.did) {
144 (Bound::Unbounded, Bound::Unbounded) => {},
145 _ => self.require_unsafe(
146 "initializing type with `rustc_layout_scalar_valid_range` attr",
147 "initializing `NonZero` with a `0` violates layout constraints \
148 and is undefined behavior",
149 UnsafetyViolationKind::MinConstFn,
153 &AggregateKind::Closure(def_id, _) |
154 &AggregateKind::Generator(def_id, _, _) => {
155 let UnsafetyCheckResult {
156 violations, unsafe_blocks
157 } = self.tcx.unsafety_check_result(def_id);
158 self.register_violations(&violations, &unsafe_blocks);
162 self.super_rvalue(rvalue, location);
165 fn visit_place(&mut self,
167 context: PlaceContext<'tcx>,
168 location: Location) {
169 if context.is_borrow() {
170 if util::is_disaligned(self.tcx, self.mir, self.param_env, place) {
171 let source_info = self.source_info;
173 self.source_scope_local_data[source_info.scope].lint_root;
174 self.register_violations(&[UnsafetyViolation {
176 description: Symbol::intern("borrow of packed field").as_interned_str(),
178 Symbol::intern("fields of packed structs might be misaligned: \
179 dereferencing a misaligned pointer or even just creating a \
180 misaligned reference is undefined behavior")
182 kind: UnsafetyViolationKind::BorrowPacked(lint_root)
188 &Place::Projection(box Projection {
191 let old_source_info = self.source_info;
192 if let &Place::Local(local) = base {
193 if self.mir.local_decls[local].internal {
194 // Internal locals are used in the `move_val_init` desugaring.
195 // We want to check unsafety against the source info of the
196 // desugaring, rather than the source info of the RHS.
197 self.source_info = self.mir.local_decls[local].source_info;
200 let base_ty = base.ty(self.mir, self.tcx).to_ty(self.tcx);
203 self.require_unsafe("dereference of raw pointer",
204 "raw pointers may be NULL, dangling or unaligned; they can violate \
205 aliasing rules and cause data races: all of these are undefined \
206 behavior", UnsafetyViolationKind::General)
210 if context == PlaceContext::MutatingUse(MutatingUseContext::Store) ||
211 context == PlaceContext::MutatingUse(MutatingUseContext::Drop) ||
212 context == PlaceContext::MutatingUse(
213 MutatingUseContext::AsmOutput
216 let elem_ty = match elem {
217 &ProjectionElem::Field(_, ty) => ty,
219 self.source_info.span,
220 "non-field projection {:?} from union?",
223 if elem_ty.moves_by_default(self.tcx, self.param_env,
224 self.source_info.span) {
226 "assignment to non-`Copy` union field",
227 "the previous content of the field will be dropped, which \
228 causes undefined behavior if the field was not properly \
229 initialized", UnsafetyViolationKind::General)
231 // write to non-move union, safe
234 self.require_unsafe("access to union field",
235 "the field may not be properly initialized: using \
236 uninitialized data will cause undefined behavior",
237 UnsafetyViolationKind::General)
243 self.source_info = old_source_info;
245 &Place::Local(..) => {
248 &Place::Promoted(_) => {
249 bug!("unsafety checking should happen before promotion")
251 &Place::Static(box Static { def_id, ty: _ }) => {
252 if self.tcx.is_static(def_id) == Some(hir::Mutability::MutMutable) {
253 self.require_unsafe("use of mutable static",
254 "mutable statics can be mutated by multiple threads: aliasing violations \
255 or data races will cause undefined behavior",
256 UnsafetyViolationKind::General);
257 } else if self.tcx.is_foreign_item(def_id) {
258 let source_info = self.source_info;
260 self.source_scope_local_data[source_info.scope].lint_root;
261 self.register_violations(&[UnsafetyViolation {
263 description: Symbol::intern("use of extern static").as_interned_str(),
265 Symbol::intern("extern statics are not controlled by the Rust type \
266 system: invalid data, aliasing violations or data \
267 races will cause undefined behavior")
269 kind: UnsafetyViolationKind::ExternStatic(lint_root)
274 self.super_place(place, context, location);
278 impl<'a, 'tcx> UnsafetyChecker<'a, 'tcx> {
281 description: &'static str,
282 details: &'static str,
283 kind: UnsafetyViolationKind,
285 let source_info = self.source_info;
286 self.register_violations(&[UnsafetyViolation {
288 description: Symbol::intern(description).as_interned_str(),
289 details: Symbol::intern(details).as_interned_str(),
294 fn register_violations(&mut self,
295 violations: &[UnsafetyViolation],
296 unsafe_blocks: &[(ast::NodeId, bool)]) {
297 let safety = self.source_scope_local_data[self.source_info.scope].safety;
298 let within_unsafe = match (safety, self.min_const_fn) {
299 // Erring on the safe side, pun intended
300 (Safety::BuiltinUnsafe, true) |
301 // mir building encodes const fn bodies as safe, even for `const unsafe fn`
302 (Safety::FnUnsafe, true) => bug!("const unsafe fn body treated as inherently unsafe"),
303 // `unsafe` blocks are required in safe code
304 (Safety::Safe, _) => {
305 for violation in violations {
306 let mut violation = violation.clone();
307 if self.min_const_fn {
308 // overwrite unsafety violation in const fn with a single hard error kind
309 violation.kind = UnsafetyViolationKind::MinConstFn;
310 } else if let UnsafetyViolationKind::MinConstFn = violation.kind {
311 // outside of const fns we treat `MinConstFn` and `General` the same
312 violation.kind = UnsafetyViolationKind::General;
314 if !self.violations.contains(&violation) {
315 self.violations.push(violation)
320 // regular `unsafe` function bodies allow unsafe without additional unsafe blocks
321 (Safety::BuiltinUnsafe, false) | (Safety::FnUnsafe, false) => true,
322 (Safety::ExplicitUnsafe(node_id), _) => {
323 // mark unsafe block as used if there are any unsafe operations inside
324 if !violations.is_empty() {
325 self.used_unsafe.insert(node_id);
327 // only some unsafety is allowed in const fn
328 if self.min_const_fn {
329 for violation in violations {
330 match violation.kind {
332 UnsafetyViolationKind::MinConstFn
333 // if `#![feature(min_const_unsafe_fn)]` is active
334 if self.tcx.sess.features_untracked().min_const_unsafe_fn => {},
336 let mut violation = violation.clone();
337 // overwrite unsafety violation in const fn with a hard error
338 violation.kind = UnsafetyViolationKind::MinConstFn;
339 if !self.violations.contains(&violation) {
340 self.violations.push(violation)
349 self.inherited_blocks.extend(unsafe_blocks.iter().map(|&(node_id, is_used)| {
350 (node_id, is_used && !within_unsafe)
355 pub(crate) fn provide(providers: &mut Providers) {
356 *providers = Providers {
357 unsafety_check_result,
358 unsafe_derive_on_repr_packed,
363 struct UnusedUnsafeVisitor<'a> {
364 used_unsafe: &'a FxHashSet<ast::NodeId>,
365 unsafe_blocks: &'a mut Vec<(ast::NodeId, bool)>,
368 impl<'a, 'tcx> hir::intravisit::Visitor<'tcx> for UnusedUnsafeVisitor<'a> {
369 fn nested_visit_map<'this>(&'this mut self) ->
370 hir::intravisit::NestedVisitorMap<'this, 'tcx>
372 hir::intravisit::NestedVisitorMap::None
375 fn visit_block(&mut self, block: &'tcx hir::Block) {
376 hir::intravisit::walk_block(self, block);
378 if let hir::UnsafeBlock(hir::UserProvided) = block.rules {
379 self.unsafe_blocks.push((block.id, self.used_unsafe.contains(&block.id)));
384 fn check_unused_unsafe<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
386 used_unsafe: &FxHashSet<ast::NodeId>,
387 unsafe_blocks: &'a mut Vec<(ast::NodeId, bool)>)
390 tcx.hir.as_local_node_id(def_id).and_then(|node_id| {
391 tcx.hir.maybe_body_owned_by(node_id)
394 let body_id = match body_id {
397 debug!("check_unused_unsafe({:?}) - no body found", def_id);
401 let body = tcx.hir.body(body_id);
402 debug!("check_unused_unsafe({:?}, body={:?}, used_unsafe={:?})",
403 def_id, body, used_unsafe);
405 let mut visitor = UnusedUnsafeVisitor { used_unsafe, unsafe_blocks };
406 hir::intravisit::Visitor::visit_body(&mut visitor, body);
409 fn unsafety_check_result<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>, def_id: DefId)
410 -> UnsafetyCheckResult
412 debug!("unsafety_violations({:?})", def_id);
414 // NB: this borrow is valid because all the consumers of
415 // `mir_built` force this.
416 let mir = &tcx.mir_built(def_id).borrow();
418 let source_scope_local_data = match mir.source_scope_local_data {
419 ClearCrossCrate::Set(ref data) => data,
420 ClearCrossCrate::Clear => {
421 debug!("unsafety_violations: {:?} - remote, skipping", def_id);
422 return UnsafetyCheckResult {
423 violations: Lrc::new([]),
424 unsafe_blocks: Lrc::new([])
429 let param_env = tcx.param_env(def_id);
430 let mut checker = UnsafetyChecker::new(
431 tcx.is_const_fn(def_id) && tcx.is_min_const_fn(def_id),
432 mir, source_scope_local_data, tcx, param_env);
433 checker.visit_mir(mir);
435 check_unused_unsafe(tcx, def_id, &checker.used_unsafe, &mut checker.inherited_blocks);
436 UnsafetyCheckResult {
437 violations: checker.violations.into(),
438 unsafe_blocks: checker.inherited_blocks.into()
442 fn unsafe_derive_on_repr_packed<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>, def_id: DefId) {
443 let lint_node_id = match tcx.hir.as_local_node_id(def_id) {
444 Some(node_id) => node_id,
445 None => bug!("checking unsafety for non-local def id {:?}", def_id)
448 // FIXME: when we make this a hard error, this should have its
450 let message = if tcx.generics_of(def_id).own_counts().types != 0 {
451 "#[derive] can't be used on a #[repr(packed)] struct with \
452 type parameters (error E0133)".to_string()
454 "#[derive] can't be used on a #[repr(packed)] struct that \
455 does not derive Copy (error E0133)".to_string()
457 tcx.lint_node(SAFE_PACKED_BORROWS,
459 tcx.def_span(def_id),
463 /// Return the NodeId for an enclosing scope that is also `unsafe`
464 fn is_enclosed(tcx: TyCtxt,
465 used_unsafe: &FxHashSet<ast::NodeId>,
466 id: ast::NodeId) -> Option<(String, ast::NodeId)> {
467 let parent_id = tcx.hir.get_parent_node(id);
469 if used_unsafe.contains(&parent_id) {
470 Some(("block".to_string(), parent_id))
471 } else if let Some(Node::Item(&hir::Item {
472 node: hir::ItemKind::Fn(_, header, _, _),
474 })) = tcx.hir.find(parent_id) {
475 match header.unsafety {
476 hir::Unsafety::Unsafe => Some(("fn".to_string(), parent_id)),
477 hir::Unsafety::Normal => None,
480 is_enclosed(tcx, used_unsafe, parent_id)
487 fn report_unused_unsafe(tcx: TyCtxt, used_unsafe: &FxHashSet<ast::NodeId>, id: ast::NodeId) {
488 let span = tcx.sess.source_map().def_span(tcx.hir.span(id));
489 let msg = "unnecessary `unsafe` block";
490 let mut db = tcx.struct_span_lint_node(UNUSED_UNSAFE, id, span, msg);
491 db.span_label(span, msg);
492 if let Some((kind, id)) = is_enclosed(tcx, used_unsafe, id) {
493 db.span_label(tcx.sess.source_map().def_span(tcx.hir.span(id)),
494 format!("because it's nested under this `unsafe` {}", kind));
499 fn builtin_derive_def_id<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>, def_id: DefId) -> Option<DefId> {
500 debug!("builtin_derive_def_id({:?})", def_id);
501 if let Some(impl_def_id) = tcx.impl_of_method(def_id) {
502 if tcx.has_attr(impl_def_id, "automatically_derived") {
503 debug!("builtin_derive_def_id({:?}) - is {:?}", def_id, impl_def_id);
506 debug!("builtin_derive_def_id({:?}) - not automatically derived", def_id);
510 debug!("builtin_derive_def_id({:?}) - not a method", def_id);
515 pub fn check_unsafety<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>, def_id: DefId) {
516 debug!("check_unsafety({:?})", def_id);
518 // closures are handled by their parent fn.
519 if tcx.is_closure(def_id) {
523 let UnsafetyCheckResult {
526 } = tcx.unsafety_check_result(def_id);
528 for &UnsafetyViolation {
529 source_info, description, details, kind
530 } in violations.iter() {
533 UnsafetyViolationKind::General => {
535 tcx.sess, source_info.span, E0133,
536 "{} is unsafe and requires unsafe function or block", description)
537 .span_label(source_info.span, &description.as_str()[..])
538 .note(&details.as_str()[..])
541 UnsafetyViolationKind::MinConstFn => {
542 tcx.sess.struct_span_err(
544 &format!("{} is unsafe and unsafe operations \
545 are not allowed in const fn", description))
546 .span_label(source_info.span, &description.as_str()[..])
547 .note(&details.as_str()[..])
550 UnsafetyViolationKind::ExternStatic(lint_node_id) => {
551 tcx.lint_node_note(SAFE_EXTERN_STATICS,
554 &format!("{} is unsafe and requires unsafe function or block \
555 (error E0133)", &description.as_str()[..]),
556 &details.as_str()[..]);
558 UnsafetyViolationKind::BorrowPacked(lint_node_id) => {
559 if let Some(impl_def_id) = builtin_derive_def_id(tcx, def_id) {
560 tcx.unsafe_derive_on_repr_packed(impl_def_id);
562 tcx.lint_node_note(SAFE_PACKED_BORROWS,
565 &format!("{} is unsafe and requires unsafe function or block \
566 (error E0133)", &description.as_str()[..]),
567 &details.as_str()[..]);
573 let mut unsafe_blocks: Vec<_> = unsafe_blocks.into_iter().collect();
574 unsafe_blocks.sort();
575 let used_unsafe: FxHashSet<_> = unsafe_blocks.iter()
576 .flat_map(|&&(id, used)| if used { Some(id) } else { None })
578 for &(block_id, is_used) in unsafe_blocks {
580 report_unused_unsafe(tcx, &used_unsafe, block_id);