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(surf_cpu, surf,
  11                                 "Logging specific to the SURF CPU module");
  12
  13 surf_cpu_model_t surf_cpu_model = NULL;
  14 lmm_system_t cpu_maxmin_system = NULL;
  15
  16 xbt_dict_t cpu_set = NULL;
  17
  18 static void cpu_free(void *cpu)
  19 {
  20   free(((cpu_Cas01_t) cpu)->name);
  21   free(cpu);
  22 }
  23
  24 static cpu_Cas01_t cpu_new(char *name, double power_scale,
  25                            double power_initial,
  26                            tmgr_trace_t power_trace,
  27                            e_surf_cpu_state_t state_initial,
  28                            tmgr_trace_t state_trace,
  29                            xbt_dict_t cpu_properties)
  30 {
  31   cpu_Cas01_t cpu = xbt_new0(s_cpu_Cas01_t, 1);
  32   xbt_assert1(!xbt_dict_get_or_null(cpu_set, name),
  33               "Host '%s' declared several times in the platform file",name);
  34
  35   cpu->model = (surf_model_t) surf_cpu_model;
  36   cpu->name = name;
  37   cpu->power_scale = power_scale;
  38   xbt_assert0(cpu->power_scale > 0, "Power has to be >0");
  39   cpu->power_current = power_initial;
  40   if (power_trace)
  41     cpu->power_event =
  42         tmgr_history_add_trace(history, power_trace, 0.0, 0, cpu);
  43
  44   cpu->state_current = state_initial;
  45   if (state_trace)
  46     cpu->state_event =
  47         tmgr_history_add_trace(history, state_trace, 0.0, 0, cpu);
  48
  49   cpu->constraint =
  50       lmm_constraint_new(cpu_maxmin_system, cpu,
  51                          cpu->power_current * cpu->power_scale);
  52
  53   /*add the property set*/
  54   cpu->properties = cpu_properties;
  55
  56   current_property_set = cpu_properties;
  57
  58   xbt_dict_set(cpu_set, name, cpu, cpu_free);
  59
  60   return cpu;
  61 }
  62
  63
  64 static void parse_cpu_init(void)
  65 {
  66   double power_scale = 0.0;
  67   double power_initial = 0.0;
  68   tmgr_trace_t power_trace = NULL;
  69   e_surf_cpu_state_t state_initial = SURF_CPU_OFF;
  70   tmgr_trace_t state_trace = NULL;
  71
  72   surf_parse_get_double(&power_scale, A_surfxml_host_power);
  73   surf_parse_get_double(&power_initial, A_surfxml_host_availability);
  74   surf_parse_get_trace(&power_trace, A_surfxml_host_availability_file);
  75
  76   xbt_assert0((A_surfxml_host_state == A_surfxml_host_state_ON) ||
  77               (A_surfxml_host_state == A_surfxml_host_state_OFF),
  78               "Invalid state");
  79   if (A_surfxml_host_state == A_surfxml_host_state_ON)
  80     state_initial = SURF_CPU_ON;
  81   if (A_surfxml_host_state == A_surfxml_host_state_OFF)
  82     state_initial = SURF_CPU_OFF;
  83   surf_parse_get_trace(&state_trace, A_surfxml_host_state_file);
  84
  85   current_property_set = xbt_dict_new();
  86   cpu_new(xbt_strdup(A_surfxml_host_id), power_scale, power_initial, power_trace, state_initial,
  87           state_trace,  current_property_set);
  88
  89 }
  90
  91 static void define_callbacks(const char *file)
  92 {
  93   surf_parse_reset_parser();
  94   surfxml_add_callback(STag_surfxml_host_cb_list, parse_cpu_init);
  95   surfxml_add_callback(STag_surfxml_prop_cb_list, parse_properties);
  96 }
  97
  98 static void *name_service(const char *name)
  99 {
 100   return xbt_dict_get_or_null(cpu_set, name);
 101 }
 102
 103 static const char *get_resource_name(void *resource_id)
 104 {
 105   return ((cpu_Cas01_t) resource_id)->name;
 106 }
 107
 108 static int resource_used(void *resource_id)
 109 {
 110   return lmm_constraint_used(cpu_maxmin_system,
 111                              ((cpu_Cas01_t) resource_id)->constraint);
 112 }
 113
 114 static int action_free(surf_action_t action)
 115 {
 116   action->using--;
 117   if (!action->using) {
 118     xbt_swag_remove(action, action->state_set);
 119     if (((surf_action_cpu_Cas01_t) action)->variable)
 120       lmm_variable_free(cpu_maxmin_system,
 121                         ((surf_action_cpu_Cas01_t) action)->variable);
 122     free(action);
 123     return 1;
 124   }
 125   return 0;
 126 }
 127
 128 static void action_use(surf_action_t action)
 129 {
 130   action->using++;
 131 }
 132
 133 static void action_cancel(surf_action_t action)
 134 {
 135   surf_action_change_state(action, SURF_ACTION_FAILED);
 136   return;
 137 }
 138
 139 static void action_recycle(surf_action_t action)
 140 {
 141   DIE_IMPOSSIBLE;
 142 }
 143
 144 static void action_change_state(surf_action_t action,
 145                                 e_surf_action_state_t state)
 146 {
 147 /*   if((state==SURF_ACTION_DONE) || (state==SURF_ACTION_FAILED)) */
 148 /*     if(((surf_action_cpu_Cas01_t)action)->variable) { */
 149 /*       lmm_variable_disable(cpu_maxmin_system, ((surf_action_cpu_Cas01_t)action)->variable); */
 150 /*       ((surf_action_cpu_Cas01_t)action)->variable = NULL; */
 151 /*     } */
 152
 153   surf_action_change_state(action, state);
 154   return;
 155 }
 156
 157 static double share_resources(double now)
 158 {
 159   s_surf_action_cpu_Cas01_t action;
 160   return generic_maxmin_share_resources(surf_cpu_model->common_public->
 161                                         states.running_action_set,
 162                                         xbt_swag_offset(action, variable),
 163                                         cpu_maxmin_system, lmm_solve);
 164 }
 165
 166 static void update_actions_state(double now, double delta)
 167 {
 168   surf_action_cpu_Cas01_t action = NULL;
 169   surf_action_cpu_Cas01_t next_action = NULL;
 170   xbt_swag_t running_actions =
 171       surf_cpu_model->common_public->states.running_action_set;
 172   /* FIXME: UNUSED
 173      xbt_swag_t failed_actions =
 174      surf_cpu_model->common_public->states.failed_action_set;
 175    */
 176
 177   xbt_swag_foreach_safe(action, next_action, running_actions) {
 178     double_update(&(action->generic_action.remains),
 179                   lmm_variable_getvalue(action->variable) * delta);
 180     if (action->generic_action.max_duration != NO_MAX_DURATION)
 181       double_update(&(action->generic_action.max_duration), delta);
 182     if ((action->generic_action.remains <= 0) &&
 183         (lmm_get_variable_weight(action->variable) > 0)) {
 184       action->generic_action.finish = surf_get_clock();
 185       action_change_state((surf_action_t) action, SURF_ACTION_DONE);
 186     } else if ((action->generic_action.max_duration != NO_MAX_DURATION) &&
 187                (action->generic_action.max_duration <= 0)) {
 188       action->generic_action.finish = surf_get_clock();
 189       action_change_state((surf_action_t) action, SURF_ACTION_DONE);
 190     } else {                    /* Need to check that none of the model has failed */
 191       lmm_constraint_t cnst = NULL;
 192       int i = 0;
 193       cpu_Cas01_t cpu = NULL;
 194
 195       while ((cnst =
 196               lmm_get_cnst_from_var(cpu_maxmin_system, action->variable,
 197                                     i++))) {
 198         cpu = lmm_constraint_id(cnst);
 199         if (cpu->state_current == SURF_CPU_OFF) {
 200           action->generic_action.finish = surf_get_clock();
 201           action_change_state((surf_action_t) action, SURF_ACTION_FAILED);
 202           break;
 203         }
 204       }
 205     }
 206   }
 207
 208   return;
 209 }
 210
 211 static void update_resource_state(void *id,
 212                                   tmgr_trace_event_t event_type,
 213                                   double value)
 214 {
 215   cpu_Cas01_t cpu = id;
 216
 217   if (event_type == cpu->power_event) {
 218     cpu->power_current = value;
 219     lmm_update_constraint_bound(cpu_maxmin_system, cpu->constraint,
 220                                 cpu->power_current * cpu->power_scale);
 221   } else if (event_type == cpu->state_event) {
 222     if (value > 0)
 223       cpu->state_current = SURF_CPU_ON;
 224     else
 225       cpu->state_current = SURF_CPU_OFF;
 226   } else {
 227     CRITICAL0("Unknown event ! \n");
 228     xbt_abort();
 229   }
 230
 231   return;
 232 }
 233
 234 static surf_action_t execute(void *cpu, double size)
 235 {
 236   surf_action_cpu_Cas01_t action = NULL;
 237   cpu_Cas01_t CPU = cpu;
 238
 239   XBT_IN2("(%s,%g)", CPU->name, size);
 240   action = xbt_new0(s_surf_action_cpu_Cas01_t, 1);
 241
 242   action->generic_action.using = 1;
 243   action->generic_action.cost = size;
 244   action->generic_action.remains = size;
 245   action->generic_action.priority = 1.0;
 246   action->generic_action.max_duration = NO_MAX_DURATION;
 247   action->generic_action.start = surf_get_clock();
 248   action->generic_action.finish = -1.0;
 249   action->generic_action.model_type =
 250       (surf_model_t) surf_cpu_model;
 251   action->suspended = 0;        /* Should be useless because of the
 252                                    calloc but it seems to help valgrind... */
 253
 254   if (CPU->state_current == SURF_CPU_ON)
 255     action->generic_action.state_set =
 256         surf_cpu_model->common_public->states.running_action_set;
 257   else
 258     action->generic_action.state_set =
 259         surf_cpu_model->common_public->states.failed_action_set;
 260   xbt_swag_insert(action, action->generic_action.state_set);
 261
 262   action->variable = lmm_variable_new(cpu_maxmin_system, action,
 263                                       action->generic_action.priority,
 264                                       -1.0, 1);
 265   lmm_expand(cpu_maxmin_system, CPU->constraint, action->variable, 1.0);
 266   XBT_OUT;
 267   return (surf_action_t) action;
 268 }
 269
 270 static surf_action_t action_sleep(void *cpu, double duration)
 271 {
 272   surf_action_cpu_Cas01_t action = NULL;
 273
 274   XBT_IN2("(%s,%g)", ((cpu_Cas01_t) cpu)->name, duration);
 275   action = (surf_action_cpu_Cas01_t) execute(cpu, 1.0);
 276   action->generic_action.max_duration = duration;
 277   action->suspended = 2;
 278   lmm_update_variable_weight(cpu_maxmin_system, action->variable, 0.0);
 279   XBT_OUT;
 280   return (surf_action_t) action;
 281 }
 282
 283 static void action_suspend(surf_action_t action)
 284 {
 285   XBT_IN1("(%p)", action);
 286   if (((surf_action_cpu_Cas01_t) action)->suspended != 2) {
 287     lmm_update_variable_weight(cpu_maxmin_system,
 288                                ((surf_action_cpu_Cas01_t) action)->
 289                                variable, 0.0);
 290     ((surf_action_cpu_Cas01_t) action)->suspended = 1;
 291   }
 292   XBT_OUT;
 293 }
 294
 295 static void action_resume(surf_action_t action)
 296 {
 297   XBT_IN1("(%p)", action);
 298   if (((surf_action_cpu_Cas01_t) action)->suspended != 2) {
 299     lmm_update_variable_weight(cpu_maxmin_system,
 300                                ((surf_action_cpu_Cas01_t) action)->
 301                                variable, action->priority);
 302     ((surf_action_cpu_Cas01_t) action)->suspended = 0;
 303   }
 304   XBT_OUT;
 305 }
 306
 307 static int action_is_suspended(surf_action_t action)
 308 {
 309   return (((surf_action_cpu_Cas01_t) action)->suspended == 1);
 310 }
 311
 312 static void action_set_max_duration(surf_action_t action, double duration)
 313 {
 314   XBT_IN2("(%p,%g)", action, duration);
 315   action->max_duration = duration;
 316   XBT_OUT;
 317 }
 318
 319 static void action_set_priority(surf_action_t action, double priority)
 320 {
 321   XBT_IN2("(%p,%g)", action, priority);
 322   action->priority = priority;
 323   lmm_update_variable_weight(cpu_maxmin_system, ((surf_action_cpu_Cas01_t) action)->variable, priority);
 324
 325   XBT_OUT;
 326 }
 327
 328 static e_surf_cpu_state_t get_state(void *cpu)
 329 {
 330   return ((cpu_Cas01_t) cpu)->state_current;
 331 }
 332
 333 static double get_speed(void *cpu, double load)
 334 {
 335   return load * (((cpu_Cas01_t) cpu)->power_scale);
 336 }
 337
 338 static double get_available_speed(void *cpu)
 339 {
 340   /* number between 0 and 1 */
 341   return ((cpu_Cas01_t) cpu)->power_current;
 342 }
 343
 344 static xbt_dict_t get_properties(void *cpu)
 345 {
 346  return ((cpu_Cas01_t) cpu)->properties;
 347 }
 348
 349 static void finalize(void)
 350 {
 351   xbt_dict_free(&cpu_set);
 352   xbt_swag_free(surf_cpu_model->common_public->states.ready_action_set);
 353   xbt_swag_free(surf_cpu_model->common_public->states.
 354                 running_action_set);
 355   xbt_swag_free(surf_cpu_model->common_public->states.
 356                 failed_action_set);
 357   xbt_swag_free(surf_cpu_model->common_public->states.done_action_set);
 358   free(surf_cpu_model->common_public);
 359   free(surf_cpu_model->common_private);
 360   free(surf_cpu_model->extension_public);
 361
 362   free(surf_cpu_model);
 363   surf_cpu_model = NULL;
 364 }
 365
 366 static void surf_cpu_model_init_internal(void)
 367 {
 368   s_surf_action_t action;
 369
 370   surf_cpu_model = xbt_new0(s_surf_cpu_model_t, 1);
 371
 372   surf_cpu_model->common_private =
 373       xbt_new0(s_surf_model_private_t, 1);
 374   surf_cpu_model->common_public = xbt_new0(s_surf_model_public_t, 1);
 375
 376   surf_cpu_model->extension_public =
 377       xbt_new0(s_surf_cpu_model_extension_public_t, 1);
 378
 379   surf_cpu_model->common_public->states.ready_action_set =
 380       xbt_swag_new(xbt_swag_offset(action, state_hookup));
 381   surf_cpu_model->common_public->states.running_action_set =
 382       xbt_swag_new(xbt_swag_offset(action, state_hookup));
 383   surf_cpu_model->common_public->states.failed_action_set =
 384       xbt_swag_new(xbt_swag_offset(action, state_hookup));
 385   surf_cpu_model->common_public->states.done_action_set =
 386       xbt_swag_new(xbt_swag_offset(action, state_hookup));
 387
 388   surf_cpu_model->common_public->name_service = name_service;
 389   surf_cpu_model->common_public->get_resource_name = get_resource_name;
 390   surf_cpu_model->common_public->action_get_state =
 391       surf_action_get_state;
 392   surf_cpu_model->common_public->action_get_start_time =
 393       surf_action_get_start_time;
 394   surf_cpu_model->common_public->action_get_finish_time =
 395       surf_action_get_finish_time;
 396   surf_cpu_model->common_public->action_free = action_free;
 397   surf_cpu_model->common_public->action_use = action_use;
 398   surf_cpu_model->common_public->action_cancel = action_cancel;
 399   surf_cpu_model->common_public->action_recycle = action_recycle;
 400   surf_cpu_model->common_public->action_change_state =
 401       action_change_state;
 402   surf_cpu_model->common_public->action_set_data = surf_action_set_data;
 403   surf_cpu_model->common_public->name = "CPU";
 404
 405   surf_cpu_model->common_private->resource_used = resource_used;
 406   surf_cpu_model->common_private->share_resources = share_resources;
 407   surf_cpu_model->common_private->update_actions_state =
 408       update_actions_state;
 409   surf_cpu_model->common_private->update_resource_state =
 410       update_resource_state;
 411   surf_cpu_model->common_private->finalize = finalize;
 412
 413   surf_cpu_model->common_public->suspend = action_suspend;
 414   surf_cpu_model->common_public->resume = action_resume;
 415   surf_cpu_model->common_public->is_suspended = action_is_suspended;
 416   surf_cpu_model->common_public->set_max_duration =
 417       action_set_max_duration;
 418   surf_cpu_model->common_public->set_priority = action_set_priority;
 419   surf_cpu_model->extension_public->execute = execute;
 420   surf_cpu_model->extension_public->sleep = action_sleep;
 421
 422   surf_cpu_model->extension_public->get_state = get_state;
 423   surf_cpu_model->extension_public->get_speed = get_speed;
 424   surf_cpu_model->extension_public->get_available_speed =
 425       get_available_speed;
 426   /*manage the properties of the cpu*/
 427   surf_cpu_model->common_public->get_properties = get_properties;
 428
 429   if(!cpu_set) cpu_set = xbt_dict_new();
 430   if (!cpu_maxmin_system) cpu_maxmin_system = lmm_system_new();
 431 }
 432
 433 /*********************************************************************/
 434 /* Basic sharing model for CPU: that is where all this started... ;) */
 435 /*********************************************************************/
 436 /* @InProceedings{casanova01simgrid, */
 437 /*   author =       "H. Casanova", */
 438 /*   booktitle =    "Proceedings of the IEEE Symposium on Cluster Computing */
 439 /*                  and the Grid (CCGrid'01)", */
 440 /*   publisher =    "IEEE Computer Society", */
 441 /*   title =        "Simgrid: {A} Toolkit for the Simulation of Application */
 442 /*                  Scheduling", */
 443 /*   year =         "2001", */
 444 /*   month =        may, */
 445 /*   note =         "Available at */
 446 /*                  \url{http://grail.sdsc.edu/papers/simgrid_ccgrid01.ps.gz}." */
 447 /* } */
 448 void surf_cpu_model_init_Cas01(const char *filename)
 449 {
 450   if (surf_cpu_model)
 451     return;
 452   surf_cpu_model_init_internal();
 453   define_callbacks(filename);
 454   xbt_dynar_push(model_list, &surf_cpu_model);
 455 }