3 /* context_lua - implementation of context switching with lua coroutines */
5 /* Copyright (c) 2004-2008 the SimGrid team. All right reserved */
7 /* This program is free software; you can redistribute it and/or modify it
8 * under the terms of the license (GNU LGPL) which comes with this package. */
11 //#include "context_sysv_config.h" /* loads context system definitions */
12 //#include "portable.h"
13 //#include <ucontext.h> /* context relative declarations */
14 #include <lua5.1/lauxlib.h>
15 #include <lua5.1/lualib.h>
17 /* lower this if you want to reduce the memory consumption */
18 //#define STACK_SIZE 128*1024
20 //#ifdef HAVE_VALGRIND_VALGRIND_H
21 //# include <valgrind/valgrind.h>
22 //#endif /* HAVE_VALGRIND_VALGRIND_H */
24 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(lua);
26 typedef struct s_smx_ctx_sysv {
30 ucontext_t uc; /* the thread that execute the code */
31 char stack[STACK_SIZE]; /* the thread stack size */
32 struct s_smx_ctx_sysv *prev; /* the previous process */
33 #ifdef HAVE_VALGRIND_VALGRIND_H
34 unsigned int valgrind_stack_id; /* the valgrind stack id */
40 int ref; /* to prevent the lua GC from collecting my threads, I ref them explicitely */
41 int nargs; /* argument to lua_resume. First time: argc-1, afterward: 0 */
42 } s_smx_ctx_lua_t, *smx_ctx_lua_t;
44 static lua_State *lua_state;
47 smx_ctx_lua_create_context(xbt_main_func_t code, int argc, char** argv,
48 void_f_pvoid_t cleanup_func, void* cleanup_arg);
50 static int smx_ctx_lua_factory_finalize(smx_context_factory_t *factory);
52 static void smx_ctx_lua_free(smx_context_t context);
53 static void smx_ctx_lua_stop(smx_context_t context);
54 static void smx_ctx_lua_suspend(smx_context_t context);
55 static void smx_ctx_lua_resume(smx_context_t new_context);
57 static void smx_ctx_sysv_wrapper(void);
59 /* Actually, the parameter is a lua_State*, but it got anonymized because that function
60 * is defined in a global header where lua may not be defined */
61 void SIMIX_ctx_lua_factory_set_state(void* state) {
64 void SIMIX_ctx_lua_factory_init(smx_context_factory_t *factory) {
66 *factory = xbt_new0(s_smx_context_factory_t, 1);
68 (*factory)->create_context = smx_ctx_lua_create_context;
69 (*factory)->finalize = smx_ctx_lua_factory_finalize;
70 (*factory)->free = smx_ctx_lua_free;
71 (*factory)->stop = smx_ctx_lua_stop;
72 (*factory)->suspend = smx_ctx_lua_suspend;
73 (*factory)->resume = smx_ctx_lua_resume;
74 (*factory)->name = "smx_lua_context_factory";
76 INFO0("Lua Factory created");
79 static int smx_ctx_lua_factory_finalize(smx_context_factory_t * factory) {
88 smx_ctx_lua_create_context(xbt_main_func_t code, int argc, char** argv,
89 void_f_pvoid_t cleanup_func, void* cleanup_arg) {
91 smx_ctx_lua_t context = xbt_new0(s_smx_ctx_lua_t, 1);
93 /* If the user provided a function for the process then use it
94 otherwise is the context for maestro */
100 context->cleanup_func = cleanup_func;
101 context->cleanup_arg = cleanup_arg;
102 INFO1("Created context for function %s",argv[0]);
104 /* start the coroutine in charge of running that code */
105 context->state = lua_newthread(lua_state);
106 context->ref = luaL_ref(lua_state, LUA_REGISTRYINDEX); // protect the thread from being garbage collected
108 /* Start the co-routine */
109 lua_getglobal(context->state,context->argv[0]);
110 xbt_assert1(lua_isfunction(context->state,-1),
111 "The lua function %s does not seem to exist",context->argv[0]);
113 // push arguments onto the stack
115 for(i=1;i<context->argc;i++)
116 lua_pushstring(context->state,context->argv[i]);
118 // Call the function (in resume)
119 context->nargs = context->argc-1;
122 INFO0("Created context for maestro");
125 return (smx_context_t)context;
128 static void smx_ctx_lua_free(smx_context_t pcontext)
131 smx_ctx_lua_t context = (smx_ctx_lua_t)pcontext;
134 DEBUG1("smx_ctx_lua_free_context(%p)",context);
138 for (i = 0; i < context->argc; i++)
139 if (context->argv[i])
140 free(context->argv[i]);
145 /* let the lua garbage collector reclaim the thread used for the coroutine */
146 luaL_unref(lua_state,LUA_REGISTRYINDEX,context->ref );
153 static void smx_ctx_lua_stop(smx_context_t pcontext) {
154 smx_ctx_lua_t context = (smx_ctx_lua_t)pcontext;
156 INFO1("Stopping '%s' (nothing to do)",context->argv[0]);
157 if (context->cleanup_func)
158 (*context->cleanup_func) (context->cleanup_arg);
160 // smx_ctx_lua_suspend(pcontext);
163 static void smx_ctx_lua_suspend(smx_context_t pcontext) {
164 smx_ctx_lua_t context = (smx_ctx_lua_t)pcontext;
165 DEBUG1("Suspending '%s' (calling lua_yield)",context->argv[0]);
166 //lua_yield(context->state,0);
168 lua_getglobal(context->state,"doyield");
169 xbt_assert0(lua_isfunction(context->state,-1),
170 "Cannot find the coroutine.yield function...");
171 INFO0("Call coroutine.yield");
172 lua_call(context->state,0,0);
173 INFO0("Back from call to coroutine.yield");
177 smx_ctx_lua_resume(smx_context_t new_context) {
178 smx_ctx_lua_t context = (smx_ctx_lua_t)new_context;
179 DEBUG1("Resuming %s",context->argv[0]);
180 int ret = lua_resume(context->state,context->nargs);
181 INFO3("Function %s yielded back with value %d %s",context->argv[0],ret,(ret==LUA_YIELD?"(ie, LUA_YIELD)":""));
182 if (lua_isstring(context->state,-1))
183 INFO2("Result of %s seem to be '%s'",context->argv[0],luaL_checkstring(context->state,-1));