Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Lua: add a function simgrid.process.sleep()
[simgrid.git] / src / bindings / lua / simgrid_lua.c
1 /* Copyright (c) 2010. The SimGrid Team.
2  * All rights reserved.                                                     */
3
4 /* This program is free software; you can redistribute it and/or modify it
5  * under the terms of the license (GNU LGPL) which comes with this package. */
6
7 /* SimGrid Lua bindings                                                     */
8
9 #include "simgrid_lua.h"
10 #include "lua_state_cloner.h"
11 #include "lua_utils.h"
12
13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(lua, bindings, "Lua Bindings");
14
15 #define TASK_MODULE_NAME "simgrid.task"
16 #define HOST_MODULE_NAME "simgrid.host"
17 #define PROCESS_MODULE_NAME "simgrid.process"
18 // Surf (bypass XML)
19 #define LINK_MODULE_NAME "simgrid.link"
20 #define ROUTE_MODULE_NAME "simgrid.route"
21 #define PLATF_MODULE_NAME "simgrid.platf"
22
23 static lua_State* sglua_maestro_state;
24
25 int luaopen_simgrid(lua_State *L);
26 static void register_c_functions(lua_State *L);
27 static int run_lua_code(int argc, char **argv);
28
29 /* ********************************************************************************* */
30 /*                                simgrid.task API                                   */
31 /* ********************************************************************************* */
32
33 /**
34  * \brief Ensures that a value in the stack is a valid task and returns it.
35  * \param L a Lua state
36  * \param index an index in the Lua stack
37  * \return the C task corresponding to this Lua task
38  */
39 static m_task_t sglua_checktask(lua_State* L, int index)
40 {
41   sglua_stack_dump("check task: ", L);
42   luaL_checktype(L, index, LUA_TTABLE);
43                                   /* ... task ... */
44   lua_getfield(L, index, "__simgrid_task");
45                                   /* ... task ... ctask */
46   m_task_t task = *((m_task_t*) luaL_checkudata(L, -1, TASK_MODULE_NAME));
47   lua_pop(L, 1);
48                                   /* ... task ... */
49
50   if (task == NULL) {
51     luaL_error(L, "This task was sent to someone else, you cannot access it anymore");
52   }
53
54   return task;
55 }
56
57 /**
58  * \brief Creates a new task and leaves it onto the stack.
59  * \param L a Lua state
60  * \return number of values returned to Lua
61  *
62  * - Argument 1 (string): name of the task
63  * - Argument 2 (number): computation size
64  * - Argument 3 (number): communication size
65  * - Return value (task): the task created
66  *
67  * A Lua task is a regular table with a full userdata inside, and both share
68  * the same metatable. For the regular table, the metatable allows OO-style
69  * writing such as your_task:send(someone).
70  * For the userdata, the metatable is used to check its type.
71  */
72 static int l_task_new(lua_State* L)
73 {
74   XBT_DEBUG("Task new");
75   const char* name = luaL_checkstring(L, 1);
76   int comp_size = luaL_checkint(L, 2);
77   int msg_size = luaL_checkint(L, 3);
78                                   /* name comp comm */
79   lua_settop(L, 0);
80                                   /* -- */
81   m_task_t msg_task = MSG_task_create(name, comp_size, msg_size, NULL);
82
83   lua_newtable(L);
84                                   /* task */
85   luaL_getmetatable(L, TASK_MODULE_NAME);
86                                   /* task mt */
87   lua_setmetatable(L, -2);
88                                   /* task */
89   m_task_t* lua_task = (m_task_t*) lua_newuserdata(L, sizeof(m_task_t));
90                                   /* task ctask */
91   *lua_task = msg_task;
92   luaL_getmetatable(L, TASK_MODULE_NAME);
93                                   /* task ctask mt */
94   lua_setmetatable(L, -2);
95                                   /* task ctask */
96   lua_setfield(L, -2, "__simgrid_task");
97                                   /* task */
98   return 1;
99 }
100
101 /**
102  * \brief Returns the name of a task.
103  * \param L a Lua state
104  * \return number of values returned to Lua
105  *
106  * - Argument 1 (task): a task
107  * - Return value (string): name of the task
108  */
109 static int l_task_get_name(lua_State* L)
110 {
111   m_task_t task = sglua_checktask(L, 1);
112   lua_pushstring(L, MSG_task_get_name(task));
113   return 1;
114 }
115
116 /**
117  * \brief Returns the computation duration of a task.
118  * \param L a Lua state
119  * \return number of values returned to Lua
120  *
121  * - Argument 1 (task): a task
122  * - Return value (number): computation duration of this task
123  */
124 static int l_task_get_computation_duration(lua_State* L)
125 {
126   m_task_t task = sglua_checktask(L, 1);
127   lua_pushnumber(L, MSG_task_get_compute_duration(task));
128   return 1;
129 }
130
131 /**
132  * \brief Executes a task.
133  * \param L a Lua state
134  * \return number of values returned to Lua
135  *
136  * - Argument 1 (task): the task to execute
137  * - Return value (nil or string): nil if the task was successfully executed,
138  * or an error string in case of failure, which may be "task canceled" or
139  * "host failure"
140  */
141 static int l_task_execute(lua_State* L)
142 {
143   m_task_t task = sglua_checktask(L, 1);
144   MSG_error_t res = MSG_task_execute(task);
145
146   switch (res) {
147
148     case MSG_OK:
149       return 0;
150
151     case MSG_TASK_CANCELED:
152       lua_pushliteral(L, "task canceled");
153       return 1;
154
155     case MSG_HOST_FAILURE:
156       lua_pushliteral(L, "host failure");
157       return 1;
158
159     default:
160       xbt_die("Unexpected result of MSG_task_execute(): %d, please report this bug", res);
161   }
162 }
163
164 /**
165  * \brief Sends a task to a mailbox and waits for its completion.
166  * \param L a Lua state
167  * \return number of values returned to Lua
168  *
169  * - Argument 1 (task): the task to send
170  * - Argument 2 (string or compatible): mailbox name, as a real string or any
171  * type convertible to string (numbers always are)
172  * - Return values (nil or string): nil if the communication was successful,
173  * or an error string in case of failure, which may be "timeout",
174  * "host failure" or "transfer failure"
175  */
176 static int l_task_send(lua_State* L)
177 {
178   m_task_t task = sglua_checktask(L, 1);
179   const char* mailbox = luaL_checkstring(L, 2);
180                                   /* task mailbox */
181   lua_settop(L, 1);
182                                   /* task */
183   /* copy my stack into the task, so that the receiver can copy the lua task */
184   MSG_task_set_data(task, L);
185   MSG_error_t res = MSG_task_send(task, mailbox);
186   while (MSG_task_get_data(task) != NULL) {
187     /* don't mess up with my stack: the receiver didn't copy the data yet */
188     MSG_process_sleep(0);
189   }
190
191   switch (res) {
192
193   case MSG_OK:
194     /* the receiver is the owner of the task and may destroy it:
195      * remove the C task on my side so that I don't garbage collect it */
196     lua_getfield(L, 1, "__simgrid_task");
197                                   /* task ctask */
198     m_task_t* udata = (m_task_t*) luaL_checkudata(L, -1, TASK_MODULE_NAME);
199     *udata = NULL;
200     return 0;
201
202   case MSG_TIMEOUT:
203     XBT_DEBUG("MSG_task_send failed: timeout");
204     lua_settop(L, 0);
205     lua_pushliteral(L, "timeout");
206     return 1;
207
208   case MSG_TRANSFER_FAILURE:
209     XBT_DEBUG("MSG_task_send failed: transfer failure");
210     lua_settop(L, 0);
211     lua_pushliteral(L, "transfer failure");
212     return 1;
213
214   case MSG_HOST_FAILURE:
215     XBT_DEBUG("MSG_task_send failed: host failure");
216     lua_settop(L, 0);
217     lua_pushliteral(L, "host failure");
218     return 1;
219
220   default:
221     xbt_die("Unexpected result of MSG_task_send: %d, please report this bug", res);
222   }
223 }
224
225 /**
226  * \brief Receives a task.
227  * \param L a Lua state
228  * \return number of values returned to Lua
229  *
230  * - Argument 1 (string or compatible): mailbox name, as a real string or any
231  * type convertible to string (numbers always are)
232  * - Argument 2 (number, optional): timeout (default is no timeout)
233  * - Return values (task or nil+string): the task received, or nil plus an
234  * error message if the communication has failed
235  */
236 static int l_task_recv(lua_State* L)
237 {
238   m_task_t task = NULL;
239   const char* mailbox = luaL_checkstring(L, 1);
240   int timeout;
241   if (lua_gettop(L) >= 2) {
242                                   /* mailbox timeout */
243     timeout = luaL_checknumber(L, 2);
244   }
245   else {
246                                   /* mailbox */
247     timeout = -1;
248     /* no timeout by default */
249   }
250   lua_settop(L, 0);
251                                   /* -- */
252   MSG_error_t res = MSG_task_receive_with_timeout(&task, mailbox, timeout);
253
254   switch (res) {
255
256   case MSG_OK:
257     /* copy the data directly from sender's stack */
258   {
259     lua_State* sender_stack = MSG_task_get_data(task);
260     sglua_copy_value(sender_stack, L);
261                                   /* task */
262     MSG_task_set_data(task, NULL);
263     return 1;
264   }
265
266   case MSG_TIMEOUT:
267     XBT_DEBUG("MSG_task_send failed: timeout");
268     lua_pushnil(L);
269     lua_pushliteral(L, "timeout");
270     return 2;
271
272   case MSG_TRANSFER_FAILURE:
273     XBT_DEBUG("MSG_task_send failed: transfer failure");
274     lua_pushnil(L);
275     lua_pushliteral(L, "transfer failure");
276     return 2;
277
278   case MSG_HOST_FAILURE:
279     XBT_DEBUG("MSG_task_send failed: host failure");
280     lua_pushnil(L);
281     lua_pushliteral(L, "host failure");
282     return 2;
283
284   default:
285     xbt_die("Unexpected result of MSG_task_recv: %d, please report this bug", res);
286   }
287 }
288
289 static const luaL_reg task_functions[] = {
290   {"new", l_task_new},
291   {"get_name", l_task_get_name},
292   {"get_computation_duration", l_task_get_computation_duration},
293   {"execute", l_task_execute},
294   {"send", l_task_send},
295   {"recv", l_task_recv},
296   {NULL, NULL}
297 };
298
299 /**
300  * \brief Finalizes the userdata of a task.
301  * \param L a Lua state
302  * \return number of values returned to Lua
303  *
304  * - Argument 1 (userdata): a C task, possibly NULL if it was sent to another
305  * Lua state
306  */
307 static int l_task_gc(lua_State* L)
308 {
309                                   /* ctask */
310   m_task_t task = *((m_task_t*) luaL_checkudata(L, 1, TASK_MODULE_NAME));
311   /* the task is NULL if I sent it to someone else */
312   if (task != NULL) {
313     MSG_task_destroy(task);
314   }
315   return 0;
316 }
317
318 /**
319  * \brief Returns a string representation of a C task.
320  * \param L a Lua state
321  * \return number of values returned to Lua
322  *
323  * - Argument 1 (userdata): a task
324  * - Return value (string): a string describing this task
325  */
326 static int l_task_tostring(lua_State* L)
327 {
328   m_task_t task = *((m_task_t*) luaL_checkudata(L, 1, TASK_MODULE_NAME));
329   lua_pushfstring(L, "Task: %p", task);
330   return 1;
331 }
332
333 /**
334  * \brief Metamethods of both a task table and the userdata inside it.
335  */
336 static const luaL_reg task_meta[] = {
337   {"__gc", l_task_gc}, /* will be called only for userdata */
338   {"__tostring", l_task_tostring},
339   {NULL, NULL}
340 };
341
342 /* ********************************************************************************* */
343 /*                                simgrid.host API                                   */
344 /* ********************************************************************************* */
345
346 /**
347  * \brief Ensures that a value in the stack is a host and returns it.
348  * \param L a Lua state
349  * \param index an index in the Lua stack
350  * \return the C host corresponding to this Lua host
351  */
352 static m_host_t sglua_checkhost(lua_State * L, int index)
353 {
354   m_host_t *pi, ht;
355   luaL_checktype(L, index, LUA_TTABLE);
356   lua_getfield(L, index, "__simgrid_host");
357   pi = (m_host_t *) luaL_checkudata(L, lua_gettop(L), HOST_MODULE_NAME);
358   if (pi == NULL)
359     luaL_typerror(L, index, HOST_MODULE_NAME);
360   ht = *pi;
361   if (!ht)
362     luaL_error(L, "null Host");
363   lua_pop(L, 1);
364   return ht;
365 }
366
367 /**
368  * \brief Returns a host given its name.
369  * \param L a Lua state
370  * \return number of values returned to Lua
371  *
372  * - Argument 1 (string): name of a host
373  * - Return value (host): the corresponding host
374  */
375 static int l_host_get_by_name(lua_State * L)
376 {
377   const char *name = luaL_checkstring(L, 1);
378   XBT_DEBUG("Getting Host from name...");
379   m_host_t msg_host = MSG_get_host_by_name(name);
380   if (!msg_host) {
381     luaL_error(L, "null Host : MSG_get_host_by_name failed");
382   }
383   lua_newtable(L);              /* create a table, put the userdata on top of it */
384   m_host_t *lua_host = (m_host_t *) lua_newuserdata(L, sizeof(m_host_t));
385   *lua_host = msg_host;
386   luaL_getmetatable(L, HOST_MODULE_NAME);
387   lua_setmetatable(L, -2);
388   lua_setfield(L, -2, "__simgrid_host");        /* put the userdata as field of the table */
389   /* remove the args from the stack */
390   lua_remove(L, 1);
391   return 1;
392 }
393
394 /**
395  * \brief Returns the name of a host.
396  * \param L a Lua state
397  * \return number of values returned to Lua
398  *
399  * - Argument 1 (host): a host
400  * - Return value (string): name of this host
401  */
402 static int l_host_get_name(lua_State * L)
403 {
404   m_host_t ht = sglua_checkhost(L, 1);
405   lua_pushstring(L, MSG_host_get_name(ht));
406   return 1;
407 }
408
409 /**
410  * \brief Returns the number of existing hosts.
411  * \param L a Lua state
412  * \return number of values returned to Lua
413  *
414  * - Return value (number): number of hosts
415  */
416 static int l_host_number(lua_State * L)
417 {
418   lua_pushnumber(L, MSG_get_host_number());
419   return 1;
420 }
421
422 /**
423  * \brief Returns the host given its index.
424  * \param L a Lua state
425  * \return number of values returned to Lua
426  *
427  * - Argument 1 (number): an index (1 is the first)
428  * - Return value (host): the host at this index
429  */
430 static int l_host_at(lua_State * L)
431 {
432   int index = luaL_checkinteger(L, 1);
433   m_host_t host = MSG_get_host_table()[index - 1];      // lua indexing start by 1 (lua[1] <=> C[0])
434   lua_newtable(L);              /* create a table, put the userdata on top of it */
435   m_host_t *lua_host = (m_host_t *) lua_newuserdata(L, sizeof(m_host_t));
436   *lua_host = host;
437   luaL_getmetatable(L, HOST_MODULE_NAME);
438   lua_setmetatable(L, -2);
439   lua_setfield(L, -2, "__simgrid_host");        /* put the userdata as field of the table */
440   return 1;
441 }
442
443 /**
444  * \brief Returns the host where the current process is located.
445  * \param L a Lua state
446  * \return number of values returned to Lua
447  *
448  * - Return value (host): the current host
449  */
450 static int l_host_self(lua_State * L)
451 {
452                                   /* -- */
453   m_host_t host = MSG_host_self();
454   lua_newtable(L);
455                                   /* table */
456   m_host_t* lua_host = (m_host_t*) lua_newuserdata(L, sizeof(m_host_t));
457                                   /* table ud */
458   *lua_host = host;
459   luaL_getmetatable(L, HOST_MODULE_NAME);
460                                   /* table ud mt */
461   lua_setmetatable(L, -2);
462                                   /* table ud */
463   lua_setfield(L, -2, "__simgrid_host");
464                                   /* table */
465   return 1;
466 }
467
468 /**
469  * \brief Returns the value of a host property.
470  * \param L a Lua state
471  * \return number of values returned to Lua
472  *
473  * - Argument 1 (host): a host
474  * - Argument 2 (string): name of the property to get
475  * - Return value (string): the value of this property
476  */
477 static int l_host_get_property_value(lua_State * L)
478 {
479   m_host_t ht = sglua_checkhost(L, 1);
480   const char *prop = luaL_checkstring(L, 2);
481   lua_pushstring(L,MSG_host_get_property_value(ht,prop));
482   return 1;
483 }
484
485 /**
486  * \brief Makes the current process sleep for a while.
487  * \param L a Lua state
488  * \return number of values returned to Lua
489  *
490  * - Argument 1 (number): duration of the sleep
491  */
492 static int l_host_sleep(lua_State *L)
493 {
494   int time = luaL_checknumber(L, 1);
495   MSG_process_sleep(time);
496   return 0;
497 }
498
499 /**
500  * \brief Destroys a host.
501  * \param L a Lua state
502  * \return number of values returned to Lua
503  *
504  * - Argument 1 (host): the host to destroy
505  */
506 static int l_host_destroy(lua_State *L)
507 {
508   m_host_t ht = sglua_checkhost(L, 1);
509   __MSG_host_destroy(ht);
510   return 0;
511 }
512
513 static const luaL_reg host_functions[] = {
514   {"get_by_name", l_host_get_by_name},
515   {"name", l_host_get_name},
516   {"number", l_host_number},
517   {"at", l_host_at},
518   {"self", l_host_self},
519   {"get_prop_value", l_host_get_property_value},
520   {"sleep", l_host_sleep},
521   {"destroy", l_host_destroy},
522   // Bypass XML Methods
523   {"set_function", console_set_function},
524   {"set_property", console_host_set_property},
525   {NULL, NULL}
526 };
527
528 /**
529  * \brief Returns a string representation of a host.
530  * \param L a Lua state
531  * \return number of values returned to Lua
532  *
533  * - Argument 1 (userdata): a host
534  * - Return value (string): a string describing this host
535  */
536 static int l_host_tostring(lua_State * L)
537 {
538   lua_pushfstring(L, "Host :%p", lua_touserdata(L, 1));
539   return 1;
540 }
541
542 static const luaL_reg host_meta[] = {
543   {"__tostring", l_host_tostring},
544   {0, 0}
545 };
546
547 /* ********************************************************************************* */
548 /*                              simgrid.process API                                  */
549 /* ********************************************************************************* */
550
551 /**
552  * \brief Makes the current process sleep for a while.
553  * \param L a Lua state
554  * \return number of values returned to Lua
555  *
556  * - Argument 1 (number): duration of the sleep
557  * - Return value (nil or string): nil in everything went ok, or a string error
558  * if case of failure ("host failure")
559  */
560 static int l_process_sleep(lua_State* L)
561 {
562   double duration = luaL_checknumber(L, 1);
563   MSG_error_t res = MSG_process_sleep(duration);
564
565   switch (res) {
566
567   case MSG_OK:
568     return 0;
569
570   case MSG_HOST_FAILURE:
571     lua_pushliteral(L, "host failure");
572     return 1;
573
574   default:
575     xbt_die("Unexpected result of MSG_process_sleep: %d, please report this bug", res);
576   }
577 }
578
579 static const luaL_reg process_functions[] = {
580     {"sleep", l_process_sleep},
581     /* TODO: self, create, kill, suspend, is_suspended, resume, get_name,
582      * get_pid, get_ppid, migrate
583      */
584     {NULL, NULL}
585 };
586
587 /* ********************************************************************************* */
588 /*                           lua_stub_generator functions                            */
589 /* ********************************************************************************* */
590
591 xbt_dict_t process_function_set;
592 xbt_dynar_t process_list;
593 xbt_dict_t machine_set;
594 static s_process_t process;
595
596 void s_process_free(void *process)
597 {
598   s_process_t *p = (s_process_t *) process;
599   int i;
600   for (i = 0; i < p->argc; i++)
601     free(p->argv[i]);
602   free(p->argv);
603   free(p->host);
604 }
605
606 static int gras_add_process_function(lua_State * L)
607 {
608   const char *arg;
609   const char *process_host = luaL_checkstring(L, 1);
610   const char *process_function = luaL_checkstring(L, 2);
611
612   if (xbt_dict_is_empty(machine_set)
613       || xbt_dict_is_empty(process_function_set)
614       || xbt_dynar_is_empty(process_list)) {
615     process_function_set = xbt_dict_new();
616     process_list = xbt_dynar_new(sizeof(s_process_t), s_process_free);
617     machine_set = xbt_dict_new();
618   }
619
620   xbt_dict_set(machine_set, process_host, NULL, NULL);
621   xbt_dict_set(process_function_set, process_function, NULL, NULL);
622
623   process.argc = 1;
624   process.argv = xbt_new(char *, 1);
625   process.argv[0] = xbt_strdup(process_function);
626   process.host = strdup(process_host);
627
628   lua_pushnil(L);
629   while (lua_next(L, 3) != 0) {
630     arg = lua_tostring(L, -1);
631     process.argc++;
632     process.argv =
633         xbt_realloc(process.argv, (process.argc) * sizeof(char *));
634     process.argv[(process.argc) - 1] = xbt_strdup(arg);
635
636     XBT_DEBUG("index = %f , arg = %s \n", lua_tonumber(L, -2),
637            lua_tostring(L, -1));
638     lua_pop(L, 1);
639   }
640   lua_pop(L, 1);
641   //add to the process list
642   xbt_dynar_push(process_list, &process);
643   return 0;
644 }
645
646 static int gras_generate(lua_State * L)
647 {
648   const char *project_name = luaL_checkstring(L, 1);
649   generate_sim(project_name);
650   generate_rl(project_name);
651   generate_makefile_local(project_name);
652   return 0;
653 }
654
655 /* ********************************************************************************* */
656 /*                               simgrid.platf API                                   */
657 /* ********************************************************************************* */
658
659 static const luaL_reg platf_functions[] = {
660     {"open", console_open},
661     {"close", console_close},
662     {"AS_open", console_AS_open},
663     {"AS_close", console_AS_close},
664     {"host_new", console_add_host},
665     {"link_new", console_add_link},
666     {"router_new", console_add_router},
667     {"route_new", console_add_route},
668     {NULL, NULL}
669 };
670
671 /* ********************************************************************************* */
672 /*                                  simgrid API                                      */
673 /* ********************************************************************************* */
674
675 /**
676  * \brief Deploys your application.
677  * \param L a Lua state
678  * \return number of values returned to Lua
679  *
680  * - Argument 1 (string): name of the deployment file to load
681  */
682 static int launch_application(lua_State* L) {
683
684   const char* file = luaL_checkstring(L, 1);
685   MSG_function_register_default(run_lua_code);
686   MSG_launch_application(file);
687   return 0;
688 }
689
690 /**
691  * \brief Creates the platform.
692  * \param L a Lua state
693  * \return number of values returned to Lua
694  *
695  * - Argument 1 (string): name of the platform file to load
696  */
697 static int create_environment(lua_State* L) {
698
699   const char* file = luaL_checkstring(L, 1);
700   XBT_DEBUG("Loading environment file %s", file);
701   MSG_create_environment(file);
702   return 0;
703 }
704
705 /**
706  * \brief Prints a log string with debug level.
707  * \param L a Lua state
708  * \return number of values returned to Lua
709  *
710  * - Argument 1 (string): the text to print
711  */
712 static int debug(lua_State* L) {
713
714   const char* str = luaL_checkstring(L, 1);
715   XBT_DEBUG("%s", str);
716   return 0;
717 }
718
719 /**
720  * \brief Prints a log string with info level.
721  * \param L a Lua state
722  * \return number of values returned to Lua
723  *
724  * - Argument 1 (string): the text to print
725  */
726 static int info(lua_State* L) {
727
728   const char* str = luaL_checkstring(L, 1);
729   XBT_INFO("%s", str);
730   return 0;
731 }
732
733 /**
734  * \brief Runs your application.
735  * \param L a Lua state
736  * \return number of values returned to Lua
737  */
738 static int run(lua_State*  L) {
739
740   MSG_main();
741   return 0;
742 }
743
744 /**
745  * \brief Returns the current simulated time.
746  * \param L a Lua state
747  * \return number of values returned to Lua
748  *
749  * - Return value (number): the simulated time
750  */
751 static int get_clock(lua_State* L) {
752
753   lua_pushnumber(L, MSG_get_clock());
754   return 1;
755 }
756
757 /**
758  * \brief Cleans the simulation.
759  * \param L a Lua state
760  * \return number of values returned to Lua
761  */
762 static int simgrid_gc(lua_State * L)
763 {
764   MSG_clean();
765   return 0;
766 }
767
768 /*
769  * Register platform for MSG
770  */
771 static int msg_register_platform(lua_State * L)
772 {
773   /* Tell Simgrid we dont wanna use its parser */
774   //surf_parse = console_parse_platform;
775   surf_parse_reset_callbacks();
776   MSG_create_environment(NULL);
777   return 0;
778 }
779
780 /*
781  * Register platform for Simdag
782  */
783
784 static int sd_register_platform(lua_State * L)
785 {
786   //surf_parse = console_parse_platform_wsL07;
787   surf_parse_reset_callbacks();
788   SD_create_environment(NULL);
789   return 0;
790 }
791
792 /*
793  * Register platform for gras
794  */
795 static int gras_register_platform(lua_State * L)
796 {
797   //surf_parse = console_parse_platform;
798   surf_parse_reset_callbacks();
799   gras_create_environment(NULL);
800   return 0;
801 }
802
803 /**
804  * Register applicaiton for MSG
805  */
806 static int msg_register_application(lua_State * L)
807 {
808   MSG_function_register_default(run_lua_code);
809   //surf_parse = console_parse_application;
810   MSG_launch_application(NULL);
811   return 0;
812 }
813
814 /*
815  * Register application for gras
816  */
817 static int gras_register_application(lua_State * L)
818 {
819   gras_function_register_default(run_lua_code);
820   //surf_parse = console_parse_application;
821   gras_launch_application(NULL);
822   return 0;
823 }
824
825 static const luaL_Reg simgrid_functions[] = {
826   {"create_environment", create_environment},
827   {"launch_application", launch_application},
828   {"debug", debug},
829   {"info", info},
830   {"run", run},
831   {"get_clock", get_clock},
832   /* short names */
833   {"platform", create_environment},
834   {"application", launch_application},
835   /* methods to bypass XML parser */
836   {"msg_register_platform", msg_register_platform},
837   {"sd_register_platform", sd_register_platform},
838   {"msg_register_application", msg_register_application},
839   {"gras_register_platform", gras_register_platform},
840   {"gras_register_application", gras_register_application},
841   /* gras sub generator method */
842   {"gras_set_process_function", gras_add_process_function},
843   {"gras_generate", gras_generate},
844   {NULL, NULL}
845 };
846
847 /* ********************************************************************************* */
848 /*                           module management functions                             */
849 /* ********************************************************************************* */
850
851 #define LUA_MAX_ARGS_COUNT 10   /* maximum amount of arguments we can get from lua on command line */
852
853 /**
854  * \brief Opens the simgrid Lua module.
855  *
856  * This function is called automatically by the Lua interpreter when some
857  * Lua code requires the "simgrid" module.
858  *
859  * \param L the Lua state
860  */
861 int luaopen_simgrid(lua_State *L)
862 {
863   XBT_DEBUG("luaopen_simgrid *****");
864
865   /* Get the command line arguments from the lua interpreter */
866   char **argv = malloc(sizeof(char *) * LUA_MAX_ARGS_COUNT);
867   int argc = 1;
868   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? */
869
870   lua_getglobal(L, "arg");
871   /* if arg is a null value, it means we use lua only as a script to init platform
872    * else it should be a table and then take arg in consideration
873    */
874   if (lua_istable(L, -1)) {
875     int done = 0;
876     while (!done) {
877       argc++;
878       lua_pushinteger(L, argc - 2);
879       lua_gettable(L, -2);
880       if (lua_isnil(L, -1)) {
881         done = 1;
882       } else {
883         xbt_assert(lua_isstring(L, -1),
884                     "argv[%d] got from lua is no string", argc - 1);
885         xbt_assert(argc < LUA_MAX_ARGS_COUNT,
886                     "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",
887                     __FILE__, LUA_MAX_ARGS_COUNT - 1);
888         argv[argc - 1] = (char *) luaL_checkstring(L, -1);
889         lua_pop(L, 1);
890         XBT_DEBUG("Got command line argument %s from lua", argv[argc - 1]);
891       }
892     }
893     argv[argc--] = NULL;
894
895     /* Initialize the MSG core */
896     MSG_global_init(&argc, argv);
897     XBT_DEBUG("Still %d arguments on command line", argc); // FIXME: update the lua's arg table to reflect the changes from SimGrid
898   }
899
900   /* Keep the context mechanism informed of our lua world today */
901   sglua_maestro_state = L;
902
903   /* initialize access to my tables by children Lua states */
904   lua_newtable(L);
905   lua_setfield(L, LUA_REGISTRYINDEX, "simgrid.maestro_tables");
906
907   register_c_functions(L);
908
909   return 1;
910 }
911
912 /**
913  * \brief Returns whether a Lua state is the maestro state.
914  * \param L a Lua state
915  * \return true if this is maestro
916  */
917 int sglua_is_maestro(lua_State* L) {
918   return L == sglua_maestro_state;
919 }
920
921 /**
922  * \brief Returns the maestro state.
923  * \return the maestro Lua state
924  */
925 lua_State* sglua_get_maestro(void) {
926   return sglua_maestro_state;
927 }
928
929 /**
930  * \brief Registers the task functions into the table simgrid.task.
931  *
932  * Also initialize the metatable of the task userdata type.
933  *
934  * \param L a lua state
935  */
936 static void register_task_functions(lua_State* L)
937 {
938   /* create a table simgrid.task and fill it with task functions */
939   luaL_openlib(L, TASK_MODULE_NAME, task_functions, 0);
940                                   /* simgrid.task */
941
942   /* create the metatable for tasks, add it to the Lua registry */
943   luaL_newmetatable(L, TASK_MODULE_NAME);
944                                   /* simgrid.task mt */
945   /* fill the metatable */
946   luaL_openlib(L, NULL, task_meta, 0);
947                                   /* simgrid.task mt */
948   lua_pushvalue(L, -2);
949                                   /* simgrid.task mt simgrid.task */
950   /* metatable.__index = simgrid.task
951    * we put the task functions inside the task itself:
952    * this allows to write task:method(args) for
953    * simgrid.task.method(task, args) */
954   lua_setfield(L, -2, "__index");
955                                   /* simgrid.task mt */
956   lua_pop(L, 2);
957                                   /* -- */
958 }
959
960 /**
961  * \brief Registers the host functions into the table simgrid.host.
962  *
963  * Also initialize the metatable of the host userdata type.
964  *
965  * \param L a lua state
966  */
967 static void register_host_functions(lua_State* L)
968 {
969   /* create a table simgrid.host and fill it with host functions */
970   luaL_openlib(L, HOST_MODULE_NAME, host_functions, 0);
971                                   /* simgrid.host */
972
973   /* create the metatable for host, add it to the Lua registry */
974   luaL_newmetatable(L, HOST_MODULE_NAME);
975                                   /* simgrid.host mt */
976   /* fill the metatable */
977   luaL_openlib(L, NULL, host_meta, 0);
978                                   /* simgrid.host mt */
979   lua_pushvalue(L, -2);
980                                   /* simgrid.host mt simgrid.host */
981   /* metatable.__index = simgrid.host
982    * we put the host functions inside the host userdata itself:
983    * this allows to write host(args) for
984    * simgrid.host.method(host, args) */
985   // FIXME: cannot work currently, same problem as tasks
986   lua_setfield(L, -2, "__index");
987                                   /* simgrid.host mt */
988   lua_pop(L, 2);
989                                   /* -- */
990 }
991
992 /**
993  * \brief Registers the process functions into the table simgrid.process.
994  * \param L a lua state
995  */
996 static void register_process_functions(lua_State* L)
997 {
998   luaL_openlib(L, PROCESS_MODULE_NAME, process_functions, 0);
999                                   /* simgrid.process */
1000   lua_pop(L, 1);
1001 }
1002
1003 /**
1004  * \brief Registers the platform functions into the table simgrid.platf.
1005  * \param L a lua state
1006  */
1007 static void register_platf_functions(lua_State* L)
1008 {
1009   luaL_openlib(L, PLATF_MODULE_NAME, platf_functions, 0);
1010                                   /* simgrid.platf */
1011   lua_pop(L, 1);
1012 }
1013
1014 /**
1015  * \brief Makes the core functions available to the Lua world.
1016  * \param L a Lua world
1017  */
1018 static void register_core_functions(lua_State *L)
1019 {
1020   /* register the core C functions to lua */
1021   luaL_register(L, "simgrid", simgrid_functions);
1022                                   /* simgrid */
1023
1024   /* set a finalizer that cleans simgrid, by adding to the simgrid module a
1025    * dummy userdata whose __gc metamethod calls MSG_clean() */
1026   lua_newuserdata(L, sizeof(void*));
1027                                   /* simgrid udata */
1028   lua_newtable(L);
1029                                   /* simgrid udata mt */
1030   lua_pushcfunction(L, simgrid_gc);
1031                                   /* simgrid udata mt simgrid_gc */
1032   lua_setfield(L, -2, "__gc");
1033                                   /* simgrid udata mt */
1034   lua_setmetatable(L, -2);
1035                                   /* simgrid udata */
1036   lua_setfield(L, -2, "__simgrid_loaded");
1037                                   /* simgrid */
1038   lua_pop(L, 1);
1039                                   /* -- */
1040 }
1041
1042 /**
1043  * \brief Creates the simgrid module and make it available to Lua.
1044  * \param L a Lua world
1045  */
1046 static void register_c_functions(lua_State *L)
1047 {
1048   register_core_functions(L);
1049   register_task_functions(L);
1050   register_host_functions(L);
1051   register_process_functions(L);
1052   register_platf_functions(L);
1053 }
1054
1055 /**
1056  * \brief Runs a Lua function as a new simulated process.
1057  * \param argc number of arguments of the function
1058  * \param argv name of the Lua function and array of its arguments
1059  * \return result of the function
1060  */
1061 static int run_lua_code(int argc, char **argv)
1062 {
1063   XBT_DEBUG("Run lua code %s", argv[0]);
1064
1065   /* create a new state, getting globals from maestro */
1066   lua_State *L = sglua_clone_maestro();
1067   int res = 1;
1068
1069   /* start the function */
1070   lua_getglobal(L, argv[0]);
1071   xbt_assert(lua_isfunction(L, -1),
1072               "There is no Lua function with name `%s'", argv[0]);
1073
1074   /* push arguments onto the stack */
1075   int i;
1076   for (i = 1; i < argc; i++)
1077     lua_pushstring(L, argv[i]);
1078
1079   /* call the function */
1080   _XBT_GNUC_UNUSED int err;
1081   err = lua_pcall(L, argc - 1, 1, 0);
1082   xbt_assert(err == 0, "Error running function `%s': %s", argv[0],
1083               lua_tostring(L, -1));
1084
1085   /* retrieve result */
1086   if (lua_isnumber(L, -1)) {
1087     res = lua_tonumber(L, -1);
1088     lua_pop(L, 1);              /* pop returned value */
1089   }
1090
1091   XBT_DEBUG("Execution of Lua code %s is over", (argv ? argv[0] : "(null)"));
1092
1093   return res;
1094 }