Logo AND Algorithmique Numérique Distribuée

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