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