[llvm-locstats] Add the --compare option
Draw a plot showing the difference in debug loc coverage on two
files provided.
Differential Revision: https://reviews.llvm.org/D71870
diff --git a/llvm/utils/llvm-locstats/llvm-locstats.py b/llvm/utils/llvm-locstats/llvm-locstats.py
index 03b4082..7b2f706 100755
--- a/llvm/utils/llvm-locstats/llvm-locstats.py
+++ b/llvm/utils/llvm-locstats/llvm-locstats.py
@@ -14,6 +14,21 @@
from collections import OrderedDict
from subprocess import Popen, PIPE
+# Initialize the plot.
+def init_plot(plt):
+ plt.title('Debug Location Statistics', fontweight='bold')
+ plt.xlabel('location buckets')
+ plt.ylabel('number of variables in the location buckets')
+ plt.xticks(rotation=45, fontsize='x-small')
+ plt.yticks()
+
+# Finalize the plot.
+def finish_plot(plt):
+ plt.legend()
+ plt.grid(color='grey', which='major', axis='y', linestyle='-', linewidth=0.3)
+ plt.savefig('locstats.png')
+ print('The plot was saved within "locstats.png".')
+
# Holds the debug location statistics.
class LocationStats:
def __init__(self, file_name, variables_total, variables_total_locstats,
@@ -73,24 +88,14 @@
# Draw a plot representing the location buckets.
def draw_plot(self):
- try:
- import matplotlib
- except ImportError:
- print('error: matplotlib not found.')
- sys.exit(1)
-
from matplotlib import pyplot as plt
buckets = range(len(self.variables_coverage_map))
plt.figure(figsize=(12, 8))
- plt.title('Debug Location Statistics', fontweight='bold')
- plt.xlabel('location buckets')
- plt.ylabel('number of variables in the location buckets')
+ init_plot(plt)
plt.bar(buckets, self.variables_coverage_map.values(), align='center',
tick_label=self.variables_coverage_map.keys(),
label='variables of {}'.format(self.file_name))
- plt.xticks(rotation=45, fontsize='x-small')
- plt.yticks()
# Place the text box with the coverage info.
pc_ranges_covered = self.get_pc_coverage()
@@ -98,11 +103,47 @@
plt.text(0.02, 0.90, 'PC ranges covered: {}%'.format(pc_ranges_covered),
transform=plt.gca().transAxes, fontsize=12,
verticalalignment='top', bbox=props)
- plt.legend()
- plt.grid(color='grey', which='major', axis='y', linestyle='-', linewidth=0.3)
- plt.savefig('locstats.png')
- print('The plot was saved within "locstats.png".')
+ finish_plot(plt)
+
+ # Compare the two LocationStats objects and draw a plot showing
+ # the difference.
+ def draw_location_diff(self, locstats_to_compare):
+ from matplotlib import pyplot as plt
+
+ pc_ranges_covered = self.get_pc_coverage()
+ pc_ranges_covered_to_compare = locstats_to_compare.get_pc_coverage()
+
+ buckets = range(len(self.variables_coverage_map))
+ buckets_to_compare = range(len(locstats_to_compare.variables_coverage_map))
+
+ fig = plt.figure(figsize=(12, 8))
+ ax = fig.add_subplot(111)
+ init_plot(plt)
+
+ ax.bar(buckets, self.variables_coverage_map.values(), align='edge',
+ tick_label=self.variables_coverage_map.keys(), width=0.4,
+ label='variables of {}'.format(self.file_name))
+ ax.bar(buckets_to_compare,
+ locstats_to_compare.variables_coverage_map.values(),
+ color='r', align='edge', width=-0.4,
+ tick_label=locstats_to_compare.variables_coverage_map.keys(),
+ label='variables of {}'.format(locstats_to_compare.file_name))
+
+ props = dict(boxstyle='round', facecolor='wheat', alpha=0.5)
+ plt.text(0.02, 0.88,
+ '{} PC ranges covered: {}%'. \
+ format(self.file_name, pc_ranges_covered),
+ transform=plt.gca().transAxes, fontsize=12,
+ verticalalignment='top', bbox=props)
+ plt.text(0.02, 0.83,
+ '{} PC ranges covered: {}%'. \
+ format(locstats_to_compare.file_name,
+ pc_ranges_covered_to_compare),
+ transform=plt.gca().transAxes, fontsize=12,
+ verticalalignment='top', bbox=props)
+
+ finish_plot(plt)
# Define the location buckets.
def coverage_buckets():
@@ -233,7 +274,11 @@
parser.add_argument('--draw-plot', action='store_true', default=False,
help='show histogram of location buckets generated (requires '
'matplotlib)')
- parser.add_argument('file_name', type=str, help='file to process')
+ parser.add_argument('--compare', action='store_true', default=False,
+ help='compare the debug location coverage on two files provided, '
+ 'and draw a plot showing the difference (requires '
+ 'matplotlib)')
+ parser.add_argument('file_names', nargs='+', type=str, help='file to process')
return parser.parse_args()
@@ -247,6 +292,21 @@
print ('error: Please use just one --only* option.')
return False
+ if not opts.compare and len(opts.file_names) != 1:
+ print ('error: Please specify only one file to process.')
+ return False
+
+ if opts.compare and len(opts.file_names) != 2:
+ print ('error: Please specify two files to process.')
+ return False
+
+ if opts.draw_plot or opts.compare:
+ try:
+ import matplotlib
+ except ImportError:
+ print('error: matplotlib not found.')
+ return False
+
return True
def Main():
@@ -257,16 +317,23 @@
parser.print_help()
sys.exit(1)
- binary = opts.file_name
- locstats = parse_locstats(opts, binary)
+ binary_file = opts.file_names[0]
+ locstats = parse_locstats(opts, binary_file)
- if opts.draw_plot:
- # Draw a histogram representing the location buckets.
- locstats.draw_plot()
+ if not opts.compare:
+ if opts.draw_plot:
+ # Draw a histogram representing the location buckets.
+ locstats.draw_plot()
+ else:
+ # Pretty print collected info on the standard output.
+ if locstats.pretty_print() == -1:
+ sys.exit(0)
else:
- # Pretty print collected info on the standard output.
- if locstats.pretty_print() == -1:
- sys.exit(0)
+ binary_file_to_compare = opts.file_names[1]
+ locstats_to_compare = parse_locstats(opts, binary_file_to_compare)
+ # Draw a plot showing the difference in debug location coverage between
+ # two files.
+ locstats.draw_location_diff(locstats_to_compare)
if __name__ == '__main__':
Main()