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_trace_cb_list = NULL;
47 xbt_dynar_t ETag_surfxml_trace_cb_list = NULL;
48 xbt_dynar_t STag_surfxml_trace_c_connect_cb_list = NULL;
49 xbt_dynar_t ETag_surfxml_trace_c_connect_cb_list = NULL;
50 xbt_dynar_t STag_surfxml_random_cb_list = NULL;
51 xbt_dynar_t ETag_surfxml_random_cb_list = NULL;
52 xbt_dynar_t STag_surfxml_AS_cb_list = NULL;
53 xbt_dynar_t ETag_surfxml_AS_cb_list = NULL;
54 xbt_dynar_t STag_surfxml_ASroute_cb_list = NULL;
55 xbt_dynar_t ETag_surfxml_ASroute_cb_list = NULL;
56 xbt_dynar_t STag_surfxml_bypassRoute_cb_list = NULL;
57 xbt_dynar_t ETag_surfxml_bypassRoute_cb_list = NULL;
59 /* store the current property set for any tag */
60 xbt_dict_t current_property_set = NULL;
61 /* dictionary of random generator data */
62 xbt_dict_t random_data_list = NULL;
64 static XBT_INLINE void surfxml_call_cb_functions(xbt_dynar_t);
66 YY_BUFFER_STATE surf_input_buffer;
67 FILE *surf_file_to_parse = NULL;
69 static void surf_parse_error(char *msg);
71 static void parse_Stag_trace(void);
72 static void parse_Etag_trace(void);
73 static void parse_Stag_trace_c_connect(void);
75 static void init_randomness(void);
76 static void add_randomness(void);
78 void surf_parse_free_callbacks(void)
80 xbt_dynar_free(&STag_surfxml_platform_cb_list);
81 xbt_dynar_free(&ETag_surfxml_platform_cb_list);
82 xbt_dynar_free(&STag_surfxml_host_cb_list);
83 xbt_dynar_free(&ETag_surfxml_host_cb_list);
84 xbt_dynar_free(&STag_surfxml_router_cb_list);
85 xbt_dynar_free(&ETag_surfxml_router_cb_list);
86 xbt_dynar_free(&STag_surfxml_link_cb_list);
87 xbt_dynar_free(&ETag_surfxml_link_cb_list);
88 xbt_dynar_free(&STag_surfxml_route_cb_list);
89 xbt_dynar_free(&ETag_surfxml_route_cb_list);
90 xbt_dynar_free(&STag_surfxml_link_c_ctn_cb_list);
91 xbt_dynar_free(&ETag_surfxml_link_c_ctn_cb_list);
92 xbt_dynar_free(&STag_surfxml_process_cb_list);
93 xbt_dynar_free(&ETag_surfxml_process_cb_list);
94 xbt_dynar_free(&STag_surfxml_argument_cb_list);
95 xbt_dynar_free(&ETag_surfxml_argument_cb_list);
96 xbt_dynar_free(&STag_surfxml_prop_cb_list);
97 xbt_dynar_free(&ETag_surfxml_prop_cb_list);
98 xbt_dynar_free(&STag_surfxml_trace_cb_list);
99 xbt_dynar_free(&ETag_surfxml_trace_cb_list);
100 xbt_dynar_free(&STag_surfxml_trace_c_connect_cb_list);
101 xbt_dynar_free(&ETag_surfxml_trace_c_connect_cb_list);
102 xbt_dynar_free(&STag_surfxml_random_cb_list);
103 xbt_dynar_free(&ETag_surfxml_random_cb_list);
104 xbt_dynar_free(&STag_surfxml_AS_cb_list);
105 xbt_dynar_free(&ETag_surfxml_AS_cb_list);
106 xbt_dynar_free(&STag_surfxml_ASroute_cb_list);
107 xbt_dynar_free(&ETag_surfxml_ASroute_cb_list);
108 xbt_dynar_free(&STag_surfxml_bypassRoute_cb_list);
109 xbt_dynar_free(&ETag_surfxml_bypassRoute_cb_list);
112 void surf_parse_reset_parser(void)
114 surf_parse_free_callbacks();
115 STag_surfxml_platform_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
116 ETag_surfxml_platform_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
117 STag_surfxml_host_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
118 ETag_surfxml_host_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
119 STag_surfxml_router_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
120 ETag_surfxml_router_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
121 STag_surfxml_link_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
122 ETag_surfxml_link_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
123 STag_surfxml_route_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
124 ETag_surfxml_route_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
125 STag_surfxml_link_c_ctn_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
126 ETag_surfxml_link_c_ctn_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
127 STag_surfxml_process_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
128 ETag_surfxml_process_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
129 STag_surfxml_argument_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
130 ETag_surfxml_argument_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
131 STag_surfxml_prop_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
132 ETag_surfxml_prop_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
133 STag_surfxml_trace_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
134 ETag_surfxml_trace_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
135 STag_surfxml_trace_c_connect_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
136 ETag_surfxml_trace_c_connect_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
137 STag_surfxml_random_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
138 ETag_surfxml_random_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
139 STag_surfxml_AS_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
140 ETag_surfxml_AS_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
141 STag_surfxml_ASroute_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
142 ETag_surfxml_ASroute_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
143 STag_surfxml_bypassRoute_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
144 ETag_surfxml_bypassRoute_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
147 /* Stag and Etag parse functions */
149 void STag_surfxml_platform(void)
151 double version = 0.0;
153 sscanf(A_surfxml_platform_version, "%lg", &version);
155 xbt_assert0((version >= 1.0), "******* BIG FAT WARNING *********\n "
156 "You're using an ancient XML file. "
157 "Since SimGrid 3.1, units are Bytes, Flops, and seconds "
158 "instead of MBytes, MFlops and seconds. "
159 "A script (surfxml_update.pl) to help you convert your old "
161 "is available in the contrib/platform_generation directory "
162 "of the simgrid repository. Please check also out the "
163 "SURF section of the ChangeLog for the 3.1 version. "
164 "Last, do not forget to also update your values for "
165 "the calls to MSG_task_create (if any).");
166 xbt_assert0((version >= 2.0), "******* BIG FAT WARNING *********\n "
167 "You're using an old XML file. "
168 "A script (surfxml_update.pl) to help you convert your old "
170 "is available in the contrib/platform_generation directory "
171 "of the simgrid repository.");
173 surfxml_call_cb_functions(STag_surfxml_platform_cb_list);
177 #define parse_method(type,name) \
178 void type##Tag_surfxml_##name(void) \
179 { surfxml_call_cb_functions(type##Tag_surfxml_##name##_cb_list); }
181 parse_method(E,platform);
182 parse_method(S,host); parse_method(E,host);
183 parse_method(S,router); parse_method(E,router);
184 parse_method(S,link); parse_method(E,link);
185 parse_method(S,route); parse_method(E,route);
186 parse_method(S,link_c_ctn); parse_method(E,link_c_ctn);
187 parse_method(S,process); parse_method(E,process);
188 parse_method(S,argument); parse_method(E,argument);
189 parse_method(S,prop); parse_method(E,prop);
190 parse_method(S,trace); parse_method(E,trace);
191 parse_method(S,trace_c_connect); parse_method(E,trace_c_connect);
192 parse_method(S,random); parse_method(E,random);
193 parse_method(S,AS); parse_method(E,AS);
194 parse_method(S,ASroute); parse_method(E,ASroute);
195 parse_method(S,bypassRoute); parse_method(E,bypassRoute);
197 /* Open and Close parse file */
199 void surf_parse_open(const char *file)
201 static int warned = 0; /* warn only once */
205 ("Bypassing the XML parser since surf_parse_open received a NULL pointer. If it is not what you want, go fix your code.");
210 surf_file_to_parse = surf_fopen(file, "r");
211 xbt_assert1((surf_file_to_parse), "Unable to open \"%s\"\n", file);
212 surf_input_buffer = surf_parse__create_buffer(surf_file_to_parse, 10);
213 surf_parse__switch_to_buffer(surf_input_buffer);
214 surf_parse_lineno = 1;
217 void surf_parse_close(void)
219 if (surf_file_to_parse) {
220 surf_parse__delete_buffer(surf_input_buffer);
221 fclose(surf_file_to_parse);
227 static int _surf_parse(void)
229 return surf_parse_lex();
232 int_f_void_t surf_parse = _surf_parse;
234 void surf_parse_error(char *msg)
236 fprintf(stderr, "Parse error on line %d: %s\n", surf_parse_lineno, msg);
240 void surf_parse_get_double(double *value, const char *string)
243 ret = sscanf(string, "%lg", value);
245 surf_parse_error(bprintf("%s is not a double", string));
248 void surf_parse_get_int(int *value, const char *string)
251 ret = sscanf(string, "%d", value);
253 surf_parse_error(bprintf("%s is not an integer", string));
256 /* Aux parse functions */
258 void surfxml_add_callback(xbt_dynar_t cb_list, void_f_void_t function)
260 xbt_dynar_push(cb_list, &function);
263 void surfxml_del_callback(xbt_dynar_t* p_cb_list, void_f_void_t function)
265 xbt_dynar_t new_cb_list = xbt_dynar_new(sizeof(void_f_void_t), NULL);
268 xbt_dynar_foreach(*p_cb_list,it,func) {
269 if( func != function )
270 xbt_dynar_push(new_cb_list, &func);
272 xbt_dynar_free(p_cb_list);
273 *p_cb_list = new_cb_list;
276 static XBT_INLINE void surfxml_call_cb_functions(xbt_dynar_t cb_list)
278 unsigned int iterator;
280 xbt_dynar_foreach(cb_list, iterator, fun) {
285 /* Init and free parse data */
287 static void init_data(void)
289 random_data_list = xbt_dict_new();
290 traces_set_list = xbt_dict_new();
291 trace_connect_list_host_avail = xbt_dict_new();
292 trace_connect_list_power = xbt_dict_new();
293 trace_connect_list_link_avail = xbt_dict_new();
294 trace_connect_list_bandwidth = xbt_dict_new();
295 trace_connect_list_latency = xbt_dict_new();
297 surfxml_add_callback(STag_surfxml_random_cb_list, &init_randomness);
298 surfxml_add_callback(ETag_surfxml_random_cb_list, &add_randomness);
299 surfxml_add_callback(STag_surfxml_prop_cb_list, &parse_properties);
300 surfxml_add_callback(STag_surfxml_trace_cb_list, &parse_Stag_trace);
301 surfxml_add_callback(ETag_surfxml_trace_cb_list, &parse_Etag_trace);
302 surfxml_add_callback(STag_surfxml_trace_c_connect_cb_list, &parse_Stag_trace_c_connect);
305 static void free_data(void)
307 xbt_dict_free(&trace_connect_list_host_avail);
308 xbt_dict_free(&trace_connect_list_power);
309 xbt_dict_free(&trace_connect_list_link_avail);
310 xbt_dict_free(&trace_connect_list_bandwidth);
311 xbt_dict_free(&trace_connect_list_latency);
312 xbt_dict_free(&traces_set_list);
313 xbt_dict_free(&random_data_list);
316 /* Here start parse */
318 void parse_platform_file(const char *file)
321 surf_parse_open(file);
323 parse_status = surf_parse();
326 xbt_assert1(!parse_status, "Parse error in %s", file);
329 /* Prop tag functions */
331 void parse_properties(void)
334 if (!current_property_set)
335 current_property_set = xbt_dict_new(); // Maybe, it should be make a error
336 value = xbt_strdup(A_surfxml_prop_value);
337 xbt_dict_set(current_property_set, A_surfxml_prop_id, value, free);
340 /* Trace management functions */
342 static double trace_periodicity = -1.0;
343 static char *trace_file = NULL;
344 static char *trace_id;
346 static void parse_Stag_trace(void)
348 trace_id = strdup(A_surfxml_trace_id);
349 trace_file = strdup(A_surfxml_trace_file);
350 surf_parse_get_double(&trace_periodicity, A_surfxml_trace_periodicity);
353 static void parse_Etag_trace(void)
356 if (!trace_file || strcmp(trace_file, "") != 0) {
357 trace = tmgr_trace_new(trace_file);
359 if (strcmp(surfxml_pcdata, "") == 0)
363 tmgr_trace_new_from_string(trace_id, surfxml_pcdata,
366 xbt_dict_set(traces_set_list, trace_id, (void *) trace, NULL);
369 static void parse_Stag_trace_c_connect(void)
371 xbt_assert2(xbt_dict_get_or_null
372 (traces_set_list, A_surfxml_trace_c_connect_trace),
373 "Cannot connect trace %s to %s: trace unknown",
374 A_surfxml_trace_c_connect_trace,
375 A_surfxml_trace_c_connect_element);
377 switch (A_surfxml_trace_c_connect_kind) {
378 case A_surfxml_trace_c_connect_kind_HOST_AVAIL:
379 xbt_dict_set(trace_connect_list_host_avail,
380 A_surfxml_trace_c_connect_trace,
381 xbt_strdup(A_surfxml_trace_c_connect_element), free);
383 case A_surfxml_trace_c_connect_kind_POWER:
384 xbt_dict_set(trace_connect_list_power, A_surfxml_trace_c_connect_trace,
385 xbt_strdup(A_surfxml_trace_c_connect_element), free);
387 case A_surfxml_trace_c_connect_kind_LINK_AVAIL:
388 xbt_dict_set(trace_connect_list_link_avail,
389 A_surfxml_trace_c_connect_trace,
390 xbt_strdup(A_surfxml_trace_c_connect_element), free);
392 case A_surfxml_trace_c_connect_kind_BANDWIDTH:
393 xbt_dict_set(trace_connect_list_bandwidth,
394 A_surfxml_trace_c_connect_trace,
395 xbt_strdup(A_surfxml_trace_c_connect_element), free);
397 case A_surfxml_trace_c_connect_kind_LATENCY:
398 xbt_dict_set(trace_connect_list_latency, A_surfxml_trace_c_connect_trace,
399 xbt_strdup(A_surfxml_trace_c_connect_element), free);
402 xbt_die(bprintf("Cannot connect trace %s to %s: kind of trace unknown",
403 A_surfxml_trace_c_connect_trace,
404 A_surfxml_trace_c_connect_element));
408 /* Random tag functions */
410 double get_cpu_power(const char *power)
412 double power_scale = 0.0;
415 random_data_t random = NULL;
416 /* randomness is inserted like this: power="$rand(my_random)" */
417 if (((p = strstr(power, "$rand(")) != NULL)
418 && ((q = strstr(power, ")")) != NULL)) {
420 generator = xbt_malloc(q - (p + 6) + 1);
421 memcpy(generator, p + 6, q - (p + 6));
422 generator[q - (p + 6)] = '\0';
423 xbt_assert1((random =
424 xbt_dict_get_or_null(random_data_list, generator)),
425 "Random generator %s undefined", generator);
426 power_scale = random_generate(random);
429 surf_parse_get_double(&power_scale, power);
434 double random_min, random_max, random_mean, random_std_deviation, random_generator;
437 static void init_randomness(void)
439 random_id = A_surfxml_random_id;
440 surf_parse_get_double(&random_min, A_surfxml_random_min);
441 surf_parse_get_double(&random_max, A_surfxml_random_max);
442 surf_parse_get_double(&random_mean, A_surfxml_random_mean);
443 surf_parse_get_double(&random_std_deviation, A_surfxml_random_std_deviation);
444 random_generator = A_surfxml_random_generator;
447 static void add_randomness(void)
449 /* If needed aditional properties can be added by using the prop tag */
450 random_data_t random = random_new(random_generator, 0, random_min, random_max, random_mean, random_std_deviation);
451 xbt_dict_set(random_data_list, random_id, (void *) random, &xbt_free_ref); // FIX BY DAVID, add the xbt_free_ref function
455 * create CPU resource via CPU Model
457 void surf_host_create_resource(char *name, double power_peak,
459 tmgr_trace_t power_trace,
460 e_surf_resource_state_t state_initial,
461 tmgr_trace_t state_trace,
462 xbt_dict_t cpu_properties)
464 return surf_cpu_model->extension.cpu.
465 create_resource(name,power_peak,power_scale,power_trace,state_initial,state_trace,cpu_properties);
469 * create CPU resource via worsktation_ptask_L07 model
472 void surf_wsL07_host_create_resource(char *name, double power_peak,
474 tmgr_trace_t power_trace,
475 e_surf_resource_state_t state_initial,
476 tmgr_trace_t state_trace,
477 xbt_dict_t cpu_properties)
479 surf_workstation_model->extension.workstation.
480 cpu_create_resource(name,power_peak,power_scale,power_trace,state_initial,state_trace,cpu_properties);
483 * create link resource via network Model
485 void surf_link_create_resource(char *name,
487 tmgr_trace_t bw_trace,
489 tmgr_trace_t lat_trace,
490 e_surf_resource_state_t
492 tmgr_trace_t state_trace,
493 e_surf_link_sharing_policy_t policy,
494 xbt_dict_t properties)
496 return surf_network_model->extension.network.
497 create_resource(name,bw_initial,bw_trace,lat_initial,lat_trace,
498 state_initial,state_trace,policy,properties);
502 * create link resource via workstation_ptask_L07 model
505 void surf_wsL07_link_create_resource(char *name,
507 tmgr_trace_t bw_trace,
509 tmgr_trace_t lat_trace,
510 e_surf_resource_state_t
512 tmgr_trace_t state_trace,
513 e_surf_link_sharing_policy_t
514 policy, xbt_dict_t properties)
516 return surf_workstation_model->extension.workstation.
517 link_create_resource(name,bw_initial,bw_trace,lat_initial,lat_trace,
518 state_initial,state_trace,policy,properties);
522 * Route: add route element bypassing the parser :
523 * same job as parse_route_elem
526 void surf_add_route_element(char* link_ctn_id)
528 xbt_die("\"surf_add_route_element\" not support");
530 // val = xbt_strdup(link_ctn_id);
531 // xbt_dynar_push(route_link_list,&val);
536 void surf_route_set_resource(char *source_id,char *destination_id,xbt_dynar_t links_id,int action)
538 xbt_die("\"surf_route_set_resource\" not support");
539 //route_link_list = xbt_dynar_new(sizeof(char *), NULL); // COMMENTED BY DAVID
540 //routing_add_route(source_id,destination_id,links_id,action); // COMMENTED BY DAVID
545 * add host to routing host list
547 void surf_route_add_host(char *host_id)
549 xbt_die("\"surf_route_add_host\" not support");
550 //routing_add_host(host_id); // COMMENTED BY DAVID
556 void surf_add_host_traces(void)
558 return surf_cpu_model->extension.cpu.add_traces();
561 void surf_add_link_traces(void)
563 return surf_network_model->extension.network.add_traces();
566 void surf_wsL07_add_traces(void)
568 return surf_workstation_model->extension.workstation.add_traces();
574 void surf_set_routes(void)
576 xbt_die("\"surf_set_routes\" not support");
577 //routing_set_routes(); // COMMENTED BY DAVID