Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
use signals a bit more to create tracing stuff
[simgrid.git] / src / surf / xml / surfxml_sax_cb.cpp
1 /* Copyright (c) 2006-2018. The SimGrid Team. All rights reserved.          */
2
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. */
5
6 #include "simgrid/kernel/routing/NetPoint.hpp"
7 #include "simgrid/s4u/Engine.hpp"
8 #include "simgrid/sg_config.hpp"
9 #include "src/instr/instr_private.hpp"
10 #include "src/surf/network_interface.hpp"
11 #include "src/surf/surf_interface.hpp"
12 #include "src/surf/xml/platf_private.hpp"
13 #include "surf/surf.hpp"
14 #include "xbt/file.hpp"
15
16 #include <boost/algorithm/string.hpp>
17 #include <boost/algorithm/string/classification.hpp>
18 #include <boost/algorithm/string/split.hpp>
19 #include <string>
20 #include <tuple>
21 #include <unordered_map>
22 #include <vector>
23
24 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_parse, surf, "Logging specific to the SURF parsing module");
25
26 #include "simgrid_dtd.c"
27
28 static const char* surf_parsed_filename; // Currently parsed file (for the error messages)
29 std::vector<simgrid::kernel::resource::LinkImpl*>
30     parsed_link_list; /* temporary store of current list link of a route */
31
32 /*
33  * Helping functions
34  */
35 void surf_parse_assert(bool cond, std::string msg)
36 {
37   if (not cond) {
38     int lineno = surf_parse_lineno;
39     cleanup();
40     XBT_ERROR("Parse error at %s:%d: %s", surf_parsed_filename, lineno, msg.c_str());
41     surf_exit();
42     xbt_die("Exiting now");
43   }
44 }
45
46 void surf_parse_error(std::string msg)
47 {
48   int lineno = surf_parse_lineno;
49   cleanup();
50   XBT_ERROR("Parse error at %s:%d: %s", surf_parsed_filename, lineno, msg.c_str());
51   surf_exit();
52   xbt_die("Exiting now");
53 }
54
55 void surf_parse_assert_netpoint(std::string hostname, std::string pre, std::string post)
56 {
57   if (sg_netpoint_by_name_or_null(hostname.c_str()) != nullptr) // found
58     return;
59
60   std::string msg = pre + hostname + post + " Existing netpoints: \n";
61
62   std::vector<simgrid::kernel::routing::NetPoint*> list;
63   simgrid::s4u::Engine::getInstance()->getNetpointList(&list);
64   std::sort(list.begin(), list.end(), [](simgrid::kernel::routing::NetPoint* a, simgrid::kernel::routing::NetPoint* b) {
65     return a->get_name() < b->get_name();
66   });
67   bool first = true;
68   for (auto const& np : list) {
69     if (np->is_netzone())
70       continue;
71
72     if (not first)
73       msg += ",";
74     first = false;
75     msg += "'" + np->get_name() + "'";
76     if (msg.length() > 4096) {
77       msg.pop_back(); // remove trailing quote
78       msg += "...(list truncated)......";
79       break;
80     }
81   }
82   surf_parse_error(msg);
83 }
84
85 double surf_parse_get_double(std::string s)
86 {
87   try {
88     return std::stod(s);
89   } catch (std::invalid_argument& ia) {
90     surf_parse_error(s + " is not a double");
91     return -1;
92   }
93 }
94
95 int surf_parse_get_int(std::string s)
96 {
97   try {
98     return std::stoi(s);
99   } catch (std::invalid_argument& ia) {
100     surf_parse_error(s + " is not a double");
101     return -1;
102   }
103 }
104
105 namespace {
106
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)
109 {
110   std::vector<int>* exploded = new std::vector<int>();
111
112   // Make all hosts
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());
119     int end   = 0;
120
121     switch (radical_ends.size()) {
122       case 1:
123         end = start;
124         break;
125       case 2:
126         end = surf_parse_get_int(radical_ends.back());
127         break;
128       default:
129         surf_parse_error(std::string("Malformed radical: ") + group);
130         break;
131     }
132     for (int i = start; i <= end; i++)
133       exploded->push_back(i);
134   }
135
136   return exploded;
137 }
138
139 class unit_scale : public std::unordered_map<std::string, double> {
140 public:
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);
144 };
145
146 unit_scale::unit_scale(std::initializer_list<std::tuple<const std::string, double, int, bool>> generators)
147 {
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);
153     double mult;
154     std::vector<std::string> prefixes;
155     switch (base) {
156       case 2:
157         mult     = 1024.0;
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"};
160         break;
161       case 10:
162         mult     = 1000.0;
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"};
165         break;
166       default:
167         THROW_IMPOSSIBLE;
168     }
169     emplace(unit, value);
170     for (const auto& prefix : prefixes) {
171       value *= mult;
172       emplace(prefix + unit, value);
173     }
174   }
175 }
176
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)
180 {
181   char* ptr;
182   errno = 0;
183   double res   = strtod(string, &ptr);
184   if (errno == ERANGE)
185     surf_parse_error(std::string("value out of range: ") + string);
186   if (ptr == string)
187     surf_parse_error(std::string("cannot parse number:") + string);
188   if (ptr[0] == '\0') {
189     if (res == 0)
190       return res; // Ok, 0 can be unit-less
191
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;
194   }
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;
199 }
200 }
201
202 double surf_parse_get_time(const char* string, const char* entity_kind, std::string name)
203 {
204   static const unit_scale units{std::make_pair("w", 7 * 24 * 60 * 60),
205                                 std::make_pair("d", 24 * 60 * 60),
206                                 std::make_pair("h", 60 * 60),
207                                 std::make_pair("m", 60),
208                                 std::make_pair("s", 1.0),
209                                 std::make_pair("ms", 1e-3),
210                                 std::make_pair("us", 1e-6),
211                                 std::make_pair("ns", 1e-9),
212                                 std::make_pair("ps", 1e-12)};
213   return surf_parse_get_value_with_unit(string, units, entity_kind, name,
214       "Append 's' to your time to get seconds", "s");
215 }
216
217 double surf_parse_get_size(const char* string, const char* entity_kind, std::string name)
218 {
219   static const unit_scale units{std::make_tuple("b", 0.125, 2, true), std::make_tuple("b", 0.125, 10, true),
220                                 std::make_tuple("B", 1.0, 2, true), std::make_tuple("B", 1.0, 10, true)};
221   return surf_parse_get_value_with_unit(string, units, entity_kind, name,
222       "Append 'B' to get bytes (or 'b' for bits but 1B = 8b).", "B");
223 }
224
225 double surf_parse_get_bandwidth(const char* string, const char* entity_kind, std::string name)
226 {
227   static const unit_scale units{std::make_tuple("bps", 0.125, 2, true), std::make_tuple("bps", 0.125, 10, true),
228                                 std::make_tuple("Bps", 1.0, 2, true), std::make_tuple("Bps", 1.0, 10, true)};
229   return surf_parse_get_value_with_unit(string, units, entity_kind, name,
230       "Append 'Bps' to get bytes per second (or 'bps' for bits but 1Bps = 8bps)", "Bps");
231 }
232
233 double surf_parse_get_speed(const char* string, const char* entity_kind, std::string name)
234 {
235   static const unit_scale units{std::make_tuple("f", 1.0, 10, true), std::make_tuple("flops", 1.0, 10, false)};
236   return surf_parse_get_value_with_unit(string, units, entity_kind, name,
237       "Append 'f' or 'flops' to your speed to get flop per second", "f");
238 }
239
240 static std::vector<double> surf_parse_get_all_speeds(char* speeds, const char* entity_kind, std::string id)
241 {
242
243   std::vector<double> speed_per_pstate;
244
245   if (strchr(speeds, ',') == nullptr){
246     double speed = surf_parse_get_speed(speeds, entity_kind, id);
247     speed_per_pstate.push_back(speed);
248   } else {
249     std::vector<std::string> pstate_list;
250     boost::split(pstate_list, speeds, boost::is_any_of(","));
251     for (auto speed_str : pstate_list) {
252       boost::trim(speed_str);
253       double speed = surf_parse_get_speed(speed_str.c_str(), entity_kind, id);
254       speed_per_pstate.push_back(speed);
255       XBT_DEBUG("Speed value: %f", speed);
256     }
257   }
258   return speed_per_pstate;
259 }
260
261 /*
262  * All the callback lists that can be overridden anywhere.
263  * (this list should probably be reduced to the bare minimum to allow the models to work)
264  */
265
266 /* make sure these symbols are defined as strong ones in this file so that the linker can resolve them */
267
268 /* The default current property receiver. Setup in the corresponding opening callbacks. */
269 std::map<std::string, std::string>* current_property_set       = nullptr;
270 std::map<std::string, std::string>* current_model_property_set = nullptr;
271 int ZONE_TAG                            = 0; // Whether we just opened a zone tag (to see what to do with the properties)
272
273 FILE *surf_file_to_parse = nullptr;
274
275 /* Stuff relative to storage */
276 void STag_surfxml_storage()
277 {
278   ZONE_TAG = 0;
279   XBT_DEBUG("STag_surfxml_storage");
280   xbt_assert(current_property_set == nullptr, "Someone forgot to reset the property set to nullptr in its closing tag (or XML malformed)");
281 }
282
283 void ETag_surfxml_storage()
284 {
285   simgrid::kernel::routing::StorageCreationArgs storage;
286
287   storage.properties   = current_property_set;
288   current_property_set = nullptr;
289
290   storage.id           = A_surfxml_storage_id;
291   storage.type_id      = A_surfxml_storage_typeId;
292   storage.content      = A_surfxml_storage_content;
293   storage.attach       = A_surfxml_storage_attach;
294
295   sg_platf_new_storage(&storage);
296 }
297 void STag_surfxml_storage___type()
298 {
299   ZONE_TAG = 0;
300   XBT_DEBUG("STag_surfxml_storage___type");
301   xbt_assert(current_property_set == nullptr, "Someone forgot to reset the property set to nullptr in its closing tag (or XML malformed)");
302   xbt_assert(current_model_property_set == nullptr, "Someone forgot to reset the model property set to nullptr in its closing tag (or XML malformed)");
303 }
304 void ETag_surfxml_storage___type()
305 {
306   simgrid::kernel::routing::StorageTypeCreationArgs storage_type;
307
308   storage_type.properties = current_property_set;
309   current_property_set    = nullptr;
310
311   storage_type.model_properties = current_model_property_set;
312   current_model_property_set    = nullptr;
313
314   storage_type.content = A_surfxml_storage___type_content;
315   storage_type.id      = A_surfxml_storage___type_id;
316   storage_type.model   = A_surfxml_storage___type_model;
317   storage_type.size =
318       surf_parse_get_size(A_surfxml_storage___type_size, "size of storage type", storage_type.id.c_str());
319   sg_platf_new_storage_type(&storage_type);
320 }
321
322 void STag_surfxml_mount()
323 {
324   XBT_DEBUG("STag_surfxml_mount");
325 }
326
327 void ETag_surfxml_mount()
328 {
329   simgrid::kernel::routing::MountCreationArgs mount;
330
331   mount.name      = A_surfxml_mount_name;
332   mount.storageId = A_surfxml_mount_storageId;
333   sg_platf_new_mount(&mount);
334 }
335
336 void STag_surfxml_include()
337 {
338   xbt_die("<include> tag was removed in SimGrid v3.18. Please stop using it now.");
339 }
340
341 void ETag_surfxml_include()
342 {
343   /* Won't happen since <include> is now removed since v3.18. */
344 }
345
346 /* Stag and Etag parse functions */
347 void STag_surfxml_platform() {
348   XBT_ATTRIB_UNUSED double version = surf_parse_get_double(A_surfxml_platform_version);
349
350   xbt_assert((version >= 1.0), "******* BIG FAT WARNING *********\n "
351       "You're using an ancient XML file.\n"
352       "Since SimGrid 3.1, units are Bytes, Flops, and seconds "
353       "instead of MBytes, MFlops and seconds.\n"
354
355       "Use simgrid_update_xml to update your file automatically. "
356       "This program is installed automatically with SimGrid, or "
357       "available in the tools/ directory of the source archive.\n"
358
359       "Please check also out the SURF section of the ChangeLog for "
360       "the 3.1 version for more information. \n"
361
362       "Last, do not forget to also update your values for "
363       "the calls to MSG_task_create (if any).");
364   xbt_assert((version >= 3.0), "******* BIG FAT WARNING *********\n "
365       "You're using an old XML file.\n"
366       "Use simgrid_update_xml to update your file automatically. "
367       "This program is installed automatically with SimGrid, or "
368       "available in the tools/ directory of the source archive.");
369   xbt_assert((version >= 4.0),
370              "******* FILE %s IS TOO OLD (v:%.1f) *********\n "
371              "Changes introduced in SimGrid 3.13:\n"
372              "  - 'power' attribute of hosts (and others) got renamed to 'speed'.\n"
373              "  - In <trace_connect>, attribute kind=\"POWER\" is now kind=\"SPEED\".\n"
374              "  - DOCTYPE now point to the rignt URL: http://simgrid.gforge.inria.fr/simgrid/simgrid.dtd\n"
375              "  - speed, bandwidth and latency attributes now MUST have an explicit unit (f, Bps, s by default)"
376              "\n\n"
377              "Use simgrid_update_xml to update your file automatically. "
378              "This program is installed automatically with SimGrid, or "
379              "available in the tools/ directory of the source archive.",
380              surf_parsed_filename, version);
381   if (version < 4.1) {
382     XBT_INFO("You're using a v%.1f XML file (%s) while the current standard is v4.1 "
383              "That's fine, the new version is backward compatible. \n\n"
384              "Use simgrid_update_xml to update your file automatically to get rid of this warning. "
385              "This program is installed automatically with SimGrid, or "
386              "available in the tools/ directory of the source archive.",
387              version, surf_parsed_filename);
388   }
389   xbt_assert(version <= 4.1, "******* FILE %s COMES FROM THE FUTURE (v:%.1f) *********\n "
390                              "The most recent formalism that this version of SimGrid understands is v4.1.\n"
391                              "Please update your code, or use another, more adapted, file.",
392              surf_parsed_filename, version);
393
394   simgrid::s4u::on_platform_creation();
395 }
396 void ETag_surfxml_platform(){
397   simgrid::s4u::on_platform_created();
398 }
399
400 void STag_surfxml_host(){
401   ZONE_TAG = 0;
402   xbt_assert(current_property_set == nullptr, "Someone forgot to reset the property set to nullptr in its closing tag (or XML malformed)");
403 }
404
405 void STag_surfxml_prop()
406 {
407   if (ZONE_TAG) { // We need to retrieve the most recently opened zone
408     XBT_DEBUG("Set zone property %s -> %s", A_surfxml_prop_id, A_surfxml_prop_value);
409     simgrid::s4u::NetZone* netzone = simgrid::s4u::Engine::getInstance()->getNetzoneByNameOrNull(A_surfxml_zone_id);
410
411     netzone->setProperty(A_surfxml_prop_id, A_surfxml_prop_value);
412   } else {
413     if (not current_property_set)
414       current_property_set = new std::map<std::string, std::string>; // Maybe, it should raise an error
415     current_property_set->insert({A_surfxml_prop_id, A_surfxml_prop_value});
416     XBT_DEBUG("add prop %s=%s into current property set %p", A_surfxml_prop_id, A_surfxml_prop_value,
417               current_property_set);
418   }
419 }
420
421 void ETag_surfxml_host()    {
422   simgrid::kernel::routing::HostCreationArgs host;
423
424   host.properties = current_property_set;
425   current_property_set = nullptr;
426
427   host.id = A_surfxml_host_id;
428
429   host.speed_per_pstate = surf_parse_get_all_speeds(A_surfxml_host_speed, "speed of host", host.id);
430
431   XBT_DEBUG("pstate: %s", A_surfxml_host_pstate);
432   host.core_amount = surf_parse_get_int(A_surfxml_host_core);
433   host.speed_trace = A_surfxml_host_availability___file[0] ? tmgr_trace_new_from_file(A_surfxml_host_availability___file) : nullptr;
434   host.state_trace = A_surfxml_host_state___file[0] ? tmgr_trace_new_from_file(A_surfxml_host_state___file) : nullptr;
435   host.pstate      = surf_parse_get_int(A_surfxml_host_pstate);
436   host.coord       = A_surfxml_host_coordinates;
437
438   sg_platf_new_host(&host);
439 }
440
441 void STag_surfxml_host___link(){
442   XBT_DEBUG("Create a Host_link for %s",A_surfxml_host___link_id);
443   simgrid::kernel::routing::HostLinkCreationArgs host_link;
444
445   host_link.id        = A_surfxml_host___link_id;
446   host_link.link_up   = A_surfxml_host___link_up;
447   host_link.link_down = A_surfxml_host___link_down;
448   sg_platf_new_hostlink(&host_link);
449 }
450
451 void STag_surfxml_router(){
452   sg_platf_new_router(A_surfxml_router_id, A_surfxml_router_coordinates);
453 }
454
455 void ETag_surfxml_cluster(){
456   simgrid::kernel::routing::ClusterCreationArgs cluster;
457   cluster.properties   = current_property_set;
458   current_property_set = nullptr;
459
460   cluster.id          = A_surfxml_cluster_id;
461   cluster.prefix      = A_surfxml_cluster_prefix;
462   cluster.suffix      = A_surfxml_cluster_suffix;
463   cluster.radicals    = explodesRadical(A_surfxml_cluster_radical);
464   cluster.speeds      = surf_parse_get_all_speeds(A_surfxml_cluster_speed, "speed of cluster", cluster.id);
465   cluster.core_amount = surf_parse_get_int(A_surfxml_cluster_core);
466   cluster.bw          = surf_parse_get_bandwidth(A_surfxml_cluster_bw, "bw of cluster", cluster.id);
467   cluster.lat         = surf_parse_get_time(A_surfxml_cluster_lat, "lat of cluster", cluster.id);
468   if(strcmp(A_surfxml_cluster_bb___bw,""))
469     cluster.bb_bw = surf_parse_get_bandwidth(A_surfxml_cluster_bb___bw, "bb_bw of cluster", cluster.id);
470   if(strcmp(A_surfxml_cluster_bb___lat,""))
471     cluster.bb_lat = surf_parse_get_time(A_surfxml_cluster_bb___lat, "bb_lat of cluster", cluster.id);
472   if(strcmp(A_surfxml_cluster_limiter___link,""))
473     cluster.limiter_link = surf_parse_get_bandwidth(A_surfxml_cluster_limiter___link, "limiter_link of cluster", cluster.id);
474   if(strcmp(A_surfxml_cluster_loopback___bw,""))
475     cluster.loopback_bw = surf_parse_get_bandwidth(A_surfxml_cluster_loopback___bw, "loopback_bw of cluster", cluster.id);
476   if(strcmp(A_surfxml_cluster_loopback___lat,""))
477     cluster.loopback_lat = surf_parse_get_time(A_surfxml_cluster_loopback___lat, "loopback_lat of cluster", cluster.id);
478
479   switch(AX_surfxml_cluster_topology){
480   case A_surfxml_cluster_topology_FLAT:
481     cluster.topology = simgrid::kernel::routing::ClusterTopology::FLAT;
482     break;
483   case A_surfxml_cluster_topology_TORUS:
484     cluster.topology = simgrid::kernel::routing::ClusterTopology::TORUS;
485     break;
486   case A_surfxml_cluster_topology_FAT___TREE:
487     cluster.topology = simgrid::kernel::routing::ClusterTopology::FAT_TREE;
488     break;
489   case A_surfxml_cluster_topology_DRAGONFLY:
490     cluster.topology = simgrid::kernel::routing::ClusterTopology::DRAGONFLY;
491     break;
492   default:
493     surf_parse_error(std::string("Invalid cluster topology for cluster ") + cluster.id);
494     break;
495   }
496   cluster.topo_parameters = A_surfxml_cluster_topo___parameters;
497   cluster.router_id = A_surfxml_cluster_router___id;
498
499   switch (AX_surfxml_cluster_sharing___policy) {
500   case A_surfxml_cluster_sharing___policy_SHARED:
501     cluster.sharing_policy = simgrid::s4u::Link::SharingPolicy::SHARED;
502     break;
503   case A_surfxml_cluster_sharing___policy_FULLDUPLEX:
504     XBT_WARN("FULLDUPLEX is now deprecated. Please update your platform file to use SPLITDUPLEX instead.");
505     cluster.sharing_policy = simgrid::s4u::Link::SharingPolicy::SPLITDUPLEX;
506     break;
507   case A_surfxml_cluster_sharing___policy_SPLITDUPLEX:
508     cluster.sharing_policy = simgrid::s4u::Link::SharingPolicy::SPLITDUPLEX;
509     break;
510   case A_surfxml_cluster_sharing___policy_FATPIPE:
511     cluster.sharing_policy = simgrid::s4u::Link::SharingPolicy::FATPIPE;
512     break;
513   default:
514     surf_parse_error(std::string("Invalid cluster sharing policy for cluster ") + cluster.id);
515     break;
516   }
517   switch (AX_surfxml_cluster_bb___sharing___policy) {
518   case A_surfxml_cluster_bb___sharing___policy_FATPIPE:
519     cluster.bb_sharing_policy = simgrid::s4u::Link::SharingPolicy::FATPIPE;
520     break;
521   case A_surfxml_cluster_bb___sharing___policy_SHARED:
522     cluster.bb_sharing_policy = simgrid::s4u::Link::SharingPolicy::SHARED;
523     break;
524   default:
525     surf_parse_error(std::string("Invalid bb sharing policy in cluster ") + cluster.id);
526     break;
527   }
528
529   sg_platf_new_cluster(&cluster);
530 }
531
532 void STag_surfxml_cluster(){
533   ZONE_TAG = 0;
534   xbt_assert(current_property_set == nullptr, "Someone forgot to reset the property set to nullptr in its closing tag (or XML malformed)");
535 }
536
537 void STag_surfxml_cabinet(){
538   simgrid::kernel::routing::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);
546
547   sg_platf_new_cabinet(&cabinet);
548 }
549
550 void STag_surfxml_peer(){
551   simgrid::kernel::routing::PeerCreationArgs peer;
552
553   peer.id          = std::string(A_surfxml_peer_id);
554   peer.speed       = surf_parse_get_speed(A_surfxml_peer_speed, "speed of peer", peer.id.c_str());
555   peer.bw_in       = surf_parse_get_bandwidth(A_surfxml_peer_bw___in, "bw_in of peer", peer.id.c_str());
556   peer.bw_out      = surf_parse_get_bandwidth(A_surfxml_peer_bw___out, "bw_out of peer", peer.id.c_str());
557   peer.coord       = A_surfxml_peer_coordinates;
558   peer.speed_trace = A_surfxml_peer_availability___file[0] ? tmgr_trace_new_from_file(A_surfxml_peer_availability___file) : nullptr;
559   peer.state_trace = A_surfxml_peer_state___file[0] ? tmgr_trace_new_from_file(A_surfxml_peer_state___file) : nullptr;
560
561   if (A_surfxml_peer_lat[0] != '\0')
562     XBT_WARN("The latency parameter in <peer> is now deprecated. Use the z coordinate instead of '%s'.",
563              A_surfxml_peer_lat);
564
565   sg_platf_new_peer(&peer);
566 }
567
568 void STag_surfxml_link(){
569   ZONE_TAG = 0;
570   xbt_assert(current_property_set == nullptr, "Someone forgot to reset the property set to nullptr in its closing tag (or XML malformed)");
571 }
572
573 void ETag_surfxml_link(){
574   simgrid::kernel::routing::LinkCreationArgs link;
575
576   link.properties          = current_property_set;
577   current_property_set     = nullptr;
578
579   link.id                  = std::string(A_surfxml_link_id);
580   link.bandwidth           = surf_parse_get_bandwidth(A_surfxml_link_bandwidth, "bandwidth of link", link.id.c_str());
581   link.bandwidth_trace     = A_surfxml_link_bandwidth___file[0] ? tmgr_trace_new_from_file(A_surfxml_link_bandwidth___file) : nullptr;
582   link.latency             = surf_parse_get_time(A_surfxml_link_latency, "latency of link", link.id.c_str());
583   link.latency_trace       = A_surfxml_link_latency___file[0] ? tmgr_trace_new_from_file(A_surfxml_link_latency___file) : nullptr;
584   link.state_trace         = A_surfxml_link_state___file[0] ? tmgr_trace_new_from_file(A_surfxml_link_state___file):nullptr;
585
586   switch (A_surfxml_link_sharing___policy) {
587   case A_surfxml_link_sharing___policy_SHARED:
588     link.policy = simgrid::s4u::Link::SharingPolicy::SHARED;
589     break;
590   case A_surfxml_link_sharing___policy_FATPIPE:
591     link.policy = simgrid::s4u::Link::SharingPolicy::FATPIPE;
592     break;
593   case A_surfxml_link_sharing___policy_FULLDUPLEX:
594     XBT_WARN("FULLDUPLEX is now deprecated. Please update your platform file to use SPLITDUPLEX instead.");
595     link.policy = simgrid::s4u::Link::SharingPolicy::SPLITDUPLEX;
596     break;
597   case A_surfxml_link_sharing___policy_SPLITDUPLEX:
598     link.policy = simgrid::s4u::Link::SharingPolicy::SPLITDUPLEX;
599     break;
600   default:
601     surf_parse_error(std::string("Invalid sharing policy in link ") + link.id);
602     break;
603   }
604
605   sg_platf_new_link(&link);
606 }
607
608 void STag_surfxml_link___ctn()
609 {
610   simgrid::kernel::resource::LinkImpl* link = nullptr;
611   switch (A_surfxml_link___ctn_direction) {
612   case AU_surfxml_link___ctn_direction:
613   case A_surfxml_link___ctn_direction_NONE:
614     link = simgrid::kernel::resource::LinkImpl::byName(A_surfxml_link___ctn_id);
615     break;
616   case A_surfxml_link___ctn_direction_UP:
617     link = simgrid::kernel::resource::LinkImpl::byName(std::string(A_surfxml_link___ctn_id) + "_UP");
618     break;
619   case A_surfxml_link___ctn_direction_DOWN:
620     link = simgrid::kernel::resource::LinkImpl::byName(std::string(A_surfxml_link___ctn_id) + "_DOWN");
621     break;
622   default:
623     surf_parse_error(std::string("Invalid direction for link ") + A_surfxml_link___ctn_id);
624     break;
625   }
626
627   const char* dirname = "";
628   switch (A_surfxml_link___ctn_direction) {
629     case A_surfxml_link___ctn_direction_UP:
630       dirname = " (upward)";
631       break;
632     case A_surfxml_link___ctn_direction_DOWN:
633       dirname = " (downward)";
634       break;
635     default:
636       dirname = "";
637   }
638   surf_parse_assert(link != nullptr, std::string("No such link: '") + A_surfxml_link___ctn_id + "'" + dirname);
639   parsed_link_list.push_back(link);
640 }
641
642 void ETag_surfxml_backbone(){
643   simgrid::kernel::routing::LinkCreationArgs link;
644
645   link.properties = nullptr;
646   link.id = std::string(A_surfxml_backbone_id);
647   link.bandwidth = surf_parse_get_bandwidth(A_surfxml_backbone_bandwidth, "bandwidth of backbone", link.id.c_str());
648   link.latency = surf_parse_get_time(A_surfxml_backbone_latency, "latency of backbone", link.id.c_str());
649   link.policy     = simgrid::s4u::Link::SharingPolicy::SHARED;
650
651   sg_platf_new_link(&link);
652   routing_cluster_add_backbone(simgrid::kernel::resource::LinkImpl::byName(A_surfxml_backbone_id));
653 }
654
655 void STag_surfxml_route(){
656   surf_parse_assert_netpoint(A_surfxml_route_src, "Route src='", "' does name a node.");
657   surf_parse_assert_netpoint(A_surfxml_route_dst, "Route dst='", "' does name a node.");
658 }
659
660 void STag_surfxml_ASroute(){
661   surf_parse_assert_netpoint(A_surfxml_ASroute_src, "ASroute src='", "' does name a node.");
662   surf_parse_assert_netpoint(A_surfxml_ASroute_dst, "ASroute dst='", "' does name a node.");
663
664   surf_parse_assert_netpoint(A_surfxml_ASroute_gw___src, "ASroute gw_src='", "' does name a node.");
665   surf_parse_assert_netpoint(A_surfxml_ASroute_gw___dst, "ASroute gw_dst='", "' does name a node.");
666 }
667 void STag_surfxml_zoneRoute(){
668   surf_parse_assert_netpoint(A_surfxml_zoneRoute_src, "zoneRoute src='", "' does name a node.");
669   surf_parse_assert_netpoint(A_surfxml_zoneRoute_dst, "zoneRoute dst='", "' does name a node.");
670   surf_parse_assert_netpoint(A_surfxml_zoneRoute_gw___src, "zoneRoute gw_src='", "' does name a node.");
671   surf_parse_assert_netpoint(A_surfxml_zoneRoute_gw___dst, "zoneRoute gw_dst='", "' does name a node.");
672 }
673
674 void STag_surfxml_bypassRoute(){
675   surf_parse_assert_netpoint(A_surfxml_bypassRoute_src, "bypassRoute src='", "' does name a node.");
676   surf_parse_assert_netpoint(A_surfxml_bypassRoute_dst, "bypassRoute dst='", "' does name a node.");
677 }
678
679 void STag_surfxml_bypassASroute(){
680   surf_parse_assert_netpoint(A_surfxml_bypassASroute_src, "bypassASroute src='", "' does name a node.");
681   surf_parse_assert_netpoint(A_surfxml_bypassASroute_dst, "bypassASroute dst='", "' does name a node.");
682   surf_parse_assert_netpoint(A_surfxml_bypassASroute_gw___src, "bypassASroute gw_src='", "' does name a node.");
683   surf_parse_assert_netpoint(A_surfxml_bypassASroute_gw___dst, "bypassASroute gw_dst='", "' does name a node.");
684 }
685 void STag_surfxml_bypassZoneRoute(){
686   surf_parse_assert_netpoint(A_surfxml_bypassZoneRoute_src, "bypassZoneRoute src='", "' does name a node.");
687   surf_parse_assert_netpoint(A_surfxml_bypassZoneRoute_dst, "bypassZoneRoute dst='", "' does name a node.");
688   surf_parse_assert_netpoint(A_surfxml_bypassZoneRoute_gw___src, "bypassZoneRoute gw_src='", "' does name a node.");
689   surf_parse_assert_netpoint(A_surfxml_bypassZoneRoute_gw___dst, "bypassZoneRoute gw_dst='", "' does name a node.");
690 }
691
692 void ETag_surfxml_route(){
693   simgrid::kernel::routing::RouteCreationArgs route;
694
695   route.src         = sg_netpoint_by_name_or_null(A_surfxml_route_src); // tested to not be nullptr in start tag
696   route.dst         = sg_netpoint_by_name_or_null(A_surfxml_route_dst); // tested to not be nullptr in start tag
697   route.gw_src    = nullptr;
698   route.gw_dst    = nullptr;
699   route.symmetrical = (A_surfxml_route_symmetrical == A_surfxml_route_symmetrical_YES);
700
701   route.link_list.swap(parsed_link_list);
702
703   sg_platf_new_route(&route);
704 }
705
706 void ETag_surfxml_ASroute()
707 {
708   AX_surfxml_zoneRoute_src = AX_surfxml_ASroute_src;
709   AX_surfxml_zoneRoute_dst = AX_surfxml_ASroute_dst;
710   AX_surfxml_zoneRoute_gw___src = AX_surfxml_ASroute_gw___src;
711   AX_surfxml_zoneRoute_gw___dst = AX_surfxml_ASroute_gw___dst;
712   AX_surfxml_zoneRoute_symmetrical = (AT_surfxml_zoneRoute_symmetrical)AX_surfxml_ASroute_symmetrical;
713   ETag_surfxml_zoneRoute();
714 }
715 void ETag_surfxml_zoneRoute()
716 {
717   simgrid::kernel::routing::RouteCreationArgs ASroute;
718
719   ASroute.src = sg_netpoint_by_name_or_null(A_surfxml_zoneRoute_src); // tested to not be nullptr in start tag
720   ASroute.dst = sg_netpoint_by_name_or_null(A_surfxml_zoneRoute_dst); // tested to not be nullptr in start tag
721
722   ASroute.gw_src = sg_netpoint_by_name_or_null(A_surfxml_zoneRoute_gw___src); // tested to not be nullptr in start tag
723   ASroute.gw_dst = sg_netpoint_by_name_or_null(A_surfxml_zoneRoute_gw___dst); // tested to not be nullptr in start tag
724
725   ASroute.link_list.swap(parsed_link_list);
726
727   switch (A_surfxml_zoneRoute_symmetrical) {
728   case AU_surfxml_zoneRoute_symmetrical:
729   case A_surfxml_zoneRoute_symmetrical_YES:
730     ASroute.symmetrical = true;
731     break;
732   case A_surfxml_zoneRoute_symmetrical_NO:
733     ASroute.symmetrical = false;
734     break;
735   default:
736     THROW_IMPOSSIBLE;
737   }
738
739   sg_platf_new_route(&ASroute);
740 }
741
742 void ETag_surfxml_bypassRoute(){
743   simgrid::kernel::routing::RouteCreationArgs route;
744
745   route.src         = sg_netpoint_by_name_or_null(A_surfxml_bypassRoute_src); // tested to not be nullptr in start tag
746   route.dst         = sg_netpoint_by_name_or_null(A_surfxml_bypassRoute_dst); // tested to not be nullptr in start tag
747   route.gw_src = nullptr;
748   route.gw_dst = nullptr;
749   route.symmetrical = false;
750
751   route.link_list.swap(parsed_link_list);
752
753   sg_platf_new_bypassRoute(&route);
754 }
755
756 void ETag_surfxml_bypassASroute()
757 {
758   AX_surfxml_bypassZoneRoute_src = AX_surfxml_bypassASroute_src;
759   AX_surfxml_bypassZoneRoute_dst = AX_surfxml_bypassASroute_dst;
760   AX_surfxml_bypassZoneRoute_gw___src = AX_surfxml_bypassASroute_gw___src;
761   AX_surfxml_bypassZoneRoute_gw___dst = AX_surfxml_bypassASroute_gw___dst;
762   ETag_surfxml_bypassZoneRoute();
763 }
764 void ETag_surfxml_bypassZoneRoute()
765 {
766   simgrid::kernel::routing::RouteCreationArgs ASroute;
767
768   ASroute.src         = sg_netpoint_by_name_or_null(A_surfxml_bypassZoneRoute_src);
769   ASroute.dst         = sg_netpoint_by_name_or_null(A_surfxml_bypassZoneRoute_dst);
770   ASroute.link_list.swap(parsed_link_list);
771
772   ASroute.symmetrical = false;
773
774   ASroute.gw_src = sg_netpoint_by_name_or_null(A_surfxml_bypassZoneRoute_gw___src);
775   ASroute.gw_dst = sg_netpoint_by_name_or_null(A_surfxml_bypassZoneRoute_gw___dst);
776
777   sg_platf_new_bypassRoute(&ASroute);
778 }
779
780 void ETag_surfxml_trace(){
781   simgrid::kernel::routing::TraceCreationArgs trace;
782
783   trace.id = A_surfxml_trace_id;
784   trace.file = A_surfxml_trace_file;
785   trace.periodicity = surf_parse_get_double(A_surfxml_trace_periodicity);
786   trace.pc_data = surfxml_pcdata;
787
788   sg_platf_new_trace(&trace);
789 }
790
791 void STag_surfxml_trace___connect()
792 {
793   simgrid::kernel::routing::TraceConnectCreationArgs trace_connect;
794
795   trace_connect.element = A_surfxml_trace___connect_element;
796   trace_connect.trace = A_surfxml_trace___connect_trace;
797
798   switch (A_surfxml_trace___connect_kind) {
799   case AU_surfxml_trace___connect_kind:
800   case A_surfxml_trace___connect_kind_SPEED:
801     trace_connect.kind = simgrid::kernel::routing::TraceConnectKind::SPEED;
802     break;
803   case A_surfxml_trace___connect_kind_BANDWIDTH:
804     trace_connect.kind = simgrid::kernel::routing::TraceConnectKind::BANDWIDTH;
805     break;
806   case A_surfxml_trace___connect_kind_HOST___AVAIL:
807     trace_connect.kind = simgrid::kernel::routing::TraceConnectKind::HOST_AVAIL;
808     break;
809   case A_surfxml_trace___connect_kind_LATENCY:
810     trace_connect.kind = simgrid::kernel::routing::TraceConnectKind::LATENCY;
811     break;
812   case A_surfxml_trace___connect_kind_LINK___AVAIL:
813     trace_connect.kind = simgrid::kernel::routing::TraceConnectKind::LINK_AVAIL;
814     break;
815   default:
816     surf_parse_error("Invalid trace kind");
817     break;
818   }
819   sg_platf_trace_connect(&trace_connect);
820 }
821
822 void STag_surfxml_AS()
823 {
824   AX_surfxml_zone_id = AX_surfxml_AS_id;
825   AX_surfxml_zone_routing = (AT_surfxml_zone_routing)AX_surfxml_AS_routing;
826   STag_surfxml_zone();
827 }
828
829 void ETag_surfxml_AS()
830 {
831   ETag_surfxml_zone();
832 }
833
834 void STag_surfxml_zone()
835 {
836   ZONE_TAG                 = 1;
837   simgrid::kernel::routing::ZoneCreationArgs zone;
838   zone.id      = A_surfxml_zone_id;
839   zone.routing = static_cast<int>(A_surfxml_zone_routing);
840
841   sg_platf_new_Zone_begin(&zone);
842 }
843
844 void ETag_surfxml_zone()
845 {
846   sg_platf_new_Zone_seal();
847 }
848
849 void STag_surfxml_config()
850 {
851   ZONE_TAG = 0;
852   xbt_assert(current_property_set == nullptr,
853              "Someone forgot to reset the property set to nullptr in its closing tag (or XML malformed)");
854   XBT_DEBUG("START configuration name = %s",A_surfxml_config_id);
855   if (_sg_cfg_init_status == 2) {
856     surf_parse_error("All <config> tags must be given before any platform elements (such as <zone>, <host>, <cluster>, "
857                      "<link>, etc).");
858   }
859 }
860
861 void ETag_surfxml_config()
862 {
863   for (auto const& elm : *current_property_set) {
864     if (simgrid::config::is_default(elm.first.c_str())) {
865       std::string cfg = elm.first + ":" + elm.second;
866       simgrid::config::set_parse(std::move(cfg));
867     } else
868       XBT_INFO("The custom configuration '%s' is already defined by user!", elm.first.c_str());
869   }
870   XBT_DEBUG("End configuration name = %s",A_surfxml_config_id);
871   if (TRACE_is_enabled())
872     TRACE_start();
873
874   delete current_property_set;
875   current_property_set = nullptr;
876 }
877
878 static std::vector<std::string> arguments;
879
880 void STag_surfxml_process()
881 {
882   AX_surfxml_actor_function = AX_surfxml_process_function;
883   STag_surfxml_actor();
884 }
885
886 void STag_surfxml_actor()
887 {
888   ZONE_TAG  = 0;
889   arguments.assign(1, A_surfxml_actor_function);
890   xbt_assert(current_property_set == nullptr, "Someone forgot to reset the property set to nullptr in its closing tag (or XML malformed)");
891 }
892
893 void ETag_surfxml_process()
894 {
895   AX_surfxml_actor_host = AX_surfxml_process_host;
896   AX_surfxml_actor_function = AX_surfxml_process_function;
897   AX_surfxml_actor_start___time = AX_surfxml_process_start___time;
898   AX_surfxml_actor_kill___time = AX_surfxml_process_kill___time;
899   AX_surfxml_actor_on___failure = (AT_surfxml_actor_on___failure)AX_surfxml_process_on___failure;
900   ETag_surfxml_actor();
901 }
902
903 void ETag_surfxml_actor()
904 {
905   simgrid::kernel::routing::ActorCreationArgs actor;
906
907   actor.properties     = current_property_set;
908   current_property_set = nullptr;
909
910   actor.args.swap(arguments);
911   actor.host       = A_surfxml_actor_host;
912   actor.function   = A_surfxml_actor_function;
913   actor.start_time = surf_parse_get_double(A_surfxml_actor_start___time);
914   actor.kill_time  = surf_parse_get_double(A_surfxml_actor_kill___time);
915
916   switch (A_surfxml_actor_on___failure) {
917   case AU_surfxml_actor_on___failure:
918   case A_surfxml_actor_on___failure_DIE:
919     actor.on_failure = simgrid::kernel::routing::ActorOnFailure::DIE;
920     break;
921   case A_surfxml_actor_on___failure_RESTART:
922     actor.on_failure = simgrid::kernel::routing::ActorOnFailure::RESTART;
923     break;
924   default:
925     surf_parse_error("Invalid on failure behavior");
926     break;
927   }
928
929   sg_platf_new_actor(&actor);
930 }
931
932 void STag_surfxml_argument(){
933   arguments.push_back(A_surfxml_argument_value);
934 }
935
936 void STag_surfxml_model___prop(){
937   if (not current_model_property_set)
938     current_model_property_set = new std::map<std::string, std::string>();
939
940   current_model_property_set->insert({A_surfxml_model___prop_id, A_surfxml_model___prop_value});
941 }
942
943 void ETag_surfxml_prop(){/* Nothing to do */}
944 void STag_surfxml_random(){/* Nothing to do */}
945 void ETag_surfxml_random(){/* Nothing to do */}
946 void ETag_surfxml_trace___connect(){/* Nothing to do */}
947 void STag_surfxml_trace(){/* Nothing to do */}
948 void ETag_surfxml_router(){/*Nothing to do*/}
949 void ETag_surfxml_host___link(){/* Nothing to do */}
950 void ETag_surfxml_cabinet(){/* Nothing to do */}
951 void ETag_surfxml_peer(){/* Nothing to do */}
952 void STag_surfxml_backbone(){/* Nothing to do */}
953 void ETag_surfxml_link___ctn(){/* Nothing to do */}
954 void ETag_surfxml_argument(){/* Nothing to do */}
955 void ETag_surfxml_model___prop(){/* Nothing to do */}
956
957 /* Open and Close parse file */
958 YY_BUFFER_STATE surf_input_buffer;
959
960 void surf_parse_open(const char *file)
961 {
962   xbt_assert(file, "Cannot parse the nullptr file. Bypassing the parser is strongly deprecated nowadays.");
963
964   surf_parsed_filename = file;
965   std::string dir      = simgrid::xbt::Path(file).getDirname();
966   surf_path.push_back(dir);
967
968   surf_file_to_parse = surf_fopen(file, "r");
969   if (surf_file_to_parse == nullptr)
970     xbt_die("Unable to open '%s'\n", file);
971   surf_input_buffer = surf_parse__create_buffer(surf_file_to_parse, YY_BUF_SIZE);
972   surf_parse__switch_to_buffer(surf_input_buffer);
973   surf_parse_lineno = 1;
974 }
975
976 void surf_parse_close()
977 {
978   surf_path.pop_back(); // remove the dirname of the opened file, that was added in surf_parse_open()
979
980   if (surf_file_to_parse) {
981     surf_parse__delete_buffer(surf_input_buffer);
982     fclose(surf_file_to_parse);
983     surf_file_to_parse = nullptr; //Must be reset for Bypass
984   }
985 }
986
987 /* Call the lexer to parse the currently opened file */
988 int surf_parse()
989 {
990   return surf_parse_lex();
991 }