[LayoutNG] Store fragmented NGPaintFragment as a list

This patch stores fragmented NGPaintFragment as a list linked
from LayoutNGMixin.

The code path doesn't run (break_token is always nullptr) in
phase 1. But without keeping them, virtual/layout_ng_experimental
will crash randomly when CL:1170726 caches NGPaintFragment in
LayoutObject.

Bug: 714962
Cq-Include-Trybots: luci.chromium.try:linux_layout_tests_layout_ng;luci.chromium.try:linux_layout_tests_slimming_paint_v2;master.tryserver.blink:linux_trusty_blink_rel
Change-Id: I6c7e4934dcb366d7dcb39412bf1aac40ebad7429
Reviewed-on: https://chromium-review.googlesource.com/1178081
Commit-Queue: Koji Ishii <kojii@chromium.org>
Reviewed-by: Emil A Eklund <eae@chromium.org>
Cr-Commit-Position: refs/heads/master@{#583980}

third_party/blink/renderer/core/layout/layout_block_flow.cc

@@ -2535,9 +2535,11 @@ void LayoutBlockFlow::SetCachedLayoutResult(const NGConstraintSpace&,
                                             scoped_refptr<NGLayoutResult>) {}
 
 void LayoutBlockFlow::SetPaintFragment(
+    const NGBreakToken*,
     scoped_refptr<const NGPhysicalFragment>) {}
 
 void LayoutBlockFlow::UpdatePaintFragmentFromCachedLayoutResult(
+    const NGBreakToken*,
     scoped_refptr<const NGPhysicalFragment>) {}
 
 void LayoutBlockFlow::ComputeOverflow(LayoutUnit old_client_after_edge,

third_party/blink/renderer/core/layout/layout_block_flow.h

@@ -460,10 +460,11 @@ class CORE_EXPORT LayoutBlockFlow : public LayoutBlock {
                                      NGBreakToken*,
                                      scoped_refptr<NGLayoutResult>);
   virtual void WillCollectInlines() {}
-  virtual void SetPaintFragment(scoped_refptr<const NGPhysicalFragment>);
+  virtual void SetPaintFragment(const NGBreakToken*,
+                                scoped_refptr<const NGPhysicalFragment>);
   virtual void UpdatePaintFragmentFromCachedLayoutResult(
+      const NGBreakToken*,
       scoped_refptr<const NGPhysicalFragment>);
-  virtual void ClearPaintFragment() {}
   virtual const NGPhysicalBoxFragment* CurrentFragment() const {
     return nullptr;
   }

third_party/blink/renderer/core/layout/ng/layout_ng_mixin.cc

@@ -261,30 +261,72 @@ LayoutNGMixin<Base>::CachedLayoutResultForTesting() {
 
 template <typename Base>
 void LayoutNGMixin<Base>::SetPaintFragment(
-    scoped_refptr<const NGPhysicalFragment> fragment) {
-  DCHECK(fragment);
+    NGPaintFragment* last_paint_fragment,
+    std::unique_ptr<NGPaintFragment> paint_fragment) {
+  if (paint_fragment) {
+    // When paint fragment is replaced, the subtree needs paint invalidation to
+    // re-compute paint properties in NGPaintFragment.
+    Base::SetSubtreeShouldDoFullPaintInvalidation();
+  }
 
-  paint_fragment_ = NGPaintFragment::Create(std::move(fragment));
+  if (last_paint_fragment) {
+    last_paint_fragment->SetNext(std::move(paint_fragment));
+  } else {
+    paint_fragment_ = std::move(paint_fragment);
+  }
+}
 
-  // When paint fragment is replaced, the subtree needs paint invalidation to
-  // re-compute paint properties in NGPaintFragment.
-  Base::SetSubtreeShouldDoFullPaintInvalidation();
+template <typename Base>
+void LayoutNGMixin<Base>::SetPaintFragment(
+    const NGBreakToken* break_token,
+    scoped_refptr<const NGPhysicalFragment> fragment) {
+  // TODO(kojii): There are cases where the first call has break_token.
+  // Investigate why and handle appropriately.
+  // DCHECK(!break_token || paint_fragment_);
+  NGPaintFragment* last_paint_fragment = nullptr;
+  if (break_token && paint_fragment_) {
+    last_paint_fragment = paint_fragment_->Last(*break_token);
+    // TODO(kojii): Sometimes an unknown break_token is given. Need to
+    // investigate why, and handle appropriately. For now, just keep it to avoid
+    // crashes and use-after-free.
+    if (!last_paint_fragment)
+      last_paint_fragment = paint_fragment_->Last();
+    DCHECK(last_paint_fragment);
+  }
+  SetPaintFragment(last_paint_fragment,
+                   fragment ? NGPaintFragment::Create(fragment) : nullptr);
 }
 
 template <typename Base>
 void LayoutNGMixin<Base>::UpdatePaintFragmentFromCachedLayoutResult(
+    const NGBreakToken* break_token,
     scoped_refptr<const NGPhysicalFragment> fragment) {
   DCHECK(fragment);
+  // TODO(kojii): There are cases where the first call has break_token.
+  // Investigate why and handle appropriately.
+  // DCHECK(!break_token || paint_fragment_);
+  NGPaintFragment* paint_fragment = nullptr;
+  NGPaintFragment* last_paint_fragment = nullptr;
+  if (!break_token) {
+    paint_fragment = paint_fragment_.get();
+  } else if (paint_fragment_) {
+    last_paint_fragment = paint_fragment_->Last(*break_token);
+    // TODO(kojii): Sometimes an unknown break_token is given. Need to
+    // investigate why, and handle appropriately. For now, just keep it to avoid
+    // crashes and use-after-free.
+    if (!last_paint_fragment)
+      last_paint_fragment = paint_fragment_->Last();
+    DCHECK(last_paint_fragment);
+    paint_fragment = last_paint_fragment->Next();
+  }
 
-  if (!paint_fragment_)
-    return SetPaintFragment(fragment);
-
-  paint_fragment_->UpdatePhysicalFragmentFromCachedLayoutResult(fragment);
-}
+  if (!paint_fragment) {
+    SetPaintFragment(last_paint_fragment,
+                     NGPaintFragment::Create(std::move(fragment)));
+    return;
+  }
 
-template <typename Base>
-void LayoutNGMixin<Base>::ClearPaintFragment() {
-  paint_fragment_ = nullptr;
+  paint_fragment->UpdatePhysicalFragmentFromCachedLayoutResult(fragment);
 }
 
 template <typename Base>

third_party/blink/renderer/core/layout/ng/layout_ng_mixin.h

@@ -70,10 +70,11 @@ class LayoutNGMixin : public Base {
   NGPaintFragment* PaintFragment() const override {
     return paint_fragment_.get();
   }
-  void SetPaintFragment(scoped_refptr<const NGPhysicalFragment>) final;
+  void SetPaintFragment(const NGBreakToken*,
+                        scoped_refptr<const NGPhysicalFragment>) final;
   void UpdatePaintFragmentFromCachedLayoutResult(
+      const NGBreakToken*,
       scoped_refptr<const NGPhysicalFragment>) final;
-  void ClearPaintFragment() final;
 
  protected:
   bool IsOfType(LayoutObject::LayoutObjectType) const override;
@@ -82,6 +83,8 @@ class LayoutNGMixin : public Base {
 
  private:
   void AddScrollingOverflowFromChildren();
+  void SetPaintFragment(NGPaintFragment* last_paint_fragment,
+                        std::unique_ptr<NGPaintFragment>);
 
  protected:
   void AddOutlineRects(

third_party/blink/renderer/core/layout/ng/ng_block_node.cc

@@ -218,7 +218,7 @@ scoped_refptr<NGLayoutResult> NGBlockNode::Layout(
       if (!constraint_space.IsIntermediateLayout() && first_child &&
           first_child.IsInline()) {
         block_flow->UpdatePaintFragmentFromCachedLayoutResult(
-            layout_result->PhysicalFragment());
+            break_token, layout_result->PhysicalFragment());
       }
       return layout_result;
     }
@@ -261,7 +261,7 @@ scoped_refptr<NGLayoutResult> NGBlockNode::Layout(
                                       layout_result);
     if (layout_result->Status() == NGLayoutResult::kSuccess &&
         !constraint_space.IsIntermediateLayout())
-      block_flow->ClearPaintFragment();
+      block_flow->SetPaintFragment(break_token, nullptr);
   }
 
   if (IsBlockLayoutComplete(constraint_space, *layout_result)) {
@@ -275,7 +275,8 @@ scoped_refptr<NGLayoutResult> NGBlockNode::Layout(
               scrollbars.block_start,
           Style().IsFlippedBlocksWritingMode());
 
-      block_flow->SetPaintFragment(layout_result->PhysicalFragment());
+      block_flow->SetPaintFragment(break_token,
+                                   layout_result->PhysicalFragment());
     }
 
     // TODO(kojii): Even when we paint fragments, there seem to be some data we

third_party/blink/renderer/core/paint/ng/ng_paint_fragment.cc

@@ -196,6 +196,28 @@ void NGPaintFragment::UpdatePhysicalFragmentFromCachedLayoutResult(
   physical_fragment_ = fragment;
 }
 
+NGPaintFragment* NGPaintFragment::Last(const NGBreakToken& break_token) {
+  for (NGPaintFragment* fragment = this; fragment;
+       fragment = fragment->next_fragmented_.get()) {
+    if (fragment->PhysicalFragment().BreakToken() == &break_token)
+      return fragment;
+  }
+  return nullptr;
+}
+
+NGPaintFragment* NGPaintFragment::Last() {
+  for (NGPaintFragment* fragment = this;;) {
+    NGPaintFragment* next = fragment->next_fragmented_.get();
+    if (!next)
+      return fragment;
+    fragment = next;
+  }
+}
+
+void NGPaintFragment::SetNext(std::unique_ptr<NGPaintFragment> fragment) {
+  next_fragmented_ = std::move(fragment);
+}
+
 bool NGPaintFragment::IsDescendantOfNotSelf(
     const NGPaintFragment& ancestor) const {
   for (const NGPaintFragment* fragment = Parent(); fragment;

third_party/blink/renderer/core/paint/ng/ng_paint_fragment.h

@@ -49,6 +49,12 @@ class CORE_EXPORT NGPaintFragment : public DisplayItemClient,
   void UpdatePhysicalFragmentFromCachedLayoutResult(
       scoped_refptr<const NGPhysicalFragment>);
 
+  // Next/last fragment for  when this is fragmented.
+  NGPaintFragment* Next() { return next_fragmented_.get(); }
+  void SetNext(std::unique_ptr<NGPaintFragment>);
+  NGPaintFragment* Last();
+  NGPaintFragment* Last(const NGBreakToken&);
+
   // The parent NGPaintFragment. This is nullptr for a root; i.e., when parent
   // is not for NGPaint. In the first phase, this means that this is a root of
   // an inline formatting context.
@@ -237,6 +243,9 @@ class CORE_EXPORT NGPaintFragment : public DisplayItemClient,
   NGPaintFragment* parent_;
   Vector<std::unique_ptr<NGPaintFragment>> children_;
 
+  // The next fragment for when this is fragmented.
+  std::unique_ptr<NGPaintFragment> next_fragmented_;
+
   NGPaintFragment* next_fragment_ = nullptr;
   NGPhysicalOffset inline_offset_to_container_box_;