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(const std::string& fullpath, void* userdata) : File(fullpath, Host::current(), userdata){};
  27
  28 File::File(const 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.reset(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 (host->get_name() != Host::current()->get_name() && read_size > 0) {
 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     host->send_to(Host::current(), read_size);
 109   }
 110
 111   return read_size;
 112 }
 113
 114 /** @brief Write into a file (local or remote)
 115  *
 116  * @param size of the file to write
 117  * @return the number of bytes successfully write or -1 if an error occurred
 118  */
 119 sg_size_t File::write(sg_size_t size, int write_inside)
 120 {
 121   if (size == 0) /* Nothing to write, return */
 122     return 0;
 123
 124   /* Find the host where the file is physically located (remote or local)*/
 125   Host* host = local_storage_->get_host();
 126
 127   if (host->get_name() != Host::current()->get_name()) {
 128     /* the file is hosted on a remote host, initiate a communication between src and dest hosts for data transfer */
 129     XBT_DEBUG("File is on %s remote host, initiate data transfer of %llu bytes.", host->get_cname(), size);
 130     Host::current()->send_to(host, size);
 131   }
 132
 133   XBT_DEBUG("WRITE %s on disk '%s'. size '%llu/%llu' '%llu:%llu'", get_path(), local_storage_->get_cname(), size, size_, sg_storage_get_size_used(local_storage_), sg_storage_get_size(local_storage_));
 134   // If the storage is full before even starting to write
 135    if (sg_storage_get_size_used(local_storage_) >= sg_storage_get_size(local_storage_))
 136      return 0;
 137   sg_size_t write_size=0;
 138   if(write_inside==0){
 139     /* Substract the part of the file that might disappear from the used sized on the storage element */
 140     local_storage_->extension<FileSystemStorageExt>()->decr_used_size(size_ - current_position_);
 141     write_size = local_storage_->write(size);
 142     local_storage_->extension<FileSystemStorageExt>()->incr_used_size(write_size);
 143     current_position_ += write_size;
 144     size_ = current_position_;
 145   }else {
 146     write_size = local_storage_->write(size);
 147     current_position_ += write_size;
 148     if(current_position_>size_)
 149       size_ = current_position_;
 150   }
 151   std::map<std::string, sg_size_t>* content = local_storage_->extension<FileSystemStorageExt>()->get_content();
 152
 153   content->erase(path_);
 154   content->insert({path_, size_});
 155
 156   return write_size;
 157 }
 158
 159 sg_size_t File::size()
 160 {
 161   return size_;
 162 }
 163
 164 void File::seek(sg_offset_t offset)
 165 {
 166   current_position_ = offset;
 167 }
 168
 169 void File::seek(sg_offset_t offset, int origin)
 170 {
 171   switch (origin) {
 172     case SEEK_SET:
 173       current_position_ = offset;
 174       break;
 175     case SEEK_CUR:
 176       current_position_ += offset;
 177       break;
 178     case SEEK_END:
 179       current_position_ = size_ + offset;
 180       break;
 181     default:
 182       break;
 183   }
 184 }
 185
 186 sg_size_t File::tell()
 187 {
 188   return current_position_;
 189 }
 190
 191 void File::move(const std::string& fullpath)
 192 {
 193   /* Check if the new full path is on the same mount point */
 194   if (fullpath.compare(0, mount_point_.length(), mount_point_) == 0) {
 195     std::map<std::string, sg_size_t>* content = local_storage_->extension<FileSystemStorageExt>()->get_content();
 196     auto sz = content->find(path_);
 197     if (sz != content->end()) { // src file exists
 198       sg_size_t new_size = sz->second;
 199       content->erase(path_);
 200       std::string path = fullpath.substr(mount_point_.length(), fullpath.length());
 201       content->insert({path.c_str(), new_size});
 202       XBT_DEBUG("Move file from %s to %s, size '%llu'", path_.c_str(), fullpath.c_str(), new_size);
 203     } else {
 204       XBT_WARN("File %s doesn't exist", path_.c_str());
 205     }
 206   } else {
 207     XBT_WARN("New full path %s is not on the same mount point: %s.", fullpath.c_str(), mount_point_.c_str());
 208   }
 209 }
 210
 211 int File::unlink()
 212 {
 213   /* Check if the file is on local storage */
 214   std::map<std::string, sg_size_t>* content = local_storage_->extension<FileSystemStorageExt>()->get_content();
 215
 216   if (content->find(path_) == content->end()) {
 217     XBT_WARN("File %s is not on disk %s. Impossible to unlink", path_.c_str(), local_storage_->get_cname());
 218     return -1;
 219   } else {
 220     XBT_DEBUG("UNLINK %s on disk '%s'", path_.c_str(), local_storage_->get_cname());
 221     local_storage_->extension<FileSystemStorageExt>()->decr_used_size(size_);
 222
 223     // Remove the file from storage
 224     content->erase(fullpath_);
 225
 226     return 0;
 227   }
 228 }
 229
 230 int File::remote_copy(sg_host_t host, const char* fullpath)
 231 {
 232   /* Find the host where the file is physically located and read it */
 233   Storage* storage_src = local_storage_;
 234   Host* src_host       = storage_src->get_host();
 235   seek(0, SEEK_SET);
 236   XBT_DEBUG("READ %s on disk '%s'", get_path(), local_storage_->get_cname());
 237   // if the current position is close to the end of the file, we may not be able to read the requested size
 238   sg_size_t read_size = local_storage_->read(size_);
 239   current_position_ += read_size;
 240
 241   /* Find the host that owns the storage where the file has to be copied */
 242   Storage* storage_dest = nullptr;
 243   Host* dst_host;
 244   size_t longest_prefix_length = 0;
 245
 246   for (auto const& elm : host->get_mounted_storages()) {
 247     std::string mount_point = std::string(fullpath).substr(0, elm.first.size());
 248     if (mount_point == elm.first && elm.first.length() > longest_prefix_length) {
 249       /* The current mount name is found in the full path and is bigger than the previous*/
 250       longest_prefix_length = elm.first.length();
 251       storage_dest          = elm.second;
 252     }
 253   }
 254
 255   if (storage_dest != nullptr) {
 256     /* Mount point found, retrieve the host the storage is attached to */
 257     dst_host = storage_dest->get_host();
 258   } else {
 259     XBT_WARN("Can't find mount point for '%s' on destination host '%s'", fullpath, host->get_cname());
 260     return -1;
 261   }
 262
 263   XBT_DEBUG("Initiate data transfer of %llu bytes between %s and %s.", read_size, src_host->get_cname(),
 264             storage_dest->get_host()->get_cname());
 265   src_host->send_to(dst_host, read_size);
 266
 267   /* Create file on remote host, write it and close it */
 268   File* fd = new File(fullpath, dst_host, nullptr);
 269   sg_size_t write_size = fd->local_storage_->write(read_size);
 270   fd->local_storage_->extension<FileSystemStorageExt>()->incr_used_size(write_size);
 271   (*(fd->local_storage_->extension<FileSystemStorageExt>()->get_content()))[path_] = size_;
 272   delete fd;
 273   return 0;
 274 }
 275
 276 int File::remote_move(sg_host_t host, const char* fullpath)
 277 {
 278   int res = remote_copy(host, fullpath);
 279   unlink();
 280   return res;
 281 }
 282
 283 FileSystemStorageExt::FileSystemStorageExt(simgrid::s4u::Storage* ptr)
 284 {
 285   content_.reset(parse_content(ptr->get_impl()->content_name_));
 286   size_    = ptr->get_impl()->size_;
 287 }
 288
 289 std::map<std::string, sg_size_t>* FileSystemStorageExt::parse_content(const std::string& filename)
 290 {
 291   if (filename.empty())
 292     return nullptr;
 293
 294   std::map<std::string, sg_size_t>* parse_content = new std::map<std::string, sg_size_t>();
 295
 296   std::ifstream* fs = surf_ifsopen(filename);
 297
 298   std::string line;
 299   std::vector<std::string> tokens;
 300   do {
 301     std::getline(*fs, line);
 302     boost::trim(line);
 303     if (line.length() > 0) {
 304       boost::split(tokens, line, boost::is_any_of(" \t"), boost::token_compress_on);
 305       xbt_assert(tokens.size() == 2, "Parse error in %s: %s", filename.c_str(), line.c_str());
 306       sg_size_t size = std::stoull(tokens.at(1));
 307
 308       used_size_ += size;
 309       parse_content->insert({tokens.front(), size});
 310     }
 311   } while (not fs->eof());
 312   delete fs;
 313   return parse_content;
 314 }
 315 }
 316 }
 317
 318 using simgrid::s4u::FileSystemStorageExt;
 319 using simgrid::s4u::FileDescriptorHostExt;
 320
 321 static void on_storage_creation(simgrid::s4u::Storage& st)
 322 {
 323   st.extension_set(new FileSystemStorageExt(&st));
 324 }
 325
 326 static void on_host_creation(simgrid::s4u::Host& host)
 327 {
 328   host.extension_set<FileDescriptorHostExt>(new FileDescriptorHostExt());
 329 }
 330
 331 /* **************************** Public interface *************************** */
 332 void sg_storage_file_system_init()
 333 {
 334   sg_storage_max_file_descriptors = 1024;
 335   simgrid::config::bind_flag(sg_storage_max_file_descriptors, "storage/max_file_descriptors",
 336                              "Maximum number of concurrently opened files per host. Default is 1024");
 337
 338   if (not FileSystemStorageExt::EXTENSION_ID.valid()) {
 339     FileSystemStorageExt::EXTENSION_ID = simgrid::s4u::Storage::extension_create<FileSystemStorageExt>();
 340     simgrid::s4u::Storage::on_creation.connect(&on_storage_creation);
 341   }
 342
 343   if (not FileDescriptorHostExt::EXTENSION_ID.valid()) {
 344     FileDescriptorHostExt::EXTENSION_ID = simgrid::s4u::Host::extension_create<FileDescriptorHostExt>();
 345     simgrid::s4u::Host::on_creation.connect(&on_host_creation);
 346   }
 347 }
 348
 349 sg_file_t sg_file_open(const char* fullpath, void* data)
 350 {
 351   return new simgrid::s4u::File(fullpath, data);
 352 }
 353
 354 sg_size_t sg_file_read(sg_file_t fd, sg_size_t size)
 355 {
 356   return fd->read(size);
 357 }
 358
 359 sg_size_t sg_file_write(sg_file_t fd, sg_size_t size)
 360 {
 361   return fd->write(size);
 362 }
 363
 364 void sg_file_close(sg_file_t fd)
 365 {
 366   delete fd;
 367 }
 368
 369 const char* sg_file_get_name(sg_file_t fd)
 370 {
 371   xbt_assert((fd != nullptr), "Invalid file descriptor");
 372   return fd->get_path();
 373 }
 374
 375 sg_size_t sg_file_get_size(sg_file_t fd)
 376 {
 377   return fd->size();
 378 }
 379
 380 void sg_file_dump(sg_file_t fd)
 381 {
 382   fd->dump();
 383 }
 384
 385 void* sg_file_get_data(sg_file_t fd)
 386 {
 387   return fd->get_userdata();
 388 }
 389
 390 void sg_file_set_data(sg_file_t fd, void* data)
 391 {
 392   fd->set_userdata(data);
 393 }
 394
 395 /**
 396  * @brief Set the file position indicator in the sg_file_t by adding offset bytes
 397  * to the position specified by origin (either SEEK_SET, SEEK_CUR, or SEEK_END).
 398  *
 399  * @param fd : file object that identifies the stream
 400  * @param offset : number of bytes to offset from origin
 401  * @param origin : Position used as reference for the offset. It is specified by one of the following constants defined
 402  *                 in \<stdio.h\> exclusively to be used as arguments for this function (SEEK_SET = beginning of file,
 403  *                 SEEK_CUR = current position of the file pointer, SEEK_END = end of file)
 404  */
 405 void sg_file_seek(sg_file_t fd, sg_offset_t offset, int origin)
 406 {
 407   fd->seek(offset, origin);
 408 }
 409
 410 sg_size_t sg_file_tell(sg_file_t fd)
 411 {
 412   return fd->tell();
 413 }
 414
 415 void sg_file_move(sg_file_t fd, const char* fullpath)
 416 {
 417   fd->move(fullpath);
 418 }
 419
 420 void sg_file_unlink(sg_file_t fd)
 421 {
 422   fd->unlink();
 423   delete fd;
 424 }
 425
 426 /**
 427  * @brief Copy a file to another location on a remote host.
 428  * @param file : the file to move
 429  * @param host : the remote host where the file has to be copied
 430  * @param fullpath : the complete path destination on the remote host
 431  * @return If successful, the function returns 0. Otherwise, it returns -1.
 432  */
 433 int sg_file_rcopy(sg_file_t file, sg_host_t host, const char* fullpath)
 434 {
 435   return file->remote_copy(host, fullpath);
 436 }
 437
 438 /**
 439  * @brief Move a file to another location on a remote host.
 440  * @param file : the file to move
 441  * @param host : the remote host where the file has to be moved
 442  * @param fullpath : the complete path destination on the remote host
 443  * @return If successful, the function returns 0. Otherwise, it returns -1.
 444  */
 445 int sg_file_rmove(sg_file_t file, sg_host_t host, const char* fullpath)
 446 {
 447   return file->remote_move(host, fullpath);
 448 }
 449
 450 sg_size_t sg_storage_get_size_free(sg_storage_t st)
 451 {
 452   return st->extension<FileSystemStorageExt>()->get_size() - st->extension<FileSystemStorageExt>()->get_used_size();
 453 }
 454
 455 sg_size_t sg_storage_get_size_used(sg_storage_t st)
 456 {
 457   return st->extension<FileSystemStorageExt>()->get_used_size();
 458 }
 459
 460 sg_size_t sg_storage_get_size(sg_storage_t st)
 461 {
 462   return st->extension<FileSystemStorageExt>()->get_size();
 463 }
 464
 465 xbt_dict_t sg_storage_get_content(sg_storage_t storage)
 466 {
 467   std::map<std::string, sg_size_t>* content = storage->extension<simgrid::s4u::FileSystemStorageExt>()->get_content();
 468   // Note: ::operator delete is ok here (no destructor called) since the dict elements are of POD type sg_size_t.
 469   xbt_dict_t content_as_dict = xbt_dict_new_homogeneous(::operator delete);
 470
 471   for (auto const& entry : *content) {
 472     sg_size_t* psize = new sg_size_t;
 473     *psize           = entry.second;
 474     xbt_dict_set(content_as_dict, entry.first.c_str(), psize, nullptr);
 475   }
 476   return content_as_dict;
 477 }
 478
 479 xbt_dict_t sg_host_get_storage_content(sg_host_t host)
 480 {
 481   xbt_assert((host != nullptr), "Invalid parameters");
 482   xbt_dict_t contents = xbt_dict_new_homogeneous(nullptr);
 483   for (auto const& elm : host->get_mounted_storages())
 484     xbt_dict_set(contents, elm.first.c_str(), sg_storage_get_content(elm.second), nullptr);
 485
 486   return contents;
 487 }