src/plugins/file_system/s4u_FileSystem.cpp

   1 /* Copyright (c) 2015-2023. 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/Comm.hpp>
   8 #include <simgrid/s4u/Disk.hpp>
   9 #include <simgrid/s4u/Engine.hpp>
  10 #include <simgrid/s4u/Host.hpp>
  11 #include <simgrid/simix.hpp>
  12 #include <xbt/asserts.h>
  13 #include <xbt/config.hpp>
  14 #include <xbt/file.hpp>
  15 #include <xbt/log.h>
  16 #include <xbt/parse_units.hpp>
  17
  18 #include <boost/algorithm/string.hpp>
  19 #include <boost/algorithm/string/split.hpp>
  20 #include <fstream>
  21 #include <numeric>
  22
  23 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_file, s4u, "S4U files");
  24
  25 /** @defgroup plugin_filesystem Plugin FileSystem
  26  *
  27  * This adds the notion of Files on top of the storage notion that provided by the core of SimGrid.
  28  * Activate this plugin at will.
  29  */
  30
  31 namespace simgrid {
  32
  33 template class xbt::Extendable<s4u::File>;
  34
  35 namespace s4u {
  36 simgrid::xbt::Extension<Disk, FileSystemDiskExt> FileSystemDiskExt::EXTENSION_ID;
  37 simgrid::xbt::Extension<Host, FileDescriptorHostExt> FileDescriptorHostExt::EXTENSION_ID;
  38 int FileDescriptorHostExt::max_file_descriptors;
  39
  40 const Disk* File::find_local_disk_on(const Host* host)
  41 {
  42   const Disk* d                = nullptr;
  43   size_t longest_prefix_length = 0;
  44   for (auto const& disk : host->get_disks()) {
  45     std::string current_mount;
  46     if (disk->get_host() != host)
  47       current_mount = disk->extension<FileSystemDiskExt>()->get_mount_point(disk->get_host());
  48     else
  49       current_mount = disk->extension<FileSystemDiskExt>()->get_mount_point();
  50     mount_point_ = fullpath_.substr(0, current_mount.length());
  51     if (mount_point_ == current_mount && current_mount.length() > longest_prefix_length) {
  52       /* The current mount name is found in the full path and is bigger than the previous*/
  53       longest_prefix_length = current_mount.length();
  54       d                     = disk;
  55     }
  56     xbt_assert(longest_prefix_length > 0, "Can't find mount point for '%s' on '%s'", fullpath_.c_str(),
  57                host->get_cname());
  58     /* Mount point found, split fullpath_ into mount_name and path+filename*/
  59     mount_point_ = fullpath_.substr(0, longest_prefix_length);
  60     if (mount_point_ == "/")
  61       path_ = fullpath_;
  62     else
  63       path_ = fullpath_.substr(longest_prefix_length, fullpath_.length());
  64     XBT_DEBUG("%s + %s", mount_point_.c_str(), path_.c_str());
  65   }
  66   return d;
  67 }
  68
  69 File::File(const std::string& fullpath, void* userdata) : File(fullpath, Host::current(), userdata) {}
  70
  71 File::File(const std::string& fullpath, const_sg_host_t host, void* userdata) : fullpath_(fullpath)
  72 {
  73   kernel::actor::simcall_answered([this, &host, userdata] {
  74     this->set_data(userdata);
  75     // this cannot fail because we get a xbt_die if the mountpoint does not exist
  76     local_disk_ = find_local_disk_on(host);
  77
  78     // assign a file descriptor id to the newly opened File
  79     auto* ext = host->extension<FileDescriptorHostExt>();
  80     if (ext->file_descriptor_table == nullptr) {
  81       ext->file_descriptor_table = std::make_unique<std::vector<int>>(FileDescriptorHostExt::max_file_descriptors);
  82       std::iota(ext->file_descriptor_table->rbegin(), ext->file_descriptor_table->rend(), 0); // Fill with ..., 1, 0.
  83     }
  84     xbt_assert(not ext->file_descriptor_table->empty(), "Too much files are opened! Some have to be closed.");
  85     desc_id = ext->file_descriptor_table->back();
  86     ext->file_descriptor_table->pop_back();
  87
  88     std::map<std::string, sg_size_t, std::less<>>* content = nullptr;
  89     content = local_disk_->extension<FileSystemDiskExt>()->get_content();
  90
  91     // if file does not exist create an empty file
  92     if (content) {
  93       auto sz = content->find(path_);
  94       if (sz != content->end()) {
  95         size_ = sz->second;
  96         XBT_DEBUG("\tOpen file '%s', size %llu", path_.c_str(), size_);
  97       } else {
  98         size_ = 0;
  99         content->insert({path_, size_});
 100         XBT_DEBUG("File '%s' was not found, file created.", path_.c_str());
 101       }
 102     }
 103   });
 104 }
 105
 106 File::~File() = default;
 107
 108 File* File::open(const std::string& fullpath, void* userdata)
 109 {
 110   return new File(fullpath, userdata);
 111 }
 112
 113 File* File::open(const std::string& fullpath, const_sg_host_t host, void* userdata)
 114 {
 115   return new File(fullpath, host, userdata);
 116 }
 117
 118 void File::close()
 119 {
 120   std::vector<int>* desc_table = Host::current()->extension<FileDescriptorHostExt>()->file_descriptor_table.get();
 121   kernel::actor::simcall_answered([this, desc_table] { desc_table->push_back(this->desc_id); });
 122   delete this;
 123 }
 124
 125 void File::dump() const
 126 {
 127   XBT_INFO("File Descriptor information:\n"
 128       "\t\tFull path: '%s'\n"
 129       "\t\tSize: %llu\n"
 130       "\t\tMount point: '%s'\n"
 131       "\t\tDisk Id: '%s'\n"
 132       "\t\tHost Id: '%s'\n"
 133       "\t\tFile Descriptor Id: %d",
 134       get_path(), size_, mount_point_.c_str(), local_disk_->get_cname(), local_disk_->get_host()->get_cname(),
 135       desc_id);
 136 }
 137
 138 sg_size_t File::read(sg_size_t size)
 139 {
 140   if (size_ == 0) /* Nothing to read, return */
 141     return 0;
 142   Host* host          = nullptr;
 143   // if the current position is close to the end of the file, we may not be able to read the requested size
 144   sg_size_t to_read   = std::min(size, size_ - current_position_);
 145   sg_size_t read_size = 0;
 146
 147   /* Find the host where the file is physically located and read it */
 148   host = local_disk_->get_host();
 149   XBT_DEBUG("READ %s on disk '%s'", get_path(), local_disk_->get_cname());
 150   read_size = local_disk_->read(to_read);
 151
 152   current_position_ += read_size;
 153
 154   if (host && host->get_name() != Host::current()->get_name() && read_size > 0) {
 155     /* the file is hosted on a remote host, initiate a communication between src and dest hosts for data transfer */
 156     XBT_DEBUG("File is on %s remote host, initiate data transfer of %llu bytes.", host->get_cname(), read_size);
 157     Comm::sendto(host, Host::current(), read_size);
 158   }
 159
 160   return read_size;
 161 }
 162
 163 /** @brief Write into a file (local or remote)
 164  * @ingroup plugin_filesystem
 165  *
 166  * @param size of the file to write
 167  * @param write_inside
 168  * @return the number of bytes successfully write or -1 if an error occurred
 169  */
 170 sg_size_t File::write(sg_size_t size, bool write_inside)
 171 {
 172   if (size == 0) /* Nothing to write, return */
 173     return 0;
 174
 175   sg_size_t write_size = 0;
 176   /* Find the host where the file is physically located (remote or local)*/
 177   if (Host* host = local_disk_->get_host(); host && host->get_name() != Host::current()->get_name()) {
 178     /* the file is hosted on a remote host, initiate a communication between src and dest hosts for data transfer */
 179     XBT_DEBUG("File is on %s remote host, initiate data transfer of %llu bytes.", host->get_cname(), size);
 180     Comm::sendto(Host::current(), host, size);
 181   }
 182   XBT_DEBUG("WRITE %s on disk '%s'. size '%llu/%llu' '%llu:%llu'", get_path(), local_disk_->get_cname(), size, size_,
 183             sg_disk_get_size_used(local_disk_), sg_disk_get_size(local_disk_));
 184   // If the disk is full before even starting to write
 185   if (sg_disk_get_size_used(local_disk_) >= sg_disk_get_size(local_disk_))
 186     return 0;
 187   if (not write_inside)
 188     /* Subtract the part of the file that might disappear from the used sized on the storage element */
 189     local_disk_->extension<FileSystemDiskExt>()->decr_used_size(size_ - current_position_);
 190   write_size = local_disk_->write(size);
 191   update_position(current_position_ + write_size);
 192
 193   return write_size;
 194 }
 195
 196 sg_size_t File::size() const
 197 {
 198   return size_;
 199 }
 200
 201 void File::seek(sg_offset_t offset)
 202 {
 203   current_position_ = offset;
 204 }
 205
 206 void File::seek(sg_offset_t offset, int origin)
 207 {
 208   switch (origin) {
 209     case SEEK_SET:
 210       update_position(offset);
 211      break;
 212     case SEEK_CUR:
 213       update_position(current_position_ + offset);
 214       break;
 215     case SEEK_END:
 216       update_position(size_ + offset);
 217       break;
 218     default:
 219       break;
 220   }
 221 }
 222
 223 void File::update_position(sg_offset_t position)
 224 {
 225   xbt_assert(position >= 0, "Error in seek, cannot seek before file %s", get_path());
 226   current_position_ = position;
 227   if(current_position_>size_){
 228     XBT_DEBUG("Updating size of file %s from %llu to %lld", path_.c_str(), size_, position);
 229     local_disk_->extension<FileSystemDiskExt>()->incr_used_size(current_position_-size_);
 230     size_ = current_position_;
 231
 232     kernel::actor::simcall_answered([this] {
 233     std::map<std::string, sg_size_t, std::less<>>* content = local_disk_->extension<FileSystemDiskExt>()->get_content();
 234     content->erase(path_);
 235     content->insert({path_, size_});
 236   });
 237   }
 238 }
 239
 240 sg_size_t File::tell() const
 241 {
 242   return current_position_;
 243 }
 244
 245 void File::move(const std::string& fullpath) const
 246 {
 247   /* Check if the new full path is on the same mount point */
 248   if (fullpath.rfind(mount_point_, 0) == 0) {
 249     std::map<std::string, sg_size_t, std::less<>>* content = nullptr;
 250     content = local_disk_->extension<FileSystemDiskExt>()->get_content();
 251     if (content) {
 252       auto sz = content->find(path_);
 253       if (sz != content->end()) { // src file exists
 254         sg_size_t new_size = sz->second;
 255         content->erase(path_);
 256         std::string path = fullpath.substr(mount_point_.length(), fullpath.length());
 257         content->insert({path.c_str(), new_size});
 258         XBT_DEBUG("Move file from %s to %s, size '%llu'", path_.c_str(), fullpath.c_str(), new_size);
 259       } else {
 260         XBT_WARN("File %s doesn't exist", path_.c_str());
 261       }
 262     }
 263   } else {
 264     XBT_WARN("New full path %s is not on the same mount point: %s.", fullpath.c_str(), mount_point_.c_str());
 265   }
 266 }
 267
 268 int File::unlink() const
 269 {
 270   /* Check if the file is on local storage */
 271   auto* content    = local_disk_->extension<FileSystemDiskExt>()->get_content();
 272   const char* name = local_disk_->get_cname();
 273
 274   if (not content || content->find(path_) == content->end()) {
 275     XBT_WARN("File %s is not on disk %s. Impossible to unlink", path_.c_str(), name);
 276     return -1;
 277   } else {
 278     XBT_DEBUG("UNLINK %s of size %llu on disk '%s'", path_.c_str(), size_, name);
 279
 280     local_disk_->extension<FileSystemDiskExt>()->decr_used_size(size_);
 281     // Remove the file from storage
 282     content->erase(path_);
 283
 284     return 0;
 285   }
 286 }
 287
 288 int File::remote_copy(sg_host_t host, const std::string& fullpath)
 289 {
 290   /* Find the host where the file is physically located and read it */
 291   Host* src_host      = nullptr;
 292   sg_size_t read_size = 0;
 293
 294   Host* dst_host = host;
 295   size_t longest_prefix_length = 0;
 296
 297   seek(0, SEEK_SET);
 298
 299   src_host = local_disk_->get_host();
 300   XBT_DEBUG("READ %s on disk '%s'", get_path(), local_disk_->get_cname());
 301   read_size = local_disk_->read(size_);
 302   current_position_ += read_size;
 303
 304   const Disk* dst_disk = nullptr;
 305
 306   for (auto const& disk : host->get_disks()) {
 307     std::string current_mount = disk->extension<FileSystemDiskExt>()->get_mount_point();
 308     std::string mount_point   = fullpath.substr(0, current_mount.length());
 309     if (mount_point == current_mount && current_mount.length() > longest_prefix_length) {
 310       /* The current mount name is found in the full path and is bigger than the previous*/
 311       longest_prefix_length = current_mount.length();
 312       dst_disk              = disk;
 313     }
 314   }
 315
 316   if (dst_disk == nullptr) {
 317     XBT_WARN("Can't find mount point for '%s' on destination host '%s'", fullpath.c_str(), host->get_cname());
 318     return -1;
 319   }
 320
 321   if (src_host) {
 322     XBT_DEBUG("Initiate data transfer of %llu bytes between %s and %s.", read_size, src_host->get_cname(),
 323               dst_host->get_cname());
 324     Comm::sendto(src_host, dst_host, read_size);
 325   }
 326
 327   /* Create file on remote host, write it and close it */
 328   auto* fd = File::open(fullpath, dst_host, nullptr);
 329   fd->write(read_size);
 330   fd->close();
 331   return 0;
 332 }
 333
 334 int File::remote_move(sg_host_t host, const std::string& fullpath)
 335 {
 336   int res = remote_copy(host, fullpath);
 337   unlink();
 338   return res;
 339 }
 340
 341 FileSystemDiskExt::FileSystemDiskExt(const Disk* ptr)
 342 {
 343   if (const char* size_str = ptr->get_property("size")) {
 344     std::string dummyfile;
 345     size_ = xbt_parse_get_size(dummyfile, -1, size_str, "disk size " + ptr->get_name());
 346   }
 347
 348   if (const char* current_mount_str = ptr->get_property("mount"))
 349     mount_point_ = current_mount_str;
 350   else
 351     mount_point_ = "/";
 352
 353   if (const char* content_str = ptr->get_property("content"))
 354     content_.reset(parse_content(content_str));
 355 }
 356
 357 std::map<std::string, sg_size_t, std::less<>>* FileSystemDiskExt::parse_content(const std::string& filename)
 358 {
 359   if (filename.empty())
 360     return nullptr;
 361
 362   auto* parse_content = new std::map<std::string, sg_size_t, std::less<>>();
 363
 364   auto fs = std::unique_ptr<std::ifstream>(simgrid::xbt::path_ifsopen(filename));
 365   xbt_assert(not fs->fail(), "Cannot open file '%s' (path=%s)", filename.c_str(),
 366              simgrid::xbt::path_to_string().c_str());
 367
 368   std::string line;
 369   std::vector<std::string> tokens;
 370   do {
 371     std::getline(*fs, line);
 372     boost::trim(line);
 373     if (line.length() > 0) {
 374       boost::split(tokens, line, boost::is_any_of(" \t"), boost::token_compress_on);
 375       xbt_assert(tokens.size() == 2, "Parse error in %s: %s", filename.c_str(), line.c_str());
 376       sg_size_t size = std::stoull(tokens.at(1));
 377
 378       used_size_ += size;
 379       parse_content->insert({tokens.front(), size});
 380     }
 381   } while (not fs->eof());
 382   return parse_content;
 383 }
 384
 385 void FileSystemDiskExt::add_remote_mount(Host* host, const std::string& mount_point)
 386 {
 387   remote_mount_points_.try_emplace(host, mount_point);
 388 }
 389
 390 void FileSystemDiskExt::decr_used_size(sg_size_t size)
 391 {
 392   simgrid::kernel::actor::simcall_answered([this, size] { used_size_ -= size; });
 393 }
 394
 395 void FileSystemDiskExt::incr_used_size(sg_size_t size)
 396 {
 397   simgrid::kernel::actor::simcall_answered([this, size] { used_size_ += size; });
 398 }
 399 }
 400 }
 401
 402 using simgrid::s4u::FileDescriptorHostExt;
 403 using simgrid::s4u::FileSystemDiskExt;
 404
 405 static void on_disk_creation(simgrid::s4u::Disk& d)
 406 {
 407   d.extension_set(new FileSystemDiskExt(&d));
 408 }
 409
 410 static void on_host_creation(simgrid::s4u::Host& host)
 411 {
 412   host.extension_set<FileDescriptorHostExt>(new FileDescriptorHostExt());
 413 }
 414
 415  static void on_platform_created()
 416  {
 417    for (auto const& host : simgrid::s4u::Engine::get_instance()->get_all_hosts()) {
 418      const char* remote_disk_str = host->get_property("remote_disk");
 419      if (not remote_disk_str)
 420        continue;
 421      std::vector<std::string> tokens;
 422      boost::split(tokens, remote_disk_str, boost::is_any_of(":"));
 423      std::string mount_point = tokens[0];
 424      simgrid::s4u::Host* remote_host = simgrid::s4u::Host::by_name_or_null(tokens[2]);
 425      xbt_assert(remote_host, "You're trying to access a host that does not exist. Please check your platform file");
 426
 427      const simgrid::s4u::Disk* disk = nullptr;
 428      for (auto const& d : remote_host->get_disks())
 429        if (d->get_name() == tokens[1]) {
 430          disk = d;
 431          break;
 432        }
 433
 434      xbt_assert(disk, "You're trying to mount a disk that does not exist. Please check your platform file");
 435      disk->extension<FileSystemDiskExt>()->add_remote_mount(remote_host, mount_point);
 436    }
 437 }
 438
 439 /* **************************** Public interface *************************** */
 440 /** @brief Initialize the file system plugin.
 441     @ingroup plugin_filesystem
 442
 443     @beginrst
 444     See the examples in :ref:`s4u_ex_disk_io`.
 445     @endrst
 446  */
 447 void sg_storage_file_system_init()
 448 {
 449   FileDescriptorHostExt::max_file_descriptors = 1024;
 450   simgrid::config::bind_flag(FileDescriptorHostExt::max_file_descriptors, "storage/max_file_descriptors",
 451                              "Maximum number of concurrently opened files per host. Default is 1024");
 452
 453   if (not FileSystemDiskExt::EXTENSION_ID.valid()) {
 454     FileSystemDiskExt::EXTENSION_ID = simgrid::s4u::Disk::extension_create<FileSystemDiskExt>();
 455     simgrid::s4u::Disk::on_creation_cb(&on_disk_creation);
 456   }
 457
 458   if (not FileDescriptorHostExt::EXTENSION_ID.valid()) {
 459     FileDescriptorHostExt::EXTENSION_ID = simgrid::s4u::Host::extension_create<FileDescriptorHostExt>();
 460     simgrid::s4u::Host::on_creation_cb(&on_host_creation);
 461   }
 462   simgrid::s4u::Engine::on_platform_created_cb(&on_platform_created);
 463 }
 464
 465 sg_file_t sg_file_open(const char* fullpath, void* data)
 466 {
 467   return simgrid::s4u::File::open(fullpath, data);
 468 }
 469
 470 sg_size_t sg_file_read(sg_file_t fd, sg_size_t size)
 471 {
 472   return fd->read(size);
 473 }
 474
 475 sg_size_t sg_file_write(sg_file_t fd, sg_size_t size)
 476 {
 477   return fd->write(size);
 478 }
 479
 480 void sg_file_close(sg_file_t fd)
 481 {
 482   fd->close();
 483 }
 484
 485 /** Retrieves the path to the file
 486  * @ingroup plugin_filesystem
 487  */
 488 const char* sg_file_get_name(const_sg_file_t fd)
 489 {
 490   xbt_assert((fd != nullptr), "Invalid file descriptor");
 491   return fd->get_path();
 492 }
 493
 494 /** Retrieves the size of the file
 495  * @ingroup plugin_filesystem
 496  */
 497 sg_size_t sg_file_get_size(const_sg_file_t fd)
 498 {
 499   return fd->size();
 500 }
 501
 502 void sg_file_dump(const_sg_file_t fd)
 503 {
 504   fd->dump();
 505 }
 506
 507 /** Retrieves the user data associated with the file
 508  * @ingroup plugin_filesystem
 509  */
 510 void* sg_file_get_data(const_sg_file_t fd)
 511 {
 512   return fd->get_data<void>();
 513 }
 514
 515 /** Changes the user data associated with the file
 516  * @ingroup plugin_filesystem
 517  */
 518 void sg_file_set_data(sg_file_t fd, void* data)
 519 {
 520   fd->set_data(data);
 521 }
 522
 523 /**
 524  * @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).
 525  * @ingroup plugin_filesystem
 526  *
 527  * @param fd : file object that identifies the stream
 528  * @param offset : number of bytes to offset from origin
 529  * @param origin : Position used as reference for the offset. It is specified by one of the following constants defined
 530  *                 in \<stdio.h\> exclusively to be used as arguments for this function (SEEK_SET = beginning of file,
 531  *                 SEEK_CUR = current position of the file pointer, SEEK_END = end of file)
 532  */
 533 void sg_file_seek(sg_file_t fd, sg_offset_t offset, int origin)
 534 {
 535   fd->seek(offset, origin);
 536 }
 537
 538 sg_size_t sg_file_tell(const_sg_file_t fd)
 539 {
 540   return fd->tell();
 541 }
 542
 543 void sg_file_move(const_sg_file_t fd, const char* fullpath)
 544 {
 545   fd->move(fullpath);
 546 }
 547
 548 void sg_file_unlink(sg_file_t fd)
 549 {
 550   fd->unlink();
 551   fd->close();
 552 }
 553
 554 /**
 555  * @brief Copy a file to another location on a remote host.
 556  * @ingroup plugin_filesystem
 557  *
 558  * @param file : the file to move
 559  * @param host : the remote host where the file has to be copied
 560  * @param fullpath : the complete path destination on the remote host
 561  * @return If successful, the function returns 0. Otherwise, it returns -1.
 562  */
 563 int sg_file_rcopy(sg_file_t file, sg_host_t host, const char* fullpath)
 564 {
 565   return file->remote_copy(host, fullpath);
 566 }
 567
 568 /**
 569  * @brief Move a file to another location on a remote host.
 570  * @ingroup plugin_filesystem
 571  *
 572  * @param file : the file to move
 573  * @param host : the remote host where the file has to be moved
 574  * @param fullpath : the complete path destination on the remote host
 575  * @return If successful, the function returns 0. Otherwise, it returns -1.
 576  */
 577 int sg_file_rmove(sg_file_t file, sg_host_t host, const char* fullpath)
 578 {
 579   return file->remote_move(host, fullpath);
 580 }
 581
 582 sg_size_t sg_disk_get_size_free(const_sg_disk_t d)
 583 {
 584   return d->extension<FileSystemDiskExt>()->get_size() - d->extension<FileSystemDiskExt>()->get_used_size();
 585 }
 586
 587 sg_size_t sg_disk_get_size_used(const_sg_disk_t d)
 588 {
 589   return d->extension<FileSystemDiskExt>()->get_used_size();
 590 }
 591
 592 sg_size_t sg_disk_get_size(const_sg_disk_t d)
 593 {
 594   return d->extension<FileSystemDiskExt>()->get_size();
 595 }
 596
 597 const char* sg_disk_get_mount_point(const_sg_disk_t d)
 598 {
 599   return d->extension<FileSystemDiskExt>()->get_mount_point();
 600 }