* - 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)
{
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;
* - 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));
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},
{"recv", l_task_recv},
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}
};
* \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;
{"debug", debug},
{"info", info},
{"run", run},
- {"clean", clean},
/* short names */
{"platform", create_environment},
{"application", launch_application},
}
/**
- * \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
+ */
+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 task:method(args) for
+ * simgrid.task.method(task, args) */
+ lua_setfield(L, -2, "__index");
+ /* 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 */
+
+ /* create the metatable for host, add it to the Lua registry */
+ luaL_newmetatable(L, HOST_MODULE_NAME);
+ /* 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_pop(L, 2);
+ /* -- */
+}
+
+/**
+ * \brief Registers the platform functions into the table simgrid.platf.
+ * \param L a lua state
*/
-void register_c_functions(lua_State *L) {
+static void register_platf_functions(lua_State* L)
+{
+ luaL_openlib(L, PLATF_MODULE_NAME, platf_functions, 0);
+ /* 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 */
- /* 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 */
- luaL_openlib(L, HOST_MODULE_NAME, host_functions, 0);
- 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);
+ /* 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);
+ /* -- */
+}
- /* register the platform methods to lua */
- luaL_openlib(L, PLATF_MODULE_NAME, platf_functions, 0);
- luaL_newmetatable(L, PLATF_MODULE_NAME);
- 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_host_functions(L);
+ register_platf_functions(L);
}
/**
{
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;
/* 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 */
