Logo AND Algorithmique Numérique Distribuée

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