Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
add surf_cpu_init_im_bypass to be used to bypass the parser without passing through...
[simgrid.git] / src / include / surf / surf.h
index 2790d9b..41ebfa0 100644 (file)
@@ -1,6 +1,5 @@
-/*     $Id$     */
-
-/* Copyright (c) 2004 Arnaud Legrand. All rights reserved.                  */
+/* Copyright (c) 2004, 2005, 2006, 2007, 2008, 2009, 2010. The SimGrid Team.
+ * 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. */
 #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
  */
      typedef struct surf_model_description {
        const char *name;
+       const char *description;
        surf_model_t model;
        void (*model_init_preparse) (const char *filename);
        void (*model_init_postparse) (void);
@@ -55,6 +51,7 @@ XBT_PUBLIC(void) update_model_description(s_surf_model_description_t * table,
                                           surf_model_t model);
 XBT_PUBLIC(int) find_model_description(s_surf_model_description_t * table,
                                        const char *name);
+XBT_PUBLIC(void) model_help(const char* category, s_surf_model_description_t * table);
 
 /** \brief Action structure
  * \ingroup SURF_actions
@@ -81,6 +78,12 @@ 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
  *
@@ -121,7 +124,7 @@ 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;
+XBT_PUBLIC_DATA(routing_t) used_routing;
 
 /** \brief Private data available on all models
  *  \ingroup SURF_models
@@ -140,14 +143,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
       *
@@ -156,7 +151,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;
@@ -169,9 +164,10 @@ 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) (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);
+       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);
@@ -186,22 +182,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);
+         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);
        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
@@ -214,9 +211,11 @@ XBT_PUBLIC(int) find_model_description(s_surf_model_description_t * table,
        const char *name;/**< Name of this model */
        s_surf_action_state_t states; /**< Any living action on this model */
 
-       e_surf_action_state_t(*action_state_get) (surf_action_t action);/**< Return the state of an action */
+         e_surf_action_state_t(*action_state_get) (surf_action_t action);
+                                                                       /**< Return the state of an action */
        void (*action_state_set) (surf_action_t action,
-                                    e_surf_action_state_t state); /**< Change an action state*/
+                                 e_surf_action_state_t state);
+                                                                  /**< Change an action state*/
 
        double (*action_get_start_time) (surf_action_t action);/**< Return the start time of an action */
        double (*action_get_finish_time) (surf_action_t action);/**< Return the finish time of an action */
@@ -229,6 +228,7 @@ XBT_PUBLIC(int) find_model_description(s_surf_model_description_t * table,
        int (*is_suspended) (surf_action_t action);/**< Return whether an action is suspended */
        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 */
+       double (*get_remains) (surf_action_t action);/**< Get the remains of an action */
 
        xbt_dict_t resource_set;
 
@@ -258,9 +258,25 @@ XBT_PUBLIC(int) find_model_description(s_surf_model_description_t * table,
        xbt_dict_t properties;
      } s_surf_resource_t, *surf_resource_t;
 
-     XBT_PUBLIC(const char*) surf_resource_name(const void *resource);
-     XBT_PUBLIC(xbt_dict_t) surf_resource_properties(const void *resource);
-XBT_PUBLIC(void) surf_resource_free(void* resource);
+
+
+/**
+ * Resource which have a metric handled by a maxmin system
+ */
+     typedef struct {
+       double scale;
+       double peak;
+       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 */
 /**************************************/
@@ -291,6 +307,22 @@ XBT_PUBLIC_DATA(surf_model_t) surf_cpu_model;
  */
 XBT_PUBLIC(void) surf_cpu_model_init_Cas01(const char *filename);
 
+/** \brief Initializes the CPU model with trace integration
+ *  \ingroup SURF_models
+ *
+ */
+XBT_PUBLIC(void) surf_cpu_model_init_ti(const char *filename);
+
+/** \brief Initializes the CPU model with the model Cas01 Improved. This model uses a heap to order the events, decreasing the time complexity to get the minimum next event.
+ *  \ingroup SURF_models
+ *
+ *  This function is called by surf_workstation_model_init_CLM03
+ *  so you shouldn't have to call it by yourself.
+ *
+ *  \see surf_workstation_model_init_CLM03()
+ */
+XBT_PUBLIC(void) surf_cpu_model_init_Cas01_im(const char *filename);
+
 /** \brief The list of all available cpu model models
  *  \ingroup SURF_models
  */
@@ -308,6 +340,18 @@ XBT_PUBLIC(void) create_workstations(void);
  */
 XBT_PUBLIC_DATA(surf_model_t) surf_network_model;
 
+/** \brief Same as network model 'LagrangeVelho', only with different correction factors.
+ *  \ingroup SURF_models
+ *  \param filename XML platform file name
+ *
+ * This model is proposed by Pierre-Nicolas Clauss and Martin Quinson and Stéphane Génaud
+ * based on the model 'LV08' and different correction factors depending on the communication
+ * size (< 1KiB, < 64KiB, >= 64KiB).
+ *
+ *  \see surf_workstation_model_init_SMPI()
+ */
+XBT_PUBLIC(void) surf_network_model_init_SMPI(const char *filename);
+
 /** \brief Initializes the platform with the network model 'LagrangeVelho'
  *  \ingroup SURF_models
  *  \param filename XML platform file name
@@ -334,6 +378,8 @@ XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(const char *filename);
  */
 XBT_PUBLIC(void) surf_network_model_init_Constant(const char *filename);
 
+XBT_PUBLIC(void) surf_network_model_init_Vivaldi(const char *filename);
+
 /** \brief Initializes the platform with the network model CM02
  *  \ingroup SURF_models
  *  \param filename XML platform file name
@@ -404,25 +450,6 @@ XBT_PUBLIC(void) surf_network_model_init_Reno2(const char *filename);
  */
 XBT_PUBLIC(void) surf_network_model_init_Vegas(const char *filename);
 
-#ifdef HAVE_SDP
-/** \brief Initializes the platform with the network model based on SDP
- *  \ingroup SURF_models
- *  \param filename XML platform file name
- *
- *  This function implements the proportional fairness known as the maximization
- *  of x1*x2*...*xn .
- *
- *  Reference:
- *
- *  [TAG03]. Corinne Touati, Eitan Altman, and Jerome Galtier.
- *  Semi-definite programming approach for bandwidth allocation and routing in networks.
- *  Game Theory and Applications, 9:169-179, December 2003. Nova publisher.
- *
- *  Call this function only if you plan using surf_workstation_model_init_compound.
- */
-XBT_PUBLIC(void) surf_network_model_init_SDP(const char *filename);
-#endif
-
 /** \brief The list of all available network model models
  *  \ingroup SURF_models
  */
@@ -601,5 +628,11 @@ XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency;
 XBT_PUBLIC(double) get_cpu_power(const char *power);
 
 
+/* used to byPass XML ( interact direclty with cpu and  avoid callback ) */
+XBT_PUBLIC(void) surf_cpu_init_im_bypass(char* name,double power);
+
+#include "surf/surf_resource.h"
+#include "surf/surf_resource_lmm.h"
+
 SG_END_DECL()
 #endif /* _SURF_SURF_H */