3 /* Copyright (c) 2005 Henri Casanova. All rights reserved. */
5 /* This program is free software; you can redistribute it and/or modify it
6 * under the terms of the license (GNU LGPL) which comes with this package. */
8 #include "network_gtnets_private.h"
9 #include "gtnets/gtnets_interface.h"
11 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_network_gtnets, surf,
12 "Logging specific to the SURF network module");
14 /** QUESTIONS for GTNetS integration
15 ** 1. Check that we did the right thing with name_service and get_resource_name
16 ** 2. Right now there is no "kill flow" in our GTNetS implementation. Do we
17 ** need to do something about this?
18 ** 3. We ignore the fact there is some max_duration on flows (see #2 above)
19 ** 4. share_resources() returns a duration, not a date, right?
20 ** 5. We don't suppoer "rates"
21 ** 6. We don't update "remaining" for ongoing flows. Is it bad?
24 /* Free memory for a network link */
25 static void link_free(void *nw_link)
27 free(((link_GTNETS_t) nw_link)->name);
31 /* Instantiate a new network link */
32 /* name: some name for the link, from the XML */
33 /* bw: The bandwidth value */
34 /* lat: The latency value */
35 static void link_new(char *name, double bw, double lat, xbt_dict_t props)
37 static int link_count = -1;
38 link_GTNETS_t gtnets_link;
40 /* If link already exists, nothing to do (FIXME: check that multiple definition match?) */
41 if (xbt_dict_get_or_null(link_set, name)) {
45 /* KF: Increment the link counter for GTNetS */
49 nw_link->model = (surf_model_t) surf_network_model;
51 nw_link->bw_current = bw_initial;
54 tmgr_history_add_trace(history, bw_trace, 0.0, 0, nw_link);
55 nw_link->lat_current = lat_initial;
58 tmgr_history_add_trace(history, lat_trace, 0.0, 0, nw_link);
59 nw_link->state_current = state_initial;
61 nw_link->state_event =
62 tmgr_history_add_trace(history, state_trace, 0.0, 0, nw_link);
65 /* KF: Add the link to the GTNetS simulation */
66 if (gtnets_add_link(link_count, bw, lat)) {
67 xbt_assert0(0, "Cannot create GTNetS link");
70 /* KF: Insert entry in the dictionary */
71 gtnets_link = xbt_new0(s_link_GTNETS_t, 1);
72 gtnets_link->name = name;
73 gtnets_link->bw_current = bw;
74 gtnets_link->lat_current = lat;
75 gtnets_link->id = link_count;
76 /* Add the properties */
77 gtnets_link->properties = current_property_set;
79 xbt_dict_set(link_set, name, gtnets_link, link_free);
84 /* free the network card */
85 static void network_card_free(void *nw_card)
87 free(((network_card_GTNETS_t) nw_card)->name);
91 /* Instantiate a new network card: MODIFYED BY KF */
92 static int network_card_new(const char *name)
94 static int card_count = -1;
96 /* KF: Check that we haven't seen the network card before */
97 network_card_GTNETS_t card =
98 xbt_dict_get_or_null(network_card_set, name);
101 /* KF: Increment the card counter for GTNetS */
104 /* KF: just use the dictionary to map link names to link indices */
105 card = xbt_new0(s_network_card_GTNETS_t, 1);
106 card->name = xbt_strdup(name);
107 card->id = card_count;
108 xbt_dict_set(network_card_set, name, card, network_card_free);
111 /* KF: just return the GTNetS ID as the SURF ID */
115 /* Instantiate a new route: MODIFY BY KF */
116 static void route_new(int src_id, int dst_id, char **links, int nb_link)
119 link_GTNETS_t *link_list = NULL;
122 ROUTE_SIZE(src_id, dst_id) = nb_link;
123 link_list = (ROUTE(src_id, dst_id) =
124 xbt_new0(link_GTNETS_t, nb_link));
125 for (i = 0; i < nb_link; i++) {
126 link_list[i] = xbt_dict_get_or_null(link_set, links[i]);
134 /* KF: Build the list of gtnets link IDs */
135 gtnets_links = (int *) calloc(nb_link, sizeof(int));
136 for (i = 0; i < nb_link; i++) {
139 (xbt_dict_get(link_set, links[i])))->id;
142 /* KF: Create the GTNets route */
143 if (gtnets_add_route(src_id, dst_id, gtnets_links, nb_link)) {
144 xbt_assert0(0, "Cannot create GTNetS route");
148 /* Instantiate a new route: MODIFY BY KF */
149 static void route_onehop_new(int src_id, int dst_id, char **links,
155 xbt_assert0(0, "In onehop_new, nb_link should be 1");
158 /* KF: Build the list of gtnets link IDs */
161 (xbt_dict_get(link_set, links[0])))->id;
163 /* KF: Create the GTNets route */
164 if (gtnets_add_onehop_route(src_id, dst_id, linkid)) {
165 xbt_assert0(0, "Cannot create GTNetS route");
171 /* Parse the XML for a network link */
172 static void parse_link_init(void)
177 e_surf_link_state_t state;
179 name = xbt_strdup(A_surfxml_link_name);
180 surf_parse_get_double(&bw, A_surfxml_link_bandwidth);
181 surf_parse_get_double(&lat, A_surfxml_link_latency);
182 state = SURF_link_ON;
184 /* Print values when no traces are specified */
186 tmgr_trace_t bw_trace;
187 tmgr_trace_t state_trace;
188 tmgr_trace_t lat_trace;
190 surf_parse_get_trace(&bw_trace, A_surfxml_link_bandwidth_file);
191 surf_parse_get_trace(&lat_trace, A_surfxml_link_latency_file);
192 surf_parse_get_trace(&state_trace, A_surfxml_link_state_file);
194 /*TODO Where is WARNING0 defined??? */
198 ("The GTNetS network model doesn't support bandwidth state traces");
201 ("The GTNetS network model doesn't support latency state traces");
204 ("The GTNetS network model doesn't support link state traces");
207 /* KF: remove several arguments to link_new */
208 current_property_set = xbt_dict_new();
209 link_new(name, bw, lat, current_property_set);
212 static int nb_link = 0;
213 static char **link_name = NULL;
214 static int src_id = -1;
215 static int dst_id = -1;
217 /* Parses a route from the XML: UNMODIFIED BY HC */
218 static void parse_route_set_endpoints(void)
220 src_id = network_card_new(A_surfxml_route_src);
221 dst_id = network_card_new(A_surfxml_route_dst);
226 route_link_list = xbt_dynar_new(sizeof(char *), &free_string);
230 static void parse_route_set_routers(void)
232 int id = network_card_new(A_surfxml_router_name);
234 /* KF: Create the GTNets router */
235 if (gtnets_add_router(id)) {
236 xbt_assert0(0, "Cannot add GTNetS router");
240 //The following is common to all and has been relocated to surfxml_parse
241 /* Parses a route element from the XML: UNMODIFIED BY HC */
242 /*static void parse_route_elem(void)
245 link_name = xbt_realloc(link_name, (nb_link) * sizeof(char *));
246 link_name[(nb_link) - 1] = xbt_strdup(A_surfxml_route_element_name);
250 /* Create the route (more than one hops): MODIFIED BY KF */
251 static void parse_route_set_route(void)
254 route_new(src_id, dst_id, link_name, nb_link);
256 name = bprintf("%x#%x",src_id, dst_id);
257 xbt_dict_set(route_table, name, route_link_list, NULL);
261 //This is not used anymore. one hop routes are created in add_route
262 /* Create the one-hope route: BY KF */
263 static void parse_route_set_onehop_route(void)
266 route_onehop_new(src_id, dst_id, link_name, nb_link);
269 static void add_route()
272 unsigned int cpt = 0;
274 xbt_dict_cursor_t cursor = NULL;
275 char *key,*data, *end;
276 const char *sep = "#";
277 xbt_dynar_t links, keys;
279 xbt_dict_foreach(route_table, cursor, key, data) {
281 links = (xbt_dynar_t)data;
282 keys = xbt_str_split_str(key, sep);
284 nb_link = xbt_dynar_length(links);
285 link_name = xbt_realloc(link_name, (nb_link) * sizeof(char *));
287 src_id = strtol(xbt_dynar_get_as(keys, 0, char*), &end, 16);
288 dst_id = strtol(xbt_dynar_get_as(keys, 1, char*), &end, 16);
292 xbt_dynar_foreach (links, cpt, link) {
294 link_name[i++] = xbt_dict_get(link_set, link);
297 RETHROW1("Link %s not found (dict raised this exception: %s)", link);
301 route_new(src_id, dst_id, link_name, nb_link);
303 route_onehop_new(src_id, dst_id, link_name, nb_link);
304 xbt_dynar_free(&links);
307 xbt_dict_free(&route_table);
310 /* Main XML parsing */
311 static void define_callbacks(const char *file)
313 surfxml_add_callback(STag_surfxml_prop_cb_list, &parse_properties);
314 surfxml_add_callback(STag_surfxml_router_cb_list, &parse_route_set_routers);
315 surfxml_add_callback(STag_surfxml_link_cb_list, &parse_link_init);
316 surfxml_add_callback(STag_surfxml_route_cb_list, &parse_route_set_endpoints);
317 surfxml_add_callback(ETag_surfxml_route_element_cb_list, &parse_route_elem);
318 /* surfxml_add_callback(ETag_surfxml_route_cb_list, &parse_route_set_onehop_route);*/
319 surfxml_add_callback(STag_surfxml_platform_cb_list, &init_data);
320 surfxml_add_callback(ETag_surfxml_route_cb_list, &parse_route_set_route);
321 surfxml_add_callback(ETag_surfxml_platform_cb_list, &add_route);
322 surfxml_add_callback(STag_surfxml_set_cb_list, &parse_sets);
323 surfxml_add_callback(STag_surfxml_route_c_multi_cb_list, &parse_route_multi_set_endpoints);
324 surfxml_add_callback(ETag_surfxml_route_c_multi_cb_list, &parse_route_multi_set_route);
325 surfxml_add_callback(STag_surfxml_foreach_cb_list, &parse_foreach);
326 surfxml_add_callback(STag_surfxml_cluster_cb_list, &parse_cluster);
329 static void *name_service(const char *name)
331 return xbt_dict_get_or_null(network_card_set, name);
334 static const char *get_resource_name(void *resource_id)
336 return ((network_card_GTNETS_t) resource_id)->name;
339 static xbt_dict_t get_properties(void *link)
341 return ((network_card_GTNETS_t) link)->properties;
345 /* We do not care about this: only used for traces */
346 static int resource_used(void *resource_id)
348 return 0; /* We don't care */
351 static int action_free(surf_action_t action)
354 if (!action->using) {
355 xbt_swag_remove(action, action->state_set);
356 /* KF: No explicit freeing needed for GTNeTS here */
363 static void action_use(surf_action_t action)
368 static void action_cancel(surf_action_t action)
370 xbt_assert0(0, "Cannot cancel GTNetS flow");
374 static void action_recycle(surf_action_t action)
376 xbt_assert0(0, "Cannot recycle GTNetS flow");
380 static void action_change_state(surf_action_t action,
381 e_surf_action_state_t state)
383 /* if((state==SURF_ACTION_DONE) || (state==SURF_ACTION_FAILED)) */
384 /* if(((surf_action_network_GTNETS_t)action)->variable) { */
385 /* lmm_variable_disable(maxmin_system, ((surf_action_network_GTNETS_t)action)->variable); */
386 /* ((surf_action_network_GTNETS_t)action)->variable = NULL; */
389 surf_action_change_state(action, state);
394 /* share_resources() */
395 static double share_resources(double now)
398 s_surf_action_network_GTNETS_t s_action;
399 surf_action_network_GTNETS_t action = NULL;
400 xbt_swag_t running_actions =
401 surf_network_model->common_public->states.running_action_set;
404 return gtnets_get_time_to_next_flow_completion();
407 /* delta: by how many time units the simulation must advance */
408 /* In this function: change the state of actions that terminate */
409 /* The delta may not come from the network, and thus may be different (smaller)
410 than the one returned by the function above */
411 /* If the delta is a network-caused min, then do not emulate any timer in the
412 network simulation, otherwise fake a timer somehow to advance the simulation of min seconds */
414 static void update_actions_state(double now, double delta)
417 surf_action_network_GTNETS_t action = NULL;
418 surf_action_network_GTNETS_t next_action = NULL;
419 xbt_swag_t running_actions =
420 surf_network_model->common_public->states.running_action_set;
423 double time_to_next_flow_completion =
424 gtnets_get_time_to_next_flow_completion();
426 /* If there are no renning flows, just return */
427 if (time_to_next_flow_completion < 0.0) {
431 /*KF: if delta == time_to_next_flow_completion, too. */
432 if (time_to_next_flow_completion <= delta) { /* run until the first flow completes */
438 if (gtnets_run_until_next_flow_completion(&metadata, &num_flows)) {
440 "Cannot run GTNetS simulation until next flow completion");
444 "GTNetS simulation couldn't find a flow that would complete");
447 for (i = 0; i < num_flows; i++) {
448 surf_action_network_GTNETS_t action =
449 (surf_action_network_GTNETS_t) (metadata[i]);
451 action->generic_action.remains = 0;
452 action->generic_action.finish = now + time_to_next_flow_completion;
453 action_change_state((surf_action_t) action, SURF_ACTION_DONE);
454 /* TODO: Anything else here? */
456 } else { /* run for a given number of seconds */
457 if (gtnets_run(delta)) {
458 xbt_assert0(0, "Cannot run GTNetS simulation");
465 /* UNUSED HERE: no traces */
466 static void update_resource_state(void *id,
467 tmgr_trace_event_t event_type,
470 xbt_assert0(0, "Cannot update model state for GTNetS simulation");
474 /* KF: Rate not supported */
475 static surf_action_t communicate(void *src, void *dst, double size,
478 surf_action_network_GTNETS_t action = NULL;
479 network_card_GTNETS_t card_src = src;
480 network_card_GTNETS_t card_dst = dst;
482 int route_size = ROUTE_SIZE(card_src->id, card_dst->id);
483 link_GTNETS_t *route = ROUTE(card_src->id, card_dst->id);
487 xbt_assert2(route_size,"You're trying to send data from %s to %s but there is no connexion between these two cards.", card_src->name, card_dst->name);
490 action = xbt_new0(s_surf_action_network_GTNETS_t, 1);
492 action->generic_action.using = 1;
493 action->generic_action.cost = size;
494 action->generic_action.remains = size;
495 /* Max durations are not supported */
496 action->generic_action.max_duration = NO_MAX_DURATION;
497 action->generic_action.start = surf_get_clock();
498 action->generic_action.finish = -1.0;
499 action->generic_action.model_type =
500 (surf_model_t) surf_network_model;
502 action->generic_action.state_set =
503 surf_network_model->common_public->states.running_action_set;
505 xbt_swag_insert(action, action->generic_action.state_set);
507 /* KF: Add a flow to the GTNets Simulation, associated to this action */
508 if (gtnets_create_flow(card_src->id, card_dst->id, size, (void *) action)
510 xbt_assert2(0, "Not route between host %s and host %s", card_src->name,
514 return (surf_action_t) action;
517 /* Suspend a flow() */
518 static void action_suspend(surf_action_t action)
521 "action_suspend() not supported for the GTNets network model");
524 /* Resume a flow() */
525 static void action_resume(surf_action_t action)
528 "action_resume() not supported for the GTNets network model");
531 /* Test whether a flow is suspended */
532 static int action_is_suspended(surf_action_t action)
537 static void finalize(void)
542 xbt_dict_free(&network_card_set);
543 xbt_dict_free(&link_set);
544 xbt_swag_free(surf_network_model->common_public->states.
546 xbt_swag_free(surf_network_model->common_public->states.
548 xbt_swag_free(surf_network_model->common_public->states.
550 xbt_swag_free(surf_network_model->common_public->states.
552 free(surf_network_model->common_public);
553 free(surf_network_model->common_private);
554 free(surf_network_model->extension_public);
556 free(surf_network_model);
557 surf_network_model = NULL;
560 for (i = 0; i < card_number; i++)
561 for (j = 0; j < card_number; j++)
564 routing_table = NULL;
565 free(routing_table_size);
566 routing_table_size = NULL;
575 static void surf_network_model_init_internal(void)
577 s_surf_action_t action;
579 surf_network_model = xbt_new0(s_surf_network_model_t, 1);
581 surf_network_model->common_private =
582 xbt_new0(s_surf_model_private_t, 1);
583 surf_network_model->common_public =
584 xbt_new0(s_surf_model_public_t, 1);
585 surf_network_model->extension_public =
586 xbt_new0(s_surf_network_model_extension_public_t, 1);
588 surf_network_model->common_public->states.ready_action_set =
589 xbt_swag_new(xbt_swag_offset(action, state_hookup));
590 surf_network_model->common_public->states.running_action_set =
591 xbt_swag_new(xbt_swag_offset(action, state_hookup));
592 surf_network_model->common_public->states.failed_action_set =
593 xbt_swag_new(xbt_swag_offset(action, state_hookup));
594 surf_network_model->common_public->states.done_action_set =
595 xbt_swag_new(xbt_swag_offset(action, state_hookup));
597 surf_network_model->common_public->name_service = name_service;
598 surf_network_model->common_public->get_resource_name =
600 surf_network_model->common_public->action_get_state =
601 surf_action_get_state;
602 surf_network_model->common_public->action_use = action_use;
603 surf_network_model->common_public->action_free = action_free;
604 surf_network_model->common_public->action_cancel = action_cancel;
605 surf_network_model->common_public->action_recycle = action_recycle;
606 surf_network_model->common_public->action_change_state =
608 surf_network_model->common_public->action_set_data =
609 surf_action_set_data;
610 surf_network_model->common_public->name = "network";
612 surf_network_model->common_private->resource_used = resource_used;
613 surf_network_model->common_private->share_resources = share_resources;
614 surf_network_model->common_private->update_actions_state =
615 update_actions_state;
616 surf_network_model->common_private->update_resource_state =
617 update_resource_state;
618 surf_network_model->common_private->finalize = finalize;
620 surf_network_model->common_public->suspend = action_suspend;
621 surf_network_model->common_public->resume = action_resume;
622 surf_network_model->common_public->is_suspended = action_is_suspended;
624 surf_network_model->extension_public->communicate = communicate;
626 /*for the props of the link*/
627 surf_network_model->common_public->get_properties = get_properties;
629 link_set = xbt_dict_new();
630 network_card_set = xbt_dict_new();
632 /* KF: Added the initialization for GTNetS interface */
633 if (gtnets_initialize()) {
634 xbt_assert0(0, "impossible to initialize GTNetS interface");
638 void surf_network_model_init_GTNETS(const char *filename)
640 if (surf_network_model)
642 surf_network_model_init_internal();
643 define_callbacks(filename);
644 xbt_dynar_push(model_list, &surf_network_model);
646 update_model_description(surf_network_model_description,
647 surf_network_model_description_size,
649 (surf_model_t) surf_network_model);