Attribute Stuff to Frames with FrameBlamer

third_party/WebKit/Source/core/frame/LocalFrame.h

 /*
  * Copyright (C) 1998, 1999 Torben Weis <weis@kde.org>
  *                     1999-2001 Lars Knoll <knoll@kde.org>
  *                     1999-2001 Antti Koivisto <koivisto@kde.org>
  *                     2000-2001 Simon Hausmann <hausmann@kde.org>
  *                     2000-2001 Dirk Mueller <mueller@kde.org>
  *                     2000 Stefan Schimanski <1Stein@gmx.de>
  * Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010 Apple Inc. All rights reserved.
  * Copyright (C) 2008 Nokia Corporation and/or its subsidiary(-ies)
  * Copyright (C) 2008 Eric Seidel <eric@webkit.org>
@@ skipping 22 matching lines @@
 #include "core/frame/Frame.h"
 #include "core/frame/LocalFrameLifecycleNotifier.h"
 #include "core/frame/LocalFrameLifecycleObserver.h"
 #include "core/loader/FrameLoader.h"
 #include "core/page/FrameTree.h"
 #include "core/paint/PaintPhase.h"
 #include "platform/Supplementable.h"
 #include "platform/graphics/ImageOrientation.h"
 #include "platform/heap/Handle.h"
 #include "platform/scroll/ScrollTypes.h"
+#include "public/platform/BlameContext.h"
 #include "wtf/HashSet.h"
 
 namespace blink {
 
 class Color;
 class Document;
 class DragImage;
 class Editor;
 template <typename Traversal> class EditingAlgorithm;
 class Element;
@@ skipping 254 matching lines @@
     WTF_MAKE_NONCOPYABLE(FrameNavigationDisabler);
     STACK_ALLOCATED();
 public:
     explicit FrameNavigationDisabler(LocalFrame&);
     ~FrameNavigationDisabler();
 
 private:
     Member<LocalFrame> m_frame;
 };
 
+class ScopedFrameBlamer {

[tkent, 2016/06/01 23:14:56]

Please add a comment that what this class does concretely.
I couldn't guess what's "FrameBlamer" without reading the design doc.

[Xiaocheng, 2016/06/02 03:17:19]

Done.

+    WTF_MAKE_NONCOPYABLE(ScopedFrameBlamer);
+    STACK_ALLOCATED();
+public:
+    explicit ScopedFrameBlamer(LocalFrame*);

[Sami, 2016/06/01 11:05:17]

Could the parameter be const?

[Xiaocheng, 2016/06/02 03:17:19]

Yes. Done.

+    ~ScopedFrameBlamer();
+
+private:
+    BlameContext* m_frameBlameContext;

[tkent, 2016/06/01 23:14:56]

Is it safe to hold a raw pointer? Can the BlameContext object die during a
ScopedFrameBlamer is alive?

[Xiaocheng, 2016/06/02 03:17:19]

FrameBlameContext (the BlameContext subclass for frames) objects are created and
owned (*) by content::RenderFrameImpls. I guess a RenderFrameImpl won't get
deleted as long as the corresponding LocalFrame is alive, right?

So it seems that we need to make sure |frame| is alive during the lifetime of a
ScopedFrameBlamer, which means we need to store |frame| as a
|Member<LocalFrame>| here. But the overhead maybe be too big since
ScopedFrameBlamer is supposed to be a helper class for tracing that may appear
anywhere.

(*) In the current implementation, FrameBlameContext objects never get deleted.
It's a memory leak that needs to be fixed. It also means we don't need to worry
about the lifetime of |m_frameBlameContext| before the fix...

+};
+
 } // namespace blink
 
 #endif // LocalFrame_h