Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
cosmetics (giva a name to a struct)
[simgrid.git] / src / include / surf / surf.h
index 5fc2982..12c74dc 100644 (file)
 #include "xbt/misc.h"
 #include "portable.h"
 #include "xbt/config.h"
+#include "surf/datatypes.h"
 
 SG_BEGIN_DECL()
+/* Actions and models are highly connected structures... */
 
 
+typedef enum {
+  SURF_RESOURCE_ON = 1,                   /**< Up & ready        */
+  SURF_RESOURCE_OFF = 0                   /**< Down & broken     */
+} e_surf_resource_state_t;
 
-/* Actions and models are higly connected structures... */
-/** \brief Action datatype
- *  \ingroup SURF_actions
- *
- * An action is some working amount on a model.
- * It is represented as a cost, a priority, a duration and a state.
- *
- * \see e_surf_action_state_t
- */
-typedef struct surf_action *surf_action_t;
 /** @Brief Specify that we use that action */
 XBT_PUBLIC(void) surf_action_ref(surf_action_t action);
-
-
-/** \brief Model datatype
- *  \ingroup SURF_models
+/** @brief Creates a new action.
  *
- *  Generic data structure for a model. The workstations,
- *  the CPUs and the network links are examples of models.
+ * @param size The size is the one of the subtype you want to create
+ * @param cost initial value
+ * @param model to which model we should attach this action
+ * @param failed whether we should start this action in failed mode
  */
-     typedef struct surf_model *surf_model_t;
+XBT_PUBLIC(void*) surf_action_new(size_t size,double cost,surf_model_t model, int failed);
+
+
 
 /** \brief Resource model description
  */
@@ -81,6 +78,11 @@ XBT_PUBLIC(int) find_model_description(s_surf_model_description_t * table,
        surf_model_t model_type;
      } s_surf_action_t;
 
+     typedef struct surf_action_lmm {
+       s_surf_action_t generic_action;
+       lmm_variable_t variable;
+       int suspended;
+     } s_surf_action_lmm_t,*surf_action_lmm_t;
 /** \brief Action states
  *  \ingroup SURF_actions
  *
@@ -120,6 +122,8 @@ XBT_PUBLIC(int) find_model_description(s_surf_model_description_t * table,
 /***************************/
 /* Generic model object */
 /***************************/
+     typedef struct s_routing s_routing_t, *routing_t;
+     XBT_PUBLIC_DATA(routing_t) used_routing;
 
 /** \brief Private data available on all models
  *  \ingroup SURF_models
@@ -138,14 +142,6 @@ XBT_PUBLIC(int) find_model_description(s_surf_model_description_t * table,
 
      /* Cpu model */
 
-     /** \brief CPU state
-      *  \ingroup SURF_models
-      */
-     typedef enum {
-       SURF_CPU_ON = 1,                   /**< Up & ready        */
-       SURF_CPU_OFF = 0                   /**< Down & broken     */
-     } e_surf_cpu_state_t;
-
      /** \brief CPU model extension public
       *  \ingroup SURF_models
       *
@@ -154,7 +150,7 @@ XBT_PUBLIC(int) find_model_description(s_surf_model_description_t * table,
      typedef struct surf_cpu_model_extension_public {
        surf_action_t(*execute) (void *cpu, double size);
        surf_action_t(*sleep) (void *cpu, double duration);
-       e_surf_cpu_state_t(*get_state) (void *cpu);
+       e_surf_resource_state_t (*get_state) (void *cpu);
        double (*get_speed) (void *cpu, double load);
        double (*get_available_speed) (void *cpu);
      } s_surf_model_extension_cpu_t;
@@ -167,9 +163,9 @@ XBT_PUBLIC(int) find_model_description(s_surf_model_description_t * table,
       *  Public functions specific to the network model
       */
      typedef struct surf_network_model_extension_public {
-       surf_action_t(*communicate) (void *src, void *dst, double size,
-                                    double max_rate);
-       xbt_dynar_t (*get_route) (void *src, void *dst);
+       surf_action_t(*communicate) (const char *src_name,const char *dst_name,int src, int dst, double size,
+           double rate);
+       xbt_dynar_t (*get_route) (int src, int dst);
        double (*get_link_bandwidth) (const void *link);
        double (*get_link_latency) (const void *link);
        int (*link_shared) (const void *link);
@@ -184,22 +180,23 @@ XBT_PUBLIC(int) find_model_description(s_surf_model_description_t * table,
        surf_action_t(*execute) (void *workstation, double size);                           /**< Execute a computation amount on a workstation
                                                                                        and create the corresponding action */
        surf_action_t(*sleep) (void *workstation, double duration);                         /**< Make a workstation sleep during a given duration */
-       e_surf_cpu_state_t(*get_state) (void *workstation);                                 /**< Return the CPU state of a workstation */
+       e_surf_resource_state_t(*get_state) (void *workstation);                                 /**< Return the CPU state of a workstation */
        double (*get_speed) (void *workstation, double load);                               /**< Return the speed of a workstation */
        double (*get_available_speed) (void *workstation);                                  /**< Return tha available speed of a workstation */
        surf_action_t(*communicate) (void *workstation_src,                                 /**< Execute a communication amount between two workstations */
                                     void *workstation_dst, double size,
                                     double max_rate);
+       xbt_dynar_t(*get_route)(void *workstation_src,void *workstation_dst);               /**< Get the list of links between two ws */
 
        surf_action_t(*execute_parallel_task) (int workstation_nb,                          /**< Execute a parallel task on several workstations */
                                               void **workstation_list,
                                               double *computation_amount,
                                               double *communication_amount,
                                               double amount, double rate);
-       xbt_dynar_t (*get_route) (void *src, void *dst);                                   /**< Return the network link list between two workstations */
        double (*get_link_bandwidth) (const void *link);                                    /**< Return the current bandwidth of a network link */
        double (*get_link_latency) (const void *link);                                      /**< Return the current latency of a network link */
        int (*link_shared) (const void *link);
+       xbt_dict_t (*get_properties)(const void*resource);
      } s_surf_model_extension_workstation_t;
 
 /** \brief Model datatype
@@ -228,7 +225,6 @@ XBT_PUBLIC(int) find_model_description(s_surf_model_description_t * table,
        void (*set_max_duration) (surf_action_t action, double duration);/**< Set the max duration of an action*/
        void (*set_priority) (surf_action_t action, double priority);/**< Set the priority of an action */
 
-       xbt_dict_t(*get_properties) (void *resource_id);/**< Return the properties dictionary */
        xbt_dict_t resource_set;
 
 
@@ -254,10 +250,28 @@ XBT_PUBLIC(int) find_model_description(s_surf_model_description_t * table,
      typedef struct surf_resource {
        surf_model_t model;
        char *name;
+       xbt_dict_t properties;
      } s_surf_resource_t, *surf_resource_t;
 
-XBT_PUBLIC(const char*) surf_resource_name(const void *resource);
-XBT_PUBLIC(void) surf_resource_free(void* resource);
+
+
+/**
+ * Resource which have a metric handled by a maxmin system
+ */
+typedef struct {
+  double current;
+  double max;
+  tmgr_trace_event_t event;
+} s_surf_metric_t;
+
+typedef struct surf_resource_lmm {
+  s_surf_resource_t generic_resource;
+  lmm_constraint_t constraint;
+  e_surf_resource_state_t state_current;
+  tmgr_trace_event_t state_event;
+  s_surf_metric_t power;
+}s_surf_resource_lmm_t, *surf_resource_lmm_t;
+
 /**************************************/
 /* Implementations of model object */
 /**************************************/
@@ -490,22 +504,6 @@ XBT_PUBLIC(void) surf_workstation_model_init_ptask_L07(const char *filename);
 XBT_PUBLIC_DATA(s_surf_model_description_t)
   surf_workstation_model_description[];
 
-/** \brief The network links
- *  \ingroup SURF_models
- *
- *  This dict contains all network links.
- *
- *  \see workstation_set
- */
-XBT_PUBLIC_DATA(xbt_dict_t) link_set;
-
-/** \brief The workstations
- *  \ingroup SURF_models
- *
- *  This dict contains all workstations.
- *
- *  \see link_set
- */
 /** \brief List of initialized models
  *  \ingroup SURF_models
  */
@@ -611,8 +609,10 @@ XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_bandwidth;
 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency;
 
 
-XBT_PUBLIC_DATA(double) get_cpu_power(const char *power);
+XBT_PUBLIC(double) get_cpu_power(const char *power);
 
+#include "surf/surf_resource.h"
+#include "surf/surf_resource_lmm.h"
 
 SG_END_DECL()
 #endif /* _SURF_SURF_H */