src/bindings/lua/lua_host.cpp

   1 /* Copyright (c) 2010, 2012-2015. 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 <simgrid/host.h>
  11 extern "C" {
  12 #include <lauxlib.h>
  13 }
  14
  15 XBT_LOG_NEW_DEFAULT_CATEGORY(lua_host, "Lua bindings (host module)");
  16
  17 #define HOST_MODULE_NAME "simgrid.host"
  18 #define HOST_FIELDNAME   "__simgrid_host"
  19 /* ********************************************************************************* */
  20 /*                                simgrid.host API                                   */
  21 /* ********************************************************************************* */
  22
  23 /**
  24  * \brief Ensures that a value in the stack is a host and returns it.
  25  *
  26  * This function is called from C and helps to verify that a specific
  27  * userdatum on the stack is in fact a sg_host_t.
  28  *
  29  * \param L a Lua state
  30  * \param index an index in the Lua stack
  31  * \return the C host corresponding to this Lua host
  32  */
  33 sg_host_t sglua_check_host(lua_State * L, int index)
  34 {
  35   sg_host_t *pi, ht;
  36   luaL_checktype(L, index, LUA_TTABLE);
  37   lua_getfield(L, index, HOST_FIELDNAME);
  38   pi = (sg_host_t *) luaL_checkudata(L, lua_gettop(L), HOST_MODULE_NAME);
  39   if (pi == NULL)
  40     XBT_ERROR("luaL_checkudata() returned NULL");
  41   ht = *pi;
  42   if (!ht)
  43     luaL_error(L, "null Host");
  44   lua_pop(L, 1);
  45   return ht;
  46 }
  47
  48 /**
  49  * \brief Returns a host given its name. This is a lua function.
  50  *
  51  * \param L a Lua state
  52  * \return number of values returned to Lua
  53  *
  54  * - Argument 1 (string): name of a host
  55  * - Return value (host): the corresponding host will be pushed onto the stack
  56  */
  57 static int l_host_get_by_name(lua_State * L)
  58 {
  59   const char *name = luaL_checkstring(L, 1);
  60   XBT_DEBUG("Getting host by name...");
  61   sg_host_t host = sg_host_by_name(name);
  62   if (!host) {
  63     XBT_ERROR("sg_get_host_by_name failed, requested hostname: %s", name);
  64   }
  65   lua_newtable(L);                        /* table */
  66   sg_host_t *lua_host = (sg_host_t *) lua_newuserdata(L, sizeof(sg_host_t));
  67                                           /* table userdatum */
  68   *lua_host = host;
  69   luaL_getmetatable(L, HOST_MODULE_NAME); /* table userdatum metatable */
  70   lua_setmetatable(L, -2);                /* table userdatum */
  71   lua_setfield(L, -2, HOST_FIELDNAME);  /* table -- put the userdata as field of the table */
  72
  73   /* remove the args from the stack */
  74   lua_remove(L, 1);
  75   return 1;
  76 }
  77
  78 /**
  79  * \brief Returns the name of a host.
  80  * \param L a Lua state
  81  * \return number of values returned to Lua
  82  *
  83  * - Argument 1 (host): a host
  84  * - Return value (string): name of this host
  85  */
  86 static int l_host_get_name(lua_State * L)
  87 {
  88   sg_host_t ht = sglua_check_host(L, 1);
  89   lua_pushstring(L, sg_host_get_name(ht));
  90   return 1;
  91 }
  92
  93 /**
  94  * \brief Returns the number of existing hosts.
  95  * \param L a Lua state
  96  * \return number of values returned to Lua
  97  *
  98  * - Return value (number): number of hosts
  99  */
 100 static int l_host_number(lua_State * L)
 101 {
 102   xbt_dynar_t hosts = sg_hosts_as_dynar();
 103   lua_pushinteger(L, xbt_dynar_length(hosts));
 104   xbt_dynar_free(&hosts);
 105   return 1;
 106 }
 107
 108 /**
 109  * \brief Returns the host given its index.
 110  * \param L a Lua state
 111  * \return number of values returned to Lua
 112  *
 113  * - Argument 1 (number): an index (1 is the first)
 114  * - Return value (host): the host at this index
 115  */
 116 static int l_host_at(lua_State * L)
 117 {
 118   int index = luaL_checkinteger(L, 1);
 119   xbt_dynar_t hosts = sg_hosts_as_dynar();
 120   sg_host_t host = xbt_dynar_get_as(hosts,index - 1,sg_host_t);// lua indexing start by 1 (lua[1] <=> C[0])
 121   lua_newtable(L);              /* create a table, put the userdata on top of it */
 122   sg_host_t *lua_host = (sg_host_t *) lua_newuserdata(L, sizeof(sg_host_t));
 123   *lua_host = host;
 124   luaL_getmetatable(L, HOST_MODULE_NAME);
 125   lua_setmetatable(L, -2);
 126   lua_setfield(L, -2, HOST_FIELDNAME);        /* put the userdata as field of the table */
 127   xbt_dynar_free(&hosts);
 128   return 1;
 129 }
 130
 131 /**
 132  * \brief Returns the value of a host property.
 133  * \param L a Lua state
 134  * \return number of values returned to Lua
 135  *
 136  * - Argument 1 (host): a host
 137  * - Argument 2 (string): name of the property to get
 138  * - Return value (string): the value of this property
 139  */
 140 static int l_host_get_property_value(lua_State * L)
 141 {
 142   sg_host_t ht = sglua_check_host(L, 1);
 143   const char *prop = luaL_checkstring(L, 2);
 144   lua_pushstring(L, sg_host_get_property_value(ht,prop));
 145   return 1;
 146 }
 147
 148 /**
 149  * \brief Destroys a host.
 150  * \param L a Lua state
 151  * \return number of values returned to Lua
 152  *
 153  * - Argument 1 (host): the host to destroy
 154  */
 155 static int l_host_destroy(lua_State *L)
 156 {
 157   //sg_host_t ht = sglua_check_host(L, 1);
 158   //FIXME: not working..__MSG_host_priv_free(MSG_host_priv(ht));
 159   return 0;
 160 }
 161
 162 static const luaL_Reg host_functions[] = {
 163   {"get_by_name", l_host_get_by_name},
 164   {"name", l_host_get_name},
 165   {"number", l_host_number},
 166   {"at", l_host_at},
 167   {"get_prop_value", l_host_get_property_value},
 168   {"destroy", l_host_destroy},
 169   // Bypass XML Methods
 170   {"set_property", console_host_set_property},
 171   {NULL, NULL}
 172 };
 173
 174 /**
 175  * \brief Returns a string representation of a host.
 176  * \param L a Lua state
 177  * \return number of values returned to Lua
 178  *
 179  * - Argument 1 (userdata): a host
 180  * - Return value (string): a string describing this host
 181  */
 182 static int l_host_tostring(lua_State * L)
 183 {
 184   lua_pushfstring(L, "Host :%p", lua_touserdata(L, 1));
 185   return 1;
 186 }
 187
 188 static const luaL_Reg host_meta[] = {
 189   {"__tostring", l_host_tostring},
 190   {0, 0}
 191 };
 192
 193 /**
 194  * \brief Registers the host functions into the table simgrid.host.
 195  *
 196  * Also initialize the metatable of the host userdata type.
 197  *
 198  * \param L a lua state
 199  */
 200 void sglua_register_host_functions(lua_State* L)
 201 {
 202   /* create a table simgrid.host and fill it with host functions */
 203   lua_getglobal(L, "simgrid"); /* simgrid */
 204   luaL_newlib(L, host_functions); /* simgrid simgrid.host */
 205   lua_setfield(L, -2, "host"); /* simgrid */
 206   lua_getfield(L, -1, "host");    /* simgrid simgrid.host */
 207
 208   /* create the metatable for host, add it to the Lua registry */
 209   luaL_newmetatable(L, HOST_MODULE_NAME); /* simgrid simgrid.host mt */
 210
 211   /* fill the metatable */
 212   luaL_setfuncs(L, host_meta, 0);         /* simgrid simgrid.host mt */
 213
 214   /**
 215    * Copy the table and push it onto the stack.
 216    * Required for the lua_setfield call below.
 217    */
 218   lua_getfield(L, -3, "host");                   /* simgrid simgrid.host mt simgrid.host */
 219
 220   /* metatable.__index = simgrid.host
 221    * we put the host functions inside the host userdata itself:
 222    * this allows to write my_host:method(args) for
 223    * simgrid.host.method(my_host, args) */
 224   lua_setfield(L, -2, "__index");         /* simgrid simgrid.host mt */
 225
 226   lua_setmetatable(L, -2);                /* simgrid simgrid.host */
 227   lua_pop(L, 2);                          /* -- */
 228 }
 229