src/plugins/file_system/s4u_FileSystem.cpp

   1 /* Copyright (c) 2015-2021. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #include "simgrid/plugins/file_system.h"
   7 #include "simgrid/s4u/Actor.hpp"
   8 #include "simgrid/s4u/Engine.hpp"
   9 #include "src/surf/HostImpl.hpp"
  10 #include "src/surf/xml/platf_private.hpp"
  11 #include "xbt/config.hpp"
  12 #include "xbt/parse_units.hpp"
  13
  14 #include <algorithm>
  15 #include <boost/algorithm/string.hpp>
  16 #include <boost/algorithm/string/join.hpp>
  17 #include <boost/algorithm/string/split.hpp>
  18 #include <fstream>
  19 #include <memory>
  20 #include <numeric>
  21
  22 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_file, s4u, "S4U files");
  23 int sg_storage_max_file_descriptors = 1024;
  24
  25 /** @defgroup plugin_filesystem Plugin FileSystem
  26  *
  27  * This adds the notion of Files on top of the storage notion that provided by the core of SimGrid.
  28  * Activate this plugin at will.
  29  */
  30
  31 namespace simgrid {
  32
  33 template class xbt::Extendable<s4u::File>;
  34
  35 namespace s4u {
  36 simgrid::xbt::Extension<Disk, FileSystemDiskExt> FileSystemDiskExt::EXTENSION_ID;
  37 simgrid::xbt::Extension<Storage, FileSystemStorageExt> FileSystemStorageExt::EXTENSION_ID;
  38 simgrid::xbt::Extension<Host, FileDescriptorHostExt> FileDescriptorHostExt::EXTENSION_ID;
  39
  40 Storage* File::find_local_storage_on(Host* host)
  41 {
  42   Storage* st                  = nullptr;
  43   size_t longest_prefix_length = 0;
  44   XBT_DEBUG("Search for storage name for '%s' on '%s'", fullpath_.c_str(), host->get_cname());
  45
  46   for (auto const& mnt : host->get_mounted_storages()) {
  47     XBT_DEBUG("See '%s'", mnt.first.c_str());
  48     mount_point_ = fullpath_.substr(0, mnt.first.length());
  49
  50     if (mount_point_ == mnt.first && mnt.first.length() > longest_prefix_length) {
  51       /* The current mount name is found in the full path and is bigger than the previous*/
  52       longest_prefix_length = mnt.first.length();
  53       st                    = mnt.second;
  54     }
  55   }
  56   if (longest_prefix_length > 0) { /* Mount point found, split fullpath_ into mount_name and path+filename*/
  57     mount_point_ = fullpath_.substr(0, longest_prefix_length);
  58     path_        = fullpath_.substr(longest_prefix_length, fullpath_.length());
  59   } else
  60     xbt_die("Can't find mount point for '%s' on '%s'", fullpath_.c_str(), host->get_cname());
  61
  62   return st;
  63 }
  64
  65 Disk* File::find_local_disk_on(const Host* host)
  66 {
  67   Disk* d                      = nullptr;
  68   size_t longest_prefix_length = 0;
  69   for (auto const& disk : host->get_disks()) {
  70     std::string current_mount;
  71     if (disk->get_host() != host)
  72       current_mount = disk->extension<FileSystemDiskExt>()->get_mount_point(disk->get_host());
  73     else
  74       current_mount = disk->extension<FileSystemDiskExt>()->get_mount_point();
  75     mount_point_ = fullpath_.substr(0, current_mount.length());
  76     if (mount_point_ == current_mount && current_mount.length() > longest_prefix_length) {
  77       /* The current mount name is found in the full path and is bigger than the previous*/
  78       longest_prefix_length = current_mount.length();
  79       d                     = disk;
  80     }
  81     if (longest_prefix_length > 0) { /* Mount point found, split fullpath_ into mount_name and path+filename*/
  82       mount_point_ = fullpath_.substr(0, longest_prefix_length);
  83       if (mount_point_ == std::string("/"))
  84         path_ = fullpath_;
  85       else
  86         path_ = fullpath_.substr(longest_prefix_length, fullpath_.length());
  87       XBT_DEBUG("%s + %s", mount_point_.c_str(), path_.c_str());
  88     } else
  89       xbt_die("Can't find mount point for '%s' on '%s'", fullpath_.c_str(), host->get_cname());
  90   }
  91   return d;
  92 }
  93
  94 File::File(const std::string& fullpath, void* userdata) : File(fullpath, Host::current(), userdata) {}
  95
  96 File::File(const std::string& fullpath, sg_host_t host, void* userdata) : fullpath_(fullpath)
  97 {
  98   kernel::actor::simcall([this, &host, userdata] {
  99     this->set_data(userdata);
 100     // this cannot fail because we get a xbt_die if the mountpoint does not exist
 101     if (not host->get_mounted_storages().empty()) {
 102       local_storage_ = find_local_storage_on(host);
 103     }
 104     if (not host->get_disks().empty()) {
 105       local_disk_ = find_local_disk_on(host);
 106     }
 107
 108     // assign a file descriptor id to the newly opened File
 109     auto* ext = host->extension<simgrid::s4u::FileDescriptorHostExt>();
 110     if (ext->file_descriptor_table == nullptr) {
 111       ext->file_descriptor_table = std::make_unique<std::vector<int>>(sg_storage_max_file_descriptors);
 112       std::iota(ext->file_descriptor_table->rbegin(), ext->file_descriptor_table->rend(), 0); // Fill with ..., 1, 0.
 113     }
 114     xbt_assert(not ext->file_descriptor_table->empty(), "Too much files are opened! Some have to be closed.");
 115     desc_id = ext->file_descriptor_table->back();
 116     ext->file_descriptor_table->pop_back();
 117
 118     XBT_DEBUG("\tOpen file '%s'", path_.c_str());
 119     std::map<std::string, sg_size_t, std::less<>>* content = nullptr;
 120     if (local_storage_)
 121       content = local_storage_->extension<FileSystemStorageExt>()->get_content();
 122
 123     if (local_disk_)
 124       content = local_disk_->extension<FileSystemDiskExt>()->get_content();
 125
 126     // if file does not exist create an empty file
 127     if (content) {
 128       auto sz = content->find(path_);
 129       if (sz != content->end()) {
 130         size_ = sz->second;
 131       } else {
 132         size_ = 0;
 133         content->insert({path_, size_});
 134         XBT_DEBUG("File '%s' was not found, file created.", path_.c_str());
 135       }
 136     }
 137   });
 138 }
 139
 140 File::~File()
 141 {
 142   std::vector<int>* desc_table =
 143       Host::current()->extension<simgrid::s4u::FileDescriptorHostExt>()->file_descriptor_table.get();
 144   kernel::actor::simcall([this, desc_table] { desc_table->push_back(this->desc_id); });
 145 }
 146
 147 void File::dump() const
 148 {
 149   if (local_storage_)
 150     XBT_INFO("File Descriptor information:\n"
 151              "\t\tFull path: '%s'\n"
 152              "\t\tSize: %llu\n"
 153              "\t\tMount point: '%s'\n"
 154              "\t\tStorage Id: '%s'\n"
 155              "\t\tStorage Type: '%s'\n"
 156              "\t\tFile Descriptor Id: %d",
 157              get_path(), size_, mount_point_.c_str(), local_storage_->get_cname(), local_storage_->get_type(), desc_id);
 158   if (local_disk_)
 159     XBT_INFO("File Descriptor information:\n"
 160              "\t\tFull path: '%s'\n"
 161              "\t\tSize: %llu\n"
 162              "\t\tMount point: '%s'\n"
 163              "\t\tDisk Id: '%s'\n"
 164              "\t\tHost Id: '%s'\n"
 165              "\t\tFile Descriptor Id: %d",
 166              get_path(), size_, mount_point_.c_str(), local_disk_->get_cname(), local_disk_->get_host()->get_cname(),
 167              desc_id);
 168 }
 169
 170 sg_size_t File::read(sg_size_t size)
 171 {
 172   if (size_ == 0) /* Nothing to read, return */
 173     return 0;
 174   sg_size_t read_size = 0;
 175   Host* host          = nullptr;
 176   if (local_storage_) {
 177     /* Find the host where the file is physically located and read it */
 178     host = local_storage_->get_host();
 179     XBT_DEBUG("READ %s on disk '%s'", get_path(), local_storage_->get_cname());
 180     // if the current position is close to the end of the file, we may not be able to read the requested size
 181     read_size = local_storage_->read(std::min(size, size_ - current_position_));
 182     current_position_ += read_size;
 183   }
 184
 185   if (local_disk_) {
 186     /* Find the host where the file is physically located and read it */
 187     host = local_disk_->get_host();
 188     XBT_DEBUG("READ %s on disk '%s'", get_path(), local_disk_->get_cname());
 189     // if the current position is close to the end of the file, we may not be able to read the requested size
 190     read_size = local_disk_->read(std::min(size, size_ - current_position_));
 191     current_position_ += read_size;
 192   }
 193
 194   if (host && host->get_name() != Host::current()->get_name() && read_size > 0) {
 195     /* the file is hosted on a remote host, initiate a communication between src and dest hosts for data transfer */
 196     XBT_DEBUG("File is on %s remote host, initiate data transfer of %llu bytes.", host->get_cname(), read_size);
 197     host->sendto(Host::current(), read_size);
 198   }
 199
 200   return read_size;
 201 }
 202
 203 /** @brief Write into a file (local or remote)
 204  * @ingroup plugin_filesystem
 205  *
 206  * @param size of the file to write
 207  * @return the number of bytes successfully write or -1 if an error occurred
 208  */
 209 sg_size_t File::write_on_disk(sg_size_t size, bool write_inside)
 210 {
 211   sg_size_t write_size = 0;
 212   /* Find the host where the file is physically located (remote or local)*/
 213   Host* host = local_disk_->get_host();
 214
 215   if (host && host->get_name() != Host::current()->get_name()) {
 216     /* the file is hosted on a remote host, initiate a communication between src and dest hosts for data transfer */
 217     XBT_DEBUG("File is on %s remote host, initiate data transfer of %llu bytes.", host->get_cname(), size);
 218     Host::current()->sendto(host, size);
 219   }
 220   XBT_DEBUG("WRITE %s on disk '%s'. size '%llu/%llu' '%llu:%llu'", get_path(), local_disk_->get_cname(), size, size_,
 221             sg_disk_get_size_used(local_disk_), sg_disk_get_size(local_disk_));
 222   // If the storage is full before even starting to write
 223   if (sg_disk_get_size_used(local_disk_) >= sg_disk_get_size(local_disk_))
 224     return 0;
 225   if (not write_inside) {
 226     /* Subtract the part of the file that might disappear from the used sized on the storage element */
 227     local_disk_->extension<FileSystemDiskExt>()->decr_used_size(size_ - current_position_);
 228     write_size = local_disk_->write(size);
 229     local_disk_->extension<FileSystemDiskExt>()->incr_used_size(write_size);
 230     current_position_ += write_size;
 231     size_ = current_position_;
 232   } else {
 233     write_size = local_disk_->write(size);
 234     current_position_ += write_size;
 235     if (current_position_ > size_)
 236       size_ = current_position_;
 237   }
 238   kernel::actor::simcall([this] {
 239     std::map<std::string, sg_size_t, std::less<>>* content = local_disk_->extension<FileSystemDiskExt>()->get_content();
 240
 241     content->erase(path_);
 242     content->insert({path_, size_});
 243   });
 244
 245   return write_size;
 246 }
 247
 248 sg_size_t File::write_on_storage(sg_size_t size, bool write_inside)
 249 {
 250   sg_size_t write_size = 0;
 251   /* Find the host where the file is physically located (remote or local)*/
 252   Host* host = local_storage_->get_host();
 253
 254   if (host && host->get_name() != Host::current()->get_name()) {
 255     /* the file is hosted on a remote host, initiate a communication between src and dest hosts for data transfer */
 256     XBT_DEBUG("File is on %s remote host, initiate data transfer of %llu bytes.", host->get_cname(), size);
 257     Host::current()->sendto(host, size);
 258   }
 259
 260   XBT_DEBUG("WRITE %s on disk '%s'. size '%llu/%llu' '%llu:%llu'", get_path(), local_storage_->get_cname(), size, size_,
 261             sg_storage_get_size_used(local_storage_), sg_storage_get_size(local_storage_));
 262   // If the storage is full before even starting to write
 263   if (sg_storage_get_size_used(local_storage_) >= sg_storage_get_size(local_storage_))
 264     return 0;
 265   if (not write_inside) {
 266     /* Subtract the part of the file that might disappear from the used sized on the storage element */
 267     local_storage_->extension<FileSystemStorageExt>()->decr_used_size(size_ - current_position_);
 268     write_size = local_storage_->write(size);
 269     local_storage_->extension<FileSystemStorageExt>()->incr_used_size(write_size);
 270     current_position_ += write_size;
 271     size_ = current_position_;
 272   } else {
 273     write_size = local_storage_->write(size);
 274     current_position_ += write_size;
 275     if (current_position_ > size_)
 276       size_ = current_position_;
 277   }
 278   kernel::actor::simcall([this] {
 279     std::map<std::string, sg_size_t, std::less<>>* content =
 280         local_storage_->extension<FileSystemStorageExt>()->get_content();
 281
 282     content->erase(path_);
 283     content->insert({path_, size_});
 284   });
 285
 286   return write_size;
 287 }
 288
 289 sg_size_t File::write(sg_size_t size, bool write_inside)
 290 {
 291   if (size == 0) /* Nothing to write, return */
 292     return 0;
 293
 294   if (local_disk_)
 295     return write_on_disk(size, write_inside);
 296   if (local_storage_)
 297     return write_on_storage(size, write_inside);
 298
 299   return 0;
 300 }
 301
 302 sg_size_t File::size() const
 303 {
 304   return size_;
 305 }
 306
 307 void File::seek(sg_offset_t offset)
 308 {
 309   current_position_ = offset;
 310 }
 311
 312 void File::seek(sg_offset_t offset, int origin)
 313 {
 314   switch (origin) {
 315     case SEEK_SET:
 316       current_position_ = offset;
 317       break;
 318     case SEEK_CUR:
 319       current_position_ += offset;
 320       break;
 321     case SEEK_END:
 322       current_position_ = size_ + offset;
 323       break;
 324     default:
 325       break;
 326   }
 327 }
 328
 329 sg_size_t File::tell() const
 330 {
 331   return current_position_;
 332 }
 333
 334 void File::move(const std::string& fullpath) const
 335 {
 336   /* Check if the new full path is on the same mount point */
 337   if (fullpath.compare(0, mount_point_.length(), mount_point_) == 0) {
 338     std::map<std::string, sg_size_t, std::less<>>* content = nullptr;
 339     if (local_storage_)
 340       content = local_storage_->extension<FileSystemStorageExt>()->get_content();
 341     if (local_disk_)
 342       content = local_disk_->extension<FileSystemDiskExt>()->get_content();
 343     if (content) {
 344       auto sz = content->find(path_);
 345       if (sz != content->end()) { // src file exists
 346         sg_size_t new_size = sz->second;
 347         content->erase(path_);
 348         std::string path = fullpath.substr(mount_point_.length(), fullpath.length());
 349         content->insert({path.c_str(), new_size});
 350         XBT_DEBUG("Move file from %s to %s, size '%llu'", path_.c_str(), fullpath.c_str(), new_size);
 351       } else {
 352         XBT_WARN("File %s doesn't exist", path_.c_str());
 353       }
 354     }
 355   } else {
 356     XBT_WARN("New full path %s is not on the same mount point: %s.", fullpath.c_str(), mount_point_.c_str());
 357   }
 358 }
 359
 360 int File::unlink() const
 361 {
 362   /* Check if the file is on local storage */
 363   std::map<std::string, sg_size_t, std::less<>>* content = nullptr;
 364   const char* name = "";
 365   if (local_storage_) {
 366     content = local_storage_->extension<FileSystemStorageExt>()->get_content();
 367     name    = local_storage_->get_cname();
 368   }
 369   if (local_disk_) {
 370     content = local_disk_->extension<FileSystemDiskExt>()->get_content();
 371     name    = local_disk_->get_cname();
 372   }
 373
 374   if (not content || content->find(path_) == content->end()) {
 375     XBT_WARN("File %s is not on disk %s. Impossible to unlink", path_.c_str(), name);
 376     return -1;
 377   } else {
 378     XBT_DEBUG("UNLINK %s on disk '%s'", path_.c_str(), name);
 379
 380     if (local_storage_)
 381       local_storage_->extension<FileSystemStorageExt>()->decr_used_size(size_);
 382
 383     if (local_disk_)
 384       local_disk_->extension<FileSystemDiskExt>()->decr_used_size(size_);
 385
 386     // Remove the file from storage
 387     content->erase(path_);
 388
 389     return 0;
 390   }
 391 }
 392
 393 int File::remote_copy(sg_host_t host, const std::string& fullpath)
 394 {
 395   /* Find the host where the file is physically located and read it */
 396   Host* src_host = nullptr;
 397   if (local_storage_) {
 398     src_host = local_storage_->get_host();
 399     XBT_DEBUG("READ %s on disk '%s'", get_path(), local_storage_->get_cname());
 400   }
 401
 402   if (local_disk_) {
 403     src_host = local_disk_->get_host();
 404     XBT_DEBUG("READ %s on disk '%s'", get_path(), local_disk_->get_cname());
 405   }
 406
 407   seek(0, SEEK_SET);
 408   // if the current position is close to the end of the file, we may not be able to read the requested size
 409   sg_size_t read_size = 0;
 410   if (local_storage_)
 411     read_size = local_storage_->read(size_);
 412   if (local_disk_)
 413     read_size = local_disk_->read(size_);
 414
 415   current_position_ += read_size;
 416
 417   Host* dst_host = host;
 418   size_t longest_prefix_length = 0;
 419   if (local_storage_) {
 420     /* Find the host that owns the storage where the file has to be copied */
 421     const Storage* storage_dest = nullptr;
 422
 423     for (auto const& elm : host->get_mounted_storages()) {
 424       std::string mount_point = std::string(fullpath).substr(0, elm.first.size());
 425       if (mount_point == elm.first && elm.first.length() > longest_prefix_length) {
 426         /* The current mount name is found in the full path and is bigger than the previous*/
 427         longest_prefix_length = elm.first.length();
 428         storage_dest          = elm.second;
 429       }
 430     }
 431
 432     if (storage_dest != nullptr) {
 433       /* Mount point found, retrieve the host the storage is attached to */
 434       dst_host = storage_dest->get_host();
 435     } else {
 436       XBT_WARN("Can't find mount point for '%s' on destination host '%s'", fullpath.c_str(), host->get_cname());
 437       return -1;
 438     }
 439   }
 440
 441   if (local_disk_) {
 442     const Disk* dst_disk = nullptr;
 443
 444     for (auto const& disk : host->get_disks()) {
 445       std::string current_mount = disk->extension<FileSystemDiskExt>()->get_mount_point();
 446       std::string mount_point   = std::string(fullpath).substr(0, current_mount.length());
 447       if (mount_point == current_mount && current_mount.length() > longest_prefix_length) {
 448         /* The current mount name is found in the full path and is bigger than the previous*/
 449         longest_prefix_length = current_mount.length();
 450         dst_disk              = disk;
 451       }
 452     }
 453
 454     if (dst_disk == nullptr) {
 455       XBT_WARN("Can't find mount point for '%s' on destination host '%s'", fullpath.c_str(), host->get_cname());
 456       return -1;
 457     }
 458   }
 459
 460   if (src_host) {
 461     XBT_DEBUG("Initiate data transfer of %llu bytes between %s and %s.", read_size, src_host->get_cname(),
 462               dst_host->get_cname());
 463     src_host->sendto(dst_host, read_size);
 464   }
 465
 466   /* Create file on remote host, write it and close it */
 467   File fd(fullpath, dst_host, nullptr);
 468   if (local_storage_) {
 469     sg_size_t write_size = fd.local_storage_->write(read_size);
 470     fd.local_storage_->extension<FileSystemStorageExt>()->incr_used_size(write_size);
 471     (*(fd.local_storage_->extension<FileSystemStorageExt>()->get_content()))[path_] = size_;
 472   }
 473   if (local_disk_)
 474     fd.write(read_size);
 475   return 0;
 476 }
 477
 478 int File::remote_move(sg_host_t host, const std::string& fullpath)
 479 {
 480   int res = remote_copy(host, fullpath);
 481   unlink();
 482   return res;
 483 }
 484
 485 FileSystemDiskExt::FileSystemDiskExt(const Disk* ptr)
 486 {
 487   const char* size_str    = ptr->get_property("size");
 488   std::string dummyfile;
 489   if (size_str)
 490     size_ = surf_parse_get_size(dummyfile, -1, size_str, "disk size", ptr->get_name());
 491
 492   const char* current_mount_str = ptr->get_property("mount");
 493   if (current_mount_str)
 494     mount_point_ = std::string(current_mount_str);
 495   else
 496     mount_point_ = std::string("/");
 497
 498   const char* content_str = ptr->get_property("content");
 499   if (content_str)
 500     content_.reset(parse_content(content_str));
 501 }
 502
 503 FileSystemStorageExt::FileSystemStorageExt(const Storage* ptr) : size_(ptr->get_impl()->size_)
 504 {
 505   content_.reset(parse_content(ptr->get_impl()->content_name_));
 506 }
 507
 508 std::map<std::string, sg_size_t, std::less<>>* FileSystemDiskExt::parse_content(const std::string& filename)
 509 {
 510   if (filename.empty())
 511     return nullptr;
 512
 513   auto* parse_content = new std::map<std::string, sg_size_t, std::less<>>();
 514
 515   auto fs = std::unique_ptr<std::ifstream>(surf_ifsopen(filename));
 516   xbt_assert(not fs->fail(), "Cannot open file '%s' (path=%s)", filename.c_str(),
 517              (boost::join(surf_path, ":")).c_str());
 518
 519   std::string line;
 520   std::vector<std::string> tokens;
 521   do {
 522     std::getline(*fs, line);
 523     boost::trim(line);
 524     if (line.length() > 0) {
 525       boost::split(tokens, line, boost::is_any_of(" \t"), boost::token_compress_on);
 526       xbt_assert(tokens.size() == 2, "Parse error in %s: %s", filename.c_str(), line.c_str());
 527       sg_size_t size = std::stoull(tokens.at(1));
 528
 529       used_size_ += size;
 530       parse_content->insert({tokens.front(), size});
 531     }
 532   } while (not fs->eof());
 533   return parse_content;
 534 }
 535
 536 std::map<std::string, sg_size_t, std::less<>>* FileSystemStorageExt::parse_content(const std::string& filename)
 537 {
 538   if (filename.empty())
 539     return nullptr;
 540
 541   auto* parse_content = new std::map<std::string, sg_size_t, std::less<>>();
 542
 543   auto fs = std::unique_ptr<std::ifstream>(surf_ifsopen(filename));
 544   xbt_assert(not fs->fail(), "Cannot open file '%s' (path=%s)", filename.c_str(),
 545              (boost::join(surf_path, ":")).c_str());
 546
 547   std::string line;
 548   std::vector<std::string> tokens;
 549   do {
 550     std::getline(*fs, line);
 551     boost::trim(line);
 552     if (line.length() > 0) {
 553       boost::split(tokens, line, boost::is_any_of(" \t"), boost::token_compress_on);
 554       xbt_assert(tokens.size() == 2, "Parse error in %s: %s", filename.c_str(), line.c_str());
 555       sg_size_t size = std::stoull(tokens.at(1));
 556
 557       used_size_ += size;
 558       parse_content->insert({tokens.front(), size});
 559     }
 560   } while (not fs->eof());
 561   return parse_content;
 562 }
 563
 564 void FileSystemStorageExt::decr_used_size(sg_size_t size)
 565 {
 566   simgrid::kernel::actor::simcall([this, size] { used_size_ -= size; });
 567 }
 568
 569 void FileSystemStorageExt::incr_used_size(sg_size_t size)
 570 {
 571   simgrid::kernel::actor::simcall([this, size] { used_size_ += size; });
 572 }
 573
 574 void FileSystemDiskExt::decr_used_size(sg_size_t size)
 575 {
 576   simgrid::kernel::actor::simcall([this, size] { used_size_ -= size; });
 577 }
 578
 579 void FileSystemDiskExt::incr_used_size(sg_size_t size)
 580 {
 581   simgrid::kernel::actor::simcall([this, size] { used_size_ += size; });
 582 }
 583 }
 584 }
 585
 586 using simgrid::s4u::FileDescriptorHostExt;
 587 using simgrid::s4u::FileSystemDiskExt;
 588 using simgrid::s4u::FileSystemStorageExt;
 589
 590 static void on_disk_creation(simgrid::s4u::Disk& d)
 591 {
 592   d.extension_set(new FileSystemDiskExt(&d));
 593 }
 594 static void on_storage_creation(simgrid::s4u::Storage& st)
 595 {
 596   st.extension_set(new FileSystemStorageExt(&st));
 597 }
 598
 599 static void on_host_creation(simgrid::s4u::Host& host)
 600 {
 601   host.extension_set<FileDescriptorHostExt>(new FileDescriptorHostExt());
 602 }
 603
 604 static void on_platform_created()
 605 {
 606   for (auto const& host : simgrid::s4u::Engine::get_instance()->get_all_hosts()) {
 607     const char* remote_disk_str = host->get_property("remote_disk");
 608     if (remote_disk_str) {
 609       std::vector<std::string> tokens;
 610       boost::split(tokens, remote_disk_str, boost::is_any_of(":"));
 611       std::string mount_point         = tokens[0];
 612       simgrid::s4u::Host* remote_host = simgrid::s4u::Host::by_name_or_null(tokens[2]);
 613       xbt_assert(remote_host, "You're trying to access a host that does not exist. Please check your platform file");
 614
 615       const simgrid::s4u::Disk* disk = nullptr;
 616       for (auto const& d : remote_host->get_disks())
 617         if (d->get_name() == tokens[1]) {
 618           disk = d;
 619           break;
 620         }
 621
 622       xbt_assert(disk, "You're trying to mount a disk that does not exist. Please check your platform file");
 623       disk->extension<FileSystemDiskExt>()->add_remote_mount(remote_host, mount_point);
 624       host->add_disk(disk);
 625
 626       XBT_DEBUG("Host '%s' wants to mount a remote disk: %s of %s mounted on %s", host->get_cname(), disk->get_cname(),
 627                 remote_host->get_cname(), mount_point.c_str());
 628       XBT_DEBUG("Host '%s' now has %zu disks", host->get_cname(), host->get_disks().size());
 629     }
 630   }
 631 }
 632
 633 static void on_simulation_end()
 634 {
 635   XBT_DEBUG("Simulation is over, time to unregister remote disks if any");
 636   for (auto const& host : simgrid::s4u::Engine::get_instance()->get_all_hosts()) {
 637     const char* remote_disk_str = host->get_property("remote_disk");
 638     if (remote_disk_str) {
 639       std::vector<std::string> tokens;
 640       boost::split(tokens, remote_disk_str, boost::is_any_of(":"));
 641       XBT_DEBUG("Host '%s' wants to unmount a remote disk: %s of %s mounted on %s", host->get_cname(),
 642                 tokens[1].c_str(), tokens[2].c_str(), tokens[0].c_str());
 643       host->remove_disk(tokens[1]);
 644       XBT_DEBUG("Host '%s' now has %zu disks", host->get_cname(), host->get_disks().size());
 645     }
 646   }
 647 }
 648
 649 /* **************************** Public interface *************************** */
 650 /** @brief Initialize the file system plugin.
 651     @ingroup plugin_filesystem
 652
 653     @beginrst
 654     See the examples in :ref:`s4u_ex_disk_io`.
 655     @endrst
 656  */
 657 void sg_storage_file_system_init()
 658 {
 659   sg_storage_max_file_descriptors = 1024;
 660   simgrid::config::bind_flag(sg_storage_max_file_descriptors, "storage/max_file_descriptors",
 661                              "Maximum number of concurrently opened files per host. Default is 1024");
 662
 663   if (not FileSystemStorageExt::EXTENSION_ID.valid()) {
 664     FileSystemStorageExt::EXTENSION_ID = simgrid::s4u::Storage::extension_create<FileSystemStorageExt>();
 665     simgrid::s4u::Storage::on_creation.connect(&on_storage_creation);
 666   }
 667
 668   if (not FileSystemDiskExt::EXTENSION_ID.valid()) {
 669     FileSystemDiskExt::EXTENSION_ID = simgrid::s4u::Disk::extension_create<FileSystemDiskExt>();
 670     simgrid::s4u::Disk::on_creation.connect(&on_disk_creation);
 671   }
 672
 673   if (not FileDescriptorHostExt::EXTENSION_ID.valid()) {
 674     FileDescriptorHostExt::EXTENSION_ID = simgrid::s4u::Host::extension_create<FileDescriptorHostExt>();
 675     simgrid::s4u::Host::on_creation.connect(&on_host_creation);
 676   }
 677   simgrid::s4u::Engine::on_platform_created.connect(&on_platform_created);
 678   simgrid::s4u::Engine::on_simulation_end.connect(&on_simulation_end);
 679 }
 680
 681 sg_file_t sg_file_open(const char* fullpath, void* data)
 682 {
 683   return new simgrid::s4u::File(fullpath, data);
 684 }
 685
 686 sg_size_t sg_file_read(sg_file_t fd, sg_size_t size)
 687 {
 688   return fd->read(size);
 689 }
 690
 691 sg_size_t sg_file_write(sg_file_t fd, sg_size_t size)
 692 {
 693   return fd->write(size);
 694 }
 695
 696 void sg_file_close(const_sg_file_t fd)
 697 {
 698   delete fd;
 699 }
 700
 701 /** Retrieves the path to the file
 702  * @ingroup plugin_filesystem
 703  */
 704 const char* sg_file_get_name(const_sg_file_t fd)
 705 {
 706   xbt_assert((fd != nullptr), "Invalid file descriptor");
 707   return fd->get_path();
 708 }
 709
 710 /** Retrieves the size of the file
 711  * @ingroup plugin_filesystem
 712  */
 713 sg_size_t sg_file_get_size(const_sg_file_t fd)
 714 {
 715   return fd->size();
 716 }
 717
 718 void sg_file_dump(const_sg_file_t fd)
 719 {
 720   fd->dump();
 721 }
 722
 723 /** Retrieves the user data associated with the file
 724  * @ingroup plugin_filesystem
 725  */
 726 void* sg_file_get_data(const_sg_file_t fd)
 727 {
 728   return fd->get_data();
 729 }
 730
 731 /** Changes the user data associated with the file
 732  * @ingroup plugin_filesystem
 733  */
 734 void sg_file_set_data(sg_file_t fd, void* data)
 735 {
 736   fd->set_data(data);
 737 }
 738
 739 /**
 740  * @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).
 741  * @ingroup plugin_filesystem
 742  *
 743  * @param fd : file object that identifies the stream
 744  * @param offset : number of bytes to offset from origin
 745  * @param origin : Position used as reference for the offset. It is specified by one of the following constants defined
 746  *                 in \<stdio.h\> exclusively to be used as arguments for this function (SEEK_SET = beginning of file,
 747  *                 SEEK_CUR = current position of the file pointer, SEEK_END = end of file)
 748  */
 749 void sg_file_seek(sg_file_t fd, sg_offset_t offset, int origin)
 750 {
 751   fd->seek(offset, origin);
 752 }
 753
 754 sg_size_t sg_file_tell(const_sg_file_t fd)
 755 {
 756   return fd->tell();
 757 }
 758
 759 void sg_file_move(const_sg_file_t fd, const char* fullpath)
 760 {
 761   fd->move(fullpath);
 762 }
 763
 764 void sg_file_unlink(sg_file_t fd)
 765 {
 766   fd->unlink();
 767   delete fd;
 768 }
 769
 770 /**
 771  * @brief Copy a file to another location on a remote host.
 772  * @ingroup plugin_filesystem
 773  *
 774  * @param file : the file to move
 775  * @param host : the remote host where the file has to be copied
 776  * @param fullpath : the complete path destination on the remote host
 777  * @return If successful, the function returns 0. Otherwise, it returns -1.
 778  */
 779 int sg_file_rcopy(sg_file_t file, sg_host_t host, const char* fullpath)
 780 {
 781   return file->remote_copy(host, fullpath);
 782 }
 783
 784 /**
 785  * @brief Move a file to another location on a remote host.
 786  * @ingroup plugin_filesystem
 787  *
 788  * @param file : the file to move
 789  * @param host : the remote host where the file has to be moved
 790  * @param fullpath : the complete path destination on the remote host
 791  * @return If successful, the function returns 0. Otherwise, it returns -1.
 792  */
 793 int sg_file_rmove(sg_file_t file, sg_host_t host, const char* fullpath)
 794 {
 795   return file->remote_move(host, fullpath);
 796 }
 797
 798 sg_size_t sg_disk_get_size_free(const_sg_disk_t d)
 799 {
 800   return d->extension<FileSystemDiskExt>()->get_size() - d->extension<FileSystemDiskExt>()->get_used_size();
 801 }
 802
 803 sg_size_t sg_disk_get_size_used(const_sg_disk_t d)
 804 {
 805   return d->extension<FileSystemDiskExt>()->get_used_size();
 806 }
 807
 808 sg_size_t sg_disk_get_size(const_sg_disk_t d)
 809 {
 810   return d->extension<FileSystemDiskExt>()->get_size();
 811 }
 812
 813 const char* sg_disk_get_mount_point(const_sg_disk_t d)
 814 {
 815   return d->extension<FileSystemDiskExt>()->get_mount_point();
 816 }
 817
 818 sg_size_t sg_storage_get_size_free(const_sg_storage_t st)
 819 {
 820   return st->extension<FileSystemStorageExt>()->get_size() - st->extension<FileSystemStorageExt>()->get_used_size();
 821 }
 822
 823 sg_size_t sg_storage_get_size_used(const_sg_storage_t st)
 824 {
 825   return st->extension<FileSystemStorageExt>()->get_used_size();
 826 }
 827
 828 sg_size_t sg_storage_get_size(const_sg_storage_t st)
 829 {
 830   return st->extension<FileSystemStorageExt>()->get_size();
 831 }
 832
 833 xbt_dict_t sg_storage_get_content(const_sg_storage_t storage)
 834 {
 835   const std::map<std::string, sg_size_t, std::less<>>* content =
 836       storage->extension<simgrid::s4u::FileSystemStorageExt>()->get_content();
 837   // Note: ::operator delete is ok here (no destructor called) since the dict elements are of POD type sg_size_t.
 838   xbt_dict_t content_as_dict = xbt_dict_new_homogeneous(::operator delete);
 839
 840   for (auto const& entry : *content) {
 841     auto* psize = new sg_size_t(entry.second);
 842     xbt_dict_set(content_as_dict, entry.first.c_str(), psize);
 843   }
 844   return content_as_dict;
 845 }
 846
 847 xbt_dict_t sg_host_get_storage_content(sg_host_t host)
 848 {
 849   xbt_assert((host != nullptr), "Invalid parameters");
 850   xbt_dict_t contents = xbt_dict_new_homogeneous(nullptr);
 851   for (auto const& elm : host->get_mounted_storages())
 852     xbt_dict_set(contents, elm.first.c_str(), sg_storage_get_content(elm.second));
 853
 854   return contents;
 855 }