Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
consistency between Action::ActionLmmList and Action::ActionList
[simgrid.git] / src / surf / surf_interface.hpp
index e42a2eb..6f6cdce 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2004-2016. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2004-2017. 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,21 +6,20 @@
 #ifndef SURF_MODEL_H_
 #define SURF_MODEL_H_
 
-#include <xbt.h>
-#include <string>
-#include <vector>
-#include <memory>
-#include <utility>
-
-#include <boost/intrusive/list.hpp>
+#include "xbt/signal.hpp"
+#include "xbt/utility.hpp"
 
-#include <xbt/signal.hpp>
+#include "src/surf/surf_private.hpp"
+#include "surf/surf.hpp"
+#include "xbt/str.h"
 
-#include "xbt/lib.h"
-#include "surf/surf_routing.h"
-#include "surf/surf.h"
-#include "src/surf/surf_private.h"
-#include "src/internal_config.h"
+#include <boost/heap/pairing_heap.hpp>
+#include <boost/intrusive/list.hpp>
+#include <boost/optional.hpp>
+#include <cmath>
+#include <set>
+#include <string>
+#include <unordered_map>
 
 #define NO_MAX_DURATION -1.0
 
  *********/
 
 /* 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_sender_gap;
 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 int sg_network_crosstraffic;
-extern XBT_PRIVATE xbt_dynar_t surf_path;
-
-extern "C" {
-XBT_PUBLIC(double) surf_get_clock(void);
+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;
 }
 
-extern XBT_PRIVATE double sg_sender_gap;
-
-namespace simgrid {
-namespace surf {
-
-extern XBT_PRIVATE simgrid::xbt::signal<void(void)> surfExitCallbacks;
-
-}
+static inline int double_positive(double value, double precision)
+{
+  return (value > precision);
 }
 
-int XBT_PRIVATE __surf_is_absolute_file_path(const char *file_path);
-
-static inline char* sg_storage_name(sg_storage_t storage) {
-  return storage->key;
+static inline int double_equals(double value1, double value2, double precision)
+{
+  return (fabs(value1 - value2) < precision);
 }
 
-/***********
- * Classes *
- ***********/
-
-enum heap_action_type{
-  LATENCY = 100,
-  MAX_DURATION,
-  NORMAL,
-  NOTSET
-};
+extern "C" {
+XBT_PUBLIC(double) surf_get_clock();
+}
+/** \ingroup SURF_simulation
+ *  \brief List of hosts that have just restarted and whose autorestart process should be restarted.
+ */
+XBT_PUBLIC_DATA(std::vector<sg_host_t>) host_that_restart;
 
-/*********
- * Trace *
- *********/
-/* For the trace and trace:connect tag (store their content till the end of the parsing) */
-XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
+int XBT_PRIVATE __surf_is_absolute_file_path(const char *file_path);
 
 /**********
  * Action *
  **********/
 
-XBT_PRIVATE void surf_action_lmm_update_index_heap(void *action, int i);
-
-XBT_PUBLIC_DATA(xbt_dynar_t) all_existing_models;
+/** \ingroup SURF_models
+ *  \brief List of initialized models
+ */
+XBT_PUBLIC_DATA(std::vector<surf_model_t>*) all_existing_models;
 
 namespace simgrid {
 namespace surf {
 
+typedef std::pair<double, simgrid::surf::Action*> heap_element_type;
+typedef boost::heap::pairing_heap<heap_element_type, boost::heap::constant_time_size<false>, boost::heap::stable<true>,
+                                  boost::heap::compare<simgrid::xbt::HeapComparator<heap_element_type>>>
+    heap_type;
+
 /** @ingroup SURF_interface
  * @brief SURF action interface class
  * @details An action is an event generated by a resource (e.g.: a communication for the network)
  */
 XBT_PUBLIC_CLASS Action {
 public:
-  boost::intrusive::list_member_hook<> action_hook;
-  boost::intrusive::list_member_hook<> action_lmm_hook;
-  typedef boost::intrusive::member_hook<
-    Action, boost::intrusive::list_member_hook<>, &Action::action_hook> ActionOptions;
+  boost::intrusive::list_member_hook<> modifiedSetHook_; /* Used by the lazy update to list the actions to track */
+  bool isLinkedModifiedSet() const { return modifiedSetHook_.is_linked(); }
+
+  typedef boost::intrusive::member_hook<Action, boost::intrusive::list_member_hook<>, &Action::modifiedSetHook_>
+      ActionLmmOptions;
+  typedef boost::intrusive::list<Action, ActionLmmOptions> ActionLmmList;
+
+  boost::intrusive::list_member_hook<> stateSetHook_;
+  typedef boost::intrusive::member_hook<Action, boost::intrusive::list_member_hook<>, &Action::stateSetHook_>
+      ActionOptions;
   typedef boost::intrusive::list<Action, ActionOptions> ActionList;
 
   enum class State {
@@ -106,14 +117,14 @@ public:
     not_in_the_system /**< Not in the system anymore. Why did you ask ? */
   };
 
-private:
-  /**
-   * @brief Common initializations for the constructors
-   */
-  void initialize(simgrid::surf::Model *model, double cost, bool failed,
-                  lmm_variable_t var = NULL);
+  enum class SuspendStates {
+    not_suspended = 0, /**< Action currently not suspended **/
+    suspended,
+    sleeping
+  };
+
+  enum class Type { LATENCY = 100, MAX_DURATION, NORMAL, NOTSET };
 
-public:
   /**
    * @brief Action constructor
    *
@@ -121,7 +132,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::Modelmodel, double cost, bool failed);
 
   /**
    * @brief Action constructor
@@ -131,36 +142,39 @@ 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, kernel::lmm::Variable* var);
 
-  /** @brief Destructor */
   virtual ~Action();
 
-  /** @brief Mark that the action is now finished */
-  void finish();
+  /**
+   * @brief Mark that the action is now finished
+   *
+   * @param state the new [state](\ref simgrid::surf::Action::State) of the current Action
+   */
+  void finish(Action::State state);
 
   /** @brief Get the [state](\ref simgrid::surf::Action::State) of the current Action */
-  Action::State getState(); /**< get the state*/
+  Action::State getState() const; /**< get the state*/
   /** @brief Set the [state](\ref simgrid::surf::Action::State) of the current Action */
   virtual void setState(Action::State state);
 
   /** @brief Get the bound of the current Action */
-  double getBound();
+  double getBound() const;
   /** @brief Set the bound of the current Action */
   void setBound(double bound);
 
   /** @brief Get the start time of the current action */
-  double getStartTime();
+  double getStartTime() const { return start_; }
   /** @brief Get the finish time of the current action */
-  double getFinishTime();
+  double getFinishTime() const { return finishTime_; }
 
   /** @brief Get the user data associated to the current action */
-  void *getData() {return data_;}
+  void* getData() const { return data_; }
   /** @brief Set the user data associated to the current action */
-  void setData(void* data);
+  void setData(void* data) { data_ = data; }
 
   /** @brief Get the cost of the current action */
-  double getCost() {return cost_;}
+  double getCost() const { return cost_; }
   /** @brief Set the cost of the current action */
   void setCost(double cost) {cost_ = cost;}
 
@@ -177,7 +191,7 @@ public:
   /** @brief Get the remaining time of the current action after updating the resource */
   virtual double getRemains();
   /** @brief Get the remaining time of the current action without updating the resource */
-  double getRemainsNoUpdate();
+  double getRemainsNoUpdate() const { return remains_; }
 
   /** @brief Set the finish time of the current action */
   void setFinishTime(double value) {finishTime_ = value;}
@@ -202,72 +216,71 @@ public:
   virtual bool isSuspended();
 
   /** @brief Get the maximum duration of the current action */
-  double getMaxDuration() {return maxDuration_;}
+  double getMaxDuration() const { return maxDuration_; }
   /** @brief Set the maximum duration of the current Action */
   virtual void setMaxDuration(double duration);
 
   /** @brief Get the tracing category associated to the current action */
-  char *getCategory() {return category_;}
+  char* getCategory() const { return category_; }
   /** @brief Set the tracing category of the current Action */
   void setCategory(const char *category);
 
   /** @brief Get the priority of the current Action */
-  double getPriority() {return priority_;};
+  double getPriority() const { return sharingWeight_; };
   /** @brief Set the priority of the current Action */
-  virtual void setPriority(double priority);
+  virtual void setSharingWeight(double priority);
+  void setSharingWeightNoUpdate(double weight) { sharingWeight_ = weight; }
 
   /** @brief Get the state set in which the action is */
-  ActionList* getStateSet() {return stateSet_;};
-
-  s_xbt_swag_hookup_t stateHookup_ = {NULL,NULL};
+  ActionList* getStateSet() const { return stateSet_; };
 
-  simgrid::surf::Model *getModel() {return model_;}
+  simgrid::surf::Model* getModel() const { return model_; }
 
 protected:
   ActionList* stateSet_;
-  double priority_ = 1.0; /**< priority (1.0 by default) */
   int    refcount_ = 1;
-  double remains_; /**< How much of that cost remains to be done in the currently running task */
-  double maxDuration_ = NO_MAX_DURATION; /*< max_duration (may fluctuate until the task is completed) */
-  double finishTime_ = -1; /**< finish time : this is modified during the run and fluctuates until the task is completed */
 
 private:
+  double sharingWeight_ = 1.0;             /**< priority (1.0 by default) */
+  double maxDuration_ = NO_MAX_DURATION; /*< max_duration (may fluctuate until the task is completed) */
+  double remains_;                       /**< How much of that cost remains to be done in the currently running task */
   double start_; /**< start time  */
-  char *category_ = NULL;            /**< tracing category for categorized resource utilization monitoring */
+  char *category_ = nullptr;            /**< tracing category for categorized resource utilization monitoring */
+  double finishTime_ =
+      -1; /**< finish time : this is modified during the run and fluctuates until the task is completed */
 
   double    cost_;
   simgrid::surf::Model *model_;
-  void *data_ = NULL; /**< for your convenience */
+  void *data_ = nullptr; /**< for your convenience */
 
   /* LMM */
+  double lastUpdate_                                  = 0;
+  double lastValue_                                   = 0;
+  kernel::lmm::Variable* variable_                    = nullptr;
+  Action::Type type_                                  = Action::Type::NOTSET;
+  boost::optional<heap_type::handle_type> heapHandle_ = boost::none;
+
 public:
-  virtual void updateRemainingLazy(double now);
-  void heapInsert(xbt_heap_t heap, double key, enum heap_action_type hat);
-  void heapRemove(xbt_heap_t heap);
-  void heapUpdate(xbt_heap_t heap, double key, enum heap_action_type hat);
-  void updateIndexHeap(int i);
-  lmm_variable_t getVariable() {return variable_;}
-  double getLastUpdate() {return lastUpdate_;}
+  virtual void updateRemainingLazy(double now) { THROW_IMPOSSIBLE; };
+  void heapInsert(heap_type & heap, double key, Action::Type hat);
+  void heapRemove(heap_type& heap);
+  void heapUpdate(heap_type & heap, double key, Action::Type hat);
+  void clearHeapHandle() { heapHandle_ = boost::none; }
+  kernel::lmm::Variable* getVariable() const { return variable_; }
+  void setVariable(kernel::lmm::Variable * var) { variable_ = var; }
+  double getLastUpdate() const { return lastUpdate_; }
   void refreshLastUpdate() {lastUpdate_ = surf_get_clock();}
-  enum heap_action_type getHat() {return hat_;}
-  bool is_linked() {return action_lmm_hook.is_linked();}
-  void gapRemove();
+  double getLastValue() const { return lastValue_; }
+  void setLastValue(double val) { lastValue_ = val; }
+  Action::Type getType() const { return type_; }
 
 protected:
-  lmm_variable_t variable_ = nullptr;
-  double lastValue_ = 0;
-  double lastUpdate_ = 0;
-  int suspended_ = 0;
-  int indexHeap_;
-  enum heap_action_type hat_ = NOTSET;
+  Action::SuspendStates suspended_ = Action::SuspendStates::not_suspended;
 };
 
 typedef Action::ActionList ActionList;
-
-typedef boost::intrusive::member_hook<
-  Action, boost::intrusive::list_member_hook<>, &Action::action_lmm_hook> ActionLmmOptions;
-typedef boost::intrusive::list<Action, ActionLmmOptions> ActionLmmList;
-typedef ActionLmmList* ActionLmmListPtr;
+typedef Action::ActionLmmList ActionLmmList;
+typedef Action::ActionLmmList* ActionLmmListPtr;
 
 /*********
  * Model *
@@ -283,31 +296,36 @@ public:
   virtual ~Model();
 
   /** @brief Get the set of [actions](@ref Action) in *ready* state */
-  virtual ActionList* getReadyActionSet() {return readyActionSet_;}
+  virtual ActionList* getReadyActionSet() const { return readyActionSet_; }
 
   /** @brief Get the set of [actions](@ref Action) in *running* state */
-  virtual ActionList* getRunningActionSet() {return runningActionSet_;}
+  virtual ActionList* getRunningActionSet() const { return runningActionSet_; }
 
   /** @brief Get the set of [actions](@ref Action) in *failed* state */
-  virtual ActionList* getFailedActionSet() {return failedActionSet_;}
+  virtual ActionList* getFailedActionSet() const { return failedActionSet_; }
 
   /** @brief Get the set of [actions](@ref Action) in *done* state */
-  virtual ActionList* getDoneActionSet() {return doneActionSet_;}
+  virtual ActionList* getDoneActionSet() const { return doneActionSet_; }
 
   /** @brief Get the set of modified [actions](@ref Action) */
-  virtual ActionLmmListPtr getModifiedSet() {return modifiedSet_;}
+  virtual ActionLmmListPtr getModifiedSet() const { return modifiedSet_; }
 
   /** @brief Get the maxmin system of the current Model */
-  lmm_system_t getMaxminSystem() {return maxminSystem_;}
+  lmm_system_t getMaxminSystem() const { return maxminSystem_; }
 
   /**
    * @brief Get the update mechanism of the current Model
    * @see e_UM_t
    */
-  e_UM_t getUpdateMechanism() {return updateMechanism_;}
+  e_UM_t getUpdateMechanism() const { return updateMechanism_; }
+  void setUpdateMechanism(e_UM_t mechanism) { updateMechanism_ = mechanism; }
 
   /** @brief Get Action heap */
-  xbt_heap_t getActionHeap() {return actionHeap_;}
+  heap_type& getActionHeap() { return actionHeap_; }
+
+  double actionHeapTopDate() const { return actionHeap_.top().first; }
+  Action* actionHeapPop();
+  bool actionHeapIsEmpty() const { return actionHeap_.empty(); }
 
   /**
    * @brief Share the resources between the actions
@@ -315,11 +333,9 @@ public:
    * @param now The current time of the simulation
    * @return The delta of time till the next action will finish
    */
-  virtual double next_occuring_event(double now);
-  virtual double next_occuring_event_lazy(double now);
-  virtual double next_occuring_event_full(double now);
-  double shareResourcesMaxMin(ActionList* running_actions,
-      lmm_system_t sys, void (*solve) (lmm_system_t));
+  virtual double nextOccuringEvent(double now);
+  virtual double nextOccuringEventLazy(double now);
+  virtual double nextOccuringEventFull(double now);
 
   /**
    * @brief Update action to the current time
@@ -336,20 +352,20 @@ public:
    * The only model that is not is NS3: computing the next timestamp moves the model up to that point,
    * so we need to call it only when the next timestamp of other sources is computed.
    */
-  virtual bool next_occuring_event_isIdempotent()=0;
+  virtual bool nextOccuringEventIsIdempotent() { return true;}
 
 protected:
   ActionLmmListPtr modifiedSet_;
   lmm_system_t maxminSystem_ = nullptr;
-  e_UM_t updateMechanism_ = UM_UNDEFINED;
-  int selectiveUpdate_;
-  xbt_heap_t actionHeap_;
+  bool selectiveUpdate_;
 
 private:
+  e_UM_t updateMechanism_ = UM_UNDEFINED;
   ActionList* readyActionSet_; /**< Actions in state SURF_ACTION_READY */
   ActionList* runningActionSet_; /**< Actions in state SURF_ACTION_RUNNING */
   ActionList* failedActionSet_; /**< Actions in state SURF_ACTION_FAILED */
   ActionList* doneActionSet_; /**< Actions in state SURF_ACTION_DONE */
+  heap_type actionHeap_;
 };
 
 }
@@ -359,95 +375,5 @@ private:
  * Resource *
  ************/
 
-/** @ingroup SURF_interface
- * @brief Resource which have a metric handled by a maxmin system
- */
-typedef struct {
-  double peak;              /**< The peak of the metric, ie its max value */
-  double scale;             /**< Current availability of the metric according to the traces, in [0,1] */
-  tmgr_trace_iterator_t event; /**< The associated trace event associated to the metric */
-} s_surf_metric_t;
-
-namespace simgrid {
-namespace surf {
-
-/** @ingroup SURF_interface
- * @brief SURF resource interface class
- * @details This is the ancestor class of every resources in SimGrid, such as links, CPU or storage
- */
-XBT_PUBLIC_CLASS Resource {
-public:
-  /**
-   * @brief Constructor of non-LMM Resources
-   *
-   * @param model Model associated to this Resource
-   * @param name The name of the Resource
-   */
-  Resource(Model *model, const char *name);
-
-  /**
-   * @brief Constructor of LMM Resources
-   *
-   * @param model Model associated to this Resource
-   * @param name The name of the Resource
-   * @param constraint The lmm constraint associated to this Resource if it is part of a LMM component
-   */
-  Resource(Model *model, const char *name, lmm_constraint_t constraint);
-
-  virtual ~Resource();
-
-  /** @brief Get the Model of the current Resource */
-  Model *getModel() const;
-
-  /** @brief Get the name of the current Resource */
-  const char *getName() const;
-
-  bool operator==(const Resource &other) const;
-
-  /**
-   * @brief Apply an event of external load event to that resource
-   *
-   * @param event What happened
-   * @param value [TODO]
-   */
-  virtual void apply_event(tmgr_trace_iterator_t event, double value)=0;
-
-  /** @brief Check if the current Resource is used (if it currently serves an action) */
-  virtual bool isUsed()=0;
-
-  /** @brief Check if the current Resource is active */
-  virtual bool isOn() const;
-  /** @brief Check if the current Resource is shut down */
-  virtual bool isOff() const;
-  /** @brief Turn on the current Resource */
-  virtual void turnOn();
-  /** @brief Turn off the current Resource */
-  virtual void turnOff();
-
-private:
-  const char *name_;
-  Model *model_;
-  bool isOn_ = true;
-
-public: /* LMM */
-  /** @brief Get the lmm constraint associated to this Resource if it is part of a LMM component (or null if none) */
-  lmm_constraint_t getConstraint() const;
-protected:
-  lmm_constraint_t constraint_ = nullptr;
-};
-
-}
-}
-
-namespace std {
-  template <>
-  struct hash<simgrid::surf::Resource>
-  {
-    std::size_t operator()(const simgrid::surf::Resource& r) const
-    {
-      return (std::size_t) xbt_str_hash(r.getName());
-    }
-  };
-}
 
 #endif /* SURF_MODEL_H_ */