1 /* Copyright (c) 2006, 2007, 2008, 2009, 2010. The SimGrid Team.
2 * All rights reserved. */
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. */
11 #include "surf/surfxml_parse_private.h"
12 #include "surf/surf_private.h"
14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_parse, surf,
15 "Logging specific to the SURF parsing module");
17 #include "simgrid_dtd.c"
19 /* Initialize the parsing globals */
20 xbt_dict_t traces_set_list = NULL;
21 xbt_dict_t trace_connect_list_host_avail = NULL;
22 xbt_dict_t trace_connect_list_power = NULL;
23 xbt_dict_t trace_connect_list_link_avail = NULL;
24 xbt_dict_t trace_connect_list_bandwidth = NULL;
25 xbt_dict_t trace_connect_list_latency = NULL;
27 /* make sure these symbols are defined as strong ones in this file so that the linked can resolve them */
28 xbt_dynar_t STag_surfxml_platform_cb_list = NULL;
29 xbt_dynar_t ETag_surfxml_platform_cb_list = NULL;
30 xbt_dynar_t STag_surfxml_host_cb_list = NULL;
31 xbt_dynar_t ETag_surfxml_host_cb_list = NULL;
32 xbt_dynar_t STag_surfxml_router_cb_list = NULL;
33 xbt_dynar_t ETag_surfxml_router_cb_list = NULL;
34 xbt_dynar_t STag_surfxml_link_cb_list = NULL;
35 xbt_dynar_t ETag_surfxml_link_cb_list = NULL;
36 xbt_dynar_t STag_surfxml_route_cb_list = NULL;
37 xbt_dynar_t ETag_surfxml_route_cb_list = NULL;
38 xbt_dynar_t STag_surfxml_link_c_ctn_cb_list = NULL;
39 xbt_dynar_t ETag_surfxml_link_c_ctn_cb_list = NULL;
40 xbt_dynar_t STag_surfxml_process_cb_list = NULL;
41 xbt_dynar_t ETag_surfxml_process_cb_list = NULL;
42 xbt_dynar_t STag_surfxml_argument_cb_list = NULL;
43 xbt_dynar_t ETag_surfxml_argument_cb_list = NULL;
44 xbt_dynar_t STag_surfxml_prop_cb_list = NULL;
45 xbt_dynar_t ETag_surfxml_prop_cb_list = NULL;
46 xbt_dynar_t STag_surfxml_cluster_cb_list = NULL;
47 xbt_dynar_t ETag_surfxml_cluster_cb_list = NULL;
48 xbt_dynar_t STag_surfxml_trace_cb_list = NULL;
49 xbt_dynar_t ETag_surfxml_trace_cb_list = NULL;
50 xbt_dynar_t STag_surfxml_trace_c_connect_cb_list = NULL;
51 xbt_dynar_t ETag_surfxml_trace_c_connect_cb_list = NULL;
52 xbt_dynar_t STag_surfxml_random_cb_list = NULL;
53 xbt_dynar_t ETag_surfxml_random_cb_list = NULL;
54 xbt_dynar_t STag_surfxml_AS_cb_list = NULL;
55 xbt_dynar_t ETag_surfxml_AS_cb_list = NULL;
56 xbt_dynar_t STag_surfxml_ASroute_cb_list = NULL;
57 xbt_dynar_t ETag_surfxml_ASroute_cb_list = NULL;
58 xbt_dynar_t STag_surfxml_bypassRoute_cb_list = NULL;
59 xbt_dynar_t ETag_surfxml_bypassRoute_cb_list = NULL;
61 /* store the current property set for any tag */
62 xbt_dict_t current_property_set = NULL;
63 /* dictionary of random generator data */
64 xbt_dict_t random_data_list = NULL;
66 static XBT_INLINE void surfxml_call_cb_functions(xbt_dynar_t);
68 YY_BUFFER_STATE surf_input_buffer;
69 FILE *surf_file_to_parse = NULL;
71 static void surf_parse_error(char *msg);
73 static void parse_Stag_trace(void);
74 static void parse_Etag_trace(void);
75 static void parse_Stag_trace_c_connect(void);
77 static void init_randomness(void);
78 static void add_randomness(void);
80 void surf_parse_free_callbacks(void)
82 xbt_dynar_free(&STag_surfxml_platform_cb_list);
83 xbt_dynar_free(&ETag_surfxml_platform_cb_list);
84 xbt_dynar_free(&STag_surfxml_host_cb_list);
85 xbt_dynar_free(&ETag_surfxml_host_cb_list);
86 xbt_dynar_free(&STag_surfxml_router_cb_list);
87 xbt_dynar_free(&ETag_surfxml_router_cb_list);
88 xbt_dynar_free(&STag_surfxml_link_cb_list);
89 xbt_dynar_free(&ETag_surfxml_link_cb_list);
90 xbt_dynar_free(&STag_surfxml_route_cb_list);
91 xbt_dynar_free(&ETag_surfxml_route_cb_list);
92 xbt_dynar_free(&STag_surfxml_link_c_ctn_cb_list);
93 xbt_dynar_free(&ETag_surfxml_link_c_ctn_cb_list);
94 xbt_dynar_free(&STag_surfxml_process_cb_list);
95 xbt_dynar_free(&ETag_surfxml_process_cb_list);
96 xbt_dynar_free(&STag_surfxml_argument_cb_list);
97 xbt_dynar_free(&ETag_surfxml_argument_cb_list);
98 xbt_dynar_free(&STag_surfxml_prop_cb_list);
99 xbt_dynar_free(&ETag_surfxml_prop_cb_list);
100 xbt_dynar_free(&STag_surfxml_trace_cb_list);
101 xbt_dynar_free(&ETag_surfxml_trace_cb_list);
102 xbt_dynar_free(&STag_surfxml_trace_c_connect_cb_list);
103 xbt_dynar_free(&ETag_surfxml_trace_c_connect_cb_list);
104 xbt_dynar_free(&STag_surfxml_random_cb_list);
105 xbt_dynar_free(&ETag_surfxml_random_cb_list);
106 xbt_dynar_free(&STag_surfxml_AS_cb_list);
107 xbt_dynar_free(&ETag_surfxml_AS_cb_list);
108 xbt_dynar_free(&STag_surfxml_ASroute_cb_list);
109 xbt_dynar_free(&ETag_surfxml_ASroute_cb_list);
110 xbt_dynar_free(&STag_surfxml_bypassRoute_cb_list);
111 xbt_dynar_free(&ETag_surfxml_bypassRoute_cb_list);
112 xbt_dynar_free(&STag_surfxml_cluster_cb_list);
113 xbt_dynar_free(&ETag_surfxml_cluster_cb_list);
116 void surf_parse_reset_parser(void)
118 surf_parse_free_callbacks();
119 STag_surfxml_platform_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
120 ETag_surfxml_platform_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
121 STag_surfxml_host_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
122 ETag_surfxml_host_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
123 STag_surfxml_router_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
124 ETag_surfxml_router_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
125 STag_surfxml_link_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
126 ETag_surfxml_link_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
127 STag_surfxml_route_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
128 ETag_surfxml_route_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
129 STag_surfxml_link_c_ctn_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
130 ETag_surfxml_link_c_ctn_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
131 STag_surfxml_process_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
132 ETag_surfxml_process_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
133 STag_surfxml_argument_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
134 ETag_surfxml_argument_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
135 STag_surfxml_prop_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
136 ETag_surfxml_prop_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
137 STag_surfxml_trace_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
138 ETag_surfxml_trace_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
139 STag_surfxml_trace_c_connect_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
140 ETag_surfxml_trace_c_connect_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
141 STag_surfxml_random_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
142 ETag_surfxml_random_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
143 STag_surfxml_AS_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
144 ETag_surfxml_AS_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
145 STag_surfxml_ASroute_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
146 ETag_surfxml_ASroute_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
147 STag_surfxml_bypassRoute_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
148 ETag_surfxml_bypassRoute_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
149 STag_surfxml_cluster_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
150 ETag_surfxml_cluster_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
153 /* Stag and Etag parse functions */
155 void STag_surfxml_platform(void)
157 double version = 0.0;
159 sscanf(A_surfxml_platform_version, "%lg", &version);
161 xbt_assert0((version >= 1.0), "******* BIG FAT WARNING *********\n "
162 "You're using an ancient XML file. "
163 "Since SimGrid 3.1, units are Bytes, Flops, and seconds "
164 "instead of MBytes, MFlops and seconds. "
165 "A script (surfxml_update.pl) to help you convert your old "
167 "is available in the contrib/platform_generation directory "
168 "of the simgrid repository. Please check also out the "
169 "SURF section of the ChangeLog for the 3.1 version. "
170 "Last, do not forget to also update your values for "
171 "the calls to MSG_task_create (if any).");
172 xbt_assert0((version >= 2.0), "******* BIG FAT WARNING *********\n "
173 "You're using an old XML file. "
174 "A script (surfxml_update.pl) to help you convert your old "
176 "is available in the contrib/platform_generation directory "
177 "of the simgrid repository.");
179 surfxml_call_cb_functions(STag_surfxml_platform_cb_list);
183 #define parse_method(type,name) \
184 void type##Tag_surfxml_##name(void) \
185 { surfxml_call_cb_functions(type##Tag_surfxml_##name##_cb_list); }
187 parse_method(E,platform);
188 parse_method(S,host); parse_method(E,host);
189 parse_method(S,router); parse_method(E,router);
190 parse_method(S,link); parse_method(E,link);
191 parse_method(S,route); parse_method(E,route);
192 parse_method(S,link_c_ctn); parse_method(E,link_c_ctn);
193 parse_method(S,process); parse_method(E,process);
194 parse_method(S,argument); parse_method(E,argument);
195 parse_method(S,prop); parse_method(E,prop);
196 parse_method(S,trace); parse_method(E,trace);
197 parse_method(S,trace_c_connect); parse_method(E,trace_c_connect);
198 parse_method(S,random); parse_method(E,random);
199 parse_method(S,AS); parse_method(E,AS);
200 parse_method(S,ASroute); parse_method(E,ASroute);
201 parse_method(S,bypassRoute); parse_method(E,bypassRoute);
202 parse_method(S,cluster); parse_method(E,cluster);
204 /* Open and Close parse file */
206 void surf_parse_open(const char *file)
208 static int warned = 0; /* warn only once */
212 ("Bypassing the XML parser since surf_parse_open received a NULL pointer. If it is not what you want, go fix your code.");
217 surf_file_to_parse = surf_fopen(file, "r");
218 xbt_assert1((surf_file_to_parse), "Unable to open \"%s\"\n", file);
219 surf_input_buffer = surf_parse__create_buffer(surf_file_to_parse, 10);
220 surf_parse__switch_to_buffer(surf_input_buffer);
221 surf_parse_lineno = 1;
224 void surf_parse_close(void)
226 if (surf_file_to_parse) {
227 surf_parse__delete_buffer(surf_input_buffer);
228 fclose(surf_file_to_parse);
234 static int _surf_parse(void)
236 return surf_parse_lex();
239 int_f_void_t surf_parse = _surf_parse;
241 void surf_parse_error(char *msg)
243 fprintf(stderr, "Parse error on line %d: %s\n", surf_parse_lineno, msg);
247 void surf_parse_get_double(double *value, const char *string)
250 ret = sscanf(string, "%lg", value);
252 surf_parse_error(bprintf("%s is not a double", string));
255 void surf_parse_get_int(int *value, const char *string)
258 ret = sscanf(string, "%d", value);
260 surf_parse_error(bprintf("%s is not an integer", string));
263 /* Aux parse functions */
265 void surfxml_add_callback(xbt_dynar_t cb_list, void_f_void_t function)
267 xbt_dynar_push(cb_list, &function);
270 void surfxml_del_callback(xbt_dynar_t* p_cb_list, void_f_void_t function)
272 xbt_dynar_t new_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
275 xbt_dynar_foreach(*p_cb_list,it,func) {
276 if( func != function )
277 xbt_dynar_push(new_cb_list, &func);
279 xbt_dynar_free(p_cb_list);
280 *p_cb_list = new_cb_list;
283 static XBT_INLINE void surfxml_call_cb_functions(xbt_dynar_t cb_list)
285 unsigned int iterator;
287 xbt_dynar_foreach(cb_list, iterator, fun) {
292 /* Init and free parse data */
294 static void init_data(void)
296 random_data_list = xbt_dict_new();
297 traces_set_list = xbt_dict_new();
298 trace_connect_list_host_avail = xbt_dict_new();
299 trace_connect_list_power = xbt_dict_new();
300 trace_connect_list_link_avail = xbt_dict_new();
301 trace_connect_list_bandwidth = xbt_dict_new();
302 trace_connect_list_latency = xbt_dict_new();
304 surfxml_add_callback(STag_surfxml_random_cb_list, &init_randomness);
305 surfxml_add_callback(ETag_surfxml_random_cb_list, &add_randomness);
306 surfxml_add_callback(STag_surfxml_prop_cb_list, &parse_properties);
307 surfxml_add_callback(STag_surfxml_trace_cb_list, &parse_Stag_trace);
308 surfxml_add_callback(ETag_surfxml_trace_cb_list, &parse_Etag_trace);
309 surfxml_add_callback(STag_surfxml_trace_c_connect_cb_list, &parse_Stag_trace_c_connect);
312 static void free_data(void)
314 xbt_dict_free(&trace_connect_list_host_avail);
315 xbt_dict_free(&trace_connect_list_power);
316 xbt_dict_free(&trace_connect_list_link_avail);
317 xbt_dict_free(&trace_connect_list_bandwidth);
318 xbt_dict_free(&trace_connect_list_latency);
319 xbt_dict_free(&traces_set_list);
320 xbt_dict_free(&random_data_list);
323 /* Here start parse */
325 void parse_platform_file(const char *file)
328 surf_parse_open(file);
330 parse_status = surf_parse();
333 xbt_assert1(!parse_status, "Parse error in %s", file);
336 /* Prop tag functions */
338 void parse_properties(void)
341 if (!current_property_set)
342 current_property_set = xbt_dict_new(); // Maybe, it should be make a error
343 value = xbt_strdup(A_surfxml_prop_value);
344 xbt_dict_set(current_property_set, A_surfxml_prop_id, value, free);
347 /* Trace management functions */
349 static double trace_periodicity = -1.0;
350 static char *trace_file = NULL;
351 static char *trace_id;
353 static void parse_Stag_trace(void)
355 trace_id = strdup(A_surfxml_trace_id);
356 trace_file = strdup(A_surfxml_trace_file);
357 surf_parse_get_double(&trace_periodicity, A_surfxml_trace_periodicity);
360 static void parse_Etag_trace(void)
363 if (!trace_file || strcmp(trace_file, "") != 0) {
364 trace = tmgr_trace_new(trace_file);
366 if (strcmp(surfxml_pcdata, "") == 0)
370 tmgr_trace_new_from_string(trace_id, surfxml_pcdata,
373 xbt_dict_set(traces_set_list, trace_id, (void *) trace, NULL);
376 static void parse_Stag_trace_c_connect(void)
378 xbt_assert2(xbt_dict_get_or_null
379 (traces_set_list, A_surfxml_trace_c_connect_trace),
380 "Cannot connect trace %s to %s: trace unknown",
381 A_surfxml_trace_c_connect_trace,
382 A_surfxml_trace_c_connect_element);
384 switch (A_surfxml_trace_c_connect_kind) {
385 case A_surfxml_trace_c_connect_kind_HOST_AVAIL:
386 xbt_dict_set(trace_connect_list_host_avail,
387 A_surfxml_trace_c_connect_trace,
388 xbt_strdup(A_surfxml_trace_c_connect_element), free);
390 case A_surfxml_trace_c_connect_kind_POWER:
391 xbt_dict_set(trace_connect_list_power, A_surfxml_trace_c_connect_trace,
392 xbt_strdup(A_surfxml_trace_c_connect_element), free);
394 case A_surfxml_trace_c_connect_kind_LINK_AVAIL:
395 xbt_dict_set(trace_connect_list_link_avail,
396 A_surfxml_trace_c_connect_trace,
397 xbt_strdup(A_surfxml_trace_c_connect_element), free);
399 case A_surfxml_trace_c_connect_kind_BANDWIDTH:
400 xbt_dict_set(trace_connect_list_bandwidth,
401 A_surfxml_trace_c_connect_trace,
402 xbt_strdup(A_surfxml_trace_c_connect_element), free);
404 case A_surfxml_trace_c_connect_kind_LATENCY:
405 xbt_dict_set(trace_connect_list_latency, A_surfxml_trace_c_connect_trace,
406 xbt_strdup(A_surfxml_trace_c_connect_element), free);
409 xbt_die(bprintf("Cannot connect trace %s to %s: kind of trace unknown",
410 A_surfxml_trace_c_connect_trace,
411 A_surfxml_trace_c_connect_element));
415 /* Random tag functions */
417 double get_cpu_power(const char *power)
419 double power_scale = 0.0;
422 random_data_t random = NULL;
423 /* randomness is inserted like this: power="$rand(my_random)" */
424 if (((p = strstr(power, "$rand(")) != NULL)
425 && ((q = strstr(power, ")")) != NULL)) {
427 generator = xbt_malloc(q - (p + 6) + 1);
428 memcpy(generator, p + 6, q - (p + 6));
429 generator[q - (p + 6)] = '\0';
430 xbt_assert1((random =
431 xbt_dict_get_or_null(random_data_list, generator)),
432 "Random generator %s undefined", generator);
433 power_scale = random_generate(random);
436 surf_parse_get_double(&power_scale, power);
441 double random_min, random_max, random_mean, random_std_deviation, random_generator;
444 static void init_randomness(void)
446 random_id = A_surfxml_random_id;
447 surf_parse_get_double(&random_min, A_surfxml_random_min);
448 surf_parse_get_double(&random_max, A_surfxml_random_max);
449 surf_parse_get_double(&random_mean, A_surfxml_random_mean);
450 surf_parse_get_double(&random_std_deviation, A_surfxml_random_std_deviation);
451 random_generator = A_surfxml_random_generator;
454 static void add_randomness(void)
456 /* If needed aditional properties can be added by using the prop tag */
457 random_data_t random = random_new(random_generator, 0, random_min, random_max, random_mean, random_std_deviation);
458 xbt_dict_set(random_data_list, random_id, (void *) random, &xbt_free_ref); // FIX BY DAVID, add the xbt_free_ref function
462 * create CPU resource via CPU Model
464 void surf_host_create_resource(char *name, double power_peak,
466 tmgr_trace_t power_trace,
467 e_surf_resource_state_t state_initial,
468 tmgr_trace_t state_trace,
469 xbt_dict_t cpu_properties)
471 return surf_cpu_model->extension.cpu.
472 create_resource(name,power_peak,power_scale,power_trace,state_initial,state_trace,cpu_properties);
476 * create CPU resource via worsktation_ptask_L07 model
479 void surf_wsL07_host_create_resource(char *name, double power_peak,
481 tmgr_trace_t power_trace,
482 e_surf_resource_state_t state_initial,
483 tmgr_trace_t state_trace,
484 xbt_dict_t cpu_properties)
486 surf_workstation_model->extension.workstation.
487 cpu_create_resource(name,power_peak,power_scale,power_trace,state_initial,state_trace,cpu_properties);
490 * create link resource via network Model
492 void surf_link_create_resource(char *name,
494 tmgr_trace_t bw_trace,
496 tmgr_trace_t lat_trace,
497 e_surf_resource_state_t
499 tmgr_trace_t state_trace,
500 e_surf_link_sharing_policy_t policy,
501 xbt_dict_t properties)
503 return surf_network_model->extension.network.
504 create_resource(name,bw_initial,bw_trace,lat_initial,lat_trace,
505 state_initial,state_trace,policy,properties);
509 * create link resource via workstation_ptask_L07 model
512 void surf_wsL07_link_create_resource(char *name,
514 tmgr_trace_t bw_trace,
516 tmgr_trace_t lat_trace,
517 e_surf_resource_state_t
519 tmgr_trace_t state_trace,
520 e_surf_link_sharing_policy_t
521 policy, xbt_dict_t properties)
523 return surf_workstation_model->extension.workstation.
524 link_create_resource(name,bw_initial,bw_trace,lat_initial,lat_trace,
525 state_initial,state_trace,policy,properties);
529 * Route: add route element bypassing the parser :
530 * same job as parse_route_elem
533 void surf_add_route_element(char* link_ctn_id)
535 xbt_die("\"surf_add_route_element\" not support");
537 // val = xbt_strdup(link_ctn_id);
538 // xbt_dynar_push(route_link_list,&val);
543 void surf_route_set_resource(char *source_id,char *destination_id,xbt_dynar_t links_id,int action)
545 xbt_die("\"surf_route_set_resource\" not support");
546 //route_link_list = xbt_dynar_new(sizeof(char *), NULL); // COMMENTED BY DAVID
547 //routing_add_route(source_id,destination_id,links_id,action); // COMMENTED BY DAVID
552 * add host to routing host list
554 void surf_route_add_host(char *host_id)
556 xbt_die("\"surf_route_add_host\" not support");
557 //routing_add_host(host_id); // COMMENTED BY DAVID
563 void surf_add_host_traces(void)
565 return surf_cpu_model->extension.cpu.add_traces();
568 void surf_add_link_traces(void)
570 return surf_network_model->extension.network.add_traces();
573 void surf_wsL07_add_traces(void)
575 return surf_workstation_model->extension.workstation.add_traces();
581 void surf_set_routes(void)
583 xbt_die("\"surf_set_routes\" not support");
584 //routing_set_routes(); // COMMENTED BY DAVID