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   Host* host          = nullptr;
 175   // if the current position is close to the end of the file, we may not be able to read the requested size
 176   sg_size_t to_read   = std::min(size, size_ - current_position_);
 177   sg_size_t read_size = 0;
 178
 179   if (local_storage_) {
 180     /* Find the host where the file is physically located and read it */
 181     host = local_storage_->get_host();
 182     XBT_DEBUG("READ %s on disk '%s'", get_path(), local_storage_->get_cname());
 183     read_size = local_storage_->read(to_read);
 184   }
 185
 186   if (local_disk_) {
 187     /* Find the host where the file is physically located and read it */
 188     host = local_disk_->get_host();
 189     XBT_DEBUG("READ %s on disk '%s'", get_path(), local_disk_->get_cname());
 190     read_size = local_disk_->read(to_read);
 191   }
 192
 193   current_position_ += read_size;
 194
 195   if (host && host->get_name() != Host::current()->get_name() && read_size > 0) {
 196     /* the file is hosted on a remote host, initiate a communication between src and dest hosts for data transfer */
 197     XBT_DEBUG("File is on %s remote host, initiate data transfer of %llu bytes.", host->get_cname(), read_size);
 198     host->sendto(Host::current(), read_size);
 199   }
 200
 201   return read_size;
 202 }
 203
 204 /** @brief Write into a file (local or remote)
 205  * @ingroup plugin_filesystem
 206  *
 207  * @param size of the file to write
 208  * @return the number of bytes successfully write or -1 if an error occurred
 209  */
 210 sg_size_t File::write_on_disk(sg_size_t size, bool write_inside)
 211 {
 212   sg_size_t write_size = 0;
 213   /* Find the host where the file is physically located (remote or local)*/
 214   Host* host = local_disk_->get_host();
 215
 216   if (host && host->get_name() != Host::current()->get_name()) {
 217     /* the file is hosted on a remote host, initiate a communication between src and dest hosts for data transfer */
 218     XBT_DEBUG("File is on %s remote host, initiate data transfer of %llu bytes.", host->get_cname(), size);
 219     Host::current()->sendto(host, size);
 220   }
 221   XBT_DEBUG("WRITE %s on disk '%s'. size '%llu/%llu' '%llu:%llu'", get_path(), local_disk_->get_cname(), size, size_,
 222             sg_disk_get_size_used(local_disk_), sg_disk_get_size(local_disk_));
 223   // If the storage is full before even starting to write
 224   if (sg_disk_get_size_used(local_disk_) >= sg_disk_get_size(local_disk_))
 225     return 0;
 226   if (not write_inside) {
 227     /* Subtract the part of the file that might disappear from the used sized on the storage element */
 228     local_disk_->extension<FileSystemDiskExt>()->decr_used_size(size_ - current_position_);
 229     write_size = local_disk_->write(size);
 230     local_disk_->extension<FileSystemDiskExt>()->incr_used_size(write_size);
 231     current_position_ += write_size;
 232     size_ = current_position_;
 233   } else {
 234     write_size = local_disk_->write(size);
 235     current_position_ += write_size;
 236     if (current_position_ > size_)
 237       size_ = current_position_;
 238   }
 239   kernel::actor::simcall([this] {
 240     std::map<std::string, sg_size_t, std::less<>>* content = local_disk_->extension<FileSystemDiskExt>()->get_content();
 241
 242     content->erase(path_);
 243     content->insert({path_, size_});
 244   });
 245
 246   return write_size;
 247 }
 248
 249 sg_size_t File::write_on_storage(sg_size_t size, bool write_inside)
 250 {
 251   sg_size_t write_size = 0;
 252   /* Find the host where the file is physically located (remote or local)*/
 253   Host* host = local_storage_->get_host();
 254
 255   if (host && host->get_name() != Host::current()->get_name()) {
 256     /* the file is hosted on a remote host, initiate a communication between src and dest hosts for data transfer */
 257     XBT_DEBUG("File is on %s remote host, initiate data transfer of %llu bytes.", host->get_cname(), size);
 258     Host::current()->sendto(host, size);
 259   }
 260
 261   XBT_DEBUG("WRITE %s on disk '%s'. size '%llu/%llu' '%llu:%llu'", get_path(), local_storage_->get_cname(), size, size_,
 262             sg_storage_get_size_used(local_storage_), sg_storage_get_size(local_storage_));
 263   // If the storage is full before even starting to write
 264   if (sg_storage_get_size_used(local_storage_) >= sg_storage_get_size(local_storage_))
 265     return 0;
 266   if (not write_inside) {
 267     /* Subtract the part of the file that might disappear from the used sized on the storage element */
 268     local_storage_->extension<FileSystemStorageExt>()->decr_used_size(size_ - current_position_);
 269     write_size = local_storage_->write(size);
 270     local_storage_->extension<FileSystemStorageExt>()->incr_used_size(write_size);
 271     current_position_ += write_size;
 272     size_ = current_position_;
 273   } else {
 274     write_size = local_storage_->write(size);
 275     current_position_ += write_size;
 276     if (current_position_ > size_)
 277       size_ = current_position_;
 278   }
 279   kernel::actor::simcall([this] {
 280     std::map<std::string, sg_size_t, std::less<>>* content =
 281         local_storage_->extension<FileSystemStorageExt>()->get_content();
 282
 283     content->erase(path_);
 284     content->insert({path_, size_});
 285   });
 286
 287   return write_size;
 288 }
 289
 290 sg_size_t File::write(sg_size_t size, bool write_inside)
 291 {
 292   if (size == 0) /* Nothing to write, return */
 293     return 0;
 294
 295   if (local_disk_)
 296     return write_on_disk(size, write_inside);
 297   if (local_storage_)
 298     return write_on_storage(size, write_inside);
 299
 300   return 0;
 301 }
 302
 303 sg_size_t File::size() const
 304 {
 305   return size_;
 306 }
 307
 308 void File::seek(sg_offset_t offset)
 309 {
 310   current_position_ = offset;
 311 }
 312
 313 void File::seek(sg_offset_t offset, int origin)
 314 {
 315   switch (origin) {
 316     case SEEK_SET:
 317       current_position_ = offset;
 318       break;
 319     case SEEK_CUR:
 320       current_position_ += offset;
 321       break;
 322     case SEEK_END:
 323       current_position_ = size_ + offset;
 324       break;
 325     default:
 326       break;
 327   }
 328 }
 329
 330 sg_size_t File::tell() const
 331 {
 332   return current_position_;
 333 }
 334
 335 void File::move(const std::string& fullpath) const
 336 {
 337   /* Check if the new full path is on the same mount point */
 338   if (fullpath.compare(0, mount_point_.length(), mount_point_) == 0) {
 339     std::map<std::string, sg_size_t, std::less<>>* content = nullptr;
 340     if (local_storage_)
 341       content = local_storage_->extension<FileSystemStorageExt>()->get_content();
 342     if (local_disk_)
 343       content = local_disk_->extension<FileSystemDiskExt>()->get_content();
 344     if (content) {
 345       auto sz = content->find(path_);
 346       if (sz != content->end()) { // src file exists
 347         sg_size_t new_size = sz->second;
 348         content->erase(path_);
 349         std::string path = fullpath.substr(mount_point_.length(), fullpath.length());
 350         content->insert({path.c_str(), new_size});
 351         XBT_DEBUG("Move file from %s to %s, size '%llu'", path_.c_str(), fullpath.c_str(), new_size);
 352       } else {
 353         XBT_WARN("File %s doesn't exist", path_.c_str());
 354       }
 355     }
 356   } else {
 357     XBT_WARN("New full path %s is not on the same mount point: %s.", fullpath.c_str(), mount_point_.c_str());
 358   }
 359 }
 360
 361 int File::unlink() const
 362 {
 363   /* Check if the file is on local storage */
 364   std::map<std::string, sg_size_t, std::less<>>* content = nullptr;
 365   const char* name = "";
 366   if (local_storage_) {
 367     content = local_storage_->extension<FileSystemStorageExt>()->get_content();
 368     name    = local_storage_->get_cname();
 369   }
 370   if (local_disk_) {
 371     content = local_disk_->extension<FileSystemDiskExt>()->get_content();
 372     name    = local_disk_->get_cname();
 373   }
 374
 375   if (not content || content->find(path_) == content->end()) {
 376     XBT_WARN("File %s is not on disk %s. Impossible to unlink", path_.c_str(), name);
 377     return -1;
 378   } else {
 379     XBT_DEBUG("UNLINK %s on disk '%s'", path_.c_str(), name);
 380
 381     if (local_storage_)
 382       local_storage_->extension<FileSystemStorageExt>()->decr_used_size(size_);
 383
 384     if (local_disk_)
 385       local_disk_->extension<FileSystemDiskExt>()->decr_used_size(size_);
 386
 387     // Remove the file from storage
 388     content->erase(path_);
 389
 390     return 0;
 391   }
 392 }
 393
 394 int File::remote_copy(sg_host_t host, const std::string& fullpath)
 395 {
 396   /* Find the host where the file is physically located and read it */
 397   Host* src_host      = nullptr;
 398   sg_size_t read_size = 0;
 399
 400   Host* dst_host = host;
 401   size_t longest_prefix_length = 0;
 402
 403   seek(0, SEEK_SET);
 404
 405   if (local_storage_) {
 406     src_host = local_storage_->get_host();
 407     XBT_DEBUG("READ %s on disk '%s'", get_path(), local_storage_->get_cname());
 408     read_size = local_storage_->read(size_);
 409     current_position_ += read_size;
 410
 411     /* Find the host that owns the storage where the file has to be copied */
 412     const Storage* storage_dest = nullptr;
 413
 414     for (auto const& elm : host->get_mounted_storages()) {
 415       std::string mount_point = std::string(fullpath).substr(0, elm.first.size());
 416       if (mount_point == elm.first && elm.first.length() > longest_prefix_length) {
 417         /* The current mount name is found in the full path and is bigger than the previous*/
 418         longest_prefix_length = elm.first.length();
 419         storage_dest          = elm.second;
 420       }
 421     }
 422
 423     if (storage_dest != nullptr) {
 424       /* Mount point found, retrieve the host the storage is attached to */
 425       dst_host = storage_dest->get_host();
 426     } else {
 427       XBT_WARN("Can't find mount point for '%s' on destination host '%s'", fullpath.c_str(), host->get_cname());
 428       return -1;
 429     }
 430   }
 431
 432   if (local_disk_) {
 433     src_host = local_disk_->get_host();
 434     XBT_DEBUG("READ %s on disk '%s'", get_path(), local_disk_->get_cname());
 435     read_size = local_disk_->read(size_);
 436     current_position_ += read_size;
 437
 438     const Disk* dst_disk = nullptr;
 439
 440     for (auto const& disk : host->get_disks()) {
 441       std::string current_mount = disk->extension<FileSystemDiskExt>()->get_mount_point();
 442       std::string mount_point   = std::string(fullpath).substr(0, current_mount.length());
 443       if (mount_point == current_mount && current_mount.length() > longest_prefix_length) {
 444         /* The current mount name is found in the full path and is bigger than the previous*/
 445         longest_prefix_length = current_mount.length();
 446         dst_disk              = disk;
 447       }
 448     }
 449
 450     if (dst_disk == nullptr) {
 451       XBT_WARN("Can't find mount point for '%s' on destination host '%s'", fullpath.c_str(), host->get_cname());
 452       return -1;
 453     }
 454   }
 455
 456   if (src_host) {
 457     XBT_DEBUG("Initiate data transfer of %llu bytes between %s and %s.", read_size, src_host->get_cname(),
 458               dst_host->get_cname());
 459     src_host->sendto(dst_host, read_size);
 460   }
 461
 462   /* Create file on remote host, write it and close it */
 463   File fd(fullpath, dst_host, nullptr);
 464   if (local_storage_) {
 465     sg_size_t write_size = fd.local_storage_->write(read_size);
 466     fd.local_storage_->extension<FileSystemStorageExt>()->incr_used_size(write_size);
 467     (*(fd.local_storage_->extension<FileSystemStorageExt>()->get_content()))[path_] = size_;
 468   }
 469   if (local_disk_)
 470     fd.write(read_size);
 471   return 0;
 472 }
 473
 474 int File::remote_move(sg_host_t host, const std::string& fullpath)
 475 {
 476   int res = remote_copy(host, fullpath);
 477   unlink();
 478   return res;
 479 }
 480
 481 FileSystemDiskExt::FileSystemDiskExt(const Disk* ptr)
 482 {
 483   const char* size_str    = ptr->get_property("size");
 484   std::string dummyfile;
 485   if (size_str)
 486     size_ = surf_parse_get_size(dummyfile, -1, size_str, "disk size", ptr->get_name());
 487
 488   const char* current_mount_str = ptr->get_property("mount");
 489   if (current_mount_str)
 490     mount_point_ = std::string(current_mount_str);
 491   else
 492     mount_point_ = std::string("/");
 493
 494   const char* content_str = ptr->get_property("content");
 495   if (content_str)
 496     content_.reset(parse_content(content_str));
 497 }
 498
 499 FileSystemStorageExt::FileSystemStorageExt(const Storage* ptr) : size_(ptr->get_impl()->size_)
 500 {
 501   content_.reset(parse_content(ptr->get_impl()->content_name_));
 502 }
 503
 504 std::map<std::string, sg_size_t, std::less<>>* FileSystemDiskExt::parse_content(const std::string& filename)
 505 {
 506   if (filename.empty())
 507     return nullptr;
 508
 509   auto* parse_content = new std::map<std::string, sg_size_t, std::less<>>();
 510
 511   auto fs = std::unique_ptr<std::ifstream>(surf_ifsopen(filename));
 512   xbt_assert(not fs->fail(), "Cannot open file '%s' (path=%s)", filename.c_str(),
 513              (boost::join(surf_path, ":")).c_str());
 514
 515   std::string line;
 516   std::vector<std::string> tokens;
 517   do {
 518     std::getline(*fs, line);
 519     boost::trim(line);
 520     if (line.length() > 0) {
 521       boost::split(tokens, line, boost::is_any_of(" \t"), boost::token_compress_on);
 522       xbt_assert(tokens.size() == 2, "Parse error in %s: %s", filename.c_str(), line.c_str());
 523       sg_size_t size = std::stoull(tokens.at(1));
 524
 525       used_size_ += size;
 526       parse_content->insert({tokens.front(), size});
 527     }
 528   } while (not fs->eof());
 529   return parse_content;
 530 }
 531
 532 std::map<std::string, sg_size_t, std::less<>>* FileSystemStorageExt::parse_content(const std::string& filename)
 533 {
 534   if (filename.empty())
 535     return nullptr;
 536
 537   auto* parse_content = new std::map<std::string, sg_size_t, std::less<>>();
 538
 539   auto fs = std::unique_ptr<std::ifstream>(surf_ifsopen(filename));
 540   xbt_assert(not fs->fail(), "Cannot open file '%s' (path=%s)", filename.c_str(),
 541              (boost::join(surf_path, ":")).c_str());
 542
 543   std::string line;
 544   std::vector<std::string> tokens;
 545   do {
 546     std::getline(*fs, line);
 547     boost::trim(line);
 548     if (line.length() > 0) {
 549       boost::split(tokens, line, boost::is_any_of(" \t"), boost::token_compress_on);
 550       xbt_assert(tokens.size() == 2, "Parse error in %s: %s", filename.c_str(), line.c_str());
 551       sg_size_t size = std::stoull(tokens.at(1));
 552
 553       used_size_ += size;
 554       parse_content->insert({tokens.front(), size});
 555     }
 556   } while (not fs->eof());
 557   return parse_content;
 558 }
 559
 560 void FileSystemStorageExt::decr_used_size(sg_size_t size)
 561 {
 562   simgrid::kernel::actor::simcall([this, size] { used_size_ -= size; });
 563 }
 564
 565 void FileSystemStorageExt::incr_used_size(sg_size_t size)
 566 {
 567   simgrid::kernel::actor::simcall([this, size] { used_size_ += size; });
 568 }
 569
 570 void FileSystemDiskExt::decr_used_size(sg_size_t size)
 571 {
 572   simgrid::kernel::actor::simcall([this, size] { used_size_ -= size; });
 573 }
 574
 575 void FileSystemDiskExt::incr_used_size(sg_size_t size)
 576 {
 577   simgrid::kernel::actor::simcall([this, size] { used_size_ += size; });
 578 }
 579 }
 580 }
 581
 582 using simgrid::s4u::FileDescriptorHostExt;
 583 using simgrid::s4u::FileSystemDiskExt;
 584 using simgrid::s4u::FileSystemStorageExt;
 585
 586 static void on_disk_creation(simgrid::s4u::Disk& d)
 587 {
 588   d.extension_set(new FileSystemDiskExt(&d));
 589 }
 590 static void on_storage_creation(simgrid::s4u::Storage& st)
 591 {
 592   st.extension_set(new FileSystemStorageExt(&st));
 593 }
 594
 595 static void on_host_creation(simgrid::s4u::Host& host)
 596 {
 597   host.extension_set<FileDescriptorHostExt>(new FileDescriptorHostExt());
 598 }
 599
 600 static void on_platform_created()
 601 {
 602   for (auto const& host : simgrid::s4u::Engine::get_instance()->get_all_hosts()) {
 603     const char* remote_disk_str = host->get_property("remote_disk");
 604     if (remote_disk_str) {
 605       std::vector<std::string> tokens;
 606       boost::split(tokens, remote_disk_str, boost::is_any_of(":"));
 607       std::string mount_point         = tokens[0];
 608       simgrid::s4u::Host* remote_host = simgrid::s4u::Host::by_name_or_null(tokens[2]);
 609       xbt_assert(remote_host, "You're trying to access a host that does not exist. Please check your platform file");
 610
 611       const simgrid::s4u::Disk* disk = nullptr;
 612       for (auto const& d : remote_host->get_disks())
 613         if (d->get_name() == tokens[1]) {
 614           disk = d;
 615           break;
 616         }
 617
 618       xbt_assert(disk, "You're trying to mount a disk that does not exist. Please check your platform file");
 619       disk->extension<FileSystemDiskExt>()->add_remote_mount(remote_host, mount_point);
 620       host->add_disk(disk);
 621
 622       XBT_DEBUG("Host '%s' wants to mount a remote disk: %s of %s mounted on %s", host->get_cname(), disk->get_cname(),
 623                 remote_host->get_cname(), mount_point.c_str());
 624       XBT_DEBUG("Host '%s' now has %zu disks", host->get_cname(), host->get_disks().size());
 625     }
 626   }
 627 }
 628
 629 static void on_simulation_end()
 630 {
 631   XBT_DEBUG("Simulation is over, time to unregister remote disks if any");
 632   for (auto const& host : simgrid::s4u::Engine::get_instance()->get_all_hosts()) {
 633     const char* remote_disk_str = host->get_property("remote_disk");
 634     if (remote_disk_str) {
 635       std::vector<std::string> tokens;
 636       boost::split(tokens, remote_disk_str, boost::is_any_of(":"));
 637       XBT_DEBUG("Host '%s' wants to unmount a remote disk: %s of %s mounted on %s", host->get_cname(),
 638                 tokens[1].c_str(), tokens[2].c_str(), tokens[0].c_str());
 639       host->remove_disk(tokens[1]);
 640       XBT_DEBUG("Host '%s' now has %zu disks", host->get_cname(), host->get_disks().size());
 641     }
 642   }
 643 }
 644
 645 /* **************************** Public interface *************************** */
 646 /** @brief Initialize the file system plugin.
 647     @ingroup plugin_filesystem
 648
 649     @beginrst
 650     See the examples in :ref:`s4u_ex_disk_io`.
 651     @endrst
 652  */
 653 void sg_storage_file_system_init()
 654 {
 655   sg_storage_max_file_descriptors = 1024;
 656   simgrid::config::bind_flag(sg_storage_max_file_descriptors, "storage/max_file_descriptors",
 657                              "Maximum number of concurrently opened files per host. Default is 1024");
 658
 659   if (not FileSystemStorageExt::EXTENSION_ID.valid()) {
 660     FileSystemStorageExt::EXTENSION_ID = simgrid::s4u::Storage::extension_create<FileSystemStorageExt>();
 661     simgrid::s4u::Storage::on_creation.connect(&on_storage_creation);
 662   }
 663
 664   if (not FileSystemDiskExt::EXTENSION_ID.valid()) {
 665     FileSystemDiskExt::EXTENSION_ID = simgrid::s4u::Disk::extension_create<FileSystemDiskExt>();
 666     simgrid::s4u::Disk::on_creation.connect(&on_disk_creation);
 667   }
 668
 669   if (not FileDescriptorHostExt::EXTENSION_ID.valid()) {
 670     FileDescriptorHostExt::EXTENSION_ID = simgrid::s4u::Host::extension_create<FileDescriptorHostExt>();
 671     simgrid::s4u::Host::on_creation.connect(&on_host_creation);
 672   }
 673   simgrid::s4u::Engine::on_platform_created.connect(&on_platform_created);
 674   simgrid::s4u::Engine::on_simulation_end.connect(&on_simulation_end);
 675 }
 676
 677 sg_file_t sg_file_open(const char* fullpath, void* data)
 678 {
 679   return new simgrid::s4u::File(fullpath, data);
 680 }
 681
 682 sg_size_t sg_file_read(sg_file_t fd, sg_size_t size)
 683 {
 684   return fd->read(size);
 685 }
 686
 687 sg_size_t sg_file_write(sg_file_t fd, sg_size_t size)
 688 {
 689   return fd->write(size);
 690 }
 691
 692 void sg_file_close(const_sg_file_t fd)
 693 {
 694   delete fd;
 695 }
 696
 697 /** Retrieves the path to the file
 698  * @ingroup plugin_filesystem
 699  */
 700 const char* sg_file_get_name(const_sg_file_t fd)
 701 {
 702   xbt_assert((fd != nullptr), "Invalid file descriptor");
 703   return fd->get_path();
 704 }
 705
 706 /** Retrieves the size of the file
 707  * @ingroup plugin_filesystem
 708  */
 709 sg_size_t sg_file_get_size(const_sg_file_t fd)
 710 {
 711   return fd->size();
 712 }
 713
 714 void sg_file_dump(const_sg_file_t fd)
 715 {
 716   fd->dump();
 717 }
 718
 719 /** Retrieves the user data associated with the file
 720  * @ingroup plugin_filesystem
 721  */
 722 void* sg_file_get_data(const_sg_file_t fd)
 723 {
 724   return fd->get_data();
 725 }
 726
 727 /** Changes the user data associated with the file
 728  * @ingroup plugin_filesystem
 729  */
 730 void sg_file_set_data(sg_file_t fd, void* data)
 731 {
 732   fd->set_data(data);
 733 }
 734
 735 /**
 736  * @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).
 737  * @ingroup plugin_filesystem
 738  *
 739  * @param fd : file object that identifies the stream
 740  * @param offset : number of bytes to offset from origin
 741  * @param origin : Position used as reference for the offset. It is specified by one of the following constants defined
 742  *                 in \<stdio.h\> exclusively to be used as arguments for this function (SEEK_SET = beginning of file,
 743  *                 SEEK_CUR = current position of the file pointer, SEEK_END = end of file)
 744  */
 745 void sg_file_seek(sg_file_t fd, sg_offset_t offset, int origin)
 746 {
 747   fd->seek(offset, origin);
 748 }
 749
 750 sg_size_t sg_file_tell(const_sg_file_t fd)
 751 {
 752   return fd->tell();
 753 }
 754
 755 void sg_file_move(const_sg_file_t fd, const char* fullpath)
 756 {
 757   fd->move(fullpath);
 758 }
 759
 760 void sg_file_unlink(sg_file_t fd)
 761 {
 762   fd->unlink();
 763   delete fd;
 764 }
 765
 766 /**
 767  * @brief Copy a file to another location on a remote host.
 768  * @ingroup plugin_filesystem
 769  *
 770  * @param file : the file to move
 771  * @param host : the remote host where the file has to be copied
 772  * @param fullpath : the complete path destination on the remote host
 773  * @return If successful, the function returns 0. Otherwise, it returns -1.
 774  */
 775 int sg_file_rcopy(sg_file_t file, sg_host_t host, const char* fullpath)
 776 {
 777   return file->remote_copy(host, fullpath);
 778 }
 779
 780 /**
 781  * @brief Move a file to another location on a remote host.
 782  * @ingroup plugin_filesystem
 783  *
 784  * @param file : the file to move
 785  * @param host : the remote host where the file has to be moved
 786  * @param fullpath : the complete path destination on the remote host
 787  * @return If successful, the function returns 0. Otherwise, it returns -1.
 788  */
 789 int sg_file_rmove(sg_file_t file, sg_host_t host, const char* fullpath)
 790 {
 791   return file->remote_move(host, fullpath);
 792 }
 793
 794 sg_size_t sg_disk_get_size_free(const_sg_disk_t d)
 795 {
 796   return d->extension<FileSystemDiskExt>()->get_size() - d->extension<FileSystemDiskExt>()->get_used_size();
 797 }
 798
 799 sg_size_t sg_disk_get_size_used(const_sg_disk_t d)
 800 {
 801   return d->extension<FileSystemDiskExt>()->get_used_size();
 802 }
 803
 804 sg_size_t sg_disk_get_size(const_sg_disk_t d)
 805 {
 806   return d->extension<FileSystemDiskExt>()->get_size();
 807 }
 808
 809 const char* sg_disk_get_mount_point(const_sg_disk_t d)
 810 {
 811   return d->extension<FileSystemDiskExt>()->get_mount_point();
 812 }
 813
 814 sg_size_t sg_storage_get_size_free(const_sg_storage_t st)
 815 {
 816   return st->extension<FileSystemStorageExt>()->get_size() - st->extension<FileSystemStorageExt>()->get_used_size();
 817 }
 818
 819 sg_size_t sg_storage_get_size_used(const_sg_storage_t st)
 820 {
 821   return st->extension<FileSystemStorageExt>()->get_used_size();
 822 }
 823
 824 sg_size_t sg_storage_get_size(const_sg_storage_t st)
 825 {
 826   return st->extension<FileSystemStorageExt>()->get_size();
 827 }
 828
 829 xbt_dict_t sg_storage_get_content(const_sg_storage_t storage)
 830 {
 831   const std::map<std::string, sg_size_t, std::less<>>* content =
 832       storage->extension<simgrid::s4u::FileSystemStorageExt>()->get_content();
 833   // Note: ::operator delete is ok here (no destructor called) since the dict elements are of POD type sg_size_t.
 834   xbt_dict_t content_as_dict = xbt_dict_new_homogeneous(::operator delete);
 835
 836   for (auto const& entry : *content) {
 837     auto* psize = new sg_size_t(entry.second);
 838     xbt_dict_set(content_as_dict, entry.first.c_str(), psize);
 839   }
 840   return content_as_dict;
 841 }
 842
 843 xbt_dict_t sg_host_get_storage_content(sg_host_t host)
 844 {
 845   xbt_assert((host != nullptr), "Invalid parameters");
 846   xbt_dict_t contents = xbt_dict_new_homogeneous(nullptr);
 847   for (auto const& elm : host->get_mounted_storages())
 848     xbt_dict_set(contents, elm.first.c_str(), sg_storage_get_content(elm.second));
 849
 850   return contents;
 851 }