Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Use the same type name (network_link_GTNETS_t) as in the private header.
[simgrid.git] / src / surf / network_gtnets.c
1 /*      $Id$     */
2
3 /* Copyright (c) 2005 Henri Casanova. All rights reserved.                  */
4
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. */
7
8 #include "network_gtnets_private.h"
9 #include "gtnets/gtnets_interface.h"
10
11 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_network_gtnets, surf,
12                                 "Logging specific to the SURF network module");
13
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?
22  **/
23
24 /* Free memory for a network link */
25 static void link_free(void *nw_link)
26 {
27   free(((network_link_GTNETS_t) nw_link)->name);
28   free(nw_link);
29 }
30
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)
36 {
37   static int link_count = -1;
38   network_link_GTNETS_t gtnets_link;
39
40   /* If link already exists, nothing to do (FIXME: check that multiple definition match?) */
41   if (xbt_dict_get_or_null(link_set, name)) {
42     return;
43   }
44
45   /* KF: Increment the link counter for GTNetS */
46   link_count++;
47
48 /*
49   nw_link->model = (surf_model_t) surf_network_model;
50   nw_link->name = name;
51   nw_link->bw_current = bw_initial;
52   if (bw_trace)
53     nw_link->bw_event =
54         tmgr_history_add_trace(history, bw_trace, 0.0, 0, nw_link);
55   nw_link->lat_current = lat_initial;
56   if (lat_trace)
57     nw_link->lat_event =
58         tmgr_history_add_trace(history, lat_trace, 0.0, 0, nw_link);
59   nw_link->state_current = state_initial;
60   if (state_trace)
61     nw_link->state_event =
62         tmgr_history_add_trace(history, state_trace, 0.0, 0, nw_link);
63 */
64
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");
68   }
69
70   /* KF: Insert entry in the dictionary */
71   gtnets_link = xbt_new0(s_network_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;
78
79   xbt_dict_set(link_set, name, gtnets_link, link_free);
80
81   return;
82 }
83
84 /* free the network card */
85 static void network_card_free(void *nw_card)
86 {
87   free(((network_card_GTNETS_t) nw_card)->name);
88   free(nw_card);
89 }
90
91 /* Instantiate a new network card: MODIFYED BY KF */
92 static int network_card_new(const char *name)
93 {
94   static int card_count = -1;
95
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);
99
100   if (!card) {
101     /* KF: Increment the card counter for GTNetS */
102     card_count++;
103
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);
109   }
110
111   /* KF: just return the GTNetS ID as the SURF ID */
112   return card->id;
113 }
114
115 /* Instantiate a new route: MODIFY BY KF */
116 static void route_new(int src_id, int dst_id, char **links, int nb_link)
117 {
118 #if 0
119   network_link_GTNETS_t *link_list = NULL;
120   int i;
121
122   ROUTE_SIZE(src_id, dst_id) = nb_link;
123   link_list = (ROUTE(src_id, dst_id) =
124                xbt_new0(network_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]);
127     free(links[i]);
128   }
129   free(links);
130 #endif
131   int i;
132   int *gtnets_links;
133
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] =
138         ((network_link_GTNETS_t)
139          (xbt_dict_get(link_set, links[i])))->id;
140   }
141
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");
145   }
146 }
147
148 /* Instantiate a new route: MODIFY BY KF */
149 static void route_onehop_new(int src_id, int dst_id, char **links,
150                              int nb_link)
151 {
152   int linkid;
153
154   if (nb_link != 1) {
155     xbt_assert0(0, "In onehop_new, nb_link should be 1");
156   }
157
158   /* KF: Build the list of gtnets link IDs */
159   linkid =
160       ((network_link_GTNETS_t)
161        (xbt_dict_get(link_set, links[0])))->id;
162
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");
166   }
167 }
168
169
170
171 /* Parse the XML for a network link */
172 static void parse_link_init(void)
173 {
174   char *name;
175   double bw;
176   double lat;
177   e_surf_link_state_t state;
178
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;
183
184   /* Print values when no traces are specified */
185   {
186     tmgr_trace_t bw_trace;
187     tmgr_trace_t state_trace;
188     tmgr_trace_t lat_trace;
189
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);
193
194     /*TODO Where is WARNING0 defined??? */
195 #if 0
196     if (bw_trace)
197       WARNING0
198           ("The GTNetS network model doesn't support bandwidth state traces");
199     if (lat_trace)
200       WARNING0
201           ("The GTNetS network model doesn't support latency state traces");
202     if (state_trace)
203       WARNING0
204           ("The GTNetS network model doesn't support link state traces");
205 #endif
206   }
207   /* KF: remove several arguments to link_new */
208   current_property_set = xbt_dict_new();
209   link_new(name, bw, lat, current_property_set);
210 }
211
212 static int nb_link = 0;
213 static char **link_name = NULL;
214 static int src_id = -1;
215 static int dst_id = -1;
216
217 /* Parses a route from the XML: UNMODIFIED BY HC */
218 static void parse_route_set_endpoints(void)
219 {
220   src_id = network_card_new(A_surfxml_route_src);
221   dst_id = network_card_new(A_surfxml_route_dst);
222
223 /*  nb_link = 0;
224   link_name = NULL;
225 */
226   route_link_list = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
227 }
228
229 /* KF*/
230 static void parse_route_set_routers(void)
231 {
232   int id = network_card_new(A_surfxml_router_name);
233
234   /* KF: Create the GTNets router */
235   if (gtnets_add_router(id)) {
236     xbt_assert0(0, "Cannot add GTNetS router");
237   }
238 }
239
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)
243 {
244   nb_link++;
245   link_name = xbt_realloc(link_name, (nb_link) * sizeof(char *));
246   link_name[(nb_link) - 1] = xbt_strdup(A_surfxml_route_element_name);
247 }
248 */
249
250 /* Create the route (more than one hops): MODIFIED BY KF */
251 static void parse_route_set_route(void)
252 {
253 /*  if (nb_link > 1)
254     route_new(src_id, dst_id, link_name, nb_link);
255 */
256     name = bprintf("%x#%x",src_id, dst_id);
257     xbt_dict_set(route_table, name, route_link_list, NULL);
258     free(name);    
259 }
260
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)
264 {
265   if (nb_link == 1)
266     route_onehop_new(src_id, dst_id, link_name, nb_link);
267 }
268
269 static void add_route()
270 {
271   xbt_ex_t e;
272   unsigned int cpt = 0;    
273   int i = 0;
274   xbt_dict_cursor_t cursor = NULL;
275   char *key,*data, *end;
276   const char *sep = "#";
277   xbt_dynar_t links, keys;
278
279   xbt_dict_foreach(route_table, cursor, key, data) {
280     nb_link = 0;
281     links = (xbt_dynar_t)data;
282     keys = xbt_str_split_str(key, sep);
283
284     nb_link = xbt_dynar_length(links);
285     link_name = xbt_realloc(link_name, (nb_link) * sizeof(char *));
286
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);
289   
290     i = 0;
291     char* link = NULL;
292     xbt_dynar_foreach (links, cpt, link) {
293       TRY {
294         link_name[i++] = xbt_dict_get(link_set, link);
295       }
296       CATCH(e) {
297         RETHROW1("Link %s not found (dict raised this exception: %s)", link);
298       }     
299     }
300     if (nb_link > 1)
301       route_new(src_id, dst_id, link_name, nb_link);
302     if (nb_link == 1)
303       route_onehop_new(src_id, dst_id, link_name, nb_link);
304    }
305
306    xbt_dict_free(&route_table);
307 }
308
309 /* Main XML parsing */
310 static void define_callbacks(const char *file)
311 {
312   surfxml_add_callback(STag_surfxml_prop_cb_list, &parse_properties);
313   surfxml_add_callback(STag_surfxml_router_cb_list, &parse_route_set_routers);
314   surfxml_add_callback(STag_surfxml_link_cb_list, &parse_link_init);
315   surfxml_add_callback(STag_surfxml_route_cb_list, &parse_route_set_endpoints);
316   surfxml_add_callback(ETag_surfxml_route_element_cb_list, &parse_route_elem);
317 /* surfxml_add_callback(ETag_surfxml_route_cb_list, &parse_route_set_onehop_route);*/
318   surfxml_add_callback(STag_surfxml_platform_cb_list, &init_data);
319   surfxml_add_callback(ETag_surfxml_route_cb_list, &parse_route_set_route);
320   surfxml_add_callback(ETag_surfxml_platform_cb_list, &add_route);
321   surfxml_add_callback(STag_surfxml_set_cb_list, &parse_sets);
322   surfxml_add_callback(STag_surfxml_route_c_multi_cb_list, &parse_route_multi_set_endpoints);
323   surfxml_add_callback(ETag_surfxml_route_c_multi_cb_list, &parse_route_multi_set_route);
324   surfxml_add_callback(STag_surfxml_foreach_cb_list, &parse_foreach);
325   surfxml_add_callback(STag_surfxml_cluster_cb_list, &parse_cluster);
326 }
327
328 static void *name_service(const char *name)
329 {
330   return xbt_dict_get_or_null(network_card_set, name);
331 }
332
333 static const char *get_resource_name(void *resource_id)
334 {
335   return ((network_card_GTNETS_t) resource_id)->name;
336 }
337
338 static xbt_dict_t get_properties(void *link)
339 {
340   return ((network_card_GTNETS_t) link)->properties;
341 }
342
343
344 /* We do not care about this: only used for traces */
345 static int resource_used(void *resource_id)
346 {
347   return 0;                     /* We don't care */
348 }
349
350 static int action_free(surf_action_t action)
351 {
352   action->using--;
353   if (!action->using) {
354     xbt_swag_remove(action, action->state_set);
355     /* KF: No explicit freeing needed for GTNeTS here */
356     free(action);
357     return 1;
358   }
359   return 0;
360 }
361
362 static void action_use(surf_action_t action)
363 {
364   action->using++;
365 }
366
367 static void action_cancel(surf_action_t action)
368 {
369   xbt_assert0(0, "Cannot cancel GTNetS flow");
370   return;
371 }
372
373 static void action_recycle(surf_action_t action)
374 {
375   xbt_assert0(0, "Cannot recycle GTNetS flow");
376   return;
377 }
378
379 static void action_change_state(surf_action_t action,
380                                 e_surf_action_state_t state)
381 {
382 /*   if((state==SURF_ACTION_DONE) || (state==SURF_ACTION_FAILED)) */
383 /*     if(((surf_action_network_GTNETS_t)action)->variable) { */
384 /*       lmm_variable_disable(maxmin_system, ((surf_action_network_GTNETS_t)action)->variable); */
385 /*       ((surf_action_network_GTNETS_t)action)->variable = NULL; */
386 /*     } */
387
388   surf_action_change_state(action, state);
389   return;
390 }
391
392
393 /* share_resources() */
394 static double share_resources(double now)
395 {
396 #if 0
397   s_surf_action_network_GTNETS_t s_action;
398   surf_action_network_GTNETS_t action = NULL;
399   xbt_swag_t running_actions =
400       surf_network_model->common_public->states.running_action_set;
401 #endif
402
403   return gtnets_get_time_to_next_flow_completion();
404 }
405
406 /* delta: by how many time units the simulation must advance */
407 /* In this function: change the state of actions that terminate */
408 /* The delta may not come from the network, and thus may be different (smaller) 
409    than the one returned by the function above */
410 /* If the delta is a network-caused min, then do not emulate any timer in the
411    network simulation, otherwise fake a timer somehow to advance the simulation of min seconds */
412
413 static void update_actions_state(double now, double delta)
414 {
415 #if 0
416   surf_action_network_GTNETS_t action = NULL;
417   surf_action_network_GTNETS_t next_action = NULL;
418   xbt_swag_t running_actions =
419       surf_network_model->common_public->states.running_action_set;
420 #endif
421
422   double time_to_next_flow_completion =
423       gtnets_get_time_to_next_flow_completion();
424
425   /* If there are no renning flows, just return */
426   if (time_to_next_flow_completion < 0.0) {
427     return;
428   }
429
430   /*KF: if delta == time_to_next_flow_completion, too. */
431   if (time_to_next_flow_completion <= delta) {  /* run until the first flow completes */
432     void **metadata;
433     int i, num_flows;
434
435     num_flows = 0;
436
437     if (gtnets_run_until_next_flow_completion(&metadata, &num_flows)) {
438       xbt_assert0(0,
439                   "Cannot run GTNetS simulation until next flow completion");
440     }
441     if (num_flows < 1) {
442       xbt_assert0(0,
443                   "GTNetS simulation couldn't find a flow that would complete");
444     }
445
446     for (i = 0; i < num_flows; i++) {
447       surf_action_network_GTNETS_t action =
448           (surf_action_network_GTNETS_t) (metadata[i]);
449
450       action->generic_action.remains = 0;
451       action->generic_action.finish = now + time_to_next_flow_completion;
452       action_change_state((surf_action_t) action, SURF_ACTION_DONE);
453       /* TODO: Anything else here? */
454     }
455   } else {                      /* run for a given number of seconds */
456     if (gtnets_run(delta)) {
457       xbt_assert0(0, "Cannot run GTNetS simulation");
458     }
459   }
460
461   return;
462 }
463
464 /* UNUSED HERE: no traces */
465 static void update_resource_state(void *id,
466                                   tmgr_trace_event_t event_type,
467                                   double value)
468 {
469   xbt_assert0(0, "Cannot update model state for GTNetS simulation");
470   return;
471 }
472
473 /* KF: Rate not supported */
474 static surf_action_t communicate(void *src, void *dst, double size,
475                                  double rate)
476 {
477   surf_action_network_GTNETS_t action = NULL;
478   network_card_GTNETS_t card_src = src;
479   network_card_GTNETS_t card_dst = dst;
480 /*
481   int route_size = ROUTE_SIZE(card_src->id, card_dst->id);
482   network_link_GTNETS_t *route = ROUTE(card_src->id, card_dst->id);
483 */
484
485 /*
486   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);
487 */
488
489   action = xbt_new0(s_surf_action_network_GTNETS_t, 1);
490
491   action->generic_action.using = 1;
492   action->generic_action.cost = size;
493   action->generic_action.remains = size;
494   /* Max durations are not supported */
495   action->generic_action.max_duration = NO_MAX_DURATION;
496   action->generic_action.start = surf_get_clock();
497   action->generic_action.finish = -1.0;
498   action->generic_action.model_type =
499       (surf_model_t) surf_network_model;
500
501   action->generic_action.state_set =
502       surf_network_model->common_public->states.running_action_set;
503
504   xbt_swag_insert(action, action->generic_action.state_set);
505
506   /* KF: Add a flow to the GTNets Simulation, associated to this action */
507   if (gtnets_create_flow(card_src->id, card_dst->id, size, (void *) action)
508       < 0) {
509     xbt_assert2(0, "Not route between host %s and host %s", card_src->name,
510                 card_dst->name);
511   }
512
513   return (surf_action_t) action;
514 }
515
516 /* Suspend a flow() */
517 static void action_suspend(surf_action_t action)
518 {
519   xbt_assert0(0,
520               "action_suspend() not supported for the GTNets network model");
521 }
522
523 /* Resume a flow() */
524 static void action_resume(surf_action_t action)
525 {
526   xbt_assert0(0,
527               "action_resume() not supported for the GTNets network model");
528 }
529
530 /* Test whether a flow is suspended */
531 static int action_is_suspended(surf_action_t action)
532 {
533   return 0;
534 }
535
536 static void finalize(void)
537 {
538 #if 0
539   int i, j;
540 #endif
541   xbt_dict_free(&network_card_set);
542   xbt_dict_free(&link_set);
543   xbt_swag_free(surf_network_model->common_public->states.
544                 ready_action_set);
545   xbt_swag_free(surf_network_model->common_public->states.
546                 running_action_set);
547   xbt_swag_free(surf_network_model->common_public->states.
548                 failed_action_set);
549   xbt_swag_free(surf_network_model->common_public->states.
550                 done_action_set);
551   free(surf_network_model->common_public);
552   free(surf_network_model->common_private);
553   free(surf_network_model->extension_public);
554
555   free(surf_network_model);
556   surf_network_model = NULL;
557
558 #if 0
559   for (i = 0; i < card_number; i++)
560     for (j = 0; j < card_number; j++)
561       free(ROUTE(i, j));
562   free(routing_table);
563   routing_table = NULL;
564   free(routing_table_size);
565   routing_table_size = NULL;
566   card_number = 0;
567 #endif
568
569   /* ADDED BY KF */
570   gtnets_finalize();
571   /* END ADDITION */
572 }
573
574 static void surf_network_model_init_internal(void)
575 {
576   s_surf_action_t action;
577
578   surf_network_model = xbt_new0(s_surf_network_model_t, 1);
579
580   surf_network_model->common_private =
581       xbt_new0(s_surf_model_private_t, 1);
582   surf_network_model->common_public =
583       xbt_new0(s_surf_model_public_t, 1);
584   surf_network_model->extension_public =
585       xbt_new0(s_surf_network_model_extension_public_t, 1);
586
587   surf_network_model->common_public->states.ready_action_set =
588       xbt_swag_new(xbt_swag_offset(action, state_hookup));
589   surf_network_model->common_public->states.running_action_set =
590       xbt_swag_new(xbt_swag_offset(action, state_hookup));
591   surf_network_model->common_public->states.failed_action_set =
592       xbt_swag_new(xbt_swag_offset(action, state_hookup));
593   surf_network_model->common_public->states.done_action_set =
594       xbt_swag_new(xbt_swag_offset(action, state_hookup));
595
596   surf_network_model->common_public->name_service = name_service;
597   surf_network_model->common_public->get_resource_name =
598       get_resource_name;
599   surf_network_model->common_public->action_get_state =
600       surf_action_get_state;
601   surf_network_model->common_public->action_use = action_use;
602   surf_network_model->common_public->action_free = action_free;
603   surf_network_model->common_public->action_cancel = action_cancel;
604   surf_network_model->common_public->action_recycle = action_recycle;
605   surf_network_model->common_public->action_change_state =
606       action_change_state;
607   surf_network_model->common_public->action_set_data =
608       surf_action_set_data;
609   surf_network_model->common_public->name = "network";
610
611   surf_network_model->common_private->resource_used = resource_used;
612   surf_network_model->common_private->share_resources = share_resources;
613   surf_network_model->common_private->update_actions_state =
614       update_actions_state;
615   surf_network_model->common_private->update_resource_state =
616       update_resource_state;
617   surf_network_model->common_private->finalize = finalize;
618
619   surf_network_model->common_public->suspend = action_suspend;
620   surf_network_model->common_public->resume = action_resume;
621   surf_network_model->common_public->is_suspended = action_is_suspended;
622
623   surf_network_model->extension_public->communicate = communicate;
624
625   /*for the props of the link*/
626   surf_network_model->common_public->get_properties =  get_properties;
627
628   link_set = xbt_dict_new();
629   network_card_set = xbt_dict_new();
630
631   /* KF: Added the initialization for GTNetS interface */
632   if (gtnets_initialize()) {
633     xbt_assert0(0, "impossible to initialize GTNetS interface");
634   }
635 }
636
637 void surf_network_model_init_GTNETS(const char *filename)
638 {
639   if (surf_network_model)
640     return;
641   surf_network_model_init_internal();
642   define_callbacks(filename);
643   xbt_dynar_push(model_list, &surf_network_model);
644
645   update_model_description(surf_network_model_description,
646                               surf_network_model_description_size,
647                               "GTNets",
648                               (surf_model_t) surf_network_model);
649 }