X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/aee6610d4ad2377964369760bce27e18a12dd708..e9a86ac48ea8d06ddebe18744c40548a9f65956f:/src/s4u/s4u_Exec.cpp

diff --git a/src/s4u/s4u_Exec.cpp b/src/s4u/s4u_Exec.cpp
index 03afd33a5c..94da9d2bd3 100644
--- a/src/s4u/s4u_Exec.cpp
+++ b/src/s4u/s4u_Exec.cpp
@@ -2,11 +2,11 @@
 
 /* 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 "xbt/log.h"
 
 #include "simgrid/s4u/Actor.hpp"
 #include "simgrid/s4u/Exec.hpp"
 #include "src/kernel/activity/ExecImpl.hpp"
+#include "xbt/log.h"
 
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_exec, s4u_activity, "S4U asynchronous executions");
 
@@ -15,16 +15,22 @@ namespace s4u {
 
 Activity* Exec::start()
 {
-  pimpl_ = simcall_execution_start(nullptr, flops_amount_, 1 / priority_, 0., host_);
-  boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(pimpl_)->setBound(bound_);
-  state_ = State::started;
+  pimpl_ = simcall_execution_start(name_, tracing_category_, flops_amount_, 1. / priority_, bound_, host_);
+  state_ = State::STARTED;
+  return this;
+}
+
+Activity* Exec::cancel()
+{
+  simcall_execution_cancel(pimpl_);
+  state_ = State::CANCELED;
   return this;
 }
 
 Activity* Exec::wait()
 {
   simcall_execution_wait(pimpl_);
-  state_ = State::finished;
+  state_ = State::FINISHED;
   return this;
 }
 
@@ -34,57 +40,98 @@ Activity* Exec::wait(double timeout)
   return this;
 }
 
+/** @brief Returns whether the state of the exec is finished */
 bool Exec::test()
 {
-  xbt_assert(state_ == State::inited || state_ == State::started || state_ == State::finished);
+  xbt_assert(state_ == State::INITED || state_ == State::STARTED || state_ == State::FINISHED);
 
-  if (state_ == State::finished)
+  if (state_ == State::FINISHED)
     return true;
 
-  if (state_ == State::inited)
+  if (state_ == State::INITED)
     this->start();
 
   if (simcall_execution_test(pimpl_)) {
-    state_ = State::finished;
+    state_ = State::FINISHED;
     return true;
   }
 
   return false;
 }
 
-ExecPtr Exec::setPriority(double priority)
+/** @brief  Change the execution priority, don't you think?
+ *
+ * An execution with twice the priority will get twice the amount of flops when the resource is shared.
+ * The default priority is 1.
+ *
+ * Currently, this cannot be changed once the exec started. */
+ExecPtr Exec::set_priority(double priority)
 {
-  xbt_assert(state_ == State::inited, "Cannot change the priority of an exec after its start");
+  xbt_assert(state_ == State::INITED, "Cannot change the priority of an exec after its start");
   priority_ = priority;
   return this;
 }
 
-ExecPtr Exec::setBound(double bound)
+/** @brief change the execution bound, ie the maximal amount of flops per second that it may consume, regardless of what
+ * the host may deliver
+ *
+ * Currently, this cannot be changed once the exec started. */
+ExecPtr Exec::set_bound(double bound)
 {
-  xbt_assert(state_ == State::inited, "Cannot change the bound of an exec after its start");
+  xbt_assert(state_ == State::INITED, "Cannot change the bound of an exec after its start");
   bound_ = bound;
   return this;
 }
 
-ExecPtr Exec::setHost(Host* host)
+/** @brief Change the host on which this activity takes place.
+ *
+ * The activity cannot be terminated already (but it may be started). */
+ExecPtr Exec::set_host(Host* host)
 {
-  xbt_assert(state_ == State::inited || state_ == State::started,
+  xbt_assert(state_ == State::INITED || state_ == State::STARTED,
              "Cannot change the host of an exec once it's done (state: %d)", (int)state_);
-  if (state_ == State::started)
+  if (state_ == State::STARTED)
     boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(pimpl_)->migrate(host);
   host_ = host;
   return this;
 }
 
+ExecPtr Exec::set_name(std::string name)
+{
+  xbt_assert(state_ == State::INITED, "Cannot change the name of an exec after its start");
+  name_ = name;
+  return this;
+}
+
+ExecPtr Exec::set_tracing_category(std::string category)
+{
+  xbt_assert(state_ == State::INITED, "Cannot change the tracing category of an exec after its start");
+  tracing_category_ = category;
+  return this;
+}
+
+/** @brief Retrieve the host on which this activity takes place. */
+Host* Exec::get_host()
+{
+  return host_;
+}
+
+/** @brief Returns the amount of flops that remain to be done */
 double Exec::get_remaining()
 {
-  return simgrid::simix::kernelImmediate(
-      [this]() { return boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(pimpl_)->remains(); });
+  return simgrid::simix::simcall(
+      [this]() { return boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(pimpl_)->get_remaining(); });
 }
-double Exec::getRemainingRatio()
+
+/** @brief Returns the ratio of elements that are still to do
+ *
+ * The returned value is between 0 (completely done) and 1 (nothing done yet).
+ */
+double Exec::get_remaining_ratio()
 {
-  return simgrid::simix::kernelImmediate(
-      [this]() { return boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(pimpl_)->remainingRatio(); });
+  return simgrid::simix::simcall([this]() {
+    return boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(pimpl_)->get_remaining_ratio();
+  });
 }
 
 void intrusive_ptr_release(simgrid::s4u::Exec* e)