1 use clippy_utils::diagnostics::{span_lint_and_help, span_lint_and_sugg, span_lint_and_then};
2 use clippy_utils::source::{snippet, snippet_with_applicability};
3 use clippy_utils::{in_macro, is_diag_trait_item, is_lang_ctor, match_def_path, meets_msrv, msrvs, paths};
4 use if_chain::if_chain;
5 use rustc_errors::Applicability;
6 use rustc_hir::def_id::DefId;
7 use rustc_hir::LangItem::OptionNone;
8 use rustc_hir::{BorrowKind, Expr, ExprKind, Mutability, QPath};
9 use rustc_lint::{LateContext, LateLintPass, LintContext};
10 use rustc_middle::lint::in_external_macro;
11 use rustc_semver::RustcVersion;
12 use rustc_session::{declare_tool_lint, impl_lint_pass};
13 use rustc_span::source_map::Span;
14 use rustc_span::symbol::sym;
16 declare_clippy_lint! {
17 /// **What it does:** Checks for `mem::replace()` on an `Option` with
20 /// **Why is this bad?** `Option` already has the method `take()` for
21 /// taking its current value (Some(..) or None) and replacing it with
24 /// **Known problems:** None.
30 /// let mut an_option = Some(0);
31 /// let replaced = mem::replace(&mut an_option, None);
33 /// Is better expressed with:
35 /// let mut an_option = Some(0);
36 /// let taken = an_option.take();
38 pub MEM_REPLACE_OPTION_WITH_NONE,
40 "replacing an `Option` with `None` instead of `take()`"
43 declare_clippy_lint! {
44 /// **What it does:** Checks for `mem::replace(&mut _, mem::uninitialized())`
45 /// and `mem::replace(&mut _, mem::zeroed())`.
47 /// **Why is this bad?** This will lead to undefined behavior even if the
48 /// value is overwritten later, because the uninitialized value may be
49 /// observed in the case of a panic.
51 /// **Known problems:** None.
57 ///# fn may_panic(v: Vec<i32>) -> Vec<i32> { v }
59 /// #[allow(deprecated, invalid_value)]
60 /// fn myfunc (v: &mut Vec<i32>) {
61 /// let taken_v = unsafe { mem::replace(v, mem::uninitialized()) };
62 /// let new_v = may_panic(taken_v); // undefined behavior on panic
63 /// mem::forget(mem::replace(v, new_v));
67 /// The [take_mut](https://docs.rs/take_mut) crate offers a sound solution,
68 /// at the cost of either lazily creating a replacement value or aborting
69 /// on panic, to ensure that the uninitialized value cannot be observed.
70 pub MEM_REPLACE_WITH_UNINIT,
72 "`mem::replace(&mut _, mem::uninitialized())` or `mem::replace(&mut _, mem::zeroed())`"
75 declare_clippy_lint! {
76 /// **What it does:** Checks for `std::mem::replace` on a value of type
77 /// `T` with `T::default()`.
79 /// **Why is this bad?** `std::mem` module already has the method `take` to
80 /// take the current value and replace it with the default value of that type.
82 /// **Known problems:** None.
86 /// let mut text = String::from("foo");
87 /// let replaced = std::mem::replace(&mut text, String::default());
89 /// Is better expressed with:
91 /// let mut text = String::from("foo");
92 /// let taken = std::mem::take(&mut text);
94 pub MEM_REPLACE_WITH_DEFAULT,
96 "replacing a value of type `T` with `T::default()` instead of using `std::mem::take`"
99 impl_lint_pass!(MemReplace =>
100 [MEM_REPLACE_OPTION_WITH_NONE, MEM_REPLACE_WITH_UNINIT, MEM_REPLACE_WITH_DEFAULT]);
102 fn check_replace_option_with_none(cx: &LateContext<'_>, src: &Expr<'_>, dest: &Expr<'_>, expr_span: Span) {
103 if let ExprKind::Path(ref replacement_qpath) = src.kind {
104 // Check that second argument is `Option::None`
105 if is_lang_ctor(cx, replacement_qpath, OptionNone) {
106 // Since this is a late pass (already type-checked),
107 // and we already know that the second argument is an
108 // `Option`, we do not need to check the first
109 // argument's type. All that's left is to get
111 let replaced_path = match dest.kind {
112 ExprKind::AddrOf(BorrowKind::Ref, Mutability::Mut, replaced) => {
113 if let ExprKind::Path(QPath::Resolved(None, replaced_path)) = replaced.kind {
119 ExprKind::Path(QPath::Resolved(None, replaced_path)) => replaced_path,
123 let mut applicability = Applicability::MachineApplicable;
126 MEM_REPLACE_OPTION_WITH_NONE,
128 "replacing an `Option` with `None`",
129 "consider `Option::take()` instead",
132 snippet_with_applicability(cx, replaced_path.span, "", &mut applicability)
140 fn check_replace_with_uninit(cx: &LateContext<'_>, src: &Expr<'_>, dest: &Expr<'_>, expr_span: Span) {
142 // check if replacement is mem::MaybeUninit::uninit().assume_init()
143 if let Some(method_def_id) = cx.typeck_results().type_dependent_def_id(src.hir_id);
144 if cx.tcx.is_diagnostic_item(sym::assume_init, method_def_id);
146 let mut applicability = Applicability::MachineApplicable;
149 MEM_REPLACE_WITH_UNINIT,
151 "replacing with `mem::MaybeUninit::uninit().assume_init()`",
154 "std::ptr::read({})",
155 snippet_with_applicability(cx, dest.span, "", &mut applicability)
164 if let ExprKind::Call(repl_func, repl_args) = src.kind;
165 if repl_args.is_empty();
166 if let ExprKind::Path(ref repl_func_qpath) = repl_func.kind;
167 if let Some(repl_def_id) = cx.qpath_res(repl_func_qpath, repl_func.hir_id).opt_def_id();
169 if cx.tcx.is_diagnostic_item(sym::mem_uninitialized, repl_def_id) {
170 let mut applicability = Applicability::MachineApplicable;
173 MEM_REPLACE_WITH_UNINIT,
175 "replacing with `mem::uninitialized()`",
178 "std::ptr::read({})",
179 snippet_with_applicability(cx, dest.span, "", &mut applicability)
183 } else if cx.tcx.is_diagnostic_item(sym::mem_zeroed, repl_def_id) &&
184 !cx.typeck_results().expr_ty(src).is_primitive() {
187 MEM_REPLACE_WITH_UNINIT,
189 "replacing with `mem::zeroed()`",
191 "consider using a default value or the `take_mut` crate instead",
198 /// Returns true if the `def_id` associated with the `path` is recognized as a "default-equivalent"
199 /// constructor from the std library
200 fn is_default_equivalent_ctor(cx: &LateContext<'_>, def_id: DefId, path: &QPath<'_>) -> bool {
201 let std_types_symbols = &[
213 if let QPath::TypeRelative(_, method) = path {
214 if method.ident.name == sym::new {
215 if let Some(impl_did) = cx.tcx.impl_of_method(def_id) {
216 if let Some(adt) = cx.tcx.type_of(impl_did).ty_adt_def() {
217 return std_types_symbols
219 .any(|&symbol| cx.tcx.is_diagnostic_item(symbol, adt.did));
227 fn check_replace_with_default(cx: &LateContext<'_>, src: &Expr<'_>, dest: &Expr<'_>, expr_span: Span) {
229 if let ExprKind::Call(repl_func, _) = src.kind;
230 if !in_external_macro(cx.tcx.sess, expr_span);
231 if let ExprKind::Path(ref repl_func_qpath) = repl_func.kind;
232 if let Some(repl_def_id) = cx.qpath_res(repl_func_qpath, repl_func.hir_id).opt_def_id();
233 if is_diag_trait_item(cx, repl_def_id, sym::Default)
234 || is_default_equivalent_ctor(cx, repl_def_id, repl_func_qpath);
239 MEM_REPLACE_WITH_DEFAULT,
241 "replacing a value of type `T` with `T::default()` is better expressed using `std::mem::take`",
243 if !in_macro(expr_span) {
244 let suggestion = format!("std::mem::take({})", snippet(cx, dest.span, ""));
246 diag.span_suggestion(
250 Applicability::MachineApplicable
259 pub struct MemReplace {
260 msrv: Option<RustcVersion>,
265 pub fn new(msrv: Option<RustcVersion>) -> Self {
270 impl<'tcx> LateLintPass<'tcx> for MemReplace {
271 fn check_expr(&mut self, cx: &LateContext<'tcx>, expr: &'tcx Expr<'_>) {
273 // Check that `expr` is a call to `mem::replace()`
274 if let ExprKind::Call(func, func_args) = expr.kind;
275 if let ExprKind::Path(ref func_qpath) = func.kind;
276 if let Some(def_id) = cx.qpath_res(func_qpath, func.hir_id).opt_def_id();
277 if match_def_path(cx, def_id, &paths::MEM_REPLACE);
278 if let [dest, src] = func_args;
280 check_replace_option_with_none(cx, src, dest, expr.span);
281 check_replace_with_uninit(cx, src, dest, expr.span);
282 if meets_msrv(self.msrv.as_ref(), &msrvs::MEM_TAKE) {
283 check_replace_with_default(cx, src, dest, expr.span);
288 extract_msrv_attr!(LateContext);