1#!/usr/bin/env python3 2 3# bitbake-diffsigs / bitbake-dumpsig 4# BitBake task signature data dump and comparison utility 5# 6# Copyright (C) 2012-2013, 2017 Intel Corporation 7# 8# SPDX-License-Identifier: GPL-2.0-only 9# 10 11import os 12import sys 13import warnings 14 15warnings.simplefilter("default") 16import argparse 17import logging 18import pickle 19 20sys.path.insert(0, os.path.join(os.path.dirname(os.path.dirname(sys.argv[0])), 'lib')) 21 22import bb.tinfoil 23import bb.siggen 24import bb.msg 25 26myname = os.path.basename(sys.argv[0]) 27logger = bb.msg.logger_create(myname) 28 29is_dump = myname == 'bitbake-dumpsig' 30 31 32def 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 57 58def find_siginfo_task(bbhandler, pn, taskname, sig1=None, sig2=None): 59 """ Find the most recent signature files for the specified PN/task """ 60 61 if not taskname.startswith('do_'): 62 taskname = 'do_%s' % taskname 63 64 if sig1 and sig2: 65 sigfiles = find_siginfo(bbhandler, pn, taskname, [sig1, sig2]) 66 if not sigfiles: 67 logger.error('No sigdata files found matching %s %s matching either %s or %s' % (pn, taskname, sig1, sig2)) 68 sys.exit(1) 69 elif sig1 not in sigfiles: 70 logger.error('No sigdata files found matching %s %s with signature %s' % (pn, taskname, sig1)) 71 sys.exit(1) 72 elif sig2 not in sigfiles: 73 logger.error('No sigdata files found matching %s %s with signature %s' % (pn, taskname, sig2)) 74 sys.exit(1) 75 else: 76 sigfiles = find_siginfo(bbhandler, pn, taskname) 77 latestsigs = sorted(sigfiles.keys(), key=lambda h: sigfiles[h]['time'])[-2:] 78 if not latestsigs: 79 logger.error('No sigdata files found matching %s %s' % (pn, taskname)) 80 sys.exit(1) 81 sig1 = latestsigs[0] 82 sig2 = latestsigs[1] 83 84 latestfiles = [sigfiles[sig1]['path'], sigfiles[sig2]['path']] 85 86 return latestfiles 87 88 89# Define recursion callback 90def recursecb(key, hash1, hash2): 91 hashes = [hash1, hash2] 92 hashfiles = find_siginfo(tinfoil, key, None, hashes) 93 94 recout = [] 95 if not hashfiles: 96 recout.append("Unable to find matching sigdata for %s with hashes %s or %s" % (key, hash1, hash2)) 97 elif hash1 not in hashfiles: 98 recout.append("Unable to find matching sigdata for %s with hash %s" % (key, hash1)) 99 elif hash2 not in hashfiles: 100 recout.append("Unable to find matching sigdata for %s with hash %s" % (key, hash2)) 101 else: 102 out2 = bb.siggen.compare_sigfiles(hashfiles[hash1]['path'], hashfiles[hash2]['path'], recursecb, color=color) 103 for change in out2: 104 for line in change.splitlines(): 105 recout.append(' ' + line) 106 107 return recout 108 109 110parser = argparse.ArgumentParser( 111 description=("Dumps" if is_dump else "Compares") + " siginfo/sigdata files written out by BitBake") 112 113parser.add_argument('-D', '--debug', 114 help='Enable debug output', 115 action='store_true') 116 117if is_dump: 118 parser.add_argument("-t", "--task", 119 help="find the signature data file for the last run of the specified task", 120 action="store", dest="taskargs", nargs=2, metavar=('recipename', 'taskname')) 121 122 parser.add_argument("sigdatafile1", 123 help="Signature file to dump. Not used when using -t/--task.", 124 action="store", nargs='?', metavar="sigdatafile") 125else: 126 parser.add_argument('-c', '--color', 127 help='Colorize the output (where %(metavar)s is %(choices)s)', 128 choices=['auto', 'always', 'never'], default='auto', metavar='color') 129 130 parser.add_argument('-d', '--dump', 131 help='Dump the last signature data instead of comparing (equivalent to using bitbake-dumpsig)', 132 action='store_true') 133 134 parser.add_argument("-t", "--task", 135 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')) 137 138 parser.add_argument("-s", "--signature", 139 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')) 141 142 parser.add_argument("sigdatafile1", 143 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='?') 145 146 parser.add_argument("sigdatafile2", 147 help="Second signature file to compare", 148 action="store", nargs='?') 149 150options = parser.parse_args() 151if is_dump: 152 options.color = 'never' 153 options.dump = True 154 options.sigdatafile2 = None 155 options.sigargs = None 156 157if options.debug: 158 logger.setLevel(logging.DEBUG) 159 160color = (options.color == 'always' or (options.color == 'auto' and sys.stdout.isatty())) 161 162if options.taskargs: 163 with bb.tinfoil.Tinfoil() as tinfoil: 164 tinfoil.prepare(config_only=True) 165 if not options.dump and options.sigargs: 166 files = find_siginfo_task(tinfoil, options.taskargs[0], options.taskargs[1], options.sigargs[0], 167 options.sigargs[1]) 168 else: 169 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: 176 logger.error('Only one matching sigdata file found for the specified task (%s %s)' % ( 177 options.taskargs[0], options.taskargs[1])) 178 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) 184else: 185 if options.sigargs: 186 logger.error('-s/--signature can only be used together with -t/--task') 187 sys.exit(1) 188 try: 189 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) 193 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() 198 sys.exit(1) 199 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) 205 206if output: 207 print('\n'.join(output)) 208