-/* Copyright (c) 2010, 2012-2015. The SimGrid Team.
- * All rights reserved. */
+/* Copyright (c) 2010-2019. The SimGrid Team. All rights reserved. */
/* This program is free software; you can redistribute it and/or modify it
* under the terms of the license (GNU LGPL) which comes with this package. */
/* SimGrid Lua bindings */
-#include "lua_private.h"
-#include <simgrid/host.h>
-extern "C" {
+#include "lua_private.hpp"
+#include "simgrid/s4u/Host.hpp"
#include <lauxlib.h>
-}
-XBT_LOG_NEW_DEFAULT_CATEGORY(lua_host, "Lua bindings (host module)");
+XBT_LOG_NEW_DEFAULT_CATEGORY(lua_host, "Lua Host module");
+
+constexpr char HOST_MODULE_NAME[] = "simgrid.host";
+constexpr char HOST_FIELDNAME[] = "__simgrid_host";
-#define HOST_MODULE_NAME "simgrid.host"
-#define HOST_FIELDNAME "__simgrid_host"
/* ********************************************************************************* */
/* simgrid.host API */
/* ********************************************************************************* */
-/**
- * \brief Ensures that a value in the stack is a host and returns it.
+/** @brief Ensures that the pointed stack value is a host userdatum and returns it.
*
- * This function is called from C and helps to verify that a specific
- * userdatum on the stack is in fact a sg_host_t.
- *
- * \param L a Lua state
- * \param index an index in the Lua stack
- * \return the C host corresponding to this Lua host
+ * @param L a Lua state
+ * @param index an index in the Lua stack
+ * @return the C host corresponding to this Lua host
*/
sg_host_t sglua_check_host(lua_State * L, int index)
{
- sg_host_t *pi, ht;
luaL_checktype(L, index, LUA_TTABLE);
lua_getfield(L, index, HOST_FIELDNAME);
- pi = (sg_host_t *) luaL_checkudata(L, lua_gettop(L), HOST_MODULE_NAME);
- if (pi == NULL)
- XBT_ERROR("luaL_checkudata() returned NULL");
- ht = *pi;
- if (!ht)
- luaL_error(L, "null Host");
+ sg_host_t *pi = (sg_host_t *) luaL_checkudata(L, lua_gettop(L), HOST_MODULE_NAME);
lua_pop(L, 1);
+ xbt_assert(pi != nullptr, "luaL_checkudata() returned nullptr");
+ sg_host_t ht = *pi;
+ if (not ht)
+ luaL_error(L, "null Host");
return ht;
}
/**
- * \brief Returns a host given its name. This is a lua function.
+ * @brief Returns a host given its name. This is a lua function.
*
- * \param L a Lua state
- * \return number of values returned to Lua
+ * @param L a Lua state
+ * @return number of values returned to Lua
*
* - Argument 1 (string): name of a host
* - Return value (host): the corresponding host will be pushed onto the stack
static int l_host_get_by_name(lua_State * L)
{
const char *name = luaL_checkstring(L, 1);
- XBT_DEBUG("Getting host by name...");
+ lua_remove(L, 1); /* remove the args from the stack */
+
sg_host_t host = sg_host_by_name(name);
- if (!host) {
- XBT_ERROR("sg_get_host_by_name failed, requested hostname: %s", name);
- }
+ lua_ensure(host, "No host name '%s' found.", name);
+
lua_newtable(L); /* table */
- sg_host_t *lua_host = (sg_host_t *) lua_newuserdata(L, sizeof(sg_host_t));
- /* table userdatum */
+ sg_host_t *lua_host = (sg_host_t *) lua_newuserdata(L, sizeof(sg_host_t)); /* table userdatum */
*lua_host = host;
luaL_getmetatable(L, HOST_MODULE_NAME); /* table userdatum metatable */
lua_setmetatable(L, -2); /* table userdatum */
- lua_setfield(L, -2, HOST_FIELDNAME); /* table -- put the userdata as field of the table */
+ lua_setfield(L, -2, HOST_FIELDNAME); /* table -- put the userdata as field of the table */
- /* remove the args from the stack */
- lua_remove(L, 1);
return 1;
}
/**
- * \brief Returns the name of a host.
- * \param L a Lua state
- * \return number of values returned to Lua
+ * @brief Returns the name of a host.
+ * @param L a Lua state
+ * @return number of values returned to Lua
*
* - Argument 1 (host): a host
* - Return value (string): name of this host
static int l_host_get_name(lua_State * L)
{
sg_host_t ht = sglua_check_host(L, 1);
- lua_pushstring(L, sg_host_get_name(ht));
+ lua_pushstring(L, ht->get_cname());
return 1;
}
/**
- * \brief Returns the number of existing hosts.
- * \param L a Lua state
- * \return number of values returned to Lua
+ * @brief Returns the number of existing hosts.
+ * @param L a Lua state
+ * @return number of values returned to Lua
*
* - Return value (number): number of hosts
*/
}
/**
- * \brief Returns the host given its index.
- * \param L a Lua state
- * \return number of values returned to Lua
+ * @brief Returns the host given its index.
+ * @param L a Lua state
+ * @return number of values returned to Lua
*
* - Argument 1 (number): an index (1 is the first)
* - Return value (host): the host at this index
}
/**
- * \brief Returns the value of a host property.
- * \param L a Lua state
- * \return number of values returned to Lua
+ * @brief Returns the value of a host property.
+ * @param L a Lua state
+ * @return number of values returned to Lua
*
* - Argument 1 (host): a host
* - Argument 2 (string): name of the property to get
}
/**
- * \brief Destroys a host.
- * \param L a Lua state
- * \return number of values returned to Lua
+ * @brief Destroys a host.
+ * @param L a Lua state
+ * @return number of values returned to Lua
*
* - Argument 1 (host): the host to destroy
*/
static int l_host_destroy(lua_State *L)
{
- //sg_host_t ht = sglua_check_host(L, 1);
- //FIXME: not working..__MSG_host_priv_free(MSG_host_priv(ht));
+ sg_host_t ht = sglua_check_host(L, 1);
+ ht->destroy();
return 0;
}
{"destroy", l_host_destroy},
// Bypass XML Methods
{"set_property", console_host_set_property},
- {NULL, NULL}
+ {nullptr, nullptr}
};
/**
- * \brief Returns a string representation of a host.
- * \param L a Lua state
- * \return number of values returned to Lua
+ * @brief Returns a string representation of a host.
+ * @param L a Lua state
+ * @return number of values returned to Lua
*
* - Argument 1 (userdata): a host
* - Return value (string): a string describing this host
};
/**
- * \brief Registers the host functions into the table simgrid.host.
+ * @brief Registers the host functions into the table simgrid.host.
*
* Also initialize the metatable of the host userdata type.
*
- * \param L a lua state
+ * @param L a lua state
*/
void sglua_register_host_functions(lua_State* L)
{
