Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Update copyright lines for 2022.
[simgrid.git] / src / surf / surf_interface.hpp
index 7723ee0..2cdc8f4 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2004-2019. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2004-2022. The SimGrid Team. All rights reserved.          */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
@@ -6,9 +6,14 @@
 #ifndef SURF_MODEL_H_
 #define SURF_MODEL_H_
 
-#include "src/surf/surf_private.hpp"
+#include <xbt/asserts.h>
+#include <xbt/function_types.h>
 
+#include "src/internal_config.h"
+
+#include <cfloat>
 #include <cmath>
+#include <functional>
 #include <set>
 #include <string>
 #include <unordered_map>
@@ -17,6 +22,8 @@
 /*********
  * Utils *
  *********/
+XBT_PRIVATE FILE* surf_fopen(const std::string& name, const char* mode);
+XBT_PRIVATE std::ifstream* surf_ifsopen(const std::string& name);
 
 /* user-visible parameters */
 XBT_PUBLIC_DATA double sg_maxmin_precision;
@@ -27,16 +34,24 @@ extern XBT_PRIVATE double sg_latency_factor;
 extern XBT_PRIVATE double sg_bandwidth_factor;
 extern XBT_PRIVATE double sg_weight_S_parameter;
 extern XBT_PRIVATE std::vector<std::string> surf_path;
-extern XBT_PRIVATE std::unordered_map<std::string, tmgr_trace_t> traces_set_list;
-extern XBT_PRIVATE std::set<std::string> watched_hosts;
+extern XBT_PRIVATE std::unordered_map<std::string, simgrid::kernel::profile::Profile*> traces_set_list;
+
+/** set of hosts for which one want to be notified if they ever restart */
+inline auto& watched_hosts() // avoid static initialization order fiasco
+{
+  static std::set<std::string, std::less<>> value;
+  return value;
+}
 
 static inline void double_update(double* variable, double value, double precision)
 {
-  // printf("Updating %g -= %g +- %g\n",*variable,value,precision);
-  // xbt_assert(value==0  || value>precision);
-  // Check that precision is higher than the machine-dependent size of the mantissa. If not, brutal rounding  may
-  // happen, and the precision mechanism is not active...
-  // xbt_assert(*variable< (2<<DBL_MANT_DIG)*precision && FLT_RADIX==2);
+  if (false) { // debug
+    fprintf(stderr, "Updating %g -= %g +- %g\n", *variable, value, precision);
+    xbt_assert(value == 0.0 || value > precision);
+    // Check that precision is higher than the machine-dependent size of the mantissa. If not, brutal rounding  may
+    // happen, and the precision mechanism is not active...
+    xbt_assert(FLT_RADIX == 2 && *variable < precision * exp2(DBL_MANT_DIG));
+  }
   *variable -= value;
   if (*variable < precision)
     *variable = 0.0;
@@ -72,16 +87,22 @@ XBT_PUBLIC void surf_cpu_model_init_Cas01();
  *
  *  @see surf_host_model_init_SMPI()
  */
+#if !HAVE_SMPI
+XBT_ATTRIB_NORETURN
+#endif
 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
+ * This model implements a variant of the contention model on Infiniband 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()
  */
+#if !HAVE_SMPI
+XBT_ATTRIB_NORETURN
+#endif
 XBT_PUBLIC void surf_network_model_init_IB();
 
 /** @ingroup SURF_models
@@ -108,7 +129,7 @@ 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.
+ *  You should 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();
@@ -121,56 +142,20 @@ XBT_PUBLIC void surf_network_model_init_CM02();
  *
  *  @see surf_host_model_init_NS3()
  */
+#if !SIMGRID_HAVE_NS3
+XBT_ATTRIB_NORETURN
+#endif
 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) ) ).
+ *  @brief Initializes the VM model used in the platform
  *
- *  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
+ *  A VM model depends on the physical CPU model to share the resources inside the VM
+ *  It will also creates the CPU model for actions running inside the VM
  *
- *  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();
+XBT_PUBLIC void surf_vm_model_init_HL13(simgrid::kernel::resource::CpuModel* cpu_pm_model);
 
 /** @ingroup SURF_models
  *  @brief Initializes the platform with a compound host model
@@ -197,49 +182,44 @@ XBT_PUBLIC void surf_host_model_init_current_default();
  */
 XBT_PUBLIC void surf_host_model_init_ptask_L07();
 
-/** @ingroup SURF_models
- *  @brief The storage model
- */
-XBT_PUBLIC void surf_storage_model_init_default();
+XBT_PUBLIC void surf_disk_model_init_default();
 
 /* --------------------
  *  Model Descriptions
  * -------------------- */
 /** @brief Resource model description */
-struct surf_model_description {
+struct surf_model_description_t {
   const char* name;
   const char* description;
-  void_f_void_t model_init_preparse;
+  std::function<void()> model_init_preparse;
 };
-typedef struct surf_model_description s_surf_model_description_t;
 
-XBT_PUBLIC int find_model_description(s_surf_model_description_t* table, std::string name);
-XBT_PUBLIC void model_help(const char* category, s_surf_model_description_t* table);
+XBT_PUBLIC const surf_model_description_t* find_model_description(const std::vector<surf_model_description_t>& table,
+                                                                  const std::string& name);
+XBT_PUBLIC void model_help(const char* category, const std::vector<surf_model_description_t>& table);
 
-#define SIMGRID_REGISTER_PLUGIN(id, desc, init)                       \
-  void simgrid_##id##_plugin_register();                              \
-  void XBT_ATTRIB_CONSTRUCTOR(800) simgrid_##id##_plugin_register() { \
-    simgrid_add_plugin_description(#id, desc, init);                  \
+#define SIMGRID_REGISTER_PLUGIN(id, desc, init)                                                                        \
+  static void XBT_ATTRIB_CONSTRUCTOR(800) _XBT_CONCAT3(simgrid_, id, _plugin_register)()                               \
+  {                                                                                                                    \
+    surf_plugin_description().emplace_back(surf_model_description_t{_XBT_STRINGIFY(id), (desc), (init)});              \
   }
 
-XBT_PUBLIC void simgrid_add_plugin_description(const char* name, const char* description, void_f_void_t init_fun);
-
 /** @brief The list of all available plugins */
-XBT_PUBLIC_DATA s_surf_model_description_t* surf_plugin_description;
+inline auto& surf_plugin_description() // Function to avoid static initialization order fiasco
+{
+  static std::vector<surf_model_description_t> plugin_description_table;
+  return plugin_description_table;
+}
 /** @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:... */
-XBT_PUBLIC_DATA s_surf_model_description_t surf_optimization_mode_description[];
+XBT_PUBLIC_DATA const std::vector<surf_model_description_t> surf_optimization_mode_description;
 /** @brief The list of all cpu models (pick one with --cfg=cpu/model) */
-XBT_PUBLIC_DATA s_surf_model_description_t surf_cpu_model_description[];
+XBT_PUBLIC_DATA const std::vector<surf_model_description_t> surf_cpu_model_description;
 /** @brief The list of all network models (pick one with --cfg=network/model) */
-XBT_PUBLIC_DATA s_surf_model_description_t surf_network_model_description[];
-/** @brief The list of all storage models (pick one with --cfg=storage/model) */
-XBT_PUBLIC_DATA s_surf_model_description_t surf_storage_model_description[];
+XBT_PUBLIC_DATA const std::vector<surf_model_description_t> surf_network_model_description;
+/** @brief The list of all disk models (pick one with --cfg=disk/model) */
+XBT_PUBLIC_DATA const std::vector<surf_model_description_t> surf_disk_model_description;
 /** @brief The list of all host models (pick one with --cfg=host/model:) */
-XBT_PUBLIC_DATA s_surf_model_description_t surf_host_model_description[];
-
-/**********
- * Action *
- **********/
+XBT_PUBLIC_DATA const std::vector<surf_model_description_t> surf_host_model_description;
 
 #endif /* SURF_MODEL_H_ */