Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Merge with master and fix conflicts
[simgrid.git] / src / surf / surfxml_parse.c
1 /* Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011. 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 <stdarg.h> /* va_arg */
8
9 #include "xbt/misc.h"
10 #include "xbt/log.h"
11 #include "xbt/str.h"
12 #include "xbt/dict.h"
13 #include "surf/surfxml_parse.h"
14 #include "surf/surf_private.h"
15 #include "simgrid/sg_config.h"
16
17 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_parse, surf,
18                                 "Logging specific to the SURF parsing module");
19 #undef CLEANUP
20 int ETag_surfxml_include_state(void);
21
22 #include "simgrid_dtd.c"
23
24 char* surf_parsed_filename = NULL; // to locate parse error messages
25
26 xbt_dynar_t parsed_link_list = NULL;   /* temporary store of current list link of a route */
27 extern AS_t current_routing;
28 /*
29  * Helping functions
30  */
31 void surf_parse_error(const char *fmt, ...) {
32   va_list va;
33   va_start(va,fmt);
34   char *msg = bvprintf(fmt,va);
35   va_end(va);
36   xbt_die("Parse error at %s:%d: %s", surf_parsed_filename, surf_parse_lineno, msg);
37 }
38 void surf_parse_warn(const char *fmt, ...) {
39   va_list va;
40   va_start(va,fmt);
41   char *msg = bvprintf(fmt,va);
42   va_end(va);
43     XBT_WARN("%s:%d: %s", surf_parsed_filename, surf_parse_lineno, msg);
44     free(msg);
45 }
46
47 double surf_parse_get_double(const char *string) {
48   double res;
49   int ret = sscanf(string, "%lg", &res);
50   if (ret != 1)
51     surf_parse_error("%s is not a double", string);
52   return res;
53 }
54
55 int surf_parse_get_int(const char *string) {
56   int res;
57   int ret = sscanf(string, "%d", &res);
58   if (ret != 1)
59     surf_parse_error("%s is not an integer", string);
60   return res;
61 }
62
63
64 /*
65  * All the callback lists that can be overridden anywhere.
66  * (this list should probably be reduced to the bare minimum to allow the models to work)
67  */
68
69 /* make sure these symbols are defined as strong ones in this file so that the linker can resolve them */
70
71 /* The default current property receiver. Setup in the corresponding opening callbacks. */
72 xbt_dict_t current_property_set = NULL;
73 xbt_dict_t as_current_property_set = NULL;
74 int AS_TAG = 0;
75 char* as_name_tab[1024];
76 void* as_dict_tab[1024];
77 int as_prop_nb = 0;
78
79
80 /* dictionary of random generator data */
81 xbt_dict_t random_data_list = NULL;
82
83 YY_BUFFER_STATE surf_input_buffer;
84 FILE *surf_file_to_parse = NULL;
85
86 static void init_randomness(void);
87 static void add_randomness(void);
88
89 /*
90  * Stuff relative to storage
91  */
92 void STag_surfxml_storage(void)
93 {
94   AS_TAG = 0;
95   XBT_DEBUG("STag_surfxml_storage");
96   xbt_assert(current_property_set == NULL, "Someone forgot to reset the property set to NULL in its closing tag (or XML malformed)");
97 }
98 void ETag_surfxml_storage(void)
99 {
100   s_sg_platf_storage_cbarg_t storage;
101   memset(&storage,0,sizeof(storage));
102
103   storage.id = A_surfxml_storage_id;
104   storage.type_id = A_surfxml_storage_typeId;
105   storage.content = A_surfxml_storage_content;
106   storage.properties = current_property_set;
107   sg_platf_new_storage(&storage);
108   current_property_set = NULL;
109 }
110 void STag_surfxml_storage___type(void)
111 {
112   AS_TAG = 0;
113   XBT_DEBUG("STag_surfxml_storage___type");
114   xbt_assert(current_property_set == NULL, "Someone forgot to reset the property set to NULL in its closing tag (or XML malformed)");
115 }
116 void ETag_surfxml_storage___type(void)
117 {
118   s_sg_platf_storage_type_cbarg_t storage_type;
119   memset(&storage_type,0,sizeof(storage_type));
120
121   storage_type.content = A_surfxml_storage___type_content;
122   storage_type.id = A_surfxml_storage___type_id;
123   storage_type.model = A_surfxml_storage___type_model;
124   storage_type.properties = current_property_set;
125   storage_type.size = surf_parse_get_int(A_surfxml_storage___type_size);
126   sg_platf_new_storage_type(&storage_type);
127   current_property_set = NULL;
128 }
129 void STag_surfxml_mstorage(void)
130 {
131   XBT_DEBUG("STag_surfxml_mstorage");
132 }
133 void ETag_surfxml_mstorage(void)
134 {
135   s_sg_platf_mstorage_cbarg_t mstorage;
136   memset(&mstorage,0,sizeof(mstorage));
137
138   mstorage.name = A_surfxml_mstorage_name;
139   mstorage.type_id = A_surfxml_mstorage_typeId;
140   sg_platf_new_mstorage(&mstorage);
141 }
142 void STag_surfxml_mount(void)
143 {
144   XBT_DEBUG("STag_surfxml_mount");
145 }
146 void ETag_surfxml_mount(void)
147 {
148   s_sg_platf_mount_cbarg_t mount;
149   memset(&mount,0,sizeof(mount));
150
151   mount.name = A_surfxml_mount_name;
152   mount.id = A_surfxml_mount_id;
153   sg_platf_new_mount(&mount);
154 }
155
156 /*
157  * Stuff relative to the <include> tag
158  */
159 static xbt_dynar_t surf_input_buffer_stack = NULL;
160 static xbt_dynar_t surf_file_to_parse_stack = NULL;
161 static xbt_dynar_t surf_parsed_filename_stack = NULL;
162
163 void STag_surfxml_include(void)
164 {
165   XBT_DEBUG("STag_surfxml_include '%s'",A_surfxml_include_file);
166   xbt_dynar_push(surf_parsed_filename_stack,&surf_parsed_filename); // save old file name
167   surf_parsed_filename = xbt_strdup(A_surfxml_include_file);
168
169   xbt_dynar_push(surf_file_to_parse_stack, &surf_file_to_parse); //save old file descriptor
170
171   surf_file_to_parse = surf_fopen(A_surfxml_include_file, "r"); // read new file descriptor
172   xbt_assert((surf_file_to_parse), "Unable to open \"%s\"\n",
173               A_surfxml_include_file);
174   xbt_dynar_push(surf_input_buffer_stack,&surf_input_buffer);
175   surf_input_buffer = surf_parse__create_buffer(surf_file_to_parse, YY_BUF_SIZE);
176   surf_parse_push_buffer_state(surf_input_buffer);
177
178   fflush(NULL);
179 }
180
181 void ETag_surfxml_include(void) {
182 /* Nothing to do when done with reading the include tag.
183  * Instead, the handling should be deferred until the EOF of current buffer -- see below */
184 }
185
186 /** @brief When reaching EOF, check whether we are in an include tag, and behave accordingly if yes
187  *
188  * This function is called automatically by sedding the parser in buildtools/Cmake/MaintainerMode.cmake
189  * Every FAIL on "Premature EOF" is preceded by a call to this function, which role is to restore the
190  * previous buffer if we reached the EOF /of an include file/. Its return code is used to avoid the
191  * error message in that case.
192  *
193  * Yeah, that's terribly hackish, but it works. A better solution should be dealed with in flexml
194  * directly: a command line flag could instruct it to do the correct thing when #include is encountered
195  * on a line. One day maybe, if the maya allow it.
196  */
197 int ETag_surfxml_include_state(void)
198 {
199   fflush(NULL);
200   XBT_DEBUG("ETag_surfxml_include_state '%s'",A_surfxml_include_file);
201
202   if(xbt_dynar_is_empty(surf_input_buffer_stack)) // nope, that's a true premature EOF. Let the parser die verbosely.
203     return 0;
204
205   // Yeah, we were in an <include> Restore state and proceed.
206   fclose(surf_file_to_parse);
207   xbt_dynar_pop(surf_file_to_parse_stack, &surf_file_to_parse);
208   surf_parse_pop_buffer_state();
209   xbt_dynar_pop(surf_input_buffer_stack,&surf_input_buffer);
210
211   // Restore the filename for error messages
212   free(surf_parsed_filename);
213   xbt_dynar_pop(surf_parsed_filename_stack,&surf_parsed_filename);
214
215   return 1;
216 }
217
218
219 void surf_parse_init_callbacks(void)
220 {
221     sg_platf_init();
222 }
223
224 void surf_parse_reset_callbacks(void)
225 {
226   surf_parse_free_callbacks();
227   surf_parse_init_callbacks();
228 }
229
230 void surf_parse_free_callbacks(void)
231 {
232   sg_platf_exit();
233 }
234
235 /* Stag and Etag parse functions */
236
237 void STag_surfxml_platform(void) {
238   _XBT_GNUC_UNUSED double version = surf_parse_get_double(A_surfxml_platform_version);
239
240   xbt_assert((version >= 1.0), "******* BIG FAT WARNING *********\n "
241       "You're using an ancient XML file.\n"
242       "Since SimGrid 3.1, units are Bytes, Flops, and seconds "
243       "instead of MBytes, MFlops and seconds.\n"
244
245       "Use simgrid_update_xml to update your file automatically. "
246       "This program is installed automatically with SimGrid, or "
247       "available in the tools/ directory of the source archive.\n"
248
249       "Please check also out the SURF section of the ChangeLog for "
250       "the 3.1 version for more information. \n"
251
252       "Last, do not forget to also update your values for "
253       "the calls to MSG_task_create (if any).");
254   xbt_assert((version >= 3.0), "******* BIG FAT WARNING *********\n "
255       "You're using an old XML file.\n"
256       "Use simgrid_update_xml to update your file automatically. "
257       "This program is installed automatically with SimGrid, or "
258       "available in the tools/ directory of the source archive.");
259
260   sg_platf_begin();
261 }
262 void ETag_surfxml_platform(void){
263   sg_platf_end();
264 }
265
266 void STag_surfxml_host(void){
267   AS_TAG = 0;
268   xbt_assert(current_property_set == NULL, "Someone forgot to reset the property set to NULL in its closing tag (or XML malformed)");
269 }
270
271 void STag_surfxml_prop(void)
272 {
273   if(AS_TAG){
274     if (!as_current_property_set){
275       xbt_assert(as_prop_nb < 1024, "Number of AS property reach the limit!!!");
276       as_current_property_set = xbt_dict_new_homogeneous(xbt_free_f); // Maybe, it should raise an error
277       as_name_tab[as_prop_nb] = xbt_strdup(A_surfxml_AS_id);
278       as_dict_tab[as_prop_nb] = as_current_property_set;
279       XBT_DEBUG("PUSH prop %p for AS '%s'",as_dict_tab[as_prop_nb],as_name_tab[as_prop_nb]);
280       as_prop_nb++;
281     }
282     xbt_dict_set(as_current_property_set, A_surfxml_prop_id, xbt_strdup(A_surfxml_prop_value), NULL);
283   }
284   else{
285     if (!current_property_set)
286       current_property_set = xbt_dict_new_homogeneous(xbt_free_f); // Maybe, it should raise an error
287     xbt_dict_set(current_property_set, A_surfxml_prop_id, xbt_strdup(A_surfxml_prop_value), NULL);
288   }
289 }
290
291 void ETag_surfxml_host(void)    {
292   s_sg_platf_host_cbarg_t host;
293   memset(&host,0,sizeof(host));
294
295   host.properties = current_property_set;
296
297   host.id = A_surfxml_host_id;
298   host.power_peak = get_cpu_power(A_surfxml_host_power);
299   host.power_scale = surf_parse_get_double( A_surfxml_host_availability);
300   host.core_amount = surf_parse_get_int(A_surfxml_host_core);
301   host.power_trace = tmgr_trace_new_from_file(A_surfxml_host_availability___file);
302   host.state_trace = tmgr_trace_new_from_file(A_surfxml_host_state___file);
303   xbt_assert((A_surfxml_host_state == A_surfxml_host_state_ON) ||
304         (A_surfxml_host_state == A_surfxml_host_state_OFF), "Invalid state");
305   if (A_surfxml_host_state == A_surfxml_host_state_ON)
306     host.initial_state = SURF_RESOURCE_ON;
307   if (A_surfxml_host_state == A_surfxml_host_state_OFF)
308     host.initial_state = SURF_RESOURCE_OFF;
309   host.coord = A_surfxml_host_coordinates;
310
311   sg_platf_new_host(&host);
312   current_property_set = NULL;
313 }
314
315 void STag_surfxml_host___link(void){
316   XBT_DEBUG("Create a Host_link for %s",A_surfxml_host___link_id);
317   s_sg_platf_host_link_cbarg_t host_link;
318   memset(&host_link,0,sizeof(host_link));
319
320   host_link.id = A_surfxml_host___link_id;
321   host_link.link_up = A_surfxml_host___link_up;
322   host_link.link_down = A_surfxml_host___link_down;
323   sg_platf_new_host_link(&host_link);
324 }
325
326 void STag_surfxml_router(void){
327   s_sg_platf_router_cbarg_t router;
328   memset(&router, 0, sizeof(router));
329
330   router.id = A_surfxml_router_id;
331   router.coord = A_surfxml_router_coordinates;
332
333   sg_platf_new_router(&router);
334 }
335
336 void STag_surfxml_cluster(void){
337   s_sg_platf_cluster_cbarg_t cluster;
338   memset(&cluster,0,sizeof(cluster));
339   cluster.id = A_surfxml_cluster_id;
340   cluster.prefix = A_surfxml_cluster_prefix;
341   cluster.suffix = A_surfxml_cluster_suffix;
342   cluster.radical = A_surfxml_cluster_radical;
343   cluster.power= surf_parse_get_double(A_surfxml_cluster_power);
344   cluster.core_amount = surf_parse_get_int(A_surfxml_cluster_core);
345   cluster.bw =   surf_parse_get_double(A_surfxml_cluster_bw);
346   cluster.lat =  surf_parse_get_double(A_surfxml_cluster_lat);
347   if(strcmp(A_surfxml_cluster_bb___bw,""))
348     cluster.bb_bw = surf_parse_get_double(A_surfxml_cluster_bb___bw);
349   if(strcmp(A_surfxml_cluster_bb___lat,""))
350     cluster.bb_lat = surf_parse_get_double(A_surfxml_cluster_bb___lat);
351   cluster.router_id = A_surfxml_cluster_router___id;
352
353   switch (AX_surfxml_cluster_sharing___policy) {
354   case A_surfxml_cluster_sharing___policy_SHARED:
355     cluster.sharing_policy = SURF_LINK_SHARED;
356     break;
357   case A_surfxml_cluster_sharing___policy_FULLDUPLEX:
358     cluster.sharing_policy = SURF_LINK_FULLDUPLEX;
359     break;
360   case A_surfxml_cluster_sharing___policy_FATPIPE:
361     cluster.sharing_policy = SURF_LINK_FATPIPE;
362     break;
363   default:
364     surf_parse_error("Invalid cluster sharing policy for cluster %s",
365                      cluster.id);
366     break;
367   }
368   switch (AX_surfxml_cluster_bb___sharing___policy) {
369   case A_surfxml_cluster_bb___sharing___policy_FATPIPE:
370     cluster.bb_sharing_policy = SURF_LINK_FATPIPE;
371     break;
372   case A_surfxml_cluster_bb___sharing___policy_SHARED:
373     cluster.bb_sharing_policy = SURF_LINK_SHARED;
374     break;
375   default:
376     surf_parse_error("Invalid bb sharing policy in cluster %s",
377                      cluster.id);
378     break;
379   }
380
381   cluster.availability_trace = A_surfxml_cluster_availability___file;
382   cluster.state_trace = A_surfxml_cluster_state___file;
383   sg_platf_new_cluster(&cluster);
384 }
385
386 void STag_surfxml_cabinet(void){
387   s_sg_platf_cabinet_cbarg_t cabinet;
388   memset(&cabinet,0,sizeof(cabinet));
389   cabinet.id = A_surfxml_cabinet_id;
390   cabinet.prefix = A_surfxml_cabinet_prefix;
391   cabinet.suffix = A_surfxml_cabinet_suffix;
392   cabinet.power = surf_parse_get_double(A_surfxml_cabinet_power);
393   cabinet.bw = surf_parse_get_double(A_surfxml_cabinet_bw);
394   cabinet.lat = surf_parse_get_double(A_surfxml_cabinet_lat);
395   cabinet.radical = A_surfxml_cabinet_radical;
396
397   sg_platf_new_cabinet(&cabinet);
398 }
399
400 void STag_surfxml_peer(void){
401   s_sg_platf_peer_cbarg_t peer;
402   memset(&peer,0,sizeof(peer));
403   peer.id = A_surfxml_peer_id;
404   peer.power = surf_parse_get_double(A_surfxml_peer_power);
405   peer.bw_in = surf_parse_get_double(A_surfxml_peer_bw___in);
406   peer.bw_out = surf_parse_get_double(A_surfxml_peer_bw___out);
407   peer.lat = surf_parse_get_double(A_surfxml_peer_lat);
408   peer.coord = A_surfxml_peer_coordinates;
409   peer.availability_trace = tmgr_trace_new_from_file(A_surfxml_peer_availability___file);
410   peer.state_trace = tmgr_trace_new_from_file(A_surfxml_peer_state___file);
411
412   sg_platf_new_peer(&peer);
413 }
414
415 void STag_surfxml_link(void){
416   AS_TAG = 0;
417   xbt_assert(current_property_set == NULL, "Someone forgot to reset the property set to NULL in its closing tag (or XML malformed)");
418 }
419
420 void ETag_surfxml_link(void){
421   s_sg_platf_link_cbarg_t link;
422   memset(&link,0,sizeof(link));
423
424   link.properties = current_property_set;
425
426   link.id = A_surfxml_link_id;
427   link.bandwidth = surf_parse_get_double(A_surfxml_link_bandwidth);
428   link.bandwidth_trace = tmgr_trace_new_from_file(A_surfxml_link_bandwidth___file);
429   link.latency = surf_parse_get_double(A_surfxml_link_latency);
430   link.latency_trace = tmgr_trace_new_from_file(A_surfxml_link_latency___file);
431
432   switch (A_surfxml_link_state) {
433   case A_surfxml_link_state_ON:
434     link.state = SURF_RESOURCE_ON;
435     break;
436   case A_surfxml_link_state_OFF:
437     link.state = SURF_RESOURCE_OFF;
438     break;
439   default:
440     surf_parse_error("invalid state for link %s", link.id);
441     break;
442   }
443   link.state_trace = tmgr_trace_new_from_file(A_surfxml_link_state___file);
444
445   switch (A_surfxml_link_sharing___policy) {
446   case A_surfxml_link_sharing___policy_SHARED:
447     link.policy = SURF_LINK_SHARED;
448     break;
449   case A_surfxml_link_sharing___policy_FATPIPE:
450      link.policy = SURF_LINK_FATPIPE;
451      break;
452   case A_surfxml_link_sharing___policy_FULLDUPLEX:
453      link.policy = SURF_LINK_FULLDUPLEX;
454      break;
455   default:
456     surf_parse_error("Invalid sharing policy in link %s", link.id);
457     break;
458   }
459
460   sg_platf_new_link(&link);
461
462   current_property_set = NULL;
463 }
464
465 void STag_surfxml_link___ctn(void){
466
467   char *link_id;
468   switch (A_surfxml_link___ctn_direction) {
469   case AU_surfxml_link___ctn_direction:
470   case A_surfxml_link___ctn_direction_NONE:
471     link_id = xbt_strdup(A_surfxml_link___ctn_id);
472     break;
473   case A_surfxml_link___ctn_direction_UP:
474     link_id = bprintf("%s_UP", A_surfxml_link___ctn_id);
475     break;
476   case A_surfxml_link___ctn_direction_DOWN:
477     link_id = bprintf("%s_DOWN", A_surfxml_link___ctn_id);
478     break;
479   }
480
481   // FIXME we should push the surf link object but it don't
482   // work because of model rulebased
483   xbt_dynar_push(parsed_link_list, &link_id);
484 }
485
486 void ETag_surfxml_backbone(void){
487   s_sg_platf_link_cbarg_t link;
488   memset(&link,0,sizeof(link));
489
490   link.properties = NULL;
491
492   link.id = A_surfxml_backbone_id;
493   link.bandwidth = surf_parse_get_double(A_surfxml_backbone_bandwidth);
494   link.latency = surf_parse_get_double(A_surfxml_backbone_latency);
495   link.state = SURF_RESOURCE_ON;
496   link.policy = SURF_LINK_SHARED;
497
498   sg_platf_new_link(&link);
499   routing_cluster_add_backbone(xbt_lib_get_or_null(link_lib, A_surfxml_backbone_id, SURF_LINK_LEVEL));
500 }
501
502 void STag_surfxml_route(void){
503   xbt_assert(strlen(A_surfxml_route_src) > 0 || strlen(A_surfxml_route_dst) > 0,
504       "Missing end-points while defining route \"%s\"->\"%s\"",
505       A_surfxml_route_src, A_surfxml_route_dst);
506   parsed_link_list = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
507 }
508
509 void STag_surfxml_ASroute(void){
510   xbt_assert(strlen(A_surfxml_ASroute_src) > 0
511              || strlen(A_surfxml_ASroute_dst) > 0
512              || strlen(A_surfxml_ASroute_gw___src) > 0
513              || strlen(A_surfxml_ASroute_gw___dst) > 0,
514              "Missing end-points while defining route \"%s\"->\"%s\" (with %s and %s as gateways)",
515              A_surfxml_ASroute_src, A_surfxml_ASroute_dst,
516              A_surfxml_ASroute_gw___src, A_surfxml_ASroute_gw___dst);
517   parsed_link_list = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
518 }
519
520 void STag_surfxml_bypassRoute(void){
521   xbt_assert(strlen(A_surfxml_bypassRoute_src) > 0
522              || strlen(A_surfxml_bypassRoute_dst) > 0,
523              "Missing end-points while defining bupass route \"%s\"->\"%s\"",
524              A_surfxml_bypassRoute_src, A_surfxml_bypassRoute_dst);
525   parsed_link_list = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
526 }
527
528 void STag_surfxml_bypassASroute(void){
529   xbt_assert(strlen(A_surfxml_bypassASroute_src) > 0
530              || strlen(A_surfxml_bypassASroute_dst) > 0
531              || strlen(A_surfxml_bypassASroute_gw___src) > 0
532              || strlen(A_surfxml_bypassASroute_gw___dst) > 0,
533              "Missing end-points while defining route \"%s\"->\"%s\" (with %s and %s as gateways)",
534              A_surfxml_bypassASroute_src, A_surfxml_bypassASroute_dst,
535              A_surfxml_bypassASroute_gw___src,A_surfxml_bypassASroute_gw___dst);
536   parsed_link_list = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
537 }
538
539 void ETag_surfxml_route(void){
540   s_sg_platf_route_cbarg_t route;
541   memset(&route,0,sizeof(route));
542
543   route.src = A_surfxml_route_src;
544   route.dst = A_surfxml_route_dst;
545   route.gw_src = NULL;
546   route.gw_dst = NULL;
547   route.link_list = parsed_link_list;
548
549   switch (A_surfxml_route_symmetrical) {
550   case AU_surfxml_route_symmetrical:
551   case A_surfxml_route_symmetrical_YES:
552     route.symmetrical = TRUE;
553     break;
554   case A_surfxml_route_symmetrical_NO:
555     route.symmetrical = FALSE;;
556     break;
557   }
558
559   sg_platf_new_route(&route);
560   parsed_link_list = NULL;
561 }
562
563 void ETag_surfxml_ASroute(void){
564   s_sg_platf_route_cbarg_t ASroute;
565   memset(&ASroute,0,sizeof(ASroute));
566
567   ASroute.src = A_surfxml_ASroute_src;
568   ASroute.dst = A_surfxml_ASroute_dst;
569
570   if (!strcmp(current_routing->model_desc->name,"RuleBased")) {
571     // DIRTY PERL HACK AHEAD: with the rulebased routing, the {src,dst}_gateway fields
572     // store the provided name instead of the entity directly (model_rulebased_parse_ASroute knows)
573     //
574     // This is because the user will provide something like "^AS_(.*)$" instead of the proper name of a given entity
575     ASroute.gw_src = (sg_routing_edge_t) A_surfxml_ASroute_gw___src;
576     ASroute.gw_dst = (sg_routing_edge_t) A_surfxml_ASroute_gw___dst;
577   } else {
578     ASroute.gw_src = sg_routing_edge_by_name_or_null(A_surfxml_ASroute_gw___src);
579     ASroute.gw_dst = sg_routing_edge_by_name_or_null(A_surfxml_ASroute_gw___dst);
580   }
581
582   ASroute.link_list = parsed_link_list;
583
584   switch (A_surfxml_ASroute_symmetrical) {
585   case AU_surfxml_ASroute_symmetrical:
586   case A_surfxml_ASroute_symmetrical_YES:
587     ASroute.symmetrical = TRUE;
588     break;
589   case A_surfxml_ASroute_symmetrical_NO:
590     ASroute.symmetrical = FALSE;
591     break;
592   }
593
594   sg_platf_new_ASroute(&ASroute);
595   parsed_link_list = NULL;
596 }
597
598 void ETag_surfxml_bypassRoute(void){
599   s_sg_platf_route_cbarg_t route;
600   memset(&route,0,sizeof(route));
601
602   route.src = A_surfxml_bypassRoute_src;
603   route.dst = A_surfxml_bypassRoute_dst;
604   route.gw_src = NULL;
605   route.gw_dst = NULL;
606   route.link_list = parsed_link_list;
607   route.symmetrical = FALSE;
608
609   sg_platf_new_bypassRoute(&route);
610   parsed_link_list = NULL;
611 }
612
613 void ETag_surfxml_bypassASroute(void){
614   s_sg_platf_route_cbarg_t ASroute;
615   memset(&ASroute,0,sizeof(ASroute));
616
617   ASroute.src = A_surfxml_bypassASroute_src;
618   ASroute.dst = A_surfxml_bypassASroute_dst;
619   ASroute.link_list = parsed_link_list;
620   ASroute.symmetrical = FALSE;
621
622   if (!strcmp(current_routing->model_desc->name,"RuleBased")) {
623     // DIRTY PERL HACK AHEAD: with the rulebased routing, the {src,dst}_gateway fields
624     // store the provided name instead of the entity directly (model_rulebased_parse_ASroute knows)
625     //
626     // This is because the user will provide something like "^AS_(.*)$" instead of the proper name of a given entity
627     ASroute.gw_src = (sg_routing_edge_t) A_surfxml_bypassASroute_gw___src;
628     ASroute.gw_dst = (sg_routing_edge_t) A_surfxml_bypassASroute_gw___dst;
629   } else {
630     ASroute.gw_src = sg_routing_edge_by_name_or_null(A_surfxml_bypassASroute_gw___src);
631     ASroute.gw_dst = sg_routing_edge_by_name_or_null(A_surfxml_bypassASroute_gw___dst);
632   }
633
634   sg_platf_new_bypassASroute(&ASroute);
635   parsed_link_list = NULL;
636 }
637
638 void ETag_surfxml_trace(void){
639   s_sg_platf_trace_cbarg_t trace;
640   memset(&trace,0,sizeof(trace));
641
642   trace.id = A_surfxml_trace_id;
643   trace.file = A_surfxml_trace_file;
644   trace.periodicity = surf_parse_get_double(A_surfxml_trace_periodicity);
645   trace.pc_data = surfxml_pcdata;
646
647   sg_platf_new_trace(&trace);
648 }
649
650 void STag_surfxml_trace___connect(void){
651   s_sg_platf_trace_connect_cbarg_t trace_connect;
652   memset(&trace_connect,0,sizeof(trace_connect));
653
654   trace_connect.element = A_surfxml_trace___connect_element;
655   trace_connect.trace = A_surfxml_trace___connect_trace;
656
657   switch (A_surfxml_trace___connect_kind) {
658   case AU_surfxml_trace___connect_kind:
659   case A_surfxml_trace___connect_kind_POWER:
660     trace_connect.kind =  SURF_TRACE_CONNECT_KIND_POWER;
661     break;
662   case A_surfxml_trace___connect_kind_BANDWIDTH:
663     trace_connect.kind =  SURF_TRACE_CONNECT_KIND_BANDWIDTH;
664     break;
665   case A_surfxml_trace___connect_kind_HOST___AVAIL:
666     trace_connect.kind =  SURF_TRACE_CONNECT_KIND_HOST_AVAIL;
667     break;
668   case A_surfxml_trace___connect_kind_LATENCY:
669     trace_connect.kind =  SURF_TRACE_CONNECT_KIND_LATENCY;
670     break;
671   case A_surfxml_trace___connect_kind_LINK___AVAIL:
672     trace_connect.kind =  SURF_TRACE_CONNECT_KIND_LINK_AVAIL;
673     break;
674   }
675   sg_platf_trace_connect(&trace_connect);
676 }
677
678 void STag_surfxml_AS(void){
679   AS_TAG = 1;
680   s_sg_platf_AS_cbarg_t AS = SG_PLATF_AS_INITIALIZER;
681   AS.id = A_surfxml_AS_id;
682   AS.routing = (int)A_surfxml_AS_routing;
683
684   as_current_property_set = NULL;
685
686   sg_platf_new_AS_begin(&AS);
687 }
688 void ETag_surfxml_AS(void){
689   if(as_prop_nb){
690     char *name = as_name_tab[as_prop_nb-1];
691     xbt_dict_t dict = as_dict_tab[as_prop_nb-1];
692     as_prop_nb--;
693     XBT_DEBUG("POP prop %p for AS '%s'",dict,name);
694     xbt_lib_set(as_router_lib,
695         name,
696       ROUTING_PROP_ASR_LEVEL,
697       dict);
698     xbt_free(name);
699   }
700   sg_platf_new_AS_end();
701 }
702
703 extern int _sg_init_status; /* FIXME: find a proper way to export this at some point */
704
705 void STag_surfxml_config(void){
706   AS_TAG = 0;
707   xbt_assert(current_property_set == NULL, "Someone forgot to reset the property set to NULL in its closing tag (or XML malformed)");
708   XBT_DEBUG("START configuration name = %s",A_surfxml_config_id);
709   if (_sg_init_status == 2) {
710     surf_parse_error("All <config> tags must be given before any platform elements (such as <AS>, <host>, <cluster>, <link>, etc).");
711   }
712 }
713 void ETag_surfxml_config(void){
714   xbt_dict_cursor_t cursor = NULL;
715   char *key;
716   char *elem;
717   char *cfg;
718   xbt_dict_foreach(current_property_set, cursor, key, elem) {
719     cfg = bprintf("%s:%s",key,elem);
720     if(xbt_cfg_is_default_value(_sg_cfg_set, key))
721       xbt_cfg_set_parse(_sg_cfg_set, cfg);
722     else
723       XBT_INFO("The custom configuration '%s' is already defined by user!",key);
724     free(cfg);
725   }
726   XBT_DEBUG("End configuration name = %s",A_surfxml_config_id);
727   xbt_dict_free(&current_property_set);
728   current_property_set = NULL;
729 }
730
731 static int argc;
732 static char **argv;
733
734 void STag_surfxml_process(void){
735   AS_TAG = 0;
736   argc = 1;
737   argv = xbt_new(char *, 1);
738   argv[0] = xbt_strdup(A_surfxml_process_function);
739   xbt_assert(current_property_set == NULL, "Someone forgot to reset the property set to NULL in its closing tag (or XML malformed)");
740 }
741
742 void ETag_surfxml_process(void){
743   s_sg_platf_process_cbarg_t process;
744   memset(&process,0,sizeof(process));
745
746   process.argc = argc;
747   process.argv = (const char **)argv;
748   process.properties = current_property_set;
749   process.host = A_surfxml_process_host;
750   process.function = A_surfxml_process_function;
751   process.start_time = surf_parse_get_double(A_surfxml_process_start___time);
752   process.kill_time = surf_parse_get_double(A_surfxml_process_kill___time);
753
754   switch (A_surfxml_process_on___failure) {
755   case AU_surfxml_process_on___failure:
756   case A_surfxml_process_on___failure_DIE:
757     process.on_failure =  SURF_PROCESS_ON_FAILURE_DIE;
758     break;
759   case A_surfxml_process_on___failure_RESTART:
760     process.on_failure =  SURF_PROCESS_ON_FAILURE_RESTART;
761     break;
762   }
763
764   sg_platf_new_process(&process);
765   current_property_set = NULL;
766 }
767
768 void STag_surfxml_argument(void){
769   argc++;
770   argv = xbt_realloc(argv, (argc) * sizeof(char *));
771   argv[(argc) - 1] = xbt_strdup(A_surfxml_argument_value);
772 }
773
774 /* ***************************************** */
775 /* TUTORIAL: New TAG                         */
776 void STag_surfxml_gpu(void)
777 {
778   XBT_DEBUG("STag_surfxml_gpu");
779 }
780 void ETag_surfxml_gpu(void)
781 {
782   s_sg_platf_gpu_cbarg_t gpu;
783   memset(&gpu,0,sizeof(gpu));
784
785   gpu.name = A_surfxml_gpu_name;
786
787   sg_platf_new_gpu(&gpu);
788 }
789 /* ***************************************** */
790
791 /* nothing to do in those functions */
792 void ETag_surfxml_prop(void){}
793 void STag_surfxml_random(void){}
794 void ETag_surfxml_random(void){}
795 void ETag_surfxml_trace___connect(void){}
796 void STag_surfxml_trace(void){}
797 void ETag_surfxml_router(void){}
798 void ETag_surfxml_host___link(void){}
799 void ETag_surfxml_cluster(void){}
800 void ETag_surfxml_cabinet(void){}
801 void ETag_surfxml_peer(void){}
802 void STag_surfxml_backbone(void){}
803 void ETag_surfxml_link___ctn(void){}
804 void ETag_surfxml_argument(void){}
805
806 /* Open and Close parse file */
807
808 void surf_parse_open(const char *file)
809 {
810   static int warned = 0;        /* warn only once */
811   if (!file) {
812     if (!warned) {
813       XBT_WARN
814           ("Bypassing the XML parser since surf_parse_open received a NULL pointer. "
815               "If it is not what you want, go fix your code.");
816       warned = 1;
817     }
818     return;
819   }
820
821   if (!surf_input_buffer_stack)
822     surf_input_buffer_stack = xbt_dynar_new(sizeof(YY_BUFFER_STATE), NULL);
823   if (!surf_file_to_parse_stack)
824     surf_file_to_parse_stack = xbt_dynar_new(sizeof(FILE *), NULL);
825
826   if (!surf_parsed_filename_stack)
827     surf_parsed_filename_stack = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
828   surf_parsed_filename = xbt_strdup(file);
829
830   surf_file_to_parse = surf_fopen(file, "r");
831   xbt_assert((surf_file_to_parse), "Unable to open \"%s\"\n", file);
832   surf_input_buffer = surf_parse__create_buffer(surf_file_to_parse, YY_BUF_SIZE);
833   surf_parse__switch_to_buffer(surf_input_buffer);
834   surf_parse_lineno = 1;
835 }
836
837 void surf_parse_close(void)
838 {
839   xbt_dynar_free(&surf_input_buffer_stack);
840   xbt_dynar_free(&surf_file_to_parse_stack);
841   xbt_dynar_free(&surf_parsed_filename_stack);
842
843   free(surf_parsed_filename);
844   surf_parsed_filename = NULL;
845
846   if (surf_file_to_parse) {
847     surf_parse__delete_buffer(surf_input_buffer);
848     fclose(surf_file_to_parse);
849     surf_file_to_parse = NULL; //Must be reset for Bypass
850   }
851 }
852
853 /* Call the lexer to parse the currently opened file. This pointer to function enables bypassing of the parser */
854
855 static int _surf_parse(void) {
856   return surf_parse_lex();
857 }
858 int_f_void_t surf_parse = _surf_parse;
859
860
861 /* Prop tag functions */
862
863 /**
864  * With XML parser
865  */
866
867 /* Random tag functions */
868
869 double get_cpu_power(const char *power)
870 {
871   double power_scale = 0.0;
872   const char *p, *q;
873   char *generator;
874   random_data_t random = NULL;
875   /* randomness is inserted like this: power="$rand(my_random)" */
876   if (((p = strstr(power, "$rand(")) != NULL)
877       && ((q = strstr(power, ")")) != NULL)) {
878     if (p < q) {
879       generator = xbt_malloc(q - (p + 6) + 1);
880       memcpy(generator, p + 6, q - (p + 6));
881       generator[q - (p + 6)] = '\0';
882       random = xbt_dict_get_or_null(random_data_list, generator);
883       xbt_assert(random, "Random generator %s undefined", generator);
884       power_scale = random_generate(random);
885     }
886   } else {
887     power_scale = surf_parse_get_double(power);
888   }
889   return power_scale;
890 }
891
892 double random_min, random_max, random_mean, random_std_deviation;
893 e_random_generator_t random_generator;
894 char *random_id;
895
896 static void init_randomness(void)
897 {
898   random_id = A_surfxml_random_id;
899   random_min = surf_parse_get_double(A_surfxml_random_min);
900   random_max = surf_parse_get_double(A_surfxml_random_max);
901   random_mean = surf_parse_get_double(A_surfxml_random_mean);
902   random_std_deviation = surf_parse_get_double(A_surfxml_random_std___deviation);
903   switch (A_surfxml_random_generator) {
904   case AU_surfxml_random_generator:
905   case A_surfxml_random_generator_NONE:
906     random_generator = NONE;
907     break;
908   case A_surfxml_random_generator_DRAND48:
909     random_generator = DRAND48;
910     break;
911   case A_surfxml_random_generator_RAND:
912     random_generator = RAND;
913     break;
914   case A_surfxml_random_generator_RNGSTREAM:
915     random_generator = RNGSTREAM;
916     break;
917   default:
918     surf_parse_error("Invalid random generator");
919     break;
920   }
921 }
922
923 static void add_randomness(void)
924 {
925   /* If needed aditional properties can be added by using the prop tag */
926   random_data_t random =
927       random_new(random_generator, 0, random_min, random_max, random_mean,
928                  random_std_deviation);
929   xbt_dict_set(random_data_list, random_id, (void *) random,
930                &xbt_free_ref);
931 }
932
933
934 xbt_dict_t get_as_router_properties(const char* name)
935 {
936   return xbt_lib_get_or_null(as_router_lib, name, ROUTING_PROP_ASR_LEVEL);
937 }
938