1 /* Copyright (c) 2006-2020. 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/sg_config.hpp"
10 #include "src/kernel/resource/profile/FutureEvtSet.hpp"
11 #include "src/kernel/resource/profile/Profile.hpp"
12 #include "src/surf/network_interface.hpp"
13 #include "src/surf/surf_interface.hpp"
14 #include "src/surf/xml/platf_private.hpp"
15 #include "surf/surf.hpp"
16 #include "xbt/file.hpp"
18 #include <boost/algorithm/string.hpp>
19 #include <boost/algorithm/string/classification.hpp>
20 #include <boost/algorithm/string/split.hpp>
23 #include <unordered_map>
26 #include "simgrid_dtd.c"
28 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_parse, surf, "Logging specific to the SURF parsing module");
30 static std::string surf_parsed_filename; // Currently parsed file (for the error messages)
31 std::vector<simgrid::kernel::resource::LinkImpl*>
32 parsed_link_list; /* temporary store of current link list of a route */
33 std::vector<simgrid::kernel::resource::DiskImpl*> parsed_disk_list; /* temporary store of current disk list of a host */
37 void surf_parse_assert(bool cond, const std::string& msg)
40 surf_parse_error(msg);
43 void surf_parse_error(const std::string& msg)
45 throw simgrid::ParseError(surf_parsed_filename, surf_parse_lineno, msg);
48 void surf_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 surf_parse_error(std::move(msg));
79 double surf_parse_get_double(const std::string& s)
83 } catch (const std::invalid_argument&) {
84 surf_parse_error(s + " is not a double");
88 int surf_parse_get_int(const std::string& s)
92 } catch (const std::invalid_argument&) {
93 surf_parse_error(s + " is not a double");
99 /* Turn something like "1-4,6,9-11" into the vector {1,2,3,4,6,9,10,11} */
100 std::vector<int>* explodesRadical(const std::string& radicals)
102 std::vector<int>* exploded = new std::vector<int>();
105 std::vector<std::string> radical_elements;
106 boost::split(radical_elements, radicals, boost::is_any_of(","));
107 for (auto const& group : radical_elements) {
108 std::vector<std::string> radical_ends;
109 boost::split(radical_ends, group, boost::is_any_of("-"));
110 int start = surf_parse_get_int(radical_ends.front());
113 switch (radical_ends.size()) {
118 end = surf_parse_get_int(radical_ends.back());
121 surf_parse_error(std::string("Malformed radical: ") + group);
123 for (int i = start; i <= end; i++)
124 exploded->push_back(i);
130 class unit_scale : public std::unordered_map<std::string, double> {
132 using std::unordered_map<std::string, double>::unordered_map;
133 // tuples are : <unit, value for unit, base (2 or 10), true if abbreviated>
134 explicit unit_scale(std::initializer_list<std::tuple<const std::string, double, int, bool>> generators);
137 unit_scale::unit_scale(std::initializer_list<std::tuple<const std::string, double, int, bool>> generators)
139 for (const auto& gen : generators) {
140 const std::string& unit = std::get<0>(gen);
141 double value = std::get<1>(gen);
142 const int base = std::get<2>(gen);
143 const bool abbrev = std::get<3>(gen);
145 std::vector<std::string> prefixes;
149 prefixes = abbrev ? std::vector<std::string>{"Ki", "Mi", "Gi", "Ti", "Pi", "Ei", "Zi", "Yi"}
150 : std::vector<std::string>{"kibi", "mebi", "gibi", "tebi", "pebi", "exbi", "zebi", "yobi"};
154 prefixes = abbrev ? std::vector<std::string>{"k", "M", "G", "T", "P", "E", "Z", "Y"}
155 : std::vector<std::string>{"kilo", "mega", "giga", "tera", "peta", "exa", "zeta", "yotta"};
160 emplace(unit, value);
161 for (const auto& prefix : prefixes) {
163 emplace(prefix + unit, value);
168 /* Note: no warning is issued for unit-less values when `name' is empty. */
169 double surf_parse_get_value_with_unit(const char* string, const unit_scale& units, const char* entity_kind,
170 const std::string& name, const char* error_msg, const char* default_unit)
174 double res = strtod(string, &endptr);
175 const char* ptr = endptr; // for const-correctness
177 surf_parse_error(std::string("value out of range: ") + string);
179 surf_parse_error(std::string("cannot parse number:") + string);
180 if (ptr[0] == '\0') {
181 // Ok, 0 can be unit-less
182 if (res != 0 && not name.empty())
183 XBT_WARN("Deprecated unit-less value '%s' for %s %s. %s", string, entity_kind, name.c_str(), error_msg);
186 auto u = units.find(ptr);
187 if (u == units.end())
188 surf_parse_error(std::string("unknown unit: ") + ptr);
189 return res * u->second;
193 double surf_parse_get_time(const char* string, const char* entity_kind, const std::string& name)
195 static const unit_scale units{std::make_pair("w", 7 * 24 * 60 * 60),
196 std::make_pair("d", 24 * 60 * 60),
197 std::make_pair("h", 60 * 60),
198 std::make_pair("m", 60),
199 std::make_pair("s", 1.0),
200 std::make_pair("ms", 1e-3),
201 std::make_pair("us", 1e-6),
202 std::make_pair("ns", 1e-9),
203 std::make_pair("ps", 1e-12)};
204 return surf_parse_get_value_with_unit(string, units, entity_kind, name,
205 "Append 's' to your time to get seconds", "s");
208 double surf_parse_get_size(const char* string, const char* entity_kind, const std::string& name)
210 static const unit_scale units{std::make_tuple("b", 0.125, 2, true), std::make_tuple("b", 0.125, 10, true),
211 std::make_tuple("B", 1.0, 2, true), std::make_tuple("B", 1.0, 10, true)};
212 return surf_parse_get_value_with_unit(string, units, entity_kind, name,
213 "Append 'B' to get bytes (or 'b' for bits but 1B = 8b).", "B");
216 double surf_parse_get_bandwidth(const char* string, const char* entity_kind, const std::string& name)
218 static const unit_scale units{std::make_tuple("bps", 0.125, 2, true), std::make_tuple("bps", 0.125, 10, true),
219 std::make_tuple("Bps", 1.0, 2, true), std::make_tuple("Bps", 1.0, 10, true)};
220 return surf_parse_get_value_with_unit(string, units, entity_kind, name,
221 "Append 'Bps' to get bytes per second (or 'bps' for bits but 1Bps = 8bps)", "Bps");
224 std::vector<double> surf_parse_get_bandwidths(const char* string, const char* entity_kind, const std::string& name)
226 static const unit_scale units{std::make_tuple("bps", 0.125, 2, true), std::make_tuple("bps", 0.125, 10, true),
227 std::make_tuple("Bps", 1.0, 2, true), std::make_tuple("Bps", 1.0, 10, true)};
229 std::vector<double> bandwidths;
230 std::vector<std::string> tokens;
231 boost::split(tokens, string, boost::is_any_of(";"));
232 for (auto token : tokens) {
233 bandwidths.push_back(surf_parse_get_value_with_unit(
234 token.c_str(), units, entity_kind, name,
235 "Append 'Bps' to get bytes per second (or 'bps' for bits but 1Bps = 8bps)", "Bps"));
241 double surf_parse_get_speed(const char* string, const char* entity_kind, const std::string& name)
243 static const unit_scale units{std::make_tuple("f", 1.0, 10, true), std::make_tuple("flops", 1.0, 10, false)};
244 return surf_parse_get_value_with_unit(string, units, entity_kind, name,
245 "Append 'f' or 'flops' to your speed to get flop per second", "f");
248 static std::vector<double> surf_parse_get_all_speeds(char* speeds, const char* entity_kind, const std::string& id)
250 std::vector<double> speed_per_pstate;
252 if (strchr(speeds, ',') == nullptr){
253 double speed = surf_parse_get_speed(speeds, entity_kind, id);
254 speed_per_pstate.push_back(speed);
256 std::vector<std::string> pstate_list;
257 boost::split(pstate_list, speeds, boost::is_any_of(","));
258 for (auto speed_str : pstate_list) {
259 boost::trim(speed_str);
260 double speed = surf_parse_get_speed(speed_str.c_str(), entity_kind, id);
261 speed_per_pstate.push_back(speed);
262 XBT_DEBUG("Speed value: %f", speed);
265 return speed_per_pstate;
269 * All the callback lists that can be overridden anywhere.
270 * (this list should probably be reduced to the bare minimum to allow the models to work)
273 /* make sure these symbols are defined as strong ones in this file so that the linker can resolve them */
275 std::vector<std::unordered_map<std::string, std::string>*> property_sets;
277 /* The default current property receiver. Setup in the corresponding opening callbacks. */
278 std::unordered_map<std::string, std::string>* current_model_property_set = nullptr;
280 FILE *surf_file_to_parse = nullptr;
282 /* Stuff relative to storage */
283 void STag_surfxml_storage()
285 XBT_DEBUG("STag_surfxml_storage");
286 property_sets.push_back(new std::unordered_map<std::string, std::string>());
289 void ETag_surfxml_storage()
291 simgrid::kernel::routing::StorageCreationArgs storage;
293 storage.properties = property_sets.back();
294 property_sets.pop_back();
296 storage.id = A_surfxml_storage_id;
297 storage.type_id = A_surfxml_storage_typeId;
298 storage.content = A_surfxml_storage_content;
299 storage.attach = A_surfxml_storage_attach;
301 sg_platf_new_storage(&storage);
303 void STag_surfxml_storage___type()
305 XBT_DEBUG("STag_surfxml_storage___type");
306 property_sets.push_back(new std::unordered_map<std::string, std::string>());
307 xbt_assert(current_model_property_set == nullptr, "Someone forgot to reset the model property set to nullptr in its closing tag (or XML malformed)");
309 void ETag_surfxml_storage___type()
311 simgrid::kernel::routing::StorageTypeCreationArgs storage_type;
313 storage_type.properties = property_sets.back();
314 property_sets.pop_back();
316 storage_type.model_properties = current_model_property_set;
317 current_model_property_set = nullptr;
319 storage_type.content = A_surfxml_storage___type_content;
320 storage_type.id = A_surfxml_storage___type_id;
321 storage_type.model = A_surfxml_storage___type_model;
323 surf_parse_get_size(A_surfxml_storage___type_size, "size of storage type", storage_type.id.c_str());
324 sg_platf_new_storage_type(&storage_type);
327 void STag_surfxml_mount()
329 XBT_DEBUG("STag_surfxml_mount");
332 void ETag_surfxml_mount()
334 simgrid::kernel::routing::MountCreationArgs mount;
336 mount.name = A_surfxml_mount_name;
337 mount.storageId = A_surfxml_mount_storageId;
338 sg_platf_new_mount(&mount);
341 void STag_surfxml_include()
343 xbt_die("<include> tag was removed in SimGrid v3.18. Please stop using it now.");
346 void ETag_surfxml_include()
348 /* Won't happen since <include> is now removed since v3.18. */
351 /* Stag and Etag parse functions */
352 void STag_surfxml_platform() {
353 double version = surf_parse_get_double(A_surfxml_platform_version);
355 surf_parse_assert((version >= 1.0), "******* BIG FAT WARNING *********\n "
356 "You're using an ancient XML file.\n"
357 "Since SimGrid 3.1, units are Bytes, Flops, and seconds "
358 "instead of MBytes, MFlops and seconds.\n"
360 "Use simgrid_update_xml to update your file automatically. "
361 "This program is installed automatically with SimGrid, or "
362 "available in the tools/ directory of the source archive.\n"
364 "Please check also out the SURF section of the ChangeLog for "
365 "the 3.1 version for more information. \n"
367 "Last, do not forget to also update your values for "
368 "the calls to MSG_task_create (if any).");
369 surf_parse_assert((version >= 3.0), "******* BIG FAT WARNING *********\n "
370 "You're using an old XML file.\n"
371 "Use simgrid_update_xml to update your file automatically. "
372 "This program is installed automatically with SimGrid, or "
373 "available in the tools/ directory of the source archive.");
374 surf_parse_assert((version >= 4.0),
375 std::string("******* THIS FILE IS TOO OLD (v:")+std::to_string(version)+") *********\n "
376 "Changes introduced in SimGrid 3.13:\n"
377 " - 'power' attribute of hosts (and others) got renamed to 'speed'.\n"
378 " - In <trace_connect>, attribute kind=\"POWER\" is now kind=\"SPEED\".\n"
379 " - DOCTYPE now point to the rignt URL.\n"
380 " - speed, bandwidth and latency attributes now MUST have an explicit unit (f, Bps, s by default)"
382 "Use simgrid_update_xml to update your file automatically. "
383 "This program is installed automatically with SimGrid, or "
384 "available in the tools/ directory of the source archive.");
386 XBT_INFO("You're using a v%.1f XML file (%s) while the current standard is v4.1 "
387 "That's fine, the new version is backward compatible. \n\n"
388 "Use simgrid_update_xml to update your file automatically to get rid of this warning. "
389 "This program is installed automatically with SimGrid, or "
390 "available in the tools/ directory of the source archive.",
391 version, surf_parsed_filename.c_str());
393 surf_parse_assert(version <= 4.1,
394 std::string("******* THIS FILE COMES FROM THE FUTURE (v:")+std::to_string(version)+") *********\n "
395 "The most recent formalism that this version of SimGrid understands is v4.1.\n"
396 "Please update your code, or use another, more adapted, file.");
398 void ETag_surfxml_platform(){
399 simgrid::s4u::Engine::on_platform_created();
402 void STag_surfxml_host(){
403 property_sets.push_back(new std::unordered_map<std::string, std::string>());
406 void STag_surfxml_prop()
408 property_sets.back()->insert({A_surfxml_prop_id, A_surfxml_prop_value});
409 XBT_DEBUG("add prop %s=%s into current property set %p", A_surfxml_prop_id, A_surfxml_prop_value,
410 property_sets.back());
413 void ETag_surfxml_host() {
414 simgrid::kernel::routing::HostCreationArgs host;
416 host.properties = property_sets.back();
417 property_sets.pop_back();
419 host.id = A_surfxml_host_id;
421 host.speed_per_pstate = surf_parse_get_all_speeds(A_surfxml_host_speed, "speed of host", host.id);
423 XBT_DEBUG("pstate: %s", A_surfxml_host_pstate);
424 host.core_amount = surf_parse_get_int(A_surfxml_host_core);
426 host.speed_trace = nullptr;
427 if (A_surfxml_host_availability___file[0] != '\0') {
428 XBT_WARN("The availability_file attribute in <host> is now deprecated. Please, use 'speed_file' instead.");
429 host.speed_trace = simgrid::kernel::profile::Profile::from_file(A_surfxml_host_availability___file);
431 if (A_surfxml_host_speed___file[0] != '\0')
432 host.speed_trace = simgrid::kernel::profile::Profile::from_file(A_surfxml_host_speed___file);
433 host.state_trace = A_surfxml_host_state___file[0]
434 ? simgrid::kernel::profile::Profile::from_file(A_surfxml_host_state___file)
436 host.pstate = surf_parse_get_int(A_surfxml_host_pstate);
437 host.coord = A_surfxml_host_coordinates;
438 host.disks.swap(parsed_disk_list);
440 sg_platf_new_host(&host);
443 void STag_surfxml_disk() {
444 property_sets.push_back(new std::unordered_map<std::string, std::string>());
447 void ETag_surfxml_disk() {
448 simgrid::kernel::routing::DiskCreationArgs disk;
449 disk.properties = property_sets.back();
450 property_sets.pop_back();
452 disk.id = A_surfxml_disk_id;
453 disk.read_bw = surf_parse_get_bandwidth(A_surfxml_disk_read___bw, "read_bw of disk ", disk.id);
454 disk.write_bw = surf_parse_get_bandwidth(A_surfxml_disk_write___bw, "write_bw of disk ", disk.id);
456 parsed_disk_list.push_back(sg_platf_new_disk(&disk));
459 void STag_surfxml_host___link(){
460 XBT_DEBUG("Create a Host_link for %s",A_surfxml_host___link_id);
461 simgrid::kernel::routing::HostLinkCreationArgs host_link;
463 host_link.id = A_surfxml_host___link_id;
464 host_link.link_up = A_surfxml_host___link_up;
465 host_link.link_down = A_surfxml_host___link_down;
466 sg_platf_new_hostlink(&host_link);
469 void STag_surfxml_router(){
470 sg_platf_new_router(A_surfxml_router_id, A_surfxml_router_coordinates);
473 void ETag_surfxml_cluster(){
474 simgrid::kernel::routing::ClusterCreationArgs cluster;
475 cluster.properties = property_sets.back();
476 property_sets.pop_back();
478 cluster.id = A_surfxml_cluster_id;
479 cluster.prefix = A_surfxml_cluster_prefix;
480 cluster.suffix = A_surfxml_cluster_suffix;
481 cluster.radicals = explodesRadical(A_surfxml_cluster_radical);
482 cluster.speeds = surf_parse_get_all_speeds(A_surfxml_cluster_speed, "speed of cluster", cluster.id);
483 cluster.core_amount = surf_parse_get_int(A_surfxml_cluster_core);
484 cluster.bw = surf_parse_get_bandwidth(A_surfxml_cluster_bw, "bw of cluster", cluster.id);
485 cluster.lat = surf_parse_get_time(A_surfxml_cluster_lat, "lat of cluster", cluster.id);
486 if(strcmp(A_surfxml_cluster_bb___bw,""))
487 cluster.bb_bw = surf_parse_get_bandwidth(A_surfxml_cluster_bb___bw, "bb_bw of cluster", cluster.id);
488 if(strcmp(A_surfxml_cluster_bb___lat,""))
489 cluster.bb_lat = surf_parse_get_time(A_surfxml_cluster_bb___lat, "bb_lat of cluster", cluster.id);
490 if(strcmp(A_surfxml_cluster_limiter___link,""))
491 cluster.limiter_link = surf_parse_get_bandwidth(A_surfxml_cluster_limiter___link, "limiter_link of cluster", cluster.id);
492 if(strcmp(A_surfxml_cluster_loopback___bw,""))
493 cluster.loopback_bw = surf_parse_get_bandwidth(A_surfxml_cluster_loopback___bw, "loopback_bw of cluster", cluster.id);
494 if(strcmp(A_surfxml_cluster_loopback___lat,""))
495 cluster.loopback_lat = surf_parse_get_time(A_surfxml_cluster_loopback___lat, "loopback_lat of cluster", cluster.id);
497 switch(AX_surfxml_cluster_topology){
498 case A_surfxml_cluster_topology_FLAT:
499 cluster.topology = simgrid::kernel::routing::ClusterTopology::FLAT;
501 case A_surfxml_cluster_topology_TORUS:
502 cluster.topology = simgrid::kernel::routing::ClusterTopology::TORUS;
504 case A_surfxml_cluster_topology_FAT___TREE:
505 cluster.topology = simgrid::kernel::routing::ClusterTopology::FAT_TREE;
507 case A_surfxml_cluster_topology_DRAGONFLY:
508 cluster.topology = simgrid::kernel::routing::ClusterTopology::DRAGONFLY;
511 surf_parse_error(std::string("Invalid cluster topology for cluster ") + cluster.id);
513 cluster.topo_parameters = A_surfxml_cluster_topo___parameters;
514 cluster.router_id = A_surfxml_cluster_router___id;
516 switch (AX_surfxml_cluster_sharing___policy) {
517 case A_surfxml_cluster_sharing___policy_SHARED:
518 cluster.sharing_policy = simgrid::s4u::Link::SharingPolicy::SHARED;
520 case A_surfxml_cluster_sharing___policy_FULLDUPLEX:
521 XBT_WARN("FULLDUPLEX is now deprecated. Please update your platform file to use SPLITDUPLEX instead.");
522 cluster.sharing_policy = simgrid::s4u::Link::SharingPolicy::SPLITDUPLEX;
524 case A_surfxml_cluster_sharing___policy_SPLITDUPLEX:
525 cluster.sharing_policy = simgrid::s4u::Link::SharingPolicy::SPLITDUPLEX;
527 case A_surfxml_cluster_sharing___policy_FATPIPE:
528 cluster.sharing_policy = simgrid::s4u::Link::SharingPolicy::FATPIPE;
531 surf_parse_error(std::string("Invalid cluster sharing policy for cluster ") + cluster.id);
533 switch (AX_surfxml_cluster_bb___sharing___policy) {
534 case A_surfxml_cluster_bb___sharing___policy_FATPIPE:
535 cluster.bb_sharing_policy = simgrid::s4u::Link::SharingPolicy::FATPIPE;
537 case A_surfxml_cluster_bb___sharing___policy_SHARED:
538 cluster.bb_sharing_policy = simgrid::s4u::Link::SharingPolicy::SHARED;
541 surf_parse_error(std::string("Invalid bb sharing policy in cluster ") + cluster.id);
544 sg_platf_new_cluster(&cluster);
547 void STag_surfxml_cluster(){
548 property_sets.push_back(new std::unordered_map<std::string, std::string>());
551 void STag_surfxml_cabinet(){
552 simgrid::kernel::routing::CabinetCreationArgs cabinet;
553 cabinet.id = A_surfxml_cabinet_id;
554 cabinet.prefix = A_surfxml_cabinet_prefix;
555 cabinet.suffix = A_surfxml_cabinet_suffix;
556 cabinet.speed = surf_parse_get_speed(A_surfxml_cabinet_speed, "speed of cabinet", cabinet.id.c_str());
557 cabinet.bw = surf_parse_get_bandwidth(A_surfxml_cabinet_bw, "bw of cabinet", cabinet.id.c_str());
558 cabinet.lat = surf_parse_get_time(A_surfxml_cabinet_lat, "lat of cabinet", cabinet.id.c_str());
559 cabinet.radicals = explodesRadical(A_surfxml_cabinet_radical);
561 sg_platf_new_cabinet(&cabinet);
564 void STag_surfxml_peer(){
565 simgrid::kernel::routing::PeerCreationArgs peer;
567 peer.id = std::string(A_surfxml_peer_id);
568 peer.speed = surf_parse_get_speed(A_surfxml_peer_speed, "speed of peer", peer.id.c_str());
569 peer.bw_in = surf_parse_get_bandwidth(A_surfxml_peer_bw___in, "bw_in of peer", peer.id.c_str());
570 peer.bw_out = surf_parse_get_bandwidth(A_surfxml_peer_bw___out, "bw_out of peer", peer.id.c_str());
571 peer.coord = A_surfxml_peer_coordinates;
572 peer.speed_trace = nullptr;
573 if (A_surfxml_peer_availability___file[0] != '\0') {
574 XBT_WARN("The availability_file attribute in <peer> is now deprecated. Please, use 'speed_file' instead.");
575 peer.speed_trace = simgrid::kernel::profile::Profile::from_file(A_surfxml_peer_availability___file);
577 if (A_surfxml_peer_speed___file[0] != '\0')
578 peer.speed_trace = simgrid::kernel::profile::Profile::from_file(A_surfxml_peer_speed___file);
579 peer.state_trace = A_surfxml_peer_state___file[0]
580 ? simgrid::kernel::profile::Profile::from_file(A_surfxml_peer_state___file)
583 if (A_surfxml_peer_lat[0] != '\0')
584 XBT_WARN("The latency attribute in <peer> is now deprecated. Use the z coordinate instead of '%s'.",
587 sg_platf_new_peer(&peer);
590 void STag_surfxml_link(){
591 property_sets.push_back(new std::unordered_map<std::string, std::string>());
594 void ETag_surfxml_link(){
595 simgrid::kernel::routing::LinkCreationArgs link;
597 link.properties = property_sets.back();
598 property_sets.pop_back();
600 link.id = std::string(A_surfxml_link_id);
601 link.bandwidths = surf_parse_get_bandwidths(A_surfxml_link_bandwidth, "bandwidth of link", link.id.c_str());
602 link.bandwidth_trace = A_surfxml_link_bandwidth___file[0]
603 ? simgrid::kernel::profile::Profile::from_file(A_surfxml_link_bandwidth___file)
605 link.latency = surf_parse_get_time(A_surfxml_link_latency, "latency of link", link.id.c_str());
606 link.latency_trace = A_surfxml_link_latency___file[0]
607 ? simgrid::kernel::profile::Profile::from_file(A_surfxml_link_latency___file)
609 link.state_trace = A_surfxml_link_state___file[0]
610 ? simgrid::kernel::profile::Profile::from_file(A_surfxml_link_state___file)
613 switch (A_surfxml_link_sharing___policy) {
614 case A_surfxml_link_sharing___policy_SHARED:
615 link.policy = simgrid::s4u::Link::SharingPolicy::SHARED;
617 case A_surfxml_link_sharing___policy_FATPIPE:
618 link.policy = simgrid::s4u::Link::SharingPolicy::FATPIPE;
620 case A_surfxml_link_sharing___policy_FULLDUPLEX:
621 XBT_WARN("FULLDUPLEX is now deprecated. Please update your platform file to use SPLITDUPLEX instead.");
622 link.policy = simgrid::s4u::Link::SharingPolicy::SPLITDUPLEX;
624 case A_surfxml_link_sharing___policy_SPLITDUPLEX:
625 link.policy = simgrid::s4u::Link::SharingPolicy::SPLITDUPLEX;
627 case A_surfxml_link_sharing___policy_WIFI:
628 link.policy = simgrid::s4u::Link::SharingPolicy::WIFI;
631 surf_parse_error(std::string("Invalid sharing policy in link ") + link.id);
634 sg_platf_new_link(&link);
637 void STag_surfxml_link___ctn()
639 simgrid::kernel::resource::LinkImpl* link = nullptr;
640 switch (A_surfxml_link___ctn_direction) {
641 case AU_surfxml_link___ctn_direction:
642 case A_surfxml_link___ctn_direction_NONE:
643 link = simgrid::s4u::Link::by_name(std::string(A_surfxml_link___ctn_id))->get_impl();
645 case A_surfxml_link___ctn_direction_UP:
646 link = simgrid::s4u::Link::by_name(std::string(A_surfxml_link___ctn_id) + "_UP")->get_impl();
648 case A_surfxml_link___ctn_direction_DOWN:
649 link = simgrid::s4u::Link::by_name(std::string(A_surfxml_link___ctn_id) + "_DOWN")->get_impl();
652 surf_parse_error(std::string("Invalid direction for link ") + A_surfxml_link___ctn_id);
655 const char* dirname = "";
656 switch (A_surfxml_link___ctn_direction) {
657 case A_surfxml_link___ctn_direction_UP:
658 dirname = " (upward)";
660 case A_surfxml_link___ctn_direction_DOWN:
661 dirname = " (downward)";
666 surf_parse_assert(link != nullptr, std::string("No such link: '") + A_surfxml_link___ctn_id + "'" + dirname);
667 parsed_link_list.push_back(link);
670 void ETag_surfxml_backbone(){
671 simgrid::kernel::routing::LinkCreationArgs link;
673 link.properties = nullptr;
674 link.id = std::string(A_surfxml_backbone_id);
675 link.bandwidths.push_back(
676 surf_parse_get_bandwidth(A_surfxml_backbone_bandwidth, "bandwidth of backbone", link.id.c_str()));
677 link.latency = surf_parse_get_time(A_surfxml_backbone_latency, "latency of backbone", link.id.c_str());
678 link.policy = simgrid::s4u::Link::SharingPolicy::SHARED;
680 sg_platf_new_link(&link);
681 routing_cluster_add_backbone(simgrid::s4u::Link::by_name(std::string(A_surfxml_backbone_id))->get_impl());
684 void STag_surfxml_route(){
685 surf_parse_assert_netpoint(A_surfxml_route_src, "Route src='", "' does name a node.");
686 surf_parse_assert_netpoint(A_surfxml_route_dst, "Route dst='", "' does name a node.");
689 void STag_surfxml_ASroute(){
690 surf_parse_assert_netpoint(A_surfxml_ASroute_src, "ASroute src='", "' does name a node.");
691 surf_parse_assert_netpoint(A_surfxml_ASroute_dst, "ASroute dst='", "' does name a node.");
693 surf_parse_assert_netpoint(A_surfxml_ASroute_gw___src, "ASroute gw_src='", "' does name a node.");
694 surf_parse_assert_netpoint(A_surfxml_ASroute_gw___dst, "ASroute gw_dst='", "' does name a node.");
696 void STag_surfxml_zoneRoute(){
697 surf_parse_assert_netpoint(A_surfxml_zoneRoute_src, "zoneRoute src='", "' does name a node.");
698 surf_parse_assert_netpoint(A_surfxml_zoneRoute_dst, "zoneRoute dst='", "' does name a node.");
699 surf_parse_assert_netpoint(A_surfxml_zoneRoute_gw___src, "zoneRoute gw_src='", "' does name a node.");
700 surf_parse_assert_netpoint(A_surfxml_zoneRoute_gw___dst, "zoneRoute gw_dst='", "' does name a node.");
703 void STag_surfxml_bypassRoute(){
704 surf_parse_assert_netpoint(A_surfxml_bypassRoute_src, "bypassRoute src='", "' does name a node.");
705 surf_parse_assert_netpoint(A_surfxml_bypassRoute_dst, "bypassRoute dst='", "' does name a node.");
708 void STag_surfxml_bypassASroute(){
709 surf_parse_assert_netpoint(A_surfxml_bypassASroute_src, "bypassASroute src='", "' does name a node.");
710 surf_parse_assert_netpoint(A_surfxml_bypassASroute_dst, "bypassASroute dst='", "' does name a node.");
711 surf_parse_assert_netpoint(A_surfxml_bypassASroute_gw___src, "bypassASroute gw_src='", "' does name a node.");
712 surf_parse_assert_netpoint(A_surfxml_bypassASroute_gw___dst, "bypassASroute gw_dst='", "' does name a node.");
714 void STag_surfxml_bypassZoneRoute(){
715 surf_parse_assert_netpoint(A_surfxml_bypassZoneRoute_src, "bypassZoneRoute src='", "' does name a node.");
716 surf_parse_assert_netpoint(A_surfxml_bypassZoneRoute_dst, "bypassZoneRoute dst='", "' does name a node.");
717 surf_parse_assert_netpoint(A_surfxml_bypassZoneRoute_gw___src, "bypassZoneRoute gw_src='", "' does name a node.");
718 surf_parse_assert_netpoint(A_surfxml_bypassZoneRoute_gw___dst, "bypassZoneRoute gw_dst='", "' does name a node.");
721 void ETag_surfxml_route(){
722 simgrid::kernel::routing::RouteCreationArgs route;
724 route.src = sg_netpoint_by_name_or_null(A_surfxml_route_src); // tested to not be nullptr in start tag
725 route.dst = sg_netpoint_by_name_or_null(A_surfxml_route_dst); // tested to not be nullptr in start tag
726 route.gw_src = nullptr;
727 route.gw_dst = nullptr;
728 route.symmetrical = (A_surfxml_route_symmetrical == A_surfxml_route_symmetrical_YES);
730 route.link_list.swap(parsed_link_list);
732 sg_platf_new_route(&route);
735 void ETag_surfxml_ASroute()
737 AX_surfxml_zoneRoute_src = AX_surfxml_ASroute_src;
738 AX_surfxml_zoneRoute_dst = AX_surfxml_ASroute_dst;
739 AX_surfxml_zoneRoute_gw___src = AX_surfxml_ASroute_gw___src;
740 AX_surfxml_zoneRoute_gw___dst = AX_surfxml_ASroute_gw___dst;
741 AX_surfxml_zoneRoute_symmetrical = (AT_surfxml_zoneRoute_symmetrical)AX_surfxml_ASroute_symmetrical;
742 ETag_surfxml_zoneRoute();
744 void ETag_surfxml_zoneRoute()
746 simgrid::kernel::routing::RouteCreationArgs ASroute;
748 ASroute.src = sg_netpoint_by_name_or_null(A_surfxml_zoneRoute_src); // tested to not be nullptr in start tag
749 ASroute.dst = sg_netpoint_by_name_or_null(A_surfxml_zoneRoute_dst); // tested to not be nullptr in start tag
751 ASroute.gw_src = sg_netpoint_by_name_or_null(A_surfxml_zoneRoute_gw___src); // tested to not be nullptr in start tag
752 ASroute.gw_dst = sg_netpoint_by_name_or_null(A_surfxml_zoneRoute_gw___dst); // tested to not be nullptr in start tag
754 ASroute.link_list.swap(parsed_link_list);
756 switch (A_surfxml_zoneRoute_symmetrical) {
757 case AU_surfxml_zoneRoute_symmetrical:
758 case A_surfxml_zoneRoute_symmetrical_YES:
759 ASroute.symmetrical = true;
761 case A_surfxml_zoneRoute_symmetrical_NO:
762 ASroute.symmetrical = false;
768 sg_platf_new_route(&ASroute);
771 void ETag_surfxml_bypassRoute(){
772 simgrid::kernel::routing::RouteCreationArgs route;
774 route.src = sg_netpoint_by_name_or_null(A_surfxml_bypassRoute_src); // tested to not be nullptr in start tag
775 route.dst = sg_netpoint_by_name_or_null(A_surfxml_bypassRoute_dst); // tested to not be nullptr in start tag
776 route.gw_src = nullptr;
777 route.gw_dst = nullptr;
778 route.symmetrical = false;
780 route.link_list.swap(parsed_link_list);
782 sg_platf_new_bypassRoute(&route);
785 void ETag_surfxml_bypassASroute()
787 AX_surfxml_bypassZoneRoute_src = AX_surfxml_bypassASroute_src;
788 AX_surfxml_bypassZoneRoute_dst = AX_surfxml_bypassASroute_dst;
789 AX_surfxml_bypassZoneRoute_gw___src = AX_surfxml_bypassASroute_gw___src;
790 AX_surfxml_bypassZoneRoute_gw___dst = AX_surfxml_bypassASroute_gw___dst;
791 ETag_surfxml_bypassZoneRoute();
793 void ETag_surfxml_bypassZoneRoute()
795 simgrid::kernel::routing::RouteCreationArgs ASroute;
797 ASroute.src = sg_netpoint_by_name_or_null(A_surfxml_bypassZoneRoute_src);
798 ASroute.dst = sg_netpoint_by_name_or_null(A_surfxml_bypassZoneRoute_dst);
799 ASroute.link_list.swap(parsed_link_list);
801 ASroute.symmetrical = false;
803 ASroute.gw_src = sg_netpoint_by_name_or_null(A_surfxml_bypassZoneRoute_gw___src);
804 ASroute.gw_dst = sg_netpoint_by_name_or_null(A_surfxml_bypassZoneRoute_gw___dst);
806 sg_platf_new_bypassRoute(&ASroute);
809 void ETag_surfxml_trace(){
810 simgrid::kernel::routing::ProfileCreationArgs trace;
812 trace.id = A_surfxml_trace_id;
813 trace.file = A_surfxml_trace_file;
814 trace.periodicity = surf_parse_get_double(A_surfxml_trace_periodicity);
815 trace.pc_data = surfxml_pcdata;
817 sg_platf_new_trace(&trace);
820 void STag_surfxml_trace___connect()
822 simgrid::kernel::routing::TraceConnectCreationArgs trace_connect;
824 trace_connect.element = A_surfxml_trace___connect_element;
825 trace_connect.trace = A_surfxml_trace___connect_trace;
827 switch (A_surfxml_trace___connect_kind) {
828 case AU_surfxml_trace___connect_kind:
829 case A_surfxml_trace___connect_kind_SPEED:
830 trace_connect.kind = simgrid::kernel::routing::TraceConnectKind::SPEED;
832 case A_surfxml_trace___connect_kind_BANDWIDTH:
833 trace_connect.kind = simgrid::kernel::routing::TraceConnectKind::BANDWIDTH;
835 case A_surfxml_trace___connect_kind_HOST___AVAIL:
836 trace_connect.kind = simgrid::kernel::routing::TraceConnectKind::HOST_AVAIL;
838 case A_surfxml_trace___connect_kind_LATENCY:
839 trace_connect.kind = simgrid::kernel::routing::TraceConnectKind::LATENCY;
841 case A_surfxml_trace___connect_kind_LINK___AVAIL:
842 trace_connect.kind = simgrid::kernel::routing::TraceConnectKind::LINK_AVAIL;
845 surf_parse_error("Invalid trace kind");
847 sg_platf_trace_connect(&trace_connect);
850 void STag_surfxml_AS()
852 AX_surfxml_zone_id = AX_surfxml_AS_id;
853 AX_surfxml_zone_routing = (AT_surfxml_zone_routing)AX_surfxml_AS_routing;
857 void ETag_surfxml_AS()
862 void STag_surfxml_zone()
864 property_sets.push_back(new std::unordered_map<std::string, std::string>());
865 simgrid::kernel::routing::ZoneCreationArgs zone;
866 zone.id = A_surfxml_zone_id;
867 zone.routing = static_cast<int>(A_surfxml_zone_routing);
868 sg_platf_new_Zone_begin(&zone);
871 void ETag_surfxml_zone()
873 sg_platf_new_Zone_set_properties(property_sets.back());
874 delete property_sets.back();
875 property_sets.pop_back();
877 sg_platf_new_Zone_seal();
880 void STag_surfxml_config()
882 property_sets.push_back(new std::unordered_map<std::string, std::string>());
883 XBT_DEBUG("START configuration name = %s",A_surfxml_config_id);
884 if (_sg_cfg_init_status == 2) {
885 surf_parse_error("All <config> tags must be given before any platform elements (such as <zone>, <host>, <cluster>, "
890 void ETag_surfxml_config()
892 // Sort config elements before applying.
893 // That's a little waste of time, but not doing so would break the tests
894 auto current_property_set = property_sets.back();
896 std::vector<std::string> keys;
897 for (auto const& kv : *current_property_set) {
898 keys.push_back(kv.first);
900 std::sort(keys.begin(), keys.end());
901 for (std::string key : keys) {
902 if (simgrid::config::is_default(key.c_str())) {
903 std::string cfg = key + ":" + current_property_set->at(key);
904 simgrid::config::set_parse(std::move(cfg));
906 XBT_INFO("The custom configuration '%s' is already defined by user!", key.c_str());
908 XBT_DEBUG("End configuration name = %s",A_surfxml_config_id);
910 delete current_property_set;
911 property_sets.pop_back();
914 static std::vector<std::string> arguments;
916 void STag_surfxml_process()
918 AX_surfxml_actor_function = AX_surfxml_process_function;
919 STag_surfxml_actor();
922 void STag_surfxml_actor()
924 property_sets.push_back(new std::unordered_map<std::string, std::string>());
925 arguments.assign(1, A_surfxml_actor_function);
928 void ETag_surfxml_process()
930 AX_surfxml_actor_host = AX_surfxml_process_host;
931 AX_surfxml_actor_function = AX_surfxml_process_function;
932 AX_surfxml_actor_start___time = AX_surfxml_process_start___time;
933 AX_surfxml_actor_kill___time = AX_surfxml_process_kill___time;
934 AX_surfxml_actor_on___failure = (AT_surfxml_actor_on___failure)AX_surfxml_process_on___failure;
935 ETag_surfxml_actor();
938 void ETag_surfxml_actor()
940 simgrid::kernel::routing::ActorCreationArgs actor;
942 actor.properties = property_sets.back();
943 property_sets.pop_back();
945 actor.args.swap(arguments);
946 actor.host = A_surfxml_actor_host;
947 actor.function = A_surfxml_actor_function;
948 actor.start_time = surf_parse_get_double(A_surfxml_actor_start___time);
949 actor.kill_time = surf_parse_get_double(A_surfxml_actor_kill___time);
951 switch (A_surfxml_actor_on___failure) {
952 case AU_surfxml_actor_on___failure:
953 case A_surfxml_actor_on___failure_DIE:
954 actor.restart_on_failure = false;
956 case A_surfxml_actor_on___failure_RESTART:
957 actor.restart_on_failure = true;
960 surf_parse_error("Invalid on failure behavior");
963 sg_platf_new_actor(&actor);
966 void STag_surfxml_argument(){
967 arguments.push_back(A_surfxml_argument_value);
970 void STag_surfxml_model___prop(){
971 if (not current_model_property_set)
972 current_model_property_set = new std::unordered_map<std::string, std::string>();
974 current_model_property_set->insert({A_surfxml_model___prop_id, A_surfxml_model___prop_value});
977 void ETag_surfxml_prop(){/* Nothing to do */}
978 void STag_surfxml_random(){/* Nothing to do */}
979 void ETag_surfxml_random(){/* Nothing to do */}
980 void ETag_surfxml_trace___connect(){/* Nothing to do */}
981 void STag_surfxml_trace()
982 { /* Nothing to do */
984 void ETag_surfxml_router(){/*Nothing to do*/}
985 void ETag_surfxml_host___link(){/* Nothing to do */}
986 void ETag_surfxml_cabinet(){/* Nothing to do */}
987 void ETag_surfxml_peer(){/* Nothing to do */}
988 void STag_surfxml_backbone(){/* Nothing to do */}
989 void ETag_surfxml_link___ctn(){/* Nothing to do */}
990 void ETag_surfxml_argument(){/* Nothing to do */}
991 void ETag_surfxml_model___prop(){/* Nothing to do */}
993 /* Open and Close parse file */
994 YY_BUFFER_STATE surf_input_buffer;
996 void surf_parse_open(const std::string& file)
998 surf_parsed_filename = file;
999 std::string dir = simgrid::xbt::Path(file).get_dir_name();
1000 surf_path.push_back(dir);
1002 surf_file_to_parse = surf_fopen(file, "r");
1003 if (surf_file_to_parse == nullptr)
1004 throw std::invalid_argument(std::string("Unable to open ')") + file + "' from '" + simgrid::xbt::Path().get_name() +
1005 "'. Does this file exist?");
1006 surf_input_buffer = surf_parse__create_buffer(surf_file_to_parse, YY_BUF_SIZE);
1007 surf_parse__switch_to_buffer(surf_input_buffer);
1008 surf_parse_lineno = 1;
1011 void surf_parse_close()
1013 surf_path.pop_back(); // remove the dirname of the opened file, that was added in surf_parse_open()
1015 if (surf_file_to_parse) {
1016 surf_parse__delete_buffer(surf_input_buffer);
1017 fclose(surf_file_to_parse);
1018 surf_file_to_parse = nullptr; //Must be reset for Bypass
1022 /* Call the lexer to parse the currently opened file */
1025 bool err = surf_parse_lex();
1026 surf_parse_assert(not err, "Flex returned an error code");