A
lgorithmique
N
umérique
D
istribuée
Public GIT Repository
projects
/
simgrid.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
snake case this bool
[simgrid.git]
/
include
/
simgrid
/
s4u
/
Actor.hpp
diff --git
a/include/simgrid/s4u/Actor.hpp
b/include/simgrid/s4u/Actor.hpp
index
3167cfd
..
7e5c4f1
100644
(file)
--- a/
include/simgrid/s4u/Actor.hpp
+++ b/
include/simgrid/s4u/Actor.hpp
@@
-1,4
+1,4
@@
-/* Copyright (c) 2006-201
8
. The SimGrid Team. All rights reserved. */
+/* Copyright (c) 2006-201
9
. 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. */
/* 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. */
@@
-126,7
+126,7
@@
class XBT_PUBLIC Actor : public simgrid::xbt::Extendable<Actor> {
friend simgrid::kernel::actor::ActorImpl;
friend simgrid::kernel::activity::MailboxImpl;
friend simgrid::kernel::actor::ActorImpl;
friend simgrid::kernel::activity::MailboxImpl;
- kernel::actor::ActorImpl* pimpl_ = nullptr;
+ kernel::actor::ActorImpl*
const
pimpl_ = nullptr;
explicit Actor(smx_actor_t pimpl) : pimpl_(pimpl) {}
explicit Actor(smx_actor_t pimpl) : pimpl_(pimpl) {}
@@
-176,7
+176,7
@@
public:
*/
template <class F> static ActorPtr create(std::string name, s4u::Host* host, F code)
{
*/
template <class F> static ActorPtr create(std::string name, s4u::Host* host, F code)
{
- return create(
name
, host, std::function<void()>(std::move(code)));
+ return create(
std::move(name)
, host, std::function<void()>(std::move(code)));
}
/** Create an actor using a callable thing and its arguments.
}
/** Create an actor using a callable thing and its arguments.
@@
-187,11
+187,11
@@
public:
typename = typename std::result_of<F(Args...)>::type>
static ActorPtr create(std::string name, s4u::Host* host, F code, Args... args)
{
typename = typename std::result_of<F(Args...)>::type>
static ActorPtr create(std::string name, s4u::Host* host, F code, Args... args)
{
- return create(
name
, host, std::bind(std::move(code), std::move(args)...));
+ return create(
std::move(name)
, host, std::bind(std::move(code), std::move(args)...));
}
// Create actor from function name:
}
// Create actor from function name:
- static ActorPtr create(std::string name, s4u::Host* host,
std::string
function, std::vector<std::string> args);
+ static ActorPtr create(std::string name, s4u::Host* host,
const std::string&
function, std::vector<std::string> args);
// ***** Methods *****
/** This actor will be automatically terminated when the last non-daemon actor finishes **/
// ***** Methods *****
/** This actor will be automatically terminated when the last non-daemon actor finishes **/
@@
-211,14
+211,12
@@
public:
/** Retrieves the actor ID of that actor's creator */
aid_t get_ppid() const;
/** Retrieves the actor ID of that actor's creator */
aid_t get_ppid() const;
- /** Suspend an actor
by suspending the task on which it was waiting for the completion.
*/
+ /** Suspend an actor
, that is blocked until resume()ed by another actor
*/
void suspend();
void suspend();
- /** Resume a
suspended actor by resuming the task on which it was waiting for the completion.
*/
+ /** Resume a
n actor that was previously suspend()ed
*/
void resume();
void resume();
- void yield();
-
/** Returns true if the actor is suspended. */
bool is_suspended();
/** Returns true if the actor is suspended. */
bool is_suspended();
@@
-260,21
+258,25
@@
public:
*/
void kill();
*/
void kill();
- /** Kill an actor from its ID */
- static void kill(aid_t pid);
-
/** Retrieves the actor that have the given PID (or nullptr if not existing) */
static ActorPtr by_pid(aid_t pid);
/** Wait for the actor to finish.
*
/** Retrieves the actor that have the given PID (or nullptr if not existing) */
static ActorPtr by_pid(aid_t pid);
/** Wait for the actor to finish.
*
- * This blocks the calling actor until the actor on which we call join() is terminated
+ * Blocks the calling actor until the joined actor is terminated. If actor alice executes bob.join(), then alice is
+ * blocked until bob terminates.
*/
void join();
*/
void join();
+
+ /** Wait for the actor to finish, or for the timeout to elapse.
+ *
+ * Blocks the calling actor until the joined actor is terminated. If actor alice executes bob.join(), then alice is
+ * blocked until bob terminates.
+ */
void join(double timeout);
Actor* restart();
void join(double timeout);
Actor* restart();
- /**
Ask kindly to all actors to die. Only the issuer will survive
. */
+ /**
Kill all actors (but the issuer). Being killed is not something that actors can delay or avoid
. */
static void kill_all();
/** Returns the internal implementation of this actor */
static void kill_all();
/** Returns the internal implementation of this actor */
@@
-283,10
+285,12
@@
public:
/** Retrieve the property value (or nullptr if not set) */
std::unordered_map<std::string, std::string>*
get_properties(); // FIXME: do not export the map, but only the keys or something
/** Retrieve the property value (or nullptr if not set) */
std::unordered_map<std::string, std::string>*
get_properties(); // FIXME: do not export the map, but only the keys or something
- const char* get_property(
std::string
key);
- void set_property(
std::string
key, std::string value);
+ const char* get_property(
const std::string&
key);
+ void set_property(
const std::string&
key, std::string value);
#ifndef DOXYGEN
#ifndef DOXYGEN
+ XBT_ATTRIB_DEPRECATED_v325("Please use Actor::by_pid(pid).kill() instead") static void kill(aid_t pid);
+
/** @deprecated See Actor::create() */
XBT_ATTRIB_DEPRECATED_v323("Please use Actor::create()") static ActorPtr createActor(
const char* name, s4u::Host* host, std::function<void()> code)
/** @deprecated See Actor::create() */
XBT_ATTRIB_DEPRECATED_v323("Please use Actor::create()") static ActorPtr createActor(
const char* name, s4u::Host* host, std::function<void()> code)
@@
-387,8
+391,9
@@
namespace this_actor {
XBT_PUBLIC bool is_maestro();
XBT_PUBLIC bool is_maestro();
-/** Block the
actor sleeping for that amount of seconds (may throws
hostFailure) */
+/** Block the
current actor sleeping for that amount of seconds (may throw
hostFailure) */
XBT_PUBLIC void sleep_for(double duration);
XBT_PUBLIC void sleep_for(double duration);
+/** Block the current actor sleeping until the specified timestamp (may throw hostFailure) */
XBT_PUBLIC void sleep_until(double timeout);
template <class Rep, class Period> inline void sleep_for(std::chrono::duration<Rep, Period> duration)
XBT_PUBLIC void sleep_until(double timeout);
template <class Rep, class Period> inline void sleep_for(std::chrono::duration<Rep, Period> duration)
@@
-403,10
+408,10
@@
template <class Duration> inline void sleep_until(const SimulationTimePoint<Dura
this_actor::sleep_until(timeout_native.time_since_epoch().count());
}
this_actor::sleep_until(timeout_native.time_since_epoch().count());
}
-/** Block the actor, computing the given amount of flops */
+/** Block the
current
actor, computing the given amount of flops */
XBT_PUBLIC void execute(double flop);
XBT_PUBLIC void execute(double flop);
-/** Block the actor, computing the given amount of flops at the given priority.
+/** Block the
current
actor, computing the given amount of flops at the given priority.
* An execution of priority 2 computes twice as fast as an execution at priority 1. */
XBT_PUBLIC void execute(double flop, double priority);
* An execution of priority 2 computes twice as fast as an execution at priority 1. */
XBT_PUBLIC void execute(double flop, double priority);
@@
-414,7
+419,7
@@
XBT_PUBLIC void execute(double flop, double priority);
* @example examples/s4u/exec-ptask/s4u-exec-ptask.cpp
*/
* @example examples/s4u/exec-ptask/s4u-exec-ptask.cpp
*/
-/** Block the actor until the built parallel execution terminates
+/** Block the
current
actor until the built parallel execution terminates
*
* \rst
* .. _API_s4u_parallel_execute:
*
* \rst
* .. _API_s4u_parallel_execute:
@@
-464,22
+469,23
@@
XBT_PUBLIC void execute(double flop, double priority);
*
* \endrst
*/
*
* \endrst
*/
-XBT_PUBLIC void parallel_execute(
std::vector<s4u::Host*> hosts, std::vector<double>
flops_amounts,
-
std::vector<double>
bytes_amounts);
+XBT_PUBLIC void parallel_execute(
const std::vector<s4u::Host*>& hosts, const std::vector<double>&
flops_amounts,
+
const std::vector<double>&
bytes_amounts);
/** \rst
/** \rst
- * Block the
actor until the built :ref:`parallel execution <API_s4u_parallel_execute>` completes, or until the timeout.
- * \endrst
+ * Block the
current actor until the built :ref:`parallel execution <API_s4u_parallel_execute>` completes, or until the
+ *
timeout.
\endrst
*/
*/
-XBT_PUBLIC void parallel_execute(
std::vector<s4u::Host*> hosts, std::vector<double>
flops_amounts,
-
std::vector<double>
bytes_amounts, double timeout);
+XBT_PUBLIC void parallel_execute(
const std::vector<s4u::Host*>& hosts, const std::vector<double>&
flops_amounts,
+
const std::vector<double>&
bytes_amounts, double timeout);
#ifndef DOXYGEN
XBT_ATTRIB_DEPRECATED_v325("Please use std::vectors as parameters") XBT_PUBLIC
#ifndef DOXYGEN
XBT_ATTRIB_DEPRECATED_v325("Please use std::vectors as parameters") XBT_PUBLIC
- void parallel_execute(int host_nb, s4u::Host** host_list, double* flops_amount, double* bytes_amount);
+ void parallel_execute(int host_nb, s4u::Host* const* host_list, const double* flops_amount,
+ const double* bytes_amount);
XBT_ATTRIB_DEPRECATED_v325("Please use std::vectors as parameters") XBT_PUBLIC
XBT_ATTRIB_DEPRECATED_v325("Please use std::vectors as parameters") XBT_PUBLIC
- void parallel_execute(int host_nb, s4u::Host*
* host_list, double* flops_amount, double* byte
s_amount,
- double timeout);
+ void parallel_execute(int host_nb, s4u::Host*
const* host_list, const double* flop
s_amount,
+
const double* bytes_amount,
double timeout);
#endif
XBT_PUBLIC ExecPtr exec_init(double flops_amounts);
#endif
XBT_PUBLIC ExecPtr exec_init(double flops_amounts);
@@
-496,27
+502,25
@@
XBT_PUBLIC std::string get_name();
/** @brief Returns the name of the current actor as a C string. */
XBT_PUBLIC const char* get_cname();
/** @brief Returns the name of the current actor as a C string. */
XBT_PUBLIC const char* get_cname();
-/** @brief Returns the name of the host on which the actor is running. */
+/** @brief Returns the name of the host on which the
curret
actor is running. */
XBT_PUBLIC Host* get_host();
XBT_PUBLIC Host* get_host();
-/** @brief Suspend the actor. */
+/** @brief Suspend the
current actor, that is blocked until resume()ed by another
actor. */
XBT_PUBLIC void suspend();
XBT_PUBLIC void suspend();
-/** @brief Yield the actor. */
+/** @brief Yield the
current
actor. */
XBT_PUBLIC void yield();
XBT_PUBLIC void yield();
-/** @brief Resume the
actor
. */
+/** @brief Resume the
current actor, that was suspend()ed previously
. */
XBT_PUBLIC void resume();
XBT_PUBLIC void resume();
-XBT_PUBLIC bool is_suspended();
-
-/** @brief kill the actor. */
+/** @brief kill the current actor. */
XBT_PUBLIC void exit();
XBT_PUBLIC void exit();
-/** @brief Add a function to the list of "on_exit" functions. */
+/** @brief Add a function to the list of "on_exit" functions
of the current actor
. */
XBT_PUBLIC void on_exit(std::function<void(int, void*)> fun, void* data);
XBT_PUBLIC void on_exit(std::function<void(int, void*)> fun, void* data);
-/** @brief Migrate the actor to a new host. */
+/** @brief Migrate the
current
actor to a new host. */
XBT_PUBLIC void migrate(Host* new_host);
/** @} */
XBT_PUBLIC void migrate(Host* new_host);
/** @} */
@@
-537,8
+541,6
@@
XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::get_pid()") XBT_PUBLIC aid_t
XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::get_ppid()") XBT_PUBLIC aid_t getPpid();
/** @deprecated See this_actor::get_host() */
XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::get_host()") XBT_PUBLIC Host* getHost();
XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::get_ppid()") XBT_PUBLIC aid_t getPpid();
/** @deprecated See this_actor::get_host() */
XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::get_host()") XBT_PUBLIC Host* getHost();
-/** @deprecated See this_actor::is_suspended() */
-XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::is_suspended()") XBT_PUBLIC bool isSuspended();
/** @deprecated See this_actor::on_exit() */
XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::on_exit()") XBT_PUBLIC void onExit(int_f_pvoid_pvoid_t fun, void* data);
/** @deprecated See this_actor::exit() */
/** @deprecated See this_actor::on_exit() */
XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::on_exit()") XBT_PUBLIC void onExit(int_f_pvoid_pvoid_t fun, void* data);
/** @deprecated See this_actor::exit() */