tickprocessor.js 30.2 KB
Newer Older
1
// Copyright 2012 the V8 project authors. All rights reserved.
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 28
// 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.


29 30 31 32 33 34 35
function inherits(childCtor, parentCtor) {
  childCtor.prototype.__proto__ = parentCtor.prototype;
};


function V8Profile(separateIc) {
  Profile.call(this);
36
  if (!separateIc) {
37
    this.skipThisFunction = function(name) { return V8Profile.IC_RE.test(name); };
38 39
  }
};
40
inherits(V8Profile, Profile);
41 42


43
V8Profile.IC_RE =
44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59
    /^(?:CallIC|LoadIC|StoreIC)|(?:Builtin: (?:Keyed)?(?:Call|Load|Store)IC_)/;


/**
 * A thin wrapper around shell's 'read' function showing a file name on error.
 */
function readFile(fileName) {
  try {
    return read(fileName);
  } catch (e) {
    print(fileName + ': ' + (e.message || e));
    throw e;
  }
}


60 61 62 63 64 65 66 67 68 69 70 71 72
/**
 * Parser for dynamic code optimization state.
 */
function parseState(s) {
  switch (s) {
  case "": return Profile.CodeState.COMPILED;
  case "~": return Profile.CodeState.OPTIMIZABLE;
  case "*": return Profile.CodeState.OPTIMIZED;
  }
  throw new Error("unknown code state: " + s);
}


73
function SnapshotLogProcessor() {
74
  LogReader.call(this, {
75
      'code-creation': {
76
          parsers: [null, parseInt, parseInt, parseInt, null, 'var-args'],
77 78 79
          processor: this.processCodeCreation },
      'code-move': { parsers: [parseInt, parseInt],
          processor: this.processCodeMove },
80 81
      'code-delete': { parsers: [parseInt],
          processor: this.processCodeDelete },
82 83 84
      'function-creation': null,
      'function-move': null,
      'function-delete': null,
85
      'sfi-move': null,
86 87
      'snapshot-pos': { parsers: [parseInt, parseInt],
          processor: this.processSnapshotPosition }});
88

89 90
  V8Profile.prototype.handleUnknownCode = function(operation, addr) {
    var op = Profile.Operation;
91 92 93 94 95
    switch (operation) {
      case op.MOVE:
        print('Snapshot: Code move event for unknown code: 0x' +
              addr.toString(16));
        break;
96 97 98 99
      case op.DELETE:
        print('Snapshot: Code delete event for unknown code: 0x' +
              addr.toString(16));
        break;
100 101 102
    }
  };

103
  this.profile_ = new V8Profile();
104 105
  this.serializedEntries_ = [];
}
106
inherits(SnapshotLogProcessor, LogReader);
107 108 109


SnapshotLogProcessor.prototype.processCodeCreation = function(
110
    type, kind, start, size, name, maybe_func) {
111 112 113 114 115 116 117
  if (maybe_func.length) {
    var funcAddr = parseInt(maybe_func[0]);
    var state = parseState(maybe_func[1]);
    this.profile_.addFuncCode(type, name, start, size, funcAddr, state);
  } else {
    this.profile_.addCode(type, name, start, size);
  }
118 119 120 121 122 123 124 125
};


SnapshotLogProcessor.prototype.processCodeMove = function(from, to) {
  this.profile_.moveCode(from, to);
};


126 127 128 129 130
SnapshotLogProcessor.prototype.processCodeDelete = function(start) {
  this.profile_.deleteCode(start);
};


131 132 133 134 135 136 137 138 139 140 141 142 143 144
SnapshotLogProcessor.prototype.processSnapshotPosition = function(addr, pos) {
  this.serializedEntries_[pos] = this.profile_.findEntry(addr);
};


SnapshotLogProcessor.prototype.processLogFile = function(fileName) {
  var contents = readFile(fileName);
  this.processLogChunk(contents);
};


SnapshotLogProcessor.prototype.getSerializedEntryName = function(pos) {
  var entry = this.serializedEntries_[pos];
  return entry ? entry.getRawName() : null;
145 146 147
};


148
function TickProcessor(
149 150 151 152 153
    cppEntriesProvider,
    separateIc,
    callGraphSize,
    ignoreUnknown,
    stateFilter,
154 155
    snapshotLogProcessor,
    distortion,
156
    range,
jkummerow's avatar
jkummerow committed
157
    sourceMap,
158
    timedRange,
159 160
    pairwiseTimedRange,
    onlySummary) {
161
  LogReader.call(this, {
162 163 164
      'shared-library': { parsers: [null, parseInt, parseInt],
          processor: this.processSharedLibrary },
      'code-creation': {
165
          parsers: [null, parseInt, parseInt, parseInt, null, 'var-args'],
166 167 168
          processor: this.processCodeCreation },
      'code-move': { parsers: [parseInt, parseInt],
          processor: this.processCodeMove },
169 170
      'code-delete': { parsers: [parseInt],
          processor: this.processCodeDelete },
171
      'sfi-move': { parsers: [parseInt, parseInt],
172 173 174
          processor: this.processFunctionMove },
      'snapshot-pos': { parsers: [parseInt, parseInt],
          processor: this.processSnapshotPosition },
175
      'tick': {
176
          parsers: [parseInt, parseInt, parseInt,
177
                    parseInt, parseInt, 'var-args'],
178
          processor: this.processTick },
179 180 181 182
      'heap-sample-begin': { parsers: [null, null, parseInt],
          processor: this.processHeapSampleBegin },
      'heap-sample-end': { parsers: [null, null],
          processor: this.processHeapSampleEnd },
183 184 185 186
      'timer-event-start' : { parsers: [null, null, null],
                              processor: this.advanceDistortion },
      'timer-event-end' : { parsers: [null, null, null],
                            processor: this.advanceDistortion },
187
      // Ignored events.
188
      'profiler': null,
189 190 191
      'function-creation': null,
      'function-move': null,
      'function-delete': null,
192
      'heap-sample-item': null,
jkummerow's avatar
jkummerow committed
193
      'current-time': null,  // Handled specially, not parsed.
194 195 196
      // Obsolete row types.
      'code-allocate': null,
      'begin-code-region': null,
jkummerow's avatar
jkummerow committed
197
      'end-code-region': null },
198 199
      timedRange,
      pairwiseTimedRange);
200

201
  this.cppEntriesProvider_ = cppEntriesProvider;
202
  this.callGraphSize_ = callGraphSize;
203 204
  this.ignoreUnknown_ = ignoreUnknown;
  this.stateFilter_ = stateFilter;
205
  this.snapshotLogProcessor_ = snapshotLogProcessor;
206
  this.sourceMap = sourceMap;
207
  this.deserializedEntriesNames_ = [];
208 209 210
  var ticks = this.ticks_ =
    { total: 0, unaccounted: 0, excluded: 0, gc: 0 };

211 212 213 214
  distortion = parseInt(distortion);
  // Convert picoseconds to nanoseconds.
  this.distortion_per_entry = isNaN(distortion) ? 0 : (distortion / 1000);
  this.distortion = 0;
215
  var rangelimits = range ? range.split(",") : [];
216 217 218 219 220 221
  var range_start = parseInt(rangelimits[0]);
  var range_end = parseInt(rangelimits[1]);
  // Convert milliseconds to nanoseconds.
  this.range_start = isNaN(range_start) ? -Infinity : (range_start * 1000);
  this.range_end = isNaN(range_end) ? Infinity : (range_end * 1000)

222
  V8Profile.prototype.handleUnknownCode = function(
223
      operation, addr, opt_stackPos) {
224
    var op = Profile.Operation;
225 226 227 228
    switch (operation) {
      case op.MOVE:
        print('Code move event for unknown code: 0x' + addr.toString(16));
        break;
229 230 231
      case op.DELETE:
        print('Code delete event for unknown code: 0x' + addr.toString(16));
        break;
232 233 234 235 236 237 238 239 240 241 242
      case op.TICK:
        // Only unknown PCs (the first frame) are reported as unaccounted,
        // otherwise tick balance will be corrupted (this behavior is compatible
        // with the original tickprocessor.py script.)
        if (opt_stackPos == 0) {
          ticks.unaccounted++;
        }
        break;
    }
  };

243
  this.profile_ = new V8Profile(separateIc);
244 245
  this.codeTypes_ = {};
  // Count each tick as a time unit.
246
  this.viewBuilder_ = new ViewBuilder(1);
247
  this.lastLogFileName_ = null;
248 249 250

  this.generation_ = 1;
  this.currentProducerProfile_ = null;
251
  this.onlySummary_ = onlySummary;
252
};
253
inherits(TickProcessor, LogReader);
254 255 256 257 258 259


TickProcessor.VmStates = {
  JS: 0,
  GC: 1,
  COMPILER: 2,
260
  OTHER: 3,
261 262
  EXTERNAL: 4,
  IDLE: 5
263 264 265 266
};


TickProcessor.CodeTypes = {
267 268
  CPP: 0,
  SHARED_LIB: 1
269
};
270 271
// Otherwise, this is JS-related code. We are not adding it to
// codeTypes_ map because there can be zillions of them.
272 273 274 275


TickProcessor.CALL_PROFILE_CUTOFF_PCT = 2.0;

276
TickProcessor.CALL_GRAPH_SIZE = 5;
277

278 279 280 281 282 283 284 285
/**
 * @override
 */
TickProcessor.prototype.printError = function(str) {
  print(str);
};


286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301
TickProcessor.prototype.setCodeType = function(name, type) {
  this.codeTypes_[name] = TickProcessor.CodeTypes[type];
};


TickProcessor.prototype.isSharedLibrary = function(name) {
  return this.codeTypes_[name] == TickProcessor.CodeTypes.SHARED_LIB;
};


TickProcessor.prototype.isCppCode = function(name) {
  return this.codeTypes_[name] == TickProcessor.CodeTypes.CPP;
};


TickProcessor.prototype.isJsCode = function(name) {
jkummerow's avatar
jkummerow committed
302
  return name !== "UNKNOWN" && !(name in this.codeTypes_);
303 304 305 306 307
};


TickProcessor.prototype.processLogFile = function(fileName) {
  this.lastLogFileName_ = fileName;
308 309 310 311
  var line;
  while (line = readline()) {
    this.processLogLine(line);
  }
312 313 314
};


315 316 317 318 319 320 321 322
TickProcessor.prototype.processLogFileInTest = function(fileName) {
   // Hack file name to avoid dealing with platform specifics.
  this.lastLogFileName_ = 'v8.log';
  var contents = readFile(fileName);
  this.processLogChunk(contents);
};


323 324
TickProcessor.prototype.processSharedLibrary = function(
    name, startAddr, endAddr) {
325
  var entry = this.profile_.addLibrary(name, startAddr, endAddr);
326 327 328 329 330 331 332 333 334 335 336 337
  this.setCodeType(entry.getName(), 'SHARED_LIB');

  var self = this;
  var libFuncs = this.cppEntriesProvider_.parseVmSymbols(
      name, startAddr, endAddr, function(fName, fStart, fEnd) {
    self.profile_.addStaticCode(fName, fStart, fEnd);
    self.setCodeType(fName, 'CPP');
  });
};


TickProcessor.prototype.processCodeCreation = function(
338
    type, kind, start, size, name, maybe_func) {
339
  name = this.deserializedEntriesNames_[start] || name;
340 341 342 343 344 345 346
  if (maybe_func.length) {
    var funcAddr = parseInt(maybe_func[0]);
    var state = parseState(maybe_func[1]);
    this.profile_.addFuncCode(type, name, start, size, funcAddr, state);
  } else {
    this.profile_.addCode(type, name, start, size);
  }
347 348 349 350 351 352 353 354
};


TickProcessor.prototype.processCodeMove = function(from, to) {
  this.profile_.moveCode(from, to);
};


355 356 357 358 359
TickProcessor.prototype.processCodeDelete = function(start) {
  this.profile_.deleteCode(start);
};


360
TickProcessor.prototype.processFunctionMove = function(from, to) {
361
  this.profile_.moveFunc(from, to);
362 363 364
};


365 366 367 368 369 370 371 372
TickProcessor.prototype.processSnapshotPosition = function(addr, pos) {
  if (this.snapshotLogProcessor_) {
    this.deserializedEntriesNames_[addr] =
      this.snapshotLogProcessor_.getSerializedEntryName(pos);
  }
};


373 374 375 376
TickProcessor.prototype.includeTick = function(vmState) {
  return this.stateFilter_ == null || this.stateFilter_ == vmState;
};

377
TickProcessor.prototype.processTick = function(pc,
378
                                               ns_since_start,
379 380
                                               is_external_callback,
                                               tos_or_external_callback,
381 382
                                               vmState,
                                               stack) {
383 384 385 386 387
  this.distortion += this.distortion_per_entry;
  ns_since_start -= this.distortion;
  if (ns_since_start < this.range_start || ns_since_start > this.range_end) {
    return;
  }
388 389 390 391 392 393
  this.ticks_.total++;
  if (vmState == TickProcessor.VmStates.GC) this.ticks_.gc++;
  if (!this.includeTick(vmState)) {
    this.ticks_.excluded++;
    return;
  }
394
  if (is_external_callback) {
395 396
    // Don't use PC when in external callback code, as it can point
    // inside callback's code, and we will erroneously report
397 398
    // that a callback calls itself. Instead we use tos_or_external_callback,
    // as simply resetting PC will produce unaccounted ticks.
399 400 401 402 403 404 405 406 407 408
    pc = tos_or_external_callback;
    tos_or_external_callback = 0;
  } else if (tos_or_external_callback) {
    // Find out, if top of stack was pointing inside a JS function
    // meaning that we have encountered a frameless invocation.
    var funcEntry = this.profile_.findEntry(tos_or_external_callback);
    if (!funcEntry || !funcEntry.isJSFunction || !funcEntry.isJSFunction()) {
      tos_or_external_callback = 0;
    }
  }
409

410
  this.profile_.recordTick(this.processStack(pc, tos_or_external_callback, stack));
411 412 413
};


414 415 416 417 418
TickProcessor.prototype.advanceDistortion = function() {
  this.distortion += this.distortion_per_entry;
}


419 420
TickProcessor.prototype.processHeapSampleBegin = function(space, state, ticks) {
  if (space != 'Heap') return;
421
  this.currentProducerProfile_ = new CallTree();
422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442
};


TickProcessor.prototype.processHeapSampleEnd = function(space, state) {
  if (space != 'Heap' || !this.currentProducerProfile_) return;

  print('Generation ' + this.generation_ + ':');
  var tree = this.currentProducerProfile_;
  tree.computeTotalWeights();
  var producersView = this.viewBuilder_.buildView(tree);
  // Sort by total time, desc, then by name, desc.
  producersView.sort(function(rec1, rec2) {
      return rec2.totalTime - rec1.totalTime ||
          (rec2.internalFuncName < rec1.internalFuncName ? -1 : 1); });
  this.printHeavyProfile(producersView.head.children);

  this.currentProducerProfile_ = null;
  this.generation_++;
};


443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460
TickProcessor.prototype.printStatistics = function() {
  print('Statistical profiling result from ' + this.lastLogFileName_ +
        ', (' + this.ticks_.total +
        ' ticks, ' + this.ticks_.unaccounted + ' unaccounted, ' +
        this.ticks_.excluded + ' excluded).');

  if (this.ticks_.total == 0) return;

  var flatProfile = this.profile_.getFlatProfile();
  var flatView = this.viewBuilder_.buildView(flatProfile);
  // Sort by self time, desc, then by name, desc.
  flatView.sort(function(rec1, rec2) {
      return rec2.selfTime - rec1.selfTime ||
          (rec2.internalFuncName < rec1.internalFuncName ? -1 : 1); });
  var totalTicks = this.ticks_.total;
  if (this.ignoreUnknown_) {
    totalTicks -= this.ticks_.unaccounted;
  }
461
  var printAllTicks = !this.onlySummary_;
462 463 464 465

  // Count library ticks
  var flatViewNodes = flatView.head.children;
  var self = this;
466

467
  var libraryTicks = 0;
468
  if(printAllTicks) this.printHeader('Shared libraries');
469
  this.printEntries(flatViewNodes, totalTicks, null,
470
      function(name) { return self.isSharedLibrary(name); },
471
      function(rec) { libraryTicks += rec.selfTime; }, printAllTicks);
472 473
  var nonLibraryTicks = totalTicks - libraryTicks;

474
  var jsTicks = 0;
475
  if(printAllTicks) this.printHeader('JavaScript');
476 477
  this.printEntries(flatViewNodes, totalTicks, nonLibraryTicks,
      function(name) { return self.isJsCode(name); },
478
      function(rec) { jsTicks += rec.selfTime; }, printAllTicks);
479

480
  var cppTicks = 0;
481
  if(printAllTicks) this.printHeader('C++');
482 483
  this.printEntries(flatViewNodes, totalTicks, nonLibraryTicks,
      function(name) { return self.isCppCode(name); },
484
      function(rec) { cppTicks += rec.selfTime; }, printAllTicks);
485 486 487 488 489 490 491 492 493 494

  this.printHeader('Summary');
  this.printLine('JavaScript', jsTicks, totalTicks, nonLibraryTicks);
  this.printLine('C++', cppTicks, totalTicks, nonLibraryTicks);
  this.printLine('GC', this.ticks_.gc, totalTicks, nonLibraryTicks);
  this.printLine('Shared libraries', libraryTicks, totalTicks, null);
  if (!this.ignoreUnknown_ && this.ticks_.unaccounted > 0) {
    this.printLine('Unaccounted', this.ticks_.unaccounted,
                   this.ticks_.total, null);
  }
495

496 497 498 499 500 501 502 503 504
  if(printAllTicks) {
    print('\n [C++ entry points]:');
    print('   ticks    cpp   total   name');
    var c_entry_functions = this.profile_.getCEntryProfile();
    var total_c_entry = c_entry_functions[0].ticks;
    for (var i = 1; i < c_entry_functions.length; i++) {
      c = c_entry_functions[i];
      this.printLine(c.name, c.ticks, total_c_entry, totalTicks);
    }
505

506 507 508 509 510 511 512 513 514 515 516
    this.printHeavyProfHeader();
    var heavyProfile = this.profile_.getBottomUpProfile();
    var heavyView = this.viewBuilder_.buildView(heavyProfile);
    // To show the same percentages as in the flat profile.
    heavyView.head.totalTime = totalTicks;
    // Sort by total time, desc, then by name, desc.
    heavyView.sort(function(rec1, rec2) {
        return rec2.totalTime - rec1.totalTime ||
            (rec2.internalFuncName < rec1.internalFuncName ? -1 : 1); });
    this.printHeavyProfile(heavyView.head.children);
  }
517 518 519 520 521 522
};


function padLeft(s, len) {
  s = s.toString();
  if (s.length < len) {
523 524 525 526 527
    var padLength = len - s.length;
    if (!(padLength in padLeft)) {
      padLeft[padLength] = new Array(padLength + 1).join(' ');
    }
    s = padLeft[padLength] + s;
528 529 530 531 532 533 534 535 536 537 538
  }
  return s;
};


TickProcessor.prototype.printHeader = function(headerTitle) {
  print('\n [' + headerTitle + ']:');
  print('   ticks  total  nonlib   name');
};


539 540 541 542 543 544 545 546 547 548 549 550
TickProcessor.prototype.printLine = function(
    entry, ticks, totalTicks, nonLibTicks) {
  var pct = ticks * 100 / totalTicks;
  var nonLibPct = nonLibTicks != null
      ? padLeft((ticks * 100 / nonLibTicks).toFixed(1), 5) + '%  '
      : '        ';
  print('  ' + padLeft(ticks, 5) + '  ' +
        padLeft(pct.toFixed(1), 5) + '%  ' +
        nonLibPct +
        entry);
}

551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566
TickProcessor.prototype.printHeavyProfHeader = function() {
  print('\n [Bottom up (heavy) profile]:');
  print('  Note: percentage shows a share of a particular caller in the ' +
        'total\n' +
        '  amount of its parent calls.');
  print('  Callers occupying less than ' +
        TickProcessor.CALL_PROFILE_CUTOFF_PCT.toFixed(1) +
        '% are not shown.\n');
  print('   ticks parent  name');
};


TickProcessor.prototype.processProfile = function(
    profile, filterP, func) {
  for (var i = 0, n = profile.length; i < n; ++i) {
    var rec = profile[i];
567
    if (!filterP(rec.internalFuncName)) {
568 569 570 571 572 573
      continue;
    }
    func(rec);
  }
};

574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605
TickProcessor.prototype.getLineAndColumn = function(name) {
  var re = /:([0-9]+):([0-9]+)$/;
  var array = re.exec(name);
  if (!array) {
    return null;
  }
  return {line: array[1], column: array[2]};
}

TickProcessor.prototype.hasSourceMap = function() {
  return this.sourceMap != null;
};


TickProcessor.prototype.formatFunctionName = function(funcName) {
  if (!this.hasSourceMap()) {
    return funcName;
  }
  var lc = this.getLineAndColumn(funcName);
  if (lc == null) {
    return funcName;
  }
  // in source maps lines and columns are zero based
  var lineNumber = lc.line - 1;
  var column = lc.column - 1;
  var entry = this.sourceMap.findEntry(lineNumber, column);
  var sourceFile = entry[2];
  var sourceLine = entry[3] + 1;
  var sourceColumn = entry[4] + 1;

  return sourceFile + ':' + sourceLine + ':' + sourceColumn + ' -> ' + funcName;
};
606 607

TickProcessor.prototype.printEntries = function(
608
    profile, totalTicks, nonLibTicks, filterP, callback, printAllTicks) {
609
  var that = this;
610 611
  this.processProfile(profile, filterP, function (rec) {
    if (rec.selfTime == 0) return;
612
    callback(rec);
613
    var funcName = that.formatFunctionName(rec.internalFuncName);
614 615 616
    if(printAllTicks) {
      that.printLine(funcName, rec.selfTime, totalTicks, nonLibTicks);
    }
617 618 619 620 621 622 623 624 625 626 627
  });
};


TickProcessor.prototype.printHeavyProfile = function(profile, opt_indent) {
  var self = this;
  var indent = opt_indent || 0;
  var indentStr = padLeft('', indent);
  this.processProfile(profile, function() { return true; }, function (rec) {
    // Cut off too infrequent callers.
    if (rec.parentTotalPercent < TickProcessor.CALL_PROFILE_CUTOFF_PCT) return;
628
    var funcName = self.formatFunctionName(rec.internalFuncName);
629 630
    print('  ' + padLeft(rec.totalTime, 5) + '  ' +
          padLeft(rec.parentTotalPercent.toFixed(1), 5) + '%  ' +
631
          indentStr + funcName);
632
    // Limit backtrace depth.
633
    if (indent < 2 * self.callGraphSize_) {
634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649
      self.printHeavyProfile(rec.children, indent + 2);
    }
    // Delimit top-level functions.
    if (indent == 0) {
      print('');
    }
  });
};


function CppEntriesProvider() {
};


CppEntriesProvider.prototype.parseVmSymbols = function(
    libName, libStart, libEnd, processorFunc) {
650
  this.loadSymbols(libName);
651 652 653

  var prevEntry;

654
  function addEntry(funcInfo) {
655 656
    // Several functions can be mapped onto the same address. To avoid
    // creating zero-sized entries, skip such duplicates.
657
    // Also double-check that function belongs to the library address space.
658 659 660 661
    if (prevEntry && !prevEntry.end &&
        prevEntry.start < funcInfo.start &&
        prevEntry.start >= libStart && funcInfo.start <= libEnd) {
      processorFunc(prevEntry.name, prevEntry.start, funcInfo.start);
662
    }
663 664 665 666 667 668
    if (funcInfo.end &&
        (!prevEntry || prevEntry.start != funcInfo.start) &&
        funcInfo.start >= libStart && funcInfo.end <= libEnd) {
      processorFunc(funcInfo.name, funcInfo.start, funcInfo.end);
    }
    prevEntry = funcInfo;
669 670
  }

671 672 673
  while (true) {
    var funcInfo = this.parseNextLine();
    if (funcInfo === null) {
674
      continue;
675 676
    } else if (funcInfo === false) {
      break;
677 678 679 680
    }
    if (funcInfo.start < libStart && funcInfo.start < libEnd - libStart) {
      funcInfo.start += libStart;
    }
681 682 683 684
    if (funcInfo.size) {
      funcInfo.end = funcInfo.start + funcInfo.size;
    }
    addEntry(funcInfo);
685
  }
686
  addEntry({name: '', start: libEnd});
687 688 689 690 691 692 693
};


CppEntriesProvider.prototype.loadSymbols = function(libName) {
};


694 695
CppEntriesProvider.prototype.parseNextLine = function() {
  return false;
696 697 698
};


699
function UnixCppEntriesProvider(nmExec, targetRootFS) {
700 701
  this.symbols = [];
  this.parsePos = 0;
702
  this.nmExec = nmExec;
703
  this.targetRootFS = targetRootFS;
704
  this.FUNC_RE = /^([0-9a-fA-F]{8,16}) ([0-9a-fA-F]{8,16} )?[tTwW] (.*)$/;
705 706 707 708 709
};
inherits(UnixCppEntriesProvider, CppEntriesProvider);


UnixCppEntriesProvider.prototype.loadSymbols = function(libName) {
710
  this.parsePos = 0;
711
  libName = this.targetRootFS + libName;
712 713
  try {
    this.symbols = [
714 715
      os.system(this.nmExec, ['-C', '-n', '-S', libName], -1, -1),
      os.system(this.nmExec, ['-C', '-n', '-S', '-D', libName], -1, -1)
716 717 718
    ];
  } catch (e) {
    // If the library cannot be found on this system let's not panic.
719
    this.symbols = ['', ''];
720
  }
721 722 723
};


724 725 726 727 728 729 730 731 732 733 734 735 736
UnixCppEntriesProvider.prototype.parseNextLine = function() {
  if (this.symbols.length == 0) {
    return false;
  }
  var lineEndPos = this.symbols[0].indexOf('\n', this.parsePos);
  if (lineEndPos == -1) {
    this.symbols.shift();
    this.parsePos = 0;
    return this.parseNextLine();
  }

  var line = this.symbols[0].substring(this.parsePos, lineEndPos);
  this.parsePos = lineEndPos + 1;
737
  var fields = line.match(this.FUNC_RE);
738 739 740 741 742 743 744 745
  var funcInfo = null;
  if (fields) {
    funcInfo = { name: fields[3], start: parseInt(fields[1], 16) };
    if (fields[2]) {
      funcInfo.size = parseInt(fields[2], 16);
    }
  }
  return funcInfo;
746 747 748
};


749 750
function MacCppEntriesProvider(nmExec, targetRootFS) {
  UnixCppEntriesProvider.call(this, nmExec, targetRootFS);
751
  // Note an empty group. It is required, as UnixCppEntriesProvider expects 3 groups.
752
  this.FUNC_RE = /^([0-9a-fA-F]{8,16}) ()[iItT] (.*)$/;
753 754 755 756 757 758
};
inherits(MacCppEntriesProvider, UnixCppEntriesProvider);


MacCppEntriesProvider.prototype.loadSymbols = function(libName) {
  this.parsePos = 0;
759
  libName = this.targetRootFS + libName;
760 761 762 763 764 765 766 767 768
  try {
    this.symbols = [os.system(this.nmExec, ['-n', '-f', libName], -1, -1), ''];
  } catch (e) {
    // If the library cannot be found on this system let's not panic.
    this.symbols = '';
  }
};


769 770
function WindowsCppEntriesProvider(_ignored_nmExec, targetRootFS) {
  this.targetRootFS = targetRootFS;
771 772
  this.symbols = '';
  this.parsePos = 0;
773 774 775 776
};
inherits(WindowsCppEntriesProvider, CppEntriesProvider);


777
WindowsCppEntriesProvider.FILENAME_RE = /^(.*)\.([^.]+)$/;
778 779 780


WindowsCppEntriesProvider.FUNC_RE =
781 782 783 784 785 786 787 788 789
    /^\s+0001:[0-9a-fA-F]{8}\s+([_\?@$0-9a-zA-Z]+)\s+([0-9a-fA-F]{8}).*$/;


WindowsCppEntriesProvider.IMAGE_BASE_RE =
    /^\s+0000:00000000\s+___ImageBase\s+([0-9a-fA-F]{8}).*$/;


// This is almost a constant on Windows.
WindowsCppEntriesProvider.EXE_IMAGE_BASE = 0x00400000;
790 791 792


WindowsCppEntriesProvider.prototype.loadSymbols = function(libName) {
793
  libName = this.targetRootFS + libName;
794
  var fileNameFields = libName.match(WindowsCppEntriesProvider.FILENAME_RE);
795
  if (!fileNameFields) return;
796
  var mapFileName = fileNameFields[1] + '.map';
797 798 799 800 801 802 803
  this.moduleType_ = fileNameFields[2].toLowerCase();
  try {
    this.symbols = read(mapFileName);
  } catch (e) {
    // If .map file cannot be found let's not panic.
    this.symbols = '';
  }
804 805 806
};


807 808 809 810 811 812 813 814
WindowsCppEntriesProvider.prototype.parseNextLine = function() {
  var lineEndPos = this.symbols.indexOf('\r\n', this.parsePos);
  if (lineEndPos == -1) {
    return false;
  }

  var line = this.symbols.substring(this.parsePos, lineEndPos);
  this.parsePos = lineEndPos + 2;
815 816 817 818 819 820 821 822 823 824 825 826

  // Image base entry is above all other symbols, so we can just
  // terminate parsing.
  var imageBaseFields = line.match(WindowsCppEntriesProvider.IMAGE_BASE_RE);
  if (imageBaseFields) {
    var imageBase = parseInt(imageBaseFields[1], 16);
    if ((this.moduleType_ == 'exe') !=
        (imageBase == WindowsCppEntriesProvider.EXE_IMAGE_BASE)) {
      return false;
    }
  }

827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851
  var fields = line.match(WindowsCppEntriesProvider.FUNC_RE);
  return fields ?
      { name: this.unmangleName(fields[1]), start: parseInt(fields[2], 16) } :
      null;
};


/**
 * Performs very simple unmangling of C++ names.
 *
 * Does not handle arguments and template arguments. The mangled names have
 * the form:
 *
 *   ?LookupInDescriptor@JSObject@internal@v8@@...arguments info...
 */
WindowsCppEntriesProvider.prototype.unmangleName = function(name) {
  // Empty or non-mangled name.
  if (name.length < 1 || name.charAt(0) != '?') return name;
  var nameEndPos = name.indexOf('@@');
  var components = name.substring(1, nameEndPos).split('@');
  components.reverse();
  return components.join('::');
};


852 853 854
function ArgumentsProcessor(args) {
  this.args_ = args;
  this.result_ = ArgumentsProcessor.DEFAULTS;
855

856
  this.argsDispatch_ = {
857 858 859 860 861 862 863 864 865 866
    '-j': ['stateFilter', TickProcessor.VmStates.JS,
        'Show only ticks from JS VM state'],
    '-g': ['stateFilter', TickProcessor.VmStates.GC,
        'Show only ticks from GC VM state'],
    '-c': ['stateFilter', TickProcessor.VmStates.COMPILER,
        'Show only ticks from COMPILER VM state'],
    '-o': ['stateFilter', TickProcessor.VmStates.OTHER,
        'Show only ticks from OTHER VM state'],
    '-e': ['stateFilter', TickProcessor.VmStates.EXTERNAL,
        'Show only ticks from EXTERNAL VM state'],
867 868
    '--call-graph-size': ['callGraphSize', TickProcessor.CALL_GRAPH_SIZE,
        'Set the call graph size'],
869 870 871 872 873 874 875
    '--ignore-unknown': ['ignoreUnknown', true,
        'Exclude ticks of unknown code entries from processing'],
    '--separate-ic': ['separateIc', true,
        'Separate IC entries'],
    '--unix': ['platform', 'unix',
        'Specify that we are running on *nix platform'],
    '--windows': ['platform', 'windows',
876
        'Specify that we are running on Windows platform'],
877 878
    '--mac': ['platform', 'mac',
        'Specify that we are running on Mac OS X platform'],
879
    '--nm': ['nm', 'nm',
880
        'Specify the \'nm\' executable to use (e.g. --nm=/my_dir/nm)'],
881 882
    '--target': ['targetRootFS', '',
        'Specify the target root directory for cross environment'],
883
    '--snapshot-log': ['snapshotLogFileName', 'snapshot.log',
884 885
        'Specify snapshot log file to use (e.g. --snapshot-log=snapshot.log)'],
    '--range': ['range', 'auto,auto',
886
        'Specify the range limit as [start],[end]'],
887
    '--distortion': ['distortion', 0,
888 889
        'Specify the logging overhead in picoseconds'],
    '--source-map': ['sourceMap', null,
jkummerow's avatar
jkummerow committed
890 891
        'Specify the source map that should be used for output'],
    '--timed-range': ['timedRange', true,
892 893
        'Ignore ticks before first and after last Date.now() call'],
    '--pairwise-timed-range': ['pairwiseTimedRange', true,
894 895 896
        'Ignore ticks outside pairs of Date.now() calls'],
    '--only-summary': ['onlySummary', true,
        'Print only tick summary, exclude other information']
897
  };
898 899 900 901 902
  this.argsDispatch_['--js'] = this.argsDispatch_['-j'];
  this.argsDispatch_['--gc'] = this.argsDispatch_['-g'];
  this.argsDispatch_['--compiler'] = this.argsDispatch_['-c'];
  this.argsDispatch_['--other'] = this.argsDispatch_['-o'];
  this.argsDispatch_['--external'] = this.argsDispatch_['-e'];
903
  this.argsDispatch_['--ptr'] = this.argsDispatch_['--pairwise-timed-range'];
904 905
};

906

907 908
ArgumentsProcessor.DEFAULTS = {
  logFileName: 'v8.log',
909
  snapshotLogFileName: null,
910 911
  platform: 'unix',
  stateFilter: null,
912
  callGraphSize: 5,
913 914
  ignoreUnknown: false,
  separateIc: false,
915
  targetRootFS: '',
916 917
  nm: 'nm',
  range: 'auto,auto',
jkummerow's avatar
jkummerow committed
918
  distortion: 0,
919
  timedRange: false,
920 921
  pairwiseTimedRange: false,
  onlySummary: false
922 923 924 925 926
};


ArgumentsProcessor.prototype.parse = function() {
  while (this.args_.length) {
927
    var arg = this.args_.shift();
928
    if (arg.charAt(0) != '-') {
929 930
      this.result_.logFileName = arg;
      continue;
931
    }
932 933 934 935 936 937
    var userValue = null;
    var eqPos = arg.indexOf('=');
    if (eqPos != -1) {
      userValue = arg.substr(eqPos + 1);
      arg = arg.substr(0, eqPos);
    }
938 939 940
    if (arg in this.argsDispatch_) {
      var dispatch = this.argsDispatch_[arg];
      this.result_[dispatch[0]] = userValue == null ? dispatch[1] : userValue;
941
    } else {
942
      return false;
943 944
    }
  }
945
  return true;
946 947 948
};


949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968
ArgumentsProcessor.prototype.result = function() {
  return this.result_;
};


ArgumentsProcessor.prototype.printUsageAndExit = function() {

  function padRight(s, len) {
    s = s.toString();
    if (s.length < len) {
      s = s + (new Array(len - s.length + 1).join(' '));
    }
    return s;
  }

  print('Cmdline args: [options] [log-file-name]\n' +
        'Default log file name is "' +
        ArgumentsProcessor.DEFAULTS.logFileName + '".\n');
  print('Options:');
  for (var arg in this.argsDispatch_) {
969
    var synonyms = [arg];
970 971 972
    var dispatch = this.argsDispatch_[arg];
    for (var synArg in this.argsDispatch_) {
      if (arg !== synArg && dispatch === this.argsDispatch_[synArg]) {
973
        synonyms.push(synArg);
974 975 976
        delete this.argsDispatch_[synArg];
      }
    }
977
    print('  ' + padRight(synonyms.join(', '), 20) + " " + dispatch[2]);
978 979 980
  }
  quit(2);
};