clippy_lints/src/types.rs

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