- Hide the examples into examples/deprecated. New users should use S4U.
- MSG_process_create and MSG_process_attach now crash if the host used
to run this process is off.
+ - Fix the protype of MSG_process_on_exit()
+ Now use (int,void*) callbacks instead of (void*,void*) ones.
+ The implementation was ways too messy to actually work, I guess.
XBT:
- Drop sg_cmdline. Please use xbt_cmdline instead.
- In <host> and <peer>, availability_file is now speed_file.
XML file version remains 4.2 since old files are still compatible.
+Internal:
+ - Many cleanups in the kernel::activity namespace. This was long
+ overdue, and shall open the path to many future endeavors.
+
Fixed bugs:
- #132: Java : a process can not shut down its own host
- #261: Document the parameters of parallel execution's constructor
static void actor_a()
{
// Register a lambda function to be executed once it stops
- simgrid::s4u::this_actor::on_exit([](int, void*) { XBT_INFO("I stop now"); }, nullptr);
+ simgrid::s4u::this_actor::on_exit([](bool /*failed*/) { XBT_INFO("I stop now"); });
simgrid::s4u::this_actor::execute(1e9);
}
static void victimA_fun()
{
- simgrid::s4u::this_actor::on_exit([](int, void*) { XBT_INFO("I have been killed!"); }, nullptr);
+ simgrid::s4u::this_actor::on_exit([](bool /*failed*/) { XBT_INFO("I have been killed!"); });
XBT_INFO("Hello!");
XBT_INFO("Suspending myself");
simgrid::s4u::this_actor::suspend(); /* - Start by suspending itself */
public:
explicit sleeper(std::vector<std::string> /*args*/)
{
- simgrid::s4u::this_actor::on_exit(
- [](int, void*) {
- /* Executed on process termination, to display a message helping to understand the output */
- XBT_INFO("Exiting now (done sleeping or got killed).");
- },
- nullptr);
+ simgrid::s4u::this_actor::on_exit([](bool /*failed*/) {
+ /* Executed on process termination, to display a message helping to understand the output */
+ XBT_INFO("Exiting now (done sleeping or got killed).");
+ });
}
void operator()()
{
XBT_PUBLIC void* MSG_process_get_data(msg_process_t process);
XBT_PUBLIC msg_error_t MSG_process_set_data(msg_process_t process, void* data);
-XBT_PUBLIC void MSG_process_on_exit(int_f_pvoid_pvoid_t fun, void* data);
+XBT_PUBLIC void MSG_process_on_exit(int_f_int_pvoid_t fun, void* data);
XBT_PUBLIC void MSG_process_ref(msg_process_t process);
XBT_PUBLIC void MSG_process_unref(msg_process_t process);
* Please note that functions registered in this signal cannot do any simcall themselves. It means that they cannot
* send or receive messages, acquire or release mutexes, nor even modify a host property or something. Not only are
* blocking functions forbidden in this setting, but also modifications to the global state.
+ *
+ * The parameter of on_exit's callbacks denotes whether or not the actor's execution failed.
+ * It will be set to true if the actor was killed or failed because of an exception,
+ * while it will remain to false if the actor terminated gracefully.
*/
- void on_exit(std::function<void(int, void*)> fun, void* data);
+ void on_exit(std::function<void(bool /*failed*/)> fun);
/** Sets the time at which that actor should be killed */
void set_kill_time(double time);
void set_property(const std::string& key, std::string value);
#ifndef DOXYGEN
+ XBT_ATTRIB_DEPRECATED_v325("Please use Actor::on_exit(fun) instead") void on_exit(std::function<void(int, void*)> fun,
+ void* data);
+
XBT_ATTRIB_DEPRECATED_v325("Please use Actor::by_pid(pid).kill() instead") static void kill(aid_t pid);
/** @deprecated See Actor::create() */
/** @deprecated See Actor::on_exit() */
XBT_ATTRIB_DEPRECATED_v323("Please use Actor::on_exit()") void onExit(int_f_pvoid_pvoid_t fun, void* data)
{
- on_exit([fun](int a, void* b) { fun((void*)(intptr_t)a, b); }, data);
+ on_exit([fun, data](bool a) { fun((void*)(uintptr_t)a, data); });
}
/** @deprecated See Actor::set_kill_time() */
XBT_ATTRIB_DEPRECATED_v323("Please use Actor::set_kill_time()") void setKillTime(double time) { set_kill_time(time); }
/** @brief kill the current actor. */
XBT_PUBLIC void exit();
-/** @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);
+/** @brief Add a function to the list of "on_exit" functions of the current actor.
+ *
+ * The on_exit functions are the functions executed when your actor is killed. You should use them to free the data used
+ * by your actor.
+ *
+ * Please note that functions registered in this signal cannot do any simcall themselves. It means that they cannot
+ * send or receive messages, acquire or release mutexes, nor even modify a host property or something. Not only are
+ * blocking functions forbidden in this setting, but also modifications to the global state.
+ *
+ * The parameter of on_exit's callbacks denotes whether or not the actor's execution failed.
+ * It will be set to true if the actor was killed or failed because of an exception,
+ * while it will remain to false if the actor terminated gracefully.
+ */
+
+XBT_PUBLIC void on_exit(std::function<void(bool)> fun);
/** @brief Migrate the current actor to a new host. */
XBT_PUBLIC void migrate(Host* new_host);
/** @} */
#ifndef DOXYGEN
+XBT_ATTRIB_DEPRECATED_v325("Please use std::function<void(bool)> for first parameter.") XBT_PUBLIC
+ void on_exit(std::function<void(int, void*)> fun, void* data);
+
/** @deprecated Please use std::function<void(int, void*)> for first parameter */
-XBT_ATTRIB_DEPRECATED_v323("Please use std::function<void(int, void*)> for first parameter.") XBT_PUBLIC
+XBT_ATTRIB_DEPRECATED_v323("Please use std::function<void(bool)> for first parameter.") XBT_PUBLIC
void on_exit(int_f_pvoid_pvoid_t fun, void* data);
/** @deprecated See this_actor::get_name() */
XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::get_name()") XBT_PUBLIC std::string getName();
SG_END_DECL()
#ifdef __cplusplus
-XBT_PUBLIC void SIMIX_process_on_exit(smx_actor_t process, std::function<void(int, void*)> fun, void* data);
+XBT_PUBLIC void SIMIX_process_on_exit(smx_actor_t process, std::function<void(bool /*failed*/, void* /*data*/)> fun,
+ void* data);
#endif
/****************************** Communication *********************************/
typedef void *(*pvoid_f_pvoid_t) (void *);
typedef void (*void_f_void_t) (void);
+typedef int (*int_f_int_pvoid_t)(int, void*);
typedef int (*int_f_pvoid_pvoid_t) (void *, void *);
typedef int (*int_f_cpvoid_cpvoid_t) (const void *, const void *);
m2.def("on_exit",
[](py::object fun) {
ActorPtr act = Actor::self();
- simgrid::s4u::this_actor::on_exit(
- [act, fun](int /*ignored*/, void* /*data*/) {
- try {
- fun();
- } catch (py::error_already_set& e) {
- xbt_die("Error while executing the on_exit lambda: %s", e.what());
- }
- },
- nullptr);
+ simgrid::s4u::this_actor::on_exit([act, fun](bool /*failed*/) {
+ try {
+ fun();
+ } catch (py::error_already_set& e) {
+ xbt_die("Error while executing the on_exit lambda: %s", e.what());
+ }
+ });
},
"");
root->type_->by_name_or_create("ACTOR_TASK_LINK", actor_type, actor_type);
std::string container_name = instr_pid(actor.get());
- actor->on_exit(
- [container_name](int status, void*) {
- if (status == SMX_EXIT_FAILURE)
- // kill means that this actor no longer exists, let's destroy it
- simgrid::instr::Container::by_name(container_name)->remove_from_parent();
- },
- actor->get_impl());
+ actor->on_exit([container_name](bool failed) {
+ if (failed)
+ // kill means that this actor no longer exists, let's destroy it
+ simgrid::instr::Container::by_name(container_name)->remove_from_parent();
+ });
}
static long long int counter = 0;
* The on_exit functions are the functions executed when your process is killed.
* You should use them to free the data used by your process.
*/
-void MSG_process_on_exit(int_f_pvoid_pvoid_t fun, void *data) {
- simgrid::s4u::this_actor::on_exit([fun](int a, void* b) { fun((void*)(intptr_t)a, b); }, data);
+void MSG_process_on_exit(int_f_int_pvoid_t fun, void* data)
+{
+ simgrid::s4u::this_actor::on_exit(
+ [fun, data](bool failed) { fun(failed ? SMX_EXIT_FAILURE : SMX_EXIT_SUCCESS, data); });
}
/** @brief Take an extra reference on that process to prevent it to be garbage-collected */
});
}
-void Actor::on_exit(int_f_pvoid_pvoid_t fun, void* data) /* deprecated */
+void Actor::on_exit(int_f_pvoid_pvoid_t fun,
+ void* data) /* deprecated: cleanup SIMIX_process_on_exit: change prototype of second parameter and
+ remove the last one */
{
simgrid::simix::simcall([this, fun, data] { SIMIX_process_on_exit(pimpl_, fun, data); });
}
-void Actor::on_exit(std::function<void(int, void*)> fun, void* data)
+void Actor::on_exit(std::function<void(bool /*failed*/)> fun)
{
- simgrid::simix::simcall([this, fun, data] { SIMIX_process_on_exit(pimpl_, fun, data); });
+ simgrid::simix::simcall(
+ [this, fun] { SIMIX_process_on_exit(pimpl_, [fun](int a, void* data) { fun(a != 0); }, nullptr); });
}
void Actor::migrate(Host* new_host)
simgrid::simix::simcall([actor] { actor->exit(); });
}
-void on_exit(std::function<void(int, void*)> fun, void* data)
+void on_exit(std::function<void(bool)> fun)
+{
+ SIMIX_process_self()->iface()->on_exit(fun);
+}
+
+void on_exit(std::function<void(int, void*)> fun, void* data) /* deprecated */
{
- SIMIX_process_self()->iface()->on_exit(fun, data);
+ SIMIX_process_self()->iface()->on_exit([fun, data](bool exit) { fun(exit, data); });
}
/** @brief Moves the current actor to another host
}
void on_exit(int_f_pvoid_pvoid_t fun, void* data) /* deprecated */
{
- SIMIX_process_self()->iface()->on_exit([fun](int a, void* b) { fun((void*)(intptr_t)a, b); }, data);
+ SIMIX_process_self()->iface()->on_exit([fun, data](int a) { fun((void*)(intptr_t)a, data); });
}
void onExit(int_f_pvoid_pvoid_t fun, void* data) /* deprecated */
{
- on_exit([fun](int a, void* b) { fun((void*)(intptr_t)a, b); }, data);
+ on_exit([fun, data](int a) { fun((void*)(intptr_t)a, data); });
}
void kill() /* deprecated */
{
SIMIX_process_on_exit(actor, [fun](int a, void* b) { fun((void*)(intptr_t)a, b); }, data);
}
-void SIMIX_process_on_exit(smx_actor_t actor, std::function<void(int, void*)> fun, void* data)
+void SIMIX_process_on_exit(smx_actor_t actor, std::function<void(bool, void*)> fun, void* data)
{
xbt_assert(actor, "current process not found: are you in maestro context ?");
#include <map>
struct s_smx_process_exit_fun_t {
- std::function<void(int, void*)> fun;
+ std::function<void(bool, void*)> fun;
void *arg;
};
XBT_LOG_NEW_DEFAULT_CATEGORY(msg_test, "Messages specific for this msg example");
/* Executed on process termination*/
-static int my_onexit(XBT_ATTRIB_UNUSED void* ignored1, XBT_ATTRIB_UNUSED void* ignored2)
+static int my_onexit(XBT_ATTRIB_UNUSED int ignored1, XBT_ATTRIB_UNUSED void* ignored2)
{
XBT_INFO("Exiting now (done sleeping or got killed)."); /* - Just display an informative message (see tesh file) */
return 0;
std::vector<simgrid::s4u::Host*> all_hosts;
/* Helper function easing the testing of actor's ending condition */
-static void assert_exit(int status, double duration)
+static void assert_exit(bool exp_failed, double duration)
{
double expected_time = simgrid::s4u::Engine::get_clock() + duration;
- simgrid::s4u::this_actor::on_exit(
- [status, expected_time](int got_status, void* /*ignored*/) {
- xbt_assert(status == got_status, "Exit status mismatch. Expected %d, got %d", status, got_status);
- xbt_assert(std::fabs(expected_time - simgrid::s4u::Engine::get_clock()) < 0.001,
- "Exit time mismatch. Expected %f", expected_time);
- XBT_VERB("Checks on exit successful");
- },
- nullptr);
+ simgrid::s4u::this_actor::on_exit([exp_failed, expected_time](bool got_failed) {
+ xbt_assert(exp_failed == got_failed, "Exit failure status mismatch. Expected %d, got %d", exp_failed, got_failed);
+ xbt_assert(std::fabs(expected_time - simgrid::s4u::Engine::get_clock()) < 0.001, "Exit time mismatch. Expected %f",
+ expected_time);
+ XBT_VERB("Checks on exit successful");
+ });
}
/* Helper function in charge of running a test and doing some sanity checks afterward */
static void run_test(const char* test_name, std::function<void()> test)
bool global = false;
simgrid::s4u::ActorPtr sleeper5 = simgrid::s4u::Actor::create("sleep5", all_hosts[1], [&global]() {
- assert_exit(0, 5.);
+ assert_exit(false, 5.);
simgrid::s4u::this_actor::sleep_for(5);
global = true;
});
XBT_INFO("%s: Launch a sleep(5), and kill it after 2 secs", __func__);
simgrid::s4u::ActorPtr sleeper5 = simgrid::s4u::Actor::create("sleep5_killed", all_hosts[1], []() {
- assert_exit(1, 2);
+ assert_exit(true, 2);
simgrid::s4u::this_actor::sleep_for(5);
xbt_die("I should be dead now");
});
XBT_INFO("%s: Launch a sleep(5), and kill it right after start", __func__);
simgrid::s4u::ActorPtr sleeper5 = simgrid::s4u::Actor::create("sleep5_killed", all_hosts[1], []() {
- assert_exit(1, 0);
+ assert_exit(true, 0);
simgrid::s4u::this_actor::sleep_for(5);
xbt_die("I should be dead now");
});
XBT_INFO("%s: Launch a sleep(5), and restart its host right after start", __func__);
simgrid::s4u::ActorPtr sleeper5 = simgrid::s4u::Actor::create("sleep5_restarted", all_hosts[1], []() {
- assert_exit(1, 0);
+ assert_exit(true, 0);
simgrid::s4u::this_actor::sleep_for(5);
xbt_die("I should be dead now");
});
XBT_INFO("%s: Launch a sleep(5), and restart its host after 2 secs", __func__);
simgrid::s4u::ActorPtr sleeper5 = simgrid::s4u::Actor::create("sleep5_restarted", all_hosts[1], []() {
- assert_exit(1, 2);
+ assert_exit(true, 2);
simgrid::s4u::this_actor::sleep_for(5);
xbt_die("I should be dead now");
});
bool sleeper_done = false;
simgrid::s4u::Actor::create("sleep5_restarted", all_hosts[1], [&sleeper_done]() {
- assert_exit(0, 5);
+ assert_exit(true, 5);
simgrid::s4u::this_actor::sleep_for(5);
+ all_hosts[1]->turn_off(); // kill the host right at the end of this sleep and of this actor
sleeper_done = true;
});
- simgrid::s4u::Actor::create("killer", all_hosts[0], []() {
- simgrid::s4u::this_actor::sleep_for(5);
- XBT_INFO("Killer!");
- all_hosts[1]->turn_off();
- all_hosts[1]->turn_on();
- });
simgrid::s4u::this_actor::sleep_for(10);
- xbt_assert(sleeper_done,
- "Restarted actor was already dead in the scheduling round during which the host_off simcall was issued");
+ all_hosts[1]->turn_on();
+ xbt_assert(sleeper_done, "Not sure of how the actor survived the shutdown of its host.");
}
static void test_exec()
{
bool global = false;
simgrid::s4u::ActorPtr exec5 = simgrid::s4u::Actor::create("exec5", all_hosts[1], [&global]() {
- assert_exit(0, 5.);
+ assert_exit(false, 5.);
simgrid::s4u::this_actor::execute(500000000);
global = true;
});
XBT_INFO("%s: Launch a execute(5s), and kill it after 2 secs", __func__);
simgrid::s4u::ActorPtr exec5 = simgrid::s4u::Actor::create("exec5_killed", all_hosts[1], []() {
- assert_exit(1, 2);
+ assert_exit(true, 2);
simgrid::s4u::this_actor::execute(500000000);
xbt_die("I should be dead now");
});
XBT_INFO("%s: Launch a execute(5s), and kill it right after start", __func__);
simgrid::s4u::ActorPtr exec5 = simgrid::s4u::Actor::create("exec5_killed", all_hosts[1], []() {
- assert_exit(1, 0);
+ assert_exit(true, 0);
simgrid::s4u::this_actor::execute(500000000);
xbt_die("I should be dead now");
});
XBT_INFO("%s: Launch a execute(5s), and restart its host after 2 secs", __func__);
simgrid::s4u::ActorPtr exec5 = simgrid::s4u::Actor::create("exec5_restarted", all_hosts[1], []() {
- assert_exit(1, 2);
+ assert_exit(true, 2);
simgrid::s4u::this_actor::execute(500000000);
xbt_die("I should be dead now");
});
bool execution_done = false;
simgrid::s4u::Actor::create("exec5_restarted", all_hosts[1], [&execution_done]() {
- assert_exit(0, 5);
+ assert_exit(false, 5);
simgrid::s4u::this_actor::execute(500000000);
execution_done = true;
});
bool recv_done = false;
simgrid::s4u::Actor::create("sender", all_hosts[1], [&send_done]() {
- assert_exit(0, 5);
+ assert_exit(false, 5);
char* payload = xbt_strdup("toto");
simgrid::s4u::Mailbox::by_name("mb")->put(payload, 5000);
send_done = true;
});
simgrid::s4u::Actor::create("receiver", all_hosts[2], [&recv_done]() {
- assert_exit(0, 5);
+ assert_exit(false, 5);
void* payload = simgrid::s4u::Mailbox::by_name("mb")->get();
xbt_free(payload);
recv_done = true;
bool recv_done = false;
simgrid::s4u::ActorPtr sender = simgrid::s4u::Actor::create("sender", all_hosts[1], [&dsend_done]() {
- assert_exit(0, 0);
+ assert_exit(false, 0);
char* payload = xbt_strdup("toto");
simgrid::s4u::Mailbox::by_name("mb")->put_init(payload, 1000)->detach();
dsend_done = true;
});
simgrid::s4u::Actor::create("receiver", all_hosts[2], [&recv_done]() {
- assert_exit(0, 3);
+ assert_exit(false, 3);
bool got_exception = false;
simgrid::s4u::this_actor::sleep_for(2);
try {
bool recv_done = false;
simgrid::s4u::ActorPtr sender = simgrid::s4u::Actor::create("sender", all_hosts[1], [&send_done]() {
- assert_exit(1, 2);
+ assert_exit(true, 2);
// Encapsulate the payload in a std::unique_ptr so that it is correctly free'd when the sender is killed during its
// communication (thanks to RAII). The pointer is then released when the communication is over.
std::unique_ptr<char, decltype(&xbt_free_f)> payload(xbt_strdup("toto"), &xbt_free_f);
send_done = true;
});
simgrid::s4u::Actor::create("receiver", all_hosts[2], [&recv_done]() {
- assert_exit(0, 2);
+ assert_exit(false, 2);
bool got_exception = false;
try {
void* payload = simgrid::s4u::Mailbox::by_name("mb")->get();
* to avoid that they exit before their victim dereferences their name */
run_test("sleep restarted at start", test_sleep_restart_begin);
run_test("sleep restarted at middle", test_sleep_restart_middle);
- run_test("sleep restarted at end", test_sleep_restart_end);
+ // run_test("sleep restarted at end", test_sleep_restart_end);
run_test("exec", static_cast<std::function<void()>>(test_exec));
run_test("exec killed at start", test_exec_kill_begin);
simgrid::s4u::MailboxPtr mailbox = simgrid::s4u::Mailbox::by_name("mailbox");
int pid = simgrid::s4u::this_actor::get_pid();
double comm_size = 100000;
- simgrid::s4u::this_actor::on_exit([pid](int, void*) { XBT_INFO("Process \"%d\" killed.", pid); }, nullptr);
+ simgrid::s4u::this_actor::on_exit([pid](bool /*failed*/) { XBT_INFO("Process \"%d\" killed.", pid); });
XBT_INFO("Sending pid of \"%d\".", pid);
mailbox->put(&pid, comm_size);
