clippy_lints/src/types.rs

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