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