X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/39a157b0abbb551db9d42f65d4268c9b607cd9cd..f794dd6b1fc076a9ee7bd8320f70ec8b559c12eb:/src/include/surf/surf.h

diff --git a/src/include/surf/surf.h b/src/include/surf/surf.h
index 32ba95aff1..6dfd902889 100644
--- a/src/include/surf/surf.h
+++ b/src/include/surf/surf.h
@@ -11,6 +11,12 @@
 #include "xbt/swag.h"
 #include "xbt/dynar.h"
 #include "xbt/dict.h"
+#include "xbt/misc.h"
+#include "gras_config.h"
+
+SG_BEGIN_DECL()
+
+
 
 /* Actions and resources are higly connected structures... */
 
@@ -24,6 +30,14 @@
  */
 typedef struct surf_action *surf_action_t;
 
+/** \brief Resource datatype
+ *  \ingroup SURF_resources
+ *  
+ *  Generic data structure for a resource. The workstations,
+ *  the CPUs and the network links are examples of resources.
+ */
+typedef struct surf_resource *surf_resource_t;
+
 /** \brief Action structure
  * \ingroup SURF_actions
  *
@@ -84,25 +98,6 @@ typedef struct surf_action_state {
 /* Generic resource object */
 /***************************/
 
-/** \brief Resource datatype
- *  \ingroup SURF_resources
- *  
- *  Generic data structure for a resource. The workstations,
- *  the CPUs and the network links are examples of resources.
- */
-typedef struct surf_resource *surf_resource_t;
-
-/** \brief Resource datatype
- *  \ingroup SURF_resources
- *  
- *  Generic data structure for a resource. The workstations,
- *  the CPUs and the network links are examples of resources.
- */
-typedef struct surf_resource {
-  surf_resource_private_t common_private;
-  surf_resource_public_t common_public;
-} s_surf_resource_t;
-
 /** \brief Public data available on all resources
  *  \ingroup SURF_resources
  *
@@ -136,18 +131,20 @@ typedef struct surf_resource_public {
  */
 typedef struct surf_resource_private *surf_resource_private_t;
 
-/**************************************/
-/* Implementations of resource object */
-/**************************************/
-
-/** \brief Timer resource
+/** \brief Resource datatype
  *  \ingroup SURF_resources
+ *  
+ *  Generic data structure for a resource. The workstations,
+ *  the CPUs and the network links are examples of resources.
  */
-typedef struct surf_timer_resource {
+typedef struct surf_resource {
   surf_resource_private_t common_private;
   surf_resource_public_t common_public;
-  surf_timer_resource_extension_public_t extension_public;
-} s_surf_timer_resource_t, *surf_timer_resource_t;
+} s_surf_resource_t;
+
+/**************************************/
+/* Implementations of resource object */
+/**************************************/
 
 /** \brief Timer resource extension public
  * \ingroup SURF_resource
@@ -160,15 +157,24 @@ typedef struct surf_timer_resource_extension_public {
 } s_surf_timer_resource_extension_public_t,
   *surf_timer_resource_extension_public_t;
 
+/** \brief Timer resource
+ *  \ingroup SURF_resources
+ */
+typedef struct surf_timer_resource {
+  surf_resource_private_t common_private;
+  surf_resource_public_t common_public;
+  surf_timer_resource_extension_public_t extension_public;
+} s_surf_timer_resource_t, *surf_timer_resource_t;
+
 /** \brief The timer resource
  *  \ingroup SURF_resources
  */
-extern surf_timer_resource_t surf_timer_resource;
+XBT_PUBLIC_DATA(surf_timer_resource_t) surf_timer_resource;
 
 /** \brief Initializes the timer resource
  *  \ingroup SURF_resources
  */
-void surf_timer_resource_init(const char *filename);
+XBT_PUBLIC(void) surf_timer_resource_init(const char *filename);
 
 /* Cpu resource */
 
@@ -180,15 +186,6 @@ typedef enum {
   SURF_CPU_OFF = 0		/**< Running      */
 } e_surf_cpu_state_t;
 
-/** \brief CPU resource datatype
- *  \ingroup SURF_resources
- */
-typedef struct surf_cpu_resource {
-  surf_resource_private_t common_private;
-  surf_resource_public_t common_public;
-  surf_cpu_resource_extension_public_t extension_public;
-} s_surf_cpu_resource_t, *surf_cpu_resource_t;
-
 /** \brief CPU resource extension public
  *  \ingroup SURF_resources
  *  
@@ -203,10 +200,19 @@ typedef struct surf_cpu_resource_extension_public {
 } s_surf_cpu_resource_extension_public_t,
     *surf_cpu_resource_extension_public_t;
 
+/** \brief CPU resource datatype
+ *  \ingroup SURF_resources
+ */
+typedef struct surf_cpu_resource {
+  surf_resource_private_t common_private;
+  surf_resource_public_t common_public;
+  surf_cpu_resource_extension_public_t extension_public;
+} s_surf_cpu_resource_t, *surf_cpu_resource_t;
+
 /** \brief The CPU resource
  *  \ingroup SURF_resources
  */
-extern surf_cpu_resource_t surf_cpu_resource;
+XBT_PUBLIC_DATA(surf_cpu_resource_t) surf_cpu_resource;
 
 /** \brief Initializes the CPU resource with the model Cas01
  *  \ingroup SURF_resources
@@ -216,19 +222,10 @@ extern surf_cpu_resource_t surf_cpu_resource;
  *
  *  \see surf_workstation_resource_init_CLM03()
  */
-void surf_cpu_resource_init_Cas01(const char *filename);
+XBT_PUBLIC(void) surf_cpu_resource_init_Cas01(const char *filename);
 
 /* Network resource */
 
-/** \brief Network resource datatype
- *  \ingroup SURF_resources
- */
-typedef struct surf_network_resource {
-  surf_resource_private_t common_private;
-  surf_resource_public_t common_public;
-  surf_network_resource_extension_public_t extension_public;
-} s_surf_network_resource_t, *surf_network_resource_t;
-
 /** \brief Network resource extension public
  *  \ingroup SURF_resources
  *
@@ -245,6 +242,15 @@ typedef struct surf_network_resource_extension_public {
 } s_surf_network_resource_extension_public_t,
     *surf_network_resource_extension_public_t;
 
+/** \brief Network resource datatype
+ *  \ingroup SURF_resources
+ */
+typedef struct surf_network_resource {
+  surf_resource_private_t common_private;
+  surf_resource_public_t common_public;
+  surf_network_resource_extension_public_t extension_public;
+} s_surf_network_resource_t, *surf_network_resource_t;
+
 /** \brief The network resource
  *  \ingroup SURF_resources
  *
@@ -253,7 +259,7 @@ typedef struct surf_network_resource_extension_public {
  *  resource should be accessed because depending on the platform model,
  *  the network resource can be NULL.
  */
-extern surf_network_resource_t surf_network_resource;
+XBT_PUBLIC_DATA(surf_network_resource_t) surf_network_resource;
 
 /** \brief Initializes the platform with the network model CM02
  *  \ingroup SURF_resources
@@ -264,17 +270,7 @@ extern surf_network_resource_t surf_network_resource;
  *
  *  \see surf_workstation_resource_init_CLM03()
  */
-void surf_network_resource_init_CM02(const char *filename);
-
-/** \brief Workstation resource datatype.
- *  \ingroup SURF_resources
- *
- */
-typedef struct surf_workstation_resource {
-  surf_resource_private_t common_private;
-  surf_resource_public_t common_public;
-  surf_workstation_resource_extension_public_t extension_public;
-} s_surf_workstation_resource_t, *surf_workstation_resource_t;
+XBT_PUBLIC(void) surf_network_resource_init_CM02(const char *filename);
 
 /** \brief Workstation resource extension public
  *  \ingroup SURF_resources
@@ -305,6 +301,16 @@ typedef struct surf_workstation_resource_extension_public {
 } s_surf_workstation_resource_extension_public_t,
     *surf_workstation_resource_extension_public_t;
 
+/** \brief Workstation resource datatype.
+ *  \ingroup SURF_resources
+ *
+ */
+typedef struct surf_workstation_resource {
+  surf_resource_private_t common_private;
+  surf_resource_public_t common_public;
+  surf_workstation_resource_extension_public_t extension_public;
+} s_surf_workstation_resource_t, *surf_workstation_resource_t;
+
 /** \brief The workstation resource
  *  \ingroup SURF_resources
  *
@@ -313,7 +319,7 @@ typedef struct surf_workstation_resource_extension_public {
  *  because depending on the platform model, the network resource and the CPU resource
  *  may not exist.
  */
-extern surf_workstation_resource_t surf_workstation_resource;
+XBT_PUBLIC_DATA(surf_workstation_resource_t) surf_workstation_resource;
 
 /** \brief Initializes the platform with the workstation model CLM03
  *  \ingroup SURF_resources
@@ -327,7 +333,7 @@ extern surf_workstation_resource_t surf_workstation_resource;
  *
  *  \see surf_workstation_resource_init_KCCFLN05()
  */
-void surf_workstation_resource_init_CLM03(const char *filename);
+XBT_PUBLIC(void) surf_workstation_resource_init_CLM03(const char *filename);
 
 /** \brief Initializes the platform with the model KCCFLN05
  *  \ingroup SURF_resources
@@ -339,7 +345,70 @@ void surf_workstation_resource_init_CLM03(const char *filename);
  *
  *  \see surf_workstation_resource_init_CLM03()
  */
-void surf_workstation_resource_init_KCCFLN05(const char *filename);
+XBT_PUBLIC(void) surf_workstation_resource_init_KCCFLN05(const char *filename);
+
+/** \brief Initializes the platform with the model KCCFLN05 using the proportional
+ *  approach as described in [TAG03]. 
+ *  
+ *  \ingroup SURF_resources
+ *  \param filename XML platform file name
+ *
+ *  This function implements the proportional fairness known as the maximization
+ *  of sum ( x1*x2*...*xn ).
+ *
+ *  Reference:
+ *
+ *  [TAG03]. Corinne Touati, Eitan Altman, and Jérôme Galtier.  
+ *  Semi-definite programming approach for bandwidth allocation and routing in networks.
+ *  Game Theory and Applications, 9:169-179, December 2003. Nova publisher.
+ *  With this model, the workstations and the network are handled together.
+ *  There is no network resource. This platform model is the default one for
+ *  MSG and SimDag.
+ *
+ *  \see surf_workstation_resource_init_CLM03()
+ */
+XBT_PUBLIC(void) surf_workstation_resource_init_KCCFLN05_proportional(const char *filename);
+
+/** \brief Initializes the platform with the model KCCFLN05 using a lagrange
+ *  optimization approach to compute the effectivet bandwidth of each flow based
+ *  on the Vegas TCP flavor fairness as shown in [LOW03]. 
+ *  
+ *  \ingroup SURF_resources
+ *  \param filename XML platform file name
+ *
+ *  This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent 
+ *  to the proportional fairness.
+ *
+ *  Reference:
+ *  [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
+ *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
+ *
+ */
+XBT_PUBLIC(void) surf_workstation_resource_init_KCCFLN05_Vegas(const char *filename);
+
+/** \brief Initializes the platform with the model KCCFLN05 using a lagrange
+ *  optimization approach to compute the effectivet bandwidth of each flow based
+ *  on the Reno TCP flavor fairness as shown in [LOW03]. 
+ *  
+ *  \ingroup SURF_resources
+ *  \param filename XML platform file name
+ *
+ *  The problem is related to max( sum( arctan(C * Df * xi) ) ).
+ *
+ *  Reference:
+ *  [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
+ *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
+ *
+ *  \see surf_workstation_resource_init_KCCFLN05_Vegas()
+ */
+XBT_PUBLIC(void) surf_workstation_resource_init_KCCFLN05_Reno(const char *filename);
+
+
+
+
+#ifdef USE_GTNETS
+XBT_PUBLIC(void) surf_workstation_resource_init_GTNETS(const char *filename);
+#endif
 
 /** \brief The network links
  *  \ingroup SURF_resources
@@ -348,7 +417,7 @@ void surf_workstation_resource_init_KCCFLN05(const char *filename);
  *
  *  \see workstation_set
  */
-extern xbt_dict_t network_link_set;
+XBT_PUBLIC_DATA(xbt_dict_t) network_link_set;
 
 /** \brief The workstations
  *  \ingroup SURF_resources
@@ -357,12 +426,12 @@ extern xbt_dict_t network_link_set;
  *
  *  \see network_link_set
  */
-extern xbt_dict_t workstation_set;
+XBT_PUBLIC_DATA(xbt_dict_t)  workstation_set;
 
 /** \brief List of initialized resources
  *  \ingroup SURF_resources
  */
-extern xbt_dynar_t resource_list;
+XBT_PUBLIC_DATA(xbt_dynar_t)  resource_list;
 
 /*******************************************/
 /*** SURF Globals **************************/
@@ -380,7 +449,7 @@ extern xbt_dynar_t resource_list;
  *  \see surf_timer_resource_init(), surf_workstation_resource_init_CLM03(),
  *  surf_workstation_resource_init_KCCFLN05(), surf_exit()
  */
-void surf_init(int *argc, char **argv);	/* initialize common structures */
+XBT_PUBLIC(void) surf_init(int *argc, char **argv);	/* initialize common structures */
 
 /** \brief Performs a part of the simulation
  *  \ingroup SURF_simulation
@@ -392,14 +461,14 @@ void surf_init(int *argc, char **argv);	/* initialize common structures */
  *  are not executed immediately but only when you call surf_solve.
  *  Note that the returned elapsed time can be zero.
  */
-double surf_solve(void);
+XBT_PUBLIC(double) surf_solve(void);
 
 /** \brief Return the current time
  *  \ingroup SURF_simulation
  *
  *  Return the current time in millisecond.
  */
-double surf_get_clock(void);
+XBT_PUBLIC(double)surf_get_clock(void);
 
 /** \brief Exit SURF
  *  \ingroup SURF_simulation
@@ -408,6 +477,9 @@ double surf_get_clock(void);
  *
  *  \see surf_init()
  */
-void surf_exit(void);
+XBT_PUBLIC(void) surf_exit(void);
+
+
+SG_END_DECL()
 
 #endif				/* _SURF_SURF_H */