1 /* SimGrid Lua bindings */
3 /* Copyright (c) 2010. The SimGrid Team.
4 * All rights reserved. */
6 /* This program is free software; you can redistribute it and/or modify it
7 * under the terms of the license (GNU LGPL) which comes with this package. */
15 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(lua,bindings,"Lua Bindings");
17 #define TASK_MODULE_NAME "simgrid.Task"
18 #define HOST_MODULE_NAME "simgrid.Host"
19 // Surf ( bypass XML )
20 #define LINK_MODULE_NAME "simgrid.Link"
21 #define ROUTE_MODULE_NAME "simgrid.Route"
23 /* ********************************************************************************* */
24 /* helper functions */
25 /* ********************************************************************************* */
27 static void stackDump (const char *msg, lua_State *L) {
31 int top = lua_gettop(L);
34 p+=sprintf(p,"STACK(top=%d): ",top);
36 for (i = 1; i <= top; i++) { /* repeat for each level */
37 int t = lua_type(L, i);
40 case LUA_TSTRING: /* strings */
41 p+=sprintf(p,"`%s'", lua_tostring(L, i));
44 case LUA_TBOOLEAN: /* booleans */
45 p+=sprintf(p,lua_toboolean(L, i) ? "true" : "false");
48 case LUA_TNUMBER: /* numbers */
49 p+=sprintf(p,"%g", lua_tonumber(L, i));
53 p+=sprintf(p, "Table");
56 default: /* other values */
58 /* if ((ptr = luaL_checkudata(L,i,TASK_MODULE_NAME))) {
61 p+=printf(p,"%s", lua_typename(L, t));
66 p+=sprintf(p," "); /* put a separator */
68 INFO2("%s%s",msg,buff);
71 /** @brief ensures that a userdata on the stack is a task and returns the pointer inside the userdata */
72 static m_task_t checkTask (lua_State *L,int index) {
74 luaL_checktype(L,index,LUA_TTABLE);
75 lua_getfield(L,index,"__simgrid_task");
76 pi = (m_task_t*)luaL_checkudata(L,-1,TASK_MODULE_NAME);
78 luaL_typerror(L,index,TASK_MODULE_NAME);
81 luaL_error(L,"null Task");
86 /* ********************************************************************************* */
87 /* wrapper functions */
88 /* ********************************************************************************* */
91 * A task is either something to compute somewhere, or something to exchange between two hosts (or both).
92 * It is defined by a computing amount and a message size.
100 * Construct an new task with the specified processing amount and amount
103 * @param name Task's name
105 * @param computeDuration A value of the processing amount (in flop) needed to process the task.
106 * If 0, then it cannot be executed with the execute() method.
107 * This value has to be >= 0.
109 * @param messageSize A value of amount of data (in bytes) needed to transfert this task.
110 * If 0, then it cannot be transfered with the get() and put() methods.
111 * This value has to be >= 0.
113 static int Task_new(lua_State* L) {
114 const char *name=luaL_checkstring(L,1);
115 int comp_size = luaL_checkint(L,2);
116 int msg_size = luaL_checkint(L,3);
117 INFO0("Creating task");
118 m_task_t msg_task = MSG_task_create(name,comp_size,msg_size,NULL);
119 lua_newtable (L); /* create a table, put the userdata on top of it */
120 m_task_t *lua_task = (m_task_t*)lua_newuserdata(L,sizeof(m_task_t));
121 *lua_task = msg_task;
122 luaL_getmetatable(L,TASK_MODULE_NAME);
123 lua_setmetatable(L,-2);
124 lua_setfield (L, -2, "__simgrid_task"); /* put the userdata as field of the table */
125 /* remove the args from the stack */
132 static int Task_get_name(lua_State *L) {
133 m_task_t tk = checkTask(L,-1);
134 lua_pushstring(L,MSG_task_get_name(tk));
138 static int Task_computation_duration(lua_State *L){
139 m_task_t tk = checkTask(L,-1);
140 lua_pushnumber(L,MSG_task_get_compute_duration (tk));
144 static int Task_execute(lua_State *L){
145 m_task_t tk = checkTask(L,-1);
146 int res = MSG_task_execute(tk);
147 lua_pushnumber(L,res);
151 static int Task_destroy(lua_State *L) {
152 m_task_t tk = checkTask(L,-1);
153 int res = MSG_task_destroy(tk);
154 lua_pushnumber(L,res);
158 static int Task_send(lua_State *L) {
159 //stackDump("send ",L);
160 m_task_t tk = checkTask(L,-2);
161 const char *mailbox = luaL_checkstring(L,-1);
162 lua_pop(L,1); // remove the string so that the task is on top of it
163 MSG_task_set_data(tk,L); // Copy my stack into the task, so that the receiver can copy the lua task directly
164 MSG_error_t res = MSG_task_send(tk,mailbox);
165 while (MSG_task_get_data(tk)!=NULL) // Don't mess up with my stack: the receiver didn't copy the data yet
166 MSG_process_sleep(0); // yield
168 if (res != MSG_OK) switch(res) {
170 ERROR0("MSG_task_send failed : Timeout");
172 case MSG_TRANSFER_FAILURE :
173 ERROR0("MSG_task_send failed : Transfer Failure");
175 case MSG_HOST_FAILURE :
176 ERROR0("MSG_task_send failed : Host Failure ");
179 ERROR0("MSG_task_send failed : Unexpected error , please report this bug");
185 static int Task_recv(lua_State *L) {
187 const char *mailbox = luaL_checkstring(L,-1);
188 MSG_error_t res = MSG_task_receive(&tk,mailbox);
190 lua_State *sender_stack = MSG_task_get_data(tk);
191 lua_xmove(sender_stack,L,1); // copy the data directly from sender's stack
192 MSG_task_set_data(tk,NULL);
194 if(res != MSG_OK) switch(res){
196 ERROR0("MSG_task_receive failed : Timeout");
198 case MSG_TRANSFER_FAILURE :
199 ERROR0("MSG_task_receive failed : Transfer Failure");
201 case MSG_HOST_FAILURE :
202 ERROR0("MSG_task_receive failed : Host Failure ");
205 ERROR0("MSG_task_receive failed : Unexpected error , please report this bug");
212 static const luaL_reg Task_methods[] = {
214 {"name", Task_get_name},
215 {"computation_duration", Task_computation_duration},
216 {"execute", Task_execute},
217 {"destroy", Task_destroy},
222 static int Task_gc(lua_State *L) {
223 m_task_t tk=checkTask(L,-1);
224 if (tk) MSG_task_destroy(tk);
228 static int Task_tostring(lua_State *L) {
229 lua_pushfstring(L, "Task :%p",lua_touserdata(L,1));
233 static const luaL_reg Task_meta[] = {
235 {"__tostring", Task_tostring},
242 static m_host_t checkHost (lua_State *L,int index) {
244 luaL_checktype(L,index,LUA_TTABLE);
245 lua_getfield(L,index,"__simgrid_host");
246 pi = (m_host_t*)luaL_checkudata(L,-1,HOST_MODULE_NAME);
248 luaL_typerror(L,index,HOST_MODULE_NAME);
251 luaL_error(L,"null Host");
256 static int Host_get_by_name(lua_State *L)
258 const char *name=luaL_checkstring(L,1);
259 DEBUG0("Getting Host from name...");
260 m_host_t msg_host = MSG_get_host_by_name(name);
263 luaL_error(L,"null Host : MSG_get_host_by_name failled");
265 lua_newtable (L); /* create a table, put the userdata on top of it */
266 m_host_t *lua_host = (m_host_t*)lua_newuserdata(L,sizeof(m_host_t));
267 *lua_host = msg_host;
268 luaL_getmetatable(L,HOST_MODULE_NAME);
269 lua_setmetatable(L,-2);
270 lua_setfield (L, -2, "__simgrid_host"); /* put the userdata as field of the table */
271 /* remove the args from the stack */
277 static int Host_get_name(lua_State *L) {
278 m_host_t ht = checkHost(L,-1);
279 lua_pushstring(L,MSG_host_get_name(ht));
283 static int Host_number(lua_State *L) {
284 lua_pushnumber(L,MSG_get_host_number());
288 static int Host_at(lua_State *L)
290 int index = luaL_checkinteger(L,1);
291 m_host_t host = MSG_get_host_table()[index-1]; // lua indexing start by 1 (lua[1] <=> C[0])
292 lua_newtable (L); /* create a table, put the userdata on top of it */
293 m_host_t *lua_host = (m_host_t*)lua_newuserdata(L,sizeof(m_host_t));
295 luaL_getmetatable(L,HOST_MODULE_NAME);
296 lua_setmetatable(L,-2);
297 lua_setfield (L, -2, "__simgrid_host"); /* put the userdata as field of the table */
302 /*****************************************************************************************
303 * BYPASS XML SURF Methods *
304 ***************************
305 ***************************
306 ******************************************************************************************/
307 #include "surf/surfxml_parse.h" /* to override surf_parse and bypass the parser */
308 typedef struct t_host_attr
313 //deployment attribute
314 const char* function;
316 const char ** args_list;
317 }host_attr,*p_host_attr;
319 typedef struct t_link_attr
324 }link_attr,*p_link_attr;
326 typedef struct t_route_attr
331 const char **links_id;
333 }route_attr,*p_route_attr;
336 static int host_index = 0;
337 static int link_index = 0;
338 static int route_index = 0;
340 //using xbt_dynar_t :
341 static xbt_dynar_t host_list_d ;
342 static xbt_dynar_t link_list_d ;
343 static xbt_dynar_t route_list_d ;
346 static int Host_new(lua_State *L) //(id,power)
348 // if it's the first time ,instanciate the dynar
349 if(xbt_dynar_is_empty(host_list_d))
350 host_list_d = xbt_dynar_new(sizeof(p_host_attr), &xbt_free_ref);
353 p_host_attr host = malloc(sizeof(host_attr));
354 host->id = luaL_checkstring(L,1);
355 host->power = luaL_checknumber(L,2);
356 host->function = NULL;
357 xbt_dynar_push(host_list_d, &host);
362 static int Link_new(lua_State *L) // (id,bandwidth,latency)
364 if(xbt_dynar_is_empty(link_list_d))
365 link_list_d = xbt_dynar_new(sizeof(p_link_attr), &xbt_free_ref);
367 p_link_attr link = malloc(sizeof(link_attr));
368 link->id = luaL_checkstring(L,1);
369 link->bandwidth = luaL_checknumber(L,2);
370 link->latency = luaL_checknumber(L,3);
371 xbt_dynar_push(link_list_d,&link);
376 static int Route_new(lua_State *L) // (src_id,dest_id,links_number,link_table)
378 if(xbt_dynar_is_empty(route_list_d))
379 route_list_d = xbt_dynar_new(sizeof(p_route_attr), &xbt_free_ref);
382 p_route_attr route = malloc(sizeof(route_attr));
383 route->src_id = luaL_checkstring(L,1);
384 route->dest_id = luaL_checkstring(L,2);
385 route->links_nb = luaL_checkint(L,3);
386 route->links_id = malloc(sizeof(char*)*route->links_nb);
388 while (lua_next(L,4) != 0) {
389 if(i >= route->links_nb)
390 ERROR1("Number of links should be less than %d",route->links_nb+1);
391 route->links_id[i] = lua_tostring(L, -1);
392 DEBUG2("index = %f , Link_id = %s \n",lua_tonumber(L, -2),lua_tostring(L, -1));
398 //add route to platform's route list
399 xbt_dynar_push(route_list_d,&route);
404 static int Host_set_function(lua_State *L) //(host,function,nb_args,list_args)
406 // look for the index of host in host_list
407 const char *host_id = luaL_checkstring(L,1);
411 xbt_dynar_foreach(host_list_d,i,p_host)
413 if(p_host->id == host_id)
415 p_host->function = luaL_checkstring(L,2);
416 p_host->args_nb = luaL_checkint(L,3);
417 p_host->args_list = malloc(sizeof(char*)*p_host->args_nb);
418 // fill the args list
421 while (lua_next(L,4) != 0) {
422 if(j >= p_host->args_nb)
423 ERROR1("Number of args should be less than %d",p_host->args_nb+1);
424 p_host->args_list[j] = lua_tostring(L, -1);
425 DEBUG2("index = %f , Arg_id = %s \n",lua_tonumber(L, -2),lua_tostring(L, -1));
433 ERROR1("Host : %s Not Fount !!",host_id);
440 * surf parse bypass platform
442 static int surf_parse_bypass_platform()
449 p_route_attr p_route;
451 static int AX_ptr = 0;
452 static int surfxml_bufferstack_size = 2048;
454 /* FIXME allocating memory for the buffer, I think 2kB should be enough */
455 surfxml_bufferstack = xbt_new0(char, surfxml_bufferstack_size);
457 SURFXML_BUFFER_SET(platform_version, "2");
458 SURFXML_START_TAG(platform);
462 //for(i=0;i<host_index;i++)
463 xbt_dynar_foreach(host_list_d,i,p_host)
465 //SURFXML_BUFFER_SET(host_id,host_list[i]->id);
466 SURFXML_BUFFER_SET(host_id,p_host->id);
467 //sprintf(buffer, "%f", host_list[i]->power);
468 sprintf(buffer,"%f",p_host->power);
469 SURFXML_BUFFER_SET(host_power,buffer);
470 SURFXML_BUFFER_SET(host_availability, "1.0");
471 SURFXML_BUFFER_SET(host_availability_file, "");
472 A_surfxml_host_state = A_surfxml_host_state_ON;
473 SURFXML_BUFFER_SET(host_state_file, "");
474 SURFXML_BUFFER_SET(host_interference_send, "1.0");
475 SURFXML_BUFFER_SET(host_interference_recv, "1.0");
476 SURFXML_BUFFER_SET(host_interference_send_recv, "1.0");
477 SURFXML_BUFFER_SET(host_max_outgoing_rate, "-1.0");
478 SURFXML_START_TAG(host);
479 SURFXML_END_TAG(host);
483 //for (i = 0;i<link_index;i++)
484 xbt_dynar_foreach(link_list_d,i,p_link)
486 //SURFXML_BUFFER_SET(link_id,link_list[i]->id);
487 SURFXML_BUFFER_SET(link_id,p_link->id);
488 //sprintf(buffer,"%f",link_list[i]->bandwidth);
489 sprintf(buffer,"%f",p_link->bandwidth);
490 SURFXML_BUFFER_SET(link_bandwidth,buffer);
491 SURFXML_BUFFER_SET(link_bandwidth_file, "");
492 //sprintf(buffer,"%f",link_list[i]->latency);
493 sprintf(buffer,"%f",p_link->latency);
494 SURFXML_BUFFER_SET(link_latency,buffer);
495 SURFXML_BUFFER_SET(link_latency_file, "");
496 A_surfxml_link_state = A_surfxml_link_state_ON;
497 SURFXML_BUFFER_SET(link_state_file, "");
498 A_surfxml_link_sharing_policy = A_surfxml_link_sharing_policy_SHARED;
499 SURFXML_START_TAG(link);
500 SURFXML_END_TAG(link);
505 //for (i = 0;i<route_index;i++)
506 xbt_dynar_foreach(route_list_d,i,p_route)
508 //SURFXML_BUFFER_SET(route_src,route_list[i]->src_id);
509 SURFXML_BUFFER_SET(route_src,p_route->src_id);
510 //SURFXML_BUFFER_SET(route_dst,route_list[i]->dest_id);
511 SURFXML_BUFFER_SET(route_dst,p_route->dest_id);
512 SURFXML_BUFFER_SET(route_impact_on_src, "0.0");
513 SURFXML_BUFFER_SET(route_impact_on_dst, "0.0");
514 SURFXML_BUFFER_SET(route_impact_on_src_with_other_recv, "0.0");
515 SURFXML_BUFFER_SET(route_impact_on_dst_with_other_send, "0.0");
516 SURFXML_START_TAG(route);
519 //for(j=0; j < route_list[i]->links_nb;j++)
520 for(j=0;j< p_route->links_nb;j++)
522 //SURFXML_BUFFER_SET(link_c_ctn_id,route_list[i]->links_id[j]);
523 SURFXML_BUFFER_SET(link_c_ctn_id,p_route->links_id[j]);
524 SURFXML_START_TAG(link_c_ctn);
525 SURFXML_END_TAG(link_c_ctn);
528 SURFXML_END_TAG(route);
532 SURFXML_END_TAG(platform);
533 free(surfxml_bufferstack);
534 return 0; // must return 0 ?!!
539 * surf parse bypass application
541 static int surf_parse_bypass_application()
549 static int surfxml_bufferstack_size = 2048;
550 /* FIXME ( should be manual )allocating memory to the buffer, I think 2MB should be enough */
551 surfxml_bufferstack = xbt_new0(char, surfxml_bufferstack_size);
554 SURFXML_BUFFER_SET(platform_version, "2");
556 SURFXML_START_TAG(platform);
558 //for(i=0 ; i< host_index ;i++)
559 xbt_dynar_foreach(host_list_d,i,p_host)
563 SURFXML_BUFFER_SET(process_host, p_host->id);
564 SURFXML_BUFFER_SET(process_function, p_host->function);
565 SURFXML_BUFFER_SET(process_start_time, "-1.0");
566 SURFXML_BUFFER_SET(process_kill_time, "-1.0");
567 SURFXML_START_TAG(process);
571 for(j=0 ;j<p_host->args_nb;j++)
573 SURFXML_BUFFER_SET(argument_value,p_host->args_list[j]);
574 SURFXML_START_TAG(argument);
575 SURFXML_END_TAG(argument);
577 SURFXML_END_TAG(process);
582 SURFXML_END_TAG(platform);
583 free(surfxml_bufferstack);
587 //***********Register Methods *******************************************//
591 static const luaL_reg Host_methods[] = {
592 {"getByName", Host_get_by_name},
593 {"name", Host_get_name},
594 {"number", Host_number},
596 // Bypass XML Methods
598 {"setFunction", Host_set_function},
602 static int Host_gc(lua_State *L)
604 m_host_t ht = checkHost(L,-1);
609 static int Host_tostring(lua_State *L)
611 lua_pushfstring(L,"Host :%p",lua_touserdata(L,1));
615 static const luaL_reg Host_meta[] = {
617 {"__tostring", Host_tostring},
624 static const luaL_reg Link_methods[] = {
631 static const luaL_reg Route_methods[] ={
636 * Environment related
639 extern lua_State *simgrid_lua_state;
641 static int run_lua_code(int argc,char **argv) {
642 DEBUG1("Run lua code %s",argv[0]);
643 lua_State *L = lua_newthread(simgrid_lua_state);
644 int ref = luaL_ref(simgrid_lua_state, LUA_REGISTRYINDEX); // protect the thread from being garbage collected
647 /* Start the co-routine */
648 lua_getglobal(L,argv[0]);
649 xbt_assert1(lua_isfunction(L,-1),
650 "The lua function %s does not seem to exist",argv[0]);
652 // push arguments onto the stack
655 lua_pushstring(L,argv[i]);
657 // Call the function (in resume)
658 xbt_assert2(lua_pcall(L, argc-1, 1, 0) == 0,
659 "error running function `%s': %s",argv[0], lua_tostring(L, -1));
661 /* retrieve result */
662 if (lua_isnumber(L, -1)) {
663 res = lua_tonumber(L, -1);
664 lua_pop(L, 1); /* pop returned value */
668 luaL_unref(simgrid_lua_state,LUA_REGISTRYINDEX,ref );
669 DEBUG1("Execution of lua code %s is over", (argv ? argv[0] : "(null)"));
672 static int launch_application(lua_State *L) {
673 const char * file = luaL_checkstring(L,1);
674 MSG_function_register_default(run_lua_code);
675 MSG_launch_application(file);
678 #include "simix/simix.h" //FIXME: KILLME when debugging on simix internals become useless
679 static int create_environment(lua_State *L) {
680 const char *file = luaL_checkstring(L,1);
681 DEBUG1("Loading environment file %s",file);
682 MSG_create_environment(file);
683 smx_host_t *hosts = SIMIX_host_get_table();
685 for (i=0;i<SIMIX_host_get_number();i++) {
686 DEBUG1("We have an host %s", SIMIX_host_get_name(hosts[i]));
692 static int debug(lua_State *L) {
693 const char *str = luaL_checkstring(L,1);
697 static int info(lua_State *L) {
698 const char *str = luaL_checkstring(L,1);
702 static int run(lua_State *L) {
706 static int clean(lua_State *L) {
714 static int register_platform(lua_State *L)
716 /* Tell Simgrid we dont wanna use its parser*/
717 surf_parse = surf_parse_bypass_platform;
718 MSG_create_environment(NULL);
722 static int register_application(lua_State *L)
724 MSG_function_register_default(run_lua_code);
725 surf_parse = surf_parse_bypass_application;
726 MSG_launch_application(NULL);
730 static const luaL_Reg simgrid_funcs[] = {
731 { "create_environment", create_environment},
732 { "launch_application", launch_application},
738 { "platform", create_environment},
739 { "application", launch_application},
740 /* methods to bypass XML parser*/
741 { "register_platform",register_platform},
742 { "register_application",register_application},
746 /* ********************************************************************************* */
747 /* module management functions */
748 /* ********************************************************************************* */
750 extern const char*xbt_ctx_factory_to_use; /*Hack: let msg load directly the right factory */
752 #define LUA_MAX_ARGS_COUNT 10 /* maximum amount of arguments we can get from lua on command line */
754 int luaopen_simgrid(lua_State* L); // Fuck gcc: we don't need that prototype
755 int luaopen_simgrid(lua_State* L) {
756 //xbt_ctx_factory_to_use = "lua";
758 char **argv=malloc(sizeof(char*)*LUA_MAX_ARGS_COUNT);
760 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? */
761 /* Get the command line arguments from the lua interpreter */
762 lua_getglobal(L,"arg");
763 xbt_assert1(lua_istable(L,-1),"arg parameter is not a table but a %s",lua_typename(L,-1));
767 lua_pushinteger(L,argc-2);
769 if (lua_isnil(L,-1)) {
772 xbt_assert1(lua_isstring(L,-1),"argv[%d] got from lua is no string",argc-1);
773 xbt_assert2(argc<LUA_MAX_ARGS_COUNT,
774 "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",
775 __FILE__,LUA_MAX_ARGS_COUNT-1);
776 argv[argc-1] = (char*)luaL_checkstring(L,-1);
778 DEBUG1("Got command line argument %s from lua",argv[argc-1]);
783 /* Initialize the MSG core */
784 MSG_global_init(&argc,argv);
785 DEBUG1("Still %d arguments on command line",argc); // FIXME: update the lua's arg table to reflect the changes from SimGrid
787 /* register the core C functions to lua */
788 luaL_register(L, "simgrid", simgrid_funcs);
789 /* register the task methods to lua */
790 luaL_openlib(L,TASK_MODULE_NAME,Task_methods,0); //create methods table,add it to the globals
791 luaL_newmetatable(L,TASK_MODULE_NAME); //create metatable for Task,add it to the Lua registry
792 luaL_openlib(L,0,Task_meta,0);// fill metatable
793 lua_pushliteral(L,"__index");
794 lua_pushvalue(L,-3); //dup methods table
795 lua_rawset(L,-3); //matatable.__index = methods
796 lua_pushliteral(L,"__metatable");
797 lua_pushvalue(L,-3); //dup methods table
798 lua_rawset(L,-3); //hide metatable:metatable.__metatable = methods
799 lua_pop(L,1); //drop metatable
801 /* register the hosts methods to lua*/
802 luaL_openlib(L,HOST_MODULE_NAME,Host_methods,0);
803 luaL_newmetatable(L,HOST_MODULE_NAME);
804 luaL_openlib(L,0,Host_meta,0);
805 lua_pushliteral(L,"__index");
808 lua_pushliteral(L,"__metatable");
813 /* register the links methods to lua*/
814 luaL_openlib(L,LINK_MODULE_NAME,Link_methods,0);
815 luaL_newmetatable(L,LINK_MODULE_NAME);
818 /*register the routes methods to lua*/
819 luaL_openlib(L,ROUTE_MODULE_NAME,Route_methods,0);
820 luaL_newmetatable(L,LINK_MODULE_NAME);
823 /* Keep the context mechanism informed of our lua world today */
824 simgrid_lua_state = L;