X-Git-Url: https://git.libre-soc.org/?a=blobdiff_plain;f=util%2Ftracediff;h=5c77d9caff036d88e0cc5b19293aa653c7a16d3b;hb=ce4f6a90207d98b1b05eca01e621119c1583ced7;hp=3633fdb48a8845b0a7f0b6296a8129e33a7b4683;hpb=6b37bb67101803f12b6ed2bef714af583d03f814;p=gem5.git

diff --git a/util/tracediff b/util/tracediff
index 3633fdb48..5c77d9caf 100755
--- a/util/tracediff
+++ b/util/tracediff
@@ -28,7 +28,9 @@
 # Authors: Steve Reinhardt
 
 # Script to simplify using rundiff on trace outputs from two
-# invocations of m5.
+# invocations of m5.  Takes a common m5 command line with embedded
+# alternatives and executes the two alternative commands in separate
+# subdirectories with output piped to rundiff.
 #
 # ******Note that you need to enable some trace flags in the args in order
 # to do anything useful!******
@@ -40,6 +42,10 @@
 #   of the '|' is appended to the respective command lines.  Note that
 #   you'll have to quote the arg or escape the '|' with a backslash
 #   so that the shell doesn't think you're doing a pipe.
+# - Arguments with '#' characters are split at those characters,
+#   processed for alternatives ('|'s) as independent terms, then
+#   pasted back into a single argument (without the '#'s).  (Sort of
+#   inspired by the C preprocessor '##' token pasting operator.)
 #
 # In other words, the arguments should look like the command line you
 # want to run, with "|" used to list the alternatives for the parts
@@ -47,34 +53,67 @@
 #
 # For example:
 #
-# % tracediff m5.opt --opt1 "--opt2|--opt3" --opt4
+# % tracediff m5.opt --opt1 '--opt2|--opt3' --opt4
 # would compare these two runs:
 # m5.opt --opt1 --opt2 --opt4
 # m5.opt --opt1 --opt3 --opt4
 #
-# If you want to compare two different simulator binaries, put a '|'
-# in the first script argument ("path1/m5.opt|path2/m5.opt").  If you
-# want to add arguments to one run only, just put a '|' in with text
-# only on one side ("--onlyOn1|").  You can do this with multiple
-# arguments together too ("|-a -b -c" adds three args to the second
+# % tracediff 'path1|path2#/m5.opt' --opt1 --opt2
+# would compare these two runs:
+# path1/m5.opt --opt1 --opt2
+# path2/m5.opt --opt1 --opt2
+#
+# If you want to add arguments to one run only, just put a '|' in with
+# text only on one side ('--onlyOn1|').  You can do this with multiple
+# arguments together too ('|-a -b -c' adds three args to the second
 # run only).
 #
+# The '-n' argument to tracediff allows you to preview the two
+# generated command lines without running them.
+#
 
 use FindBin;
 
-if (@ARGV < 2) {
-    die "Usage: tracediff \"sim1|sim2\" [common-arg \"arg1|arg2\" ...]\n";
+$dryrun = 0;
+
+if (@ARGV >= 1 && $ARGV[0] eq '-n') {
+    $dryrun = 1;
+    shift @ARGV;
+}
+
+if (@ARGV < 1) {
+    die "Usage: tracediff [-n] \"sim1|sim2\" [common-arg \"arg1|arg2\" ...]\n";
 }
 
 foreach $arg (@ARGV) {
-    @pair = split('\|', $arg, -1); # -1 enables null trailing fields
-    if ($#pair > 0) {
-	push @cmd1, $pair[0];
-	push @cmd2, $pair[1];
-    } else {
-	push @cmd1, $arg;
-	push @cmd2, $arg;
+    $a1 = $a2 = '';
+    @subargs = split('#', $arg);
+    foreach $subarg (@subargs) {
+        if ($subarg eq '') {
+            next;
+        }
+        @pair = split('\|', $subarg, -1); # -1 enables null trailing fields
+        if (@pair == 1) {
+            $a1 .= $subarg;
+            $a2 .= $subarg;
+        } elsif (@pair == 2) {
+            $a1 .= $pair[0];
+            $a2 .= $pair[1];
+        } else {
+            print 'Parse error: too many |s in ', $arg, "\n";
+            exit(1);
+        }
     }
+
+    push @cmd1, $a1;
+    push @cmd2, $a2;
+}
+
+
+if ($dryrun) {
+    print "CMD1: ", join(' ', @cmd1), "\n";
+    print "CMD2: ", join(' ', @cmd2), "\n";
+    exit(0);
 }
 
 # First two args are the two simulator binaries to compare
@@ -85,11 +124,11 @@ $sim2 = shift @cmd2;
 $args1 = join(' ', @cmd1);
 $args2 = join(' ', @cmd2);
 
-# Common mistake: if you don't set any traceflags this often isn't
+# Common mistake: if you don't set any debugflags this often isn't
 # doing what you want.
-if ($args1 !~ /--trace-flags/) {
+if ($args1 !~ /--debug-flags/) {
     print "****\n";
-    print "**** WARNING: no trace flags set... you may not be diffing much!\n";
+    print "**** WARNING: no debug flags set... you may not be diffing much!\n";
     print "****\n";
 }