Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
cleanup the resource::Action::State::IGNORED thing
[simgrid.git] / src / kernel / resource / Action.cpp
index a7d037a..02aee24 100644 (file)
@@ -7,6 +7,7 @@
 #include "simgrid/kernel/resource/Model.hpp"
 #include "src/kernel/lmm/maxmin.hpp"
 #include "src/surf/surf_interface.hpp"
+#include "surf/surf.hpp"
 
 XBT_LOG_NEW_CATEGORY(kernel, "Logging specific to the internals of SimGrid");
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(resource, kernel, "Logging specific to the resources");
@@ -20,55 +21,71 @@ Action::Action(simgrid::kernel::resource::Model* model, double cost, bool failed
 }
 
 Action::Action(simgrid::kernel::resource::Model* model, double cost, bool failed, kernel::lmm::Variable* var)
-    : remains_(cost), start_(surf_get_clock()), cost_(cost), model_(model), variable_(var)
+    : remains_(cost), start_time_(surf_get_clock()), cost_(cost), model_(model), variable_(var)
 {
   if (failed)
-    state_set_ = getModel()->getFailedActionSet();
+    state_set_ = get_model()->get_failed_action_set();
   else
-    state_set_ = getModel()->getRunningActionSet();
+    state_set_ = get_model()->get_started_action_set();
 
   state_set_->push_back(*this);
 }
 
 Action::~Action()
 {
+  if (state_set_hook_.is_linked())
+    simgrid::xbt::intrusive_erase(*state_set_, *this);
+  if (get_variable())
+    get_model()->get_maxmin_system()->variable_free(get_variable());
+
+  /* remove from heap on need (ie, if selective update) */
+  get_model()->get_action_heap().remove(this);
+  if (modified_set_hook_.is_linked())
+    simgrid::xbt::intrusive_erase(*get_model()->get_modified_set(), *this);
+
   xbt_free(category_);
 }
 
 void Action::finish(Action::State state)
 {
   finish_time_ = surf_get_clock();
-  setState(state);
+  set_state(state);
+  set_remains(0);
 }
 
-Action::State Action::getState() const
+Action::State Action::get_state() const
 {
-  if (state_set_ == model_->getReadyActionSet())
-    return Action::State::ready;
-  if (state_set_ == model_->getRunningActionSet())
-    return Action::State::running;
-  if (state_set_ == model_->getFailedActionSet())
-    return Action::State::failed;
-  if (state_set_ == model_->getDoneActionSet())
-    return Action::State::done;
-  return Action::State::not_in_the_system;
+  if (state_set_ == model_->get_inited_action_set())
+    return Action::State::INITED;
+  if (state_set_ == model_->get_started_action_set())
+    return Action::State::STARTED;
+  if (state_set_ == model_->get_failed_action_set())
+    return Action::State::FAILED;
+  if (state_set_ == model_->get_finished_action_set())
+    return Action::State::FINISHED;
+  if (state_set_ == model_->get_ignored_action_set())
+    return Action::State::IGNORED;
+  THROW_IMPOSSIBLE;
 }
 
-void Action::setState(Action::State state)
+void Action::set_state(Action::State state)
 {
   simgrid::xbt::intrusive_erase(*state_set_, *this);
   switch (state) {
-    case Action::State::ready:
-      state_set_ = model_->getReadyActionSet();
+    case Action::State::INITED:
+      state_set_ = model_->get_inited_action_set();
       break;
-    case Action::State::running:
-      state_set_ = model_->getRunningActionSet();
+    case Action::State::STARTED:
+      state_set_ = model_->get_started_action_set();
       break;
-    case Action::State::failed:
-      state_set_ = model_->getFailedActionSet();
+    case Action::State::FAILED:
+      state_set_ = model_->get_failed_action_set();
       break;
-    case Action::State::done:
-      state_set_ = model_->getDoneActionSet();
+    case Action::State::FINISHED:
+      state_set_ = model_->get_finished_action_set();
+      break;
+    case Action::State::IGNORED:
+      state_set_ = model_->get_ignored_action_set();
       break;
     default:
       state_set_ = nullptr;
@@ -78,23 +95,23 @@ void Action::setState(Action::State state)
     state_set_->push_back(*this);
 }
 
-double Action::getBound() const
+double Action::get_bound() const
 {
   return variable_ ? variable_->get_bound() : 0;
 }
 
-void Action::setBound(double bound)
+void Action::set_bound(double bound)
 {
   XBT_IN("(%p,%g)", this, bound);
   if (variable_)
-    getModel()->getMaxminSystem()->update_variable_bound(variable_, bound);
+    get_model()->get_maxmin_system()->update_variable_bound(variable_, bound);
 
-  if (getModel()->getUpdateMechanism() == UM_LAZY && getLastUpdate() != surf_get_clock())
-    heapRemove(getModel()->getActionHeap());
+  if (get_model()->get_update_algorithm() == Model::UpdateAlgo::Lazy && get_last_update() != surf_get_clock())
+    get_model()->get_action_heap().remove(this);
   XBT_OUT();
 }
 
-void Action::setCategory(const char* category)
+void Action::set_category(const char* category)
 {
   category_ = xbt_strdup(category);
 }
@@ -104,31 +121,31 @@ void Action::ref()
   refcount_++;
 }
 
-void Action::setMaxDuration(double duration)
+void Action::set_max_duration(double duration)
 {
   max_duration_ = duration;
-  if (getModel()->getUpdateMechanism() == UM_LAZY) // remove action from the heap
-    heapRemove(getModel()->getActionHeap());
+  if (get_model()->get_update_algorithm() == Model::UpdateAlgo::Lazy) // remove action from the heap
+    get_model()->get_action_heap().remove(this);
 }
 
-void Action::setSharingWeight(double weight)
+void Action::set_priority(double weight)
 {
   XBT_IN("(%p,%g)", this, weight);
-  sharing_weight_ = weight;
-  getModel()->getMaxminSystem()->update_variable_weight(getVariable(), weight);
+  sharing_priority_ = weight;
+  get_model()->get_maxmin_system()->update_variable_weight(get_variable(), weight);
 
-  if (getModel()->getUpdateMechanism() == UM_LAZY)
-    heapRemove(getModel()->getActionHeap());
+  if (get_model()->get_update_algorithm() == Model::UpdateAlgo::Lazy)
+    get_model()->get_action_heap().remove(this);
   XBT_OUT();
 }
 
 void Action::cancel()
 {
-  setState(Action::State::failed);
-  if (getModel()->getUpdateMechanism() == UM_LAZY) {
-    if (modifiedSetHook_.is_linked())
-      simgrid::xbt::intrusive_erase(*getModel()->getModifiedSet(), *this);
-    heapRemove(getModel()->getActionHeap());
+  set_state(Action::State::FAILED);
+  if (get_model()->get_update_algorithm() == Model::UpdateAlgo::Lazy) {
+    if (modified_set_hook_.is_linked())
+      simgrid::xbt::intrusive_erase(*get_model()->get_modified_set(), *this);
+    get_model()->get_action_heap().remove(this);
   }
 }
 
@@ -136,16 +153,6 @@ int Action::unref()
 {
   refcount_--;
   if (not refcount_) {
-    if (stateSetHook_.is_linked())
-      simgrid::xbt::intrusive_erase(*state_set_, *this);
-    if (getVariable())
-      getModel()->getMaxminSystem()->variable_free(getVariable());
-    if (getModel()->getUpdateMechanism() == UM_LAZY) {
-      /* remove from heap */
-      heapRemove(getModel()->getActionHeap());
-      if (modifiedSetHook_.is_linked())
-        simgrid::xbt::intrusive_erase(*getModel()->getModifiedSet(), *this);
-    }
     delete this;
     return 1;
   }
@@ -156,13 +163,12 @@ void Action::suspend()
 {
   XBT_IN("(%p)", this);
   if (suspended_ != SuspendStates::sleeping) {
-    getModel()->getMaxminSystem()->update_variable_weight(getVariable(), 0.0);
-    if (getModel()->getUpdateMechanism() == UM_LAZY) {
-      heapRemove(getModel()->getActionHeap());
-      if (getModel()->getUpdateMechanism() == UM_LAZY && state_set_ == getModel()->getRunningActionSet() &&
-          sharing_weight_ > 0) {
+    get_model()->get_maxmin_system()->update_variable_weight(get_variable(), 0.0);
+    if (get_model()->get_update_algorithm() == Model::UpdateAlgo::Lazy) {
+      get_model()->get_action_heap().remove(this);
+      if (state_set_ == get_model()->get_started_action_set() && sharing_priority_ > 0) {
         // If we have a lazy model, we need to update the remaining value accordingly
-        updateRemainingLazy(surf_get_clock());
+        update_remains_lazy(surf_get_clock());
       }
     }
     suspended_ = SuspendStates::suspended;
@@ -174,74 +180,77 @@ void Action::resume()
 {
   XBT_IN("(%p)", this);
   if (suspended_ != SuspendStates::sleeping) {
-    getModel()->getMaxminSystem()->update_variable_weight(getVariable(), getPriority());
+    get_model()->get_maxmin_system()->update_variable_weight(get_variable(), get_priority());
     suspended_ = SuspendStates::not_suspended;
-    if (getModel()->getUpdateMechanism() == UM_LAZY)
-      heapRemove(getModel()->getActionHeap());
+    if (get_model()->get_update_algorithm() == Model::UpdateAlgo::Lazy)
+      get_model()->get_action_heap().remove(this);
   }
   XBT_OUT();
 }
 
-bool Action::isSuspended()
+bool Action::is_suspended()
 {
   return suspended_ == SuspendStates::suspended;
 }
-/* insert action on heap using a given key and a hat (heap_action_type)
- * a hat can be of three types for communications:
- *
- * NORMAL = this is a normal heap entry stating the date to finish transmitting
- * LATENCY = this is a heap entry to warn us when the latency is payed
- * MAX_DURATION =this is a heap entry to warn us when the max_duration limit is reached
- */
-void Action::heapInsert(heap_type& heap, double key, Action::Type hat)
-{
-  type_       = hat;
-  heap_handle_ = heap.emplace(std::make_pair(key, this));
-}
-
-void Action::heapRemove(heap_type& heap)
-{
-  type_ = Action::Type::NOTSET;
-  if (heap_handle_) {
-    heap.erase(*heap_handle_);
-    clearHeapHandle();
-  }
-}
-
-void Action::heapUpdate(heap_type& heap, double key, Action::Type hat)
-{
-  type_ = hat;
-  if (heap_handle_) {
-    heap.update(*heap_handle_, std::make_pair(key, this));
-  } else {
-    heap_handle_ = heap.emplace(std::make_pair(key, this));
-  }
-}
 
-double Action::getRemains()
+double Action::get_remains()
 {
   XBT_IN("(%p)", this);
   /* update remains before return it */
-  if (getModel()->getUpdateMechanism() == UM_LAZY) /* update remains before return it */
-    updateRemainingLazy(surf_get_clock());
+  if (get_model()->get_update_algorithm() == Model::UpdateAlgo::Lazy) /* update remains before return it */
+    update_remains_lazy(surf_get_clock());
   XBT_OUT();
   return remains_;
 }
 
-void Action::updateMaxDuration(double delta)
+void Action::update_max_duration(double delta)
 {
   double_update(&max_duration_, delta, sg_surf_precision);
 }
-void Action::updateRemains(double delta)
+void Action::update_remains(double delta)
 {
   double_update(&remains_, delta, sg_maxmin_precision * sg_surf_precision);
 }
 
-void Action::refreshLastUpdate()
+void Action::set_last_update()
 {
   last_update_ = surf_get_clock();
 }
 
+double ActionHeap::top_date() const
+{
+  return top().first;
+}
+void ActionHeap::insert(Action* action, double date, ActionHeap::Type type)
+{
+  action->type_      = type;
+  action->heap_hook_ = emplace(std::make_pair(date, action));
+}
+void ActionHeap::remove(Action* action)
+{
+  action->type_ = ActionHeap::Type::unset;
+  if (action->heap_hook_) {
+    erase(*action->heap_hook_);
+    action->heap_hook_ = boost::none;
+  }
+}
+void ActionHeap::update(Action* action, double date, ActionHeap::Type type)
+{
+  action->type_ = type;
+  if (action->heap_hook_) {
+    heap_type::update(*action->heap_hook_, std::make_pair(date, action));
+  } else {
+    action->heap_hook_ = emplace(std::make_pair(date, action));
+  }
+}
+Action* ActionHeap::pop()
+{
+  Action* action = top().second;
+  heap_type::pop();
+  action->heap_hook_ = boost::none;
+  return action;
+}
+
 } // namespace surf
 } // namespace simgrid
 } // namespace simgrid