1 /* Copyright (c) 2006-2019. 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/kernel/routing/NetPoint.hpp"
7 #include "simgrid/s4u/Engine.hpp"
8 #include "simgrid/sg_config.hpp"
9 #include "src/surf/network_interface.hpp"
10 #include "src/surf/surf_interface.hpp"
11 #include "src/surf/xml/platf_private.hpp"
12 #include "surf/surf.hpp"
13 #include "xbt/file.hpp"
15 #include <boost/algorithm/string.hpp>
16 #include <boost/algorithm/string/classification.hpp>
17 #include <boost/algorithm/string/split.hpp>
20 #include <unordered_map>
23 #include "simgrid_dtd.c"
25 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_parse, surf, "Logging specific to the SURF parsing module");
27 static std::string surf_parsed_filename; // Currently parsed file (for the error messages)
28 std::vector<simgrid::kernel::resource::LinkImpl*>
29 parsed_link_list; /* temporary store of current list link of a route */
34 void surf_parse_assert(bool cond, const std::string& msg)
37 int lineno = surf_parse_lineno;
39 XBT_ERROR("Parse error at %s:%d: %s", surf_parsed_filename.c_str(), lineno, msg.c_str());
41 xbt_die("Exiting now");
45 void surf_parse_error(const std::string& msg)
47 int lineno = surf_parse_lineno;
49 XBT_ERROR("Parse error at %s:%d: %s", surf_parsed_filename.c_str(), lineno, msg.c_str());
51 xbt_die("Exiting now");
54 void surf_parse_assert_netpoint(const std::string& hostname, const std::string& pre, const std::string& post)
56 if (sg_netpoint_by_name_or_null(hostname.c_str()) != nullptr) // found
59 std::string msg = pre + hostname + post + " Existing netpoints: \n";
61 std::vector<simgrid::kernel::routing::NetPoint*> netpoints =
62 simgrid::s4u::Engine::get_instance()->get_all_netpoints();
63 std::sort(netpoints.begin(), netpoints.end(),
64 [](simgrid::kernel::routing::NetPoint* a, simgrid::kernel::routing::NetPoint* b) {
65 return a->get_name() < b->get_name();
68 for (auto const& np : netpoints) {
75 msg += "'" + np->get_name() + "'";
76 if (msg.length() > 4096) {
77 msg.pop_back(); // remove trailing quote
78 msg += "...(list truncated)......";
82 surf_parse_error(msg);
85 double surf_parse_get_double(const std::string& s)
89 } catch (std::invalid_argument& ia) {
90 surf_parse_error(s + " is not a double");
94 int surf_parse_get_int(const std::string& s)
98 } catch (std::invalid_argument& ia) {
99 surf_parse_error(s + " is not a double");
105 /* Turn something like "1-4,6,9-11" into the vector {1,2,3,4,6,9,10,11} */
106 std::vector<int>* explodesRadical(const std::string& radicals)
108 std::vector<int>* exploded = new std::vector<int>();
111 std::vector<std::string> radical_elements;
112 boost::split(radical_elements, radicals, boost::is_any_of(","));
113 for (auto const& group : radical_elements) {
114 std::vector<std::string> radical_ends;
115 boost::split(radical_ends, group, boost::is_any_of("-"));
116 int start = surf_parse_get_int(radical_ends.front());
119 switch (radical_ends.size()) {
124 end = surf_parse_get_int(radical_ends.back());
127 surf_parse_error(std::string("Malformed radical: ") + group);
129 for (int i = start; i <= end; i++)
130 exploded->push_back(i);
136 class unit_scale : public std::unordered_map<std::string, double> {
138 using std::unordered_map<std::string, double>::unordered_map;
139 // tuples are : <unit, value for unit, base (2 or 10), true if abbreviated>
140 explicit unit_scale(std::initializer_list<std::tuple<const std::string, double, int, bool>> generators);
143 unit_scale::unit_scale(std::initializer_list<std::tuple<const std::string, double, int, bool>> generators)
145 for (const auto& gen : generators) {
146 const std::string& unit = std::get<0>(gen);
147 double value = std::get<1>(gen);
148 const int base = std::get<2>(gen);
149 const bool abbrev = std::get<3>(gen);
151 std::vector<std::string> prefixes;
155 prefixes = abbrev ? std::vector<std::string>{"Ki", "Mi", "Gi", "Ti", "Pi", "Ei", "Zi", "Yi"}
156 : std::vector<std::string>{"kibi", "mebi", "gibi", "tebi", "pebi", "exbi", "zebi", "yobi"};
160 prefixes = abbrev ? std::vector<std::string>{"k", "M", "G", "T", "P", "E", "Z", "Y"}
161 : std::vector<std::string>{"kilo", "mega", "giga", "tera", "peta", "exa", "zeta", "yotta"};
166 emplace(unit, value);
167 for (const auto& prefix : prefixes) {
169 emplace(prefix + unit, value);
174 /* Note: field `unit' for the last element of parameter `units' should be nullptr. */
175 double surf_parse_get_value_with_unit(const char* string, const unit_scale& units, const char* entity_kind,
176 const std::string& name, const char* error_msg, const char* default_unit)
180 double res = strtod(string, &ptr);
182 surf_parse_error(std::string("value out of range: ") + string);
184 surf_parse_error(std::string("cannot parse number:") + string);
185 if (ptr[0] == '\0') {
187 return res; // Ok, 0 can be unit-less
189 XBT_WARN("Deprecated unit-less value '%s' for %s %s. %s", string, entity_kind, name.c_str(), error_msg);
190 ptr = (char*)default_unit;
192 auto u = units.find(ptr);
193 if (u == units.end())
194 surf_parse_error(std::string("unknown unit: ") + ptr);
195 return res * u->second;
199 double surf_parse_get_time(const char* string, const char* entity_kind, const std::string& name)
201 static const unit_scale units{std::make_pair("w", 7 * 24 * 60 * 60),
202 std::make_pair("d", 24 * 60 * 60),
203 std::make_pair("h", 60 * 60),
204 std::make_pair("m", 60),
205 std::make_pair("s", 1.0),
206 std::make_pair("ms", 1e-3),
207 std::make_pair("us", 1e-6),
208 std::make_pair("ns", 1e-9),
209 std::make_pair("ps", 1e-12)};
210 return surf_parse_get_value_with_unit(string, units, entity_kind, name,
211 "Append 's' to your time to get seconds", "s");
214 double surf_parse_get_size(const char* string, const char* entity_kind, const std::string& name)
216 static const unit_scale units{std::make_tuple("b", 0.125, 2, true), std::make_tuple("b", 0.125, 10, true),
217 std::make_tuple("B", 1.0, 2, true), std::make_tuple("B", 1.0, 10, true)};
218 return surf_parse_get_value_with_unit(string, units, entity_kind, name,
219 "Append 'B' to get bytes (or 'b' for bits but 1B = 8b).", "B");
222 double surf_parse_get_bandwidth(const char* string, const char* entity_kind, const std::string& name)
224 static const unit_scale units{std::make_tuple("bps", 0.125, 2, true), std::make_tuple("bps", 0.125, 10, true),
225 std::make_tuple("Bps", 1.0, 2, true), std::make_tuple("Bps", 1.0, 10, true)};
226 return surf_parse_get_value_with_unit(string, units, entity_kind, name,
227 "Append 'Bps' to get bytes per second (or 'bps' for bits but 1Bps = 8bps)", "Bps");
230 double surf_parse_get_speed(const char* string, const char* entity_kind, const std::string& name)
232 static const unit_scale units{std::make_tuple("f", 1.0, 10, true), std::make_tuple("flops", 1.0, 10, false)};
233 return surf_parse_get_value_with_unit(string, units, entity_kind, name,
234 "Append 'f' or 'flops' to your speed to get flop per second", "f");
237 static std::vector<double> surf_parse_get_all_speeds(char* speeds, const char* entity_kind, const std::string& id)
240 std::vector<double> speed_per_pstate;
242 if (strchr(speeds, ',') == nullptr){
243 double speed = surf_parse_get_speed(speeds, entity_kind, id);
244 speed_per_pstate.push_back(speed);
246 std::vector<std::string> pstate_list;
247 boost::split(pstate_list, speeds, boost::is_any_of(","));
248 for (auto speed_str : pstate_list) {
249 boost::trim(speed_str);
250 double speed = surf_parse_get_speed(speed_str.c_str(), entity_kind, id);
251 speed_per_pstate.push_back(speed);
252 XBT_DEBUG("Speed value: %f", speed);
255 return speed_per_pstate;
259 * All the callback lists that can be overridden anywhere.
260 * (this list should probably be reduced to the bare minimum to allow the models to work)
263 /* make sure these symbols are defined as strong ones in this file so that the linker can resolve them */
265 /* The default current property receiver. Setup in the corresponding opening callbacks. */
266 std::unordered_map<std::string, std::string>* current_property_set = nullptr;
267 std::unordered_map<std::string, std::string>* current_model_property_set = nullptr;
268 int ZONE_TAG = 0; // Whether we just opened a zone tag (to see what to do with the properties)
270 FILE *surf_file_to_parse = nullptr;
272 /* Stuff relative to storage */
273 void STag_surfxml_storage()
276 XBT_DEBUG("STag_surfxml_storage");
277 xbt_assert(current_property_set == nullptr, "Someone forgot to reset the property set to nullptr in its closing tag (or XML malformed)");
280 void ETag_surfxml_storage()
282 simgrid::kernel::routing::StorageCreationArgs storage;
284 storage.properties = current_property_set;
285 current_property_set = nullptr;
287 storage.id = A_surfxml_storage_id;
288 storage.type_id = A_surfxml_storage_typeId;
289 storage.content = A_surfxml_storage_content;
290 storage.attach = A_surfxml_storage_attach;
292 sg_platf_new_storage(&storage);
294 void STag_surfxml_storage___type()
297 XBT_DEBUG("STag_surfxml_storage___type");
298 xbt_assert(current_property_set == nullptr, "Someone forgot to reset the property set to nullptr in its closing tag (or XML malformed)");
299 xbt_assert(current_model_property_set == nullptr, "Someone forgot to reset the model property set to nullptr in its closing tag (or XML malformed)");
301 void ETag_surfxml_storage___type()
303 simgrid::kernel::routing::StorageTypeCreationArgs storage_type;
305 storage_type.properties = current_property_set;
306 current_property_set = nullptr;
308 storage_type.model_properties = current_model_property_set;
309 current_model_property_set = nullptr;
311 storage_type.content = A_surfxml_storage___type_content;
312 storage_type.id = A_surfxml_storage___type_id;
313 storage_type.model = A_surfxml_storage___type_model;
315 surf_parse_get_size(A_surfxml_storage___type_size, "size of storage type", storage_type.id.c_str());
316 sg_platf_new_storage_type(&storage_type);
319 void STag_surfxml_mount()
321 XBT_DEBUG("STag_surfxml_mount");
324 void ETag_surfxml_mount()
326 simgrid::kernel::routing::MountCreationArgs mount;
328 mount.name = A_surfxml_mount_name;
329 mount.storageId = A_surfxml_mount_storageId;
330 sg_platf_new_mount(&mount);
333 void STag_surfxml_include()
335 xbt_die("<include> tag was removed in SimGrid v3.18. Please stop using it now.");
338 void ETag_surfxml_include()
340 /* Won't happen since <include> is now removed since v3.18. */
343 /* Stag and Etag parse functions */
344 void STag_surfxml_platform() {
345 XBT_ATTRIB_UNUSED double version = surf_parse_get_double(A_surfxml_platform_version);
347 xbt_assert((version >= 1.0), "******* BIG FAT WARNING *********\n "
348 "You're using an ancient XML file.\n"
349 "Since SimGrid 3.1, units are Bytes, Flops, and seconds "
350 "instead of MBytes, MFlops and seconds.\n"
352 "Use simgrid_update_xml to update your file automatically. "
353 "This program is installed automatically with SimGrid, or "
354 "available in the tools/ directory of the source archive.\n"
356 "Please check also out the SURF section of the ChangeLog for "
357 "the 3.1 version for more information. \n"
359 "Last, do not forget to also update your values for "
360 "the calls to MSG_task_create (if any).");
361 xbt_assert((version >= 3.0), "******* BIG FAT WARNING *********\n "
362 "You're using an old XML file.\n"
363 "Use simgrid_update_xml to update your file automatically. "
364 "This program is installed automatically with SimGrid, or "
365 "available in the tools/ directory of the source archive.");
366 xbt_assert((version >= 4.0),
367 "******* FILE %s IS TOO OLD (v:%.1f) *********\n "
368 "Changes introduced in SimGrid 3.13:\n"
369 " - 'power' attribute of hosts (and others) got renamed to 'speed'.\n"
370 " - In <trace_connect>, attribute kind=\"POWER\" is now kind=\"SPEED\".\n"
371 " - DOCTYPE now point to the rignt URL.\n"
372 " - speed, bandwidth and latency attributes now MUST have an explicit unit (f, Bps, s by default)"
374 "Use simgrid_update_xml to update your file automatically. "
375 "This program is installed automatically with SimGrid, or "
376 "available in the tools/ directory of the source archive.",
377 surf_parsed_filename.c_str(), version);
379 XBT_INFO("You're using a v%.1f XML file (%s) while the current standard is v4.1 "
380 "That's fine, the new version is backward compatible. \n\n"
381 "Use simgrid_update_xml to update your file automatically to get rid of this warning. "
382 "This program is installed automatically with SimGrid, or "
383 "available in the tools/ directory of the source archive.",
384 version, surf_parsed_filename.c_str());
386 xbt_assert(version <= 4.1,
387 "******* FILE %s COMES FROM THE FUTURE (v:%.1f) *********\n "
388 "The most recent formalism that this version of SimGrid understands is v4.1.\n"
389 "Please update your code, or use another, more adapted, file.",
390 surf_parsed_filename.c_str(), version);
392 void ETag_surfxml_platform(){
393 simgrid::s4u::on_platform_created();
396 void STag_surfxml_host(){
398 xbt_assert(current_property_set == nullptr, "Someone forgot to reset the property set to nullptr in its closing tag (or XML malformed)");
401 void STag_surfxml_prop()
403 if (ZONE_TAG) { // We need to retrieve the most recently opened zone
404 XBT_DEBUG("Set zone property %s -> %s", A_surfxml_prop_id, A_surfxml_prop_value);
405 simgrid::s4u::NetZone* netzone = simgrid::s4u::Engine::get_instance()->netzone_by_name_or_null(A_surfxml_zone_id);
407 netzone->set_property(std::string(A_surfxml_prop_id), A_surfxml_prop_value);
409 if (not current_property_set)
410 current_property_set = new std::unordered_map<std::string, std::string>; // Maybe, it should raise an error
411 current_property_set->insert({A_surfxml_prop_id, A_surfxml_prop_value});
412 XBT_DEBUG("add prop %s=%s into current property set %p", A_surfxml_prop_id, A_surfxml_prop_value,
413 current_property_set);
417 void ETag_surfxml_host() {
418 simgrid::kernel::routing::HostCreationArgs host;
420 host.properties = current_property_set;
421 current_property_set = nullptr;
423 host.id = A_surfxml_host_id;
425 host.speed_per_pstate = surf_parse_get_all_speeds(A_surfxml_host_speed, "speed of host", host.id);
427 XBT_DEBUG("pstate: %s", A_surfxml_host_pstate);
428 host.core_amount = surf_parse_get_int(A_surfxml_host_core);
430 host.speed_trace = nullptr;
431 if (A_surfxml_host_availability___file[0] != '\0') {
432 XBT_WARN("The availability_file attribute in <host> is now deprecated. Please, use 'speed_file' instead.");
433 host.speed_trace = simgrid::kernel::profile::Profile::from_file(A_surfxml_host_availability___file);
435 if (A_surfxml_host_speed___file[0] != '\0')
436 host.speed_trace = simgrid::kernel::profile::Profile::from_file(A_surfxml_host_speed___file);
437 host.state_trace = A_surfxml_host_state___file[0]
438 ? simgrid::kernel::profile::Profile::from_file(A_surfxml_host_state___file)
440 host.pstate = surf_parse_get_int(A_surfxml_host_pstate);
441 host.coord = A_surfxml_host_coordinates;
443 sg_platf_new_host(&host);
446 void STag_surfxml_host___link(){
447 XBT_DEBUG("Create a Host_link for %s",A_surfxml_host___link_id);
448 simgrid::kernel::routing::HostLinkCreationArgs host_link;
450 host_link.id = A_surfxml_host___link_id;
451 host_link.link_up = A_surfxml_host___link_up;
452 host_link.link_down = A_surfxml_host___link_down;
453 sg_platf_new_hostlink(&host_link);
456 void STag_surfxml_router(){
457 sg_platf_new_router(A_surfxml_router_id, A_surfxml_router_coordinates);
460 void ETag_surfxml_cluster(){
461 simgrid::kernel::routing::ClusterCreationArgs cluster;
462 cluster.properties = current_property_set;
463 current_property_set = nullptr;
465 cluster.id = A_surfxml_cluster_id;
466 cluster.prefix = A_surfxml_cluster_prefix;
467 cluster.suffix = A_surfxml_cluster_suffix;
468 cluster.radicals = explodesRadical(A_surfxml_cluster_radical);
469 cluster.speeds = surf_parse_get_all_speeds(A_surfxml_cluster_speed, "speed of cluster", cluster.id);
470 cluster.core_amount = surf_parse_get_int(A_surfxml_cluster_core);
471 cluster.bw = surf_parse_get_bandwidth(A_surfxml_cluster_bw, "bw of cluster", cluster.id);
472 cluster.lat = surf_parse_get_time(A_surfxml_cluster_lat, "lat of cluster", cluster.id);
473 if(strcmp(A_surfxml_cluster_bb___bw,""))
474 cluster.bb_bw = surf_parse_get_bandwidth(A_surfxml_cluster_bb___bw, "bb_bw of cluster", cluster.id);
475 if(strcmp(A_surfxml_cluster_bb___lat,""))
476 cluster.bb_lat = surf_parse_get_time(A_surfxml_cluster_bb___lat, "bb_lat of cluster", cluster.id);
477 if(strcmp(A_surfxml_cluster_limiter___link,""))
478 cluster.limiter_link = surf_parse_get_bandwidth(A_surfxml_cluster_limiter___link, "limiter_link of cluster", cluster.id);
479 if(strcmp(A_surfxml_cluster_loopback___bw,""))
480 cluster.loopback_bw = surf_parse_get_bandwidth(A_surfxml_cluster_loopback___bw, "loopback_bw of cluster", cluster.id);
481 if(strcmp(A_surfxml_cluster_loopback___lat,""))
482 cluster.loopback_lat = surf_parse_get_time(A_surfxml_cluster_loopback___lat, "loopback_lat of cluster", cluster.id);
484 switch(AX_surfxml_cluster_topology){
485 case A_surfxml_cluster_topology_FLAT:
486 cluster.topology = simgrid::kernel::routing::ClusterTopology::FLAT;
488 case A_surfxml_cluster_topology_TORUS:
489 cluster.topology = simgrid::kernel::routing::ClusterTopology::TORUS;
491 case A_surfxml_cluster_topology_FAT___TREE:
492 cluster.topology = simgrid::kernel::routing::ClusterTopology::FAT_TREE;
494 case A_surfxml_cluster_topology_DRAGONFLY:
495 cluster.topology = simgrid::kernel::routing::ClusterTopology::DRAGONFLY;
498 surf_parse_error(std::string("Invalid cluster topology for cluster ") + cluster.id);
500 cluster.topo_parameters = A_surfxml_cluster_topo___parameters;
501 cluster.router_id = A_surfxml_cluster_router___id;
503 switch (AX_surfxml_cluster_sharing___policy) {
504 case A_surfxml_cluster_sharing___policy_SHARED:
505 cluster.sharing_policy = simgrid::s4u::Link::SharingPolicy::SHARED;
507 case A_surfxml_cluster_sharing___policy_FULLDUPLEX:
508 XBT_WARN("FULLDUPLEX is now deprecated. Please update your platform file to use SPLITDUPLEX instead.");
509 cluster.sharing_policy = simgrid::s4u::Link::SharingPolicy::SPLITDUPLEX;
511 case A_surfxml_cluster_sharing___policy_SPLITDUPLEX:
512 cluster.sharing_policy = simgrid::s4u::Link::SharingPolicy::SPLITDUPLEX;
514 case A_surfxml_cluster_sharing___policy_FATPIPE:
515 cluster.sharing_policy = simgrid::s4u::Link::SharingPolicy::FATPIPE;
518 surf_parse_error(std::string("Invalid cluster sharing policy for cluster ") + cluster.id);
520 switch (AX_surfxml_cluster_bb___sharing___policy) {
521 case A_surfxml_cluster_bb___sharing___policy_FATPIPE:
522 cluster.bb_sharing_policy = simgrid::s4u::Link::SharingPolicy::FATPIPE;
524 case A_surfxml_cluster_bb___sharing___policy_SHARED:
525 cluster.bb_sharing_policy = simgrid::s4u::Link::SharingPolicy::SHARED;
528 surf_parse_error(std::string("Invalid bb sharing policy in cluster ") + cluster.id);
531 sg_platf_new_cluster(&cluster);
534 void STag_surfxml_cluster(){
536 xbt_assert(current_property_set == nullptr, "Someone forgot to reset the property set to nullptr in its closing tag (or XML malformed)");
539 void STag_surfxml_cabinet(){
540 simgrid::kernel::routing::CabinetCreationArgs cabinet;
541 cabinet.id = A_surfxml_cabinet_id;
542 cabinet.prefix = A_surfxml_cabinet_prefix;
543 cabinet.suffix = A_surfxml_cabinet_suffix;
544 cabinet.speed = surf_parse_get_speed(A_surfxml_cabinet_speed, "speed of cabinet", cabinet.id.c_str());
545 cabinet.bw = surf_parse_get_bandwidth(A_surfxml_cabinet_bw, "bw of cabinet", cabinet.id.c_str());
546 cabinet.lat = surf_parse_get_time(A_surfxml_cabinet_lat, "lat of cabinet", cabinet.id.c_str());
547 cabinet.radicals = explodesRadical(A_surfxml_cabinet_radical);
549 sg_platf_new_cabinet(&cabinet);
552 void STag_surfxml_peer(){
553 simgrid::kernel::routing::PeerCreationArgs peer;
555 peer.id = std::string(A_surfxml_peer_id);
556 peer.speed = surf_parse_get_speed(A_surfxml_peer_speed, "speed of peer", peer.id.c_str());
557 peer.bw_in = surf_parse_get_bandwidth(A_surfxml_peer_bw___in, "bw_in of peer", peer.id.c_str());
558 peer.bw_out = surf_parse_get_bandwidth(A_surfxml_peer_bw___out, "bw_out of peer", peer.id.c_str());
559 peer.coord = A_surfxml_peer_coordinates;
560 peer.speed_trace = nullptr;
561 if (A_surfxml_peer_availability___file[0] != '\0') {
562 XBT_WARN("The availability_file attribute in <peer> is now deprecated. Please, use 'speed_file' instead.");
563 peer.speed_trace = simgrid::kernel::profile::Profile::from_file(A_surfxml_peer_availability___file);
565 if (A_surfxml_peer_speed___file[0] != '\0')
566 peer.speed_trace = simgrid::kernel::profile::Profile::from_file(A_surfxml_peer_speed___file);
567 peer.state_trace = A_surfxml_peer_state___file[0]
568 ? simgrid::kernel::profile::Profile::from_file(A_surfxml_peer_state___file)
571 if (A_surfxml_peer_lat[0] != '\0')
572 XBT_WARN("The latency attribute in <peer> is now deprecated. Use the z coordinate instead of '%s'.",
575 sg_platf_new_peer(&peer);
578 void STag_surfxml_link(){
580 xbt_assert(current_property_set == nullptr, "Someone forgot to reset the property set to nullptr in its closing tag (or XML malformed)");
583 void ETag_surfxml_link(){
584 simgrid::kernel::routing::LinkCreationArgs link;
586 link.properties = current_property_set;
587 current_property_set = nullptr;
589 link.id = std::string(A_surfxml_link_id);
590 link.bandwidth = surf_parse_get_bandwidth(A_surfxml_link_bandwidth, "bandwidth of link", link.id.c_str());
591 link.bandwidth_trace = A_surfxml_link_bandwidth___file[0]
592 ? simgrid::kernel::profile::Profile::from_file(A_surfxml_link_bandwidth___file)
594 link.latency = surf_parse_get_time(A_surfxml_link_latency, "latency of link", link.id.c_str());
595 link.latency_trace = A_surfxml_link_latency___file[0]
596 ? simgrid::kernel::profile::Profile::from_file(A_surfxml_link_latency___file)
598 link.state_trace = A_surfxml_link_state___file[0]
599 ? simgrid::kernel::profile::Profile::from_file(A_surfxml_link_state___file)
602 switch (A_surfxml_link_sharing___policy) {
603 case A_surfxml_link_sharing___policy_SHARED:
604 link.policy = simgrid::s4u::Link::SharingPolicy::SHARED;
606 case A_surfxml_link_sharing___policy_FATPIPE:
607 link.policy = simgrid::s4u::Link::SharingPolicy::FATPIPE;
609 case A_surfxml_link_sharing___policy_FULLDUPLEX:
610 XBT_WARN("FULLDUPLEX is now deprecated. Please update your platform file to use SPLITDUPLEX instead.");
611 link.policy = simgrid::s4u::Link::SharingPolicy::SPLITDUPLEX;
613 case A_surfxml_link_sharing___policy_SPLITDUPLEX:
614 link.policy = simgrid::s4u::Link::SharingPolicy::SPLITDUPLEX;
617 surf_parse_error(std::string("Invalid sharing policy in link ") + link.id);
620 sg_platf_new_link(&link);
623 void STag_surfxml_link___ctn()
625 simgrid::kernel::resource::LinkImpl* link = nullptr;
626 switch (A_surfxml_link___ctn_direction) {
627 case AU_surfxml_link___ctn_direction:
628 case A_surfxml_link___ctn_direction_NONE:
629 link = simgrid::s4u::Link::by_name(std::string(A_surfxml_link___ctn_id))->get_impl();
631 case A_surfxml_link___ctn_direction_UP:
632 link = simgrid::s4u::Link::by_name(std::string(A_surfxml_link___ctn_id) + "_UP")->get_impl();
634 case A_surfxml_link___ctn_direction_DOWN:
635 link = simgrid::s4u::Link::by_name(std::string(A_surfxml_link___ctn_id) + "_DOWN")->get_impl();
638 surf_parse_error(std::string("Invalid direction for link ") + A_surfxml_link___ctn_id);
641 const char* dirname = "";
642 switch (A_surfxml_link___ctn_direction) {
643 case A_surfxml_link___ctn_direction_UP:
644 dirname = " (upward)";
646 case A_surfxml_link___ctn_direction_DOWN:
647 dirname = " (downward)";
652 surf_parse_assert(link != nullptr, std::string("No such link: '") + A_surfxml_link___ctn_id + "'" + dirname);
653 parsed_link_list.push_back(link);
656 void ETag_surfxml_backbone(){
657 simgrid::kernel::routing::LinkCreationArgs link;
659 link.properties = nullptr;
660 link.id = std::string(A_surfxml_backbone_id);
661 link.bandwidth = surf_parse_get_bandwidth(A_surfxml_backbone_bandwidth, "bandwidth of backbone", link.id.c_str());
662 link.latency = surf_parse_get_time(A_surfxml_backbone_latency, "latency of backbone", link.id.c_str());
663 link.policy = simgrid::s4u::Link::SharingPolicy::SHARED;
665 sg_platf_new_link(&link);
666 routing_cluster_add_backbone(simgrid::s4u::Link::by_name(std::string(A_surfxml_backbone_id))->get_impl());
669 void STag_surfxml_route(){
670 surf_parse_assert_netpoint(A_surfxml_route_src, "Route src='", "' does name a node.");
671 surf_parse_assert_netpoint(A_surfxml_route_dst, "Route dst='", "' does name a node.");
674 void STag_surfxml_ASroute(){
675 surf_parse_assert_netpoint(A_surfxml_ASroute_src, "ASroute src='", "' does name a node.");
676 surf_parse_assert_netpoint(A_surfxml_ASroute_dst, "ASroute dst='", "' does name a node.");
678 surf_parse_assert_netpoint(A_surfxml_ASroute_gw___src, "ASroute gw_src='", "' does name a node.");
679 surf_parse_assert_netpoint(A_surfxml_ASroute_gw___dst, "ASroute gw_dst='", "' does name a node.");
681 void STag_surfxml_zoneRoute(){
682 surf_parse_assert_netpoint(A_surfxml_zoneRoute_src, "zoneRoute src='", "' does name a node.");
683 surf_parse_assert_netpoint(A_surfxml_zoneRoute_dst, "zoneRoute dst='", "' does name a node.");
684 surf_parse_assert_netpoint(A_surfxml_zoneRoute_gw___src, "zoneRoute gw_src='", "' does name a node.");
685 surf_parse_assert_netpoint(A_surfxml_zoneRoute_gw___dst, "zoneRoute gw_dst='", "' does name a node.");
688 void STag_surfxml_bypassRoute(){
689 surf_parse_assert_netpoint(A_surfxml_bypassRoute_src, "bypassRoute src='", "' does name a node.");
690 surf_parse_assert_netpoint(A_surfxml_bypassRoute_dst, "bypassRoute dst='", "' does name a node.");
693 void STag_surfxml_bypassASroute(){
694 surf_parse_assert_netpoint(A_surfxml_bypassASroute_src, "bypassASroute src='", "' does name a node.");
695 surf_parse_assert_netpoint(A_surfxml_bypassASroute_dst, "bypassASroute dst='", "' does name a node.");
696 surf_parse_assert_netpoint(A_surfxml_bypassASroute_gw___src, "bypassASroute gw_src='", "' does name a node.");
697 surf_parse_assert_netpoint(A_surfxml_bypassASroute_gw___dst, "bypassASroute gw_dst='", "' does name a node.");
699 void STag_surfxml_bypassZoneRoute(){
700 surf_parse_assert_netpoint(A_surfxml_bypassZoneRoute_src, "bypassZoneRoute src='", "' does name a node.");
701 surf_parse_assert_netpoint(A_surfxml_bypassZoneRoute_dst, "bypassZoneRoute dst='", "' does name a node.");
702 surf_parse_assert_netpoint(A_surfxml_bypassZoneRoute_gw___src, "bypassZoneRoute gw_src='", "' does name a node.");
703 surf_parse_assert_netpoint(A_surfxml_bypassZoneRoute_gw___dst, "bypassZoneRoute gw_dst='", "' does name a node.");
706 void ETag_surfxml_route(){
707 simgrid::kernel::routing::RouteCreationArgs route;
709 route.src = sg_netpoint_by_name_or_null(A_surfxml_route_src); // tested to not be nullptr in start tag
710 route.dst = sg_netpoint_by_name_or_null(A_surfxml_route_dst); // tested to not be nullptr in start tag
711 route.gw_src = nullptr;
712 route.gw_dst = nullptr;
713 route.symmetrical = (A_surfxml_route_symmetrical == A_surfxml_route_symmetrical_YES);
715 route.link_list.swap(parsed_link_list);
717 sg_platf_new_route(&route);
720 void ETag_surfxml_ASroute()
722 AX_surfxml_zoneRoute_src = AX_surfxml_ASroute_src;
723 AX_surfxml_zoneRoute_dst = AX_surfxml_ASroute_dst;
724 AX_surfxml_zoneRoute_gw___src = AX_surfxml_ASroute_gw___src;
725 AX_surfxml_zoneRoute_gw___dst = AX_surfxml_ASroute_gw___dst;
726 AX_surfxml_zoneRoute_symmetrical = (AT_surfxml_zoneRoute_symmetrical)AX_surfxml_ASroute_symmetrical;
727 ETag_surfxml_zoneRoute();
729 void ETag_surfxml_zoneRoute()
731 simgrid::kernel::routing::RouteCreationArgs ASroute;
733 ASroute.src = sg_netpoint_by_name_or_null(A_surfxml_zoneRoute_src); // tested to not be nullptr in start tag
734 ASroute.dst = sg_netpoint_by_name_or_null(A_surfxml_zoneRoute_dst); // tested to not be nullptr in start tag
736 ASroute.gw_src = sg_netpoint_by_name_or_null(A_surfxml_zoneRoute_gw___src); // tested to not be nullptr in start tag
737 ASroute.gw_dst = sg_netpoint_by_name_or_null(A_surfxml_zoneRoute_gw___dst); // tested to not be nullptr in start tag
739 ASroute.link_list.swap(parsed_link_list);
741 switch (A_surfxml_zoneRoute_symmetrical) {
742 case AU_surfxml_zoneRoute_symmetrical:
743 case A_surfxml_zoneRoute_symmetrical_YES:
744 ASroute.symmetrical = true;
746 case A_surfxml_zoneRoute_symmetrical_NO:
747 ASroute.symmetrical = false;
753 sg_platf_new_route(&ASroute);
756 void ETag_surfxml_bypassRoute(){
757 simgrid::kernel::routing::RouteCreationArgs route;
759 route.src = sg_netpoint_by_name_or_null(A_surfxml_bypassRoute_src); // tested to not be nullptr in start tag
760 route.dst = sg_netpoint_by_name_or_null(A_surfxml_bypassRoute_dst); // tested to not be nullptr in start tag
761 route.gw_src = nullptr;
762 route.gw_dst = nullptr;
763 route.symmetrical = false;
765 route.link_list.swap(parsed_link_list);
767 sg_platf_new_bypassRoute(&route);
770 void ETag_surfxml_bypassASroute()
772 AX_surfxml_bypassZoneRoute_src = AX_surfxml_bypassASroute_src;
773 AX_surfxml_bypassZoneRoute_dst = AX_surfxml_bypassASroute_dst;
774 AX_surfxml_bypassZoneRoute_gw___src = AX_surfxml_bypassASroute_gw___src;
775 AX_surfxml_bypassZoneRoute_gw___dst = AX_surfxml_bypassASroute_gw___dst;
776 ETag_surfxml_bypassZoneRoute();
778 void ETag_surfxml_bypassZoneRoute()
780 simgrid::kernel::routing::RouteCreationArgs ASroute;
782 ASroute.src = sg_netpoint_by_name_or_null(A_surfxml_bypassZoneRoute_src);
783 ASroute.dst = sg_netpoint_by_name_or_null(A_surfxml_bypassZoneRoute_dst);
784 ASroute.link_list.swap(parsed_link_list);
786 ASroute.symmetrical = false;
788 ASroute.gw_src = sg_netpoint_by_name_or_null(A_surfxml_bypassZoneRoute_gw___src);
789 ASroute.gw_dst = sg_netpoint_by_name_or_null(A_surfxml_bypassZoneRoute_gw___dst);
791 sg_platf_new_bypassRoute(&ASroute);
794 void ETag_surfxml_trace(){
795 simgrid::kernel::routing::ProfileCreationArgs trace;
797 trace.id = A_surfxml_trace_id;
798 trace.file = A_surfxml_trace_file;
799 trace.periodicity = surf_parse_get_double(A_surfxml_trace_periodicity);
800 trace.pc_data = surfxml_pcdata;
802 sg_platf_new_trace(&trace);
805 void STag_surfxml_trace___connect()
807 simgrid::kernel::routing::TraceConnectCreationArgs trace_connect;
809 trace_connect.element = A_surfxml_trace___connect_element;
810 trace_connect.trace = A_surfxml_trace___connect_trace;
812 switch (A_surfxml_trace___connect_kind) {
813 case AU_surfxml_trace___connect_kind:
814 case A_surfxml_trace___connect_kind_SPEED:
815 trace_connect.kind = simgrid::kernel::routing::TraceConnectKind::SPEED;
817 case A_surfxml_trace___connect_kind_BANDWIDTH:
818 trace_connect.kind = simgrid::kernel::routing::TraceConnectKind::BANDWIDTH;
820 case A_surfxml_trace___connect_kind_HOST___AVAIL:
821 trace_connect.kind = simgrid::kernel::routing::TraceConnectKind::HOST_AVAIL;
823 case A_surfxml_trace___connect_kind_LATENCY:
824 trace_connect.kind = simgrid::kernel::routing::TraceConnectKind::LATENCY;
826 case A_surfxml_trace___connect_kind_LINK___AVAIL:
827 trace_connect.kind = simgrid::kernel::routing::TraceConnectKind::LINK_AVAIL;
830 surf_parse_error("Invalid trace kind");
832 sg_platf_trace_connect(&trace_connect);
835 void STag_surfxml_AS()
837 AX_surfxml_zone_id = AX_surfxml_AS_id;
838 AX_surfxml_zone_routing = (AT_surfxml_zone_routing)AX_surfxml_AS_routing;
842 void ETag_surfxml_AS()
847 void STag_surfxml_zone()
850 simgrid::kernel::routing::ZoneCreationArgs zone;
851 zone.id = A_surfxml_zone_id;
852 zone.routing = static_cast<int>(A_surfxml_zone_routing);
854 sg_platf_new_Zone_begin(&zone);
857 void ETag_surfxml_zone()
859 sg_platf_new_Zone_seal();
862 void STag_surfxml_config()
865 xbt_assert(current_property_set == nullptr,
866 "Someone forgot to reset the property set to nullptr in its closing tag (or XML malformed)");
867 XBT_DEBUG("START configuration name = %s",A_surfxml_config_id);
868 if (_sg_cfg_init_status == 2) {
869 surf_parse_error("All <config> tags must be given before any platform elements (such as <zone>, <host>, <cluster>, "
874 void ETag_surfxml_config()
876 // Sort config elements before applying.
877 // That's a little waste of time, but not doing so would break the tests
878 std::vector<std::string> keys;
879 for (auto const& kv : *current_property_set) {
880 keys.push_back(kv.first);
882 std::sort(keys.begin(), keys.end());
883 for (std::string key : keys) {
884 if (simgrid::config::is_default(key.c_str())) {
885 std::string cfg = key + ":" + current_property_set->at(key);
886 simgrid::config::set_parse(std::move(cfg));
888 XBT_INFO("The custom configuration '%s' is already defined by user!", key.c_str());
890 XBT_DEBUG("End configuration name = %s",A_surfxml_config_id);
892 delete current_property_set;
893 current_property_set = nullptr;
896 static std::vector<std::string> arguments;
898 void STag_surfxml_process()
900 AX_surfxml_actor_function = AX_surfxml_process_function;
901 STag_surfxml_actor();
904 void STag_surfxml_actor()
907 arguments.assign(1, A_surfxml_actor_function);
908 xbt_assert(current_property_set == nullptr, "Someone forgot to reset the property set to nullptr in its closing tag (or XML malformed)");
911 void ETag_surfxml_process()
913 AX_surfxml_actor_host = AX_surfxml_process_host;
914 AX_surfxml_actor_function = AX_surfxml_process_function;
915 AX_surfxml_actor_start___time = AX_surfxml_process_start___time;
916 AX_surfxml_actor_kill___time = AX_surfxml_process_kill___time;
917 AX_surfxml_actor_on___failure = (AT_surfxml_actor_on___failure)AX_surfxml_process_on___failure;
918 ETag_surfxml_actor();
921 void ETag_surfxml_actor()
923 simgrid::kernel::routing::ActorCreationArgs actor;
925 actor.properties = current_property_set;
926 current_property_set = nullptr;
928 actor.args.swap(arguments);
929 actor.host = A_surfxml_actor_host;
930 actor.function = A_surfxml_actor_function;
931 actor.start_time = surf_parse_get_double(A_surfxml_actor_start___time);
932 actor.kill_time = surf_parse_get_double(A_surfxml_actor_kill___time);
934 switch (A_surfxml_actor_on___failure) {
935 case AU_surfxml_actor_on___failure:
936 case A_surfxml_actor_on___failure_DIE:
937 actor.on_failure = simgrid::kernel::routing::ActorOnFailure::DIE;
939 case A_surfxml_actor_on___failure_RESTART:
940 actor.on_failure = simgrid::kernel::routing::ActorOnFailure::RESTART;
943 surf_parse_error("Invalid on failure behavior");
946 sg_platf_new_actor(&actor);
949 void STag_surfxml_argument(){
950 arguments.push_back(A_surfxml_argument_value);
953 void STag_surfxml_model___prop(){
954 if (not current_model_property_set)
955 current_model_property_set = new std::unordered_map<std::string, std::string>();
957 current_model_property_set->insert({A_surfxml_model___prop_id, A_surfxml_model___prop_value});
960 void ETag_surfxml_prop(){/* Nothing to do */}
961 void STag_surfxml_random(){/* Nothing to do */}
962 void ETag_surfxml_random(){/* Nothing to do */}
963 void ETag_surfxml_trace___connect(){/* Nothing to do */}
964 void STag_surfxml_trace()
965 { /* Nothing to do */
967 void ETag_surfxml_router(){/*Nothing to do*/}
968 void ETag_surfxml_host___link(){/* Nothing to do */}
969 void ETag_surfxml_cabinet(){/* Nothing to do */}
970 void ETag_surfxml_peer(){/* Nothing to do */}
971 void STag_surfxml_backbone(){/* Nothing to do */}
972 void ETag_surfxml_link___ctn(){/* Nothing to do */}
973 void ETag_surfxml_argument(){/* Nothing to do */}
974 void ETag_surfxml_model___prop(){/* Nothing to do */}
976 /* Open and Close parse file */
977 YY_BUFFER_STATE surf_input_buffer;
979 void surf_parse_open(const std::string& file)
981 surf_parsed_filename = file;
982 std::string dir = simgrid::xbt::Path(file).get_dir_name();
983 surf_path.push_back(dir);
985 surf_file_to_parse = surf_fopen(file, "r");
986 if (surf_file_to_parse == nullptr) {
987 std::string cwd = simgrid::xbt::Path().get_name();
988 xbt_die("Unable to open '%s' from '%s'\n", file.c_str(), cwd.c_str());
990 surf_input_buffer = surf_parse__create_buffer(surf_file_to_parse, YY_BUF_SIZE);
991 surf_parse__switch_to_buffer(surf_input_buffer);
992 surf_parse_lineno = 1;
995 void surf_parse_close()
997 surf_path.pop_back(); // remove the dirname of the opened file, that was added in surf_parse_open()
999 if (surf_file_to_parse) {
1000 surf_parse__delete_buffer(surf_input_buffer);
1001 fclose(surf_file_to_parse);
1002 surf_file_to_parse = nullptr; //Must be reset for Bypass
1006 /* Call the lexer to parse the currently opened file */
1009 return surf_parse_lex();