1 /* Copyright (c) 2015-2017. The SimGrid Team. All rights reserved. */
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. */
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"
16 #include <boost/algorithm/string.hpp>
17 #include <boost/algorithm/string/join.hpp>
18 #include <boost/algorithm/string/split.hpp>
22 XBT_LOG_NEW_DEFAULT_CATEGORY(s4u_file, "S4U files");
23 int sg_storage_max_file_descriptors = 1024;
27 simgrid::xbt::Extension<Storage, FileSystemStorageExt> FileSystemStorageExt::EXTENSION_ID;
28 simgrid::xbt::Extension<Host, FileDescriptorHostExt> FileDescriptorHostExt::EXTENSION_ID;
30 File::File(std::string fullpath, void* userdata) : File(fullpath, Host::current(), userdata){};
32 File::File(std::string fullpath, sg_host_t host, void* userdata) : fullpath_(fullpath), userdata_(userdata)
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());
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());
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();
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());
53 xbt_die("Can't find mount point for '%s' on '%s'", fullpath.c_str(), host->getCname());
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.
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();
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()) {
75 content->insert({path_, size_});
76 XBT_DEBUG("File '%s' was not found, file created.", path_.c_str());
82 Host::current()->extension<simgrid::s4u::FileDescriptorHostExt>()->file_descriptor_table->push_back(desc_id);
87 XBT_INFO("File Descriptor information:\n"
88 "\t\tFull path: '%s'\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);
97 sg_size_t File::read(sg_size_t size)
99 if (size_ == 0) /* Nothing to read, return */
102 /* Find the host where the file is physically located and read it */
103 Host* host = localStorage->getHost();
104 XBT_DEBUG("READ %s on disk '%s'", getPath(), localStorage->getCname());
105 // if the current position is close to the end of the file, we may not be able to read the requested size
106 sg_size_t read_size = localStorage->read(std::min(size, size_ - current_position_));
107 current_position_ += read_size;
109 if (strcmp(host->getCname(), Host::current()->getCname())) {
110 /* the file is hosted on a remote host, initiate a communication between src and dest hosts for data transfer */
111 XBT_DEBUG("File is on %s remote host, initiate data transfer of %llu bytes.", host->getCname(), read_size);
112 Host* m_host_list[] = {Host::current(), host};
113 double* flops_amount = new double[2]{0, 0};
114 double* bytes_amount = new double[4]{0, 0, static_cast<double>(read_size), 0};
116 this_actor::parallel_execute(2, m_host_list, flops_amount, bytes_amount);
122 /** \brief Write into a file (local or remote)
124 * \param size of the file to write
125 * \param fd is a the file descriptor
126 * \return the number of bytes successfully write or -1 if an error occurred
128 sg_size_t File::write(sg_size_t size)
130 if (size == 0) /* Nothing to write, return */
133 /* Find the host where the file is physically located (remote or local)*/
134 Host* host = localStorage->getHost();
136 if (strcmp(host->getCname(), Host::current()->getCname())) {
137 /* the file is hosted on a remote host, initiate a communication between src and dest hosts for data transfer */
138 XBT_DEBUG("File is on %s remote host, initiate data transfer of %llu bytes.", host->getCname(), size);
139 Host* m_host_list[] = {Host::current(), host};
140 double* flops_amount = new double[2]{0, 0};
141 double* bytes_amount = new double[4]{0, static_cast<double>(size), 0, 0};
143 this_actor::parallel_execute(2, m_host_list, flops_amount, bytes_amount);
146 XBT_DEBUG("WRITE %s on disk '%s'. size '%llu/%llu'", getPath(), localStorage->getCname(), size, size_);
147 // If the storage is full before even starting to write
148 if (sg_storage_get_size_used(localStorage) >= sg_storage_get_size(localStorage))
150 /* Substract the part of the file that might disappear from the used sized on the storage element */
151 localStorage->extension<FileSystemStorageExt>()->decrUsedSize(size_ - current_position_);
153 sg_size_t write_size = localStorage->write(size);
154 localStorage->extension<FileSystemStorageExt>()->incrUsedSize(write_size);
156 current_position_ += write_size;
157 size_ = current_position_;
158 std::map<std::string, sg_size_t>* content = localStorage->extension<FileSystemStorageExt>()->getContent();
160 content->erase(path_);
161 content->insert({path_, size_});
166 sg_size_t File::size()
171 void File::seek(sg_offset_t offset)
173 current_position_ = offset;
176 void File::seek(sg_offset_t offset, int origin)
180 current_position_ = offset;
183 current_position_ += offset;
186 current_position_ = size_ + offset;
193 sg_size_t File::tell()
195 return current_position_;
198 void File::move(std::string fullpath)
200 /* Check if the new full path is on the same mount point */
201 if (not strncmp(mount_point_.c_str(), fullpath.c_str(), mount_point_.length())) {
202 std::map<std::string, sg_size_t>* content = localStorage->extension<FileSystemStorageExt>()->getContent();
203 auto sz = content->find(path_);
204 if (sz != content->end()) { // src file exists
205 sg_size_t new_size = sz->second;
206 content->erase(path_);
207 std::string path = fullpath.substr(mount_point_.length(), fullpath.length());
208 content->insert({path.c_str(), new_size});
209 XBT_DEBUG("Move file from %s to %s, size '%llu'", path_.c_str(), fullpath.c_str(), new_size);
211 XBT_WARN("File %s doesn't exist", path_.c_str());
214 XBT_WARN("New full path %s is not on the same mount point: %s.", fullpath.c_str(), mount_point_.c_str());
220 /* Check if the file is on local storage */
221 std::map<std::string, sg_size_t>* content = localStorage->extension<FileSystemStorageExt>()->getContent();
223 if (content->find(path_) == content->end()) {
224 XBT_WARN("File %s is not on disk %s. Impossible to unlink", path_.c_str(), localStorage->getCname());
227 XBT_DEBUG("UNLINK %s on disk '%s'", path_.c_str(), localStorage->getCname());
228 localStorage->extension<FileSystemStorageExt>()->decrUsedSize(size_);
230 // Remove the file from storage
231 content->erase(fullpath_);
237 int File::remoteCopy(sg_host_t host, const char* fullpath)
239 /* Find the host where the file is physically located and read it */
240 Storage* storage_src = localStorage;
241 Host* src_host = storage_src->getHost();
243 XBT_DEBUG("READ %s on disk '%s'", getPath(), localStorage->getCname());
244 // if the current position is close to the end of the file, we may not be able to read the requested size
245 sg_size_t read_size = localStorage->read(size_);
246 current_position_ += read_size;
248 /* Find the host that owns the storage where the file has to be copied */
249 Storage* storage_dest = nullptr;
251 size_t longest_prefix_length = 0;
253 for (auto const& elm : host->getMountedStorages()) {
254 std::string mount_point = std::string(fullpath).substr(0, elm.first.size());
255 if (mount_point == elm.first && elm.first.length() > longest_prefix_length) {
256 /* The current mount name is found in the full path and is bigger than the previous*/
257 longest_prefix_length = elm.first.length();
258 storage_dest = elm.second;
262 if (storage_dest != nullptr) {
263 /* Mount point found, retrieve the host the storage is attached to */
264 dst_host = storage_dest->getHost();
266 XBT_WARN("Can't find mount point for '%s' on destination host '%s'", fullpath, host->getCname());
270 XBT_DEBUG("Initiate data transfer of %llu bytes between %s and %s.", read_size, src_host->getCname(),
271 storage_dest->getHost()->getCname());
272 Host* m_host_list[] = {src_host, dst_host};
273 double* flops_amount = new double[2]{0, 0};
274 double* bytes_amount = new double[4]{0, static_cast<double>(read_size), 0, 0};
276 this_actor::parallel_execute(2, m_host_list, flops_amount, bytes_amount);
278 /* Create file on remote host, write it and close it */
279 File* fd = new File(fullpath, dst_host, nullptr);
280 sg_size_t write_size = fd->localStorage->write(read_size);
281 fd->localStorage->extension<FileSystemStorageExt>()->incrUsedSize(write_size);
282 (*(fd->localStorage->extension<FileSystemStorageExt>()->getContent()))[path_] = size_;
287 int File::remoteMove(sg_host_t host, const char* fullpath)
289 int res = remoteCopy(host, fullpath);
294 FileSystemStorageExt::FileSystemStorageExt(simgrid::s4u::Storage* ptr)
296 content_ = parseContent(ptr->getImpl()->content_name);
297 size_ = ptr->getImpl()->size_;
300 FileSystemStorageExt::~FileSystemStorageExt()
305 std::map<std::string, sg_size_t>* FileSystemStorageExt::parseContent(std::string filename)
307 if (filename.empty())
310 std::map<std::string, sg_size_t>* parse_content = new std::map<std::string, sg_size_t>();
312 std::ifstream* fs = surf_ifsopen(filename);
315 std::vector<std::string> tokens;
317 std::getline(*fs, line);
319 if (line.length() > 0) {
320 boost::split(tokens, line, boost::is_any_of(" \t"), boost::token_compress_on);
321 xbt_assert(tokens.size() == 2, "Parse error in %s: %s", filename.c_str(), line.c_str());
322 sg_size_t size = std::stoull(tokens.at(1));
325 parse_content->insert({tokens.front(), size});
327 } while (not fs->eof());
329 return parse_content;
334 using simgrid::s4u::FileSystemStorageExt;
335 using simgrid::s4u::FileDescriptorHostExt;
337 static void onStorageCreation(simgrid::s4u::Storage& st)
339 st.extension_set(new FileSystemStorageExt(&st));
342 static void onStorageDestruction(simgrid::s4u::Storage& st)
344 delete st.extension<FileSystemStorageExt>();
347 static void onHostCreation(simgrid::s4u::Host& host)
349 host.extension_set<FileDescriptorHostExt>(new FileDescriptorHostExt());
352 /* **************************** Public interface *************************** */
355 void sg_storage_file_system_init()
357 if (not FileSystemStorageExt::EXTENSION_ID.valid()) {
358 FileSystemStorageExt::EXTENSION_ID = simgrid::s4u::Storage::extension_create<FileSystemStorageExt>();
359 simgrid::s4u::Storage::onCreation.connect(&onStorageCreation);
360 simgrid::s4u::Storage::onDestruction.connect(&onStorageDestruction);
363 if (not FileDescriptorHostExt::EXTENSION_ID.valid()) {
364 FileDescriptorHostExt::EXTENSION_ID = simgrid::s4u::Host::extension_create<FileDescriptorHostExt>();
365 simgrid::s4u::Host::onCreation.connect(&onHostCreation);
369 sg_file_t sg_file_open(const char* fullpath, void* data)
371 return new simgrid::s4u::File(fullpath, data);
374 sg_size_t sg_file_read(sg_file_t fd, sg_size_t size)
376 return fd->read(size);
379 sg_size_t sg_file_write(sg_file_t fd, sg_size_t size)
381 return fd->write(size);
384 void sg_file_close(sg_file_t fd)
389 const char* sg_file_get_name(sg_file_t fd)
391 xbt_assert((fd != nullptr), "Invalid file descriptor");
392 return fd->getPath();
395 sg_size_t sg_file_get_size(sg_file_t fd)
400 void sg_file_dump(sg_file_t fd)
405 void* sg_file_get_data(sg_file_t fd)
407 return fd->getUserdata();
410 void sg_file_set_data(sg_file_t fd, void* data)
412 fd->setUserdata(data);
416 * \brief Set the file position indicator in the msg_file_t by adding offset bytes
417 * to the position specified by origin (either SEEK_SET, SEEK_CUR, or SEEK_END).
419 * \param fd : file object that identifies the stream
420 * \param offset : number of bytes to offset from origin
421 * \param origin : Position used as reference for the offset. It is specified by one of the following constants defined
422 * in \<stdio.h\> exclusively to be used as arguments for this function (SEEK_SET = beginning of file,
423 * SEEK_CUR = current position of the file pointer, SEEK_END = end of file)
425 void sg_file_seek(sg_file_t fd, sg_offset_t offset, int origin)
427 fd->seek(offset, origin);
430 sg_size_t sg_file_tell(sg_file_t fd)
435 void sg_file_move(sg_file_t fd, const char* fullpath)
440 void sg_file_unlink(sg_file_t fd)
447 * \brief Copy a file to another location on a remote host.
448 * \param file : the file to move
449 * \param host : the remote host where the file has to be copied
450 * \param fullpath : the complete path destination on the remote host
451 * \return If successful, the function returns 0. Otherwise, it returns -1.
453 int sg_file_rcopy(sg_file_t file, sg_host_t host, const char* fullpath)
455 return file->remoteCopy(host, fullpath);
459 * \brief Move a file to another location on a remote host.
460 * \param file : the file to move
461 * \param host : the remote host where the file has to be moved
462 * \param fullpath : the complete path destination on the remote host
463 * \return If successful, the function returns 0. Otherwise, it returns -1.
465 int sg_file_rmove(sg_file_t file, sg_host_t host, const char* fullpath)
467 return file->remoteMove(host, fullpath);
471 sg_size_t sg_storage_get_size_free(sg_storage_t st)
473 return st->extension<FileSystemStorageExt>()->getSize() - st->extension<FileSystemStorageExt>()->getUsedSize();
476 sg_size_t sg_storage_get_size_used(sg_storage_t st)
478 return st->extension<FileSystemStorageExt>()->getUsedSize();
481 sg_size_t sg_storage_get_size(sg_storage_t st)
483 return st->extension<FileSystemStorageExt>()->getSize();
486 xbt_dict_t sg_storage_get_content(sg_storage_t storage)
488 std::map<std::string, sg_size_t>* content = storage->extension<simgrid::s4u::FileSystemStorageExt>()->getContent();
489 // Note: ::operator delete is ok here (no destructor called) since the dict elements are of POD type sg_size_t.
490 xbt_dict_t content_as_dict = xbt_dict_new_homogeneous(::operator delete);
492 for (auto const& entry : *content) {
493 sg_size_t* psize = new sg_size_t;
494 *psize = entry.second;
495 xbt_dict_set(content_as_dict, entry.first.c_str(), psize, nullptr);
497 return content_as_dict;
500 xbt_dict_t sg_host_get_storage_content(sg_host_t host)
502 xbt_assert((host != nullptr), "Invalid parameters");
503 xbt_dict_t contents = xbt_dict_new_homogeneous(nullptr);
504 for (auto const& elm : host->getMountedStorages())
505 xbt_dict_set(contents, elm.first.c_str(), sg_storage_get_content(elm.second), nullptr);