X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/5eeb3c843b60e9ba5e1a952ffe83df2a4d8f5fa0..10675785aab38470f386150c08e4c3ab8fcc8a71:/include/simgrid/s4u/Exec.hpp?ds=sidebyside diff --git a/include/simgrid/s4u/Exec.hpp b/include/simgrid/s4u/Exec.hpp index 26af5d02e4..c6b3898288 100644 --- a/include/simgrid/s4u/Exec.hpp +++ b/include/simgrid/s4u/Exec.hpp @@ -1,4 +1,4 @@ -/* Copyright (c) 2017-2018. The SimGrid Team. All rights reserved. */ +/* Copyright (c) 2017-2021. 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. */ @@ -8,70 +8,87 @@ #include #include - -#include +#include +#include namespace simgrid { namespace s4u { -/** Computation #Activity, representing the asynchronous disk access. +/** Computation Activity, representing the asynchronous executions. + * + * @beginrst + * Most of them are created with :cpp:func:`simgrid::s4u::this_actor::exec_init()` or + * :cpp:func:`simgrid::s4u::Host::execute()`, and represent a classical (sequential) execution. This can be used to + * simulate some computation occurring in another thread when the calling actor is not blocked during the execution. * - * They are generated from simgrid::s4u::this_actor::exec_init() or simgrid::s4u::Host::execute(). + * You can also use :cpp:func:`simgrid::s4u::this_actor::parallel_execute()` to create *parallel* executions. These + * objects represent distributed computations involving computations on several hosts and communications between them. + * Such objects can for example represent a matrix multiplication done with ScaLAPACK on a real system. Once created, + * parallel Exec are very similar to the sequential ones. The only difference is that you cannot migrate them, and their + * remaining amount of work can only be defined as a ratio. See the doc of :cpp:func:`simgrid::s4u::Exec::get_remaining` + * and :cpp:func:`simgrid::s4u::Exec::get_remaining_ratio` for more info. + * @endrst */ +class XBT_PUBLIC Exec : public Activity_T { +#ifndef DOXYGEN + friend kernel::activity::ExecImpl; +#endif + + bool parallel_ = false; + +protected: + explicit Exec(kernel::activity::ExecImplPtr pimpl); + + void complete(Activity::State state) override; -class XBT_PUBLIC Exec : public Activity { - Exec() : Activity() {} public: - friend XBT_PUBLIC void intrusive_ptr_release(simgrid::s4u::Exec * e); - friend XBT_PUBLIC void intrusive_ptr_add_ref(simgrid::s4u::Exec * e); - friend XBT_PUBLIC ExecPtr this_actor::exec_init(double flops_amount); +#ifndef DOXYGEN + Exec(Exec const&) = delete; + Exec& operator=(Exec const&) = delete; +#endif + static xbt::signal on_start; + static xbt::signal on_completion; - ~Exec() = default; + static ExecPtr init(); + Exec* start() override; - Activity* start() override; - Activity* wait() override; - Activity* wait(double timeout) override; - Activity* cancel() override; - bool test(); + /*! take a vector of s4u::ExecPtr and return when one of them is finished. + * The return value is the rank of the first finished ExecPtr. */ + static ssize_t wait_any(const std::vector& execs) { return wait_any_for(execs, -1); } + /*! Same as wait_any, but with a timeout. If the timeout occurs, parameter last is returned.*/ + static ssize_t wait_any_for(const std::vector& execs, double timeout); - ExecPtr set_priority(double priority); - ExecPtr set_bound(double bound); +#ifndef DOXYGEN + XBT_ATTRIB_DEPRECATED_v332("Please use a plain vector for parameter") + static int wait_any(std::vector* execs) { return static_cast(wait_any_for(*execs, -1)); } + XBT_ATTRIB_DEPRECATED_v332("Please use a plain vector for first parameter") + static int wait_any_for(std::vector* execs, double timeout) { return static_cast(wait_any_for(*execs, timeout)); } +#endif + + /** @brief On sequential executions, returns the amount of flops that remain to be done; This cannot be used on + * parallel executions. */ + double get_remaining() const override; + double get_remaining_ratio() const; ExecPtr set_host(Host* host); - ExecPtr set_name(std::string name); - ExecPtr set_tracing_category(std::string category); - Host* get_host(); - - double get_remaining() override; - double get_remaining_ratio(); - - //////////////// Deprecated functions - /** @deprecated See Exec::set_priority() */ - XBT_ATTRIB_DEPRECATED_v323("Please use Exec::set_priority()") ExecPtr setPriority(double priority) - { - return set_priority(priority); - } - /** @deprecated See Exec::set_bound() */ - XBT_ATTRIB_DEPRECATED_v323("Please use Exec::set_bound()") ExecPtr setBound(double bound) { return set_bound(bound); } - /** @deprecated See Exec::set_host() */ - XBT_ATTRIB_DEPRECATED_v323("Please use Exec::set_host()") ExecPtr setHost(Host* host) { return set_host(host); } - /** @deprecated See Exec::get_host() */ - XBT_ATTRIB_DEPRECATED_v323("Please use Exec::get_host()") Host* getHost() { return get_host(); } - /** @deprecated See Exec::get_remaining_ratio() */ - XBT_ATTRIB_DEPRECATED_v323("Please use Exec::get_remaining_ratio()") double getRemainingRatio() - { - return get_remaining_ratio(); - } - -private: - Host* host_ = nullptr; - double flops_amount_ = 0.0; - double priority_ = 1.0; - double bound_ = 0.0; - std::string name_ = ""; - std::string tracing_category_ = ""; - std::atomic_int_fast32_t refcount_{0}; -}; // class -} -}; // Namespace simgrid::s4u + ExecPtr set_hosts(const std::vector& hosts); + + ExecPtr set_flops_amount(double flops_amount); + ExecPtr set_flops_amounts(const std::vector& flops_amounts); + ExecPtr set_bytes_amounts(const std::vector& bytes_amounts); + + ExecPtr set_bound(double bound); + ExecPtr set_priority(double priority); + + Host* get_host() const; + unsigned int get_host_number() const; + double get_start_time() const; + double get_finish_time() const; + double get_cost() const; + bool is_parallel() const { return parallel_; } + bool is_assigned() const override; +}; + +} // namespace s4u +} // namespace simgrid #endif /* SIMGRID_S4U_EXEC_HPP */