Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
- Update xml DTD to handle WIFI sharing policy
[simgrid.git] / src / surf / xml / simgrid.dtd
1 <!--
2              DTD of SimGrid platform and deployment files.
3
4 More info: https://simgrid.org/doc/latest/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.1 (in SimGrid 3.16): backward compatible change (v4 files are valid v4.1 files)
15    - <zone> can be used as a synonym for the now deprecated <as>
16    - <zoneRoute> can be used as a synonym for the now deprecated <asroute>
17    - <bypassZoneRoute> an be used as a synonym for the now deprecated <bypassAsRoute>
18    - <actor> can be used as a synonym for the now deprecated <process>
19   Other backward-compatible changes for which we did not bump the DTD version.
20   - SPLITDUPLEX is the new spelling of the deprecated FULLDUPLEX (SimGrid v3.19)
21   - In <host> and <peer> availability_file is now speed_file (SimGrid v3.22)
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 redundant with state and availability profiles, and with peak values.
31
32    - In <cluster>, cannot set the availability nor state profiles.
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 speed_file CDATA "">
143 <!ATTLIST host availability_file CDATA ""> <!-- deprecated -->
144 <!ATTLIST host state_file CDATA "">
145 <!ATTLIST host coordinates  CDATA "">
146 <!ATTLIST host pstate CDATA "0.0">
147
148 <!ELEMENT storage (prop*)>
149 <!ATTLIST storage id CDATA #REQUIRED>
150 <!ATTLIST storage typeId CDATA #REQUIRED>
151 <!ATTLIST storage content  CDATA "">
152 <!ATTLIST storage attach CDATA #REQUIRED>
153
154 <!ELEMENT host_link EMPTY>
155 <!ATTLIST host_link id CDATA #REQUIRED>
156 <!ATTLIST host_link up CDATA #REQUIRED>
157 <!ATTLIST host_link down CDATA #REQUIRED>
158
159 <!ELEMENT cluster (prop*)>
160 <!ATTLIST cluster id CDATA #REQUIRED>
161 <!ATTLIST cluster prefix CDATA #REQUIRED>
162 <!ATTLIST cluster suffix CDATA #REQUIRED>
163 <!ATTLIST cluster radical CDATA #REQUIRED>
164 <!ATTLIST cluster speed CDATA #REQUIRED>
165 <!ATTLIST cluster core CDATA "1">
166 <!ATTLIST cluster bw CDATA #REQUIRED>
167 <!ATTLIST cluster lat CDATA #REQUIRED>
168 <!ATTLIST cluster sharing_policy (SHARED|SPLITDUPLEX|FULLDUPLEX|FATPIPE) "SPLITDUPLEX">
169 <!ATTLIST cluster topology (FLAT|TORUS|FAT_TREE|DRAGONFLY) "FLAT">
170 <!ATTLIST cluster topo_parameters CDATA "">
171 <!ATTLIST cluster bb_bw CDATA "">
172 <!ATTLIST cluster bb_lat CDATA "0s">
173 <!ATTLIST cluster bb_sharing_policy (SHARED|FATPIPE) "SHARED">
174 <!ATTLIST cluster router_id CDATA "">
175 <!ATTLIST cluster limiter_link CDATA "">
176 <!ATTLIST cluster loopback_bw CDATA "">
177 <!ATTLIST cluster loopback_lat CDATA "">
178
179 <!ELEMENT cabinet EMPTY>
180 <!ATTLIST cabinet id CDATA #REQUIRED>
181 <!ATTLIST cabinet prefix CDATA #REQUIRED>
182 <!ATTLIST cabinet suffix CDATA #REQUIRED>
183 <!ATTLIST cabinet radical CDATA #REQUIRED>
184 <!ATTLIST cabinet speed CDATA #REQUIRED>
185 <!ATTLIST cabinet bw CDATA #REQUIRED>
186 <!ATTLIST cabinet lat CDATA #REQUIRED>
187
188 <!ELEMENT peer EMPTY>
189 <!ATTLIST peer id CDATA #REQUIRED>
190 <!ATTLIST peer speed CDATA #REQUIRED>
191 <!ATTLIST peer bw_in CDATA #REQUIRED>
192 <!ATTLIST peer bw_out CDATA #REQUIRED>
193 <!ATTLIST peer lat CDATA "0">
194 <!ATTLIST peer coordinates CDATA "">
195 <!ATTLIST peer speed_file CDATA ""> 
196 <!ATTLIST peer availability_file CDATA ""> <!-- deprecated -->
197 <!ATTLIST peer state_file CDATA "">
198
199 <!ELEMENT router EMPTY>
200 <!ATTLIST router id CDATA #REQUIRED>
201 <!ATTLIST router coordinates  CDATA "">
202
203 <!ELEMENT backbone EMPTY>
204 <!ATTLIST backbone id CDATA #REQUIRED>
205 <!ATTLIST backbone bandwidth CDATA  #REQUIRED>
206 <!ATTLIST backbone latency CDATA #REQUIRED>
207
208 <!ELEMENT link (prop*)>
209 <!ATTLIST link id CDATA #REQUIRED>
210 <!ATTLIST link bandwidth CDATA  #REQUIRED>
211 <!ATTLIST link bandwidth_file CDATA "">
212 <!ATTLIST link latency CDATA "0">
213 <!ATTLIST link latency_file CDATA "">
214 <!ATTLIST link state_file CDATA "">
215 <!ATTLIST link sharing_policy (SHARED|SPLITDUPLEX|FULLDUPLEX|FATPIPE|WIFI) "SHARED">
216
217 <!ELEMENT route (link_ctn*)>
218 <!ATTLIST route src CDATA #REQUIRED>
219 <!ATTLIST route dst CDATA #REQUIRED>
220 <!ATTLIST route symmetrical (YES|NO|yes|no) "YES">
221
222 <!ELEMENT ASroute (link_ctn*)>
223 <!ATTLIST ASroute src CDATA #REQUIRED>
224 <!ATTLIST ASroute dst CDATA #REQUIRED>
225 <!ATTLIST ASroute gw_src CDATA #REQUIRED>
226 <!ATTLIST ASroute gw_dst CDATA #REQUIRED>
227 <!ATTLIST ASroute symmetrical (YES|NO|yes|no) "YES">
228
229 <!ELEMENT zoneRoute (link_ctn*)>
230 <!ATTLIST zoneRoute src CDATA #REQUIRED>
231 <!ATTLIST zoneRoute dst CDATA #REQUIRED>
232 <!ATTLIST zoneRoute gw_src CDATA #REQUIRED>
233 <!ATTLIST zoneRoute gw_dst CDATA #REQUIRED>
234 <!ATTLIST zoneRoute symmetrical (YES|NO|yes|no) "YES">
235
236 <!ELEMENT link_ctn EMPTY>
237 <!ATTLIST link_ctn id CDATA #REQUIRED>
238 <!ATTLIST link_ctn direction (UP|DOWN|NONE) "NONE">
239
240 <!ELEMENT bypassRoute (link_ctn*)>
241 <!ATTLIST bypassRoute src CDATA #REQUIRED>
242 <!ATTLIST bypassRoute dst CDATA #REQUIRED>
243
244 <!ELEMENT bypassASroute (link_ctn*)>
245 <!ATTLIST bypassASroute src CDATA #REQUIRED>
246 <!ATTLIST bypassASroute dst CDATA #REQUIRED>
247 <!ATTLIST bypassASroute gw_src CDATA #REQUIRED>
248 <!ATTLIST bypassASroute gw_dst CDATA #REQUIRED>
249
250 <!ELEMENT bypassZoneRoute (link_ctn*)>
251 <!ATTLIST bypassZoneRoute src CDATA #REQUIRED>
252 <!ATTLIST bypassZoneRoute dst CDATA #REQUIRED>
253 <!ATTLIST bypassZoneRoute gw_src CDATA #REQUIRED>
254 <!ATTLIST bypassZoneRoute gw_dst CDATA #REQUIRED>
255
256 <!ELEMENT process ((argument|prop)*)>
257 <!ATTLIST process host CDATA #REQUIRED>
258 <!ATTLIST process function CDATA #REQUIRED>
259 <!ATTLIST process start_time CDATA "-1.0">
260 <!ATTLIST process kill_time CDATA "-1.0">
261 <!ATTLIST process on_failure (DIE|RESTART) "DIE">
262
263 <!ELEMENT actor ((argument|prop)*)>
264 <!ATTLIST actor host CDATA #REQUIRED>
265 <!ATTLIST actor function CDATA #REQUIRED>
266 <!ATTLIST actor start_time CDATA "-1.0">
267 <!ATTLIST actor kill_time CDATA "-1.0">
268 <!ATTLIST actor on_failure (DIE|RESTART) "DIE">
269
270 <!ELEMENT argument EMPTY>
271 <!ATTLIST argument value CDATA #REQUIRED>
272
273 <!ELEMENT config (prop*)>
274 <!ATTLIST config id CDATA "">
275
276 <!ELEMENT prop EMPTY>
277 <!ATTLIST prop id CDATA #REQUIRED> <!-- <!ATTLIST prop key CDATA #REQUIRED> -->
278 <!ATTLIST prop value CDATA #REQUIRED>
279
280 <!ELEMENT model_prop EMPTY>
281 <!ATTLIST model_prop id CDATA #REQUIRED> <!-- <!ATTLIST model_prop key CDATA #REQUIRED> -->
282 <!ATTLIST model_prop value CDATA #REQUIRED>