Logo AND Algorithmique Numérique Distribuée

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