Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
move VMs in the S4U realm for good
[simgrid.git] / src / msg / msg_io.cpp
index 269ae90..0734919 100644 (file)
 /* 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 "simgrid/s4u/File.hpp"
 #include "simgrid/s4u/Host.hpp"
 #include "simgrid/s4u/Storage.hpp"
 #include "src/msg/msg_private.hpp"
+#include "src/plugins/file_system/FileSystem.hpp"
 #include <numeric>
 
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_io, msg, "Logging specific to MSG (io)");
 
-SG_BEGIN_DECL()
-
-/** @addtogroup msg_file
- * (#msg_file_t) and the functions for managing it.
- *
- *  \see #msg_file_t
- */
-
-static int MSG_host_get_file_descriptor_id(msg_host_t host)
-{
-  simgrid::MsgHostExt* priv = host->extension<simgrid::MsgHostExt>();
-  if (priv->file_descriptor_table == nullptr) {
-    priv->file_descriptor_table = new std::vector<int>(sg_storage_max_file_descriptors);
-    std::iota(priv->file_descriptor_table->rbegin(), priv->file_descriptor_table->rend(), 0); // Fill with ..., 1, 0.
-  }
-  xbt_assert(not priv->file_descriptor_table->empty(), "Too much files are opened! Some have to be closed.");
-  int desc = priv->file_descriptor_table->back();
-  priv->file_descriptor_table->pop_back();
-  return desc;
-}
-
-static void MSG_host_release_file_descriptor_id(msg_host_t host, int id)
-{
-  host->extension<simgrid::MsgHostExt>()->file_descriptor_table->push_back(id);
-}
-
-/** \ingroup msg_file
- *
- * \brief Set the user data of a #msg_file_t.
- *
- * This functions attach \a data to \a file.
- */
-msg_error_t MSG_file_set_data(msg_file_t fd, void *data)
-{
-  fd->setUserdata(data);
-  return MSG_OK;
-}
-
-/** \ingroup msg_file
- *
- * \brief Return the user data of a #msg_file_t.
- *
- * 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 fd->getUserdata();
-}
-
-/** \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){
-  XBT_INFO("File Descriptor information:\n"
-           "\t\tFull path: '%s'\n"
-           "\t\tSize: %llu\n"
-           "\t\tMount point: '%s'\n"
-           "\t\tStorage Id: '%s'\n"
-           "\t\tStorage Type: '%s'\n"
-           "\t\tFile Descriptor Id: %d",
-           fd->getPath(), fd->size(), fd->mount_point.c_str(), fd->storageId.c_str(), fd->storage_type.c_str(),
-           fd->desc_id);
-}
-
-/** \ingroup msg_file
- * \brief Read a file (local or remote)
- *
- * \param size of the file to read
- * \param fd is a the file descriptor
- * \return the number of bytes successfully read or -1 if an error occurred
- */
-sg_size_t MSG_file_read(msg_file_t fd, sg_size_t size)
-{
-  sg_size_t read_size;
-
-  if (fd->size() == 0) /* Nothing to read, return */
-    return 0;
-
-  /* Find the host where the file is physically located and read it */
-  msg_storage_t storage_src           = simgrid::s4u::Storage::byName(fd->storageId);
-  msg_host_t attached_host            = storage_src->getHost();
-  read_size                           = fd->read(size);
-
-  if (strcmp(attached_host->getCname(), MSG_host_self()->getCname())) {
-    /* 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.", attached_host->getCname(), read_size);
-    msg_host_t m_host_list[] = {MSG_host_self(), attached_host};
-    double flops_amount[]    = {0, 0};
-    double bytes_amount[]    = {0, 0, static_cast<double>(read_size), 0};
-
-    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);
-
-    if(transfer != MSG_OK){
-      if (transfer == MSG_HOST_FAILURE)
-        XBT_WARN("Transfer error, %s remote host just turned off!", attached_host->getCname());
-      if (transfer == MSG_TASK_CANCELED)
-        XBT_WARN("Transfer error, task has been canceled!");
-
-      return -1;
-    }
-  }
-  return read_size;
-}
-
-/** \ingroup msg_file
- * \brief Write into a file (local or remote)
- *
- * \param size of the file to write
- * \param fd is a the file descriptor
- * \return the number of bytes successfully write or -1 if an error occurred
- */
-sg_size_t MSG_file_write(msg_file_t fd, sg_size_t size)
-{
-  if (size == 0) /* Nothing to write, return */
-    return 0;
-
-  /* Find the host where the file is physically located (remote or local)*/
-  msg_storage_t storage_src = simgrid::s4u::Storage::byName(fd->storageId);
-  msg_host_t attached_host  = storage_src->getHost();
-
-  if (strcmp(attached_host->getCname(), MSG_host_self()->getCname())) {
-    /* 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.", attached_host->getCname(), size);
-    msg_host_t m_host_list[] = {MSG_host_self(), attached_host};
-    double flops_amount[]    = {0, 0};
-    double bytes_amount[]    = {0, static_cast<double>(size), 0, 0};
-
-    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);
-
-    if(transfer != MSG_OK){
-      if (transfer == MSG_HOST_FAILURE)
-        XBT_WARN("Transfer error, %s remote host just turned off!", attached_host->getCname());
-      if (transfer == MSG_TASK_CANCELED)
-        XBT_WARN("Transfer error, task has been canceled!");
-
-      return -1;
-    }
-  }
-  /* Write file on local or remote host */
-  sg_size_t write_size = fd->write(size);
-
-  return write_size;
-}
-
-/** \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
- * \param data user data to attach to the file
- *
- * \return An #msg_file_t associated to the file
- */
-msg_file_t MSG_file_open(const char* fullpath, void* data)
-{
-  msg_file_t fd         = new simgrid::s4u::File(fullpath, MSG_host_self());
-  fd->desc_id           = MSG_host_get_file_descriptor_id(MSG_host_self());
-  fd->setUserdata(data);
-  return fd;
-}
-
-/** \ingroup msg_file
- * \brief Close the file
- *
- * \param fd is the file to close
- * \return 0 on success or 1 on error
- */
-int MSG_file_close(msg_file_t fd)
-{
-  MSG_host_release_file_descriptor_id(MSG_host_self(), fd->desc_id);
-  delete fd;
-
-  return MSG_OK;
-}
-
-/** \ingroup msg_file
- * \brief Unlink the file pointed by fd
- *
- * \param fd is the file descriptor (#msg_file_t)
- * \return 0 on success or 1 on error
- */
-msg_error_t MSG_file_unlink(msg_file_t fd)
-{
-  fd->unlink();
-  delete fd;
-  return MSG_OK;
-}
-
-/** \ingroup msg_file
- * \brief Return the size of a file
- *
- * \param fd is the file descriptor (#msg_file_t)
- * \return the size of the file (as a #sg_size_t)
- */
-sg_size_t MSG_file_get_size(msg_file_t fd)
-{
-  return fd->size();
-}
-
-/**
- * \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).
- */
-msg_error_t MSG_file_seek(msg_file_t fd, sg_offset_t offset, int origin)
-{
-  fd->seek(offset, origin);
-  return MSG_OK;
-}
-
-/**
- * \ingroup msg_file
- * \brief Returns the current value of the position indicator of the file
- *
- * \param fd : file object that identifies the stream
- * \return On success, the current value of the position indicator is returned.
- *
- */
-sg_size_t MSG_file_tell(msg_file_t fd)
-{
-  return fd->tell();
-}
-
-const char *MSG_file_get_name(msg_file_t fd) {
-  xbt_assert((fd != nullptr), "Invalid parameters");
-  return fd->getPath();
-}
-
-/**
- * \ingroup msg_file
- * \brief Move a file to another location on the *same mount point*.
- *
- */
-msg_error_t MSG_file_move (msg_file_t fd, const char* fullpath)
-{
-  fd->move(fullpath);
-  return MSG_OK;
-}
-
-/**
- * \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.
- */
-msg_error_t MSG_file_rcopy (msg_file_t file, msg_host_t host, const char* fullpath)
-{
-  /* Find the host where the file is physically located and read it */
-  msg_storage_t storage_src = simgrid::s4u::Storage::byName(file->storageId);
-  msg_host_t src_host       = storage_src->getHost();
-  MSG_file_seek(file, 0, SEEK_SET);
-  sg_size_t read_size = file->read(file->size());
-
-  /* Find the host that owns the storage where the file has to be copied */
-  msg_storage_t storage_dest = nullptr;
-  msg_host_t dst_host;
-  size_t longest_prefix_length = 0;
-
-  for (auto const& elm : host->getMountedStorages()) {
-    std::string mount_point = std::string(fullpath).substr(0, elm.first.size());
-    if (mount_point == elm.first && elm.first.length() > longest_prefix_length) {
-      /* The current mount name is found in the full path and is bigger than the previous*/
-      longest_prefix_length = elm.first.length();
-      storage_dest          = elm.second;
-    }
-  }
-
-  if (storage_dest != nullptr) {
-    /* Mount point found, retrieve the host the storage is attached to */
-    dst_host = storage_dest->getHost();
-  }else{
-    XBT_WARN("Can't find mount point for '%s' on destination host '%s'", fullpath, host->getCname());
-    return MSG_TASK_CANCELED;
-  }
-
-  XBT_DEBUG("Initiate data transfer of %llu bytes between %s and %s.", read_size, src_host->getCname(),
-            storage_dest->getHost()->getCname());
-  msg_host_t m_host_list[] = {src_host, dst_host};
-  double flops_amount[]    = {0, 0};
-  double bytes_amount[]    = {0, static_cast<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, nullptr);
-  msg_error_t err = MSG_parallel_task_execute(task);
-  MSG_task_destroy(task);
-
-  if (err != MSG_OK) {
-    if (err == MSG_HOST_FAILURE)
-      XBT_WARN("Transfer error, %s remote host just turned off!", storage_dest->getHost()->getCname());
-    if (err == MSG_TASK_CANCELED)
-      XBT_WARN("Transfer error, task has been canceled!");
-
-    return err;
-  }
-
-  /* Create file on remote host, write it and close it */
-  msg_file_t fd = new simgrid::s4u::File(fullpath, dst_host, nullptr);
-  fd->write(read_size);
-  delete fd;
-  return MSG_OK;
-}
-
-/**
- * \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.
- */
-msg_error_t MSG_file_rmove (msg_file_t file, msg_host_t host, const char* fullpath)
-{
-  msg_error_t res = MSG_file_rcopy(file, host, fullpath);
-  MSG_file_unlink(file);
-  return res;
-}
+extern "C" {
 
 /********************************* Storage **************************************/
 /** @addtogroup msg_storage_management
@@ -358,27 +27,13 @@ msg_error_t MSG_file_rmove (msg_file_t file, msg_host_t host, const char* fullpa
 const char* MSG_storage_get_name(msg_storage_t storage)
 {
   xbt_assert((storage != nullptr), "Invalid parameters");
-  return storage->getName();
-}
-
-/** \ingroup msg_storage_management
- * \brief Returns the free space size of a storage element
- * \param storage a storage
- * \return the free space size of the storage element (as a #sg_size_t)
- */
-sg_size_t MSG_storage_get_free_size(msg_storage_t storage)
-{
-  return storage->getSizeFree();
+  return storage->getCname();
 }
 
-/** \ingroup msg_storage_management
- * \brief Returns the used space size of a storage element
- * \param storage a storage
- * \return the used space size of the storage element (as a #sg_size_t)
- */
-sg_size_t MSG_storage_get_used_size(msg_storage_t storage)
+const char* MSG_storage_get_host(msg_storage_t storage)
 {
-  return storage->getSizeUsed();
+  xbt_assert((storage != nullptr), "Invalid parameters");
+  return storage->getHost()->getCname();
 }
 
 /** \ingroup msg_storage_management
@@ -438,77 +93,35 @@ msg_storage_t MSG_storage_get_by_name(const char *name)
  */
 xbt_dynar_t MSG_storages_as_dynar()
 {
-  std::map<std::string, simgrid::s4u::Storage*>* storage_map = simgrid::s4u::allStorages();
+  std::map<std::string, simgrid::s4u::Storage*>* storage_list = new std::map<std::string, simgrid::s4u::Storage*>;
+  simgrid::s4u::getStorageList(storage_list);
   xbt_dynar_t res = xbt_dynar_new(sizeof(msg_storage_t),nullptr);
-  for (auto const& s : *storage_map)
+  for (auto const& s : *storage_list)
     xbt_dynar_push(res, &(s.second));
-  delete storage_map;
+  delete storage_list;
   return res;
 }
 
-/** \ingroup msg_storage_management
- *
- * \brief Set the user data of a #msg_storage_t.
- * This functions attach \a data to \a storage if possible.
- */
-msg_error_t MSG_storage_set_data(msg_storage_t storage, void *data)
-{
-  storage->setUserdata(data);
-  return MSG_OK;
-}
-
-/** \ingroup m_host_management
- *
- * \brief Returns the user data of a #msg_storage_t.
- *
- * 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)
+void* MSG_storage_get_data(msg_storage_t storage)
 {
   xbt_assert((storage != nullptr), "Invalid parameters");
   return storage->getUserdata();
 }
 
-/** \ingroup msg_storage_management
- *
- * \brief Returns the content (file list) of a #msg_storage_t.
- * \param storage a storage
- * \return The content of this storage element as a dict (full path file => size)
- */
-xbt_dict_t MSG_storage_get_content(msg_storage_t storage)
+msg_error_t MSG_storage_set_data(msg_storage_t storage, void *data)
 {
-  std::map<std::string, sg_size_t>* content = storage->getContent();
-  xbt_dict_t content_as_dict = xbt_dict_new_homogeneous(xbt_free_f);
-
-  for (auto const& entry : *content) {
-    sg_size_t* psize = static_cast<sg_size_t*>(malloc(sizeof(sg_size_t)));
-    *psize           = entry.second;
-    xbt_dict_set(content_as_dict, entry.first.c_str(), psize, nullptr);
-  }
-  return content_as_dict;
+  storage->setUserdata(data);
+  return MSG_OK;
 }
 
-/** \ingroup msg_storage_management
- *
- * \brief Returns the size of a #msg_storage_t.
- * \param storage a storage
- * \return The size of the storage
- */
-sg_size_t MSG_storage_get_size(msg_storage_t storage)
+sg_size_t MSG_storage_read(msg_storage_t storage, sg_size_t size)
 {
-  return storage->getSize();
+  return storage->read(size);
 }
 
-/** \ingroup msg_storage_management
- *
- * \brief 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.
- */
-const char* MSG_storage_get_host(msg_storage_t storage)
+sg_size_t MSG_storage_write(msg_storage_t storage, sg_size_t size)
 {
-  xbt_assert((storage != nullptr), "Invalid parameters");
-  return storage->getHost()->getCname();
+  return storage->write(size);
 }
 
-SG_END_DECL()
+}