1 /* Copyright (c) 2006-2017. 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/s4u/Engine.hpp"
7 #include "simgrid/sg_config.h"
8 #include "src/kernel/routing/NetPoint.hpp"
9 #include "src/surf/network_interface.hpp"
10 #include "xbt/file.hpp"
12 #include "src/surf/xml/platf_private.hpp"
13 #include <boost/algorithm/string.hpp>
14 #include <boost/algorithm/string/classification.hpp>
15 #include <boost/algorithm/string/split.hpp>
16 #include <initializer_list>
19 #include <unordered_map>
22 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_parse, surf, "Logging specific to the SURF parsing module");
26 #include "simgrid_dtd.c"
28 static const char* surf_parsed_filename; // Currently parsed file (for the error messages)
29 std::vector<simgrid::surf::LinkImpl*> parsed_link_list; /* temporary store of current list link of a route */
34 void surf_parse_assert(bool cond, std::string msg)
37 int lineno = surf_parse_lineno;
39 XBT_ERROR("Parse error at %s:%d: %s", surf_parsed_filename, lineno, msg.c_str());
41 xbt_die("Exiting now");
45 void surf_parse_error(std::string msg)
47 int lineno = surf_parse_lineno;
49 XBT_ERROR("Parse error at %s:%d: %s", surf_parsed_filename, lineno, msg.c_str());
51 xbt_die("Exiting now");
54 void surf_parse_assert_netpoint(std::string hostname, std::string pre, 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*> list;
62 simgrid::s4u::Engine::getInstance()->getNetpointList(&list);
63 std::sort(list.begin(), list.end(), [](simgrid::kernel::routing::NetPoint* a, simgrid::kernel::routing::NetPoint* b) {
64 return a->getName() < b->getName();
67 for (auto const& np : list) {
74 msg += "'" + np->getName() + "'";
75 if (msg.length() > 4096) {
76 msg.pop_back(); // remove trailing quote
77 msg += "...(list truncated)......";
81 surf_parse_error(msg);
84 double surf_parse_get_double(std::string s)
88 } catch (std::invalid_argument& ia) {
89 surf_parse_error(s + " is not a double");
94 int surf_parse_get_int(std::string s)
98 } catch (std::invalid_argument& ia) {
99 surf_parse_error(s + " is not a double");
107 /* Turn something like "1-4,6,9-11" into the vector {1,2,3,4,6,9,10,11} */
108 std::vector<int>* explodesRadical(std::string radicals)
110 std::vector<int>* exploded = new std::vector<int>();
113 std::vector<std::string> radical_elements;
114 boost::split(radical_elements, radicals, boost::is_any_of(","));
115 for (auto const& group : radical_elements) {
116 std::vector<std::string> radical_ends;
117 boost::split(radical_ends, group, boost::is_any_of("-"));
118 int start = surf_parse_get_int(radical_ends.front());
121 switch (radical_ends.size()) {
126 end = surf_parse_get_int(radical_ends.back());
129 surf_parse_error(std::string("Malformed radical: ") + group);
132 for (int i = start; i <= end; i++)
133 exploded->push_back(i);
139 class unit_scale : public std::unordered_map<std::string, double> {
141 using std::unordered_map<std::string, double>::unordered_map;
142 // tuples are : <unit, value for unit, base (2 or 10), true if abbreviated>
143 explicit unit_scale(std::initializer_list<std::tuple<const std::string, double, int, bool>> generators);
146 unit_scale::unit_scale(std::initializer_list<std::tuple<const std::string, double, int, bool>> generators)
148 for (const auto& gen : generators) {
149 const std::string& unit = std::get<0>(gen);
150 double value = std::get<1>(gen);
151 const int base = std::get<2>(gen);
152 const bool abbrev = std::get<3>(gen);
154 std::vector<std::string> prefixes;
158 prefixes = abbrev ? std::vector<std::string>{"Ki", "Mi", "Gi", "Ti", "Pi", "Ei", "Zi", "Yi"}
159 : std::vector<std::string>{"kibi", "mebi", "gibi", "tebi", "pebi", "exbi", "zebi", "yobi"};
163 prefixes = abbrev ? std::vector<std::string>{"k", "M", "G", "T", "P", "E", "Z", "Y"}
164 : std::vector<std::string>{"kilo", "mega", "giga", "tera", "peta", "exa", "zeta", "yotta"};
169 emplace(unit, value);
170 for (const auto& prefix : prefixes) {
172 emplace(prefix + unit, value);
177 /* Note: field `unit' for the last element of parameter `units' should be nullptr. */
178 double surf_parse_get_value_with_unit(const char* string, const unit_scale& units, const char* entity_kind,
179 std::string name, const char* error_msg, const char* default_unit)
183 double res = strtod(string, &ptr);
185 surf_parse_error(std::string("value out of range: ") + string);
187 surf_parse_error(std::string("cannot parse number:") + string);
188 if (ptr[0] == '\0') {
190 return res; // Ok, 0 can be unit-less
192 XBT_WARN("Deprecated unit-less value '%s' for %s %s. %s", string, entity_kind, name.c_str(), error_msg);
193 ptr = (char*)default_unit;
195 auto u = units.find(ptr);
196 if (u == units.end())
197 surf_parse_error(std::string("unknown unit: ") + ptr);
198 return res * u->second;
204 double surf_parse_get_time(const char* string, const char* entity_kind, std::string name)
206 static const unit_scale units{std::make_pair("w", 7 * 24 * 60 * 60),
207 std::make_pair("d", 24 * 60 * 60),
208 std::make_pair("h", 60 * 60),
209 std::make_pair("m", 60),
210 std::make_pair("s", 1.0),
211 std::make_pair("ms", 1e-3),
212 std::make_pair("us", 1e-6),
213 std::make_pair("ns", 1e-9),
214 std::make_pair("ps", 1e-12)};
215 return surf_parse_get_value_with_unit(string, units, entity_kind, name,
216 "Append 's' to your time to get seconds", "s");
219 double surf_parse_get_size(const char* string, const char* entity_kind, std::string name)
221 static const unit_scale units{std::make_tuple("b", 0.125, 2, true), std::make_tuple("b", 0.125, 10, true),
222 std::make_tuple("B", 1.0, 2, true), std::make_tuple("B", 1.0, 10, true)};
223 return surf_parse_get_value_with_unit(string, units, entity_kind, name,
224 "Append 'B' to get bytes (or 'b' for bits but 1B = 8b).", "B");
227 double surf_parse_get_bandwidth(const char* string, const char* entity_kind, std::string name)
229 static const unit_scale units{std::make_tuple("bps", 0.125, 2, true), std::make_tuple("bps", 0.125, 10, true),
230 std::make_tuple("Bps", 1.0, 2, true), std::make_tuple("Bps", 1.0, 10, true)};
231 return surf_parse_get_value_with_unit(string, units, entity_kind, name,
232 "Append 'Bps' to get bytes per second (or 'bps' for bits but 1Bps = 8bps)", "Bps");
235 double surf_parse_get_speed(const char* string, const char* entity_kind, std::string name)
237 static const unit_scale units{std::make_tuple("f", 1.0, 10, true), std::make_tuple("flops", 1.0, 10, false)};
238 return surf_parse_get_value_with_unit(string, units, entity_kind, name,
239 "Append 'f' or 'flops' to your speed to get flop per second", "f");
242 static std::vector<double> surf_parse_get_all_speeds(char* speeds, const char* entity_kind, std::string id)
245 std::vector<double> speed_per_pstate;
247 if (strchr(speeds, ',') == nullptr){
248 double speed = surf_parse_get_speed(speeds, entity_kind, id);
249 speed_per_pstate.push_back(speed);
251 std::vector<std::string> pstate_list;
252 boost::split(pstate_list, speeds, boost::is_any_of(","));
253 for (auto speed_str : pstate_list) {
254 boost::trim(speed_str);
255 double speed = surf_parse_get_speed(speed_str.c_str(), entity_kind, id);
256 speed_per_pstate.push_back(speed);
257 XBT_DEBUG("Speed value: %f", speed);
260 return speed_per_pstate;
264 * All the callback lists that can be overridden anywhere.
265 * (this list should probably be reduced to the bare minimum to allow the models to work)
268 /* make sure these symbols are defined as strong ones in this file so that the linker can resolve them */
270 /* The default current property receiver. Setup in the corresponding opening callbacks. */
271 std::map<std::string, std::string>* current_property_set = nullptr;
272 std::map<std::string, std::string>* current_model_property_set = nullptr;
273 int ZONE_TAG = 0; // Whether we just opened a zone tag (to see what to do with the properties)
275 FILE *surf_file_to_parse = nullptr;
277 /* Stuff relative to storage */
278 void STag_surfxml_storage()
281 XBT_DEBUG("STag_surfxml_storage");
282 xbt_assert(current_property_set == nullptr, "Someone forgot to reset the property set to nullptr in its closing tag (or XML malformed)");
285 void ETag_surfxml_storage()
287 StorageCreationArgs storage;
289 storage.properties = current_property_set;
290 current_property_set = nullptr;
292 storage.id = A_surfxml_storage_id;
293 storage.type_id = A_surfxml_storage_typeId;
294 storage.content = A_surfxml_storage_content;
295 storage.attach = A_surfxml_storage_attach;
297 sg_platf_new_storage(&storage);
299 void STag_surfxml_storage___type()
302 XBT_DEBUG("STag_surfxml_storage___type");
303 xbt_assert(current_property_set == nullptr, "Someone forgot to reset the property set to nullptr in its closing tag (or XML malformed)");
304 xbt_assert(current_model_property_set == nullptr, "Someone forgot to reset the model property set to nullptr in its closing tag (or XML malformed)");
306 void ETag_surfxml_storage___type()
308 StorageTypeCreationArgs storage_type;
310 storage_type.properties = current_property_set;
311 current_property_set = nullptr;
313 storage_type.model_properties = current_model_property_set;
314 current_model_property_set = nullptr;
316 storage_type.content = A_surfxml_storage___type_content;
317 storage_type.id = A_surfxml_storage___type_id;
318 storage_type.model = A_surfxml_storage___type_model;
320 surf_parse_get_size(A_surfxml_storage___type_size, "size of storage type", storage_type.id.c_str());
321 sg_platf_new_storage_type(&storage_type);
324 void STag_surfxml_mount()
326 XBT_DEBUG("STag_surfxml_mount");
329 void ETag_surfxml_mount()
331 MountCreationArgs mount;
333 mount.name = A_surfxml_mount_name;
334 mount.storageId = A_surfxml_mount_storageId;
335 sg_platf_new_mount(&mount);
338 void STag_surfxml_include()
340 xbt_die("<include> tag was removed in SimGrid v3.18. Please stop using it now.");
343 void ETag_surfxml_include()
345 /* Won't happen since <include> is now removed since v3.18. */
348 /* Stag and Etag parse functions */
349 void STag_surfxml_platform() {
350 XBT_ATTRIB_UNUSED double version = surf_parse_get_double(A_surfxml_platform_version);
352 xbt_assert((version >= 1.0), "******* BIG FAT WARNING *********\n "
353 "You're using an ancient XML file.\n"
354 "Since SimGrid 3.1, units are Bytes, Flops, and seconds "
355 "instead of MBytes, MFlops and seconds.\n"
357 "Use simgrid_update_xml to update your file automatically. "
358 "This program is installed automatically with SimGrid, or "
359 "available in the tools/ directory of the source archive.\n"
361 "Please check also out the SURF section of the ChangeLog for "
362 "the 3.1 version for more information. \n"
364 "Last, do not forget to also update your values for "
365 "the calls to MSG_task_create (if any).");
366 xbt_assert((version >= 3.0), "******* BIG FAT WARNING *********\n "
367 "You're using an old XML file.\n"
368 "Use simgrid_update_xml to update your file automatically. "
369 "This program is installed automatically with SimGrid, or "
370 "available in the tools/ directory of the source archive.");
371 xbt_assert((version >= 4.0),
372 "******* FILE %s IS TOO OLD (v:%.1f) *********\n "
373 "Changes introduced in SimGrid 3.13:\n"
374 " - 'power' attribute of hosts (and others) got renamed to 'speed'.\n"
375 " - In <trace_connect>, attribute kind=\"POWER\" is now kind=\"SPEED\".\n"
376 " - DOCTYPE now point to the rignt URL: http://simgrid.gforge.inria.fr/simgrid/simgrid.dtd\n"
377 " - speed, bandwidth and latency attributes now MUST have an explicit unit (f, Bps, s by default)"
379 "Use simgrid_update_xml to update your file automatically. "
380 "This program is installed automatically with SimGrid, or "
381 "available in the tools/ directory of the source archive.",
382 surf_parsed_filename, version);
384 XBT_INFO("You're using a v%.1f XML file (%s) while the current standard is v4.1 "
385 "That's fine, the new version is backward compatible. \n\n"
386 "Use simgrid_update_xml to update your file automatically. "
387 "This program is installed automatically with SimGrid, or "
388 "available in the tools/ directory of the source archive.",
389 version, surf_parsed_filename);
391 xbt_assert(version <= 4.1, "******* FILE %s COMES FROM THE FUTURE (v:%.1f) *********\n "
392 "The most recent formalism that this version of SimGrid understands is v4.1.\n"
393 "Please update your code, or use another, more adapted, file.",
394 surf_parsed_filename, version);
398 void ETag_surfxml_platform(){
402 void STag_surfxml_host(){
404 xbt_assert(current_property_set == nullptr, "Someone forgot to reset the property set to nullptr in its closing tag (or XML malformed)");
407 void STag_surfxml_prop()
409 if (ZONE_TAG) { // We need to retrieve the most recently opened zone
410 XBT_DEBUG("Set zone property %s -> %s", A_surfxml_prop_id, A_surfxml_prop_value);
411 simgrid::s4u::NetZone* netzone = simgrid::s4u::Engine::getInstance()->getNetzoneByNameOrNull(A_surfxml_zone_id);
413 netzone->setProperty(A_surfxml_prop_id, A_surfxml_prop_value);
415 if (not current_property_set)
416 current_property_set = new std::map<std::string, std::string>; // Maybe, it should raise an error
417 current_property_set->insert({A_surfxml_prop_id, A_surfxml_prop_value});
418 XBT_DEBUG("add prop %s=%s into current property set %p", A_surfxml_prop_id, A_surfxml_prop_value,
419 current_property_set);
423 void ETag_surfxml_host() {
424 s_sg_platf_host_cbarg_t host;
426 host.properties = current_property_set;
427 current_property_set = nullptr;
429 host.id = A_surfxml_host_id;
431 host.speed_per_pstate = surf_parse_get_all_speeds(A_surfxml_host_speed, "speed of host", host.id);
433 XBT_DEBUG("pstate: %s", A_surfxml_host_pstate);
434 host.core_amount = surf_parse_get_int(A_surfxml_host_core);
435 host.speed_trace = A_surfxml_host_availability___file[0] ? tmgr_trace_new_from_file(A_surfxml_host_availability___file) : nullptr;
436 host.state_trace = A_surfxml_host_state___file[0] ? tmgr_trace_new_from_file(A_surfxml_host_state___file) : nullptr;
437 host.pstate = surf_parse_get_int(A_surfxml_host_pstate);
438 host.coord = A_surfxml_host_coordinates;
440 sg_platf_new_host(&host);
443 void STag_surfxml_host___link(){
444 XBT_DEBUG("Create a Host_link for %s",A_surfxml_host___link_id);
445 HostLinkCreationArgs host_link;
447 host_link.id = A_surfxml_host___link_id;
448 host_link.link_up = A_surfxml_host___link_up;
449 host_link.link_down = A_surfxml_host___link_down;
450 sg_platf_new_hostlink(&host_link);
453 void STag_surfxml_router(){
454 sg_platf_new_router(A_surfxml_router_id, A_surfxml_router_coordinates);
457 void ETag_surfxml_cluster(){
458 ClusterCreationArgs cluster;
459 cluster.properties = current_property_set;
460 current_property_set = nullptr;
462 cluster.id = A_surfxml_cluster_id;
463 cluster.prefix = A_surfxml_cluster_prefix;
464 cluster.suffix = A_surfxml_cluster_suffix;
465 cluster.radicals = explodesRadical(A_surfxml_cluster_radical);
466 cluster.speeds = surf_parse_get_all_speeds(A_surfxml_cluster_speed, "speed of cluster", cluster.id);
467 cluster.core_amount = surf_parse_get_int(A_surfxml_cluster_core);
468 cluster.bw = surf_parse_get_bandwidth(A_surfxml_cluster_bw, "bw of cluster", cluster.id);
469 cluster.lat = surf_parse_get_time(A_surfxml_cluster_lat, "lat of cluster", cluster.id);
470 if(strcmp(A_surfxml_cluster_bb___bw,""))
471 cluster.bb_bw = surf_parse_get_bandwidth(A_surfxml_cluster_bb___bw, "bb_bw of cluster", cluster.id);
472 if(strcmp(A_surfxml_cluster_bb___lat,""))
473 cluster.bb_lat = surf_parse_get_time(A_surfxml_cluster_bb___lat, "bb_lat of cluster", cluster.id);
474 if(strcmp(A_surfxml_cluster_limiter___link,""))
475 cluster.limiter_link = surf_parse_get_bandwidth(A_surfxml_cluster_limiter___link, "limiter_link of cluster", cluster.id);
476 if(strcmp(A_surfxml_cluster_loopback___bw,""))
477 cluster.loopback_bw = surf_parse_get_bandwidth(A_surfxml_cluster_loopback___bw, "loopback_bw of cluster", cluster.id);
478 if(strcmp(A_surfxml_cluster_loopback___lat,""))
479 cluster.loopback_lat = surf_parse_get_time(A_surfxml_cluster_loopback___lat, "loopback_lat of cluster", cluster.id);
481 switch(AX_surfxml_cluster_topology){
482 case A_surfxml_cluster_topology_FLAT:
483 cluster.topology = ClusterTopology::FLAT;
485 case A_surfxml_cluster_topology_TORUS:
486 cluster.topology = ClusterTopology::TORUS;
488 case A_surfxml_cluster_topology_FAT___TREE:
489 cluster.topology = ClusterTopology::FAT_TREE;
491 case A_surfxml_cluster_topology_DRAGONFLY:
492 cluster.topology = ClusterTopology::DRAGONFLY;
495 surf_parse_error(std::string("Invalid cluster topology for cluster ") + cluster.id);
498 cluster.topo_parameters = A_surfxml_cluster_topo___parameters;
499 cluster.router_id = A_surfxml_cluster_router___id;
501 switch (AX_surfxml_cluster_sharing___policy) {
502 case A_surfxml_cluster_sharing___policy_SHARED:
503 cluster.sharing_policy = SURF_LINK_SHARED;
505 case A_surfxml_cluster_sharing___policy_FULLDUPLEX:
506 cluster.sharing_policy = SURF_LINK_FULLDUPLEX;
508 case A_surfxml_cluster_sharing___policy_FATPIPE:
509 cluster.sharing_policy = SURF_LINK_FATPIPE;
512 surf_parse_error(std::string("Invalid cluster sharing policy for cluster ") + cluster.id);
515 switch (AX_surfxml_cluster_bb___sharing___policy) {
516 case A_surfxml_cluster_bb___sharing___policy_FATPIPE:
517 cluster.bb_sharing_policy = SURF_LINK_FATPIPE;
519 case A_surfxml_cluster_bb___sharing___policy_SHARED:
520 cluster.bb_sharing_policy = SURF_LINK_SHARED;
523 surf_parse_error(std::string("Invalid bb sharing policy in cluster ") + cluster.id);
527 sg_platf_new_cluster(&cluster);
530 void STag_surfxml_cluster(){
532 parse_after_config();
533 xbt_assert(current_property_set == nullptr, "Someone forgot to reset the property set to nullptr in its closing tag (or XML malformed)");
536 void STag_surfxml_cabinet(){
537 parse_after_config();
538 CabinetCreationArgs cabinet;
539 cabinet.id = A_surfxml_cabinet_id;
540 cabinet.prefix = A_surfxml_cabinet_prefix;
541 cabinet.suffix = A_surfxml_cabinet_suffix;
542 cabinet.speed = surf_parse_get_speed(A_surfxml_cabinet_speed, "speed of cabinet", cabinet.id.c_str());
543 cabinet.bw = surf_parse_get_bandwidth(A_surfxml_cabinet_bw, "bw of cabinet", cabinet.id.c_str());
544 cabinet.lat = surf_parse_get_time(A_surfxml_cabinet_lat, "lat of cabinet", cabinet.id.c_str());
545 cabinet.radicals = explodesRadical(A_surfxml_cabinet_radical);
547 sg_platf_new_cabinet(&cabinet);
550 void STag_surfxml_peer(){
551 parse_after_config();
552 PeerCreationArgs peer;
554 peer.id = std::string(A_surfxml_peer_id);
555 peer.speed = surf_parse_get_speed(A_surfxml_peer_speed, "speed of peer", peer.id.c_str());
556 peer.bw_in = surf_parse_get_bandwidth(A_surfxml_peer_bw___in, "bw_in of peer", peer.id.c_str());
557 peer.bw_out = surf_parse_get_bandwidth(A_surfxml_peer_bw___out, "bw_out of peer", peer.id.c_str());
558 peer.coord = A_surfxml_peer_coordinates;
559 peer.speed_trace = A_surfxml_peer_availability___file[0] ? tmgr_trace_new_from_file(A_surfxml_peer_availability___file) : nullptr;
560 peer.state_trace = A_surfxml_peer_state___file[0] ? tmgr_trace_new_from_file(A_surfxml_peer_state___file) : nullptr;
562 if (A_surfxml_peer_lat[0] != '\0')
563 XBT_WARN("The latency parameter in <peer> is now deprecated. Use the z coordinate instead of '%s'.",
566 sg_platf_new_peer(&peer);
569 void STag_surfxml_link(){
571 xbt_assert(current_property_set == nullptr, "Someone forgot to reset the property set to nullptr in its closing tag (or XML malformed)");
574 void ETag_surfxml_link(){
575 LinkCreationArgs link;
577 link.properties = current_property_set;
578 current_property_set = nullptr;
580 link.id = std::string(A_surfxml_link_id);
581 link.bandwidth = surf_parse_get_bandwidth(A_surfxml_link_bandwidth, "bandwidth of link", link.id.c_str());
582 link.bandwidth_trace = A_surfxml_link_bandwidth___file[0] ? tmgr_trace_new_from_file(A_surfxml_link_bandwidth___file) : nullptr;
583 link.latency = surf_parse_get_time(A_surfxml_link_latency, "latency of link", link.id.c_str());
584 link.latency_trace = A_surfxml_link_latency___file[0] ? tmgr_trace_new_from_file(A_surfxml_link_latency___file) : nullptr;
585 link.state_trace = A_surfxml_link_state___file[0] ? tmgr_trace_new_from_file(A_surfxml_link_state___file):nullptr;
587 switch (A_surfxml_link_sharing___policy) {
588 case A_surfxml_link_sharing___policy_SHARED:
589 link.policy = SURF_LINK_SHARED;
591 case A_surfxml_link_sharing___policy_FATPIPE:
592 link.policy = SURF_LINK_FATPIPE;
594 case A_surfxml_link_sharing___policy_FULLDUPLEX:
595 link.policy = SURF_LINK_FULLDUPLEX;
598 surf_parse_error(std::string("Invalid sharing policy in link ") + link.id);
602 sg_platf_new_link(&link);
605 void STag_surfxml_link___ctn()
607 simgrid::surf::LinkImpl* link = nullptr;
608 switch (A_surfxml_link___ctn_direction) {
609 case AU_surfxml_link___ctn_direction:
610 case A_surfxml_link___ctn_direction_NONE:
611 link = simgrid::surf::LinkImpl::byName(A_surfxml_link___ctn_id);
613 case A_surfxml_link___ctn_direction_UP:
614 link = simgrid::surf::LinkImpl::byName(std::string(A_surfxml_link___ctn_id) + "_UP");
616 case A_surfxml_link___ctn_direction_DOWN:
617 link = simgrid::surf::LinkImpl::byName(std::string(A_surfxml_link___ctn_id) + "_DOWN");
620 surf_parse_error(std::string("Invalid direction for link ") + A_surfxml_link___ctn_id);
624 const char* dirname = "";
625 switch (A_surfxml_link___ctn_direction) {
626 case A_surfxml_link___ctn_direction_UP:
627 dirname = " (upward)";
629 case A_surfxml_link___ctn_direction_DOWN:
630 dirname = " (downward)";
635 surf_parse_assert(link != nullptr, std::string("No such link: '") + A_surfxml_link___ctn_id + "'" + dirname);
636 parsed_link_list.push_back(link);
639 void ETag_surfxml_backbone(){
640 LinkCreationArgs link;
642 link.properties = nullptr;
643 link.id = std::string(A_surfxml_backbone_id);
644 link.bandwidth = surf_parse_get_bandwidth(A_surfxml_backbone_bandwidth, "bandwidth of backbone", link.id.c_str());
645 link.latency = surf_parse_get_time(A_surfxml_backbone_latency, "latency of backbone", link.id.c_str());
646 link.policy = SURF_LINK_SHARED;
648 sg_platf_new_link(&link);
649 routing_cluster_add_backbone(simgrid::surf::LinkImpl::byName(A_surfxml_backbone_id));
652 void STag_surfxml_route(){
653 surf_parse_assert_netpoint(A_surfxml_route_src, "Route src='", "' does name a node.");
654 surf_parse_assert_netpoint(A_surfxml_route_dst, "Route dst='", "' does name a node.");
657 void STag_surfxml_ASroute(){
658 surf_parse_assert_netpoint(A_surfxml_ASroute_src, "ASroute src='", "' does name a node.");
659 surf_parse_assert_netpoint(A_surfxml_ASroute_dst, "ASroute dst='", "' does name a node.");
661 surf_parse_assert_netpoint(A_surfxml_ASroute_gw___src, "ASroute gw_src='", "' does name a node.");
662 surf_parse_assert_netpoint(A_surfxml_ASroute_gw___dst, "ASroute gw_dst='", "' does name a node.");
664 void STag_surfxml_zoneRoute(){
665 surf_parse_assert_netpoint(A_surfxml_zoneRoute_src, "zoneRoute src='", "' does name a node.");
666 surf_parse_assert_netpoint(A_surfxml_zoneRoute_dst, "zoneRoute dst='", "' does name a node.");
667 surf_parse_assert_netpoint(A_surfxml_zoneRoute_gw___src, "zoneRoute gw_src='", "' does name a node.");
668 surf_parse_assert_netpoint(A_surfxml_zoneRoute_gw___dst, "zoneRoute gw_dst='", "' does name a node.");
671 void STag_surfxml_bypassRoute(){
672 surf_parse_assert_netpoint(A_surfxml_bypassRoute_src, "bypassRoute src='", "' does name a node.");
673 surf_parse_assert_netpoint(A_surfxml_bypassRoute_dst, "bypassRoute dst='", "' does name a node.");
676 void STag_surfxml_bypassASroute(){
677 surf_parse_assert_netpoint(A_surfxml_bypassASroute_src, "bypassASroute src='", "' does name a node.");
678 surf_parse_assert_netpoint(A_surfxml_bypassASroute_dst, "bypassASroute dst='", "' does name a node.");
679 surf_parse_assert_netpoint(A_surfxml_bypassASroute_gw___src, "bypassASroute gw_src='", "' does name a node.");
680 surf_parse_assert_netpoint(A_surfxml_bypassASroute_gw___dst, "bypassASroute gw_dst='", "' does name a node.");
682 void STag_surfxml_bypassZoneRoute(){
683 surf_parse_assert_netpoint(A_surfxml_bypassZoneRoute_src, "bypassZoneRoute src='", "' does name a node.");
684 surf_parse_assert_netpoint(A_surfxml_bypassZoneRoute_dst, "bypassZoneRoute dst='", "' does name a node.");
685 surf_parse_assert_netpoint(A_surfxml_bypassZoneRoute_gw___src, "bypassZoneRoute gw_src='", "' does name a node.");
686 surf_parse_assert_netpoint(A_surfxml_bypassZoneRoute_gw___dst, "bypassZoneRoute gw_dst='", "' does name a node.");
689 void ETag_surfxml_route(){
690 RouteCreationArgs route;
692 route.src = sg_netpoint_by_name_or_null(A_surfxml_route_src); // tested to not be nullptr in start tag
693 route.dst = sg_netpoint_by_name_or_null(A_surfxml_route_dst); // tested to not be nullptr in start tag
694 route.gw_src = nullptr;
695 route.gw_dst = nullptr;
696 route.symmetrical = (A_surfxml_route_symmetrical == A_surfxml_route_symmetrical_YES);
698 route.link_list.swap(parsed_link_list);
700 sg_platf_new_route(&route);
703 void ETag_surfxml_ASroute()
705 AX_surfxml_zoneRoute_src = AX_surfxml_ASroute_src;
706 AX_surfxml_zoneRoute_dst = AX_surfxml_ASroute_dst;
707 AX_surfxml_zoneRoute_gw___src = AX_surfxml_ASroute_gw___src;
708 AX_surfxml_zoneRoute_gw___dst = AX_surfxml_ASroute_gw___dst;
709 AX_surfxml_zoneRoute_symmetrical = (AT_surfxml_zoneRoute_symmetrical)AX_surfxml_ASroute_symmetrical;
710 ETag_surfxml_zoneRoute();
712 void ETag_surfxml_zoneRoute()
714 RouteCreationArgs ASroute;
716 ASroute.src = sg_netpoint_by_name_or_null(A_surfxml_zoneRoute_src); // tested to not be nullptr in start tag
717 ASroute.dst = sg_netpoint_by_name_or_null(A_surfxml_zoneRoute_dst); // tested to not be nullptr in start tag
719 ASroute.gw_src = sg_netpoint_by_name_or_null(A_surfxml_zoneRoute_gw___src); // tested to not be nullptr in start tag
720 ASroute.gw_dst = sg_netpoint_by_name_or_null(A_surfxml_zoneRoute_gw___dst); // tested to not be nullptr in start tag
722 ASroute.link_list.swap(parsed_link_list);
724 switch (A_surfxml_zoneRoute_symmetrical) {
725 case AU_surfxml_zoneRoute_symmetrical:
726 case A_surfxml_zoneRoute_symmetrical_YES:
727 ASroute.symmetrical = true;
729 case A_surfxml_zoneRoute_symmetrical_NO:
730 ASroute.symmetrical = false;
736 sg_platf_new_route(&ASroute);
739 void ETag_surfxml_bypassRoute(){
740 RouteCreationArgs route;
742 route.src = sg_netpoint_by_name_or_null(A_surfxml_bypassRoute_src); // tested to not be nullptr in start tag
743 route.dst = sg_netpoint_by_name_or_null(A_surfxml_bypassRoute_dst); // tested to not be nullptr in start tag
744 route.gw_src = nullptr;
745 route.gw_dst = nullptr;
746 route.symmetrical = false;
748 route.link_list.swap(parsed_link_list);
750 sg_platf_new_bypassRoute(&route);
753 void ETag_surfxml_bypassASroute()
755 AX_surfxml_bypassZoneRoute_src = AX_surfxml_bypassASroute_src;
756 AX_surfxml_bypassZoneRoute_dst = AX_surfxml_bypassASroute_dst;
757 AX_surfxml_bypassZoneRoute_gw___src = AX_surfxml_bypassASroute_gw___src;
758 AX_surfxml_bypassZoneRoute_gw___dst = AX_surfxml_bypassASroute_gw___dst;
759 ETag_surfxml_bypassZoneRoute();
761 void ETag_surfxml_bypassZoneRoute()
763 RouteCreationArgs ASroute;
765 ASroute.src = sg_netpoint_by_name_or_null(A_surfxml_bypassZoneRoute_src);
766 ASroute.dst = sg_netpoint_by_name_or_null(A_surfxml_bypassZoneRoute_dst);
767 ASroute.link_list.swap(parsed_link_list);
769 ASroute.symmetrical = false;
771 ASroute.gw_src = sg_netpoint_by_name_or_null(A_surfxml_bypassZoneRoute_gw___src);
772 ASroute.gw_dst = sg_netpoint_by_name_or_null(A_surfxml_bypassZoneRoute_gw___dst);
774 sg_platf_new_bypassRoute(&ASroute);
777 void ETag_surfxml_trace(){
778 TraceCreationArgs trace;
780 trace.id = A_surfxml_trace_id;
781 trace.file = A_surfxml_trace_file;
782 trace.periodicity = surf_parse_get_double(A_surfxml_trace_periodicity);
783 trace.pc_data = surfxml_pcdata;
785 sg_platf_new_trace(&trace);
788 void STag_surfxml_trace___connect()
790 parse_after_config();
791 TraceConnectCreationArgs trace_connect;
793 trace_connect.element = A_surfxml_trace___connect_element;
794 trace_connect.trace = A_surfxml_trace___connect_trace;
796 switch (A_surfxml_trace___connect_kind) {
797 case AU_surfxml_trace___connect_kind:
798 case A_surfxml_trace___connect_kind_SPEED:
799 trace_connect.kind = TraceConnectKind::SPEED;
801 case A_surfxml_trace___connect_kind_BANDWIDTH:
802 trace_connect.kind = TraceConnectKind::BANDWIDTH;
804 case A_surfxml_trace___connect_kind_HOST___AVAIL:
805 trace_connect.kind = TraceConnectKind::HOST_AVAIL;
807 case A_surfxml_trace___connect_kind_LATENCY:
808 trace_connect.kind = TraceConnectKind::LATENCY;
810 case A_surfxml_trace___connect_kind_LINK___AVAIL:
811 trace_connect.kind = TraceConnectKind::LINK_AVAIL;
814 surf_parse_error("Invalid trace kind");
817 sg_platf_trace_connect(&trace_connect);
820 void STag_surfxml_AS()
822 AX_surfxml_zone_id = AX_surfxml_AS_id;
823 AX_surfxml_zone_routing = (AT_surfxml_zone_routing)AX_surfxml_AS_routing;
827 void ETag_surfxml_AS()
832 void STag_surfxml_zone()
834 parse_after_config();
836 ZoneCreationArgs zone;
837 zone.id = A_surfxml_zone_id;
838 zone.routing = static_cast<int>(A_surfxml_zone_routing);
840 sg_platf_new_Zone_begin(&zone);
843 void ETag_surfxml_zone()
845 sg_platf_new_Zone_seal();
848 void STag_surfxml_config()
851 xbt_assert(current_property_set == nullptr,
852 "Someone forgot to reset the property set to nullptr in its closing tag (or XML malformed)");
853 XBT_DEBUG("START configuration name = %s",A_surfxml_config_id);
854 if (_sg_cfg_init_status == 2) {
855 surf_parse_error("All <config> tags must be given before any platform elements (such as <zone>, <host>, <cluster>, "
860 void ETag_surfxml_config()
862 for (auto const& elm : *current_property_set) {
863 if (xbt_cfg_is_default_value(elm.first.c_str())) {
864 std::string cfg = elm.first + ":" + elm.second;
865 xbt_cfg_set_parse(cfg.c_str());
867 XBT_INFO("The custom configuration '%s' is already defined by user!", elm.first.c_str());
869 XBT_DEBUG("End configuration name = %s",A_surfxml_config_id);
871 delete current_property_set;
872 current_property_set = nullptr;
875 static std::vector<std::string> arguments;
877 void STag_surfxml_process()
879 AX_surfxml_actor_function = AX_surfxml_process_function;
880 STag_surfxml_actor();
883 void STag_surfxml_actor()
886 arguments.assign(1, A_surfxml_actor_function);
887 xbt_assert(current_property_set == nullptr, "Someone forgot to reset the property set to nullptr in its closing tag (or XML malformed)");
890 void ETag_surfxml_process()
892 AX_surfxml_actor_host = AX_surfxml_process_host;
893 AX_surfxml_actor_function = AX_surfxml_process_function;
894 AX_surfxml_actor_start___time = AX_surfxml_process_start___time;
895 AX_surfxml_actor_kill___time = AX_surfxml_process_kill___time;
896 AX_surfxml_actor_on___failure = (AT_surfxml_actor_on___failure)AX_surfxml_process_on___failure;
897 ETag_surfxml_actor();
900 void ETag_surfxml_actor()
902 ActorCreationArgs actor;
904 actor.properties = current_property_set;
905 current_property_set = nullptr;
907 actor.args.swap(arguments);
908 actor.host = A_surfxml_actor_host;
909 actor.function = A_surfxml_actor_function;
910 actor.start_time = surf_parse_get_double(A_surfxml_actor_start___time);
911 actor.kill_time = surf_parse_get_double(A_surfxml_actor_kill___time);
913 switch (A_surfxml_actor_on___failure) {
914 case AU_surfxml_actor_on___failure:
915 case A_surfxml_actor_on___failure_DIE:
916 actor.on_failure = ActorOnFailure::DIE;
918 case A_surfxml_actor_on___failure_RESTART:
919 actor.on_failure = ActorOnFailure::RESTART;
922 surf_parse_error("Invalid on failure behavior");
926 sg_platf_new_actor(&actor);
929 void STag_surfxml_argument(){
930 arguments.push_back(A_surfxml_argument_value);
933 void STag_surfxml_model___prop(){
934 if (not current_model_property_set)
935 current_model_property_set = new std::map<std::string, std::string>();
937 current_model_property_set->insert({A_surfxml_model___prop_id, A_surfxml_model___prop_value});
940 void ETag_surfxml_prop(){/* Nothing to do */}
941 void STag_surfxml_random(){/* Nothing to do */}
942 void ETag_surfxml_random(){/* Nothing to do */}
943 void ETag_surfxml_trace___connect(){/* Nothing to do */}
944 void STag_surfxml_trace(){parse_after_config();}
945 void ETag_surfxml_router(){/*Nothing to do*/}
946 void ETag_surfxml_host___link(){/* Nothing to do */}
947 void ETag_surfxml_cabinet(){/* Nothing to do */}
948 void ETag_surfxml_peer(){/* Nothing to do */}
949 void STag_surfxml_backbone(){/* Nothing to do */}
950 void ETag_surfxml_link___ctn(){/* Nothing to do */}
951 void ETag_surfxml_argument(){/* Nothing to do */}
952 void ETag_surfxml_model___prop(){/* Nothing to do */}
954 /* Open and Close parse file */
955 YY_BUFFER_STATE surf_input_buffer;
957 void surf_parse_open(const char *file)
959 xbt_assert(file, "Cannot parse the nullptr file. Bypassing the parser is strongly deprecated nowadays.");
961 surf_parsed_filename = file;
962 std::string dir = simgrid::xbt::Path(file).getDirname();
963 surf_path.push_back(dir);
965 surf_file_to_parse = surf_fopen(file, "r");
966 if (surf_file_to_parse == nullptr)
967 xbt_die("Unable to open '%s'\n", file);
968 surf_input_buffer = surf_parse__create_buffer(surf_file_to_parse, YY_BUF_SIZE);
969 surf_parse__switch_to_buffer(surf_input_buffer);
970 surf_parse_lineno = 1;
973 void surf_parse_close()
975 surf_path.pop_back(); // remove the dirname of the opened file, that was added in surf_parse_open()
977 if (surf_file_to_parse) {
978 surf_parse__delete_buffer(surf_input_buffer);
979 fclose(surf_file_to_parse);
980 surf_file_to_parse = nullptr; //Must be reset for Bypass
984 /* Call the lexer to parse the currently opened file */
987 return surf_parse_lex();