/* Copyright (c) 2004, 2005, 2006, 2007, 2008, 2009, 2010. 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. */
#include "msg/msg_private.h"
#include "msg/msg_mailbox.h"
#include "xbt/sysdep.h"
#include "xbt/log.h"
#include "simgrid/simix.h"
XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(msg);
/** @addtogroup m_host_management
* \htmlonly \endhtmlonly
* (#msg_host_t) and the functions for managing it.
*
* A location (or host) is any possible place where
* a process may run. Thus it may be represented as a
* physical resource with computing capabilities, some
* mailboxes to enable running process to communicate with
* remote ones, and some private data that can be only
* accessed by local process.
* \see msg_host_t
*/
/********************************* Host **************************************/
msg_host_t __MSG_host_create(smx_host_t workstation)
{
const char *name = SIMIX_host_get_name(workstation);
msg_host_priv_t host = xbt_new0(s_msg_host_priv_t, 1);
s_msg_vm_t vm; // simply to compute the offset
host->vms = xbt_swag_new(xbt_swag_offset(vm,host_vms_hookup));
#ifdef MSG_USE_DEPRECATED
int i;
char alias[MAX_ALIAS_NAME + 1] = { 0 }; /* buffer used to build the key of the mailbox */
if (msg_global->max_channel > 0)
host->mailboxes = xbt_new0(msg_mailbox_t, msg_global->max_channel);
for (i = 0; i < msg_global->max_channel; i++) {
sprintf(alias, "%s:%d", name, i);
/* the key of the mailbox (in this case) is build from the name of the host and the channel number */
host->mailboxes[i] = MSG_mailbox_new(alias);
memset(alias, 0, MAX_ALIAS_NAME + 1);
}
#endif
xbt_lib_set(host_lib,name,MSG_HOST_LEVEL,host);
return xbt_lib_get_elm_or_null(host_lib, name);
}
/** \ingroup msg_host_management
* \brief Finds a msg_host_t using its name.
*
* This is a name directory service
* \param name the name of an host.
* \return the corresponding host
*/
msg_host_t MSG_get_host_by_name(const char *name)
{
return (msg_host_t) xbt_lib_get_elm_or_null(host_lib,name);
}
/** \ingroup m_host_management
*
* \brief Set the user data of a #msg_host_t.
*
* This functions checks whether some data has already been associated to \a host
or not and attach \a data to \a host if it is possible.
*/
msg_error_t MSG_host_set_data(msg_host_t host, void *data)
{
SIMIX_host_set_data(host,data);
return MSG_OK;
}
/** \ingroup m_host_management
*
* \brief Return the user data of a #msg_host_t.
*
* This functions checks whether \a host is a valid pointer or not and return
the user data associated to \a host if it is possible.
*/
void *MSG_host_get_data(msg_host_t host)
{
return SIMIX_host_get_data(host);
}
/** \ingroup m_host_management
*
* \brief Return the name of the #msg_host_t.
*
* This functions checks whether \a host is a valid pointer or not and return
its name.
*/
const char *MSG_host_get_name(msg_host_t host) {
return SIMIX_host_get_name(host);
}
/** \ingroup m_host_management
*
* \brief Return the location on which the current process is executed.
*/
msg_host_t MSG_host_self(void)
{
return MSG_process_get_host(NULL);
}
/*
* \brief Destroys a host (internal call only)
*/
void __MSG_host_destroy(msg_host_priv_t host) {
#ifdef MSG_USE_DEPRECATED
if (msg_global->max_channel > 0)
free(host->mailboxes);
#endif
if (xbt_swag_size(host->vms) > 0 ) {
XBT_VERB("Host shut down, but it still hosts %d VMs. They will be leaked.",xbt_swag_size(host->vms));
}
xbt_swag_free(host->vms);
free(host);
}
/** \ingroup m_host_management
* \brief Return the current number MSG hosts.
*/
int MSG_get_host_number(void)
{
return xbt_lib_length(host_lib);
}
#ifdef MSG_USE_DEPRECATED
msg_host_t *MSG_get_host_table(void)
{
void **array;
int i = 0;
xbt_lib_cursor_t cursor;
char *key;
void **data;
if (xbt_lib_length(host_lib) == 0)
return NULL;
else
array = xbt_new0(void *, xbt_lib_length(host_lib));
xbt_lib_foreach(host_lib, cursor, key, data) {
if(routing_get_network_element_type(key) == SURF_NETWORK_ELEMENT_HOST)
array[i++] = data[MSG_HOST_LEVEL];
}
return (msg_host_t *)array;
}
#endif
/** \ingroup m_host_management
* \brief Return a dynar containing all the hosts declared at a given point of time
*/
xbt_dynar_t MSG_hosts_as_dynar(void) {
xbt_lib_cursor_t cursor;
char *key;
void **data;
xbt_dynar_t res = xbt_dynar_new(sizeof(msg_host_t),NULL);
xbt_lib_foreach(host_lib, cursor, key, data) {
if(routing_get_network_element_type(key) == SURF_NETWORK_ELEMENT_HOST) {
xbt_dictelm_t elm = xbt_dict_cursor_get_elm(cursor);
xbt_dynar_push(res, &elm);
}
}
return res;
}
/** \ingroup m_host_management
* \brief Return the number of MSG tasks currently running on a
* #msg_host_t. The external load is not taken in account.
*/
int MSG_get_host_msgload(msg_host_t h)
{
xbt_assert((h != NULL), "Invalid parameters");
xbt_die( "Not implemented yet");
return (0);
}
/** \ingroup m_host_management
* \brief Return the speed of the processor (in flop/s), regardless of
the current load on the machine.
*/
double MSG_get_host_speed(msg_host_t h)
{
xbt_assert((h != NULL), "Invalid parameters");
return (simcall_host_get_speed(h));
}
/** \ingroup m_host_management
* \brief Returns the value of a given host property
*
* \param host a host
* \param name a property name
* \return value of a property (or NULL if property not set)
*/
const char *MSG_host_get_property_value(msg_host_t host, const char *name)
{
return xbt_dict_get_or_null(MSG_host_get_properties(host), name);
}
/** \ingroup m_host_management
* \brief Returns a xbt_dict_t consisting of the list of properties assigned to this host
*
* \param host a host
* \return a dict containing the properties
*/
xbt_dict_t MSG_host_get_properties(msg_host_t host)
{
xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
return (simcall_host_get_properties(host));
}
/** \ingroup m_host_management
* \brief Change the value of a given host property
*
* \param host a host
* \param name a property name
* \param value what to change the property to
* \param free_ctn the freeing function to use to kill the value on need
*/
void MSG_host_set_property_value(msg_host_t host, const char *name, char *value,void_f_pvoid_t free_ctn) {
xbt_dict_set(MSG_host_get_properties(host), name, value,free_ctn);
}
/** \ingroup msg_gos_functions
* \brief Determine if a host is available.
*
* \param host host to test
* \return Returns 1 if host is available, 0 otherwise
*/
int MSG_host_is_avail(msg_host_t host)
{
xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
return (simcall_host_get_state(host));
}