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