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"
13 static double time_to_next_flow_completion = -1;
15 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_network_gtnets, surf,
16 "Logging specific to the SURF network module");
18 /** QUESTIONS for GTNetS integration
19 ** 1. Check that we did the right thing with name_service and get_resource_name
20 ** 2. Right now there is no "kill flow" in our GTNetS implementation. Do we
21 ** need to do something about this?
22 ** 3. We ignore the fact there is some max_duration on flows (see #2 above)
23 ** 4. share_resources() returns a duration, not a date, right?
24 ** 5. We don't suppoer "rates"
25 ** 6. We don't update "remaining" for ongoing flows. Is it bad?
28 static int src_id = -1;
29 static int dst_id = -1;
31 /* Free memory for a network link */
32 static void link_free(void *nw_link)
34 free(((network_link_GTNETS_t) nw_link)->name);
35 xbt_dict_free(&(((network_link_GTNETS_t) nw_link)->properties));
39 /* Instantiate a new network link */
40 /* name: some name for the link, from the XML */
41 /* bw: The bandwidth value */
42 /* lat: The latency value */
43 static void link_new(char *name, double bw, double lat, xbt_dict_t props)
45 static int link_count = -1;
46 network_link_GTNETS_t gtnets_link;
48 /* If link already exists, nothing to do (FIXME: check that multiple definition match?) */
49 if (xbt_dict_get_or_null(link_set, name)) {
53 /* KF: Increment the link counter for GTNetS */
57 nw_link->model = (surf_model_t) surf_network_model;
59 nw_link->bw_current = bw_initial;
62 tmgr_history_add_trace(history, bw_trace, 0.0, 0, nw_link);
63 nw_link->lat_current = lat_initial;
66 tmgr_history_add_trace(history, lat_trace, 0.0, 0, nw_link);
67 nw_link->state_current = state_initial;
69 nw_link->state_event =
70 tmgr_history_add_trace(history, state_trace, 0.0, 0, nw_link);
73 /* KF: Add the link to the GTNetS simulation */
74 if (gtnets_add_link(link_count, bw, lat)) {
75 xbt_assert0(0, "Cannot create GTNetS link");
78 /* KF: Insert entry in the dictionary */
79 gtnets_link = xbt_new0(s_network_link_GTNETS_t, 1);
80 gtnets_link->name = name;
81 gtnets_link->bw_current = bw;
82 gtnets_link->lat_current = lat;
83 gtnets_link->id = link_count;
84 /* Add the properties */
85 gtnets_link->properties = props;
87 xbt_dict_set(link_set, name, gtnets_link, link_free);
92 /* free the network card */
93 static void network_card_free(void *nw_card)
95 free(((network_card_GTNETS_t) nw_card)->name);
99 /* Instantiate a new network card: MODIFYED BY KF */
100 static int network_card_new(const char *name)
102 static int card_count = -1;
104 XBT_IN1("(%s)", name);
105 /* KF: Check that we haven't seen the network card before */
106 network_card_GTNETS_t card = xbt_dict_get_or_null(network_card_set, name);
109 /* KF: Increment the card counter for GTNetS */
112 /* KF: just use the dictionary to map link names to link indices */
113 card = xbt_new0(s_network_card_GTNETS_t, 1);
114 card->name = xbt_strdup(name);
115 card->id = card_count;
116 xbt_dict_set(network_card_set, name, card, network_card_free);
119 LOG1(xbt_log_priority_trace, " return %d", card->id);
121 /* KF: just return the GTNetS ID as the SURF ID */
125 /* Instantiate a new route: MODIFY BY KF */
126 static void route_new(int src_id, int dst_id, network_link_GTNETS_t * links,
131 XBT_IN4("(src_id=%d, dst_id=%d, links=%p, nb_link=%d)",
132 src_id, dst_id, links, nb_link);
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++) {
137 gtnets_links[i] = links[i]->id;
140 /* KF: Create the GTNets route */
141 if (gtnets_add_route(src_id, dst_id, gtnets_links, nb_link)) {
142 xbt_assert0(0, "Cannot create GTNetS route");
147 /* Instantiate a new route: MODIFY BY KF */
148 static void route_onehop_new(int src_id, int dst_id,
149 network_link_GTNETS_t * links, int nb_link)
154 xbt_assert0(0, "In onehop_new, nb_link should be 1");
157 /* KF: Build the linbst of gtnets link IDs */
158 linkid = links[0]->id;
160 /* KF: Create the GTNets route */
161 if (gtnets_add_onehop_route(src_id, dst_id, linkid)) {
162 xbt_assert0(0, "Cannot create GTNetS route");
168 /* Parse the XML for a network link */
169 static void parse_link_init(void)
174 e_surf_link_state_t state;
176 name = xbt_strdup(A_surfxml_link_id);
177 surf_parse_get_double(&bw, A_surfxml_link_bandwidth);
178 surf_parse_get_double(&lat, A_surfxml_link_latency);
179 state = SURF_LINK_ON;
181 tmgr_trace_t bw_trace;
182 tmgr_trace_t state_trace;
183 tmgr_trace_t lat_trace;
185 surf_parse_get_trace(&bw_trace, A_surfxml_link_bandwidth_file);
186 surf_parse_get_trace(&lat_trace, A_surfxml_link_latency_file);
187 surf_parse_get_trace(&state_trace, A_surfxml_link_state_file);
190 INFO0("The GTNetS network model doesn't support bandwidth state traces");
192 INFO0("The GTNetS network model doesn't support latency state traces");
194 INFO0("The GTNetS network model doesn't support link state traces");
196 current_property_set = xbt_dict_new();
197 link_new(name, bw, lat, current_property_set);
200 /* Parses a route from the XML: UNMODIFIED BY HC */
201 static void parse_route_set_endpoints(void)
203 src_id = network_card_new(A_surfxml_route_src);
204 dst_id = network_card_new(A_surfxml_route_dst);
205 route_action = A_surfxml_route_action;
209 static void parse_route_set_routers(void)
211 int id = network_card_new(A_surfxml_router_id);
213 /* KF: Create the GTNets router */
214 if (gtnets_add_router(id)) {
215 xbt_assert0(0, "Cannot add GTNetS router");
219 /* Create the route (more than one hops): MODIFIED BY KF */
220 static void parse_route_set_route(void)
223 if (src_id != -1 && dst_id != -1) {
224 name = bprintf("%x#%x", src_id, dst_id);
225 manage_route(route_table, name, route_action, 0);
230 static void add_route()
233 unsigned int cpt = 0;
234 int link_list_capacity = 0;
236 xbt_dict_cursor_t cursor = NULL;
237 char *key, *data, *end;
238 const char *sep = "#";
239 xbt_dynar_t links, keys;
240 static network_link_GTNETS_t *link_list = NULL;
244 xbt_dict_foreach(route_table, cursor, key, data) {
247 links = (xbt_dynar_t) data;
248 keys = xbt_str_split_str(key, sep);
250 link_list_capacity = xbt_dynar_length(links);
251 link_list = xbt_new(network_link_GTNETS_t, link_list_capacity);
253 src_id = strtol(xbt_dynar_get_as(keys, 0, char *), &end, 16);
254 dst_id = strtol(xbt_dynar_get_as(keys, 1, char *), &end, 16);
255 xbt_dynar_free(&keys);
257 xbt_dynar_foreach(links, cpt, link) {
259 link_list[nb_link++] = xbt_dict_get(link_set, link);
262 RETHROW1("Link %s not found (dict raised this exception: %s)", link);
266 route_onehop_new(src_id, dst_id, link_list, nb_link);
269 xbt_dict_foreach(route_table, cursor, key, data) {
272 links = (xbt_dynar_t) data;
273 keys = xbt_str_split_str(key, sep);
275 link_list_capacity = xbt_dynar_length(links);
276 link_list = xbt_new(network_link_GTNETS_t, link_list_capacity);
278 src_id = strtol(xbt_dynar_get_as(keys, 0, char *), &end, 16);
279 dst_id = strtol(xbt_dynar_get_as(keys, 1, char *), &end, 16);
280 xbt_dynar_free(&keys);
282 xbt_dynar_foreach(links, cpt, link) {
284 link_list[nb_link++] = xbt_dict_get(link_set, link);
287 RETHROW1("Link %s not found (dict raised this exception: %s)", link);
291 route_new(src_id, dst_id, link_list, nb_link);
294 xbt_dict_free(&route_table);
295 gtnets_print_topology();
299 /* Main XML parsing */
300 static void define_callbacks(const char *file)
302 surfxml_add_callback(STag_surfxml_router_cb_list, &parse_route_set_routers);
303 surfxml_add_callback(STag_surfxml_link_cb_list, &parse_link_init);
304 surfxml_add_callback(STag_surfxml_route_cb_list,
305 &parse_route_set_endpoints);
306 surfxml_add_callback(ETag_surfxml_route_cb_list, &parse_route_set_route);
307 surfxml_add_callback(ETag_surfxml_platform_cb_list, &add_route);
310 static void *name_service(const char *name)
312 return xbt_dict_get_or_null(network_card_set, name);
315 static const char *get_resource_name(void *resource_id)
317 return ((network_card_GTNETS_t) resource_id)->name;
320 static xbt_dict_t get_properties(void *link)
322 return ((network_card_GTNETS_t) link)->properties;
326 /* We do not care about this: only used for traces */
327 static int resource_used(void *resource_id)
329 return 0; /* We don't care */
332 static int action_free(surf_action_t action)
335 if (!action->refcount) {
336 xbt_swag_remove(action, action->state_set);
337 /* KF: No explicit freeing needed for GTNeTS here */
344 static void action_use(surf_action_t action)
349 static void action_cancel(surf_action_t action)
351 xbt_assert0(0, "Cannot cancel GTNetS flow");
355 static void action_recycle(surf_action_t action)
357 xbt_assert0(0, "Cannot recycle GTNetS flow");
361 static void action_change_state(surf_action_t action,
362 e_surf_action_state_t state)
364 /* if((state==SURF_ACTION_DONE) || (state==SURF_ACTION_FAILED)) */
365 /* if(((surf_action_network_GTNETS_t)action)->variable) { */
366 /* lmm_variable_disable(maxmin_system, ((surf_action_network_GTNETS_t)action)->variable); */
367 /* ((surf_action_network_GTNETS_t)action)->variable = NULL; */
370 surf_action_change_state(action, state);
375 /* share_resources() */
376 static double share_resources(double now)
378 xbt_swag_t running_actions =
379 surf_network_model->common_public.states.running_action_set;
381 //get the first relevant value from the running_actions list
382 if (!xbt_swag_size(running_actions))
385 xbt_assert0(time_to_next_flow_completion,
386 "Time to next flow completion not initialized!\n");
388 time_to_next_flow_completion = gtnets_get_time_to_next_flow_completion();
390 return time_to_next_flow_completion;
393 /* delta: by how many time units the simulation must advance */
394 /* In this function: change the state of actions that terminate */
395 /* The delta may not come from the network, and thus may be different (smaller)
396 than the one returned by the function above */
397 /* If the delta is a network-caused min, then do not emulate any timer in the
398 network simulation, otherwise fake a timer somehow to advance the simulation of min seconds */
400 static void update_actions_state(double now, double delta)
402 surf_action_network_GTNETS_t action = NULL;
403 // surf_action_network_GTNETS_t next_action = NULL;
404 xbt_swag_t running_actions =
405 surf_network_model->common_public.states.running_action_set;
407 /* If there are no renning flows, just return */
408 if (time_to_next_flow_completion < 0.0) {
412 /*KF: if delta == time_to_next_flow_completion, too. */
413 if (time_to_next_flow_completion <= delta) { /* run until the first flow completes */
419 if (gtnets_run_until_next_flow_completion(&metadata, &num_flows)) {
421 "Cannot run GTNetS simulation until next flow completion");
425 "GTNetS simulation couldn't find a flow that would complete");
428 xbt_swag_foreach(action, running_actions) {
429 DEBUG2("Action (%p) remains old value: %f", action,
430 action->generic_action.remains);
431 double remain = gtnets_get_flow_rx(action);
432 DEBUG1("Remain value returned by GTNetS : %f", remain);
433 //need to trust this remain value
435 action->generic_action.remains = 0;
437 action->generic_action.remains = action->generic_action.cost - remain;
439 DEBUG2("Action (%p) remains new value: %f", action,
440 action->generic_action.remains);
443 for (i = 0; i < num_flows; i++) {
444 action = (surf_action_network_GTNETS_t) (metadata[i]);
446 action->generic_action.finish = now + time_to_next_flow_completion;
447 action_change_state((surf_action_t) action, SURF_ACTION_DONE);
448 DEBUG1("----> Action (%p) just terminated", action);
452 } else { /* run for a given number of seconds */
453 if (gtnets_run(delta)) {
454 xbt_assert0(0, "Cannot run GTNetS simulation");
461 /* UNUSED HERE: no traces */
462 static void update_resource_state(void *id,
463 tmgr_trace_event_t event_type,
464 double value, double date)
466 xbt_assert0(0, "Cannot update model state for GTNetS simulation");
470 /* KF: Rate not supported */
471 static surf_action_t communicate(void *src, void *dst, double size,
474 surf_action_network_GTNETS_t action = NULL;
475 network_card_GTNETS_t card_src = src;
476 network_card_GTNETS_t card_dst = dst;
478 int route_size = ROUTE_SIZE(card_src->id, card_dst->id);
479 network_link_GTNETS_t *route = ROUTE(card_src->id, card_dst->id);
483 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);
486 action = xbt_new0(s_surf_action_network_GTNETS_t, 1);
488 action->generic_action.refcount = 1;
489 action->generic_action.cost = size;
490 action->generic_action.remains = size;
491 /* Max durations are not supported */
492 action->generic_action.max_duration = NO_MAX_DURATION;
493 action->generic_action.start = surf_get_clock();
494 action->generic_action.finish = -1.0;
495 action->generic_action.model_type = (surf_model_t) surf_network_model;
497 action->generic_action.state_set =
498 surf_network_model->common_public.states.running_action_set;
500 xbt_swag_insert(action, action->generic_action.state_set);
502 /* KF: Add a flow to the GTNets Simulation, associated to this action */
503 if (gtnets_create_flow(card_src->id, card_dst->id, size, (void *) action)
505 xbt_assert2(0, "Not route between host %s and host %s", card_src->name,
509 return (surf_action_t) action;
512 /* Suspend a flow() */
513 static void action_suspend(surf_action_t action)
516 "action_suspend() not supported for the GTNets network model");
519 /* Resume a flow() */
520 static void action_resume(surf_action_t action)
523 "action_resume() not supported for the GTNets network model");
526 /* Test whether a flow is suspended */
527 static int action_is_suspended(surf_action_t action)
532 static void finalize(void)
534 xbt_dict_free(&network_card_set);
535 xbt_dict_free(&link_set);
537 surf_model_exit((surf_model_t)surf_network_model);
539 free(surf_network_model->extension_public);
541 free(surf_network_model);
542 surf_network_model = NULL;
547 static void surf_network_model_init_internal(void)
549 s_surf_action_t action;
551 surf_network_model = xbt_new0(s_surf_network_model_t, 1);
553 surf_model_init((surf_model_t)surf_network_model);
555 surf_network_model->extension_public =
556 xbt_new0(s_surf_network_model_extension_public_t, 1);
558 surf_network_model->common_public.name_service = name_service;
559 surf_network_model->common_public.get_resource_name = get_resource_name;
560 surf_network_model->common_public.action_get_state = surf_action_get_state;
561 surf_network_model->common_public.action_use = action_use;
562 surf_network_model->common_public.action_free = action_free;
563 surf_network_model->common_public.action_cancel = action_cancel;
564 surf_network_model->common_public.action_recycle = action_recycle;
565 surf_network_model->common_public.action_change_state =
567 surf_network_model->common_public.action_set_data = surf_action_set_data;
568 surf_network_model->common_public.name = "network";
570 surf_network_model->common_private->resource_used = resource_used;
571 surf_network_model->common_private->share_resources = share_resources;
572 surf_network_model->common_private->update_actions_state =
573 update_actions_state;
574 surf_network_model->common_private->update_resource_state =
575 update_resource_state;
576 surf_network_model->common_private->finalize = finalize;
578 surf_network_model->common_public.suspend = action_suspend;
579 surf_network_model->common_public.resume = action_resume;
580 surf_network_model->common_public.is_suspended = action_is_suspended;
582 surf_network_model->extension_public->communicate = communicate;
584 /*for the props of the link */
585 surf_network_model->common_public.get_properties = get_properties;
587 link_set = xbt_dict_new();
588 network_card_set = xbt_dict_new();
590 /* KF: Added the initialization for GTNetS interface */
591 if (gtnets_initialize()) {
592 xbt_assert0(0, "impossible to initialize GTNetS interface");
597 void surf_network_model_init_GTNETS(const char *filename)
599 if (surf_network_model)
601 surf_network_model_init_internal();
602 define_callbacks(filename);
603 xbt_dynar_push(model_list, &surf_network_model);
605 update_model_description(surf_network_model_description,
606 "GTNets", (surf_model_t) surf_network_model);