Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
make s4u::File extendable
[simgrid.git] / src / plugins / file_system / s4u_FileSystem.cpp
index e9aeb84..669bf1d 100644 (file)
@@ -5,6 +5,7 @@
 
 #include "simgrid/plugins/file_system.h"
 #include "simgrid/s4u/Actor.hpp"
+#include "simgrid/s4u/Engine.hpp"
 #include "src/surf/HostImpl.hpp"
 #include "src/surf/xml/platf_private.hpp"
 #include "xbt/config.hpp"
@@ -27,8 +28,9 @@ simgrid::xbt::Extension<Host, FileDescriptorHostExt> FileDescriptorHostExt::EXTE
 
 File::File(const std::string& fullpath, void* userdata) : File(fullpath, Host::current(), userdata){};
 
-File::File(const std::string& fullpath, sg_host_t host, void* userdata) : fullpath_(fullpath), userdata_(userdata)
+File::File(const std::string& fullpath, sg_host_t host, void* userdata) : fullpath_(fullpath)
 {
+  this->set_data(userdata);
   // this cannot fail because we get a xbt_die if the mountpoint does not exist
   if (not host->get_mounted_storages().empty()) {
     Storage* st                  = nullptr;
@@ -57,21 +59,26 @@ File::File(const std::string& fullpath, sg_host_t host, void* userdata) : fullpa
     Disk* d                      = nullptr;
     size_t longest_prefix_length = 0;
     for (auto const& disk : host->get_disks()) {
-      const char* current_mount_str = disk->get_property("mount");
-      if (current_mount_str) {
-        std::string current_mount = std::string(current_mount_str);
-        mount_point_              = fullpath_.substr(0, current_mount.length());
-        if (mount_point_ == current_mount && current_mount.length() > longest_prefix_length) {
-          /* The current mount name is found in the full path and is bigger than the previous*/
-          longest_prefix_length = current_mount.length();
-          d                     = disk;
-        }
-        if (longest_prefix_length > 0) { /* Mount point found, split fullpath_ into mount_name and path+filename*/
-          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->get_cname());
+      std::string current_mount;
+      if (disk->get_host() != host)
+        current_mount = disk->extension<FileSystemDiskExt>()->get_mount_point(disk->get_host());
+      else
+        current_mount = disk->extension<FileSystemDiskExt>()->get_mount_point();
+      mount_point_              = fullpath_.substr(0, current_mount.length());
+      if (mount_point_ == current_mount && current_mount.length() > longest_prefix_length) {
+        /* The current mount name is found in the full path and is bigger than the previous*/
+        longest_prefix_length = current_mount.length();
+        d                     = disk;
       }
+      if (longest_prefix_length > 0) { /* Mount point found, split fullpath_ into mount_name and path+filename*/
+        mount_point_ = fullpath_.substr(0, longest_prefix_length);
+        if (mount_point_ == std::string("/"))
+          path_ = fullpath_;
+        else
+          path_ = fullpath_.substr(longest_prefix_length, fullpath_.length());
+        XBT_DEBUG("%s + %s", mount_point_.c_str(), path_.c_str());
+      } else
+        xbt_die("Can't find mount point for '%s' on '%s'", fullpath_.c_str(), host->get_cname());
     }
     local_disk_ = d;
   }
@@ -87,7 +94,7 @@ File::File(const std::string& fullpath, sg_host_t host, void* userdata) : fullpa
   ext->file_descriptor_table->pop_back();
 
   XBT_DEBUG("\tOpen file '%s'", path_.c_str());
-  std::map<std::string, sg_size_t>* content;
+  std::map<std::string, sg_size_t>* content = nullptr;
   if (local_storage_)
     content = local_storage_->extension<FileSystemStorageExt>()->get_content();
 
@@ -95,13 +102,15 @@ File::File(const std::string& fullpath, sg_host_t host, void* userdata) : fullpa
     content = local_disk_->extension<FileSystemDiskExt>()->get_content();
 
   // if file does not exist create an empty file
-  auto sz = content->find(path_);
-  if (sz != content->end()) {
-    size_ = sz->second;
-  } else {
-    size_ = 0;
-    content->insert({path_, size_});
-    XBT_DEBUG("File '%s' was not found, file created.", path_.c_str());
+  if (content) {
+    auto sz = content->find(path_);
+    if (sz != content->end()) {
+      size_ = sz->second;
+    } else {
+      size_ = 0;
+      content->insert({path_, size_});
+      XBT_DEBUG("File '%s' was not found, file created.", path_.c_str());
+    }
   }
 }
 
@@ -138,30 +147,31 @@ sg_size_t File::read(sg_size_t size)
   if (size_ == 0) /* Nothing to read, return */
     return 0;
   sg_size_t read_size = 0;
-
+  Host* host          = nullptr;
   if (local_storage_) {
     /* Find the host where the file is physically located and read it */
-    Host* host = local_storage_->get_host();
+    host = local_storage_->get_host();
     XBT_DEBUG("READ %s on disk '%s'", get_path(), local_storage_->get_cname());
     // if the current position is close to the end of the file, we may not be able to read the requested size
     read_size = local_storage_->read(std::min(size, size_ - current_position_));
     current_position_ += read_size;
-
-    if (host->get_name() != Host::current()->get_name() && read_size > 0) {
-      /* 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->send_to(Host::current(), read_size);
-    }
   }
 
   if (local_disk_) {
     /* Find the host where the file is physically located and read it */
+    host = local_disk_->get_host();
     XBT_DEBUG("READ %s on disk '%s'", get_path(), local_disk_->get_cname());
     // if the current position is close to the end of the file, we may not be able to read the requested size
     read_size = local_disk_->read(std::min(size, size_ - current_position_));
     current_position_ += read_size;
   }
 
+  if (host && host->get_name() != Host::current()->get_name() && read_size > 0) {
+    /* 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->send_to(Host::current(), read_size);
+  }
+
   return read_size;
 }
 
@@ -175,24 +185,28 @@ sg_size_t File::write(sg_size_t size, int write_inside)
   if (size == 0) /* Nothing to write, return */
     return 0;
   sg_size_t write_size = 0;
+  Host* host           = nullptr;
 
-  if (local_storage_) {
-    /* Find the host where the file is physically located (remote or local)*/
-    Host* host = local_storage_->get_host();
+  /* Find the host where the file is physically located (remote or local)*/
+  if (local_storage_)
+    host = local_storage_->get_host();
+  if (local_disk_)
+    host = local_disk_->get_host();
 
-    if (host->get_name() != Host::current()->get_name()) {
-      /* 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::current()->send_to(host, size);
-    }
+  if (host && host->get_name() != Host::current()->get_name()) {
+    /* 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::current()->send_to(host, size);
+  }
 
+  if (local_storage_) {
     XBT_DEBUG("WRITE %s on disk '%s'. size '%llu/%llu' '%llu:%llu'", get_path(), local_storage_->get_cname(), size,
               size_, sg_storage_get_size_used(local_storage_), sg_storage_get_size(local_storage_));
     // If the storage is full before even starting to write
     if (sg_storage_get_size_used(local_storage_) >= sg_storage_get_size(local_storage_))
       return 0;
     if (write_inside == 0) {
-      /* Substract the part of the file that might disappear from the used sized on the storage element */
+      /* Subtract the part of the file that might disappear from the used sized on the storage element */
       local_storage_->extension<FileSystemStorageExt>()->decr_used_size(size_ - current_position_);
       write_size = local_storage_->write(size);
       local_storage_->extension<FileSystemStorageExt>()->incr_used_size(write_size);
@@ -217,7 +231,7 @@ sg_size_t File::write(sg_size_t size, int write_inside)
     if (sg_disk_get_size_used(local_disk_) >= sg_disk_get_size(local_disk_))
       return 0;
     if (write_inside == 0) {
-      /* Substract the part of the file that might disappear from the used sized on the storage element */
+      /* Subtract the part of the file that might disappear from the used sized on the storage element */
       local_disk_->extension<FileSystemDiskExt>()->decr_used_size(size_ - current_position_);
       write_size = local_disk_->write(size);
       local_disk_->extension<FileSystemDiskExt>()->incr_used_size(write_size);
@@ -273,20 +287,22 @@ void File::move(const std::string& fullpath)
 {
   /* Check if the new full path is on the same mount point */
   if (fullpath.compare(0, mount_point_.length(), mount_point_) == 0) {
-    std::map<std::string, sg_size_t>* content;
+    std::map<std::string, sg_size_t>* content = nullptr;
     if (local_storage_)
       content = local_storage_->extension<FileSystemStorageExt>()->get_content();
     if (local_disk_)
       content = local_disk_->extension<FileSystemDiskExt>()->get_content();
-    auto sz = content->find(path_);
-    if (sz != content->end()) { // src file exists
-      sg_size_t new_size = sz->second;
-      content->erase(path_);
-      std::string path = fullpath.substr(mount_point_.length(), fullpath.length());
-      content->insert({path.c_str(), new_size});
-      XBT_DEBUG("Move file from %s to %s, size '%llu'", path_.c_str(), fullpath.c_str(), new_size);
-    } else {
-      XBT_WARN("File %s doesn't exist", path_.c_str());
+    if (content) {
+      auto sz = content->find(path_);
+      if (sz != content->end()) { // src file exists
+        sg_size_t new_size = sz->second;
+        content->erase(path_);
+        std::string path = fullpath.substr(mount_point_.length(), fullpath.length());
+        content->insert({path.c_str(), new_size});
+        XBT_DEBUG("Move file from %s to %s, size '%llu'", path_.c_str(), fullpath.c_str(), new_size);
+      } else {
+        XBT_WARN("File %s doesn't exist", path_.c_str());
+      }
     }
   } else {
     XBT_WARN("New full path %s is not on the same mount point: %s.", fullpath.c_str(), mount_point_.c_str());
@@ -296,8 +312,8 @@ void File::move(const std::string& fullpath)
 int File::unlink()
 {
   /* Check if the file is on local storage */
-  std::map<std::string, sg_size_t>* content;
-  const char* name = nullptr;
+  std::map<std::string, sg_size_t>* content = nullptr;
+  const char* name = "";
   if (local_storage_) {
     content = local_storage_->extension<FileSystemStorageExt>()->get_content();
     name    = local_storage_->get_cname();
@@ -307,7 +323,7 @@ int File::unlink()
     name    = local_disk_->get_cname();
   }
 
-  if (content->find(path_) == content->end()) {
+  if (not content || content->find(path_) == content->end()) {
     XBT_WARN("File %s is not on disk %s. Impossible to unlink", path_.c_str(), name);
     return -1;
   } else {
@@ -329,7 +345,7 @@ int File::unlink()
 int File::remote_copy(sg_host_t host, const char* fullpath)
 {
   /* Find the host where the file is physically located and read it */
-  Host* src_host;
+  Host* src_host = nullptr;
   if (local_storage_) {
     src_host = local_storage_->get_host();
     XBT_DEBUG("READ %s on disk '%s'", get_path(), local_storage_->get_cname());
@@ -379,15 +395,12 @@ int File::remote_copy(sg_host_t host, const char* fullpath)
     Disk* dst_disk               = nullptr;
 
     for (auto const& disk : host->get_disks()) {
-      const char* current_mount_str = disk->get_property("mount");
-      if (current_mount_str) {
-        std::string current_mount = std::string(current_mount_str);
-        std::string mount_point   = std::string(fullpath).substr(0, current_mount.length());
-        if (mount_point == current_mount && current_mount.length() > longest_prefix_length) {
-          /* The current mount name is found in the full path and is bigger than the previous*/
-          longest_prefix_length = current_mount.length();
-          dst_disk              = disk;
-        }
+      std::string current_mount = disk->extension<FileSystemDiskExt>()->get_mount_point();
+      std::string mount_point   = std::string(fullpath).substr(0, current_mount.length());
+      if (mount_point == current_mount && current_mount.length() > longest_prefix_length) {
+        /* The current mount name is found in the full path and is bigger than the previous*/
+        longest_prefix_length = current_mount.length();
+        dst_disk              = disk;
       }
     }
 
@@ -397,9 +410,11 @@ int File::remote_copy(sg_host_t host, const char* fullpath)
     }
   }
 
-  XBT_DEBUG("Initiate data transfer of %llu bytes between %s and %s.", read_size, src_host->get_cname(),
-            dst_host->get_cname());
-  src_host->send_to(dst_host, read_size);
+  if (src_host) {
+    XBT_DEBUG("Initiate data transfer of %llu bytes between %s and %s.", read_size, src_host->get_cname(),
+              dst_host->get_cname());
+    src_host->send_to(dst_host, read_size);
+  }
 
   /* Create file on remote host, write it and close it */
   File* fd = new File(fullpath, dst_host, nullptr);
@@ -424,8 +439,16 @@ int File::remote_move(sg_host_t host, const char* fullpath)
 FileSystemDiskExt::FileSystemDiskExt(simgrid::s4u::Disk* ptr)
 {
   const char* size_str    = ptr->get_property("size");
+  if (size_str)
+    size_ = surf_parse_get_size(size_str, "disk size", ptr->get_name());
+
+  const char* current_mount_str = ptr->get_property("mount");
+  if (current_mount_str)
+    mount_point_ = std::string(current_mount_str);
+  else
+    mount_point_ = std::string("/");
+
   const char* content_str = ptr->get_property("content");
-  size_                   = size_str ? surf_parse_get_size(size_str, "disk size", ptr->get_name()) : 0;
   if (content_str)
     content_.reset(parse_content(content_str));
 }
@@ -510,6 +533,51 @@ static void on_host_creation(simgrid::s4u::Host& host)
   host.extension_set<FileDescriptorHostExt>(new FileDescriptorHostExt());
 }
 
+static void on_platform_created()
+{
+  for (auto const& host : simgrid::s4u::Engine::get_instance()->get_all_hosts()) {
+    const char* remote_disk_str = host->get_property("remote_disk");
+    if (remote_disk_str) {
+      std::vector<std::string> tokens;
+      boost::split(tokens, remote_disk_str, boost::is_any_of(":"));
+      std::string mount_point         = tokens[0];
+      simgrid::s4u::Host* remote_host = simgrid::s4u::Host::by_name_or_null(tokens[2]);
+      xbt_assert(remote_host, "You're trying to access a host that does not exist. Please check your platform file");
+
+      simgrid::s4u::Disk* disk = nullptr;
+      for (auto const& d : remote_host->get_disks())
+        if (d->get_name() == tokens[1]) {
+          disk = d;
+          break;
+        }
+
+      xbt_assert(disk, "You're trying to mount a disk that does not exist. Please check your platform file");
+      disk->extension<FileSystemDiskExt>()->add_remote_mount(remote_host, mount_point);
+      host->add_disk(disk);
+
+      XBT_DEBUG("Host '%s' wants to mount a remote disk: %s of %s mounted on %s", host->get_cname(), disk->get_cname(),
+                remote_host->get_cname(), mount_point.c_str());
+      XBT_DEBUG("Host '%s' now has %zu disks", host->get_cname(), host->get_disks().size());
+    }
+  }
+}
+
+static void on_simulation_end()
+{
+  XBT_DEBUG("Simulation is over, time to unregister remote disks if any");
+  for (auto const& host : simgrid::s4u::Engine::get_instance()->get_all_hosts()) {
+    const char* remote_disk_str = host->get_property("remote_disk");
+    if (remote_disk_str) {
+      std::vector<std::string> tokens;
+      boost::split(tokens, remote_disk_str, boost::is_any_of(":"));
+      XBT_DEBUG("Host '%s' wants to unmount a remote disk: %s of %s mounted on %s", host->get_cname(),
+                tokens[1].c_str(), tokens[2].c_str(), tokens[0].c_str());
+      host->remove_disk(tokens[1]);
+      XBT_DEBUG("Host '%s' now has %zu disks", host->get_cname(), host->get_disks().size());
+    }
+  }
+}
+
 /* **************************** Public interface *************************** */
 void sg_storage_file_system_init()
 {
@@ -531,6 +599,8 @@ void sg_storage_file_system_init()
     FileDescriptorHostExt::EXTENSION_ID = simgrid::s4u::Host::extension_create<FileDescriptorHostExt>();
     simgrid::s4u::Host::on_creation.connect(&on_host_creation);
   }
+  simgrid::s4u::Engine::on_platform_created.connect(&on_platform_created);
+  simgrid::s4u::Engine::on_simulation_end.connect(&on_simulation_end);
 }
 
 sg_file_t sg_file_open(const char* fullpath, void* data)
@@ -571,12 +641,12 @@ void sg_file_dump(sg_file_t fd)
 
 void* sg_file_get_data(sg_file_t fd)
 {
-  return fd->get_userdata();
+  return fd->get_data();
 }
 
 void sg_file_set_data(sg_file_t fd, void* data)
 {
-  fd->set_userdata(data);
+  fd->set_data(data);
 }
 
 /**
@@ -649,6 +719,11 @@ sg_size_t sg_disk_get_size(sg_disk_t d)
   return d->extension<FileSystemDiskExt>()->get_size();
 }
 
+const char* sg_disk_get_mount_point(sg_disk_t d)
+{
+  return d->extension<FileSystemDiskExt>()->get_mount_point();
+}
+
 sg_size_t sg_storage_get_size_free(sg_storage_t st)
 {
   return st->extension<FileSystemStorageExt>()->get_size() - st->extension<FileSystemStorageExt>()->get_used_size();
@@ -673,7 +748,7 @@ xbt_dict_t sg_storage_get_content(sg_storage_t storage)
   for (auto const& entry : *content) {
     sg_size_t* psize = new sg_size_t;
     *psize           = entry.second;
-    xbt_dict_set(content_as_dict, entry.first.c_str(), psize, nullptr);
+    xbt_dict_set(content_as_dict, entry.first.c_str(), psize);
   }
   return content_as_dict;
 }
@@ -683,7 +758,7 @@ xbt_dict_t sg_host_get_storage_content(sg_host_t host)
   xbt_assert((host != nullptr), "Invalid parameters");
   xbt_dict_t contents = xbt_dict_new_homogeneous(nullptr);
   for (auto const& elm : host->get_mounted_storages())
-    xbt_dict_set(contents, elm.first.c_str(), sg_storage_get_content(elm.second), nullptr);
+    xbt_dict_set(contents, elm.first.c_str(), sg_storage_get_content(elm.second));
 
   return contents;
 }