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