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