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   void (*sleep_for_fun)(double)   = &simgrid::s4u::this_actor::sleep_for; // pick the right overload
  73   void (*sleep_until_fun)(double) = &simgrid::s4u::this_actor::sleep_until;
  74
  75   py::module m2 = m.def_submodule("this_actor", "Bindings of the s4u::this_actor namespace.");
  76   m2.def("info", [](const char* s) { XBT_INFO("%s", s); }, "Display a logging message of 'info' priority.");
  77   m2.def("error", [](const char* s) { XBT_ERROR("%s", s); }, "Display a logging message of 'error' priority.");
  78   m2.def("execute", py::overload_cast<double, double>(&simgrid::s4u::this_actor::execute),
  79          "Block the current actor, computing the given amount of flops at the given priority, see :cpp:func:`void "
  80          "simgrid::s4u::this_actor::execute(double, double)`",
  81          py::arg("flops"), py::arg("priority") = 1);
  82   m2.def("exec_init", [](double flops) { return simgrid::s4u::this_actor::exec_init(flops); });
  83   m2.def("get_host", &simgrid::s4u::this_actor::get_host, "Retrieves host on which the current actor is located");
  84   m2.def("set_host", &simgrid::s4u::this_actor::set_host,
  85          "Moves the current actor to another host, see :cpp:func:`void simgrid::s4u::this_actor::set_host()`",
  86          py::arg("dest"));
  87   m2.def(
  88       "sleep_for", sleep_for_fun,
  89       "Block the actor sleeping for that amount of seconds, see :cpp:func:`void simgrid::s4u::this_actor::sleep_for`",
  90       py::arg("duration"));
  91   m2.def("sleep_until", sleep_until_fun, "Block the actor sleeping until the specified timestamp, see :cpp:func:`void "
  92                                          "simgrid::s4u::this_actor::sleep_until`",
  93          py::arg("duration"));
  94   m2.def("suspend", &simgrid::s4u::this_actor::suspend, "Suspend the current actor, that is blocked until resume()ed "
  95                                                         "by another actor. see :cpp:func:`void "
  96                                                         "simgrid::s4u::this_actor::suspend`");
  97   m2.def("yield_", &simgrid::s4u::this_actor::yield,
  98          "Yield the actor, see :cpp:func:`void simgrid::s4u::this_actor::yield()`");
  99   m2.def("exit", &simgrid::s4u::this_actor::exit, "kill the current actor");
 100   m2.def("on_exit",
 101          [](py::object fun) {
 102            ActorPtr act = Actor::self();
 103            simgrid::s4u::this_actor::on_exit([act, fun](bool /*failed*/) {
 104              try {
 105                fun();
 106              } catch (const py::error_already_set& e) {
 107                xbt_die("Error while executing the on_exit lambda: %s", e.what());
 108              }
 109            });
 110          },
 111          "");
 112
 113   /* Class Engine */
 114   py::class_<Engine>(m, "Engine", "Simulation Engine, see :ref:`class s4u::Engine <API_s4u_Engine>`")
 115       .def(py::init([](std::vector<std::string> args) {
 116         static char noarg[] = {'\0'};
 117         int argc            = args.size();
 118         std::unique_ptr<char* []> argv(new char*[argc + 1]);
 119         for (int i = 0; i != argc; ++i)
 120           argv[i] = args[i].empty() ? noarg : &args[i].front();
 121         argv[argc] = nullptr;
 122         // Currently this can be dangling, we should wrap this somehow.
 123         return new simgrid::s4u::Engine(&argc, argv.get());
 124       }))
 125       .def_static("get_clock", &Engine::get_clock,
 126                   "The simulation time, ie the amount of simulated seconds since the simulation start.")
 127       .def("get_all_hosts", &Engine::get_all_hosts, "Returns the list of all hosts found in the platform")
 128       .def("load_platform", &Engine::load_platform,
 129            "Load a platform file describing the environment, see :cpp:func:`simgrid::s4u::Engine::load_platform()`")
 130       .def("load_deployment", &Engine::load_deployment,
 131            "Load a deployment file and launch the actors that it contains, see "
 132            ":cpp:func:`simgrid::s4u::Engine::load_deployment()`")
 133       .def("run", &Engine::run, "Run the simulation")
 134       .def("register_actor",
 135            [](Engine* e, const std::string& name, py::object fun_or_class) {
 136              e->register_actor(name, [fun_or_class](std::vector<std::string> args) {
 137                try {
 138                  /* Convert the std::vector into a py::tuple */
 139                  py::tuple params(args.size() - 1);
 140                  for (size_t i = 1; i < args.size(); i++)
 141                    params[i - 1] = py::cast(args[i]);
 142
 143                  py::object res = fun_or_class(*params);
 144
 145                  /* If I was passed a class, I just built an instance, so I need to call it now */
 146                  if (py::isinstance<py::function>(res))
 147                    res();
 148                } catch (const py::error_already_set& ex) {
 149                  if (ex.matches(pyForcefulKillEx)) {
 150                    XBT_VERB("Actor killed");
 151                    /* Stop here that ForcefulKill exception which was meant to free the RAII stuff on the stack */
 152                  } else {
 153                    throw;
 154                  }
 155                }
 156              });
 157            },
 158            "Registers the main function of an actor, see :cpp:func:`simgrid::s4u::Engine::register_actor()`");
 159
 160   /* Class Host */
 161   py::class_<simgrid::s4u::Host, std::unique_ptr<Host, py::nodelete>>(
 162       m, "Host", "Simulation Engine, see :ref:`class s4u::Host <API_s4u_Host>`")
 163       .def("by_name", &Host::by_name, "Retrieves a host from its name, or die")
 164       .def("get_pstate_count", &Host::get_pstate_count,
 165            "Retrieve the cound of defined pstate levels, see :cpp:func:`simgrid::s4u::Host::get_pstate_count`")
 166       .def("get_pstate_speed", &Host::get_pstate_speed,
 167            "Retrieve the maximal speed at the given pstate, see :cpp:func:`simgrid::s4u::Host::get_pstate_speed`")
 168       .def_property("pstate", &Host::get_pstate, &Host::set_pstate, "The current pstate")
 169
 170       .def("current", &Host::current,
 171            "Retrieves the host on which the running actor is located, see :cpp:func:`simgrid::s4u::Host::current()`")
 172       .def_property_readonly("name",
 173                              [](const Host* self) {
 174                                return std::string(self->get_name().c_str()); // Convert from xbt::string because of MC
 175                              },
 176                              "The name of this host")
 177       .def_property_readonly(
 178           "load", &Host::get_load,
 179           "Returns the current computation load (in flops per second). This is the currently achieved speed. "
 180           "See :cpp:func:`simgrid::s4u::Host::get_load()`")
 181       .def_property_readonly(
 182           "speed", &Host::get_speed,
 183           "The peak computing speed in flops/s at the current pstate, taking the external load into account. "
 184           "This is the max potential speed. See :cpp:func:`simgrid::s4u::Host::get_speed()`");
 185
 186   /* Class Mailbox */
 187   py::class_<simgrid::s4u::Mailbox, std::unique_ptr<Mailbox, py::nodelete>>(
 188       m, "Mailbox", "Mailbox, see :ref:`class s4u::Mailbox <API_s4u_Mailbox>`")
 189       .def("__str__", [](const Mailbox* self) { return std::string("Mailbox(") + self->get_cname() + ")"; },
 190            "Textual representation of the Mailbox`")
 191       .def("by_name", &Mailbox::by_name,
 192            "Retrieve a Mailbox from its name, see :cpp:func:`simgrid::s4u::Mailbox::by_name()`")
 193       .def_property_readonly("name",
 194                              [](const Mailbox* self) {
 195                                return std::string(self->get_name().c_str()); // Convert from xbt::string because of MC
 196                              },
 197                              "The name of that mailbox, see :cpp:func:`simgrid::s4u::Mailbox::get_name()`")
 198       .def("put",
 199            [](Mailbox* self, py::object data, int size) {
 200              data.inc_ref();
 201              self->put(data.ptr(), size);
 202            },
 203            "Blocking data transmission, see :cpp:func:`void simgrid::s4u::Mailbox::put(void*, uint64_t)`")
 204       .def("put_async",
 205            [](Mailbox* self, py::object data, int size) {
 206              data.inc_ref();
 207              return self->put_async(data.ptr(), size);
 208            },
 209            "Non-blocking data transmission, see :cpp:func:`void simgrid::s4u::Mailbox::put_async(void*, uint64_t)`")
 210       .def("get",
 211            [](Mailbox* self) {
 212              py::object data = pybind11::reinterpret_steal<py::object>(static_cast<PyObject*>(self->get()));
 213              data.dec_ref();
 214              return data;
 215            },
 216            "Blocking data reception, see :cpp:func:`void* simgrid::s4u::Mailbox::get()`");
 217
 218   /* Class Comm */
 219   py::class_<simgrid::s4u::Comm, simgrid::s4u::CommPtr>(m, "Comm",
 220                                                         "Communication, see :ref:`class s4u::Comm <API_s4u_Comm>`")
 221       .def("test", [](simgrid::s4u::CommPtr self) { return self->test(); },
 222            "Test whether the communication is terminated, see :cpp:func:`simgrid::s4u::Comm::test()`")
 223       .def("wait", [](simgrid::s4u::CommPtr self) { self->wait(); },
 224            "Block until the completion of that communication, see :cpp:func:`simgrid::s4u::Comm::wait()`")
 225       .def("wait_all", [](const std::vector<simgrid::s4u::CommPtr>* comms) { simgrid::s4u::Comm::wait_all(comms); },
 226            "Block until the completion of all communications in the list, see "
 227            ":cpp:func:`simgrid::s4u::Comm::wait_all()`")
 228       .def("wait_any",
 229            [](const std::vector<simgrid::s4u::CommPtr>* comms) { return simgrid::s4u::Comm::wait_any(comms); },
 230            "Block until the completion of any communication in the list and return the index of the terminated one, "
 231            "see :cpp:func:`simgrid::s4u::Comm::wait_any()`");
 232
 233   /* Class Exec */
 234   py::class_<simgrid::s4u::Exec, simgrid::s4u::ExecPtr>(m, "Exec",
 235                                                         "Execution, see :ref:`class s4u::Exec <API_s4u_Exec>`")
 236       .def_property_readonly("remaining", [](simgrid::s4u::ExecPtr self) { return self->get_remaining(); },
 237                              "Amount of flops that remain to be computed until completion, see "
 238                              ":cpp:func:`simgrid::s4u::Exec::get_remaining()`")
 239       .def_property_readonly("remaining_ratio", [](simgrid::s4u::ExecPtr self) { return self->get_remaining_ratio(); },
 240                              "Amount of work remaining until completion from 0 (completely done) to 1 (nothing done "
 241                              "yet). See :cpp:func:`simgrid::s4u::Exec::get_remaining_ratio()`")
 242       .def_property("host",
 243                     [](simgrid::s4u::ExecPtr self) {
 244                       simgrid::s4u::ExecSeqPtr seq = boost::dynamic_pointer_cast<simgrid::s4u::ExecSeq>(self);
 245                       if (seq != nullptr)
 246                         return seq->get_host();
 247                       xbt_throw_unimplemented(__FILE__, __LINE__,
 248                                               "host of parallel executions is not implemented in python yet.");
 249                     },
 250                     [](simgrid::s4u::ExecPtr self, simgrid::s4u::Host* host) { self->set_host(host); },
 251                     "Host on which this execution runs. See :cpp:func:`simgrid::s4u::ExecSeq::get_host()`")
 252       .def("test", [](simgrid::s4u::ExecPtr self) { return self->test(); },
 253            "Test whether the execution is terminated, see :cpp:func:`simgrid::s4u::Exec::test()`")
 254       .def("cancel", [](simgrid::s4u::ExecPtr self) { self->cancel(); },
 255            "Cancel that execution, see :cpp:func:`simgrid::s4u::Exec::cancel()`")
 256       .def("start", [](simgrid::s4u::ExecPtr self) { return self->start(); },
 257            "Start that execution, see :cpp:func:`simgrid::s4u::Exec::start()`")
 258       .def("wait", [](simgrid::s4u::ExecPtr self) { return self->wait(); },
 259            "Block until the completion of that execution, see :cpp:func:`simgrid::s4u::Exec::wait()`");
 260
 261   /* Class Actor */
 262   py::class_<simgrid::s4u::Actor, ActorPtr>(m, "Actor",
 263                                             "An actor is an independent stream of execution in your distributed "
 264                                             "application, see :ref:`class s4u::Actor <API_s4u_Actor>`")
 265       .def("create",
 266            [](py::str name, py::object host, py::object fun, py::args args) {
 267              return simgrid::s4u::Actor::create(name, host.cast<Host*>(), [fun, args]() {
 268                try {
 269                  fun(*args);
 270                } catch (const py::error_already_set& ex) {
 271                  if (ex.matches(pyForcefulKillEx)) {
 272                    XBT_VERB("Actor killed");
 273                    /* Stop here that ForcefulKill exception which was meant to free the RAII stuff on the stack */
 274                  } else {
 275                    throw;
 276                  }
 277                }
 278              });
 279            },
 280            "Create an actor from a function or an object.")
 281       .def_property("host", &Actor::get_host, &Actor::set_host, "The host on which this actor is located")
 282       .def_property_readonly("name", &Actor::get_cname, "The name of this actor.")
 283       .def_property_readonly("pid", &Actor::get_pid, "The PID (unique identifier) of this actor.")
 284       .def_property_readonly("ppid", &Actor::get_ppid,
 285                              "The PID (unique identifier) of the actor that created this one.")
 286       .def("by_pid", &Actor::by_pid, "Retrieve an actor by its PID")
 287       .def("daemonize", &Actor::daemonize,
 288            "This actor will be automatically terminated when the last non-daemon actor finishes (more info in the C++ "
 289            "documentation).")
 290       .def("is_daemon", &Actor::is_daemon,
 291            "Returns True if that actor is a daemon and will be terminated automatically when the last non-daemon actor "
 292            "terminates.")
 293       .def("join", py::overload_cast<double>(&Actor::join),
 294            "Wait for the actor to finish (more info in the C++ documentation).", py::arg("timeout"))
 295       .def("kill", [](ActorPtr act) { act->kill(); }, "Kill that actor")
 296       .def("kill_all", &Actor::kill_all, "Kill all actors but the caller.")
 297       .def("self", &Actor::self, "Retrieves the current actor.")
 298       .def("is_suspended", &Actor::is_suspended, "Returns True if that actor is currently suspended.")
 299       .def("suspend", &Actor::suspend, "Suspend that actor, that is blocked until resume()ed by another actor.")
 300       .def("resume", &Actor::resume, "Resume that actor, that was previously suspend()ed.");
 301 }