Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Replace xbt_heap by boost::heap::fibonacci_heap
[simgrid.git] / src / surf / surf_interface.hpp
index ffceddc..513a293 100644 (file)
 #include <xbt.h>
 #include <string>
 #include <vector>
-#include <iostream>
 #include <memory>
 #include <boost/function.hpp>
 #include <boost/intrusive/list.hpp>
+#include <boost/heap/fibonacci_heap.hpp>
+#include <boost/smart_ptr.hpp>
 #include "surf/trace_mgr.h"
 #include "xbt/lib.h"
 #include "surf/surf_routing.h"
@@ -63,6 +64,8 @@ XBT_PUBLIC(double) surf_get_clock(void);
 extern double sg_sender_gap;
 XBT_PUBLIC(int)  SURF_CPU_LEVEL;    //Surf cpu level
 
+extern surf_callback(void, void) surfExitCallbacks;
+
 int __surf_is_absolute_file_path(const char *file_path);
 
 /***********
@@ -73,7 +76,7 @@ typedef Model* ModelPtr;
 
 //class Resource;
 typedef Resource* ResourcePtr;
-                       
+
 //class Action;
 typedef Action* ActionPtr;
 
@@ -87,6 +90,56 @@ typedef ActionLmmList* ActionLmmListPtr;
 typedef boost::intrusive::list_base_hook<boost::intrusive::tag<lmmTag> > actionLmmHook;
 
 
+template <typename K, typename V>
+class Heap {
+  class HeapItem;
+  struct compare_PI : binary_function <boost::shared_ptr<HeapItem>, boost::shared_ptr<HeapItem>, bool> {
+    bool operator() (boost::shared_ptr<HeapItem> x, boost::shared_ptr<HeapItem> y) const {
+      return (x->p_key==y->p_key) ? x->m_i<y->m_i : x->p_key>y->p_key;}
+  };
+public:
+  typedef typename boost::heap::fibonacci_heap<boost::shared_ptr<HeapItem>, boost::heap::compare<compare_PI > >::handle_type HeapHandle;
+  typedef boost::shared_ptr<HeapHandle> HeapHandleSPtr;
+private:
+  class HeapItem {
+  public:
+    HeapItem(K key, V value, int i)
+     : p_key(key), p_value(value), m_i(i) {
+    }
+    K p_key;
+    V p_value;
+    int m_i;
+    HeapHandleSPtr sp_handle;
+  };
+  boost::heap::fibonacci_heap<boost::shared_ptr<HeapItem>, boost::heap::compare<compare_PI > > m_heap;
+public:
+  int m_i;
+  Heap() : m_i(0) {}
+  HeapHandleSPtr push(K key, V value) {
+    boost::shared_ptr<HeapItem> hi(new HeapItem(key, value, m_i++));
+    hi->sp_handle = boost::shared_ptr<HeapHandle>(new HeapHandle(m_heap.push(hi)));
+    return hi->sp_handle;
+  }
+  void pop() {
+    HeapHandleSPtr hl = m_heap.top()->sp_handle;
+    m_heap.pop();
+    hl->node_ = NULL;
+  }
+  void erase(HeapHandleSPtr handle) {
+    if (used(handle)) {
+      m_heap.erase(*handle);
+      handle->node_ = NULL;
+    }
+  }
+  K topKey() {return m_heap.top()->p_key;}
+  V topValue() {return m_heap.top()->p_value;}
+  int size() {return m_heap.size();}
+  bool empty() {return m_heap.empty();}
+  bool used(HeapHandleSPtr handle) {return handle && handle->node_!=NULL;}
+};
+
+typedef Heap<double, ActionPtr> ActionHeap;
+
 enum heap_action_type{
   LATENCY = 100,
   MAX_DURATION,
@@ -101,8 +154,8 @@ enum heap_action_type{
 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_link_avail;
+XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_bandwidth;
 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency;
 
 /*********
@@ -114,58 +167,60 @@ XBT_PUBLIC_DATA(xbt_dynar_t) model_list;
  * @brief SURF model interface class
  * @details A model is an object which handle the interactions between its Resources and its Actions
  */
-class Model {
+XBT_PUBLIC_CLASS Model {
 public:
-  /** 
+  /**
    * @brief Model constructor
-   * 
+   *
    * @param name the name of the model
    */
   Model(const char *name);
 
-  /** 
+  /**
    * @brief Model destructor
    */
   virtual ~Model();
 
+  virtual void addTraces() =0;
+
   /**
    * @brief Get the name of the current Model
-   * 
+   *
    * @return The name of the current Model
    */
   const char *getName() {return p_name;}
 
   /**
-   * @brief Get the set of [actions](@ref Action) in *ready* state 
-   * 
-   * @return The set of [actions](@ref Action) in *ready* state 
+   * @brief Get the set of [actions](@ref Action) in *ready* state
+   *
+   * @return The set of [actions](@ref Action) in *ready* state
    */
   virtual ActionListPtr getReadyActionSet() {return p_readyActionSet;}
 
   /**
    * @brief Get the set of [actions](@ref Action) in *running* state
-   * 
+   *
    * @return The set of [actions](@ref Action) in *running* state
    */
   virtual ActionListPtr getRunningActionSet() {return p_runningActionSet;}
 
   /**
    * @brief Get the set of [actions](@ref Action) in *failed* state
-   * 
+   *
    * @return The set of [actions](@ref Action) in *failed* state
    */
   virtual ActionListPtr getFailedActionSet() {return p_failedActionSet;}
 
   /**
    * @brief Get the set of [actions](@ref Action) in *done* state
-   * 
+   *
    * @return The set of [actions](@ref Action) in *done* state
    */
   virtual ActionListPtr getDoneActionSet() {return p_doneActionSet;}
 
   /**
    * @brief Get the set of modified [actions](@ref Action)
-   * 
+   *
    * @return The set of modified [actions](@ref Action)
    */
   virtual ActionLmmListPtr getModifiedSet() {return p_modifiedSet;}
@@ -180,7 +235,7 @@ public:
   /**
    * @brief Get the update mechanism of the current Model
    * @see e_UM_t
-   * 
+   *
    * @return [description]
    */
   e_UM_t getUpdateMechanism() {return p_updateMechanism;}
@@ -188,17 +243,17 @@ public:
   /**
    * @brief Get Action heap
    * @details [TODO]
-   * 
+   *
    * @return The Action heap
    */
-  xbt_heap_t getActionHeap() {return p_actionHeap;}
+  ActionHeap *getActionHeap() {return p_actionHeap;}
 
-  /** 
+  /**
    * @brief share the resources
-   * @details Share the resources between the actions 
-   * 
-   * @param 
-   * @return the date of the next action will finish
+   * @details Share the resources between the actions
+   *
+   * @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);
@@ -209,10 +264,10 @@ public:
 
   /**
    * @brief Update state of actions
-   * @details [TODO]
-   * 
-   * @param now [TODO]
-   * @param delta [TODO]
+   * @details Update action to the current time
+   *
+   * @param now The current time of the simulation
+   * @param delta The delta of time since the last update
    */
   virtual void updateActionsState(double now, double delta);
   virtual void updateActionsStateLazy(double now, double delta);
@@ -223,7 +278,7 @@ protected:
   lmm_system_t p_maxminSystem;
   e_UM_t p_updateMechanism;
   int m_selectiveUpdate;
-  xbt_heap_t p_actionHeap;
+  ActionHeap *p_actionHeap;
 
 private:
   const char *p_name;
@@ -251,25 +306,25 @@ typedef struct {
  * @brief SURF resource interface class
  * @details A resource represent an element of a component (e.g.: a link for the network)
  */
-class Resource {
+XBT_PUBLIC_CLASS Resource {
 public:
-  /** 
+  /**
    * @brief Resource constructor
    */
   Resource();
 
-  /** 
+  /**
    * @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
    */
   Resource(ModelPtr model, const char *name, xbt_dict_t props);
 
-  /** 
+  /**
    * @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
@@ -277,9 +332,9 @@ public:
    */
   Resource(ModelPtr model, const char *name, xbt_dict_t props, lmm_constraint_t constraint);
 
-  /** 
+  /**
    * @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
@@ -290,25 +345,25 @@ public:
   /**
    * @brief Resource destructor
    */
-  virtual ~Resource(); 
+  virtual ~Resource();
 
   /**
    * @brief Get the Model of the current Resource
-   * 
+   *
    * @return The Model of the current Resource
    */
   ModelPtr getModel();
 
   /**
    * @brief Get the name of the current Resource
-   * 
+   *
    * @return The name of the current Resource
    */
   const char *getName();
 
   /**
    * @brief Get the properties of the current Resource
-   * 
+   *
    * @return The properties of the current Resource
    */
   virtual xbt_dict_t getProperties();
@@ -316,7 +371,7 @@ public:
   /**
    * @brief Update the state of the current Resource
    * @details [TODO]
-   * 
+   *
    * @param event_type [TODO]
    * @param value [TODO]
    * @param date [TODO]
@@ -355,7 +410,7 @@ public:
 
   /**
    * @brief Set the [state](\ref e_surf_resource_state_t) of the current Resource
-   * 
+   *
    * @param state The new state of the current Resource
    */
   virtual void setState(e_surf_resource_state_t state);
@@ -364,7 +419,6 @@ private:
   const char *p_name;
   xbt_dict_t p_properties;
   ModelPtr p_model;
-  void *p_resource;
   bool m_running;
   e_surf_resource_state_t m_stateCurrent;
 
@@ -372,7 +426,7 @@ private:
 public:
   /**
    * @brief Get the lmm constraint associated to this Resource if it is part of a LMM component
-   * 
+   *
    * @return The lmm constraint associated to this Resource
    */
   lmm_constraint_t getConstraint();
@@ -383,22 +437,23 @@ private:
 /**********
  * Action *
  **********/
-void surf_action_lmm_update_index_heap(void *action, int i);
 
 /** @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)
  */
-class Action : public actionHook, public actionLmmHook {
-public:
+XBT_PUBLIC_CLASS Action : public actionHook, public actionLmmHook {
+private:
   /**
-   * @brief Action constructor
+   * @brief Common initializations for the constructors
    */
-  Action();
+  void initialize(ModelPtr model, double cost, bool failed,
+                  lmm_variable_t var = NULL);
 
+public:
   /**
    * @brief Action constructor
-   * 
+   *
    * @param model The Model associated to this Action
    * @param cost The cost of the Action
    * @param failed If the action is impossible (e.g.: execute something on a switched off workstation)
@@ -407,7 +462,7 @@ public:
 
   /**
    * @brief Action constructor
-   * 
+   *
    * @param model The Model associated to this Action
    * @param cost The cost of the Action
    * @param failed If the action is impossible (e.g.: execute something on a switched off workstation)
@@ -419,7 +474,7 @@ public:
    * @brief Action destructor
    */
   virtual ~Action();
-  
+
   /**
    * @brief Finish the action
    */
@@ -427,105 +482,112 @@ public:
 
   /**
    * @brief Get the [state](\ref e_surf_action_state_t) of the current Action
-   * 
+   *
    * @return The state of the current Action
    */
   e_surf_action_state_t getState(); /**< get the state*/
 
   /**
    * @brief Set the [state](\ref e_surf_action_state_t) of the current Action
-   * 
+   *
    * @param state The new state of the current Action
    */
   virtual void setState(e_surf_action_state_t state);
 
   /**
    * @brief Get the bound of the current Action
-   * 
+   *
    * @return The bound of the current Action
    */
-  double getBound() {return m_bound;}
+  double getBound();
+
+  /**
+   * @brief Set the bound of the current Action
+   *
+   * @param bound The new bound of the current Action
+   */
+  void setBound(double bound);
 
   /**
    * @brief Get the start time of the current action
-   * 
+   *
    * @return The start time of the current action
    */
   double getStartTime();
 
   /**
    * @brief Get the finish time of the current action
-   * 
+   *
    * @return The finish time of the current action
    */
   double getFinishTime();
 
   /**
    * @brief Get the data associated to the current action
-   * 
+   *
    * @return The data associated to the current action
    */
   void *getData() {return p_data;}
 
   /**
    * @brief Set the data associated to the current action
-   * 
+   *
    * @param data The new data associated to the current action
    */
   void setData(void* data);
 
   /**
    * @brief Get the maximum duration of the current action
-   * 
+   *
    * @return The maximum duration of the current action
    */
   double getMaxDuration() {return m_maxDuration;}
 
   /**
    * @brief Get the category associated to the current action
-   * 
+   *
    * @return The category associated to the current action
    */
   char *getCategory() {return p_category;}
 
   /**
    * @brief Get the cost of the current action
-   * 
+   *
    * @return The cost of the current action
    */
   double getCost() {return m_cost;}
 
   /**
    * @brief Set the cost of the current action
-   * 
+   *
    * @param cost The new cost of the current action
    */
   void setCost(double cost) {m_cost = cost;}
 
   /**
    * @brief Update the maximum duration of the current action
-   * 
+   *
    * @param delta [TODO]
    */
-  void updateMaxDuration(double delta) {double_update(&m_maxDuration, delta);}
+  void updateMaxDuration(double delta) {double_update(&m_maxDuration, delta,sg_surf_precision);}
 
   /**
    * @brief Update the remaining time of the current action
-   * 
+   *
    * @param delta [TODO]
    */
-  void updateRemains(double delta) {double_update(&m_remains, delta);}
+  void updateRemains(double delta) {double_update(&m_remains, delta, sg_maxmin_precision*sg_surf_precision);}
 
   /**
    * @brief Set the remaining time of the current action
-   * 
+   *
    * @param value The new remaining time of the current action
    */
   void setRemains(double value) {m_remains = value;}
 
   /**
    * @brief Set the finish time of the current action
-   * 
+   *
    * @param value The new Finush time of the current action
    */
   void setFinishTime(double value) {m_finish = value;}
@@ -538,7 +600,7 @@ public:
   /**
    * @brief Remove a reference to the current action
    * @details If the Action has no more reference, we destroy it
-   * 
+   *
    * @return true if the action was destroyed and false if someone still has references on it
    */
   virtual int unref();
@@ -565,21 +627,21 @@ public:
 
   /**
    * @brief Check if the current action is running
-   * 
+   *
    * @return true if the current Action is suspended, false otherwise
    */
   virtual bool isSuspended();
 
   /**
    * @brief Set the maximum duration of the current Action
-   * 
+   *
    * @param duration The new maximum duration of the current Action
    */
   virtual void setMaxDuration(double duration);
 
   /**
    * @brief Set the priority of the current Action
-   * 
+   *
    * @param priority The new priority of the current Action
    */
   virtual void setPriority(double priority);
@@ -587,7 +649,7 @@ public:
 #ifdef HAVE_TRACING
   /**
    * @brief Set the category of the current Action
-   * 
+   *
    * @param category The new category of the current Action
    */
   void setCategory(const char *category);
@@ -595,30 +657,21 @@ public:
 
   /**
    * @brief Get the remaining time of the current action after updating the resource
-   * 
+   *
    * @return The remaining time
    */
   virtual double getRemains();
 
   /**
    * @brief Get the remaining time of the current action without updating the resource
-   * 
+   *
    * @return The remaining time
    */
   double getRemainsNoUpdate();
 
-#ifdef HAVE_LATENCY_BOUND_TRACKING
-  /**
-   * @brief Check if the action is limited by latency.
-   * 
-   * @return 1 if action is limited by latency, 0 otherwise
-   */
-  int getLatencyLimited();
-#endif
-
   /**
    * @brief Get the priority of the current Action
-   * 
+   *
    * @return The priority of the current Action
    */
   double getPriority() {return m_priority;};
@@ -626,13 +679,15 @@ public:
   /**
    * @brief Get the state set in which the action is
    * @details [TODO]
-   * 
+   *
    * @return The state set in which the action is
    */
   ActionListPtr getStateSet() {return p_stateSet;};
 
   s_xbt_swag_hookup_t p_stateHookup;
 
+  ModelPtr getModel() {return p_model;}
+
 protected:
   ActionListPtr p_stateSet;
   double m_priority; /**< priority (1.0 by default) */
@@ -641,15 +696,13 @@ protected:
   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 */
 
-  ModelPtr getModel() {return p_model;}
-
 private:
   int resourceUsed(void *resource_id);
 
   /**
    * @brief Share the resources to the actions
    * @details [TODO]
-   * 
+   *
    * @param now [TODO]
    * @return in how much time the next action may terminatedescription]
    */
@@ -658,7 +711,7 @@ private:
   /**
    * @brief Update the current action state
    * @details [TODO]
-   * 
+   *
    * @param now [TODO]
    * @param delta [TODO]
    */
@@ -667,7 +720,7 @@ private:
   /**
    * @brief Update the [TODO]
    * @details [TODO]
-   * 
+   *
    * @param id [TODO]
    * @param event_type [TODO]
    * @param value [TODO]
@@ -677,9 +730,7 @@ private:
                                  double value, double time);
 
   ActionLmmListPtr p_modifiedSet;
-  xbt_heap_t p_actionHeap;
   int m_selectiveUpdate;
-  double m_bound;   /**< the capping of the CPU use  */
   bool m_failed;
   double m_start; /**< start time  */
   char *p_category;               /**< tracing category for categorized resource utilization monitoring */
@@ -687,20 +738,19 @@ private:
   #ifdef HAVE_LATENCY_BOUND_TRACKING
   int m_latencyLimited;               /**< Set to 1 if is limited by latency, 0 otherwise */
   #endif
-  int    m_cost;
+  double    m_cost;
   ModelPtr p_model;
   void *p_data; /**< for your convenience */
 
   /* LMM */
 public:
+  void heapInsert(double key, enum heap_action_type hat);
+  void heapRemove();
+  enum heap_action_type getHeapActionType() {return m_hat;}
   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 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;}
   bool is_linked() {return actionLmmHook::is_linked();}
   void gapRemove();
 
@@ -709,7 +759,7 @@ protected:
   double m_lastValue;
   double m_lastUpdate;
   int m_suspended;
-  int m_indexHeap;
+  ActionHeap::HeapHandleSPtr sp_heapHandle;
   enum heap_action_type m_hat;
 };