Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
cosmetics
[simgrid.git] / src / include / surf / surf.h
index 670cf5e..7c10146 100644 (file)
@@ -47,13 +47,11 @@ typedef struct surf_model_description {
 } s_surf_model_description_t, *surf_model_description_t;
 
 XBT_PUBLIC(void) update_model_description(s_surf_model_description_t *table,
-                                            int table_size,
-                                            const char* name, 
-                                            surf_model_t model
-                                            );
+                                         const char* name, 
+                                         surf_model_t model
+                                         );
 XBT_PUBLIC(int) find_model_description(s_surf_model_description_t *table,
-                                         int table_size,
-                                         const char* name);
+                                      const char* name);
 
 /** \brief Action structure
  * \ingroup SURF_actions
@@ -140,10 +138,8 @@ typedef struct surf_model_public {
   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 */
+  xbt_dict_t (*get_properties) (void* resource_id); /**< Return the properties dictionary */
   const char *name; /**< Name of this model */
-
-  xbt_dict_t (*get_properties) (void* link); /**< Return the properties dictionary */
-
 } s_surf_model_public_t, *surf_model_public_t;
 
 /** \brief Private data available on all models
@@ -244,11 +240,10 @@ XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model;
  */
 XBT_PUBLIC(void) surf_cpu_model_init_Cas01(const char *filename);
 
-#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[surf_cpu_model_description_size];
+XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
 
 /* Network model */
 
@@ -289,6 +284,21 @@ XBT_PUBLIC(void) create_workstations(void);
  */
 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
@@ -328,6 +338,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
@@ -363,17 +388,10 @@ XBT_PUBLIC(void) surf_network_model_init_Vegas(const char *filename);
 XBT_PUBLIC(void) surf_network_model_init_SDP(const char *filename);
 #endif
 
-#if defined(HAVE_GTNETS) && defined(HAVE_SDP)
-# define surf_network_model_description_size  5
-#elsif defined(HAVE_GTNETS) || defined(HAVE_SDP)
-# define surf_network_model_description_size  4
-#else 
-# define surf_network_model_description_size  3
-#endif   
 /** \brief The list of all available network model models
  *  \ingroup SURF_models
  */
-XBT_PUBLIC_DATA(s_surf_model_description_t) surf_network_model_description[surf_network_model_description_size];
+XBT_PUBLIC_DATA(s_surf_model_description_t) surf_network_model_description[];
 
 /** \brief Workstation model extension public
  *  \ingroup SURF_models
@@ -473,11 +491,10 @@ XBT_PUBLIC(void) surf_workstation_model_init_KCCFLN05(const char *filename);
  */
 XBT_PUBLIC(void) surf_workstation_model_init_ptask_L07(const char *filename);
 
-#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[surf_workstation_model_description_size];
+XBT_PUBLIC_DATA(s_surf_model_description_t) surf_workstation_model_description[];
 
 /** \brief The network links
  *  \ingroup SURF_models
@@ -522,6 +539,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
@@ -552,45 +576,33 @@ 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_DATA(void) parse_properties(void);
 
-/* 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 */
-void parse_platform_file(const char* file);
+/* 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(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 */
+/* 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_dynar_t) traces_connect_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;
+
+
+XBT_PUBLIC_DATA(double) get_cpu_power(const char* power);
 
-double get_cpu_power(const char* power);
-void init_randomness(void);
-void add_randomness(void);
 
 SG_END_DECL()