clippy_lints/src/missing_inline.rs

   1 use crate::utils::span_lint;
   2 use rustc::declare_lint_pass;
   3 use rustc::hir;
   4 use rustc::lint::{self, LateContext, LateLintPass, LintArray, LintContext, LintPass};
   5 use rustc_session::declare_tool_lint;
   6 use syntax::ast;
   7 use syntax::source_map::Span;
   8
   9 declare_clippy_lint! {
  10     /// **What it does:** it lints if an exported function, method, trait method with default impl,
  11     /// or trait method impl is not `#[inline]`.
  12     ///
  13     /// **Why is this bad?** In general, it is not. Functions can be inlined across
  14     /// crates when that's profitable as long as any form of LTO is used. When LTO is disabled,
  15     /// functions that are not `#[inline]` cannot be inlined across crates. Certain types of crates
  16     /// might intend for most of the methods in their public API to be able to be inlined across
  17     /// crates even when LTO is disabled. For these types of crates, enabling this lint might make
  18     /// sense. It allows the crate to require all exported methods to be `#[inline]` by default, and
  19     /// then opt out for specific methods where this might not make sense.
  20     ///
  21     /// **Known problems:** None.
  22     ///
  23     /// **Example:**
  24     /// ```rust
  25     /// pub fn foo() {} // missing #[inline]
  26     /// fn ok() {} // ok
  27     /// #[inline] pub fn bar() {} // ok
  28     /// #[inline(always)] pub fn baz() {} // ok
  29     ///
  30     /// pub trait Bar {
  31     ///   fn bar(); // ok
  32     ///   fn def_bar() {} // missing #[inline]
  33     /// }
  34     ///
  35     /// struct Baz;
  36     /// impl Baz {
  37     ///    fn private() {} // ok
  38     /// }
  39     ///
  40     /// impl Bar for Baz {
  41     ///   fn bar() {} // ok - Baz is not exported
  42     /// }
  43     ///
  44     /// pub struct PubBaz;
  45     /// impl PubBaz {
  46     ///    fn private() {} // ok
  47     ///    pub fn not_ptrivate() {} // missing #[inline]
  48     /// }
  49     ///
  50     /// impl Bar for PubBaz {
  51     ///    fn bar() {} // missing #[inline]
  52     ///    fn def_bar() {} // missing #[inline]
  53     /// }
  54     /// ```
  55     pub MISSING_INLINE_IN_PUBLIC_ITEMS,
  56     restriction,
  57     "detects missing #[inline] attribute for public callables (functions, trait methods, methods...)"
  58 }
  59
  60 fn check_missing_inline_attrs(cx: &LateContext<'_, '_>, attrs: &[ast::Attribute], sp: Span, desc: &'static str) {
  61     let has_inline = attrs.iter().any(|a| a.check_name(sym!(inline)));
  62     if !has_inline {
  63         span_lint(
  64             cx,
  65             MISSING_INLINE_IN_PUBLIC_ITEMS,
  66             sp,
  67             &format!("missing `#[inline]` for {}", desc),
  68         );
  69     }
  70 }
  71
  72 fn is_executable(cx: &LateContext<'_, '_>) -> bool {
  73     use rustc::session::config::CrateType;
  74
  75     cx.tcx.sess.crate_types.get().iter().any(|t: &CrateType| match t {
  76         CrateType::Executable => true,
  77         _ => false,
  78     })
  79 }
  80
  81 declare_lint_pass!(MissingInline => [MISSING_INLINE_IN_PUBLIC_ITEMS]);
  82
  83 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for MissingInline {
  84     fn check_item(&mut self, cx: &LateContext<'a, 'tcx>, it: &'tcx hir::Item) {
  85         if lint::in_external_macro(cx.sess(), it.span) || is_executable(cx) {
  86             return;
  87         }
  88
  89         if !cx.access_levels.is_exported(it.hir_id) {
  90             return;
  91         }
  92         match it.kind {
  93             hir::ItemKind::Fn(..) => {
  94                 let desc = "a function";
  95                 check_missing_inline_attrs(cx, &it.attrs, it.span, desc);
  96             },
  97             hir::ItemKind::Trait(ref _is_auto, ref _unsafe, ref _generics, ref _bounds, ref trait_items) => {
  98                 // note: we need to check if the trait is exported so we can't use
  99                 // `LateLintPass::check_trait_item` here.
 100                 for tit in trait_items {
 101                     let tit_ = cx.tcx.hir().trait_item(tit.id);
 102                     match tit_.kind {
 103                         hir::TraitItemKind::Const(..) | hir::TraitItemKind::Type(..) => {},
 104                         hir::TraitItemKind::Method(..) => {
 105                             if tit.defaultness.has_value() {
 106                                 // trait method with default body needs inline in case
 107                                 // an impl is not provided
 108                                 let desc = "a default trait method";
 109                                 let item = cx.tcx.hir().expect_trait_item(tit.id.hir_id);
 110                                 check_missing_inline_attrs(cx, &item.attrs, item.span, desc);
 111                             }
 112                         },
 113                     }
 114                 }
 115             },
 116             hir::ItemKind::Const(..)
 117             | hir::ItemKind::Enum(..)
 118             | hir::ItemKind::Mod(..)
 119             | hir::ItemKind::Static(..)
 120             | hir::ItemKind::Struct(..)
 121             | hir::ItemKind::TraitAlias(..)
 122             | hir::ItemKind::GlobalAsm(..)
 123             | hir::ItemKind::TyAlias(..)
 124             | hir::ItemKind::Union(..)
 125             | hir::ItemKind::OpaqueTy(..)
 126             | hir::ItemKind::ExternCrate(..)
 127             | hir::ItemKind::ForeignMod(..)
 128             | hir::ItemKind::Impl(..)
 129             | hir::ItemKind::Use(..) => {},
 130         };
 131     }
 132
 133     fn check_impl_item(&mut self, cx: &LateContext<'a, 'tcx>, impl_item: &'tcx hir::ImplItem) {
 134         use rustc::ty::{ImplContainer, TraitContainer};
 135         if lint::in_external_macro(cx.sess(), impl_item.span) || is_executable(cx) {
 136             return;
 137         }
 138
 139         // If the item being implemented is not exported, then we don't need #[inline]
 140         if !cx.access_levels.is_exported(impl_item.hir_id) {
 141             return;
 142         }
 143
 144         let desc = match impl_item.kind {
 145             hir::ImplItemKind::Method(..) => "a method",
 146             hir::ImplItemKind::Const(..) | hir::ImplItemKind::TyAlias(_) | hir::ImplItemKind::OpaqueTy(_) => return,
 147         };
 148
 149         let def_id = cx.tcx.hir().local_def_id(impl_item.hir_id);
 150         let trait_def_id = match cx.tcx.associated_item(def_id).container {
 151             TraitContainer(cid) => Some(cid),
 152             ImplContainer(cid) => cx.tcx.impl_trait_ref(cid).map(|t| t.def_id),
 153         };
 154
 155         if let Some(trait_def_id) = trait_def_id {
 156             if cx.tcx.hir().as_local_node_id(trait_def_id).is_some() && !cx.access_levels.is_exported(impl_item.hir_id)
 157             {
 158                 // If a trait is being implemented for an item, and the
 159                 // trait is not exported, we don't need #[inline]
 160                 return;
 161             }
 162         }
 163
 164         check_missing_inline_attrs(cx, &impl_item.attrs, impl_item.span, desc);
 165     }
 166 }