1 // Copyright 2012-2015 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 //! Lints in the Rust compiler.
13 //! This contains lints which can feasibly be implemented as their own
14 //! AST visitor. Also see `rustc::lint::builtin`, which contains the
15 //! definitions of lints that are emitted directly inside the main
18 //! To add a new lint to rustc, declare it here using `declare_lint!()`.
19 //! Then add code to emit the new lint in the appropriate circumstances.
20 //! You can do that in an existing `LintPass` if it makes sense, or in a
21 //! new `LintPass`, or using `Session::add_lint` elsewhere in the
22 //! compiler. Only do the latter if the check can't be written cleanly as a
23 //! `LintPass` (also, note that such lints will need to be defined in
24 //! `rustc::lint::builtin`, not here).
26 //! If you define a new `LintPass`, you will also need to add it to the
27 //! `add_builtin!` or `add_builtin_with_new!` invocation in `lib.rs`.
28 //! Use the former for unit-like structs and the latter for structs with
31 use middle::{cfg, infer, stability, traits};
33 use middle::cstore::CrateStore;
34 use middle::def_id::DefId;
35 use middle::subst::Substs;
36 use middle::ty::{self, Ty};
37 use middle::ty::adjustment;
38 use rustc::front::map as hir_map;
39 use util::nodemap::{NodeSet};
40 use lint::{Level, LateContext, LintContext, LintArray, Lint};
41 use lint::{LintPass, LateLintPass};
43 use std::collections::HashSet;
46 use syntax::attr::{self, AttrMetaMethods};
47 use syntax::codemap::{self, Span};
49 use rustc_front::hir::{self, PatKind};
50 use rustc_front::intravisit::FnKind;
52 use bad_style::{MethodLateContext, method_context};
54 // hardwired lints from librustc
55 pub use lint::builtin::*;
60 "suggest using `loop { }` instead of `while true { }`"
63 #[derive(Copy, Clone)]
66 impl LintPass for WhileTrue {
67 fn get_lints(&self) -> LintArray {
68 lint_array!(WHILE_TRUE)
72 impl LateLintPass for WhileTrue {
73 fn check_expr(&mut self, cx: &LateContext, e: &hir::Expr) {
74 if let hir::ExprWhile(ref cond, _, _) = e.node {
75 if let hir::ExprLit(ref lit) = cond.node {
76 if let ast::LitKind::Bool(true) = lit.node {
77 cx.span_lint(WHILE_TRUE, e.span,
78 "denote infinite loops with loop { ... }");
88 "use of owned (Box type) heap memory"
91 #[derive(Copy, Clone)]
92 pub struct BoxPointers;
95 fn check_heap_type<'a, 'tcx>(&self, cx: &LateContext<'a, 'tcx>,
96 span: Span, ty: Ty<'tcx>) {
97 for leaf_ty in ty.walk() {
98 if let ty::TyBox(_) = leaf_ty.sty {
99 let m = format!("type uses owned (Box type) pointers: {}", ty);
100 cx.span_lint(BOX_POINTERS, span, &m);
106 impl LintPass for BoxPointers {
107 fn get_lints(&self) -> LintArray {
108 lint_array!(BOX_POINTERS)
112 impl LateLintPass for BoxPointers {
113 fn check_item(&mut self, cx: &LateContext, it: &hir::Item) {
118 hir::ItemStruct(..) =>
119 self.check_heap_type(cx, it.span,
120 cx.tcx.node_id_to_type(it.id)),
124 // If it's a struct, we also have to check the fields' types
126 hir::ItemStruct(ref struct_def, _) => {
127 for struct_field in struct_def.fields() {
128 self.check_heap_type(cx, struct_field.span,
129 cx.tcx.node_id_to_type(struct_field.node.id));
136 fn check_expr(&mut self, cx: &LateContext, e: &hir::Expr) {
137 let ty = cx.tcx.node_id_to_type(e.id);
138 self.check_heap_type(cx, e.span, ty);
143 NON_SHORTHAND_FIELD_PATTERNS,
145 "using `Struct { x: x }` instead of `Struct { x }`"
148 #[derive(Copy, Clone)]
149 pub struct NonShorthandFieldPatterns;
151 impl LintPass for NonShorthandFieldPatterns {
152 fn get_lints(&self) -> LintArray {
153 lint_array!(NON_SHORTHAND_FIELD_PATTERNS)
157 impl LateLintPass for NonShorthandFieldPatterns {
158 fn check_pat(&mut self, cx: &LateContext, pat: &hir::Pat) {
159 let def_map = cx.tcx.def_map.borrow();
160 if let PatKind::Struct(_, ref v, _) = pat.node {
161 let field_pats = v.iter().filter(|fieldpat| {
162 if fieldpat.node.is_shorthand {
165 let def = def_map.get(&fieldpat.node.pat.id).map(|d| d.full_def());
166 if let Some(def_id) = cx.tcx.map.opt_local_def_id(fieldpat.node.pat.id) {
167 def == Some(Def::Local(def_id, fieldpat.node.pat.id))
172 for fieldpat in field_pats {
173 if let PatKind::Ident(_, ident, None) = fieldpat.node.pat.node {
174 if ident.node.unhygienic_name == fieldpat.node.name {
175 cx.span_lint(NON_SHORTHAND_FIELD_PATTERNS, fieldpat.span,
176 &format!("the `{}:` in this pattern is redundant and can \
177 be removed", ident.node))
188 "usage of `unsafe` code"
191 #[derive(Copy, Clone)]
192 pub struct UnsafeCode;
194 impl LintPass for UnsafeCode {
195 fn get_lints(&self) -> LintArray {
196 lint_array!(UNSAFE_CODE)
200 impl LateLintPass for UnsafeCode {
201 fn check_expr(&mut self, cx: &LateContext, e: &hir::Expr) {
202 if let hir::ExprBlock(ref blk) = e.node {
203 // Don't warn about generated blocks, that'll just pollute the output.
204 if blk.rules == hir::UnsafeBlock(hir::UserProvided) {
205 cx.span_lint(UNSAFE_CODE, blk.span, "usage of an `unsafe` block");
210 fn check_item(&mut self, cx: &LateContext, it: &hir::Item) {
212 hir::ItemTrait(hir::Unsafety::Unsafe, _, _, _) =>
213 cx.span_lint(UNSAFE_CODE, it.span, "declaration of an `unsafe` trait"),
215 hir::ItemImpl(hir::Unsafety::Unsafe, _, _, _, _, _) =>
216 cx.span_lint(UNSAFE_CODE, it.span, "implementation of an `unsafe` trait"),
222 fn check_fn(&mut self, cx: &LateContext, fk: FnKind, _: &hir::FnDecl,
223 _: &hir::Block, span: Span, _: ast::NodeId) {
225 FnKind::ItemFn(_, _, hir::Unsafety::Unsafe, _, _, _) =>
226 cx.span_lint(UNSAFE_CODE, span, "declaration of an `unsafe` function"),
228 FnKind::Method(_, sig, _) => {
229 if sig.unsafety == hir::Unsafety::Unsafe {
230 cx.span_lint(UNSAFE_CODE, span, "implementation of an `unsafe` method")
238 fn check_trait_item(&mut self, cx: &LateContext, trait_item: &hir::TraitItem) {
239 if let hir::MethodTraitItem(ref sig, None) = trait_item.node {
240 if sig.unsafety == hir::Unsafety::Unsafe {
241 cx.span_lint(UNSAFE_CODE, trait_item.span,
242 "declaration of an `unsafe` method")
251 "detects missing documentation for public members"
254 pub struct MissingDoc {
255 /// Stack of IDs of struct definitions.
256 struct_def_stack: Vec<ast::NodeId>,
258 /// True if inside variant definition
261 /// Stack of whether #[doc(hidden)] is set
262 /// at each level which has lint attributes.
263 doc_hidden_stack: Vec<bool>,
265 /// Private traits or trait items that leaked through. Don't check their methods.
266 private_traits: HashSet<ast::NodeId>,
270 pub fn new() -> MissingDoc {
272 struct_def_stack: vec!(),
274 doc_hidden_stack: vec!(false),
275 private_traits: HashSet::new(),
279 fn doc_hidden(&self) -> bool {
280 *self.doc_hidden_stack.last().expect("empty doc_hidden_stack")
283 fn check_missing_docs_attrs(&self,
285 id: Option<ast::NodeId>,
286 attrs: &[ast::Attribute],
288 desc: &'static str) {
289 // If we're building a test harness, then warning about
290 // documentation is probably not really relevant right now.
291 if cx.sess().opts.test {
295 // `#[doc(hidden)]` disables missing_docs check.
296 if self.doc_hidden() {
300 // Only check publicly-visible items, using the result from the privacy pass.
301 // It's an option so the crate root can also use this function (it doesn't
303 if let Some(id) = id {
304 if !cx.access_levels.is_exported(id) {
309 let has_doc = attrs.iter().any(|a| {
310 match a.node.value.node {
311 ast::MetaItemKind::NameValue(ref name, _) if *name == "doc" => true,
316 cx.span_lint(MISSING_DOCS, sp,
317 &format!("missing documentation for {}", desc));
322 impl LintPass for MissingDoc {
323 fn get_lints(&self) -> LintArray {
324 lint_array!(MISSING_DOCS)
328 impl LateLintPass for MissingDoc {
329 fn enter_lint_attrs(&mut self, _: &LateContext, attrs: &[ast::Attribute]) {
330 let doc_hidden = self.doc_hidden() || attrs.iter().any(|attr| {
331 attr.check_name("doc") && match attr.meta_item_list() {
333 Some(l) => attr::contains_name(&l[..], "hidden"),
336 self.doc_hidden_stack.push(doc_hidden);
339 fn exit_lint_attrs(&mut self, _: &LateContext, _: &[ast::Attribute]) {
340 self.doc_hidden_stack.pop().expect("empty doc_hidden_stack");
343 fn check_struct_def(&mut self, _: &LateContext, _: &hir::VariantData,
344 _: ast::Name, _: &hir::Generics, item_id: ast::NodeId) {
345 self.struct_def_stack.push(item_id);
348 fn check_struct_def_post(&mut self, _: &LateContext, _: &hir::VariantData,
349 _: ast::Name, _: &hir::Generics, item_id: ast::NodeId) {
350 let popped = self.struct_def_stack.pop().expect("empty struct_def_stack");
351 assert!(popped == item_id);
354 fn check_crate(&mut self, cx: &LateContext, krate: &hir::Crate) {
355 self.check_missing_docs_attrs(cx, None, &krate.attrs, krate.span, "crate");
358 fn check_item(&mut self, cx: &LateContext, it: &hir::Item) {
359 let desc = match it.node {
360 hir::ItemFn(..) => "a function",
361 hir::ItemMod(..) => "a module",
362 hir::ItemEnum(..) => "an enum",
363 hir::ItemStruct(..) => "a struct",
364 hir::ItemTrait(_, _, _, ref items) => {
365 // Issue #11592, traits are always considered exported, even when private.
366 if it.vis == hir::Visibility::Inherited {
367 self.private_traits.insert(it.id);
369 self.private_traits.insert(itm.id);
375 hir::ItemTy(..) => "a type alias",
376 hir::ItemImpl(_, _, _, Some(ref trait_ref), _, ref impl_items) => {
377 // If the trait is private, add the impl items to private_traits so they don't get
378 // reported for missing docs.
379 let real_trait = cx.tcx.trait_ref_to_def_id(trait_ref);
380 if let Some(node_id) = cx.tcx.map.as_local_node_id(real_trait) {
381 match cx.tcx.map.find(node_id) {
382 Some(hir_map::NodeItem(item)) => if item.vis == hir::Visibility::Inherited {
383 for itm in impl_items {
384 self.private_traits.insert(itm.id);
392 hir::ItemConst(..) => "a constant",
393 hir::ItemStatic(..) => "a static",
397 self.check_missing_docs_attrs(cx, Some(it.id), &it.attrs, it.span, desc);
400 fn check_trait_item(&mut self, cx: &LateContext, trait_item: &hir::TraitItem) {
401 if self.private_traits.contains(&trait_item.id) { return }
403 let desc = match trait_item.node {
404 hir::ConstTraitItem(..) => "an associated constant",
405 hir::MethodTraitItem(..) => "a trait method",
406 hir::TypeTraitItem(..) => "an associated type",
409 self.check_missing_docs_attrs(cx, Some(trait_item.id),
411 trait_item.span, desc);
414 fn check_impl_item(&mut self, cx: &LateContext, impl_item: &hir::ImplItem) {
415 // If the method is an impl for a trait, don't doc.
416 if method_context(cx, impl_item.id, impl_item.span) == MethodLateContext::TraitImpl {
420 let desc = match impl_item.node {
421 hir::ImplItemKind::Const(..) => "an associated constant",
422 hir::ImplItemKind::Method(..) => "a method",
423 hir::ImplItemKind::Type(_) => "an associated type",
425 self.check_missing_docs_attrs(cx, Some(impl_item.id),
427 impl_item.span, desc);
430 fn check_struct_field(&mut self, cx: &LateContext, sf: &hir::StructField) {
431 if sf.node.name.is_some() {
432 if sf.node.vis == hir::Public || self.in_variant {
433 let cur_struct_def = *self.struct_def_stack.last()
434 .expect("empty struct_def_stack");
435 self.check_missing_docs_attrs(cx, Some(cur_struct_def),
436 &sf.node.attrs, sf.span,
442 fn check_variant(&mut self, cx: &LateContext, v: &hir::Variant, _: &hir::Generics) {
443 self.check_missing_docs_attrs(cx, Some(v.node.data.id()),
444 &v.node.attrs, v.span, "a variant");
445 assert!(!self.in_variant);
446 self.in_variant = true;
449 fn check_variant_post(&mut self, _: &LateContext, _: &hir::Variant, _: &hir::Generics) {
450 assert!(self.in_variant);
451 self.in_variant = false;
456 pub MISSING_COPY_IMPLEMENTATIONS,
458 "detects potentially-forgotten implementations of `Copy`"
461 #[derive(Copy, Clone)]
462 pub struct MissingCopyImplementations;
464 impl LintPass for MissingCopyImplementations {
465 fn get_lints(&self) -> LintArray {
466 lint_array!(MISSING_COPY_IMPLEMENTATIONS)
470 impl LateLintPass for MissingCopyImplementations {
471 fn check_item(&mut self, cx: &LateContext, item: &hir::Item) {
472 if !cx.access_levels.is_reachable(item.id) {
475 let (def, ty) = match item.node {
476 hir::ItemStruct(_, ref ast_generics) => {
477 if ast_generics.is_parameterized() {
480 let def = cx.tcx.lookup_adt_def(cx.tcx.map.local_def_id(item.id));
481 (def, cx.tcx.mk_struct(def,
482 cx.tcx.mk_substs(Substs::empty())))
484 hir::ItemEnum(_, ref ast_generics) => {
485 if ast_generics.is_parameterized() {
488 let def = cx.tcx.lookup_adt_def(cx.tcx.map.local_def_id(item.id));
489 (def, cx.tcx.mk_enum(def,
490 cx.tcx.mk_substs(Substs::empty())))
494 if def.has_dtor() { return; }
495 let parameter_environment = cx.tcx.empty_parameter_environment();
496 // FIXME (@jroesch) should probably inver this so that the parameter env still impls this
498 if !ty.moves_by_default(¶meter_environment, item.span) {
501 if parameter_environment.can_type_implement_copy(ty, item.span).is_ok() {
502 cx.span_lint(MISSING_COPY_IMPLEMENTATIONS,
504 "type could implement `Copy`; consider adding `impl \
511 MISSING_DEBUG_IMPLEMENTATIONS,
513 "detects missing implementations of fmt::Debug"
516 pub struct MissingDebugImplementations {
517 impling_types: Option<NodeSet>,
520 impl MissingDebugImplementations {
521 pub fn new() -> MissingDebugImplementations {
522 MissingDebugImplementations {
528 impl LintPass for MissingDebugImplementations {
529 fn get_lints(&self) -> LintArray {
530 lint_array!(MISSING_DEBUG_IMPLEMENTATIONS)
534 impl LateLintPass for MissingDebugImplementations {
535 fn check_item(&mut self, cx: &LateContext, item: &hir::Item) {
536 if !cx.access_levels.is_reachable(item.id) {
541 hir::ItemStruct(..) | hir::ItemEnum(..) => {},
545 let debug = match cx.tcx.lang_items.debug_trait() {
546 Some(debug) => debug,
550 if self.impling_types.is_none() {
551 let debug_def = cx.tcx.lookup_trait_def(debug);
552 let mut impls = NodeSet();
553 debug_def.for_each_impl(cx.tcx, |d| {
554 if let Some(n) = cx.tcx.map.as_local_node_id(d) {
555 if let Some(ty_def) = cx.tcx.node_id_to_type(n).ty_to_def_id() {
556 if let Some(node_id) = cx.tcx.map.as_local_node_id(ty_def) {
557 impls.insert(node_id);
563 self.impling_types = Some(impls);
564 debug!("{:?}", self.impling_types);
567 if !self.impling_types.as_ref().unwrap().contains(&item.id) {
568 cx.span_lint(MISSING_DEBUG_IMPLEMENTATIONS,
570 "type does not implement `fmt::Debug`; consider adding #[derive(Debug)] \
571 or a manual implementation")
579 "detects use of deprecated items"
582 /// Checks for use of items with `#[deprecated]` or `#[rustc_deprecated]` attributes
583 #[derive(Copy, Clone)]
584 pub struct Deprecated;
587 fn lint(&self, cx: &LateContext, _id: DefId, span: Span,
588 stability: &Option<&attr::Stability>, deprecation: &Option<attr::Deprecation>) {
589 // Deprecated attributes apply in-crate and cross-crate.
590 if let Some(&attr::Stability{rustc_depr: Some(attr::RustcDeprecation{ref reason, ..}), ..})
592 output(cx, DEPRECATED, span, Some(&reason))
593 } else if let Some(attr::Deprecation{ref note, ..}) = *deprecation {
594 output(cx, DEPRECATED, span, note.as_ref().map(|x| &**x))
597 fn output(cx: &LateContext, lint: &'static Lint, span: Span, note: Option<&str>) {
598 let msg = if let Some(note) = note {
599 format!("use of deprecated item: {}", note)
601 format!("use of deprecated item")
604 cx.span_lint(lint, span, &msg);
609 impl LintPass for Deprecated {
610 fn get_lints(&self) -> LintArray {
611 lint_array!(DEPRECATED)
615 impl LateLintPass for Deprecated {
616 fn check_item(&mut self, cx: &LateContext, item: &hir::Item) {
617 stability::check_item(cx.tcx, item, false,
618 &mut |id, sp, stab, depr|
619 self.lint(cx, id, sp, &stab, &depr));
622 fn check_expr(&mut self, cx: &LateContext, e: &hir::Expr) {
623 stability::check_expr(cx.tcx, e,
624 &mut |id, sp, stab, depr|
625 self.lint(cx, id, sp, &stab, &depr));
628 fn check_path(&mut self, cx: &LateContext, path: &hir::Path, id: ast::NodeId) {
629 stability::check_path(cx.tcx, path, id,
630 &mut |id, sp, stab, depr|
631 self.lint(cx, id, sp, &stab, &depr));
634 fn check_path_list_item(&mut self, cx: &LateContext, item: &hir::PathListItem) {
635 stability::check_path_list_item(cx.tcx, item,
636 &mut |id, sp, stab, depr|
637 self.lint(cx, id, sp, &stab, &depr));
640 fn check_pat(&mut self, cx: &LateContext, pat: &hir::Pat) {
641 stability::check_pat(cx.tcx, pat,
642 &mut |id, sp, stab, depr|
643 self.lint(cx, id, sp, &stab, &depr));
648 pub UNCONDITIONAL_RECURSION,
650 "functions that cannot return without calling themselves"
653 #[derive(Copy, Clone)]
654 pub struct UnconditionalRecursion;
657 impl LintPass for UnconditionalRecursion {
658 fn get_lints(&self) -> LintArray {
659 lint_array![UNCONDITIONAL_RECURSION]
663 impl LateLintPass for UnconditionalRecursion {
664 fn check_fn(&mut self, cx: &LateContext, fn_kind: FnKind, _: &hir::FnDecl,
665 blk: &hir::Block, sp: Span, id: ast::NodeId) {
666 let method = match fn_kind {
667 FnKind::ItemFn(..) => None,
668 FnKind::Method(..) => {
669 cx.tcx.impl_or_trait_item(cx.tcx.map.local_def_id(id)).as_opt_method()
671 // closures can't recur, so they don't matter.
672 FnKind::Closure => return
675 // Walk through this function (say `f`) looking to see if
676 // every possible path references itself, i.e. the function is
677 // called recursively unconditionally. This is done by trying
678 // to find a path from the entry node to the exit node that
679 // *doesn't* call `f` by traversing from the entry while
680 // pretending that calls of `f` are sinks (i.e. ignoring any
681 // exit edges from them).
683 // NB. this has an edge case with non-returning statements,
684 // like `loop {}` or `panic!()`: control flow never reaches
685 // the exit node through these, so one can have a function
686 // that never actually calls itselfs but is still picked up by
689 // fn f(cond: bool) {
690 // if !cond { panic!() } // could come from `assert!(cond)`
694 // In general, functions of that form may be able to call
695 // itself a finite number of times and then diverge. The lint
696 // considers this to be an error for two reasons, (a) it is
697 // easier to implement, and (b) it seems rare to actually want
698 // to have behaviour like the above, rather than
699 // e.g. accidentally recurring after an assert.
701 let cfg = cfg::CFG::new(cx.tcx, blk);
703 let mut work_queue = vec![cfg.entry];
704 let mut reached_exit_without_self_call = false;
705 let mut self_call_spans = vec![];
706 let mut visited = HashSet::new();
708 while let Some(idx) = work_queue.pop() {
711 reached_exit_without_self_call = true;
715 let cfg_id = idx.node_id();
716 if visited.contains(&cfg_id) {
720 visited.insert(cfg_id);
722 let node_id = cfg.graph.node_data(idx).id();
724 // is this a recursive call?
725 let self_recursive = if node_id != ast::DUMMY_NODE_ID {
727 Some(ref method) => {
728 expr_refers_to_this_method(cx.tcx, method, node_id)
730 None => expr_refers_to_this_fn(cx.tcx, id, node_id)
736 self_call_spans.push(cx.tcx.map.span(node_id));
737 // this is a self call, so we shouldn't explore past
738 // this node in the CFG.
741 // add the successors of this node to explore the graph further.
742 for (_, edge) in cfg.graph.outgoing_edges(idx) {
743 let target_idx = edge.target();
744 let target_cfg_id = target_idx.node_id();
745 if !visited.contains(&target_cfg_id) {
746 work_queue.push(target_idx)
751 // Check the number of self calls because a function that
752 // doesn't return (e.g. calls a `-> !` function or `loop { /*
753 // no break */ }`) shouldn't be linted unless it actually
755 if !reached_exit_without_self_call && !self_call_spans.is_empty() {
756 let mut db = cx.struct_span_lint(UNCONDITIONAL_RECURSION, sp,
757 "function cannot return without recurring");
759 // FIXME #19668: these could be span_lint_note's instead of this manual guard.
760 if cx.current_level(UNCONDITIONAL_RECURSION) != Level::Allow {
761 // offer some help to the programmer.
762 for call in &self_call_spans {
763 db.span_note(*call, "recursive call site");
765 db.fileline_help(sp, "a `loop` may express intention \
766 better if this is on purpose");
774 // Functions for identifying if the given Expr NodeId `id`
775 // represents a call to the function `fn_id`/method `method`.
777 fn expr_refers_to_this_fn(tcx: &ty::ctxt,
779 id: ast::NodeId) -> bool {
780 match tcx.map.get(id) {
781 hir_map::NodeExpr(&hir::Expr { node: hir::ExprCall(ref callee, _), .. }) => {
786 |def| def.def_id() == tcx.map.local_def_id(fn_id))
792 // Check if the expression `id` performs a call to `method`.
793 fn expr_refers_to_this_method(tcx: &ty::ctxt,
795 id: ast::NodeId) -> bool {
796 // Check for method calls and overloaded operators.
797 let opt_m = tcx.tables.borrow().method_map.get(&ty::MethodCall::expr(id)).cloned();
798 if let Some(m) = opt_m {
799 if method_call_refers_to_method(tcx, method, m.def_id, m.substs, id) {
804 // Check for overloaded autoderef method calls.
805 let opt_adj = tcx.tables.borrow().adjustments.get(&id).cloned();
806 if let Some(adjustment::AdjustDerefRef(adj)) = opt_adj {
807 for i in 0..adj.autoderefs {
808 let method_call = ty::MethodCall::autoderef(id, i as u32);
809 if let Some(m) = tcx.tables.borrow().method_map
812 if method_call_refers_to_method(tcx, method, m.def_id, m.substs, id) {
819 // Check for calls to methods via explicit paths (e.g. `T::method()`).
820 match tcx.map.get(id) {
821 hir_map::NodeExpr(&hir::Expr { node: hir::ExprCall(ref callee, _), .. }) => {
822 match tcx.def_map.borrow().get(&callee.id).map(|d| d.full_def()) {
823 Some(Def::Method(def_id)) => {
825 tcx.tables.borrow().item_substs
828 .unwrap_or_else(|| ty::ItemSubsts::empty());
829 method_call_refers_to_method(
830 tcx, method, def_id, &item_substs.substs, id)
839 // Check if the method call to the method with the ID `callee_id`
840 // and instantiated with `callee_substs` refers to method `method`.
841 fn method_call_refers_to_method<'tcx>(tcx: &ty::ctxt<'tcx>,
844 callee_substs: &Substs<'tcx>,
845 expr_id: ast::NodeId) -> bool {
846 let callee_item = tcx.impl_or_trait_item(callee_id);
848 match callee_item.container() {
849 // This is an inherent method, so the `def_id` refers
850 // directly to the method definition.
851 ty::ImplContainer(_) => {
852 callee_id == method.def_id
855 // A trait method, from any number of possible sources.
856 // Attempt to select a concrete impl before checking.
857 ty::TraitContainer(trait_def_id) => {
858 let trait_ref = callee_substs.to_trait_ref(tcx, trait_def_id);
859 let trait_ref = ty::Binder(trait_ref);
860 let span = tcx.map.span(expr_id);
862 traits::Obligation::new(traits::ObligationCause::misc(span, expr_id),
863 trait_ref.to_poly_trait_predicate());
865 // unwrap() is ok here b/c `method` is the method
866 // defined in this crate whose body we are
867 // checking, so it's always local
868 let node_id = tcx.map.as_local_node_id(method.def_id).unwrap();
870 let param_env = ty::ParameterEnvironment::for_item(tcx, node_id);
871 let infcx = infer::new_infer_ctxt(tcx, &tcx.tables, Some(param_env));
872 let mut selcx = traits::SelectionContext::new(&infcx);
873 match selcx.select(&obligation) {
874 // The method comes from a `T: Trait` bound.
875 // If `T` is `Self`, then this call is inside
876 // a default method definition.
877 Ok(Some(traits::VtableParam(_))) => {
878 let self_ty = callee_substs.self_ty();
879 let on_self = self_ty.map_or(false, |t| t.is_self());
880 // We can only be recurring in a default
881 // method if we're being called literally
882 // on the `Self` type.
883 on_self && callee_id == method.def_id
886 // The `impl` is known, so we check that with a
888 Ok(Some(traits::VtableImpl(vtable_impl))) => {
889 let container = ty::ImplContainer(vtable_impl.impl_def_id);
890 // It matches if it comes from the same impl,
891 // and has the same method name.
892 container == method.container
893 && callee_item.name() == method.name
896 // There's no way to know if this call is
897 // recursive, so we assume it's not.
909 "compiler plugin used as ordinary library in non-plugin crate"
912 #[derive(Copy, Clone)]
913 pub struct PluginAsLibrary;
915 impl LintPass for PluginAsLibrary {
916 fn get_lints(&self) -> LintArray {
917 lint_array![PLUGIN_AS_LIBRARY]
921 impl LateLintPass for PluginAsLibrary {
922 fn check_item(&mut self, cx: &LateContext, it: &hir::Item) {
923 if cx.sess().plugin_registrar_fn.get().is_some() {
924 // We're compiling a plugin; it's fine to link other plugins.
929 hir::ItemExternCrate(..) => (),
933 let prfn = match cx.sess().cstore.extern_mod_stmt_cnum(it.id) {
934 Some(cnum) => cx.sess().cstore.plugin_registrar_fn(cnum),
936 // Probably means we aren't linking the crate for some reason.
938 // Not sure if / when this could happen.
944 cx.span_lint(PLUGIN_AS_LIBRARY, it.span,
945 "compiler plugin used as an ordinary library");
951 PRIVATE_NO_MANGLE_FNS,
953 "functions marked #[no_mangle] should be exported"
957 PRIVATE_NO_MANGLE_STATICS,
959 "statics marked #[no_mangle] should be exported"
963 NO_MANGLE_CONST_ITEMS,
965 "const items will not have their symbols exported"
969 NO_MANGLE_GENERIC_ITEMS,
971 "generic items must be mangled"
974 #[derive(Copy, Clone)]
975 pub struct InvalidNoMangleItems;
977 impl LintPass for InvalidNoMangleItems {
978 fn get_lints(&self) -> LintArray {
979 lint_array!(PRIVATE_NO_MANGLE_FNS,
980 PRIVATE_NO_MANGLE_STATICS,
981 NO_MANGLE_CONST_ITEMS,
982 NO_MANGLE_GENERIC_ITEMS)
986 impl LateLintPass for InvalidNoMangleItems {
987 fn check_item(&mut self, cx: &LateContext, it: &hir::Item) {
989 hir::ItemFn(_, _, _, _, ref generics, _) => {
990 if attr::contains_name(&it.attrs, "no_mangle") {
991 if !cx.access_levels.is_reachable(it.id) {
992 let msg = format!("function {} is marked #[no_mangle], but not exported",
994 cx.span_lint(PRIVATE_NO_MANGLE_FNS, it.span, &msg);
996 if generics.is_parameterized() {
997 cx.span_lint(NO_MANGLE_GENERIC_ITEMS,
999 "generic functions must be mangled");
1003 hir::ItemStatic(..) => {
1004 if attr::contains_name(&it.attrs, "no_mangle") &&
1005 !cx.access_levels.is_reachable(it.id) {
1006 let msg = format!("static {} is marked #[no_mangle], but not exported",
1008 cx.span_lint(PRIVATE_NO_MANGLE_STATICS, it.span, &msg);
1011 hir::ItemConst(..) => {
1012 if attr::contains_name(&it.attrs, "no_mangle") {
1013 // Const items do not refer to a particular location in memory, and therefore
1014 // don't have anything to attach a symbol to
1015 let msg = "const items should never be #[no_mangle], consider instead using \
1017 cx.span_lint(NO_MANGLE_CONST_ITEMS, it.span, msg);
1025 #[derive(Clone, Copy)]
1026 pub struct MutableTransmutes;
1031 "mutating transmuted &mut T from &T may cause undefined behavior"
1034 impl LintPass for MutableTransmutes {
1035 fn get_lints(&self) -> LintArray {
1036 lint_array!(MUTABLE_TRANSMUTES)
1040 impl LateLintPass for MutableTransmutes {
1041 fn check_expr(&mut self, cx: &LateContext, expr: &hir::Expr) {
1042 use syntax::abi::Abi::RustIntrinsic;
1044 let msg = "mutating transmuted &mut T from &T may cause undefined behavior,\
1045 consider instead using an UnsafeCell";
1046 match get_transmute_from_to(cx, expr) {
1047 Some((&ty::TyRef(_, from_mt), &ty::TyRef(_, to_mt))) => {
1048 if to_mt.mutbl == hir::Mutability::MutMutable
1049 && from_mt.mutbl == hir::Mutability::MutImmutable {
1050 cx.span_lint(MUTABLE_TRANSMUTES, expr.span, msg);
1056 fn get_transmute_from_to<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, expr: &hir::Expr)
1057 -> Option<(&'tcx ty::TypeVariants<'tcx>, &'tcx ty::TypeVariants<'tcx>)> {
1059 hir::ExprPath(..) => (),
1062 if let Def::Fn(did) = cx.tcx.resolve_expr(expr) {
1063 if !def_id_is_transmute(cx, did) {
1066 let typ = cx.tcx.node_id_to_type(expr.id);
1068 ty::TyBareFn(_, ref bare_fn) if bare_fn.abi == RustIntrinsic => {
1069 if let ty::FnConverging(to) = bare_fn.sig.0.output {
1070 let from = bare_fn.sig.0.inputs[0];
1071 return Some((&from.sty, &to.sty));
1080 fn def_id_is_transmute(cx: &LateContext, def_id: DefId) -> bool {
1081 match cx.tcx.lookup_item_type(def_id).ty.sty {
1082 ty::TyBareFn(_, ref bfty) if bfty.abi == RustIntrinsic => (),
1085 cx.tcx.with_path(def_id, |path| match path.last() {
1086 Some(ref last) => last.name().as_str() == "transmute",
1093 /// Forbids using the `#[feature(...)]` attribute
1094 #[derive(Copy, Clone)]
1095 pub struct UnstableFeatures;
1100 "enabling unstable features (deprecated. do not use)"
1103 impl LintPass for UnstableFeatures {
1104 fn get_lints(&self) -> LintArray {
1105 lint_array!(UNSTABLE_FEATURES)
1109 impl LateLintPass for UnstableFeatures {
1110 fn check_attribute(&mut self, ctx: &LateContext, attr: &ast::Attribute) {
1111 if attr::contains_name(&[attr.node.value.clone()], "feature") {
1112 if let Some(items) = attr.node.value.meta_item_list() {
1114 ctx.span_lint(UNSTABLE_FEATURES, item.span, "unstable feature");
1121 /// Lints for attempts to impl Drop on types that have `#[repr(C)]`
1122 /// attribute (see issue #24585).
1123 #[derive(Copy, Clone)]
1124 pub struct DropWithReprExtern;
1127 DROP_WITH_REPR_EXTERN,
1129 "use of #[repr(C)] on a type that implements Drop"
1132 impl LintPass for DropWithReprExtern {
1133 fn get_lints(&self) -> LintArray {
1134 lint_array!(DROP_WITH_REPR_EXTERN)
1138 impl LateLintPass for DropWithReprExtern {
1139 fn check_crate(&mut self, ctx: &LateContext, _: &hir::Crate) {
1140 let drop_trait = match ctx.tcx.lang_items.drop_trait() {
1141 Some(id) => ctx.tcx.lookup_trait_def(id), None => { return }
1143 drop_trait.for_each_impl(ctx.tcx, |drop_impl_did| {
1144 if !drop_impl_did.is_local() {
1147 let dtor_self_type = ctx.tcx.lookup_item_type(drop_impl_did).ty;
1149 match dtor_self_type.sty {
1150 ty::TyEnum(self_type_def, _) |
1151 ty::TyStruct(self_type_def, _) => {
1152 let self_type_did = self_type_def.did;
1153 let hints = ctx.tcx.lookup_repr_hints(self_type_did);
1154 if hints.iter().any(|attr| *attr == attr::ReprExtern) &&
1155 self_type_def.dtor_kind().has_drop_flag() {
1156 let drop_impl_span = ctx.tcx.map.def_id_span(drop_impl_did,
1158 let self_defn_span = ctx.tcx.map.def_id_span(self_type_did,
1160 ctx.span_lint_note(DROP_WITH_REPR_EXTERN,
1162 "implementing Drop adds hidden state to types, \
1163 possibly conflicting with `#[repr(C)]`",
1165 "the `#[repr(C)]` attribute is attached here");