1 /* Copyright (c) 2018. The SimGrid Team. All rights reserved. */
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. */
11 #include <pybind11/functional.h>
12 #include <pybind11/pybind11.h>
13 #include <pybind11/stl.h>
15 #include <simgrid/config.h>
17 #include <xbt/string.hpp>
19 #include <simgrid/s4u/Actor.hpp>
20 #include <simgrid/s4u/Engine.hpp>
21 #include <simgrid/s4u/Host.hpp>
22 #include <simgrid/s4u/Mailbox.hpp>
24 #include <boost/intrusive_ptr.hpp>
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;
33 XBT_LOG_NEW_DEFAULT_CATEGORY(python, "python");
35 PYBIND11_DECLARE_HOLDER_TYPE(T, boost::intrusive_ptr<T>);
39 static std::string get_simgrid_version()
41 int major, minor, patch;
42 sg_version_get(&major, &minor, &patch);
43 return simgrid::xbt::string_printf("%i.%i.%i", major, minor, patch);
46 static std::string simgrid_version = get_simgrid_version();
50 PYBIND11_MODULE(simgrid, m)
53 m.doc() = "SimGrid userspace API";
55 m.attr("simgrid_version") = simgrid_version;
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>(&simgrid::s4u::this_actor::execute),
61 "Block the current actor, computing the given amount of flops, see :cpp:func:`void "
62 "simgrid::s4u::this_actor::execute(double)`");
63 m2.def("execute", py::overload_cast<double, double>(&simgrid::s4u::this_actor::execute),
64 "Block the current actor, computing the given amount of flops at the given priority, see :cpp:func:`void "
65 "simgrid::s4u::this_actor::execute(double, double)`");
66 m2.def("yield_", &simgrid::s4u::this_actor::yield,
67 "Yield the actor, see :cpp:func:`void simgrid::s4u::this_actor::yield()`");
70 py::class_<Engine>(m, "Engine", "Simulation Engine, see :ref:`class s4u::Engine <API_s4u_Engine>`")
71 .def(py::init([](std::vector<std::string> args) -> simgrid::s4u::Engine* {
72 static char noarg[] = {'\0'};
73 int argc = args.size();
74 std::unique_ptr<char* []> argv(new char*[argc + 1]);
75 for (int i = 0; i != argc; ++i)
76 argv[i] = args[i].empty() ? noarg : &args[i].front();
78 // Currently this can be dangling, we should wrap this somehow.
79 return new simgrid::s4u::Engine(&argc, argv.get());
81 .def("load_platform", &Engine::load_platform,
82 "Load a platform file describing the environment, see :cpp:func:`simgrid::s4u::Engine::load_platform()`")
83 .def("load_deployment", &Engine::load_deployment,
84 "Load a deployment file and launch the actors that it contains, see :cpp:func:`simgrid::s4u::Engine::load_deployment()`")
85 .def("run", &Engine::run, "Run the simulation")
86 .def("register_actor", [](Engine*, std::string name, py::object obj) {
87 simgrid::simix::register_function(name,
88 [obj](std::vector<std::string> args) -> simgrid::simix::ActorCode {
89 return [obj, args]() {
90 /* Convert the std::vector into a py::tuple */
91 py::tuple params(args.size()-1);
92 for (size_t i=1; i<args.size(); i++)
93 params[i-1] = py::cast(args[i]);
95 PyObject *result = PyObject_CallObject(obj.ptr(), params.ptr());
97 throw pybind11::error_already_set();
99 /* If I was passed a class, I just built an instance, so I need to call it now */
100 if (PyCallable_Check(result)) {
101 py::object obj2 = pybind11::reinterpret_steal<py::object>(pybind11::handle(static_cast<PyObject*>(result)));
106 }, "Registers the main function of an actor, see :cpp:func:`simgrid::s4u::Engine::register_function()`")
110 py::class_<simgrid::s4u::Host, std::unique_ptr<Host, py::nodelete>>(m, "Host", "Simulation Engine, see :ref:`class s4u::Host <API_s4u_Host>`").def(
111 "by_name", &Host::by_name, "Retrieve a host from its name, or die");
114 py::class_<simgrid::s4u::Mailbox, std::unique_ptr<Mailbox, py::nodelete>>(m, "Mailbox", "Mailbox, see :ref:`class s4u::Mailbox <API_s4u_Mailbox>`")
115 .def("by_name", &Mailbox::by_name, "Retrieve a Mailbox from its name, see :cpp:func:`simgrid::s4u::Mailbox::by_name()`")
116 .def("get_name", &Mailbox::get_name, "Retrieves the name of that host, see :cpp:func:`simgrid::s4u::Mailbox::get_name()`")
117 .def("put", [](Mailbox self, py::object data, int size) {
119 self.put(data.ptr(), size);
120 }, "Blocking data transmission, see :cpp:func:`void simgrid::s4u::Mailbox::put(void*, uint64_t)`")
121 .def("get", [](Mailbox self) -> py::object {
122 py::object data = pybind11::reinterpret_steal<py::object>(pybind11::handle(static_cast<PyObject*>(self.get())));
125 }, "Blocking data reception, see :cpp:func:`void* simgrid::s4u::Mailbox::get()`");
128 py::class_<simgrid::s4u::Actor, ActorPtr>(m, "Actor",
130 "An actor is an independent stream of execution in your distributed "
131 "application, see :ref:`class s4u::Actor <API_s4u_Actor>`")
134 [](py::args args, py::kwargs kwargs) {
135 xbt_assert(args.size() > 2,
136 "Creating an actor takes at least 3 parameters: name, host, and main function.");
137 return simgrid::s4u::Actor::create(args[0].cast<std::string>(), args[1].cast<Host*>(), [args]() {
138 py::tuple funargs(args.size() - 3);
139 for (size_t i = 3; i < args.size(); i++)
140 funargs[i - 3] = args[i];
142 PyObject* result = PyObject_CallObject(args[2].ptr(), funargs.ptr());
144 throw pybind11::error_already_set();
147 "Create an actor from a function or an object, see :cpp:func:`simgrid::s4u::Actor::create()`");