]> git.lizzy.rs Git - rust.git/blob - clippy_lints/src/types.rs
Auto merge of #4686 - lzutao:fix-travis-windows-stuck, r=Manishearth
[rust.git] / clippy_lints / src / types.rs
1 #![allow(rustc::default_hash_types)]
2
3 use std::borrow::Cow;
4 use std::cmp::Ordering;
5 use std::collections::BTreeMap;
6
7 use if_chain::if_chain;
8 use rustc::hir;
9 use rustc::hir::intravisit::{walk_body, walk_expr, walk_ty, FnKind, NestedVisitorMap, Visitor};
10 use rustc::hir::*;
11 use rustc::lint::{in_external_macro, LateContext, LateLintPass, LintArray, LintContext, LintPass};
12 use rustc::ty::layout::LayoutOf;
13 use rustc::ty::{self, InferTy, Ty, TyCtxt, TypeckTables};
14 use rustc::{declare_lint_pass, declare_tool_lint, impl_lint_pass};
15 use rustc_errors::Applicability;
16 use rustc_target::spec::abi::Abi;
17 use rustc_typeck::hir_ty_to_ty;
18 use syntax::ast::{FloatTy, IntTy, LitIntType, LitKind, UintTy};
19 use syntax::errors::DiagnosticBuilder;
20 use syntax::source_map::Span;
21 use syntax::symbol::{sym, Symbol};
22 use syntax_expand::base::MacroKind;
23 use syntax_expand::hygiene::ExpnKind;
24
25 use crate::consts::{constant, Constant};
26 use crate::utils::paths;
27 use crate::utils::{
28     clip, comparisons, differing_macro_contexts, higher, in_constant, int_bits, last_path_segment, match_def_path,
29     match_path, multispan_sugg, qpath_res, same_tys, sext, snippet, snippet_opt, snippet_with_applicability,
30     snippet_with_macro_callsite, span_help_and_lint, span_lint, span_lint_and_sugg, span_lint_and_then, unsext,
31 };
32
33 declare_clippy_lint! {
34     /// **What it does:** Checks for use of `Box<Vec<_>>` anywhere in the code.
35     ///
36     /// **Why is this bad?** `Vec` already keeps its contents in a separate area on
37     /// the heap. So if you `Box` it, you just add another level of indirection
38     /// without any benefit whatsoever.
39     ///
40     /// **Known problems:** None.
41     ///
42     /// **Example:**
43     /// ```rust,ignore
44     /// struct X {
45     ///     values: Box<Vec<Foo>>,
46     /// }
47     /// ```
48     ///
49     /// Better:
50     ///
51     /// ```rust,ignore
52     /// struct X {
53     ///     values: Vec<Foo>,
54     /// }
55     /// ```
56     pub BOX_VEC,
57     perf,
58     "usage of `Box<Vec<T>>`, vector elements are already on the heap"
59 }
60
61 declare_clippy_lint! {
62     /// **What it does:** Checks for use of `Vec<Box<T>>` where T: Sized anywhere in the code.
63     ///
64     /// **Why is this bad?** `Vec` already keeps its contents in a separate area on
65     /// the heap. So if you `Box` its contents, you just add another level of indirection.
66     ///
67     /// **Known problems:** Vec<Box<T: Sized>> makes sense if T is a large type (see #3530,
68     /// 1st comment).
69     ///
70     /// **Example:**
71     /// ```rust
72     /// struct X {
73     ///     values: Vec<Box<i32>>,
74     /// }
75     /// ```
76     ///
77     /// Better:
78     ///
79     /// ```rust
80     /// struct X {
81     ///     values: Vec<i32>,
82     /// }
83     /// ```
84     pub VEC_BOX,
85     complexity,
86     "usage of `Vec<Box<T>>` where T: Sized, vector elements are already on the heap"
87 }
88
89 declare_clippy_lint! {
90     /// **What it does:** Checks for use of `Option<Option<_>>` in function signatures and type
91     /// definitions
92     ///
93     /// **Why is this bad?** `Option<_>` represents an optional value. `Option<Option<_>>`
94     /// represents an optional optional value which is logically the same thing as an optional
95     /// value but has an unneeded extra level of wrapping.
96     ///
97     /// **Known problems:** None.
98     ///
99     /// **Example**
100     /// ```rust
101     /// fn x() -> Option<Option<u32>> {
102     ///     None
103     /// }
104     /// ```
105     pub OPTION_OPTION,
106     complexity,
107     "usage of `Option<Option<T>>`"
108 }
109
110 declare_clippy_lint! {
111     /// **What it does:** Checks for usage of any `LinkedList`, suggesting to use a
112     /// `Vec` or a `VecDeque` (formerly called `RingBuf`).
113     ///
114     /// **Why is this bad?** Gankro says:
115     ///
116     /// > The TL;DR of `LinkedList` is that it's built on a massive amount of
117     /// pointers and indirection.
118     /// > It wastes memory, it has terrible cache locality, and is all-around slow.
119     /// `RingBuf`, while
120     /// > "only" amortized for push/pop, should be faster in the general case for
121     /// almost every possible
122     /// > workload, and isn't even amortized at all if you can predict the capacity
123     /// you need.
124     /// >
125     /// > `LinkedList`s are only really good if you're doing a lot of merging or
126     /// splitting of lists.
127     /// > This is because they can just mangle some pointers instead of actually
128     /// copying the data. Even
129     /// > if you're doing a lot of insertion in the middle of the list, `RingBuf`
130     /// can still be better
131     /// > because of how expensive it is to seek to the middle of a `LinkedList`.
132     ///
133     /// **Known problems:** False positives – the instances where using a
134     /// `LinkedList` makes sense are few and far between, but they can still happen.
135     ///
136     /// **Example:**
137     /// ```rust
138     /// # use std::collections::LinkedList;
139     /// let x: LinkedList<usize> = LinkedList::new();
140     /// ```
141     pub LINKEDLIST,
142     pedantic,
143     "usage of LinkedList, usually a vector is faster, or a more specialized data structure like a VecDeque"
144 }
145
146 declare_clippy_lint! {
147     /// **What it does:** Checks for use of `&Box<T>` anywhere in the code.
148     ///
149     /// **Why is this bad?** Any `&Box<T>` can also be a `&T`, which is more
150     /// general.
151     ///
152     /// **Known problems:** None.
153     ///
154     /// **Example:**
155     /// ```rust,ignore
156     /// fn foo(bar: &Box<T>) { ... }
157     /// ```
158     ///
159     /// Better:
160     ///
161     /// ```rust,ignore
162     /// fn foo(bar: &T) { ... }
163     /// ```
164     pub BORROWED_BOX,
165     complexity,
166     "a borrow of a boxed type"
167 }
168
169 declare_lint_pass!(Types => [BOX_VEC, VEC_BOX, OPTION_OPTION, LINKEDLIST, BORROWED_BOX]);
170
171 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for Types {
172     fn check_fn(&mut self, cx: &LateContext<'_, '_>, _: FnKind<'_>, decl: &FnDecl, _: &Body, _: Span, id: HirId) {
173         // Skip trait implementations; see issue #605.
174         if let Some(hir::Node::Item(item)) = cx.tcx.hir().find(cx.tcx.hir().get_parent_item(id)) {
175             if let ItemKind::Impl(_, _, _, _, Some(..), _, _) = item.kind {
176                 return;
177             }
178         }
179
180         check_fn_decl(cx, decl);
181     }
182
183     fn check_struct_field(&mut self, cx: &LateContext<'_, '_>, field: &hir::StructField) {
184         check_ty(cx, &field.ty, false);
185     }
186
187     fn check_trait_item(&mut self, cx: &LateContext<'_, '_>, item: &TraitItem) {
188         match item.kind {
189             TraitItemKind::Const(ref ty, _) | TraitItemKind::Type(_, Some(ref ty)) => check_ty(cx, ty, false),
190             TraitItemKind::Method(ref sig, _) => check_fn_decl(cx, &sig.decl),
191             _ => (),
192         }
193     }
194
195     fn check_local(&mut self, cx: &LateContext<'_, '_>, local: &Local) {
196         if let Some(ref ty) = local.ty {
197             check_ty(cx, ty, true);
198         }
199     }
200 }
201
202 fn check_fn_decl(cx: &LateContext<'_, '_>, decl: &FnDecl) {
203     for input in &decl.inputs {
204         check_ty(cx, input, false);
205     }
206
207     if let FunctionRetTy::Return(ref ty) = decl.output {
208         check_ty(cx, ty, false);
209     }
210 }
211
212 /// Checks if `qpath` has last segment with type parameter matching `path`
213 fn match_type_parameter(cx: &LateContext<'_, '_>, qpath: &QPath, path: &[&str]) -> bool {
214     let last = last_path_segment(qpath);
215     if_chain! {
216         if let Some(ref params) = last.args;
217         if !params.parenthesized;
218         if let Some(ty) = params.args.iter().find_map(|arg| match arg {
219             GenericArg::Type(ty) => Some(ty),
220             _ => None,
221         });
222         if let TyKind::Path(ref qpath) = ty.kind;
223         if let Some(did) = qpath_res(cx, qpath, ty.hir_id).opt_def_id();
224         if match_def_path(cx, did, path);
225         then {
226             return true;
227         }
228     }
229     false
230 }
231
232 /// Recursively check for `TypePass` lints in the given type. Stop at the first
233 /// lint found.
234 ///
235 /// The parameter `is_local` distinguishes the context of the type; types from
236 /// local bindings should only be checked for the `BORROWED_BOX` lint.
237 #[allow(clippy::too_many_lines)]
238 fn check_ty(cx: &LateContext<'_, '_>, hir_ty: &hir::Ty, is_local: bool) {
239     if hir_ty.span.from_expansion() {
240         return;
241     }
242     match hir_ty.kind {
243         TyKind::Path(ref qpath) if !is_local => {
244             let hir_id = hir_ty.hir_id;
245             let res = qpath_res(cx, qpath, hir_id);
246             if let Some(def_id) = res.opt_def_id() {
247                 if Some(def_id) == cx.tcx.lang_items().owned_box() {
248                     if match_type_parameter(cx, qpath, &paths::VEC) {
249                         span_help_and_lint(
250                             cx,
251                             BOX_VEC,
252                             hir_ty.span,
253                             "you seem to be trying to use `Box<Vec<T>>`. Consider using just `Vec<T>`",
254                             "`Vec<T>` is already on the heap, `Box<Vec<T>>` makes an extra allocation.",
255                         );
256                         return; // don't recurse into the type
257                     }
258                 } else if cx.tcx.is_diagnostic_item(Symbol::intern("vec_type"), def_id) {
259                     if_chain! {
260                         // Get the _ part of Vec<_>
261                         if let Some(ref last) = last_path_segment(qpath).args;
262                         if let Some(ty) = last.args.iter().find_map(|arg| match arg {
263                             GenericArg::Type(ty) => Some(ty),
264                             _ => None,
265                         });
266                         // ty is now _ at this point
267                         if let TyKind::Path(ref ty_qpath) = ty.kind;
268                         let res = qpath_res(cx, ty_qpath, ty.hir_id);
269                         if let Some(def_id) = res.opt_def_id();
270                         if Some(def_id) == cx.tcx.lang_items().owned_box();
271                         // At this point, we know ty is Box<T>, now get T
272                         if let Some(ref last) = last_path_segment(ty_qpath).args;
273                         if let Some(boxed_ty) = last.args.iter().find_map(|arg| match arg {
274                             GenericArg::Type(ty) => Some(ty),
275                             _ => None,
276                         });
277                         then {
278                             let ty_ty = hir_ty_to_ty(cx.tcx, boxed_ty);
279                             if ty_ty.is_sized(cx.tcx.at(ty.span), cx.param_env) {
280                                 span_lint_and_sugg(
281                                     cx,
282                                     VEC_BOX,
283                                     hir_ty.span,
284                                     "`Vec<T>` is already on the heap, the boxing is unnecessary.",
285                                     "try",
286                                     format!("Vec<{}>", ty_ty),
287                                     Applicability::MachineApplicable,
288                                 );
289                                 return; // don't recurse into the type
290                             }
291                         }
292                     }
293                 } else if match_def_path(cx, def_id, &paths::OPTION) {
294                     if match_type_parameter(cx, qpath, &paths::OPTION) {
295                         span_lint(
296                             cx,
297                             OPTION_OPTION,
298                             hir_ty.span,
299                             "consider using `Option<T>` instead of `Option<Option<T>>` or a custom \
300                              enum if you need to distinguish all 3 cases",
301                         );
302                         return; // don't recurse into the type
303                     }
304                 } else if match_def_path(cx, def_id, &paths::LINKED_LIST) {
305                     span_help_and_lint(
306                         cx,
307                         LINKEDLIST,
308                         hir_ty.span,
309                         "I see you're using a LinkedList! Perhaps you meant some other data structure?",
310                         "a VecDeque might work",
311                     );
312                     return; // don't recurse into the type
313                 }
314             }
315             match *qpath {
316                 QPath::Resolved(Some(ref ty), ref p) => {
317                     check_ty(cx, ty, is_local);
318                     for ty in p.segments.iter().flat_map(|seg| {
319                         seg.args
320                             .as_ref()
321                             .map_or_else(|| [].iter(), |params| params.args.iter())
322                             .filter_map(|arg| match arg {
323                                 GenericArg::Type(ty) => Some(ty),
324                                 _ => None,
325                             })
326                     }) {
327                         check_ty(cx, ty, is_local);
328                     }
329                 },
330                 QPath::Resolved(None, ref p) => {
331                     for ty in p.segments.iter().flat_map(|seg| {
332                         seg.args
333                             .as_ref()
334                             .map_or_else(|| [].iter(), |params| params.args.iter())
335                             .filter_map(|arg| match arg {
336                                 GenericArg::Type(ty) => Some(ty),
337                                 _ => None,
338                             })
339                     }) {
340                         check_ty(cx, ty, is_local);
341                     }
342                 },
343                 QPath::TypeRelative(ref ty, ref seg) => {
344                     check_ty(cx, ty, is_local);
345                     if let Some(ref params) = seg.args {
346                         for ty in params.args.iter().filter_map(|arg| match arg {
347                             GenericArg::Type(ty) => Some(ty),
348                             _ => None,
349                         }) {
350                             check_ty(cx, ty, is_local);
351                         }
352                     }
353                 },
354             }
355         },
356         TyKind::Rptr(ref lt, ref mut_ty) => check_ty_rptr(cx, hir_ty, is_local, lt, mut_ty),
357         // recurse
358         TyKind::Slice(ref ty) | TyKind::Array(ref ty, _) | TyKind::Ptr(MutTy { ref ty, .. }) => {
359             check_ty(cx, ty, is_local)
360         },
361         TyKind::Tup(ref tys) => {
362             for ty in tys {
363                 check_ty(cx, ty, is_local);
364             }
365         },
366         _ => {},
367     }
368 }
369
370 fn check_ty_rptr(cx: &LateContext<'_, '_>, hir_ty: &hir::Ty, is_local: bool, lt: &Lifetime, mut_ty: &MutTy) {
371     match mut_ty.ty.kind {
372         TyKind::Path(ref qpath) => {
373             let hir_id = mut_ty.ty.hir_id;
374             let def = qpath_res(cx, qpath, hir_id);
375             if_chain! {
376                 if let Some(def_id) = def.opt_def_id();
377                 if Some(def_id) == cx.tcx.lang_items().owned_box();
378                 if let QPath::Resolved(None, ref path) = *qpath;
379                 if let [ref bx] = *path.segments;
380                 if let Some(ref params) = bx.args;
381                 if !params.parenthesized;
382                 if let Some(inner) = params.args.iter().find_map(|arg| match arg {
383                     GenericArg::Type(ty) => Some(ty),
384                     _ => None,
385                 });
386                 then {
387                     if is_any_trait(inner) {
388                         // Ignore `Box<Any>` types; see issue #1884 for details.
389                         return;
390                     }
391
392                     let ltopt = if lt.is_elided() {
393                         String::new()
394                     } else {
395                         format!("{} ", lt.name.ident().as_str())
396                     };
397                     let mutopt = if mut_ty.mutbl == Mutability::MutMutable {
398                         "mut "
399                     } else {
400                         ""
401                     };
402                     let mut applicability = Applicability::MachineApplicable;
403                     span_lint_and_sugg(
404                         cx,
405                         BORROWED_BOX,
406                         hir_ty.span,
407                         "you seem to be trying to use `&Box<T>`. Consider using just `&T`",
408                         "try",
409                         format!(
410                             "&{}{}{}",
411                             ltopt,
412                             mutopt,
413                             &snippet_with_applicability(cx, inner.span, "..", &mut applicability)
414                         ),
415                         Applicability::Unspecified,
416                     );
417                     return; // don't recurse into the type
418                 }
419             };
420             check_ty(cx, &mut_ty.ty, is_local);
421         },
422         _ => check_ty(cx, &mut_ty.ty, is_local),
423     }
424 }
425
426 // Returns true if given type is `Any` trait.
427 fn is_any_trait(t: &hir::Ty) -> bool {
428     if_chain! {
429         if let TyKind::TraitObject(ref traits, _) = t.kind;
430         if traits.len() >= 1;
431         // Only Send/Sync can be used as additional traits, so it is enough to
432         // check only the first trait.
433         if match_path(&traits[0].trait_ref.path, &paths::ANY_TRAIT);
434         then {
435             return true;
436         }
437     }
438
439     false
440 }
441
442 declare_clippy_lint! {
443     /// **What it does:** Checks for binding a unit value.
444     ///
445     /// **Why is this bad?** A unit value cannot usefully be used anywhere. So
446     /// binding one is kind of pointless.
447     ///
448     /// **Known problems:** None.
449     ///
450     /// **Example:**
451     /// ```rust
452     /// let x = {
453     ///     1;
454     /// };
455     /// ```
456     pub LET_UNIT_VALUE,
457     style,
458     "creating a let binding to a value of unit type, which usually can't be used afterwards"
459 }
460
461 declare_lint_pass!(LetUnitValue => [LET_UNIT_VALUE]);
462
463 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for LetUnitValue {
464     fn check_stmt(&mut self, cx: &LateContext<'a, 'tcx>, stmt: &'tcx Stmt) {
465         if let StmtKind::Local(ref local) = stmt.kind {
466             if is_unit(cx.tables.pat_ty(&local.pat)) {
467                 if in_external_macro(cx.sess(), stmt.span) || local.pat.span.from_expansion() {
468                     return;
469                 }
470                 if higher::is_from_for_desugar(local) {
471                     return;
472                 }
473                 span_lint_and_then(cx, LET_UNIT_VALUE, stmt.span, "this let-binding has unit value", |db| {
474                     if let Some(expr) = &local.init {
475                         let snip = snippet_with_macro_callsite(cx, expr.span, "()");
476                         db.span_suggestion(
477                             stmt.span,
478                             "omit the `let` binding",
479                             format!("{};", snip),
480                             Applicability::MachineApplicable, // snippet
481                         );
482                     }
483                 });
484             }
485         }
486     }
487 }
488
489 declare_clippy_lint! {
490     /// **What it does:** Checks for comparisons to unit. This includes all binary
491     /// comparisons (like `==` and `<`) and asserts.
492     ///
493     /// **Why is this bad?** Unit is always equal to itself, and thus is just a
494     /// clumsily written constant. Mostly this happens when someone accidentally
495     /// adds semicolons at the end of the operands.
496     ///
497     /// **Known problems:** None.
498     ///
499     /// **Example:**
500     /// ```rust
501     /// # fn foo() {};
502     /// # fn bar() {};
503     /// # fn baz() {};
504     /// if {
505     ///     foo();
506     /// } == {
507     ///     bar();
508     /// } {
509     ///     baz();
510     /// }
511     /// ```
512     /// is equal to
513     /// ```rust
514     /// # fn foo() {};
515     /// # fn bar() {};
516     /// # fn baz() {};
517     /// {
518     ///     foo();
519     ///     bar();
520     ///     baz();
521     /// }
522     /// ```
523     ///
524     /// For asserts:
525     /// ```rust
526     /// # fn foo() {};
527     /// # fn bar() {};
528     /// assert_eq!({ foo(); }, { bar(); });
529     /// ```
530     /// will always succeed
531     pub UNIT_CMP,
532     correctness,
533     "comparing unit values"
534 }
535
536 declare_lint_pass!(UnitCmp => [UNIT_CMP]);
537
538 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for UnitCmp {
539     fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr) {
540         if expr.span.from_expansion() {
541             if let Some(callee) = expr.span.source_callee() {
542                 if let ExpnKind::Macro(MacroKind::Bang, symbol) = callee.kind {
543                     if let ExprKind::Binary(ref cmp, ref left, _) = expr.kind {
544                         let op = cmp.node;
545                         if op.is_comparison() && is_unit(cx.tables.expr_ty(left)) {
546                             let result = match &*symbol.as_str() {
547                                 "assert_eq" | "debug_assert_eq" => "succeed",
548                                 "assert_ne" | "debug_assert_ne" => "fail",
549                                 _ => return,
550                             };
551                             span_lint(
552                                 cx,
553                                 UNIT_CMP,
554                                 expr.span,
555                                 &format!(
556                                     "`{}` of unit values detected. This will always {}",
557                                     symbol.as_str(),
558                                     result
559                                 ),
560                             );
561                         }
562                     }
563                 }
564             }
565             return;
566         }
567         if let ExprKind::Binary(ref cmp, ref left, _) = expr.kind {
568             let op = cmp.node;
569             if op.is_comparison() && is_unit(cx.tables.expr_ty(left)) {
570                 let result = match op {
571                     BinOpKind::Eq | BinOpKind::Le | BinOpKind::Ge => "true",
572                     _ => "false",
573                 };
574                 span_lint(
575                     cx,
576                     UNIT_CMP,
577                     expr.span,
578                     &format!(
579                         "{}-comparison of unit values detected. This will always be {}",
580                         op.as_str(),
581                         result
582                     ),
583                 );
584             }
585         }
586     }
587 }
588
589 declare_clippy_lint! {
590     /// **What it does:** Checks for passing a unit value as an argument to a function without using a
591     /// unit literal (`()`).
592     ///
593     /// **Why is this bad?** This is likely the result of an accidental semicolon.
594     ///
595     /// **Known problems:** None.
596     ///
597     /// **Example:**
598     /// ```rust,ignore
599     /// foo({
600     ///     let a = bar();
601     ///     baz(a);
602     /// })
603     /// ```
604     pub UNIT_ARG,
605     complexity,
606     "passing unit to a function"
607 }
608
609 declare_lint_pass!(UnitArg => [UNIT_ARG]);
610
611 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for UnitArg {
612     fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr) {
613         if expr.span.from_expansion() {
614             return;
615         }
616
617         // apparently stuff in the desugaring of `?` can trigger this
618         // so check for that here
619         // only the calls to `Try::from_error` is marked as desugared,
620         // so we need to check both the current Expr and its parent.
621         if is_questionmark_desugar_marked_call(expr) {
622             return;
623         }
624         if_chain! {
625             let map = &cx.tcx.hir();
626             let opt_parent_node = map.find(map.get_parent_node(expr.hir_id));
627             if let Some(hir::Node::Expr(parent_expr)) = opt_parent_node;
628             if is_questionmark_desugar_marked_call(parent_expr);
629             then {
630                 return;
631             }
632         }
633
634         match expr.kind {
635             ExprKind::Call(_, ref args) | ExprKind::MethodCall(_, _, ref args) => {
636                 for arg in args {
637                     if is_unit(cx.tables.expr_ty(arg)) && !is_unit_literal(arg) {
638                         if let ExprKind::Match(.., match_source) = &arg.kind {
639                             if *match_source == MatchSource::TryDesugar {
640                                 continue;
641                             }
642                         }
643
644                         span_lint_and_sugg(
645                             cx,
646                             UNIT_ARG,
647                             arg.span,
648                             "passing a unit value to a function",
649                             "if you intended to pass a unit value, use a unit literal instead",
650                             "()".to_string(),
651                             Applicability::MachineApplicable,
652                         );
653                     }
654                 }
655             },
656             _ => (),
657         }
658     }
659 }
660
661 fn is_questionmark_desugar_marked_call(expr: &Expr) -> bool {
662     use syntax_pos::hygiene::DesugaringKind;
663     if let ExprKind::Call(ref callee, _) = expr.kind {
664         callee.span.is_desugaring(DesugaringKind::QuestionMark)
665     } else {
666         false
667     }
668 }
669
670 fn is_unit(ty: Ty<'_>) -> bool {
671     match ty.kind {
672         ty::Tuple(slice) if slice.is_empty() => true,
673         _ => false,
674     }
675 }
676
677 fn is_unit_literal(expr: &Expr) -> bool {
678     match expr.kind {
679         ExprKind::Tup(ref slice) if slice.is_empty() => true,
680         _ => false,
681     }
682 }
683
684 declare_clippy_lint! {
685     /// **What it does:** Checks for casts from any numerical to a float type where
686     /// the receiving type cannot store all values from the original type without
687     /// rounding errors. This possible rounding is to be expected, so this lint is
688     /// `Allow` by default.
689     ///
690     /// Basically, this warns on casting any integer with 32 or more bits to `f32`
691     /// or any 64-bit integer to `f64`.
692     ///
693     /// **Why is this bad?** It's not bad at all. But in some applications it can be
694     /// helpful to know where precision loss can take place. This lint can help find
695     /// those places in the code.
696     ///
697     /// **Known problems:** None.
698     ///
699     /// **Example:**
700     /// ```rust
701     /// let x = std::u64::MAX;
702     /// x as f64;
703     /// ```
704     pub CAST_PRECISION_LOSS,
705     pedantic,
706     "casts that cause loss of precision, e.g., `x as f32` where `x: u64`"
707 }
708
709 declare_clippy_lint! {
710     /// **What it does:** Checks for casts from a signed to an unsigned numerical
711     /// type. In this case, negative values wrap around to large positive values,
712     /// which can be quite surprising in practice. However, as the cast works as
713     /// defined, this lint is `Allow` by default.
714     ///
715     /// **Why is this bad?** Possibly surprising results. You can activate this lint
716     /// as a one-time check to see where numerical wrapping can arise.
717     ///
718     /// **Known problems:** None.
719     ///
720     /// **Example:**
721     /// ```rust
722     /// let y: i8 = -1;
723     /// y as u128; // will return 18446744073709551615
724     /// ```
725     pub CAST_SIGN_LOSS,
726     pedantic,
727     "casts from signed types to unsigned types, e.g., `x as u32` where `x: i32`"
728 }
729
730 declare_clippy_lint! {
731     /// **What it does:** Checks for casts between numerical types that may
732     /// truncate large values. This is expected behavior, so the cast is `Allow` by
733     /// default.
734     ///
735     /// **Why is this bad?** In some problem domains, it is good practice to avoid
736     /// truncation. This lint can be activated to help assess where additional
737     /// checks could be beneficial.
738     ///
739     /// **Known problems:** None.
740     ///
741     /// **Example:**
742     /// ```rust
743     /// fn as_u8(x: u64) -> u8 {
744     ///     x as u8
745     /// }
746     /// ```
747     pub CAST_POSSIBLE_TRUNCATION,
748     pedantic,
749     "casts that may cause truncation of the value, e.g., `x as u8` where `x: u32`, or `x as i32` where `x: f32`"
750 }
751
752 declare_clippy_lint! {
753     /// **What it does:** Checks for casts from an unsigned type to a signed type of
754     /// the same size. Performing such a cast is a 'no-op' for the compiler,
755     /// i.e., nothing is changed at the bit level, and the binary representation of
756     /// the value is reinterpreted. This can cause wrapping if the value is too big
757     /// for the target signed type. However, the cast works as defined, so this lint
758     /// is `Allow` by default.
759     ///
760     /// **Why is this bad?** While such a cast is not bad in itself, the results can
761     /// be surprising when this is not the intended behavior, as demonstrated by the
762     /// example below.
763     ///
764     /// **Known problems:** None.
765     ///
766     /// **Example:**
767     /// ```rust
768     /// std::u32::MAX as i32; // will yield a value of `-1`
769     /// ```
770     pub CAST_POSSIBLE_WRAP,
771     pedantic,
772     "casts that may cause wrapping around the value, e.g., `x as i32` where `x: u32` and `x > i32::MAX`"
773 }
774
775 declare_clippy_lint! {
776     /// **What it does:** Checks for casts between numerical types that may
777     /// be replaced by safe conversion functions.
778     ///
779     /// **Why is this bad?** Rust's `as` keyword will perform many kinds of
780     /// conversions, including silently lossy conversions. Conversion functions such
781     /// as `i32::from` will only perform lossless conversions. Using the conversion
782     /// functions prevents conversions from turning into silent lossy conversions if
783     /// the types of the input expressions ever change, and make it easier for
784     /// people reading the code to know that the conversion is lossless.
785     ///
786     /// **Known problems:** None.
787     ///
788     /// **Example:**
789     /// ```rust
790     /// fn as_u64(x: u8) -> u64 {
791     ///     x as u64
792     /// }
793     /// ```
794     ///
795     /// Using `::from` would look like this:
796     ///
797     /// ```rust
798     /// fn as_u64(x: u8) -> u64 {
799     ///     u64::from(x)
800     /// }
801     /// ```
802     pub CAST_LOSSLESS,
803     pedantic,
804     "casts using `as` that are known to be lossless, e.g., `x as u64` where `x: u8`"
805 }
806
807 declare_clippy_lint! {
808     /// **What it does:** Checks for casts to the same type.
809     ///
810     /// **Why is this bad?** It's just unnecessary.
811     ///
812     /// **Known problems:** None.
813     ///
814     /// **Example:**
815     /// ```rust
816     /// let _ = 2i32 as i32;
817     /// ```
818     pub UNNECESSARY_CAST,
819     complexity,
820     "cast to the same type, e.g., `x as i32` where `x: i32`"
821 }
822
823 declare_clippy_lint! {
824     /// **What it does:** Checks for casts from a less-strictly-aligned pointer to a
825     /// more-strictly-aligned pointer
826     ///
827     /// **Why is this bad?** Dereferencing the resulting pointer may be undefined
828     /// behavior.
829     ///
830     /// **Known problems:** Using `std::ptr::read_unaligned` and `std::ptr::write_unaligned` or similar
831     /// on the resulting pointer is fine.
832     ///
833     /// **Example:**
834     /// ```rust
835     /// let _ = (&1u8 as *const u8) as *const u16;
836     /// let _ = (&mut 1u8 as *mut u8) as *mut u16;
837     /// ```
838     pub CAST_PTR_ALIGNMENT,
839     correctness,
840     "cast from a pointer to a more-strictly-aligned pointer"
841 }
842
843 declare_clippy_lint! {
844     /// **What it does:** Checks for casts of function pointers to something other than usize
845     ///
846     /// **Why is this bad?**
847     /// Casting a function pointer to anything other than usize/isize is not portable across
848     /// architectures, because you end up losing bits if the target type is too small or end up with a
849     /// bunch of extra bits that waste space and add more instructions to the final binary than
850     /// strictly necessary for the problem
851     ///
852     /// Casting to isize also doesn't make sense since there are no signed addresses.
853     ///
854     /// **Example**
855     ///
856     /// ```rust
857     /// // Bad
858     /// fn fun() -> i32 { 1 }
859     /// let a = fun as i64;
860     ///
861     /// // Good
862     /// fn fun2() -> i32 { 1 }
863     /// let a = fun2 as usize;
864     /// ```
865     pub FN_TO_NUMERIC_CAST,
866     style,
867     "casting a function pointer to a numeric type other than usize"
868 }
869
870 declare_clippy_lint! {
871     /// **What it does:** Checks for casts of a function pointer to a numeric type not wide enough to
872     /// store address.
873     ///
874     /// **Why is this bad?**
875     /// Such a cast discards some bits of the function's address. If this is intended, it would be more
876     /// clearly expressed by casting to usize first, then casting the usize to the intended type (with
877     /// a comment) to perform the truncation.
878     ///
879     /// **Example**
880     ///
881     /// ```rust
882     /// // Bad
883     /// fn fn1() -> i16 {
884     ///     1
885     /// };
886     /// let _ = fn1 as i32;
887     ///
888     /// // Better: Cast to usize first, then comment with the reason for the truncation
889     /// fn fn2() -> i16 {
890     ///     1
891     /// };
892     /// let fn_ptr = fn2 as usize;
893     /// let fn_ptr_truncated = fn_ptr as i32;
894     /// ```
895     pub FN_TO_NUMERIC_CAST_WITH_TRUNCATION,
896     style,
897     "casting a function pointer to a numeric type not wide enough to store the address"
898 }
899
900 /// Returns the size in bits of an integral type.
901 /// Will return 0 if the type is not an int or uint variant
902 fn int_ty_to_nbits(typ: Ty<'_>, tcx: TyCtxt<'_>) -> u64 {
903     match typ.kind {
904         ty::Int(i) => match i {
905             IntTy::Isize => tcx.data_layout.pointer_size.bits(),
906             IntTy::I8 => 8,
907             IntTy::I16 => 16,
908             IntTy::I32 => 32,
909             IntTy::I64 => 64,
910             IntTy::I128 => 128,
911         },
912         ty::Uint(i) => match i {
913             UintTy::Usize => tcx.data_layout.pointer_size.bits(),
914             UintTy::U8 => 8,
915             UintTy::U16 => 16,
916             UintTy::U32 => 32,
917             UintTy::U64 => 64,
918             UintTy::U128 => 128,
919         },
920         _ => 0,
921     }
922 }
923
924 fn is_isize_or_usize(typ: Ty<'_>) -> bool {
925     match typ.kind {
926         ty::Int(IntTy::Isize) | ty::Uint(UintTy::Usize) => true,
927         _ => false,
928     }
929 }
930
931 fn span_precision_loss_lint(cx: &LateContext<'_, '_>, expr: &Expr, cast_from: Ty<'_>, cast_to_f64: bool) {
932     let mantissa_nbits = if cast_to_f64 { 52 } else { 23 };
933     let arch_dependent = is_isize_or_usize(cast_from) && cast_to_f64;
934     let arch_dependent_str = "on targets with 64-bit wide pointers ";
935     let from_nbits_str = if arch_dependent {
936         "64".to_owned()
937     } else if is_isize_or_usize(cast_from) {
938         "32 or 64".to_owned()
939     } else {
940         int_ty_to_nbits(cast_from, cx.tcx).to_string()
941     };
942     span_lint(
943         cx,
944         CAST_PRECISION_LOSS,
945         expr.span,
946         &format!(
947             "casting {0} to {1} causes a loss of precision {2}({0} is {3} bits wide, but {1}'s mantissa \
948              is only {4} bits wide)",
949             cast_from,
950             if cast_to_f64 { "f64" } else { "f32" },
951             if arch_dependent { arch_dependent_str } else { "" },
952             from_nbits_str,
953             mantissa_nbits
954         ),
955     );
956 }
957
958 fn should_strip_parens(op: &Expr, snip: &str) -> bool {
959     if let ExprKind::Binary(_, _, _) = op.kind {
960         if snip.starts_with('(') && snip.ends_with(')') {
961             return true;
962         }
963     }
964     false
965 }
966
967 fn span_lossless_lint(cx: &LateContext<'_, '_>, expr: &Expr, op: &Expr, cast_from: Ty<'_>, cast_to: Ty<'_>) {
968     // Do not suggest using From in consts/statics until it is valid to do so (see #2267).
969     if in_constant(cx, expr.hir_id) {
970         return;
971     }
972     // The suggestion is to use a function call, so if the original expression
973     // has parens on the outside, they are no longer needed.
974     let mut applicability = Applicability::MachineApplicable;
975     let opt = snippet_opt(cx, op.span);
976     let sugg = if let Some(ref snip) = opt {
977         if should_strip_parens(op, snip) {
978             &snip[1..snip.len() - 1]
979         } else {
980             snip.as_str()
981         }
982     } else {
983         applicability = Applicability::HasPlaceholders;
984         ".."
985     };
986
987     span_lint_and_sugg(
988         cx,
989         CAST_LOSSLESS,
990         expr.span,
991         &format!(
992             "casting {} to {} may become silently lossy if you later change the type",
993             cast_from, cast_to
994         ),
995         "try",
996         format!("{}::from({})", cast_to, sugg),
997         applicability,
998     );
999 }
1000
1001 enum ArchSuffix {
1002     _32,
1003     _64,
1004     None,
1005 }
1006
1007 fn check_loss_of_sign(cx: &LateContext<'_, '_>, expr: &Expr, op: &Expr, cast_from: Ty<'_>, cast_to: Ty<'_>) {
1008     if !cast_from.is_signed() || cast_to.is_signed() {
1009         return;
1010     }
1011
1012     // don't lint for positive constants
1013     let const_val = constant(cx, &cx.tables, op);
1014     if_chain! {
1015         if let Some((const_val, _)) = const_val;
1016         if let Constant::Int(n) = const_val;
1017         if let ty::Int(ity) = cast_from.kind;
1018         if sext(cx.tcx, n, ity) >= 0;
1019         then {
1020             return
1021         }
1022     }
1023
1024     // don't lint for the result of `abs`
1025     // `abs` is an inherent impl of `i{N}`, so a method call with ident `abs` will always
1026     // resolve to that spesific method
1027     if_chain! {
1028         if let ExprKind::MethodCall(ref path, _, _) = op.kind;
1029         if path.ident.name.as_str() == "abs";
1030         then {
1031             return
1032         }
1033     }
1034
1035     span_lint(
1036         cx,
1037         CAST_SIGN_LOSS,
1038         expr.span,
1039         &format!("casting {} to {} may lose the sign of the value", cast_from, cast_to),
1040     );
1041 }
1042
1043 fn check_truncation_and_wrapping(cx: &LateContext<'_, '_>, expr: &Expr, cast_from: Ty<'_>, cast_to: Ty<'_>) {
1044     let arch_64_suffix = " on targets with 64-bit wide pointers";
1045     let arch_32_suffix = " on targets with 32-bit wide pointers";
1046     let cast_unsigned_to_signed = !cast_from.is_signed() && cast_to.is_signed();
1047     let from_nbits = int_ty_to_nbits(cast_from, cx.tcx);
1048     let to_nbits = int_ty_to_nbits(cast_to, cx.tcx);
1049     let (span_truncation, suffix_truncation, span_wrap, suffix_wrap) =
1050         match (is_isize_or_usize(cast_from), is_isize_or_usize(cast_to)) {
1051             (true, true) | (false, false) => (
1052                 to_nbits < from_nbits,
1053                 ArchSuffix::None,
1054                 to_nbits == from_nbits && cast_unsigned_to_signed,
1055                 ArchSuffix::None,
1056             ),
1057             (true, false) => (
1058                 to_nbits <= 32,
1059                 if to_nbits == 32 {
1060                     ArchSuffix::_64
1061                 } else {
1062                     ArchSuffix::None
1063                 },
1064                 to_nbits <= 32 && cast_unsigned_to_signed,
1065                 ArchSuffix::_32,
1066             ),
1067             (false, true) => (
1068                 from_nbits == 64,
1069                 ArchSuffix::_32,
1070                 cast_unsigned_to_signed,
1071                 if from_nbits == 64 {
1072                     ArchSuffix::_64
1073                 } else {
1074                     ArchSuffix::_32
1075                 },
1076             ),
1077         };
1078     if span_truncation {
1079         span_lint(
1080             cx,
1081             CAST_POSSIBLE_TRUNCATION,
1082             expr.span,
1083             &format!(
1084                 "casting {} to {} may truncate the value{}",
1085                 cast_from,
1086                 cast_to,
1087                 match suffix_truncation {
1088                     ArchSuffix::_32 => arch_32_suffix,
1089                     ArchSuffix::_64 => arch_64_suffix,
1090                     ArchSuffix::None => "",
1091                 }
1092             ),
1093         );
1094     }
1095     if span_wrap {
1096         span_lint(
1097             cx,
1098             CAST_POSSIBLE_WRAP,
1099             expr.span,
1100             &format!(
1101                 "casting {} to {} may wrap around the value{}",
1102                 cast_from,
1103                 cast_to,
1104                 match suffix_wrap {
1105                     ArchSuffix::_32 => arch_32_suffix,
1106                     ArchSuffix::_64 => arch_64_suffix,
1107                     ArchSuffix::None => "",
1108                 }
1109             ),
1110         );
1111     }
1112 }
1113
1114 fn check_lossless(cx: &LateContext<'_, '_>, expr: &Expr, op: &Expr, cast_from: Ty<'_>, cast_to: Ty<'_>) {
1115     let cast_signed_to_unsigned = cast_from.is_signed() && !cast_to.is_signed();
1116     let from_nbits = int_ty_to_nbits(cast_from, cx.tcx);
1117     let to_nbits = int_ty_to_nbits(cast_to, cx.tcx);
1118     if !is_isize_or_usize(cast_from) && !is_isize_or_usize(cast_to) && from_nbits < to_nbits && !cast_signed_to_unsigned
1119     {
1120         span_lossless_lint(cx, expr, op, cast_from, cast_to);
1121     }
1122 }
1123
1124 declare_lint_pass!(Casts => [
1125     CAST_PRECISION_LOSS,
1126     CAST_SIGN_LOSS,
1127     CAST_POSSIBLE_TRUNCATION,
1128     CAST_POSSIBLE_WRAP,
1129     CAST_LOSSLESS,
1130     UNNECESSARY_CAST,
1131     CAST_PTR_ALIGNMENT,
1132     FN_TO_NUMERIC_CAST,
1133     FN_TO_NUMERIC_CAST_WITH_TRUNCATION,
1134 ]);
1135
1136 // Check if the given type is either `core::ffi::c_void` or
1137 // one of the platform specific `libc::<platform>::c_void` of libc.
1138 fn is_c_void(cx: &LateContext<'_, '_>, ty: Ty<'_>) -> bool {
1139     if let ty::Adt(adt, _) = ty.kind {
1140         let names = cx.get_def_path(adt.did);
1141
1142         if names.is_empty() {
1143             return false;
1144         }
1145         if names[0] == sym!(libc) || names[0] == sym::core && *names.last().unwrap() == sym!(c_void) {
1146             return true;
1147         }
1148     }
1149     false
1150 }
1151
1152 /// Returns the mantissa bits wide of a fp type.
1153 /// Will return 0 if the type is not a fp
1154 fn fp_ty_mantissa_nbits(typ: Ty<'_>) -> u32 {
1155     match typ.kind {
1156         ty::Float(FloatTy::F32) => 23,
1157         ty::Float(FloatTy::F64) | ty::Infer(InferTy::FloatVar(_)) => 52,
1158         _ => 0,
1159     }
1160 }
1161
1162 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for Casts {
1163     fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr) {
1164         if expr.span.from_expansion() {
1165             return;
1166         }
1167         if let ExprKind::Cast(ref ex, _) = expr.kind {
1168             let (cast_from, cast_to) = (cx.tables.expr_ty(ex), cx.tables.expr_ty(expr));
1169             lint_fn_to_numeric_cast(cx, expr, ex, cast_from, cast_to);
1170             if let ExprKind::Lit(ref lit) = ex.kind {
1171                 if let LitKind::Int(n, _) = lit.node {
1172                     if cast_to.is_floating_point() {
1173                         let from_nbits = 128 - n.leading_zeros();
1174                         let to_nbits = fp_ty_mantissa_nbits(cast_to);
1175                         if from_nbits != 0 && to_nbits != 0 && from_nbits <= to_nbits {
1176                             span_lint_and_sugg(
1177                                 cx,
1178                                 UNNECESSARY_CAST,
1179                                 expr.span,
1180                                 &format!("casting integer literal to {} is unnecessary", cast_to),
1181                                 "try",
1182                                 format!("{}_{}", n, cast_to),
1183                                 Applicability::MachineApplicable,
1184                             );
1185                             return;
1186                         }
1187                     }
1188                 }
1189                 match lit.node {
1190                     LitKind::Int(_, LitIntType::Unsuffixed) | LitKind::FloatUnsuffixed(_) => {},
1191                     _ => {
1192                         if cast_from.kind == cast_to.kind && !in_external_macro(cx.sess(), expr.span) {
1193                             span_lint(
1194                                 cx,
1195                                 UNNECESSARY_CAST,
1196                                 expr.span,
1197                                 &format!(
1198                                     "casting to the same type is unnecessary (`{}` -> `{}`)",
1199                                     cast_from, cast_to
1200                                 ),
1201                             );
1202                         }
1203                     },
1204                 }
1205             }
1206             if cast_from.is_numeric() && cast_to.is_numeric() && !in_external_macro(cx.sess(), expr.span) {
1207                 lint_numeric_casts(cx, expr, ex, cast_from, cast_to);
1208             }
1209
1210             lint_cast_ptr_alignment(cx, expr, cast_from, cast_to);
1211         }
1212     }
1213 }
1214
1215 fn lint_numeric_casts<'tcx>(
1216     cx: &LateContext<'_, 'tcx>,
1217     expr: &Expr,
1218     cast_expr: &Expr,
1219     cast_from: Ty<'tcx>,
1220     cast_to: Ty<'tcx>,
1221 ) {
1222     match (cast_from.is_integral(), cast_to.is_integral()) {
1223         (true, false) => {
1224             let from_nbits = int_ty_to_nbits(cast_from, cx.tcx);
1225             let to_nbits = if let ty::Float(FloatTy::F32) = cast_to.kind {
1226                 32
1227             } else {
1228                 64
1229             };
1230             if is_isize_or_usize(cast_from) || from_nbits >= to_nbits {
1231                 span_precision_loss_lint(cx, expr, cast_from, to_nbits == 64);
1232             }
1233             if from_nbits < to_nbits {
1234                 span_lossless_lint(cx, expr, cast_expr, cast_from, cast_to);
1235             }
1236         },
1237         (false, true) => {
1238             span_lint(
1239                 cx,
1240                 CAST_POSSIBLE_TRUNCATION,
1241                 expr.span,
1242                 &format!("casting {} to {} may truncate the value", cast_from, cast_to),
1243             );
1244             if !cast_to.is_signed() {
1245                 span_lint(
1246                     cx,
1247                     CAST_SIGN_LOSS,
1248                     expr.span,
1249                     &format!("casting {} to {} may lose the sign of the value", cast_from, cast_to),
1250                 );
1251             }
1252         },
1253         (true, true) => {
1254             check_loss_of_sign(cx, expr, cast_expr, cast_from, cast_to);
1255             check_truncation_and_wrapping(cx, expr, cast_from, cast_to);
1256             check_lossless(cx, expr, cast_expr, cast_from, cast_to);
1257         },
1258         (false, false) => {
1259             if let (&ty::Float(FloatTy::F64), &ty::Float(FloatTy::F32)) = (&cast_from.kind, &cast_to.kind) {
1260                 span_lint(
1261                     cx,
1262                     CAST_POSSIBLE_TRUNCATION,
1263                     expr.span,
1264                     "casting f64 to f32 may truncate the value",
1265                 );
1266             }
1267             if let (&ty::Float(FloatTy::F32), &ty::Float(FloatTy::F64)) = (&cast_from.kind, &cast_to.kind) {
1268                 span_lossless_lint(cx, expr, cast_expr, cast_from, cast_to);
1269             }
1270         },
1271     }
1272 }
1273
1274 fn lint_cast_ptr_alignment<'tcx>(cx: &LateContext<'_, 'tcx>, expr: &Expr, cast_from: Ty<'tcx>, cast_to: Ty<'tcx>) {
1275     if_chain! {
1276         if let ty::RawPtr(from_ptr_ty) = &cast_from.kind;
1277         if let ty::RawPtr(to_ptr_ty) = &cast_to.kind;
1278         if let Ok(from_layout) = cx.layout_of(from_ptr_ty.ty);
1279         if let Ok(to_layout) = cx.layout_of(to_ptr_ty.ty);
1280         if from_layout.align.abi < to_layout.align.abi;
1281         // with c_void, we inherently need to trust the user
1282         if !is_c_void(cx, from_ptr_ty.ty);
1283         // when casting from a ZST, we don't know enough to properly lint
1284         if !from_layout.is_zst();
1285         then {
1286             span_lint(
1287                 cx,
1288                 CAST_PTR_ALIGNMENT,
1289                 expr.span,
1290                 &format!(
1291                     "casting from `{}` to a more-strictly-aligned pointer (`{}`) ({} < {} bytes)",
1292                     cast_from,
1293                     cast_to,
1294                     from_layout.align.abi.bytes(),
1295                     to_layout.align.abi.bytes(),
1296                 ),
1297             );
1298         }
1299     }
1300 }
1301
1302 fn lint_fn_to_numeric_cast(
1303     cx: &LateContext<'_, '_>,
1304     expr: &Expr,
1305     cast_expr: &Expr,
1306     cast_from: Ty<'_>,
1307     cast_to: Ty<'_>,
1308 ) {
1309     // We only want to check casts to `ty::Uint` or `ty::Int`
1310     match cast_to.kind {
1311         ty::Uint(_) | ty::Int(..) => { /* continue on */ },
1312         _ => return,
1313     }
1314     match cast_from.kind {
1315         ty::FnDef(..) | ty::FnPtr(_) => {
1316             let mut applicability = Applicability::MaybeIncorrect;
1317             let from_snippet = snippet_with_applicability(cx, cast_expr.span, "x", &mut applicability);
1318
1319             let to_nbits = int_ty_to_nbits(cast_to, cx.tcx);
1320             if to_nbits < cx.tcx.data_layout.pointer_size.bits() {
1321                 span_lint_and_sugg(
1322                     cx,
1323                     FN_TO_NUMERIC_CAST_WITH_TRUNCATION,
1324                     expr.span,
1325                     &format!(
1326                         "casting function pointer `{}` to `{}`, which truncates the value",
1327                         from_snippet, cast_to
1328                     ),
1329                     "try",
1330                     format!("{} as usize", from_snippet),
1331                     applicability,
1332                 );
1333             } else if cast_to.kind != ty::Uint(UintTy::Usize) {
1334                 span_lint_and_sugg(
1335                     cx,
1336                     FN_TO_NUMERIC_CAST,
1337                     expr.span,
1338                     &format!("casting function pointer `{}` to `{}`", from_snippet, cast_to),
1339                     "try",
1340                     format!("{} as usize", from_snippet),
1341                     applicability,
1342                 );
1343             }
1344         },
1345         _ => {},
1346     }
1347 }
1348
1349 declare_clippy_lint! {
1350     /// **What it does:** Checks for types used in structs, parameters and `let`
1351     /// declarations above a certain complexity threshold.
1352     ///
1353     /// **Why is this bad?** Too complex types make the code less readable. Consider
1354     /// using a `type` definition to simplify them.
1355     ///
1356     /// **Known problems:** None.
1357     ///
1358     /// **Example:**
1359     /// ```rust
1360     /// # use std::rc::Rc;
1361     /// struct Foo {
1362     ///     inner: Rc<Vec<Vec<Box<(u32, u32, u32, u32)>>>>,
1363     /// }
1364     /// ```
1365     pub TYPE_COMPLEXITY,
1366     complexity,
1367     "usage of very complex types that might be better factored into `type` definitions"
1368 }
1369
1370 pub struct TypeComplexity {
1371     threshold: u64,
1372 }
1373
1374 impl TypeComplexity {
1375     #[must_use]
1376     pub fn new(threshold: u64) -> Self {
1377         Self { threshold }
1378     }
1379 }
1380
1381 impl_lint_pass!(TypeComplexity => [TYPE_COMPLEXITY]);
1382
1383 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for TypeComplexity {
1384     fn check_fn(
1385         &mut self,
1386         cx: &LateContext<'a, 'tcx>,
1387         _: FnKind<'tcx>,
1388         decl: &'tcx FnDecl,
1389         _: &'tcx Body,
1390         _: Span,
1391         _: HirId,
1392     ) {
1393         self.check_fndecl(cx, decl);
1394     }
1395
1396     fn check_struct_field(&mut self, cx: &LateContext<'a, 'tcx>, field: &'tcx hir::StructField) {
1397         // enum variants are also struct fields now
1398         self.check_type(cx, &field.ty);
1399     }
1400
1401     fn check_item(&mut self, cx: &LateContext<'a, 'tcx>, item: &'tcx Item) {
1402         match item.kind {
1403             ItemKind::Static(ref ty, _, _) | ItemKind::Const(ref ty, _) => self.check_type(cx, ty),
1404             // functions, enums, structs, impls and traits are covered
1405             _ => (),
1406         }
1407     }
1408
1409     fn check_trait_item(&mut self, cx: &LateContext<'a, 'tcx>, item: &'tcx TraitItem) {
1410         match item.kind {
1411             TraitItemKind::Const(ref ty, _) | TraitItemKind::Type(_, Some(ref ty)) => self.check_type(cx, ty),
1412             TraitItemKind::Method(MethodSig { ref decl, .. }, TraitMethod::Required(_)) => self.check_fndecl(cx, decl),
1413             // methods with default impl are covered by check_fn
1414             _ => (),
1415         }
1416     }
1417
1418     fn check_impl_item(&mut self, cx: &LateContext<'a, 'tcx>, item: &'tcx ImplItem) {
1419         match item.kind {
1420             ImplItemKind::Const(ref ty, _) | ImplItemKind::TyAlias(ref ty) => self.check_type(cx, ty),
1421             // methods are covered by check_fn
1422             _ => (),
1423         }
1424     }
1425
1426     fn check_local(&mut self, cx: &LateContext<'a, 'tcx>, local: &'tcx Local) {
1427         if let Some(ref ty) = local.ty {
1428             self.check_type(cx, ty);
1429         }
1430     }
1431 }
1432
1433 impl<'a, 'tcx> TypeComplexity {
1434     fn check_fndecl(&self, cx: &LateContext<'a, 'tcx>, decl: &'tcx FnDecl) {
1435         for arg in &decl.inputs {
1436             self.check_type(cx, arg);
1437         }
1438         if let Return(ref ty) = decl.output {
1439             self.check_type(cx, ty);
1440         }
1441     }
1442
1443     fn check_type(&self, cx: &LateContext<'_, '_>, ty: &hir::Ty) {
1444         if ty.span.from_expansion() {
1445             return;
1446         }
1447         let score = {
1448             let mut visitor = TypeComplexityVisitor { score: 0, nest: 1 };
1449             visitor.visit_ty(ty);
1450             visitor.score
1451         };
1452
1453         if score > self.threshold {
1454             span_lint(
1455                 cx,
1456                 TYPE_COMPLEXITY,
1457                 ty.span,
1458                 "very complex type used. Consider factoring parts into `type` definitions",
1459             );
1460         }
1461     }
1462 }
1463
1464 /// Walks a type and assigns a complexity score to it.
1465 struct TypeComplexityVisitor {
1466     /// total complexity score of the type
1467     score: u64,
1468     /// current nesting level
1469     nest: u64,
1470 }
1471
1472 impl<'tcx> Visitor<'tcx> for TypeComplexityVisitor {
1473     fn visit_ty(&mut self, ty: &'tcx hir::Ty) {
1474         let (add_score, sub_nest) = match ty.kind {
1475             // _, &x and *x have only small overhead; don't mess with nesting level
1476             TyKind::Infer | TyKind::Ptr(..) | TyKind::Rptr(..) => (1, 0),
1477
1478             // the "normal" components of a type: named types, arrays/tuples
1479             TyKind::Path(..) | TyKind::Slice(..) | TyKind::Tup(..) | TyKind::Array(..) => (10 * self.nest, 1),
1480
1481             // function types bring a lot of overhead
1482             TyKind::BareFn(ref bare) if bare.abi == Abi::Rust => (50 * self.nest, 1),
1483
1484             TyKind::TraitObject(ref param_bounds, _) => {
1485                 let has_lifetime_parameters = param_bounds.iter().any(|bound| {
1486                     bound.bound_generic_params.iter().any(|gen| match gen.kind {
1487                         GenericParamKind::Lifetime { .. } => true,
1488                         _ => false,
1489                     })
1490                 });
1491                 if has_lifetime_parameters {
1492                     // complex trait bounds like A<'a, 'b>
1493                     (50 * self.nest, 1)
1494                 } else {
1495                     // simple trait bounds like A + B
1496                     (20 * self.nest, 0)
1497                 }
1498             },
1499
1500             _ => (0, 0),
1501         };
1502         self.score += add_score;
1503         self.nest += sub_nest;
1504         walk_ty(self, ty);
1505         self.nest -= sub_nest;
1506     }
1507     fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'tcx> {
1508         NestedVisitorMap::None
1509     }
1510 }
1511
1512 declare_clippy_lint! {
1513     /// **What it does:** Checks for expressions where a character literal is cast
1514     /// to `u8` and suggests using a byte literal instead.
1515     ///
1516     /// **Why is this bad?** In general, casting values to smaller types is
1517     /// error-prone and should be avoided where possible. In the particular case of
1518     /// converting a character literal to u8, it is easy to avoid by just using a
1519     /// byte literal instead. As an added bonus, `b'a'` is even slightly shorter
1520     /// than `'a' as u8`.
1521     ///
1522     /// **Known problems:** None.
1523     ///
1524     /// **Example:**
1525     /// ```rust,ignore
1526     /// 'x' as u8
1527     /// ```
1528     ///
1529     /// A better version, using the byte literal:
1530     ///
1531     /// ```rust,ignore
1532     /// b'x'
1533     /// ```
1534     pub CHAR_LIT_AS_U8,
1535     complexity,
1536     "casting a character literal to u8 truncates"
1537 }
1538
1539 declare_lint_pass!(CharLitAsU8 => [CHAR_LIT_AS_U8]);
1540
1541 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for CharLitAsU8 {
1542     fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr) {
1543         if_chain! {
1544             if !expr.span.from_expansion();
1545             if let ExprKind::Cast(e, _) = &expr.kind;
1546             if let ExprKind::Lit(l) = &e.kind;
1547             if let LitKind::Char(c) = l.node;
1548             if ty::Uint(UintTy::U8) == cx.tables.expr_ty(expr).kind;
1549             then {
1550                 let mut applicability = Applicability::MachineApplicable;
1551                 let snippet = snippet_with_applicability(cx, e.span, "'x'", &mut applicability);
1552
1553                 span_lint_and_then(
1554                     cx,
1555                     CHAR_LIT_AS_U8,
1556                     expr.span,
1557                     "casting a character literal to `u8` truncates",
1558                     |db| {
1559                         db.note("`char` is four bytes wide, but `u8` is a single byte");
1560
1561                         if c.is_ascii() {
1562                             db.span_suggestion(
1563                                 expr.span,
1564                                 "use a byte literal instead",
1565                                 format!("b{}", snippet),
1566                                 applicability,
1567                             );
1568                         }
1569                 });
1570             }
1571         }
1572     }
1573 }
1574
1575 declare_clippy_lint! {
1576     /// **What it does:** Checks for comparisons where one side of the relation is
1577     /// either the minimum or maximum value for its type and warns if it involves a
1578     /// case that is always true or always false. Only integer and boolean types are
1579     /// checked.
1580     ///
1581     /// **Why is this bad?** An expression like `min <= x` may misleadingly imply
1582     /// that it is possible for `x` to be less than the minimum. Expressions like
1583     /// `max < x` are probably mistakes.
1584     ///
1585     /// **Known problems:** For `usize` the size of the current compile target will
1586     /// be assumed (e.g., 64 bits on 64 bit systems). This means code that uses such
1587     /// a comparison to detect target pointer width will trigger this lint. One can
1588     /// use `mem::sizeof` and compare its value or conditional compilation
1589     /// attributes
1590     /// like `#[cfg(target_pointer_width = "64")] ..` instead.
1591     ///
1592     /// **Example:**
1593     ///
1594     /// ```rust
1595     /// let vec: Vec<isize> = vec![];
1596     /// if vec.len() <= 0 {}
1597     /// if 100 > std::i32::MAX {}
1598     /// ```
1599     pub ABSURD_EXTREME_COMPARISONS,
1600     correctness,
1601     "a comparison with a maximum or minimum value that is always true or false"
1602 }
1603
1604 declare_lint_pass!(AbsurdExtremeComparisons => [ABSURD_EXTREME_COMPARISONS]);
1605
1606 enum ExtremeType {
1607     Minimum,
1608     Maximum,
1609 }
1610
1611 struct ExtremeExpr<'a> {
1612     which: ExtremeType,
1613     expr: &'a Expr,
1614 }
1615
1616 enum AbsurdComparisonResult {
1617     AlwaysFalse,
1618     AlwaysTrue,
1619     InequalityImpossible,
1620 }
1621
1622 fn is_cast_between_fixed_and_target<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr) -> bool {
1623     if let ExprKind::Cast(ref cast_exp, _) = expr.kind {
1624         let precast_ty = cx.tables.expr_ty(cast_exp);
1625         let cast_ty = cx.tables.expr_ty(expr);
1626
1627         return is_isize_or_usize(precast_ty) != is_isize_or_usize(cast_ty);
1628     }
1629
1630     false
1631 }
1632
1633 fn detect_absurd_comparison<'a, 'tcx>(
1634     cx: &LateContext<'a, 'tcx>,
1635     op: BinOpKind,
1636     lhs: &'tcx Expr,
1637     rhs: &'tcx Expr,
1638 ) -> Option<(ExtremeExpr<'tcx>, AbsurdComparisonResult)> {
1639     use crate::types::AbsurdComparisonResult::*;
1640     use crate::types::ExtremeType::*;
1641     use crate::utils::comparisons::*;
1642
1643     // absurd comparison only makes sense on primitive types
1644     // primitive types don't implement comparison operators with each other
1645     if cx.tables.expr_ty(lhs) != cx.tables.expr_ty(rhs) {
1646         return None;
1647     }
1648
1649     // comparisons between fix sized types and target sized types are considered unanalyzable
1650     if is_cast_between_fixed_and_target(cx, lhs) || is_cast_between_fixed_and_target(cx, rhs) {
1651         return None;
1652     }
1653
1654     let normalized = normalize_comparison(op, lhs, rhs);
1655     let (rel, normalized_lhs, normalized_rhs) = if let Some(val) = normalized {
1656         val
1657     } else {
1658         return None;
1659     };
1660
1661     let lx = detect_extreme_expr(cx, normalized_lhs);
1662     let rx = detect_extreme_expr(cx, normalized_rhs);
1663
1664     Some(match rel {
1665         Rel::Lt => {
1666             match (lx, rx) {
1667                 (Some(l @ ExtremeExpr { which: Maximum, .. }), _) => (l, AlwaysFalse), // max < x
1668                 (_, Some(r @ ExtremeExpr { which: Minimum, .. })) => (r, AlwaysFalse), // x < min
1669                 _ => return None,
1670             }
1671         },
1672         Rel::Le => {
1673             match (lx, rx) {
1674                 (Some(l @ ExtremeExpr { which: Minimum, .. }), _) => (l, AlwaysTrue), // min <= x
1675                 (Some(l @ ExtremeExpr { which: Maximum, .. }), _) => (l, InequalityImpossible), // max <= x
1676                 (_, Some(r @ ExtremeExpr { which: Minimum, .. })) => (r, InequalityImpossible), // x <= min
1677                 (_, Some(r @ ExtremeExpr { which: Maximum, .. })) => (r, AlwaysTrue), // x <= max
1678                 _ => return None,
1679             }
1680         },
1681         Rel::Ne | Rel::Eq => return None,
1682     })
1683 }
1684
1685 fn detect_extreme_expr<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr) -> Option<ExtremeExpr<'tcx>> {
1686     use crate::types::ExtremeType::*;
1687
1688     let ty = cx.tables.expr_ty(expr);
1689
1690     let cv = constant(cx, cx.tables, expr)?.0;
1691
1692     let which = match (&ty.kind, cv) {
1693         (&ty::Bool, Constant::Bool(false)) | (&ty::Uint(_), Constant::Int(0)) => Minimum,
1694         (&ty::Int(ity), Constant::Int(i))
1695             if i == unsext(cx.tcx, i128::min_value() >> (128 - int_bits(cx.tcx, ity)), ity) =>
1696         {
1697             Minimum
1698         },
1699
1700         (&ty::Bool, Constant::Bool(true)) => Maximum,
1701         (&ty::Int(ity), Constant::Int(i))
1702             if i == unsext(cx.tcx, i128::max_value() >> (128 - int_bits(cx.tcx, ity)), ity) =>
1703         {
1704             Maximum
1705         },
1706         (&ty::Uint(uty), Constant::Int(i)) if clip(cx.tcx, u128::max_value(), uty) == i => Maximum,
1707
1708         _ => return None,
1709     };
1710     Some(ExtremeExpr { which, expr })
1711 }
1712
1713 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for AbsurdExtremeComparisons {
1714     fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr) {
1715         use crate::types::AbsurdComparisonResult::*;
1716         use crate::types::ExtremeType::*;
1717
1718         if let ExprKind::Binary(ref cmp, ref lhs, ref rhs) = expr.kind {
1719             if let Some((culprit, result)) = detect_absurd_comparison(cx, cmp.node, lhs, rhs) {
1720                 if !expr.span.from_expansion() {
1721                     let msg = "this comparison involving the minimum or maximum element for this \
1722                                type contains a case that is always true or always false";
1723
1724                     let conclusion = match result {
1725                         AlwaysFalse => "this comparison is always false".to_owned(),
1726                         AlwaysTrue => "this comparison is always true".to_owned(),
1727                         InequalityImpossible => format!(
1728                             "the case where the two sides are not equal never occurs, consider using {} == {} \
1729                              instead",
1730                             snippet(cx, lhs.span, "lhs"),
1731                             snippet(cx, rhs.span, "rhs")
1732                         ),
1733                     };
1734
1735                     let help = format!(
1736                         "because {} is the {} value for this type, {}",
1737                         snippet(cx, culprit.expr.span, "x"),
1738                         match culprit.which {
1739                             Minimum => "minimum",
1740                             Maximum => "maximum",
1741                         },
1742                         conclusion
1743                     );
1744
1745                     span_help_and_lint(cx, ABSURD_EXTREME_COMPARISONS, expr.span, msg, &help);
1746                 }
1747             }
1748         }
1749     }
1750 }
1751
1752 declare_clippy_lint! {
1753     /// **What it does:** Checks for comparisons where the relation is always either
1754     /// true or false, but where one side has been upcast so that the comparison is
1755     /// necessary. Only integer types are checked.
1756     ///
1757     /// **Why is this bad?** An expression like `let x : u8 = ...; (x as u32) > 300`
1758     /// will mistakenly imply that it is possible for `x` to be outside the range of
1759     /// `u8`.
1760     ///
1761     /// **Known problems:**
1762     /// https://github.com/rust-lang/rust-clippy/issues/886
1763     ///
1764     /// **Example:**
1765     /// ```rust
1766     /// let x: u8 = 1;
1767     /// (x as u32) > 300;
1768     /// ```
1769     pub INVALID_UPCAST_COMPARISONS,
1770     pedantic,
1771     "a comparison involving an upcast which is always true or false"
1772 }
1773
1774 declare_lint_pass!(InvalidUpcastComparisons => [INVALID_UPCAST_COMPARISONS]);
1775
1776 #[derive(Copy, Clone, Debug, Eq)]
1777 enum FullInt {
1778     S(i128),
1779     U(u128),
1780 }
1781
1782 impl FullInt {
1783     #[allow(clippy::cast_sign_loss)]
1784     #[must_use]
1785     fn cmp_s_u(s: i128, u: u128) -> Ordering {
1786         if s < 0 {
1787             Ordering::Less
1788         } else if u > (i128::max_value() as u128) {
1789             Ordering::Greater
1790         } else {
1791             (s as u128).cmp(&u)
1792         }
1793     }
1794 }
1795
1796 impl PartialEq for FullInt {
1797     #[must_use]
1798     fn eq(&self, other: &Self) -> bool {
1799         self.partial_cmp(other).expect("partial_cmp only returns Some(_)") == Ordering::Equal
1800     }
1801 }
1802
1803 impl PartialOrd for FullInt {
1804     #[must_use]
1805     fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
1806         Some(match (self, other) {
1807             (&Self::S(s), &Self::S(o)) => s.cmp(&o),
1808             (&Self::U(s), &Self::U(o)) => s.cmp(&o),
1809             (&Self::S(s), &Self::U(o)) => Self::cmp_s_u(s, o),
1810             (&Self::U(s), &Self::S(o)) => Self::cmp_s_u(o, s).reverse(),
1811         })
1812     }
1813 }
1814 impl Ord for FullInt {
1815     #[must_use]
1816     fn cmp(&self, other: &Self) -> Ordering {
1817         self.partial_cmp(other)
1818             .expect("partial_cmp for FullInt can never return None")
1819     }
1820 }
1821
1822 fn numeric_cast_precast_bounds<'a>(cx: &LateContext<'_, '_>, expr: &'a Expr) -> Option<(FullInt, FullInt)> {
1823     use std::*;
1824
1825     if let ExprKind::Cast(ref cast_exp, _) = expr.kind {
1826         let pre_cast_ty = cx.tables.expr_ty(cast_exp);
1827         let cast_ty = cx.tables.expr_ty(expr);
1828         // if it's a cast from i32 to u32 wrapping will invalidate all these checks
1829         if cx.layout_of(pre_cast_ty).ok().map(|l| l.size) == cx.layout_of(cast_ty).ok().map(|l| l.size) {
1830             return None;
1831         }
1832         match pre_cast_ty.kind {
1833             ty::Int(int_ty) => Some(match int_ty {
1834                 IntTy::I8 => (
1835                     FullInt::S(i128::from(i8::min_value())),
1836                     FullInt::S(i128::from(i8::max_value())),
1837                 ),
1838                 IntTy::I16 => (
1839                     FullInt::S(i128::from(i16::min_value())),
1840                     FullInt::S(i128::from(i16::max_value())),
1841                 ),
1842                 IntTy::I32 => (
1843                     FullInt::S(i128::from(i32::min_value())),
1844                     FullInt::S(i128::from(i32::max_value())),
1845                 ),
1846                 IntTy::I64 => (
1847                     FullInt::S(i128::from(i64::min_value())),
1848                     FullInt::S(i128::from(i64::max_value())),
1849                 ),
1850                 IntTy::I128 => (FullInt::S(i128::min_value()), FullInt::S(i128::max_value())),
1851                 IntTy::Isize => (
1852                     FullInt::S(isize::min_value() as i128),
1853                     FullInt::S(isize::max_value() as i128),
1854                 ),
1855             }),
1856             ty::Uint(uint_ty) => Some(match uint_ty {
1857                 UintTy::U8 => (
1858                     FullInt::U(u128::from(u8::min_value())),
1859                     FullInt::U(u128::from(u8::max_value())),
1860                 ),
1861                 UintTy::U16 => (
1862                     FullInt::U(u128::from(u16::min_value())),
1863                     FullInt::U(u128::from(u16::max_value())),
1864                 ),
1865                 UintTy::U32 => (
1866                     FullInt::U(u128::from(u32::min_value())),
1867                     FullInt::U(u128::from(u32::max_value())),
1868                 ),
1869                 UintTy::U64 => (
1870                     FullInt::U(u128::from(u64::min_value())),
1871                     FullInt::U(u128::from(u64::max_value())),
1872                 ),
1873                 UintTy::U128 => (FullInt::U(u128::min_value()), FullInt::U(u128::max_value())),
1874                 UintTy::Usize => (
1875                     FullInt::U(usize::min_value() as u128),
1876                     FullInt::U(usize::max_value() as u128),
1877                 ),
1878             }),
1879             _ => None,
1880         }
1881     } else {
1882         None
1883     }
1884 }
1885
1886 fn node_as_const_fullint<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr) -> Option<FullInt> {
1887     let val = constant(cx, cx.tables, expr)?.0;
1888     if let Constant::Int(const_int) = val {
1889         match cx.tables.expr_ty(expr).kind {
1890             ty::Int(ity) => Some(FullInt::S(sext(cx.tcx, const_int, ity))),
1891             ty::Uint(_) => Some(FullInt::U(const_int)),
1892             _ => None,
1893         }
1894     } else {
1895         None
1896     }
1897 }
1898
1899 fn err_upcast_comparison(cx: &LateContext<'_, '_>, span: Span, expr: &Expr, always: bool) {
1900     if let ExprKind::Cast(ref cast_val, _) = expr.kind {
1901         span_lint(
1902             cx,
1903             INVALID_UPCAST_COMPARISONS,
1904             span,
1905             &format!(
1906                 "because of the numeric bounds on `{}` prior to casting, this expression is always {}",
1907                 snippet(cx, cast_val.span, "the expression"),
1908                 if always { "true" } else { "false" },
1909             ),
1910         );
1911     }
1912 }
1913
1914 fn upcast_comparison_bounds_err<'a, 'tcx>(
1915     cx: &LateContext<'a, 'tcx>,
1916     span: Span,
1917     rel: comparisons::Rel,
1918     lhs_bounds: Option<(FullInt, FullInt)>,
1919     lhs: &'tcx Expr,
1920     rhs: &'tcx Expr,
1921     invert: bool,
1922 ) {
1923     use crate::utils::comparisons::*;
1924
1925     if let Some((lb, ub)) = lhs_bounds {
1926         if let Some(norm_rhs_val) = node_as_const_fullint(cx, rhs) {
1927             if rel == Rel::Eq || rel == Rel::Ne {
1928                 if norm_rhs_val < lb || norm_rhs_val > ub {
1929                     err_upcast_comparison(cx, span, lhs, rel == Rel::Ne);
1930                 }
1931             } else if match rel {
1932                 Rel::Lt => {
1933                     if invert {
1934                         norm_rhs_val < lb
1935                     } else {
1936                         ub < norm_rhs_val
1937                     }
1938                 },
1939                 Rel::Le => {
1940                     if invert {
1941                         norm_rhs_val <= lb
1942                     } else {
1943                         ub <= norm_rhs_val
1944                     }
1945                 },
1946                 Rel::Eq | Rel::Ne => unreachable!(),
1947             } {
1948                 err_upcast_comparison(cx, span, lhs, true)
1949             } else if match rel {
1950                 Rel::Lt => {
1951                     if invert {
1952                         norm_rhs_val >= ub
1953                     } else {
1954                         lb >= norm_rhs_val
1955                     }
1956                 },
1957                 Rel::Le => {
1958                     if invert {
1959                         norm_rhs_val > ub
1960                     } else {
1961                         lb > norm_rhs_val
1962                     }
1963                 },
1964                 Rel::Eq | Rel::Ne => unreachable!(),
1965             } {
1966                 err_upcast_comparison(cx, span, lhs, false)
1967             }
1968         }
1969     }
1970 }
1971
1972 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for InvalidUpcastComparisons {
1973     fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr) {
1974         if let ExprKind::Binary(ref cmp, ref lhs, ref rhs) = expr.kind {
1975             let normalized = comparisons::normalize_comparison(cmp.node, lhs, rhs);
1976             let (rel, normalized_lhs, normalized_rhs) = if let Some(val) = normalized {
1977                 val
1978             } else {
1979                 return;
1980             };
1981
1982             let lhs_bounds = numeric_cast_precast_bounds(cx, normalized_lhs);
1983             let rhs_bounds = numeric_cast_precast_bounds(cx, normalized_rhs);
1984
1985             upcast_comparison_bounds_err(cx, expr.span, rel, lhs_bounds, normalized_lhs, normalized_rhs, false);
1986             upcast_comparison_bounds_err(cx, expr.span, rel, rhs_bounds, normalized_rhs, normalized_lhs, true);
1987         }
1988     }
1989 }
1990
1991 declare_clippy_lint! {
1992     /// **What it does:** Checks for public `impl` or `fn` missing generalization
1993     /// over different hashers and implicitly defaulting to the default hashing
1994     /// algorithm (`SipHash`).
1995     ///
1996     /// **Why is this bad?** `HashMap` or `HashSet` with custom hashers cannot be
1997     /// used with them.
1998     ///
1999     /// **Known problems:** Suggestions for replacing constructors can contain
2000     /// false-positives. Also applying suggestions can require modification of other
2001     /// pieces of code, possibly including external crates.
2002     ///
2003     /// **Example:**
2004     /// ```rust
2005     /// # use std::collections::HashMap;
2006     /// # use std::hash::{Hash, BuildHasher};
2007     /// # trait Serialize {};
2008     /// impl<K: Hash + Eq, V> Serialize for HashMap<K, V> { }
2009     ///
2010     /// pub fn foo(map: &mut HashMap<i32, i32>) { }
2011     /// ```
2012     /// could be rewritten as
2013     /// ```rust
2014     /// # use std::collections::HashMap;
2015     /// # use std::hash::{Hash, BuildHasher};
2016     /// # trait Serialize {};
2017     /// impl<K: Hash + Eq, V, S: BuildHasher> Serialize for HashMap<K, V, S> { }
2018     ///
2019     /// pub fn foo<S: BuildHasher>(map: &mut HashMap<i32, i32, S>) { }
2020     /// ```
2021     pub IMPLICIT_HASHER,
2022     style,
2023     "missing generalization over different hashers"
2024 }
2025
2026 declare_lint_pass!(ImplicitHasher => [IMPLICIT_HASHER]);
2027
2028 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for ImplicitHasher {
2029     #[allow(clippy::cast_possible_truncation, clippy::too_many_lines)]
2030     fn check_item(&mut self, cx: &LateContext<'a, 'tcx>, item: &'tcx Item) {
2031         use syntax_pos::BytePos;
2032
2033         fn suggestion<'a, 'tcx>(
2034             cx: &LateContext<'a, 'tcx>,
2035             db: &mut DiagnosticBuilder<'_>,
2036             generics_span: Span,
2037             generics_suggestion_span: Span,
2038             target: &ImplicitHasherType<'_>,
2039             vis: ImplicitHasherConstructorVisitor<'_, '_, '_>,
2040         ) {
2041             let generics_snip = snippet(cx, generics_span, "");
2042             // trim `<` `>`
2043             let generics_snip = if generics_snip.is_empty() {
2044                 ""
2045             } else {
2046                 &generics_snip[1..generics_snip.len() - 1]
2047             };
2048
2049             multispan_sugg(
2050                 db,
2051                 "consider adding a type parameter".to_string(),
2052                 vec![
2053                     (
2054                         generics_suggestion_span,
2055                         format!(
2056                             "<{}{}S: ::std::hash::BuildHasher{}>",
2057                             generics_snip,
2058                             if generics_snip.is_empty() { "" } else { ", " },
2059                             if vis.suggestions.is_empty() {
2060                                 ""
2061                             } else {
2062                                 // request users to add `Default` bound so that generic constructors can be used
2063                                 " + Default"
2064                             },
2065                         ),
2066                     ),
2067                     (
2068                         target.span(),
2069                         format!("{}<{}, S>", target.type_name(), target.type_arguments(),),
2070                     ),
2071                 ],
2072             );
2073
2074             if !vis.suggestions.is_empty() {
2075                 multispan_sugg(db, "...and use generic constructor".into(), vis.suggestions);
2076             }
2077         }
2078
2079         if !cx.access_levels.is_exported(item.hir_id) {
2080             return;
2081         }
2082
2083         match item.kind {
2084             ItemKind::Impl(_, _, _, ref generics, _, ref ty, ref items) => {
2085                 let mut vis = ImplicitHasherTypeVisitor::new(cx);
2086                 vis.visit_ty(ty);
2087
2088                 for target in &vis.found {
2089                     if differing_macro_contexts(item.span, target.span()) {
2090                         return;
2091                     }
2092
2093                     let generics_suggestion_span = generics.span.substitute_dummy({
2094                         let pos = snippet_opt(cx, item.span.until(target.span()))
2095                             .and_then(|snip| Some(item.span.lo() + BytePos(snip.find("impl")? as u32 + 4)));
2096                         if let Some(pos) = pos {
2097                             Span::new(pos, pos, item.span.data().ctxt)
2098                         } else {
2099                             return;
2100                         }
2101                     });
2102
2103                     let mut ctr_vis = ImplicitHasherConstructorVisitor::new(cx, target);
2104                     for item in items.iter().map(|item| cx.tcx.hir().impl_item(item.id)) {
2105                         ctr_vis.visit_impl_item(item);
2106                     }
2107
2108                     span_lint_and_then(
2109                         cx,
2110                         IMPLICIT_HASHER,
2111                         target.span(),
2112                         &format!(
2113                             "impl for `{}` should be generalized over different hashers",
2114                             target.type_name()
2115                         ),
2116                         move |db| {
2117                             suggestion(cx, db, generics.span, generics_suggestion_span, target, ctr_vis);
2118                         },
2119                     );
2120                 }
2121             },
2122             ItemKind::Fn(ref decl, .., ref generics, body_id) => {
2123                 let body = cx.tcx.hir().body(body_id);
2124
2125                 for ty in &decl.inputs {
2126                     let mut vis = ImplicitHasherTypeVisitor::new(cx);
2127                     vis.visit_ty(ty);
2128
2129                     for target in &vis.found {
2130                         if in_external_macro(cx.sess(), generics.span) {
2131                             continue;
2132                         }
2133                         let generics_suggestion_span = generics.span.substitute_dummy({
2134                             let pos = snippet_opt(cx, item.span.until(body.params[0].pat.span))
2135                                 .and_then(|snip| {
2136                                     let i = snip.find("fn")?;
2137                                     Some(item.span.lo() + BytePos((i + (&snip[i..]).find('(')?) as u32))
2138                                 })
2139                                 .expect("failed to create span for type parameters");
2140                             Span::new(pos, pos, item.span.data().ctxt)
2141                         });
2142
2143                         let mut ctr_vis = ImplicitHasherConstructorVisitor::new(cx, target);
2144                         ctr_vis.visit_body(body);
2145
2146                         span_lint_and_then(
2147                             cx,
2148                             IMPLICIT_HASHER,
2149                             target.span(),
2150                             &format!(
2151                                 "parameter of type `{}` should be generalized over different hashers",
2152                                 target.type_name()
2153                             ),
2154                             move |db| {
2155                                 suggestion(cx, db, generics.span, generics_suggestion_span, target, ctr_vis);
2156                             },
2157                         );
2158                     }
2159                 }
2160             },
2161             _ => {},
2162         }
2163     }
2164 }
2165
2166 enum ImplicitHasherType<'tcx> {
2167     HashMap(Span, Ty<'tcx>, Cow<'static, str>, Cow<'static, str>),
2168     HashSet(Span, Ty<'tcx>, Cow<'static, str>),
2169 }
2170
2171 impl<'tcx> ImplicitHasherType<'tcx> {
2172     /// Checks that `ty` is a target type without a `BuildHasher`.
2173     fn new<'a>(cx: &LateContext<'a, 'tcx>, hir_ty: &hir::Ty) -> Option<Self> {
2174         if let TyKind::Path(QPath::Resolved(None, ref path)) = hir_ty.kind {
2175             let params: Vec<_> = path
2176                 .segments
2177                 .last()
2178                 .as_ref()?
2179                 .args
2180                 .as_ref()?
2181                 .args
2182                 .iter()
2183                 .filter_map(|arg| match arg {
2184                     GenericArg::Type(ty) => Some(ty),
2185                     _ => None,
2186                 })
2187                 .collect();
2188             let params_len = params.len();
2189
2190             let ty = hir_ty_to_ty(cx.tcx, hir_ty);
2191
2192             if match_path(path, &paths::HASHMAP) && params_len == 2 {
2193                 Some(ImplicitHasherType::HashMap(
2194                     hir_ty.span,
2195                     ty,
2196                     snippet(cx, params[0].span, "K"),
2197                     snippet(cx, params[1].span, "V"),
2198                 ))
2199             } else if match_path(path, &paths::HASHSET) && params_len == 1 {
2200                 Some(ImplicitHasherType::HashSet(
2201                     hir_ty.span,
2202                     ty,
2203                     snippet(cx, params[0].span, "T"),
2204                 ))
2205             } else {
2206                 None
2207             }
2208         } else {
2209             None
2210         }
2211     }
2212
2213     fn type_name(&self) -> &'static str {
2214         match *self {
2215             ImplicitHasherType::HashMap(..) => "HashMap",
2216             ImplicitHasherType::HashSet(..) => "HashSet",
2217         }
2218     }
2219
2220     fn type_arguments(&self) -> String {
2221         match *self {
2222             ImplicitHasherType::HashMap(.., ref k, ref v) => format!("{}, {}", k, v),
2223             ImplicitHasherType::HashSet(.., ref t) => format!("{}", t),
2224         }
2225     }
2226
2227     fn ty(&self) -> Ty<'tcx> {
2228         match *self {
2229             ImplicitHasherType::HashMap(_, ty, ..) | ImplicitHasherType::HashSet(_, ty, ..) => ty,
2230         }
2231     }
2232
2233     fn span(&self) -> Span {
2234         match *self {
2235             ImplicitHasherType::HashMap(span, ..) | ImplicitHasherType::HashSet(span, ..) => span,
2236         }
2237     }
2238 }
2239
2240 struct ImplicitHasherTypeVisitor<'a, 'tcx> {
2241     cx: &'a LateContext<'a, 'tcx>,
2242     found: Vec<ImplicitHasherType<'tcx>>,
2243 }
2244
2245 impl<'a, 'tcx> ImplicitHasherTypeVisitor<'a, 'tcx> {
2246     fn new(cx: &'a LateContext<'a, 'tcx>) -> Self {
2247         Self { cx, found: vec![] }
2248     }
2249 }
2250
2251 impl<'a, 'tcx> Visitor<'tcx> for ImplicitHasherTypeVisitor<'a, 'tcx> {
2252     fn visit_ty(&mut self, t: &'tcx hir::Ty) {
2253         if let Some(target) = ImplicitHasherType::new(self.cx, t) {
2254             self.found.push(target);
2255         }
2256
2257         walk_ty(self, t);
2258     }
2259
2260     fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'tcx> {
2261         NestedVisitorMap::None
2262     }
2263 }
2264
2265 /// Looks for default-hasher-dependent constructors like `HashMap::new`.
2266 struct ImplicitHasherConstructorVisitor<'a, 'b, 'tcx> {
2267     cx: &'a LateContext<'a, 'tcx>,
2268     body: &'a TypeckTables<'tcx>,
2269     target: &'b ImplicitHasherType<'tcx>,
2270     suggestions: BTreeMap<Span, String>,
2271 }
2272
2273 impl<'a, 'b, 'tcx> ImplicitHasherConstructorVisitor<'a, 'b, 'tcx> {
2274     fn new(cx: &'a LateContext<'a, 'tcx>, target: &'b ImplicitHasherType<'tcx>) -> Self {
2275         Self {
2276             cx,
2277             body: cx.tables,
2278             target,
2279             suggestions: BTreeMap::new(),
2280         }
2281     }
2282 }
2283
2284 impl<'a, 'b, 'tcx> Visitor<'tcx> for ImplicitHasherConstructorVisitor<'a, 'b, 'tcx> {
2285     fn visit_body(&mut self, body: &'tcx Body) {
2286         let prev_body = self.body;
2287         self.body = self.cx.tcx.body_tables(body.id());
2288         walk_body(self, body);
2289         self.body = prev_body;
2290     }
2291
2292     fn visit_expr(&mut self, e: &'tcx Expr) {
2293         if_chain! {
2294             if let ExprKind::Call(ref fun, ref args) = e.kind;
2295             if let ExprKind::Path(QPath::TypeRelative(ref ty, ref method)) = fun.kind;
2296             if let TyKind::Path(QPath::Resolved(None, ref ty_path)) = ty.kind;
2297             then {
2298                 if !same_tys(self.cx, self.target.ty(), self.body.expr_ty(e)) {
2299                     return;
2300                 }
2301
2302                 if match_path(ty_path, &paths::HASHMAP) {
2303                     if method.ident.name == sym!(new) {
2304                         self.suggestions
2305                             .insert(e.span, "HashMap::default()".to_string());
2306                     } else if method.ident.name == sym!(with_capacity) {
2307                         self.suggestions.insert(
2308                             e.span,
2309                             format!(
2310                                 "HashMap::with_capacity_and_hasher({}, Default::default())",
2311                                 snippet(self.cx, args[0].span, "capacity"),
2312                             ),
2313                         );
2314                     }
2315                 } else if match_path(ty_path, &paths::HASHSET) {
2316                     if method.ident.name == sym!(new) {
2317                         self.suggestions
2318                             .insert(e.span, "HashSet::default()".to_string());
2319                     } else if method.ident.name == sym!(with_capacity) {
2320                         self.suggestions.insert(
2321                             e.span,
2322                             format!(
2323                                 "HashSet::with_capacity_and_hasher({}, Default::default())",
2324                                 snippet(self.cx, args[0].span, "capacity"),
2325                             ),
2326                         );
2327                     }
2328                 }
2329             }
2330         }
2331
2332         walk_expr(self, e);
2333     }
2334
2335     fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'tcx> {
2336         NestedVisitorMap::OnlyBodies(&self.cx.tcx.hir())
2337     }
2338 }
2339
2340 declare_clippy_lint! {
2341     /// **What it does:** Checks for casts of `&T` to `&mut T` anywhere in the code.
2342     ///
2343     /// **Why is this bad?** It’s basically guaranteed to be undefined behaviour.
2344     /// `UnsafeCell` is the only way to obtain aliasable data that is considered
2345     /// mutable.
2346     ///
2347     /// **Known problems:** None.
2348     ///
2349     /// **Example:**
2350     /// ```rust,ignore
2351     /// fn x(r: &i32) {
2352     ///     unsafe {
2353     ///         *(r as *const _ as *mut _) += 1;
2354     ///     }
2355     /// }
2356     /// ```
2357     ///
2358     /// Instead consider using interior mutability types.
2359     ///
2360     /// ```rust
2361     /// use std::cell::UnsafeCell;
2362     ///
2363     /// fn x(r: &UnsafeCell<i32>) {
2364     ///     unsafe {
2365     ///         *r.get() += 1;
2366     ///     }
2367     /// }
2368     /// ```
2369     pub CAST_REF_TO_MUT,
2370     correctness,
2371     "a cast of reference to a mutable pointer"
2372 }
2373
2374 declare_lint_pass!(RefToMut => [CAST_REF_TO_MUT]);
2375
2376 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for RefToMut {
2377     fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr) {
2378         if_chain! {
2379             if let ExprKind::Unary(UnOp::UnDeref, e) = &expr.kind;
2380             if let ExprKind::Cast(e, t) = &e.kind;
2381             if let TyKind::Ptr(MutTy { mutbl: Mutability::MutMutable, .. }) = t.kind;
2382             if let ExprKind::Cast(e, t) = &e.kind;
2383             if let TyKind::Ptr(MutTy { mutbl: Mutability::MutImmutable, .. }) = t.kind;
2384             if let ty::Ref(..) = cx.tables.node_type(e.hir_id).kind;
2385             then {
2386                 span_lint(
2387                     cx,
2388                     CAST_REF_TO_MUT,
2389                     expr.span,
2390                     "casting &T to &mut T may cause undefined behaviour, consider instead using an UnsafeCell",
2391                 );
2392             }
2393         }
2394     }
2395 }