-/* 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 "lua_state_cloner.h"
+#include "lua_utils.h"
XBT_LOG_NEW_DEFAULT_SUBCATEGORY(lua, bindings, "Lua Bindings");
-lua_State *simgrid_lua_state;
+static lua_State *lua_maestro_state;
#define TASK_MODULE_NAME "simgrid.Task"
#define HOST_MODULE_NAME "simgrid.Host"
-// Surf ( bypass XML )
+// 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"
-/* ********************************************************************************* */
-/* helper functions */
-/* ********************************************************************************* */
-static void stackDump(const char *msg, lua_State * L)
-{
- char buff[2048];
- char *p = buff;
- int i;
- int top = lua_gettop(L);
-
- fflush(stdout);
- p += sprintf(p, "STACK(top=%d): ", top);
-
- for (i = 1; i <= top; i++) { /* repeat for each level */
- int t = lua_type(L, i);
- switch (t) {
-
- case LUA_TSTRING: /* strings */
- p += sprintf(p, "`%s'", lua_tostring(L, i));
- break;
-
- case LUA_TBOOLEAN: /* booleans */
- p += sprintf(p, lua_toboolean(L, i) ? "true" : "false");
- break;
+static void register_c_functions(lua_State *L);
- case LUA_TNUMBER: /* numbers */
- p += sprintf(p, "%g", lua_tonumber(L, i));
- break;
+static void *my_checkudata (lua_State *L, int ud, const char *tname) {
- case LUA_TTABLE:
- p += sprintf(p, "Table");
- break;
+ XBT_DEBUG("Checking the task: ud = %d", ud);
+ sglua_stack_dump("my_checkudata: ", L);
+ void *p = lua_touserdata(L, ud);
+ lua_getfield(L, LUA_REGISTRYINDEX, tname);
+ const void* correct_mt = lua_topointer(L, -1);
- default: /* other values */
- p += sprintf(p, "???");
-/* if ((ptr = luaL_checkudata(L,i,TASK_MODULE_NAME))) {
- p+=sprintf(p,"task");
- } else {
- p+=printf(p,"%s", lua_typename(L, t));
- }*/
- break;
+ int has_mt = lua_getmetatable(L, ud);
+ XBT_DEBUG("Checking the task: has metatable ? %d", has_mt);
+ const void* actual_mt = NULL;
+ if (has_mt) { actual_mt = lua_topointer(L, -1); lua_pop(L, 1); }
+ XBT_DEBUG("Checking the task's metatable: expected %p, found %p", correct_mt, actual_mt);
+ sglua_stack_dump("my_checkudata: ", L);
- }
- p += sprintf(p, " "); /* put a separator */
- }
- XBT_INFO("%s%s", msg, buff);
+ if (p == NULL || !lua_getmetatable(L, ud) || !lua_rawequal(L, -1, -2))
+ luaL_typerror(L, ud, tname);
+ lua_pop(L, 2);
+ return p;
}
-/** @brief ensures that a userdata on the stack is a task and returns the pointer inside the userdata */
+/**
+ * @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;
+ XBT_DEBUG("Lua task: %s", sglua_tostring(L, index));
luaL_checktype(L, index, LUA_TTABLE);
lua_getfield(L, index, "__simgrid_task");
- pi = (m_task_t *) luaL_checkudata(L, -1, TASK_MODULE_NAME);
+
+ pi = (m_task_t *) luaL_checkudata(L, lua_gettop(L), TASK_MODULE_NAME);
+
if (pi == NULL)
luaL_typerror(L, index, TASK_MODULE_NAME);
tk = *pi;
/* * * *
* * Constructors * *
* * * */
+
/**
- * Construct an new task with the specified processing amount and amount
+ * @brief Constructs a new task with the specified processing amount and amount
* of data needed.
*
* @param name Task's name
*/
static int Task_new(lua_State * L)
{
+ 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);
static int Task_send(lua_State * L)
{
- //stackDump("send ",L);
- m_task_t tk = checkTask(L, -2);
- const char *mailbox = luaL_checkstring(L, -1);
+ //stack_dump("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);
if (res != MSG_OK)
switch (res) {
case MSG_TIMEOUT:
- XBT_ERROR("MSG_task_send failed : Timeout");
+ XBT_DEBUG("MSG_task_send failed : Timeout");
break;
case MSG_TRANSFER_FAILURE:
- XBT_ERROR("MSG_task_send failed : Transfer Failure");
+ XBT_DEBUG("MSG_task_send failed : Transfer Failure");
break;
case MSG_HOST_FAILURE:
- XBT_ERROR("MSG_task_send failed : Host Failure ");
+ XBT_DEBUG("MSG_task_send failed : Host Failure ");
break;
default:
XBT_ERROR
return 0;
}
-static int Task_recv(lua_State * L)
+static int Task_recv_with_timeout(lua_State *L)
{
m_task_t tk = NULL;
- const char *mailbox = luaL_checkstring(L, -1);
- MSG_error_t res = MSG_task_receive(&tk, mailbox);
-
- 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);
-
- if (res != MSG_OK)
+ 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);
+
+ if (res == MSG_OK) {
+ lua_State *sender_stack = MSG_task_get_data(tk);
+ sglua_move_value(sender_stack, L); // copy the data directly from sender's stack
+ MSG_task_set_data(tk, NULL);
+ }
+ else {
switch (res) {
case MSG_TIMEOUT:
- XBT_ERROR("MSG_task_receive failed : Timeout");
+ XBT_DEBUG("MSG_task_receive failed : Timeout");
break;
case MSG_TRANSFER_FAILURE:
- XBT_ERROR("MSG_task_receive failed : Transfer Failure");
+ XBT_DEBUG("MSG_task_receive failed : Transfer Failure");
break;
case MSG_HOST_FAILURE:
- XBT_ERROR("MSG_task_receive failed : Host Failure ");
+ XBT_DEBUG("MSG_task_receive failed : Host Failure ");
break;
default:
- XBT_ERROR
- ("MSG_task_receive failed : Unexpected error , please report this bug");
+ XBT_ERROR("MSG_task_receive failed : Unexpected error , please report this bug");
break;
}
-
+ lua_pushnil(L);
+ }
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},
{"destroy", Task_destroy},
{"send", Task_send},
{"recv", Task_recv},
- {0, 0}
+ {"recv_timeout", Task_recv_with_timeout},
+ {NULL, NULL}
};
static int Task_gc(lua_State * L)
static const luaL_reg Task_meta[] = {
{"__gc", Task_gc},
{"__tostring", Task_tostring},
- {0, 0}
+ {NULL, NULL}
};
/**
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;
XBT_DEBUG("Getting Host from name...");
m_host_t msg_host = MSG_get_host_by_name(name);
if (!msg_host) {
- luaL_error(L, "null Host : MSG_get_host_by_name failled");
+ luaL_error(L, "null Host : MSG_get_host_by_name failed");
}
lua_newtable(L); /* create a table, put the userdata on top of it */
m_host_t *lua_host = (m_host_t *) lua_newuserdata(L, sizeof(m_host_t));
return 1;
}
-
static int Host_get_name(lua_State * L)
{
m_host_t ht = checkHost(L, -1);
static int 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));
- *lua_host = host;
- luaL_getmetatable(L, HOST_MODULE_NAME);
- lua_setmetatable(L, -2);
- lua_setfield(L, -2, "__simgrid_host");
- return 1;
-
+ /* -- */
+ m_host_t host = MSG_host_self();
+ lua_newtable(L);
+ /* 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)
{
- m_host_t ht = checkHost(L, -2);
- const char *prop = luaL_checkstring(L, -1);
- lua_pushstring(L,MSG_host_get_property_value(ht,prop));
- return 1;
+ m_host_t ht = checkHost(L, -2);
+ const char *prop = luaL_checkstring(L, -1);
+ lua_pushstring(L,MSG_host_get_property_value(ht,prop));
+ return 1;
+}
+
+static int Host_sleep(lua_State *L)
+{
+ int time = luaL_checknumber(L, -1);
+ MSG_process_sleep(time);
+ return 1;
+}
+
+static int Host_destroy(lua_State *L)
+{
+ m_host_t ht = checkHost(L, -1);
+ __MSG_host_destroy(ht);
+ return 1;
}
/* ********************************************************************************* */
lua_pop(L, 1);
//add to the process list
xbt_dynar_push(process_list, &process);
-
return 0;
-
}
#endif
return 1;
}
-//***********Register Methods *******************************************//
+
+// *********** Register Methods ******************************************* //
+
/*
* Host Methods
*/
{"name", Host_get_name},
{"number", Host_number},
{"at", Host_at},
- {"self",Host_self},
- {"getPropValue",Host_get_property_value},
+ {"self", Host_self},
+ {"getPropValue", Host_get_property_value},
+ {"sleep", Host_sleep},
+ {"destroy", Host_destroy},
// Bypass XML Methods
- {"new", console_add_host},
{"setFunction", console_set_function},
- {0, 0}
+ {"setProperty", console_host_set_property},
+ {NULL, NULL}
};
static int Host_gc(lua_State * L)
*/
static const luaL_reg AS_methods[] = {
{"new", console_add_AS},
- {0, 0}
-};
-
-
-/*
- * Link Methods
- */
-static const luaL_reg Link_methods[] = {
- {"new", console_add_link},
- {0, 0}
-};
-
-/*
- * Route Methods
- */
-static const luaL_reg Route_methods[] = {
- {"new", console_add_route},
- {0, 0}
+ {"addHost", console_add_host},
+ {"addLink", console_add_link},
+ {"addRoute", console_add_route},
+ {NULL, NULL}
};
/**
* Tracing Functions
*/
static const luaL_reg Trace_methods[] = {
- {"start",trace_start},
- {"category",trace_category},
- {"setTaskCategory",trace_set_task_category},
- {"finish",trace_end},
- {0,0}
+ {"start", trace_start},
+ {"category", trace_category},
+ {"setTaskCategory", trace_set_task_category},
+ {"finish", trace_end},
+ {NULL, NULL}
};
+
/*
* Environment related
*/
-extern lua_State *simgrid_lua_state;
-
+/**
+ * @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]);
- lua_State *L = lua_newthread(simgrid_lua_state);
- int ref = luaL_ref(simgrid_lua_state, LUA_REGISTRYINDEX); // protect the thread from being garbage collected
+
+ lua_State *L = sglua_clone_maestro();
int res = 1;
- /* Start the co-routine */
+ /* start the function */
lua_getglobal(L, argv[0]);
- xbt_assert1(lua_isfunction(L, -1),
+ xbt_assert(lua_isfunction(L, -1),
"The lua function %s does not seem to exist", argv[0]);
- // push arguments onto the stack
+ /* push arguments onto the stack */
int i;
for (i = 1; i < argc; i++)
lua_pushstring(L, argv[i]);
- // Call the function (in resume)
- xbt_assert2(lua_pcall(L, argc - 1, 1, 0) == 0,
- "error running function `%s': %s", argv[0], lua_tostring(L,
- -1));
+ /* 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 */
}
- // cleanups
- luaL_unref(simgrid_lua_state, LUA_REGISTRYINDEX, ref);
- XBT_DEBUG("Execution of lua code %s is over", (argv ? argv[0] : "(null)"));
+
+ XBT_DEBUG("Execution of Lua code %s is over", (argv ? argv[0] : "(null)"));
+
return res;
}
return 0;
}
-#include "simix/simix.h" //FIXME: KILLME when debugging on simix internals become useless
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);
-
-/*
- xbt_dict_t hosts = SIMIX_host_get_dict();
- smx_host_t host;
- xbt_dict_cursor_t c;
- const char *name;
-
- xbt_dict_foreach(hosts, c, name, host) {
- XBT_DEBUG("We have an host %s", SIMIX_host_get_name(host));
- }
-*/
-
return 0;
}
/* module management functions */
/* ********************************************************************************* */
-
#define LUA_MAX_ARGS_COUNT 10 /* maximum amount of arguments we can get from lua on command line */
-#define TEST
-int luaopen_simgrid(lua_State * L); // Fuck gcc: we don't need that prototype
-int luaopen_simgrid(lua_State * L)
+
+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
+ */
+int luaopen_simgrid(lua_State *L)
{
+ XBT_DEBUG("luaopen_simgrid *****");
+ /* Get the command line arguments from the lua interpreter */
char **argv = malloc(sizeof(char *) * LUA_MAX_ARGS_COUNT);
int argc = 1;
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? */
- /* Get the command line arguments from the lua interpreter */
+
lua_getglobal(L, "arg");
/* if arg is a null value, it means we use lua only as a script to init platform
* else it should be a table and then take arg in consideration
if (lua_isnil(L, -1)) {
done = 1;
} else {
- xbt_assert1(lua_isstring(L, -1),
+ xbt_assert(lua_isstring(L, -1),
"argv[%d] got from lua is no string", argc - 1);
- xbt_assert2(argc < LUA_MAX_ARGS_COUNT,
+ xbt_assert(argc < LUA_MAX_ARGS_COUNT,
"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",
__FILE__, LUA_MAX_ARGS_COUNT - 1);
argv[argc - 1] = (char *) luaL_checkstring(L, -1);
MSG_global_init(&argc, argv);
XBT_DEBUG("Still %d arguments on command line", argc); // FIXME: update the lua's arg table to reflect the changes from SimGrid
}
+
+ /* Keep the context mechanism informed of our lua world today */
+ lua_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);
+
+ return 1;
+}
+
+/**
+ * @brief Returns whether a Lua state is the maestro state.
+ * @param L a Lua state
+ * @return true if this is maestro
+ */
+int sglua_is_maestro(lua_State* L) {
+ return L == lua_maestro_state;
+}
+
+/**
+ * @brief Returns the maestro state.
+ * @return true the maestro Lua state
+ */
+lua_State* sglua_get_maestro(void) {
+ return lua_maestro_state;
+}
+
+/**
+ * Makes the appropriate Simgrid functions available to the Lua world.
+ * @param L a Lua world
+ */
+void register_c_functions(lua_State *L) {
+
/* 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, 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
+ lua_pushvalue(L, -3); // dup methods table
+ lua_rawset(L, -3); // matatable.__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
+ 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_methods, 0);
luaL_newmetatable(L, AS_MODULE_NAME);
lua_pop(L, 1);
- /* register the links methods to lua */
- luaL_openlib(L, LINK_MODULE_NAME, Link_methods, 0);
- luaL_newmetatable(L, LINK_MODULE_NAME);
- lua_pop(L, 1);
-
- /*register the routes methods to lua */
- luaL_openlib(L, ROUTE_MODULE_NAME, Route_methods, 0);
- luaL_newmetatable(L, ROUTE_MODULE_NAME);
- lua_pop(L, 1);
-
- /*register the Tracing functions to lua */
+ /* register the Tracing functions to lua */
luaL_openlib(L, TRACE_MODULE_NAME, Trace_methods, 0);
luaL_newmetatable(L, TRACE_MODULE_NAME);
lua_pop(L, 1);
-
- /* Keep the context mechanism informed of our lua world today */
- simgrid_lua_state = L;
- return 1;
}