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