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"
17 #include "src/msg/msg_private.h"
18 #include "src/simix/smx_host_private.h"
19 #include "src/surf/surf_private.h"
21 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(lua_platf, bindings, "Lua bindings (platform module)");
23 #define PLATF_MODULE_NAME "simgrid.platf"
25 /* ********************************************************************************* */
26 /* simgrid.platf API */
27 /* ********************************************************************************* */
29 static const luaL_Reg platf_functions[] = {
30 {"open", console_open},
31 {"close", console_close},
32 {"AS_open", console_AS_open},
33 {"AS_close", console_AS_close},
34 {"backbone_new", console_add_backbone},
35 {"host_link_new", console_add_host___link},
36 {"host_new", console_add_host},
37 {"link_new", console_add_link},
38 {"router_new", console_add_router},
39 {"route_new", console_add_route},
40 {"ASroute_new", console_add_ASroute},
44 int console_open(lua_State *L) {
48 storage_register_callbacks();
49 routing_register_callbacks();
51 gpu_register_callbacks();
56 int console_close(lua_State *L) {
60 xbt_lib_cursor_t cursor;
64 /* Initialize MSG and WKS hosts */
65 XBT_DEBUG("Initialize MSG and WKS hosts");
66 xbt_lib_foreach(host_lib, cursor, name, data) {
67 if(data[SURF_HOST_LEVEL]){
68 XBT_DEBUG("\tSee surf host %s",name);
69 SIMIX_host_create(name);
70 // THIS IS BRAINDEAD. There is no sg_host_t in that level, but a smx_host_priv. So commenting out for now.
71 // Lua is broken anyway. Christian will fix it
72 // __MSG_host_create((sg_host_t)data[SIMIX_HOST_LEVEL]);
79 int console_add_backbone(lua_State *L) {
80 s_sg_platf_link_cbarg_t link;
81 memset(&link,0,sizeof(link));
84 link.properties = NULL;
86 if (!lua_istable(L, -1)) {
88 ("Bad Arguments to create backbone in Lua. Should be a table with named arguments.");
92 lua_pushstring(L, "id");
93 type = lua_gettable(L, -2);
94 if (type != LUA_TSTRING) {
95 XBT_ERROR("Attribute 'id' must be specified for backbone and must be a string.");
97 link.id = lua_tostring(L, -1);
100 lua_pushstring(L, "bandwidth");
101 type = lua_gettable(L, -2);
102 if (type != LUA_TSTRING && type != LUA_TNUMBER) {
103 XBT_ERROR("Attribute 'bandwidth' must be specified for backbone and must either be a string (in the right format; see docs) or a number.");
105 link.bandwidth = surf_parse_get_bandwidth(lua_tostring(L, -1));
108 lua_pushstring(L, "lat");
109 type = lua_gettable(L, -2);
110 if (type != LUA_TSTRING && type != LUA_TNUMBER) {
111 XBT_ERROR("Attribute 'lat' must be specified for backbone and must either be a string (in the right format; see docs) or a number.");
113 link.latency = surf_parse_get_time(lua_tostring(L, -1));
116 link.state = SURF_RESOURCE_ON;
118 lua_pushstring(L, "sharing_policy");
119 type = lua_gettable(L, -2);
120 const char* policy = lua_tostring(L, -1);
121 if (policy && !strcmp(policy,"FULLDUPLEX")) {
122 link.policy = SURF_LINK_FULLDUPLEX;
123 } else if (policy && !strcmp(policy,"FATPIPE")) {
124 link.policy = SURF_LINK_FATPIPE;
126 link.policy = SURF_LINK_SHARED;
129 sg_platf_new_link(&link);
130 routing_cluster_add_backbone(sg_link_by_name(link.id));
135 int console_add_host___link(lua_State *L) {
136 s_sg_platf_host_link_cbarg_t host_link;
137 memset(&host_link,0,sizeof(host_link));
140 // we get values from the table passed as argument
141 if (!lua_istable(L, -1)) {
143 ("Bad Arguments to create host_link in Lua. Should be a table with named arguments.");
147 lua_pushstring(L, "id");
148 type = lua_gettable(L, -2);
149 if (type != LUA_TSTRING) {
150 XBT_ERROR("Attribute 'id' must be specified for any host_link and must be a string.");
152 host_link.id = lua_tostring(L, -1);
155 lua_pushstring(L, "up");
156 type = lua_gettable(L, -2);
157 if (type != LUA_TSTRING && type != LUA_TNUMBER) {
158 XBT_ERROR("Attribute 'up' must be specified for host_link and must either be a string or a number.");
160 host_link.link_up = lua_tostring(L, -1);
163 lua_pushstring(L, "down");
164 type = lua_gettable(L, -2);
165 if (type != LUA_TSTRING && type != LUA_TNUMBER) {
166 XBT_ERROR("Attribute 'down' must be specified for host_link and must either be a string or a number.");
168 host_link.link_down = lua_tostring(L, -1);
171 XBT_DEBUG("Create a host_link for host %s", host_link.id);
172 sg_platf_new_host_link(&host_link);
177 int console_add_host(lua_State *L) {
178 s_sg_platf_host_cbarg_t host;
179 memset(&host,0,sizeof(host));
182 // we get values from the table passed as argument
183 if (!lua_istable(L, -1)) {
185 ("Bad Arguments to create host. Should be a table with named arguments");
190 lua_pushstring(L, "id");
191 type = lua_gettable(L, -2);
192 if (type != LUA_TSTRING && type != LUA_TNUMBER) {
193 XBT_ERROR("Attribute 'id' must be specified for any host and must be a string.");
195 host.id = lua_tostring(L, -1);
199 lua_pushstring(L, "power");
200 type = lua_gettable(L, -2);
201 if (type != LUA_TSTRING && type != LUA_TNUMBER) {
202 XBT_ERROR("Attribute 'power' must be specified for host and must either be a string (in the correct format; check documentation) or a number.");
204 host.power_peak = xbt_dynar_new(sizeof(double), NULL);
205 xbt_dynar_push_as(host.power_peak, double, get_cpu_power(lua_tostring(L, -1)));
209 lua_pushstring(L, "core");
211 if(!lua_isnumber(L,-1)) {
212 host.core_amount = 1;// Default value
214 else host.core_amount = lua_tonumber(L, -1);
215 if (host.core_amount == 0)
216 host.core_amount = 1;
220 lua_pushstring(L, "availability");
222 if(!lua_isnumber(L,-1)) host.power_scale = 1;// Default value
223 else host.power_scale = lua_tonumber(L, -1);
227 lua_pushstring(L, "availability_file");
229 host.power_trace = tmgr_trace_new_from_file(lua_tostring(L, -1));
233 lua_pushstring(L, "state");
235 if(!lua_isnumber(L,-1)) state = 1;// Default value
236 else state = lua_tonumber(L, -1);
240 host.initial_state = SURF_RESOURCE_ON;
242 host.initial_state = SURF_RESOURCE_OFF;
245 lua_pushstring(L, "state_file");
247 host.state_trace = tmgr_trace_new_from_file(lua_tostring(L, -1));
250 sg_platf_new_host(&host);
251 xbt_dynar_free(&host.power_peak);
256 int console_add_link(lua_State *L) {
257 s_sg_platf_link_cbarg_t link;
258 memset(&link,0,sizeof(link));
263 if (! lua_istable(L, -1)) {
264 XBT_ERROR("Bad Arguments to create link, Should be a table with named arguments");
269 lua_pushstring(L, "id");
270 type = lua_gettable(L, -2);
271 if (type != LUA_TSTRING && type != LUA_TNUMBER) {
272 XBT_ERROR("Attribute 'id' must be specified for any link and must be a string.");
274 link.id = lua_tostring(L, -1);
277 // get bandwidth value
278 lua_pushstring(L, "bandwidth");
279 type = lua_gettable(L, -2);
280 if (type != LUA_TSTRING && type != LUA_TNUMBER) {
281 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.");
283 link.bandwidth = surf_parse_get_bandwidth(lua_tostring(L, -1));
287 lua_pushstring(L, "lat");
288 type = lua_gettable(L, -2);
289 if (type != LUA_TSTRING && type != LUA_TNUMBER) {
290 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.");
292 link.latency = surf_parse_get_time(lua_tostring(L, -1));
295 /*Optional Arguments */
297 //get bandwidth_trace value
298 lua_pushstring(L, "bandwidth_file");
300 link.bandwidth_trace = tmgr_trace_new_from_file(lua_tostring(L, -1));
303 //get latency_trace value
304 lua_pushstring(L, "latency_file");
306 link.latency_trace = tmgr_trace_new_from_file(lua_tostring(L, -1));
309 //get state_trace value
310 lua_pushstring(L, "state_file");
312 link.state_trace = tmgr_trace_new_from_file(lua_tostring(L, -1));
315 //get state_initial value
316 lua_pushstring(L, "state");
318 if (!lua_isnumber(L,-1) || lua_tonumber(L, -1))
319 link.state = SURF_RESOURCE_ON;
321 link.state = SURF_RESOURCE_OFF;
325 lua_pushstring(L, "sharing_policy");
327 policy = lua_tostring(L, -1);
329 if (policy && !strcmp(policy,"FULLDUPLEX")) {
330 link.policy = SURF_LINK_FULLDUPLEX;
331 } else if (policy && !strcmp(policy,"FATPIPE")) {
332 link.policy = SURF_LINK_FATPIPE;
334 link.policy = SURF_LINK_SHARED;
337 sg_platf_new_link(&link);
342 * add Router to AS components
344 int console_add_router(lua_State* L) {
345 s_sg_platf_router_cbarg_t router;
346 memset(&router,0,sizeof(router));
349 if (! lua_istable(L, -1)) {
350 XBT_ERROR("Bad Arguments to create router, Should be a table with named arguments");
354 lua_pushstring(L, "id");
355 type = lua_gettable(L, -2);
356 if (type != LUA_TSTRING) {
357 XBT_ERROR("Attribute 'id' must be specified for any link and must be a string.");
359 router.id = lua_tostring(L, -1);
362 lua_pushstring(L,"coord");
364 router.coord = lua_tostring(L, -1);
367 sg_platf_new_router(&router);
372 #include "surf/surfxml_parse.h" /* to override surf_parse and bypass the parser */
374 int console_add_route(lua_State *L) {
375 XBT_DEBUG("Adding route");
376 s_sg_platf_route_cbarg_t route;
377 memset(&route,0,sizeof(route));
380 /* allocating memory for the buffer, I think 2kB should be enough */
381 surfxml_bufferstack = xbt_new0(char, surfxml_bufferstack_size);
383 if (! lua_istable(L, -1)) {
384 XBT_ERROR("Bad Arguments to create a route. Should be a table with named arguments");
388 lua_pushstring(L,"src");
389 type = lua_gettable(L,-2);
390 if (type != LUA_TSTRING) {
391 XBT_ERROR("Attribute 'src' must be specified for any route and must be a string.");
393 route.src = lua_tostring(L, -1);
396 lua_pushstring(L,"dest");
397 type = lua_gettable(L,-2);
398 if (type != LUA_TSTRING) {
399 XBT_ERROR("Attribute 'dest' must be specified for any route and must be a string.");
401 route.dst = lua_tostring(L, -1);
404 lua_pushstring(L,"links");
405 type = lua_gettable(L,-2);
406 if (type != LUA_TSTRING) {
407 XBT_ERROR("Attribute 'links' must be specified for any route and must be a string (different links separated by commas or single spaces.");
409 route.link_list = xbt_str_split(lua_tostring(L, -1), ", \t\r\n");
410 if (xbt_dynar_is_empty(route.link_list))
411 xbt_dynar_push_as(route.link_list,char*,xbt_strdup(lua_tostring(L, -1)));
414 /* We are relying on the XML bypassing mechanism since the corresponding sg_platf does not exist yet.
415 * Et ouais mon pote. That's the way it goes. F34R.
417 * (Note that above this function, there is a #include statement. Is this
418 * comment related to that statement?)
420 lua_pushstring(L,"symmetrical");
422 if (lua_isstring(L, -1)) {
423 const char* value = lua_tostring(L, -1);
424 if (strcmp("YES", value) == 0) {
425 route.symmetrical = TRUE;
428 route.symmetrical = FALSE;
431 route.symmetrical = TRUE;
438 sg_platf_new_route(&route);
443 int console_add_ASroute(lua_State *L) {
444 s_sg_platf_route_cbarg_t ASroute;
445 memset(&ASroute,0,sizeof(ASroute));
447 lua_pushstring(L, "src");
449 ASroute.src = lua_tostring(L, -1);
452 lua_pushstring(L, "dst");
454 ASroute.dst = lua_tostring(L, -1);
457 lua_pushstring(L, "gw_src");
459 ASroute.gw_src = sg_routing_edge_by_name_or_null(lua_tostring(L, -1));
462 lua_pushstring(L, "gw_dst");
464 ASroute.gw_dst = sg_routing_edge_by_name_or_null(lua_tostring(L, -1));
467 /*if (A_surfxml_ASroute_gw___src && !ASroute.gw_src)*/
468 /*surf_parse_error("gw_src=\"%s\" not found for ASroute from \"%s\" to \"%s\"",*/
469 /*A_surfxml_ASroute_gw___src, ASroute.src, ASroute.dst);*/
470 /*if (A_surfxml_ASroute_gw___dst && !ASroute.gw_dst)*/
471 /*surf_parse_error("gw_dst=\"%s\" not found for ASroute from \"%s\" to \"%s\"",*/
472 /*A_surfxml_ASroute_gw___dst, ASroute.src, ASroute.dst);*/
474 lua_pushstring(L,"links");
476 ASroute.link_list = xbt_str_split(lua_tostring(L, -1), ", \t\r\n");
477 if (xbt_dynar_is_empty(ASroute.link_list))
478 xbt_dynar_push_as(ASroute.link_list,char*,xbt_strdup(lua_tostring(L, -1)));
481 lua_pushstring(L,"symmetrical");
483 if (lua_isstring(L, -1)) {
484 const char* value = lua_tostring(L, -1);
485 if (strcmp("YES", value) == 0) {
486 ASroute.symmetrical = TRUE;
489 ASroute.symmetrical = FALSE;
492 ASroute.symmetrical = TRUE;
496 sg_platf_new_ASroute(&ASroute);
501 int console_AS_open(lua_State *L) {
506 XBT_DEBUG("Opening AS");
508 if (! lua_istable(L, 1)) {
509 XBT_ERROR("Bad Arguments to AS_open, Should be a table with named arguments");
513 lua_pushstring(L, "id");
514 type = lua_gettable(L, -2);
515 if (type != LUA_TSTRING) {
516 XBT_ERROR("Attribute 'id' must be specified for any AS and must be a string.");
518 id = lua_tostring(L, -1);
521 lua_pushstring(L, "mode");
523 mode = lua_tostring(L, -1);
526 int mode_int = A_surfxml_AS_routing_None;
527 if(!strcmp(mode,"Full")) mode_int = A_surfxml_AS_routing_Full;
528 else if(!strcmp(mode,"Floyd")) mode_int = A_surfxml_AS_routing_Floyd;
529 else if(!strcmp(mode,"Dijkstra")) mode_int = A_surfxml_AS_routing_Dijkstra;
530 else if(!strcmp(mode,"DijkstraCache")) mode_int = A_surfxml_AS_routing_DijkstraCache;
531 else if(!strcmp(mode,"Vivaldi")) mode_int = A_surfxml_AS_routing_Vivaldi;
532 else if(!strcmp(mode,"Cluster")) mode_int = A_surfxml_AS_routing_Cluster;
533 else if(!strcmp(mode,"none")) mode_int = A_surfxml_AS_routing_None;
534 else xbt_die("Don't have the model name '%s'",mode);
536 s_sg_platf_AS_cbarg_t AS = SG_PLATF_AS_INITIALIZER;
538 AS.routing = mode_int;
540 sg_platf_new_AS_begin(&AS);
544 int console_AS_close(lua_State *L) {
545 XBT_DEBUG("Closing AS");
546 sg_platf_new_AS_end();
550 int console_set_function(lua_State *L) {
552 const char *host_id ;
553 const char *function_id;
556 if (! lua_istable(L, 1)) {
557 XBT_ERROR("Bad Arguments to AS.new, Should be a table with named arguments");
562 lua_pushstring(L, "host");
564 host_id = lua_tostring(L, -1);
568 lua_pushstring(L, "fct");
570 function_id = lua_tostring(L, -1);
574 lua_pushstring(L,"args");
576 args = xbt_str_split_str( lua_tostring(L,-1) , ",");
579 msg_host_t host = MSG_host_by_name(host_id);
581 XBT_ERROR("no host '%s' found",host_id);
585 // FIXME: use sg_platf_new_process directly (warning: find a way to check hostname)
586 MSG_set_function(host_id, function_id, args);
591 int console_host_set_property(lua_State *L) {
592 const char* name ="";
593 const char* prop_id = "";
594 const char* prop_value = "";
595 if (!lua_istable(L, -1)) {
596 XBT_ERROR("Bad Arguments to create link, Should be a table with named arguments");
602 lua_pushstring(L, "host");
604 name = lua_tostring(L, -1);
608 lua_pushstring(L, "prop");
610 prop_id = lua_tostring(L, -1);
613 lua_pushstring(L,"value");
615 prop_value = lua_tostring(L,-1);
618 msg_host_t host = MSG_host_by_name(name);
620 XBT_ERROR("no host '%s' found",name);
623 xbt_dict_t props = MSG_host_get_properties(host);
624 xbt_dict_set(props,prop_id,xbt_strdup(prop_value),NULL);
630 * \brief Registers the platform functions into the table simgrid.platf.
631 * \param L a lua state
633 void sglua_register_platf_functions(lua_State* L)
635 lua_getglobal(L, "simgrid"); /* simgrid */
636 luaL_newlib(L, platf_functions); /* simgrid simgrid.platf */
637 lua_setfield(L, -2, "platf"); /* simgrid */
639 lua_pop(L, 1); /* -- */