clippy_lints/src/types.rs

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