Major documentation update for 570 F04.
[gem5.git] / util / tracediff
1 #! /usr/bin/env perl
2 # Copyright (c) 2003-2004 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 # If you want to pass different arguments to the two instances of m5,
37 # you can embed them in the simulator arguments like this:
38 #
39 # % tracediff "m5.opt --foo:bar=1" "m5.opt --foo:bar=2" [common args]
40 #
41
42 if (@ARGV < 2) {
43 die "Usage: tracediff sim1 sim2 [--trace:flags=X args...]\n";
44 }
45
46 # First two args are the two simulator binaries to compare
47 $sim1 = shift;
48 $sim2 = shift;
49
50 # Everything else on the command line is taken to be an m5 argument to
51 # be given to both invocations
52 $simargs = '"' . join('" "', @ARGV) . '"';
53
54 # Redirect config output to cout so that gets diffed too (in case
55 # that's the source of the problem).
56 $simargs += " --Universe:config_output_file=cout";
57
58 $cmd1 = "$sim1 $simargs --stats:text_file=tracediff-$$-1.stats 2>&1 |";
59 $cmd2 = "$sim2 $simargs --stats:text_file=tracediff-$$-2.stats 2>&1 |";
60
61 # This only works if you have rundiff in your path. I just edit it
62 # with an explicit path if necessary.
63 $fullcmd = "rundiff '$cmd1' '$cmd2' 2>&1 > tracediff-$$.out";
64
65 print "Executing $fullcmd\n";
66 system($fullcmd);
67
68
69