Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Sanitize the prototype of Actor::on_exit() callbacks
[simgrid.git] / src / bindings / python / simgrid_python.cpp
index 5c4f434..ca67538 100644 (file)
@@ -3,15 +3,22 @@
 /* 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. */
 
+#ifdef _WIN32
+#warning Try to work around https://bugs.python.org/issue11566
+#define _hypot hypot
+#endif
+
+#include <pybind11/functional.h>
+#include <pybind11/pybind11.h> // Must come before our own stuff
+#include <pybind11/stl.h>
+
 #include "src/kernel/context/Context.hpp"
+#include <simgrid/Exception.hpp>
 #include <simgrid/s4u/Actor.hpp>
 #include <simgrid/s4u/Engine.hpp>
 #include <simgrid/s4u/Host.hpp>
 #include <simgrid/s4u/Mailbox.hpp>
 
-#include <pybind11/pybind11.h>
-#include <pybind11/stl.h>
-
 #include <memory>
 #include <string>
 #include <vector>
@@ -31,7 +38,9 @@ namespace {
 
 static std::string get_simgrid_version()
 {
-  int major, minor, patch;
+  int major;
+  int minor;
+  int patch;
   sg_version_get(&major, &minor, &patch);
   return simgrid::xbt::string_printf("%i.%i.%i", major, minor, patch);
 }
@@ -48,7 +57,7 @@ PYBIND11_MODULE(simgrid, m)
   m.attr("simgrid_version") = simgrid_version;
 
   // Internal exception used to kill actors and sweep the RAII chimney (free objects living on the stack)
-  py::object pyStopRequestEx = py::register_exception<simgrid::kernel::context::Context::StopRequest>(m, "ActorKilled");
+  py::object pyForcefulKillEx = py::register_exception<simgrid::ForcefulKillException>(m, "ActorKilled");
 
   /* this_actor namespace */
   void (*sleep_for_fun)(double) = &simgrid::s4u::this_actor::sleep_for; // pick the right overload
@@ -61,7 +70,7 @@ PYBIND11_MODULE(simgrid, m)
          "Block the current actor, computing the given amount of flops at the given priority, see :cpp:func:`void "
          "simgrid::s4u::this_actor::execute(double, double)`",
          py::arg("flops"), py::arg("priority") = 1);
-  m2.def("get_host", &simgrid::s4u::this_actor::get_host, "Retrives host on which the current actor is located");
+  m2.def("get_host", &simgrid::s4u::this_actor::get_host, "Retrieves host on which the current actor is located");
   m2.def("migrate", &simgrid::s4u::this_actor::migrate, "Moves the current actor to another host, see :cpp:func:`void simgrid::s4u::this_actor::migrate()`",
       py::arg("dest"));
   m2.def("sleep_for", sleep_for_fun,
@@ -71,7 +80,19 @@ PYBIND11_MODULE(simgrid, m)
   m2.def("suspend", &simgrid::s4u::this_actor::suspend, "Suspend the current actor, that is blocked until resume()ed by another actor. see :cpp:func:`void simgrid::s4u::this_actor::suspend`");
   m2.def("yield_", &simgrid::s4u::this_actor::yield,
          "Yield the actor, see :cpp:func:`void simgrid::s4u::this_actor::yield()`");
-  m2.def("exit", &simgrid::s4u::this_actor::exit);
+  m2.def("exit", &simgrid::s4u::this_actor::exit, "kill the current actor");
+  m2.def("on_exit",
+         [](py::object fun) {
+           ActorPtr act = Actor::self();
+           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());
+             }
+           });
+         },
+         "");
 
   /* Class Engine */
   py::class_<Engine>(m, "Engine", "Simulation Engine, see :ref:`class s4u::Engine <API_s4u_Engine>`")
@@ -86,7 +107,7 @@ PYBIND11_MODULE(simgrid, m)
         return new simgrid::s4u::Engine(&argc, argv.get());
       }))
       .def("get_all_hosts", &Engine::get_all_hosts, "Returns the list of all hosts found in the platform")
-      .def("get_clock", &Engine::get_clock, "Retrieve the simulation time")
+      .def("get_clock", &Engine::get_clock, "Retrieve the simulation time (in seconds)")
       .def("load_platform", &Engine::load_platform,
            "Load a platform file describing the environment, see :cpp:func:`simgrid::s4u::Engine::load_platform()`")
       .def("load_deployment", &Engine::load_deployment,
@@ -94,10 +115,10 @@ PYBIND11_MODULE(simgrid, m)
            ":cpp:func:`simgrid::s4u::Engine::load_deployment()`")
       .def("run", &Engine::run, "Run the simulation")
       .def("register_actor",
-           [pyStopRequestEx](Engine*, std::string name, py::object fun_or_class) {
+           [pyForcefulKillEx](Engine*, const std::string& name, py::object fun_or_class) {
              simgrid::simix::register_function(
-                 name, [pyStopRequestEx, fun_or_class](std::vector<std::string> args) -> simgrid::simix::ActorCode {
-                   return [pyStopRequestEx, fun_or_class, args]() {
+                 name, [pyForcefulKillEx, fun_or_class](std::vector<std::string> args) -> simgrid::simix::ActorCode {
+                   return [pyForcefulKillEx, fun_or_class, args]() {
                      try {
                        /* Convert the std::vector into a py::tuple */
                        py::tuple params(args.size() - 1);
@@ -110,9 +131,9 @@ PYBIND11_MODULE(simgrid, m)
                        if (py::isinstance<py::function>(res))
                          res();
                      } catch (py::error_already_set& ex) {
-                       if (ex.matches(pyStopRequestEx)) {
+                       if (ex.matches(pyForcefulKillEx)) {
                          XBT_VERB("Actor killed");
-                         /* Stop here that StopRequest exception which was meant to free the RAII stuff on the stack */
+                         /* Stop here that ForcefulKill exception which was meant to free the RAII stuff on the stack */
                        } else {
                          throw;
                        }
@@ -154,16 +175,16 @@ PYBIND11_MODULE(simgrid, m)
                                             "application, see :ref:`class s4u::Actor <API_s4u_Actor>`")
 
       .def("create",
-           [pyStopRequestEx](py::str name, py::object host, py::object fun, py::args args) {
+           [pyForcefulKillEx](py::str name, py::object host, py::object fun, py::args args) {
 
-             return simgrid::s4u::Actor::create(name, host.cast<Host*>(), [fun, args, pyStopRequestEx]() {
+             return simgrid::s4u::Actor::create(name, host.cast<Host*>(), [fun, args, pyForcefulKillEx]() {
 
                try {
                  fun(*args);
                } catch (py::error_already_set& ex) {
-                 if (ex.matches(pyStopRequestEx)) {
+                 if (ex.matches(pyForcefulKillEx)) {
                    XBT_VERB("Actor killed");
-                   /* Stop here that StopRequest exception which was meant to free the RAII stuff on the stack */
+                   /* Stop here that ForcefulKill exception which was meant to free the RAII stuff on the stack */
                  } else {
                    throw;
                  }
@@ -172,11 +193,15 @@ PYBIND11_MODULE(simgrid, m)
            },
            "Create an actor from a function or an object, see :cpp:func:`simgrid::s4u::Actor::create()`")
       .def_property("host", &Actor::get_host, &Actor::migrate, "The host on which this actor is located")
+      .def_property_readonly("pid", &Actor::get_pid, "The PID (unique identifier) of this actor.")
+      .def("by_pid", &Actor::by_pid, "Retrieve an actor by its PID")
       .def("daemonize", &Actor::daemonize,
            "This actor will be automatically terminated when the last non-daemon actor finishes, see :cpp:func:`void "
            "simgrid::s4u::Actor::daemonize()`")
       .def("join", py::overload_cast<double>(&Actor::join),
            "Wait for the actor to finish, see :cpp:func:`void simgrid::s4u::Actor::join(double)`", py::arg("timeout"))
+      .def("kill", [](ActorPtr act) { act->kill(); }, "Kill that actor")
+      .def("kill_all", &Actor::kill_all, "Kill all actors but the caller.")
       .def("migrate", &Actor::migrate,
            "Moves that actor to another host, see :cpp:func:`void simgrid::s4u::Actor::migrate()`", py::arg("dest"))
       .def("self", &Actor::self, "Retrieves the current actor, see :cpp:func:`void simgrid::s4u::Actor::self()`")