Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
this parameter belongs to the plugin
[simgrid.git] / src / plugins / file_system / s4u_FileSystem.cpp
index b5460bf..d636541 100644 (file)
@@ -1,27 +1,28 @@
-/* Copyright (c) 2015-2017. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2015-2018. The SimGrid Team. All rights reserved.          */
 
 /* 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 "xbt/log.h"
 
-#include "simgrid/s4u/Host.hpp"
-#include "simgrid/s4u/Storage.hpp"
-#include "simgrid/simix.hpp"
-#include "src/plugins/file_system/FileSystem.hpp"
+#include "simgrid/plugins/file_system.h"
+#include "simgrid/s4u/Actor.hpp"
 #include "src/surf/HostImpl.hpp"
+#include "xbt/config.hpp"
 
 #include <algorithm>
 #include <boost/algorithm/string.hpp>
 #include <boost/algorithm/string/join.hpp>
 #include <boost/algorithm/string/split.hpp>
 #include <fstream>
+#include <numeric>
 
 XBT_LOG_NEW_DEFAULT_CATEGORY(s4u_file, "S4U files");
+int sg_storage_max_file_descriptors = 1024;
 
 namespace simgrid {
 namespace s4u {
-simgrid::xbt::Extension<s4u::Storage, FileSystemStorageExt> FileSystemStorageExt::EXTENSION_ID;
+simgrid::xbt::Extension<Storage, FileSystemStorageExt> FileSystemStorageExt::EXTENSION_ID;
+simgrid::xbt::Extension<Host, FileDescriptorHostExt> FileDescriptorHostExt::EXTENSION_ID;
 
 File::File(std::string fullpath, void* userdata) : File(fullpath, Host::current(), userdata){};
 
@@ -30,7 +31,7 @@ File::File(std::string fullpath, sg_host_t host, void* userdata) : fullpath_(ful
   // this cannot fail because we get a xbt_die if the mountpoint does not exist
   Storage* st                  = nullptr;
   size_t longest_prefix_length = 0;
-  XBT_DEBUG("Search for storage name for '%s' on '%s'", fullpath.c_str(), host->getCname());
+  XBT_DEBUG("Search for storage name for '%s' on '%s'", fullpath.c_str(), host->get_cname());
 
   for (auto const& mnt : host->getMountedStorages()) {
     XBT_DEBUG("See '%s'", mnt.first.c_str());
@@ -46,10 +47,20 @@ File::File(std::string fullpath, sg_host_t host, void* userdata) : fullpath_(ful
     mount_point_ = fullpath.substr(0, longest_prefix_length);
     path_        = fullpath.substr(longest_prefix_length, fullpath.length());
   } else
-    xbt_die("Can't find mount point for '%s' on '%s'", fullpath.c_str(), host->getCname());
+    xbt_die("Can't find mount point for '%s' on '%s'", fullpath.c_str(), host->get_cname());
 
   localStorage = st;
 
+  // assign a file descriptor id to the newly opened File
+  FileDescriptorHostExt* ext = host->extension<simgrid::s4u::FileDescriptorHostExt>();
+  if (ext->file_descriptor_table == nullptr) {
+    ext->file_descriptor_table = new std::vector<int>(sg_storage_max_file_descriptors);
+    std::iota(ext->file_descriptor_table->rbegin(), ext->file_descriptor_table->rend(), 0); // Fill with ..., 1, 0.
+  }
+  xbt_assert(not ext->file_descriptor_table->empty(), "Too much files are opened! Some have to be closed.");
+  desc_id = ext->file_descriptor_table->back();
+  ext->file_descriptor_table->pop_back();
+
   XBT_DEBUG("\tOpen file '%s'", path_.c_str());
   std::map<std::string, sg_size_t>* content = localStorage->extension<FileSystemStorageExt>()->getContent();
   // if file does not exist create an empty file
@@ -63,6 +74,11 @@ File::File(std::string fullpath, sg_host_t host, void* userdata) : fullpath_(ful
   }
 }
 
+File::~File()
+{
+  Host::current()->extension<simgrid::s4u::FileDescriptorHostExt>()->file_descriptor_table->push_back(desc_id);
+}
+
 void File::dump()
 {
   XBT_INFO("File Descriptor information:\n"
@@ -72,21 +88,59 @@ void File::dump()
            "\t\tStorage Id: '%s'\n"
            "\t\tStorage Type: '%s'\n"
            "\t\tFile Descriptor Id: %d",
-           getPath(), size_, mount_point_.c_str(), localStorage->getCname(), localStorage->getType(), desc_id);
+           getPath(), size_, mount_point_.c_str(), localStorage->get_cname(), localStorage->getType(), desc_id);
 }
 
 sg_size_t File::read(sg_size_t size)
 {
-  XBT_DEBUG("READ %s on disk '%s'", getPath(), localStorage->getCname());
+  if (size_ == 0) /* Nothing to read, return */
+    return 0;
+
+  /* Find the host where the file is physically located and read it */
+  Host* host = localStorage->getHost();
+  XBT_DEBUG("READ %s on disk '%s'", getPath(), localStorage->get_cname());
   // if the current position is close to the end of the file, we may not be able to read the requested size
   sg_size_t read_size = localStorage->read(std::min(size, size_ - current_position_));
   current_position_ += read_size;
+
+  if (strcmp(host->get_cname(), Host::current()->get_cname())) {
+    /* 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.", host->get_cname(), read_size);
+    Host* m_host_list[]  = {Host::current(), host};
+    double* flops_amount = new double[2]{0, 0};
+    double* bytes_amount = new double[4]{0, 0, static_cast<double>(read_size), 0};
+
+    this_actor::parallel_execute(2, m_host_list, flops_amount, bytes_amount);
+  }
+
   return read_size;
 }
 
+/** \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 File::write(sg_size_t size)
 {
-  XBT_DEBUG("WRITE %s on disk '%s'. size '%llu/%llu'", getPath(), localStorage->getCname(), size, size_);
+  if (size == 0) /* Nothing to write, return */
+    return 0;
+
+  /* Find the host where the file is physically located (remote or local)*/
+  Host* host = localStorage->getHost();
+
+  if (strcmp(host->get_cname(), Host::current()->get_cname())) {
+    /* 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.", host->get_cname(), size);
+    Host* m_host_list[]  = {Host::current(), host};
+    double* flops_amount = new double[2]{0, 0};
+    double* bytes_amount = new double[4]{0, static_cast<double>(size), 0, 0};
+
+    this_actor::parallel_execute(2, m_host_list, flops_amount, bytes_amount);
+  }
+
+  XBT_DEBUG("WRITE %s on disk '%s'. size '%llu/%llu'", getPath(), localStorage->get_cname(), size, size_);
   // If the storage is full before even starting to write
   if (sg_storage_get_size_used(localStorage) >= sg_storage_get_size(localStorage))
     return 0;
@@ -164,10 +218,10 @@ int File::unlink()
   std::map<std::string, sg_size_t>* content = localStorage->extension<FileSystemStorageExt>()->getContent();
 
   if (content->find(path_) == content->end()) {
-    XBT_WARN("File %s is not on disk %s. Impossible to unlink", path_.c_str(), localStorage->getCname());
+    XBT_WARN("File %s is not on disk %s. Impossible to unlink", path_.c_str(), localStorage->get_cname());
     return -1;
   } else {
-    XBT_DEBUG("UNLINK %s on disk '%s'", path_.c_str(), localStorage->getCname());
+    XBT_DEBUG("UNLINK %s on disk '%s'", path_.c_str(), localStorage->get_cname());
     localStorage->extension<FileSystemStorageExt>()->decrUsedSize(size_);
 
     // Remove the file from storage
@@ -177,6 +231,63 @@ int File::unlink()
   }
 }
 
+int File::remoteCopy(sg_host_t host, const char* fullpath)
+{
+  /* Find the host where the file is physically located and read it */
+  Storage* storage_src = localStorage;
+  Host* src_host       = storage_src->getHost();
+  seek(0, SEEK_SET);
+  XBT_DEBUG("READ %s on disk '%s'", getPath(), localStorage->get_cname());
+  // if the current position is close to the end of the file, we may not be able to read the requested size
+  sg_size_t read_size = localStorage->read(size_);
+  current_position_ += read_size;
+
+  /* Find the host that owns the storage where the file has to be copied */
+  Storage* storage_dest = nullptr;
+  Host* 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->get_cname());
+    return -1;
+  }
+
+  XBT_DEBUG("Initiate data transfer of %llu bytes between %s and %s.", read_size, src_host->get_cname(),
+            storage_dest->getHost()->get_cname());
+  Host* m_host_list[]     = {src_host, dst_host};
+  double* flops_amount    = new double[2]{0, 0};
+  double* bytes_amount    = new double[4]{0, static_cast<double>(read_size), 0, 0};
+
+  this_actor::parallel_execute(2, m_host_list, flops_amount, bytes_amount);
+
+  /* Create file on remote host, write it and close it */
+  File* fd = new File(fullpath, dst_host, nullptr);
+  sg_size_t write_size = fd->localStorage->write(read_size);
+  fd->localStorage->extension<FileSystemStorageExt>()->incrUsedSize(write_size);
+  (*(fd->localStorage->extension<FileSystemStorageExt>()->getContent()))[path_] = size_;
+  delete fd;
+  return 0;
+}
+
+int File::remoteMove(sg_host_t host, const char* fullpath)
+{
+  int res = remoteCopy(host, fullpath);
+  unlink();
+  return res;
+}
+
 FileSystemStorageExt::FileSystemStorageExt(simgrid::s4u::Storage* ptr)
 {
   content_ = parseContent(ptr->getImpl()->content_name);
@@ -218,6 +329,7 @@ std::map<std::string, sg_size_t>* FileSystemStorageExt::parseContent(std::string
 }
 
 using simgrid::s4u::FileSystemStorageExt;
+using simgrid::s4u::FileDescriptorHostExt;
 
 static void onStorageCreation(simgrid::s4u::Storage& st)
 {
@@ -229,18 +341,48 @@ static void onStorageDestruction(simgrid::s4u::Storage& st)
   delete st.extension<FileSystemStorageExt>();
 }
 
-/* **************************** Public interface *************************** */
-SG_BEGIN_DECL()
+static void onHostCreation(simgrid::s4u::Host& host)
+{
+  host.extension_set<FileDescriptorHostExt>(new FileDescriptorHostExt());
+}
 
+/* **************************** Public interface *************************** */
 void sg_storage_file_system_init()
 {
-  if (FileSystemStorageExt::EXTENSION_ID.valid())
-    return;
+  sg_storage_max_file_descriptors = 1024;
+  simgrid::config::bind_flag(sg_storage_max_file_descriptors, "storage/max_file_descriptors",
+                             "Maximum number of concurrently opened files per host. Default is 1024");
+
+  if (not FileSystemStorageExt::EXTENSION_ID.valid()) {
+    FileSystemStorageExt::EXTENSION_ID = simgrid::s4u::Storage::extension_create<FileSystemStorageExt>();
+    simgrid::s4u::Storage::onCreation.connect(&onStorageCreation);
+    simgrid::s4u::Storage::onDestruction.connect(&onStorageDestruction);
+  }
 
-  FileSystemStorageExt::EXTENSION_ID = simgrid::s4u::Storage::extension_create<FileSystemStorageExt>();
+  if (not FileDescriptorHostExt::EXTENSION_ID.valid()) {
+    FileDescriptorHostExt::EXTENSION_ID = simgrid::s4u::Host::extension_create<FileDescriptorHostExt>();
+    simgrid::s4u::Host::onCreation.connect(&onHostCreation);
+  }
+}
 
-  simgrid::s4u::Storage::onCreation.connect(&onStorageCreation);
-  simgrid::s4u::Storage::onDestruction.connect(&onStorageDestruction);
+sg_file_t sg_file_open(const char* fullpath, void* data)
+{
+  return new simgrid::s4u::File(fullpath, data);
+}
+
+sg_size_t sg_file_read(sg_file_t fd, sg_size_t size)
+{
+  return fd->read(size);
+}
+
+sg_size_t sg_file_write(sg_file_t fd, sg_size_t size)
+{
+  return fd->write(size);
+}
+
+void sg_file_close(sg_file_t fd)
+{
+  delete fd;
 }
 
 const char* sg_file_get_name(sg_file_t fd)
@@ -270,7 +412,7 @@ void sg_file_set_data(sg_file_t fd, void* data)
 }
 
 /**
- * \brief Set the file position indicator in the msg_file_t by adding offset bytes
+ * \brief Set the file position indicator in the sg_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
@@ -300,6 +442,30 @@ void sg_file_unlink(sg_file_t fd)
   delete fd;
 }
 
+/**
+ * \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 0. Otherwise, it returns -1.
+ */
+int sg_file_rcopy(sg_file_t file, sg_host_t host, const char* fullpath)
+{
+  return file->remoteCopy(host, fullpath);
+}
+
+/**
+ * \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 0. Otherwise, it returns -1.
+ */
+int sg_file_rmove(sg_file_t file, sg_host_t host, const char* fullpath)
+{
+  return file->remoteMove(host, fullpath);
+}
+
 sg_size_t sg_storage_get_size_free(sg_storage_t st)
 {
   return st->extension<FileSystemStorageExt>()->getSize() - st->extension<FileSystemStorageExt>()->getUsedSize();
@@ -338,5 +504,3 @@ xbt_dict_t sg_host_get_storage_content(sg_host_t host)
 
   return contents;
 }
-
-SG_END_DECL()