Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
reindent.
[simgrid.git] / src / surf / cpu.c
index 06b7eaa..fd68353 100644 (file)
-/* Authors: Arnaud Legrand                                                  */
+/*     $Id$     */
+
+/* Copyright (c) 2004 Arnaud Legrand. All rights reserved.                  */
 
 /* This program is free software; you can redistribute it and/or modify it
  under the terms of the license (GNU LGPL) which comes with this package. */
* under the terms of the license (GNU LGPL) which comes with this package. */
 
 #include "cpu_private.h"
-#include "xbt/dict.h"
+
+XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_cpu, surf,
+                               "Logging specific to the SURF CPU module");
 
 surf_cpu_resource_t surf_cpu_resource = NULL;
-static xbt_dict_t cpu_set = NULL;
-static lmm_system_t sys = NULL;
+lmm_system_t cpu_maxmin_system = NULL;
 
-/* power_scale is the basic power of the cpu when the cpu is
-   completely available. initial_power is therefore expected to be
-   comprised between 0.0 and 1.0, just as the values of power_trace.
-   state_trace values mean SURF_CPU_ON if >0 and SURF_CPU_OFF
-   otherwise.
-*/
+xbt_dict_t cpu_set = NULL;
 
-static void *new_cpu(const char *name, xbt_maxmin_float_t power_scale,
-                     xbt_maxmin_float_t initial_power, tmgr_trace_t power_trace,
-                     e_surf_cpu_state_t initial_state, tmgr_trace_t state_trace)
+static void cpu_free(void *cpu)
 {
-  cpu_t cpu = xbt_new0(s_cpu_t,1);
+  free(((cpu_Cas01_t) cpu)->name);
+  free(cpu);
+}
 
+static cpu_Cas01_t cpu_new(char *name, double power_scale,
+                          double power_initial,
+                          tmgr_trace_t power_trace,
+                          e_surf_cpu_state_t state_initial,
+                          tmgr_trace_t state_trace)
+{
+  cpu_Cas01_t cpu = xbt_new0(s_cpu_Cas01_t, 1);
+
+  cpu->resource = (surf_resource_t) surf_cpu_resource;
   cpu->name = name;
   cpu->power_scale = power_scale;
-  cpu->current_power = initial_power;
-  cpu->power_trace = power_trace;
-  if(power_trace) tmgr_history_add_trace(history, power_trace, 0.0, 0, cpu);
+  xbt_assert0(cpu->power_scale > 0, "Power has to be >0");
+  cpu->power_current = power_initial;
+  if (power_trace)
+    cpu->power_event =
+       tmgr_history_add_trace(history, power_trace, 0.0, 0, cpu);
 
-  cpu->current_state = initial_state;
-  cpu->state_trace = state_trace;
-  if(state_trace) tmgr_history_add_trace(history, state_trace, 0.0, 0, cpu);
+  cpu->state_current = state_initial;
+  if (state_trace)
+    cpu->state_event =
+       tmgr_history_add_trace(history, state_trace, 0.0, 0, cpu);
 
-  cpu->constraint = lmm_constraint_new(sys, cpu, cpu->current_power * cpu->power_scale);
+  cpu->constraint =
+      lmm_constraint_new(cpu_maxmin_system, cpu,
+                        cpu->power_current * cpu->power_scale);
 
-  xbt_dict_set(cpu_set, name, cpu, NULL);
+  xbt_dict_set(cpu_set, name, cpu, cpu_free);
 
   return cpu;
 }
 
-static void parse_file(const char *file)
+static void parse_cpu(void)
 {
-  tmgr_trace_t trace_A = tmgr_trace_new("trace_A.txt");
-  tmgr_trace_t trace_B = tmgr_trace_new("trace_B.txt");
+  char *name = NULL;
+  double power_scale = 0.0;
+  double power_initial = 0.0;
+  tmgr_trace_t power_trace = NULL;
+  e_surf_cpu_state_t state_initial = SURF_CPU_OFF;
+  tmgr_trace_t state_trace = NULL;
+
+  name = xbt_strdup(A_surfxml_cpu_name);
+  surf_parse_get_double(&power_scale, A_surfxml_cpu_power);
+  surf_parse_get_double(&power_initial, A_surfxml_cpu_availability);
+  surf_parse_get_trace(&power_trace, A_surfxml_cpu_availability_file);
+
+  xbt_assert0((A_surfxml_cpu_state == A_surfxml_cpu_state_ON) ||
+             (A_surfxml_cpu_state == A_surfxml_cpu_state_OFF),
+             "Invalid state");
+  if (A_surfxml_cpu_state == A_surfxml_cpu_state_ON)
+    state_initial = SURF_CPU_ON;
+  if (A_surfxml_cpu_state == A_surfxml_cpu_state_OFF)
+    state_initial = SURF_CPU_OFF;
+  surf_parse_get_trace(&state_trace, A_surfxml_cpu_state_file);
+
+  cpu_new(name, power_scale, power_initial, power_trace, state_initial,
+         state_trace);
+}
 
-  new_cpu("Cpu A", 20.0, 1.0, trace_A, SURF_CPU_ON, NULL);
-  new_cpu("Cpu B", 120.0, 1.0, trace_B, SURF_CPU_ON, NULL);
+static void parse_file(const char *file)
+{
+  surf_parse_reset_parser();
+  ETag_surfxml_cpu_fun = parse_cpu;
+  surf_parse_open(file);
+  xbt_assert1((!surf_parse()), "Parse error in %s", file);
+  surf_parse_close();
 }
 
 static void *name_service(const char *name)
 {
-  void *cpu=NULL;
-  
-  xbt_dict_get(cpu_set, name, &cpu);
-
-  return cpu;
+  return xbt_dict_get_or_null(cpu_set, name);
 }
 
 static const char *get_resource_name(void *resource_id)
 {
-  return ((cpu_t) resource_id)->name;
+  return ((cpu_Cas01_t) resource_id)->name;
 }
 
 static int resource_used(void *resource_id)
 {
-  return lmm_constraint_used(sys, ((cpu_t)resource_id)->constraint);
-}
-
-static surf_action_t action_new(void *callback)
-{
-  return NULL;
+  return lmm_constraint_used(cpu_maxmin_system,
+                            ((cpu_Cas01_t) resource_id)->constraint);
 }
 
-static e_surf_action_state_t action_get_state(surf_action_t action)
+static int action_free(surf_action_t action)
 {
-  return SURF_ACTION_NOT_IN_THE_SYSTEM;
+  action->using--;
+  if (!action->using) {
+    xbt_swag_remove(action, action->state_set);
+    if (((surf_action_cpu_Cas01_t) action)->variable)
+      lmm_variable_free(cpu_maxmin_system,
+                       ((surf_action_cpu_Cas01_t) action)->variable);
+    free(action);
+    return 1;
+  }
+  return 0;
 }
 
-static void action_free(surf_action_t * action)
+static void action_use(surf_action_t action)
 {
-  return;
+  action->using++;
 }
 
 static void action_cancel(surf_action_t action)
 {
+  surf_action_change_state(action, SURF_ACTION_FAILED);
   return;
 }
 
 static void action_recycle(surf_action_t action)
 {
-  return;
+  DIE_IMPOSSIBLE;
 }
 
-static void action_change_state(surf_action_t action, e_surf_action_state_t state)
+static void action_change_state(surf_action_t action,
+                               e_surf_action_state_t state)
 {
+/*   if((state==SURF_ACTION_DONE) || (state==SURF_ACTION_FAILED)) */
+/*     if(((surf_action_cpu_Cas01_t)action)->variable) { */
+/*       lmm_variable_disable(cpu_maxmin_system, ((surf_action_cpu_Cas01_t)action)->variable); */
+/*       ((surf_action_cpu_Cas01_t)action)->variable = NULL; */
+/*     } */
+
   surf_action_change_state(action, state);
   return;
 }
 
-static xbt_heap_float_t share_resources()
+static double share_resources(double now)
 {
-  surf_action_cpu_t action = NULL;
-  xbt_swag_t running_actions= surf_cpu_resource->resource.states.running_action_set;
-  xbt_maxmin_float_t min = -1;
-  xbt_maxmin_float_t value = -1;
-  lmm_solve(sys);  
+  s_surf_action_cpu_Cas01_t action;
+  return generic_maxmin_share_resources2(surf_cpu_resource->common_public->
+                                        states.running_action_set,
+                                        xbt_swag_offset(action, variable),
+                                        cpu_maxmin_system, lmm_solve);
+}
 
-  action = xbt_swag_getFirst(running_actions);
-  if(!action) return 0.0;
-  value = lmm_variable_getvalue(action->variable);
-  min = action->generic_action.remains / value ;
+static void update_actions_state(double now, double delta)
+{
+  surf_action_cpu_Cas01_t action = NULL;
+  surf_action_cpu_Cas01_t next_action = NULL;
+  xbt_swag_t running_actions =
+      surf_cpu_resource->common_public->states.running_action_set;
+  /* FIXME: UNUSED
+     xbt_swag_t failed_actions =
+     surf_cpu_resource->common_public->states.failed_action_set;
+   */
 
-  xbt_swag_foreach(action,running_actions) {
-    value = action->generic_action.remains / 
-      lmm_variable_getvalue(action->variable);
-    if(value<min) min=value;
+  xbt_swag_foreach_safe(action, next_action, running_actions) {
+    double_update(&(action->generic_action.remains),
+                 lmm_variable_getvalue(action->variable) * delta);
+    if (action->generic_action.max_duration != NO_MAX_DURATION)
+      double_update(&(action->generic_action.max_duration), delta);
+    if ((action->generic_action.remains <= 0) &&
+       (lmm_get_variable_weight(action->variable) > 0)) {
+      action->generic_action.finish = surf_get_clock();
+      action_change_state((surf_action_t) action, SURF_ACTION_DONE);
+    } else if ((action->generic_action.max_duration != NO_MAX_DURATION) &&
+              (action->generic_action.max_duration <= 0)) {
+      action->generic_action.finish = surf_get_clock();
+      action_change_state((surf_action_t) action, SURF_ACTION_DONE);
+    } else {                   /* Need to check that none of the resource has failed */
+      lmm_constraint_t cnst = NULL;
+      int i = 0;
+      cpu_Cas01_t cpu = NULL;
+
+      while ((cnst =
+             lmm_get_cnst_from_var(cpu_maxmin_system, action->variable,
+                                   i++))) {
+       cpu = lmm_constraint_id(cnst);
+       if (cpu->state_current == SURF_CPU_OFF) {
+         action->generic_action.finish = surf_get_clock();
+         action_change_state((surf_action_t) action, SURF_ACTION_FAILED);
+         break;
+       }
+      }
+    }
   }
 
-  return min;
+  return;
 }
 
-static void update_state(xbt_heap_float_t now,
-                        xbt_heap_float_t delta)
+static void update_resource_state(void *id,
+                                 tmgr_trace_event_t event_type,
+                                 double value)
 {
-  surf_action_cpu_t action = NULL;
-  surf_action_cpu_t next_action = NULL;
-  xbt_swag_t running_actions= surf_cpu_resource->resource.states.running_action_set;
-
-  xbt_swag_foreach_safe(action, next_action, running_actions) {
-    action->generic_action.remains -= 
-      lmm_variable_getvalue(action->variable)*delta;
-/*     if(action->generic_action.remains<.00001) action->generic_action.remains=0; */
-    if(action->generic_action.remains<=0) {
-      action_change_state((surf_action_t)action, SURF_ACTION_DONE);
-    } /* else if(host_failed..) */
+  cpu_Cas01_t cpu = id;
+
+  if (event_type == cpu->power_event) {
+    cpu->power_current = value;
+    lmm_update_constraint_bound(cpu_maxmin_system, cpu->constraint,
+                               cpu->power_current * cpu->power_scale);
+  } else if (event_type == cpu->state_event) {
+    if (value > 0)
+      cpu->state_current = SURF_CPU_ON;
+    else
+      cpu->state_current = SURF_CPU_OFF;
+  } else {
+    CRITICAL0("Unknown event ! \n");
+    xbt_abort();
   }
 
   return;
 }
 
-static surf_action_t execute(void *cpu, xbt_maxmin_float_t size)
+static surf_action_t execute(void *cpu, double size)
 {
-  lmm_variable_t var;
-  surf_action_cpu_t action = NULL;
+  surf_action_cpu_Cas01_t action = NULL;
+  cpu_Cas01_t CPU = cpu;
+
+  XBT_IN2("(%s,%g)", CPU->name, size);
+  action = xbt_new0(s_surf_action_cpu_Cas01_t, 1);
+
+  action->generic_action.using = 1;
+  action->generic_action.cost = size;
+  action->generic_action.remains = size;
+  action->generic_action.priority = 1.0;
+  action->generic_action.max_duration = NO_MAX_DURATION;
+  action->generic_action.start = surf_get_clock();
+  action->generic_action.finish = -1.0;
+  action->generic_action.resource_type =
+      (surf_resource_t) surf_cpu_resource;
+  action->suspended = 0;       /* Should be useless because of the 
+                                  calloc but it seems to help valgrind... */
+
+  if (CPU->state_current == SURF_CPU_ON)
+    action->generic_action.state_set =
+       surf_cpu_resource->common_public->states.running_action_set;
+  else
+    action->generic_action.state_set =
+       surf_cpu_resource->common_public->states.failed_action_set;
+  xbt_swag_insert(action, action->generic_action.state_set);
+
+  action->variable = lmm_variable_new(cpu_maxmin_system, action,
+                                     action->generic_action.priority,
+                                     -1.0, 1);
+  lmm_expand(cpu_maxmin_system, CPU->constraint, action->variable, 1.0);
+  XBT_OUT;
+  return (surf_action_t) action;
+}
 
-  action=xbt_new0(s_surf_action_cpu_t,1);
+static surf_action_t action_sleep(void *cpu, double duration)
+{
+  surf_action_cpu_Cas01_t action = NULL;
+
+  XBT_IN2("(%s,%g)", ((cpu_Cas01_t) cpu)->name, duration);
+  action = (surf_action_cpu_Cas01_t) execute(cpu, 1.0);
+  action->generic_action.max_duration = duration;
+  action->suspended = 2;
+  lmm_update_variable_weight(cpu_maxmin_system, action->variable, 0.0);
+  XBT_OUT;
+  return (surf_action_t) action;
+}
 
-  action->generic_action.cost=size;
-  action->generic_action.remains=size;  
-  action->generic_action.start=-1.0;
-  action->generic_action.finish=-1.0;
-  action->generic_action.callback=cpu;
-  action->generic_action.resource_type=(surf_resource_t)surf_cpu_resource;
+static void action_suspend(surf_action_t action)
+{
+  XBT_IN1("(%p)", action);
+  if (((surf_action_cpu_Cas01_t) action)->suspended != 2) {
+    lmm_update_variable_weight(cpu_maxmin_system,
+                              ((surf_action_cpu_Cas01_t) action)->
+                              variable, 0.0);
+    ((surf_action_cpu_Cas01_t) action)->suspended = 1;
+  }
+  XBT_OUT;
+}
 
-  action->generic_action.state_set=surf_cpu_resource->resource.states.running_action_set;
-  xbt_swag_insert(action,action->generic_action.state_set);
+static void action_resume(surf_action_t action)
+{
+  XBT_IN1("(%p)", action);
+  if (((surf_action_cpu_Cas01_t) action)->suspended != 2) {
+    lmm_update_variable_weight(cpu_maxmin_system,
+                              ((surf_action_cpu_Cas01_t) action)->
+                              variable, action->priority);
+    ((surf_action_cpu_Cas01_t) action)->suspended = 0;
+  }
+  XBT_OUT;
+}
 
-  action->variable = lmm_variable_new(sys, action, 1.0, -1.0, 1);
-  lmm_expand(sys, ((cpu_t)cpu)->constraint, action->variable, 1.0);
+static int action_is_suspended(surf_action_t action)
+{
+  return (((surf_action_cpu_Cas01_t) action)->suspended == 1);
+}
 
-  return (surf_action_t) action;
+static void action_set_max_duration(surf_action_t action, double duration)
+{
+  XBT_IN2("(%p,%g)", action, duration);
+  action->max_duration = duration;
+  XBT_OUT;
+}
+
+static void action_set_priority(surf_action_t action, double priority)
+{
+  XBT_IN2("(%p,%g)", action, priority);
+  action->priority = priority;
+  XBT_OUT;
 }
 
 static e_surf_cpu_state_t get_state(void *cpu)
 {
-  return SURF_CPU_OFF;
+  return ((cpu_Cas01_t) cpu)->state_current;
 }
 
-static surf_cpu_resource_t surf_cpu_resource_init_internal(void)
+static double get_speed(void *cpu, double load)
+{
+  return load * (((cpu_Cas01_t) cpu)->power_scale);
+}
+
+static double get_available_speed(void *cpu)
+{
+  /* number between 0 and 1 */
+  return ((cpu_Cas01_t) cpu)->power_current;
+}
+
+static void finalize(void)
+{
+  xbt_dict_free(&cpu_set);
+  xbt_swag_free(surf_cpu_resource->common_public->states.ready_action_set);
+  xbt_swag_free(surf_cpu_resource->common_public->states.
+               running_action_set);
+  xbt_swag_free(surf_cpu_resource->common_public->states.
+               failed_action_set);
+  xbt_swag_free(surf_cpu_resource->common_public->states.done_action_set);
+  free(surf_cpu_resource->common_public);
+  free(surf_cpu_resource->common_private);
+  free(surf_cpu_resource->extension_public);
+
+  free(surf_cpu_resource);
+  surf_cpu_resource = NULL;
+}
+
+static void surf_cpu_resource_init_internal(void)
 {
   s_surf_action_t action;
 
-  surf_cpu_resource = xbt_new0(s_surf_cpu_resource_t,1);
-
-  surf_cpu_resource->resource.states.ready_action_set=
-    xbt_swag_new(xbt_swag_offset(action,state_hookup));
-  surf_cpu_resource->resource.states.running_action_set=
-    xbt_swag_new(xbt_swag_offset(action,state_hookup));
-  surf_cpu_resource->resource.states.failed_action_set=
-    xbt_swag_new(xbt_swag_offset(action,state_hookup));
-  surf_cpu_resource->resource.states.done_action_set=
-    xbt_swag_new(xbt_swag_offset(action,state_hookup));
-
-  surf_cpu_resource->resource.name_service = name_service;
-  surf_cpu_resource->resource.get_resource_name = get_resource_name;
-  surf_cpu_resource->resource.resource_used = resource_used;
-  surf_cpu_resource->resource.action_get_state=surf_action_get_state;
-  surf_cpu_resource->resource.action_free = action_free;
-  surf_cpu_resource->resource.action_cancel = action_cancel;
-  surf_cpu_resource->resource.action_recycle = action_recycle;
-  surf_cpu_resource->resource.action_change_state = action_change_state;
-  surf_cpu_resource->resource.share_resources = share_resources;
-  surf_cpu_resource->resource.update_state = update_state;
-
-  surf_cpu_resource->execute = execute;
-  surf_cpu_resource->get_state = get_state;
+  surf_cpu_resource = xbt_new0(s_surf_cpu_resource_t, 1);
+
+  surf_cpu_resource->common_private =
+      xbt_new0(s_surf_resource_private_t, 1);
+  surf_cpu_resource->common_public = xbt_new0(s_surf_resource_public_t, 1);
+
+  surf_cpu_resource->extension_public =
+      xbt_new0(s_surf_cpu_resource_extension_public_t, 1);
+
+  surf_cpu_resource->common_public->states.ready_action_set =
+      xbt_swag_new(xbt_swag_offset(action, state_hookup));
+  surf_cpu_resource->common_public->states.running_action_set =
+      xbt_swag_new(xbt_swag_offset(action, state_hookup));
+  surf_cpu_resource->common_public->states.failed_action_set =
+      xbt_swag_new(xbt_swag_offset(action, state_hookup));
+  surf_cpu_resource->common_public->states.done_action_set =
+      xbt_swag_new(xbt_swag_offset(action, state_hookup));
+
+  surf_cpu_resource->common_public->name_service = name_service;
+  surf_cpu_resource->common_public->get_resource_name = get_resource_name;
+  surf_cpu_resource->common_public->action_get_state =
+      surf_action_get_state;
+  surf_cpu_resource->common_public->action_get_start_time =
+      surf_action_get_start_time;
+  surf_cpu_resource->common_public->action_get_finish_time =
+      surf_action_get_finish_time;
+  surf_cpu_resource->common_public->action_free = action_free;
+  surf_cpu_resource->common_public->action_use = action_use;
+  surf_cpu_resource->common_public->action_cancel = action_cancel;
+  surf_cpu_resource->common_public->action_recycle = action_recycle;
+  surf_cpu_resource->common_public->action_change_state =
+      action_change_state;
+  surf_cpu_resource->common_public->action_set_data = surf_action_set_data;
+  surf_cpu_resource->common_public->name = "CPU";
+
+  surf_cpu_resource->common_private->resource_used = resource_used;
+  surf_cpu_resource->common_private->share_resources = share_resources;
+  surf_cpu_resource->common_private->update_actions_state =
+      update_actions_state;
+  surf_cpu_resource->common_private->update_resource_state =
+      update_resource_state;
+  surf_cpu_resource->common_private->finalize = finalize;
+
+  surf_cpu_resource->common_public->suspend = action_suspend;
+  surf_cpu_resource->common_public->resume = action_resume;
+  surf_cpu_resource->common_public->is_suspended = action_is_suspended;
+  surf_cpu_resource->common_public->set_max_duration =
+      action_set_max_duration;
+  surf_cpu_resource->common_public->set_priority = action_set_priority;
+  surf_cpu_resource->extension_public->execute = execute;
+  surf_cpu_resource->extension_public->sleep = action_sleep;
+
+  surf_cpu_resource->extension_public->get_state = get_state;
+  surf_cpu_resource->extension_public->get_speed = get_speed;
+  surf_cpu_resource->extension_public->get_available_speed =
+      get_available_speed;
 
   cpu_set = xbt_dict_new();
 
-  sys = lmm_system_new();
-
-  return surf_cpu_resource;
+  if (!cpu_maxmin_system)
+    cpu_maxmin_system = lmm_system_new();
 }
 
-void surf_cpu_resource_init(const char* filename)
+/*********************************************************************/
+/* Basic sharing model for CPU: that is where all this started... ;) */
+/*********************************************************************/
+/* @InProceedings{casanova01simgrid, */
+/*   author =       "H. Casanova", */
+/*   booktitle =    "Proceedings of the IEEE Symposium on Cluster Computing */
+/*                  and the Grid (CCGrid'01)", */
+/*   publisher =    "IEEE Computer Society", */
+/*   title =        "Simgrid: {A} Toolkit for the Simulation of Application */
+/*                  Scheduling", */
+/*   year =         "2001", */
+/*   month =        may, */
+/*   note =         "Available at */
+/*                  \url{http://grail.sdsc.edu/papers/simgrid_ccgrid01.ps.gz}." */
+/* } */
+void surf_cpu_resource_init_Cas01(const char *filename)
 {
-  surf_resource_t CPU = NULL;
-
-  surf_cpu_resource=surf_cpu_resource_init_internal();
+  if (surf_cpu_resource)
+    return;
+  surf_cpu_resource_init_internal();
   parse_file(filename);
-  CPU = &(surf_cpu_resource->resource); /* to make short */
-  xbt_dynar_push(resource_list, &CPU);
+  xbt_dynar_push(resource_list, &surf_cpu_resource);
 }