src/plugins/file_system/s4u_FileSystem.cpp

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