1 /* Copyright (c) 2010-2017. 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 "src/kernel/routing/NetPoint.hpp"
10 #include "src/surf/network_interface.hpp"
11 #include "src/surf/xml/platf_private.hpp"
19 #include "src/surf/surf_private.hpp"
20 #include <boost/algorithm/string/classification.hpp>
21 #include <boost/algorithm/string/split.hpp>
22 #include <simgrid/s4u/Host.hpp>
26 XBT_LOG_NEW_DEFAULT_CATEGORY(lua_platf, "Lua bindings (platform module)");
28 #define PLATF_MODULE_NAME "simgrid.engine"
29 #define AS_FIELDNAME "__simgrid_as"
31 /* ********************************************************************************* */
32 /* simgrid.platf API */
33 /* ********************************************************************************* */
35 static const luaL_Reg platf_functions[] = {
36 {"open", console_open},
37 {"close", console_close},
38 {"AS_open", console_AS_open},
39 {"AS_seal", console_AS_seal},
40 {"backbone_new", console_add_backbone},
41 {"host_link_new", console_add_host___link},
42 {"host_new", console_add_host},
43 {"link_new", console_add_link},
44 {"router_new", console_add_router},
45 {"route_new", console_add_route},
46 {"ASroute_new", console_add_ASroute},
50 int console_open(lua_State *L) {
54 storage_register_callbacks();
59 int console_close(lua_State *L) {
65 int console_add_backbone(lua_State *L) {
66 LinkCreationArgs link;
68 link.properties = nullptr;
70 lua_ensure(lua_istable(L, -1),"Bad Arguments to create backbone in Lua. Should be a table with named arguments.");
72 lua_pushstring(L, "id");
73 int type = lua_gettable(L, -2);
74 lua_ensure(type == LUA_TSTRING, "Attribute 'id' must be specified for backbone and must be a string.");
75 link.id = lua_tostring(L, -1);
78 lua_pushstring(L, "bandwidth");
79 type = lua_gettable(L, -2);
80 lua_ensure(type == LUA_TSTRING || type == LUA_TNUMBER,
81 "Attribute 'bandwidth' must be specified for backbone and must either be a string (in the right format; see docs) or a number.");
82 link.bandwidth = surf_parse_get_bandwidth(lua_tostring(L, -1), "bandwidth of backbone", link.id.c_str());
85 lua_pushstring(L, "lat");
86 type = lua_gettable(L, -2);
87 lua_ensure(type == LUA_TSTRING || type == LUA_TNUMBER,
88 "Attribute 'lat' must be specified for backbone and must either be a string (in the right format; see docs) or a number.");
89 link.latency = surf_parse_get_time(lua_tostring(L, -1), "latency of backbone", link.id.c_str());
92 lua_pushstring(L, "sharing_policy");
94 const char* policy = lua_tostring(L, -1);
96 if (policy && not strcmp(policy, "FULLDUPLEX")) {
97 link.policy = SURF_LINK_FULLDUPLEX;
98 } else if (policy && not strcmp(policy, "FATPIPE")) {
99 link.policy = SURF_LINK_FATPIPE;
101 link.policy = SURF_LINK_SHARED;
104 sg_platf_new_link(&link);
105 routing_cluster_add_backbone(simgrid::surf::LinkImpl::byName(link.id));
110 int console_add_host___link(lua_State *L) {
111 HostLinkCreationArgs hostlink;
114 lua_ensure(lua_istable(L, -1), "Bad Arguments to create host_link in Lua. Should be a table with named arguments.");
116 lua_pushstring(L, "id");
117 type = lua_gettable(L, -2);
118 lua_ensure(type == LUA_TSTRING, "Attribute 'id' must be specified for any host_link and must be a string.");
119 hostlink.id = lua_tostring(L, -1);
122 lua_pushstring(L, "up");
123 type = lua_gettable(L, -2);
124 lua_ensure(type == LUA_TSTRING || type == LUA_TNUMBER,
125 "Attribute 'up' must be specified for host_link and must either be a string or a number.");
126 hostlink.link_up = lua_tostring(L, -1);
129 lua_pushstring(L, "down");
130 type = lua_gettable(L, -2);
131 lua_ensure(type == LUA_TSTRING || type == LUA_TNUMBER,
132 "Attribute 'down' must be specified for host_link and must either be a string or a number.");
133 hostlink.link_down = lua_tostring(L, -1);
136 XBT_DEBUG("Create a host_link for host %s", hostlink.id.c_str());
137 sg_platf_new_hostlink(&hostlink);
142 int console_add_host(lua_State *L) {
143 s_sg_platf_host_cbarg_t host;
146 // we get values from the table passed as argument
147 lua_ensure(lua_istable(L, -1),
148 "Bad Arguments to create host. Should be a table with named arguments");
151 lua_pushstring(L, "id");
152 type = lua_gettable(L, -2);
153 lua_ensure(type == LUA_TSTRING,
154 "Attribute 'id' must be specified for any host and must be a string.");
155 host.id = lua_tostring(L, -1);
159 lua_pushstring(L, "speed");
160 type = lua_gettable(L, -2);
161 lua_ensure(type == LUA_TSTRING || type == LUA_TNUMBER,
162 "Attribute 'speed' must be specified for host and must either be a string (in the correct format; check documentation) or a number.");
163 if (type == LUA_TNUMBER)
164 host.speed_per_pstate.push_back(lua_tointeger(L, -1));
166 host.speed_per_pstate.push_back(surf_parse_get_speed(lua_tostring(L, -1), "speed of host", host.id));
170 lua_pushstring(L, "core");
172 if (not lua_isnumber(L, -1))
173 host.core_amount = 1; // Default value
175 host.core_amount = lua_tonumber(L, -1);
176 if (host.core_amount == 0)
177 host.core_amount = 1;
181 lua_pushstring(L, "availability_file");
183 const char *filename = lua_tostring(L, -1);
185 host.speed_trace = tmgr_trace_new_from_file(filename);
189 lua_pushstring(L, "state_file");
191 filename = lua_tostring(L, -1);
193 host.state_trace = tmgr_trace_new_from_file(filename);
196 sg_platf_new_host(&host);
201 int console_add_link(lua_State *L) {
202 LinkCreationArgs link;
206 lua_ensure(lua_istable(L, -1), "Bad Arguments to create link, Should be a table with named arguments");
209 lua_pushstring(L, "id");
210 int type = lua_gettable(L, -2);
211 lua_ensure(type == LUA_TSTRING || type == LUA_TNUMBER,
212 "Attribute 'id' must be specified for any link and must be a string.");
213 link.id = lua_tostring(L, -1);
216 // get bandwidth value
217 lua_pushstring(L, "bandwidth");
218 type = lua_gettable(L, -2);
219 lua_ensure(type == LUA_TSTRING || type == LUA_TNUMBER,
220 "Attribute 'bandwidth' must be specified for any link and must either be either a string (in the right format; see docs) or a number.");
221 if (type == LUA_TNUMBER)
222 link.bandwidth = lua_tonumber(L, -1);
224 link.bandwidth = surf_parse_get_bandwidth(lua_tostring(L, -1), "bandwidth of link", link.id.c_str());
228 lua_pushstring(L, "lat");
229 type = lua_gettable(L, -2);
230 lua_ensure(type == LUA_TSTRING || type == LUA_TNUMBER,
231 "Attribute 'lat' must be specified for any link and must either be a string (in the right format; see docs) or a number.");
232 if (type == LUA_TNUMBER)
233 link.latency = lua_tonumber(L, -1);
235 link.latency = surf_parse_get_time(lua_tostring(L, -1), "latency of link", link.id.c_str());
238 /*Optional Arguments */
240 //get bandwidth_trace value
241 lua_pushstring(L, "bandwidth_file");
243 const char *filename = lua_tostring(L, -1);
245 link.bandwidth_trace = tmgr_trace_new_from_file(filename);
248 //get latency_trace value
249 lua_pushstring(L, "latency_file");
251 filename = lua_tostring(L, -1);
253 link.latency_trace = tmgr_trace_new_from_file(filename);
256 //get state_trace value
257 lua_pushstring(L, "state_file");
259 filename = lua_tostring(L, -1);
261 link.state_trace = tmgr_trace_new_from_file(filename);
265 lua_pushstring(L, "sharing_policy");
267 policy = lua_tostring(L, -1);
269 if (policy && not strcmp(policy, "FULLDUPLEX")) {
270 link.policy = SURF_LINK_FULLDUPLEX;
271 } else if (policy && not strcmp(policy, "FATPIPE")) {
272 link.policy = SURF_LINK_FATPIPE;
274 link.policy = SURF_LINK_SHARED;
277 sg_platf_new_link(&link);
282 * add Router to AS components
284 int console_add_router(lua_State* L) {
285 lua_ensure(lua_istable(L, -1), "Bad Arguments to create router, Should be a table with named arguments");
287 lua_pushstring(L, "id");
288 int type = lua_gettable(L, -2);
289 lua_ensure(type == LUA_TSTRING, "Attribute 'id' must be specified for any link and must be a string.");
290 const char* name = lua_tostring(L, -1);
293 lua_pushstring(L,"coord");
295 const char* coords = lua_tostring(L, -1);
298 sg_platf_new_router(name, coords);
303 int console_add_route(lua_State *L) {
304 XBT_DEBUG("Adding route");
305 s_sg_platf_route_cbarg_t route;
308 lua_ensure(lua_istable(L, -1), "Bad Arguments to add a route. Should be a table with named arguments");
310 lua_pushstring(L,"src");
311 type = lua_gettable(L,-2);
312 lua_ensure(type == LUA_TSTRING, "Attribute 'src' must be specified for any route and must be a string.");
313 const char *srcName = lua_tostring(L, -1);
314 route.src = sg_netpoint_by_name_or_null(srcName);
315 lua_ensure(route.src != nullptr, "Attribute 'src=%s' of route does not name a node.", srcName);
318 lua_pushstring(L,"dest");
319 type = lua_gettable(L,-2);
320 lua_ensure(type == LUA_TSTRING, "Attribute 'dest' must be specified for any route and must be a string.");
321 const char *dstName = lua_tostring(L, -1);
322 route.dst = sg_netpoint_by_name_or_null(dstName);
323 lua_ensure(route.dst != nullptr, "Attribute 'dst=%s' of route does not name a node.", dstName);
326 lua_pushstring(L,"links");
327 type = lua_gettable(L,-2);
328 lua_ensure(type == LUA_TSTRING,
329 "Attribute 'links' must be specified for any route and must be a string (different links separated by commas or single spaces.");
330 std::vector<std::string> names;
331 const char* str = lua_tostring(L, -1);
332 boost::split(names, str, boost::is_any_of(", \t\r\n"));
335 route.link_list.push_back(simgrid::surf::LinkImpl::byName(lua_tostring(L, -1)));
337 // Several names separated by , \t\r\n
338 for (auto const& name : names) {
339 if (name.length() > 0) {
340 simgrid::surf::LinkImpl* link = simgrid::surf::LinkImpl::byName(name);
341 route.link_list.push_back(link);
347 /* We are relying on the XML bypassing mechanism since the corresponding sg_platf does not exist yet.
348 * Et ouais mon pote. That's the way it goes. F34R.
350 * (Note that above this function, there is a #include statement. Is this
351 * comment related to that statement?)
353 lua_pushstring(L,"symmetrical");
355 if (lua_isstring(L, -1)) {
356 const char* value = lua_tostring(L, -1);
357 if (strcmp("YES", value) == 0)
358 route.symmetrical = true;
360 route.symmetrical = false;
363 route.symmetrical = true;
367 route.gw_src = nullptr;
368 route.gw_dst = nullptr;
370 sg_platf_new_route(&route);
375 int console_add_ASroute(lua_State *L) {
376 s_sg_platf_route_cbarg_t ASroute;
378 lua_pushstring(L, "src");
380 const char *srcName = lua_tostring(L, -1);
381 ASroute.src = sg_netpoint_by_name_or_null(srcName);
382 lua_ensure(ASroute.src != nullptr, "Attribute 'src=%s' of AS route does not name a node.", srcName);
385 lua_pushstring(L, "dst");
387 const char *dstName = lua_tostring(L, -1);
388 ASroute.dst = sg_netpoint_by_name_or_null(dstName);
389 lua_ensure(ASroute.dst != nullptr, "Attribute 'dst=%s' of AS route does not name a node.", dstName);
392 lua_pushstring(L, "gw_src");
394 const char *name = lua_tostring(L, -1);
395 ASroute.gw_src = sg_netpoint_by_name_or_null(name);
396 lua_ensure(ASroute.gw_src, "Attribute 'gw_src=%s' of AS route does not name a valid node", name);
399 lua_pushstring(L, "gw_dst");
401 name = lua_tostring(L, -1);
402 ASroute.gw_dst = sg_netpoint_by_name_or_null(name);
403 lua_ensure(ASroute.gw_dst, "Attribute 'gw_dst=%s' of AS route does not name a valid node", name);
406 lua_pushstring(L,"links");
408 std::vector<std::string> names;
409 const char* str = lua_tostring(L, -1);
410 boost::split(names, str, boost::is_any_of(", \t\r\n"));
412 /* unique name with no comma */
413 ASroute.link_list.push_back(simgrid::surf::LinkImpl::byName(lua_tostring(L, -1)));
415 // Several names separated by , \t\r\n
416 for (auto const& name : names) {
417 if (name.length() > 0) {
418 simgrid::surf::LinkImpl* link = simgrid::surf::LinkImpl::byName(name);
419 ASroute.link_list.push_back(link);
425 lua_pushstring(L,"symmetrical");
427 if (lua_isstring(L, -1)) {
428 const char* value = lua_tostring(L, -1);
429 if (strcmp("YES", value) == 0)
430 ASroute.symmetrical = true;
432 ASroute.symmetrical = false;
435 ASroute.symmetrical = true;
439 sg_platf_new_route(&ASroute);
444 int console_AS_open(lua_State *L) {
445 XBT_DEBUG("Opening AS");
447 lua_ensure(lua_istable(L, 1), "Bad Arguments to AS_open, Should be a table with named arguments");
449 lua_pushstring(L, "id");
450 int type = lua_gettable(L, -2);
451 lua_ensure(type == LUA_TSTRING, "Attribute 'id' must be specified for any AS and must be a string.");
452 const char* id = lua_tostring(L, -1);
455 lua_pushstring(L, "mode");
457 const char* mode = lua_tostring(L, -1);
460 int mode_int = A_surfxml_AS_routing_None;
461 if (not strcmp(mode, "Full"))
462 mode_int = A_surfxml_AS_routing_Full;
463 else if (not strcmp(mode, "Floyd"))
464 mode_int = A_surfxml_AS_routing_Floyd;
465 else if (not strcmp(mode, "Dijkstra"))
466 mode_int = A_surfxml_AS_routing_Dijkstra;
467 else if (not strcmp(mode, "DijkstraCache"))
468 mode_int = A_surfxml_AS_routing_DijkstraCache;
469 else if (not strcmp(mode, "Vivaldi"))
470 mode_int = A_surfxml_AS_routing_Vivaldi;
471 else if (not strcmp(mode, "Cluster"))
472 mode_int = A_surfxml_AS_routing_Cluster;
473 else if (not strcmp(mode, "none"))
474 mode_int = A_surfxml_AS_routing_None;
475 else xbt_die("Don't have the model name '%s'",mode);
479 AS.routing = mode_int;
480 simgrid::s4u::NetZone* new_as = sg_platf_new_Zone_begin(&AS);
482 /* Build a Lua representation of the new AS on the stack */
484 simgrid::s4u::NetZone** lua_as =
485 (simgrid::s4u::NetZone**)lua_newuserdata(L, sizeof(simgrid::s4u::NetZone*)); /* table userdatum */
487 luaL_getmetatable(L, PLATF_MODULE_NAME); /* table userdatum metatable */
488 lua_setmetatable(L, -2); /* table userdatum */
489 lua_setfield(L, -2, AS_FIELDNAME); /* table -- put the userdata as field of the table */
493 int console_AS_seal(lua_State *L) {
494 XBT_DEBUG("Sealing AS");
495 sg_platf_new_Zone_seal();
499 int console_host_set_property(lua_State *L) {
500 lua_ensure(lua_istable(L, -1), "Bad Arguments to create link, Should be a table with named arguments");
503 lua_pushstring(L, "host");
505 const char* name = lua_tostring(L, -1);
509 lua_pushstring(L, "prop");
511 const char* prop_id = lua_tostring(L, -1);
514 lua_pushstring(L,"value");
516 const char* prop_value = lua_tostring(L, -1);
519 sg_host_t host = sg_host_by_name(name);
520 lua_ensure(host, "no host '%s' found",name);
521 host->setProperty(prop_id, prop_value);
527 * \brief Registers the platform functions into the table simgrid.platf.
528 * \param L a lua state
530 void sglua_register_platf_functions(lua_State* L)
532 lua_getglobal(L, "simgrid"); /* simgrid */
533 luaL_newlib(L, platf_functions); /* simgrid simgrid.platf */
534 lua_setfield(L, -2, "engine"); /* simgrid */
536 lua_pop(L, 1); /* -- */