Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Add new entry in Release_Notes.
[simgrid.git] / src / kernel / resource / Model.cpp
index ac5f5ec..6006754 100644 (file)
-/* Copyright (c) 2004-2018. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2004-2023. 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/Model.hpp"
+#include "simgrid/kernel/resource/Model.hpp"
 #include "src/kernel/lmm/maxmin.hpp"
+#include "xbt/ex.h"
 
-XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(resource);
+XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(ker_resource);
 
-namespace simgrid {
-namespace surf {
+namespace simgrid::kernel::resource {
 
-Model::Model() : maxminSystem_(nullptr)
+Model::Model(const std::string& name) : name_(name)
 {
-  readyActionSet_   = new ActionList();
-  runningActionSet_ = new ActionList();
-  failedActionSet_  = new ActionList();
-  doneActionSet_    = new ActionList();
-
-  modifiedSet_     = nullptr;
-  updateMechanism_ = UM_UNDEFINED;
-  selectiveUpdate_ = 0;
 }
 
-Model::~Model()
+Model::~Model() =
+    default; // Don't move this declaration to the header, or it will break external projects such as SimGrid-FMI
+
+Model* Model::set_update_algorithm(Model::UpdateAlgo algo)
+{
+  update_algorithm_ = algo;
+  return this;
+}
+
+Action::ModifiedSet* Model::get_modified_set() const
 {
-  delete readyActionSet_;
-  delete runningActionSet_;
-  delete failedActionSet_;
-  delete doneActionSet_;
-  delete modifiedSet_;
-  delete maxminSystem_;
+  return maxmin_system_->get_modified_action_set();
 }
 
-Action* Model::actionHeapPop()
+void Model::set_maxmin_system(lmm::System* system)
 {
-  Action* action = actionHeap_.top().second;
-  actionHeap_.pop();
-  action->clearHeapHandle();
-  return action;
+  maxmin_system_.release(); // ugly...
+  maxmin_system_.reset(system);
 }
 
-double Model::nextOccuringEvent(double now)
+double Model::next_occurring_event(double now)
 {
   // FIXME: set the good function once and for all
-  if (updateMechanism_ == UM_LAZY)
-    return nextOccuringEventLazy(now);
-  else if (updateMechanism_ == UM_FULL)
-    return nextOccuringEventFull(now);
+  if (update_algorithm_ == Model::UpdateAlgo::LAZY)
+    return next_occurring_event_lazy(now);
+  else if (update_algorithm_ == Model::UpdateAlgo::FULL)
+    return next_occurring_event_full(now);
   else
     xbt_die("Invalid cpu update mechanism!");
 }
 
-double Model::nextOccuringEventLazy(double now)
+double Model::next_occurring_event_lazy(double now)
 {
-  XBT_DEBUG("Before share resources, the size of modified actions set is %zu", modifiedSet_->size());
-  lmm_solve(maxminSystem_);
-  XBT_DEBUG("After share resources, The size of modified actions set is %zu", modifiedSet_->size());
-
-  while (not modifiedSet_->empty()) {
-    Action* action = &(modifiedSet_->front());
-    modifiedSet_->pop_front();
-    bool max_dur_flag = false;
-
-    if (action->getStateSet() != runningActionSet_)
+  XBT_DEBUG("Before share resources, the size of modified actions set is %zu",
+            maxmin_system_->get_modified_action_set()->size());
+  maxmin_system_->solve();
+  Action::ModifiedSet* modified_action_set = maxmin_system_->get_modified_action_set();
+  XBT_DEBUG("After share resources, The size of modified actions set is %zu", modified_action_set->size());
+
+  while (not modified_action_set->empty()) {
+    Action* action = &(modified_action_set->front());
+    modified_action_set->pop_front();
+    ActionHeap::Type action_type = ActionHeap::Type::normal;
+
+    if (action->get_state_set() != &started_action_set_)
       continue;
 
     /* bogus priority, skip it */
-    if (action->getPriority() <= 0 || action->getType() == Action::Type::LATENCY)
+    if (action->get_sharing_penalty() <= 0 || action->get_type() == ActionHeap::Type::latency)
       continue;
 
-    action->updateRemainingLazy(now);
+    action->update_remains_lazy(now);
 
     double min   = -1;
-    double share = action->getVariable()->get_value();
+    double share = action->get_rate();
 
     if (share > 0) {
       double time_to_completion;
-      if (action->getRemains() > 0) {
-        time_to_completion = action->getRemainsNoUpdate() / share;
+      if (action->get_remains() > 0) {
+        time_to_completion = action->get_remains_no_update() / share;
       } else {
         time_to_completion = 0.0;
       }
       min = now + time_to_completion; // when the task will complete if nothing changes
     }
 
-    if ((action->getMaxDuration() > NO_MAX_DURATION) &&
-        (min <= -1 || action->getStartTime() + action->getMaxDuration() < min)) {
+    if ((action->get_max_duration() != NO_MAX_DURATION) &&
+        (min <= -1 || action->get_start_time() + action->get_max_duration() < min)) {
       // when the task will complete anyway because of the deadline if any
-      min          = action->getStartTime() + action->getMaxDuration();
-      max_dur_flag = true;
+      min         = action->get_start_time() + action->get_max_duration();
+      action_type = ActionHeap::Type::max_duration;
     }
 
-    XBT_DEBUG("Action(%p) corresponds to variable %d", action, action->getVariable()->id_int);
+    XBT_DEBUG("Action(%p) corresponds to variable %d", action, action->get_variable()->rank_);
 
     XBT_DEBUG("Action(%p) Start %f. May finish at %f (got a share of %f). Max_duration %f", action,
-              action->getStartTime(), min, share, action->getMaxDuration());
+              action->get_start_time(), min, share, action->get_max_duration());
 
     if (min > -1) {
-      action->heapUpdate(actionHeap_, min, max_dur_flag ? Action::Type::MAX_DURATION : Action::Type::NORMAL);
+      action_heap_.update(action, min, action_type);
       XBT_DEBUG("Insert at heap action(%p) min %f now %f", action, min, now);
     } else
       DIE_IMPOSSIBLE;
   }
 
   // hereafter must have already the min value for this resource model
-  if (not actionHeapIsEmpty()) {
-    double min = actionHeapTopDate() - now;
+  if (not action_heap_.empty()) {
+    double min = action_heap_.top_date() - now;
     XBT_DEBUG("minimum with the HEAP %f", min);
     return min;
   } else {
@@ -115,17 +111,16 @@ double Model::nextOccuringEventLazy(double now)
   }
 }
 
-double Model::nextOccuringEventFull(double /*now*/)
+double Model::next_occurring_event_full(double /*now*/)
 {
-  maxminSystem_->solve_fun(maxminSystem_);
+  maxmin_system_->solve();
 
   double min = -1;
 
-  for (Action& action : *getRunningActionSet()) {
-    double value = action.getVariable()->get_value();
-    if (value > 0) {
-      if (action.getRemains() > 0)
-        value = action.getRemainsNoUpdate() / value;
+  for (Action& action : *get_started_action_set()) {
+    if (double value = action.get_rate(); value > 0) {
+      if (action.get_remains() > 0)
+        value = action.get_remains_no_update() / value;
       else
         value = 0.0;
       if (min < 0 || value < min) {
@@ -133,8 +128,8 @@ double Model::nextOccuringEventFull(double /*now*/)
         XBT_DEBUG("Updating min (value) with %p: %f", &action, min);
       }
     }
-    if ((action.getMaxDuration() >= 0) && (min < 0 || action.getMaxDuration() < min)) {
-      min = action.getMaxDuration();
+    if ((action.get_max_duration() >= 0) && (min < 0 || action.get_max_duration() < min)) {
+      min = action.get_max_duration();
       XBT_DEBUG("Updating min (duration) with %p: %f", &action, min);
     }
   }
@@ -143,25 +138,46 @@ double Model::nextOccuringEventFull(double /*now*/)
   return min;
 }
 
-void Model::updateActionsState(double now, double delta)
+void Model::update_actions_state(double now, double delta)
 {
-  if (updateMechanism_ == UM_FULL)
-    updateActionsStateFull(now, delta);
-  else if (updateMechanism_ == UM_LAZY)
-    updateActionsStateLazy(now, delta);
+  if (update_algorithm_ == Model::UpdateAlgo::FULL)
+    update_actions_state_full(now, delta);
+  else if (update_algorithm_ == Model::UpdateAlgo::LAZY)
+    update_actions_state_lazy(now, delta);
   else
     xbt_die("Invalid cpu update mechanism!");
 }
 
-void Model::updateActionsStateLazy(double /*now*/, double /*delta*/)
+/** Pops and returns the first action of that state set (or nullptr if none exist) */
+Action* Model::extract_action(Action::StateSet* list)
+{
+  if (list->empty())
+    return nullptr;
+  Action* res = &list->front();
+  list->pop_front();
+  return res;
+}
+
+/** Pops and returns the first finished action (or nullptr if none exist) */
+Action* Model::extract_done_action()
+{
+  return extract_action(get_finished_action_set());
+}
+
+/** Pops and returns the failed finished action (or nullptr if none exist) */
+Action* Model::extract_failed_action()
+{
+  return extract_action(get_failed_action_set());
+}
+
+void Model::update_actions_state_lazy(double /*now*/, double /*delta*/)
 {
   THROW_UNIMPLEMENTED;
 }
 
-void Model::updateActionsStateFull(double /*now*/, double /*delta*/)
+void Model::update_actions_state_full(double /*now*/, double /*delta*/)
 {
   THROW_UNIMPLEMENTED;
 }
 
-} // namespace surf
-} // namespace simgrid
+} // namespace simgrid::kernel::resource