src/surf/network_dassf.c

   1 /*      $Id$     */
   2
   3 /* Copyright (c) 2005 Henri Casanova. 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_dassf_private.h"
   9
  10 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(surf_network);
  11
  12 /* surf_network_resource_t surf_network_resource = NULL; */
  13 /*xbt_dict_t network_link_set = NULL;*/
  14 /* xbt_dict_t network_card_set = NULL; */
  15
  16 static int card_number = 0;
  17 static network_link_DASSF_t **routing_table = NULL;
  18 static int *routing_table_size = NULL;
  19
  20 #define ROUTE(i,j) routing_table[(i)+(j)*card_number]
  21 #define ROUTE_SIZE(i,j) routing_table_size[(i)+(j)*card_number]
  22
  23 static void create_routing_table(void)
  24 {
  25   routing_table = xbt_new0(network_link_DASSF_t *, card_number * card_number);
  26   routing_table_size = xbt_new0(int, card_number * card_number);
  27 }
  28
  29 static void network_link_free(void *nw_link)
  30 {
  31   free(((network_link_DASSF_t)nw_link)->name);
  32   free(nw_link);
  33 }
  34
  35 static network_link_DASSF_t network_link_new(char *name,
  36                                        double bw_initial,
  37                                        tmgr_trace_t bw_trace,
  38                                        double lat_initial,
  39                                        tmgr_trace_t lat_trace,
  40                                        e_surf_network_link_state_t
  41                                        state_initial,
  42                                        tmgr_trace_t state_trace)
  43 {
  44   network_link_DASSF_t nw_link = xbt_new0(s_network_link_DASSF_t, 1);
  45
  46
  47   nw_link->resource = (surf_resource_t) surf_network_resource;
  48   nw_link->name = name;
  49   nw_link->bw_current = bw_initial;
  50   if (bw_trace)
  51     nw_link->bw_event =
  52         tmgr_history_add_trace(history, bw_trace, 0.0, 0, nw_link);
  53   nw_link->lat_current = lat_initial;
  54   if (lat_trace)
  55     nw_link->lat_event =
  56         tmgr_history_add_trace(history, lat_trace, 0.0, 0, nw_link);
  57   nw_link->state_current = state_initial;
  58   if (state_trace)
  59     nw_link->state_event =
  60         tmgr_history_add_trace(history, state_trace, 0.0, 0, nw_link);
  61
  62   nw_link->constraint =
  63       lmm_constraint_new(maxmin_system, nw_link, nw_link->bw_current);
  64
  65   xbt_dict_set(network_link_set, name, nw_link, network_link_free);
  66
  67   return nw_link;
  68 }
  69
  70 static void network_card_free(void *nw_card)
  71 {
  72   free(((network_card_DASSF_t)nw_card)->name);
  73   free(nw_card);
  74 }
  75
  76 static int network_card_new(const char *card_name)
  77 {
  78   network_card_DASSF_t card = xbt_dict_get_or_null(network_card_set, card_name);
  79
  80   if (!card) {
  81     card = xbt_new0(s_network_card_DASSF_t, 1);
  82     card->name = xbt_strdup(card_name);
  83     card->id = card_number++;
  84     xbt_dict_set(network_card_set, card_name, card, network_card_free);
  85   }
  86   return card->id;
  87 }
  88
  89 static void route_new(int src_id, int dst_id, network_link_DASSF_t *link_list, int nb_link)
  90 {
  91   ROUTE_SIZE(src_id, dst_id) = nb_link;
  92   ROUTE(src_id, dst_id) = link_list = xbt_realloc(link_list, sizeof(network_link_DASSF_t) * nb_link);
  93 }
  94
  95 static void parse_network_link(void)
  96 {
  97   char *name;
  98   double bw_initial;
  99   tmgr_trace_t bw_trace;
 100   double lat_initial;
 101   tmgr_trace_t lat_trace;
 102   e_surf_network_link_state_t state_initial = SURF_NETWORK_LINK_ON;
 103   tmgr_trace_t state_trace;
 104
 105   name = xbt_strdup(A_surfxml_network_link_name);
 106   surf_parse_get_double(&bw_initial,A_surfxml_network_link_bandwidth);
 107   surf_parse_get_trace(&bw_trace, A_surfxml_network_link_bandwidth_file);
 108   surf_parse_get_double(&lat_initial,A_surfxml_network_link_latency);
 109   surf_parse_get_trace(&lat_trace, A_surfxml_network_link_latency_file);
 110
 111   xbt_assert0((A_surfxml_network_link_state==A_surfxml_network_link_state_ON)||
 112               (A_surfxml_network_link_state==A_surfxml_network_link_state_OFF),
 113               "Invalid state");
 114   if (A_surfxml_network_link_state==A_surfxml_network_link_state_ON)
 115     state_initial = SURF_NETWORK_LINK_ON;
 116   if (A_surfxml_network_link_state==A_surfxml_network_link_state_OFF)
 117     state_initial = SURF_NETWORK_LINK_OFF;
 118   surf_parse_get_trace(&state_trace,A_surfxml_network_link_state_file);
 119
 120   network_link_new(name, bw_initial, bw_trace,
 121                    lat_initial, lat_trace, state_initial, state_trace);
 122 }
 123
 124 static int nb_link;
 125 static int link_list_capacity;
 126 static network_link_DASSF_t *link_list = NULL;
 127 static int src_id = -1;
 128 static int dst_id = -1;
 129
 130 static void parse_route_set_endpoints(void)
 131 {
 132   src_id = network_card_new(A_surfxml_route_src);
 133   dst_id = network_card_new(A_surfxml_route_dst);
 134   nb_link = 0;
 135   link_list_capacity = 20;
 136   link_list = xbt_new(network_link_DASSF_t, link_list_capacity);
 137 }
 138
 139 static void parse_route_elem(void)
 140 {
 141   if (nb_link == link_list_capacity) {
 142     link_list_capacity *= 2;
 143     link_list = xbt_realloc(link_list, link_list_capacity * sizeof(network_link_DASSF_t));
 144   }
 145   link_list[nb_link++] = xbt_dict_get_or_null(network_link_set, A_surfxml_route_element_name);
 146 }
 147
 148 static void parse_route_set_route(void)
 149 {
 150   route_new(src_id, dst_id, link_list, nb_link);
 151 }
 152
 153 static void parse_file(const char *file)
 154 {
 155   /* Figuring out the network links */
 156   surf_parse_reset_parser();
 157   ETag_surfxml_network_link_fun=parse_network_link;
 158   surf_parse_open(file);
 159   xbt_assert1((!surf_parse()),"Parse error in %s",file);
 160   surf_parse_close();
 161
 162   /* Figuring out the network cards used */
 163   surf_parse_reset_parser();
 164   STag_surfxml_route_fun=parse_route_set_endpoints;
 165   surf_parse_open(file);
 166   xbt_assert1((!surf_parse()),"Parse error in %s",file);
 167   surf_parse_close();
 168
 169   create_routing_table();
 170
 171   /* Building the routes */
 172   surf_parse_reset_parser();
 173   STag_surfxml_route_fun=parse_route_set_endpoints;
 174   ETag_surfxml_route_element_fun=parse_route_elem;
 175   ETag_surfxml_route_fun=parse_route_set_route;
 176   surf_parse_open(file);
 177   xbt_assert1((!surf_parse()),"Parse error in %s",file);
 178   surf_parse_close();
 179 }
 180
 181 static void *name_service(const char *name)
 182 {
 183   return xbt_dict_get_or_null(network_card_set, name);
 184 }
 185
 186 static const char *get_resource_name(void *resource_id)
 187 {
 188   return ((network_card_DASSF_t) resource_id)->name;
 189 }
 190
 191 static int resource_used(void *resource_id)
 192 {
 193   return lmm_constraint_used(maxmin_system,
 194                              ((network_link_DASSF_t) resource_id)->constraint);
 195 }
 196
 197 static int action_free(surf_action_t action)
 198 {
 199   action->using--;
 200   if(!action->using) {
 201     xbt_swag_remove(action, action->state_set);
 202     if(((surf_action_network_DASSF_t)action)->variable)
 203       lmm_variable_free(maxmin_system, ((surf_action_network_DASSF_t)action)->variable);
 204     free(action);
 205   }
 206   return 1;
 207 }
 208
 209 static void action_cancel(surf_action_t action)
 210 {
 211   return;
 212 }
 213
 214 static void action_recycle(surf_action_t action)
 215 {
 216   return;
 217 }
 218
 219 static void action_change_state(surf_action_t action,
 220                                 e_surf_action_state_t state)
 221 {
 222 /*   if((state==SURF_ACTION_DONE) || (state==SURF_ACTION_FAILED)) */
 223 /*     if(((surf_action_network_DASSF_t)action)->variable) { */
 224 /*       lmm_variable_disable(maxmin_system, ((surf_action_network_DASSF_t)action)->variable); */
 225 /*       ((surf_action_network_DASSF_t)action)->variable = NULL; */
 226 /*     } */
 227
 228   surf_action_change_state(action, state);
 229   return;
 230 }
 231
 232 /* I nothing more happens, return the date at which the first action that will terminate does terminate */
 233 /* This returns the time for the first NETWORK action to complete */
 234 /* It would be nice to store this minimum somewhere so that the next function can
 235    figure out whether the min comes from the network or from something else */
 236 static double share_resources(double now)
 237 {
 238   s_surf_action_network_DASSF_t s_action;
 239   surf_action_network_DASSF_t action = NULL;
 240   xbt_swag_t running_actions = surf_network_resource->common_public->states.running_action_set;
 241   double min = generic_maxmin_share_resources(running_actions,
 242                                               xbt_swag_offset(s_action, variable));
 243
 244   xbt_swag_foreach(action, running_actions) {
 245     if(action->latency>0) {
 246       if(min<0) min = action->latency;
 247       else if (action->latency<min) min = action->latency;
 248     }
 249   }
 250
 251   return min;
 252 }
 253
 254 /* delta: by how many time units the simulation must advance */
 255 /* In this function: change the state of actions that terminate */
 256 /* The delta may not come from the network, and thus may be different (smaller)
 257    than the one returned by the function above */
 258 /* If the delta is a network-caused min, then do not emulate any timer in the
 259    network simulation, otherwise fake a timer somehow to advance the simulation of min seconds */
 260
 261 static void update_actions_state(double now, double delta)
 262 {
 263   double deltap = 0.0;
 264   surf_action_network_DASSF_t action = NULL;
 265   surf_action_network_DASSF_t next_action = NULL;
 266   xbt_swag_t running_actions =
 267       surf_network_resource->common_public->states.running_action_set;
 268   /* KILLME: unused
 269   xbt_swag_t failed_actions =
 270       surf_network_resource->common_public->states.failed_action_set;
 271   */
 272
 273   xbt_swag_foreach_safe(action, next_action, running_actions) {
 274     deltap = delta;
 275     if (action->latency > 0) {
 276       if (action->latency > deltap) {
 277         double_update(&(action->latency),deltap);
 278         deltap = 0.0;
 279       } else {
 280         double_update(&(deltap), action->latency);
 281         action->latency = 0.0;
 282       }
 283       if ((action->latency == 0.0) && !(action->suspended))
 284         lmm_update_variable_weight(maxmin_system, action->variable, 1.0);
 285     }
 286     double_update(&(action->generic_action.remains),
 287         lmm_variable_getvalue(action->variable) * deltap);
 288     if (action->generic_action.max_duration != NO_MAX_DURATION)
 289       double_update(&(action->generic_action.max_duration), delta);
 290
 291     /*   if(action->generic_action.remains<.00001) action->generic_action.remains=0; */
 292
 293     if (action->generic_action.remains <= 0) {
 294       action->generic_action.finish = surf_get_clock();
 295       action_change_state((surf_action_t) action, SURF_ACTION_DONE);
 296     } else if ((action->generic_action.max_duration != NO_MAX_DURATION) &&
 297                (action->generic_action.max_duration <= 0)) {
 298       action->generic_action.finish = surf_get_clock();
 299       action_change_state((surf_action_t) action, SURF_ACTION_DONE);
 300     } else {                    /* Need to check that none of the resource has failed */
 301       /* to ignore for now */
 302       lmm_constraint_t cnst = NULL;
 303       int i = 0;
 304       network_link_DASSF_t nw_link = NULL;
 305
 306       while ((cnst =
 307               lmm_get_cnst_from_var(maxmin_system, action->variable,
 308                                     i++))) {
 309         nw_link = lmm_constraint_id(cnst);
 310         if (nw_link->state_current == SURF_NETWORK_LINK_OFF) {
 311           action->generic_action.finish = surf_get_clock();
 312           action_change_state((surf_action_t) action, SURF_ACTION_FAILED);
 313           break;
 314         }
 315       }
 316     }
 317   }
 318
 319   return;
 320 }
 321
 322 /* Called only when there is a change in trace: Useless in packet-level simulation */
 323 static void update_resource_state(void *id,
 324                                   tmgr_trace_event_t event_type,
 325                                   double value)
 326 {
 327   network_link_DASSF_t nw_link = id;
 328   /*   printf("[" "%lg" "] Asking to update network card \"%s\" with value " */
 329   /*     "%lg" " for event %p\n", surf_get_clock(), nw_link->name, */
 330   /*     value, event_type); */
 331
 332   if (event_type == nw_link->bw_event) {
 333     nw_link->bw_current = value;
 334     lmm_update_constraint_bound(maxmin_system, nw_link->constraint,
 335                                 nw_link->bw_current);
 336   } else if (event_type == nw_link->lat_event) {
 337     double delta = value - nw_link->lat_current;
 338     lmm_variable_t var = NULL;
 339     surf_action_network_DASSF_t action = NULL;
 340
 341     nw_link->lat_current = value;
 342     while (lmm_get_var_from_cnst(maxmin_system, nw_link->constraint, &var)) {
 343       action = lmm_variable_id(var);
 344       action->lat_current += delta;
 345       if(action->rate<0)
 346         lmm_update_variable_bound(maxmin_system, action->variable,
 347                                   SG_TCP_CTE_GAMMA / action->lat_current);
 348       else
 349         lmm_update_variable_bound(maxmin_system, action->variable,
 350                                   min(action->rate,SG_TCP_CTE_GAMMA / action->lat_current));
 351     }
 352   } else if (event_type == nw_link->state_event) {
 353     if (value > 0)
 354       nw_link->state_current = SURF_NETWORK_LINK_ON;
 355     else
 356       nw_link->state_current = SURF_NETWORK_LINK_OFF;
 357   } else {
 358     CRITICAL0("Unknown event ! \n");
 359     xbt_abort();
 360   }
 361
 362   return;
 363 }
 364
 365 static surf_action_t communicate(void *src, void *dst, double size, double rate)
 366 {
 367   surf_action_network_DASSF_t action = NULL;
 368   network_card_DASSF_t card_src = src;
 369   network_card_DASSF_t card_dst = dst;
 370   int route_size = ROUTE_SIZE(card_src->id, card_dst->id);
 371   network_link_DASSF_t *route = ROUTE(card_src->id, card_dst->id);
 372   int i;
 373
 374   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);
 375
 376   action = xbt_new0(s_surf_action_network_DASSF_t, 1);
 377
 378   action->generic_action.using = 1;
 379   action->generic_action.cost = size;
 380   action->generic_action.remains = size;
 381   action->generic_action.max_duration = NO_MAX_DURATION;
 382   action->generic_action.start = -1.0;
 383   action->generic_action.finish = -1.0;
 384   action->generic_action.resource_type =
 385       (surf_resource_t) surf_network_resource;
 386
 387   action->generic_action.state_set =
 388       surf_network_resource->common_public->states.running_action_set;
 389
 390   xbt_swag_insert(action, action->generic_action.state_set);
 391   action->rate = rate;
 392
 393   action->latency = 0.0;
 394   for (i = 0; i < route_size; i++)
 395     action->latency += route[i]->lat_current;
 396   action->lat_current = action->latency;
 397
 398   if(action->latency>0)
 399     action->variable = lmm_variable_new(maxmin_system, action, 0.0, -1.0,
 400                                         route_size);
 401   else
 402     action->variable = lmm_variable_new(maxmin_system, action, 1.0, -1.0,
 403                                         route_size);
 404
 405   if(action->rate<0)
 406     lmm_update_variable_bound(maxmin_system, action->variable,
 407                               SG_TCP_CTE_GAMMA / action->lat_current);
 408   else
 409     lmm_update_variable_bound(maxmin_system, action->variable,
 410                               min(action->rate,SG_TCP_CTE_GAMMA / action->lat_current));
 411
 412   if(route_size == 0) {
 413     action_change_state((surf_action_t) action, SURF_ACTION_DONE);
 414   }
 415
 416   for (i = 0; i < route_size; i++)
 417     lmm_expand(maxmin_system, route[i]->constraint, action->variable, 1.0);
 418
 419   return (surf_action_t) action;
 420 }
 421
 422 /* returns a NULL-terminated array of network_link_DASSF_t */
 423 static const void** get_route(void *src, void *dst) {
 424   network_card_DASSF_t card_src = src;
 425   network_card_DASSF_t card_dst = dst;
 426   return (const void**) ROUTE(card_src->id, card_dst->id);
 427 }
 428
 429 static int get_route_size(void *src, void *dst) {
 430   network_card_DASSF_t card_src = src;
 431   network_card_DASSF_t card_dst = dst;
 432   return ROUTE_SIZE(card_src->id, card_dst->id);
 433 }
 434
 435 static const char *get_link_name(const void *link) {
 436   return ((network_link_DASSF_t) link)->name;
 437 }
 438
 439 static double get_link_bandwidth(const void *link) {
 440   return ((network_link_DASSF_t) link)->bw_current;
 441 }
 442
 443 static double get_link_latency(const void *link) {
 444   return ((network_link_DASSF_t) link)->lat_current;
 445 }
 446
 447 static void action_suspend(surf_action_t action)
 448 {
 449   ((surf_action_network_DASSF_t) action)->suspended = 1;
 450   lmm_update_variable_weight(maxmin_system,
 451                              ((surf_action_network_DASSF_t) action)->variable, 0.0);
 452 }
 453
 454 static void action_resume(surf_action_t action)
 455 {
 456   lmm_update_variable_weight(maxmin_system,
 457                              ((surf_action_network_DASSF_t) action)->variable, 1.0);
 458   ((surf_action_network_DASSF_t) action)->suspended = 0;
 459 }
 460
 461 static int action_is_suspended(surf_action_t action)
 462 {
 463   return ((surf_action_network_DASSF_t) action)->suspended;
 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_get_start_time =
 525       surf_action_get_start_time;
 526   surf_network_resource->common_public->action_get_finish_time =
 527       surf_action_get_finish_time;
 528   surf_network_resource->common_public->action_free = action_free;
 529   surf_network_resource->common_public->action_cancel = action_cancel;
 530   surf_network_resource->common_public->action_recycle = action_recycle;
 531   surf_network_resource->common_public->action_change_state =
 532       action_change_state;
 533   surf_network_resource->common_public->action_set_data = surf_action_set_data;
 534   surf_network_resource->common_public->name = "network";
 535
 536   surf_network_resource->common_private->resource_used = resource_used;
 537   surf_network_resource->common_private->share_resources = share_resources;
 538   surf_network_resource->common_private->update_actions_state =
 539       update_actions_state;
 540   surf_network_resource->common_private->update_resource_state =
 541       update_resource_state;
 542   surf_network_resource->common_private->finalize = finalize;
 543
 544   surf_network_resource->common_public->suspend = action_suspend;
 545   surf_network_resource->common_public->resume = action_resume;
 546   surf_network_resource->common_public->is_suspended = action_is_suspended;
 547
 548   surf_network_resource->extension_public->communicate = communicate;
 549   surf_network_resource->extension_public->get_route = get_route;
 550   surf_network_resource->extension_public->get_route_size = get_route_size;
 551   surf_network_resource->extension_public->get_link_name = get_link_name;
 552   surf_network_resource->extension_public->get_link_bandwidth = get_link_bandwidth;
 553   surf_network_resource->extension_public->get_link_latency = get_link_latency;
 554
 555   network_link_set = xbt_dict_new();
 556   network_card_set = xbt_dict_new();
 557
 558   xbt_assert0(maxmin_system, "surf_init has to be called first!");
 559 }
 560
 561 /***************************************************************************/
 562 /* The nice Hack by Henri to use DASSF from within SURF !                  */
 563 /***************************************************************************/
 564 /* I put this prototype here for now but it will have to go in
 565    src/include/surf.h when it will be functionnal. */
 566 void surf_network_resource_init_DASSF(const char *filename);
 567
 568 void surf_network_resource_init_DASSF(const char *filename)
 569 {
 570   if (surf_network_resource)
 571     return;
 572   surf_network_resource_init_internal();
 573   parse_file(filename);
 574   xbt_dynar_push(resource_list, &surf_network_resource);
 575 }