.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "SIMGRID_UPDATE_XML 1"
.TH SIMGRID_UPDATE_XML 1 2024-04-07 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
simgrid_update_xml \- updates SimGrid XML files to latest version
.SH SYNOPSIS
.IX Header "SYNOPSIS"
\&\fBsimgrid_update_xml\fR \fIxml_file\fR
.SH DESCRIPTION
.IX Header "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.
.PP
In SimGrid XML files, the standard version is indicated in the version
attribute of the platform tag. Current version is 4. Here is a list of major
changes in each version.
.IP "\fBVersion 0:\fR Used before SimGrid 3.3" 4
.IX Item "Version 0: Used before SimGrid 3.3"
.PD 0
.IP "\fBVersion 1:\fR Introduced in SimGrid 3.3" 4
.IX Item "Version 1: Introduced in SimGrid 3.3"
.RS 4
.IP \(bu 4
.PD
The version attribute of platform were added to allow file versioning.
.IP \(bu 4
The link bandwidth changed from Mb/s to b/s; and the CPU power were changed
from MFlop/s to Flop/s
.RE
.RS 4
.RE
.IP "\fBVersion 2:\fR Introduced in SimGrid 3.4" 4
.IX Item "Version 2: Introduced in SimGrid 3.4"
.RS 4
.PD 0
.IP \(bu 4
.PD
Several tags were renamed:
.Sp
.Vb 4
\&  CPU \-> HOST
\&  NETWORK_LINK \-> LINK
\&  ROUTE_ELEMENT \->  LINK_CTN
\&  PLATFORM_DESCRIPTION \-> PLATFORM
.Ve
.RE
.RS 4
.RE
.IP "\fBVersion 3:\fR Introduced in SimGrid 3.5" 4
.IX Item "Version 3: Introduced in SimGrid 3.5"
.RS 4
.PD 0
.IP \(bu 4
.PD
The AS tag were introduced. Every platform should now contain an englobing AS
tag.
.IP \(bu 4
Routes are now symmetric by default.
.IP \(bu 4
Several tags were renamed (for sake of XML sanity):
.Sp
.Vb 2
\&  LINK:CTN \-> LINK_CTN
\&  TRACE:CONNECT \-> TRACE_CONNECT
.Ve
.RE
.RS 4
.RE
.IP "\fBVersion 4:\fR Introduced in SimGrid 3.13" 4
.IX Item "Version 4: Introduced in SimGrid 3.13"
.RS 4
.PD 0
.IP \(bu 4
.PD
Rename the attributes describing the amount of flop that a host / peer / cluster / cabinet can deliver per second.
.Sp
.Vb 1
\&  <host power=...> \-> <host speed=...>
.Ve
.IP \(bu 4
In <trace_connect>, attribute kind="POWER" is now kind="SPEED".
.IP \(bu 4
The DOCTYPE points to the right URL.
.IP \(bu 4
Units are now mandatory in attributes. USE THE SCRIPT sg_xml_unit_converter.py TO CONVERT THIS
.Sp
.Vb 3
\&     \- speed. Old default: \*(Aqf\*(Aq or \*(Aqflops\*(Aq. Also defined:
\&        \*(AqYf\*(Aq,         \*(AqZf\*(Aq,         \*(AqEf\*(Aq,       \*(AqPf\*(Aq,        \*(AqTf\*(Aq,        \*(AqGf\*(Aq,        \*(AqMf\*(Aq,        \*(Aqkf\*(Aq
\&        \*(Aqyottaflops\*(Aq, \*(Aqzettaflops\*(Aq, \*(Aqexaflops\*(Aq, \*(Aqpetaflops\*(Aq, \*(Aqteraflops\*(Aq, \*(Aqgigaflops\*(Aq, \*(Aqmegaflops\*(Aq, \*(Aqkiloflops\*(Aq
\&
\&     \- bandwidth. Old default: \*(AqBps\*(Aq bytes per second (or \*(Aqbps\*(Aq but 1 Bps = 8 bps)
\&       Also defined in bytes: \*(AqTiBps\*(Aq, \*(AqGiBps\*(Aq, \*(AqMiBps\*(Aq, \*(AqKiBps\*(Aq, \*(AqTBps\*(Aq, \*(AqGBps\*(Aq, \*(AqMBps\*(Aq, \*(AqkBps\*(Aq, \*(AqBps\*(Aq
\&       And the same in bits:  \*(AqTibps\*(Aq, \*(AqGibps\*(Aq, \*(AqMibps\*(Aq, \*(AqKibps\*(Aq, \*(AqTbps\*(Aq, \*(AqGbps\*(Aq, \*(AqMbps\*(Aq, \*(Aqkbps\*(Aq, \*(Aqbps\*(Aq
\&
\&     \- latency. Old default: \*(Aqs\*(Aq second. Also defined:
\&       \*(Aqw\*(Aq week, \*(Aqd\*(Aq day, \*(Aqh\*(Aq hour, \*(Aqm\*(Aq minute, \*(Aqms\*(Aq millisecond, \*(Aqus\*(Aq microsecond, \*(Aqns\*(Aq nanosecond, \*(Aqps\*(Aq picosecond
.Ve
.RE
.RS 4
.RE
.IP "\fBVersion 4.1:\fR Introduced in SimGrid 3.16 (this is the current version)." 4
.IX Item "Version 4.1: Introduced in SimGrid 3.16 (this is the current version)."
.RS 4
.PD 0
.IP \(bu 4
.PD
Rename a few tags, but in a backward-compatible manner: the old names are still accepted.
.Sp
.Vb 4
\&  AS            \-> zone
\&  ASroute       \-> zoneRoute
\&  bypassAsRoute \-> bypassZoneRoute
\&  process       \-> actor
.Ve
.RE
.RS 4
.RE
.IP "Other backward-compatible changes (old syntax is still accepted) for which we did not bump the DTD version:" 4
.IX Item "Other backward-compatible changes (old syntax is still accepted) for which we did not bump the DTD version:"
.RS 4
.PD 0
.IP \(bu 4
.PD
Rename the FULLDUPLEX sharing into SPLITDUPLEX.
.IP \(bu 4
In <host> and <peer>, rename the 'availability_file' attribute into 'speed_file'.
.RE
.RS 4
.RE
.SH AUTHORS
.IX Header "AUTHORS"
.Vb 1
\& The SimGrid team
.Ve
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright (c) 2006\-2023. The SimGrid Team. All rights reserved.
.PP
This program is free software; you may redistribute it and/or modify it
under the terms of GNU LGPL (v2.1) license.