X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/2ef50482d97a960d49f0d6d4389d84ab97d0bdc3..b95d4833e971f85bed540dc1a5a4d98ea6c9bef4:/src/bindings/lua/simgrid_lua.c diff --git a/src/bindings/lua/simgrid_lua.c b/src/bindings/lua/simgrid_lua.c index 1cee499512..ef4ace54fc 100644 --- a/src/bindings/lua/simgrid_lua.c +++ b/src/bindings/lua/simgrid_lua.c @@ -13,7 +13,9 @@ XBT_LOG_NEW_DEFAULT_SUBCATEGORY(lua, bindings, "Lua Bindings"); #define TASK_MODULE_NAME "simgrid.task" +#define COMM_MODULE_NAME "simgrid.comm" #define HOST_MODULE_NAME "simgrid.host" +#define PROCESS_MODULE_NAME "simgrid.process" // Surf (bypass XML) #define LINK_MODULE_NAME "simgrid.link" #define ROUTE_MODULE_NAME "simgrid.route" @@ -21,6 +23,14 @@ XBT_LOG_NEW_DEFAULT_SUBCATEGORY(lua, bindings, "Lua Bindings"); static lua_State* sglua_maestro_state; +static const char* msg_errors[] = { + NULL, + "timeout", + "transfer failure", + "host failure", + "task canceled" +}; + int luaopen_simgrid(lua_State *L); static void register_c_functions(lua_State *L); static int run_lua_code(int argc, char **argv); @@ -62,6 +72,11 @@ static m_task_t sglua_checktask(lua_State* L, int index) * - Argument 2 (number): computation size * - Argument 3 (number): communication size * - Return value (task): the task created + * + * A Lua task is a regular table with a full userdata inside, and both share + * the same metatable. For the regular table, the metatable allows OO-style + * writing such as your_task:send(someone). + * For the userdata, the metatable is used to check its type. */ static int l_task_new(lua_State* L) { @@ -76,6 +91,10 @@ static int l_task_new(lua_State* L) lua_newtable(L); /* task */ + luaL_getmetatable(L, TASK_MODULE_NAME); + /* task mt */ + lua_setmetatable(L, -2); + /* task */ m_task_t* lua_task = (m_task_t*) lua_newuserdata(L, sizeof(m_task_t)); /* task ctask */ *lua_task = msg_task; @@ -111,7 +130,7 @@ static int l_task_get_name(lua_State* L) * - Argument 1 (task): a task * - Return value (number): computation duration of this task */ -static int l_task_computation_duration(lua_State* L) +static int l_task_get_computation_duration(lua_State* L) { m_task_t task = sglua_checktask(L, 1); lua_pushnumber(L, MSG_task_get_compute_duration(task)); @@ -124,14 +143,22 @@ static int l_task_computation_duration(lua_State* L) * \return number of values returned to Lua * * - Argument 1 (task): the task to execute - * - Return value (number): error code + * - Return value (nil or string): nil if the task was successfully executed, + * or an error string in case of failure, which may be "task canceled" or + * "host failure" */ static int l_task_execute(lua_State* L) { m_task_t task = sglua_checktask(L, 1); - int res = MSG_task_execute(task); - lua_pushnumber(L, res); - return 1; + MSG_error_t res = MSG_task_execute(task); + + if (res == MSG_OK) { + return 0; + } + else { + lua_pushstring(L, msg_errors[res]); + return 1; + } } /** @@ -140,7 +167,11 @@ static int l_task_execute(lua_State* L) * \return number of values returned to Lua * * - Argument 1 (task): the task to send - * - Argument 2 (string): mailbox + * - Argument 2 (string or compatible): mailbox name, as a real string or any + * type convertible to string (numbers always are) + * - Return values (nil or string): nil if the communication was successful, + * or an error string in case of failure, which may be "timeout", + * "host failure" or "transfer failure" */ static int l_task_send(lua_State* L) { @@ -164,26 +195,24 @@ static int l_task_send(lua_State* L) /* task ctask */ m_task_t* udata = (m_task_t*) luaL_checkudata(L, -1, TASK_MODULE_NAME); *udata = NULL; - lua_pop(L, 1); - /* task */ + return 0; } else { - switch (res) { - case MSG_TIMEOUT: - XBT_DEBUG("MSG_task_send failed : Timeout"); - break; - case MSG_TRANSFER_FAILURE: - XBT_DEBUG("MSG_task_send failed : Transfer Failure"); - break; - case MSG_HOST_FAILURE: - XBT_DEBUG("MSG_task_send failed : Host Failure "); - break; - default: - XBT_ERROR - ("MSG_task_send failed : Unexpected error , please report this bug"); - break; - } + lua_settop(L, 0); + lua_pushstring(L, msg_errors[res]); + return 1; } +} + +static int l_task_isend(lua_State* L) +{ + // TODO + return 0; +} + +static int l_task_dsend(lua_State* L) +{ + // TODO return 0; } @@ -192,12 +221,13 @@ static int l_task_send(lua_State* L) * \param L a Lua state * \return number of values returned to Lua * - * - Argument 1 (string): mailbox + * - Argument 1 (string or compatible): mailbox name, as a real string or any + * type convertible to string (numbers always are) * - Argument 2 (number, optional): timeout (default is no timeout) - * - Return value (task/nil): the task received or nil if the communication - * has failed + * - Return values (task or nil + string): the task received, or nil plus an + * error message if the communication has failed */ -static int l_task_recv(lua_State *L) +static int l_task_recv(lua_State* L) { m_task_t task = NULL; const char* mailbox = luaL_checkstring(L, 1); @@ -221,36 +251,31 @@ static int l_task_recv(lua_State *L) sglua_copy_value(sender_stack, L); /* task */ MSG_task_set_data(task, NULL); + return 1; } else { - switch (res) { - case MSG_TIMEOUT: - XBT_DEBUG("MSG_task_receive failed : Timeout"); - break; - case MSG_TRANSFER_FAILURE: - XBT_DEBUG("MSG_task_receive failed : Transfer Failure"); - break; - case MSG_HOST_FAILURE: - XBT_DEBUG("MSG_task_receive failed : Host Failure "); - break; - default: - XBT_ERROR("MSG_task_receive failed : Unexpected error , please report this bug"); - break; - } lua_pushnil(L); - /* nil */ + lua_pushstring(L, msg_errors[res]); + return 2; } - /* task/nil */ - return 1; +} + +static int l_task_irecv(lua_State* L) +{ + // TODO + return 0; } static const luaL_reg task_functions[] = { {"new", l_task_new}, - {"name", l_task_get_name}, - {"computation_duration", l_task_computation_duration}, + {"get_name", l_task_get_name}, + {"get_computation_duration", l_task_get_computation_duration}, {"execute", l_task_execute}, {"send", l_task_send}, + {"isend", l_task_isend}, + {"dsend", l_task_dsend}, {"recv", l_task_recv}, + {"irecv", l_task_irecv}, {NULL, NULL} }; @@ -288,12 +313,149 @@ static int l_task_tostring(lua_State* L) return 1; } +/** + * \brief Metamethods of both a task table and the userdata inside it. + */ static const luaL_reg task_meta[] = { - {"__gc", l_task_gc}, + {"__gc", l_task_gc}, /* will be called only for userdata */ {"__tostring", l_task_tostring}, {NULL, NULL} }; +/* ********************************************************************************* */ +/* simgrid.comm API */ +/* ********************************************************************************* */ + +/** + * \brief Ensures that a value in the stack is a comm and returns it. + * \param L a Lua state + * \param index an index in the Lua stack + * \return the C comm + */ +static msg_comm_t sglua_checkcomm(lua_State* L, int index) +{ + msg_comm_t comm = *((msg_comm_t*) luaL_checkudata(L, index, COMM_MODULE_NAME)); + lua_pop(L, 1); + return comm; +} + +/** + * \brief Blocks the current process until a communication is finished. + * \param L a Lua state + * \return number of values returned to Lua + * + * This function performs a waitany operation: you can specify an + * individual communication or a list of communications. + * If you provide a list, the function returns whenever one communication of + * the list is finished, and this communication will be removed from you list. + * This means you can make a waitall operation with successive calls to this + * function. + * + * - Argument 1 (comm or table): a comm or an array of comms + * - Argument 2 (number, optional): timeout (supported only when there is only + * one comm) + * - Return values (comm + string): the first comm of your list that finishes, + * plus an error string if this comm was unsuccessful. + */ +static int l_comm_wait(lua_State* L) { + + if (lua_istable(L, 1)) { + // TODO implement waitany + THROW_UNIMPLEMENTED; + } + else { + /* only one comm */ + msg_comm_t comm = sglua_checkcomm(L, 1); + double timeout = -1; + if (lua_gettop(L) >= 2) { + timeout = luaL_checknumber(L, 2); + } + /* comm ... */ + MSG_error_t res = MSG_comm_wait(comm, timeout); + lua_settop(L, 1); + /* comm */ + if (res == MSG_OK) { + return 1; + } + else { + lua_pushstring(L, msg_errors[res]); + /* comm error */ + return 2; + } + } + return 0; +} + +/** + * @brief Returns whether a communication is finished. + * + * This function always returns immediately. + * It performs a testany operation: you can provide an individual + * communication or a list of communications. + * + * - Argument 1 (comm or table): a comm or an array of comms + * - Return values (nil or comm + string): if no comm from your list is finished + * yet, returns nil. If a comm is finished, removes it from your list and + * returns it, plus an error string if it was unsuccessful. + */ +static int l_comm_test(lua_State* L) { + + if (lua_istable(L, 1)) { + /* TODO implement testany */ + THROW_UNIMPLEMENTED; + } + else { + /* only one comm */ + msg_comm_t comm = sglua_checkcomm(L, 1); + /* comm ... */ + if (!MSG_comm_test(comm)) { + return 0; + } + else { + lua_settop(L, 1); + /* comm */ + MSG_error_t res = MSG_comm_get_status(comm); + if (res == MSG_OK) { + return 1; + } + else { + lua_pushstring(L, msg_errors[res]); + /* comm error */ + return 2; + } + } + } +} + +static const luaL_reg comm_functions[] = { + {"wait", l_comm_wait}, + {"test", l_comm_test}, + {NULL, NULL} +}; + +/** + * \brief Finalizes a comm userdata. + * \param L a Lua state + * \return number of values returned to Lua + * + * - Argument 1 (userdata): a comm + */ +static int l_comm_gc(lua_State* L) +{ + /* ctask */ + msg_comm_t comm = *((msg_comm_t*) luaL_checkudata(L, 1, COMM_MODULE_NAME)); + MSG_comm_destroy(comm); + return 0; +} + +/** + * \brief Metamethods of the comm userdata. + */ +static const luaL_reg comm_meta[] = { + {"__gc", l_comm_gc}, + {NULL, NULL} +}; + /* ********************************************************************************* */ /* simgrid.host API */ /* ********************************************************************************* */ @@ -448,7 +610,7 @@ static int l_host_sleep(lua_State *L) { int time = luaL_checknumber(L, 1); MSG_process_sleep(time); - return 1; + return 0; } /** @@ -462,7 +624,7 @@ static int l_host_destroy(lua_State *L) { m_host_t ht = sglua_checkhost(L, 1); __MSG_host_destroy(ht); - return 1; + return 0; } static const luaL_reg host_functions[] = { @@ -499,6 +661,46 @@ static const luaL_reg host_meta[] = { {0, 0} }; +/* ********************************************************************************* */ +/* simgrid.process API */ +/* ********************************************************************************* */ + +/** + * \brief Makes the current process sleep for a while. + * \param L a Lua state + * \return number of values returned to Lua + * + * - Argument 1 (number): duration of the sleep + * - Return value (nil or string): nil in everything went ok, or a string error + * if case of failure ("host failure") + */ +static int l_process_sleep(lua_State* L) +{ + double duration = luaL_checknumber(L, 1); + MSG_error_t res = MSG_process_sleep(duration); + + switch (res) { + + case MSG_OK: + return 0; + + case MSG_HOST_FAILURE: + lua_pushliteral(L, "host failure"); + return 1; + + default: + xbt_die("Unexpected result of MSG_process_sleep: %d, please report this bug", res); + } +} + +static const luaL_reg process_functions[] = { + {"sleep", l_process_sleep}, + /* TODO: self, create, kill, suspend, is_suspended, resume, get_name, + * get_pid, get_ppid, migrate + */ + {NULL, NULL} +}; + /* ********************************************************************************* */ /* lua_stub_generator functions */ /* ********************************************************************************* */ @@ -594,9 +796,9 @@ static const luaL_reg platf_functions[] = { * * - Argument 1 (string): name of the deployment file to load */ -static int launch_application(lua_State * L) -{ - const char *file = luaL_checkstring(L, 1); +static int launch_application(lua_State* L) { + + const char* file = luaL_checkstring(L, 1); MSG_function_register_default(run_lua_code); MSG_launch_application(file); return 0; @@ -609,9 +811,9 @@ static int launch_application(lua_State * L) * * - Argument 1 (string): name of the platform file to load */ -static int create_environment(lua_State * L) -{ - const char *file = luaL_checkstring(L, 1); +static int create_environment(lua_State* L) { + + const char* file = luaL_checkstring(L, 1); XBT_DEBUG("Loading environment file %s", file); MSG_create_environment(file); return 0; @@ -624,9 +826,9 @@ static int create_environment(lua_State * L) * * - Argument 1 (string): the text to print */ -static int debug(lua_State * L) -{ - const char *str = luaL_checkstring(L, 1); +static int debug(lua_State* L) { + + const char* str = luaL_checkstring(L, 1); XBT_DEBUG("%s", str); return 0; } @@ -638,9 +840,9 @@ static int debug(lua_State * L) * * - Argument 1 (string): the text to print */ -static int info(lua_State * L) -{ - const char *str = luaL_checkstring(L, 1); +static int info(lua_State* L) { + + const char* str = luaL_checkstring(L, 1); XBT_INFO("%s", str); return 0; } @@ -650,18 +852,31 @@ static int info(lua_State * L) * \param L a Lua state * \return number of values returned to Lua */ -static int run(lua_State * L) -{ +static int run(lua_State* L) { + MSG_main(); return 0; } +/** + * \brief Returns the current simulated time. + * \param L a Lua state + * \return number of values returned to Lua + * + * - Return value (number): the simulated time + */ +static int get_clock(lua_State* L) { + + lua_pushnumber(L, MSG_get_clock()); + return 1; +} + /** * \brief Cleans the simulation. * \param L a Lua state * \return number of values returned to Lua */ -static int clean(lua_State * L) +static int simgrid_gc(lua_State * L) { MSG_clean(); return 0; @@ -730,7 +945,7 @@ static const luaL_Reg simgrid_functions[] = { {"debug", debug}, {"info", info}, {"run", run}, - {"clean", clean}, + {"get_clock", get_clock}, /* short names */ {"platform", create_environment}, {"application", launch_application}, @@ -829,42 +1044,160 @@ lua_State* sglua_get_maestro(void) { } /** - * \brief Makes the appropriate Simgrid functions available to the Lua world. - * \param L a Lua world + * \brief Registers the task functions into the table simgrid.task. + * + * Also initialize the metatable of the task userdata type. + * + * \param L a lua state */ -void register_c_functions(lua_State *L) { +static void register_task_functions(lua_State* L) +{ + /* create a table simgrid.task and fill it with task functions */ + luaL_openlib(L, TASK_MODULE_NAME, task_functions, 0); + /* simgrid.task */ + + /* create the metatable for tasks, add it to the Lua registry */ + luaL_newmetatable(L, TASK_MODULE_NAME); + /* simgrid.task mt */ + /* fill the metatable */ + luaL_openlib(L, NULL, task_meta, 0); + /* simgrid.task mt */ + lua_pushvalue(L, -2); + /* simgrid.task mt simgrid.task */ + /* metatable.__index = simgrid.task + * we put the task functions inside the task itself: + * this allows to write my_task:method(args) for + * simgrid.task.method(my_task, args) */ + lua_setfield(L, -2, "__index"); + /* simgrid.task mt */ + lua_pop(L, 2); + /* -- */ +} - /* register the core C functions to lua */ - luaL_register(L, "simgrid", simgrid_functions); +/** + * \brief Registers the comm functions into the table simgrid.comm. + * + * Also initialize the metatable of the comm userdata type. + * + * \param L a lua state + */ +static void register_comm_functions(lua_State* L) +{ + /* create a table simgrid.com and fill it with com functions */ + luaL_openlib(L, COMM_MODULE_NAME, comm_functions, 0); + /* simgrid.comm */ + + /* create the metatable for comms, add it to the Lua registry */ + luaL_newmetatable(L, COMM_MODULE_NAME); + /* simgrid.comm mt */ + /* fill the metatable */ + luaL_openlib(L, NULL, comm_meta, 0); + /* simgrid.comm mt */ + lua_pushvalue(L, -2); + /* simgrid.comm mt simgrid.comm */ + /* metatable.__index = simgrid.comm + * we put the comm functions inside the comm itself: + * this allows to write my_comm:method(args) for + * simgrid.comm.method(my_comm, args) */ + lua_setfield(L, -2, "__index"); + /* simgrid.comm mt */ + lua_pop(L, 2); + /* -- */ +} - /* register the task methods to lua */ - luaL_openlib(L, TASK_MODULE_NAME, task_functions, 0); // create methods table, add it to the globals - luaL_newmetatable(L, TASK_MODULE_NAME); // create metatable for Task, add it to the Lua registry - luaL_openlib(L, 0, task_meta, 0); // fill metatable - lua_pushliteral(L, "__index"); - lua_pushvalue(L, -3); // dup methods table - lua_rawset(L, -3); // metatable.__index = methods - lua_pushliteral(L, "__metatable"); - lua_pushvalue(L, -3); // dup methods table - lua_rawset(L, -3); // hide metatable:metatable.__metatable = methods - lua_pop(L, 1); // drop metatable - - /* register the hosts methods to lua */ +/** + * \brief Registers the host functions into the table simgrid.host. + * + * Also initialize the metatable of the host userdata type. + * + * \param L a lua state + */ +static void register_host_functions(lua_State* L) +{ + /* create a table simgrid.host and fill it with host functions */ luaL_openlib(L, HOST_MODULE_NAME, host_functions, 0); + /* simgrid.host */ + + /* create the metatable for host, add it to the Lua registry */ luaL_newmetatable(L, HOST_MODULE_NAME); - luaL_openlib(L, 0, host_meta, 0); - lua_pushliteral(L, "__index"); - lua_pushvalue(L, -3); - lua_rawset(L, -3); - lua_pushliteral(L, "__metatable"); - lua_pushvalue(L, -3); - lua_rawset(L, -3); + /* simgrid.host mt */ + /* fill the metatable */ + luaL_openlib(L, NULL, host_meta, 0); + /* simgrid.host mt */ + lua_pushvalue(L, -2); + /* simgrid.host mt simgrid.host */ + /* metatable.__index = simgrid.host + * we put the host functions inside the host userdata itself: + * this allows to write my_host:method(args) for + * simgrid.host.method(my_host, args) */ + lua_setfield(L, -2, "__index"); + /* simgrid.host mt */ + lua_pop(L, 2); + /* -- */ +} + +/** + * \brief Registers the process functions into the table simgrid.process. + * \param L a lua state + */ +static void register_process_functions(lua_State* L) +{ + luaL_openlib(L, PROCESS_MODULE_NAME, process_functions, 0); + /* simgrid.process */ lua_pop(L, 1); +} - /* register the platform methods to lua */ +/** + * \brief Registers the platform functions into the table simgrid.platf. + * \param L a lua state + */ +static void register_platf_functions(lua_State* L) +{ luaL_openlib(L, PLATF_MODULE_NAME, platf_functions, 0); - luaL_newmetatable(L, PLATF_MODULE_NAME); + /* simgrid.platf */ + lua_pop(L, 1); +} + +/** + * \brief Makes the core functions available to the Lua world. + * \param L a Lua world + */ +static void register_core_functions(lua_State *L) +{ + /* register the core C functions to lua */ + luaL_register(L, "simgrid", simgrid_functions); + /* simgrid */ + + /* set a finalizer that cleans simgrid, by adding to the simgrid module a + * dummy userdata whose __gc metamethod calls MSG_clean() */ + lua_newuserdata(L, sizeof(void*)); + /* simgrid udata */ + lua_newtable(L); + /* simgrid udata mt */ + lua_pushcfunction(L, simgrid_gc); + /* simgrid udata mt simgrid_gc */ + lua_setfield(L, -2, "__gc"); + /* simgrid udata mt */ + lua_setmetatable(L, -2); + /* simgrid udata */ + lua_setfield(L, -2, "__simgrid_loaded"); + /* simgrid */ lua_pop(L, 1); + /* -- */ +} + +/** + * \brief Creates the simgrid module and make it available to Lua. + * \param L a Lua world + */ +static void register_c_functions(lua_State *L) +{ + register_core_functions(L); + register_task_functions(L); + register_comm_functions(L); + register_host_functions(L); + register_process_functions(L); + register_platf_functions(L); } /** @@ -877,13 +1210,14 @@ static int run_lua_code(int argc, char **argv) { XBT_DEBUG("Run lua code %s", argv[0]); + /* create a new state, getting globals from maestro */ lua_State *L = sglua_clone_maestro(); int res = 1; /* start the function */ lua_getglobal(L, argv[0]); xbt_assert(lua_isfunction(L, -1), - "The lua function %s does not seem to exist", argv[0]); + "There is no Lua function with name `%s'", argv[0]); /* push arguments onto the stack */ int i; @@ -893,7 +1227,7 @@ static int run_lua_code(int argc, char **argv) /* call the function */ _XBT_GNUC_UNUSED int err; err = lua_pcall(L, argc - 1, 1, 0); - xbt_assert(err == 0, "error running function `%s': %s", argv[0], + xbt_assert(err == 0, "Error running function `%s': %s", argv[0], lua_tostring(L, -1)); /* retrieve result */