clippy_lints/src/types.rs

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