Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Added Reno2, a model that takes 2W/RTT as the utility parameter in the Low proposed...
[simgrid.git] / src / include / surf / surf.h
index fb139cb..f77959c 100644 (file)
@@ -8,11 +8,11 @@
 #ifndef _SURF_SURF_H
 #define _SURF_SURF_H
 
+#include "portable.h"
 #include "xbt/swag.h"
 #include "xbt/dynar.h"
 #include "xbt/dict.h"
 #include "xbt/misc.h"
-#include "portable.h"
 
 SG_BEGIN_DECL()
 
@@ -44,6 +44,7 @@ typedef struct surf_model_description {
   const char *name;
   surf_model_t model;
   void (* model_init) (const char *filename);
+  void (* create_ws) (void);
 } s_surf_model_description_t, *surf_model_description_t;
 
 XBT_PUBLIC(void) update_model_description(s_surf_model_description_t *table,
@@ -142,11 +143,7 @@ typedef struct surf_model_public {
   void (*set_priority) (surf_action_t action, double priority); /**< Set the priority of an action */
   const char *name; /**< Name of this model */
 
-  /*for the properties of the link*/
-  xbt_dict_t (*get_link_properties) (void* link);
-
-  /*for the properties of the cpu*/
-  xbt_dict_t (*get_cpu_properties) (void* cpu);
+  xbt_dict_t (*get_properties) (void* link); /**< Return the properties dictionary */
 
 } s_surf_model_public_t, *surf_model_public_t;
 
@@ -206,8 +203,8 @@ XBT_PUBLIC(void) surf_timer_model_init(const char *filename);
  *  \ingroup SURF_models
  */
 typedef enum {
-  SURF_CPU_ON = 1,             /**< Ready        */
-  SURF_CPU_OFF = 0             /**< Running      */
+  SURF_CPU_ON = 1,             /**< Up & ready        */
+  SURF_CPU_OFF = 0             /**< Down & broken     */
 } e_surf_cpu_state_t;
 
 /** \brief CPU model extension public
@@ -248,11 +245,11 @@ XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model;
  */
 XBT_PUBLIC(void) surf_cpu_model_init_Cas01(const char *filename);
 
-XBT_PUBLIC_DATA(int) surf_cpu_model_description_size;
+#define surf_cpu_model_description_size 1
 /** \brief The list of all available cpu model models
  *  \ingroup SURF_models
  */
-XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
+XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[surf_cpu_model_description_size];
 
 /* Network model */
 
@@ -281,6 +278,8 @@ typedef struct surf_network_model {
   surf_network_model_extension_public_t extension_public;
 } s_surf_network_model_t, *surf_network_model_t;
 
+XBT_PUBLIC(void) create_workstations(void);
+
 /** \brief The network model
  *  \ingroup SURF_models
  *
@@ -291,6 +290,21 @@ typedef struct surf_network_model {
  */
 XBT_PUBLIC_DATA(surf_network_model_t) surf_network_model;
 
+
+/** \brief Initializes the platform with the network model 'Constant'
+ *  \ingroup SURF_models
+ *  \param filename XML platform file name
+ *
+ *  In this model, the communication time between two network cards is
+ *  constant, hence no need for a routing table. This is particularly
+ *  usefull when simulating huge distributed algorithms where
+ *  scalability is really an issue. This function is called in
+ *  conjunction with surf_workstation_model_init_compound.
+ *
+ *  \see surf_workstation_model_init_compound()
+ */
+XBT_PUBLIC(void) surf_network_model_init_Constant(const char *filename);
+
 /** \brief Initializes the platform with the network model CM02
  *  \ingroup SURF_models
  *  \param filename XML platform file name
@@ -330,6 +344,21 @@ XBT_PUBLIC(void) surf_network_model_init_GTNETS(const char *filename);
  */
 XBT_PUBLIC(void) surf_network_model_init_Reno(const char *filename);
 
+/** \brief Initializes the platform with the network model Reno2
+ *  \ingroup SURF_models
+ *  \param filename XML platform file name
+ *
+ *  The problem is related to max( sum( arctan(C * Df * xi) ) ).
+ *
+ *  Reference:
+ *  [LOW01] S. H. Low. A duality model of TCP and queue management algorithms.
+ *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
+ *
+ *  Call this function only if you plan using surf_workstation_model_init_compound.
+ *
+ */
+XBT_PUBLIC(void) surf_network_model_init_Reno2(const char *filename);
+
 /** \brief Initializes the platform with the network model Vegas
  *  \ingroup SURF_models
  *  \param filename XML platform file name
@@ -356,7 +385,7 @@ XBT_PUBLIC(void) surf_network_model_init_Vegas(const char *filename);
  *
  *  Reference:
  *
- *  [TAG03]. Corinne Touati, Eitan Altman, and Jérôme Galtier.  
+ *  [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.
  *
@@ -365,13 +394,23 @@ XBT_PUBLIC(void) surf_network_model_init_Vegas(const char *filename);
 XBT_PUBLIC(void) surf_network_model_init_SDP(const char *filename);
 #endif
 
+#if (HAVE_GTNETS)
+# define inc_GT 1
+#else 
+# define inc_GT 0
+#endif
+#if (HAVE_SDP)
+# define inc_SDP 1
+#else
+# define inc_SDP 0
+#endif
 
+#define surf_network_model_description_size  4+inc_SDP+inc_GT
 
-XBT_PUBLIC_DATA(int) surf_network_model_description_size;
 /** \brief The list of all available network model models
  *  \ingroup SURF_models
  */
-XBT_PUBLIC_DATA(s_surf_model_description_t) surf_network_model_description[];
+XBT_PUBLIC_DATA(s_surf_model_description_t) surf_network_model_description[surf_network_model_description_size];
 
 /** \brief Workstation model extension public
  *  \ingroup SURF_models
@@ -471,11 +510,11 @@ XBT_PUBLIC(void) surf_workstation_model_init_KCCFLN05(const char *filename);
  */
 XBT_PUBLIC(void) surf_workstation_model_init_ptask_L07(const char *filename);
 
-XBT_PUBLIC_DATA(int) surf_workstation_model_description_size;
+#define surf_workstation_model_description_size 4
 /** \brief The list of all available workstation model models
  *  \ingroup SURF_models
  */
-XBT_PUBLIC_DATA(s_surf_model_description_t) surf_workstation_model_description[];
+XBT_PUBLIC_DATA(s_surf_model_description_t) surf_workstation_model_description[surf_workstation_model_description_size];
 
 /** \brief The network links
  *  \ingroup SURF_models
@@ -484,17 +523,17 @@ XBT_PUBLIC_DATA(s_surf_model_description_t) surf_workstation_model_description[]
  *
  *  \see workstation_set
  */
-XBT_PUBLIC_DATA(xbt_dict_t) network_link_set;
+XBT_PUBLIC_DATA(xbt_dict_t) link_set;
 
 /** \brief The workstations
  *  \ingroup SURF_models
  *
  *  This dict contains all workstations.
  *
- *  \see network_link_set
+ *  \see link_set
  */
 XBT_PUBLIC_DATA(xbt_dict_t)  workstation_set;
-
+XBT_PUBLIC_DATA(xbt_dict_t)  cpu_set;
 /** \brief List of initialized models
  *  \ingroup SURF_models
  */
@@ -520,6 +559,13 @@ XBT_PUBLIC_DATA(xbt_dynar_t)  model_list;
  */
 XBT_PUBLIC(void) surf_init(int *argc, char **argv);    /* initialize common structures */
 
+/** \brief Finish simulation initialization
+ *  \ingroup SURF_simulation
+ *
+ *  This function must be called before the first call to surf_solve()
+ */
+XBT_PUBLIC(void) surf_presolve(void);
+
 /** \brief Performs a part of the simulation
  *  \ingroup SURF_simulation
  *  \return the elapsed time, or -1.0 if no event could be executed
@@ -549,10 +595,50 @@ XBT_PUBLIC(double)surf_get_clock(void);
 XBT_PUBLIC(void) surf_exit(void);
 
 /* Prototypes of the functions that handle the properties */
+XBT_PUBLIC_DATA(xbt_dict_t) current_property_set; /* the prop set for the currently parsed element (also used in SIMIX) */
 void parse_properties(void);
-void free_string(void*);
 
-XBT_PUBLIC(void) surfxml_add_callback(xbt_dynar_t cb_list, void_f_void_t function);
+/* Prototypes for functions handling routing and were factorized succesfully from the models */
+void init_data(void);
+void parse_route_elem(void);
+
+/* surf parse file related (public because called from a test suite) */
+XBT_PUBLIC(void) parse_platform_file(const char* file);
+
+/* Stores the sets */
+XBT_PUBLIC_DATA(xbt_dict_t) set_list;
+
+void parse_foreach(void);
+void parse_sets(void);
+void parse_route_multi_set_endpoints(void);
+void parse_route_multi_set_route(void);
+void parse_cluster(void);
+void parse_trace_init(void);
+void parse_trace_finalize(void);
+void parse_trace_c_connect(void);
+
+void manage_route(xbt_dict_t route_table, const char* route_name, int action, int isMultiRoute);
+XBT_PUBLIC_DATA(int) route_action;
+
+/* This is used by all models when creating the routing table while parsing */
+XBT_PUBLIC_DATA(xbt_dict_t) route_table;
+XBT_PUBLIC_DATA(xbt_dict_t) route_multi_table;
+XBT_PUBLIC_DATA(xbt_dict_t) route_table;
+XBT_PUBLIC_DATA(xbt_dict_t) route_multi_table;
+XBT_PUBLIC_DATA(xbt_dynar_t) route_link_list;
+
+/* For the trace and trace:connect tag (store their content till the end of the parsing) */
+XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
+XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_host_avail;
+XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_power;
+XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_link_avail;
+XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_bandwidth;
+XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency;
+
+
+double get_cpu_power(const char* power);
+void init_randomness(void);
+void add_randomness(void);
 
 SG_END_DECL()