1 /* Copyright (c) 2010-2018. The SimGrid Team. All rights reserved. */
3 /* This program is free software; you can redistribute it and/or modify it
4 * under the terms of the license (GNU LGPL) which comes with this package. */
6 /* SimGrid Lua bindings */
8 #include "lua_private.hpp"
9 #include "simgrid/s4u/Host.hpp"
12 XBT_LOG_NEW_DEFAULT_CATEGORY(lua_host, "Lua Host module");
14 #define HOST_MODULE_NAME "simgrid.host"
15 #define HOST_FIELDNAME "__simgrid_host"
16 /* ********************************************************************************* */
17 /* simgrid.host API */
18 /* ********************************************************************************* */
20 /** @brief Ensures that the pointed stack value is an host userdatum 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
26 sg_host_t sglua_check_host(lua_State * L, int index)
28 luaL_checktype(L, index, LUA_TTABLE);
29 lua_getfield(L, index, HOST_FIELDNAME);
30 sg_host_t *pi = (sg_host_t *) luaL_checkudata(L, lua_gettop(L), HOST_MODULE_NAME);
33 XBT_ERROR("luaL_checkudata() returned nullptr");
36 luaL_error(L, "null Host");
41 * \brief Returns a host given its name. This is a lua function.
43 * \param L a Lua state
44 * \return number of values returned to Lua
46 * - Argument 1 (string): name of a host
47 * - Return value (host): the corresponding host will be pushed onto the stack
49 static int l_host_get_by_name(lua_State * L)
51 const char *name = luaL_checkstring(L, 1);
52 lua_remove(L, 1); /* remove the args from the stack */
54 sg_host_t host = sg_host_by_name(name);
55 lua_ensure(host, "No host name '%s' found.", name);
57 lua_newtable(L); /* table */
58 sg_host_t *lua_host = (sg_host_t *) lua_newuserdata(L, sizeof(sg_host_t)); /* table userdatum */
60 luaL_getmetatable(L, HOST_MODULE_NAME); /* table userdatum metatable */
61 lua_setmetatable(L, -2); /* table userdatum */
62 lua_setfield(L, -2, HOST_FIELDNAME); /* table -- put the userdata as field of the table */
68 * \brief Returns the name of a host.
69 * \param L a Lua state
70 * \return number of values returned to Lua
72 * - Argument 1 (host): a host
73 * - Return value (string): name of this host
75 static int l_host_get_name(lua_State * L)
77 sg_host_t ht = sglua_check_host(L, 1);
78 lua_pushstring(L, ht->get_cname());
83 * \brief Returns the number of existing hosts.
84 * \param L a Lua state
85 * \return number of values returned to Lua
87 * - Return value (number): number of hosts
89 static int l_host_number(lua_State * L)
91 xbt_dynar_t hosts = sg_hosts_as_dynar();
92 lua_pushinteger(L, xbt_dynar_length(hosts));
93 xbt_dynar_free(&hosts);
98 * \brief Returns the host given its index.
99 * \param L a Lua state
100 * \return number of values returned to Lua
102 * - Argument 1 (number): an index (1 is the first)
103 * - Return value (host): the host at this index
105 static int l_host_at(lua_State * L)
107 int index = luaL_checkinteger(L, 1);
108 xbt_dynar_t hosts = sg_hosts_as_dynar();
109 sg_host_t host = xbt_dynar_get_as(hosts,index - 1,sg_host_t);// lua indexing start by 1 (lua[1] <=> C[0])
110 lua_newtable(L); /* create a table, put the userdata on top of it */
111 sg_host_t *lua_host = (sg_host_t *) lua_newuserdata(L, sizeof(sg_host_t));
113 luaL_getmetatable(L, HOST_MODULE_NAME);
114 lua_setmetatable(L, -2);
115 lua_setfield(L, -2, HOST_FIELDNAME); /* put the userdata as field of the table */
116 xbt_dynar_free(&hosts);
121 * \brief Returns the value of a host property.
122 * \param L a Lua state
123 * \return number of values returned to Lua
125 * - Argument 1 (host): a host
126 * - Argument 2 (string): name of the property to get
127 * - Return value (string): the value of this property
129 static int l_host_get_property_value(lua_State * L)
131 sg_host_t ht = sglua_check_host(L, 1);
132 const char *prop = luaL_checkstring(L, 2);
133 lua_pushstring(L, sg_host_get_property_value(ht,prop));
138 * \brief Destroys a host.
139 * \param L a Lua state
140 * \return number of values returned to Lua
142 * - Argument 1 (host): the host to destroy
144 static int l_host_destroy(lua_State *L)
146 //sg_host_t ht = sglua_check_host(L, 1);
147 //FIXME: not working..__MSG_host_priv_free(MSG_host_priv(ht));
151 static const luaL_Reg host_functions[] = {
152 {"get_by_name", l_host_get_by_name},
153 {"name", l_host_get_name},
154 {"number", l_host_number},
156 {"get_prop_value", l_host_get_property_value},
157 {"destroy", l_host_destroy},
158 // Bypass XML Methods
159 {"set_property", console_host_set_property},
164 * \brief Returns a string representation of a host.
165 * \param L a Lua state
166 * \return number of values returned to Lua
168 * - Argument 1 (userdata): a host
169 * - Return value (string): a string describing this host
171 static int l_host_tostring(lua_State * L)
173 lua_pushfstring(L, "Host :%p", lua_touserdata(L, 1));
177 static const luaL_Reg host_meta[] = {
178 {"__tostring", l_host_tostring},
183 * \brief Registers the host functions into the table simgrid.host.
185 * Also initialize the metatable of the host userdata type.
187 * \param L a lua state
189 void sglua_register_host_functions(lua_State* L)
191 /* create a table simgrid.host and fill it with host functions */
192 lua_getglobal(L, "simgrid"); /* simgrid */
193 luaL_newlib(L, host_functions); /* simgrid simgrid.host */
194 lua_setfield(L, -2, "host"); /* simgrid */
195 lua_getfield(L, -1, "host"); /* simgrid simgrid.host */
197 /* create the metatable for host, add it to the Lua registry */
198 luaL_newmetatable(L, HOST_MODULE_NAME); /* simgrid simgrid.host mt */
200 /* fill the metatable */
201 luaL_setfuncs(L, host_meta, 0); /* simgrid simgrid.host mt */
204 * Copy the table and push it onto the stack.
205 * Required for the lua_setfield call below.
207 lua_getfield(L, -3, "host"); /* simgrid simgrid.host mt simgrid.host */
209 /* metatable.__index = simgrid.host
210 * we put the host functions inside the host userdata itself:
211 * this allows to write my_host:method(args) for
212 * simgrid.host.method(my_host, args) */
213 lua_setfield(L, -2, "__index"); /* simgrid simgrid.host mt */
215 lua_setmetatable(L, -2); /* simgrid simgrid.host */
216 lua_pop(L, 2); /* -- */