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_NEW_DEFAULT_SUBCATEGORY(network_dassf, surf,
  11                                 "Logging specific to the SURF network module");
  12
  13 /* surf_network_resource_t surf_network_resource = NULL; */
  14 static xbt_dict_t network_link_set = NULL;
  15 /* xbt_dict_t network_card_set = NULL; */
  16
  17 static int card_number = 0;
  18 static network_link_DASSF_t **routing_table = NULL;
  19 static int *routing_table_size = NULL;
  20
  21 #define ROUTE(i,j) routing_table[(i)+(j)*card_number]
  22 #define ROUTE_SIZE(i,j) routing_table_size[(i)+(j)*card_number]
  23
  24 static void create_routing_table(void)
  25 {
  26   routing_table = xbt_new0(network_link_DASSF_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_DASSF_t)nw_link)->name);
  33   free(nw_link);
  34 }
  35
  36 static network_link_DASSF_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 {
  45   network_link_DASSF_t nw_link = xbt_new0(s_network_link_DASSF_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, nw_link->bw_current);
  65
  66   xbt_dict_set(network_link_set, name, nw_link, network_link_free);
  67
  68   return nw_link;
  69 }
  70
  71 static void network_card_free(void *nw_card)
  72 {
  73   free(((network_card_DASSF_t)nw_card)->name);
  74   free(nw_card);
  75 }
  76
  77 static int network_card_new(const char *card_name)
  78 {
  79   network_card_DASSF_t card = xbt_dict_get_or_null(network_card_set, card_name);
  80
  81   if (!card) {
  82     card = xbt_new0(s_network_card_DASSF_t, 1);
  83     card->name = xbt_strdup(card_name);
  84     card->id = card_number++;
  85     xbt_dict_set(network_card_set, card_name, card, network_card_free);
  86   }
  87   return card->id;
  88 }
  89
  90 static void route_new(int src_id, int dst_id, char **links, int nb_link)
  91 {
  92   network_link_DASSF_t *link_list = NULL;
  93   int i;
  94
  95   ROUTE_SIZE(src_id, dst_id) = nb_link;
  96   link_list = (ROUTE(src_id, dst_id) = xbt_new0(network_link_DASSF_t, nb_link));
  97   for (i = 0; i < nb_link; i++) {
  98     link_list[i] = xbt_dict_get_or_null(network_link_set, links[i]);
  99     free(links[i]);
 100   }
 101   free(links);
 102 }
 103
 104 static void parse_network_link(void)
 105 {
 106   char *name;
 107   double bw_initial;
 108   tmgr_trace_t bw_trace;
 109   double lat_initial;
 110   tmgr_trace_t lat_trace;
 111   e_surf_network_link_state_t state_initial = SURF_NETWORK_LINK_ON;
 112   tmgr_trace_t state_trace;
 113
 114   name = xbt_strdup(A_surfxml_network_link_name);
 115   surf_parse_get_double(&bw_initial,A_surfxml_network_link_bandwidth);
 116   surf_parse_get_trace(&bw_trace, A_surfxml_network_link_bandwidth_file);
 117   surf_parse_get_double(&lat_initial,A_surfxml_network_link_latency);
 118   surf_parse_get_trace(&lat_trace, A_surfxml_network_link_latency_file);
 119
 120   xbt_assert0((A_surfxml_network_link_state==A_surfxml_network_link_state_ON)||
 121               (A_surfxml_network_link_state==A_surfxml_network_link_state_OFF),
 122               "Invalid state");
 123   if (A_surfxml_network_link_state==A_surfxml_network_link_state_ON)
 124     state_initial = SURF_NETWORK_LINK_ON;
 125   if (A_surfxml_network_link_state==A_surfxml_network_link_state_OFF)
 126     state_initial = SURF_NETWORK_LINK_OFF;
 127   surf_parse_get_trace(&state_trace,A_surfxml_network_link_state_file);
 128
 129   network_link_new(name, bw_initial, bw_trace,
 130                    lat_initial, lat_trace, state_initial, state_trace);
 131 }
 132
 133 static int nb_link = 0;
 134 static char **link_name = NULL;
 135 static int src_id = -1;
 136 static int dst_id = -1;
 137
 138 static void parse_route_set_endpoints(void)
 139 {
 140   src_id = network_card_new(A_surfxml_route_src);
 141   dst_id = network_card_new(A_surfxml_route_dst);
 142   nb_link = 0;
 143   link_name = NULL;
 144 }
 145
 146 static void parse_route_elem(void)
 147 {
 148   nb_link++;
 149   link_name = xbt_realloc(link_name, (nb_link) * sizeof(char *));
 150   link_name[(nb_link) - 1] = xbt_strdup(A_surfxml_route_element_name);
 151 }
 152
 153 static void parse_route_set_route(void)
 154 {
 155   route_new(src_id, dst_id, link_name, nb_link);
 156 }
 157
 158 static void parse_file(const char *file)
 159 {
 160   /* Figuring out the network links */
 161   surf_parse_reset_parser();
 162   ETag_surfxml_network_link_fun=parse_network_link;
 163   surf_parse_open(file);
 164   xbt_assert1((!surf_parse()),"Parse error in %s",file);
 165   surf_parse_close();
 166
 167   /* Figuring out the network cards used */
 168   surf_parse_reset_parser();
 169   STag_surfxml_route_fun=parse_route_set_endpoints;
 170   surf_parse_open(file);
 171   xbt_assert1((!surf_parse()),"Parse error in %s",file);
 172   surf_parse_close();
 173
 174   create_routing_table();
 175
 176   /* Building the routes */
 177   surf_parse_reset_parser();
 178   STag_surfxml_route_fun=parse_route_set_endpoints;
 179   ETag_surfxml_route_element_fun=parse_route_elem;
 180   ETag_surfxml_route_fun=parse_route_set_route;
 181   surf_parse_open(file);
 182   xbt_assert1((!surf_parse()),"Parse error in %s",file);
 183   surf_parse_close();
 184 }
 185
 186 static void *name_service(const char *name)
 187 {
 188   return xbt_dict_get_or_null(network_card_set, name);
 189 }
 190
 191 static const char *get_resource_name(void *resource_id)
 192 {
 193   return ((network_card_DASSF_t) resource_id)->name;
 194 }
 195
 196 static int resource_used(void *resource_id)
 197 {
 198   return lmm_constraint_used(maxmin_system,
 199                              ((network_link_DASSF_t) resource_id)->constraint);
 200 }
 201
 202 static int action_free(surf_action_t action)
 203 {
 204   action->using--;
 205   if(!action->using) {
 206     xbt_swag_remove(action, action->state_set);
 207     if(((surf_action_network_DASSF_t)action)->variable)
 208       lmm_variable_free(maxmin_system, ((surf_action_network_DASSF_t)action)->variable);
 209     free(action);
 210   }
 211   return 1;
 212 }
 213
 214 static void action_cancel(surf_action_t action)
 215 {
 216   return;
 217 }
 218
 219 static void action_recycle(surf_action_t action)
 220 {
 221   return;
 222 }
 223
 224 static void action_change_state(surf_action_t action,
 225                                 e_surf_action_state_t state)
 226 {
 227 /*   if((state==SURF_ACTION_DONE) || (state==SURF_ACTION_FAILED)) */
 228 /*     if(((surf_action_network_DASSF_t)action)->variable) { */
 229 /*       lmm_variable_disable(maxmin_system, ((surf_action_network_DASSF_t)action)->variable); */
 230 /*       ((surf_action_network_DASSF_t)action)->variable = NULL; */
 231 /*     } */
 232
 233   surf_action_change_state(action, state);
 234   return;
 235 }
 236
 237 static double share_resources(double now)
 238 {
 239   s_surf_action_network_DASSF_t s_action;
 240   surf_action_network_DASSF_t action = NULL;
 241   xbt_swag_t running_actions = surf_network_resource->common_public->states.running_action_set;
 242   double min = generic_maxmin_share_resources(running_actions,
 243                                               xbt_swag_offset(s_action, variable));
 244
 245   xbt_swag_foreach(action, running_actions) {
 246     if(action->latency>0) {
 247       if(min<0) min = action->latency;
 248       else if (action->latency<min) min = action->latency;
 249     }
 250   }
 251
 252   return min;
 253 }
 254
 255 static void update_actions_state(double now, double delta)
 256 {
 257   double deltap = 0.0;
 258   surf_action_network_DASSF_t action = NULL;
 259   surf_action_network_DASSF_t next_action = NULL;
 260   xbt_swag_t running_actions =
 261       surf_network_resource->common_public->states.running_action_set;
 262   /* KILLME: unused
 263   xbt_swag_t failed_actions =
 264       surf_network_resource->common_public->states.failed_action_set;
 265   */
 266
 267   xbt_swag_foreach_safe(action, next_action, running_actions) {
 268     deltap = delta;
 269     if (action->latency > 0) {
 270       if (action->latency > deltap) {
 271         surf_double_update(&(action->latency),deltap);
 272         deltap = 0.0;
 273       } else {
 274         surf_double_update(&(deltap), action->latency);
 275         action->latency = 0.0;
 276       }
 277       if ((action->latency == 0.0) && !(action->suspended))
 278         lmm_update_variable_weight(maxmin_system, action->variable, 1.0);
 279     }
 280     surf_double_update(&(action->generic_action.remains),
 281         lmm_variable_getvalue(action->variable) * deltap);
 282     if (action->generic_action.max_duration != NO_MAX_DURATION)
 283       surf_double_update(&(action->generic_action.max_duration), delta);
 284
 285     /*   if(action->generic_action.remains<.00001) action->generic_action.remains=0; */
 286
 287     if (action->generic_action.remains <= 0) {
 288       action->generic_action.finish = surf_get_clock();
 289       action_change_state((surf_action_t) action, SURF_ACTION_DONE);
 290     } else if ((action->generic_action.max_duration != NO_MAX_DURATION) &&
 291                (action->generic_action.max_duration <= 0)) {
 292       action->generic_action.finish = surf_get_clock();
 293       action_change_state((surf_action_t) action, SURF_ACTION_DONE);
 294     } else {                    /* Need to check that none of the resource has failed */
 295       lmm_constraint_t cnst = NULL;
 296       int i = 0;
 297       network_link_DASSF_t nw_link = NULL;
 298
 299       while ((cnst =
 300               lmm_get_cnst_from_var(maxmin_system, action->variable,
 301                                     i++))) {
 302         nw_link = lmm_constraint_id(cnst);
 303         if (nw_link->state_current == SURF_NETWORK_LINK_OFF) {
 304           action->generic_action.finish = surf_get_clock();
 305           action_change_state((surf_action_t) action, SURF_ACTION_FAILED);
 306           break;
 307         }
 308       }
 309     }
 310   }
 311
 312   return;
 313 }
 314
 315 static void update_resource_state(void *id,
 316                                   tmgr_trace_event_t event_type,
 317                                   double value)
 318 {
 319   network_link_DASSF_t nw_link = id;
 320   /*   printf("[" "%lg" "] Asking to update network card \"%s\" with value " */
 321   /*     "%lg" " for event %p\n", surf_get_clock(), nw_link->name, */
 322   /*     value, event_type); */
 323
 324   if (event_type == nw_link->bw_event) {
 325     nw_link->bw_current = value;
 326     lmm_update_constraint_bound(maxmin_system, nw_link->constraint,
 327                                 nw_link->bw_current);
 328   } else if (event_type == nw_link->lat_event) {
 329     double delta = value - nw_link->lat_current;
 330     lmm_variable_t var = NULL;
 331     surf_action_network_DASSF_t action = NULL;
 332
 333     nw_link->lat_current = value;
 334     while (lmm_get_var_from_cnst(maxmin_system, nw_link->constraint, &var)) {
 335       action = lmm_variable_id(var);
 336       action->lat_current += delta;
 337       if(action->rate<0)
 338         lmm_update_variable_bound(maxmin_system, action->variable,
 339                                   SG_TCP_CTE_GAMMA / action->lat_current);
 340       else
 341         lmm_update_variable_bound(maxmin_system, action->variable,
 342                                   min(action->rate,SG_TCP_CTE_GAMMA / action->lat_current));
 343     }
 344   } else if (event_type == nw_link->state_event) {
 345     if (value > 0)
 346       nw_link->state_current = SURF_NETWORK_LINK_ON;
 347     else
 348       nw_link->state_current = SURF_NETWORK_LINK_OFF;
 349   } else {
 350     CRITICAL0("Unknown event ! \n");
 351     xbt_abort();
 352   }
 353
 354   return;
 355 }
 356
 357 static surf_action_t communicate(void *src, void *dst, double size, double rate)
 358 {
 359   surf_action_network_DASSF_t action = NULL;
 360   network_card_DASSF_t card_src = src;
 361   network_card_DASSF_t card_dst = dst;
 362   int route_size = ROUTE_SIZE(card_src->id, card_dst->id);
 363   network_link_DASSF_t *route = ROUTE(card_src->id, card_dst->id);
 364   int i;
 365
 366   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);
 367
 368   action = xbt_new0(s_surf_action_network_DASSF_t, 1);
 369
 370   action->generic_action.using = 1;
 371   action->generic_action.cost = size;
 372   action->generic_action.remains = size;
 373   action->generic_action.max_duration = NO_MAX_DURATION;
 374   action->generic_action.start = -1.0;
 375   action->generic_action.finish = -1.0;
 376   action->generic_action.resource_type =
 377       (surf_resource_t) surf_network_resource;
 378
 379   action->generic_action.state_set =
 380       surf_network_resource->common_public->states.running_action_set;
 381
 382   xbt_swag_insert(action, action->generic_action.state_set);
 383   action->rate = rate;
 384
 385   action->latency = 0.0;
 386   for (i = 0; i < route_size; i++)
 387     action->latency += route[i]->lat_current;
 388   action->lat_current = action->latency;
 389
 390   if(action->latency>0)
 391     action->variable = lmm_variable_new(maxmin_system, action, 0.0, -1.0,
 392                                         route_size);
 393   else
 394     action->variable = lmm_variable_new(maxmin_system, action, 1.0, -1.0,
 395                                         route_size);
 396
 397   if(action->rate<0)
 398     lmm_update_variable_bound(maxmin_system, action->variable,
 399                               SG_TCP_CTE_GAMMA / action->lat_current);
 400   else
 401     lmm_update_variable_bound(maxmin_system, action->variable,
 402                               min(action->rate,SG_TCP_CTE_GAMMA / action->lat_current));
 403
 404   if(route_size == 0) {
 405     action_change_state((surf_action_t) action, SURF_ACTION_DONE);
 406   }
 407
 408   for (i = 0; i < route_size; i++)
 409     lmm_expand(maxmin_system, route[i]->constraint, action->variable, 1.0);
 410
 411   return (surf_action_t) action;
 412 }
 413
 414 static void action_suspend(surf_action_t action)
 415 {
 416   ((surf_action_network_DASSF_t) action)->suspended = 1;
 417   lmm_update_variable_weight(maxmin_system,
 418                              ((surf_action_network_DASSF_t) action)->variable, 0.0);
 419 }
 420
 421 static void action_resume(surf_action_t action)
 422 {
 423   lmm_update_variable_weight(maxmin_system,
 424                              ((surf_action_network_DASSF_t) action)->variable, 1.0);
 425   ((surf_action_network_DASSF_t) action)->suspended = 0;
 426 }
 427
 428 static int action_is_suspended(surf_action_t action)
 429 {
 430   return ((surf_action_network_DASSF_t) action)->suspended;
 431 }
 432
 433 static void finalize(void)
 434 {
 435   int i,j;
 436
 437   xbt_dict_free(&network_card_set);
 438   xbt_dict_free(&network_link_set);
 439   xbt_swag_free(surf_network_resource->common_public->states.
 440                 ready_action_set);
 441   xbt_swag_free(surf_network_resource->common_public->states.
 442                 running_action_set);
 443   xbt_swag_free(surf_network_resource->common_public->states.
 444                 failed_action_set);
 445   xbt_swag_free(surf_network_resource->common_public->states.
 446                 done_action_set);
 447   free(surf_network_resource->common_public);
 448   free(surf_network_resource->common_private);
 449   free(surf_network_resource->extension_public);
 450
 451   free(surf_network_resource);
 452   surf_network_resource = NULL;
 453
 454   for (i = 0; i < card_number; i++)
 455     for (j = 0; j < card_number; j++)
 456       free(ROUTE(i,j));
 457   free(routing_table);
 458   routing_table = NULL;
 459   free(routing_table_size);
 460   routing_table_size = NULL;
 461   card_number = 0;
 462 }
 463
 464 static void surf_network_resource_init_internal(void)
 465 {
 466   s_surf_action_t action;
 467
 468   surf_network_resource = xbt_new0(s_surf_network_resource_t, 1);
 469
 470   surf_network_resource->common_private =
 471       xbt_new0(s_surf_resource_private_t, 1);
 472   surf_network_resource->common_public =
 473       xbt_new0(s_surf_resource_public_t, 1);
 474   surf_network_resource->extension_public =
 475       xbt_new0(s_surf_network_resource_extension_public_t, 1);
 476
 477   surf_network_resource->common_public->states.ready_action_set =
 478       xbt_swag_new(xbt_swag_offset(action, state_hookup));
 479   surf_network_resource->common_public->states.running_action_set =
 480       xbt_swag_new(xbt_swag_offset(action, state_hookup));
 481   surf_network_resource->common_public->states.failed_action_set =
 482       xbt_swag_new(xbt_swag_offset(action, state_hookup));
 483   surf_network_resource->common_public->states.done_action_set =
 484       xbt_swag_new(xbt_swag_offset(action, state_hookup));
 485
 486   surf_network_resource->common_public->name_service = name_service;
 487   surf_network_resource->common_public->get_resource_name =
 488       get_resource_name;
 489   surf_network_resource->common_public->action_get_state =
 490       surf_action_get_state;
 491   surf_network_resource->common_public->action_free = action_free;
 492   surf_network_resource->common_public->action_cancel = action_cancel;
 493   surf_network_resource->common_public->action_recycle = action_recycle;
 494   surf_network_resource->common_public->action_change_state =
 495       action_change_state;
 496   surf_network_resource->common_public->action_set_data = surf_action_set_data;
 497   surf_network_resource->common_public->name = "network";
 498
 499   surf_network_resource->common_private->resource_used = resource_used;
 500   surf_network_resource->common_private->share_resources = share_resources;
 501   surf_network_resource->common_private->update_actions_state =
 502       update_actions_state;
 503   surf_network_resource->common_private->update_resource_state =
 504       update_resource_state;
 505   surf_network_resource->common_private->finalize = finalize;
 506
 507   surf_network_resource->common_public->suspend = action_suspend;
 508   surf_network_resource->common_public->resume = action_resume;
 509   surf_network_resource->common_public->is_suspended = action_is_suspended;
 510
 511   surf_network_resource->extension_public->communicate = communicate;
 512
 513   network_link_set = xbt_dict_new();
 514   network_card_set = xbt_dict_new();
 515
 516   xbt_assert0(maxmin_system, "surf_init has to be called first!");
 517 }
 518
 519 /***************************************************************************/
 520 /* The nice Hack by Henri to use DASSF from within SURF !                  */
 521 /***************************************************************************/
 522 /* I put this prototype here for now but it will have to go in
 523    src/include/surf.h when it will be functionnal. */
 524 void surf_network_resource_init_DASSF(const char *filename);
 525
 526 void surf_network_resource_init_DASSF(const char *filename)
 527 {
 528   if (surf_network_resource)
 529     return;
 530   surf_network_resource_init_internal();
 531   parse_file(filename);
 532   xbt_dynar_push(resource_list, &surf_network_resource);
 533 }