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