Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
yet another dynar to disappear
[simgrid.git] / src / surf / xml / surfxml_sax_cb.cpp
1 /* Copyright (c) 2006-2015. The SimGrid Team.
2  * All rights reserved.                                                     */
3
4 /* This program is free software; you can redistribute it and/or modify it
5  * under the terms of the license (GNU LGPL) which comes with this package. */
6
7 #include <errno.h>
8 #include <math.h>
9 #include <stdarg.h> /* va_arg */
10
11 #include "xbt/misc.h"
12 #include "xbt/log.h"
13 #include "xbt/str.h"
14 #include "xbt/file.h"
15 #include "xbt/dict.h"
16 #include "src/surf/surf_private.h"
17 #include "src/surf/network_interface.hpp"
18 #include "simgrid/sg_config.h"
19 #include "simgrid/link.h"
20
21 #include "src/surf/xml/platf_private.hpp"
22
23 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_parse, surf, "Logging specific to the SURF parsing module");
24 #undef CLEANUP
25 int ETag_surfxml_include_state();
26
27 #include "simgrid_dtd.c"
28
29 char* surf_parsed_filename = nullptr; // to locate parse error messages
30
31 std::vector<char*> parsed_link_list;   /* temporary store of current list link of a route */
32 /*
33  * Helping functions
34  */
35 void surf_parse_assert(bool cond, const char *fmt, ...) {
36   if (!cond ) {
37     va_list va;
38     va_start(va,fmt);
39     int lineno = surf_parse_lineno;
40     char *msg = bvprintf(fmt,va);
41     va_end(va);
42     cleanup();
43     XBT_ERROR("Parse error at %s:%d: %s", surf_parsed_filename, lineno, msg);
44     surf_exit();
45     xbt_die("Exiting now");
46   }
47 }
48 void surf_parse_error(const char *fmt, ...) {
49   va_list va;
50   va_start(va,fmt);
51   int lineno = surf_parse_lineno;
52   char *msg = bvprintf(fmt,va);
53   va_end(va);
54   cleanup();
55   XBT_ERROR("Parse error at %s:%d: %s", surf_parsed_filename, lineno, msg);
56   surf_exit();
57   xbt_die("Exiting now");
58 }
59 void surf_parse_warn(const char *fmt, ...) {
60   va_list va;
61   va_start(va,fmt);
62   char *msg = bvprintf(fmt,va);
63   va_end(va);
64     XBT_WARN("%s:%d: %s", surf_parsed_filename, surf_parse_lineno, msg);
65     free(msg);
66 }
67
68 double surf_parse_get_double(const char *string) {
69   double res;
70   int ret = sscanf(string, "%lg", &res);
71   if (ret != 1)
72     surf_parse_error("%s is not a double", string);
73   return res;
74 }
75
76 int surf_parse_get_int(const char *string) {
77   int res;
78   int ret = sscanf(string, "%d", &res);
79   if (ret != 1)
80     surf_parse_error("%s is not an integer", string);
81   return res;
82 }
83
84 struct unit_scale {
85   const char *unit;
86   double scale;
87 };
88
89 /* Note: field `unit' for the last element of parameter `units' should be nullptr. */
90 static double surf_parse_get_value_with_unit(const char *string, const struct unit_scale *units,
91     const char *entity_kind, const char *name,
92     const char *error_msg, const char *default_unit)
93 {
94   char* ptr;
95   double res;
96   int i;
97   errno = 0;
98   res   = strtod(string, &ptr);
99   if (errno == ERANGE)
100     surf_parse_error("value out of range: %s", string);
101   if (ptr == string)
102     surf_parse_error("cannot parse number: %s", string);
103   if (ptr[0] == '\0') {
104     if (res == 0)
105       return res; // Ok, 0 can be unit-less
106
107     XBT_WARN("Deprecated unit-less value '%s' for %s %s. %s",string, entity_kind, name, error_msg);
108     ptr = (char*)default_unit;
109   }
110   for (i = 0; units[i].unit != nullptr && strcmp(ptr, units[i].unit) != 0; i++) {
111   }
112   if (units[i].unit != nullptr)
113     res *= units[i].scale;
114   else
115     surf_parse_error("unknown unit: %s", ptr);
116   return res;
117 }
118
119 double surf_parse_get_time(const char *string, const char *entity_kind, const char *name)
120 {
121   const struct unit_scale units[] = {
122     { "w",  7 * 24 * 60 * 60 },
123     { "d",  24 * 60 * 60 },
124     { "h",  60 * 60 },
125     { "m",  60 },
126     { "s",  1.0 },
127     { "ms", 1e-3 },
128     { "us", 1e-6 },
129     { "ns", 1e-9 },
130     { "ps", 1e-12 },
131     { nullptr, 0 }
132   };
133   return surf_parse_get_value_with_unit(string, units, entity_kind, name,
134       "Append 's' to your time to get seconds", "s");
135 }
136
137 double surf_parse_get_size(const char *string, const char *entity_kind, const char *name)
138 {
139   const struct unit_scale units[] = {
140     { "EiB", pow(1024, 6) },
141     { "PiB", pow(1024, 5) },
142     { "TiB", pow(1024, 4) },
143     { "GiB", pow(1024, 3) },
144     { "MiB", pow(1024, 2) },
145     { "KiB", 1024 },
146     { "EB",  1e18 },
147     { "PB",  1e15 },
148     { "TB",  1e12 },
149     { "GB",  1e9 },
150     { "MB",  1e6 },
151     { "kB",  1e3 },
152     { "B",   1.0 },
153     { "Eib", 0.125 * pow(1024, 6) },
154     { "Pib", 0.125 * pow(1024, 5) },
155     { "Tib", 0.125 * pow(1024, 4) },
156     { "Gib", 0.125 * pow(1024, 3) },
157     { "Mib", 0.125 * pow(1024, 2) },
158     { "Kib", 0.125 * 1024 },
159     { "Eb",  0.125 * 1e18 },
160     { "Pb",  0.125 * 1e15 },
161     { "Tb",  0.125 * 1e12 },
162     { "Gb",  0.125 * 1e9 },
163     { "Mb",  0.125 * 1e6 },
164     { "kb",  0.125 * 1e3 },
165     { "b",   0.125 },
166     { nullptr,    0 }
167   };
168   return surf_parse_get_value_with_unit(string, units, entity_kind, name,
169       "Append 'B' to get bytes (or 'b' for bits but 1B = 8b).", "B");
170 }
171
172 double surf_parse_get_bandwidth(const char *string, const char *entity_kind, const char *name)
173 {
174   const struct unit_scale units[] = {
175     { "EiBps", pow(1024, 6) },
176     { "PiBps", pow(1024, 5) },
177     { "TiBps", pow(1024, 4) },
178     { "GiBps", pow(1024, 3) },
179     { "MiBps", pow(1024, 2) },
180     { "KiBps", 1024 },
181     { "EBps",  1e18 },
182     { "PBps",  1e15 },
183     { "TBps",  1e12 },
184     { "GBps",  1e9 },
185     { "MBps",  1e6 },
186     { "kBps",  1e3 },
187     { "Bps",   1.0 },
188     { "Eibps", 0.125 * pow(1024, 6) },
189     { "Pibps", 0.125 * pow(1024, 5) },
190     { "Tibps", 0.125 * pow(1024, 4) },
191     { "Gibps", 0.125 * pow(1024, 3) },
192     { "Mibps", 0.125 * pow(1024, 2) },
193     { "Kibps", 0.125 * 1024 },
194     { "Tbps",  0.125 * 1e12 },
195     { "Gbps",  0.125 * 1e9 },
196     { "Mbps",  0.125 * 1e6 },
197     { "kbps",  0.125 * 1e3 },
198     { "bps",   0.125 },
199     { nullptr,    0 }
200   };
201   return surf_parse_get_value_with_unit(string, units, entity_kind, name,
202       "Append 'Bps' to get bytes per second (or 'bps' for bits but 1Bps = 8bps)", "Bps");
203 }
204
205 double surf_parse_get_speed(const char *string, const char *entity_kind, const char *name)
206 {
207   const struct unit_scale units[] = {
208     { "yottaflops", 1e24 },
209     { "Yf",         1e24 },
210     { "zettaflops", 1e21 },
211     { "Zf",         1e21 },
212     { "exaflops",   1e18 },
213     { "Ef",         1e18 },
214     { "petaflops",  1e15 },
215     { "Pf",         1e15 },
216     { "teraflops",  1e12 },
217     { "Tf",         1e12 },
218     { "gigaflops",  1e9 },
219     { "Gf",         1e9 },
220     { "megaflops",  1e6 },
221     { "Mf",         1e6 },
222     { "kiloflops",  1e3 },
223     { "kf",         1e3 },
224     { "flops",      1.0 },
225     { "f",          1.0 },
226     { nullptr,         0 }
227   };
228   return surf_parse_get_value_with_unit(string, units, entity_kind, name,
229       "Append 'f' or 'flops' to your speed to get flop per second", "f");
230 }
231
232 /*
233  * All the callback lists that can be overridden anywhere.
234  * (this list should probably be reduced to the bare minimum to allow the models to work)
235  */
236
237 /* make sure these symbols are defined as strong ones in this file so that the linker can resolve them */
238
239 /* The default current property receiver. Setup in the corresponding opening callbacks. */
240 xbt_dict_t current_property_set = nullptr;
241 xbt_dict_t current_model_property_set = nullptr;
242 xbt_dict_t as_current_property_set = nullptr;
243 int AS_TAG = 0;
244 char* as_name_tab[1024];
245 void* as_dict_tab[1024];
246 int as_prop_nb = 0;
247
248
249 /* dictionary of random generator data */
250 xbt_dict_t random_data_list = nullptr;
251
252 YY_BUFFER_STATE surf_input_buffer;
253 FILE *surf_file_to_parse = nullptr;
254
255 /*
256  * Stuff relative to storage
257  */
258 void STag_surfxml_storage()
259 {
260   AS_TAG = 0;
261   XBT_DEBUG("STag_surfxml_storage");
262   xbt_assert(current_property_set == nullptr, "Someone forgot to reset the property set to nullptr in its closing tag (or XML malformed)");
263 }
264 void ETag_surfxml_storage()
265 {
266   s_sg_platf_storage_cbarg_t storage;
267   memset(&storage,0,sizeof(storage));
268
269   storage.id           = A_surfxml_storage_id;
270   storage.type_id      = A_surfxml_storage_typeId;
271   storage.content      = A_surfxml_storage_content;
272   storage.content_type = A_surfxml_storage_content___type;
273   storage.properties   = current_property_set;
274   storage.attach       = A_surfxml_storage_attach;
275   sg_platf_new_storage(&storage);
276   current_property_set = nullptr;
277 }
278 void STag_surfxml_storage___type()
279 {
280   AS_TAG = 0;
281   XBT_DEBUG("STag_surfxml_storage___type");
282   xbt_assert(current_property_set == nullptr, "Someone forgot to reset the property set to nullptr in its closing tag (or XML malformed)");
283   xbt_assert(current_model_property_set == nullptr, "Someone forgot to reset the model property set to nullptr in its closing tag (or XML malformed)");
284 }
285 void ETag_surfxml_storage___type()
286 {
287   s_sg_platf_storage_type_cbarg_t storage_type;
288   memset(&storage_type,0,sizeof(storage_type));
289
290   storage_type.content          = A_surfxml_storage___type_content;
291   storage_type.content_type     = A_surfxml_storage___type_content___type;
292   storage_type.id               = A_surfxml_storage___type_id;
293   storage_type.model            = A_surfxml_storage___type_model;
294   storage_type.properties       = current_property_set;
295   storage_type.model_properties = current_model_property_set;
296   storage_type.size             = surf_parse_get_size(A_surfxml_storage___type_size,
297         "size of storage type", storage_type.id);
298   sg_platf_new_storage_type(&storage_type);
299   current_property_set       = nullptr;
300   current_model_property_set = nullptr;
301 }
302 void STag_surfxml_mount()
303 {
304   XBT_DEBUG("STag_surfxml_mount");
305 }
306 void ETag_surfxml_mount()
307 {
308   s_sg_platf_mount_cbarg_t mount;
309   memset(&mount,0,sizeof(mount));
310
311   mount.name      = A_surfxml_mount_name;
312   mount.storageId = A_surfxml_mount_storageId;
313   sg_platf_new_mount(&mount);
314 }
315
316 /*
317  * Stuff relative to the <include> tag
318  */
319 static xbt_dynar_t surf_input_buffer_stack    = nullptr;
320 static xbt_dynar_t surf_file_to_parse_stack   = nullptr;
321 static xbt_dynar_t surf_parsed_filename_stack = nullptr;
322
323 void STag_surfxml_include()
324 {
325   parse_after_config();
326   XBT_DEBUG("STag_surfxml_include '%s'",A_surfxml_include_file);
327   xbt_dynar_push(surf_parsed_filename_stack,&surf_parsed_filename); // save old file name
328   surf_parsed_filename = xbt_strdup(A_surfxml_include_file);
329
330   xbt_dynar_push(surf_file_to_parse_stack, &surf_file_to_parse); //save old file descriptor
331
332   surf_file_to_parse = surf_fopen(A_surfxml_include_file, "r"); // read new file descriptor
333   xbt_assert((surf_file_to_parse), "Unable to open \"%s\"\n", A_surfxml_include_file);
334
335   xbt_dynar_push(surf_input_buffer_stack,&surf_input_buffer);
336   surf_input_buffer = surf_parse__create_buffer(surf_file_to_parse, YY_BUF_SIZE);
337   surf_parse_push_buffer_state(surf_input_buffer);
338
339   fflush(nullptr);
340 }
341
342 void ETag_surfxml_include() {
343 /* Nothing to do when done with reading the include tag.
344  * Instead, the handling should be deferred until the EOF of current buffer -- see below */
345 }
346
347 /** @brief When reaching EOF, check whether we are in an include tag, and behave accordingly if yes
348  *
349  * This function is called automatically by sedding the parser in tools/cmake/MaintainerMode.cmake
350  * Every FAIL on "Premature EOF" is preceded by a call to this function, which role is to restore the
351  * previous buffer if we reached the EOF /of an include file/. Its return code is used to avoid the
352  * error message in that case.
353  *
354  * Yeah, that's terribly hackish, but it works. A better solution should be dealed with in flexml
355  * directly: a command line flag could instruct it to do the correct thing when #include is encountered
356  * on a line. One day maybe, if the maya allow it.
357  */
358 int ETag_surfxml_include_state()
359 {
360   fflush(nullptr);
361   XBT_DEBUG("ETag_surfxml_include_state '%s'",A_surfxml_include_file);
362
363   if(xbt_dynar_is_empty(surf_input_buffer_stack)) // nope, that's a true premature EOF. Let the parser die verbosely.
364     return 0;
365
366   // Yeah, we were in an <include> Restore state and proceed.
367   fclose(surf_file_to_parse);
368   xbt_dynar_pop(surf_file_to_parse_stack, &surf_file_to_parse);
369   surf_parse_pop_buffer_state();
370   xbt_dynar_pop(surf_input_buffer_stack,&surf_input_buffer);
371
372   // Restore the filename for error messages
373   free(surf_parsed_filename);
374   xbt_dynar_pop(surf_parsed_filename_stack,&surf_parsed_filename);
375
376   return 1;
377 }
378
379 /* Stag and Etag parse functions */
380
381 void STag_surfxml_platform() {
382   XBT_ATTRIB_UNUSED double version = surf_parse_get_double(A_surfxml_platform_version);
383
384   xbt_assert((version >= 1.0), "******* BIG FAT WARNING *********\n "
385       "You're using an ancient XML file.\n"
386       "Since SimGrid 3.1, units are Bytes, Flops, and seconds "
387       "instead of MBytes, MFlops and seconds.\n"
388
389       "Use simgrid_update_xml to update your file automatically. "
390       "This program is installed automatically with SimGrid, or "
391       "available in the tools/ directory of the source archive.\n"
392
393       "Please check also out the SURF section of the ChangeLog for "
394       "the 3.1 version for more information. \n"
395
396       "Last, do not forget to also update your values for "
397       "the calls to MSG_task_create (if any).");
398   xbt_assert((version >= 3.0), "******* BIG FAT WARNING *********\n "
399       "You're using an old XML file.\n"
400       "Use simgrid_update_xml to update your file automatically. "
401       "This program is installed automatically with SimGrid, or "
402       "available in the tools/ directory of the source archive.");
403   xbt_assert((version >= 4.0), "******* FILE %s IS TOO OLD (v:%.1f) *********\n "
404       "Changes introduced in SimGrid 3.13:\n"
405       "  - 'power' attribute of hosts (and others) got renamed to 'speed'.\n"
406       "  - In <trace_connect>, attribute kind=\"POWER\" is now kind=\"SPEED\".\n"
407       "  - DOCTYPE now point to the rignt URL: http://simgrid.gforge.inria.fr/simgrid/simgrid.dtd\n"
408       "  - speed, bandwidth and latency attributes now MUST have an explicit unit (f, Bps, s by default)"
409       "\n\n"
410       "Use simgrid_update_xml to update your file automatically. "
411       "This program is installed automatically with SimGrid, or "
412       "available in the tools/ directory of the source archive.",surf_parsed_filename, version);
413
414   sg_platf_begin();
415 }
416 void ETag_surfxml_platform(){
417   sg_platf_end();
418 }
419
420 void STag_surfxml_host(){
421   AS_TAG = 0;
422   xbt_assert(current_property_set == nullptr, "Someone forgot to reset the property set to nullptr in its closing tag (or XML malformed)");
423 }
424
425 void STag_surfxml_prop()
426 {
427   if(AS_TAG){ // We need a stack here to retrieve the most recently opened AS
428     if (!as_current_property_set){
429       xbt_assert(as_prop_nb < 1024, "Number of AS property reach the limit!!!");
430       as_current_property_set = xbt_dict_new_homogeneous(xbt_free_f); // Maybe, it should raise an error
431       as_name_tab[as_prop_nb] = xbt_strdup(A_surfxml_AS_id);
432       as_dict_tab[as_prop_nb] = as_current_property_set;
433       XBT_DEBUG("PUSH prop set %p for AS '%s'",as_dict_tab[as_prop_nb],as_name_tab[as_prop_nb]);
434       as_prop_nb++;
435     }
436     XBT_DEBUG("add prop %s=%s into current AS property set", A_surfxml_prop_id, A_surfxml_prop_value);
437     xbt_dict_set(as_current_property_set, A_surfxml_prop_id, xbt_strdup(A_surfxml_prop_value), nullptr);
438   }
439   else{
440     if (!current_property_set)
441        current_property_set = xbt_dict_new(); // Maybe, it should raise an error
442     xbt_dict_set(current_property_set, A_surfxml_prop_id, xbt_strdup(A_surfxml_prop_value), xbt_free_f);
443     XBT_DEBUG("add prop %s=%s into current property set", A_surfxml_prop_id, A_surfxml_prop_value);
444   }
445 }
446
447 void ETag_surfxml_host()    {
448   s_sg_platf_host_cbarg_t host;
449   memset(&host,0,sizeof(host));
450   char* buf;
451
452
453   host.properties = current_property_set;
454
455   host.id = A_surfxml_host_id;
456
457   buf = A_surfxml_host_speed;
458   XBT_DEBUG("Buffer: %s", buf);
459   if (strchr(buf, ',') == nullptr){
460     double speed = surf_parse_get_speed(A_surfxml_host_speed,"speed of host", host.id);
461     host.speed_per_pstate.push_back(speed);
462   }
463   else {
464     xbt_dynar_t pstate_list = xbt_str_split(buf, ",");
465     unsigned int i;
466     char* speed_str;
467     xbt_dynar_foreach(pstate_list, i, speed_str) {
468       xbt_str_trim(speed_str, nullptr);
469       double speed = surf_parse_get_speed(speed_str,"speed of host", host.id);
470       host.speed_per_pstate.push_back(speed);
471       XBT_DEBUG("Speed value: %f", speed);
472     }
473     xbt_dynar_free(&pstate_list);
474   }
475
476   XBT_DEBUG("pstate: %s", A_surfxml_host_pstate);
477   host.core_amount = surf_parse_get_int(A_surfxml_host_core);
478   host.speed_trace = A_surfxml_host_availability___file[0] ? tmgr_trace_new_from_file(A_surfxml_host_availability___file) : nullptr;
479   host.state_trace = A_surfxml_host_state___file[0] ? tmgr_trace_new_from_file(A_surfxml_host_state___file) : nullptr;
480   host.pstate      = surf_parse_get_int(A_surfxml_host_pstate);
481   host.coord       = A_surfxml_host_coordinates;
482
483   sg_platf_new_host(&host);
484   current_property_set = nullptr;
485 }
486
487 void STag_surfxml_host___link(){
488   XBT_DEBUG("Create a Host_link for %s",A_surfxml_host___link_id);
489   s_sg_platf_host_link_cbarg_t host_link;
490   memset(&host_link,0,sizeof(host_link));
491
492   host_link.id        = A_surfxml_host___link_id;
493   host_link.link_up   = A_surfxml_host___link_up;
494   host_link.link_down = A_surfxml_host___link_down;
495   sg_platf_new_hostlink(&host_link);
496 }
497
498 void STag_surfxml_router(){
499   s_sg_platf_router_cbarg_t router;
500   memset(&router, 0, sizeof(router));
501
502   router.id    = A_surfxml_router_id;
503   router.coord = A_surfxml_router_coordinates;
504
505   sg_platf_new_router(&router);
506 }
507
508 void ETag_surfxml_cluster(){
509   s_sg_platf_cluster_cbarg_t cluster;
510   memset(&cluster,0,sizeof(cluster));
511   cluster.properties = as_current_property_set;
512
513   cluster.id          = A_surfxml_cluster_id;
514   cluster.prefix      = A_surfxml_cluster_prefix;
515   cluster.suffix      = A_surfxml_cluster_suffix;
516   cluster.radical     = A_surfxml_cluster_radical;
517   cluster.speed       = surf_parse_get_speed(A_surfxml_cluster_speed, "speed of cluster", cluster.id);
518   cluster.core_amount = surf_parse_get_int(A_surfxml_cluster_core);
519   cluster.bw          = surf_parse_get_bandwidth(A_surfxml_cluster_bw, "bw of cluster", cluster.id);
520   cluster.lat         = surf_parse_get_time(A_surfxml_cluster_lat, "lat of cluster", cluster.id);
521   if(strcmp(A_surfxml_cluster_bb___bw,""))
522     cluster.bb_bw = surf_parse_get_bandwidth(A_surfxml_cluster_bb___bw, "bb_bw of cluster", cluster.id);
523   if(strcmp(A_surfxml_cluster_bb___lat,""))
524     cluster.bb_lat = surf_parse_get_time(A_surfxml_cluster_bb___lat, "bb_lat of cluster", cluster.id);
525   if(strcmp(A_surfxml_cluster_limiter___link,""))
526     cluster.limiter_link = surf_parse_get_bandwidth(A_surfxml_cluster_limiter___link, "limiter_link of cluster", cluster.id);
527   if(strcmp(A_surfxml_cluster_loopback___bw,""))
528     cluster.loopback_bw = surf_parse_get_bandwidth(A_surfxml_cluster_loopback___bw, "loopback_bw of cluster", cluster.id);
529   if(strcmp(A_surfxml_cluster_loopback___lat,""))
530     cluster.loopback_lat = surf_parse_get_time(A_surfxml_cluster_loopback___lat, "loopback_lat of cluster", cluster.id);
531
532   switch(AX_surfxml_cluster_topology){
533   case A_surfxml_cluster_topology_FLAT:
534     cluster.topology= SURF_CLUSTER_FLAT ;
535     break;
536   case A_surfxml_cluster_topology_TORUS:
537     cluster.topology= SURF_CLUSTER_TORUS ;
538     break;
539   case A_surfxml_cluster_topology_FAT___TREE:
540     cluster.topology = SURF_CLUSTER_FAT_TREE;
541     break;
542   case A_surfxml_cluster_topology_DRAGONFLY:
543     cluster.topology= SURF_CLUSTER_DRAGONFLY ;
544     break;
545   default:
546     surf_parse_error("Invalid cluster topology for cluster %s",
547                      cluster.id);
548     break;
549   }
550   cluster.topo_parameters = A_surfxml_cluster_topo___parameters;
551   cluster.router_id = A_surfxml_cluster_router___id;
552
553   switch (AX_surfxml_cluster_sharing___policy) {
554   case A_surfxml_cluster_sharing___policy_SHARED:
555     cluster.sharing_policy = SURF_LINK_SHARED;
556     break;
557   case A_surfxml_cluster_sharing___policy_FULLDUPLEX:
558     cluster.sharing_policy = SURF_LINK_FULLDUPLEX;
559     break;
560   case A_surfxml_cluster_sharing___policy_FATPIPE:
561     cluster.sharing_policy = SURF_LINK_FATPIPE;
562     break;
563   default:
564     surf_parse_error("Invalid cluster sharing policy for cluster %s",
565                      cluster.id);
566     break;
567   }
568   switch (AX_surfxml_cluster_bb___sharing___policy) {
569   case A_surfxml_cluster_bb___sharing___policy_FATPIPE:
570     cluster.bb_sharing_policy = SURF_LINK_FATPIPE;
571     break;
572   case A_surfxml_cluster_bb___sharing___policy_SHARED:
573     cluster.bb_sharing_policy = SURF_LINK_SHARED;
574     break;
575   default:
576     surf_parse_error("Invalid bb sharing policy in cluster %s",
577                      cluster.id);
578     break;
579   }
580
581   sg_platf_new_cluster(&cluster);
582
583   current_property_set = nullptr;
584 }
585
586 void STag_surfxml_cluster(){
587   parse_after_config();
588   xbt_assert(current_property_set == nullptr, "Someone forgot to reset the property set to nullptr in its closing tag (or XML malformed)");
589 }
590
591 void STag_surfxml_cabinet(){
592   parse_after_config();
593   s_sg_platf_cabinet_cbarg_t cabinet;
594   memset(&cabinet,0,sizeof(cabinet));
595   cabinet.id      = A_surfxml_cabinet_id;
596   cabinet.prefix  = A_surfxml_cabinet_prefix;
597   cabinet.suffix  = A_surfxml_cabinet_suffix;
598   cabinet.speed   = surf_parse_get_speed(A_surfxml_cabinet_speed, "speed of cabinet", cabinet.id);
599   cabinet.bw      = surf_parse_get_bandwidth(A_surfxml_cabinet_bw, "bw of cabinet", cabinet.id);
600   cabinet.lat     = surf_parse_get_time(A_surfxml_cabinet_lat, "lat of cabinet", cabinet.id);
601   cabinet.radical = A_surfxml_cabinet_radical;
602
603   sg_platf_new_cabinet(&cabinet);
604 }
605
606 void STag_surfxml_peer(){
607   parse_after_config();
608   s_sg_platf_peer_cbarg_t peer;
609   memset(&peer,0,sizeof(peer));
610   peer.id                 = A_surfxml_peer_id;
611   peer.speed              = surf_parse_get_speed(A_surfxml_peer_speed, "speed of peer", peer.id);
612   peer.bw_in              = surf_parse_get_bandwidth(A_surfxml_peer_bw___in, "bw_in of peer", peer.id);
613   peer.bw_out             = surf_parse_get_bandwidth(A_surfxml_peer_bw___out, "bw_out of peer", peer.id);
614   peer.lat                = surf_parse_get_time(A_surfxml_peer_lat, "lat of peer", peer.id);
615   peer.coord              = A_surfxml_peer_coordinates;
616   peer.availability_trace = A_surfxml_peer_availability___file[0] ? tmgr_trace_new_from_file(A_surfxml_peer_availability___file) : nullptr;
617   peer.state_trace        = A_surfxml_peer_state___file[0] ? tmgr_trace_new_from_file(A_surfxml_peer_state___file) : nullptr;
618
619   sg_platf_new_peer(&peer);
620 }
621
622 void STag_surfxml_link(){
623   AS_TAG = 0;
624   xbt_assert(current_property_set == nullptr, "Someone forgot to reset the property set to nullptr in its closing tag (or XML malformed)");
625 }
626
627 void ETag_surfxml_link(){
628   s_sg_platf_link_cbarg_t link;
629   memset(&link,0,sizeof(link));
630
631   link.properties          = current_property_set;
632   link.id                  = A_surfxml_link_id;
633   link.bandwidth           = surf_parse_get_bandwidth(A_surfxml_link_bandwidth, "bandwidth of link", link.id);
634   link.bandwidth_trace     = A_surfxml_link_bandwidth___file[0] ? tmgr_trace_new_from_file(A_surfxml_link_bandwidth___file) : nullptr;
635   link.latency             = surf_parse_get_time(A_surfxml_link_latency, "latency of link", link.id);
636   link.latency_trace       = A_surfxml_link_latency___file[0] ? tmgr_trace_new_from_file(A_surfxml_link_latency___file) : nullptr;
637   link.state_trace         = A_surfxml_link_state___file[0] ? tmgr_trace_new_from_file(A_surfxml_link_state___file):nullptr;
638
639   switch (A_surfxml_link_sharing___policy) {
640   case A_surfxml_link_sharing___policy_SHARED:
641     link.policy = SURF_LINK_SHARED;
642     break;
643   case A_surfxml_link_sharing___policy_FATPIPE:
644      link.policy = SURF_LINK_FATPIPE;
645      break;
646   case A_surfxml_link_sharing___policy_FULLDUPLEX:
647      link.policy = SURF_LINK_FULLDUPLEX;
648      break;
649   default:
650     surf_parse_error("Invalid sharing policy in link %s", link.id);
651     break;
652   }
653
654   sg_platf_new_link(&link);
655
656   current_property_set = nullptr;
657 }
658
659 void STag_surfxml_link___ctn(){
660
661   char *link_id;
662   switch (A_surfxml_link___ctn_direction) {
663   case AU_surfxml_link___ctn_direction:
664   case A_surfxml_link___ctn_direction_NONE:
665     link_id = xbt_strdup(A_surfxml_link___ctn_id);
666     break;
667   case A_surfxml_link___ctn_direction_UP:
668     link_id = bprintf("%s_UP", A_surfxml_link___ctn_id);
669     break;
670   case A_surfxml_link___ctn_direction_DOWN:
671     link_id = bprintf("%s_DOWN", A_surfxml_link___ctn_id);
672     break;
673   }
674
675   // FIXME we should push the surf link object but it doesn't work because of model rulebased
676   // Rule-based routing doesnt' exist anymore, does it?
677   parsed_link_list.push_back(link_id);
678 }
679
680 void ETag_surfxml_backbone(){
681   s_sg_platf_link_cbarg_t link;
682   memset(&link,0,sizeof(link));
683
684   link.properties = nullptr;
685   link.id = A_surfxml_backbone_id;
686   link.bandwidth = surf_parse_get_bandwidth(A_surfxml_backbone_bandwidth, "bandwidth of backbone", link.id);
687   link.latency = surf_parse_get_time(A_surfxml_backbone_latency, "latency of backbone", link.id);
688   link.policy = SURF_LINK_SHARED;
689
690   sg_platf_new_link(&link);
691   routing_cluster_add_backbone(sg_link_by_name(A_surfxml_backbone_id));
692 }
693
694 void STag_surfxml_route(){
695   surf_parse_assert(sg_netcard_by_name_or_null(A_surfxml_route_src),
696       "Route src='%s' does name a node.", A_surfxml_route_src);
697   surf_parse_assert(sg_netcard_by_name_or_null(A_surfxml_route_dst),
698       "Route dst='%s' does name a node.", A_surfxml_route_dst);
699 }
700
701 void STag_surfxml_ASroute(){
702   surf_parse_assert(sg_netcard_by_name_or_null(A_surfxml_ASroute_src),
703       "ASroute src='%s' does name a node.", A_surfxml_route_src);
704   surf_parse_assert(sg_netcard_by_name_or_null(A_surfxml_ASroute_dst),
705       "ASroute dst='%s' does name a node.", A_surfxml_route_dst);
706
707   surf_parse_assert(sg_netcard_by_name_or_null(A_surfxml_ASroute_gw___src),
708       "ASroute gw_src='%s' does name a node.", A_surfxml_ASroute_gw___src);
709   surf_parse_assert(sg_netcard_by_name_or_null(A_surfxml_ASroute_gw___dst),
710       "ASroute gw_dst='%s' does name a node.", A_surfxml_ASroute_gw___dst);
711 }
712
713 void STag_surfxml_bypassRoute(){
714   surf_parse_assert(sg_netcard_by_name_or_null(A_surfxml_bypassRoute_src),
715       "bypassRoute src='%s' does name a node.", A_surfxml_bypassRoute_src);
716   surf_parse_assert(sg_netcard_by_name_or_null(A_surfxml_bypassRoute_dst),
717       "bypassRoute dst='%s' does name a node.", A_surfxml_bypassRoute_dst);
718 }
719
720 void STag_surfxml_bypassASroute(){
721   surf_parse_assert(sg_netcard_by_name_or_null(A_surfxml_bypassASroute_src),
722       "bypassASroute src='%s' does name a node.", A_surfxml_bypassASroute_src);
723   surf_parse_assert(sg_netcard_by_name_or_null(A_surfxml_bypassASroute_dst),
724       "bypassASroute dst='%s' does name a node.", A_surfxml_bypassASroute_dst);
725   surf_parse_assert(sg_netcard_by_name_or_null(A_surfxml_bypassASroute_gw___src),
726       "bypassASroute gw_src='%s' does name a node.", A_surfxml_bypassASroute_gw___src);
727   surf_parse_assert(sg_netcard_by_name_or_null(A_surfxml_bypassASroute_gw___dst),
728       "bypassASroute gw_dst='%s' does name a node.", A_surfxml_bypassASroute_gw___dst);
729 }
730
731 void ETag_surfxml_route(){
732   s_sg_platf_route_cbarg_t route;
733   memset(&route,0,sizeof(route));
734
735   route.src       = sg_netcard_by_name_or_null(A_surfxml_route_src); // tested to not be nullptr in start tag
736   route.dst       = sg_netcard_by_name_or_null(A_surfxml_route_dst); // tested to not be nullptr in start tag
737   route.gw_src    = nullptr;
738   route.gw_dst    = nullptr;
739   route.link_list = new std::vector<Link*>();
740   route.symmetrical = (A_surfxml_route_symmetrical == A_surfxml_route_symmetrical_YES);
741
742   for (auto link_name: parsed_link_list) {
743     simgrid::surf::Link *link = Link::byName(link_name);
744     route.link_list->push_back(link);
745   }
746   parsed_link_list.clear();
747
748   sg_platf_new_route(&route);
749   delete route.link_list;
750 }
751
752 void ETag_surfxml_ASroute(){
753   s_sg_platf_route_cbarg_t ASroute;
754   memset(&ASroute,0,sizeof(ASroute));
755
756   ASroute.src    = sg_netcard_by_name_or_null(A_surfxml_ASroute_src); // tested to not be nullptr in start tag
757   ASroute.dst    = sg_netcard_by_name_or_null(A_surfxml_ASroute_dst); // tested to not be nullptr in start tag
758
759   ASroute.gw_src = sg_netcard_by_name_or_null(A_surfxml_ASroute_gw___src); // tested to not be nullptr in start tag
760   ASroute.gw_dst = sg_netcard_by_name_or_null(A_surfxml_ASroute_gw___dst); // tested to not be nullptr in start tag
761
762   ASroute.link_list =  new std::vector<Link*>();
763
764   for (auto link_name: parsed_link_list) {
765     simgrid::surf::Link *link = Link::byName(link_name);
766     ASroute.link_list->push_back(link);
767   }
768   parsed_link_list.clear();
769
770   switch (A_surfxml_ASroute_symmetrical) {
771   case AU_surfxml_ASroute_symmetrical:
772   case A_surfxml_ASroute_symmetrical_YES:
773     ASroute.symmetrical = true;
774     break;
775   case A_surfxml_ASroute_symmetrical_NO:
776     ASroute.symmetrical = false;
777     break;
778   }
779
780   sg_platf_new_route(&ASroute);
781   delete ASroute.link_list;
782 }
783
784 void ETag_surfxml_bypassRoute(){
785   s_sg_platf_route_cbarg_t route;
786   memset(&route,0,sizeof(route));
787
788   route.src = sg_netcard_by_name_or_null(A_surfxml_bypassRoute_src); // tested to not be nullptr in start tag
789   route.dst = sg_netcard_by_name_or_null(A_surfxml_bypassRoute_dst); // tested to not be nullptr in start tag
790   route.gw_src = nullptr;
791   route.gw_dst = nullptr;
792   route.symmetrical = false;
793   route.link_list =  new std::vector<Link*>();
794
795   for (auto link_name: parsed_link_list) {
796     simgrid::surf::Link *link = Link::byName(link_name);
797     route.link_list->push_back(link);
798   }
799   parsed_link_list.clear();
800
801   sg_platf_new_bypassRoute(&route);
802 }
803
804 void ETag_surfxml_bypassASroute(){
805   s_sg_platf_route_cbarg_t ASroute;
806   memset(&ASroute,0,sizeof(ASroute));
807
808   ASroute.src         = sg_netcard_by_name_or_null(A_surfxml_bypassASroute_src);
809   ASroute.dst         = sg_netcard_by_name_or_null(A_surfxml_bypassASroute_dst);
810   ASroute.link_list   = new std::vector<Link*>();
811   for (auto link_name: parsed_link_list) {
812     simgrid::surf::Link *link = Link::byName(link_name);
813     ASroute.link_list->push_back(link);
814   }
815   parsed_link_list.clear();
816
817   ASroute.symmetrical = false;
818
819   ASroute.gw_src = sg_netcard_by_name_or_null(A_surfxml_bypassASroute_gw___src);
820   ASroute.gw_dst = sg_netcard_by_name_or_null(A_surfxml_bypassASroute_gw___dst);
821
822   sg_platf_new_bypassRoute(&ASroute);
823 }
824
825 void ETag_surfxml_trace(){
826   s_sg_platf_trace_cbarg_t trace;
827   memset(&trace,0,sizeof(trace));
828
829   trace.id = A_surfxml_trace_id;
830   trace.file = A_surfxml_trace_file;
831   trace.periodicity = surf_parse_get_double(A_surfxml_trace_periodicity);
832   trace.pc_data = surfxml_pcdata;
833
834   sg_platf_new_trace(&trace);
835 }
836
837 void STag_surfxml_trace___connect(){
838   parse_after_config();
839   s_sg_platf_trace_connect_cbarg_t trace_connect;
840   memset(&trace_connect,0,sizeof(trace_connect));
841
842   trace_connect.element = A_surfxml_trace___connect_element;
843   trace_connect.trace = A_surfxml_trace___connect_trace;
844
845   switch (A_surfxml_trace___connect_kind) {
846   case AU_surfxml_trace___connect_kind:
847   case A_surfxml_trace___connect_kind_SPEED:
848     trace_connect.kind =  SURF_TRACE_CONNECT_KIND_SPEED;
849     break;
850   case A_surfxml_trace___connect_kind_BANDWIDTH:
851     trace_connect.kind =  SURF_TRACE_CONNECT_KIND_BANDWIDTH;
852     break;
853   case A_surfxml_trace___connect_kind_HOST___AVAIL:
854     trace_connect.kind =  SURF_TRACE_CONNECT_KIND_HOST_AVAIL;
855     break;
856   case A_surfxml_trace___connect_kind_LATENCY:
857     trace_connect.kind =  SURF_TRACE_CONNECT_KIND_LATENCY;
858     break;
859   case A_surfxml_trace___connect_kind_LINK___AVAIL:
860     trace_connect.kind =  SURF_TRACE_CONNECT_KIND_LINK_AVAIL;
861     break;
862   }
863   sg_platf_trace_connect(&trace_connect);
864 }
865
866 void STag_surfxml_AS(){
867   parse_after_config();
868   AS_TAG                   = 1;
869   s_sg_platf_AS_cbarg_t AS = { A_surfxml_AS_id, (int)A_surfxml_AS_routing};
870
871   as_current_property_set = nullptr;
872
873   sg_platf_new_AS_begin(&AS);
874 }
875 void ETag_surfxml_AS(){
876   if(as_prop_nb){
877     char *name      = as_name_tab[as_prop_nb-1];
878     xbt_dict_t dict = (xbt_dict_t) as_dict_tab[as_prop_nb-1];
879     as_prop_nb--;
880     XBT_DEBUG("POP prop %p for AS '%s'",dict,name);
881     xbt_lib_set(as_router_lib, name, ROUTING_PROP_ASR_LEVEL, dict);
882     xbt_free(name);
883   }
884   sg_platf_new_AS_seal();
885 }
886
887 void STag_surfxml_config(){
888   AS_TAG = 0;
889   xbt_assert(current_property_set == nullptr, "Someone forgot to reset the property set to nullptr in its closing tag (or XML malformed)");
890   XBT_DEBUG("START configuration name = %s",A_surfxml_config_id);
891   if (_sg_cfg_init_status == 2) {
892     surf_parse_error("All <config> tags must be given before any platform elements (such as <AS>, <host>, <cluster>, <link>, etc).");
893   }
894 }
895 void ETag_surfxml_config(){
896   xbt_dict_cursor_t cursor = nullptr;
897   char *key;
898   char *elem;
899   char *cfg;
900   xbt_dict_foreach(current_property_set, cursor, key, elem) {
901     cfg = bprintf("%s:%s",key,elem);
902     if(xbt_cfg_is_default_value(key))
903       xbt_cfg_set_parse(cfg);
904     else
905       XBT_INFO("The custom configuration '%s' is already defined by user!",key);
906     free(cfg);
907   }
908   XBT_DEBUG("End configuration name = %s",A_surfxml_config_id);
909
910   xbt_dict_free(&current_property_set);
911   current_property_set = nullptr;
912 }
913
914 static int argc;
915 static char **argv;
916
917 void STag_surfxml_process(){
918   AS_TAG  = 0;
919   argc    = 1;
920   argv    = xbt_new(char *, 1);
921   argv[0] = xbt_strdup(A_surfxml_process_function);
922   xbt_assert(current_property_set == nullptr, "Someone forgot to reset the property set to nullptr in its closing tag (or XML malformed)");
923 }
924
925 void ETag_surfxml_process(){
926   s_sg_platf_process_cbarg_t process;
927   memset(&process,0,sizeof(process));
928
929   process.argc       = argc;
930   process.argv       = (const char **)argv;
931   process.properties = current_property_set;
932   process.host       = A_surfxml_process_host;
933   process.function   = A_surfxml_process_function;
934   process.start_time = surf_parse_get_double(A_surfxml_process_start___time);
935   process.kill_time  = surf_parse_get_double(A_surfxml_process_kill___time);
936
937   switch (A_surfxml_process_on___failure) {
938   case AU_surfxml_process_on___failure:
939   case A_surfxml_process_on___failure_DIE:
940     process.on_failure =  SURF_PROCESS_ON_FAILURE_DIE;
941     break;
942   case A_surfxml_process_on___failure_RESTART:
943     process.on_failure =  SURF_PROCESS_ON_FAILURE_RESTART;
944     break;
945   }
946
947   sg_platf_new_process(&process);
948
949   for (int i = 0; i != argc; ++i)
950     xbt_free(argv[i]);
951   xbt_free(argv);
952   argv = nullptr;
953
954   current_property_set = nullptr;
955 }
956
957 void STag_surfxml_argument(){
958   argc++;
959   argv = (char**)xbt_realloc(argv, (argc) * sizeof(char **));
960   argv[(argc) - 1] = xbt_strdup(A_surfxml_argument_value);
961 }
962
963 void STag_surfxml_model___prop(){
964   if (!current_model_property_set)
965     current_model_property_set = xbt_dict_new_homogeneous(xbt_free_f);
966
967   xbt_dict_set(current_model_property_set, A_surfxml_model___prop_id, xbt_strdup(A_surfxml_model___prop_value), nullptr);
968 }
969
970 /* nothing to do in those functions */
971 void ETag_surfxml_prop(){}
972 void STag_surfxml_random(){}
973 void ETag_surfxml_random(){}
974 void ETag_surfxml_trace___connect(){}
975 void STag_surfxml_trace(){parse_after_config();}
976 void ETag_surfxml_router(){}
977 void ETag_surfxml_host___link(){}
978 void ETag_surfxml_cabinet(){}
979 void ETag_surfxml_peer(){}
980 void STag_surfxml_backbone(){}
981 void ETag_surfxml_link___ctn(){}
982 void ETag_surfxml_argument(){}
983 void ETag_surfxml_model___prop(){}
984
985 /* Open and Close parse file */
986
987 void surf_parse_open(const char *file)
988 {
989   xbt_assert(file, "Cannot parse the nullptr file. Bypassing the parser is strongly deprecated nowadays.");
990
991   if (!surf_input_buffer_stack)
992     surf_input_buffer_stack = xbt_dynar_new(sizeof(YY_BUFFER_STATE), nullptr);
993   if (!surf_file_to_parse_stack)
994     surf_file_to_parse_stack = xbt_dynar_new(sizeof(FILE *), nullptr);
995
996   if (!surf_parsed_filename_stack)
997     surf_parsed_filename_stack = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
998
999   surf_parsed_filename = xbt_strdup(file);
1000   char *dir = xbt_dirname(file);
1001   xbt_dynar_push(surf_path, &dir);
1002
1003   surf_file_to_parse = surf_fopen(file, "r");
1004   xbt_assert((surf_file_to_parse), "Unable to open \"%s\"\n", file);
1005   surf_input_buffer = surf_parse__create_buffer(surf_file_to_parse, YY_BUF_SIZE);
1006   surf_parse__switch_to_buffer(surf_input_buffer);
1007   surf_parse_lineno = 1;
1008 }
1009
1010 void surf_parse_close()
1011 {
1012   xbt_dynar_free(&surf_input_buffer_stack);
1013   xbt_dynar_free(&surf_file_to_parse_stack);
1014   xbt_dynar_free(&surf_parsed_filename_stack);
1015   if (surf_parsed_filename) {
1016     char *dir = nullptr;
1017     xbt_dynar_pop(surf_path, &dir);
1018     free(dir);
1019   }
1020
1021   free(surf_parsed_filename);
1022   surf_parsed_filename = nullptr;
1023
1024   if (surf_file_to_parse) {
1025     surf_parse__delete_buffer(surf_input_buffer);
1026     fclose(surf_file_to_parse);
1027     surf_file_to_parse = nullptr; //Must be reset for Bypass
1028   }
1029 }
1030
1031 /* Call the lexer to parse the currently opened file. This pointer to function enables bypassing of the parser */
1032
1033 static int _surf_parse() {
1034   return surf_parse_lex();
1035 }
1036 int_f_void_t surf_parse = _surf_parse;
1037
1038
1039 /* Prop tag functions */
1040
1041 /**
1042  * With XML parser
1043  */
1044 xbt_dict_t get_as_router_properties(const char* name)
1045 {
1046   return (xbt_dict_t)xbt_lib_get_or_null(as_router_lib, name, ROUTING_PROP_ASR_LEVEL);
1047 }
1048