src/bindings/lua/lua_host.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 "lua_private.h"
  10 #include <lauxlib.h>
  11
  12 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(lua_host, bindings, "Lua bindings (host module)");
  13
  14 #define HOST_MODULE_NAME "simgrid.host"
  15
  16 /* ********************************************************************************* */
  17 /*                                simgrid.host API                                   */
  18 /* ********************************************************************************* */
  19
  20 /**
  21  * \brief Ensures that a value in the stack is a host and returns it.
  22  * \param L a Lua state
  23  * \param index an index in the Lua stack
  24  * \return the C host corresponding to this Lua host
  25  */
  26 msg_host_t sglua_check_host(lua_State * L, int index)
  27 {
  28   msg_host_t *pi, ht;
  29   luaL_checktype(L, index, LUA_TTABLE);
  30   lua_getfield(L, index, "__simgrid_host");
  31   pi = (msg_host_t *) luaL_checkudata(L, lua_gettop(L), HOST_MODULE_NAME);
  32   if (pi == NULL)
  33     luaL_typerror(L, index, HOST_MODULE_NAME);
  34   ht = *pi;
  35   if (!ht)
  36     luaL_error(L, "null Host");
  37   lua_pop(L, 1);
  38   return ht;
  39 }
  40
  41 /**
  42  * \brief Returns a host given its name.
  43  * \param L a Lua state
  44  * \return number of values returned to Lua
  45  *
  46  * - Argument 1 (string): name of a host
  47  * - Return value (host): the corresponding host
  48  */
  49 static int l_host_get_by_name(lua_State * L)
  50 {
  51   const char *name = luaL_checkstring(L, 1);
  52   XBT_DEBUG("Getting Host from name...");
  53   msg_host_t msg_host = MSG_get_host_by_name(name);
  54   if (!msg_host) {
  55     luaL_error(L, "null Host : MSG_get_host_by_name failed");
  56   }
  57   lua_newtable(L);              /* create a table, put the userdata on top of it */
  58   msg_host_t *lua_host = (msg_host_t *) lua_newuserdata(L, sizeof(msg_host_t));
  59   *lua_host = msg_host;
  60   luaL_getmetatable(L, HOST_MODULE_NAME);
  61   lua_setmetatable(L, -2);
  62   lua_setfield(L, -2, "__simgrid_host");        /* put the userdata as field of the table */
  63   /* remove the args from the stack */
  64   lua_remove(L, 1);
  65   return 1;
  66 }
  67
  68 /**
  69  * \brief Returns the name of a host.
  70  * \param L a Lua state
  71  * \return number of values returned to Lua
  72  *
  73  * - Argument 1 (host): a host
  74  * - Return value (string): name of this host
  75  */
  76 static int l_host_get_name(lua_State * L)
  77 {
  78   msg_host_t ht = sglua_check_host(L, 1);
  79   lua_pushstring(L, MSG_host_get_name(ht));
  80   return 1;
  81 }
  82
  83 /**
  84  * \brief Returns the number of existing hosts.
  85  * \param L a Lua state
  86  * \return number of values returned to Lua
  87  *
  88  * - Return value (number): number of hosts
  89  */
  90 static int l_host_number(lua_State * L)
  91 {
  92   xbt_dynar_t hosts = MSG_hosts_as_dynar();
  93   lua_pushnumber(L, xbt_dynar_length(hosts));
  94   xbt_dynar_free(&hosts);
  95   return 1;
  96 }
  97
  98 /**
  99  * \brief Returns the host given its index.
 100  * \param L a Lua state
 101  * \return number of values returned to Lua
 102  *
 103  * - Argument 1 (number): an index (1 is the first)
 104  * - Return value (host): the host at this index
 105  */
 106 static int l_host_at(lua_State * L)
 107 {
 108   int index = luaL_checkinteger(L, 1);
 109   xbt_dynar_t hosts = MSG_hosts_as_dynar();
 110   msg_host_t host = xbt_dynar_get_as(hosts,index - 1,msg_host_t);// lua indexing start by 1 (lua[1] <=> C[0])
 111   lua_newtable(L);              /* create a table, put the userdata on top of it */
 112   msg_host_t *lua_host = (msg_host_t *) lua_newuserdata(L, sizeof(msg_host_t));
 113   *lua_host = host;
 114   luaL_getmetatable(L, HOST_MODULE_NAME);
 115   lua_setmetatable(L, -2);
 116   lua_setfield(L, -2, "__simgrid_host");        /* put the userdata as field of the table */
 117   xbt_dynar_free(&hosts);
 118   return 1;
 119 }
 120
 121 /**
 122  * \brief Returns the host where the current process is located.
 123  * \param L a Lua state
 124  * \return number of values returned to Lua
 125  *
 126  * - Return value (host): the current host
 127  */
 128 static int l_host_self(lua_State * L)
 129 {
 130                                   /* -- */
 131   msg_host_t host = MSG_host_self();
 132   lua_newtable(L);
 133                                   /* table */
 134   msg_host_t* lua_host = (msg_host_t*) lua_newuserdata(L, sizeof(msg_host_t));
 135                                   /* table ud */
 136   *lua_host = host;
 137   luaL_getmetatable(L, HOST_MODULE_NAME);
 138                                   /* table ud mt */
 139   lua_setmetatable(L, -2);
 140                                   /* table ud */
 141   lua_setfield(L, -2, "__simgrid_host");
 142                                   /* table */
 143   return 1;
 144 }
 145
 146 /**
 147  * \brief Returns the value of a host property.
 148  * \param L a Lua state
 149  * \return number of values returned to Lua
 150  *
 151  * - Argument 1 (host): a host
 152  * - Argument 2 (string): name of the property to get
 153  * - Return value (string): the value of this property
 154  */
 155 static int l_host_get_property_value(lua_State * L)
 156 {
 157   msg_host_t ht = sglua_check_host(L, 1);
 158   const char *prop = luaL_checkstring(L, 2);
 159   lua_pushstring(L,MSG_host_get_property_value(ht,prop));
 160   return 1;
 161 }
 162
 163 /**
 164  * \brief Makes the current process sleep for a while.
 165  * \param L a Lua state
 166  * \return number of values returned to Lua
 167  *
 168  * - Argument 1 (number): duration of the sleep
 169  */
 170 static int l_host_sleep(lua_State *L)
 171 {
 172   int time = luaL_checknumber(L, 1);
 173   MSG_process_sleep(time);
 174   return 0;
 175 }
 176
 177 /**
 178  * \brief Destroys a host.
 179  * \param L a Lua state
 180  * \return number of values returned to Lua
 181  *
 182  * - Argument 1 (host): the host to destroy
 183  */
 184 static int l_host_destroy(lua_State *L)
 185 {
 186   msg_host_t ht = sglua_check_host(L, 1);
 187   __MSG_host_destroy(MSG_host_priv(ht));
 188   return 0;
 189 }
 190
 191 static const luaL_reg host_functions[] = {
 192   {"get_by_name", l_host_get_by_name},
 193   {"name", l_host_get_name},
 194   {"number", l_host_number},
 195   {"at", l_host_at},
 196   {"self", l_host_self},
 197   {"get_prop_value", l_host_get_property_value},
 198   {"sleep", l_host_sleep},
 199   {"destroy", l_host_destroy},
 200   // Bypass XML Methods
 201   {"set_function", console_set_function},
 202   {"set_property", console_host_set_property},
 203   {NULL, NULL}
 204 };
 205
 206 /**
 207  * \brief Returns a string representation of a host.
 208  * \param L a Lua state
 209  * \return number of values returned to Lua
 210  *
 211  * - Argument 1 (userdata): a host
 212  * - Return value (string): a string describing this host
 213  */
 214 static int l_host_tostring(lua_State * L)
 215 {
 216   lua_pushfstring(L, "Host :%p", lua_touserdata(L, 1));
 217   return 1;
 218 }
 219
 220 static const luaL_reg host_meta[] = {
 221   {"__tostring", l_host_tostring},
 222   {0, 0}
 223 };
 224
 225 /**
 226  * \brief Registers the host functions into the table simgrid.host.
 227  *
 228  * Also initialize the metatable of the host userdata type.
 229  *
 230  * \param L a lua state
 231  */
 232 void sglua_register_host_functions(lua_State* L)
 233 {
 234   /* create a table simgrid.host and fill it with host functions */
 235   luaL_openlib(L, HOST_MODULE_NAME, host_functions, 0);
 236                                   /* simgrid.host */
 237
 238   /* create the metatable for host, add it to the Lua registry */
 239   luaL_newmetatable(L, HOST_MODULE_NAME);
 240                                   /* simgrid.host mt */
 241   /* fill the metatable */
 242   luaL_openlib(L, NULL, host_meta, 0);
 243                                   /* simgrid.host mt */
 244   lua_pushvalue(L, -2);
 245                                   /* simgrid.host mt simgrid.host */
 246   /* metatable.__index = simgrid.host
 247    * we put the host functions inside the host userdata itself:
 248    * this allows to write my_host:method(args) for
 249    * simgrid.host.method(my_host, args) */
 250   lua_setfield(L, -2, "__index");
 251                                   /* simgrid.host mt */
 252   lua_pop(L, 2);
 253                                   /* -- */
 254 }
 255