clippy_lints/src/types.rs

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