Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Sanitize the includes of context objects declarations (was dupplicated and a bit...
[simgrid.git] / src / simix / smx_context_lua.c
1 /* $Id$ */
2
3 /* context_lua - implementation of context switching with lua coroutines */
4
5 /* Copyright (c) 2004-2008 the SimGrid team. All right reserved */
6
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. */
9
10 #include "smx_context_private.h"
11 #include <lua5.1/lauxlib.h>
12 #include <lua5.1/lualib.h>
13
14 /* lower this if you want to reduce the memory consumption  */
15 //#define STACK_SIZE 128*1024
16
17 //#ifdef HAVE_VALGRIND_VALGRIND_H
18 //#  include <valgrind/valgrind.h>
19 //#endif /* HAVE_VALGRIND_VALGRIND_H */
20
21 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(lua);
22
23 typedef struct s_smx_ctx_sysv {
24   s_smx_ctx_base_t super;  /* Fields of super implementation */
25
26 #ifdef KILLME
27   /* Ucontext info */
28   ucontext_t uc;                /* the thread that execute the code */
29   char stack[STACK_SIZE];       /* the thread stack size */
30   struct s_smx_ctx_sysv *prev;           /* the previous process */
31 #ifdef HAVE_VALGRIND_VALGRIND_H
32   unsigned int valgrind_stack_id;       /* the valgrind stack id */
33 #endif
34 #endif /* KILLME */
35
36   /* lua state info */
37   lua_State *state;
38   int ref; /* to prevent the lua GC from collecting my threads, I ref them explicitely */
39   int nargs; /* argument to lua_resume. First time: argc-1, afterward: 0 */
40 } s_smx_ctx_lua_t, *smx_ctx_lua_t;
41
42 static lua_State *lua_state;
43
44 static smx_context_t 
45 smx_ctx_lua_create_context(xbt_main_func_t code, int argc, char** argv, 
46     void_f_pvoid_t cleanup_func, void* cleanup_arg);
47
48 static int smx_ctx_lua_factory_finalize(smx_context_factory_t *factory);
49
50 static void smx_ctx_lua_free(smx_context_t context);
51 static void smx_ctx_lua_stop(smx_context_t context);
52 static void smx_ctx_lua_suspend(smx_context_t context);
53 static void smx_ctx_lua_resume(smx_context_t new_context);
54
55 static void smx_ctx_sysv_wrapper(void);
56
57 /* Actually, the parameter is a lua_State*, but it got anonymized because that function
58  * is defined in a global header where lua may not be defined */
59 void SIMIX_ctx_lua_factory_set_state(void* state) {
60   lua_state = state;
61 }
62 void SIMIX_ctx_lua_factory_init(smx_context_factory_t *factory) {
63
64   smx_ctx_base_factory_init(factory);
65
66   (*factory)->create_context = smx_ctx_lua_create_context;
67   (*factory)->finalize = smx_ctx_lua_factory_finalize;
68   (*factory)->free = smx_ctx_lua_free;
69   (*factory)->stop = smx_ctx_lua_stop;
70   (*factory)->suspend = smx_ctx_lua_suspend;
71   (*factory)->resume = smx_ctx_lua_resume;
72   (*factory)->name = "smx_lua_context_factory";
73
74   INFO0("Lua Factory created");
75 }
76
77 static int smx_ctx_lua_factory_finalize(smx_context_factory_t * factory) {
78   lua_close(lua_state);
79
80   return smx_ctx_base_factory_finalize(factory);
81 }
82
83 static smx_context_t 
84 smx_ctx_lua_create_context(xbt_main_func_t code, int argc, char** argv, 
85     void_f_pvoid_t cleanup_func, void* cleanup_arg) {
86
87   smx_ctx_lua_t context = xbt_new0(s_smx_ctx_lua_t, 1);
88
89   /* If the user provided a function for the process then use it
90      otherwise is the context for maestro */
91   if (code){
92     context->super.code = code;
93
94     context->super.argc = argc;
95     context->super.argv = argv;
96     context->super.cleanup_func = cleanup_func;
97     context->super.cleanup_arg = cleanup_arg;
98     INFO1("Created context for function %s",argv[0]);
99
100     /* start the coroutine in charge of running that code */
101     context->state = lua_newthread(lua_state);
102     context->ref = luaL_ref(lua_state, LUA_REGISTRYINDEX); // protect the thread from being garbage collected
103
104     /* Start the co-routine */
105     lua_getglobal(context->state,context->super.argv[0]);
106     xbt_assert1(lua_isfunction(context->state,-1),
107         "The lua function %s does not seem to exist",context->super.argv[0]);
108
109     // push arguments onto the stack
110     int i;
111     for(i=1;i<context->super.argc;i++)
112       lua_pushstring(context->state,context->super.argv[i]);
113
114     // Call the function (in resume)
115     context->nargs = context->super.argc-1;
116
117   } else {
118     INFO0("Created context for maestro");
119   }
120
121   return (smx_context_t)context;
122 }
123
124 static void smx_ctx_lua_free(smx_context_t context) {
125
126   if (context){
127     DEBUG1("smx_ctx_lua_free_context(%p)",context);
128
129     /* let the lua garbage collector reclaim the thread used for the coroutine */
130     luaL_unref(lua_state,LUA_REGISTRYINDEX,((smx_ctx_lua_t)context)->ref );
131   }
132
133   smx_ctx_base_free(context);
134 }
135
136 static void smx_ctx_lua_stop(smx_context_t pcontext) {
137   smx_ctx_lua_t context = (smx_ctx_lua_t)pcontext;
138
139   INFO1("Stopping '%s' (nothing to do)",context->super.argv[0]);
140   if (context->super.cleanup_func)
141     (*context->super.cleanup_func) (context->super.cleanup_arg);
142
143 //  smx_ctx_lua_suspend(pcontext);
144 }
145
146 static void smx_ctx_lua_suspend(smx_context_t pcontext) {
147   smx_ctx_lua_t context = (smx_ctx_lua_t)pcontext;
148   DEBUG1("Suspending '%s' (calling lua_yield)",context->super.argv[0]);
149   //lua_yield(context->state,0);
150
151   lua_getglobal(context->state,"doyield");
152   xbt_assert0(lua_isfunction(context->state,-1),
153       "Cannot find the coroutine.yield function...");
154   INFO0("Call coroutine.yield");
155   lua_call(context->state,0,0);
156   INFO0("Back from call to coroutine.yield");
157 }
158
159 static void 
160 smx_ctx_lua_resume(smx_context_t new_context) {
161   smx_ctx_lua_t context = (smx_ctx_lua_t)new_context;
162   DEBUG1("Resuming %s",context->super.argv[0]);
163   int ret = lua_resume(context->state,context->nargs);
164   INFO3("Function %s yielded back with value %d %s",context->super.argv[0],ret,(ret==LUA_YIELD?"(ie, LUA_YIELD)":""));
165   if (lua_isstring(context->state,-1))
166     INFO2("Result of %s seem to be '%s'",context->super.argv[0],luaL_checkstring(context->state,-1));
167   context->nargs=0;
168 }