src/surf/cpu.c

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