src/bindings/python/simgrid_python.cpp

   1 /* Copyright (c) 2018. 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 #include <functional>
   7 #include <memory>
   8 #include <string>
   9 #include <vector>
  10
  11 #include <pybind11/functional.h>
  12 #include <pybind11/pybind11.h>
  13 #include <pybind11/stl.h>
  14
  15 #include <simgrid/config.h>
  16 #include <xbt/log.h>
  17 #include <xbt/string.hpp>
  18
  19 #include <simgrid/s4u/Actor.hpp>
  20 #include <simgrid/s4u/Engine.hpp>
  21 #include <simgrid/s4u/Host.hpp>
  22 #include <simgrid/s4u/Mailbox.hpp>
  23
  24 #include <boost/intrusive_ptr.hpp>
  25
  26 namespace py = pybind11;
  27 using simgrid::s4u::Actor;
  28 using simgrid::s4u::ActorPtr;
  29 using simgrid::s4u::Engine;
  30 using simgrid::s4u::Host;
  31 using simgrid::s4u::Mailbox;
  32
  33 XBT_LOG_NEW_DEFAULT_CATEGORY(python, "python");
  34
  35 PYBIND11_DECLARE_HOLDER_TYPE(T, boost::intrusive_ptr<T>);
  36
  37 namespace {
  38
  39 static std::string get_simgrid_version()
  40 {
  41   int major, minor, patch;
  42   sg_version_get(&major, &minor, &patch);
  43   return simgrid::xbt::string_printf("%i.%i.%i", major, minor, patch);
  44 }
  45
  46 static std::string simgrid_version = get_simgrid_version();
  47
  48 } // namespace
  49
  50 PYBIND11_MODULE(simgrid, m)
  51 {
  52
  53   m.doc() = "SimGrid userspace API";
  54
  55   m.attr("simgrid_version") = simgrid_version;
  56
  57   /* this_actor namespace */
  58   py::module m2 = m.def_submodule("this_actor", "Bindings of the s4u::this_actor namespace.");
  59   m2.def("info", [](char* s) { XBT_INFO("%s", s); }, "Display a logging message of default priority.");
  60   m2.def("execute", py::overload_cast<double, double>(&simgrid::s4u::this_actor::execute),
  61          "Block the current actor, computing the given amount of flops at the given priority, see :cpp:func:`void "
  62          "simgrid::s4u::this_actor::execute(double, double)`",
  63          py::arg("flops"), py::arg("priority") = 1);
  64   m2.def("yield_", &simgrid::s4u::this_actor::yield,
  65          "Yield the actor, see :cpp:func:`void simgrid::s4u::this_actor::yield()`");
  66
  67   /* Class Engine */
  68   py::class_<Engine>(m, "Engine", "Simulation Engine, see :ref:`class s4u::Engine <API_s4u_Engine>`")
  69       .def(py::init([](std::vector<std::string> args) -> simgrid::s4u::Engine* {
  70         static char noarg[] = {'\0'};
  71         int argc            = args.size();
  72         std::unique_ptr<char* []> argv(new char*[argc + 1]);
  73         for (int i = 0; i != argc; ++i)
  74           argv[i] = args[i].empty() ? noarg : &args[i].front();
  75         argv[argc] = nullptr;
  76         // Currently this can be dangling, we should wrap this somehow.
  77         return new simgrid::s4u::Engine(&argc, argv.get());
  78       }))
  79       .def("load_platform", &Engine::load_platform,
  80           "Load a platform file describing the environment, see :cpp:func:`simgrid::s4u::Engine::load_platform()`")
  81       .def("load_deployment", &Engine::load_deployment,
  82           "Load a deployment file and launch the actors that it contains, see :cpp:func:`simgrid::s4u::Engine::load_deployment()`")
  83       .def("run", &Engine::run, "Run the simulation")
  84       .def("register_actor", [](Engine*, std::string name, py::object obj) {
  85         simgrid::simix::register_function(name,
  86             [obj](std::vector<std::string> args) -> simgrid::simix::ActorCode {
  87           return [obj, args]() {
  88             /* Convert the std::vector into a py::tuple */
  89             py::tuple params(args.size()-1);
  90             for (size_t i=1; i<args.size(); i++)
  91               params[i-1] = py::cast(args[i]);
  92
  93             PyObject *result = PyObject_CallObject(obj.ptr(), params.ptr());
  94             if (!result)
  95                 throw pybind11::error_already_set();
  96
  97             /* If I was passed a class, I just built an instance, so I need to call it now */
  98             if (PyCallable_Check(result)) {
  99               py::object obj2 = pybind11::reinterpret_steal<py::object>(pybind11::handle(static_cast<PyObject*>(result)));
 100               obj2();
 101             }
 102           };
 103         });
 104       }, "Registers the main function of an actor, see :cpp:func:`simgrid::s4u::Engine::register_function()`")
 105       ;
 106
 107   /* Class Host */
 108   auto get_name = [](const Host* self) {
 109     return self->get_name();
 110   };
 111   py::class_<simgrid::s4u::Host, std::unique_ptr<Host, py::nodelete>>(m, "Host", "Simulation Engine, see :ref:`class s4u::Host <API_s4u_Host>`")
 112       .def("by_name", &Host::by_name, "Retrieve a host from its name, or die")
 113       .def("get_name", &Host::get_name, "Retrieve the name of this host")
 114       .def_property_readonly("name", get_name, "Retrieve the name of this host")
 115       .def_property_readonly("speed", &Host::get_speed,
 116           "Get the peak computing speed in flops/s at the current pstate, taking the external load into account, see :cpp:func:`simgrid::s4u::Host::get_speed()`");
 117
 118   /* Class Mailbox */
 119   py::class_<simgrid::s4u::Mailbox, std::unique_ptr<Mailbox, py::nodelete>>(m, "Mailbox", "Mailbox, see :ref:`class s4u::Mailbox <API_s4u_Mailbox>`")
 120       .def("by_name", &Mailbox::by_name, "Retrieve a Mailbox from its name, see :cpp:func:`simgrid::s4u::Mailbox::by_name()`")
 121       .def("get_name", &Mailbox::get_name, "Retrieves the name of that host, see :cpp:func:`simgrid::s4u::Mailbox::get_name()`")
 122       .def("put", [](Mailbox self, py::object data, int size) {
 123         data.inc_ref();
 124         self.put(data.ptr(), size);
 125       }, "Blocking data transmission, see :cpp:func:`void simgrid::s4u::Mailbox::put(void*, uint64_t)`")
 126       .def("get", [](Mailbox self) -> py::object {
 127          py::object data = pybind11::reinterpret_steal<py::object>(pybind11::handle(static_cast<PyObject*>(self.get())));
 128          data.dec_ref();
 129          return data;
 130       }, "Blocking data reception, see :cpp:func:`void* simgrid::s4u::Mailbox::get()`");
 131
 132   /* Class Actor */
 133   py::class_<simgrid::s4u::Actor, ActorPtr>(m, "Actor",
 134                                             ""
 135                                             "An actor is an independent stream of execution in your distributed "
 136                                             "application, see :ref:`class s4u::Actor <API_s4u_Actor>`")
 137
 138       .def("create",
 139            [](py::args args, py::kwargs kwargs) {
 140              xbt_assert(args.size() > 2,
 141                         "Creating an actor takes at least 3 parameters: name, host, and main function.");
 142              return simgrid::s4u::Actor::create(args[0].cast<std::string>(), args[1].cast<Host*>(), [args]() {
 143                py::tuple funargs(args.size() - 3);
 144                for (size_t i = 3; i < args.size(); i++)
 145                  funargs[i - 3] = args[i];
 146
 147                PyObject* result = PyObject_CallObject(args[2].ptr(), funargs.ptr());
 148                if (!result)
 149                  throw pybind11::error_already_set();
 150              });
 151            },
 152            "Create an actor from a function or an object, see :cpp:func:`simgrid::s4u::Actor::create()`");
 153 }