annotate utils/prepare-code-coverage-artifact.py @ 120:1172e4bd9c6f

update 4.0.0
author mir3636
date Fri, 25 Nov 2016 19:14:25 +0900
parents
children 803732b1fca8
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
120
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
1 #!/usr/bin/env python
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
2
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
3 from __future__ import print_function
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
4
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
5 '''Prepare a code coverage artifact.
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
6
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
7 - Collate raw profiles into one indexed profile.
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
8 - Generate html reports for the given binaries.
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
9 '''
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
10
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
11 import argparse
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
12 import glob
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
13 import os
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
14 import subprocess
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
15 import sys
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
16
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
17 def merge_raw_profiles(host_llvm_profdata, profile_data_dir, preserve_profiles):
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
18 print(':: Merging raw profiles...', end='')
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
19 sys.stdout.flush()
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
20 raw_profiles = glob.glob(os.path.join(profile_data_dir, '*.profraw'))
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
21 manifest_path = os.path.join(profile_data_dir, 'profiles.manifest')
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
22 profdata_path = os.path.join(profile_data_dir, 'Coverage.profdata')
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
23 with open(manifest_path, 'w') as manifest:
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
24 manifest.write('\n'.join(raw_profiles))
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
25 subprocess.check_call([host_llvm_profdata, 'merge', '-sparse', '-f',
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
26 manifest_path, '-o', profdata_path])
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
27 if not preserve_profiles:
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
28 for raw_profile in raw_profiles:
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
29 os.remove(raw_profile)
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
30 os.remove(manifest_path)
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
31 print('Done!')
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
32 return profdata_path
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
33
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
34 def prepare_html_report(host_llvm_cov, profile, report_dir, binaries,
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
35 restricted_dirs):
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
36 print(':: Preparing html report for {0}...'.format(binaries), end='')
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
37 sys.stdout.flush()
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
38 objects = []
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
39 for i, binary in enumerate(binaries):
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
40 if i == 0:
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
41 objects.append(binary)
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
42 else:
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
43 objects.extend(('-object', binary))
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
44 invocation = [host_llvm_cov, 'show'] + objects + ['-format', 'html',
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
45 '-instr-profile', profile, '-o', report_dir,
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
46 '-show-line-counts-or-regions', '-Xdemangler', 'c++filt',
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
47 '-Xdemangler', '-n'] + restricted_dirs
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
48 subprocess.check_call(invocation)
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
49 with open(os.path.join(report_dir, 'summary.txt'), 'wb') as Summary:
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
50 subprocess.check_call([host_llvm_cov, 'report'] + objects +
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
51 ['-instr-profile', profile], stdout=Summary)
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
52 print('Done!')
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
53
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
54 def prepare_html_reports(host_llvm_cov, profdata_path, report_dir, binaries,
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
55 unified_report, restricted_dirs):
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
56 if unified_report:
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
57 prepare_html_report(host_llvm_cov, profdata_path, report_dir, binaries,
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
58 restricted_dirs)
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
59 else:
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
60 for binary in binaries:
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
61 binary_report_dir = os.path.join(report_dir,
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
62 os.path.basename(binary))
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
63 prepare_html_report(host_llvm_cov, profdata_path, binary_report_dir,
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
64 [binary], restricted_dirs)
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
65
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
66 if __name__ == '__main__':
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
67 parser = argparse.ArgumentParser(description=__doc__)
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
68 parser.add_argument('host_llvm_profdata', help='Path to llvm-profdata')
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
69 parser.add_argument('host_llvm_cov', help='Path to llvm-cov')
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
70 parser.add_argument('profile_data_dir',
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
71 help='Path to the directory containing the raw profiles')
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
72 parser.add_argument('report_dir',
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
73 help='Path to the output directory for html reports')
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
74 parser.add_argument('binaries', metavar='B', type=str, nargs='*',
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
75 help='Path to an instrumented binary')
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
76 parser.add_argument('--only-merge', action='store_true',
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
77 help='Only merge raw profiles together, skip report '
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
78 'generation')
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
79 parser.add_argument('--preserve-profiles',
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
80 help='Do not delete raw profiles', action='store_true')
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
81 parser.add_argument('--use-existing-profdata',
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
82 help='Specify an existing indexed profile to use')
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
83 parser.add_argument('--unified-report', action='store_true',
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
84 help='Emit a unified report for all binaries')
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
85 parser.add_argument('--restrict', metavar='R', type=str, nargs='*',
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
86 default=[],
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
87 help='Restrict the reporting to the given source paths')
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
88 args = parser.parse_args()
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
89
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
90 if args.use_existing_profdata and args.only_merge:
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
91 print('--use-existing-profdata and --only-merge are incompatible')
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
92 exit(1)
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
93
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
94 if args.use_existing_profdata:
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
95 profdata_path = args.use_existing_profdata
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
96 else:
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
97 profdata_path = merge_raw_profiles(args.host_llvm_profdata,
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
98 args.profile_data_dir,
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
99 args.preserve_profiles)
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
100
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
101 if not len(args.binaries):
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
102 print('No binaries specified, no work to do!')
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
103 exit(1)
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
104
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
105 if not args.only_merge:
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
106 prepare_html_reports(args.host_llvm_cov, profdata_path, args.report_dir,
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
107 args.binaries, args.unified_report, args.restrict)