util/tracediff

   1 #! /usr/bin/env perl
   2 # Copyright (c) 2003-2007 The Regents of The University of Michigan
   3 # All rights reserved.
   4 #
   5 # Redistribution and use in source and binary forms, with or without
   6 # modification, are permitted provided that the following conditions are
   7 # met: redistributions of source code must retain the above copyright
   8 # notice, this list of conditions and the following disclaimer;
   9 # redistributions in binary form must reproduce the above copyright
  10 # notice, this list of conditions and the following disclaimer in the
  11 # documentation and/or other materials provided with the distribution;
  12 # neither the name of the copyright holders nor the names of its
  13 # contributors may be used to endorse or promote products derived from
  14 # this software without specific prior written permission.
  15 #
  16 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  17 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  18 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  19 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  20 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  21 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  22 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  26 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27 #
  28 # Authors: Steve Reinhardt
  29
  30 # Script to simplify using rundiff on trace outputs from two
  31 # invocations of m5.
  32 #
  33 # ******Note that you need to enable some trace flags in the args in order
  34 # to do anything useful!******
  35 #
  36 # Script arguments are handled uniformly as follows:
  37 # - If the argument does not contain a '|' character, it is appended
  38 #   to both command lines.
  39 # - If the argument has a '|' character in it, the text on either side
  40 #   of the '|' is appended to the respective command lines.  Note that
  41 #   you'll have to quote the arg or escape the '|' with a backslash
  42 #   so that the shell doesn't think you're doing a pipe.
  43 #
  44 # In other words, the arguments should look like the command line you
  45 # want to run, with "|" used to list the alternatives for the parts
  46 # that you want to differ between the two runs.
  47 #
  48 # For example:
  49 #
  50 # % tracediff m5.opt --opt1 "--opt2|--opt3" --opt4
  51 # would compare these two runs:
  52 # m5.opt --opt1 --opt2 --opt4
  53 # m5.opt --opt1 --opt3 --opt4
  54 #
  55 # If you want to compare two different simulator binaries, put a '|'
  56 # in the first script argument ("path1/m5.opt|path2/m5.opt").  If you
  57 # want to add arguments to one run only, just put a '|' in with text
  58 # only on one side ("--onlyOn1|").  You can do this with multiple
  59 # arguments together too ("|-a -b -c" adds three args to the second
  60 # run only).
  61 #
  62
  63 use FindBin;
  64
  65 if (@ARGV < 2) {
  66     die "Usage: tracediff \"sim1|sim2\" [common-arg \"arg1|arg2\" ...]\n";
  67 }
  68
  69 foreach $arg (@ARGV) {
  70     @pair = split('\|', $arg, -1); # -1 enables null trailing fields
  71     if ($#pair > 0) {
  72         push @cmd1, $pair[0];
  73         push @cmd2, $pair[1];
  74     } else {
  75         push @cmd1, $arg;
  76         push @cmd2, $arg;
  77     }
  78 }
  79
  80 # First two args are the two simulator binaries to compare
  81 $sim1 = shift @cmd1;
  82 $sim2 = shift @cmd2;
  83
  84 # Everything else is a simulator arg.
  85 $args1 = join(' ', @cmd1);
  86 $args2 = join(' ', @cmd2);
  87
  88 # Common mistake: if you don't set any traceflags this often isn't
  89 # doing what you want.
  90 if ($args1 !~ /--trace-flags/) {
  91     print "****\n";
  92     print "**** WARNING: no trace flags set... you may not be diffing much!\n";
  93     print "****\n";
  94 }
  95
  96 # Run individual invocations in separate dirs so output and intermediate
  97 # files (particularly config.py and config.ini) don't conflict.
  98 $dir1 = "tracediff-$$-1";
  99 $dir2 = "tracediff-$$-2";
 100 mkdir($dir1) or die "Can't create dir $dir1\n";
 101 mkdir($dir2) or die "Can't create dir $dir2\n";
 102
 103 $cmd1 = "$sim1 -d $dir1 $args1 2>&1 |";
 104 $cmd2 = "$sim2 -d $dir2 $args2 2>&1 |";
 105
 106 # Expect that rundiff is in the same dir as the tracediff script.
 107 # FindBin figures that out for us.
 108 $fullcmd = "$FindBin::Bin/rundiff '$cmd1' '$cmd2' 2>&1 > tracediff-$$.out";
 109
 110 print "Executing $fullcmd\n";
 111 system($fullcmd);
 112
 113
 114