1 /* Copyright (c) 2010, 2012-2015. The SimGrid Team.
2 * All rights reserved. */
4 /* This program is free software; you can redistribute it and/or modify it
5 * under the terms of the license (GNU LGPL) which comes with this package. */
7 /* SimGrid Lua bindings */
9 #include "lua_private.h"
10 #include "simgrid/platf_interface.h"
11 #include "surf/surfxml_parse.h"
12 #include "surf/surf_routing.h"
20 #include <simgrid/host.h>
21 #include "src/surf/surf_private.h"
23 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(lua_platf, bindings, "Lua bindings (platform module)");
25 #define PLATF_MODULE_NAME "simgrid.platf"
27 /* ********************************************************************************* */
28 /* simgrid.platf API */
29 /* ********************************************************************************* */
31 static const luaL_Reg platf_functions[] = {
32 {"open", console_open},
33 {"close", console_close},
34 {"AS_open", console_AS_open},
35 {"AS_close", console_AS_close},
36 {"backbone_new", console_add_backbone},
37 {"host_link_new", console_add_host___link},
38 {"host_new", console_add_host},
39 {"link_new", console_add_link},
40 {"router_new", console_add_router},
41 {"route_new", console_add_route},
42 {"ASroute_new", console_add_ASroute},
46 int console_open(lua_State *L) {
50 storage_register_callbacks();
51 routing_register_callbacks();
56 int console_close(lua_State *L) {
62 int console_add_backbone(lua_State *L) {
63 s_sg_platf_link_cbarg_t link;
64 memset(&link,0,sizeof(link));
67 link.properties = NULL;
69 if (!lua_istable(L, -1)) {
71 ("Bad Arguments to create backbone in Lua. Should be a table with named arguments.");
75 lua_pushstring(L, "id");
76 type = lua_gettable(L, -2);
77 if (type != LUA_TSTRING) {
78 XBT_ERROR("Attribute 'id' must be specified for backbone and must be a string.");
80 link.id = lua_tostring(L, -1);
83 lua_pushstring(L, "bandwidth");
84 type = lua_gettable(L, -2);
85 if (type != LUA_TSTRING && type != LUA_TNUMBER) {
86 XBT_ERROR("Attribute 'bandwidth' must be specified for backbone and must either be a string (in the right format; see docs) or a number.");
88 link.bandwidth = surf_parse_get_bandwidth(lua_tostring(L, -1),"bandwidth of backbone",link.id);
91 lua_pushstring(L, "lat");
92 type = lua_gettable(L, -2);
93 if (type != LUA_TSTRING && type != LUA_TNUMBER) {
94 XBT_ERROR("Attribute 'lat' must be specified for backbone and must either be a string (in the right format; see docs) or a number.");
96 link.latency = surf_parse_get_time(lua_tostring(L, -1),"latency of backbone",link.id);
101 lua_pushstring(L, "sharing_policy");
102 type = lua_gettable(L, -2);
103 const char* policy = lua_tostring(L, -1);
104 if (policy && !strcmp(policy,"FULLDUPLEX")) {
105 link.policy = SURF_LINK_FULLDUPLEX;
106 } else if (policy && !strcmp(policy,"FATPIPE")) {
107 link.policy = SURF_LINK_FATPIPE;
109 link.policy = SURF_LINK_SHARED;
112 sg_platf_new_link(&link);
113 routing_cluster_add_backbone(sg_link_by_name(link.id));
118 int console_add_host___link(lua_State *L) {
119 s_sg_platf_host_link_cbarg_t netcard;
120 memset(&netcard,0,sizeof(netcard));
123 // we get values from the table passed as argument
124 if (!lua_istable(L, -1)) {
126 ("Bad Arguments to create host_link in Lua. Should be a table with named arguments.");
130 lua_pushstring(L, "id");
131 type = lua_gettable(L, -2);
132 if (type != LUA_TSTRING) {
133 XBT_ERROR("Attribute 'id' must be specified for any host_link and must be a string.");
135 netcard.id = lua_tostring(L, -1);
138 lua_pushstring(L, "up");
139 type = lua_gettable(L, -2);
140 if (type != LUA_TSTRING && type != LUA_TNUMBER) {
141 XBT_ERROR("Attribute 'up' must be specified for host_link and must either be a string or a number.");
143 netcard.link_up = lua_tostring(L, -1);
146 lua_pushstring(L, "down");
147 type = lua_gettable(L, -2);
148 if (type != LUA_TSTRING && type != LUA_TNUMBER) {
149 XBT_ERROR("Attribute 'down' must be specified for host_link and must either be a string or a number.");
151 netcard.link_down = lua_tostring(L, -1);
154 XBT_DEBUG("Create a host_link for host %s", netcard.id);
155 sg_platf_new_netcard(&netcard);
160 int console_add_host(lua_State *L) {
161 s_sg_platf_host_cbarg_t host;
162 memset(&host,0,sizeof(host));
165 // we get values from the table passed as argument
166 if (!lua_istable(L, -1)) {
168 ("Bad Arguments to create host. Should be a table with named arguments");
173 lua_pushstring(L, "id");
174 type = lua_gettable(L, -2);
175 if (type != LUA_TSTRING) {
176 XBT_ERROR("Attribute 'id' must be specified for any host and must be a string.");
178 host.id = lua_tostring(L, -1);
182 lua_pushstring(L, "speed");
183 type = lua_gettable(L, -2);
184 if (type != LUA_TSTRING && type != LUA_TNUMBER) {
185 XBT_ERROR("Attribute 'speed' must be specified for host and must either be a string (in the correct format; check documentation) or a number.");
187 host.speed_peak = xbt_dynar_new(sizeof(double), NULL);
188 if (type == LUA_TNUMBER)
189 xbt_dynar_push_as(host.speed_peak, double, lua_tointeger(L, -1));
191 xbt_dynar_push_as(host.speed_peak, double, surf_parse_get_speed(lua_tostring(L, -1), "speed of host", host.id));
195 lua_pushstring(L, "core");
197 if(!lua_isnumber(L,-1)) {
198 host.core_amount = 1;// Default value
200 else host.core_amount = lua_tonumber(L, -1);
201 if (host.core_amount == 0)
202 host.core_amount = 1;
206 lua_pushstring(L, "availability");
208 if(!lua_isnumber(L,-1)) host.speed_scale = 1;// Default value
209 else host.speed_scale = lua_tonumber(L, -1);
213 lua_pushstring(L, "availability_file");
215 host.speed_trace = tmgr_trace_new_from_file(lua_tostring(L, -1));
219 lua_pushstring(L, "state");
221 if(!lua_isnumber(L,-1)) state = 1;// Default value
222 else state = lua_tonumber(L, -1);
226 host.initiallyOn = 1;
228 host.initiallyOn = 0;
231 lua_pushstring(L, "state_file");
233 host.state_trace = tmgr_trace_new_from_file(lua_tostring(L, -1));
236 sg_platf_new_host(&host);
237 xbt_dynar_free(&host.speed_peak);
242 int console_add_link(lua_State *L) {
243 s_sg_platf_link_cbarg_t link;
244 memset(&link,0,sizeof(link));
249 if (! lua_istable(L, -1)) {
250 XBT_ERROR("Bad Arguments to create link, Should be a table with named arguments");
255 lua_pushstring(L, "id");
256 type = lua_gettable(L, -2);
257 if (type != LUA_TSTRING && type != LUA_TNUMBER) {
258 XBT_ERROR("Attribute 'id' must be specified for any link and must be a string.");
260 link.id = lua_tostring(L, -1);
263 // get bandwidth value
264 lua_pushstring(L, "bandwidth");
265 type = lua_gettable(L, -2);
266 if (type != LUA_TSTRING && type != LUA_TNUMBER) {
267 XBT_ERROR("Attribute 'bandwidth' must be specified for any link and must either be either a string (in the right format; see docs) or a number.");
269 if (type == LUA_TNUMBER)
270 link.bandwidth = lua_tonumber(L, -1);
272 link.bandwidth = surf_parse_get_bandwidth(lua_tostring(L, -1),"bandwidth of link", link.id);
276 lua_pushstring(L, "lat");
277 type = lua_gettable(L, -2);
278 if (type != LUA_TSTRING && type != LUA_TNUMBER) {
279 XBT_ERROR("Attribute 'lat' must be specified for any link and must either be a string (in the right format; see docs) or a number.");
281 if (type == LUA_TNUMBER)
282 link.latency = lua_tonumber(L, -1);
284 link.latency = surf_parse_get_time(lua_tostring(L, -1),"latency of link", link.id);
287 /*Optional Arguments */
289 //get bandwidth_trace value
290 lua_pushstring(L, "bandwidth_file");
292 link.bandwidth_trace = tmgr_trace_new_from_file(lua_tostring(L, -1));
295 //get latency_trace value
296 lua_pushstring(L, "latency_file");
298 link.latency_trace = tmgr_trace_new_from_file(lua_tostring(L, -1));
301 //get state_trace value
302 lua_pushstring(L, "state_file");
304 link.state_trace = tmgr_trace_new_from_file(lua_tostring(L, -1));
307 //get state_initial value
308 lua_pushstring(L, "state");
310 if (!lua_isnumber(L,-1) || lua_tonumber(L, -1))
311 link.initiallyOn = 1;
313 link.initiallyOn = 0;
317 lua_pushstring(L, "sharing_policy");
319 policy = lua_tostring(L, -1);
321 if (policy && !strcmp(policy,"FULLDUPLEX")) {
322 link.policy = SURF_LINK_FULLDUPLEX;
323 } else if (policy && !strcmp(policy,"FATPIPE")) {
324 link.policy = SURF_LINK_FATPIPE;
326 link.policy = SURF_LINK_SHARED;
329 sg_platf_new_link(&link);
334 * add Router to AS components
336 int console_add_router(lua_State* L) {
337 s_sg_platf_router_cbarg_t router;
338 memset(&router,0,sizeof(router));
341 if (! lua_istable(L, -1)) {
342 XBT_ERROR("Bad Arguments to create router, Should be a table with named arguments");
346 lua_pushstring(L, "id");
347 type = lua_gettable(L, -2);
348 if (type != LUA_TSTRING) {
349 XBT_ERROR("Attribute 'id' must be specified for any link and must be a string.");
351 router.id = lua_tostring(L, -1);
354 lua_pushstring(L,"coord");
356 router.coord = lua_tostring(L, -1);
359 sg_platf_new_router(&router);
364 #include "surf/surfxml_parse.h" /* to override surf_parse and bypass the parser */
366 int console_add_route(lua_State *L) {
367 XBT_DEBUG("Adding route");
368 s_sg_platf_route_cbarg_t route;
369 memset(&route,0,sizeof(route));
372 /* allocating memory for the buffer, I think 2kB should be enough */
373 surfxml_bufferstack = xbt_new0(char, surfxml_bufferstack_size);
375 if (! lua_istable(L, -1)) {
376 XBT_ERROR("Bad Arguments to create a route. Should be a table with named arguments");
380 lua_pushstring(L,"src");
381 type = lua_gettable(L,-2);
382 if (type != LUA_TSTRING) {
383 XBT_ERROR("Attribute 'src' must be specified for any route and must be a string.");
385 route.src = lua_tostring(L, -1);
388 lua_pushstring(L,"dest");
389 type = lua_gettable(L,-2);
390 if (type != LUA_TSTRING) {
391 XBT_ERROR("Attribute 'dest' must be specified for any route and must be a string.");
393 route.dst = lua_tostring(L, -1);
396 lua_pushstring(L,"links");
397 type = lua_gettable(L,-2);
398 if (type != LUA_TSTRING) {
399 XBT_ERROR("Attribute 'links' must be specified for any route and must be a string (different links separated by commas or single spaces.");
401 route.link_list = xbt_str_split(lua_tostring(L, -1), ", \t\r\n");
402 if (xbt_dynar_is_empty(route.link_list))
403 xbt_dynar_push_as(route.link_list,char*,xbt_strdup(lua_tostring(L, -1)));
406 /* We are relying on the XML bypassing mechanism since the corresponding sg_platf does not exist yet.
407 * Et ouais mon pote. That's the way it goes. F34R.
409 * (Note that above this function, there is a #include statement. Is this
410 * comment related to that statement?)
412 lua_pushstring(L,"symmetrical");
414 if (lua_isstring(L, -1)) {
415 const char* value = lua_tostring(L, -1);
416 if (strcmp("YES", value) == 0) {
417 route.symmetrical = TRUE;
420 route.symmetrical = FALSE;
423 route.symmetrical = TRUE;
430 sg_platf_new_route(&route);
435 int console_add_ASroute(lua_State *L) {
436 s_sg_platf_route_cbarg_t ASroute;
437 memset(&ASroute,0,sizeof(ASroute));
439 lua_pushstring(L, "src");
441 ASroute.src = lua_tostring(L, -1);
444 lua_pushstring(L, "dst");
446 ASroute.dst = lua_tostring(L, -1);
449 lua_pushstring(L, "gw_src");
451 ASroute.gw_src = sg_netcard_by_name_or_null(lua_tostring(L, -1));
454 lua_pushstring(L, "gw_dst");
456 ASroute.gw_dst = sg_netcard_by_name_or_null(lua_tostring(L, -1));
459 /*if (A_surfxml_ASroute_gw___src && !ASroute.gw_src)*/
460 /*surf_parse_error("gw_src=\"%s\" not found for ASroute from \"%s\" to \"%s\"",*/
461 /*A_surfxml_ASroute_gw___src, ASroute.src, ASroute.dst);*/
462 /*if (A_surfxml_ASroute_gw___dst && !ASroute.gw_dst)*/
463 /*surf_parse_error("gw_dst=\"%s\" not found for ASroute from \"%s\" to \"%s\"",*/
464 /*A_surfxml_ASroute_gw___dst, ASroute.src, ASroute.dst);*/
466 lua_pushstring(L,"links");
468 ASroute.link_list = xbt_str_split(lua_tostring(L, -1), ", \t\r\n");
469 if (xbt_dynar_is_empty(ASroute.link_list))
470 xbt_dynar_push_as(ASroute.link_list,char*,xbt_strdup(lua_tostring(L, -1)));
473 lua_pushstring(L,"symmetrical");
475 if (lua_isstring(L, -1)) {
476 const char* value = lua_tostring(L, -1);
477 if (strcmp("YES", value) == 0) {
478 ASroute.symmetrical = TRUE;
481 ASroute.symmetrical = FALSE;
484 ASroute.symmetrical = TRUE;
488 sg_platf_new_ASroute(&ASroute);
493 int console_AS_open(lua_State *L) {
498 XBT_DEBUG("Opening AS");
500 if (! lua_istable(L, 1)) {
501 XBT_ERROR("Bad Arguments to AS_open, Should be a table with named arguments");
505 lua_pushstring(L, "id");
506 type = lua_gettable(L, -2);
507 if (type != LUA_TSTRING) {
508 XBT_ERROR("Attribute 'id' must be specified for any AS and must be a string.");
510 id = lua_tostring(L, -1);
513 lua_pushstring(L, "mode");
515 mode = lua_tostring(L, -1);
518 int mode_int = A_surfxml_AS_routing_None;
519 if(!strcmp(mode,"Full")) mode_int = A_surfxml_AS_routing_Full;
520 else if(!strcmp(mode,"Floyd")) mode_int = A_surfxml_AS_routing_Floyd;
521 else if(!strcmp(mode,"Dijkstra")) mode_int = A_surfxml_AS_routing_Dijkstra;
522 else if(!strcmp(mode,"DijkstraCache")) mode_int = A_surfxml_AS_routing_DijkstraCache;
523 else if(!strcmp(mode,"Vivaldi")) mode_int = A_surfxml_AS_routing_Vivaldi;
524 else if(!strcmp(mode,"Cluster")) mode_int = A_surfxml_AS_routing_Cluster;
525 else if(!strcmp(mode,"none")) mode_int = A_surfxml_AS_routing_None;
526 else xbt_die("Don't have the model name '%s'",mode);
528 s_sg_platf_AS_cbarg_t AS = SG_PLATF_AS_INITIALIZER;
530 AS.routing = mode_int;
532 sg_platf_new_AS_begin(&AS);
536 int console_AS_close(lua_State *L) {
537 XBT_DEBUG("Closing AS");
538 sg_platf_new_AS_end();
542 int console_host_set_property(lua_State *L) {
543 const char* name ="";
544 const char* prop_id = "";
545 const char* prop_value = "";
546 if (!lua_istable(L, -1)) {
547 XBT_ERROR("Bad Arguments to create link, Should be a table with named arguments");
553 lua_pushstring(L, "host");
555 name = lua_tostring(L, -1);
559 lua_pushstring(L, "prop");
561 prop_id = lua_tostring(L, -1);
564 lua_pushstring(L,"value");
566 prop_value = lua_tostring(L,-1);
569 sg_host_t host = sg_host_by_name(name);
571 XBT_ERROR("no host '%s' found",name);
574 xbt_dict_t props = sg_host_get_properties(host);
575 xbt_dict_set(props,prop_id,xbt_strdup(prop_value),NULL);
581 * \brief Registers the platform functions into the table simgrid.platf.
582 * \param L a lua state
584 void sglua_register_platf_functions(lua_State* L)
586 lua_getglobal(L, "simgrid"); /* simgrid */
587 luaL_newlib(L, platf_functions); /* simgrid simgrid.platf */
588 lua_setfield(L, -2, "platf"); /* simgrid */
590 lua_pop(L, 1); /* -- */
593 //void sglua_register_routing_constants(lua_State* L)
595 // lua_getglobal(L, "simgrid"); /* simgrid */
596 // lua_newtable(L); /* simgrid simgrid.routing */
598 // lua_pushstring(L, "Cluster"); /* simgrid simgrid.routing Cluster */
599 // lua_setfield(L, -2, "CLUSTER"); /* simgrid simgrid.routing */
601 // lua_pushstring(L, "Dijkstra"); /* simgrid simgrid.routing Dijkstra */
602 // lua_setfield(L, -2, "DIJKSTRA"); /* simgrid simgrid.routing */
604 // lua_pushstring(L, "DijkstraCache"); /* simgrid simgrid.routing DijkstraCache */
605 // lua_setfield(L, -2, "DIJKSTRA_CACHE"); /* simgrid simgrid.routing */
607 // lua_pushstring(L, "Floyd"); /* simgrid simgrid.routing Floyd */
608 // lua_setfield(L, -2, "FLOYD"); /* simgrid simgrid.routing */
610 // lua_pushstring(L, "Full"); /* simgrid simgrid.routing Full */
611 // lua_setfield(L, -2, "FULL"); /* simgrid simgrid.routing */
613 // lua_pushstring(L, "None"); /* simgrid simgrid.routing None */
614 // lua_setfield(L, -2, "NONE"); /* simgrid simgrid.routing */
616 // lua_pushstring(L, "Vivaldi"); /* simgrid simgrid.routing Vivaldi */
617 // lua_setfield(L, -2, "FULL"); /* simgrid simgrid.routing */
619 // lua_setfield(L, -2, "routing"); /* simgrid */
621 // lua_pop(L, 1); /* -- */