[PATCH v5] c++: Implement -Wself-move warning [PR81159]

[Marek Polacek <polacek@redhat.com>]

On Thu, Aug 25, 2022 at 08:52:58PM -0400, Jason Merrill wrote:
> On 8/25/22 17:49, Marek Polacek wrote:
> > On Thu, Aug 25, 2022 at 09:25:43AM -0400, Jason Merrill wrote:
> > > On 8/24/22 17:30, Marek Polacek wrote:
> > > > On Tue, Aug 23, 2022 at 05:27:00PM -0400, Jason Merrill wrote:
> > > > > On 8/23/22 09:39, Marek Polacek wrote:
> > > > > > +  tree arg = CALL_EXPR_ARG (fn, 0);
> > > > > > +  extract_op (arg);
> > > > > > +  if (TREE_CODE (arg) == ADDR_EXPR)
> > > > > > +    arg = TREE_OPERAND (arg, 0);
> > > > > > +  tree type = TREE_TYPE (lhs);
> > > > > > +  lhs = maybe_undo_parenthesized_ref (lhs);
> > > > > > +  STRIP_ANY_LOCATION_WRAPPER (lhs);
> > > > > > +  const bool print_var_p = (DECL_P (lhs)
> > > > > > +			    || REFERENCE_REF_P (lhs)
> > > > > > +			    || TREE_CODE (lhs) == COMPONENT_REF);
> > > > > 
> > > > > Why include REFERENCE_REF_P and COMPONENT_REF?  Reference refs should be
> > > > > stripped before this test, member refs aren't variables.
> > > > 
> > > > I'm checking REFERENCE_REF_P and COMPONENT_REF to say "moving a variable"
> > > > in #1 and #3.  The REFERENCE_REF_P check means that we also say "variable"
> > > > for #2.  Sure, "A variable is introduced by the declaration of a reference
> > > > other than a non-static data member", but I'm not sure if users care about
> > > > that here?
> > > > 
> > > > If I strip REFERENCE_REFs before the check then the result will be the
> > > > same.
> > > 
> > > That's what I was suggesting, yes: Strip the REFERENCE_REF so DECL_P can see
> > > the decl.
> > 
> > Ok, I've added the REFERENCE_REF stripping.  But I've still left the
> > COMPONENT_REF in.  Perhaps we could say "moving a member" to itself for
> > COMPONENT_REFs.  Or just say "moving 'x' of type 'int' to itself" and
> > avoid all of this.  :)
> 
> Sure, that would be simpler.  In any case, we shouldn't call member
> references variables.

Here's the "moving 'x' of type 'int' to itself" version then:

Bootstrapped/regtested on x86_64-pc-linux-gnu, ok for trunk?

-- >8 --
About 5 years ago we got a request to implement -Wself-move, which
warns about useless moves like this:

  int x;
  x = std::move (x);

This patch implements that warning.

	PR c++/81159

gcc/c-family/ChangeLog:

	* c.opt (Wself-move): New option.

gcc/cp/ChangeLog:

	* typeck.cc (maybe_warn_self_move): New.
	(cp_build_modify_expr): Call maybe_warn_self_move.

gcc/ChangeLog:

	* doc/invoke.texi: Document -Wself-move.

gcc/testsuite/ChangeLog:

	* g++.dg/warn/Wself-move1.C: New test.
---
 gcc/c-family/c.opt                      |   4 +
 gcc/cp/typeck.cc                        |  53 +++++++++-
 gcc/doc/invoke.texi                     |  23 ++++-
 gcc/testsuite/g++.dg/warn/Wself-move1.C | 125 ++++++++++++++++++++++++
 4 files changed, 203 insertions(+), 2 deletions(-)
 create mode 100644 gcc/testsuite/g++.dg/warn/Wself-move1.C

diff --git a/gcc/c-family/c.opt b/gcc/c-family/c.opt
index dfdebd596ef..f776efd39d8 100644
--- a/gcc/c-family/c.opt
+++ b/gcc/c-family/c.opt
@@ -1229,6 +1229,10 @@ Wselector
 ObjC ObjC++ Var(warn_selector) Warning
 Warn if a selector has multiple methods.
 
+Wself-move
+C++ ObjC++ Var(warn_self_move) Warning LangEnabledBy(C++ ObjC++, Wall)
+Warn when a value is moved to itself with std::move.
+
 Wsequence-point
 C ObjC C++ ObjC++ Var(warn_sequence_point) Warning LangEnabledBy(C ObjC C++ ObjC++,Wall)
 Warn about possible violations of sequence point rules.
diff --git a/gcc/cp/typeck.cc b/gcc/cp/typeck.cc
index 7fde65adaa4..b99947c10fd 100644
--- a/gcc/cp/typeck.cc
+++ b/gcc/cp/typeck.cc
@@ -8897,7 +8897,56 @@ cp_build_c_cast (location_t loc, tree type, tree expr,
 
   return error_mark_node;
 }
-\f
+
+/* Warn when a value is moved to itself with std::move.  LHS is the target,
+   RHS may be the std::move call, and LOC is the location of the whole
+   assignment.  */
+
+static void
+maybe_warn_self_move (location_t loc, tree lhs, tree rhs)
+{
+  if (!warn_self_move)
+    return;
+
+  /* C++98 doesn't know move.  */
+  if (cxx_dialect < cxx11)
+    return;
+
+  if (processing_template_decl)
+    return;
+
+  if (!REFERENCE_REF_P (rhs)
+      || TREE_CODE (TREE_OPERAND (rhs, 0)) != CALL_EXPR)
+    return;
+  tree fn = TREE_OPERAND (rhs, 0);
+  if (!is_std_move_p (fn))
+    return;
+
+  /* Just a little helper to strip * and various NOPs.  */
+  auto extract_op = [] (tree &op) {
+    STRIP_NOPS (op);
+    while (INDIRECT_REF_P (op))
+      op = TREE_OPERAND (op, 0);
+    op = maybe_undo_parenthesized_ref (op);
+    STRIP_ANY_LOCATION_WRAPPER (op);
+  };
+
+  tree arg = CALL_EXPR_ARG (fn, 0);
+  extract_op (arg);
+  if (TREE_CODE (arg) == ADDR_EXPR)
+    arg = TREE_OPERAND (arg, 0);
+  tree type = TREE_TYPE (lhs);
+  tree orig_lhs = lhs;
+  extract_op (lhs);
+  if (cp_tree_equal (lhs, arg))
+    {
+      auto_diagnostic_group d;
+      if (warning_at (loc, OPT_Wself_move,
+		      "moving %qE of type %qT to itself", orig_lhs, type))
+	inform (loc, "remove %<std::move%> call");
+    }
+}
+
 /* For use from the C common bits.  */
 tree
 build_modify_expr (location_t location,
@@ -9101,6 +9150,8 @@ cp_build_modify_expr (location_t loc, tree lhs, enum tree_code modifycode,
 
       if (modifycode == NOP_EXPR)
 	{
+	  maybe_warn_self_move (loc, lhs, rhs);
+
 	  if (c_dialect_objc ())
 	    {
 	      result = objc_maybe_build_modify_expr (lhs, rhs);
diff --git a/gcc/doc/invoke.texi b/gcc/doc/invoke.texi
index 9ba83a6b1f3..6131bfa7acf 100644
--- a/gcc/doc/invoke.texi
+++ b/gcc/doc/invoke.texi
@@ -264,7 +264,7 @@ in the following sections.
 -Wreorder  -Wregister @gol
 -Wstrict-null-sentinel  -Wno-subobject-linkage  -Wtemplates @gol
 -Wno-non-template-friend  -Wold-style-cast @gol
--Woverloaded-virtual  -Wno-pmf-conversions -Wsign-promo @gol
+-Woverloaded-virtual  -Wno-pmf-conversions -Wself-move -Wsign-promo @gol
 -Wsized-deallocation  -Wsuggest-final-methods @gol
 -Wsuggest-final-types  -Wsuggest-override  @gol
 -Wno-terminate  -Wuseless-cast  -Wno-vexing-parse  @gol
@@ -5838,6 +5838,7 @@ Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
 -Wreorder   @gol
 -Wrestrict   @gol
 -Wreturn-type  @gol
+-Wself-move @r{(only for C++)}  @gol
 -Wsequence-point  @gol
 -Wsign-compare @r{(only in C++)}  @gol
 -Wsizeof-array-div @gol
@@ -6823,6 +6824,26 @@ of a declaration:
 
 This warning is enabled by @option{-Wall}.
 
+@item -Wno-self-move @r{(C++ and Objective-C++ only)}
+@opindex Wself-move
+@opindex Wno-self-move
+This warning warns when a value is moved to itself with @code{std::move}.
+Such a @code{std::move} typically has no effect.
+
+@smallexample
+struct T @{
+@dots{}
+@};
+void fn()
+@{
+  T t;
+  @dots{}
+  t = std::move (t);
+@}
+@end smallexample
+
+This warning is enabled by @option{-Wall}.
+
 @item -Wsequence-point
 @opindex Wsequence-point
 @opindex Wno-sequence-point
diff --git a/gcc/testsuite/g++.dg/warn/Wself-move1.C b/gcc/testsuite/g++.dg/warn/Wself-move1.C
new file mode 100644
index 00000000000..5c9fc92c347
--- /dev/null
+++ b/gcc/testsuite/g++.dg/warn/Wself-move1.C
@@ -0,0 +1,125 @@
+// PR c++/81159
+// { dg-do compile { target c++11 } }
+// { dg-options "-Wself-move" }
+
+// Define std::move.
+namespace std {
+  template<typename _Tp>
+    struct remove_reference
+    { typedef _Tp   type; };
+
+  template<typename _Tp>
+    struct remove_reference<_Tp&>
+    { typedef _Tp   type; };
+
+  template<typename _Tp>
+    struct remove_reference<_Tp&&>
+    { typedef _Tp   type; };
+
+  template<typename _Tp>
+    constexpr typename std::remove_reference<_Tp>::type&&
+    move(_Tp&& __t) noexcept
+    { return static_cast<typename std::remove_reference<_Tp>::type&&>(__t); }
+}
+
+int g;
+
+struct S {
+  int x;
+  S(S&& o) {
+    x = std::move (x); // { dg-warning "moving '\[^\n\r]*S::x' of type .int. to itself" }
+    x = std::move (o.x);
+    o.x = std::move (x);
+    o.x = std::move (o.x); // { dg-warning "moving 'o.S::x' of type .int. to itself" }
+  }
+  void foo (int x) {
+    x = std::move (x); // { dg-warning "moving 'x' of type .int. to itself" }
+  }
+};
+
+struct X {
+  int x;
+  X(int x) : x(std::move (x)) { }
+};
+
+struct A {};
+struct B { A a; };
+struct C { C(); ~C(); };
+struct D { D(); D(const D&); D(D&&); D& operator=(const D&); };
+
+void
+test ()
+{
+  int i = 42;
+  i = std::move (i); // { dg-warning "moving 'i' of type .int. to itself" }
+  (i) = std::move (i); // { dg-warning "moving 'i' of type .int. to itself" }
+
+  g = std::move (g); // { dg-warning "moving 'g' of type .int. to itself" }
+  (g) = std::move (g); // { dg-warning "moving 'g' of type .int. to itself" }
+
+  A a;
+  a = std::move (a); // { dg-warning "moving 'a' of type .A. to itself" }
+  (a) = std::move (a); // { dg-warning "moving 'a' of type .A. to itself" }
+
+  B b;
+  b = std::move (b); // { dg-warning "moving 'b' of type .B. to itself" }
+  (b) = std::move (b); // { dg-warning "moving 'b' of type .B. to itself" }
+  b.a = std::move (b.a); // { dg-warning "moving 'b.B::a' of type .A. to itself" }
+  (b.a) = std::move (b.a); // { dg-warning "moving 'b.B::a' of type .A. to itself" }
+
+  C c;
+  c = std::move (c); // { dg-warning "moving 'c' of type .C. to itself" }
+  D d;
+  d = std::move (d); // { dg-warning "moving 'd' of type .D. to itself" }
+}
+
+template<typename T>
+void ttest ()
+{
+  T t;
+  t = std::move (t); // { dg-warning "moving 't' of type .A. to itself" }
+}
+
+template void ttest<A>();
+
+void
+testref (int &r, int &&rr)
+{
+  r = std::move (r); // { dg-warning "moving 'r' of type .int. to itself" }
+  rr = std::move (rr); // { dg-warning "moving 'rr' of type .int. to itself" }
+}
+
+// Test various other arguments to std::move.
+template<typename T>
+void
+testargs (T *Tptr, T **Tpptr, T& Tref, T&& Trref, const T *Tcptr)
+{
+  Tptr = std::move (Tptr); // { dg-warning "moving 'Tptr' of type 'int\\*' to itself" }
+  *Tptr = std::move (*Tptr); // { dg-warning "moving '\\* Tptr' of type 'int' to itself" }
+  *Tptr = std::move (*(Tptr)); // { dg-warning "moving '\\* Tptr' of type 'int' to itself" }
+  *(Tptr) = std::move (*Tptr); // { dg-warning "moving '\\* Tptr' of type 'int' to itself" }
+  *(Tptr + 1) = std::move (*(Tptr + 1)); // { dg-warning "moving '\[^\n\r]*Tptr\[^\n\r]*' of type 'int' to itself" }
+  *(Tptr + 1) = std::move (*(Tptr + 2));
+  (*(Tptr)) = std::move (*Tptr); // { dg-warning "moving '\\* Tptr' of type 'int' to itself" }
+  *Tpptr = std::move (*Tpptr); // { dg-warning "moving '\\* Tpptr' of type 'int\\*' to itself" }
+  **Tpptr = std::move (**Tpptr); // { dg-warning "moving '\\* \\* Tpptr' of type 'int' to itself" }
+  Tref = std::move (Tref); // { dg-warning "moving 'Tref' of type 'int' to itself" }
+  Trref = std::move (Trref); // { dg-warning "moving 'Trref' of type 'int' to itself" }
+  Tcptr = std::move (Tcptr); // { dg-warning "moving 'Tcptr' of type 'const int\\*' to itself" }
+  (Tptr) = std::move (Tptr); // { dg-warning "moving 'Tptr' of type 'int\\*' to itself" }
+  (*Tptr) = std::move (*Tptr); // { dg-warning "moving '\\* Tptr' of type 'int' to itself" }
+  (*Tpptr) = std::move (*Tpptr); // { dg-warning "moving '\\* Tpptr' of type 'int\\*' to itself" }
+  (**Tpptr) = std::move (**Tpptr); // { dg-warning "moving '\\* \\* Tpptr' of type 'int' to itself" }
+  (*(*(Tpptr))) = std::move (**Tpptr); // { dg-warning "moving '\\* \\* Tpptr' of type 'int' to itself" }
+  (Tref) = std::move (Tref); // { dg-warning "moving 'Tref' of type 'int' to itself" }
+  (Trref) = std::move (Trref); // { dg-warning "moving 'Trref' of type 'int' to itself" }
+  (Tcptr) = std::move (Tcptr); // { dg-warning "moving 'Tcptr' of type 'const int\\*' to itself" }
+}
+
+void
+call_testargs ()
+{
+  int i = 42;
+  int *p = &i;
+  testargs<int>(&i, &p, i, 42, &i);
+}

base-commit: 1e2462890ac748a5e5b6a34fdeb61e7027863a90
-- 
2.37.2