Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
uniformization
[simgrid.git] / src / surf / surf_interface.hpp
index 66ed71d..25bc6fc 100644 (file)
@@ -6,22 +6,15 @@
 #ifndef SURF_MODEL_H_
 #define SURF_MODEL_H_
 
-#include <xbt.h>
-#include <string>
-#include <vector>
-#include <memory>
-#include <utility>
-
-#include <boost/function.hpp>
-#include <boost/intrusive/list.hpp>
-
-#include <xbt/signal.hpp>
+#include "xbt/signal.hpp"
 
-#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 "surf/surf.h"
+#include "surf/surf_routing.h"
+#include "xbt/str.h"
+
+#include <boost/intrusive/list.hpp>
+#include <string>
 
 #define NO_MAX_DURATION -1.0
 
@@ -36,11 +29,16 @@ 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 XBT_PRIVATE std::vector<std::string> surf_path;
 
 extern "C" {
 XBT_PUBLIC(double) surf_get_clock(void);
 }
+/** \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;
+
 
 extern XBT_PRIVATE double sg_sender_gap;
 
@@ -54,10 +52,6 @@ extern XBT_PRIVATE simgrid::xbt::signal<void(void)> surfExitCallbacks;
 
 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;
-}
-
 /***********
  * Classes *
  ***********/
@@ -81,7 +75,10 @@ XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
 
 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 {
@@ -107,14 +104,6 @@ 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);
-
-public:
   /**
    * @brief Action constructor
    *
@@ -140,9 +129,9 @@ public:
   /** @brief Mark that the action is now finished */
   void finish();
 
-  /** @brief Get the [state](\ref e_surf_action_state_t) of the current Action */
+  /** @brief Get the [state](\ref simgrid::surf::Action::State) of the current Action */
   Action::State getState(); /**< get the state*/
-  /** @brief Set the [state](\ref e_surf_action_state_t) of the current Action */
+  /** @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 */
@@ -156,32 +145,32 @@ public:
   double getFinishTime();
 
   /** @brief Get the user data associated to the current action */
-  void *getData() {return p_data;}
+  void *getData() {return data_;}
   /** @brief Set the user data associated to the current action */
   void setData(void* data);
 
   /** @brief Get the cost of the current action */
-  double getCost() {return m_cost;}
+  double getCost() {return cost_;}
   /** @brief Set the cost of the current action */
-  void setCost(double cost) {m_cost = cost;}
+  void setCost(double cost) {cost_ = cost;}
 
   /** @brief Update the maximum duration of the current action
    *  @param delta Amount to remove from the MaxDuration */
-  void updateMaxDuration(double delta) {double_update(&m_maxDuration, delta,sg_surf_precision);}
+  void updateMaxDuration(double delta) {double_update(&maxDuration_, delta,sg_surf_precision);}
 
   /** @brief Update the remaining time of the current action
    *  @param delta Amount to remove from the remaining time */
-  void updateRemains(double delta) {double_update(&m_remains, delta, sg_maxmin_precision*sg_surf_precision);}
+  void updateRemains(double delta) {double_update(&remains_, delta, sg_maxmin_precision*sg_surf_precision);}
 
   /** @brief Set the remaining time of the current action */
-  void setRemains(double value) {m_remains = value;}
+  void setRemains(double value) {remains_ = value;}
   /** @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();
 
   /** @brief Set the finish time of the current action */
-  void setFinishTime(double value) {m_finish = value;}
+  void setFinishTime(double value) {finishTime_ = value;}
 
   /**@brief Add a reference to the current action (refcounting) */
   void ref();
@@ -203,42 +192,42 @@ public:
   virtual bool isSuspended();
 
   /** @brief Get the maximum duration of the current action */
-  double getMaxDuration() {return m_maxDuration;}
+  double getMaxDuration() {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 p_category;}
+  char *getCategory() {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 m_priority;};
+  double getPriority() {return priority_;};
   /** @brief Set the priority of the current Action */
   virtual void setPriority(double priority);
 
   /** @brief Get the state set in which the action is */
-  ActionList* getStateSet() {return p_stateSet;};
+  ActionList* getStateSet() {return stateSet_;};
 
-  s_xbt_swag_hookup_t p_stateHookup = {NULL,NULL};
+  s_xbt_swag_hookup_t stateHookup_ = {nullptr,nullptr};
 
-  simgrid::surf::Model *getModel() {return p_model;}
+  simgrid::surf::Model* getModel() { return model_; }
 
 protected:
-  ActionList* p_stateSet;
-  double m_priority = 1.0; /**< priority (1.0 by default) */
-  int    m_refcount = 1;
-  double m_remains; /**< How much of that cost remains to be done in the currently running task */
-  double m_maxDuration = NO_MAX_DURATION; /*< max_duration (may fluctuate until the task is completed) */
-  double m_finish = -1; /**< finish time : this is modified during the run and fluctuates until the task is completed */
+  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 m_start; /**< start time  */
-  char *p_category = NULL;            /**< tracing category for categorized resource utilization monitoring */
+  double start_; /**< start time  */
+  char *category_ = nullptr;            /**< tracing category for categorized resource utilization monitoring */
 
-  double    m_cost;
-  simgrid::surf::Model *p_model;
-  void *p_data = NULL; /**< for your convenience */
+  double    cost_;
+  simgrid::surf::Model *model_;
+  void *data_ = nullptr; /**< for your convenience */
 
   /* LMM */
 public:
@@ -247,20 +236,20 @@ public:
   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 p_variable;}
-  double getLastUpdate() {return m_lastUpdate;}
-  void refreshLastUpdate() {m_lastUpdate = surf_get_clock();}
-  enum heap_action_type getHat() {return m_hat;}
+  lmm_variable_t getVariable() {return variable_;}
+  double getLastUpdate() {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();
 
 protected:
-  lmm_variable_t p_variable;
-  double m_lastValue = 0;
-  double m_lastUpdate = 0;
-  int m_suspended = 0;
-  int m_indexHeap;
-  enum heap_action_type m_hat = NOTSET;
+  lmm_variable_t variable_ = nullptr;
+  double lastValue_ = 0;
+  double lastUpdate_ = 0;
+  int suspended_ = 0;
+  int indexHeap_;
+  enum heap_action_type hat_ = NOTSET;
 };
 
 typedef Action::ActionList ActionList;
@@ -316,11 +305,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
@@ -337,13 +324,13 @@ 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_;
+  bool selectiveUpdate_;
   xbt_heap_t actionHeap_;
 
 private:
@@ -378,14 +365,6 @@ namespace surf {
  */
 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
    *
@@ -398,15 +377,15 @@ public:
   virtual ~Resource();
 
   /** @brief Get the Model of the current Resource */
-  Model *getModel() const;
+  Model* model() const;
 
   /** @brief Get the name of the current Resource */
-  const char *getName() const;
+  const char* cname() const;
 
   bool operator==(const Resource &other) const;
 
   /**
-   * @brief Apply an event of external load event to that storage
+   * @brief Apply an event of external load event to that resource
    *
    * @param event What happened
    * @param value [TODO]
@@ -426,15 +405,16 @@ public:
   virtual void turnOff();
 
 private:
-  const char *name_;
+  std::string 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;
+  lmm_constraint_t constraint() const;
+
 protected:
-  lmm_constraint_t constraint_ = nullptr;
+  const lmm_constraint_t constraint_ = nullptr;
 };
 
 }
@@ -446,7 +426,7 @@ namespace std {
   {
     std::size_t operator()(const simgrid::surf::Resource& r) const
     {
-      return (std::size_t) xbt_str_hash(r.getName());
+      return (std::size_t) xbt_str_hash(r.cname());
     }
   };
 }