1 #!/usr/bin/python2 2 # Copyright 2015 The Chromium OS Authors. All rights reserved. 3 # Use of this source code is governed by a BSD-style license that can be 4 # found in the LICENSE file. 5 """Wrapper to generate heat maps for chrome.""" 6 7 from __future__ import print_function 8 9 import argparse 10 import shutil 11 import os 12 import sys 13 import tempfile 14 from sets import Set 15 16 from cros_utils import command_executer 17 18 def IsARepoRoot(directory): 19 """Returns True if directory is the root of a repo checkout.""" 20 return os.path.exists(os.path.join(directory, '.repo')) 21 22 23 class HeatMapProducer(object): 24 """Class to produce heat map.""" 25 26 def __init__(self, chromeos_root, perf_data, page_size, binary): 27 self.chromeos_root = os.path.realpath(chromeos_root) 28 self.perf_data = os.path.realpath(perf_data) 29 self.page_size = page_size 30 self.dir = os.path.dirname(os.path.realpath(__file__)) 31 self.binary = binary 32 self.tempDir = '' 33 self.ce = command_executer.GetCommandExecuter() 34 self.loading_address = None 35 self.temp_perf = '' 36 self.temp_perf_inchroot = '' 37 self.perf_report = '' 38 39 def copyFileToChroot(self): 40 self.tempDir = tempfile.mkdtemp( 41 prefix=os.path.join(self.chromeos_root, 'src/')) 42 self.temp_perf = os.path.join(self.tempDir, 'perf.data') 43 shutil.copy2(self.perf_data, self.temp_perf) 44 self.temp_perf_inchroot = os.path.join('~/trunk/src', 45 os.path.basename(self.tempDir)) 46 47 def getPerfReport(self): 48 cmd = ('cd %s; perf report -D -i perf.data > perf_report.txt' % 49 self.temp_perf_inchroot) 50 retval = self.ce.ChrootRunCommand(self.chromeos_root, cmd) 51 if retval: 52 raise RuntimeError('Failed to generate perf report') 53 self.perf_report = os.path.join(self.tempDir, 'perf_report.txt') 54 55 def getBinaryBaseAddress(self): 56 cmd = 'grep PERF_RECORD_MMAP %s | grep "%s$"' % (self.perf_report, 57 self.binary) 58 retval, output, _ = self.ce.RunCommandWOutput(cmd) 59 if retval: 60 raise RuntimeError('Failed to run grep to get base address') 61 baseAddresses = Set() 62 for line in output.strip().split('\n'): 63 head = line.split('[')[2] 64 address = head.split('(')[0] 65 baseAddresses.add(address) 66 if len(baseAddresses) > 1: 67 raise RuntimeError( 68 'Multiple base address found, please disable ASLR and collect ' 69 'profile again') 70 if not len(baseAddresses): 71 raise RuntimeError('Could not find the base address in the profile') 72 self.loading_address = baseAddresses.pop() 73 74 def RemoveFiles(self): 75 shutil.rmtree(self.tempDir) 76 if os.path.isfile(os.path.join(os.getcwd(), 'out.txt')): 77 os.remove(os.path.join(os.getcwd(), 'out.txt')) 78 if os.path.isfile(os.path.join(os.getcwd(), 'inst-histo.txt')): 79 os.remove(os.path.join(os.getcwd(), 'inst-histo.txt')) 80 81 def getHeatmap(self): 82 if not self.loading_address: 83 return 84 heatmap_script = os.path.join(self.dir, 'perf-to-inst-page.sh') 85 cmd = '{0} {1} {2} {3} {4}'.format(heatmap_script, self.binary, 86 self.perf_report, self.loading_address, 87 self.page_size) 88 retval = self.ce.RunCommand(cmd) 89 if retval: 90 raise RuntimeError('Failed to run script to generate heatmap') 91 92 93 def main(argv): 94 """Parse the options. 95 96 Args: 97 argv: The options with which this script was invoked. 98 99 Returns: 100 0 unless an exception is raised. 101 """ 102 parser = argparse.ArgumentParser() 103 104 parser.add_argument('--chromeos_root', 105 dest='chromeos_root', 106 required=True, 107 help='ChromeOS root to use for generate heatmaps.') 108 parser.add_argument('--perf_data', 109 dest='perf_data', 110 required=True, 111 help='The raw perf data.') 112 parser.add_argument('--binary', 113 dest='binary', 114 required=False, 115 help='The name of the binary.', 116 default='chrome') 117 parser.add_argument('--page_size', 118 dest='page_size', 119 required=False, 120 help='The page size for heat maps.', 121 default=4096) 122 options = parser.parse_args(argv) 123 124 if not IsARepoRoot(options.chromeos_root): 125 parser.error('% does not contain .repo dir.' % options.chromeos_root) 126 127 if not os.path.isfile(options.perf_data): 128 parser.error('Cannot find perf_data: %s.' % options.perf_data) 129 130 heatmap_producer = HeatMapProducer(options.chromeos_root, options.perf_data, 131 options.page_size, options.binary) 132 try: 133 heatmap_producer.copyFileToChroot() 134 heatmap_producer.getPerfReport() 135 heatmap_producer.getBinaryBaseAddress() 136 heatmap_producer.getHeatmap() 137 print('\nheat map and time histgram genereated in the current directory ' 138 'with name heat_map.png and timeline.png accordingly.') 139 except RuntimeError, e: 140 print(e) 141 finally: 142 heatmap_producer.RemoveFiles() 143 144 145 if __name__ == '__main__': 146 sys.exit(main(sys.argv[1:])) 147
