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