X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/2895b2413e1efc17e3a42047c85a4917f1114708..5265dc224e69f1d3094f04f86b97bb0d1308d80e:/src/bindings/lua/simgrid_lua.c

diff --git a/src/bindings/lua/simgrid_lua.c b/src/bindings/lua/simgrid_lua.c
index e919383643..0fd82dcc3a 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                                   */
 /* ********************************************************************************* */
@@ -96,6 +62,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)
 {
@@ -110,6 +81,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;
@@ -145,7 +120,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));
@@ -158,14 +133,30 @@ 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 / error): none 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);
+
+  switch (res) {
+
+    case MSG_OK:
+      return 0;
+
+    case MSG_TASK_CANCELED:
+      lua_pushliteral(L, "task canceled");
+      return 1;
+
+    case MSG_HOST_FAILURE:
+      lua_pushliteral(L, "host failure");
+      return 1;
+
+    default:
+      xbt_die("Unexpected result of MSG_task_execute(): %d, please report this bug", res);
+  }
 }
 
 /**
@@ -175,6 +166,9 @@ static int l_task_execute(lua_State* L)
  *
  * - Argument 1 (task): the task to send
  * - Argument 2 (string): mailbox
+ * - Return value (nil / error): none 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)
 {
@@ -191,34 +185,38 @@ static int l_task_send(lua_State* L)
     MSG_process_sleep(0);
   }
 
-  if (res == MSG_OK) {
+  switch (res) {
+
+  case 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");
-      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;
-    }
+    return 0;
+
+  case MSG_TIMEOUT:
+    XBT_DEBUG("MSG_task_send failed: timeout");
+    lua_settop(L, 0);
+    lua_pushliteral(L, "timeout");
+    return 1;
+
+  case MSG_TRANSFER_FAILURE:
+    XBT_DEBUG("MSG_task_send failed: transfer failure");
+    lua_settop(L, 0);
+    lua_pushliteral(L, "transfer failure");
+    return 1;
+
+  case MSG_HOST_FAILURE:
+    XBT_DEBUG("MSG_task_send failed: host failure");
+    lua_settop(L, 0);
+    lua_pushliteral(L, "host failure");
+    return 1;
+
+  default:
+    xbt_die("Unexpected result of MSG_task_send: %d, please report this bug", res);
   }
-  return 0;
 }
 
 /**
@@ -228,8 +226,8 @@ static int l_task_send(lua_State* L)
  *
  * - 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
+ * - Return value (task / nil+err): the task received, or nil plus an error message if
+ * the communication has failed
  */
 static int l_task_recv(lua_State *L)
 {
@@ -249,39 +247,45 @@ static int l_task_recv(lua_State *L)
                                   /* -- */
   MSG_error_t res = MSG_task_receive_with_timeout(&task, mailbox, timeout);
 
-  if (res == MSG_OK) {
+  switch (res) {
+
+  case MSG_OK:
     /* 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);
+    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;
-    }
+
+  case MSG_TIMEOUT:
+    XBT_DEBUG("MSG_task_send failed: timeout");
+    lua_pushnil(L);
+    lua_pushliteral(L, "timeout");
+    return 2;
+
+  case MSG_TRANSFER_FAILURE:
+    XBT_DEBUG("MSG_task_send failed: transfer failure");
+    lua_pushnil(L);
+    lua_pushliteral(L, "transfer failure");
+    return 2;
+
+  case MSG_HOST_FAILURE:
+    XBT_DEBUG("MSG_task_send failed: host failure");
     lua_pushnil(L);
-                                  /* nil */
+    lua_pushliteral(L, "host failure");
+    return 2;
+
+  default:
+    xbt_die("Unexpected result of MSG_task_recv: %d, please report this bug", res);
   }
-                                  /* task/nil */
-  return 1;
 }
 
 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},
@@ -322,8 +326,11 @@ 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}
 };
@@ -482,7 +489,7 @@ static int l_host_sleep(lua_State *L)
 {
   int time = luaL_checknumber(L, 1);
   MSG_process_sleep(time);
-  return 1;
+  return 0;
 }
 
 /**
@@ -496,7 +503,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[] = {
@@ -695,7 +702,7 @@ static int run(lua_State * L)
  * \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;
@@ -764,7 +771,6 @@ static const luaL_Reg simgrid_functions[] = {
   {"debug", debug},
   {"info", info},
   {"run", run},
-  {"clean", clean},
   /* short names */
   {"platform", create_environment},
   {"application", launch_application},
@@ -863,42 +869,117 @@ 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) {
-
-  /* register the core C functions to lua */
-  luaL_register(L, "simgrid", simgrid_functions);
+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);
+                                  /* -- */
+}
 
-  /* 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);
-  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);
+                                  /* -- */
+}
 
-  /* 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_host_functions(L);
+  register_platf_functions(L);
 }
 
 /**
@@ -911,13 +992,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;
@@ -927,7 +1009,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 */