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 "src/surf/HostImpl.hpp"
   9 #include "xbt/config.hpp"
  10
  11 #include <algorithm>
  12 #include <boost/algorithm/string.hpp>
  13 #include <boost/algorithm/string/join.hpp>
  14 #include <boost/algorithm/string/split.hpp>
  15 #include <fstream>
  16 #include <numeric>
  17
  18 XBT_LOG_NEW_DEFAULT_CATEGORY(s4u_file, "S4U files");
  19 int sg_storage_max_file_descriptors = 1024;
  20
  21 namespace simgrid {
  22 namespace s4u {
  23 simgrid::xbt::Extension<Storage, FileSystemStorageExt> FileSystemStorageExt::EXTENSION_ID;
  24 simgrid::xbt::Extension<Host, FileDescriptorHostExt> FileDescriptorHostExt::EXTENSION_ID;
  25
  26 File::File(std::string fullpath, void* userdata) : File(fullpath, Host::current(), userdata){};
  27
  28 File::File(std::string fullpath, sg_host_t host, void* userdata) : fullpath_(fullpath), userdata_(userdata)
  29 {
  30   // this cannot fail because we get a xbt_die if the mountpoint does not exist
  31   Storage* st                  = nullptr;
  32   size_t longest_prefix_length = 0;
  33   XBT_DEBUG("Search for storage name for '%s' on '%s'", fullpath.c_str(), host->get_cname());
  34
  35   for (auto const& mnt : host->get_mounted_storages()) {
  36     XBT_DEBUG("See '%s'", mnt.first.c_str());
  37     mount_point_ = fullpath.substr(0, mnt.first.length());
  38
  39     if (mount_point_ == mnt.first && mnt.first.length() > longest_prefix_length) {
  40       /* The current mount name is found in the full path and is bigger than the previous*/
  41       longest_prefix_length = mnt.first.length();
  42       st                    = mnt.second;
  43     }
  44   }
  45   if (longest_prefix_length > 0) { /* Mount point found, split fullpath into mount_name and path+filename*/
  46     mount_point_ = fullpath.substr(0, longest_prefix_length);
  47     path_        = fullpath.substr(longest_prefix_length, fullpath.length());
  48   } else
  49     xbt_die("Can't find mount point for '%s' on '%s'", fullpath.c_str(), host->get_cname());
  50
  51   local_storage_ = st;
  52
  53   // assign a file descriptor id to the newly opened File
  54   FileDescriptorHostExt* ext = host->extension<simgrid::s4u::FileDescriptorHostExt>();
  55   if (ext->file_descriptor_table == nullptr) {
  56     ext->file_descriptor_table = new std::vector<int>(sg_storage_max_file_descriptors);
  57     std::iota(ext->file_descriptor_table->rbegin(), ext->file_descriptor_table->rend(), 0); // Fill with ..., 1, 0.
  58   }
  59   xbt_assert(not ext->file_descriptor_table->empty(), "Too much files are opened! Some have to be closed.");
  60   desc_id = ext->file_descriptor_table->back();
  61   ext->file_descriptor_table->pop_back();
  62
  63   XBT_DEBUG("\tOpen file '%s'", path_.c_str());
  64   std::map<std::string, sg_size_t>* content = local_storage_->extension<FileSystemStorageExt>()->get_content();
  65   // if file does not exist create an empty file
  66   auto sz = content->find(path_);
  67   if (sz != content->end()) {
  68     size_ = sz->second;
  69   } else {
  70     size_ = 0;
  71     content->insert({path_, size_});
  72     XBT_DEBUG("File '%s' was not found, file created.", path_.c_str());
  73   }
  74 }
  75
  76 File::~File()
  77 {
  78   Host::current()->extension<simgrid::s4u::FileDescriptorHostExt>()->file_descriptor_table->push_back(desc_id);
  79 }
  80
  81 void File::dump()
  82 {
  83   XBT_INFO("File Descriptor information:\n"
  84            "\t\tFull path: '%s'\n"
  85            "\t\tSize: %llu\n"
  86            "\t\tMount point: '%s'\n"
  87            "\t\tStorage Id: '%s'\n"
  88            "\t\tStorage Type: '%s'\n"
  89            "\t\tFile Descriptor Id: %d",
  90            get_path(), size_, mount_point_.c_str(), local_storage_->get_cname(), local_storage_->get_type(), desc_id);
  91 }
  92
  93 sg_size_t File::read(sg_size_t size)
  94 {
  95   if (size_ == 0) /* Nothing to read, return */
  96     return 0;
  97
  98   /* Find the host where the file is physically located and read it */
  99   Host* host = local_storage_->get_host();
 100   XBT_DEBUG("READ %s on disk '%s'", get_path(), local_storage_->get_cname());
 101   // if the current position is close to the end of the file, we may not be able to read the requested size
 102   sg_size_t read_size = local_storage_->read(std::min(size, size_ - current_position_));
 103   current_position_ += read_size;
 104
 105   if (strcmp(host->get_cname(), Host::current()->get_cname())) {
 106     /* the file is hosted on a remote host, initiate a communication between src and dest hosts for data transfer */
 107     XBT_DEBUG("File is on %s remote host, initiate data transfer of %llu bytes.", host->get_cname(), read_size);
 108     std::vector<Host*> m_host_list   = {Host::current(), host};
 109     std::vector<double> flops_amount = {0., 0.};
 110     std::vector<double> bytes_amount = {0., 0., static_cast<double>(read_size), 0.};
 111
 112     this_actor::parallel_execute(m_host_list, flops_amount, bytes_amount);
 113   }
 114
 115   return read_size;
 116 }
 117
 118 /** @brief Write into a file (local or remote)
 119  *
 120  * @param size of the file to write
 121  * @return the number of bytes successfully write or -1 if an error occurred
 122  */
 123 sg_size_t File::write(sg_size_t size)
 124 {
 125   if (size == 0) /* Nothing to write, return */
 126     return 0;
 127
 128   /* Find the host where the file is physically located (remote or local)*/
 129   Host* host = local_storage_->get_host();
 130
 131   if (strcmp(host->get_cname(), Host::current()->get_cname())) {
 132     /* the file is hosted on a remote host, initiate a communication between src and dest hosts for data transfer */
 133     XBT_DEBUG("File is on %s remote host, initiate data transfer of %llu bytes.", host->get_cname(), size);
 134     std::vector<Host*> m_host_list   = {Host::current(), host};
 135     std::vector<double> flops_amount = {0, 0};
 136     std::vector<double> bytes_amount = {0, static_cast<double>(size), 0, 0};
 137
 138     this_actor::parallel_execute(m_host_list, flops_amount, bytes_amount);
 139   }
 140
 141   XBT_DEBUG("WRITE %s on disk '%s'. size '%llu/%llu'", get_path(), local_storage_->get_cname(), size, size_);
 142   // If the storage is full before even starting to write
 143   if (sg_storage_get_size_used(local_storage_) >= sg_storage_get_size(local_storage_))
 144     return 0;
 145   /* Substract the part of the file that might disappear from the used sized on the storage element */
 146   local_storage_->extension<FileSystemStorageExt>()->decr_used_size(size_ - current_position_);
 147
 148   sg_size_t write_size = local_storage_->write(size);
 149   local_storage_->extension<FileSystemStorageExt>()->incr_used_size(write_size);
 150
 151   current_position_ += write_size;
 152   size_ = current_position_;
 153   std::map<std::string, sg_size_t>* content = local_storage_->extension<FileSystemStorageExt>()->get_content();
 154
 155   content->erase(path_);
 156   content->insert({path_, size_});
 157
 158   return write_size;
 159 }
 160
 161 sg_size_t File::size()
 162 {
 163   return size_;
 164 }
 165
 166 void File::seek(sg_offset_t offset)
 167 {
 168   current_position_ = offset;
 169 }
 170
 171 void File::seek(sg_offset_t offset, int origin)
 172 {
 173   switch (origin) {
 174     case SEEK_SET:
 175       current_position_ = offset;
 176       break;
 177     case SEEK_CUR:
 178       current_position_ += offset;
 179       break;
 180     case SEEK_END:
 181       current_position_ = size_ + offset;
 182       break;
 183     default:
 184       break;
 185   }
 186 }
 187
 188 sg_size_t File::tell()
 189 {
 190   return current_position_;
 191 }
 192
 193 void File::move(std::string fullpath)
 194 {
 195   /* Check if the new full path is on the same mount point */
 196   if (not strncmp(mount_point_.c_str(), fullpath.c_str(), mount_point_.length())) {
 197     std::map<std::string, sg_size_t>* content = local_storage_->extension<FileSystemStorageExt>()->get_content();
 198     auto sz = content->find(path_);
 199     if (sz != content->end()) { // src file exists
 200       sg_size_t new_size = sz->second;
 201       content->erase(path_);
 202       std::string path = fullpath.substr(mount_point_.length(), fullpath.length());
 203       content->insert({path.c_str(), new_size});
 204       XBT_DEBUG("Move file from %s to %s, size '%llu'", path_.c_str(), fullpath.c_str(), new_size);
 205     } else {
 206       XBT_WARN("File %s doesn't exist", path_.c_str());
 207     }
 208   } else {
 209     XBT_WARN("New full path %s is not on the same mount point: %s.", fullpath.c_str(), mount_point_.c_str());
 210   }
 211 }
 212
 213 int File::unlink()
 214 {
 215   /* Check if the file is on local storage */
 216   std::map<std::string, sg_size_t>* content = local_storage_->extension<FileSystemStorageExt>()->get_content();
 217
 218   if (content->find(path_) == content->end()) {
 219     XBT_WARN("File %s is not on disk %s. Impossible to unlink", path_.c_str(), local_storage_->get_cname());
 220     return -1;
 221   } else {
 222     XBT_DEBUG("UNLINK %s on disk '%s'", path_.c_str(), local_storage_->get_cname());
 223     local_storage_->extension<FileSystemStorageExt>()->decr_used_size(size_);
 224
 225     // Remove the file from storage
 226     content->erase(fullpath_);
 227
 228     return 0;
 229   }
 230 }
 231
 232 int File::remote_copy(sg_host_t host, const char* fullpath)
 233 {
 234   /* Find the host where the file is physically located and read it */
 235   Storage* storage_src = local_storage_;
 236   Host* src_host       = storage_src->get_host();
 237   seek(0, SEEK_SET);
 238   XBT_DEBUG("READ %s on disk '%s'", get_path(), local_storage_->get_cname());
 239   // if the current position is close to the end of the file, we may not be able to read the requested size
 240   sg_size_t read_size = local_storage_->read(size_);
 241   current_position_ += read_size;
 242
 243   /* Find the host that owns the storage where the file has to be copied */
 244   Storage* storage_dest = nullptr;
 245   Host* dst_host;
 246   size_t longest_prefix_length = 0;
 247
 248   for (auto const& elm : host->get_mounted_storages()) {
 249     std::string mount_point = std::string(fullpath).substr(0, elm.first.size());
 250     if (mount_point == elm.first && elm.first.length() > longest_prefix_length) {
 251       /* The current mount name is found in the full path and is bigger than the previous*/
 252       longest_prefix_length = elm.first.length();
 253       storage_dest          = elm.second;
 254     }
 255   }
 256
 257   if (storage_dest != nullptr) {
 258     /* Mount point found, retrieve the host the storage is attached to */
 259     dst_host = storage_dest->get_host();
 260   } else {
 261     XBT_WARN("Can't find mount point for '%s' on destination host '%s'", fullpath, host->get_cname());
 262     return -1;
 263   }
 264
 265   XBT_DEBUG("Initiate data transfer of %llu bytes between %s and %s.", read_size, src_host->get_cname(),
 266             storage_dest->get_host()->get_cname());
 267   std::vector<Host*> m_host_list   = {src_host, dst_host};
 268   std::vector<double> flops_amount = {0, 0};
 269   std::vector<double> bytes_amount = {0, static_cast<double>(read_size), 0, 0};
 270
 271   this_actor::parallel_execute(m_host_list, flops_amount, bytes_amount);
 272
 273   /* Create file on remote host, write it and close it */
 274   File* fd = new File(fullpath, dst_host, nullptr);
 275   sg_size_t write_size = fd->local_storage_->write(read_size);
 276   fd->local_storage_->extension<FileSystemStorageExt>()->incr_used_size(write_size);
 277   (*(fd->local_storage_->extension<FileSystemStorageExt>()->get_content()))[path_] = size_;
 278   delete fd;
 279   return 0;
 280 }
 281
 282 int File::remote_move(sg_host_t host, const char* fullpath)
 283 {
 284   int res = remote_copy(host, fullpath);
 285   unlink();
 286   return res;
 287 }
 288
 289 FileSystemStorageExt::FileSystemStorageExt(simgrid::s4u::Storage* ptr)
 290 {
 291   content_ = parse_content(ptr->get_impl()->content_name);
 292   size_    = ptr->get_impl()->size_;
 293 }
 294
 295 FileSystemStorageExt::~FileSystemStorageExt()
 296 {
 297   delete content_;
 298 }
 299
 300 std::map<std::string, sg_size_t>* FileSystemStorageExt::parse_content(std::string filename)
 301 {
 302   if (filename.empty())
 303     return nullptr;
 304
 305   std::map<std::string, sg_size_t>* parse_content = new std::map<std::string, sg_size_t>();
 306
 307   std::ifstream* fs = surf_ifsopen(filename);
 308
 309   std::string line;
 310   std::vector<std::string> tokens;
 311   do {
 312     std::getline(*fs, line);
 313     boost::trim(line);
 314     if (line.length() > 0) {
 315       boost::split(tokens, line, boost::is_any_of(" \t"), boost::token_compress_on);
 316       xbt_assert(tokens.size() == 2, "Parse error in %s: %s", filename.c_str(), line.c_str());
 317       sg_size_t size = std::stoull(tokens.at(1));
 318
 319       used_size_ += size;
 320       parse_content->insert({tokens.front(), size});
 321     }
 322   } while (not fs->eof());
 323   delete fs;
 324   return parse_content;
 325 }
 326 }
 327 }
 328
 329 using simgrid::s4u::FileSystemStorageExt;
 330 using simgrid::s4u::FileDescriptorHostExt;
 331
 332 static void on_storage_creation(simgrid::s4u::Storage& st)
 333 {
 334   st.extension_set(new FileSystemStorageExt(&st));
 335 }
 336
 337 static void on_host_creation(simgrid::s4u::Host& host)
 338 {
 339   host.extension_set<FileDescriptorHostExt>(new FileDescriptorHostExt());
 340 }
 341
 342 /* **************************** Public interface *************************** */
 343 void sg_storage_file_system_init()
 344 {
 345   sg_storage_max_file_descriptors = 1024;
 346   simgrid::config::bind_flag(sg_storage_max_file_descriptors, "storage/max_file_descriptors",
 347                              "Maximum number of concurrently opened files per host. Default is 1024");
 348
 349   if (not FileSystemStorageExt::EXTENSION_ID.valid()) {
 350     FileSystemStorageExt::EXTENSION_ID = simgrid::s4u::Storage::extension_create<FileSystemStorageExt>();
 351     simgrid::s4u::Storage::on_creation.connect(&on_storage_creation);
 352   }
 353
 354   if (not FileDescriptorHostExt::EXTENSION_ID.valid()) {
 355     FileDescriptorHostExt::EXTENSION_ID = simgrid::s4u::Host::extension_create<FileDescriptorHostExt>();
 356     simgrid::s4u::Host::on_creation.connect(&on_host_creation);
 357   }
 358 }
 359
 360 sg_file_t sg_file_open(const char* fullpath, void* data)
 361 {
 362   return new simgrid::s4u::File(fullpath, data);
 363 }
 364
 365 sg_size_t sg_file_read(sg_file_t fd, sg_size_t size)
 366 {
 367   return fd->read(size);
 368 }
 369
 370 sg_size_t sg_file_write(sg_file_t fd, sg_size_t size)
 371 {
 372   return fd->write(size);
 373 }
 374
 375 void sg_file_close(sg_file_t fd)
 376 {
 377   delete fd;
 378 }
 379
 380 const char* sg_file_get_name(sg_file_t fd)
 381 {
 382   xbt_assert((fd != nullptr), "Invalid file descriptor");
 383   return fd->get_path();
 384 }
 385
 386 sg_size_t sg_file_get_size(sg_file_t fd)
 387 {
 388   return fd->size();
 389 }
 390
 391 void sg_file_dump(sg_file_t fd)
 392 {
 393   fd->dump();
 394 }
 395
 396 void* sg_file_get_data(sg_file_t fd)
 397 {
 398   return fd->get_userdata();
 399 }
 400
 401 void sg_file_set_data(sg_file_t fd, void* data)
 402 {
 403   fd->set_userdata(data);
 404 }
 405
 406 /**
 407  * @brief Set the file position indicator in the sg_file_t by adding offset bytes
 408  * to the position specified by origin (either SEEK_SET, SEEK_CUR, or SEEK_END).
 409  *
 410  * @param fd : file object that identifies the stream
 411  * @param offset : number of bytes to offset from origin
 412  * @param origin : Position used as reference for the offset. It is specified by one of the following constants defined
 413  *                 in \<stdio.h\> exclusively to be used as arguments for this function (SEEK_SET = beginning of file,
 414  *                 SEEK_CUR = current position of the file pointer, SEEK_END = end of file)
 415  */
 416 void sg_file_seek(sg_file_t fd, sg_offset_t offset, int origin)
 417 {
 418   fd->seek(offset, origin);
 419 }
 420
 421 sg_size_t sg_file_tell(sg_file_t fd)
 422 {
 423   return fd->tell();
 424 }
 425
 426 void sg_file_move(sg_file_t fd, const char* fullpath)
 427 {
 428   fd->move(fullpath);
 429 }
 430
 431 void sg_file_unlink(sg_file_t fd)
 432 {
 433   fd->unlink();
 434   delete fd;
 435 }
 436
 437 /**
 438  * @brief Copy a file to another location on a remote host.
 439  * @param file : the file to move
 440  * @param host : the remote host where the file has to be copied
 441  * @param fullpath : the complete path destination on the remote host
 442  * @return If successful, the function returns 0. Otherwise, it returns -1.
 443  */
 444 int sg_file_rcopy(sg_file_t file, sg_host_t host, const char* fullpath)
 445 {
 446   return file->remote_copy(host, fullpath);
 447 }
 448
 449 /**
 450  * @brief Move a file to another location on a remote host.
 451  * @param file : the file to move
 452  * @param host : the remote host where the file has to be moved
 453  * @param fullpath : the complete path destination on the remote host
 454  * @return If successful, the function returns 0. Otherwise, it returns -1.
 455  */
 456 int sg_file_rmove(sg_file_t file, sg_host_t host, const char* fullpath)
 457 {
 458   return file->remote_move(host, fullpath);
 459 }
 460
 461 sg_size_t sg_storage_get_size_free(sg_storage_t st)
 462 {
 463   return st->extension<FileSystemStorageExt>()->get_size() - st->extension<FileSystemStorageExt>()->get_used_size();
 464 }
 465
 466 sg_size_t sg_storage_get_size_used(sg_storage_t st)
 467 {
 468   return st->extension<FileSystemStorageExt>()->get_used_size();
 469 }
 470
 471 sg_size_t sg_storage_get_size(sg_storage_t st)
 472 {
 473   return st->extension<FileSystemStorageExt>()->get_size();
 474 }
 475
 476 xbt_dict_t sg_storage_get_content(sg_storage_t storage)
 477 {
 478   std::map<std::string, sg_size_t>* content = storage->extension<simgrid::s4u::FileSystemStorageExt>()->get_content();
 479   // Note: ::operator delete is ok here (no destructor called) since the dict elements are of POD type sg_size_t.
 480   xbt_dict_t content_as_dict = xbt_dict_new_homogeneous(::operator delete);
 481
 482   for (auto const& entry : *content) {
 483     sg_size_t* psize = new sg_size_t;
 484     *psize           = entry.second;
 485     xbt_dict_set(content_as_dict, entry.first.c_str(), psize, nullptr);
 486   }
 487   return content_as_dict;
 488 }
 489
 490 xbt_dict_t sg_host_get_storage_content(sg_host_t host)
 491 {
 492   xbt_assert((host != nullptr), "Invalid parameters");
 493   xbt_dict_t contents = xbt_dict_new_homogeneous(nullptr);
 494   for (auto const& elm : host->get_mounted_storages())
 495     xbt_dict_set(contents, elm.first.c_str(), sg_storage_get_content(elm.second), nullptr);
 496
 497   return contents;
 498 }