profile.mjs 39.6 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
  findFunctionSourcePosition(sourcePosition) {
109
    // TODO(cbruni): implement
110 111 112
    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
    if (this.sourcePosition === undefined && entry.entry?.type === "Script") {
      // Mark the source position of scripts, for inline scripts which don't
      // start at line 1.
122 123
      this.sourcePosition = sourcePosition;
    }
124
    sourcePosition.addEntry(entry);
125
    this._entries.push(entry);
126 127 128
    return sourcePosition;
  }

129
  _addSourcePosition(line, column, sourcePosition) {
130 131 132 133 134 135 136 137 138 139
    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);
  }
140

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

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

  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;
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 233

  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";
      }
    })();
  }
234 235
}

236

237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265
const kOffsetPairRegex = /C([0-9]+)O([0-9]+)/g;
class SourcePositionTable {
  constructor(encodedTable) {
    this._offsets = [];
    while (true) {
      const regexResult = kOffsetPairRegex.exec(encodedTable);
      if (!regexResult) break;
      const codeOffset = parseInt(regexResult[1]);
      const scriptOffset = parseInt(regexResult[2]);
      if (isNaN(codeOffset) || isNaN(scriptOffset)) continue;
      this._offsets.push({code: codeOffset, script: scriptOffset});
    }
  }

  getScriptOffset(codeOffset) {
    if (codeOffset < 0) {
      throw new Exception(`Invalid codeOffset=${codeOffset}, should be >= 0`);
    }
    for (let i = this.offsetTable.length - 1; i >= 0; i--) {
      const offset = this._offsets[i];
      if (offset.code <= codeOffset) {
        return offset.script;
      }
    }
    return this._offsets[0].script;
  }
}


266
class SourceInfo {
267 268 269 270 271 272 273
  script;
  start;
  end;
  positions;
  inlined;
  fns;
  disassemble;
274

275 276 277
  setSourcePositionInfo(
        script, startPos, endPos, sourcePositionTableData, inliningPositions,
        inlinedFunctions) {
278 279 280
    this.script = script;
    this.start = startPos;
    this.end = endPos;
281
    this.positions = sourcePositionTableData;
282 283
    this.inlined = inliningPositions;
    this.fns = inlinedFunctions;
284
    this.sourcePositionTable = new SourcePositionTable(sourcePositionTableData);
285
  }
286 287 288 289

  setDisassemble(code) {
    this.disassemble = code;
  }
290 291 292 293

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

296 297 298 299
const kProfileOperationMove = 0;
const kProfileOperationDelete = 1;
const kProfileOperationTick = 2;

300 301 302 303 304 305
/**
 * Creates a profile object for processing profiling-related events
 * and calculating function execution times.
 *
 * @constructor
 */
306 307 308 309
export class Profile {
  codeMap_ = new CodeMap();
  topDownTree_ = new CallTree();
  bottomUpTree_ = new CallTree();
310
  c_entries_ = {__proto__:null};
311 312
  scripts_ = [];
  urlToScript_ = new Map();
313
  warnings = new Set();
314

315 316 317 318 319 320 321 322
  serializeVMSymbols() {
    let result = this.codeMap_.getAllStaticEntriesWithAddresses();
    result.concat(this.codeMap_.getAllLibraryEntriesWithAddresses())
    return result.map(([startAddress, codeEntry]) => {
      return [codeEntry.getName(), startAddress, startAddress + codeEntry.size]
    });
  }

323 324
  /**
   * Returns whether a function with the specified name must be skipped.
325
   * Should be overridden by subclasses.
326 327 328 329 330 331
   *
   * @param {string} name Function name.
   */
  skipThisFunction(name) {
    return false;
  }
332

333 334 335 336 337 338 339
  /**
   * Enum for profiler operations that involve looking up existing
   * code entries.
   *
   * @enum {number}
   */
  static Operation = {
340 341 342
    MOVE: kProfileOperationMove,
    DELETE: kProfileOperationDelete,
    TICK: kProfileOperationTick
343
  }
344

345 346 347 348 349 350 351
  /**
   * Enum for code state regarding its dynamic optimization.
   *
   * @enum {number}
   */
  static CodeState = {
    COMPILED: 0,
352
    IGNITION: 1,
353
    BASELINE: 2,
354
    TURBOFAN: 5,
355 356
  }

357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373
  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
  }

374 375 376 377 378 379 380 381 382
  /**
   * Parser for dynamic code optimization state.
   */
  static parseState(s) {
    switch (s) {
      case '':
        return this.CodeState.COMPILED;
      case '~':
        return this.CodeState.IGNITION;
383
      case '^':
384
        return this.CodeState.BASELINE;
385 386 387 388
      case '*':
        return this.CodeState.TURBOFAN;
    }
    throw new Error(`unknown code state: ${s}`);
389
  }
390

391 392 393 394 395
  static getKindFromState(state) {
    if (state === this.CodeState.COMPILED) {
      return "Builtin";
    } else if (state === this.CodeState.IGNITION) {
      return "Unopt";
396 397
    } else if (state === this.CodeState.BASELINE) {
      return "Baseline";
398 399 400 401 402 403
    } else if (state === this.CodeState.TURBOFAN) {
      return "Opt";
    }
    throw new Error(`unknown code state: ${state}`);
  }

404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425
  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';
  }

426 427 428 429 430 431 432 433 434 435 436 437
  /**
   * 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.
   */
438
  handleUnknownCode(operation, addr, opt_stackPos) { }
439 440 441 442 443 444 445 446 447

  /**
   * Registers a library.
   *
   * @param {string} name Code entry name.
   * @param {number} startAddr Starting address.
   * @param {number} endAddr Ending address.
   */
  addLibrary(name, startAddr, endAddr) {
448
    const entry = new CodeEntry(endAddr - startAddr, name, 'SHARED_LIB');
449 450 451
    this.codeMap_.addLibrary(startAddr, entry);
    return entry;
  }
452

453 454 455 456 457 458 459 460
  /**
   * 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) {
461
    const entry = new CodeEntry(endAddr - startAddr, name, 'CPP');
462 463 464
    this.codeMap_.addStaticCode(startAddr, entry);
    return entry;
  }
465

466 467 468 469 470 471 472 473 474
  /**
   * 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) {
475
    const entry = new DynamicCodeEntry(size, type, name);
476 477 478
    this.codeMap_.addCode(start, entry);
    return entry;
  }
479

480 481 482 483 484 485 486 487 488 489 490 491 492 493 494
  /**
   * Registers dynamic (JIT-compiled) code entry or entries that overlap with
   * static entries (like builtins).
   *
   * @param {string} type Code entry type.
   * @param {string} name Code entry name.
   * @param {number} start Starting address.
   * @param {number} size Code entry size.
   */
  addAnyCode(type, name, timestamp, start, size) {
    const entry = new DynamicCodeEntry(size, type, name);
    this.codeMap_.addAnyCode(start, entry);
    return entry;
  }

495 496 497 498 499 500 501 502 503 504 505 506 507
  /**
   * 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.
508
    let func = this.codeMap_.findDynamicEntryByStartAddress(funcAddr);
509
    if (func === null) {
510 511 512 513 514 515
      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;
    }
516
    let entry = this.codeMap_.findDynamicEntryByStartAddress(start);
517
    if (entry !== null) {
518 519 520 521 522 523 524 525
      if (entry.size === size && entry.func === func) {
        // Entry state has changed.
        entry.state = state;
      } else {
        this.codeMap_.deleteCode(start);
        entry = null;
      }
    }
526
    if (entry === null) {
527 528 529 530 531
      entry = new DynamicFuncCodeEntry(size, type, func, state);
      this.codeMap_.addCode(start, entry);
    }
    return entry;
  }
532

533 534 535 536 537 538 539 540 541 542
  /**
   * 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) {
543
      this.handleUnknownCode(kProfileOperationMove, from);
544 545
    }
  }
546

547
  deoptCode(timestamp, code, inliningId, scriptOffset, bailoutType,
548
    sourcePositionText, deoptReasonText) {
549
  }
550 551 552 553 554 555 556 557

  /**
   * Reports about deletion of a dynamic code entry.
   *
   * @param {number} start Starting address.
   */
  deleteCode(start) {
    try {
558
      this.codeMap_.deleteCode(start);
559
    } catch (e) {
560
      this.handleUnknownCode(kProfileOperationDelete, start);
561 562 563
    }
  }

564 565 566
  /**
   * Adds source positions for given code.
   */
567
  addSourcePositions(start, scriptId, startPos, endPos, sourcePositionTable,
568
        inliningPositions, inlinedFunctions) {
569 570
    const script = this.getOrCreateScript(scriptId);
    const entry = this.codeMap_.findDynamicEntryByStartAddress(start);
571
    if (entry === null) return;
572 573 574 575 576 577
    // 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);
578
        if (func === null || func.funcId === undefined) {
579
          // TODO: fix
580
          this.warnings.add(`Could not find function ${inlinedFunctions[i]}`);
581 582 583 584 585 586 587 588 589
          inlinedFunctions[i] = null;
        } else {
          inlinedFunctions[i] = func.funcId;
        }
      }
    } else {
      inlinedFunctions = [];
    }

590
    this.getOrCreateSourceInfo(entry).setSourcePositionInfo(
591 592
      script, startPos, endPos, sourcePositionTable, inliningPositions,
      inlinedFunctions);
593 594
  }

595 596
  addDisassemble(start, kind, disassemble) {
    const entry = this.codeMap_.findDynamicEntryByStartAddress(start);
597 598 599
    if (entry !== null) {
      this.getOrCreateSourceInfo(entry).setDisassemble(disassemble);
    }
600
    return entry;
601 602 603 604 605 606
  }

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

607
  addScriptSource(id, url, source) {
608 609
    const script = this.getOrCreateScript(id);
    script.update(url, source);
610
    this.urlToScript_.set(url, script);
611 612
  }

613 614
  getOrCreateScript(id) {
    let script = this.scripts_[id];
615
    if (script === undefined) {
616 617 618 619 620 621
      script = new Script(id);
      this.scripts_[id] = script;
    }
    return script;
  }

622 623
  getScript(url) {
    return this.urlToScript_.get(url);
624 625
  }

626 627 628 629 630 631 632 633 634 635 636
  /**
   * 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);
    }
  }
637

638 639 640 641 642 643 644 645
  /**
   * Retrieves a code entry by an address.
   *
   * @param {number} addr Entry address.
   */
  findEntry(addr) {
    return this.codeMap_.findEntry(addr);
  }
646

647 648 649 650
  /**
   * Records a tick event. Stack must contain a sequence of
   * addresses starting with the program counter value.
   *
651
   * @param {number[]} stack Stack sample.
652 653
   */
  recordTick(time_ns, vmState, stack) {
654 655 656 657
    const {nameStack, entryStack} = this.resolveAndFilterFuncs_(stack);
    this.bottomUpTree_.addPath(nameStack);
    nameStack.reverse();
    this.topDownTree_.addPath(nameStack);
658
    return entryStack;
659
  }
660

661 662 663 664
  /**
   * Translates addresses into function names and filters unneeded
   * functions.
   *
665
   * @param {number[]} stack Stack sample.
666 667
   */
  resolveAndFilterFuncs_(stack) {
668 669
    const nameStack = [];
    const entryStack = [];
670 671 672
    let last_seen_c_function = '';
    let look_for_first_c_function = false;
    for (let i = 0; i < stack.length; ++i) {
673 674
      const pc = stack[i];
      const entry = this.codeMap_.findEntry(pc);
675
      if (entry !== null) {
676
        entryStack.push(entry);
677
        const name = entry.getName();
678 679 680 681 682 683 684
        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)) {
685
          nameStack.push(name);
686 687
        }
      } else {
688
        this.handleUnknownCode(kProfileOperationTick, pc, i);
689 690
        if (i === 0) nameStack.push("UNKNOWN");
        entryStack.push(pc);
691
      }
692
      if (look_for_first_c_function && i > 0 &&
693 694
          (entry === null || entry.type !== 'CPP')
          && last_seen_c_function !== '') {
695 696 697 698 699
        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.
700 701
      }
    }
702
    return {nameStack, entryStack};
703 704
  }

705 706 707 708 709 710 711 712
  /**
   * Performs a BF traversal of the top down call graph.
   *
   * @param {function(CallTreeNode)} f Visitor function.
   */
  traverseTopDownTree(f) {
    this.topDownTree_.traverse(f);
  }
713

714 715 716 717 718 719 720 721
  /**
   * Performs a BF traversal of the bottom up call graph.
   *
   * @param {function(CallTreeNode)} f Visitor function.
   */
  traverseBottomUpTree(f) {
    this.bottomUpTree_.traverse(f);
  }
722

723 724 725 726 727 728 729 730 731
  /**
   * 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);
  }
732

733 734 735 736 737 738 739 740
  /**
   * 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);
741 742
  }

743 744 745 746 747 748 749 750 751 752 753
  /**
   * 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 {
754
      const subTree = tree.cloneSubtree(opt_label);
755 756 757 758
      subTree.computeTotalWeights();
      return subTree;
    }
  }
759

760 761 762 763 764 765 766
  /**
   * 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) {
767 768
    const counters = new CallTree();
    const rootLabel = opt_label || CallTree.ROOT_NODE_LABEL;
769
    const precs = {__proto__:null};
770
    precs[rootLabel] = 0;
771
    const root = counters.findOrAddChild(rootLabel);
772 773 774 775 776 777 778

    this.topDownTree_.computeTotalWeights();
    this.topDownTree_.traverseInDepth(
      function onEnter(node) {
        if (!(node.label in precs)) {
          precs[node.label] = 0;
        }
779
        const nodeLabelIsRootLabel = node.label == rootLabel;
780 781 782 783 784
        if (nodeLabelIsRootLabel || precs[rootLabel] > 0) {
          if (precs[rootLabel] == 0) {
            root.selfWeight += node.selfWeight;
            root.totalWeight += node.totalWeight;
          } else {
785
            const rec = root.findOrAddChild(node.label);
786 787 788 789
            rec.selfWeight += node.selfWeight;
            if (nodeLabelIsRootLabel || precs[node.label] == 0) {
              rec.totalWeight += node.totalWeight;
            }
790
          }
791
          precs[node.label]++;
792
        }
793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811
      },
      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;
812 813
  }

814
  getCEntryProfile() {
815 816 817 818
    const result = [new CEntryNode("TOTAL", 0)];
    let total_ticks = 0;
    for (let f in this.c_entries_) {
      const ticks = this.c_entries_[f];
819 820 821 822
      total_ticks += ticks;
      result.push(new CEntryNode(f, ticks));
    }
    result[0].ticks = total_ticks;  // Sorting will keep this at index 0.
823
    result.sort((n1, n2) => n2.ticks - n1.ticks || (n2.name < n1.name ? -1 : 1));
824
    return result;
825 826 827
  }


828 829 830 831
  /**
   * Cleans up function entries that are not referenced by code entries.
   */
  cleanUpFuncEntries() {
832 833 834
    const referencedFuncEntries = [];
    const entries = this.codeMap_.getAllDynamicEntriesWithAddresses();
    for (let i = 0, l = entries.length; i < l; ++i) {
835 836 837
      if (entries[i][1].constructor === FunctionEntry) {
        entries[i][1].used = false;
      }
838
    }
839
    for (let i = 0, l = entries.length; i < l; ++i) {
840 841 842
      if ("func" in entries[i][1]) {
        entries[i][1].func.used = true;
      }
843
    }
844
    for (let i = 0, l = entries.length; i < l; ++i) {
845 846 847 848
      if (entries[i][1].constructor === FunctionEntry &&
        !entries[i][1].used) {
        this.codeMap_.deleteCode(entries[i][0]);
      }
849 850
    }
  }
851 852 853 854 855 856 857 858
}

class CEntryNode {
  constructor(name, ticks) {
    this.name = name;
    this.ticks = ticks;
  }
}
859 860 861 862 863 864 865 866 867 868


/**
 * Creates a dynamic code entry.
 *
 * @param {number} size Code size.
 * @param {string} type Code type.
 * @param {string} name Function name.
 * @constructor
 */
869 870 871 872
class DynamicCodeEntry extends CodeEntry {
  constructor(size, type, name) {
    super(size, name, type);
  }
873

874 875 876
  getName() {
    return this.type + ': ' + this.name;
  }
877

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

885 886 887
  isJSFunction() {
    return false;
  }
888

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


/**
 * Creates a dynamic code entry.
 *
 * @param {number} size Code size.
 * @param {string} type Code type.
900
 * @param {FunctionEntry} func Shared function entry.
901 902 903
 * @param {Profile.CodeState} state Code optimization state.
 * @constructor
 */
904 905 906 907
class DynamicFuncCodeEntry extends CodeEntry {
  constructor(size, type, func, state) {
    super(size, '', type);
    this.func = func;
908
    func.addDynamicCode(this);
909 910
    this.state = state;
  }
911

912 913 914 915
  get functionName() {
    return this.func.functionName;
  }

916 917 918 919
  getSourceCode() {
    return this.source?.getSourceCode();
  }

920
  static STATE_PREFIX = ["", "~", "^", "-", "+", "*"];
921 922 923
  getState() {
    return DynamicFuncCodeEntry.STATE_PREFIX[this.state];
  }
924

925
  getName() {
926
    const name = this.func.getName();
927 928
    return this.type + ': ' + this.getState() + name;
  }
929

930 931 932 933 934 935
  /**
   * Returns raw node name (without type decoration).
   */
  getRawName() {
    return this.func.getName();
  }
936

937 938 939
  isJSFunction() {
    return true;
  }
940

941 942 943 944
  toString() {
    return this.getName() + ': ' + this.size.toString(16);
  }
}
945 946 947 948 949 950 951

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

954
  // Contains the list of generated code for this function.
955
  /** @type {Set<DynamicCodeEntry>} */
956 957
  _codeEntries = new Set();

958 959
  constructor(name) {
    super(0, name);
960 961
    const index = name.lastIndexOf(' ');
    this.functionName = 1 <= index ? name.substring(0, index) : '<anonymous>';
962
  }
963

964 965 966 967 968 969 970 971 972 973 974 975
  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();
  }

976 977 978 979
  get codeEntries() {
    return this._codeEntries;
  }

980 981 982 983
  /**
   * Returns node name.
   */
  getName() {
984
    let name = this.name;
985
    if (name.length == 0) {
986
      return '<anonymous>';
987 988
    } else if (name.charAt(0) == ' ') {
      // An anonymous function with location: " aaa.js:10".
989
      return `<anonymous>${name}`;
990 991 992 993
    }
    return name;
  }
}
994 995 996 997 998 999

/**
 * Constructs a call graph.
 *
 * @constructor
 */
1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013
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_;
1014 1015
  }

1016 1017 1018
  /**
   * Adds the specified call path, constructing nodes as necessary.
   *
1019
   * @param {string[]} path Call path.
1020 1021
   */
  addPath(path) {
1022
    if (path.length == 0) return;
1023 1024
    let curr = this.root_;
    for (let i = 0; i < path.length; ++i) {
1025 1026 1027 1028
      curr = curr.findOrAddChild(path[i]);
    }
    curr.selfWeight++;
    this.totalsComputed_ = false;
1029 1030
  }

1031 1032 1033 1034 1035 1036 1037 1038 1039 1040
  /**
   * 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);
  }
1041

1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058
  /**
   * 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) {
1059
    const subTree = new CallTree();
1060 1061 1062 1063
    this.traverse((node, parent) => {
      if (!parent && node.label != label) {
        return null;
      }
1064
      const child = (parent ? parent : subTree).findOrAddChild(node.label);
1065 1066
      child.selfWeight += node.selfWeight;
      return child;
1067
    });
1068
    return subTree;
1069 1070
  }

1071 1072 1073 1074 1075 1076 1077 1078
  /**
   * Computes total weights in the call graph.
   */
  computeTotalWeights() {
    if (this.totalsComputed_) return;
    this.root_.computeTotalWeight();
    this.totalsComputed_ = true;
  }
1079

1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095
  /**
   * 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) {
1096
    const pairsToProcess = new ConsArray();
1097 1098
    pairsToProcess.concat([{ node: this.root_, param: null }]);
    while (!pairsToProcess.atEnd()) {
1099 1100 1101 1102
      const pair = pairsToProcess.next();
      const node = pair.node;
      const newParam = f(node, pair.param);
      const morePairsToProcess = [];
1103 1104 1105 1106 1107
      node.forEachChild((child) => {
        morePairsToProcess.push({ node: child, param: newParam });
      });
      pairsToProcess.concat(morePairsToProcess);
    }
1108
  }
1109 1110 1111 1112 1113 1114 1115 1116 1117

  /**
   * 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.
   */
1118
  traverseInDepth(enter, exit) {
1119 1120 1121 1122 1123 1124 1125 1126
    function traverse(node) {
      enter(node);
      node.forEachChild(traverse);
      exit(node);
    }
    traverse(this.root_);
  }
}
1127 1128 1129 1130 1131 1132


/**
 * Constructs a call graph node.
 *
 * @param {string} label Node label.
1133
 * @param {CallTreeNode} opt_parent Node parent.
1134
 */
1135
class CallTreeNode {
1136 1137

  constructor(label, opt_parent) {
1138 1139 1140 1141 1142 1143
    // Node self weight (how many times this node was the last node in
    // a call path).
    this.selfWeight = 0;
    // Node total weight (includes weights of all children).
    this.totalWeight = 0;
    this. children = { __proto__:null };
1144 1145 1146
    this.label = label;
    this.parent = opt_parent;
  }
1147 1148


1149 1150 1151 1152 1153 1154
  /**
   * Adds a child node.
   *
   * @param {string} label Child node label.
   */
  addChild(label) {
1155
    const child = new CallTreeNode(label, this);
1156 1157 1158
    this.children[label] = child;
    return child;
  }
1159

1160 1161 1162 1163
  /**
   * Computes node's total weight.
   */
  computeTotalWeight() {
1164
    let totalWeight = this.selfWeight;
1165 1166 1167 1168
    this.forEachChild(function (child) {
      totalWeight += child.computeTotalWeight();
    });
    return this.totalWeight = totalWeight;
1169
  }
1170

1171 1172 1173 1174
  /**
   * Returns all node's children as an array.
   */
  exportChildren() {
1175
    const result = [];
1176 1177 1178
    this.forEachChild(function (node) { result.push(node); });
    return result;
  }
1179

1180 1181 1182 1183 1184 1185
  /**
   * Finds an immediate child with the specified label.
   *
   * @param {string} label Child node label.
   */
  findChild(label) {
1186 1187
    const found = this.children[label];
    return found === undefined ? null : found;
1188 1189
  }

1190 1191 1192 1193 1194 1195 1196
  /**
   * Finds an immediate child with the specified label, creates a child
   * node if necessary.
   *
   * @param {string} label Child node label.
   */
  findOrAddChild(label) {
1197 1198 1199
    const found = this.findChild(label)
    if (found === null) return this.addChild(label);
    return found;
1200
  }
1201

1202 1203 1204 1205 1206 1207
  /**
   * Calls the specified function for every child.
   *
   * @param {function(CallTreeNode)} f Visitor function.
   */
  forEachChild(f) {
1208
    for (let c in this.children) {
1209 1210
      f(this.children[c]);
    }
1211 1212
  }

1213 1214 1215 1216 1217 1218
  /**
   * Walks up from the current node up to the call tree root.
   *
   * @param {function(CallTreeNode)} f Visitor function.
   */
  walkUpToRoot(f) {
1219
    for (let curr = this; curr !== null; curr = curr.parent) {
1220 1221 1222
      f(curr);
    }
  }
1223

1224 1225 1226
  /**
   * Tries to find a node with the specified path.
   *
1227
   * @param {string[]} labels The path.
1228 1229 1230
   * @param {function(CallTreeNode)} opt_f Visitor function.
   */
  descendToChild(labels, opt_f) {
1231 1232 1233
    let curr = this;
    for (let pos = 0; pos < labels.length && curr != null; pos++) {
      const child = curr.findChild(labels[pos]);
1234 1235 1236 1237
      if (opt_f) {
        opt_f(child, pos);
      }
      curr = child;
1238
    }
1239
    return curr;
1240
  }
1241
}
1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252

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

JsonProfile.prototype.addLibrary = function (
  name, startAddr, endAddr) {
1253
  const entry = new CodeEntry(
1254 1255 1256 1257 1258 1259 1260 1261 1262 1263
    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) {
1264
  const entry = new CodeEntry(
1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282
    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;
  }

1283
  const entry = new CodeEntry(size, name, 'CODE');
1284 1285 1286 1287 1288 1289 1290
  this.codeMap_.addCode(start, entry);

  entry.codeId = codeId;
  this.codeEntries_[codeId] = {
    name: entry.name,
    timestamp: timestamp,
    type: entry.type,
1291
    kind: kind,
1292 1293 1294 1295 1296 1297 1298 1299 1300
  };

  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.
1301
  let func = this.codeMap_.findDynamicEntryByStartAddress(funcAddr);
1302
  if (!func) {
1303
    func = new CodeEntry(0, name, 'SFI');
1304 1305 1306
    this.codeMap_.addCode(funcAddr, func);

    func.funcId = this.functionEntries_.length;
1307
    this.functionEntries_.push({ name, codes: [] });
1308 1309 1310 1311 1312
  } else if (func.name !== name) {
    // Function object has been overwritten with a new one.
    func.name = name;

    func.funcId = this.functionEntries_.length;
1313
    this.functionEntries_.push({ name, codes: [] });
1314 1315
  }
  // TODO(jarin): Insert the code object into the SFI's code list.
1316
  let entry = this.codeMap_.findDynamicEntryByStartAddress(start);
1317 1318 1319 1320 1321 1322 1323 1324 1325 1326
  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) {
1327
    entry = new CodeEntry(size, name, 'JS');
1328 1329 1330 1331 1332 1333
    this.codeMap_.addCode(start, entry);

    entry.codeId = this.codeEntries_.length;

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

1334
    kind = Profile.getKindFromState(state);
1335 1336 1337 1338 1339 1340

    this.codeEntries_.push({
      name: entry.name,
      type: entry.type,
      kind: kind,
      func: func.funcId,
1341
      tm: timestamp,
1342 1343 1344 1345 1346 1347 1348 1349 1350
    });
  }
  return entry;
};

JsonProfile.prototype.moveCode = function (from, to) {
  try {
    this.codeMap_.moveCode(from, to);
  } catch (e) {
1351
    printErr(`Move: unknown source ${from}`);
1352 1353 1354 1355 1356 1357
  }
};

JsonProfile.prototype.addSourcePositions = function (
  start, script, startPos, endPos, sourcePositions, inliningPositions,
  inlinedFunctions) {
1358
  const entry = this.codeMap_.findDynamicEntryByStartAddress(start);
1359
  if (!entry) return;
1360
  const codeId = entry.codeId;
1361 1362 1363 1364

  // Resolve the inlined functions list.
  if (inlinedFunctions.length > 0) {
    inlinedFunctions = inlinedFunctions.substring(1).split("S");
1365 1366 1367
    for (let i = 0; i < inlinedFunctions.length; i++) {
      const funcAddr = parseInt(inlinedFunctions[i]);
      const func = this.codeMap_.findDynamicEntryByStartAddress(funcAddr);
1368
      if (!func || func.funcId === undefined) {
1369
        printErr(`Could not find function ${inlinedFunctions[i]}`);
1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389
        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) {
1390 1391 1392
  const script = new Script(id);
  script.update(url, source);
  this.scripts_[id] = script;
1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410
};

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,
1411
        bailoutType: bailoutType,
1412 1413 1414 1415 1416 1417 1418 1419 1420
      };
    }
  }
};

JsonProfile.prototype.deleteCode = function (start) {
  try {
    this.codeMap_.deleteCode(start);
  } catch (e) {
1421
    printErr(`Delete: unknown address ${start}`);
1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437
  }
};

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).
1438 1439 1440
  const processedStack = [];
  for (let i = 0; i < stack.length; i++) {
    const resolved = this.codeMap_.findAddress(stack[i]);
1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467
    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');
1468
  for (let i = 0; i < this.ticks_.length; i++) {
1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483
    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');
};