SimGrid  3.9
Versatile Simulation of Distributed Systems
 All Data Structures Functions Variables Typedefs Enumerations Enumerator Groups Pages
Host Management Functions

This section describes the host structure of MSG. More...

Typedefs

typedef xbt_dictelm_t msg_host_t
 Host datatype.A location (or host) is any possible place where a process may run. Thus it is 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.

Functions

msg_error_t MSG_host_set_data (msg_host_t host, void *data)
 Set the user data of a msg_host_t.
void * MSG_host_get_data (msg_host_t host)
 Return the user data of a msg_host_t.
const char * MSG_host_get_name (msg_host_t host)
 Return the name of the msg_host_t.
msg_host_t MSG_host_self (void)
 Return the location on which the current process is executed.
int MSG_get_host_number (void)
 Return the current number MSG hosts.
xbt_dynar_t MSG_hosts_as_dynar (void)
 Return a dynar containing all the hosts declared at a given point of time.
int MSG_get_host_msgload (msg_host_t h)
 Return the number of MSG tasks currently running on a msg_host_t. The external load is not taken in account.
double MSG_get_host_speed (msg_host_t h)
 Return the speed of the processor (in flop/s), regardless of the current load on the machine.
const char * MSG_host_get_property_value (msg_host_t host, const char *name)
 Returns the value of a given host property.
xbt_dict_t MSG_host_get_properties (msg_host_t host)
 Returns a xbt_dict_t consisting of the list of properties assigned to this host.
void MSG_host_set_property_value (msg_host_t host, const char *name, char *value, void_f_pvoid_t free_ctn)
 Change the value of a given host property.

Detailed Description

This section describes the host structure of MSG.

@htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Hosts" --> \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 Also
msg_host_t

Function Documentation

msg_error_t MSG_host_set_data ( msg_host_t  host,
void *  data 
)

Set the user data of a msg_host_t.

This functions checks whether some data has already been associated to host or not and attach data to host if it is possible.

void* MSG_host_get_data ( msg_host_t  host)

Return the user data of a msg_host_t.

This functions checks whether host is a valid pointer or not and return the user data associated to host if it is possible.

const char* MSG_host_get_name ( msg_host_t  host)

Return the name of the msg_host_t.

This functions checks whether host is a valid pointer or not and return its name.

const char* MSG_host_get_property_value ( msg_host_t  host,
const char *  name 
)

Returns the value of a given host property.

Parameters
hosta host
namea property name
Returns
value of a property (or NULL if property not set)
xbt_dict_t MSG_host_get_properties ( msg_host_t  host)

Returns a xbt_dict_t consisting of the list of properties assigned to this host.

Parameters
hosta host
Returns
a dict containing the properties
void MSG_host_set_property_value ( msg_host_t  host,
const char *  name,
char *  value,
void_f_pvoid_t  free_ctn 
)

Change the value of a given host property.

Parameters
hosta host
namea property name
valuewhat to change the property to
free_ctnthe freeing function to use to kill the value on need