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