[ Do not submit ] Prototype for invalidation analysis

Source/devtools/front_end/timeline/TracingTimelineModel.js

 // 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.
 
 /**
  * @constructor
  * @param {!WebInspector.TracingModel} tracingModel
  * @param {!WebInspector.TimelineModel.Filter} recordFilter
  * @extends {WebInspector.TimelineModel}
  */
@@ skipping 13 matching lines @@
 
     GPUTask: "GPUTask",
 
     RequestMainThreadFrame: "RequestMainThreadFrame",
     BeginFrame: "BeginFrame",
     BeginMainThreadFrame: "BeginMainThreadFrame",
     ActivateLayerTree: "ActivateLayerTree",
     DrawFrame: "DrawFrame",
     ScheduleStyleRecalculation: "ScheduleStyleRecalculation",
     RecalculateStyles: "RecalculateStyles",
+    StyleInvalidationTracking: "StyleInvalidationTracking",
+    LayoutInvalidationTracking: "LayoutInvalidationTracking",
+    PaintInvalidationTracking: "PaintInvalidationTracking",
     InvalidateLayout: "InvalidateLayout",
     Layout: "Layout",
     UpdateLayer: "UpdateLayer",
     UpdateLayerTree: "UpdateLayerTree",
     PaintSetup: "PaintSetup",
     Paint: "Paint",
     PaintImage: "PaintImage",
     Rasterize: "Rasterize",
     RasterTask: "RasterTask",
     ScrollLayer: "ScrollLayer",
@@ skipping 65 matching lines @@
     this.events = [];
     /** @type {!Array.<!Array.<!WebInspector.TracingModel.Event>>} */
     this.asyncEvents = [];
 }
 
 WebInspector.TracingTimelineModel.prototype = {
     /**
      * @param {boolean} captureStacks
      * @param {boolean} captureMemory
      * @param {boolean} capturePictures
+     * @param {boolean} captureInvalidationTracking
      */
-    startRecording: function(captureStacks, captureMemory, capturePictures)
+    startRecording: function(captureStacks, captureMemory, capturePictures, captureInvalidationTracking)
     {
         function disabledByDefault(category)
         {
             return "disabled-by-default-" + category;
         }
         var categoriesArray = [
             "-*",
             disabledByDefault("devtools.timeline"),
             disabledByDefault("devtools.timeline.frame"),
             WebInspector.TracingModel.ConsoleEventCategory
         ];
         if (captureStacks) {
             categoriesArray.push(disabledByDefault("devtools.timeline.stack"));
             if (WebInspector.experimentsSettings.timelineJSCPUProfile.isEnabled()) {
                 this._jsProfilerStarted = true;
                 this._currentTarget = WebInspector.context.flavor(WebInspector.Target);
                 this._configureCpuProfilerSamplingInterval();
                 this._currentTarget.profilerAgent().start();
             }
         }
         if (capturePictures) {
             categoriesArray = categoriesArray.concat([
                 disabledByDefault("devtools.timeline.layers"),
                 disabledByDefault("devtools.timeline.picture"),
                 disabledByDefault("blink.graphics_context_annotations")]);
         }
+        if (captureInvalidationTracking) {
+            categoriesArray = categoriesArray.concat([
+                disabledByDefault("devtools.timeline.invalidationTracking")]);
+        }
         var categories = categoriesArray.join(",");
         this._startRecordingWithCategories(categories);
     },
 
     stopRecording: function()
     {
         this._stopCallbackBarrier = new CallbackBarrier();
         if (this._jsProfilerStarted) {
             this._currentTarget.profilerAgent().stop(this._stopCallbackBarrier.createCallback(this._didStopRecordingJSSamples.bind(this)));
             this._jsProfilerStarted = false;
@@ skipping 246 matching lines @@
         if (record.type() === WebInspector.TracingTimelineModel.RecordType.GPUTask)
             this._gpuThreadTasks.push(record);
         this.dispatchEventToListeners(WebInspector.TimelineModel.Events.RecordAdded, record);
     },
 
     _resetProcessingState: function()
     {
         this._sendRequestEvents = {};
         this._timerEvents = {};
         this._requestAnimationFrameEvents = {};
+        this._invalidationTracker = new WebInspector.InvalidationTracker();
         this._layoutInvalidate = {};
         this._lastScheduleStyleRecalculation = {};
         this._webSocketCreateEvents = {};
         this._paintImageEventByPixelRefId = {};
         this._lastPaintForLayer = {};
         this._lastRecalculateStylesEvent = null;
         this._currentScriptEvent = null;
         this._eventStack = [];
     },
 
@@ skipping 92 matching lines @@
 
         case recordTypes.ScheduleStyleRecalculation:
             this._lastScheduleStyleRecalculation[event.args["frame"]] = event;
             break;
 
         case recordTypes.RecalculateStyles:
             event.initiator = this._lastScheduleStyleRecalculation[event.args["frame"]];
             this._lastRecalculateStylesEvent = event;
             break;
 
+        case recordTypes.StyleInvalidationTracking:
+            this._invalidationTracker.addStyleInvalidation({
+                frameId: event.args.data.frame,
+                nodeId: event.args.data.nodeId,
+                nodeName: event.args.data.nodeName,
+                callstack: event.args.data.callstack
+            });
+            break;
+
+        case recordTypes.LayoutInvalidationTracking:
+            this._invalidationTracker.addLayoutInvalidation({
+                frameId: event.args.data.frame,
+                rendererId: event.args.data.rendererId,
+                nodeId: event.args.data.nodeId,
+                nodeName: event.args.data.nodeName,
+                callstack: event.args.data.callstack
+            });
+            break;
+
+        case recordTypes.PaintInvalidationTracking:
+            this._invalidationTracker.addPaintInvalidation({
+                frameId: event.args.data.frame,
+                rendererId: event.args.data.rendererId,
+                nodeId: event.args.data.nodeId,
+                nodeName: event.args.data.nodeName,
+                paintId: event.args.data.paintId
+            });
+            break;
+
         case recordTypes.InvalidateLayout:
             // Consider style recalculation as a reason for layout invalidation,
             // but only if we had no earlier layout invalidation records.
             var layoutInitator = event;
             var frameId = event.args["frame"];
             if (!this._layoutInvalidate[frameId] && this._lastRecalculateStylesEvent && this._lastRecalculateStylesEvent.endTime >  event.startTime)
                 layoutInitator = this._lastRecalculateStylesEvent.initiator;
             this._layoutInvalidate[frameId] = layoutInitator;
             break;
 
@@ skipping 21 matching lines @@
         case recordTypes.FunctionCall:
             if (!this._currentScriptEvent)
                 this._currentScriptEvent = event;
             break;
 
         case recordTypes.SetLayerTreeId:
             this._inspectedTargetLayerTreeId = event.args["layerTreeId"];
             break;
 
         case recordTypes.Paint:
+            this._invalidationTracker.updatePaint(event);
             event.highlightQuad = event.args["data"]["clip"];
             event.backendNodeId = event.args["data"]["nodeId"];
             var layerUpdateEvent = this._findAncestorEvent(recordTypes.UpdateLayer);
             if (!layerUpdateEvent || layerUpdateEvent.args["layerTreeId"] !== this._inspectedTargetLayerTreeId)
                 break;
             // Only keep layer paint events, skip paints for subframes that get painted to the same layer as parent.
             if (!event.args["data"]["layerId"])
                 break;
             this._lastPaintForLayer[layerUpdateEvent.args["layerId"]] = event;
             break;
@@ skipping 467 matching lines @@
     },
 
     _didWriteNextChunk: function(stream)
     {
         if (this._recordIndex === this._payloads.length)
             stream.close();
         else
             this._writeNextChunk(stream);
     }
 }
+
+/**
+ * TODO: Properly doc this class.
+ *
+ * Track style, layout, and paint invalidation events.
+ */
+WebInspector.InvalidationTracker = function()
+{
+    // Invalidation events for the current frame.
+    this._styleTrackingEvents = {};
+    this._layoutTrackingEvents = {};
+    this._paintTrackingEvents = {};
+
+    // FIXME: This is used to clear out the tracking event maps but it may
+    //        not be sufficient if there are multiple frame ids.
+    this._lastFrameId = -1;
+
+    this._didPaint = false;
+}
+
+WebInspector.InvalidationTracker.prototype = {
+
+    addStyleInvalidation: function(invalidation)
+    {
+        this._startNewFrameIfNeeded();
+
+        var frameId = invalidation.frameId;
+        this._lastFrameId = frameId;
+
+        if (!invalidation.nodeId) {
+            console.error('Style invalidation lacks node information.');
+            console.error(invalidation);
+        }
+
+        if (this._styleTrackingEvents[frameId] === undefined)
+            this._styleTrackingEvents[frameId] = [];
+        this._styleTrackingEvents[frameId].push(invalidation);
+    },
+
+    addLayoutInvalidation: function(invalidation)
+    {
+        this._startNewFrameIfNeeded();
+
+        var frameId = invalidation.frameId;
+        this._lastFrameId = frameId;
+
+        if (!invalidation.nodeId && !invalidation.rendererId) {
+            console.error('Layout invalidation lacks node or renderer information.');
+            console.error(invalidation);
+        }
+
+        if (this._layoutTrackingEvents[frameId] === undefined)
+            this._layoutTrackingEvents[frameId] = [];
+        this._layoutTrackingEvents[frameId].push(invalidation);
+    },
+
+    addPaintInvalidation: function(invalidation)
+    {
+        this._startNewFrameIfNeeded();
+
+        var frameId = invalidation.frameId;
+        this._lastFrameId = frameId;
+
+        if (!invalidation.nodeId && !invalidation.rendererId) {
+            console.error('Paint invalidation lacks node or renderer information.');
+            console.error(invalidation);
+        }
+
+        if (this._paintTrackingEvents[frameId] === undefined)
+            this._paintTrackingEvents[frameId] = [];
+        this._paintTrackingEvents[frameId].push(invalidation);
+    },
+
+    updatePaint: function(paintEvent)
+    {
+        this._didPaint = true;
+
+        var frameId = paintEvent.args.data.frame;
+        var paintId = paintEvent.args.data.paintId;
+
+        paintEvent.styleInvalidationTrackingEvents = [];
+        paintEvent.layoutInvalidationTrackingEvents = [];
+
+        var styleTrackingEvents = this._styleTrackingEvents[frameId] || [];
+        var layoutTrackingEvents = this._layoutTrackingEvents[frameId] || [];
+        var paintTrackingEvents = this._paintTrackingEvents[frameId] || [];
+
+        paintTrackingEvents.forEach(function(paintInvalidation) {
+            if (paintInvalidation.paintId != paintId)
+                return;
+
+            // Collect style and layout invalidations that caused this paint.
+            styleTrackingEvents.forEach(function(invalidation) {
+                if (invalidation.nodeId == paintInvalidation.nodeId) {
+                    if (paintEvent.styleInvalidationTrackingEvents.indexOf(invalidation) == -1)
+                        paintEvent.styleInvalidationTrackingEvents.push(invalidation);
+                }
+            });
+            layoutTrackingEvents.forEach(function(invalidation) {
+                if (invalidation.nodeId == paintInvalidation.nodeId
+                    || invalidation.rendererId == paintInvalidation.rendererId) {
+                    if (paintEvent.layoutInvalidationTrackingEvents.indexOf(invalidation) == -1)
+                        paintEvent.layoutInvalidationTrackingEvents.push(invalidation);
+                }
+            });
+        });
+    },
+
+    // If there's a new frame, save off all current invalidations.
+    _startNewFrameIfNeeded: function()
+    {
+        if (!this._didPaint)
+            return;
+        this._styleTrackingEvents[this._lastFrameId] = undefined;
+        this._layoutTrackingEvents[this._lastFrameId] = undefined;
+        this._paintTrackingEvents[this._lastFrameId] = undefined;
+        this._didPaint = false;
+    }
+}