blob: a8f49191b0c741e94b19e3c93a3212fb0ec4607c [file] [log] [blame]
Patrick Williamsc0f7c042017-02-23 20:41:17 -06001#!/usr/bin/env python3
Patrick Williamsc124f4f2015-09-15 14:41:29 -05002
Brad Bishopa5c52ff2018-11-23 10:55:50 +13003# bitbake-diffsigs / bitbake-dumpsig
4# BitBake task signature data dump and comparison utility
Patrick Williamsc124f4f2015-09-15 14:41:29 -05005#
Brad Bishop6e60e8b2018-02-01 10:27:11 -05006# Copyright (C) 2012-2013, 2017 Intel Corporation
Patrick Williamsc124f4f2015-09-15 14:41:29 -05007#
Brad Bishopc342db32019-05-15 21:57:59 -04008# SPDX-License-Identifier: GPL-2.0-only
Patrick Williamsc124f4f2015-09-15 14:41:29 -05009#
Patrick Williamsc124f4f2015-09-15 14:41:29 -050010
11import os
12import sys
13import warnings
Patrick Williams03907ee2022-05-01 06:28:52 -050014
Andrew Geissler5199d832021-09-24 16:47:35 -050015warnings.simplefilter("default")
Brad Bishop6e60e8b2018-02-01 10:27:11 -050016import argparse
Patrick Williamsc124f4f2015-09-15 14:41:29 -050017import logging
Patrick Williamsc0f7c042017-02-23 20:41:17 -060018import pickle
Patrick Williamsc124f4f2015-09-15 14:41:29 -050019
20sys.path.insert(0, os.path.join(os.path.dirname(os.path.dirname(sys.argv[0])), 'lib'))
21
22import bb.tinfoil
23import bb.siggen
Brad Bishop6e60e8b2018-02-01 10:27:11 -050024import bb.msg
Patrick Williamsc124f4f2015-09-15 14:41:29 -050025
Brad Bishopa5c52ff2018-11-23 10:55:50 +130026myname = os.path.basename(sys.argv[0])
27logger = bb.msg.logger_create(myname)
28
29is_dump = myname == 'bitbake-dumpsig'
Patrick Williamsc124f4f2015-09-15 14:41:29 -050030
Patrick Williams03907ee2022-05-01 06:28:52 -050031
Brad Bishopd7bf8c12018-02-25 22:55:05 -050032def find_siginfo(tinfoil, pn, taskname, sigs=None):
33 result = None
34 tinfoil.set_event_mask(['bb.event.FindSigInfoResult',
35 'logging.LogRecord',
36 'bb.command.CommandCompleted',
37 'bb.command.CommandFailed'])
38 ret = tinfoil.run_command('findSigInfo', pn, taskname, sigs)
39 if ret:
40 while True:
41 event = tinfoil.wait_event(1)
42 if event:
43 if isinstance(event, bb.command.CommandCompleted):
44 break
45 elif isinstance(event, bb.command.CommandFailed):
46 logger.error(str(event))
47 sys.exit(2)
48 elif isinstance(event, bb.event.FindSigInfoResult):
49 result = event.result
50 elif isinstance(event, logging.LogRecord):
51 logger.handle(event)
52 else:
53 logger.error('No result returned from findSigInfo command')
54 sys.exit(2)
55 return result
56
Patrick Williams03907ee2022-05-01 06:28:52 -050057
Brad Bishopa5c52ff2018-11-23 10:55:50 +130058def find_siginfo_task(bbhandler, pn, taskname, sig1=None, sig2=None):
59 """ Find the most recent signature files for the specified PN/task """
Patrick Williamsc124f4f2015-09-15 14:41:29 -050060
Patrick Williamsc124f4f2015-09-15 14:41:29 -050061 if not taskname.startswith('do_'):
62 taskname = 'do_%s' % taskname
63
Brad Bishop6e60e8b2018-02-01 10:27:11 -050064 if sig1 and sig2:
Brad Bishopd7bf8c12018-02-25 22:55:05 -050065 sigfiles = find_siginfo(bbhandler, pn, taskname, [sig1, sig2])
Andrew Geissler595f6302022-01-24 19:11:47 +000066 if not sigfiles:
Brad Bishop6e60e8b2018-02-01 10:27:11 -050067 logger.error('No sigdata files found matching %s %s matching either %s or %s' % (pn, taskname, sig1, sig2))
68 sys.exit(1)
Patrick Williams03907ee2022-05-01 06:28:52 -050069 elif sig1 not in sigfiles:
Brad Bishop6e60e8b2018-02-01 10:27:11 -050070 logger.error('No sigdata files found matching %s %s with signature %s' % (pn, taskname, sig1))
71 sys.exit(1)
Patrick Williams03907ee2022-05-01 06:28:52 -050072 elif sig2 not in sigfiles:
Brad Bishop6e60e8b2018-02-01 10:27:11 -050073 logger.error('No sigdata files found matching %s %s with signature %s' % (pn, taskname, sig2))
74 sys.exit(1)
Patrick Williamsc124f4f2015-09-15 14:41:29 -050075 else:
Patrick Williams169d7bc2024-01-05 11:33:25 -060076 sigfiles = find_siginfo(bbhandler, pn, taskname)
77 latestsigs = sorted(sigfiles.keys(), key=lambda h: sigfiles[h]['time'])[-2:]
78 if not latestsigs:
Brad Bishop6e60e8b2018-02-01 10:27:11 -050079 logger.error('No sigdata files found matching %s %s' % (pn, taskname))
80 sys.exit(1)
Patrick Williams169d7bc2024-01-05 11:33:25 -060081 sig1 = latestsigs[0]
82 sig2 = latestsigs[1]
83
84 latestfiles = [sigfiles[sig1]['path'], sigfiles[sig2]['path']]
Patrick Williamsc124f4f2015-09-15 14:41:29 -050085
Brad Bishopa5c52ff2018-11-23 10:55:50 +130086 return latestfiles
Patrick Williamsc124f4f2015-09-15 14:41:29 -050087
Patrick Williamsc124f4f2015-09-15 14:41:29 -050088
Brad Bishopa5c52ff2018-11-23 10:55:50 +130089# Define recursion callback
90def recursecb(key, hash1, hash2):
91 hashes = [hash1, hash2]
92 hashfiles = find_siginfo(tinfoil, key, None, hashes)
Patrick Williamsc124f4f2015-09-15 14:41:29 -050093
Brad Bishopa5c52ff2018-11-23 10:55:50 +130094 recout = []
Andrew Geissler595f6302022-01-24 19:11:47 +000095 if not hashfiles:
Brad Bishopa5c52ff2018-11-23 10:55:50 +130096 recout.append("Unable to find matching sigdata for %s with hashes %s or %s" % (key, hash1, hash2))
Patrick Williams03907ee2022-05-01 06:28:52 -050097 elif hash1 not in hashfiles:
Brad Bishopa5c52ff2018-11-23 10:55:50 +130098 recout.append("Unable to find matching sigdata for %s with hash %s" % (key, hash1))
Patrick Williams03907ee2022-05-01 06:28:52 -050099 elif hash2 not in hashfiles:
Brad Bishopa5c52ff2018-11-23 10:55:50 +1300100 recout.append("Unable to find matching sigdata for %s with hash %s" % (key, hash2))
101 else:
102 out2 = bb.siggen.compare_sigfiles(hashfiles[hash1], hashfiles[hash2], recursecb, color=color)
103 for change in out2:
104 for line in change.splitlines():
Brad Bishopc342db32019-05-15 21:57:59 -0400105 recout.append(' ' + line)
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500106
Brad Bishopa5c52ff2018-11-23 10:55:50 +1300107 return recout
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500108
109
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500110parser = argparse.ArgumentParser(
Brad Bishopa5c52ff2018-11-23 10:55:50 +1300111 description=("Dumps" if is_dump else "Compares") + " siginfo/sigdata files written out by BitBake")
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500112
Brad Bishopa5c52ff2018-11-23 10:55:50 +1300113parser.add_argument('-D', '--debug',
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500114 help='Enable debug output',
115 action='store_true')
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500116
Brad Bishopa5c52ff2018-11-23 10:55:50 +1300117if is_dump:
118 parser.add_argument("-t", "--task",
Patrick Williams03907ee2022-05-01 06:28:52 -0500119 help="find the signature data file for the last run of the specified task",
120 action="store", dest="taskargs", nargs=2, metavar=('recipename', 'taskname'))
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500121
Brad Bishopa5c52ff2018-11-23 10:55:50 +1300122 parser.add_argument("sigdatafile1",
Patrick Williams03907ee2022-05-01 06:28:52 -0500123 help="Signature file to dump. Not used when using -t/--task.",
124 action="store", nargs='?', metavar="sigdatafile")
Brad Bishopa5c52ff2018-11-23 10:55:50 +1300125else:
126 parser.add_argument('-c', '--color',
Patrick Williams03907ee2022-05-01 06:28:52 -0500127 help='Colorize the output (where %(metavar)s is %(choices)s)',
128 choices=['auto', 'always', 'never'], default='auto', metavar='color')
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500129
Brad Bishopa5c52ff2018-11-23 10:55:50 +1300130 parser.add_argument('-d', '--dump',
Patrick Williams03907ee2022-05-01 06:28:52 -0500131 help='Dump the last signature data instead of comparing (equivalent to using bitbake-dumpsig)',
132 action='store_true')
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500133
Brad Bishopa5c52ff2018-11-23 10:55:50 +1300134 parser.add_argument("-t", "--task",
Patrick Williams03907ee2022-05-01 06:28:52 -0500135 help="find the signature data files for the last two runs of the specified task and compare them",
136 action="store", dest="taskargs", nargs=2, metavar=('recipename', 'taskname'))
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500137
Brad Bishopa5c52ff2018-11-23 10:55:50 +1300138 parser.add_argument("-s", "--signature",
Patrick Williams03907ee2022-05-01 06:28:52 -0500139 help="With -t/--task, specify the signatures to look for instead of taking the last two",
140 action="store", dest="sigargs", nargs=2, metavar=('fromsig', 'tosig'))
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500141
Brad Bishopa5c52ff2018-11-23 10:55:50 +1300142 parser.add_argument("sigdatafile1",
Patrick Williams03907ee2022-05-01 06:28:52 -0500143 help="First signature file to compare (or signature file to dump, if second not specified). Not used when using -t/--task.",
144 action="store", nargs='?')
Brad Bishopa5c52ff2018-11-23 10:55:50 +1300145
146 parser.add_argument("sigdatafile2",
Patrick Williams03907ee2022-05-01 06:28:52 -0500147 help="Second signature file to compare",
148 action="store", nargs='?')
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500149
150options = parser.parse_args()
Brad Bishopa5c52ff2018-11-23 10:55:50 +1300151if is_dump:
152 options.color = 'never'
153 options.dump = True
154 options.sigdatafile2 = None
155 options.sigargs = None
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500156
157if options.debug:
158 logger.setLevel(logging.DEBUG)
159
160color = (options.color == 'always' or (options.color == 'auto' and sys.stdout.isatty()))
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500161
162if options.taskargs:
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600163 with bb.tinfoil.Tinfoil() as tinfoil:
164 tinfoil.prepare(config_only=True)
Brad Bishopa5c52ff2018-11-23 10:55:50 +1300165 if not options.dump and options.sigargs:
Patrick Williams03907ee2022-05-01 06:28:52 -0500166 files = find_siginfo_task(tinfoil, options.taskargs[0], options.taskargs[1], options.sigargs[0],
167 options.sigargs[1])
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500168 else:
Brad Bishopa5c52ff2018-11-23 10:55:50 +1300169 files = find_siginfo_task(tinfoil, options.taskargs[0], options.taskargs[1])
170
171 if options.dump:
172 logger.debug("Signature file: %s" % files[-1])
173 output = bb.siggen.dump_sigfile(files[-1])
174 else:
175 if len(files) < 2:
Patrick Williams03907ee2022-05-01 06:28:52 -0500176 logger.error('Only one matching sigdata file found for the specified task (%s %s)' % (
177 options.taskargs[0], options.taskargs[1]))
Brad Bishopa5c52ff2018-11-23 10:55:50 +1300178 sys.exit(1)
179
180 # Recurse into signature comparison
181 logger.debug("Signature file (previous): %s" % files[-2])
182 logger.debug("Signature file (latest): %s" % files[-1])
183 output = bb.siggen.compare_sigfiles(files[-2], files[-1], recursecb, color=color)
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500184else:
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500185 if options.sigargs:
186 logger.error('-s/--signature can only be used together with -t/--task')
187 sys.exit(1)
188 try:
Brad Bishopa5c52ff2018-11-23 10:55:50 +1300189 if not options.dump and options.sigdatafile1 and options.sigdatafile2:
190 with bb.tinfoil.Tinfoil() as tinfoil:
191 tinfoil.prepare(config_only=True)
192 output = bb.siggen.compare_sigfiles(options.sigdatafile1, options.sigdatafile2, recursecb, color=color)
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500193 elif options.sigdatafile1:
194 output = bb.siggen.dump_sigfile(options.sigdatafile1)
195 else:
196 logger.error('Must specify signature file(s) or -t/--task')
197 parser.print_help()
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500198 sys.exit(1)
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500199 except IOError as e:
200 logger.error(str(e))
201 sys.exit(1)
202 except (pickle.UnpicklingError, EOFError):
203 logger.error('Invalid signature data - ensure you are specifying sigdata/siginfo files')
204 sys.exit(1)
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500205
Brad Bishopa5c52ff2018-11-23 10:55:50 +1300206if output:
207 print('\n'.join(output))