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"
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>
18 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_parse, surf, "Logging specific to the SURF parsing module");
22 int ETag_surfxml_include_state();
24 #include "simgrid_dtd.c"
26 char* surf_parsed_filename = nullptr; // to locate parse error messages
28 std::vector<simgrid::surf::LinkImpl*> parsed_link_list; /* temporary store of current list link of a route */
33 void surf_parse_assert(bool cond, const char *fmt, ...) {
37 int lineno = surf_parse_lineno;
38 char *msg = bvprintf(fmt,va);
41 XBT_ERROR("Parse error at %s:%d: %s", surf_parsed_filename, lineno, msg);
43 xbt_die("Exiting now");
46 void surf_parse_error(const char *fmt, ...) {
49 int lineno = surf_parse_lineno;
50 char *msg = bvprintf(fmt,va);
53 XBT_ERROR("Parse error at %s:%d: %s", surf_parsed_filename, lineno, msg);
55 xbt_die("Exiting now");
57 void surf_parse_assert_netpoint(char* hostname, const char* pre, const char* post)
59 if (sg_netpoint_by_name_or_null(hostname) != nullptr) // found
62 std::string msg = std::string(pre);
65 msg += " Existing netpoints: \n";
67 std::vector<simgrid::kernel::routing::NetPoint*> list;
68 simgrid::s4u::Engine::getInstance()->getNetpointList(&list);
69 std::sort(list.begin(), list.end(),
70 [](simgrid::kernel::routing::NetPoint* a, simgrid::kernel::routing::NetPoint* b) {
71 return a->name() < b->name();
74 for (auto np : list) {
81 msg += "'" + np->name() + "'";
82 if (msg.length() > 4096) {
83 msg.pop_back(); // remove trailing quote
84 msg += "...(list truncated)......";
88 surf_parse_error("%s", msg.c_str());
91 void surf_parse_warn(const char *fmt, ...) {
94 char *msg = bvprintf(fmt,va);
96 XBT_WARN("%s:%d: %s", surf_parsed_filename, surf_parse_lineno, msg);
100 double surf_parse_get_double(const char *string) {
102 int ret = sscanf(string, "%lg", &res);
104 surf_parse_error("%s is not a double", string);
108 int surf_parse_get_int(const char *string) {
110 int ret = sscanf(string, "%d", &res);
112 surf_parse_error("%s is not an integer", string);
116 /* Turn something like "1-4,6,9-11" into the vector {1,2,3,4,6,9,10,11} */
117 static std::vector<int>* explodesRadical(const char* radicals)
119 std::vector<int>* exploded = new std::vector<int>();
122 std::vector<std::string> radical_elements;
123 boost::split(radical_elements, radicals, boost::is_any_of(","));
124 for (auto group : radical_elements) {
125 std::vector<std::string> radical_ends;
126 boost::split(radical_ends, group, boost::is_any_of("-"));
127 int start = surf_parse_get_int((radical_ends.front()).c_str());
130 switch (radical_ends.size()) {
135 end = surf_parse_get_int((radical_ends.back()).c_str());
138 surf_parse_error("Malformed radical: %s", group.c_str());
141 for (int i = start; i <= end; i++)
142 exploded->push_back(i);
153 /* Note: field `unit' for the last element of parameter `units' should be nullptr. */
154 static double surf_parse_get_value_with_unit(const char *string, const struct unit_scale *units,
155 const char *entity_kind, const char *name, const char *error_msg, const char *default_unit)
160 double res = strtod(string, &ptr);
162 surf_parse_error("value out of range: %s", string);
164 surf_parse_error("cannot parse number: %s", string);
165 if (ptr[0] == '\0') {
167 return res; // Ok, 0 can be unit-less
169 XBT_WARN("Deprecated unit-less value '%s' for %s %s. %s",string, entity_kind, name, error_msg);
170 ptr = (char*)default_unit;
172 for (i = 0; units[i].unit != nullptr && strcmp(ptr, units[i].unit) != 0; i++);
174 if (units[i].unit != nullptr)
175 res *= units[i].scale;
177 surf_parse_error("unknown unit: %s", ptr);
181 double surf_parse_get_time(const char *string, const char *entity_kind, const char *name)
183 const struct unit_scale units[] = {
184 { "w", 7 * 24 * 60 * 60 },
185 { "d", 24 * 60 * 60 },
195 return surf_parse_get_value_with_unit(string, units, entity_kind, name,
196 "Append 's' to your time to get seconds", "s");
199 double surf_parse_get_size(const char *string, const char *entity_kind, const char *name)
201 const struct unit_scale units[] = {
202 { "EiB", pow(1024, 6) },
203 { "PiB", pow(1024, 5) },
204 { "TiB", pow(1024, 4) },
205 { "GiB", pow(1024, 3) },
206 { "MiB", pow(1024, 2) },
215 { "Eib", 0.125 * pow(1024, 6) },
216 { "Pib", 0.125 * pow(1024, 5) },
217 { "Tib", 0.125 * pow(1024, 4) },
218 { "Gib", 0.125 * pow(1024, 3) },
219 { "Mib", 0.125 * pow(1024, 2) },
220 { "Kib", 0.125 * 1024 },
221 { "Eb", 0.125 * 1e18 },
222 { "Pb", 0.125 * 1e15 },
223 { "Tb", 0.125 * 1e12 },
224 { "Gb", 0.125 * 1e9 },
225 { "Mb", 0.125 * 1e6 },
226 { "kb", 0.125 * 1e3 },
230 return surf_parse_get_value_with_unit(string, units, entity_kind, name,
231 "Append 'B' to get bytes (or 'b' for bits but 1B = 8b).", "B");
234 double surf_parse_get_bandwidth(const char *string, const char *entity_kind, const char *name)
236 const struct unit_scale units[] = {
237 { "EiBps", pow(1024, 6) },
238 { "PiBps", pow(1024, 5) },
239 { "TiBps", pow(1024, 4) },
240 { "GiBps", pow(1024, 3) },
241 { "MiBps", pow(1024, 2) },
250 { "Eibps", 0.125 * pow(1024, 6) },
251 { "Pibps", 0.125 * pow(1024, 5) },
252 { "Tibps", 0.125 * pow(1024, 4) },
253 { "Gibps", 0.125 * pow(1024, 3) },
254 { "Mibps", 0.125 * pow(1024, 2) },
255 { "Kibps", 0.125 * 1024 },
256 { "Tbps", 0.125 * 1e12 },
257 { "Gbps", 0.125 * 1e9 },
258 { "Mbps", 0.125 * 1e6 },
259 { "kbps", 0.125 * 1e3 },
263 return surf_parse_get_value_with_unit(string, units, entity_kind, name,
264 "Append 'Bps' to get bytes per second (or 'bps' for bits but 1Bps = 8bps)", "Bps");
267 double surf_parse_get_speed(const char *string, const char *entity_kind, const char *name)
269 const struct unit_scale units[] = {
270 { "yottaflops", 1e24 },
272 { "zettaflops", 1e21 },
274 { "exaflops", 1e18 },
276 { "petaflops", 1e15 },
278 { "teraflops", 1e12 },
280 { "gigaflops", 1e9 },
282 { "megaflops", 1e6 },
284 { "kiloflops", 1e3 },
290 return surf_parse_get_value_with_unit(string, units, entity_kind, name,
291 "Append 'f' or 'flops' to your speed to get flop per second", "f");
294 static std::vector<double> surf_parse_get_all_speeds(char* speeds, const char* entity_kind, const char* id){
296 std::vector<double> speed_per_pstate;
298 if (strchr(speeds, ',') == nullptr){
299 double speed = surf_parse_get_speed(speeds, entity_kind, id);
300 speed_per_pstate.push_back(speed);
302 std::vector<std::string> pstate_list;
303 boost::split(pstate_list, speeds, boost::is_any_of(","));
304 for (auto speed_str : pstate_list) {
305 boost::trim(speed_str);
306 double speed = surf_parse_get_speed(speed_str.c_str(), entity_kind, id);
307 speed_per_pstate.push_back(speed);
308 XBT_DEBUG("Speed value: %f", speed);
311 return speed_per_pstate;
315 * All the callback lists that can be overridden anywhere.
316 * (this list should probably be reduced to the bare minimum to allow the models to work)
319 /* make sure these symbols are defined as strong ones in this file so that the linker can resolve them */
321 /* The default current property receiver. Setup in the corresponding opening callbacks. */
322 std::map<std::string, std::string>* current_property_set = nullptr;
323 std::map<std::string, std::string>* current_model_property_set = nullptr;
324 int ZONE_TAG = 0; // Whether we just opened a zone tag (to see what to do with the properties)
326 YY_BUFFER_STATE surf_input_buffer;
327 FILE *surf_file_to_parse = nullptr;
329 /* Stuff relative to storage */
330 void STag_surfxml_storage()
333 XBT_DEBUG("STag_surfxml_storage");
334 xbt_assert(current_property_set == nullptr, "Someone forgot to reset the property set to nullptr in its closing tag (or XML malformed)");
337 void ETag_surfxml_storage()
339 StorageCreationArgs storage;
341 storage.properties = current_property_set;
342 current_property_set = nullptr;
344 storage.id = A_surfxml_storage_id;
345 storage.type_id = A_surfxml_storage_typeId;
346 storage.content = A_surfxml_storage_content;
347 storage.attach = A_surfxml_storage_attach;
349 sg_platf_new_storage(&storage);
351 void STag_surfxml_storage___type()
354 XBT_DEBUG("STag_surfxml_storage___type");
355 xbt_assert(current_property_set == nullptr, "Someone forgot to reset the property set to nullptr in its closing tag (or XML malformed)");
356 xbt_assert(current_model_property_set == nullptr, "Someone forgot to reset the model property set to nullptr in its closing tag (or XML malformed)");
358 void ETag_surfxml_storage___type()
360 StorageTypeCreationArgs storage_type;
362 storage_type.properties = current_property_set;
363 current_property_set = nullptr;
365 storage_type.model_properties = current_model_property_set;
366 current_model_property_set = nullptr;
368 storage_type.content = A_surfxml_storage___type_content;
369 storage_type.id = A_surfxml_storage___type_id;
370 storage_type.model = A_surfxml_storage___type_model;
372 surf_parse_get_size(A_surfxml_storage___type_size, "size of storage type", storage_type.id.c_str());
373 sg_platf_new_storage_type(&storage_type);
376 void STag_surfxml_mount()
378 XBT_DEBUG("STag_surfxml_mount");
381 void ETag_surfxml_mount()
383 MountCreationArgs mount;
385 mount.name = A_surfxml_mount_name;
386 mount.storageId = A_surfxml_mount_storageId;
387 sg_platf_new_mount(&mount);
391 * Stuff relative to the <include> tag
393 static std::vector<YY_BUFFER_STATE> surf_input_buffer_stack;
394 static std::vector<FILE*> surf_file_to_parse_stack;
395 static std::vector<char*> surf_parsed_filename_stack;
397 void STag_surfxml_include()
399 parse_after_config();
400 XBT_DEBUG("STag_surfxml_include '%s'",A_surfxml_include_file);
401 surf_parsed_filename_stack.push_back(surf_parsed_filename); // save old file name
402 surf_parsed_filename = xbt_strdup(A_surfxml_include_file);
404 surf_file_to_parse_stack.push_back(surf_file_to_parse); // save old file descriptor
406 surf_file_to_parse = surf_fopen(A_surfxml_include_file, "r"); // read new file descriptor
407 xbt_assert((surf_file_to_parse), "Unable to open \"%s\"\n", A_surfxml_include_file);
409 surf_input_buffer_stack.push_back(surf_input_buffer);
410 surf_input_buffer = surf_parse__create_buffer(surf_file_to_parse, YY_BUF_SIZE);
411 surf_parse_push_buffer_state(surf_input_buffer);
416 void ETag_surfxml_include() {
417 /* Nothing to do when done with reading the include tag.
418 * Instead, the handling should be deferred until the EOF of current buffer -- see below */
421 /** @brief When reaching EOF, check whether we are in an include tag, and behave accordingly if yes
423 * This function is called automatically by sedding the parser in tools/cmake/MaintainerMode.cmake
424 * Every FAIL on "Premature EOF" is preceded by a call to this function, which role is to restore the
425 * previous buffer if we reached the EOF /of an include file/. Its return code is used to avoid the
426 * error message in that case.
428 * Yeah, that's terribly hackish, but it works. A better solution should be dealed with in flexml
429 * directly: a command line flag could instruct it to do the correct thing when the include directive is encountered
430 * on a line. One day maybe, if the maya allow it.
432 int ETag_surfxml_include_state()
435 XBT_DEBUG("ETag_surfxml_include_state '%s'",A_surfxml_include_file);
437 if (surf_input_buffer_stack.empty()) // nope, that's a true premature EOF. Let the parser die verbosely.
440 // Yeah, we were in an <include> Restore state and proceed.
441 fclose(surf_file_to_parse);
442 surf_file_to_parse_stack.pop_back();
443 surf_parse_pop_buffer_state();
444 surf_input_buffer_stack.pop_back();
446 // Restore the filename for error messages
447 free(surf_parsed_filename);
448 surf_parsed_filename_stack.pop_back();
453 /* Stag and Etag parse functions */
455 void STag_surfxml_platform() {
456 XBT_ATTRIB_UNUSED double version = surf_parse_get_double(A_surfxml_platform_version);
458 xbt_assert((version >= 1.0), "******* BIG FAT WARNING *********\n "
459 "You're using an ancient XML file.\n"
460 "Since SimGrid 3.1, units are Bytes, Flops, and seconds "
461 "instead of MBytes, MFlops and seconds.\n"
463 "Use simgrid_update_xml to update your file automatically. "
464 "This program is installed automatically with SimGrid, or "
465 "available in the tools/ directory of the source archive.\n"
467 "Please check also out the SURF section of the ChangeLog for "
468 "the 3.1 version for more information. \n"
470 "Last, do not forget to also update your values for "
471 "the calls to MSG_task_create (if any).");
472 xbt_assert((version >= 3.0), "******* BIG FAT WARNING *********\n "
473 "You're using an old XML file.\n"
474 "Use simgrid_update_xml to update your file automatically. "
475 "This program is installed automatically with SimGrid, or "
476 "available in the tools/ directory of the source archive.");
477 xbt_assert((version >= 4.0),
478 "******* FILE %s IS TOO OLD (v:%.1f) *********\n "
479 "Changes introduced in SimGrid 3.13:\n"
480 " - 'power' attribute of hosts (and others) got renamed to 'speed'.\n"
481 " - In <trace_connect>, attribute kind=\"POWER\" is now kind=\"SPEED\".\n"
482 " - DOCTYPE now point to the rignt URL: http://simgrid.gforge.inria.fr/simgrid/simgrid.dtd\n"
483 " - speed, bandwidth and latency attributes now MUST have an explicit unit (f, Bps, s by default)"
485 "Use simgrid_update_xml to update your file automatically. "
486 "This program is installed automatically with SimGrid, or "
487 "available in the tools/ directory of the source archive.",
488 surf_parsed_filename, version);
490 XBT_INFO("You're using a v%.1f XML file (%s) while the current standard is v4.1 "
491 "That's fine, the new version is backward compatible. \n\n"
492 "Use simgrid_update_xml to update your file automatically. "
493 "This program is installed automatically with SimGrid, or "
494 "available in the tools/ directory of the source archive.",
495 version, surf_parsed_filename);
497 xbt_assert(version <= 4.1, "******* FILE %s COMES FROM THE FUTURE (v:%.1f) *********\n "
498 "The most recent formalism that this version of SimGrid understands is v4.1.\n"
499 "Please update your code, or use another, more adapted, file.",
500 surf_parsed_filename, version);
504 void ETag_surfxml_platform(){
508 void STag_surfxml_host(){
510 xbt_assert(current_property_set == nullptr, "Someone forgot to reset the property set to nullptr in its closing tag (or XML malformed)");
513 void STag_surfxml_prop()
515 if (ZONE_TAG) { // We need to retrieve the most recently opened zone
516 XBT_DEBUG("Set zone property %s -> %s", A_surfxml_prop_id, A_surfxml_prop_value);
517 simgrid::s4u::NetZone* netzone = simgrid::s4u::Engine::getInstance()->getNetzoneByNameOrNull(A_surfxml_zone_id);
519 netzone->setProperty(A_surfxml_prop_id, A_surfxml_prop_value);
521 if (not current_property_set)
522 current_property_set = new std::map<std::string, std::string>; // Maybe, it should raise an error
523 current_property_set->insert({A_surfxml_prop_id, A_surfxml_prop_value});
524 XBT_DEBUG("add prop %s=%s into current property set %p", A_surfxml_prop_id, A_surfxml_prop_value,
525 current_property_set);
529 void ETag_surfxml_host() {
530 s_sg_platf_host_cbarg_t host;
531 memset(&host,0,sizeof(host));
533 host.properties = current_property_set;
534 current_property_set = nullptr;
536 host.id = A_surfxml_host_id;
538 host.speed_per_pstate = surf_parse_get_all_speeds(A_surfxml_host_speed, "speed of host", host.id);
540 XBT_DEBUG("pstate: %s", A_surfxml_host_pstate);
541 host.core_amount = surf_parse_get_int(A_surfxml_host_core);
542 host.speed_trace = A_surfxml_host_availability___file[0] ? tmgr_trace_new_from_file(A_surfxml_host_availability___file) : nullptr;
543 host.state_trace = A_surfxml_host_state___file[0] ? tmgr_trace_new_from_file(A_surfxml_host_state___file) : nullptr;
544 host.pstate = surf_parse_get_int(A_surfxml_host_pstate);
545 host.coord = A_surfxml_host_coordinates;
547 sg_platf_new_host(&host);
550 void STag_surfxml_host___link(){
551 XBT_DEBUG("Create a Host_link for %s",A_surfxml_host___link_id);
552 s_sg_platf_host_link_cbarg_t host_link;
553 memset(&host_link,0,sizeof(host_link));
555 host_link.id = A_surfxml_host___link_id;
556 host_link.link_up = A_surfxml_host___link_up;
557 host_link.link_down = A_surfxml_host___link_down;
558 sg_platf_new_hostlink(&host_link);
561 void STag_surfxml_router(){
562 sg_platf_new_router(A_surfxml_router_id, A_surfxml_router_coordinates);
565 void ETag_surfxml_cluster(){
566 s_sg_platf_cluster_cbarg_t cluster;
567 memset(&cluster,0,sizeof(cluster));
568 cluster.properties = current_property_set;
569 current_property_set = nullptr;
571 cluster.id = A_surfxml_cluster_id;
572 cluster.prefix = A_surfxml_cluster_prefix;
573 cluster.suffix = A_surfxml_cluster_suffix;
574 cluster.radicals = explodesRadical(A_surfxml_cluster_radical);
575 cluster.speeds = surf_parse_get_all_speeds(A_surfxml_cluster_speed, "speed of cluster", cluster.id);
576 cluster.core_amount = surf_parse_get_int(A_surfxml_cluster_core);
577 cluster.bw = surf_parse_get_bandwidth(A_surfxml_cluster_bw, "bw of cluster", cluster.id);
578 cluster.lat = surf_parse_get_time(A_surfxml_cluster_lat, "lat of cluster", cluster.id);
579 if(strcmp(A_surfxml_cluster_bb___bw,""))
580 cluster.bb_bw = surf_parse_get_bandwidth(A_surfxml_cluster_bb___bw, "bb_bw of cluster", cluster.id);
581 if(strcmp(A_surfxml_cluster_bb___lat,""))
582 cluster.bb_lat = surf_parse_get_time(A_surfxml_cluster_bb___lat, "bb_lat of cluster", cluster.id);
583 if(strcmp(A_surfxml_cluster_limiter___link,""))
584 cluster.limiter_link = surf_parse_get_bandwidth(A_surfxml_cluster_limiter___link, "limiter_link of cluster", cluster.id);
585 if(strcmp(A_surfxml_cluster_loopback___bw,""))
586 cluster.loopback_bw = surf_parse_get_bandwidth(A_surfxml_cluster_loopback___bw, "loopback_bw of cluster", cluster.id);
587 if(strcmp(A_surfxml_cluster_loopback___lat,""))
588 cluster.loopback_lat = surf_parse_get_time(A_surfxml_cluster_loopback___lat, "loopback_lat of cluster", cluster.id);
590 switch(AX_surfxml_cluster_topology){
591 case A_surfxml_cluster_topology_FLAT:
592 cluster.topology= SURF_CLUSTER_FLAT ;
594 case A_surfxml_cluster_topology_TORUS:
595 cluster.topology= SURF_CLUSTER_TORUS ;
597 case A_surfxml_cluster_topology_FAT___TREE:
598 cluster.topology = SURF_CLUSTER_FAT_TREE;
600 case A_surfxml_cluster_topology_DRAGONFLY:
601 cluster.topology= SURF_CLUSTER_DRAGONFLY ;
604 surf_parse_error("Invalid cluster topology for cluster %s",
608 cluster.topo_parameters = A_surfxml_cluster_topo___parameters;
609 cluster.router_id = A_surfxml_cluster_router___id;
611 switch (AX_surfxml_cluster_sharing___policy) {
612 case A_surfxml_cluster_sharing___policy_SHARED:
613 cluster.sharing_policy = SURF_LINK_SHARED;
615 case A_surfxml_cluster_sharing___policy_FULLDUPLEX:
616 cluster.sharing_policy = SURF_LINK_FULLDUPLEX;
618 case A_surfxml_cluster_sharing___policy_FATPIPE:
619 cluster.sharing_policy = SURF_LINK_FATPIPE;
622 surf_parse_error("Invalid cluster sharing policy for cluster %s", cluster.id);
625 switch (AX_surfxml_cluster_bb___sharing___policy) {
626 case A_surfxml_cluster_bb___sharing___policy_FATPIPE:
627 cluster.bb_sharing_policy = SURF_LINK_FATPIPE;
629 case A_surfxml_cluster_bb___sharing___policy_SHARED:
630 cluster.bb_sharing_policy = SURF_LINK_SHARED;
633 surf_parse_error("Invalid bb sharing policy in cluster %s", cluster.id);
637 sg_platf_new_cluster(&cluster);
640 void STag_surfxml_cluster(){
642 parse_after_config();
643 xbt_assert(current_property_set == nullptr, "Someone forgot to reset the property set to nullptr in its closing tag (or XML malformed)");
646 void STag_surfxml_cabinet(){
647 parse_after_config();
648 s_sg_platf_cabinet_cbarg_t cabinet;
649 memset(&cabinet,0,sizeof(cabinet));
650 cabinet.id = A_surfxml_cabinet_id;
651 cabinet.prefix = A_surfxml_cabinet_prefix;
652 cabinet.suffix = A_surfxml_cabinet_suffix;
653 cabinet.speed = surf_parse_get_speed(A_surfxml_cabinet_speed, "speed of cabinet", cabinet.id);
654 cabinet.bw = surf_parse_get_bandwidth(A_surfxml_cabinet_bw, "bw of cabinet", cabinet.id);
655 cabinet.lat = surf_parse_get_time(A_surfxml_cabinet_lat, "lat of cabinet", cabinet.id);
656 cabinet.radicals = explodesRadical(A_surfxml_cabinet_radical);
658 sg_platf_new_cabinet(&cabinet);
661 void STag_surfxml_peer(){
662 parse_after_config();
663 PeerCreationArgs peer;
665 peer.id = std::string(A_surfxml_peer_id);
666 peer.speed = surf_parse_get_speed(A_surfxml_peer_speed, "speed of peer", peer.id.c_str());
667 peer.bw_in = surf_parse_get_bandwidth(A_surfxml_peer_bw___in, "bw_in of peer", peer.id.c_str());
668 peer.bw_out = surf_parse_get_bandwidth(A_surfxml_peer_bw___out, "bw_out of peer", peer.id.c_str());
669 peer.coord = A_surfxml_peer_coordinates;
670 peer.speed_trace = A_surfxml_peer_availability___file[0] ? tmgr_trace_new_from_file(A_surfxml_peer_availability___file) : nullptr;
671 peer.state_trace = A_surfxml_peer_state___file[0] ? tmgr_trace_new_from_file(A_surfxml_peer_state___file) : nullptr;
673 if (A_surfxml_peer_lat[0] != '\0')
674 XBT_WARN("The latency parameter in <peer> is now deprecated. Use the z coordinate instead of '%s'.",
677 sg_platf_new_peer(&peer);
680 void STag_surfxml_link(){
682 xbt_assert(current_property_set == nullptr, "Someone forgot to reset the property set to nullptr in its closing tag (or XML malformed)");
685 void ETag_surfxml_link(){
686 LinkCreationArgs link;
688 link.properties = current_property_set;
689 current_property_set = nullptr;
691 link.id = std::string(A_surfxml_link_id);
692 link.bandwidth = surf_parse_get_bandwidth(A_surfxml_link_bandwidth, "bandwidth of link", link.id.c_str());
693 link.bandwidth_trace = A_surfxml_link_bandwidth___file[0] ? tmgr_trace_new_from_file(A_surfxml_link_bandwidth___file) : nullptr;
694 link.latency = surf_parse_get_time(A_surfxml_link_latency, "latency of link", link.id.c_str());
695 link.latency_trace = A_surfxml_link_latency___file[0] ? tmgr_trace_new_from_file(A_surfxml_link_latency___file) : nullptr;
696 link.state_trace = A_surfxml_link_state___file[0] ? tmgr_trace_new_from_file(A_surfxml_link_state___file):nullptr;
698 switch (A_surfxml_link_sharing___policy) {
699 case A_surfxml_link_sharing___policy_SHARED:
700 link.policy = SURF_LINK_SHARED;
702 case A_surfxml_link_sharing___policy_FATPIPE:
703 link.policy = SURF_LINK_FATPIPE;
705 case A_surfxml_link_sharing___policy_FULLDUPLEX:
706 link.policy = SURF_LINK_FULLDUPLEX;
709 surf_parse_error("Invalid sharing policy in link %s", link.id.c_str());
713 sg_platf_new_link(&link);
716 void STag_surfxml_link___ctn(){
718 simgrid::surf::LinkImpl* link = nullptr;
719 char *link_name=nullptr;
720 switch (A_surfxml_link___ctn_direction) {
721 case AU_surfxml_link___ctn_direction:
722 case A_surfxml_link___ctn_direction_NONE:
723 link = simgrid::surf::LinkImpl::byName(A_surfxml_link___ctn_id);
725 case A_surfxml_link___ctn_direction_UP:
726 link_name = bprintf("%s_UP", A_surfxml_link___ctn_id);
727 link = simgrid::surf::LinkImpl::byName(link_name);
729 case A_surfxml_link___ctn_direction_DOWN:
730 link_name = bprintf("%s_DOWN", A_surfxml_link___ctn_id);
731 link = simgrid::surf::LinkImpl::byName(link_name);
734 surf_parse_error("Invalid direction for link %s", link_name);
737 xbt_free(link_name); // no-op if it's already nullptr
739 const char* dirname = "";
740 switch (A_surfxml_link___ctn_direction) {
741 case A_surfxml_link___ctn_direction_UP:
742 dirname = " (upward)";
744 case A_surfxml_link___ctn_direction_DOWN:
745 dirname = " (downward)";
750 surf_parse_assert(link != nullptr, "No such link: '%s'%s", A_surfxml_link___ctn_id, dirname);
751 parsed_link_list.push_back(link);
754 void ETag_surfxml_backbone(){
755 LinkCreationArgs link;
757 link.properties = nullptr;
758 link.id = std::string(A_surfxml_backbone_id);
759 link.bandwidth = surf_parse_get_bandwidth(A_surfxml_backbone_bandwidth, "bandwidth of backbone", link.id.c_str());
760 link.latency = surf_parse_get_time(A_surfxml_backbone_latency, "latency of backbone", link.id.c_str());
761 link.policy = SURF_LINK_SHARED;
763 sg_platf_new_link(&link);
764 routing_cluster_add_backbone(simgrid::surf::LinkImpl::byName(A_surfxml_backbone_id));
767 void STag_surfxml_route(){
768 surf_parse_assert_netpoint(A_surfxml_route_src, "Route src='", "' does name a node.");
769 surf_parse_assert_netpoint(A_surfxml_route_dst, "Route dst='", "' does name a node.");
772 void STag_surfxml_ASroute(){
773 surf_parse_assert_netpoint(A_surfxml_ASroute_src, "ASroute src='", "' does name a node.");
774 surf_parse_assert_netpoint(A_surfxml_ASroute_dst, "ASroute dst='", "' does name a node.");
776 surf_parse_assert_netpoint(A_surfxml_ASroute_gw___src, "ASroute gw_src='", "' does name a node.");
777 surf_parse_assert_netpoint(A_surfxml_ASroute_gw___dst, "ASroute gw_dst='", "' does name a node.");
779 void STag_surfxml_zoneRoute(){
780 surf_parse_assert_netpoint(A_surfxml_zoneRoute_src, "zoneRoute src='", "' does name a node.");
781 surf_parse_assert_netpoint(A_surfxml_zoneRoute_dst, "zoneRoute dst='", "' does name a node.");
782 surf_parse_assert_netpoint(A_surfxml_zoneRoute_gw___src, "zoneRoute gw_src='", "' does name a node.");
783 surf_parse_assert_netpoint(A_surfxml_zoneRoute_gw___dst, "zoneRoute gw_dst='", "' does name a node.");
786 void STag_surfxml_bypassRoute(){
787 surf_parse_assert_netpoint(A_surfxml_bypassRoute_src, "bypassRoute src='", "' does name a node.");
788 surf_parse_assert_netpoint(A_surfxml_bypassRoute_dst, "bypassRoute dst='", "' does name a node.");
791 void STag_surfxml_bypassASroute(){
792 surf_parse_assert_netpoint(A_surfxml_bypassASroute_src, "bypassASroute src='", "' does name a node.");
793 surf_parse_assert_netpoint(A_surfxml_bypassASroute_dst, "bypassASroute dst='", "' does name a node.");
794 surf_parse_assert_netpoint(A_surfxml_bypassASroute_gw___src, "bypassASroute gw_src='", "' does name a node.");
795 surf_parse_assert_netpoint(A_surfxml_bypassASroute_gw___dst, "bypassASroute gw_dst='", "' does name a node.");
797 void STag_surfxml_bypassZoneRoute(){
798 surf_parse_assert_netpoint(A_surfxml_bypassZoneRoute_src, "bypassZoneRoute src='", "' does name a node.");
799 surf_parse_assert_netpoint(A_surfxml_bypassZoneRoute_dst, "bypassZoneRoute dst='", "' does name a node.");
800 surf_parse_assert_netpoint(A_surfxml_bypassZoneRoute_gw___src, "bypassZoneRoute gw_src='", "' does name a node.");
801 surf_parse_assert_netpoint(A_surfxml_bypassZoneRoute_gw___dst, "bypassZoneRoute gw_dst='", "' does name a node.");
804 void ETag_surfxml_route(){
805 s_sg_platf_route_cbarg_t route;
806 memset(&route,0,sizeof(route));
808 route.src = sg_netpoint_by_name_or_null(A_surfxml_route_src); // tested to not be nullptr in start tag
809 route.dst = sg_netpoint_by_name_or_null(A_surfxml_route_dst); // tested to not be nullptr in start tag
810 route.gw_src = nullptr;
811 route.gw_dst = nullptr;
812 route.link_list = new std::vector<simgrid::surf::LinkImpl*>();
813 route.symmetrical = (A_surfxml_route_symmetrical == A_surfxml_route_symmetrical_YES);
815 for (auto link: parsed_link_list)
816 route.link_list->push_back(link);
817 parsed_link_list.clear();
819 sg_platf_new_route(&route);
820 delete route.link_list;
823 void ETag_surfxml_ASroute()
825 AX_surfxml_zoneRoute_src = AX_surfxml_ASroute_src;
826 AX_surfxml_zoneRoute_dst = AX_surfxml_ASroute_dst;
827 AX_surfxml_zoneRoute_gw___src = AX_surfxml_ASroute_gw___src;
828 AX_surfxml_zoneRoute_gw___dst = AX_surfxml_ASroute_gw___dst;
829 AX_surfxml_zoneRoute_symmetrical = (AT_surfxml_zoneRoute_symmetrical)AX_surfxml_ASroute_symmetrical;
830 ETag_surfxml_zoneRoute();
832 void ETag_surfxml_zoneRoute()
834 s_sg_platf_route_cbarg_t ASroute;
835 memset(&ASroute,0,sizeof(ASroute));
837 ASroute.src = sg_netpoint_by_name_or_null(A_surfxml_zoneRoute_src); // tested to not be nullptr in start tag
838 ASroute.dst = sg_netpoint_by_name_or_null(A_surfxml_zoneRoute_dst); // tested to not be nullptr in start tag
840 ASroute.gw_src = sg_netpoint_by_name_or_null(A_surfxml_zoneRoute_gw___src); // tested to not be nullptr in start tag
841 ASroute.gw_dst = sg_netpoint_by_name_or_null(A_surfxml_zoneRoute_gw___dst); // tested to not be nullptr in start tag
843 ASroute.link_list = new std::vector<simgrid::surf::LinkImpl*>();
845 for (auto link: parsed_link_list)
846 ASroute.link_list->push_back(link);
847 parsed_link_list.clear();
849 switch (A_surfxml_zoneRoute_symmetrical) {
850 case AU_surfxml_zoneRoute_symmetrical:
851 case A_surfxml_zoneRoute_symmetrical_YES:
852 ASroute.symmetrical = true;
854 case A_surfxml_zoneRoute_symmetrical_NO:
855 ASroute.symmetrical = false;
859 sg_platf_new_route(&ASroute);
860 delete ASroute.link_list;
863 void ETag_surfxml_bypassRoute(){
864 s_sg_platf_route_cbarg_t route;
865 memset(&route,0,sizeof(route));
867 route.src = sg_netpoint_by_name_or_null(A_surfxml_bypassRoute_src); // tested to not be nullptr in start tag
868 route.dst = sg_netpoint_by_name_or_null(A_surfxml_bypassRoute_dst); // tested to not be nullptr in start tag
869 route.gw_src = nullptr;
870 route.gw_dst = nullptr;
871 route.symmetrical = false;
872 route.link_list = new std::vector<simgrid::surf::LinkImpl*>();
874 for (auto link: parsed_link_list)
875 route.link_list->push_back(link);
876 parsed_link_list.clear();
878 sg_platf_new_bypassRoute(&route);
879 delete route.link_list;
882 void ETag_surfxml_bypassASroute()
884 AX_surfxml_bypassZoneRoute_src = AX_surfxml_bypassASroute_src;
885 AX_surfxml_bypassZoneRoute_dst = AX_surfxml_bypassASroute_dst;
886 AX_surfxml_bypassZoneRoute_gw___src = AX_surfxml_bypassASroute_gw___src;
887 AX_surfxml_bypassZoneRoute_gw___dst = AX_surfxml_bypassASroute_gw___dst;
888 ETag_surfxml_bypassZoneRoute();
890 void ETag_surfxml_bypassZoneRoute()
892 s_sg_platf_route_cbarg_t ASroute;
893 memset(&ASroute,0,sizeof(ASroute));
895 ASroute.src = sg_netpoint_by_name_or_null(A_surfxml_bypassZoneRoute_src);
896 ASroute.dst = sg_netpoint_by_name_or_null(A_surfxml_bypassZoneRoute_dst);
897 ASroute.link_list = new std::vector<simgrid::surf::LinkImpl*>();
898 for (auto link: parsed_link_list)
899 ASroute.link_list->push_back(link);
900 parsed_link_list.clear();
902 ASroute.symmetrical = false;
904 ASroute.gw_src = sg_netpoint_by_name_or_null(A_surfxml_bypassZoneRoute_gw___src);
905 ASroute.gw_dst = sg_netpoint_by_name_or_null(A_surfxml_bypassZoneRoute_gw___dst);
907 sg_platf_new_bypassRoute(&ASroute);
908 delete ASroute.link_list;
911 void ETag_surfxml_trace(){
912 s_sg_platf_trace_cbarg_t trace;
913 memset(&trace,0,sizeof(trace));
915 trace.id = A_surfxml_trace_id;
916 trace.file = A_surfxml_trace_file;
917 trace.periodicity = surf_parse_get_double(A_surfxml_trace_periodicity);
918 trace.pc_data = surfxml_pcdata;
920 sg_platf_new_trace(&trace);
923 void STag_surfxml_trace___connect()
925 parse_after_config();
926 s_sg_platf_trace_connect_cbarg_t trace_connect;
927 memset(&trace_connect,0,sizeof(trace_connect));
929 trace_connect.element = A_surfxml_trace___connect_element;
930 trace_connect.trace = A_surfxml_trace___connect_trace;
932 switch (A_surfxml_trace___connect_kind) {
933 case AU_surfxml_trace___connect_kind:
934 case A_surfxml_trace___connect_kind_SPEED:
935 trace_connect.kind = SURF_TRACE_CONNECT_KIND_SPEED;
937 case A_surfxml_trace___connect_kind_BANDWIDTH:
938 trace_connect.kind = SURF_TRACE_CONNECT_KIND_BANDWIDTH;
940 case A_surfxml_trace___connect_kind_HOST___AVAIL:
941 trace_connect.kind = SURF_TRACE_CONNECT_KIND_HOST_AVAIL;
943 case A_surfxml_trace___connect_kind_LATENCY:
944 trace_connect.kind = SURF_TRACE_CONNECT_KIND_LATENCY;
946 case A_surfxml_trace___connect_kind_LINK___AVAIL:
947 trace_connect.kind = SURF_TRACE_CONNECT_KIND_LINK_AVAIL;
950 surf_parse_error("Invalid trace kind");
953 sg_platf_trace_connect(&trace_connect);
956 void STag_surfxml_AS()
958 AX_surfxml_zone_id = AX_surfxml_AS_id;
959 AX_surfxml_zone_routing = (AT_surfxml_zone_routing)AX_surfxml_AS_routing;
963 void ETag_surfxml_AS()
968 void STag_surfxml_zone()
970 parse_after_config();
972 s_sg_platf_AS_cbarg_t AS = {A_surfxml_zone_id, (int)A_surfxml_zone_routing};
974 sg_platf_new_AS_begin(&AS);
977 void ETag_surfxml_zone()
979 sg_platf_new_AS_seal();
982 void STag_surfxml_config()
985 xbt_assert(current_property_set == nullptr, "Someone forgot to reset the property set to nullptr in its closing tag (or XML malformed)");
986 XBT_DEBUG("START configuration name = %s",A_surfxml_config_id);
987 if (_sg_cfg_init_status == 2) {
988 surf_parse_error("All <config> tags must be given before any platform elements (such as <zone>, <host>, <cluster>, "
993 void ETag_surfxml_config()
995 for (auto elm : *current_property_set) {
996 if (xbt_cfg_is_default_value(elm.first.c_str())) {
997 std::string cfg = elm.first + ":" + elm.second;
998 xbt_cfg_set_parse(cfg.c_str());
1000 XBT_INFO("The custom configuration '%s' is already defined by user!", elm.first.c_str());
1002 XBT_DEBUG("End configuration name = %s",A_surfxml_config_id);
1004 delete current_property_set;
1005 current_property_set = nullptr;
1011 void STag_surfxml_process()
1013 AX_surfxml_actor_function = AX_surfxml_process_function;
1014 STag_surfxml_actor();
1016 void STag_surfxml_actor()
1020 argv = xbt_new(char *, 1);
1021 argv[0] = xbt_strdup(A_surfxml_actor_function);
1022 xbt_assert(current_property_set == nullptr, "Someone forgot to reset the property set to nullptr in its closing tag (or XML malformed)");
1025 void ETag_surfxml_process()
1027 AX_surfxml_actor_host = AX_surfxml_process_host;
1028 AX_surfxml_actor_function = AX_surfxml_process_function;
1029 AX_surfxml_actor_start___time = AX_surfxml_process_start___time;
1030 AX_surfxml_actor_kill___time = AX_surfxml_process_kill___time;
1031 AX_surfxml_actor_on___failure = (AT_surfxml_actor_on___failure)AX_surfxml_process_on___failure;
1032 ETag_surfxml_actor();
1034 void ETag_surfxml_actor()
1036 s_sg_platf_process_cbarg_t actor;
1037 memset(&actor,0,sizeof(actor));
1040 actor.argv = (const char **)argv;
1041 actor.properties = current_property_set;
1042 actor.host = A_surfxml_actor_host;
1043 actor.function = A_surfxml_actor_function;
1044 actor.start_time = surf_parse_get_double(A_surfxml_actor_start___time);
1045 actor.kill_time = surf_parse_get_double(A_surfxml_actor_kill___time);
1047 switch (A_surfxml_actor_on___failure) {
1048 case AU_surfxml_actor_on___failure:
1049 case A_surfxml_actor_on___failure_DIE:
1050 actor.on_failure = SURF_ACTOR_ON_FAILURE_DIE;
1052 case A_surfxml_actor_on___failure_RESTART:
1053 actor.on_failure = SURF_ACTOR_ON_FAILURE_RESTART;
1056 surf_parse_error("Invalid on failure behavior");
1060 sg_platf_new_process(&actor);
1062 for (int i = 0; i != argc; ++i)
1067 current_property_set = nullptr;
1070 void STag_surfxml_argument(){
1072 argv = (char**)xbt_realloc(argv, (argc) * sizeof(char **));
1073 argv[(argc) - 1] = xbt_strdup(A_surfxml_argument_value);
1076 void STag_surfxml_model___prop(){
1077 if (not current_model_property_set)
1078 current_model_property_set = new std::map<std::string, std::string>();
1080 current_model_property_set->insert(
1081 {std::string(A_surfxml_model___prop_id), std::string(A_surfxml_model___prop_value)});
1084 void ETag_surfxml_prop(){/* Nothing to do */}
1085 void STag_surfxml_random(){/* Nothing to do */}
1086 void ETag_surfxml_random(){/* Nothing to do */}
1087 void ETag_surfxml_trace___connect(){/* Nothing to do */}
1088 void STag_surfxml_trace(){parse_after_config();}
1089 void ETag_surfxml_router(){/*Nothing to do*/}
1090 void ETag_surfxml_host___link(){/* Nothing to do */}
1091 void ETag_surfxml_cabinet(){/* Nothing to do */}
1092 void ETag_surfxml_peer(){/* Nothing to do */}
1093 void STag_surfxml_backbone(){/* Nothing to do */}
1094 void ETag_surfxml_link___ctn(){/* Nothing to do */}
1095 void ETag_surfxml_argument(){/* Nothing to do */}
1096 void ETag_surfxml_model___prop(){/* Nothing to do */}
1098 /* Open and Close parse file */
1099 void surf_parse_open(const char *file)
1101 xbt_assert(file, "Cannot parse the nullptr file. Bypassing the parser is strongly deprecated nowadays.");
1103 surf_parsed_filename = xbt_strdup(file);
1104 char* dir = xbt_dirname(file);
1105 surf_path.push_back(std::string(dir));
1108 surf_file_to_parse = surf_fopen(file, "r");
1109 if (surf_file_to_parse == nullptr)
1110 xbt_die("Unable to open '%s'\n", file);
1111 surf_input_buffer = surf_parse__create_buffer(surf_file_to_parse, YY_BUF_SIZE);
1112 surf_parse__switch_to_buffer(surf_input_buffer);
1113 surf_parse_lineno = 1;
1116 void surf_parse_close()
1118 if (surf_parsed_filename) {
1119 surf_path.pop_back();
1122 free(surf_parsed_filename);
1123 surf_parsed_filename = nullptr;
1125 if (surf_file_to_parse) {
1126 surf_parse__delete_buffer(surf_input_buffer);
1127 fclose(surf_file_to_parse);
1128 surf_file_to_parse = nullptr; //Must be reset for Bypass
1132 /* Call the lexer to parse the currently opened file */
1135 return surf_parse_lex();