X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/cf108868b4eeed4d0d9d343bc68557d7814e18c0..b049bada6ece9a57127a23fc04c542298518dc00:/src/msg/msg_io.cpp diff --git a/src/msg/msg_io.cpp b/src/msg/msg_io.cpp index 227031e00a..31d0bb17e9 100644 --- a/src/msg/msg_io.cpp +++ b/src/msg/msg_io.cpp @@ -4,21 +4,19 @@ /* 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 + #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 \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){ @@ -36,12 +34,11 @@ 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) { @@ -50,12 +47,11 @@ 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) { @@ -63,12 +59,11 @@ 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); @@ -87,7 +82,7 @@ void MSG_file_dump (msg_file_t 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 @@ -99,6 +94,9 @@ sg_size_t MSG_file_read(msg_file_t fd, sg_size_t size) msg_file_priv_t file_priv = MSG_file_priv(fd); sg_size_t read_size; + if (file_priv->size == 0.0) /* Nothing to read, return */ + return 0.0; + /* Find the host where the file is physically located and read it */ msg_storage_t storage_src =(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); @@ -108,15 +106,16 @@ sg_size_t MSG_file_read(msg_file_t fd, sg_size_t size) if(strcmp(storage_priv_src->hostname, MSG_host_get_name(MSG_host_self()))){ /* the file is hosted on a remote host, initiate a communication between src and dest hosts for data transfer */ XBT_DEBUG("File is on %s remote host, initiate data transfer of %llu bytes.", storage_priv_src->hostname, read_size); - msg_host_t *m_host_list = NULL; + msg_host_t *m_host_list = nullptr; m_host_list = (msg_host_t*) calloc(2, sizeof(msg_host_t)); m_host_list[0] = MSG_host_self(); m_host_list[1] = attached_host; - double flops_amount[] = { 0, 0 }; + 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, + nullptr); msg_error_t transfer = MSG_parallel_task_execute(task); MSG_task_destroy(task); free(m_host_list); @@ -132,7 +131,7 @@ sg_size_t MSG_file_read(msg_file_t fd, sg_size_t size) 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 @@ -142,7 +141,9 @@ sg_size_t MSG_file_read(msg_file_t fd, sg_size_t size) sg_size_t MSG_file_write(msg_file_t fd, sg_size_t size) { msg_file_priv_t file_priv = MSG_file_priv(fd); - sg_size_t write_size, offset; + + if (size == 0.0) /* Nothing to write, return */ + return 0.0; /* 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); @@ -152,7 +153,7 @@ sg_size_t MSG_file_write(msg_file_t fd, sg_size_t size) if(strcmp(storage_priv_src->hostname, MSG_host_get_name(MSG_host_self()))){ /* the file is hosted on a remote host, initiate a communication between src and dest hosts for data transfer */ XBT_DEBUG("File is on %s remote host, initiate data transfer of %llu bytes.", storage_priv_src->hostname, size); - msg_host_t *m_host_list = NULL; + msg_host_t *m_host_list = nullptr; m_host_list = (msg_host_t*) calloc(2, sizeof(msg_host_t)); m_host_list[0] = MSG_host_self(); @@ -160,7 +161,8 @@ sg_size_t MSG_file_write(msg_file_t fd, sg_size_t size) 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, + nullptr); msg_error_t transfer = MSG_parallel_task_execute(task); MSG_task_destroy(task); free(m_host_list); @@ -174,14 +176,14 @@ sg_size_t MSG_file_write(msg_file_t fd, sg_size_t size) } } /* Write file on local or remote host */ - offset = simcall_file_tell(file_priv->simdata->smx_file); - write_size = simcall_file_write(file_priv->simdata->smx_file, size, attached_host); + sg_size_t offset = simcall_file_tell(file_priv->simdata->smx_file); + sg_size_t write_size = simcall_file_write(file_priv->simdata->smx_file, size, attached_host); file_priv->size = offset+write_size; 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 @@ -199,8 +201,7 @@ msg_file_t MSG_file_open(const char* fullpath, void* data) 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); @@ -210,7 +211,7 @@ msg_file_t MSG_file_open(const char* fullpath, void* data) return fd; } -/** \ingroup msg_file_management +/** \ingroup msg_file * \brief Close the file * * \param fd is the file to close @@ -224,15 +225,14 @@ int MSG_file_close(msg_file_t fd) 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) @@ -243,15 +243,14 @@ msg_error_t MSG_file_unlink(msg_file_t fd) 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) @@ -263,20 +262,16 @@ sg_size_t MSG_file_get_size(msg_file_t fd){ } /** - * \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 \ 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 \ 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) { @@ -285,7 +280,7 @@ 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 @@ -299,13 +294,13 @@ sg_size_t MSG_file_tell(msg_file_t fd) } const char *MSG_file_get_name(msg_file_t fd) { - xbt_assert((fd != NULL), "Invalid parameters"); + xbt_assert((fd != nullptr), "Invalid parameters"); msg_file_priv_t priv = MSG_file_priv(fd); return priv->fullpath; } /** - * \ingroup msg_file_management + * \ingroup msg_file * \brief Move a file to another location on the *same mount point*. * */ @@ -316,13 +311,12 @@ msg_error_t MSG_file_move (msg_file_t fd, const char* fullpath) } /** - * \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) { @@ -337,15 +331,15 @@ msg_error_t MSG_file_rcopy (msg_file_t file, msg_host_t host, const char* fullpa read_size = simcall_file_read(file_priv->simdata->smx_file, file_priv->size, attached_host); /* Find the real host destination where the file will be physically stored */ - xbt_dict_cursor_t cursor = NULL; - char *mount_name, *storage_name, *file_mount_name, *host_name_dest; - msg_storage_t storage_dest = NULL; + xbt_dict_cursor_t cursor = nullptr; + msg_storage_t storage_dest = nullptr; 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(); + char *mount_name, *storage_name; xbt_dict_foreach(storage_list,cursor,mount_name,storage_name){ - file_mount_name = (char *) xbt_malloc ((strlen(mount_name)+1)); + char* file_mount_name = (char *) xbt_malloc ((strlen(mount_name)+1)); strncpy(file_mount_name,fullpath,strlen(mount_name)+1); file_mount_name[strlen(mount_name)] = '\0'; @@ -358,19 +352,20 @@ msg_error_t MSG_file_rcopy (msg_file_t file, msg_host_t host, const char* fullpa } xbt_dict_free(&storage_list); + char* host_name_dest = nullptr; if(longest_prefix_length>0){ /* Mount point found, retrieve the host the storage is attached to */ msg_storage_priv_t storage_dest_priv = MSG_storage_priv(storage_dest); host_name_dest = (char*)storage_dest_priv->hostname; host_dest = MSG_host_by_name(host_name_dest); - }else{ XBT_WARN("Can't find mount point for '%s' on destination host '%s'", fullpath, sg_host_get_name(host)); 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); - msg_host_t *m_host_list = NULL; + 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 = nullptr; m_host_list = (msg_host_t*) calloc(2, sizeof(msg_host_t)); m_host_list[0] = attached_host; @@ -378,7 +373,8 @@ msg_error_t MSG_file_rcopy (msg_file_t file, msg_host_t host, const char* fullpa 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, nullptr); msg_error_t transfer = MSG_parallel_task_execute(task); MSG_task_destroy(task); free(m_host_list); @@ -396,17 +392,15 @@ msg_error_t MSG_file_rcopy (msg_file_t file, msg_host_t host, const char* fullpa 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) { @@ -423,12 +417,10 @@ void __MSG_file_destroy(msg_file_priv_t file) { xbt_free(file->simdata); xbt_free(file); } -/********************************* Storage **************************************/ +/********************************* Storage **************************************/ /** @addtogroup msg_storage_management - * \htmlonly \endhtmlonly * (#msg_storage_t) and the functions for managing it. - * */ msg_storage_t __MSG_storage_create(smx_storage_t storage) @@ -448,7 +440,6 @@ void __MSG_storage_destroy(msg_storage_priv_t storage) { free(storage); } - /** \ingroup msg_storage_management * * \brief Returns the name of the #msg_storage_t. @@ -456,7 +447,7 @@ void __MSG_storage_destroy(msg_storage_priv_t storage) { * This functions checks whether a storage is a valid pointer or not and return its name. */ const char *MSG_storage_get_name(msg_storage_t storage) { - xbt_assert((storage != NULL), "Invalid parameters"); + xbt_assert((storage != nullptr), "Invalid parameters"); return SIMIX_storage_get_name(storage); } @@ -485,7 +476,7 @@ sg_size_t MSG_storage_get_used_size(msg_storage_t storage){ */ xbt_dict_t MSG_storage_get_properties(msg_storage_t storage) { - xbt_assert((storage != NULL), "Invalid parameters (storage is NULL)"); + xbt_assert((storage != nullptr), "Invalid parameters (storage is nullptr)"); return (simcall_storage_get_properties(storage)); } @@ -506,14 +497,13 @@ void MSG_storage_set_property_value(msg_storage_t storage, const char *name, cha * * \param storage a storage * \param name a property name - * \return value of a property (or NULL if property not set) + * \return value of a property (or nullptr if property not set) */ const char *MSG_storage_get_property_value(msg_storage_t storage, const char *name) { 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 @@ -526,17 +516,15 @@ msg_storage_t MSG_storage_get_by_name(const char *name) /** \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; - xbt_dynar_t res = xbt_dynar_new(sizeof(msg_storage_t),NULL); + xbt_dynar_t res = xbt_dynar_new(sizeof(msg_storage_t),nullptr); xbt_lib_foreach(storage_lib, cursor, key, data) { - if(xbt_lib_get_level(xbt_lib_get_elm_or_null(storage_lib, key), MSG_STORAGE_LEVEL) != NULL) { + if(xbt_lib_get_level(xbt_lib_get_elm_or_null(storage_lib, key), MSG_STORAGE_LEVEL) != nullptr) { xbt_dictelm_t elm = xbt_dict_cursor_get_elm(cursor); xbt_dynar_push(res, &elm); } @@ -547,8 +535,7 @@ xbt_dynar_t MSG_storages_as_dynar(void) { /** \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) { @@ -561,12 +548,11 @@ 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) { - xbt_assert((storage != NULL), "Invalid parameters"); + xbt_assert((storage != nullptr), "Invalid parameters"); msg_storage_priv_t priv = MSG_storage_priv(storage); return priv->data; } @@ -600,7 +586,7 @@ sg_size_t MSG_storage_get_size(msg_storage_t storage) * This functions checks whether a storage is a valid pointer or not and return its name. */ const char *MSG_storage_get_host(msg_storage_t storage) { - xbt_assert((storage != NULL), "Invalid parameters"); + xbt_assert((storage != nullptr), "Invalid parameters"); msg_storage_priv_t priv = MSG_storage_priv(storage); return priv->hostname; }