clippy_lints/src/types.rs

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