Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Enforce "Rule-of-Three/Five".
[simgrid.git] / include / simgrid / kernel / resource / Model.hpp
index 83076be..49918bb 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2004-2018. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2004-2019. 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. */
@@ -20,28 +20,33 @@ class XBT_PUBLIC Model {
 public:
   /** @brief Possible update mechanisms */
   enum class UpdateAlgo {
-    Full, /**< Full update mechanism: the remaining time of every action is recomputed at each step */
-    Lazy  /**< Lazy update mechanism: only the modified actions get recomputed.
+    FULL, /**< Full update mechanism: the remaining time of every action is recomputed at each step */
+    LAZY  /**< Lazy update mechanism: only the modified actions get recomputed.
                    It may be slower than full if your system is tightly coupled to the point where every action
                    gets recomputed anyway. In that case, you'd better not try to be cleaver with lazy and go for
                    a simple full update.  */
   };
 
   explicit Model(Model::UpdateAlgo algo);
+  Model(const Model&) = delete;
+  Model& operator=(const Model&) = delete;
 
   virtual ~Model();
 
-  /** @brief Get the set of [actions](@ref Action) in *ready* state */
-  Action::StateSet* get_ready_action_set() const { return ready_action_set_; }
+  /** @brief Get the set of [actions](@ref Action) in *inited* state */
+  Action::StateSet* get_inited_action_set() const { return inited_action_set_; }
 
-  /** @brief Get the set of [actions](@ref Action) in *running* state */
-  Action::StateSet* get_running_action_set() const { return running_action_set_; }
+  /** @brief Get the set of [actions](@ref Action) in *started* state */
+  Action::StateSet* get_started_action_set() const { return started_action_set_; }
 
   /** @brief Get the set of [actions](@ref Action) in *failed* state */
   Action::StateSet* get_failed_action_set() const { return failed_action_set_; }
 
-  /** @brief Get the set of [actions](@ref Action) in *done* state */
-  Action::StateSet* get_done_action_set() const { return done_action_set_; }
+  /** @brief Get the set of [actions](@ref Action) in *finished* state */
+  Action::StateSet* get_finished_action_set() const { return finished_action_set_; }
+
+  /** @brief Get the set of [actions](@ref Action) in *ignored* state */
+  Action::StateSet* get_ignored_action_set() const { return ignored_action_set_; }
 
   /** @brief Get the set of modified [actions](@ref Action) */
   Action::ModifiedSet* get_modified_set() const;
@@ -52,15 +57,11 @@ public:
   /** @brief Set the maxmin system of the current Model */
   void set_maxmin_system(lmm::System* system) { maxmin_system_ = system; }
 
-  /** @brief Get the update mechanism of the current Model */
-  UpdateAlgo getUpdateMechanism() const { return update_algorithm_; }
+  /** @brief Get the update algorithm of the current Model */
+  UpdateAlgo get_update_algorithm() const { return update_algorithm_; }
 
   /** @brief Get Action heap */
-  heap_type& getActionHeap() { return action_heap_; }
-
-  double actionHeapTopDate() const { return action_heap_.top().first; }
-  Action* actionHeapPop();
-  bool actionHeapIsEmpty() const { return action_heap_.empty(); }
+  ActionHeap& get_action_heap() { return action_heap_; }
 
   /**
    * @brief Share the resources between the actions
@@ -72,6 +73,13 @@ public:
   virtual double next_occuring_event_lazy(double now);
   virtual double next_occuring_event_full(double now);
 
+private:
+  Action* extract_action(Action::StateSet* list);
+
+public:
+  Action* extract_done_action();
+  Action* extract_failed_action();
+
   /**
    * @brief Update action to the current time
    *
@@ -82,24 +90,32 @@ public:
   virtual void update_actions_state_lazy(double now, double delta);
   virtual void update_actions_state_full(double now, double delta);
 
-  /** @brief Returns whether this model have an idempotent shareResource()
+  /** @brief Returns whether this model have an idempotent share_resource()
    *
    * 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 nextOccuringEventIsIdempotent() { return true; }
+  virtual bool next_occuring_event_is_idempotent() { return true; }
 
 private:
   lmm::System* maxmin_system_           = nullptr;
   const UpdateAlgo update_algorithm_;
-  Action::StateSet* ready_action_set_   = new Action::StateSet(); /**< Actions in state SURF_ACTION_READY */
-  Action::StateSet* running_action_set_ = new Action::StateSet(); /**< Actions in state SURF_ACTION_RUNNING */
-  Action::StateSet* failed_action_set_  = new Action::StateSet(); /**< Actions in state SURF_ACTION_FAILED */
-  Action::StateSet* done_action_set_    = new Action::StateSet(); /**< Actions in state SURF_ACTION_DONE */
-  heap_type action_heap_;
+  Action::StateSet* inited_action_set_  = new Action::StateSet(); /**< Created not started */
+  Action::StateSet* started_action_set_  = new Action::StateSet(); /**< Started not done */
+  Action::StateSet* failed_action_set_  = new Action::StateSet(); /**< Done with failure */
+  Action::StateSet* finished_action_set_ = new Action::StateSet(); /**< Done successful */
+  Action::StateSet* ignored_action_set_  = new Action::StateSet(); /**< not considered (failure detectors?) */
+
+  ActionHeap action_heap_;
 };
 
 } // namespace resource
 } // namespace kernel
 } // namespace simgrid
+
+/** @ingroup SURF_models
+ *  @brief List of initialized models
+ */
+XBT_PUBLIC_DATA std::vector<simgrid::kernel::resource::Model*> all_existing_models;
+
 #endif