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