-/* Copyright (c) 2015-2017. The SimGrid Team. All rights reserved. */
+/* Copyright (c) 2015-2019. 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;
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){};
+File::File(const std::string& fullpath, void* userdata) : File(fullpath, Host::current(), userdata){};
-File::File(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), userdata_(userdata)
{
// 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()) {
+ for (auto const& mnt : host->get_mounted_storages()) {
XBT_DEBUG("See '%s'", mnt.first.c_str());
- mount_point_ = fullpath.substr(0, mnt.first.length());
+ mount_point_ = fullpath_.substr(0, mnt.first.length());
if (mount_point_ == mnt.first && mnt.first.length() > longest_prefix_length) {
/* The current mount name is found in the full path and is bigger than the previous*/
st = mnt.second;
}
}
- 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());
+ 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->getCname());
+ xbt_die("Can't find mount point for '%s' on '%s'", fullpath_.c_str(), host->get_cname());
- localStorage = st;
+ local_storage_ = st;
// assign a file descriptor id to the newly opened File
FileDescriptorHostExt* ext = host->extension<simgrid::s4u::FileDescriptorHostExt>();
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();
+ std::map<std::string, sg_size_t>* content = local_storage_->extension<FileSystemStorageExt>()->get_content();
// if file does not exist create an empty file
auto sz = content->find(path_);
if (sz != content->end()) {
"\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);
+ get_path(), size_, mount_point_.c_str(), local_storage_->get_cname(), local_storage_->get_type(), 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 = 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
- sg_size_t read_size = localStorage->read(std::min(size, size_ - current_position_));
+ sg_size_t read_size = local_storage_->read(std::min(size, size_ - current_position_));
current_position_ += read_size;
+
+ 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(), read_size);
+ std::vector<Host*> m_host_list = {Host::current(), host};
+ std::vector<double> flops_amount = {0., 0.};
+ std::vector<double> bytes_amount = {0., 0., static_cast<double>(read_size), 0.};
+
+ this_actor::parallel_execute(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
+ * @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 = local_storage_->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);
+ std::vector<Host*> m_host_list = {Host::current(), host};
+ std::vector<double> flops_amount = {0, 0};
+ std::vector<double> bytes_amount = {0, static_cast<double>(size), 0, 0};
+
+ this_actor::parallel_execute(m_host_list, flops_amount, bytes_amount);
+ }
+
+ XBT_DEBUG("WRITE %s on disk '%s'. size '%llu/%llu'", get_path(), local_storage_->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))
+ if (sg_storage_get_size_used(local_storage_) >= sg_storage_get_size(local_storage_))
return 0;
/* Substract the part of the file that might disappear from the used sized on the storage element */
- localStorage->extension<FileSystemStorageExt>()->decrUsedSize(size_ - current_position_);
+ local_storage_->extension<FileSystemStorageExt>()->decr_used_size(size_ - current_position_);
- sg_size_t write_size = localStorage->write(size);
- localStorage->extension<FileSystemStorageExt>()->incrUsedSize(write_size);
+ sg_size_t write_size = local_storage_->write(size);
+ local_storage_->extension<FileSystemStorageExt>()->incr_used_size(write_size);
current_position_ += write_size;
size_ = current_position_;
- std::map<std::string, sg_size_t>* content = localStorage->extension<FileSystemStorageExt>()->getContent();
+ std::map<std::string, sg_size_t>* content = local_storage_->extension<FileSystemStorageExt>()->get_content();
content->erase(path_);
content->insert({path_, size_});
return current_position_;
}
-void File::move(std::string fullpath)
+void File::move(const std::string& fullpath)
{
/* Check if the new full path is on the same mount point */
- if (not strncmp(mount_point_.c_str(), fullpath.c_str(), mount_point_.length())) {
- std::map<std::string, sg_size_t>* content = localStorage->extension<FileSystemStorageExt>()->getContent();
+ if (fullpath.compare(0, mount_point_.length(), mount_point_) == 0) {
+ std::map<std::string, sg_size_t>* content = local_storage_->extension<FileSystemStorageExt>()->get_content();
auto sz = content->find(path_);
if (sz != content->end()) { // src file exists
sg_size_t new_size = sz->second;
int File::unlink()
{
/* Check if the file is on local storage */
- std::map<std::string, sg_size_t>* content = localStorage->extension<FileSystemStorageExt>()->getContent();
+ std::map<std::string, sg_size_t>* content = local_storage_->extension<FileSystemStorageExt>()->get_content();
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(), local_storage_->get_cname());
return -1;
} else {
- XBT_DEBUG("UNLINK %s on disk '%s'", path_.c_str(), localStorage->getCname());
- localStorage->extension<FileSystemStorageExt>()->decrUsedSize(size_);
+ XBT_DEBUG("UNLINK %s on disk '%s'", path_.c_str(), local_storage_->get_cname());
+ local_storage_->extension<FileSystemStorageExt>()->decr_used_size(size_);
// Remove the file from storage
content->erase(fullpath_);
}
}
+int File::remote_copy(sg_host_t host, const char* fullpath)
+{
+ /* Find the host where the file is physically located and read it */
+ Storage* storage_src = local_storage_;
+ Host* src_host = storage_src->get_host();
+ seek(0, SEEK_SET);
+ 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
+ sg_size_t read_size = local_storage_->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->get_mounted_storages()) {
+ 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->get_host();
+ } 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->get_host()->get_cname());
+ std::vector<Host*> m_host_list = {src_host, dst_host};
+ std::vector<double> flops_amount = {0, 0};
+ std::vector<double> bytes_amount = {0, static_cast<double>(read_size), 0, 0};
+
+ this_actor::parallel_execute(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->local_storage_->write(read_size);
+ fd->local_storage_->extension<FileSystemStorageExt>()->incr_used_size(write_size);
+ (*(fd->local_storage_->extension<FileSystemStorageExt>()->get_content()))[path_] = size_;
+ delete fd;
+ return 0;
+}
+
+int File::remote_move(sg_host_t host, const char* fullpath)
+{
+ int res = remote_copy(host, fullpath);
+ unlink();
+ return res;
+}
+
FileSystemStorageExt::FileSystemStorageExt(simgrid::s4u::Storage* ptr)
{
- content_ = parseContent(ptr->getImpl()->content_name);
- size_ = ptr->getImpl()->size_;
+ content_ = parse_content(ptr->get_impl()->content_name);
+ size_ = ptr->get_impl()->size_;
}
FileSystemStorageExt::~FileSystemStorageExt()
delete content_;
}
-std::map<std::string, sg_size_t>* FileSystemStorageExt::parseContent(std::string filename)
+std::map<std::string, sg_size_t>* FileSystemStorageExt::parse_content(const std::string& filename)
{
if (filename.empty())
return nullptr;
xbt_assert(tokens.size() == 2, "Parse error in %s: %s", filename.c_str(), line.c_str());
sg_size_t size = std::stoull(tokens.at(1));
- usedSize_ += size;
+ used_size_ += size;
parse_content->insert({tokens.front(), size});
}
} while (not fs->eof());
using simgrid::s4u::FileSystemStorageExt;
using simgrid::s4u::FileDescriptorHostExt;
-static void onStorageCreation(simgrid::s4u::Storage& st)
+static void on_storage_creation(simgrid::s4u::Storage& st)
{
st.extension_set(new FileSystemStorageExt(&st));
}
-static void onStorageDestruction(simgrid::s4u::Storage& st)
-{
- delete st.extension<FileSystemStorageExt>();
-}
-
-static void onHostCreation(simgrid::s4u::Host& host)
+static void on_host_creation(simgrid::s4u::Host& host)
{
host.extension_set<FileDescriptorHostExt>(new FileDescriptorHostExt());
}
/* **************************** Public interface *************************** */
-SG_BEGIN_DECL()
-
void sg_storage_file_system_init()
{
+ 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);
+ simgrid::s4u::Storage::on_creation.connect(&on_storage_creation);
}
if (not FileDescriptorHostExt::EXTENSION_ID.valid()) {
FileDescriptorHostExt::EXTENSION_ID = simgrid::s4u::Host::extension_create<FileDescriptorHostExt>();
- simgrid::s4u::Host::onCreation.connect(&onHostCreation);
+ simgrid::s4u::Host::on_creation.connect(&on_host_creation);
}
}
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)
{
xbt_assert((fd != nullptr), "Invalid file descriptor");
- return fd->getPath();
+ return fd->get_path();
}
sg_size_t sg_file_get_size(sg_file_t fd)
void* sg_file_get_data(sg_file_t fd)
{
- return fd->getUserdata();
+ return fd->get_userdata();
}
void sg_file_set_data(sg_file_t fd, void* data)
{
- fd->setUserdata(data);
+ fd->set_userdata(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
- * \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
+ * @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)
*/
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->remote_copy(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->remote_move(host, fullpath);
+}
+
sg_size_t sg_storage_get_size_free(sg_storage_t st)
{
- return st->extension<FileSystemStorageExt>()->getSize() - st->extension<FileSystemStorageExt>()->getUsedSize();
+ return st->extension<FileSystemStorageExt>()->get_size() - st->extension<FileSystemStorageExt>()->get_used_size();
}
sg_size_t sg_storage_get_size_used(sg_storage_t st)
{
- return st->extension<FileSystemStorageExt>()->getUsedSize();
+ return st->extension<FileSystemStorageExt>()->get_used_size();
}
sg_size_t sg_storage_get_size(sg_storage_t st)
{
- return st->extension<FileSystemStorageExt>()->getSize();
+ return st->extension<FileSystemStorageExt>()->get_size();
}
xbt_dict_t sg_storage_get_content(sg_storage_t storage)
{
- std::map<std::string, sg_size_t>* content = storage->extension<simgrid::s4u::FileSystemStorageExt>()->getContent();
+ std::map<std::string, sg_size_t>* content = storage->extension<simgrid::s4u::FileSystemStorageExt>()->get_content();
// Note: ::operator delete is ok here (no destructor called) since the dict elements are of POD type sg_size_t.
xbt_dict_t content_as_dict = xbt_dict_new_homogeneous(::operator delete);
{
xbt_assert((host != nullptr), "Invalid parameters");
xbt_dict_t contents = xbt_dict_new_homogeneous(nullptr);
- for (auto const& elm : host->getMountedStorages())
+ for (auto const& elm : host->get_mounted_storages())
xbt_dict_set(contents, elm.first.c_str(), sg_storage_get_content(elm.second), nullptr);
return contents;
}
-
-SG_END_DECL()
