clippy_lints/src/types.rs

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