src/plugins/operation.cpp

   1 #include <simgrid/Exception.hpp>
   2 #include <simgrid/plugins/operation.hpp>
   3 #include <simgrid/s4u/Comm.hpp>
   4 #include <simgrid/s4u/Exec.hpp>
   5 #include <simgrid/simix.hpp>
   6
   7 #include "src/simgrid/module.hpp"
   8
   9 SIMGRID_REGISTER_PLUGIN(operation, "Battery management", nullptr)
  10 /** @defgroup plugin_operation plugin_operation Plugin Operation
  11
  12   @beginrst
  13
  14 This is the operation plugin, enabling management of Operations.
  15 To activate this plugin, first call :cpp:func:`Operation::init`.
  16
  17 Operations are designed to represent workflows, i.e, graphs of Operations.
  18 Operations can only be instancied using either
  19 :cpp:func:`simgrid::plugins::ExecOp::init` or :cpp:func:`simgrid::plugins::CommOp::init`
  20 An ExecOp is an Execution Operation. Its underlying Activity is an :ref:`Exec <API_s4u_Exec>`.
  21 A CommOp is a Communication Operation. Its underlying Activity is a :ref:`Comm <API_s4u_Comm>`.
  22
  23   @endrst
  24  */
  25 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(Operation, kernel, "Logging specific to the operation plugin");
  26
  27 namespace simgrid::plugins {
  28
  29 xbt::signal<void(Operation*)> Operation::on_start;
  30 xbt::signal<void(Operation*)> Operation::on_end;
  31
  32 Operation::Operation(const std::string& name) : name_(name) {}
  33
  34 std::string Operation::get_name()
  35 {
  36   return name_;
  37 }
  38
  39 /**
  40  *  @param predecessor The Operation to add.
  41  *  @brief Add a predecessor to this Operation.
  42  */
  43 void Operation::add_predecessor(Operation* predecessor)
  44 {
  45   if (predecessors_.find(predecessor) == predecessors_.end())
  46     simgrid::kernel::actor::simcall_answered([this, predecessor] { predecessors_[predecessor] = 0; });
  47 }
  48
  49 /**
  50  *  @param predecessor The Operation to remove.
  51  *  @brief Remove a predecessor from this Operation.
  52  */
  53 void Operation::remove_predecessor(Operation* predecessor)
  54 {
  55   simgrid::kernel::actor::simcall_answered([this, predecessor] { predecessors_.erase(predecessor); });
  56 }
  57
  58 /**
  59  *  @brief Return True if the Operation can start a new Activity.
  60  *  @note The Operation is ready if not already doing something and there is at least one execution waiting in queue.
  61  */
  62 bool Operation::ready_to_run() const
  63 {
  64   if (working_ or queued_execs_ <= 0)
  65     return false;
  66   else
  67     return true;
  68 }
  69
  70 /**
  71  *  @param source The sender.
  72  *  @brief Receive a token from another Operation.
  73  *  @note Check upon reception if the Operation has received a token from each of its predecessors,
  74  * and in this case consumes those tokens and enqueue an execution.
  75  */
  76 void Operation::receive(Operation* source)
  77 {
  78   XBT_DEBUG("Operation %s received a token from %s", name_.c_str(), source->name_.c_str());
  79   auto it = predecessors_.find(source);
  80   simgrid::kernel::actor::simcall_answered([this, it] {
  81     it->second++;
  82     bool enough_tokens = true;
  83     for (auto const& [key, val] : predecessors_)
  84       if (val < 1) {
  85         enough_tokens = false;
  86         break;
  87       }
  88     if (enough_tokens) {
  89       for (auto& [key, val] : predecessors_)
  90         val--;
  91       enqueue_execs(1);
  92     }
  93   });
  94 }
  95
  96 /**
  97  *  @brief Operation routine when finishing an execution.
  98  *  @note Set its working status as false.
  99  * Add 1 to its count of finished executions.
 100  * Call the on_this_end func.
 101  * Fire on_end callback.
 102  * Send a token to each of its successors.
 103  * Start a new execution if possible.
 104  */
 105 void Operation::complete()
 106 {
 107   simgrid::kernel::actor::simcall_answered([this] {
 108     working_ = false;
 109     count_++;
 110   });
 111   end_func_(this);
 112   Operation::on_end(this);
 113   for (auto const& op : successors_)
 114     op->receive(this);
 115   if (ready_to_run())
 116     execute();
 117 }
 118
 119 /** @ingroup plugin_operation
 120  *  @brief Init the Operation plugin.
 121  *  @note Add a completion callback to all Activities to call Operation::complete().
 122  */
 123 void Operation::init()
 124 {
 125   if (Operation::inited_)
 126     return;
 127   Operation::inited_                      = true;
 128   ExtendedAttributeActivity::EXTENSION_ID = simgrid::s4u::Activity::extension_create<ExtendedAttributeActivity>();
 129   simgrid::s4u::Activity::on_completion_cb([&](simgrid::s4u::Activity const& activity) {
 130     activity.extension<ExtendedAttributeActivity>()->operation_->complete();
 131   });
 132 }
 133
 134 /** @ingroup plugin_operation
 135  *  @param n The number of executions to enqueue.
 136  *  @brief Enqueue executions.
 137  *  @note Immediatly starts an execution if possible.
 138  */
 139 void Operation::enqueue_execs(int n)
 140 {
 141   simgrid::kernel::actor::simcall_answered([this, n] {
 142     queued_execs_ += n;
 143     if (ready_to_run())
 144       execute();
 145   });
 146 }
 147
 148 /** @ingroup plugin_operation
 149  *  @param amount The amount to set.
 150  *  @brief Set the amout of work to do.
 151  *  @note Amount in flop for ExecOp and in bytes for CommOp.
 152  */
 153 void Operation::set_amount(double amount)
 154 {
 155   simgrid::kernel::actor::simcall_answered([this, amount] { amount_ = amount; });
 156 }
 157
 158 /** @ingroup plugin_operation
 159  *  @param successor The Operation to add.
 160  *  @brief Add a successor to this Operation.
 161  *  @note It also adds this as a predecessor of successor.
 162  */
 163 void Operation::add_successor(OperationPtr successor)
 164 {
 165   simgrid::kernel::actor::simcall_answered([this, successor] { successors_.insert(successor.get()); });
 166   successor->add_predecessor(this);
 167 }
 168
 169 /** @ingroup plugin_operation
 170  *  @param successor The Operation to remove.
 171  *  @brief Remove a successor from this Operation.
 172  *  @note It also remove this from the predecessors of successor.
 173  */
 174 void Operation::remove_successor(OperationPtr successor)
 175 {
 176   simgrid::kernel::actor::simcall_answered([this, successor] { successors_.erase(successor.get()); });
 177   successor->remove_predecessor(this);
 178 }
 179
 180 /** @ingroup plugin_operation
 181  *  @param func The function to set.
 182  *  @brief Set a function to be called before each execution.
 183  *  @note The function is called before the underlying Activity starts.
 184  */
 185 void Operation::on_this_start(std::function<void(Operation*)> func)
 186 {
 187   simgrid::kernel::actor::simcall_answered([this, func] { start_func_ = func; });
 188 }
 189
 190 /** @ingroup plugin_operation
 191  *  @param func The function to set.
 192  *  @brief Set a function to be called after each execution.
 193  *  @note The function is called after the underlying Activity ends, but before sending tokens to successors.
 194  */
 195 void Operation::on_this_end(std::function<void(Operation*)> func)
 196 {
 197   simgrid::kernel::actor::simcall_answered([this, func] { end_func_ = func; });
 198 }
 199
 200 /** @ingroup plugin_operation
 201  *  @brief Return the number of completed executions.
 202  */
 203 int Operation::get_count()
 204 {
 205   return count_;
 206 }
 207
 208 /**
 209  *  @brief Default constructor.
 210  */
 211 ExecOp::ExecOp(const std::string& name) : Operation(name) {}
 212
 213 /** @ingroup plugin_operation
 214  *  @brief Smart Constructor.
 215  */
 216 ExecOpPtr ExecOp::init(const std::string& name)
 217 {
 218   auto op = ExecOpPtr(new ExecOp(name));
 219   return op;
 220 }
 221
 222 /** @ingroup plugin_operation
 223  *  @brief Smart Constructor.
 224  */
 225 ExecOpPtr ExecOp::init(const std::string& name, double flops, simgrid::s4u::Host* host)
 226 {
 227   auto op = ExecOpPtr(new ExecOp(name));
 228   op->set_flops(flops);
 229   op->set_host(host);
 230   return op;
 231 }
 232
 233 /**
 234  *  @brief Do one execution of the Operation.
 235  *  @note Call the on_this_start() func. Set its working status as true.
 236  *  Init and start the underlying Activity.
 237  */
 238 void ExecOp::execute()
 239 {
 240   start_func_(this);
 241   Operation::on_start(this);
 242   simgrid::kernel::actor::simcall_answered([this] {
 243     working_      = true;
 244     queued_execs_ = std::max(queued_execs_ - 1, 0);
 245   });
 246   simgrid::s4u::ExecPtr exec = simgrid::s4u::Exec::init();
 247   exec->set_name(name_);
 248   exec->set_flops_amount(amount_);
 249   exec->set_host(host_);
 250   exec->start();
 251   exec->extension_set(new ExtendedAttributeActivity());
 252   exec->extension<ExtendedAttributeActivity>()->operation_ = this;
 253   simgrid::kernel::actor::simcall_answered([this, exec] { current_activity_ = exec; });
 254 }
 255
 256 /** @ingroup plugin_operation
 257  *  @param host The host to set.
 258  *  @brief Set a new host.
 259  */
 260 void ExecOp::set_host(simgrid::s4u::Host* host)
 261 {
 262   simgrid::kernel::actor::simcall_answered([this, host] { host_ = host; });
 263 }
 264
 265 /** @ingroup plugin_operation
 266  *  @param flops The amount of flops to set.
 267  */
 268 void ExecOp::set_flops(double flops)
 269 {
 270   simgrid::kernel::actor::simcall_answered([this, flops] { amount_ = flops; });
 271 }
 272
 273 /**
 274  *  @brief Default constructor.
 275  */
 276 CommOp::CommOp(const std::string& name) : Operation(name) {}
 277
 278 /** @ingroup plugin_operation
 279  *  @brief Smart constructor.
 280  */
 281 CommOpPtr CommOp::init(const std::string& name)
 282 {
 283   auto op = CommOpPtr(new CommOp(name));
 284   return op;
 285 }
 286
 287 /** @ingroup plugin_operation
 288  *  @brief Smart constructor.
 289  */
 290 CommOpPtr CommOp::init(const std::string& name, double bytes, simgrid::s4u::Host* source,
 291                        simgrid::s4u::Host* destination)
 292 {
 293   auto op = CommOpPtr(new CommOp(name));
 294   op->set_bytes(bytes);
 295   op->set_source(source);
 296   op->set_destination(destination);
 297   return op;
 298 }
 299
 300 /**
 301  *  @brief Do one execution of the Operation.
 302  *  @note Call the on_this_start() func. Set its working status as true.
 303  *  Init and start the underlying Activity.
 304  */
 305 void CommOp::execute()
 306 {
 307   start_func_(this);
 308   Operation::on_start(this);
 309   simgrid::kernel::actor::simcall_answered([this] {
 310     working_      = true;
 311     queued_execs_ = std::max(queued_execs_ - 1, 0);
 312   });
 313   simgrid::s4u::CommPtr comm = simgrid::s4u::Comm::sendto_init(source_, destination_);
 314   comm->set_name(name_);
 315   comm->set_payload_size(amount_);
 316   comm->start();
 317   comm->extension_set(new ExtendedAttributeActivity());
 318   comm->extension<ExtendedAttributeActivity>()->operation_ = this;
 319   simgrid::kernel::actor::simcall_answered([this, comm] { current_activity_ = comm; });
 320 }
 321
 322 /** @ingroup plugin_operation
 323  *  @param source The host to set.
 324  *  @brief Set a new source host.
 325  */
 326 void CommOp::set_source(simgrid::s4u::Host* source)
 327 {
 328   simgrid::kernel::actor::simcall_answered([this, source] { source_ = source; });
 329 }
 330
 331 /** @ingroup plugin_operation
 332  *  @param destination The host to set.
 333  *  @brief Set a new destination host.
 334  */
 335 void CommOp::set_destination(simgrid::s4u::Host* destination)
 336 {
 337   simgrid::kernel::actor::simcall_answered([this, destination] { destination_ = destination; });
 338 }
 339
 340 /** @ingroup plugin_operation
 341  *  @param bytes The amount of bytes to set.
 342  */
 343 void CommOp::set_bytes(double bytes)
 344 {
 345   simgrid::kernel::actor::simcall_answered([this, bytes] { amount_ = bytes; });
 346 }
 347
 348 } // namespace simgrid::plugins
 349
 350 simgrid::xbt::Extension<simgrid::s4u::Activity, simgrid::plugins::ExtendedAttributeActivity>
 351     simgrid::plugins::ExtendedAttributeActivity::EXTENSION_ID;
 352 bool simgrid::plugins::Operation::inited_ = false;