buildstats-diff 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302
  1. #!/usr/bin/python3
  2. #
  3. # Script for comparing buildstats from two different builds
  4. #
  5. # Copyright (c) 2016, Intel Corporation.
  6. #
  7. # SPDX-License-Identifier: GPL-2.0-only
  8. #
  9. import argparse
  10. import glob
  11. import logging
  12. import math
  13. import os
  14. import sys
  15. from operator import attrgetter
  16. # Import oe libs
  17. scripts_path = os.path.dirname(os.path.realpath(__file__))
  18. sys.path.append(os.path.join(scripts_path, 'lib'))
  19. from buildstats import BuildStats, diff_buildstats, taskdiff_fields, BSVerDiff
  20. # Setup logging
  21. logging.basicConfig(level=logging.INFO, format="%(levelname)s: %(message)s")
  22. log = logging.getLogger()
  23. class ScriptError(Exception):
  24. """Exception for internal error handling of this script"""
  25. pass
  26. def read_buildstats(path, multi):
  27. """Read buildstats"""
  28. if not os.path.exists(path):
  29. raise ScriptError("No such file or directory: {}".format(path))
  30. if os.path.isfile(path):
  31. return BuildStats.from_file_json(path)
  32. if os.path.isfile(os.path.join(path, 'build_stats')):
  33. return BuildStats.from_dir(path)
  34. # Handle a non-buildstat directory
  35. subpaths = sorted(glob.glob(path + '/*'))
  36. if len(subpaths) > 1:
  37. if multi:
  38. log.info("Averaging over {} buildstats from {}".format(
  39. len(subpaths), path))
  40. else:
  41. raise ScriptError("Multiple buildstats found in '{}'. Please give "
  42. "a single buildstat directory of use the --multi "
  43. "option".format(path))
  44. bs = None
  45. for subpath in subpaths:
  46. if os.path.isfile(subpath):
  47. _bs = BuildStats.from_file_json(subpath)
  48. else:
  49. _bs = BuildStats.from_dir(subpath)
  50. if bs is None:
  51. bs = _bs
  52. else:
  53. bs.aggregate(_bs)
  54. if not bs:
  55. raise ScriptError("No buildstats found under {}".format(path))
  56. return bs
  57. def print_ver_diff(bs1, bs2):
  58. """Print package version differences"""
  59. diff = BSVerDiff(bs1, bs2)
  60. maxlen = max([len(r) for r in set(bs1.keys()).union(set(bs2.keys()))])
  61. fmt_str = " {:{maxlen}} ({})"
  62. if diff.new:
  63. print("\nNEW RECIPES:")
  64. print("------------")
  65. for name, val in sorted(diff.new.items()):
  66. print(fmt_str.format(name, val.nevr, maxlen=maxlen))
  67. if diff.dropped:
  68. print("\nDROPPED RECIPES:")
  69. print("----------------")
  70. for name, val in sorted(diff.dropped.items()):
  71. print(fmt_str.format(name, val.nevr, maxlen=maxlen))
  72. fmt_str = " {0:{maxlen}} {1:<20} ({2})"
  73. if diff.rchanged:
  74. print("\nREVISION CHANGED:")
  75. print("-----------------")
  76. for name, val in sorted(diff.rchanged.items()):
  77. field1 = "{} -> {}".format(val.left.revision, val.right.revision)
  78. field2 = "{} -> {}".format(val.left.nevr, val.right.nevr)
  79. print(fmt_str.format(name, field1, field2, maxlen=maxlen))
  80. if diff.vchanged:
  81. print("\nVERSION CHANGED:")
  82. print("----------------")
  83. for name, val in sorted(diff.vchanged.items()):
  84. field1 = "{} -> {}".format(val.left.version, val.right.version)
  85. field2 = "{} -> {}".format(val.left.nevr, val.right.nevr)
  86. print(fmt_str.format(name, field1, field2, maxlen=maxlen))
  87. if diff.echanged:
  88. print("\nEPOCH CHANGED:")
  89. print("--------------")
  90. for name, val in sorted(diff.echanged.items()):
  91. field1 = "{} -> {}".format(val.left.epoch, val.right.epoch)
  92. field2 = "{} -> {}".format(val.left.nevr, val.right.nevr)
  93. print(fmt_str.format(name, field1, field2, maxlen=maxlen))
  94. def print_task_diff(bs1, bs2, val_type, min_val=0, min_absdiff=0, sort_by=('absdiff',), only_tasks=[]):
  95. """Diff task execution times"""
  96. def val_to_str(val, human_readable=False):
  97. """Convert raw value to printable string"""
  98. def hms_time(secs):
  99. """Get time in human-readable HH:MM:SS format"""
  100. h = int(secs / 3600)
  101. m = int((secs % 3600) / 60)
  102. s = secs % 60
  103. if h == 0:
  104. return "{:02d}:{:04.1f}".format(m, s)
  105. else:
  106. return "{:d}:{:02d}:{:04.1f}".format(h, m, s)
  107. if 'time' in val_type:
  108. if human_readable:
  109. return hms_time(val)
  110. else:
  111. return "{:.1f}s".format(val)
  112. elif 'bytes' in val_type and human_readable:
  113. prefix = ['', 'Ki', 'Mi', 'Gi', 'Ti', 'Pi']
  114. dec = int(math.log(val, 2) / 10)
  115. prec = 1 if dec > 0 else 0
  116. return "{:.{prec}f}{}B".format(val / (2 ** (10 * dec)),
  117. prefix[dec], prec=prec)
  118. elif 'ops' in val_type and human_readable:
  119. prefix = ['', 'k', 'M', 'G', 'T', 'P']
  120. dec = int(math.log(val, 1000))
  121. prec = 1 if dec > 0 else 0
  122. return "{:.{prec}f}{}ops".format(val / (1000 ** dec),
  123. prefix[dec], prec=prec)
  124. return str(int(val))
  125. def sum_vals(buildstats):
  126. """Get cumulative sum of all tasks"""
  127. total = 0.0
  128. for recipe_data in buildstats.values():
  129. for name, bs_task in recipe_data.tasks.items():
  130. if not only_tasks or name in only_tasks:
  131. total += getattr(bs_task, val_type)
  132. return total
  133. if min_val:
  134. print("Ignoring tasks less than {} ({})".format(
  135. val_to_str(min_val, True), val_to_str(min_val)))
  136. if min_absdiff:
  137. print("Ignoring differences less than {} ({})".format(
  138. val_to_str(min_absdiff, True), val_to_str(min_absdiff)))
  139. # Prepare the data
  140. tasks_diff = diff_buildstats(bs1, bs2, val_type, min_val, min_absdiff, only_tasks)
  141. # Sort our list
  142. for field in reversed(sort_by):
  143. if field.startswith('-'):
  144. field = field[1:]
  145. reverse = True
  146. else:
  147. reverse = False
  148. tasks_diff = sorted(tasks_diff, key=attrgetter(field), reverse=reverse)
  149. linedata = [(' ', 'PKG', ' ', 'TASK', 'ABSDIFF', 'RELDIFF',
  150. val_type.upper() + '1', val_type.upper() + '2')]
  151. field_lens = dict([('len_{}'.format(i), len(f)) for i, f in enumerate(linedata[0])])
  152. # Prepare fields in string format and measure field lengths
  153. for diff in tasks_diff:
  154. task_prefix = diff.task_op if diff.pkg_op == ' ' else ' '
  155. linedata.append((diff.pkg_op, diff.pkg, task_prefix, diff.task,
  156. val_to_str(diff.absdiff),
  157. '{:+.1f}%'.format(diff.reldiff),
  158. val_to_str(diff.value1),
  159. val_to_str(diff.value2)))
  160. for i, field in enumerate(linedata[-1]):
  161. key = 'len_{}'.format(i)
  162. if len(field) > field_lens[key]:
  163. field_lens[key] = len(field)
  164. # Print data
  165. print()
  166. for fields in linedata:
  167. print("{:{len_0}}{:{len_1}} {:{len_2}}{:{len_3}} {:>{len_4}} {:>{len_5}} {:>{len_6}} -> {:{len_7}}".format(
  168. *fields, **field_lens))
  169. # Print summary of the diffs
  170. total1 = sum_vals(bs1)
  171. total2 = sum_vals(bs2)
  172. print("\nCumulative {}:".format(val_type))
  173. print (" {} {:+.1f}% {} ({}) -> {} ({})".format(
  174. val_to_str(total2 - total1), 100 * (total2-total1) / total1,
  175. val_to_str(total1, True), val_to_str(total1),
  176. val_to_str(total2, True), val_to_str(total2)))
  177. def parse_args(argv):
  178. """Parse cmdline arguments"""
  179. description="""
  180. Script for comparing buildstats of two separate builds."""
  181. parser = argparse.ArgumentParser(
  182. formatter_class=argparse.ArgumentDefaultsHelpFormatter,
  183. description=description)
  184. min_val_defaults = {'cputime': 3.0,
  185. 'read_bytes': 524288,
  186. 'write_bytes': 524288,
  187. 'read_ops': 500,
  188. 'write_ops': 500,
  189. 'walltime': 5}
  190. min_absdiff_defaults = {'cputime': 1.0,
  191. 'read_bytes': 131072,
  192. 'write_bytes': 131072,
  193. 'read_ops': 50,
  194. 'write_ops': 50,
  195. 'walltime': 2}
  196. parser.add_argument('--debug', '-d', action='store_true',
  197. help="Verbose logging")
  198. parser.add_argument('--ver-diff', action='store_true',
  199. help="Show package version differences and exit")
  200. parser.add_argument('--diff-attr', default='cputime',
  201. choices=min_val_defaults.keys(),
  202. help="Buildstat attribute which to compare")
  203. parser.add_argument('--min-val', default=min_val_defaults, type=float,
  204. help="Filter out tasks less than MIN_VAL. "
  205. "Default depends on --diff-attr.")
  206. parser.add_argument('--min-absdiff', default=min_absdiff_defaults, type=float,
  207. help="Filter out tasks whose difference is less than "
  208. "MIN_ABSDIFF, Default depends on --diff-attr.")
  209. parser.add_argument('--sort-by', default='absdiff',
  210. help="Comma-separated list of field sort order. "
  211. "Prepend the field name with '-' for reversed sort. "
  212. "Available fields are: {}".format(', '.join(taskdiff_fields)))
  213. parser.add_argument('--multi', action='store_true',
  214. help="Read all buildstats from the given paths and "
  215. "average over them")
  216. parser.add_argument('--only-task', dest='only_tasks', metavar='TASK', action='append', default=[],
  217. help="Only include TASK in report. May be specified multiple times")
  218. parser.add_argument('buildstats1', metavar='BUILDSTATS1', help="'Left' buildstat")
  219. parser.add_argument('buildstats2', metavar='BUILDSTATS2', help="'Right' buildstat")
  220. args = parser.parse_args(argv)
  221. # We do not nedd/want to read all buildstats if we just want to look at the
  222. # package versions
  223. if args.ver_diff:
  224. args.multi = False
  225. # Handle defaults for the filter arguments
  226. if args.min_val is min_val_defaults:
  227. args.min_val = min_val_defaults[args.diff_attr]
  228. if args.min_absdiff is min_absdiff_defaults:
  229. args.min_absdiff = min_absdiff_defaults[args.diff_attr]
  230. return args
  231. def main(argv=None):
  232. """Script entry point"""
  233. args = parse_args(argv)
  234. if args.debug:
  235. log.setLevel(logging.DEBUG)
  236. # Validate sort fields
  237. sort_by = []
  238. for field in args.sort_by.split(','):
  239. if field.lstrip('-') not in taskdiff_fields:
  240. log.error("Invalid sort field '%s' (must be one of: %s)" %
  241. (field, ', '.join(taskdiff_fields)))
  242. sys.exit(1)
  243. sort_by.append(field)
  244. try:
  245. bs1 = read_buildstats(args.buildstats1, args.multi)
  246. bs2 = read_buildstats(args.buildstats2, args.multi)
  247. if args.ver_diff:
  248. print_ver_diff(bs1, bs2)
  249. else:
  250. print_task_diff(bs1, bs2, args.diff_attr, args.min_val,
  251. args.min_absdiff, sort_by, args.only_tasks)
  252. except ScriptError as err:
  253. log.error(str(err))
  254. return 1
  255. return 0
  256. if __name__ == "__main__":
  257. sys.exit(main())