[DVFS] Update HostDvfs class documentation

[simgrid.git] / src / surf / surf_interface.hpp

diff --git a/src/surf/surf_interface.hpp b/src/surf/surf_interface.hpp
index 38bdbe0..8b16ee0 100644 (file)
--- a/src/surf/surf_interface.hpp
+++ b/src/surf/surf_interface.hpp
@@ -16,6 +16,7 @@
 #include <boost/heap/pairing_heap.hpp>
 #include <boost/intrusive/list.hpp>
 #include <boost/optional.hpp>
+#include <cmath>
 #include <set>
 #include <string>
 #include <unordered_map>
@@ -27,6 +28,10 @@
  *********/
 
 /* user-visible parameters */
+XBT_PUBLIC_DATA(double) sg_maxmin_precision;
+XBT_PUBLIC_DATA(double) sg_surf_precision;
+XBT_PUBLIC_DATA(int) sg_concurrency_limit;
+
 extern XBT_PRIVATE double sg_tcp_gamma;
 extern XBT_PRIVATE double sg_latency_factor;
 extern XBT_PRIVATE double sg_bandwidth_factor;
@@ -36,6 +41,28 @@ 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;
 
+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);
+  *variable -= value;
+  if (*variable < precision)
+    *variable = 0.0;
+}
+
+static inline int double_positive(double value, double precision)
+{
+  return (value > precision);
+}
+
+static inline int double_equals(double value1, double value2, double precision)
+{
+  return (fabs(value1 - value2) < precision);
+}
+
 extern "C" {
 XBT_PUBLIC(double) surf_get_clock();
 }
@@ -102,6 +129,12 @@ public:
     not_in_the_system /**< Not in the system anymore. Why did you ask ? */
   };
 
+  enum class SuspendStates {
+    not_suspended = 0, /**< Action currently not suspended **/
+    suspended,
+    sleeping
+  };
+
   /**
    * @brief Action constructor
    *
@@ -109,7 +142,7 @@ public:
    * @param cost The cost of the Action
    * @param failed If the action is impossible (e.g.: execute something on a switched off host)
    */
-  Action(simgrid::surf::Model *model, double cost, bool failed);
+  Action(simgrid::surf::Model* model, double cost, bool failed);
 
   /**
    * @brief Action constructor
@@ -119,7 +152,7 @@ public:
    * @param failed If the action is impossible (e.g.: execute something on a switched off host)
    * @param var The lmm variable associated to this Action if it is part of a LMM component
    */
-  Action(simgrid::surf::Model *model, double cost, bool failed, lmm_variable_t var);
+  Action(simgrid::surf::Model* model, double cost, bool failed, lmm_variable_t var);
 
   /** @brief Destructor */
   virtual ~Action();
@@ -212,8 +245,6 @@ public:
   /** @brief Get the state set in which the action is */
   ActionList* getStateSet() const { return stateSet_; };
 
-  s_xbt_swag_hookup_t stateHookup_ = {nullptr,nullptr};
-
   simgrid::surf::Model* getModel() const { return model_; }
 
 protected:
@@ -234,10 +265,10 @@ private:
   void *data_ = nullptr; /**< for your convenience */
 
   /* LMM */
-  double lastUpdate_         = 0;
-  double lastValue_          = 0;
-  lmm_variable_t variable_   = nullptr;
-  enum heap_action_type hat_ = NOTSET;
+  double lastUpdate_                                  = 0;
+  double lastValue_                                   = 0;
+  lmm_variable_t variable_                            = nullptr;
+  enum heap_action_type hat_                          = NOTSET;
   boost::optional<heap_type::handle_type> heapHandle_ = boost::none;
 
 public:
@@ -255,7 +286,7 @@ public:
   enum heap_action_type getHat() const { return hat_; }
   bool is_linked() const { return action_lmm_hook.is_linked(); }
 protected:
-  int suspended_ = 0;
+  Action::SuspendStates suspended_ = Action::SuspendStates::not_suspended;
 };
 
 typedef Action::ActionList ActionList;
@@ -408,6 +439,9 @@ public:
   /** @brief Check if the current Resource is used (if it currently serves an action) */
   virtual bool isUsed()=0;
 
+  /** @brief returns the current load (in flops per second, byte per second or similar) */
+  virtual double getLoad();
+
   /** @brief Check if the current Resource is active */
   virtual bool isOn() const;
   /** @brief Check if the current Resource is shut down */