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