Assert sequence validity on non-thread-safe RefCount manipulations (2)

base/memory/ref_counted.h

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #ifndef BASE_MEMORY_REF_COUNTED_H_
 #define BASE_MEMORY_REF_COUNTED_H_
 
 #include <stddef.h>
 
 #include <cassert>
 #include <iosfwd>
 #include <type_traits>
 
 #include "base/atomic_ref_count.h"
 #include "base/base_export.h"
 #include "base/compiler_specific.h"
 #include "base/logging.h"
 #include "base/macros.h"
+#include "base/sequence_checker.h"
 #include "base/threading/thread_collision_warner.h"
 #include "build/build_config.h"
 
 namespace base {
-
 namespace subtle {
 
 class BASE_EXPORT RefCountedBase {
  public:
   bool HasOneRef() const { return ref_count_ == 1; }
 
  protected:
-  RefCountedBase()
-      : ref_count_(0)
-#if DCHECK_IS_ON()
-        , in_dtor_(false)
-#endif
-  {
-  }
-
-  ~RefCountedBase() {
-#if DCHECK_IS_ON()
-    DCHECK(in_dtor_) << "RefCounted object deleted without calling Release()";
-#endif
-  }
-
+  RefCountedBase();
+  ~RefCountedBase();
 
   void AddRef() const {
+    ++ref_count_;
+
     // TODO(maruel): Add back once it doesn't assert 500 times/sec.
     // Current thread books the critical section "AddRelease"
     // without release it.
     // DFAKE_SCOPED_LOCK_THREAD_LOCKED(add_release_);
 #if DCHECK_IS_ON()
     DCHECK(!in_dtor_);
+    if (ref_count_ >= 2)
+      DCHECK(CalledOnValidSequence());

[gab, 2017/02/16 21:38:47]

I found this whole comparing with "2" confusing (thought it should be 1) until I
realized you're comparing *after add* and *before release*.

I'd prefer this to be the other way around, check w.r.t to 1 and Add() after /
Release() before the check.

[tzik, 2017/02/17 11:36:08]

Done.

 #endif
-    ++ref_count_;
   }
 
   // Returns true if the object should self-delete.
   bool Release() const {
     // TODO(maruel): Add back once it doesn't assert 500 times/sec.
     // Current thread books the critical section "AddRelease"
     // without release it.
     // DFAKE_SCOPED_LOCK_THREAD_LOCKED(add_release_);
 #if DCHECK_IS_ON()
     DCHECK(!in_dtor_);
+    if (ref_count_ >= 2)
+      DCHECK(CalledOnValidSequence());
+    if (ref_count_ == 2)
+      DetachFromSequence();
 #endif
     if (--ref_count_ == 0) {
 #if DCHECK_IS_ON()
       in_dtor_ = true;
 #endif
       return true;
     }
     return false;
   }
 
  private:
+  void DetachFromSequence() const;

[gab, 2017/02/16 21:38:46]

Invoked sequence_checker_.DetachFromSequence() directly and remove the
DetachFromSequence() private method.

[tzik, 2017/02/17 11:36:08]

Done.

+  bool CalledOnValidSequence() const;

[gab, 2017/02/16 21:38:47]

Wrap method itself in DCHECK_IS_ON() since it's already never called outside
those blocks.

[tzik, 2017/02/17 11:36:08]

Done.

+
   mutable size_t ref_count_;

[gab, 2017/02/16 21:38:47]

Tangential cleanup while you're here

= 0;

here and drop initialization list altogether in constructor :)

[tzik, 2017/02/17 11:36:09]

Done.

 #if DCHECK_IS_ON()
-  mutable bool in_dtor_;
+  mutable bool in_dtor_ = false;
+  mutable SequenceChecker sequence_checker_;
 #endif
 
   DFAKE_MUTEX(add_release_);
 
   DISALLOW_COPY_AND_ASSIGN(RefCountedBase);
 };
 
 class BASE_EXPORT RefCountedThreadSafeBase {
  public:
   bool HasOneRef() const;
@@ skipping 11 matching lines @@
   mutable AtomicRefCount ref_count_;
 #if DCHECK_IS_ON()
   mutable bool in_dtor_;
 #endif
 
   DISALLOW_COPY_AND_ASSIGN(RefCountedThreadSafeBase);
 };
 
 }  // namespace subtle
 
+class BASE_EXPORT ScopedAllowCrossThreadRefCountAccess final {

[gab, 2017/02/16 21:38:46]

// See RefCounted class for documentation.

[tzik, 2017/02/17 11:36:08]

Done.

+ public:
+#if DCHECK_IS_ON()
+  ScopedAllowCrossThreadRefCountAccess();
+  ~ScopedAllowCrossThreadRefCountAccess();
+#else
+  ScopedAllowCrossThreadRefCountAccess() {}
+  ~ScopedAllowCrossThreadRefCountAccess() {}
+#endif
+};
+
 //
 // A base class for reference counted classes.  Otherwise, known as a cheap
 // knock-off of WebKit's RefCounted<T> class.  To use this, just extend your
 // class from it like so:
 //
 //   class MyFoo : public base::RefCounted<MyFoo> {
 //    ...
 //    private:
 //     friend class base::RefCounted<MyFoo>;
 //     ~MyFoo();
 //   };
 //
 // You should always make your destructor non-public, to avoid any code deleting
 // the object accidently while there are references to it.
+//
+// The ref count manipulation to RefCounted is NOT thread safe, and has DCHECKs

[gab, 2017/02/16 21:38:47]

rm comma

[tzik, 2017/02/17 11:36:08]

Done.

+// to trap unsafe cross thread usages. A subclass instance of RefCounted can be

[gab, 2017/02/16 21:38:47]

s/usages/usage/

[tzik, 2017/02/17 11:36:08]

Done.

+// passed to the other thread or sequence only when its ref count is 1. If the
+// ref count is more than 1, the ref count checks if it's on the same thread or

[gab, 2017/02/16 21:38:47]

s/checks if it's on the same thread or sequence to the previous ones/verifies
the ref updates are made on the same execution sequence as the previous ones/

[tzik, 2017/02/17 11:36:09]

Done.

+// sequence to the previous ones.

[gab, 2017/02/16 21:38:47]

s/thread or sequence/execution sequence/

[tzik, 2017/02/17 11:36:08]

Done.

+// If you want to temporarily opt-out from the check, use
+// ScopedAllowCrossThreadRefCountAccess to disable the DCHECK.

[gab, 2017/02/16 21:38:47]

For this last paragraph: 

// In rare cases where thread-safety is guaranteed through other means (e.g.
locks or explicit sequencing of calls across execution sequences):
ScopedAllowCrossThreadRefCountAccess can be used to explicitly indicate this and
disable the aforementioned check.

[tzik, 2017/02/17 11:36:09]

Done.

 template <class T>
 class RefCounted : public subtle::RefCountedBase {
  public:
   RefCounted() = default;
 
   void AddRef() const {
     subtle::RefCountedBase::AddRef();
   }
 
   void Release() const {
@@ skipping 321 matching lines @@
 bool operator!=(std::nullptr_t null, const scoped_refptr<T>& rhs) {
   return !operator==(null, rhs);
 }
 
 template <typename T>
 std::ostream& operator<<(std::ostream& out, const scoped_refptr<T>& p) {
   return out << p.get();
 }
 
 #endif  // BASE_MEMORY_REF_COUNTED_H_