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.h"
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.h"
20 #include <boost/algorithm/string/classification.hpp>
21 #include <boost/algorithm/string/split.hpp>
22 #include <simgrid/host.h>
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");
93 type = lua_gettable(L, -2);
94 const char* policy = lua_tostring(L, -1);
95 if (policy && not strcmp(policy, "FULLDUPLEX")) {
96 link.policy = SURF_LINK_FULLDUPLEX;
97 } else if (policy && not strcmp(policy, "FATPIPE")) {
98 link.policy = SURF_LINK_FATPIPE;
100 link.policy = SURF_LINK_SHARED;
103 sg_platf_new_link(&link);
104 routing_cluster_add_backbone(simgrid::surf::LinkImpl::byName(link.id.c_str()));
109 int console_add_host___link(lua_State *L) {
110 s_sg_platf_host_link_cbarg_t hostlink;
111 memset(&hostlink,0,sizeof(hostlink));
114 lua_ensure(lua_istable(L, -1),
115 "Bad Arguments to create host_link in Lua. Should be a table with named arguments.");
117 lua_pushstring(L, "id");
118 type = lua_gettable(L, -2);
119 lua_ensure(type == LUA_TSTRING, "Attribute 'id' must be specified for any host_link and must be a string.");
120 hostlink.id = lua_tostring(L, -1);
123 lua_pushstring(L, "up");
124 type = lua_gettable(L, -2);
125 lua_ensure(type == LUA_TSTRING || type == LUA_TNUMBER,
126 "Attribute 'up' must be specified for host_link and must either be a string or a number.");
127 hostlink.link_up = lua_tostring(L, -1);
130 lua_pushstring(L, "down");
131 type = lua_gettable(L, -2);
132 lua_ensure(type == LUA_TSTRING || type == LUA_TNUMBER,
133 "Attribute 'down' must be specified for host_link and must either be a string or a number.");
134 hostlink.link_down = lua_tostring(L, -1);
137 XBT_DEBUG("Create a host_link for host %s", hostlink.id);
138 sg_platf_new_hostlink(&hostlink);
143 int console_add_host(lua_State *L) {
144 s_sg_platf_host_cbarg_t host;
145 memset(&host,0,sizeof(host));
148 // we get values from the table passed as argument
149 lua_ensure(lua_istable(L, -1),
150 "Bad Arguments to create host. Should be a table with named arguments");
153 lua_pushstring(L, "id");
154 type = lua_gettable(L, -2);
155 lua_ensure(type == LUA_TSTRING,
156 "Attribute 'id' must be specified for any host and must be a string.");
157 host.id = lua_tostring(L, -1);
161 lua_pushstring(L, "speed");
162 type = lua_gettable(L, -2);
163 lua_ensure(type == LUA_TSTRING || type == LUA_TNUMBER,
164 "Attribute 'speed' must be specified for host and must either be a string (in the correct format; check documentation) or a number.");
165 if (type == LUA_TNUMBER)
166 host.speed_per_pstate.push_back(lua_tointeger(L, -1));
168 host.speed_per_pstate.push_back(surf_parse_get_speed(lua_tostring(L, -1), "speed of host", host.id));
172 lua_pushstring(L, "core");
174 if (not lua_isnumber(L, -1))
175 host.core_amount = 1; // Default value
177 host.core_amount = lua_tonumber(L, -1);
178 if (host.core_amount == 0)
179 host.core_amount = 1;
183 lua_pushstring(L, "availability_file");
185 const char *filename = lua_tostring(L, -1);
187 host.speed_trace = tmgr_trace_new_from_file(filename);
191 lua_pushstring(L, "state_file");
193 filename = lua_tostring(L, -1);
195 host.state_trace = tmgr_trace_new_from_file(filename);
198 sg_platf_new_host(&host);
203 int console_add_link(lua_State *L) {
204 LinkCreationArgs link;
208 lua_ensure(lua_istable(L, -1), "Bad Arguments to create link, Should be a table with named arguments");
211 lua_pushstring(L, "id");
212 int type = lua_gettable(L, -2);
213 lua_ensure(type == LUA_TSTRING || type == LUA_TNUMBER,
214 "Attribute 'id' must be specified for any link and must be a string.");
215 link.id = lua_tostring(L, -1);
218 // get bandwidth value
219 lua_pushstring(L, "bandwidth");
220 type = lua_gettable(L, -2);
221 lua_ensure(type == LUA_TSTRING || type == LUA_TNUMBER,
222 "Attribute 'bandwidth' must be specified for any link and must either be either a string (in the right format; see docs) or a number.");
223 if (type == LUA_TNUMBER)
224 link.bandwidth = lua_tonumber(L, -1);
226 link.bandwidth = surf_parse_get_bandwidth(lua_tostring(L, -1), "bandwidth of link", link.id.c_str());
230 lua_pushstring(L, "lat");
231 type = lua_gettable(L, -2);
232 lua_ensure(type == LUA_TSTRING || type == LUA_TNUMBER,
233 "Attribute 'lat' must be specified for any link and must either be a string (in the right format; see docs) or a number.");
234 if (type == LUA_TNUMBER)
235 link.latency = lua_tonumber(L, -1);
237 link.latency = surf_parse_get_time(lua_tostring(L, -1), "latency of link", link.id.c_str());
240 /*Optional Arguments */
242 //get bandwidth_trace value
243 lua_pushstring(L, "bandwidth_file");
245 const char *filename = lua_tostring(L, -1);
247 link.bandwidth_trace = tmgr_trace_new_from_file(filename);
250 //get latency_trace value
251 lua_pushstring(L, "latency_file");
253 filename = lua_tostring(L, -1);
255 link.latency_trace = tmgr_trace_new_from_file(filename);
258 //get state_trace value
259 lua_pushstring(L, "state_file");
261 filename = lua_tostring(L, -1);
263 link.state_trace = tmgr_trace_new_from_file(filename);
267 lua_pushstring(L, "sharing_policy");
269 policy = lua_tostring(L, -1);
271 if (policy && not strcmp(policy, "FULLDUPLEX")) {
272 link.policy = SURF_LINK_FULLDUPLEX;
273 } else if (policy && not strcmp(policy, "FATPIPE")) {
274 link.policy = SURF_LINK_FATPIPE;
276 link.policy = SURF_LINK_SHARED;
279 sg_platf_new_link(&link);
284 * add Router to AS components
286 int console_add_router(lua_State* L) {
287 lua_ensure(lua_istable(L, -1),
288 "Bad Arguments to create router, Should be a table with named arguments");
290 lua_pushstring(L, "id");
291 int type = lua_gettable(L, -2);
292 lua_ensure(type == LUA_TSTRING, "Attribute 'id' must be specified for any link and must be a string.");
293 const char* name = lua_tostring(L, -1);
296 lua_pushstring(L,"coord");
298 const char* coords = lua_tostring(L, -1);
301 sg_platf_new_router(name, coords);
306 int console_add_route(lua_State *L) {
307 XBT_DEBUG("Adding route");
308 s_sg_platf_route_cbarg_t route;
309 memset(&route,0,sizeof(route));
312 lua_ensure(lua_istable(L, -1), "Bad Arguments to add a route. Should be a table with named arguments");
314 lua_pushstring(L,"src");
315 type = lua_gettable(L,-2);
316 lua_ensure(type == LUA_TSTRING, "Attribute 'src' must be specified for any route and must be a string.");
317 const char *srcName = lua_tostring(L, -1);
318 route.src = sg_netpoint_by_name_or_null(srcName);
319 lua_ensure(route.src != nullptr, "Attribute 'src=%s' of route does not name a node.", srcName);
322 lua_pushstring(L,"dest");
323 type = lua_gettable(L,-2);
324 lua_ensure(type == LUA_TSTRING, "Attribute 'dest' must be specified for any route and must be a string.");
325 const char *dstName = lua_tostring(L, -1);
326 route.dst = sg_netpoint_by_name_or_null(dstName);
327 lua_ensure(route.dst != nullptr, "Attribute 'dst=%s' of route does not name a node.", dstName);
330 lua_pushstring(L,"links");
331 type = lua_gettable(L,-2);
332 lua_ensure(type == LUA_TSTRING,
333 "Attribute 'links' must be specified for any route and must be a string (different links separated by commas or single spaces.");
334 route.link_list = new std::vector<simgrid::surf::LinkImpl*>();
335 std::vector<std::string> names;
336 const char* str = lua_tostring(L, -1);
337 boost::split(names, str, boost::is_any_of(", \t\r\n"));
340 route.link_list->push_back(simgrid::surf::LinkImpl::byName(lua_tostring(L, -1)));
342 // Several names separated by , \t\r\n
343 for (auto name : names) {
344 if (name.length() > 0) {
345 simgrid::surf::LinkImpl* link = simgrid::surf::LinkImpl::byName(name.c_str());
346 route.link_list->push_back(link);
352 /* We are relying on the XML bypassing mechanism since the corresponding sg_platf does not exist yet.
353 * Et ouais mon pote. That's the way it goes. F34R.
355 * (Note that above this function, there is a #include statement. Is this
356 * comment related to that statement?)
358 lua_pushstring(L,"symmetrical");
360 if (lua_isstring(L, -1)) {
361 const char* value = lua_tostring(L, -1);
362 if (strcmp("YES", value) == 0)
363 route.symmetrical = true;
365 route.symmetrical = false;
368 route.symmetrical = true;
372 route.gw_src = nullptr;
373 route.gw_dst = nullptr;
375 sg_platf_new_route(&route);
376 delete route.link_list;
381 int console_add_ASroute(lua_State *L) {
382 s_sg_platf_route_cbarg_t ASroute;
383 memset(&ASroute,0,sizeof(ASroute));
385 lua_pushstring(L, "src");
387 const char *srcName = lua_tostring(L, -1);
388 ASroute.src = sg_netpoint_by_name_or_null(srcName);
389 lua_ensure(ASroute.src != nullptr, "Attribute 'src=%s' of AS route does not name a node.", srcName);
392 lua_pushstring(L, "dst");
394 const char *dstName = lua_tostring(L, -1);
395 ASroute.dst = sg_netpoint_by_name_or_null(dstName);
396 lua_ensure(ASroute.dst != nullptr, "Attribute 'dst=%s' of AS route does not name a node.", dstName);
399 lua_pushstring(L, "gw_src");
401 const char *name = lua_tostring(L, -1);
402 ASroute.gw_src = sg_netpoint_by_name_or_null(name);
403 lua_ensure(ASroute.gw_src, "Attribute 'gw_src=%s' of AS route does not name a valid node", name);
406 lua_pushstring(L, "gw_dst");
408 name = lua_tostring(L, -1);
409 ASroute.gw_dst = sg_netpoint_by_name_or_null(name);
410 lua_ensure(ASroute.gw_dst, "Attribute 'gw_dst=%s' of AS route does not name a valid node", name);
413 lua_pushstring(L,"links");
415 ASroute.link_list = new std::vector<simgrid::surf::LinkImpl*>();
416 std::vector<std::string> names;
417 const char* str = lua_tostring(L, -1);
418 boost::split(names, str, boost::is_any_of(", \t\r\n"));
420 /* unique name with no comma */
421 ASroute.link_list->push_back(simgrid::surf::LinkImpl::byName(lua_tostring(L, -1)));
423 // Several names separated by , \t\r\n
424 for (auto name : names) {
425 if (name.length() > 0) {
426 simgrid::surf::LinkImpl* link = simgrid::surf::LinkImpl::byName(name.c_str());
427 ASroute.link_list->push_back(link);
433 lua_pushstring(L,"symmetrical");
435 if (lua_isstring(L, -1)) {
436 const char* value = lua_tostring(L, -1);
437 if (strcmp("YES", value) == 0)
438 ASroute.symmetrical = true;
440 ASroute.symmetrical = false;
443 ASroute.symmetrical = true;
447 sg_platf_new_route(&ASroute);
448 delete ASroute.link_list;
453 int console_AS_open(lua_State *L) {
454 XBT_DEBUG("Opening AS");
456 lua_ensure(lua_istable(L, 1), "Bad Arguments to AS_open, Should be a table with named arguments");
458 lua_pushstring(L, "id");
459 int type = lua_gettable(L, -2);
460 lua_ensure(type == LUA_TSTRING, "Attribute 'id' must be specified for any AS and must be a string.");
461 const char* id = lua_tostring(L, -1);
464 lua_pushstring(L, "mode");
466 const char* mode = lua_tostring(L, -1);
469 int mode_int = A_surfxml_AS_routing_None;
470 if (not strcmp(mode, "Full"))
471 mode_int = A_surfxml_AS_routing_Full;
472 else if (not strcmp(mode, "Floyd"))
473 mode_int = A_surfxml_AS_routing_Floyd;
474 else if (not strcmp(mode, "Dijkstra"))
475 mode_int = A_surfxml_AS_routing_Dijkstra;
476 else if (not strcmp(mode, "DijkstraCache"))
477 mode_int = A_surfxml_AS_routing_DijkstraCache;
478 else if (not strcmp(mode, "Vivaldi"))
479 mode_int = A_surfxml_AS_routing_Vivaldi;
480 else if (not strcmp(mode, "Cluster"))
481 mode_int = A_surfxml_AS_routing_Cluster;
482 else if (not strcmp(mode, "none"))
483 mode_int = A_surfxml_AS_routing_None;
484 else xbt_die("Don't have the model name '%s'",mode);
486 s_sg_platf_AS_cbarg_t AS;
488 AS.routing = mode_int;
489 simgrid::s4u::NetZone* new_as = sg_platf_new_AS_begin(&AS);
491 /* Build a Lua representation of the new AS on the stack */
493 simgrid::s4u::NetZone** lua_as =
494 (simgrid::s4u::NetZone**)lua_newuserdata(L, sizeof(simgrid::s4u::NetZone*)); /* table userdatum */
496 luaL_getmetatable(L, PLATF_MODULE_NAME); /* table userdatum metatable */
497 lua_setmetatable(L, -2); /* table userdatum */
498 lua_setfield(L, -2, AS_FIELDNAME); /* table -- put the userdata as field of the table */
502 int console_AS_seal(lua_State *L) {
503 XBT_DEBUG("Sealing AS");
504 sg_platf_new_AS_seal();
508 int console_host_set_property(lua_State *L) {
509 lua_ensure(lua_istable(L, -1), "Bad Arguments to create link, Should be a table with named arguments");
512 lua_pushstring(L, "host");
514 const char* name = lua_tostring(L, -1);
518 lua_pushstring(L, "prop");
520 const char* prop_id = lua_tostring(L, -1);
523 lua_pushstring(L,"value");
525 const char* prop_value = lua_tostring(L, -1);
528 sg_host_t host = sg_host_by_name(name);
529 lua_ensure(host, "no host '%s' found",name);
530 host->setProperty(prop_id, prop_value);
536 * \brief Registers the platform functions into the table simgrid.platf.
537 * \param L a lua state
539 void sglua_register_platf_functions(lua_State* L)
541 lua_getglobal(L, "simgrid"); /* simgrid */
542 luaL_newlib(L, platf_functions); /* simgrid simgrid.platf */
543 lua_setfield(L, -2, "engine"); /* simgrid */
545 lua_pop(L, 1); /* -- */