Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
cosmetics around surf::Resouce::apply_event()
[simgrid.git] / src / surf / surf_interface.hpp
index 01623b2..de6cfa5 100644 (file)
@@ -1,5 +1,4 @@
-/* Copyright (c) 2004-2015. The SimGrid Team.
- * All rights reserved.                                                     */
+/* Copyright (c) 2004-2016. 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. */
@@ -15,7 +14,9 @@
 
 #include <boost/function.hpp>
 #include <boost/intrusive/list.hpp>
-#include "surf/trace_mgr.h"
+
+#include <xbt/signal.hpp>
+
 #include "xbt/lib.h"
 #include "surf/surf_routing.h"
 #include "simgrid/platf_interface.h"
 #include "src/surf/surf_private.h"
 #include "src/internal_config.h"
 
-#ifdef LIBSIGC
-#include <sigc++/sigc++.h>
-namespace simgrid {
-namespace surf {
-  // Wraps sigc++ signals with the interface of boost::signals2:
-  template<class T> class signal;
-  template<class R, class... P>
-  class signal<R(P...)> {
-  private:
-    sigc::signal<R, P...> sig_;
-  public:
-    template<class T> XBT_ALWAYS_INLINE
-    void connect(T&& slot)
-    {
-      sig_.connect(std::forward<T>(slot));
-    }
-    template<class Res, class... Args> XBT_ALWAYS_INLINE
-    void connect(Res(*slot)(Args...))
-    {
-      sig_.connect(sigc::ptr_fun(slot));
-    }
-    template<class... Args>
-    R operator()(Args&&... args) const
-    {
-      return sig_.emit(std::forward<Args>(args)...);
-    }
-  };
-}
-}
-#else
-#include <boost/signals2.hpp>
-namespace simgrid {
-namespace surf {
-  template<class T>
-  using signal = ::boost::signals2::signal<T>;
-}
-}
-#endif
-
-// Deprecated:
-#define surf_callback(arg1, ...)  ::simgrid::surf::signal<arg1(__VA_ARGS__)>
-#define surf_callback_connect(callback, fun_ptr) callback.connect(fun_ptr)
-#define surf_callback_emit(callback, ...) callback(__VA_ARGS__)
-
-#ifdef _MSC_VER
-#pragma warning( disable : 4251)
-// 4251: needs to have dll-interface to be used by clients of class
-#endif
-
-extern XBT_PRIVATE tmgr_history_t history;
 #define NO_MAX_DURATION -1.0
 
-using namespace std;
-
 /*********
  * Utils *
  *********/
@@ -96,7 +45,13 @@ XBT_PUBLIC(double) surf_get_clock(void);
 
 extern XBT_PRIVATE double sg_sender_gap;
 
-extern XBT_PRIVATE surf_callback(void, void) surfExitCallbacks;
+namespace simgrid {
+namespace surf {
+
+extern XBT_PRIVATE simgrid::xbt::signal<void(void)> surfExitCallbacks;
+
+}
+}
 
 int XBT_PRIVATE __surf_is_absolute_file_path(const char *file_path);
 
@@ -116,17 +71,18 @@ enum heap_action_type{
  *********/
 /* 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;
-XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_host_avail;
-XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_power;
-XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_link_avail;
-XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_bandwidth;
-XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency;
 
 /**********
  * Action *
  **********/
+
 XBT_PRIVATE void surf_action_lmm_update_index_heap(void *action, int i);
 
+XBT_PUBLIC_DATA(xbt_dynar_t) all_existing_models;
+
+namespace simgrid {
+namespace surf {
+
 /** @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)
@@ -142,7 +98,7 @@ private:
   /**
    * @brief Common initializations for the constructors
    */
-  void initialize(Model *model, double cost, bool failed,
+  void initialize(simgrid::surf::Model *model, double cost, bool failed,
                   lmm_variable_t var = NULL);
 
 public:
@@ -153,7 +109,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(Model *model, double cost, bool failed);
+  Action(simgrid::surf::Model *model, double cost, bool failed);
 
   /**
    * @brief Action constructor
@@ -163,7 +119,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(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();
@@ -251,28 +207,28 @@ public:
   /** @brief Get the state set in which the action is */
   ActionList* getStateSet() {return p_stateSet;};
 
-  s_xbt_swag_hookup_t p_stateHookup;
+  s_xbt_swag_hookup_t p_stateHookup = {NULL,NULL};
 
-  Model *getModel() {return p_model;}
+  simgrid::surf::Model *getModel() {return p_model;}
 
 protected:
   ActionList* p_stateSet;
-  double m_priority; /**< priority (1.0 by default) */
-  int    m_refcount;
+  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; /*< max_duration (may fluctuate until the task is completed) */
-  double m_finish; /**< finish time : this is modified during the run and fluctuates until the task is completed */
+  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 */
 
 private:
   double m_start; /**< start time  */
-  char *p_category;               /**< tracing category for categorized resource utilization monitoring */
+  char *p_category = NULL;            /**< tracing category for categorized resource utilization monitoring */
 
   #ifdef HAVE_LATENCY_BOUND_TRACKING
   int m_latencyLimited;               /**< Set to 1 if is limited by latency, 0 otherwise */
   #endif
   double    m_cost;
-  Model *p_model;
-  void *p_data; /**< for your convenience */
+  simgrid::surf::Model *p_model;
+  void *p_data = NULL; /**< for your convenience */
 
   /* LMM */
 public:
@@ -290,11 +246,11 @@ public:
 
 protected:
   lmm_variable_t p_variable;
-  double m_lastValue;
-  double m_lastUpdate;
-  int m_suspended;
+  double m_lastValue = 0;
+  double m_lastUpdate = 0;
+  int m_suspended = 0;
   int m_indexHeap;
-  enum heap_action_type m_hat;
+  enum heap_action_type m_hat = NOTSET;
 };
 
 typedef Action::ActionList ActionList;
@@ -307,7 +263,6 @@ typedef ActionLmmList* ActionLmmListPtr;
 /*********
  * Model *
  *********/
-XBT_PUBLIC_DATA(xbt_dynar_t) all_existing_models;
 
 /** @ingroup SURF_interface
  * @brief SURF model interface class
@@ -318,8 +273,6 @@ public:
   Model();
   virtual ~Model();
 
-  virtual void addTraces() =0;
-
   /** @brief Get the set of [actions](@ref Action) in *ready* state */
   virtual ActionList* getReadyActionSet() {return p_readyActionSet;}
 
@@ -353,12 +306,11 @@ public:
    * @param now The current time of the simulation
    * @return The delta of time till the next action will finish
    */
-  virtual double shareResources(double now);
-  virtual double shareResourcesLazy(double now);
-  virtual double shareResourcesFull(double now);
+  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));
+      lmm_system_t sys, void (*solve) (lmm_system_t));
 
   /**
    * @brief Update action to the current time
@@ -375,11 +327,11 @@ 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 shareResourcesIsIdempotent()=0;
+  virtual bool next_occuring_event_isIdempotent()=0;
 
 protected:
   ActionLmmListPtr p_modifiedSet;
-  lmm_system_t p_maxminSystem;
+  lmm_system_t p_maxminSystem = nullptr;
   e_UM_t p_updateMechanism = UM_UNDEFINED;
   int m_selectiveUpdate;
   xbt_heap_t p_actionHeap;
@@ -391,6 +343,9 @@ private:
   ActionList* p_doneActionSet; /**< Actions in state SURF_ACTION_DONE */
 };
 
+}
+}
+
 /************
  * Resource *
  ************/
@@ -399,49 +354,47 @@ private:
  * @brief Resource which have a metric handled by a maxmin system
  */
 typedef struct {
-  double scale;             /**< The scale of the metric */
-  double peak;              /**< The peak of the metric */
-  tmgr_trace_event_t event; /**< The associated trace event associated to the metric */
+  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 A resource represent an element of a component (e.g.: a link for the network)
  */
 XBT_PUBLIC_CLASS Resource {
 public:
-  Resource();
-
   /**
    * @brief Constructor of non-LMM Resources
    *
    * @param model Model associated to this Resource
    * @param name The name of the Resource
-   * @param props Dictionary of properties associated to this Resource
    */
-  Resource(Model *model, const char *name, xbt_dict_t props);
+  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 props Dictionary of properties associated to this Resource
    * @param constraint The lmm constraint associated to this Resource if it is part of a LMM component
    */
-  Resource(Model *model, const char *name, xbt_dict_t props, lmm_constraint_t constraint);
+  Resource(Model *model, const char *name, lmm_constraint_t constraint);
 
-  Resource(Model *model, const char *name, xbt_dict_t props, lmm_constraint_t constraint, e_surf_resource_state_t stateInit);
+  Resource(Model *model, const char *name, lmm_constraint_t constraint, int initiallyOn);
 
   /**
    * @brief Resource constructor
    *
    * @param model Model associated to this Resource
    * @param name The name of the Resource
-   * @param props Dictionary of properties associated to this Resource
-   * @param stateInit the initial state of the Resource
+   * @param initiallyOn the initial state of the Resource
    */
-  Resource(Model *model, const char *name, xbt_dict_t props, e_surf_resource_state_t stateInit);
+  Resource(Model *model, const char *name, int initiallyOn);
 
   virtual ~Resource();
 
@@ -451,47 +404,39 @@ public:
   /** @brief Get the name of the current Resource */
   const char *getName();
 
-  /** @brief Get the properties of the current Resource */
-  virtual xbt_dict_t getProperties();
-
   /**
-   * @brief Update the state of the current Resource
-   * @details [TODO]
+   * @brief Apply an event of external load event to that storage
    *
-   * @param event_type [TODO]
+   * @param event What happened
    * @param value [TODO]
-   * @param date [TODO]
    */
-  virtual void updateState(tmgr_trace_event_t event_type, double value, double date)=0;
+  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 */
-  bool isOn();
+  virtual bool isOn();
+  /** @brief Check if the current Resource is shut down */
+  virtual bool isOff();
   /** @brief Turn on the current Resource */
-  void turnOn();
+  virtual void turnOn();
   /** @brief Turn off the current Resource */
-  void turnOff();
-
-  /** @brief Get the [state](\ref e_surf_resource_state_t) of the current Resource */
-  virtual e_surf_resource_state_t getState();
-  /** @brief Set the [state](\ref e_surf_resource_state_t) of the current Resource */
-  virtual void setState(e_surf_resource_state_t state);
+  virtual void turnOff();
 
 private:
   const char *p_name;
-  xbt_dict_t p_properties;
   Model *p_model;
-  bool m_running;
-  e_surf_resource_state_t m_stateCurrent;
-
+  bool m_isOn;
 
 public: /* LMM */
   /** @brief Get the lmm constraint associated to this Resource if it is part of a LMM component */
   lmm_constraint_t getConstraint();
-private:
-  lmm_constraint_t p_constraint;
+protected:
+  lmm_constraint_t p_constraint = nullptr;
 };
 
+}
+}
+
 #endif /* SURF_MODEL_H_ */