src/tools/clippy/clippy_lints/src/ptr.rs

   1 //! Checks for usage of  `&Vec[_]` and `&String`.
   2
   3 use clippy_utils::diagnostics::{span_lint, span_lint_and_sugg, span_lint_and_then};
   4 use clippy_utils::ptr::get_spans;
   5 use clippy_utils::source::snippet_opt;
   6 use clippy_utils::ty::{is_type_diagnostic_item, match_type, walk_ptrs_hir_ty};
   7 use clippy_utils::{expr_path_res, is_lint_allowed, match_any_diagnostic_items, paths};
   8 use if_chain::if_chain;
   9 use rustc_errors::Applicability;
  10 use rustc_hir::{
  11     BinOpKind, BodyId, Expr, ExprKind, FnDecl, FnRetTy, GenericArg, HirId, Impl, ImplItem, ImplItemKind, Item,
  12     ItemKind, Lifetime, MutTy, Mutability, Node, PathSegment, QPath, TraitFn, TraitItem, TraitItemKind, Ty, TyKind,
  13 };
  14 use rustc_lint::{LateContext, LateLintPass};
  15 use rustc_middle::ty;
  16 use rustc_session::{declare_lint_pass, declare_tool_lint};
  17 use rustc_span::source_map::Span;
  18 use rustc_span::symbol::Symbol;
  19 use rustc_span::{sym, MultiSpan};
  20 use std::borrow::Cow;
  21
  22 declare_clippy_lint! {
  23     /// ### What it does
  24     /// This lint checks for function arguments of type `&String`
  25     /// or `&Vec` unless the references are mutable. It will also suggest you
  26     /// replace `.clone()` calls with the appropriate `.to_owned()`/`to_string()`
  27     /// calls.
  28     ///
  29     /// ### Why is this bad?
  30     /// Requiring the argument to be of the specific size
  31     /// makes the function less useful for no benefit; slices in the form of `&[T]`
  32     /// or `&str` usually suffice and can be obtained from other types, too.
  33     ///
  34     /// ### Known problems
  35     /// The lint does not follow data. So if you have an
  36     /// argument `x` and write `let y = x; y.clone()` the lint will not suggest
  37     /// changing that `.clone()` to `.to_owned()`.
  38     ///
  39     /// Other functions called from this function taking a `&String` or `&Vec`
  40     /// argument may also fail to compile if you change the argument. Applying
  41     /// this lint on them will fix the problem, but they may be in other crates.
  42     ///
  43     /// One notable example of a function that may cause issues, and which cannot
  44     /// easily be changed due to being in the standard library is `Vec::contains`.
  45     /// when called on a `Vec<Vec<T>>`. If a `&Vec` is passed to that method then
  46     /// it will compile, but if a `&[T]` is passed then it will not compile.
  47     ///
  48     /// ```ignore
  49     /// fn cannot_take_a_slice(v: &Vec<u8>) -> bool {
  50     ///     let vec_of_vecs: Vec<Vec<u8>> = some_other_fn();
  51     ///
  52     ///     vec_of_vecs.contains(v)
  53     /// }
  54     /// ```
  55     ///
  56     /// Also there may be `fn(&Vec)`-typed references pointing to your function.
  57     /// If you have them, you will get a compiler error after applying this lint's
  58     /// suggestions. You then have the choice to undo your changes or change the
  59     /// type of the reference.
  60     ///
  61     /// Note that if the function is part of your public interface, there may be
  62     /// other crates referencing it, of which you may not be aware. Carefully
  63     /// deprecate the function before applying the lint suggestions in this case.
  64     ///
  65     /// ### Example
  66     /// ```ignore
  67     /// // Bad
  68     /// fn foo(&Vec<u32>) { .. }
  69     ///
  70     /// // Good
  71     /// fn foo(&[u32]) { .. }
  72     /// ```
  73     pub PTR_ARG,
  74     style,
  75     "fn arguments of the type `&Vec<...>` or `&String`, suggesting to use `&[...]` or `&str` instead, respectively"
  76 }
  77
  78 declare_clippy_lint! {
  79     /// ### What it does
  80     /// This lint checks for equality comparisons with `ptr::null`
  81     ///
  82     /// ### Why is this bad?
  83     /// It's easier and more readable to use the inherent
  84     /// `.is_null()`
  85     /// method instead
  86     ///
  87     /// ### Example
  88     /// ```ignore
  89     /// // Bad
  90     /// if x == ptr::null {
  91     ///     ..
  92     /// }
  93     ///
  94     /// // Good
  95     /// if x.is_null() {
  96     ///     ..
  97     /// }
  98     /// ```
  99     pub CMP_NULL,
 100     style,
 101     "comparing a pointer to a null pointer, suggesting to use `.is_null()` instead"
 102 }
 103
 104 declare_clippy_lint! {
 105     /// ### What it does
 106     /// This lint checks for functions that take immutable
 107     /// references and return mutable ones.
 108     ///
 109     /// ### Why is this bad?
 110     /// This is trivially unsound, as one can create two
 111     /// mutable references from the same (immutable!) source.
 112     /// This [error](https://github.com/rust-lang/rust/issues/39465)
 113     /// actually lead to an interim Rust release 1.15.1.
 114     ///
 115     /// ### Known problems
 116     /// To be on the conservative side, if there's at least one
 117     /// mutable reference with the output lifetime, this lint will not trigger.
 118     /// In practice, this case is unlikely anyway.
 119     ///
 120     /// ### Example
 121     /// ```ignore
 122     /// fn foo(&Foo) -> &mut Bar { .. }
 123     /// ```
 124     pub MUT_FROM_REF,
 125     correctness,
 126     "fns that create mutable refs from immutable ref args"
 127 }
 128
 129 declare_clippy_lint! {
 130     /// ### What it does
 131     /// This lint checks for invalid usages of `ptr::null`.
 132     ///
 133     /// ### Why is this bad?
 134     /// This causes undefined behavior.
 135     ///
 136     /// ### Example
 137     /// ```ignore
 138     /// // Bad. Undefined behavior
 139     /// unsafe { std::slice::from_raw_parts(ptr::null(), 0); }
 140     /// ```
 141     ///
 142     /// // Good
 143     /// unsafe { std::slice::from_raw_parts(NonNull::dangling().as_ptr(), 0); }
 144     /// ```
 145     pub INVALID_NULL_PTR_USAGE,
 146     correctness,
 147     "invalid usage of a null pointer, suggesting `NonNull::dangling()` instead"
 148 }
 149
 150 declare_lint_pass!(Ptr => [PTR_ARG, CMP_NULL, MUT_FROM_REF, INVALID_NULL_PTR_USAGE]);
 151
 152 impl<'tcx> LateLintPass<'tcx> for Ptr {
 153     fn check_item(&mut self, cx: &LateContext<'tcx>, item: &'tcx Item<'_>) {
 154         if let ItemKind::Fn(ref sig, _, body_id) = item.kind {
 155             check_fn(cx, sig.decl, item.hir_id(), Some(body_id));
 156         }
 157     }
 158
 159     fn check_impl_item(&mut self, cx: &LateContext<'tcx>, item: &'tcx ImplItem<'_>) {
 160         if let ImplItemKind::Fn(ref sig, body_id) = item.kind {
 161             let parent_item = cx.tcx.hir().get_parent_item(item.hir_id());
 162             if let Some(Node::Item(it)) = cx.tcx.hir().find(parent_item) {
 163                 if let ItemKind::Impl(Impl { of_trait: Some(_), .. }) = it.kind {
 164                     return; // ignore trait impls
 165                 }
 166             }
 167             check_fn(cx, sig.decl, item.hir_id(), Some(body_id));
 168         }
 169     }
 170
 171     fn check_trait_item(&mut self, cx: &LateContext<'tcx>, item: &'tcx TraitItem<'_>) {
 172         if let TraitItemKind::Fn(ref sig, ref trait_method) = item.kind {
 173             let body_id = if let TraitFn::Provided(b) = *trait_method {
 174                 Some(b)
 175             } else {
 176                 None
 177             };
 178             check_fn(cx, sig.decl, item.hir_id(), body_id);
 179         }
 180     }
 181
 182     fn check_expr(&mut self, cx: &LateContext<'tcx>, expr: &'tcx Expr<'_>) {
 183         if let ExprKind::Binary(ref op, l, r) = expr.kind {
 184             if (op.node == BinOpKind::Eq || op.node == BinOpKind::Ne) && (is_null_path(cx, l) || is_null_path(cx, r)) {
 185                 span_lint(
 186                     cx,
 187                     CMP_NULL,
 188                     expr.span,
 189                     "comparing with null is better expressed by the `.is_null()` method",
 190                 );
 191             }
 192         } else {
 193             check_invalid_ptr_usage(cx, expr);
 194         }
 195     }
 196 }
 197
 198 fn check_invalid_ptr_usage<'tcx>(cx: &LateContext<'tcx>, expr: &'tcx Expr<'_>) {
 199     // (fn_path, arg_indices) - `arg_indices` are the `arg` positions where null would cause U.B.
 200     const INVALID_NULL_PTR_USAGE_TABLE: [(&[&str], &[usize]); 16] = [
 201         (&paths::SLICE_FROM_RAW_PARTS, &[0]),
 202         (&paths::SLICE_FROM_RAW_PARTS_MUT, &[0]),
 203         (&paths::PTR_COPY, &[0, 1]),
 204         (&paths::PTR_COPY_NONOVERLAPPING, &[0, 1]),
 205         (&paths::PTR_READ, &[0]),
 206         (&paths::PTR_READ_UNALIGNED, &[0]),
 207         (&paths::PTR_READ_VOLATILE, &[0]),
 208         (&paths::PTR_REPLACE, &[0]),
 209         (&paths::PTR_SLICE_FROM_RAW_PARTS, &[0]),
 210         (&paths::PTR_SLICE_FROM_RAW_PARTS_MUT, &[0]),
 211         (&paths::PTR_SWAP, &[0, 1]),
 212         (&paths::PTR_SWAP_NONOVERLAPPING, &[0, 1]),
 213         (&paths::PTR_WRITE, &[0]),
 214         (&paths::PTR_WRITE_UNALIGNED, &[0]),
 215         (&paths::PTR_WRITE_VOLATILE, &[0]),
 216         (&paths::PTR_WRITE_BYTES, &[0]),
 217     ];
 218
 219     if_chain! {
 220         if let ExprKind::Call(fun, args) = expr.kind;
 221         if let ExprKind::Path(ref qpath) = fun.kind;
 222         if let Some(fun_def_id) = cx.qpath_res(qpath, fun.hir_id).opt_def_id();
 223         let fun_def_path = cx.get_def_path(fun_def_id).into_iter().map(Symbol::to_ident_string).collect::<Vec<_>>();
 224         if let Some(&(_, arg_indices)) = INVALID_NULL_PTR_USAGE_TABLE
 225             .iter()
 226             .find(|&&(fn_path, _)| fn_path == fun_def_path);
 227         then {
 228             for &arg_idx in arg_indices {
 229                 if let Some(arg) = args.get(arg_idx).filter(|arg| is_null_path(cx, arg)) {
 230                     span_lint_and_sugg(
 231                         cx,
 232                         INVALID_NULL_PTR_USAGE,
 233                         arg.span,
 234                         "pointer must be non-null",
 235                         "change this to",
 236                         "core::ptr::NonNull::dangling().as_ptr()".to_string(),
 237                         Applicability::MachineApplicable,
 238                     );
 239                 }
 240             }
 241         }
 242     }
 243 }
 244
 245 #[allow(clippy::too_many_lines)]
 246 fn check_fn(cx: &LateContext<'_>, decl: &FnDecl<'_>, fn_id: HirId, opt_body_id: Option<BodyId>) {
 247     let fn_def_id = cx.tcx.hir().local_def_id(fn_id);
 248     let sig = cx.tcx.fn_sig(fn_def_id);
 249     let fn_ty = sig.skip_binder();
 250     let body = opt_body_id.map(|id| cx.tcx.hir().body(id));
 251
 252     for (idx, (arg, ty)) in decl.inputs.iter().zip(fn_ty.inputs()).enumerate() {
 253         // Honor the allow attribute on parameters. See issue 5644.
 254         if let Some(body) = &body {
 255             if is_lint_allowed(cx, PTR_ARG, body.params[idx].hir_id) {
 256                 continue;
 257             }
 258         }
 259
 260         if let ty::Ref(_, ty, Mutability::Not) = ty.kind() {
 261             if is_type_diagnostic_item(cx, ty, sym::vec_type) {
 262                 if let Some(spans) = get_spans(cx, opt_body_id, idx, &[("clone", ".to_owned()")]) {
 263                     span_lint_and_then(
 264                         cx,
 265                         PTR_ARG,
 266                         arg.span,
 267                         "writing `&Vec<_>` instead of `&[_]` involves one more reference and cannot be used \
 268                          with non-Vec-based slices",
 269                         |diag| {
 270                             if let Some(ref snippet) = get_only_generic_arg_snippet(cx, arg) {
 271                                 diag.span_suggestion(
 272                                     arg.span,
 273                                     "change this to",
 274                                     format!("&[{}]", snippet),
 275                                     Applicability::Unspecified,
 276                                 );
 277                             }
 278                             for (clonespan, suggestion) in spans {
 279                                 diag.span_suggestion(
 280                                     clonespan,
 281                                     &snippet_opt(cx, clonespan).map_or("change the call to".into(), |x| {
 282                                         Cow::Owned(format!("change `{}` to", x))
 283                                     }),
 284                                     suggestion.into(),
 285                                     Applicability::Unspecified,
 286                                 );
 287                             }
 288                         },
 289                     );
 290                 }
 291             } else if is_type_diagnostic_item(cx, ty, sym::string_type) {
 292                 if let Some(spans) = get_spans(cx, opt_body_id, idx, &[("clone", ".to_string()"), ("as_str", "")]) {
 293                     span_lint_and_then(
 294                         cx,
 295                         PTR_ARG,
 296                         arg.span,
 297                         "writing `&String` instead of `&str` involves a new object where a slice will do",
 298                         |diag| {
 299                             diag.span_suggestion(arg.span, "change this to", "&str".into(), Applicability::Unspecified);
 300                             for (clonespan, suggestion) in spans {
 301                                 diag.span_suggestion_short(
 302                                     clonespan,
 303                                     &snippet_opt(cx, clonespan).map_or("change the call to".into(), |x| {
 304                                         Cow::Owned(format!("change `{}` to", x))
 305                                     }),
 306                                     suggestion.into(),
 307                                     Applicability::Unspecified,
 308                                 );
 309                             }
 310                         },
 311                     );
 312                 }
 313             } else if is_type_diagnostic_item(cx, ty, sym::PathBuf) {
 314                 if let Some(spans) = get_spans(cx, opt_body_id, idx, &[("clone", ".to_path_buf()"), ("as_path", "")]) {
 315                     span_lint_and_then(
 316                         cx,
 317                         PTR_ARG,
 318                         arg.span,
 319                         "writing `&PathBuf` instead of `&Path` involves a new object where a slice will do",
 320                         |diag| {
 321                             diag.span_suggestion(
 322                                 arg.span,
 323                                 "change this to",
 324                                 "&Path".into(),
 325                                 Applicability::Unspecified,
 326                             );
 327                             for (clonespan, suggestion) in spans {
 328                                 diag.span_suggestion_short(
 329                                     clonespan,
 330                                     &snippet_opt(cx, clonespan).map_or("change the call to".into(), |x| {
 331                                         Cow::Owned(format!("change `{}` to", x))
 332                                     }),
 333                                     suggestion.into(),
 334                                     Applicability::Unspecified,
 335                                 );
 336                             }
 337                         },
 338                     );
 339                 }
 340             } else if match_type(cx, ty, &paths::COW) {
 341                 if_chain! {
 342                     if let TyKind::Rptr(_, MutTy { ty, ..} ) = arg.kind;
 343                     if let TyKind::Path(QPath::Resolved(None, pp)) = ty.kind;
 344                     if let [ref bx] = *pp.segments;
 345                     if let Some(params) = bx.args;
 346                     if !params.parenthesized;
 347                     if let Some(inner) = params.args.iter().find_map(|arg| match arg {
 348                         GenericArg::Type(ty) => Some(ty),
 349                         _ => None,
 350                     });
 351                     let replacement = snippet_opt(cx, inner.span);
 352                     if let Some(r) = replacement;
 353                     then {
 354                         span_lint_and_sugg(
 355                             cx,
 356                             PTR_ARG,
 357                             arg.span,
 358                             "using a reference to `Cow` is not recommended",
 359                             "change this to",
 360                             "&".to_owned() + &r,
 361                             Applicability::Unspecified,
 362                         );
 363                     }
 364                 }
 365             }
 366         }
 367     }
 368
 369     if let FnRetTy::Return(ty) = decl.output {
 370         if let Some((out, Mutability::Mut, _)) = get_rptr_lm(ty) {
 371             let mut immutables = vec![];
 372             for (_, ref mutbl, ref argspan) in decl
 373                 .inputs
 374                 .iter()
 375                 .filter_map(|ty| get_rptr_lm(ty))
 376                 .filter(|&(lt, _, _)| lt.name == out.name)
 377             {
 378                 if *mutbl == Mutability::Mut {
 379                     return;
 380                 }
 381                 immutables.push(*argspan);
 382             }
 383             if immutables.is_empty() {
 384                 return;
 385             }
 386             span_lint_and_then(
 387                 cx,
 388                 MUT_FROM_REF,
 389                 ty.span,
 390                 "mutable borrow from immutable input(s)",
 391                 |diag| {
 392                     let ms = MultiSpan::from_spans(immutables);
 393                     diag.span_note(ms, "immutable borrow here");
 394                 },
 395             );
 396         }
 397     }
 398 }
 399
 400 fn get_only_generic_arg_snippet(cx: &LateContext<'_>, arg: &Ty<'_>) -> Option<String> {
 401     if_chain! {
 402         if let TyKind::Path(QPath::Resolved(_, path)) = walk_ptrs_hir_ty(arg).kind;
 403         if let Some(&PathSegment{args: Some(parameters), ..}) = path.segments.last();
 404         let types: Vec<_> = parameters.args.iter().filter_map(|arg| match arg {
 405             GenericArg::Type(ty) => Some(ty),
 406             _ => None,
 407         }).collect();
 408         if types.len() == 1;
 409         then {
 410             snippet_opt(cx, types[0].span)
 411         } else {
 412             None
 413         }
 414     }
 415 }
 416
 417 fn get_rptr_lm<'tcx>(ty: &'tcx Ty<'tcx>) -> Option<(&'tcx Lifetime, Mutability, Span)> {
 418     if let TyKind::Rptr(ref lt, ref m) = ty.kind {
 419         Some((lt, m.mutbl, ty.span))
 420     } else {
 421         None
 422     }
 423 }
 424
 425 fn is_null_path(cx: &LateContext<'_>, expr: &Expr<'_>) -> bool {
 426     if let ExprKind::Call(pathexp, []) = expr.kind {
 427         expr_path_res(cx, pathexp).opt_def_id().map_or(false, |id| {
 428             match_any_diagnostic_items(cx, id, &[sym::ptr_null, sym::ptr_null_mut]).is_some()
 429         })
 430     } else {
 431         false
 432     }
 433 }