X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/30a95d9c54b09486dad30be824b354fb570078b1..92a1a3afd9e836da4c7cec7022097b7956c6d749:/src/include/surf/surf.h

diff --git a/src/include/surf/surf.h b/src/include/surf/surf.h
index 267a97a3c2..a35a9923e4 100644
--- a/src/include/surf/surf.h
+++ b/src/include/surf/surf.h
@@ -345,12 +345,67 @@ XBT_PUBLIC(void) surf_workstation_resource_init_CLM03(const char *filename);
  *
  *  \see surf_workstation_resource_init_CLM03()
  */
-
 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_proportionnal(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
@@ -424,6 +479,7 @@ XBT_PUBLIC(double)surf_get_clock(void);
  */
 XBT_PUBLIC(void) surf_exit(void);
 
+
 SG_END_DECL()
 
 #endif				/* _SURF_SURF_H */