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 /* power_scale is the basic power of the cpu when the cpu is
  24    completely available. power_initial is therefore expected to be
  25    comprised between 0.0 and 1.0, just as the values of power_trace.
  26    state_trace values mean SURF_CPU_ON if >0 and SURF_CPU_OFF
  27    otherwise.
  28 */
  29 static cpu_t cpu_new(char *name, double power_scale,
  30                      double power_initial,
  31                      tmgr_trace_t power_trace,
  32                      e_surf_cpu_state_t state_initial,
  33                      tmgr_trace_t state_trace)
  34 {
  35   cpu_t cpu = xbt_new0(s_cpu_t, 1);
  36
  37   cpu->resource = (surf_resource_t) surf_cpu_resource;
  38   cpu->name = name;
  39   cpu->power_scale = power_scale;
  40   cpu->power_current = power_initial;
  41 /*   cpu->power_trace = power_trace; */
  42   if (power_trace)
  43     cpu->power_event =
  44         tmgr_history_add_trace(history, power_trace, 0.0, 0, cpu);
  45
  46   cpu->state_current = state_initial;
  47 /*   cpu->state_trace = state_trace; */
  48   if (state_trace)
  49     cpu->state_event =
  50         tmgr_history_add_trace(history, state_trace, 0.0, 0, cpu);
  51
  52   cpu->constraint =
  53       lmm_constraint_new(maxmin_system, cpu,
  54                          cpu->power_current * cpu->power_scale);
  55
  56   xbt_dict_set(cpu_set, name, cpu, cpu_free);
  57
  58   return cpu;
  59 }
  60
  61 /*
  62    Semantic:  name       scale     initial     power     initial     state
  63                                     power      trace      state      trace
  64
  65    Token:   TOKEN_WORD TOKEN_WORD TOKEN_WORD TOKEN_WORD TOKEN_WORD TOKEN_WORD
  66    Type:     string      double     double     string     ON/OFF     string
  67 */
  68
  69 static void parse_cpu(void)
  70 {
  71   e_surf_token_t token;
  72   char *name = NULL;
  73   double power_scale = 0.0;
  74   double power_initial = 0.0;
  75   tmgr_trace_t power_trace = NULL;
  76   e_surf_cpu_state_t state_initial = SURF_CPU_OFF;
  77   tmgr_trace_t state_trace = NULL;
  78
  79   name = xbt_strdup(surf_parse_text);
  80
  81   surf_parse_double(&power_scale);
  82   surf_parse_double(&power_initial);
  83   surf_parse_trace(&power_trace);
  84
  85   token = surf_parse();         /* state_initial */
  86   xbt_assert1((token == TOKEN_WORD), "Parse error line %d", surf_line_pos);
  87   if (strcmp(surf_parse_text, "ON") == 0)
  88     state_initial = SURF_CPU_ON;
  89   else if (strcmp(surf_parse_text, "OFF") == 0)
  90     state_initial = SURF_CPU_OFF;
  91   else {
  92     CRITICAL2("Invalid cpu state (line %d): %s neq ON or OFF\n", surf_line_pos,
  93               surf_parse_text);
  94     xbt_abort();
  95   }
  96
  97   surf_parse_trace(&state_trace);
  98
  99   cpu_new(name, power_scale, power_initial, power_trace, state_initial,
 100           state_trace);
 101 }
 102
 103 static void parse_file(const char *file)
 104 {
 105   e_surf_token_t token;
 106
 107   find_section(file, "CPU");
 108
 109   while (1) {
 110     token = surf_parse();
 111
 112     if (token == TOKEN_END_SECTION)
 113       break;
 114     if (token == TOKEN_NEWLINE)
 115       continue;
 116
 117     if (token == TOKEN_WORD)
 118       parse_cpu();
 119     else {
 120       CRITICAL1("Parse error line %d\n", surf_line_pos);
 121       xbt_abort();
 122     }
 123   }
 124
 125   close_section("CPU");
 126 }
 127
 128 static void *name_service(const char *name)
 129 {
 130   void *cpu = NULL;
 131
 132   xbt_dict_get(cpu_set, name, &cpu);
 133
 134   return cpu;
 135 }
 136
 137 static const char *get_resource_name(void *resource_id)
 138 {
 139   return ((cpu_t) resource_id)->name;
 140 }
 141
 142 static int resource_used(void *resource_id)
 143 {
 144   return lmm_constraint_used(maxmin_system,
 145                              ((cpu_t) resource_id)->constraint);
 146 }
 147
 148 static void action_free(surf_action_t action)
 149 {
 150   surf_action_cpu_t Action = (surf_action_cpu_t) action;
 151
 152   xbt_swag_remove(action, action->state_set);
 153   lmm_variable_free(maxmin_system, Action->variable);
 154   xbt_free(action);
 155
 156   return;
 157 }
 158
 159 static void action_cancel(surf_action_t action)
 160 {
 161   return;
 162 }
 163
 164 static void action_recycle(surf_action_t action)
 165 {
 166   return;
 167 }
 168
 169 static void action_change_state(surf_action_t action,
 170                                 e_surf_action_state_t state)
 171 {
 172   surf_action_change_state(action, state);
 173   return;
 174 }
 175
 176 static double share_resources(double now)
 177 {
 178   s_surf_action_cpu_t action;
 179   return generic_maxmin_share_resources(surf_cpu_resource->common_public->
 180                                         states.running_action_set,
 181                                         xbt_swag_offset(action, variable));
 182 }
 183
 184 static void update_actions_state(double now, double delta)
 185 {
 186   surf_action_cpu_t action = NULL;
 187   surf_action_cpu_t next_action = NULL;
 188   xbt_swag_t running_actions =
 189       surf_cpu_resource->common_public->states.running_action_set;
 190   xbt_swag_t failed_actions =
 191       surf_cpu_resource->common_public->states.failed_action_set;
 192
 193   xbt_swag_foreach_safe(action, next_action, running_actions) {
 194     action->generic_action.remains -=
 195         lmm_variable_getvalue(action->variable) * delta;
 196     if (action->generic_action.max_duration != NO_MAX_DURATION)
 197       action->generic_action.max_duration -= delta;
 198 /*     if(action->generic_action.remains<.00001) action->generic_action.remains=0; */
 199     if ((action->generic_action.remains <= 0) &&
 200         (lmm_get_variable_weight(action->variable)>0)) {
 201       action->generic_action.finish = surf_get_clock();
 202       action_change_state((surf_action_t) action, SURF_ACTION_DONE);
 203     } else if ((action->generic_action.max_duration != NO_MAX_DURATION) &&
 204                (action->generic_action.max_duration <= 0)) {
 205       action->generic_action.finish = surf_get_clock();
 206       action_change_state((surf_action_t) action, SURF_ACTION_DONE);
 207     } else {                    /* Need to check that none of the resource has failed */
 208       lmm_constraint_t cnst = NULL;
 209       int i = 0;
 210       cpu_t cpu = NULL;
 211
 212       while ((cnst =
 213               lmm_get_cnst_from_var(maxmin_system, action->variable,
 214                                     i++))) {
 215         cpu = lmm_constraint_id(cnst);
 216         if (cpu->state_current == SURF_CPU_OFF) {
 217           action->generic_action.finish = surf_get_clock();
 218           action_change_state((surf_action_t) action, SURF_ACTION_FAILED);
 219           break;
 220         }
 221       }
 222     }
 223   }
 224
 225   xbt_swag_foreach_safe(action, next_action, failed_actions) {
 226     lmm_variable_disable(maxmin_system, action->variable);
 227   }
 228
 229   return;
 230 }
 231
 232 static void update_resource_state(void *id,
 233                                   tmgr_trace_event_t event_type,
 234                                   double value)
 235 {
 236   cpu_t cpu = id;
 237
 238 /*   printf("[" "%lg" "] Asking to update CPU \"%s\" with value " */
 239 /*       "%lg" " for event %p\n", surf_get_clock(), cpu->name, */
 240 /*       value, event_type); */
 241
 242   if (event_type == cpu->power_event) {
 243     cpu->power_current = value;
 244     lmm_update_constraint_bound(maxmin_system, cpu->constraint,
 245                                 cpu->power_current * cpu->power_scale);
 246   } else if (event_type == cpu->state_event) {
 247     if (value > 0)
 248       cpu->state_current = SURF_CPU_ON;
 249     else
 250       cpu->state_current = SURF_CPU_OFF;
 251   } else {
 252     CRITICAL0("Unknown event ! \n");
 253     xbt_abort();
 254   }
 255
 256   return;
 257 }
 258
 259 static surf_action_t execute(void *cpu, double size)
 260 {
 261   surf_action_cpu_t action = NULL;
 262   cpu_t CPU = cpu;
 263
 264   action = xbt_new0(s_surf_action_cpu_t, 1);
 265
 266   action->generic_action.cost = size;
 267   action->generic_action.remains = size;
 268   action->generic_action.max_duration = NO_MAX_DURATION;
 269   action->generic_action.start = surf_get_clock();
 270   action->generic_action.finish = -1.0;
 271   action->generic_action.resource_type =
 272       (surf_resource_t) surf_cpu_resource;
 273
 274   if (CPU->state_current == SURF_CPU_ON)
 275     action->generic_action.state_set =
 276         surf_cpu_resource->common_public->states.running_action_set;
 277   else
 278     action->generic_action.state_set =
 279         surf_cpu_resource->common_public->states.failed_action_set;
 280   xbt_swag_insert(action, action->generic_action.state_set);
 281
 282   action->variable = lmm_variable_new(maxmin_system, action, 1.0, -1.0, 1);
 283   lmm_expand(maxmin_system, ((cpu_t) cpu)->constraint, action->variable,
 284              1.0);
 285
 286   return (surf_action_t) action;
 287 }
 288
 289 static surf_action_t action_sleep(void *cpu, double duration)
 290 {
 291   surf_action_cpu_t action = NULL;
 292
 293   action = (surf_action_cpu_t) execute(cpu, 1.0);
 294   action->generic_action.max_duration = duration;
 295   lmm_update_variable_weight(maxmin_system, action->variable, 0.0);
 296
 297   return (surf_action_t) action;
 298 }
 299
 300 static void action_suspend(surf_action_t action)
 301 {
 302   lmm_update_variable_weight(maxmin_system,
 303                              ((surf_action_cpu_t) action)->variable, 0.0);
 304 }
 305
 306 static void action_resume(surf_action_t action)
 307 {
 308   lmm_update_variable_weight(maxmin_system,
 309                              ((surf_action_cpu_t) action)->variable, 1.0);
 310 }
 311
 312 static int action_is_suspended(surf_action_t action)
 313 {
 314   return (lmm_get_variable_weight(((surf_action_cpu_t) action)->variable) == 0.0);
 315 }
 316
 317 static e_surf_cpu_state_t get_state(void *cpu)
 318 {
 319   return ((cpu_t) cpu)->state_current;
 320 }
 321
 322 static void finalize(void)
 323 {
 324   xbt_dict_free(&cpu_set);
 325   xbt_swag_free(surf_cpu_resource->common_public->states.ready_action_set);
 326   xbt_swag_free(surf_cpu_resource->common_public->states.
 327                 running_action_set);
 328   xbt_swag_free(surf_cpu_resource->common_public->states.
 329                 failed_action_set);
 330   xbt_swag_free(surf_cpu_resource->common_public->states.done_action_set);
 331   xbt_free(surf_cpu_resource->common_public);
 332   xbt_free(surf_cpu_resource->common_private);
 333   xbt_free(surf_cpu_resource->extension_public);
 334
 335   xbt_free(surf_cpu_resource);
 336   surf_cpu_resource = NULL;
 337 }
 338
 339 static void surf_cpu_resource_init_internal(void)
 340 {
 341   s_surf_action_t action;
 342
 343   surf_cpu_resource = xbt_new0(s_surf_cpu_resource_t, 1);
 344
 345   surf_cpu_resource->common_private =
 346       xbt_new0(s_surf_resource_private_t, 1);
 347   surf_cpu_resource->common_public = xbt_new0(s_surf_resource_public_t, 1);
 348
 349   surf_cpu_resource->extension_public =
 350       xbt_new0(s_surf_cpu_resource_extension_public_t, 1);
 351
 352   surf_cpu_resource->common_public->states.ready_action_set =
 353       xbt_swag_new(xbt_swag_offset(action, state_hookup));
 354   surf_cpu_resource->common_public->states.running_action_set =
 355       xbt_swag_new(xbt_swag_offset(action, state_hookup));
 356   surf_cpu_resource->common_public->states.failed_action_set =
 357       xbt_swag_new(xbt_swag_offset(action, state_hookup));
 358   surf_cpu_resource->common_public->states.done_action_set =
 359       xbt_swag_new(xbt_swag_offset(action, state_hookup));
 360
 361   surf_cpu_resource->common_public->name_service = name_service;
 362   surf_cpu_resource->common_public->get_resource_name = get_resource_name;
 363   surf_cpu_resource->common_public->action_get_state =
 364       surf_action_get_state;
 365   surf_cpu_resource->common_public->action_free = action_free;
 366   surf_cpu_resource->common_public->action_cancel = action_cancel;
 367   surf_cpu_resource->common_public->action_recycle = action_recycle;
 368   surf_cpu_resource->common_public->action_change_state =
 369       action_change_state;
 370   surf_cpu_resource->common_public->action_set_data = surf_action_set_data;
 371   surf_cpu_resource->common_public->name = "CPU";
 372
 373   surf_cpu_resource->common_private->resource_used = resource_used;
 374   surf_cpu_resource->common_private->share_resources = share_resources;
 375   surf_cpu_resource->common_private->update_actions_state =
 376       update_actions_state;
 377   surf_cpu_resource->common_private->update_resource_state =
 378       update_resource_state;
 379   surf_cpu_resource->common_private->finalize = finalize;
 380
 381   surf_cpu_resource->extension_public->execute = execute;
 382   surf_cpu_resource->extension_public->sleep = action_sleep;
 383   surf_cpu_resource->extension_public->suspend = action_suspend;
 384   surf_cpu_resource->extension_public->resume = action_resume;
 385   surf_cpu_resource->extension_public->is_suspended = action_is_suspended;
 386
 387   surf_cpu_resource->extension_public->get_state = get_state;
 388
 389   cpu_set = xbt_dict_new();
 390
 391   xbt_assert0(maxmin_system, "surf_init has to be called first!");
 392 }
 393
 394 void surf_cpu_resource_init(const char *filename)
 395 {
 396   if (surf_cpu_resource)
 397     return;
 398   surf_cpu_resource_init_internal();
 399   parse_file(filename);
 400   xbt_dynar_push(resource_list, &surf_cpu_resource);
 401 }