buildstats-diff 11 KB

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