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 */
21 xbt_dict_t traces_set_list = NULL;
22 //xbt_dynar_t traces_connect_list = NULL;
23 xbt_dict_t trace_connect_list_host_avail = NULL;
24 xbt_dict_t trace_connect_list_power = NULL;
25 xbt_dict_t trace_connect_list_link_avail = NULL;
26 xbt_dict_t trace_connect_list_bandwidth = NULL;
27 xbt_dict_t trace_connect_list_latency = NULL;
29 /* This buffer is used to store the original buffer before substituing it by out own buffer. Use full for the foreach tag */
30 static xbt_dynar_t surfxml_bufferstack_stack = NULL;
31 int surfxml_bufferstack_size = 2048;
32 // static char *old_buff = NULL;
33 static void surf_parse_error(char *msg);
35 /* make sure these symbols are defined as strong ones in this file so that the linked can resolve them */
36 xbt_dynar_t STag_surfxml_platform_cb_list = NULL;
37 xbt_dynar_t ETag_surfxml_platform_cb_list = NULL;
38 xbt_dynar_t STag_surfxml_host_cb_list = NULL;
39 xbt_dynar_t ETag_surfxml_host_cb_list = NULL;
40 xbt_dynar_t STag_surfxml_router_cb_list = NULL;
41 xbt_dynar_t ETag_surfxml_router_cb_list = NULL;
42 xbt_dynar_t STag_surfxml_link_cb_list = NULL;
43 xbt_dynar_t ETag_surfxml_link_cb_list = NULL;
44 xbt_dynar_t STag_surfxml_route_cb_list = NULL;
45 xbt_dynar_t ETag_surfxml_route_cb_list = NULL;
46 xbt_dynar_t STag_surfxml_link_c_ctn_cb_list = NULL;
47 xbt_dynar_t ETag_surfxml_link_c_ctn_cb_list = NULL;
48 xbt_dynar_t STag_surfxml_process_cb_list = NULL;
49 xbt_dynar_t ETag_surfxml_process_cb_list = NULL;
50 xbt_dynar_t STag_surfxml_argument_cb_list = NULL;
51 xbt_dynar_t ETag_surfxml_argument_cb_list = NULL;
52 xbt_dynar_t STag_surfxml_prop_cb_list = NULL;
53 xbt_dynar_t ETag_surfxml_prop_cb_list = NULL;
54 xbt_dynar_t STag_surfxml_trace_cb_list = NULL;
55 xbt_dynar_t ETag_surfxml_trace_cb_list = NULL;
56 xbt_dynar_t STag_surfxml_trace_c_connect_cb_list = NULL;
57 xbt_dynar_t ETag_surfxml_trace_c_connect_cb_list = NULL;
58 xbt_dynar_t STag_surfxml_random_cb_list = NULL;
59 xbt_dynar_t ETag_surfxml_random_cb_list = NULL;
60 xbt_dynar_t STag_surfxml_AS_cb_list = NULL;
61 xbt_dynar_t ETag_surfxml_AS_cb_list = NULL;
62 xbt_dynar_t STag_surfxml_ASroute_cb_list = NULL;
63 xbt_dynar_t ETag_surfxml_ASroute_cb_list = NULL;
64 xbt_dynar_t STag_surfxml_bypassRoute_cb_list = NULL;
65 xbt_dynar_t ETag_surfxml_bypassRoute_cb_list = NULL;
67 xbt_dict_t current_property_set = NULL;
68 xbt_dict_t random_data_list = NULL; /* dictionary of random generator data */
70 static xbt_dynar_t surf_input_buffer_stack = NULL;
71 static xbt_dynar_t surf_file_to_parse_stack = NULL;
73 static XBT_INLINE void surfxml_call_cb_functions(xbt_dynar_t);
75 YY_BUFFER_STATE surf_input_buffer;
76 FILE *surf_file_to_parse = NULL;
78 static void parse_Stag_trace(void);
79 static void parse_Etag_trace(void);
80 static void parse_Stag_trace_c_connect(void);
81 static void init_randomness(void);
82 static void add_randomness(void);
84 void surf_parse_free_callbacks(void)
86 xbt_dynar_free(&STag_surfxml_platform_cb_list);
87 xbt_dynar_free(&ETag_surfxml_platform_cb_list);
88 xbt_dynar_free(&STag_surfxml_host_cb_list);
89 xbt_dynar_free(&ETag_surfxml_host_cb_list);
90 xbt_dynar_free(&STag_surfxml_router_cb_list);
91 xbt_dynar_free(&ETag_surfxml_router_cb_list);
92 xbt_dynar_free(&STag_surfxml_link_cb_list);
93 xbt_dynar_free(&ETag_surfxml_link_cb_list);
94 xbt_dynar_free(&STag_surfxml_route_cb_list);
95 xbt_dynar_free(&ETag_surfxml_route_cb_list);
96 xbt_dynar_free(&STag_surfxml_link_c_ctn_cb_list);
97 xbt_dynar_free(&ETag_surfxml_link_c_ctn_cb_list);
98 xbt_dynar_free(&STag_surfxml_process_cb_list);
99 xbt_dynar_free(&ETag_surfxml_process_cb_list);
100 xbt_dynar_free(&STag_surfxml_argument_cb_list);
101 xbt_dynar_free(&ETag_surfxml_argument_cb_list);
102 xbt_dynar_free(&STag_surfxml_prop_cb_list);
103 xbt_dynar_free(&ETag_surfxml_prop_cb_list);
104 xbt_dynar_free(&STag_surfxml_trace_cb_list);
105 xbt_dynar_free(&ETag_surfxml_trace_cb_list);
106 xbt_dynar_free(&STag_surfxml_trace_c_connect_cb_list);
107 xbt_dynar_free(&ETag_surfxml_trace_c_connect_cb_list);
108 xbt_dynar_free(&STag_surfxml_random_cb_list);
109 xbt_dynar_free(&ETag_surfxml_random_cb_list);
110 xbt_dynar_free(&STag_surfxml_AS_cb_list);
111 xbt_dynar_free(&ETag_surfxml_AS_cb_list);
112 xbt_dynar_free(&STag_surfxml_ASroute_cb_list);
113 xbt_dynar_free(&ETag_surfxml_ASroute_cb_list);
114 xbt_dynar_free(&STag_surfxml_bypassRoute_cb_list);
115 xbt_dynar_free(&ETag_surfxml_bypassRoute_cb_list);
118 void surf_parse_reset_parser(void)
120 surf_parse_free_callbacks();
121 STag_surfxml_platform_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
122 ETag_surfxml_platform_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
123 STag_surfxml_host_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
124 ETag_surfxml_host_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
125 STag_surfxml_router_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
126 ETag_surfxml_router_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
127 STag_surfxml_link_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
128 ETag_surfxml_link_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
129 STag_surfxml_route_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
130 ETag_surfxml_route_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
131 STag_surfxml_link_c_ctn_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
132 ETag_surfxml_link_c_ctn_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
133 STag_surfxml_process_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
134 ETag_surfxml_process_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
135 STag_surfxml_argument_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
136 ETag_surfxml_argument_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
137 STag_surfxml_prop_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
138 ETag_surfxml_prop_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
139 STag_surfxml_trace_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
140 ETag_surfxml_trace_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
141 STag_surfxml_trace_c_connect_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
142 ETag_surfxml_trace_c_connect_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
143 STag_surfxml_random_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
144 ETag_surfxml_random_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
145 STag_surfxml_AS_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
146 ETag_surfxml_AS_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
147 STag_surfxml_ASroute_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
148 ETag_surfxml_ASroute_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
149 STag_surfxml_bypassRoute_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
150 ETag_surfxml_bypassRoute_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
153 void STag_surfxml_include(void)
155 xbt_dynar_push(surf_input_buffer_stack, &surf_input_buffer);
156 xbt_dynar_push(surf_file_to_parse_stack, &surf_file_to_parse);
158 surf_file_to_parse = surf_fopen(A_surfxml_include_file, "r");
159 xbt_assert1((surf_file_to_parse), "Unable to open \"%s\"\n", A_surfxml_include_file);
160 surf_input_buffer = surf_parse__create_buffer(surf_file_to_parse, 10);
161 surf_parse__switch_to_buffer(surf_input_buffer);
166 void ETag_surfxml_include(void)
170 surf_parse__delete_buffer(surf_input_buffer);
171 fclose(surf_file_to_parse);
172 xbt_dynar_pop(surf_file_to_parse_stack, &surf_file_to_parse);
173 xbt_dynar_pop(surf_input_buffer_stack, &surf_input_buffer);
176 void STag_surfxml_platform(void)
178 double version = 0.0;
180 sscanf(A_surfxml_platform_version, "%lg", &version);
182 xbt_assert0((version >= 1.0), "******* BIG FAT WARNING *********\n "
183 "You're using an ancient XML file. "
184 "Since SimGrid 3.1, units are Bytes, Flops, and seconds "
185 "instead of MBytes, MFlops and seconds. "
186 "A script (surfxml_update.pl) to help you convert your old "
188 "is available in the contrib/platform_generation directory "
189 "of the simgrid repository. Please check also out the "
190 "SURF section of the ChangeLog for the 3.1 version. "
191 "Last, do not forget to also update your values for "
192 "the calls to MSG_task_create (if any).");
193 xbt_assert0((version >= 2.0), "******* BIG FAT WARNING *********\n "
194 "You're using an old XML file. "
195 "A script (surfxml_update.pl) to help you convert your old "
197 "is available in the contrib/platform_generation directory "
198 "of the simgrid repository.");
200 surfxml_call_cb_functions(STag_surfxml_platform_cb_list);
204 void ETag_surfxml_platform(void)
206 surfxml_call_cb_functions(ETag_surfxml_platform_cb_list);
207 xbt_dict_free(&random_data_list); // FIXME: DUPLICATE
210 #define parse_method(type,name) void type##Tag_surfxml_##name(void) { surfxml_call_cb_functions(type##Tag_surfxml_##name##_cb_list); }
212 parse_method(S,host); parse_method(E,host);
213 parse_method(S,router); parse_method(E,router);
214 parse_method(S,link); parse_method(E,link);
215 parse_method(S,route); parse_method(E,route);
216 parse_method(S,link_c_ctn); parse_method(E,link_c_ctn);
217 parse_method(S,process); parse_method(E,process);
218 parse_method(S,argument); parse_method(E,argument);
219 parse_method(S,prop); parse_method(E,prop);
220 parse_method(S,trace); parse_method(E,trace);
221 parse_method(S,trace_c_connect); parse_method(E,trace_c_connect);
222 parse_method(S,random); parse_method(E,random);
223 parse_method(S,AS); parse_method(E,AS);
224 parse_method(S,ASroute); parse_method(E,ASroute);
225 parse_method(S,bypassRoute); parse_method(E,bypassRoute);
227 /* Open and Close parse file */
229 void surf_parse_open(const char *file)
231 static int warned = 0; /* warn only once */
235 ("Bypassing the XML parser since surf_parse_open received a NULL pointer. If it is not what you want, go fix your code.");
240 surf_file_to_parse = surf_fopen(file, "r");
241 xbt_assert1((surf_file_to_parse), "Unable to open \"%s\"\n", file);
243 if (!surf_input_buffer_stack)
244 surf_input_buffer_stack = xbt_dynar_new(sizeof(YY_BUFFER_STATE), NULL);
245 if (!surf_file_to_parse_stack)
246 surf_file_to_parse_stack = xbt_dynar_new(sizeof(FILE *), NULL);
248 surf_input_buffer = surf_parse__create_buffer(surf_file_to_parse, 10);
249 surf_parse__switch_to_buffer(surf_input_buffer);
250 surf_parse_lineno = 1;
253 void surf_parse_close(void)
255 if (surf_input_buffer_stack)
256 xbt_dynar_free(&surf_input_buffer_stack);
257 if (surf_file_to_parse_stack)
258 xbt_dynar_free(&surf_file_to_parse_stack);
260 if (surf_file_to_parse) {
261 surf_parse__delete_buffer(surf_input_buffer);
262 fclose(surf_file_to_parse);
268 static int _surf_parse(void)
270 return surf_parse_lex();
273 int_f_void_t surf_parse = _surf_parse;
275 void surf_parse_error(char *msg)
277 fprintf(stderr, "Parse error on line %d: %s\n", surf_parse_lineno, msg);
281 void surf_parse_get_double(double *value, const char *string)
284 ret = sscanf(string, "%lg", value);
286 surf_parse_error(bprintf("%s is not a double", string));
289 void surf_parse_get_int(int *value, const char *string)
292 ret = sscanf(string, "%d", value);
294 surf_parse_error(bprintf("%s is not an integer", string));
297 /* Aux parse functions */
299 void surfxml_add_callback(xbt_dynar_t cb_list, void_f_void_t function)
301 xbt_dynar_push(cb_list, &function);
304 void surfxml_del_callback(xbt_dynar_t* p_cb_list, void_f_void_t function)
306 xbt_dynar_t new_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
309 xbt_dynar_foreach(*p_cb_list,it,func) {
310 if( func != function )
311 xbt_dynar_push(new_cb_list, &func);
313 xbt_dynar_free(p_cb_list);
314 *p_cb_list = new_cb_list;
317 static XBT_INLINE void surfxml_call_cb_functions(xbt_dynar_t cb_list)
319 unsigned int iterator;
321 xbt_dynar_foreach(cb_list, iterator, fun) {
326 /* Init and free parse data */
328 static void init_data(void)
330 if (!surfxml_bufferstack_stack)
331 surfxml_bufferstack_stack = xbt_dynar_new(sizeof(char *), NULL);
333 traces_set_list = xbt_dict_new();
335 trace_connect_list_host_avail = xbt_dict_new();
336 trace_connect_list_power = xbt_dict_new();
337 trace_connect_list_link_avail = xbt_dict_new();
338 trace_connect_list_bandwidth = xbt_dict_new();
339 trace_connect_list_latency = xbt_dict_new();
341 random_data_list = xbt_dict_new();
342 surfxml_add_callback(STag_surfxml_random_cb_list, &init_randomness);
343 surfxml_add_callback(ETag_surfxml_random_cb_list, &add_randomness);
344 surfxml_add_callback(STag_surfxml_prop_cb_list, &parse_properties);
345 surfxml_add_callback(STag_surfxml_trace_cb_list, &parse_Stag_trace);
346 surfxml_add_callback(ETag_surfxml_trace_cb_list, &parse_Etag_trace);
347 surfxml_add_callback(STag_surfxml_trace_c_connect_cb_list, &parse_Stag_trace_c_connect);
350 static void free_data(void)
352 xbt_dynar_free(&surfxml_bufferstack_stack);
354 xbt_dict_free(&traces_set_list);
355 xbt_dict_free(&trace_connect_list_host_avail);
356 xbt_dict_free(&trace_connect_list_power);
357 xbt_dict_free(&trace_connect_list_link_avail);
358 xbt_dict_free(&trace_connect_list_bandwidth);
359 xbt_dict_free(&trace_connect_list_latency);
360 xbt_dict_free(&traces_set_list);
363 /* Here start parse */
365 void parse_platform_file(const char *file)
368 surf_parse_open(file);
370 parse_status = surf_parse();
373 if (parse_status) xbt_dict_free(&random_data_list); // FIXME: DUPLICATE
374 xbt_assert1(!parse_status, "Parse error in %s", file);
377 /* Prop tag functions */
379 void parse_properties(void)
382 if (!current_property_set)
383 current_property_set = xbt_dict_new(); // Maybe, it should be make a error
384 value = xbt_strdup(A_surfxml_prop_value);
385 xbt_dict_set(current_property_set, A_surfxml_prop_id, value, free);
388 /* Trace management functions */
390 static double trace_periodicity = -1.0;
391 static char *trace_file = NULL;
392 static char *trace_id;
394 static void parse_Stag_trace(void)
396 trace_id = strdup(A_surfxml_trace_id);
397 trace_file = strdup(A_surfxml_trace_file);
398 surf_parse_get_double(&trace_periodicity, A_surfxml_trace_periodicity);
401 static void parse_Etag_trace(void)
404 if (!trace_file || strcmp(trace_file, "") != 0) {
405 trace = tmgr_trace_new(trace_file);
407 if (strcmp(surfxml_pcdata, "") == 0)
411 tmgr_trace_new_from_string(trace_id, surfxml_pcdata,
414 xbt_dict_set(traces_set_list, trace_id, (void *) trace, NULL);
417 static void parse_Stag_trace_c_connect(void)
419 xbt_assert2(xbt_dict_get_or_null
420 (traces_set_list, A_surfxml_trace_c_connect_trace),
421 "Cannot connect trace %s to %s: trace unknown",
422 A_surfxml_trace_c_connect_trace,
423 A_surfxml_trace_c_connect_element);
425 switch (A_surfxml_trace_c_connect_kind) {
426 case A_surfxml_trace_c_connect_kind_HOST_AVAIL:
427 xbt_dict_set(trace_connect_list_host_avail,
428 A_surfxml_trace_c_connect_trace,
429 xbt_strdup(A_surfxml_trace_c_connect_element), free);
431 case A_surfxml_trace_c_connect_kind_POWER:
432 xbt_dict_set(trace_connect_list_power, A_surfxml_trace_c_connect_trace,
433 xbt_strdup(A_surfxml_trace_c_connect_element), free);
435 case A_surfxml_trace_c_connect_kind_LINK_AVAIL:
436 xbt_dict_set(trace_connect_list_link_avail,
437 A_surfxml_trace_c_connect_trace,
438 xbt_strdup(A_surfxml_trace_c_connect_element), free);
440 case A_surfxml_trace_c_connect_kind_BANDWIDTH:
441 xbt_dict_set(trace_connect_list_bandwidth,
442 A_surfxml_trace_c_connect_trace,
443 xbt_strdup(A_surfxml_trace_c_connect_element), free);
445 case A_surfxml_trace_c_connect_kind_LATENCY:
446 xbt_dict_set(trace_connect_list_latency, A_surfxml_trace_c_connect_trace,
447 xbt_strdup(A_surfxml_trace_c_connect_element), free);
450 xbt_die(bprintf("Cannot connect trace %s to %s: kind of trace unknown",
451 A_surfxml_trace_c_connect_trace,
452 A_surfxml_trace_c_connect_element));
456 /* Random tag functions */
458 double get_cpu_power(const char *power)
460 double power_scale = 0.0;
463 random_data_t random = NULL;
464 /* randomness is inserted like this: power="$rand(my_random)" */
465 if (((p = strstr(power, "$rand(")) != NULL)
466 && ((q = strstr(power, ")")) != NULL)) {
468 generator = xbt_malloc(q - (p + 6) + 1);
469 memcpy(generator, p + 6, q - (p + 6));
470 generator[q - (p + 6)] = '\0';
471 xbt_assert1((random =
472 xbt_dict_get_or_null(random_data_list, generator)),
473 "Random generator %s undefined", generator);
474 power_scale = random_generate(random);
477 surf_parse_get_double(&power_scale, power);
482 double random_min, random_max, random_mean, random_std_deviation,
486 static void init_randomness(void)
488 random_id = A_surfxml_random_id;
489 surf_parse_get_double(&random_min, A_surfxml_random_min);
490 surf_parse_get_double(&random_max, A_surfxml_random_max);
491 surf_parse_get_double(&random_mean, A_surfxml_random_mean);
492 surf_parse_get_double(&random_std_deviation, A_surfxml_random_std_deviation);
493 random_generator = A_surfxml_random_generator;
496 static void add_randomness(void)
498 /* If needed aditional properties can be added by using the prop tag */
499 random_data_t random = random_new(random_generator, 0, random_min, random_max, random_mean, random_std_deviation);
500 xbt_dict_set(random_data_list, random_id, (void *) random, &xbt_free_ref); // FIX BY DAVID, add the xbt_free_ref function
504 * create CPU resource via CPU Model
506 void surf_host_create_resource(char *name, double power_peak,
508 tmgr_trace_t power_trace,
509 e_surf_resource_state_t state_initial,
510 tmgr_trace_t state_trace,
511 xbt_dict_t cpu_properties)
513 return surf_cpu_model->extension.cpu.
514 create_resource(name,power_peak,power_scale,power_trace,state_initial,state_trace,cpu_properties);
518 * create CPU resource via worsktation_ptask_L07 model
521 void surf_wsL07_host_create_resource(char *name, double power_peak,
523 tmgr_trace_t power_trace,
524 e_surf_resource_state_t state_initial,
525 tmgr_trace_t state_trace,
526 xbt_dict_t cpu_properties)
528 surf_workstation_model->extension.workstation.
529 cpu_create_resource(name,power_peak,power_scale,power_trace,state_initial,state_trace,cpu_properties);
532 * create link resource via network Model
534 void surf_link_create_resource(char *name,
536 tmgr_trace_t bw_trace,
538 tmgr_trace_t lat_trace,
539 e_surf_resource_state_t
541 tmgr_trace_t state_trace,
542 e_surf_link_sharing_policy_t policy,
543 xbt_dict_t properties)
545 return surf_network_model->extension.network.
546 create_resource(name,bw_initial,bw_trace,lat_initial,lat_trace,
547 state_initial,state_trace,policy,properties);
552 * create link resource via workstation_ptask_L07 model
555 void surf_wsL07_link_create_resource(char *name,
557 tmgr_trace_t bw_trace,
559 tmgr_trace_t lat_trace,
560 e_surf_resource_state_t
562 tmgr_trace_t state_trace,
563 e_surf_link_sharing_policy_t
564 policy, xbt_dict_t properties)
566 return surf_workstation_model->extension.workstation.
567 link_create_resource(name,bw_initial,bw_trace,lat_initial,lat_trace,
568 state_initial,state_trace,policy,properties);
574 void surf_add_host_traces(void)
576 return surf_cpu_model->extension.cpu.add_traces();
579 void surf_add_link_traces(void)
581 return surf_network_model->extension.network.add_traces();
584 void surf_wsL07_add_traces(void)
586 return surf_workstation_model->extension.workstation.add_traces();