Track client debug names for raster invalidation tracking

third_party/WebKit/Source/platform/graphics/paint/PaintController.cpp

 // Copyright 2014 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.
 
 #include "platform/graphics/paint/PaintController.h"
 
 #include "platform/graphics/GraphicsLayer.h"
 #include "platform/graphics/paint/DrawingDisplayItem.h"
 #include "platform/instrumentation/tracing/TraceEvent.h"
 #include "platform/wtf/AutoReset.h"
 #include "platform/wtf/text/StringBuilder.h"
 #include "third_party/skia/include/core/SkPictureAnalyzer.h"
 
 #ifndef NDEBUG
 #include "platform/graphics/LoggingCanvas.h"
 #include <stdio.h>
 #endif
 
 static constexpr int kMaxNumberOfSlowPathsBeforeVeto = 5;
 
 namespace blink {
 
 void PaintController::SetTracksRasterInvalidations(bool value) {
   if (value ||
       RuntimeEnabledFeatures::paintUnderInvalidationCheckingEnabled()) {
-    raster_invalidation_tracking_map_ =
-        WTF::WrapUnique(new RasterInvalidationTrackingMap<const PaintChunk>);
+    raster_invalidation_tracking_info_ =
+        WTF::MakeUnique<RasterInvalidationTrackingInfo>();
+
+    // This is called just after a full document cycle update, so all clients in
+    // current_paint_artifact_ should be still alive.
+    DCHECK(new_display_item_list_.IsEmpty());
+    for (const auto& item : current_paint_artifact_.GetDisplayItemList()) {
+      raster_invalidation_tracking_info_->old_client_debug_names.Set(
+          &item.Client(), item.Client().DebugName());
+    }
   } else {
-    raster_invalidation_tracking_map_ = nullptr;
+    raster_invalidation_tracking_info_ = nullptr;
   }
 }
 
 const PaintArtifact& PaintController::GetPaintArtifact() const {
   DCHECK(new_display_item_list_.IsEmpty());
   DCHECK(new_paint_chunks_.IsInInitialState());
   return current_paint_artifact_;
 }
 
 bool PaintController::UseCachedDrawingIfPossible(
@@ skipping 201 matching lines @@
 
 #if CHECK_DISPLAY_ITEM_CLIENT_ALIVENESS
   if (display_item.IsCacheable()) {
     BeginShouldKeepAlive(display_item.Client());
   }
 #endif
 
   if (IsSkippingCache())
     display_item.SetSkippedCache();
 
+  if (raster_invalidation_tracking_info_) {
+    raster_invalidation_tracking_info_->new_client_debug_names.insert(
+        &display_item.Client(), display_item.Client().DebugName());
+  }
+
   if (RuntimeEnabledFeatures::slimmingPaintV2Enabled()) {
     size_t last_chunk_index = new_paint_chunks_.LastChunkIndex();
     if (new_paint_chunks_.IncrementDisplayItemIndex(display_item)) {
       DCHECK(last_chunk_index != new_paint_chunks_.LastChunkIndex());
       if (last_chunk_index != kNotFound) {
         GenerateRasterInvalidations(
             new_paint_chunks_.PaintChunkAt(last_chunk_index));
       }
     }
   }
@@ skipping 332 matching lines @@
       }
     }
   }
 
   for (auto* client : skipped_cache_clients)
     client->SetDisplayItemsUncached();
 
   // The new list will not be appended to again so we can release unused memory.
   new_display_item_list_.ShrinkToFit();
 
-  if (raster_invalidation_tracking_map_) {
+  if (raster_invalidation_tracking_info_) {
     for (const auto& chunk : current_paint_artifact_.PaintChunks())
-      raster_invalidation_tracking_map_->Remove(&chunk);
+      raster_invalidation_tracking_info_->map.Remove(&chunk);
   }
   current_paint_artifact_ = PaintArtifact(
       std::move(new_display_item_list_), new_paint_chunks_.ReleasePaintChunks(),
       num_slow_paths <= kMaxNumberOfSlowPathsBeforeVeto);
 
   ResetCurrentListIndices();
   out_of_order_item_indices_.clear();
   out_of_order_chunk_indices_.clear();
   items_moved_into_new_list_.clear();
 
   if (RuntimeEnabledFeatures::slimmingPaintV2Enabled()) {
     for (const auto& chunk : current_paint_artifact_.PaintChunks()) {
       if (chunk.id && chunk.id->client.IsJustCreated())
         chunk.id->client.ClearIsJustCreated();
     }
   }
 
   // We'll allocate the initial buffer when we start the next paint.
   new_display_item_list_ = DisplayItemList(0);
 
 #if CHECK_DISPLAY_ITEM_CLIENT_ALIVENESS
   DisplayItemClient::EndShouldKeepAliveAllClients(this);
 #endif
 
 #ifndef NDEBUG
   num_sequential_matches_ = 0;
   num_out_of_order_matches_ = 0;
   num_indexed_items_ = 0;
 #endif
+
+  if (raster_invalidation_tracking_info_) {
+    raster_invalidation_tracking_info_->old_client_debug_names.clear();
+    std::swap(raster_invalidation_tracking_info_->old_client_debug_names,
+              raster_invalidation_tracking_info_->new_client_debug_names);
+  }
 }
 
 size_t PaintController::ApproximateUnsharedMemoryUsage() const {
   size_t memory_usage = sizeof(*this);
 
   // Memory outside this class due to m_currentPaintArtifact.
   memory_usage += current_paint_artifact_.ApproximateUnsharedMemoryUsage() -
                   sizeof(current_paint_artifact_);
 
   // TODO(jbroman): If display items begin to have significant external memory
@@ skipping 31 matching lines @@
 }
 
 void PaintController::GenerateRasterInvalidations(PaintChunk& new_chunk) {
   DCHECK(RuntimeEnabledFeatures::slimmingPaintV2Enabled());
   if (new_chunk.begin_index >=
       current_cached_subsequence_begin_index_in_new_list_)
     return;
 
   static FloatRect infinite_float_rect(LayoutRect::InfiniteIntRect());
   if (!new_chunk.id) {
-    AddRasterInvalidation(nullptr, new_chunk, infinite_float_rect);
+    // This chunk is not cacheable, so always invalidate the whole chunk.
+    AddRasterInvalidation(
+        new_display_item_list_[new_chunk.begin_index].Client(), new_chunk,
+        infinite_float_rect);
     return;
   }
 
   // Try to match old chunk sequentially first.
   const auto& old_chunks = current_paint_artifact_.PaintChunks();
   while (next_chunk_to_match_ < old_chunks.size()) {
     const PaintChunk& old_chunk = old_chunks[next_chunk_to_match_];
     if (new_chunk.Matches(old_chunk)) {
       GenerateRasterInvalidationsComparingChunks(new_chunk, old_chunk);
       ++next_chunk_to_match_;
@@ skipping 19 matching lines @@
   if (it != out_of_order_chunk_indices_.end()) {
     for (size_t i : it->value) {
       if (new_chunk.Matches(old_chunks[i])) {
         GenerateRasterInvalidationsComparingChunks(new_chunk, old_chunks[i]);
         return;
       }
     }
   }
 
   // We reach here because the chunk is new.
-  AddRasterInvalidation(nullptr, new_chunk, infinite_float_rect);
+  AddRasterInvalidation(new_display_item_list_[new_chunk.begin_index].Client(),
+                        new_chunk, infinite_float_rect);
 }
 
-void PaintController::AddRasterInvalidation(const DisplayItemClient* client,
+void PaintController::AddRasterInvalidation(const DisplayItemClient& client,
                                             PaintChunk& chunk,
                                             const FloatRect& rect) {
   chunk.raster_invalidation_rects.push_back(rect);
-  if (raster_invalidation_tracking_map_)
+  if (raster_invalidation_tracking_info_)
     TrackRasterInvalidation(client, chunk, rect);
 }
 
-void PaintController::TrackRasterInvalidation(const DisplayItemClient* client,
+void PaintController::TrackRasterInvalidation(const DisplayItemClient& client,
                                               PaintChunk& chunk,
                                               const FloatRect& rect) {
-  DCHECK(raster_invalidation_tracking_map_);
+  DCHECK(raster_invalidation_tracking_info_);
 
   RasterInvalidationInfo info;
   info.rect = EnclosingIntRect(rect);
-  info.client = client;
-  if (client) {
-    info.client_debug_name = client->DebugName();
-    info.reason = client->GetPaintInvalidationReason();
+  info.client = &client;
+  auto it =
+      raster_invalidation_tracking_info_->new_client_debug_names.find(&client);
+  if (it == raster_invalidation_tracking_info_->new_client_debug_names.end()) {
+    it = raster_invalidation_tracking_info_->old_client_debug_names.find(
+        &client);
+    // The client should be either in new list or in old list.
+    DCHECK(it !=
+           raster_invalidation_tracking_info_->old_client_debug_names.end());
+    info.reason = kPaintInvalidationLayoutObjectRemoval;
+  } else {
+    info.reason = client.GetPaintInvalidationReason();
   }
-  raster_invalidation_tracking_map_->Add(&chunk).invalidations.push_back(info);
+  info.client_debug_name = it->value;
+  raster_invalidation_tracking_info_->map.Add(&chunk).invalidations.push_back(
+      info);
 }
 
 void PaintController::GenerateRasterInvalidationsComparingChunks(
     PaintChunk& new_chunk,
     const PaintChunk& old_chunk) {
   DCHECK(RuntimeEnabledFeatures::slimmingPaintV2Enabled());
 
   // TODO(wangxianzhu): Handle PaintInvalidationIncremental.
   // TODO(wangxianzhu): Optimize paint offset change.
 
   HashSet<const DisplayItemClient*> invalidated_clients_in_old_chunk;
   size_t highest_moved_to_index = 0;
   for (size_t old_index = old_chunk.begin_index;
        old_index < old_chunk.end_index; ++old_index) {
     const DisplayItem& old_item =
         current_paint_artifact_.GetDisplayItemList()[old_index];
     const DisplayItemClient* client_to_invalidate = nullptr;
-    bool is_potentially_invalid_client = false;
+
     if (!old_item.HasValidClient()) {
       size_t moved_to_index = items_moved_into_new_list_[old_index];
       if (new_display_item_list_[moved_to_index].DrawsContent()) {
         if (moved_to_index < new_chunk.begin_index ||
             moved_to_index >= new_chunk.end_index) {
           // The item has been moved into another chunk, so need to invalidate
           // it in the old chunk.
           client_to_invalidate =
               &new_display_item_list_[moved_to_index].Client();
           // And invalidate in the new chunk into which the item was moved.
           PaintChunk& moved_to_chunk =
               new_paint_chunks_.FindChunkByDisplayItemIndex(moved_to_index);
-          AddRasterInvalidation(client_to_invalidate, moved_to_chunk,
+          AddRasterInvalidation(*client_to_invalidate, moved_to_chunk,
                                 FloatRect(client_to_invalidate->VisualRect()));
         } else if (moved_to_index < highest_moved_to_index) {
           // The item has been moved behind other cached items, so need to
           // invalidate the area that is probably exposed by the item moved
           // earlier.
           client_to_invalidate =
               &new_display_item_list_[moved_to_index].Client();
         } else {
           highest_moved_to_index = moved_to_index;
         }
       }
     } else if (old_item.DrawsContent()) {
-      is_potentially_invalid_client = true;
       client_to_invalidate = &old_item.Client();
     }
     if (client_to_invalidate &&
         invalidated_clients_in_old_chunk.insert(client_to_invalidate)
             .is_new_entry) {
       AddRasterInvalidation(
-          is_potentially_invalid_client ? nullptr : client_to_invalidate,
-          new_chunk,
+          *client_to_invalidate, new_chunk,
           FloatRect(current_paint_artifact_.GetDisplayItemList().VisualRect(
               old_index)));
     }
   }
 
   HashSet<const DisplayItemClient*> invalidated_clients_in_new_chunk;
   for (size_t new_index = new_chunk.begin_index;
        new_index < new_chunk.end_index; ++new_index) {
     const DisplayItem& new_item = new_display_item_list_[new_index];
     if (new_item.DrawsContent() && !ClientCacheIsValid(new_item.Client()) &&
         invalidated_clients_in_new_chunk.insert(&new_item.Client())
             .is_new_entry) {
-      AddRasterInvalidation(&new_item.Client(), new_chunk,
+      AddRasterInvalidation(new_item.Client(), new_chunk,
                             FloatRect(new_item.Client().VisualRect()));
     }
   }
 }
 
 void PaintController::ShowUnderInvalidationError(
     const char* reason,
     const DisplayItem& new_item,
     const DisplayItem* old_item) const {
   LOG(ERROR) << under_invalidation_message_prefix_ << " " << reason;
@@ skipping 122 matching lines @@
               show_paint_records
                   ? (DisplayItemList::JsonOptions::kShowPaintRecords |
                      DisplayItemList::JsonOptions::kShowClientDebugName)
                   : DisplayItemList::JsonOptions::kShowClientDebugName)
           ->ToPrettyJSONString()
           .Utf8()
           .data());
 }
 
 }  // namespace blink