Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
0c380c825badcdc9e031c9d8451c115f9bbe72c1
[simgrid.git] / 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      http://simgrid.gforge.inria.fr/simgrid/simgrid.dtd
37
38    - Kill <gpu>. Was not doing anything.
39
40    - A warning is emitted for unit-less values (they are still accepted).
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 <!ELEMENT AS ((prop*), ((AS|zone|ASroute|zoneRoute|include|storage_type|storage|link|backbone|cabinet|router|host|cluster|peer|host_link)*,(route|ASroute|zoneRoute|trace|trace_connect|bypassRoute|bypassASroute|bypassZoneRoute)*))>
107 <!ATTLIST AS id CDATA #REQUIRED>
108 <!ATTLIST AS routing (Full|Floyd|Dijkstra|DijkstraCache|None|Vivaldi|Cluster|ClusterTorus|ClusterFatTree|ClusterDragonfly) #REQUIRED>
109
110 <!-- A zone is either an internal node that contains other zones, 
111      or a  leaf containing hosts and other leaf-like elements -->
112 <!ELEMENT zone ((prop*),
113           (((AS|zone|include|link|backbone|cabinet|cluster|peer|trace|trace_connect)*,
114             (zoneRoute|ASroute|trace|trace_connect|bypassASroute)*,
115             (trace|trace_connect)*)
116            |((include|storage_type|storage|host|cabinet|router|link|backbone|trace|trace_connect|host_link)*,
117              (route|trace|trace_connect|bypassRoute)*)))>
118 <!ATTLIST zone id CDATA #REQUIRED>
119 <!ATTLIST zone routing (Full|Floyd|Dijkstra|DijkstraCache|None|Vivaldi|Cluster|ClusterTorus|ClusterFatTree|ClusterDragonfly) #REQUIRED>
120
121 <!ELEMENT storage_type ((model_prop|prop)*)>
122 <!ATTLIST storage_type id       CDATA #REQUIRED>
123 <!ATTLIST storage_type model    CDATA "N11">
124 <!ATTLIST storage_type size     CDATA #REQUIRED>
125 <!ATTLIST storage_type content  CDATA "">
126
127 <!ELEMENT mount EMPTY>
128 <!ATTLIST mount storageId CDATA #REQUIRED>
129 <!ATTLIST mount name CDATA #REQUIRED>
130
131 <!ELEMENT host (prop|mount)*>
132 <!ATTLIST host id CDATA #REQUIRED>
133 <!ATTLIST host speed CDATA #REQUIRED>
134 <!ATTLIST host core  CDATA "1">
135 <!ATTLIST host availability_file CDATA "">
136 <!ATTLIST host state_file CDATA "">
137 <!ATTLIST host coordinates  CDATA "">
138 <!ATTLIST host pstate CDATA "0.0">
139
140 <!ELEMENT storage (prop*)>
141 <!ATTLIST storage id CDATA #REQUIRED>
142 <!ATTLIST storage typeId CDATA #REQUIRED>
143 <!ATTLIST storage content  CDATA "">
144 <!ATTLIST storage attach CDATA #REQUIRED>
145
146 <!ELEMENT host_link EMPTY>
147 <!ATTLIST host_link id CDATA #REQUIRED>
148 <!ATTLIST host_link up CDATA #REQUIRED>
149 <!ATTLIST host_link down CDATA #REQUIRED>
150
151 <!ELEMENT cluster (prop*)>
152 <!ATTLIST cluster id CDATA #REQUIRED>
153 <!ATTLIST cluster prefix CDATA #REQUIRED>
154 <!ATTLIST cluster suffix CDATA #REQUIRED>
155 <!ATTLIST cluster radical CDATA #REQUIRED>
156 <!ATTLIST cluster speed CDATA #REQUIRED>
157 <!ATTLIST cluster core CDATA "1">
158 <!ATTLIST cluster bw CDATA #REQUIRED>
159 <!ATTLIST cluster lat CDATA #REQUIRED>
160 <!ATTLIST cluster sharing_policy (SHARED|SPLITDUPLEX|FULLDUPLEX|FATPIPE) "SPLITDUPLEX">
161 <!ATTLIST cluster topology (FLAT|TORUS|FAT_TREE|DRAGONFLY) "FLAT">
162 <!ATTLIST cluster topo_parameters CDATA "">
163 <!ATTLIST cluster bb_bw CDATA "">
164 <!ATTLIST cluster bb_lat CDATA "0s">
165 <!ATTLIST cluster bb_sharing_policy (SHARED|FATPIPE) "SHARED">
166 <!ATTLIST cluster router_id CDATA "">
167 <!ATTLIST cluster limiter_link CDATA "">
168 <!ATTLIST cluster loopback_bw CDATA "">
169 <!ATTLIST cluster loopback_lat CDATA "">
170
171 <!ELEMENT cabinet EMPTY>
172 <!ATTLIST cabinet id CDATA #REQUIRED>
173 <!ATTLIST cabinet prefix CDATA #REQUIRED>
174 <!ATTLIST cabinet suffix CDATA #REQUIRED>
175 <!ATTLIST cabinet radical CDATA #REQUIRED>
176 <!ATTLIST cabinet speed CDATA #REQUIRED>
177 <!ATTLIST cabinet bw CDATA #REQUIRED>
178 <!ATTLIST cabinet lat CDATA #REQUIRED>
179
180 <!ELEMENT peer EMPTY>
181 <!ATTLIST peer id CDATA #REQUIRED>
182 <!ATTLIST peer speed CDATA #REQUIRED>
183 <!ATTLIST peer bw_in CDATA #REQUIRED>
184 <!ATTLIST peer bw_out CDATA #REQUIRED>
185 <!ATTLIST peer lat CDATA "0">
186 <!ATTLIST peer coordinates CDATA "">
187 <!ATTLIST peer availability_file CDATA "">
188 <!ATTLIST peer state_file CDATA "">
189
190 <!ELEMENT router EMPTY>
191 <!ATTLIST router id CDATA #REQUIRED>
192 <!ATTLIST router coordinates  CDATA "">
193
194 <!ELEMENT backbone EMPTY>
195 <!ATTLIST backbone id CDATA #REQUIRED>
196 <!ATTLIST backbone bandwidth CDATA  #REQUIRED>
197 <!ATTLIST backbone latency CDATA #REQUIRED>
198
199 <!ELEMENT link (prop*)>
200 <!ATTLIST link id CDATA #REQUIRED>
201 <!ATTLIST link bandwidth CDATA  #REQUIRED>
202 <!ATTLIST link bandwidth_file CDATA "">
203 <!ATTLIST link latency CDATA "0">
204 <!ATTLIST link latency_file CDATA "">
205 <!ATTLIST link state_file CDATA "">
206 <!ATTLIST link sharing_policy (SHARED|SPLITDUPLEX|FULLDUPLEX|FATPIPE) "SHARED">
207
208 <!ELEMENT route (link_ctn*)>
209 <!ATTLIST route src CDATA #REQUIRED>
210 <!ATTLIST route dst CDATA #REQUIRED>
211 <!ATTLIST route symmetrical (YES|NO|yes|no) "YES">
212
213 <!ELEMENT ASroute (link_ctn*)>
214 <!ATTLIST ASroute src CDATA #REQUIRED>
215 <!ATTLIST ASroute dst CDATA #REQUIRED>
216 <!ATTLIST ASroute gw_src CDATA #REQUIRED>
217 <!ATTLIST ASroute gw_dst CDATA #REQUIRED>
218 <!ATTLIST ASroute symmetrical (YES|NO|yes|no) "YES">
219
220 <!ELEMENT zoneRoute (link_ctn*)>
221 <!ATTLIST zoneRoute src CDATA #REQUIRED>
222 <!ATTLIST zoneRoute dst CDATA #REQUIRED>
223 <!ATTLIST zoneRoute gw_src CDATA #REQUIRED>
224 <!ATTLIST zoneRoute gw_dst CDATA #REQUIRED>
225 <!ATTLIST zoneRoute symmetrical (YES|NO|yes|no) "YES">
226
227 <!ELEMENT link_ctn EMPTY>
228 <!ATTLIST link_ctn id CDATA #REQUIRED>
229 <!ATTLIST link_ctn direction (UP|DOWN|NONE) "NONE">
230
231 <!ELEMENT bypassRoute (link_ctn*)>
232 <!ATTLIST bypassRoute src CDATA #REQUIRED>
233 <!ATTLIST bypassRoute dst CDATA #REQUIRED>
234
235 <!ELEMENT bypassASroute (link_ctn*)>
236 <!ATTLIST bypassASroute src CDATA #REQUIRED>
237 <!ATTLIST bypassASroute dst CDATA #REQUIRED>
238 <!ATTLIST bypassASroute gw_src CDATA #REQUIRED>
239 <!ATTLIST bypassASroute gw_dst CDATA #REQUIRED>
240
241 <!ELEMENT bypassZoneRoute (link_ctn*)>
242 <!ATTLIST bypassZoneRoute src CDATA #REQUIRED>
243 <!ATTLIST bypassZoneRoute dst CDATA #REQUIRED>
244 <!ATTLIST bypassZoneRoute gw_src CDATA #REQUIRED>
245 <!ATTLIST bypassZoneRoute gw_dst CDATA #REQUIRED>
246
247 <!ELEMENT process ((argument|prop)*)>
248 <!ATTLIST process host CDATA #REQUIRED>
249 <!ATTLIST process function CDATA #REQUIRED>
250 <!ATTLIST process start_time CDATA "-1.0">
251 <!ATTLIST process kill_time CDATA "-1.0">
252 <!ATTLIST process on_failure (DIE|RESTART) "DIE">
253
254 <!ELEMENT actor ((argument|prop)*)>
255 <!ATTLIST actor host CDATA #REQUIRED>
256 <!ATTLIST actor function CDATA #REQUIRED>
257 <!ATTLIST actor start_time CDATA "-1.0">
258 <!ATTLIST actor kill_time CDATA "-1.0">
259 <!ATTLIST actor on_failure (DIE|RESTART) "DIE">
260
261 <!ELEMENT argument EMPTY>
262 <!ATTLIST argument value CDATA #REQUIRED>
263
264 <!ELEMENT config (prop*)>
265 <!ATTLIST config id CDATA "">
266
267 <!ELEMENT prop EMPTY>
268 <!ATTLIST prop id CDATA #REQUIRED> <!-- <!ATTLIST prop key CDATA #REQUIRED> -->
269 <!ATTLIST prop value CDATA #REQUIRED>
270
271 <!ELEMENT model_prop EMPTY>
272 <!ATTLIST model_prop id CDATA #REQUIRED> <!-- <!ATTLIST model_prop key CDATA #REQUIRED> -->
273 <!ATTLIST model_prop value CDATA #REQUIRED>