src/plugins/file_system/s4u_FileSystem.cpp

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