Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[mc] Make snapshots compatible with SMPI privatization of global variables
[simgrid.git] / tools / simgrid_update_xml.pl
index 5b7b5a1..7ec9879 100755 (executable)
-#! /usr/bin/perl
+#! /usr/bin/env perl
+eval 'exec perl -S $0 ${1+"$@"}'
+    if $running_under_some_shell;
 
 # This script updates the simgrid XML file passed as argument (modification in place)
-# It is built to do the conversion incrementally (even if for now, only 2 versions are defined)
+# It is built to do the conversion incrementally.
 
-# Copyright (C) 2006-2007. The SimGrid team. All rights reserved.
+# Copyright (c) 2006-2014. The SimGrid Team.
+# All rights reserved.
 #
-# This file is part of the SimGrid project. This is free software:
-# You can redistribute and/or modify it under the terms of the
-# GNU LGPL (v2.1) licence.
+# This program is free software; you can redistribute it and/or modify it
+# under the terms of the license (GNU LGPL) which comes with this package.
+
+=encoding UTF-8
+
+=head1 NAME
+
+simgrid_update_xml - updates simgrid XML files to latest version
+  
+=head1 SYNOPSIS
+
+B<simgrid_update_xml> I<xml_file>
+  
+=head1 DESCRIPTION
+
+simgrid_update_xml updates the simgrid XML file passed as argument.  The file
+is modified in place, without any kind of backup. You may want to save a copy
+before running the script.
+
+In SimGrid XML files, the standard version is indicated in the version
+attribute of the platform tag. Current version is 3. Here is a list of major
+changes in each version.
+
+=over 4
+
+=item B<Version 0:> Used before SimGrid 3.3
+
+=item B<Version 1:> Introduced in SimGrid 3.3
+
+=over 4
+
+=item 
+
+The version attribute of platform were added to allow file versionning.
+
+=item
+
+The link bandwidth changed from Mb/s to b/s; and the CPU power were changed
+from MFlop/s to Flop/s
+
+=back
+
+=item B<Version 2:> Introduced in SimGrid 3.4
+
+=over 
+
+=item 
+
+Several tags were renamed: 
+
+  CPU -> HOST 
+  NETWORK_LINK -> LINK
+  ROUTE_ELEMENT ->  LINK_CTN
+  PLATFORM_DESCRIPTION -> PLATFORM
+
+=back
+
+=item B<Version 3:> Introduced in SimGrid 3.5 (this is the current version)
+
+=over 4
+
+=item
+
+The AS tag were introduced. Every plaform should now contain an englobing AS
+tag.
+
+=item 
+
+Routes are now symmetric by default.
+
+=item
+
+Several tags were renamed (for sake of XML sanity):
+
+  LINK:CTN -> LINK_CTN
+  TRACE:CONNECT -> TRACE_CONNECT
+
+=back
+
+=back
+
+=head1 AUTHORS
+
+ The SimGrid team (simgrid-devel@lists.gforge.inria.fr)
+  
+=head1 COPYRIGHT AND LICENSE
+
+Copyright (c) 2006-2014. The SimGrid Team. All rights reserved.
+  
+This program is free software; you may redistribute it and/or modify it
+under the terms of GNU LGPL (v2.1) license.
+  
+=cut
+
 
 use strict;
 
@@ -19,78 +113,82 @@ my($output_string);
 $ARGV[0] or die "simgrid_update_xml.pl <platform.xml>\n";
 open INPUT, "$ARGV[0]" or die "Cannot open input file $ARGV[0]: $!\n";
 
-$output_string .=  "<?xml version='1.0'?>\n";
-$output_string .=  "<!DOCTYPE platform SYSTEM \"simgrid.dtd\">\n";
-$output_string .=  "<platform version=\"$toversion\">\n";
-$output_string .=  " <AS  id=\"AS0\"  routing=\"Full\">\n";
+$output_string = "<?xml version='1.0'?>\n".
+    "<!DOCTYPE platform SYSTEM \"http://simgrid.gforge.inria.fr/simgrid.dtd\">\n".
+    "<platform version=\"$toversion\">\n";
+
+
+my($AS_opened)=0;
 
 my $line;
-while (defined($line = <INPUT>))
-{
+while (defined($line = <INPUT>)) {
     chomp $line;
     # eat the header, whatever form it has
     next if ($line =~ s/<\?xml[^>]*>//           && ! $line =~ /\S/); # just in case several tags are on the same line
     next if ($line =~ s/<!DOCTYPE[^>]*>//        && ! $line =~ /\S/);
     
-    if ($line =~ s/<platform(_description)? *>//)
-    {
-               $fromversion = 0;
-               print "version 0\n";
-               next if !$line =~ /\S/;
-    }
-    elsif ($line =~ s/<platform.*version=["]*([0-9.])["]*>//)
-    {
-               $fromversion = $1;
-               print "version $fromversion\n";
-               if ($fromversion == $toversion) 
-               {
-               die "Input platform file version is already $fromversion. This should be a no-op.\n";
-               }
-               if ($fromversion > $toversion)
-               {
-               die "Input platform file version is more recent than this script (file version: $fromversion; script version: $toversion)\n";
-               }
-               next if !$line =~ /\S/;
+    if ($line =~ s/<platform(_description)? *>//) {
+       $fromversion = 0;
+       print "version 0\n";
+       next if !$line =~ /\S/;
+    } elsif ($line =~ s/<platform.*version=["]*([0-9.])["]*>//) {
+       $fromversion = $1;
+       print "version $fromversion\n";
+       if ($fromversion == $toversion) {
+           die "Input platform file version is already $fromversion. This should be a no-op.\n";
+       }
+       if ($fromversion > $toversion) {
+           die "Input platform file version is more recent than this script (file version: $fromversion; script version: $toversion)\n";
+       }
+       next if !$line =~ /\S/;
     }
     
-    if ($fromversion == 0)
-    {
-               while ($line =~ m|^(.*?)<cpu(.*?)power="([^"]*)"(.*)$|)
-               {
-               $line = "$1TOTOTUTUTATA${2}TOTOTUTUTATA".($3*1000000)."TOTOTUTUTATA${4}";
-               }
-               while ($line =~ /^(.*?)TOTOTUTUTATA(.*?)TOTOTUTUTATA(.*?)TOTOTUTUTATA(.*)$/)
-               {
-               $line = "$1<cpu${2}power=\"$3\"$4";
-               }
-               while ($line =~ m|^(.*?)<network_link(.*?)bandwidth="([^"]*)"(.*?)$|)
-               {
-               $line = "$1TOTOTUTUTATA${2}TOTOTUTUTATA".($3*1000000)."TOTOTUTUTATA${4}";
-               }
-               while ($line =~ /^(.*?)TOTOTUTUTATA(.*?)TOTOTUTUTATA(.*?)TOTOTUTUTATA(.*?)$/)
-               {
-               $line = "$1<network_link${2}bandwidth=\"$3\"$4";
-               }
+    if ($fromversion == 0) {
+       while ($line =~ m|^(.*?)<cpu(.*?)power="([^"]*)"(.*)$|) {
+           $line = "$1TOTOTUTUTATA${2}TOTOTUTUTATA".($3*1000000)."TOTOTUTUTATA${4}";
+       }
+       while ($line =~ /^(.*?)TOTOTUTUTATA(.*?)TOTOTUTUTATA(.*?)TOTOTUTUTATA(.*)$/) {
+           $line = "$1<cpu${2}power=\"$3\"$4";
+       }
+       while ($line =~ m|^(.*?)<network_link(.*?)bandwidth="([^"]*)"(.*?)$|) {
+           $line = "$1TOTOTUTUTATA${2}TOTOTUTUTATA".($3*1000000)."TOTOTUTUTATA${4}";
+       }
+       while ($line =~ /^(.*?)TOTOTUTUTATA(.*?)TOTOTUTUTATA(.*?)TOTOTUTUTATA(.*?)$/) {
+           $line = "$1<network_link${2}bandwidth=\"$3\"$4";
+       }
     }
 
-    if ($fromversion < 2) 
-    {
-               # The renamings (\b=zero-width word boundary check)
-               $line =~ s/\bplatform_description\b/platform/g;
-               $line =~ s/\bname\b/id/g;
-               $line =~ s/\bcpu\b/host/g;
-               $line =~ s/\bnetwork_link\b/link/g;
-               $line =~ s/\broute_element\b/link:ctn/g;
+    if ($fromversion < 2)  {
+       # The renamings (\b=zero-width word boundary check)
+       $line =~ s/\bplatform_description\b/platform/g;
+       $line =~ s/\bname\b/id/g;
+       $line =~ s/\bcpu\b/host/g;
+       $line =~ s/\bnetwork_link\b/link/g;
+       $line =~ s/\broute_element\b/link:ctn/g;
     }
     
-    if($line =~ /^(.*)<\/platform>(.*)$/)
-       {
-               $output_string .=  " <\/AS>\n<\/platform>";
+    if ($fromversion < 3)  {
+       $line =~ s/\blink:ctn\b/link_ctn/g;
+       $line =~ s/\btrace:connect\b/trace_connect/g;
+
+       if($AS_opened && (($line=~ /<\/platform>/) || ($line=~ /<process/))) {
+           $output_string .= "</AS>\n";
+           $AS_opened = 0;
        }
-       else
-       {
-       $output_string .=  "$line\n";
+
+       if( (!$AS_opened) && (
+               ($line =~ /<host/)    ||
+               ($line =~ /<link/)    ||
+               ($line =~ /<cluster/) ||
+               ($line =~ /<router/)
+           )) {
+           $output_string .=  " <AS  id=\"AS0\"  routing=\"Full\">\n";
+           $AS_opened=1;
        }
+    }
+       
+       if($line=~/<route /){$line =~ s/\<route/\<route symmetrical=\"NO\"/g;}
+    $output_string .= "$line\n";
 }
 
 close INPUT;