1 /* Copyright (c) 2006-2023. The SimGrid Team. All rights reserved. */
3 /* This program is free software; you can redistribute it and/or modify it
4 * under the terms of the license (GNU LGPL) which comes with this package. */
6 #include <simgrid/Exception.hpp>
7 #include <simgrid/kernel/routing/NetPoint.hpp>
8 #include <simgrid/s4u/Engine.hpp>
9 #include <simgrid/s4u/Host.hpp>
10 #include <xbt/file.hpp>
11 #include <xbt/parse_units.hpp>
13 #include "src/kernel/resource/LinkImpl.hpp"
14 #include "src/kernel/resource/profile/FutureEvtSet.hpp"
15 #include "src/kernel/resource/profile/Profile.hpp"
16 #include "src/kernel/xml/platf.hpp"
17 #include "src/kernel/xml/platf_private.hpp"
18 #include "src/simgrid/sg_config.hpp"
20 #include <boost/algorithm/string/classification.hpp>
21 #include <boost/algorithm/string/split.hpp>
24 #include <unordered_map>
27 #include "simgrid_dtd.c"
29 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(platf_parse, ker_platform, "Logging specific to the parsing of platform files");
31 std::string simgrid_parsed_filename; // Currently parsed file (for the error messages)
32 static std::vector<simgrid::s4u::LinkInRoute> parsed_link_list; /* temporary store of current link list of a route */
34 static bool fire_on_platform_created_callback;
36 /* Helping functions */
37 void simgrid_parse_assert(bool cond, const std::string& msg)
40 simgrid_parse_error(msg);
43 void simgrid_parse_error(const std::string& msg)
45 throw simgrid::ParseError(simgrid_parsed_filename, simgrid_parse_lineno, msg);
48 void simgrid_parse_assert_netpoint(const std::string& hostname, const std::string& pre, const std::string& post)
50 if (simgrid::s4u::Engine::get_instance()->netpoint_by_name_or_null(hostname) != nullptr) // found
53 std::string msg = pre + hostname + post + " Existing netpoints:\n";
55 std::vector<simgrid::kernel::routing::NetPoint*> netpoints =
56 simgrid::s4u::Engine::get_instance()->get_all_netpoints();
57 std::sort(netpoints.begin(), netpoints.end(),
58 [](const simgrid::kernel::routing::NetPoint* a, const simgrid::kernel::routing::NetPoint* b) {
59 return a->get_name() < b->get_name();
62 for (auto const& np : netpoints) {
69 msg += "'" + np->get_name() + "'";
70 if (msg.length() > 4096) {
71 msg.pop_back(); // remove trailing quote
72 msg += "...(list truncated)......";
76 simgrid_parse_error(msg);
79 double simgrid_parse_get_double(const std::string& s)
83 } catch (const std::invalid_argument&) {
84 simgrid_parse_error(s + " is not a double");
88 int simgrid_parse_get_int(const std::string& s)
92 } catch (const std::invalid_argument&) {
93 simgrid_parse_error(s + " is not an int");
97 /* Turn something like "1-4,6,9-11" into the vector {1,2,3,4,6,9,10,11} */
98 static void explodesRadical(const std::string& radicals, std::vector<int>* exploded)
101 std::vector<std::string> radical_elements;
102 boost::split(radical_elements, radicals, boost::is_any_of(","));
103 for (auto const& group : radical_elements) {
104 std::vector<std::string> radical_ends;
105 boost::split(radical_ends, group, boost::is_any_of("-"));
106 int start = simgrid_parse_get_int(radical_ends.front());
109 switch (radical_ends.size()) {
114 end = simgrid_parse_get_int(radical_ends.back());
117 simgrid_parse_error("Malformed radical: " + group);
119 for (int i = start; i <= end; i++)
120 exploded->push_back(i);
124 /* Trace related stuff */
125 XBT_PRIVATE std::unordered_map<std::string, simgrid::kernel::profile::Profile*>
126 traces_set_list; // shown to sg_platf.cpp
127 static std::unordered_map<std::string, std::string> trace_connect_list_host_avail;
128 static std::unordered_map<std::string, std::string> trace_connect_list_host_speed;
129 static std::unordered_map<std::string, std::string> trace_connect_list_link_avail;
130 static std::unordered_map<std::string, std::string> trace_connect_list_link_bw;
131 static std::unordered_map<std::string, std::string> trace_connect_list_link_lat;
133 static void sg_platf_trace_connect(simgrid::kernel::routing::TraceConnectCreationArgs* trace_connect)
135 simgrid_parse_assert(traces_set_list.find(trace_connect->trace) != traces_set_list.end(),
136 "Cannot connect trace " + trace_connect->trace + " to " + trace_connect->element +
139 switch (trace_connect->kind) {
140 case simgrid::kernel::routing::TraceConnectKind::HOST_AVAIL:
141 trace_connect_list_host_avail.try_emplace(trace_connect->trace, trace_connect->element);
143 case simgrid::kernel::routing::TraceConnectKind::SPEED:
144 trace_connect_list_host_speed.try_emplace(trace_connect->trace, trace_connect->element);
146 case simgrid::kernel::routing::TraceConnectKind::LINK_AVAIL:
147 trace_connect_list_link_avail.try_emplace(trace_connect->trace, trace_connect->element);
149 case simgrid::kernel::routing::TraceConnectKind::BANDWIDTH:
150 trace_connect_list_link_bw.try_emplace(trace_connect->trace, trace_connect->element);
152 case simgrid::kernel::routing::TraceConnectKind::LATENCY:
153 trace_connect_list_link_lat.try_emplace(trace_connect->trace, trace_connect->element);
156 simgrid_parse_error("Cannot connect trace " + trace_connect->trace + " to " + trace_connect->element +
157 ": unknown kind of trace");
162 * All the callback lists that can be overridden anywhere.
163 * (this list should probably be reduced to the bare minimum to allow the models to work)
166 /* make sure these symbols are defined as strong ones in this file so that the linker can resolve them */
168 static std::vector<std::unordered_map<std::string, std::string>> property_sets;
170 static FILE* file_to_parse = nullptr;
172 /* Stuff relative to storage */
173 void STag_simgrid_parse_storage()
175 xbt_die("<storage> tag was removed in SimGrid v3.27. Please stop using it now.");
178 void ETag_simgrid_parse_storage()
180 /* Won't happen since <storage> is now removed since v3.27. */
182 void STag_simgrid_parse_storage___type()
184 xbt_die("<storage_type> tag was removed in SimGrid v3.27. Please stop using it now.");
186 void ETag_simgrid_parse_storage___type()
188 /* Won't happen since <storage_type> is now removed since v3.27. */
191 void STag_simgrid_parse_mount()
193 xbt_die("<mount> tag was removed in SimGrid v3.27. Please stop using it now.");
196 void ETag_simgrid_parse_mount()
198 /* Won't happen since <mount> is now removed since v3.27. */
201 void STag_simgrid_parse_include()
203 xbt_die("<include> tag was removed in SimGrid v3.18. Please stop using it now.");
206 void ETag_simgrid_parse_include()
208 /* Won't happen since <include> is now removed since v3.18. */
211 /* Stag and Etag parse functions */
212 void STag_simgrid_parse_platform()
214 /* Use fixed point arithmetic to avoid rounding errors ("4.1" for example cannot be represented exactly as a floating
216 const long int version = lround(100.0 * simgrid_parse_get_double(A_simgrid_parse_platform_version));
217 const std::string version_string = std::to_string(version / 100) + "." + std::to_string(version % 100);
219 simgrid_parse_assert(version >= 100L, "******* BIG FAT WARNING *********\n "
220 "You're using an ancient XML file.\n"
221 "Since SimGrid 3.1, units are Bytes, Flops, and seconds "
222 "instead of MBytes, MFlops and seconds.\n"
224 "Use simgrid_update_xml to update your file automatically. "
225 "This program is installed automatically with SimGrid, or "
226 "available in the tools/ directory of the source archive.\n"
228 "Please check also out the SURF section of the ChangeLog for "
229 "the 3.1 version for more information.");
230 simgrid_parse_assert(version >= 300L, "******* BIG FAT WARNING *********\n "
231 "You're using an old XML file.\n"
232 "Use simgrid_update_xml to update your file automatically. "
233 "This program is installed automatically with SimGrid, or "
234 "available in the tools/ directory of the source archive.");
235 simgrid_parse_assert(
237 "******* THIS FILE IS TOO OLD (v:" + version_string +
239 "Changes introduced in SimGrid 3.13:\n"
240 " - 'power' attribute of hosts (and others) got renamed to 'speed'.\n"
241 " - In <trace_connect>, attribute kind=\"POWER\" is now kind=\"SPEED\".\n"
242 " - DOCTYPE now point to the rignt URL.\n"
243 " - speed, bandwidth and latency attributes now MUST have an explicit unit (f, Bps, s by default)"
245 "Use simgrid_update_xml to update your file automatically. "
246 "This program is installed automatically with SimGrid, or "
247 "available in the tools/ directory of the source archive.");
248 if (version < 410L) {
249 XBT_INFO("You're using a v%s XML file (%s) while the current standard is v4.1 "
250 "That's fine, the new version is backward compatible. \n\n"
251 "Use simgrid_update_xml to update your file automatically to get rid of this warning. "
252 "This program is installed automatically with SimGrid, or "
253 "available in the tools/ directory of the source archive.",
254 version_string.c_str(), simgrid_parsed_filename.c_str());
256 simgrid_parse_assert(version <= 410L,
257 "******* THIS FILE COMES FROM THE FUTURE (v:" + version_string +
259 "The most recent formalism that this version of SimGrid understands is v4.1.\n"
260 "Please update your code, or use another, more adapted, file.");
262 void ETag_simgrid_parse_platform()
264 if (fire_on_platform_created_callback)
265 simgrid::s4u::Engine::on_platform_created();
268 void STag_simgrid_parse_prop()
270 property_sets.back().try_emplace(A_simgrid_parse_prop_id, A_simgrid_parse_prop_value);
271 XBT_DEBUG("add prop %s=%s into current property set %p", A_simgrid_parse_prop_id, A_simgrid_parse_prop_value,
272 &(property_sets.back()));
275 void STag_simgrid_parse_host()
277 simgrid::kernel::routing::HostCreationArgs host;
278 property_sets.emplace_back();
279 host.id = A_simgrid_parse_host_id;
281 host.speed_per_pstate = xbt_parse_get_all_speeds(simgrid_parsed_filename, simgrid_parse_lineno,
282 A_simgrid_parse_host_speed, "speed of host " + host.id);
284 XBT_DEBUG("pstate: %s", A_simgrid_parse_host_pstate);
285 host.core_amount = simgrid_parse_get_int(A_simgrid_parse_host_core);
287 if (A_simgrid_parse_host_availability___file[0] != '\0') {
288 XBT_WARN("The availability_file attribute in <host> is now deprecated. Please, use 'speed_file' instead.");
289 host.speed_trace = simgrid::kernel::profile::ProfileBuilder::from_file(A_simgrid_parse_host_availability___file);
291 if (A_simgrid_parse_host_speed___file[0] != '\0')
292 host.speed_trace = simgrid::kernel::profile::ProfileBuilder::from_file(A_simgrid_parse_host_speed___file);
293 host.state_trace = A_simgrid_parse_host_state___file[0]
294 ? simgrid::kernel::profile::ProfileBuilder::from_file(A_simgrid_parse_host_state___file)
296 host.coord = A_simgrid_parse_host_coordinates;
298 sg_platf_new_host_begin(&host);
301 void ETag_simgrid_parse_host()
303 sg_platf_new_host_set_properties(property_sets.back());
304 property_sets.pop_back();
306 sg_platf_new_host_seal(simgrid_parse_get_int(A_simgrid_parse_host_pstate));
309 void STag_simgrid_parse_disk()
311 property_sets.emplace_back();
314 void ETag_simgrid_parse_disk()
316 simgrid::kernel::routing::DiskCreationArgs disk;
317 disk.properties = property_sets.back();
318 property_sets.pop_back();
320 disk.id = A_simgrid_parse_disk_id;
321 disk.read_bw = xbt_parse_get_bandwidth(simgrid_parsed_filename, simgrid_parse_lineno, A_simgrid_parse_disk_read___bw,
322 "read_bw of disk " + disk.id);
323 disk.write_bw = xbt_parse_get_bandwidth(simgrid_parsed_filename, simgrid_parse_lineno,
324 A_simgrid_parse_disk_write___bw, "write_bw of disk " + disk.id);
326 sg_platf_new_disk(&disk);
329 void STag_simgrid_parse_host___link()
331 XBT_DEBUG("Create a Host_link for %s", A_simgrid_parse_host___link_id);
332 simgrid::kernel::routing::HostLinkCreationArgs host_link;
334 host_link.id = A_simgrid_parse_host___link_id;
335 host_link.link_up = A_simgrid_parse_host___link_up;
336 host_link.link_down = A_simgrid_parse_host___link_down;
337 sg_platf_new_hostlink(&host_link);
340 void STag_simgrid_parse_router()
342 sg_platf_new_router(A_simgrid_parse_router_id, A_simgrid_parse_router_coordinates);
345 void ETag_simgrid_parse_cluster()
347 simgrid::kernel::routing::ClusterCreationArgs cluster;
348 cluster.properties = property_sets.back();
349 property_sets.pop_back();
351 cluster.id = A_simgrid_parse_cluster_id;
352 cluster.prefix = A_simgrid_parse_cluster_prefix;
353 cluster.suffix = A_simgrid_parse_cluster_suffix;
354 explodesRadical(A_simgrid_parse_cluster_radical, &cluster.radicals);
356 cluster.speeds = xbt_parse_get_all_speeds(simgrid_parsed_filename, simgrid_parse_lineno,
357 A_simgrid_parse_cluster_speed, "speed of cluster " + cluster.id);
358 cluster.core_amount = simgrid_parse_get_int(A_simgrid_parse_cluster_core);
359 cluster.bw = xbt_parse_get_bandwidth(simgrid_parsed_filename, simgrid_parse_lineno, A_simgrid_parse_cluster_bw,
360 "bw of cluster " + cluster.id);
361 cluster.lat = xbt_parse_get_time(simgrid_parsed_filename, simgrid_parse_lineno, A_simgrid_parse_cluster_lat,
362 "lat of cluster " + cluster.id);
363 if (strcmp(A_simgrid_parse_cluster_bb___bw, ""))
364 cluster.bb_bw = xbt_parse_get_bandwidth(simgrid_parsed_filename, simgrid_parse_lineno,
365 A_simgrid_parse_cluster_bb___bw, "bb_bw of cluster " + cluster.id);
366 if (strcmp(A_simgrid_parse_cluster_bb___lat, ""))
367 cluster.bb_lat = xbt_parse_get_time(simgrid_parsed_filename, simgrid_parse_lineno, A_simgrid_parse_cluster_bb___lat,
368 "bb_lat of cluster " + cluster.id);
369 if (strcmp(A_simgrid_parse_cluster_limiter___link, ""))
370 cluster.limiter_link =
371 xbt_parse_get_bandwidth(simgrid_parsed_filename, simgrid_parse_lineno, A_simgrid_parse_cluster_limiter___link,
372 "limiter_link of cluster " + cluster.id);
373 if (strcmp(A_simgrid_parse_cluster_loopback___bw, ""))
374 cluster.loopback_bw =
375 xbt_parse_get_bandwidth(simgrid_parsed_filename, simgrid_parse_lineno, A_simgrid_parse_cluster_loopback___bw,
376 "loopback_bw of cluster " + cluster.id);
377 if (strcmp(A_simgrid_parse_cluster_loopback___lat, ""))
378 cluster.loopback_lat =
379 xbt_parse_get_time(simgrid_parsed_filename, simgrid_parse_lineno, A_simgrid_parse_cluster_loopback___lat,
380 "loopback_lat of cluster " + cluster.id);
382 switch (AX_simgrid_parse_cluster_topology) {
383 case A_simgrid_parse_cluster_topology_FLAT:
384 cluster.topology = simgrid::kernel::routing::ClusterTopology::FLAT;
386 case A_simgrid_parse_cluster_topology_TORUS:
387 cluster.topology = simgrid::kernel::routing::ClusterTopology::TORUS;
389 case A_simgrid_parse_cluster_topology_FAT___TREE:
390 cluster.topology = simgrid::kernel::routing::ClusterTopology::FAT_TREE;
392 case A_simgrid_parse_cluster_topology_DRAGONFLY:
393 cluster.topology = simgrid::kernel::routing::ClusterTopology::DRAGONFLY;
396 simgrid_parse_error("Invalid cluster topology for cluster " + cluster.id);
398 cluster.topo_parameters = A_simgrid_parse_cluster_topo___parameters;
399 cluster.router_id = A_simgrid_parse_cluster_router___id;
401 switch (AX_simgrid_parse_cluster_sharing___policy) {
402 case A_simgrid_parse_cluster_sharing___policy_SHARED:
403 cluster.sharing_policy = simgrid::s4u::Link::SharingPolicy::SHARED;
405 case A_simgrid_parse_cluster_sharing___policy_FULLDUPLEX:
406 XBT_WARN("FULLDUPLEX is now deprecated. Please update your platform file to use SPLITDUPLEX instead.");
407 cluster.sharing_policy = simgrid::s4u::Link::SharingPolicy::SPLITDUPLEX;
409 case A_simgrid_parse_cluster_sharing___policy_SPLITDUPLEX:
410 cluster.sharing_policy = simgrid::s4u::Link::SharingPolicy::SPLITDUPLEX;
412 case A_simgrid_parse_cluster_sharing___policy_FATPIPE:
413 cluster.sharing_policy = simgrid::s4u::Link::SharingPolicy::FATPIPE;
416 simgrid_parse_error("Invalid cluster sharing policy for cluster " + cluster.id);
418 switch (AX_simgrid_parse_cluster_bb___sharing___policy) {
419 case A_simgrid_parse_cluster_bb___sharing___policy_FATPIPE:
420 cluster.bb_sharing_policy = simgrid::s4u::Link::SharingPolicy::FATPIPE;
422 case A_simgrid_parse_cluster_bb___sharing___policy_SHARED:
423 cluster.bb_sharing_policy = simgrid::s4u::Link::SharingPolicy::SHARED;
426 simgrid_parse_error("Invalid bb sharing policy in cluster " + cluster.id);
429 sg_platf_new_tag_cluster(&cluster);
432 void STag_simgrid_parse_cluster()
434 property_sets.emplace_back();
437 void STag_simgrid_parse_cabinet()
439 simgrid::kernel::routing::CabinetCreationArgs cabinet;
440 cabinet.id = A_simgrid_parse_cabinet_id;
441 cabinet.prefix = A_simgrid_parse_cabinet_prefix;
442 cabinet.suffix = A_simgrid_parse_cabinet_suffix;
443 cabinet.speed = xbt_parse_get_speed(simgrid_parsed_filename, simgrid_parse_lineno, A_simgrid_parse_cabinet_speed,
444 "speed of cabinet " + cabinet.id);
445 cabinet.bw = xbt_parse_get_bandwidth(simgrid_parsed_filename, simgrid_parse_lineno, A_simgrid_parse_cabinet_bw,
446 "bw of cabinet " + cabinet.id);
447 cabinet.lat = xbt_parse_get_time(simgrid_parsed_filename, simgrid_parse_lineno, A_simgrid_parse_cabinet_lat,
448 "lat of cabinet " + cabinet.id);
449 explodesRadical(A_simgrid_parse_cabinet_radical, &cabinet.radicals);
451 sg_platf_new_cabinet(&cabinet);
454 void STag_simgrid_parse_peer()
456 simgrid::kernel::routing::PeerCreationArgs peer;
458 peer.id = A_simgrid_parse_peer_id;
459 peer.speed = xbt_parse_get_speed(simgrid_parsed_filename, simgrid_parse_lineno, A_simgrid_parse_peer_speed,
460 "speed of peer " + peer.id);
461 peer.bw_in = xbt_parse_get_bandwidth(simgrid_parsed_filename, simgrid_parse_lineno, A_simgrid_parse_peer_bw___in,
462 "bw_in of peer " + peer.id);
463 peer.bw_out = xbt_parse_get_bandwidth(simgrid_parsed_filename, simgrid_parse_lineno, A_simgrid_parse_peer_bw___out,
464 "bw_out of peer " + peer.id);
465 peer.coord = A_simgrid_parse_peer_coordinates;
466 peer.speed_trace = nullptr;
467 if (A_simgrid_parse_peer_availability___file[0] != '\0') {
468 XBT_WARN("The availability_file attribute in <peer> is now deprecated. Please, use 'speed_file' instead.");
469 peer.speed_trace = simgrid::kernel::profile::ProfileBuilder::from_file(A_simgrid_parse_peer_availability___file);
471 if (A_simgrid_parse_peer_speed___file[0] != '\0')
472 peer.speed_trace = simgrid::kernel::profile::ProfileBuilder::from_file(A_simgrid_parse_peer_speed___file);
473 peer.state_trace = A_simgrid_parse_peer_state___file[0]
474 ? simgrid::kernel::profile::ProfileBuilder::from_file(A_simgrid_parse_peer_state___file)
477 if (A_simgrid_parse_peer_lat[0] != '\0')
478 XBT_WARN("The latency attribute in <peer> is now deprecated. Use the z coordinate instead of '%s'.",
479 A_simgrid_parse_peer_lat);
481 sg_platf_new_peer(&peer);
484 void STag_simgrid_parse_link()
486 property_sets.emplace_back();
489 void ETag_simgrid_parse_link()
491 simgrid::kernel::routing::LinkCreationArgs link;
493 link.properties = property_sets.back();
494 property_sets.pop_back();
496 link.id = A_simgrid_parse_link_id;
497 link.bandwidths = xbt_parse_get_bandwidths(simgrid_parsed_filename, simgrid_parse_lineno,
498 A_simgrid_parse_link_bandwidth, "bandwidth of link " + link.id);
499 link.bandwidth_trace =
500 A_simgrid_parse_link_bandwidth___file[0]
501 ? simgrid::kernel::profile::ProfileBuilder::from_file(A_simgrid_parse_link_bandwidth___file)
503 link.latency = xbt_parse_get_time(simgrid_parsed_filename, simgrid_parse_lineno, A_simgrid_parse_link_latency,
504 "latency of link " + link.id);
505 link.latency_trace = A_simgrid_parse_link_latency___file[0]
506 ? simgrid::kernel::profile::ProfileBuilder::from_file(A_simgrid_parse_link_latency___file)
508 link.state_trace = A_simgrid_parse_link_state___file[0]
509 ? simgrid::kernel::profile::ProfileBuilder::from_file(A_simgrid_parse_link_state___file)
512 switch (A_simgrid_parse_link_sharing___policy) {
513 case A_simgrid_parse_link_sharing___policy_SHARED:
514 link.policy = simgrid::s4u::Link::SharingPolicy::SHARED;
516 case A_simgrid_parse_link_sharing___policy_FATPIPE:
517 link.policy = simgrid::s4u::Link::SharingPolicy::FATPIPE;
519 case A_simgrid_parse_link_sharing___policy_FULLDUPLEX:
520 XBT_WARN("FULLDUPLEX is now deprecated. Please update your platform file to use SPLITDUPLEX instead.");
521 link.policy = simgrid::s4u::Link::SharingPolicy::SPLITDUPLEX;
523 case A_simgrid_parse_link_sharing___policy_SPLITDUPLEX:
524 link.policy = simgrid::s4u::Link::SharingPolicy::SPLITDUPLEX;
526 case A_simgrid_parse_link_sharing___policy_WIFI:
527 link.policy = simgrid::s4u::Link::SharingPolicy::WIFI;
530 simgrid_parse_error("Invalid sharing policy in link " + link.id);
533 sg_platf_new_link(&link);
536 void STag_simgrid_parse_link___ctn()
538 const auto engine = simgrid::s4u::Engine::get_instance();
539 const simgrid::s4u::Link* link;
540 simgrid::s4u::LinkInRoute::Direction direction = simgrid::s4u::LinkInRoute::Direction::NONE;
541 switch (A_simgrid_parse_link___ctn_direction) {
542 case AU_simgrid_parse_link___ctn_direction:
543 case A_simgrid_parse_link___ctn_direction_NONE:
544 link = engine->link_by_name(A_simgrid_parse_link___ctn_id);
546 case A_simgrid_parse_link___ctn_direction_UP:
547 link = engine->split_duplex_link_by_name(A_simgrid_parse_link___ctn_id);
548 direction = simgrid::s4u::LinkInRoute::Direction::UP;
550 case A_simgrid_parse_link___ctn_direction_DOWN:
551 link = engine->split_duplex_link_by_name(A_simgrid_parse_link___ctn_id);
552 direction = simgrid::s4u::LinkInRoute::Direction::DOWN;
555 simgrid_parse_error(std::string("Invalid direction for link ") + A_simgrid_parse_link___ctn_id);
559 switch (A_simgrid_parse_link___ctn_direction) {
560 case A_simgrid_parse_link___ctn_direction_UP:
561 dirname = " (upward)";
563 case A_simgrid_parse_link___ctn_direction_DOWN:
564 dirname = " (downward)";
569 simgrid_parse_assert(link != nullptr, std::string("No such link: '") + A_simgrid_parse_link___ctn_id + "'" + dirname);
570 parsed_link_list.emplace_back(link, direction);
573 void ETag_simgrid_parse_backbone()
575 auto link = std::make_unique<simgrid::kernel::routing::LinkCreationArgs>();
577 link->id = A_simgrid_parse_backbone_id;
578 link->bandwidths.push_back(xbt_parse_get_bandwidth(simgrid_parsed_filename, simgrid_parse_lineno,
579 A_simgrid_parse_backbone_bandwidth,
580 "bandwidth of backbone " + link->id));
581 link->latency = xbt_parse_get_time(simgrid_parsed_filename, simgrid_parse_lineno, A_simgrid_parse_backbone_latency,
582 "latency of backbone " + link->id);
583 link->policy = simgrid::s4u::Link::SharingPolicy::SHARED;
585 routing_cluster_add_backbone(std::move(link));
588 void STag_simgrid_parse_route()
590 simgrid_parse_assert_netpoint(A_simgrid_parse_route_src, "Route src='", "' does name a node.");
591 simgrid_parse_assert_netpoint(A_simgrid_parse_route_dst, "Route dst='", "' does name a node.");
594 void STag_simgrid_parse_ASroute()
596 simgrid_parse_assert_netpoint(A_simgrid_parse_ASroute_src, "ASroute src='", "' does name a node.");
597 simgrid_parse_assert_netpoint(A_simgrid_parse_ASroute_dst, "ASroute dst='", "' does name a node.");
599 simgrid_parse_assert_netpoint(A_simgrid_parse_ASroute_gw___src, "ASroute gw_src='", "' does name a node.");
600 simgrid_parse_assert_netpoint(A_simgrid_parse_ASroute_gw___dst, "ASroute gw_dst='", "' does name a node.");
602 void STag_simgrid_parse_zoneRoute()
604 simgrid_parse_assert_netpoint(A_simgrid_parse_zoneRoute_src, "zoneRoute src='", "' does name a node.");
605 simgrid_parse_assert_netpoint(A_simgrid_parse_zoneRoute_dst, "zoneRoute dst='", "' does name a node.");
606 simgrid_parse_assert_netpoint(A_simgrid_parse_zoneRoute_gw___src, "zoneRoute gw_src='", "' does name a node.");
607 simgrid_parse_assert_netpoint(A_simgrid_parse_zoneRoute_gw___dst, "zoneRoute gw_dst='", "' does name a node.");
610 void STag_simgrid_parse_bypassRoute()
612 simgrid_parse_assert_netpoint(A_simgrid_parse_bypassRoute_src, "bypassRoute src='", "' does name a node.");
613 simgrid_parse_assert_netpoint(A_simgrid_parse_bypassRoute_dst, "bypassRoute dst='", "' does name a node.");
616 void STag_simgrid_parse_bypassASroute()
618 simgrid_parse_assert_netpoint(A_simgrid_parse_bypassASroute_src, "bypassASroute src='", "' does name a node.");
619 simgrid_parse_assert_netpoint(A_simgrid_parse_bypassASroute_dst, "bypassASroute dst='", "' does name a node.");
620 simgrid_parse_assert_netpoint(A_simgrid_parse_bypassASroute_gw___src, "bypassASroute gw_src='",
621 "' does name a node.");
622 simgrid_parse_assert_netpoint(A_simgrid_parse_bypassASroute_gw___dst, "bypassASroute gw_dst='",
623 "' does name a node.");
625 void STag_simgrid_parse_bypassZoneRoute()
627 simgrid_parse_assert_netpoint(A_simgrid_parse_bypassZoneRoute_src, "bypassZoneRoute src='", "' does name a node.");
628 simgrid_parse_assert_netpoint(A_simgrid_parse_bypassZoneRoute_dst, "bypassZoneRoute dst='", "' does name a node.");
629 simgrid_parse_assert_netpoint(A_simgrid_parse_bypassZoneRoute_gw___src, "bypassZoneRoute gw_src='",
630 "' does name a node.");
631 simgrid_parse_assert_netpoint(A_simgrid_parse_bypassZoneRoute_gw___dst, "bypassZoneRoute gw_dst='",
632 "' does name a node.");
635 void ETag_simgrid_parse_route()
637 simgrid::kernel::routing::RouteCreationArgs route;
639 route.src = sg_netpoint_by_name_or_null(A_simgrid_parse_route_src); // tested to not be nullptr in start tag
640 route.dst = sg_netpoint_by_name_or_null(A_simgrid_parse_route_dst); // tested to not be nullptr in start tag
641 route.symmetrical = (A_simgrid_parse_route_symmetrical == AU_simgrid_parse_route_symmetrical ||
642 A_simgrid_parse_route_symmetrical == A_simgrid_parse_route_symmetrical_YES ||
643 A_simgrid_parse_route_symmetrical == A_simgrid_parse_route_symmetrical_yes);
645 route.link_list.swap(parsed_link_list);
647 sg_platf_new_route(&route);
650 void ETag_simgrid_parse_ASroute()
652 AX_simgrid_parse_zoneRoute_src = AX_simgrid_parse_ASroute_src;
653 AX_simgrid_parse_zoneRoute_dst = AX_simgrid_parse_ASroute_dst;
654 AX_simgrid_parse_zoneRoute_gw___src = AX_simgrid_parse_ASroute_gw___src;
655 AX_simgrid_parse_zoneRoute_gw___dst = AX_simgrid_parse_ASroute_gw___dst;
656 AX_simgrid_parse_zoneRoute_symmetrical = (AT_simgrid_parse_zoneRoute_symmetrical)AX_simgrid_parse_ASroute_symmetrical;
657 ETag_simgrid_parse_zoneRoute();
659 void ETag_simgrid_parse_zoneRoute()
661 simgrid::kernel::routing::RouteCreationArgs ASroute;
663 ASroute.src = sg_netpoint_by_name_or_null(A_simgrid_parse_zoneRoute_src); // tested to not be nullptr in start tag
664 ASroute.dst = sg_netpoint_by_name_or_null(A_simgrid_parse_zoneRoute_dst); // tested to not be nullptr in start tag
667 sg_netpoint_by_name_or_null(A_simgrid_parse_zoneRoute_gw___src); // tested to not be nullptr in start tag
669 sg_netpoint_by_name_or_null(A_simgrid_parse_zoneRoute_gw___dst); // tested to not be nullptr in start tag
671 ASroute.link_list.swap(parsed_link_list);
673 ASroute.symmetrical = (A_simgrid_parse_zoneRoute_symmetrical == AU_simgrid_parse_zoneRoute_symmetrical ||
674 A_simgrid_parse_zoneRoute_symmetrical == A_simgrid_parse_zoneRoute_symmetrical_YES ||
675 A_simgrid_parse_zoneRoute_symmetrical == A_simgrid_parse_zoneRoute_symmetrical_yes);
677 sg_platf_new_route(&ASroute);
680 void ETag_simgrid_parse_bypassRoute()
682 simgrid::kernel::routing::RouteCreationArgs route;
684 route.src = sg_netpoint_by_name_or_null(A_simgrid_parse_bypassRoute_src); // tested to not be nullptr in start tag
685 route.dst = sg_netpoint_by_name_or_null(A_simgrid_parse_bypassRoute_dst); // tested to not be nullptr in start tag
686 route.symmetrical = false;
688 route.link_list.swap(parsed_link_list);
690 sg_platf_new_bypass_route(&route);
693 void ETag_simgrid_parse_bypassASroute()
695 AX_simgrid_parse_bypassZoneRoute_src = AX_simgrid_parse_bypassASroute_src;
696 AX_simgrid_parse_bypassZoneRoute_dst = AX_simgrid_parse_bypassASroute_dst;
697 AX_simgrid_parse_bypassZoneRoute_gw___src = AX_simgrid_parse_bypassASroute_gw___src;
698 AX_simgrid_parse_bypassZoneRoute_gw___dst = AX_simgrid_parse_bypassASroute_gw___dst;
699 ETag_simgrid_parse_bypassZoneRoute();
701 void ETag_simgrid_parse_bypassZoneRoute()
703 simgrid::kernel::routing::RouteCreationArgs ASroute;
705 ASroute.src = sg_netpoint_by_name_or_null(A_simgrid_parse_bypassZoneRoute_src);
706 ASroute.dst = sg_netpoint_by_name_or_null(A_simgrid_parse_bypassZoneRoute_dst);
707 ASroute.link_list.swap(parsed_link_list);
709 ASroute.symmetrical = false;
711 ASroute.gw_src = sg_netpoint_by_name_or_null(A_simgrid_parse_bypassZoneRoute_gw___src);
712 ASroute.gw_dst = sg_netpoint_by_name_or_null(A_simgrid_parse_bypassZoneRoute_gw___dst);
714 sg_platf_new_bypass_route(&ASroute);
717 void ETag_simgrid_parse_trace()
719 simgrid::kernel::routing::ProfileCreationArgs trace;
721 trace.id = A_simgrid_parse_trace_id;
722 trace.file = A_simgrid_parse_trace_file;
723 trace.periodicity = simgrid_parse_get_double(A_simgrid_parse_trace_periodicity);
724 trace.pc_data = simgrid_parse_pcdata;
726 sg_platf_new_trace(&trace);
729 void STag_simgrid_parse_trace___connect()
731 simgrid::kernel::routing::TraceConnectCreationArgs trace_connect;
733 trace_connect.element = A_simgrid_parse_trace___connect_element;
734 trace_connect.trace = A_simgrid_parse_trace___connect_trace;
736 switch (A_simgrid_parse_trace___connect_kind) {
737 case AU_simgrid_parse_trace___connect_kind:
738 case A_simgrid_parse_trace___connect_kind_SPEED:
739 trace_connect.kind = simgrid::kernel::routing::TraceConnectKind::SPEED;
741 case A_simgrid_parse_trace___connect_kind_BANDWIDTH:
742 trace_connect.kind = simgrid::kernel::routing::TraceConnectKind::BANDWIDTH;
744 case A_simgrid_parse_trace___connect_kind_HOST___AVAIL:
745 trace_connect.kind = simgrid::kernel::routing::TraceConnectKind::HOST_AVAIL;
747 case A_simgrid_parse_trace___connect_kind_LATENCY:
748 trace_connect.kind = simgrid::kernel::routing::TraceConnectKind::LATENCY;
750 case A_simgrid_parse_trace___connect_kind_LINK___AVAIL:
751 trace_connect.kind = simgrid::kernel::routing::TraceConnectKind::LINK_AVAIL;
754 simgrid_parse_error("Invalid trace kind");
756 sg_platf_trace_connect(&trace_connect);
759 void STag_simgrid_parse_AS()
761 AX_simgrid_parse_zone_id = AX_simgrid_parse_AS_id;
762 AX_simgrid_parse_zone_routing = AX_simgrid_parse_AS_routing;
763 STag_simgrid_parse_zone();
766 void ETag_simgrid_parse_AS()
768 ETag_simgrid_parse_zone();
771 void STag_simgrid_parse_zone()
773 property_sets.emplace_back();
774 simgrid::kernel::routing::ZoneCreationArgs zone;
775 zone.id = A_simgrid_parse_zone_id;
776 zone.routing = A_simgrid_parse_zone_routing;
777 sg_platf_new_zone_begin(&zone);
780 void ETag_simgrid_parse_zone()
782 sg_platf_new_zone_set_properties(property_sets.back());
783 property_sets.pop_back();
784 sg_platf_new_zone_seal();
787 void STag_simgrid_parse_config()
789 property_sets.emplace_back();
790 XBT_DEBUG("START configuration name = %s", A_simgrid_parse_config_id);
791 if (_sg_cfg_init_status == 2) {
793 "All <config> tags must be given before any platform elements (such as <zone>, <host>, <cluster>, "
798 void ETag_simgrid_parse_config()
800 // Sort config elements before applying.
801 // That's a little waste of time, but not doing so would break the tests
802 auto current_property_set = property_sets.back();
804 std::vector<std::string> keys;
805 for (auto const& [key, _] : current_property_set) {
808 std::sort(keys.begin(), keys.end());
809 for (const std::string& key : keys) {
810 if (simgrid::config::is_default(key.c_str())) {
811 std::string cfg = key + ":" + current_property_set.at(key);
812 simgrid::config::set_parse(cfg);
814 XBT_INFO("The custom configuration '%s' is already defined by user!", key.c_str());
816 XBT_DEBUG("End configuration name = %s", A_simgrid_parse_config_id);
818 property_sets.pop_back();
821 static std::vector<std::string> arguments;
823 void STag_simgrid_parse_process()
825 AX_simgrid_parse_actor_function = AX_simgrid_parse_process_function;
826 STag_simgrid_parse_actor();
829 void STag_simgrid_parse_actor()
831 property_sets.emplace_back();
832 arguments.assign(1, A_simgrid_parse_actor_function);
835 void ETag_simgrid_parse_process()
837 AX_simgrid_parse_actor_host = AX_simgrid_parse_process_host;
838 AX_simgrid_parse_actor_function = AX_simgrid_parse_process_function;
839 AX_simgrid_parse_actor_start___time = AX_simgrid_parse_process_start___time;
840 AX_simgrid_parse_actor_kill___time = AX_simgrid_parse_process_kill___time;
841 AX_simgrid_parse_actor_on___failure = (AT_simgrid_parse_actor_on___failure)AX_simgrid_parse_process_on___failure;
842 ETag_simgrid_parse_actor();
845 void ETag_simgrid_parse_actor()
847 simgrid::kernel::routing::ActorCreationArgs actor;
849 actor.properties = property_sets.back();
850 property_sets.pop_back();
852 actor.args.swap(arguments);
853 actor.host = A_simgrid_parse_actor_host;
854 actor.function = A_simgrid_parse_actor_function;
855 actor.start_time = simgrid_parse_get_double(A_simgrid_parse_actor_start___time);
856 actor.kill_time = simgrid_parse_get_double(A_simgrid_parse_actor_kill___time);
858 switch (A_simgrid_parse_actor_on___failure) {
859 case AU_simgrid_parse_actor_on___failure:
860 case A_simgrid_parse_actor_on___failure_DIE:
861 actor.restart_on_failure = false;
863 case A_simgrid_parse_actor_on___failure_RESTART:
864 actor.restart_on_failure = true;
867 simgrid_parse_error("Invalid on failure behavior");
870 sg_platf_new_actor(&actor);
873 void STag_simgrid_parse_argument()
875 arguments.emplace_back(A_simgrid_parse_argument_value);
878 void STag_simgrid_parse_model___prop()
880 XBT_INFO("Deprecated tag <model_prop> ignored");
883 void ETag_simgrid_parse_prop()
884 { /* Nothing to do */
886 void STag_simgrid_parse_random()
887 { /* Nothing to do */
889 void ETag_simgrid_parse_random()
890 { /* Nothing to do */
892 void ETag_simgrid_parse_trace___connect()
893 { /* Nothing to do */
895 void STag_simgrid_parse_trace()
896 { /* Nothing to do */
898 void ETag_simgrid_parse_router()
901 void ETag_simgrid_parse_host___link()
902 { /* Nothing to do */
904 void ETag_simgrid_parse_cabinet()
905 { /* Nothing to do */
907 void ETag_simgrid_parse_peer()
908 { /* Nothing to do */
910 void STag_simgrid_parse_backbone()
911 { /* Nothing to do */
913 void ETag_simgrid_parse_link___ctn()
914 { /* Nothing to do */
916 void ETag_simgrid_parse_argument()
917 { /* Nothing to do */
919 void ETag_simgrid_parse_model___prop()
920 { /* Nothing to do */
923 /* Open and Close parse file */
924 static YY_BUFFER_STATE input_buffer;
926 void simgrid_parse_open(const std::string& file)
928 simgrid_parsed_filename = file;
929 std::string dir = simgrid::xbt::Path(file).get_dir_name();
930 simgrid::xbt::path_push(dir);
932 file_to_parse = simgrid::xbt::path_fopen(file, "r");
933 if (file_to_parse == nullptr)
934 throw std::invalid_argument("Unable to open '" + file + "' from '" + simgrid::xbt::Path().get_name() +
935 "'. Does this file exist?");
936 input_buffer = simgrid_parse__create_buffer(file_to_parse, YY_BUF_SIZE);
937 simgrid_parse__switch_to_buffer(input_buffer);
938 simgrid_parse_lineno = 1;
941 void simgrid_parse_close()
943 simgrid::xbt::path_pop(); // remove the dirname of the opened file, that was added in simgrid_parse_open()
946 simgrid_parse__delete_buffer(input_buffer);
947 fclose(file_to_parse);
948 file_to_parse = nullptr; // Must be reset for Bypass
952 /* Call the lexer to parse the currently opened file */
953 void simgrid_parse(bool fire_on_platform_created_callback_param)
955 fire_on_platform_created_callback = fire_on_platform_created_callback_param;
956 bool err = simgrid_parse_lex();
957 simgrid_parse_assert(not err, "Flex returned an error code");
959 /* Actually connect the traces now that every elements are created */
960 const auto engine = simgrid::s4u::Engine::get_instance();
962 for (auto const& [trace, name] : trace_connect_list_host_avail) {
963 simgrid_parse_assert(traces_set_list.find(trace) != traces_set_list.end(),
964 "<trace_connect kind=\"HOST_AVAIL\">: Trace " + trace + " undefined.");
965 auto profile = traces_set_list.at(trace);
967 auto host = engine->host_by_name_or_null(name);
968 simgrid_parse_assert(host, "<trace_connect kind=\"HOST_AVAIL\">: Host " + name + " undefined.");
969 host->set_state_profile(profile);
971 trace_connect_list_host_avail.clear();
973 for (auto const& [trace, name] : trace_connect_list_host_speed) {
974 simgrid_parse_assert(traces_set_list.find(trace) != traces_set_list.end(),
975 "<trace_connect kind=\"SPEED\">: Trace " + trace + " undefined.");
976 auto profile = traces_set_list.at(trace);
978 auto host = engine->host_by_name_or_null(name);
979 simgrid_parse_assert(host, "<trace_connect kind=\"SPEED\">: Host " + name + " undefined.");
980 host->set_speed_profile(profile);
982 trace_connect_list_host_speed.clear();
984 for (auto const& [trace, name] : trace_connect_list_link_avail) {
985 simgrid_parse_assert(traces_set_list.find(trace) != traces_set_list.end(),
986 "<trace_connect kind=\"LINK_AVAIL\">: Trace " + trace + " undefined.");
987 auto profile = traces_set_list.at(trace);
989 auto link = engine->link_by_name_or_null(name);
990 simgrid_parse_assert(link, "<trace_connect kind=\"LINK_AVAIL\">: Link " + name + " undefined.");
991 link->set_state_profile(profile);
993 trace_connect_list_link_avail.clear();
995 for (auto const& [trace, name] : trace_connect_list_link_bw) {
996 simgrid_parse_assert(traces_set_list.find(trace) != traces_set_list.end(),
997 "<trace_connect kind=\"BANDWIDTH\">: Trace " + trace + " undefined.");
998 auto profile = traces_set_list.at(trace);
1000 auto link = engine->link_by_name_or_null(name);
1001 simgrid_parse_assert(link, "<trace_connect kind=\"BANDWIDTH\">: Link " + name + " undefined.");
1002 link->set_bandwidth_profile(profile);
1004 trace_connect_list_link_bw.clear();
1006 for (auto const& [trace, name] : trace_connect_list_link_lat) {
1007 simgrid_parse_assert(traces_set_list.find(trace) != traces_set_list.end(),
1008 "<trace_connect kind=\"LATENCY\">: Trace " + trace + " undefined.");
1009 auto profile = traces_set_list.at(trace);
1011 auto link = engine->link_by_name_or_null(name);
1012 simgrid_parse_assert(link, "<trace_connect kind=\"LATENCY\">: Link " + name + " undefined.");
1013 link->set_latency_profile(profile);
1015 trace_connect_list_link_lat.clear();