src/plugins/file_system/s4u_FileSystem.cpp

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