Many tiny documentation improvements

[simgrid.git] / src / s4u / s4u_Exec.cpp

diff --git a/src/s4u/s4u_Exec.cpp b/src/s4u/s4u_Exec.cpp
index ab680d81ae3b7f0114f319d924ee0e287411d797..633284da0dfcc7d04f2e5df50b0d37b94c85c74b 100644 (file)
--- a/src/s4u/s4u_Exec.cpp
+++ b/src/s4u/s4u_Exec.cpp
@@ -1,47 +1,45 @@
-/* Copyright (c) 2006-2021. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2006-2022. 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 "simgrid/Exception.hpp"
-#include "simgrid/exec.h"
-#include "simgrid/s4u/Actor.hpp"
-#include "simgrid/s4u/Exec.hpp"
-#include "simgrid/s4u/Host.hpp"
+#include <simgrid/Exception.hpp>
+#include <simgrid/exec.h>
+#include <simgrid/s4u/Exec.hpp>
+#include <simgrid/s4u/Host.hpp>
+
 #include "src/kernel/activity/ExecImpl.hpp"
 #include "src/kernel/actor/ActorImpl.hpp"
 #include "src/kernel/actor/SimcallObserver.hpp"
-#include "xbt/log.h"
 
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_exec, s4u_activity, "S4U asynchronous executions");
 
 namespace simgrid {
 namespace s4u {
 xbt::signal<void(Exec const&)> Exec::on_start;
-xbt::signal<void(Exec const&)> Exec::on_completion;
 
 Exec::Exec(kernel::activity::ExecImplPtr pimpl)
 {
   pimpl_ = pimpl;
 }
 
-void Exec::complete(Activity::State state)
+void Exec::reset() const
 {
-  Activity::complete(state);
-  on_completion(*this);
+  boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->reset();
 }
 
 ExecPtr Exec::init()
 {
   auto pimpl = kernel::activity::ExecImplPtr(new kernel::activity::ExecImpl());
-  Host::on_state_change.connect([pimpl](s4u::Host const& h) {
-    if (not h.is_on() && pimpl->state_ == kernel::activity::State::RUNNING &&
+  unsigned int cb_id = Host::on_state_change.connect([pimpl](s4u::Host const& h) {
+    if (not h.is_on() && pimpl->get_state() == kernel::activity::State::RUNNING &&
         std::find(pimpl->get_hosts().begin(), pimpl->get_hosts().end(), &h) != pimpl->get_hosts().end()) {
-      pimpl->state_ = kernel::activity::State::FAILED;
+      pimpl->set_state(kernel::activity::State::FAILED);
       pimpl->post();
     }
   });
-  return ExecPtr(pimpl->get_iface());
+  pimpl->set_cb_id(cb_id);
+  return ExecPtr(static_cast<Exec*>(pimpl->get_iface()));
 }
 
 Exec* Exec::start()
@@ -108,6 +106,14 @@ ExecPtr Exec::set_priority(double priority)
   return this;
 }
 
+ExecPtr Exec::update_priority(double priority)
+{
+  kernel::actor::simcall([this, priority] {
+    boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->update_sharing_penalty(1. / priority);
+  });
+  return this;
+}
+
 ExecPtr Exec::set_flops_amount(double flops_amount)
 {
   xbt_assert(state_ == State::INITED || state_ == State::STARTING,
@@ -153,16 +159,6 @@ unsigned int Exec::get_host_number() const
   return static_cast<kernel::activity::ExecImpl*>(pimpl_.get())->get_host_number();
 }
 
-double Exec::get_start_time() const
-{
-  return static_cast<kernel::activity::ExecImpl*>(pimpl_.get())->get_start_time();
-}
-
-double Exec::get_finish_time() const
-{
-  return static_cast<kernel::activity::ExecImpl*>(pimpl_.get())->get_finish_time();
-}
-
 /** @brief Change the host on which this activity takes place.
  *
  * The activity cannot be terminated already (but it may be started). */
@@ -200,6 +196,22 @@ ExecPtr Exec::set_hosts(const std::vector<Host*>& hosts)
   return this;
 }
 
+ExecPtr Exec::unset_host()
+{
+  if (not is_assigned())
+    throw std::invalid_argument(
+        xbt::string_printf("Exec %s: the activity is not assigned to any host(s)", get_cname()));
+  else {
+    reset();
+
+    if (state_ == State::STARTED)
+      cancel();
+    vetoable_start();
+
+    return this;
+  }
+}
+
 double Exec::get_cost() const
 {
   return (pimpl_->surf_action_ == nullptr) ? -1 : pimpl_->surf_action_->get_cost();