1 /* Copyright (c) 2006-2022. 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 <xbt/file.hpp>
10 #include <xbt/parse_units.hpp>
12 #include "simgrid/sg_config.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/surf/surf_interface.hpp"
17 #include "src/surf/xml/platf.hpp"
18 #include "src/surf/xml/platf_private.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(surf_parse, surf, "Logging specific to the SURF parsing module");
31 std::string surf_parsed_filename; // Currently parsed file (for the error messages)
32 std::vector<simgrid::s4u::LinkInRoute> parsed_link_list; /* temporary store of current link list of a route */
34 /* Helping functions */
35 void surf_parse_assert(bool cond, const std::string& msg)
38 surf_parse_error(msg);
41 void surf_parse_error(const std::string& msg)
43 throw simgrid::ParseError(surf_parsed_filename, surf_parse_lineno, msg);
46 void surf_parse_assert_netpoint(const std::string& hostname, const std::string& pre, const std::string& post)
48 if (simgrid::s4u::Engine::get_instance()->netpoint_by_name_or_null(hostname) != nullptr) // found
51 std::string msg = pre + hostname + post + " Existing netpoints:\n";
53 std::vector<simgrid::kernel::routing::NetPoint*> netpoints =
54 simgrid::s4u::Engine::get_instance()->get_all_netpoints();
55 std::sort(netpoints.begin(), netpoints.end(),
56 [](const simgrid::kernel::routing::NetPoint* a, const simgrid::kernel::routing::NetPoint* b) {
57 return a->get_name() < b->get_name();
60 for (auto const& np : netpoints) {
67 msg += "'" + np->get_name() + "'";
68 if (msg.length() > 4096) {
69 msg.pop_back(); // remove trailing quote
70 msg += "...(list truncated)......";
74 surf_parse_error(msg);
77 double surf_parse_get_double(const std::string& s)
81 } catch (const std::invalid_argument&) {
82 surf_parse_error(s + " is not a double");
86 int surf_parse_get_int(const std::string& s)
90 } catch (const std::invalid_argument&) {
91 surf_parse_error(s + " is not an int");
95 /* Turn something like "1-4,6,9-11" into the vector {1,2,3,4,6,9,10,11} */
96 static void explodesRadical(const std::string& radicals, std::vector<int>* exploded)
99 std::vector<std::string> radical_elements;
100 boost::split(radical_elements, radicals, boost::is_any_of(","));
101 for (auto const& group : radical_elements) {
102 std::vector<std::string> radical_ends;
103 boost::split(radical_ends, group, boost::is_any_of("-"));
104 int start = surf_parse_get_int(radical_ends.front());
107 switch (radical_ends.size()) {
112 end = surf_parse_get_int(radical_ends.back());
115 surf_parse_error(std::string("Malformed radical: ") + group);
117 for (int i = start; i <= end; i++)
118 exploded->push_back(i);
124 * All the callback lists that can be overridden anywhere.
125 * (this list should probably be reduced to the bare minimum to allow the models to work)
128 /* make sure these symbols are defined as strong ones in this file so that the linker can resolve them */
130 std::vector<std::unordered_map<std::string, std::string>> property_sets;
132 FILE *surf_file_to_parse = nullptr;
134 /* Stuff relative to storage */
135 void STag_surfxml_storage()
137 xbt_die("<storage> tag was removed in SimGrid v3.27. Please stop using it now.");
140 void ETag_surfxml_storage()
142 /* Won't happen since <storage> is now removed since v3.27. */
144 void STag_surfxml_storage___type()
146 xbt_die("<storage_type> tag was removed in SimGrid v3.27. Please stop using it now.");
148 void ETag_surfxml_storage___type()
150 /* Won't happen since <storage_type> is now removed since v3.27. */
153 void STag_surfxml_mount()
155 xbt_die("<mount> tag was removed in SimGrid v3.27. Please stop using it now.");
158 void ETag_surfxml_mount()
160 /* Won't happen since <mount> is now removed since v3.27. */
163 void STag_surfxml_include()
165 xbt_die("<include> tag was removed in SimGrid v3.18. Please stop using it now.");
168 void ETag_surfxml_include()
170 /* Won't happen since <include> is now removed since v3.18. */
173 /* Stag and Etag parse functions */
174 void STag_surfxml_platform() {
175 double version = surf_parse_get_double(A_surfxml_platform_version);
177 surf_parse_assert((version >= 1.0), "******* BIG FAT WARNING *********\n "
178 "You're using an ancient XML file.\n"
179 "Since SimGrid 3.1, units are Bytes, Flops, and seconds "
180 "instead of MBytes, MFlops and seconds.\n"
182 "Use simgrid_update_xml to update your file automatically. "
183 "This program is installed automatically with SimGrid, or "
184 "available in the tools/ directory of the source archive.\n"
186 "Please check also out the SURF section of the ChangeLog for "
187 "the 3.1 version for more information. \n"
189 "Last, do not forget to also update your values for "
190 "the calls to MSG_task_create (if any).");
191 surf_parse_assert((version >= 3.0), "******* BIG FAT WARNING *********\n "
192 "You're using an old XML file.\n"
193 "Use simgrid_update_xml to update your file automatically. "
194 "This program is installed automatically with SimGrid, or "
195 "available in the tools/ directory of the source archive.");
198 std::string("******* THIS FILE IS TOO OLD (v:") + std::to_string(version) +
200 "Changes introduced in SimGrid 3.13:\n"
201 " - 'power' attribute of hosts (and others) got renamed to 'speed'.\n"
202 " - In <trace_connect>, attribute kind=\"POWER\" is now kind=\"SPEED\".\n"
203 " - DOCTYPE now point to the rignt URL.\n"
204 " - speed, bandwidth and latency attributes now MUST have an explicit unit (f, Bps, s by default)"
206 "Use simgrid_update_xml to update your file automatically. "
207 "This program is installed automatically with SimGrid, or "
208 "available in the tools/ directory of the source archive.");
210 XBT_INFO("You're using a v%.1f XML file (%s) while the current standard is v4.1 "
211 "That's fine, the new version is backward compatible. \n\n"
212 "Use simgrid_update_xml to update your file automatically to get rid of this warning. "
213 "This program is installed automatically with SimGrid, or "
214 "available in the tools/ directory of the source archive.",
215 version, surf_parsed_filename.c_str());
217 surf_parse_assert(version <= 4.1,
218 std::string("******* THIS FILE COMES FROM THE FUTURE (v:")+std::to_string(version)+") *********\n "
219 "The most recent formalism that this version of SimGrid understands is v4.1.\n"
220 "Please update your code, or use another, more adapted, file.");
222 void ETag_surfxml_platform(){
223 simgrid::s4u::Engine::on_platform_created();
226 void STag_surfxml_prop()
228 property_sets.back().try_emplace(A_surfxml_prop_id, A_surfxml_prop_value);
229 XBT_DEBUG("add prop %s=%s into current property set %p", A_surfxml_prop_id, A_surfxml_prop_value,
230 &(property_sets.back()));
233 void STag_surfxml_host()
235 simgrid::kernel::routing::HostCreationArgs host;
236 property_sets.emplace_back();
237 host.id = A_surfxml_host_id;
239 host.speed_per_pstate = xbt_parse_get_all_speeds(surf_parsed_filename, surf_parse_lineno, A_surfxml_host_speed,
240 "speed of host " + host.id);
242 XBT_DEBUG("pstate: %s", A_surfxml_host_pstate);
243 host.core_amount = surf_parse_get_int(A_surfxml_host_core);
245 if (A_surfxml_host_availability___file[0] != '\0') {
246 XBT_WARN("The availability_file attribute in <host> is now deprecated. Please, use 'speed_file' instead.");
247 host.speed_trace = simgrid::kernel::profile::ProfileBuilder::from_file(A_surfxml_host_availability___file);
249 if (A_surfxml_host_speed___file[0] != '\0')
250 host.speed_trace = simgrid::kernel::profile::ProfileBuilder::from_file(A_surfxml_host_speed___file);
251 host.state_trace = A_surfxml_host_state___file[0]
252 ? simgrid::kernel::profile::ProfileBuilder::from_file(A_surfxml_host_state___file)
254 host.coord = A_surfxml_host_coordinates;
256 sg_platf_new_host_begin(&host);
259 void ETag_surfxml_host()
261 sg_platf_new_host_set_properties(property_sets.back());
262 property_sets.pop_back();
264 sg_platf_new_host_seal(surf_parse_get_int(A_surfxml_host_pstate));
267 void STag_surfxml_disk() {
268 property_sets.emplace_back();
271 void ETag_surfxml_disk() {
272 simgrid::kernel::routing::DiskCreationArgs disk;
273 disk.properties = property_sets.back();
274 property_sets.pop_back();
276 disk.id = A_surfxml_disk_id;
277 disk.read_bw = xbt_parse_get_bandwidth(surf_parsed_filename, surf_parse_lineno, A_surfxml_disk_read___bw,
278 "read_bw of disk " + disk.id);
279 disk.write_bw = xbt_parse_get_bandwidth(surf_parsed_filename, surf_parse_lineno, A_surfxml_disk_write___bw,
280 "write_bw of disk " + disk.id);
282 sg_platf_new_disk(&disk);
285 void STag_surfxml_host___link(){
286 XBT_DEBUG("Create a Host_link for %s",A_surfxml_host___link_id);
287 simgrid::kernel::routing::HostLinkCreationArgs host_link;
289 host_link.id = A_surfxml_host___link_id;
290 host_link.link_up = A_surfxml_host___link_up;
291 host_link.link_down = A_surfxml_host___link_down;
292 sg_platf_new_hostlink(&host_link);
295 void STag_surfxml_router(){
296 sg_platf_new_router(A_surfxml_router_id, A_surfxml_router_coordinates);
299 void ETag_surfxml_cluster(){
300 simgrid::kernel::routing::ClusterCreationArgs cluster;
301 cluster.properties = property_sets.back();
302 property_sets.pop_back();
304 cluster.id = A_surfxml_cluster_id;
305 cluster.prefix = A_surfxml_cluster_prefix;
306 cluster.suffix = A_surfxml_cluster_suffix;
307 explodesRadical(A_surfxml_cluster_radical, &cluster.radicals);
309 cluster.speeds = xbt_parse_get_all_speeds(surf_parsed_filename, surf_parse_lineno, A_surfxml_cluster_speed,
310 "speed of cluster " + cluster.id);
311 cluster.core_amount = surf_parse_get_int(A_surfxml_cluster_core);
312 cluster.bw = xbt_parse_get_bandwidth(surf_parsed_filename, surf_parse_lineno, A_surfxml_cluster_bw,
313 "bw of cluster " + cluster.id);
314 cluster.lat = xbt_parse_get_time(surf_parsed_filename, surf_parse_lineno, A_surfxml_cluster_lat,
315 "lat of cluster " + cluster.id);
316 if(strcmp(A_surfxml_cluster_bb___bw,""))
317 cluster.bb_bw = xbt_parse_get_bandwidth(surf_parsed_filename, surf_parse_lineno, A_surfxml_cluster_bb___bw,
318 "bb_bw of cluster " + cluster.id);
319 if(strcmp(A_surfxml_cluster_bb___lat,""))
320 cluster.bb_lat = xbt_parse_get_time(surf_parsed_filename, surf_parse_lineno, A_surfxml_cluster_bb___lat,
321 "bb_lat of cluster " + cluster.id);
322 if(strcmp(A_surfxml_cluster_limiter___link,""))
323 cluster.limiter_link =
324 xbt_parse_get_bandwidth(surf_parsed_filename, surf_parse_lineno, A_surfxml_cluster_limiter___link,
325 "limiter_link of cluster " + cluster.id);
326 if(strcmp(A_surfxml_cluster_loopback___bw,""))
327 cluster.loopback_bw =
328 xbt_parse_get_bandwidth(surf_parsed_filename, surf_parse_lineno, A_surfxml_cluster_loopback___bw,
329 "loopback_bw of cluster " + cluster.id);
330 if(strcmp(A_surfxml_cluster_loopback___lat,""))
331 cluster.loopback_lat = xbt_parse_get_time(surf_parsed_filename, surf_parse_lineno, A_surfxml_cluster_loopback___lat,
332 "loopback_lat of cluster " + cluster.id);
334 switch(AX_surfxml_cluster_topology){
335 case A_surfxml_cluster_topology_FLAT:
336 cluster.topology = simgrid::kernel::routing::ClusterTopology::FLAT;
338 case A_surfxml_cluster_topology_TORUS:
339 cluster.topology = simgrid::kernel::routing::ClusterTopology::TORUS;
341 case A_surfxml_cluster_topology_FAT___TREE:
342 cluster.topology = simgrid::kernel::routing::ClusterTopology::FAT_TREE;
344 case A_surfxml_cluster_topology_DRAGONFLY:
345 cluster.topology = simgrid::kernel::routing::ClusterTopology::DRAGONFLY;
348 surf_parse_error(std::string("Invalid cluster topology for cluster ") + cluster.id);
350 cluster.topo_parameters = A_surfxml_cluster_topo___parameters;
351 cluster.router_id = A_surfxml_cluster_router___id;
353 switch (AX_surfxml_cluster_sharing___policy) {
354 case A_surfxml_cluster_sharing___policy_SHARED:
355 cluster.sharing_policy = simgrid::s4u::Link::SharingPolicy::SHARED;
357 case A_surfxml_cluster_sharing___policy_FULLDUPLEX:
358 XBT_WARN("FULLDUPLEX is now deprecated. Please update your platform file to use SPLITDUPLEX instead.");
359 cluster.sharing_policy = simgrid::s4u::Link::SharingPolicy::SPLITDUPLEX;
361 case A_surfxml_cluster_sharing___policy_SPLITDUPLEX:
362 cluster.sharing_policy = simgrid::s4u::Link::SharingPolicy::SPLITDUPLEX;
364 case A_surfxml_cluster_sharing___policy_FATPIPE:
365 cluster.sharing_policy = simgrid::s4u::Link::SharingPolicy::FATPIPE;
368 surf_parse_error(std::string("Invalid cluster sharing policy for cluster ") + cluster.id);
370 switch (AX_surfxml_cluster_bb___sharing___policy) {
371 case A_surfxml_cluster_bb___sharing___policy_FATPIPE:
372 cluster.bb_sharing_policy = simgrid::s4u::Link::SharingPolicy::FATPIPE;
374 case A_surfxml_cluster_bb___sharing___policy_SHARED:
375 cluster.bb_sharing_policy = simgrid::s4u::Link::SharingPolicy::SHARED;
378 surf_parse_error(std::string("Invalid bb sharing policy in cluster ") + cluster.id);
381 sg_platf_new_tag_cluster(&cluster);
384 void STag_surfxml_cluster(){
385 property_sets.emplace_back();
388 void STag_surfxml_cabinet(){
389 simgrid::kernel::routing::CabinetCreationArgs cabinet;
390 cabinet.id = A_surfxml_cabinet_id;
391 cabinet.prefix = A_surfxml_cabinet_prefix;
392 cabinet.suffix = A_surfxml_cabinet_suffix;
393 cabinet.speed = xbt_parse_get_speed(surf_parsed_filename, surf_parse_lineno, A_surfxml_cabinet_speed,
394 "speed of cabinet " + cabinet.id);
395 cabinet.bw = xbt_parse_get_bandwidth(surf_parsed_filename, surf_parse_lineno, A_surfxml_cabinet_bw,
396 "bw of cabinet " + cabinet.id);
397 cabinet.lat = xbt_parse_get_time(surf_parsed_filename, surf_parse_lineno, A_surfxml_cabinet_lat,
398 "lat of cabinet " + cabinet.id);
399 explodesRadical(A_surfxml_cabinet_radical, &cabinet.radicals);
401 sg_platf_new_cabinet(&cabinet);
404 void STag_surfxml_peer(){
405 simgrid::kernel::routing::PeerCreationArgs peer;
407 peer.id = std::string(A_surfxml_peer_id);
409 xbt_parse_get_speed(surf_parsed_filename, surf_parse_lineno, A_surfxml_peer_speed, "speed of peer " + peer.id);
410 peer.bw_in = xbt_parse_get_bandwidth(surf_parsed_filename, surf_parse_lineno, A_surfxml_peer_bw___in,
411 "bw_in of peer " + peer.id);
412 peer.bw_out = xbt_parse_get_bandwidth(surf_parsed_filename, surf_parse_lineno, A_surfxml_peer_bw___out,
413 "bw_out of peer " + peer.id);
414 peer.coord = A_surfxml_peer_coordinates;
415 peer.speed_trace = nullptr;
416 if (A_surfxml_peer_availability___file[0] != '\0') {
417 XBT_WARN("The availability_file attribute in <peer> is now deprecated. Please, use 'speed_file' instead.");
418 peer.speed_trace = simgrid::kernel::profile::ProfileBuilder::from_file(A_surfxml_peer_availability___file);
420 if (A_surfxml_peer_speed___file[0] != '\0')
421 peer.speed_trace = simgrid::kernel::profile::ProfileBuilder::from_file(A_surfxml_peer_speed___file);
422 peer.state_trace = A_surfxml_peer_state___file[0]
423 ? simgrid::kernel::profile::ProfileBuilder::from_file(A_surfxml_peer_state___file)
426 if (A_surfxml_peer_lat[0] != '\0')
427 XBT_WARN("The latency attribute in <peer> is now deprecated. Use the z coordinate instead of '%s'.",
430 sg_platf_new_peer(&peer);
433 void STag_surfxml_link(){
434 property_sets.emplace_back();
437 void ETag_surfxml_link(){
438 simgrid::kernel::routing::LinkCreationArgs link;
440 link.properties = property_sets.back();
441 property_sets.pop_back();
443 link.id = std::string(A_surfxml_link_id);
444 link.bandwidths = xbt_parse_get_bandwidths(surf_parsed_filename, surf_parse_lineno, A_surfxml_link_bandwidth,
445 "bandwidth of link " + link.id);
446 link.bandwidth_trace = A_surfxml_link_bandwidth___file[0]
447 ? simgrid::kernel::profile::ProfileBuilder::from_file(A_surfxml_link_bandwidth___file)
450 xbt_parse_get_time(surf_parsed_filename, surf_parse_lineno, A_surfxml_link_latency, "latency of link " + link.id);
451 link.latency_trace = A_surfxml_link_latency___file[0]
452 ? simgrid::kernel::profile::ProfileBuilder::from_file(A_surfxml_link_latency___file)
454 link.state_trace = A_surfxml_link_state___file[0]
455 ? simgrid::kernel::profile::ProfileBuilder::from_file(A_surfxml_link_state___file)
458 switch (A_surfxml_link_sharing___policy) {
459 case A_surfxml_link_sharing___policy_SHARED:
460 link.policy = simgrid::s4u::Link::SharingPolicy::SHARED;
462 case A_surfxml_link_sharing___policy_FATPIPE:
463 link.policy = simgrid::s4u::Link::SharingPolicy::FATPIPE;
465 case A_surfxml_link_sharing___policy_FULLDUPLEX:
466 XBT_WARN("FULLDUPLEX is now deprecated. Please update your platform file to use SPLITDUPLEX instead.");
467 link.policy = simgrid::s4u::Link::SharingPolicy::SPLITDUPLEX;
469 case A_surfxml_link_sharing___policy_SPLITDUPLEX:
470 link.policy = simgrid::s4u::Link::SharingPolicy::SPLITDUPLEX;
472 case A_surfxml_link_sharing___policy_WIFI:
473 link.policy = simgrid::s4u::Link::SharingPolicy::WIFI;
476 surf_parse_error(std::string("Invalid sharing policy in link ") + link.id);
479 sg_platf_new_link(&link);
482 void STag_surfxml_link___ctn()
484 const auto engine = simgrid::s4u::Engine::get_instance();
485 const simgrid::s4u::Link* link;
486 simgrid::s4u::LinkInRoute::Direction direction = simgrid::s4u::LinkInRoute::Direction::NONE;
487 switch (A_surfxml_link___ctn_direction) {
488 case AU_surfxml_link___ctn_direction:
489 case A_surfxml_link___ctn_direction_NONE:
490 link = engine->link_by_name(std::string(A_surfxml_link___ctn_id));
492 case A_surfxml_link___ctn_direction_UP:
493 link = engine->split_duplex_link_by_name(std::string(A_surfxml_link___ctn_id));
494 direction = simgrid::s4u::LinkInRoute::Direction::UP;
496 case A_surfxml_link___ctn_direction_DOWN:
497 link = engine->split_duplex_link_by_name(std::string(A_surfxml_link___ctn_id));
498 direction = simgrid::s4u::LinkInRoute::Direction::DOWN;
501 surf_parse_error(std::string("Invalid direction for link ") + A_surfxml_link___ctn_id);
505 switch (A_surfxml_link___ctn_direction) {
506 case A_surfxml_link___ctn_direction_UP:
507 dirname = " (upward)";
509 case A_surfxml_link___ctn_direction_DOWN:
510 dirname = " (downward)";
515 surf_parse_assert(link != nullptr, std::string("No such link: '") + A_surfxml_link___ctn_id + "'" + dirname);
516 parsed_link_list.emplace_back(link, direction);
519 void ETag_surfxml_backbone()
521 auto link = std::make_unique<simgrid::kernel::routing::LinkCreationArgs>();
523 link->id = std::string(A_surfxml_backbone_id);
524 link->bandwidths.push_back(xbt_parse_get_bandwidth(
525 surf_parsed_filename, surf_parse_lineno, A_surfxml_backbone_bandwidth, "bandwidth of backbone " + link->id));
526 link->latency = xbt_parse_get_time(surf_parsed_filename, surf_parse_lineno, A_surfxml_backbone_latency,
527 "latency of backbone " + link->id);
528 link->policy = simgrid::s4u::Link::SharingPolicy::SHARED;
530 routing_cluster_add_backbone(std::move(link));
533 void STag_surfxml_route(){
534 surf_parse_assert_netpoint(A_surfxml_route_src, "Route src='", "' does name a node.");
535 surf_parse_assert_netpoint(A_surfxml_route_dst, "Route dst='", "' does name a node.");
538 void STag_surfxml_ASroute(){
539 surf_parse_assert_netpoint(A_surfxml_ASroute_src, "ASroute src='", "' does name a node.");
540 surf_parse_assert_netpoint(A_surfxml_ASroute_dst, "ASroute dst='", "' does name a node.");
542 surf_parse_assert_netpoint(A_surfxml_ASroute_gw___src, "ASroute gw_src='", "' does name a node.");
543 surf_parse_assert_netpoint(A_surfxml_ASroute_gw___dst, "ASroute gw_dst='", "' does name a node.");
545 void STag_surfxml_zoneRoute(){
546 surf_parse_assert_netpoint(A_surfxml_zoneRoute_src, "zoneRoute src='", "' does name a node.");
547 surf_parse_assert_netpoint(A_surfxml_zoneRoute_dst, "zoneRoute dst='", "' does name a node.");
548 surf_parse_assert_netpoint(A_surfxml_zoneRoute_gw___src, "zoneRoute gw_src='", "' does name a node.");
549 surf_parse_assert_netpoint(A_surfxml_zoneRoute_gw___dst, "zoneRoute gw_dst='", "' does name a node.");
552 void STag_surfxml_bypassRoute(){
553 surf_parse_assert_netpoint(A_surfxml_bypassRoute_src, "bypassRoute src='", "' does name a node.");
554 surf_parse_assert_netpoint(A_surfxml_bypassRoute_dst, "bypassRoute dst='", "' does name a node.");
557 void STag_surfxml_bypassASroute(){
558 surf_parse_assert_netpoint(A_surfxml_bypassASroute_src, "bypassASroute src='", "' does name a node.");
559 surf_parse_assert_netpoint(A_surfxml_bypassASroute_dst, "bypassASroute dst='", "' does name a node.");
560 surf_parse_assert_netpoint(A_surfxml_bypassASroute_gw___src, "bypassASroute gw_src='", "' does name a node.");
561 surf_parse_assert_netpoint(A_surfxml_bypassASroute_gw___dst, "bypassASroute gw_dst='", "' does name a node.");
563 void STag_surfxml_bypassZoneRoute(){
564 surf_parse_assert_netpoint(A_surfxml_bypassZoneRoute_src, "bypassZoneRoute src='", "' does name a node.");
565 surf_parse_assert_netpoint(A_surfxml_bypassZoneRoute_dst, "bypassZoneRoute dst='", "' does name a node.");
566 surf_parse_assert_netpoint(A_surfxml_bypassZoneRoute_gw___src, "bypassZoneRoute gw_src='", "' does name a node.");
567 surf_parse_assert_netpoint(A_surfxml_bypassZoneRoute_gw___dst, "bypassZoneRoute gw_dst='", "' does name a node.");
570 void ETag_surfxml_route(){
571 simgrid::kernel::routing::RouteCreationArgs route;
573 route.src = sg_netpoint_by_name_or_null(A_surfxml_route_src); // tested to not be nullptr in start tag
574 route.dst = sg_netpoint_by_name_or_null(A_surfxml_route_dst); // tested to not be nullptr in start tag
575 route.symmetrical = (A_surfxml_route_symmetrical == AU_surfxml_route_symmetrical ||
576 A_surfxml_route_symmetrical == A_surfxml_route_symmetrical_YES ||
577 A_surfxml_route_symmetrical == A_surfxml_route_symmetrical_yes);
579 route.link_list.swap(parsed_link_list);
581 sg_platf_new_route(&route);
584 void ETag_surfxml_ASroute()
586 AX_surfxml_zoneRoute_src = AX_surfxml_ASroute_src;
587 AX_surfxml_zoneRoute_dst = AX_surfxml_ASroute_dst;
588 AX_surfxml_zoneRoute_gw___src = AX_surfxml_ASroute_gw___src;
589 AX_surfxml_zoneRoute_gw___dst = AX_surfxml_ASroute_gw___dst;
590 AX_surfxml_zoneRoute_symmetrical = (AT_surfxml_zoneRoute_symmetrical)AX_surfxml_ASroute_symmetrical;
591 ETag_surfxml_zoneRoute();
593 void ETag_surfxml_zoneRoute()
595 simgrid::kernel::routing::RouteCreationArgs ASroute;
597 ASroute.src = sg_netpoint_by_name_or_null(A_surfxml_zoneRoute_src); // tested to not be nullptr in start tag
598 ASroute.dst = sg_netpoint_by_name_or_null(A_surfxml_zoneRoute_dst); // tested to not be nullptr in start tag
600 ASroute.gw_src = sg_netpoint_by_name_or_null(A_surfxml_zoneRoute_gw___src); // tested to not be nullptr in start tag
601 ASroute.gw_dst = sg_netpoint_by_name_or_null(A_surfxml_zoneRoute_gw___dst); // tested to not be nullptr in start tag
603 ASroute.link_list.swap(parsed_link_list);
605 ASroute.symmetrical = (A_surfxml_zoneRoute_symmetrical == AU_surfxml_zoneRoute_symmetrical ||
606 A_surfxml_zoneRoute_symmetrical == A_surfxml_zoneRoute_symmetrical_YES ||
607 A_surfxml_zoneRoute_symmetrical == A_surfxml_zoneRoute_symmetrical_yes);
609 sg_platf_new_route(&ASroute);
612 void ETag_surfxml_bypassRoute(){
613 simgrid::kernel::routing::RouteCreationArgs route;
615 route.src = sg_netpoint_by_name_or_null(A_surfxml_bypassRoute_src); // tested to not be nullptr in start tag
616 route.dst = sg_netpoint_by_name_or_null(A_surfxml_bypassRoute_dst); // tested to not be nullptr in start tag
617 route.symmetrical = false;
619 route.link_list.swap(parsed_link_list);
621 sg_platf_new_bypass_route(&route);
624 void ETag_surfxml_bypassASroute()
626 AX_surfxml_bypassZoneRoute_src = AX_surfxml_bypassASroute_src;
627 AX_surfxml_bypassZoneRoute_dst = AX_surfxml_bypassASroute_dst;
628 AX_surfxml_bypassZoneRoute_gw___src = AX_surfxml_bypassASroute_gw___src;
629 AX_surfxml_bypassZoneRoute_gw___dst = AX_surfxml_bypassASroute_gw___dst;
630 ETag_surfxml_bypassZoneRoute();
632 void ETag_surfxml_bypassZoneRoute()
634 simgrid::kernel::routing::RouteCreationArgs ASroute;
636 ASroute.src = sg_netpoint_by_name_or_null(A_surfxml_bypassZoneRoute_src);
637 ASroute.dst = sg_netpoint_by_name_or_null(A_surfxml_bypassZoneRoute_dst);
638 ASroute.link_list.swap(parsed_link_list);
640 ASroute.symmetrical = false;
642 ASroute.gw_src = sg_netpoint_by_name_or_null(A_surfxml_bypassZoneRoute_gw___src);
643 ASroute.gw_dst = sg_netpoint_by_name_or_null(A_surfxml_bypassZoneRoute_gw___dst);
645 sg_platf_new_bypass_route(&ASroute);
648 void ETag_surfxml_trace(){
649 simgrid::kernel::routing::ProfileCreationArgs trace;
651 trace.id = A_surfxml_trace_id;
652 trace.file = A_surfxml_trace_file;
653 trace.periodicity = surf_parse_get_double(A_surfxml_trace_periodicity);
654 trace.pc_data = surfxml_pcdata;
656 sg_platf_new_trace(&trace);
659 void STag_surfxml_trace___connect()
661 simgrid::kernel::routing::TraceConnectCreationArgs trace_connect;
663 trace_connect.element = A_surfxml_trace___connect_element;
664 trace_connect.trace = A_surfxml_trace___connect_trace;
666 switch (A_surfxml_trace___connect_kind) {
667 case AU_surfxml_trace___connect_kind:
668 case A_surfxml_trace___connect_kind_SPEED:
669 trace_connect.kind = simgrid::kernel::routing::TraceConnectKind::SPEED;
671 case A_surfxml_trace___connect_kind_BANDWIDTH:
672 trace_connect.kind = simgrid::kernel::routing::TraceConnectKind::BANDWIDTH;
674 case A_surfxml_trace___connect_kind_HOST___AVAIL:
675 trace_connect.kind = simgrid::kernel::routing::TraceConnectKind::HOST_AVAIL;
677 case A_surfxml_trace___connect_kind_LATENCY:
678 trace_connect.kind = simgrid::kernel::routing::TraceConnectKind::LATENCY;
680 case A_surfxml_trace___connect_kind_LINK___AVAIL:
681 trace_connect.kind = simgrid::kernel::routing::TraceConnectKind::LINK_AVAIL;
684 surf_parse_error("Invalid trace kind");
686 sg_platf_trace_connect(&trace_connect);
689 void STag_surfxml_AS()
691 AX_surfxml_zone_id = AX_surfxml_AS_id;
692 AX_surfxml_zone_routing = AX_surfxml_AS_routing;
696 void ETag_surfxml_AS()
701 void STag_surfxml_zone()
703 property_sets.emplace_back();
704 simgrid::kernel::routing::ZoneCreationArgs zone;
705 zone.id = A_surfxml_zone_id;
706 zone.routing = A_surfxml_zone_routing;
707 sg_platf_new_zone_begin(&zone);
710 void ETag_surfxml_zone()
712 sg_platf_new_zone_set_properties(property_sets.back());
713 property_sets.pop_back();
714 sg_platf_new_zone_seal();
717 void STag_surfxml_config()
719 property_sets.emplace_back();
720 XBT_DEBUG("START configuration name = %s",A_surfxml_config_id);
721 if (_sg_cfg_init_status == 2) {
722 surf_parse_error("All <config> tags must be given before any platform elements (such as <zone>, <host>, <cluster>, "
727 void ETag_surfxml_config()
729 // Sort config elements before applying.
730 // That's a little waste of time, but not doing so would break the tests
731 auto current_property_set = property_sets.back();
733 std::vector<std::string> keys;
734 for (auto const& [key, _] : current_property_set) {
737 std::sort(keys.begin(), keys.end());
738 for (const std::string& key : keys) {
739 if (simgrid::config::is_default(key.c_str())) {
740 std::string cfg = key + ":" + current_property_set.at(key);
741 simgrid::config::set_parse(cfg);
743 XBT_INFO("The custom configuration '%s' is already defined by user!", key.c_str());
745 XBT_DEBUG("End configuration name = %s",A_surfxml_config_id);
747 property_sets.pop_back();
750 static std::vector<std::string> arguments;
752 void STag_surfxml_process()
754 AX_surfxml_actor_function = AX_surfxml_process_function;
755 STag_surfxml_actor();
758 void STag_surfxml_actor()
760 property_sets.emplace_back();
761 arguments.assign(1, A_surfxml_actor_function);
764 void ETag_surfxml_process()
766 AX_surfxml_actor_host = AX_surfxml_process_host;
767 AX_surfxml_actor_function = AX_surfxml_process_function;
768 AX_surfxml_actor_start___time = AX_surfxml_process_start___time;
769 AX_surfxml_actor_kill___time = AX_surfxml_process_kill___time;
770 AX_surfxml_actor_on___failure = (AT_surfxml_actor_on___failure)AX_surfxml_process_on___failure;
771 ETag_surfxml_actor();
774 void ETag_surfxml_actor()
776 simgrid::kernel::routing::ActorCreationArgs actor;
778 actor.properties = property_sets.back();
779 property_sets.pop_back();
781 actor.args.swap(arguments);
782 actor.host = A_surfxml_actor_host;
783 actor.function = A_surfxml_actor_function;
784 actor.start_time = surf_parse_get_double(A_surfxml_actor_start___time);
785 actor.kill_time = surf_parse_get_double(A_surfxml_actor_kill___time);
787 switch (A_surfxml_actor_on___failure) {
788 case AU_surfxml_actor_on___failure:
789 case A_surfxml_actor_on___failure_DIE:
790 actor.restart_on_failure = false;
792 case A_surfxml_actor_on___failure_RESTART:
793 actor.restart_on_failure = true;
796 surf_parse_error("Invalid on failure behavior");
799 sg_platf_new_actor(&actor);
802 void STag_surfxml_argument(){
803 arguments.emplace_back(A_surfxml_argument_value);
806 void STag_surfxml_model___prop(){
807 XBT_INFO("Deprecated tag <model_prop> ignored");
810 void ETag_surfxml_prop(){/* Nothing to do */}
811 void STag_surfxml_random(){/* Nothing to do */}
812 void ETag_surfxml_random(){/* Nothing to do */}
813 void ETag_surfxml_trace___connect()
814 { /* Nothing to do */
816 void STag_surfxml_trace()
817 { /* Nothing to do */
819 void ETag_surfxml_router(){/*Nothing to do*/}
820 void ETag_surfxml_host___link(){/* Nothing to do */}
821 void ETag_surfxml_cabinet(){/* Nothing to do */}
822 void ETag_surfxml_peer(){/* Nothing to do */}
823 void STag_surfxml_backbone(){/* Nothing to do */}
824 void ETag_surfxml_link___ctn(){/* Nothing to do */}
825 void ETag_surfxml_argument(){/* Nothing to do */}
826 void ETag_surfxml_model___prop(){/* Nothing to do */}
828 /* Open and Close parse file */
829 YY_BUFFER_STATE surf_input_buffer;
831 void surf_parse_open(const std::string& file)
833 surf_parsed_filename = file;
834 std::string dir = simgrid::xbt::Path(file).get_dir_name();
835 surf_path.push_back(dir);
837 surf_file_to_parse = surf_fopen(file, "r");
838 if (surf_file_to_parse == nullptr)
839 throw std::invalid_argument(std::string("Unable to open '") + file + "' from '" + simgrid::xbt::Path().get_name() +
840 "'. Does this file exist?");
841 surf_input_buffer = surf_parse__create_buffer(surf_file_to_parse, YY_BUF_SIZE);
842 surf_parse__switch_to_buffer(surf_input_buffer);
843 surf_parse_lineno = 1;
846 void surf_parse_close()
848 surf_path.pop_back(); // remove the dirname of the opened file, that was added in surf_parse_open()
850 if (surf_file_to_parse) {
851 surf_parse__delete_buffer(surf_input_buffer);
852 fclose(surf_file_to_parse);
853 surf_file_to_parse = nullptr; //Must be reset for Bypass
857 /* Call the lexer to parse the currently opened file */
860 bool err = surf_parse_lex();
861 surf_parse_assert(not err, "Flex returned an error code");