-/* SimGrid Lua bindings */
-
-/* Copyright (c) 2010, the SimGrid team. All right reserved. */
+/* 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. */
-#include <stdio.h>
-#include <lua5.1/lauxlib.h>
-#include <lua5.1/lualib.h>
+/* SimGrid Lua bindings */
-#include "msg/msg.h"
+#include "lua_private.h"
+#include "lua_state_cloner.h"
+#include "lua_utils.h"
#include "xbt.h"
+#include "msg/msg.h"
+#include "simdag/simdag.h"
+#include "surf/surfxml_parse.h"
+#include <lauxlib.h>
+
+XBT_LOG_NEW_DEFAULT_SUBCATEGORY(lua, bindings, "Lua Bindings");
-XBT_LOG_NEW_DEFAULT_SUBCATEGORY(lua,bindings,"Lua Bindings");
+static lua_State* sglua_maestro_state;
-#define TASK_MODULE_NAME "simgrid.Task"
+int luaopen_simgrid(lua_State *L);
+static void sglua_register_c_functions(lua_State *L);
+static int run_lua_code(int argc, char **argv);
/* ********************************************************************************* */
-/* helper functions */
+/* simgrid API */
/* ********************************************************************************* */
-static void stackDump (lua_State *L) {
- char buff[2048];
- char *p=buff;
- int i;
- int top = lua_gettop(L);
- void *ptr;
- 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;
-
- case LUA_TNUMBER: /* numbers */
- p+=sprintf(p,"%g", lua_tonumber(L, i));
- break;
-
- default: /* other values */
- if ((ptr = luaL_checkudata(L,i,TASK_MODULE_NAME))) {
- p+=sprintf(p,"task");
- } else {
- p+=printf(p,"%s", lua_typename(L, t));
- }
- break;
-
- }
- p+=sprintf(p," "); /* put a separator */
- }
- INFO1("%s",buff);
-}
+/**
+ * \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 launch_application(lua_State* L) {
-/** @brief ensures that a userdata on the stack is a task and returns the pointer inside the userdata */
-static m_task_t checkTask (lua_State *L,int index) {
- m_task_t *pi,tk;
- luaL_checktype(L,index,LUA_TUSERDATA);
- pi = (m_task_t*)luaL_checkudata(L,index,TASK_MODULE_NAME);
- if(pi == NULL)
- luaL_typerror(L,index,TASK_MODULE_NAME);
- tk = *pi;
- if(!tk)
- luaL_error(L,"null Task");
- return tk;
+ const char* file = luaL_checkstring(L, 1);
+ MSG_function_register_default(run_lua_code);
+ MSG_launch_application(file);
+ return 0;
}
-/** @brief leaves a new userdata on top of the stack, sets its metatable, and sets the Task pointer inside the userdata */
-static m_task_t *pushTask (lua_State *L,m_task_t tk) {
- m_task_t *pi = (m_task_t*)lua_newuserdata(L,sizeof(m_task_t));
- *pi=tk;
- luaL_getmetatable(L,TASK_MODULE_NAME);
- lua_setmetatable(L,-2);
- return pi;
+/**
+ * \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);
+ XBT_DEBUG("Loading environment file %s", file);
+ MSG_create_environment(file);
+ 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) {
-/* ********************************************************************************* */
-/* wrapper functions */
-/* ********************************************************************************* */
-
-static int Task_new(lua_State* L) {
- const char *name=luaL_checkstring(L,1);
- int comp_size = luaL_checkint(L,2);
- int msg_size = luaL_checkint(L,3);
- // FIXME: data shouldn't be NULL I guess
- pushTask(L,MSG_task_create(name,comp_size,msg_size,NULL));
- INFO0("Created task");
- return 1;
+ const char* str = luaL_checkstring(L, 1);
+ XBT_DEBUG("%s", str);
+ return 0;
}
-static int Task_get_name(lua_State *L) {
- m_task_t tk = checkTask(L,1);
- lua_pushstring(L,MSG_task_get_name(tk));
- return 1;
-}
+/**
+ * \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) {
-static int Task_computation_duration(lua_State *L){
- m_task_t tk = checkTask(L,1);
- lua_pushnumber(L,MSG_task_get_compute_duration (tk));
- return 1;
+ const char* str = luaL_checkstring(L, 1);
+ XBT_INFO("%s", str);
+ return 0;
}
-static int Task_execute(lua_State *L){
- m_task_t tk = checkTask(L,1);
- int res = MSG_task_execute(tk);
- lua_pushnumber(L,res);
- return 1;
-}
+/**
+ * \brief Runs your application.
+ * \param L a Lua state
+ * \return number of values returned to Lua
+ */
+static int run(lua_State* L) {
-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;
-}
-static int Task_send(lua_State *L) {
- m_task_t tk = checkTask(L,1);
- const char *mailbox = luaL_checkstring(L,2);
- stackDump(L);fflush(stdout);fflush(stderr);
- int res = MSG_task_send(tk,mailbox);
- res++;//FIXME: check it instead of avoiding the warning
- stackDump(L);
+ MSG_main();
return 0;
}
-static int Task_recv(lua_State *L) {
- m_task_t tk = NULL;
- //stackDump(L);
- const char *mailbox = luaL_checkstring(L,1);
- int res = MSG_task_receive(&tk,mailbox);
- res++;//FIXME: check it instead of avoiding the warning
- INFO1("Task Name : >>>%s",MSG_task_get_name(tk));
- pushTask(L,tk);
- // stackDump(L);
- return 1;
-}
-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},
- {0,0}
-};
-static int Task_gc(lua_State *L) {
- m_task_t tk=checkTask(L,1);
- if (tk) MSG_task_destroy(tk);
- //printf("GoodBye Task(%p)\n",lua_touserdata(L,1));
- return 0;
-}
+/**
+ * \brief Returns the current simulated time.
+ * \param L a Lua state
+ * \return number of values returned to Lua
+ *
+ * - Return value (number): the simulated time
+ */
+static int get_clock(lua_State* L) {
-static int Task_tostring(lua_State *L) {
- lua_pushfstring(L, "Task :%p",lua_touserdata(L,1));
+ lua_pushnumber(L, MSG_get_clock());
return 1;
}
-
-static const luaL_reg Task_meta[] = {
- {"__gc", Task_gc},
- {"__tostring", Task_tostring},
- {0,0}
-};
-
-/*
- * Environment related
+/**
+ * \brief Cleans the simulation.
+ * \param L a Lua state
+ * \return number of values returned to Lua
*/
-static int launch_application(lua_State *L) {
- const char * file = luaL_checkstring(L,1);
- MSG_launch_application(file);
+static int simgrid_gc(lua_State * L)
+{
+ // There is no need to cleanup the C world anymore, as it gets cleaned at system process closing automatically
+ // Maybe at some point we'll want to reintroduce this, for example when encapsulating the simulation properly
+ //if (sglua_is_maestro(L)) {
+ // MSG_clean();
+ //}
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);
- INFO1("Loading environment file %s",file);
- MSG_create_environment(file);
- smx_host_t *hosts = SIMIX_host_get_table();
- int i;
- for (i=0;i<SIMIX_host_get_number();i++) {
- INFO1("We have an host %s", SIMIX_host_get_name(hosts[i]));
- }
+/*
+ * Register platform for MSG
+ */
+static int msg_register_platform(lua_State * L)
+{
+ /* Tell Simgrid we don't wanna use its parser */
+ //surf_parse = console_parse_platform;
+ surf_parse_reset_callbacks();
+ MSG_create_environment(NULL);
return 0;
}
-static int debug(lua_State *L) {
- const char *str = luaL_checkstring(L,1);
- DEBUG1("%s",str);
- return 0;
-}
-static int info(lua_State *L) {
- const char *str = luaL_checkstring(L,1);
- INFO1("%s",str);
+
+/*
+ * Register platform for Simdag
+ */
+static int sd_register_platform(lua_State * L)
+{
+ //surf_parse = console_parse_platform_wsL07;
+ surf_parse_reset_callbacks();
+ SD_create_environment(NULL);
return 0;
}
-static int run(lua_State *L) {
- MSG_main();
+
+/**
+ * Register applicaiton for MSG
+ */
+static int msg_register_application(lua_State * L)
+{
+ MSG_function_register_default(run_lua_code);
+ //surf_parse = console_parse_application;
+ MSG_launch_application(NULL);
return 0;
}
-static int clean(lua_State *L) {
- MSG_clean();
+
+static int console_init_application(lua_State *L) {
+ MSG_function_register_default(run_lua_code);
+ SIMIX_init_application();
return 0;
}
-static const luaL_Reg simgrid_funcs[] = {
- { "create_environment", create_environment},
- { "launch_application", launch_application},
- { "debug", debug},
- { "info", info},
- { "run", run},
- { "clean", clean},
- /* short names */
- { "platform", create_environment},
- { "application", launch_application},
- { NULL, NULL }
+
+
+static const luaL_Reg simgrid_functions[] = {
+ {"create_environment", create_environment},
+ {"launch_application", launch_application},
+ {"debug", debug},
+ {"info", info},
+ {"run", run},
+ {"get_clock", get_clock},
+ /* short names */
+ {"platform", create_environment},
+ {"application", launch_application},
+ /* methods to bypass XML parser */
+ {"msg_register_platform", msg_register_platform},
+ {"sd_register_platform", sd_register_platform},
+ {"msg_register_application", msg_register_application},
+ {"init_application", console_init_application},
+ {NULL, NULL}
};
/* ********************************************************************************* */
-/* module management functions */
+/* module management functions */
/* ********************************************************************************* */
-void SIMIX_ctx_lua_factory_set_state(void *state);/* Hack: pass the L to our factory */
-extern const char*xbt_ctx_factory_to_use; /*Hack: let msg load directly the right factory */
+#define LUA_MAX_ARGS_COUNT 10 /* maximum amount of arguments we can get from lua on command line */
-#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
-int luaopen_simgrid(lua_State* L) {
- xbt_ctx_factory_to_use = "lua";
+/**
+ * \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)
+{
+ XBT_DEBUG("luaopen_simgrid *****");
- 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");
- xbt_assert1(lua_istable(L,-1),"arg parameter is not a table but a %s",lua_typename(L,-1));
- int done=0;
- while (!done) {
- argc++;
- lua_pushinteger(L,argc-2);
- lua_gettable(L,-2);
- if (lua_isnil(L,-1)) {
- done = 1;
- } else {
- xbt_assert1(lua_isstring(L,-1),"argv[%d] got from lua is no string",argc-1);
- xbt_assert2(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);
- lua_pop(L,1);
- INFO1("Got command line argument %s from lua",argv[argc-1]);
+ char **argv = xbt_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? */
+
+ 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_istable(L, -1)) {
+ int done = 0;
+ while (!done) {
+ argc++;
+ lua_pushinteger(L, argc - 2);
+ lua_gettable(L, -2);
+ if (lua_isnil(L, -1)) {
+ done = 1;
+ } else {
+ xbt_assert(lua_isstring(L, -1),
+ "argv[%d] got from lua is no string", argc - 1);
+ 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);
+ lua_pop(L, 1);
+ XBT_DEBUG("Got command line argument %s from lua", argv[argc - 1]);
+ }
}
+ argv[argc--] = NULL;
+
+ /* Initialize the MSG core */
+ MSG_init(&argc, argv);
+ MSG_process_set_data_cleanup((void_f_pvoid_t) lua_close);
+ XBT_DEBUG("Still %d arguments on command line", argc); // FIXME: update the lua's arg table to reflect the changes from SimGrid
}
- argv[argc--]=NULL;
- /* Initialize the MSG core */
- MSG_global_init(&argc,argv);
- INFO1("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 */
+ sglua_maestro_state = L;
- /* register the core C functions to lua */
- luaL_register(L, "simgrid", simgrid_funcs);
- /* register the tasks 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
- 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
+ /* initialize access to my tables by children Lua states */
+ lua_newtable(L);
+ lua_setfield(L, LUA_REGISTRYINDEX, "simgrid.maestro_tables");
- /* Keep the context mechanism informed of our lua world today */
- SIMIX_ctx_lua_factory_set_state(L);
+ sglua_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 == sglua_maestro_state;
+}
+
+/**
+ * \brief Returns the maestro state.
+ * \return the maestro Lua state
+ */
+lua_State* sglua_get_maestro(void) {
+ return sglua_maestro_state;
+}
+
+/**
+ * \brief Makes the core functions available to the Lua world.
+ * \param L a Lua world
+ */
+static void sglua_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 sglua_register_c_functions(lua_State *L)
+{
+ sglua_register_core_functions(L);
+ sglua_register_task_functions(L);
+ sglua_register_comm_functions(L);
+ sglua_register_host_functions(L);
+ sglua_register_process_functions(L);
+ sglua_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();
+ MSG_process_set_data(MSG_process_self(), L);
+
+ /* 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 */
+ int res = 1;
+ 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;
+}
+
+/**
+ * \brief Returns a string corresponding to an MSG error code.
+ * \param err an MSG error code
+ * \return a string describing this error
+ */
+const char* sglua_get_msg_error(msg_error_t err) {
+
+ static const char* msg_errors[] = {
+ NULL,
+ "timeout",
+ "transfer failure",
+ "host failure",
+ "task canceled"
+ };
+
+ return msg_errors[err];
+}
