src/plugins/file_system/s4u_FileSystem.cpp

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