src/surf/network.c

   1 /*      $Id$     */
   2
   3 /* Copyright (c) 2004 Arnaud Legrand. 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_private.h"
   9
  10 #define SG_TCP_CTE_GAMMA 20000.0
  11
  12 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(network, surf,
  13                                 "Logging specific to the SURF network module");
  14
  15 surf_network_resource_t surf_network_resource = NULL;
  16
  17 static xbt_dict_t network_link_set = NULL;
  18 xbt_dict_t network_card_set = NULL;
  19
  20 int card_number = 0;
  21 network_link_CM02_t **routing_table = NULL;
  22 int *routing_table_size = NULL;
  23 static network_link_CM02_t loopback = NULL;
  24
  25 static void create_routing_table(void)
  26 {
  27   routing_table = xbt_new0(network_link_CM02_t *, card_number * card_number);
  28   routing_table_size = xbt_new0(int, card_number * card_number);
  29 }
  30
  31 static void network_link_free(void *nw_link)
  32 {
  33   free(((network_link_CM02_t)nw_link)->name);
  34   free(nw_link);
  35 }
  36
  37 static network_link_CM02_t network_link_new(char *name,
  38                                        double bw_initial,
  39                                        tmgr_trace_t bw_trace,
  40                                        double lat_initial,
  41                                        tmgr_trace_t lat_trace,
  42                                        e_surf_network_link_state_t
  43                                        state_initial,
  44                                        tmgr_trace_t state_trace,
  45                                        e_surf_network_link_sharing_policy_t policy)
  46 {
  47   network_link_CM02_t nw_link = xbt_new0(s_network_link_CM02_t, 1);
  48
  49
  50   nw_link->resource = (surf_resource_t) surf_network_resource;
  51   nw_link->name = name;
  52   nw_link->bw_current = bw_initial;
  53   if (bw_trace)
  54     nw_link->bw_event =
  55         tmgr_history_add_trace(history, bw_trace, 0.0, 0, nw_link);
  56   nw_link->lat_current = lat_initial;
  57   if (lat_trace)
  58     nw_link->lat_event =
  59         tmgr_history_add_trace(history, lat_trace, 0.0, 0, nw_link);
  60   nw_link->state_current = state_initial;
  61   if (state_trace)
  62     nw_link->state_event =
  63         tmgr_history_add_trace(history, state_trace, 0.0, 0, nw_link);
  64
  65   nw_link->constraint =
  66       lmm_constraint_new(maxmin_system, nw_link, nw_link->bw_current);
  67
  68   if(policy == SURF_NETWORK_LINK_FATPIPE)
  69     lmm_constraint_shared(nw_link->constraint);
  70
  71   xbt_dict_set(network_link_set, name, nw_link, network_link_free);
  72
  73   return nw_link;
  74 }
  75
  76 static void network_card_free(void *nw_card)
  77 {
  78   free(((network_card_CM02_t)nw_card)->name);
  79   free(nw_card);
  80 }
  81
  82 static int network_card_new(const char *card_name)
  83 {
  84   network_card_CM02_t card = xbt_dict_get_or_null(network_card_set, card_name);
  85
  86   if (!card) {
  87     card = xbt_new0(s_network_card_CM02_t, 1);
  88     card->name = xbt_strdup(card_name);
  89     card->id = card_number++;
  90     xbt_dict_set(network_card_set, card_name, card, network_card_free);
  91   }
  92   return card->id;
  93 }
  94
  95 static void route_new(int src_id, int dst_id, char **links, int nb_link)
  96 {
  97   network_link_CM02_t *link_list = NULL;
  98   int i;
  99
 100   ROUTE_SIZE(src_id, dst_id) = nb_link;
 101   link_list = (ROUTE(src_id, dst_id) = xbt_new0(network_link_CM02_t, nb_link));
 102   for (i = 0; i < nb_link; i++) {
 103     link_list[i] = xbt_dict_get_or_null(network_link_set, links[i]);
 104     xbt_assert1(link_list[i],"Invalid link name \"%s\"",links[i]);
 105     free(links[i]);
 106   }
 107   free(links);
 108 }
 109
 110 static void parse_network_link(void)
 111 {
 112   char *name;
 113   double bw_initial;
 114   tmgr_trace_t bw_trace;
 115   double lat_initial;
 116   tmgr_trace_t lat_trace;
 117   e_surf_network_link_state_t state_initial = SURF_NETWORK_LINK_ON;
 118   e_surf_network_link_sharing_policy_t policy_initial = SURF_NETWORK_LINK_SHARED;
 119   tmgr_trace_t state_trace;
 120
 121   name = xbt_strdup(A_network_link_name);
 122   surf_parse_get_double(&bw_initial,A_network_link_bandwidth);
 123   surf_parse_get_trace(&bw_trace, A_network_link_bandwidth_file);
 124   surf_parse_get_double(&lat_initial,A_network_link_latency);
 125   surf_parse_get_trace(&lat_trace, A_network_link_latency_file);
 126
 127   xbt_assert0((A_network_link_state==A_network_link_state_ON)||
 128               (A_network_link_state==A_network_link_state_OFF),
 129               "Invalid state")
 130   if (A_network_link_state==A_network_link_state_ON)
 131     state_initial = SURF_NETWORK_LINK_ON;
 132   else if (A_network_link_state==A_network_link_state_OFF)
 133     state_initial = SURF_NETWORK_LINK_OFF;
 134
 135   if (A_network_link_sharing_policy==A_network_link_sharing_policy_SHARED)
 136     policy_initial = SURF_NETWORK_LINK_SHARED;
 137   else if (A_network_link_sharing_policy==A_network_link_sharing_policy_FATPIPE)
 138     policy_initial = SURF_NETWORK_LINK_FATPIPE;
 139
 140   surf_parse_get_trace(&state_trace,A_network_link_state_file);
 141
 142   network_link_new(name, bw_initial, bw_trace,
 143                    lat_initial, lat_trace, state_initial, state_trace,
 144                    policy_initial);
 145 }
 146
 147 static int nb_link = 0;
 148 static char **link_name = NULL;
 149 static int src_id = -1;
 150 static int dst_id = -1;
 151
 152 static void parse_route_set_endpoints(void)
 153 {
 154   src_id = network_card_new(A_route_src);
 155   dst_id = network_card_new(A_route_dst);
 156   nb_link = 0;
 157   link_name = NULL;
 158 }
 159
 160 static void parse_route_elem(void)
 161 {
 162   nb_link++;
 163   link_name = xbt_realloc(link_name, (nb_link) * sizeof(char *));
 164   link_name[(nb_link) - 1] = xbt_strdup(A_route_element_name);
 165 }
 166
 167 static void parse_route_set_route(void)
 168 {
 169   route_new(src_id, dst_id, link_name, nb_link);
 170 }
 171
 172 static void parse_file(const char *file)
 173 {
 174   int i;
 175
 176   /* Figuring out the network links */
 177   surf_parse_reset_parser();
 178   ETag_network_link_fun=parse_network_link;
 179   surf_parse_open(file);
 180   xbt_assert1((!surf_parse()),"Parse error in %s",file);
 181   surf_parse_close();
 182
 183   /* Figuring out the network cards used */
 184   surf_parse_reset_parser();
 185   STag_route_fun=parse_route_set_endpoints;
 186   surf_parse_open(file);
 187   xbt_assert1((!surf_parse()),"Parse error in %s",file);
 188   surf_parse_close();
 189
 190   create_routing_table();
 191
 192   /* Building the routes */
 193   surf_parse_reset_parser();
 194   STag_route_fun=parse_route_set_endpoints;
 195   ETag_route_element_fun=parse_route_elem;
 196   ETag_route_fun=parse_route_set_route;
 197   surf_parse_open(file);
 198   xbt_assert1((!surf_parse()),"Parse error in %s",file);
 199   surf_parse_close();
 200
 201   /* Adding loopback if needed */
 202
 203   for (i = 0; i < card_number; i++)
 204     if(!ROUTE_SIZE(i,i)) {
 205       if(!loopback)
 206         loopback = network_link_new(xbt_strdup("__MSG_loopback__"),
 207                                    498.00, NULL, 0.000015, NULL,
 208                                    SURF_NETWORK_LINK_ON, NULL,
 209                                    SURF_NETWORK_LINK_FATPIPE);
 210       ROUTE_SIZE(i,i)=1;
 211       ROUTE(i,i) = xbt_new0(network_link_CM02_t, 1);
 212       ROUTE(i,i)[0] = loopback;
 213     }
 214 }
 215
 216 static void *name_service(const char *name)
 217 {
 218   network_card_CM02_t card = xbt_dict_get_or_null(network_card_set, name);
 219   return card;
 220 }
 221
 222 static const char *get_resource_name(void *resource_id)
 223 {
 224   return ((network_card_CM02_t) resource_id)->name;
 225 }
 226
 227 static int resource_used(void *resource_id)
 228 {
 229   return lmm_constraint_used(maxmin_system,
 230                              ((network_link_CM02_t) resource_id)->constraint);
 231 }
 232
 233 static int action_free(surf_action_t action)
 234 {
 235   action->using--;
 236   if(!action->using) {
 237     xbt_swag_remove(action, action->state_set);
 238     if(((surf_action_network_CM02_t)action)->variable)
 239       lmm_variable_free(maxmin_system, ((surf_action_network_CM02_t)action)->variable);
 240     free(action);
 241     return 1;
 242   }
 243   return 0;
 244 }
 245
 246 static void action_use(surf_action_t action)
 247 {
 248   action->using++;
 249 }
 250
 251 static void action_cancel(surf_action_t action)
 252 {
 253   return;
 254 }
 255
 256 static void action_recycle(surf_action_t action)
 257 {
 258   return;
 259 }
 260
 261 static void action_change_state(surf_action_t action,
 262                                 e_surf_action_state_t state)
 263 {
 264 /*   if((state==SURF_ACTION_DONE) || (state==SURF_ACTION_FAILED)) */
 265 /*     if(((surf_action_network_CM02_t)action)->variable) { */
 266 /*       lmm_variable_disable(maxmin_system, ((surf_action_network_CM02_t)action)->variable); */
 267 /*       ((surf_action_network_CM02_t)action)->variable = NULL; */
 268 /*     } */
 269
 270   surf_action_change_state(action, state);
 271   return;
 272 }
 273
 274 static double share_resources(double now)
 275 {
 276   s_surf_action_network_CM02_t s_action;
 277   surf_action_network_CM02_t action = NULL;
 278   xbt_swag_t running_actions = surf_network_resource->common_public->states.running_action_set;
 279   double min = generic_maxmin_share_resources(running_actions,
 280                                               xbt_swag_offset(s_action, variable));
 281
 282   xbt_swag_foreach(action, running_actions) {
 283     if(action->latency>0) {
 284       if(min<0) min = action->latency;
 285       else if (action->latency<min) min = action->latency;
 286     }
 287   }
 288
 289   return min;
 290 }
 291
 292 static void update_actions_state(double now, double delta)
 293 {
 294   double deltap = 0.0;
 295   surf_action_network_CM02_t action = NULL;
 296   surf_action_network_CM02_t next_action = NULL;
 297   xbt_swag_t running_actions =
 298       surf_network_resource->common_public->states.running_action_set;
 299   /*
 300   xbt_swag_t failed_actions =
 301       surf_network_resource->common_public->states.failed_action_set;
 302   */
 303
 304   xbt_swag_foreach_safe(action, next_action, running_actions) {
 305     deltap = delta;
 306     if (action->latency > 0) {
 307       if (action->latency > deltap) {
 308         surf_double_update(&(action->latency),deltap);
 309         deltap = 0.0;
 310       } else {
 311         surf_double_update(&(deltap), action->latency);
 312         action->latency = 0.0;
 313       }
 314       if ((action->latency == 0.0) && !(action->suspended))
 315         lmm_update_variable_weight(maxmin_system, action->variable, 1.0);
 316     }
 317     surf_double_update(&(action->generic_action.remains),
 318         lmm_variable_getvalue(action->variable) * deltap);
 319     if (action->generic_action.max_duration != NO_MAX_DURATION)
 320       surf_double_update(&(action->generic_action.max_duration), delta);
 321
 322     /*   if(action->generic_action.remains<.00001) action->generic_action.remains=0; */
 323
 324     if (action->generic_action.remains <= 0) {
 325       action->generic_action.finish = surf_get_clock();
 326       action_change_state((surf_action_t) action, SURF_ACTION_DONE);
 327     } else if ((action->generic_action.max_duration != NO_MAX_DURATION) &&
 328                (action->generic_action.max_duration <= 0)) {
 329       action->generic_action.finish = surf_get_clock();
 330       action_change_state((surf_action_t) action, SURF_ACTION_DONE);
 331     } else {                    /* Need to check that none of the resource has failed */
 332       lmm_constraint_t cnst = NULL;
 333       int i = 0;
 334       network_link_CM02_t nw_link = NULL;
 335
 336       while ((cnst =
 337               lmm_get_cnst_from_var(maxmin_system, action->variable,
 338                                     i++))) {
 339         nw_link = lmm_constraint_id(cnst);
 340         if (nw_link->state_current == SURF_NETWORK_LINK_OFF) {
 341           action->generic_action.finish = surf_get_clock();
 342           action_change_state((surf_action_t) action, SURF_ACTION_FAILED);
 343           break;
 344         }
 345       }
 346     }
 347   }
 348
 349   return;
 350 }
 351
 352 static void update_resource_state(void *id,
 353                                   tmgr_trace_event_t event_type,
 354                                   double value)
 355 {
 356   network_link_CM02_t nw_link = id;
 357   /*   printf("[" "%lg" "] Asking to update network card \"%s\" with value " */
 358   /*     "%lg" " for event %p\n", surf_get_clock(), nw_link->name, */
 359   /*     value, event_type); */
 360
 361   if (event_type == nw_link->bw_event) {
 362     nw_link->bw_current = value;
 363     lmm_update_constraint_bound(maxmin_system, nw_link->constraint,
 364                                 nw_link->bw_current);
 365   } else if (event_type == nw_link->lat_event) {
 366     double delta = value - nw_link->lat_current;
 367     lmm_variable_t var = NULL;
 368     surf_action_network_CM02_t action = NULL;
 369
 370     nw_link->lat_current = value;
 371     while (lmm_get_var_from_cnst(maxmin_system, nw_link->constraint, &var)) {
 372       action = lmm_variable_id(var);
 373       action->lat_current += delta;
 374       if(action->rate<0)
 375         lmm_update_variable_bound(maxmin_system, action->variable,
 376                                   SG_TCP_CTE_GAMMA / action->lat_current);
 377       else
 378         lmm_update_variable_bound(maxmin_system, action->variable,
 379                                   min(action->rate,SG_TCP_CTE_GAMMA / action->lat_current));
 380     }
 381   } else if (event_type == nw_link->state_event) {
 382     if (value > 0)
 383       nw_link->state_current = SURF_NETWORK_LINK_ON;
 384     else
 385       nw_link->state_current = SURF_NETWORK_LINK_OFF;
 386   } else {
 387     CRITICAL0("Unknown event ! \n");
 388     xbt_abort();
 389   }
 390
 391   return;
 392 }
 393
 394 static surf_action_t communicate(void *src, void *dst, double size, double rate)
 395 {
 396   surf_action_network_CM02_t action = NULL;
 397   network_card_CM02_t card_src = src;
 398   network_card_CM02_t card_dst = dst;
 399   int route_size = ROUTE_SIZE(card_src->id, card_dst->id);
 400   network_link_CM02_t *route = ROUTE(card_src->id, card_dst->id);
 401   int i;
 402
 403   action = xbt_new0(s_surf_action_network_CM02_t, 1);
 404
 405   action->generic_action.using = 1;
 406   action->generic_action.cost = size;
 407   action->generic_action.remains = size;
 408   action->generic_action.max_duration = NO_MAX_DURATION;
 409   action->generic_action.start = -1.0;
 410   action->generic_action.finish = -1.0;
 411   action->generic_action.resource_type =
 412       (surf_resource_t) surf_network_resource;
 413   action->suspended = 0;  /* Should be useless because of the
 414                              calloc but it seems to help valgrind... */
 415   action->generic_action.state_set =
 416       surf_network_resource->common_public->states.running_action_set;
 417
 418   xbt_swag_insert(action, action->generic_action.state_set);
 419   action->rate = rate;
 420
 421   action->latency = 0.0;
 422   for (i = 0; i < route_size; i++)
 423     action->latency += route[i]->lat_current;
 424   action->lat_current = action->latency;
 425
 426   if(action->latency>0)
 427     action->variable = lmm_variable_new(maxmin_system, action, 0.0, -1.0,
 428                                         route_size);
 429   else
 430     action->variable = lmm_variable_new(maxmin_system, action, 1.0, -1.0,
 431                                         route_size);
 432
 433   if(action->rate<0) {
 434     if(action->lat_current>0)
 435       lmm_update_variable_bound(maxmin_system, action->variable,
 436                                 SG_TCP_CTE_GAMMA / action->lat_current);
 437     else
 438       lmm_update_variable_bound(maxmin_system, action->variable, -1.0);
 439   } else {
 440     if(action->lat_current>0)
 441       lmm_update_variable_bound(maxmin_system, action->variable,
 442                                 min(action->rate,SG_TCP_CTE_GAMMA / action->lat_current));
 443     else
 444       lmm_update_variable_bound(maxmin_system, action->variable, action->rate);
 445   }
 446
 447   for (i = 0; i < route_size; i++)
 448     lmm_expand(maxmin_system, route[i]->constraint, action->variable, 1.0);
 449
 450   if(route_size == 0) {
 451     action_change_state((surf_action_t) action, SURF_ACTION_DONE);
 452   }
 453
 454   return (surf_action_t) action;
 455 }
 456
 457 static void action_suspend(surf_action_t action)
 458 {
 459   ((surf_action_network_CM02_t) action)->suspended = 1;
 460   lmm_update_variable_weight(maxmin_system,
 461                              ((surf_action_network_CM02_t) action)->variable, 0.0);
 462 }
 463
 464 static void action_resume(surf_action_t action)
 465 {
 466   lmm_update_variable_weight(maxmin_system,
 467                              ((surf_action_network_CM02_t) action)->variable, 1.0);
 468   ((surf_action_network_CM02_t) action)->suspended = 0;
 469 }
 470
 471 static int action_is_suspended(surf_action_t action)
 472 {
 473   return ((surf_action_network_CM02_t) action)->suspended;
 474 }
 475
 476 static void action_set_max_duration(surf_action_t action, double duration)
 477 {
 478   action->max_duration = duration;
 479 }
 480
 481 static void finalize(void)
 482 {
 483   int i,j;
 484
 485   xbt_dict_free(&network_card_set);
 486   xbt_dict_free(&network_link_set);
 487   xbt_swag_free(surf_network_resource->common_public->states.
 488                 ready_action_set);
 489   xbt_swag_free(surf_network_resource->common_public->states.
 490                 running_action_set);
 491   xbt_swag_free(surf_network_resource->common_public->states.
 492                 failed_action_set);
 493   xbt_swag_free(surf_network_resource->common_public->states.
 494                 done_action_set);
 495   free(surf_network_resource->common_public);
 496   free(surf_network_resource->common_private);
 497   free(surf_network_resource->extension_public);
 498
 499   free(surf_network_resource);
 500   surf_network_resource = NULL;
 501
 502   loopback = NULL;
 503   for (i = 0; i < card_number; i++)
 504     for (j = 0; j < card_number; j++)
 505       free(ROUTE(i,j));
 506   free(routing_table);
 507   routing_table = NULL;
 508   free(routing_table_size);
 509   routing_table_size = NULL;
 510   card_number = 0;
 511 }
 512
 513 static void surf_network_resource_init_internal(void)
 514 {
 515   s_surf_action_t action;
 516
 517   surf_network_resource = xbt_new0(s_surf_network_resource_t, 1);
 518
 519   surf_network_resource->common_private =
 520       xbt_new0(s_surf_resource_private_t, 1);
 521   surf_network_resource->common_public =
 522       xbt_new0(s_surf_resource_public_t, 1);
 523   surf_network_resource->extension_public =
 524       xbt_new0(s_surf_network_resource_extension_public_t, 1);
 525
 526   surf_network_resource->common_public->states.ready_action_set =
 527       xbt_swag_new(xbt_swag_offset(action, state_hookup));
 528   surf_network_resource->common_public->states.running_action_set =
 529       xbt_swag_new(xbt_swag_offset(action, state_hookup));
 530   surf_network_resource->common_public->states.failed_action_set =
 531       xbt_swag_new(xbt_swag_offset(action, state_hookup));
 532   surf_network_resource->common_public->states.done_action_set =
 533       xbt_swag_new(xbt_swag_offset(action, state_hookup));
 534
 535   surf_network_resource->common_public->name_service = name_service;
 536   surf_network_resource->common_public->get_resource_name =
 537       get_resource_name;
 538   surf_network_resource->common_public->action_get_state =
 539       surf_action_get_state;
 540   surf_network_resource->common_public->action_free = action_free;
 541   surf_network_resource->common_public->action_use = action_use;
 542   surf_network_resource->common_public->action_cancel = action_cancel;
 543   surf_network_resource->common_public->action_recycle = action_recycle;
 544   surf_network_resource->common_public->action_change_state =
 545       action_change_state;
 546   surf_network_resource->common_public->action_set_data = surf_action_set_data;
 547   surf_network_resource->common_public->name = "network";
 548
 549   surf_network_resource->common_private->resource_used = resource_used;
 550   surf_network_resource->common_private->share_resources = share_resources;
 551   surf_network_resource->common_private->update_actions_state =
 552       update_actions_state;
 553   surf_network_resource->common_private->update_resource_state =
 554       update_resource_state;
 555   surf_network_resource->common_private->finalize = finalize;
 556
 557   surf_network_resource->common_public->suspend = action_suspend;
 558   surf_network_resource->common_public->resume = action_resume;
 559   surf_network_resource->common_public->is_suspended = action_is_suspended;
 560   surf_cpu_resource->common_public->set_max_duration = action_set_max_duration;
 561
 562   surf_network_resource->extension_public->communicate = communicate;
 563
 564   network_link_set = xbt_dict_new();
 565   network_card_set = xbt_dict_new();
 566
 567   xbt_assert0(maxmin_system, "surf_init has to be called first!");
 568 }
 569
 570 /***************************************************************************/
 571 /* The nice TCP sharing model designed by Loris Marchal and Henri Casanova */
 572 /***************************************************************************/
 573 /* @TechReport{      rr-lip2002-40, */
 574 /*   author        = {Henri Casanova and Loris Marchal}, */
 575 /*   institution   = {LIP}, */
 576 /*   title         = {A Network Model for Simulation of Grid Application}, */
 577 /*   number        = {2002-40}, */
 578 /*   month         = {oct}, */
 579 /*   year          = {2002} */
 580 /* } */
 581 void surf_network_resource_init_CM02(const char *filename)
 582 {
 583   if (surf_network_resource)
 584     return;
 585   surf_network_resource_init_internal();
 586   parse_file(filename);
 587   xbt_dynar_push(resource_list, &surf_network_resource);
 588 }