SimGrid  3.11
Versatile Simulation of Distributed Systems
Storage Management Functions

This section describes the storage structure of MSG (msg_storage_t) and the functions for managing it. It is based on POSIX functions. More...

Typedefs

typedef xbt_dictelm_t msg_storage_t
 Storage datatype.You should consider this as an opaque object.
 

Functions

const char * MSG_storage_get_name (msg_storage_t storage)
 Returns the name of the msg_storage_t. More...
 
sg_size_t MSG_storage_get_free_size (msg_storage_t storage)
 Returns the free space size of a storage element. More...
 
sg_size_t MSG_storage_get_used_size (msg_storage_t storage)
 Returns the used space size of a storage element. More...
 
xbt_dict_t MSG_storage_get_properties (msg_storage_t storage)
 Returns a xbt_dict_t consisting of the list of properties assigned to this storage. More...
 
void MSG_storage_set_property_value (msg_storage_t storage, const char *name, char *value, void_f_pvoid_t free_ctn)
 Change the value of a given storage property. More...
 
msg_storage_t MSG_storage_get_by_name (const char *name)
 Finds a msg_storage_t using its name. More...
 
xbt_dynar_t MSG_storages_as_dynar (void)
 Returns a dynar containing all the storage elements declared at a given point of time.
 
msg_error_t MSG_storage_set_data (msg_storage_t storage, void *data)
 Set the user data of a msg_storage_t. This functions checks whether some data has already been associated to storage or not and attach data to storage if it is possible.
 
xbt_dict_t MSG_storage_get_content (msg_storage_t storage)
 Returns the content (file list) of a msg_storage_t. More...
 
sg_size_t MSG_storage_get_size (msg_storage_t storage)
 Returns the size of a msg_storage_t. More...
 
const char * MSG_storage_get_host (msg_storage_t storage)
 Returns the host name the storage is attached to. More...
 

Detailed Description

This section describes the storage structure of MSG (msg_storage_t) and the functions for managing it. It is based on POSIX functions.

(msg_storage_t) and the functions for managing it.

Function Documentation

const char* MSG_storage_get_name ( msg_storage_t  storage)

Returns the name of the msg_storage_t.

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

sg_size_t MSG_storage_get_free_size ( msg_storage_t  storage)

Returns the free space size of a storage element.

Parameters
storagea storage
Returns
the free space size of the storage element (as a sg_size_t)
sg_size_t MSG_storage_get_used_size ( msg_storage_t  storage)

Returns the used space size of a storage element.

Parameters
storagea storage
Returns
the used space size of the storage element (as a sg_size_t)
xbt_dict_t MSG_storage_get_properties ( msg_storage_t  storage)

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

Parameters
storagea storage
Returns
a dict containing the properties
void MSG_storage_set_property_value ( msg_storage_t  storage,
const char *  name,
char *  value,
void_f_pvoid_t  free_ctn 
)

Change the value of a given storage property.

Parameters
storagea storage
namea property name
valuewhat to change the property to
free_ctnthe freeing function to use to kill the value on need
msg_storage_t MSG_storage_get_by_name ( const char *  name)

Finds a msg_storage_t using its name.

Parameters
namethe name of a storage
Returns
the corresponding storage
xbt_dict_t MSG_storage_get_content ( msg_storage_t  storage)

Returns the content (file list) of a msg_storage_t.

Parameters
storagea storage
Returns
The content of this storage element as a dict (full path file => size)
sg_size_t MSG_storage_get_size ( msg_storage_t  storage)

Returns the size of a msg_storage_t.

Parameters
storagea storage
Returns
The size of the storage
const char* MSG_storage_get_host ( msg_storage_t  storage)

Returns the host name the storage is attached to.

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