tracediff revision 4018
16157Snate@binkert.org#! /usr/bin/env perl 26157Snate@binkert.org# Copyright (c) 2003-2007 The Regents of The University of Michigan 36157Snate@binkert.org# All rights reserved. 46157Snate@binkert.org# 56157Snate@binkert.org# Redistribution and use in source and binary forms, with or without 66157Snate@binkert.org# modification, are permitted provided that the following conditions are 76157Snate@binkert.org# met: redistributions of source code must retain the above copyright 86157Snate@binkert.org# notice, this list of conditions and the following disclaimer; 96157Snate@binkert.org# redistributions in binary form must reproduce the above copyright 106157Snate@binkert.org# notice, this list of conditions and the following disclaimer in the 116157Snate@binkert.org# documentation and/or other materials provided with the distribution; 126157Snate@binkert.org# neither the name of the copyright holders nor the names of its 136157Snate@binkert.org# contributors may be used to endorse or promote products derived from 146157Snate@binkert.org# this software without specific prior written permission. 156157Snate@binkert.org# 166157Snate@binkert.org# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 176157Snate@binkert.org# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 186157Snate@binkert.org# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 196157Snate@binkert.org# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 206157Snate@binkert.org# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 216157Snate@binkert.org# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 226157Snate@binkert.org# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 236157Snate@binkert.org# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 246157Snate@binkert.org# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 256157Snate@binkert.org# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 266157Snate@binkert.org# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 276157Snate@binkert.org# 286157Snate@binkert.org# Authors: Steve Reinhardt 296157Snate@binkert.org 306157Snate@binkert.org# Script to simplify using rundiff on trace outputs from two 316157Snate@binkert.org# invocations of m5. 326157Snate@binkert.org# 336157Snate@binkert.org# ******Note that you need to enable some trace flags in the args in order 346157Snate@binkert.org# to do anything useful!****** 356157Snate@binkert.org# 366157Snate@binkert.org# Script arguments are handled uniformly as follows: 376157Snate@binkert.org# - If the argument does not contain a '|' character, it is appended 386157Snate@binkert.org# to both command lines. 396157Snate@binkert.org# - If the argument has a '|' character in it, the text on either side 406168Snate@binkert.org# of the '|' is appended to the respective command lines. Note that 416168Snate@binkert.org# you'll have to quote the arg or escape the '|' with a backslash 426168Snate@binkert.org# so that the shell doesn't think you're doing a pipe. 436286Snate@binkert.org# 446157Snate@binkert.org# In other words, the arguments should look like the command line you 456157Snate@binkert.org# want to run, with "|" used to list the alternatives for the parts 466157Snate@binkert.org# that you want to differ between the two runs. 476157Snate@binkert.org# 486157Snate@binkert.org# For example: 496157Snate@binkert.org# 506157Snate@binkert.org# % tracediff m5.opt --opt1 "--opt2|--opt3" --opt4 516157Snate@binkert.org# would compare these two runs: 526157Snate@binkert.org# m5.opt --opt1 --opt2 --opt4 536157Snate@binkert.org# m5.opt --opt1 --opt3 --opt4 546157Snate@binkert.org# 556157Snate@binkert.org# If you want to compare two different simulator binaries, put a '|' 566157Snate@binkert.org# in the first script argument ("path1/m5.opt|path2/m5.opt"). If you 576157Snate@binkert.org# want to add arguments to one run only, just put a '|' in with text 586157Snate@binkert.org# only on one side ("--onlyOn1|"). You can do this with multiple 596157Snate@binkert.org# arguments together too ("|-a -b -c" adds three args to the second 606157Snate@binkert.org# run only). 616157Snate@binkert.org# 626157Snate@binkert.org 636157Snate@binkert.orguse FindBin; 646157Snate@binkert.org 656157Snate@binkert.orgif (@ARGV < 2) { 666157Snate@binkert.org die "Usage: tracediff \"sim1|sim2\" [common-arg \"arg1|arg2\" ...]\n"; 676157Snate@binkert.org} 686157Snate@binkert.org 696157Snate@binkert.orgforeach $arg (@ARGV) { 706157Snate@binkert.org @pair = split('\|', $arg, -1); # -1 enables null trailing fields 716157Snate@binkert.org if ($#pair > 0) { 726157Snate@binkert.org push @cmd1, $pair[0]; 736157Snate@binkert.org push @cmd2, $pair[1]; 746157Snate@binkert.org } else { 756157Snate@binkert.org push @cmd1, $arg; 766157Snate@binkert.org push @cmd2, $arg; 776157Snate@binkert.org } 786157Snate@binkert.org} 796157Snate@binkert.org 806157Snate@binkert.org# First two args are the two simulator binaries to compare 816157Snate@binkert.org$sim1 = shift @cmd1; 826157Snate@binkert.org$sim2 = shift @cmd2; 836157Snate@binkert.org 846157Snate@binkert.org# Everything else is a simulator arg. 856157Snate@binkert.org$args1 = join(' ', @cmd1); 866157Snate@binkert.org$args2 = join(' ', @cmd2); 876157Snate@binkert.org 886157Snate@binkert.org# Common mistake: if you don't set any traceflags this often isn't 896157Snate@binkert.org# doing what you want. 906157Snate@binkert.orgif ($args1 !~ /--trace-flags/) { 916157Snate@binkert.org print "****\n"; 926157Snate@binkert.org print "**** WARNING: no trace flags set... you may not be diffing much!\n"; 936157Snate@binkert.org print "****\n"; 946157Snate@binkert.org} 956157Snate@binkert.org 966157Snate@binkert.org# Run individual invocations in separate dirs so output and intermediate 976157Snate@binkert.org# files (particularly config.py and config.ini) don't conflict. 986286Snate@binkert.org$dir1 = "tracediff-$$-1"; 996286Snate@binkert.org$dir2 = "tracediff-$$-2"; 1006286Snate@binkert.orgmkdir($dir1) or die "Can't create dir $dir1\n"; 1016286Snate@binkert.orgmkdir($dir2) or die "Can't create dir $dir2\n"; 1026286Snate@binkert.org 1036286Snate@binkert.org$cmd1 = "$sim1 -d $dir1 $args1 2>&1 |"; 1046157Snate@binkert.org$cmd2 = "$sim2 -d $dir2 $args2 2>&1 |"; 1056157Snate@binkert.org 1066157Snate@binkert.org# Expect that rundiff is in the same dir as the tracediff script. 1076157Snate@binkert.org# FindBin figures that out for us. 1086157Snate@binkert.org$fullcmd = "$FindBin::Bin/rundiff '$cmd1' '$cmd2' 2>&1 > tracediff-$$.out"; 1096286Snate@binkert.org 1106157Snate@binkert.orgprint "Executing $fullcmd\n"; 1116286Snate@binkert.orgsystem($fullcmd); 1126157Snate@binkert.org 1136157Snate@binkert.org 1146157Snate@binkert.org 1156157Snate@binkert.org