Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Comply with clang-format rules
[simgrid.git] / src / kernel / resource / Action.cpp
index fac7b4a..cf86b5c 100644 (file)
@@ -1,11 +1,13 @@
-/* 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. */
 
-#include "src/kernel/resource/Action.hpp"
+#include "simgrid/kernel/resource/Action.hpp"
+#include "simgrid/kernel/resource/Model.hpp"
 #include "src/kernel/lmm/maxmin.hpp"
-#include "src/kernel/resource/Model.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");
@@ -19,149 +21,147 @@ 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)
-    stateSet_ = getModel()->getFailedActionSet();
+    state_set_ = get_model()->get_failed_action_set();
   else
-    stateSet_ = getModel()->getRunningActionSet();
+    state_set_ = get_model()->get_started_action_set();
 
-  stateSet_->push_back(*this);
+  state_set_->push_back(*this);
 }
 
 Action::~Action()
 {
-  xbt_free(category_);
+  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);
 }
 
 void Action::finish(Action::State state)
 {
-  finishTime_ = surf_get_clock();
-  setState(state);
+  finish_time_ = surf_get_clock();
+  set_remains(0);
+  set_state(state);
 }
 
-Action::State Action::getState() const
+Action::State Action::get_state() const
 {
-  if (stateSet_ == model_->getReadyActionSet())
-    return Action::State::ready;
-  if (stateSet_ == model_->getRunningActionSet())
-    return Action::State::running;
-  if (stateSet_ == model_->getFailedActionSet())
-    return Action::State::failed;
-  if (stateSet_ == 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(*stateSet_, *this);
+  simgrid::xbt::intrusive_erase(*state_set_, *this);
   switch (state) {
-    case Action::State::ready:
-      stateSet_ = model_->getReadyActionSet();
+    case Action::State::INITED:
+      state_set_ = model_->get_inited_action_set();
+      break;
+    case Action::State::STARTED:
+      state_set_ = model_->get_started_action_set();
       break;
-    case Action::State::running:
-      stateSet_ = model_->getRunningActionSet();
+    case Action::State::FAILED:
+      state_set_ = model_->get_failed_action_set();
       break;
-    case Action::State::failed:
-      stateSet_ = model_->getFailedActionSet();
+    case Action::State::FINISHED:
+      state_set_ = model_->get_finished_action_set();
       break;
-    case Action::State::done:
-      stateSet_ = model_->getDoneActionSet();
+    case Action::State::IGNORED:
+      state_set_ = model_->get_ignored_action_set();
       break;
     default:
-      stateSet_ = nullptr;
+      state_set_ = nullptr;
       break;
   }
-  if (stateSet_)
-    stateSet_->push_back(*this);
+  if (state_set_)
+    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)
-{
-  category_ = xbt_strdup(category);
-}
-
 void Action::ref()
 {
   refcount_++;
 }
 
-void Action::setMaxDuration(double duration)
+void Action::set_max_duration(double duration)
 {
-  maxDuration_ = duration;
-  if (getModel()->getUpdateMechanism() == UM_LAZY) // remove action from the heap
-    heapRemove(getModel()->getActionHeap());
+  max_duration_ = duration;
+  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);
-  sharingWeight_ = 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);
   }
 }
 
-int Action::unref()
+bool Action::unref()
 {
   refcount_--;
   if (not refcount_) {
-    if (stateSetHook_.is_linked())
-      simgrid::xbt::intrusive_erase(*stateSet_, *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;
+    return true;
   }
-  return 0;
+  return false;
 }
 
 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 && stateSet_ == getModel()->getRunningActionSet() &&
-          sharingWeight_ > 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;
@@ -173,60 +173,78 @@ 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)
+
+double Action::get_remains()
 {
-  type_       = hat;
-  heapHandle_ = heap.emplace(std::make_pair(key, this));
+  XBT_IN("(%p)", this);
+  /* update remains before returning it */
+  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::heapRemove(heap_type& heap)
+void Action::update_max_duration(double delta)
 {
-  type_ = Action::Type::NOTSET;
-  if (heapHandle_) {
-    heap.erase(*heapHandle_);
-    clearHeapHandle();
-  }
+  if (max_duration_ != NO_MAX_DURATION)
+    double_update(&max_duration_, delta, sg_surf_precision);
+}
+void Action::update_remains(double delta)
+{
+  double_update(&remains_, delta, sg_maxmin_precision * sg_surf_precision);
+}
+
+void Action::set_last_update()
+{
+  last_update_ = surf_get_clock();
 }
 
-void Action::heapUpdate(heap_type& heap, double key, Action::Type hat)
+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)
 {
-  type_ = hat;
-  if (heapHandle_) {
-    heap.update(*heapHandle_, std::make_pair(key, this));
+  action->type_ = type;
+  if (action->heap_hook_) {
+    heap_type::update(*action->heap_hook_, std::make_pair(date, action));
   } else {
-    heapHandle_ = heap.emplace(std::make_pair(key, this));
+    action->heap_hook_ = emplace(std::make_pair(date, action));
   }
 }
-
-double Action::getRemains()
+Action* ActionHeap::pop()
 {
-  XBT_IN("(%p)", this);
-  /* update remains before return it */
-  if (getModel()->getUpdateMechanism() == UM_LAZY) /* update remains before return it */
-    updateRemainingLazy(surf_get_clock());
-  XBT_OUT();
-  return remains_;
+  Action* action = top().second;
+  heap_type::pop();
+  action->heap_hook_ = boost::none;
+  return action;
 }
 
 } // namespace surf
-} // namespace simgrid
+} // namespace kernel
 } // namespace simgrid