1 /* Copyright (c) 2010. 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 "simgrid_lua.h"
10 #include "lua_state_cloner.h"
12 XBT_LOG_NEW_DEFAULT_CATEGORY(lua, "Lua Bindings");
14 static lua_State *lua_maestro_state;
16 #define TASK_MODULE_NAME "simgrid.Task"
17 #define HOST_MODULE_NAME "simgrid.Host"
19 #define LINK_MODULE_NAME "simgrid.Link"
20 #define ROUTE_MODULE_NAME "simgrid.Route"
21 #define AS_MODULE_NAME "simgrid.AS"
22 #define TRACE_MODULE_NAME "simgrid.Trace"
24 static void register_c_functions(lua_State *L);
27 static void *my_checkudata (lua_State *L, int ud, const char *tname) {
28 void *p = lua_touserdata(L, ud);
29 lua_getfield(L, LUA_REGISTRYINDEX, tname);
30 const void* correct_mt = lua_topointer(L, -1);
32 int has_mt = lua_getmetatable(L, ud);
33 const void* actual_mt = NULL;
34 if (has_mt) { actual_mt = lua_topointer(L, -1); lua_pop(L, 1); }
35 XBT_DEBUG("Checking the task's metatable: expected %p, found %p", correct_mt, actual_mt);
36 stack_dump("my_checkudata: ", L);
38 if (p == NULL || !lua_getmetatable(L, ud) || !lua_rawequal(L, -1, -2))
39 luaL_typerror(L, ud, tname);
46 * @brief Ensures that a userdata on the stack is a task
47 * and returns the pointer inside the userdata.
48 * @param L a Lua state
49 * @param index an index in the Lua stack
50 * @return the task at this index
52 static m_task_t checkTask(lua_State * L, int index)
55 luaL_checktype(L, index, LUA_TTABLE);
56 lua_getfield(L, index, "__simgrid_task");
58 pi = (m_task_t *) luaL_checkudata(L, lua_gettop(L), TASK_MODULE_NAME);
61 luaL_typerror(L, index, TASK_MODULE_NAME);
64 luaL_error(L, "null Task");
69 /* ********************************************************************************* */
70 /* wrapper functions */
71 /* ********************************************************************************* */
74 * A task is either something to compute somewhere, or something to exchange between two hosts (or both).
75 * It is defined by a computing amount and a message size.
84 * @brief Constructs a new task with the specified processing amount and amount
87 * @param name Task's name
89 * @param computeDuration A value of the processing amount (in flop) needed to process the task.
90 * If 0, then it cannot be executed with the execute() method.
91 * This value has to be >= 0.
93 * @param messageSize A value of amount of data (in bytes) needed to transfert this task.
94 * If 0, then it cannot be transfered with the get() and put() methods.
95 * This value has to be >= 0.
97 static int Task_new(lua_State * L)
99 XBT_DEBUG("Task new...");
100 const char *name = luaL_checkstring(L, 1);
101 int comp_size = luaL_checkint(L, 2);
102 int msg_size = luaL_checkint(L, 3);
103 m_task_t msg_task = MSG_task_create(name, comp_size, msg_size, NULL);
104 lua_newtable(L); /* create a table, put the userdata on top of it */
105 m_task_t *lua_task = (m_task_t *) lua_newuserdata(L, sizeof(m_task_t));
106 *lua_task = msg_task;
107 luaL_getmetatable(L, TASK_MODULE_NAME);
108 lua_setmetatable(L, -2);
109 lua_setfield(L, -2, "__simgrid_task"); /* put the userdata as field of the table */
110 /* remove the args from the stack */
117 static int Task_get_name(lua_State * L)
119 m_task_t tk = checkTask(L, -1);
120 lua_pushstring(L, MSG_task_get_name(tk));
124 static int Task_computation_duration(lua_State * L)
126 m_task_t tk = checkTask(L, -1);
127 lua_pushnumber(L, MSG_task_get_compute_duration(tk));
131 static int Task_execute(lua_State * L)
133 m_task_t tk = checkTask(L, -1);
134 int res = MSG_task_execute(tk);
135 lua_pushnumber(L, res);
139 static int Task_destroy(lua_State * L)
141 m_task_t tk = checkTask(L, -1);
142 int res = MSG_task_destroy(tk);
143 lua_pushnumber(L, res);
147 static int Task_send(lua_State * L)
149 //stack_dump("send ", L);
150 m_task_t tk = checkTask(L, 1);
151 const char *mailbox = luaL_checkstring(L, 2);
152 lua_pop(L, 1); // remove the string so that the task is on top of it
153 MSG_task_set_data(tk, L); // Copy my stack into the task, so that the receiver can copy the lua task directly
154 MSG_error_t res = MSG_task_send(tk, mailbox);
155 while (MSG_task_get_data(tk) != NULL) // Don't mess up with my stack: the receiver didn't copy the data yet
156 MSG_process_sleep(0); // yield
161 XBT_DEBUG("MSG_task_send failed : Timeout");
163 case MSG_TRANSFER_FAILURE:
164 XBT_DEBUG("MSG_task_send failed : Transfer Failure");
166 case MSG_HOST_FAILURE:
167 XBT_DEBUG("MSG_task_send failed : Host Failure ");
171 ("MSG_task_send failed : Unexpected error , please report this bug");
177 static int Task_recv_with_timeout(lua_State *L)
180 const char *mailbox = luaL_checkstring(L, -2);
181 int timeout = luaL_checknumber(L, -1);
182 MSG_error_t res = MSG_task_receive_with_timeout(&tk, mailbox, timeout);
185 lua_State *sender_stack = MSG_task_get_data(tk);
186 sglua_move_value(sender_stack, L); // copy the data directly from sender's stack
187 MSG_task_set_data(tk, NULL);
192 XBT_DEBUG("MSG_task_receive failed : Timeout");
194 case MSG_TRANSFER_FAILURE:
195 XBT_DEBUG("MSG_task_receive failed : Transfer Failure");
197 case MSG_HOST_FAILURE:
198 XBT_DEBUG("MSG_task_receive failed : Host Failure ");
201 XBT_ERROR("MSG_task_receive failed : Unexpected error , please report this bug");
209 static int Task_recv(lua_State * L)
211 lua_pushnumber(L, -1.0);
212 return Task_recv_with_timeout(L);
215 static const luaL_reg Task_methods[] = {
217 {"name", Task_get_name},
218 {"computation_duration", Task_computation_duration},
219 {"execute", Task_execute},
220 {"destroy", Task_destroy},
223 {"recv_timeout", Task_recv_with_timeout},
227 static int Task_gc(lua_State * L)
229 m_task_t tk = checkTask(L, -1);
231 MSG_task_destroy(tk);
235 static int Task_tostring(lua_State * L)
237 lua_pushfstring(L, "Task :%p", lua_touserdata(L, 1));
241 static const luaL_reg Task_meta[] = {
243 {"__tostring", Task_tostring},
250 static m_host_t checkHost(lua_State * L, int index)
253 luaL_checktype(L, index, LUA_TTABLE);
254 lua_getfield(L, index, "__simgrid_host");
255 pi = (m_host_t *) luaL_checkudata(L, lua_gettop(L), HOST_MODULE_NAME);
257 luaL_typerror(L, index, HOST_MODULE_NAME);
260 luaL_error(L, "null Host");
265 static int Host_get_by_name(lua_State * L)
267 const char *name = luaL_checkstring(L, 1);
268 XBT_DEBUG("Getting Host from name...");
269 m_host_t msg_host = MSG_get_host_by_name(name);
271 luaL_error(L, "null Host : MSG_get_host_by_name failed");
273 lua_newtable(L); /* create a table, put the userdata on top of it */
274 m_host_t *lua_host = (m_host_t *) lua_newuserdata(L, sizeof(m_host_t));
275 *lua_host = msg_host;
276 luaL_getmetatable(L, HOST_MODULE_NAME);
277 lua_setmetatable(L, -2);
278 lua_setfield(L, -2, "__simgrid_host"); /* put the userdata as field of the table */
279 /* remove the args from the stack */
284 static int Host_get_name(lua_State * L)
286 m_host_t ht = checkHost(L, -1);
287 lua_pushstring(L, MSG_host_get_name(ht));
291 static int Host_number(lua_State * L)
293 lua_pushnumber(L, MSG_get_host_number());
297 static int Host_at(lua_State * L)
299 int index = luaL_checkinteger(L, 1);
300 m_host_t host = MSG_get_host_table()[index - 1]; // lua indexing start by 1 (lua[1] <=> C[0])
301 lua_newtable(L); /* create a table, put the userdata on top of it */
302 m_host_t *lua_host = (m_host_t *) lua_newuserdata(L, sizeof(m_host_t));
304 luaL_getmetatable(L, HOST_MODULE_NAME);
305 lua_setmetatable(L, -2);
306 lua_setfield(L, -2, "__simgrid_host"); /* put the userdata as field of the table */
311 static int Host_self(lua_State * L)
313 m_host_t host = MSG_host_self();
315 m_host_t *lua_host =(m_host_t *)lua_newuserdata(L,sizeof(m_host_t));
317 luaL_getmetatable(L, HOST_MODULE_NAME);
318 lua_setmetatable(L, -2);
319 lua_setfield(L, -2, "__simgrid_host");
323 static int Host_get_property_value(lua_State * L)
325 m_host_t ht = checkHost(L, -2);
326 const char *prop = luaL_checkstring(L, -1);
327 lua_pushstring(L,MSG_host_get_property_value(ht,prop));
331 static int Host_sleep(lua_State *L)
333 int time = luaL_checknumber(L, -1);
334 MSG_process_sleep(time);
338 static int Host_destroy(lua_State *L)
340 m_host_t ht = checkHost(L, -1);
341 __MSG_host_destroy(ht);
345 /* ********************************************************************************* */
346 /* lua_stub_generator functions */
347 /* ********************************************************************************* */
349 xbt_dict_t process_function_set;
350 xbt_dynar_t process_list;
351 xbt_dict_t machine_set;
352 static s_process_t process;
354 void s_process_free(void *process)
356 s_process_t *p = (s_process_t *) process;
358 for (i = 0; i < p->argc; i++)
364 static int gras_add_process_function(lua_State * L)
367 const char *process_host = luaL_checkstring(L, 1);
368 const char *process_function = luaL_checkstring(L, 2);
370 if (xbt_dict_is_empty(machine_set)
371 || xbt_dict_is_empty(process_function_set)
372 || xbt_dynar_is_empty(process_list)) {
373 process_function_set = xbt_dict_new();
374 process_list = xbt_dynar_new(sizeof(s_process_t), s_process_free);
375 machine_set = xbt_dict_new();
378 xbt_dict_set(machine_set, process_host, NULL, NULL);
379 xbt_dict_set(process_function_set, process_function, NULL, NULL);
382 process.argv = xbt_new(char *, 1);
383 process.argv[0] = xbt_strdup(process_function);
384 process.host = strdup(process_host);
387 while (lua_next(L, 3) != 0) {
388 arg = lua_tostring(L, -1);
391 xbt_realloc(process.argv, (process.argc) * sizeof(char *));
392 process.argv[(process.argc) - 1] = xbt_strdup(arg);
394 XBT_DEBUG("index = %f , arg = %s \n", lua_tonumber(L, -2),
395 lua_tostring(L, -1));
399 //add to the process list
400 xbt_dynar_push(process_list, &process);
405 static int gras_generate(lua_State * L)
407 const char *project_name = luaL_checkstring(L, 1);
408 generate_sim(project_name);
409 generate_rl(project_name);
410 generate_makefile_local(project_name);
414 /***********************************
416 **********************************/
417 static int trace_start(lua_State *L)
425 static int trace_category(lua_State * L)
428 TRACE_category(luaL_checkstring(L, 1));
433 static int trace_set_task_category(lua_State *L)
436 TRACE_msg_set_task_category(checkTask(L, -2), luaL_checkstring(L, -1));
441 static int trace_end(lua_State *L)
449 // *********** Register Methods ******************************************* //
454 static const luaL_reg Host_methods[] = {
455 {"getByName", Host_get_by_name},
456 {"name", Host_get_name},
457 {"number", Host_number},
460 {"getPropValue", Host_get_property_value},
461 {"sleep", Host_sleep},
462 {"destroy", Host_destroy},
463 // Bypass XML Methods
464 {"setFunction", console_set_function},
465 {"setProperty", console_host_set_property},
469 static int Host_gc(lua_State * L)
471 m_host_t ht = checkHost(L, -1);
477 static int Host_tostring(lua_State * L)
479 lua_pushfstring(L, "Host :%p", lua_touserdata(L, 1));
483 static const luaL_reg Host_meta[] = {
485 {"__tostring", Host_tostring},
492 static const luaL_reg AS_methods[] = {
493 {"new", console_add_AS},
494 {"addHost", console_add_host},
495 {"addLink", console_add_link},
496 {"addRoute", console_add_route},
503 static const luaL_reg Trace_methods[] = {
504 {"start", trace_start},
505 {"category", trace_category},
506 {"setTaskCategory", trace_set_task_category},
507 {"finish", trace_end},
512 * Environment related
516 * @brief Runs a Lua function as a new simulated process.
517 * @param argc number of arguments of the function
518 * @param argv name of the Lua function and array of its arguments
519 * @return result of the function
521 static int run_lua_code(int argc, char **argv)
523 XBT_DEBUG("Run lua code %s", argv[0]);
525 lua_State *L = sglua_clone_maestro();
528 /* start the function */
529 lua_getglobal(L, argv[0]);
530 xbt_assert(lua_isfunction(L, -1),
531 "The lua function %s does not seem to exist", argv[0]);
533 /* push arguments onto the stack */
535 for (i = 1; i < argc; i++)
536 lua_pushstring(L, argv[i]);
538 /* call the function */
540 err = lua_pcall(L, argc - 1, 1, 0);
541 xbt_assert(err == 0, "error running function `%s': %s", argv[0],
542 lua_tostring(L, -1));
544 /* retrieve result */
545 if (lua_isnumber(L, -1)) {
546 res = lua_tonumber(L, -1);
547 lua_pop(L, 1); /* pop returned value */
550 XBT_DEBUG("Execution of Lua code %s is over", (argv ? argv[0] : "(null)"));
555 static int launch_application(lua_State * L)
557 const char *file = luaL_checkstring(L, 1);
558 MSG_function_register_default(run_lua_code);
559 MSG_launch_application(file);
563 static int create_environment(lua_State * L)
565 const char *file = luaL_checkstring(L, 1);
566 XBT_DEBUG("Loading environment file %s", file);
567 MSG_create_environment(file);
571 static int debug(lua_State * L)
573 const char *str = luaL_checkstring(L, 1);
574 XBT_DEBUG("%s", str);
578 static int info(lua_State * L)
580 const char *str = luaL_checkstring(L, 1);
585 static int run(lua_State * L)
591 static int clean(lua_State * L)
598 * Bypass XML Parser (lua console)
602 * Register platform for MSG
604 static int msg_register_platform(lua_State * L)
606 /* Tell Simgrid we dont wanna use its parser */
607 surf_parse = console_parse_platform;
608 surf_parse_reset_callbacks();
609 surf_config_models_setup(NULL);
610 MSG_create_environment(NULL);
615 * Register platform for Simdag
618 static int sd_register_platform(lua_State * L)
620 surf_parse = console_parse_platform_wsL07;
621 surf_parse_reset_callbacks();
622 surf_config_models_setup(NULL);
623 SD_create_environment(NULL);
628 * Register platform for gras
630 static int gras_register_platform(lua_State * L)
632 /* Tell Simgrid we dont wanna use surf parser */
633 surf_parse = console_parse_platform;
634 surf_parse_reset_callbacks();
635 surf_config_models_setup(NULL);
636 gras_create_environment(NULL);
641 * Register applicaiton for MSG
643 static int msg_register_application(lua_State * L)
645 MSG_function_register_default(run_lua_code);
646 surf_parse = console_parse_application;
647 MSG_launch_application(NULL);
652 * Register application for gras
654 static int gras_register_application(lua_State * L)
656 gras_function_register_default(run_lua_code);
657 surf_parse = console_parse_application;
658 gras_launch_application(NULL);
662 static const luaL_Reg simgrid_funcs[] = {
663 {"create_environment", create_environment},
664 {"launch_application", launch_application},
670 {"platform", create_environment},
671 {"application", launch_application},
672 /* methods to bypass XML parser */
673 {"msg_register_platform", msg_register_platform},
674 {"sd_register_platform", sd_register_platform},
675 {"msg_register_application", msg_register_application},
676 {"gras_register_platform", gras_register_platform},
677 {"gras_register_application", gras_register_application},
678 /* gras sub generator method */
679 {"gras_set_process_function", gras_add_process_function},
680 {"gras_generate", gras_generate},
684 /* ********************************************************************************* */
685 /* module management functions */
686 /* ********************************************************************************* */
688 #define LUA_MAX_ARGS_COUNT 10 /* maximum amount of arguments we can get from lua on command line */
690 int luaopen_simgrid(lua_State *L); // Fuck gcc: we don't need that prototype
693 * This function is called automatically by the Lua interpreter when some Lua code requires
694 * the "simgrid" module.
695 * @param L the Lua state
697 int luaopen_simgrid(lua_State *L)
699 XBT_DEBUG("luaopen_simgrid *****");
701 /* Get the command line arguments from the lua interpreter */
702 char **argv = malloc(sizeof(char *) * LUA_MAX_ARGS_COUNT);
704 argv[0] = (char *) "/usr/bin/lua"; /* Lie on the argv[0] so that the stack dumping facilities find the right binary. FIXME: what if lua is not in that location? */
706 lua_getglobal(L, "arg");
707 /* if arg is a null value, it means we use lua only as a script to init platform
708 * else it should be a table and then take arg in consideration
710 if (lua_istable(L, -1)) {
714 lua_pushinteger(L, argc - 2);
716 if (lua_isnil(L, -1)) {
719 xbt_assert(lua_isstring(L, -1),
720 "argv[%d] got from lua is no string", argc - 1);
721 xbt_assert(argc < LUA_MAX_ARGS_COUNT,
722 "Too many arguments, please increase LUA_MAX_ARGS_COUNT in %s before recompiling SimGrid if you insist on having more than %d args on command line",
723 __FILE__, LUA_MAX_ARGS_COUNT - 1);
724 argv[argc - 1] = (char *) luaL_checkstring(L, -1);
726 XBT_DEBUG("Got command line argument %s from lua", argv[argc - 1]);
731 /* Initialize the MSG core */
732 MSG_global_init(&argc, argv);
733 XBT_DEBUG("Still %d arguments on command line", argc); // FIXME: update the lua's arg table to reflect the changes from SimGrid
736 /* Keep the context mechanism informed of our lua world today */
737 lua_maestro_state = L;
739 /* initialize access to my tables by children Lua states */
741 lua_setfield(L, LUA_REGISTRYINDEX, "simgrid.maestro_tables");
743 register_c_functions(L);
749 * @brief Returns whether a Lua state is the maestro state.
750 * @param L a Lua state
751 * @return true if this is maestro
753 int sglua_is_maestro(lua_State* L) {
754 return L == lua_maestro_state;
758 * @brief Returns the maestro state.
759 * @return true the maestro Lua state
761 lua_State* sglua_get_maestro(void) {
762 return lua_maestro_state;
766 * Makes the appropriate Simgrid functions available to the Lua world.
767 * @param L a Lua world
769 void register_c_functions(lua_State *L) {
771 /* register the core C functions to lua */
772 luaL_register(L, "simgrid", simgrid_funcs);
774 /* register the task methods to lua */
775 luaL_openlib(L, TASK_MODULE_NAME, Task_methods, 0); // create methods table, add it to the globals
776 luaL_newmetatable(L, TASK_MODULE_NAME); // create metatable for Task, add it to the Lua registry
777 luaL_openlib(L, 0, Task_meta, 0); // fill metatable
778 lua_pushliteral(L, "__index");
779 lua_pushvalue(L, -3); // dup methods table
780 lua_rawset(L, -3); // matatable.__index = methods
781 lua_pushliteral(L, "__metatable");
782 lua_pushvalue(L, -3); // dup methods table
783 lua_rawset(L, -3); // hide metatable:metatable.__metatable = methods
784 lua_pop(L, 1); // drop metatable
786 /* register the hosts methods to lua */
787 luaL_openlib(L, HOST_MODULE_NAME, Host_methods, 0);
788 luaL_newmetatable(L, HOST_MODULE_NAME);
789 luaL_openlib(L, 0, Host_meta, 0);
790 lua_pushliteral(L, "__index");
791 lua_pushvalue(L, -3);
793 lua_pushliteral(L, "__metatable");
794 lua_pushvalue(L, -3);
798 /* register the links methods to lua */
799 luaL_openlib(L, AS_MODULE_NAME, AS_methods, 0);
800 luaL_newmetatable(L, AS_MODULE_NAME);
803 /* register the Tracing functions to lua */
804 luaL_openlib(L, TRACE_MODULE_NAME, Trace_methods, 0);
805 luaL_newmetatable(L, TRACE_MODULE_NAME);