profile.mjs 37.9 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
// Copyright 2009 the V8 project authors. All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
//       notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
//       copyright notice, this list of conditions and the following
//       disclaimer in the documentation and/or other materials provided
//       with the distribution.
//     * Neither the name of Google Inc. nor the names of its
//       contributors may be used to endorse or promote products derived
//       from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

28
import { CodeMap, CodeEntry } from "./codemap.mjs";
29
import { ConsArray } from "./consarray.mjs";
30
import { WebInspector } from "./sourcemap.mjs";
31

32
// Used to associate log entries with source positions in scripts.
33 34
// TODO: move to separate modules
export class SourcePosition {
35 36 37 38 39 40 41
  script = null;
  line = -1;
  column = -1;
  entries = [];
  isFunction = false;
  originalPosition = undefined;

42 43 44 45 46
  constructor(script, line, column) {
    this.script = script;
    this.line = line;
    this.column = column;
  }
47

48 49 50
  addEntry(entry) {
    this.entries.push(entry);
  }
51 52

  toString() {
53
    return `${this.script.name}:${this.line}:${this.column}`;
54
  }
55 56 57 58 59 60 61 62 63 64 65

  get functionPosition() {
    // TODO(cbruni)
    return undefined;
  }

  get toolTipDict() {
    return {
      title: this.toString(),
      __this__: this,
      script: this.script,
66
      entries: this.entries,
67 68
    }
  }
69 70 71
}

export class Script {
72
  url;
73
  source;
74
  name;
75
  sourcePosition = undefined;
76 77
  // Map<line, Map<column, SourcePosition>>
  lineToColumn = new Map();
78
  _entries = [];
79
  _sourceMapState = "unknown";
80 81

  constructor(id) {
82
    this.id = id;
83 84 85
    this.sourcePositions = [];
  }

86 87 88
  update(url, source) {
    this.url = url;
    this.name = Script.getShortestUniqueName(url, this);
89 90 91
    this.source = source;
  }

92 93 94 95
  get length() {
    return this.source.length;
  }

96 97 98 99
  get entries() {
    return this._entries;
  }

100 101 102 103 104 105 106 107
  get startLine() {
    return this.sourcePosition?.line ?? 1;
  }

  get sourceMapState() {
    return this._sourceMapState;
  }

108 109 110 111 112
  findFunctionSourcePosition(sourcePosition) {
    // TODO(cbruni) implmenent
    return undefined;
  }

113 114 115
  addSourcePosition(line, column, entry) {
    let sourcePosition = this.lineToColumn.get(line)?.get(column);
    if (sourcePosition === undefined) {
116
      sourcePosition = new SourcePosition(this, line, column,)
117
      this._addSourcePosition(line, column, sourcePosition);
118
    }
119 120 121 122
    if (entry.entry?.type == "Script") {
      // Mark the source position of scripts, for inline scripts which
      this.sourcePosition = sourcePosition;
    }
123
    sourcePosition.addEntry(entry);
124
    this._entries.push(entry);
125 126 127
    return sourcePosition;
  }

128
  _addSourcePosition(line, column, sourcePosition) {
129 130 131 132 133 134 135 136 137 138
    let columnToSourcePosition;
    if (this.lineToColumn.has(line)) {
      columnToSourcePosition = this.lineToColumn.get(line);
    } else {
      columnToSourcePosition = new Map();
      this.lineToColumn.set(line, columnToSourcePosition);
    }
    this.sourcePositions.push(sourcePosition);
    columnToSourcePosition.set(column, sourcePosition);
  }
139

140
  toString() {
141
    return `Script(${this.id}): ${this.name}`;
142
  }
143

144 145 146 147 148 149 150
  get toolTipDict() {
    return {
      title: this.toString(),
      __this__: this,
      id: this.id,
      url: this.url,
      source: this.source,
151
      sourcePositions: this.sourcePositions
152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170
    }
  }

  static getShortestUniqueName(url, script) {
    const parts = url.split('/');
    const filename = parts[parts.length -1];
    const dict = this._dict ?? (this._dict = new Map());
    const matchingScripts = dict.get(filename);
    if (matchingScripts == undefined) {
      dict.set(filename, [script]);
      return filename;
    }
    // TODO: find shortest unique substring
    // Update all matching scripts to have a unique filename again.
    for (let matchingScript of matchingScripts) {
      matchingScript.name = script.url
    }
    matchingScripts.push(script);
    return url;
171
  }
172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232

  ensureSourceMapCalculated(sourceMapFetchPrefix=undefined) {
    if (this._sourceMapState !== "unknown") return;

    const sourceMapURLMatch =
        this.source.match(/\/\/# sourceMappingURL=(.*)\n/);
    if (!sourceMapURLMatch) {
      this._sourceMapState = "none";
      return;
    }

    this._sourceMapState = "loading";
    let sourceMapURL = sourceMapURLMatch[1];
    (async () => {
      try {
        let sourceMapPayload;
        try {
          sourceMapPayload = await fetch(sourceMapURL);
        } catch (e) {
          if (e instanceof TypeError && sourceMapFetchPrefix) {
            // Try again with fetch prefix.
            // TODO(leszeks): Remove the retry once the prefix is
            // configurable.
            sourceMapPayload =
                await fetch(sourceMapFetchPrefix + sourceMapURL);
          } else {
            throw e;
          }
        }
        sourceMapPayload = await sourceMapPayload.text();

        if (sourceMapPayload.startsWith(')]}')) {
          sourceMapPayload =
              sourceMapPayload.substring(sourceMapPayload.indexOf('\n'));
        }
        sourceMapPayload = JSON.parse(sourceMapPayload);
        const sourceMap =
            new WebInspector.SourceMap(sourceMapURL, sourceMapPayload);

        const startLine = this.startLine;
        for (const sourcePosition of this.sourcePositions) {
          const line = sourcePosition.line - startLine;
          const column = sourcePosition.column - 1;
          const mapping = sourceMap.findEntry(line, column);
          if (mapping) {
            sourcePosition.originalPosition = {
              source: new URL(mapping[2], sourceMapURL).href,
              line: mapping[3] + 1,
              column: mapping[4] + 1
            };
          } else {
            sourcePosition.originalPosition = {source: null, line:0, column:0};
          }
        }
        this._sourceMapState = "loaded";
      } catch (e) {
        console.error(e);
        this._sourceMapState = "failed";
      }
    })();
  }
233 234
}

235

236
class SourceInfo {
237 238 239 240 241 242 243
  script;
  start;
  end;
  positions;
  inlined;
  fns;
  disassemble;
244 245

  setSourcePositionInfo(script, startPos, endPos, sourcePositionTable, inliningPositions, inlinedFunctions) {
246 247 248 249 250 251 252
    this.script = script;
    this.start = startPos;
    this.end = endPos;
    this.positions = sourcePositionTable;
    this.inlined = inliningPositions;
    this.fns = inlinedFunctions;
  }
253 254 255 256

  setDisassemble(code) {
    this.disassemble = code;
  }
257 258 259 260

  getSourceCode() {
    return this.script.source?.substring(this.start, this.end);
  }
261 262
}

263 264 265 266 267 268
/**
 * Creates a profile object for processing profiling-related events
 * and calculating function execution times.
 *
 * @constructor
 */
269 270 271 272 273 274 275 276
export class Profile {
  codeMap_ = new CodeMap();
  topDownTree_ = new CallTree();
  bottomUpTree_ = new CallTree();
  c_entries_ = {};
  scripts_ = [];
  urlToScript_ = new Map();

277 278 279 280 281 282 283 284
  serializeVMSymbols() {
    let result = this.codeMap_.getAllStaticEntriesWithAddresses();
    result.concat(this.codeMap_.getAllLibraryEntriesWithAddresses())
    return result.map(([startAddress, codeEntry]) => {
      return [codeEntry.getName(), startAddress, startAddress + codeEntry.size]
    });
  }

285 286
  /**
   * Returns whether a function with the specified name must be skipped.
287
   * Should be overridden by subclasses.
288 289 290 291 292 293
   *
   * @param {string} name Function name.
   */
  skipThisFunction(name) {
    return false;
  }
294

295 296 297 298 299 300 301 302 303 304 305
  /**
   * Enum for profiler operations that involve looking up existing
   * code entries.
   *
   * @enum {number}
   */
  static Operation = {
    MOVE: 0,
    DELETE: 1,
    TICK: 2
  }
306

307 308 309 310 311 312 313
  /**
   * Enum for code state regarding its dynamic optimization.
   *
   * @enum {number}
   */
  static CodeState = {
    COMPILED: 0,
314
    IGNITION: 1,
315
    BASELINE: 2,
316 317
    TURBOPROP: 4,
    TURBOFAN: 5,
318 319
  }

320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336
  static VMState = {
    JS: 0,
    GC: 1,
    PARSER: 2,
    BYTECODE_COMPILER: 3,
    // TODO(cbruni): add BASELINE_COMPILER
    COMPILER: 4,
    OTHER: 5,
    EXTERNAL: 6,
    IDLE: 7,
  }

  static CodeType = {
    CPP: 0,
    SHARED_LIB: 1
  }

337 338 339 340 341 342 343 344 345
  /**
   * Parser for dynamic code optimization state.
   */
  static parseState(s) {
    switch (s) {
      case '':
        return this.CodeState.COMPILED;
      case '~':
        return this.CodeState.IGNITION;
346
      case '^':
347
        return this.CodeState.BASELINE;
348
      case '+':
349 350 351 352 353
        return this.CodeState.TURBOPROP;
      case '*':
        return this.CodeState.TURBOFAN;
    }
    throw new Error(`unknown code state: ${s}`);
354
  }
355

356 357 358 359 360
  static getKindFromState(state) {
    if (state === this.CodeState.COMPILED) {
      return "Builtin";
    } else if (state === this.CodeState.IGNITION) {
      return "Unopt";
361 362
    } else if (state === this.CodeState.BASELINE) {
      return "Baseline";
363 364 365 366 367 368 369 370
    } else if (state === this.CodeState.TURBOPROP) {
      return "Turboprop";
    } else if (state === this.CodeState.TURBOFAN) {
      return "Opt";
    }
    throw new Error(`unknown code state: ${state}`);
  }

371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392
  static vmStateString(state) {
    switch (state) {
      case this.VMState.JS:
        return 'JS';
      case this.VMState.GC:
        return 'GC';
      case this.VMState.PARSER:
        return 'Parse';
      case this.VMState.BYTECODE_COMPILER:
        return 'Compile Bytecode';
      case this.VMState.COMPILER:
        return 'Compile';
      case this.VMState.OTHER:
        return 'Other';
      case this.VMState.EXTERNAL:
        return 'External';
      case this.VMState.IDLE:
        return 'Idle';
    }
    return 'unknown';
  }

393 394 395 396 397 398 399 400 401 402 403 404
  /**
   * Called whenever the specified operation has failed finding a function
   * containing the specified address. Should be overriden by subclasses.
   * See the Profile.Operation enum for the list of
   * possible operations.
   *
   * @param {number} operation Operation.
   * @param {number} addr Address of the unknown code.
   * @param {number} opt_stackPos If an unknown address is encountered
   *     during stack strace processing, specifies a position of the frame
   *     containing the address.
   */
405
  handleUnknownCode(operation, addr, opt_stackPos) { }
406 407 408 409 410 411 412 413 414

  /**
   * Registers a library.
   *
   * @param {string} name Code entry name.
   * @param {number} startAddr Starting address.
   * @param {number} endAddr Ending address.
   */
  addLibrary(name, startAddr, endAddr) {
415
    const entry = new CodeEntry(endAddr - startAddr, name, 'SHARED_LIB');
416 417 418
    this.codeMap_.addLibrary(startAddr, entry);
    return entry;
  }
419

420 421 422 423 424 425 426 427
  /**
   * Registers statically compiled code entry.
   *
   * @param {string} name Code entry name.
   * @param {number} startAddr Starting address.
   * @param {number} endAddr Ending address.
   */
  addStaticCode(name, startAddr, endAddr) {
428
    const entry = new CodeEntry(endAddr - startAddr, name, 'CPP');
429 430 431
    this.codeMap_.addStaticCode(startAddr, entry);
    return entry;
  }
432

433 434 435 436 437 438 439 440 441
  /**
   * Registers dynamic (JIT-compiled) code entry.
   *
   * @param {string} type Code entry type.
   * @param {string} name Code entry name.
   * @param {number} start Starting address.
   * @param {number} size Code entry size.
   */
  addCode(type, name, timestamp, start, size) {
442
    const entry = new DynamicCodeEntry(size, type, name);
443 444 445
    this.codeMap_.addCode(start, entry);
    return entry;
  }
446

447 448 449 450 451 452 453 454 455 456 457 458 459
  /**
   * Registers dynamic (JIT-compiled) code entry.
   *
   * @param {string} type Code entry type.
   * @param {string} name Code entry name.
   * @param {number} start Starting address.
   * @param {number} size Code entry size.
   * @param {number} funcAddr Shared function object address.
   * @param {Profile.CodeState} state Optimization state.
   */
  addFuncCode(type, name, timestamp, start, size, funcAddr, state) {
    // As code and functions are in the same address space,
    // it is safe to put them in a single code map.
460
    let func = this.codeMap_.findDynamicEntryByStartAddress(funcAddr);
461 462 463 464 465 466 467
    if (!func) {
      func = new FunctionEntry(name);
      this.codeMap_.addCode(funcAddr, func);
    } else if (func.name !== name) {
      // Function object has been overwritten with a new one.
      func.name = name;
    }
468
    let entry = this.codeMap_.findDynamicEntryByStartAddress(start);
469 470 471 472 473 474 475 476 477 478 479 480 481 482 483
    if (entry) {
      if (entry.size === size && entry.func === func) {
        // Entry state has changed.
        entry.state = state;
      } else {
        this.codeMap_.deleteCode(start);
        entry = null;
      }
    }
    if (!entry) {
      entry = new DynamicFuncCodeEntry(size, type, func, state);
      this.codeMap_.addCode(start, entry);
    }
    return entry;
  }
484

485 486 487 488 489 490 491 492 493 494 495 496 497
  /**
   * Reports about moving of a dynamic code entry.
   *
   * @param {number} from Current code entry address.
   * @param {number} to New code entry address.
   */
  moveCode(from, to) {
    try {
      this.codeMap_.moveCode(from, to);
    } catch (e) {
      this.handleUnknownCode(Profile.Operation.MOVE, from);
    }
  }
498

499
  deoptCode(timestamp, code, inliningId, scriptOffset, bailoutType,
500
    sourcePositionText, deoptReasonText) {
501
  }
502 503 504 505 506 507 508 509

  /**
   * Reports about deletion of a dynamic code entry.
   *
   * @param {number} start Starting address.
   */
  deleteCode(start) {
    try {
510
      this.codeMap_.deleteCode(start);
511 512
    } catch (e) {
      this.handleUnknownCode(Profile.Operation.DELETE, start);
513 514 515
    }
  }

516 517 518
  /**
   * Adds source positions for given code.
   */
519
  addSourcePositions(start, scriptId, startPos, endPos, sourcePositionTable,
520
        inliningPositions, inlinedFunctions) {
521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541
    const script = this.getOrCreateScript(scriptId);
    const entry = this.codeMap_.findDynamicEntryByStartAddress(start);
    if (!entry) return;
    // Resolve the inlined functions list.
    if (inlinedFunctions.length > 0) {
      inlinedFunctions = inlinedFunctions.substring(1).split("S");
      for (let i = 0; i < inlinedFunctions.length; i++) {
        const funcAddr = parseInt(inlinedFunctions[i]);
        const func = this.codeMap_.findDynamicEntryByStartAddress(funcAddr);
        if (!func || func.funcId === undefined) {
          // TODO: fix
          console.warn(`Could not find function ${inlinedFunctions[i]}`);
          inlinedFunctions[i] = null;
        } else {
          inlinedFunctions[i] = func.funcId;
        }
      }
    } else {
      inlinedFunctions = [];
    }

542
    this.getOrCreateSourceInfo(entry).setSourcePositionInfo(
543 544
      script, startPos, endPos, sourcePositionTable, inliningPositions,
      inlinedFunctions);
545 546
  }

547 548
  addDisassemble(start, kind, disassemble) {
    const entry = this.codeMap_.findDynamicEntryByStartAddress(start);
549 550
    if (entry) this.getOrCreateSourceInfo(entry).setDisassemble(disassemble);
    return entry;
551 552 553 554 555 556
  }

  getOrCreateSourceInfo(entry) {
    return entry.source ?? (entry.source = new SourceInfo());
  }

557
  addScriptSource(id, url, source) {
558 559
    const script = this.getOrCreateScript(id);
    script.update(url, source);
560
    this.urlToScript_.set(url, script);
561 562
  }

563 564 565 566 567 568 569 570 571
  getOrCreateScript(id) {
    let script = this.scripts_[id];
    if (!script) {
      script = new Script(id);
      this.scripts_[id] = script;
    }
    return script;
  }

572 573
  getScript(url) {
    return this.urlToScript_.get(url);
574 575
  }

576 577 578 579 580 581 582 583 584 585 586
  /**
   * Reports about moving of a dynamic code entry.
   *
   * @param {number} from Current code entry address.
   * @param {number} to New code entry address.
   */
  moveFunc(from, to) {
    if (this.codeMap_.findDynamicEntryByStartAddress(from)) {
      this.codeMap_.moveCode(from, to);
    }
  }
587

588 589 590 591 592 593 594 595
  /**
   * Retrieves a code entry by an address.
   *
   * @param {number} addr Entry address.
   */
  findEntry(addr) {
    return this.codeMap_.findEntry(addr);
  }
596

597 598 599 600 601 602 603
  /**
   * Records a tick event. Stack must contain a sequence of
   * addresses starting with the program counter value.
   *
   * @param {Array<number>} stack Stack sample.
   */
  recordTick(time_ns, vmState, stack) {
604 605 606 607
    const {nameStack, entryStack} = this.resolveAndFilterFuncs_(stack);
    this.bottomUpTree_.addPath(nameStack);
    nameStack.reverse();
    this.topDownTree_.addPath(nameStack);
608
    return entryStack;
609
  }
610

611 612 613 614 615 616 617
  /**
   * Translates addresses into function names and filters unneeded
   * functions.
   *
   * @param {Array<number>} stack Stack sample.
   */
  resolveAndFilterFuncs_(stack) {
618 619
    const nameStack = [];
    const entryStack = [];
620 621 622
    let last_seen_c_function = '';
    let look_for_first_c_function = false;
    for (let i = 0; i < stack.length; ++i) {
623 624
      const pc = stack[i];
      const entry = this.codeMap_.findEntry(pc);
625
      if (entry) {
626
        entryStack.push(entry);
627
        const name = entry.getName();
628 629 630 631 632 633 634
        if (i === 0 && (entry.type === 'CPP' || entry.type === 'SHARED_LIB')) {
          look_for_first_c_function = true;
        }
        if (look_for_first_c_function && entry.type === 'CPP') {
          last_seen_c_function = name;
        }
        if (!this.skipThisFunction(name)) {
635
          nameStack.push(name);
636 637
        }
      } else {
638 639 640
        this.handleUnknownCode(Profile.Operation.TICK, pc, i);
        if (i === 0) nameStack.push("UNKNOWN");
        entryStack.push(pc);
641
      }
642 643
      if (look_for_first_c_function && i > 0 &&
          (!entry || entry.type !== 'CPP') && last_seen_c_function !== '') {
644 645 646 647 648
        if (this.c_entries_[last_seen_c_function] === undefined) {
          this.c_entries_[last_seen_c_function] = 0;
        }
        this.c_entries_[last_seen_c_function]++;
        look_for_first_c_function = false;  // Found it, we're done.
649 650
      }
    }
651
    return {nameStack, entryStack};
652 653
  }

654 655 656 657 658 659 660 661
  /**
   * Performs a BF traversal of the top down call graph.
   *
   * @param {function(CallTreeNode)} f Visitor function.
   */
  traverseTopDownTree(f) {
    this.topDownTree_.traverse(f);
  }
662

663 664 665 666 667 668 669 670
  /**
   * Performs a BF traversal of the bottom up call graph.
   *
   * @param {function(CallTreeNode)} f Visitor function.
   */
  traverseBottomUpTree(f) {
    this.bottomUpTree_.traverse(f);
  }
671

672 673 674 675 676 677 678 679 680
  /**
   * Calculates a top down profile for a node with the specified label.
   * If no name specified, returns the whole top down calls tree.
   *
   * @param {string} opt_label Node label.
   */
  getTopDownProfile(opt_label) {
    return this.getTreeProfile_(this.topDownTree_, opt_label);
  }
681

682 683 684 685 686 687 688 689
  /**
   * Calculates a bottom up profile for a node with the specified label.
   * If no name specified, returns the whole bottom up calls tree.
   *
   * @param {string} opt_label Node label.
   */
  getBottomUpProfile(opt_label) {
    return this.getTreeProfile_(this.bottomUpTree_, opt_label);
690 691
  }

692 693 694 695 696 697 698 699 700 701 702
  /**
   * Helper function for calculating a tree profile.
   *
   * @param {Profile.CallTree} tree Call tree.
   * @param {string} opt_label Node label.
   */
  getTreeProfile_(tree, opt_label) {
    if (!opt_label) {
      tree.computeTotalWeights();
      return tree;
    } else {
703
      const subTree = tree.cloneSubtree(opt_label);
704 705 706 707
      subTree.computeTotalWeights();
      return subTree;
    }
  }
708

709 710 711 712 713 714 715
  /**
   * Calculates a flat profile of callees starting from a node with
   * the specified label. If no name specified, starts from the root.
   *
   * @param {string} opt_label Starting node label.
   */
  getFlatProfile(opt_label) {
716 717 718
    const counters = new CallTree();
    const rootLabel = opt_label || CallTree.ROOT_NODE_LABEL;
    const precs = {};
719
    precs[rootLabel] = 0;
720
    const root = counters.findOrAddChild(rootLabel);
721 722 723 724 725 726 727

    this.topDownTree_.computeTotalWeights();
    this.topDownTree_.traverseInDepth(
      function onEnter(node) {
        if (!(node.label in precs)) {
          precs[node.label] = 0;
        }
728
        const nodeLabelIsRootLabel = node.label == rootLabel;
729 730 731 732 733
        if (nodeLabelIsRootLabel || precs[rootLabel] > 0) {
          if (precs[rootLabel] == 0) {
            root.selfWeight += node.selfWeight;
            root.totalWeight += node.totalWeight;
          } else {
734
            const rec = root.findOrAddChild(node.label);
735 736 737 738
            rec.selfWeight += node.selfWeight;
            if (nodeLabelIsRootLabel || precs[node.label] == 0) {
              rec.totalWeight += node.totalWeight;
            }
739
          }
740
          precs[node.label]++;
741
        }
742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760
      },
      function onExit(node) {
        if (node.label == rootLabel || precs[rootLabel] > 0) {
          precs[node.label]--;
        }
      },
      null);

    if (!opt_label) {
      // If we have created a flat profile for the whole program, we don't
      // need an explicit root in it. Thus, replace the counters tree
      // root with the node corresponding to the whole program.
      counters.root_ = root;
    } else {
      // Propagate weights so percents can be calculated correctly.
      counters.getRoot().selfWeight = root.selfWeight;
      counters.getRoot().totalWeight = root.totalWeight;
    }
    return counters;
761 762
  }

763
  getCEntryProfile() {
764 765 766 767
    const result = [new CEntryNode("TOTAL", 0)];
    let total_ticks = 0;
    for (let f in this.c_entries_) {
      const ticks = this.c_entries_[f];
768 769 770 771
      total_ticks += ticks;
      result.push(new CEntryNode(f, ticks));
    }
    result[0].ticks = total_ticks;  // Sorting will keep this at index 0.
772
    result.sort((n1, n2) => n2.ticks - n1.ticks || (n2.name < n1.name ? -1 : 1));
773
    return result;
774 775 776
  }


777 778 779 780
  /**
   * Cleans up function entries that are not referenced by code entries.
   */
  cleanUpFuncEntries() {
781 782 783
    const referencedFuncEntries = [];
    const entries = this.codeMap_.getAllDynamicEntriesWithAddresses();
    for (let i = 0, l = entries.length; i < l; ++i) {
784 785 786
      if (entries[i][1].constructor === FunctionEntry) {
        entries[i][1].used = false;
      }
787
    }
788
    for (let i = 0, l = entries.length; i < l; ++i) {
789 790 791
      if ("func" in entries[i][1]) {
        entries[i][1].func.used = true;
      }
792
    }
793
    for (let i = 0, l = entries.length; i < l; ++i) {
794 795 796 797
      if (entries[i][1].constructor === FunctionEntry &&
        !entries[i][1].used) {
        this.codeMap_.deleteCode(entries[i][0]);
      }
798 799
    }
  }
800 801 802 803 804 805 806 807
}

class CEntryNode {
  constructor(name, ticks) {
    this.name = name;
    this.ticks = ticks;
  }
}
808 809 810 811 812 813 814 815 816 817


/**
 * Creates a dynamic code entry.
 *
 * @param {number} size Code size.
 * @param {string} type Code type.
 * @param {string} name Function name.
 * @constructor
 */
818 819 820 821
class DynamicCodeEntry extends CodeEntry {
  constructor(size, type, name) {
    super(size, name, type);
  }
822

823 824 825
  getName() {
    return this.type + ': ' + this.name;
  }
826

827 828 829 830 831 832
  /**
   * Returns raw node name (without type decoration).
   */
  getRawName() {
    return this.name;
  }
833

834 835 836
  isJSFunction() {
    return false;
  }
837

838 839 840 841
  toString() {
    return this.getName() + ': ' + this.size.toString(16);
  }
}
842 843 844 845 846 847 848


/**
 * Creates a dynamic code entry.
 *
 * @param {number} size Code size.
 * @param {string} type Code type.
849
 * @param {FunctionEntry} func Shared function entry.
850 851 852
 * @param {Profile.CodeState} state Code optimization state.
 * @constructor
 */
853 854 855 856
class DynamicFuncCodeEntry extends CodeEntry {
  constructor(size, type, func, state) {
    super(size, '', type);
    this.func = func;
857
    func.addDynamicCode(this);
858 859
    this.state = state;
  }
860

861 862 863 864
  get functionName() {
    return this.func.functionName;
  }

865 866 867 868
  getSourceCode() {
    return this.source?.getSourceCode();
  }

869
  static STATE_PREFIX = ["", "~", "^", "-", "+", "*"];
870 871 872
  getState() {
    return DynamicFuncCodeEntry.STATE_PREFIX[this.state];
  }
873

874
  getName() {
875
    const name = this.func.getName();
876 877
    return this.type + ': ' + this.getState() + name;
  }
878

879 880 881 882 883 884
  /**
   * Returns raw node name (without type decoration).
   */
  getRawName() {
    return this.func.getName();
  }
885

886 887 888
  isJSFunction() {
    return true;
  }
889

890 891 892 893
  toString() {
    return this.getName() + ': ' + this.size.toString(16);
  }
}
894 895 896 897 898 899 900

/**
 * Creates a shared function object entry.
 *
 * @param {string} name Function name.
 * @constructor
 */
901
class FunctionEntry extends CodeEntry {
902

903 904 905
  // Contains the list of generated code for this function.
  _codeEntries = new Set();

906 907
  constructor(name) {
    super(0, name);
908 909
    const index = name.lastIndexOf(' ');
    this.functionName = 1 <= index ? name.substring(0, index) : '<anonymous>';
910
  }
911

912 913 914 915 916 917 918 919 920 921 922 923
  addDynamicCode(code) {
    if (code.func != this) {
      throw new Error("Adding dynamic code to wrong function");
    }
    this._codeEntries.add(code);
  }

  getSourceCode() {
    // All code entries should map to the same source positions.
    return this._codeEntries.values().next().value.getSourceCode();
  }

924 925 926 927
  get codeEntries() {
    return this._codeEntries;
  }

928 929 930 931
  /**
   * Returns node name.
   */
  getName() {
932
    let name = this.name;
933
    if (name.length == 0) {
934
      return '<anonymous>';
935 936
    } else if (name.charAt(0) == ' ') {
      // An anonymous function with location: " aaa.js:10".
937
      return `<anonymous>${name}`;
938 939 940 941
    }
    return name;
  }
}
942 943 944 945 946 947

/**
 * Constructs a call graph.
 *
 * @constructor
 */
948 949 950 951 952 953 954 955 956 957 958 959 960 961
class CallTree {
  root_ = new CallTreeNode(CallTree.ROOT_NODE_LABEL);
  totalsComputed_ = false;

  /**
   * The label of the root node.
   */
  static ROOT_NODE_LABEL = '';

  /**
   * Returns the tree root.
   */
  getRoot() {
    return this.root_;
962 963
  }

964 965 966 967 968 969 970 971
  /**
   * Adds the specified call path, constructing nodes as necessary.
   *
   * @param {Array<string>} path Call path.
   */
  addPath(path) {
    if (path.length == 0) {
      return;
972
    }
973 974
    let curr = this.root_;
    for (let i = 0; i < path.length; ++i) {
975 976 977 978
      curr = curr.findOrAddChild(path[i]);
    }
    curr.selfWeight++;
    this.totalsComputed_ = false;
979 980
  }

981 982 983 984 985 986 987 988 989 990
  /**
   * Finds an immediate child of the specified parent with the specified
   * label, creates a child node if necessary. If a parent node isn't
   * specified, uses tree root.
   *
   * @param {string} label Child node label.
   */
  findOrAddChild(label) {
    return this.root_.findOrAddChild(label);
  }
991

992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008
  /**
   * Creates a subtree by cloning and merging all subtrees rooted at nodes
   * with a given label. E.g. cloning the following call tree on label 'A'
   * will give the following result:
   *
   *           <A>--<B>                                     <B>
   *          /                                            /
   *     <root>             == clone on 'A' ==>  <root>--<A>
   *          \                                            \
   *           <C>--<A>--<D>                                <D>
   *
   * And <A>'s selfWeight will be the sum of selfWeights of <A>'s from the
   * source call tree.
   *
   * @param {string} label The label of the new root node.
   */
  cloneSubtree(label) {
1009
    const subTree = new CallTree();
1010 1011 1012 1013
    this.traverse((node, parent) => {
      if (!parent && node.label != label) {
        return null;
      }
1014
      const child = (parent ? parent : subTree).findOrAddChild(node.label);
1015 1016
      child.selfWeight += node.selfWeight;
      return child;
1017
    });
1018
    return subTree;
1019 1020
  }

1021 1022 1023 1024 1025 1026 1027 1028
  /**
   * Computes total weights in the call graph.
   */
  computeTotalWeights() {
    if (this.totalsComputed_) return;
    this.root_.computeTotalWeight();
    this.totalsComputed_ = true;
  }
1029

1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045
  /**
   * Traverses the call graph in preorder. This function can be used for
   * building optionally modified tree clones. This is the boilerplate code
   * for this scenario:
   *
   * callTree.traverse(function(node, parentClone) {
   *   var nodeClone = cloneNode(node);
   *   if (parentClone)
   *     parentClone.addChild(nodeClone);
   *   return nodeClone;
   * });
   *
   * @param {function(CallTreeNode, *)} f Visitor function.
   *    The second parameter is the result of calling 'f' on the parent node.
   */
  traverse(f) {
1046
    const pairsToProcess = new ConsArray();
1047 1048
    pairsToProcess.concat([{ node: this.root_, param: null }]);
    while (!pairsToProcess.atEnd()) {
1049 1050 1051 1052
      const pair = pairsToProcess.next();
      const node = pair.node;
      const newParam = f(node, pair.param);
      const morePairsToProcess = [];
1053 1054 1055 1056 1057
      node.forEachChild((child) => {
        morePairsToProcess.push({ node: child, param: newParam });
      });
      pairsToProcess.concat(morePairsToProcess);
    }
1058
  }
1059 1060 1061 1062 1063 1064 1065 1066 1067

  /**
   * Performs an indepth call graph traversal.
   *
   * @param {function(CallTreeNode)} enter A function called
   *     prior to visiting node's children.
   * @param {function(CallTreeNode)} exit A function called
   *     after visiting node's children.
   */
1068
  traverseInDepth(enter, exit) {
1069 1070 1071 1072 1073 1074 1075 1076
    function traverse(node) {
      enter(node);
      node.forEachChild(traverse);
      exit(node);
    }
    traverse(this.root_);
  }
}
1077 1078 1079 1080 1081 1082


/**
 * Constructs a call graph node.
 *
 * @param {string} label Node label.
1083
 * @param {CallTreeNode} opt_parent Node parent.
1084
 */
1085
class CallTreeNode {
1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103
  /**
   * Node self weight (how many times this node was the last node in
   * a call path).
   * @type {number}
   */
  selfWeight = 0;

  /**
   * Node total weight (includes weights of all children).
   * @type {number}
   */
  totalWeight = 0;
  children = {};

  constructor(label, opt_parent) {
    this.label = label;
    this.parent = opt_parent;
  }
1104 1105


1106 1107 1108 1109 1110 1111
  /**
   * Adds a child node.
   *
   * @param {string} label Child node label.
   */
  addChild(label) {
1112
    const child = new CallTreeNode(label, this);
1113 1114 1115
    this.children[label] = child;
    return child;
  }
1116

1117 1118 1119 1120
  /**
   * Computes node's total weight.
   */
  computeTotalWeight() {
1121
    let totalWeight = this.selfWeight;
1122 1123 1124 1125
    this.forEachChild(function (child) {
      totalWeight += child.computeTotalWeight();
    });
    return this.totalWeight = totalWeight;
1126
  }
1127

1128 1129 1130 1131
  /**
   * Returns all node's children as an array.
   */
  exportChildren() {
1132
    const result = [];
1133 1134 1135
    this.forEachChild(function (node) { result.push(node); });
    return result;
  }
1136

1137 1138 1139 1140 1141 1142 1143
  /**
   * Finds an immediate child with the specified label.
   *
   * @param {string} label Child node label.
   */
  findChild(label) {
    return this.children[label] || null;
1144 1145
  }

1146 1147 1148 1149 1150 1151 1152 1153 1154
  /**
   * Finds an immediate child with the specified label, creates a child
   * node if necessary.
   *
   * @param {string} label Child node label.
   */
  findOrAddChild(label) {
    return this.findChild(label) || this.addChild(label);
  }
1155

1156 1157 1158 1159 1160 1161
  /**
   * Calls the specified function for every child.
   *
   * @param {function(CallTreeNode)} f Visitor function.
   */
  forEachChild(f) {
1162
    for (let c in this.children) {
1163 1164
      f(this.children[c]);
    }
1165 1166
  }

1167 1168 1169 1170 1171 1172
  /**
   * Walks up from the current node up to the call tree root.
   *
   * @param {function(CallTreeNode)} f Visitor function.
   */
  walkUpToRoot(f) {
1173
    for (let curr = this; curr != null; curr = curr.parent) {
1174 1175 1176
      f(curr);
    }
  }
1177

1178 1179 1180 1181 1182 1183 1184
  /**
   * Tries to find a node with the specified path.
   *
   * @param {Array<string>} labels The path.
   * @param {function(CallTreeNode)} opt_f Visitor function.
   */
  descendToChild(labels, opt_f) {
1185 1186 1187
    let curr = this;
    for (let pos = 0; pos < labels.length && curr != null; pos++) {
      const child = curr.findChild(labels[pos]);
1188 1189 1190 1191
      if (opt_f) {
        opt_f(child, pos);
      }
      curr = child;
1192
    }
1193
    return curr;
1194
  }
1195
}
1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206

export function JsonProfile() {
  this.codeMap_ = new CodeMap();
  this.codeEntries_ = [];
  this.functionEntries_ = [];
  this.ticks_ = [];
  this.scripts_ = [];
}

JsonProfile.prototype.addLibrary = function (
  name, startAddr, endAddr) {
1207
  const entry = new CodeEntry(
1208 1209 1210 1211 1212 1213 1214 1215 1216 1217
    endAddr - startAddr, name, 'SHARED_LIB');
  this.codeMap_.addLibrary(startAddr, entry);

  entry.codeId = this.codeEntries_.length;
  this.codeEntries_.push({ name: entry.name, type: entry.type });
  return entry;
};

JsonProfile.prototype.addStaticCode = function (
  name, startAddr, endAddr) {
1218
  const entry = new CodeEntry(
1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236
    endAddr - startAddr, name, 'CPP');
  this.codeMap_.addStaticCode(startAddr, entry);

  entry.codeId = this.codeEntries_.length;
  this.codeEntries_.push({ name: entry.name, type: entry.type });
  return entry;
};

JsonProfile.prototype.addCode = function (
  kind, name, timestamp, start, size) {
  let codeId = this.codeEntries_.length;
  // Find out if we have a static code entry for the code. If yes, we will
  // make sure it is written to the JSON file just once.
  let staticEntry = this.codeMap_.findAddress(start);
  if (staticEntry && staticEntry.entry.type === 'CPP') {
    codeId = staticEntry.entry.codeId;
  }

1237
  const entry = new CodeEntry(size, name, 'CODE');
1238 1239 1240 1241 1242 1243 1244
  this.codeMap_.addCode(start, entry);

  entry.codeId = codeId;
  this.codeEntries_[codeId] = {
    name: entry.name,
    timestamp: timestamp,
    type: entry.type,
1245
    kind: kind,
1246 1247 1248 1249 1250 1251 1252 1253 1254
  };

  return entry;
};

JsonProfile.prototype.addFuncCode = function (
  kind, name, timestamp, start, size, funcAddr, state) {
  // As code and functions are in the same address space,
  // it is safe to put them in a single code map.
1255
  let func = this.codeMap_.findDynamicEntryByStartAddress(funcAddr);
1256
  if (!func) {
1257
    func = new CodeEntry(0, name, 'SFI');
1258 1259 1260
    this.codeMap_.addCode(funcAddr, func);

    func.funcId = this.functionEntries_.length;
1261
    this.functionEntries_.push({ name, codes: [] });
1262 1263 1264 1265 1266
  } else if (func.name !== name) {
    // Function object has been overwritten with a new one.
    func.name = name;

    func.funcId = this.functionEntries_.length;
1267
    this.functionEntries_.push({ name, codes: [] });
1268 1269
  }
  // TODO(jarin): Insert the code object into the SFI's code list.
1270
  let entry = this.codeMap_.findDynamicEntryByStartAddress(start);
1271 1272 1273 1274 1275 1276 1277 1278 1279 1280
  if (entry) {
    if (entry.size === size && entry.func === func) {
      // Entry state has changed.
      entry.state = state;
    } else {
      this.codeMap_.deleteCode(start);
      entry = null;
    }
  }
  if (!entry) {
1281
    entry = new CodeEntry(size, name, 'JS');
1282 1283 1284 1285 1286 1287
    this.codeMap_.addCode(start, entry);

    entry.codeId = this.codeEntries_.length;

    this.functionEntries_[func.funcId].codes.push(entry.codeId);

1288
    kind = Profile.getKindFromState(state);
1289 1290 1291 1292 1293 1294

    this.codeEntries_.push({
      name: entry.name,
      type: entry.type,
      kind: kind,
      func: func.funcId,
1295
      tm: timestamp,
1296 1297 1298 1299 1300 1301 1302 1303 1304
    });
  }
  return entry;
};

JsonProfile.prototype.moveCode = function (from, to) {
  try {
    this.codeMap_.moveCode(from, to);
  } catch (e) {
1305
    printErr(`Move: unknown source ${from}`);
1306 1307 1308 1309 1310 1311
  }
};

JsonProfile.prototype.addSourcePositions = function (
  start, script, startPos, endPos, sourcePositions, inliningPositions,
  inlinedFunctions) {
1312
  const entry = this.codeMap_.findDynamicEntryByStartAddress(start);
1313
  if (!entry) return;
1314
  const codeId = entry.codeId;
1315 1316 1317 1318

  // Resolve the inlined functions list.
  if (inlinedFunctions.length > 0) {
    inlinedFunctions = inlinedFunctions.substring(1).split("S");
1319 1320 1321
    for (let i = 0; i < inlinedFunctions.length; i++) {
      const funcAddr = parseInt(inlinedFunctions[i]);
      const func = this.codeMap_.findDynamicEntryByStartAddress(funcAddr);
1322
      if (!func || func.funcId === undefined) {
1323
        printErr(`Could not find function ${inlinedFunctions[i]}`);
1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343
        inlinedFunctions[i] = null;
      } else {
        inlinedFunctions[i] = func.funcId;
      }
    }
  } else {
    inlinedFunctions = [];
  }

  this.codeEntries_[entry.codeId].source = {
    script: script,
    start: startPos,
    end: endPos,
    positions: sourcePositions,
    inlined: inliningPositions,
    fns: inlinedFunctions
  };
};

JsonProfile.prototype.addScriptSource = function (id, url, source) {
1344 1345 1346
  const script = new Script(id);
  script.update(url, source);
  this.scripts_[id] = script;
1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364
};

JsonProfile.prototype.deoptCode = function (
  timestamp, code, inliningId, scriptOffset, bailoutType,
  sourcePositionText, deoptReasonText) {
  let entry = this.codeMap_.findDynamicEntryByStartAddress(code);
  if (entry) {
    let codeId = entry.codeId;
    if (!this.codeEntries_[codeId].deopt) {
      // Only add the deopt if there was no deopt before.
      // The subsequent deoptimizations should be lazy deopts for
      // other on-stack activations.
      this.codeEntries_[codeId].deopt = {
        tm: timestamp,
        inliningId: inliningId,
        scriptOffset: scriptOffset,
        posText: sourcePositionText,
        reason: deoptReasonText,
1365
        bailoutType: bailoutType,
1366 1367 1368 1369 1370 1371 1372 1373 1374
      };
    }
  }
};

JsonProfile.prototype.deleteCode = function (start) {
  try {
    this.codeMap_.deleteCode(start);
  } catch (e) {
1375
    printErr(`Delete: unknown address ${start}`);
1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391
  }
};

JsonProfile.prototype.moveFunc = function (from, to) {
  if (this.codeMap_.findDynamicEntryByStartAddress(from)) {
    this.codeMap_.moveCode(from, to);
  }
};

JsonProfile.prototype.findEntry = function (addr) {
  return this.codeMap_.findEntry(addr);
};

JsonProfile.prototype.recordTick = function (time_ns, vmState, stack) {
  // TODO(jarin) Resolve the frame-less case (when top of stack is
  // known code).
1392 1393 1394
  const processedStack = [];
  for (let i = 0; i < stack.length; i++) {
    const resolved = this.codeMap_.findAddress(stack[i]);
1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421
    if (resolved) {
      processedStack.push(resolved.entry.codeId, resolved.offset);
    } else {
      processedStack.push(-1, stack[i]);
    }
  }
  this.ticks_.push({ tm: time_ns, vm: vmState, s: processedStack });
};

function writeJson(s) {
  write(JSON.stringify(s, null, 2));
}

JsonProfile.prototype.writeJson = function () {
  // Write out the JSON in a partially manual way to avoid creating too-large
  // strings in one JSON.stringify call when there are a lot of ticks.
  write('{\n')

  write('  "code": ');
  writeJson(this.codeEntries_);
  write(',\n');

  write('  "functions": ');
  writeJson(this.functionEntries_);
  write(',\n');

  write('  "ticks": [\n');
1422
  for (let i = 0; i < this.ticks_.length; i++) {
1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437
    write('    ');
    writeJson(this.ticks_[i]);
    if (i < this.ticks_.length - 1) {
      write(',\n');
    } else {
      write('\n');
    }
  }
  write('  ],\n');

  write('  "scripts": ');
  writeJson(this.scripts_);

  write('}\n');
};