src/librustc_mir/transform/check_unsafety.rs

   1 use rustc_data_structures::fx::FxHashSet;
   2 use rustc_data_structures::indexed_vec::IndexVec;
   3 use rustc_data_structures::sync::Lrc;
   4
   5 use rustc::ty::query::Providers;
   6 use rustc::ty::{self, TyCtxt};
   7 use rustc::ty::cast::CastTy;
   8 use rustc::hir;
   9 use rustc::hir::Node;
  10 use rustc::hir::def_id::DefId;
  11 use rustc::lint::builtin::{SAFE_EXTERN_STATICS, SAFE_PACKED_BORROWS, UNUSED_UNSAFE};
  12 use rustc::mir::*;
  13 use rustc::mir::visit::{PlaceContext, Visitor, MutatingUseContext};
  14
  15 use syntax::symbol::{InternedString, sym};
  16
  17 use std::ops::Bound;
  18
  19 use crate::util;
  20
  21 pub struct UnsafetyChecker<'a, 'tcx: 'a> {
  22     mir: &'a Body<'tcx>,
  23     const_context: bool,
  24     min_const_fn: bool,
  25     source_scope_local_data: &'a IndexVec<SourceScope, SourceScopeLocalData>,
  26     violations: Vec<UnsafetyViolation>,
  27     source_info: SourceInfo,
  28     tcx: TyCtxt<'a, 'tcx, 'tcx>,
  29     param_env: ty::ParamEnv<'tcx>,
  30     /// Mark an `unsafe` block as used, so we don't lint it.
  31     used_unsafe: FxHashSet<hir::HirId>,
  32     inherited_blocks: Vec<(hir::HirId, bool)>,
  33 }
  34
  35 impl<'a, 'gcx, 'tcx> UnsafetyChecker<'a, 'tcx> {
  36     fn new(
  37         const_context: bool,
  38         min_const_fn: bool,
  39         mir: &'a Body<'tcx>,
  40         source_scope_local_data: &'a IndexVec<SourceScope, SourceScopeLocalData>,
  41         tcx: TyCtxt<'a, 'tcx, 'tcx>,
  42         param_env: ty::ParamEnv<'tcx>,
  43     ) -> Self {
  44         // sanity check
  45         if min_const_fn {
  46             assert!(const_context);
  47         }
  48         Self {
  49             mir,
  50             const_context,
  51             min_const_fn,
  52             source_scope_local_data,
  53             violations: vec![],
  54             source_info: SourceInfo {
  55                 span: mir.span,
  56                 scope: OUTERMOST_SOURCE_SCOPE
  57             },
  58             tcx,
  59             param_env,
  60             used_unsafe: Default::default(),
  61             inherited_blocks: vec![],
  62         }
  63     }
  64 }
  65
  66 impl<'a, 'tcx> Visitor<'tcx> for UnsafetyChecker<'a, 'tcx> {
  67     fn visit_terminator(&mut self,
  68                         terminator: &Terminator<'tcx>,
  69                         location: Location)
  70     {
  71         self.source_info = terminator.source_info;
  72         match terminator.kind {
  73             TerminatorKind::Goto { .. } |
  74             TerminatorKind::SwitchInt { .. } |
  75             TerminatorKind::Drop { .. } |
  76             TerminatorKind::Yield { .. } |
  77             TerminatorKind::Assert { .. } |
  78             TerminatorKind::DropAndReplace { .. } |
  79             TerminatorKind::GeneratorDrop |
  80             TerminatorKind::Resume |
  81             TerminatorKind::Abort |
  82             TerminatorKind::Return |
  83             TerminatorKind::Unreachable |
  84             TerminatorKind::FalseEdges { .. } |
  85             TerminatorKind::FalseUnwind { .. } => {
  86                 // safe (at least as emitted during MIR construction)
  87             }
  88
  89             TerminatorKind::Call { ref func, .. } => {
  90                 let func_ty = func.ty(self.mir, self.tcx);
  91                 let sig = func_ty.fn_sig(self.tcx);
  92                 if let hir::Unsafety::Unsafe = sig.unsafety() {
  93                     self.require_unsafe("call to unsafe function",
  94                         "consult the function's documentation for information on how to avoid \
  95                          undefined behavior", UnsafetyViolationKind::GeneralAndConstFn)
  96                 }
  97             }
  98         }
  99         self.super_terminator(terminator, location);
 100     }
 101
 102     fn visit_statement(&mut self,
 103                        statement: &Statement<'tcx>,
 104                        location: Location)
 105     {
 106         self.source_info = statement.source_info;
 107         match statement.kind {
 108             StatementKind::Assign(..) |
 109             StatementKind::FakeRead(..) |
 110             StatementKind::SetDiscriminant { .. } |
 111             StatementKind::StorageLive(..) |
 112             StatementKind::StorageDead(..) |
 113             StatementKind::Retag { .. } |
 114             StatementKind::AscribeUserType(..) |
 115             StatementKind::Nop => {
 116                 // safe (at least as emitted during MIR construction)
 117             }
 118
 119             StatementKind::InlineAsm { .. } => {
 120                 self.require_unsafe("use of inline assembly",
 121                     "inline assembly is entirely unchecked and can cause undefined behavior",
 122                     UnsafetyViolationKind::General)
 123             },
 124         }
 125         self.super_statement(statement, location);
 126     }
 127
 128     fn visit_rvalue(&mut self,
 129                     rvalue: &Rvalue<'tcx>,
 130                     location: Location)
 131     {
 132         match rvalue {
 133             Rvalue::Aggregate(box ref aggregate, _) => {
 134                 match aggregate {
 135                     &AggregateKind::Array(..) |
 136                     &AggregateKind::Tuple => {}
 137                     &AggregateKind::Adt(ref def, ..) => {
 138                         match self.tcx.layout_scalar_valid_range(def.did) {
 139                             (Bound::Unbounded, Bound::Unbounded) => {},
 140                             _ => self.require_unsafe(
 141                                 "initializing type with `rustc_layout_scalar_valid_range` attr",
 142                                 "initializing a layout restricted type's field with a value \
 143                                 outside the valid range is undefined behavior",
 144                                 UnsafetyViolationKind::GeneralAndConstFn,
 145                             ),
 146                         }
 147                     }
 148                     &AggregateKind::Closure(def_id, _) |
 149                     &AggregateKind::Generator(def_id, _, _) => {
 150                         let UnsafetyCheckResult {
 151                             violations, unsafe_blocks
 152                         } = self.tcx.unsafety_check_result(def_id);
 153                         self.register_violations(&violations, &unsafe_blocks);
 154                     }
 155                 }
 156             },
 157             // casting pointers to ints is unsafe in const fn because the const evaluator cannot
 158             // possibly know what the result of various operations like `address / 2` would be
 159             // pointers during const evaluation have no integral address, only an abstract one
 160             Rvalue::Cast(CastKind::Misc, ref operand, cast_ty)
 161             if self.const_context && self.tcx.features().const_raw_ptr_to_usize_cast => {
 162                 let operand_ty = operand.ty(self.mir, self.tcx);
 163                 let cast_in = CastTy::from_ty(operand_ty).expect("bad input type for cast");
 164                 let cast_out = CastTy::from_ty(cast_ty).expect("bad output type for cast");
 165                 match (cast_in, cast_out) {
 166                     (CastTy::Ptr(_), CastTy::Int(_)) |
 167                     (CastTy::FnPtr, CastTy::Int(_)) => {
 168                         self.register_violations(&[UnsafetyViolation {
 169                             source_info: self.source_info,
 170                             description: InternedString::intern("cast of pointer to int"),
 171                             details: InternedString::intern(
 172                                 "casting pointers to integers in constants"),
 173                             kind: UnsafetyViolationKind::General,
 174                         }], &[]);
 175                     },
 176                     _ => {},
 177                 }
 178             }
 179             // raw pointer and fn pointer operations are unsafe as it is not clear whether one
 180             // pointer would be "less" or "equal" to another, because we cannot know where llvm
 181             // or the linker will place various statics in memory. Without this information the
 182             // result of a comparison of addresses would differ between runtime and compile-time.
 183             Rvalue::BinaryOp(_, ref lhs, _)
 184             if self.const_context && self.tcx.features().const_compare_raw_pointers => {
 185                 if let ty::RawPtr(_) | ty::FnPtr(..) = lhs.ty(self.mir, self.tcx).sty {
 186                     self.register_violations(&[UnsafetyViolation {
 187                         source_info: self.source_info,
 188                         description: InternedString::intern("pointer operation"),
 189                         details: InternedString::intern("operations on pointers in constants"),
 190                         kind: UnsafetyViolationKind::General,
 191                     }], &[]);
 192                 }
 193             }
 194             _ => {},
 195         }
 196         self.super_rvalue(rvalue, location);
 197     }
 198
 199     fn visit_place(&mut self,
 200                     place: &Place<'tcx>,
 201                     context: PlaceContext,
 202                     location: Location) {
 203         match place {
 204             &Place::Projection(box Projection {
 205                 ref base, ref elem
 206             }) => {
 207                 if context.is_borrow() {
 208                     if util::is_disaligned(self.tcx, self.mir, self.param_env, place) {
 209                         let source_info = self.source_info;
 210                         let lint_root =
 211                             self.source_scope_local_data[source_info.scope].lint_root;
 212                         self.register_violations(&[UnsafetyViolation {
 213                             source_info,
 214                             description: InternedString::intern("borrow of packed field"),
 215                             details: InternedString::intern(
 216                                 "fields of packed structs might be misaligned: dereferencing a \
 217                                 misaligned pointer or even just creating a misaligned reference \
 218                                 is undefined behavior"),
 219                             kind: UnsafetyViolationKind::BorrowPacked(lint_root)
 220                         }], &[]);
 221                     }
 222                 }
 223                 let is_borrow_of_interior_mut = context.is_borrow() && !base
 224                     .ty(self.mir, self.tcx)
 225                     .ty
 226                     .is_freeze(self.tcx, self.param_env, self.source_info.span);
 227                 // prevent
 228                 // * `&mut x.field`
 229                 // * `x.field = y;`
 230                 // * `&x.field` if `field`'s type has interior mutability
 231                 // because either of these would allow modifying the layout constrained field and
 232                 // insert values that violate the layout constraints.
 233                 if context.is_mutating_use() || is_borrow_of_interior_mut {
 234                     self.check_mut_borrowing_layout_constrained_field(
 235                         place, context.is_mutating_use(),
 236                     );
 237                 }
 238                 let old_source_info = self.source_info;
 239                 if let &Place::Base(PlaceBase::Local(local)) = base {
 240                     if self.mir.local_decls[local].internal {
 241                         // Internal locals are used in the `move_val_init` desugaring.
 242                         // We want to check unsafety against the source info of the
 243                         // desugaring, rather than the source info of the RHS.
 244                         self.source_info = self.mir.local_decls[local].source_info;
 245                     }
 246                 }
 247                 let base_ty = base.ty(self.mir, self.tcx).ty;
 248                 match base_ty.sty {
 249                     ty::RawPtr(..) => {
 250                         self.require_unsafe("dereference of raw pointer",
 251                             "raw pointers may be NULL, dangling or unaligned; they can violate \
 252                              aliasing rules and cause data races: all of these are undefined \
 253                              behavior", UnsafetyViolationKind::General)
 254                     }
 255                     ty::Adt(adt, _) => {
 256                         if adt.is_union() {
 257                             if context == PlaceContext::MutatingUse(MutatingUseContext::Store) ||
 258                                 context == PlaceContext::MutatingUse(MutatingUseContext::Drop) ||
 259                                 context == PlaceContext::MutatingUse(
 260                                     MutatingUseContext::AsmOutput
 261                                 )
 262                             {
 263                                 let elem_ty = match elem {
 264                                     &ProjectionElem::Field(_, ty) => ty,
 265                                     _ => span_bug!(
 266                                         self.source_info.span,
 267                                         "non-field projection {:?} from union?",
 268                                         place)
 269                                 };
 270                                 if !elem_ty.is_copy_modulo_regions(
 271                                     self.tcx,
 272                                     self.param_env,
 273                                     self.source_info.span,
 274                                 ) {
 275                                     self.require_unsafe(
 276                                         "assignment to non-`Copy` union field",
 277                                         "the previous content of the field will be dropped, which \
 278                                          causes undefined behavior if the field was not properly \
 279                                          initialized", UnsafetyViolationKind::General)
 280                                 } else {
 281                                     // write to non-move union, safe
 282                                 }
 283                             } else {
 284                                 self.require_unsafe("access to union field",
 285                                     "the field may not be properly initialized: using \
 286                                      uninitialized data will cause undefined behavior",
 287                                      UnsafetyViolationKind::General)
 288                             }
 289                         }
 290                     }
 291                     _ => {}
 292                 }
 293                 self.source_info = old_source_info;
 294             }
 295             &Place::Base(PlaceBase::Local(..)) => {
 296                 // locals are safe
 297             }
 298             &Place::Base(PlaceBase::Static(box Static { kind: StaticKind::Promoted(_), .. })) => {
 299                 bug!("unsafety checking should happen before promotion")
 300             }
 301             &Place::Base(
 302                 PlaceBase::Static(box Static { kind: StaticKind::Static(def_id), .. })
 303             ) => {
 304                 if self.tcx.is_mutable_static(def_id) {
 305                     self.require_unsafe("use of mutable static",
 306                         "mutable statics can be mutated by multiple threads: aliasing violations \
 307                          or data races will cause undefined behavior",
 308                          UnsafetyViolationKind::General);
 309                 } else if self.tcx.is_foreign_item(def_id) {
 310                     let source_info = self.source_info;
 311                     let lint_root =
 312                         self.source_scope_local_data[source_info.scope].lint_root;
 313                     self.register_violations(&[UnsafetyViolation {
 314                         source_info,
 315                         description: InternedString::intern("use of extern static"),
 316                         details: InternedString::intern(
 317                             "extern statics are not controlled by the Rust type system: invalid \
 318                             data, aliasing violations or data races will cause undefined behavior"),
 319                         kind: UnsafetyViolationKind::ExternStatic(lint_root)
 320                     }], &[]);
 321                 }
 322             }
 323         };
 324         self.super_place(place, context, location);
 325     }
 326 }
 327
 328 impl<'a, 'tcx> UnsafetyChecker<'a, 'tcx> {
 329     fn require_unsafe(
 330         &mut self,
 331         description: &'static str,
 332         details: &'static str,
 333         kind: UnsafetyViolationKind,
 334     ) {
 335         let source_info = self.source_info;
 336         self.register_violations(&[UnsafetyViolation {
 337             source_info,
 338             description: InternedString::intern(description),
 339             details: InternedString::intern(details),
 340             kind,
 341         }], &[]);
 342     }
 343
 344     fn register_violations(&mut self,
 345                            violations: &[UnsafetyViolation],
 346                            unsafe_blocks: &[(hir::HirId, bool)]) {
 347         let safety = self.source_scope_local_data[self.source_info.scope].safety;
 348         let within_unsafe = match safety {
 349             // `unsafe` blocks are required in safe code
 350             Safety::Safe => {
 351                 for violation in violations {
 352                     let mut violation = violation.clone();
 353                     match violation.kind {
 354                         UnsafetyViolationKind::GeneralAndConstFn |
 355                         UnsafetyViolationKind::General => {},
 356                         UnsafetyViolationKind::BorrowPacked(_) |
 357                         UnsafetyViolationKind::ExternStatic(_) => if self.min_const_fn {
 358                             // const fns don't need to be backwards compatible and can
 359                             // emit these violations as a hard error instead of a backwards
 360                             // compat lint
 361                             violation.kind = UnsafetyViolationKind::General;
 362                         },
 363                     }
 364                     if !self.violations.contains(&violation) {
 365                         self.violations.push(violation)
 366                     }
 367                 }
 368                 false
 369             }
 370             // `unsafe` function bodies allow unsafe without additional unsafe blocks
 371             Safety::BuiltinUnsafe | Safety::FnUnsafe => true,
 372             Safety::ExplicitUnsafe(hir_id) => {
 373                 // mark unsafe block as used if there are any unsafe operations inside
 374                 if !violations.is_empty() {
 375                     self.used_unsafe.insert(hir_id);
 376                 }
 377                 // only some unsafety is allowed in const fn
 378                 if self.min_const_fn {
 379                     for violation in violations {
 380                         match violation.kind {
 381                             // these unsafe things are stable in const fn
 382                             UnsafetyViolationKind::GeneralAndConstFn => {},
 383                             // these things are forbidden in const fns
 384                             UnsafetyViolationKind::General |
 385                             UnsafetyViolationKind::BorrowPacked(_) |
 386                             UnsafetyViolationKind::ExternStatic(_) => {
 387                                 let mut violation = violation.clone();
 388                                 // const fns don't need to be backwards compatible and can
 389                                 // emit these violations as a hard error instead of a backwards
 390                                 // compat lint
 391                                 violation.kind = UnsafetyViolationKind::General;
 392                                 if !self.violations.contains(&violation) {
 393                                     self.violations.push(violation)
 394                                 }
 395                             },
 396                         }
 397                     }
 398                 }
 399                 true
 400             }
 401         };
 402         self.inherited_blocks.extend(unsafe_blocks.iter().map(|&(hir_id, is_used)| {
 403             (hir_id, is_used && !within_unsafe)
 404         }));
 405     }
 406     fn check_mut_borrowing_layout_constrained_field(
 407         &mut self,
 408         mut place: &Place<'tcx>,
 409         is_mut_use: bool,
 410     ) {
 411         while let &Place::Projection(box Projection {
 412             ref base, ref elem
 413         }) = place {
 414             match *elem {
 415                 ProjectionElem::Field(..) => {
 416                     let ty = base.ty(&self.mir.local_decls, self.tcx).ty;
 417                     match ty.sty {
 418                         ty::Adt(def, _) => match self.tcx.layout_scalar_valid_range(def.did) {
 419                             (Bound::Unbounded, Bound::Unbounded) => {},
 420                             _ => {
 421                                 let (description, details) = if is_mut_use {
 422                                     (
 423                                         "mutation of layout constrained field",
 424                                         "mutating layout constrained fields cannot statically be \
 425                                         checked for valid values",
 426                                     )
 427                                 } else {
 428                                     (
 429                                         "borrow of layout constrained field with interior \
 430                                         mutability",
 431                                         "references to fields of layout constrained fields \
 432                                         lose the constraints. Coupled with interior mutability, \
 433                                         the field can be changed to invalid values",
 434                                     )
 435                                 };
 436                                 let source_info = self.source_info;
 437                                 self.register_violations(&[UnsafetyViolation {
 438                                     source_info,
 439                                     description: InternedString::intern(description),
 440                                     details: InternedString::intern(details),
 441                                     kind: UnsafetyViolationKind::GeneralAndConstFn,
 442                                 }], &[]);
 443                             }
 444                         },
 445                         _ => {}
 446                     }
 447                 }
 448                 _ => {}
 449             }
 450             place = base;
 451         }
 452     }
 453 }
 454
 455 pub(crate) fn provide(providers: &mut Providers<'_>) {
 456     *providers = Providers {
 457         unsafety_check_result,
 458         unsafe_derive_on_repr_packed,
 459         ..*providers
 460     };
 461 }
 462
 463 struct UnusedUnsafeVisitor<'a> {
 464     used_unsafe: &'a FxHashSet<hir::HirId>,
 465     unsafe_blocks: &'a mut Vec<(hir::HirId, bool)>,
 466 }
 467
 468 impl<'a, 'tcx> hir::intravisit::Visitor<'tcx> for UnusedUnsafeVisitor<'a> {
 469     fn nested_visit_map<'this>(&'this mut self) ->
 470         hir::intravisit::NestedVisitorMap<'this, 'tcx>
 471     {
 472         hir::intravisit::NestedVisitorMap::None
 473     }
 474
 475     fn visit_block(&mut self, block: &'tcx hir::Block) {
 476         hir::intravisit::walk_block(self, block);
 477
 478         if let hir::UnsafeBlock(hir::UserProvided) = block.rules {
 479             self.unsafe_blocks.push((block.hir_id, self.used_unsafe.contains(&block.hir_id)));
 480         }
 481     }
 482 }
 483
 484 fn check_unused_unsafe<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
 485                                  def_id: DefId,
 486                                  used_unsafe: &FxHashSet<hir::HirId>,
 487                                  unsafe_blocks: &'a mut Vec<(hir::HirId, bool)>)
 488 {
 489     let body_id =
 490         tcx.hir().as_local_hir_id(def_id).and_then(|hir_id| {
 491             tcx.hir().maybe_body_owned_by_by_hir_id(hir_id)
 492         });
 493
 494     let body_id = match body_id {
 495         Some(body) => body,
 496         None => {
 497             debug!("check_unused_unsafe({:?}) - no body found", def_id);
 498             return
 499         }
 500     };
 501     let body = tcx.hir().body(body_id);
 502     debug!("check_unused_unsafe({:?}, body={:?}, used_unsafe={:?})",
 503            def_id, body, used_unsafe);
 504
 505     let mut visitor =  UnusedUnsafeVisitor { used_unsafe, unsafe_blocks };
 506     hir::intravisit::Visitor::visit_body(&mut visitor, body);
 507 }
 508
 509 fn unsafety_check_result<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>, def_id: DefId)
 510                                    -> UnsafetyCheckResult
 511 {
 512     debug!("unsafety_violations({:?})", def_id);
 513
 514     // N.B., this borrow is valid because all the consumers of
 515     // `mir_built` force this.
 516     let mir = &tcx.mir_built(def_id).borrow();
 517
 518     let source_scope_local_data = match mir.source_scope_local_data {
 519         ClearCrossCrate::Set(ref data) => data,
 520         ClearCrossCrate::Clear => {
 521             debug!("unsafety_violations: {:?} - remote, skipping", def_id);
 522             return UnsafetyCheckResult {
 523                 violations: Lrc::new([]),
 524                 unsafe_blocks: Lrc::new([])
 525             }
 526         }
 527     };
 528
 529     let param_env = tcx.param_env(def_id);
 530
 531     let id = tcx.hir().as_local_hir_id(def_id).unwrap();
 532     let (const_context, min_const_fn) = match tcx.hir().body_owner_kind_by_hir_id(id) {
 533         hir::BodyOwnerKind::Closure => (false, false),
 534         hir::BodyOwnerKind::Fn => (tcx.is_const_fn(def_id), tcx.is_min_const_fn(def_id)),
 535         hir::BodyOwnerKind::Const |
 536         hir::BodyOwnerKind::Static(_) => (true, false),
 537     };
 538     let mut checker = UnsafetyChecker::new(
 539         const_context, min_const_fn,
 540         mir, source_scope_local_data, tcx, param_env);
 541     checker.visit_body(mir);
 542
 543     check_unused_unsafe(tcx, def_id, &checker.used_unsafe, &mut checker.inherited_blocks);
 544     UnsafetyCheckResult {
 545         violations: checker.violations.into(),
 546         unsafe_blocks: checker.inherited_blocks.into()
 547     }
 548 }
 549
 550 fn unsafe_derive_on_repr_packed<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>, def_id: DefId) {
 551     let lint_hir_id = tcx.hir().as_local_hir_id(def_id).unwrap_or_else(||
 552         bug!("checking unsafety for non-local def id {:?}", def_id));
 553
 554     // FIXME: when we make this a hard error, this should have its
 555     // own error code.
 556     let message = if tcx.generics_of(def_id).own_requires_monomorphization() {
 557         "#[derive] can't be used on a #[repr(packed)] struct with \
 558          type or const parameters (error E0133)".to_string()
 559     } else {
 560         "#[derive] can't be used on a #[repr(packed)] struct that \
 561          does not derive Copy (error E0133)".to_string()
 562     };
 563     tcx.lint_hir(SAFE_PACKED_BORROWS,
 564                  lint_hir_id,
 565                  tcx.def_span(def_id),
 566                  &message);
 567 }
 568
 569 /// Returns the `HirId` for an enclosing scope that is also `unsafe`.
 570 fn is_enclosed(tcx: TyCtxt<'_, '_, '_>,
 571                used_unsafe: &FxHashSet<hir::HirId>,
 572                id: hir::HirId) -> Option<(String, hir::HirId)> {
 573     let parent_id = tcx.hir().get_parent_node_by_hir_id(id);
 574     if parent_id != id {
 575         if used_unsafe.contains(&parent_id) {
 576             Some(("block".to_string(), parent_id))
 577         } else if let Some(Node::Item(&hir::Item {
 578             node: hir::ItemKind::Fn(_, header, _, _),
 579             ..
 580         })) = tcx.hir().find_by_hir_id(parent_id) {
 581             match header.unsafety {
 582                 hir::Unsafety::Unsafe => Some(("fn".to_string(), parent_id)),
 583                 hir::Unsafety::Normal => None,
 584             }
 585         } else {
 586             is_enclosed(tcx, used_unsafe, parent_id)
 587         }
 588     } else {
 589         None
 590     }
 591 }
 592
 593 fn report_unused_unsafe(tcx: TyCtxt<'_, '_, '_>,
 594                         used_unsafe: &FxHashSet<hir::HirId>,
 595                         id: hir::HirId) {
 596     let span = tcx.sess.source_map().def_span(tcx.hir().span_by_hir_id(id));
 597     let msg = "unnecessary `unsafe` block";
 598     let mut db = tcx.struct_span_lint_hir(UNUSED_UNSAFE, id, span, msg);
 599     db.span_label(span, msg);
 600     if let Some((kind, id)) = is_enclosed(tcx, used_unsafe, id) {
 601         db.span_label(tcx.sess.source_map().def_span(tcx.hir().span_by_hir_id(id)),
 602                       format!("because it's nested under this `unsafe` {}", kind));
 603     }
 604     db.emit();
 605 }
 606
 607 fn builtin_derive_def_id<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>, def_id: DefId) -> Option<DefId> {
 608     debug!("builtin_derive_def_id({:?})", def_id);
 609     if let Some(impl_def_id) = tcx.impl_of_method(def_id) {
 610         if tcx.has_attr(impl_def_id, sym::automatically_derived) {
 611             debug!("builtin_derive_def_id({:?}) - is {:?}", def_id, impl_def_id);
 612             Some(impl_def_id)
 613         } else {
 614             debug!("builtin_derive_def_id({:?}) - not automatically derived", def_id);
 615             None
 616         }
 617     } else {
 618         debug!("builtin_derive_def_id({:?}) - not a method", def_id);
 619         None
 620     }
 621 }
 622
 623 pub fn check_unsafety<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>, def_id: DefId) {
 624     debug!("check_unsafety({:?})", def_id);
 625
 626     // closures are handled by their parent fn.
 627     if tcx.is_closure(def_id) {
 628         return;
 629     }
 630
 631     let UnsafetyCheckResult {
 632         violations,
 633         unsafe_blocks
 634     } = tcx.unsafety_check_result(def_id);
 635
 636     for &UnsafetyViolation {
 637         source_info, description, details, kind
 638     } in violations.iter() {
 639         // Report an error.
 640         match kind {
 641             UnsafetyViolationKind::GeneralAndConstFn |
 642             UnsafetyViolationKind::General => {
 643                 struct_span_err!(
 644                     tcx.sess, source_info.span, E0133,
 645                     "{} is unsafe and requires unsafe function or block", description)
 646                     .span_label(source_info.span, &description.as_str()[..])
 647                     .note(&details.as_str()[..])
 648                     .emit();
 649             }
 650             UnsafetyViolationKind::ExternStatic(lint_hir_id) => {
 651                 tcx.lint_node_note(SAFE_EXTERN_STATICS,
 652                               lint_hir_id,
 653                               source_info.span,
 654                               &format!("{} is unsafe and requires unsafe function or block \
 655                                         (error E0133)", &description.as_str()[..]),
 656                               &details.as_str()[..]);
 657             }
 658             UnsafetyViolationKind::BorrowPacked(lint_hir_id) => {
 659                 if let Some(impl_def_id) = builtin_derive_def_id(tcx, def_id) {
 660                     tcx.unsafe_derive_on_repr_packed(impl_def_id);
 661                 } else {
 662                     tcx.lint_node_note(SAFE_PACKED_BORROWS,
 663                                   lint_hir_id,
 664                                   source_info.span,
 665                                   &format!("{} is unsafe and requires unsafe function or block \
 666                                             (error E0133)", &description.as_str()[..]),
 667                                   &details.as_str()[..]);
 668                 }
 669             }
 670         }
 671     }
 672
 673     let mut unsafe_blocks: Vec<_> = unsafe_blocks.into_iter().collect();
 674     unsafe_blocks.sort_by_cached_key(|(hir_id, _)| tcx.hir().hir_to_node_id(*hir_id));
 675     let used_unsafe: FxHashSet<_> = unsafe_blocks.iter()
 676         .flat_map(|&&(id, used)| if used { Some(id) } else { None })
 677         .collect();
 678     for &(block_id, is_used) in unsafe_blocks {
 679         if !is_used {
 680             report_unused_unsafe(tcx, &used_unsafe, block_id);
 681         }
 682     }
 683 }