X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/fa45f2acc4946349e99256a79b5d45b51462f404..bc6e45effd2e9460dd74972af247ba21182fd777:/src/bindings/lua/simgrid_lua.c diff --git a/src/bindings/lua/simgrid_lua.c b/src/bindings/lua/simgrid_lua.c index 13f733d609..9de044a556 100644 --- a/src/bindings/lua/simgrid_lua.c +++ b/src/bindings/lua/simgrid_lua.c @@ -1,576 +1,173 @@ -/* SimGrid Lua bindings */ - /* Copyright (c) 2010. The SimGrid Team. * All rights reserved. */ /* This program is free software; you can redistribute it and/or modify it * under the terms of the license (GNU LGPL) which comes with this package. */ + +/* SimGrid Lua bindings */ + #include "simgrid_lua.h" -#include // memcpy +#include "lua_state_cloner.h" +#include "lua_utils.h" XBT_LOG_NEW_DEFAULT_SUBCATEGORY(lua, bindings, "Lua Bindings"); -static lua_State *lua_maestro_state; - -#define TASK_MODULE_NAME "simgrid.Task" -#define HOST_MODULE_NAME "simgrid.Host" +#define TASK_MODULE_NAME "simgrid.task" +#define HOST_MODULE_NAME "simgrid.host" // Surf (bypass XML) -#define LINK_MODULE_NAME "simgrid.Link" -#define ROUTE_MODULE_NAME "simgrid.Route" -#define AS_MODULE_NAME "simgrid.AS" -#define TRACE_MODULE_NAME "simgrid.Trace" +#define LINK_MODULE_NAME "simgrid.link" +#define ROUTE_MODULE_NAME "simgrid.route" +#define PLATF_MODULE_NAME "simgrid.platf" -/** - * @brief A chunk of memory. - * - * TODO replace this by a dynar - */ -typedef struct s_buffer { - char* data; - size_t size; - size_t capacity; -} s_buffer_t, *buffer_t; - -static const char* value_tostring(lua_State* L, int index); -static const char* keyvalue_tostring(lua_State* L, int key_index, int value_index); -static void stack_dump(const char *msg, lua_State* L); -static int writer(lua_State* L, const void* source, size_t size, void* userdata); -static void move_value(lua_State* dst, lua_State* src, const char* name); -static int l_get_from_father(lua_State* L); -static lua_State *clone_lua_state(lua_State* L); -static m_task_t check_task(lua_State *L, int index); +static lua_State* sglua_maestro_state; + +int luaopen_simgrid(lua_State *L); static void register_c_functions(lua_State *L); +static int run_lua_code(int argc, char **argv); /* ********************************************************************************* */ -/* helper functions */ +/* simgrid.task API */ /* ********************************************************************************* */ /** - * @brief Returns a string representation of a value in the Lua stack. - * - * This function is for debugging purposes. - * It always returns the same pointer. - * - * @param L the Lua state - * @param index index in the stack - * @return a string representation of the value at this index - */ -static const char* value_tostring(lua_State* L, int index) { - - static char buff[64]; - - switch (lua_type(L, index)) { - - case LUA_TNIL: - sprintf(buff, "nil"); - break; - - case LUA_TNUMBER: - sprintf(buff, "%.3f", lua_tonumber(L, index)); - break; - - case LUA_TBOOLEAN: - sprintf(buff, "%s", lua_toboolean(L, index) ? "true" : "false"); - break; - - case LUA_TSTRING: - snprintf(buff, 63, "'%s'", lua_tostring(L, index)); - break; - - case LUA_TFUNCTION: - if (lua_iscfunction(L, index)) { - sprintf(buff, "C-function"); - } - else { - sprintf(buff, "function"); - } - break; - - case LUA_TTABLE: - sprintf(buff, "table(%zu)", lua_objlen(L, index)); - break; - - case LUA_TLIGHTUSERDATA: - case LUA_TUSERDATA: - sprintf(buff, "userdata(%p)", lua_touserdata(L, index)); - break; - - case LUA_TTHREAD: - sprintf(buff, "thread"); - break; - } - return buff; -} - -/** - * @brief Returns a string representation of a key-value pair. - * - * This function is for debugging purposes. - * It always returns the same pointer. - * - * @param L the Lua state - * @param key_index index of the key - * @param value_index index of the value - * @return a string representation of the key-value pair - */ -static const char* keyvalue_tostring(lua_State* L, int key_index, int value_index) { - - static char buff[64]; - /* value_tostring also always returns the same pointer */ - int len = snprintf(buff, 63, "%s -> ", value_tostring(L, key_index)); - snprintf(buff + len, 63 - len, "%s", value_tostring(L, value_index)); - return buff; -} - -/** - * @brief Dumps the Lua stack if debug logs are enabled. - * @param msg a message to print - * @param L a Lua state + * \brief Ensures that a value in the stack is a valid task and returns it. + * \param L a Lua state + * \param index an index in the Lua stack + * \return the C task corresponding to this Lua task */ -static void stack_dump(const char* msg, lua_State* L) +static m_task_t sglua_checktask(lua_State* L, int index) { - if (XBT_LOG_ISENABLED(lua, xbt_log_priority_debug)) { - char buff[2048]; - char* p = buff; - int i; - int top = lua_gettop(L); - - // if (1) return; - - fflush(stdout); - - p[0] = '\0'; - for (i = 1; i <= top; i++) { /* repeat for each level */ - - p += sprintf(p, "%s", value_tostring(L, i)); - p += sprintf(p, " "); /* put a separator */ - } - XBT_DEBUG("%s%s", msg, buff); - } -} - -/** - * @brief Writes the specified data into a memory buffer. - * - * This function is a valid lua_Writer that writes into a memory buffer passed - * as userdata. - * - * @param L a lua state - * @param source some data - * @param sz number of bytes of data - * @param user_data the memory buffer to write - */ -static int writer(lua_State* L, const void* source, size_t size, void* userdata) { - - buffer_t buffer = (buffer_t) userdata; - while (buffer->capacity < buffer->size + size) { - buffer->capacity *= 2; - buffer->data = xbt_realloc(buffer->data, buffer->capacity); - } - memcpy(buffer->data + buffer->size, source, size); - buffer->size += size; - - return 0; -} - -/** - * @brief Pops a value from the stack of a source state and pushes it on the - * stack of another state. - * - * If the value is a table, its content is copied recursively. To avoid cycles, - * a table of previsously visited tables must be present at index 1 of dst. - * Its keys are pointers to visited tables in src and its values are the tables - * already built. - * - * TODO: add support of upvalues - * - * @param src the source state - * @param dst the destination state - * @param name a name describing the value - */ -static void move_value(lua_State* dst, lua_State *src, const char* name) { - - luaL_checkany(src, -1); /* check the value to copy */ - luaL_checktype(dst, 1, LUA_TTABLE); /* check the presence of a table of - previously visited tables */ - - XBT_DEBUG("Copying value %s", name); - - stack_dump("src before copying a value (should be ... value): ", src); - stack_dump("dst before copying a value (should be visited ...): ", dst); - - switch (lua_type(src, -1)) { - - case LUA_TNIL: - lua_pushnil(dst); - break; - - case LUA_TNUMBER: - lua_pushnumber(dst, lua_tonumber(src, -1)); - break; - - case LUA_TBOOLEAN: - lua_pushboolean(dst, lua_toboolean(src, -1)); - break; - - case LUA_TSTRING: - /* no worries about memory: lua_pushstring makes a copy */ - lua_pushstring(dst, lua_tostring(src, -1)); - break; - - case LUA_TFUNCTION: - /* it's a function that does not exist yet in L2 */ - - if (lua_iscfunction(src, -1)) { - /* it's a C function: just copy the pointer */ - XBT_DEBUG("Copying C function '%s'", name); - lua_CFunction f = lua_tocfunction(src, -1); - lua_pushcfunction(dst, f); - } - else { - /* it's a Lua function: dump it from src */ - XBT_DEBUG("Dumping Lua function '%s'", name); - - s_buffer_t buffer; - buffer.capacity = 64; - buffer.size = 0; - buffer.data = xbt_new(char, buffer.capacity); - - /* copy the binary chunk from src into a buffer */ - int error = lua_dump(src, writer, &buffer); - xbt_assert(!error, "Failed to dump function '%s' from the source state: error %d", - name, error); - - /* load the chunk into dst */ - error = luaL_loadbuffer(dst, buffer.data, buffer.size, name); - xbt_assert(!error, "Failed to load function '%s' from the source state: %s", - name, lua_tostring(dst, -1)); - XBT_DEBUG("Function '%s' successfully dumped from source state.", name); - } - break; - - case LUA_TTABLE: - - /* see if this table was already visited */ - lua_pushlightuserdata(dst, (void*) lua_topointer(src, -1)); - /* dst: visited ... psrctable */ - lua_gettable(dst, 1); - /* dst: visited ... table/nil */ - if (lua_istable(dst, -1)) { - XBT_DEBUG("Nothing to do: table already visited"); - /* dst: visited ... table */ - } - else { - XBT_DEBUG("First visit of this table"); - /* dst: visited ... nil */ - lua_pop(dst, 1); - /* dst: visited ... */ - - /* first visit: create the new table in dst */ - lua_newtable(dst); - /* dst: visited ... table */ - - /* mark the table as visited to avoid infinite recursion */ - lua_pushlightuserdata(dst, (void*) lua_topointer(src, -1)); - /* dst: visited ... table psrctable */ - lua_pushvalue(dst, -2); - /* dst: visited ... table psrctable table */ - lua_settable(dst, 1); - /* dst: visited ... table */ - XBT_DEBUG("Table marked as visited"); - - stack_dump("dst after marking the table as visited (should be visited ... table): ", dst); - - /* copy the metatable if any */ - int has_meta_table = lua_getmetatable(src, -1); - /* src: ... table mt? */ - if (has_meta_table) { - XBT_DEBUG("Copying metatable"); - /* src: ... table mt */ - move_value(dst, src, "metatable"); - /* src: ... table - dst: visited ... table mt */ - lua_setmetatable(dst, -2); - /* dst: visited ... table */ - } - else { - XBT_DEBUG("No metatable"); - } - - stack_dump("src before traversing the table (should be ... table): ", src); - stack_dump("dst before traversing the table (should be visited ... table): ", dst); - - /* traverse the table of src and copy each element */ - lua_pushnil(src); - /* src: ... table nil */ - while (lua_next(src, -2) != 0) { - /* src: ... table key value */ - - XBT_DEBUG("Copying table element %s", keyvalue_tostring(src, -2, -1)); - - stack_dump("src before copying table element (should be ... table key value): ", src); - stack_dump("dst before copying table element (should be visited ... table): ", dst); - - /* copy the key */ - lua_pushvalue(src, -2); - /* src: ... table key value key */ - XBT_DEBUG("Copying the element key"); - move_value(dst, src, value_tostring(src, -1)); - /* src: ... table key value - dst: visited ... table key */ - XBT_DEBUG("Copied the element key"); - - /* copy the value */ - XBT_DEBUG("Copying the element value"); - move_value(dst, src, value_tostring(src, -1)); - /* src: ... table key - dst: visited ... table key value */ - XBT_DEBUG("Copied the element value"); - - /* set the table element */ - lua_settable(dst, -3); - /* dst: visited ... table */ - - /* the key stays on top of src for next iteration */ - stack_dump("src before next iteration (should be ... table key): ", src); - stack_dump("dst before next iteration (should be visited ... table): ", dst); - } - XBT_DEBUG("Finished traversing the table"); - } - break; - - case LUA_TLIGHTUSERDATA: - lua_pushlightuserdata(dst, lua_touserdata(src, -1)); - break; - - case LUA_TUSERDATA: - XBT_WARN("Cannot copy a full userdata from the source state."); - lua_pushnil(dst); - break; - - case LUA_TTHREAD: - XBT_WARN("Cannot copy a thread from the source state."); - lua_pushnil(dst); - break; - } - - /* pop the value from src */ - lua_pop(src, 1); - - stack_dump("src after copying a value (should be ...): ", src); - stack_dump("dst after copying a value (should be visited ... value): ", dst); -} - -/** - * @brief Copies a global value from the father state. - * - * The state L must have a father, i.e. it should have been created by - * clone_lua_state(). - * This function is meant to be an __index metamethod. - * Consequently, it assumes that the stack has two elements: - * a table (usually the environment of L) and the string key of a value - * that does not exist yet in this table. It copies the corresponding global - * value from the father state and pushes it on the stack of L. - * If the global value does not exist in the father state either, nil is - * pushed. - * - * TODO: make this function thread safe. If the simulation runs in parallel, - * several simulated processes may trigger this __index metamethod at the same - * time and get globals from maestro. - * - * @param L the current state - * @return number of return values pushed (always 1) - */ -static int l_get_from_father(lua_State *L) { - - /* retrieve the father */ - lua_getfield(L, LUA_REGISTRYINDEX, "simgrid.father_state"); - lua_State* father = lua_touserdata(L, -1); - xbt_assert(father != NULL, "This Lua state has no father"); - lua_pop(L, 1); - - /* get the global from the father */ - const char* key = luaL_checkstring(L, 2); /* L: table key */ - lua_getglobal(father, key); /* father: ... value */ - XBT_DEBUG("__index of '%s' begins", key); - - /* push the value onto the stack of L */ - lua_newtable(L); /* L: table key visited */ - lua_insert(L, 1); /* L: visited table key */ - move_value(L, father, key); /* father: ... - L: visited table key value */ - lua_remove(L, 1); /* L: table key value */ - - /* prepare the return value of __index */ - lua_pushvalue(L, -1); /* L: table key value value */ - lua_insert(L, 1); /* L: value table key value */ - - /* save the copied value in the table for subsequent accesses */ - lua_settable(L, -3); /* L: value table */ - lua_remove(L, 2); /* L: value */ - - XBT_DEBUG("__index of '%s' returns %s", key, value_tostring(L, -1)); - - return 1; -} - -/** - * @brief Creates a new Lua state and get its environment from an existing state. - * - * The state created is independent from the existing one and has its own - * copies of global variables and functions. - * However, the global variables and functions are not copied right now from - * the original state; they are copied only the first time they are accessed. - * This behavior saves time and memory, and is okay for Simgrid's needs. - * - * @param father an existing state - * @return the state created - */ -static lua_State* clone_lua_state(lua_State *father) { - - /* create the new state */ - lua_State *L = luaL_newstate(); - - /* set its environment: - * - create a table newenv - * - create a metatable mt - * - set mt.__index = a function that copies the global from the father state - * - set mt as the metatable of newenv - * - set newenv as the environment of the new state - */ - lua_pushthread(L); /* thread */ - lua_newtable(L); /* thread newenv */ - lua_newtable(L); /* thread newenv mt */ - lua_pushcfunction(L, l_get_from_father); /* thread newenv mt f */ - lua_setfield(L, -2, "__index"); /* thread newenv mt */ - lua_setmetatable(L, -2); /* thread newenv */ - lua_setfenv(L, -2); /* thread */ - lua_pop(L, 1); /* -- */ - - /* open the standard libs (theoretically, this is not necessary) */ - luaL_openlibs(L); - - /* put a pointer to the father */ - lua_pushlightuserdata(L, father); - lua_setfield(L, LUA_REGISTRYINDEX, "simgrid.father_state"); - - XBT_DEBUG("New state created"); - - return L; -} - -/** - * @brief Ensures that a userdata on the stack is a task - * and returns the pointer inside the userdata. - * @param L a Lua state - * @param index an index in the Lua stack - * @return the task at this index - */ -static m_task_t checkTask(lua_State * L, int index) -{ - m_task_t *pi, tk; + sglua_stack_dump("check task: ", L); luaL_checktype(L, index, LUA_TTABLE); + /* ... task ... */ lua_getfield(L, index, "__simgrid_task"); - pi = (m_task_t *) luaL_checkudata(L, -1, TASK_MODULE_NAME); - if (pi == NULL) - luaL_typerror(L, index, TASK_MODULE_NAME); - tk = *pi; - if (!tk) - luaL_error(L, "null Task"); + /* ... task ... ctask */ + m_task_t task = *((m_task_t*) luaL_checkudata(L, -1, TASK_MODULE_NAME)); lua_pop(L, 1); - return tk; -} - -/* ********************************************************************************* */ -/* wrapper functions */ -/* ********************************************************************************* */ + /* ... task ... */ -/** - * A task is either something to compute somewhere, or something to exchange between two hosts (or both). - * It is defined by a computing amount and a message size. - * - */ + if (task == NULL) { + luaL_error(L, "This task was sent to someone else, you cannot access it anymore"); + } -/* * * * - * * Constructors * * - * * * */ + return task; +} /** - * @brief Constructs a new task with the specified processing amount and amount - * of data needed. - * - * @param name Task's name - * - * @param computeDuration A value of the processing amount (in flop) needed to process the task. - * If 0, then it cannot be executed with the execute() method. - * This value has to be >= 0. + * \brief Creates a new task and leaves it onto the stack. + * \param L a Lua state + * \return number of values returned to Lua * - * @param messageSize A value of amount of data (in bytes) needed to transfert this task. - * If 0, then it cannot be transfered with the get() and put() methods. - * This value has to be >= 0. + * - Argument 1 (string): name of the task + * - Argument 2 (number): computation size + * - Argument 3 (number): communication size + * - Return value (task): the task created */ -static int Task_new(lua_State * L) +static int l_task_new(lua_State* L) { - XBT_DEBUG("Task new..."); - const char *name = luaL_checkstring(L, 1); + XBT_DEBUG("Task new"); + const char* name = luaL_checkstring(L, 1); int comp_size = luaL_checkint(L, 2); int msg_size = luaL_checkint(L, 3); + /* name comp comm */ + lua_settop(L, 0); + /* -- */ m_task_t msg_task = MSG_task_create(name, comp_size, msg_size, NULL); - lua_newtable(L); /* create a table, put the userdata on top of it */ - m_task_t *lua_task = (m_task_t *) lua_newuserdata(L, sizeof(m_task_t)); + + lua_newtable(L); + /* task */ + m_task_t* lua_task = (m_task_t*) lua_newuserdata(L, sizeof(m_task_t)); + /* task ctask */ *lua_task = msg_task; luaL_getmetatable(L, TASK_MODULE_NAME); + /* task ctask mt */ lua_setmetatable(L, -2); - lua_setfield(L, -2, "__simgrid_task"); /* put the userdata as field of the table */ - /* remove the args from the stack */ - lua_remove(L, 1); - lua_remove(L, 1); - lua_remove(L, 1); + /* task ctask */ + lua_setfield(L, -2, "__simgrid_task"); + /* task */ return 1; } -static int Task_get_name(lua_State * L) +/** + * \brief Returns the name of a task. + * \param L a Lua state + * \return number of values returned to Lua + * + * - Argument 1 (task): a task + * - Return value (string): name of the task + */ +static int l_task_get_name(lua_State* L) { - m_task_t tk = checkTask(L, -1); - lua_pushstring(L, MSG_task_get_name(tk)); + m_task_t task = sglua_checktask(L, 1); + lua_pushstring(L, MSG_task_get_name(task)); return 1; } -static int Task_computation_duration(lua_State * L) +/** + * \brief Returns the computation duration of a task. + * \param L a Lua state + * \return number of values returned to Lua + * + * - Argument 1 (task): a task + * - Return value (number): computation duration of this task + */ +static int l_task_computation_duration(lua_State* L) { - m_task_t tk = checkTask(L, -1); - lua_pushnumber(L, MSG_task_get_compute_duration(tk)); + m_task_t task = sglua_checktask(L, 1); + lua_pushnumber(L, MSG_task_get_compute_duration(task)); return 1; } -static int Task_execute(lua_State * L) +/** + * \brief Executes a task. + * \param L a Lua state + * \return number of values returned to Lua + * + * - Argument 1 (task): the task to execute + * - Return value (number): error code + */ +static int l_task_execute(lua_State* L) { - m_task_t tk = checkTask(L, -1); - int res = MSG_task_execute(tk); + m_task_t task = sglua_checktask(L, 1); + int res = MSG_task_execute(task); lua_pushnumber(L, res); return 1; } -static int Task_destroy(lua_State * L) -{ - m_task_t tk = checkTask(L, -1); - int res = MSG_task_destroy(tk); - lua_pushnumber(L, res); - return 1; -} +/** + * \brief Sends a task to a mailbox and waits for its completion. + * \param L a Lua state + * \return number of values returned to Lua + * + * - Argument 1 (task): the task to send + * - Argument 2 (string): mailbox + */ +static int l_task_send(lua_State* L) +{ + m_task_t task = sglua_checktask(L, 1); + const char* mailbox = luaL_checkstring(L, 2); + /* task mailbox */ + lua_settop(L, 1); + /* task */ + /* copy my stack into the task, so that the receiver can copy the lua task */ + MSG_task_set_data(task, L); + MSG_error_t res = MSG_task_send(task, mailbox); + while (MSG_task_get_data(task) != NULL) { + /* don't mess up with my stack: the receiver didn't copy the data yet */ + MSG_process_sleep(0); + } -static int Task_send(lua_State * L) -{ - //stackDump("send ",L); - m_task_t tk = checkTask(L, 1); - const char *mailbox = luaL_checkstring(L, 2); - lua_pop(L, 1); // remove the string so that the task is on top of it - MSG_task_set_data(tk, L); // Copy my stack into the task, so that the receiver can copy the lua task directly - MSG_error_t res = MSG_task_send(tk, mailbox); - while (MSG_task_get_data(tk) != NULL) // Don't mess up with my stack: the receiver didn't copy the data yet - MSG_process_sleep(0); // yield - - if (res != MSG_OK) + if (res == MSG_OK) { + /* the receiver is the owner of the task and may destroy it: + * remove the C task on my side so that I don't garbage collect it */ + lua_getfield(L, 1, "__simgrid_task"); + /* task ctask */ + m_task_t* udata = (m_task_t*) luaL_checkudata(L, -1, TASK_MODULE_NAME); + *udata = NULL; + lua_pop(L, 1); + /* task */ + } + else { switch (res) { case MSG_TIMEOUT: XBT_DEBUG("MSG_task_send failed : Timeout"); @@ -586,20 +183,44 @@ static int Task_send(lua_State * L) ("MSG_task_send failed : Unexpected error , please report this bug"); break; } + } return 0; } -static int Task_recv_with_timeout(lua_State *L) -{ - m_task_t tk = NULL; - const char *mailbox = luaL_checkstring(L, -2); - int timeout = luaL_checknumber(L, -1); - MSG_error_t res = MSG_task_receive_with_timeout(&tk, mailbox, timeout); +/** + * \brief Receives a task. + * \param L a Lua state + * \return number of values returned to Lua + * + * - Argument 1 (string): mailbox + * - Argument 2 (number, optional): timeout (default is no timeout) + * - Return value (task/nil): the task received or nil if the communication + * has failed + */ +static int l_task_recv(lua_State *L) +{ + m_task_t task = NULL; + const char* mailbox = luaL_checkstring(L, 1); + int timeout; + if (lua_gettop(L) >= 2) { + /* mailbox timeout */ + timeout = luaL_checknumber(L, 2); + } + else { + /* mailbox */ + timeout = -1; + /* no timeout by default */ + } + lua_settop(L, 0); + /* -- */ + MSG_error_t res = MSG_task_receive_with_timeout(&task, mailbox, timeout); if (res == MSG_OK) { - lua_State *sender_stack = MSG_task_get_data(tk); - lua_xmove(sender_stack, L, 1); // copy the data directly from sender's stack - MSG_task_set_data(tk, NULL); + /* copy the data directly from sender's stack */ + lua_State* sender_stack = MSG_task_get_data(task); + sglua_copy_value(sender_stack, L); + /* task */ + MSG_task_set_data(task, NULL); } else { switch (res) { @@ -617,57 +238,78 @@ static int Task_recv_with_timeout(lua_State *L) break; } lua_pushnil(L); + /* nil */ } + /* task/nil */ return 1; } -static int Task_recv(lua_State * L) -{ - lua_pushnumber(L, -1.0); - return Task_recv_with_timeout(L); -} - -static const luaL_reg Task_methods[] = { - {"new", Task_new}, - {"name", Task_get_name}, - {"computation_duration", Task_computation_duration}, - {"execute", Task_execute}, - {"destroy", Task_destroy}, - {"send", Task_send}, - {"recv", Task_recv}, - {"recv_timeout", Task_recv_with_timeout}, +static const luaL_reg task_functions[] = { + {"new", l_task_new}, + {"name", l_task_get_name}, + {"computation_duration", l_task_computation_duration}, + {"execute", l_task_execute}, + {"send", l_task_send}, + {"recv", l_task_recv}, {NULL, NULL} }; -static int Task_gc(lua_State * L) +/** + * \brief Finalizes the userdata of a task. + * \param L a Lua state + * \return number of values returned to Lua + * + * - Argument 1 (userdata): a C task, possibly NULL if it was sent to another + * Lua state + */ +static int l_task_gc(lua_State* L) { - m_task_t tk = checkTask(L, -1); - if (tk) - MSG_task_destroy(tk); + /* ctask */ + m_task_t task = *((m_task_t*) luaL_checkudata(L, 1, TASK_MODULE_NAME)); + /* the task is NULL if I sent it to someone else */ + if (task != NULL) { + MSG_task_destroy(task); + } return 0; } -static int Task_tostring(lua_State * L) +/** + * \brief Returns a string representation of a C task. + * \param L a Lua state + * \return number of values returned to Lua + * + * - Argument 1 (userdata): a task + * - Return value (string): a string describing this task + */ +static int l_task_tostring(lua_State* L) { - lua_pushfstring(L, "Task :%p", lua_touserdata(L, 1)); + m_task_t task = *((m_task_t*) luaL_checkudata(L, 1, TASK_MODULE_NAME)); + lua_pushfstring(L, "Task: %p", task); return 1; } -static const luaL_reg Task_meta[] = { - {"__gc", Task_gc}, - {"__tostring", Task_tostring}, +static const luaL_reg task_meta[] = { + {"__gc", l_task_gc}, + {"__tostring", l_task_tostring}, {NULL, NULL} }; +/* ********************************************************************************* */ +/* simgrid.host API */ +/* ********************************************************************************* */ + /** - * Host + * \brief Ensures that a value in the stack is a host and returns it. + * \param L a Lua state + * \param index an index in the Lua stack + * \return the C host corresponding to this Lua host */ -static m_host_t checkHost(lua_State * L, int index) +static m_host_t sglua_checkhost(lua_State * L, int index) { m_host_t *pi, ht; luaL_checktype(L, index, LUA_TTABLE); lua_getfield(L, index, "__simgrid_host"); - pi = (m_host_t *) luaL_checkudata(L, -1, HOST_MODULE_NAME); + pi = (m_host_t *) luaL_checkudata(L, lua_gettop(L), HOST_MODULE_NAME); if (pi == NULL) luaL_typerror(L, index, HOST_MODULE_NAME); ht = *pi; @@ -677,7 +319,15 @@ static m_host_t checkHost(lua_State * L, int index) return ht; } -static int Host_get_by_name(lua_State * L) +/** + * \brief Returns a host given its name. + * \param L a Lua state + * \return number of values returned to Lua + * + * - Argument 1 (string): name of a host + * - Return value (host): the corresponding host + */ +static int l_host_get_by_name(lua_State * L) { const char *name = luaL_checkstring(L, 1); XBT_DEBUG("Getting Host from name..."); @@ -696,20 +346,43 @@ static int Host_get_by_name(lua_State * L) return 1; } -static int Host_get_name(lua_State * L) +/** + * \brief Returns the name of a host. + * \param L a Lua state + * \return number of values returned to Lua + * + * - Argument 1 (host): a host + * - Return value (string): name of this host + */ +static int l_host_get_name(lua_State * L) { - m_host_t ht = checkHost(L, -1); + m_host_t ht = sglua_checkhost(L, 1); lua_pushstring(L, MSG_host_get_name(ht)); return 1; } -static int Host_number(lua_State * L) +/** + * \brief Returns the number of existing hosts. + * \param L a Lua state + * \return number of values returned to Lua + * + * - Return value (number): number of hosts + */ +static int l_host_number(lua_State * L) { lua_pushnumber(L, MSG_get_host_number()); return 1; } -static int Host_at(lua_State * L) +/** + * \brief Returns the host given its index. + * \param L a Lua state + * \return number of values returned to Lua + * + * - Argument 1 (number): an index (1 is the first) + * - Return value (host): the host at this index + */ +static int l_host_at(lua_State * L) { int index = luaL_checkinteger(L, 1); m_host_t host = MSG_get_host_table()[index - 1]; // lua indexing start by 1 (lua[1] <=> C[0]) @@ -720,43 +393,112 @@ static int Host_at(lua_State * L) lua_setmetatable(L, -2); lua_setfield(L, -2, "__simgrid_host"); /* put the userdata as field of the table */ return 1; - } -static int Host_self(lua_State * L) +/** + * \brief Returns the host where the current process is located. + * \param L a Lua state + * \return number of values returned to Lua + * + * - Return value (host): the current host + */ +static int l_host_self(lua_State * L) { + /* -- */ m_host_t host = MSG_host_self(); lua_newtable(L); - m_host_t *lua_host =(m_host_t *)lua_newuserdata(L,sizeof(m_host_t)); + /* table */ + m_host_t* lua_host = (m_host_t*) lua_newuserdata(L, sizeof(m_host_t)); + /* table ud */ *lua_host = host; luaL_getmetatable(L, HOST_MODULE_NAME); + /* table ud mt */ lua_setmetatable(L, -2); + /* table ud */ lua_setfield(L, -2, "__simgrid_host"); + /* table */ return 1; } -static int Host_get_property_value(lua_State * L) +/** + * \brief Returns the value of a host property. + * \param L a Lua state + * \return number of values returned to Lua + * + * - Argument 1 (host): a host + * - Argument 2 (string): name of the property to get + * - Return value (string): the value of this property + */ +static int l_host_get_property_value(lua_State * L) { - m_host_t ht = checkHost(L, -2); - const char *prop = luaL_checkstring(L, -1); + m_host_t ht = sglua_checkhost(L, 1); + const char *prop = luaL_checkstring(L, 2); lua_pushstring(L,MSG_host_get_property_value(ht,prop)); return 1; } -static int Host_sleep(lua_State *L) +/** + * \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 + */ +static int l_host_sleep(lua_State *L) { - int time = luaL_checknumber(L, -1); + int time = luaL_checknumber(L, 1); MSG_process_sleep(time); - return 1; + return 0; } -static int Host_destroy(lua_State *L) +/** + * \brief Destroys a host. + * \param L a Lua state + * \return number of values returned to Lua + * + * - Argument 1 (host): the host to destroy + */ +static int l_host_destroy(lua_State *L) { - m_host_t ht = checkHost(L, -1); + m_host_t ht = sglua_checkhost(L, 1); __MSG_host_destroy(ht); + return 0; +} + +static const luaL_reg host_functions[] = { + {"get_by_name", l_host_get_by_name}, + {"name", l_host_get_name}, + {"number", l_host_number}, + {"at", l_host_at}, + {"self", l_host_self}, + {"get_prop_value", l_host_get_property_value}, + {"sleep", l_host_sleep}, + {"destroy", l_host_destroy}, + // Bypass XML Methods + {"set_function", console_set_function}, + {"set_property", console_host_set_property}, + {NULL, NULL} +}; + +/** + * \brief Returns a string representation of a host. + * \param L a Lua state + * \return number of values returned to Lua + * + * - Argument 1 (userdata): a host + * - Return value (string): a string describing this host + */ +static int l_host_tostring(lua_State * L) +{ + lua_pushfstring(L, "Host :%p", lua_touserdata(L, 1)); return 1; } +static const luaL_reg host_meta[] = { + {"__tostring", l_host_tostring}, + {0, 0} +}; + /* ********************************************************************************* */ /* lua_stub_generator functions */ /* ********************************************************************************* */ @@ -816,7 +558,6 @@ static int gras_add_process_function(lua_State * L) return 0; } - static int gras_generate(lua_State * L) { const char *project_name = luaL_checkstring(L, 1); @@ -826,147 +567,33 @@ static int gras_generate(lua_State * L) return 0; } -/*********************************** - * Tracing - **********************************/ -static int trace_start(lua_State *L) -{ -#ifdef HAVE_TRACING - TRACE_start(); -#endif - return 1; -} - -static int trace_category(lua_State * L) -{ -#ifdef HAVE_TRACING - TRACE_category(luaL_checkstring(L, 1)); -#endif - return 1; -} - -static int trace_set_task_category(lua_State *L) -{ -#ifdef HAVE_TRACING - TRACE_msg_set_task_category(checkTask(L, -2), luaL_checkstring(L, -1)); -#endif - return 1; -} - -static int trace_end(lua_State *L) -{ -#ifdef HAVE_TRACING - TRACE_end(); -#endif - return 1; -} - -// *********** Register Methods ******************************************* // - -/* - * Host Methods - */ -static const luaL_reg Host_methods[] = { - {"getByName", Host_get_by_name}, - {"name", Host_get_name}, - {"number", Host_number}, - {"at", Host_at}, - {"self", Host_self}, - {"getPropValue", Host_get_property_value}, - {"sleep", Host_sleep}, - {"destroy", Host_destroy}, - // Bypass XML Methods - {"setFunction", console_set_function}, - {"setProperty", console_host_set_property}, - {NULL, NULL} -}; - -static int Host_gc(lua_State * L) -{ - m_host_t ht = checkHost(L, -1); - if (ht) - ht = NULL; - return 0; -} - -static int Host_tostring(lua_State * L) -{ - lua_pushfstring(L, "Host :%p", lua_touserdata(L, 1)); - return 1; -} - -static const luaL_reg Host_meta[] = { - {"__gc", Host_gc}, - {"__tostring", Host_tostring}, - {0, 0} -}; - -/* - * AS Methods - */ -static const luaL_reg AS_methods[] = { - {"new", console_add_AS}, - {"addHost", console_add_host}, - {"addLink", console_add_link}, - {"addRoute", console_add_route}, - {NULL, NULL} -}; +/* ********************************************************************************* */ +/* simgrid.platf API */ +/* ********************************************************************************* */ -/** - * Tracing Functions - */ -static const luaL_reg Trace_methods[] = { - {"start", trace_start}, - {"category", trace_category}, - {"setTaskCategory", trace_set_task_category}, - {"finish", trace_end}, - {NULL, NULL} +static const luaL_reg platf_functions[] = { + {"open", console_open}, + {"close", console_close}, + {"AS_open", console_AS_open}, + {"AS_close", console_AS_close}, + {"host_new", console_add_host}, + {"link_new", console_add_link}, + {"router_new", console_add_router}, + {"route_new", console_add_route}, + {NULL, NULL} }; -/* - * Environment related - */ +/* ********************************************************************************* */ +/* simgrid API */ +/* ********************************************************************************* */ /** - * @brief Runs a Lua function as a new simulated process. - * @param argc number of arguments of the function - * @param argv name of the Lua function and array of its arguments - * @return result of the function + * \brief Deploys your application. + * \param L a Lua state + * \return number of values returned to Lua + * + * - Argument 1 (string): name of the deployment file to load */ -static int run_lua_code(int argc, char **argv) -{ - XBT_DEBUG("Run lua code %s", argv[0]); - - lua_State *L = clone_lua_state(lua_maestro_state); - 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]); - - /* push arguments onto the stack */ - int i; - for (i = 1; i < argc; i++) - lua_pushstring(L, argv[i]); - - /* call the function */ - int err; - err = lua_pcall(L, argc - 1, 1, 0); - xbt_assert(err == 0, "error running function `%s': %s", argv[0], - lua_tostring(L, -1)); - - /* retrieve result */ - if (lua_isnumber(L, -1)) { - res = lua_tonumber(L, -1); - lua_pop(L, 1); /* pop returned value */ - } - - XBT_DEBUG("Execution of Lua code %s is over", (argv ? argv[0] : "(null)")); - - return res; -} - static int launch_application(lua_State * L) { const char *file = luaL_checkstring(L, 1); @@ -975,6 +602,13 @@ static int launch_application(lua_State * L) return 0; } +/** + * \brief Creates the platform. + * \param L a Lua state + * \return number of values returned to Lua + * + * - Argument 1 (string): name of the platform file to load + */ static int create_environment(lua_State * L) { const char *file = luaL_checkstring(L, 1); @@ -983,6 +617,13 @@ static int create_environment(lua_State * L) return 0; } +/** + * \brief Prints a log string with debug level. + * \param L a Lua state + * \return number of values returned to Lua + * + * - Argument 1 (string): the text to print + */ static int debug(lua_State * L) { const char *str = luaL_checkstring(L, 1); @@ -990,6 +631,13 @@ static int debug(lua_State * L) return 0; } +/** + * \brief Prints a log string with info level. + * \param L a Lua state + * \return number of values returned to Lua + * + * - Argument 1 (string): the text to print + */ static int info(lua_State * L) { const char *str = luaL_checkstring(L, 1); @@ -997,31 +645,36 @@ static int info(lua_State * L) return 0; } +/** + * \brief Runs your application. + * \param L a Lua state + * \return number of values returned to Lua + */ static int run(lua_State * L) { MSG_main(); return 0; } +/** + * \brief Cleans the simulation. + * \param L a Lua state + * \return number of values returned to Lua + */ static int clean(lua_State * L) { MSG_clean(); return 0; } -/* - * Bypass XML Parser (lua console) - */ - /* * Register platform for MSG */ static int msg_register_platform(lua_State * L) { /* Tell Simgrid we dont wanna use its parser */ - surf_parse = console_parse_platform; + //surf_parse = console_parse_platform; surf_parse_reset_callbacks(); - surf_config_models_setup(NULL); MSG_create_environment(NULL); return 0; } @@ -1032,9 +685,8 @@ static int msg_register_platform(lua_State * L) static int sd_register_platform(lua_State * L) { - surf_parse = console_parse_platform_wsL07; + //surf_parse = console_parse_platform_wsL07; surf_parse_reset_callbacks(); - surf_config_models_setup(NULL); SD_create_environment(NULL); return 0; } @@ -1044,10 +696,8 @@ static int sd_register_platform(lua_State * L) */ static int gras_register_platform(lua_State * L) { - /* Tell Simgrid we dont wanna use surf parser */ - surf_parse = console_parse_platform; + //surf_parse = console_parse_platform; surf_parse_reset_callbacks(); - surf_config_models_setup(NULL); gras_create_environment(NULL); return 0; } @@ -1058,7 +708,7 @@ static int gras_register_platform(lua_State * L) static int msg_register_application(lua_State * L) { MSG_function_register_default(run_lua_code); - surf_parse = console_parse_application; + //surf_parse = console_parse_application; MSG_launch_application(NULL); return 0; } @@ -1069,12 +719,12 @@ static int msg_register_application(lua_State * L) static int gras_register_application(lua_State * L) { gras_function_register_default(run_lua_code); - surf_parse = console_parse_application; + //surf_parse = console_parse_application; gras_launch_application(NULL); return 0; } -static const luaL_Reg simgrid_funcs[] = { +static const luaL_Reg simgrid_functions[] = { {"create_environment", create_environment}, {"launch_application", launch_application}, {"debug", debug}, @@ -1097,17 +747,18 @@ static const luaL_Reg simgrid_funcs[] = { }; /* ********************************************************************************* */ -/* module management functions */ +/* module management functions */ /* ********************************************************************************* */ #define LUA_MAX_ARGS_COUNT 10 /* maximum amount of arguments we can get from lua on command line */ -int luaopen_simgrid(lua_State *L); // Fuck gcc: we don't need that prototype - /** - * This function is called automatically by the Lua interpreter when some Lua code requires - * the "simgrid" module. - * @param L the Lua state + * \brief Opens the simgrid Lua module. + * + * This function is called automatically by the Lua interpreter when some + * Lua code requires the "simgrid" module. + * + * \param L the Lua state */ int luaopen_simgrid(lua_State *L) { @@ -1149,7 +800,11 @@ int luaopen_simgrid(lua_State *L) } /* Keep the context mechanism informed of our lua world today */ - lua_maestro_state = L; + sglua_maestro_state = L; + + /* initialize access to my tables by children Lua states */ + lua_newtable(L); + lua_setfield(L, LUA_REGISTRYINDEX, "simgrid.maestro_tables"); register_c_functions(L); @@ -1157,45 +812,164 @@ int luaopen_simgrid(lua_State *L) } /** - * Makes the appropriate Simgrid functions available to the Lua world. - * @param L a Lua world + * \brief Returns whether a Lua state is the maestro state. + * \param L a Lua state + * \return true if this is maestro */ -void register_c_functions(lua_State *L) { +int sglua_is_maestro(lua_State* L) { + return L == sglua_maestro_state; +} - /* register the core C functions to lua */ - luaL_register(L, "simgrid", simgrid_funcs); - - /* register the task methods to lua */ - luaL_openlib(L, TASK_MODULE_NAME, Task_methods, 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); // matatable.__index = methods +/** + * \brief Returns the maestro state. + * \return the maestro Lua state + */ +lua_State* sglua_get_maestro(void) { + return sglua_maestro_state; +} + +/** + * \brief Registers the task functions into the table simgrid.task. + * + * Also initialize the metatable of the task userdata type. + * + * \param L a lua state + */ +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 userdata itself: + * this allows to write task:method(args) for + * simgrid.task.method(task, args) */ + // FIXME: in the current implementation, a Lua task is a table with a + // __simgrid_task field that contains the userdata, so the OO-style + // writing doesn't work + lua_setfield(L, -2, "__index"); + /* simgrid.task mt */ 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 + /* simgrid.task mt "__metatable" */ + lua_pushnumber(L, 0); + /* simgrid.task mt "__metatable" 0 */ + /* protect the metatable from Lua code (by setting any value to __metatable) */ + lua_rawset(L, -3); /* simgrid.task mt */ + lua_pop(L, 2); + /* -- */ +} + +/** + * \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 */ - /* register the hosts methods to lua */ - luaL_openlib(L, HOST_MODULE_NAME, Host_methods, 0); + /* 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); + /* 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 host(args) for + * simgrid.host.method(host, args) */ + // FIXME: cannot work currently, same problem as tasks + lua_setfield(L, -2, "__index"); + /* simgrid.host mt */ lua_pushliteral(L, "__metatable"); - lua_pushvalue(L, -3); - lua_rawset(L, -3); - lua_pop(L, 1); + /* simgrid.host mt "__metatable" */ + lua_pushnumber(L, 0); + /* simgrid.host mt "__metatable" 0 */ + /* protect the metatable from Lua code (by setting any value to __metatable) */ + lua_rawset(L, -3); /* simgrid.host mt */ + lua_pop(L, 2); + /* -- */ +} + +/** + * \brief Registers the platform functions into the table simgrid.platf. + * \param L a lua state + */ +static void register_platf_functions(lua_State* L) { - /* register the links methods to lua */ - luaL_openlib(L, AS_MODULE_NAME, AS_methods, 0); - luaL_newmetatable(L, AS_MODULE_NAME); + luaL_openlib(L, PLATF_MODULE_NAME, platf_functions, 0); + /* simgrid.platf */ lua_pop(L, 1); +} - /* register the Tracing functions to lua */ - luaL_openlib(L, TRACE_MODULE_NAME, Trace_methods, 0); - luaL_newmetatable(L, TRACE_MODULE_NAME); +/** + * \brief Makes the Simgrid functions available to the Lua world. + * \param L a Lua world + */ +static void register_c_functions(lua_State *L) { + + /* register the core C functions to lua */ + luaL_register(L, "simgrid", simgrid_functions); + /* simgrid */ lua_pop(L, 1); + /* -- */ + register_task_functions(L); + register_host_functions(L); + register_platf_functions(L); +} + +/** + * \brief Runs a Lua function as a new simulated process. + * \param argc number of arguments of the function + * \param argv name of the Lua function and array of its arguments + * \return result of the function + */ +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), + "There is no Lua function with name `%s'", argv[0]); + + /* push arguments onto the stack */ + int i; + for (i = 1; i < argc; i++) + lua_pushstring(L, argv[i]); + + /* 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], + lua_tostring(L, -1)); + + /* retrieve result */ + if (lua_isnumber(L, -1)) { + res = lua_tonumber(L, -1); + lua_pop(L, 1); /* pop returned value */ + } + + XBT_DEBUG("Execution of Lua code %s is over", (argv ? argv[0] : "(null)")); + + return res; }