1 /* Copyright (c) 2010-2020. 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. */
6 /* SimGrid Lua bindings */
8 #include "lua_private.hpp"
9 #include "simgrid/kernel/routing/NetPoint.hpp"
10 #include "src/kernel/resource/profile/Profile.hpp"
11 #include "src/surf/network_interface.hpp"
12 #include "src/surf/surf_private.hpp"
13 #include "src/surf/xml/platf_private.hpp"
14 #include "xbt/parse_units.hpp"
16 #include <boost/algorithm/string/classification.hpp>
17 #include <boost/algorithm/string/split.hpp>
18 #include <simgrid/s4u/Engine.hpp>
19 #include <simgrid/s4u/Host.hpp>
28 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(lua_platf, lua, "Lua bindings (platform module)");
30 constexpr char PLATF_MODULE_NAME[] = "simgrid.engine";
31 constexpr char AS_FIELDNAME[] = "__simgrid_as";
33 /* ********************************************************************************* */
34 /* simgrid.platf API */
35 /* ********************************************************************************* */
37 static const luaL_Reg platf_functions[] = {
38 {"open", console_open},
39 {"close", console_close},
40 {"AS_open", console_AS_open},
41 {"AS_seal", console_AS_seal},
42 {"backbone_new", console_add_backbone},
43 {"host_link_new", console_add_host___link},
44 {"host_new", console_add_host},
45 {"link_new", console_add_link},
46 {"router_new", console_add_router},
47 {"route_new", console_add_route},
48 {"ASroute_new", console_add_ASroute},
52 static simgrid::s4u::Link::SharingPolicy link_policy_get_by_name(const char* policy)
54 if (policy && not strcmp(policy, "FULLDUPLEX")) {
55 XBT_WARN("Please update your platform to use SPLITDUPLEX instead of FULLDUPLEX");
56 return simgrid::s4u::Link::SharingPolicy::SPLITDUPLEX;
57 } else if (policy && not strcmp(policy, "SPLITDUPLEX")) {
58 return simgrid::s4u::Link::SharingPolicy::SPLITDUPLEX;
59 } else if (policy && not strcmp(policy, "FATPIPE")) {
60 return simgrid::s4u::Link::SharingPolicy::FATPIPE;
62 return simgrid::s4u::Link::SharingPolicy::SHARED;
66 int console_open(lua_State*)
69 simgrid::s4u::Engine::on_platform_creation();
74 int console_close(lua_State*)
76 simgrid::s4u::Engine::on_platform_created();
81 int console_add_backbone(lua_State *L) {
82 simgrid::kernel::routing::LinkCreationArgs link;
84 lua_getstack(L, 1, &ar);
85 lua_getinfo(L, "Sl", &ar);
87 link.properties = nullptr;
89 lua_ensure(lua_istable(L, -1),"Bad Arguments to create backbone in Lua. Should be a table with named arguments.");
91 lua_pushstring(L, "id");
92 int type = lua_gettable(L, -2);
93 lua_ensure(type == LUA_TSTRING, "Attribute 'id' must be specified for backbone and must be a string.");
94 link.id = lua_tostring(L, -1);
97 lua_pushstring(L, "bandwidth");
98 type = lua_gettable(L, -2);
99 lua_ensure(type == LUA_TSTRING || type == LUA_TNUMBER,
100 "Attribute 'bandwidth' must be specified for backbone and must either be a string (in the right format; see docs) or a number.");
101 link.bandwidths.push_back(xbt_parse_get_bandwidth(ar.short_src, ar.currentline, lua_tostring(L, -1),
102 "bandwidth of backbone", link.id.c_str()));
105 lua_pushstring(L, "lat");
106 type = lua_gettable(L, -2);
107 lua_ensure(type == LUA_TSTRING || type == LUA_TNUMBER,
108 "Attribute 'lat' must be specified for backbone and must either be a string (in the right format; see docs) or a number.");
110 xbt_parse_get_time(ar.short_src, ar.currentline, lua_tostring(L, -1), "latency of backbone", link.id.c_str());
113 lua_pushstring(L, "sharing_policy");
115 const char* policy = lua_tostring(L, -1);
117 link.policy = link_policy_get_by_name(policy);
119 sg_platf_new_link(&link);
120 routing_cluster_add_backbone(simgrid::s4u::Link::by_name(link.id)->get_impl());
125 int console_add_host___link(lua_State *L) {
126 simgrid::kernel::routing::HostLinkCreationArgs hostlink;
129 lua_ensure(lua_istable(L, -1), "Bad Arguments to create host_link in Lua. Should be a table with named arguments.");
131 lua_pushstring(L, "id");
132 type = lua_gettable(L, -2);
133 lua_ensure(type == LUA_TSTRING, "Attribute 'id' must be specified for any host_link and must be a string.");
134 hostlink.id = lua_tostring(L, -1);
137 lua_pushstring(L, "up");
138 type = lua_gettable(L, -2);
139 lua_ensure(type == LUA_TSTRING || type == LUA_TNUMBER,
140 "Attribute 'up' must be specified for host_link and must either be a string or a number.");
141 hostlink.link_up = lua_tostring(L, -1);
144 lua_pushstring(L, "down");
145 type = lua_gettable(L, -2);
146 lua_ensure(type == LUA_TSTRING || type == LUA_TNUMBER,
147 "Attribute 'down' must be specified for host_link and must either be a string or a number.");
148 hostlink.link_down = lua_tostring(L, -1);
151 XBT_DEBUG("Create a host_link for host %s", hostlink.id.c_str());
152 sg_platf_new_hostlink(&hostlink);
157 int console_add_host(lua_State *L) {
158 simgrid::kernel::routing::HostCreationArgs host;
161 lua_getstack(L, 1, &ar);
162 lua_getinfo(L, "Sl", &ar);
164 // we get values from the table passed as argument
165 lua_ensure(lua_istable(L, -1),
166 "Bad Arguments to create host. Should be a table with named arguments");
169 lua_pushstring(L, "id");
170 type = lua_gettable(L, -2);
171 lua_ensure(type == LUA_TSTRING,
172 "Attribute 'id' must be specified for any host and must be a string.");
173 host.id = lua_tostring(L, -1);
177 lua_pushstring(L, "speed");
178 type = lua_gettable(L, -2);
179 lua_ensure(type == LUA_TSTRING || type == LUA_TNUMBER,
180 "Attribute 'speed' must be specified for host and must either be a string (in the correct format; check documentation) or a number.");
181 if (type == LUA_TNUMBER)
182 host.speed_per_pstate.push_back(lua_tonumber(L, -1));
184 host.speed_per_pstate.push_back(
185 xbt_parse_get_speed(ar.short_src, ar.currentline, lua_tostring(L, -1), "speed of host", host.id));
189 lua_pushstring(L, "core");
191 if (not lua_isnumber(L, -1))
192 host.core_amount = 1; // Default value
194 host.core_amount = static_cast<int>(lua_tointeger(L, -1));
195 if (host.core_amount == 0)
196 host.core_amount = 1;
200 lua_pushstring(L, "availability_file");
202 const char *filename = lua_tostring(L, -1);
204 host.speed_trace = simgrid::kernel::profile::Profile::from_file(filename);
208 lua_pushstring(L, "state_file");
210 filename = lua_tostring(L, -1);
212 host.state_trace = simgrid::kernel::profile::Profile::from_file(filename);
215 sg_platf_new_host(&host);
220 int console_add_link(lua_State *L) {
221 simgrid::kernel::routing::LinkCreationArgs link;
223 lua_getstack(L, 1, &ar);
224 lua_getinfo(L, "Sl", &ar);
228 lua_ensure(lua_istable(L, -1), "Bad Arguments to create link, Should be a table with named arguments");
231 lua_pushstring(L, "id");
232 int type = lua_gettable(L, -2);
233 lua_ensure(type == LUA_TSTRING || type == LUA_TNUMBER,
234 "Attribute 'id' must be specified for any link and must be a string.");
235 link.id = lua_tostring(L, -1);
238 // get bandwidth value
239 lua_pushstring(L, "bandwidth");
240 type = lua_gettable(L, -2);
241 lua_ensure(type == LUA_TSTRING || type == LUA_TNUMBER,
242 "Attribute 'bandwidth' must be specified for any link and must either be either a string (in the right format; see docs) or a number.");
243 if (type == LUA_TNUMBER)
244 link.bandwidths.push_back(lua_tonumber(L, -1));
246 link.bandwidths.push_back(xbt_parse_get_bandwidth(ar.short_src, ar.currentline, lua_tostring(L, -1),
247 "bandwidth of link", link.id.c_str()));
251 lua_pushstring(L, "lat");
252 type = lua_gettable(L, -2);
253 lua_ensure(type == LUA_TSTRING || type == LUA_TNUMBER,
254 "Attribute 'lat' must be specified for any link and must either be a string (in the right format; see docs) or a number.");
255 if (type == LUA_TNUMBER)
256 link.latency = lua_tonumber(L, -1);
259 xbt_parse_get_time(ar.short_src, ar.currentline, lua_tostring(L, -1), "latency of link", link.id.c_str());
262 /*Optional Arguments */
264 //get bandwidth_trace value
265 lua_pushstring(L, "bandwidth_file");
267 const char *filename = lua_tostring(L, -1);
269 link.bandwidth_trace = simgrid::kernel::profile::Profile::from_file(filename);
272 //get latency_trace value
273 lua_pushstring(L, "latency_file");
275 filename = lua_tostring(L, -1);
277 link.latency_trace = simgrid::kernel::profile::Profile::from_file(filename);
280 //get state_trace value
281 lua_pushstring(L, "state_file");
283 filename = lua_tostring(L, -1);
285 link.state_trace = simgrid::kernel::profile::Profile::from_file(filename);
289 lua_pushstring(L, "sharing_policy");
291 policy = lua_tostring(L, -1);
293 link.policy = link_policy_get_by_name(policy);
295 sg_platf_new_link(&link);
300 * add Router to AS components
302 int console_add_router(lua_State* L) {
303 lua_ensure(lua_istable(L, -1), "Bad Arguments to create router, Should be a table with named arguments");
305 lua_pushstring(L, "id");
306 int type = lua_gettable(L, -2);
307 lua_ensure(type == LUA_TSTRING, "Attribute 'id' must be specified for any link and must be a string.");
308 const char* name = lua_tostring(L, -1);
311 lua_pushstring(L,"coord");
313 const char* coords = lua_tostring(L, -1);
316 sg_platf_new_router(name, coords);
321 int console_add_route(lua_State *L) {
322 XBT_DEBUG("Adding route");
323 simgrid::kernel::routing::RouteCreationArgs route;
326 lua_ensure(lua_istable(L, -1), "Bad Arguments to add a route. Should be a table with named arguments");
328 lua_pushstring(L,"src");
329 type = lua_gettable(L,-2);
330 lua_ensure(type == LUA_TSTRING, "Attribute 'src' must be specified for any route and must be a string.");
331 const char *srcName = lua_tostring(L, -1);
332 route.src = sg_netpoint_by_name_or_null(srcName);
333 lua_ensure(route.src != nullptr, "Attribute 'src=%s' of route does not name a node.", srcName);
336 lua_pushstring(L,"dest");
337 type = lua_gettable(L,-2);
338 lua_ensure(type == LUA_TSTRING, "Attribute 'dest' must be specified for any route and must be a string.");
339 const char *dstName = lua_tostring(L, -1);
340 route.dst = sg_netpoint_by_name_or_null(dstName);
341 lua_ensure(route.dst != nullptr, "Attribute 'dst=%s' of route does not name a node.", dstName);
344 lua_pushstring(L,"links");
345 type = lua_gettable(L,-2);
346 lua_ensure(type == LUA_TSTRING,
347 "Attribute 'links' must be specified for any route and must be a string (different links separated by commas or single spaces.");
348 std::vector<std::string> names;
349 const char* str = lua_tostring(L, -1);
350 boost::split(names, str, boost::is_any_of(", \t\r\n"));
353 route.link_list.push_back(simgrid::s4u::Link::by_name(lua_tostring(L, -1))->get_impl());
355 // Several names separated by , \t\r\n
356 for (auto const& name : names) {
357 if (name.length() > 0) {
358 simgrid::kernel::resource::LinkImpl* link = simgrid::s4u::Link::by_name(name)->get_impl();
359 route.link_list.push_back(link);
365 /* We are relying on the XML bypassing mechanism since the corresponding sg_platf does not exist yet.
366 * Et ouais mon pote. That's the way it goes. F34R.
368 * (Note that above this function, there is a #include statement. Is this
369 * comment related to that statement?)
371 lua_pushstring(L,"symmetrical");
373 if (lua_isstring(L, -1)) {
374 const char* value = lua_tostring(L, -1);
375 if (strcmp("YES", value) == 0)
376 route.symmetrical = true;
378 route.symmetrical = false;
381 route.symmetrical = true;
385 route.gw_src = nullptr;
386 route.gw_dst = nullptr;
388 sg_platf_new_route(&route);
393 int console_add_ASroute(lua_State *L) {
394 simgrid::kernel::routing::RouteCreationArgs ASroute;
396 lua_pushstring(L, "src");
398 const char *srcName = lua_tostring(L, -1);
399 ASroute.src = sg_netpoint_by_name_or_null(srcName);
400 lua_ensure(ASroute.src != nullptr, "Attribute 'src=%s' of AS route does not name a node.", srcName);
403 lua_pushstring(L, "dst");
405 const char *dstName = lua_tostring(L, -1);
406 ASroute.dst = sg_netpoint_by_name_or_null(dstName);
407 lua_ensure(ASroute.dst != nullptr, "Attribute 'dst=%s' of AS route does not name a node.", dstName);
410 lua_pushstring(L, "gw_src");
412 const char* pname = lua_tostring(L, -1);
413 ASroute.gw_src = sg_netpoint_by_name_or_null(pname);
414 lua_ensure(ASroute.gw_src, "Attribute 'gw_src=%s' of AS route does not name a valid node", pname);
417 lua_pushstring(L, "gw_dst");
419 pname = lua_tostring(L, -1);
420 ASroute.gw_dst = sg_netpoint_by_name_or_null(pname);
421 lua_ensure(ASroute.gw_dst, "Attribute 'gw_dst=%s' of AS route does not name a valid node", pname);
424 lua_pushstring(L,"links");
426 std::vector<std::string> names;
427 const char* str = lua_tostring(L, -1);
428 boost::split(names, str, boost::is_any_of(", \t\r\n"));
430 /* unique name with no comma */
431 ASroute.link_list.push_back(simgrid::s4u::Link::by_name(lua_tostring(L, -1))->get_impl());
433 // Several names separated by , \t\r\n
434 for (auto const& name : names) {
435 if (name.length() > 0) {
436 simgrid::kernel::resource::LinkImpl* link = simgrid::s4u::Link::by_name(name)->get_impl();
437 ASroute.link_list.push_back(link);
443 lua_pushstring(L,"symmetrical");
445 if (lua_isstring(L, -1)) {
446 const char* value = lua_tostring(L, -1);
447 if (strcmp("YES", value) == 0)
448 ASroute.symmetrical = true;
450 ASroute.symmetrical = false;
453 ASroute.symmetrical = true;
457 sg_platf_new_route(&ASroute);
462 int console_AS_open(lua_State *L) {
463 XBT_DEBUG("Opening AS");
465 lua_ensure(lua_istable(L, 1), "Bad Arguments to AS_open, Should be a table with named arguments");
467 lua_pushstring(L, "id");
468 int type = lua_gettable(L, -2);
469 lua_ensure(type == LUA_TSTRING, "Attribute 'id' must be specified for any AS and must be a string.");
470 const char* id = lua_tostring(L, -1);
473 lua_pushstring(L, "mode");
475 const char* mode = lua_tostring(L, -1);
478 int mode_int = A_surfxml_AS_routing_None;
479 if (not strcmp(mode, "Full"))
480 mode_int = A_surfxml_AS_routing_Full;
481 else if (not strcmp(mode, "Floyd"))
482 mode_int = A_surfxml_AS_routing_Floyd;
483 else if (not strcmp(mode, "Dijkstra"))
484 mode_int = A_surfxml_AS_routing_Dijkstra;
485 else if (not strcmp(mode, "DijkstraCache"))
486 mode_int = A_surfxml_AS_routing_DijkstraCache;
487 else if (not strcmp(mode, "Vivaldi"))
488 mode_int = A_surfxml_AS_routing_Vivaldi;
489 else if (not strcmp(mode, "Cluster"))
490 mode_int = A_surfxml_AS_routing_Cluster;
491 else if (not strcmp(mode, "none"))
492 mode_int = A_surfxml_AS_routing_None;
493 else xbt_die("Don't have the model name '%s'",mode);
495 simgrid::kernel::routing::ZoneCreationArgs AS;
497 AS.routing = mode_int;
498 simgrid::kernel::routing::NetZoneImpl* new_as = sg_platf_new_Zone_begin(&AS);
500 /* Build a Lua representation of the new AS on the stack */
502 simgrid::kernel::routing::NetZoneImpl** lua_as = (simgrid::kernel::routing::NetZoneImpl**)lua_newuserdata(
503 L, sizeof(simgrid::kernel::routing::NetZoneImpl*)); /* table userdatum */
505 luaL_getmetatable(L, PLATF_MODULE_NAME); /* table userdatum metatable */
506 lua_setmetatable(L, -2); /* table userdatum */
507 lua_setfield(L, -2, AS_FIELDNAME); /* table -- put the userdata as field of the table */
512 int console_AS_seal(lua_State*)
514 XBT_DEBUG("Sealing AS");
515 sg_platf_new_Zone_seal();
519 int console_host_set_property(lua_State *L) {
520 lua_ensure(lua_istable(L, -1), "Bad Arguments to create link, Should be a table with named arguments");
523 lua_pushstring(L, "host");
525 const char* name = lua_tostring(L, -1);
529 lua_pushstring(L, "prop");
531 const char* prop_id = lua_tostring(L, -1);
534 lua_pushstring(L,"value");
536 const char* prop_value = lua_tostring(L, -1);
539 sg_host_t host = sg_host_by_name(name);
540 lua_ensure(host, "no host '%s' found",name);
541 host->set_property(prop_id, prop_value);
547 * @brief Registers the platform functions into the table simgrid.platf.
548 * @param L a lua state
550 void sglua_register_platf_functions(lua_State* L)
552 lua_getglobal(L, "simgrid"); /* simgrid */
553 luaL_newlib(L, platf_functions); /* simgrid simgrid.platf */
554 lua_setfield(L, -2, "engine"); /* simgrid */
556 lua_pop(L, 1); /* -- */