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 static int card_number = 0;
  21 static network_link_t **routing_table = NULL;
  22 static int *routing_table_size = NULL;
  23
  24 #define ROUTE(i,j) routing_table[(i)+(j)*card_number]
  25 #define ROUTE_SIZE(i,j) routing_table_size[(i)+(j)*card_number]
  26
  27 static void create_routing_table(void)
  28 {
  29   routing_table = xbt_new0(network_link_t *, card_number * card_number);
  30   routing_table_size = xbt_new0(int, card_number * card_number);
  31 }
  32
  33 static void network_link_free(void *nw_link)
  34 {
  35   xbt_free(((network_link_t)nw_link)->name);
  36   xbt_free(nw_link);
  37 }
  38
  39 static network_link_t network_link_new(char *name,
  40                                        double bw_initial,
  41                                        tmgr_trace_t bw_trace,
  42                                        double lat_initial,
  43                                        tmgr_trace_t lat_trace,
  44                                        e_surf_network_link_state_t
  45                                        state_initial,
  46                                        tmgr_trace_t state_trace)
  47 {
  48   network_link_t nw_link = xbt_new0(s_network_link_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   xbt_dict_set(network_link_set, name, nw_link, network_link_free);
  70
  71   return nw_link;
  72 }
  73
  74 static void network_card_free(void *nw_card)
  75 {
  76   xbt_free(((network_card_t)nw_card)->name);
  77   xbt_free(nw_card);
  78 }
  79
  80 static int network_card_new(char *card_name)
  81 {
  82   network_card_t card = NULL;
  83
  84   xbt_dict_get(network_card_set, card_name, (void *) &card);
  85
  86   if (!card) {
  87     card = xbt_new0(s_network_card_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_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_t, nb_link));
 102   for (i = 0; i < nb_link; i++) {
 103     xbt_dict_get(network_link_set, links[i], (void *) &(link_list[i]));
 104     xbt_free(links[i]);
 105   }
 106   xbt_free(links);
 107 }
 108
 109 /*
 110    Semantic:  name       initial   bandwidth   initial   latency    initial     state
 111                         bandwidth    trace     latency    trace      state      trace
 112
 113    Token:   TOKEN_WORD TOKEN_WORD TOKEN_WORD TOKEN_WORD TOKEN_WORD TOKEN_WORD TOKEN_WORD
 114    Type:     string      double      string    double     string     ON/OFF     string
 115 */
 116 static void parse_network_link(void)
 117 {
 118   e_surf_token_t token;
 119   char *name;
 120   double bw_initial;
 121   tmgr_trace_t bw_trace;
 122   double lat_initial;
 123   tmgr_trace_t lat_trace;
 124   e_surf_network_link_state_t state_initial;
 125   tmgr_trace_t state_trace;
 126
 127   name = xbt_strdup(surf_parse_text);
 128
 129   surf_parse_double(&bw_initial);
 130   surf_parse_trace(&bw_trace);
 131   surf_parse_double(&lat_initial);
 132   surf_parse_trace(&lat_trace);
 133
 134   token = surf_parse();         /* state_initial */
 135   xbt_assert1((token == TOKEN_WORD), "Parse error line %d", surf_line_pos);
 136   if (strcmp(surf_parse_text, "ON") == 0)
 137     state_initial = SURF_NETWORK_LINK_ON;
 138   else if (strcmp(surf_parse_text, "OFF") == 0)
 139     state_initial = SURF_NETWORK_LINK_OFF;
 140   else {
 141     CRITICAL2("Invalid cpu state (line %d): %s neq ON or OFF\n", surf_line_pos,
 142               surf_parse_text);
 143     xbt_abort();
 144   }
 145
 146   surf_parse_trace(&state_trace);
 147
 148   network_link_new(name, bw_initial, bw_trace,
 149                    lat_initial, lat_trace, state_initial, state_trace);
 150 }
 151
 152 /*
 153    Semantic:  source   destination           network
 154                                               links
 155
 156    Token:   TOKEN_WORD TOKEN_WORD TOKEN_LP TOKEN_WORD* TOKEN_RP
 157    Type:     string       string             string
 158 */
 159 static void parse_route(int fake)
 160 {
 161   int src_id = -1;
 162   int dst_id = -1;
 163   int nb_link = 0;
 164   char **link_name = NULL;
 165   e_surf_token_t token;
 166
 167   src_id = network_card_new(surf_parse_text);
 168
 169   token = surf_parse();
 170   xbt_assert1((token == TOKEN_WORD), "Parse error line %d", surf_line_pos);
 171   dst_id = network_card_new(surf_parse_text);
 172
 173   token = surf_parse();
 174   xbt_assert1((token == TOKEN_LP), "Parse error line %d", surf_line_pos);
 175
 176   while ((token = surf_parse()) == TOKEN_WORD) {
 177     if (!fake) {
 178       nb_link++;
 179       link_name = xbt_realloc(link_name, (nb_link) * sizeof(char *));
 180       link_name[(nb_link) - 1] = xbt_strdup(surf_parse_text);
 181     }
 182   }
 183   xbt_assert1((token == TOKEN_RP), "Parse error line %d", surf_line_pos);
 184
 185   if (!fake)
 186     route_new(src_id, dst_id, link_name, nb_link);
 187 }
 188
 189 static void parse_file(const char *file)
 190 {
 191   e_surf_token_t token;
 192
 193   /* Figuring out the network links in the system */
 194   find_section(file, "NETWORK");
 195   while (1) {
 196     token = surf_parse();
 197
 198     if (token == TOKEN_END_SECTION)
 199       break;
 200     if (token == TOKEN_NEWLINE)
 201       continue;
 202
 203     if (token == TOKEN_WORD)
 204       parse_network_link();
 205     else {
 206       CRITICAL1("Parse error line %d\n", surf_line_pos);
 207       xbt_abort();
 208     }
 209   }
 210   close_section("NETWORK");
 211
 212   /* Figuring out the network cards used */
 213   find_section(file, "ROUTE");
 214   while (1) {
 215     token = surf_parse();
 216
 217     if (token == TOKEN_END_SECTION)
 218       break;
 219     if (token == TOKEN_NEWLINE)
 220       continue;
 221
 222     if (token == TOKEN_WORD)
 223       parse_route(1);
 224     else {
 225       CRITICAL1("Parse error line %d\n", surf_line_pos);
 226       xbt_abort();
 227     }
 228   }
 229   close_section("ROUTE");
 230
 231   create_routing_table();
 232
 233   /* Building the routes */
 234   find_section(file, "ROUTE");
 235   while (1) {
 236     token = surf_parse();
 237
 238     if (token == TOKEN_END_SECTION)
 239       break;
 240     if (token == TOKEN_NEWLINE)
 241       continue;
 242
 243     if (token == TOKEN_WORD)
 244       parse_route(0);
 245     else {
 246       CRITICAL1("Parse error line %d\n", surf_line_pos);
 247       xbt_abort();
 248     }
 249   }
 250   close_section("ROUTE");
 251 }
 252
 253 static void *name_service(const char *name)
 254 {
 255   network_card_t card = NULL;
 256
 257   xbt_dict_get(network_card_set, name, (void *) &card);
 258
 259   return card;
 260 }
 261
 262 static const char *get_resource_name(void *resource_id)
 263 {
 264   return ((network_card_t) resource_id)->name;
 265 }
 266
 267 static int resource_used(void *resource_id)
 268 {
 269   return lmm_constraint_used(maxmin_system,
 270                              ((network_link_t) resource_id)->constraint);
 271 }
 272
 273 static void action_free(surf_action_t action)
 274 {
 275   surf_action_network_t Action = (surf_action_network_t) action;
 276
 277   xbt_swag_remove(action, action->state_set);
 278   lmm_variable_free(maxmin_system, Action->variable);
 279   xbt_free(action);
 280
 281   return;
 282 }
 283
 284 static void action_cancel(surf_action_t action)
 285 {
 286   return;
 287 }
 288
 289 static void action_recycle(surf_action_t action)
 290 {
 291   return;
 292 }
 293
 294 static void action_change_state(surf_action_t action,
 295                                 e_surf_action_state_t state)
 296 {
 297   surf_action_change_state(action, state);
 298   return;
 299 }
 300
 301 static double share_resources(double now)
 302 {
 303   s_surf_action_network_t s_action;
 304   surf_action_network_t action = NULL;
 305   xbt_swag_t running_actions = surf_network_resource->common_public->states.running_action_set;
 306   double min = generic_maxmin_share_resources(running_actions,
 307                                               xbt_swag_offset(s_action, variable));
 308
 309   xbt_swag_foreach(action, running_actions) {
 310     if(action->latency>0) {
 311       if(min<0) min = action->latency;
 312       else if (action->latency<min) min = action->latency;
 313     }
 314   }
 315
 316   return min;
 317 }
 318
 319
 320 static void update_actions_state(double now, double delta)
 321 {
 322   double deltap = 0.0;
 323   surf_action_network_t action = NULL;
 324   surf_action_network_t next_action = NULL;
 325   xbt_swag_t running_actions =
 326       surf_network_resource->common_public->states.running_action_set;
 327   xbt_swag_t failed_actions =
 328       surf_network_resource->common_public->states.failed_action_set;
 329
 330   xbt_swag_foreach_safe(action, next_action, running_actions) {
 331     deltap = delta;
 332     if (action->latency > 0) {
 333       if (action->latency > deltap) {
 334         action->latency -= deltap;
 335         deltap = 0.0;
 336       } else {
 337         deltap -= action->latency;
 338         action->latency = 0.0;
 339       }
 340       if (action->latency == 0.0)
 341         lmm_update_variable_weight(maxmin_system, action->variable, 1.0);
 342     }
 343     action->generic_action.remains -=
 344         lmm_variable_getvalue(action->variable) * deltap;
 345     if (action->generic_action.max_duration != NO_MAX_DURATION)
 346       action->generic_action.max_duration -= delta;
 347
 348 /*     if(action->generic_action.remains<.00001) action->generic_action.remains=0; */
 349
 350     if (action->generic_action.remains <= 0) {
 351       action->generic_action.finish = surf_get_clock();
 352       action_change_state((surf_action_t) action, SURF_ACTION_DONE);
 353     } else if ((action->generic_action.max_duration != NO_MAX_DURATION) &&
 354                (action->generic_action.max_duration <= 0)) {
 355       action->generic_action.finish = surf_get_clock();
 356       action_change_state((surf_action_t) action, SURF_ACTION_DONE);
 357     } else {                    /* Need to check that none of the resource has failed */
 358       lmm_constraint_t cnst = NULL;
 359       int i = 0;
 360       network_link_t nw_link = NULL;
 361
 362       while ((cnst =
 363               lmm_get_cnst_from_var(maxmin_system, action->variable,
 364                                     i++))) {
 365         nw_link = lmm_constraint_id(cnst);
 366         if (nw_link->state_current == SURF_NETWORK_LINK_OFF) {
 367           action->generic_action.finish = surf_get_clock();
 368           action_change_state((surf_action_t) action, SURF_ACTION_FAILED);
 369           break;
 370         }
 371       }
 372     }
 373   }
 374
 375   xbt_swag_foreach_safe(action, next_action, failed_actions) {
 376     lmm_variable_disable(maxmin_system, action->variable);
 377   }
 378
 379   return;
 380 }
 381
 382 static void update_resource_state(void *id,
 383                                   tmgr_trace_event_t event_type,
 384                                   double value)
 385 {
 386   network_link_t nw_link = id;
 387
 388 /*   printf("[" "%lg" "] Asking to update network card \"%s\" with value " */
 389 /*       "%lg" " for event %p\n", surf_get_clock(), nw_link->name, */
 390 /*       value, event_type); */
 391
 392   if (event_type == nw_link->bw_event) {
 393     nw_link->bw_current = value;
 394     lmm_update_constraint_bound(maxmin_system, nw_link->constraint,
 395                                 nw_link->bw_current);
 396   } else if (event_type == nw_link->lat_event) {
 397     double delta = value - nw_link->lat_current;
 398     lmm_variable_t var = NULL;
 399     surf_action_network_t action = NULL;
 400
 401     nw_link->lat_current = value;
 402     while (lmm_get_var_from_cnst(maxmin_system, nw_link->constraint, &var)) {
 403       action = lmm_variable_id(var);
 404       action->lat_current += delta;
 405       lmm_update_variable_bound(maxmin_system, var,
 406                                 1 / (action->lat_current));
 407     }
 408   } else if (event_type == nw_link->state_event) {
 409     if (value > 0)
 410       nw_link->state_current = SURF_NETWORK_LINK_ON;
 411     else
 412       nw_link->state_current = SURF_NETWORK_LINK_OFF;
 413   } else {
 414     CRITICAL0("Unknown event ! \n");
 415     xbt_abort();
 416   }
 417
 418   return;
 419 }
 420
 421 static surf_action_t communicate(void *src, void *dst, double size)
 422 {
 423   surf_action_network_t action = NULL;
 424   network_card_t card_src = src;
 425   network_card_t card_dst = dst;
 426   int route_size = ROUTE_SIZE(card_src->id, card_dst->id);
 427   network_link_t *route = ROUTE(card_src->id, card_dst->id);
 428   int i;
 429
 430   action = xbt_new0(s_surf_action_network_t, 1);
 431
 432   action->generic_action.cost = size;
 433   action->generic_action.remains = size;
 434   action->generic_action.max_duration = NO_MAX_DURATION;
 435   action->generic_action.start = -1.0;
 436   action->generic_action.finish = -1.0;
 437   action->generic_action.resource_type =
 438       (surf_resource_t) surf_network_resource;
 439
 440   action->generic_action.state_set =
 441       surf_network_resource->common_public->states.running_action_set;
 442
 443   xbt_swag_insert(action, action->generic_action.state_set);
 444
 445   action->latency = 0.0;
 446   for (i = 0; i < route_size; i++)
 447     action->latency += route[i]->lat_current;
 448   action->lat_current = action->latency;
 449
 450   if(action->latency>0)
 451     action->variable = lmm_variable_new(maxmin_system, action, 0.0, -1.0,
 452                                         route_size);
 453   else
 454     action->variable = lmm_variable_new(maxmin_system, action, 1.0, -1.0,
 455                                         route_size);
 456
 457   lmm_update_variable_bound(maxmin_system, action->variable,
 458                             SG_TCP_CTE_GAMMA / action->lat_current);
 459
 460   for (i = 0; i < route_size; i++)
 461     lmm_expand(maxmin_system, route[i]->constraint, action->variable, 1.0);
 462
 463   return (surf_action_t) action;
 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   xbt_free(surf_network_resource->common_public);
 481   xbt_free(surf_network_resource->common_private);
 482   xbt_free(surf_network_resource->extension_public);
 483
 484   xbt_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       xbt_free(ROUTE(i,j));
 490   xbt_free(routing_table);
 491   routing_table = NULL;
 492   xbt_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_private = xbt_new0(s_surf_network_resource_extension_private_t,1); */
 508   surf_network_resource->extension_public =
 509       xbt_new0(s_surf_network_resource_extension_public_t, 1);
 510
 511   surf_network_resource->common_public->states.ready_action_set =
 512       xbt_swag_new(xbt_swag_offset(action, state_hookup));
 513   surf_network_resource->common_public->states.running_action_set =
 514       xbt_swag_new(xbt_swag_offset(action, state_hookup));
 515   surf_network_resource->common_public->states.failed_action_set =
 516       xbt_swag_new(xbt_swag_offset(action, state_hookup));
 517   surf_network_resource->common_public->states.done_action_set =
 518       xbt_swag_new(xbt_swag_offset(action, state_hookup));
 519
 520   surf_network_resource->common_public->name_service = name_service;
 521   surf_network_resource->common_public->get_resource_name =
 522       get_resource_name;
 523   surf_network_resource->common_public->action_get_state =
 524       surf_action_get_state;
 525   surf_network_resource->common_public->action_free = action_free;
 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->extension_public->communicate = communicate;
 542
 543   network_link_set = xbt_dict_new();
 544   network_card_set = xbt_dict_new();
 545
 546   xbt_assert0(maxmin_system, "surf_init has to be called first!");
 547 }
 548
 549 void surf_network_resource_init(const char *filename)
 550 {
 551   if (surf_network_resource)
 552     return;
 553   surf_network_resource_init_internal();
 554   parse_file(filename);
 555   xbt_dynar_push(resource_list, &surf_network_resource);
 556 }