Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Make field private.
[simgrid.git] / src / surf / surf_interface.hpp
index b0d4d98..85d23ef 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,16 @@
 #ifndef SURF_MODEL_H_
 #define SURF_MODEL_H_
 
-#include <cstddef>
+#include "xbt/signal.hpp"
 
-#include <xbt.h>
-#include <memory>
-#include <utility>
+#include "src/surf/surf_private.hpp"
+#include "surf/surf.h"
+#include "xbt/str.h"
 
 #include <boost/intrusive/list.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 <set>
+#include <string>
+#include <unordered_map>
 
 #define NO_MAX_DURATION -1.0
 
 
 /* user-visible parameters */
 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 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 "C" {
-XBT_PUBLIC(double) surf_get_clock(void);
+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;
 
-
-extern XBT_PRIVATE double sg_sender_gap;
-
 namespace simgrid {
 namespace surf {
 
-extern XBT_PRIVATE simgrid::xbt::signal<void(void)> surfExitCallbacks;
-
+extern XBT_PRIVATE simgrid::xbt::signal<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 *
  ***********/
@@ -73,12 +61,6 @@ enum heap_action_type{
   NOTSET
 };
 
-/*********
- * 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;
-
 /**********
  * Action *
  **********/
@@ -114,14 +96,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 = nullptr);
-
-public:
   /**
    * @brief Action constructor
    *
@@ -144,8 +118,12 @@ public:
   /** @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*/
@@ -220,20 +198,20 @@ public:
   void setCategory(const char *category);
 
   /** @brief Get the priority of the current Action */
-  double getPriority() {return priority_;};
+  double getPriority() { return sharingWeight_; };
   /** @brief Set the priority of the current Action */
-  virtual void setPriority(double priority);
+  virtual void setSharingWeight(double priority);
 
   /** @brief Get the state set in which the action is */
   ActionList* getStateSet() {return stateSet_;};
 
   s_xbt_swag_hookup_t stateHookup_ = {nullptr,nullptr};
 
-  simgrid::surf::Model *getModel() {return model_;}
+  simgrid::surf::Model* getModel() { return model_; }
 
 protected:
   ActionList* stateSet_;
-  double priority_ = 1.0; /**< priority (1.0 by default) */
+  double sharingWeight_ = 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) */
@@ -249,17 +227,16 @@ private:
 
   /* LMM */
 public:
-  virtual void updateRemainingLazy(double now);
+  virtual void updateRemainingLazy(double now) { THROW_IMPOSSIBLE; };
   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);
+  virtual void updateIndexHeap(int i);
   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 variable_ = nullptr;
@@ -267,6 +244,8 @@ protected:
   double lastUpdate_ = 0;
   int suspended_ = 0;
   int indexHeap_;
+
+private:
   enum heap_action_type hat_ = NOTSET;
 };
 
@@ -323,11 +302,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
@@ -344,13 +321,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:
@@ -370,11 +347,11 @@ private:
 /** @ingroup SURF_interface
  * @brief Resource which have a metric handled by a maxmin system
  */
-typedef struct {
+struct s_surf_metric_t {
   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;
+  tmgr_trace_event_t event; /**< The associated trace event associated to the metric */
+};
 
 namespace simgrid {
 namespace surf {
@@ -385,14 +362,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
    *
@@ -400,15 +369,17 @@ public:
    * @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);
+  Resource(Model * model, const std::string& name, lmm_constraint_t constraint);
 
   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 std::string& getName() const;
+  /** @brief Get the name of the current Resource */
+  const char* getCname() const;
 
   bool operator==(const Resource &other) const;
 
@@ -418,7 +389,7 @@ public:
    * @param event What happened
    * @param value [TODO]
    */
-  virtual void apply_event(tmgr_trace_iterator_t event, double value)=0;
+  virtual void apply_event(tmgr_trace_event_t event, double value) = 0;
 
   /** @brief Check if the current Resource is used (if it currently serves an action) */
   virtual bool isUsed()=0;
@@ -433,29 +404,26 @@ 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;
 };
 
 }
 }
 
 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());
-    }
-  };
+template <> class hash<simgrid::surf::Resource> {
+public:
+  std::size_t operator()(const simgrid::surf::Resource& r) const { return (std::size_t)xbt_str_hash(r.getCname()); }
+};
 }
 
 #endif /* SURF_MODEL_H_ */