X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/8a43946b44780021927676dcab1944fa67ee8340..efd201684c340bfd7508b656bdbc59f57e7e7c67:/src/bindings/lua/simgrid_lua.c

diff --git a/src/bindings/lua/simgrid_lua.c b/src/bindings/lua/simgrid_lua.c
index d29e6d56f4..3496588228 100644
--- a/src/bindings/lua/simgrid_lua.c
+++ b/src/bindings/lua/simgrid_lua.c
@@ -25,40 +25,6 @@ int luaopen_simgrid(lua_State *L);
 static void register_c_functions(lua_State *L);
 static int run_lua_code(int argc, char **argv);
 
-
-/**
- * \brief Like luaL_checkudata, with additional debug logs.
- *
- * This function is for debugging purposes only.
- *
- * \param L a lua state
- * \param ud index of the userdata to check in the stack
- * \param tname key of the metatable of this userdata in the registry
- */
-static void* my_checkudata(lua_State* L, int ud, const char* tname)
-{
-  XBT_DEBUG("Checking the userdata: 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);
-
-  int has_mt = lua_getmetatable(L, ud);
-  XBT_DEBUG("Checking the userdata: 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);
-
-  if (p == NULL || !lua_getmetatable(L, ud) || !lua_rawequal(L, -1, -2))
-    luaL_typerror(L, ud, tname);
-  lua_pop(L, 2);
-  return p;
-}
-
 /* ********************************************************************************* */
 /*                                simgrid.task API                                   */
 /* ********************************************************************************* */
@@ -222,21 +188,29 @@ static int l_task_send(lua_State* L)
 }
 
 /**
- * \brief Receives a task or fails after a timeout.
+ * \brief Receives a task.
  * \param L a Lua state
  * \return number of values returned to Lua
  *
  * - Argument 1 (string): mailbox
- * - Argument 2 (number): timeout
+ * - 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_with_timeout(lua_State *L)
+static int l_task_recv(lua_State *L)
 {
   m_task_t task = NULL;
   const char* mailbox = luaL_checkstring(L, 1);
-  int timeout = luaL_checknumber(L, 2);
+  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);
@@ -270,21 +244,6 @@ static int l_task_recv_with_timeout(lua_State *L)
   return 1;
 }
 
-/**
- * \brief Receives a task.
- * \param L a Lua state
- * \return number of values returned to Lua
- *
- * - Argument 1 (string): mailbox
- * - Return value (task/nil): the task received or nil if the communication
- * has failed
- */
-static int l_task_recv(lua_State * L)
-{
-  lua_pushnumber(L, -1.0);
-  return l_task_recv_with_timeout(L);
-}
-
 static const luaL_reg task_functions[] = {
   {"new", l_task_new},
   {"name", l_task_get_name},
@@ -292,7 +251,6 @@ static const luaL_reg task_functions[] = {
   {"execute", l_task_execute},
   {"send", l_task_send},
   {"recv", l_task_recv},
-  {"recv_timeout", l_task_recv_with_timeout},
   {NULL, NULL}
 };
 
@@ -325,7 +283,7 @@ static int l_task_gc(lua_State* L)
  */
 static int l_task_tostring(lua_State* L)
 {
-  m_task_t task = sglua_checktask(L, 1);
+  m_task_t task = *((m_task_t*) luaL_checkudata(L, 1, TASK_MODULE_NAME));
   lua_pushfstring(L, "Task: %p", task);
   return 1;
 }
@@ -490,7 +448,7 @@ static int l_host_sleep(lua_State *L)
 {
   int time = luaL_checknumber(L, 1);
   MSG_process_sleep(time);
-  return 1;
+  return 0;
 }
 
 /**
@@ -504,7 +462,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[] = {
@@ -871,42 +829,96 @@ 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 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_pop(L, 2);
+                                  /* -- */
+}
 
-  /* register the core C functions to lua */
-  luaL_register(L, "simgrid", simgrid_functions);
+/**
+ * \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) {
 
-  /* 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 */
+  /* 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);
-  lua_pop(L, 1);
+                                  /* 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
+ */
+static void register_platf_functions(lua_State* L) {
 
-  /* register the platform methods to lua */
   luaL_openlib(L, PLATF_MODULE_NAME, platf_functions, 0);
-  luaL_newmetatable(L, PLATF_MODULE_NAME);
+                                  /* simgrid.platf */
+  lua_pop(L, 1);
+}
+
+/**
+ * \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);
 }
 
 /**
@@ -919,13 +931,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;
@@ -935,7 +948,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 */