Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Copy directly the lua task from stack to stack. Allows to remove the pimple where...
[simgrid.git] / src / bindings / lua / simgrid_lua.c
1 /* SimGrid Lua bindings                                                     */
2
3 /* Copyright (c) 2010, the SimGrid team. All right reserved.                */
4
5 /* This program is free software; you can redistribute it and/or modify it
6  * under the terms of the license (GNU LGPL) which comes with this package. */
7
8 #include <stdio.h>
9 #include <lauxlib.h>
10 #include <lualib.h>
11
12 #include "msg/msg.h"
13 #include "xbt.h"
14
15 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(lua,bindings,"Lua Bindings");
16
17 #define TASK_MODULE_NAME "simgrid.Task"
18
19 /* ********************************************************************************* */
20 /*                            helper functions                                       */
21 /* ********************************************************************************* */
22
23 static void stackDump (const char *msg, lua_State *L) {
24   char buff[2048];
25   char *p=buff;
26   int i;
27   int top = lua_gettop(L);
28   void *ptr;
29   fflush(stdout);
30   p+=sprintf(p,"STACK(top=%d): ",top);
31   for (i = 1; i <= top; i++) {  /* repeat for each level */
32     int t = lua_type(L, i);
33     switch (t) {
34
35     case LUA_TSTRING:  /* strings */
36       p+=sprintf(p,"`%s'", lua_tostring(L, i));
37       break;
38
39     case LUA_TBOOLEAN:  /* booleans */
40       p+=sprintf(p,lua_toboolean(L, i) ? "true" : "false");
41       break;
42
43     case LUA_TNUMBER:  /* numbers */
44       p+=sprintf(p,"%g", lua_tonumber(L, i));
45       break;
46
47     default:  /* other values */
48       if ((ptr = luaL_checkudata(L,i,TASK_MODULE_NAME))) {
49         p+=sprintf(p,"task");
50       } else {
51         p+=printf(p,"%s", lua_typename(L, t));
52       }
53       break;
54
55     }
56     p+=sprintf(p,"  ");  /* put a separator */
57   }
58   INFO2("%s%s",msg,buff);
59 }
60
61 /** @brief ensures that a userdata on the stack is a task and returns the pointer inside the userdata */
62 static m_task_t checkTask (lua_State *L,int index) {
63   m_task_t *pi,tk;
64   luaL_checktype(L,index,LUA_TUSERDATA);
65   pi = (m_task_t*)luaL_checkudata(L,index,TASK_MODULE_NAME);
66   if(pi == NULL)
67          luaL_typerror(L,index,TASK_MODULE_NAME);
68   tk = *pi;
69   if(!tk)
70          luaL_error(L,"null Task");
71   return  tk;
72 }
73
74 /** @brief leaves a new userdata on top of the stack, sets its metatable, and sets the Task pointer inside the userdata */
75 static m_task_t *pushTask (lua_State *L,m_task_t tk) {
76
77   m_task_t *pi = NULL;
78   pi = (m_task_t*)lua_newuserdata(L,sizeof(m_task_t));
79   *pi=tk;
80
81   DEBUG1("push lua task with Name : %s \n",MSG_task_get_name(*pi));
82   luaL_getmetatable(L,TASK_MODULE_NAME);
83   lua_setmetatable(L,-2);
84   return pi;
85
86 }
87
88 /* ********************************************************************************* */
89 /*                           wrapper functions                                       */
90 /* ********************************************************************************* */
91
92 static int Task_new(lua_State* L) {
93   const char *name=luaL_checkstring(L,1);
94   int comp_size = luaL_checkint(L,2);
95   int msg_size = luaL_checkint(L,3);
96   m_task_t msg_task = MSG_task_create(name,comp_size,msg_size,NULL);
97   m_task_t *lua_task = (m_task_t*)lua_newuserdata(L,sizeof(m_task_t));
98   *lua_task = msg_task;
99   MSG_task_set_data(msg_task,lua_task);
100   pushTask(L,msg_task);
101   INFO0("Created task");
102   return 1;
103 }
104
105 static int Task_get_name(lua_State *L) {
106   m_task_t tk = checkTask(L,1);
107   lua_pushstring(L,MSG_task_get_name(tk));
108   return 1;
109 }
110
111 static int Task_computation_duration(lua_State *L){
112   m_task_t tk = checkTask(L,1);
113   lua_pushnumber(L,MSG_task_get_compute_duration (tk));
114   return 1;
115 }
116
117 static int Task_execute(lua_State *L){
118   m_task_t tk = checkTask(L,1);
119   int res = MSG_task_execute(tk);
120   lua_pushnumber(L,res);
121   return 1;
122 }
123
124 static int Task_destroy(lua_State *L) {
125   m_task_t tk = checkTask(L,1);
126   int res = MSG_task_destroy(tk);
127   lua_pushnumber(L,res);
128   return 1;
129 }
130 static int Task_send(lua_State *L)  {
131   m_task_t tk = checkTask(L,1);
132   const char *mailbox = luaL_checkstring(L,2);
133   lua_pop(L,1); // remove the string so that the task is on top of it
134   MSG_task_set_data(tk,L); // Copy my stack into the task, so that the receiver can copy the lua task directly
135   MSG_error_t res = MSG_task_send(tk,mailbox);
136   while (MSG_task_has_data(tk)) // Don't mess up with my stack: the receiver didn't copy the data yet
137     MSG_process_sleep(0); // yield
138
139   if (res != MSG_OK) switch(res) {
140     case MSG_TIMEOUT :
141       ERROR0("MSG_task_send failed : Timeout");
142       break;
143     case MSG_TRANSFER_FAILURE :
144       ERROR0("MSG_task_send failed : Transfer Failure");
145       break;
146     case MSG_HOST_FAILURE :
147       ERROR0("MSG_task_send failed : Host Failure ");
148       break;
149     default :
150       ERROR0("MSG_task_send failed : Unexpected error , please report this bug");
151       break;
152     }
153   return 0;
154 }
155 static int Task_recv(lua_State *L)  {
156   m_task_t tk = NULL;
157   const char *mailbox = luaL_checkstring(L,1);
158   MSG_error_t res = MSG_task_receive(&tk,mailbox);
159
160   lua_State *sender_stack = MSG_task_get_data(tk);
161   lua_xmove(sender_stack,L,1); // copy the data directly from sender's stack
162   MSG_task_set_data(tk,NULL);
163
164   if(res != MSG_OK) switch(res){
165           case MSG_TIMEOUT :
166                   ERROR0("MSG_task_receive failed : Timeout");
167                   break;
168           case MSG_TRANSFER_FAILURE :
169                   ERROR0("MSG_task_receive failed : Transfer Failure");
170                   break;
171           case MSG_HOST_FAILURE :
172                   ERROR0("MSG_task_receive failed : Host Failure ");
173                   break;
174           default :
175                   ERROR0("MSG_task_receive failed : Unexpected error , please report this bug");
176                   break;
177                   }
178
179   return 1;
180 }
181
182 static const luaL_reg Task_methods[] = {
183     {"new",   Task_new},
184     {"name",  Task_get_name},
185     {"computation_duration",  Task_computation_duration},
186     {"execute", Task_execute},
187     {"destroy", Task_destroy},
188     {"send",    Task_send},
189     {"recv",    Task_recv},
190     {0,0}
191 };
192 static int Task_gc(lua_State *L) {
193   m_task_t tk=checkTask(L,1);
194   if (tk) MSG_task_destroy(tk);
195   //printf("GoodBye Task(%p)\n",lua_touserdata(L,1));
196   return 0;
197 }
198
199 static int Task_tostring(lua_State *L) {
200   lua_pushfstring(L, "Task :%p",lua_touserdata(L,1));
201   return 1;
202 }
203
204
205 static const luaL_reg Task_meta[] = {
206     {"__gc",  Task_gc},
207     {"__tostring",  Task_tostring},
208     {0,0}
209 };
210
211 /*
212  * Environment related
213  */
214 extern lua_State *simgrid_lua_state;
215
216 static int run_lua_code(int argc,char **argv) {
217   DEBUG1("Run lua code %s",argv[0]);
218 //  fprintf(stderr,"Run lua code %s\n", (argv ? argv[0] : "(null)"));
219   lua_State *L = lua_newthread(simgrid_lua_state);
220   int ref = luaL_ref(simgrid_lua_state, LUA_REGISTRYINDEX); // protect the thread from being garbage collected
221   int res = 1;
222
223   /* Start the co-routine */
224   lua_getglobal(L,argv[0]);
225   xbt_assert1(lua_isfunction(L,-1),
226       "The lua function %s does not seem to exist",argv[0]);
227
228   // push arguments onto the stack
229   int i;
230   for(i=1;i<argc;i++)
231     lua_pushstring(L,argv[i]);
232
233   // Call the function (in resume)
234   xbt_assert2(lua_pcall(L, argc-1, 1, 0) == 0,
235     "error running function `%s': %s",argv[0], lua_tostring(L, -1));
236
237   /* retrieve result */
238   if (lua_isnumber(L, -1)) {
239     res = lua_tonumber(L, -1);
240     lua_pop(L, 1);  /* pop returned value */
241   }
242
243   // cleanups
244   luaL_unref(simgrid_lua_state,LUA_REGISTRYINDEX,ref );
245   DEBUG1("Execution of lua code %s is over", (argv ? argv[0] : "(null)"));
246   return res;
247 }
248 static int launch_application(lua_State *L) {
249   const char * file = luaL_checkstring(L,1);
250   MSG_function_register_default(run_lua_code);
251   MSG_launch_application(file);
252   return 0;
253 }
254 #include "simix/simix.h" //FIXME: KILLME when debugging on simix internals become useless
255 static int create_environment(lua_State *L) {
256   const char *file = luaL_checkstring(L,1);
257   DEBUG1("Loading environment file %s",file);
258   MSG_create_environment(file);
259   smx_host_t *hosts = SIMIX_host_get_table();
260   int i;
261   for (i=0;i<SIMIX_host_get_number();i++) {
262     DEBUG1("We have an host %s", SIMIX_host_get_name(hosts[i]));
263   }
264
265   return 0;
266 }
267 static int debug(lua_State *L) {
268   const char *str = luaL_checkstring(L,1);
269   DEBUG1("%s",str);
270   return 0;
271 }
272 static int info(lua_State *L) {
273   const char *str = luaL_checkstring(L,1);
274   INFO1("%s",str);
275   return 0;
276 }
277 static int run(lua_State *L) {
278   MSG_main();
279   return 0;
280 }
281 static int clean(lua_State *L) {
282   MSG_clean();
283   return 0;
284 }
285 static const luaL_Reg simgrid_funcs[] = {
286     { "create_environment", create_environment},
287     { "launch_application", launch_application},
288     { "debug", debug},
289     { "info", info},
290     { "run", run},
291     { "clean", clean},
292     /* short names */
293     { "platform", create_environment},
294     { "application", launch_application},
295     { NULL, NULL }
296 };
297
298 /* ********************************************************************************* */
299 /*                       module management functions                                 */
300 /* ********************************************************************************* */
301
302 extern const char*xbt_ctx_factory_to_use; /*Hack: let msg load directly the right factory */
303
304 #define LUA_MAX_ARGS_COUNT 10 /* maximum amount of arguments we can get from lua on command line */
305
306 int luaopen_simgrid(lua_State* L); // Fuck gcc: we don't need that prototype
307 int luaopen_simgrid(lua_State* L) {
308   //xbt_ctx_factory_to_use = "lua";
309
310   char **argv=malloc(sizeof(char*)*LUA_MAX_ARGS_COUNT);
311   int argc=1;
312   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? */
313   /* Get the command line arguments from the lua interpreter */
314   lua_getglobal(L,"arg");
315   xbt_assert1(lua_istable(L,-1),"arg parameter is not a table but a %s",lua_typename(L,-1));
316   int done=0;
317   while (!done) {
318     argc++;
319     lua_pushinteger(L,argc-2);
320     lua_gettable(L,-2);
321     if (lua_isnil(L,-1)) {
322       done = 1;
323     } else {
324       xbt_assert1(lua_isstring(L,-1),"argv[%d] got from lua is no string",argc-1);
325       xbt_assert2(argc<LUA_MAX_ARGS_COUNT,
326            "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",
327            __FILE__,LUA_MAX_ARGS_COUNT-1);
328       argv[argc-1] = (char*)luaL_checkstring(L,-1);
329       lua_pop(L,1);
330       DEBUG1("Got command line argument %s from lua",argv[argc-1]);
331     }
332   }
333   argv[argc--]=NULL;
334
335   /* Initialize the MSG core */
336   MSG_global_init(&argc,argv);
337   DEBUG1("Still %d arguments on command line",argc); // FIXME: update the lua's arg table to reflect the changes from SimGrid
338
339   /* register the core C functions to lua */
340   luaL_register(L, "simgrid", simgrid_funcs);
341   /* register the tasks to lua */
342   luaL_openlib(L,TASK_MODULE_NAME,Task_methods,0); //create methods table,add it to the globals
343   luaL_newmetatable(L,TASK_MODULE_NAME); //create metatable for Task,add it to the Lua registry
344   luaL_openlib(L,0,Task_meta,0);// fill metatable
345   lua_pushliteral(L,"__index");
346   lua_pushvalue(L,-3);  //dup methods table
347   lua_rawset(L,-3); //matatable.__index = methods
348   lua_pushliteral(L,"__metatable");
349   lua_pushvalue(L,-3);  //dup methods table
350   lua_rawset(L,-3); //hide metatable:metatable.__metatable = methods
351   lua_pop(L,1);   //drop metatable
352
353   /* Keep the context mechanism informed of our lua world today */
354   simgrid_lua_state = L;
355
356   return 1;
357 }