src/surf/network.c

   1 /* Authors: Arnaud Legrand                                                  */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4    under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #include "network_private.h"
   7 #include "xbt/dict.h"
   8
   9 #define SG_TCP_CTE_GAMMA 20000.0
  10
  11 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(network, surf,
  12                                 "Logging specific to the SURF network module");
  13
  14 surf_network_resource_t surf_network_resource = NULL;
  15
  16 static xbt_dict_t network_link_set = NULL;
  17 static xbt_dict_t network_card_set = NULL;
  18
  19 static int card_number = 0;
  20 static network_link_t **routing_table = NULL;
  21 static int *routing_table_size = NULL;
  22
  23 #define ROUTE(i,j) routing_table[(i)+(j)*card_number]
  24 #define ROUTE_SIZE(i,j) routing_table_size[(i)+(j)*card_number]
  25
  26 static void create_routing_table(void)
  27 {
  28   routing_table = xbt_new0(network_link_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   xbt_free(nw_link);
  35 }
  36
  37 static network_link_t network_link_new(const char *name,
  38                                        xbt_maxmin_float_t bw_initial,
  39                                        tmgr_trace_t bw_trace,
  40                                        xbt_maxmin_float_t lat_initial,
  41                                        tmgr_trace_t lat_trace,
  42                                        e_surf_network_link_state_t state_initial,
  43                                        tmgr_trace_t state_trace)
  44 {
  45   network_link_t nw_link = xbt_new0(s_network_link_t, 1);
  46
  47
  48   nw_link->resource = (surf_resource_t) surf_network_resource;
  49   nw_link->name = name;
  50   nw_link->bw_current = bw_initial;
  51   if (bw_trace)
  52     nw_link->bw_event =
  53         tmgr_history_add_trace(history, bw_trace, 0.0, 0, nw_link);
  54   nw_link->lat_current = lat_initial;
  55   if (lat_trace)
  56     nw_link->lat_event =
  57         tmgr_history_add_trace(history, lat_trace, 0.0, 0, nw_link);
  58   nw_link->state_current = state_initial;
  59   if (state_trace)
  60     nw_link->state_event =
  61         tmgr_history_add_trace(history, state_trace, 0.0, 0, nw_link);
  62
  63   nw_link->constraint =
  64       lmm_constraint_new(maxmin_system, nw_link,
  65                          nw_link->bw_current);
  66
  67   xbt_dict_set(network_link_set, name, nw_link, network_link_free);
  68
  69   return nw_link;
  70 }
  71
  72 static int network_card_new(const char *card_name)
  73 {
  74   network_card_t card = NULL;
  75
  76   xbt_dict_get(network_card_set, card_name, (void *) &card);
  77
  78   if(!card) {
  79     card = xbt_new0(s_network_card_t,1);
  80     card->name=xbt_strdup(card_name);
  81     card->id=card_number++;
  82     xbt_dict_set(network_card_set, card_name, card, NULL);
  83   }
  84   return card->id;
  85 }
  86
  87 static void route_new(int src_id, int dst_id,
  88                       char* *links, int nb_link)
  89 {
  90   network_link_t *link_list = NULL;
  91   int i ;
  92
  93   ROUTE_SIZE(src_id,dst_id) = nb_link;
  94   link_list = (ROUTE(src_id,dst_id) = xbt_new0(network_link_t,nb_link));
  95   for(i=0; i < nb_link; i++) {
  96     xbt_dict_get(network_link_set,links[i], (void *) &(link_list[i]));
  97     xbt_free(links[i]);
  98   }
  99   xbt_free(links);
 100 }
 101
 102 /*
 103    Semantic:  name       initial   bandwidth   initial   latency    initial     state
 104                         bandwidth    trace     latency    trace      state      trace
 105
 106    Token:   TOKEN_WORD TOKEN_WORD TOKEN_WORD TOKEN_WORD TOKEN_WORD TOKEN_WORD TOKEN_WORD
 107    Type:     string       float      string    float      string     ON/OFF     string
 108 */
 109 static void parse_network_link(void)
 110 {
 111   e_surf_token_t token;
 112   char *name;
 113   xbt_maxmin_float_t bw_initial;
 114   tmgr_trace_t bw_trace;
 115   xbt_maxmin_float_t lat_initial;
 116   tmgr_trace_t lat_trace;
 117   e_surf_network_link_state_t state_initial;
 118   tmgr_trace_t state_trace;
 119
 120   name = xbt_strdup(surf_parse_text);
 121
 122   surf_parse_float(&bw_initial);
 123   surf_parse_trace(&bw_trace);
 124   surf_parse_float(&lat_initial);
 125   surf_parse_trace(&lat_trace);
 126
 127   token = surf_parse();         /* state_initial */
 128   xbt_assert1((token == TOKEN_WORD), "Parse error line %d", line_pos);
 129   if (strcmp(surf_parse_text, "ON") == 0)
 130     state_initial = SURF_NETWORK_LINK_ON;
 131   else if (strcmp(surf_parse_text, "OFF") == 0)
 132     state_initial = SURF_NETWORK_LINK_OFF;
 133   else {
 134     CRITICAL2("Invalid cpu state (line %d): %s neq ON or OFF\n", line_pos,
 135               surf_parse_text);
 136     xbt_abort();
 137   }
 138
 139   surf_parse_trace(&state_trace);
 140
 141   network_link_new(name, bw_initial, bw_trace,
 142                    lat_initial, lat_trace,
 143                    state_initial, state_trace);
 144 }
 145
 146 /*
 147    Semantic:  source   destination           network
 148                                               links
 149
 150    Token:   TOKEN_WORD TOKEN_WORD TOKEN_LP TOKEN_WORD* TOKEN_RP
 151    Type:     string       string             string
 152 */
 153 static void parse_route(int fake)
 154 {
 155   int src_id = -1;
 156   int dst_id = -1;
 157   int nb_link = 0;
 158   char **link_name = NULL;
 159   e_surf_token_t token;
 160
 161   src_id = network_card_new(surf_parse_text);
 162
 163   token = surf_parse();
 164   xbt_assert1((token == TOKEN_WORD), "Parse error line %d", line_pos);
 165   dst_id = network_card_new(surf_parse_text);
 166
 167   token = surf_parse();
 168   xbt_assert1((token == TOKEN_LP), "Parse error line %d", line_pos);
 169
 170   while((token = surf_parse())==TOKEN_WORD) {
 171     if(!fake) {
 172       nb_link++;
 173       link_name=xbt_realloc(link_name, (nb_link) * sizeof(char*));
 174       link_name[(nb_link)-1]=xbt_strdup(surf_parse_text);
 175     }
 176   }
 177   xbt_assert1((token == TOKEN_RP), "Parse error line %d", line_pos);
 178
 179   if(!fake) route_new(src_id,dst_id,link_name, nb_link);
 180 }
 181
 182 static void parse_file(const char *file)
 183 {
 184   e_surf_token_t token;
 185
 186   /* Figuring out the network links in the system */
 187   find_section(file, "NETWORK");
 188   while (1) {
 189     token = surf_parse();
 190
 191     if (token == TOKEN_END_SECTION)
 192       break;
 193     if (token == TOKEN_NEWLINE)
 194       continue;
 195
 196     if (token == TOKEN_WORD)
 197       parse_network_link();
 198     else {
 199       CRITICAL1("Parse error line %d\n", line_pos);
 200       xbt_abort();
 201     }
 202   }
 203   close_section("NETWORK");
 204
 205   /* Figuring out the network cards used */
 206   find_section(file, "ROUTE");
 207   while (1) {
 208     token = surf_parse();
 209
 210     if (token == TOKEN_END_SECTION)
 211       break;
 212     if (token == TOKEN_NEWLINE)
 213       continue;
 214
 215     if (token == TOKEN_WORD)
 216       parse_route(1);
 217     else {
 218       CRITICAL1("Parse error line %d\n", line_pos);
 219       xbt_abort();
 220     }
 221   }
 222   close_section("ROUTE");
 223
 224   create_routing_table();
 225
 226   /* Building the routes */
 227   find_section(file, "ROUTE");
 228   while (1) {
 229     token = surf_parse();
 230
 231     if (token == TOKEN_END_SECTION)
 232       break;
 233     if (token == TOKEN_NEWLINE)
 234       continue;
 235
 236     if (token == TOKEN_WORD)
 237       parse_route(0);
 238     else {
 239       CRITICAL1("Parse error line %d\n", line_pos);
 240       xbt_abort();
 241     }
 242   }
 243   close_section("ROUTE");
 244 }
 245
 246 static void *name_service(const char *name)
 247 {
 248   network_card_t card = NULL;
 249
 250   xbt_dict_get(network_card_set, name, (void *) &card);
 251
 252   return card;
 253 }
 254
 255 static const char *get_resource_name(void *resource_id)
 256 {
 257   return ((network_card_t) resource_id)->name;
 258 }
 259
 260 static int resource_used(void *resource_id)
 261 {
 262   return lmm_constraint_used(maxmin_system,
 263                              ((network_link_t) resource_id)->constraint);
 264 }
 265
 266 static void action_free(surf_action_t action)
 267 {
 268   surf_action_network_t Action = (surf_action_network_t) action;
 269
 270   xbt_swag_remove(action, action->state_set);
 271   lmm_variable_free(maxmin_system, Action->variable);
 272   xbt_free(action);
 273
 274   return;
 275 }
 276
 277 static void action_cancel(surf_action_t action)
 278 {
 279   return;
 280 }
 281
 282 static void action_recycle(surf_action_t action)
 283 {
 284   return;
 285 }
 286
 287 static void action_change_state(surf_action_t action,
 288                                 e_surf_action_state_t state)
 289 {
 290   surf_action_change_state(action, state);
 291   return;
 292 }
 293
 294 static xbt_heap_float_t share_resources(xbt_heap_float_t now)
 295 {
 296   surf_action_network_t action = NULL;
 297   xbt_swag_t running_actions =
 298       surf_network_resource->common_public->states.running_action_set;
 299   xbt_maxmin_float_t min = -1;
 300   xbt_maxmin_float_t value = -1;
 301   lmm_solve(maxmin_system);
 302
 303   action = xbt_swag_getFirst(running_actions);
 304   if (!action)
 305     return -1.0;
 306   value = lmm_variable_getvalue(action->variable);
 307   min = action->generic_action.remains / value;
 308
 309   xbt_swag_foreach(action, running_actions) {
 310     value = action->latency + (action->generic_action.remains /
 311         lmm_variable_getvalue(action->variable));
 312     if (value < min)
 313       min = value;
 314   }
 315
 316   return min;
 317 }
 318
 319
 320 static void update_actions_state(xbt_heap_float_t now,
 321                                  xbt_heap_float_t delta)
 322 {
 323   xbt_heap_float_t deltap = 0.0;
 324   surf_action_network_t action = NULL;
 325   surf_action_network_t next_action = NULL;
 326   xbt_swag_t running_actions =
 327       surf_network_resource->common_public->states.running_action_set;
 328   xbt_swag_t failed_actions =
 329       surf_network_resource->common_public->states.failed_action_set;
 330
 331   xbt_swag_foreach_safe(action, next_action, running_actions) {
 332     deltap = delta;
 333     if(action->latency>0) {
 334       if(action->latency>deltap) {
 335         action->latency-=deltap;
 336         deltap = 0.0;
 337       } else {
 338         deltap -= action->latency;
 339         action->latency = 0.0;
 340       }
 341     }
 342     action->generic_action.remains -=
 343       lmm_variable_getvalue(action->variable) * deltap;
 344
 345 /*     if(action->generic_action.remains<.00001) action->generic_action.remains=0; */
 346
 347     if (action->generic_action.remains <= 0) {
 348       action_change_state((surf_action_t) action, SURF_ACTION_DONE);
 349     } else {                    /* Need to check that none of the resource has failed */
 350       lmm_constraint_t cnst = NULL;
 351       int i = 0;
 352       network_link_t nw_link = NULL;
 353
 354       while ((cnst =
 355               lmm_get_cnst_from_var(maxmin_system, action->variable,
 356                                     i++))) {
 357         nw_link = lmm_constraint_id(cnst);
 358         if (nw_link->state_current == SURF_NETWORK_LINK_OFF) {
 359           action_change_state((surf_action_t) action, SURF_ACTION_FAILED);
 360           break;
 361         }
 362       }
 363     }
 364   }
 365
 366   xbt_swag_foreach_safe(action, next_action, failed_actions) {
 367     lmm_variable_disable(maxmin_system, action->variable);
 368   }
 369
 370   return;
 371 }
 372
 373 static void update_resource_state(void *id,
 374                                   tmgr_trace_event_t event_type,
 375                                   xbt_maxmin_float_t value)
 376 {
 377   network_link_t nw_link = id;
 378
 379 /*   printf("[" XBT_HEAP_FLOAT_T "] Asking to update network card \"%s\" with value " */
 380 /*       XBT_MAXMIN_FLOAT_T " for event %p\n", surf_get_clock(), nw_link->name, */
 381 /*       value, event_type); */
 382
 383   if (event_type == nw_link->bw_event) {
 384     nw_link->bw_current = value;
 385     lmm_update_constraint_bound(maxmin_system, nw_link->constraint,
 386                                 nw_link->bw_current);
 387   } else if (event_type == nw_link->lat_event) {
 388     xbt_maxmin_float_t delta = value - nw_link->lat_current;
 389     lmm_variable_t var = NULL;
 390     surf_action_network_t action = NULL;
 391
 392     nw_link->lat_current = value;
 393     while(lmm_get_var_from_cnst(maxmin_system, nw_link->constraint, &var)) {
 394       action  = lmm_variable_id(var);
 395       action->lat_current+=delta;
 396       lmm_update_variable_bound(maxmin_system, var,
 397                                 1/(action->lat_current));
 398     }
 399   } else if (event_type == nw_link->state_event) {
 400     if (value > 0)
 401       nw_link->state_current = SURF_NETWORK_LINK_ON;
 402     else
 403       nw_link->state_current = SURF_NETWORK_LINK_OFF;
 404   } else {
 405     CRITICAL0("Unknown event ! \n");
 406     xbt_abort();
 407   }
 408
 409   return;
 410 }
 411
 412 static surf_action_t communicate(void *src, void *dst,
 413                                  xbt_maxmin_float_t size)
 414 {
 415   surf_action_network_t action = NULL;
 416   network_card_t card_src = src;
 417   network_card_t card_dst = dst;
 418   int route_size = ROUTE_SIZE(card_src->id,card_dst->id);
 419   network_link_t *route = ROUTE(card_src->id,card_dst->id);
 420   int i;
 421
 422   action = xbt_new0(s_surf_action_network_t, 1);
 423
 424   action->generic_action.cost = size;
 425   action->generic_action.remains = size;
 426   action->generic_action.start = -1.0;
 427   action->generic_action.finish = -1.0;
 428   action->generic_action.callback = NULL;
 429   action->generic_action.resource_type =
 430       (surf_resource_t) surf_network_resource;
 431
 432   action->generic_action.state_set =
 433     surf_network_resource->common_public->states.running_action_set;
 434
 435   xbt_swag_insert(action, action->generic_action.state_set);
 436
 437   action->variable = lmm_variable_new(maxmin_system, action, 1.0, -1.0,
 438                                       route_size);
 439   for(i=0; i<route_size; i++)
 440     lmm_expand(maxmin_system, route[i]->constraint, action->variable,
 441                1.0);
 442
 443   action->latency = 0.0;
 444   for(i=0; i<route_size; i++)
 445     action->latency += route[i]->lat_current;
 446   action->lat_current = action->latency;
 447   lmm_update_variable_bound(maxmin_system, action->variable,
 448                             SG_TCP_CTE_GAMMA/action->lat_current);
 449
 450   return (surf_action_t) action;
 451 }
 452
 453 static void finalize(void)
 454 {
 455   xbt_dict_free(&network_card_set);
 456   xbt_dict_free(&network_link_set);
 457   xbt_swag_free(surf_network_resource->common_public->states.ready_action_set);
 458   xbt_swag_free(surf_network_resource->common_public->states.
 459                 running_action_set);
 460   xbt_swag_free(surf_network_resource->common_public->states.
 461                 failed_action_set);
 462   xbt_swag_free(surf_network_resource->common_public->states.done_action_set);
 463   xbt_free(surf_network_resource->common_public);
 464   xbt_free(surf_network_resource->common_private);
 465   xbt_free(surf_network_resource->extension_public);
 466
 467   xbt_free(surf_network_resource);
 468   surf_network_resource = NULL;
 469 }
 470
 471 static void surf_network_resource_init_internal(void)
 472 {
 473   s_surf_action_t action;
 474
 475   surf_network_resource = xbt_new0(s_surf_network_resource_t, 1);
 476
 477   surf_network_resource->common_private =
 478       xbt_new0(s_surf_resource_private_t, 1);
 479   surf_network_resource->common_public =
 480       xbt_new0(s_surf_resource_public_t, 1);
 481 /*   surf_network_resource->extension_private = xbt_new0(s_surf_network_resource_extension_private_t,1); */
 482   surf_network_resource->extension_public =
 483       xbt_new0(s_surf_network_resource_extension_public_t, 1);
 484
 485   surf_network_resource->common_public->states.ready_action_set =
 486       xbt_swag_new(xbt_swag_offset(action, state_hookup));
 487   surf_network_resource->common_public->states.running_action_set =
 488       xbt_swag_new(xbt_swag_offset(action, state_hookup));
 489   surf_network_resource->common_public->states.failed_action_set =
 490       xbt_swag_new(xbt_swag_offset(action, state_hookup));
 491   surf_network_resource->common_public->states.done_action_set =
 492       xbt_swag_new(xbt_swag_offset(action, state_hookup));
 493
 494   surf_network_resource->common_public->name_service = name_service;
 495   surf_network_resource->common_public->get_resource_name =
 496       get_resource_name;
 497   surf_network_resource->common_public->action_get_state =
 498       surf_action_get_state;
 499   surf_network_resource->common_public->action_free = action_free;
 500   surf_network_resource->common_public->action_cancel = action_cancel;
 501   surf_network_resource->common_public->action_recycle = action_recycle;
 502   surf_network_resource->common_public->action_change_state =
 503       action_change_state;
 504
 505   surf_network_resource->common_private->resource_used = resource_used;
 506   surf_network_resource->common_private->share_resources = share_resources;
 507   surf_network_resource->common_private->update_actions_state =
 508       update_actions_state;
 509   surf_network_resource->common_private->update_resource_state =
 510       update_resource_state;
 511   surf_network_resource->common_private->finalize = finalize;
 512
 513   surf_network_resource->extension_public->communicate = communicate;
 514
 515   network_link_set = xbt_dict_new();
 516   network_card_set = xbt_dict_new();
 517
 518   xbt_assert0(maxmin_system, "surf_init has to be called first!");
 519 }
 520
 521 void surf_network_resource_init(const char *filename)
 522 {
 523   surf_network_resource_init_internal();
 524   parse_file(filename);
 525   xbt_dynar_push(resource_list, &surf_network_resource);
 526 }