diff mbox series

relax -Wclass-memaccess for class members (PR 84850)

Message ID 896452a4-b727-5e50-1a26-2647b5713aea@gmail.com
State New
Headers show
Series relax -Wclass-memaccess for class members (PR 84850) | expand

Commit Message

Martin Sebor March 20, 2018, 2:06 a.m. UTC
The -Wclass-memaccess warning makes an exception for ctors and
dtors of non-trivial classes with no bases to avoid triggering
for uses of raw memory functions with this as the destination.
All other members as well as non-members trigger the warning.

In bug 84850 the reporter shows that some code (squid in this
case) calls memset(this, 0. ...) in both the copy assignment
operator and the copy ctor as a short-hand to clear all trivial
members without having to explicitly enumerate them.  A similar
idiom has been seen in Firefox (some of the bugs linked from
https://bugzilla.mozilla.org/show_bug.cgi?id=1411029).

Since calling memset(this, 0, sizeof *this) from any non-static
member of a non-trivial class containing no non-trivial members
is safe, the attached patch relaxes the warning to allow this
idiom.

I also noticed that the exemption for ctors and dtors is overly
permissive and causes the warning not to trigger for classes with
no bases or virtual functions but containing non-trivial members.
This is bug 84851.  Jakub suggested to fix just 84850 for GCC 8
and defer 84851 to GCC 9, so the patch follows that suggestion.
Fixing the latter is a matter of removing the block in
warn_for_restrict() with the FIXME comment above it.

Martin

Comments

Jason Merrill March 20, 2018, 9:52 p.m. UTC | #1
OK.

On Mon, Mar 19, 2018 at 10:06 PM, Martin Sebor <msebor@gmail.com> wrote:
> The -Wclass-memaccess warning makes an exception for ctors and
> dtors of non-trivial classes with no bases to avoid triggering
> for uses of raw memory functions with this as the destination.
> All other members as well as non-members trigger the warning.
>
> In bug 84850 the reporter shows that some code (squid in this
> case) calls memset(this, 0. ...) in both the copy assignment
> operator and the copy ctor as a short-hand to clear all trivial
> members without having to explicitly enumerate them.  A similar
> idiom has been seen in Firefox (some of the bugs linked from
> https://bugzilla.mozilla.org/show_bug.cgi?id=1411029).
>
> Since calling memset(this, 0, sizeof *this) from any non-static
> member of a non-trivial class containing no non-trivial members
> is safe, the attached patch relaxes the warning to allow this
> idiom.
>
> I also noticed that the exemption for ctors and dtors is overly
> permissive and causes the warning not to trigger for classes with
> no bases or virtual functions but containing non-trivial members.
> This is bug 84851.  Jakub suggested to fix just 84850 for GCC 8
> and defer 84851 to GCC 9, so the patch follows that suggestion.
> Fixing the latter is a matter of removing the block in
> warn_for_restrict() with the FIXME comment above it.
>
> Martin
diff mbox series

Patch

PR c++/84850 - -Wclass-memaccess on a memcpy in a copy assignment operator with no nontrivial bases or members

gcc/cp/ChangeLog:

	PR c++/84850
	* call.c (first_non_public_field): New template and function.
	(first_non_trivial_field): New function.
	(maybe_warn_class_memaccess): Call them.

gcc/testsuite/ChangeLog:

	PR c++/84850
	* g++.dg/Wclass-memaccess-3.C: New test.
	* g++.dg/Wclass-memaccess-4.C: New test.

Index: gcc/cp/call.c
===================================================================
--- gcc/cp/call.c	(revision 258646)
+++ gcc/cp/call.c	(working copy)
@@ -8261,13 +8261,17 @@  build_over_call (struct z_candidate *cand, int fla
   return call;
 }
 
-/* Return the DECL of the first non-public data member of class TYPE
-   or null if none can be found.  */
+namespace
+{
 
-static tree
-first_non_public_field (tree type)
+/* Return the DECL of the first non-static subobject of class TYPE
+   that satisfies the predicate PRED or null if none can be found.  */
+
+template <class Predicate>
+tree
+first_non_static_field (tree type, Predicate pred)
 {
-  if (!CLASS_TYPE_P (type))
+  if (!type || !CLASS_TYPE_P (type))
     return NULL_TREE;
 
   for (tree field = TYPE_FIELDS (type); field; field = DECL_CHAIN (field))
@@ -8276,7 +8280,7 @@  build_over_call (struct z_candidate *cand, int fla
 	continue;
       if (TREE_STATIC (field))
 	continue;
-      if (TREE_PRIVATE (field) || TREE_PROTECTED (field))
+      if (pred (field))
 	return field;
     }
 
@@ -8286,8 +8290,9 @@  build_over_call (struct z_candidate *cand, int fla
        BINFO_BASE_ITERATE (binfo, i, base_binfo); i++)
     {
       tree base = TREE_TYPE (base_binfo);
-
-      if (tree field = first_non_public_field (base))
+      if (pred (base))
+	return base;
+      if (tree field = first_non_static_field (base, pred))
 	return field;
     }
 
@@ -8294,6 +8299,42 @@  build_over_call (struct z_candidate *cand, int fla
   return NULL_TREE;
 }
 
+struct NonPublicField
+{
+  bool operator() (const_tree t)
+  {
+    return DECL_P (t) && (TREE_PRIVATE (t) || TREE_PROTECTED (t));
+  }
+};
+
+/* Return the DECL of the first non-public subobject of class TYPE
+   or null if none can be found.  */
+
+static inline tree
+first_non_public_field (tree type)
+{
+  return first_non_static_field (type, NonPublicField ());
+}
+
+struct NonTrivialField
+{
+  bool operator() (const_tree t)
+  {
+    return !trivial_type_p (DECL_P (t) ? TREE_TYPE (t) : t);
+  }
+};
+
+/* Return the DECL of the first non-trivial subobject of class TYPE
+   or null if none can be found.  */
+
+static inline tree
+first_non_trivial_field (tree type)
+{
+  return first_non_static_field (type, NonTrivialField ());
+}
+
+}   /* unnamed namespace */
+
 /* Return true if all copy and move assignment operator overloads for
    class TYPE are trivial and at least one of them is not deleted and,
    when ACCESS is set, accessible.  Return false otherwise.  Set
@@ -8419,23 +8460,31 @@  maybe_warn_class_memaccess (location_t loc, tree f
   if (!desttype || !COMPLETE_TYPE_P (desttype) || !CLASS_TYPE_P (desttype))
     return;
 
-  /* Check to see if the raw memory call is made by a ctor or dtor
-     with this as the destination argument for the destination type.
-     If so, be more permissive.  */
+  /* Check to see if the raw memory call is made by a non-static member
+     function with THIS as the destination argument for the destination
+     type.  If so, and if the class has no non-trivial bases or members,
+     be more permissive.  */
   if (current_function_decl
-      && (DECL_CONSTRUCTOR_P (current_function_decl)
-	  || DECL_DESTRUCTOR_P (current_function_decl))
+      && DECL_NONSTATIC_MEMBER_FUNCTION_P (current_function_decl)
       && is_this_parameter (tree_strip_nop_conversions (dest)))
     {
       tree ctx = DECL_CONTEXT (current_function_decl);
       bool special = same_type_ignoring_top_level_qualifiers_p (ctx, desttype);
-
       tree binfo = TYPE_BINFO (ctx);
 
-      /* A ctor and dtor for a class with no bases and no virtual functions
-	 can do whatever they want.  Bail early with no further checking.  */
-      if (special && !BINFO_VTABLE (binfo) && !BINFO_N_BASE_BINFOS (binfo))
+      /* FIXME: The following if statement is overly permissive (see
+	 bug 84851).  Remove it in GCC 9.  */
+      if (special
+	  && !BINFO_VTABLE (binfo)
+	  && !BINFO_N_BASE_BINFOS (binfo)
+	  && (DECL_CONSTRUCTOR_P (current_function_decl)
+	      || DECL_DESTRUCTOR_P (current_function_decl)))
 	return;
+
+      if (special
+	  && !BINFO_VTABLE (binfo)
+	  && !first_non_trivial_field (desttype))
+	return;
     }
 
   /* True if the class is trivial.  */
Index: gcc/testsuite/g++.dg/Wclass-memaccess-3.C
===================================================================
--- gcc/testsuite/g++.dg/Wclass-memaccess-3.C	(nonexistent)
+++ gcc/testsuite/g++.dg/Wclass-memaccess-3.C	(working copy)
@@ -0,0 +1,287 @@ 
+/* PR c++/84850 - -Wclass-memaccess on a memcpy in a copy assignment
+   operator with no nontrivial bases or members
+   { dg-do compile }
+   { dg-options "-Wclass-memaccess -ftrack-macro-expansion=0" } */
+
+typedef __SIZE_TYPE__ size_t;
+
+extern "C" void* memcpy (void*, const void*, size_t);
+extern "C" void* memset (void*, int, size_t);
+
+template <int>
+struct EmptyClass { };
+
+template <int>
+struct TrivialClass
+{
+  bool a;
+  int b;
+  void *c;
+  double d[2];
+  void (*e)();
+};
+
+template <int>
+struct HasDefault
+{
+  HasDefault ();
+};
+
+/* Verify that raw memory accesses from non-static members of a class with
+   an empty base is not diagnosed.  */
+
+struct EmptyWithBase: EmptyClass<0>, EmptyClass<1>, EmptyClass<2>
+{
+  EmptyWithBase ()
+  {
+    memset (this, 0, sizeof *this);
+  }
+
+  EmptyWithBase (const EmptyWithBase &x)
+  {
+    memcpy (this, &x, sizeof *this);
+  }
+
+  ~EmptyWithBase ()
+  {
+    memset (this, 0, sizeof *this);
+  }
+
+  void operator= (const EmptyWithBase &x)
+  {
+    memcpy (this, &x, sizeof *this);
+  }
+
+  void clear ()
+  {
+    memset (this, 0, sizeof *this);   // { dg-bogus "\\\[-Wclass-memaccess" }
+  }
+
+  void copy (const void *p)
+  {
+    memcpy (this, p, sizeof *this);   // { dg-bogus "\\\[-Wclass-memaccess" }
+  }
+
+  static void bad_clear (EmptyWithBase &x)
+  {
+    memset (&x, 0, sizeof x);         // { dg-warning "\\\[-Wclass-memaccess" }
+  }
+
+  static void bad_copy (EmptyWithBase &x, const void *p)
+  {
+    memcpy (&x, p, sizeof x);         // { dg-warning "\\\[-Wclass-memaccess" }
+  }
+};
+
+/* Verify that raw memory accesses from non-static members of a class with
+   all trivial members is not diagnosed.  */
+
+struct HasTrivialMembers
+{
+  bool a;
+  int b;
+  void *c;
+  double d[2];
+  void (*e)();
+
+  TrivialClass<1> trivial;
+
+  HasTrivialMembers ()
+  {
+    memset (this, 0, sizeof *this);
+  }
+
+  HasTrivialMembers (const HasTrivialMembers &x)
+  {
+    memcpy (this, &x, sizeof *this);
+  }
+
+  ~HasTrivialMembers ()
+  {
+    memset (this, 0, sizeof *this);
+  }
+
+  void operator= (const HasTrivialMembers &x)
+  {
+    memcpy (this, &x, sizeof *this);
+  }
+
+  void clear ()
+  {
+    memset (this, 0, sizeof *this);   // { dg-bogus "\\\[-Wclass-memaccess" }
+  }
+
+  void copy (const void *p)
+  {
+    memcpy (this, p, sizeof *this);   // { dg-bogus "\\\[-Wclass-memaccess" }
+  }
+
+  static void bad_clear (HasTrivialMembers &x)
+  {
+    memset (&x, 0, sizeof x);         // { dg-warning "\\\[-Wclass-memaccess" }
+  }
+
+  static void bad_copy (HasTrivialMembers &x, const void *p)
+  {
+    memcpy (&x, p, sizeof x);         // { dg-warning "\\\[-Wclass-memaccess" }
+  }
+};
+
+/* Verify that raw memory accesses from non-static members of a class with
+   a trivial base class and no non-trivial members is not diagnosed.  */
+
+struct HasTrivialBase: TrivialClass<1>
+{
+  TrivialClass<2> a[2];
+
+  HasTrivialBase ()
+  {
+    memset (this, 0, sizeof *this);   // { dg-bogus "\\\[-Wclass-memaccess" }
+  }
+
+  HasTrivialBase (const HasTrivialBase &x)
+  {
+    memcpy (this, &x, sizeof *this);  // { dg-bogus "\\\[-Wclass-memaccess" }
+  }
+
+  ~HasTrivialBase ()
+  {
+    memset (this, 0, sizeof *this);   // { dg-bogus "\\\[-Wclass-memaccess" }
+  }
+
+  void operator= (const HasTrivialBase &x)
+  {
+    memcpy (this, &x, sizeof *this);
+  }
+
+  void clear ()
+  {
+    memset (this, 0, sizeof *this);   // { dg-bogus "\\\[-Wclass-memaccess" }
+  }
+
+  void copy (void *p)
+  {
+    memcpy (this, p, sizeof *this);   // { dg-bogus "\\\[-Wclass-memaccess" }
+  }
+};
+
+
+struct HasTrivialBases: TrivialClass<1>, TrivialClass<2>
+{
+  TrivialClass<3> a[2];
+
+  HasTrivialBases ()
+  {
+    memset (this, 0, sizeof *this);   // { dg-bogus "\\\[-Wclass-memaccess" }
+  }
+
+  HasTrivialBases (const HasTrivialBases &x)
+  {
+    memcpy (this, &x, sizeof *this);  // { dg-bogus "\\\[-Wclass-memaccess" }
+  }
+
+  ~HasTrivialBases ()
+  {
+    memset (this, 0, sizeof *this);   // { dg-bogus "\\\[-Wclass-memaccess" }
+  }
+
+  void operator= (const HasTrivialBases &x)
+  {
+    memcpy (this, &x, sizeof *this);
+  }
+
+  void clear ()
+  {
+    memset (this, 0, sizeof *this);   // { dg-bogus "\\\[-Wclass-memaccess" }
+  }
+
+  void copy (void *p)
+  {
+    memcpy (this, p, sizeof *this);   // { dg-bogus "\\\[-Wclass-memaccess" }
+  }
+};
+
+struct DerivesFromNontrivialClass: HasDefault<1> { };
+
+/* Verify that raw memory accesses from members of a class with a non-trivial
+   base class is diagnosed.  */
+
+struct HasNonTrivialBase: TrivialClass<1>, TrivialClass<2>,
+			  DerivesFromNontrivialClass,
+			  TrivialClass<3>, TrivialClass<4>
+{
+  HasNonTrivialBase ()
+  {
+    memset (this, 0, sizeof *this);   // { dg-warning "\\\[-Wclass-memaccess" }
+  }
+
+  HasNonTrivialBase (const HasNonTrivialBase &x)
+  {
+    memcpy (this, &x, sizeof *this);  // { dg-warning "\\\[-Wclass-memaccess" }
+  }
+
+  ~HasNonTrivialBase ()
+  {
+    memset (this, 0, sizeof *this);   // { dg-warning "\\\[-Wclass-memaccess" }
+  }
+
+  HasNonTrivialBase& operator= (const HasNonTrivialBase &x)
+  {
+    memcpy (this, &x, sizeof *this);  // { dg-warning "\\\[-Wclass-memaccess" }
+    return *this;
+  }
+
+  void clear ()
+  {
+    memset (this, 0, sizeof *this);   // { dg-warning "\\\[-Wclass-memaccess" }
+  }
+
+  void copy (void *p)
+  {
+    memcpy (this, p, sizeof *this);   // { dg-warning "\\\[-Wclass-memaccess" }
+  }
+};
+
+struct DerivesIndidirectlyFromNontrivialClass:
+  TrivialClass<1>, TrivialClass<2>,
+  DerivesFromNontrivialClass,
+  TrivialClass<3>, TrivialClass<4> { };
+
+/* Verify that raw memory accesses from members of a class with a non-trivial
+   indirect base class is diagnosed.  */
+
+struct HasIndirectNonTrivialBase: TrivialClass<5>, TrivialClass<6>,
+				  TrivialClass<7>, TrivialClass<8>,
+				  DerivesIndidirectlyFromNontrivialClass
+{
+  HasIndirectNonTrivialBase ()
+  {
+    memset (this, 0, sizeof *this);   // { dg-warning "\\\[-Wclass-memaccess" }
+  }
+
+  HasIndirectNonTrivialBase (const HasIndirectNonTrivialBase &x)
+  {
+    memcpy (this, &x, sizeof *this);  // { dg-warning "\\\[-Wclass-memaccess" }
+  }
+
+  ~HasIndirectNonTrivialBase ()
+  {
+    memset (this, 0, sizeof *this);   // { dg-warning "\\\[-Wclass-memaccess" }
+  }
+
+  HasIndirectNonTrivialBase& operator= (const HasIndirectNonTrivialBase &x)
+  {
+    memcpy (this, &x, sizeof *this);  // { dg-warning "\\\[-Wclass-memaccess" }
+    return *this;
+  }
+
+  void clear ()
+  {
+    memset (this, 0, sizeof *this);   // { dg-warning "\\\[-Wclass-memaccess" }
+  }
+
+  void copy (void *p)
+  {
+    memcpy (this, p, sizeof *this);   // { dg-warning "\\\[-Wclass-memaccess" }
+  }
+};
Index: gcc/testsuite/g++.dg/Wclass-memaccess-4.C
===================================================================
--- gcc/testsuite/g++.dg/Wclass-memaccess-4.C	(nonexistent)
+++ gcc/testsuite/g++.dg/Wclass-memaccess-4.C	(working copy)
@@ -0,0 +1,39 @@ 
+/* PR c++/84850 - missing -Wclass-memaccess for a memcpy in a copy ctor
+   with a non-trivial member
+   { dg-do compile }
+   { dg-options "-Wclass-memaccess -ftrack-macro-expansion=0" } */
+
+typedef __SIZE_TYPE__ size_t;
+
+extern "C" void* memcpy (void*, const void*, size_t);
+
+struct A
+{
+  const int &r;
+
+  A ();
+
+  A (const A&);
+
+  virtual ~A ();
+};
+
+struct C
+{
+  A a;
+
+  C (const C&);
+
+  C& operator= (const C&);
+};
+
+C::C (const C &c)
+{
+  memcpy (this, &c, sizeof c);    // { dg-warning "\\\[-Wclass-memaccess]" "pr84851" { xfail *-*-*} }
+}
+
+C& C::operator= (const C &c)
+{
+  memcpy (this, &c, sizeof c);    // { dg-warning "\\\[-Wclass-memaccess]" }
+  return *this;
+}