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