Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Various doc improvements
[simgrid.git] / src / bindings / python / simgrid_python.cpp
index 15eae3d..1a02f46 100644 (file)
@@ -47,6 +47,9 @@ 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");
+
   /* this_actor namespace */
   void (*sleep_for_fun)(double) = &simgrid::s4u::this_actor::sleep_for; // pick the right overload
   void (*sleep_until_fun)(double) = &simgrid::s4u::this_actor::sleep_until;
@@ -67,6 +70,7 @@ 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);
 
   /* Class Engine */
   py::class_<Engine>(m, "Engine", "Simulation Engine, see :ref:`class s4u::Engine <API_s4u_Engine>`")
@@ -83,32 +87,39 @@ PYBIND11_MODULE(simgrid, m)
       .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("load_platform", &Engine::load_platform,
-          "Load a platform file describing the environment, see :cpp:func:`simgrid::s4u::Engine::load_platform()`")
+           "Load a platform file describing the environment, see :cpp:func:`simgrid::s4u::Engine::load_platform()`")
       .def("load_deployment", &Engine::load_deployment,
-          "Load a deployment file and launch the actors that it contains, see :cpp:func:`simgrid::s4u::Engine::load_deployment()`")
+           "Load a deployment file and launch the actors that it contains, see "
+           ":cpp:func:`simgrid::s4u::Engine::load_deployment()`")
       .def("run", &Engine::run, "Run the simulation")
-      .def("register_actor", [](Engine*, std::string name, py::object obj) {
-        simgrid::simix::register_function(name,
-            [obj](std::vector<std::string> args) -> simgrid::simix::ActorCode {
-          return [obj, args]() {
-            /* Convert the std::vector into a py::tuple */
-            py::tuple params(args.size()-1);
-            for (size_t i=1; i<args.size(); i++)
-              params[i-1] = py::cast(args[i]);
-
-            PyObject *result = PyObject_CallObject(obj.ptr(), params.ptr());
-            if (!result)
-                throw pybind11::error_already_set();
-
-            /* If I was passed a class, I just built an instance, so I need to call it now */
-            if (PyCallable_Check(result)) {
-              py::object obj2 = pybind11::reinterpret_steal<py::object>(pybind11::handle(static_cast<PyObject*>(result)));
-              obj2();
-            }
-          };
-        });
-      }, "Registers the main function of an actor, see :cpp:func:`simgrid::s4u::Engine::register_function()`")
-      ;
+      .def("register_actor",
+           [pyStopRequestEx](Engine*, 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]() {
+                     try {
+                       /* Convert the std::vector into a py::tuple */
+                       py::tuple params(args.size() - 1);
+                       for (size_t i = 1; i < args.size(); i++)
+                         params[i - 1] = py::cast(args[i]);
+
+                       py::object res = fun_or_class(*params);
+
+                       /* If I was passed a class, I just built an instance, so I need to call it now */
+                       if (py::isinstance<py::function>(res))
+                         res();
+                     } catch (py::error_already_set& ex) {
+                       if (ex.matches(pyStopRequestEx)) {
+                         XBT_VERB("Actor killed");
+                         /* Stop here that StopRequest exception which was meant to free the RAII stuff on the stack */
+                       } else {
+                         throw;
+                       }
+                     }
+                   };
+                 });
+           },
+           "Registers the main function of an actor, see :cpp:func:`simgrid::s4u::Engine::register_function()`");
 
   /* Class Host */
   py::class_<simgrid::s4u::Host, std::unique_ptr<Host, py::nodelete>>(m, "Host", "Simulation Engine, see :ref:`class s4u::Host <API_s4u_Host>`")
@@ -137,7 +148,6 @@ PYBIND11_MODULE(simgrid, m)
       }, "Blocking data reception, see :cpp:func:`void* simgrid::s4u::Mailbox::get()`");
 
   /* Class Actor */
-  py::object pyStopRequestEx = py::register_exception<simgrid::kernel::context::Context::StopRequest>(m, "ActorKilled");
   py::class_<simgrid::s4u::Actor, ActorPtr>(m, "Actor",
                                             "An actor is an independent stream of execution in your distributed "
                                             "application, see :ref:`class s4u::Actor <API_s4u_Actor>`")
@@ -151,8 +161,8 @@ PYBIND11_MODULE(simgrid, m)
                  fun(*args);
                } catch (py::error_already_set& ex) {
                  if (ex.matches(pyStopRequestEx)) {
-                   /* The actor was killed.
-                    * Stop here that StopRequest exception which was meant to free the RAII stuff on the stack */
+                   XBT_VERB("Actor killed");
+                   /* Stop here that StopRequest exception which was meant to free the RAII stuff on the stack */
                  } else {
                    throw;
                  }
@@ -169,9 +179,7 @@ PYBIND11_MODULE(simgrid, m)
       .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()`")
-      .def("suspend", &Actor::suspend,
-           "Suspend that actor, that is blocked until resume()ed by another actor. See :cpp:func:`void "
-           "simgrid::s4u::Actor::suspend()`")
-      .def("resume", &Actor::resume,
-           "Resume that actor, that was previously suspend()ed. See :cpp:func:`void simgrid::s4u::Actor::suspend()`");
+      .def("is_suspended", &Actor::is_suspended, "Returns True if that actor is currently suspended.")
+      .def("suspend", &Actor::suspend, "Suspend that actor, that is blocked until resume()ed by another actor.")
+      .def("resume", &Actor::resume, "Resume that actor, that was previously suspend()ed.");
 }