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 "cpu_private.h"
   9
  10 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(cpu, surf,
  11                                 "Logging specific to the SURF CPU module");
  12
  13 surf_cpu_resource_t surf_cpu_resource = NULL;
  14
  15 xbt_dict_t cpu_set = NULL;
  16
  17 static void cpu_free(void *cpu)
  18 {
  19   free(((cpu_Cas01_t)cpu)->name);
  20   free(cpu);
  21 }
  22
  23 static cpu_Cas01_t cpu_new(char *name, double power_scale,
  24                      double power_initial,
  25                      tmgr_trace_t power_trace,
  26                      e_surf_cpu_state_t state_initial,
  27                      tmgr_trace_t state_trace)
  28 {
  29   cpu_Cas01_t cpu = xbt_new0(s_cpu_Cas01_t, 1);
  30
  31   cpu->resource = (surf_resource_t) surf_cpu_resource;
  32   cpu->name = name;
  33   cpu->power_scale = power_scale;
  34   xbt_assert0(cpu->power_scale>0,"Power has to be >0");
  35   cpu->power_current = power_initial;
  36   if (power_trace)
  37     cpu->power_event =
  38         tmgr_history_add_trace(history, power_trace, 0.0, 0, cpu);
  39
  40   cpu->state_current = state_initial;
  41   if (state_trace)
  42     cpu->state_event =
  43         tmgr_history_add_trace(history, state_trace, 0.0, 0, cpu);
  44
  45   cpu->constraint =
  46       lmm_constraint_new(maxmin_system, cpu,
  47                          cpu->power_current * cpu->power_scale);
  48
  49   xbt_dict_set(cpu_set, name, cpu, cpu_free);
  50
  51   return cpu;
  52 }
  53
  54 static void parse_cpu(void)
  55 {
  56   char *name = NULL;
  57   double power_scale = 0.0;
  58   double power_initial = 0.0;
  59   tmgr_trace_t power_trace = NULL;
  60   e_surf_cpu_state_t state_initial = SURF_CPU_OFF;
  61   tmgr_trace_t state_trace = NULL;
  62
  63   name = xbt_strdup(A_cpu_name);
  64   surf_parse_get_double(&power_scale,A_cpu_power);
  65   surf_parse_get_double(&power_initial,A_cpu_availability);
  66   surf_parse_get_trace(&power_trace,A_cpu_availability_file);
  67
  68   xbt_assert0((A_cpu_state==A_cpu_state_ON)||(A_cpu_state==A_cpu_state_OFF),
  69               "Invalid state")
  70   if (A_cpu_state==A_cpu_state_ON) state_initial = SURF_CPU_ON;
  71   if (A_cpu_state==A_cpu_state_OFF) state_initial = SURF_CPU_OFF;
  72   surf_parse_get_trace(&state_trace,A_cpu_state_file);
  73
  74   cpu_new(name, power_scale, power_initial, power_trace, state_initial,
  75           state_trace);
  76 }
  77
  78 static void parse_file(const char *file)
  79 {
  80   surf_parse_reset_parser();
  81   ETag_cpu_fun=parse_cpu;
  82   surf_parse_open(file);
  83   xbt_assert1((!surf_parse()),"Parse error in %s",file);
  84   surf_parse_close();
  85 }
  86
  87 static void *name_service(const char *name)
  88 {
  89   void *cpu = NULL;
  90
  91   xbt_dict_get(cpu_set, name, &cpu);
  92
  93   return cpu;
  94 }
  95
  96 static const char *get_resource_name(void *resource_id)
  97 {
  98   return ((cpu_Cas01_t) resource_id)->name;
  99 }
 100
 101 static int resource_used(void *resource_id)
 102 {
 103   return lmm_constraint_used(maxmin_system,
 104                              ((cpu_Cas01_t) resource_id)->constraint);
 105 }
 106
 107 static int action_free(surf_action_t action)
 108 {
 109   action->using--;
 110   if(!action->using) {
 111     xbt_swag_remove(action, action->state_set);
 112     if(((surf_action_cpu_Cas01_t)action)->variable)
 113       lmm_variable_free(maxmin_system, ((surf_action_cpu_Cas01_t)action)->variable);
 114     free(action);
 115     return 1;
 116   }
 117   return 0;
 118 }
 119
 120 static void action_use(surf_action_t action)
 121 {
 122   action->using++;
 123 }
 124
 125 static void action_cancel(surf_action_t action)
 126 {
 127   surf_action_change_state(action, SURF_ACTION_FAILED);
 128   return;
 129 }
 130
 131 static void action_recycle(surf_action_t action)
 132 {
 133   return;
 134 }
 135
 136 static void action_change_state(surf_action_t action,
 137                                 e_surf_action_state_t state)
 138 {
 139 /*   if((state==SURF_ACTION_DONE) || (state==SURF_ACTION_FAILED)) */
 140 /*     if(((surf_action_cpu_Cas01_t)action)->variable) { */
 141 /*       lmm_variable_disable(maxmin_system, ((surf_action_cpu_Cas01_t)action)->variable); */
 142 /*       ((surf_action_cpu_Cas01_t)action)->variable = NULL; */
 143 /*     } */
 144
 145   surf_action_change_state(action, state);
 146   return;
 147 }
 148
 149 static double share_resources(double now)
 150 {
 151   s_surf_action_cpu_Cas01_t action;
 152   return generic_maxmin_share_resources(surf_cpu_resource->common_public->
 153                                         states.running_action_set,
 154                                         xbt_swag_offset(action, variable));
 155 }
 156
 157 static void update_actions_state(double now, double delta)
 158 {
 159   surf_action_cpu_Cas01_t action = NULL;
 160   surf_action_cpu_Cas01_t next_action = NULL;
 161   xbt_swag_t running_actions =
 162       surf_cpu_resource->common_public->states.running_action_set;
 163   xbt_swag_t failed_actions =
 164       surf_cpu_resource->common_public->states.failed_action_set;
 165
 166   xbt_swag_foreach_safe(action, next_action, running_actions) {
 167     surf_double_update(&(action->generic_action.remains),
 168         lmm_variable_getvalue(action->variable) * delta);
 169     if (action->generic_action.max_duration != NO_MAX_DURATION)
 170       surf_double_update(&(action->generic_action.max_duration), delta);
 171     if ((action->generic_action.remains <= 0) &&
 172         (lmm_get_variable_weight(action->variable)>0)) {
 173       action->generic_action.finish = surf_get_clock();
 174       action_change_state((surf_action_t) action, SURF_ACTION_DONE);
 175     } else if ((action->generic_action.max_duration != NO_MAX_DURATION) &&
 176                (action->generic_action.max_duration <= 0)) {
 177       action->generic_action.finish = surf_get_clock();
 178       action_change_state((surf_action_t) action, SURF_ACTION_DONE);
 179     } else {                    /* Need to check that none of the resource has failed */
 180       lmm_constraint_t cnst = NULL;
 181       int i = 0;
 182       cpu_Cas01_t cpu = NULL;
 183
 184       while ((cnst =
 185               lmm_get_cnst_from_var(maxmin_system, action->variable,
 186                                     i++))) {
 187         cpu = lmm_constraint_id(cnst);
 188         if (cpu->state_current == SURF_CPU_OFF) {
 189           action->generic_action.finish = surf_get_clock();
 190           action_change_state((surf_action_t) action, SURF_ACTION_FAILED);
 191           break;
 192         }
 193       }
 194     }
 195   }
 196
 197   return;
 198 }
 199
 200 static void update_resource_state(void *id,
 201                                   tmgr_trace_event_t event_type,
 202                                   double value)
 203 {
 204   cpu_Cas01_t cpu = id;
 205
 206   if (event_type == cpu->power_event) {
 207     cpu->power_current = value;
 208     lmm_update_constraint_bound(maxmin_system, cpu->constraint,
 209                                 cpu->power_current * cpu->power_scale);
 210   } else if (event_type == cpu->state_event) {
 211     if (value > 0)
 212       cpu->state_current = SURF_CPU_ON;
 213     else
 214       cpu->state_current = SURF_CPU_OFF;
 215   } else {
 216     CRITICAL0("Unknown event ! \n");
 217     xbt_abort();
 218   }
 219
 220   return;
 221 }
 222
 223 static surf_action_t execute(void *cpu, double size)
 224 {
 225   surf_action_cpu_Cas01_t action = NULL;
 226   cpu_Cas01_t CPU = cpu;
 227
 228   action = xbt_new0(s_surf_action_cpu_Cas01_t, 1);
 229
 230   action->generic_action.using = 1;
 231   action->generic_action.cost = size;
 232   action->generic_action.remains = size;
 233   action->generic_action.max_duration = NO_MAX_DURATION;
 234   action->generic_action.start = surf_get_clock();
 235   action->generic_action.finish = -1.0;
 236   action->generic_action.resource_type =
 237       (surf_resource_t) surf_cpu_resource;
 238
 239   if (CPU->state_current == SURF_CPU_ON)
 240     action->generic_action.state_set =
 241         surf_cpu_resource->common_public->states.running_action_set;
 242   else
 243     action->generic_action.state_set =
 244         surf_cpu_resource->common_public->states.failed_action_set;
 245   xbt_swag_insert(action, action->generic_action.state_set);
 246
 247   action->variable = lmm_variable_new(maxmin_system, action, 1.0, -1.0, 1);
 248   lmm_expand(maxmin_system, CPU->constraint, action->variable,
 249              1.0);
 250
 251   return (surf_action_t) action;
 252 }
 253
 254 static surf_action_t action_sleep(void *cpu, double duration)
 255 {
 256   surf_action_cpu_Cas01_t action = NULL;
 257
 258   action = (surf_action_cpu_Cas01_t) execute(cpu, 1.0);
 259   action->generic_action.max_duration = duration;
 260   lmm_update_variable_weight(maxmin_system, action->variable, 0.0);
 261
 262   return (surf_action_t) action;
 263 }
 264
 265 static void action_suspend(surf_action_t action)
 266 {
 267   lmm_update_variable_weight(maxmin_system,
 268                              ((surf_action_cpu_Cas01_t) action)->variable, 0.0);
 269 }
 270
 271 static void action_resume(surf_action_t action)
 272 {
 273   lmm_update_variable_weight(maxmin_system,
 274                              ((surf_action_cpu_Cas01_t) action)->variable, 1.0);
 275 }
 276
 277 static int action_is_suspended(surf_action_t action)
 278 {
 279   return (lmm_get_variable_weight(((surf_action_cpu_Cas01_t) action)->variable) == 0.0);
 280 }
 281
 282 static void action_set_max_duration(surf_action_t action, double duration)
 283 {
 284   action->max_duration = duration;
 285 }
 286
 287 static e_surf_cpu_state_t get_state(void *cpu)
 288 {
 289   return ((cpu_Cas01_t) cpu)->state_current;
 290 }
 291
 292 static double get_speed(void *cpu, double load)
 293 {
 294   return load*(((cpu_Cas01_t) cpu)->power_scale);
 295 }
 296
 297 static void finalize(void)
 298 {
 299   xbt_dict_free(&cpu_set);
 300   xbt_swag_free(surf_cpu_resource->common_public->states.ready_action_set);
 301   xbt_swag_free(surf_cpu_resource->common_public->states.
 302                 running_action_set);
 303   xbt_swag_free(surf_cpu_resource->common_public->states.
 304                 failed_action_set);
 305   xbt_swag_free(surf_cpu_resource->common_public->states.done_action_set);
 306   free(surf_cpu_resource->common_public);
 307   free(surf_cpu_resource->common_private);
 308   free(surf_cpu_resource->extension_public);
 309
 310   free(surf_cpu_resource);
 311   surf_cpu_resource = NULL;
 312 }
 313
 314 static void surf_cpu_resource_init_internal(void)
 315 {
 316   s_surf_action_t action;
 317
 318   surf_cpu_resource = xbt_new0(s_surf_cpu_resource_t, 1);
 319
 320   surf_cpu_resource->common_private =
 321       xbt_new0(s_surf_resource_private_t, 1);
 322   surf_cpu_resource->common_public = xbt_new0(s_surf_resource_public_t, 1);
 323
 324   surf_cpu_resource->extension_public =
 325       xbt_new0(s_surf_cpu_resource_extension_public_t, 1);
 326
 327   surf_cpu_resource->common_public->states.ready_action_set =
 328       xbt_swag_new(xbt_swag_offset(action, state_hookup));
 329   surf_cpu_resource->common_public->states.running_action_set =
 330       xbt_swag_new(xbt_swag_offset(action, state_hookup));
 331   surf_cpu_resource->common_public->states.failed_action_set =
 332       xbt_swag_new(xbt_swag_offset(action, state_hookup));
 333   surf_cpu_resource->common_public->states.done_action_set =
 334       xbt_swag_new(xbt_swag_offset(action, state_hookup));
 335
 336   surf_cpu_resource->common_public->name_service = name_service;
 337   surf_cpu_resource->common_public->get_resource_name = get_resource_name;
 338   surf_cpu_resource->common_public->action_get_state =
 339       surf_action_get_state;
 340   surf_cpu_resource->common_public->action_free = action_free;
 341   surf_cpu_resource->common_public->action_use = action_use;
 342   surf_cpu_resource->common_public->action_cancel = action_cancel;
 343   surf_cpu_resource->common_public->action_recycle = action_recycle;
 344   surf_cpu_resource->common_public->action_change_state =
 345       action_change_state;
 346   surf_cpu_resource->common_public->action_set_data = surf_action_set_data;
 347   surf_cpu_resource->common_public->name = "CPU";
 348
 349   surf_cpu_resource->common_private->resource_used = resource_used;
 350   surf_cpu_resource->common_private->share_resources = share_resources;
 351   surf_cpu_resource->common_private->update_actions_state =
 352       update_actions_state;
 353   surf_cpu_resource->common_private->update_resource_state =
 354       update_resource_state;
 355   surf_cpu_resource->common_private->finalize = finalize;
 356
 357   surf_cpu_resource->common_public->suspend = action_suspend;
 358   surf_cpu_resource->common_public->resume = action_resume;
 359   surf_cpu_resource->common_public->is_suspended = action_is_suspended;
 360   surf_cpu_resource->common_public->set_max_duration = action_set_max_duration;
 361
 362   surf_cpu_resource->extension_public->execute = execute;
 363   surf_cpu_resource->extension_public->sleep = action_sleep;
 364
 365   surf_cpu_resource->extension_public->get_state = get_state;
 366   surf_cpu_resource->extension_public->get_speed = get_speed;
 367
 368   cpu_set = xbt_dict_new();
 369
 370   xbt_assert0(maxmin_system, "surf_init has to be called first!");
 371 }
 372
 373 /*********************************************************************/
 374 /* Basic sharing model for CPU: that is where all this started... ;) */
 375 /*********************************************************************/
 376 /* @InProceedings{casanova01simgrid, */
 377 /*   author =       "H. Casanova", */
 378 /*   booktitle =    "Proceedings of the IEEE Symposium on Cluster Computing */
 379 /*                  and the Grid (CCGrid'01)", */
 380 /*   publisher =    "IEEE Computer Society", */
 381 /*   title =        "Simgrid: {A} Toolkit for the Simulation of Application */
 382 /*                  Scheduling", */
 383 /*   year =         "2001", */
 384 /*   month =        may, */
 385 /*   note =         "Available at */
 386 /*                  \url{http://grail.sdsc.edu/papers/simgrid_ccgrid01.ps.gz}." */
 387 /* } */
 388 void surf_cpu_resource_init_Cas01(const char *filename)
 389 {
 390   if (surf_cpu_resource)
 391     return;
 392   surf_cpu_resource_init_internal();
 393   parse_file(filename);
 394   xbt_dynar_push(resource_list, &surf_cpu_resource);
 395 }