Logo AND Algorithmique Numérique Distribuée

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