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/Disk.hpp>
9 #include <simgrid/s4u/Engine.hpp>
10 #include <simgrid/s4u/Host.hpp>
11 #include <xbt/file.hpp>
12 #include <xbt/parse_units.hpp>
14 #include "src/kernel/resource/LinkImpl.hpp"
15 #include "src/kernel/resource/profile/FutureEvtSet.hpp"
16 #include "src/kernel/resource/profile/Profile.hpp"
17 #include "src/kernel/xml/platf.hpp"
18 #include "src/kernel/xml/platf_private.hpp"
19 #include "src/simgrid/sg_config.hpp"
21 #include <boost/algorithm/string/classification.hpp>
22 #include <boost/algorithm/string/split.hpp>
25 #include <unordered_map>
28 #include "simgrid_dtd.c"
30 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(platf_parse, ker_platform, "Logging specific to the parsing of platform files");
32 std::string simgrid_parsed_filename; // Currently parsed file (for the error messages)
33 static std::vector<simgrid::s4u::LinkInRoute> parsed_link_list; /* temporary store of current link list of a route */
35 static bool fire_on_platform_created_callback;
37 /* Helping functions */
38 void simgrid_parse_assert(bool cond, const std::string& msg)
41 simgrid_parse_error(msg);
44 void simgrid_parse_error(const std::string& msg)
46 throw simgrid::ParseError(simgrid_parsed_filename, simgrid_parse_lineno, msg);
49 void simgrid_parse_assert_netpoint(const std::string& hostname, const std::string& pre, const std::string& post)
51 if (simgrid::s4u::Engine::get_instance()->netpoint_by_name_or_null(hostname) != nullptr) // found
54 std::string msg = pre + hostname + post + " Existing netpoints:\n";
56 std::vector<simgrid::kernel::routing::NetPoint*> netpoints =
57 simgrid::s4u::Engine::get_instance()->get_all_netpoints();
58 std::sort(netpoints.begin(), netpoints.end(),
59 [](const simgrid::kernel::routing::NetPoint* a, const simgrid::kernel::routing::NetPoint* b) {
60 return a->get_name() < b->get_name();
63 for (auto const& np : netpoints) {
70 msg += "'" + np->get_name() + "'";
71 if (msg.length() > 4096) {
72 msg.pop_back(); // remove trailing quote
73 msg += "...(list truncated)......";
77 simgrid_parse_error(msg);
80 double simgrid_parse_get_double(const std::string& s)
84 } catch (const std::invalid_argument&) {
85 simgrid_parse_error(s + " is not a double");
89 int simgrid_parse_get_int(const std::string& s)
93 } catch (const std::invalid_argument&) {
94 simgrid_parse_error(s + " is not an int");
98 /* Turn something like "1-4,6,9-11" into the vector {1,2,3,4,6,9,10,11} */
99 static void explodesRadical(const std::string& radicals, std::vector<int>* exploded)
102 std::vector<std::string> radical_elements;
103 boost::split(radical_elements, radicals, boost::is_any_of(","));
104 for (auto const& group : radical_elements) {
105 std::vector<std::string> radical_ends;
106 boost::split(radical_ends, group, boost::is_any_of("-"));
107 int start = simgrid_parse_get_int(radical_ends.front());
110 switch (radical_ends.size()) {
115 end = simgrid_parse_get_int(radical_ends.back());
118 simgrid_parse_error("Malformed radical: " + group);
120 for (int i = start; i <= end; i++)
121 exploded->push_back(i);
125 /* Trace related stuff */
126 XBT_PRIVATE std::unordered_map<std::string, simgrid::kernel::profile::Profile*>
127 traces_set_list; // shown to sg_platf.cpp
128 static std::unordered_map<std::string, std::string> trace_connect_list_host_avail;
129 static std::unordered_map<std::string, std::string> trace_connect_list_host_speed;
130 static std::unordered_map<std::string, std::string> trace_connect_list_link_avail;
131 static std::unordered_map<std::string, std::string> trace_connect_list_link_bw;
132 static std::unordered_map<std::string, std::string> trace_connect_list_link_lat;
134 static void sg_platf_trace_connect(simgrid::kernel::routing::TraceConnectCreationArgs* trace_connect)
136 simgrid_parse_assert(traces_set_list.find(trace_connect->trace) != traces_set_list.end(),
137 "Cannot connect trace " + trace_connect->trace + " to " + trace_connect->element +
140 switch (trace_connect->kind) {
141 case simgrid::kernel::routing::TraceConnectKind::HOST_AVAIL:
142 trace_connect_list_host_avail.try_emplace(trace_connect->trace, trace_connect->element);
144 case simgrid::kernel::routing::TraceConnectKind::SPEED:
145 trace_connect_list_host_speed.try_emplace(trace_connect->trace, trace_connect->element);
147 case simgrid::kernel::routing::TraceConnectKind::LINK_AVAIL:
148 trace_connect_list_link_avail.try_emplace(trace_connect->trace, trace_connect->element);
150 case simgrid::kernel::routing::TraceConnectKind::BANDWIDTH:
151 trace_connect_list_link_bw.try_emplace(trace_connect->trace, trace_connect->element);
153 case simgrid::kernel::routing::TraceConnectKind::LATENCY:
154 trace_connect_list_link_lat.try_emplace(trace_connect->trace, trace_connect->element);
157 simgrid_parse_error("Cannot connect trace " + trace_connect->trace + " to " + trace_connect->element +
158 ": unknown kind of trace");
163 * All the callback lists that can be overridden anywhere.
164 * (this list should probably be reduced to the bare minimum to allow the models to work)
167 /* make sure these symbols are defined as strong ones in this file so that the linker can resolve them */
169 static std::vector<std::unordered_map<std::string, std::string>> property_sets;
171 static FILE* file_to_parse = nullptr;
173 /* Stuff relative to storage */
174 void STag_simgrid_parse_storage()
176 xbt_die("<storage> tag was removed in SimGrid v3.27. Please stop using it now.");
179 void ETag_simgrid_parse_storage()
181 /* Won't happen since <storage> is now removed since v3.27. */
183 void STag_simgrid_parse_storage___type()
185 xbt_die("<storage_type> tag was removed in SimGrid v3.27. Please stop using it now.");
187 void ETag_simgrid_parse_storage___type()
189 /* Won't happen since <storage_type> is now removed since v3.27. */
192 void STag_simgrid_parse_mount()
194 xbt_die("<mount> tag was removed in SimGrid v3.27. Please stop using it now.");
197 void ETag_simgrid_parse_mount()
199 /* Won't happen since <mount> is now removed since v3.27. */
202 void STag_simgrid_parse_include()
204 xbt_die("<include> tag was removed in SimGrid v3.18. Please stop using it now.");
207 void ETag_simgrid_parse_include()
209 /* Won't happen since <include> is now removed since v3.18. */
212 /* Stag and Etag parse functions */
213 void STag_simgrid_parse_platform()
215 /* Use fixed point arithmetic to avoid rounding errors ("4.1" for example cannot be represented exactly as a floating
217 const long int version = lround(100.0 * simgrid_parse_get_double(A_simgrid_parse_platform_version));
218 const std::string version_string = std::to_string(version / 100) + "." + std::to_string(version % 100);
220 simgrid_parse_assert(version >= 100L, "******* BIG FAT WARNING *********\n "
221 "You're using an ancient XML file.\n"
222 "Since SimGrid 3.1, units are Bytes, Flops, and seconds "
223 "instead of MBytes, MFlops and seconds.\n"
225 "Use simgrid_update_xml to update your file automatically. "
226 "This program is installed automatically with SimGrid, or "
227 "available in the tools/ directory of the source archive.\n"
229 "Please check also out the SURF section of the ChangeLog for "
230 "the 3.1 version for more information.");
231 simgrid_parse_assert(version >= 300L, "******* BIG FAT WARNING *********\n "
232 "You're using an old XML file.\n"
233 "Use simgrid_update_xml to update your file automatically. "
234 "This program is installed automatically with SimGrid, or "
235 "available in the tools/ directory of the source archive.");
236 simgrid_parse_assert(
238 "******* THIS FILE IS TOO OLD (v:" + version_string +
240 "Changes introduced in SimGrid 3.13:\n"
241 " - 'power' attribute of hosts (and others) got renamed to 'speed'.\n"
242 " - In <trace_connect>, attribute kind=\"POWER\" is now kind=\"SPEED\".\n"
243 " - DOCTYPE now point to the rignt URL.\n"
244 " - speed, bandwidth and latency attributes now MUST have an explicit unit (f, Bps, s by default)"
246 "Use simgrid_update_xml to update your file automatically. "
247 "This program is installed automatically with SimGrid, or "
248 "available in the tools/ directory of the source archive.");
249 if (version < 410L) {
250 XBT_INFO("You're using a v%s XML file (%s) while the current standard is v4.1 "
251 "That's fine, the new version is backward compatible. \n\n"
252 "Use simgrid_update_xml to update your file automatically to get rid of this warning. "
253 "This program is installed automatically with SimGrid, or "
254 "available in the tools/ directory of the source archive.",
255 version_string.c_str(), simgrid_parsed_filename.c_str());
257 simgrid_parse_assert(version <= 410L,
258 "******* THIS FILE COMES FROM THE FUTURE (v:" + version_string +
260 "The most recent formalism that this version of SimGrid understands is v4.1.\n"
261 "Please update your code, or use another, more adapted, file.");
264 static void add_remote_disks()
266 for (auto const& host : simgrid::s4u::Engine::get_instance()->get_all_hosts()) {
267 const char* remote_disk_str = host->get_property("remote_disk");
268 if (not remote_disk_str)
270 std::vector<std::string> tokens;
271 boost::split(tokens, remote_disk_str, boost::is_any_of(":"));
272 simgrid::s4u::Host* remote_host = simgrid::s4u::Host::by_name_or_null(tokens[2]);
273 xbt_assert(remote_host, "You're trying to access a host that does not exist. Please check your platform file");
275 const simgrid::s4u::Disk* disk = nullptr;
276 for (auto const& d : remote_host->get_disks())
277 if (d->get_name() == tokens[1]) {
282 xbt_assert(disk, "You're trying to mount a disk that does not exist. Please check your platform file");
283 host->add_disk(disk);
285 XBT_DEBUG("Host '%s' wants to access a remote disk: %s of %s", host->get_cname(), disk->get_cname(),
286 remote_host->get_cname());
287 XBT_DEBUG("Host '%s' now has %zu disks", host->get_cname(), host->get_disks().size());
291 static void remove_remote_disks()
293 XBT_DEBUG("Simulation is over, time to unregister remote disks if any");
294 for (auto const& host : simgrid::s4u::Engine::get_instance()->get_all_hosts()) {
295 const char* remote_disk_str = host->get_property("remote_disk");
296 if (remote_disk_str) {
297 std::vector<std::string> tokens;
298 boost::split(tokens, remote_disk_str, boost::is_any_of(":"));
299 XBT_DEBUG("Host '%s' wants to unmount a remote disk: %s of %s", host->get_cname(),
300 tokens[1].c_str(), tokens[2].c_str());
301 host->remove_disk(tokens[1]);
302 XBT_DEBUG("Host '%s' now has %zu disks", host->get_cname(), host->get_disks().size());
307 void ETag_simgrid_parse_platform()
309 simgrid::s4u::Engine::on_platform_created_cb(&add_remote_disks);
310 simgrid::s4u::Engine::on_simulation_end_cb(&remove_remote_disks);
311 if (fire_on_platform_created_callback)
312 simgrid::s4u::Engine::on_platform_created();
316 void STag_simgrid_parse_prop()
318 property_sets.back().try_emplace(A_simgrid_parse_prop_id, A_simgrid_parse_prop_value);
319 XBT_DEBUG("add prop %s=%s into current property set %p", A_simgrid_parse_prop_id, A_simgrid_parse_prop_value,
320 &(property_sets.back()));
323 void STag_simgrid_parse_host()
325 simgrid::kernel::routing::HostCreationArgs host;
326 property_sets.emplace_back();
327 host.id = A_simgrid_parse_host_id;
329 host.speed_per_pstate = xbt_parse_get_all_speeds(simgrid_parsed_filename, simgrid_parse_lineno,
330 A_simgrid_parse_host_speed, "speed of host " + host.id);
332 XBT_DEBUG("pstate: %s", A_simgrid_parse_host_pstate);
333 host.core_amount = simgrid_parse_get_int(A_simgrid_parse_host_core);
335 if (A_simgrid_parse_host_availability___file[0] != '\0') {
336 XBT_WARN("The availability_file attribute in <host> is now deprecated. Please, use 'speed_file' instead.");
337 host.speed_trace = simgrid::kernel::profile::ProfileBuilder::from_file(A_simgrid_parse_host_availability___file);
339 if (A_simgrid_parse_host_speed___file[0] != '\0')
340 host.speed_trace = simgrid::kernel::profile::ProfileBuilder::from_file(A_simgrid_parse_host_speed___file);
341 host.state_trace = A_simgrid_parse_host_state___file[0]
342 ? simgrid::kernel::profile::ProfileBuilder::from_file(A_simgrid_parse_host_state___file)
344 host.coord = A_simgrid_parse_host_coordinates;
346 sg_platf_new_host_begin(&host);
349 void ETag_simgrid_parse_host()
351 sg_platf_new_host_set_properties(property_sets.back());
352 property_sets.pop_back();
354 sg_platf_new_host_seal(simgrid_parse_get_int(A_simgrid_parse_host_pstate));
357 void STag_simgrid_parse_disk()
359 property_sets.emplace_back();
362 void ETag_simgrid_parse_disk()
364 simgrid::kernel::routing::DiskCreationArgs disk;
365 disk.properties = property_sets.back();
366 property_sets.pop_back();
368 disk.id = A_simgrid_parse_disk_id;
369 disk.read_bw = xbt_parse_get_bandwidth(simgrid_parsed_filename, simgrid_parse_lineno, A_simgrid_parse_disk_read___bw,
370 "read_bw of disk " + disk.id);
371 disk.write_bw = xbt_parse_get_bandwidth(simgrid_parsed_filename, simgrid_parse_lineno,
372 A_simgrid_parse_disk_write___bw, "write_bw of disk " + disk.id);
374 sg_platf_new_disk(&disk);
377 void STag_simgrid_parse_host___link()
379 XBT_DEBUG("Create a Host_link for %s", A_simgrid_parse_host___link_id);
380 simgrid::kernel::routing::HostLinkCreationArgs host_link;
382 host_link.id = A_simgrid_parse_host___link_id;
383 host_link.link_up = A_simgrid_parse_host___link_up;
384 host_link.link_down = A_simgrid_parse_host___link_down;
385 sg_platf_new_hostlink(&host_link);
388 void STag_simgrid_parse_router()
390 sg_platf_new_router(A_simgrid_parse_router_id, A_simgrid_parse_router_coordinates);
393 void ETag_simgrid_parse_cluster()
395 simgrid::kernel::routing::ClusterCreationArgs cluster;
396 cluster.properties = property_sets.back();
397 property_sets.pop_back();
399 cluster.id = A_simgrid_parse_cluster_id;
400 cluster.prefix = A_simgrid_parse_cluster_prefix;
401 cluster.suffix = A_simgrid_parse_cluster_suffix;
402 explodesRadical(A_simgrid_parse_cluster_radical, &cluster.radicals);
404 cluster.speeds = xbt_parse_get_all_speeds(simgrid_parsed_filename, simgrid_parse_lineno,
405 A_simgrid_parse_cluster_speed, "speed of cluster " + cluster.id);
406 cluster.core_amount = simgrid_parse_get_int(A_simgrid_parse_cluster_core);
407 cluster.bw = xbt_parse_get_bandwidth(simgrid_parsed_filename, simgrid_parse_lineno, A_simgrid_parse_cluster_bw,
408 "bw of cluster " + cluster.id);
409 cluster.lat = xbt_parse_get_time(simgrid_parsed_filename, simgrid_parse_lineno, A_simgrid_parse_cluster_lat,
410 "lat of cluster " + cluster.id);
411 if (strcmp(A_simgrid_parse_cluster_bb___bw, ""))
412 cluster.bb_bw = xbt_parse_get_bandwidth(simgrid_parsed_filename, simgrid_parse_lineno,
413 A_simgrid_parse_cluster_bb___bw, "bb_bw of cluster " + cluster.id);
414 if (strcmp(A_simgrid_parse_cluster_bb___lat, ""))
415 cluster.bb_lat = xbt_parse_get_time(simgrid_parsed_filename, simgrid_parse_lineno, A_simgrid_parse_cluster_bb___lat,
416 "bb_lat of cluster " + cluster.id);
417 if (strcmp(A_simgrid_parse_cluster_limiter___link, ""))
418 cluster.limiter_link =
419 xbt_parse_get_bandwidth(simgrid_parsed_filename, simgrid_parse_lineno, A_simgrid_parse_cluster_limiter___link,
420 "limiter_link of cluster " + cluster.id);
421 if (strcmp(A_simgrid_parse_cluster_loopback___bw, ""))
422 cluster.loopback_bw =
423 xbt_parse_get_bandwidth(simgrid_parsed_filename, simgrid_parse_lineno, A_simgrid_parse_cluster_loopback___bw,
424 "loopback_bw of cluster " + cluster.id);
425 if (strcmp(A_simgrid_parse_cluster_loopback___lat, ""))
426 cluster.loopback_lat =
427 xbt_parse_get_time(simgrid_parsed_filename, simgrid_parse_lineno, A_simgrid_parse_cluster_loopback___lat,
428 "loopback_lat of cluster " + cluster.id);
430 switch (AX_simgrid_parse_cluster_topology) {
431 case A_simgrid_parse_cluster_topology_FLAT:
432 cluster.topology = simgrid::kernel::routing::ClusterTopology::FLAT;
434 case A_simgrid_parse_cluster_topology_TORUS:
435 cluster.topology = simgrid::kernel::routing::ClusterTopology::TORUS;
437 case A_simgrid_parse_cluster_topology_FAT___TREE:
438 cluster.topology = simgrid::kernel::routing::ClusterTopology::FAT_TREE;
440 case A_simgrid_parse_cluster_topology_DRAGONFLY:
441 cluster.topology = simgrid::kernel::routing::ClusterTopology::DRAGONFLY;
444 simgrid_parse_error("Invalid cluster topology for cluster " + cluster.id);
446 cluster.topo_parameters = A_simgrid_parse_cluster_topo___parameters;
447 cluster.router_id = A_simgrid_parse_cluster_router___id;
449 switch (AX_simgrid_parse_cluster_sharing___policy) {
450 case A_simgrid_parse_cluster_sharing___policy_SHARED:
451 cluster.sharing_policy = simgrid::s4u::Link::SharingPolicy::SHARED;
453 case A_simgrid_parse_cluster_sharing___policy_FULLDUPLEX:
454 XBT_WARN("FULLDUPLEX is now deprecated. Please update your platform file to use SPLITDUPLEX instead.");
455 cluster.sharing_policy = simgrid::s4u::Link::SharingPolicy::SPLITDUPLEX;
457 case A_simgrid_parse_cluster_sharing___policy_SPLITDUPLEX:
458 cluster.sharing_policy = simgrid::s4u::Link::SharingPolicy::SPLITDUPLEX;
460 case A_simgrid_parse_cluster_sharing___policy_FATPIPE:
461 cluster.sharing_policy = simgrid::s4u::Link::SharingPolicy::FATPIPE;
464 simgrid_parse_error("Invalid cluster sharing policy for cluster " + cluster.id);
466 switch (AX_simgrid_parse_cluster_bb___sharing___policy) {
467 case A_simgrid_parse_cluster_bb___sharing___policy_FATPIPE:
468 cluster.bb_sharing_policy = simgrid::s4u::Link::SharingPolicy::FATPIPE;
470 case A_simgrid_parse_cluster_bb___sharing___policy_SHARED:
471 cluster.bb_sharing_policy = simgrid::s4u::Link::SharingPolicy::SHARED;
474 simgrid_parse_error("Invalid bb sharing policy in cluster " + cluster.id);
477 sg_platf_new_tag_cluster(&cluster);
480 void STag_simgrid_parse_cluster()
482 property_sets.emplace_back();
485 void STag_simgrid_parse_cabinet()
487 simgrid::kernel::routing::CabinetCreationArgs cabinet;
488 cabinet.id = A_simgrid_parse_cabinet_id;
489 cabinet.prefix = A_simgrid_parse_cabinet_prefix;
490 cabinet.suffix = A_simgrid_parse_cabinet_suffix;
491 cabinet.speed = xbt_parse_get_speed(simgrid_parsed_filename, simgrid_parse_lineno, A_simgrid_parse_cabinet_speed,
492 "speed of cabinet " + cabinet.id);
493 cabinet.bw = xbt_parse_get_bandwidth(simgrid_parsed_filename, simgrid_parse_lineno, A_simgrid_parse_cabinet_bw,
494 "bw of cabinet " + cabinet.id);
495 cabinet.lat = xbt_parse_get_time(simgrid_parsed_filename, simgrid_parse_lineno, A_simgrid_parse_cabinet_lat,
496 "lat of cabinet " + cabinet.id);
497 explodesRadical(A_simgrid_parse_cabinet_radical, &cabinet.radicals);
499 sg_platf_new_cabinet(&cabinet);
502 void STag_simgrid_parse_peer()
504 simgrid::kernel::routing::PeerCreationArgs peer;
506 peer.id = A_simgrid_parse_peer_id;
507 peer.speed = xbt_parse_get_speed(simgrid_parsed_filename, simgrid_parse_lineno, A_simgrid_parse_peer_speed,
508 "speed of peer " + peer.id);
509 peer.bw_in = xbt_parse_get_bandwidth(simgrid_parsed_filename, simgrid_parse_lineno, A_simgrid_parse_peer_bw___in,
510 "bw_in of peer " + peer.id);
511 peer.bw_out = xbt_parse_get_bandwidth(simgrid_parsed_filename, simgrid_parse_lineno, A_simgrid_parse_peer_bw___out,
512 "bw_out of peer " + peer.id);
513 peer.coord = A_simgrid_parse_peer_coordinates;
514 peer.speed_trace = nullptr;
515 if (A_simgrid_parse_peer_availability___file[0] != '\0') {
516 XBT_WARN("The availability_file attribute in <peer> is now deprecated. Please, use 'speed_file' instead.");
517 peer.speed_trace = simgrid::kernel::profile::ProfileBuilder::from_file(A_simgrid_parse_peer_availability___file);
519 if (A_simgrid_parse_peer_speed___file[0] != '\0')
520 peer.speed_trace = simgrid::kernel::profile::ProfileBuilder::from_file(A_simgrid_parse_peer_speed___file);
521 peer.state_trace = A_simgrid_parse_peer_state___file[0]
522 ? simgrid::kernel::profile::ProfileBuilder::from_file(A_simgrid_parse_peer_state___file)
525 if (A_simgrid_parse_peer_lat[0] != '\0')
526 XBT_WARN("The latency attribute in <peer> is now deprecated. Use the z coordinate instead of '%s'.",
527 A_simgrid_parse_peer_lat);
529 sg_platf_new_peer(&peer);
532 void STag_simgrid_parse_link()
534 property_sets.emplace_back();
537 void ETag_simgrid_parse_link()
539 simgrid::kernel::routing::LinkCreationArgs link;
541 link.properties = property_sets.back();
542 property_sets.pop_back();
544 link.id = A_simgrid_parse_link_id;
545 link.bandwidths = xbt_parse_get_bandwidths(simgrid_parsed_filename, simgrid_parse_lineno,
546 A_simgrid_parse_link_bandwidth, "bandwidth of link " + link.id);
547 link.bandwidth_trace =
548 A_simgrid_parse_link_bandwidth___file[0]
549 ? simgrid::kernel::profile::ProfileBuilder::from_file(A_simgrid_parse_link_bandwidth___file)
551 link.latency = xbt_parse_get_time(simgrid_parsed_filename, simgrid_parse_lineno, A_simgrid_parse_link_latency,
552 "latency of link " + link.id);
553 link.latency_trace = A_simgrid_parse_link_latency___file[0]
554 ? simgrid::kernel::profile::ProfileBuilder::from_file(A_simgrid_parse_link_latency___file)
556 link.state_trace = A_simgrid_parse_link_state___file[0]
557 ? simgrid::kernel::profile::ProfileBuilder::from_file(A_simgrid_parse_link_state___file)
560 switch (A_simgrid_parse_link_sharing___policy) {
561 case A_simgrid_parse_link_sharing___policy_SHARED:
562 link.policy = simgrid::s4u::Link::SharingPolicy::SHARED;
564 case A_simgrid_parse_link_sharing___policy_FATPIPE:
565 link.policy = simgrid::s4u::Link::SharingPolicy::FATPIPE;
567 case A_simgrid_parse_link_sharing___policy_FULLDUPLEX:
568 XBT_WARN("FULLDUPLEX is now deprecated. Please update your platform file to use SPLITDUPLEX instead.");
569 link.policy = simgrid::s4u::Link::SharingPolicy::SPLITDUPLEX;
571 case A_simgrid_parse_link_sharing___policy_SPLITDUPLEX:
572 link.policy = simgrid::s4u::Link::SharingPolicy::SPLITDUPLEX;
574 case A_simgrid_parse_link_sharing___policy_WIFI:
575 link.policy = simgrid::s4u::Link::SharingPolicy::WIFI;
578 simgrid_parse_error("Invalid sharing policy in link " + link.id);
581 sg_platf_new_link(&link);
584 void STag_simgrid_parse_link___ctn()
586 const auto* engine = simgrid::s4u::Engine::get_instance();
587 const simgrid::s4u::Link* link;
588 simgrid::s4u::LinkInRoute::Direction direction = simgrid::s4u::LinkInRoute::Direction::NONE;
589 switch (A_simgrid_parse_link___ctn_direction) {
590 case AU_simgrid_parse_link___ctn_direction:
591 case A_simgrid_parse_link___ctn_direction_NONE:
592 link = engine->link_by_name(A_simgrid_parse_link___ctn_id);
594 case A_simgrid_parse_link___ctn_direction_UP:
595 link = engine->split_duplex_link_by_name(A_simgrid_parse_link___ctn_id);
596 direction = simgrid::s4u::LinkInRoute::Direction::UP;
598 case A_simgrid_parse_link___ctn_direction_DOWN:
599 link = engine->split_duplex_link_by_name(A_simgrid_parse_link___ctn_id);
600 direction = simgrid::s4u::LinkInRoute::Direction::DOWN;
603 simgrid_parse_error(std::string("Invalid direction for link ") + A_simgrid_parse_link___ctn_id);
607 switch (A_simgrid_parse_link___ctn_direction) {
608 case A_simgrid_parse_link___ctn_direction_UP:
609 dirname = " (upward)";
611 case A_simgrid_parse_link___ctn_direction_DOWN:
612 dirname = " (downward)";
617 simgrid_parse_assert(link != nullptr, std::string("No such link: '") + A_simgrid_parse_link___ctn_id + "'" + dirname);
618 parsed_link_list.emplace_back(link, direction);
621 void ETag_simgrid_parse_backbone()
623 auto link = std::make_unique<simgrid::kernel::routing::LinkCreationArgs>();
625 link->id = A_simgrid_parse_backbone_id;
626 link->bandwidths.push_back(xbt_parse_get_bandwidth(simgrid_parsed_filename, simgrid_parse_lineno,
627 A_simgrid_parse_backbone_bandwidth,
628 "bandwidth of backbone " + link->id));
629 link->latency = xbt_parse_get_time(simgrid_parsed_filename, simgrid_parse_lineno, A_simgrid_parse_backbone_latency,
630 "latency of backbone " + link->id);
631 link->policy = simgrid::s4u::Link::SharingPolicy::SHARED;
633 routing_cluster_add_backbone(std::move(link));
636 void STag_simgrid_parse_route()
638 simgrid_parse_assert_netpoint(A_simgrid_parse_route_src, "Route src='", "' does name a node.");
639 simgrid_parse_assert_netpoint(A_simgrid_parse_route_dst, "Route dst='", "' does name a node.");
642 void STag_simgrid_parse_ASroute()
644 simgrid_parse_assert_netpoint(A_simgrid_parse_ASroute_src, "ASroute src='", "' does name a node.");
645 simgrid_parse_assert_netpoint(A_simgrid_parse_ASroute_dst, "ASroute dst='", "' does name a node.");
647 simgrid_parse_assert_netpoint(A_simgrid_parse_ASroute_gw___src, "ASroute gw_src='", "' does name a node.");
648 simgrid_parse_assert_netpoint(A_simgrid_parse_ASroute_gw___dst, "ASroute gw_dst='", "' does name a node.");
650 void STag_simgrid_parse_zoneRoute()
652 simgrid_parse_assert_netpoint(A_simgrid_parse_zoneRoute_src, "zoneRoute src='", "' does name a node.");
653 simgrid_parse_assert_netpoint(A_simgrid_parse_zoneRoute_dst, "zoneRoute dst='", "' does name a node.");
654 simgrid_parse_assert_netpoint(A_simgrid_parse_zoneRoute_gw___src, "zoneRoute gw_src='", "' does name a node.");
655 simgrid_parse_assert_netpoint(A_simgrid_parse_zoneRoute_gw___dst, "zoneRoute gw_dst='", "' does name a node.");
658 void STag_simgrid_parse_bypassRoute()
660 simgrid_parse_assert_netpoint(A_simgrid_parse_bypassRoute_src, "bypassRoute src='", "' does name a node.");
661 simgrid_parse_assert_netpoint(A_simgrid_parse_bypassRoute_dst, "bypassRoute dst='", "' does name a node.");
664 void STag_simgrid_parse_bypassASroute()
666 simgrid_parse_assert_netpoint(A_simgrid_parse_bypassASroute_src, "bypassASroute src='", "' does name a node.");
667 simgrid_parse_assert_netpoint(A_simgrid_parse_bypassASroute_dst, "bypassASroute dst='", "' does name a node.");
668 simgrid_parse_assert_netpoint(A_simgrid_parse_bypassASroute_gw___src, "bypassASroute gw_src='",
669 "' does name a node.");
670 simgrid_parse_assert_netpoint(A_simgrid_parse_bypassASroute_gw___dst, "bypassASroute gw_dst='",
671 "' does name a node.");
673 void STag_simgrid_parse_bypassZoneRoute()
675 simgrid_parse_assert_netpoint(A_simgrid_parse_bypassZoneRoute_src, "bypassZoneRoute src='", "' does name a node.");
676 simgrid_parse_assert_netpoint(A_simgrid_parse_bypassZoneRoute_dst, "bypassZoneRoute dst='", "' does name a node.");
677 simgrid_parse_assert_netpoint(A_simgrid_parse_bypassZoneRoute_gw___src, "bypassZoneRoute gw_src='",
678 "' does name a node.");
679 simgrid_parse_assert_netpoint(A_simgrid_parse_bypassZoneRoute_gw___dst, "bypassZoneRoute gw_dst='",
680 "' does name a node.");
683 void ETag_simgrid_parse_route()
685 simgrid::kernel::routing::RouteCreationArgs route;
687 route.src = sg_netpoint_by_name_or_null(A_simgrid_parse_route_src); // tested to not be nullptr in start tag
688 route.dst = sg_netpoint_by_name_or_null(A_simgrid_parse_route_dst); // tested to not be nullptr in start tag
689 route.symmetrical = (A_simgrid_parse_route_symmetrical == AU_simgrid_parse_route_symmetrical ||
690 A_simgrid_parse_route_symmetrical == A_simgrid_parse_route_symmetrical_YES ||
691 A_simgrid_parse_route_symmetrical == A_simgrid_parse_route_symmetrical_yes);
693 route.link_list.swap(parsed_link_list);
695 sg_platf_new_route(&route);
698 void ETag_simgrid_parse_ASroute()
700 AX_simgrid_parse_zoneRoute_src = AX_simgrid_parse_ASroute_src;
701 AX_simgrid_parse_zoneRoute_dst = AX_simgrid_parse_ASroute_dst;
702 AX_simgrid_parse_zoneRoute_gw___src = AX_simgrid_parse_ASroute_gw___src;
703 AX_simgrid_parse_zoneRoute_gw___dst = AX_simgrid_parse_ASroute_gw___dst;
704 AX_simgrid_parse_zoneRoute_symmetrical = (AT_simgrid_parse_zoneRoute_symmetrical)AX_simgrid_parse_ASroute_symmetrical;
705 ETag_simgrid_parse_zoneRoute();
707 void ETag_simgrid_parse_zoneRoute()
709 simgrid::kernel::routing::RouteCreationArgs ASroute;
711 ASroute.src = sg_netpoint_by_name_or_null(A_simgrid_parse_zoneRoute_src); // tested to not be nullptr in start tag
712 ASroute.dst = sg_netpoint_by_name_or_null(A_simgrid_parse_zoneRoute_dst); // tested to not be nullptr in start tag
715 sg_netpoint_by_name_or_null(A_simgrid_parse_zoneRoute_gw___src); // tested to not be nullptr in start tag
717 sg_netpoint_by_name_or_null(A_simgrid_parse_zoneRoute_gw___dst); // tested to not be nullptr in start tag
719 ASroute.link_list.swap(parsed_link_list);
721 ASroute.symmetrical = (A_simgrid_parse_zoneRoute_symmetrical == AU_simgrid_parse_zoneRoute_symmetrical ||
722 A_simgrid_parse_zoneRoute_symmetrical == A_simgrid_parse_zoneRoute_symmetrical_YES ||
723 A_simgrid_parse_zoneRoute_symmetrical == A_simgrid_parse_zoneRoute_symmetrical_yes);
725 sg_platf_new_route(&ASroute);
728 void ETag_simgrid_parse_bypassRoute()
730 simgrid::kernel::routing::RouteCreationArgs route;
732 route.src = sg_netpoint_by_name_or_null(A_simgrid_parse_bypassRoute_src); // tested to not be nullptr in start tag
733 route.dst = sg_netpoint_by_name_or_null(A_simgrid_parse_bypassRoute_dst); // tested to not be nullptr in start tag
734 route.symmetrical = false;
736 route.link_list.swap(parsed_link_list);
738 sg_platf_new_bypass_route(&route);
741 void ETag_simgrid_parse_bypassASroute()
743 AX_simgrid_parse_bypassZoneRoute_src = AX_simgrid_parse_bypassASroute_src;
744 AX_simgrid_parse_bypassZoneRoute_dst = AX_simgrid_parse_bypassASroute_dst;
745 AX_simgrid_parse_bypassZoneRoute_gw___src = AX_simgrid_parse_bypassASroute_gw___src;
746 AX_simgrid_parse_bypassZoneRoute_gw___dst = AX_simgrid_parse_bypassASroute_gw___dst;
747 ETag_simgrid_parse_bypassZoneRoute();
749 void ETag_simgrid_parse_bypassZoneRoute()
751 simgrid::kernel::routing::RouteCreationArgs ASroute;
753 ASroute.src = sg_netpoint_by_name_or_null(A_simgrid_parse_bypassZoneRoute_src);
754 ASroute.dst = sg_netpoint_by_name_or_null(A_simgrid_parse_bypassZoneRoute_dst);
755 ASroute.link_list.swap(parsed_link_list);
757 ASroute.symmetrical = false;
759 ASroute.gw_src = sg_netpoint_by_name_or_null(A_simgrid_parse_bypassZoneRoute_gw___src);
760 ASroute.gw_dst = sg_netpoint_by_name_or_null(A_simgrid_parse_bypassZoneRoute_gw___dst);
762 sg_platf_new_bypass_route(&ASroute);
765 void ETag_simgrid_parse_trace()
767 simgrid::kernel::routing::ProfileCreationArgs trace;
769 trace.id = A_simgrid_parse_trace_id;
770 trace.file = A_simgrid_parse_trace_file;
771 trace.periodicity = simgrid_parse_get_double(A_simgrid_parse_trace_periodicity);
772 trace.pc_data = simgrid_parse_pcdata;
774 sg_platf_new_trace(&trace);
777 void STag_simgrid_parse_trace___connect()
779 simgrid::kernel::routing::TraceConnectCreationArgs trace_connect;
781 trace_connect.element = A_simgrid_parse_trace___connect_element;
782 trace_connect.trace = A_simgrid_parse_trace___connect_trace;
784 switch (A_simgrid_parse_trace___connect_kind) {
785 case AU_simgrid_parse_trace___connect_kind:
786 case A_simgrid_parse_trace___connect_kind_SPEED:
787 trace_connect.kind = simgrid::kernel::routing::TraceConnectKind::SPEED;
789 case A_simgrid_parse_trace___connect_kind_BANDWIDTH:
790 trace_connect.kind = simgrid::kernel::routing::TraceConnectKind::BANDWIDTH;
792 case A_simgrid_parse_trace___connect_kind_HOST___AVAIL:
793 trace_connect.kind = simgrid::kernel::routing::TraceConnectKind::HOST_AVAIL;
795 case A_simgrid_parse_trace___connect_kind_LATENCY:
796 trace_connect.kind = simgrid::kernel::routing::TraceConnectKind::LATENCY;
798 case A_simgrid_parse_trace___connect_kind_LINK___AVAIL:
799 trace_connect.kind = simgrid::kernel::routing::TraceConnectKind::LINK_AVAIL;
802 simgrid_parse_error("Invalid trace kind");
804 sg_platf_trace_connect(&trace_connect);
807 void STag_simgrid_parse_AS()
809 AX_simgrid_parse_zone_id = AX_simgrid_parse_AS_id;
810 AX_simgrid_parse_zone_routing = AX_simgrid_parse_AS_routing;
811 STag_simgrid_parse_zone();
814 void ETag_simgrid_parse_AS()
816 ETag_simgrid_parse_zone();
819 void STag_simgrid_parse_zone()
821 property_sets.emplace_back();
822 simgrid::kernel::routing::ZoneCreationArgs zone;
823 zone.id = A_simgrid_parse_zone_id;
824 zone.routing = A_simgrid_parse_zone_routing;
825 sg_platf_new_zone_begin(&zone);
828 void ETag_simgrid_parse_zone()
830 sg_platf_new_zone_set_properties(property_sets.back());
831 property_sets.pop_back();
832 sg_platf_new_zone_seal();
835 void STag_simgrid_parse_config()
837 property_sets.emplace_back();
838 XBT_DEBUG("START configuration name = %s", A_simgrid_parse_config_id);
839 if (_sg_cfg_init_status == 2) {
841 "All <config> tags must be given before any platform elements (such as <zone>, <host>, <cluster>, "
846 void ETag_simgrid_parse_config()
848 // Sort config elements before applying.
849 // That's a little waste of time, but not doing so would break the tests
850 auto current_property_set = property_sets.back();
852 std::vector<std::string> keys;
853 for (auto const& [key, _] : current_property_set) {
856 std::sort(keys.begin(), keys.end());
857 for (const std::string& key : keys) {
858 if (simgrid::config::is_default(key.c_str())) {
859 std::string cfg = key + ":" + current_property_set.at(key);
860 simgrid::config::set_parse(cfg);
862 XBT_INFO("The custom configuration '%s' is already defined by user!", key.c_str());
864 XBT_DEBUG("End configuration name = %s", A_simgrid_parse_config_id);
866 property_sets.pop_back();
869 static std::vector<std::string> arguments;
871 void STag_simgrid_parse_process()
873 AX_simgrid_parse_actor_function = AX_simgrid_parse_process_function;
874 STag_simgrid_parse_actor();
877 void STag_simgrid_parse_actor()
879 property_sets.emplace_back();
880 arguments.assign(1, A_simgrid_parse_actor_function);
883 void ETag_simgrid_parse_process()
885 AX_simgrid_parse_actor_host = AX_simgrid_parse_process_host;
886 AX_simgrid_parse_actor_function = AX_simgrid_parse_process_function;
887 AX_simgrid_parse_actor_start___time = AX_simgrid_parse_process_start___time;
888 AX_simgrid_parse_actor_kill___time = AX_simgrid_parse_process_kill___time;
889 AX_simgrid_parse_actor_on___failure = (AT_simgrid_parse_actor_on___failure)AX_simgrid_parse_process_on___failure;
890 ETag_simgrid_parse_actor();
893 void ETag_simgrid_parse_actor()
895 simgrid::kernel::routing::ActorCreationArgs actor;
897 actor.properties = property_sets.back();
898 property_sets.pop_back();
900 actor.args.swap(arguments);
901 actor.host = A_simgrid_parse_actor_host;
902 actor.function = A_simgrid_parse_actor_function;
903 actor.start_time = simgrid_parse_get_double(A_simgrid_parse_actor_start___time);
904 actor.kill_time = simgrid_parse_get_double(A_simgrid_parse_actor_kill___time);
906 switch (A_simgrid_parse_actor_on___failure) {
907 case AU_simgrid_parse_actor_on___failure:
908 case A_simgrid_parse_actor_on___failure_DIE:
909 actor.restart_on_failure = false;
911 case A_simgrid_parse_actor_on___failure_RESTART:
912 actor.restart_on_failure = true;
915 simgrid_parse_error("Invalid on failure behavior");
918 sg_platf_new_actor(&actor);
921 void STag_simgrid_parse_argument()
923 arguments.emplace_back(A_simgrid_parse_argument_value);
926 void STag_simgrid_parse_model___prop()
928 XBT_INFO("Deprecated tag <model_prop> ignored");
931 void ETag_simgrid_parse_prop()
932 { /* Nothing to do */
934 void STag_simgrid_parse_random()
935 { /* Nothing to do */
937 void ETag_simgrid_parse_random()
938 { /* Nothing to do */
940 void ETag_simgrid_parse_trace___connect()
941 { /* Nothing to do */
943 void STag_simgrid_parse_trace()
944 { /* Nothing to do */
946 void ETag_simgrid_parse_router()
949 void ETag_simgrid_parse_host___link()
950 { /* Nothing to do */
952 void ETag_simgrid_parse_cabinet()
953 { /* Nothing to do */
955 void ETag_simgrid_parse_peer()
956 { /* Nothing to do */
958 void STag_simgrid_parse_backbone()
959 { /* Nothing to do */
961 void ETag_simgrid_parse_link___ctn()
962 { /* Nothing to do */
964 void ETag_simgrid_parse_argument()
965 { /* Nothing to do */
967 void ETag_simgrid_parse_model___prop()
968 { /* Nothing to do */
971 /* Open and Close parse file */
972 static YY_BUFFER_STATE input_buffer;
974 void simgrid_parse_open(const std::string& file)
976 simgrid_parsed_filename = file;
977 std::string dir = simgrid::xbt::Path(file).get_dir_name();
978 simgrid::xbt::path_push(dir);
980 file_to_parse = simgrid::xbt::path_fopen(file, "r");
981 if (file_to_parse == nullptr)
982 throw std::invalid_argument("Unable to open '" + file + "' from '" + simgrid::xbt::Path().get_name() +
983 "'. Does this file exist?");
984 input_buffer = simgrid_parse__create_buffer(file_to_parse, YY_BUF_SIZE);
985 simgrid_parse__switch_to_buffer(input_buffer);
986 simgrid_parse_lineno = 1;
989 void simgrid_parse_close()
991 simgrid::xbt::path_pop(); // remove the dirname of the opened file, that was added in simgrid_parse_open()
994 simgrid_parse__delete_buffer(input_buffer);
995 fclose(file_to_parse);
996 file_to_parse = nullptr; // Must be reset for Bypass
1000 /* Call the lexer to parse the currently opened file */
1001 void simgrid_parse(bool fire_on_platform_created_callback_param)
1003 fire_on_platform_created_callback = fire_on_platform_created_callback_param;
1004 bool err = simgrid_parse_lex();
1005 simgrid_parse_assert(not err, "Flex returned an error code");
1007 /* Actually connect the traces now that every elements are created */
1008 const auto* engine = simgrid::s4u::Engine::get_instance();
1010 for (auto const& [trace, name] : trace_connect_list_host_avail) {
1011 simgrid_parse_assert(traces_set_list.find(trace) != traces_set_list.end(),
1012 "<trace_connect kind=\"HOST_AVAIL\">: Trace " + trace + " undefined.");
1013 auto profile = traces_set_list.at(trace);
1015 auto host = engine->host_by_name_or_null(name);
1016 simgrid_parse_assert(host, "<trace_connect kind=\"HOST_AVAIL\">: Host " + name + " undefined.");
1017 host->set_state_profile(profile);
1019 trace_connect_list_host_avail.clear();
1021 for (auto const& [trace, name] : trace_connect_list_host_speed) {
1022 simgrid_parse_assert(traces_set_list.find(trace) != traces_set_list.end(),
1023 "<trace_connect kind=\"SPEED\">: Trace " + trace + " undefined.");
1024 auto profile = traces_set_list.at(trace);
1026 auto host = engine->host_by_name_or_null(name);
1027 simgrid_parse_assert(host, "<trace_connect kind=\"SPEED\">: Host " + name + " undefined.");
1028 host->set_speed_profile(profile);
1030 trace_connect_list_host_speed.clear();
1032 for (auto const& [trace, name] : trace_connect_list_link_avail) {
1033 simgrid_parse_assert(traces_set_list.find(trace) != traces_set_list.end(),
1034 "<trace_connect kind=\"LINK_AVAIL\">: Trace " + trace + " undefined.");
1035 auto profile = traces_set_list.at(trace);
1037 auto link = engine->link_by_name_or_null(name);
1038 simgrid_parse_assert(link, "<trace_connect kind=\"LINK_AVAIL\">: Link " + name + " undefined.");
1039 link->set_state_profile(profile);
1041 trace_connect_list_link_avail.clear();
1043 for (auto const& [trace, name] : trace_connect_list_link_bw) {
1044 simgrid_parse_assert(traces_set_list.find(trace) != traces_set_list.end(),
1045 "<trace_connect kind=\"BANDWIDTH\">: Trace " + trace + " undefined.");
1046 auto profile = traces_set_list.at(trace);
1048 auto link = engine->link_by_name_or_null(name);
1049 simgrid_parse_assert(link, "<trace_connect kind=\"BANDWIDTH\">: Link " + name + " undefined.");
1050 link->set_bandwidth_profile(profile);
1052 trace_connect_list_link_bw.clear();
1054 for (auto const& [trace, name] : trace_connect_list_link_lat) {
1055 simgrid_parse_assert(traces_set_list.find(trace) != traces_set_list.end(),
1056 "<trace_connect kind=\"LATENCY\">: Trace " + trace + " undefined.");
1057 auto profile = traces_set_list.at(trace);
1059 auto link = engine->link_by_name_or_null(name);
1060 simgrid_parse_assert(link, "<trace_connect kind=\"LATENCY\">: Link " + name + " undefined.");
1061 link->set_latency_profile(profile);
1063 trace_connect_list_link_lat.clear();