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