Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
cleanup __surf_is_absolute_file_path + empty a bit surf.hpp
authorMartin Quinson <martin.quinson@loria.fr>
Sat, 7 Jul 2018 23:29:44 +0000 (01:29 +0200)
committerMartin Quinson <martin.quinson@loria.fr>
Sat, 7 Jul 2018 23:29:50 +0000 (01:29 +0200)
Sorry for smashing two commits together this way, I forgot to commit
between 2 cleanups (because of clang-format).

The symbols removed from the public surf.hpp should never have been
made public in the first place. I think (and hope) that nobody use them.

src/include/surf/surf.hpp
src/surf/surf_interface.cpp
src/surf/surf_interface.hpp
src/surf/surf_private.hpp

index f04854a..0330f60 100644 (file)
@@ -78,17 +78,6 @@ XBT_PUBLIC_DATA simgrid::surf::CpuModel* surf_cpu_model_pm;
  */
 XBT_PUBLIC_DATA simgrid::surf::CpuModel* surf_cpu_model_vm;
 
-/** \ingroup SURF_models
- *  \brief Initializes the CPU model with the model Cas01
- *
- *  By default, this model uses the lazy optimization mechanism that relies on partial invalidation in LMM and a heap
- *  for lazy action update.
- *  You can change this behavior by setting the cpu/optim configuration variable to a different value.
- *
- *  You shouldn't have to call it by yourself.
- */
-XBT_PUBLIC void surf_cpu_model_init_Cas01();
-
 /** \ingroup SURF_models
  *  \brief The list of all available optimization modes (both for cpu and networks).
  *  These optimization modes can be set using --cfg=cpu/optim:... and --cfg=network/optim:...
@@ -105,115 +94,11 @@ XBT_PUBLIC_DATA s_surf_model_description_t surf_plugin_description[];
  */
 XBT_PUBLIC_DATA s_surf_model_description_t surf_cpu_model_description[];
 
-/** \ingroup SURF_models
- *  \brief Same as network model 'LagrangeVelho', only with different correction factors.
- *
- * 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 comments in the code for more information.
- *
- *  \see surf_host_model_init_SMPI()
- */
-XBT_PUBLIC void surf_network_model_init_SMPI();
-
-/** \ingroup SURF_models
- *  \brief Same as network model 'LagrangeVelho', only with different correction factors.
- *
- * This model impelments a variant of the contention model on Infinband networks based on
- * the works of Jérôme Vienne : http://mescal.imag.fr/membres/jean-marc.vincent/index.html/PhD/Vienne.pdf
- *
- *  \see surf_host_model_init_IB()
- */
-XBT_PUBLIC void surf_network_model_init_IB();
-
-/** \ingroup SURF_models
- *  \brief Initializes the platform with the network model 'LegrandVelho'
- *
- * This model is proposed by Arnaud Legrand and Pedro Velho based on the results obtained with the GTNets simulator for
- * onelink and dogbone sharing scenarios. See comments in the code for more information.
- *
- *  \see surf_host_model_init_LegrandVelho()
- */
-XBT_PUBLIC void surf_network_model_init_LegrandVelho();
-
-/** \ingroup SURF_models
- *  \brief Initializes the platform with the network model 'Constant'
- *
- *  In this model, the communication time between two network cards is constant, hence no need for a routing table.
- *  This is particularly useful when simulating huge distributed algorithms where scalability is really an issue. This
- *  function is called in conjunction with surf_host_model_init_compound.
- *
- *  \see surf_host_model_init_compound()
- */
-XBT_PUBLIC void surf_network_model_init_Constant();
-
-/** \ingroup SURF_models
- *  \brief Initializes the platform with the network model CM02
- *
- *  You sould call this function by yourself only if you plan using surf_host_model_init_compound.
- *  See comments in the code for more information.
- */
-XBT_PUBLIC void surf_network_model_init_CM02();
-
-/** \ingroup SURF_models
- *  \brief Initializes the platform with the network model NS3
- *
- *  This function is called by surf_host_model_init_NS3 or by yourself only if you plan using
- *  surf_host_model_init_compound
- *
- *  \see surf_host_model_init_NS3()
- */
-XBT_PUBLIC void surf_network_model_init_NS3();
-
-/** \ingroup SURF_models
- *  \brief Initializes the platform with the network model Reno
- *
- *  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.
- *
- *  Call this function only if you plan using surf_host_model_init_compound.
- */
-XBT_PUBLIC void surf_network_model_init_Reno();
-
-/** \ingroup SURF_models
- *  \brief Initializes the platform with the network model Reno2
- *
- *  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_host_model_init_compound.
- */
-XBT_PUBLIC void surf_network_model_init_Reno2();
-
-/** \ingroup SURF_models
- *  \brief Initializes the platform with the network model Vegas
- *
- *  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.
- *
- *  Call this function only if you plan using surf_host_model_init_compound.
- */
-XBT_PUBLIC void surf_network_model_init_Vegas();
-
 /** \ingroup SURF_models
  *  \brief The list of all available network model models
  */
 XBT_PUBLIC_DATA s_surf_model_description_t surf_network_model_description[];
 
-/** \ingroup SURF_models
- *  \brief The storage model
- */
-XBT_PUBLIC void surf_storage_model_init_default();
-
 /** \ingroup SURF_models
  *  \brief The list of all available storage modes.
  *  This storage mode can be set using --cfg=storage/model:...
@@ -230,46 +115,11 @@ XBT_PUBLIC_DATA simgrid::surf::StorageModel* surf_storage_model;
  */
 XBT_PUBLIC_DATA simgrid::surf::HostModel* surf_host_model;
 
-/** \ingroup SURF_models
- *  \brief Initializes the platform with a compound host model
- *
- *  This function should be called after a cpu_model and a network_model have been set up.
- */
-XBT_PUBLIC void surf_host_model_init_compound();
-
-/** \ingroup SURF_models
- *  \brief Initializes the platform with the current best network and cpu models at hand
- *
- *  This platform model separates the host model and the network model.
- *  The host model will be initialized with the model compound, the network model with the model LV08 (with cross
- *  traffic support) and the CPU model with the model Cas01.
- *  Such model is subject to modification with warning in the ChangeLog so monitor it!
- */
-XBT_PUBLIC void surf_host_model_init_current_default();
-
-/** \ingroup SURF_models
- *  \brief Initializes the platform with the model L07
- *
- *  With this model, only parallel tasks can be used. Resource sharing is done by identifying bottlenecks and giving an
- *  equal share of the model to each action.
- */
-XBT_PUBLIC void surf_host_model_init_ptask_L07();
-
 /** \ingroup SURF_models
  *  \brief The list of all available host model models
  */
 XBT_PUBLIC_DATA s_surf_model_description_t surf_host_model_description[];
 
-/** \ingroup SURF_models
- *  \brief Initializes the platform with the current best network and cpu models at hand
- *
- *  This platform model seperates the host model and the network model.
- *  The host model will be initialized with the model compound, the network model with the model LV08 (with cross
- *  traffic support) and the CPU model with the model Cas01.
- *  Such model is subject to modification with warning in the ChangeLog so monitor it!
- */
-XBT_PUBLIC void surf_vm_model_init_HL13();
-
 /*** SURF Globals **************************/
 
 /** \ingroup SURF_simulation
index db2ad1f..93a3b17 100644 (file)
@@ -122,11 +122,29 @@ double surf_get_clock()
   return NOW;
 }
 
+/* returns whether #file_path is a absolute file path. Surprising, isn't it ? */
+static bool is_absolute_file_path(const char* file_path)
+{
+#ifdef _WIN32
+  WIN32_FIND_DATA wfd = {0};
+  HANDLE hFile        = FindFirstFile(file_path, &wfd);
+
+  if (INVALID_HANDLE_VALUE == hFile)
+    return false;
+
+  FindClose(hFile);
+  return true;
+#else
+  return (file_path[0] == '/');
+#endif
+}
+
 std::ifstream* surf_ifsopen(std::string name)
 {
-  std::ifstream* fs = new std::ifstream();
   xbt_assert(not name.empty());
-  if (__surf_is_absolute_file_path(name.c_str())) { /* don't mess with absolute file names */
+
+  std::ifstream* fs = new std::ifstream();
+  if (is_absolute_file_path(name.c_str())) { /* don't mess with absolute file names */
     fs->open(name.c_str(), std::ifstream::in);
   }
 
@@ -150,7 +168,7 @@ FILE *surf_fopen(const char *name, const char *mode)
 
   xbt_assert(name);
 
-  if (__surf_is_absolute_file_path(name))       /* don't mess with absolute file names */
+  if (is_absolute_file_path(name)) /* don't mess with absolute file names */
     return fopen(name, mode);
 
   /* search relative files in the path */
@@ -164,26 +182,6 @@ FILE *surf_fopen(const char *name, const char *mode)
   return nullptr;
 }
 
-/* The __surf_is_absolute_file_path() returns 1 if
- * file_path is a absolute file path, in the other
- * case the function returns 0.
- */
-int __surf_is_absolute_file_path(const char *file_path)
-{
-#ifdef _WIN32
-  WIN32_FIND_DATA wfd = { 0 };
-  HANDLE hFile = FindFirstFile(file_path, &wfd);
-
-  if (INVALID_HANDLE_VALUE == hFile)
-    return 0;
-
-  FindClose(hFile);
-  return 1;
-#else
-  return (file_path[0] == '/');
-#endif
-}
-
 /** Displays the long description of all registered models, and quit */
 void model_help(const char *category, s_surf_model_description_t * table)
 {
index 80d582f..80ebe02 100644 (file)
@@ -57,7 +57,155 @@ static inline int double_equals(double value1, double value2, double precision)
  */
 XBT_PUBLIC_DATA std::vector<sg_host_t> host_that_restart;
 
-int XBT_PRIVATE __surf_is_absolute_file_path(const char *file_path);
+/** \ingroup SURF_models
+ *  \brief Initializes the CPU model with the model Cas01
+ *
+ *  By default, this model uses the lazy optimization mechanism that relies on partial invalidation in LMM and a heap
+ *  for lazy action update.
+ *  You can change this behavior by setting the cpu/optim configuration variable to a different value.
+ *
+ *  You shouldn't have to call it by yourself.
+ */
+XBT_PUBLIC void surf_cpu_model_init_Cas01();
+
+/** \ingroup SURF_models
+ *  \brief Same as network model 'LagrangeVelho', only with different correction factors.
+ *
+ * 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 comments in the code for more information.
+ *
+ *  \see surf_host_model_init_SMPI()
+ */
+XBT_PUBLIC void surf_network_model_init_SMPI();
+
+/** \ingroup SURF_models
+ *  \brief Same as network model 'LagrangeVelho', only with different correction factors.
+ *
+ * This model impelments a variant of the contention model on Infinband networks based on
+ * the works of Jérôme Vienne : http://mescal.imag.fr/membres/jean-marc.vincent/index.html/PhD/Vienne.pdf
+ *
+ *  \see surf_host_model_init_IB()
+ */
+XBT_PUBLIC void surf_network_model_init_IB();
+
+/** \ingroup SURF_models
+ *  \brief Initializes the platform with the network model 'LegrandVelho'
+ *
+ * This model is proposed by Arnaud Legrand and Pedro Velho based on the results obtained with the GTNets simulator for
+ * onelink and dogbone sharing scenarios. See comments in the code for more information.
+ *
+ *  \see surf_host_model_init_LegrandVelho()
+ */
+XBT_PUBLIC void surf_network_model_init_LegrandVelho();
+
+/** \ingroup SURF_models
+ *  \brief Initializes the platform with the network model 'Constant'
+ *
+ *  In this model, the communication time between two network cards is constant, hence no need for a routing table.
+ *  This is particularly useful when simulating huge distributed algorithms where scalability is really an issue. This
+ *  function is called in conjunction with surf_host_model_init_compound.
+ *
+ *  \see surf_host_model_init_compound()
+ */
+XBT_PUBLIC void surf_network_model_init_Constant();
+
+/** \ingroup SURF_models
+ *  \brief Initializes the platform with the network model CM02
+ *
+ *  You sould call this function by yourself only if you plan using surf_host_model_init_compound.
+ *  See comments in the code for more information.
+ */
+XBT_PUBLIC void surf_network_model_init_CM02();
+
+/** \ingroup SURF_models
+ *  \brief Initializes the platform with the network model NS3
+ *
+ *  This function is called by surf_host_model_init_NS3 or by yourself only if you plan using
+ *  surf_host_model_init_compound
+ *
+ *  \see surf_host_model_init_NS3()
+ */
+XBT_PUBLIC void surf_network_model_init_NS3();
+
+/** \ingroup SURF_models
+ *  \brief Initializes the platform with the network model Reno
+ *
+ *  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.
+ *
+ *  Call this function only if you plan using surf_host_model_init_compound.
+ */
+XBT_PUBLIC void surf_network_model_init_Reno();
+
+/** \ingroup SURF_models
+ *  \brief Initializes the platform with the network model Reno2
+ *
+ *  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_host_model_init_compound.
+ */
+XBT_PUBLIC void surf_network_model_init_Reno2();
+
+/** \ingroup SURF_models
+ *  \brief Initializes the platform with the network model Vegas
+ *
+ *  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.
+ *
+ *  Call this function only if you plan using surf_host_model_init_compound.
+ */
+XBT_PUBLIC void surf_network_model_init_Vegas();
+
+/** \ingroup SURF_models
+ *  \brief Initializes the platform with the current best network and cpu models at hand
+ *
+ *  This platform model seperates the host model and the network model.
+ *  The host model will be initialized with the model compound, the network model with the model LV08 (with cross
+ *  traffic support) and the CPU model with the model Cas01.
+ *  Such model is subject to modification with warning in the ChangeLog so monitor it!
+ */
+XBT_PUBLIC void surf_vm_model_init_HL13();
+
+/** \ingroup SURF_models
+ *  \brief Initializes the platform with a compound host model
+ *
+ *  This function should be called after a cpu_model and a network_model have been set up.
+ */
+XBT_PUBLIC void surf_host_model_init_compound();
+
+/** \ingroup SURF_models
+ *  \brief Initializes the platform with the current best network and cpu models at hand
+ *
+ *  This platform model separates the host model and the network model.
+ *  The host model will be initialized with the model compound, the network model with the model LV08 (with cross
+ *  traffic support) and the CPU model with the model Cas01.
+ *  Such model is subject to modification with warning in the ChangeLog so monitor it!
+ */
+XBT_PUBLIC void surf_host_model_init_current_default();
+
+/** \ingroup SURF_models
+ *  \brief Initializes the platform with the model L07
+ *
+ *  With this model, only parallel tasks can be used. Resource sharing is done by identifying bottlenecks and giving an
+ *  equal share of the model to each action.
+ */
+XBT_PUBLIC void surf_host_model_init_ptask_L07();
+
+/** \ingroup SURF_models
+ *  \brief The storage model
+ */
+XBT_PUBLIC void surf_storage_model_init_default();
 
 /**********
  * Action *
index 64319f3..06530ad 100644 (file)
 XBT_PRIVATE FILE* surf_fopen(const char* name, const char* mode);
 XBT_PRIVATE std::ifstream* surf_ifsopen(std::string name);
 
-/* The __surf_is_absolute_file_path() returns 1 if
- * file_path is a absolute file path, in the other
- * case the function returns 0.
- */
-XBT_PRIVATE int __surf_is_absolute_file_path(const char* file_path);
-
 XBT_PRIVATE void check_disk_attachment();
 
 #endif