Logo AND Algorithmique Numérique Distribuée

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