src/surf/cpu.c

   1 /* Copyright (c) 2004, 2005, 2006, 2007, 2008, 2009, 2010. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   4 /* This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the license (GNU LGPL) which comes with this package. */
   6
   7 #include "surf_private.h"
   8
   9 typedef s_surf_action_lmm_t s_surf_action_cpu_Cas01_t,
  10     *surf_action_cpu_Cas01_t;
  11
  12 typedef struct cpu_Cas01 {
  13   s_surf_resource_t generic_resource;
  14   double power_peak;
  15   double power_scale;
  16   int core;
  17   tmgr_trace_event_t power_event;
  18   e_surf_resource_state_t state_current;
  19   tmgr_trace_event_t state_event;
  20   lmm_constraint_t constraint;
  21 } s_cpu_Cas01_t, *cpu_Cas01_t;
  22
  23 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_cpu, surf,
  24                                 "Logging specific to the SURF CPU module");
  25
  26
  27
  28 surf_model_t surf_cpu_model = NULL;
  29 lmm_system_t cpu_maxmin_system = NULL;
  30
  31
  32 static xbt_swag_t cpu_running_action_set_that_does_not_need_being_checked =
  33     NULL;
  34
  35 static cpu_Cas01_t cpu_new(char *name, double power_peak,
  36                            double power_scale,
  37                            tmgr_trace_t power_trace,
  38                            int core,
  39                            e_surf_resource_state_t state_initial,
  40                            tmgr_trace_t state_trace,
  41                            xbt_dict_t cpu_properties)
  42 {
  43   cpu_Cas01_t cpu = xbt_new0(s_cpu_Cas01_t, 1);
  44   xbt_assert(!surf_cpu_resource_by_name(name),
  45               "Host '%s' declared several times in the platform file",
  46               name);
  47   cpu->generic_resource.model = surf_cpu_model;
  48   cpu->generic_resource.name = name;
  49   cpu->generic_resource.properties = cpu_properties;
  50   cpu->power_peak = power_peak;
  51   xbt_assert(cpu->power_peak > 0, "Power has to be >0");
  52   cpu->power_scale = power_scale;
  53   cpu->core = core;
  54   xbt_assert(core>0,"Invalid number of cores %d",core);
  55   if (power_trace)
  56     cpu->power_event =
  57         tmgr_history_add_trace(history, power_trace, 0.0, 0, cpu);
  58
  59   cpu->state_current = state_initial;
  60   if (state_trace)
  61     cpu->state_event =
  62         tmgr_history_add_trace(history, state_trace, 0.0, 0, cpu);
  63
  64   cpu->constraint =
  65       lmm_constraint_new(cpu_maxmin_system, cpu,
  66                          cpu->core * cpu->power_scale * cpu->power_peak);
  67
  68   xbt_lib_set(host_lib, name, SURF_CPU_LEVEL, cpu);
  69
  70   return cpu;
  71 }
  72
  73
  74 static void parse_cpu_init(void)
  75 {
  76   double power_peak = 0.0;
  77   double power_scale = 0.0;
  78   int core = 0;
  79   tmgr_trace_t power_trace = NULL;
  80   e_surf_resource_state_t state_initial = SURF_RESOURCE_OFF;
  81   tmgr_trace_t state_trace = NULL;
  82
  83   power_peak = get_cpu_power(A_surfxml_host_power);
  84   surf_parse_get_double(&power_scale, A_surfxml_host_availability);
  85   power_trace = tmgr_trace_new(A_surfxml_host_availability_file);
  86   surf_parse_get_int(&core, A_surfxml_host_core);
  87
  88   xbt_assert((A_surfxml_host_state == A_surfxml_host_state_ON) ||
  89               (A_surfxml_host_state == A_surfxml_host_state_OFF),
  90               "Invalid state");
  91   if (A_surfxml_host_state == A_surfxml_host_state_ON)
  92     state_initial = SURF_RESOURCE_ON;
  93   if (A_surfxml_host_state == A_surfxml_host_state_OFF)
  94     state_initial = SURF_RESOURCE_OFF;
  95   state_trace = tmgr_trace_new(A_surfxml_host_state_file);
  96
  97   cpu_new(xbt_strdup(A_surfxml_host_id), power_peak, power_scale,
  98           power_trace, core, state_initial, state_trace, current_property_set);
  99   current_property_set = NULL;
 100 }
 101
 102 static void add_traces_cpu(void)
 103 {
 104   xbt_dict_cursor_t cursor = NULL;
 105   char *trace_name, *elm;
 106
 107   static int called = 0;
 108
 109   if (called)
 110     return;
 111   called = 1;
 112
 113
 114   /* connect all traces relative to hosts */
 115   xbt_dict_foreach(trace_connect_list_host_avail, cursor, trace_name, elm) {
 116     tmgr_trace_t trace = xbt_dict_get_or_null(traces_set_list, trace_name);
 117     cpu_Cas01_t host = surf_cpu_resource_by_name(elm);
 118
 119     xbt_assert(host, "Host %s undefined", elm);
 120     xbt_assert(trace, "Trace %s undefined", trace_name);
 121
 122     host->state_event =
 123         tmgr_history_add_trace(history, trace, 0.0, 0, host);
 124   }
 125
 126   xbt_dict_foreach(trace_connect_list_power, cursor, trace_name, elm) {
 127     tmgr_trace_t trace = xbt_dict_get_or_null(traces_set_list, trace_name);
 128     cpu_Cas01_t host = surf_cpu_resource_by_name(elm);
 129
 130     xbt_assert(host, "Host %s undefined", elm);
 131     xbt_assert(trace, "Trace %s undefined", trace_name);
 132
 133     host->power_event =
 134         tmgr_history_add_trace(history, trace, 0.0, 0, host);
 135   }
 136 }
 137
 138 static void cpu_define_callbacks(const char *file)
 139 {
 140   surfxml_add_callback(ETag_surfxml_host_cb_list, parse_cpu_init);
 141   surfxml_add_callback(ETag_surfxml_platform_cb_list, &add_traces_cpu);
 142 }
 143
 144 static int cpu_resource_used(void *resource_id)
 145 {
 146   return lmm_constraint_used(cpu_maxmin_system,
 147                              ((cpu_Cas01_t) resource_id)->constraint);
 148 }
 149
 150 static int cpu_action_unref(surf_action_t action)
 151 {
 152   action->refcount--;
 153   if (!action->refcount) {
 154     xbt_swag_remove(action, action->state_set);
 155     if (((surf_action_cpu_Cas01_t) action)->variable)
 156       lmm_variable_free(cpu_maxmin_system,
 157                         ((surf_action_cpu_Cas01_t) action)->variable);
 158 #ifdef HAVE_TRACING
 159     if (action->category)
 160       xbt_free(action->category);
 161 #endif
 162     surf_action_free(&action);
 163     return 1;
 164   }
 165   return 0;
 166 }
 167
 168 static void cpu_action_cancel(surf_action_t action)
 169 {
 170   surf_action_state_set(action, SURF_ACTION_FAILED);
 171   return;
 172 }
 173
 174 static void cpu_action_state_set(surf_action_t action,
 175                                  e_surf_action_state_t state)
 176 {
 177 /*   if((state==SURF_ACTION_DONE) || (state==SURF_ACTION_FAILED)) */
 178 /*     if(((surf_action_cpu_Cas01_t)action)->variable) { */
 179 /*       lmm_variable_disable(cpu_maxmin_system, ((surf_action_cpu_Cas01_t)action)->variable); */
 180 /*       ((surf_action_cpu_Cas01_t)action)->variable = NULL; */
 181 /*     } */
 182
 183   surf_action_state_set(action, state);
 184   return;
 185 }
 186
 187 static double cpu_share_resources(double now)
 188 {
 189   s_surf_action_cpu_Cas01_t action;
 190   return generic_maxmin_share_resources(surf_cpu_model->
 191                                         states.running_action_set,
 192                                         xbt_swag_offset(action, variable),
 193                                         cpu_maxmin_system, lmm_solve);
 194 }
 195
 196 static void cpu_update_actions_state(double now, double delta)
 197 {
 198   surf_action_cpu_Cas01_t action = NULL;
 199   surf_action_cpu_Cas01_t next_action = NULL;
 200   xbt_swag_t running_actions = surf_cpu_model->states.running_action_set;
 201
 202   xbt_swag_foreach_safe(action, next_action, running_actions) {
 203 #ifdef HAVE_TRACING
 204     cpu_Cas01_t x =
 205         lmm_constraint_id(lmm_get_cnst_from_var
 206                           (cpu_maxmin_system, action->variable, 0));
 207
 208     TRACE_surf_host_set_utilization(x->generic_resource.name,
 209                                     action->generic_action.data,
 210                                     (surf_action_t) action,
 211                                     lmm_variable_getvalue
 212                                     (action->variable), now - delta,
 213                                     delta);
 214     TRACE_last_timestamp_to_dump = now-delta;
 215 #endif
 216     double_update(&(action->generic_action.remains),
 217                   lmm_variable_getvalue(action->variable) * delta);
 218     if (action->generic_action.max_duration != NO_MAX_DURATION)
 219       double_update(&(action->generic_action.max_duration), delta);
 220     if ((action->generic_action.remains <= 0) &&
 221         (lmm_get_variable_weight(action->variable) > 0)) {
 222       action->generic_action.finish = surf_get_clock();
 223       cpu_action_state_set((surf_action_t) action, SURF_ACTION_DONE);
 224     } else if ((action->generic_action.max_duration != NO_MAX_DURATION) &&
 225                (action->generic_action.max_duration <= 0)) {
 226       action->generic_action.finish = surf_get_clock();
 227       cpu_action_state_set((surf_action_t) action, SURF_ACTION_DONE);
 228     }
 229   }
 230
 231   return;
 232 }
 233
 234 static void cpu_update_resource_state(void *id,
 235                                       tmgr_trace_event_t event_type,
 236                                       double value, double date)
 237 {
 238   cpu_Cas01_t cpu = id;
 239   lmm_variable_t var = NULL;
 240   lmm_element_t elem = NULL;
 241
 242   if (event_type == cpu->power_event) {
 243     cpu->power_scale = value;
 244     lmm_update_constraint_bound(cpu_maxmin_system, cpu->constraint,
 245                                 cpu->core * cpu->power_scale * cpu->power_peak);
 246 #ifdef HAVE_TRACING
 247     TRACE_surf_host_set_power(date, cpu->generic_resource.name,
 248                               cpu->core * cpu->power_scale * cpu->power_peak);
 249 #endif
 250     while ((var = lmm_get_var_from_cnst
 251             (cpu_maxmin_system, cpu->constraint, &elem))) {
 252         surf_action_cpu_Cas01_t action = lmm_variable_id(var);
 253         lmm_update_variable_bound(cpu_maxmin_system, action->variable,
 254                                   cpu->power_scale * cpu->power_peak);
 255     }
 256     if (tmgr_trace_event_free(event_type))
 257       cpu->power_event = NULL;
 258   } else if (event_type == cpu->state_event) {
 259     if (value > 0)
 260       cpu->state_current = SURF_RESOURCE_ON;
 261     else {
 262       lmm_constraint_t cnst = cpu->constraint;
 263       lmm_variable_t var = NULL;
 264       lmm_element_t elem = NULL;
 265
 266       cpu->state_current = SURF_RESOURCE_OFF;
 267
 268       while ((var = lmm_get_var_from_cnst(cpu_maxmin_system, cnst, &elem))) {
 269         surf_action_t action = lmm_variable_id(var);
 270
 271         if (surf_action_state_get(action) == SURF_ACTION_RUNNING ||
 272             surf_action_state_get(action) == SURF_ACTION_READY ||
 273             surf_action_state_get(action) ==
 274             SURF_ACTION_NOT_IN_THE_SYSTEM) {
 275           action->finish = date;
 276           cpu_action_state_set(action, SURF_ACTION_FAILED);
 277         }
 278       }
 279     }
 280     if (tmgr_trace_event_free(event_type))
 281       cpu->state_event = NULL;
 282   } else {
 283     XBT_CRITICAL("Unknown event ! \n");
 284     xbt_abort();
 285   }
 286
 287   return;
 288 }
 289
 290 static surf_action_t cpu_execute(void *cpu, double size)
 291 {
 292   surf_action_cpu_Cas01_t action = NULL;
 293   cpu_Cas01_t CPU = cpu;
 294
 295   XBT_IN("(%s,%g)", surf_resource_name(CPU), size);
 296   action =
 297       surf_action_new(sizeof(s_surf_action_cpu_Cas01_t), size,
 298                       surf_cpu_model,
 299                       CPU->state_current != SURF_RESOURCE_ON);
 300
 301   action->suspended = 0;        /* Should be useless because of the
 302                                    calloc but it seems to help valgrind... */
 303
 304   action->variable = lmm_variable_new(cpu_maxmin_system, action,
 305                                       action->generic_action.priority,
 306                                       CPU->power_scale * CPU->power_peak, 1);
 307   lmm_expand(cpu_maxmin_system, CPU->constraint, action->variable, 1.0);
 308   XBT_OUT();
 309   return (surf_action_t) action;
 310 }
 311
 312 static surf_action_t cpu_action_sleep(void *cpu, double duration)
 313 {
 314   surf_action_cpu_Cas01_t action = NULL;
 315
 316   if (duration > 0)
 317     duration = MAX(duration, MAXMIN_PRECISION);
 318
 319   XBT_IN("(%s,%g)", surf_resource_name(cpu), duration);
 320   action = (surf_action_cpu_Cas01_t) cpu_execute(cpu, 1.0);
 321   action->generic_action.max_duration = duration;
 322   action->suspended = 2;
 323   if (duration == NO_MAX_DURATION) {
 324     /* Move to the *end* of the corresponding action set. This convention
 325        is used to speed up update_resource_state  */
 326     xbt_swag_remove(action, ((surf_action_t) action)->state_set);
 327     ((surf_action_t) action)->state_set =
 328         cpu_running_action_set_that_does_not_need_being_checked;
 329     xbt_swag_insert(action, ((surf_action_t) action)->state_set);
 330   }
 331
 332   lmm_update_variable_weight(cpu_maxmin_system, action->variable, 0.0);
 333   XBT_OUT();
 334   return (surf_action_t) action;
 335 }
 336
 337 static void cpu_action_suspend(surf_action_t action)
 338 {
 339   XBT_IN("(%p)", action);
 340   if (((surf_action_cpu_Cas01_t) action)->suspended != 2) {
 341     lmm_update_variable_weight(cpu_maxmin_system,
 342                                ((surf_action_cpu_Cas01_t)
 343                                 action)->variable, 0.0);
 344     ((surf_action_cpu_Cas01_t) action)->suspended = 1;
 345   }
 346   XBT_OUT();
 347 }
 348
 349 static void cpu_action_resume(surf_action_t action)
 350 {
 351   XBT_IN("(%p)", action);
 352   if (((surf_action_cpu_Cas01_t) action)->suspended != 2) {
 353     lmm_update_variable_weight(cpu_maxmin_system,
 354                                ((surf_action_cpu_Cas01_t)
 355                                 action)->variable, action->priority);
 356     ((surf_action_cpu_Cas01_t) action)->suspended = 0;
 357   }
 358   XBT_OUT();
 359 }
 360
 361 static int cpu_action_is_suspended(surf_action_t action)
 362 {
 363   return (((surf_action_cpu_Cas01_t) action)->suspended == 1);
 364 }
 365
 366 static void cpu_action_set_max_duration(surf_action_t action,
 367                                         double duration)
 368 {
 369   XBT_IN("(%p,%g)", action, duration);
 370   action->max_duration = duration;
 371   XBT_OUT();
 372 }
 373
 374 static void cpu_action_set_priority(surf_action_t action, double priority)
 375 {
 376   XBT_IN("(%p,%g)", action, priority);
 377   action->priority = priority;
 378   lmm_update_variable_weight(cpu_maxmin_system,
 379                              ((surf_action_cpu_Cas01_t) action)->variable,
 380                              priority);
 381
 382   XBT_OUT();
 383 }
 384
 385 #ifdef HAVE_TRACING
 386 static void cpu_action_set_category(surf_action_t action, const char *category)
 387 {
 388   XBT_IN("(%p,%s)", action, category);
 389   action->category = xbt_strdup (category);
 390   XBT_OUT();
 391 }
 392 #endif
 393
 394 static double cpu_action_get_remains(surf_action_t action)
 395 {
 396   XBT_IN("(%p)", action);
 397   return action->remains;
 398   XBT_OUT();
 399 }
 400
 401 static e_surf_resource_state_t cpu_get_state(void *cpu)
 402 {
 403   return ((cpu_Cas01_t) cpu)->state_current;
 404 }
 405
 406 static double cpu_get_speed(void *cpu, double load)
 407 {
 408   return load * (((cpu_Cas01_t) cpu)->power_peak);
 409 }
 410
 411 static double cpu_get_available_speed(void *cpu)
 412 {
 413   /* number between 0 and 1 */
 414   return ((cpu_Cas01_t) cpu)->power_scale;
 415 }
 416
 417 static void cpu_create_resource(char *name, double power_peak,
 418                                 double power_scale,
 419                                 tmgr_trace_t power_trace,
 420                                 int core,
 421                                 e_surf_resource_state_t state_initial,
 422                                 tmgr_trace_t state_trace,
 423                                 xbt_dict_t cpu_properties)
 424 {
 425   cpu_new(name, power_peak, power_scale, power_trace, core,
 426           state_initial, state_trace, cpu_properties);
 427 }
 428
 429 static void cpu_finalize(void)
 430 {
 431   lmm_system_free(cpu_maxmin_system);
 432   cpu_maxmin_system = NULL;
 433
 434   surf_model_exit(surf_cpu_model);
 435   surf_cpu_model = NULL;
 436
 437   xbt_swag_free(cpu_running_action_set_that_does_not_need_being_checked);
 438   cpu_running_action_set_that_does_not_need_being_checked = NULL;
 439 }
 440
 441 static void surf_cpu_model_init_internal(void)
 442 {
 443   s_surf_action_t action;
 444
 445   surf_cpu_model = surf_model_init();
 446
 447   cpu_running_action_set_that_does_not_need_being_checked =
 448       xbt_swag_new(xbt_swag_offset(action, state_hookup));
 449
 450   surf_cpu_model->name = "CPU";
 451
 452   surf_cpu_model->action_unref = cpu_action_unref;
 453   surf_cpu_model->action_cancel = cpu_action_cancel;
 454   surf_cpu_model->action_state_set = cpu_action_state_set;
 455
 456   surf_cpu_model->model_private->resource_used = cpu_resource_used;
 457   surf_cpu_model->model_private->share_resources = cpu_share_resources;
 458   surf_cpu_model->model_private->update_actions_state =
 459       cpu_update_actions_state;
 460   surf_cpu_model->model_private->update_resource_state =
 461       cpu_update_resource_state;
 462   surf_cpu_model->model_private->finalize = cpu_finalize;
 463
 464   surf_cpu_model->suspend = cpu_action_suspend;
 465   surf_cpu_model->resume = cpu_action_resume;
 466   surf_cpu_model->is_suspended = cpu_action_is_suspended;
 467   surf_cpu_model->set_max_duration = cpu_action_set_max_duration;
 468   surf_cpu_model->set_priority = cpu_action_set_priority;
 469 #ifdef HAVE_TRACING
 470   surf_cpu_model->set_category = cpu_action_set_category;
 471 #endif
 472   surf_cpu_model->get_remains = cpu_action_get_remains;
 473
 474   surf_cpu_model->extension.cpu.execute = cpu_execute;
 475   surf_cpu_model->extension.cpu.sleep = cpu_action_sleep;
 476
 477   surf_cpu_model->extension.cpu.get_state = cpu_get_state;
 478   surf_cpu_model->extension.cpu.get_speed = cpu_get_speed;
 479   surf_cpu_model->extension.cpu.get_available_speed =
 480       cpu_get_available_speed;
 481   surf_cpu_model->extension.cpu.create_resource = cpu_create_resource;
 482   surf_cpu_model->extension.cpu.add_traces = add_traces_cpu;
 483
 484   if (!cpu_maxmin_system)
 485     cpu_maxmin_system = lmm_system_new();
 486 }
 487
 488 /*********************************************************************/
 489 /* Basic sharing model for CPU: that is where all this started... ;) */
 490 /*********************************************************************/
 491 /* @InProceedings{casanova01simgrid, */
 492 /*   author =       "H. Casanova", */
 493 /*   booktitle =    "Proceedings of the IEEE Symposium on Cluster Computing */
 494 /*                  and the Grid (CCGrid'01)", */
 495 /*   publisher =    "IEEE Computer Society", */
 496 /*   title =        "Simgrid: {A} Toolkit for the Simulation of Application */
 497 /*                  Scheduling", */
 498 /*   year =         "2001", */
 499 /*   month =        may, */
 500 /*   note =         "Available at */
 501 /*                  \url{http://grail.sdsc.edu/papers/simgrid_ccgrid01.ps.gz}." */
 502 /* } */
 503 void surf_cpu_model_init_Cas01(const char *filename)
 504 {
 505   if (surf_cpu_model)
 506     return;
 507   surf_cpu_model_init_internal();
 508   cpu_define_callbacks(filename);
 509   xbt_dynar_push(model_list, &surf_cpu_model);
 510 }