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 #include "xbt/log.h"
  10
  11 #define SG_TCP_CTE_GAMMA 20000.0
  12
  13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(network, surf,
  14                                 "Logging specific to the SURF network module");
  15
  16 surf_network_resource_t surf_network_resource = NULL;
  17
  18 static xbt_dict_t network_link_set = NULL;
  19 xbt_dict_t network_card_set = NULL;
  20
  21 int card_number = 0;
  22 network_link_CM02_t **routing_table = NULL;
  23 int *routing_table_size = NULL;
  24 static network_link_CM02_t loopback = NULL;
  25
  26 static void create_routing_table(void)
  27 {
  28   routing_table = xbt_new0(network_link_CM02_t *, card_number * card_number);
  29   routing_table_size = xbt_new0(int, card_number * card_number);
  30 }
  31
  32 static void network_link_free(void *nw_link)
  33 {
  34   free(((network_link_CM02_t)nw_link)->name);
  35   free(nw_link);
  36 }
  37
  38 static network_link_CM02_t network_link_new(char *name,
  39                                        double bw_initial,
  40                                        tmgr_trace_t bw_trace,
  41                                        double lat_initial,
  42                                        tmgr_trace_t lat_trace,
  43                                        e_surf_network_link_state_t
  44                                        state_initial,
  45                                        tmgr_trace_t state_trace,
  46                                        e_surf_network_link_sharing_policy_t policy)
  47 {
  48   network_link_CM02_t nw_link = xbt_new0(s_network_link_CM02_t, 1);
  49
  50
  51   nw_link->resource = (surf_resource_t) surf_network_resource;
  52   nw_link->name = name;
  53   nw_link->bw_current = bw_initial;
  54   if (bw_trace)
  55     nw_link->bw_event =
  56         tmgr_history_add_trace(history, bw_trace, 0.0, 0, nw_link);
  57   nw_link->lat_current = lat_initial;
  58   if (lat_trace)
  59     nw_link->lat_event =
  60         tmgr_history_add_trace(history, lat_trace, 0.0, 0, nw_link);
  61   nw_link->state_current = state_initial;
  62   if (state_trace)
  63     nw_link->state_event =
  64         tmgr_history_add_trace(history, state_trace, 0.0, 0, nw_link);
  65
  66   nw_link->constraint =
  67       lmm_constraint_new(maxmin_system, nw_link, nw_link->bw_current);
  68
  69   if(policy == SURF_NETWORK_LINK_FATPIPE)
  70     lmm_constraint_shared(nw_link->constraint);
  71
  72   xbt_dict_set(network_link_set, name, nw_link, network_link_free);
  73
  74   return nw_link;
  75 }
  76
  77 static void network_card_free(void *nw_card)
  78 {
  79   free(((network_card_CM02_t)nw_card)->name);
  80   free(nw_card);
  81 }
  82
  83 static int network_card_new(const char *card_name)
  84 {
  85   network_card_CM02_t card = xbt_dict_get_or_null(network_card_set, card_name);
  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     link_list[i] = xbt_dict_get_or_null(network_link_set, links[i]);
 105     xbt_assert1(link_list[i],"Invalid link name \"%s\"",links[i]);
 106     free(links[i]);
 107   }
 108   free(links);
 109 }
 110
 111 static void parse_network_link(void)
 112 {
 113   char *name;
 114   double bw_initial;
 115   tmgr_trace_t bw_trace;
 116   double lat_initial;
 117   tmgr_trace_t lat_trace;
 118   e_surf_network_link_state_t state_initial = SURF_NETWORK_LINK_ON;
 119   e_surf_network_link_sharing_policy_t policy_initial = SURF_NETWORK_LINK_SHARED;
 120   tmgr_trace_t state_trace;
 121
 122   name = xbt_strdup(A_network_link_name);
 123   surf_parse_get_double(&bw_initial,A_network_link_bandwidth);
 124   surf_parse_get_trace(&bw_trace, A_network_link_bandwidth_file);
 125   surf_parse_get_double(&lat_initial,A_network_link_latency);
 126   surf_parse_get_trace(&lat_trace, A_network_link_latency_file);
 127
 128   xbt_assert0((A_network_link_state==A_network_link_state_ON)||
 129               (A_network_link_state==A_network_link_state_OFF),
 130               "Invalid state");
 131   if (A_network_link_state==A_network_link_state_ON)
 132     state_initial = SURF_NETWORK_LINK_ON;
 133   else if (A_network_link_state==A_network_link_state_OFF)
 134     state_initial = SURF_NETWORK_LINK_OFF;
 135
 136   if (A_network_link_sharing_policy==A_network_link_sharing_policy_SHARED)
 137     policy_initial = SURF_NETWORK_LINK_SHARED;
 138   else if (A_network_link_sharing_policy==A_network_link_sharing_policy_FATPIPE)
 139     policy_initial = SURF_NETWORK_LINK_FATPIPE;
 140
 141   surf_parse_get_trace(&state_trace,A_network_link_state_file);
 142
 143   network_link_new(name, bw_initial, bw_trace,
 144                    lat_initial, lat_trace, state_initial, state_trace,
 145                    policy_initial);
 146 }
 147
 148 static int nb_link = 0;
 149 static char **link_name = NULL;
 150 static int src_id = -1;
 151 static int dst_id = -1;
 152
 153 static void parse_route_set_endpoints(void)
 154 {
 155   src_id = network_card_new(A_route_src);
 156   dst_id = network_card_new(A_route_dst);
 157   nb_link = 0;
 158   link_name = NULL;
 159 }
 160
 161 static void parse_route_elem(void)
 162 {
 163   nb_link++;
 164   link_name = xbt_realloc(link_name, (nb_link) * sizeof(char *));
 165   link_name[(nb_link) - 1] = xbt_strdup(A_route_element_name);
 166 }
 167
 168 static void parse_route_set_route(void)
 169 {
 170   route_new(src_id, dst_id, link_name, nb_link);
 171 }
 172
 173 static void parse_file(const char *file)
 174 {
 175   int i;
 176
 177   /* Figuring out the network links */
 178   surf_parse_reset_parser();
 179   ETag_network_link_fun=parse_network_link;
 180   surf_parse_open(file);
 181   xbt_assert1((!surf_parse()),"Parse error in %s",file);
 182   surf_parse_close();
 183
 184   /* Figuring out the network cards used */
 185   surf_parse_reset_parser();
 186   STag_route_fun=parse_route_set_endpoints;
 187   surf_parse_open(file);
 188   xbt_assert1((!surf_parse()),"Parse error in %s",file);
 189   surf_parse_close();
 190
 191   create_routing_table();
 192
 193   /* Building the routes */
 194   surf_parse_reset_parser();
 195   STag_route_fun=parse_route_set_endpoints;
 196   ETag_route_element_fun=parse_route_elem;
 197   ETag_route_fun=parse_route_set_route;
 198   surf_parse_open(file);
 199   xbt_assert1((!surf_parse()),"Parse error in %s",file);
 200   surf_parse_close();
 201
 202   /* Adding loopback if needed */
 203
 204   for (i = 0; i < card_number; i++)
 205     if(!ROUTE_SIZE(i,i)) {
 206       if(!loopback)
 207         loopback = network_link_new(xbt_strdup("__MSG_loopback__"),
 208                                    498.00, NULL, 0.000015, NULL,
 209                                    SURF_NETWORK_LINK_ON, NULL,
 210                                    SURF_NETWORK_LINK_FATPIPE);
 211       ROUTE_SIZE(i,i)=1;
 212       ROUTE(i,i) = xbt_new0(network_link_CM02_t, 1);
 213       ROUTE(i,i)[0] = loopback;
 214     }
 215 }
 216
 217 static void *name_service(const char *name)
 218 {
 219   network_card_CM02_t card = xbt_dict_get_or_null(network_card_set, name);
 220   return card;
 221 }
 222
 223 static const char *get_resource_name(void *resource_id)
 224 {
 225   return ((network_card_CM02_t) resource_id)->name;
 226 }
 227
 228 static int resource_used(void *resource_id)
 229 {
 230   return lmm_constraint_used(maxmin_system,
 231                              ((network_link_CM02_t) resource_id)->constraint);
 232 }
 233
 234 static int action_free(surf_action_t action)
 235 {
 236   action->using--;
 237   if(!action->using) {
 238     xbt_swag_remove(action, action->state_set);
 239     if(((surf_action_network_CM02_t)action)->variable)
 240       lmm_variable_free(maxmin_system, ((surf_action_network_CM02_t)action)->variable);
 241     free(action);
 242     return 1;
 243   }
 244   return 0;
 245 }
 246
 247 static void action_use(surf_action_t action)
 248 {
 249   action->using++;
 250 }
 251
 252 static void action_cancel(surf_action_t action)
 253 {
 254   return;
 255 }
 256
 257 static void action_recycle(surf_action_t action)
 258 {
 259   return;
 260 }
 261
 262 static void action_change_state(surf_action_t action,
 263                                 e_surf_action_state_t state)
 264 {
 265 /*   if((state==SURF_ACTION_DONE) || (state==SURF_ACTION_FAILED)) */
 266 /*     if(((surf_action_network_CM02_t)action)->variable) { */
 267 /*       lmm_variable_disable(maxmin_system, ((surf_action_network_CM02_t)action)->variable); */
 268 /*       ((surf_action_network_CM02_t)action)->variable = NULL; */
 269 /*     } */
 270
 271   surf_action_change_state(action, state);
 272   return;
 273 }
 274
 275 static double share_resources(double now)
 276 {
 277   s_surf_action_network_CM02_t s_action;
 278   surf_action_network_CM02_t action = NULL;
 279   xbt_swag_t running_actions = surf_network_resource->common_public->states.running_action_set;
 280   double min = generic_maxmin_share_resources(running_actions,
 281                                               xbt_swag_offset(s_action, variable));
 282
 283   xbt_swag_foreach(action, running_actions) {
 284     if(action->latency>0) {
 285       if(min<0) min = action->latency;
 286       else if (action->latency<min) min = action->latency;
 287     }
 288   }
 289
 290   return min;
 291 }
 292
 293 static void update_actions_state(double now, double delta)
 294 {
 295   double deltap = 0.0;
 296   surf_action_network_CM02_t action = NULL;
 297   surf_action_network_CM02_t next_action = NULL;
 298   xbt_swag_t running_actions =
 299       surf_network_resource->common_public->states.running_action_set;
 300   /*
 301   xbt_swag_t failed_actions =
 302       surf_network_resource->common_public->states.failed_action_set;
 303   */
 304
 305   xbt_swag_foreach_safe(action, next_action, running_actions) {
 306     deltap = delta;
 307     if (action->latency > 0) {
 308       if (action->latency > deltap) {
 309         surf_double_update(&(action->latency),deltap);
 310         deltap = 0.0;
 311       } else {
 312         surf_double_update(&(deltap), action->latency);
 313         action->latency = 0.0;
 314       }
 315       if ((action->latency == 0.0) && !(action->suspended))
 316         lmm_update_variable_weight(maxmin_system, action->variable, 1.0);
 317     }
 318     surf_double_update(&(action->generic_action.remains),
 319         lmm_variable_getvalue(action->variable) * deltap);
 320     if (action->generic_action.max_duration != NO_MAX_DURATION)
 321       surf_double_update(&(action->generic_action.max_duration), delta);
 322
 323     /*   if(action->generic_action.remains<.00001) action->generic_action.remains=0; */
 324
 325     if (action->generic_action.remains <= 0) {
 326       action->generic_action.finish = surf_get_clock();
 327       action_change_state((surf_action_t) action, SURF_ACTION_DONE);
 328     } else if ((action->generic_action.max_duration != NO_MAX_DURATION) &&
 329                (action->generic_action.max_duration <= 0)) {
 330       action->generic_action.finish = surf_get_clock();
 331       action_change_state((surf_action_t) action, SURF_ACTION_DONE);
 332     } else {                    /* Need to check that none of the resource has failed */
 333       lmm_constraint_t cnst = NULL;
 334       int i = 0;
 335       network_link_CM02_t nw_link = NULL;
 336
 337       while ((cnst =
 338               lmm_get_cnst_from_var(maxmin_system, action->variable,
 339                                     i++))) {
 340         nw_link = lmm_constraint_id(cnst);
 341         if (nw_link->state_current == SURF_NETWORK_LINK_OFF) {
 342           action->generic_action.finish = surf_get_clock();
 343           action_change_state((surf_action_t) action, SURF_ACTION_FAILED);
 344           break;
 345         }
 346       }
 347     }
 348   }
 349
 350   return;
 351 }
 352
 353 static void update_resource_state(void *id,
 354                                   tmgr_trace_event_t event_type,
 355                                   double value)
 356 {
 357   network_link_CM02_t nw_link = id;
 358   /*   printf("[" "%lg" "] Asking to update network card \"%s\" with value " */
 359   /*     "%lg" " for event %p\n", surf_get_clock(), nw_link->name, */
 360   /*     value, event_type); */
 361
 362   if (event_type == nw_link->bw_event) {
 363     nw_link->bw_current = value;
 364     lmm_update_constraint_bound(maxmin_system, nw_link->constraint,
 365                                 nw_link->bw_current);
 366   } else if (event_type == nw_link->lat_event) {
 367     double delta = value - nw_link->lat_current;
 368     lmm_variable_t var = NULL;
 369     surf_action_network_CM02_t action = NULL;
 370
 371     nw_link->lat_current = value;
 372     while (lmm_get_var_from_cnst(maxmin_system, nw_link->constraint, &var)) {
 373       action = lmm_variable_id(var);
 374       action->lat_current += delta;
 375       if(action->rate<0)
 376         lmm_update_variable_bound(maxmin_system, action->variable,
 377                                   SG_TCP_CTE_GAMMA / action->lat_current);
 378       else
 379         lmm_update_variable_bound(maxmin_system, action->variable,
 380                                   min(action->rate,SG_TCP_CTE_GAMMA / action->lat_current));
 381     }
 382   } else if (event_type == nw_link->state_event) {
 383     if (value > 0)
 384       nw_link->state_current = SURF_NETWORK_LINK_ON;
 385     else
 386       nw_link->state_current = SURF_NETWORK_LINK_OFF;
 387   } else {
 388     CRITICAL0("Unknown event ! \n");
 389     xbt_abort();
 390   }
 391
 392   return;
 393 }
 394
 395 static surf_action_t communicate(void *src, void *dst, double size, double rate)
 396 {
 397   surf_action_network_CM02_t action = NULL;
 398   network_card_CM02_t card_src = src;
 399   network_card_CM02_t card_dst = dst;
 400   int route_size = ROUTE_SIZE(card_src->id, card_dst->id);
 401   network_link_CM02_t *route = ROUTE(card_src->id, card_dst->id);
 402   int i;
 403
 404   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);
 405
 406   action = xbt_new0(s_surf_action_network_CM02_t, 1);
 407
 408   action->generic_action.using = 1;
 409   action->generic_action.cost = size;
 410   action->generic_action.remains = size;
 411   action->generic_action.max_duration = NO_MAX_DURATION;
 412   action->generic_action.start = -1.0;
 413   action->generic_action.finish = -1.0;
 414   action->generic_action.resource_type =
 415       (surf_resource_t) surf_network_resource;
 416   action->suspended = 0;  /* Should be useless because of the
 417                              calloc but it seems to help valgrind... */
 418   action->generic_action.state_set =
 419       surf_network_resource->common_public->states.running_action_set;
 420
 421   xbt_swag_insert(action, action->generic_action.state_set);
 422   action->rate = rate;
 423
 424   action->latency = 0.0;
 425   for (i = 0; i < route_size; i++)
 426     action->latency += route[i]->lat_current;
 427   action->lat_current = action->latency;
 428
 429   if(action->latency>0)
 430     action->variable = lmm_variable_new(maxmin_system, action, 0.0, -1.0,
 431                                         route_size);
 432   else
 433     action->variable = lmm_variable_new(maxmin_system, action, 1.0, -1.0,
 434                                         route_size);
 435
 436   if(action->rate<0) {
 437     if(action->lat_current>0)
 438       lmm_update_variable_bound(maxmin_system, action->variable,
 439                                 SG_TCP_CTE_GAMMA / action->lat_current);
 440     else
 441       lmm_update_variable_bound(maxmin_system, action->variable, -1.0);
 442   } else {
 443     if(action->lat_current>0)
 444       lmm_update_variable_bound(maxmin_system, action->variable,
 445                                 min(action->rate,SG_TCP_CTE_GAMMA / action->lat_current));
 446     else
 447       lmm_update_variable_bound(maxmin_system, action->variable, action->rate);
 448   }
 449
 450   for (i = 0; i < route_size; i++)
 451     lmm_expand(maxmin_system, route[i]->constraint, action->variable, 1.0);
 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 }