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"
11 #include "lua_utils.h"
13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(lua, bindings, "Lua Bindings");
15 #define TASK_MODULE_NAME "simgrid.task"
16 #define COMM_MODULE_NAME "simgrid.comm"
17 #define HOST_MODULE_NAME "simgrid.host"
18 #define PROCESS_MODULE_NAME "simgrid.process"
20 #define LINK_MODULE_NAME "simgrid.link"
21 #define ROUTE_MODULE_NAME "simgrid.route"
22 #define PLATF_MODULE_NAME "simgrid.platf"
24 static lua_State* sglua_maestro_state;
26 static const char* msg_errors[] = {
34 int luaopen_simgrid(lua_State *L);
35 static void register_c_functions(lua_State *L);
36 static int run_lua_code(int argc, char **argv);
38 /* ********************************************************************************* */
39 /* simgrid.task API */
40 /* ********************************************************************************* */
43 * \brief Ensures that a value in the stack is a valid task and returns it.
44 * \param L a Lua state
45 * \param index an index in the Lua stack
46 * \return the C task corresponding to this Lua task
48 static m_task_t sglua_checktask(lua_State* L, int index)
50 sglua_stack_dump("check task: ", L);
51 luaL_checktype(L, index, LUA_TTABLE);
53 lua_getfield(L, index, "__simgrid_task");
54 /* ... task ... ctask */
55 m_task_t task = *((m_task_t*) luaL_checkudata(L, -1, TASK_MODULE_NAME));
60 luaL_error(L, "This task was sent to someone else, you cannot access it anymore");
67 * \brief Creates a new task and leaves it onto the stack.
68 * \param L a Lua state
69 * \return number of values returned to Lua
71 * - Argument 1 (string): name of the task
72 * - Argument 2 (number): computation size
73 * - Argument 3 (number): communication size
74 * - Return value (task): the task created
76 * A Lua task is a regular table with a full userdata inside, and both share
77 * the same metatable. For the regular table, the metatable allows OO-style
78 * writing such as your_task:send(someone).
79 * For the userdata, the metatable is used to check its type.
80 * TODO: make the task name an optional last parameter
82 static int l_task_new(lua_State* L)
84 XBT_DEBUG("Task new");
85 const char* name = luaL_checkstring(L, 1);
86 int comp_size = luaL_checkint(L, 2);
87 int msg_size = luaL_checkint(L, 3);
91 m_task_t msg_task = MSG_task_create(name, comp_size, msg_size, NULL);
95 luaL_getmetatable(L, TASK_MODULE_NAME);
97 lua_setmetatable(L, -2);
99 m_task_t* lua_task = (m_task_t*) lua_newuserdata(L, sizeof(m_task_t));
101 *lua_task = msg_task;
102 luaL_getmetatable(L, TASK_MODULE_NAME);
104 lua_setmetatable(L, -2);
106 lua_setfield(L, -2, "__simgrid_task");
112 * \brief Returns the name of a task.
113 * \param L a Lua state
114 * \return number of values returned to Lua
116 * - Argument 1 (task): a task
117 * - Return value (string): name of the task
119 static int l_task_get_name(lua_State* L)
121 m_task_t task = sglua_checktask(L, 1);
122 lua_pushstring(L, MSG_task_get_name(task));
127 * \brief Returns the computation duration of a task.
128 * \param L a Lua state
129 * \return number of values returned to Lua
131 * - Argument 1 (task): a task
132 * - Return value (number): computation duration of this task
134 static int l_task_get_computation_duration(lua_State* L)
136 m_task_t task = sglua_checktask(L, 1);
137 lua_pushnumber(L, MSG_task_get_compute_duration(task));
142 * \brief Executes a task.
143 * \param L a Lua state
144 * \return number of values returned to Lua
146 * - Argument 1 (task): the task to execute
147 * - Return value (nil or string): nil if the task was successfully executed,
148 * or an error string in case of failure, which may be "task canceled" or
151 static int l_task_execute(lua_State* L)
153 m_task_t task = sglua_checktask(L, 1);
154 MSG_error_t res = MSG_task_execute(task);
160 lua_pushstring(L, msg_errors[res]);
166 * \brief Pops the Lua task on top of the stack and registers it so that a
167 * receiver can retrieve it later knowing the C task.
169 * After calling this function, you can send the C task to someone and he
170 * will be able to also get the corresponding Lua task.
172 * \param L a lua state
174 static void task_register(lua_State* L) {
176 m_task_t task = sglua_checktask(L, -1);
178 /* put in the C task a ref to the lua task so that the receiver finds it */
179 unsigned long ref = luaL_ref(L, LUA_REGISTRYINDEX);
181 MSG_task_set_data(task, (void*) ref);
185 * \brief Pushes onto the stack the Lua task corresponding to a C task.
187 * The Lua task must have been previously registered with task_register so
188 * that it can be retrieved knowing the C task.
190 * \param L a lua state
191 * \param task a C task
193 static void task_unregister(lua_State* L, m_task_t task) {
196 /* the task is in my registry, put it onto my stack */
197 unsigned long ref = (unsigned long) MSG_task_get_data(task);
198 lua_rawgeti(L, LUA_REGISTRYINDEX, ref);
200 luaL_unref(L, LUA_REGISTRYINDEX, ref);
201 MSG_task_set_data(task, NULL);
205 * \brief When a C task has been received, retrieves the corresponding Lua
206 * task from the sender and pushes it onto the receiver's stack.
208 * This function should be called from the receiver process.
210 * \param dst the receiver
211 * \param task the task just received
213 static void task_copy(lua_State* dst, m_task_t task) {
215 m_process_t src_proc = MSG_task_get_sender(task);
216 lua_State* src = MSG_process_get_data(src_proc);
220 task_unregister(src, task);
222 sglua_copy_value(src, dst);
226 /* the receiver is the owner of the task and may destroy it:
227 * make the C task NULL on the sender side so that it doesn't garbage
229 lua_getfield(src, -1, "__simgrid_task");
230 /* src: ... task ctask */
231 m_task_t* udata = (m_task_t*) luaL_checkudata(src, -1, TASK_MODULE_NAME);
238 * \brief Sends a task to a mailbox and waits for its completion.
239 * \param L a Lua state
240 * \return number of values returned to Lua
242 * - Argument 1 (task): the task to send
243 * - Argument 2 (string or compatible): mailbox name, as a real string or any
244 * type convertible to string (numbers always are)
245 * - Return values (boolean + string): true if the communication was successful,
246 * or false plus an error string in case of failure, which may be "timeout",
247 * "host failure" or "transfer failure"
249 static int l_task_send(lua_State* L)
251 m_task_t task = sglua_checktask(L, 1);
252 const char* mailbox = luaL_checkstring(L, 2);
253 /* task mailbox ... */
258 MSG_error_t res = MSG_task_send(task, mailbox);
261 lua_pushboolean(L, 1);
266 /* the communication has failed, I'm still the owner of the task */
267 task_unregister(L, task);
269 lua_pushboolean(L, 0);
271 lua_pushstring(L, msg_errors[res]);
272 /* task false error */
278 * \brief Sends a task on a mailbox.
279 * \param L a Lua state
280 * \return number of values returned to Lua
282 * This is a non-blocking function: use simgrid.comm.wait() or
283 * simgrid.comm.test() to end the communication.
285 * - Argument 1 (task): the task to send
286 * - Argument 2 (string or compatible): mailbox name, as a real string or any
287 * type convertible to string (numbers always are)
288 * - Return value (comm): a communication object to be used later with wait or test
290 static int l_task_isend(lua_State* L)
292 m_task_t task = sglua_checktask(L, 1);
293 const char* mailbox = luaL_checkstring(L, 2);
294 /* task mailbox ... */
299 msg_comm_t comm = MSG_task_isend(task, mailbox);
301 msg_comm_t* userdata = (msg_comm_t*) lua_newuserdata(L, sizeof(msg_comm_t));
304 luaL_getmetatable(L, COMM_MODULE_NAME);
306 lua_setmetatable(L, -2);
312 * \brief Sends a task on a mailbox on a best effort way (detached send).
313 * \param L a Lua state
314 * \return number of values returned to Lua
316 * Like simgrid.task.isend, this is a non-blocking function.
317 * You can use this function if you don't care about when the communication
318 * ends and whether it succeeds.
319 * FIXME: isn't this equivalent to calling simgrid.task.isend() and ignoring
322 * - Argument 1 (task): the task to send
323 * - Argument 2 (string or compatible): mailbox name, as a real string or any
324 * type convertible to string (numbers always are)
326 static int l_task_dsend(lua_State* L)
328 m_task_t task = sglua_checktask(L, 1);
329 const char* mailbox = luaL_checkstring(L, 2);
330 /* task mailbox ... */
335 MSG_task_dsend(task, mailbox, NULL);
340 * \brief Receives a task.
341 * \param L a Lua state
342 * \return number of values returned to Lua
344 * - Argument 1 (string or compatible): mailbox name, as a real string or any
345 * type convertible to string (numbers always are)
346 * - Argument 2 (number, optional): timeout (default is no timeout)
347 * - Return values (task or nil + string): the task received, or nil plus an
348 * error message if the communication has failed
350 static int l_task_recv(lua_State* L)
352 m_task_t task = NULL;
353 const char* mailbox = luaL_checkstring(L, 1);
355 if (lua_gettop(L) >= 2) {
356 /* mailbox timeout ... */
357 timeout = luaL_checknumber(L, 2);
362 /* no timeout by default */
365 MSG_error_t res = MSG_task_receive_with_timeout(&task, mailbox, timeout);
369 /* mailbox ... task */
374 /* mailbox ... nil */
375 lua_pushstring(L, msg_errors[res]);
376 /* mailbox ... nil error */
382 * \brief Asynchronously receives a task on a mailbox.
383 * \param L a Lua state
384 * \return number of values returned to Lua
386 * This is a non-blocking function: use simgrid.comm.wait() or
387 * simgrid.comm.test() to end the communication and get the task in case of
390 * - Argument 1 (string or compatible): mailbox name, as a real string or any
391 * type convertible to string (numbers always are)
392 * - Return value (comm): a communication object to be used later with wait or test
395 static int l_task_irecv(lua_State* L)
397 const char* mailbox = luaL_checkstring(L, 1);
399 m_task_t* task = xbt_new0(m_task_t, 1); // FIXME fix this leak
400 msg_comm_t comm = MSG_task_irecv(task, mailbox);
402 msg_comm_t* userdata = (msg_comm_t*) lua_newuserdata(L, sizeof(msg_comm_t));
403 /* mailbox ... comm */
405 luaL_getmetatable(L, COMM_MODULE_NAME);
406 /* mailbox ... comm mt */
407 lua_setmetatable(L, -2);
408 /* mailbox ... comm */
412 static const luaL_reg task_functions[] = {
414 {"get_name", l_task_get_name},
415 {"get_computation_duration", l_task_get_computation_duration},
416 {"execute", l_task_execute},
417 {"send", l_task_send},
418 {"isend", l_task_isend},
419 {"dsend", l_task_dsend},
420 {"recv", l_task_recv},
421 {"irecv", l_task_irecv},
426 * \brief Finalizes the userdata of a task.
427 * \param L a Lua state
428 * \return number of values returned to Lua
430 * - Argument 1 (userdata): a C task, possibly NULL if it was sent to another
433 static int l_task_gc(lua_State* L)
436 m_task_t task = *((m_task_t*) luaL_checkudata(L, 1, TASK_MODULE_NAME));
437 /* the task is NULL if I sent it to someone else */
439 MSG_task_destroy(task);
445 * \brief Returns a string representation of a C task.
446 * \param L a Lua state
447 * \return number of values returned to Lua
449 * - Argument 1 (userdata): a task
450 * - Return value (string): a string describing this task
452 static int l_task_tostring(lua_State* L)
454 m_task_t task = *((m_task_t*) luaL_checkudata(L, 1, TASK_MODULE_NAME));
455 lua_pushfstring(L, "Task: %p", task);
460 * \brief Metamethods of both a task table and the userdata inside it.
462 static const luaL_reg task_meta[] = {
463 {"__gc", l_task_gc}, /* will be called only for userdata */
464 {"__tostring", l_task_tostring},
468 /* ********************************************************************************* */
469 /* simgrid.comm API */
470 /* ********************************************************************************* */
473 * \brief Ensures that a value in the stack is a comm and returns it.
474 * \param L a Lua state
475 * \param index an index in the Lua stack
478 static msg_comm_t sglua_checkcomm(lua_State* L, int index)
480 msg_comm_t comm = *((msg_comm_t*) luaL_checkudata(L, index, COMM_MODULE_NAME));
485 * \brief Blocks the current process until a communication is finished.
486 * \param L a Lua state
487 * \return number of values returned to Lua
489 * - Argument 1 (comm): a comm (previously created by isend or irecv)
490 * - Argument 2 (number, optional): timeout (default is no timeout)
491 * - Return values (task or nil + string): in case of success, returns the task
492 * received if you are the receiver and nil if you are the sender. In case of
493 * failure, returns nil plus an error string.
495 static int l_comm_wait(lua_State* L) {
497 msg_comm_t comm = sglua_checkcomm(L, 1);
499 if (lua_gettop(L) >= 2) {
500 timeout = luaL_checknumber(L, 2);
503 MSG_error_t res = MSG_comm_wait(comm, timeout);
506 m_task_t task = MSG_comm_get_task(comm);
507 if (MSG_task_get_sender(task) == MSG_process_self()) {
512 /* I'm the receiver: copy the Lua task from the sender */
519 /* the communication has failed */
522 lua_pushstring(L, msg_errors[res]);
523 /* comm ... nil error */
529 * @brief Returns whether a communication is finished.
531 * Unlike wait(), This function always returns immediately.
533 * - Argument 1 (comm): a comm (previously created by isend or irecv)
534 * - Return values (task/boolean or nil + string): if the communication is not
535 * finished, return false. If the communication is finished and was successful,
536 * returns the task received if you are the receiver or true if you are the
537 * sender. If the communication is finished and has failed, returns nil
538 * plus an error string.
540 static int l_comm_test(lua_State* L) {
542 msg_comm_t comm = sglua_checkcomm(L, 1);
544 if (!MSG_comm_test(comm)) {
545 /* not finished yet */
546 lua_pushboolean(L, 0);
551 /* finished but may have failed */
552 MSG_error_t res = MSG_comm_get_status(comm);
555 m_task_t task = MSG_comm_get_task(comm);
556 if (MSG_task_get_sender(task) == MSG_process_self()) {
558 lua_pushboolean(L, 1);
563 /* I'm the receiver: copy the Lua task from the sender */
570 /* the communication has failed */
573 lua_pushstring(L, msg_errors[res]);
574 /* comm ... nil error */
580 static const luaL_reg comm_functions[] = {
581 {"wait", l_comm_wait},
582 {"test", l_comm_test},
583 /* TODO waitany, testany */
588 * \brief Finalizes a comm userdata.
589 * \param L a Lua state
590 * \return number of values returned to Lua
592 * - Argument 1 (userdata): a comm
594 static int l_comm_gc(lua_State* L)
597 msg_comm_t comm = *((msg_comm_t*) luaL_checkudata(L, 1, COMM_MODULE_NAME));
598 MSG_comm_destroy(comm);
603 * \brief Metamethods of the comm userdata.
605 static const luaL_reg comm_meta[] = {
610 /* ********************************************************************************* */
611 /* simgrid.host API */
612 /* ********************************************************************************* */
615 * \brief Ensures that a value in the stack is a host and returns it.
616 * \param L a Lua state
617 * \param index an index in the Lua stack
618 * \return the C host corresponding to this Lua host
620 static m_host_t sglua_checkhost(lua_State * L, int index)
623 luaL_checktype(L, index, LUA_TTABLE);
624 lua_getfield(L, index, "__simgrid_host");
625 pi = (m_host_t *) luaL_checkudata(L, lua_gettop(L), HOST_MODULE_NAME);
627 luaL_typerror(L, index, HOST_MODULE_NAME);
630 luaL_error(L, "null Host");
636 * \brief Returns a host given its name.
637 * \param L a Lua state
638 * \return number of values returned to Lua
640 * - Argument 1 (string): name of a host
641 * - Return value (host): the corresponding host
643 static int l_host_get_by_name(lua_State * L)
645 const char *name = luaL_checkstring(L, 1);
646 XBT_DEBUG("Getting Host from name...");
647 m_host_t msg_host = MSG_get_host_by_name(name);
649 luaL_error(L, "null Host : MSG_get_host_by_name failed");
651 lua_newtable(L); /* create a table, put the userdata on top of it */
652 m_host_t *lua_host = (m_host_t *) lua_newuserdata(L, sizeof(m_host_t));
653 *lua_host = msg_host;
654 luaL_getmetatable(L, HOST_MODULE_NAME);
655 lua_setmetatable(L, -2);
656 lua_setfield(L, -2, "__simgrid_host"); /* put the userdata as field of the table */
657 /* remove the args from the stack */
663 * \brief Returns the name of a host.
664 * \param L a Lua state
665 * \return number of values returned to Lua
667 * - Argument 1 (host): a host
668 * - Return value (string): name of this host
670 static int l_host_get_name(lua_State * L)
672 m_host_t ht = sglua_checkhost(L, 1);
673 lua_pushstring(L, MSG_host_get_name(ht));
678 * \brief Returns the number of existing hosts.
679 * \param L a Lua state
680 * \return number of values returned to Lua
682 * - Return value (number): number of hosts
684 static int l_host_number(lua_State * L)
686 lua_pushnumber(L, MSG_get_host_number());
691 * \brief Returns the host given its index.
692 * \param L a Lua state
693 * \return number of values returned to Lua
695 * - Argument 1 (number): an index (1 is the first)
696 * - Return value (host): the host at this index
698 static int l_host_at(lua_State * L)
700 int index = luaL_checkinteger(L, 1);
701 m_host_t host = MSG_get_host_table()[index - 1]; // lua indexing start by 1 (lua[1] <=> C[0])
702 lua_newtable(L); /* create a table, put the userdata on top of it */
703 m_host_t *lua_host = (m_host_t *) lua_newuserdata(L, sizeof(m_host_t));
705 luaL_getmetatable(L, HOST_MODULE_NAME);
706 lua_setmetatable(L, -2);
707 lua_setfield(L, -2, "__simgrid_host"); /* put the userdata as field of the table */
712 * \brief Returns the host where the current process is located.
713 * \param L a Lua state
714 * \return number of values returned to Lua
716 * - Return value (host): the current host
718 static int l_host_self(lua_State * L)
721 m_host_t host = MSG_host_self();
724 m_host_t* lua_host = (m_host_t*) lua_newuserdata(L, sizeof(m_host_t));
727 luaL_getmetatable(L, HOST_MODULE_NAME);
729 lua_setmetatable(L, -2);
731 lua_setfield(L, -2, "__simgrid_host");
737 * \brief Returns the value of a host property.
738 * \param L a Lua state
739 * \return number of values returned to Lua
741 * - Argument 1 (host): a host
742 * - Argument 2 (string): name of the property to get
743 * - Return value (string): the value of this property
745 static int l_host_get_property_value(lua_State * L)
747 m_host_t ht = sglua_checkhost(L, 1);
748 const char *prop = luaL_checkstring(L, 2);
749 lua_pushstring(L,MSG_host_get_property_value(ht,prop));
754 * \brief Makes the current process sleep for a while.
755 * \param L a Lua state
756 * \return number of values returned to Lua
758 * - Argument 1 (number): duration of the sleep
760 static int l_host_sleep(lua_State *L)
762 int time = luaL_checknumber(L, 1);
763 MSG_process_sleep(time);
768 * \brief Destroys a host.
769 * \param L a Lua state
770 * \return number of values returned to Lua
772 * - Argument 1 (host): the host to destroy
774 static int l_host_destroy(lua_State *L)
776 m_host_t ht = sglua_checkhost(L, 1);
777 __MSG_host_destroy(ht);
781 static const luaL_reg host_functions[] = {
782 {"get_by_name", l_host_get_by_name},
783 {"name", l_host_get_name},
784 {"number", l_host_number},
786 {"self", l_host_self},
787 {"get_prop_value", l_host_get_property_value},
788 {"sleep", l_host_sleep},
789 {"destroy", l_host_destroy},
790 // Bypass XML Methods
791 {"set_function", console_set_function},
792 {"set_property", console_host_set_property},
797 * \brief Returns a string representation of a host.
798 * \param L a Lua state
799 * \return number of values returned to Lua
801 * - Argument 1 (userdata): a host
802 * - Return value (string): a string describing this host
804 static int l_host_tostring(lua_State * L)
806 lua_pushfstring(L, "Host :%p", lua_touserdata(L, 1));
810 static const luaL_reg host_meta[] = {
811 {"__tostring", l_host_tostring},
815 /* ********************************************************************************* */
816 /* simgrid.process API */
817 /* ********************************************************************************* */
820 * \brief Makes the current process sleep for a while.
821 * \param L a Lua state
822 * \return number of values returned to Lua
824 * - Argument 1 (number): duration of the sleep
825 * - Return value (nil or string): nil in everything went ok, or a string error
826 * if case of failure ("host failure")
828 static int l_process_sleep(lua_State* L)
830 double duration = luaL_checknumber(L, 1);
831 MSG_error_t res = MSG_process_sleep(duration);
838 case MSG_HOST_FAILURE:
839 lua_pushliteral(L, "host failure");
843 xbt_die("Unexpected result of MSG_process_sleep: %d, please report this bug", res);
847 static const luaL_reg process_functions[] = {
848 {"sleep", l_process_sleep},
849 /* TODO: self, create, kill, suspend, is_suspended, resume, get_name,
850 * get_pid, get_ppid, migrate
855 /* ********************************************************************************* */
856 /* lua_stub_generator functions */
857 /* ********************************************************************************* */
859 xbt_dict_t process_function_set;
860 xbt_dynar_t process_list;
861 xbt_dict_t machine_set;
862 static s_process_t process;
864 void s_process_free(void *process)
866 s_process_t *p = (s_process_t *) process;
868 for (i = 0; i < p->argc; i++)
874 static int gras_add_process_function(lua_State * L)
877 const char *process_host = luaL_checkstring(L, 1);
878 const char *process_function = luaL_checkstring(L, 2);
880 if (xbt_dict_is_empty(machine_set)
881 || xbt_dict_is_empty(process_function_set)
882 || xbt_dynar_is_empty(process_list)) {
883 process_function_set = xbt_dict_new();
884 process_list = xbt_dynar_new(sizeof(s_process_t), s_process_free);
885 machine_set = xbt_dict_new();
888 xbt_dict_set(machine_set, process_host, NULL, NULL);
889 xbt_dict_set(process_function_set, process_function, NULL, NULL);
892 process.argv = xbt_new(char *, 1);
893 process.argv[0] = xbt_strdup(process_function);
894 process.host = strdup(process_host);
897 while (lua_next(L, 3) != 0) {
898 arg = lua_tostring(L, -1);
901 xbt_realloc(process.argv, (process.argc) * sizeof(char *));
902 process.argv[(process.argc) - 1] = xbt_strdup(arg);
904 XBT_DEBUG("index = %f , arg = %s \n", lua_tonumber(L, -2),
905 lua_tostring(L, -1));
909 //add to the process list
910 xbt_dynar_push(process_list, &process);
914 static int gras_generate(lua_State * L)
916 const char *project_name = luaL_checkstring(L, 1);
917 generate_sim(project_name);
918 generate_rl(project_name);
919 generate_makefile_local(project_name);
923 /* ********************************************************************************* */
924 /* simgrid.platf API */
925 /* ********************************************************************************* */
927 static const luaL_reg platf_functions[] = {
928 {"open", console_open},
929 {"close", console_close},
930 {"AS_open", console_AS_open},
931 {"AS_close", console_AS_close},
932 {"host_new", console_add_host},
933 {"link_new", console_add_link},
934 {"router_new", console_add_router},
935 {"route_new", console_add_route},
939 /* ********************************************************************************* */
941 /* ********************************************************************************* */
944 * \brief Deploys your application.
945 * \param L a Lua state
946 * \return number of values returned to Lua
948 * - Argument 1 (string): name of the deployment file to load
950 static int launch_application(lua_State* L) {
952 const char* file = luaL_checkstring(L, 1);
953 MSG_function_register_default(run_lua_code);
954 MSG_launch_application(file);
959 * \brief Creates the platform.
960 * \param L a Lua state
961 * \return number of values returned to Lua
963 * - Argument 1 (string): name of the platform file to load
965 static int create_environment(lua_State* L) {
967 const char* file = luaL_checkstring(L, 1);
968 XBT_DEBUG("Loading environment file %s", file);
969 MSG_create_environment(file);
974 * \brief Prints a log string with debug level.
975 * \param L a Lua state
976 * \return number of values returned to Lua
978 * - Argument 1 (string): the text to print
980 static int debug(lua_State* L) {
982 const char* str = luaL_checkstring(L, 1);
983 XBT_DEBUG("%s", str);
988 * \brief Prints a log string with info level.
989 * \param L a Lua state
990 * \return number of values returned to Lua
992 * - Argument 1 (string): the text to print
994 static int info(lua_State* L) {
996 const char* str = luaL_checkstring(L, 1);
1002 * \brief Runs your application.
1003 * \param L a Lua state
1004 * \return number of values returned to Lua
1006 static int run(lua_State* L) {
1013 * \brief Returns the current simulated time.
1014 * \param L a Lua state
1015 * \return number of values returned to Lua
1017 * - Return value (number): the simulated time
1019 static int get_clock(lua_State* L) {
1021 lua_pushnumber(L, MSG_get_clock());
1026 * \brief Cleans the simulation.
1027 * \param L a Lua state
1028 * \return number of values returned to Lua
1030 static int simgrid_gc(lua_State * L)
1037 * Register platform for MSG
1039 static int msg_register_platform(lua_State * L)
1041 /* Tell Simgrid we dont wanna use its parser */
1042 //surf_parse = console_parse_platform;
1043 surf_parse_reset_callbacks();
1044 MSG_create_environment(NULL);
1049 * Register platform for Simdag
1052 static int sd_register_platform(lua_State * L)
1054 //surf_parse = console_parse_platform_wsL07;
1055 surf_parse_reset_callbacks();
1056 SD_create_environment(NULL);
1061 * Register platform for gras
1063 static int gras_register_platform(lua_State * L)
1065 //surf_parse = console_parse_platform;
1066 surf_parse_reset_callbacks();
1067 gras_create_environment(NULL);
1072 * Register applicaiton for MSG
1074 static int msg_register_application(lua_State * L)
1076 MSG_function_register_default(run_lua_code);
1077 //surf_parse = console_parse_application;
1078 MSG_launch_application(NULL);
1083 * Register application for gras
1085 static int gras_register_application(lua_State * L)
1087 gras_function_register_default(run_lua_code);
1088 //surf_parse = console_parse_application;
1089 gras_launch_application(NULL);
1093 static const luaL_Reg simgrid_functions[] = {
1094 {"create_environment", create_environment},
1095 {"launch_application", launch_application},
1099 {"get_clock", get_clock},
1101 {"platform", create_environment},
1102 {"application", launch_application},
1103 /* methods to bypass XML parser */
1104 {"msg_register_platform", msg_register_platform},
1105 {"sd_register_platform", sd_register_platform},
1106 {"msg_register_application", msg_register_application},
1107 {"gras_register_platform", gras_register_platform},
1108 {"gras_register_application", gras_register_application},
1109 /* gras sub generator method */
1110 {"gras_set_process_function", gras_add_process_function},
1111 {"gras_generate", gras_generate},
1115 /* ********************************************************************************* */
1116 /* module management functions */
1117 /* ********************************************************************************* */
1119 #define LUA_MAX_ARGS_COUNT 10 /* maximum amount of arguments we can get from lua on command line */
1122 * \brief Opens the simgrid Lua module.
1124 * This function is called automatically by the Lua interpreter when some
1125 * Lua code requires the "simgrid" module.
1127 * \param L the Lua state
1129 int luaopen_simgrid(lua_State *L)
1131 XBT_DEBUG("luaopen_simgrid *****");
1133 /* Get the command line arguments from the lua interpreter */
1134 char **argv = malloc(sizeof(char *) * LUA_MAX_ARGS_COUNT);
1136 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? */
1138 lua_getglobal(L, "arg");
1139 /* if arg is a null value, it means we use lua only as a script to init platform
1140 * else it should be a table and then take arg in consideration
1142 if (lua_istable(L, -1)) {
1146 lua_pushinteger(L, argc - 2);
1147 lua_gettable(L, -2);
1148 if (lua_isnil(L, -1)) {
1151 xbt_assert(lua_isstring(L, -1),
1152 "argv[%d] got from lua is no string", argc - 1);
1153 xbt_assert(argc < LUA_MAX_ARGS_COUNT,
1154 "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",
1155 __FILE__, LUA_MAX_ARGS_COUNT - 1);
1156 argv[argc - 1] = (char *) luaL_checkstring(L, -1);
1158 XBT_DEBUG("Got command line argument %s from lua", argv[argc - 1]);
1161 argv[argc--] = NULL;
1163 /* Initialize the MSG core */
1164 MSG_global_init(&argc, argv);
1165 XBT_DEBUG("Still %d arguments on command line", argc); // FIXME: update the lua's arg table to reflect the changes from SimGrid
1168 /* Keep the context mechanism informed of our lua world today */
1169 sglua_maestro_state = L;
1171 /* initialize access to my tables by children Lua states */
1173 lua_setfield(L, LUA_REGISTRYINDEX, "simgrid.maestro_tables");
1175 register_c_functions(L);
1181 * \brief Returns whether a Lua state is the maestro state.
1182 * \param L a Lua state
1183 * \return true if this is maestro
1185 int sglua_is_maestro(lua_State* L) {
1186 return L == sglua_maestro_state;
1190 * \brief Returns the maestro state.
1191 * \return the maestro Lua state
1193 lua_State* sglua_get_maestro(void) {
1194 return sglua_maestro_state;
1198 * \brief Registers the task functions into the table simgrid.task.
1200 * Also initialize the metatable of the task userdata type.
1202 * \param L a lua state
1204 static void register_task_functions(lua_State* L)
1206 /* create a table simgrid.task and fill it with task functions */
1207 luaL_openlib(L, TASK_MODULE_NAME, task_functions, 0);
1210 /* create the metatable for tasks, add it to the Lua registry */
1211 luaL_newmetatable(L, TASK_MODULE_NAME);
1212 /* simgrid.task mt */
1213 /* fill the metatable */
1214 luaL_openlib(L, NULL, task_meta, 0);
1215 /* simgrid.task mt */
1216 lua_pushvalue(L, -2);
1217 /* simgrid.task mt simgrid.task */
1218 /* metatable.__index = simgrid.task
1219 * we put the task functions inside the task itself:
1220 * this allows to write my_task:method(args) for
1221 * simgrid.task.method(my_task, args) */
1222 lua_setfield(L, -2, "__index");
1223 /* simgrid.task mt */
1229 * \brief Registers the comm functions into the table simgrid.comm.
1231 * Also initialize the metatable of the comm userdata type.
1233 * \param L a lua state
1235 static void register_comm_functions(lua_State* L)
1237 /* create a table simgrid.com and fill it with com functions */
1238 luaL_openlib(L, COMM_MODULE_NAME, comm_functions, 0);
1241 /* create the metatable for comms, add it to the Lua registry */
1242 luaL_newmetatable(L, COMM_MODULE_NAME);
1243 /* simgrid.comm mt */
1244 /* fill the metatable */
1245 luaL_openlib(L, NULL, comm_meta, 0);
1246 /* simgrid.comm mt */
1247 lua_pushvalue(L, -2);
1248 /* simgrid.comm mt simgrid.comm */
1249 /* metatable.__index = simgrid.comm
1250 * we put the comm functions inside the comm itself:
1251 * this allows to write my_comm:method(args) for
1252 * simgrid.comm.method(my_comm, args) */
1253 lua_setfield(L, -2, "__index");
1254 /* simgrid.comm mt */
1260 * \brief Registers the host functions into the table simgrid.host.
1262 * Also initialize the metatable of the host userdata type.
1264 * \param L a lua state
1266 static void register_host_functions(lua_State* L)
1268 /* create a table simgrid.host and fill it with host functions */
1269 luaL_openlib(L, HOST_MODULE_NAME, host_functions, 0);
1272 /* create the metatable for host, add it to the Lua registry */
1273 luaL_newmetatable(L, HOST_MODULE_NAME);
1274 /* simgrid.host mt */
1275 /* fill the metatable */
1276 luaL_openlib(L, NULL, host_meta, 0);
1277 /* simgrid.host mt */
1278 lua_pushvalue(L, -2);
1279 /* simgrid.host mt simgrid.host */
1280 /* metatable.__index = simgrid.host
1281 * we put the host functions inside the host userdata itself:
1282 * this allows to write my_host:method(args) for
1283 * simgrid.host.method(my_host, args) */
1284 lua_setfield(L, -2, "__index");
1285 /* simgrid.host mt */
1291 * \brief Registers the process functions into the table simgrid.process.
1292 * \param L a lua state
1294 static void register_process_functions(lua_State* L)
1296 luaL_openlib(L, PROCESS_MODULE_NAME, process_functions, 0);
1297 /* simgrid.process */
1302 * \brief Registers the platform functions into the table simgrid.platf.
1303 * \param L a lua state
1305 static void register_platf_functions(lua_State* L)
1307 luaL_openlib(L, PLATF_MODULE_NAME, platf_functions, 0);
1313 * \brief Makes the core functions available to the Lua world.
1314 * \param L a Lua world
1316 static void register_core_functions(lua_State *L)
1318 /* register the core C functions to lua */
1319 luaL_register(L, "simgrid", simgrid_functions);
1322 /* set a finalizer that cleans simgrid, by adding to the simgrid module a
1323 * dummy userdata whose __gc metamethod calls MSG_clean() */
1324 lua_newuserdata(L, sizeof(void*));
1327 /* simgrid udata mt */
1328 lua_pushcfunction(L, simgrid_gc);
1329 /* simgrid udata mt simgrid_gc */
1330 lua_setfield(L, -2, "__gc");
1331 /* simgrid udata mt */
1332 lua_setmetatable(L, -2);
1334 lua_setfield(L, -2, "__simgrid_loaded");
1341 * \brief Creates the simgrid module and make it available to Lua.
1342 * \param L a Lua world
1344 static void register_c_functions(lua_State *L)
1346 register_core_functions(L);
1347 register_task_functions(L);
1348 register_comm_functions(L);
1349 register_host_functions(L);
1350 register_process_functions(L);
1351 register_platf_functions(L);
1355 * \brief Runs a Lua function as a new simulated process.
1356 * \param argc number of arguments of the function
1357 * \param argv name of the Lua function and array of its arguments
1358 * \return result of the function
1360 static int run_lua_code(int argc, char **argv)
1362 XBT_DEBUG("Run lua code %s", argv[0]);
1364 /* create a new state, getting globals from maestro */
1365 lua_State *L = sglua_clone_maestro();
1366 MSG_process_set_data(MSG_process_self(), L);
1368 /* start the function */
1369 lua_getglobal(L, argv[0]);
1370 xbt_assert(lua_isfunction(L, -1),
1371 "There is no Lua function with name `%s'", argv[0]);
1373 /* push arguments onto the stack */
1375 for (i = 1; i < argc; i++)
1376 lua_pushstring(L, argv[i]);
1378 /* call the function */
1379 _XBT_GNUC_UNUSED int err;
1380 err = lua_pcall(L, argc - 1, 1, 0);
1381 xbt_assert(err == 0, "Error running function `%s': %s", argv[0],
1382 lua_tostring(L, -1));
1384 /* retrieve result */
1386 if (lua_isnumber(L, -1)) {
1387 res = lua_tonumber(L, -1);
1388 lua_pop(L, 1); /* pop returned value */
1391 XBT_DEBUG("Execution of Lua code %s is over", (argv ? argv[0] : "(null)"));