Implicit prefinalizer registration.

third_party/WebKit/Source/platform/heap/ThreadState.h

 /*
  * Copyright (C) 2013 Google Inc. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are
  * met:
  *
  *     * Redistributions of source code must retain the above copyright
  * notice, this list of conditions and the following disclaimer.
  *     * Redistributions in binary form must reproduce the above
@@ skipping 73 matching lines @@
 // HeapHashMap<WeakMember<Foo>, std::unique_ptr<Disposer>> idiom requires an
 // assumption that the HeapHashMap outlives objects pointed by WeakMembers.
 // FIXME: Replace all of the
 // HeapHashMap<WeakMember<Foo>, std::unique_ptr<Disposer>> idiom usages with the
 // pre-finalizer if the replacement won't cause performance regressions.
 //
 // Usage:
 //
 // class Foo : GarbageCollected<Foo> {
 //     USING_PRE_FINALIZER(Foo, dispose);
-// public:
-//     Foo()
-//     {
-//         ThreadState::current()->registerPreFinalizer(this);
-//     }
 // private:
 //     void dispose()
 //     {
 //         m_bar->...; // It is safe to touch other on-heap objects.
 //     }
 //     Member<Bar> m_bar;
 // };
-#define USING_PRE_FINALIZER(Class, preFinalizer)    \
- public:                                            \
-  static bool invokePreFinalizer(void* object) {    \
-    Class* self = reinterpret_cast<Class*>(object); \
-    if (ThreadHeap::isHeapObjectAlive(self))        \
-      return false;                                 \
-    self->Class::preFinalizer();                    \
-    return true;                                    \
-  }                                                 \
+#define USING_PRE_FINALIZER(Class, preFinalizer)                           \
+ public:                                                                   \
+  static bool invokePreFinalizer(void* object) {                           \
+    Class* self = reinterpret_cast<Class*>(object);                        \
+    if (ThreadHeap::isHeapObjectAlive(self))                               \
+      return false;                                                        \
+    self->Class::preFinalizer();                                           \
+    return true;                                                           \
+  }                                                                        \
+                                                                           \
+ private:                                                                  \
+  ThreadState::PrefinalizerRegistration<Class> m_prefinalizerDummy = this; \
   using UsingPreFinalizerMacroNeedsTrailingSemiColon = char
 
 class PLATFORM_EXPORT ThreadState {
   USING_FAST_MALLOC(ThreadState);
   WTF_MAKE_NONCOPYABLE(ThreadState);
 
  public:
   typedef std::pair<void*, PreFinalizerCallback> PreFinalizer;
 
   // See setGCState() for possible state transitions.
@@ skipping 283 matching lines @@
     Vector<size_t> liveSize;
     Vector<size_t> deadSize;
   };
 
   void pushThreadLocalWeakCallback(void*, WeakCallback);
   bool popAndInvokeThreadLocalWeakCallback(Visitor*);
   void threadLocalWeakProcessing();
 
   size_t objectPayloadSizeForTesting();
 
-  // Register the pre-finalizer for the |self| object. This method is normally
-  // called in the constructor of the |self| object. The class T must have
-  // USING_PRE_FINALIZER().
+  // TODO: no longer needed, remove all uses.
   template <typename T>
   void registerPreFinalizer(T* self) {
-    static_assert(sizeof(&T::invokePreFinalizer) > 0,
-                  "USING_PRE_FINALIZER(T) must be defined.");
-    ASSERT(checkThread());
-    ASSERT(!sweepForbidden());
-    ASSERT(!m_orderedPreFinalizers.contains(
-        PreFinalizer(self, T::invokePreFinalizer)));
-    m_orderedPreFinalizers.add(PreFinalizer(self, T::invokePreFinalizer));
-  }
-
-  // Unregister the pre-finalizer for the |self| object.
-  template <typename T>
-  void unregisterPreFinalizer(T* self) {
-    static_assert(sizeof(&T::invokePreFinalizer) > 0,
-                  "USING_PRE_FINALIZER(T) must be defined.");
-    ASSERT(checkThread());
-    // Ignore pre-finalizers called during pre-finalizers or destructors.
-    if (sweepForbidden())
-      return;
-    ASSERT(m_orderedPreFinalizers.contains(
-        PreFinalizer(self, T::invokePreFinalizer)));
-    m_orderedPreFinalizers.remove(PreFinalizer(self, &T::invokePreFinalizer));
   }
 
   void shouldFlushHeapDoesNotContainCache() {
     m_shouldFlushHeapDoesNotContainCache = true;
   }
 
   void registerTraceDOMWrappers(
       v8::Isolate* isolate,
       void (*traceDOMWrappers)(v8::Isolate*, Visitor*),
       void (*invalidateDeadObjectsInWrappersMarkingDeque)(v8::Isolate*),
@@ skipping 104 matching lines @@
   void increaseMarkedObjectSize(size_t);
 
   void callThreadShutdownHooks();
 
   v8::Isolate* isolate() const { return m_isolate; }
 
   void collectGarbage(BlinkGC::StackState, BlinkGC::GCType, BlinkGC::GCReason);
   void collectGarbageForTerminatingThread();
   void collectAllGarbage();
 
+  // Register the pre-finalizer for the |self| object. The class T must have
+  // USING_PRE_FINALIZER().
+  template <typename T>
+  class PrefinalizerRegistration final {
+   public:
+    PrefinalizerRegistration(T* self) {
+      static_assert(sizeof(&T::invokePreFinalizer) > 0,
+                    "USING_PRE_FINALIZER(T) must be defined.");
+      ThreadState* state = ThreadState::current();
+#if ENABLE(ASSERT)
+      DCHECK(state->checkThread());
+#endif
+      DCHECK(!state->sweepForbidden());
+      DCHECK(!state->m_orderedPreFinalizers.contains(
+          PreFinalizer(self, T::invokePreFinalizer)));
+      state->m_orderedPreFinalizers.add(
+          PreFinalizer(self, T::invokePreFinalizer));
+    }
+  };
+
  private:
+  template <typename T>
+  friend class PrefinalizerRegistration;
   enum SnapshotType { HeapSnapshot, FreelistSnapshot };
 
   explicit ThreadState(BlinkGC::ThreadHeapMode);
   ~ThreadState();
 
   NO_SANITIZE_ADDRESS void copyStackUntilSafePointScope();
   void clearSafePointScopeMarker() {
     m_safePointStackCopy.clear();
     m_safePointScopeMarker = nullptr;
   }
@@ skipping 173 matching lines @@
 class ThreadStateFor<AnyThread> {
   STATIC_ONLY(ThreadStateFor);
 
  public:
   static ThreadState* state() { return ThreadState::current(); }
 };
 
 }  // namespace blink
 
 #endif  // ThreadState_h