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