#include "msg_private.h"
#include "xbt/log.h"
-#include "msg_mailbox.h"
-XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_io, msg,
- "Logging specific to MSG (io)");
+XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_io, msg, "Logging specific to MSG (io)");
-/** @addtogroup msg_file_management
- * \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Files" --> \endhtmlonly
+/** @addtogroup msg_file
* (#msg_file_t) and the functions for managing it.
*
* \see #msg_file_t
*/
-
/********************************* File **************************************/
void __MSG_file_get_info(msg_file_t fd){
xbt_dynar_free_container(&info);
}
-/** \ingroup msg_file_management
+/** \ingroup msg_file
*
* \brief Set the user data of a #msg_file_t.
*
- * This functions checks whether some data has already been associated to \a file
- or not and attach \a data to \a file if it is possible.
+ * This functions attach \a data to \a file.
*/
msg_error_t MSG_file_set_data(msg_file_t fd, void *data)
{
return MSG_OK;
}
-/** \ingroup msg_file_management
+/** \ingroup msg_file
*
* \brief Return the user data of a #msg_file_t.
*
- * This functions checks whether \a file is a valid pointer or not and return
- the user data associated to \a file if it is possible.
+ * This functions checks whether \a file is a valid pointer and return the user data associated to \a file if possible.
*/
void *MSG_file_get_data(msg_file_t fd)
{
return priv->data;
}
-/** \ingroup msg_file_management
+/** \ingroup msg_file
* \brief Display information related to a file descriptor
*
* \param fd is a the file descriptor
*/
-
void MSG_file_dump (msg_file_t fd){
/* Update the cached information first */
__MSG_file_get_info(fd);
priv->content_type, priv->desc_id);
}
-/** \ingroup msg_file_management
+/** \ingroup msg_file
* \brief Read a file (local or remote)
*
* \param size of the file to read
double flops_amount[] = { 0, 0 };
double bytes_amount[] = { 0, 0, (double)read_size, 0 };
- msg_task_t task = MSG_parallel_task_create("file transfer for read", 2, m_host_list, flops_amount, bytes_amount, NULL);
+ msg_task_t task = MSG_parallel_task_create("file transfer for read", 2, m_host_list, flops_amount, bytes_amount,
+ NULL);
msg_error_t transfer = MSG_parallel_task_execute(task);
MSG_task_destroy(task);
free(m_host_list);
return read_size;
}
-/** \ingroup msg_file_management
+/** \ingroup msg_file
* \brief Write into a file (local or remote)
*
* \param size of the file to write
double flops_amount[] = { 0, 0 };
double bytes_amount[] = { 0, (double)size, 0, 0 };
- msg_task_t task = MSG_parallel_task_create("file transfer for write", 2, m_host_list, flops_amount, bytes_amount, NULL);
+ msg_task_t task = MSG_parallel_task_create("file transfer for write", 2, m_host_list, flops_amount, bytes_amount,
+ NULL);
msg_error_t transfer = MSG_parallel_task_execute(task);
MSG_task_destroy(task);
free(m_host_list);
return write_size;
}
-/** \ingroup msg_file_management
+/** \ingroup msg_file
* \brief Opens the file whose name is the string pointed to by path
*
* \param fullpath is the file location on the storage
priv->simdata->smx_file = simcall_file_open(fullpath, MSG_host_self());
priv->desc_id = __MSG_host_get_file_descriptor_id(MSG_host_self());
- name = bprintf("%s:%s:%d", priv->fullpath, MSG_host_get_name(MSG_host_self()),
- priv->desc_id);
+ name = bprintf("%s:%s:%d", priv->fullpath, MSG_host_get_name(MSG_host_self()), priv->desc_id);
xbt_lib_set(file_lib, name, MSG_FILE_LEVEL, priv);
msg_file_t fd = (msg_file_t) xbt_lib_get_elm_or_null(file_lib, name);
return fd;
}
-/** \ingroup msg_file_management
+/** \ingroup msg_file
* \brief Close the file
*
* \param fd is the file to close
xbt_free(priv->data);
int res = simcall_file_close(priv->simdata->smx_file, MSG_host_self());
- name = bprintf("%s:%s:%d", priv->fullpath, MSG_host_get_name(MSG_host_self()),
- priv->desc_id);
+ name = bprintf("%s:%s:%d", priv->fullpath, MSG_host_get_name(MSG_host_self()), priv->desc_id);
__MSG_host_release_file_descriptor_id(MSG_host_self(), priv->desc_id);
xbt_lib_unset(file_lib, name, MSG_FILE_LEVEL, 1);
xbt_free(name);
return res;
}
-/** \ingroup msg_file_management
+/** \ingroup msg_file
* \brief Unlink the file pointed by fd
*
* \param fd is the file descriptor (#msg_file_t)
msg_file_priv_t file_priv = MSG_file_priv(fd);
/* Find the host where the file is physically located (remote or local)*/
msg_storage_t storage_src =
- (msg_storage_t) xbt_lib_get_elm_or_null(storage_lib,
- file_priv->storageId);
+ (msg_storage_t) xbt_lib_get_elm_or_null(storage_lib, file_priv->storageId);
msg_storage_priv_t storage_priv_src = MSG_storage_priv(storage_src);
msg_host_t attached_host = MSG_host_by_name(storage_priv_src->hostname);
int res = simcall_file_unlink(file_priv->simdata->smx_file, attached_host);
return (msg_error_t) res;
}
-/** \ingroup msg_file_management
+/** \ingroup msg_file
* \brief Return the size of a file
*
* \param fd is the file descriptor (#msg_file_t)
}
/**
- * \ingroup msg_file_management
+ * \ingroup msg_file
* \brief Set the file position indicator in the msg_file_t by adding offset bytes
* to the position specified by origin (either SEEK_SET, SEEK_CUR, or SEEK_END).
*
* \param fd : file object that identifies the stream
* \param offset : number of bytes to offset from origin
- * \param origin : Position used as reference for the offset. It is specified by
- * one of the following constants defined in \<stdio.h\> exclusively to be used as
- * arguments for this function (SEEK_SET = beginning of file, SEEK_CUR = current
- * position of the file pointer, SEEK_END = end of file)
- *
- * \return If successful, the function returns MSG_OK (=0). Otherwise, it returns
- * MSG_TASK_CANCELED (=8).
- *
+ * \param origin : Position used as reference for the offset. It is specified by one of the following constants defined
+ * in \<stdio.h\> exclusively to be used as arguments for this function (SEEK_SET = beginning of file,
+ * SEEK_CUR = current position of the file pointer, SEEK_END = end of file)
+ * \return If successful, the function returns MSG_OK (=0). Otherwise, it returns MSG_TASK_CANCELED (=8).
*/
msg_error_t MSG_file_seek(msg_file_t fd, sg_offset_t offset, int origin)
{
}
/**
- * \ingroup msg_file_management
+ * \ingroup msg_file
* \brief Returns the current value of the position indicator of the file
*
* \param fd : file object that identifies the stream
}
/**
- * \ingroup msg_file_management
+ * \ingroup msg_file
* \brief Move a file to another location on the *same mount point*.
*
*/
}
/**
- * \ingroup msg_file_management
+ * \ingroup msg_file
* \brief Copy a file to another location on a remote host.
* \param file : the file to move
* \param host : the remote host where the file has to be copied
* \param fullpath : the complete path destination on the remote host
- * \return If successful, the function returns MSG_OK. Otherwise, it returns
- * MSG_TASK_CANCELED.
+ * \return If successful, the function returns MSG_OK. Otherwise, it returns MSG_TASK_CANCELED.
*/
msg_error_t MSG_file_rcopy (msg_file_t file, msg_host_t host, const char* fullpath)
{
msg_host_t host_dest;
size_t longest_prefix_length = 0;
- xbt_dict_t storage_list = host->mounted_storages_as_dict();
+ xbt_dict_t storage_list = host->mountedStoragesAsDict();
xbt_dict_foreach(storage_list,cursor,mount_name,storage_name){
file_mount_name = (char *) xbt_malloc ((strlen(mount_name)+1));
strncpy(file_mount_name,fullpath,strlen(mount_name)+1);
return MSG_TASK_CANCELED;
}
- XBT_DEBUG("Initiate data transfer of %llu bytes between %s and %s.", read_size, storage_priv_src->hostname, host_name_dest);
+ XBT_DEBUG("Initiate data transfer of %llu bytes between %s and %s.", read_size, storage_priv_src->hostname,
+ host_name_dest);
msg_host_t *m_host_list = NULL;
m_host_list = (msg_host_t*) calloc(2, sizeof(msg_host_t));
double flops_amount[] = { 0, 0 };
double bytes_amount[] = { 0, (double)read_size, 0, 0 };
- msg_task_t task = MSG_parallel_task_create("file transfer for write", 2, m_host_list, flops_amount, bytes_amount, NULL);
+ msg_task_t task =
+ MSG_parallel_task_create("file transfer for write", 2, m_host_list, flops_amount, bytes_amount, NULL);
msg_error_t transfer = MSG_parallel_task_execute(task);
MSG_task_destroy(task);
free(m_host_list);
simcall_file_write(smx_file, read_size, host_dest);
simcall_file_close(smx_file, host_dest);
return MSG_OK;
-
}
/**
- * \ingroup msg_file_management
+ * \ingroup msg_file
* \brief Move a file to another location on a remote host.
* \param file : the file to move
* \param host : the remote host where the file has to be moved
* \param fullpath : the complete path destination on the remote host
- * \return If successful, the function returns MSG_OK. Otherwise, it returns
- * MSG_TASK_CANCELED.
+ * \return If successful, the function returns MSG_OK. Otherwise, it returns MSG_TASK_CANCELED.
*/
msg_error_t MSG_file_rmove (msg_file_t file, msg_host_t host, const char* fullpath)
{
xbt_free(file->simdata);
xbt_free(file);
}
-/********************************* Storage **************************************/
+/********************************* Storage **************************************/
/** @addtogroup msg_storage_management
- * \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Storages" --> \endhtmlonly
* (#msg_storage_t) and the functions for managing it.
- *
*/
msg_storage_t __MSG_storage_create(smx_storage_t storage)
free(storage);
}
-
/** \ingroup msg_storage_management
*
* \brief Returns the name of the #msg_storage_t.
return (char*) xbt_dict_get_or_null(MSG_storage_get_properties(storage), name);
}
-
/** \ingroup msg_storage_management
* \brief Finds a msg_storage_t using its name.
* \param name the name of a storage
/** \ingroup msg_storage_management
* \brief Returns a dynar containing all the storage elements declared at a given point of time
- *
*/
xbt_dynar_t MSG_storages_as_dynar(void) {
-
xbt_lib_cursor_t cursor;
char *key;
void **data;
/** \ingroup msg_storage_management
*
* \brief Set the user data of a #msg_storage_t.
- * This functions checks whether some data has already been associated to \a storage
- or not and attach \a data to \a storage if it is possible.
+ * This functions attach \a data to \a storage if possible.
*/
msg_error_t MSG_storage_set_data(msg_storage_t storage, void *data)
{
*
* \brief Returns the user data of a #msg_storage_t.
*
- * This functions checks whether \a storage is a valid pointer or not and returns
- the user data associated to \a storage if it is possible.
+ * This functions checks whether \a storage is a valid pointer and returns its associate user data if possible.
*/
void *MSG_storage_get_data(msg_storage_t storage)
{
