@paulirish/trace_engine 0.0.9 → 0.0.11

package/models/trace/helpers/SamplesIntegrator.js

@@ -0,0 +1,397 @@
+// Copyright 2023 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.
+import * as Types from '../types/types.js';
+import { millisecondsToMicroseconds } from './Timing.js';
+import { makeProfileCall, mergeEventsInOrder } from './Trace.js';
+/**
+ * This is a helper that integrates CPU profiling data coming in the
+ * shape of samples, with trace events. Samples indicate what the JS
+ * stack trace looked at a given point in time, but they don't have
+ * duration. The SamplesIntegrator task is to make an approximation
+ * of what the duration of each JS call was, given the sample data and
+ * given the trace events profiled during that time. At the end of its
+ * execution, the SamplesIntegrator returns an array of ProfileCalls
+ * (under SamplesIntegrator::buildProfileCalls()), which
+ * represent JS calls, with a call frame and duration. These calls have
+ * the shape of a complete trace events and can be treated as flame
+ * chart entries in the timeline.
+ *
+ * The approach to build the profile calls consists in tracking the
+ * current stack as the following events happen (in order):
+ * 1. A sample was done.
+ * 2. A trace event started.
+ * 3. A trace event ended.
+ * Depending on the event and on the data that's coming with it the
+ * stack is updated by adding or removing JS calls to it and updating
+ * the duration of the calls in the tracking stack.
+ *
+ * note: Although this approach has been implemented since long ago, and
+ * is relatively efficent (adds a complexity over the trace parsing of
+ * O(n) where n is the number of samples) it has proven to be faulty.
+ * It might be worthwhile experimenting with improvements or with a
+ * completely different approach. Improving the approach is tracked in
+ * crbug.com/1417439
+ */
+export class SamplesIntegrator {
+    /**
+     * The result of runing the samples integrator. Holds the JS calls
+     * with their approximated duration after integrating samples into the
+     * trace event tree.
+     */
+    #constructedProfileCalls = [];
+    /**
+     * tracks the state of the JS stack at each point in time to update
+     * the profile call durations as new events arrive. This doesn't only
+     * happen with new profile calls (in which case we would compare the
+     * stack in them) but also with trace events (in which case we would
+     * update the duration of the events we are tracking at the moment).
+     */
+    #currentJSStack = [];
+    /**
+     * Process holding the CPU profile and trace events.
+     */
+    #processId;
+    /**
+     * Thread holding the CPU profile and trace events.
+     */
+    #threadId;
+    /**
+     * Tracks the depth of the JS stack at the moment a trace event starts
+     * or ends. It is assumed that for the duration of a trace event, the
+     * JS stack's depth cannot decrease, since JS calls that started
+     * before a trace event cannot end during the trace event. So as trace
+     * events arrive, we store the "locked" amount of JS frames that were
+     * in the stack before the event came.
+     */
+    #lockedJsStackDepth = [];
+    /**
+     * Used to keep track when samples should be integrated even if they
+     * are not children of invocation trace events. This is useful in
+     * cases where we can be missing the start of JS invocation events if
+     * we start tracing half-way through.
+     */
+    #fakeJSInvocation = false;
+    /**
+     * The parsed CPU profile, holding the tree hierarchy of JS frames and
+     * the sample data.
+     */
+    #profileModel;
+    /**
+     * Because GC nodes don't have a stack, we artificially add a stack to
+     * them which corresponds to that of the previous sample. This map
+     * tracks which node is used for the stack of a GC call.
+     * Note that GC samples are not shown in the flamechart, however they
+     * are used during the construction of for profile calls, as we can
+     * infer information about the duration of the executed code when a
+     * GC node is sampled.
+     */
+    #nodeForGC = new Map();
+    #engineConfig;
+    constructor(profileModel, pid, tid, configuration) {
+        this.#profileModel = profileModel;
+        this.#threadId = tid;
+        this.#processId = pid;
+        this.#engineConfig = configuration || Types.Configuration.DEFAULT;
+    }
+    buildProfileCalls(traceEvents) {
+        const mergedEvents = mergeEventsInOrder(traceEvents, this.callsFromProfileSamples());
+        const stack = [];
+        for (let i = 0; i < mergedEvents.length; i++) {
+            const event = mergedEvents[i];
+            // Because instant trace events have no duration, they don't provide
+            // useful information for possible changes in the duration of calls
+            // in the JS stack.
+            if (event.ph === "I" /* Types.TraceEvents.Phase.INSTANT */) {
+                continue;
+            }
+            if (stack.length === 0) {
+                if (Types.TraceEvents.isProfileCall(event)) {
+                    this.#onProfileCall(event);
+                    continue;
+                }
+                stack.push(event);
+                this.#onTraceEventStart(event);
+                continue;
+            }
+            const parentEvent = stack.at(-1);
+            if (parentEvent === undefined) {
+                continue;
+            }
+            const begin = event.ts;
+            const parentBegin = parentEvent.ts;
+            const parentDuration = parentEvent.dur || 0;
+            const parentEnd = parentBegin + parentDuration;
+            const startsAfterParent = begin >= parentEnd;
+            if (startsAfterParent) {
+                this.#onTraceEventEnd(parentEvent);
+                stack.pop();
+                i--;
+                continue;
+            }
+            if (Types.TraceEvents.isProfileCall(event)) {
+                this.#onProfileCall(event, parentEvent);
+                continue;
+            }
+            this.#onTraceEventStart(event);
+            stack.push(event);
+        }
+        while (stack.length) {
+            const last = stack.pop();
+            if (last) {
+                this.#onTraceEventEnd(last);
+            }
+        }
+        return this.#constructedProfileCalls;
+    }
+    #onTraceEventStart(event) {
+        // Top level events cannot be nested into JS frames so we reset
+        // the stack when we find one.
+        if (event.name === "RunMicrotasks" /* Types.TraceEvents.KnownEventName.RunMicrotasks */ ||
+            event.name === "RunTask" /* Types.TraceEvents.KnownEventName.RunTask */) {
+            this.#lockedJsStackDepth = [];
+            this.#truncateJSStack(0, event.ts);
+            this.#fakeJSInvocation = false;
+        }
+        if (this.#fakeJSInvocation) {
+            this.#truncateJSStack(this.#lockedJsStackDepth.pop() || 0, event.ts);
+            this.#fakeJSInvocation = false;
+        }
+        this.#extractStackTrace(event);
+        // Keep track of the call frames in the stack before the event
+        // happened. For the duration of this event, these frames cannot
+        // change (none can be terminated before this event finishes).
+        //
+        // Also, every frame that is opened after this event, is considered
+        // to be a descendant of the event. So once the event finishes, the
+        // frames that were opened after it, need to be closed (see
+        // onEndEvent).
+        //
+        // TODO(crbug.com/1417439):
+        // The assumption that every frame opened after an event is a
+        // descendant of the event is incorrect. For example, a JS call that
+        // parents a trace event might have been sampled after the event was
+        // dispatched. In this case the JS call would be discarded if this
+        // event isn't an invocation event, otherwise the call will be
+        // considered a child of the event. In both cases, the result would
+        // be incorrect.
+        this.#lockedJsStackDepth.push(this.#currentJSStack.length);
+    }
+    #onProfileCall(event, parent) {
+        if ((parent && Types.TraceEvents.isJSInvocationEvent(parent)) || this.#fakeJSInvocation) {
+            this.#extractStackTrace(event);
+        }
+        else if (Types.TraceEvents.isProfileCall(event) && this.#currentJSStack.length === 0) {
+            // Force JS Samples to show up even if we are not inside a JS
+            // invocation event, because we can be missing the start of JS
+            // invocation events if we start tracing half-way through. Pretend
+            // we have a top-level JS invocation event.
+            this.#fakeJSInvocation = true;
+            const stackDepthBefore = this.#currentJSStack.length;
+            this.#extractStackTrace(event);
+            this.#lockedJsStackDepth.push(stackDepthBefore);
+        }
+    }
+    #onTraceEventEnd(event) {
+        // Because the event has ended, any frames that happened after
+        // this event are terminated. Frames that are ancestors to this
+        // event are extended to cover its ending.
+        const endTime = Types.Timing.MicroSeconds(event.ts + (event.dur || 0));
+        this.#truncateJSStack(this.#lockedJsStackDepth.pop() || 0, endTime);
+    }
+    /**
+     * Builds the initial calls with no duration from samples. Their
+     * purpose is to be merged with the trace event array being parsed so
+     * that they can be traversed in order with them and their duration
+     * can be updated as the SampleIntegrator callbacks are invoked.
+     */
+    callsFromProfileSamples() {
+        const samples = this.#profileModel.samples;
+        const timestamps = this.#profileModel.timestamps;
+        if (!samples) {
+            return [];
+        }
+        const calls = [];
+        let prevNode;
+        for (let i = 0; i < samples.length; i++) {
+            const node = this.#profileModel.nodeByIndex(i);
+            const timestamp = millisecondsToMicroseconds(Types.Timing.MilliSeconds(timestamps[i]));
+            if (!node) {
+                continue;
+            }
+            const call = makeProfileCall(node, timestamp, this.#processId, this.#threadId);
+            calls.push(call);
+            if (node.id === this.#profileModel.gcNode?.id && prevNode) {
+                // GC samples have no stack, so we just put GC node on top of the
+                // last recorded sample. Cache the previous sample for future
+                // reference.
+                this.#nodeForGC.set(call, prevNode);
+                continue;
+            }
+            prevNode = node;
+        }
+        return calls;
+    }
+    #getStackTraceFromProfileCall(profileCall) {
+        let node = this.#profileModel.nodeById(profileCall.nodeId);
+        const isGarbageCollection = node?.id === this.#profileModel.gcNode?.id;
+        if (isGarbageCollection) {
+            // Because GC don't have a stack, we use the stack of the previous
+            // sample.
+            node = this.#nodeForGC.get(profileCall) || null;
+        }
+        if (!node) {
+            return [];
+        }
+        // `node.depth` is 0 based, so to set the size of the array we need
+        // to add 1 to its value.
+        const callFrames = new Array(node.depth + 1 + Number(isGarbageCollection));
+        // Add the stack trace in reverse order (bottom first).
+        let i = callFrames.length - 1;
+        if (isGarbageCollection) {
+            // Place the garbage collection call frame on top of the stack.
+            callFrames[i--] = profileCall;
+        }
+        while (node) {
+            callFrames[i--] = makeProfileCall(node, profileCall.ts, this.#processId, this.#threadId);
+            node = node.parent;
+        }
+        return callFrames;
+    }
+    /**
+     * Update tracked stack using this event's call stack.
+     */
+    #extractStackTrace(event) {
+        const stackTrace = Types.TraceEvents.isProfileCall(event) ? this.#getStackTraceFromProfileCall(event) : this.#currentJSStack;
+        SamplesIntegrator.filterStackFrames(stackTrace, this.#engineConfig);
+        const endTime = event.ts + (event.dur || 0);
+        const minFrames = Math.min(stackTrace.length, this.#currentJSStack.length);
+        let i;
+        // Merge a sample's stack frames with the stack frames we have
+        // so far if we detect they are equivalent.
+        // Graphically
+        // This:
+        // Current stack trace       Sample
+        // [-------A------]          [A]
+        // [-------B------]          [B]
+        // [-------C------]          [C]
+        //                ^ t = x1    ^ t = x2
+        // Becomes this:
+        // New stack trace after merge
+        // [--------A-------]
+        // [--------B-------]
+        // [--------C-------]
+        //                  ^ t = x2
+        for (i = this.#lockedJsStackDepth.at(-1) || 0; i < minFrames; ++i) {
+            const newFrame = stackTrace[i].callFrame;
+            const oldFrame = this.#currentJSStack[i].callFrame;
+            if (!SamplesIntegrator.framesAreEqual(newFrame, oldFrame)) {
+                break;
+            }
+            // Scoot the right edge of this callFrame to the right
+            this.#currentJSStack[i].dur =
+                Types.Timing.MicroSeconds(Math.max(this.#currentJSStack[i].dur || 0, endTime - this.#currentJSStack[i].ts));
+        }
+        // If there are call frames in the sample that differ with the stack
+        // we have, update the stack, but keeping the common frames in place
+        // Graphically
+        // This:
+        // Current stack trace       Sample
+        // [-------A------]          [A]
+        // [-------B------]          [B]
+        // [-------C------]          [C]
+        // [-------D------]          [E]
+        //                ^ t = x1    ^ t = x2
+        // Becomes this:
+        // New stack trace after merge
+        // [--------A-------]
+        // [--------B-------]
+        // [--------C-------]
+        //                [E]
+        //                  ^ t = x2
+        this.#truncateJSStack(i, event.ts);
+        for (; i < stackTrace.length; ++i) {
+            const call = stackTrace[i];
+            if (call.nodeId === this.#profileModel.programNode?.id || call.nodeId === this.#profileModel.root?.id ||
+                call.nodeId === this.#profileModel.idleNode?.id || call.nodeId === this.#profileModel.gcNode?.id) {
+                // Skip (root), (program) and (idle) frames, since this are not
+                // relevant for web profiling and we don't want to show them in
+                // the timeline.
+                continue;
+            }
+            this.#currentJSStack.push(call);
+            this.#constructedProfileCalls.push(call);
+        }
+    }
+    /**
+     * When a call stack that differs from the one we are tracking has
+     * been detected in the samples, the latter is "truncated" by
+     * setting the ending time of its call frames and removing the top
+     * call frames that aren't shared with the new call stack. This way,
+     * we can update the tracked stack with the new call frames on top.
+     * @param depth the amount of call frames from bottom to top that
+     * should be kept in the tracking stack trace. AKA amount of shared
+     * call frames between two stacks.
+     * @param time the new end of the call frames in the stack.
+     */
+    #truncateJSStack(depth, time) {
+        if (this.#lockedJsStackDepth.length) {
+            const lockedDepth = this.#lockedJsStackDepth.at(-1);
+            if (lockedDepth && depth < lockedDepth) {
+                console.error(`Child stack is shallower (${depth}) than the parent stack (${lockedDepth}) at ${time}`);
+                depth = lockedDepth;
+            }
+        }
+        if (this.#currentJSStack.length < depth) {
+            console.error(`Trying to truncate higher than the current stack size at ${time}`);
+            depth = this.#currentJSStack.length;
+        }
+        for (let k = 0; k < this.#currentJSStack.length; ++k) {
+            this.#currentJSStack[k].dur = Types.Timing.MicroSeconds(Math.max(time - this.#currentJSStack[k].ts, 0));
+        }
+        this.#currentJSStack.length = depth;
+    }
+    static framesAreEqual(frame1, frame2) {
+        return frame1.scriptId === frame2.scriptId && frame1.functionName === frame2.functionName &&
+            frame1.lineNumber === frame2.lineNumber;
+    }
+    static showNativeName(name, runtimeCallStatsEnabled) {
+        return runtimeCallStatsEnabled && Boolean(SamplesIntegrator.nativeGroup(name));
+    }
+    static nativeGroup(nativeName) {
+        if (nativeName.startsWith('Parse')) {
+            return 'Parse';
+        }
+        if (nativeName.startsWith('Compile') || nativeName.startsWith('Recompile')) {
+            return 'Compile';
+        }
+        return null;
+    }
+    static isNativeRuntimeFrame(frame) {
+        return frame.url === 'native V8Runtime';
+    }
+    static filterStackFrames(stack, engineConfig) {
+        const showAllEvents = engineConfig.experiments.timelineShowAllEvents;
+        if (showAllEvents) {
+            return;
+        }
+        let previousNativeFrameName = null;
+        let j = 0;
+        for (let i = 0; i < stack.length; ++i) {
+            const frame = stack[i].callFrame;
+            const nativeRuntimeFrame = SamplesIntegrator.isNativeRuntimeFrame(frame);
+            if (nativeRuntimeFrame &&
+                !SamplesIntegrator.showNativeName(frame.functionName, engineConfig.experiments.timelineV8RuntimeCallStats)) {
+                continue;
+            }
+            const nativeFrameName = nativeRuntimeFrame ? SamplesIntegrator.nativeGroup(frame.functionName) : null;
+            if (previousNativeFrameName && previousNativeFrameName === nativeFrameName) {
+                continue;
+            }
+            previousNativeFrameName = nativeFrameName;
+            stack[j++] = stack[i];
+        }
+        stack.length = j;
+    }
+}
+//# sourceMappingURL=SamplesIntegrator.js.map

package/models/trace/helpers/SamplesIntegrator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SamplesIntegrator.js","sourceRoot":"","sources":["../../../../../../../front_end/models/trace/helpers/SamplesIntegrator.ts"],"names":[],"mappings":"AAAA,4DAA4D;AAC5D,yEAAyE;AACzE,6BAA6B;AAI7B,OAAO,KAAK,KAAK,MAAM,mBAAmB,CAAC;AAE3C,OAAO,EAAC,0BAA0B,EAAC,MAAM,aAAa,CAAC;AACvD,OAAO,EAAC,eAAe,EAAE,kBAAkB,EAAC,MAAM,YAAY,CAAC;AAE/D;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,MAAM,OAAO,iBAAiB;IAC5B;;;;OAIG;IACH,wBAAwB,GAA6C,EAAE,CAAC;IACxE;;;;;;OAMG;IACH,eAAe,GAA6C,EAAE,CAAC;IAC/D;;OAEG;IACH,UAAU,CAA8B;IACxC;;OAEG;IACH,SAAS,CAA6B;IACtC;;;;;;;OAOG;IACH,mBAAmB,GAAa,EAAE,CAAC;IACnC;;;;;OAKG;IACH,iBAAiB,GAAG,KAAK,CAAC;IAC1B;;;OAGG;IACH,aAAa,CAAqD;IAClE;;;;;;;;OAQG;IACH,UAAU,GAAG,IAAI,GAAG,EAAmF,CAAC;IAExG,aAAa,CAAoC;IAEjD,YACI,YAAgE,EAAE,GAAgC,EAClG,GAA+B,EAAE,aAAiD;QACpF,IAAI,CAAC,aAAa,GAAG,YAAY,CAAC;QAClC,IAAI,CAAC,SAAS,GAAG,GAAG,CAAC;QACrB,IAAI,CAAC,UAAU,GAAG,GAAG,CAAC;QACtB,IAAI,CAAC,aAAa,GAAG,aAAa,IAAI,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC;IACpE,CAAC;IAED,iBAAiB,CAAC,WAA+C;QAC/D,MAAM,YAAY,GAAG,kBAAkB,CAAC,WAAW,EAAE,IAAI,CAAC,uBAAuB,EAAE,CAAC,CAAC;QACrF,MAAM,KAAK,GAAG,EAAE,CAAC;QACjB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,YAAY,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YAC5C,MAAM,KAAK,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC;YAC9B,oEAAoE;YACpE,mEAAmE;YACnE,mBAAmB;YACnB,IAAI,KAAK,CAAC,EAAE,8CAAoC,EAAE;gBAChD,SAAS;aACV;YACD,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE;gBACtB,IAAI,KAAK,CAAC,WAAW,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE;oBAC1C,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;oBAC3B,SAAS;iBACV;gBACD,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBAClB,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;gBAC/B,SAAS;aACV;YAED,MAAM,WAAW,GAAG,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;YACjC,IAAI,WAAW,KAAK,SAAS,EAAE;gBAC7B,SAAS;aACV;YACD,MAAM,KAAK,GAAG,KAAK,CAAC,EAAE,CAAC;YACvB,MAAM,WAAW,GAAG,WAAW,CAAC,EAAE,CAAC;YACnC,MAAM,cAAc,GAAG,WAAW,CAAC,GAAG,IAAI,CAAC,CAAC;YAC5C,MAAM,SAAS,GAAG,WAAW,GAAG,cAAc,CAAC;YAE/C,MAAM,iBAAiB,GAAG,KAAK,IAAI,SAAS,CAAC;YAC7C,IAAI,iBAAiB,EAAE;gBACrB,IAAI,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAC;gBACnC,KAAK,CAAC,GAAG,EAAE,CAAC;gBACZ,CAAC,EAAE,CAAC;gBACJ,SAAS;aACV;YACD,IAAI,KAAK,CAAC,WAAW,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE;gBAC1C,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;gBACxC,SAAS;aACV;YACD,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;YAC/B,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;SACnB;QACD,OAAO,KAAK,CAAC,MAAM,EAAE;YACnB,MAAM,IAAI,GAAG,KAAK,CAAC,GAAG,EAAE,CAAC;YACzB,IAAI,IAAI,EAAE;gBACR,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;aAC7B;SACF;QACD,OAAO,IAAI,CAAC,wBAAwB,CAAC;IACvC,CAAC;IAED,kBAAkB,CAAC,KAAuC;QACxD,+DAA+D;QAC/D,8BAA8B;QAC9B,IAAI,KAAK,CAAC,IAAI,yEAAmD;YAC7D,KAAK,CAAC,IAAI,6DAA6C,EAAE;YAC3D,IAAI,CAAC,mBAAmB,GAAG,EAAE,CAAC;YAC9B,IAAI,CAAC,gBAAgB,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC,CAAC;YACnC,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC;SAChC;QAED,IAAI,IAAI,CAAC,iBAAiB,EAAE;YAC1B,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,mBAAmB,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC,CAAC;YACrE,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC;SAChC;QACD,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;QAC/B,8DAA8D;QAC9D,gEAAgE;QAChE,8DAA8D;QAC9D,EAAE;QACF,mEAAmE;QACnE,mEAAmE;QACnE,2DAA2D;QAC3D,eAAe;QACf,EAAE;QACF,2BAA2B;QAC3B,6DAA6D;QAC7D,oEAAoE;QACpE,oEAAoE;QACpE,kEAAkE;QAClE,8DAA8D;QAC9D,mEAAmE;QACnE,gBAAgB;QAChB,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;IAC7D,CAAC;IAED,cAAc,CAAC,KAA6C,EAAE,MAAyC;QACrG,IAAI,CAAC,MAAM,IAAI,KAAK,CAAC,WAAW,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC,IAAI,IAAI,CAAC,iBAAiB,EAAE;YACvF,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;SAChC;aAAM,IAAI,KAAK,CAAC,WAAW,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,eAAe,CAAC,MAAM,KAAK,CAAC,EAAE;YACtF,6DAA6D;YAC7D,8DAA8D;YAC9D,kEAAkE;YAClE,2CAA2C;YAC3C,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC;YAC9B,MAAM,gBAAgB,GAAG,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC;YACrD,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;YAC/B,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;SACjD;IACH,CAAC;IAED,gBAAgB,CAAC,KAAuC;QACtD,8DAA8D;QAC9D,+DAA+D;QAC/D,0CAA0C;QAC1C,MAAM,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,GAAG,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QACvE,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,mBAAmB,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,OAAO,CAAC,CAAC;IACtE,CAAC;IAED;;;;;OAKG;IACH,uBAAuB;QACrB,MAAM,OAAO,GAAG,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC;QAC3C,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC;QACjD,IAAI,CAAC,OAAO,EAAE;YACZ,OAAO,EAAE,CAAC;SACX;QACD,MAAM,KAAK,GAA6C,EAAE,CAAC;QAC3D,IAAI,QAAQ,CAAC;QACb,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YACvC,MAAM,IAAI,GAAG,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;YAC/C,MAAM,SAAS,GAAG,0BAA0B,CAAC,KAAK,CAAC,MAAM,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YACvF,IAAI,CAAC,IAAI,EAAE;gBACT,SAAS;aACV;YACD,MAAM,IAAI,GAAG,eAAe,CAAC,IAAI,EAAE,SAAS,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;YAC/E,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACjB,IAAI,IAAI,CAAC,EAAE,KAAK,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,EAAE,IAAI,QAAQ,EAAE;gBACzD,iEAAiE;gBACjE,6DAA6D;gBAC7D,aAAa;gBACb,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;gBACpC,SAAS;aACV;YACD,QAAQ,GAAG,IAAI,CAAC;SACjB;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,6BAA6B,CAAC,WAAmD;QAE/E,IAAI,IAAI,GAAG,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;QAC3D,MAAM,mBAAmB,GAAG,IAAI,EAAE,EAAE,KAAK,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,EAAE,CAAC;QACvE,IAAI,mBAAmB,EAAE;YACvB,kEAAkE;YAClE,UAAU;YACV,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,IAAI,CAAC;SACjD;QACD,IAAI,CAAC,IAAI,EAAE;YACT,OAAO,EAAE,CAAC;SACX;QACD,mEAAmE;QACnE,yBAAyB;QACzB,MAAM,UAAU,GAAG,IAAI,KAAK,CAAyC,IAAI,CAAC,KAAK,GAAG,CAAC,GAAG,MAAM,CAAC,mBAAmB,CAAC,CAAC,CAAC;QACnH,uDAAuD;QACvD,IAAI,CAAC,GAAG,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC;QAC9B,IAAI,mBAAmB,EAAE;YACvB,+DAA+D;YAC/D,UAAU,CAAC,CAAC,EAAE,CAAC,GAAG,WAAW,CAAC;SAC/B;QACD,OAAO,IAAI,EAAE;YACX,UAAU,CAAC,CAAC,EAAE,CAAC,GAAG,eAAe,CAAC,IAAI,EAAE,WAAW,CAAC,EAAE,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;YACzF,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC;SACpB;QACD,OAAO,UAAU,CAAC;IACpB,CAAC;IAED;;OAEG;IACH,kBAAkB,CAAC,KAAuC;QACxD,MAAM,UAAU,GACZ,KAAK,CAAC,WAAW,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,6BAA6B,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC;QAC9G,iBAAiB,CAAC,iBAAiB,CAAC,UAAU,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;QAEpE,MAAM,OAAO,GAAG,KAAK,CAAC,EAAE,GAAG,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;QAC5C,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,MAAM,EAAE,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;QAC3E,IAAI,CAAC,CAAC;QACN,8DAA8D;QAC9D,2CAA2C;QAC3C,cAAc;QACd,QAAQ;QACR,mCAAmC;QACnC,gCAAgC;QAChC,gCAAgC;QAChC,gCAAgC;QAChC,sCAAsC;QAEtC,gBAAgB;QAChB,8BAA8B;QAC9B,qBAAqB;QACrB,qBAAqB;QACrB,qBAAqB;QACrB,4BAA4B;QAC5B,KAAK,CAAC,GAAG,IAAI,CAAC,mBAAmB,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,SAAS,EAAE,EAAE,CAAC,EAAE;YACjE,MAAM,QAAQ,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YACzC,MAAM,QAAQ,GAAG,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YACnD,IAAI,CAAC,iBAAiB,CAAC,cAAc,CAAC,QAAQ,EAAE,QAAQ,CAAC,EAAE;gBACzD,MAAM;aACP;YACD,sDAAsD;YACtD,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,GAAG;gBACvB,KAAK,CAAC,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;SACjH;QAED,oEAAoE;QACpE,oEAAoE;QACpE,cAAc;QACd,QAAQ;QACR,mCAAmC;QACnC,gCAAgC;QAChC,gCAAgC;QAChC,gCAAgC;QAChC,gCAAgC;QAChC,sCAAsC;QACtC,gBAAgB;QAChB,8BAA8B;QAC9B,qBAAqB;QACrB,qBAAqB;QACrB,qBAAqB;QACrB,qBAAqB;QACrB,4BAA4B;QAC5B,IAAI,CAAC,gBAAgB,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC,CAAC;QAEnC,OAAO,CAAC,GAAG,UAAU,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE;YACjC,MAAM,IAAI,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC;YAC3B,IAAI,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC,aAAa,CAAC,WAAW,EAAE,EAAE,IAAI,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,EAAE;gBACjG,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC,aAAa,CAAC,QAAQ,EAAE,EAAE,IAAI,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,EAAE,EAAE;gBACpG,+DAA+D;gBAC/D,+DAA+D;gBAC/D,gBAAgB;gBAChB,SAAS;aACV;YACD,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAChC,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SAC1C;IACH,CAAC;IAED;;;;;;;;;;OAUG;IACH,gBAAgB,CAAC,KAAa,EAAE,IAA+B;QAC7D,IAAI,IAAI,CAAC,mBAAmB,CAAC,MAAM,EAAE;YACnC,MAAM,WAAW,GAAG,IAAI,CAAC,mBAAmB,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;YACpD,IAAI,WAAW,IAAI,KAAK,GAAG,WAAW,EAAE;gBACtC,OAAO,CAAC,KAAK,CAAC,6BAA6B,KAAK,4BAA4B,WAAW,QAAQ,IAAI,EAAE,CAAC,CAAC;gBACvG,KAAK,GAAG,WAAW,CAAC;aACrB;SACF;QACD,IAAI,IAAI,CAAC,eAAe,CAAC,MAAM,GAAG,KAAK,EAAE;YACvC,OAAO,CAAC,KAAK,CAAC,4DAA4D,IAAI,EAAE,CAAC,CAAC;YAClF,KAAK,GAAG,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC;SACrC;QACD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE;YACpD,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,KAAK,CAAC,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;SACzG;QACD,IAAI,CAAC,eAAe,CAAC,MAAM,GAAG,KAAK,CAAC;IACtC,CAAC;IAED,MAAM,CAAC,cAAc,CAAC,MAAkC,EAAE,MAAkC;QAC1F,OAAO,MAAM,CAAC,QAAQ,KAAK,MAAM,CAAC,QAAQ,IAAI,MAAM,CAAC,YAAY,KAAK,MAAM,CAAC,YAAY;YACrF,MAAM,CAAC,UAAU,KAAK,MAAM,CAAC,UAAU,CAAC;IAC9C,CAAC;IAED,MAAM,CAAC,cAAc,CAAC,IAAY,EAAE,uBAAgC;QAClE,OAAO,uBAAuB,IAAI,OAAO,CAAC,iBAAiB,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC;IACjF,CAAC;IAED,MAAM,CAAC,WAAW,CAAC,UAAkB;QACnC,IAAI,UAAU,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE;YAClC,OAAO,OAAO,CAAC;SAChB;QACD,IAAI,UAAU,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,UAAU,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE;YAC1E,OAAO,SAAS,CAAC;SAClB;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,CAAC,oBAAoB,CAAC,KAAiC;QAC3D,OAAO,KAAK,CAAC,GAAG,KAAK,kBAAkB,CAAC;IAC1C,CAAC;IAED,MAAM,CAAC,iBAAiB,CACpB,KAA+C,EAAE,YAA+C;QAClG,MAAM,aAAa,GAAG,YAAY,CAAC,WAAW,CAAC,qBAAqB,CAAC;QACrE,IAAI,aAAa,EAAE;YACjB,OAAO;SACR;QACD,IAAI,uBAAuB,GAAgB,IAAI,CAAC;QAChD,IAAI,CAAC,GAAG,CAAC,CAAC;QACV,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE;YACrC,MAAM,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YACjC,MAAM,kBAAkB,GAAG,iBAAiB,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;YACzE,IAAI,kBAAkB;gBAClB,CAAC,iBAAiB,CAAC,cAAc,CAAC,KAAK,CAAC,YAAY,EAAE,YAAY,CAAC,WAAW,CAAC,0BAA0B,CAAC,EAAE;gBAC9G,SAAS;aACV;YACD,MAAM,eAAe,GAAG,kBAAkB,CAAC,CAAC,CAAC,iBAAiB,CAAC,WAAW,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;YACtG,IAAI,uBAAuB,IAAI,uBAAuB,KAAK,eAAe,EAAE;gBAC1E,SAAS;aACV;YACD,uBAAuB,GAAG,eAAe,CAAC;YAC1C,KAAK,CAAC,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;SACvB;QACD,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;IACnB,CAAC;CACF","sourcesContent":["// Copyright 2023 The Chromium Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style license that can be\n// found in the LICENSE file.\n\nimport type * as Protocol from '../../../generated/protocol.js';\nimport type * as CPUProfile from '../../cpu_profile/cpu_profile.js';\nimport * as Types from '../types/types.js';\n\nimport {millisecondsToMicroseconds} from './Timing.js';\nimport {makeProfileCall, mergeEventsInOrder} from './Trace.js';\n\n/**\n * This is a helper that integrates CPU profiling data coming in the\n * shape of samples, with trace events. Samples indicate what the JS\n * stack trace looked at a given point in time, but they don't have\n * duration. The SamplesIntegrator task is to make an approximation\n * of what the duration of each JS call was, given the sample data and\n * given the trace events profiled during that time. At the end of its\n * execution, the SamplesIntegrator returns an array of ProfileCalls\n * (under SamplesIntegrator::buildProfileCalls()), which\n * represent JS calls, with a call frame and duration. These calls have\n * the shape of a complete trace events and can be treated as flame\n * chart entries in the timeline.\n *\n * The approach to build the profile calls consists in tracking the\n * current stack as the following events happen (in order):\n * 1. A sample was done.\n * 2. A trace event started.\n * 3. A trace event ended.\n * Depending on the event and on the data that's coming with it the\n * stack is updated by adding or removing JS calls to it and updating\n * the duration of the calls in the tracking stack.\n *\n * note: Although this approach has been implemented since long ago, and\n * is relatively efficent (adds a complexity over the trace parsing of\n * O(n) where n is the number of samples) it has proven to be faulty.\n * It might be worthwhile experimenting with improvements or with a\n * completely different approach. Improving the approach is tracked in\n * crbug.com/1417439\n */\nexport class SamplesIntegrator {\n  /**\n   * The result of runing the samples integrator. Holds the JS calls\n   * with their approximated duration after integrating samples into the\n   * trace event tree.\n   */\n  #constructedProfileCalls: Types.TraceEvents.SyntheticProfileCall[] = [];\n  /**\n   * tracks the state of the JS stack at each point in time to update\n   * the profile call durations as new events arrive. This doesn't only\n   * happen with new profile calls (in which case we would compare the\n   * stack in them) but also with trace events (in which case we would\n   * update the duration of the events we are tracking at the moment).\n   */\n  #currentJSStack: Types.TraceEvents.SyntheticProfileCall[] = [];\n  /**\n   * Process holding the CPU profile and trace events.\n   */\n  #processId: Types.TraceEvents.ProcessID;\n  /**\n   * Thread holding the CPU profile and trace events.\n   */\n  #threadId: Types.TraceEvents.ThreadID;\n  /**\n   * Tracks the depth of the JS stack at the moment a trace event starts\n   * or ends. It is assumed that for the duration of a trace event, the\n   * JS stack's depth cannot decrease, since JS calls that started\n   * before a trace event cannot end during the trace event. So as trace\n   * events arrive, we store the \"locked\" amount of JS frames that were\n   * in the stack before the event came.\n   */\n  #lockedJsStackDepth: number[] = [];\n  /**\n   * Used to keep track when samples should be integrated even if they\n   * are not children of invocation trace events. This is useful in\n   * cases where we can be missing the start of JS invocation events if\n   * we start tracing half-way through.\n   */\n  #fakeJSInvocation = false;\n  /**\n   * The parsed CPU profile, holding the tree hierarchy of JS frames and\n   * the sample data.\n   */\n  #profileModel: CPUProfile.CPUProfileDataModel.CPUProfileDataModel;\n  /**\n   * Because GC nodes don't have a stack, we artificially add a stack to\n   * them which corresponds to that of the previous sample. This map\n   * tracks which node is used for the stack of a GC call.\n   * Note that GC samples are not shown in the flamechart, however they\n   * are used during the construction of for profile calls, as we can\n   * infer information about the duration of the executed code when a\n   * GC node is sampled.\n   */\n  #nodeForGC = new Map<Types.TraceEvents.SyntheticProfileCall, CPUProfile.ProfileTreeModel.ProfileNode>();\n\n  #engineConfig: Types.Configuration.Configuration;\n\n  constructor(\n      profileModel: CPUProfile.CPUProfileDataModel.CPUProfileDataModel, pid: Types.TraceEvents.ProcessID,\n      tid: Types.TraceEvents.ThreadID, configuration?: Types.Configuration.Configuration) {\n    this.#profileModel = profileModel;\n    this.#threadId = tid;\n    this.#processId = pid;\n    this.#engineConfig = configuration || Types.Configuration.DEFAULT;\n  }\n\n  buildProfileCalls(traceEvents: Types.TraceEvents.TraceEventData[]): Types.TraceEvents.SyntheticProfileCall[] {\n    const mergedEvents = mergeEventsInOrder(traceEvents, this.callsFromProfileSamples());\n    const stack = [];\n    for (let i = 0; i < mergedEvents.length; i++) {\n      const event = mergedEvents[i];\n      // Because instant trace events have no duration, they don't provide\n      // useful information for possible changes in the duration of calls\n      // in the JS stack.\n      if (event.ph === Types.TraceEvents.Phase.INSTANT) {\n        continue;\n      }\n      if (stack.length === 0) {\n        if (Types.TraceEvents.isProfileCall(event)) {\n          this.#onProfileCall(event);\n          continue;\n        }\n        stack.push(event);\n        this.#onTraceEventStart(event);\n        continue;\n      }\n\n      const parentEvent = stack.at(-1);\n      if (parentEvent === undefined) {\n        continue;\n      }\n      const begin = event.ts;\n      const parentBegin = parentEvent.ts;\n      const parentDuration = parentEvent.dur || 0;\n      const parentEnd = parentBegin + parentDuration;\n\n      const startsAfterParent = begin >= parentEnd;\n      if (startsAfterParent) {\n        this.#onTraceEventEnd(parentEvent);\n        stack.pop();\n        i--;\n        continue;\n      }\n      if (Types.TraceEvents.isProfileCall(event)) {\n        this.#onProfileCall(event, parentEvent);\n        continue;\n      }\n      this.#onTraceEventStart(event);\n      stack.push(event);\n    }\n    while (stack.length) {\n      const last = stack.pop();\n      if (last) {\n        this.#onTraceEventEnd(last);\n      }\n    }\n    return this.#constructedProfileCalls;\n  }\n\n  #onTraceEventStart(event: Types.TraceEvents.TraceEventData): void {\n    // Top level events cannot be nested into JS frames so we reset\n    // the stack when we find one.\n    if (event.name === Types.TraceEvents.KnownEventName.RunMicrotasks ||\n        event.name === Types.TraceEvents.KnownEventName.RunTask) {\n      this.#lockedJsStackDepth = [];\n      this.#truncateJSStack(0, event.ts);\n      this.#fakeJSInvocation = false;\n    }\n\n    if (this.#fakeJSInvocation) {\n      this.#truncateJSStack(this.#lockedJsStackDepth.pop() || 0, event.ts);\n      this.#fakeJSInvocation = false;\n    }\n    this.#extractStackTrace(event);\n    // Keep track of the call frames in the stack before the event\n    // happened. For the duration of this event, these frames cannot\n    // change (none can be terminated before this event finishes).\n    //\n    // Also, every frame that is opened after this event, is considered\n    // to be a descendant of the event. So once the event finishes, the\n    // frames that were opened after it, need to be closed (see\n    // onEndEvent).\n    //\n    // TODO(crbug.com/1417439):\n    // The assumption that every frame opened after an event is a\n    // descendant of the event is incorrect. For example, a JS call that\n    // parents a trace event might have been sampled after the event was\n    // dispatched. In this case the JS call would be discarded if this\n    // event isn't an invocation event, otherwise the call will be\n    // considered a child of the event. In both cases, the result would\n    // be incorrect.\n    this.#lockedJsStackDepth.push(this.#currentJSStack.length);\n  }\n\n  #onProfileCall(event: Types.TraceEvents.SyntheticProfileCall, parent?: Types.TraceEvents.TraceEventData): void {\n    if ((parent && Types.TraceEvents.isJSInvocationEvent(parent)) || this.#fakeJSInvocation) {\n      this.#extractStackTrace(event);\n    } else if (Types.TraceEvents.isProfileCall(event) && this.#currentJSStack.length === 0) {\n      // Force JS Samples to show up even if we are not inside a JS\n      // invocation event, because we can be missing the start of JS\n      // invocation events if we start tracing half-way through. Pretend\n      // we have a top-level JS invocation event.\n      this.#fakeJSInvocation = true;\n      const stackDepthBefore = this.#currentJSStack.length;\n      this.#extractStackTrace(event);\n      this.#lockedJsStackDepth.push(stackDepthBefore);\n    }\n  }\n\n  #onTraceEventEnd(event: Types.TraceEvents.TraceEventData): void {\n    // Because the event has ended, any frames that happened after\n    // this event are terminated. Frames that are ancestors to this\n    // event are extended to cover its ending.\n    const endTime = Types.Timing.MicroSeconds(event.ts + (event.dur || 0));\n    this.#truncateJSStack(this.#lockedJsStackDepth.pop() || 0, endTime);\n  }\n\n  /**\n   * Builds the initial calls with no duration from samples. Their\n   * purpose is to be merged with the trace event array being parsed so\n   * that they can be traversed in order with them and their duration\n   * can be updated as the SampleIntegrator callbacks are invoked.\n   */\n  callsFromProfileSamples(): Types.TraceEvents.SyntheticProfileCall[] {\n    const samples = this.#profileModel.samples;\n    const timestamps = this.#profileModel.timestamps;\n    if (!samples) {\n      return [];\n    }\n    const calls: Types.TraceEvents.SyntheticProfileCall[] = [];\n    let prevNode;\n    for (let i = 0; i < samples.length; i++) {\n      const node = this.#profileModel.nodeByIndex(i);\n      const timestamp = millisecondsToMicroseconds(Types.Timing.MilliSeconds(timestamps[i]));\n      if (!node) {\n        continue;\n      }\n      const call = makeProfileCall(node, timestamp, this.#processId, this.#threadId);\n      calls.push(call);\n      if (node.id === this.#profileModel.gcNode?.id && prevNode) {\n        // GC samples have no stack, so we just put GC node on top of the\n        // last recorded sample. Cache the previous sample for future\n        // reference.\n        this.#nodeForGC.set(call, prevNode);\n        continue;\n      }\n      prevNode = node;\n    }\n    return calls;\n  }\n\n  #getStackTraceFromProfileCall(profileCall: Types.TraceEvents.SyntheticProfileCall):\n      Types.TraceEvents.SyntheticProfileCall[] {\n    let node = this.#profileModel.nodeById(profileCall.nodeId);\n    const isGarbageCollection = node?.id === this.#profileModel.gcNode?.id;\n    if (isGarbageCollection) {\n      // Because GC don't have a stack, we use the stack of the previous\n      // sample.\n      node = this.#nodeForGC.get(profileCall) || null;\n    }\n    if (!node) {\n      return [];\n    }\n    // `node.depth` is 0 based, so to set the size of the array we need\n    // to add 1 to its value.\n    const callFrames = new Array<Types.TraceEvents.SyntheticProfileCall>(node.depth + 1 + Number(isGarbageCollection));\n    // Add the stack trace in reverse order (bottom first).\n    let i = callFrames.length - 1;\n    if (isGarbageCollection) {\n      // Place the garbage collection call frame on top of the stack.\n      callFrames[i--] = profileCall;\n    }\n    while (node) {\n      callFrames[i--] = makeProfileCall(node, profileCall.ts, this.#processId, this.#threadId);\n      node = node.parent;\n    }\n    return callFrames;\n  }\n\n  /**\n   * Update tracked stack using this event's call stack.\n   */\n  #extractStackTrace(event: Types.TraceEvents.TraceEventData): void {\n    const stackTrace =\n        Types.TraceEvents.isProfileCall(event) ? this.#getStackTraceFromProfileCall(event) : this.#currentJSStack;\n    SamplesIntegrator.filterStackFrames(stackTrace, this.#engineConfig);\n\n    const endTime = event.ts + (event.dur || 0);\n    const minFrames = Math.min(stackTrace.length, this.#currentJSStack.length);\n    let i;\n    // Merge a sample's stack frames with the stack frames we have\n    // so far if we detect they are equivalent.\n    // Graphically\n    // This:\n    // Current stack trace       Sample\n    // [-------A------]          [A]\n    // [-------B------]          [B]\n    // [-------C------]          [C]\n    //                ^ t = x1    ^ t = x2\n\n    // Becomes this:\n    // New stack trace after merge\n    // [--------A-------]\n    // [--------B-------]\n    // [--------C-------]\n    //                  ^ t = x2\n    for (i = this.#lockedJsStackDepth.at(-1) || 0; i < minFrames; ++i) {\n      const newFrame = stackTrace[i].callFrame;\n      const oldFrame = this.#currentJSStack[i].callFrame;\n      if (!SamplesIntegrator.framesAreEqual(newFrame, oldFrame)) {\n        break;\n      }\n      // Scoot the right edge of this callFrame to the right\n      this.#currentJSStack[i].dur =\n          Types.Timing.MicroSeconds(Math.max(this.#currentJSStack[i].dur || 0, endTime - this.#currentJSStack[i].ts));\n    }\n\n    // If there are call frames in the sample that differ with the stack\n    // we have, update the stack, but keeping the common frames in place\n    // Graphically\n    // This:\n    // Current stack trace       Sample\n    // [-------A------]          [A]\n    // [-------B------]          [B]\n    // [-------C------]          [C]\n    // [-------D------]          [E]\n    //                ^ t = x1    ^ t = x2\n    // Becomes this:\n    // New stack trace after merge\n    // [--------A-------]\n    // [--------B-------]\n    // [--------C-------]\n    //                [E]\n    //                  ^ t = x2\n    this.#truncateJSStack(i, event.ts);\n\n    for (; i < stackTrace.length; ++i) {\n      const call = stackTrace[i];\n      if (call.nodeId === this.#profileModel.programNode?.id || call.nodeId === this.#profileModel.root?.id ||\n          call.nodeId === this.#profileModel.idleNode?.id || call.nodeId === this.#profileModel.gcNode?.id) {\n        // Skip (root), (program) and (idle) frames, since this are not\n        // relevant for web profiling and we don't want to show them in\n        // the timeline.\n        continue;\n      }\n      this.#currentJSStack.push(call);\n      this.#constructedProfileCalls.push(call);\n    }\n  }\n\n  /**\n   * When a call stack that differs from the one we are tracking has\n   * been detected in the samples, the latter is \"truncated\" by\n   * setting the ending time of its call frames and removing the top\n   * call frames that aren't shared with the new call stack. This way,\n   * we can update the tracked stack with the new call frames on top.\n   * @param depth the amount of call frames from bottom to top that\n   * should be kept in the tracking stack trace. AKA amount of shared\n   * call frames between two stacks.\n   * @param time the new end of the call frames in the stack.\n   */\n  #truncateJSStack(depth: number, time: Types.Timing.MicroSeconds): void {\n    if (this.#lockedJsStackDepth.length) {\n      const lockedDepth = this.#lockedJsStackDepth.at(-1);\n      if (lockedDepth && depth < lockedDepth) {\n        console.error(`Child stack is shallower (${depth}) than the parent stack (${lockedDepth}) at ${time}`);\n        depth = lockedDepth;\n      }\n    }\n    if (this.#currentJSStack.length < depth) {\n      console.error(`Trying to truncate higher than the current stack size at ${time}`);\n      depth = this.#currentJSStack.length;\n    }\n    for (let k = 0; k < this.#currentJSStack.length; ++k) {\n      this.#currentJSStack[k].dur = Types.Timing.MicroSeconds(Math.max(time - this.#currentJSStack[k].ts, 0));\n    }\n    this.#currentJSStack.length = depth;\n  }\n\n  static framesAreEqual(frame1: Protocol.Runtime.CallFrame, frame2: Protocol.Runtime.CallFrame): boolean {\n    return frame1.scriptId === frame2.scriptId && frame1.functionName === frame2.functionName &&\n        frame1.lineNumber === frame2.lineNumber;\n  }\n\n  static showNativeName(name: string, runtimeCallStatsEnabled: boolean): boolean {\n    return runtimeCallStatsEnabled && Boolean(SamplesIntegrator.nativeGroup(name));\n  }\n\n  static nativeGroup(nativeName: string): 'Parse'|'Compile'|null {\n    if (nativeName.startsWith('Parse')) {\n      return 'Parse';\n    }\n    if (nativeName.startsWith('Compile') || nativeName.startsWith('Recompile')) {\n      return 'Compile';\n    }\n    return null;\n  }\n\n  static isNativeRuntimeFrame(frame: Protocol.Runtime.CallFrame): boolean {\n    return frame.url === 'native V8Runtime';\n  }\n\n  static filterStackFrames(\n      stack: Types.TraceEvents.SyntheticProfileCall[], engineConfig: Types.Configuration.Configuration): void {\n    const showAllEvents = engineConfig.experiments.timelineShowAllEvents;\n    if (showAllEvents) {\n      return;\n    }\n    let previousNativeFrameName: string|null = null;\n    let j = 0;\n    for (let i = 0; i < stack.length; ++i) {\n      const frame = stack[i].callFrame;\n      const nativeRuntimeFrame = SamplesIntegrator.isNativeRuntimeFrame(frame);\n      if (nativeRuntimeFrame &&\n          !SamplesIntegrator.showNativeName(frame.functionName, engineConfig.experiments.timelineV8RuntimeCallStats)) {\n        continue;\n      }\n      const nativeFrameName = nativeRuntimeFrame ? SamplesIntegrator.nativeGroup(frame.functionName) : null;\n      if (previousNativeFrameName && previousNativeFrameName === nativeFrameName) {\n        continue;\n      }\n      previousNativeFrameName = nativeFrameName;\n      stack[j++] = stack[i];\n    }\n    stack.length = j;\n  }\n}\n"]}

package/models/trace/helpers/Timing.d.ts

@@ -0,0 +1,26 @@
+import * as Types from '../types/types.js';
+export declare const millisecondsToMicroseconds: (value: Types.Timing.MilliSeconds) => Types.Timing.MicroSeconds;
+export declare const secondsToMilliseconds: (value: Types.Timing.Seconds) => Types.Timing.MilliSeconds;
+export declare const secondsToMicroseconds: (value: Types.Timing.Seconds) => Types.Timing.MicroSeconds;
+export declare const microSecondsToMilliseconds: (value: Types.Timing.MicroSeconds) => Types.Timing.MilliSeconds;
+export declare const microSecondsToSeconds: (value: Types.Timing.MicroSeconds) => Types.Timing.Seconds;
+export declare function detectBestTimeUnit(timeInMicroseconds: Types.Timing.MicroSeconds): Types.Timing.TimeUnit;
+interface FormatOptions extends Intl.NumberFormatOptions {
+    format?: Types.Timing.TimeUnit;
+}
+export declare function formatMicrosecondsTime(timeInMicroseconds: Types.Timing.MicroSeconds, opts?: FormatOptions): string;
+export declare function timeStampForEventAdjustedByClosestNavigation(event: Types.TraceEvents.TraceEventData, traceBounds: Types.Timing.TraceWindowMicroSeconds, navigationsByNavigationId: Map<string, Types.TraceEvents.TraceEventNavigationStart>, navigationsByFrameId: Map<string, Types.TraceEvents.TraceEventNavigationStart[]>): Types.Timing.MicroSeconds;
+export interface EventTimingsData<ValueType extends Types.Timing.MicroSeconds | Types.Timing.MilliSeconds | Types.Timing.Seconds> {
+    startTime: ValueType;
+    endTime: ValueType;
+    duration: ValueType;
+    selfTime: ValueType;
+}
+export declare function eventTimingsMicroSeconds(event: Types.TraceEvents.TraceEventData): EventTimingsData<Types.Timing.MicroSeconds>;
+export declare function eventTimingsMilliSeconds(event: Types.TraceEvents.TraceEventData): EventTimingsData<Types.Timing.MilliSeconds>;
+export declare function eventTimingsSeconds(event: Types.TraceEvents.TraceEventData): EventTimingsData<Types.Timing.Seconds>;
+export declare function traceWindowMilliSeconds(bounds: Types.Timing.TraceWindowMicroSeconds): Types.Timing.TraceWindowMilliSeconds;
+export declare function traceWindowMillisecondsToMicroSeconds(bounds: Types.Timing.TraceWindowMilliSeconds): Types.Timing.TraceWindowMicroSeconds;
+export declare function traceWindowFromMilliSeconds(min: Types.Timing.MilliSeconds, max: Types.Timing.MilliSeconds): Types.Timing.TraceWindowMicroSeconds;
+export declare function traceWindowFromMicroSeconds(min: Types.Timing.MicroSeconds, max: Types.Timing.MicroSeconds): Types.Timing.TraceWindowMicroSeconds;
+export {};

package/models/trace/helpers/Timing.js

@@ -0,0 +1,162 @@
+// Copyright 2022 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.
+import * as Platform from '../../../core/platform/platform.js';
+import * as Types from '../types/types.js';
+import { getNavigationForTraceEvent } from './Trace.js';
+export const millisecondsToMicroseconds = (value) => Types.Timing.MicroSeconds(value * 1000);
+export const secondsToMilliseconds = (value) => Types.Timing.MilliSeconds(value * 1000);
+export const secondsToMicroseconds = (value) => millisecondsToMicroseconds(secondsToMilliseconds(value));
+export const microSecondsToMilliseconds = (value) => Types.Timing.MilliSeconds(value / 1000);
+export const microSecondsToSeconds = (value) => Types.Timing.Seconds(value / 1000 / 1000);
+export function detectBestTimeUnit(timeInMicroseconds) {
+    if (timeInMicroseconds < 1000) {
+        return 0 /* Types.Timing.TimeUnit.MICROSECONDS */;
+    }
+    const timeInMilliseconds = timeInMicroseconds / 1000;
+    if (timeInMilliseconds < 1000) {
+        return 1 /* Types.Timing.TimeUnit.MILLISECONDS */;
+    }
+    const timeInSeconds = timeInMilliseconds / 1000;
+    if (timeInSeconds < 60) {
+        return 2 /* Types.Timing.TimeUnit.SECONDS */;
+    }
+    return 3 /* Types.Timing.TimeUnit.MINUTES */;
+}
+const defaultFormatOptions = {
+    style: 'unit',
+    unit: 'millisecond',
+    unitDisplay: 'narrow',
+};
+// Create a bunch of common formatters up front, so that we're not creating
+// them repeatedly during rendering.
+const serialize = (value) => JSON.stringify(value);
+const formatterFactory = (key) => {
+    // If we pass undefined as the locale, that achieves two things:
+    // 1. Avoids us referencing window.navigatior to fetch the locale, which is
+    //    useful given long term we would like this engine to run in NodeJS
+    //    environments.
+    // 2. Will cause the formatter to fallback to the locale of the system, which
+    //    is likely going to be the most accurate one to use anyway.
+    return new Intl.NumberFormat(undefined, key ? JSON.parse(key) : {});
+};
+const formatters = new Map();
+// Microsecond Formatter.
+Platform.MapUtilities.getWithDefault(formatters, serialize({ style: 'decimal' }), formatterFactory);
+// Millisecond Formatter
+Platform.MapUtilities.getWithDefault(formatters, serialize(defaultFormatOptions), formatterFactory);
+// Second Formatter
+Platform.MapUtilities.getWithDefault(formatters, serialize({ ...defaultFormatOptions, unit: 'second' }), formatterFactory);
+// Minute Formatter
+Platform.MapUtilities.getWithDefault(formatters, serialize({ ...defaultFormatOptions, unit: 'minute' }), formatterFactory);
+export function formatMicrosecondsTime(timeInMicroseconds, opts = {}) {
+    if (!opts.format) {
+        opts.format = detectBestTimeUnit(timeInMicroseconds);
+    }
+    const timeInMilliseconds = timeInMicroseconds / 1000;
+    const timeInSeconds = timeInMilliseconds / 1000;
+    const formatterOpts = { ...defaultFormatOptions, ...opts };
+    switch (opts.format) {
+        case 0 /* Types.Timing.TimeUnit.MICROSECONDS */: {
+            const formatter = Platform.MapUtilities.getWithDefault(formatters, serialize({ style: 'decimal' }), formatterFactory);
+            return `${formatter.format(timeInMicroseconds)}μs`;
+        }
+        case 1 /* Types.Timing.TimeUnit.MILLISECONDS */: {
+            const formatter = Platform.MapUtilities.getWithDefault(formatters, serialize(formatterOpts), formatterFactory);
+            return formatter.format(timeInMilliseconds);
+        }
+        case 2 /* Types.Timing.TimeUnit.SECONDS */: {
+            const formatter = Platform.MapUtilities.getWithDefault(formatters, serialize({ ...formatterOpts, unit: 'second' }), formatterFactory);
+            return formatter.format(timeInSeconds);
+        }
+        default: {
+            // Switch to mins & seconds.
+            const minuteFormatter = Platform.MapUtilities.getWithDefault(formatters, serialize({ ...formatterOpts, unit: 'minute' }), formatterFactory);
+            const secondFormatter = Platform.MapUtilities.getWithDefault(formatters, serialize({ ...formatterOpts, unit: 'second' }), formatterFactory);
+            const timeInMinutes = timeInSeconds / 60;
+            const [mins, divider, fraction] = minuteFormatter.formatToParts(timeInMinutes);
+            let seconds = 0;
+            if (divider && fraction) {
+                // Convert the fraction value (a string) to the nearest second.
+                seconds = Math.round(Number(`0.${fraction.value}`) * 60);
+            }
+            return `${minuteFormatter.format(Number(mins.value))} ${secondFormatter.format(seconds)}`;
+        }
+    }
+}
+export function timeStampForEventAdjustedByClosestNavigation(event, traceBounds, navigationsByNavigationId, navigationsByFrameId) {
+    let eventTimeStamp = event.ts - traceBounds.min;
+    if (event.args?.data?.navigationId) {
+        const navigationForEvent = navigationsByNavigationId.get(event.args.data.navigationId);
+        if (navigationForEvent) {
+            eventTimeStamp = event.ts - navigationForEvent.ts;
+        }
+    }
+    else if (event.args?.data?.frame) {
+        const navigationForEvent = getNavigationForTraceEvent(event, event.args.data.frame, navigationsByFrameId);
+        if (navigationForEvent) {
+            eventTimeStamp = event.ts - navigationForEvent.ts;
+        }
+    }
+    return Types.Timing.MicroSeconds(eventTimeStamp);
+}
+export function eventTimingsMicroSeconds(event) {
+    return {
+        startTime: event.ts,
+        endTime: Types.Timing.MicroSeconds(event.ts + (event.dur || Types.Timing.MicroSeconds(0))),
+        duration: Types.Timing.MicroSeconds(event.dur || 0),
+        // TODO(crbug.com/1434599): Implement selfTime calculation for events
+        // from the new engine.
+        selfTime: Types.TraceEvents.isSyntheticTraceEntry(event) ? Types.Timing.MicroSeconds(event.selfTime || 0) :
+            Types.Timing.MicroSeconds(event.dur || 0),
+    };
+}
+export function eventTimingsMilliSeconds(event) {
+    const microTimes = eventTimingsMicroSeconds(event);
+    return {
+        startTime: microSecondsToMilliseconds(microTimes.startTime),
+        endTime: microSecondsToMilliseconds(microTimes.endTime),
+        duration: microSecondsToMilliseconds(microTimes.duration),
+        selfTime: microSecondsToMilliseconds(microTimes.selfTime),
+    };
+}
+export function eventTimingsSeconds(event) {
+    const microTimes = eventTimingsMicroSeconds(event);
+    return {
+        startTime: microSecondsToSeconds(microTimes.startTime),
+        endTime: microSecondsToSeconds(microTimes.endTime),
+        duration: microSecondsToSeconds(microTimes.duration),
+        selfTime: microSecondsToSeconds(microTimes.selfTime),
+    };
+}
+export function traceWindowMilliSeconds(bounds) {
+    return {
+        min: microSecondsToMilliseconds(bounds.min),
+        max: microSecondsToMilliseconds(bounds.max),
+        range: microSecondsToMilliseconds(bounds.range),
+    };
+}
+export function traceWindowMillisecondsToMicroSeconds(bounds) {
+    return {
+        min: millisecondsToMicroseconds(bounds.min),
+        max: millisecondsToMicroseconds(bounds.max),
+        range: millisecondsToMicroseconds(bounds.range),
+    };
+}
+export function traceWindowFromMilliSeconds(min, max) {
+    const traceWindow = {
+        min: millisecondsToMicroseconds(min),
+        max: millisecondsToMicroseconds(max),
+        range: Types.Timing.MicroSeconds(millisecondsToMicroseconds(max) - millisecondsToMicroseconds(min)),
+    };
+    return traceWindow;
+}
+export function traceWindowFromMicroSeconds(min, max) {
+    const traceWindow = {
+        min,
+        max,
+        range: Types.Timing.MicroSeconds(max - min),
+    };
+    return traceWindow;
+}
+//# sourceMappingURL=Timing.js.map