src/surf/xml/simgrid.dtd

   1 <!--
   2              DTD of SimGrid platform and deployment files.
   3
   4 More info: http://simgrid.gforge.inria.fr/simgrid/latest/doc/platform.html
   5 To upgrade your files, use the tool simgrid_update_xml
   6
   7 * Things that will change in upcoming version 5 (TODO):
   8   - The following tags will be removed:
   9     - <include> spits an error since v3.18
  10     - <random> does nothing since a very long time
  11     - <as>, <asroute>, <bypassZoneRoute> and <process>, deprecated in DTD4.1
  12   - FULLDUPLEX sharing will be removed, deprecated in DTD4.2 (v3.19)
  13
  14 * New in DTD version 4.2 (in SimGrid 3.19): backward compatible change (v4 files are valid v4.2 files)
  15    - SPLITDUPLEX is the new spelling of the deprecated FULLDUPLEX
  16
  17 * New in DTD version 4.1 (in SimGrid 3.16): backward compatible change (v4 files are valid v4.1 files)
  18    - <zone> can be used as a synonym for the now deprecated <as>
  19    - <zoneRoute> can be used as a synonym for the now deprecated <asroute>
  20    - <bypassZoneRoute> an be used as a synonym for the now deprecated <bypassAsRoute>
  21    - <actor> can be used as a synonym for the now deprecated <process>
  22
  23 * New in DTD version 4 (in SimGrid 3.13):
  24    - Rename (power->speed) the attributes describing the amount of flop
  25      that a <host>, <peer>, <cluster> or <cabinet> can deliver per second.
  26
  27    - In <trace_connect>, attribute kind="POWER" is now kind="SPEED".
  28
  29    - In <host> and <link>, attributes availability and state are gone.
  30      It was redundent with state and availability traces, and with peak values.
  31
  32    - In <cluster>, cannot set the availability nor state traces.
  33      This was too complex and unused.
  34
  35    - The DOCTYPE points to the right URL (this file).
  36
  37    - Kill <gpu>. Was not doing anything.
  38
  39    - A warning is emitted for unit-less values (they are still accepted).
  40      The value 0 can remain unit-less, as its unit does not matter.
  41
  42      - speed. Default: 'f' or 'flops'. Also defined:
  43         'Yf',         'Zf',         'Ef',       'Pf',        'Tf',        'Gf',        'Mf',        'kf'
  44         'yottaflops', 'zettaflops', 'exaflops', 'petaflops', 'teraflops', 'gigaflops', 'megaflops', 'kiloflops'
  45
  46      - bandwidth. Default: 'Bps' bytes per second
  47        In bytes and powers of 2  (1 KiBps = 1024 Bps): 'EiBps', 'PiBps', 'TiBps', 'GiBps', 'MiBps', 'KiBps'
  48        In bits  and powers of 2  (1 Bps = 8 bps)     : 'Eibps', 'Pibps', 'Tibps', 'Gibps', 'Mibps', 'Kibps'
  49        In bytes and powers of 10 (1 KBps = 1000 Bps) : 'EBps', 'PBps', 'TBps', 'GBps', 'MBps', 'kBps', 'Bps'
  50        In bits  and powers of 10                     : 'Ebps', 'Pbps', 'Tbps', 'Gbps', 'Mbps', 'kbps', 'bps'
  51        (Exa and Peta notations were introduced in SimGrid v3.14)
  52
  53      - latency. Default: 's' second. Also defined:
  54        'w' week, 'd' day, 'h' hour, 'm' minute, 'ms' millisecond, 'us' microsecond, 'ns' nanosecond, 'ps' picosecond
  55
  56 * New in DTD version 3 (in SimGrid 3.5):
  57    - The AS tag were introduced. Every platform should now
  58      contain an englobing AS tag.
  59    - Routes are now symmetric by default.
  60    - Renamed tags (for sake of XML sanity):
  61      - LINK:CTN -> LINK_CTN
  62      - TRACE:CONNECT -> TRACE_CONNECT
  63
  64 * New in DTD version 2 (in SimGrid 3.4):
  65    - Renamed tags:
  66      - CPU -> HOST
  67      - NETWORK_LINK -> LINK
  68      - ROUTE_ELEMENT ->  LINK:CTN (changed again in v3)
  69      - PLATFORM_DESCRIPTION -> PLATFORM
  70
  71 * New in DTD version 1 (in SimGrid 3.3):
  72    - DTD is now versionned with the version attribute of platform
  73    - Unit change:
  74      - Link bandwidth: from Mb/s to b/s
  75      - CPU speed: from MFlop/s to Flop/s
  76
  77 -->
  78
  79 <!ELEMENT platform ((config|random)*,(include|cluster|cabinet|peer|AS|zone|trace|trace_connect)*,(process|actor)*)>
  80 <!ATTLIST platform version CDATA "0.0">
  81
  82 <!-- tag include is deprecated. Not documented, and removed in v3.22 -->
  83 <!ELEMENT include (include|cluster|cabinet|peer|AS|zone|trace|trace_connect)*>
  84 <!ATTLIST include file CDATA #REQUIRED>
  85
  86 <!ELEMENT trace (#PCDATA)>
  87 <!ATTLIST trace id CDATA #REQUIRED>
  88 <!ATTLIST trace file CDATA "">
  89 <!ATTLIST trace periodicity CDATA #REQUIRED>
  90
  91 <!ELEMENT random EMPTY>
  92 <!ATTLIST random id CDATA #REQUIRED>
  93 <!ATTLIST random min CDATA #REQUIRED>
  94 <!ATTLIST random max CDATA #REQUIRED>
  95 <!ATTLIST random mean CDATA #REQUIRED>
  96 <!ATTLIST random std_deviation CDATA #REQUIRED>
  97 <!ATTLIST random seed CDATA "2147483647">
  98 <!ATTLIST random radical CDATA "">
  99 <!ATTLIST random generator (DRAND48|RAND|RNGSTREAM|NONE) "DRAND48">
 100
 101 <!ELEMENT trace_connect EMPTY>
 102 <!ATTLIST trace_connect kind (HOST_AVAIL|SPEED|LINK_AVAIL|BANDWIDTH|LATENCY) "HOST_AVAIL">
 103 <!ATTLIST trace_connect trace CDATA #REQUIRED>
 104 <!ATTLIST trace_connect element CDATA #REQUIRED>
 105
 106 <!-- A zone is either an internal node that contains other zones,
 107      or a  leaf containing hosts and other leaf-like elements -->
 108 <!ELEMENT AS ((prop*),
 109           (((AS|zone|include|link|backbone|cabinet|cluster|peer|trace|trace_connect)*,
 110             (zoneRoute|ASroute|trace|trace_connect|bypassASroute|bypassZoneRoute)*,
 111             (trace|trace_connect)*)
 112            |((include|storage_type|storage|host|cabinet|router|link|backbone|trace|trace_connect|host_link)*,
 113              (route|trace|trace_connect|bypassRoute)*)))>
 114 <!ATTLIST AS id CDATA #REQUIRED>
 115 <!ATTLIST AS routing (Full|Floyd|Dijkstra|DijkstraCache|None|Vivaldi|Cluster|ClusterTorus|ClusterFatTree|ClusterDragonfly) #REQUIRED>
 116
 117 <!-- A zone is either an internal node that contains other zones,
 118      or a  leaf containing hosts and other leaf-like elements -->
 119 <!ELEMENT zone ((prop*),
 120           (((AS|zone|include|link|backbone|cluster|peer|trace|trace_connect)*,
 121             (zoneRoute|ASroute|trace|trace_connect|bypassASroute|bypassZoneRoute)*,
 122             (trace|trace_connect)*)
 123            |((include|storage_type|storage|host|cabinet|router|link|backbone|trace|trace_connect|host_link)*,
 124              (route|trace|trace_connect|bypassRoute)*)))>
 125 <!ATTLIST zone id CDATA #REQUIRED>
 126 <!ATTLIST zone routing (Full|Floyd|Dijkstra|DijkstraCache|None|Vivaldi|Cluster|ClusterTorus|ClusterFatTree|ClusterDragonfly) #REQUIRED>
 127
 128 <!ELEMENT storage_type ((model_prop|prop)*)>
 129 <!ATTLIST storage_type id       CDATA #REQUIRED>
 130 <!ATTLIST storage_type model    CDATA "N11">
 131 <!ATTLIST storage_type size     CDATA #REQUIRED>
 132 <!ATTLIST storage_type content  CDATA "">
 133
 134 <!ELEMENT mount EMPTY>
 135 <!ATTLIST mount storageId CDATA #REQUIRED>
 136 <!ATTLIST mount name CDATA #REQUIRED>
 137
 138 <!ELEMENT host (prop|mount)*>
 139 <!ATTLIST host id CDATA #REQUIRED>
 140 <!ATTLIST host speed CDATA #REQUIRED>
 141 <!ATTLIST host core  CDATA "1">
 142 <!ATTLIST host availability_file CDATA "">
 143 <!ATTLIST host state_file CDATA "">
 144 <!ATTLIST host coordinates  CDATA "">
 145 <!ATTLIST host pstate CDATA "0.0">
 146
 147 <!ELEMENT storage (prop*)>
 148 <!ATTLIST storage id CDATA #REQUIRED>
 149 <!ATTLIST storage typeId CDATA #REQUIRED>
 150 <!ATTLIST storage content  CDATA "">
 151 <!ATTLIST storage attach CDATA #REQUIRED>
 152
 153 <!ELEMENT host_link EMPTY>
 154 <!ATTLIST host_link id CDATA #REQUIRED>
 155 <!ATTLIST host_link up CDATA #REQUIRED>
 156 <!ATTLIST host_link down CDATA #REQUIRED>
 157
 158 <!ELEMENT cluster (prop*)>
 159 <!ATTLIST cluster id CDATA #REQUIRED>
 160 <!ATTLIST cluster prefix CDATA #REQUIRED>
 161 <!ATTLIST cluster suffix CDATA #REQUIRED>
 162 <!ATTLIST cluster radical CDATA #REQUIRED>
 163 <!ATTLIST cluster speed CDATA #REQUIRED>
 164 <!ATTLIST cluster core CDATA "1">
 165 <!ATTLIST cluster bw CDATA #REQUIRED>
 166 <!ATTLIST cluster lat CDATA #REQUIRED>
 167 <!ATTLIST cluster sharing_policy (SHARED|SPLITDUPLEX|FULLDUPLEX|FATPIPE) "SPLITDUPLEX">
 168 <!ATTLIST cluster topology (FLAT|TORUS|FAT_TREE|DRAGONFLY) "FLAT">
 169 <!ATTLIST cluster topo_parameters CDATA "">
 170 <!ATTLIST cluster bb_bw CDATA "">
 171 <!ATTLIST cluster bb_lat CDATA "0s">
 172 <!ATTLIST cluster bb_sharing_policy (SHARED|FATPIPE) "SHARED">
 173 <!ATTLIST cluster router_id CDATA "">
 174 <!ATTLIST cluster limiter_link CDATA "">
 175 <!ATTLIST cluster loopback_bw CDATA "">
 176 <!ATTLIST cluster loopback_lat CDATA "">
 177
 178 <!ELEMENT cabinet EMPTY>
 179 <!ATTLIST cabinet id CDATA #REQUIRED>
 180 <!ATTLIST cabinet prefix CDATA #REQUIRED>
 181 <!ATTLIST cabinet suffix CDATA #REQUIRED>
 182 <!ATTLIST cabinet radical CDATA #REQUIRED>
 183 <!ATTLIST cabinet speed CDATA #REQUIRED>
 184 <!ATTLIST cabinet bw CDATA #REQUIRED>
 185 <!ATTLIST cabinet lat CDATA #REQUIRED>
 186
 187 <!ELEMENT peer EMPTY>
 188 <!ATTLIST peer id CDATA #REQUIRED>
 189 <!ATTLIST peer speed CDATA #REQUIRED>
 190 <!ATTLIST peer bw_in CDATA #REQUIRED>
 191 <!ATTLIST peer bw_out CDATA #REQUIRED>
 192 <!ATTLIST peer lat CDATA "0">
 193 <!ATTLIST peer coordinates CDATA "">
 194 <!ATTLIST peer availability_file CDATA "">
 195 <!ATTLIST peer state_file CDATA "">
 196
 197 <!ELEMENT router EMPTY>
 198 <!ATTLIST router id CDATA #REQUIRED>
 199 <!ATTLIST router coordinates  CDATA "">
 200
 201 <!ELEMENT backbone EMPTY>
 202 <!ATTLIST backbone id CDATA #REQUIRED>
 203 <!ATTLIST backbone bandwidth CDATA  #REQUIRED>
 204 <!ATTLIST backbone latency CDATA #REQUIRED>
 205
 206 <!ELEMENT link (prop*)>
 207 <!ATTLIST link id CDATA #REQUIRED>
 208 <!ATTLIST link bandwidth CDATA  #REQUIRED>
 209 <!ATTLIST link bandwidth_file CDATA "">
 210 <!ATTLIST link latency CDATA "0">
 211 <!ATTLIST link latency_file CDATA "">
 212 <!ATTLIST link state_file CDATA "">
 213 <!ATTLIST link sharing_policy (SHARED|SPLITDUPLEX|FULLDUPLEX|FATPIPE) "SHARED">
 214
 215 <!ELEMENT route (link_ctn*)>
 216 <!ATTLIST route src CDATA #REQUIRED>
 217 <!ATTLIST route dst CDATA #REQUIRED>
 218 <!ATTLIST route symmetrical (YES|NO|yes|no) "YES">
 219
 220 <!ELEMENT ASroute (link_ctn*)>
 221 <!ATTLIST ASroute src CDATA #REQUIRED>
 222 <!ATTLIST ASroute dst CDATA #REQUIRED>
 223 <!ATTLIST ASroute gw_src CDATA #REQUIRED>
 224 <!ATTLIST ASroute gw_dst CDATA #REQUIRED>
 225 <!ATTLIST ASroute symmetrical (YES|NO|yes|no) "YES">
 226
 227 <!ELEMENT zoneRoute (link_ctn*)>
 228 <!ATTLIST zoneRoute src CDATA #REQUIRED>
 229 <!ATTLIST zoneRoute dst CDATA #REQUIRED>
 230 <!ATTLIST zoneRoute gw_src CDATA #REQUIRED>
 231 <!ATTLIST zoneRoute gw_dst CDATA #REQUIRED>
 232 <!ATTLIST zoneRoute symmetrical (YES|NO|yes|no) "YES">
 233
 234 <!ELEMENT link_ctn EMPTY>
 235 <!ATTLIST link_ctn id CDATA #REQUIRED>
 236 <!ATTLIST link_ctn direction (UP|DOWN|NONE) "NONE">
 237
 238 <!ELEMENT bypassRoute (link_ctn*)>
 239 <!ATTLIST bypassRoute src CDATA #REQUIRED>
 240 <!ATTLIST bypassRoute dst CDATA #REQUIRED>
 241
 242 <!ELEMENT bypassASroute (link_ctn*)>
 243 <!ATTLIST bypassASroute src CDATA #REQUIRED>
 244 <!ATTLIST bypassASroute dst CDATA #REQUIRED>
 245 <!ATTLIST bypassASroute gw_src CDATA #REQUIRED>
 246 <!ATTLIST bypassASroute gw_dst CDATA #REQUIRED>
 247
 248 <!ELEMENT bypassZoneRoute (link_ctn*)>
 249 <!ATTLIST bypassZoneRoute src CDATA #REQUIRED>
 250 <!ATTLIST bypassZoneRoute dst CDATA #REQUIRED>
 251 <!ATTLIST bypassZoneRoute gw_src CDATA #REQUIRED>
 252 <!ATTLIST bypassZoneRoute gw_dst CDATA #REQUIRED>
 253
 254 <!ELEMENT process ((argument|prop)*)>
 255 <!ATTLIST process host CDATA #REQUIRED>
 256 <!ATTLIST process function CDATA #REQUIRED>
 257 <!ATTLIST process start_time CDATA "-1.0">
 258 <!ATTLIST process kill_time CDATA "-1.0">
 259 <!ATTLIST process on_failure (DIE|RESTART) "DIE">
 260
 261 <!ELEMENT actor ((argument|prop)*)>
 262 <!ATTLIST actor host CDATA #REQUIRED>
 263 <!ATTLIST actor function CDATA #REQUIRED>
 264 <!ATTLIST actor start_time CDATA "-1.0">
 265 <!ATTLIST actor kill_time CDATA "-1.0">
 266 <!ATTLIST actor on_failure (DIE|RESTART) "DIE">
 267
 268 <!ELEMENT argument EMPTY>
 269 <!ATTLIST argument value CDATA #REQUIRED>
 270
 271 <!ELEMENT config (prop*)>
 272 <!ATTLIST config id CDATA "">
 273
 274 <!ELEMENT prop EMPTY>
 275 <!ATTLIST prop id CDATA #REQUIRED> <!-- <!ATTLIST prop key CDATA #REQUIRED> -->
 276 <!ATTLIST prop value CDATA #REQUIRED>
 277
 278 <!ELEMENT model_prop EMPTY>
 279 <!ATTLIST model_prop id CDATA #REQUIRED> <!-- <!ATTLIST model_prop key CDATA #REQUIRED> -->
 280 <!ATTLIST model_prop value CDATA #REQUIRED>