src/bindings/python/simgrid_python.cpp

   1 /* Copyright (c) 2018-2020. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #ifdef _WIN32
   7 #warning Try to work around https://bugs.python.org/issue11566
   8 #define _hypot hypot
   9 #endif
  10
  11 #if defined(__GNUG__)
  12 #pragma GCC diagnostic push
  13 #pragma GCC diagnostic ignored "-Wunused-value"
  14 #endif
  15
  16 #include <pybind11/functional.h>
  17 #include <pybind11/pybind11.h> // Must come before our own stuff
  18 #include <pybind11/stl.h>
  19
  20 #if defined(__GNUG__)
  21 #pragma GCC diagnostic pop
  22 #endif
  23
  24 #include "src/kernel/context/Context.hpp"
  25 #include <simgrid/Exception.hpp>
  26 #include <simgrid/s4u/Actor.hpp>
  27 #include <simgrid/s4u/Comm.hpp>
  28 #include <simgrid/s4u/Engine.hpp>
  29 #include <simgrid/s4u/Exec.hpp>
  30 #include <simgrid/s4u/Host.hpp>
  31 #include <simgrid/s4u/Mailbox.hpp>
  32 #include <simgrid/version.h>
  33
  34 #include <memory>
  35 #include <string>
  36 #include <vector>
  37
  38 namespace py = pybind11;
  39 using simgrid::s4u::Actor;
  40 using simgrid::s4u::ActorPtr;
  41 using simgrid::s4u::Engine;
  42 using simgrid::s4u::Host;
  43 using simgrid::s4u::Mailbox;
  44
  45 XBT_LOG_NEW_DEFAULT_CATEGORY(python, "python");
  46
  47 namespace {
  48
  49 static std::string get_simgrid_version()
  50 {
  51   int major;
  52   int minor;
  53   int patch;
  54   sg_version_get(&major, &minor, &patch);
  55   return simgrid::xbt::string_printf("%i.%i.%i", major, minor, patch);
  56 }
  57
  58 } // namespace
  59
  60 PYBIND11_DECLARE_HOLDER_TYPE(T, boost::intrusive_ptr<T>)
  61
  62 PYBIND11_MODULE(simgrid, m)
  63 {
  64   m.doc() = "SimGrid userspace API";
  65
  66   m.attr("simgrid_version") = get_simgrid_version();
  67
  68   // Internal exception used to kill actors and sweep the RAII chimney (free objects living on the stack)
  69   static py::object pyForcefulKillEx(py::register_exception<simgrid::ForcefulKillException>(m, "ActorKilled"));
  70
  71   /* this_actor namespace */
  72   py::module m2 = m.def_submodule("this_actor", "Bindings of the s4u::this_actor namespace.");
  73   m2.def("info", [](const char* s) { XBT_INFO("%s", s); }, "Display a logging message of 'info' priority.");
  74   m2.def("error", [](const char* s) { XBT_ERROR("%s", s); }, "Display a logging message of 'error' priority.");
  75   m2.def("execute", py::overload_cast<double, double>(&simgrid::s4u::this_actor::execute),
  76          "Block the current actor, computing the given amount of flops at the given priority, see :cpp:func:`void "
  77          "simgrid::s4u::this_actor::execute(double, double)`",
  78          py::arg("flops"), py::arg("priority") = 1);
  79   m2.def("exec_init", py::overload_cast<double>(&simgrid::s4u::this_actor::exec_init));
  80   m2.def("get_host", &simgrid::s4u::this_actor::get_host, "Retrieves host on which the current actor is located");
  81   m2.def("set_host", &simgrid::s4u::this_actor::set_host,
  82          "Moves the current actor to another host, see :cpp:func:`void simgrid::s4u::this_actor::set_host()`",
  83          py::arg("dest"));
  84   m2.def(
  85       "sleep_for", static_cast<void (*)(double)>(&simgrid::s4u::this_actor::sleep_for),
  86       "Block the actor sleeping for that amount of seconds, see :cpp:func:`void simgrid::s4u::this_actor::sleep_for`",
  87       py::arg("duration"));
  88   m2.def("sleep_until", static_cast<void (*)(double)>(&simgrid::s4u::this_actor::sleep_until),
  89          "Block the actor sleeping until the specified timestamp, see :cpp:func:`void "
  90          "simgrid::s4u::this_actor::sleep_until`",
  91          py::arg("duration"));
  92   m2.def("suspend", &simgrid::s4u::this_actor::suspend, "Suspend the current actor, that is blocked until resume()ed "
  93                                                         "by another actor. see :cpp:func:`void "
  94                                                         "simgrid::s4u::this_actor::suspend`");
  95   m2.def("yield_", &simgrid::s4u::this_actor::yield,
  96          "Yield the actor, see :cpp:func:`void simgrid::s4u::this_actor::yield()`");
  97   m2.def("exit", &simgrid::s4u::this_actor::exit, "kill the current actor");
  98   m2.def("on_exit",
  99          [](py::object fun) {
 100            ActorPtr act = Actor::self();
 101            simgrid::s4u::this_actor::on_exit([act, fun](bool /*failed*/) {
 102              try {
 103                fun();
 104              } catch (const py::error_already_set& e) {
 105                xbt_die("Error while executing the on_exit lambda: %s", e.what());
 106              }
 107            });
 108          },
 109          "");
 110
 111   /* Class Engine */
 112   py::class_<Engine>(m, "Engine", "Simulation Engine, see :ref:`class s4u::Engine <API_s4u_Engine>`")
 113       .def(py::init([](std::vector<std::string> args) {
 114         static char noarg[] = {'\0'};
 115         int argc            = args.size();
 116         std::unique_ptr<char* []> argv(new char*[argc + 1]);
 117         for (int i = 0; i != argc; ++i)
 118           argv[i] = args[i].empty() ? noarg : &args[i].front();
 119         argv[argc] = nullptr;
 120         // Currently this can be dangling, we should wrap this somehow.
 121         return new simgrid::s4u::Engine(&argc, argv.get());
 122       }))
 123       .def_static("get_clock", &Engine::get_clock,
 124                   "The simulation time, ie the amount of simulated seconds since the simulation start.")
 125       .def("get_all_hosts", &Engine::get_all_hosts, "Returns the list of all hosts found in the platform")
 126       .def("load_platform", &Engine::load_platform,
 127            "Load a platform file describing the environment, see :cpp:func:`simgrid::s4u::Engine::load_platform()`")
 128       .def("load_deployment", &Engine::load_deployment,
 129            "Load a deployment file and launch the actors that it contains, see "
 130            ":cpp:func:`simgrid::s4u::Engine::load_deployment()`")
 131       .def("run", &Engine::run, "Run the simulation")
 132       .def("register_actor",
 133            [](Engine* e, const std::string& name, py::object fun_or_class) {
 134              e->register_actor(name, [fun_or_class](std::vector<std::string> args) {
 135                try {
 136                  /* Convert the std::vector into a py::tuple */
 137                  py::tuple params(args.size() - 1);
 138                  for (size_t i = 1; i < args.size(); i++)
 139                    params[i - 1] = py::cast(args[i]);
 140
 141                  py::object res = fun_or_class(*params);
 142
 143                  /* If I was passed a class, I just built an instance, so I need to call it now */
 144                  if (py::isinstance<py::function>(res))
 145                    res();
 146                } catch (const py::error_already_set& ex) {
 147                  if (ex.matches(pyForcefulKillEx)) {
 148                    XBT_VERB("Actor killed");
 149                    /* Stop here that ForcefulKill exception which was meant to free the RAII stuff on the stack */
 150                  } else {
 151                    throw;
 152                  }
 153                }
 154              });
 155            },
 156            "Registers the main function of an actor, see :cpp:func:`simgrid::s4u::Engine::register_actor()`");
 157
 158   /* Class Host */
 159   py::class_<simgrid::s4u::Host, std::unique_ptr<Host, py::nodelete>>(
 160       m, "Host", "Simulation Engine, see :ref:`class s4u::Host <API_s4u_Host>`")
 161       .def("by_name", &Host::by_name, "Retrieves a host from its name, or die")
 162       .def("get_pstate_count", &Host::get_pstate_count,
 163            "Retrieve the cound of defined pstate levels, see :cpp:func:`simgrid::s4u::Host::get_pstate_count`")
 164       .def("get_pstate_speed", &Host::get_pstate_speed,
 165            "Retrieve the maximal speed at the given pstate, see :cpp:func:`simgrid::s4u::Host::get_pstate_speed`")
 166       .def_property("pstate", &Host::get_pstate, &Host::set_pstate, "The current pstate")
 167
 168       .def("current", &Host::current,
 169            "Retrieves the host on which the running actor is located, see :cpp:func:`simgrid::s4u::Host::current()`")
 170       .def_property_readonly("name",
 171                              [](const Host* self) {
 172                                return std::string(self->get_name().c_str()); // Convert from xbt::string because of MC
 173                              },
 174                              "The name of this host")
 175       .def_property_readonly(
 176           "load", &Host::get_load,
 177           "Returns the current computation load (in flops per second). This is the currently achieved speed. "
 178           "See :cpp:func:`simgrid::s4u::Host::get_load()`")
 179       .def_property_readonly(
 180           "speed", &Host::get_speed,
 181           "The peak computing speed in flops/s at the current pstate, taking the external load into account. "
 182           "This is the max potential speed. See :cpp:func:`simgrid::s4u::Host::get_speed()`");
 183
 184   /* Class Mailbox */
 185   py::class_<simgrid::s4u::Mailbox, std::unique_ptr<Mailbox, py::nodelete>>(
 186       m, "Mailbox", "Mailbox, see :ref:`class s4u::Mailbox <API_s4u_Mailbox>`")
 187       .def("__str__", [](const Mailbox* self) { return std::string("Mailbox(") + self->get_cname() + ")"; },
 188            "Textual representation of the Mailbox`")
 189       .def("by_name", &Mailbox::by_name,
 190            "Retrieve a Mailbox from its name, see :cpp:func:`simgrid::s4u::Mailbox::by_name()`")
 191       .def_property_readonly("name",
 192                              [](const Mailbox* self) {
 193                                return std::string(self->get_name().c_str()); // Convert from xbt::string because of MC
 194                              },
 195                              "The name of that mailbox, see :cpp:func:`simgrid::s4u::Mailbox::get_name()`")
 196       .def("put",
 197            [](Mailbox* self, py::object data, int size) {
 198              data.inc_ref();
 199              self->put(data.ptr(), size);
 200            },
 201            "Blocking data transmission, see :cpp:func:`void simgrid::s4u::Mailbox::put(void*, uint64_t)`")
 202       .def("put_async",
 203            [](Mailbox* self, py::object data, int size) {
 204              data.inc_ref();
 205              return self->put_async(data.ptr(), size);
 206            },
 207            "Non-blocking data transmission, see :cpp:func:`void simgrid::s4u::Mailbox::put_async(void*, uint64_t)`")
 208       .def("get",
 209            [](Mailbox* self) {
 210              py::object data = pybind11::reinterpret_steal<py::object>(static_cast<PyObject*>(self->get()));
 211              data.dec_ref();
 212              return data;
 213            },
 214            "Blocking data reception, see :cpp:func:`void* simgrid::s4u::Mailbox::get()`");
 215
 216   /* Class Comm */
 217   py::class_<simgrid::s4u::Comm, simgrid::s4u::CommPtr>(m, "Comm",
 218                                                         "Communication, see :ref:`class s4u::Comm <API_s4u_Comm>`")
 219       .def("test", &simgrid::s4u::Comm::test,
 220            "Test whether the communication is terminated, see :cpp:func:`simgrid::s4u::Comm::test()`")
 221       .def("wait", &simgrid::s4u::Comm::wait,
 222            "Block until the completion of that communication, see :cpp:func:`simgrid::s4u::Comm::wait()`")
 223       .def("wait_all", &simgrid::s4u::Comm::wait_all,
 224            "Block until the completion of all communications in the list, see "
 225            ":cpp:func:`simgrid::s4u::Comm::wait_all()`")
 226       .def("wait_any", &simgrid::s4u::Comm::wait_any,
 227            "Block until the completion of any communication in the list and return the index of the terminated one, "
 228            "see :cpp:func:`simgrid::s4u::Comm::wait_any()`");
 229
 230   /* Class Exec */
 231   py::class_<simgrid::s4u::Exec, simgrid::s4u::ExecPtr>(m, "Exec",
 232                                                         "Execution, see :ref:`class s4u::Exec <API_s4u_Exec>`")
 233       .def_property_readonly("remaining", &simgrid::s4u::Exec::get_remaining,
 234                              "Amount of flops that remain to be computed until completion, see "
 235                              ":cpp:func:`simgrid::s4u::Exec::get_remaining()`")
 236       .def_property_readonly("remaining_ratio", &simgrid::s4u::Exec::get_remaining_ratio,
 237                              "Amount of work remaining until completion from 0 (completely done) to 1 (nothing done "
 238                              "yet). See :cpp:func:`simgrid::s4u::Exec::get_remaining_ratio()`")
 239       .def_property("host",
 240                     [](simgrid::s4u::ExecPtr self) {
 241                       simgrid::s4u::ExecSeqPtr seq = boost::dynamic_pointer_cast<simgrid::s4u::ExecSeq>(self);
 242                       if (seq != nullptr)
 243                         return seq->get_host();
 244                       xbt_throw_unimplemented(__FILE__, __LINE__,
 245                                               "host of parallel executions is not implemented in python yet.");
 246                     },
 247                     &simgrid::s4u::Exec::set_host,
 248                     "Host on which this execution runs. See :cpp:func:`simgrid::s4u::ExecSeq::get_host()`")
 249       .def("test", &simgrid::s4u::Exec::test,
 250            "Test whether the execution is terminated, see :cpp:func:`simgrid::s4u::Exec::test()`")
 251       .def("cancel", &simgrid::s4u::Exec::cancel, "Cancel that execution, see :cpp:func:`simgrid::s4u::Exec::cancel()`")
 252       .def("start", &simgrid::s4u::Exec::start, "Start that execution, see :cpp:func:`simgrid::s4u::Exec::start()`")
 253       .def("wait", &simgrid::s4u::Exec::wait,
 254            "Block until the completion of that execution, see :cpp:func:`simgrid::s4u::Exec::wait()`");
 255
 256   /* Class Actor */
 257   py::class_<simgrid::s4u::Actor, ActorPtr>(m, "Actor",
 258                                             "An actor is an independent stream of execution in your distributed "
 259                                             "application, see :ref:`class s4u::Actor <API_s4u_Actor>`")
 260       .def("create",
 261            [](py::str name, Host* host, py::object fun, py::args args) {
 262              return simgrid::s4u::Actor::create(name, host, [fun, args]() {
 263                try {
 264                  fun(*args);
 265                } catch (const py::error_already_set& ex) {
 266                  if (ex.matches(pyForcefulKillEx)) {
 267                    XBT_VERB("Actor killed");
 268                    /* Stop here that ForcefulKill exception which was meant to free the RAII stuff on the stack */
 269                  } else {
 270                    throw;
 271                  }
 272                }
 273              });
 274            },
 275            "Create an actor from a function or an object.")
 276       .def_property("host", &Actor::get_host, &Actor::set_host, "The host on which this actor is located")
 277       .def_property_readonly("name", &Actor::get_cname, "The name of this actor.")
 278       .def_property_readonly("pid", &Actor::get_pid, "The PID (unique identifier) of this actor.")
 279       .def_property_readonly("ppid", &Actor::get_ppid,
 280                              "The PID (unique identifier) of the actor that created this one.")
 281       .def("by_pid", &Actor::by_pid, "Retrieve an actor by its PID")
 282       .def("daemonize", &Actor::daemonize,
 283            "This actor will be automatically terminated when the last non-daemon actor finishes (more info in the C++ "
 284            "documentation).")
 285       .def("is_daemon", &Actor::is_daemon,
 286            "Returns True if that actor is a daemon and will be terminated automatically when the last non-daemon actor "
 287            "terminates.")
 288       .def("join", py::overload_cast<double>(&Actor::join),
 289            "Wait for the actor to finish (more info in the C++ documentation).", py::arg("timeout"))
 290       .def("kill", &Actor::kill, "Kill that actor")
 291       .def("kill_all", &Actor::kill_all, "Kill all actors but the caller.")
 292       .def("self", &Actor::self, "Retrieves the current actor.")
 293       .def("is_suspended", &Actor::is_suspended, "Returns True if that actor is currently suspended.")
 294       .def("suspend", &Actor::suspend, "Suspend that actor, that is blocked until resume()ed by another actor.")
 295       .def("resume", &Actor::resume, "Resume that actor, that was previously suspend()ed.");
 296 }